diff --git a/.changelog/bacf869ab83a47b29c19349bb8cfb042.json b/.changelog/bacf869ab83a47b29c19349bb8cfb042.json new file mode 100644 index 00000000000..b8638be0583 --- /dev/null +++ b/.changelog/bacf869ab83a47b29c19349bb8cfb042.json @@ -0,0 +1,397 @@ +{ + "id": "bacf869a-b83a-47b2-9c19-349bb8cfb042", + "type": "bugfix", + "collapse": true, + "description": "GoDoc improvement", + "modules": [ + "internal/protocoltest/awsrestjson", + "internal/protocoltest/ec2query", + "internal/protocoltest/jsonrpc", + "internal/protocoltest/jsonrpc10", + "internal/protocoltest/query", + "internal/protocoltest/restxml", + "internal/protocoltest/restxmlwithnamespace", + "internal/protocoltest/smithyrpcv2cbor", + "service/accessanalyzer", + "service/account", + "service/acm", + "service/acmpca", + "service/amp", + "service/amplify", + "service/amplifybackend", + "service/amplifyuibuilder", + "service/apigateway", + "service/apigatewaymanagementapi", + "service/apigatewayv2", + "service/appconfig", + "service/appconfigdata", + "service/appfabric", + "service/appflow", + "service/appintegrations", + "service/applicationautoscaling", + "service/applicationcostprofiler", + "service/applicationdiscoveryservice", + "service/applicationinsights", + "service/appmesh", + "service/apprunner", + "service/appstream", + "service/appsync", + "service/arczonalshift", + "service/artifact", + "service/athena", + "service/auditmanager", + "service/autoscaling", + "service/autoscalingplans", + "service/b2bi", + "service/backup", + "service/backupgateway", + "service/backupstorage", + "service/batch", + "service/bcmdataexports", + "service/bedrock", + "service/bedrockagent", + "service/bedrockagentruntime", + "service/bedrockruntime", + "service/billingconductor", + "service/braket", + "service/budgets", + "service/chatbot", + "service/chime", + "service/chimesdkidentity", + "service/chimesdkmediapipelines", + "service/chimesdkmeetings", + "service/chimesdkmessaging", + "service/chimesdkvoice", + "service/cleanrooms", + "service/cleanroomsml", + "service/cloud9", + "service/cloudcontrol", + "service/clouddirectory", + "service/cloudformation", + "service/cloudfront", + "service/cloudfrontkeyvaluestore", + "service/cloudhsm", + "service/cloudhsmv2", + "service/cloudsearch", + "service/cloudsearchdomain", + "service/cloudtrail", + "service/cloudtraildata", + "service/cloudwatch", + "service/cloudwatchevents", + "service/cloudwatchlogs", + "service/codeartifact", + "service/codebuild", + "service/codecatalyst", + "service/codecommit", + "service/codeconnections", + "service/codedeploy", + "service/codeguruprofiler", + "service/codegurureviewer", + "service/codegurusecurity", + "service/codepipeline", + "service/codestar", + "service/codestarconnections", + "service/codestarnotifications", + "service/cognitoidentity", + "service/cognitoidentityprovider", + "service/cognitosync", + "service/comprehend", + "service/comprehendmedical", + "service/computeoptimizer", + "service/configservice", + "service/connect", + "service/connectcampaigns", + "service/connectcases", + "service/connectcontactlens", + "service/connectparticipant", + "service/controlcatalog", + "service/controltower", + "service/costandusagereportservice", + "service/costexplorer", + "service/costoptimizationhub", + "service/customerprofiles", + "service/databasemigrationservice", + "service/databrew", + "service/dataexchange", + "service/datapipeline", + "service/datasync", + "service/datazone", + "service/dax", + "service/deadline", + "service/detective", + "service/devicefarm", + "service/devopsguru", + "service/directconnect", + "service/directoryservice", + "service/dlm", + "service/docdb", + "service/docdbelastic", + "service/drs", + "service/dynamodb", + "service/dynamodbstreams", + "service/ebs", + "service/ec2", + "service/ec2instanceconnect", + "service/ecr", + "service/ecrpublic", + "service/ecs", + "service/efs", + "service/eks", + "service/eksauth", + "service/elasticache", + "service/elasticbeanstalk", + "service/elasticinference", + "service/elasticloadbalancing", + "service/elasticloadbalancingv2", + "service/elasticsearchservice", + "service/elastictranscoder", + "service/emr", + "service/emrcontainers", + "service/emrserverless", + "service/entityresolution", + "service/eventbridge", + "service/evidently", + "service/finspace", + "service/finspacedata", + "service/firehose", + "service/fis", + "service/fms", + "service/forecast", + "service/forecastquery", + "service/frauddetector", + "service/freetier", + "service/fsx", + "service/gamelift", + "service/glacier", + "service/globalaccelerator", + "service/glue", + "service/grafana", + "service/greengrass", + "service/greengrassv2", + "service/groundstation", + "service/guardduty", + "service/health", + "service/healthlake", + "service/honeycode", + "service/iam", + "service/identitystore", + "service/imagebuilder", + "service/inspector", + "service/inspector2", + "service/inspectorscan", + "service/internetmonitor", + "service/iot", + "service/iot1clickdevicesservice", + "service/iot1clickprojects", + "service/iotanalytics", + "service/iotdataplane", + "service/iotdeviceadvisor", + "service/iotevents", + "service/ioteventsdata", + "service/iotfleethub", + "service/iotfleetwise", + "service/iotjobsdataplane", + "service/iotsecuretunneling", + "service/iotsitewise", + "service/iotthingsgraph", + "service/iottwinmaker", + "service/iotwireless", + "service/ivs", + "service/ivschat", + "service/ivsrealtime", + "service/kafka", + "service/kafkaconnect", + "service/kendra", + "service/kendraranking", + "service/keyspaces", + "service/kinesis", + "service/kinesisanalytics", + "service/kinesisanalyticsv2", + "service/kinesisvideo", + "service/kinesisvideoarchivedmedia", + "service/kinesisvideomedia", + "service/kinesisvideosignaling", + "service/kinesisvideowebrtcstorage", + "service/kms", + "service/lakeformation", + "service/lambda", + "service/launchwizard", + "service/lexmodelbuildingservice", + "service/lexmodelsv2", + "service/lexruntimeservice", + "service/lexruntimev2", + "service/licensemanager", + "service/licensemanagerlinuxsubscriptions", + "service/licensemanagerusersubscriptions", + "service/lightsail", + "service/location", + "service/lookoutequipment", + "service/lookoutmetrics", + "service/lookoutvision", + "service/m2", + "service/machinelearning", + "service/macie2", + "service/managedblockchain", + "service/managedblockchainquery", + "service/marketplaceagreement", + "service/marketplacecatalog", + "service/marketplacecommerceanalytics", + "service/marketplacedeployment", + "service/marketplaceentitlementservice", + "service/marketplacemetering", + "service/mediaconnect", + "service/mediaconvert", + "service/medialive", + "service/mediapackage", + "service/mediapackagev2", + "service/mediapackagevod", + "service/mediastore", + "service/mediastoredata", + "service/mediatailor", + "service/medicalimaging", + "service/memorydb", + "service/mgn", + "service/migrationhub", + "service/migrationhubconfig", + "service/migrationhuborchestrator", + "service/migrationhubrefactorspaces", + "service/migrationhubstrategy", + "service/mobile", + "service/mq", + "service/mturk", + "service/mwaa", + "service/neptune", + "service/neptunedata", + "service/neptunegraph", + "service/networkfirewall", + "service/networkmanager", + "service/networkmonitor", + "service/nimble", + "service/oam", + "service/omics", + "service/opensearch", + "service/opensearchserverless", + "service/opsworks", + "service/opsworkscm", + "service/organizations", + "service/osis", + "service/outposts", + "service/panorama", + "service/paymentcryptography", + "service/paymentcryptographydata", + "service/pcaconnectorad", + "service/personalize", + "service/personalizeevents", + "service/personalizeruntime", + "service/pi", + "service/pinpoint", + "service/pinpointemail", + "service/pinpointsmsvoice", + "service/pinpointsmsvoicev2", + "service/pipes", + "service/polly", + "service/pricing", + "service/privatenetworks", + "service/proton", + "service/qbusiness", + "service/qconnect", + "service/qldb", + "service/qldbsession", + "service/quicksight", + "service/ram", + "service/rbin", + "service/rds", + "service/rdsdata", + "service/redshift", + "service/redshiftdata", + "service/redshiftserverless", + "service/rekognition", + "service/repostspace", + "service/resiliencehub", + "service/resourceexplorer2", + "service/resourcegroups", + "service/resourcegroupstaggingapi", + "service/robomaker", + "service/rolesanywhere", + "service/route53", + "service/route53domains", + "service/route53profiles", + "service/route53recoverycluster", + "service/route53recoverycontrolconfig", + "service/route53recoveryreadiness", + "service/route53resolver", + "service/rum", + "service/s3", + "service/s3control", + "service/s3outposts", + "service/sagemaker", + "service/sagemakera2iruntime", + "service/sagemakeredge", + "service/sagemakerfeaturestoreruntime", + "service/sagemakergeospatial", + "service/sagemakermetrics", + "service/sagemakerruntime", + "service/savingsplans", + "service/scheduler", + "service/schemas", + "service/secretsmanager", + "service/securityhub", + "service/securitylake", + "service/serverlessapplicationrepository", + "service/servicecatalog", + "service/servicecatalogappregistry", + "service/servicediscovery", + "service/servicequotas", + "service/ses", + "service/sesv2", + "service/sfn", + "service/shield", + "service/signer", + "service/simspaceweaver", + "service/sms", + "service/snowball", + "service/snowdevicemanagement", + "service/sns", + "service/sqs", + "service/ssm", + "service/ssmcontacts", + "service/ssmincidents", + "service/ssmsap", + "service/sso", + "service/ssoadmin", + "service/ssooidc", + "service/storagegateway", + "service/sts", + "service/supplychain", + "service/support", + "service/supportapp", + "service/swf", + "service/synthetics", + "service/textract", + "service/timestreaminfluxdb", + "service/timestreamquery", + "service/timestreamwrite", + "service/tnb", + "service/transcribe", + "service/transcribestreaming", + "service/transfer", + "service/translate", + "service/trustedadvisor", + "service/verifiedpermissions", + "service/voiceid", + "service/vpclattice", + "service/waf", + "service/wafregional", + "service/wafv2", + "service/wellarchitected", + "service/wisdom", + "service/workdocs", + "service/worklink", + "service/workmail", + "service/workmailmessageflow", + "service/workspaces", + "service/workspacesthinclient", + "service/workspacesweb", + "service/xray" + ] +} \ No newline at end of file diff --git a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go index 19589229628..bc63167dad8 100644 --- a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has four possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A BadRequest error. diff --git a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go index 844cf2819a5..e15284f2615 100644 --- a/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go +++ b/internal/protocoltest/awsrestjson/api_op_GreetingWithErrors_test.go @@ -130,8 +130,9 @@ func TestClient_GreetingWithErrors_FooError_awsRestjson1Deserialize(t *testing.T // 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. + // is to be interpreted as 'ValidationException'. + // + // For an example service see Amazon Polly. "RestJsonFooErrorUsingXAmznErrorTypeWithUri": { StatusCode: 500, Header: http.Header{ @@ -152,8 +153,9 @@ func TestClient_GreetingWithErrors_FooError_awsRestjson1Deserialize(t *testing.T // This example uses the 'code' property in the output rather than // X-Amzn-Errortype. Some services do this though it's preferable to send the // X-Amzn-Errortype. Client implementations must first check for the - // X-Amzn-Errortype and then check for a top-level 'code' property. For example - // service see Amazon S3 Glacier. + // X-Amzn-Errortype and then check for a top-level 'code' property. + // + // For example service see Amazon S3 Glacier. "RestJsonFooErrorUsingCode": { StatusCode: 500, Header: http.Header{ diff --git a/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go b/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go index 92e0d67f22c..74785286fd3 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpPayloadTraits.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example serializes a blob shape in the payload. In this example, no JSON -// document is synthesized because the payload is not a structure or a union type. +// This example serializes a blob shape in the payload. +// +// In this example, no JSON document is synthesized because the payload is not a +// structure or a union type. func (c *Client) HttpPayloadTraits(ctx context.Context, params *HttpPayloadTraitsInput, optFns ...func(*Options)) (*HttpPayloadTraitsOutput, error) { if params == nil { params = &HttpPayloadTraitsInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_HttpPayloadWithStructure.go b/internal/protocoltest/awsrestjson/api_op_HttpPayloadWithStructure.go index 3255271afb6..6275d07ce24 100644 --- a/internal/protocoltest/awsrestjson/api_op_HttpPayloadWithStructure.go +++ b/internal/protocoltest/awsrestjson/api_op_HttpPayloadWithStructure.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example serializes a structure in the payload. Note that serializing a -// structure changes the wrapper element name to match the targeted structure. +// This example serializes a structure in the payload. +// +// Note that serializing a structure changes the wrapper element name to match the +// targeted structure. func (c *Client) HttpPayloadWithStructure(ctx context.Context, params *HttpPayloadWithStructureInput, optFns ...func(*Options)) (*HttpPayloadWithStructureOutput, error) { if params == nil { params = &HttpPayloadWithStructureInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_JsonLists.go b/internal/protocoltest/awsrestjson/api_op_JsonLists.go index 68e6cf7a328..6d4ea0eaf76 100644 --- a/internal/protocoltest/awsrestjson/api_op_JsonLists.go +++ b/internal/protocoltest/awsrestjson/api_op_JsonLists.go @@ -14,6 +14,7 @@ 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. diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go index 914fb047cf9..67344c09d63 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraits.go @@ -11,9 +11,10 @@ import ( "io" ) -// This examples serializes a streaming blob shape in the request body. In this -// example, no JSON document is synthesized because the payload is not a structure -// or a union type. +// This examples serializes a streaming blob shape in the request body. +// +// In this example, no JSON document is synthesized because the payload is not a +// structure or a union type. func (c *Client) StreamingTraits(ctx context.Context, params *StreamingTraitsInput, optFns ...func(*Options)) (*StreamingTraitsOutput, error) { if params == nil { params = &StreamingTraitsInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go index 5fb84dd07e2..5c4372d34e2 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsRequireLength.go @@ -12,8 +12,10 @@ import ( ) // This examples serializes a streaming blob shape with a required content length -// in the request body. In this example, no JSON document is synthesized because -// the payload is not a structure or a union type. +// in the request body. +// +// In this example, no JSON document is synthesized because the payload is not a +// structure or a union type. func (c *Client) StreamingTraitsRequireLength(ctx context.Context, params *StreamingTraitsRequireLengthInput, optFns ...func(*Options)) (*StreamingTraitsRequireLengthOutput, error) { if params == nil { params = &StreamingTraitsRequireLengthInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go index e2f610aabda..1d18e84c8f4 100644 --- a/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go +++ b/internal/protocoltest/awsrestjson/api_op_StreamingTraitsWithMediaType.go @@ -11,8 +11,9 @@ 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 f8f5464bce0..a39358b7e9f 100644 --- a/internal/protocoltest/awsrestjson/api_op_TestBodyStructure.go +++ b/internal/protocoltest/awsrestjson/api_op_TestBodyStructure.go @@ -11,9 +11,10 @@ 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_TestNoPayload.go b/internal/protocoltest/awsrestjson/api_op_TestNoPayload.go index 732d3020017..6d67880b1e5 100644 --- a/internal/protocoltest/awsrestjson/api_op_TestNoPayload.go +++ b/internal/protocoltest/awsrestjson/api_op_TestNoPayload.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example operation serializes a request without an HTTP body. These tests -// are to ensure we do not attach a body or related headers (Content-Length, -// Content-Type) to operations that semantically cannot produce an HTTP body. +// This example operation serializes a request without an HTTP body. +// +// These tests are to ensure we do not attach a body or related headers +// (Content-Length, Content-Type) to operations that semantically cannot produce an +// HTTP body. func (c *Client) TestNoPayload(ctx context.Context, params *TestNoPayloadInput, optFns ...func(*Options)) (*TestNoPayloadOutput, error) { if params == nil { params = &TestNoPayloadInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_TestPayloadBlob.go b/internal/protocoltest/awsrestjson/api_op_TestPayloadBlob.go index e79dac93981..5791b2726ac 100644 --- a/internal/protocoltest/awsrestjson/api_op_TestPayloadBlob.go +++ b/internal/protocoltest/awsrestjson/api_op_TestPayloadBlob.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example operation serializes a payload targeting a blob. The Blob shape is -// not structured content and we cannot make assumptions about what data will be -// sent. This test ensures only a generic "Content-Type: application/octet-stream" -// header is used, and that we are not treating an empty body as an empty JSON -// document. +// This example operation serializes a payload targeting a blob. +// +// The Blob shape is not structured content and we cannot make assumptions about +// what data will be sent. This test ensures only a generic "Content-Type: +// application/octet-stream" header is used, and that we are not treating an empty +// body as an empty JSON document. func (c *Client) TestPayloadBlob(ctx context.Context, params *TestPayloadBlobInput, optFns ...func(*Options)) (*TestPayloadBlobOutput, error) { if params == nil { params = &TestPayloadBlobInput{} diff --git a/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go b/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go index 8a13e91f068..7b5a028ee1b 100644 --- a/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go +++ b/internal/protocoltest/awsrestjson/api_op_TestPayloadStructure.go @@ -11,9 +11,10 @@ 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/options.go b/internal/protocoltest/awsrestjson/options.go index 001777cf985..962d9f1bd08 100644 --- a/internal/protocoltest/awsrestjson/options.go +++ b/internal/protocoltest/awsrestjson/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -81,17 +83,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -108,8 +113,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -154,6 +160,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/awsrestjson/types/enums.go b/internal/protocoltest/awsrestjson/types/enums.go index a9a2312d5b7..45cedce552e 100644 --- a/internal/protocoltest/awsrestjson/types/enums.go +++ b/internal/protocoltest/awsrestjson/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for StringEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StringEnum) Values() []StringEnum { return []StringEnum{ "enumvalue", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/internal/protocoltest/ec2query/api_op_EmptyInputAndEmptyOutput.go b/internal/protocoltest/ec2query/api_op_EmptyInputAndEmptyOutput.go index 83ded623372..cccefcaed96 100644 --- a/internal/protocoltest/ec2query/api_op_EmptyInputAndEmptyOutput.go +++ b/internal/protocoltest/ec2query/api_op_EmptyInputAndEmptyOutput.go @@ -11,8 +11,9 @@ import ( ) // The example tests how requests and responses are serialized when there's no -// request or response members. While this should be rare, code generators must -// support this. +// request or response members. +// +// While this should be rare, code generators must support this. func (c *Client) EmptyInputAndEmptyOutput(ctx context.Context, params *EmptyInputAndEmptyOutputInput, optFns ...func(*Options)) (*EmptyInputAndEmptyOutputOutput, error) { if params == nil { params = &EmptyInputAndEmptyOutputInput{} diff --git a/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go b/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go index 451f33e661c..8ab55a68842 100644 --- a/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/ec2query/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has three possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A BadRequest error. diff --git a/internal/protocoltest/ec2query/api_op_IgnoresWrappingXmlName.go b/internal/protocoltest/ec2query/api_op_IgnoresWrappingXmlName.go index 6e82786bd93..b0035974e88 100644 --- a/internal/protocoltest/ec2query/api_op_IgnoresWrappingXmlName.go +++ b/internal/protocoltest/ec2query/api_op_IgnoresWrappingXmlName.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The xmlName trait on the output structure is ignored in AWS Query. The wrapping -// element is always operation name + "Response". +// The xmlName trait on the output structure is ignored in AWS Query. +// +// The wrapping element is always operation name + "Response". func (c *Client) IgnoresWrappingXmlName(ctx context.Context, params *IgnoresWrappingXmlNameInput, optFns ...func(*Options)) (*IgnoresWrappingXmlNameOutput, error) { if params == nil { params = &IgnoresWrappingXmlNameInput{} diff --git a/internal/protocoltest/ec2query/api_op_NoInputAndOutput.go b/internal/protocoltest/ec2query/api_op_NoInputAndOutput.go index f20019b7f8a..35805e06a20 100644 --- a/internal/protocoltest/ec2query/api_op_NoInputAndOutput.go +++ b/internal/protocoltest/ec2query/api_op_NoInputAndOutput.go @@ -11,8 +11,9 @@ import ( ) // The example tests how requests and responses are serialized when there's no -// request payload or response members. While this should be rare, code generators -// must support this. +// request payload or response members. +// +// While this should be rare, code generators must support this. func (c *Client) NoInputAndOutput(ctx context.Context, params *NoInputAndOutputInput, optFns ...func(*Options)) (*NoInputAndOutputOutput, error) { if params == nil { params = &NoInputAndOutputInput{} diff --git a/internal/protocoltest/ec2query/api_op_QueryTimestamps.go b/internal/protocoltest/ec2query/api_op_QueryTimestamps.go index a60ff2ae957..3df28627ff6 100644 --- a/internal/protocoltest/ec2query/api_op_QueryTimestamps.go +++ b/internal/protocoltest/ec2query/api_op_QueryTimestamps.go @@ -12,6 +12,7 @@ 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 diff --git a/internal/protocoltest/ec2query/api_op_XmlLists.go b/internal/protocoltest/ec2query/api_op_XmlLists.go index 46312cb4e81..2fff73f3290 100644 --- a/internal/protocoltest/ec2query/api_op_XmlLists.go +++ b/internal/protocoltest/ec2query/api_op_XmlLists.go @@ -14,6 +14,7 @@ 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. diff --git a/internal/protocoltest/ec2query/options.go b/internal/protocoltest/ec2query/options.go index 973ef575134..cc5134ecf39 100644 --- a/internal/protocoltest/ec2query/options.go +++ b/internal/protocoltest/ec2query/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -81,17 +83,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -108,8 +113,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -154,6 +160,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/ec2query/types/enums.go b/internal/protocoltest/ec2query/types/enums.go index 6652e863c7a..f0cbe93725d 100644 --- a/internal/protocoltest/ec2query/types/enums.go +++ b/internal/protocoltest/ec2query/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go index 90b4086da86..b52012d39a2 100644 --- a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has three possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A ComplexError error. diff --git a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go index 3f1f58852c1..760b0c43f93 100644 --- a/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go +++ b/internal/protocoltest/jsonrpc/api_op_GreetingWithErrors_test.go @@ -249,8 +249,9 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson11Deserialize(t *testing.T // 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. + // is to be interpreted as 'ValidationException'. + // + // For an example service see Amazon Polly. "AwsJson11FooErrorUsingXAmznErrorTypeWithUri": { StatusCode: 500, Header: http.Header{ @@ -271,8 +272,9 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson11Deserialize(t *testing.T // This example uses the 'code' property in the output rather than // X-Amzn-Errortype. Some services do this though it's preferable to send the // X-Amzn-Errortype. Client implementations must first check for the - // X-Amzn-Errortype and then check for a top-level 'code' property. For example - // service see Amazon S3 Glacier. + // X-Amzn-Errortype and then check for a top-level 'code' property. + // + // For example service see Amazon S3 Glacier. "AwsJson11FooErrorUsingCode": { StatusCode: 500, Header: http.Header{ diff --git a/internal/protocoltest/jsonrpc/options.go b/internal/protocoltest/jsonrpc/options.go index 9630316047b..0407c40cda0 100644 --- a/internal/protocoltest/jsonrpc/options.go +++ b/internal/protocoltest/jsonrpc/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -77,17 +79,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -104,8 +109,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -150,6 +156,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/jsonrpc/types/enums.go b/internal/protocoltest/jsonrpc/types/enums.go index a0088b218b8..49fef81a21f 100644 --- a/internal/protocoltest/jsonrpc/types/enums.go +++ b/internal/protocoltest/jsonrpc/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go index ae2a7fc519c..67ea0c60a0b 100644 --- a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has three possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A ComplexError error. diff --git a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go index 16e74fdb965..2128ff9f165 100644 --- a/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go +++ b/internal/protocoltest/jsonrpc10/api_op_GreetingWithErrors_test.go @@ -134,8 +134,9 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson10Deserialize(t *testing.T // 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. + // is to be interpreted as 'ValidationException'. + // + // For an example service see Amazon Polly. "AwsJson10FooErrorUsingXAmznErrorTypeWithUri": { StatusCode: 500, Header: http.Header{ @@ -156,8 +157,9 @@ func TestClient_GreetingWithErrors_FooError_awsAwsjson10Deserialize(t *testing.T // This example uses the 'code' property in the output rather than // X-Amzn-Errortype. Some services do this though it's preferable to send the // X-Amzn-Errortype. Client implementations must first check for the - // X-Amzn-Errortype and then check for a top-level 'code' property. For example - // service see Amazon S3 Glacier. + // X-Amzn-Errortype and then check for a top-level 'code' property. + // + // For example service see Amazon S3 Glacier. "AwsJson10FooErrorUsingCode": { StatusCode: 500, Header: http.Header{ diff --git a/internal/protocoltest/jsonrpc10/options.go b/internal/protocoltest/jsonrpc10/options.go index b4410a8fedb..b53698ccdc0 100644 --- a/internal/protocoltest/jsonrpc10/options.go +++ b/internal/protocoltest/jsonrpc10/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -77,17 +79,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -104,8 +109,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -150,6 +156,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/jsonrpc10/types/enums.go b/internal/protocoltest/jsonrpc10/types/enums.go index 14f15a9f2c3..cdf0d71f0e2 100644 --- a/internal/protocoltest/jsonrpc10/types/enums.go +++ b/internal/protocoltest/jsonrpc10/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for TestEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestEnum) Values() []TestEnum { return []TestEnum{ "FOO", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/internal/protocoltest/query/api_op_EmptyInputAndEmptyOutput.go b/internal/protocoltest/query/api_op_EmptyInputAndEmptyOutput.go index 4fcc87402ea..35bb723228e 100644 --- a/internal/protocoltest/query/api_op_EmptyInputAndEmptyOutput.go +++ b/internal/protocoltest/query/api_op_EmptyInputAndEmptyOutput.go @@ -11,8 +11,9 @@ import ( ) // The example tests how requests and responses are serialized when there's no -// request or response members. While this should be rare, code generators must -// support this. +// request or response members. +// +// While this should be rare, code generators must support this. func (c *Client) EmptyInputAndEmptyOutput(ctx context.Context, params *EmptyInputAndEmptyOutputInput, optFns ...func(*Options)) (*EmptyInputAndEmptyOutputOutput, error) { if params == nil { params = &EmptyInputAndEmptyOutputInput{} diff --git a/internal/protocoltest/query/api_op_GreetingWithErrors.go b/internal/protocoltest/query/api_op_GreetingWithErrors.go index fe06c7f987e..07efd662333 100644 --- a/internal/protocoltest/query/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/query/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has three possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A BadRequest error. diff --git a/internal/protocoltest/query/api_op_IgnoresWrappingXmlName.go b/internal/protocoltest/query/api_op_IgnoresWrappingXmlName.go index e04a3a72ff7..5ffe6a63c1d 100644 --- a/internal/protocoltest/query/api_op_IgnoresWrappingXmlName.go +++ b/internal/protocoltest/query/api_op_IgnoresWrappingXmlName.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The xmlName trait on the output structure is ignored in AWS Query. The wrapping -// element is always operation name + "Response", and inside of that wrapper is -// another wrapper named operation name + "Result". +// The xmlName trait on the output structure is ignored in AWS Query. +// +// The wrapping element is always operation name + "Response", and inside of that +// wrapper is another wrapper named operation name + "Result". func (c *Client) IgnoresWrappingXmlName(ctx context.Context, params *IgnoresWrappingXmlNameInput, optFns ...func(*Options)) (*IgnoresWrappingXmlNameOutput, error) { if params == nil { params = &IgnoresWrappingXmlNameInput{} diff --git a/internal/protocoltest/query/api_op_NoInputAndNoOutput.go b/internal/protocoltest/query/api_op_NoInputAndNoOutput.go index 2a2db844946..b5b74c67c13 100644 --- a/internal/protocoltest/query/api_op_NoInputAndNoOutput.go +++ b/internal/protocoltest/query/api_op_NoInputAndNoOutput.go @@ -11,8 +11,9 @@ import ( ) // The example tests how requests and responses are serialized when there's no -// request or response payload because the operation has no input or output. While -// this should be rare, code generators must support this. +// request or response payload because the operation has no input or output. +// +// While this should be rare, code generators must support this. func (c *Client) NoInputAndNoOutput(ctx context.Context, params *NoInputAndNoOutputInput, optFns ...func(*Options)) (*NoInputAndNoOutputOutput, error) { if params == nil { params = &NoInputAndNoOutputInput{} diff --git a/internal/protocoltest/query/api_op_NoInputAndOutput.go b/internal/protocoltest/query/api_op_NoInputAndOutput.go index dd60a4e112e..a6d15ba2595 100644 --- a/internal/protocoltest/query/api_op_NoInputAndOutput.go +++ b/internal/protocoltest/query/api_op_NoInputAndOutput.go @@ -11,8 +11,9 @@ import ( ) // The example tests how requests and responses are serialized when there's no -// request payload or response members. While this should be rare, code generators -// must support this. +// request payload or response members. +// +// While this should be rare, code generators must support this. func (c *Client) NoInputAndOutput(ctx context.Context, params *NoInputAndOutputInput, optFns ...func(*Options)) (*NoInputAndOutputOutput, error) { if params == nil { params = &NoInputAndOutputInput{} diff --git a/internal/protocoltest/query/api_op_QueryTimestamps.go b/internal/protocoltest/query/api_op_QueryTimestamps.go index d4c15f2f843..ef8d2c46c10 100644 --- a/internal/protocoltest/query/api_op_QueryTimestamps.go +++ b/internal/protocoltest/query/api_op_QueryTimestamps.go @@ -12,6 +12,7 @@ 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 diff --git a/internal/protocoltest/query/api_op_XmlLists.go b/internal/protocoltest/query/api_op_XmlLists.go index de8ab7b97aa..e0963f0a099 100644 --- a/internal/protocoltest/query/api_op_XmlLists.go +++ b/internal/protocoltest/query/api_op_XmlLists.go @@ -14,6 +14,7 @@ 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. diff --git a/internal/protocoltest/query/options.go b/internal/protocoltest/query/options.go index 7886032adee..117f0e53413 100644 --- a/internal/protocoltest/query/options.go +++ b/internal/protocoltest/query/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -81,17 +83,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -108,8 +113,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -154,6 +160,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/query/types/enums.go b/internal/protocoltest/query/types/enums.go index 6652e863c7a..f0cbe93725d 100644 --- a/internal/protocoltest/query/types/enums.go +++ b/internal/protocoltest/query/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/internal/protocoltest/restxml/api_op_GreetingWithErrors.go b/internal/protocoltest/restxml/api_op_GreetingWithErrors.go index 81c51c0a506..c80515a555e 100644 --- a/internal/protocoltest/restxml/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/restxml/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has three possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A BadRequest error. diff --git a/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go b/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go index e096c722874..63d4157ccce 100644 --- a/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go +++ b/internal/protocoltest/restxml/api_op_HttpPayloadTraits.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example serializes a blob shape in the payload. In this example, no XML -// document is synthesized because the payload is not a structure or a union type. +// This example serializes a blob shape in the payload. +// +// In this example, no XML document is synthesized because the payload is not a +// structure or a union type. func (c *Client) HttpPayloadTraits(ctx context.Context, params *HttpPayloadTraitsInput, optFns ...func(*Options)) (*HttpPayloadTraitsOutput, error) { if params == nil { params = &HttpPayloadTraitsInput{} diff --git a/internal/protocoltest/restxml/api_op_HttpPayloadWithStructure.go b/internal/protocoltest/restxml/api_op_HttpPayloadWithStructure.go index 098890ffce8..7088ed98247 100644 --- a/internal/protocoltest/restxml/api_op_HttpPayloadWithStructure.go +++ b/internal/protocoltest/restxml/api_op_HttpPayloadWithStructure.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This example serializes a structure in the payload. Note that serializing a -// structure changes the wrapper element name to match the targeted structure. +// This example serializes a structure in the payload. +// +// Note that serializing a structure changes the wrapper element name to match the +// targeted structure. func (c *Client) HttpPayloadWithStructure(ctx context.Context, params *HttpPayloadWithStructureInput, optFns ...func(*Options)) (*HttpPayloadWithStructureOutput, error) { if params == nil { params = &HttpPayloadWithStructureInput{} diff --git a/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go b/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go index 59d08a31aff..2415f422186 100644 --- a/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go +++ b/internal/protocoltest/restxml/api_op_SimpleScalarProperties_test.go @@ -305,11 +305,14 @@ 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 439f2298255..6f8c106f845 100644 --- a/internal/protocoltest/restxml/api_op_XmlLists.go +++ b/internal/protocoltest/restxml/api_op_XmlLists.go @@ -14,6 +14,7 @@ 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. diff --git a/internal/protocoltest/restxml/options.go b/internal/protocoltest/restxml/options.go index fde261ba734..e8fd5423244 100644 --- a/internal/protocoltest/restxml/options.go +++ b/internal/protocoltest/restxml/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -81,17 +83,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -108,8 +113,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -154,6 +160,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/restxml/types/enums.go b/internal/protocoltest/restxml/types/enums.go index a9a2312d5b7..45cedce552e 100644 --- a/internal/protocoltest/restxml/types/enums.go +++ b/internal/protocoltest/restxml/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for StringEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StringEnum) Values() []StringEnum { return []StringEnum{ "enumvalue", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/internal/protocoltest/restxmlwithnamespace/doc.go b/internal/protocoltest/restxmlwithnamespace/doc.go index 3ecca767b43..2cd246d45ba 100644 --- a/internal/protocoltest/restxmlwithnamespace/doc.go +++ b/internal/protocoltest/restxmlwithnamespace/doc.go @@ -3,8 +3,11 @@ // Package restxmlwithnamespace provides the API client, operations, and parameter // types for Sample Rest Xml Protocol Service With Namespace. // -// A REST XML service that sends XML requests and responses. This service and test -// case is complementary to the test cases in the restXml directory, but the -// service under test here has the xmlNamespace trait applied to it. See -// https://github.com/awslabs/smithy/issues/616 +// A REST XML service that sends XML requests and responses. +// +// This service and test case is complementary to the test cases in the restXml +// directory, but the service under test here has the xmlNamespace trait applied +// to it. +// +// See https://github.com/awslabs/smithy/issues/616 package restxmlwithnamespace diff --git a/internal/protocoltest/restxmlwithnamespace/options.go b/internal/protocoltest/restxmlwithnamespace/options.go index 74691069060..2361a83b595 100644 --- a/internal/protocoltest/restxmlwithnamespace/options.go +++ b/internal/protocoltest/restxmlwithnamespace/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/smithyrpcv2cbor/api_op_GreetingWithErrors.go b/internal/protocoltest/smithyrpcv2cbor/api_op_GreetingWithErrors.go index 8c4c5d646cf..69942fb9a3e 100644 --- a/internal/protocoltest/smithyrpcv2cbor/api_op_GreetingWithErrors.go +++ b/internal/protocoltest/smithyrpcv2cbor/api_op_GreetingWithErrors.go @@ -11,6 +11,7 @@ import ( ) // This operation has three possible return values: +// // - A successful response in the form of GreetingWithErrorsOutput // - An InvalidGreeting error. // - A ComplexError error. diff --git a/internal/protocoltest/smithyrpcv2cbor/api_op_RpcV2CborLists.go b/internal/protocoltest/smithyrpcv2cbor/api_op_RpcV2CborLists.go index b05fa1dc40e..91842886da2 100644 --- a/internal/protocoltest/smithyrpcv2cbor/api_op_RpcV2CborLists.go +++ b/internal/protocoltest/smithyrpcv2cbor/api_op_RpcV2CborLists.go @@ -14,6 +14,7 @@ import ( // This test case serializes JSON lists for the following cases for both input and // output: +// // - Normal lists. // - Normal sets. // - Lists of lists. diff --git a/internal/protocoltest/smithyrpcv2cbor/options.go b/internal/protocoltest/smithyrpcv2cbor/options.go index d22a18ab04c..f01eca98eaa 100644 --- a/internal/protocoltest/smithyrpcv2cbor/options.go +++ b/internal/protocoltest/smithyrpcv2cbor/options.go @@ -44,8 +44,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -61,17 +63,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -88,8 +93,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -132,6 +138,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/internal/protocoltest/smithyrpcv2cbor/types/enums.go b/internal/protocoltest/smithyrpcv2cbor/types/enums.go index 14f15a9f2c3..cdf0d71f0e2 100644 --- a/internal/protocoltest/smithyrpcv2cbor/types/enums.go +++ b/internal/protocoltest/smithyrpcv2cbor/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for TestEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestEnum) Values() []TestEnum { return []TestEnum{ "FOO", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for FooEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FooEnum) Values() []FooEnum { return []FooEnum{ "Foo", diff --git a/service/accessanalyzer/api_op_CheckAccessNotGranted.go b/service/accessanalyzer/api_op_CheckAccessNotGranted.go index 35cdf19aae2..9fb56475a23 100644 --- a/service/accessanalyzer/api_op_CheckAccessNotGranted.go +++ b/service/accessanalyzer/api_op_CheckAccessNotGranted.go @@ -42,11 +42,12 @@ type CheckAccessNotGrantedInput struct { // The type of policy. Identity policies grant permissions to IAM principals. // Identity policies include managed and inline policies for IAM roles, users, and - // groups. Resource policies grant permissions on Amazon Web Services resources. - // Resource policies include trust policies for IAM roles and bucket policies for - // Amazon S3 buckets. You can provide a generic input such as identity policy or - // resource policy or a specific input such as managed policy or Amazon S3 bucket - // policy. + // groups. + // + // Resource policies grant permissions on Amazon Web Services resources. Resource + // policies include trust policies for IAM roles and bucket policies for Amazon S3 + // buckets. You can provide a generic input such as identity policy or resource + // policy or a specific input such as managed policy or Amazon S3 bucket policy. // // This member is required. PolicyType types.AccessCheckPolicyType diff --git a/service/accessanalyzer/api_op_CheckNoNewAccess.go b/service/accessanalyzer/api_op_CheckNoNewAccess.go index e772dc04bcb..56231a60f51 100644 --- a/service/accessanalyzer/api_op_CheckNoNewAccess.go +++ b/service/accessanalyzer/api_op_CheckNoNewAccess.go @@ -12,11 +12,14 @@ import ( ) // Checks whether new access is allowed for an updated policy when compared to the -// existing policy. You can find examples for reference policies and learn how to -// set up and run a custom policy check for new access in the IAM Access Analyzer -// custom policy checks samples (https://github.com/aws-samples/iam-access-analyzer-custom-policy-check-samples) -// repository on GitHub. The reference policies in this repository are meant to be -// passed to the existingPolicyDocument request parameter. +// existing policy. +// +// You can find examples for reference policies and learn how to set up and run a +// custom policy check for new access in the [IAM Access Analyzer custom policy checks samples]repository on GitHub. The reference +// policies in this repository are meant to be passed to the existingPolicyDocument +// request parameter. +// +// [IAM Access Analyzer custom policy checks samples]: https://github.com/aws-samples/iam-access-analyzer-custom-policy-check-samples func (c *Client) CheckNoNewAccess(ctx context.Context, params *CheckNoNewAccessInput, optFns ...func(*Options)) (*CheckNoNewAccessOutput, error) { if params == nil { params = &CheckNoNewAccessInput{} @@ -46,11 +49,12 @@ type CheckNoNewAccessInput struct { // The type of policy to compare. Identity policies grant permissions to IAM // principals. Identity policies include managed and inline policies for IAM roles, - // users, and groups. Resource policies grant permissions on Amazon Web Services - // resources. Resource policies include trust policies for IAM roles and bucket - // policies for Amazon S3 buckets. You can provide a generic input such as identity - // policy or resource policy or a specific input such as managed policy or Amazon - // S3 bucket policy. + // users, and groups. + // + // Resource policies grant permissions on Amazon Web Services resources. Resource + // policies include trust policies for IAM roles and bucket policies for Amazon S3 + // buckets. You can provide a generic input such as identity policy or resource + // policy or a specific input such as managed policy or Amazon S3 bucket policy. // // This member is required. PolicyType types.AccessCheckPolicyType diff --git a/service/accessanalyzer/api_op_CreateAccessPreview.go b/service/accessanalyzer/api_op_CreateAccessPreview.go index f8d6072852f..b04c376a787 100644 --- a/service/accessanalyzer/api_op_CreateAccessPreview.go +++ b/service/accessanalyzer/api_op_CreateAccessPreview.go @@ -30,9 +30,10 @@ 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) - // used to generate the access preview. You can only create an access preview for - // analyzers with an Account type and Active status. + // The [ARN of the account analyzer] used to generate the access preview. You can only create an access preview + // for analyzers with an Account type and Active status. + // + // [ARN of the account analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_CreateArchiveRule.go b/service/accessanalyzer/api_op_CreateArchiveRule.go index 09c2dd744ff..2e055840206 100644 --- a/service/accessanalyzer/api_op_CreateArchiveRule.go +++ b/service/accessanalyzer/api_op_CreateArchiveRule.go @@ -13,9 +13,11 @@ 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) -// in the IAM User Guide. +// +// To learn about filter keys that you can use to create an archive rule, see [IAM Access Analyzer filter keys] in +// the IAM User Guide. +// +// [IAM Access Analyzer filter keys]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html func (c *Client) CreateArchiveRule(ctx context.Context, params *CreateArchiveRuleInput, optFns ...func(*Options)) (*CreateArchiveRuleOutput, error) { if params == nil { params = &CreateArchiveRuleInput{} diff --git a/service/accessanalyzer/api_op_GetAccessPreview.go b/service/accessanalyzer/api_op_GetAccessPreview.go index 656b634ef54..214eab57eee 100644 --- a/service/accessanalyzer/api_op_GetAccessPreview.go +++ b/service/accessanalyzer/api_op_GetAccessPreview.go @@ -34,8 +34,9 @@ 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) - // used to generate the access preview. + // The [ARN of the analyzer] used to generate the access preview. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_GetAnalyzedResource.go b/service/accessanalyzer/api_op_GetAnalyzedResource.go index 657e06ea9b6..988ac3aacdb 100644 --- a/service/accessanalyzer/api_op_GetAnalyzedResource.go +++ b/service/accessanalyzer/api_op_GetAnalyzedResource.go @@ -30,8 +30,9 @@ 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) - // to retrieve information from. + // The [ARN of the analyzer] to retrieve information from. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_GetArchiveRule.go b/service/accessanalyzer/api_op_GetArchiveRule.go index b2943162627..ce84e48b6b7 100644 --- a/service/accessanalyzer/api_op_GetArchiveRule.go +++ b/service/accessanalyzer/api_op_GetArchiveRule.go @@ -11,9 +11,12 @@ 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) -// in the IAM User Guide. +// 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] in +// the IAM User Guide. +// +// [IAM Access Analyzer filter keys]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html func (c *Client) GetArchiveRule(ctx context.Context, params *GetArchiveRuleInput, optFns ...func(*Options)) (*GetArchiveRuleOutput, error) { if params == nil { params = &GetArchiveRuleInput{} diff --git a/service/accessanalyzer/api_op_GetFinding.go b/service/accessanalyzer/api_op_GetFinding.go index ed3ff298a0a..0e8e583e51c 100644 --- a/service/accessanalyzer/api_op_GetFinding.go +++ b/service/accessanalyzer/api_op_GetFinding.go @@ -33,8 +33,9 @@ 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) - // that generated the finding. + // The [ARN of the analyzer] that generated the finding. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_GetFindingV2.go b/service/accessanalyzer/api_op_GetFindingV2.go index 842d932d831..41f96224bff 100644 --- a/service/accessanalyzer/api_op_GetFindingV2.go +++ b/service/accessanalyzer/api_op_GetFindingV2.go @@ -33,8 +33,9 @@ func (c *Client) GetFindingV2(ctx context.Context, params *GetFindingV2Input, op type GetFindingV2Input struct { - // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) - // that generated the finding. + // The [ARN of the analyzer] that generated the finding. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_GetGeneratedPolicy.go b/service/accessanalyzer/api_op_GetGeneratedPolicy.go index 27cab8d4762..a59175ac8b2 100644 --- a/service/accessanalyzer/api_op_GetGeneratedPolicy.go +++ b/service/accessanalyzer/api_op_GetGeneratedPolicy.go @@ -38,15 +38,17 @@ type GetGeneratedPolicyInput struct { // The level of detail that you want to generate. You can specify whether to // 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 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 "*" . IncludeResourcePlaceholders *bool // The level of detail that you want to generate. You can specify whether to - // generate service-level policies. IAM Access Analyzer uses - // iam:servicelastaccessed to identify services that have been used recently to - // create this service-level template. + // generate service-level policies. + // + // IAM Access Analyzer uses iam:servicelastaccessed to identify services that have + // been used recently to create this service-level template. IncludeServiceLevelTemplate *bool noSmithyDocumentSerde diff --git a/service/accessanalyzer/api_op_ListAccessPreviewFindings.go b/service/accessanalyzer/api_op_ListAccessPreviewFindings.go index 0eb9659a90e..fc65e2534be 100644 --- a/service/accessanalyzer/api_op_ListAccessPreviewFindings.go +++ b/service/accessanalyzer/api_op_ListAccessPreviewFindings.go @@ -35,8 +35,9 @@ 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) - // used to generate the access. + // The [ARN of the analyzer] used to generate the access. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_ListAccessPreviews.go b/service/accessanalyzer/api_op_ListAccessPreviews.go index 79368458d69..9bd175bb1f8 100644 --- a/service/accessanalyzer/api_op_ListAccessPreviews.go +++ b/service/accessanalyzer/api_op_ListAccessPreviews.go @@ -29,8 +29,9 @@ 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) - // used to generate the access preview. + // The [ARN of the analyzer] used to generate the access preview. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_ListAnalyzedResources.go b/service/accessanalyzer/api_op_ListAnalyzedResources.go index 8303d7d76fb..8c4e1b5b1c3 100644 --- a/service/accessanalyzer/api_op_ListAnalyzedResources.go +++ b/service/accessanalyzer/api_op_ListAnalyzedResources.go @@ -32,8 +32,9 @@ 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) - // to retrieve a list of analyzed resources from. + // The [ARN of the analyzer] to retrieve a list of analyzed resources from. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_ListFindings.go b/service/accessanalyzer/api_op_ListFindings.go index 8a643a3ad4c..a9f6c9f35fd 100644 --- a/service/accessanalyzer/api_op_ListFindings.go +++ b/service/accessanalyzer/api_op_ListFindings.go @@ -14,9 +14,12 @@ import ( // Retrieves a list of findings generated by the specified analyzer. ListFindings // and ListFindingsV2 both use access-analyzer:ListFindings in the Action element // of an IAM policy statement. You must have permission to perform the -// access-analyzer:ListFindings action. 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) +// access-analyzer:ListFindings action. +// +// To learn about filter keys that you can use to retrieve a list of findings, see [IAM Access Analyzer filter keys] // in the IAM User Guide. +// +// [IAM Access Analyzer filter keys]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, optFns ...func(*Options)) (*ListFindingsOutput, error) { if params == nil { params = &ListFindingsInput{} @@ -35,8 +38,9 @@ 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) - // to retrieve findings from. + // The [ARN of the analyzer] to retrieve findings from. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_ListFindingsV2.go b/service/accessanalyzer/api_op_ListFindingsV2.go index 1b497e81c58..6b8356ed574 100644 --- a/service/accessanalyzer/api_op_ListFindingsV2.go +++ b/service/accessanalyzer/api_op_ListFindingsV2.go @@ -14,9 +14,12 @@ import ( // Retrieves a list of findings generated by the specified analyzer. ListFindings // and ListFindingsV2 both use access-analyzer:ListFindings in the Action element // of an IAM policy statement. You must have permission to perform the -// access-analyzer:ListFindings action. 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) +// access-analyzer:ListFindings action. +// +// To learn about filter keys that you can use to retrieve a list of findings, see [IAM Access Analyzer filter keys] // in the IAM User Guide. +// +// [IAM Access Analyzer filter keys]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html func (c *Client) ListFindingsV2(ctx context.Context, params *ListFindingsV2Input, optFns ...func(*Options)) (*ListFindingsV2Output, error) { if params == nil { params = &ListFindingsV2Input{} @@ -34,8 +37,9 @@ func (c *Client) ListFindingsV2(ctx context.Context, params *ListFindingsV2Input type ListFindingsV2Input struct { - // The ARN of the analyzer (https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources) - // to retrieve findings from. + // The [ARN of the analyzer] to retrieve findings from. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_StartPolicyGeneration.go b/service/accessanalyzer/api_op_StartPolicyGeneration.go index 9d1caa61347..1ab32994126 100644 --- a/service/accessanalyzer/api_op_StartPolicyGeneration.go +++ b/service/accessanalyzer/api_op_StartPolicyGeneration.go @@ -39,9 +39,10 @@ type StartPolicyGenerationInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, the // 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. + // 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. ClientToken *string // A CloudTrailDetails object that contains details about a Trail that you want to diff --git a/service/accessanalyzer/api_op_StartResourceScan.go b/service/accessanalyzer/api_op_StartResourceScan.go index 3d3693e243b..9a49b0e8711 100644 --- a/service/accessanalyzer/api_op_StartResourceScan.go +++ b/service/accessanalyzer/api_op_StartResourceScan.go @@ -29,8 +29,9 @@ 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) - // to use to scan the policies applied to the specified resource. + // The [ARN of the analyzer] to use to scan the policies applied to the specified resource. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_UpdateFindings.go b/service/accessanalyzer/api_op_UpdateFindings.go index 60265ef88c2..3f7ff819011 100644 --- a/service/accessanalyzer/api_op_UpdateFindings.go +++ b/service/accessanalyzer/api_op_UpdateFindings.go @@ -30,8 +30,9 @@ 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) - // that generated the findings to update. + // The [ARN of the analyzer] that generated the findings to update. + // + // [ARN of the analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources // // This member is required. AnalyzerArn *string diff --git a/service/accessanalyzer/api_op_ValidatePolicy.go b/service/accessanalyzer/api_op_ValidatePolicy.go index 56f0cfc0c9b..4db27009ca1 100644 --- a/service/accessanalyzer/api_op_ValidatePolicy.go +++ b/service/accessanalyzer/api_op_ValidatePolicy.go @@ -39,13 +39,15 @@ type ValidatePolicyInput struct { // The type of policy to validate. Identity policies grant permissions to IAM // principals. Identity policies include managed and inline policies for IAM roles, - // users, and groups. Resource policies grant permissions on Amazon Web Services - // resources. Resource policies include trust policies for IAM roles and bucket - // policies for Amazon S3 buckets. You can provide a generic input such as identity - // policy or resource policy or a specific input such as managed policy or Amazon - // S3 bucket policy. Service control policies (SCPs) are a type of organization - // policy attached to an Amazon Web Services organization, organizational unit - // (OU), or an account. + // users, and groups. + // + // Resource policies grant permissions on Amazon Web Services resources. Resource + // policies include trust policies for IAM roles and bucket policies for Amazon S3 + // buckets. You can provide a generic input such as identity policy or resource + // policy or a specific input such as managed policy or Amazon S3 bucket policy. + // + // Service control policies (SCPs) are a type of organization policy attached to + // an Amazon Web Services organization, organizational unit (OU), or an account. // // This member is required. PolicyType types.PolicyType @@ -62,12 +64,13 @@ type ValidatePolicyInput struct { // 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 // 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 - // apply to all resource policies. For example, to validate a resource policy to - // attach to a KMS key, do not specify a value for the policy validation resource - // type and IAM Access Analyzer will run policy checks that apply to all resource - // policies. + // 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 apply to all resource policies. For example, to validate a + // resource policy to attach to a KMS key, do not specify a value for the policy + // validation resource type and IAM Access Analyzer will run policy checks that + // apply to all resource policies. ValidatePolicyResourceType types.ValidatePolicyResourceType noSmithyDocumentSerde diff --git a/service/accessanalyzer/doc.go b/service/accessanalyzer/doc.go index 728e9ecd1a3..d24819195a8 100644 --- a/service/accessanalyzer/doc.go +++ b/service/accessanalyzer/doc.go @@ -8,23 +8,29 @@ // include findings for external and unused access, basic and custom policy checks // for validating policies, and policy generation to generate fine-grained // policies. To start using IAM Access Analyzer to identify external or unused -// access, you first need to create an analyzer. External access analyzers help -// identify potential risks of accessing resources by enabling you to identify any -// resource policies that grant access to an external principal. It does this by -// using logic-based reasoning to analyze resource-based policies in your Amazon -// Web Services environment. An external principal can be another Amazon Web -// Services account, a root user, an IAM user or role, a federated user, an Amazon -// Web Services service, or an anonymous user. You can also use IAM Access Analyzer -// to preview public and cross-account access to your resources before deploying -// permissions changes. Unused access analyzers help identify potential identity -// access risks by enabling you to identify unused IAM roles, unused access keys, -// unused console passwords, and IAM principals with unused service and -// action-level permissions. Beyond findings, IAM Access Analyzer provides basic -// and custom policy checks to validate IAM policies before deploying permissions -// changes. You can use policy generation to refine permissions by attaching a -// policy generated using access activity logged in CloudTrail logs. This guide -// describes the IAM 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) -// in the IAM User Guide. +// access, you first need to create an analyzer. +// +// External access analyzers help identify potential risks of accessing resources +// by enabling you to identify any resource policies that grant access to an +// external principal. It does this by using logic-based reasoning to analyze +// resource-based policies in your Amazon Web Services environment. An external +// principal can be another Amazon Web Services account, a root user, an IAM user +// or role, a federated user, an Amazon Web Services service, or an anonymous user. +// You can also use IAM Access Analyzer to preview public and cross-account access +// to your resources before deploying permissions changes. +// +// Unused access analyzers help identify potential identity access risks by +// enabling you to identify unused IAM roles, unused access keys, unused console +// passwords, and IAM principals with unused service and action-level permissions. +// +// Beyond findings, IAM Access Analyzer provides basic and custom policy checks to +// validate IAM policies before deploying permissions changes. You can use policy +// generation to refine permissions by attaching a policy generated using access +// activity logged in CloudTrail logs. +// +// This guide describes the IAM Access Analyzer operations that you can call +// programmatically. For general information about IAM Access Analyzer, see [Identity and Access Management Access Analyzer]in the +// IAM User Guide. +// +// [Identity and Access Management Access Analyzer]: https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html package accessanalyzer diff --git a/service/accessanalyzer/options.go b/service/accessanalyzer/options.go index ca4b79fb918..d1d702a9cd2 100644 --- a/service/accessanalyzer/options.go +++ b/service/accessanalyzer/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/accessanalyzer/types/enums.go b/service/accessanalyzer/types/enums.go index 7d55deb9bbd..0a5f32c6a00 100644 --- a/service/accessanalyzer/types/enums.go +++ b/service/accessanalyzer/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessCheckPolicyType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessCheckPolicyType) Values() []AccessCheckPolicyType { return []AccessCheckPolicyType{ "IDENTITY_POLICY", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AccessPreviewStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessPreviewStatus) Values() []AccessPreviewStatus { return []AccessPreviewStatus{ "COMPLETED", @@ -50,8 +52,9 @@ const ( // Values returns all known values for AccessPreviewStatusReasonCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessPreviewStatusReasonCode) Values() []AccessPreviewStatusReasonCode { return []AccessPreviewStatusReasonCode{ "INTERNAL_ERROR", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for AclPermission. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AclPermission) Values() []AclPermission { return []AclPermission{ "READ", @@ -94,8 +98,9 @@ const ( ) // Values returns all known values for AnalyzerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyzerStatus) Values() []AnalyzerStatus { return []AnalyzerStatus{ "ACTIVE", @@ -115,6 +120,7 @@ const ( // Values returns all known values for CheckAccessNotGrantedResult. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CheckAccessNotGrantedResult) Values() []CheckAccessNotGrantedResult { return []CheckAccessNotGrantedResult{ @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for CheckNoNewAccessResult. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CheckNoNewAccessResult) Values() []CheckNoNewAccessResult { return []CheckNoNewAccessResult{ "PASS", @@ -151,8 +158,9 @@ const ( ) // Values returns all known values for FindingChangeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingChangeType) Values() []FindingChangeType { return []FindingChangeType{ "CHANGED", @@ -172,8 +180,9 @@ const ( ) // Values returns all known values for FindingSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingSourceType) Values() []FindingSourceType { return []FindingSourceType{ "POLICY", @@ -193,8 +202,9 @@ const ( ) // Values returns all known values for FindingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingStatus) Values() []FindingStatus { return []FindingStatus{ "ACTIVE", @@ -212,8 +222,9 @@ const ( ) // Values returns all known values for FindingStatusUpdate. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingStatusUpdate) Values() []FindingStatusUpdate { return []FindingStatusUpdate{ "ACTIVE", @@ -233,8 +244,9 @@ const ( ) // Values returns all known values for FindingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingType) Values() []FindingType { return []FindingType{ "ExternalAccess", @@ -256,8 +268,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -278,8 +291,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -310,8 +324,9 @@ const ( ) // Values returns all known values for KmsGrantOperation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KmsGrantOperation) Values() []KmsGrantOperation { return []KmsGrantOperation{ "CreateGrant", @@ -348,8 +363,9 @@ const ( ) // Values returns all known values for Locale. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Locale) Values() []Locale { return []Locale{ "DE", @@ -374,8 +390,9 @@ const ( ) // Values returns all known values for OrderBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderBy) Values() []OrderBy { return []OrderBy{ "ASC", @@ -393,8 +410,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "IDENTITY_POLICY", @@ -414,8 +432,9 @@ const ( ) // Values returns all known values for ReasonCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReasonCode) Values() []ReasonCode { return []ReasonCode{ "AWS_SERVICE_ACCESS_DISABLED", @@ -448,8 +467,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -482,8 +502,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "ACCOUNT", @@ -505,6 +526,7 @@ const ( // Values returns all known values for ValidatePolicyFindingType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidatePolicyFindingType) Values() []ValidatePolicyFindingType { return []ValidatePolicyFindingType{ @@ -529,6 +551,7 @@ const ( // Values returns all known values for ValidatePolicyResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidatePolicyResourceType) Values() []ValidatePolicyResourceType { return []ValidatePolicyResourceType{ @@ -553,6 +576,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/accessanalyzer/types/types.go b/service/accessanalyzer/types/types.go index 304dd435494..711f0fc66b9 100644 --- a/service/accessanalyzer/types/types.go +++ b/service/accessanalyzer/types/types.go @@ -44,16 +44,20 @@ 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. // // This member is required. Status AccessPreviewStatus - // Provides more details about the current status of the access preview. For - // example, if the creation of the access preview fails, a Failed status is + // Provides more details about the current status of the access preview. + // + // For example, if the creation of the access preview fails, a Failed status is // returned. This failure can be due to an internal issue with the analysis or due // to an invalid resource configuration. StatusReason *AccessPreviewStatusReason @@ -66,11 +70,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. + // + // - 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. @@ -178,9 +185,12 @@ 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. // // This member is required. @@ -196,13 +206,14 @@ 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]. // // The following types satisfy this interface: // // AclGranteeMemberId // AclGranteeMemberUri +// +// [PutBucketAcl]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAcl.html type AclGrantee interface { isAclGrantee() } @@ -612,8 +623,9 @@ 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]. +// +// [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. @@ -634,15 +646,19 @@ type Criterion struct { // The proposed access control configuration for a DynamoDB stream. You can // propose a configuration for a new DynamoDB stream or an existing DynamoDB stream // that you own by specifying the policy for the DynamoDB stream. For more -// information, see PutResourcePolicy (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutResourcePolicy.html) -// . +// information, see [PutResourcePolicy]. +// // - If the configuration is for an existing DynamoDB stream and you do not // specify the DynamoDB policy, then the access preview uses the existing DynamoDB // policy for the stream. +// // - If the access preview is for a new resource and you do not specify the // policy, then the access preview assumes a DynamoDB stream without a policy. +// // - To propose deletion of an existing DynamoDB stream policy, you can specify // an empty string for the DynamoDB policy. +// +// [PutResourcePolicy]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutResourcePolicy.html type DynamodbStreamConfiguration struct { // The proposed resource policy defining who can access or manage the DynamoDB @@ -655,15 +671,19 @@ type DynamodbStreamConfiguration struct { // The proposed access control configuration for a DynamoDB table or index. You // can propose a configuration for a new DynamoDB table or index or an existing // DynamoDB table or index that you own by specifying the policy for the DynamoDB -// table or index. For more information, see PutResourcePolicy (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutResourcePolicy.html) -// . +// table or index. For more information, see [PutResourcePolicy]. +// // - If the configuration is for an existing DynamoDB table or index and you do // not specify the DynamoDB policy, then the access preview uses the existing // DynamoDB policy for the table or index. +// // - If the access preview is for a new resource and you do not specify the // policy, then the access preview assumes a DynamoDB table without a policy. +// // - To propose deletion of an existing DynamoDB table or index policy, you can // specify an empty string for the DynamoDB policy. +// +// [PutResourcePolicy]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutResourcePolicy.html type DynamodbTableConfiguration struct { // The proposed resource policy defining who can access or manage the DynamoDB @@ -676,37 +696,46 @@ type DynamodbTableConfiguration struct { // 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) -// . +// optional KMS encryption key. For more information, see [ModifySnapshotAttribute]. +// +// [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 . 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. 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 . UserIds []string @@ -717,21 +746,26 @@ 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) -// . +// information, see [Repository]. +// // - 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. +// +// [Repository]: https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Repository.html 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) - // in the Amazon ECR User Guide. + // information, see [Private repository policy examples]in the Amazon ECR User Guide. + // + // [Private repository policy examples]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html RepositoryPolicy *string noSmithyDocumentSerde @@ -740,22 +774,26 @@ type EcrRepositoryConfiguration struct { // 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) -// . +// more information, see [Using file systems in Amazon EFS]. +// // - 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. +// +// [Using file systems in Amazon EFS]: https://docs.aws.amazon.com/efs/latest/ug/using-fs.html 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) - // . + // information on the elements that make up a file system policy, see [Amazon EFS Resource-based policies]. + // + // [Amazon EFS 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 @@ -1070,8 +1108,9 @@ type FindingSummaryV2 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) - // action. + // the [CreatePolicy]action. + // + // [CreatePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html // // This member is required. Policy *string @@ -1108,8 +1147,9 @@ 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) - // action. + // the [CreatePolicy]action. + // + // [CreatePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html GeneratedPolicies []GeneratedPolicy noSmithyDocumentSerde @@ -1121,9 +1161,9 @@ type GeneratedPolicyResult struct { // must specify the trust policy. If the configuration is for an existing IAM role // 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) -// . +// empty string. For more information about role trust policy limits, see [IAM and STS quotas]. +// +// [IAM and 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. @@ -1201,9 +1241,9 @@ type JobError struct { noSmithyDocumentSerde } -// A proposed grant configuration for a KMS key. For more information, see -// CreateGrant (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) -// . +// A proposed grant configuration for a KMS key. For more information, see [CreateGrant]. +// +// [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 @@ -1212,7 +1252,7 @@ type KmsGrantConfiguration struct { // This member is required. GranteePrincipal *string - // The Amazon Web Services account under which the grant was issued. The account + // 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. // @@ -1224,38 +1264,43 @@ 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) - // 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) - // . + // Use this structure to propose allowing [cryptographic operations] in the grant only when the operation + // request includes the specified [encryption context]. + // + // [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations + // [encryption 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) - // operation. + // The principal that is given permission to retire the grant by using [RetireGrant] operation. + // + // [RetireGrant]: https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html RetiringPrincipal *string noSmithyDocumentSerde } -// 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) -// . +// Use this structure to propose allowing [cryptographic operations] in the grant only when the operation +// request includes the specified [encryption context]. You can specify only one type of encryption +// context. An empty map is treated as not specified. For more information, see [GrantConstraints]. +// +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [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) + // A list of key-value pairs that must match the encryption context in the [cryptographic operation] // 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. + // + // [cryptographic operation]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations 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) - // request. The grant allows the cryptographic operation only when the encryption - // context in the request includes the key-value pairs specified in this + // the [cryptographic operation]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. + // + // [cryptographic operation]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations EncryptionContextSubset map[string]string noSmithyDocumentSerde @@ -1268,9 +1313,10 @@ 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]. For more information about key policy limits, see [Resource quotas]. +// +// [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default +// [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 @@ -1280,8 +1326,9 @@ type KmsKeyConfiguration struct { 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) - // . + // name of the key policy is default . For more information, see [Default key policy]. + // + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default KeyPolicies map[string]string noSmithyDocumentSerde @@ -1309,13 +1356,14 @@ type Location struct { // 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]. // // The following types satisfy this interface: // // NetworkOriginConfigurationMemberInternetConfiguration // NetworkOriginConfigurationMemberVpcConfiguration +// +// [Creating access points]: https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html type NetworkOriginConfiguration interface { isNetworkOriginConfiguration() } @@ -1332,8 +1380,9 @@ 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]. +// +// [VpcConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html type NetworkOriginConfigurationMemberVpcConfiguration struct { Value VpcConfiguration @@ -1466,12 +1515,15 @@ type RdsDbClusterSnapshotAttributeValue interface { // 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 { @@ -1486,8 +1538,9 @@ func (*RdsDbClusterSnapshotAttributeValueMemberAccountIds) isRdsDbClusterSnapsho // 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]. +// +// [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 @@ -1502,6 +1555,7 @@ type RdsDbClusterSnapshotConfiguration struct { // - 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. @@ -1524,12 +1578,15 @@ type RdsDbSnapshotAttributeValue interface { // 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 . type RdsDbSnapshotAttributeValueMemberAccountIds struct { @@ -1543,8 +1600,9 @@ func (*RdsDbSnapshotAttributeValueMemberAccountIds) isRdsDbSnapshotAttributeValu // 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) -// . +// optional KMS encryption key. For more information, see [ModifyDBSnapshotAttribute]. +// +// [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 @@ -1555,9 +1613,11 @@ type RdsDbSnapshotConfiguration struct { // 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. @@ -1588,10 +1648,11 @@ type ReasonSummary struct { // 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) -// . +// For more information, see [Creating access points]. For more information about access point policy +// limits, see [Access points restrictions and limitations]. +// +// [Access points restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points-restrictions-limitations.html +// [Creating access points]: https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html type S3AccessPointConfiguration struct { // The access point or multi-region access point policy. @@ -1613,8 +1674,9 @@ type S3AccessPointConfiguration struct { } // 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]. +// +// [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. @@ -1640,8 +1702,9 @@ 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]. +// +// [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 @@ -1673,9 +1736,9 @@ type S3BucketConfiguration struct { // new resource and you do not specify the Amazon S3 bucket policy, the access // preview assumes an directory bucket without a policy. To propose deletion of an // existing bucket policy, you can specify an empty string. For more information -// about Amazon S3 directory bucket policies, see Example directory bucket -// policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// . +// about Amazon S3 directory bucket policies, see [Example directory bucket policies for S3 Express One Zone]. +// +// [Example directory bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html type S3ExpressDirectoryBucketConfiguration struct { // The proposed bucket policy for the Amazon S3 directory bucket. @@ -1690,18 +1753,18 @@ type S3ExpressDirectoryBucketConfiguration struct { // 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 // 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]. +// +// [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 + // Specifies whether Amazon S3 should ignore public ACLs for this bucket and // objects in this bucket. // // This member is required. IgnorePublicAcls *bool - // Specifies whether Amazon S3 should restrict public bucket policies for this + // Specifies whether Amazon S3 should restrict public bucket policies for this // bucket. // // This member is required. @@ -1710,10 +1773,10 @@ type S3PublicAccessBlockConfiguration struct { noSmithyDocumentSerde } -// 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 +// The configuration for a Secrets Manager secret. For more information, see [CreateSecret]. +// +// 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 @@ -1723,8 +1786,10 @@ type S3PublicAccessBlockConfiguration struct { // 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.]. +// +// [Quotas for Secrets Manager.]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_limits.html +// [CreateSecret]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html type SecretsManagerSecretConfiguration struct { // The proposed ARN, key ID, or alias of the KMS key. @@ -1744,13 +1809,15 @@ 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]. +// +// [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]in the Amazon SNS Developer Guide. + // + // [Example cases for Amazon SNS access control]: https://docs.aws.amazon.com/sns/latest/dg/sns-access-policy-use-cases.html TopicPolicy *string noSmithyDocumentSerde @@ -1793,12 +1860,12 @@ type Span struct { // access preview is for a new resource and you do not specify the policy, the // 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) -// . +// Amazon SQS policy. For more information about Amazon SQS policy limits, see [Quotas related to policies]. +// +// [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. + // The proposed resource policy for the Amazon SQS queue. QueuePolicy *string noSmithyDocumentSerde @@ -1888,8 +1955,9 @@ type UnusedAccessConfiguration struct { // Contains information about an unused access finding for an action. IAM Access // Analyzer charges for unused access analysis based on the number of IAM roles and -// users analyzed per month. For more details on pricing, see IAM Access Analyzer -// pricing (https://aws.amazon.com/iam/access-analyzer/pricing) . +// users analyzed per month. For more details on pricing, see [IAM Access Analyzer pricing]. +// +// [IAM Access Analyzer pricing]: https://aws.amazon.com/iam/access-analyzer/pricing type UnusedAction struct { // The action for which the unused access finding was generated. @@ -1905,8 +1973,9 @@ type UnusedAction struct { // Contains information about an unused access finding for an IAM role. IAM Access // Analyzer charges for unused access analysis based on the number of IAM roles and -// users analyzed per month. For more details on pricing, see IAM Access Analyzer -// pricing (https://aws.amazon.com/iam/access-analyzer/pricing) . +// users analyzed per month. For more details on pricing, see [IAM Access Analyzer pricing]. +// +// [IAM Access Analyzer pricing]: https://aws.amazon.com/iam/access-analyzer/pricing type UnusedIamRoleDetails struct { // The time at which the role was last accessed. @@ -1917,8 +1986,9 @@ type UnusedIamRoleDetails struct { // Contains information about an unused access finding for an IAM user access key. // IAM Access Analyzer charges for unused access analysis based on the number of -// IAM roles and users analyzed per month. For more details on pricing, see IAM -// Access Analyzer pricing (https://aws.amazon.com/iam/access-analyzer/pricing) . +// IAM roles and users analyzed per month. For more details on pricing, see [IAM Access Analyzer pricing]. +// +// [IAM Access Analyzer pricing]: https://aws.amazon.com/iam/access-analyzer/pricing type UnusedIamUserAccessKeyDetails struct { // The ID of the access key for which the unused access finding was generated. @@ -1934,8 +2004,9 @@ type UnusedIamUserAccessKeyDetails struct { // Contains information about an unused access finding for an IAM user password. // IAM Access Analyzer charges for unused access analysis based on the number of -// IAM roles and users analyzed per month. For more details on pricing, see IAM -// Access Analyzer pricing (https://aws.amazon.com/iam/access-analyzer/pricing) . +// IAM roles and users analyzed per month. For more details on pricing, see [IAM Access Analyzer pricing]. +// +// [IAM Access Analyzer pricing]: https://aws.amazon.com/iam/access-analyzer/pricing type UnusedIamUserPasswordDetails struct { // The time at which the password was last accessed. @@ -1946,8 +2017,9 @@ type UnusedIamUserPasswordDetails struct { // Contains information about an unused access finding for a permission. IAM // Access Analyzer charges for unused access analysis based on the number of IAM -// roles and users analyzed per month. For more details on pricing, see IAM Access -// Analyzer pricing (https://aws.amazon.com/iam/access-analyzer/pricing) . +// roles and users analyzed per month. For more details on pricing, see [IAM Access Analyzer pricing]. +// +// [IAM Access Analyzer pricing]: https://aws.amazon.com/iam/access-analyzer/pricing type UnusedPermissionDetails struct { // The namespace of the Amazon Web Services service that contains the unused @@ -1975,11 +2047,18 @@ type ValidatePolicyFinding struct { // This member is required. FindingDetails *string - // The impact of the finding. Security warnings report when the policy allows - // access that we consider overly permissive. Errors report when a part of the - // policy is not functional. Warnings report non-security issues when a policy does - // not conform to policy writing best practices. Suggestions recommend stylistic - // improvements in the policy that do not impact access. + // The impact of the finding. + // + // Security warnings report when the policy allows access that we consider overly + // permissive. + // + // Errors report when a part of the policy is not functional. + // + // Warnings report non-security issues when a policy does not conform to policy + // writing best practices. + // + // Suggestions recommend stylistic improvements in the policy that do not impact + // access. // // This member is required. FindingType ValidatePolicyFindingType @@ -2021,11 +2100,12 @@ 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]. +// +// [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 + // If this field is specified, this access point will only allow connections from // the specified VPC ID. // // This member is required. diff --git a/service/account/api_op_DeleteAlternateContact.go b/service/account/api_op_DeleteAlternateContact.go index 5337703758c..f751f6617ab 100644 --- a/service/account/api_op_DeleteAlternateContact.go +++ b/service/account/api_op_DeleteAlternateContact.go @@ -12,14 +12,16 @@ import ( ) // 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 +// +// For complete details about how to use the alternate contact operations, see [Access or updating the alternate contacts]. +// +// 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) -// . +// For more information, see [Enabling trusted access for Amazon Web Services Account Management]. +// +// [Access or updating the alternate contacts]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html +// [Enabling trusted access for Amazon Web Services 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,20 +45,28 @@ type DeleteAlternateContactInput struct { 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) - // 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 - // 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 - // identity belonging to the account whose contacts you wish to retrieve or modify. + // 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] 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], and the organization must + // have [trusted access]enabled for the Account Management service, and optionally a [delegated admin] 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 identity + // belonging to the account whose contacts you wish to retrieve or modify. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_DisableRegion.go b/service/account/api_op_DisableRegion.go index 3306e1be8e3..52b42ca601f 100644 --- a/service/account/api_op_DisableRegion.go +++ b/service/account/api_op_DisableRegion.go @@ -42,17 +42,22 @@ type DisableRegionInput struct { // 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) - // 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 - // 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. + // the [organization's management 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], and the + // organization must have [trusted access]enabled for the Account Management service, and + // optionally a [delegated admin]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. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_EnableRegion.go b/service/account/api_op_EnableRegion.go index 45dfd33d71e..0f91581dd8b 100644 --- a/service/account/api_op_EnableRegion.go +++ b/service/account/api_op_EnableRegion.go @@ -42,17 +42,22 @@ type EnableRegionInput struct { // 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) - // 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 - // 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. + // the [organization's management 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], and the + // organization must have [trusted access]enabled for the Account Management service, and + // optionally a [delegated admin]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. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_GetAlternateContact.go b/service/account/api_op_GetAlternateContact.go index b365fdf1ea5..c56649173a1 100644 --- a/service/account/api_op_GetAlternateContact.go +++ b/service/account/api_op_GetAlternateContact.go @@ -12,14 +12,17 @@ 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 +// account. +// +// For complete details about how to use the alternate contact operations, see [Access or updating the alternate contacts]. +// +// 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) -// . +// For more information, see [Enabling trusted access for Amazon Web Services Account Management]. +// +// [Access or updating the alternate contacts]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html +// [Enabling trusted access for Amazon Web Services 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,20 +46,28 @@ type GetAlternateContactInput struct { 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) - // 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 - // 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 - // identity belonging to the account whose contacts you wish to retrieve or modify. + // 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] 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], and the organization must + // have [trusted access]enabled for the Account Management service, and optionally a [delegated admin] 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 identity + // belonging to the account whose contacts you wish to retrieve or modify. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_GetContactInformation.go b/service/account/api_op_GetContactInformation.go index 077e02635da..8736c6954f4 100644 --- a/service/account/api_op_GetContactInformation.go +++ b/service/account/api_op_GetContactInformation.go @@ -12,9 +12,10 @@ import ( ) // 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) -// . +// +// For complete details about how to use the primary contact operations, see [Update the primary and alternate contact information]. +// +// [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{} @@ -36,17 +37,22 @@ type GetContactInformationInput struct { // 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) - // 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 - // 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. + // the [organization's management 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], and the + // organization must have [trusted access]enabled for the Account Management service, and + // optionally a [delegated admin]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. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_GetRegionOptStatus.go b/service/account/api_op_GetRegionOptStatus.go index ad320abc0c9..5c8c1443e2a 100644 --- a/service/account/api_op_GetRegionOptStatus.go +++ b/service/account/api_op_GetRegionOptStatus.go @@ -40,17 +40,22 @@ type GetRegionOptStatusInput struct { // 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) - // 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 - // 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. + // the [organization's management 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], and the + // organization must have [trusted access]enabled for the Account Management service, and + // optionally a [delegated admin]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. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_ListRegions.go b/service/account/api_op_ListRegions.go index 3dbc66971a1..5826238e698 100644 --- a/service/account/api_op_ListRegions.go +++ b/service/account/api_op_ListRegions.go @@ -35,17 +35,22 @@ type ListRegionsInput struct { // 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) - // 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 - // 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. + // the [organization's management 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], and the + // organization must have [trusted access]enabled for the Account Management service, and + // optionally a [delegated admin]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. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string // The total number of items to return in the command’s output. If the total @@ -53,13 +58,17 @@ type ListRegionsInput struct { // 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. + // usage examples, see [Pagination]in the Amazon Web Services Command Line Interface User + // Guide. + // + // [Pagination]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html 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]in the Amazon Web + // Services Command Line Interface User Guide. + // + // [Pagination]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html NextToken *string // A list of Region statuses (Enabling, Enabled, Disabling, Disabled, @@ -178,8 +187,10 @@ type ListRegionsPaginatorOptions struct { // 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. + // usage examples, see [Pagination]in the Amazon Web Services Command Line Interface User + // Guide. + // + // [Pagination]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html 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 186a6ecf726..006e66b7cde 100644 --- a/service/account/api_op_PutAlternateContact.go +++ b/service/account/api_op_PutAlternateContact.go @@ -12,14 +12,17 @@ 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 +// account. +// +// For complete details about how to use the alternate contact operations, see [Access or updating the alternate contacts]. +// +// 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) -// . +// For more information, see [Enabling trusted access for Amazon Web Services Account Management]. +// +// [Access or updating the alternate contacts]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html +// [Enabling trusted access for Amazon Web Services 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,20 +66,28 @@ type PutAlternateContactInput struct { 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) - // 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 - // 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 - // identity belonging to the account whose contacts you wish to retrieve or modify. + // 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] 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], and the organization must + // have [trusted access]enabled for the Account Management service, and optionally a [delegated admin] 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 identity + // belonging to the account whose contacts you wish to retrieve or modify. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/api_op_PutContactInformation.go b/service/account/api_op_PutContactInformation.go index 4aa61321de7..a261fc84503 100644 --- a/service/account/api_op_PutContactInformation.go +++ b/service/account/api_op_PutContactInformation.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -42,17 +43,22 @@ type PutContactInformationInput struct { // 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) - // 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 - // 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. + // the [organization's management 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], and the + // organization must have [trusted access]enabled for the Account Management service, and + // optionally a [delegated admin]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. + // + // [organization's management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account + // [all features enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html + // [delegated admin]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html + // [trusted access]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html AccountId *string noSmithyDocumentSerde diff --git a/service/account/options.go b/service/account/options.go index b346281233b..4d1fe5045dd 100644 --- a/service/account/options.go +++ b/service/account/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/account/types/enums.go b/service/account/types/enums.go index 713d75aa5b0..85c65427fbb 100644 --- a/service/account/types/enums.go +++ b/service/account/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AlternateContactType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlternateContactType) Values() []AlternateContactType { return []AlternateContactType{ "BILLING", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for RegionOptStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegionOptStatus) Values() []RegionOptStatus { return []RegionOptStatus{ "ENABLED", @@ -56,6 +58,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/acm/api_op_AddTagsToCertificate.go b/service/acm/api_op_AddTagsToCertificate.go index 8a0eb54cace..f0277609f31 100644 --- a/service/acm/api_op_AddTagsToCertificate.go +++ b/service/acm/api_op_AddTagsToCertificate.go @@ -14,18 +14,21 @@ import ( // 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 +// 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]. +// +// 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 ListTagsForCertificateaction. +// +// [Tagging ACM certificates]: https://docs.aws.amazon.com/acm/latest/userguide/tags.html func (c *Client) AddTagsToCertificate(ctx context.Context, params *AddTagsToCertificateInput, optFns ...func(*Options)) (*AddTagsToCertificateOutput, error) { if params == nil { params = &AddTagsToCertificateInput{} @@ -45,9 +48,12 @@ 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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 1a0e91237e6..f086ecf8c92 100644 --- a/service/acm/api_op_DeleteCertificate.go +++ b/service/acm/api_op_DeleteCertificate.go @@ -12,11 +12,12 @@ import ( // Deletes a certificate and its associated private key. If this action succeeds, // the certificate no longer appears in the list that can be displayed by calling -// the ListCertificates action or be retrieved by calling the GetCertificate -// action. The certificate will not be available for use by Amazon Web Services -// services integrated with ACM. You cannot delete an ACM certificate that is being -// used by another Amazon Web Services service. To delete a certificate that is in -// use, the certificate association must first be removed. +// the ListCertificatesaction or be retrieved by calling the GetCertificate action. The certificate will not be +// available for use by Amazon Web Services services integrated with ACM. +// +// You cannot delete an ACM certificate that is being used by another Amazon Web +// Services service. To delete a certificate that is in use, the certificate +// association must first be removed. func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error) { if params == nil { params = &DeleteCertificateInput{} @@ -36,9 +37,12 @@ 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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 aad61466d08..a6d814badb9 100644 --- a/service/acm/api_op_DescribeCertificate.go +++ b/service/acm/api_op_DescribeCertificate.go @@ -16,9 +16,11 @@ import ( "time" ) -// Returns detailed metadata about the specified ACM certificate. If you have just -// created a certificate using the RequestCertificate action, there is a delay of -// several seconds before you can retrieve information about it. +// Returns detailed metadata about the specified ACM certificate. +// +// If you have just created a certificate using the RequestCertificate action, +// there is a delay of several seconds before you can retrieve information about +// it. func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error) { if params == nil { params = &DescribeCertificateInput{} @@ -38,9 +40,12 @@ 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. CertificateArn *string @@ -180,12 +185,13 @@ type CertificateValidatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCertificateInput, *DescribeCertificateOutput, error) (bool, error) } diff --git a/service/acm/api_op_ExportCertificate.go b/service/acm/api_op_ExportCertificate.go index 1f780430f34..960cba1d8ff 100644 --- a/service/acm/api_op_ExportCertificate.go +++ b/service/acm/api_op_ExportCertificate.go @@ -14,10 +14,12 @@ import ( // 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) -// . +// 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]. +// +// [Export a Private 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{} @@ -37,17 +39,22 @@ type ExportCertificateInput struct { // An Amazon Resource Name (ARN) of the issued certificate. This must be of the // form: - // arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 + // + // arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 // // This member is required. CertificateArn *string - // Passphrase to associate with the encrypted exported private key. When creating - // your passphrase, you can use any ASCII character except #, $, or %. If you want - // to later decrypt the private key, you must have the passphrase. You can use the - // following OpenSSL command to decrypt a private key. After entering the command, - // you are prompted for the passphrase. openssl rsa -in encrypted_key.pem -out - // decrypted_key.pem + // Passphrase to associate with the encrypted exported private key. + // + // When creating your passphrase, you can use any ASCII character except #, $, or + // %. + // + // If you want to later decrypt the private key, you must have the passphrase. You + // can use the following OpenSSL command to decrypt a private key. After entering + // the command, you are prompted for the passphrase. + // + // openssl rsa -in encrypted_key.pem -out decrypted_key.pem // // This member is required. Passphrase []byte diff --git a/service/acm/api_op_GetCertificate.go b/service/acm/api_op_GetCertificate.go index 6535411b88d..d445fecbced 100644 --- a/service/acm/api_op_GetCertificate.go +++ b/service/acm/api_op_GetCertificate.go @@ -13,8 +13,9 @@ import ( // Retrieves an Amazon-issued certificate and its certificate chain. The chain // consists of the certificate of the issuing CA and the intermediate certificates // of any other subordinate CAs. All of the certificates are base64 encoded. You -// can use OpenSSL (https://wiki.openssl.org/index.php/Command_Line_Utilities) to -// decode the certificates and inspect individual fields. +// can use [OpenSSL]to decode the certificates and inspect individual fields. +// +// [OpenSSL]: https://wiki.openssl.org/index.php/Command_Line_Utilities func (c *Client) GetCertificate(ctx context.Context, params *GetCertificateInput, optFns ...func(*Options)) (*GetCertificateOutput, error) { if params == nil { params = &GetCertificateInput{} @@ -33,9 +34,12 @@ func (c *Client) GetCertificate(ctx context.Context, params *GetCertificateInput 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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 e18457ce724..363b733a790 100644 --- a/service/acm/api_op_ImportCertificate.go +++ b/service/acm/api_op_ImportCertificate.go @@ -12,45 +12,62 @@ 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]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]in the Certificate Manager User Guide. +// +// ACM does not provide [managed renewal] 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. // -// 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)] of the imported certificate. +// +// [Importing Certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html +// [integrated services]: https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html +// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html func (c *Client) ImportCertificate(ctx context.Context, params *ImportCertificateInput, optFns ...func(*Options)) (*ImportCertificateOutput, error) { if params == nil { params = &ImportCertificateInput{} @@ -78,16 +95,18 @@ 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 - // field. + // The [Amazon Resource Name (ARN)] of an imported certificate to replace. To import a new certificate, omit + // this field. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html CertificateArn *string // The PEM encoded certificate chain. CertificateChain []byte - // One or more resource tags to associate with the imported certificate. Note: You - // cannot apply tags when reimporting a certificate. + // One or more resource tags to associate with the imported certificate. + // + // Note: You cannot apply tags when reimporting a certificate. Tags []types.Tag noSmithyDocumentSerde @@ -95,8 +114,9 @@ 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)] of the imported certificate. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 14b589463f3..115478c2d14 100644 --- a/service/acm/api_op_ListCertificates.go +++ b/service/acm/api_op_ListCertificates.go @@ -14,7 +14,7 @@ import ( // 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{} diff --git a/service/acm/api_op_ListTagsForCertificate.go b/service/acm/api_op_ListTagsForCertificate.go index cba623c4ead..b4d67a90ac1 100644 --- a/service/acm/api_op_ListTagsForCertificate.go +++ b/service/acm/api_op_ListTagsForCertificate.go @@ -13,8 +13,7 @@ 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 AddTagsToCertificateaction. 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{} @@ -34,9 +33,12 @@ 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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 18cee0e823d..da0c1a6c3f0 100644 --- a/service/acm/api_op_PutAccountConfiguration.go +++ b/service/acm/api_op_PutAccountConfiguration.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or modifies account-level configurations in ACM. The supported -// 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 -// expiration. +// Adds or modifies account-level configurations in ACM. +// +// The supported 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 expiration. func (c *Client) PutAccountConfiguration(ctx context.Context, params *PutAccountConfigurationInput, optFns ...func(*Options)) (*PutAccountConfigurationOutput, error) { if params == nil { params = &PutAccountConfigurationInput{} diff --git a/service/acm/api_op_RemoveTagsFromCertificate.go b/service/acm/api_op_RemoveTagsFromCertificate.go index d4b96a8da87..f17ec7c92f6 100644 --- a/service/acm/api_op_RemoveTagsFromCertificate.go +++ b/service/acm/api_op_RemoveTagsFromCertificate.go @@ -14,10 +14,10 @@ import ( // Remove one or more tags from an ACM certificate. A tag consists of a key-value // pair. If you do not specify the value portion of the tag when calling this // function, 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 certificate, use the AddTagsToCertificate action. To view all of the -// tags that have been applied to a specific ACM certificate, use the -// ListTagsForCertificate action. +// the tag is removed only if it is associated with the specified value. +// +// To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that +// have been applied to a specific ACM certificate, use the ListTagsForCertificateaction. func (c *Client) RemoveTagsFromCertificate(ctx context.Context, params *RemoveTagsFromCertificateInput, optFns ...func(*Options)) (*RemoveTagsFromCertificateOutput, error) { if params == nil { params = &RemoveTagsFromCertificateInput{} @@ -37,9 +37,12 @@ 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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 849fe12d1db..6fc070eab32 100644 --- a/service/acm/api_op_RenewCertificate.go +++ b/service/acm/api_op_RenewCertificate.go @@ -12,10 +12,11 @@ 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. +// Web Services Private CA certificates with ACM, you must first [grant the ACM service principal permission to do so]. For more +// information, see [Testing Managed Renewal]in the ACM User Guide. +// +// [Testing Managed Renewal]: https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html +// [grant the ACM service principal permission to do so]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaPermissions.html func (c *Client) RenewCertificate(ctx context.Context, params *RenewCertificateInput, optFns ...func(*Options)) (*RenewCertificateOutput, error) { if params == nil { params = &RenewCertificateInput{} @@ -35,9 +36,12 @@ 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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 6af85f861d6..67698f6bf39 100644 --- a/service/acm/api_op_RequestCertificate.go +++ b/service/acm/api_op_RequestCertificate.go @@ -14,18 +14,25 @@ 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) +// 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]or [email validation] // . 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). +// receiving approval from the domain owner. +// +// ACM behavior differs from the [RFC 6125] 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. +// +// [email validation]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html +// [RFC 6125]: https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2 +// [DNS validation]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html func (c *Client) RequestCertificate(ctx context.Context, params *RequestCertificateInput, optFns ...func(*Options)) (*RequestCertificateOutput, error) { if params == nil { params = &RequestCertificateInput{} @@ -47,11 +54,14 @@ 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], 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. + // + // [RFC 5280]: https://datatracker.ietf.org/doc/html/rfc5280 // // This member is required. DomainName *string @@ -59,10 +69,12 @@ 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: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // certificate. For more information about private CAs, see the [Amazon Web Services Private Certificate Authority]user guide. The + // ARN must have the following form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [Amazon Web Services Private Certificate Authority]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html CertificateAuthorityArn *string // The domain name that you want ACM to use to send you emails so that you can @@ -85,16 +97,18 @@ type RequestCertificateInput struct { // 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 + // 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 // to a certificate transparency log. Certificate transparency makes it possible to // 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) - // . + // browser. For more information, see [Opting Out of Certificate Transparency Logging]. + // + // [Opting Out of Certificate 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 @@ -103,26 +117,34 @@ type RequestCertificateInput struct { // 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 + // information, see [Quotas]. + // + // 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. + // + // [Quotas]: https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html 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]or [validate with email]. We recommend that you use + // DNS validation. + // + // [validate with email]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html + // [validate with DNS]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html ValidationMethod types.ValidationMethod noSmithyDocumentSerde @@ -132,7 +154,8 @@ type RequestCertificateOutput struct { // String that contains the ARN of the issued certificate. This must be of the // form: - // arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 CertificateArn *string // Metadata pertaining to the operation's result. diff --git a/service/acm/api_op_ResendValidationEmail.go b/service/acm/api_op_ResendValidationEmail.go index 85865eae9f8..73e6d35367f 100644 --- a/service/acm/api_op_ResendValidationEmail.go +++ b/service/acm/api_op_ResendValidationEmail.go @@ -19,8 +19,9 @@ import ( // 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]. +// +// [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{} @@ -39,11 +40,11 @@ func (c *Client) ResendValidationEmail(ctx context.Context, params *ResendValida type ResendValidationEmailInput struct { // String that contains the ARN of the requested certificate. The certificate ARN - // is generated and returned by the RequestCertificate action as soon as the - // request is made. By default, using this parameter causes email to be sent to all - // top-level domains you specified in the certificate request. The ARN must be of - // the form: - // arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // is generated and returned by the RequestCertificateaction as soon as the request is made. By + // default, using this parameter causes email to be sent to all top-level domains + // you specified in the certificate request. The ARN must be of the form: + // + // arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 // // This member is required. CertificateArn *string @@ -60,10 +61,15 @@ type ResendValidationEmailInput struct { // 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. diff --git a/service/acm/api_op_UpdateCertificateOptions.go b/service/acm/api_op_UpdateCertificateOptions.go index 432365662cd..3c6ce9220e5 100644 --- a/service/acm/api_op_UpdateCertificateOptions.go +++ b/service/acm/api_op_UpdateCertificateOptions.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} @@ -33,7 +34,8 @@ func (c *Client) UpdateCertificateOptions(ctx context.Context, params *UpdateCer type UpdateCertificateOptionsInput struct { // ARN of the requested certificate to update. This must be of the form: - // arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 + // + // arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 // // This member is required. CertificateArn *string diff --git a/service/acm/doc.go b/service/acm/doc.go index 9574960e2f9..01d356f93eb 100644 --- a/service/acm/doc.go +++ b/service/acm/doc.go @@ -3,8 +3,11 @@ // Package acm provides the API client, operations, and parameter types for AWS // Certificate Manager. // -// 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/) -// . +// # 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]. +// +// [Certificate Manager User Guide]: https://docs.aws.amazon.com/acm/latest/userguide/ package acm diff --git a/service/acm/options.go b/service/acm/options.go index 77edd733ce1..87a05eee1b3 100644 --- a/service/acm/options.go +++ b/service/acm/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/acm/types/enums.go b/service/acm/types/enums.go index 40a2198d6ec..0c8c7f53cd3 100644 --- a/service/acm/types/enums.go +++ b/service/acm/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for CertificateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateStatus) Values() []CertificateStatus { return []CertificateStatus{ "PENDING_VALIDATION", @@ -40,8 +41,9 @@ const ( // Values returns all known values for CertificateTransparencyLoggingPreference. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateTransparencyLoggingPreference) Values() []CertificateTransparencyLoggingPreference { return []CertificateTransparencyLoggingPreference{ "ENABLED", @@ -59,8 +61,9 @@ const ( ) // Values returns all known values for CertificateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateType) Values() []CertificateType { return []CertificateType{ "IMPORTED", @@ -79,8 +82,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -108,8 +112,9 @@ const ( ) // Values returns all known values for ExtendedKeyUsageName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExtendedKeyUsageName) Values() []ExtendedKeyUsageName { return []ExtendedKeyUsageName{ "TLS_WEB_SERVER_AUTHENTICATION", @@ -151,8 +156,9 @@ const ( ) // Values returns all known values for FailureReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureReason) Values() []FailureReason { return []FailureReason{ "NO_AVAILABLE_CONTACTS", @@ -189,8 +195,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -221,8 +228,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -247,8 +255,9 @@ const ( ) // Values returns all known values for RecordType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordType) Values() []RecordType { return []RecordType{ "CNAME", @@ -264,8 +273,9 @@ const ( ) // Values returns all known values for RenewalEligibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenewalEligibility) Values() []RenewalEligibility { return []RenewalEligibility{ "ELIGIBLE", @@ -284,8 +294,9 @@ const ( ) // Values returns all known values for RenewalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenewalStatus) Values() []RenewalStatus { return []RenewalStatus{ "PENDING_AUTO_RENEWAL", @@ -312,8 +323,9 @@ const ( ) // Values returns all known values for RevocationReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RevocationReason) Values() []RevocationReason { return []RevocationReason{ "UNSPECIFIED", @@ -337,8 +349,9 @@ const ( ) // Values returns all known values for SortBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortBy) Values() []SortBy { return []SortBy{ "CREATED_AT", @@ -354,8 +367,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -372,8 +386,9 @@ const ( ) // Values returns all known values for ValidationMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationMethod) Values() []ValidationMethod { return []ValidationMethod{ "EMAIL", diff --git a/service/acm/types/types.go b/service/acm/types/types.go index 254a816bb9d..042f535e512 100644 --- a/service/acm/types/types.go +++ b/service/acm/types/types.go @@ -8,17 +8,19 @@ import ( ) // Contains metadata about an ACM certificate. This structure is returned in the -// response to a DescribeCertificate request. +// response to a DescribeCertificaterequest. 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html CertificateArn *string // The Amazon Resource Name (ARN) of the private certificate authority (CA) that // issued the certificate. This has the following format: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 CertificateAuthorityArn *string // The time at which the certificate was requested. @@ -29,8 +31,8 @@ type CertificateDetail struct { DomainName *string // 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 . + // occurs as a result of the RequestCertificaterequest. This field exists only when the certificate + // type is AMAZON_ISSUED . DomainValidationOptions []DomainValidation // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object @@ -39,9 +41,10 @@ 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) - // in the Certificate Manager User Guide. + // certificate status is FAILED . For more information, see [Certificate Request Failed] in the Certificate + // Manager User Guide. + // + // [Certificate Request Failed]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed FailureReason FailureReason // The date and time when the certificate was imported. This value exists only @@ -83,12 +86,13 @@ type CertificateDetail struct { Options *CertificateOptions // Specifies whether the certificate is eligible for renewal. At this time, only - // exported private certificates can be renewed with the RenewCertificate command. + // exported private certificates can be renewed with the RenewCertificatecommand. 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] for the certificate. This field + // exists only when the certificate type is AMAZON_ISSUED . + // + // [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html RenewalSummary *RenewalSummary // The reason the certificate was revoked. This value exists only when the @@ -105,14 +109,18 @@ type CertificateDetail struct { // The algorithm that was used to sign the certificate. SignatureAlgorithm *string - // 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 - // 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 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]. 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]or [Email validation], and try again. If validation succeeds, the + // certificate enters status ISSUED. + // + // [DNS validation]: https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html + // [Certificate request fails]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html + // [Email validation]: https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html Status CertificateStatus // The name of the entity that is associated with the public key contained in the @@ -127,12 +135,13 @@ 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]for imported certificates. For more information about + // the differences between certificates that you import and those that ACM + // provides, see [Importing Certificates]in the Certificate Manager User Guide. + // + // [Importing Certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html + // [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html Type CertificateType noSmithyDocumentSerde @@ -144,8 +153,9 @@ 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]. +// +// [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 @@ -159,9 +169,12 @@ type CertificateOptions struct { 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) - // . + // + // arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)]. + // + // [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. @@ -180,13 +193,14 @@ 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 - // 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) - // . + // When called by [ListCertificates], 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]. + // + // [DescribeCertificate]: https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html + // [ListCertificates]: https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html HasAdditionalSubjectAlternativeNames *bool // The date and time when the certificate was imported. This value exists only @@ -217,41 +231,49 @@ type CertificateSummary struct { NotBefore *time.Time // Specifies whether the certificate is eligible for renewal. At this time, only - // exported private certificates can be renewed with the RenewCertificate command. + // exported private certificates can be renewed with the RenewCertificatecommand. RenewalEligibility RenewalEligibility // The time at which the certificate was revoked. This value exists only when the // 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 - // 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 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]. 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]or [Email validation], and try again. If validation succeeds, the + // certificate enters status ISSUED. + // + // [DNS validation]: https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html + // [Certificate request fails]: https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html + // [Email validation]: https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html 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], 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]. + // + // [DescribeCertificate]: https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html + // [ListCertificates]: https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.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]for imported certificates. For more information about + // the differences between certificates that you import and those that ACM + // provides, see [Importing Certificates]in the Certificate Manager User Guide. + // + // [Importing Certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html + // [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html Type CertificateType noSmithyDocumentSerde @@ -268,12 +290,15 @@ type DomainValidation struct { 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]. + // + // 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 // "_a79865eb4cd1a6ab990a45779b4e0b96" must be used. + // + // [Use DNS to Validate Domain Ownership]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html ResourceRecord *ResourceRecord // The domain name that ACM used to send domain validation emails. @@ -287,8 +312,11 @@ type DomainValidation struct { // The validation status of the domain name. This can be one of the following // values: + // // - PENDING_VALIDATION + // // - SUCCESS + // // - FAILED ValidationStatus DomainStatus @@ -310,10 +338,15 @@ type DomainValidationOption struct { // 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 // // This member is required. @@ -345,30 +378,40 @@ type ExtendedKeyUsage struct { // 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) OID *string noSmithyDocumentSerde } -// This structure can be used in the ListCertificates action to filter the output -// of the certificate list. +// This structure can be used in the ListCertificates action to filter the output of the +// certificate list. type Filters struct { // Specify one or more ExtendedKeyUsage extension values. 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 + // 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. KeyTypes []KeyAlgorithm @@ -389,22 +432,25 @@ 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] for the certificate. This +// structure exists only when the certificate type is AMAZON_ISSUED . +// +// [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html 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 - // RequestCertificate request. This field exists only when the certificate type is - // AMAZON_ISSUED . + // certificate, as it pertains to ACM's [managed renewal]. This is different from the initial + // validation that occurs as a result of the RequestCertificaterequest. This field exists only when + // the certificate type is AMAZON_ISSUED . + // + // [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html // // 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] of the certificate. + // + // [managed renewal]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html // // This member is required. RenewalStatus RenewalStatus @@ -421,7 +467,7 @@ type RenewalSummary struct { } // Contains a DNS record value that you can use to validate ownership or control -// of a domain. This is used by the DescribeCertificate action. +// of a domain. This is used by the DescribeCertificateaction. type ResourceRecord struct { // The name of the DNS record to create in your domain. This is supplied by ACM. diff --git a/service/acmpca/api_op_CreateCertificateAuthority.go b/service/acmpca/api_op_CreateCertificateAuthority.go index fcdaa12e4f2..44f7e03e917 100644 --- a/service/acmpca/api_op_CreateCertificateAuthority.go +++ b/service/acmpca/api_op_CreateCertificateAuthority.go @@ -22,14 +22,18 @@ import ( // expiration period in days (the validity period of the CRL), the Amazon S3 bucket // that will contain the CRL, and a CNAME alias for the S3 bucket that is included // in certificates issued by the CA. If successful, this action returns the Amazon -// Resource Name (ARN) of the CA. 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 -// protected with encryption. For more information, see Encrypting Your CRLs (https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption) -// . +// Resource Name (ARN) of the CA. +// +// 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]. +// +// Amazon Web Services Private CA assets that are stored in Amazon S3 can be +// protected with encryption. For more information, see [Encrypting Your CRLs]. +// +// [Access policies for CRLs in Amazon S3]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies +// [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{} @@ -69,47 +73,62 @@ type CreateCertificateAuthorityInput struct { IdempotencyToken *string // Specifies a cryptographic key management compliance standard used for handling - // CA keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Some Amazon Web Services Regions - // do not support the default. 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 + // CA keys. + // + // Default: FIPS_140_2_LEVEL_3_OR_HIGHER + // + // Some Amazon Web Services Regions do not support the default. 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." For information - // about security standard support in various Regions, see Storage and security - // compliance of Amazon Web Services Private CA private keys (https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys) - // . + // created in this region with the specified security standard." + // + // For information about security standard support in various Regions, see [Storage and security compliance of Amazon Web Services Private CA private keys]. + // + // [Storage and security compliance of Amazon Web Services Private CA private keys]: https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys 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. + // 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) - // . + // + // - In a CRL configuration, the S3BucketName parameter must conform to [Amazon S3 bucket naming rules]. + // // - 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. + // CRLs or OCSP must conform to [RFC2396]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. + // + // For more information, see the [OcspConfiguration] and [CrlConfiguration] types. + // + // [RFC2396]: https://www.ietf.org/rfc/rfc2396.txt + // [OcspConfiguration]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html + // [Amazon S3 bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html + // [CrlConfiguration]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html 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]. + // + // [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 // require a revocation mechanism, or short-lived certificates that may optionally // omit revocation because they expire quickly. Short-lived certificate validity is - // limited to seven days. The default value is GENERAL_PURPOSE. + // limited to seven days. + // + // The default value is GENERAL_PURPOSE. UsageMode types.CertificateAuthorityUsageMode noSmithyDocumentSerde @@ -119,6 +138,7 @@ type CreateCertificateAuthorityOutput struct { // 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 739c902fb06..be2729511be 100644 --- a/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go +++ b/service/acmpca/api_op_CreateCertificateAuthorityAuditReport.go @@ -12,18 +12,23 @@ 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) -// 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 -// 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. +// The report is saved in the Amazon S3 bucket that you specify on input. The [IssueCertificate]and [RevokeCertificate] +// 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]. +// +// 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]. +// +// You can generate a maximum of one report every 30 minutes. +// +// [RevokeCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html +// [Encrypting Your Audit Reports]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption +// [IssueCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html +// [Access policies for CRLs in Amazon S3]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies func (c *Client) CreateCertificateAuthorityAuditReport(ctx context.Context, params *CreateCertificateAuthorityAuditReportInput, optFns ...func(*Options)) (*CreateCertificateAuthorityAuditReportOutput, error) { if params == nil { params = &CreateCertificateAuthorityAuditReportInput{} @@ -47,6 +52,7 @@ type CreateCertificateAuthorityAuditReportInput struct { AuditReportResponseFormat types.AuditReportResponseFormat // The Amazon Resource Name (ARN) of the CA to be audited. This is of the form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // diff --git a/service/acmpca/api_op_CreatePermission.go b/service/acmpca/api_op_CreatePermission.go index 668cbbe7133..938227eac67 100644 --- a/service/acmpca/api_op_CreatePermission.go +++ b/service/acmpca/api_op_CreatePermission.go @@ -14,20 +14,28 @@ 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) -// action. About Permissions +// as the CA. +// +// You can list current permissions with the [ListPermissions] action and revoke them with the [DeletePermission] +// 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) -// . +// issuance and renewals. For more information, see [Using a Resource Based Policy with Amazon Web Services Private CA]. +// +// [Using a Resource Based Policy with Amazon Web Services Private CA]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html +// [ListPermissions]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html +// [DeletePermission]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html func (c *Client) CreatePermission(ctx context.Context, params *CreatePermissionInput, optFns ...func(*Options)) (*CreatePermissionOutput, error) { if params == nil { params = &CreatePermissionInput{} @@ -52,11 +60,13 @@ type CreatePermissionInput struct { 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) - // action. This must have the following form: + // find the ARN by calling the [ListCertificateAuthorities]action. This must have the following form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // + // [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html + // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_DeleteCertificateAuthority.go b/service/acmpca/api_op_DeleteCertificateAuthority.go index c23244d16b7..3ec055be064 100644 --- a/service/acmpca/api_op_DeleteCertificateAuthority.go +++ b/service/acmpca/api_op_DeleteCertificateAuthority.go @@ -12,25 +12,32 @@ 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) -// 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 . +// ARN by calling the [ListCertificateAuthorities]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]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) -// 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) -// action. +// +// When you successfully call [DeleteCertificateAuthority], 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]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] action. +// +// [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html +// [RestoreCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html +// [UpdateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html +// [DeleteCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html +// [DescribeCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html func (c *Client) DeleteCertificateAuthority(ctx context.Context, params *DeleteCertificateAuthorityInput, optFns ...func(*Options)) (*DeleteCertificateAuthorityOutput, error) { if params == nil { params = &DeleteCertificateAuthorityInput{} @@ -48,12 +55,14 @@ 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: + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must + // have the following form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html + // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_DeletePermission.go b/service/acmpca/api_op_DeletePermission.go index 00aacb88c8c..a9ff62f92cb 100644 --- a/service/acmpca/api_op_DeletePermission.go +++ b/service/acmpca/api_op_DeletePermission.go @@ -11,23 +11,31 @@ import ( ) // Revokes permissions on a private CA 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. 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) -// action. About Permissions +// 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] action and listed with the [ListPermissions] 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) -// . +// issuance and renewals. For more information, see [Using a Resource Based Policy with Amazon Web Services Private CA]. +// +// [Using a Resource Based Policy with Amazon Web Services Private CA]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html +// [CreatePermission]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html +// [ListPermissions]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionInput, optFns ...func(*Options)) (*DeletePermissionOutput, error) { if params == nil { params = &DeletePermissionInput{} @@ -46,11 +54,14 @@ 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) - // action. This must have the following form: + // You can find the CA's ARN by calling the [ListCertificateAuthorities]action. This must have the following + // form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // + // [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html + // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_DeletePolicy.go b/service/acmpca/api_op_DeletePolicy.go index 1fb5bda8232..45986a18de2 100644 --- a/service/acmpca/api_op_DeletePolicy.go +++ b/service/acmpca/api_op_DeletePolicy.go @@ -12,30 +12,40 @@ import ( // 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 +// 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] and updated with [PutPolicy]. +// +// 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) -// . +// more information, see [Using a Resource Based Policy with Amazon Web Services Private CA]. +// // - 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) -// . +// Services Private CA policy. For more information, see [Using a Service Linked Role with ACM]. +// // - 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) -// . +// policies. For more information, see [Attach a Policy for Cross-Account Access]. +// +// [PutPolicy]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html +// [Using a Resource Based Policy with Amazon Web Services Private CA]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html +// [Using a Service Linked Role with ACM]: https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html +// [Attach a Policy for Cross-Account Access]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html +// [GetPolicy]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} @@ -54,11 +64,13 @@ 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) - // action. The ARN value must have the form + // deleted. You can find the CA's ARN by calling the [ListCertificateAuthorities]action. The ARN value must + // have the form // arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab // . // + // [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html + // // This member is required. ResourceArn *string diff --git a/service/acmpca/api_op_DescribeCertificateAuthority.go b/service/acmpca/api_op_DescribeCertificateAuthority.go index 5d71f467372..f126d04b7c1 100644 --- a/service/acmpca/api_op_DescribeCertificateAuthority.go +++ b/service/acmpca/api_op_DescribeCertificateAuthority.go @@ -15,17 +15,24 @@ 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. @@ -46,12 +53,14 @@ 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: + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must be + // of the form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html + // // This member is required. CertificateAuthorityArn *string @@ -60,8 +69,9 @@ type DescribeCertificateAuthorityInput struct { type DescribeCertificateAuthorityOutput struct { - // A CertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html) - // structure that contains information about your private CA. + // A [CertificateAuthority] structure that contains information about your private CA. + // + // [CertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CertificateAuthority.html CertificateAuthority *types.CertificateAuthority // Metadata pertaining to the operation's result. diff --git a/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go b/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go index 95125d5e61a..e86472f9608 100644 --- a/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go +++ b/service/acmpca/api_op_DescribeCertificateAuthorityAuditReport.go @@ -15,12 +15,13 @@ import ( "time" ) -// Lists information about a specific audit report created by calling the -// 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) -// action. +// Lists information about a specific audit report created by calling the [CreateCertificateAuthorityAuditReport] 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]action or the [RevokeCertificate] action. +// +// [RevokeCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html +// [IssueCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html +// [CreateCertificateAuthorityAuditReport]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html func (c *Client) DescribeCertificateAuthorityAuditReport(ctx context.Context, params *DescribeCertificateAuthorityAuditReportInput, optFns ...func(*Options)) (*DescribeCertificateAuthorityAuditReportOutput, error) { if params == nil { params = &DescribeCertificateAuthorityAuditReportInput{} @@ -38,13 +39,15 @@ 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) - // action. + // The report ID returned by calling the [CreateCertificateAuthorityAuditReport] action. + // + // [CreateCertificateAuthorityAuditReport]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html // // This member is required. AuditReportId *string // The Amazon Resource Name (ARN) of the private CA. This must be of the form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // @@ -193,12 +196,13 @@ type AuditReportCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCertificateAuthorityAuditReportInput, *DescribeCertificateAuthorityAuditReportOutput, error) (bool, error) } diff --git a/service/acmpca/api_op_GetCertificate.go b/service/acmpca/api_op_GetCertificate.go index 59714b2d12a..99cd87cadfe 100644 --- a/service/acmpca/api_op_GetCertificate.go +++ b/service/acmpca/api_op_GetCertificate.go @@ -16,13 +16,15 @@ 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) -// 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) -// action to create a report that contains information about all of the -// certificates issued and revoked by your private CA. +// you. The ARN of the certificate is returned when you call the [IssueCertificate]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]action to create a report that +// contains information about all of the certificates issued and revoked by your +// private CA. +// +// [IssueCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html +// [CreateCertificateAuthorityAuditReport]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html func (c *Client) GetCertificate(ctx context.Context, params *GetCertificateInput, optFns ...func(*Options)) (*GetCertificateOutput, error) { if params == nil { params = &GetCertificateInput{} @@ -42,17 +44,20 @@ type GetCertificateInput struct { // The ARN of the issued certificate. The ARN contains the certificate serial // number and must be in the following form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245 + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245 // // This member is required. 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: + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must be + // of the form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html + // // This member is required. CertificateAuthorityArn *string @@ -193,12 +198,13 @@ type CertificateIssuedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetCertificateInput, *GetCertificateOutput, error) (bool, error) } diff --git a/service/acmpca/api_op_GetCertificateAuthorityCertificate.go b/service/acmpca/api_op_GetCertificateAuthorityCertificate.go index 984e7b884f2..e01b68e4b2d 100644 --- a/service/acmpca/api_op_GetCertificateAuthorityCertificate.go +++ b/service/acmpca/api_op_GetCertificateAuthorityCertificate.go @@ -32,6 +32,7 @@ func (c *Client) GetCertificateAuthorityCertificate(ctx context.Context, params type GetCertificateAuthorityCertificateInput struct { // The Amazon Resource Name (ARN) of your private CA. This is of the form: + // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // . // diff --git a/service/acmpca/api_op_GetCertificateAuthorityCsr.go b/service/acmpca/api_op_GetCertificateAuthorityCsr.go index a1e4a217d2c..b2b2a6bed8f 100644 --- a/service/acmpca/api_op_GetCertificateAuthorityCsr.go +++ b/service/acmpca/api_op_GetCertificateAuthorityCsr.go @@ -16,12 +16,13 @@ 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) -// 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) -// action. The CSR is returned as a base64 PEM-encoded string. +// authority (CA). The CSR is created when you call the [CreateCertificateAuthority]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]action. The CSR is returned as a base64 PEM-encoded string. +// +// [ImportCertificateAuthorityCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html +// [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html func (c *Client) GetCertificateAuthorityCsr(ctx context.Context, params *GetCertificateAuthorityCsrInput, optFns ...func(*Options)) (*GetCertificateAuthorityCsrOutput, error) { if params == nil { params = &GetCertificateAuthorityCsrInput{} @@ -39,10 +40,12 @@ 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) - // action. This must be of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called the [CreateCertificateAuthority] action. + // This must be of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string @@ -184,12 +187,13 @@ type CertificateAuthorityCSRCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetCertificateAuthorityCsrInput, *GetCertificateAuthorityCsrOutput, error) (bool, error) } diff --git a/service/acmpca/api_op_GetPolicy.go b/service/acmpca/api_op_GetPolicy.go index 577ee20815b..72ea00cc7bb 100644 --- a/service/acmpca/api_op_GetPolicy.go +++ b/service/acmpca/api_op_GetPolicy.go @@ -12,26 +12,33 @@ 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 +// ResourceNotFoundException . +// +// The policy can be attached or updated with [PutPolicy] and removed with [DeletePolicy]. +// +// 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) -// . +// more information, see [Using a Resource Based Policy with Amazon Web Services Private CA]. +// // - 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) -// . +// Services Private CA policy. For more information, see [Using a Service Linked Role with ACM]. +// // - 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) -// . +// policies. For more information, see [Attach a Policy for Cross-Account Access]. +// +// [PutPolicy]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html +// [Using a Resource Based Policy with Amazon Web Services Private CA]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html +// [Using a Service Linked Role with ACM]: https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html +// [DeletePolicy]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html +// [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 1fc3bc11ce9..a46e5e2ae5b 100644 --- a/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go +++ b/service/acmpca/api_op_ImportCertificateAuthorityCertificate.go @@ -14,62 +14,96 @@ 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). +// +// - In Amazon Web Services Private CA, call the [CreateCertificateAuthority]action to create the private CA +// that you plan to back with the imported certificate. +// +// - Call the [GetCertificateAuthorityCsr]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. +// # 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 +// +// [GetCertificateAuthorityCsr]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html +// [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html func (c *Client) ImportCertificateAuthorityCertificate(ctx context.Context, params *ImportCertificateAuthorityCertificateInput, optFns ...func(*Options)) (*ImportCertificateAuthorityCertificateOutput, error) { if params == nil { params = &ImportCertificateAuthorityCertificateInput{} @@ -94,10 +128,12 @@ type ImportCertificateAuthorityCertificateInput struct { // This member is required. 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: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must be + // of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string @@ -105,9 +141,10 @@ type ImportCertificateAuthorityCertificateInput struct { // A PEM-encoded file that contains all of your certificates, other than the // certificate you're importing, chaining up to your root CA. Your Amazon Web // Services Private CA-hosted or on-premises root certificate is the last in the - // chain, and each certificate in the chain signs the one preceding. This parameter - // must be supplied when you import a subordinate CA. When you import a root CA, - // there is no chain. + // chain, and each certificate in the chain signs the one preceding. + // + // This parameter must be supplied when you import a subordinate CA. When you + // import a root CA, there is no chain. CertificateChain []byte noSmithyDocumentSerde diff --git a/service/acmpca/api_op_IssueCertificate.go b/service/acmpca/api_op_IssueCertificate.go index cf1d7855214..ba9e8762292 100644 --- a/service/acmpca/api_op_IssueCertificate.go +++ b/service/acmpca/api_op_IssueCertificate.go @@ -13,11 +13,13 @@ 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) -// 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. +// (ARN) of the certificate. You can retrieve the certificate by calling the [GetCertificate] +// 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. +// +// [GetCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html func (c *Client) IssueCertificate(ctx context.Context, params *IssueCertificateInput, optFns ...func(*Options)) (*IssueCertificateOutput, error) { if params == nil { params = &IssueCertificateInput{} @@ -35,60 +37,79 @@ 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: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must be + // of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string // The certificate signing request (CSR) for the certificate you want to issue. As // an example, you can use the following OpenSSL command to create the CSR and a - // 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. + // 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. // // This member is required. Csr []byte // The name of the algorithm that will be used to sign the certificate to be - // issued. This parameter should not be confused with the SigningAlgorithm - // parameter used to sign a CSR in the CreateCertificateAuthority action. The - // specified signing algorithm family (RSA or ECDSA) must match the algorithm + // issued. + // + // This parameter should not be confused with the SigningAlgorithm parameter used + // to sign a CSR in the CreateCertificateAuthority action. + // + // The specified signing algorithm family (RSA or ECDSA) must match the algorithm // family of the CA's secret key. // // This member is required. SigningAlgorithm types.SigningAlgorithm // Information describing the end of the validity period of the certificate. This - // parameter sets the “Not After” date for the certificate. Certificate validity is - // 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. + // parameter sets the “Not After” date for the certificate. + // + // Certificate validity is 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]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. // + // [Validity]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5 + // // This member is required. Validity *types.Validity // 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) - // to determine what information is used. + // these templates, see [Understanding Certificate Templates]. + // + // If conflicting or duplicate certificate information is supplied during + // certificate issuance, Amazon Web Services Private CA applies [order of operation rules]to determine what + // information is used. + // + // [Understanding Certificate Templates]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html + // [order of operation rules]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations ApiPassthrough *types.ApiPassthrough // Alphanumeric string that can be used to distinguish between calls to the @@ -104,25 +125,33 @@ 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 - // 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) - // . + // PathLenN portion of the ARN, where N is the [CA depth]. + // + // 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]. + // + // [Understanding Certificate Templates]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html + // [CA depth]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaTerms.html#terms-cadepth 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 - // 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/privateca/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. + // 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] in this API + // reference and [Validity]in RFC 5280. + // + // [Validity]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5 ValidityNotBefore *types.Validity noSmithyDocumentSerde @@ -132,7 +161,8 @@ type IssueCertificateOutput struct { // The Amazon Resource Name (ARN) of the issued certificate and the certificate // serial number. This is of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245 + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245 CertificateArn *string // Metadata pertaining to the operation's result. diff --git a/service/acmpca/api_op_ListCertificateAuthorities.go b/service/acmpca/api_op_ListCertificateAuthorities.go index 2d07724e5f5..fe1bc49753b 100644 --- a/service/acmpca/api_op_ListCertificateAuthorities.go +++ b/service/acmpca/api_op_ListCertificateAuthorities.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the private certificate authorities that you created by using the -// CreateCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) -// action. +// Lists the private certificate authorities that you created by using the [CreateCertificateAuthority] action. +// +// [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html func (c *Client) ListCertificateAuthorities(ctx context.Context, params *ListCertificateAuthoritiesInput, optFns ...func(*Options)) (*ListCertificateAuthoritiesOutput, error) { if params == nil { params = &ListCertificateAuthoritiesInput{} @@ -34,8 +34,10 @@ type ListCertificateAuthoritiesInput struct { // Use this parameter when paginating results to specify the maximum number of // items to return in the response on each page. 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. Although - // the maximum value is 1000, the action only returns a maximum of 100 items. + // NextToken value in a subsequent request to retrieve additional items. + // + // Although the maximum value is 1000, the action only returns a maximum of 100 + // items. MaxResults *int32 // Use this parameter when paginating results in a subsequent request after you @@ -155,8 +157,10 @@ type ListCertificateAuthoritiesPaginatorOptions struct { // Use this parameter when paginating results to specify the maximum number of // items to return in the response on each page. 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. Although - // the maximum value is 1000, the action only returns a maximum of 100 items. + // NextToken value in a subsequent request to retrieve additional items. + // + // Although the maximum value is 1000, the action only returns a maximum of 100 + // items. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/acmpca/api_op_ListPermissions.go b/service/acmpca/api_op_ListPermissions.go index 77cf65a996a..c5f9cde67fd 100644 --- a/service/acmpca/api_op_ListPermissions.go +++ b/service/acmpca/api_op_ListPermissions.go @@ -12,22 +12,30 @@ import ( ) // 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 +// 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] action and revoked with the [DeletePermission] 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) -// . +// issuance and renewals. For more information, see [Using a Resource Based Policy with Amazon Web Services Private CA]. +// +// [Using a Resource Based Policy with Amazon Web Services Private CA]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html +// [CreatePermission]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html +// [DeletePermission]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error) { if params == nil { params = &ListPermissionsInput{} @@ -46,11 +54,11 @@ 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) - // action. This must be of the form: + // ARN by calling the [ListCertificateAuthorities]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) - // action. + // You can get a private CA's ARN by running the [ListCertificateAuthorities]action. + // + // [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_ListTags.go b/service/acmpca/api_op_ListTags.go index 9b9518ceb7f..4f9bd0b97fe 100644 --- a/service/acmpca/api_op_ListTags.go +++ b/service/acmpca/api_op_ListTags.go @@ -13,10 +13,11 @@ import ( // 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. +// organize your CAs. Each tag consists of a key and an optional value. Call the [TagCertificateAuthority] +// action to add one or more tags to your CA. Call the [UntagCertificateAuthority]action to remove tags. +// +// [TagCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html +// [UntagCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} @@ -34,10 +35,12 @@ 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) - // action. This must be of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called the [CreateCertificateAuthority] action. + // This must be of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_PutPolicy.go b/service/acmpca/api_op_PutPolicy.go index 50bfa41eb26..a2c605dbc75 100644 --- a/service/acmpca/api_op_PutPolicy.go +++ b/service/acmpca/api_op_PutPolicy.go @@ -10,29 +10,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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]. +// +// The policy can be displayed with [GetPolicy] and removed with [DeletePolicy]. +// +// 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) -// . +// more information, see [Using a Resource Based Policy with Amazon Web Services Private CA]. +// // - 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) -// . +// Services Private CA policy. For more information, see [Using a Service Linked Role with ACM]. +// // - 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) -// . +// policies. For more information, see [Attach a Policy for Cross-Account Access]. +// +// [Using a Resource Based Policy with Amazon Web Services Private CA]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html +// [Using a Service Linked Role with ACM]: https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html +// [Attach a Policy for Cross-Account Access]: https://docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html +// [DeletePolicy]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html +// [GetPolicy]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html func (c *Client) PutPolicy(ctx context.Context, params *PutPolicyInput, optFns ...func(*Options)) (*PutPolicyOutput, error) { if params == nil { params = &PutPolicyInput{} @@ -54,15 +61,17 @@ type PutPolicyInput struct { // 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) - // . + // statement structure, see [Overview of JSON Policies]. + // + // [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) - // action. + // policy. The ARN of the CA can be found by calling the [ListCertificateAuthorities]action. + // + // [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html // // This member is required. ResourceArn *string diff --git a/service/acmpca/api_op_RestoreCertificateAuthority.go b/service/acmpca/api_op_RestoreCertificateAuthority.go index 03c27f0fc64..99802605644 100644 --- a/service/acmpca/api_op_RestoreCertificateAuthority.go +++ b/service/acmpca/api_op_RestoreCertificateAuthority.go @@ -12,19 +12,22 @@ 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) -// 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) -// 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) -// 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) -// 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. +// PermanentDeletionTimeInDays parameter of the [DeleteCertificateAuthority]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]or [ListCertificateAuthorities] 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] action. If the private CA was in the +// PENDING_CERTIFICATE state at deletion, you must use the [ImportCertificateAuthorityCertificate] 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. +// +// [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html +// [ImportCertificateAuthorityCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html +// [UpdateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html +// [DeleteCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html +// [DescribeCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html func (c *Client) RestoreCertificateAuthority(ctx context.Context, params *RestoreCertificateAuthorityInput, optFns ...func(*Options)) (*RestoreCertificateAuthorityOutput, error) { if params == nil { params = &RestoreCertificateAuthorityInput{} @@ -42,10 +45,12 @@ 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) - // action. This must be of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called the [CreateCertificateAuthority] action. + // This must be of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_RevokeCertificate.go b/service/acmpca/api_op_RevokeCertificate.go index 7a0857b3e81..ffc5b5cfdc7 100644 --- a/service/acmpca/api_op_RevokeCertificate.go +++ b/service/acmpca/api_op_RevokeCertificate.go @@ -19,14 +19,21 @@ import ( // 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 +// more information, see [Supported CloudWatch Metrics]. +// +// 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]. +// +// Amazon Web Services Private CA also writes revocation information to the audit +// report. For more information, see [CreateCertificateAuthorityAuditReport]. +// +// You cannot revoke a root CA self-signed certificate. +// +// [Access policies for CRLs in Amazon S3]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies +// [CreateCertificateAuthorityAuditReport]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html +// [Supported CloudWatch Metrics]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html func (c *Client) RevokeCertificate(ctx context.Context, params *RevokeCertificateInput, optFns ...func(*Options)) (*RevokeCertificateOutput, error) { if params == nil { params = &RevokeCertificateInput{} @@ -46,20 +53,26 @@ type RevokeCertificateInput struct { // Amazon Resource Name (ARN) of the private CA that issued the certificate to be // revoked. This must be of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. 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) - // 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) - // action in the Certificate Manager API Reference. + // format. You can retrieve the serial number by calling [GetCertificate]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] action in the + // Certificate Manager API Reference. + // + // [DescribeCertificate]: https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html + // [GetCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html // // This member is required. CertificateSerial *string diff --git a/service/acmpca/api_op_TagCertificateAuthority.go b/service/acmpca/api_op_TagCertificateAuthority.go index 4709833e477..b4c0e6a1ebb 100644 --- a/service/acmpca/api_op_TagCertificateAuthority.go +++ b/service/acmpca/api_op_TagCertificateAuthority.go @@ -18,14 +18,17 @@ 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) -// 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) -// . +// or more tags, use the [UntagCertificateAuthority]action. Call the [ListTags] 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]. +// +// [Attaching tags to a CA at the time of creation]: https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca +// [UntagCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html +// [ListTags]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html func (c *Client) TagCertificateAuthority(ctx context.Context, params *TagCertificateAuthorityInput, optFns ...func(*Options)) (*TagCertificateAuthorityOutput, error) { if params == nil { params = &TagCertificateAuthorityInput{} @@ -43,10 +46,12 @@ 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: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must be + // of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_UntagCertificateAuthority.go b/service/acmpca/api_op_UntagCertificateAuthority.go index 344ff3494e2..13c1f62eee8 100644 --- a/service/acmpca/api_op_UntagCertificateAuthority.go +++ b/service/acmpca/api_op_UntagCertificateAuthority.go @@ -15,9 +15,11 @@ 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) -// action to see what tags are associated with your CA. +// a private CA, use the [TagCertificateAuthority]. Call the [ListTags] action to see what tags are associated with +// your CA. +// +// [TagCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html +// [ListTags]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html func (c *Client) UntagCertificateAuthority(ctx context.Context, params *UntagCertificateAuthorityInput, optFns ...func(*Options)) (*UntagCertificateAuthorityOutput, error) { if params == nil { params = &UntagCertificateAuthorityInput{} @@ -35,10 +37,12 @@ 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: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // The Amazon Resource Name (ARN) that was returned when you called [CreateCertificateAuthority]. This must be + // of the form: + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html // // This member is required. CertificateAuthorityArn *string diff --git a/service/acmpca/api_op_UpdateCertificateAuthority.go b/service/acmpca/api_op_UpdateCertificateAuthority.go index 27582cce2a0..c3f885afccc 100644 --- a/service/acmpca/api_op_UpdateCertificateAuthority.go +++ b/service/acmpca/api_op_UpdateCertificateAuthority.go @@ -14,12 +14,14 @@ import ( // Updates the status or configuration of a private certificate authority (CA). // Your private CA must be in the ACTIVE or DISABLED state before you can update // it. You can disable a private CA that is in the ACTIVE state or make a CA that -// is in the DISABLED state active again. 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) -// . +// is in the DISABLED state active again. +// +// 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]. +// +// [Access 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{} @@ -39,7 +41,8 @@ type UpdateCertificateAuthorityInput struct { // Amazon Resource Name (ARN) of the private CA that issued the certificate to be // revoked. This must be of the form: - // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // + // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // // This member is required. CertificateAuthorityArn *string @@ -47,20 +50,27 @@ 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) - // types. The following requirements apply to revocation configurations. + // unchanged. For more information, see the [OcspConfiguration]and [CrlConfiguration] 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) - // . + // + // - In a CRL configuration, the S3BucketName parameter must conform to [Amazon S3 bucket naming rules]. + // // - 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. + // CRLs or OCSP must conform to [RFC2396]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://". + // + // [RFC2396]: https://www.ietf.org/rfc/rfc2396.txt + // [OcspConfiguration]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html + // [Amazon S3 bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html + // [CrlConfiguration]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html RevocationConfiguration *types.RevocationConfiguration // Status of your private CA. diff --git a/service/acmpca/doc.go b/service/acmpca/doc.go index 73c41ce3194..0f0fbd6c0b9 100644 --- a/service/acmpca/doc.go +++ b/service/acmpca/doc.go @@ -6,21 +6,27 @@ // This is the Amazon Web Services Private Certificate Authority API Reference. It // provides descriptions, syntax, and usage examples for each of the actions and // data types involved in creating and managing a private certificate authority -// (CA) for your organization. The documentation for each action shows the API -// 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 -// 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/privateca/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. +// (CA) for your organization. +// +// The documentation for each action shows the API 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]. +// +// 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]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]console. +// +// [Amazon Web Services SDKs]: https://aws.amazon.com/tools/#SDKs +// [Service Quotas]: https://console.aws.amazon.com/servicequotas/ +// [ThrottlingException]: https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html package acmpca diff --git a/service/acmpca/options.go b/service/acmpca/options.go index 8ac2813ff96..14b8c8a8f6e 100644 --- a/service/acmpca/options.go +++ b/service/acmpca/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/acmpca/types/enums.go b/service/acmpca/types/enums.go index 9642a845335..eed3d297452 100644 --- a/service/acmpca/types/enums.go +++ b/service/acmpca/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AccessMethodType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessMethodType) Values() []AccessMethodType { return []AccessMethodType{ "CA_REPOSITORY", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "IssueCertificate", @@ -52,6 +54,7 @@ const ( // Values returns all known values for AuditReportResponseFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuditReportResponseFormat) Values() []AuditReportResponseFormat { return []AuditReportResponseFormat{ @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for AuditReportStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditReportStatus) Values() []AuditReportStatus { return []AuditReportStatus{ "CREATING", @@ -95,6 +99,7 @@ const ( // Values returns all known values for CertificateAuthorityStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CertificateAuthorityStatus) Values() []CertificateAuthorityStatus { return []CertificateAuthorityStatus{ @@ -118,6 +123,7 @@ const ( // 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{ @@ -136,8 +142,9 @@ const ( // Values returns all known values for CertificateAuthorityUsageMode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateAuthorityUsageMode) Values() []CertificateAuthorityUsageMode { return []CertificateAuthorityUsageMode{ "GENERAL_PURPOSE", @@ -161,8 +168,9 @@ const ( ) // Values returns all known values for ExtendedKeyUsageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExtendedKeyUsageType) Values() []ExtendedKeyUsageType { return []ExtendedKeyUsageType{ "SERVER_AUTH", @@ -187,8 +195,9 @@ const ( ) // Values returns all known values for FailureReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureReason) Values() []FailureReason { return []FailureReason{ "REQUEST_TIMED_OUT", @@ -208,8 +217,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -229,6 +239,7 @@ const ( // Values returns all known values for KeyStorageSecurityStandard. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (KeyStorageSecurityStandard) Values() []KeyStorageSecurityStandard { return []KeyStorageSecurityStandard{ @@ -245,8 +256,9 @@ const ( ) // Values returns all known values for PolicyQualifierId. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyQualifierId) Values() []PolicyQualifierId { return []PolicyQualifierId{ "CPS", @@ -262,8 +274,9 @@ const ( ) // Values returns all known values for ResourceOwner. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceOwner) Values() []ResourceOwner { return []ResourceOwner{ "SELF", @@ -286,8 +299,9 @@ const ( ) // Values returns all known values for RevocationReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RevocationReason) Values() []RevocationReason { return []RevocationReason{ "UNSPECIFIED", @@ -310,8 +324,9 @@ const ( ) // Values returns all known values for S3ObjectAcl. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ObjectAcl) Values() []S3ObjectAcl { return []S3ObjectAcl{ "PUBLIC_READ", @@ -332,8 +347,9 @@ const ( ) // Values returns all known values for SigningAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SigningAlgorithm) Values() []SigningAlgorithm { return []SigningAlgorithm{ "SHA256WITHECDSA", @@ -357,8 +373,9 @@ const ( ) // Values returns all known values for ValidityPeriodType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidityPeriodType) Values() []ValidityPeriodType { return []ValidityPeriodType{ "END_DATE", diff --git a/service/acmpca/types/errors.go b/service/acmpca/types/errors.go index ab30395a7c5..340bbde2097 100644 --- a/service/acmpca/types/errors.go +++ b/service/acmpca/types/errors.go @@ -113,8 +113,9 @@ 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]. +// +// [ListCertificateAuthorities]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html type InvalidNextTokenException struct { Message *string @@ -141,9 +142,9 @@ func (e *InvalidNextTokenException) ErrorCode() string { func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// . +// information about IAM policy and statement structure, see [Overview of JSON Policies]. +// +// [Overview of JSON Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json type InvalidPolicyException struct { Message *string diff --git a/service/acmpca/types/types.go b/service/acmpca/types/types.go index 7cbca8b5603..e5d9a16cbe2 100644 --- a/service/acmpca/types/types.go +++ b/service/acmpca/types/types.go @@ -8,8 +8,9 @@ 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]. +// +// [RFC 5280]: https://datatracker.ietf.org/doc/html/rfc5280 type AccessDescription struct { // The location of AccessDescription information. @@ -35,8 +36,9 @@ type AccessMethod struct { // 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) - // . + // of [Object Identifier (OID)]. + // + // [Object Identifier (OID)]: https://csrc.nist.gov/glossary/term/Object_Identifier CustomObjectIdentifier *string noSmithyDocumentSerde @@ -44,10 +46,13 @@ type AccessMethod struct { // 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. +// 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]to determine what information +// is used. +// +// [order of operation rules]: https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations type ApiPassthrough struct { // Specifies X.509 extension information for a certificate. @@ -73,9 +78,10 @@ type ApiPassthrough struct { 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 - // certificate subject. + // 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 // Two-digit code that specifies the country in which the certificate subject @@ -84,8 +90,11 @@ 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)]. + // + // Custom attributes cannot be used in combination with standard attributes. + // + // [Object Identifier (OID)]: https://csrc.nist.gov/glossary/term/Object_Identifier CustomAttributes []CustomAttribute // Disambiguating information for the certificate subject. @@ -107,7 +116,8 @@ type ASN1Subject struct { // located. Locality *string - // Legal name of the organization with which the certificate subject is affiliated. + // Legal name of the organization with which the certificate subject is + // affiliated. Organization *string // A subdivision or unit of the organization (such as sales or finance) with which @@ -138,14 +148,15 @@ type ASN1Subject struct { // 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) -// 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) +// the public key contained in the Subject Public Key Info field. Call the [CreateCertificateAuthority]action +// to create your private CA. You must then call the [GetCertificateAuthorityCertificate]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] // action to import the signed certificate into Certificate Manager (ACM). +// +// [ImportCertificateAuthorityCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html +// [GetCertificateAuthorityCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCertificate.html +// [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html type CertificateAuthority struct { // Amazon Resource Name (ARN) for your private certificate authority (CA). The @@ -162,12 +173,16 @@ type CertificateAuthority struct { FailureReason FailureReason // Defines a cryptographic key management compliance standard used for handling CA - // keys. Default: FIPS_140_2_LEVEL_3_OR_HIGHER Note: Amazon Web Services Region - // ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly - // specify this parameter and value when creating a CA in that Region. Specifying a - // different value (or no value) results in an InvalidArgsException with the - // message "A certificate authority cannot be created in this region with the - // specified security standard." + // keys. + // + // Default: FIPS_140_2_LEVEL_3_OR_HIGHER + // + // Note: Amazon Web Services Region ap-northeast-3 supports only + // FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and + // value when creating a CA in that Region. Specifying a different value (or no + // value) results in an InvalidArgsException with the message "A certificate + // authority cannot be created in this region with the specified security + // standard." KeyStorageSecurityStandard KeyStorageSecurityStandard // Date and time at which your private CA was last updated. @@ -183,9 +198,9 @@ type CertificateAuthority struct { OwnerAccount *string // 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) - // action. + // the PermanentDeletionTimeInDays parameter of the [DeleteCertificateAuthorityRequest] action. + // + // [DeleteCertificateAuthorityRequest]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html RestorableUntil *time.Time // Information about the Online Certificate Status Protocol (OCSP) configuration @@ -204,7 +219,9 @@ type CertificateAuthority struct { // Specifies whether the CA issues general-purpose certificates that typically // require a revocation mechanism, or short-lived certificates that may optionally // omit revocation because they expire quickly. Short-lived certificate validity is - // limited to seven days. The default value is GENERAL_PURPOSE. + // limited to seven days. + // + // The default value is GENERAL_PURPOSE. UsageMode CertificateAuthorityUsageMode noSmithyDocumentSerde @@ -214,9 +231,9 @@ type CertificateAuthority struct { // This includes information about the class of public key algorithm and the key // 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) -// action. +// distinguished name. You must specify this information when you call the [CreateCertificateAuthority]action. +// +// [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html type CertificateAuthorityConfiguration struct { // Type of the public key algorithm and size, in bits, of the key pair that your @@ -226,9 +243,10 @@ type CertificateAuthorityConfiguration struct { // This member is required. KeyAlgorithm KeyAlgorithm - // Name of the algorithm your private CA uses to sign certificate requests. This - // parameter should not be confused with the SigningAlgorithm parameter used to - // sign certificates when they are issued. + // Name of the algorithm your private CA uses to sign certificate requests. + // + // This parameter should not be confused with the SigningAlgorithm parameter used + // to sign certificates when they are issued. // // This member is required. SigningAlgorithm SigningAlgorithm @@ -256,50 +274,75 @@ type CertificateAuthorityConfiguration struct { // of each certificate it issues. If you want to configure this default behavior to // be something different, you can set the // CrlDistributionPointExtensionConfiguration parameter. 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 +// 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]. +// +// 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 -// CRL after expiration, and it always appears in the audit report. A CRL is -// 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: +// CRL after expiration, and it always appears in the audit report. +// +// A CRL is 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. +// +// - 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 +// 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)] in the Amazon Web Services Private Certificate +// Authority User Guide +// +// [Planning a certificate revocation list (CRL)]: https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html +// [Encrypting Your CRLs]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption 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) - // action. + // when you call the [CreateCertificateAuthority]action or for an existing CA when you call the [UpdateCertificateAuthority] action. + // + // [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html + // [UpdateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html // // This member is required. Enabled *bool @@ -312,10 +355,13 @@ 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://". + // 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] 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://". + // + // [RFC2396]: https://www.ietf.org/rfc/rfc2396.txt CustomCname *string // Validity period of the CRL in days. @@ -324,26 +370,33 @@ 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) - // 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) - // . + // of your bucket by calling the [UpdateCertificateAuthority]operation. You must specify a [bucket policy] 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]. + // + // [bucket policy]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies + // [S3 bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html + // [UpdateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html S3BucketName *string // Determines whether the CRL will be publicly readable or privately held in the // CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over // 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 - // 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 - // 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) - // . + // 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 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 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]. + // + // [Blocking public access to the S3 bucket]: https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa S3ObjectAcl S3ObjectAcl noSmithyDocumentSerde @@ -360,10 +413,13 @@ type CrlDistributionPointExtensionConfiguration struct { // Configures whether the CRL Distribution Point extension should be populated // with the default URL to the CRL. If set to true , then the CDP extension will // not be present in any certificates issued by that CA unless otherwise specified - // through CSR or API passthrough. Only set this if you have another way to - // distribute the CRL Distribution Points ffor certificates issued by your CA, such - // as the Matter Distributed Compliance Ledger This configuration cannot be enabled - // with a custom CNAME set. + // through CSR or API passthrough. + // + // Only set this if you have another way to distribute the CRL Distribution Points + // ffor certificates issued by your CA, such as the Matter Distributed Compliance + // Ledger + // + // This configuration cannot be enabled with a custom CNAME set. // // This member is required. OmitExtension *bool @@ -380,9 +436,9 @@ type CsrExtensions struct { 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. + // the CA, such as revocation and policy. For more information, see [Subject Information Access]in RFC 5280. + // + // [Subject Information Access]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2 SubjectInformationAccess []AccessDescription noSmithyDocumentSerde @@ -405,13 +461,17 @@ type CustomAttribute struct { noSmithyDocumentSerde } -// Specifies the X.509 extension information for a certificate. Extensions present -// in CustomExtensions follow the ApiPassthrough template rules (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) -// . +// Specifies the X.509 extension information for a certificate. +// +// Extensions present in CustomExtensions follow the ApiPassthrough[template rules] . +// +// [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 - // information, see the Global OID reference database. (https://oidref.com/2.5.29) + // information, see the [Global OID reference database.] + // + // [Global OID reference database.]: https://oidref.com/2.5.29 // // This member is required. ObjectIdentifier *string @@ -428,8 +488,9 @@ type CustomExtension struct { } // 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. +// defined in [Subject Alternative Name]in RFC 5280. +// +// [Subject Alternative Name]: https://datatracker.ietf.org/doc/html/rfc5280 type EdiPartyName struct { // Specifies the party name. @@ -450,8 +511,9 @@ 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]. + // + // [RFC 5280]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12 ExtendedKeyUsageType ExtendedKeyUsageType noSmithyDocumentSerde @@ -462,16 +524,21 @@ 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 + // information, see NIST's definition of [Object Identifier (OID)]. + // + // 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. + // + // [Object Identifier (OID)]: https://csrc.nist.gov/glossary/term/Object_Identifier 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.] + // + // [Global OID reference database.]: https://oidref.com/2.5.29 CustomExtensions []CustomExtension // Specifies additional purposes for which the certified public key may be used @@ -490,9 +557,11 @@ 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]. Only one of the following +// naming options should be provided. Providing more than one option results in an +// InvalidArgsException error. +// +// [RFC 5280]: https://datatracker.ietf.org/doc/html/rfc5280 type GeneralName struct { // Contains information about the certificate subject. The Subject field in the @@ -515,11 +584,12 @@ type GeneralName struct { // Represents GeneralName using an OtherName object. OtherName *OtherName - // Represents GeneralName as an object identifier (OID). + // 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] email address. + // + // [RFC 822]: https://datatracker.ietf.org/doc/html/rfc822 Rfc822Name *string // Represents GeneralName as a URI. @@ -541,7 +611,7 @@ type KeyUsage struct { // Key can be used only to decipher data. DecipherOnly bool - // Key can be used for digital signing. + // Key can be used for digital signing. DigitalSignature bool // Key can be used only to encipher data. @@ -563,8 +633,10 @@ type KeyUsage struct { } // Contains information to enable and configure Online Certificate Status Protocol -// (OCSP) for validating certificate revocation status. When you revoke a -// certificate, OCSP responses may take up to 60 minutes to reflect the new status. +// (OCSP) for validating certificate revocation status. +// +// When you revoke a certificate, OCSP responses may take up to 60 minutes to +// reflect the new status. type OcspConfiguration struct { // Flag enabling use of the Online Certificate Status Protocol (OCSP) for @@ -576,12 +648,17 @@ type OcspConfiguration struct { // 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. + // specifying a customized OCSP domain. + // + // The content of a Canonical Name (CNAME) record must conform to [RFC2396] 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)] in the Amazon Web Services Private Certificate + // Authority User Guide. + // + // [RFC2396]: https://www.ietf.org/rfc/rfc2396.txt + // [Customizing Online Certificate Status Protocol (OCSP)]: https://docs.aws.amazon.com/privateca/latest/userguide/ocsp-customize.html OcspCustomCname *string noSmithyDocumentSerde @@ -589,8 +666,9 @@ 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)]. +// +// [Object Identifier (OID)]: https://csrc.nist.gov/glossary/term/Object_Identifier type OtherName struct { // Specifies an OID. @@ -610,10 +688,11 @@ type OtherName struct { // 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) -// action. +// assigned with the [CreatePermission]action, removed with the [DeletePermission] action, and listed with the [ListPermissions] action. +// +// [CreatePermission]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html +// [ListPermissions]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html +// [DeletePermission]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html type Permission struct { // The private CA actions that can be performed by the designated Amazon Web @@ -644,8 +723,9 @@ type Permission struct { 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) . + // certificate was issued. For more information, see NIST's definition of [Object Identifier (OID)]. + // + // [Object Identifier (OID)]: https://csrc.nist.gov/glossary/term/Object_Identifier // // This member is required. CertPolicyId *string @@ -677,8 +757,9 @@ 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]defined in RFC 5280. +// +// [certification practice statement (CPS) qualifier]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4 type Qualifier struct { // Contains a pointer to a certification practice statement (CPS) published by the @@ -690,15 +771,18 @@ 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) -// 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) -// in the Amazon Web Services Private Certificate Authority User Guide. +// Certificate revocation information used by the [CreateCertificateAuthority] and [UpdateCertificateAuthority] 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]and [Setting up a certificate revocation method] in the Amazon Web Services Private Certificate Authority +// User Guide. +// +// [RevokeCertificate]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html +// [Setting up a certificate revocation method]: https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html +// [CreateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html +// [UpdateCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html type RevocationConfiguration struct { // Configuration of the certificate revocation list (CRL), if any, maintained by @@ -717,10 +801,11 @@ type RevocationConfiguration struct { // 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. +// tags with a private CA. To add one or more tags to a private CA, call the [TagCertificateAuthority] +// action. To remove a tag, call the [UntagCertificateAuthority]action. +// +// [TagCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html +// [UntagCertificateAuthority]: https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html type Tag struct { // Key (name) of the tag. @@ -737,33 +822,47 @@ 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]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. +// +// [Validity]: https://tools.ietf.org/html/rfc5280#section-4.1.2.5 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: + // 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. diff --git a/service/amp/api_op_CreateAlertManagerDefinition.go b/service/amp/api_op_CreateAlertManagerDefinition.go index 8819178714c..a04cced20aa 100644 --- a/service/amp/api_op_CreateAlertManagerDefinition.go +++ b/service/amp/api_op_CreateAlertManagerDefinition.go @@ -33,9 +33,11 @@ func (c *Client) CreateAlertManagerDefinition(ctx context.Context, params *Creat type CreateAlertManagerDefinitionInput struct { // The alert manager definition to add. A base64-encoded version of the YAML alert - // manager definition file. For details about the alert manager definition, see - // AlertManagedDefinitionData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html) - // . + // manager definition file. + // + // For details about the alert manager definition, see [AlertManagedDefinitionData]. + // + // [AlertManagedDefinitionData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html // // This member is required. Data []byte diff --git a/service/amp/api_op_CreateRuleGroupsNamespace.go b/service/amp/api_op_CreateRuleGroupsNamespace.go index 600c04e28f6..989ca3dab2f 100644 --- a/service/amp/api_op_CreateRuleGroupsNamespace.go +++ b/service/amp/api_op_CreateRuleGroupsNamespace.go @@ -13,9 +13,10 @@ import ( // The CreateRuleGroupsNamespace operation creates a rule groups namespace within // a workspace. A rule groups namespace is associated with exactly one rules file. -// A workspace can have multiple rule groups namespaces. Use this operation only to -// create new rule groups namespaces. To update an existing rule groups namespace, -// use PutRuleGroupsNamespace . +// A workspace can have multiple rule groups namespaces. +// +// Use this operation only to create new rule groups namespaces. To update an +// existing rule groups namespace, use PutRuleGroupsNamespace . func (c *Client) CreateRuleGroupsNamespace(ctx context.Context, params *CreateRuleGroupsNamespaceInput, optFns ...func(*Options)) (*CreateRuleGroupsNamespaceOutput, error) { if params == nil { params = &CreateRuleGroupsNamespaceInput{} @@ -34,10 +35,13 @@ func (c *Client) CreateRuleGroupsNamespace(ctx context.Context, params *CreateRu // Represents the input of a CreateRuleGroupsNamespace operation. type CreateRuleGroupsNamespaceInput struct { - // The rules file to use in the new namespace. Contains the base64-encoded version - // of the YAML rules file. For details about the rule groups namespace structure, - // see RuleGroupsNamespaceData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html) - // . + // The rules file to use in the new namespace. + // + // Contains the base64-encoded version of the YAML rules file. + // + // For details about the rule groups namespace structure, see [RuleGroupsNamespaceData]. + // + // [RuleGroupsNamespaceData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html // // This member is required. Data []byte diff --git a/service/amp/api_op_CreateScraper.go b/service/amp/api_op_CreateScraper.go index 72471fbde92..50c3fb6172f 100644 --- a/service/amp/api_op_CreateScraper.go +++ b/service/amp/api_op_CreateScraper.go @@ -15,17 +15,24 @@ import ( // pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, // and sends them to your Amazon Managed Service for Prometheus workspace. You can // configure the scraper to control what metrics are collected, and what -// transformations are applied prior to sending them to your workspace. If needed, -// an IAM role will be created for you that gives Amazon Managed Service for -// Prometheus access to the metrics in your cluster. For more information, see -// Using roles for scraping metrics from EKS (https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper) -// in the Amazon Managed Service for Prometheus User Guide. You cannot update a -// scraper. If you want to change the configuration of the scraper, create a new -// scraper and delete the old one. The scrapeConfiguration parameter contains the -// base64-encoded version of the YAML configuration file. For more information -// about collectors, including what metrics are collected, and how to configure the -// scraper, see Amazon Web Services managed collectors (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html) -// in the Amazon Managed Service for Prometheus User Guide. +// transformations are applied prior to sending them to your workspace. +// +// If needed, an IAM role will be created for you that gives Amazon Managed +// Service for Prometheus access to the metrics in your cluster. For more +// information, see [Using roles for scraping metrics from EKS]in the Amazon Managed Service for Prometheus User Guide. +// +// You cannot update a scraper. If you want to change the configuration of the +// scraper, create a new scraper and delete the old one. +// +// The scrapeConfiguration parameter contains the base64-encoded version of the +// YAML configuration file. +// +// For more information about collectors, including what metrics are collected, +// and how to configure the scraper, see [Amazon Web Services managed collectors]in the Amazon Managed Service for +// Prometheus User Guide. +// +// [Amazon Web Services managed collectors]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html +// [Using roles for scraping metrics from EKS]: https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper func (c *Client) CreateScraper(ctx context.Context, params *CreateScraperInput, optFns ...func(*Options)) (*CreateScraperOutput, error) { if params == nil { params = &CreateScraperInput{} @@ -49,8 +56,8 @@ type CreateScraperInput struct { // This member is required. Destination types.Destination - // The configuration file to use in the new scraper. For more information, see - // Scraper configuration in the Amazon Managed Service for Prometheus User Guide. + // The configuration file to use in the new scraper. For more information, see Scraper configuration in + // the Amazon Managed Service for Prometheus User Guide. // // This member is required. ScrapeConfiguration types.ScrapeConfiguration diff --git a/service/amp/api_op_CreateWorkspace.go b/service/amp/api_op_CreateWorkspace.go index f59b866f0a9..78236bf2d93 100644 --- a/service/amp/api_op_CreateWorkspace.go +++ b/service/amp/api_op_CreateWorkspace.go @@ -33,8 +33,10 @@ func (c *Client) CreateWorkspace(ctx context.Context, params *CreateWorkspaceInp type CreateWorkspaceInput struct { // An alias that you assign to this workspace to help you identify it. It does not - // need to be unique. Blank spaces at the beginning or end of the alias that you - // specify will be trimmed from the value used. + // need to be unique. + // + // Blank spaces at the beginning or end of the alias that you specify will be + // trimmed from the value used. Alias *string // A unique identifier that you can provide to ensure the idempotency of the @@ -43,8 +45,9 @@ type CreateWorkspaceInput struct { // (optional) The ARN for a customer managed KMS key to use for encrypting data // within your workspace. For more information about using your own key in your - // workspace, see Encryption at rest (https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) - // in the Amazon Managed Service for Prometheus User Guide. + // workspace, see [Encryption at rest]in the Amazon Managed Service for Prometheus User Guide. + // + // [Encryption at rest]: https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html KmsKeyArn *string // The list of tag keys and values to associate with the workspace. diff --git a/service/amp/api_op_DeleteWorkspace.go b/service/amp/api_op_DeleteWorkspace.go index 48072422c60..8e5a8b6de56 100644 --- a/service/amp/api_op_DeleteWorkspace.go +++ b/service/amp/api_op_DeleteWorkspace.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing workspace. When you delete a workspace, the data that has -// been ingested into it is not immediately deleted. It will be permanently deleted -// within one month. +// Deletes an existing workspace. +// +// When you delete a workspace, the data that has been ingested into it is not +// immediately deleted. It will be permanently deleted within one month. func (c *Client) DeleteWorkspace(ctx context.Context, params *DeleteWorkspaceInput, optFns ...func(*Options)) (*DeleteWorkspaceOutput, error) { if params == nil { params = &DeleteWorkspaceInput{} diff --git a/service/amp/api_op_DescribeScraper.go b/service/amp/api_op_DescribeScraper.go index 1b3f134a926..e86d15bfa2e 100644 --- a/service/amp/api_op_DescribeScraper.go +++ b/service/amp/api_op_DescribeScraper.go @@ -176,12 +176,13 @@ type ScraperActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeScraperInput, *DescribeScraperOutput, error) (bool, error) } @@ -365,12 +366,13 @@ type ScraperDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeScraperInput, *DescribeScraperOutput, error) (bool, error) } diff --git a/service/amp/api_op_DescribeWorkspace.go b/service/amp/api_op_DescribeWorkspace.go index c42fcd65567..89a683e03ae 100644 --- a/service/amp/api_op_DescribeWorkspace.go +++ b/service/amp/api_op_DescribeWorkspace.go @@ -176,12 +176,13 @@ type WorkspaceActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeWorkspaceInput, *DescribeWorkspaceOutput, error) (bool, error) } @@ -382,12 +383,13 @@ type WorkspaceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeWorkspaceInput, *DescribeWorkspaceOutput, error) (bool, error) } diff --git a/service/amp/api_op_GetDefaultScraperConfiguration.go b/service/amp/api_op_GetDefaultScraperConfiguration.go index 88127288c71..164a0b8f09f 100644 --- a/service/amp/api_op_GetDefaultScraperConfiguration.go +++ b/service/amp/api_op_GetDefaultScraperConfiguration.go @@ -35,9 +35,10 @@ type GetDefaultScraperConfigurationInput struct { // Represents the output of a GetDefaultScraperConfiguration operation. type GetDefaultScraperConfigurationOutput struct { - // The configuration file. Base 64 encoded. For more information, see Scraper - // configuration (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration) - // in the Amazon Managed Service for Prometheus User Guide. + // The configuration file. Base 64 encoded. For more information, see [Scraper configuration]in the + // Amazon Managed Service for Prometheus User Guide. + // + // [Scraper configuration]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration // // This member is required. Configuration []byte diff --git a/service/amp/api_op_ListRuleGroupsNamespaces.go b/service/amp/api_op_ListRuleGroupsNamespaces.go index a79f71b4a14..288335966b0 100644 --- a/service/amp/api_op_ListRuleGroupsNamespaces.go +++ b/service/amp/api_op_ListRuleGroupsNamespaces.go @@ -45,10 +45,12 @@ type ListRuleGroupsNamespacesInput struct { // The token for the next set of items to return. You receive this token from a // previous call, and use it to get the next page of results. The other parameters - // must be the same as the initial call. For example, if your initial request has - // maxResults of 10, and there are 12 rule groups namespaces to return, then your - // initial request will return 10 and a nextToken . Using the next token in a - // subsequent call will return the remaining 2 namespaces. + // must be the same as the initial call. + // + // For example, if your initial request has maxResults of 10, and there are 12 + // rule groups namespaces to return, then your initial request will return 10 and a + // nextToken . Using the next token in a subsequent call will return the remaining + // 2 namespaces. NextToken *string noSmithyDocumentSerde diff --git a/service/amp/api_op_ListScrapers.go b/service/amp/api_op_ListScrapers.go index 1f43040dadc..6d9ad761a79 100644 --- a/service/amp/api_op_ListScrapers.go +++ b/service/amp/api_op_ListScrapers.go @@ -33,21 +33,27 @@ func (c *Client) ListScrapers(ctx context.Context, params *ListScrapersInput, op type ListScrapersInput struct { // (Optional) A list of key-value pairs to filter the list of scrapers returned. - // Keys include status , sourceArn , destinationArn , and alias . Filters on the - // same key are OR 'd together, and filters on different keys are AND 'd together. - // For example, status=ACTIVE&status=CREATING&alias=Test , will return all scrapers - // that have the alias Test, and are either in status ACTIVE or CREATING. To find - // all active scrapers that are sending metrics to a specific Amazon Managed - // Service for Prometheus workspace, you would use the ARN of the workspace in a - // query: - // status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012 + // Keys include status , sourceArn , destinationArn , and alias . + // + // Filters on the same key are OR 'd together, and filters on different keys are + // AND 'd together. For example, status=ACTIVE&status=CREATING&alias=Test , will + // return all scrapers that have the alias Test, and are either in status ACTIVE or + // CREATING. + // + // To find all active scrapers that are sending metrics to a specific Amazon + // Managed Service for Prometheus workspace, you would use the ARN of the workspace + // in a query: + // + // status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012 + // // If this is included, it filters the results to only the scrapers that match the // filter. Filters map[string][]string // Optional) The maximum number of scrapers to return in one ListScrapers - // operation. The range is 1-1000. If you omit this parameter, the default of 100 - // is used. + // operation. The range is 1-1000. + // + // If you omit this parameter, the default of 100 is used. MaxResults *int32 // (Optional) The token for the next set of items to return. (You received this @@ -162,8 +168,9 @@ var _ ListScrapersAPIClient = (*Client)(nil) // ListScrapersPaginatorOptions is the paginator options for ListScrapers type ListScrapersPaginatorOptions struct { // Optional) The maximum number of scrapers to return in one ListScrapers - // operation. The range is 1-1000. If you omit this parameter, the default of 100 - // is used. + // operation. The range is 1-1000. + // + // 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/amp/api_op_ListWorkspaces.go b/service/amp/api_op_ListWorkspaces.go index cd0d3b54ac7..be18932d4ec 100644 --- a/service/amp/api_op_ListWorkspaces.go +++ b/service/amp/api_op_ListWorkspaces.go @@ -32,9 +32,10 @@ func (c *Client) ListWorkspaces(ctx context.Context, params *ListWorkspacesInput type ListWorkspacesInput struct { // If this is included, it filters the results to only the workspaces with names - // that start with the value that you specify here. Amazon Managed Service for - // Prometheus will automatically strip any blank spaces from the beginning and end - // of the alias that you specify. + // that start with the value that you specify here. + // + // Amazon Managed Service for Prometheus will automatically strip any blank spaces + // from the beginning and end of the alias that you specify. Alias *string // The maximum number of workspaces to return per request. The default is 100. @@ -42,10 +43,12 @@ type ListWorkspacesInput struct { // The token for the next set of items to return. You receive this token from a // previous call, and use it to get the next page of results. The other parameters - // must be the same as the initial call. For example, if your initial request has - // maxResults of 10, and there are 12 workspaces to return, then your initial - // request will return 10 and a nextToken . Using the next token in a subsequent - // call will return the remaining 2 workspaces. + // must be the same as the initial call. + // + // For example, if your initial request has maxResults of 10, and there are 12 + // workspaces to return, then your initial request will return 10 and a nextToken . + // Using the next token in a subsequent call will return the remaining 2 + // workspaces. NextToken *string noSmithyDocumentSerde diff --git a/service/amp/api_op_PutAlertManagerDefinition.go b/service/amp/api_op_PutAlertManagerDefinition.go index 1311cf7cdc0..bfc53902959 100644 --- a/service/amp/api_op_PutAlertManagerDefinition.go +++ b/service/amp/api_op_PutAlertManagerDefinition.go @@ -33,9 +33,11 @@ func (c *Client) PutAlertManagerDefinition(ctx context.Context, params *PutAlert type PutAlertManagerDefinitionInput struct { // The alert manager definition to use. A base64-encoded version of the YAML alert - // manager definition file. For details about the alert manager definition, see - // AlertManagedDefinitionData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html) - // . + // manager definition file. + // + // For details about the alert manager definition, see [AlertManagedDefinitionData]. + // + // [AlertManagedDefinitionData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html // // This member is required. Data []byte diff --git a/service/amp/api_op_PutRuleGroupsNamespace.go b/service/amp/api_op_PutRuleGroupsNamespace.go index 8480d8c9570..18fdea813f7 100644 --- a/service/amp/api_op_PutRuleGroupsNamespace.go +++ b/service/amp/api_op_PutRuleGroupsNamespace.go @@ -13,10 +13,13 @@ import ( // Updates an existing rule groups namespace within a workspace. A rule groups // namespace is associated with exactly one rules file. A workspace can have -// multiple rule groups namespaces. Use this operation only to update existing rule -// groups namespaces. To create a new rule groups namespace, use -// CreateRuleGroupsNamespace . You can't use this operation to add tags to an -// existing rule groups namespace. Instead, use TagResource . +// multiple rule groups namespaces. +// +// Use this operation only to update existing rule groups namespaces. To create a +// new rule groups namespace, use CreateRuleGroupsNamespace . +// +// You can't use this operation to add tags to an existing rule groups namespace. +// Instead, use TagResource . func (c *Client) PutRuleGroupsNamespace(ctx context.Context, params *PutRuleGroupsNamespaceInput, optFns ...func(*Options)) (*PutRuleGroupsNamespaceOutput, error) { if params == nil { params = &PutRuleGroupsNamespaceInput{} @@ -36,9 +39,11 @@ func (c *Client) PutRuleGroupsNamespace(ctx context.Context, params *PutRuleGrou type PutRuleGroupsNamespaceInput struct { // The new rules file to use in the namespace. A base64-encoded version of the - // YAML rule groups file. For details about the rule groups namespace structure, - // see RuleGroupsNamespaceData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html) - // . + // YAML rule groups file. + // + // For details about the rule groups namespace structure, see [RuleGroupsNamespaceData]. + // + // [RuleGroupsNamespaceData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html // // This member is required. Data []byte diff --git a/service/amp/api_op_TagResource.go b/service/amp/api_op_TagResource.go index 312f7531cc6..f8c692da8b3 100644 --- a/service/amp/api_op_TagResource.go +++ b/service/amp/api_op_TagResource.go @@ -12,10 +12,12 @@ import ( // The TagResource operation associates tags with an Amazon Managed Service for // Prometheus resource. The only resources that can be tagged are workspaces and -// rule groups namespaces. If you specify a new tag key for the resource, this tag -// is appended to the list of tags associated with the resource. 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. +// rule groups namespaces. +// +// If you specify a new tag key for the resource, this tag is appended to the list +// of tags associated with the resource. 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -38,8 +40,9 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The list of tag keys and values to associate with the resource. Keys may not - // begin with aws: . + // The list of tag keys and values to associate with the resource. + // + // Keys may not begin with aws: . // // This member is required. Tags map[string]string diff --git a/service/amp/api_op_UpdateWorkspaceAlias.go b/service/amp/api_op_UpdateWorkspaceAlias.go index d6b11a31563..018acd458bc 100644 --- a/service/amp/api_op_UpdateWorkspaceAlias.go +++ b/service/amp/api_op_UpdateWorkspaceAlias.go @@ -34,9 +34,10 @@ type UpdateWorkspaceAliasInput struct { // This member is required. WorkspaceId *string - // The new alias for the workspace. It does not need to be unique. Amazon Managed - // Service for Prometheus will automatically strip any blank spaces from the - // beginning and end of the alias that you specify. + // The new alias for the workspace. It does not need to be unique. + // + // Amazon Managed Service for Prometheus will automatically strip any blank spaces + // from the beginning and end of the alias that you specify. Alias *string // A unique identifier that you can provide to ensure the idempotency of the diff --git a/service/amp/doc.go b/service/amp/doc.go index 02f301f2a19..178abe44421 100644 --- a/service/amp/doc.go +++ b/service/amp/doc.go @@ -9,13 +9,19 @@ // Prometheus, you can use the same open-source Prometheus data model and query // language that you use today to monitor the performance of your containerized // workloads, and also enjoy improved scalability, availability, and security -// without having to manage the underlying infrastructure. For more information -// about Amazon Managed Service for Prometheus, see the Amazon Managed Service for -// Prometheus (https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html) -// User Guide. Amazon Managed Service for Prometheus includes two APIs. +// without having to manage the underlying infrastructure. +// +// For more information about Amazon Managed Service for Prometheus, see the [Amazon Managed Service for Prometheus] User +// Guide. +// +// Amazon Managed Service for Prometheus includes two APIs. +// // - Use the Amazon Web Services API described in this guide to manage Amazon // Managed Service for Prometheus resources, such as workspaces, rule groups, and // alert managers. -// - Use the Prometheus-compatible API (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis) -// to work within your Prometheus workspace. +// +// - Use the [Prometheus-compatible API]to work within your Prometheus workspace. +// +// [Amazon Managed Service for Prometheus]: https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html +// [Prometheus-compatible API]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis package amp diff --git a/service/amp/options.go b/service/amp/options.go index 829dbabaa8f..dbe2fd7bff9 100644 --- a/service/amp/options.go +++ b/service/amp/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/amp/types/enums.go b/service/amp/types/enums.go index 8bf4b70e3fa..5f3407ab9d3 100644 --- a/service/amp/types/enums.go +++ b/service/amp/types/enums.go @@ -26,8 +26,9 @@ const ( // Values returns all known values for AlertManagerDefinitionStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlertManagerDefinitionStatusCode) Values() []AlertManagerDefinitionStatusCode { return []AlertManagerDefinitionStatusCode{ "CREATING", @@ -63,8 +64,9 @@ const ( // Values returns all known values for LoggingConfigurationStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoggingConfigurationStatusCode) Values() []LoggingConfigurationStatusCode { return []LoggingConfigurationStatusCode{ "CREATING", @@ -100,8 +102,9 @@ const ( // Values returns all known values for RuleGroupsNamespaceStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleGroupsNamespaceStatusCode) Values() []RuleGroupsNamespaceStatusCode { return []RuleGroupsNamespaceStatusCode{ "CREATING", @@ -130,8 +133,9 @@ const ( ) // Values returns all known values for ScraperStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScraperStatusCode) Values() []ScraperStatusCode { return []ScraperStatusCode{ "CREATING", @@ -154,6 +158,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -182,8 +187,9 @@ const ( ) // Values returns all known values for WorkspaceStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceStatusCode) Values() []WorkspaceStatusCode { return []WorkspaceStatusCode{ "CREATING", diff --git a/service/amp/types/types.go b/service/amp/types/types.go index 97bad32c5e8..4df5592a855 100644 --- a/service/amp/types/types.go +++ b/service/amp/types/types.go @@ -15,9 +15,11 @@ type AlertManagerDefinitionDescription struct { // This member is required. CreatedAt *time.Time - // The actual alert manager definition. For details about the alert manager - // definition, see AlertManagedDefinitionData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html) - // . + // The actual alert manager definition. + // + // For details about the alert manager definition, see [AlertManagedDefinitionData]. + // + // [AlertManagedDefinitionData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html // // This member is required. Data []byte @@ -158,9 +160,11 @@ type RuleGroupsNamespaceDescription struct { // This member is required. CreatedAt *time.Time - // The rule groups file used in the namespace. For details about the rule groups - // namespace structure, see RuleGroupsNamespaceData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html) - // . + // The rule groups file used in the namespace. + // + // For details about the rule groups namespace structure, see [RuleGroupsNamespaceData]. + // + // [RuleGroupsNamespaceData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html // // This member is required. Data []byte @@ -238,8 +242,7 @@ type RuleGroupsNamespaceSummary struct { } // A scrape configuration for a scraper, base 64 encoded. For more information, -// see Scraper configuration in the Amazon Managed Service for Prometheus User -// Guide. +// see Scraper configurationin the Amazon Managed Service for Prometheus User Guide. // // The following types satisfy this interface: // diff --git a/service/amplify/api_op_CreateApp.go b/service/amplify/api_op_CreateApp.go index 7fbab9b32a8..393c5aa12d4 100644 --- a/service/amplify/api_op_CreateApp.go +++ b/service/amplify/api_op_CreateApp.go @@ -37,14 +37,18 @@ type CreateAppInput struct { // The personal access token for a GitHub repository for an Amplify app. The // 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 - // 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 . + // 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 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]in the Amplify User Guide . + // + // [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 AccessToken *string // The automated branch creation configuration for an Amplify app. @@ -84,10 +88,12 @@ type CreateAppInput struct { // branch from your Git repository. EnableBranchAutoDeletion *bool - // The environment variables map for an Amplify app. For a list of the environment - // variables that are accessible to Amplify by default, see Amplify Environment - // variables (https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) - // in the Amplify Hosting User Guide. + // The environment variables map for an Amplify app. + // + // For a list of the environment variables that are accessible to Amplify by + // default, see [Amplify Environment variables]in the Amplify Hosting User Guide. + // + // [Amplify Environment variables]: https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html EnvironmentVariables map[string]string // The AWS Identity and Access Management (IAM) service role for an Amplify app. @@ -95,15 +101,19 @@ type CreateAppInput struct { // The OAuth token for a third-party source control system for an Amplify app. The // 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 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) - // in the Amplify User Guide . + // 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 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]in the Amplify User Guide . + // + // [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 OauthToken *string // The platform for the Amplify app. For a static app, set the platform type to WEB diff --git a/service/amplify/api_op_CreateBackendEnvironment.go b/service/amplify/api_op_CreateBackendEnvironment.go index 89f26a41640..8ad7dc3ebfc 100644 --- a/service/amplify/api_op_CreateBackendEnvironment.go +++ b/service/amplify/api_op_CreateBackendEnvironment.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new backend environment for an Amplify app. This API is available -// only to Amplify Gen 1 applications where the backend is created using Amplify -// Studio or the Amplify command line interface (CLI). This API isn’t available to -// applications created using the Amplify Gen 2 public preview. When you deploy an -// application with Amplify Gen 2, you provision the app's backend infrastructure -// using Typescript code. +// Creates a new backend environment for an Amplify app. +// +// This API is available only to Amplify Gen 1 applications where the backend is +// created using Amplify Studio or the Amplify command line interface (CLI). This +// API isn’t available to applications created using the Amplify Gen 2 public +// preview. When you deploy an application with Amplify Gen 2, you provision the +// app's backend infrastructure using Typescript code. func (c *Client) CreateBackendEnvironment(ctx context.Context, params *CreateBackendEnvironmentInput, optFns ...func(*Options)) (*CreateBackendEnvironmentOutput, error) { if params == nil { params = &CreateBackendEnvironmentInput{} diff --git a/service/amplify/api_op_CreateBranch.go b/service/amplify/api_op_CreateBranch.go index d706568c390..aae1dd7e286 100644 --- a/service/amplify/api_op_CreateBranch.go +++ b/service/amplify/api_op_CreateBranch.go @@ -30,7 +30,7 @@ func (c *Client) CreateBranch(ctx context.Context, params *CreateBranchInput, op // The request structure for the create branch request. type CreateBranchInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string @@ -48,53 +48,54 @@ type CreateBranchInput struct { // Amplify app. BackendEnvironmentArn *string - // The basic authorization credentials for the branch. You must base64-encode the + // The basic authorization credentials for the branch. You must base64-encode the // authorization credentials and provide them in the format user:password . BasicAuthCredentials *string - // The build specification (build spec) for the branch. + // The build specification (build spec) for the branch. BuildSpec *string // The description for the branch. Description *string - // The display name for a branch. This is used as the default domain prefix. + // The display name for a branch. This is used as the default domain prefix. DisplayName *string - // Enables auto building for the branch. + // Enables auto building for the branch. EnableAutoBuild *bool - // Enables basic authorization for the branch. + // Enables basic authorization for the branch. EnableBasicAuth *bool - // Enables notifications for the branch. + // Enables notifications for the branch. EnableNotification *bool - // Enables performance mode for the branch. Performance mode optimizes for faster - // hosting performance by keeping content cached at the edge for a longer interval. - // When performance mode is enabled, hosting configuration or code changes can take - // up to 10 minutes to roll out. + // Enables performance mode for the branch. + // + // Performance mode optimizes for faster hosting performance by keeping content + // cached at the edge for a longer interval. When performance mode is enabled, + // hosting configuration or code changes can take up to 10 minutes to roll out. EnablePerformanceMode *bool - // Enables pull request previews for this branch. + // Enables pull request previews for this branch. EnablePullRequestPreview *bool - // The environment variables for the branch. + // The environment variables for the branch. EnvironmentVariables map[string]string - // The framework for the branch. + // The framework for the branch. Framework *string - // The Amplify environment name for the pull request. + // The Amplify environment name for the pull request. PullRequestEnvironmentName *string // Describes the current stage for the branch. Stage types.Stage - // The tag for the branch. + // The tag for the branch. Tags map[string]string - // The content Time To Live (TTL) for the website in seconds. + // The content Time To Live (TTL) for the website in seconds. Ttl *string noSmithyDocumentSerde @@ -103,8 +104,8 @@ type CreateBranchInput struct { // The result structure for create branch request. type CreateBranchOutput struct { - // Describes the branch for an Amplify app, which maps to a third-party repository - // branch. + // Describes the branch for an Amplify app, which maps to a third-party + // repository branch. // // This member is required. Branch *types.Branch diff --git a/service/amplify/api_op_CreateDeployment.go b/service/amplify/api_op_CreateDeployment.go index 239cb3ff879..570216c8f5a 100644 --- a/service/amplify/api_op_CreateDeployment.go +++ b/service/amplify/api_op_CreateDeployment.go @@ -11,10 +11,11 @@ import ( ) // Creates a deployment for a manually deployed Amplify app. Manually deployed -// apps are not connected to a repository. The maximum duration between the -// CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If -// the duration exceeds 8 hours, the StartDeployment call and the associated Job -// will fail. +// apps are not connected to a repository. +// +// The maximum duration between the CreateDeployment call and the StartDeployment +// call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment +// call and the associated Job will fail. func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error) { if params == nil { params = &CreateDeploymentInput{} @@ -33,17 +34,17 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI // The request structure for the create a new deployment request. type CreateDeploymentInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string - // The name of the branch to use for the job. + // The name of the branch to use for the job. // // This member is required. BranchName *string - // An optional file map that contains the file name as the key and the file + // 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. @@ -55,19 +56,19 @@ type CreateDeploymentInput struct { // The result structure for the create a new deployment request. type CreateDeploymentOutput struct { - // When the fileMap argument is provided in the request, fileUploadUrls will + // When the fileMap argument is provided in the request, fileUploadUrls will // contain a map of file names to upload URLs. // // This member is required. FileUploadUrls map[string]string - // When the fileMap argument is not provided in the request, this zipUploadUrl is + // When the fileMap argument is not provided in the request, this zipUploadUrl is // returned. // // This member is required. ZipUploadUrl *string - // The job ID for this deployment. will supply to start deployment api. + // The job ID for this deployment. will supply to start deployment api. JobId *string // Metadata pertaining to the operation's result. diff --git a/service/amplify/api_op_CreateDomainAssociation.go b/service/amplify/api_op_CreateDomainAssociation.go index ccbf8dda16d..da8b1c35434 100644 --- a/service/amplify/api_op_CreateDomainAssociation.go +++ b/service/amplify/api_op_CreateDomainAssociation.go @@ -31,25 +31,25 @@ func (c *Client) CreateDomainAssociation(ctx context.Context, params *CreateDoma // The request structure for the create domain association request. type CreateDomainAssociationInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string - // The domain name for the domain association. + // The domain name for the domain association. // // This member is required. DomainName *string - // The setting for the subdomain. + // The setting for the subdomain. // // This member is required. SubDomainSettings []types.SubDomainSetting - // Sets the branch patterns for automatic subdomain creation. + // Sets the branch patterns for automatic subdomain creation. AutoSubDomainCreationPatterns []string - // The required AWS Identity and Access Management (IAM) service role for the + // The required AWS Identity and Access Management (IAM) service role for the // Amazon Resource Name (ARN) for automatically creating subdomains. AutoSubDomainIAMRole *string @@ -58,7 +58,7 @@ type CreateDomainAssociationInput struct { // provisions and manages for you. CertificateSettings *types.CertificateSettings - // Enables the automated creation of subdomains for branches. + // Enables the automated creation of subdomains for branches. EnableAutoSubDomain *bool noSmithyDocumentSerde @@ -67,7 +67,7 @@ type CreateDomainAssociationInput struct { // The result structure for the create domain association request. type CreateDomainAssociationOutput struct { - // Describes the structure of a domain association, which associates a custom + // Describes the structure of a domain association, which associates a custom // domain with an Amplify app. // // This member is required. diff --git a/service/amplify/api_op_DeleteBackendEnvironment.go b/service/amplify/api_op_DeleteBackendEnvironment.go index f1d01f930a8..6400b901d8b 100644 --- a/service/amplify/api_op_DeleteBackendEnvironment.go +++ b/service/amplify/api_op_DeleteBackendEnvironment.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a backend environment for an Amplify app. This API is available only to -// Amplify Gen 1 applications where the backend was created using Amplify Studio or -// the Amplify command line interface (CLI). This API isn’t available to -// applications created using the Amplify Gen 2 public preview. When you deploy an -// application with Amplify Gen 2, you provision the app's backend infrastructure -// using Typescript code. +// Deletes a backend environment for an Amplify app. +// +// This API is available only to Amplify Gen 1 applications where the backend was +// created using Amplify Studio or the Amplify command line interface (CLI). This +// API isn’t available to applications created using the Amplify Gen 2 public +// preview. When you deploy an application with Amplify Gen 2, you provision the +// app's backend infrastructure using Typescript code. func (c *Client) DeleteBackendEnvironment(ctx context.Context, params *DeleteBackendEnvironmentInput, optFns ...func(*Options)) (*DeleteBackendEnvironmentOutput, error) { if params == nil { params = &DeleteBackendEnvironmentInput{} diff --git a/service/amplify/api_op_DeleteBranch.go b/service/amplify/api_op_DeleteBranch.go index dc18a58f919..95ce4359dfc 100644 --- a/service/amplify/api_op_DeleteBranch.go +++ b/service/amplify/api_op_DeleteBranch.go @@ -30,7 +30,7 @@ func (c *Client) DeleteBranch(ctx context.Context, params *DeleteBranchInput, op // The request structure for the delete branch request. type DeleteBranchInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string diff --git a/service/amplify/api_op_DeleteDomainAssociation.go b/service/amplify/api_op_DeleteDomainAssociation.go index 5873b8d2e44..88e8831f169 100644 --- a/service/amplify/api_op_DeleteDomainAssociation.go +++ b/service/amplify/api_op_DeleteDomainAssociation.go @@ -30,12 +30,12 @@ func (c *Client) DeleteDomainAssociation(ctx context.Context, params *DeleteDoma // The request structure for the delete domain association request. type DeleteDomainAssociationInput struct { - // The unique id for an Amplify app. + // The unique id for an Amplify app. // // This member is required. AppId *string - // The name of the domain. + // The name of the domain. // // This member is required. DomainName *string diff --git a/service/amplify/api_op_DeleteJob.go b/service/amplify/api_op_DeleteJob.go index 135142ba3e5..ff0fcf545c4 100644 --- a/service/amplify/api_op_DeleteJob.go +++ b/service/amplify/api_op_DeleteJob.go @@ -30,7 +30,7 @@ func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns . // The request structure for the delete job request. type DeleteJobInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string @@ -40,7 +40,7 @@ type DeleteJobInput struct { // This member is required. BranchName *string - // The unique ID for the job. + // The unique ID for the job. // // This member is required. JobId *string @@ -51,7 +51,7 @@ type DeleteJobInput struct { // The result structure for the delete job request. type DeleteJobOutput struct { - // Describes the summary for an execution job for an Amplify app. + // Describes the summary for an execution job for an Amplify app. // // This member is required. JobSummary *types.JobSummary diff --git a/service/amplify/api_op_GenerateAccessLogs.go b/service/amplify/api_op_GenerateAccessLogs.go index 661c008ed94..ed65de2fbe2 100644 --- a/service/amplify/api_op_GenerateAccessLogs.go +++ b/service/amplify/api_op_GenerateAccessLogs.go @@ -11,7 +11,8 @@ import ( "time" ) -// Returns the website access logs for a specific time range using a presigned URL. +// Returns the website access logs for a specific time range using a presigned +// URL. func (c *Client) GenerateAccessLogs(ctx context.Context, params *GenerateAccessLogsInput, optFns ...func(*Options)) (*GenerateAccessLogsOutput, error) { if params == nil { params = &GenerateAccessLogsInput{} diff --git a/service/amplify/api_op_GetBackendEnvironment.go b/service/amplify/api_op_GetBackendEnvironment.go index 052a162e3dd..8464b3585e6 100644 --- a/service/amplify/api_op_GetBackendEnvironment.go +++ b/service/amplify/api_op_GetBackendEnvironment.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a backend environment for an Amplify app. This API is available only to -// Amplify Gen 1 applications where the backend was created using Amplify Studio or -// the Amplify command line interface (CLI). This API isn’t available to -// applications created using the Amplify Gen 2 public preview. When you deploy an -// application with Amplify Gen 2, you provision the app's backend infrastructure -// using Typescript code. +// Returns a backend environment for an Amplify app. +// +// This API is available only to Amplify Gen 1 applications where the backend was +// created using Amplify Studio or the Amplify command line interface (CLI). This +// API isn’t available to applications created using the Amplify Gen 2 public +// preview. When you deploy an application with Amplify Gen 2, you provision the +// app's backend infrastructure using Typescript code. func (c *Client) GetBackendEnvironment(ctx context.Context, params *GetBackendEnvironmentInput, optFns ...func(*Options)) (*GetBackendEnvironmentOutput, error) { if params == nil { params = &GetBackendEnvironmentInput{} diff --git a/service/amplify/api_op_GetBranch.go b/service/amplify/api_op_GetBranch.go index 6c479f42a17..f1327e6eb82 100644 --- a/service/amplify/api_op_GetBranch.go +++ b/service/amplify/api_op_GetBranch.go @@ -30,7 +30,7 @@ func (c *Client) GetBranch(ctx context.Context, params *GetBranchInput, optFns . // The request structure for the get branch request. type GetBranchInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string @@ -45,7 +45,7 @@ type GetBranchInput struct { type GetBranchOutput struct { - // The branch for an Amplify app, which maps to a third-party repository branch. + // The branch for an Amplify app, which maps to a third-party repository branch. // // This member is required. Branch *types.Branch diff --git a/service/amplify/api_op_GetDomainAssociation.go b/service/amplify/api_op_GetDomainAssociation.go index 96ecbbb2b47..75e836b66ec 100644 --- a/service/amplify/api_op_GetDomainAssociation.go +++ b/service/amplify/api_op_GetDomainAssociation.go @@ -30,12 +30,12 @@ func (c *Client) GetDomainAssociation(ctx context.Context, params *GetDomainAsso // The request structure for the get domain association request. type GetDomainAssociationInput struct { - // The unique id for an Amplify app. + // The unique id for an Amplify app. // // This member is required. AppId *string - // The name of the domain. + // The name of the domain. // // This member is required. DomainName *string @@ -46,7 +46,7 @@ type GetDomainAssociationInput struct { // The result structure for the get domain association request. type GetDomainAssociationOutput struct { - // Describes the structure of a domain association, which associates a custom + // Describes the structure of a domain association, which associates a custom // domain with an Amplify app. // // This member is required. diff --git a/service/amplify/api_op_GetJob.go b/service/amplify/api_op_GetJob.go index 5e719fc0821..e474bb88647 100644 --- a/service/amplify/api_op_GetJob.go +++ b/service/amplify/api_op_GetJob.go @@ -50,7 +50,7 @@ type GetJobInput struct { type GetJobOutput struct { - // Describes an execution job for an Amplify app. + // Describes an execution job for an Amplify app. // // This member is required. Job *types.Job diff --git a/service/amplify/api_op_ListBackendEnvironments.go b/service/amplify/api_op_ListBackendEnvironments.go index 127f4b04ea2..b2120a6fb8b 100644 --- a/service/amplify/api_op_ListBackendEnvironments.go +++ b/service/amplify/api_op_ListBackendEnvironments.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the backend environments for an Amplify app. This API is available only -// to Amplify Gen 1 applications where the backend was created using Amplify Studio -// or the Amplify command line interface (CLI). This API isn’t available to -// applications created using the Amplify Gen 2 public preview. When you deploy an -// application with Amplify Gen 2, you provision the app's backend infrastructure -// using Typescript code. +// Lists the backend environments for an Amplify app. +// +// This API is available only to Amplify Gen 1 applications where the backend was +// created using Amplify Studio or the Amplify command line interface (CLI). This +// API isn’t available to applications created using the Amplify Gen 2 public +// preview. When you deploy an application with Amplify Gen 2, you provision the +// app's backend infrastructure using Typescript code. func (c *Client) ListBackendEnvironments(ctx context.Context, params *ListBackendEnvironmentsInput, optFns ...func(*Options)) (*ListBackendEnvironmentsOutput, error) { if params == nil { params = &ListBackendEnvironmentsInput{} diff --git a/service/amplify/api_op_ListBranches.go b/service/amplify/api_op_ListBranches.go index ff1a339430f..37b4c81c140 100644 --- a/service/amplify/api_op_ListBranches.go +++ b/service/amplify/api_op_ListBranches.go @@ -35,7 +35,7 @@ type ListBranchesInput struct { // This member is required. AppId *string - // The maximum number of records to list in a single response. + // The maximum number of records to list in a single response. MaxResults int32 // A pagination token. Set to null to start listing branches from the start. If a @@ -49,12 +49,12 @@ type ListBranchesInput struct { // The result structure for the list branches request. type ListBranchesOutput struct { - // A list of branches for an Amplify app. + // A list of branches for an Amplify app. // // This member is required. Branches []types.Branch - // A pagination token. If a non-null pagination token is returned in a result, + // 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 @@ -152,7 +152,7 @@ var _ ListBranchesAPIClient = (*Client)(nil) // ListBranchesPaginatorOptions is the paginator options for ListBranches type ListBranchesPaginatorOptions struct { - // The maximum number of records to list in a single response. + // The maximum number of records to list in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/amplify/api_op_ListDomainAssociations.go b/service/amplify/api_op_ListDomainAssociations.go index b237fd1b44f..8034f75de40 100644 --- a/service/amplify/api_op_ListDomainAssociations.go +++ b/service/amplify/api_op_ListDomainAssociations.go @@ -30,15 +30,15 @@ func (c *Client) ListDomainAssociations(ctx context.Context, params *ListDomainA // The request structure for the list domain associations request. type ListDomainAssociationsInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string - // The maximum number of records to list in a single response. + // The maximum number of records to list in a single response. MaxResults int32 - // A pagination token. Set to null to start listing apps from the start. If + // A pagination token. Set to null to start listing apps from the start. If // non-null, a pagination token is returned in a result. Pass its value in here to // list more projects. NextToken *string @@ -49,12 +49,12 @@ type ListDomainAssociationsInput struct { // The result structure for the list domain association request. type ListDomainAssociationsOutput struct { - // A list of domain associations. + // A list of domain associations. // // This member is required. DomainAssociations []types.DomainAssociation - // A pagination token. If non-null, a pagination token is returned in a result. + // A pagination token. If non-null, a pagination token is returned in a result. // Pass its value in another request to retrieve more entries. NextToken *string @@ -154,7 +154,7 @@ var _ ListDomainAssociationsAPIClient = (*Client)(nil) // ListDomainAssociationsPaginatorOptions is the paginator options for // ListDomainAssociations type ListDomainAssociationsPaginatorOptions struct { - // The maximum number of records to list in a single response. + // The maximum number of records to list in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/amplify/api_op_ListJobs.go b/service/amplify/api_op_ListJobs.go index 15f7d8d0167..5d6d0f6abf1 100644 --- a/service/amplify/api_op_ListJobs.go +++ b/service/amplify/api_op_ListJobs.go @@ -30,7 +30,7 @@ func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ... // The request structure for the list jobs request. type ListJobsInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string diff --git a/service/amplify/api_op_StartDeployment.go b/service/amplify/api_op_StartDeployment.go index 90b679aa1b1..2e6916dc783 100644 --- a/service/amplify/api_op_StartDeployment.go +++ b/service/amplify/api_op_StartDeployment.go @@ -12,9 +12,11 @@ import ( ) // Starts a deployment for a manually deployed app. Manually deployed apps are not -// connected to a repository. The maximum duration between the CreateDeployment -// call and the StartDeployment call cannot exceed 8 hours. If the duration -// exceeds 8 hours, the StartDeployment call and the associated Job will fail. +// connected to a repository. +// +// The maximum duration between the CreateDeployment call and the StartDeployment +// call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment +// call and the associated Job will fail. func (c *Client) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error) { if params == nil { params = &StartDeploymentInput{} diff --git a/service/amplify/api_op_StartJob.go b/service/amplify/api_op_StartJob.go index 66c154e35c6..76a0bfe0b0c 100644 --- a/service/amplify/api_op_StartJob.go +++ b/service/amplify/api_op_StartJob.go @@ -43,19 +43,21 @@ 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. + // 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. // // This member is required. JobType types.JobType - // The commit ID from a third-party repository provider for the job. + // The commit ID from a third-party repository provider for the job. CommitId *string - // The commit message from a third-party repository provider for the job. + // The commit message from a third-party repository provider for the job. CommitMessage *string - // The commit date and time for the job. + // The commit date and time for the job. CommitTime *time.Time // The unique ID for an existing job. This is required if the value of jobType is @@ -71,7 +73,7 @@ type StartJobInput struct { // The result structure for the run job request. type StartJobOutput struct { - // The summary for the job. + // The summary for the job. // // This member is required. JobSummary *types.JobSummary diff --git a/service/amplify/api_op_StopJob.go b/service/amplify/api_op_StopJob.go index 5547489bef6..a95713d8eaa 100644 --- a/service/amplify/api_op_StopJob.go +++ b/service/amplify/api_op_StopJob.go @@ -30,7 +30,7 @@ func (c *Client) StopJob(ctx context.Context, params *StopJobInput, optFns ...fu // The request structure for the stop job request. type StopJobInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string @@ -40,7 +40,7 @@ type StopJobInput struct { // This member is required. BranchName *string - // The unique id for the job. + // The unique id for the job. // // This member is required. JobId *string @@ -51,7 +51,7 @@ type StopJobInput struct { // The result structure for the stop job request. type StopJobOutput struct { - // The summary for the job. + // The summary for the job. // // This member is required. JobSummary *types.JobSummary diff --git a/service/amplify/api_op_TagResource.go b/service/amplify/api_op_TagResource.go index 82025064a45..dea07cc9b2f 100644 --- a/service/amplify/api_op_TagResource.go +++ b/service/amplify/api_op_TagResource.go @@ -29,7 +29,7 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF // The request structure to tag a resource with a tag key and value. type TagResourceInput struct { - // The Amazon Resource Name (ARN) to use to tag a resource. + // The Amazon Resource Name (ARN) to use to tag a resource. // // This member is required. ResourceArn *string diff --git a/service/amplify/api_op_UpdateApp.go b/service/amplify/api_op_UpdateApp.go index 830544e89c9..187f11673dc 100644 --- a/service/amplify/api_op_UpdateApp.go +++ b/service/amplify/api_op_UpdateApp.go @@ -37,14 +37,18 @@ type UpdateAppInput struct { // The personal access token for a GitHub repository for an Amplify app. The // 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 - // 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 . + // 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 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]in the Amplify User Guide . + // + // [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 AccessToken *string // The automated branch creation configuration for an Amplify app. @@ -93,15 +97,20 @@ type UpdateAppInput struct { // The OAuth token for a third-party source control system for an Amplify app. The // 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) - // in the Amplify User Guide . + // 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]in the Amplify User Guide . + // + // [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 OauthToken *string // The platform for the Amplify app. For a static app, set the platform type to WEB diff --git a/service/amplify/api_op_UpdateBranch.go b/service/amplify/api_op_UpdateBranch.go index ae598c005a2..3b27ffca1f1 100644 --- a/service/amplify/api_op_UpdateBranch.go +++ b/service/amplify/api_op_UpdateBranch.go @@ -30,7 +30,7 @@ func (c *Client) UpdateBranch(ctx context.Context, params *UpdateBranchInput, op // The request structure for the update branch request. type UpdateBranchInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string @@ -48,50 +48,51 @@ type UpdateBranchInput struct { // Amplify app. BackendEnvironmentArn *string - // The basic authorization credentials for the branch. You must base64-encode the + // The basic authorization credentials for the branch. You must base64-encode the // authorization credentials and provide them in the format user:password . BasicAuthCredentials *string - // The build specification (build spec) for the branch. + // The build specification (build spec) for the branch. BuildSpec *string - // The description for the branch. + // The description for the branch. Description *string - // The display name for a branch. This is used as the default domain prefix. + // The display name for a branch. This is used as the default domain prefix. DisplayName *string - // Enables auto building for the branch. + // Enables auto building for the branch. EnableAutoBuild *bool - // Enables basic authorization for the branch. + // Enables basic authorization for the branch. EnableBasicAuth *bool - // Enables notifications for the branch. + // Enables notifications for the branch. EnableNotification *bool - // Enables performance mode for the branch. Performance mode optimizes for faster - // hosting performance by keeping content cached at the edge for a longer interval. - // When performance mode is enabled, hosting configuration or code changes can take - // up to 10 minutes to roll out. + // Enables performance mode for the branch. + // + // Performance mode optimizes for faster hosting performance by keeping content + // cached at the edge for a longer interval. When performance mode is enabled, + // hosting configuration or code changes can take up to 10 minutes to roll out. EnablePerformanceMode *bool - // Enables pull request previews for this branch. + // Enables pull request previews for this branch. EnablePullRequestPreview *bool - // The environment variables for the branch. + // The environment variables for the branch. EnvironmentVariables map[string]string - // The framework for the branch. + // The framework for the branch. Framework *string - // The Amplify environment name for the pull request. + // The Amplify environment name for the pull request. PullRequestEnvironmentName *string - // Describes the current stage for the branch. + // Describes the current stage for the branch. Stage types.Stage - // The content Time to Live (TTL) for the website in seconds. + // The content Time to Live (TTL) for the website in seconds. Ttl *string noSmithyDocumentSerde @@ -100,7 +101,7 @@ type UpdateBranchInput struct { // The result structure for the update branch request. type UpdateBranchOutput struct { - // The branch for an Amplify app, which maps to a third-party repository branch. + // The branch for an Amplify app, which maps to a third-party repository branch. // // This member is required. Branch *types.Branch diff --git a/service/amplify/api_op_UpdateDomainAssociation.go b/service/amplify/api_op_UpdateDomainAssociation.go index 697af2817b7..411f9343921 100644 --- a/service/amplify/api_op_UpdateDomainAssociation.go +++ b/service/amplify/api_op_UpdateDomainAssociation.go @@ -30,30 +30,30 @@ func (c *Client) UpdateDomainAssociation(ctx context.Context, params *UpdateDoma // The request structure for the update domain association request. type UpdateDomainAssociationInput struct { - // The unique ID for an Amplify app. + // The unique ID for an Amplify app. // // This member is required. AppId *string - // The name of the domain. + // The name of the domain. // // This member is required. DomainName *string - // Sets the branch patterns for automatic subdomain creation. + // Sets the branch patterns for automatic subdomain creation. AutoSubDomainCreationPatterns []string - // The required AWS Identity and Access Management (IAM) service role for the + // The required AWS Identity and Access Management (IAM) service role for the // Amazon Resource Name (ARN) for automatically creating subdomains. AutoSubDomainIAMRole *string // The type of SSL/TLS certificate to use for your custom domain. CertificateSettings *types.CertificateSettings - // Enables the automated creation of subdomains for branches. + // Enables the automated creation of subdomains for branches. EnableAutoSubDomain *bool - // Describes the settings for the subdomain. + // Describes the settings for the subdomain. SubDomainSettings []types.SubDomainSetting noSmithyDocumentSerde @@ -62,7 +62,7 @@ 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 + // Describes a domain association, which associates a custom domain with an // Amplify app. // // This member is required. diff --git a/service/amplify/doc.go b/service/amplify/doc.go index a6f00c96282..a1b8ab7f6e0 100644 --- a/service/amplify/doc.go +++ b/service/amplify/doc.go @@ -5,8 +5,10 @@ // // Amplify enables developers to develop and deploy cloud-powered mobile and web // apps. Amplify Hosting provides a continuous delivery and hosting service for web -// applications. For more information, see the Amplify Hosting 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/) +// applications. For more information, see the [Amplify Hosting User Guide]. The Amplify Framework is a +// comprehensive set of SDKs, libraries, tools, and documentation for client app +// development. For more information, see the [Amplify Framework.] +// +// [Amplify Hosting User Guide]: https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html +// [Amplify Framework.]: https://docs.amplify.aws/ package amplify diff --git a/service/amplify/options.go b/service/amplify/options.go index 3a64da839b1..03c80576f98 100644 --- a/service/amplify/options.go +++ b/service/amplify/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/amplify/types/enums.go b/service/amplify/types/enums.go index a108ab4ef52..e23bc5606a1 100644 --- a/service/amplify/types/enums.go +++ b/service/amplify/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for CertificateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateType) Values() []CertificateType { return []CertificateType{ "AMPLIFY_MANAGED", @@ -37,8 +38,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -68,8 +70,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -93,8 +96,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "RELEASE", @@ -114,8 +118,9 @@ const ( ) // Values returns all known values for Platform. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Platform) Values() []Platform { return []Platform{ "WEB", @@ -134,8 +139,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SSH", @@ -156,8 +162,9 @@ const ( ) // 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. +// the future, and so 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{ "PRODUCTION", @@ -182,8 +189,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "REQUESTING_CERTIFICATE", diff --git a/service/amplify/types/types.go b/service/amplify/types/types.go index 763bf2d40dc..3d072d8b6c3 100644 --- a/service/amplify/types/types.go +++ b/service/amplify/types/types.go @@ -46,10 +46,12 @@ type App struct { // This member is required. EnableBranchAutoBuild *bool - // The environment variables for the Amplify app. For a list of the environment - // variables that are accessible to Amplify by default, see Amplify Environment - // variables (https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) - // in the Amplify Hosting User Guide. + // The environment variables for the Amplify app. + // + // For a list of the environment variables that are accessible to Amplify by + // default, see [Amplify Environment variables]in the Amplify Hosting User Guide. + // + // [Amplify Environment variables]: https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html // // This member is required. EnvironmentVariables map[string]string @@ -112,10 +114,12 @@ 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 - // Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories. + // 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 // The tag for the Amplify app. @@ -157,10 +161,11 @@ type AutoBranchCreationConfig struct { // Enables basic authorization for the autocreated branch. EnableBasicAuth *bool - // Enables performance mode for the branch. Performance mode optimizes for faster - // hosting performance by keeping content cached at the edge for a longer interval. - // When performance mode is enabled, hosting configuration or code changes can take - // up to 10 minutes to roll out. + // Enables performance mode for the branch. + // + // Performance mode optimizes for faster hosting performance by keeping content + // cached at the edge for a longer interval. When performance mode is enabled, + // hosting configuration or code changes can take up to 10 minutes to roll out. EnablePerformanceMode *bool // Enables pull request previews for the autocreated branch. @@ -228,128 +233,129 @@ type BackendEnvironment struct { // The branch for an Amplify app, which maps to a third-party repository branch. type Branch struct { - // The ID of the active job for a branch of an Amplify app. + // The ID of the active job for a branch of an Amplify app. // // This member is required. ActiveJobId *string - // The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. + // The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. // // This member is required. BranchArn *string - // The name for the branch that is part of an Amplify app. + // The name for the branch that is part of an Amplify app. // // This member is required. BranchName *string - // The creation date and time for a branch that is part of an Amplify app. + // The creation date and time for a branch that is part of an Amplify app. // // This member is required. CreateTime *time.Time - // The custom domains for a branch of an Amplify app. + // The custom domains for a branch of an Amplify app. // // This member is required. CustomDomains []string - // The description for the branch that is part of an Amplify app. + // The description for the branch that is part of an Amplify app. // // This member is required. Description *string - // The display name for the branch. This is used as the default domain prefix. + // The display name for the branch. This is used as the default domain prefix. // // This member is required. DisplayName *string - // Enables auto-building on push for a branch of an Amplify app. + // Enables auto-building on push for a branch of an Amplify app. // // This member is required. EnableAutoBuild *bool - // Enables basic authorization for a branch of an Amplify app. + // Enables basic authorization for a branch of an Amplify app. // // This member is required. EnableBasicAuth *bool - // Enables notifications for a branch that is part of an Amplify app. + // Enables notifications for a branch that is part of an Amplify app. // // This member is required. EnableNotification *bool - // Enables pull request previews for the branch. + // Enables pull request previews for the branch. // // This member is required. EnablePullRequestPreview *bool - // The environment variables specific to a branch of an Amplify app. + // The environment variables specific to a branch of an Amplify app. // // This member is required. EnvironmentVariables map[string]string - // The framework for a branch of an Amplify app. + // The framework for a branch of an Amplify app. // // This member is required. Framework *string - // The current stage for the branch that is part of an Amplify app. + // The current stage for the branch that is part of an Amplify app. // // This member is required. Stage Stage - // The total number of jobs that are part of an Amplify app. + // The total number of jobs that are part of an Amplify app. // // This member is required. TotalNumberOfJobs *string - // The content Time to Live (TTL) for the website in seconds. + // The content Time to Live (TTL) for the website in seconds. // // This member is required. Ttl *string - // The last updated date and time for a branch that is part of an Amplify app. + // The last updated date and time for a branch that is part of an Amplify app. // // This member is required. UpdateTime *time.Time - // A list of custom resources that are linked to this branch. + // A list of custom resources that are linked to this branch. AssociatedResources []string // Describes the backend properties associated with an Amplify Branch . Backend *Backend - // The Amazon Resource Name (ARN) for a backend environment that is part of an + // The Amazon Resource Name (ARN) for a backend environment that is part of an // Amplify app. BackendEnvironmentArn *string - // The basic authorization credentials for a branch of an Amplify app. You must + // 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 . BasicAuthCredentials *string - // The build specification (build spec) content for the branch of an Amplify app. + // The build specification (build spec) content for the branch of an Amplify app. BuildSpec *string - // The destination branch if the branch is a pull request branch. + // The destination branch if the branch is a pull request branch. DestinationBranch *string - // Enables performance mode for the branch. Performance mode optimizes for faster - // hosting performance by keeping content cached at the edge for a longer interval. - // When performance mode is enabled, hosting configuration or code changes can take - // up to 10 minutes to roll out. + // Enables performance mode for the branch. + // + // Performance mode optimizes for faster hosting performance by keeping content + // cached at the edge for a longer interval. When performance mode is enabled, + // hosting configuration or code changes can take up to 10 minutes to roll out. EnablePerformanceMode *bool - // The Amplify environment name for the pull request. + // The Amplify environment name for the pull request. PullRequestEnvironmentName *string - // The source branch if the branch is a pull request branch. + // The source branch if the branch is a pull request branch. SourceBranch *string - // The tag for the branch of an Amplify app. + // The tag for the branch of an Amplify app. Tags map[string]string - // The thumbnail URL for the branch of an Amplify app. + // The thumbnail URL for the branch of an Amplify app. ThumbnailUrl *string noSmithyDocumentSerde @@ -360,13 +366,17 @@ type Branch struct { // Certificate describes the new certificate that you are creating. type Certificate struct { - // The type of SSL/TLS certificate that you want to use. Specify AMPLIFY_MANAGED - // to use the default certificate that Amplify provisions for you. Specify CUSTOM - // to use your own certificate that you have already added to Certificate Manager - // in your Amazon Web Services account. Make sure you request (or import) the - // certificate in the US East (N. Virginia) Region (us-east-1). For more - // information about using ACM, see Importing certificates into Certificate Manager (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) - // in the ACM User guide . + // The type of SSL/TLS certificate that you want to use. + // + // Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions + // for you. + // + // Specify CUSTOM to use your own certificate that you have already added to + // Certificate Manager in your Amazon Web Services account. Make sure you request + // (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For + // more information about using ACM, see [Importing certificates into Certificate Manager]in the ACM User guide . + // + // [Importing certificates into Certificate Manager]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html // // This member is required. Type CertificateType @@ -375,8 +385,9 @@ type Certificate struct { CertificateVerificationDNSRecord *string // The Amazon resource name (ARN) for a custom certificate that you have already - // added to Certificate Manager in your Amazon Web Services account. This field is - // required only when the certificate type is CUSTOM . + // added to Certificate Manager in your Amazon Web Services account. + // + // This field is required only when the certificate type is CUSTOM . CustomCertificateArn *string noSmithyDocumentSerde @@ -386,20 +397,25 @@ type Certificate struct { // type isn't specified, Amplify uses the default AMPLIFY_MANAGED certificate. type CertificateSettings struct { - // The certificate type. Specify AMPLIFY_MANAGED to use the default certificate - // that Amplify provisions for you. Specify CUSTOM to use your own certificate - // that you have already added to Certificate Manager in your Amazon Web Services - // account. Make sure you request (or import) the certificate in the US East (N. - // Virginia) Region (us-east-1). For more information about using ACM, see - // Importing certificates into Certificate Manager (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) - // in the ACM User guide. + // The certificate type. + // + // Specify AMPLIFY_MANAGED to use the default certificate that Amplify provisions + // for you. + // + // Specify CUSTOM to use your own certificate that you have already added to + // Certificate Manager in your Amazon Web Services account. Make sure you request + // (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For + // more information about using ACM, see [Importing certificates into Certificate Manager]in the ACM User guide. + // + // [Importing certificates into Certificate Manager]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html // // This member is required. Type CertificateType // The Amazon resource name (ARN) for the custom certificate that you have already - // added to Certificate Manager in your Amazon Web Services account. This field is - // required only when the certificate type is CUSTOM . + // added to Certificate Manager in your Amazon Web Services account. + // + // This field is required only when the certificate type is CUSTOM . CustomCertificateArn *string noSmithyDocumentSerde @@ -421,11 +437,18 @@ 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 permanently) 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 permanently) 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 @@ -434,72 +457,84 @@ type CustomRule struct { // Describes the association between a custom domain and an Amplify app. type DomainAssociation struct { - // The Amazon Resource Name (ARN) for the domain association. + // The Amazon Resource Name (ARN) for the domain association. // // This member is required. DomainAssociationArn *string - // The name of the domain. + // The name of the domain. // // This member is required. DomainName *string - // The current status of the domain association. + // The current status of the domain association. // // This member is required. DomainStatus DomainStatus - // Enables the automated creation of subdomains for branches. + // Enables the automated creation of subdomains for branches. // // This member is required. EnableAutoSubDomain *bool - // Additional information that describes why the domain association is in the + // Additional information that describes why the domain association is in the // current state. // // This member is required. StatusReason *string - // The subdomains for the domain association. + // The subdomains for the domain association. // // This member is required. SubDomains []SubDomain - // Sets branch patterns for automatic subdomain creation. + // Sets branch patterns for automatic subdomain creation. AutoSubDomainCreationPatterns []string - // The required AWS Identity and Access Management (IAM) service role for the + // The required AWS Identity and Access Management (IAM) service role for the // Amazon Resource Name (ARN) for automatically creating subdomains. AutoSubDomainIAMRole *string // Describes the SSL/TLS certificate for the domain association. This can be your // own custom certificate or the default certificate that Amplify provisions for - // you. If you are updating your domain to use a different certificate, certificate + // you. + // + // If you are updating your domain to use a different certificate, certificate // points to the new certificate that is being created instead of the current // active certificate. Otherwise, certificate points to the current active // certificate. Certificate *Certificate - // The DNS record for certificate verification. + // The DNS record for certificate verification. CertificateVerificationDNSRecord *string // The status of the domain update operation that is currently in progress. The - // following list describes the valid update states. REQUESTING_CERTIFICATE The - // certificate is in the process of being updated. PENDING_VERIFICATION Indicates - // that an Amplify managed certificate is in the process of being verified. This - // occurs during the creation of a custom domain or when a custom domain is updated - // to use a managed certificate. IMPORTING_CUSTOM_CERTIFICATE Indicates that an - // Amplify custom certificate is in the process of being imported. This occurs - // during the creation of a custom domain or when a custom domain is updated to use - // a custom certificate. PENDING_DEPLOYMENT Indicates that the subdomain or - // certificate changes are being propagated. AWAITING_APP_CNAME Amplify is waiting - // for CNAME records corresponding to subdomains to be propagated. If your custom - // domain is on Route 53, Amplify handles this for you automatically. For more - // information about custom domains, see Setting up custom domains (https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) - // in the Amplify Hosting User Guide. UPDATE_COMPLETE The certificate has been - // associated with a domain. UPDATE_FAILED The certificate has failed to be - // provisioned or associated, and there is no existing active certificate to roll - // back to. + // following list describes the valid update states. + // + // REQUESTING_CERTIFICATE The certificate is in the process of being updated. + // + // PENDING_VERIFICATION Indicates that an Amplify managed certificate is in the + // process of being verified. This occurs during the creation of a custom domain or + // when a custom domain is updated to use a managed certificate. + // + // IMPORTING_CUSTOM_CERTIFICATE Indicates that an Amplify custom certificate is in + // the process of being imported. This occurs during the creation of a custom + // domain or when a custom domain is updated to use a custom certificate. + // + // PENDING_DEPLOYMENT Indicates that the subdomain or certificate changes are + // being propagated. + // + // AWAITING_APP_CNAME Amplify is waiting for CNAME records corresponding to + // subdomains to be propagated. If your custom domain is on Route 53, Amplify + // handles this for you automatically. For more information about custom domains, + // see [Setting up custom domains]in the Amplify Hosting User Guide. + // + // UPDATE_COMPLETE The certificate has been associated with a domain. + // + // UPDATE_FAILED The certificate has failed to be provisioned or associated, and + // there is no existing active certificate to roll back to. + // + // [Setting up custom domains]: https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html UpdateStatus UpdateStatus noSmithyDocumentSerde @@ -508,12 +543,12 @@ type DomainAssociation struct { // Describes an execution job for an Amplify app. type Job struct { - // The execution steps for an execution job, for an Amplify app. + // The execution steps for an execution job, for an Amplify app. // // This member is required. Steps []Step - // Describes the summary for an execution job for an Amplify app. + // Describes the summary for an execution job for an Amplify app. // // This member is required. Summary *JobSummary @@ -524,32 +559,32 @@ type Job struct { // Describes the summary for an execution job for an Amplify app. type JobSummary struct { - // The commit ID from a third-party repository provider for the job. + // The commit ID from a third-party repository provider for the job. // // This member is required. CommitId *string - // The commit message from a third-party repository provider for the job. + // The commit message from a third-party repository provider for the job. // // This member is required. CommitMessage *string - // The commit date and time for the job. + // The commit date and time for the job. // // This member is required. CommitTime *time.Time - // The Amazon Resource Name (ARN) for the job. + // The Amazon Resource Name (ARN) for the job. // // This member is required. JobArn *string - // The unique ID for the job. + // The unique ID for the job. // // This member is required. JobId *string - // The type for the job. If the value is RELEASE , the job was manually released + // 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. @@ -557,17 +592,17 @@ type JobSummary struct { // This member is required. JobType JobType - // The start date and time for the job. + // The start date and time for the job. // // This member is required. StartTime *time.Time - // The current status for the job. + // The current status for the job. // // This member is required. Status JobStatus - // The end date and time for the job. + // The end date and time for the job. EndTime *time.Time noSmithyDocumentSerde @@ -594,45 +629,45 @@ type ProductionBranch struct { // Describes an execution step, for an execution job, for an Amplify app. type Step struct { - // The end date and time of the execution step. + // The end date and time of the execution step. // // This member is required. EndTime *time.Time - // The start date and time of the execution step. + // The start date and time of the execution step. // // This member is required. StartTime *time.Time - // The status of the execution step. + // The status of the execution step. // // This member is required. Status JobStatus - // The name of the execution step. + // The name of the execution step. // // This member is required. StepName *string - // The URL to the artifact for the execution step. + // The URL to the artifact for the execution step. ArtifactsUrl *string - // The context for the current step. Includes a build image if the step is build. + // The context for the current step. Includes a build image if the step is build. Context *string - // The URL to the logs for the execution step. + // The URL to the logs for the execution step. LogUrl *string - // The list of screenshot URLs for the execution step, if relevant. + // The list of screenshot URLs for the execution step, if relevant. Screenshots map[string]string - // The reason for the current step status. + // The reason for the current step status. StatusReason *string - // The URL to the test artifact for the execution step. + // The URL to the test artifact for the execution step. TestArtifactsUrl *string - // The URL to the test configuration for the execution step. + // The URL to the test configuration for the execution step. TestConfigUrl *string noSmithyDocumentSerde @@ -641,17 +676,17 @@ type Step struct { // The subdomain for the domain association. type SubDomain struct { - // The DNS record for the subdomain. + // The DNS record for the subdomain. // // This member is required. DnsRecord *string - // Describes the settings for the subdomain. + // Describes the settings for the subdomain. // // This member is required. SubDomainSetting *SubDomainSetting - // The verified status of the subdomain + // The verified status of the subdomain // // This member is required. Verified *bool @@ -662,12 +697,12 @@ type SubDomain struct { // Describes the settings for the subdomain. type SubDomainSetting struct { - // The branch name setting for the subdomain. + // The branch name setting for the subdomain. // // This member is required. BranchName *string - // The prefix setting for the subdomain. + // The prefix setting for the subdomain. // // This member is required. Prefix *string diff --git a/service/amplifybackend/options.go b/service/amplifybackend/options.go index 0dac28bfee7..7d9c38210ae 100644 --- a/service/amplifybackend/options.go +++ b/service/amplifybackend/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/amplifybackend/types/enums.go b/service/amplifybackend/types/enums.go index e1c606e2966..6e54c2c7cdd 100644 --- a/service/amplifybackend/types/enums.go +++ b/service/amplifybackend/types/enums.go @@ -14,8 +14,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalConstraintsElement) Values() []AdditionalConstraintsElement { return []AdditionalConstraintsElement{ "REQUIRE_DIGIT", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AuthenticatedElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticatedElement) Values() []AuthenticatedElement { return []AuthenticatedElement{ "READ", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for AuthResources. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthResources) Values() []AuthResources { return []AuthResources{ "USER_POOL_ONLY", @@ -72,8 +75,9 @@ const ( ) // Values returns all known values for DeliveryMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryMethod) Values() []DeliveryMethod { return []DeliveryMethod{ "EMAIL", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for MFAMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MFAMode) Values() []MFAMode { return []MFAMode{ "ON", @@ -110,8 +115,9 @@ const ( ) // Values returns all known values for MfaTypesElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MfaTypesElement) Values() []MfaTypesElement { return []MfaTypesElement{ "SMS", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for Mode. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mode) Values() []Mode { return []Mode{ "API_KEY", @@ -150,8 +157,9 @@ const ( ) // Values returns all known values for OAuthGrantType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OAuthGrantType) Values() []OAuthGrantType { return []OAuthGrantType{ "CODE", @@ -171,8 +179,9 @@ const ( ) // Values returns all known values for OAuthScopesElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OAuthScopesElement) Values() []OAuthScopesElement { return []OAuthScopesElement{ "PHONE", @@ -208,8 +217,9 @@ const ( // Values returns all known values for RequiredSignUpAttributesElement. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequiredSignUpAttributesElement) Values() []RequiredSignUpAttributesElement { return []RequiredSignUpAttributesElement{ "ADDRESS", @@ -243,8 +253,9 @@ const ( ) // Values returns all known values for ResolutionStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolutionStrategy) Values() []ResolutionStrategy { return []ResolutionStrategy{ "OPTIMISTIC_CONCURRENCY", @@ -262,8 +273,9 @@ const ( ) // Values returns all known values for Service. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Service) Values() []Service { return []Service{ "COGNITO", @@ -278,8 +290,9 @@ const ( ) // Values returns all known values for ServiceName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceName) Values() []ServiceName { return []ServiceName{ "S3", @@ -297,8 +310,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -317,8 +331,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "LATEST", @@ -336,8 +351,9 @@ const ( ) // Values returns all known values for UnAuthenticatedElement. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnAuthenticatedElement) Values() []UnAuthenticatedElement { return []UnAuthenticatedElement{ "READ", diff --git a/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go b/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go index c98517f8db3..90d95aadf96 100644 --- a/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go +++ b/service/amplifyuibuilder/api_op_ExchangeCodeForToken.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is for internal use. Amplify uses this action to exchange an access code -// for a token. +// This is for internal use. +// +// Amplify uses this action to exchange an access code for a token. func (c *Client) ExchangeCodeForToken(ctx context.Context, params *ExchangeCodeForTokenInput, optFns ...func(*Options)) (*ExchangeCodeForTokenOutput, error) { if params == nil { params = &ExchangeCodeForTokenInput{} diff --git a/service/amplifyuibuilder/api_op_RefreshToken.go b/service/amplifyuibuilder/api_op_RefreshToken.go index 3c00bcfa0f2..30811a55dab 100644 --- a/service/amplifyuibuilder/api_op_RefreshToken.go +++ b/service/amplifyuibuilder/api_op_RefreshToken.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is for internal use. Amplify uses this action to refresh a previously -// issued access token that might have expired. +// This is for internal use. +// +// Amplify uses this action to refresh a previously issued access token that might +// have expired. func (c *Client) RefreshToken(ctx context.Context, params *RefreshTokenInput, optFns ...func(*Options)) (*RefreshTokenOutput, error) { if params == nil { params = &RefreshTokenInput{} diff --git a/service/amplifyuibuilder/doc.go b/service/amplifyuibuilder/doc.go index 2e6a010087d..2a4a74e2a87 100644 --- a/service/amplifyuibuilder/doc.go +++ b/service/amplifyuibuilder/doc.go @@ -6,13 +6,17 @@ // The Amplify UI Builder API provides a programmatic interface for creating and // configuring user interface (UI) component libraries and themes for use in your // 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) -// . +// 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]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]. For +// more information about deploying an Amplify application to Amazon Web Services, +// see the [Amplify User Guide]. +// +// [Amplify User Guide]: https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html +// [Introduction]: https://docs.amplify.aws/console/adminui/intro +// [Amplify Framework]: https://docs.amplify.aws/ package amplifyuibuilder diff --git a/service/amplifyuibuilder/options.go b/service/amplifyuibuilder/options.go index bdbd6f5f287..655186bf0b2 100644 --- a/service/amplifyuibuilder/options.go +++ b/service/amplifyuibuilder/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/amplifyuibuilder/types/enums.go b/service/amplifyuibuilder/types/enums.go index 1b1f2ed6ef8..b2f25a5913b 100644 --- a/service/amplifyuibuilder/types/enums.go +++ b/service/amplifyuibuilder/types/enums.go @@ -27,8 +27,9 @@ const ( // Values returns all known values for CodegenGenericDataFieldDataType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodegenGenericDataFieldDataType) Values() []CodegenGenericDataFieldDataType { return []CodegenGenericDataFieldDataType{ "ID", @@ -60,8 +61,9 @@ const ( // Values returns all known values for CodegenJobGenericDataSourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodegenJobGenericDataSourceType) Values() []CodegenJobGenericDataSourceType { return []CodegenJobGenericDataSourceType{ "DataStore", @@ -78,8 +80,9 @@ const ( ) // Values returns all known values for CodegenJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodegenJobStatus) Values() []CodegenJobStatus { return []CodegenJobStatus{ "in_progress", @@ -96,8 +99,9 @@ const ( ) // Values returns all known values for FixedPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FixedPosition) Values() []FixedPosition { return []FixedPosition{ "first", @@ -113,8 +117,9 @@ const ( ) // Values returns all known values for FormActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormActionType) Values() []FormActionType { return []FormActionType{ "create", @@ -132,8 +137,9 @@ const ( ) // Values returns all known values for FormButtonsPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormButtonsPosition) Values() []FormButtonsPosition { return []FormButtonsPosition{ "top", @@ -153,8 +159,9 @@ const ( ) // Values returns all known values for FormDataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormDataSourceType) Values() []FormDataSourceType { return []FormDataSourceType{ "DataStore", @@ -173,6 +180,7 @@ const ( // Values returns all known values for GenericDataRelationshipType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GenericDataRelationshipType) Values() []GenericDataRelationshipType { return []GenericDataRelationshipType{ @@ -191,8 +199,9 @@ const ( ) // Values returns all known values for JSModule. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JSModule) Values() []JSModule { return []JSModule{ "es2020", @@ -210,8 +219,9 @@ const ( ) // Values returns all known values for JSScript. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JSScript) Values() []JSScript { return []JSScript{ "jsx", @@ -229,8 +239,9 @@ const ( ) // Values returns all known values for JSTarget. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JSTarget) Values() []JSTarget { return []JSTarget{ "es2015", @@ -248,8 +259,9 @@ const ( ) // Values returns all known values for LabelDecorator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LabelDecorator) Values() []LabelDecorator { return []LabelDecorator{ "required", @@ -267,8 +279,9 @@ const ( ) // Values returns all known values for SortDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortDirection) Values() []SortDirection { return []SortDirection{ "ASC", @@ -286,8 +299,9 @@ const ( ) // Values returns all known values for StorageAccessLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageAccessLevel) Values() []StorageAccessLevel { return []StorageAccessLevel{ "public", @@ -305,8 +319,9 @@ const ( ) // Values returns all known values for TokenProviders. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TokenProviders) Values() []TokenProviders { return []TokenProviders{ "figma", diff --git a/service/amplifyuibuilder/types/types.go b/service/amplifyuibuilder/types/types.go index 9a0061ee129..8298f507c5c 100644 --- a/service/amplifyuibuilder/types/types.go +++ b/service/amplifyuibuilder/types/types.go @@ -1037,16 +1037,19 @@ type FileUploaderFieldConfig struct { // 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. + // access level, see [File access levels]in the Amplify documentation. + // + // [File access levels]: https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/ // // 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 - // 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. + // 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 // Specifies the maximum number of files that can be selected to upload. The diff --git a/service/apigateway/api_op_CreateDeployment.go b/service/apigateway/api_op_CreateDeployment.go index e3c45ad1f89..ae570c1e18f 100644 --- a/service/apigateway/api_op_CreateDeployment.go +++ b/service/apigateway/api_op_CreateDeployment.go @@ -41,8 +41,9 @@ 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]. + // + // [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 diff --git a/service/apigateway/api_op_CreateStage.go b/service/apigateway/api_op_CreateStage.go index 27b7efd7c14..6aecfb4ba84 100644 --- a/service/apigateway/api_op_CreateStage.go +++ b/service/apigateway/api_op_CreateStage.go @@ -52,8 +52,9 @@ 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]. + // + // [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. @@ -93,8 +94,9 @@ 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]. + // + // [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. diff --git a/service/apigateway/api_op_CreateUsagePlan.go b/service/apigateway/api_op_CreateUsagePlan.go index d008cfc5380..cedf099a178 100644 --- a/service/apigateway/api_op_CreateUsagePlan.go +++ b/service/apigateway/api_op_CreateUsagePlan.go @@ -61,9 +61,10 @@ 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]to monitor costs and [WAF] to manage API requests. +// +// [Amazon Web Services Budgets]: https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html +// [WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type CreateUsagePlanOutput struct { // The associated API stages of a usage plan. diff --git a/service/apigateway/api_op_DeleteBasePathMapping.go b/service/apigateway/api_op_DeleteBasePathMapping.go index 47a08d932b0..f8a36186d49 100644 --- a/service/apigateway/api_op_DeleteBasePathMapping.go +++ b/service/apigateway/api_op_DeleteBasePathMapping.go @@ -29,8 +29,9 @@ func (c *Client) DeleteBasePathMapping(ctx context.Context, params *DeleteBasePa // A request to delete the BasePathMapping resource. type DeleteBasePathMappingInput struct { - // The base path name of the BasePathMapping resource to delete. To specify an - // empty base path, set this parameter to '(none)' . + // The base path name of the BasePathMapping resource to delete. + // + // To specify an empty base path, set this parameter to '(none)' . // // This member is required. BasePath *string diff --git a/service/apigateway/api_op_GetIntegration.go b/service/apigateway/api_op_GetIntegration.go index f0690459c95..15e57fe1ff6 100644 --- a/service/apigateway/api_op_GetIntegration.go +++ b/service/apigateway/api_op_GetIntegration.go @@ -74,9 +74,10 @@ type GetIntegrationOutput struct { // Specifies how to handle request payload content type conversions. Supported // 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. + // + // 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. ContentHandling types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -137,15 +138,18 @@ type GetIntegrationOutput struct { TlsConfig *types.TlsConfig // 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 - // 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. + // 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 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 + // 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 standard integrations. // If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For // AWS or AWS_PROXY integrations, the URI is of the form diff --git a/service/apigateway/api_op_GetIntegrationResponse.go b/service/apigateway/api_op_GetIntegrationResponse.go index 12ba474f7a5..f0aed99a6e1 100644 --- a/service/apigateway/api_op_GetIntegrationResponse.go +++ b/service/apigateway/api_op_GetIntegrationResponse.go @@ -60,6 +60,7 @@ 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: + // // 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 diff --git a/service/apigateway/api_op_GetMethod.go b/service/apigateway/api_op_GetMethod.go index 78c9bca0187..05246c98796 100644 --- a/service/apigateway/api_op_GetMethod.go +++ b/service/apigateway/api_op_GetMethod.go @@ -48,7 +48,8 @@ type GetMethodInput struct { noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to +// 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 diff --git a/service/apigateway/api_op_GetStage.go b/service/apigateway/api_op_GetStage.go index a6e730fc39d..5b6b0a389bb 100644 --- a/service/apigateway/api_op_GetStage.go +++ b/service/apigateway/api_op_GetStage.go @@ -56,8 +56,9 @@ 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]. + // + // [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. diff --git a/service/apigateway/api_op_GetUsagePlan.go b/service/apigateway/api_op_GetUsagePlan.go index f15e77c76c6..b8af30dc9fd 100644 --- a/service/apigateway/api_op_GetUsagePlan.go +++ b/service/apigateway/api_op_GetUsagePlan.go @@ -41,9 +41,10 @@ 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]to monitor costs and [WAF] to manage API requests. +// +// [Amazon Web Services Budgets]: https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html +// [WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type GetUsagePlanOutput struct { // The associated API stages of a usage plan. diff --git a/service/apigateway/api_op_ImportRestApi.go b/service/apigateway/api_op_ImportRestApi.go index d4cd1e5aee4..4952ec6afc5 100644 --- a/service/apigateway/api_op_ImportRestApi.go +++ b/service/apigateway/api_op_ImportRestApi.go @@ -46,12 +46,17 @@ type ImportRestApiInput struct { // 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 . + // 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 . Parameters map[string]string noSmithyDocumentSerde diff --git a/service/apigateway/api_op_PutIntegration.go b/service/apigateway/api_op_PutIntegration.go index d1363bcb45d..61cc1c9a0ec 100644 --- a/service/apigateway/api_op_PutIntegration.go +++ b/service/apigateway/api_op_PutIntegration.go @@ -73,9 +73,10 @@ type PutIntegrationInput struct { // Specifies how to handle request payload content type conversions. Supported // 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. + // + // 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. ContentHandling types.ContentHandlingStrategy // Specifies whether credentials are required for a put integration. @@ -162,9 +163,10 @@ type PutIntegrationOutput struct { // Specifies how to handle request payload content type conversions. Supported // 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. + // + // 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. ContentHandling types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -225,15 +227,18 @@ type PutIntegrationOutput struct { TlsConfig *types.TlsConfig // 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 - // 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. + // 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 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 + // 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 standard integrations. // If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For // AWS or AWS_PROXY integrations, the URI is of the form diff --git a/service/apigateway/api_op_PutIntegrationResponse.go b/service/apigateway/api_op_PutIntegrationResponse.go index 8fc589a861c..ecddcb436a6 100644 --- a/service/apigateway/api_op_PutIntegrationResponse.go +++ b/service/apigateway/api_op_PutIntegrationResponse.go @@ -53,6 +53,7 @@ type PutIntegrationResponseInput struct { // Specifies how to handle response payload content type conversions. Supported // 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 @@ -86,6 +87,7 @@ 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: + // // 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 diff --git a/service/apigateway/api_op_PutMethod.go b/service/apigateway/api_op_PutMethod.go index fb13413b026..97c4022cb2f 100644 --- a/service/apigateway/api_op_PutMethod.go +++ b/service/apigateway/api_op_PutMethod.go @@ -96,7 +96,8 @@ type PutMethodInput struct { noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to +// 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 diff --git a/service/apigateway/api_op_UpdateAccount.go b/service/apigateway/api_op_UpdateAccount.go index ea59cc32d44..2119349fe09 100644 --- a/service/apigateway/api_op_UpdateAccount.go +++ b/service/apigateway/api_op_UpdateAccount.go @@ -30,8 +30,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateApiKey.go b/service/apigateway/api_op_UpdateApiKey.go index cc4ed9f96e9..39fdaca6713 100644 --- a/service/apigateway/api_op_UpdateApiKey.go +++ b/service/apigateway/api_op_UpdateApiKey.go @@ -36,8 +36,9 @@ 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]. + // + // [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 2eedddc6746..99dea443bcc 100644 --- a/service/apigateway/api_op_UpdateAuthorizer.go +++ b/service/apigateway/api_op_UpdateAuthorizer.go @@ -40,8 +40,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateBasePathMapping.go b/service/apigateway/api_op_UpdateBasePathMapping.go index 5498ca46574..6e6633a3d13 100644 --- a/service/apigateway/api_op_UpdateBasePathMapping.go +++ b/service/apigateway/api_op_UpdateBasePathMapping.go @@ -30,8 +30,9 @@ func (c *Client) UpdateBasePathMapping(ctx context.Context, params *UpdateBasePa // A request to change information about the BasePathMapping resource. type UpdateBasePathMappingInput struct { - // The base path of the BasePathMapping resource to change. To specify an empty - // base path, set this parameter to '(none)' . + // The base path of the BasePathMapping resource to change. + // + // To specify an empty base path, set this parameter to '(none)' . // // This member is required. BasePath *string @@ -41,8 +42,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateClientCertificate.go b/service/apigateway/api_op_UpdateClientCertificate.go index a44fbb7c4e2..221a438a728 100644 --- a/service/apigateway/api_op_UpdateClientCertificate.go +++ b/service/apigateway/api_op_UpdateClientCertificate.go @@ -36,8 +36,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateDeployment.go b/service/apigateway/api_op_UpdateDeployment.go index 56e95334e94..80e5a93f597 100644 --- a/service/apigateway/api_op_UpdateDeployment.go +++ b/service/apigateway/api_op_UpdateDeployment.go @@ -42,8 +42,9 @@ 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]. + // + // [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 9bb14ffd1f4..b5665ff5257 100644 --- a/service/apigateway/api_op_UpdateDocumentationPart.go +++ b/service/apigateway/api_op_UpdateDocumentationPart.go @@ -40,8 +40,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateDocumentationVersion.go b/service/apigateway/api_op_UpdateDocumentationVersion.go index 6f7060ce40d..105f405ef16 100644 --- a/service/apigateway/api_op_UpdateDocumentationVersion.go +++ b/service/apigateway/api_op_UpdateDocumentationVersion.go @@ -41,8 +41,9 @@ 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]. + // + // [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 242fef7bcab..9b247a9e70d 100644 --- a/service/apigateway/api_op_UpdateDomainName.go +++ b/service/apigateway/api_op_UpdateDomainName.go @@ -36,8 +36,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateGatewayResponse.go b/service/apigateway/api_op_UpdateGatewayResponse.go index f6bd3d313a7..acfa1d8d682 100644 --- a/service/apigateway/api_op_UpdateGatewayResponse.go +++ b/service/apigateway/api_op_UpdateGatewayResponse.go @@ -40,8 +40,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateIntegration.go b/service/apigateway/api_op_UpdateIntegration.go index 6c9468c465b..ec6bed80790 100644 --- a/service/apigateway/api_op_UpdateIntegration.go +++ b/service/apigateway/api_op_UpdateIntegration.go @@ -45,8 +45,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -78,9 +79,10 @@ type UpdateIntegrationOutput struct { // Specifies how to handle request payload content type conversions. Supported // 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. + // + // 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. ContentHandling types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -141,15 +143,18 @@ type UpdateIntegrationOutput struct { TlsConfig *types.TlsConfig // 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 - // 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. + // 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 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 + // 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 standard integrations. // If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For // AWS or AWS_PROXY integrations, the URI is of the form diff --git a/service/apigateway/api_op_UpdateIntegrationResponse.go b/service/apigateway/api_op_UpdateIntegrationResponse.go index 94bb4d1de2b..e29396cc4ff 100644 --- a/service/apigateway/api_op_UpdateIntegrationResponse.go +++ b/service/apigateway/api_op_UpdateIntegrationResponse.go @@ -50,8 +50,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -64,6 +65,7 @@ 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: + // // 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 diff --git a/service/apigateway/api_op_UpdateMethod.go b/service/apigateway/api_op_UpdateMethod.go index 2f62cbf1e05..4359f692693 100644 --- a/service/apigateway/api_op_UpdateMethod.go +++ b/service/apigateway/api_op_UpdateMethod.go @@ -45,14 +45,16 @@ 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]. + // + // [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 +// 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 diff --git a/service/apigateway/api_op_UpdateMethodResponse.go b/service/apigateway/api_op_UpdateMethodResponse.go index 6b1e596dd65..d6c69bf4236 100644 --- a/service/apigateway/api_op_UpdateMethodResponse.go +++ b/service/apigateway/api_op_UpdateMethodResponse.go @@ -50,8 +50,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateModel.go b/service/apigateway/api_op_UpdateModel.go index d5d771fa43e..0301bab61f8 100644 --- a/service/apigateway/api_op_UpdateModel.go +++ b/service/apigateway/api_op_UpdateModel.go @@ -40,8 +40,9 @@ 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]. + // + // [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 e5e9a66b015..33854a86175 100644 --- a/service/apigateway/api_op_UpdateRequestValidator.go +++ b/service/apigateway/api_op_UpdateRequestValidator.go @@ -40,8 +40,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateResource.go b/service/apigateway/api_op_UpdateResource.go index d9752c38fe0..331171a68a3 100644 --- a/service/apigateway/api_op_UpdateResource.go +++ b/service/apigateway/api_op_UpdateResource.go @@ -40,8 +40,9 @@ 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]. + // + // [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 8f31074758e..aa7957b341c 100644 --- a/service/apigateway/api_op_UpdateRestApi.go +++ b/service/apigateway/api_op_UpdateRestApi.go @@ -36,8 +36,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateStage.go b/service/apigateway/api_op_UpdateStage.go index a462bed4b2c..9213e7b13e1 100644 --- a/service/apigateway/api_op_UpdateStage.go +++ b/service/apigateway/api_op_UpdateStage.go @@ -41,8 +41,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -60,8 +61,9 @@ 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]. + // + // [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. diff --git a/service/apigateway/api_op_UpdateUsage.go b/service/apigateway/api_op_UpdateUsage.go index 91a01df2271..cb1240ab912 100644 --- a/service/apigateway/api_op_UpdateUsage.go +++ b/service/apigateway/api_op_UpdateUsage.go @@ -43,8 +43,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/api_op_UpdateUsagePlan.go b/service/apigateway/api_op_UpdateUsagePlan.go index 0f742fef3c3..6da8516ad8e 100644 --- a/service/apigateway/api_op_UpdateUsagePlan.go +++ b/service/apigateway/api_op_UpdateUsagePlan.go @@ -35,8 +35,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde @@ -45,9 +46,10 @@ 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]to monitor costs and [WAF] to manage API requests. +// +// [Amazon Web Services Budgets]: https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html +// [WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type UpdateUsagePlanOutput struct { // The associated API stages of a usage plan. diff --git a/service/apigateway/api_op_UpdateVpcLink.go b/service/apigateway/api_op_UpdateVpcLink.go index 68651e9025b..a75de4c009c 100644 --- a/service/apigateway/api_op_UpdateVpcLink.go +++ b/service/apigateway/api_op_UpdateVpcLink.go @@ -36,8 +36,9 @@ 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]. + // + // [Patch Operations]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html PatchOperations []types.PatchOperation noSmithyDocumentSerde diff --git a/service/apigateway/doc.go b/service/apigateway/doc.go index b769c471c8f..5feca866b50 100644 --- a/service/apigateway/doc.go +++ b/service/apigateway/doc.go @@ -3,9 +3,10 @@ // Package apigateway provides the API client, operations, and parameter types for // Amazon API Gateway. // -// Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure, -// and scalable mobile and web application back ends. API Gateway allows developers -// to securely connect mobile and web applications to APIs that run on Lambda, -// Amazon EC2, or other publicly addressable web services that are hosted outside -// of AWS. +// # Amazon API Gateway +// +// Amazon API Gateway helps developers deliver robust, secure, and scalable mobile +// and web application back ends. API Gateway allows developers to securely connect +// mobile and web applications to APIs that run on Lambda, Amazon EC2, or other +// publicly addressable web services that are hosted outside of AWS. package apigateway diff --git a/service/apigateway/options.go b/service/apigateway/options.go index 2eeaf81d95a..4b2a456a782 100644 --- a/service/apigateway/options.go +++ b/service/apigateway/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/apigateway/types/enums.go b/service/apigateway/types/enums.go index 5677c782e7a..d52981ab810 100644 --- a/service/apigateway/types/enums.go +++ b/service/apigateway/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for ApiKeysFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiKeysFormat) Values() []ApiKeysFormat { return []ApiKeysFormat{ "csv", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for ApiKeySourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiKeySourceType) Values() []ApiKeySourceType { return []ApiKeySourceType{ "HEADER", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for AuthorizerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizerType) Values() []AuthorizerType { return []AuthorizerType{ "TOKEN", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for CacheClusterSize. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CacheClusterSize) Values() []CacheClusterSize { return []CacheClusterSize{ "0.5", @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for CacheClusterStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CacheClusterStatus) Values() []CacheClusterStatus { return []CacheClusterStatus{ "CREATE_IN_PROGRESS", @@ -119,8 +124,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "INTERNET", @@ -137,8 +143,9 @@ const ( ) // Values returns all known values for ContentHandlingStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentHandlingStrategy) Values() []ContentHandlingStrategy { return []ContentHandlingStrategy{ "CONVERT_TO_BINARY", @@ -165,8 +172,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "API", @@ -196,8 +204,9 @@ const ( ) // Values returns all known values for DomainNameStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainNameStatus) Values() []DomainNameStatus { return []DomainNameStatus{ "AVAILABLE", @@ -218,8 +227,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -256,8 +266,9 @@ const ( ) // Values returns all known values for GatewayResponseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayResponseType) Values() []GatewayResponseType { return []GatewayResponseType{ "DEFAULT_4XX", @@ -296,8 +307,9 @@ const ( ) // Values returns all known values for IntegrationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationType) Values() []IntegrationType { return []IntegrationType{ "HTTP", @@ -317,8 +329,9 @@ const ( ) // Values returns all known values for LocationStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocationStatusType) Values() []LocationStatusType { return []LocationStatusType{ "DOCUMENTED", @@ -339,8 +352,9 @@ const ( ) // Values returns all known values for Op. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Op) Values() []Op { return []Op{ "add", @@ -361,8 +375,9 @@ const ( ) // Values returns all known values for PutMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PutMode) Values() []PutMode { return []PutMode{ "merge", @@ -380,8 +395,9 @@ const ( ) // Values returns all known values for QuotaPeriodType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuotaPeriodType) Values() []QuotaPeriodType { return []QuotaPeriodType{ "DAY", @@ -399,8 +415,9 @@ const ( ) // Values returns all known values for SecurityPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityPolicy) Values() []SecurityPolicy { return []SecurityPolicy{ "TLS_1_0", @@ -419,8 +436,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnauthorizedCacheControlHeaderStrategy) Values() []UnauthorizedCacheControlHeaderStrategy { return []UnauthorizedCacheControlHeaderStrategy{ "FAIL_WITH_403", @@ -440,8 +458,9 @@ const ( ) // Values returns all known values for VpcLinkStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcLinkStatus) Values() []VpcLinkStatus { return []VpcLinkStatus{ "AVAILABLE", diff --git a/service/apigateway/types/types.go b/service/apigateway/types/types.go index ba26284976c..4ecb9247623 100644 --- a/service/apigateway/types/types.go +++ b/service/apigateway/types/types.go @@ -508,9 +508,10 @@ type Integration struct { // Specifies how to handle request payload content type conversions. Supported // 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. + // + // 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. ContentHandling ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -571,15 +572,18 @@ type Integration struct { TlsConfig *TlsConfig // 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 - // 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. + // 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 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 + // 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 standard integrations. // If connectionType is VPC_LINK specify the Network Load Balancer DNS name. For // AWS or AWS_PROXY integrations, the URI is of the form @@ -609,6 +613,7 @@ 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: + // // 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 @@ -648,7 +653,8 @@ type IntegrationResponse struct { noSmithyDocumentSerde } -// Represents a client-facing interface by which the client calls the API to +// 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 @@ -880,8 +886,9 @@ 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]. +// +// [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 @@ -1092,8 +1099,9 @@ 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]. + // + // [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. @@ -1184,6 +1192,7 @@ type TlsConfig struct { // 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. @@ -1195,9 +1204,10 @@ 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]to monitor costs and [WAF] to manage API requests. +// +// [Amazon Web Services Budgets]: https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html +// [WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type UsagePlan struct { // The associated API stages of a usage plan. diff --git a/service/apigatewaymanagementapi/options.go b/service/apigatewaymanagementapi/options.go index f4d53167a7b..b3e6b8ba0ae 100644 --- a/service/apigatewaymanagementapi/options.go +++ b/service/apigatewaymanagementapi/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/apigatewayv2/api_op_CreateApi.go b/service/apigatewayv2/api_op_CreateApi.go index 459bb796be1..6f503bff6a0 100644 --- a/service/apigatewayv2/api_op_CreateApi.go +++ b/service/apigatewayv2/api_op_CreateApi.go @@ -41,13 +41,14 @@ type CreateApiInput struct { // This member is required. 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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) - // for more information. + // A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS] for more information. + // + // [Configuring CORS]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html CorsConfiguration *types.Cors // This property is part of quick create. It specifies the credentials required @@ -118,9 +119,9 @@ type CreateApiOutput struct { // 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. diff --git a/service/apigatewayv2/api_op_CreateAuthorizer.go b/service/apigatewayv2/api_op_CreateAuthorizer.go index ba41362f438..007357ccc47 100644 --- a/service/apigatewayv2/api_op_CreateAuthorizer.go +++ b/service/apigatewayv2/api_op_CreateAuthorizer.go @@ -42,11 +42,12 @@ type CreateAuthorizerInput struct { // This member is required. AuthorizerType types.AuthorizerType - // The identity source for which authorization is requested. For a REQUEST - // authorizer, this is optional. The value is a set of one or more mapping - // expressions of the specified request parameters. The identity source can be - // headers, query string parameters, stage variables, and context parameters. For - // example, if an Auth header and a Name query string parameter are defined as + // The identity source for which authorization is requested. + // + // For a REQUEST authorizer, this is optional. The value is a set of one or more + // mapping expressions of the specified request parameters. The identity source can + // be headers, query string parameters, stage variables, and context parameters. + // For example, if an Auth header and a Name query string parameter are defined as // identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, @@ -56,13 +57,15 @@ type CreateAuthorizerInput struct { // when this is true does the authorizer invoke the authorizer Lambda function. // 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 + // caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]. + // + // 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. // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html + // // This member is required. IdentitySource []string @@ -79,8 +82,9 @@ 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]. + // + // [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 @@ -104,8 +108,9 @@ type CreateAuthorizerInput struct { // Specifies whether a Lambda authorizer returns a response in a simple format. By // 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) + // for HTTP APIs. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs] + // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html EnableSimpleResponses *bool // This parameter is not used. @@ -131,8 +136,9 @@ 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]. + // + // [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,15 +166,17 @@ 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] + // + // [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 - // authorizer, this is optional. The value is a set of one or more mapping - // expressions of the specified request parameters. The identity source can be - // headers, query string parameters, stage variables, and context parameters. For - // example, if an Auth header and a Name query string parameter are defined as + // The identity source for which authorization is requested. + // + // For a REQUEST authorizer, this is optional. The value is a set of one or more + // mapping expressions of the specified request parameters. The identity source can + // be headers, query string parameters, stage variables, and context parameters. + // For example, if an Auth header and a Name query string parameter are defined as // identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, @@ -178,12 +186,14 @@ type CreateAuthorizerOutput struct { // when this is true does the authorizer invoke the authorizer Lambda function. // 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 + // caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]. + // + // 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. + // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html 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 489aab15444..cdbab5b8231 100644 --- a/service/apigatewayv2/api_op_CreateIntegration.go +++ b/service/apigatewayv2/api_op_CreateIntegration.go @@ -35,21 +35,30 @@ type CreateIntegrationInput struct { // This member is required. ApiId *string - // The integration type of an integration. One of the following: AWS: for - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with a Lambda function or - // other AWS service action. This integration is also referred to as a Lambda proxy - // integration. HTTP: for integrating the route or method request with an HTTP - // endpoint. This integration is also referred to as the HTTP custom integration. - // Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or - // method request with an HTTP endpoint, with the client request passed through - // as-is. This is also referred to as HTTP proxy integration. For HTTP API private - // integrations, use an HTTP_PROXY integration. MOCK: for integrating the route or - // method request with API Gateway as a "loopback" endpoint without invoking any - // backend. Supported only for WebSocket APIs. + // The integration type of an integration. One of the following: + // + // AWS: for integrating the route or method request with an AWS service action, + // including the Lambda function-invoking action. With the Lambda function-invoking + // action, this is referred to as the Lambda custom integration. With any other AWS + // service action, this is known as AWS integration. Supported only for WebSocket + // APIs. + // + // AWS_PROXY: for integrating the route or method request with a Lambda function + // or other AWS service action. This integration is also referred to as a Lambda + // proxy integration. + // + // HTTP: for integrating the route or method request with an HTTP endpoint. This + // integration is also referred to as the HTTP custom integration. Supported only + // for WebSocket APIs. + // + // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, + // with the client request passed through as-is. This is also referred to as HTTP + // proxy integration. For HTTP API private integrations, use an HTTP_PROXY + // integration. + // + // MOCK: for integrating the route or method request with API Gateway as a + // "loopback" endpoint without invoking any backend. Supported only for WebSocket + // APIs. // // This member is required. IntegrationType types.IntegrationType @@ -65,12 +74,17 @@ type CreateIntegrationInput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -88,27 +102,37 @@ 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]. + // + // [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 - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // 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. + // For a Lambda integration, specify the URI of a Lambda function. + // + // For an HTTP integration, specify a fully-qualified URL. + // + // For an HTTP API private integration, specify the ARN of an Application Load + // Balancer listener, Network Load Balancer 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]. 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 IntegrationUri *string // 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. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // only for WebSocket APIs. + // + // WHEN_NO_MATCH passes the request body for unmapped content types through to the + // integration backend without transformation. + // + // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type + // response. + // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media @@ -126,19 +150,24 @@ type CreateIntegrationInput struct { // required by the backend. 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. For HTTP API integrations with a specified integrationSubtype, request + // name. + // + // For HTTP API integrations with a specified integrationSubtype, request // 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]. + // + // 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]. + // + // [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + // [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 @@ -155,8 +184,9 @@ 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]. + // + // [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. @@ -193,12 +223,17 @@ type CreateIntegrationOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -219,48 +254,68 @@ 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]. + // + // [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]. + // + // [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 - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with a Lambda function or - // other AWS service action. This integration is also referred to as a Lambda proxy - // integration. HTTP: for integrating the route or method request with an HTTP - // endpoint. This integration is also referred to as the HTTP custom integration. - // Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or - // method request with an HTTP endpoint, with the client request passed through - // as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating - // the route or method request with API Gateway as a "loopback" endpoint without - // invoking any backend. Supported only for WebSocket APIs. + // The integration type of an integration. One of the following: + // + // AWS: for integrating the route or method request with an AWS service action, + // including the Lambda function-invoking action. With the Lambda function-invoking + // action, this is referred to as the Lambda custom integration. With any other AWS + // service action, this is known as AWS integration. Supported only for WebSocket + // APIs. + // + // AWS_PROXY: for integrating the route or method request with a Lambda function + // or other AWS service action. This integration is also referred to as a Lambda + // proxy integration. + // + // HTTP: for integrating the route or method request with an HTTP endpoint. This + // integration is also referred to as the HTTP custom integration. Supported only + // for WebSocket APIs. + // + // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, + // with the client request passed through as-is. This is also referred to as HTTP + // proxy integration. + // + // MOCK: for integrating the route or method request with API Gateway as a + // "loopback" endpoint without invoking any backend. Supported only for WebSocket + // APIs. IntegrationType types.IntegrationType - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // 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. + // For a Lambda integration, specify the URI of a Lambda function. + // + // For an HTTP integration, specify a fully-qualified URL. + // + // For an HTTP API private integration, specify the ARN of an Application Load + // Balancer listener, Network Load Balancer 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]. 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 IntegrationUri *string // 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. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // only for WebSocket APIs. + // + // WHEN_NO_MATCH passes the request body for unmapped content types through to the + // integration backend without transformation. + // + // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type + // response. + // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media @@ -278,19 +333,24 @@ type CreateIntegrationOutput struct { // required by the backend. 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. For HTTP API integrations with a specified integrationSubtype, request + // name. + // + // For HTTP API integrations with a specified integrationSubtype, request // 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]. + // + // 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 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]. + // + // [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + // [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 @@ -307,8 +367,9 @@ 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]. + // + // [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 diff --git a/service/apigatewayv2/api_op_CreateIntegrationResponse.go b/service/apigatewayv2/api_op_CreateIntegrationResponse.go index 939aa9670ec..39da1364f16 100644 --- a/service/apigatewayv2/api_op_CreateIntegrationResponse.go +++ b/service/apigatewayv2/api_op_CreateIntegrationResponse.go @@ -47,11 +47,16 @@ type CreateIntegrationResponseInput struct { // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: + // // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to - // the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from - // a binary blob to a Base64-encoded string. If this property is not defined, the - // response payload will be passed through from the integration response to the - // route response or method response without modification. + // the corresponding binary blob. + // + // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // A key-value map specifying response parameters that are passed to the method @@ -83,12 +88,17 @@ type CreateIntegrationResponseOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // The integration response ID. diff --git a/service/apigatewayv2/api_op_ExportApi.go b/service/apigatewayv2/api_op_ExportApi.go index 948d82f79a9..6576e477ffe 100644 --- a/service/apigatewayv2/api_op_ExportApi.go +++ b/service/apigatewayv2/api_op_ExportApi.go @@ -47,8 +47,10 @@ 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) - // in the exported API definition. API Gateway extensions are included by default. + // Specifies whether to include [API Gateway extensions] in the exported API definition. API Gateway + // extensions are included by default. + // + // [API Gateway extensions]: https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html IncludeExtensions *bool // The name of the API stage to export. If you don't specify this property, a diff --git a/service/apigatewayv2/api_op_GetApi.go b/service/apigatewayv2/api_op_GetApi.go index 154b5e8e414..7d1d91489f4 100644 --- a/service/apigatewayv2/api_op_GetApi.go +++ b/service/apigatewayv2/api_op_GetApi.go @@ -53,9 +53,9 @@ type GetApiOutput struct { // 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. diff --git a/service/apigatewayv2/api_op_GetAuthorizer.go b/service/apigatewayv2/api_op_GetAuthorizer.go index d35db02a1d3..020eae6674a 100644 --- a/service/apigatewayv2/api_op_GetAuthorizer.go +++ b/service/apigatewayv2/api_op_GetAuthorizer.go @@ -55,8 +55,9 @@ 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]. + // + // [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,15 +85,17 @@ 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] + // + // [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 - // authorizer, this is optional. The value is a set of one or more mapping - // expressions of the specified request parameters. The identity source can be - // headers, query string parameters, stage variables, and context parameters. For - // example, if an Auth header and a Name query string parameter are defined as + // The identity source for which authorization is requested. + // + // For a REQUEST authorizer, this is optional. The value is a set of one or more + // mapping expressions of the specified request parameters. The identity source can + // be headers, query string parameters, stage variables, and context parameters. + // For example, if an Auth header and a Name query string parameter are defined as // identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, @@ -102,12 +105,14 @@ type GetAuthorizerOutput struct { // when this is true does the authorizer invoke the authorizer Lambda function. // 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 + // caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]. + // + // 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. + // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html 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 a352a36b8e0..6e6dd749d24 100644 --- a/service/apigatewayv2/api_op_GetIntegration.go +++ b/service/apigatewayv2/api_op_GetIntegration.go @@ -60,12 +60,17 @@ type GetIntegrationOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -86,48 +91,68 @@ 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]. + // + // [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]. + // + // [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 - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with a Lambda function or - // other AWS service action. This integration is also referred to as a Lambda proxy - // integration. HTTP: for integrating the route or method request with an HTTP - // endpoint. This integration is also referred to as the HTTP custom integration. - // Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or - // method request with an HTTP endpoint, with the client request passed through - // as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating - // the route or method request with API Gateway as a "loopback" endpoint without - // invoking any backend. Supported only for WebSocket APIs. + // The integration type of an integration. One of the following: + // + // AWS: for integrating the route or method request with an AWS service action, + // including the Lambda function-invoking action. With the Lambda function-invoking + // action, this is referred to as the Lambda custom integration. With any other AWS + // service action, this is known as AWS integration. Supported only for WebSocket + // APIs. + // + // AWS_PROXY: for integrating the route or method request with a Lambda function + // or other AWS service action. This integration is also referred to as a Lambda + // proxy integration. + // + // HTTP: for integrating the route or method request with an HTTP endpoint. This + // integration is also referred to as the HTTP custom integration. Supported only + // for WebSocket APIs. + // + // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, + // with the client request passed through as-is. This is also referred to as HTTP + // proxy integration. + // + // MOCK: for integrating the route or method request with API Gateway as a + // "loopback" endpoint without invoking any backend. Supported only for WebSocket + // APIs. IntegrationType types.IntegrationType - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // 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. + // For a Lambda integration, specify the URI of a Lambda function. + // + // For an HTTP integration, specify a fully-qualified URL. + // + // For an HTTP API private integration, specify the ARN of an Application Load + // Balancer listener, Network Load Balancer 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]. 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 IntegrationUri *string // 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. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // only for WebSocket APIs. + // + // WHEN_NO_MATCH passes the request body for unmapped content types through to the + // integration backend without transformation. + // + // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type + // response. + // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media @@ -145,19 +170,24 @@ type GetIntegrationOutput struct { // required by the backend. 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. For HTTP API integrations with a specified integrationSubtype, request + // name. + // + // For HTTP API integrations with a specified integrationSubtype, request // 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]. + // + // 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 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]. + // + // [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + // [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 @@ -174,8 +204,9 @@ 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]. + // + // [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 diff --git a/service/apigatewayv2/api_op_GetIntegrationResponse.go b/service/apigatewayv2/api_op_GetIntegrationResponse.go index f6fbf18971c..1fc60acb947 100644 --- a/service/apigatewayv2/api_op_GetIntegrationResponse.go +++ b/service/apigatewayv2/api_op_GetIntegrationResponse.go @@ -51,12 +51,17 @@ type GetIntegrationResponseOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // The integration response ID. diff --git a/service/apigatewayv2/api_op_ImportApi.go b/service/apigatewayv2/api_op_ImportApi.go index 6c817a21544..26c33091e39 100644 --- a/service/apigatewayv2/api_op_ImportApi.go +++ b/service/apigatewayv2/api_op_ImportApi.go @@ -36,9 +36,10 @@ type ImportApiInput struct { Body *string // 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) + // are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property] // . Supported only for HTTP APIs. + // + // [Set the OpenAPI basePath Property]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html Basepath *string // Specifies whether to rollback the API creation when a warning is encountered. @@ -63,9 +64,9 @@ type ImportApiOutput struct { // 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. diff --git a/service/apigatewayv2/api_op_ReimportApi.go b/service/apigatewayv2/api_op_ReimportApi.go index 796903869c1..64c4e99381b 100644 --- a/service/apigatewayv2/api_op_ReimportApi.go +++ b/service/apigatewayv2/api_op_ReimportApi.go @@ -41,9 +41,10 @@ type ReimportApiInput struct { Body *string // 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) + // are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property] // . Supported only for HTTP APIs. + // + // [Set the OpenAPI basePath Property]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html Basepath *string // Specifies whether to rollback the API creation when a warning is encountered. @@ -68,9 +69,9 @@ type ReimportApiOutput struct { // 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. diff --git a/service/apigatewayv2/api_op_UpdateApi.go b/service/apigatewayv2/api_op_UpdateApi.go index 6b925ede3ee..f7c8f79db01 100644 --- a/service/apigatewayv2/api_op_UpdateApi.go +++ b/service/apigatewayv2/api_op_UpdateApi.go @@ -36,9 +36,9 @@ type UpdateApiInput struct { // This member is required. 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. @@ -112,9 +112,9 @@ type UpdateApiOutput struct { // 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. diff --git a/service/apigatewayv2/api_op_UpdateAuthorizer.go b/service/apigatewayv2/api_op_UpdateAuthorizer.go index 6109fcb12cd..69719da42d4 100644 --- a/service/apigatewayv2/api_op_UpdateAuthorizer.go +++ b/service/apigatewayv2/api_op_UpdateAuthorizer.go @@ -48,8 +48,9 @@ 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]. + // + // [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 @@ -78,15 +79,17 @@ type UpdateAuthorizerInput struct { // Specifies whether a Lambda authorizer returns a response in a simple format. By // 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) + // for HTTP APIs. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs] + // + // [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 - // authorizer, this is optional. The value is a set of one or more mapping - // expressions of the specified request parameters. The identity source can be - // headers, query string parameters, stage variables, and context parameters. For - // example, if an Auth header and a Name query string parameter are defined as + // The identity source for which authorization is requested. + // + // For a REQUEST authorizer, this is optional. The value is a set of one or more + // mapping expressions of the specified request parameters. The identity source can + // be headers, query string parameters, stage variables, and context parameters. + // For example, if an Auth header and a Name query string parameter are defined as // identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, @@ -96,12 +99,14 @@ type UpdateAuthorizerInput struct { // when this is true does the authorizer invoke the authorizer Lambda function. // 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 + // caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]. + // + // 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. + // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html IdentitySource []string // This parameter is not used. @@ -130,8 +135,9 @@ 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]. + // + // [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 @@ -159,15 +165,17 @@ 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] + // + // [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 - // authorizer, this is optional. The value is a set of one or more mapping - // expressions of the specified request parameters. The identity source can be - // headers, query string parameters, stage variables, and context parameters. For - // example, if an Auth header and a Name query string parameter are defined as + // The identity source for which authorization is requested. + // + // For a REQUEST authorizer, this is optional. The value is a set of one or more + // mapping expressions of the specified request parameters. The identity source can + // be headers, query string parameters, stage variables, and context parameters. + // For example, if an Auth header and a Name query string parameter are defined as // identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, @@ -177,12 +185,14 @@ type UpdateAuthorizerOutput struct { // when this is true does the authorizer invoke the authorizer Lambda function. // 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 + // caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]. + // + // 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. + // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html 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 d314d89e727..a1d8336dad2 100644 --- a/service/apigatewayv2/api_op_UpdateIntegration.go +++ b/service/apigatewayv2/api_op_UpdateIntegration.go @@ -51,12 +51,17 @@ type UpdateIntegrationInput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -74,44 +79,63 @@ 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]. + // + // [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 - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with a Lambda function or - // other AWS service action. This integration is also referred to as a Lambda proxy - // integration. HTTP: for integrating the route or method request with an HTTP - // endpoint. This integration is also referred to as the HTTP custom integration. - // Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or - // method request with an HTTP endpoint, with the client request passed through - // as-is. This is also referred to as HTTP proxy integration. For HTTP API private - // integrations, use an HTTP_PROXY integration. MOCK: for integrating the route or - // method request with API Gateway as a "loopback" endpoint without invoking any - // backend. Supported only for WebSocket APIs. + // The integration type of an integration. One of the following: + // + // AWS: for integrating the route or method request with an AWS service action, + // including the Lambda function-invoking action. With the Lambda function-invoking + // action, this is referred to as the Lambda custom integration. With any other AWS + // service action, this is known as AWS integration. Supported only for WebSocket + // APIs. + // + // AWS_PROXY: for integrating the route or method request with a Lambda function + // or other AWS service action. This integration is also referred to as a Lambda + // proxy integration. + // + // HTTP: for integrating the route or method request with an HTTP endpoint. This + // integration is also referred to as the HTTP custom integration. Supported only + // for WebSocket APIs. + // + // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, + // with the client request passed through as-is. This is also referred to as HTTP + // proxy integration. For HTTP API private integrations, use an HTTP_PROXY + // integration. + // + // MOCK: for integrating the route or method request with API Gateway as a + // "loopback" endpoint without invoking any backend. Supported only for WebSocket + // APIs. IntegrationType types.IntegrationType - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // 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. + // For a Lambda integration, specify the URI of a Lambda function. + // + // For an HTTP integration, specify a fully-qualified URL. + // + // For an HTTP API private integration, specify the ARN of an Application Load + // Balancer listener, Network Load Balancer 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]. 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 IntegrationUri *string // 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. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // only for WebSocket APIs. + // + // WHEN_NO_MATCH passes the request body for unmapped content types through to the + // integration backend without transformation. + // + // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type + // response. + // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media @@ -129,19 +153,24 @@ type UpdateIntegrationInput struct { // required by the backend. 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. For HTTP API integrations with a specified integrationSubtype, request + // name. + // + // For HTTP API integrations with a specified integrationSubtype, request // 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]. + // + // 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]. + // + // [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + // [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 @@ -158,8 +187,9 @@ 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]. + // + // [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. @@ -196,12 +226,17 @@ type UpdateIntegrationOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -222,48 +257,68 @@ 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]. + // + // [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]. + // + // [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 - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with a Lambda function or - // other AWS service action. This integration is also referred to as a Lambda proxy - // integration. HTTP: for integrating the route or method request with an HTTP - // endpoint. This integration is also referred to as the HTTP custom integration. - // Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or - // method request with an HTTP endpoint, with the client request passed through - // as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating - // the route or method request with API Gateway as a "loopback" endpoint without - // invoking any backend. Supported only for WebSocket APIs. + // The integration type of an integration. One of the following: + // + // AWS: for integrating the route or method request with an AWS service action, + // including the Lambda function-invoking action. With the Lambda function-invoking + // action, this is referred to as the Lambda custom integration. With any other AWS + // service action, this is known as AWS integration. Supported only for WebSocket + // APIs. + // + // AWS_PROXY: for integrating the route or method request with a Lambda function + // or other AWS service action. This integration is also referred to as a Lambda + // proxy integration. + // + // HTTP: for integrating the route or method request with an HTTP endpoint. This + // integration is also referred to as the HTTP custom integration. Supported only + // for WebSocket APIs. + // + // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, + // with the client request passed through as-is. This is also referred to as HTTP + // proxy integration. + // + // MOCK: for integrating the route or method request with API Gateway as a + // "loopback" endpoint without invoking any backend. Supported only for WebSocket + // APIs. IntegrationType types.IntegrationType - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // 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. + // For a Lambda integration, specify the URI of a Lambda function. + // + // For an HTTP integration, specify a fully-qualified URL. + // + // For an HTTP API private integration, specify the ARN of an Application Load + // Balancer listener, Network Load Balancer 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]. 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 IntegrationUri *string // 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. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // only for WebSocket APIs. + // + // WHEN_NO_MATCH passes the request body for unmapped content types through to the + // integration backend without transformation. + // + // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type + // response. + // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media @@ -281,19 +336,24 @@ type UpdateIntegrationOutput struct { // required by the backend. 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. For HTTP API integrations with a specified integrationSubtype, request + // name. + // + // For HTTP API integrations with a specified integrationSubtype, request // 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]. + // + // 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 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]. + // + // [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + // [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 @@ -310,8 +370,9 @@ 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]. + // + // [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 diff --git a/service/apigatewayv2/api_op_UpdateIntegrationResponse.go b/service/apigatewayv2/api_op_UpdateIntegrationResponse.go index 0fdae227e2a..63eaef7072c 100644 --- a/service/apigatewayv2/api_op_UpdateIntegrationResponse.go +++ b/service/apigatewayv2/api_op_UpdateIntegrationResponse.go @@ -47,12 +47,17 @@ type UpdateIntegrationResponseInput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // The integration response key. @@ -87,12 +92,17 @@ type UpdateIntegrationResponseOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy types.ContentHandlingStrategy // The integration response ID. diff --git a/service/apigatewayv2/options.go b/service/apigatewayv2/options.go index 2d335fa1572..5ef882df78c 100644 --- a/service/apigatewayv2/options.go +++ b/service/apigatewayv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/apigatewayv2/types/enums.go b/service/apigatewayv2/types/enums.go index 8a25b3479cd..a0c8904dde2 100644 --- a/service/apigatewayv2/types/enums.go +++ b/service/apigatewayv2/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AuthorizationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizationType) Values() []AuthorizationType { return []AuthorizationType{ "NONE", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for AuthorizerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizerType) Values() []AuthorizerType { return []AuthorizerType{ "REQUEST", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "INTERNET", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for ContentHandlingStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentHandlingStrategy) Values() []ContentHandlingStrategy { return []ContentHandlingStrategy{ "CONVERT_TO_BINARY", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "PENDING", @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for DomainNameStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainNameStatus) Values() []DomainNameStatus { return []DomainNameStatus{ "AVAILABLE", @@ -129,8 +135,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -150,8 +157,9 @@ const ( ) // Values returns all known values for IntegrationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationType) Values() []IntegrationType { return []IntegrationType{ "AWS", @@ -172,8 +180,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -192,8 +201,9 @@ const ( ) // Values returns all known values for PassthroughBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PassthroughBehavior) Values() []PassthroughBehavior { return []PassthroughBehavior{ "WHEN_NO_MATCH", @@ -211,8 +221,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -229,8 +240,9 @@ const ( ) // Values returns all known values for SecurityPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityPolicy) Values() []SecurityPolicy { return []SecurityPolicy{ "TLS_1_0", @@ -250,8 +262,9 @@ const ( ) // Values returns all known values for VpcLinkStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcLinkStatus) Values() []VpcLinkStatus { return []VpcLinkStatus{ "PENDING", @@ -270,8 +283,9 @@ const ( ) // Values returns all known values for VpcLinkVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcLinkVersion) Values() []VpcLinkVersion { return []VpcLinkVersion{ "V2", diff --git a/service/apigatewayv2/types/types.go b/service/apigatewayv2/types/types.go index 9ab574dea77..474effe63b4 100644 --- a/service/apigatewayv2/types/types.go +++ b/service/apigatewayv2/types/types.go @@ -54,9 +54,9 @@ type Api struct { // 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) - // . + // An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions]. + // + // [API Key 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. @@ -138,8 +138,9 @@ 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]. + // + // [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,15 +168,17 @@ 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] + // + // [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 - // authorizer, this is optional. The value is a set of one or more mapping - // expressions of the specified request parameters. The identity source can be - // headers, query string parameters, stage variables, and context parameters. For - // example, if an Auth header and a Name query string parameter are defined as + // The identity source for which authorization is requested. + // + // For a REQUEST authorizer, this is optional. The value is a set of one or more + // mapping expressions of the specified request parameters. The identity source can + // be headers, query string parameters, stage variables, and context parameters. + // For example, if an Auth header and a Name query string parameter are defined as // identity sources, this value is route.request.header.Auth, // route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection // expressions prefixed with $, for example, $request.header.Auth, @@ -185,12 +188,14 @@ type Authorizer struct { // when this is true does the authorizer invoke the authorizer Lambda function. // 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 + // caching is enabled. To learn more, see [Working with AWS Lambda authorizers for HTTP APIs]. + // + // 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. + // + // [Working with AWS Lambda authorizers for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html IdentitySource []string // The validation expression does not apply to the REQUEST authorizer. @@ -203,9 +208,10 @@ type Authorizer struct { noSmithyDocumentSerde } -// Represents 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. +// Represents a CORS configuration. Supported only for HTTP APIs. See [Configuring CORS] for more +// information. +// +// [Configuring CORS]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html type Cors struct { // Specifies whether credentials are included in the CORS request. Supported only @@ -344,12 +350,17 @@ type Integration struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy ContentHandlingStrategy // Specifies the credentials required for the integration, if any. For AWS @@ -370,48 +381,68 @@ 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]. + // + // [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]. + // + // [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 - // integrating the route or method request with an AWS service action, including - // the Lambda function-invoking action. With the Lambda function-invoking action, - // this is referred to as the Lambda custom integration. With any other AWS service - // action, this is known as AWS integration. Supported only for WebSocket APIs. - // AWS_PROXY: for integrating the route or method request with a Lambda function or - // other AWS service action. This integration is also referred to as a Lambda proxy - // integration. HTTP: for integrating the route or method request with an HTTP - // endpoint. This integration is also referred to as the HTTP custom integration. - // Supported only for WebSocket APIs. HTTP_PROXY: for integrating the route or - // method request with an HTTP endpoint, with the client request passed through - // as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating - // the route or method request with API Gateway as a "loopback" endpoint without - // invoking any backend. Supported only for WebSocket APIs. + // The integration type of an integration. One of the following: + // + // AWS: for integrating the route or method request with an AWS service action, + // including the Lambda function-invoking action. With the Lambda function-invoking + // action, this is referred to as the Lambda custom integration. With any other AWS + // service action, this is known as AWS integration. Supported only for WebSocket + // APIs. + // + // AWS_PROXY: for integrating the route or method request with a Lambda function + // or other AWS service action. This integration is also referred to as a Lambda + // proxy integration. + // + // HTTP: for integrating the route or method request with an HTTP endpoint. This + // integration is also referred to as the HTTP custom integration. Supported only + // for WebSocket APIs. + // + // HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, + // with the client request passed through as-is. This is also referred to as HTTP + // proxy integration. + // + // MOCK: for integrating the route or method request with API Gateway as a + // "loopback" endpoint without invoking any backend. Supported only for WebSocket + // APIs. IntegrationType IntegrationType - // For a Lambda integration, specify the URI of a Lambda function. For an HTTP - // integration, specify a fully-qualified URL. For an HTTP API private integration, - // specify the ARN of an Application Load Balancer listener, Network Load Balancer - // 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. + // For a Lambda integration, specify the URI of a Lambda function. + // + // For an HTTP integration, specify a fully-qualified URL. + // + // For an HTTP API private integration, specify the ARN of an Application Load + // Balancer listener, Network Load Balancer 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]. 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 IntegrationUri *string // 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. Supported - // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped - // content types through to the integration backend without transformation. NEVER - // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. + // only for WebSocket APIs. + // + // WHEN_NO_MATCH passes the request body for unmapped content types through to the + // integration backend without transformation. + // + // NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type + // response. + // // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media @@ -429,19 +460,24 @@ type Integration struct { // required by the backend. 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. For HTTP API integrations with a specified integrationSubtype, request + // name. + // + // For HTTP API integrations with a specified integrationSubtype, request // 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]. + // + // 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 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]. + // + // [Working with AWS service integrations for HTTP APIs]: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html + // [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 @@ -458,8 +494,9 @@ 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]. + // + // [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 @@ -489,12 +526,17 @@ type IntegrationResponse struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and - // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a - // response payload from a Base64-encoded string to the corresponding binary blob. + // CONVERT_TO_TEXT, with the following behaviors: + // + // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to + // the corresponding binary blob. + // // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a - // Base64-encoded string. If this property is not defined, the response payload - // will be passed through from the integration response to the route response or - // method response without modification. + // Base64-encoded string. + // + // If this property is not defined, the response payload will be passed through + // from the integration response to the route response or method response without + // modification. ContentHandlingStrategy ContentHandlingStrategy // The integration response ID. @@ -529,8 +571,10 @@ 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]. Supported only for HTTP + // APIs. + // + // [RFC 7519]: https://tools.ietf.org/html/rfc7519#section-4.1.3 Audience []string // The base domain of the identity provider that issues JSON Web Tokens. For @@ -542,9 +586,9 @@ type JWTConfiguration struct { noSmithyDocumentSerde } -// 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) -// . +// Represents a data model for an API. Supported only for WebSocket APIs. See [Create Models and Mapping Templates for Request and Response Mappings]. +// +// [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. diff --git a/service/appconfig/api_op_CreateConfigurationProfile.go b/service/appconfig/api_op_CreateConfigurationProfile.go index ca5c5863b97..6b5c3e959ea 100644 --- a/service/appconfig/api_op_CreateConfigurationProfile.go +++ b/service/appconfig/api_op_CreateConfigurationProfile.go @@ -14,26 +14,36 @@ 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 // // 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. // -// 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. +// For more information, see [Create a Configuration and a Configuration Profile] in the AppConfig User Guide. +// +// [Create a Configuration and a Configuration Profile]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html func (c *Client) CreateConfigurationProfile(ctx context.Context, params *CreateConfigurationProfileInput, optFns ...func(*Options)) (*CreateConfigurationProfileOutput, error) { if params == nil { params = &CreateConfigurationProfileInput{} @@ -57,16 +67,22 @@ 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 Amazon Web Services CodePipeline pipeline, specify the URI in the // following format: codepipeline ://. + // // - For an Secrets Manager secret, specify the URI in the following format: // secretsmanager ://. + // // - 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). // @@ -90,9 +106,11 @@ type CreateConfigurationProfileInput struct { KmsKeyIdentifier *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 - // stored in the AppConfig hosted configuration store. It is required for all other - // sources that store your configuration. + // 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 // Metadata to assign to the configuration profile. Tags help organize and @@ -104,7 +122,10 @@ 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 @@ -150,7 +171,10 @@ type CreateConfigurationProfileOutput 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 diff --git a/service/appconfig/api_op_CreateDeploymentStrategy.go b/service/appconfig/api_op_CreateDeploymentStrategy.go index cc1056c4903..759633856a3 100644 --- a/service/appconfig/api_op_CreateDeploymentStrategy.go +++ b/service/appconfig/api_op_CreateDeploymentStrategy.go @@ -56,27 +56,37 @@ type CreateDeploymentStrategyInput struct { // after the configuration has been deployed to 100% of its targets, before // 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) - // in the AppConfig User Guide. + // AppConfig to roll back based on CloudWatch alarms. For more information, see [Configuring permissions for rollback based on Amazon CloudWatch alarms]in + // the AppConfig User Guide. + // + // [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 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 - // configuration. Exponential: For this type, AppConfig processes the 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) + // 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 configuration. + // + // Exponential: For this type, AppConfig processes the 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 // Save the deployment strategy to a Systems Manager (SSM) document. diff --git a/service/appconfig/api_op_CreateExtension.go b/service/appconfig/api_op_CreateExtension.go index 94927543d20..75c9c7b3e60 100644 --- a/service/appconfig/api_op_CreateExtension.go +++ b/service/appconfig/api_op_CreateExtension.go @@ -13,22 +13,27 @@ import ( // Creates an AppConfig extension. An extension augments your ability to inject // logic or behavior at different points during the AppConfig workflow of creating -// or deploying a configuration. You can create your own extensions or use the -// Amazon Web Services authored extensions provided by AppConfig. For an AppConfig -// extension that uses Lambda, you must create a Lambda function to perform any -// computation and processing defined in the extension. If you plan to create -// custom versions of the Amazon Web Services authored notification extensions, you -// only need to specify an Amazon Resource Name (ARN) in the Uri field for the new -// extension version. +// or deploying a configuration. +// +// You can create your own extensions or use the Amazon Web Services authored +// extensions provided by AppConfig. For an AppConfig extension that uses Lambda, +// you must create a Lambda function to perform any computation and processing +// defined in the extension. If you plan to create custom versions of the Amazon +// Web Services authored notification extensions, you only need to specify an +// Amazon Resource Name (ARN) in the Uri field for the new extension version. +// // - For a custom EventBridge notification extension, enter the ARN of the // EventBridge default events in the Uri field. +// // - For a custom Amazon SNS notification extension, enter the ARN of an Amazon // SNS topic in the Uri field. +// // - For a custom Amazon SQS notification extension, enter the ARN of an Amazon // SQS message queue in the Uri field. // -// For more information about extensions, see Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// For more information about extensions, see [Extending workflows] in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) CreateExtension(ctx context.Context, params *CreateExtensionInput, optFns ...func(*Options)) (*CreateExtensionOutput, error) { if params == nil { params = &CreateExtensionInput{} diff --git a/service/appconfig/api_op_CreateExtensionAssociation.go b/service/appconfig/api_op_CreateExtensionAssociation.go index ec8365fcbe5..9614f6cd400 100644 --- a/service/appconfig/api_op_CreateExtensionAssociation.go +++ b/service/appconfig/api_op_CreateExtensionAssociation.go @@ -19,8 +19,9 @@ import ( // associate with an AppConfig resource is called an extension association. An // 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 Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// information about extensions and associations, see [Extending workflows]in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) CreateExtensionAssociation(ctx context.Context, params *CreateExtensionAssociationInput, optFns ...func(*Options)) (*CreateExtensionAssociationOutput, error) { if params == nil { params = &CreateExtensionAssociationInput{} diff --git a/service/appconfig/api_op_CreateHostedConfigurationVersion.go b/service/appconfig/api_op_CreateHostedConfigurationVersion.go index 6a3c0a5e1d7..911896fd66d 100644 --- a/service/appconfig/api_op_CreateHostedConfigurationVersion.go +++ b/service/appconfig/api_op_CreateHostedConfigurationVersion.go @@ -44,8 +44,9 @@ 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]. + // + // [Content-Type]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 // // This member is required. ContentType *string @@ -80,8 +81,9 @@ 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]. + // + // [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_GetConfiguration.go b/service/appconfig/api_op_GetConfiguration.go index 0a781b8f59f..2a40215d31b 100644 --- a/service/appconfig/api_op_GetConfiguration.go +++ b/service/appconfig/api_op_GetConfiguration.go @@ -10,17 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// (Deprecated) Retrieves the latest deployed configuration. Note the following -// important information. +// (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/) -// . +// use the [StartConfigurationSession]and [GetLatestConfiguration]APIs instead. +// +// - GetConfiguration is a priced call. For more information, see [Pricing]. // // Deprecated: This API has been deprecated in favor of the GetLatestConfiguration // API used in conjunction with StartConfigurationSession. +// +// [GetLatestConfiguration]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html +// [StartConfigurationSession]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html +// [Pricing]: https://aws.amazon.com/systems-manager/pricing/ func (c *Client) GetConfiguration(ctx context.Context, params *GetConfigurationInput, optFns ...func(*Options)) (*GetConfigurationOutput, error) { if params == nil { params = &GetConfigurationInput{} @@ -63,22 +67,28 @@ 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 + // 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) - // 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 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) - // in the AppConfig User Guide. + // receive a configuration. + // + // To avoid excess charges, we recommend you use the [StartConfigurationSession] and [GetLatestConfiguration] 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 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] in the AppConfig + // User Guide. + // + // [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 + // [Retrieving the Configuration]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html ClientConfigurationVersion *string noSmithyDocumentSerde @@ -89,16 +99,19 @@ type GetConfigurationOutput struct { // The configuration version. ConfigurationVersion *string - // The content of the configuration or the configuration data. The Content - // attribute only contains data if the system finds new or updated configuration - // data. If there is no new or updated data and ClientConfigurationVersion matches - // the version of the current configuration, AppConfig returns a 204 No Content - // HTTP response code and the Content value will be empty. + // The content of the configuration or the configuration data. + // + // The Content attribute only contains data if the system finds new or updated + // configuration data. If there is no new or updated data and + // ClientConfigurationVersion matches the version of the current configuration, + // AppConfig returns a 204 No Content HTTP response code and the Content value + // will be empty. 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]. + // + // [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 0a9cf04de47..bb22a999359 100644 --- a/service/appconfig/api_op_GetConfigurationProfile.go +++ b/service/appconfig/api_op_GetConfigurationProfile.go @@ -79,7 +79,10 @@ type GetConfigurationProfileOutput 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 diff --git a/service/appconfig/api_op_GetExtensionAssociation.go b/service/appconfig/api_op_GetExtensionAssociation.go index 8f4422de9f4..08ec0302ada 100644 --- a/service/appconfig/api_op_GetExtensionAssociation.go +++ b/service/appconfig/api_op_GetExtensionAssociation.go @@ -11,8 +11,9 @@ import ( ) // Returns information about an AppConfig extension association. For more -// information about extensions and associations, see Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// information about extensions and associations, see [Extending workflows]in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) GetExtensionAssociation(ctx context.Context, params *GetExtensionAssociationInput, optFns ...func(*Options)) (*GetExtensionAssociationOutput, error) { if params == nil { params = &GetExtensionAssociationInput{} diff --git a/service/appconfig/api_op_GetHostedConfigurationVersion.go b/service/appconfig/api_op_GetHostedConfigurationVersion.go index 190e72224f3..a268cb83832 100644 --- a/service/appconfig/api_op_GetHostedConfigurationVersion.go +++ b/service/appconfig/api_op_GetHostedConfigurationVersion.go @@ -58,8 +58,9 @@ 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]. + // + // [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 ced4488a85d..95f993b50fa 100644 --- a/service/appconfig/api_op_ListExtensionAssociations.go +++ b/service/appconfig/api_op_ListExtensionAssociations.go @@ -12,8 +12,9 @@ import ( ) // Lists all AppConfig extension associations in the account. For more information -// about extensions and associations, see Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// about extensions and associations, see [Extending workflows]in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) ListExtensionAssociations(ctx context.Context, params *ListExtensionAssociationsInput, optFns ...func(*Options)) (*ListExtensionAssociationsOutput, error) { if params == nil { params = &ListExtensionAssociationsInput{} diff --git a/service/appconfig/api_op_ListExtensions.go b/service/appconfig/api_op_ListExtensions.go index c27a55c78ae..251a00cca44 100644 --- a/service/appconfig/api_op_ListExtensions.go +++ b/service/appconfig/api_op_ListExtensions.go @@ -12,8 +12,9 @@ import ( ) // Lists all custom and Amazon Web Services authored AppConfig extensions in the -// account. For more information about extensions, see Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// account. For more information about extensions, see [Extending workflows]in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) ListExtensions(ctx context.Context, params *ListExtensionsInput, optFns ...func(*Options)) (*ListExtensionsOutput, error) { if params == nil { params = &ListExtensionsInput{} diff --git a/service/appconfig/api_op_UpdateConfigurationProfile.go b/service/appconfig/api_op_UpdateConfigurationProfile.go index a57b22f2f4f..6d66def2cdc 100644 --- a/service/appconfig/api_op_UpdateConfigurationProfile.go +++ b/service/appconfig/api_op_UpdateConfigurationProfile.go @@ -99,7 +99,10 @@ type UpdateConfigurationProfileOutput 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 diff --git a/service/appconfig/api_op_UpdateDeploymentStrategy.go b/service/appconfig/api_op_UpdateDeploymentStrategy.go index 002951b8931..9bb9d94f2d6 100644 --- a/service/appconfig/api_op_UpdateDeploymentStrategy.go +++ b/service/appconfig/api_op_UpdateDeploymentStrategy.go @@ -49,22 +49,30 @@ type UpdateDeploymentStrategyInput struct { GrowthFactor *float32 // 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 increments of the growth factor evenly distributed over the - // deployment time. For example, a linear deployment that uses a growth factor of - // 20 initially makes the configuration available to 20 percent of the targets. - // 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, - // 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) + // the following growth types: + // + // Linear: For this type, AppConfig processes the deployment by increments of the + // growth factor evenly distributed over the deployment time. For example, a linear + // deployment that uses a growth factor of 20 initially makes the configuration + // available to 20 percent of the targets. 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, 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_UpdateExtension.go b/service/appconfig/api_op_UpdateExtension.go index fe70d23ae09..33b403447e7 100644 --- a/service/appconfig/api_op_UpdateExtension.go +++ b/service/appconfig/api_op_UpdateExtension.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an AppConfig extension. For more information about extensions, see -// Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// Updates an AppConfig extension. For more information about extensions, see [Extending workflows] in +// the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) UpdateExtension(ctx context.Context, params *UpdateExtensionInput, optFns ...func(*Options)) (*UpdateExtensionOutput, error) { if params == nil { params = &UpdateExtensionInput{} diff --git a/service/appconfig/api_op_UpdateExtensionAssociation.go b/service/appconfig/api_op_UpdateExtensionAssociation.go index d1b1ceefdd4..f65aebd9dc2 100644 --- a/service/appconfig/api_op_UpdateExtensionAssociation.go +++ b/service/appconfig/api_op_UpdateExtensionAssociation.go @@ -11,8 +11,9 @@ import ( ) // Updates an association. For more information about extensions and associations, -// see Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// see [Extending workflows]in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html func (c *Client) UpdateExtensionAssociation(ctx context.Context, params *UpdateExtensionAssociationInput, optFns ...func(*Options)) (*UpdateExtensionAssociationOutput, error) { if params == nil { params = &UpdateExtensionAssociationInput{} diff --git a/service/appconfig/doc.go b/service/appconfig/doc.go index e6f6dfff3cf..424add905f9 100644 --- a/service/appconfig/doc.go +++ b/service/appconfig/doc.go @@ -12,83 +12,116 @@ // capabilities to all users. With operational flags and dynamic configurations, // you can update block lists, allow lists, throttling limits, logging verbosity, // and perform other operational tuning to quickly respond to issues in production -// environments. AppConfig is a capability of Amazon Web Services Systems Manager. +// environments. +// +// AppConfig is a capability of Amazon Web Services Systems Manager. +// // Despite the fact that application configuration content can vary greatly from // application to application, AppConfig supports the following use cases, which // cover a broad spectrum of customer needs: +// // - Feature flags and toggles - Safely release new capabilities to your // customers in a controlled environment. Instantly roll back changes if you // experience a problem. +// // - Application tuning - Carefully introduce application changes while testing // the impact of those changes with users in production environments. +// // - Allow list or block list - Control access to premium features or instantly // block specific users without deploying new code. +// // - Centralized configuration storage - Keep your configuration data organized // and consistent across all of your workloads. You can use AppConfig to deploy // configuration data stored in the AppConfig hosted configuration store, Secrets // Manager, Systems Manager, Parameter Store, or Amazon S3. // -// How AppConfig works This section provides a high-level description of how -// AppConfig works and how you get started. 1. Identify configuration values in -// code you want to manage in the cloud Before you start creating AppConfig -// artifacts, we recommend you identify configuration data in your code that you -// want to dynamically manage using AppConfig. Good examples include feature flags -// or toggles, allow and block lists, logging verbosity, service limits, and -// throttling rules, to name a few. If your configuration data already exists in -// the cloud, you can take advantage of AppConfig validation, deployment, and -// extension features to further streamline configuration data management. 2. -// Create an application namespace To create a namespace, you create an AppConfig -// artifact called an application. An application is simply an organizational -// construct like a folder. 3. Create environments For each AppConfig application, -// you define one or more environments. An environment is a logical grouping of -// targets, such as applications in a Beta or Production environment, Lambda -// functions, or containers. You can also define environments for application -// subcomponents, such as the Web , Mobile , and Back-end . 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. 4. Create a configuration profile A configuration profile -// includes, among other things, a URI that enables AppConfig to locate your -// configuration data in its stored location and a profile type. AppConfig supports -// two configuration profile types: feature flags and freeform configurations. -// Feature flag configuration profiles store their data in the AppConfig hosted -// configuration store and the URI is simply hosted . For freeform configuration -// profiles, you can store your data in the AppConfig hosted configuration store or -// any Amazon Web Services service that integrates with AppConfig, as described in -// Creating a free form configuration profile (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-free-form-configurations-creating.html) -// in the the AppConfig User Guide. A configuration profile can also include -// optional validators to ensure your configuration data is syntactically and -// semantically correct. AppConfig performs a check using the validators when you -// start a deployment. If any errors are detected, the deployment rolls back to the -// previous configuration data. 5. Deploy configuration data When you create a new -// deployment, you specify the following: +// # How AppConfig works +// +// This section provides a high-level description of how AppConfig works and how +// you get started. +// +// 1. Identify configuration values in code you want to manage in the cloud Before +// you start creating AppConfig artifacts, we recommend you identify configuration +// data in your code that you want to dynamically manage using AppConfig. Good +// examples include feature flags or toggles, allow and block lists, logging +// verbosity, service limits, and throttling rules, to name a few. +// +// If your configuration data already exists in the cloud, you can take advantage +// of AppConfig validation, deployment, and extension features to further +// streamline configuration data management. +// +// 2. Create an application namespace To create a namespace, you create an +// AppConfig artifact called an application. An application is simply an +// organizational construct like a folder. +// +// 3. Create environments For each AppConfig application, you define one or more +// environments. An environment is a logical grouping of targets, such as +// applications in a Beta or Production environment, Lambda functions, or +// containers. You can also define environments for application subcomponents, such +// as the Web , Mobile , and Back-end . +// +// 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. +// +// 4. Create a configuration profile A configuration profile includes, among other +// things, a URI that enables AppConfig to locate your configuration data in its +// stored location and a profile type. AppConfig supports two configuration profile +// types: feature flags and freeform configurations. Feature flag configuration +// profiles store their data in the AppConfig hosted configuration store and the +// URI is simply hosted . For freeform configuration profiles, you can store your +// data in the AppConfig hosted configuration store or any Amazon Web Services +// service that integrates with AppConfig, as described in [Creating a free form configuration profile]in the the AppConfig +// User Guide. +// +// A configuration profile can also include optional validators to ensure your +// configuration data is syntactically and semantically correct. AppConfig performs +// a check using the validators when you start a deployment. If any errors are +// detected, the deployment rolls back to the previous configuration data. +// +// 5. Deploy configuration data When you create a new deployment, you specify the +// following: +// // - An application ID +// // - A configuration profile ID +// // - A configuration version +// // - An environment ID where you want to deploy the configuration data +// // - A deployment strategy ID that defines how fast you want the changes to take // effect // -// When you call the StartDeployment (https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_StartDeployment.html) -// API action, AppConfig performs the following tasks: +// When you call the [StartDeployment] API action, AppConfig performs the following tasks: +// // - Retrieves the configuration data from the underlying data store by using // the location URI in the configuration profile. +// // - Verifies the configuration data is syntactically and semantically correct // by using the validators you specified when you created your configuration // profile. +// // - Caches a copy of the data so it is ready to be retrieved by your // application. This cached copy is called the deployed data. // // 6. Retrieve the configuration You can configure AppConfig Agent as a local host // and have the agent poll AppConfig for configuration updates. The agent calls 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) -// API actions and caches your configuration data locally. To retrieve the data, -// your application makes an HTTP call to the localhost server. AppConfig Agent -// supports several use cases, as described in Simplified retrieval methods (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-simplified-methods.html) -// in the the AppConfig User Guide. If AppConfig Agent isn't supported for your use -// case, you can configure your application to poll AppConfig for configuration -// updates by directly calling 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) -// API actions. This reference is intended to be used with the AppConfig User Guide (http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) -// . +// [StartConfigurationSession]and [GetLatestConfiguration] API actions and caches your configuration data locally. To retrieve the +// data, your application makes an HTTP call to the localhost server. AppConfig +// Agent supports several use cases, as described in [Simplified retrieval methods]in the the AppConfig User +// Guide. +// +// If AppConfig Agent isn't supported for your use case, you can configure your +// application to poll AppConfig for configuration updates by directly calling the [StartConfigurationSession] +// and [GetLatestConfiguration]API actions. +// +// This reference is intended to be used with the [AppConfig User Guide]. +// +// [AppConfig User Guide]: http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html +// [GetLatestConfiguration]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html +// [StartConfigurationSession]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html +// [StartDeployment]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_StartDeployment.html +// [Creating a free form configuration profile]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-free-form-configurations-creating.html +// [Simplified retrieval methods]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-simplified-methods.html package appconfig diff --git a/service/appconfig/options.go b/service/appconfig/options.go index a9c45e0c8bb..bc024b8a0b6 100644 --- a/service/appconfig/options.go +++ b/service/appconfig/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appconfig/types/enums.go b/service/appconfig/types/enums.go index 4063199362e..9a0467985d1 100644 --- a/service/appconfig/types/enums.go +++ b/service/appconfig/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for ActionPoint. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionPoint) Values() []ActionPoint { return []ActionPoint{ "PRE_CREATE_HOSTED_CONFIGURATION_VERSION", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for BadRequestReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BadRequestReason) Values() []BadRequestReason { return []BadRequestReason{ "InvalidConfiguration", @@ -54,8 +56,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -75,8 +78,9 @@ const ( ) // Values returns all known values for DeploymentEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentEventType) Values() []DeploymentEventType { return []DeploymentEventType{ "PERCENTAGE_UPDATED", @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for DeploymentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentState) Values() []DeploymentState { return []DeploymentState{ "BAKING", @@ -125,8 +130,9 @@ const ( ) // Values returns all known values for EnvironmentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentState) Values() []EnvironmentState { return []EnvironmentState{ "READY_FOR_DEPLOYMENT", @@ -145,8 +151,9 @@ const ( ) // Values returns all known values for GrowthType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GrowthType) Values() []GrowthType { return []GrowthType{ "LINEAR", @@ -163,8 +170,9 @@ const ( ) // Values returns all known values for ReplicateTo. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicateTo) Values() []ReplicateTo { return []ReplicateTo{ "NONE", @@ -183,8 +191,9 @@ const ( ) // Values returns all known values for TriggeredBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggeredBy) Values() []TriggeredBy { return []TriggeredBy{ "USER", @@ -203,8 +212,9 @@ const ( ) // Values returns all known values for ValidatorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidatorType) Values() []ValidatorType { return []ValidatorType{ "JSON_SCHEMA", diff --git a/service/appconfig/types/errors.go b/service/appconfig/types/errors.go index 8775198c82d..50f840d8594 100644 --- a/service/appconfig/types/errors.go +++ b/service/appconfig/types/errors.go @@ -149,13 +149,21 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of one more AppConfig resources exceeds the maximum allowed. Verify -// that your environment doesn't exceed the following service quotas: Applications: -// 100 max Deployment strategies: 20 max Configuration profiles: 100 max per -// application Environments: 20 max per application To resolve this issue, you can -// delete one or more resources and try again. Or, you can request a quota -// increase. For more information about quotas and to request an increase, see -// Service quotas for AppConfig (https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig) -// in the Amazon Web Services General Reference. +// that your environment doesn't exceed the following service quotas: +// +// Applications: 100 max +// +// Deployment strategies: 20 max +// +// Configuration profiles: 100 max per application +// +// Environments: 20 max per application +// +// To resolve this issue, you can delete one or more resources and try again. Or, +// you can request a quota increase. For more information about quotas and to +// request an increase, see [Service quotas for AppConfig]in the Amazon Web Services General Reference. +// +// [Service quotas for AppConfig]: https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig type ServiceQuotaExceededException struct { Message *string diff --git a/service/appconfig/types/types.go b/service/appconfig/types/types.go index 7bfa00a73d1..8cb29f62aee 100644 --- a/service/appconfig/types/types.go +++ b/service/appconfig/types/types.go @@ -14,12 +14,19 @@ import ( // (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 type Action struct { @@ -142,7 +149,10 @@ 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 @@ -160,9 +170,12 @@ type DeploymentEvent struct { // A description of the deployment event. Descriptions include, but are not // limited to, the following: + // // - The Amazon Web Services account or the Amazon CloudWatch alarm ARN that // initiated a rollback. + // // - The percentage of hosts that received the deployment. + // // - A recommendation to attempt a new deployment (in the case of an internal // error). Description *string @@ -332,8 +345,9 @@ 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]. + // + // [Content-Type]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17 ContentType *string // A description of the configuration. @@ -396,8 +410,9 @@ 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 Extending workflows (https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html) -// in the AppConfig User Guide. +// see [Extending workflows]in the AppConfig User Guide. +// +// [Extending workflows]: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html type Parameter struct { // Information about the parameter. diff --git a/service/appconfigdata/api_op_GetLatestConfiguration.go b/service/appconfigdata/api_op_GetLatestConfiguration.go index c861dc431a8..cdddb68c338 100644 --- a/service/appconfigdata/api_op_GetLatestConfiguration.go +++ b/service/appconfigdata/api_op_GetLatestConfiguration.go @@ -13,15 +13,19 @@ import ( // Retrieves the latest deployed configuration. This API may return empty // 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) -// in the AppConfig User Guide. Note the following important information. +// to use it with the StartConfigurationSessionAPI action, see [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/) -// . +// +// - GetLatestConfiguration is a priced call. For more information, see [Pricing]. +// +// [Pricing]: https://aws.amazon.com/systems-manager/pricing/ +// [Retrieving the configuration]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration func (c *Client) GetLatestConfiguration(ctx context.Context, params *GetLatestConfigurationInput, optFns ...func(*Options)) (*GetLatestConfigurationOutput, error) { if params == nil { params = &GetLatestConfigurationInput{} @@ -40,13 +44,13 @@ func (c *Client) GetLatestConfiguration(ctx context.Context, params *GetLatestCo 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 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 . + // token, first call the StartConfigurationSessionAPI. Note that every call to 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 . // // This member is required. ConfigurationToken *string @@ -64,10 +68,11 @@ type GetLatestConfigurationOutput struct { 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 . + // 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 f23a45268d3..41cb5dda09b 100644 --- a/service/appconfigdata/api_op_StartConfigurationSession.go +++ b/service/appconfigdata/api_op_StartConfigurationSession.go @@ -12,9 +12,9 @@ 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) -// in the AppConfig User Guide. +// show how to use it with the GetLatestConfigurationAPI action, see [Retrieving the configuration] in the AppConfig User Guide. +// +// [Retrieving the configuration]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration func (c *Client) StartConfigurationSession(ctx context.Context, params *StartConfigurationSessionInput, optFns ...func(*Options)) (*StartConfigurationSessionOutput, error) { if params == nil { params = &StartConfigurationSessionInput{} @@ -48,8 +48,8 @@ type StartConfigurationSessionInput struct { EnvironmentIdentifier *string // Sets a constraint on a session. If you specify a value of, for example, 60 - // seconds, then the client that established the session can't call - // GetLatestConfiguration more frequently than every 60 seconds. + // seconds, then the client that established the session can't call GetLatestConfigurationmore + // frequently than every 60 seconds. RequiredMinimumPollIntervalInSeconds *int32 noSmithyDocumentSerde @@ -58,10 +58,12 @@ 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 ( + // 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 diff --git a/service/appconfigdata/doc.go b/service/appconfigdata/doc.go index 70a95261b9c..17f82e219cf 100644 --- a/service/appconfigdata/doc.go +++ b/service/appconfigdata/doc.go @@ -4,40 +4,52 @@ // for AWS AppConfig Data. // // AppConfig Data provides the data plane APIs your application uses to retrieve -// configuration data. Here's how it works: Your application retrieves -// 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 -// the following information: +// configuration data. Here's how it works: +// +// Your application retrieves configuration data by first establishing a +// configuration session using the AppConfig Data StartConfigurationSessionAPI action. Your session's +// client then makes periodic calls to GetLatestConfigurationto check for and retrieve the 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: +// 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. +// 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] in the AppConfig User Guide. +// +// [Retrieving the configuration]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration package appconfigdata diff --git a/service/appconfigdata/options.go b/service/appconfigdata/options.go index fb71991d3ed..7c7cb3132f9 100644 --- a/service/appconfigdata/options.go +++ b/service/appconfigdata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appconfigdata/types/enums.go b/service/appconfigdata/types/enums.go index 897bef4d417..a268bd4e5bd 100644 --- a/service/appconfigdata/types/enums.go +++ b/service/appconfigdata/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for BadRequestReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BadRequestReason) Values() []BadRequestReason { return []BadRequestReason{ "InvalidParameters", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for InvalidParameterProblem. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvalidParameterProblem) Values() []InvalidParameterProblem { return []InvalidParameterProblem{ "Corrupted", @@ -60,8 +62,9 @@ const ( ) // 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. +// expanded in the future, and so 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/appfabric/api_op_BatchGetUserAccessTasks.go b/service/appfabric/api_op_BatchGetUserAccessTasks.go index 0ffa7824a9d..4f21a4dfddc 100644 --- a/service/appfabric/api_op_BatchGetUserAccessTasks.go +++ b/service/appfabric/api_op_BatchGetUserAccessTasks.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets user access details in a batch request. This action polls data from the -// tasks that are kicked off by the StartUserAccessTasks action. +// Gets user access details in a batch request. +// +// This action polls data from the tasks that are kicked off by the +// StartUserAccessTasks action. func (c *Client) BatchGetUserAccessTasks(ctx context.Context, params *BatchGetUserAccessTasksInput, optFns ...func(*Options)) (*BatchGetUserAccessTasksOutput, error) { if params == nil { params = &BatchGetUserAccessTasksInput{} diff --git a/service/appfabric/api_op_ConnectAppAuthorization.go b/service/appfabric/api_op_ConnectAppAuthorization.go index 7b04b65f1de..b7b5986aa7b 100644 --- a/service/appfabric/api_op_ConnectAppAuthorization.go +++ b/service/appfabric/api_op_ConnectAppAuthorization.go @@ -42,9 +42,10 @@ type ConnectAppAuthorizationInput struct { // This member is required. AppBundleIdentifier *string - // Contains OAuth2 authorization information. This is required if the app - // authorization for the request is configured with an OAuth2 ( oauth2 ) - // authorization type. + // Contains OAuth2 authorization information. + // + // This is required if the app authorization for the request is configured with an + // OAuth2 ( oauth2 ) authorization type. AuthRequest *types.AuthRequest noSmithyDocumentSerde diff --git a/service/appfabric/api_op_CreateAppAuthorization.go b/service/appfabric/api_op_CreateAppAuthorization.go index 6b216ecc07e..2782a649922 100644 --- a/service/appfabric/api_op_CreateAppAuthorization.go +++ b/service/appfabric/api_op_CreateAppAuthorization.go @@ -30,18 +30,32 @@ func (c *Client) CreateAppAuthorization(ctx context.Context, params *CreateAppAu type CreateAppAuthorizationInput struct { - // The name of the application. Valid values are: + // The name of the application. + // + // Valid values are: + // // - SLACK + // // - ASANA + // // - JIRA + // // - M365 + // // - M365AUDITLOGS + // // - ZOOM + // // - ZENDESK + // // - OKTA + // // - GOOGLE + // // - DROPBOX + // // - SMARTSHEET + // // - CISCO // // This member is required. @@ -59,9 +73,11 @@ type CreateAppAuthorizationInput struct { AuthType types.AuthType // Contains credentials for the application, such as an API key or OAuth2 client - // ID and secret. Specify credentials that match the authorization type for your - // request. For example, if the authorization type for your request is OAuth2 ( - // oauth2 ), then you should provide only the OAuth2 credentials. + // ID and secret. + // + // Specify credentials that match the authorization type for your request. For + // example, if the authorization type for your request is OAuth2 ( oauth2 ), then + // you should provide only the OAuth2 credentials. // // This member is required. Credential types.Credential @@ -76,10 +92,15 @@ type CreateAppAuthorizationInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // A map of the key-value pairs of the tag or tags to assign to the resource. diff --git a/service/appfabric/api_op_CreateAppBundle.go b/service/appfabric/api_op_CreateAppBundle.go index ced22ca65ed..2034305adf9 100644 --- a/service/appfabric/api_op_CreateAppBundle.go +++ b/service/appfabric/api_op_CreateAppBundle.go @@ -33,10 +33,15 @@ type CreateAppBundleInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use diff --git a/service/appfabric/api_op_CreateIngestion.go b/service/appfabric/api_op_CreateIngestion.go index de933c30c28..08b1afc8bf1 100644 --- a/service/appfabric/api_op_CreateIngestion.go +++ b/service/appfabric/api_op_CreateIngestion.go @@ -29,18 +29,32 @@ func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInp type CreateIngestionInput struct { - // The name of the application. Valid values are: + // The name of the application. + // + // Valid values are: + // // - SLACK + // // - ASANA + // // - JIRA + // // - M365 + // // - M365AUDITLOGS + // // - ZOOM + // // - ZENDESK + // // - OKTA + // // - GOOGLE + // // - DROPBOX + // // - SMARTSHEET + // // - CISCO // // This member is required. @@ -66,10 +80,15 @@ type CreateIngestionInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // A map of the key-value pairs of the tag or tags to assign to the resource. diff --git a/service/appfabric/api_op_CreateIngestionDestination.go b/service/appfabric/api_op_CreateIngestionDestination.go index e5fc9d524ce..b11caa6099b 100644 --- a/service/appfabric/api_op_CreateIngestionDestination.go +++ b/service/appfabric/api_op_CreateIngestionDestination.go @@ -56,10 +56,15 @@ type CreateIngestionDestinationInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // A map of the key-value pairs of the tag or tags to assign to the resource. diff --git a/service/appfabric/api_op_DeleteIngestionDestination.go b/service/appfabric/api_op_DeleteIngestionDestination.go index 75a26dcad0f..2de9c3024e1 100644 --- a/service/appfabric/api_op_DeleteIngestionDestination.go +++ b/service/appfabric/api_op_DeleteIngestionDestination.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an ingestion destination. This deletes the association between an -// ingestion and it's destination. It doesn't delete previously ingested data or -// the storage destination, such as the Amazon S3 bucket where the data is -// delivered. If the ingestion destination is deleted while the associated -// ingestion is enabled, the ingestion will fail and is eventually disabled. +// Deletes an ingestion destination. +// +// This deletes the association between an ingestion and it's destination. It +// doesn't delete previously ingested data or the storage destination, such as the +// Amazon S3 bucket where the data is delivered. If the ingestion destination is +// deleted while the associated ingestion is enabled, the ingestion will fail and +// is eventually disabled. func (c *Client) DeleteIngestionDestination(ctx context.Context, params *DeleteIngestionDestinationInput, optFns ...func(*Options)) (*DeleteIngestionDestinationOutput, error) { if params == nil { params = &DeleteIngestionDestinationInput{} diff --git a/service/appfabric/api_op_ListAppAuthorizations.go b/service/appfabric/api_op_ListAppAuthorizations.go index 644b3438434..074fe33775c 100644 --- a/service/appfabric/api_op_ListAppAuthorizations.go +++ b/service/appfabric/api_op_ListAppAuthorizations.go @@ -36,8 +36,10 @@ type ListAppAuthorizationsInput struct { AppBundleIdentifier *string // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -161,8 +163,10 @@ var _ ListAppAuthorizationsAPIClient = (*Client)(nil) // ListAppAuthorizations type ListAppAuthorizationsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appfabric/api_op_ListAppBundles.go b/service/appfabric/api_op_ListAppBundles.go index f1392a149d5..c258fb7ade4 100644 --- a/service/appfabric/api_op_ListAppBundles.go +++ b/service/appfabric/api_op_ListAppBundles.go @@ -30,8 +30,10 @@ func (c *Client) ListAppBundles(ctx context.Context, params *ListAppBundlesInput type ListAppBundlesInput struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -151,8 +153,10 @@ var _ ListAppBundlesAPIClient = (*Client)(nil) // ListAppBundlesPaginatorOptions is the paginator options for ListAppBundles type ListAppBundlesPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appfabric/api_op_ListIngestionDestinations.go b/service/appfabric/api_op_ListIngestionDestinations.go index aa11d6eaef9..61b1fa37f88 100644 --- a/service/appfabric/api_op_ListIngestionDestinations.go +++ b/service/appfabric/api_op_ListIngestionDestinations.go @@ -42,8 +42,10 @@ type ListIngestionDestinationsInput struct { IngestionIdentifier *string // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -167,8 +169,10 @@ var _ ListIngestionDestinationsAPIClient = (*Client)(nil) // ListIngestionDestinations type ListIngestionDestinationsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appfabric/api_op_ListIngestions.go b/service/appfabric/api_op_ListIngestions.go index 747849ff788..4c04935ff38 100644 --- a/service/appfabric/api_op_ListIngestions.go +++ b/service/appfabric/api_op_ListIngestions.go @@ -36,8 +36,10 @@ type ListIngestionsInput struct { AppBundleIdentifier *string // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -160,8 +162,10 @@ var _ ListIngestionsAPIClient = (*Client)(nil) // ListIngestionsPaginatorOptions is the paginator options for ListIngestions type ListIngestionsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appfabric/api_op_StartUserAccessTasks.go b/service/appfabric/api_op_StartUserAccessTasks.go index f32c1edd461..68f294466ce 100644 --- a/service/appfabric/api_op_StartUserAccessTasks.go +++ b/service/appfabric/api_op_StartUserAccessTasks.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts the tasks to search user access status for a specific email address. The -// tasks are stopped when the user access status data is found. The tasks are +// Starts the tasks to search user access status for a specific email address. +// +// The tasks are stopped when the user access status data is found. The tasks are // terminated when the API calls to the application time out. func (c *Client) StartUserAccessTasks(ctx context.Context, params *StartUserAccessTasksInput, optFns ...func(*Options)) (*StartUserAccessTasksOutput, error) { if params == nil { diff --git a/service/appfabric/api_op_UpdateAppAuthorization.go b/service/appfabric/api_op_UpdateAppAuthorization.go index 9626bc8ee9a..7c08223e40b 100644 --- a/service/appfabric/api_op_UpdateAppAuthorization.go +++ b/service/appfabric/api_op_UpdateAppAuthorization.go @@ -12,8 +12,10 @@ import ( ) // Updates an app authorization within an app bundle, which allows AppFabric to -// connect to an application. If the app authorization was in a connected state, -// updating the app authorization will set it back to a PendingConnect state. +// connect to an application. +// +// If the app authorization was in a connected state, updating the app +// authorization will set it back to a PendingConnect state. func (c *Client) UpdateAppAuthorization(ctx context.Context, params *UpdateAppAuthorizationInput, optFns ...func(*Options)) (*UpdateAppAuthorizationOutput, error) { if params == nil { params = &UpdateAppAuthorizationInput{} @@ -44,10 +46,11 @@ type UpdateAppAuthorizationInput struct { AppBundleIdentifier *string // Contains credentials for the application, such as an API key or OAuth2 client - // ID and secret. Specify credentials that match the authorization type of the app - // authorization to update. For example, if the authorization type of the app - // authorization is OAuth2 ( oauth2 ), then you should provide only the OAuth2 - // credentials. + // ID and secret. + // + // Specify credentials that match the authorization type of the app authorization + // to update. For example, if the authorization type of the app authorization is + // OAuth2 ( oauth2 ), then you should provide only the OAuth2 credentials. Credential types.Credential // Contains information about an application tenant, such as the application diff --git a/service/appfabric/doc.go b/service/appfabric/doc.go index e35136d8662..cb18868127e 100644 --- a/service/appfabric/doc.go +++ b/service/appfabric/doc.go @@ -9,9 +9,10 @@ // complete everyday tasks faster using generative artificial intelligence (AI). // You can use these APIs to complete AppFabric tasks, such as setting up audit log // ingestions or viewing user access. For more information about AppFabric, -// including the required permissions to use the service, see the Amazon Web -// Services AppFabric Administration Guide (https://docs.aws.amazon.com/appfabric/latest/adminguide/) -// . For more information about using the Command Line Interface (CLI) to manage -// your AppFabric resources, see the AppFabric section of the CLI Reference (https://docs.aws.amazon.com/cli/latest/reference/appfabric/index.html) -// . +// including the required permissions to use the service, see the [Amazon Web Services AppFabric Administration Guide]. For more +// information about using the Command Line Interface (CLI) to manage your +// AppFabric resources, see the [AppFabric section of the CLI Reference]. +// +// [AppFabric section of the CLI Reference]: https://docs.aws.amazon.com/cli/latest/reference/appfabric/index.html +// [Amazon Web Services AppFabric Administration Guide]: https://docs.aws.amazon.com/appfabric/latest/adminguide/ package appfabric diff --git a/service/appfabric/options.go b/service/appfabric/options.go index c157deda065..fc5f5d5ec22 100644 --- a/service/appfabric/options.go +++ b/service/appfabric/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appfabric/types/enums.go b/service/appfabric/types/enums.go index 8659288651b..9a12683d558 100644 --- a/service/appfabric/types/enums.go +++ b/service/appfabric/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AppAuthorizationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppAuthorizationStatus) Values() []AppAuthorizationStatus { return []AppAuthorizationStatus{ "PendingConnect", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for AuthType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthType) Values() []AuthType { return []AuthType{ "oauth2", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "json", @@ -70,6 +73,7 @@ const ( // Values returns all known values for IngestionDestinationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IngestionDestinationStatus) Values() []IngestionDestinationStatus { return []IngestionDestinationStatus{ @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for IngestionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionState) Values() []IngestionState { return []IngestionState{ "enabled", @@ -104,8 +109,9 @@ const ( ) // Values returns all known values for IngestionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionType) Values() []IngestionType { return []IngestionType{ "auditLog", @@ -121,8 +127,9 @@ const ( ) // Values returns all known values for Persona. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Persona) Values() []Persona { return []Persona{ "admin", @@ -141,8 +148,9 @@ const ( ) // Values returns all known values for ResultStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResultStatus) Values() []ResultStatus { return []ResultStatus{ "IN_PROGRESS", @@ -161,8 +169,9 @@ const ( ) // Values returns all known values for Schema. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Schema) Values() []Schema { return []Schema{ "ocsf", @@ -182,6 +191,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/appfabric/types/types.go b/service/appfabric/types/types.go index 308c6fbcff4..52d7e5e8a04 100644 --- a/service/appfabric/types/types.go +++ b/service/appfabric/types/types.go @@ -46,15 +46,21 @@ type AppAuthorization struct { // This member is required. CreatedAt *time.Time - // The state of the app authorization. The following states are possible: + // The state of the app authorization. + // + // The following states are possible: + // // - PendingConnect : The initial state of the app authorization. The app // authorization is created but not yet connected. + // // - Connected : The app authorization is connected to the application, and is // ready to be used. + // // - ConnectionValidationFailed : The app authorization received a validation // exception when trying to connect to the application. If the app authorization is // in this state, you should verify the configured credentials and try to connect // the app authorization again. + // // - TokenAutoRotationFailed : AppFabric failed to refresh the access token. If // the app authorization is in this state, you should try to reconnect the app // authorization. @@ -76,7 +82,9 @@ type AppAuthorization struct { // The application URL for the OAuth flow. AuthUrl *string - // The user persona of the app authorization. This field should always be admin . + // The user persona of the app authorization. + // + // This field should always be admin . Persona Persona noSmithyDocumentSerde @@ -100,15 +108,21 @@ type AppAuthorizationSummary struct { // This member is required. AppBundleArn *string - // The state of the app authorization. The following states are possible: + // The state of the app authorization. + // + // The following states are possible: + // // - PendingConnect : The initial state of the app authorization. The app // authorization is created but not yet connected. + // // - Connected : The app authorization is connected to the application, and is // ready to be used. + // // - ConnectionValidationFailed : The app authorization received a validation // exception when trying to connect to the application. If the app authorization is // in this state, you should verify the configured credentials and try to connect // the app authorization again. + // // - TokenAutoRotationFailed : AppFabric failed to refresh the access token. If // the app authorization is in this state, you should try to reconnect the app // authorization. @@ -358,15 +372,20 @@ type IngestionDestination struct { // The timestamp of when the ingestion destination was created. CreatedAt *time.Time - // The state of the ingestion destination. The following states are possible: + // The state of the ingestion destination. + // + // The following states are possible: + // // - Active : The ingestion destination is active and is ready to be used. + // // - Failed : The ingestion destination has failed. If the ingestion destination // is in this state, you should verify the ingestion destination configuration and // try again. Status IngestionDestinationStatus - // The reason for the current status of the ingestion destination. Only present - // when the status of ingestion destination is Failed . + // The reason for the current status of the ingestion destination. + // + // Only present when the status of ingestion destination is Failed . StatusReason *string // The timestamp of when the ingestion destination was last updated. @@ -514,10 +533,16 @@ type UserAccessResultItem struct { // The email address of the target user. Email *string - // The status of the user access result item. The following states are possible: + // The status of the user access result item. + // + // The following states are possible: + // // - IN_PROGRESS : The user access task is in progress. + // // - COMPLETED : The user access task completed successfully. + // // - FAILED : The user access task failed. + // // - EXPIRED : The user access task expired. ResultStatus ResultStatus diff --git a/service/appflow/api_op_CancelFlowExecutions.go b/service/appflow/api_op_CancelFlowExecutions.go index d9b5e95f343..5cbfee5f922 100644 --- a/service/appflow/api_op_CancelFlowExecutions.go +++ b/service/appflow/api_op_CancelFlowExecutions.go @@ -10,22 +10,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels active runs for a flow. You can cancel all of the active runs for a -// flow, or you can cancel specific runs by providing their IDs. You can cancel a -// flow run only when the run is in progress. You can't cancel a run that has -// already completed or failed. You also can't cancel a run that's scheduled to -// occur but hasn't started yet. To prevent a scheduled run, you can deactivate the -// flow with the StopFlow action. You cannot resume a run after you cancel it. +// Cancels active runs for a flow. +// +// You can cancel all of the active runs for a flow, or you can cancel specific +// runs by providing their IDs. +// +// You can cancel a flow run only when the run is in progress. You can't cancel a +// run that has already completed or failed. You also can't cancel a run that's +// scheduled to occur but hasn't started yet. To prevent a scheduled run, you can +// deactivate the flow with the StopFlow action. +// +// You cannot resume a run after you cancel it. +// // When you send your request, the status for each run becomes CancelStarted . When -// the cancellation completes, the status becomes Canceled . When you cancel a run, -// you still incur charges for any data that the run already processed before the -// cancellation. If the run had already written some data to the flow destination, -// then that data remains in the destination. If you configured the flow to use a -// batch API (such as the Salesforce Bulk API 2.0), then the run will finish -// reading or writing its entire batch of data after the cancellation. For these -// operations, the data processing charges for Amazon AppFlow apply. For the -// pricing information, see Amazon AppFlow pricing (http://aws.amazon.com/appflow/pricing/) -// . +// the cancellation completes, the status becomes Canceled . +// +// When you cancel a run, you still incur charges for any data that the run +// already processed before the cancellation. If the run had already written some +// data to the flow destination, then that data remains in the destination. If you +// configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), +// then the run will finish reading or writing its entire batch of data after the +// cancellation. For these operations, the data processing charges for Amazon +// AppFlow apply. For the pricing information, see [Amazon AppFlow pricing]. +// +// [Amazon AppFlow pricing]: http://aws.amazon.com/appflow/pricing/ func (c *Client) CancelFlowExecutions(ctx context.Context, params *CancelFlowExecutionsInput, optFns ...func(*Options)) (*CancelFlowExecutionsOutput, error) { if params == nil { params = &CancelFlowExecutionsInput{} @@ -49,8 +57,10 @@ type CancelFlowExecutionsInput struct { FlowName *string // The ID of each active run to cancel. These runs must belong to the flow you - // specify in your request. If you omit this parameter, your request ends all - // active runs that belong to the flow. + // specify in your request. + // + // If you omit this parameter, your request ends all active runs that belong to + // the flow. ExecutionIds []string noSmithyDocumentSerde diff --git a/service/appflow/api_op_CreateConnectorProfile.go b/service/appflow/api_op_CreateConnectorProfile.go index c08e74b6ae7..f03cb84a140 100644 --- a/service/appflow/api_op_CreateConnectorProfile.go +++ b/service/appflow/api_op_CreateConnectorProfile.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new connector profile associated with your Amazon Web Services +// Creates a new connector profile associated with your Amazon Web Services +// // account. There is a soft quota of 100 connector profiles per Amazon Web Services // account. If you need more connector profiles than this quota allows, you can // submit a request to the Amazon AppFlow team through the Amazon AppFlow support @@ -34,25 +35,25 @@ func (c *Client) CreateConnectorProfile(ctx context.Context, params *CreateConne type CreateConnectorProfileInput struct { - // Indicates the connection mode and specifies whether it is public or private. + // Indicates the connection mode and specifies whether it is public or private. // Private flows use Amazon Web Services PrivateLink to route data over Amazon Web // Services infrastructure without exposing it to the public internet. // // This member is required. ConnectionMode types.ConnectionMode - // Defines the connector-specific configuration and credentials. + // Defines the connector-specific configuration and credentials. // // This member is required. ConnectorProfileConfig *types.ConnectorProfileConfig - // The name of the connector profile. The name is unique for each ConnectorProfile + // The name of the connector profile. The name is unique for each ConnectorProfile // in your Amazon Web Services account. // // This member is required. ConnectorProfileName *string - // The type of connector, such as Salesforce, Amplitude, and so on. + // The type of connector, such as Salesforce, Amplitude, and so on. // // This member is required. ConnectorType types.ConnectorType @@ -60,13 +61,16 @@ type CreateConnectorProfileInput struct { // The clientToken parameter is an idempotency token. It ensures that your // CreateConnectorProfile request completes only once. You choose the value to // pass. For example, if you don't receive a response from your request, you can - // safely retry the request with the same clientToken parameter value. If you omit - // a clientToken value, the Amazon Web Services SDK that you are using inserts a - // value for you. This way, the SDK can safely retry requests multiple times after - // a network error. You must provide your own value for other use cases. If you - // specify input parameters that differ from your first request, an error occurs. - // If you use a different value for clientToken , Amazon AppFlow considers it a new - // call to CreateConnectorProfile . The token is active for 8 hours. + // safely retry the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs. If you use a different value for clientToken , Amazon AppFlow considers + // it a new call to CreateConnectorProfile . The token is active for 8 hours. ClientToken *string // The label of the connector. The label is unique for each ConnectorRegistration @@ -74,7 +78,7 @@ type CreateConnectorProfileInput struct { // connector type/. ConnectorLabel *string - // The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you + // The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you // provide for encryption. This is required if you do not want to use the Amazon // AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses // the Amazon AppFlow-managed KMS key. @@ -85,7 +89,7 @@ type CreateConnectorProfileInput struct { type CreateConnectorProfileOutput struct { - // The Amazon Resource Name (ARN) of the connector profile. + // The Amazon Resource Name (ARN) of the connector profile. ConnectorProfileArn *string // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_CreateFlow.go b/service/appflow/api_op_CreateFlow.go index 0dd6756a7d1..cef4aeec5f1 100644 --- a/service/appflow/api_op_CreateFlow.go +++ b/service/appflow/api_op_CreateFlow.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables your application to create a new flow using Amazon AppFlow. You must +// Enables your application to create a new flow using Amazon AppFlow. You must +// // create a connector profile before calling this API. Please note that the Request // Syntax below shows syntax for multiple destinations, however, you can only // transfer data to one item in this list at a time. Amazon AppFlow does not @@ -33,31 +34,31 @@ func (c *Client) CreateFlow(ctx context.Context, params *CreateFlowInput, optFns type CreateFlowInput struct { - // The configuration that controls how Amazon AppFlow places data in the + // The configuration that controls how Amazon AppFlow places data in the // destination connector. // // This member is required. DestinationFlowConfigList []types.DestinationFlowConfig - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. FlowName *string - // The configuration that controls how Amazon AppFlow retrieves data from the + // The configuration that controls how Amazon AppFlow retrieves data from the // source connector. // // This member is required. SourceFlowConfig *types.SourceFlowConfig - // A list of tasks that Amazon AppFlow performs while transferring the data in the - // flow run. + // A list of tasks that Amazon AppFlow performs while transferring the data in + // the flow run. // // This member is required. Tasks []types.Task - // The trigger settings that determine how and when the flow runs. + // The trigger settings that determine how and when the flow runs. // // This member is required. TriggerConfig *types.TriggerConfig @@ -65,19 +66,22 @@ type CreateFlowInput struct { // The clientToken parameter is an idempotency token. It ensures that your // CreateFlow request completes only once. You choose the value to pass. For // example, if you don't receive a response from your request, you can safely retry - // the request with the same clientToken parameter value. If you omit a clientToken - // value, the Amazon Web Services SDK that you are using inserts a value for you. - // This way, the SDK can safely retry requests multiple times after a network - // error. You must provide your own value for other use cases. If you specify input - // parameters that differ from your first request, an error occurs. If you use a - // different value for clientToken , Amazon AppFlow considers it a new call to - // CreateFlow . The token is active for 8 hours. + // the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs. If you use a different value for clientToken , Amazon AppFlow considers + // it a new call to CreateFlow . The token is active for 8 hours. ClientToken *string - // A description of the flow you want to create. + // A description of the flow you want to create. Description *string - // The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you + // The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you // provide for encryption. This is required if you do not want to use the Amazon // AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses // the Amazon AppFlow-managed KMS key. @@ -88,7 +92,7 @@ type CreateFlowInput struct { // from a flow, it stores metadata in a data catalog. MetadataCatalogConfig *types.MetadataCatalogConfig - // The tags used to organize, track, or control access for your flow. + // The tags used to organize, track, or control access for your flow. Tags map[string]string noSmithyDocumentSerde @@ -96,10 +100,10 @@ type CreateFlowInput struct { type CreateFlowOutput struct { - // The flow's Amazon Resource Name (ARN). + // The flow's Amazon Resource Name (ARN). FlowArn *string - // Indicates the current status of the flow. + // Indicates the current status of the flow. FlowStatus types.FlowStatus // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_DeleteConnectorProfile.go b/service/appflow/api_op_DeleteConnectorProfile.go index c44bb150453..bddc4ff0478 100644 --- a/service/appflow/api_op_DeleteConnectorProfile.go +++ b/service/appflow/api_op_DeleteConnectorProfile.go @@ -28,13 +28,13 @@ func (c *Client) DeleteConnectorProfile(ctx context.Context, params *DeleteConne type DeleteConnectorProfileInput struct { - // The name of the connector profile. The name is unique for each ConnectorProfile + // The name of the connector profile. The name is unique for each ConnectorProfile // in your account. // // This member is required. ConnectorProfileName *string - // Indicates whether Amazon AppFlow should delete the profile, even if it is + // Indicates whether Amazon AppFlow should delete the profile, even if it is // currently in use in one or more flows. ForceDelete bool diff --git a/service/appflow/api_op_DeleteFlow.go b/service/appflow/api_op_DeleteFlow.go index eecc429df44..cb9131e8eed 100644 --- a/service/appflow/api_op_DeleteFlow.go +++ b/service/appflow/api_op_DeleteFlow.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables your application to delete an existing flow. Before deleting the flow, +// Enables your application to delete an existing flow. Before deleting the flow, +// // Amazon AppFlow validates the request by checking the flow configuration and // status. You can delete flows one at a time. func (c *Client) DeleteFlow(ctx context.Context, params *DeleteFlowInput, optFns ...func(*Options)) (*DeleteFlowOutput, error) { @@ -30,13 +31,13 @@ func (c *Client) DeleteFlow(ctx context.Context, params *DeleteFlowInput, optFns type DeleteFlowInput struct { - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. FlowName *string - // Indicates whether Amazon AppFlow should delete the flow, even if it is + // Indicates whether Amazon AppFlow should delete the flow, even if it is // currently in use. ForceDelete bool diff --git a/service/appflow/api_op_DescribeConnectorEntity.go b/service/appflow/api_op_DescribeConnectorEntity.go index f80857c7573..6aea25b6b4c 100644 --- a/service/appflow/api_op_DescribeConnectorEntity.go +++ b/service/appflow/api_op_DescribeConnectorEntity.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides details regarding the entity used with the connector, with a +// Provides details regarding the entity used with the connector, with a +// // description of the data model for each field in that entity. func (c *Client) DescribeConnectorEntity(ctx context.Context, params *DescribeConnectorEntityInput, optFns ...func(*Options)) (*DescribeConnectorEntityOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) DescribeConnectorEntity(ctx context.Context, params *DescribeCo type DescribeConnectorEntityInput struct { - // The entity name for that connector. + // The entity name for that connector. // // This member is required. ConnectorEntityName *string @@ -38,11 +39,11 @@ type DescribeConnectorEntityInput struct { // The version of the API that's used by the connector. ApiVersion *string - // The name of the connector profile. The name is unique for each ConnectorProfile + // The name of the connector profile. The name is unique for each ConnectorProfile // in the Amazon Web Services account. ConnectorProfileName *string - // The type of connector application, such as Salesforce, Amplitude, and so on. + // The type of connector application, such as Salesforce, Amplitude, and so on. ConnectorType types.ConnectorType noSmithyDocumentSerde @@ -50,7 +51,7 @@ type DescribeConnectorEntityInput struct { type DescribeConnectorEntityOutput struct { - // Describes the fields for that connector entity. For example, for an account + // Describes the fields for that connector entity. For example, for an account // entity, the fields would be account name, account ID, and so on. // // This member is required. diff --git a/service/appflow/api_op_DescribeConnectorProfiles.go b/service/appflow/api_op_DescribeConnectorProfiles.go index 48d1661281a..8b11027c20c 100644 --- a/service/appflow/api_op_DescribeConnectorProfiles.go +++ b/service/appflow/api_op_DescribeConnectorProfiles.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of connector-profile details matching the provided +// Returns a list of connector-profile details matching the provided +// // 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. +// 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. func (c *Client) DescribeConnectorProfiles(ctx context.Context, params *DescribeConnectorProfilesInput, optFns ...func(*Options)) (*DescribeConnectorProfilesOutput, error) { if params == nil { params = &DescribeConnectorProfilesInput{} @@ -38,18 +40,18 @@ type DescribeConnectorProfilesInput struct { // connector type/. ConnectorLabel *string - // The name of the connector profile. The name is unique for each ConnectorProfile + // The name of the connector profile. The name is unique for each ConnectorProfile // in the Amazon Web Services account. ConnectorProfileNames []string - // The type of connector, such as Salesforce, Amplitude, and so on. + // 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 + // 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. + // The pagination token for the next page of data. NextToken *string noSmithyDocumentSerde @@ -57,10 +59,10 @@ type DescribeConnectorProfilesInput struct { type DescribeConnectorProfilesOutput struct { - // Returns information about the connector profiles associated with the flow. + // 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 @@ -157,7 +159,7 @@ 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 + // 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 diff --git a/service/appflow/api_op_DescribeConnectors.go b/service/appflow/api_op_DescribeConnectors.go index 6ffc955d60f..783e85f5f73 100644 --- a/service/appflow/api_op_DescribeConnectors.go +++ b/service/appflow/api_op_DescribeConnectors.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the connectors vended by Amazon AppFlow for specified connector +// 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 @@ -34,14 +35,14 @@ func (c *Client) DescribeConnectors(ctx context.Context, params *DescribeConnect type DescribeConnectorsInput struct { - // The type of connector, such as Salesforce, Amplitude, and so on. + // The type of connector, such as Salesforce, Amplitude, and so on. ConnectorTypes []types.ConnectorType // The maximum number of items that should be returned in the result set. The // default is 20. MaxResults *int32 - // The pagination token for the next page of data. + // The pagination token for the next page of data. NextToken *string noSmithyDocumentSerde @@ -49,13 +50,13 @@ type DescribeConnectorsInput struct { type DescribeConnectorsOutput struct { - // The configuration that is applied to the connectors used in the flow. + // The configuration that is applied to the connectors used in the flow. ConnectorConfigurations map[string]types.ConnectorConfiguration // Information about the connectors supported in Amazon AppFlow. Connectors []types.ConnectorDetail - // The pagination token for the next page of data. + // The pagination token for the next page of data. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_DescribeFlow.go b/service/appflow/api_op_DescribeFlow.go index cfc88f6e40e..95413c6ef01 100644 --- a/service/appflow/api_op_DescribeFlow.go +++ b/service/appflow/api_op_DescribeFlow.go @@ -30,7 +30,7 @@ func (c *Client) DescribeFlow(ctx context.Context, params *DescribeFlowInput, op type DescribeFlowInput struct { - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. @@ -41,50 +41,50 @@ type DescribeFlowInput struct { type DescribeFlowOutput struct { - // Specifies when the flow was created. + // Specifies when the flow was created. CreatedAt *time.Time - // The ARN of the user who created the flow. + // The ARN of the user who created the flow. CreatedBy *string - // A description of the flow. + // A description of the flow. Description *string - // The configuration that controls how Amazon AppFlow transfers data to the + // The configuration that controls how Amazon AppFlow transfers data to the // destination connector. DestinationFlowConfigList []types.DestinationFlowConfig - // The flow's Amazon Resource Name (ARN). + // The flow's Amazon Resource Name (ARN). FlowArn *string - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. FlowName *string - // Indicates the current status of the flow. + // Indicates the current status of the flow. FlowStatus types.FlowStatus - // Contains an error message if the flow status is in a suspended or error state. + // Contains an error message if the flow status is in a suspended or error state. // This applies only to scheduled or event-triggered flows. FlowStatusMessage *string - // The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you + // The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you // provide for encryption. This is required if you do not want to use the Amazon // AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses // the Amazon AppFlow-managed KMS key. KmsArn *string - // Describes the details of the most recent flow run. + // Describes the details of the most recent flow run. LastRunExecutionDetails *types.ExecutionDetails // Describes the metadata catalog, metadata table, and data partitions that Amazon // AppFlow used for the associated flow run. LastRunMetadataCatalogDetails []types.MetadataCatalogDetail - // Specifies when the flow was last updated. + // Specifies when the flow was last updated. LastUpdatedAt *time.Time - // Specifies the user name of the account that performed the most recent update. + // Specifies the user name of the account that performed the most recent update. LastUpdatedBy *string // Specifies the configuration that Amazon AppFlow uses when it catalogs the data @@ -95,23 +95,26 @@ 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 SchemaVersion *int64 - // The configuration that controls how Amazon AppFlow retrieves data from the + // The configuration that controls how Amazon AppFlow retrieves data from the // source connector. SourceFlowConfig *types.SourceFlowConfig - // The tags used to organize, track, or control access for your flow. + // The tags used to organize, track, or control access for your flow. Tags map[string]string - // A list of tasks that Amazon AppFlow performs while transferring the data in the - // flow run. + // A list of tasks that Amazon AppFlow performs while transferring the data in + // the flow run. Tasks []types.Task - // The trigger settings that determine how and when the flow runs. + // The trigger settings that determine how and when the flow runs. TriggerConfig *types.TriggerConfig // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_DescribeFlowExecutionRecords.go b/service/appflow/api_op_DescribeFlowExecutionRecords.go index 5ea525d1879..a34b14a0075 100644 --- a/service/appflow/api_op_DescribeFlowExecutionRecords.go +++ b/service/appflow/api_op_DescribeFlowExecutionRecords.go @@ -29,17 +29,17 @@ func (c *Client) DescribeFlowExecutionRecords(ctx context.Context, params *Descr type DescribeFlowExecutionRecordsInput struct { - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. FlowName *string - // Specifies the maximum number of items that should be returned in the result + // 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. + // The pagination token for the next page of data. NextToken *string noSmithyDocumentSerde @@ -47,10 +47,10 @@ type DescribeFlowExecutionRecordsInput struct { type DescribeFlowExecutionRecordsOutput struct { - // Returns a list of all instances when this flow was run. + // Returns a list of all instances when this flow was run. FlowExecutions []types.ExecutionRecord - // The pagination token for the next page of data. + // The pagination token for the next page of data. NextToken *string // Metadata pertaining to the operation's result. @@ -149,7 +149,7 @@ 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 + // 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 diff --git a/service/appflow/api_op_ListConnectorEntities.go b/service/appflow/api_op_ListConnectorEntities.go index 5629c2eeb26..cb8a0a7935f 100644 --- a/service/appflow/api_op_ListConnectorEntities.go +++ b/service/appflow/api_op_ListConnectorEntities.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of available connector entities supported by Amazon AppFlow. +// Returns the list of available connector entities supported by Amazon AppFlow. +// // For example, you can query Salesforce for Account and Opportunity entities, or // query ServiceNow for the Incident entity. func (c *Client) ListConnectorEntities(ctx context.Context, params *ListConnectorEntitiesInput, optFns ...func(*Options)) (*ListConnectorEntitiesOutput, error) { @@ -34,15 +35,15 @@ type ListConnectorEntitiesInput struct { // The version of the API that's used by the connector. ApiVersion *string - // The name of the connector profile. The name is unique for each ConnectorProfile + // The name of the connector profile. The name is unique for each ConnectorProfile // in the Amazon Web Services account, and is used to query the downstream // connector. ConnectorProfileName *string - // The type of connector, such as Salesforce, Amplitude, and so on. + // The type of connector, such as Salesforce, Amplitude, and so on. ConnectorType types.ConnectorType - // This optional parameter is specific to connector implementation. Some + // 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, @@ -63,7 +64,7 @@ type ListConnectorEntitiesInput struct { type ListConnectorEntitiesOutput struct { - // The response of ListConnectorEntities lists entities grouped by category. This + // The response of ListConnectorEntities lists entities grouped by category. This // map's key represents the group name, and its value contains the list of entities // belonging to that group. // diff --git a/service/appflow/api_op_ListFlows.go b/service/appflow/api_op_ListFlows.go index 327fce5042e..523319a020f 100644 --- a/service/appflow/api_op_ListFlows.go +++ b/service/appflow/api_op_ListFlows.go @@ -29,10 +29,11 @@ func (c *Client) ListFlows(ctx context.Context, params *ListFlowsInput, optFns . type ListFlowsInput struct { - // Specifies the maximum number of items that should be returned in the result set. + // Specifies the maximum number of items that should be returned in the result + // set. MaxResults *int32 - // The pagination token for next page of data. + // The pagination token for next page of data. NextToken *string noSmithyDocumentSerde @@ -40,10 +41,10 @@ type ListFlowsInput struct { type ListFlowsOutput struct { - // The list of flows associated with your account. + // The list of flows associated with your account. Flows []types.FlowDefinition - // The pagination token for next page of data. + // The pagination token for next page of data. NextToken *string // Metadata pertaining to the operation's result. @@ -137,7 +138,8 @@ var _ ListFlowsAPIClient = (*Client)(nil) // ListFlowsPaginatorOptions is the paginator options for ListFlows type ListFlowsPaginatorOptions struct { - // Specifies the maximum number of items that should be returned in the result set. + // Specifies the maximum number of items that should be returned in the result + // set. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/appflow/api_op_ListTagsForResource.go b/service/appflow/api_op_ListTagsForResource.go index 47449a75faa..3d6b69c0d2e 100644 --- a/service/appflow/api_op_ListTagsForResource.go +++ b/service/appflow/api_op_ListTagsForResource.go @@ -28,7 +28,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the specified flow. + // The Amazon Resource Name (ARN) of the specified flow. // // This member is required. ResourceArn *string @@ -38,7 +38,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags used to organize, track, or control access for your flow. + // The tags used to organize, track, or control access for your flow. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_RegisterConnector.go b/service/appflow/api_op_RegisterConnector.go index a7b6fe27056..0e5299012c3 100644 --- a/service/appflow/api_op_RegisterConnector.go +++ b/service/appflow/api_op_RegisterConnector.go @@ -34,17 +34,20 @@ type RegisterConnectorInput struct { // The clientToken parameter is an idempotency token. It ensures that your // RegisterConnector request completes only once. You choose the value to pass. For // example, if you don't receive a response from your request, you can safely retry - // the request with the same clientToken parameter value. If you omit a clientToken - // value, the Amazon Web Services SDK that you are using inserts a value for you. - // This way, the SDK can safely retry requests multiple times after a network - // error. You must provide your own value for other use cases. If you specify input - // parameters that differ from your first request, an error occurs. If you use a - // different value for clientToken , Amazon AppFlow considers it a new call to - // RegisterConnector . The token is active for 8 hours. + // the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs. If you use a different value for clientToken , Amazon AppFlow considers + // it a new call to RegisterConnector . The token is active for 8 hours. ClientToken *string - // The name of the connector. The name is unique for each ConnectorRegistration in - // your Amazon Web Services account. + // The name of the connector. The name is unique for each ConnectorRegistration + // in your Amazon Web Services account. ConnectorLabel *string // The provisioning type of the connector. Currently the only supported value is diff --git a/service/appflow/api_op_ResetConnectorMetadataCache.go b/service/appflow/api_op_ResetConnectorMetadataCache.go index 7abe8b4d260..d7b19a8b48d 100644 --- a/service/appflow/api_op_ResetConnectorMetadataCache.go +++ b/service/appflow/api_op_ResetConnectorMetadataCache.go @@ -13,13 +13,14 @@ import ( // Resets metadata about your connector entities that Amazon AppFlow stored in its // cache. Use this action when you want Amazon AppFlow to return the latest -// information about the data that you have in a source application. Amazon AppFlow -// returns metadata about your entities when you use the ListConnectorEntities or -// DescribeConnectorEntities actions. Following these actions, Amazon AppFlow -// caches the metadata to reduce the number of API requests that it must send to -// the source application. Amazon AppFlow automatically resets the cache once every -// hour, but you can use this action when you want to get the latest metadata right -// away. +// information about the data that you have in a source application. +// +// Amazon AppFlow returns metadata about your entities when you use the +// ListConnectorEntities or DescribeConnectorEntities actions. Following these +// actions, Amazon AppFlow caches the metadata to reduce the number of API requests +// that it must send to the source application. Amazon AppFlow automatically resets +// the cache once every hour, but you can use this action when you want to get the +// latest metadata right away. func (c *Client) ResetConnectorMetadataCache(ctx context.Context, params *ResetConnectorMetadataCacheInput, optFns ...func(*Options)) (*ResetConnectorMetadataCacheOutput, error) { if params == nil { params = &ResetConnectorMetadataCacheInput{} @@ -39,42 +40,52 @@ type ResetConnectorMetadataCacheInput struct { // The API version that you specified in the connector profile that you’re // resetting cached metadata for. You must use this parameter only if the connector - // supports multiple API versions or if the connector type is CustomConnector. To - // look up how many versions a connector supports, use the DescribeConnectors + // supports multiple API versions or if the connector type is CustomConnector. + // + // To look up how many versions a connector supports, use the DescribeConnectors // action. In the response, find the value that Amazon AppFlow returns for the - // connectorVersion parameter. To look up the connector type, use the - // DescribeConnectorProfiles action. In the response, find the value that Amazon - // AppFlow returns for the connectorType parameter. To look up the API version that - // you specified in a connector profile, use the DescribeConnectorProfiles action. + // connectorVersion parameter. + // + // To look up the connector type, use the DescribeConnectorProfiles action. In the + // response, find the value that Amazon AppFlow returns for the connectorType + // parameter. + // + // To look up the API version that you specified in a connector profile, use the + // DescribeConnectorProfiles action. ApiVersion *string // Use this parameter if you want to reset cached metadata about the details for - // an individual entity. If you don't include this parameter in your request, - // Amazon AppFlow only resets cached metadata about entity names, not entity - // details. + // an individual entity. + // + // If you don't include this parameter in your request, Amazon AppFlow only resets + // cached metadata about entity names, not entity details. ConnectorEntityName *string // The name of the connector profile that you want to reset cached metadata for. + // // You can omit this parameter if you're resetting the cache for any of the // following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for // Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other // connector, you must include this parameter in your request. ConnectorProfileName *string - // The type of connector to reset cached metadata for. You must include this - // parameter in your request if you're resetting the cache for any of the following - // connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, - // Amazon S3, or Upsolver. If you're resetting the cache for any other connector, - // you can omit this parameter from your request. + // The type of connector to reset cached metadata for. + // + // You must include this parameter in your request if you're resetting the cache + // for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon + // Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for + // any other connector, you can omit this parameter from your request. ConnectorType types.ConnectorType // Use this parameter only if you’re resetting the cached metadata about a nested // entity. Only some connectors support nested entities. A nested entity is one // that has another entity as a parent. To use this parameter, specify the name of - // the parent entity. To look up the parent-child relationship of entities, you can - // send a ListConnectorEntities request that omits the entitiesPath parameter. - // Amazon AppFlow will return a list of top-level entities. For each one, it - // indicates whether the entity has nested entities. Then, in a subsequent + // the parent entity. + // + // To look up the parent-child relationship of entities, you can send a + // ListConnectorEntities request that omits the entitiesPath parameter. Amazon + // AppFlow will return a list of top-level entities. For each one, it indicates + // whether the entity has nested entities. Then, in a subsequent // ListConnectorEntities request, you can specify a parent entity name for the // entitiesPath parameter. Amazon AppFlow will return a list of the child entities // for that parent. diff --git a/service/appflow/api_op_StartFlow.go b/service/appflow/api_op_StartFlow.go index 3ab979f9d85..33bd8bb4312 100644 --- a/service/appflow/api_op_StartFlow.go +++ b/service/appflow/api_op_StartFlow.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Activates an existing flow. For on-demand flows, this operation runs the flow +// Activates an existing flow. For on-demand flows, this operation runs the flow +// // immediately. For schedule and event-triggered flows, this operation activates // the flow. func (c *Client) StartFlow(ctx context.Context, params *StartFlowInput, optFns ...func(*Options)) (*StartFlowOutput, error) { @@ -31,7 +32,7 @@ func (c *Client) StartFlow(ctx context.Context, params *StartFlowInput, optFns . type StartFlowInput struct { - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. @@ -40,15 +41,20 @@ type StartFlowInput struct { // The clientToken parameter is an idempotency token. It ensures that your // StartFlow request completes only once. You choose the value to pass. For // example, if you don't receive a response from your request, you can safely retry - // the request with the same clientToken parameter value. If you omit a clientToken - // value, the Amazon Web Services SDK that you are using inserts a value for you. - // This way, the SDK can safely retry requests multiple times after a network - // error. You must provide your own value for other use cases. If you specify input - // parameters that differ from your first request, an error occurs for flows that - // run on a schedule or based on an event. However, the error doesn't occur for - // flows that run on demand. You set the conditions that initiate your flow for the - // triggerConfig parameter. If you use a different value for clientToken , Amazon - // AppFlow considers it a new call to StartFlow . The token is active for 8 hours. + // the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs for flows that run on a schedule or based on an event. However, the error + // doesn't occur for flows that run on demand. You set the conditions that initiate + // your flow for the triggerConfig parameter. + // + // If you use a different value for clientToken , Amazon AppFlow considers it a new + // call to StartFlow . The token is active for 8 hours. ClientToken *string noSmithyDocumentSerde @@ -56,14 +62,14 @@ type StartFlowInput struct { type StartFlowOutput struct { - // Returns the internal execution ID of an on-demand flow when the flow is + // 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). + // The flow's Amazon Resource Name (ARN). FlowArn *string - // Indicates the current status of the flow. + // Indicates the current status of the flow. FlowStatus types.FlowStatus // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_StopFlow.go b/service/appflow/api_op_StopFlow.go index 61b6f933ad0..7e3ece20f5d 100644 --- a/service/appflow/api_op_StopFlow.go +++ b/service/appflow/api_op_StopFlow.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deactivates the existing flow. For on-demand flows, this operation returns an +// Deactivates the existing flow. For on-demand flows, this operation returns an +// // unsupportedOperationException error message. For schedule and event-triggered // flows, this operation deactivates the flow. func (c *Client) StopFlow(ctx context.Context, params *StopFlowInput, optFns ...func(*Options)) (*StopFlowOutput, error) { @@ -31,7 +32,7 @@ func (c *Client) StopFlow(ctx context.Context, params *StopFlowInput, optFns ... type StopFlowInput struct { - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. @@ -42,10 +43,10 @@ type StopFlowInput struct { type StopFlowOutput struct { - // The flow's Amazon Resource Name (ARN). + // The flow's Amazon Resource Name (ARN). FlowArn *string - // Indicates the current status of the flow. + // Indicates the current status of the flow. FlowStatus types.FlowStatus // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_TagResource.go b/service/appflow/api_op_TagResource.go index 233e8912390..9c7ff7e7b93 100644 --- a/service/appflow/api_op_TagResource.go +++ b/service/appflow/api_op_TagResource.go @@ -28,12 +28,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the flow that you want to tag. + // The Amazon Resource Name (ARN) of the flow that you want to tag. // // This member is required. ResourceArn *string - // The tags used to organize, track, or control access for your flow. + // The tags used to organize, track, or control access for your flow. // // This member is required. Tags map[string]string diff --git a/service/appflow/api_op_UntagResource.go b/service/appflow/api_op_UntagResource.go index 077a04d47a7..45ba676a67f 100644 --- a/service/appflow/api_op_UntagResource.go +++ b/service/appflow/api_op_UntagResource.go @@ -28,12 +28,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the flow that you want to untag. + // The Amazon Resource Name (ARN) of the flow that you want to untag. // // This member is required. ResourceArn *string - // The tag keys associated with the tag that you want to remove from your flow. + // The tag keys associated with the tag that you want to remove from your flow. // // This member is required. TagKeys []string diff --git a/service/appflow/api_op_UpdateConnectorProfile.go b/service/appflow/api_op_UpdateConnectorProfile.go index e2af70188e4..970cf820e58 100644 --- a/service/appflow/api_op_UpdateConnectorProfile.go +++ b/service/appflow/api_op_UpdateConnectorProfile.go @@ -29,17 +29,17 @@ func (c *Client) UpdateConnectorProfile(ctx context.Context, params *UpdateConne type UpdateConnectorProfileInput struct { - // Indicates the connection mode and if it is public or private. + // Indicates the connection mode and if it is public or private. // // This member is required. ConnectionMode types.ConnectionMode - // Defines the connector-specific profile configuration and credentials. + // Defines the connector-specific profile configuration and credentials. // // This member is required. ConnectorProfileConfig *types.ConnectorProfileConfig - // The name of the connector profile and is unique for each ConnectorProfile in + // The name of the connector profile and is unique for each ConnectorProfile in // the Amazon Web Services account. // // This member is required. @@ -48,13 +48,16 @@ type UpdateConnectorProfileInput struct { // The clientToken parameter is an idempotency token. It ensures that your // UpdateConnectorProfile request completes only once. You choose the value to // pass. For example, if you don't receive a response from your request, you can - // safely retry the request with the same clientToken parameter value. If you omit - // a clientToken value, the Amazon Web Services SDK that you are using inserts a - // value for you. This way, the SDK can safely retry requests multiple times after - // a network error. You must provide your own value for other use cases. If you - // specify input parameters that differ from your first request, an error occurs. - // If you use a different value for clientToken , Amazon AppFlow considers it a new - // call to UpdateConnectorProfile . The token is active for 8 hours. + // safely retry the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs. If you use a different value for clientToken , Amazon AppFlow considers + // it a new call to UpdateConnectorProfile . The token is active for 8 hours. ClientToken *string noSmithyDocumentSerde @@ -62,7 +65,7 @@ type UpdateConnectorProfileInput struct { type UpdateConnectorProfileOutput struct { - // The Amazon Resource Name (ARN) of the connector profile. + // The Amazon Resource Name (ARN) of the connector profile. ConnectorProfileArn *string // Metadata pertaining to the operation's result. diff --git a/service/appflow/api_op_UpdateConnectorRegistration.go b/service/appflow/api_op_UpdateConnectorRegistration.go index d8e0f835b21..50ad640348e 100644 --- a/service/appflow/api_op_UpdateConnectorRegistration.go +++ b/service/appflow/api_op_UpdateConnectorRegistration.go @@ -13,8 +13,10 @@ 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 func (c *Client) UpdateConnectorRegistration(ctx context.Context, params *UpdateConnectorRegistrationInput, optFns ...func(*Options)) (*UpdateConnectorRegistrationOutput, error) { if params == nil { @@ -42,13 +44,16 @@ type UpdateConnectorRegistrationInput struct { // The clientToken parameter is an idempotency token. It ensures that your // UpdateConnectorRegistration request completes only once. You choose the value to // pass. For example, if you don't receive a response from your request, you can - // safely retry the request with the same clientToken parameter value. If you omit - // a clientToken value, the Amazon Web Services SDK that you are using inserts a - // value for you. This way, the SDK can safely retry requests multiple times after - // a network error. You must provide your own value for other use cases. If you - // specify input parameters that differ from your first request, an error occurs. - // If you use a different value for clientToken , Amazon AppFlow considers it a new - // call to UpdateConnectorRegistration . The token is active for 8 hours. + // safely retry the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs. If you use a different value for clientToken , Amazon AppFlow considers + // it a new call to UpdateConnectorRegistration . The token is active for 8 hours. ClientToken *string // Contains information about the configuration of the connector being registered. diff --git a/service/appflow/api_op_UpdateFlow.go b/service/appflow/api_op_UpdateFlow.go index 67d6a983d13..77714e0cb08 100644 --- a/service/appflow/api_op_UpdateFlow.go +++ b/service/appflow/api_op_UpdateFlow.go @@ -29,31 +29,31 @@ func (c *Client) UpdateFlow(ctx context.Context, params *UpdateFlowInput, optFns type UpdateFlowInput struct { - // The configuration that controls how Amazon AppFlow transfers data to the + // The configuration that controls how Amazon AppFlow transfers data to the // destination connector. // // This member is required. DestinationFlowConfigList []types.DestinationFlowConfig - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. // // This member is required. FlowName *string - // Contains information about the configuration of the source connector used in + // Contains information about the configuration of the source connector used in // the flow. // // This member is required. SourceFlowConfig *types.SourceFlowConfig - // A list of tasks that Amazon AppFlow performs while transferring the data in the - // flow run. + // A list of tasks that Amazon AppFlow performs while transferring the data in + // the flow run. // // This member is required. Tasks []types.Task - // The trigger settings that determine how and when the flow runs. + // The trigger settings that determine how and when the flow runs. // // This member is required. TriggerConfig *types.TriggerConfig @@ -61,16 +61,19 @@ type UpdateFlowInput struct { // The clientToken parameter is an idempotency token. It ensures that your // UpdateFlow request completes only once. You choose the value to pass. For // example, if you don't receive a response from your request, you can safely retry - // the request with the same clientToken parameter value. If you omit a clientToken - // value, the Amazon Web Services SDK that you are using inserts a value for you. - // This way, the SDK can safely retry requests multiple times after a network - // error. You must provide your own value for other use cases. If you specify input - // parameters that differ from your first request, an error occurs. If you use a - // different value for clientToken , Amazon AppFlow considers it a new call to - // UpdateFlow . The token is active for 8 hours. + // the request with the same clientToken parameter value. + // + // If you omit a clientToken value, the Amazon Web Services SDK that you are using + // inserts a value for you. This way, the SDK can safely retry requests multiple + // times after a network error. You must provide your own value for other use + // cases. + // + // If you specify input parameters that differ from your first request, an error + // occurs. If you use a different value for clientToken , Amazon AppFlow considers + // it a new call to UpdateFlow . The token is active for 8 hours. ClientToken *string - // A description of the flow. + // A description of the flow. Description *string // Specifies the configuration that Amazon AppFlow uses when it catalogs the data diff --git a/service/appflow/doc.go b/service/appflow/doc.go index 1e786cee619..088e11d01c2 100644 --- a/service/appflow/doc.go +++ b/service/appflow/doc.go @@ -5,26 +5,39 @@ // // Welcome to the Amazon AppFlow API reference. This guide is for developers who // need detailed information about the Amazon AppFlow API operations, data types, -// and errors. Amazon AppFlow is a fully managed integration service that enables -// you to securely transfer data between software as a service (SaaS) applications -// 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. -// -// 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 +// and errors. +// +// Amazon AppFlow is a fully managed integration service that enables you to +// securely transfer data between software as a service (SaaS) applications 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] +// - : An alphabetical list of all Amazon AppFlow API operations. +// +// [Data types] +// - : An alphabetical list of all Amazon AppFlow data types. +// +// [Common parameters] +// - : Parameters that all Query operations can use. +// +// [Common errors] +// - : 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]. +// +// 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) -// documentation. +// refer to the [Authorize Apps with OAuth]documentation. +// +// [Common errors]: https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html +// [Actions]: https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html +// [Authorize Apps with OAuth]: https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm +// [Data types]: https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html +// [Common parameters]: https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html +// [Amazon AppFlow User Guide]: https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html package appflow diff --git a/service/appflow/options.go b/service/appflow/options.go index 9949552f60c..4ebfb1b4373 100644 --- a/service/appflow/options.go +++ b/service/appflow/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appflow/types/enums.go b/service/appflow/types/enums.go index 0506336d104..e398940f8a2 100644 --- a/service/appflow/types/enums.go +++ b/service/appflow/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AggregationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationType) Values() []AggregationType { return []AggregationType{ "None", @@ -29,6 +30,7 @@ const ( // Values returns all known values for AmplitudeConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AmplitudeConnectorOperator) Values() []AmplitudeConnectorOperator { return []AmplitudeConnectorOperator{ @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "OAUTH2", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for CatalogType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CatalogType) Values() []CatalogType { return []CatalogType{ "GLUE", @@ -83,8 +87,9 @@ const ( ) // Values returns all known values for ConnectionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionMode) Values() []ConnectionMode { return []ConnectionMode{ "Public", @@ -101,6 +106,7 @@ const ( // Values returns all known values for ConnectorProvisioningType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorProvisioningType) Values() []ConnectorProvisioningType { return []ConnectorProvisioningType{ @@ -139,8 +145,9 @@ const ( ) // Values returns all known values for ConnectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorType) Values() []ConnectorType { return []ConnectorType{ "Salesforce", @@ -193,6 +200,7 @@ const ( // 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{ @@ -223,8 +231,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -242,8 +251,9 @@ const ( ) // Values returns all known values for DataTransferApiType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataTransferApiType) Values() []DataTransferApiType { return []DataTransferApiType{ "SYNC", @@ -275,6 +285,7 @@ const ( // Values returns all known values for DynatraceConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DynatraceConnectorOperator) Values() []DynatraceConnectorOperator { return []DynatraceConnectorOperator{ @@ -308,8 +319,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "InProgress", @@ -330,8 +342,9 @@ const ( ) // Values returns all known values for FileType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileType) Values() []FileType { return []FileType{ "CSV", @@ -353,8 +366,9 @@ const ( ) // Values returns all known values for FlowStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlowStatus) Values() []FlowStatus { return []FlowStatus{ "Active", @@ -376,8 +390,9 @@ const ( // Values returns all known values for GoogleAnalyticsConnectorOperator. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GoogleAnalyticsConnectorOperator) Values() []GoogleAnalyticsConnectorOperator { return []GoogleAnalyticsConnectorOperator{ "PROJECTION", @@ -408,6 +423,7 @@ const ( // Values returns all known values for InforNexusConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InforNexusConnectorOperator) Values() []InforNexusConnectorOperator { return []InforNexusConnectorOperator{ @@ -453,6 +469,7 @@ const ( // 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{ @@ -484,8 +501,9 @@ const ( ) // Values returns all known values for OAuth2CustomPropType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OAuth2CustomPropType) Values() []OAuth2CustomPropType { return []OAuth2CustomPropType{ "TOKEN_URL", @@ -503,8 +521,9 @@ const ( ) // Values returns all known values for OAuth2GrantType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OAuth2GrantType) Values() []OAuth2GrantType { return []OAuth2GrantType{ "CLIENT_CREDENTIALS", @@ -541,8 +560,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "PROJECTION", @@ -593,8 +613,9 @@ const ( ) // Values returns all known values for OperatorPropertiesKeys. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperatorPropertiesKeys) Values() []OperatorPropertiesKeys { return []OperatorPropertiesKeys{ "VALUE", @@ -645,8 +666,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -694,8 +716,9 @@ const ( ) // Values returns all known values for PardotConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PardotConnectorOperator) Values() []PardotConnectorOperator { return []PardotConnectorOperator{ "PROJECTION", @@ -724,8 +747,9 @@ const ( ) // Values returns all known values for PathPrefix. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PathPrefix) Values() []PathPrefix { return []PathPrefix{ "EXECUTION_ID", @@ -745,8 +769,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -767,8 +792,9 @@ const ( ) // Values returns all known values for PrefixType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrefixType) Values() []PrefixType { return []PrefixType{ "FILENAME", @@ -790,8 +816,9 @@ const ( // Values returns all known values for PrivateConnectionProvisioningFailureCause. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrivateConnectionProvisioningFailureCause) Values() []PrivateConnectionProvisioningFailureCause { return []PrivateConnectionProvisioningFailureCause{ "CONNECTOR_AUTHENTICATION", @@ -813,8 +840,9 @@ const ( // Values returns all known values for PrivateConnectionProvisioningStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrivateConnectionProvisioningStatus) Values() []PrivateConnectionProvisioningStatus { return []PrivateConnectionProvisioningStatus{ "FAILED", @@ -850,8 +878,9 @@ const ( ) // Values returns all known values for S3ConnectorOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ConnectorOperator) Values() []S3ConnectorOperator { return []S3ConnectorOperator{ "PROJECTION", @@ -886,8 +915,9 @@ const ( ) // Values returns all known values for S3InputFileType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3InputFileType) Values() []S3InputFileType { return []S3InputFileType{ "CSV", @@ -924,6 +954,7 @@ const ( // Values returns all known values for SalesforceConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SalesforceConnectorOperator) Values() []SalesforceConnectorOperator { return []SalesforceConnectorOperator{ @@ -962,6 +993,7 @@ const ( // Values returns all known values for SalesforceDataTransferApi. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SalesforceDataTransferApi) Values() []SalesforceDataTransferApi { return []SalesforceDataTransferApi{ @@ -1000,6 +1032,7 @@ const ( // Values returns all known values for SAPODataConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SAPODataConnectorOperator) Values() []SAPODataConnectorOperator { return []SAPODataConnectorOperator{ @@ -1040,8 +1073,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "BYMINUTE", @@ -1082,6 +1116,7 @@ const ( // Values returns all known values for ServiceNowConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNowConnectorOperator) Values() []ServiceNowConnectorOperator { return []ServiceNowConnectorOperator{ @@ -1131,6 +1166,7 @@ const ( // Values returns all known values for SingularConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SingularConnectorOperator) Values() []SingularConnectorOperator { return []SingularConnectorOperator{ @@ -1177,8 +1213,9 @@ const ( ) // Values returns all known values for SlackConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlackConnectorOperator) Values() []SlackConnectorOperator { return []SlackConnectorOperator{ "PROJECTION", @@ -1213,6 +1250,7 @@ const ( // Values returns all known values for SupportedDataTransferType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SupportedDataTransferType) Values() []SupportedDataTransferType { return []SupportedDataTransferType{ @@ -1238,8 +1276,9 @@ const ( ) // Values returns all known values for TaskType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskType) Values() []TaskType { return []TaskType{ "Arithmetic", @@ -1277,6 +1316,7 @@ const ( // Values returns all known values for TrendmicroConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TrendmicroConnectorOperator) Values() []TrendmicroConnectorOperator { return []TrendmicroConnectorOperator{ @@ -1307,8 +1347,9 @@ const ( ) // Values returns all known values for TriggerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerType) Values() []TriggerType { return []TriggerType{ "Scheduled", @@ -1345,8 +1386,9 @@ const ( ) // Values returns all known values for VeevaConnectorOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VeevaConnectorOperator) Values() []VeevaConnectorOperator { return []VeevaConnectorOperator{ "PROJECTION", @@ -1384,8 +1426,9 @@ const ( ) // Values returns all known values for WriteOperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WriteOperationType) Values() []WriteOperationType { return []WriteOperationType{ "INSERT", @@ -1417,6 +1460,7 @@ const ( // 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{ diff --git a/service/appflow/types/errors.go b/service/appflow/types/errors.go index 7fd2ba5cb21..d0abb58411f 100644 --- a/service/appflow/types/errors.go +++ b/service/appflow/types/errors.go @@ -33,7 +33,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There was a conflict when processing the request (for example, a flow with the +// There was a conflict when processing the request (for example, a flow with the +// // given name already exists within the account. Check for conflicting resource // names and try again. type ConflictException struct { @@ -113,7 +114,8 @@ func (e *ConnectorServerException) ErrorCode() string { } func (e *ConnectorServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An internal service error occurred during the processing of your request. Try +// An internal service error occurred during the processing of your request. Try +// // again later. type InternalServerException struct { Message *string @@ -140,7 +142,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The resource specified in the request (such as the source or destination +// The resource specified in the request (such as the source or destination +// // connector profile) is not found. type ResourceNotFoundException struct { Message *string @@ -167,7 +170,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request would cause a service quota (such as the number of flows) to be +// The request would cause a service quota (such as the number of flows) to be +// // exceeded. type ServiceQuotaExceededException struct { Message *string diff --git a/service/appflow/types/types.go b/service/appflow/types/types.go index d1e2da124a6..01febbe647a 100644 --- a/service/appflow/types/types.go +++ b/service/appflow/types/types.go @@ -7,11 +7,12 @@ import ( "time" ) -// The aggregation settings that you can use to customize the output format of +// 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 + // Specifies whether Amazon AppFlow aggregates the flow records into a single // file, or leave them unaggregated. AggregationType AggregationType @@ -27,13 +28,13 @@ type AggregationConfig struct { // The connector-specific credentials required when using Amplitude. type AmplitudeConnectorProfileCredentials struct { - // A unique alphanumeric identifier used to authenticate a user, developer, or + // A unique alphanumeric identifier used to authenticate a user, developer, or // calling program to your API. // // This member is required. ApiKey *string - // The Secret Access Key portion of the credentials. + // The Secret Access Key portion of the credentials. // // This member is required. SecretKey *string @@ -54,7 +55,7 @@ type AmplitudeMetadata struct { // The properties that are applied when Amplitude is being used as a source. type AmplitudeSourceProperties struct { - // The object specified in the Amplitude flow source. + // The object specified in the Amplitude flow source. // // This member is required. Object *string @@ -129,12 +130,12 @@ type AuthParameter struct { // The basic auth credentials required for basic authentication. type BasicAuthCredentials struct { - // The password to use to connect to a resource. + // The password to use to connect to a resource. // // This member is required. Password *string - // The username to use to connect to a resource. + // The username to use to connect to a resource. // // This member is required. Username *string @@ -148,10 +149,10 @@ type ConnectorConfiguration struct { // The authentication config required for the connector. AuthenticationConfig *AuthenticationConfig - // Specifies whether the connector can be used as a destination. + // Specifies whether the connector can be used as a destination. CanUseAsDestination bool - // Specifies whether the connector can be used as a source. + // Specifies whether the connector can be used as a source. CanUseAsSource bool // The Amazon Resource Name (ARN) for the registered connector. @@ -163,7 +164,7 @@ type ConnectorConfiguration struct { // The label used for registering the connector. ConnectorLabel *string - // Specifies connector-specific metadata such as oAuthScopes , supportedRegions , + // Specifies connector-specific metadata such as oAuthScopes , supportedRegions , // privateLinkServiceUrl , and so on. ConnectorMetadata *ConnectorMetadata @@ -191,10 +192,10 @@ type ConnectorConfiguration struct { // The connector version. ConnectorVersion *string - // Specifies if PrivateLink is enabled for that connector. + // Specifies if PrivateLink is enabled for that connector. IsPrivateLinkEnabled bool - // Specifies if a PrivateLink endpoint URL is required. + // Specifies if a PrivateLink endpoint URL is required. IsPrivateLinkEndpointUrlRequired bool // Logo URL of the connector. @@ -213,20 +214,23 @@ type ConnectorConfiguration struct { // your data. SupportedDataTransferApis []DataTransferApi - // The data transfer types that the connector supports. RECORD Structured records. + // The data transfer types that the connector supports. + // + // RECORD Structured records. + // // FILE Files or binary data. SupportedDataTransferTypes []SupportedDataTransferType - // Lists the connectors that are available for use as destinations. + // Lists the connectors that are available for use as destinations. SupportedDestinationConnectors []ConnectorType // A list of operators supported by the connector. SupportedOperators []Operators - // Specifies the supported flow frequency for that connector. + // Specifies the supported flow frequency for that connector. SupportedSchedulingFrequencies []ScheduleFrequencyType - // Specifies the supported trigger types for the flow. + // Specifies the supported trigger types for the flow. SupportedTriggerTypes []TriggerType // A list of write operations supported by the connector. @@ -271,41 +275,46 @@ type ConnectorDetail struct { // The user who registered the connector. RegisteredBy *string - // The data transfer types that the connector supports. RECORD Structured records. + // The data transfer types that the connector supports. + // + // RECORD Structured records. + // // FILE Files or binary data. SupportedDataTransferTypes []SupportedDataTransferType noSmithyDocumentSerde } -// The high-level entity that can be queried in Amazon AppFlow. For example, a +// The high-level entity that can be queried in Amazon AppFlow. For example, a +// // Salesforce entity might be an Account or Opportunity, whereas a ServiceNow // entity might be an Incident. type ConnectorEntity struct { - // The name of the connector entity. + // The name of the connector entity. // // This member is required. Name *string - // Specifies whether the connector entity is a parent or a category and has more + // 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 // nested entities underneath it. This provides a way to retrieve all supported // entities in a recursive fashion. HasNestedEntities bool - // The label applied to the connector entity. + // The label applied to the connector entity. Label *string noSmithyDocumentSerde } -// Describes the data model of a connector field. For example, for an account +// Describes the data model of a connector field. For example, for an account +// // entity, the fields would be account name, account ID, and so on. type ConnectorEntityField struct { - // The unique identifier of the connector field. + // The unique identifier of the connector field. // // This member is required. Identifier *string @@ -316,10 +325,10 @@ type ConnectorEntityField struct { // Default value that can be assigned to this field. DefaultValue *string - // A description of the connector entity field. + // A description of the connector entity field. Description *string - // The properties applied to a field when the connector is being used as a + // The properties applied to a field when the connector is being used as a // destination. DestinationProperties *DestinationFieldProperties @@ -329,105 +338,107 @@ type ConnectorEntityField struct { // Booelan value that indicates whether this field can be used as a primary key. IsPrimaryKey bool - // The label applied to a connector entity field. + // The label applied to a connector entity field. Label *string // The parent identifier of the connector field. ParentIdentifier *string - // The properties that can be applied to a field when the connector is being used + // The properties that can be applied to a field when the connector is being used // 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 , +// A structure to specify connector-specific metadata such as oAuthScopes , +// // supportedRegions , privateLinkServiceUrl , and so on. type ConnectorMetadata struct { - // The connector metadata specific to Amplitude. + // The connector metadata specific to Amplitude. Amplitude *AmplitudeMetadata - // The connector metadata specific to Amazon Connect Customer Profiles. + // The connector metadata specific to Amazon Connect Customer Profiles. CustomerProfiles *CustomerProfilesMetadata - // The connector metadata specific to Datadog. + // The connector metadata specific to Datadog. Datadog *DatadogMetadata - // The connector metadata specific to Dynatrace. + // The connector metadata specific to Dynatrace. Dynatrace *DynatraceMetadata - // The connector metadata specific to Amazon EventBridge. + // The connector metadata specific to Amazon EventBridge. EventBridge *EventBridgeMetadata - // The connector metadata specific to Google Analytics. + // The connector metadata specific to Google Analytics. GoogleAnalytics *GoogleAnalyticsMetadata - // The connector metadata specific to Amazon Honeycode. + // The connector metadata specific to Amazon Honeycode. Honeycode *HoneycodeMetadata - // The connector metadata specific to Infor Nexus. + // The connector metadata specific to Infor Nexus. InforNexus *InforNexusMetadata - // The connector metadata specific to Marketo. + // The connector metadata specific to Marketo. Marketo *MarketoMetadata // The connector metadata specific to Salesforce Pardot. Pardot *PardotMetadata - // The connector metadata specific to Amazon Redshift. + // The connector metadata specific to Amazon Redshift. Redshift *RedshiftMetadata - // The connector metadata specific to Amazon S3. + // The connector metadata specific to Amazon S3. S3 *S3Metadata - // The connector metadata specific to SAPOData. + // The connector metadata specific to SAPOData. SAPOData *SAPODataMetadata - // The connector metadata specific to Salesforce. + // The connector metadata specific to Salesforce. Salesforce *SalesforceMetadata - // The connector metadata specific to ServiceNow. + // The connector metadata specific to ServiceNow. ServiceNow *ServiceNowMetadata - // The connector metadata specific to Singular. + // The connector metadata specific to Singular. Singular *SingularMetadata - // The connector metadata specific to Slack. + // The connector metadata specific to Slack. Slack *SlackMetadata - // The connector metadata specific to Snowflake. + // The connector metadata specific to Snowflake. Snowflake *SnowflakeMetadata - // The connector metadata specific to Trend Micro. + // The connector metadata specific to Trend Micro. Trendmicro *TrendmicroMetadata - // The connector metadata specific to Upsolver. + // The connector metadata specific to Upsolver. Upsolver *UpsolverMetadata - // The connector metadata specific to Veeva. + // The connector metadata specific to Veeva. Veeva *VeevaMetadata - // The connector metadata specific to Zendesk. + // The connector metadata specific to Zendesk. Zendesk *ZendeskMetadata noSmithyDocumentSerde } -// Used by select connectors for which the OAuth workflow is supported, such as +// Used by select connectors for which the OAuth workflow is supported, such as +// // Salesforce, Google Analytics, Marketo, Zendesk, and Slack. type ConnectorOAuthRequest struct { - // The code provided by the connector when it has been authenticated via the + // The code provided by the connector when it has been authenticated via the // connected app. AuthCode *string - // The URL to which the authentication server redirects the browser after + // The URL to which the authentication server redirects the browser after // authorization has been granted. RedirectUri *string @@ -437,111 +448,113 @@ type ConnectorOAuthRequest struct { // The operation to be performed on the provided source fields. type ConnectorOperator struct { - // The operation to be performed on the provided Amplitude source fields. + // The operation to be performed on the provided Amplitude source fields. Amplitude AmplitudeConnectorOperator // Operators supported by the custom connector. CustomConnector Operator - // The operation to be performed on the provided Datadog source fields. + // The operation to be performed on the provided Datadog source fields. Datadog DatadogConnectorOperator - // The operation to be performed on the provided Dynatrace source fields. + // The operation to be performed on the provided Dynatrace source fields. Dynatrace DynatraceConnectorOperator - // The operation to be performed on the provided Google Analytics source fields. + // The operation to be performed on the provided Google Analytics source fields. GoogleAnalytics GoogleAnalyticsConnectorOperator - // The operation to be performed on the provided Infor Nexus source fields. + // The operation to be performed on the provided Infor Nexus source fields. InforNexus InforNexusConnectorOperator - // The operation to be performed on the provided Marketo source fields. + // The operation to be performed on the provided Marketo source fields. Marketo MarketoConnectorOperator // The operation to be performed on the provided Salesforce Pardot source fields. Pardot PardotConnectorOperator - // The operation to be performed on the provided Amazon S3 source fields. + // The operation to be performed on the provided Amazon S3 source fields. S3 S3ConnectorOperator - // The operation to be performed on the provided SAPOData source fields. + // The operation to be performed on the provided SAPOData source fields. SAPOData SAPODataConnectorOperator - // The operation to be performed on the provided Salesforce source fields. + // The operation to be performed on the provided Salesforce source fields. Salesforce SalesforceConnectorOperator - // The operation to be performed on the provided ServiceNow source fields. + // The operation to be performed on the provided ServiceNow source fields. ServiceNow ServiceNowConnectorOperator - // The operation to be performed on the provided Singular source fields. + // The operation to be performed on the provided Singular source fields. Singular SingularConnectorOperator - // The operation to be performed on the provided Slack source fields. + // The operation to be performed on the provided Slack source fields. Slack SlackConnectorOperator - // The operation to be performed on the provided Trend Micro source fields. + // The operation to be performed on the provided Trend Micro source fields. Trendmicro TrendmicroConnectorOperator - // The operation to be performed on the provided Veeva source fields. + // The operation to be performed on the provided Veeva source fields. Veeva VeevaConnectorOperator - // The operation to be performed on the provided Zendesk source fields. + // The operation to be performed on the provided Zendesk source fields. Zendesk ZendeskConnectorOperator noSmithyDocumentSerde } -// Describes an instance of a connector. This includes the provided name, +// Describes an instance of a connector. This includes the provided name, +// // credentials ARN, connection-mode, and so on. To keep the API intuitive and // extensible, the fields that are common to all types of connector profiles are // explicitly specified at the top level. The rest of the connector-specific // properties are available via the connectorProfileProperties field. type ConnectorProfile struct { - // Indicates the connection mode and if it is public or private. + // Indicates the connection mode and if it is public or private. ConnectionMode ConnectionMode // The label for the connector profile being created. ConnectorLabel *string - // The Amazon Resource Name (ARN) of the connector profile. + // The Amazon Resource Name (ARN) of the connector profile. ConnectorProfileArn *string - // The name of the connector profile. The name is unique for each ConnectorProfile + // The name of the connector profile. The name is unique for each ConnectorProfile // in the Amazon Web Services account. ConnectorProfileName *string - // The connector-specific properties of the profile configuration. + // The connector-specific properties of the profile configuration. ConnectorProfileProperties *ConnectorProfileProperties - // The type of connector, such as Salesforce, Amplitude, and so on. + // The type of connector, such as Salesforce, Amplitude, and so on. ConnectorType ConnectorType - // Specifies when the connector profile was created. + // Specifies when the connector profile was created. CreatedAt *time.Time - // The Amazon Resource Name (ARN) of the connector profile credentials. + // The Amazon Resource Name (ARN) of the connector profile credentials. CredentialsArn *string - // Specifies when the connector profile was last updated. + // Specifies when the connector profile was last updated. LastUpdatedAt *time.Time - // Specifies the private connection provisioning state. + // Specifies the private connection provisioning state. PrivateConnectionProvisioningState *PrivateConnectionProvisioningState noSmithyDocumentSerde } -// Defines the connector-specific configuration and credentials for the connector +// Defines the connector-specific configuration and credentials for the connector +// // profile. type ConnectorProfileConfig struct { - // The connector-specific properties of the profile configuration. + // The connector-specific properties of the profile configuration. // // This member is required. ConnectorProfileProperties *ConnectorProfileProperties - // The connector-specific credentials required by each connector. + // The connector-specific credentials required by each connector. ConnectorProfileCredentials *ConnectorProfileCredentials noSmithyDocumentSerde @@ -550,62 +563,62 @@ type ConnectorProfileConfig struct { // The connector-specific credentials required by a connector. type ConnectorProfileCredentials struct { - // The connector-specific credentials required when using Amplitude. + // The connector-specific credentials required when using Amplitude. Amplitude *AmplitudeConnectorProfileCredentials // The connector-specific profile credentials that are required when using the // custom connector. CustomConnector *CustomConnectorProfileCredentials - // The connector-specific credentials required when using Datadog. + // The connector-specific credentials required when using Datadog. Datadog *DatadogConnectorProfileCredentials - // The connector-specific credentials required when using Dynatrace. + // The connector-specific credentials required when using Dynatrace. Dynatrace *DynatraceConnectorProfileCredentials - // The connector-specific credentials required when using Google Analytics. + // The connector-specific credentials required when using Google Analytics. GoogleAnalytics *GoogleAnalyticsConnectorProfileCredentials - // The connector-specific credentials required when using Amazon Honeycode. + // The connector-specific credentials required when using Amazon Honeycode. Honeycode *HoneycodeConnectorProfileCredentials - // The connector-specific credentials required when using Infor Nexus. + // The connector-specific credentials required when using Infor Nexus. InforNexus *InforNexusConnectorProfileCredentials - // The connector-specific credentials required when using Marketo. + // The connector-specific credentials required when using Marketo. Marketo *MarketoConnectorProfileCredentials // The connector-specific credentials required when using Salesforce Pardot. Pardot *PardotConnectorProfileCredentials - // The connector-specific credentials required when using Amazon Redshift. + // The connector-specific credentials required when using Amazon Redshift. Redshift *RedshiftConnectorProfileCredentials - // The connector-specific profile credentials required when using SAPOData. + // The connector-specific profile credentials required when using SAPOData. SAPOData *SAPODataConnectorProfileCredentials - // The connector-specific credentials required when using Salesforce. + // The connector-specific credentials required when using Salesforce. Salesforce *SalesforceConnectorProfileCredentials - // The connector-specific credentials required when using ServiceNow. + // The connector-specific credentials required when using ServiceNow. ServiceNow *ServiceNowConnectorProfileCredentials - // The connector-specific credentials required when using Singular. + // The connector-specific credentials required when using Singular. Singular *SingularConnectorProfileCredentials - // The connector-specific credentials required when using Slack. + // The connector-specific credentials required when using Slack. Slack *SlackConnectorProfileCredentials - // The connector-specific credentials required when using Snowflake. + // The connector-specific credentials required when using Snowflake. Snowflake *SnowflakeConnectorProfileCredentials - // The connector-specific credentials required when using Trend Micro. + // The connector-specific credentials required when using Trend Micro. Trendmicro *TrendmicroConnectorProfileCredentials - // The connector-specific credentials required when using Veeva. + // The connector-specific credentials required when using Veeva. Veeva *VeevaConnectorProfileCredentials - // The connector-specific credentials required when using Zendesk. + // The connector-specific credentials required when using Zendesk. Zendesk *ZendeskConnectorProfileCredentials noSmithyDocumentSerde @@ -614,61 +627,61 @@ type ConnectorProfileCredentials struct { // The connector-specific profile properties required by each connector. type ConnectorProfileProperties struct { - // The connector-specific properties required by Amplitude. + // The connector-specific properties required by Amplitude. Amplitude *AmplitudeConnectorProfileProperties // The properties required by the custom connector. CustomConnector *CustomConnectorProfileProperties - // The connector-specific properties required by Datadog. + // The connector-specific properties required by Datadog. Datadog *DatadogConnectorProfileProperties - // The connector-specific properties required by Dynatrace. + // The connector-specific properties required by Dynatrace. Dynatrace *DynatraceConnectorProfileProperties - // The connector-specific properties required Google Analytics. + // The connector-specific properties required Google Analytics. GoogleAnalytics *GoogleAnalyticsConnectorProfileProperties - // The connector-specific properties required by Amazon Honeycode. + // The connector-specific properties required by Amazon Honeycode. Honeycode *HoneycodeConnectorProfileProperties - // The connector-specific properties required by Infor Nexus. + // The connector-specific properties required by Infor Nexus. InforNexus *InforNexusConnectorProfileProperties - // The connector-specific properties required by Marketo. + // The connector-specific properties required by Marketo. Marketo *MarketoConnectorProfileProperties // The connector-specific properties required by Salesforce Pardot. Pardot *PardotConnectorProfileProperties - // The connector-specific properties required by Amazon Redshift. + // The connector-specific properties required by Amazon Redshift. Redshift *RedshiftConnectorProfileProperties - // The connector-specific profile properties required when using SAPOData. + // The connector-specific profile properties required when using SAPOData. SAPOData *SAPODataConnectorProfileProperties - // The connector-specific properties required by Salesforce. + // The connector-specific properties required by Salesforce. Salesforce *SalesforceConnectorProfileProperties - // The connector-specific properties required by serviceNow. + // The connector-specific properties required by serviceNow. ServiceNow *ServiceNowConnectorProfileProperties - // The connector-specific properties required by Singular. + // The connector-specific properties required by Singular. Singular *SingularConnectorProfileProperties - // The connector-specific properties required by Slack. + // The connector-specific properties required by Slack. Slack *SlackConnectorProfileProperties - // The connector-specific properties required by Snowflake. + // The connector-specific properties required by Snowflake. Snowflake *SnowflakeConnectorProfileProperties - // The connector-specific properties required by Trend Micro. + // The connector-specific properties required by Trend Micro. Trendmicro *TrendmicroConnectorProfileProperties - // The connector-specific properties required by Veeva. + // The connector-specific properties required by Veeva. Veeva *VeevaConnectorProfileProperties - // The connector-specific properties required by Zendesk. + // The connector-specific properties required by Zendesk. Zendesk *ZendeskConnectorProfileProperties noSmithyDocumentSerde @@ -825,16 +838,17 @@ type CustomConnectorSourceProperties struct { noSmithyDocumentSerde } -// The properties that are applied when Amazon Connect Customer Profiles is used +// 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. + // The unique name of the Amazon Connect Customer Profiles domain. // // This member is required. DomainName *string - // The object specified in the Amazon Connect Customer Profiles flow destination. + // The object specified in the Amazon Connect Customer Profiles flow destination. ObjectTypeName *string noSmithyDocumentSerde @@ -848,13 +862,13 @@ type CustomerProfilesMetadata struct { // The connector-specific credentials required by Datadog. type DatadogConnectorProfileCredentials struct { - // A unique alphanumeric identifier used to authenticate a user, developer, or + // A unique alphanumeric identifier used to authenticate a user, developer, or // calling program to your API. // // This member is required. ApiKey *string - // Application keys, in conjunction with your API key, give you full access to + // Application keys, in conjunction with your API key, give you full access to // Datadog’s programmatic API. Application keys are associated with the user // account that created them. The application key is used to log all requests made // to the API. @@ -868,7 +882,7 @@ type DatadogConnectorProfileCredentials struct { // The connector-specific profile properties required by Datadog. type DatadogConnectorProfileProperties struct { - // The location of the Datadog resource. + // The location of the Datadog resource. // // This member is required. InstanceUrl *string @@ -884,7 +898,7 @@ type DatadogMetadata struct { // The properties that are applied when Datadog is being used as a source. type DatadogSourceProperties struct { - // The object specified in the Datadog flow source. + // The object specified in the Datadog flow source. // // This member is required. Object *string @@ -899,12 +913,16 @@ type DataTransferApi struct { // The name of the connector application API. Name *string - // You can specify one of the following types: AUTOMATIC The default. Optimizes a - // flow for datasets that fluctuate in size from small to large. For each flow run, - // Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of - // data that the run transfers. SYNC A synchronous API. This type of API optimizes - // a flow for small to medium-sized datasets. ASYNC An asynchronous API. This type - // of API optimizes a flow for large datasets. + // You can specify one of the following types: + // + // AUTOMATIC The default. Optimizes a flow for datasets that fluctuate in size + // from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC + // or ASYNC API type based on the amount of data that the run transfers. + // + // SYNC A synchronous API. This type of API optimizes a flow for small to + // medium-sized datasets. + // + // ASYNC An asynchronous API. This type of API optimizes a flow for large datasets. Type DataTransferApiType noSmithyDocumentSerde @@ -916,37 +934,37 @@ type DestinationConnectorProperties struct { // The properties that are required to query the custom Connector. CustomConnector *CustomConnectorDestinationProperties - // The properties required to query Amazon Connect Customer Profiles. + // The properties required to query Amazon Connect Customer Profiles. CustomerProfiles *CustomerProfilesDestinationProperties - // The properties required to query Amazon EventBridge. + // The properties required to query Amazon EventBridge. EventBridge *EventBridgeDestinationProperties - // The properties required to query Amazon Honeycode. + // The properties required to query Amazon Honeycode. Honeycode *HoneycodeDestinationProperties - // The properties required to query Amazon Lookout for Metrics. + // The properties required to query Amazon Lookout for Metrics. LookoutMetrics *LookoutMetricsDestinationProperties // The properties required to query Marketo. Marketo *MarketoDestinationProperties - // The properties required to query Amazon Redshift. + // The properties required to query Amazon Redshift. Redshift *RedshiftDestinationProperties - // The properties required to query Amazon S3. + // The properties required to query Amazon S3. S3 *S3DestinationProperties // The properties required to query SAPOData. SAPOData *SAPODataDestinationProperties - // The properties required to query Salesforce. + // The properties required to query Salesforce. Salesforce *SalesforceDestinationProperties - // The properties required to query Snowflake. + // The properties required to query Snowflake. Snowflake *SnowflakeDestinationProperties - // The properties required to query Upsolver. + // The properties required to query Upsolver. Upsolver *UpsolverDestinationProperties // The properties required to query Zendesk. @@ -955,28 +973,29 @@ type DestinationConnectorProperties struct { noSmithyDocumentSerde } -// The properties that can be applied to a field when connector is being used as a -// destination. +// The properties that can be applied to a field when connector is being used as +// +// a destination. type DestinationFieldProperties struct { - // Specifies if the destination field can be created by the current user. + // Specifies if the destination field can be created by the current user. IsCreatable bool // Specifies whether the field can use the default value during a Create operation. IsDefaultedOnCreate bool - // Specifies if the destination field can have a null value. + // Specifies if the destination field can have a null value. IsNullable bool - // Specifies whether the field can be updated during an UPDATE or UPSERT write + // Specifies whether the field can be updated during an UPDATE or UPSERT write // operation. IsUpdatable bool - // Specifies if the flow run can either insert new rows in the destination field + // 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 + // A list of supported write operations. For each write operation listed, this // field can be used in idFieldNames when that write operation is present as a // destination option. SupportedWriteOperations []WriteOperationType @@ -984,16 +1003,17 @@ type DestinationFieldProperties struct { noSmithyDocumentSerde } -// Contains information about the configuration of destination connectors present +// Contains information about the configuration of destination connectors present +// // in the flow. type DestinationFlowConfig struct { - // The type of connector, such as Salesforce, Amplitude, and so on. + // The type of connector, such as Salesforce, Amplitude, and so on. // // This member is required. ConnectorType ConnectorType - // This stores the information that is required to query a particular connector. + // This stores the information that is required to query a particular connector. // // This member is required. DestinationConnectorProperties *DestinationConnectorProperties @@ -1001,7 +1021,7 @@ type DestinationFlowConfig struct { // The API version that the destination connector uses. ApiVersion *string - // The name of the connector profile. This name must be unique for each connector + // The name of the connector profile. This name must be unique for each connector // profile in the Amazon Web Services account. ConnectorProfileName *string @@ -1011,7 +1031,7 @@ type DestinationFlowConfig struct { // The connector-specific profile credentials required by Dynatrace. type DynatraceConnectorProfileCredentials struct { - // The API tokens used by Dynatrace API to authenticate various API calls. + // The API tokens used by Dynatrace API to authenticate various API calls. // // This member is required. ApiToken *string @@ -1022,7 +1042,7 @@ type DynatraceConnectorProfileCredentials struct { // The connector-specific profile properties required by Dynatrace. type DynatraceConnectorProfileProperties struct { - // The location of the Dynatrace resource. + // The location of the Dynatrace resource. // // This member is required. InstanceUrl *string @@ -1038,7 +1058,7 @@ type DynatraceMetadata struct { // The properties that are applied when Dynatrace is being used as a source. type DynatraceSourceProperties struct { - // The object specified in the Dynatrace flow source. + // The object specified in the Dynatrace flow source. // // This member is required. Object *string @@ -1046,49 +1066,52 @@ type DynatraceSourceProperties struct { noSmithyDocumentSerde } -// The settings that determine how Amazon AppFlow handles an error when placing +// The settings that determine how Amazon AppFlow handles an error when placing +// // data in the destination. For example, this setting would determine if the flow // should fail after one insertion error, or continue and attempt to insert every // record regardless of the initial failure. ErrorHandlingConfig is a part of the // destination connector details. type ErrorHandlingConfig struct { - // Specifies the name of the Amazon S3 bucket. + // Specifies the name of the Amazon S3 bucket. BucketName *string - // Specifies the Amazon S3 bucket prefix. + // Specifies the Amazon S3 bucket prefix. BucketPrefix *string - // Specifies if the flow should fail after the first instance of a failure when + // Specifies if the flow should fail after the first instance of a failure when // attempting to place data in the destination. FailOnFirstDestinationError bool noSmithyDocumentSerde } -// Provides details in the event of a failed flow, including the failure count and -// the related error messages. +// Provides details in the event of a failed flow, including the failure count +// +// and the related error messages. type ErrorInfo struct { - // Specifies the error message that appears if a flow fails. + // Specifies the error message that appears if a flow fails. ExecutionMessage *string - // Specifies the failure count for the attempted flow. + // Specifies the failure count for the attempted flow. PutFailuresCount *int64 noSmithyDocumentSerde } -// The properties that are applied when Amazon EventBridge is being used as a +// The properties that are applied when Amazon EventBridge is being used as a +// // destination. type EventBridgeDestinationProperties struct { - // The object specified in the Amazon EventBridge flow destination. + // The object specified in the Amazon EventBridge flow destination. // // This member is required. Object *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the destination. For example, this setting would determine if the flow // should fail after one insertion error, or continue and attempt to insert every // record regardless of the initial failure. ErrorHandlingConfig is a part of the @@ -1103,17 +1126,18 @@ type EventBridgeMetadata struct { noSmithyDocumentSerde } -// Describes the details of the flow run, including the timestamp, status, and +// Describes the details of the flow run, including the timestamp, status, and +// // message. type ExecutionDetails struct { - // Describes the details of the most recent flow run. + // Describes the details of the most recent flow run. MostRecentExecutionMessage *string - // Specifies the status of the most recent flow run. + // Specifies the status of the most recent flow run. MostRecentExecutionStatus ExecutionStatus - // Specifies the time of the most recent flow run. + // Specifies the time of the most recent flow run. MostRecentExecutionTime *time.Time noSmithyDocumentSerde @@ -1122,32 +1146,32 @@ 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 + // 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 - // in the flow run. + // The timestamp that determines the first new or updated record to be + // transferred in the flow run. DataPullStartTime *time.Time - // Specifies the identifier of the given flow run. + // Specifies the identifier of the given flow run. ExecutionId *string - // Describes the result of the given flow run. + // Describes the result of the given flow run. ExecutionResult *ExecutionResult - // Specifies the flow run status and whether it is in progress, has completed + // Specifies the flow run status and whether it is in progress, has completed // successfully, or has failed. ExecutionStatus ExecutionStatus - // Specifies the time of the most recent update. + // Specifies the time of the most recent update. LastUpdatedAt *time.Time // Describes the metadata catalog, metadata table, and data partitions that Amazon // AppFlow used for the associated flow run. MetadataCatalogDetails []MetadataCatalogDetail - // Specifies the start time of the flow run. + // Specifies the start time of the flow run. StartedAt *time.Time noSmithyDocumentSerde @@ -1156,13 +1180,13 @@ type ExecutionRecord struct { // Specifies the end result of the flow run. type ExecutionResult struct { - // The total number of bytes processed by the flow run. + // The total number of bytes processed by the flow run. BytesProcessed *int64 - // The total number of bytes written as a result of the flow run. + // The total number of bytes written as a result of the flow run. BytesWritten *int64 - // Provides any error message information related to the flow run. + // Provides any error message information related to the flow run. ErrorInfo *ErrorInfo // The maximum number of records that Amazon AppFlow receives in each page of the @@ -1173,22 +1197,23 @@ type ExecutionResult struct { // retrieved your data. NumParallelProcesses *int64 - // The number of records processed in the flow run. + // The number of records processed in the flow run. RecordsProcessed *int64 noSmithyDocumentSerde } -// Contains details regarding the supported field type and the operators that can +// Contains details regarding the supported field type and the operators that can +// // be applied for filtering. type FieldTypeDetails struct { - // The type of field, such as string, integer, date, and so on. + // The type of field, such as string, integer, date, and so on. // // This member is required. FieldType *string - // The list of operators supported by a field. + // The list of operators supported by a field. // // This member is required. FilterOperators []Operator @@ -1202,7 +1227,7 @@ type FieldTypeDetails struct { // The date format that the field supports. SupportedDateFormat *string - // The list of values that a field can contain. For example, a Boolean fieldType + // The list of values that a field can contain. For example, a Boolean fieldType // can have two values: "true" and "false". SupportedValues []string @@ -1212,56 +1237,58 @@ type FieldTypeDetails struct { noSmithyDocumentSerde } -// The properties of the flow, such as its source, destination, trigger type, and +// The properties of the flow, such as its source, destination, trigger type, and +// // so on. type FlowDefinition struct { - // Specifies when the flow was created. + // Specifies when the flow was created. CreatedAt *time.Time - // The ARN of the user who created the flow. + // The ARN of the user who created the flow. CreatedBy *string - // A user-entered description of the flow. + // A user-entered description of the flow. Description *string // The label of the destination connector in the flow. DestinationConnectorLabel *string - // Specifies the destination connector type, such as Salesforce, Amazon S3, + // Specifies the destination connector type, such as Salesforce, Amazon S3, // Amplitude, and so on. DestinationConnectorType ConnectorType - // The flow's Amazon Resource Name (ARN). + // The flow's Amazon Resource Name (ARN). FlowArn *string - // The specified name of the flow. Spaces are not allowed. Use underscores (_) or + // The specified name of the flow. Spaces are not allowed. Use underscores (_) or // hyphens (-) only. FlowName *string - // Indicates the current status of the flow. + // Indicates the current status of the flow. FlowStatus FlowStatus - // Describes the details of the most recent flow run. + // Describes the details of the most recent flow run. LastRunExecutionDetails *ExecutionDetails - // Specifies when the flow was last updated. + // Specifies when the flow was last updated. LastUpdatedAt *time.Time - // Specifies the account user name that most recently updated the flow. + // Specifies the account user name that most recently updated the flow. LastUpdatedBy *string // The label of the source connector in the flow. SourceConnectorLabel *string - // Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, + // Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, // and so on. SourceConnectorType ConnectorType - // The tags used to organize, track, or control access for your flow. + // 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 @@ -1270,25 +1297,29 @@ type FlowDefinition struct { // Specifies the configuration that Amazon AppFlow uses when it catalogs your data // with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores // metadata in Data Catalog tables. This metadata represents the data that's -// transferred by the flow that you configure with these settings. You can -// configure a flow with these settings only when the flow destination is Amazon -// S3. +// transferred by the flow that you configure with these settings. +// +// You can configure a flow with these settings only when the flow destination is +// Amazon S3. type GlueDataCatalogConfig struct { // The name of the Data Catalog database that stores the metadata tables that // Amazon AppFlow creates in your Amazon Web Services account. These tables contain // metadata for the data that's transferred by the flow that you configure with - // this parameter. When you configure a new flow with this parameter, you must - // specify an existing database. + // this parameter. + // + // When you configure a new flow with this parameter, you must specify an existing + // database. // // This member is required. DatabaseName *string // 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) - // . + // + // For an example IAM policy that has the required permissions, see [Identity-based policy examples for Amazon AppFlow]. + // + // [Identity-based 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 @@ -1306,25 +1337,25 @@ type GlueDataCatalogConfig struct { // The connector-specific profile credentials required by Google Analytics. type GoogleAnalyticsConnectorProfileCredentials struct { - // The identifier for the desired client. + // The identifier for the desired client. // // This member is required. ClientId *string - // The client secret used by the OAuth client to authenticate to the authorization - // server. + // The client secret used by the OAuth client to authenticate to the + // authorization server. // // This member is required. ClientSecret *string - // The credentials used to access protected Google Analytics resources. + // The credentials used to access protected Google Analytics resources. AccessToken *string - // The OAuth requirement needed to request security tokens from the connector + // The OAuth requirement needed to request security tokens from the connector // endpoint. OAuthRequest *ConnectorOAuthRequest - // The credentials used to acquire new access tokens. This is required only for + // The credentials used to acquire new access tokens. This is required only for // OAuth2 access tokens, and is not required for OAuth1 access tokens. RefreshToken *string @@ -1339,16 +1370,18 @@ type GoogleAnalyticsConnectorProfileProperties struct { // The connector metadata specific to Google Analytics. type GoogleAnalyticsMetadata struct { - // The desired authorization scope for the Google Analytics account. + // The desired authorization scope for the Google Analytics account. OAuthScopes []string noSmithyDocumentSerde } -// The properties that are applied when Google Analytics is being used as a source. +// The properties that are applied when Google Analytics is being used as a +// +// source. type GoogleAnalyticsSourceProperties struct { - // The object specified in the Google Analytics flow source. + // The object specified in the Google Analytics flow source. // // This member is required. Object *string @@ -1359,14 +1392,14 @@ type GoogleAnalyticsSourceProperties struct { // The connector-specific credentials required when using Amazon Honeycode. type HoneycodeConnectorProfileCredentials struct { - // The credentials used to access protected Amazon Honeycode resources. + // The credentials used to access protected Amazon Honeycode resources. AccessToken *string - // Used by select connectors for which the OAuth workflow is supported, such as + // Used by select connectors for which the OAuth workflow is supported, such as // Salesforce, Google Analytics, Marketo, Zendesk, and Slack. OAuthRequest *ConnectorOAuthRequest - // The credentials used to acquire new access tokens. + // The credentials used to acquire new access tokens. RefreshToken *string noSmithyDocumentSerde @@ -1377,15 +1410,17 @@ type HoneycodeConnectorProfileProperties struct { noSmithyDocumentSerde } -// The properties that are applied when Amazon Honeycode is used as a destination. +// The properties that are applied when Amazon Honeycode is used as a +// +// destination. type HoneycodeDestinationProperties struct { - // The object specified in the Amazon Honeycode flow destination. + // The object specified in the Amazon Honeycode flow destination. // // This member is required. Object *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the destination. For example, this setting would determine if the flow // should fail after one insertion error, or continue and attempt to insert every // record regardless of the initial failure. ErrorHandlingConfig is a part of the @@ -1398,17 +1433,18 @@ type HoneycodeDestinationProperties struct { // The connector metadata specific to Amazon Honeycode. type HoneycodeMetadata struct { - // The desired authorization scope for the Amazon Honeycode account. + // The desired authorization scope for the Amazon Honeycode account. OAuthScopes []string noSmithyDocumentSerde } -// Specifies the configuration used when importing incremental records from the +// Specifies the configuration used when importing incremental records from the +// // source. type IncrementalPullConfig struct { - // A field that specifies the date time or timestamp field as the criteria to use + // A field that specifies the date time or timestamp field as the criteria to use // when importing incremental records from the source. DatetimeTypeFieldName *string @@ -1418,22 +1454,22 @@ type IncrementalPullConfig struct { // The connector-specific profile credentials required by Infor Nexus. type InforNexusConnectorProfileCredentials struct { - // The Access Key portion of the credentials. + // The Access Key portion of the credentials. // // This member is required. AccessKeyId *string - // The encryption keys used to encrypt data. + // The encryption keys used to encrypt data. // // This member is required. Datakey *string - // The secret key used to sign requests. + // The secret key used to sign requests. // // This member is required. SecretAccessKey *string - // The identifier for the user. + // The identifier for the user. // // This member is required. UserId *string @@ -1444,7 +1480,7 @@ type InforNexusConnectorProfileCredentials struct { // The connector-specific profile properties required by Infor Nexus. type InforNexusConnectorProfileProperties struct { - // The location of the Infor Nexus resource. + // The location of the Infor Nexus resource. // // This member is required. InstanceUrl *string @@ -1460,7 +1496,7 @@ type InforNexusMetadata struct { // The properties that are applied when Infor Nexus is being used as a source. type InforNexusSourceProperties struct { - // The object specified in the Infor Nexus flow source. + // The object specified in the Infor Nexus flow source. // // This member is required. Object *string @@ -1480,7 +1516,8 @@ type LambdaConnectorProvisioningConfig struct { noSmithyDocumentSerde } -// The properties that are applied when Amazon Lookout for Metrics is used as a +// The properties that are applied when Amazon Lookout for Metrics is used as a +// // destination. type LookoutMetricsDestinationProperties struct { noSmithyDocumentSerde @@ -1489,21 +1526,21 @@ type LookoutMetricsDestinationProperties struct { // The connector-specific profile credentials required by Marketo. type MarketoConnectorProfileCredentials struct { - // The identifier for the desired client. + // The identifier for the desired client. // // This member is required. ClientId *string - // The client secret used by the OAuth client to authenticate to the authorization - // server. + // The client secret used by the OAuth client to authenticate to the + // authorization server. // // This member is required. ClientSecret *string - // The credentials used to access protected Marketo resources. + // The credentials used to access protected Marketo resources. AccessToken *string - // The OAuth requirement needed to request security tokens from the connector + // The OAuth requirement needed to request security tokens from the connector // endpoint. OAuthRequest *ConnectorOAuthRequest @@ -1513,7 +1550,7 @@ type MarketoConnectorProfileCredentials struct { // The connector-specific profile properties required when using Marketo. type MarketoConnectorProfileProperties struct { - // The location of the Marketo resource. + // The location of the Marketo resource. // // This member is required. InstanceUrl *string @@ -1530,7 +1567,7 @@ type MarketoDestinationProperties struct { // This member is required. Object *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the destination. For example, this setting would determine if the flow // should fail after one insertion error, or continue and attempt to insert every // record regardless of the initial failure. ErrorHandlingConfig is a part of the @@ -1548,7 +1585,7 @@ type MarketoMetadata struct { // The properties that are applied when Marketo is being used as a source. type MarketoSourceProperties struct { - // The object specified in the Marketo flow source. + // The object specified in the Marketo flow source. // // This member is required. Object *string @@ -1573,9 +1610,10 @@ type MetadataCatalogConfig struct { type MetadataCatalogDetail struct { // The type of metadata catalog that Amazon AppFlow used for the associated flow - // run. This parameter returns the following value: GLUE The metadata catalog is - // provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a - // component. + // run. This parameter returns the following value: + // + // GLUE The metadata catalog is provided by the Glue Data Catalog. Glue includes + // the Glue Data Catalog as a component. CatalogType CatalogType // Describes the status of the attempt from Amazon AppFlow to register the data @@ -1611,7 +1649,7 @@ type OAuth2Credentials struct { // server. ClientSecret *string - // Used by select connectors for which the OAuth workflow is supported, such as + // Used by select connectors for which the OAuth workflow is supported, such as // Salesforce, Google Analytics, Marketo, Zendesk, and Slack. OAuthRequest *ConnectorOAuthRequest @@ -1694,25 +1732,25 @@ type OAuth2Properties struct { // The OAuth credentials required for OAuth type authentication. type OAuthCredentials struct { - // The identifier for the desired client. + // The identifier for the desired client. // // This member is required. ClientId *string - // The client secret used by the OAuth client to authenticate to the authorization - // server. + // The client secret used by the OAuth client to authenticate to the + // authorization server. // // This member is required. ClientSecret *string - // The access token used to access protected SAPOData resources. + // The access token used to access protected SAPOData resources. AccessToken *string - // The OAuth requirement needed to request security tokens from the connector + // The OAuth requirement needed to request security tokens from the connector // endpoint. OAuthRequest *ConnectorOAuthRequest - // The refresh token used to refresh expired access token. + // The refresh token used to refresh expired access token. RefreshToken *string noSmithyDocumentSerde @@ -1721,18 +1759,18 @@ type OAuthCredentials struct { // The OAuth properties required for OAuth type authentication. type OAuthProperties struct { - // The authorization code url required to redirect to SAP Login Page to fetch + // The authorization code url required to redirect to SAP Login Page to fetch // authorization code for OAuth type authentication. // // This member is required. AuthCodeUrl *string - // The OAuth scopes required for OAuth type authentication. + // The OAuth scopes required for OAuth type authentication. // // This member is required. OAuthScopes []string - // The token url required to fetch access/refresh tokens using authorization code + // The token url required to fetch access/refresh tokens using authorization code // and also to refresh expired access token using refresh token. // // This member is required. @@ -1752,7 +1790,7 @@ type PardotConnectorProfileCredentials struct { // connected app. ClientCredentialsArn *string - // Used by select connectors for which the OAuth workflow is supported, such as + // Used by select connectors for which the OAuth workflow is supported, such as // Salesforce, Google Analytics, Marketo, Zendesk, and Slack. OAuthRequest *ConnectorOAuthRequest @@ -1800,12 +1838,18 @@ type PardotSourceProperties struct { type PrefixConfig struct { // Specifies whether the destination file path includes either or both of the - // following elements: EXECUTION_ID The ID that Amazon AppFlow assigns to the flow - // 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: + // following elements: + // + // EXECUTION_ID The ID that Amazon AppFlow assigns to the flow 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 PathPrefixHierarchy []PathPrefix @@ -1823,13 +1867,13 @@ type PrefixConfig struct { // Specifies the private connection provisioning state. type PrivateConnectionProvisioningState struct { - // Specifies the private connection provisioning failure cause. + // Specifies the private connection provisioning failure cause. FailureCause PrivateConnectionProvisioningFailureCause - // Specifies the private connection provisioning failure reason. + // Specifies the private connection provisioning failure reason. FailureMessage *string - // Specifies the private connection provisioning status. + // Specifies the private connection provisioning status. Status PrivateConnectionProvisioningStatus noSmithyDocumentSerde @@ -1847,13 +1891,15 @@ type Range struct { noSmithyDocumentSerde } -// The connector-specific profile credentials required when using Amazon Redshift. +// The connector-specific profile credentials required when using Amazon +// +// Redshift. type RedshiftConnectorProfileCredentials struct { - // The password that corresponds to the user name. + // The password that corresponds to the user name. Password *string - // The name of the user. + // The name of the user. Username *string noSmithyDocumentSerde @@ -1862,21 +1908,21 @@ type RedshiftConnectorProfileCredentials struct { // The connector-specific profile properties when using Amazon Redshift. type RedshiftConnectorProfileProperties struct { - // A name for the associated Amazon S3 bucket. + // A name for the associated Amazon S3 bucket. // // This member is required. BucketName *string - // The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift + // 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) - // . + // you attach to this role, see [Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3]. + // + // [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 - // The object key for the destination bucket in which Amazon AppFlow places the + // The object key for the destination bucket in which Amazon AppFlow places the // files. BucketPrefix *string @@ -1885,15 +1931,15 @@ 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) - // . + // and for the polices that you attach to this role, see [Allow Amazon AppFlow to access Amazon Redshift databases with the Data API]. + // + // [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 DataApiRoleArn *string // The name of an Amazon Redshift database. DatabaseName *string - // The JDBC URL of the Amazon Redshift cluster. + // The JDBC URL of the Amazon Redshift cluster. DatabaseUrl *string // Indicates whether the connector profile defines a connection to an Amazon @@ -1906,26 +1952,27 @@ type RedshiftConnectorProfileProperties struct { noSmithyDocumentSerde } -// The properties that are applied when Amazon Redshift is being used as a +// The properties that are applied when Amazon Redshift is being used as a +// // destination. type RedshiftDestinationProperties struct { - // The intermediate bucket that Amazon AppFlow uses when moving data into Amazon + // The intermediate bucket that Amazon AppFlow uses when moving data into Amazon // Redshift. // // This member is required. IntermediateBucketName *string - // The object specified in the Amazon Redshift flow destination. + // The object specified in the Amazon Redshift flow destination. // // This member is required. Object *string - // The object key for the bucket in which Amazon AppFlow places the destination + // The object key for the bucket in which Amazon AppFlow places the destination // files. BucketPrefix *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the Amazon Redshift destination. For example, this setting would // determine if the flow should fail after one insertion error, or continue and // attempt to insert every record regardless of the initial failure. @@ -1941,6 +1988,7 @@ type RedshiftMetadata struct { } // Describes the status of an attempt from Amazon AppFlow to register a resource. +// // When you run a flow that you've configured to use a metadata catalog, Amazon // AppFlow registers a metadata table and data partitions with that catalog. This // operation provides the status of that registration attempt. The operation also @@ -1964,27 +2012,28 @@ type RegistrationOutput struct { // The properties that are applied when Amazon S3 is used as a destination. type S3DestinationProperties struct { - // The Amazon S3 bucket name in which Amazon AppFlow places the transferred data. + // The Amazon S3 bucket name in which Amazon AppFlow places the transferred data. // // This member is required. BucketName *string - // The object key for the destination bucket in which Amazon AppFlow places the + // The object key for the destination bucket in which Amazon AppFlow places the // files. BucketPrefix *string - // The configuration that determines how Amazon AppFlow should format the flow + // The configuration that determines how Amazon AppFlow should format the flow // output data when Amazon S3 is used as the destination. S3OutputFormatConfig *S3OutputFormatConfig noSmithyDocumentSerde } -// When you use Amazon S3 as the source, the configuration format that you provide -// the flow input data. +// When you use Amazon S3 as the source, the configuration format that you +// +// provide the flow input data. type S3InputFormatConfig struct { - // The file type that Amazon AppFlow gets from your Amazon S3 bucket. + // The file type that Amazon AppFlow gets from your Amazon S3 bucket. S3InputFileType S3InputFileType noSmithyDocumentSerde @@ -1995,27 +2044,30 @@ type S3Metadata struct { noSmithyDocumentSerde } -// The configuration that determines how Amazon AppFlow should format the flow +// The configuration that determines how Amazon AppFlow should format the flow +// // 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 + // 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. + // Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket. FileType FileType - // Determines the prefix that Amazon AppFlow applies to the folder name in the + // Determines the prefix that Amazon AppFlow applies to the folder name in the // Amazon S3 bucket. You can name folders according to the flow frequency and date. PrefixConfig *PrefixConfig // 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. @@ -2024,19 +2076,21 @@ type S3OutputFormatConfig struct { noSmithyDocumentSerde } -// The properties that are applied when Amazon S3 is being used as the flow source. +// The properties that are applied when Amazon S3 is being used as the flow +// +// source. type S3SourceProperties struct { - // The Amazon S3 bucket name where the source files are stored. + // The Amazon S3 bucket name where the source files are stored. // // This member is required. BucketName *string - // The object key for the Amazon S3 bucket in which the source files are stored. + // The object key for the Amazon S3 bucket in which the source files are stored. BucketPrefix *string - // When you use Amazon S3 as the source, the configuration format that you provide - // the flow input data. + // When you use Amazon S3 as the source, the configuration format that you + // provide the flow input data. S3InputFormatConfig *S3InputFormatConfig noSmithyDocumentSerde @@ -2045,10 +2099,10 @@ type S3SourceProperties struct { // The connector-specific profile credentials required when using Salesforce. type SalesforceConnectorProfileCredentials struct { - // The credentials used to access protected Salesforce resources. + // The credentials used to access protected Salesforce resources. AccessToken *string - // The secret manager ARN, which contains the client ID and client secret of the + // The secret manager ARN, which contains the client ID and client secret of the // connected app. ClientCredentialsArn *string @@ -2058,14 +2112,20 @@ type SalesforceConnectorProfileCredentials struct { // Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an // access token from Salesforce. Amazon AppFlow requires an access token each time - // it attempts to access your Salesforce records. You can specify one of the - // following values: AUTHORIZATION_CODE Amazon AppFlow passes an authorization code - // when it requests the access token from Salesforce. Amazon AppFlow receives the - // authorization code from Salesforce after you log in to your Salesforce account - // and authorize Amazon AppFlow to access your records. CLIENT_CREDENTIALS Amazon - // AppFlow passes client credentials (a client ID and client secret) when it - // requests the access token from Salesforce. You provide these credentials to - // Amazon AppFlow when you define the connection to your Salesforce account. + // it attempts to access your Salesforce records. + // + // You can specify one of the following values: + // + // AUTHORIZATION_CODE Amazon AppFlow passes an authorization code when it requests + // the access token from Salesforce. Amazon AppFlow receives the authorization code + // from Salesforce after you log in to your Salesforce account and authorize Amazon + // AppFlow to access your records. + // + // CLIENT_CREDENTIALS Amazon AppFlow passes client credentials (a client ID and + // client secret) when it requests the access token from Salesforce. You provide + // these credentials to Amazon AppFlow when you define the connection to your + // Salesforce account. + // // JWT_BEARER Amazon AppFlow passes a JSON web token (JWT) when it requests the // access token from Salesforce. You provide the JWT to Amazon AppFlow when you // define the connection to your Salesforce account. When you use this grant type, @@ -2073,11 +2133,11 @@ type SalesforceConnectorProfileCredentials struct { // to access your records. OAuth2GrantType OAuth2GrantType - // The OAuth requirement needed to request security tokens from the connector + // The OAuth requirement needed to request security tokens from the connector // endpoint. OAuthRequest *ConnectorOAuthRequest - // The credentials used to acquire new access tokens. + // The credentials used to acquire new access tokens. RefreshToken *string noSmithyDocumentSerde @@ -2086,10 +2146,10 @@ type SalesforceConnectorProfileCredentials struct { // The connector-specific profile properties required when using Salesforce. type SalesforceConnectorProfileProperties struct { - // The location of the Salesforce resource. + // The location of the Salesforce resource. InstanceUrl *string - // Indicates whether the connector profile applies to a sandbox or production + // Indicates whether the connector profile applies to a sandbox or production // environment. IsSandboxEnvironment bool @@ -2097,72 +2157,95 @@ type SalesforceConnectorProfileProperties struct { // 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: + // 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: + // 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. UsePrivateLinkForMetadataAndAuthorization bool noSmithyDocumentSerde } -// The properties that are applied when Salesforce is being used as a destination. +// The properties that are applied when Salesforce is being used as a +// +// destination. type SalesforceDestinationProperties struct { - // The object specified in the Salesforce flow destination. + // The object specified in the Salesforce flow destination. // // This member is required. Object *string // Specifies which Salesforce API is used by Amazon AppFlow when your flow - // transfers data to Salesforce. AUTOMATIC The default. Amazon AppFlow selects - // which API to use based on the number of records that your flow transfers to - // Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses - // Salesforce REST API. If your flow transfers 1,000 records or more, Amazon - // AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs structures - // data differently. If Amazon AppFlow selects the API automatically, be aware - // that, for recurring flows, the data output might vary from one flow run to the - // next. For example, if a flow runs daily, it might use REST API on one day to - // transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer - // 1,100 records. For each of these flow runs, the respective Salesforce API - // formats the data differently. Some of the differences include how dates are - // formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer - // Salesforce compound fields. By choosing this option, you optimize flow - // performance for both small and large data transfers, but the tradeoff is - // inconsistent formatting in the output. BULKV2 Amazon AppFlow uses only - // Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's - // optimal for large sets of data. By choosing this option, you ensure that your - // flow writes consistent output, but you optimize performance only for large data - // transfers. Note that Bulk API 2.0 does not transfer Salesforce compound fields. - // REST_SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this option, - // you ensure that your flow writes consistent output, but you decrease performance - // for large data transfers that are better suited for Bulk API 2.0. In some cases, - // if your flow attempts to transfer a vary large set of data, it might fail with a - // timed out error. + // transfers data to Salesforce. + // + // AUTOMATIC The default. Amazon AppFlow selects which API to use based on the + // number of records that your flow transfers to Salesforce. If your flow transfers + // fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow + // transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. + // + // Each of these Salesforce APIs structures data differently. If Amazon AppFlow + // selects the API automatically, be aware that, for recurring flows, the data + // output might vary from one flow run to the next. For example, if a flow runs + // daily, it might use REST API on one day to transfer 900 records, and it might + // use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these + // flow runs, the respective Salesforce API formats the data differently. Some of + // the differences include how dates are formatted and null values are represented. + // Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. + // + // By choosing this option, you optimize flow performance for both small and large + // data transfers, but the tradeoff is inconsistent formatting in the output. + // + // BULKV2 Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs + // asynchronous data transfers, and it's optimal for large sets of data. By + // choosing this option, you ensure that your flow writes consistent output, but + // you optimize performance only for large data transfers. + // + // Note that Bulk API 2.0 does not transfer Salesforce compound fields. + // + // REST_SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this + // option, you ensure that your flow writes consistent output, but you decrease + // performance for large data transfers that are better suited for Bulk API 2.0. In + // some cases, if your flow attempts to transfer a vary large set of data, it might + // fail with a timed out error. DataTransferApi SalesforceDataTransferApi - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the Salesforce destination. For example, this setting would determine if // the flow should fail after one insertion error, or continue and attempt to // insert every record regardless of the initial failure. ErrorHandlingConfig is a // part of the destination connector details. ErrorHandlingConfig *ErrorHandlingConfig - // The name of the field that Amazon AppFlow uses as an ID when performing a write - // operation such as update or delete. + // The name of the field that Amazon AppFlow uses as an ID when performing a + // write operation such as update or delete. IdFieldNames []string - // This specifies the type of write operation to be performed in Salesforce. When + // This specifies the type of write operation to be performed in Salesforce. When // the value is UPSERT , then idFieldNames is required. WriteOperationType WriteOperationType @@ -2176,23 +2259,28 @@ type SalesforceMetadata struct { // transfers data to or from Salesforce. DataTransferApis []SalesforceDataTransferApi - // The desired authorization scope for the Salesforce account. + // The desired authorization scope for the Salesforce account. OAuthScopes []string // The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an // access token from Salesforce. Amazon AppFlow requires an access token each time - // it attempts to access your Salesforce records. AUTHORIZATION_CODE Amazon AppFlow - // passes an authorization code when it requests the access token from Salesforce. - // Amazon AppFlow receives the authorization code from Salesforce after you log in - // to your Salesforce account and authorize Amazon AppFlow to access your records. + // it attempts to access your Salesforce records. + // + // AUTHORIZATION_CODE Amazon AppFlow passes an authorization code when it requests + // the access token from Salesforce. Amazon AppFlow receives the authorization code + // from Salesforce after you log in to your Salesforce account and authorize Amazon + // AppFlow to access your records. + // // CLIENT_CREDENTIALS Amazon AppFlow passes client credentials (a client ID and // client secret) when it requests the access token from Salesforce. You provide // these credentials to Amazon AppFlow when you define the connection to your - // Salesforce account. JWT_BEARER Amazon AppFlow passes a JSON web token (JWT) when - // it requests the access token from Salesforce. You provide the JWT to Amazon - // AppFlow when you define the connection to your Salesforce account. When you use - // this grant type, you don't need to log in to your Salesforce account to - // authorize Amazon AppFlow to access your records. + // Salesforce account. + // + // JWT_BEARER Amazon AppFlow passes a JSON web token (JWT) when it requests the + // access token from Salesforce. You provide the JWT to Amazon AppFlow when you + // define the connection to your Salesforce account. When you use this grant type, + // you don't need to log in to your Salesforce account to authorize Amazon AppFlow + // to access your records. Oauth2GrantTypesSupported []OAuth2GrantType noSmithyDocumentSerde @@ -2201,43 +2289,51 @@ type SalesforceMetadata struct { // The properties that are applied when Salesforce is being used as a source. type SalesforceSourceProperties struct { - // The object specified in the Salesforce flow source. + // The object specified in the Salesforce flow source. // // This member is required. Object *string // Specifies which Salesforce API is used by Amazon AppFlow when your flow - // transfers data from Salesforce. AUTOMATIC The default. Amazon AppFlow selects - // which API to use based on the number of records that your flow transfers from - // Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow - // uses Salesforce REST API. If your flow transfers 1,000,000 records or more, - // Amazon AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs - // structures data differently. If Amazon AppFlow selects the API automatically, be - // aware that, for recurring flows, the data output might vary from one flow run to - // the next. For example, if a flow runs daily, it might use REST API on one day to - // transfer 900,000 records, and it might use Bulk API 2.0 on the next day to - // transfer 1,100,000 records. For each of these flow runs, the respective - // Salesforce API formats the data differently. Some of the differences include how - // dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't - // transfer Salesforce compound fields. By choosing this option, you optimize flow - // performance for both small and large data transfers, but the tradeoff is - // inconsistent formatting in the output. BULKV2 Amazon AppFlow uses only - // Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's - // optimal for large sets of data. By choosing this option, you ensure that your - // flow writes consistent output, but you optimize performance only for large data - // transfers. Note that Bulk API 2.0 does not transfer Salesforce compound fields. - // REST_SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this option, - // you ensure that your flow writes consistent output, but you decrease performance - // for large data transfers that are better suited for Bulk API 2.0. In some cases, - // if your flow attempts to transfer a vary large set of data, it might fail wituh - // a timed out error. + // transfers data from Salesforce. + // + // AUTOMATIC The default. Amazon AppFlow selects which API to use based on the + // number of records that your flow transfers from Salesforce. If your flow + // transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. + // If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce + // Bulk API 2.0. + // + // Each of these Salesforce APIs structures data differently. If Amazon AppFlow + // selects the API automatically, be aware that, for recurring flows, the data + // output might vary from one flow run to the next. For example, if a flow runs + // daily, it might use REST API on one day to transfer 900,000 records, and it + // might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each + // of these flow runs, the respective Salesforce API formats the data differently. + // Some of the differences include how dates are formatted and null values are + // represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. + // + // By choosing this option, you optimize flow performance for both small and large + // data transfers, but the tradeoff is inconsistent formatting in the output. + // + // BULKV2 Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs + // asynchronous data transfers, and it's optimal for large sets of data. By + // choosing this option, you ensure that your flow writes consistent output, but + // you optimize performance only for large data transfers. + // + // Note that Bulk API 2.0 does not transfer Salesforce compound fields. + // + // REST_SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this + // option, you ensure that your flow writes consistent output, but you decrease + // performance for large data transfers that are better suited for Bulk API 2.0. In + // some cases, if your flow attempts to transfer a vary large set of data, it might + // fail wituh a timed out error. DataTransferApi SalesforceDataTransferApi - // The flag that enables dynamic fetching of new (recently added) fields in the + // The flag that enables dynamic fetching of new (recently added) fields in the // Salesforce objects while running a flow. EnableDynamicFieldUpdate bool - // Indicates whether Amazon AppFlow includes deleted files in the flow run. + // Indicates whether Amazon AppFlow includes deleted files in the flow run. IncludeDeletedRecords bool noSmithyDocumentSerde @@ -2246,10 +2342,10 @@ type SalesforceSourceProperties struct { // The connector-specific profile credentials required when using SAPOData. type SAPODataConnectorProfileCredentials struct { - // The SAPOData basic authentication credentials. + // The SAPOData basic authentication credentials. BasicAuthCredentials *BasicAuthCredentials - // The SAPOData OAuth type authentication credentials. + // The SAPOData OAuth type authentication credentials. OAuthCredentials *OAuthCredentials noSmithyDocumentSerde @@ -2258,28 +2354,29 @@ type SAPODataConnectorProfileCredentials struct { // The connector-specific profile properties required when using SAPOData. type SAPODataConnectorProfileProperties struct { - // The location of the SAPOData resource. + // The location of the SAPOData resource. // // This member is required. ApplicationHostUrl *string - // The application path to catalog service. + // The application path to catalog service. // // This member is required. ApplicationServicePath *string - // The client number for the client creating the connection. + // The client number for the client creating the connection. // // This member is required. ClientNumber *string - // The port number of the SAPOData instance. + // The port number of the SAPOData instance. // // This member is required. PortNumber *int32 // If you set this parameter to true , Amazon AppFlow bypasses the single sign-on // (SSO) settings in your SAP account when it accesses your SAP OData instance. + // // Whether you need this option depends on the types of credentials that you // applied to your SAP OData connection profile. If your profile uses basic // authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting @@ -2288,13 +2385,13 @@ type SAPODataConnectorProfileProperties struct { // profile uses OAuth credentials, this parameter has no affect. DisableSSO bool - // The logon language of SAPOData instance. + // The logon language of SAPOData instance. LogonLanguage *string - // The SAPOData OAuth properties required for OAuth type authentication. + // The SAPOData OAuth properties required for OAuth type authentication. OAuthProperties *OAuthProperties - // The SAPOData Private Link service name to be used for private data transfers. + // The SAPOData Private Link service name to be used for private data transfers. PrivateLinkServiceName *string noSmithyDocumentSerde @@ -2308,24 +2405,25 @@ type SAPODataDestinationProperties struct { // This member is required. ObjectPath *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the destination. For example, this setting would determine if the flow // should fail after one insertion error, or continue and attempt to insert every // record regardless of the initial failure. ErrorHandlingConfig is a part of the // destination connector details. ErrorHandlingConfig *ErrorHandlingConfig - // A list of field names that can be used as an ID field when performing a write + // A list of field names that can be used as an ID field when performing a write // 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. + // 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 + // The possible write operations in the destination connector. When this value is // not provided, this defaults to the INSERT operation. WriteOperationType WriteOperationType @@ -2372,7 +2470,7 @@ type SAPODataParallelismConfig struct { // The properties that are applied when using SAPOData as a flow source. type SAPODataSourceProperties struct { - // The object path specified in the SAPOData flow source. + // The object path specified in the SAPOData flow source. ObjectPath *string // Sets the page size for each concurrent process that transfers OData records @@ -2386,21 +2484,22 @@ type SAPODataSourceProperties struct { noSmithyDocumentSerde } -// Specifies the configuration details of a schedule-triggered flow as defined by +// Specifies the configuration details of a schedule-triggered flow as defined by +// // the user. 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 + // The scheduling expression that determines the rate at which the schedule will // run, for example rate(5minutes) . // // This member is required. ScheduleExpression *string - // Specifies whether a scheduled flow has an incremental data transfer or a + // Specifies whether a scheduled flow has an incremental data transfer or a // complete data transfer for each flow run. DataPullMode DataPullMode - // Specifies the date range for the records to import from the connector in the + // Specifies the date range for the records to import from the connector in the // first flow run. FirstExecutionFrom *time.Time @@ -2412,7 +2511,7 @@ type ScheduledTriggerProperties struct { // 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 + // Specifies the optional offset that is added to the time interval for a // schedule-triggered flow. ScheduleOffset *int64 @@ -2423,10 +2522,11 @@ type ScheduledTriggerProperties struct { // 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 // 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 . + // 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 . Timezone *string noSmithyDocumentSerde @@ -2435,13 +2535,13 @@ type ScheduledTriggerProperties struct { // The connector-specific profile credentials required when using ServiceNow. type ServiceNowConnectorProfileCredentials struct { - // The OAuth 2.0 credentials required to authenticate the user. + // The OAuth 2.0 credentials required to authenticate the user. OAuth2Credentials *OAuth2Credentials - // The password that corresponds to the user name. + // The password that corresponds to the user name. Password *string - // The name of the user. + // The name of the user. Username *string noSmithyDocumentSerde @@ -2450,7 +2550,7 @@ type ServiceNowConnectorProfileCredentials struct { // The connector-specific profile properties required when using ServiceNow. type ServiceNowConnectorProfileProperties struct { - // The location of the ServiceNow resource. + // The location of the ServiceNow resource. // // This member is required. InstanceUrl *string @@ -2466,7 +2566,7 @@ type ServiceNowMetadata struct { // The properties that are applied when ServiceNow is being used as a source. type ServiceNowSourceProperties struct { - // The object specified in the ServiceNow flow source. + // The object specified in the ServiceNow flow source. // // This member is required. Object *string @@ -2477,7 +2577,7 @@ type ServiceNowSourceProperties struct { // The connector-specific profile credentials required when using Singular. type SingularConnectorProfileCredentials struct { - // A unique alphanumeric identifier used to authenticate a user, developer, or + // A unique alphanumeric identifier used to authenticate a user, developer, or // calling program to your API. // // This member is required. @@ -2499,7 +2599,7 @@ type SingularMetadata struct { // The properties that are applied when Singular is being used as a source. type SingularSourceProperties struct { - // The object specified in the Singular flow source. + // The object specified in the Singular flow source. // // This member is required. Object *string @@ -2510,21 +2610,21 @@ type SingularSourceProperties struct { // The connector-specific profile credentials required when using Slack. type SlackConnectorProfileCredentials struct { - // The identifier for the client. + // The identifier for the client. // // This member is required. ClientId *string - // The client secret used by the OAuth client to authenticate to the authorization - // server. + // The client secret used by the OAuth client to authenticate to the + // authorization server. // // This member is required. ClientSecret *string - // The credentials used to access protected Slack resources. + // The credentials used to access protected Slack resources. AccessToken *string - // The OAuth requirement needed to request security tokens from the connector + // The OAuth requirement needed to request security tokens from the connector // endpoint. OAuthRequest *ConnectorOAuthRequest @@ -2534,7 +2634,7 @@ type SlackConnectorProfileCredentials struct { // The connector-specific profile properties required when using Slack. type SlackConnectorProfileProperties struct { - // The location of the Slack resource. + // The location of the Slack resource. // // This member is required. InstanceUrl *string @@ -2545,7 +2645,7 @@ type SlackConnectorProfileProperties struct { // The connector metadata specific to Slack. type SlackMetadata struct { - // The desired authorization scope for the Slack account. + // The desired authorization scope for the Slack account. OAuthScopes []string noSmithyDocumentSerde @@ -2554,7 +2654,7 @@ type SlackMetadata struct { // The properties that are applied when Slack is being used as a source. type SlackSourceProperties struct { - // The object specified in the Slack flow source. + // The object specified in the Slack flow source. // // This member is required. Object *string @@ -2565,12 +2665,12 @@ type SlackSourceProperties struct { // The connector-specific profile credentials required when using Snowflake. type SnowflakeConnectorProfileCredentials struct { - // The password that corresponds to the user name. + // The password that corresponds to the user name. // // This member is required. Password *string - // The name of the user. + // The name of the user. // // This member is required. Username *string @@ -2581,33 +2681,33 @@ type SnowflakeConnectorProfileCredentials struct { // The connector-specific profile properties required when using Snowflake. type SnowflakeConnectorProfileProperties struct { - // The name of the Amazon S3 bucket associated with Snowflake. + // The name of the Amazon S3 bucket associated with Snowflake. // // This member is required. BucketName *string - // The name of the Amazon S3 stage that was created while setting up an Amazon S3 + // The name of the Amazon S3 stage that was created while setting up an Amazon S3 // stage in the Snowflake account. This is written in the following format: < // Database>< Schema>. // // This member is required. Stage *string - // The name of the Snowflake warehouse. + // The name of the Snowflake warehouse. // // This member is required. Warehouse *string - // The name of the account. + // The name of the account. AccountName *string - // The bucket path that refers to the Amazon S3 bucket associated with Snowflake. + // The bucket path that refers to the Amazon S3 bucket associated with Snowflake. BucketPrefix *string - // The Snowflake Private Link service name to be used for private data transfers. + // The Snowflake Private Link service name to be used for private data transfers. PrivateLinkServiceName *string - // The Amazon Web Services Region of the Snowflake account. + // The Amazon Web Services Region of the Snowflake account. Region *string noSmithyDocumentSerde @@ -2616,22 +2716,22 @@ type SnowflakeConnectorProfileProperties struct { // The properties that are applied when Snowflake is being used as a destination. type SnowflakeDestinationProperties struct { - // The intermediate bucket that Amazon AppFlow uses when moving data into + // The intermediate bucket that Amazon AppFlow uses when moving data into // Snowflake. // // This member is required. IntermediateBucketName *string - // The object specified in the Snowflake flow destination. + // The object specified in the Snowflake flow destination. // // This member is required. Object *string - // The object key for the destination bucket in which Amazon AppFlow places the + // The object key for the destination bucket in which Amazon AppFlow places the // files. BucketPrefix *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the Snowflake destination. For example, this setting would determine if // the flow should fail after one insertion error, or continue and attempt to // insert every record regardless of the initial failure. ErrorHandlingConfig is a @@ -2644,7 +2744,7 @@ type SnowflakeDestinationProperties struct { // The connector metadata specific to Snowflake. type SnowflakeMetadata struct { - // Specifies the supported Amazon Web Services Regions when using Snowflake. + // Specifies the supported Amazon Web Services Regions when using Snowflake. SupportedRegions []string noSmithyDocumentSerde @@ -2653,69 +2753,70 @@ type SnowflakeMetadata struct { // Specifies the information that is required to query a particular connector. type SourceConnectorProperties struct { - // Specifies the information that is required for querying Amplitude. + // Specifies the information that is required for querying Amplitude. Amplitude *AmplitudeSourceProperties // The properties that are applied when the custom connector is being used as a // source. CustomConnector *CustomConnectorSourceProperties - // Specifies the information that is required for querying Datadog. + // Specifies the information that is required for querying Datadog. Datadog *DatadogSourceProperties - // Specifies the information that is required for querying Dynatrace. + // Specifies the information that is required for querying Dynatrace. Dynatrace *DynatraceSourceProperties - // Specifies the information that is required for querying Google Analytics. + // Specifies the information that is required for querying Google Analytics. GoogleAnalytics *GoogleAnalyticsSourceProperties - // Specifies the information that is required for querying Infor Nexus. + // Specifies the information that is required for querying Infor Nexus. InforNexus *InforNexusSourceProperties - // Specifies the information that is required for querying Marketo. + // Specifies the information that is required for querying Marketo. Marketo *MarketoSourceProperties // Specifies the information that is required for querying Salesforce Pardot. Pardot *PardotSourceProperties - // Specifies the information that is required for querying Amazon S3. + // Specifies the information that is required for querying Amazon S3. S3 *S3SourceProperties - // The properties that are applied when using SAPOData as a flow source. + // The properties that are applied when using SAPOData as a flow source. SAPOData *SAPODataSourceProperties - // Specifies the information that is required for querying Salesforce. + // Specifies the information that is required for querying Salesforce. Salesforce *SalesforceSourceProperties - // Specifies the information that is required for querying ServiceNow. + // Specifies the information that is required for querying ServiceNow. ServiceNow *ServiceNowSourceProperties - // Specifies the information that is required for querying Singular. + // Specifies the information that is required for querying Singular. Singular *SingularSourceProperties - // Specifies the information that is required for querying Slack. + // Specifies the information that is required for querying Slack. Slack *SlackSourceProperties - // Specifies the information that is required for querying Trend Micro. + // Specifies the information that is required for querying Trend Micro. Trendmicro *TrendmicroSourceProperties - // Specifies the information that is required for querying Veeva. + // Specifies the information that is required for querying Veeva. Veeva *VeevaSourceProperties - // Specifies the information that is required for querying Zendesk. + // Specifies the information that is required for querying Zendesk. Zendesk *ZendeskSourceProperties noSmithyDocumentSerde } -// The properties that can be applied to a field when the connector is being used +// The properties that can be applied to a field when the connector is being used +// // as a source. type SourceFieldProperties struct { - // Indicates if the field can be queried. + // Indicates if the field can be queried. IsQueryable bool - // Indicates whether the field can be returned in a search result. + // Indicates whether the field can be returned in a search result. IsRetrievable bool // Indicates if this timestamp field can be used for incremental queries. @@ -2724,16 +2825,17 @@ type SourceFieldProperties struct { noSmithyDocumentSerde } -// Contains information about the configuration of the source connector used in +// 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. + // The type of connector, such as Salesforce, Amplitude, and so on. // // This member is required. ConnectorType ConnectorType - // Specifies the information that is required to query a particular source + // Specifies the information that is required to query a particular source // connector. // // This member is required. @@ -2742,11 +2844,11 @@ type SourceFlowConfig struct { // The API version of the connector when it's used as a source in the flow. ApiVersion *string - // The name of the connector profile. This name must be unique for each connector + // The name of the connector profile. This name must be unique for each connector // profile in the Amazon Web Services account. ConnectorProfileName *string - // Defines the configuration for a scheduled incremental data pull. If a valid + // Defines the configuration for a scheduled incremental data pull. If a valid // configuration is provided, the fields specified in the configuration are used // when querying for the incremental data pull. IncrementalPullConfig *IncrementalPullConfig @@ -2755,9 +2857,10 @@ type SourceFlowConfig struct { } // 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. +// 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. @@ -2769,11 +2872,12 @@ type SuccessResponseHandlingConfig struct { noSmithyDocumentSerde } -// Contains details regarding all the supported FieldTypes and their corresponding -// filterOperators and supportedValues . +// Contains details regarding all the supported FieldTypes and their +// +// corresponding 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. @@ -2782,28 +2886,29 @@ type SupportedFieldTypeDetails struct { noSmithyDocumentSerde } -// A class for modeling different type of tasks. Task implementation varies based +// A class for modeling different type of tasks. Task implementation varies based +// // on the TaskType . type Task struct { - // The source fields to which a particular task is applied. + // The source fields to which a particular task is applied. // // This member is required. SourceFields []string - // Specifies the particular task implementation that Amazon AppFlow performs. + // Specifies the particular task implementation that Amazon AppFlow performs. // // This member is required. TaskType TaskType - // The operation to be performed on the provided source fields. + // The operation to be performed on the provided source fields. ConnectorOperator *ConnectorOperator - // A field in a destination connector, or a field value against which Amazon + // A field in a destination connector, or a field value against which Amazon // AppFlow validates a source field. DestinationField *string - // A map used to store task-related information. The execution service looks for + // A map used to store task-related information. The execution service looks for // particular information based on the TaskType . TaskProperties map[string]string @@ -2813,7 +2918,7 @@ type Task struct { // The connector-specific profile credentials required when using Trend Micro. type TrendmicroConnectorProfileCredentials struct { - // The Secret Access Key portion of the credentials. + // The Secret Access Key portion of the credentials. // // This member is required. ApiSecretKey *string @@ -2834,7 +2939,7 @@ type TrendmicroMetadata struct { // The properties that are applied when using Trend Micro as a flow source. type TrendmicroSourceProperties struct { - // The object specified in the Trend Micro flow source. + // The object specified in the Trend Micro flow source. // // This member is required. Object *string @@ -2842,27 +2947,30 @@ type TrendmicroSourceProperties struct { noSmithyDocumentSerde } -// The trigger settings that determine how and when Amazon AppFlow runs the +// The trigger settings that determine how and when Amazon AppFlow runs the +// // 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 - // Specifies the configuration details of a schedule-triggered flow as defined by + // Specifies the configuration details of a schedule-triggered flow as defined by // the user. Currently, these settings only apply to the Scheduled trigger type. TriggerProperties *TriggerProperties noSmithyDocumentSerde } -// Specifies the configuration details that control the trigger for a flow. +// Specifies the configuration details that control the trigger for a flow. +// // Currently, these settings only apply to the Scheduled trigger type. type TriggerProperties struct { - // Specifies the configuration details of a schedule-triggered flow as defined by + // Specifies the configuration details of a schedule-triggered flow as defined by // the user. Scheduled *ScheduledTriggerProperties @@ -2872,19 +2980,19 @@ type TriggerProperties struct { // The properties that are applied when Upsolver is used as a destination. type UpsolverDestinationProperties struct { - // The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the + // The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the // transferred data. // // This member is required. BucketName *string - // The configuration that determines how data is formatted when Upsolver is used + // The configuration that determines how data is formatted when Upsolver is used // as the flow destination. // // This member is required. S3OutputFormatConfig *UpsolverS3OutputFormatConfig - // The object key for the destination Upsolver Amazon S3 bucket in which Amazon + // The object key for the destination Upsolver Amazon S3 bucket in which Amazon // AppFlow places the files. BucketPrefix *string @@ -2896,7 +3004,8 @@ type UpsolverMetadata struct { noSmithyDocumentSerde } -// The configuration that determines how Amazon AppFlow formats the flow output +// The configuration that determines how Amazon AppFlow formats the flow output +// // data when Upsolver is used as the destination. type UpsolverS3OutputFormatConfig struct { @@ -2906,11 +3015,11 @@ type UpsolverS3OutputFormatConfig struct { // This member is required. PrefixConfig *PrefixConfig - // The aggregation settings that you can use to customize the output format of + // 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 + // Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 // bucket. FileType FileType @@ -2920,12 +3029,12 @@ type UpsolverS3OutputFormatConfig struct { // The connector-specific profile credentials required when using Veeva. type VeevaConnectorProfileCredentials struct { - // The password that corresponds to the user name. + // The password that corresponds to the user name. // // This member is required. Password *string - // The name of the user. + // The name of the user. // // This member is required. Username *string @@ -2936,7 +3045,7 @@ type VeevaConnectorProfileCredentials struct { // The connector-specific profile properties required when using Veeva. type VeevaConnectorProfileProperties struct { - // The location of the Veeva resource. + // The location of the Veeva resource. // // This member is required. InstanceUrl *string @@ -2952,7 +3061,7 @@ type VeevaMetadata struct { // The properties that are applied when using Veeva as a flow source. type VeevaSourceProperties struct { - // The object specified in the Veeva flow source. + // The object specified in the Veeva flow source. // // This member is required. Object *string @@ -2975,21 +3084,21 @@ type VeevaSourceProperties struct { // The connector-specific profile credentials required when using Zendesk. type ZendeskConnectorProfileCredentials struct { - // The identifier for the desired client. + // The identifier for the desired client. // // This member is required. ClientId *string - // The client secret used by the OAuth client to authenticate to the authorization - // server. + // The client secret used by the OAuth client to authenticate to the + // authorization server. // // This member is required. ClientSecret *string - // The credentials used to access protected Zendesk resources. + // The credentials used to access protected Zendesk resources. AccessToken *string - // The OAuth requirement needed to request security tokens from the connector + // The OAuth requirement needed to request security tokens from the connector // endpoint. OAuthRequest *ConnectorOAuthRequest @@ -2999,7 +3108,7 @@ type ZendeskConnectorProfileCredentials struct { // The connector-specific profile properties required when using Zendesk. type ZendeskConnectorProfileProperties struct { - // The location of the Zendesk resource. + // The location of the Zendesk resource. // // This member is required. InstanceUrl *string @@ -3015,18 +3124,18 @@ type ZendeskDestinationProperties struct { // This member is required. Object *string - // The settings that determine how Amazon AppFlow handles an error when placing + // The settings that determine how Amazon AppFlow handles an error when placing // data in the destination. For example, this setting would determine if the flow // should fail after one insertion error, or continue and attempt to insert every // record regardless of the initial failure. ErrorHandlingConfig is a part of the // destination connector details. ErrorHandlingConfig *ErrorHandlingConfig - // A list of field names that can be used as an ID field when performing a write + // A list of field names that can be used as an ID field when performing a write // operation. IdFieldNames []string - // The possible write operations in the destination connector. When this value is + // The possible write operations in the destination connector. When this value is // not provided, this defaults to the INSERT operation. WriteOperationType WriteOperationType @@ -3036,7 +3145,7 @@ type ZendeskDestinationProperties struct { // The connector metadata specific to Zendesk. type ZendeskMetadata struct { - // The desired authorization scope for the Zendesk account. + // The desired authorization scope for the Zendesk account. OAuthScopes []string noSmithyDocumentSerde @@ -3045,7 +3154,7 @@ type ZendeskMetadata struct { // The properties that are applied when using Zendesk as a flow source. type ZendeskSourceProperties struct { - // The object specified in the Zendesk flow source. + // The object specified in the Zendesk flow source. // // This member is required. Object *string diff --git a/service/appintegrations/api_op_CreateApplication.go b/service/appintegrations/api_op_CreateApplication.go index db22ae1c980..d12c50ce02c 100644 --- a/service/appintegrations/api_op_CreateApplication.go +++ b/service/appintegrations/api_op_CreateApplication.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is in preview release and subject to change. Creates and persists an -// Application resource. +// This API is in preview release and subject to change. +// +// Creates and persists an Application resource. func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -47,9 +48,9 @@ type CreateApplicationInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the application. diff --git a/service/appintegrations/api_op_CreateDataIntegration.go b/service/appintegrations/api_op_CreateDataIntegration.go index 5aa8c8e0611..392491e935b 100644 --- a/service/appintegrations/api_op_CreateDataIntegration.go +++ b/service/appintegrations/api_op_CreateDataIntegration.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates and persists a DataIntegration resource. 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 API. +// Creates and persists a DataIntegration resource. +// +// 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 API. func (c *Client) CreateDataIntegration(ctx context.Context, params *CreateDataIntegrationInput, optFns ...func(*Options)) (*CreateDataIntegrationOutput, error) { if params == nil { params = &CreateDataIntegrationInput{} @@ -49,9 +50,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A description of the DataIntegration. @@ -80,9 +81,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A description of the DataIntegration. diff --git a/service/appintegrations/api_op_CreateEventIntegration.go b/service/appintegrations/api_op_CreateEventIntegration.go index fb36ae0983f..9cb58fe6468 100644 --- a/service/appintegrations/api_op_CreateEventIntegration.go +++ b/service/appintegrations/api_op_CreateEventIntegration.go @@ -49,9 +49,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the event integration. diff --git a/service/appintegrations/api_op_DeleteDataIntegration.go b/service/appintegrations/api_op_DeleteDataIntegration.go index 75c4c459e28..05599b6c224 100644 --- a/service/appintegrations/api_op_DeleteDataIntegration.go +++ b/service/appintegrations/api_op_DeleteDataIntegration.go @@ -12,11 +12,13 @@ import ( // Deletes the DataIntegration. Only DataIntegrations that don't have any // DataIntegrationAssociations can be deleted. Deleting a DataIntegration also -// 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) -// API. +// 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]API. +// +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) DeleteDataIntegration(ctx context.Context, params *DeleteDataIntegrationInput, optFns ...func(*Options)) (*DeleteDataIntegrationOutput, error) { if params == nil { params = &DeleteDataIntegrationInput{} diff --git a/service/appintegrations/api_op_GetApplication.go b/service/appintegrations/api_op_GetApplication.go index 53275491505..7a974a49433 100644 --- a/service/appintegrations/api_op_GetApplication.go +++ b/service/appintegrations/api_op_GetApplication.go @@ -12,8 +12,9 @@ import ( "time" ) -// This API is in preview release and subject to change. Get an Application -// resource. +// This API is in preview release and subject to change. +// +// Get an Application resource. func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput, optFns ...func(*Options)) (*GetApplicationOutput, error) { if params == nil { params = &GetApplicationInput{} diff --git a/service/appintegrations/api_op_GetDataIntegration.go b/service/appintegrations/api_op_GetDataIntegration.go index 9a189b868ab..13c218210ff 100644 --- a/service/appintegrations/api_op_GetDataIntegration.go +++ b/service/appintegrations/api_op_GetDataIntegration.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API. +// 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]API. +// +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) GetDataIntegration(ctx context.Context, params *GetDataIntegrationInput, optFns ...func(*Options)) (*GetDataIntegrationOutput, error) { if params == nil { params = &GetDataIntegrationInput{} diff --git a/service/appintegrations/api_op_ListApplications.go b/service/appintegrations/api_op_ListApplications.go index f83307474b5..505062ce18b 100644 --- a/service/appintegrations/api_op_ListApplications.go +++ b/service/appintegrations/api_op_ListApplications.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is in preview release and subject to change. Lists applications in the -// account. +// This API is in preview release and subject to change. +// +// Lists applications in the account. func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error) { if params == nil { params = &ListApplicationsInput{} diff --git a/service/appintegrations/api_op_ListDataIntegrationAssociations.go b/service/appintegrations/api_op_ListDataIntegrationAssociations.go index 98b0b6eb04c..c718657bd84 100644 --- a/service/appintegrations/api_op_ListDataIntegrationAssociations.go +++ b/service/appintegrations/api_op_ListDataIntegrationAssociations.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API. +// 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]API. +// +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) ListDataIntegrationAssociations(ctx context.Context, params *ListDataIntegrationAssociationsInput, optFns ...func(*Options)) (*ListDataIntegrationAssociationsOutput, error) { if params == nil { params = &ListDataIntegrationAssociationsInput{} diff --git a/service/appintegrations/api_op_ListDataIntegrations.go b/service/appintegrations/api_op_ListDataIntegrations.go index fe574531af0..e08481feb1a 100644 --- a/service/appintegrations/api_op_ListDataIntegrations.go +++ b/service/appintegrations/api_op_ListDataIntegrations.go @@ -11,11 +11,13 @@ 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 -// associated. Use a different DataIntegration, or recreate the DataIntegration -// using the CreateDataIntegration (https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) -// API. +// 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]API. +// +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) ListDataIntegrations(ctx context.Context, params *ListDataIntegrationsInput, optFns ...func(*Options)) (*ListDataIntegrationsOutput, error) { if params == nil { params = &ListDataIntegrationsInput{} diff --git a/service/appintegrations/api_op_UpdateApplication.go b/service/appintegrations/api_op_UpdateApplication.go index 08d5446e359..84222a39d65 100644 --- a/service/appintegrations/api_op_UpdateApplication.go +++ b/service/appintegrations/api_op_UpdateApplication.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is in preview release and subject to change. Updates and persists an -// Application resource. +// This API is in preview release and subject to change. +// +// Updates and persists an Application resource. func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error) { if params == nil { params = &UpdateApplicationInput{} diff --git a/service/appintegrations/api_op_UpdateDataIntegration.go b/service/appintegrations/api_op_UpdateDataIntegration.go index 18bfc888718..6538f67586c 100644 --- a/service/appintegrations/api_op_UpdateDataIntegration.go +++ b/service/appintegrations/api_op_UpdateDataIntegration.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API. +// 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]API. +// +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) UpdateDataIntegration(ctx context.Context, params *UpdateDataIntegrationInput, optFns ...func(*Options)) (*UpdateDataIntegrationOutput, error) { if params == nil { params = &UpdateDataIntegrationInput{} diff --git a/service/appintegrations/doc.go b/service/appintegrations/doc.go index eca3f2a18a2..63b4b3a671b 100644 --- a/service/appintegrations/doc.go +++ b/service/appintegrations/doc.go @@ -4,8 +4,11 @@ // 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) -// in the Amazon Connect Administrator Guide. +// connections to external applications. +// +// For information about how you can use external applications with Amazon +// Connect, see [Set up pre-built integrations]and [Deliver information to agents using Amazon Connect Wisdom] in the Amazon Connect Administrator Guide. +// +// [Set up pre-built integrations]: https://docs.aws.amazon.com/connect/latest/adminguide/crm.html +// [Deliver information to agents using Amazon Connect Wisdom]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-wisdom.html package appintegrations diff --git a/service/appintegrations/options.go b/service/appintegrations/options.go index 1987a53d2ee..0652610ea1a 100644 --- a/service/appintegrations/options.go +++ b/service/appintegrations/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/applicationautoscaling/api_op_DeleteScalingPolicy.go b/service/applicationautoscaling/api_op_DeleteScalingPolicy.go index 97bf966d6c8..31005ddd666 100644 --- a/service/applicationautoscaling/api_op_DeleteScalingPolicy.go +++ b/service/applicationautoscaling/api_op_DeleteScalingPolicy.go @@ -12,12 +12,16 @@ import ( ) // Deletes the specified scaling policy for an Application Auto Scaling scalable -// 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/create-step-scaling-policy-cli.html#delete-step-scaling-policy) -// and Delete a target tracking scaling policy (https://docs.aws.amazon.com/autoscaling/application/userguide/create-target-tracking-policy-cli.html#delete-target-tracking-policy) -// in the Application Auto Scaling User Guide. +// 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] and [Delete a target tracking scaling policy] in the Application Auto Scaling User Guide. +// +// [Delete a target tracking scaling policy]: https://docs.aws.amazon.com/autoscaling/application/userguide/create-target-tracking-policy-cli.html#delete-target-tracking-policy +// [Delete a step scaling policy]: https://docs.aws.amazon.com/autoscaling/application/userguide/create-step-scaling-policy-cli.html#delete-step-scaling-policy func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingPolicyInput, optFns ...func(*Options)) (*DeleteScalingPolicyOutput, error) { if params == nil { params = &DeleteScalingPolicyInput{} @@ -42,105 +46,146 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // diff --git a/service/applicationautoscaling/api_op_DeleteScheduledAction.go b/service/applicationautoscaling/api_op_DeleteScheduledAction.go index a87882ceba8..1d8fe5899b9 100644 --- a/service/applicationautoscaling/api_op_DeleteScheduledAction.go +++ b/service/applicationautoscaling/api_op_DeleteScheduledAction.go @@ -12,8 +12,11 @@ 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) -// in the Application Auto Scaling User Guide. +// target. +// +// For more information, see [Delete a scheduled action] in the Application Auto Scaling User Guide. +// +// [Delete a scheduled action]: https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html#delete-scheduled-action func (c *Client) DeleteScheduledAction(ctx context.Context, params *DeleteScheduledActionInput, optFns ...func(*Options)) (*DeleteScheduledActionOutput, error) { if params == nil { params = &DeleteScheduledActionInput{} @@ -33,105 +36,146 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // diff --git a/service/applicationautoscaling/api_op_DeregisterScalableTarget.go b/service/applicationautoscaling/api_op_DeregisterScalableTarget.go index d5495493e81..2aefbf49a63 100644 --- a/service/applicationautoscaling/api_op_DeregisterScalableTarget.go +++ b/service/applicationautoscaling/api_op_DeregisterScalableTarget.go @@ -12,10 +12,12 @@ 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 +// using it. To see which resources have been registered, use [DescribeScalableTargets]. +// +// Deregistering a scalable target deletes the scaling policies and the scheduled // actions that are associated with it. +// +// [DescribeScalableTargets]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html func (c *Client) DeregisterScalableTarget(ctx context.Context, params *DeregisterScalableTargetInput, optFns ...func(*Options)) (*DeregisterScalableTargetOutput, error) { if params == nil { params = &DeregisterScalableTargetInput{} @@ -35,105 +37,146 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // diff --git a/service/applicationautoscaling/api_op_DescribeScalableTargets.go b/service/applicationautoscaling/api_op_DescribeScalableTargets.go index b8b84cdd20b..efaa528a2d8 100644 --- a/service/applicationautoscaling/api_op_DescribeScalableTargets.go +++ b/service/applicationautoscaling/api_op_DescribeScalableTargets.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the scalable targets in the specified namespace. You can -// filter the results using ResourceIds and ScalableDimension . +// Gets information about the scalable targets in the specified namespace. +// +// You can 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{} @@ -38,11 +39,12 @@ type DescribeScalableTargetsInput struct { ServiceNamespace types.ServiceNamespace // The maximum number of scalable targets. This value can be between 1 and 50. The - // default value is 50. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 50 results and a NextToken value, if - // applicable. + // default value is 50. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 50 results and a NextToken value, if applicable. MaxResults *int32 // The token for the next set of results. @@ -50,104 +52,145 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . + // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. ScalableDimension types.ScalableDimension @@ -261,11 +304,12 @@ var _ DescribeScalableTargetsAPIClient = (*Client)(nil) // DescribeScalableTargets type DescribeScalableTargetsPaginatorOptions struct { // The maximum number of scalable targets. This value can be between 1 and 50. The - // default value is 50. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 50 results and a NextToken value, if - // applicable. + // default value is 50. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 50 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/applicationautoscaling/api_op_DescribeScalingActivities.go b/service/applicationautoscaling/api_op_DescribeScalingActivities.go index f4df217ac02..4463d0f79e1 100644 --- a/service/applicationautoscaling/api_op_DescribeScalingActivities.go +++ b/service/applicationautoscaling/api_op_DescribeScalingActivities.go @@ -12,11 +12,14 @@ 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 -// 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) -// . +// namespace from the previous six weeks. +// +// You can filter the results using ResourceId and ScalableDimension . +// +// For information about viewing scaling activities using the Amazon Web Services +// CLI, see [Scaling activities for Application Auto Scaling]. +// +// [Scaling activities for 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{} @@ -44,17 +47,19 @@ type DescribeScalingActivitiesInput struct { // Specifies whether to include activities that aren't scaled (not scaled // 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) + // loops. For help interpreting the not scaled reason details in the response, see [Scaling activities for Application Auto Scaling] // . + // + // [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 - // default value is 50. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 50 results and a NextToken value, if - // applicable. + // default value is 50. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 50 results and a NextToken value, if applicable. MaxResults *int32 // The token for the next set of results. @@ -62,104 +67,145 @@ type DescribeScalingActivitiesInput struct { // 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . + // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. ScalableDimension types.ScalableDimension @@ -273,11 +319,12 @@ var _ DescribeScalingActivitiesAPIClient = (*Client)(nil) // DescribeScalingActivities type DescribeScalingActivitiesPaginatorOptions struct { // The maximum number of scalable targets. This value can be between 1 and 50. The - // default value is 50. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 50 results and a NextToken value, if - // applicable. + // default value is 50. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 50 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/applicationautoscaling/api_op_DescribeScalingPolicies.go b/service/applicationautoscaling/api_op_DescribeScalingPolicies.go index 49884ffdd8e..c92e672a3d8 100644 --- a/service/applicationautoscaling/api_op_DescribeScalingPolicies.go +++ b/service/applicationautoscaling/api_op_DescribeScalingPolicies.go @@ -12,11 +12,15 @@ 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) -// in the Application Auto Scaling User Guide. +// service namespace. +// +// You can filter the results using ResourceId , ScalableDimension , and +// PolicyNames . +// +// For more information, see [Target tracking scaling policies] and [Step scaling policies] in the Application Auto Scaling User Guide. +// +// [Step scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html +// [Target tracking scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html func (c *Client) DescribeScalingPolicies(ctx context.Context, params *DescribeScalingPoliciesInput, optFns ...func(*Options)) (*DescribeScalingPoliciesOutput, error) { if params == nil { params = &DescribeScalingPoliciesInput{} @@ -42,11 +46,12 @@ type DescribeScalingPoliciesInput struct { ServiceNamespace types.ServiceNamespace // The maximum number of scalable targets. This value can be between 1 and 10. The - // default value is 10. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 10 results and a NextToken value, if - // applicable. + // default value is 10. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 10 results and a NextToken value, if applicable. MaxResults *int32 // The token for the next set of results. @@ -57,104 +62,145 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . + // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. ScalableDimension types.ScalableDimension @@ -268,11 +314,12 @@ var _ DescribeScalingPoliciesAPIClient = (*Client)(nil) // DescribeScalingPolicies type DescribeScalingPoliciesPaginatorOptions struct { // The maximum number of scalable targets. This value can be between 1 and 10. The - // default value is 10. If this parameter is used, the operation returns up to - // MaxResults results at a time, along with a NextToken value. To get the next set - // of results, include the NextToken value in a subsequent call. If this parameter - // is not used, the operation returns up to 10 results and a NextToken value, if - // applicable. + // default value is 10. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation 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/applicationautoscaling/api_op_DescribeScheduledActions.go b/service/applicationautoscaling/api_op_DescribeScheduledActions.go index 668aa2035df..642c382ffeb 100644 --- a/service/applicationautoscaling/api_op_DescribeScheduledActions.go +++ b/service/applicationautoscaling/api_op_DescribeScheduledActions.go @@ -12,11 +12,15 @@ 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) -// in the Application Auto Scaling User Guide. +// service namespace. +// +// You can filter the results using the ResourceId , ScalableDimension , and +// ScheduledActionNames parameters. +// +// For more information, see [Scheduled scaling] and [Managing scheduled scaling] in the Application Auto Scaling User Guide. +// +// [Managing scheduled scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html +// [Scheduled scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeScheduledActionsInput, optFns ...func(*Options)) (*DescribeScheduledActionsOutput, error) { if params == nil { params = &DescribeScheduledActionsInput{} @@ -42,11 +46,12 @@ type DescribeScheduledActionsInput struct { ServiceNamespace types.ServiceNamespace // The maximum number of scheduled action results. This value can be between 1 and - // 50. The default value is 50. If this parameter is used, the operation returns up - // to MaxResults results at a time, along with a NextToken value. To get the next - // set of results, include the NextToken value in a subsequent call. If this - // parameter is not used, the operation returns up to 50 results and a NextToken - // value, if applicable. + // 50. The default value is 50. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 50 results and a NextToken value, if applicable. MaxResults *int32 // The token for the next set of results. @@ -54,104 +59,145 @@ type DescribeScheduledActionsInput 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . + // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. ScalableDimension types.ScalableDimension @@ -268,11 +314,12 @@ var _ DescribeScheduledActionsAPIClient = (*Client)(nil) // DescribeScheduledActions type DescribeScheduledActionsPaginatorOptions struct { // The maximum number of scheduled action results. This value can be between 1 and - // 50. The default value is 50. If this parameter is used, the operation returns up - // to MaxResults results at a time, along with a NextToken value. To get the next - // set of results, include the NextToken value in a subsequent call. If this - // parameter is not used, the operation returns up to 50 results and a NextToken - // value, if applicable. + // 50. The default value is 50. + // + // If this parameter is used, the operation returns up to MaxResults results at a + // time, along with a NextToken value. To get the next set of results, include the + // NextToken value in a subsequent call. If this parameter is not used, the + // operation returns up to 50 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/applicationautoscaling/api_op_ListTagsForResource.go b/service/applicationautoscaling/api_op_ListTagsForResource.go index d45b214aac4..f84beb39531 100644 --- a/service/applicationautoscaling/api_op_ListTagsForResource.go +++ b/service/applicationautoscaling/api_op_ListTagsForResource.go @@ -11,9 +11,11 @@ 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] in +// the Amazon Web Services General Reference. +// +// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -31,9 +33,12 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // Specify the ARN of the scalable target. For example: + // 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 5a27cc3e206..a239eaecaf4 100644 --- a/service/applicationautoscaling/api_op_PutScalingPolicy.go +++ b/service/applicationautoscaling/api_op_PutScalingPolicy.go @@ -12,31 +12,40 @@ import ( ) // Creates or updates a scaling policy for an Application Auto Scaling scalable -// target. Each scalable target is identified by a service namespace, resource ID, -// and scalable dimension. A scaling policy applies to the scalable target -// identified by those three attributes. You cannot create a scaling policy until -// you have registered the resource as a scalable target. Multiple scaling policies -// can be in force at the same time for the same scalable target. You can have one -// or more target tracking scaling policies, one or more step scaling policies, or -// both. However, there is a chance that multiple policies could conflict, -// instructing the scalable target to scale out or in at the same time. Application -// Auto Scaling gives precedence to the policy that provides the largest capacity -// for both scale out and scale in. For example, if one policy increases capacity -// by 3, another policy increases capacity by 200 percent, and the current capacity -// is 10, Application Auto Scaling uses the policy with the highest calculated -// capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, -// when using target tracking scaling policies with step scaling policies because -// conflicts between these policies can cause undesirable behavior. For example, if -// the step scaling policy initiates a scale-in activity before the target tracking -// 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) -// 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 -// deleted. +// target. +// +// Each scalable target is identified by a service namespace, resource ID, and +// scalable dimension. A scaling policy applies to the scalable target identified +// by those three attributes. You cannot create a scaling policy until you have +// registered the resource as a scalable target. +// +// Multiple scaling policies can be in force at the same time for the same +// scalable target. You can have one or more target tracking scaling policies, one +// or more step scaling policies, or both. However, there is a chance that multiple +// policies could conflict, instructing the scalable target to scale out or in at +// the same time. Application Auto Scaling gives precedence to the policy that +// provides the largest capacity for both scale out and scale in. For example, if +// one policy increases capacity by 3, another policy increases capacity by 200 +// percent, and the current capacity is 10, Application Auto Scaling uses the +// policy with the highest calculated capacity (200% of 10 = 20) and scales out to +// 30. +// +// We recommend caution, however, when using target tracking scaling policies with +// step scaling policies because conflicts between these policies can cause +// undesirable behavior. For example, if the step scaling policy initiates a +// scale-in activity before the target tracking 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] and [Step scaling policies] 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 deleted. +// +// [Step scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html +// [Target tracking scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyInput, optFns ...func(*Options)) (*PutScalingPolicyOutput, error) { if params == nil { params = &PutScalingPolicyInput{} @@ -54,114 +63,157 @@ func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyI type PutScalingPolicyInput struct { - // The name of the scaling policy. You cannot change the name of a scaling policy, - // but you can delete the original scaling policy and create a new scaling policy - // with the same settings and a different name. + // The name of the scaling policy. + // + // You cannot change the name of a scaling policy, but you can delete the original + // scaling policy and create a new scaling policy with the same settings and a + // different name. // // This member is required. PolicyName *string // 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // @@ -176,21 +228,32 @@ type PutScalingPolicyInput struct { 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) - // in the Application Auto Scaling User Guide. + // 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] and [Step scaling policies] in the Application Auto Scaling User Guide. + // + // [Step scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html + // [Target tracking scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html PolicyType types.PolicyType - // A step scaling policy. This parameter is required if you are creating a policy - // and the policy type is StepScaling . + // A step scaling policy. + // + // This parameter is required if you are creating a policy 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 . + // metrics. + // + // This parameter is required if you are creating a policy and the policy type is + // TargetTrackingScaling . TargetTrackingScalingPolicyConfiguration *types.TargetTrackingScalingPolicyConfiguration noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_PutScheduledAction.go b/service/applicationautoscaling/api_op_PutScheduledAction.go index fde042e4b62..9c3be54e1a1 100644 --- a/service/applicationautoscaling/api_op_PutScheduledAction.go +++ b/service/applicationautoscaling/api_op_PutScheduledAction.go @@ -13,19 +13,27 @@ import ( ) // Creates or updates a scheduled action for an Application Auto Scaling scalable -// target. Each scalable target is identified by a service namespace, resource ID, -// and scalable dimension. A scheduled action applies to the scalable target -// identified by those three attributes. You cannot create a scheduled action until -// you have registered the resource as a scalable target. When you specify start -// and end times with a recurring schedule using a cron expression or rates, they -// 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) -// 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 -// deleted. +// target. +// +// Each scalable target is identified by a service namespace, resource ID, and +// scalable dimension. A scheduled action applies to the scalable target identified +// by those three attributes. You cannot create a scheduled action until you have +// registered the resource as a scalable target. +// +// When you specify start and end times with a recurring schedule using a cron +// expression or rates, they 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] 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 deleted. +// +// [Scheduled scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html func (c *Client) PutScheduledAction(ctx context.Context, params *PutScheduledActionInput, optFns ...func(*Options)) (*PutScheduledActionOutput, error) { if params == nil { params = &PutScheduledActionInput{} @@ -45,105 +53,146 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // @@ -174,30 +223,42 @@ 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) - // in the Application Auto Scaling User Guide. + // 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] in the Application Auto Scaling User + // Guide. + // + // [Example scheduled actions for Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html Schedule *string // The date and time for this scheduled action to start, in UTC. StartTime *time.Time // 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) - // . + // 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]: 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 ffe2958dfed..0f2f92e43b9 100644 --- a/service/applicationautoscaling/api_op_RegisterScalableTarget.go +++ b/service/applicationautoscaling/api_op_RegisterScalableTarget.go @@ -12,38 +12,50 @@ import ( ) // Registers or updates a scalable target, which is the resource that you want to -// scale. Scalable targets are uniquely identified by the combination of resource -// ID, scalable dimension, and namespace, which represents some capacity dimension -// of the underlying service. When you register a new scalable target, you must -// specify values for the minimum and maximum capacity. If the specified resource -// is not active in the target service, this operation does not change the -// resource's current capacity. Otherwise, it changes the resource's current -// capacity to a value that is inside of this range. If you add a scaling policy, -// current capacity is adjustable within the specified range when scaling starts. -// Application Auto Scaling scaling policies will not scale capacity to values that -// 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. +// scale. +// +// Scalable targets are uniquely identified by the combination of resource ID, +// scalable dimension, and namespace, which represents some capacity dimension of +// the underlying service. +// +// When you register a new scalable target, you must specify values for the +// minimum and maximum capacity. If the specified resource is not active in the +// target service, this operation does not change the resource's current capacity. +// Otherwise, it changes the resource's current capacity to a value that is inside +// of this range. +// +// If you add a scaling policy, current capacity is adjustable within the +// specified range when scaling starts. Application Auto Scaling scaling policies +// will not scale capacity to values that 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]. You can also view the scaling policies for a service +// namespace by using [DescribeScalableTargets]. If you no longer need a scalable target, you can +// deregister it by using [DeregisterScalableTarget]. +// +// 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 +// 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]. 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. +// +// [DescribeScalableTargets]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html +// [eventual consistency]: https://en.wikipedia.org/wiki/Eventual_consistency +// [DeregisterScalableTarget]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DeregisterScalableTarget.html func (c *Client) RegisterScalableTarget(ctx context.Context, params *RegisterScalableTargetInput, optFns ...func(*Options)) (*RegisterScalableTargetOutput, error) { if params == nil { params = &RegisterScalableTargetInput{} @@ -63,105 +75,146 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // @@ -178,32 +231,47 @@ type RegisterScalableTargetInput struct { // The maximum value that you plan to scale out to. When a scaling policy is in // effect, Application Auto Scaling can scale out (expand) as needed to the maximum // capacity limit in response to changing demand. This property is required when - // registering a new scalable target. Although you can specify a large maximum - // capacity, note that service quotas might impose lower limits. Each service has - // 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. + // registering a new scalable target. + // + // Although you can specify a large maximum capacity, note that service quotas + // might impose lower limits. Each service has 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]in the + // Amazon Web Services General Reference. + // + // [Service endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html MaxCapacity *int32 // The minimum value that you plan to scale in to. When a scaling policy is in // effect, Application Auto Scaling can scale in (contract) as needed to the // 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. + // 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 + // // - SageMaker Serverless endpoint provisioned concurrency + // // - 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 @@ -212,34 +280,48 @@ type RegisterScalableTargetInput struct { // 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 + // 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]. + // + // [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 + // 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) - // in the Application Auto Scaling User Guide. + // + // For more information, see [Suspending and resuming scaling] in the Application Auto Scaling User Guide. + // + // [Suspending and resuming scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html SuspendedState *types.SuspendedState // Assigns one or more tags to the scalable target. Use this parameter to tag the - // scalable target when it is created. To tag an existing scalable target, use the - // 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) - // in the Application Auto Scaling User Guide. + // scalable target when it is created. To tag an existing scalable target, use the 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] in + // the Application Auto Scaling User Guide. + // + // [Tagging support for Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/applicationautoscaling/api_op_TagResource.go b/service/applicationautoscaling/api_op_TagResource.go index 0f8a0280ec7..1e7f517689b 100644 --- a/service/applicationautoscaling/api_op_TagResource.go +++ b/service/applicationautoscaling/api_op_TagResource.go @@ -10,19 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or edits tags on an Application Auto Scaling scalable target. Each tag -// consists of a tag key and a tag value, which are both case-sensitive strings. 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 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) -// in the Application Auto Scaling User Guide. +// Adds or edits tags on an Application Auto Scaling scalable target. +// +// Each tag consists of a tag key and a tag value, which are both case-sensitive +// strings. 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 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] 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] in +// the Application Auto Scaling User Guide. +// +// [Tagging support for Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html +// [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{} @@ -41,21 +48,30 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // Identifies the Application Auto Scaling scalable target that you want to apply - // tags to. For example: + // 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 // 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 tag key and a tag value. - // You cannot have more than one tag on an Application Auto Scaling scalable target - // with the same tag 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // Amazon Web Services resource. + // + // Each tag consists of a tag key and a tag value. + // + // You cannot have more than one tag on an Application Auto Scaling scalable + // target with the same tag 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] in + // the Amazon Web Services Billing and Cost Management User Guide. + // + // [User-defined tag restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html // // This member is required. Tags map[string]string diff --git a/service/applicationautoscaling/api_op_UntagResource.go b/service/applicationautoscaling/api_op_UntagResource.go index 8dd2ef8abb9..7199651d659 100644 --- a/service/applicationautoscaling/api_op_UntagResource.go +++ b/service/applicationautoscaling/api_op_UntagResource.go @@ -30,9 +30,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // Identifies the Application Auto Scaling scalable target from which to remove - // tags. For example: + // 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 e99b5a756eb..b99148785e8 100644 --- a/service/applicationautoscaling/doc.go +++ b/service/applicationautoscaling/doc.go @@ -5,39 +5,61 @@ // // 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 +// // - Amazon SageMaker Serverless endpoint provisioned concurrency +// // - Amazon SageMaker inference components +// // - 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: +// To learn more about Application Auto Scaling, see the [Application Auto Scaling User Guide]. +// +// # 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. +// scaling by calling the [RegisterScalableTarget]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. +// +// [Application Auto Scaling User Guide]: https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html +// [RegisterScalableTarget]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html package applicationautoscaling diff --git a/service/applicationautoscaling/options.go b/service/applicationautoscaling/options.go index f60a2d67a83..0ee2e999411 100644 --- a/service/applicationautoscaling/options.go +++ b/service/applicationautoscaling/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/applicationautoscaling/types/enums.go b/service/applicationautoscaling/types/enums.go index 2cef4363d31..3809dfa4d7d 100644 --- a/service/applicationautoscaling/types/enums.go +++ b/service/applicationautoscaling/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AdjustmentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdjustmentType) Values() []AdjustmentType { return []AdjustmentType{ "ChangeInCapacity", @@ -32,8 +33,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Average", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for MetricStatistic. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricStatistic) Values() []MetricStatistic { return []MetricStatistic{ "Average", @@ -97,8 +100,9 @@ const ( ) // Values returns all known values for MetricType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricType) Values() []MetricType { return []MetricType{ "DynamoDBReadCapacityUtilization", @@ -137,8 +141,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "StepScaling", @@ -175,8 +180,9 @@ const ( ) // Values returns all known values for ScalableDimension. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalableDimension) Values() []ScalableDimension { return []ScalableDimension{ "ecs:service:DesiredCount", @@ -218,6 +224,7 @@ const ( // Values returns all known values for ScalingActivityStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScalingActivityStatusCode) Values() []ScalingActivityStatusCode { return []ScalingActivityStatusCode{ @@ -251,8 +258,9 @@ const ( ) // Values returns all known values for ServiceNamespace. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNamespace) Values() []ServiceNamespace { return []ServiceNamespace{ "ecs", diff --git a/service/applicationautoscaling/types/errors.go b/service/applicationautoscaling/types/errors.go index 4e2f251afaa..6c0d542e449 100644 --- a/service/applicationautoscaling/types/errors.go +++ b/service/applicationautoscaling/types/errors.go @@ -37,8 +37,10 @@ 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) -// on your behalf. +// a scalable target does not have permission to call the CloudWatch [DescribeAlarms]on your +// behalf. +// +// [DescribeAlarms]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html type FailedResourceAccessException struct { Message *string @@ -116,9 +118,9 @@ 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) -// . +// A per-account resource limit is exceeded. For more information, see [Application Auto Scaling service quotas]. +// +// [Application 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 3d0add1b453..6dc4c96e83d 100644 --- a/service/applicationautoscaling/types/types.go +++ b/service/applicationautoscaling/types/types.go @@ -24,34 +24,42 @@ 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) -// in the Amazon CloudWatch User Guide. To create your customized metric -// specification: +// 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] 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. +// must first publish the metric to CloudWatch. For more information, see [Publish custom metrics]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) -// in the Amazon CloudWatch User Guide. +// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts] in the Amazon +// CloudWatch User Guide. +// +// [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html +// [Amazon CloudWatch concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html +// [Publish custom metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html type CustomizedMetricSpecification struct { - // The dimensions of the metric. Conditional: If you published your metric with - // dimensions, you must specify the same dimensions in your scaling policy. + // The dimensions of the metric. + // + // Conditional: If you published your metric with 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) - // . + // dimensions, inspect the [Metric]object that's returned by a call to [ListMetrics]. + // + // [ListMetrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html + // [Metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html MetricName *string // The metrics to include in the target tracking scaling policy, as a metric data @@ -65,8 +73,9 @@ 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) - // data type in the Amazon CloudWatch API Reference. + // supports, see the [MetricDatum]data type in the Amazon CloudWatch API Reference. + // + // [MetricDatum]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html Unit *string noSmithyDocumentSerde @@ -90,15 +99,23 @@ type MetricDimension struct { // 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) -// . +// see [Scaling activities for Application Auto Scaling]. +// +// [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: + // A code that represents the reason for not scaling. + // + // Valid values: + // // - AutoScalingAnticipatedFlapping + // // - TargetServicePutResourceAsUnscalable + // // - AlreadyAtMaxCapacity + // // - AlreadyAtMinCapacity + // // - AlreadyAtDesiredCapacity // // This member is required. @@ -117,12 +134,14 @@ type NotScaledReason struct { } // Represents a predefined metric for a target tracking scaling policy to use with -// Application Auto Scaling. Only the Amazon Web Services that you're using send -// 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 Monitor your resources using -// CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html) -// in the Application Auto Scaling User Guide. +// Application Auto Scaling. +// +// Only the Amazon Web Services that you're using send 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 [Monitor your resources using CloudWatch]in the Application Auto Scaling User Guide. +// +// [Monitor your resources using CloudWatch]: https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html type PredefinedMetricSpecification struct { // The metric type. The ALBRequestCountPerTarget metric type applies only to Spot @@ -133,18 +152,25 @@ type PredefinedMetricSpecification struct { // 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: + // 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ResourceLabel *string noSmithyDocumentSerde @@ -170,59 +196,78 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // This member is required. ResourceId *string @@ -234,47 +279,69 @@ type ScalableTarget struct { // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // @@ -300,18 +367,23 @@ type ScalableTarget struct { // Represents the minimum and maximum capacity for a scheduled action. type ScalableTargetAction struct { - // The maximum capacity. Although you can specify a large maximum capacity, note - // that service quotas may impose lower limits. Each service has 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. + // The maximum capacity. + // + // Although you can specify a large maximum capacity, note that service quotas may + // impose lower limits. Each service has 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]in the Amazon + // Web Services General Reference. + // + // [Service endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html MaxCapacity *int32 - // The minimum capacity. When the scheduled action runs, the resource will have at - // least this much capacity, but it might have more depending on other settings, - // such as the target utilization level of a target tracking scaling policy. + // The minimum capacity. + // + // When the scheduled action runs, the resource will have at least this much + // capacity, but it might have more depending on other settings, such as the target + // utilization level of a target tracking scaling policy. MinCapacity *int32 noSmithyDocumentSerde @@ -337,105 +409,146 @@ type ScalingActivity struct { // 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // @@ -465,8 +578,9 @@ 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) - // includes not scaled activities. + // available when [DescribeScalingActivities]includes not scaled activities. + // + // [DescribeScalingActivities]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalingActivities.html NotScaledReasons []NotScaledReason // A simple message about the current status of the scaling activity. @@ -475,10 +589,12 @@ type ScalingActivity struct { noSmithyDocumentSerde } -// 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) -// in the Application Auto Scaling User Guide. +// 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]in the Application Auto Scaling User Guide. +// +// [Amazon Web Services services that you can use with Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html type ScalingPolicy struct { // The Unix timestamp for when the scaling policy was created. @@ -496,115 +612,160 @@ type ScalingPolicy struct { // This member is required. 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 - // ElastiCache, or Neptune. + // 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 ElastiCache, or Neptune. // // This member is required. PolicyType PolicyType // 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. // @@ -639,76 +800,106 @@ 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) - // . + // More information is available in our [GitHub repository]. + // // - 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 . + // // - SageMaker Serverless endpoint - The resource type is variant and the unique // identifier is the resource ID. Example: // endpoint/my-end-point/variant/KMeansClustering . + // // - SageMaker inference component - The resource type is inference-component and // the unique identifier is the resource ID. Example: // inference-component/my-inference-component . // + // [GitHub repository]: https://github.com/aws/aws-auto-scaling-custom-resource + // // 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) - // in the Application Auto Scaling User Guide. + // 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] in the Application Auto Scaling User + // Guide. + // + // [Example scheduled actions for Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html // // This member is required. Schedule *string @@ -734,47 +925,69 @@ 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. + // // - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned // concurrency for a SageMaker Serverless endpoint. + // // - sagemaker:inference-component:DesiredCopyCount - The number of copies across // an endpoint for a SageMaker inference component. ScalableDimension ScalableDimension @@ -796,25 +1009,34 @@ 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 -// 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: +// Represents a step adjustment for a [StepScalingPolicyConfiguration]. 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 . // // 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. +// +// [StepScalingPolicyConfiguration]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html type StepAdjustment struct { // The amount by which to scale, based on the specified adjustment type. A @@ -836,29 +1058,37 @@ type StepAdjustment struct { // CloudWatch metric. If the metric value is above the breach threshold, the upper // bound is exclusive (the metric must be less than the threshold plus the upper // bound). Otherwise, it's inclusive (the metric must be less than or equal to the - // threshold plus the upper bound). A null value indicates positive infinity. The - // upper bound must be greater than the lower bound. + // threshold plus the upper bound). A null value indicates positive infinity. + // + // The upper bound must be greater than the lower bound. MetricIntervalUpperBound *float64 noSmithyDocumentSerde } // Represents a step scaling policy configuration to use with Application Auto -// Scaling. For more information, see 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. +// Scaling. +// +// For more information, see [Step scaling policies] in the Application Auto Scaling User Guide. +// +// [Step scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html type StepScalingPolicyConfiguration struct { - // 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 . + // Specifies how the ScalingAdjustment value in a [StepAdjustment] is interpreted (for example, an + // absolute number or a percentage). The valid values are ChangeInCapacity , + // ExactCapacity , and PercentChangeInCapacity . + // // AdjustmentType is required if you are adding a new step scaling policy // configuration. + // + // [StepAdjustment]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html AdjustmentType AdjustmentType // The amount of time, in seconds, to wait for a previous scaling activity to take - // effect. If not specified, the default value is 300. For more information, see - // Cooldown period (https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) + // effect. If not specified, the default value is 300. For more information, see [Cooldown period] // in the Application Auto Scaling User Guide. + // + // [Cooldown period]: https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown Cooldown *int32 // The aggregation type for the CloudWatch metrics. Valid values are Minimum , @@ -876,8 +1106,10 @@ type StepScalingPolicyConfiguration struct { MinAdjustmentMagnitude *int32 // A set of adjustments that enable you to scale based on the size of the alarm - // breach. At least one step adjustment is required if you are adding a new step - // scaling policy configuration. + // breach. + // + // At least one step adjustment is required if you are adding a new step scaling + // policy configuration. StepAdjustments []StepAdjustment noSmithyDocumentSerde @@ -905,23 +1137,28 @@ type SuspendedState struct { noSmithyDocumentSerde } -// Represents a specific metric. Metric is a property of the -// TargetTrackingMetricStat object. +// Represents a specific metric. +// +// Metric is a property of the TargetTrackingMetricStat object. 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) - // in the Amazon CloudWatch User Guide. Conditional: If you published your metric - // with dimensions, you must specify the same dimensions in your scaling policy. + // Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics]in the Amazon + // CloudWatch User Guide. + // + // Conditional: If you published your metric with dimensions, you must specify the + // same dimensions in your scaling policy. + // + // [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html Dimensions []TargetTrackingMetricDimension // The name of the metric. 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) - // in the Amazon CloudWatch User Guide. + // The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics] in the + // Amazon CloudWatch User Guide. + // + // [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html Namespace *string noSmithyDocumentSerde @@ -930,10 +1167,12 @@ type TargetTrackingMetric struct { // The metric data to return. Also defines whether this call is returning data for // one metric only, or whether it is performing a math expression on the values of // 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) -// in the Application Auto Scaling User Guide. +// 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] in the Application Auto Scaling User +// Guide. +// +// [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 type TargetTrackingMetricDataQuery struct { // A short name that identifies the object's results in the response. This name @@ -949,27 +1188,31 @@ type TargetTrackingMetricDataQuery struct { // The math expression to perform on the returned data, if this object is // 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 - // TargetTrackingMetricDataQuery object, you must specify either Expression or - // MetricStat , but not both. + // to use the result of those expressions. + // + // Conditional: Within each TargetTrackingMetricDataQuery 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 // if this is a math expression, so that you know what the value represents. Label *string - // Information about the metric data to return. Conditional: Within each - // MetricDataQuery object, you must specify either Expression or MetricStat , but - // not both. + // Information about the metric data to return. + // + // Conditional: Within each MetricDataQuery object, you must specify either + // Expression or MetricStat , but not both. MetricStat *TargetTrackingMetricStat // Indicates whether to return the timestamps and raw data values of this metric. + // // If you use any math expressions, specify true for this value for only the final // 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 ). + // 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 ). ReturnData *bool noSmithyDocumentSerde @@ -992,40 +1235,51 @@ 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) -// in the Amazon CloudWatch User Guide. +// statistic, period, and unit. +// +// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts] in the Amazon +// CloudWatch User Guide. +// +// [Amazon CloudWatch concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html 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]object that is returned by a call to [ListMetrics]. + // + // [ListMetrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html + // [Metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.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) - // in the Amazon CloudWatch User Guide. The most commonly used metric for scaling - // is Average . + // statistic. For a list of valid values, see the table in [Statistics]in the Amazon + // CloudWatch User Guide. + // + // The most commonly used metric for scaling is Average . + // + // [Statistics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic // // 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) - // data type in the Amazon CloudWatch API Reference. + // that CloudWatch supports, see the [MetricDatum]data type in the Amazon CloudWatch API + // Reference. + // + // [MetricDatum]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html Unit *string noSmithyDocumentSerde } // Represents a target tracking scaling policy configuration to use with -// Application Auto Scaling. For more information, see Target tracking scaling -// policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) -// in the Application Auto Scaling User Guide. +// Application Auto Scaling. +// +// For more information, see [Target tracking scaling policies] in the Application Auto Scaling User Guide. +// +// [Target tracking scaling policies]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html type TargetTrackingScalingPolicyConfiguration struct { // The target value for the metric. Although this property accepts numbers of type @@ -1033,9 +1287,11 @@ type TargetTrackingScalingPolicyConfiguration struct { // must be in the range of -2^360 to 2^360. The value must be a valid number based // on the choice of metric. For example, if the metric is CPU utilization, then the // target value is a percent value that represents how much of the CPU can be used - // before scaling out. If the scaling policy specifies the ALBRequestCountPerTarget - // predefined metric, specify the target utilization as the optimal average request - // count per target during any one-minute interval. + // before scaling out. + // + // If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, + // specify the target utilization as the optimal average request count per target + // during any one-minute interval. // // This member is required. TargetValue *float64 @@ -1057,14 +1313,16 @@ type TargetTrackingScalingPolicyConfiguration struct { // The amount of time, in seconds, after a scale-in activity completes before // another scale-in activity can start. For more information and for default - // values, see Define cooldown periods (https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) - // in the Application Auto Scaling User Guide. + // values, see [Define cooldown periods]in the Application Auto Scaling User Guide. + // + // [Define cooldown periods]: https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown ScaleInCooldown *int32 // The amount of time, in seconds, to wait for a previous scale-out activity to - // take effect. For more information and for default values, see Define cooldown - // periods (https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) - // in the Application Auto Scaling User Guide. + // take effect. For more information and for default values, see [Define cooldown periods]in the + // Application Auto Scaling User Guide. + // + // [Define cooldown periods]: https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown ScaleOutCooldown *int32 noSmithyDocumentSerde diff --git a/service/applicationcostprofiler/api_op_ImportApplicationUsage.go b/service/applicationcostprofiler/api_op_ImportApplicationUsage.go index b88a84378eb..299e069ec71 100644 --- a/service/applicationcostprofiler/api_op_ImportApplicationUsage.go +++ b/service/applicationcostprofiler/api_op_ImportApplicationUsage.go @@ -12,6 +12,7 @@ import ( ) // Ingests application usage data from Amazon Simple Storage Service (Amazon S3). +// // The data must already exist in the S3 location. As part of the action, AWS // Application Cost Profiler copies the object from your S3 bucket to an S3 bucket // owned by Amazon for processing asynchronously. diff --git a/service/applicationcostprofiler/api_op_ListReportDefinitions.go b/service/applicationcostprofiler/api_op_ListReportDefinitions.go index 30d5bceb374..3e744979d78 100644 --- a/service/applicationcostprofiler/api_op_ListReportDefinitions.go +++ b/service/applicationcostprofiler/api_op_ListReportDefinitions.go @@ -12,6 +12,7 @@ import ( ) // Retrieves a list of all reports and their configurations for your AWS account. +// // The maximum number of reports is one. func (c *Client) ListReportDefinitions(ctx context.Context, params *ListReportDefinitionsInput, optFns ...func(*Options)) (*ListReportDefinitionsOutput, error) { if params == nil { diff --git a/service/applicationcostprofiler/doc.go b/service/applicationcostprofiler/doc.go index 7efae0a5c0b..0fff21bd057 100644 --- a/service/applicationcostprofiler/doc.go +++ b/service/applicationcostprofiler/doc.go @@ -4,10 +4,12 @@ // parameter types for AWS Application Cost Profiler. // // This reference provides descriptions of the AWS Application Cost Profiler API. +// // 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) -// . +// 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]. +// +// [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/options.go b/service/applicationcostprofiler/options.go index 1a5293d2d67..14913565ff8 100644 --- a/service/applicationcostprofiler/options.go +++ b/service/applicationcostprofiler/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/applicationcostprofiler/types/enums.go b/service/applicationcostprofiler/types/enums.go index d81cdecd020..5c48c1c5d93 100644 --- a/service/applicationcostprofiler/types/enums.go +++ b/service/applicationcostprofiler/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "CSV", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ReportFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportFrequency) Values() []ReportFrequency { return []ReportFrequency{ "MONTHLY", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for S3BucketRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3BucketRegion) Values() []S3BucketRegion { return []S3BucketRegion{ "ap-east-1", diff --git a/service/applicationcostprofiler/types/types.go b/service/applicationcostprofiler/types/types.go index a5277463658..307cd8c7caf 100644 --- a/service/applicationcostprofiler/types/types.go +++ b/service/applicationcostprofiler/types/types.go @@ -67,9 +67,10 @@ 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) - // in the AWS General Reference guide. + // For more infomration about Regions that are disabled by default, see [Enabling a Region]in the AWS + // General Reference guide. + // + // [Enabling a Region]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable Region S3BucketRegion noSmithyDocumentSerde diff --git a/service/applicationdiscoveryservice/api_op_BatchDeleteAgents.go b/service/applicationdiscoveryservice/api_op_BatchDeleteAgents.go index 178932c3289..133c57c7c93 100644 --- a/service/applicationdiscoveryservice/api_op_BatchDeleteAgents.go +++ b/service/applicationdiscoveryservice/api_op_BatchDeleteAgents.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes one or more agents or collectors as specified by ID. Deleting an agent +// Deletes one or more agents or collectors as specified by ID. Deleting an agent +// // or collector does not delete the previously discovered data. To delete the data // collected, use StartBatchDeleteConfigurationTask . func (c *Client) BatchDeleteAgents(ctx context.Context, params *BatchDeleteAgentsInput, optFns ...func(*Options)) (*BatchDeleteAgentsOutput, error) { @@ -31,7 +32,7 @@ func (c *Client) BatchDeleteAgents(ctx context.Context, params *BatchDeleteAgent type BatchDeleteAgentsInput struct { - // The list of agents to delete. + // The list of agents to delete. // // This member is required. DeleteAgents []types.DeleteAgent @@ -41,8 +42,8 @@ type BatchDeleteAgentsInput struct { type BatchDeleteAgentsOutput struct { - // A list of agent IDs that failed to delete during the deletion task, each paired - // with an error message. + // A list of agent IDs that failed to delete during the deletion task, each + // paired with an error message. Errors []types.BatchDeleteAgentError // Metadata pertaining to the operation's result. diff --git a/service/applicationdiscoveryservice/api_op_BatchDeleteImportData.go b/service/applicationdiscoveryservice/api_op_BatchDeleteImportData.go index 51b49b58816..f84276dfbca 100644 --- a/service/applicationdiscoveryservice/api_op_BatchDeleteImportData.go +++ b/service/applicationdiscoveryservice/api_op_BatchDeleteImportData.go @@ -13,6 +13,7 @@ import ( // Deletes one or more import tasks, each identified by their import ID. Each // import task has a number of records that can identify servers or applications. +// // Amazon Web Services Application Discovery Service has built-in matching logic // that will identify when discovered servers match existing entries that you've // previously discovered, the information for the already-existing discovered @@ -41,7 +42,7 @@ type BatchDeleteImportDataInput struct { // This member is required. ImportTaskIds []string - // Set to true to remove the deleted import task from DescribeImportTasks . + // Set to true to remove the deleted import task from DescribeImportTasks. DeleteHistory bool noSmithyDocumentSerde diff --git a/service/applicationdiscoveryservice/api_op_CreateTags.go b/service/applicationdiscoveryservice/api_op_CreateTags.go index e09f1b95301..b68d83b0dee 100644 --- a/service/applicationdiscoveryservice/api_op_CreateTags.go +++ b/service/applicationdiscoveryservice/api_op_CreateTags.go @@ -13,7 +13,9 @@ import ( // Creates one or more tags for configuration items. Tags are metadata that help // you categorize IT assets. This API accepts a list of multiple configuration -// items. Do not store sensitive information (like personal data) in tags. +// items. +// +// Do not store sensitive information (like personal data) in tags. func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error) { if params == nil { params = &CreateTagsInput{} @@ -37,8 +39,9 @@ type CreateTagsInput struct { ConfigurationIds []string // Tags that you want to associate with one or more configuration items. Specify - // the tags that you want to create in a key-value format. For example: {"key": - // "serverType", "value": "webServer"} + // the tags that you want to create in a key-value format. For example: + // + // {"key": "serverType", "value": "webServer"} // // This member is required. Tags []types.Tag diff --git a/service/applicationdiscoveryservice/api_op_DeleteTags.go b/service/applicationdiscoveryservice/api_op_DeleteTags.go index 359c8b3ffbc..6a71f4e26cc 100644 --- a/service/applicationdiscoveryservice/api_op_DeleteTags.go +++ b/service/applicationdiscoveryservice/api_op_DeleteTags.go @@ -36,8 +36,9 @@ type DeleteTagsInput struct { ConfigurationIds []string // Tags that you want to delete from one or more configuration items. Specify the - // tags that you want to delete in a key-value format. For example: {"key": - // "serverType", "value": "webServer"} + // tags that you want to delete in a key-value format. For example: + // + // {"key": "serverType", "value": "webServer"} Tags []types.Tag noSmithyDocumentSerde diff --git a/service/applicationdiscoveryservice/api_op_DescribeAgents.go b/service/applicationdiscoveryservice/api_op_DescribeAgents.go index 385090923e6..1b3fdae03bb 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeAgents.go +++ b/service/applicationdiscoveryservice/api_op_DescribeAgents.go @@ -37,7 +37,9 @@ type DescribeAgentsInput struct { AgentIds []string // You can filter the request using various logical operators and a key-value - // format. For example: {"key": "collectionStatus", "value": "STARTED"} + // format. For example: + // + // {"key": "collectionStatus", "value": "STARTED"} Filters []types.Filter // The total number of agents/collectors to return in a single page of output. The diff --git a/service/applicationdiscoveryservice/api_op_DescribeBatchDeleteConfigurationTask.go b/service/applicationdiscoveryservice/api_op_DescribeBatchDeleteConfigurationTask.go index 665d4a640a5..f9de5c86405 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeBatchDeleteConfigurationTask.go +++ b/service/applicationdiscoveryservice/api_op_DescribeBatchDeleteConfigurationTask.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Takes a unique deletion task identifier as input and returns metadata about a +// Takes a unique deletion task identifier as input and returns metadata about a +// // configuration deletion task. func (c *Client) DescribeBatchDeleteConfigurationTask(ctx context.Context, params *DescribeBatchDeleteConfigurationTaskInput, optFns ...func(*Options)) (*DescribeBatchDeleteConfigurationTaskOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) DescribeBatchDeleteConfigurationTask(ctx context.Context, param type DescribeBatchDeleteConfigurationTaskInput struct { - // The ID of the task to delete. + // The ID of the task to delete. // // This member is required. TaskId *string @@ -40,7 +41,7 @@ type DescribeBatchDeleteConfigurationTaskInput struct { type DescribeBatchDeleteConfigurationTaskOutput struct { - // The BatchDeleteConfigurationTask that represents the deletion task being + // The BatchDeleteConfigurationTask that represents the deletion task being // executed. Task *types.BatchDeleteConfigurationTask diff --git a/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go b/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go index 80671c340d4..4bfbd086fc3 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_DescribeConfigurations.go @@ -10,19 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // // 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. +// 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] in the Amazon Web +// Services Application Discovery Service User Guide. +// +// [Using the DescribeConfigurations Action]: https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#DescribeConfigurations func (c *Client) DescribeConfigurations(ctx context.Context, params *DescribeConfigurationsInput, optFns ...func(*Options)) (*DescribeConfigurationsOutput, error) { if params == nil { params = &DescribeConfigurationsInput{} diff --git a/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go b/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go index ba6b6d63042..6b18733c145 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_DescribeExportConfigurations.go @@ -11,10 +11,11 @@ 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], instead. // // Deprecated: This operation has been deprecated. +// +// [DescribeExportTasks]: https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html func (c *Client) DescribeExportConfigurations(ctx context.Context, params *DescribeExportConfigurationsInput, optFns ...func(*Options)) (*DescribeExportConfigurationsOutput, error) { if params == nil { params = &DescribeExportConfigurationsInput{} diff --git a/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go b/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go index a68baab160d..92a9ad8eac6 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go +++ b/service/applicationdiscoveryservice/api_op_DescribeExportTasks.go @@ -34,6 +34,7 @@ type DescribeExportTasksInput struct { ExportIds []string // One or more filters. + // // - AgentId - ID of the agent whose collected data will be exported Filters []types.ExportFilter diff --git a/service/applicationdiscoveryservice/api_op_DescribeTags.go b/service/applicationdiscoveryservice/api_op_DescribeTags.go index 74e55269f94..b6cb689da74 100644 --- a/service/applicationdiscoveryservice/api_op_DescribeTags.go +++ b/service/applicationdiscoveryservice/api_op_DescribeTags.go @@ -13,9 +13,13 @@ 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: +// // - tagKey +// // - tagValue +// // - configurationId // // Also, all configuration items associated with your user that have tags can be diff --git a/service/applicationdiscoveryservice/api_op_ExportConfigurations.go b/service/applicationdiscoveryservice/api_op_ExportConfigurations.go index 19a43a09bdc..8eae65002f0 100644 --- a/service/applicationdiscoveryservice/api_op_ExportConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_ExportConfigurations.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deprecated. Use StartExportTask instead. Exports all discovered configuration -// data to an Amazon S3 bucket or an application that enables you to view and -// evaluate the data. Data includes tags and tag associations, processes, -// connections, servers, and system performance. This API returns an export ID that -// you can query using the DescribeExportConfigurations API. The system imposes a -// limit of two configuration exports in six hours. +// Deprecated. Use StartExportTask instead. +// +// Exports all discovered configuration data to an Amazon S3 bucket or an +// application that enables you to view and evaluate the data. Data includes tags +// and tag associations, processes, connections, servers, and system performance. +// This API returns an export ID that you can query using the +// DescribeExportConfigurations API. The system imposes a limit of two +// configuration exports in six hours. // // Deprecated: This operation has been deprecated. func (c *Client) ExportConfigurations(ctx context.Context, params *ExportConfigurationsInput, optFns ...func(*Options)) (*ExportConfigurationsOutput, error) { diff --git a/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go b/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go index 209b4315e2a..d774f10f0f2 100644 --- a/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go +++ b/service/applicationdiscoveryservice/api_op_GetDiscoverySummary.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a short summary of discovered assets. This API operation takes no -// request parameters and is called as is at the command prompt as shown in the -// example. +// Retrieves a short summary of discovered assets. +// +// This API operation takes no request parameters and is called as is at the +// command prompt as shown in the example. func (c *Client) GetDiscoverySummary(ctx context.Context, params *GetDiscoverySummaryInput, optFns ...func(*Options)) (*GetDiscoverySummaryOutput, error) { if params == nil { params = &GetDiscoverySummaryInput{} @@ -38,7 +39,7 @@ type GetDiscoverySummaryOutput struct { // Details about discovered agents, including agent status and health. AgentSummary *types.CustomerAgentInfo - // Details about Agentless Collector collectors, including status. + // Details about Agentless Collector collectors, including status. AgentlessCollectorSummary *types.CustomerAgentlessCollectorInfo // The number of applications discovered. @@ -47,7 +48,7 @@ type GetDiscoverySummaryOutput struct { // Details about discovered connectors, including connector status and health. ConnectorSummary *types.CustomerConnectorInfo - // Details about Migration Evaluator collectors, including collector status and + // Details about Migration Evaluator collectors, including collector status and // health. MeCollectorSummary *types.CustomerMeCollectorInfo diff --git a/service/applicationdiscoveryservice/api_op_ListConfigurations.go b/service/applicationdiscoveryservice/api_op_ListConfigurations.go index 0dd4b6d8862..e17c928bcff 100644 --- a/service/applicationdiscoveryservice/api_op_ListConfigurations.go +++ b/service/applicationdiscoveryservice/api_op_ListConfigurations.go @@ -37,10 +37,14 @@ type ListConfigurationsInput struct { ConfigurationType types.ConfigurationItemType // 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) - // in the Amazon Web Services Application Discovery Service User Guide. + // 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]in the Amazon Web Services Application Discovery Service User Guide. + // + // [Using the ListConfigurations Action]: https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations Filters []types.Filter // The total number of items to return. The maximum value is 100. @@ -53,9 +57,10 @@ type ListConfigurationsInput struct { NextToken *string // 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) - // in the Amazon Web Services Application Discovery Service User Guide. + // descending order. For a list of output characteristics for each filter, see [Using the ListConfigurations Action]in + // the Amazon Web Services Application Discovery Service User Guide. + // + // [Using the ListConfigurations Action]: https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations OrderBy []types.OrderByElement noSmithyDocumentSerde diff --git a/service/applicationdiscoveryservice/api_op_StartBatchDeleteConfigurationTask.go b/service/applicationdiscoveryservice/api_op_StartBatchDeleteConfigurationTask.go index 7a4109a23b6..76fb76694e4 100644 --- a/service/applicationdiscoveryservice/api_op_StartBatchDeleteConfigurationTask.go +++ b/service/applicationdiscoveryservice/api_op_StartBatchDeleteConfigurationTask.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Takes a list of configurationId as input and starts an asynchronous deletion +// Takes a list of configurationId as input and starts an asynchronous deletion +// // task to remove the configurationItems. Returns a unique deletion task // identifier. func (c *Client) StartBatchDeleteConfigurationTask(ctx context.Context, params *StartBatchDeleteConfigurationTaskInput, optFns ...func(*Options)) (*StartBatchDeleteConfigurationTaskOutput, error) { @@ -31,12 +32,12 @@ func (c *Client) StartBatchDeleteConfigurationTask(ctx context.Context, params * type StartBatchDeleteConfigurationTaskInput struct { - // The list of configuration IDs that will be deleted by the task. + // The list of configuration IDs that will be deleted by the task. // // This member is required. ConfigurationIds []string - // The type of configuration item to delete. Supported types are: SERVER. + // The type of configuration item to delete. Supported types are: SERVER. // // This member is required. ConfigurationType types.DeletionConfigurationItemType @@ -46,7 +47,7 @@ type StartBatchDeleteConfigurationTaskInput struct { type StartBatchDeleteConfigurationTaskOutput struct { - // The unique identifier associated with the newly started deletion task. + // The unique identifier associated with the newly started deletion task. TaskId *string // Metadata pertaining to the operation's result. diff --git a/service/applicationdiscoveryservice/api_op_StartContinuousExport.go b/service/applicationdiscoveryservice/api_op_StartContinuousExport.go index 00974499c75..0af4ab22353 100644 --- a/service/applicationdiscoveryservice/api_op_StartContinuousExport.go +++ b/service/applicationdiscoveryservice/api_op_StartContinuousExport.go @@ -45,6 +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. SchemaStorageConfig map[string]string diff --git a/service/applicationdiscoveryservice/api_op_StartExportTask.go b/service/applicationdiscoveryservice/api_op_StartExportTask.go index 5f2276370af..a64620e8fef 100644 --- a/service/applicationdiscoveryservice/api_op_StartExportTask.go +++ b/service/applicationdiscoveryservice/api_op_StartExportTask.go @@ -13,24 +13,30 @@ import ( ) // Begins the export of a discovered data report to an Amazon S3 bucket managed by -// Amazon Web Services. Exports might provide an estimate of fees and savings based -// on certain information that you provide. Fee estimates do not include any taxes -// that might apply. Your actual fees and savings depend on a variety of factors, -// including your actual usage of Amazon Web Services services, which might vary -// from the estimates provided in this report. If you do not specify preferences -// or agentIds in the filter, a summary of all servers, applications, tags, and -// performance is generated. This data is an aggregation of all server data -// collected through on-premises tooling, file import, application grouping and -// applying tags. 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 concurrently running exports. Export of detailed agent -// data is limited to two exports per day. If you enable -// ec2RecommendationsPreferences in preferences , an Amazon EC2 instance matching -// the characteristics of each server in Application Discovery Service is -// generated. Changing the attributes of the ec2RecommendationsPreferences changes -// the criteria of the recommendation. +// Amazon Web Services. +// +// Exports might provide an estimate of fees and savings based on certain +// information that you provide. Fee estimates do not include any taxes that might +// apply. Your actual fees and savings depend on a variety of factors, including +// your actual usage of Amazon Web Services services, which might vary from the +// estimates provided in this report. +// +// If you do not specify preferences or agentIds in the filter, a summary of all +// servers, applications, tags, and performance is generated. This data is an +// aggregation of all server data collected through on-premises tooling, file +// import, application grouping and applying tags. +// +// 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 concurrently running exports. Export of detailed agent data is +// limited to two exports per day. +// +// If you enable ec2RecommendationsPreferences in preferences , an Amazon EC2 +// instance matching the characteristics of each server in Application Discovery +// Service is generated. Changing the attributes of the +// ec2RecommendationsPreferences changes the criteria of the recommendation. func (c *Client) StartExportTask(ctx context.Context, params *StartExportTaskInput, optFns ...func(*Options)) (*StartExportTaskOutput, error) { if params == nil { params = &StartExportTaskInput{} @@ -65,8 +71,10 @@ type StartExportTaskInput struct { // data from Application Discovery Agent agents. Filters []types.ExportFilter - // Indicates the type of data that needs to be exported. Only one ExportPreferences (https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_ExportPreferences.html) - // can be enabled at any time. + // Indicates the type of data that needs to be exported. Only one [ExportPreferences] can be enabled + // at any time. + // + // [ExportPreferences]: https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_ExportPreferences.html Preferences types.ExportPreferences // The start timestamp for exported data from the single Application Discovery diff --git a/service/applicationdiscoveryservice/api_op_StartImportTask.go b/service/applicationdiscoveryservice/api_op_StartImportTask.go index 20251a89529..a01a437f175 100644 --- a/service/applicationdiscoveryservice/api_op_StartImportTask.go +++ b/service/applicationdiscoveryservice/api_op_StartImportTask.go @@ -18,24 +18,31 @@ import ( // Agentless Collector or Application Discovery Agent. This gives you the option to // perform migration 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: +// 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) -// . +// template, which you can find here: [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) -// 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) -// in the Amazon Web Services Application Discovery Service User Guide. +// For more information, including step-by-step procedures, see [Migration Hub Import] 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]in the Amazon Web +// Services Application Discovery Service User Guide. +// +// [Amazon Web Services Application Discovery Service Limits]: https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html +// [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 +// [Migration Hub Import]: https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html func (c *Client) StartImportTask(ctx context.Context, params *StartImportTaskInput, optFns ...func(*Options)) (*StartImportTaskOutput, error) { if params == nil { params = &StartImportTaskInput{} @@ -53,8 +60,9 @@ func (c *Client) StartImportTask(ctx context.Context, params *StartImportTaskInp type StartImportTaskInput struct { - // The URL for your import file that you've uploaded to Amazon S3. If you're using - // the Amazon Web Services CLI, this URL is structured as follows: + // The URL for your import file that you've uploaded to Amazon S3. + // + // If you're using the Amazon Web Services CLI, this URL is structured as follows: // s3://BucketName/ImportFileName.CSV // // This member is required. @@ -70,9 +78,11 @@ type StartImportTaskInput struct { // 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. + // 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. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/applicationdiscoveryservice/doc.go b/service/applicationdiscoveryservice/doc.go index 39319a95689..be6334f8eae 100644 --- a/service/applicationdiscoveryservice/doc.go +++ b/service/applicationdiscoveryservice/doc.go @@ -3,12 +3,14 @@ // Package applicationdiscoveryservice provides the API client, operations, and // parameter types for AWS Application Discovery Service. // -// Amazon Web Services Application Discovery Service Amazon Web Services -// Application Discovery Service (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 +// # Amazon Web Services Application Discovery Service +// +// Amazon Web Services Application Discovery Service (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]. +// +// Application Discovery Service offers three ways of performing discovery and // collecting data about your on-premises servers: // // - Agentless discovery using Amazon Web Services Application Discovery Service @@ -32,8 +34,7 @@ // // - The information collected by agents is secured at rest and in transit to // the Application Discovery Service database in the Amazon Web Services cloud. For -// more information, see Amazon Web Services Application Discovery Agent (https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-agent.html) -// . +// more information, see [Amazon Web Services Application Discovery Agent]. // // - Amazon Web Services Partner Network (APN) solutions integrate with // Application Discovery Service, enabling you to import details of your @@ -48,27 +49,38 @@ // - In this way, you can import data into Migration Hub and view it, so that // you can associate applications with servers and track migrations. // -// 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) -// . +// # 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]. +// // - 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 (https://docs.aws.amazon.com/application-discovery/latest/userguide/) -// . All data is handled according to the Amazon Web Services Privacy Policy (https://aws.amazon.com/privacy/) -// . You can operate Application Discovery Service offline to inspect collected -// data before it is shared with the service. +// This guide is intended for use with the [Amazon Web Services Application Discovery Service User Guide]. +// +// All data is handled according to the [Amazon Web Services Privacy Policy]. You can operate Application Discovery +// Service offline to inspect collected data before it is shared with the service. +// +// [Amazon Web Services Privacy Policy]: https://aws.amazon.com/privacy/ +// [Amazon Web Services Application Discovery Agent]: https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-agent.html +// [Amazon Web Services SDKs]: http://aws.amazon.com/tools/#SDKs +// [Amazon Web Services Application Discovery Service FAQ]: http://aws.amazon.com/application-discovery/faqs/ +// [Amazon Web Services Application Discovery Service User Guide]: https://docs.aws.amazon.com/application-discovery/latest/userguide/ package applicationdiscoveryservice diff --git a/service/applicationdiscoveryservice/options.go b/service/applicationdiscoveryservice/options.go index 33bc3e728aa..c48c16ec14b 100644 --- a/service/applicationdiscoveryservice/options.go +++ b/service/applicationdiscoveryservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/applicationdiscoveryservice/types/enums.go b/service/applicationdiscoveryservice/types/enums.go index 583228aad56..5ba4bf40789 100644 --- a/service/applicationdiscoveryservice/types/enums.go +++ b/service/applicationdiscoveryservice/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AgentStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentStatus) Values() []AgentStatus { return []AgentStatus{ "HEALTHY", @@ -41,8 +42,9 @@ const ( // Values returns all known values for BatchDeleteConfigurationTaskStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchDeleteConfigurationTaskStatus) Values() []BatchDeleteConfigurationTaskStatus { return []BatchDeleteConfigurationTaskStatus{ "INITIALIZING", @@ -64,8 +66,9 @@ const ( // Values returns all known values for BatchDeleteImportDataErrorCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchDeleteImportDataErrorCode) Values() []BatchDeleteImportDataErrorCode { return []BatchDeleteImportDataErrorCode{ "NOT_FOUND", @@ -85,8 +88,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SERVER", @@ -110,8 +114,9 @@ const ( ) // Values returns all known values for ContinuousExportStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContinuousExportStatus) Values() []ContinuousExportStatus { return []ContinuousExportStatus{ "START_IN_PROGRESS", @@ -132,8 +137,9 @@ const ( ) // Values returns all known values for DataSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSource) Values() []DataSource { return []DataSource{ "AGENT", @@ -150,8 +156,9 @@ const ( ) // Values returns all known values for DeleteAgentErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteAgentErrorCode) Values() []DeleteAgentErrorCode { return []DeleteAgentErrorCode{ "NOT_FOUND", @@ -169,8 +176,9 @@ const ( // Values returns all known values for DeletionConfigurationItemType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeletionConfigurationItemType) Values() []DeletionConfigurationItemType { return []DeletionConfigurationItemType{ "SERVER", @@ -185,8 +193,9 @@ const ( ) // Values returns all known values for ExportDataFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportDataFormat) Values() []ExportDataFormat { return []ExportDataFormat{ "CSV", @@ -203,8 +212,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -231,8 +241,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -259,8 +270,9 @@ const ( ) // Values returns all known values for ImportTaskFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportTaskFilterName) Values() []ImportTaskFilterName { return []ImportTaskFilterName{ "IMPORT_TASK_ID", @@ -278,8 +290,9 @@ const ( ) // Values returns all known values for OfferingClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferingClass) Values() []OfferingClass { return []OfferingClass{ "STANDARD", @@ -296,8 +309,9 @@ const ( ) // Values returns all known values for OrderString. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderString) Values() []OrderString { return []OrderString{ "ASC", @@ -315,8 +329,9 @@ const ( ) // Values returns all known values for PurchasingOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PurchasingOption) Values() []PurchasingOption { return []PurchasingOption{ "ALL_UPFRONT", @@ -334,8 +349,9 @@ const ( ) // Values returns all known values for Tenancy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tenancy) Values() []Tenancy { return []Tenancy{ "DEDICATED", @@ -352,8 +368,9 @@ const ( ) // Values returns all known values for TermLength. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TermLength) Values() []TermLength { return []TermLength{ "ONE_YEAR", diff --git a/service/applicationdiscoveryservice/types/types.go b/service/applicationdiscoveryservice/types/types.go index 34747f9bd2e..d2c1e3218eb 100644 --- a/service/applicationdiscoveryservice/types/types.go +++ b/service/applicationdiscoveryservice/types/types.go @@ -78,22 +78,23 @@ type AgentNetworkInfo struct { noSmithyDocumentSerde } -// An object representing the agent or data collector that failed to delete, each +// An object representing the agent or data collector that failed to delete, each +// // containing agentId, errorMessage, and errorCode. type BatchDeleteAgentError struct { - // The ID of the agent or data collector to delete. + // The ID of the agent or data collector to delete. // // This member is required. AgentId *string - // The type of error that occurred for the delete failed agent. Valid status are: + // The type of error that occurred for the delete failed agent. Valid status are: // AGENT_IN_USE | NOT_FOUND | INTERNAL_SERVER_ERROR. // // This member is required. ErrorCode DeleteAgentErrorCode - // The description of the error that occurred for the delete failed agent. + // The description of the error that occurred for the delete failed agent. // // This member is required. ErrorMessage *string @@ -104,37 +105,37 @@ type BatchDeleteAgentError struct { // A metadata object that represents the deletion task being executed. type BatchDeleteConfigurationTask struct { - // The type of configuration item to delete. Supported types are: SERVER. + // The type of configuration item to delete. Supported types are: SERVER. ConfigurationType DeletionConfigurationItemType - // The list of configuration IDs that were successfully deleted by the deletion + // The list of configuration IDs that were successfully deleted by the deletion // task. DeletedConfigurations []string - // A list of configuration IDs that produced warnings regarding their deletion, + // A list of configuration IDs that produced warnings regarding their deletion, // paired with a warning message. DeletionWarnings []DeletionWarning - // An epoch seconds timestamp (UTC) of when the deletion task was completed or + // An epoch seconds timestamp (UTC) of when the deletion task was completed or // failed. EndTime *time.Time - // A list of configuration IDs that failed to delete during the deletion task, + // A list of configuration IDs that failed to delete during the deletion task, // each paired with an error message. FailedConfigurations []FailedConfiguration - // The list of configuration IDs that were originally requested to be deleted by + // The list of configuration IDs that were originally requested to be deleted by // the deletion task. RequestedConfigurations []string - // An epoch seconds timestamp (UTC) of when the deletion task was started. + // An epoch seconds timestamp (UTC) of when the deletion task was started. StartTime *time.Time - // The current execution status of the deletion task. Valid status are: + // The current execution status of the deletion task. Valid status are: // INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED. Status BatchDeleteConfigurationTaskStatus - // The deletion task's unique identifier. + // The deletion task's unique identifier. TaskId *string noSmithyDocumentSerde @@ -193,6 +194,7 @@ 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. SchemaStorageConfig map[string]string @@ -200,71 +202,93 @@ type ContinuousExportDescription struct { 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. 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. + // information, see [Setting Up Amazon Web Services Application Discovery Service]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. + // increase and try again. For more information, see [Kinesis Data Streams Limits]in the Amazon Kinesis Data + // Streams Developer Guide. + // // - FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state // because your user is missing the Amazon Web // ServicesApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in - // Amazon Athena and try again. For more information, see Creating the Amazon - // Web ServicesApplicationDiscoveryServiceFirehose Role (https://docs.aws.amazon.com/application-discovery/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-create-firehose-role) - // in the Application Discovery Service User Guide. + // Amazon Athena and try again. For more information, see [Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role]in the Application + // Discovery Service User Guide. + // // - FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an // error state because your 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. + // permissions to start continuous export. For more information, see [Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model]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. + // information, see [Change Data Catalog 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. + // For more information, see [Granting Database Permissions]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. + // implicit permissions for any created tables. For more information, see [Implicit Lake Formation Permissions]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. + // more information, see [Bucket Restrictions and Limitations]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) . + // URL: [https://aws.amazon.com/s3]. + // + // [Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role]: https://docs.aws.amazon.com/application-discovery/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-create-firehose-role + // [Implicit Lake Formation Permissions]: https://docs.aws.amazon.com/lake-formation/latest/dg/implicit-permissions.html + // [Granting Database Permissions]: https://docs.aws.amazon.com/lake-formation/latest/dg/granting-database-permissions.html + // [Kinesis Data Streams Limits]: http://docs.aws.amazon.com/streams/latest/dev/service-sizes-and-limits.html + // [Setting Up Amazon Web Services Application Discovery Service]: http://docs.aws.amazon.com/application-discovery/latest/userguide/setting-up.html + // [Change Data Catalog Settings]: https://docs.aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#setup-change-cat-settings + // [https://aws.amazon.com/s3]: https://aws.amazon.com/s3 + // [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 + // [Bucket Restrictions and Limitations]: http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html StatusDetail *string // The timestamp that represents when this continuous export was stopped. @@ -337,17 +361,17 @@ type CustomerAgentlessCollectorInfo struct { // This member is required. ShutdownAgentlessCollectors int32 - // The total number of Agentless Collector collectors. + // The total number of Agentless Collector collectors. // // This member is required. TotalAgentlessCollectors int32 - // The number of unhealthy Agentless Collector collectors. + // The number of unhealthy Agentless Collector collectors. // // This member is required. UnhealthyAgentlessCollectors int32 - // The number of unknown Agentless Collector collectors. + // The number of unknown Agentless Collector collectors. // // This member is required. UnknownAgentlessCollectors int32 @@ -399,37 +423,37 @@ type CustomerConnectorInfo struct { // The inventory data for installed Migration Evaluator collectors. type CustomerMeCollectorInfo struct { - // The number of active Migration Evaluator collectors. + // The number of active Migration Evaluator collectors. // // This member is required. ActiveMeCollectors int32 - // The number of deny-listed Migration Evaluator collectors. + // The number of deny-listed Migration Evaluator collectors. // // This member is required. DenyListedMeCollectors int32 - // The number of healthy Migration Evaluator collectors. + // The number of healthy Migration Evaluator collectors. // // This member is required. HealthyMeCollectors int32 - // The number of Migration Evaluator collectors with SHUTDOWN status. + // The number of Migration Evaluator collectors with SHUTDOWN status. // // This member is required. ShutdownMeCollectors int32 - // The total number of Migration Evaluator collectors. + // The total number of Migration Evaluator collectors. // // This member is required. TotalMeCollectors int32 - // The number of unhealthy Migration Evaluator collectors. + // The number of unhealthy Migration Evaluator collectors. // // This member is required. UnhealthyMeCollectors int32 - // The number of unknown Migration Evaluator collectors. + // The number of unknown Migration Evaluator collectors. // // This member is required. UnknownMeCollectors int32 @@ -437,16 +461,17 @@ type CustomerMeCollectorInfo struct { noSmithyDocumentSerde } -// An object representing the agent or data collector to be deleted along with the -// optional configurations for error handling. +// An object representing the agent or data collector to be deleted along with +// +// the optional configurations for error handling. type DeleteAgent struct { - // The ID of the agent or data collector to delete. + // The ID of the agent or data collector to delete. // // This member is required. AgentId *string - // Optional flag used to force delete an agent or data collector. It is needed to + // Optional flag used to force delete an agent or data collector. It is needed to // delete any agent in HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an // agent that is actively reporting health causes it to be re-registered with a // different agent ID after data collector re-connects with Amazon Web Services. @@ -458,57 +483,61 @@ type DeleteAgent struct { // A configuration ID paired with a warning message. type DeletionWarning struct { - // The unique identifier of the configuration that produced a warning. + // The unique identifier of the configuration that produced a warning. ConfigurationId *string - // The integer warning code associated with the warning message. + // The integer warning code associated with the warning message. WarningCode int32 - // A descriptive message of the warning the associated configuration ID produced. + // A descriptive message of the warning the associated configuration ID produced. WarningText *string noSmithyDocumentSerde } -// Indicates that the exported data must include EC2 instance type matches for +// Indicates that the exported data must include EC2 instance type matches for +// // on-premises servers that are discovered through Amazon Web Services Application // Discovery Service. type Ec2RecommendationsExportPreferences struct { - // The recommended EC2 instance type that matches the CPU usage metric of server + // The recommended EC2 instance type that matches the CPU usage metric of server // performance data. CpuPerformanceMetricBasis *UsageMetricBasis - // If set to true, the export preferences (https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestSyntax) - // is set to Ec2RecommendationsExportPreferences . + // If set to true, the export [preferences] is set to Ec2RecommendationsExportPreferences . + // + // [preferences]: https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestSyntax Enabled bool - // An array of instance types to exclude from recommendations. + // An array of instance types to exclude from recommendations. ExcludedInstanceTypes []string - // The target Amazon Web Services Region for the recommendations. You can use any - // of the Region codes available for the chosen service, as listed in Amazon Web - // Services service endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) - // in the Amazon Web Services General Reference. + // The target Amazon Web Services Region for the recommendations. You can use any + // of the Region codes available for the chosen service, as listed in [Amazon Web Services service endpoints]in the + // Amazon Web Services General Reference. + // + // [Amazon Web Services service endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html PreferredRegion *string - // The recommended EC2 instance type that matches the Memory usage metric of + // The recommended EC2 instance type that matches the Memory usage metric of // server performance data. RamPerformanceMetricBasis *UsageMetricBasis - // The contract type for a reserved instance. If blank, we assume an On-Demand + // The contract type for a reserved instance. If blank, we assume an On-Demand // instance is preferred. ReservedInstanceOptions *ReservedInstanceOptions - // The target tenancy to use for your recommended EC2 instances. + // The target tenancy to use for your recommended EC2 instances. Tenancy Tenancy noSmithyDocumentSerde } // 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) -// action. +// selected for export using the [StartExportTask]action. +// +// [StartExportTask]: http://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html type ExportFilter struct { // Supported condition: EQUALS @@ -521,10 +550,11 @@ type ExportFilter struct { // 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) + // A single agent ID for a Discovery Agent. An agent ID can be found using the [DescribeAgents] // 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 + // // This member is required. Values []string @@ -576,18 +606,21 @@ type ExportInfo struct { noSmithyDocumentSerde } -// Indicates the type of data that is being exported. Only one ExportPreferences -// can be enabled for a StartExportTask (https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html) -// action. +// Indicates the type of data that is being exported. Only one ExportPreferences +// +// can be enabled for a [StartExportTask]action. // // The following types satisfy this interface: // // ExportPreferencesMemberEc2RecommendationsPreferences +// +// [StartExportTask]: https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_StartExportTask.html type ExportPreferences interface { isExportPreferences() } -// If enabled, exported data includes EC2 instance type matches for on-premises +// If enabled, exported data includes EC2 instance type matches for on-premises +// // servers discovered through Amazon Web Services Application Discovery Service. type ExportPreferencesMemberEc2RecommendationsPreferences struct { Value Ec2RecommendationsExportPreferences @@ -600,22 +633,25 @@ func (*ExportPreferencesMemberEc2RecommendationsPreferences) isExportPreferences // A configuration ID paired with an error message. type FailedConfiguration struct { - // The unique identifier of the configuration the failed to delete. + // The unique identifier of the configuration the failed to delete. ConfigurationId *string - // A descriptive message indicating why the associated configuration failed to + // A descriptive message indicating why the associated configuration failed to // delete. ErrorMessage *string - // The integer error code associated with the error message. + // The integer error code associated with the error message. ErrorStatusCode int32 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) -// in the Amazon Web Services Application Discovery Service User Guide. +// A filter that can use conditional operators. +// +// For more information about filters, see [Querying Discovered Configuration Items] in the Amazon Web Services Application +// Discovery Service User Guide. +// +// [Querying Discovered Configuration Items]: https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html type Filter struct { // A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, @@ -663,12 +699,15 @@ type ImportTask struct { // 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 - // so you can confirm the authenticity of the compressed archive before you - // download it. If some records failed to be imported we recommend that you correct - // the records in the failed entries file and then imports that failed entries - // file. This prevents you from having to correct and update the larger original - // file and attempt importing it again. + // another import task request. + // + // This field also includes authorization information so you can confirm the + // authenticity of the compressed archive before you download it. + // + // If some records failed to be imported we recommend that you correct the records + // in the failed entries file and then imports that failed entries file. This + // prevents you from having to correct and update the larger original file and + // attempt importing it again. ErrorsAndFailedEntriesZip *string // The time that the import task request finished, presented in the Unix time @@ -714,8 +753,9 @@ type ImportTask struct { } // A name-values pair of elements you can use to filter the results when querying -// your import tasks. Currently, wildcards are not supported for filters. When -// filtering by import status, all other filter values are ignored. +// your import tasks. Currently, wildcards are not supported for filters. +// +// When filtering by import status, all other filter values are ignored. type ImportTaskFilter struct { // The name, status, or import task ID for a specific import task. @@ -772,17 +812,18 @@ type OrderByElement struct { // Used to provide Reserved Instance preferences for the recommendation. type ReservedInstanceOptions struct { - // The flexibility to change the instance types needed for your Reserved Instance. + // The flexibility to change the instance types needed for your Reserved + // Instance. // // This member is required. OfferingClass OfferingClass - // The payment plan to use for your Reserved Instance. + // The payment plan to use for your Reserved Instance. // // This member is required. PurchasingOption PurchasingOption - // The preferred duration of the Reserved Instance term. + // The preferred duration of the Reserved Instance term. // // This member is required. TermLength TermLength @@ -790,8 +831,9 @@ type ReservedInstanceOptions struct { noSmithyDocumentSerde } -// Metadata that help you categorize IT assets. Do not store sensitive information -// (like personal data) in tags. +// Metadata that help you categorize IT assets. +// +// Do not store sensitive information (like personal data) in tags. type Tag struct { // The type of tag on which to filter. @@ -823,14 +865,15 @@ type TagFilter struct { noSmithyDocumentSerde } -// Specifies the performance metrics to use for the server that is used for +// Specifies the performance metrics to use for the server that is used for +// // recommendations. type UsageMetricBasis struct { - // A utilization metric that is used by the recommendations. + // A utilization metric that is used by the recommendations. Name *string - // Specifies the percentage of the specified utilization metric that is used by + // Specifies the percentage of the specified utilization metric that is used by // the recommendations. PercentageAdjust *float64 diff --git a/service/applicationinsights/api_op_CreateApplication.go b/service/applicationinsights/api_op_CreateApplication.go index cf5052f891c..a2b08497410 100644 --- a/service/applicationinsights/api_op_CreateApplication.go +++ b/service/applicationinsights/api_op_CreateApplication.go @@ -33,15 +33,15 @@ type CreateApplicationInput struct { // instance roles if they are missing. AttachMissingPermission *bool - // Indicates whether Application Insights automatically configures unmonitored + // Indicates whether Application Insights automatically configures unmonitored // resources in the resource group. AutoConfigEnabled *bool - // Configures all of the resources in the resource group by applying the + // Configures all of the resources in the resource group by applying the // recommended configurations. AutoCreate *bool - // Indicates whether Application Insights can listen to CloudWatch events for the + // Indicates whether Application Insights can listen to CloudWatch events for the // application resources, such as instance terminated , failed deployment , and // others. CWEMonitorEnabled *bool @@ -51,10 +51,11 @@ type CreateApplicationInput struct { // 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 + // 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 diff --git a/service/applicationinsights/api_op_ListConfigurationHistory.go b/service/applicationinsights/api_op_ListConfigurationHistory.go index 4b6d36c2340..081a8629161 100644 --- a/service/applicationinsights/api_op_ListConfigurationHistory.go +++ b/service/applicationinsights/api_op_ListConfigurationHistory.go @@ -12,11 +12,15 @@ import ( "time" ) -// Lists the INFO, WARN, and ERROR events for periodic configuration updates +// 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. func (c *Client) ListConfigurationHistory(ctx context.Context, params *ListConfigurationHistoryInput, optFns ...func(*Options)) (*ListConfigurationHistoryOutput, error) { if params == nil { @@ -45,9 +49,9 @@ type ListConfigurationHistoryInput struct { // WARN, and ERROR. EventStatus types.ConfigurationEventStatus - // The maximum number of results returned by ListConfigurationHistory in paginated - // output. When this parameter is used, ListConfigurationHistory returns only - // MaxResults in a single page along with a NextToken response element. The + // The maximum number of results returned by ListConfigurationHistory in + // paginated output. When this parameter is used, ListConfigurationHistory returns + // only MaxResults in a single page along with a NextToken response element. The // remaining results of the initial request can be seen by sending another // ListConfigurationHistory request with the returned NextToken value. If this // parameter is not used, then ListConfigurationHistory returns all results. @@ -71,7 +75,7 @@ type ListConfigurationHistoryInput struct { type ListConfigurationHistoryOutput struct { - // The list of configuration events and their corresponding details. + // The list of configuration events and their corresponding details. EventList []types.ConfigurationEvent // The NextToken value to include in a future ListConfigurationHistory request. @@ -173,9 +177,9 @@ var _ ListConfigurationHistoryAPIClient = (*Client)(nil) // ListConfigurationHistoryPaginatorOptions is the paginator options for // ListConfigurationHistory type ListConfigurationHistoryPaginatorOptions struct { - // The maximum number of results returned by ListConfigurationHistory in paginated - // output. When this parameter is used, ListConfigurationHistory returns only - // MaxResults in a single page along with a NextToken response element. The + // The maximum number of results returned by ListConfigurationHistory in + // paginated output. When this parameter is used, ListConfigurationHistory returns + // only MaxResults in a single page along with a NextToken response element. The // remaining results of the initial request can be seen by sending another // ListConfigurationHistory request with the returned NextToken value. If this // parameter is not used, then ListConfigurationHistory returns all results. diff --git a/service/applicationinsights/api_op_ListProblems.go b/service/applicationinsights/api_op_ListProblems.go index d4b22f29ec5..2ab7c13bf87 100644 --- a/service/applicationinsights/api_op_ListProblems.go +++ b/service/applicationinsights/api_op_ListProblems.go @@ -33,7 +33,7 @@ type ListProblemsInput struct { // The AWS account ID for the resource group owner. AccountId *string - // The name of the component. + // The name of the component. ComponentName *string // The time when the problem ended, in epoch seconds. If not specified, problems @@ -73,7 +73,7 @@ type ListProblemsOutput struct { // The list of problems. ProblemList []types.Problem - // The name of the resource group. + // The name of the resource group. ResourceGroupName *string // Metadata pertaining to the operation's result. diff --git a/service/applicationinsights/api_op_TagResource.go b/service/applicationinsights/api_op_TagResource.go index 7282849aef1..1db8b770c70 100644 --- a/service/applicationinsights/api_op_TagResource.go +++ b/service/applicationinsights/api_op_TagResource.go @@ -14,10 +14,11 @@ import ( // Add one or more tags (keys and values) to a specified application. A tag is a // label that you optionally define and associate with an application. Tags can // help you categorize and manage application 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 more specific tag values. A tag value -// acts as a descriptor within a tag key. +// 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 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{} diff --git a/service/applicationinsights/api_op_UntagResource.go b/service/applicationinsights/api_op_UntagResource.go index 85e7b152f99..a3fdc0b46c6 100644 --- a/service/applicationinsights/api_op_UntagResource.go +++ b/service/applicationinsights/api_op_UntagResource.go @@ -35,9 +35,10 @@ type UntagResourceInput struct { ResourceARN *string // The tags (tag keys) that you want to remove from the resource. When you specify - // a tag key, the action removes both that key and its associated tag value. To - // remove more than one tag from the application, append the TagKeys parameter and - // argument for each additional tag to remove, separated by an ampersand. + // a tag key, the action removes both that key and its associated tag value. + // + // To remove more than one tag from the application, append the TagKeys parameter + // and argument for each additional tag to remove, separated by an ampersand. // // This member is required. TagKeys []string diff --git a/service/applicationinsights/api_op_UpdateApplication.go b/service/applicationinsights/api_op_UpdateApplication.go index 9566f5bd651..7602c334ce7 100644 --- a/service/applicationinsights/api_op_UpdateApplication.go +++ b/service/applicationinsights/api_op_UpdateApplication.go @@ -38,22 +38,23 @@ type UpdateApplicationInput struct { // instance roles if they are missing. AttachMissingPermission *bool - // Turns auto-configuration on or off. + // Turns auto-configuration on or off. AutoConfigEnabled *bool - // Indicates whether Application Insights can listen to CloudWatch events for the + // Indicates whether Application Insights can listen to CloudWatch events for the // 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 + // 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. + // Disassociates the SNS topic from the opsItem created for detected problems. RemoveSNSTopic *bool noSmithyDocumentSerde diff --git a/service/applicationinsights/api_op_UpdateComponentConfiguration.go b/service/applicationinsights/api_op_UpdateComponentConfiguration.go index 2f1fa6c4157..84f68aa834c 100644 --- a/service/applicationinsights/api_op_UpdateComponentConfiguration.go +++ b/service/applicationinsights/api_op_UpdateComponentConfiguration.go @@ -41,17 +41,18 @@ type UpdateComponentConfigurationInput struct { // This member is required. ResourceGroupName *string - // Automatically configures the component by applying the recommended + // Automatically configures the component by applying the recommended // configurations. AutoConfigEnabled *bool // 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 - // 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) - // . + // the configuration. For more information about the JSON format, see [Working with JSON]. 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]. + // + // [Working with JSON]: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html + // [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_UpdateWorkload.go b/service/applicationinsights/api_op_UpdateWorkload.go index fe4b7f5460d..a836b751c1f 100644 --- a/service/applicationinsights/api_op_UpdateWorkload.go +++ b/service/applicationinsights/api_op_UpdateWorkload.go @@ -29,7 +29,7 @@ func (c *Client) UpdateWorkload(ctx context.Context, params *UpdateWorkloadInput type UpdateWorkloadInput struct { - // The name of the component. + // The name of the component. // // This member is required. ComponentName *string diff --git a/service/applicationinsights/doc.go b/service/applicationinsights/doc.go index 5e5c2d967ee..cfd6e1dd2cc 100644 --- a/service/applicationinsights/doc.go +++ b/service/applicationinsights/doc.go @@ -3,16 +3,20 @@ // 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 -// 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 -// application, CloudWatch Application Insights identifies, recommends, and sets up -// metrics and logs. It continuously analyzes and correlates your metrics and logs -// for unusual behavior to surface actionable problems with your application. For -// example, if your application is slow and unresponsive and leading to HTTP 500 -// errors in your Application Load Balancer (ALB), Application Insights informs you -// that a memory pressure problem with your SQL Server database is occurring. It -// bases this analysis on impactful metrics and log errors. +// # 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 application, CloudWatch Application Insights identifies, +// recommends, and sets up metrics and logs. It continuously analyzes and +// correlates your metrics and logs for unusual behavior to surface actionable +// problems with your application. For example, if your application is slow and +// unresponsive and leading to HTTP 500 errors in your Application Load Balancer +// (ALB), Application Insights informs you that a memory pressure problem with your +// SQL Server database is occurring. It bases this analysis on impactful metrics +// and log errors. package applicationinsights diff --git a/service/applicationinsights/options.go b/service/applicationinsights/options.go index 0104b50bbfd..498a4de5f66 100644 --- a/service/applicationinsights/options.go +++ b/service/applicationinsights/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/applicationinsights/types/enums.go b/service/applicationinsights/types/enums.go index 935b47c9885..726389728ca 100644 --- a/service/applicationinsights/types/enums.go +++ b/service/applicationinsights/types/enums.go @@ -13,8 +13,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "EC2", @@ -36,8 +37,9 @@ const ( // Values returns all known values for ConfigurationEventResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationEventResourceType) Values() []ConfigurationEventResourceType { return []ConfigurationEventResourceType{ "CLOUDWATCH_ALARM", @@ -58,6 +60,7 @@ const ( // 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{ @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for DiscoveryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiscoveryType) Values() []DiscoveryType { return []DiscoveryType{ "RESOURCE_GROUP_BASED", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for FeedbackKey. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeedbackKey) Values() []FeedbackKey { return []FeedbackKey{ "INSIGHTS_FEEDBACK", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for FeedbackValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeedbackValue) Values() []FeedbackValue { return []FeedbackValue{ "NOT_SPECIFIED", @@ -129,8 +135,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -147,8 +154,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -166,8 +174,9 @@ const ( ) // Values returns all known values for OsType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OsType) Values() []OsType { return []OsType{ "WINDOWS", @@ -185,8 +194,9 @@ const ( ) // Values returns all known values for RecommendationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationType) Values() []RecommendationType { return []RecommendationType{ "INFRA_ONLY", @@ -205,8 +215,9 @@ const ( ) // Values returns all known values for ResolutionMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolutionMethod) Values() []ResolutionMethod { return []ResolutionMethod{ "MANUAL", @@ -226,8 +237,9 @@ const ( ) // Values returns all known values for SeverityLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SeverityLevel) Values() []SeverityLevel { return []SeverityLevel{ "Informative", @@ -249,8 +261,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "IGNORE", @@ -289,8 +302,9 @@ const ( ) // Values returns all known values for Tier. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tier) Values() []Tier { return []Tier{ "CUSTOM", @@ -325,8 +339,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "RESOLVED", @@ -342,8 +357,9 @@ const ( ) // Values returns all known values for Visibility. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Visibility) Values() []Visibility { return []Visibility{ "IGNORED", diff --git a/service/applicationinsights/types/types.go b/service/applicationinsights/types/types.go index 56f5e74113e..a4cb6ce0ba4 100644 --- a/service/applicationinsights/types/types.go +++ b/service/applicationinsights/types/types.go @@ -14,17 +14,17 @@ type ApplicationComponent struct { // The name of the component. ComponentName *string - // If logging is supported for the resource type, indicates whether the component + // If logging is supported for the resource type, indicates whether the component // has configured logs to be monitored. ComponentRemarks *string - // Workloads detected in the application component. + // Workloads detected in the application component. DetectedWorkload map[string]map[string]string // Indicates whether the application component is monitored. Monitor *bool - // The operating system of the component. + // The operating system of the component. OsType OsType // The resource type. Supported resource types include EC2 instances, Auto Scaling @@ -47,31 +47,33 @@ type ApplicationInfo struct { // instance roles if they are missing. AttachMissingPermission *bool - // Indicates whether auto-configuration is turned on for this application. + // Indicates whether auto-configuration is turned on for this application. AutoConfigEnabled *bool - // Indicates whether Application Insights can listen to CloudWatch events for the + // Indicates whether Application Insights can listen to CloudWatch events for the // application resources, such as instance terminated , failed deployment , and // others. CWEMonitorEnabled *bool - // The method used by Application Insights to onboard your resources. + // The method used by Application Insights to onboard your resources. DiscoveryType DiscoveryType // The lifecycle of the application. LifeCycle *string - // Indicates whether Application Insights will create opsItems for any problem + // Indicates whether Application Insights will create opsItems for any problem // detected by Application Insights for an application. OpsCenterEnabled *bool - // The SNS topic provided to Application Insights that is associated to the + // 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” Remarks *string @@ -88,24 +90,24 @@ type ConfigurationEvent struct { // event belongs. AccountId *string - // The details of the event in plain text. + // The details of the event in plain text. EventDetail *string - // The name of the resource Application Insights attempted to configure. + // The name of the resource Application Insights attempted to configure. EventResourceName *string - // The resource type that Application Insights attempted to configure, for + // 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, + // The status of the configuration update event. Possible values include INFO, // WARN, and ERROR. EventStatus ConfigurationEventStatus - // The timestamp of the event. + // The timestamp of the event. EventTime *time.Time - // The resource monitored by Application Insights. + // The resource monitored by Application Insights. MonitoredResourceARN *string // The name of the resource group of the application to which the configuration @@ -150,66 +152,67 @@ type LogPattern struct { // Describes an anomaly or error with the application. type Observation struct { - // The detail type of the CloudWatch Event-based observation, for example, EC2 + // The detail type of the CloudWatch Event-based observation, for example, EC2 // Instance State-change Notification . CloudWatchEventDetailType *string - // The ID of the CloudWatch Event-based observation related to the detected + // The ID of the CloudWatch Event-based observation related to the detected // problem. CloudWatchEventId *string - // The source of the CloudWatch Event. + // The source of the CloudWatch Event. CloudWatchEventSource CloudWatchEventSource - // The CodeDeploy application to which the deployment belongs. + // The CodeDeploy application to which the deployment belongs. CodeDeployApplication *string - // The deployment group to which the CodeDeploy deployment belongs. + // The deployment group to which the CodeDeploy deployment belongs. CodeDeployDeploymentGroup *string - // The deployment ID of the CodeDeploy-based observation related to the detected + // The deployment ID of the CodeDeploy-based observation related to the detected // problem. CodeDeployDeploymentId *string - // The instance group to which the CodeDeploy instance belongs. + // 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. + // The cause of an EBS CloudWatch event. EbsCause *string - // The type of EBS CloudWatch event, such as createVolume , deleteVolume or + // The type of EBS CloudWatch event, such as createVolume , deleteVolume or // attachVolume . EbsEvent *string - // The request ID of an EBS CloudWatch event. + // 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. EndTime *time.Time - // The Amazon Resource Name (ARN) of the AWS Health Event-based observation. + // The Amazon Resource Name (ARN) of the AWS Health Event-based observation. HealthEventArn *string - // The description of the AWS Health event provided by the service, such as Amazon - // EC2. + // The description of the AWS Health event provided by the service, such as + // Amazon 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. + // The service to which the AWS Health Event belongs, such as EC2. HealthService *string // The ID of the observation type. @@ -234,13 +237,13 @@ type Observation struct { // The namespace of the observation metric. MetricNamespace *string - // The category of an RDS event. + // The category of an RDS event. RdsEventCategories *string - // The message of an RDS event. + // The message of an RDS event. RdsEventMessage *string - // The name of the S3 CloudWatch Event-based observation. + // The name of the S3 CloudWatch Event-based observation. S3EventName *string // The source resource ARN of the observation. @@ -252,16 +255,17 @@ type Observation struct { // The time when the observation was first detected, in epoch seconds. StartTime *time.Time - // The Amazon Resource Name (ARN) of the step function-based observation. + // The Amazon Resource Name (ARN) of the step function-based observation. StatesArn *string - // The Amazon Resource Name (ARN) of the step function execution-based observation. + // The Amazon Resource Name (ARN) of the step function execution-based + // observation. StatesExecutionArn *string - // The input to the step function-based observation. + // The input to the step function-based observation. StatesInput *string - // The status of the step function-related observation. + // The status of the step function-related observation. StatesStatus *string // The unit of the source observation metric. @@ -270,25 +274,25 @@ type Observation struct { // The value of the source observation metric. Value *float64 - // The X-Ray request error percentage for this node. + // The X-Ray request error percentage for this node. XRayErrorPercent *int32 - // The X-Ray request fault percentage for this node. + // The X-Ray request fault percentage for this node. XRayFaultPercent *int32 - // The name of the X-Ray node. + // The name of the X-Ray node. XRayNodeName *string - // The type of the X-Ray node. + // The type of the X-Ray node. XRayNodeType *string - // The X-Ray node request average latency for this node. + // The X-Ray node request average latency for this node. XRayRequestAverageLatency *int64 - // The X-Ray request count for this node. + // The X-Ray request count for this node. XRayRequestCount *int32 - // The X-Ray request throttle percentage for this node. + // The X-Ray request throttle percentage for this node. XRayThrottlePercent *int32 noSmithyDocumentSerde @@ -315,10 +319,10 @@ type Problem struct { // A detailed analysis of the problem using machine learning. Insights *string - // The last time that the problem reoccurred after its last resolution. + // 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 + // The number of times that the same problem reoccurred after the first time it // was resolved. RecurringCount *int64 @@ -361,16 +365,21 @@ type RelatedObservations struct { // 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: +// 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. diff --git a/service/appmesh/api_op_CreateGatewayRoute.go b/service/appmesh/api_op_CreateGatewayRoute.go index 4628c9d084f..7a3800a918c 100644 --- a/service/appmesh/api_op_CreateGatewayRoute.go +++ b/service/appmesh/api_op_CreateGatewayRoute.go @@ -11,11 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -62,8 +66,9 @@ type CreateGatewayRouteInput struct { // 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) - // . + // For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 319315bf6a4..3837466e646 100644 --- a/service/appmesh/api_op_CreateMesh.go +++ b/service/appmesh/api_op_CreateMesh.go @@ -11,13 +11,16 @@ 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]. +// +// [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 9724369c849..8ecfee27cdf 100644 --- a/service/appmesh/api_op_CreateRoute.go +++ b/service/appmesh/api_op_CreateRoute.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -61,8 +65,9 @@ type CreateRouteInput struct { // 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) - // . + // For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 1ad6761bb18..528bb616782 100644 --- a/service/appmesh/api_op_CreateVirtualGateway.go +++ b/service/appmesh/api_op_CreateVirtualGateway.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a virtual gateway. A virtual gateway allows resources outside your mesh -// to communicate to resources that are inside your mesh. The virtual gateway -// represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes -// 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) -// . +// Creates a virtual gateway. +// +// A virtual gateway allows resources outside your mesh to communicate to +// resources that are inside your mesh. The virtual gateway represents an Envoy +// proxy running in an Amazon ECS task, in a Kubernetes 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]. +// +// [Virtual 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{} @@ -58,8 +61,9 @@ type CreateVirtualGatewayInput struct { // 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) - // . + // For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 228eb34bf68..74dc309742e 100644 --- a/service/appmesh/api_op_CreateVirtualNode.go +++ b/service/appmesh/api_op_CreateVirtualNode.go @@ -11,27 +11,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a virtual node within a service mesh. A virtual node acts as a logical -// pointer to a particular task group, such as an Amazon ECS service or a -// Kubernetes deployment. When you create a virtual node, you can specify the -// service discovery information for your task group, and whether the proxy running -// 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, +// Creates a virtual node within a service mesh. +// +// A virtual node acts as a logical pointer to a particular task group, such as an +// Amazon ECS service or a Kubernetes deployment. When you create a virtual node, +// you can specify the service discovery information for your task group, and +// whether the proxy running 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 // 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 -// 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. +// 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]. 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]in the App Mesh User Guide. +// +// [Virtual nodes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html +// [Envoy image]: https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html func (c *Client) CreateVirtualNode(ctx context.Context, params *CreateVirtualNodeInput, optFns ...func(*Options)) (*CreateVirtualNodeOutput, error) { if params == nil { params = &CreateVirtualNodeInput{} @@ -71,8 +80,9 @@ type CreateVirtualNodeInput struct { // 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) - // . + // For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 2cc15154ddf..84a8bbdad4f 100644 --- a/service/appmesh/api_op_CreateVirtualRouter.go +++ b/service/appmesh/api_op_CreateVirtualRouter.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a virtual router within a service mesh. Specify a listener for any -// inbound traffic that your virtual router receives. Create a virtual router for -// each protocol and port that you need to route. Virtual routers handle traffic -// 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) -// . +// Creates a virtual router within a service mesh. +// +// Specify a listener for any inbound traffic that your virtual router receives. +// Create a virtual router for each protocol and port that you need to route. +// Virtual routers handle traffic 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]. +// +// [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{} @@ -58,8 +61,9 @@ type CreateVirtualRouterInput struct { // 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) - // . + // For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 8c008bcb567..7190c81309f 100644 --- a/service/appmesh/api_op_CreateVirtualService.go +++ b/service/appmesh/api_op_CreateVirtualService.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// . +// 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 node or virtual router that is specified as +// the provider for the virtual service. +// +// For more information about virtual services, see [Virtual services]. +// +// [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{} @@ -57,8 +61,9 @@ type CreateVirtualServiceInput struct { // 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) - // . + // For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 d2170f8560b..0cc93fdfe08 100644 --- a/service/appmesh/api_op_DeleteGatewayRoute.go +++ b/service/appmesh/api_op_DeleteGatewayRoute.go @@ -46,9 +46,9 @@ type DeleteGatewayRouteInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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_DeleteMesh.go b/service/appmesh/api_op_DeleteMesh.go index b4340be7df5..7fe0efa6e19 100644 --- a/service/appmesh/api_op_DeleteMesh.go +++ b/service/appmesh/api_op_DeleteMesh.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing service mesh. You must delete all resources (virtual -// services, routes, virtual routers, and virtual nodes) in the service mesh before -// you can delete the mesh itself. +// Deletes an existing service mesh. +// +// You must delete all resources (virtual services, routes, virtual routers, and +// virtual nodes) in the service mesh before you can delete the mesh itself. func (c *Client) DeleteMesh(ctx context.Context, params *DeleteMeshInput, optFns ...func(*Options)) (*DeleteMeshOutput, error) { if params == nil { params = &DeleteMeshInput{} diff --git a/service/appmesh/api_op_DeleteRoute.go b/service/appmesh/api_op_DeleteRoute.go index a85d04c88c7..817f281762a 100644 --- a/service/appmesh/api_op_DeleteRoute.go +++ b/service/appmesh/api_op_DeleteRoute.go @@ -46,9 +46,9 @@ type DeleteRouteInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 96e322431c2..f2b00843283 100644 --- a/service/appmesh/api_op_DeleteVirtualGateway.go +++ b/service/appmesh/api_op_DeleteVirtualGateway.go @@ -42,9 +42,9 @@ type DeleteVirtualGatewayInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 54a7760638a..5687919dbab 100644 --- a/service/appmesh/api_op_DeleteVirtualNode.go +++ b/service/appmesh/api_op_DeleteVirtualNode.go @@ -11,9 +11,10 @@ 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 -// itself. +// 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 { params = &DeleteVirtualNodeInput{} @@ -44,9 +45,9 @@ type DeleteVirtualNodeInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 ea3da7be403..7116f8eab5a 100644 --- a/service/appmesh/api_op_DeleteVirtualRouter.go +++ b/service/appmesh/api_op_DeleteVirtualRouter.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing virtual router. You must delete any routes associated with -// the virtual router before you can delete the router itself. +// Deletes an existing virtual router. +// +// You must delete any routes associated with the virtual router before you can +// delete the router itself. func (c *Client) DeleteVirtualRouter(ctx context.Context, params *DeleteVirtualRouterInput, optFns ...func(*Options)) (*DeleteVirtualRouterOutput, error) { if params == nil { params = &DeleteVirtualRouterInput{} @@ -42,9 +44,9 @@ type DeleteVirtualRouterInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 311bd1d6f89..573fb9344db 100644 --- a/service/appmesh/api_op_DeleteVirtualService.go +++ b/service/appmesh/api_op_DeleteVirtualService.go @@ -41,9 +41,9 @@ type DeleteVirtualServiceInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 f86d374581c..6ff6549b3ed 100644 --- a/service/appmesh/api_op_DescribeGatewayRoute.go +++ b/service/appmesh/api_op_DescribeGatewayRoute.go @@ -46,9 +46,9 @@ type DescribeGatewayRouteInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 e7c489f7805..27b3a5e3884 100644 --- a/service/appmesh/api_op_DescribeMesh.go +++ b/service/appmesh/api_op_DescribeMesh.go @@ -36,9 +36,9 @@ type DescribeMeshInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 fea604b7256..0e3f5cb8f34 100644 --- a/service/appmesh/api_op_DescribeRoute.go +++ b/service/appmesh/api_op_DescribeRoute.go @@ -46,9 +46,9 @@ type DescribeRouteInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 ede3eb5d30e..62ae1111a68 100644 --- a/service/appmesh/api_op_DescribeVirtualGateway.go +++ b/service/appmesh/api_op_DescribeVirtualGateway.go @@ -41,9 +41,9 @@ type DescribeVirtualGatewayInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 47a2cc1de68..41223281fee 100644 --- a/service/appmesh/api_op_DescribeVirtualNode.go +++ b/service/appmesh/api_op_DescribeVirtualNode.go @@ -41,9 +41,9 @@ type DescribeVirtualNodeInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 e574136d565..9dd1a742830 100644 --- a/service/appmesh/api_op_DescribeVirtualRouter.go +++ b/service/appmesh/api_op_DescribeVirtualRouter.go @@ -41,9 +41,9 @@ type DescribeVirtualRouterInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 7522a81d2f1..3dce297c587 100644 --- a/service/appmesh/api_op_DescribeVirtualService.go +++ b/service/appmesh/api_op_DescribeVirtualService.go @@ -41,9 +41,9 @@ type DescribeVirtualServiceInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 9b3124e0979..74387ac0181 100644 --- a/service/appmesh/api_op_ListGatewayRoutes.go +++ b/service/appmesh/api_op_ListGatewayRoutes.go @@ -51,9 +51,9 @@ type ListGatewayRoutesInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 diff --git a/service/appmesh/api_op_ListMeshes.go b/service/appmesh/api_op_ListMeshes.go index 6259d474ab9..f3416a557d4 100644 --- a/service/appmesh/api_op_ListMeshes.go +++ b/service/appmesh/api_op_ListMeshes.go @@ -41,7 +41,9 @@ type ListMeshesInput struct { // The nextToken value returned from a previous paginated ListMeshes 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. This token should be treated as an opaque identifier that is used only to + // 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 diff --git a/service/appmesh/api_op_ListRoutes.go b/service/appmesh/api_op_ListRoutes.go index 5ef3d820ff3..1ec8fb9d150 100644 --- a/service/appmesh/api_op_ListRoutes.go +++ b/service/appmesh/api_op_ListRoutes.go @@ -50,9 +50,9 @@ type ListRoutesInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 diff --git a/service/appmesh/api_op_ListVirtualGateways.go b/service/appmesh/api_op_ListVirtualGateways.go index 42bafe1f944..73e80585475 100644 --- a/service/appmesh/api_op_ListVirtualGateways.go +++ b/service/appmesh/api_op_ListVirtualGateways.go @@ -45,9 +45,9 @@ type ListVirtualGatewaysInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 diff --git a/service/appmesh/api_op_ListVirtualNodes.go b/service/appmesh/api_op_ListVirtualNodes.go index b4ef4f7d0e2..d200a2488ca 100644 --- a/service/appmesh/api_op_ListVirtualNodes.go +++ b/service/appmesh/api_op_ListVirtualNodes.go @@ -45,9 +45,9 @@ type ListVirtualNodesInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 diff --git a/service/appmesh/api_op_ListVirtualRouters.go b/service/appmesh/api_op_ListVirtualRouters.go index 049d71f790a..bd1d84cdfc7 100644 --- a/service/appmesh/api_op_ListVirtualRouters.go +++ b/service/appmesh/api_op_ListVirtualRouters.go @@ -45,9 +45,9 @@ type ListVirtualRoutersInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 diff --git a/service/appmesh/api_op_ListVirtualServices.go b/service/appmesh/api_op_ListVirtualServices.go index 67c33f768ad..f6a5ebf535b 100644 --- a/service/appmesh/api_op_ListVirtualServices.go +++ b/service/appmesh/api_op_ListVirtualServices.go @@ -45,9 +45,9 @@ type ListVirtualServicesInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 diff --git a/service/appmesh/api_op_UpdateGatewayRoute.go b/service/appmesh/api_op_UpdateGatewayRoute.go index d65f1757a28..7e48d1fc093 100644 --- a/service/appmesh/api_op_UpdateGatewayRoute.go +++ b/service/appmesh/api_op_UpdateGatewayRoute.go @@ -56,9 +56,9 @@ type UpdateGatewayRouteInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 95b2343bd3e..5616c9f142f 100644 --- a/service/appmesh/api_op_UpdateRoute.go +++ b/service/appmesh/api_op_UpdateRoute.go @@ -55,9 +55,9 @@ type UpdateRouteInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 0b321be8636..1637b56c1ef 100644 --- a/service/appmesh/api_op_UpdateVirtualGateway.go +++ b/service/appmesh/api_op_UpdateVirtualGateway.go @@ -51,9 +51,9 @@ type UpdateVirtualGatewayInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 c59567b6585..1ad8270f8d4 100644 --- a/service/appmesh/api_op_UpdateVirtualNode.go +++ b/service/appmesh/api_op_UpdateVirtualNode.go @@ -50,9 +50,9 @@ type UpdateVirtualNodeInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 2bdab84f370..a4d30b85c44 100644 --- a/service/appmesh/api_op_UpdateVirtualRouter.go +++ b/service/appmesh/api_op_UpdateVirtualRouter.go @@ -51,9 +51,9 @@ type UpdateVirtualRouterInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 f9f70636e08..c9f6b4aff80 100644 --- a/service/appmesh/api_op_UpdateVirtualService.go +++ b/service/appmesh/api_op_UpdateVirtualService.go @@ -51,9 +51,9 @@ type UpdateVirtualServiceInput struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [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 2917689c601..42e80fdc3a4 100644 --- a/service/appmesh/doc.go +++ b/service/appmesh/doc.go @@ -6,13 +6,19 @@ // 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 // communicate, giving you end-to-end visibility and helping to ensure high -// availability for your applications. App Mesh gives you consistent visibility and -// network traffic controls for every microservice in an application. You can use -// 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. +// availability for your applications. +// +// App Mesh gives you consistent visibility and network traffic controls for every +// microservice in an application. You can use 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]in the Amazon Elastic Container Service Developer Guide. Kubernetes +// kube-dns and coredns are supported. For more information, see [DNS for Services and Pods] in the +// Kubernetes documentation. +// +// [Service Discovery]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html +// [DNS for Services and Pods]: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ package appmesh diff --git a/service/appmesh/options.go b/service/appmesh/options.go index 1cab890736d..8061d081ce7 100644 --- a/service/appmesh/options.go +++ b/service/appmesh/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appmesh/types/enums.go b/service/appmesh/types/enums.go index b94f71072c0..5cc92b8b9be 100644 --- a/service/appmesh/types/enums.go +++ b/service/appmesh/types/enums.go @@ -12,6 +12,7 @@ const ( // Values returns all known values for DefaultGatewayRouteRewrite. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DefaultGatewayRouteRewrite) Values() []DefaultGatewayRouteRewrite { return []DefaultGatewayRouteRewrite{ @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for DnsResponseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DnsResponseType) Values() []DnsResponseType { return []DnsResponseType{ "LOADBALANCER", @@ -47,8 +49,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -65,8 +68,9 @@ const ( ) // Values returns all known values for EgressFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EgressFilterType) Values() []EgressFilterType { return []EgressFilterType{ "ALLOW_ALL", @@ -84,8 +88,9 @@ const ( ) // Values returns all known values for GatewayRouteStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayRouteStatusCode) Values() []GatewayRouteStatusCode { return []GatewayRouteStatusCode{ "ACTIVE", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for GrpcRetryPolicyEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GrpcRetryPolicyEvent) Values() []GrpcRetryPolicyEvent { return []GrpcRetryPolicyEvent{ "cancelled", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for HttpMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpMethod) Values() []HttpMethod { return []HttpMethod{ "GET", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for HttpScheme. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpScheme) Values() []HttpScheme { return []HttpScheme{ "http", @@ -179,8 +187,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -200,8 +209,9 @@ const ( ) // Values returns all known values for ListenerTlsMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListenerTlsMode) Values() []ListenerTlsMode { return []ListenerTlsMode{ "STRICT", @@ -220,8 +230,9 @@ const ( ) // Values returns all known values for MeshStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MeshStatusCode) Values() []MeshStatusCode { return []MeshStatusCode{ "ACTIVE", @@ -241,8 +252,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -262,8 +274,9 @@ const ( ) // Values returns all known values for RouteStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteStatusCode) Values() []RouteStatusCode { return []RouteStatusCode{ "ACTIVE", @@ -280,8 +293,9 @@ const ( ) // Values returns all known values for TcpRetryPolicyEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TcpRetryPolicyEvent) Values() []TcpRetryPolicyEvent { return []TcpRetryPolicyEvent{ "connection-error", @@ -299,8 +313,9 @@ const ( // Values returns all known values for VirtualGatewayListenerTlsMode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualGatewayListenerTlsMode) Values() []VirtualGatewayListenerTlsMode { return []VirtualGatewayListenerTlsMode{ "STRICT", @@ -320,6 +335,7 @@ const ( // Values returns all known values for VirtualGatewayPortProtocol. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VirtualGatewayPortProtocol) Values() []VirtualGatewayPortProtocol { return []VirtualGatewayPortProtocol{ @@ -340,6 +356,7 @@ const ( // 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{ @@ -359,8 +376,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -379,8 +397,9 @@ const ( ) // Values returns all known values for VirtualRouterStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualRouterStatusCode) Values() []VirtualRouterStatusCode { return []VirtualRouterStatusCode{ "ACTIVE", @@ -400,6 +419,7 @@ const ( // 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{ diff --git a/service/appmesh/types/errors.go b/service/appmesh/types/errors.go index 865ce200197..2335b6bd626 100644 --- a/service/appmesh/types/errors.go +++ b/service/appmesh/types/errors.go @@ -114,9 +114,10 @@ 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) +// You have exceeded a service limit for your account. For more information, see [Service Limits] // in the App Mesh User Guide. +// +// [Service Limits]: https://docs.aws.amazon.com/app-mesh/latest/userguide/service-quotas.html type LimitExceededException struct { Message *string diff --git a/service/appmesh/types/types.go b/service/appmesh/types/types.go index f6ab1db4a0c..af2137fd0db 100644 --- a/service/appmesh/types/types.go +++ b/service/appmesh/types/types.go @@ -26,7 +26,9 @@ type AccessLogMemberFile struct { func (*AccessLogMemberFile) isAccessLog() {} // An object that represents the Cloud Map attribute information for your virtual -// node. Cloud Map is not available in the eu-south-1 Region. +// node. +// +// Cloud Map is not available in the eu-south-1 Region. type AwsCloudMapInstanceAttribute struct { // The name of an Cloud Map service instance attribute key. Any Cloud Map service @@ -45,7 +47,9 @@ type AwsCloudMapInstanceAttribute struct { } // An object that represents the Cloud Map service discovery information for your -// virtual node. Cloud Map is not available in the eu-south-1 Region. +// virtual node. +// +// Cloud Map is not available in the eu-south-1 Region. type AwsCloudMapServiceDiscovery struct { // The name of the Cloud Map namespace to use. @@ -143,8 +147,9 @@ 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)]. +// +// [Transport Layer Security (TLS)]: https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html type ClientTlsCertificateMemberFile struct { Value ListenerTlsFileCertificate @@ -217,9 +222,10 @@ type FileAccessLog struct { // 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 // 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 - // bootstrap properly. + // 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 bootstrap properly. // // This member is required. Path *string @@ -318,18 +324,18 @@ type GatewayRouteRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -543,8 +549,9 @@ func (*GrpcMetadataMatchMethodMemberSuffix) isGrpcMetadataMatchMethod() {} // 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]. +// +// [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. @@ -561,10 +568,14 @@ 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 HttpRetryEvents []string @@ -797,8 +808,9 @@ type HealthCheckPolicy struct { 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) - // . + // service must conform to the [GRPC Health Checking Protocol]. + // + // [GRPC Health Checking Protocol]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md // // This member is required. Protocol PortProtocol @@ -821,7 +833,7 @@ type HealthCheckPolicy struct { Path *string // The destination port for the health check request. This port must match the - // port defined in the PortMapping for the listener. + // port defined in the PortMappingfor the listener. Port *int32 noSmithyDocumentSerde @@ -974,8 +986,9 @@ type HttpQueryParameter struct { // 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]. +// +// [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. @@ -989,10 +1002,14 @@ 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 HttpRetryEvents []string @@ -1209,8 +1226,11 @@ 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. // // This member is required. @@ -1228,8 +1248,9 @@ 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)]. + // + // [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 @@ -1279,8 +1300,9 @@ 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)]. +// +// [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. @@ -1299,8 +1321,9 @@ 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]for more info. +// +// [TLS documentation]: https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html type ListenerTlsSdsCertificate struct { // A reference to an object that represents the name of the secret requested from @@ -1465,18 +1488,18 @@ type MeshRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -1592,18 +1615,18 @@ type ResourceMetadata struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -1683,18 +1706,18 @@ type RouteRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -1922,8 +1945,9 @@ 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]for more info. +// +// [TLS documentation]: https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html type TlsValidationContextSdsTrust struct { // A reference to an object that represents the name of the secret for a Transport @@ -2049,8 +2073,9 @@ 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)]. +// +// [Transport Layer Security (TLS)]: https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html type VirtualGatewayClientTlsCertificateMemberFile struct { Value VirtualGatewayListenerTlsFileCertificate @@ -2069,10 +2094,12 @@ type VirtualGatewayClientTlsCertificateMemberSds struct { func (*VirtualGatewayClientTlsCertificateMemberSds) isVirtualGatewayClientTlsCertificate() {} -// 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 . +// 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 . // // The following types satisfy this interface: // @@ -2188,8 +2215,9 @@ type VirtualGatewayHealthCheckPolicy struct { 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) - // . + // service must conform to the [GRPC Health Checking Protocol]. + // + // [GRPC Health Checking Protocol]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md // // This member is required. Protocol VirtualGatewayPortProtocol @@ -2212,7 +2240,7 @@ type VirtualGatewayHealthCheckPolicy struct { Path *string // The destination port for the health check request. This port must match the - // port defined in the PortMapping for the listener. + // port defined in the PortMappingfor the listener. Port *int32 noSmithyDocumentSerde @@ -2277,8 +2305,11 @@ 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. // // This member is required. @@ -2296,8 +2327,9 @@ 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)]. + // + // [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 @@ -2347,8 +2379,9 @@ 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)]. +// +// [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. @@ -2367,8 +2400,9 @@ 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 Mesh TLS documentation (https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html) -// for more info. +// Unix Domain Socket. See App Mesh[TLS documentation] for more info. +// +// [TLS documentation]: https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html type VirtualGatewayListenerTlsSdsCertificate struct { // A reference to an object that represents the name of the secret secret @@ -2482,18 +2516,18 @@ type VirtualGatewayRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -2584,9 +2618,10 @@ 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) +// be configured with a local SDS provider via a Unix Domain Socket. See App Mesh [TLS documentation] // for more info. +// +// [TLS documentation]: https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html type VirtualGatewayTlsValidationContextSdsTrust struct { // A reference to an object that represents the name of the secret for a virtual @@ -2644,10 +2679,12 @@ type VirtualGatewayTlsValidationContextTrustMemberSds struct { func (*VirtualGatewayTlsValidationContextTrustMemberSds) isVirtualGatewayTlsValidationContextTrust() { } -// 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 . +// 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 . // // The following types satisfy this interface: // @@ -2791,18 +2828,18 @@ type VirtualNodeRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -2946,18 +2983,18 @@ type VirtualRouterRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. ResourceOwner *string @@ -3106,18 +3143,18 @@ type VirtualServiceRef struct { // 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) - // . + // with your account. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working with shared meshes]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html // // This member is required. MeshOwner *string // 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) - // . + // the mesh is shared with. For more information about mesh sharing, see [Working with shared meshes]. + // + // [Working 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_op_AssociateCustomDomain.go b/service/apprunner/api_op_AssociateCustomDomain.go index 1e84abcd37f..92a3bf72d3d 100644 --- a/service/apprunner/api_op_AssociateCustomDomain.go +++ b/service/apprunner/api_op_AssociateCustomDomain.go @@ -12,14 +12,16 @@ import ( ) // Associate your own domain name with the App Runner subdomain URL of your App -// Runner service. After you call AssociateCustomDomain and receive a successful -// response, use the information in the CustomDomain record that's returned to add -// CNAME records to your Domain Name System (DNS). For each mapped domain name, add -// 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) -// . +// Runner service. +// +// After you call AssociateCustomDomain and receive a successful response, use the +// information in the CustomDomainrecord that's returned to add CNAME records to your Domain +// Name System (DNS). For each mapped domain name, add 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)]. +// +// [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{} @@ -51,7 +53,9 @@ type AssociateCustomDomainInput struct { ServiceArn *string // Set to true to associate the subdomain www.DomainName with the App Runner - // service in addition to the base domain. Default: true + // service in addition to the base domain. + // + // Default: true EnableWWWSubdomain *bool noSmithyDocumentSerde diff --git a/service/apprunner/api_op_CreateAutoScalingConfiguration.go b/service/apprunner/api_op_CreateAutoScalingConfiguration.go index e56e0593b93..b6658f91979 100644 --- a/service/apprunner/api_op_CreateAutoScalingConfiguration.go +++ b/service/apprunner/api_op_CreateAutoScalingConfiguration.go @@ -14,17 +14,21 @@ import ( // Create an App Runner automatic scaling configuration resource. App Runner // requires this resource when you create or update App Runner services and you // 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 +// configuration across multiple services. +// +// Create multiple revisions of a configuration by calling this action multiple +// times using the same 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 -// configure the service to use a specific revision. Configure a higher MinSize to -// increase the spread of your App Runner service over more Availability Zones in -// the Amazon Web Services Region. The tradeoff is a higher minimal cost. Configure -// a lower MaxSize to control your cost. The tradeoff is lower responsiveness -// during peak demand. +// configure the service to use a specific revision. +// +// Configure a higher MinSize to increase the spread of your App Runner service +// over more Availability Zones in the Amazon Web Services Region. The tradeoff is +// a higher minimal cost. +// +// Configure a lower MaxSize to control your cost. The tradeoff is lower +// responsiveness during peak demand. func (c *Client) CreateAutoScalingConfiguration(ctx context.Context, params *CreateAutoScalingConfigurationInput, optFns ...func(*Options)) (*CreateAutoScalingConfigurationOutput, error) { if params == nil { params = &CreateAutoScalingConfigurationInput{} @@ -45,31 +49,42 @@ 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 // name. When you use the same name in subsequent calls, App Runner creates - // incremental revisions of the configuration. Prior to the release of Auto scale - // configuration enhancements (https://docs.aws.amazon.com/apprunner/latest/relnotes/release-2023-09-22-auto-scale-config.html) - // , the name DefaultConfiguration was reserved. This restriction is no longer in - // place. You can now manage DefaultConfiguration the same way you manage your - // custom auto scaling configurations. This means you can do the following with the - // DefaultConfiguration that App Runner provides: + // incremental revisions of the configuration. + // + // Prior to the release of [Auto scale configuration enhancements], the name DefaultConfiguration was reserved. + // + // This restriction is no longer in place. You can now manage DefaultConfiguration + // the same way you manage your custom auto scaling configurations. This means you + // can do the following with the DefaultConfiguration that App Runner provides: + // // - Create new revisions of the DefaultConfiguration . + // // - Delete the revisions of the DefaultConfiguration . + // // - Delete the auto scaling configuration for which the App Runner // DefaultConfiguration was created. + // // - If you delete the auto scaling configuration you can create another custom // auto scaling configuration with the same DefaultConfiguration name. The // original DefaultConfiguration resource provided by App Runner remains in your // account unless you make changes to it. // + // [Auto scale configuration enhancements]: https://docs.aws.amazon.com/apprunner/latest/relnotes/release-2023-09-22-auto-scale-config.html + // // This member is required. AutoScalingConfigurationName *string // The maximum number of concurrent requests that you want an instance to process. // If the number of concurrent requests exceeds this limit, App Runner scales up - // your service. Default: 100 + // your service. + // + // Default: 100 MaxConcurrency *int32 // The maximum number of instances that your service scales up to. At most MaxSize - // instances actively serve traffic for your service. Default: 25 + // instances actively serve traffic for your service. + // + // Default: 25 MaxSize *int32 // The minimum number of instances that App Runner provisions for your service. @@ -77,9 +92,12 @@ type CreateAutoScalingConfigurationInput struct { // 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 + // 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 b99db57f58f..8bafcf79150 100644 --- a/service/apprunner/api_op_CreateConnection.go +++ b/service/apprunner/api_op_CreateConnection.go @@ -14,9 +14,11 @@ import ( // Create an App Runner connection resource. App Runner requires a connection // resource when you create App Runner services that access private repositories // from certain third-party providers. You can share a connection across multiple -// services. A connection resource is needed to access GitHub and Bitbucket -// repositories. Both require a user interface approval process through the App -// Runner console before you can use the connection. +// services. +// +// A connection resource is needed to access GitHub and Bitbucket repositories. +// Both require a user interface approval process through the App Runner console +// before you can use the connection. func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionInput, optFns ...func(*Options)) (*CreateConnectionOutput, error) { if params == nil { params = &CreateConnectionInput{} diff --git a/service/apprunner/api_op_CreateObservabilityConfiguration.go b/service/apprunner/api_op_CreateObservabilityConfiguration.go index 3b13b97d614..3666273feb6 100644 --- a/service/apprunner/api_op_CreateObservabilityConfiguration.go +++ b/service/apprunner/api_op_CreateObservabilityConfiguration.go @@ -14,17 +14,20 @@ import ( // Create an App Runner observability configuration resource. App Runner requires // this resource when you create or update App Runner services and you want to // 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 -// 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 ). -// If you don't specify a feature parameter, App Runner doesn't enable the feature. +// configuration across multiple services. +// +// Create multiple revisions of a configuration by calling this action multiple +// times using the same 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 ). 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 { params = &CreateObservabilityConfigurationInput{} @@ -45,11 +48,14 @@ type CreateObservabilityConfigurationInput struct { // A name for the observability 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. You can't use it to create a new observability configuration, and you - // can't create a revision of it. When you want to use your own observability - // configuration for your App Runner service, create a configuration with a - // different name, and then provide it when you create or update your service. + // incremental revisions of the configuration. + // + // The name DefaultConfiguration is reserved. You can't use it to create a new + // observability configuration, and you can't create a revision of it. + // + // When you want to use your own observability configuration for your App Runner + // service, create a configuration with a different name, and then provide it when + // you create or update your service. // // This member is required. ObservabilityConfigurationName *string diff --git a/service/apprunner/api_op_CreateService.go b/service/apprunner/api_op_CreateService.go index c036dd40b95..08bcd1a6177 100644 --- a/service/apprunner/api_op_CreateService.go +++ b/service/apprunner/api_op_CreateService.go @@ -12,9 +12,12 @@ 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. +// automatically starts a deployment. +// +// 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. +// +// [ListOperations]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -48,9 +51,11 @@ type CreateServiceInput struct { // The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration // resource that you want to associate with your service. If not provided, App // Runner associates the latest revision of a default auto scaling configuration. - // Specify an ARN with a name and a revision number to associate that revision. For - // example: + // + // Specify an ARN with a name and a revision number to associate that revision. + // For example: // arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3 + // // Specify just the name to associate the latest revision. For example: // arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability AutoScalingConfigurationArn *string @@ -84,8 +89,9 @@ 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]call to track the operation's progress. + // + // [ListOperations]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html // // This member is required. OperationId *string diff --git a/service/apprunner/api_op_CreateVpcConnector.go b/service/apprunner/api_op_CreateVpcConnector.go index 456f5669b66..36a2ac852fd 100644 --- a/service/apprunner/api_op_CreateVpcConnector.go +++ b/service/apprunner/api_op_CreateVpcConnector.go @@ -33,8 +33,9 @@ type CreateVpcConnectorInput struct { // A list of IDs of subnets that App Runner should use when it associates your // service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. - // App Runner determines the Amazon VPC from the subnets you specify. App Runner - // currently only provides support for IPv4. + // App Runner determines the Amazon VPC from the subnets you specify. + // + // App Runner currently only provides support for IPv4. // // This member is required. Subnets []string diff --git a/service/apprunner/api_op_DeleteAutoScalingConfiguration.go b/service/apprunner/api_op_DeleteAutoScalingConfiguration.go index 15f922d263d..df5d1a8be87 100644 --- a/service/apprunner/api_op_DeleteAutoScalingConfiguration.go +++ b/service/apprunner/api_op_DeleteAutoScalingConfiguration.go @@ -34,17 +34,20 @@ 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. + // 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 // Set to true to delete all of the revisions associated with the - // AutoScalingConfigurationArn parameter value. When DeleteAllRevisions is set to - // true , the only valid value for the Amazon Resource Name (ARN) is a partial ARN - // ending with: .../name . + // AutoScalingConfigurationArn parameter value. + // + // When DeleteAllRevisions is set to true , the only valid value for the Amazon + // Resource Name (ARN) is a partial ARN ending with: .../name . DeleteAllRevisions bool noSmithyDocumentSerde diff --git a/service/apprunner/api_op_DeleteObservabilityConfiguration.go b/service/apprunner/api_op_DeleteObservabilityConfiguration.go index 7275c2dd434..3de8618c1c1 100644 --- a/service/apprunner/api_op_DeleteObservabilityConfiguration.go +++ b/service/apprunner/api_op_DeleteObservabilityConfiguration.go @@ -32,9 +32,11 @@ func (c *Client) DeleteObservabilityConfiguration(ctx context.Context, params *D type DeleteObservabilityConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner observability configuration - // that you want to delete. 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 deleted. + // that you want to delete. + // + // 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 deleted. // // This member is required. ObservabilityConfigurationArn *string diff --git a/service/apprunner/api_op_DeleteService.go b/service/apprunner/api_op_DeleteService.go index 8331cb64cf6..973563e2cbc 100644 --- a/service/apprunner/api_op_DeleteService.go +++ b/service/apprunner/api_op_DeleteService.go @@ -11,10 +11,13 @@ 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 -// VPCIngressConnections associated with the service you want to delete. +// 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 { params = &DeleteServiceInput{} @@ -44,7 +47,7 @@ type DeleteServiceInput struct { type DeleteServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can - // use it combined with the ListOperations call to track the operation's progress. + // use it combined with the ListOperationscall to track the operation's progress. // // This member is required. OperationId *string diff --git a/service/apprunner/api_op_DeleteVpcConnector.go b/service/apprunner/api_op_DeleteVpcConnector.go index 0847de920f9..051c1a547c1 100644 --- a/service/apprunner/api_op_DeleteVpcConnector.go +++ b/service/apprunner/api_op_DeleteVpcConnector.go @@ -31,7 +31,9 @@ func (c *Client) DeleteVpcConnector(ctx context.Context, params *DeleteVpcConnec type DeleteVpcConnectorInput struct { // The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to - // delete. The ARN must be a full VPC connector ARN. + // delete. + // + // The ARN must be a full VPC connector ARN. // // This member is required. VpcConnectorArn *string diff --git a/service/apprunner/api_op_DeleteVpcIngressConnection.go b/service/apprunner/api_op_DeleteVpcIngressConnection.go index 130ac13077c..1b095e7087f 100644 --- a/service/apprunner/api_op_DeleteVpcIngressConnection.go +++ b/service/apprunner/api_op_DeleteVpcIngressConnection.go @@ -14,9 +14,13 @@ 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 func (c *Client) DeleteVpcIngressConnection(ctx context.Context, params *DeleteVpcIngressConnectionInput, optFns ...func(*Options)) (*DeleteVpcIngressConnectionOutput, error) { if params == nil { diff --git a/service/apprunner/api_op_DescribeAutoScalingConfiguration.go b/service/apprunner/api_op_DescribeAutoScalingConfiguration.go index 52a04662886..e3cea7328db 100644 --- a/service/apprunner/api_op_DescribeAutoScalingConfiguration.go +++ b/service/apprunner/api_op_DescribeAutoScalingConfiguration.go @@ -31,10 +31,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. + // 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 1193ea0f58b..390d08a7be2 100644 --- a/service/apprunner/api_op_DescribeCustomDomains.go +++ b/service/apprunner/api_op_DescribeCustomDomains.go @@ -37,14 +37,17 @@ type DescribeCustomDomainsInput struct { 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 - // retrieves all available results in a single response. + // 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. + // identical to the ones that are specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -177,8 +180,10 @@ var _ DescribeCustomDomainsAPIClient = (*Client)(nil) // 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 - // retrieves all available results in a single response. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_DescribeObservabilityConfiguration.go b/service/apprunner/api_op_DescribeObservabilityConfiguration.go index 285bb8e823b..d75d500b19c 100644 --- a/service/apprunner/api_op_DescribeObservabilityConfiguration.go +++ b/service/apprunner/api_op_DescribeObservabilityConfiguration.go @@ -30,10 +30,11 @@ func (c *Client) DescribeObservabilityConfiguration(ctx context.Context, params 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. + // 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. // // This member is required. ObservabilityConfigurationArn *string diff --git a/service/apprunner/api_op_DescribeVpcConnector.go b/service/apprunner/api_op_DescribeVpcConnector.go index 9adc0c23d23..e5016ae647b 100644 --- a/service/apprunner/api_op_DescribeVpcConnector.go +++ b/service/apprunner/api_op_DescribeVpcConnector.go @@ -30,7 +30,9 @@ func (c *Client) DescribeVpcConnector(ctx context.Context, params *DescribeVpcCo type DescribeVpcConnectorInput struct { // The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a - // description for. The ARN must be a full VPC connector ARN. + // description for. + // + // The ARN must be a full VPC connector ARN. // // This member is required. VpcConnectorArn *string diff --git a/service/apprunner/api_op_DisassociateCustomDomain.go b/service/apprunner/api_op_DisassociateCustomDomain.go index e6e359c031d..f49b4e48213 100644 --- a/service/apprunner/api_op_DisassociateCustomDomain.go +++ b/service/apprunner/api_op_DisassociateCustomDomain.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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)]. 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 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 164b2643ae4..66faeb477a1 100644 --- a/service/apprunner/api_op_ListAutoScalingConfigurations.go +++ b/service/apprunner/api_op_ListAutoScalingConfigurations.go @@ -15,8 +15,10 @@ import ( // Amazon Web Services account. You can query the revisions for a specific // 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 . +// name. +// +// To retrieve a full description of a particular configuration revision, 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{} @@ -40,19 +42,25 @@ type ListAutoScalingConfigurationsInput struct { AutoScalingConfigurationName *string // Set to true to list only the latest revision for each requested configuration - // name. Set to false to list all revisions for each requested configuration name. + // name. + // + // Set to false to list all revisions for each requested configuration name. + // // Default: true 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 - // retrieves all available results in a single response. + // 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. + // identical to the ones that are specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -164,8 +172,10 @@ 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListConnections.go b/service/apprunner/api_op_ListConnections.go index fe8f07de95c..95b84d6943f 100644 --- a/service/apprunner/api_op_ListConnections.go +++ b/service/apprunner/api_op_ListConnections.go @@ -35,14 +35,17 @@ 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 - // all available results in a single response. + // 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 - // request retrieves the first result page. + // the ones specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -153,8 +156,10 @@ 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 - // all available results in a single response. + // for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListObservabilityConfigurations.go b/service/apprunner/api_op_ListObservabilityConfigurations.go index c63db359136..0e0b319e1ed 100644 --- a/service/apprunner/api_op_ListObservabilityConfigurations.go +++ b/service/apprunner/api_op_ListObservabilityConfigurations.go @@ -14,9 +14,10 @@ import ( // Returns a list of active App Runner observability configurations in your Amazon // Web Services account. You can query the revisions for a specific 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 ListObservabilityConfigurations . +// 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 . func (c *Client) ListObservabilityConfigurations(ctx context.Context, params *ListObservabilityConfigurationsInput, optFns ...func(*Options)) (*ListObservabilityConfigurationsOutput, error) { if params == nil { params = &ListObservabilityConfigurationsInput{} @@ -35,19 +36,25 @@ func (c *Client) ListObservabilityConfigurations(ctx context.Context, params *Li type ListObservabilityConfigurationsInput struct { // Set to true to list only the latest revision for each requested configuration - // name. Set to false to list all revisions for each requested configuration name. + // name. + // + // Set to false to list all revisions for each requested configuration name. + // // Default: true 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 - // retrieves all available results in a single response. + // 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. + // identical to the ones that are specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string // The name of the App Runner observability configuration that you want to list. @@ -164,8 +171,10 @@ 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListOperations.go b/service/apprunner/api_op_ListOperations.go index 4ed2e77325a..a2bcc45659a 100644 --- a/service/apprunner/api_op_ListOperations.go +++ b/service/apprunner/api_op_ListOperations.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Return a list of operations that occurred on an App Runner service. The -// resulting list of OperationSummary objects is sorted in reverse chronological -// order. The first object on the list represents the last started operation. +// Return a list of operations that occurred on an App Runner service. +// +// The resulting list of OperationSummary objects is sorted in reverse chronological order. The +// first object on the list represents the last started operation. func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput, optFns ...func(*Options)) (*ListOperationsOutput, error) { if params == nil { params = &ListOperationsInput{} @@ -38,14 +39,17 @@ type ListOperationsInput struct { 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 - // retrieves all available results in a single response. + // 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. + // identical to the ones specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -157,8 +161,10 @@ 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListServices.go b/service/apprunner/api_op_ListServices.go index fa410214466..b37f68c96f0 100644 --- a/service/apprunner/api_op_ListServices.go +++ b/service/apprunner/api_op_ListServices.go @@ -31,14 +31,17 @@ 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 - // retrieves all available results in a single response. + // 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 - // request retrieves the first result page. + // the ones specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -148,8 +151,10 @@ 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListServicesForAutoScalingConfiguration.go b/service/apprunner/api_op_ListServicesForAutoScalingConfiguration.go index ba2cf2dca53..66fd3b3701a 100644 --- a/service/apprunner/api_op_ListServicesForAutoScalingConfiguration.go +++ b/service/apprunner/api_op_ListServicesForAutoScalingConfiguration.go @@ -30,23 +30,27 @@ func (c *Client) ListServicesForAutoScalingConfiguration(ctx context.Context, pa type ListServicesForAutoScalingConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration - // that you want to list the services 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 used. + // that you want to list the services 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 used. // // This member is required. AutoScalingConfigurationArn *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 - // retrieves all available results in a single response. + // 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. + // identical to the ones specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -161,8 +165,10 @@ var _ ListServicesForAutoScalingConfigurationAPIClient = (*Client)(nil) // options for ListServicesForAutoScalingConfiguration type ListServicesForAutoScalingConfigurationPaginatorOptions 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListTagsForResource.go b/service/apprunner/api_op_ListTagsForResource.go index e2ca7e75105..ef5d0dc55b4 100644 --- a/service/apprunner/api_op_ListTagsForResource.go +++ b/service/apprunner/api_op_ListTagsForResource.go @@ -30,8 +30,9 @@ 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 6ea326fe08e..b1387145eae 100644 --- a/service/apprunner/api_op_ListVpcConnectors.go +++ b/service/apprunner/api_op_ListVpcConnectors.go @@ -30,14 +30,17 @@ 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 - // retrieves all available results in a single response. + // 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. + // identical to the ones that are specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -148,8 +151,10 @@ 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_ListVpcIngressConnections.go b/service/apprunner/api_op_ListVpcIngressConnections.go index 495cee0e422..56f2a34cafa 100644 --- a/service/apprunner/api_op_ListVpcIngressConnections.go +++ b/service/apprunner/api_op_ListVpcIngressConnections.go @@ -35,14 +35,17 @@ 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 - // retrieves all available results in a single response. + // 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. + // identical to the ones that are specified in the initial request. + // + // If you don't specify NextToken , the request retrieves the first result page. NextToken *string noSmithyDocumentSerde @@ -154,8 +157,10 @@ 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 - // retrieves all available results in a single response. + // used for a paginated request. + // + // If you don't specify MaxResults , the request retrieves all available results in + // a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/apprunner/api_op_PauseService.go b/service/apprunner/api_op_PauseService.go index 0b553d4477b..eca23c95910 100644 --- a/service/apprunner/api_op_PauseService.go +++ b/service/apprunner/api_op_PauseService.go @@ -13,9 +13,9 @@ import ( // Pause an active App Runner service. App Runner reduces compute capacity for the // service to zero and loses state (for example, ephemeral storage is removed). +// // 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. +// returned OperationId and the ListOperations call to track the operation's progress. func (c *Client) PauseService(ctx context.Context, params *PauseServiceInput, optFns ...func(*Options)) (*PauseServiceOutput, error) { if params == nil { params = &PauseServiceInput{} @@ -49,7 +49,7 @@ type PauseServiceOutput struct { Service *types.Service // The unique ID of the asynchronous operation that this request started. You can - // use it combined with the ListOperations call to track the operation's progress. + // use it combined with the ListOperationscall to track the operation's progress. OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/apprunner/api_op_ResumeService.go b/service/apprunner/api_op_ResumeService.go index 72d222f272f..111818bb4e6 100644 --- a/service/apprunner/api_op_ResumeService.go +++ b/service/apprunner/api_op_ResumeService.go @@ -12,9 +12,10 @@ import ( ) // Resume an active App Runner service. App Runner provisions compute capacity for -// the 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. +// the 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. func (c *Client) ResumeService(ctx context.Context, params *ResumeServiceInput, optFns ...func(*Options)) (*ResumeServiceOutput, error) { if params == nil { params = &ResumeServiceInput{} @@ -49,7 +50,7 @@ type ResumeServiceOutput struct { Service *types.Service // The unique ID of the asynchronous operation that this request started. You can - // use it combined with the ListOperations call to track the operation's progress. + // use it combined with the ListOperationscall to track the operation's progress. OperationId *string // Metadata pertaining to the operation's result. diff --git a/service/apprunner/api_op_StartDeployment.go b/service/apprunner/api_op_StartDeployment.go index 1e02a55c106..841a36ea536 100644 --- a/service/apprunner/api_op_StartDeployment.go +++ b/service/apprunner/api_op_StartDeployment.go @@ -11,13 +11,15 @@ import ( ) // 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 -// starts a new container instance. 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. +// 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 starts a new container instance. +// +// 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) StartDeployment(ctx context.Context, params *StartDeploymentInput, optFns ...func(*Options)) (*StartDeploymentOutput, error) { if params == nil { params = &StartDeploymentInput{} @@ -47,7 +49,7 @@ type StartDeploymentInput struct { type StartDeploymentOutput struct { // The unique ID of the asynchronous operation that this request started. You can - // use it combined with the ListOperations call to track the operation's progress. + // use it combined with the ListOperationscall to track the operation's progress. // // This member is required. OperationId *string diff --git a/service/apprunner/api_op_TagResource.go b/service/apprunner/api_op_TagResource.go index a60f6a58ae7..c256ded9f10 100644 --- a/service/apprunner/api_op_TagResource.go +++ b/service/apprunner/api_op_TagResource.go @@ -30,8 +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 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 diff --git a/service/apprunner/api_op_UntagResource.go b/service/apprunner/api_op_UntagResource.go index 96de2baf4a6..296b5cd6ce0 100644 --- a/service/apprunner/api_op_UntagResource.go +++ b/service/apprunner/api_op_UntagResource.go @@ -29,7 +29,9 @@ 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. It must be the ARN of an App Runner resource. + // from. + // + // It must be the ARN of an App Runner resource. // // This member is required. ResourceArn *string diff --git a/service/apprunner/api_op_UpdateDefaultAutoScalingConfiguration.go b/service/apprunner/api_op_UpdateDefaultAutoScalingConfiguration.go index 7ed64ef18bb..4df9b022c3d 100644 --- a/service/apprunner/api_op_UpdateDefaultAutoScalingConfiguration.go +++ b/service/apprunner/api_op_UpdateDefaultAutoScalingConfiguration.go @@ -31,10 +31,11 @@ func (c *Client) UpdateDefaultAutoScalingConfiguration(ctx context.Context, para type UpdateDefaultAutoScalingConfigurationInput struct { // The Amazon Resource Name (ARN) of the App Runner auto scaling configuration - // that you want to set as the default. 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 set as the default. + // that you want to set as the default. + // + // 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 set as the default. // // This member is required. AutoScalingConfigurationArn *string diff --git a/service/apprunner/api_op_UpdateService.go b/service/apprunner/api_op_UpdateService.go index eefdb705cd1..50e002d90a9 100644 --- a/service/apprunner/api_op_UpdateService.go +++ b/service/apprunner/api_op_UpdateService.go @@ -15,10 +15,12 @@ import ( // instance configuration of the service. You can also update the ARN of the auto // 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 -// asynchronous operation. On a successful call, you can use the returned -// OperationId and the ListOperations call to track the operation's progress. +// 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 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) { if params == nil { params = &UpdateServiceInput{} @@ -60,13 +62,15 @@ type UpdateServiceInput struct { // The observability configuration of your service. ObservabilityConfiguration *types.ServiceObservabilityConfiguration - // The source configuration to apply to the App Runner service. You can change the - // configuration of the code or image repository that the service uses. However, - // 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, - // set the values to members of the structure that you include. + // The source configuration to apply to the App Runner service. + // + // You can change the configuration of the code or image repository that the + // service uses. However, 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, set the values to members of the structure that + // you include. SourceConfiguration *types.SourceConfiguration noSmithyDocumentSerde @@ -75,7 +79,7 @@ type UpdateServiceInput struct { type UpdateServiceOutput struct { // The unique ID of the asynchronous operation that this request started. You can - // use it combined with the ListOperations call to track the operation's progress. + // use it combined with the ListOperationscall to track the operation's progress. // // This member is required. OperationId *string diff --git a/service/apprunner/api_op_UpdateVpcIngressConnection.go b/service/apprunner/api_op_UpdateVpcIngressConnection.go index 9df78c43c11..6d254a0740f 100644 --- a/service/apprunner/api_op_UpdateVpcIngressConnection.go +++ b/service/apprunner/api_op_UpdateVpcIngressConnection.go @@ -13,8 +13,11 @@ 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 func (c *Client) UpdateVpcIngressConnection(ctx context.Context, params *UpdateVpcIngressConnectionInput, optFns ...func(*Options)) (*UpdateVpcIngressConnectionOutput, error) { if params == nil { diff --git a/service/apprunner/doc.go b/service/apprunner/doc.go index 84d46f9a765..af4bbcae782 100644 --- a/service/apprunner/doc.go +++ b/service/apprunner/doc.go @@ -3,20 +3,32 @@ // Package apprunner provides the API client, operations, and parameter types for // AWS App Runner. // -// App Runner App Runner is an application service that provides a fast, simple, -// and cost-effective way to go directly from an existing container image or source +// # App Runner +// +// App Runner is an application service that provides a fast, simple, and +// cost-effective way to go directly from an existing container image or source // code to a running service in the Amazon Web Services Cloud in seconds. You don't // need to learn new technologies, decide which compute service to use, or -// understand how to provision and configure Amazon Web Services resources. App -// 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 +// understand how to provision and configure Amazon Web Services resources. +// +// App 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]. For release information, see +// the [App Runner Release Notes]. +// +// 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. +// the API, see [Tools for Amazon Web Services]. +// +// # Endpoints +// +// For a list of Region-specific endpoints that App Runner supports, see [App Runner endpoints and quotas] in the +// Amazon Web Services General Reference. +// +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [App Runner Developer Guide]: https://docs.aws.amazon.com/apprunner/latest/dg/ +// [App Runner Release Notes]: https://docs.aws.amazon.com/apprunner/latest/relnotes/ +// [App Runner endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/apprunner.html package apprunner diff --git a/service/apprunner/options.go b/service/apprunner/options.go index dbab338d6df..842fa541c5d 100644 --- a/service/apprunner/options.go +++ b/service/apprunner/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/apprunner/types/enums.go b/service/apprunner/types/enums.go index d7ab810c9e8..a79a8f61143 100644 --- a/service/apprunner/types/enums.go +++ b/service/apprunner/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for AutoScalingConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingConfigurationStatus) Values() []AutoScalingConfigurationStatus { return []AutoScalingConfigurationStatus{ "ACTIVE", @@ -32,8 +33,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateValidationRecordStatus) Values() []CertificateValidationRecordStatus { return []CertificateValidationRecordStatus{ "PENDING_VALIDATION", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for ConfigurationSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationSource) Values() []ConfigurationSource { return []ConfigurationSource{ "REPOSITORY", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "PENDING_HANDSHAKE", @@ -97,8 +101,9 @@ const ( // Values returns all known values for CustomDomainAssociationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomDomainAssociationStatus) Values() []CustomDomainAssociationStatus { return []CustomDomainAssociationStatus{ "CREATING", @@ -120,8 +125,9 @@ const ( ) // Values returns all known values for EgressType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EgressType) Values() []EgressType { return []EgressType{ "DEFAULT", @@ -138,8 +144,9 @@ const ( ) // Values returns all known values for HealthCheckProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthCheckProtocol) Values() []HealthCheckProtocol { return []HealthCheckProtocol{ "TCP", @@ -156,8 +163,9 @@ const ( ) // Values returns all known values for ImageRepositoryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageRepositoryType) Values() []ImageRepositoryType { return []ImageRepositoryType{ "ECR", @@ -174,8 +182,9 @@ const ( ) // Values returns all known values for IpAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressType) Values() []IpAddressType { return []IpAddressType{ "IPV4", @@ -193,8 +202,9 @@ const ( // Values returns all known values for ObservabilityConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObservabilityConfigurationStatus) Values() []ObservabilityConfigurationStatus { return []ObservabilityConfigurationStatus{ "ACTIVE", @@ -216,8 +226,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "PENDING", @@ -243,8 +254,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "START_DEPLOYMENT", @@ -265,8 +277,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -293,8 +306,9 @@ const ( ) // Values returns all known values for Runtime. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Runtime) Values() []Runtime { return []Runtime{ "PYTHON_3", @@ -325,8 +339,9 @@ const ( ) // Values returns all known values for ServiceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceStatus) Values() []ServiceStatus { return []ServiceStatus{ "CREATE_FAILED", @@ -346,8 +361,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "BRANCH", @@ -362,8 +378,9 @@ const ( ) // Values returns all known values for TracingVendor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TracingVendor) Values() []TracingVendor { return []TracingVendor{ "AWSXRAY", @@ -379,8 +396,9 @@ const ( ) // Values returns all known values for VpcConnectorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcConnectorStatus) Values() []VpcConnectorStatus { return []VpcConnectorStatus{ "ACTIVE", @@ -404,6 +422,7 @@ const ( // Values returns all known values for VpcIngressConnectionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VpcIngressConnectionStatus) Values() []VpcIngressConnectionStatus { return []VpcIngressConnectionStatus{ diff --git a/service/apprunner/types/errors.go b/service/apprunner/types/errors.go index 04db49b2fec..863c4d3b7ef 100644 --- a/service/apprunner/types/errors.go +++ b/service/apprunner/types/errors.go @@ -114,9 +114,12 @@ 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] in the Amazon Web Services General +// Reference. +// +// [App Runner endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/apprunner.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/apprunner/types/types.go b/service/apprunner/types/types.go index b34977b14ac..dbc19e738a7 100644 --- a/service/apprunner/types/types.go +++ b/service/apprunner/types/types.go @@ -24,11 +24,16 @@ type AuthenticationConfiguration struct { noSmithyDocumentSerde } -// Describes an App Runner automatic scaling configuration resource. A higher -// MinSize increases the spread of your App Runner service over more Availability -// Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost. +// Describes an App Runner automatic scaling configuration resource. +// +// A higher MinSize increases the spread of your App Runner service over more +// Availability Zones in the Amazon Web Services Region. The tradeoff is a higher +// minimal cost. +// // A lower MaxSize controls your cost. The tradeoff is lower responsiveness during -// peak demand. Multiple revisions of a configuration might have the same +// peak demand. +// +// Multiple revisions of a configuration might have the same // AutoScalingConfigurationName and different AutoScalingConfigurationRevision // values. type AutoScalingConfiguration struct { @@ -84,9 +89,10 @@ type AutoScalingConfiguration struct { // 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. + // 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 @@ -99,12 +105,12 @@ type AutoScalingConfiguration struct { } // 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 -// DeleteAutoScalingConfiguration actions using the AutoScalingConfiguration type. +// 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 ListAutoScalingConfigurationsaction. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration +// , and DeleteAutoScalingConfigurationactions using the AutoScalingConfiguration type. type AutoScalingConfigurationSummary struct { // The Amazon Resource Name (ARN) of this auto scaling configuration. @@ -145,8 +151,9 @@ type AutoScalingConfigurationSummary struct { } // 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]. +// +// [AssociateCustomDomain]: https://docs.aws.amazon.com/apprunner/latest/api/API_AssociateCustomDomain.html type CertificateValidationRecord struct { // The certificate CNAME record name. @@ -170,8 +177,10 @@ type CertificateValidationRecord struct { 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. @@ -202,7 +211,9 @@ type CodeConfigurationValues struct { // The command App Runner runs to build your application. BuildCommand *string - // The port that your application listens to in the container. Default: 8080 + // The port that your application listens to in the container. + // + // Default: 8080 Port *string // An array of key-value pairs representing the secrets and parameters that get @@ -210,10 +221,12 @@ 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. RuntimeEnvironmentSecrets map[string]string @@ -242,7 +255,9 @@ type CodeRepository struct { SourceCodeVersion *SourceCodeVersion // Configuration for building and running the service from a source code - // repository. CodeConfiguration is required only for CreateService request. + // repository. + // + // CodeConfiguration is required only for CreateService request. CodeConfiguration *CodeConfiguration // The path of the directory that stores source code and configuration files. The @@ -328,9 +343,12 @@ type CustomDomain struct { // Runner service. 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 . + // 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 . EgressType EgressType // The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to @@ -357,27 +375,41 @@ type EncryptionConfiguration struct { type HealthCheckConfiguration struct { // The number of consecutive checks that must succeed before App Runner decides - // that the service is healthy. Default: 1 + // that the service is healthy. + // + // Default: 1 HealthyThreshold *int32 - // The time interval, in seconds, between health checks. Default: 5 + // 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 + // path specified by Path . + // + // Default: TCP Protocol HealthCheckProtocol // The time, in seconds, to wait for a health check response before deciding it - // failed. Default: 2 + // failed. + // + // Default: 2 Timeout *int32 // The number of consecutive checks that must fail before App Runner decides that - // the service is unhealthy. Default: 5 + // the service is unhealthy. + // + // Default: 5 UnhealthyThreshold *int32 noSmithyDocumentSerde @@ -387,7 +419,9 @@ type HealthCheckConfiguration struct { // using an image pulled from a source image repository. type ImageConfiguration struct { - // The port that your application listens to in the container. Default: 8080 + // The port that your application listens to in the container. + // + // Default: 8080 Port *string // An array of key-value pairs representing the secrets and parameters that get @@ -395,10 +429,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. RuntimeEnvironmentSecrets map[string]string @@ -418,10 +454,12 @@ type ImageConfiguration struct { // Describes a source image repository. 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) - // in the Amazon ECR User Guide. + // 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]in the Amazon ECR User Guide. + // + // [Pulling an image]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html // // This member is required. ImageIdentifier *string @@ -468,6 +506,7 @@ type IngressVpcConfiguration struct { type InstanceConfiguration struct { // The number of CPU units reserved for each instance of your App Runner service. + // // Default: 1 vCPU Cpu *string @@ -477,7 +516,9 @@ type InstanceConfiguration struct { InstanceRoleArn *string // The amount of memory, in MB or GB, reserved for each instance of your App - // Runner service. Default: 2 GB + // Runner service. + // + // Default: 2 GB Memory *string noSmithyDocumentSerde @@ -509,11 +550,13 @@ type NetworkConfiguration struct { // App Runner provides you with the option to choose between Internet Protocol // version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network // configuration. This is an optional parameter. If you do not specify an - // IpAddressType , it defaults to select IPv4. Currently, App Runner supports dual - // stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If - // you update a service that's using dual-stack Public endpoint to a Private - // endpoint, your App Runner service will default to support only IPv4 for Private - // endpoint and fail to receive traffic originating from IPv6 endpoint. + // IpAddressType , it defaults to select IPv4. + // + // Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 + // is supported for Private endpoint. If you update a service that's using + // dual-stack Public endpoint to a Private endpoint, your App Runner service will + // default to support only IPv4 for Private endpoint and fail to receive traffic + // originating from IPv6 endpoint. IpAddressType IpAddressType noSmithyDocumentSerde @@ -521,11 +564,12 @@ type NetworkConfiguration struct { // 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. +// 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 @@ -567,13 +611,12 @@ type ObservabilityConfiguration struct { } // Provides summary information about an App Runner observability configuration -// resource. This type contains limited information about an observability -// 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 -// DeleteObservabilityConfiguration actions using the ObservabilityConfiguration -// type. +// resource. +// +// This type contains limited information about an observability configuration. It +// includes only identification information, without configuration details. It's +// returned by the ListObservabilityConfigurationsaction. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration +// , and DeleteObservabilityConfigurationactions using the ObservabilityConfiguration type. type ObservabilityConfigurationSummary struct { // The Amazon Resource Name (ARN) of this observability configuration. @@ -623,13 +666,17 @@ 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. +// including deleted services. +// +// This type contains the full information about a service, including +// configuration details. It's returned by the [CreateService], [DescribeService], and [DeleteService] actions. A subset of this +// information is returned by the [ListServices]action using the [ServiceSummary] type. +// +// [CreateService]: https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html +// [DeleteService]: https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html +// [ListServices]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html +// [ServiceSummary]: https://docs.aws.amazon.com/apprunner/latest/api/API_ServiceSummary.html +// [DescribeService]: https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html type Service struct { // Summary information for the App Runner automatic scaling configuration resource @@ -679,10 +726,12 @@ type Service struct { // The current state of the App Runner service. These particular values mean the // following. + // // - CREATE_FAILED – The service failed to create. The failed service isn't // usable, and still counts towards your service quota. To troubleshoot this // failure, read the failure events and logs, change any parameters that need to be // fixed, and rebuild your service using UpdateService . + // // - 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. @@ -733,9 +782,11 @@ type ServiceObservabilityConfiguration struct { // The Amazon Resource Name (ARN) of the observability configuration that is // 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: + // + // 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 + // // Specify just the name to associate the latest revision. For example: // arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing ObservabilityConfigurationArn *string @@ -743,14 +794,17 @@ type ServiceObservabilityConfiguration struct { noSmithyDocumentSerde } -// 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. +// 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]action. Complete service +// information is returned by the [CreateService], [DescribeService], and [DeleteService] actions using the [Service] type. +// +// [CreateService]: https://docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html +// [DeleteService]: https://docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html +// [ListServices]: https://docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html +// [Service]: https://docs.aws.amazon.com/apprunner/latest/api/API_Service.html +// [DescribeService]: https://docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html type ServiceSummary struct { // The time when the App Runner service was created. It's in the Unix time stamp @@ -773,10 +827,12 @@ type ServiceSummary struct { // The current state of the App Runner service. These particular values mean the // following. + // // - CREATE_FAILED – The service failed to create. The failed service isn't // usable, and still counts towards your service quota. To troubleshoot this // failure, read the failure events and logs, change any parameters that need to be // fixed, and rebuild your service using UpdateService . + // // - 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. @@ -793,14 +849,17 @@ type ServiceSummary struct { // repository. type SourceCodeVersion struct { - // The type of version identifier. For a git-based repository, branches represent - // versions. + // The type of version identifier. + // + // For a git-based repository, branches represent versions. // // This member is required. Type SourceCodeVersionType - // A source code version. For a git-based repository, a branch name maps to a - // specific version. App Runner uses the most recent commit to the branch. + // A source code version. + // + // For a git-based repository, a branch name maps to a specific version. App + // Runner uses the most recent commit to the branch. // // This member is required. Value *string @@ -818,19 +877,23 @@ type SourceConfiguration struct { // 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 - // an Amazon Web Services account other than the one that the service is in. App - // Runner sets to true in all other cases (which currently include a source code - // repository or a source image using a same-account ECR repository). + // 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 an Amazon Web Services account other + // than the one that the service is in. App Runner sets to true in all other cases + // (which currently include a source code 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 - // member or CodeRepository (but not both). + // The description of a source image repository. + // + // You must provide either this member or CodeRepository (but not both). ImageRepository *ImageRepository noSmithyDocumentSerde @@ -863,9 +926,12 @@ 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. +// 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. type VpcConnector struct { // The time when the VPC connector was created. It's in Unix time stamp format. @@ -896,8 +962,9 @@ 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 @@ -931,13 +998,17 @@ type VpcIngressConnection struct { // The time when the VPC Ingress Connection was created. It's in the Unix time // stamp format. + // // - 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 DeletedAt *time.Time diff --git a/service/appstream/api_op_CreateAppBlock.go b/service/appstream/api_op_CreateAppBlock.go index 0969139f8bd..275e0e4fe1e 100644 --- a/service/appstream/api_op_CreateAppBlock.go +++ b/service/appstream/api_op_CreateAppBlock.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an app block. App blocks are an Amazon AppStream 2.0 resource that -// stores the details about the virtual hard disk in an S3 bucket. It also stores -// the setup script with details about how to mount the virtual hard disk. The -// virtual hard disk includes the application binaries and other files necessary to -// launch your applications. Multiple applications can be assigned to a single app -// block. This is only supported for Elastic fleets. +// Creates an app block. +// +// App blocks are an Amazon AppStream 2.0 resource that stores the details about +// the virtual hard disk in an S3 bucket. It also stores the setup script with +// details about how to mount the virtual hard disk. The virtual hard disk includes +// the application binaries and other files necessary to launch your applications. +// Multiple applications can be assigned to a single app block. +// +// This is only supported for Elastic fleets. func (c *Client) CreateAppBlock(ctx context.Context, params *CreateAppBlockInput, optFns ...func(*Options)) (*CreateAppBlockOutput, error) { if params == nil { params = &CreateAppBlockInput{} diff --git a/service/appstream/api_op_CreateAppBlockBuilder.go b/service/appstream/api_op_CreateAppBlockBuilder.go index 7d0471c56bd..cc90e1481bc 100644 --- a/service/appstream/api_op_CreateAppBlockBuilder.go +++ b/service/appstream/api_op_CreateAppBlockBuilder.go @@ -31,10 +31,15 @@ type CreateAppBlockBuilderInput struct { // The instance type to use when launching the app block builder. The following // instance types are available: + // // - stream.standard.small + // // - stream.standard.medium + // // - stream.standard.large + // // - stream.standard.xlarge + // // - stream.standard.2xlarge // // This member is required. @@ -45,14 +50,17 @@ type CreateAppBlockBuilderInput struct { // This member is required. Name *string - // The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid - // value. + // The platform of the app block builder. + // + // WINDOWS_SERVER_2019 is the only valid value. // // This member is required. Platform types.AppBlockBuilderPlatformType - // The VPC configuration for the app block builder. App block builders require - // that you specify at least two subnets in different availability zones. + // The VPC configuration for the app block builder. + // + // App block builders require that you specify at least two subnets in different + // availability zones. // // This member is required. VpcConfig *types.VpcConfig @@ -75,19 +83,27 @@ type CreateAppBlockBuilderInput struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // 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] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The tags to associate with the app block 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=. 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) - // in the Amazon AppStream 2.0 Administration Guide. + // 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: + // + // _ . : / = + \ - @ + // + // For more information, see [Tagging Your Resources] in the Amazon AppStream 2.0 Administration Guide. + // + // [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/appstream/api_op_CreateApplication.go b/service/appstream/api_op_CreateApplication.go index 467b7c0ff61..a472a5843ce 100644 --- a/service/appstream/api_op_CreateApplication.go +++ b/service/appstream/api_op_CreateApplication.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an application. Applications are an Amazon AppStream 2.0 resource that -// stores the details about how to launch applications on Elastic fleet streaming -// instances. An application consists of the launch details, icon, and display -// name. Applications are associated with an app block that contains the -// application binaries and other files. The applications assigned to an Elastic -// fleet are the applications users can launch. This is only supported for Elastic -// fleets. +// Creates an application. +// +// Applications are an Amazon AppStream 2.0 resource that stores the details about +// how to launch applications on Elastic fleet streaming instances. An application +// consists of the launch details, icon, and display name. Applications are +// associated with an app block that contains the application binaries and other +// files. The applications assigned to an Elastic fleet are the applications users +// can launch. +// +// This is only supported for Elastic fleets. func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} diff --git a/service/appstream/api_op_CreateFleet.go b/service/appstream/api_op_CreateFleet.go index c0654242bd4..52bcc5dc7d7 100644 --- a/service/appstream/api_op_CreateFleet.go +++ b/service/appstream/api_op_CreateFleet.go @@ -32,46 +32,87 @@ 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 // // This member is required. @@ -93,7 +134,9 @@ type CreateFleetInput struct { // disconnect. If users try to reconnect to the streaming session after a // disconnection or network interruption within this time interval, they are // connected to their previous session. Otherwise, they are connected to a new - // session with a new streaming instance. Specify a value between 60 and 360000. + // session with a new streaming instance. + // + // Specify a value between 60 and 360000. DisconnectTimeoutInSeconds *int32 // The fleet name to display. @@ -106,12 +149,14 @@ type CreateFleetInput struct { // Enables or disables default internet access for the fleet. EnableDefaultInternetAccess *bool - // The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. - // You are charged for all running instances in your fleet, even if no users are - // streaming apps. ON_DEMAND Provide users with access to applications after they - // connect, which takes one to two minutes. You are charged for instance streaming - // when users are connected and a small hourly fee for instances that are not - // streaming apps. + // The fleet type. + // + // ALWAYS_ON Provides users with instant-on access to their apps. You are charged + // for all running instances in your fleet, even if no users are streaming apps. + // + // ON_DEMAND Provide users with access to applications after they connect, which + // takes one to two minutes. You are charged for instance streaming when users are + // connected and a small hourly fee for instances that are not streaming apps. FleetType types.FleetType // The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume @@ -119,9 +164,11 @@ type CreateFleetInput struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // instance. + // + // For more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The amount of time that users can be idle (inactive) before they are @@ -133,16 +180,18 @@ type CreateFleetInput struct { // keyboard or mouse input during their streaming session. File uploads and // downloads, audio in, audio out, and pixels changing do not qualify as user // activity. If users continue to be idle after the time interval in - // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users - // from being disconnected due to inactivity, specify a value of 0. Otherwise, - // specify a value between 60 and 3600. The default value is 0. If you enable this - // feature, we recommend that you specify a value that corresponds exactly to a - // whole number of minutes (for example, 60, 120, and 180). If you don't do this, - // the value is rounded to the nearest minute. For example, if you specify a value - // of 70, users are disconnected after 1 minute of inactivity. If you specify a - // value that is at the midpoint between two different minutes, the value is - // rounded up. For example, if you specify a value of 90, users are disconnected - // after 2 minutes of inactivity. + // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. + // + // To prevent users from being disconnected due to inactivity, specify a value of + // 0. Otherwise, specify a value between 60 and 3600. The default value is 0. + // + // If you enable this feature, we recommend that you specify a value that + // corresponds exactly to a whole number of minutes (for example, 60, 120, and + // 180). If you don't do this, the value is rounded to the nearest minute. For + // example, if you specify a value of 70, users are disconnected after 1 minute of + // inactivity. If you specify a value that is at the midpoint between two different + // minutes, the value is rounded up. For example, if you specify a value of 90, + // users are disconnected after 2 minutes of inactivity. IdleDisconnectTimeoutInSeconds *int32 // The ARN of the public, private, or shared image to use. @@ -163,7 +212,9 @@ type CreateFleetInput struct { // seconds. If users are still connected to a streaming instance five minutes // before this limit is reached, they are prompted to save any open documents // before being disconnected. After this time elapses, the instance is terminated - // and replaced by a new instance. Specify a value between 600 and 432000. + // and replaced by a new instance. + // + // Specify a value between 600 and 432000. MaxUserDurationInSeconds *int32 // The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for @@ -177,16 +228,25 @@ type CreateFleetInput struct { // 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 . + // 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 // 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: _ . : / = + \ - @ - // 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. + // 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] in the Amazon AppStream 2.0 Administration Guide. + // + // [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html Tags map[string]string // The USB device filter strings that specify which USB devices a user can diff --git a/service/appstream/api_op_CreateImageBuilder.go b/service/appstream/api_op_CreateImageBuilder.go index d50f5a95496..c770e31531d 100644 --- a/service/appstream/api_op_CreateImageBuilder.go +++ b/service/appstream/api_op_CreateImageBuilder.go @@ -12,8 +12,10 @@ 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,38 +35,71 @@ 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 // // This member is required. @@ -101,10 +136,11 @@ type CreateImageBuilderInput struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // 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] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The ARN of the public, private, or shared image to use. @@ -115,11 +151,19 @@ type CreateImageBuilderInput struct { // 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. + // 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] in the Amazon AppStream 2.0 + // Administration Guide. + // + // [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html Tags map[string]string // The VPC configuration for the image builder. You can specify only one subnet. diff --git a/service/appstream/api_op_CreateStack.go b/service/appstream/api_op_CreateStack.go index db95f52efc5..7828eeb33fd 100644 --- a/service/appstream/api_op_CreateStack.go +++ b/service/appstream/api_op_CreateStack.go @@ -71,11 +71,19 @@ type CreateStackInput struct { // The tags to associate with the stack. 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: _ . : / = + \ - @ - // 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. + // 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] in the Amazon AppStream 2.0 + // Administration Guide. + // + // [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html Tags map[string]string // The actions that are enabled or disabled for users during their streaming diff --git a/service/appstream/api_op_CreateStreamingURL.go b/service/appstream/api_op_CreateStreamingURL.go index 4671b5c8ca2..9b48ee3696b 100644 --- a/service/appstream/api_op_CreateStreamingURL.go +++ b/service/appstream/api_op_CreateStreamingURL.go @@ -52,8 +52,10 @@ type CreateStreamingURLInput struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // The session context. For more information, see [Session Context] in the Amazon AppStream 2.0 + // Administration Guide. + // + // [Session Context]: https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters SessionContext *string // The time that the streaming URL will be valid, in seconds. Specify a value diff --git a/service/appstream/api_op_CreateUpdatedImage.go b/service/appstream/api_op_CreateUpdatedImage.go index 8dba4bf6794..b988497516c 100644 --- a/service/appstream/api_op_CreateUpdatedImage.go +++ b/service/appstream/api_op_CreateUpdatedImage.go @@ -12,10 +12,12 @@ 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. +// 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], in the Amazon AppStream 2.0 Administration Guide. +// +// [Administer Your AppStream 2.0 Images]: https://docs.aws.amazon.com/appstream2/latest/developerguide/administer-images.html func (c *Client) CreateUpdatedImage(ctx context.Context, params *CreateUpdatedImageInput, optFns ...func(*Options)) (*CreateUpdatedImageOutput, error) { if params == nil { params = &CreateUpdatedImageInput{} @@ -60,11 +62,19 @@ type CreateUpdatedImageInput struct { // The tags to associate with the new image. 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. + // 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] in the Amazon AppStream 2.0 + // Administration Guide. + // + // [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html NewImageTags map[string]string noSmithyDocumentSerde diff --git a/service/appstream/api_op_CreateUsageReportSubscription.go b/service/appstream/api_op_CreateUsageReportSubscription.go index 980571f273e..bc31ebb469e 100644 --- a/service/appstream/api_op_CreateUsageReportSubscription.go +++ b/service/appstream/api_op_CreateUsageReportSubscription.go @@ -33,13 +33,14 @@ type CreateUsageReportSubscriptionInput struct { type CreateUsageReportSubscriptionOutput struct { - // The Amazon S3 bucket where generated reports are stored. If you enabled - // on-instance session scripts and Amazon S3 logging for your session script - // configuration, AppStream 2.0 created an S3 bucket to store the script output. - // The bucket is unique to your account and Region. When you enable usage reporting - // in this case, AppStream 2.0 uses the same bucket to store your usage reports. If - // you haven't already enabled on-instance session scripts, when you enable usage - // reports, AppStream 2.0 creates a new S3 bucket. + // The Amazon S3 bucket where generated reports are stored. + // + // If you enabled on-instance session scripts and Amazon S3 logging for your + // session script configuration, AppStream 2.0 created an S3 bucket to store the + // script output. The bucket is unique to your account and Region. When you enable + // usage reporting in this case, AppStream 2.0 uses the same bucket to store your + // usage reports. If you haven't already enabled on-instance session scripts, when + // you enable usage reports, AppStream 2.0 creates a new S3 bucket. S3BucketName *string // The schedule for generating usage reports. diff --git a/service/appstream/api_op_CreateUser.go b/service/appstream/api_op_CreateUser.go index 319ca046f60..92d749d7444 100644 --- a/service/appstream/api_op_CreateUser.go +++ b/service/appstream/api_op_CreateUser.go @@ -34,10 +34,12 @@ 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 @@ -51,9 +53,10 @@ type CreateUserInput struct { // The action to take for the welcome email that is sent to a user after the user // is created in the user pool. If you specify SUPPRESS, no email is sent. If you // specify RESEND, do not specify the first name or last name of the user. If the - // value is null, the email is sent. The temporary password in the welcome email is - // valid for only 7 days. If users don’t set their passwords within 7 days, you - // must send them a new welcome email. + // value is null, the email is sent. + // + // The temporary password in the welcome email is valid for only 7 days. If users + // don’t set their passwords within 7 days, you must send them a new welcome email. MessageAction types.MessageAction noSmithyDocumentSerde diff --git a/service/appstream/api_op_DeleteAppBlockBuilder.go b/service/appstream/api_op_DeleteAppBlockBuilder.go index 06af25990c3..111f186d781 100644 --- a/service/appstream/api_op_DeleteAppBlockBuilder.go +++ b/service/appstream/api_op_DeleteAppBlockBuilder.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an app block builder. An app block builder can only be deleted when it -// has no association with an app block. +// Deletes an app block builder. +// +// An app block builder can only be deleted when it has no association with an app +// block. func (c *Client) DeleteAppBlockBuilder(ctx context.Context, params *DeleteAppBlockBuilderInput, optFns ...func(*Options)) (*DeleteAppBlockBuilderOutput, error) { if params == nil { params = &DeleteAppBlockBuilderInput{} diff --git a/service/appstream/api_op_DeleteUser.go b/service/appstream/api_op_DeleteUser.go index 44ee2fe34c2..52526a061fc 100644 --- a/service/appstream/api_op_DeleteUser.go +++ b/service/appstream/api_op_DeleteUser.go @@ -34,7 +34,9 @@ type DeleteUserInput struct { // This member is required. AuthenticationType types.AuthenticationType - // The email address of the user. Users' email addresses are case-sensitive. + // The email address of the user. + // + // Users' email addresses are case-sensitive. // // This member is required. UserName *string diff --git a/service/appstream/api_op_DescribeDirectoryConfigs.go b/service/appstream/api_op_DescribeDirectoryConfigs.go index a4614ffa211..064254e6f5a 100644 --- a/service/appstream/api_op_DescribeDirectoryConfigs.go +++ b/service/appstream/api_op_DescribeDirectoryConfigs.go @@ -15,9 +15,10 @@ import ( // for AppStream 2.0, if the names for these objects are provided. Otherwise, all // Directory Config objects in the account are described. These objects include the // configuration information required to join fleets and image builders to -// Microsoft Active Directory domains. Although the response syntax in this topic -// includes the account password, this password is not returned in the actual -// response. +// Microsoft Active Directory domains. +// +// Although the response syntax in this topic includes the account password, this +// password is not returned in the actual response. func (c *Client) DescribeDirectoryConfigs(ctx context.Context, params *DescribeDirectoryConfigsInput, optFns ...func(*Options)) (*DescribeDirectoryConfigsOutput, error) { if params == nil { params = &DescribeDirectoryConfigsInput{} diff --git a/service/appstream/api_op_DescribeFleets.go b/service/appstream/api_op_DescribeFleets.go index a79ca1b658e..cc9d4d7fc0c 100644 --- a/service/appstream/api_op_DescribeFleets.go +++ b/service/appstream/api_op_DescribeFleets.go @@ -175,12 +175,13 @@ type FleetStartedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFleetsInput, *DescribeFleetsOutput, error) (bool, error) } @@ -409,12 +410,13 @@ type FleetStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFleetsInput, *DescribeFleetsOutput, error) (bool, error) } diff --git a/service/appstream/api_op_DescribeUserStackAssociations.go b/service/appstream/api_op_DescribeUserStackAssociations.go index d3517807442..8fa7c5fd02c 100644 --- a/service/appstream/api_op_DescribeUserStackAssociations.go +++ b/service/appstream/api_op_DescribeUserStackAssociations.go @@ -13,7 +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 func (c *Client) DescribeUserStackAssociations(ctx context.Context, params *DescribeUserStackAssociationsInput, optFns ...func(*Options)) (*DescribeUserStackAssociationsOutput, error) { @@ -47,8 +49,9 @@ type DescribeUserStackAssociationsInput struct { // The name of the stack that is associated with the user. StackName *string - // The email address of the user who is associated with the stack. Users' email - // addresses are case-sensitive. + // The email address of the user who is associated with the stack. + // + // Users' email addresses are case-sensitive. UserName *string noSmithyDocumentSerde diff --git a/service/appstream/api_op_DisableUser.go b/service/appstream/api_op_DisableUser.go index 9361e973395..24dfb356238 100644 --- a/service/appstream/api_op_DisableUser.go +++ b/service/appstream/api_op_DisableUser.go @@ -35,7 +35,9 @@ type DisableUserInput struct { // This member is required. AuthenticationType types.AuthenticationType - // The email address of the user. Users' email addresses are case-sensitive. + // The email address of the user. + // + // Users' email addresses are case-sensitive. // // This member is required. UserName *string diff --git a/service/appstream/api_op_EnableUser.go b/service/appstream/api_op_EnableUser.go index 79bddb753c6..bd64cb73307 100644 --- a/service/appstream/api_op_EnableUser.go +++ b/service/appstream/api_op_EnableUser.go @@ -35,10 +35,12 @@ 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 75359503d02..a475ab28ed4 100644 --- a/service/appstream/api_op_ListTagsForResource.go +++ b/service/appstream/api_op_ListTagsForResource.go @@ -11,9 +11,12 @@ 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) -// in the Amazon AppStream 2.0 Administration Guide. +// tag AppStream 2.0 image builders, images, fleets, and stacks. +// +// For more information about tags, see [Tagging Your Resources] in the Amazon AppStream 2.0 +// Administration Guide. +// +// [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/appstream/api_op_StartAppBlockBuilder.go b/service/appstream/api_op_StartAppBlockBuilder.go index f77dfbbd9e6..739c6a43709 100644 --- a/service/appstream/api_op_StartAppBlockBuilder.go +++ b/service/appstream/api_op_StartAppBlockBuilder.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an app block builder. An app block builder can only be started when it's -// associated with an app block. Starting an app block builder starts a new -// instance, which is equivalent to an elastic fleet instance with application -// builder assistance functionality. +// Starts an app block builder. +// +// An app block builder can only be started when it's associated with an app block. +// +// Starting an app block builder starts a new instance, which is equivalent to an +// elastic fleet instance with application builder assistance functionality. func (c *Client) StartAppBlockBuilder(ctx context.Context, params *StartAppBlockBuilderInput, optFns ...func(*Options)) (*StartAppBlockBuilderOutput, error) { if params == nil { params = &StartAppBlockBuilderInput{} diff --git a/service/appstream/api_op_StopAppBlockBuilder.go b/service/appstream/api_op_StopAppBlockBuilder.go index 2a394c3bb6d..e990e2b6449 100644 --- a/service/appstream/api_op_StopAppBlockBuilder.go +++ b/service/appstream/api_op_StopAppBlockBuilder.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops an app block builder. Stopping an app block builder terminates the -// instance, and the instance state is not persisted. +// Stops an app block builder. +// +// Stopping an app block builder terminates the instance, and the instance state +// is not persisted. func (c *Client) StopAppBlockBuilder(ctx context.Context, params *StopAppBlockBuilderInput, optFns ...func(*Options)) (*StopAppBlockBuilderOutput, error) { if params == nil { params = &StopAppBlockBuilderInput{} diff --git a/service/appstream/api_op_TagResource.go b/service/appstream/api_op_TagResource.go index 08c197d1adb..28564e97011 100644 --- a/service/appstream/api_op_TagResource.go +++ b/service/appstream/api_op_TagResource.go @@ -11,13 +11,18 @@ import ( ) // Adds or overwrites one or more tags for the specified AppStream 2.0 resource. -// 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) -// in the Amazon AppStream 2.0 Administration Guide. +// 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] in the Amazon AppStream 2.0 +// Administration Guide. +// +// [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -41,10 +46,14 @@ type TagResourceInput struct { 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: _ . : / = + \ - @ + // 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 26c7ddd2da0..1f1448f493a 100644 --- a/service/appstream/api_op_UntagResource.go +++ b/service/appstream/api_op_UntagResource.go @@ -11,9 +11,14 @@ 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) -// in the Amazon AppStream 2.0 Administration Guide. +// resource. +// +// To list the current tags for your resources, use ListTagsForResource. +// +// For more information about tags, see [Tagging Your Resources] in the Amazon AppStream 2.0 +// Administration Guide. +// +// [Tagging Your Resources]: https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/appstream/api_op_UpdateAppBlockBuilder.go b/service/appstream/api_op_UpdateAppBlockBuilder.go index db071a165cc..a794ec6e750 100644 --- a/service/appstream/api_op_UpdateAppBlockBuilder.go +++ b/service/appstream/api_op_UpdateAppBlockBuilder.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an app block builder. If the app block builder is in the STARTING or -// STOPPING state, you can't update it. If the app block builder is in the RUNNING -// state, you can only update the DisplayName and Description. If the app block -// builder is in the STOPPED state, you can update any attribute except the Name. +// Updates an app block builder. +// +// If the app block builder is in the STARTING or STOPPING state, you can't update +// it. If the app block builder is in the RUNNING state, you can only update the +// DisplayName and Description. If the app block builder is in the STOPPED state, +// you can update any attribute except the Name. func (c *Client) UpdateAppBlockBuilder(ctx context.Context, params *UpdateAppBlockBuilderInput, optFns ...func(*Options)) (*UpdateAppBlockBuilderOutput, error) { if params == nil { params = &UpdateAppBlockBuilderInput{} @@ -58,27 +60,36 @@ type UpdateAppBlockBuilderInput struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // 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] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The instance type to use when launching the app block builder. The following // instance types are available: + // // - stream.standard.small + // // - stream.standard.medium + // // - stream.standard.large + // // - stream.standard.xlarge + // // - stream.standard.2xlarge InstanceType *string - // The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid - // value. + // The platform of the app block builder. + // + // WINDOWS_SERVER_2019 is the only valid value. Platform types.PlatformType - // The VPC configuration for the app block builder. App block builders require - // that you specify at least two subnets in different availability zones. + // The VPC configuration for the app block builder. + // + // App block builders require that you specify at least two subnets in different + // availability zones. VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/appstream/api_op_UpdateFleet.go b/service/appstream/api_op_UpdateFleet.go index d22f1bbdaf6..5a067099507 100644 --- a/service/appstream/api_op_UpdateFleet.go +++ b/service/appstream/api_op_UpdateFleet.go @@ -11,16 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. // // 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) { @@ -58,7 +68,9 @@ type UpdateFleetInput struct { // disconnect. If users try to reconnect to the streaming session after a // disconnection or network interruption within this time interval, they are // connected to their previous session. Otherwise, they are connected to a new - // session with a new streaming instance. Specify a value between 60 and 360000. + // session with a new streaming instance. + // + // Specify a value between 60 and 360000. DisconnectTimeoutInSeconds *int32 // The fleet name to display. @@ -76,9 +88,11 @@ type UpdateFleetInput struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // instance. + // + // For more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The amount of time that users can be idle (inactive) before they are @@ -90,16 +104,18 @@ type UpdateFleetInput struct { // keyboard or mouse input during their streaming session. File uploads and // downloads, audio in, audio out, and pixels changing do not qualify as user // activity. If users continue to be idle after the time interval in - // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users - // from being disconnected due to inactivity, specify a value of 0. Otherwise, - // specify a value between 60 and 3600. The default value is 0. If you enable this - // feature, we recommend that you specify a value that corresponds exactly to a - // whole number of minutes (for example, 60, 120, and 180). If you don't do this, - // the value is rounded to the nearest minute. For example, if you specify a value - // of 70, users are disconnected after 1 minute of inactivity. If you specify a - // value that is at the midpoint between two different minutes, the value is - // rounded up. For example, if you specify a value of 90, users are disconnected - // after 2 minutes of inactivity. + // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. + // + // To prevent users from being disconnected due to inactivity, specify a value of + // 0. Otherwise, specify a value between 60 and 3600. The default value is 0. + // + // If you enable this feature, we recommend that you specify a value that + // corresponds exactly to a whole number of minutes (for example, 60, 120, and + // 180). If you don't do this, the value is rounded to the nearest minute. For + // example, if you specify a value of 70, users are disconnected after 1 minute of + // inactivity. If you specify a value that is at the midpoint between two different + // minutes, the value is rounded up. For example, if you specify a value of 90, + // users are disconnected after 2 minutes of inactivity. IdleDisconnectTimeoutInSeconds *int32 // The ARN of the public, private, or shared image to use. @@ -110,46 +126,87 @@ 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 InstanceType *string @@ -164,7 +221,9 @@ type UpdateFleetInput struct { // seconds. If users are still connected to a streaming instance five minutes // before this limit is reached, they are prompted to save any open documents // before being disconnected. After this time elapses, the instance is terminated - // and replaced by a new instance. Specify a value between 600 and 432000. + // and replaced by a new instance. + // + // Specify a value between 600 and 432000. MaxUserDurationInSeconds *int32 // A unique name for the fleet. @@ -181,7 +240,9 @@ type UpdateFleetInput struct { // 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 . + // 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 diff --git a/service/appstream/doc.go b/service/appstream/doc.go index 4b3e2647efb..def9f03baeb 100644 --- a/service/appstream/doc.go +++ b/service/appstream/doc.go @@ -3,18 +3,26 @@ // Package appstream provides the API client, operations, and parameter types for // Amazon AppStream. // -// Amazon AppStream 2.0 This is the Amazon AppStream 2.0 API Reference. This -// documentation provides descriptions and syntax for each of the actions and data -// types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application -// streaming service that lets you stream desktop applications to users without -// rewriting applications. AppStream 2.0 manages the AWS resources that are -// required to host and run your applications, scales automatically, and provides -// 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) -// 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 +// +// This is the Amazon AppStream 2.0 API Reference. This documentation provides +// descriptions and syntax for each of the actions and data types in AppStream 2.0. +// AppStream 2.0 is a fully managed, secure application streaming service that lets +// you stream desktop applications to users without rewriting applications. +// AppStream 2.0 manages the AWS resources that are required to host and run your +// applications, scales automatically, and provides 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]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] +// +// [Amazon AppStream 2.0 documentation] +// +// [Amazon AppStream 2.0 product page]: http://aws.amazon.com/appstream2 +// [Amazon AppStream 2.0 documentation]: http://aws.amazon.com/documentation/appstream2 +// [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 package appstream diff --git a/service/appstream/options.go b/service/appstream/options.go index 7e745094409..76baac88f4c 100644 --- a/service/appstream/options.go +++ b/service/appstream/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appstream/types/enums.go b/service/appstream/types/enums.go index 751711ea443..e06b9df557b 100644 --- a/service/appstream/types/enums.go +++ b/service/appstream/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for AccessEndpointType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessEndpointType) Values() []AccessEndpointType { return []AccessEndpointType{ "STREAMING", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for Action. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Action) Values() []Action { return []Action{ "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", @@ -57,6 +59,7 @@ const ( // Values returns all known values for AppBlockBuilderAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AppBlockBuilderAttribute) Values() []AppBlockBuilderAttribute { return []AppBlockBuilderAttribute{ @@ -75,6 +78,7 @@ const ( // Values returns all known values for AppBlockBuilderPlatformType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AppBlockBuilderPlatformType) Values() []AppBlockBuilderPlatformType { return []AppBlockBuilderPlatformType{ @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for AppBlockBuilderState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppBlockBuilderState) Values() []AppBlockBuilderState { return []AppBlockBuilderState{ "STARTING", @@ -113,8 +118,9 @@ const ( // Values returns all known values for AppBlockBuilderStateChangeReasonCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppBlockBuilderStateChangeReasonCode) Values() []AppBlockBuilderStateChangeReasonCode { return []AppBlockBuilderStateChangeReasonCode{ "INTERNAL_ERROR", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for AppBlockState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppBlockState) Values() []AppBlockState { return []AppBlockState{ "INACTIVE", @@ -148,8 +155,9 @@ const ( ) // Values returns all known values for ApplicationAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationAttribute) Values() []ApplicationAttribute { return []ApplicationAttribute{ "LAUNCH_PARAMETERS", @@ -166,8 +174,9 @@ const ( ) // Values returns all known values for AppVisibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppVisibility) Values() []AppVisibility { return []AppVisibility{ "ALL", @@ -186,8 +195,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "API", @@ -208,6 +218,7 @@ const ( // Values returns all known values for CertificateBasedAuthStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CertificateBasedAuthStatus) Values() []CertificateBasedAuthStatus { return []CertificateBasedAuthStatus{ @@ -231,8 +242,9 @@ const ( ) // Values returns all known values for FleetAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetAttribute) Values() []FleetAttribute { return []FleetAttribute{ "VPC_CONFIGURATION", @@ -282,8 +294,9 @@ const ( ) // Values returns all known values for FleetErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetErrorCode) Values() []FleetErrorCode { return []FleetErrorCode{ "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", @@ -330,8 +343,9 @@ const ( ) // Values returns all known values for FleetState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetState) Values() []FleetState { return []FleetState{ "STARTING", @@ -351,8 +365,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -379,8 +394,9 @@ const ( ) // Values returns all known values for ImageBuilderState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageBuilderState) Values() []ImageBuilderState { return []ImageBuilderState{ "PENDING", @@ -407,8 +423,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageBuilderStateChangeReasonCode) Values() []ImageBuilderStateChangeReasonCode { return []ImageBuilderStateChangeReasonCode{ "INTERNAL_ERROR", @@ -430,8 +447,9 @@ const ( ) // Values returns all known values for ImageState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageState) Values() []ImageState { return []ImageState{ "PENDING", @@ -455,6 +473,7 @@ const ( // Values returns all known values for ImageStateChangeReasonCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ImageStateChangeReasonCode) Values() []ImageStateChangeReasonCode { return []ImageStateChangeReasonCode{ @@ -473,8 +492,9 @@ const ( ) // Values returns all known values for MessageAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageAction) Values() []MessageAction { return []MessageAction{ "SUPPRESS", @@ -491,8 +511,9 @@ const ( ) // Values returns all known values for PackagingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackagingType) Values() []PackagingType { return []PackagingType{ "CUSTOM", @@ -509,8 +530,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "ENABLED", @@ -530,8 +552,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -551,8 +574,9 @@ const ( ) // Values returns all known values for PreferredProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreferredProtocol) Values() []PreferredProtocol { return []PreferredProtocol{ "TCP", @@ -569,8 +593,9 @@ const ( ) // Values returns all known values for SessionConnectionState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionConnectionState) Values() []SessionConnectionState { return []SessionConnectionState{ "CONNECTED", @@ -588,8 +613,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -617,8 +643,9 @@ const ( ) // Values returns all known values for StackAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackAttribute) Values() []StackAttribute { return []StackAttribute{ "STORAGE_CONNECTORS", @@ -645,8 +672,9 @@ const ( ) // Values returns all known values for StackErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackErrorCode) Values() []StackErrorCode { return []StackErrorCode{ "STORAGE_CONNECTOR_ERROR", @@ -664,8 +692,9 @@ const ( ) // Values returns all known values for StorageConnectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageConnectorType) Values() []StorageConnectorType { return []StorageConnectorType{ "HOMEFOLDERS", @@ -683,8 +712,9 @@ const ( ) // Values returns all known values for StreamView. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamView) Values() []StreamView { return []StreamView{ "APP", @@ -703,8 +733,9 @@ const ( // Values returns all known values for UsageReportExecutionErrorCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageReportExecutionErrorCode) Values() []UsageReportExecutionErrorCode { return []UsageReportExecutionErrorCode{ "RESOURCE_NOT_FOUND", @@ -721,8 +752,9 @@ const ( ) // Values returns all known values for UsageReportSchedule. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageReportSchedule) Values() []UsageReportSchedule { return []UsageReportSchedule{ "DAILY", @@ -741,8 +773,9 @@ const ( // Values returns all known values for UserStackAssociationErrorCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserStackAssociationErrorCode) Values() []UserStackAssociationErrorCode { return []UserStackAssociationErrorCode{ "STACK_NOT_FOUND", @@ -762,8 +795,9 @@ const ( ) // Values returns all known values for VisibilityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VisibilityType) Values() []VisibilityType { return []VisibilityType{ "PUBLIC", diff --git a/service/appstream/types/types.go b/service/appstream/types/types.go index 4311f832dc3..a22e6987090 100644 --- a/service/appstream/types/types.go +++ b/service/appstream/types/types.go @@ -26,12 +26,15 @@ type AccessEndpoint struct { noSmithyDocumentSerde } -// Describes an app block. App blocks are an Amazon AppStream 2.0 resource that -// stores the details about the virtual hard disk in an S3 bucket. It also stores -// the setup script with details about how to mount the virtual hard disk. The -// virtual hard disk includes the application binaries and other files necessary to -// launch your applications. Multiple applications can be assigned to a single app -// block. This is only supported for Elastic fleets. +// Describes an app block. +// +// App blocks are an Amazon AppStream 2.0 resource that stores the details about +// the virtual hard disk in an S3 bucket. It also stores the setup script with +// details about how to mount the virtual hard disk. The virtual hard disk includes +// the application binaries and other files necessary to launch your applications. +// Multiple applications can be assigned to a single app block. +// +// This is only supported for Elastic fleets. type AppBlock struct { // The ARN of the app block. @@ -59,22 +62,27 @@ type AppBlock struct { // The packaging type of the app block. PackagingType PackagingType - // The post setup script details of the app block. This only applies to app blocks - // with PackagingType APPSTREAM2 . + // The post setup script details of the app block. + // + // This only applies to app blocks with PackagingType APPSTREAM2 . PostSetupScriptDetails *ScriptDetails - // The setup script details of the app block. This only applies to app blocks with - // PackagingType CUSTOM . + // The setup script details of the app block. + // + // This only applies to app blocks with PackagingType CUSTOM . SetupScriptDetails *ScriptDetails // The source S3 location of the app block. SourceS3Location *S3Location - // The state of the app block. An app block with AppStream 2.0 packaging will be - // in the INACTIVE state if no application package (VHD) is assigned to it. After - // an application package (VHD) is created by an app block builder for an app - // block, it becomes ACTIVE . Custom app blocks are always in the ACTIVE state and - // no action is required to use them. + // The state of the app block. + // + // An app block with AppStream 2.0 packaging will be in the INACTIVE state if no + // application package (VHD) is assigned to it. After an application package (VHD) + // is created by an app block builder for an app block, it becomes ACTIVE . + // + // Custom app blocks are always in the ACTIVE state and no action is required to + // use them. State AppBlockState noSmithyDocumentSerde @@ -98,8 +106,9 @@ type AppBlockBuilder struct { // This member is required. Name *string - // The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid - // value. + // The platform of the app block builder. + // + // WINDOWS_SERVER_2019 is the only valid value. // // This member is required. Platform AppBlockBuilderPlatformType @@ -301,9 +310,11 @@ type ComputeCapacity struct { DesiredInstances *int32 // The desired number of user sessions for a multi-session fleet. This is not - // allowed for single-session fleets. When you create a fleet, you must set either - // the DesiredSessions or DesiredInstances attribute, based on the type of fleet - // you create. You can’t define both attributes or leave both attributes blank. + // allowed for single-session fleets. + // + // When you create a fleet, you must set either the DesiredSessions or + // DesiredInstances attribute, based on the type of fleet you create. You can’t + // define both attributes or leave both attributes blank. DesiredSessions *int32 noSmithyDocumentSerde @@ -322,23 +333,31 @@ type ComputeCapacityStatus struct { ActiveUserSessions *int32 // The total number of session slots that are available for streaming or are - // currently streaming. ActualUserSessionCapacity = AvailableUserSessionCapacity + - // ActiveUserSessions This only applies to multi-session fleets. + // currently streaming. + // + // ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions + // + // This only applies to multi-session fleets. ActualUserSessions *int32 // The number of currently available instances that can be used to stream sessions. Available *int32 // The number of idle session slots currently available for user sessions. + // // AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions + // // This only applies to multi-session fleets. AvailableUserSessions *int32 // The total number of sessions slots that are either running or pending. This // represents the total number of concurrent streaming sessions your fleet can - // support in a steady state. DesiredUserSessionCapacity = - // ActualUserSessionCapacity + PendingUserSessionCapacity This only applies to - // multi-session fleets. + // support in a steady state. + // + // DesiredUserSessionCapacity = ActualUserSessionCapacity + + // PendingUserSessionCapacity + // + // This only applies to multi-session fleets. DesiredUserSessions *int32 // The number of instances in use for streaming. @@ -455,13 +474,22 @@ 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: + // SAML application. + // + // The following are valid values: + // // - roles + // // - department + // // - organization + // // - groups + // // - title + // // - costCenter + // // - userType // // This member is required. @@ -503,38 +531,71 @@ 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 // // This member is required. @@ -560,7 +621,9 @@ type Fleet struct { // disconnect. If they try to reconnect to the streaming session after a // disconnection or network interruption within this time interval, they are // connected to their previous session. Otherwise, they are connected to a new - // session with a new streaming instance. Specify a value between 60 and 360000. + // session with a new streaming instance. + // + // Specify a value between 60 and 360000. DisconnectTimeoutInSeconds *int32 // The fleet name to display. @@ -576,12 +639,14 @@ type Fleet struct { // The fleet errors. FleetErrors []FleetError - // The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. - // You are charged for all running instances in your fleet, even if no users are - // streaming apps. ON_DEMAND Provide users with access to applications after they - // connect, which takes one to two minutes. You are charged for instance streaming - // when users are connected and a small hourly fee for instances that are not - // streaming apps. + // The fleet type. + // + // ALWAYS_ON Provides users with instant-on access to their apps. You are charged + // for all running instances in your fleet, even if no users are streaming apps. + // + // ON_DEMAND Provide users with access to applications after they connect, which + // takes one to two minutes. You are charged for instance streaming when users are + // connected and a small hourly fee for instances that are not streaming apps. FleetType FleetType // The ARN of the IAM role that is applied to the fleet. To assume a role, the @@ -589,9 +654,11 @@ type Fleet struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // instance. + // + // For more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The amount of time that users can be idle (inactive) before they are @@ -603,16 +670,18 @@ type Fleet struct { // keyboard or mouse input during their streaming session. File uploads and // downloads, audio in, audio out, and pixels changing do not qualify as user // activity. If users continue to be idle after the time interval in - // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users - // from being disconnected due to inactivity, specify a value of 0. Otherwise, - // specify a value between 60 and 3600. The default value is 0. If you enable this - // feature, we recommend that you specify a value that corresponds exactly to a - // whole number of minutes (for example, 60, 120, and 180). If you don't do this, - // the value is rounded to the nearest minute. For example, if you specify a value - // of 70, users are disconnected after 1 minute of inactivity. If you specify a - // value that is at the midpoint between two different minutes, the value is - // rounded up. For example, if you specify a value of 90, users are disconnected - // after 2 minutes of inactivity. + // IdleDisconnectTimeoutInSeconds elapses, they are disconnected. + // + // To prevent users from being disconnected due to inactivity, specify a value of + // 0. Otherwise, specify a value between 60 and 3600. The default value is 0. + // + // If you enable this feature, we recommend that you specify a value that + // corresponds exactly to a whole number of minutes (for example, 60, 120, and + // 180). If you don't do this, the value is rounded to the nearest minute. For + // example, if you specify a value of 70, users are disconnected after 1 minute of + // inactivity. If you specify a value that is at the midpoint between two different + // minutes, the value is rounded up. For example, if you specify a value of 90, + // users are disconnected after 2 minutes of inactivity. IdleDisconnectTimeoutInSeconds *int32 // The ARN for the public, private, or shared image. @@ -632,7 +701,9 @@ type Fleet struct { // seconds. If users are still connected to a streaming instance five minutes // before this limit is reached, they are prompted to save any open documents // before being disconnected. After this time elapses, the instance is terminated - // and replaced by a new instance. Specify a value between 600 and 360000. + // and replaced by a new instance. + // + // Specify a value between 600 and 360000. MaxUserDurationInSeconds *int32 // The platform of the fleet. @@ -645,7 +716,9 @@ type Fleet struct { // 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 . + // by the operating system displays. + // + // The default value is APP . StreamView StreamView // The USB device filter strings associated with the fleet. @@ -774,9 +847,11 @@ type ImageBuilder struct { // 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) - // in the Amazon AppStream 2.0 Administration Guide. + // instance. + // + // For more information, see [Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances] in the Amazon AppStream 2.0 Administration Guide. + // + // [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 IamRoleArn *string // The ARN of the image from which this builder was created. @@ -787,38 +862,71 @@ 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 InstanceType *string @@ -928,12 +1036,19 @@ type S3Location struct { // This member is required. S3Bucket *string - // The S3 key of the S3 object. This is required when used for the following: + // The S3 key of the S3 object. + // + // This is required when used for the following: + // // - IconS3Location (Actions: CreateApplication and UpdateApplication) + // // - SessionScriptS3Location (Actions: CreateFleet and UpdateFleet) + // // - ScriptDetails (Actions: CreateAppBlock) + // // - SourceS3Location when creating an app block with CUSTOM PackagingType // (Actions: CreateAppBlock) + // // - SourceS3Location when creating an app block with APPSTREAM2 PackagingType, // and using an existing application package (VHD file). In this case, S3Key // refers to the VHD file. If a new application package is required, then S3Key @@ -1160,13 +1275,14 @@ type UsageReportSubscription struct { // The time when the last usage report was generated. LastGeneratedReportDate *time.Time - // The Amazon S3 bucket where generated reports are stored. If you enabled - // on-instance session scripts and Amazon S3 logging for your session script - // configuration, AppStream 2.0 created an S3 bucket to store the script output. - // The bucket is unique to your account and Region. When you enable usage reporting - // in this case, AppStream 2.0 uses the same bucket to store your usage reports. If - // you haven't already enabled on-instance session scripts, when you enable usage - // reports, AppStream 2.0 creates a new S3 bucket. + // The Amazon S3 bucket where generated reports are stored. + // + // If you enabled on-instance session scripts and Amazon S3 logging for your + // session script configuration, AppStream 2.0 created an S3 bucket to store the + // script output. The bucket is unique to your account and Region. When you enable + // usage reporting in this case, AppStream 2.0 uses the same bucket to store your + // usage reports. If you haven't already enabled on-instance session scripts, when + // you enable usage reports, AppStream 2.0 creates a new S3 bucket. S3BucketName *string // The schedule for generating usage reports. @@ -1201,16 +1317,22 @@ type User struct { // The last name, or surname, of the user. LastName *string - // The status of the user in the user pool. The status can be one of the - // following: + // 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. Status *string - // The email address of the user. Users' email addresses are case-sensitive. + // The email address of the user. + // + // Users' email addresses are case-sensitive. UserName *string noSmithyDocumentSerde @@ -1232,12 +1354,18 @@ type UserSetting struct { // Specifies the number of characters that can be copied by end users from the // local device to the remote session, and to the local device from the remote - // session. This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE - // and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions. This defaults to 20,971,520 (20 MB) - // when unspecified and the permission is ENABLED . This can't be specified when - // the permission is DISABLED . This can only be specified for AlwaysOn and - // OnDemand fleets. The attribute is not supported on Elastic fleets. The value can - // be between 1 and 20,971,520 (20 MB). + // session. + // + // This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and + // CLIPBOARD_COPY_TO_LOCAL_DEVICE actions. + // + // This defaults to 20,971,520 (20 MB) when unspecified and the permission is + // ENABLED . This can't be specified when the permission is DISABLED . + // + // This can only be specified for AlwaysOn and OnDemand fleets. The attribute is + // not supported on Elastic fleets. + // + // The value can be between 1 and 20,971,520 (20 MB). MaximumLength *int32 noSmithyDocumentSerde @@ -1256,8 +1384,9 @@ type UserStackAssociation struct { // This member is required. StackName *string - // The email address of the user who is associated with the stack. Users' email - // addresses are case-sensitive. + // The email address of the user who is associated with the stack. + // + // Users' email addresses are case-sensitive. // // This member is required. UserName *string diff --git a/service/appsync/api_op_CreateApiCache.go b/service/appsync/api_op_CreateApiCache.go index b1216ef02f2..fe942514daf 100644 --- a/service/appsync/api_op_CreateApiCache.go +++ b/service/appsync/api_op_CreateApiCache.go @@ -31,7 +31,9 @@ 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. // // This member is required. @@ -42,29 +44,48 @@ type CreateApiCacheInput struct { // This member is required. ApiId *string - // TTL in seconds for cache entries. Valid values are 1–3,600 seconds. + // TTL in seconds for cache entries. + // + // Valid values are 1–3,600 seconds. // // This member is required. 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: + // 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. @@ -76,12 +97,15 @@ type CreateApiCacheInput struct { // Controls how cache health metrics will be emitted to CloudWatch. Cache health // metrics include: + // // - NetworkBandwidthOutAllowanceExceeded: The network packets dropped because // the throughput exceeded the aggregated bandwidth limit. This is useful for // diagnosing bottlenecks in a cache configuration. + // // - EngineCPUUtilization: The CPU utilization (percentage) allocated to the // Redis process. This is useful for diagnosing bottlenecks in a cache // configuration. + // // Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED // . HealthMetricsConfig types.CacheHealthMetricsConfig diff --git a/service/appsync/api_op_CreateDataSource.go b/service/appsync/api_op_CreateDataSource.go index b53acff8a2c..ccf976a17ea 100644 --- a/service/appsync/api_op_CreateDataSource.go +++ b/service/appsync/api_op_CreateDataSource.go @@ -50,10 +50,11 @@ type CreateDataSourceInput struct { // Amazon DynamoDB settings. DynamodbConfig *types.DynamodbDataSourceConfig - // Amazon OpenSearch Service settings. As of September 2021, Amazon Elasticsearch - // service is Amazon OpenSearch Service. This configuration is deprecated. For new - // data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an - // OpenSearch data source. + // Amazon OpenSearch Service settings. + // + // As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch + // Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfigto create + // an OpenSearch data source. ElasticsearchConfig *types.ElasticsearchDataSourceConfig // Amazon EventBridge settings. @@ -69,8 +70,9 @@ type CreateDataSourceInput struct { // Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior // value is set to PER_DATA_SOURCE_METRICS . If the dataSourceLevelMetricsBehavior // is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be - // ignored. However, you can still set its value. metricsConfig can be ENABLED or - // DISABLED . + // ignored. However, you can still set its value. + // + // metricsConfig can be ENABLED or DISABLED . MetricsConfig types.DataSourceLevelMetricsConfig // Amazon OpenSearch Service settings. diff --git a/service/appsync/api_op_CreateFunction.go b/service/appsync/api_op_CreateFunction.go index 44a17999a73..8f68a221f68 100644 --- a/service/appsync/api_op_CreateFunction.go +++ b/service/appsync/api_op_CreateFunction.go @@ -11,8 +11,10 @@ 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{} @@ -73,8 +75,10 @@ type CreateFunctionInput struct { // specified. Runtime *types.AppSyncRuntime - // Describes a Sync configuration for a resolver. Specifies which Conflict - // Detection strategy and Resolution strategy to use when the resolver is invoked. + // Describes a Sync configuration for a resolver. + // + // Specifies which Conflict Detection strategy and Resolution strategy to use when + // the resolver is invoked. SyncConfig *types.SyncConfig noSmithyDocumentSerde diff --git a/service/appsync/api_op_CreateGraphqlApi.go b/service/appsync/api_op_CreateGraphqlApi.go index 1aa23ae9e9a..b6fcf86a277 100644 --- a/service/appsync/api_op_CreateGraphqlApi.go +++ b/service/appsync/api_op_CreateGraphqlApi.go @@ -53,9 +53,11 @@ type CreateGraphqlApiInput struct { // Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) // introspection. If no value is provided, the introspection configuration will be // set to ENABLED by default. This field will produce an error if the operation - // attempts to use the introspection feature while this field is disabled. For more - // information about introspection, see GraphQL introspection (https://graphql.org/learn/introspection/) - // . + // attempts to use the introspection feature while this field is disabled. + // + // For more information about introspection, see [GraphQL introspection]. + // + // [GraphQL introspection]: https://graphql.org/learn/introspection/ IntrospectionConfig types.GraphQLApiIntrospectionConfig // Configuration for Lambda function authorization. @@ -73,17 +75,20 @@ type CreateGraphqlApiInput struct { // The OIDC configuration. OpenIDConnectConfig *types.OpenIDConnectConfig - // The owner contact information for an API resource. This field accepts any - // string input with a length of 0 - 256 characters. + // The owner contact information for an API resource. + // + // This field accepts any string input with a length of 0 - 256 characters. OwnerContact *string // The maximum depth a query can have in a single request. Depth refers to the // amount of nested levels allowed in the body of query. The default value is 0 // (or unspecified), which indicates there's no depth limit. If you set a limit, it // can be between 1 and 75 nested levels. This field will produce a limit error if - // the operation falls out of bounds. Note that fields can still be set to nullable - // or non-nullable. If a non-nullable field produces an error, the error will be - // thrown upwards to the first nullable field available. + // the operation falls out of bounds. + // + // Note that fields can still be set to nullable or non-nullable. If a + // non-nullable field produces an error, the error will be thrown upwards to the + // first nullable field available. QueryDepthLimit int32 // The maximum number of resolvers that can be invoked in a single request. The diff --git a/service/appsync/api_op_CreateResolver.go b/service/appsync/api_op_CreateResolver.go index a9f0f9bff23..7a2d3520eb2 100644 --- a/service/appsync/api_op_CreateResolver.go +++ b/service/appsync/api_op_CreateResolver.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Resolver object. A resolver converts incoming requests into a format -// that a data source can understand, and converts the data source's responses into -// GraphQL. +// Creates a Resolver object. +// +// A resolver converts incoming requests into a format that a data source can +// understand, and converts the data source's responses into GraphQL. func (c *Client) CreateResolver(ctx context.Context, params *CreateResolverInput, optFns ...func(*Options)) (*CreateResolverOutput, error) { if params == nil { params = &CreateResolverInput{} @@ -57,6 +58,7 @@ type CreateResolverInput struct { 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. // @@ -72,18 +74,23 @@ type CreateResolverInput struct { // that metricsConfig won't be used unless the resolverLevelMetricsBehavior value // is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to // FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, - // you can still set its value. metricsConfig can be ENABLED or DISABLED . + // you can still set its value. + // + // metricsConfig can be ENABLED or DISABLED . MetricsConfig types.ResolverLevelMetricsConfig // The PipelineConfig . PipelineConfig *types.PipelineConfig - // The mapping template to use for requests. A resolver uses a request mapping - // template to convert a GraphQL expression into a format that a data source can - // understand. Mapping templates are written in Apache Velocity Template Language - // (VTL). VTL request mapping templates are optional when using an Lambda data - // source. For all other data sources, VTL request and response mapping templates - // are required. + // The mapping template to use for requests. + // + // A resolver uses a request mapping template to convert a GraphQL expression into + // a format that a data source can understand. Mapping templates are written in + // Apache Velocity Template Language (VTL). + // + // VTL request mapping templates are optional when using an Lambda data source. + // For all other data sources, VTL request and response mapping templates are + // required. RequestMappingTemplate *string // The mapping template to use for responses from the data source. diff --git a/service/appsync/api_op_CreateType.go b/service/appsync/api_op_CreateType.go index 180d5222d1c..a75675374f0 100644 --- a/service/appsync/api_op_CreateType.go +++ b/service/appsync/api_op_CreateType.go @@ -34,9 +34,11 @@ type CreateTypeInput struct { // This member is required. 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/) - // . + // The type definition, in GraphQL Schema Definition Language (SDL) format. + // + // For more information, see the [GraphQL SDL documentation]. + // + // [GraphQL SDL documentation]: http://graphql.org/learn/schema/ // // This member is required. Definition *string diff --git a/service/appsync/api_op_EvaluateMappingTemplate.go b/service/appsync/api_op_EvaluateMappingTemplate.go index 82be45a0925..90b8f426a5d 100644 --- a/service/appsync/api_op_EvaluateMappingTemplate.go +++ b/service/appsync/api_op_EvaluateMappingTemplate.go @@ -12,10 +12,13 @@ import ( ) // 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. +// 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. +// // Mapping templates are written in the Apache Velocity Template Language (VTL). func (c *Client) EvaluateMappingTemplate(ctx context.Context, params *EvaluateMappingTemplateInput, optFns ...func(*Options)) (*EvaluateMappingTemplateOutput, error) { if params == nil { diff --git a/service/appsync/api_op_GetIntrospectionSchema.go b/service/appsync/api_op_GetIntrospectionSchema.go index 4d4a91c16fa..3f8d335b79c 100644 --- a/service/appsync/api_op_GetIntrospectionSchema.go +++ b/service/appsync/api_op_GetIntrospectionSchema.go @@ -48,9 +48,11 @@ 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/) - // . + // The schema, in GraphQL Schema Definition Language (SDL) format. + // + // For more information, see the [GraphQL SDL documentation]. + // + // [GraphQL SDL documentation]: http://graphql.org/learn/schema/ Schema []byte // Metadata pertaining to the operation's result. diff --git a/service/appsync/api_op_ListApiKeys.go b/service/appsync/api_op_ListApiKeys.go index ca5b80a8e30..b1278b348fd 100644 --- a/service/appsync/api_op_ListApiKeys.go +++ b/service/appsync/api_op_ListApiKeys.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the API keys for a given API. API keys are deleted automatically 60 days -// after they expire. However, they may still be included in the response until -// they have actually been deleted. You can safely call DeleteApiKey to manually -// delete a key before it's automatically deleted. +// Lists the API keys for a given API. +// +// API keys are deleted automatically 60 days after they expire. However, they may +// still be included in the response until they have actually been deleted. You can +// safely call DeleteApiKey to manually delete a key before it's automatically +// deleted. func (c *Client) ListApiKeys(ctx context.Context, params *ListApiKeysInput, optFns ...func(*Options)) (*ListApiKeysOutput, error) { if params == nil { params = &ListApiKeysInput{} diff --git a/service/appsync/api_op_PutGraphqlApiEnvironmentVariables.go b/service/appsync/api_op_PutGraphqlApiEnvironmentVariables.go index 98484e262b1..5e3366b914e 100644 --- a/service/appsync/api_op_PutGraphqlApiEnvironmentVariables.go +++ b/service/appsync/api_op_PutGraphqlApiEnvironmentVariables.go @@ -10,21 +10,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a list of environmental variables in an API by its ID value. When -// creating an environmental variable, it must follow the constraints below: +// Creates a list of environmental variables in an API by its ID value. +// +// When creating an environmental variable, it must follow the constraints below: +// // - Both JavaScript and VTL templates support environmental variables. +// // - Environmental variables are not evaluated before function invocation. +// // - Environmental variables only support string values. +// // - Any defined value in an environmental variable is considered a string // literal and not expanded. +// // - Variable evaluations should ideally be performed in the function code. // // When creating an environmental variable key-value pair, it must follow the // additional constraints below: +// // - Keys must begin with a letter. +// // - Keys must be at least two characters long. +// // - Keys can only contain letters, numbers, and the underscore character (_). +// // - Values can be up to 512 characters long. +// // - You can configure up to 50 key-value pairs in a GraphQL API. // // You can create a list of environmental variables by adding it to the @@ -57,14 +68,21 @@ type PutGraphqlApiEnvironmentVariablesInput struct { // This member is required. ApiId *string - // The list of environmental variables to add to the API. When creating an - // environmental variable key-value pair, it must follow the additional constraints - // below: + // The list of environmental variables to add to the API. + // + // When creating an environmental variable key-value pair, it must follow the + // additional constraints below: + // // - Keys must begin with a letter. + // // - Keys must be at least two characters long. + // // - Keys can only contain letters, numbers, and the underscore character (_). + // // - Values can be up to 512 characters long. + // // - You can configure up to 50 key-value pairs in a GraphQL API. + // // You can create a list of environmental variables by adding it to the // environmentVariables payload as a list in the format // {"key1":"value1","key2":"value2", …} . Note that each call of the diff --git a/service/appsync/api_op_StartSchemaCreation.go b/service/appsync/api_op_StartSchemaCreation.go index 08233777f7d..db8bc851806 100644 --- a/service/appsync/api_op_StartSchemaCreation.go +++ b/service/appsync/api_op_StartSchemaCreation.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a new schema to your GraphQL API. This operation is asynchronous. Use to -// determine when it has completed. +// Adds a new schema to your GraphQL API. +// +// This operation is asynchronous. Use to determine when it has completed. func (c *Client) StartSchemaCreation(ctx context.Context, params *StartSchemaCreationInput, optFns ...func(*Options)) (*StartSchemaCreationOutput, error) { if params == nil { params = &StartSchemaCreationInput{} diff --git a/service/appsync/api_op_UpdateApiCache.go b/service/appsync/api_op_UpdateApiCache.go index dc4d1b82aa9..f2a401fa212 100644 --- a/service/appsync/api_op_UpdateApiCache.go +++ b/service/appsync/api_op_UpdateApiCache.go @@ -31,7 +31,9 @@ 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. // // This member is required. @@ -42,29 +44,48 @@ type UpdateApiCacheInput struct { // This member is required. ApiId *string - // TTL in seconds for cache entries. Valid values are 1–3,600 seconds. + // TTL in seconds for cache entries. + // + // Valid values are 1–3,600 seconds. // // This member is required. 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: + // 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. @@ -72,12 +93,15 @@ type UpdateApiCacheInput struct { // Controls how cache health metrics will be emitted to CloudWatch. Cache health // metrics include: + // // - NetworkBandwidthOutAllowanceExceeded: The network packets dropped because // the throughput exceeded the aggregated bandwidth limit. This is useful for // diagnosing bottlenecks in a cache configuration. + // // - EngineCPUUtilization: The CPU utilization (percentage) allocated to the // Redis process. This is useful for diagnosing bottlenecks in a cache // configuration. + // // Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED // . HealthMetricsConfig types.CacheHealthMetricsConfig diff --git a/service/appsync/api_op_UpdateDataSource.go b/service/appsync/api_op_UpdateDataSource.go index e5bf5771ecc..9fc42ea278b 100644 --- a/service/appsync/api_op_UpdateDataSource.go +++ b/service/appsync/api_op_UpdateDataSource.go @@ -50,9 +50,10 @@ type UpdateDataSourceInput struct { // The new Amazon DynamoDB configuration. DynamodbConfig *types.DynamodbDataSourceConfig - // 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 + // The new OpenSearch configuration. + // + // As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch + // Service. This configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfigto update an OpenSearch // data source. ElasticsearchConfig *types.ElasticsearchDataSourceConfig @@ -69,8 +70,9 @@ type UpdateDataSourceInput struct { // Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior // value is set to PER_DATA_SOURCE_METRICS . If the dataSourceLevelMetricsBehavior // is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be - // ignored. However, you can still set its value. metricsConfig can be ENABLED or - // DISABLED . + // ignored. However, you can still set its value. + // + // metricsConfig can be ENABLED or DISABLED . MetricsConfig types.DataSourceLevelMetricsConfig // The new OpenSearch configuration. diff --git a/service/appsync/api_op_UpdateFunction.go b/service/appsync/api_op_UpdateFunction.go index 972c7173f28..e0c1ba3e6f1 100644 --- a/service/appsync/api_op_UpdateFunction.go +++ b/service/appsync/api_op_UpdateFunction.go @@ -77,8 +77,10 @@ type UpdateFunctionInput struct { // specified. Runtime *types.AppSyncRuntime - // Describes a Sync configuration for a resolver. Specifies which Conflict - // Detection strategy and Resolution strategy to use when the resolver is invoked. + // Describes a Sync configuration for a resolver. + // + // Specifies which Conflict Detection strategy and Resolution strategy to use when + // the resolver is invoked. SyncConfig *types.SyncConfig noSmithyDocumentSerde diff --git a/service/appsync/api_op_UpdateGraphqlApi.go b/service/appsync/api_op_UpdateGraphqlApi.go index 72ca3b3122b..cc673d356d8 100644 --- a/service/appsync/api_op_UpdateGraphqlApi.go +++ b/service/appsync/api_op_UpdateGraphqlApi.go @@ -53,9 +53,11 @@ type UpdateGraphqlApiInput struct { // Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) // introspection. If no value is provided, the introspection configuration will be // set to ENABLED by default. This field will produce an error if the operation - // attempts to use the introspection feature while this field is disabled. For more - // information about introspection, see GraphQL introspection (https://graphql.org/learn/introspection/) - // . + // attempts to use the introspection feature while this field is disabled. + // + // For more information about introspection, see [GraphQL introspection]. + // + // [GraphQL introspection]: https://graphql.org/learn/introspection/ IntrospectionConfig types.GraphQLApiIntrospectionConfig // Configuration for Lambda function authorization. @@ -73,17 +75,20 @@ type UpdateGraphqlApiInput struct { // The OpenID Connect configuration for the GraphqlApi object. OpenIDConnectConfig *types.OpenIDConnectConfig - // The owner contact information for an API resource. This field accepts any - // string input with a length of 0 - 256 characters. + // The owner contact information for an API resource. + // + // This field accepts any string input with a length of 0 - 256 characters. OwnerContact *string // The maximum depth a query can have in a single request. Depth refers to the // amount of nested levels allowed in the body of query. The default value is 0 // (or unspecified), which indicates there's no depth limit. If you set a limit, it // can be between 1 and 75 nested levels. This field will produce a limit error if - // the operation falls out of bounds. Note that fields can still be set to nullable - // or non-nullable. If a non-nullable field produces an error, the error will be - // thrown upwards to the first nullable field available. + // the operation falls out of bounds. + // + // Note that fields can still be set to nullable or non-nullable. If a + // non-nullable field produces an error, the error will be thrown upwards to the + // first nullable field available. QueryDepthLimit int32 // The maximum number of resolvers that can be invoked in a single request. The diff --git a/service/appsync/api_op_UpdateResolver.go b/service/appsync/api_op_UpdateResolver.go index b988cf89b9b..131730ffab2 100644 --- a/service/appsync/api_op_UpdateResolver.go +++ b/service/appsync/api_op_UpdateResolver.go @@ -55,6 +55,7 @@ type UpdateResolverInput struct { 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. // @@ -70,17 +71,23 @@ type UpdateResolverInput struct { // that metricsConfig won't be used unless the resolverLevelMetricsBehavior value // is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to // FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, - // you can still set its value. metricsConfig can be ENABLED or DISABLED . + // you can still set its value. + // + // metricsConfig can be ENABLED or DISABLED . MetricsConfig types.ResolverLevelMetricsConfig // The PipelineConfig . PipelineConfig *types.PipelineConfig - // The new request mapping template. A resolver uses a request mapping template to - // convert a GraphQL expression into a format that a data source can understand. - // Mapping templates are written in Apache Velocity Template Language (VTL). VTL - // request mapping templates are optional when using an Lambda data source. For all - // other data sources, VTL request and response mapping templates are required. + // The new request mapping template. + // + // A resolver uses a request mapping template to convert a GraphQL expression into + // a format that a data source can understand. Mapping templates are written in + // Apache Velocity Template Language (VTL). + // + // VTL request mapping templates are optional when using an Lambda data source. + // For all other data sources, VTL request and response mapping templates are + // required. RequestMappingTemplate *string // The new response mapping template. diff --git a/service/appsync/options.go b/service/appsync/options.go index 8f4505d8489..1855a612d68 100644 --- a/service/appsync/options.go +++ b/service/appsync/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/appsync/types/enums.go b/service/appsync/types/enums.go index c2b1aa82451..f89388afa0c 100644 --- a/service/appsync/types/enums.go +++ b/service/appsync/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ApiCacheStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiCacheStatus) Values() []ApiCacheStatus { return []ApiCacheStatus{ "AVAILABLE", @@ -48,8 +49,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -79,8 +81,9 @@ const ( ) // Values returns all known values for ApiCachingBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiCachingBehavior) Values() []ApiCachingBehavior { return []ApiCachingBehavior{ "FULL_REQUEST_CACHING", @@ -98,8 +101,9 @@ const ( ) // Values returns all known values for AssociationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationStatus) Values() []AssociationStatus { return []AssociationStatus{ "PROCESSING", @@ -120,8 +124,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "API_KEY", @@ -140,8 +145,9 @@ const ( ) // Values returns all known values for AuthorizationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizationType) Values() []AuthorizationType { return []AuthorizationType{ "AWS_IAM", @@ -156,8 +162,9 @@ const ( ) // Values returns all known values for BadRequestReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BadRequestReason) Values() []BadRequestReason { return []BadRequestReason{ "CODE_ERROR", @@ -174,6 +181,7 @@ const ( // Values returns all known values for CacheHealthMetricsConfig. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CacheHealthMetricsConfig) Values() []CacheHealthMetricsConfig { return []CacheHealthMetricsConfig{ @@ -191,8 +199,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "VERSION", @@ -211,8 +220,9 @@ const ( ) // Values returns all known values for ConflictHandlerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictHandlerType) Values() []ConflictHandlerType { return []ConflictHandlerType{ "OPTIMISTIC_CONCURRENCY", @@ -233,8 +243,9 @@ const ( // Values returns all known values for DataSourceIntrospectionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceIntrospectionStatus) Values() []DataSourceIntrospectionStatus { return []DataSourceIntrospectionStatus{ "PROCESSING", @@ -253,8 +264,9 @@ const ( // Values returns all known values for DataSourceLevelMetricsBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceLevelMetricsBehavior) Values() []DataSourceLevelMetricsBehavior { return []DataSourceLevelMetricsBehavior{ "FULL_REQUEST_DATA_SOURCE_METRICS", @@ -272,8 +284,9 @@ const ( // Values returns all known values for DataSourceLevelMetricsConfig. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceLevelMetricsConfig) Values() []DataSourceLevelMetricsConfig { return []DataSourceLevelMetricsConfig{ "ENABLED", @@ -296,8 +309,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "AWS_LAMBDA", @@ -320,8 +334,9 @@ const ( ) // Values returns all known values for DefaultAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultAction) Values() []DefaultAction { return []DefaultAction{ "ALLOW", @@ -339,8 +354,9 @@ const ( ) // Values returns all known values for FieldLogLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FieldLogLevel) Values() []FieldLogLevel { return []FieldLogLevel{ "NONE", @@ -359,8 +375,9 @@ const ( // Values returns all known values for GraphQLApiIntrospectionConfig. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GraphQLApiIntrospectionConfig) Values() []GraphQLApiIntrospectionConfig { return []GraphQLApiIntrospectionConfig{ "ENABLED", @@ -377,8 +394,9 @@ const ( ) // Values returns all known values for GraphQLApiType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GraphQLApiType) Values() []GraphQLApiType { return []GraphQLApiType{ "GRAPHQL", @@ -395,8 +413,9 @@ const ( ) // Values returns all known values for GraphQLApiVisibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GraphQLApiVisibility) Values() []GraphQLApiVisibility { return []GraphQLApiVisibility{ "GLOBAL", @@ -413,8 +432,9 @@ const ( ) // Values returns all known values for MergeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MergeType) Values() []MergeType { return []MergeType{ "MANUAL_MERGE", @@ -432,6 +452,7 @@ const ( // Values returns all known values for OperationLevelMetricsConfig. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OperationLevelMetricsConfig) Values() []OperationLevelMetricsConfig { return []OperationLevelMetricsConfig{ @@ -449,8 +470,9 @@ const ( ) // Values returns all known values for OutputType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputType) Values() []OutputType { return []OutputType{ "SDL", @@ -467,8 +489,9 @@ const ( ) // 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. +// in the future, and so 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{ "CURRENT_ACCOUNT", @@ -485,8 +508,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationalDatabaseSourceType) Values() []RelationalDatabaseSourceType { return []RelationalDatabaseSourceType{ "RDS_HTTP_ENDPOINT", @@ -502,8 +526,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -521,8 +546,9 @@ const ( // Values returns all known values for ResolverLevelMetricsBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverLevelMetricsBehavior) Values() []ResolverLevelMetricsBehavior { return []ResolverLevelMetricsBehavior{ "FULL_REQUEST_RESOLVER_METRICS", @@ -540,6 +566,7 @@ const ( // Values returns all known values for ResolverLevelMetricsConfig. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResolverLevelMetricsConfig) Values() []ResolverLevelMetricsConfig { return []ResolverLevelMetricsConfig{ @@ -556,8 +583,9 @@ const ( ) // Values returns all known values for RuntimeName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuntimeName) Values() []RuntimeName { return []RuntimeName{ "APPSYNC_JS", @@ -577,8 +605,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -606,6 +635,7 @@ const ( // Values returns all known values for SourceApiAssociationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SourceApiAssociationStatus) Values() []SourceApiAssociationStatus { return []SourceApiAssociationStatus{ @@ -629,8 +659,9 @@ const ( ) // Values returns all known values for TypeDefinitionFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TypeDefinitionFormat) Values() []TypeDefinitionFormat { return []TypeDefinitionFormat{ "SDL", diff --git a/service/appsync/types/types.go b/service/appsync/types/types.go index 4679a8653c7..a8a865c5d0b 100644 --- a/service/appsync/types/types.go +++ b/service/appsync/types/types.go @@ -33,10 +33,13 @@ 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. AssociationStatus AssociationStatus @@ -54,7 +57,9 @@ 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. ApiCachingBehavior ApiCachingBehavior @@ -64,21 +69,29 @@ type ApiCache struct { // Controls how cache health metrics will be emitted to CloudWatch. Cache health // metrics include: + // // - NetworkBandwidthOutAllowanceExceeded: The network packets dropped because // the throughput exceeded the aggregated bandwidth limit. This is useful for // diagnosing bottlenecks in a cache configuration. + // // - EngineCPUUtilization: The CPU utilization (percentage) allocated to the // Redis process. This is useful for diagnosing bottlenecks in a cache // configuration. + // // Metrics will be recorded by API ID. You can set the value to ENABLED or DISABLED // . HealthMetricsConfig CacheHealthMetricsConfig // 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. Status ApiCacheStatus @@ -86,42 +99,69 @@ type ApiCache struct { // setting after creation. TransitEncryptionEnabled bool - // TTL in seconds for cache entries. Valid values are 1–3,600 seconds. + // 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: + // 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 } -// Describes an API key. Customers invoke AppSync GraphQL API operations with API -// keys as an identity mechanism. There are two key versions: da1: We introduced -// 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. +// Describes an API key. +// +// Customers invoke AppSync GraphQL API operations with API keys as an identity +// mechanism. There are two key versions: +// +// da1: We introduced 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 @@ -129,17 +169,23 @@ type ApiCache struct { // // 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 { @@ -185,6 +231,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). // // This member is required. @@ -221,15 +268,17 @@ type BadRequestDetail struct { // The caching configuration for a resolver that has caching activated. type CachingConfig struct { - // The TTL in seconds for a resolver that has caching activated. Valid values are - // 1–3,600 seconds. + // The TTL in seconds for a resolver that has caching activated. + // + // Valid values are 1–3,600 seconds. // // This member is required. 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 - // maps. + // The caching keys for a resolver that has caching activated. + // + // Valid values are entries from the $context.arguments , $context.source , and + // $context.identity maps. CachingKeys []string noSmithyDocumentSerde @@ -238,15 +287,18 @@ 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 . + // A user presentable error. + // + // Examples include, but aren't limited to: Parsing error: Unterminated string + // literal . Value *string noSmithyDocumentSerde @@ -315,8 +367,9 @@ type DataSource struct { // Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior // value is set to PER_DATA_SOURCE_METRICS . If the dataSourceLevelMetricsBehavior // is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be - // ignored. However, you can still set its value. metricsConfig can be ENABLED or - // DISABLED . + // ignored. However, you can still set its value. + // + // metricsConfig can be ENABLED or DISABLED . MetricsConfig DataSourceLevelMetricsConfig // The name of the data source. @@ -334,18 +387,26 @@ type DataSource struct { 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. Type DataSourceType @@ -395,10 +456,14 @@ type DataSourceIntrospectionModelField struct { type DataSourceIntrospectionModelFieldType struct { // Specifies the classification of data. For example, this could be set to values - // like Scalar or NonNull to indicate a fundamental property of the field. Valid - // values include: + // like Scalar or NonNull to indicate a fundamental property of the field. + // + // Valid values include: + // // - Scalar : Indicates the value is a primitive type (scalar). + // // - NonNull : Indicates the field cannot be null . + // // - List : Indicates the field contains a list. Kind *string @@ -407,11 +472,12 @@ type DataSourceIntrospectionModelFieldType struct { Name *string // The DataSourceIntrospectionModelFieldType object data. The type is only present - // if DataSourceIntrospectionModelFieldType.kind is set to NonNull or List . The - // type typically contains its own kind and name fields to represent the actual - // type data. For instance, type could contain a kind value of Scalar with a name - // value of String . The values Scalar and String will be collectively stored in - // the values field. + // if DataSourceIntrospectionModelFieldType.kind is set to NonNull or List . + // + // The type typically contains its own kind and name fields to represent the + // actual type data. For instance, type could contain a kind value of Scalar with + // a name value of String . The values Scalar and String will be collectively + // stored in the values field. Type *DataSourceIntrospectionModelFieldType // The values of the type field. This field represents the AppSync data type @@ -512,10 +578,11 @@ type DynamodbDataSourceConfig struct { noSmithyDocumentSerde } -// Describes an OpenSearch data source configuration. As of September 2021, Amazon -// Elasticsearch service is Amazon OpenSearch Service. This configuration is -// deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to -// specify an OpenSearch data source. +// Describes an OpenSearch data source configuration. +// +// As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch +// Service. This configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfigto specify +// an OpenSearch data source. type ElasticsearchDataSourceConfig struct { // The Amazon Web Services Region. @@ -535,64 +602,98 @@ type ElasticsearchDataSourceConfig struct { // granular data on API usage and performance such as AppSync request and error // counts, latency, and cache hits/misses. All enhanced metric data is sent to your // CloudWatch account, and you can configure the types of data that will be sent. +// // Enhanced metrics can be configured at the resolver, data source, and operation // levels. EnhancedMetricsConfig contains three required parameters, each // controlling one of these categories: +// // - resolverLevelMetricsBehavior : Controls how resolver metrics will be emitted // to CloudWatch. Resolver metrics include: +// // - GraphQL errors: The number of GraphQL errors that occurred. +// // - Requests: The number of invocations that occurred during a request. +// // - Latency: The time to complete a resolver invocation. +// // - Cache hits: The number of cache hits during a request. -// - Cache misses: The number of cache misses during a request. These metrics -// can be emitted to CloudWatch per resolver or for all resolvers in the request. -// Metrics will be recorded by API ID and resolver name. -// resolverLevelMetricsBehavior accepts one of these values at a time: -// - FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all -// resolvers in the request. -// - PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have -// the metricsConfig value set to ENABLED . -// - dataSourceLevelMetricsBehavior : Controls how data source metrics will be -// emitted to CloudWatch. Data source metrics include: -// - Requests: The number of invocations that occured during a request. -// - Latency: The time to complete a data source invocation. -// - Errors: The number of errors that occurred during a data source invocation. -// These metrics can be emitted to CloudWatch per data source or for all data -// sources in the request. Metrics will be recorded by API ID and data source name. -// dataSourceLevelMetricsBehavior accepts one of these values at a time: -// - FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all -// data sources in the request. -// - PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources -// that have the metricsConfig value set to ENABLED . -// - operationLevelMetricsConfig : Controls how operation metrics will be emitted -// to CloudWatch. Operation metrics include: -// - Requests: The number of times a specified GraphQL operation was called. -// - GraphQL errors: The number of GraphQL errors that occurred during a -// specified GraphQL operation. Metrics will be recorded by API ID and operation -// name. You can set the value to ENABLED or DISABLED . +// +// - Cache misses: The number of cache misses during a request. +// +// These metrics can be emitted to CloudWatch per resolver or for all resolvers in +// +// the request. Metrics will be recorded by API ID and resolver name. +// resolverLevelMetricsBehavior accepts one of these values at a time: +// +// - FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all +// resolvers in the request. +// +// - PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have +// the metricsConfig value set to ENABLED . +// +// - dataSourceLevelMetricsBehavior : Controls how data source metrics will be +// emitted to CloudWatch. Data source metrics include: +// +// - Requests: The number of invocations that occured during a request. +// +// - Latency: The time to complete a data source invocation. +// +// - Errors: The number of errors that occurred during a data source invocation. +// +// These metrics can be emitted to CloudWatch per data source or for all data +// +// sources in the request. Metrics will be recorded by API ID and data source name. +// dataSourceLevelMetricsBehavior accepts one of these values at a time: +// +// - FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all +// data sources in the request. +// +// - PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources +// that have the metricsConfig value set to ENABLED . +// +// - operationLevelMetricsConfig : Controls how operation metrics will be emitted +// to CloudWatch. Operation metrics include: +// +// - Requests: The number of times a specified GraphQL operation was called. +// +// - GraphQL errors: The number of GraphQL errors that occurred during a +// specified GraphQL operation. +// +// Metrics will be recorded by API ID and operation name. You can set the value to +// +// ENABLED or DISABLED . type EnhancedMetricsConfig struct { // Controls how data source metrics will be emitted to CloudWatch. Data source // metrics include: + // // - Requests: The number of invocations that occured during a request. + // // - Latency: The time to complete a data source invocation. + // // - Errors: The number of errors that occurred during a data source invocation. + // // These metrics can be emitted to CloudWatch per data source or for all data // sources in the request. Metrics will be recorded by API ID and data source name. // dataSourceLevelMetricsBehavior accepts one of these values at a time: + // // - FULL_REQUEST_DATA_SOURCE_METRICS : Records and emits metric data for all // data sources in the request. + // // - PER_DATA_SOURCE_METRICS : Records and emits metric data for data sources // that have the metricsConfig value set to ENABLED . // // This member is required. DataSourceLevelMetricsBehavior DataSourceLevelMetricsBehavior - // Controls how operation metrics will be emitted to CloudWatch. Operation metrics - // include: + // Controls how operation metrics will be emitted to CloudWatch. Operation + // metrics include: + // // - Requests: The number of times a specified GraphQL operation was called. + // // - GraphQL errors: The number of GraphQL errors that occurred during a // specified GraphQL operation. + // // Metrics will be recorded by API ID and operation name. You can set the value to // ENABLED or DISABLED . // @@ -601,16 +702,24 @@ type EnhancedMetricsConfig struct { // Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics // include: + // // - GraphQL errors: The number of GraphQL errors that occurred. + // // - Requests: The number of invocations that occurred during a request. + // // - Latency: The time to complete a resolver invocation. + // // - Cache hits: The number of cache hits during a request. + // // - Cache misses: The number of cache misses during a request. + // // These metrics can be emitted to CloudWatch per resolver or for all resolvers in // the request. Metrics will be recorded by API ID and resolver name. // resolverLevelMetricsBehavior accepts one of these values at a time: + // // - FULL_REQUEST_RESOLVER_METRICS : Records and emits metric data for all // resolvers in the request. + // // - PER_RESOLVER_METRICS : Records and emits metric data for resolvers that have // the metricsConfig value set to ENABLED . // @@ -645,9 +754,9 @@ type EvaluateCodeErrorDetail struct { // Describes an Amazon EventBridge bus data source configuration. 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) - // . + // The ARN of the event bus. For more information about event buses, see [Amazon EventBridge event buses]. + // + // [Amazon EventBridge event buses]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html // // This member is required. EventBusArn *string @@ -698,8 +807,10 @@ type FunctionConfiguration struct { // specified. Runtime *AppSyncRuntime - // Describes a Sync configuration for a resolver. Specifies which Conflict - // Detection strategy and Resolution strategy to use when the resolver is invoked. + // Describes a Sync configuration for a resolver. + // + // Specifies which Conflict Detection strategy and Resolution strategy to use when + // the resolver is invoked. SyncConfig *SyncConfig noSmithyDocumentSerde @@ -733,9 +844,11 @@ type GraphqlApi struct { // Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) // introspection. If no value is provided, the introspection configuration will be // set to ENABLED by default. This field will produce an error if the operation - // attempts to use the introspection feature while this field is disabled. For more - // information about introspection, see GraphQL introspection (https://graphql.org/learn/introspection/) - // . + // attempts to use the introspection feature while this field is disabled. + // + // For more information about introspection, see [GraphQL introspection]. + // + // [GraphQL introspection]: https://graphql.org/learn/introspection/ IntrospectionConfig GraphQLApiIntrospectionConfig // Configuration for Lambda function authorization. @@ -759,17 +872,20 @@ type GraphqlApi struct { // The account owner of the GraphQL API. Owner *string - // The owner contact information for an API resource. This field accepts any - // string input with a length of 0 - 256 characters. + // The owner contact information for an API resource. + // + // This field accepts any string input with a length of 0 - 256 characters. OwnerContact *string // The maximum depth a query can have in a single request. Depth refers to the // amount of nested levels allowed in the body of query. The default value is 0 // (or unspecified), which indicates there's no depth limit. If you set a limit, it // can be between 1 and 75 nested levels. This field will produce a limit error if - // the operation falls out of bounds. Note that fields can still be set to nullable - // or non-nullable. If a non-nullable field produces an error, the error will be - // thrown upwards to the first nullable field available. + // the operation falls out of bounds. + // + // Note that fields can still be set to nullable or non-nullable. If a + // non-nullable field produces an error, the error will be thrown upwards to the + // first nullable field available. QueryDepthLimit int32 // The maximum number of resolvers that can be invoked in a single request. The @@ -825,12 +941,15 @@ 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 - // 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 - // "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id - // "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction + // 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 + // "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id + // "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction // // This member is required. AuthorizerUri *string @@ -881,15 +1000,21 @@ 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: + // + // - 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. + // + // - 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. @@ -1005,6 +1130,7 @@ 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. RelationalDatabaseSourceType RelationalDatabaseSourceType @@ -1029,6 +1155,7 @@ 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. // @@ -1044,7 +1171,9 @@ type Resolver struct { // that metricsConfig won't be used unless the resolverLevelMetricsBehavior value // is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to // FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, - // you can still set its value. metricsConfig can be ENABLED or DISABLED . + // you can still set its value. + // + // metricsConfig can be ENABLED or DISABLED . MetricsConfig ResolverLevelMetricsConfig // The PipelineConfig . @@ -1078,11 +1207,14 @@ type Resolver struct { // is linked to a merged API. There can be multiple source APIs attached to each // merged API. When linked to a merged API, the source API's schema, data sources, // and resolvers will be combined with other linked source API data to form a new, -// singular API. Source APIs can originate from your account or from other accounts -// via Amazon Web Services Resource Access Manager. For more information about -// sharing resources from other accounts, see What is Amazon Web Services Resource -// Access Manager? (https://docs.aws.amazon.com/ram/latest/userguide/what-is.html) -// in the Amazon Web Services Resource Access Manager guide. +// singular API. +// +// Source APIs can originate from your account or from other accounts via Amazon +// Web Services Resource Access Manager. For more information about sharing +// resources from other accounts, see [What is Amazon Web Services Resource Access Manager?]in the Amazon Web Services Resource Access +// Manager guide. +// +// [What is Amazon Web Services Resource Access Manager?]: https://docs.aws.amazon.com/ram/latest/userguide/what-is.html type SourceApiAssociation struct { // The Amazon Resource Name (ARN) of the source API association. @@ -1126,12 +1258,14 @@ type SourceApiAssociation struct { type SourceApiAssociationConfig struct { // The property that indicates which merging option is enabled in the source API - // association. Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE . - // Manual merges are the default behavior and require the user to trigger any - // changes from the source APIs to the merged API manually. Auto merges subscribe - // the merged API to the changes performed on the source APIs so that any change in - // the source APIs are also made to the merged API. Auto merges use - // MergedApiExecutionRoleArn to perform merge operations. + // association. + // + // Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE . Manual merges are + // the default behavior and require the user to trigger any changes from the source + // APIs to the merged API manually. Auto merges subscribe the merged API to the + // changes performed on the source APIs so that any change in the source APIs are + // also made to the merged API. Auto merges use MergedApiExecutionRoleArn to + // perform merge operations. MergeType MergeType noSmithyDocumentSerde @@ -1164,20 +1298,27 @@ type SourceApiAssociationSummary struct { noSmithyDocumentSerde } -// Describes a Sync configuration for a resolver. Specifies which Conflict -// Detection strategy and Resolution strategy to use when the resolver is invoked. +// Describes a Sync configuration for a resolver. +// +// Specifies which Conflict Detection strategy and Resolution strategy to use when +// the resolver is invoked. 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. 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 . ConflictHandler ConflictHandlerType diff --git a/service/arczonalshift/api_op_CancelZonalShift.go b/service/arczonalshift/api_op_CancelZonalShift.go index 53ef18e1924..c57ea8d0f6b 100644 --- a/service/arczonalshift/api_op_CancelZonalShift.go +++ b/service/arczonalshift/api_op_CancelZonalShift.go @@ -13,10 +13,11 @@ import ( ) // Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To -// cancel the zonal shift, specify the zonal shift ID. A zonal shift can be one -// that you've started for a resource in your Amazon Web Services account in an -// Amazon Web Services Region, or it can be a zonal shift started by a practice run -// with zonal autoshift. +// cancel the zonal shift, specify the zonal shift ID. +// +// A zonal shift can be one that you've started for a resource in your Amazon Web +// Services account in an Amazon Web Services Region, or it can be a zonal shift +// started by a practice run with zonal autoshift. func (c *Client) CancelZonalShift(ctx context.Context, params *CancelZonalShiftInput, optFns ...func(*Options)) (*CancelZonalShiftOutput, error) { if params == nil { params = &CancelZonalShiftInput{} @@ -62,10 +63,11 @@ type CancelZonalShiftOutput struct { // The expiry time (expiration time) for a customer-started zonal shift. A zonal // shift is temporary and must be set to expire when you start the zonal shift. You // can initially set a zonal shift to expire in a maximum of three days (72 hours). - // However, you can update a zonal shift to set a new expiration at any time. When - // you start a zonal shift, you specify how long you want it to be active, which - // Route 53 ARC converts to an expiry time (expiration time). You can cancel a - // zonal shift when you're ready to restore traffic to the Availability Zone, or + // However, you can update a zonal shift to set a new expiration at any time. + // + // When you start a zonal shift, you specify how long you want it to be active, + // which Route 53 ARC converts to an expiry time (expiration time). You can cancel + // a zonal shift when you're ready to restore traffic to the Availability Zone, or // just wait for it to expire. Or you can update the zonal shift to specify another // length of time to expire in. // @@ -73,9 +75,10 @@ type CancelZonalShiftOutput struct { ExpiryTime *time.Time // The identifier for the resource to shift away traffic for. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, supported - // resources are Network Load Balancers and Application Load Balancers with - // cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, supported resources are Network Load Balancers and Application + // Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string @@ -85,10 +88,14 @@ type CancelZonalShiftOutput struct { // This member is required. StartTime *time.Time - // A status for a zonal shift. The Status for a zonal shift can have one of the - // following values: + // A status for a zonal shift. + // + // The Status for a zonal shift can have one of the following values: + // // - ACTIVE: The zonal shift has been started and active. + // // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // // - CANCELED: The zonal shift was canceled. // // This member is required. diff --git a/service/arczonalshift/api_op_CreatePracticeRunConfiguration.go b/service/arczonalshift/api_op_CreatePracticeRunConfiguration.go index a2ae44cf824..80ac87af397 100644 --- a/service/arczonalshift/api_op_CreatePracticeRunConfiguration.go +++ b/service/arczonalshift/api_op_CreatePracticeRunConfiguration.go @@ -16,9 +16,12 @@ import ( // blocked dates and blocked time windows, and for Amazon CloudWatch alarms that // you create to use with practice runs. The alarms that you specify are an outcome // alarm, to monitor application health during practice runs and, optionally, a -// blocking alarm, to block practice runs from starting. For more information, see -// Considerations when you configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html) -// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// blocking alarm, to block practice runs from starting. +// +// For more information, see [Considerations when you configure zonal autoshift] in the Amazon Route 53 Application Recovery +// Controller Developer Guide. +// +// [Considerations when you configure zonal autoshift]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html func (c *Client) CreatePracticeRunConfiguration(ctx context.Context, params *CreatePracticeRunConfigurationInput, optFns ...func(*Options)) (*CreatePracticeRunConfigurationOutput, error) { if params == nil { params = &CreatePracticeRunConfigurationInput{} @@ -38,6 +41,7 @@ type CreatePracticeRunConfigurationInput struct { // The outcome alarm for practice runs is a required Amazon CloudWatch alarm that // you specify that ends a practice run when the alarm is in an ALARM state. + // // Configure the alarm to monitor the health of your application when traffic is // shifted away from an Availability Zone during each weekly practice run. You // should configure the alarm to go into an ALARM state if your application is @@ -49,35 +53,43 @@ type CreatePracticeRunConfigurationInput struct { // The identifier of the resource to shift away traffic for when a practice run // starts a zonal shift. The identifier is the Amazon Resource Name (ARN) for the - // resource. At this time, supported resources are Network Load Balancers and - // Application Load Balancers with cross-zone load balancing turned off. + // resource. + // + // At this time, supported resources are Network Load Balancers and Application + // Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string // Optionally, you can block Route 53 ARC from starting practice runs for a - // resource on specific calendar dates. The format for blocked dates is: - // YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for - // practice runs are in UTC. Separate multiple blocked dates with spaces. For - // example, if you have an application update scheduled to launch on May 1, 2024, - // and you don't want practice runs to shift traffic away at that time, you could - // set a blocked date for 2024-05-01 . + // resource on specific calendar dates. + // + // The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify + // dates, that dates and times for practice runs are in UTC. Separate multiple + // blocked dates with spaces. + // + // For example, if you have an application update scheduled to launch on May 1, + // 2024, and you don't want practice runs to shift traffic away at that time, you + // could set a blocked date for 2024-05-01 . BlockedDates []string // Optionally, you can block Route 53 ARC from starting practice runs for specific - // windows of days and times. The format for blocked windows is: - // DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times - // for practice runs are in UTC. Also, be aware of potential time adjustments that - // might be required for daylight saving time differences. Separate multiple - // blocked windows with spaces. For example, say you run business report summaries - // three days a week. For this scenario, you might set the following recurring days - // and times as blocked windows, for example: MON-20:30-21:30 WED-20:30-21:30 - // FRI-20:30-21:30 . + // windows of days and times. + // + // The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you + // specify dates, that dates and times for practice runs are in UTC. Also, be aware + // of potential time adjustments that might be required for daylight saving time + // differences. Separate multiple blocked windows with spaces. + // + // For example, say you run business report summaries three days a week. For this + // scenario, you might set the following recurring days and times as blocked + // windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30 . BlockedWindows []string // An Amazon CloudWatch alarm that you can specify for zonal autoshift practice // runs. This alarm blocks Route 53 ARC from starting practice run zonal shifts, - // and ends a practice run that's in progress, when the alarm is in an ALARM state. + // and ends a practice run that's in progress, when the alarm is in an ALARM + // state. BlockingAlarms []types.ControlCondition noSmithyDocumentSerde @@ -107,8 +119,10 @@ type CreatePracticeRunConfigurationOutput struct { // status as ENABLED , Amazon Web Services shifts traffic away from shifts away // application resource traffic from an Availability Zone, on your behalf, when // Amazon Web Services determines that there's an issue in the Availability Zone - // that could potentially affect customers. When you enable zonal autoshift, you - // must also configure practice runs for the resource. + // that could potentially affect customers. + // + // When you enable zonal autoshift, you must also configure practice runs for the + // resource. // // This member is required. ZonalAutoshiftStatus types.ZonalAutoshiftStatus diff --git a/service/arczonalshift/api_op_GetManagedResource.go b/service/arczonalshift/api_op_GetManagedResource.go index d811ebcbce8..f6d2c3b07f8 100644 --- a/service/arczonalshift/api_op_GetManagedResource.go +++ b/service/arczonalshift/api_op_GetManagedResource.go @@ -15,9 +15,11 @@ import ( // Amazon Route 53 Application Recovery Controller in this Amazon Web Services // Region. Resources that are registered for zonal shifts are managed resources in // Route 53 ARC. You can start zonal shifts and configure zonal autoshift for -// managed resources. At this time, you can only start a zonal shift or configure -// zonal autoshift for Network Load Balancers and Application Load Balancers with -// cross-zone load balancing turned off. +// managed resources. +// +// At this time, you can only start a zonal shift or configure zonal autoshift for +// Network Load Balancers and Application Load Balancers with cross-zone load +// balancing turned off. func (c *Client) GetManagedResource(ctx context.Context, params *GetManagedResourceInput, optFns ...func(*Options)) (*GetManagedResourceOutput, error) { if params == nil { params = &GetManagedResourceInput{} @@ -36,9 +38,10 @@ func (c *Client) GetManagedResource(ctx context.Context, params *GetManagedResou type GetManagedResourceInput struct { // The identifier for the resource to shift away traffic for. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, supported - // resources are Network Load Balancers and Application Load Balancers with - // cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, supported resources are Network Load Balancers and Application + // Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string diff --git a/service/arczonalshift/api_op_ListZonalShifts.go b/service/arczonalshift/api_op_ListZonalShifts.go index b10ee59b6a1..874d1370e6d 100644 --- a/service/arczonalshift/api_op_ListZonalShifts.go +++ b/service/arczonalshift/api_op_ListZonalShifts.go @@ -15,9 +15,12 @@ import ( // Recovery Controller in your Amazon Web Services account in this Amazon Web // Services Region. ListZonalShifts returns customer-started zonal shifts, as well // as practice run zonal shifts that Route 53 ARC started on your behalf for zonal -// autoshift. The ListZonalShifts operation does not list autoshifts. For more -// information about listing autoshifts, see ">ListAutoshifts (https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html) -// . +// autoshift. +// +// The ListZonalShifts operation does not list autoshifts. For more information +// about listing autoshifts, see [">ListAutoshifts]. +// +// [">ListAutoshifts]: https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html func (c *Client) ListZonalShifts(ctx context.Context, params *ListZonalShiftsInput, optFns ...func(*Options)) (*ListZonalShiftsOutput, error) { if params == nil { params = &ListZonalShiftsInput{} @@ -48,10 +51,14 @@ type ListZonalShiftsInput struct { // identifier is the Amazon Resource Name (ARN) for the resource. ResourceIdentifier *string - // A status for a zonal shift. The Status for a zonal shift can have one of the - // following values: + // A status for a zonal shift. + // + // The Status for a zonal shift can have one of the following values: + // // - ACTIVE: The zonal shift has been started and active. + // // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // // - CANCELED: The zonal shift was canceled. Status types.ZonalShiftStatus diff --git a/service/arczonalshift/api_op_StartZonalShift.go b/service/arczonalshift/api_op_StartZonalShift.go index f2bcd1e2d87..8314033487b 100644 --- a/service/arczonalshift/api_op_StartZonalShift.go +++ b/service/arczonalshift/api_op_StartZonalShift.go @@ -18,15 +18,20 @@ import ( // an Amazon Web Services infrastructure failure in a single Availability Zone. You // can start a zonal shift in Route 53 ARC only for managed resources in your // Amazon Web Services account in an Amazon Web Services Region. Resources are -// automatically registered with Route 53 ARC by Amazon Web Services services. At -// this time, you can only start a zonal shift for Network Load Balancers and -// Application Load Balancers with cross-zone load balancing turned off. When you -// start a zonal shift, traffic for the resource is no longer routed to the -// Availability Zone. The zonal shift is created immediately in Route 53 ARC. +// automatically registered with Route 53 ARC by Amazon Web Services services. +// +// At this time, you can only start a zonal shift for Network Load Balancers and +// Application Load Balancers with cross-zone load balancing turned off. +// +// When you start a zonal shift, traffic for the resource is no longer routed 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. +// in-progress connections in the Availability Zone to complete. +// +// For more information, see [Zonal shift] in the Amazon Route 53 Application Recovery +// Controller Developer Guide. +// +// [Zonal shift]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html func (c *Client) StartZonalShift(ctx context.Context, params *StartZonalShiftInput, optFns ...func(*Options)) (*StartZonalShiftOutput, error) { if params == nil { params = &StartZonalShiftInput{} @@ -61,14 +66,20 @@ type StartZonalShiftInput struct { // The length of time that you want a zonal shift to be active, which Route 53 ARC // converts to an expiry time (expiration time). Zonal shifts are temporary. You - // can set a zonal shift to be active initially for up to three days (72 hours). If - // you want to still keep traffic away from an Availability Zone, you can update - // the zonal shift and set a new expiration. You can also cancel a zonal shift, - // 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: + // can set a zonal shift to be active initially for up to three days (72 hours). + // + // If you want to still keep traffic away from an Availability Zone, you can + // update the zonal shift and set a new expiration. You can also cancel a zonal + // shift, 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). // @@ -76,9 +87,10 @@ type StartZonalShiftInput struct { ExpiresIn *string // The identifier for the resource to shift away traffic for. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, supported - // resources are Network Load Balancers and Application Load Balancers with - // cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, supported resources are Network Load Balancers and Application + // Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string @@ -106,10 +118,11 @@ type StartZonalShiftOutput struct { // The expiry time (expiration time) for a customer-started zonal shift. A zonal // shift is temporary and must be set to expire when you start the zonal shift. You // can initially set a zonal shift to expire in a maximum of three days (72 hours). - // However, you can update a zonal shift to set a new expiration at any time. When - // you start a zonal shift, you specify how long you want it to be active, which - // Route 53 ARC converts to an expiry time (expiration time). You can cancel a - // zonal shift when you're ready to restore traffic to the Availability Zone, or + // However, you can update a zonal shift to set a new expiration at any time. + // + // When you start a zonal shift, you specify how long you want it to be active, + // which Route 53 ARC converts to an expiry time (expiration time). You can cancel + // a zonal shift when you're ready to restore traffic to the Availability Zone, or // just wait for it to expire. Or you can update the zonal shift to specify another // length of time to expire in. // @@ -117,9 +130,10 @@ type StartZonalShiftOutput struct { ExpiryTime *time.Time // The identifier for the resource to shift away traffic for. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, supported - // resources are Network Load Balancers and Application Load Balancers with - // cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, supported resources are Network Load Balancers and Application + // Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string @@ -129,10 +143,14 @@ type StartZonalShiftOutput struct { // This member is required. StartTime *time.Time - // A status for a zonal shift. The Status for a zonal shift can have one of the - // following values: + // A status for a zonal shift. + // + // The Status for a zonal shift can have one of the following values: + // // - ACTIVE: The zonal shift has been started and active. + // // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // // - CANCELED: The zonal shift was canceled. // // This member is required. diff --git a/service/arczonalshift/api_op_UpdatePracticeRunConfiguration.go b/service/arczonalshift/api_op_UpdatePracticeRunConfiguration.go index 9f8e4d60a6f..f7ca7ab457f 100644 --- a/service/arczonalshift/api_op_UpdatePracticeRunConfiguration.go +++ b/service/arczonalshift/api_op_UpdatePracticeRunConfiguration.go @@ -39,23 +39,28 @@ type UpdatePracticeRunConfigurationInput struct { ResourceIdentifier *string // Add, change, or remove blocked dates for a practice run in zonal autoshift. + // // Optionally, you can block practice runs for specific calendar dates. The format // for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that // dates and times for practice runs are in UTC. Separate multiple blocked dates - // with spaces. For example, if you have an application update scheduled to launch - // on May 1, 2024, and you don't want practice runs to shift traffic away at that - // time, you could set a blocked date for 2024-05-01 . + // with spaces. + // + // For example, if you have an application update scheduled to launch on May 1, + // 2024, and you don't want practice runs to shift traffic away at that time, you + // could set a blocked date for 2024-05-01 . BlockedDates []string // Add, change, or remove windows of days and times for when you can, optionally, - // block Route 53 ARC from starting a practice run for a resource. The format for - // blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, - // that dates and times for practice runs are in UTC. Also, be aware of potential - // time adjustments that might be required for daylight saving time differences. - // Separate multiple blocked windows with spaces. For example, say you run business - // report summaries three days a week. For this scenario, you might set the - // following recurring days and times as blocked windows, for example: - // MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30 . + // block Route 53 ARC from starting a practice run for a resource. + // + // The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you + // specify dates, that dates and times for practice runs are in UTC. Also, be aware + // of potential time adjustments that might be required for daylight saving time + // differences. Separate multiple blocked windows with spaces. + // + // For example, say you run business report summaries three days a week. For this + // scenario, you might set the following recurring days and times as blocked + // windows, for example: MON-20:30-21:30 WED-20:30-21:30 FRI-20:30-21:30 . BlockedWindows []string // Add, change, or remove the Amazon CloudWatch alarm that you optionally specify diff --git a/service/arczonalshift/api_op_UpdateZonalShift.go b/service/arczonalshift/api_op_UpdateZonalShift.go index d3581d4f008..7b5d43402c8 100644 --- a/service/arczonalshift/api_op_UpdateZonalShift.go +++ b/service/arczonalshift/api_op_UpdateZonalShift.go @@ -44,14 +44,20 @@ type UpdateZonalShiftInput struct { // The length of time that you want a zonal shift to be active, which Route 53 ARC // converts to an expiry time (expiration time). Zonal shifts are temporary. You - // can set a zonal shift to be active initially for up to three days (72 hours). If - // you want to still keep traffic away from an Availability Zone, you can update - // the zonal shift and set a new expiration. You can also cancel a zonal shift, - // 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: + // can set a zonal shift to be active initially for up to three days (72 hours). + // + // If you want to still keep traffic away from an Availability Zone, you can + // update the zonal shift and set a new expiration. You can also cancel a zonal + // shift, 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). ExpiresIn *string @@ -79,10 +85,11 @@ type UpdateZonalShiftOutput struct { // The expiry time (expiration time) for a customer-started zonal shift. A zonal // shift is temporary and must be set to expire when you start the zonal shift. You // can initially set a zonal shift to expire in a maximum of three days (72 hours). - // However, you can update a zonal shift to set a new expiration at any time. When - // you start a zonal shift, you specify how long you want it to be active, which - // Route 53 ARC converts to an expiry time (expiration time). You can cancel a - // zonal shift when you're ready to restore traffic to the Availability Zone, or + // However, you can update a zonal shift to set a new expiration at any time. + // + // When you start a zonal shift, you specify how long you want it to be active, + // which Route 53 ARC converts to an expiry time (expiration time). You can cancel + // a zonal shift when you're ready to restore traffic to the Availability Zone, or // just wait for it to expire. Or you can update the zonal shift to specify another // length of time to expire in. // @@ -90,9 +97,10 @@ type UpdateZonalShiftOutput struct { ExpiryTime *time.Time // The identifier for the resource to shift away traffic for. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, supported - // resources are Network Load Balancers and Application Load Balancers with - // cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, supported resources are Network Load Balancers and Application + // Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string @@ -102,10 +110,14 @@ type UpdateZonalShiftOutput struct { // This member is required. StartTime *time.Time - // A status for a zonal shift. The Status for a zonal shift can have one of the - // following values: + // A status for a zonal shift. + // + // The Status for a zonal shift can have one of the following values: + // // - ACTIVE: The zonal shift has been started and active. + // // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // // - CANCELED: The zonal shift was canceled. // // This member is required. diff --git a/service/arczonalshift/doc.go b/service/arczonalshift/doc.go index 3f85324ac38..b093015812a 100644 --- a/service/arczonalshift/doc.go +++ b/service/arczonalshift/doc.go @@ -4,29 +4,36 @@ // for AWS ARC - Zonal Shift. // // Welcome to the Zonal Shift API Reference Guide for Amazon Route 53 Application -// Recovery Controller (Route 53 ARC). You can start a zonal shift to move traffic -// for a load balancer resource away from an Availability Zone to help your -// application recover quickly from an impairment in an Availability Zone. For -// example, you can recover your application from a developer's bad code deployment -// or from an Amazon Web Services infrastructure failure in a single Availability -// Zone. You can also configure zonal autoshift for a load balancer resource. Zonal +// Recovery Controller (Route 53 ARC). +// +// You can start a zonal shift to move traffic for a load balancer resource away +// from an Availability Zone to help your application recover quickly from an +// impairment in an Availability Zone. For example, you can recover your +// application from a developer's bad code deployment or from an Amazon Web +// Services infrastructure failure in a single Availability Zone. +// +// You can also configure zonal autoshift for a load balancer resource. Zonal // autoshift is a capability in Route 53 ARC where Amazon Web Services shifts away // application resource traffic from an Availability Zone, on your behalf, to help // reduce your time to recovery during events. Amazon Web Services shifts away // traffic for resources that are enabled for zonal autoshift whenever Amazon Web // Services determines that there's an issue in the Availability Zone that could -// potentially affect customers. To ensure that zonal autoshift is safe for your -// application, you must also configure practice runs when you enable zonal -// autoshift for a resource. Practice runs start weekly zonal shifts for a -// resource, to shift traffic for the resource out of an Availability Zone. -// Practice runs make sure, on a regular basis, that you have enough capacity in -// all the Availability Zones in an Amazon Web Services Region for your application -// to continue to operate normally when traffic for a resource is shifted away from -// one Availability Zone. You must prescale resource capacity in all Availability -// Zones in the Region where your application is deployed, before you configure -// practice runs or enable zonal autoshift for a resource. You should not rely on -// scaling on demand when an autoshift or practice run starts. For more information -// about using zonal shift and zonal autoshift, see the Amazon Route 53 -// Application Recovery Controller Developer Guide (https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html) -// . +// potentially affect customers. +// +// To ensure that zonal autoshift is safe for your application, you must also +// configure practice runs when you enable zonal autoshift for a resource. Practice +// runs start weekly zonal shifts for a resource, to shift traffic for the resource +// out of an Availability Zone. Practice runs make sure, on a regular basis, that +// you have enough capacity in all the Availability Zones in an Amazon Web Services +// Region for your application to continue to operate normally when traffic for a +// resource is shifted away from one Availability Zone. +// +// You must prescale resource capacity in all Availability Zones in the Region +// where your application is deployed, before you configure practice runs or enable +// zonal autoshift for a resource. You should not rely on scaling on demand when an +// autoshift or practice run starts. +// +// For more information about using zonal shift and zonal autoshift, see the [Amazon Route 53 Application Recovery Controller Developer Guide]. +// +// [Amazon Route 53 Application Recovery Controller Developer Guide]: https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html package arczonalshift diff --git a/service/arczonalshift/options.go b/service/arczonalshift/options.go index 2f88c457456..463191fd7cc 100644 --- a/service/arczonalshift/options.go +++ b/service/arczonalshift/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/arczonalshift/types/enums.go b/service/arczonalshift/types/enums.go index b7c13e1d146..33f800bfb2c 100644 --- a/service/arczonalshift/types/enums.go +++ b/service/arczonalshift/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AppliedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppliedStatus) Values() []AppliedStatus { return []AppliedStatus{ "APPLIED", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AutoshiftAppliedStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoshiftAppliedStatus) Values() []AutoshiftAppliedStatus { return []AutoshiftAppliedStatus{ "APPLIED", @@ -48,6 +50,7 @@ const ( // Values returns all known values for AutoshiftExecutionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AutoshiftExecutionStatus) Values() []AutoshiftExecutionStatus { return []AutoshiftExecutionStatus{ @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "ZonalShiftAlreadyExists", @@ -90,8 +94,9 @@ const ( ) // Values returns all known values for ControlConditionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlConditionType) Values() []ControlConditionType { return []ControlConditionType{ "CLOUDWATCH", @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for PracticeRunOutcome. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PracticeRunOutcome) Values() []PracticeRunOutcome { return []PracticeRunOutcome{ "FAILED", @@ -138,6 +144,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -163,8 +170,9 @@ const ( ) // Values returns all known values for ZonalAutoshiftStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ZonalAutoshiftStatus) Values() []ZonalAutoshiftStatus { return []ZonalAutoshiftStatus{ "ENABLED", @@ -182,8 +190,9 @@ const ( ) // Values returns all known values for ZonalShiftStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ZonalShiftStatus) Values() []ZonalShiftStatus { return []ZonalShiftStatus{ "ACTIVE", diff --git a/service/arczonalshift/types/types.go b/service/arczonalshift/types/types.go index 7f7b8c9bb98..667a65c61bf 100644 --- a/service/arczonalshift/types/types.go +++ b/service/arczonalshift/types/types.go @@ -8,9 +8,12 @@ import ( ) // A complex structure that lists an autoshift that is currently active for a -// managed resource and information about the autoshift. For more information, see -// How zonal autoshift and practice runs work (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html) -// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// managed resource and information about the autoshift. +// +// For more information, see [How zonal autoshift and practice runs work] in the Amazon Route 53 Application Recovery +// Controller Developer Guide. +// +// [How zonal autoshift and practice runs work]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html type AutoshiftInResource struct { // The appliedStatus field specifies which application traffic shift is in effect @@ -19,12 +22,16 @@ type AutoshiftInResource struct { // practice run zonal shifts, customer-started zonal shifts, or an autoshift. The // appliedStatus field for an autoshift for a resource can have one of two values: // APPLIED or NOT_APPLIED . The zonal shift or autoshift that is currently in - // effect for the resource has an applied status set to APPLIED . The overall - // principle for precedence is that zonal shifts that you start as a customer take - // precedence autoshifts, which take precedence over practice runs. That is, - // customer-started zonal shifts > autoshifts > practice run zonal shifts. For more - // information, see How zonal autoshift and practice runs work (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html) - // in the Amazon Route 53 Application Recovery Controller Developer Guide. + // effect for the resource has an applied status set to APPLIED . + // + // The overall principle for precedence is that zonal shifts that you start as a + // customer take precedence autoshifts, which take precedence over practice runs. + // That is, customer-started zonal shifts > autoshifts > practice run zonal shifts. + // + // For more information, see [How zonal autoshift and practice runs work] in the Amazon Route 53 Application Recovery + // Controller Developer Guide. + // + // [How zonal autoshift and practice runs work]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html // // This member is required. AppliedStatus AutoshiftAppliedStatus @@ -53,10 +60,13 @@ type AutoshiftInResource struct { // issue in the Availability Zone that could potentially affect customers. You can // configure zonal autoshift in Route 53 ARC for managed resources in your Amazon // Web Services account in a Region. Supported Amazon Web Services resources are -// automatically registered with Route 53 ARC. Autoshifts are temporary. When the -// Availability Zone recovers, Amazon Web Services ends the autoshift, and traffic -// for the resource is no longer directed to the other Availability Zones in the -// Region. You can stop an autoshift for a resource by disabling zonal autoshift. +// automatically registered with Route 53 ARC. +// +// Autoshifts are temporary. When the Availability Zone recovers, Amazon Web +// Services ends the autoshift, and traffic for the resource is no longer directed +// to the other Availability Zones in the Region. +// +// You can stop an autoshift for a resource by disabling zonal autoshift. type AutoshiftSummary struct { // The Availability Zone that traffic is shifted away from for a resource when @@ -92,9 +102,14 @@ type AutoshiftSummary struct { // CloudWatch alarms, which you create in CloudWatch to use with the practice run. // The alarms that you specify are an outcome alarm, to monitor application health // during practice runs and, optionally, a blocking alarm, to block practice runs -// from starting. Control condition alarms do not apply for autoshifts. For more -// information, see Considerations when you configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html) -// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// from starting. +// +// Control condition alarms do not apply for autoshifts. +// +// For more information, see [Considerations when you configure zonal autoshift] in the Amazon Route 53 Application Recovery +// Controller Developer Guide. +// +// [Considerations when you configure zonal autoshift]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html type ControlCondition struct { // The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify @@ -113,13 +128,16 @@ type ControlCondition struct { } // A complex structure for a managed resource in an Amazon Web Services account -// with information about zonal shifts and autoshifts. A managed resource is a load -// balancer that has been registered with Route 53 ARC by Elastic Load Balancing. -// You can start a zonal shift in Route 53 ARC for a managed resource to -// temporarily move traffic for the resource away from an Availability Zone in an -// Amazon Web Services Region. You can also configure zonal autoshift for a managed -// resource. At this time, managed resources are Network Load Balancers and -// Application Load Balancers with cross-zone load balancing turned off. +// with information about zonal shifts and autoshifts. +// +// A managed resource is a load balancer that has been registered with Route 53 +// ARC by Elastic Load Balancing. You can start a zonal shift in Route 53 ARC for a +// managed resource to temporarily move traffic for the resource away from an +// Availability Zone in an Amazon Web Services Region. You can also configure zonal +// autoshift for a managed resource. +// +// At this time, managed resources are Network Load Balancers and Application Load +// Balancers with cross-zone load balancing turned off. type ManagedResourceSummary struct { // The Availability Zones that a resource is deployed in. @@ -145,8 +163,10 @@ type ManagedResourceSummary struct { // When you configure a practice run for a resource so that a practice run // configuration exists, Route 53 ARC sets this value to ENABLED . If a you have // not configured a practice run for the resource, or delete a practice run - // configuration, Route 53 ARC sets the value to DISABLED . Route 53 ARC updates - // this status; you can't set a practice run status to ENABLED or DISABLED . + // configuration, Route 53 ARC sets the value to DISABLED . + // + // Route 53 ARC updates this status; you can't set a practice run status to ENABLED + // or DISABLED . PracticeRunStatus ZonalAutoshiftStatus // The status of autoshift for a resource. When you configure zonal autoshift for @@ -161,10 +181,11 @@ type ManagedResourceSummary struct { // A practice run configuration for a resource includes the Amazon CloudWatch // alarms that you've specified for a practice run, as well as any blocked dates or -// blocked windows for the practice run. You can update or delete a practice run -// configuration. Before you delete a practice run configuration, you must disable -// zonal autoshift for the resource. A practice run configuration is required when -// zonal autoshift is enabled. +// blocked windows for the practice run. +// +// You can update or delete a practice run configuration. Before you delete a +// practice run configuration, you must disable zonal autoshift for the resource. A +// practice run configuration is required when zonal autoshift is enabled. type PracticeRunConfiguration struct { // The outcome alarm for practice runs is an alarm that you specify that ends a @@ -174,14 +195,16 @@ type PracticeRunConfiguration struct { OutcomeAlarms []ControlCondition // An array of one or more dates that you can specify when Amazon Web Services - // does not start practice runs for a resource. Specify blocked dates, in UTC, in - // the format YYYY-MM-DD , separated by spaces. + // does not start practice runs for a resource. + // + // Specify blocked dates, in UTC, in the format YYYY-MM-DD , separated by spaces. BlockedDates []string // An array of one or more windows of days and times that you can block Route 53 - // ARC from starting practice runs for a resource. Specify the blocked windows in - // UTC, using the format DAY:HH:MM-DAY:HH:MM , separated by spaces. For example, - // MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 . + // ARC from starting practice runs for a resource. + // + // Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM , + // separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30 . BlockedWindows []string // The blocking alarm for practice runs is an optional alarm that you can specify @@ -201,12 +224,16 @@ type ZonalShiftInResource struct { // practice run zonal shifts, customer-started zonal shifts, or an autoshift. The // appliedStatus field for an autoshift for a resource can have one of two values: // APPLIED or NOT_APPLIED . The zonal shift or autoshift that is currently in - // effect for the resource has an applied status set to APPLIED . The overall - // principle for precedence is that zonal shifts that you start as a customer take - // precedence autoshifts, which take precedence over practice runs. That is, - // customer-started zonal shifts > autoshifts > practice run zonal shifts. For more - // information, see How zonal autoshift and practice runs work (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html) - // in the Amazon Route 53 Application Recovery Controller Developer Guide. + // effect for the resource has an applied status set to APPLIED . + // + // The overall principle for precedence is that zonal shifts that you start as a + // customer take precedence autoshifts, which take precedence over practice runs. + // That is, customer-started zonal shifts > autoshifts > practice run zonal shifts. + // + // For more information, see [How zonal autoshift and practice runs work] in the Amazon Route 53 Application Recovery + // Controller Developer Guide. + // + // [How zonal autoshift and practice runs work]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html // // This member is required. AppliedStatus AppliedStatus @@ -229,10 +256,11 @@ type ZonalShiftInResource struct { // The expiry time (expiration time) for a customer-started zonal shift. A zonal // shift is temporary and must be set to expire when you start the zonal shift. You // can initially set a zonal shift to expire in a maximum of three days (72 hours). - // However, you can update a zonal shift to set a new expiration at any time. When - // you start a zonal shift, you specify how long you want it to be active, which - // Route 53 ARC converts to an expiry time (expiration time). You can cancel a - // zonal shift when you're ready to restore traffic to the Availability Zone, or + // However, you can update a zonal shift to set a new expiration at any time. + // + // When you start a zonal shift, you specify how long you want it to be active, + // which Route 53 ARC converts to an expiry time (expiration time). You can cancel + // a zonal shift when you're ready to restore traffic to the Availability Zone, or // just wait for it to expire. Or you can update the zonal shift to specify another // length of time to expire in. // @@ -240,9 +268,10 @@ type ZonalShiftInResource struct { ExpiryTime *time.Time // The identifier for the resource to include in a zonal shift. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, you can only - // start a zonal shift for Network Load Balancers and Application Load Balancers - // with cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, you can only start a zonal shift for Network Load Balancers and + // Application Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string @@ -259,20 +288,26 @@ type ZonalShiftInResource struct { // The outcome, or end state, returned for a practice run. The following values // can be returned: + // // - PENDING: Outcome value when a practice run is in progress. + // // - SUCCEEDED: Outcome value when the outcome alarm specified for the practice // run configuration does not go into an ALARM state during the practice run, and // the practice run was not interrupted before it completed the expected 30 minute // zonal shift. + // // - INTERRUPTED: Outcome value when the practice run was stopped before the // expected 30 minute zonal shift duration, or there was another problem with the // practice run that created an inconclusive outcome. + // // - FAILED: Outcome value when the outcome alarm specified for the practice run // configuration goes into an ALARM state during the practice run, and the // practice run was not interrupted before it completed. - // For more information about practice run outcomes, see Considerations when you - // configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html) - // in the Amazon Route 53 Application Recovery Controller Developer Guide. + // + // For more information about practice run outcomes, see [Considerations when you configure zonal autoshift] in the Amazon Route 53 + // Application Recovery Controller Developer Guide. + // + // [Considerations when you configure zonal autoshift]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html PracticeRunOutcome PracticeRunOutcome noSmithyDocumentSerde @@ -280,11 +315,12 @@ type ZonalShiftInResource struct { // Lists information about zonal shifts in Amazon Route 53 Application Recovery // Controller, including zonal shifts that you start yourself and zonal shifts that -// Route 53 ARC starts on your behalf for practice runs with zonal autoshift. Zonal -// shifts are temporary, including customer-started zonal shifts and the zonal -// autoshift practice run zonal shifts that Route 53 ARC starts weekly, on your -// behalf. A zonal shift that a customer starts can be active for up to three days -// (72 hours). A practice run zonal shift has a 30 minute duration. +// Route 53 ARC starts on your behalf for practice runs with zonal autoshift. +// +// Zonal shifts are temporary, including customer-started zonal shifts and the +// zonal autoshift practice run zonal shifts that Route 53 ARC starts weekly, on +// your behalf. A zonal shift that a customer starts can be active for up to three +// days (72 hours). A practice run zonal shift has a 30 minute duration. type ZonalShiftSummary struct { // The Availability Zone that traffic is moved away from for a resource when you @@ -305,10 +341,11 @@ type ZonalShiftSummary struct { // The expiry time (expiration time) for a customer-started zonal shift. A zonal // shift is temporary and must be set to expire when you start the zonal shift. You // can initially set a zonal shift to expire in a maximum of three days (72 hours). - // However, you can update a zonal shift to set a new expiration at any time. When - // you start a zonal shift, you specify how long you want it to be active, which - // Route 53 ARC converts to an expiry time (expiration time). You can cancel a - // zonal shift when you're ready to restore traffic to the Availability Zone, or + // However, you can update a zonal shift to set a new expiration at any time. + // + // When you start a zonal shift, you specify how long you want it to be active, + // which Route 53 ARC converts to an expiry time (expiration time). You can cancel + // a zonal shift when you're ready to restore traffic to the Availability Zone, or // just wait for it to expire. Or you can update the zonal shift to specify another // length of time to expire in. // @@ -316,9 +353,10 @@ type ZonalShiftSummary struct { ExpiryTime *time.Time // The identifier for the resource to include in a zonal shift. The identifier is - // the Amazon Resource Name (ARN) for the resource. At this time, you can only - // start a zonal shift for Network Load Balancers and Application Load Balancers - // with cross-zone load balancing turned off. + // the Amazon Resource Name (ARN) for the resource. + // + // At this time, you can only start a zonal shift for Network Load Balancers and + // Application Load Balancers with cross-zone load balancing turned off. // // This member is required. ResourceIdentifier *string @@ -328,10 +366,14 @@ type ZonalShiftSummary struct { // This member is required. StartTime *time.Time - // A status for a zonal shift. The Status for a zonal shift can have one of the - // following values: + // A status for a zonal shift. + // + // The Status for a zonal shift can have one of the following values: + // // - ACTIVE: The zonal shift has been started and active. + // // - EXPIRED: The zonal shift has expired (the expiry time was exceeded). + // // - CANCELED: The zonal shift was canceled. // // This member is required. @@ -344,19 +386,25 @@ type ZonalShiftSummary struct { // The outcome, or end state, of a practice run. The following values can be // returned: + // // - PENDING: Outcome value when the practice run is in progress. + // // - SUCCEEDED: Outcome value when the outcome alarm specified for the practice // run configuration does not go into an ALARM state during the practice run, and // the practice run was not interrupted before it completed. + // // - INTERRUPTED: Outcome value when the practice run did not run for the // expected 30 minutes or there was another problem with the practice run that // created an inconclusive outcome. + // // - FAILED: Outcome value when the outcome alarm specified for the practice run // configuration goes into an ALARM state during the practice run, and the // practice run was not interrupted before it completed. - // For more information about practice run outcomes, see Considerations when you - // configure zonal autoshift (https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html) - // in the Amazon Route 53 Application Recovery Controller Developer Guide. + // + // For more information about practice run outcomes, see [Considerations when you configure zonal autoshift] in the Amazon Route 53 + // Application Recovery Controller Developer Guide. + // + // [Considerations when you configure zonal autoshift]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html PracticeRunOutcome PracticeRunOutcome noSmithyDocumentSerde diff --git a/service/artifact/options.go b/service/artifact/options.go index 8235a27b0a3..8dbf9c1a6aa 100644 --- a/service/artifact/options.go +++ b/service/artifact/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/artifact/types/enums.go b/service/artifact/types/enums.go index 7539e311b66..8ef464597d5 100644 --- a/service/artifact/types/enums.go +++ b/service/artifact/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AcceptanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceptanceType) Values() []AcceptanceType { return []AcceptanceType{ "PASSTHROUGH", @@ -36,8 +37,9 @@ const ( // Values returns all known values for NotificationSubscriptionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationSubscriptionStatus) Values() []NotificationSubscriptionStatus { return []NotificationSubscriptionStatus{ "SUBSCRIBED", @@ -56,8 +58,9 @@ const ( ) // Values returns all known values for PublishedState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PublishedState) Values() []PublishedState { return []PublishedState{ "PUBLISHED", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for UploadState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UploadState) Values() []UploadState { return []UploadState{ "PROCESSING", @@ -100,6 +104,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/athena/api_op_BatchGetNamedQuery.go b/service/athena/api_op_BatchGetNamedQuery.go index 9d86af21822..8343d9f7459 100644 --- a/service/athena/api_op_BatchGetNamedQuery.go +++ b/service/athena/api_op_BatchGetNamedQuery.go @@ -13,13 +13,11 @@ import ( // 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. +// to the workgroup in which the queries were saved. Use ListNamedQueriesInputto 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 BatchGetQueryExecutionInputto get details about each +// unique query execution, and ListQueryExecutionsInputto 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_BatchGetQueryExecution.go b/service/athena/api_op_BatchGetQueryExecution.go index 6029573fd03..4687dfe1aa6 100644 --- a/service/athena/api_op_BatchGetQueryExecution.go +++ b/service/athena/api_op_BatchGetQueryExecution.go @@ -14,9 +14,8 @@ 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 BatchGetNamedQueryInputto 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 5a52c5f75da..86f0edf3610 100644 --- a/service/athena/api_op_CreateDataCatalog.go +++ b/service/athena/api_op_CreateDataCatalog.go @@ -50,21 +50,32 @@ type CreateDataCatalogInput struct { // 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 + // + // 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 + // + // 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 + // + // 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 + // 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. diff --git a/service/athena/api_op_CreateNamedQuery.go b/service/athena/api_op_CreateNamedQuery.go index 27baf77932c..1c96583cee7 100644 --- a/service/athena/api_op_CreateNamedQuery.go +++ b/service/athena/api_op_CreateNamedQuery.go @@ -47,11 +47,12 @@ type CreateNamedQueryInput struct { // 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 - // 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 - // must provide this token or the action will fail. + // 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 must provide this token or the action will fail. ClientRequestToken *string // The query description. diff --git a/service/athena/api_op_CreateNotebook.go b/service/athena/api_op_CreateNotebook.go index 1ea346d9dfb..2a732883455 100644 --- a/service/athena/api_op_CreateNotebook.go +++ b/service/athena/api_op_CreateNotebook.go @@ -41,11 +41,12 @@ type CreateNotebookInput struct { 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. + // 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 58f5decdd90..252a4e4c982 100644 --- a/service/athena/api_op_CreatePresignedNotebookUrl.go +++ b/service/athena/api_op_CreatePresignedNotebookUrl.go @@ -13,8 +13,9 @@ 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]. +// +// [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 219158fb91d..d8e7d0ac132 100644 --- a/service/athena/api_op_CreateWorkGroup.go +++ b/service/athena/api_op_CreateWorkGroup.go @@ -42,8 +42,7 @@ type CreateWorkGroupInput struct { // 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 - // WorkGroupConfiguration override client-side settings. See - // WorkGroupConfiguration$EnforceWorkGroupConfiguration . + // WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. Configuration *types.WorkGroupConfiguration // The workgroup description. diff --git a/service/athena/api_op_GetQueryResults.go b/service/athena/api_op_GetQueryResults.go index a34c8896bb3..893bdfc3ff0 100644 --- a/service/athena/api_op_GetQueryResults.go +++ b/service/athena/api_op_GetQueryResults.go @@ -12,17 +12,21 @@ 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) +// from the Athena query results location in Amazon S3. For more information, see [Working with query results, recent queries, and output files] // 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. +// returns results. Use StartQueryExecutionto 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 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_GetQueryRuntimeStatistics.go b/service/athena/api_op_GetQueryRuntimeStatistics.go index a643e5c373f..b0c439b8ad9 100644 --- a/service/athena/api_op_GetQueryRuntimeStatistics.go +++ b/service/athena/api_op_GetQueryRuntimeStatistics.go @@ -13,10 +13,9 @@ import ( // Returns query execution runtime statistics related to a single execution of a // query if you have access to the workgroup in which the query ran. Query -// execution runtime statistics are returned only when QueryExecutionStatus$State -// is in a SUCCEEDED or FAILED state. Stage-level input and output row count and -// data size statistics are not shown when a query has row-level filters defined in -// Lake Formation. +// execution runtime statistics are returned only when QueryExecutionStatus$Stateis in a SUCCEEDED or FAILED +// state. Stage-level input and output row count and data size statistics are not +// shown when a query has row-level filters defined in Lake Formation. func (c *Client) GetQueryRuntimeStatistics(ctx context.Context, params *GetQueryRuntimeStatisticsInput, optFns ...func(*Options)) (*GetQueryRuntimeStatisticsOutput, error) { if params == nil { params = &GetQueryRuntimeStatisticsInput{} diff --git a/service/athena/api_op_GetSession.go b/service/athena/api_op_GetSession.go index 15d0150ba7c..1b58f7757db 100644 --- a/service/athena/api_op_GetSession.go +++ b/service/athena/api_op_GetSession.go @@ -47,7 +47,7 @@ type GetSessionOutput struct { 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 . + // 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 278e6c0467b..bde46cc6825 100644 --- a/service/athena/api_op_ImportNotebook.go +++ b/service/athena/api_op_ImportNotebook.go @@ -50,11 +50,12 @@ type ImportNotebookInput struct { 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. + // 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 // A URI that specifies the Amazon S3 location of a notebook file in ipynb format. diff --git a/service/athena/api_op_ListCalculationExecutions.go b/service/athena/api_op_ListCalculationExecutions.go index 1433f3454e4..294e2c4d37b 100644 --- a/service/athena/api_op_ListCalculationExecutions.go +++ b/service/athena/api_op_ListCalculationExecutions.go @@ -44,14 +44,25 @@ type ListCalculationExecutionsInput struct { 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. + // 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_ListDataCatalogs.go b/service/athena/api_op_ListDataCatalogs.go index 483bbe1de48..89d3afde048 100644 --- a/service/athena/api_op_ListDataCatalogs.go +++ b/service/athena/api_op_ListDataCatalogs.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the data catalogs in the current Amazon Web Services account. In the -// Athena console, data catalogs are listed as "data sources" on the Data sources -// page under the Data source name column. +// Lists the data catalogs in the current Amazon Web Services account. +// +// In the Athena console, data catalogs are listed as "data sources" on the Data +// sources page under the Data source name column. func (c *Client) ListDataCatalogs(ctx context.Context, params *ListDataCatalogsInput, optFns ...func(*Options)) (*ListDataCatalogsOutput, error) { if params == nil { params = &ListDataCatalogsInput{} diff --git a/service/athena/api_op_ListExecutors.go b/service/athena/api_op_ListExecutors.go index 10d32473def..eafe4614428 100644 --- a/service/athena/api_op_ListExecutors.go +++ b/service/athena/api_op_ListExecutors.go @@ -37,11 +37,18 @@ type ListExecutorsInput struct { SessionId *string // A filter for a specific executor state. A description of each state follows. - // CREATING - The executor is being started, including acquiring resources. CREATED - // - The executor has been started. REGISTERED - The executor has been registered. - // TERMINATING - The executor is in the process of shutting down. TERMINATED - The - // executor is no longer running. FAILED - Due to a failure, the executor is no - // longer running. + // + // CREATING - The executor is being started, including acquiring resources. + // + // CREATED - The executor has been started. + // + // REGISTERED - The executor has been registered. + // + // TERMINATING - The executor is in the process of shutting down. + // + // TERMINATED - The executor is no longer running. + // + // FAILED - Due to a failure, the executor is no longer running. ExecutorStateFilter types.ExecutorState // The maximum number of executors to return. diff --git a/service/athena/api_op_ListSessions.go b/service/athena/api_op_ListSessions.go index aba3e8102ae..0fc0061f694 100644 --- a/service/athena/api_op_ListSessions.go +++ b/service/athena/api_op_ListSessions.go @@ -45,13 +45,23 @@ type ListSessionsInput struct { NextToken *string // A filter for a specific session state. 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. 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 are no longer running. + // + // 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. + // + // 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 are no longer running. StateFilter types.SessionState noSmithyDocumentSerde diff --git a/service/athena/api_op_ListWorkGroups.go b/service/athena/api_op_ListWorkGroups.go index c1e1543a1dd..12762705cdb 100644 --- a/service/athena/api_op_ListWorkGroups.go +++ b/service/athena/api_op_ListWorkGroups.go @@ -47,8 +47,8 @@ type ListWorkGroupsOutput struct { // pass in the NextToken from the response object of the previous page call. NextToken *string - // A list of WorkGroupSummary objects that include the names, descriptions, - // creation times, and states for each workgroup. + // A list of WorkGroupSummary objects that include the names, descriptions, creation times, and + // states for each workgroup. WorkGroups []types.WorkGroupSummary // Metadata pertaining to the operation's result. diff --git a/service/athena/api_op_StartCalculationExecution.go b/service/athena/api_op_StartCalculationExecution.go index 4e1c5034e21..d0504690a42 100644 --- a/service/athena/api_op_StartCalculationExecution.go +++ b/service/athena/api_op_StartCalculationExecution.go @@ -12,11 +12,10 @@ import ( ) // Submits calculations for execution within a session. You can supply the code to -// run as an inline code block within the request. The request syntax requires the -// StartCalculationExecutionRequest$CodeBlock parameter or the -// CalculationConfiguration$CodeBlock parameter, but not both. Because -// CalculationConfiguration$CodeBlock is deprecated, use the -// StartCalculationExecutionRequest$CodeBlock parameter instead. +// run as an inline code block within the request. +// +// The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. +// Because CalculationConfiguration$CodeBlockis deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead. func (c *Client) StartCalculationExecution(ctx context.Context, params *StartCalculationExecutionInput, optFns ...func(*Options)) (*StartCalculationExecutionOutput, error) { if params == nil { params = &StartCalculationExecutionInput{} @@ -48,14 +47,16 @@ type StartCalculationExecutionInput struct { // calculation is idempotent (executes only once). If another // StartCalculationExecutionRequest is received, the same response is returned and // another calculation is not created. If a parameter has changed, 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 must provide this token or the action will fail. + // 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 must provide this token or the action will fail. ClientRequestToken *string // A string that contains the code of the calculation. Use this parameter instead - // of CalculationConfiguration$CodeBlock , which is deprecated. + // of CalculationConfiguration$CodeBlock, which is deprecated. CodeBlock *string // A description of the calculation. @@ -69,13 +70,23 @@ type StartCalculationExecutionOutput struct { // The calculation execution UUID. CalculationExecutionId *string - // 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. + // 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. State types.CalculationExecutionState // Metadata pertaining to the operation's result. diff --git a/service/athena/api_op_StartQueryExecution.go b/service/athena/api_op_StartQueryExecution.go index b050f7bd5bd..f9d79976bbe 100644 --- a/service/athena/api_op_StartQueryExecution.go +++ b/service/athena/api_op_StartQueryExecution.go @@ -13,10 +13,10 @@ import ( // 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 -// Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the -// Amazon Athena User Guide. +// external catalog requires GetDataCatalogpermission to the catalog. For code samples using the +// Amazon Web Services SDK for Java, see [Examples and Code Samples]in the Amazon Athena User Guide. +// +// [Examples and Code Samples]: http://docs.aws.amazon.com/athena/latest/ug/code-samples.html func (c *Client) StartQueryExecution(ctx context.Context, params *StartQueryExecutionInput, optFns ...func(*Options)) (*StartQueryExecutionOutput, error) { if params == nil { params = &StartQueryExecutionInput{} @@ -45,11 +45,12 @@ type StartQueryExecutionInput struct { // error is returned if a parameter, such as QueryString , has changed. A call to // StartQueryExecution that uses a previous client request token returns the same // QueryExecutionId even if the requester doesn't have permission on the tables - // specified in QueryString . 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 must provide this token or the action - // will fail. + // specified in QueryString . + // + // 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 must provide this token or the action will fail. ClientRequestToken *string // A list of values for the parameters in a query. The values are applied @@ -64,8 +65,7 @@ type StartQueryExecutionInput struct { // execution. If the query runs in a workgroup, then workgroup's settings may // 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 . + // the WorkGroupConfiguration. See 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 b242af231d7..ffdd8842968 100644 --- a/service/athena/api_op_StartSession.go +++ b/service/athena/api_op_StartSession.go @@ -44,11 +44,12 @@ type StartSessionInput struct { // A unique case-sensitive string used to ensure the request to create the session // is idempotent (executes only once). If another StartSessionRequest is received, // the same response is returned and another session is not created. If a parameter - // has changed, 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 must provide this token or the action - // will fail. + // has changed, 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 must provide this token or the action will fail. ClientRequestToken *string // The session description. @@ -58,7 +59,7 @@ type StartSessionInput struct { // 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 . + // NotebookId . See EngineConfiguration$AdditionalConfigs. NotebookVersion *string // The idle timeout in minutes for the session. @@ -72,14 +73,24 @@ type StartSessionOutput struct { // The session ID. SessionId *string - // 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. - // 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 - // are no longer running. + // 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. + // + // 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 are no longer running. State types.SessionState // Metadata pertaining to the operation's result. diff --git a/service/athena/api_op_StopCalculationExecution.go b/service/athena/api_op_StopCalculationExecution.go index 501848439e5..a6e0fc0e7c0 100644 --- a/service/athena/api_op_StopCalculationExecution.go +++ b/service/athena/api_op_StopCalculationExecution.go @@ -13,11 +13,12 @@ import ( // 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. +// , 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{} @@ -45,13 +46,23 @@ type StopCalculationExecutionInput struct { type StopCalculationExecutionOutput struct { - // 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. + // 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. State types.CalculationExecutionState // Metadata pertaining to the operation's result. diff --git a/service/athena/api_op_TagResource.go b/service/athena/api_op_TagResource.go index ee24fc80c48..58566d98161 100644 --- a/service/athena/api_op_TagResource.go +++ b/service/athena/api_op_TagResource.go @@ -16,12 +16,14 @@ import ( // you define. For example, you can use tags to categorize Athena workgroups, data // catalogs, or capacity reservations by purpose, owner, or environment. Use a // consistent set of tag keys to make it easier to search and filter the resources -// 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 -// specify more than one tag, separate them by commas. +// in your account. For best practices, see [Tagging Best Practices]. 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 specify more than one tag, separate +// them by commas. +// +// [Tagging Best Practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/athena/api_op_TerminateSession.go b/service/athena/api_op_TerminateSession.go index 2db7fbbfe0a..82d70ef8d82 100644 --- a/service/athena/api_op_TerminateSession.go +++ b/service/athena/api_op_TerminateSession.go @@ -43,14 +43,24 @@ type TerminateSessionInput struct { 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. - // 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 - // are no longer running. + // 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. + // + // 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 are no longer running. State types.SessionState // Metadata pertaining to the operation's result. diff --git a/service/athena/api_op_UpdateDataCatalog.go b/service/athena/api_op_UpdateDataCatalog.go index 5e6cf902eb9..4f8bb078b95 100644 --- a/service/athena/api_op_UpdateDataCatalog.go +++ b/service/athena/api_op_UpdateDataCatalog.go @@ -48,18 +48,25 @@ type UpdateDataCatalogInput struct { // 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 + // + // 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 + // + // 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 + // + // 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 725e976aa43..faad89f8036 100644 --- a/service/athena/api_op_UpdateNotebook.go +++ b/service/athena/api_op_UpdateNotebook.go @@ -45,11 +45,12 @@ type UpdateNotebookInput struct { 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. + // 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 fa0ecc2497e..ff336768f61 100644 --- a/service/athena/api_op_UpdateNotebookMetadata.go +++ b/service/athena/api_op_UpdateNotebookMetadata.go @@ -39,11 +39,12 @@ type UpdateNotebookMetadataInput struct { 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. + // 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 c90bd04d443..719025bf051 100644 --- a/service/athena/doc.go +++ b/service/athena/doc.go @@ -8,11 +8,13 @@ // S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so // there is no infrastructure to set up or manage. You pay only for the queries you // run. Athena scales automatically—executing queries in parallel—so results are -// fast, even with large datasets and complex queries. For more information, see -// What is Amazon Athena (http://docs.aws.amazon.com/athena/latest/ug/what-is.html) -// 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) -// . +// fast, even with large datasets and complex queries. For more information, see [What is Amazon Athena] +// 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]. +// +// [Accessing Amazon Athena with JDBC]: https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html +// [What is Amazon Athena]: http://docs.aws.amazon.com/athena/latest/ug/what-is.html package athena diff --git a/service/athena/options.go b/service/athena/options.go index f3f1f5fa505..9c622d8e97d 100644 --- a/service/athena/options.go +++ b/service/athena/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/athena/types/enums.go b/service/athena/types/enums.go index 9814aa6179c..d2f5c2489fb 100644 --- a/service/athena/types/enums.go +++ b/service/athena/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "DIRECTORY_IDENTITY", @@ -34,6 +35,7 @@ const ( // Values returns all known values for CalculationExecutionState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CalculationExecutionState) Values() []CalculationExecutionState { return []CalculationExecutionState{ @@ -59,6 +61,7 @@ const ( // Values returns all known values for CapacityAllocationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CapacityAllocationStatus) Values() []CapacityAllocationStatus { return []CapacityAllocationStatus{ @@ -82,6 +85,7 @@ const ( // Values returns all known values for CapacityReservationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationStatus) Values() []CapacityReservationStatus { return []CapacityReservationStatus{ @@ -104,8 +108,9 @@ const ( ) // Values returns all known values for ColumnNullable. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnNullable) Values() []ColumnNullable { return []ColumnNullable{ "NOT_NULL", @@ -124,8 +129,9 @@ const ( ) // Values returns all known values for DataCatalogType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataCatalogType) Values() []DataCatalogType { return []DataCatalogType{ "LAMBDA", @@ -144,8 +150,9 @@ const ( ) // Values returns all known values for EncryptionOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionOption) Values() []EncryptionOption { return []EncryptionOption{ "SSE_S3", @@ -167,8 +174,9 @@ const ( ) // Values returns all known values for ExecutorState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutorState) Values() []ExecutorState { return []ExecutorState{ "CREATING", @@ -190,8 +198,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -208,8 +217,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -228,8 +238,9 @@ const ( ) // Values returns all known values for QueryExecutionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryExecutionState) Values() []QueryExecutionState { return []QueryExecutionState{ "QUEUED", @@ -248,8 +259,9 @@ const ( ) // Values returns all known values for S3AclOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3AclOption) Values() []S3AclOption { return []S3AclOption{ "BUCKET_OWNER_FULL_CONTROL", @@ -271,8 +283,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -296,8 +309,9 @@ const ( ) // Values returns all known values for StatementType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatementType) Values() []StatementType { return []StatementType{ "DDL", @@ -314,8 +328,9 @@ const ( ) // Values returns all known values for ThrottleReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThrottleReason) Values() []ThrottleReason { return []ThrottleReason{ "CONCURRENT_QUERY_LIMIT_EXCEEDED", @@ -331,8 +346,9 @@ const ( ) // Values returns all known values for WorkGroupState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkGroupState) Values() []WorkGroupState { return []WorkGroupState{ "ENABLED", diff --git a/service/athena/types/types.go b/service/athena/types/types.go index 33cf4c64087..9a627dcf3c0 100644 --- a/service/athena/types/types.go +++ b/service/athena/types/types.go @@ -10,8 +10,9 @@ 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) -// in the Amazon S3 User Guide. +// Object Ownership, see [Object Ownership settings]in the Amazon S3 User Guide. +// +// [Object Ownership settings]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview type AclConfiguration struct { // The Amazon S3 canned ACL that Athena should specify when storing query results. @@ -19,8 +20,9 @@ type AclConfiguration struct { // 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) - // in the Amazon S3 User Guide. + // ACLs, see [Canned ACL]in the Amazon S3 User Guide. + // + // [Canned ACL]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl // // This member is required. S3AclOption S3AclOption @@ -49,16 +51,23 @@ type ApplicationDPUSizes struct { type AthenaError struct { // An integer value that specifies the category of a query failure error. The - // following list shows the category for each integer value. 1 - System 2 - User 3 - // - Other + // following list shows the category for each integer value. + // + // 1 - System + // + // 2 - User + // + // 3 - Other ErrorCategory *int32 // 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) - // in the Amazon Athena User Guide. + // error. For the meaning of specific values, see the [Error Type Reference]in the Amazon Athena User + // Guide. + // + // [Error Type Reference]: https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference ErrorType *int32 // True if the query might succeed if resubmitted. @@ -113,13 +122,24 @@ type CalculationStatus struct { CompletionDateTime *time.Time // The state of the calculation execution. 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. + // + // 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. State CalculationExecutionState // The reason for the calculation state change (for example, the calculation was @@ -325,8 +345,9 @@ type Database struct { noSmithyDocumentSerde } -// Contains information about a data catalog in an Amazon Web Services account. In -// the Athena console, data catalogs are listed as "data sources" on the Data +// Contains information about a data catalog in an Amazon Web Services account. +// +// In the Athena console, data catalogs are listed as "data sources" on the Data // sources page under the Data source name column. type DataCatalog struct { @@ -349,21 +370,32 @@ 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 + // + // 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 + // + // 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 + // + // 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 + // 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. @@ -402,10 +434,12 @@ 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. + // 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 @@ -427,9 +461,8 @@ type EngineConfiguration struct { // Contains additional notebook engine MAP parameter mappings in the form of // key-value pairs. To specify an Athena notebook that the Jupyter server will - // download and serve, specify a value for the StartSessionRequest$NotebookVersion - // field, and then add a key named NotebookId to AdditionalConfigs that has the - // value of the Athena notebook ID. + // download and serve, specify a value for the StartSessionRequest$NotebookVersionfield, and then add a key named + // NotebookId to AdditionalConfigs that has the value of the Athena notebook ID. AdditionalConfigs map[string]string // The number of DPUs to use for the coordinator. A coordinator is a special @@ -482,11 +515,18 @@ type ExecutorsSummary struct { ExecutorSize *int64 // The processing state of the executor. A description of each state follows. - // CREATING - The executor is being started, including acquiring resources. CREATED - // - The executor has been started. REGISTERED - The executor has been registered. - // TERMINATING - The executor is in the process of shutting down. TERMINATED - The - // executor is no longer running. FAILED - Due to a failure, the executor is no - // longer running. + // + // CREATING - The executor is being started, including acquiring resources. + // + // CREATED - The executor has been started. + // + // REGISTERED - The executor has been registered. + // + // TERMINATING - The executor is in the process of shutting down. + // + // TERMINATED - The executor is no longer running. + // + // FAILED - Due to a failure, the executor is no longer running. ExecutorState ExecutorState // The type of executor used for the application ( COORDINATOR , GATEWAY , or @@ -701,8 +741,9 @@ 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]in the Amazon Athena User Guide. + // + // [Working with Query Results, Output Files, and Query History]: https://docs.aws.amazon.com/athena/latest/ug/querying.html DataManifestLocation *string // The number of bytes in the data that was queried. @@ -755,9 +796,11 @@ type QueryExecutionStatus struct { // 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 . + // 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 QueryExecutionState // Further detail about the status of the query. @@ -846,7 +889,7 @@ type QueryRuntimeStatisticsTimeline struct { // the query back to the queue. QueryQueueTimeInMillis *int64 - // The number of milliseconds that Athena spends on preprocessing before it + // The number of milliseconds that Athena spends on preprocessing before it // submits the query to the engine. ServicePreProcessingTimeInMillis *int64 @@ -925,10 +968,9 @@ type ResultConfiguration struct { // 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) - // . + // results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings]. + // + // [Workgroup Settings 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 @@ -936,35 +978,35 @@ type ResultConfiguration struct { // 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) - // . + // the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings]. + // + // [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 - // 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) - // . + // 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$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings]. + // + // [Workgroup Settings 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 - // 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 . + // 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]. If workgroup settings override client-side settings, + // then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration. + // + // [Working with query results, recent queries, and output files]: https://docs.aws.amazon.com/athena/latest/ug/querying.html OutputLocation *string noSmithyDocumentSerde @@ -981,36 +1023,36 @@ type ResultConfigurationUpdates struct { 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 - // 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) - // . + // 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$EnforceWorkGroupConfigurationand [Workgroup Settings Override Client-Side Settings]. + // + // [Workgroup Settings 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]. 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. + // + // [Working with query results, recent queries, and output files]: https://docs.aws.amazon.com/athena/latest/ug/querying.html OutputLocation *string // 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 - // 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) - // . + // ResultConfiguration is updated with the new value. For more information, see [Workgroup Settings Override Client-Side Settings]. + // + // [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 @@ -1019,17 +1061,18 @@ 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]. + // + // [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 - // 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) - // . + // 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]. + // + // [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 @@ -1037,9 +1080,9 @@ type ResultConfigurationUpdates struct { // 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) - // . + // updated with the new value. For more information, see [Workgroup Settings Override Client-Side Settings]. + // + // [Workgroup Settings Override Client-Side Settings]: https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html RemoveOutputLocation *bool noSmithyDocumentSerde @@ -1085,8 +1128,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 . +// the column structure and data types. To return a ResultSet object, use GetQueryResults. type ResultSet struct { // The metadata that describes the column structure and data types of a table of @@ -1100,7 +1142,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. @@ -1164,14 +1206,24 @@ type SessionStatus struct { // The date and time that the session started. StartDateTime *time.Time - // 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. - // 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 - // are no longer running. + // 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. + // + // 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 are no longer running. State SessionState // The reason for the session state change (for example, canceled because the @@ -1236,12 +1288,14 @@ type TableMetadata struct { // optional value, both of which you define. For example, you can use tags to // categorize Athena resources by purpose, owner, or environment. Use a consistent // set of tag keys to make it easier to search and filter the resources 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 -// specify more than one tag, separate them by commas. +// account. For best practices, see [Tagging Best Practices]. 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 specify more than one tag, separate them by +// commas. +// +// [Tagging Best Practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html type Tag struct { // A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You @@ -1283,10 +1337,13 @@ 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. ErrorMessage *string @@ -1315,14 +1372,13 @@ type UnprocessedQueryExecutionId struct { } // 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 . +// 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. type WorkGroup struct { // The workgroup name. @@ -1336,8 +1392,7 @@ 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. @@ -1362,8 +1417,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. @@ -1380,17 +1435,18 @@ type WorkGroupConfiguration struct { // Enforces a minimal level of encryption for the workgroup for query and // calculation results that are written to Amazon S3. When enabled, workgroup users // can set encryption only to the minimum level set by the administrator or higher - // when they submit queries. The EnforceWorkGroupConfiguration setting takes - // precedence over the EnableMinimumEncryptionConfiguration flag. This means that - // if EnforceWorkGroupConfiguration is true, the - // EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup - // configuration for encryption is used. + // when they submit queries. + // + // The EnforceWorkGroupConfiguration setting takes precedence over the + // EnableMinimumEncryptionConfiguration flag. This means that if + // EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration + // flag is ignored, and the workgroup configuration for encryption is used. EnableMinimumEncryptionConfiguration *bool // 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) - // . + // If set to "false", client-side settings are used. For more information, see [Workgroup Settings Override Client-Side Settings]. + // + // [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 @@ -1417,19 +1473,21 @@ type WorkGroupConfiguration struct { // 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. + // information about Requester Pays buckets, see [Requester Pays Buckets]in the Amazon Simple Storage + // Service Developer Guide. + // + // [Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html RequesterPaysEnabled *bool // The configuration for the workgroup, which includes the location in Amazon S3 // where query and calculation results are stored and the encryption option, if // 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 - // 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) - // . + // this setting, or for individual queries (client-side), using 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]. + // + // [Working with query results, recent queries, and output files]: https://docs.aws.amazon.com/athena/latest/ug/querying.html ResultConfiguration *ResultConfiguration noSmithyDocumentSerde @@ -1459,16 +1517,18 @@ type WorkGroupConfigurationUpdates struct { // calculation results that are written to Amazon S3. When enabled, workgroup users // can set encryption only to the minimum level set by the administrator or higher // when they submit queries. This setting does not apply to Spark-enabled - // workgroups. The EnforceWorkGroupConfiguration setting takes precedence over the + // workgroups. + // + // The EnforceWorkGroupConfiguration setting takes precedence over the // EnableMinimumEncryptionConfiguration flag. This means that if // EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration // flag is ignored, and the workgroup configuration for encryption is used. EnableMinimumEncryptionConfiguration *bool // 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) - // . + // If set to "false" client-side settings are used. For more information, see [Workgroup Settings Override Client-Side Settings]. + // + // [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 @@ -1490,8 +1550,7 @@ type WorkGroupConfigurationUpdates struct { // Specifies whether Amazon S3 access grants are enabled for query results. QueryResultsS3AccessGrantsConfiguration *QueryResultsS3AccessGrantsConfiguration - // Indicates that the data usage control limit per query is removed. - // WorkGroupConfiguration$BytesScannedCutoffPerQuery + // Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery RemoveBytesScannedCutoffPerQuery *bool // Removes content encryption configuration from an Apache Spark-enabled Athena @@ -1502,8 +1561,10 @@ type WorkGroupConfigurationUpdates struct { // 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. + // information about Requester Pays buckets, see [Requester Pays Buckets]in the Amazon Simple Storage + // Service Developer Guide. + // + // [Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html RequesterPaysEnabled *bool // The result configuration information about the queries in this workgroup that diff --git a/service/auditmanager/api_op_AssociateAssessmentReportEvidenceFolder.go b/service/auditmanager/api_op_AssociateAssessmentReportEvidenceFolder.go index 5d7e431b530..1a7799c3ffe 100644 --- a/service/auditmanager/api_op_AssociateAssessmentReportEvidenceFolder.go +++ b/service/auditmanager/api_op_AssociateAssessmentReportEvidenceFolder.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates an evidence folder to an assessment report in an Audit Manager +// Associates an evidence folder to an assessment report in an Audit Manager +// // assessment. func (c *Client) AssociateAssessmentReportEvidenceFolder(ctx context.Context, params *AssociateAssessmentReportEvidenceFolderInput, optFns ...func(*Options)) (*AssociateAssessmentReportEvidenceFolderOutput, error) { if params == nil { @@ -29,12 +30,12 @@ func (c *Client) AssociateAssessmentReportEvidenceFolder(ctx context.Context, pa type AssociateAssessmentReportEvidenceFolderInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifier for the folder that the evidence is stored in. + // The identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string diff --git a/service/auditmanager/api_op_BatchAssociateAssessmentReportEvidence.go b/service/auditmanager/api_op_BatchAssociateAssessmentReportEvidence.go index c47d8f7be5c..44d177390c0 100644 --- a/service/auditmanager/api_op_BatchAssociateAssessmentReportEvidence.go +++ b/service/auditmanager/api_op_BatchAssociateAssessmentReportEvidence.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a list of evidence to an assessment report in an Audit Manager +// Associates a list of evidence to an assessment report in an Audit Manager +// // assessment. func (c *Client) BatchAssociateAssessmentReportEvidence(ctx context.Context, params *BatchAssociateAssessmentReportEvidenceInput, optFns ...func(*Options)) (*BatchAssociateAssessmentReportEvidenceOutput, error) { if params == nil { @@ -30,17 +31,17 @@ func (c *Client) BatchAssociateAssessmentReportEvidence(ctx context.Context, par type BatchAssociateAssessmentReportEvidenceInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifier for the folder that the evidence is stored in. + // The identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string - // The list of evidence identifiers. + // The list of evidence identifiers. // // This member is required. EvidenceIds []string @@ -50,10 +51,10 @@ type BatchAssociateAssessmentReportEvidenceInput struct { type BatchAssociateAssessmentReportEvidenceOutput struct { - // A list of errors that the BatchAssociateAssessmentReportEvidence API returned. + // A list of errors that the BatchAssociateAssessmentReportEvidence API returned. Errors []types.AssessmentReportEvidenceError - // The list of evidence identifiers. + // The list of evidence identifiers. EvidenceIds []string // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_BatchCreateDelegationByAssessment.go b/service/auditmanager/api_op_BatchCreateDelegationByAssessment.go index 1c84f38aae7..d7c632d678d 100644 --- a/service/auditmanager/api_op_BatchCreateDelegationByAssessment.go +++ b/service/auditmanager/api_op_BatchCreateDelegationByAssessment.go @@ -29,12 +29,12 @@ func (c *Client) BatchCreateDelegationByAssessment(ctx context.Context, params * type BatchCreateDelegationByAssessmentInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The API request to batch create delegations in Audit Manager. + // The API request to batch create delegations in Audit Manager. // // This member is required. CreateDelegationRequests []types.CreateDelegationRequest @@ -44,10 +44,10 @@ type BatchCreateDelegationByAssessmentInput struct { type BatchCreateDelegationByAssessmentOutput struct { - // The delegations that are associated with the assessment. + // The delegations that are associated with the assessment. Delegations []types.Delegation - // A list of errors that the BatchCreateDelegationByAssessment API returned. + // A list of errors that the BatchCreateDelegationByAssessment API returned. Errors []types.BatchCreateDelegationByAssessmentError // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_BatchDeleteDelegationByAssessment.go b/service/auditmanager/api_op_BatchDeleteDelegationByAssessment.go index 7f082208b0b..772045e8669 100644 --- a/service/auditmanager/api_op_BatchDeleteDelegationByAssessment.go +++ b/service/auditmanager/api_op_BatchDeleteDelegationByAssessment.go @@ -29,12 +29,12 @@ func (c *Client) BatchDeleteDelegationByAssessment(ctx context.Context, params * type BatchDeleteDelegationByAssessmentInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifiers for the delegations. + // The identifiers for the delegations. // // This member is required. DelegationIds []string @@ -44,7 +44,7 @@ type BatchDeleteDelegationByAssessmentInput struct { type BatchDeleteDelegationByAssessmentOutput struct { - // A list of errors that the BatchDeleteDelegationByAssessment API returned. + // A list of errors that the BatchDeleteDelegationByAssessment API returned. Errors []types.BatchDeleteDelegationByAssessmentError // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_BatchDisassociateAssessmentReportEvidence.go b/service/auditmanager/api_op_BatchDisassociateAssessmentReportEvidence.go index 5ee00369709..774b98f74b2 100644 --- a/service/auditmanager/api_op_BatchDisassociateAssessmentReportEvidence.go +++ b/service/auditmanager/api_op_BatchDisassociateAssessmentReportEvidence.go @@ -29,17 +29,17 @@ func (c *Client) BatchDisassociateAssessmentReportEvidence(ctx context.Context, type BatchDisassociateAssessmentReportEvidenceInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifier for the folder that the evidence is stored in. + // The identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string - // The list of evidence identifiers. + // The list of evidence identifiers. // // This member is required. EvidenceIds []string @@ -49,11 +49,11 @@ type BatchDisassociateAssessmentReportEvidenceInput struct { type BatchDisassociateAssessmentReportEvidenceOutput struct { - // A list of errors that the BatchDisassociateAssessmentReportEvidence API + // A list of errors that the BatchDisassociateAssessmentReportEvidence API // returned. Errors []types.AssessmentReportEvidenceError - // The identifier for the evidence. + // The identifier for the evidence. EvidenceIds []string // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go b/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go index 96893dd3cdc..12bddb8c8c5 100644 --- a/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go +++ b/service/auditmanager/api_op_BatchImportEvidenceToAssessmentControl.go @@ -12,20 +12,27 @@ import ( ) // Adds one or more pieces of evidence to a control in an Audit Manager -// assessment. You can import manual evidence from any S3 bucket by specifying the -// S3 URI of the object. You can also upload a file from your browser, or enter -// plain text in response to a risk assessment question. The following restrictions -// apply to this action: +// assessment. +// +// You can import manual evidence from any S3 bucket by specifying the S3 URI of +// the object. You can also upload a file from your browser, or enter plain text in +// response to a risk assessment question. +// +// The following restrictions apply to this action: +// // - manualEvidence can be only one of the following: evidenceFileName , // s3ResourcePath , or textResponse +// // - 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) -// . +// - Supported file formats: See [Supported file types for manual evidence]in the Audit Manager User Guide +// +// For more information about Audit Manager service restrictions, see [Quotas and restrictions for Audit Manager]. +// +// [Supported file types for manual evidence]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files +// [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{} @@ -43,22 +50,22 @@ func (c *Client) BatchImportEvidenceToAssessmentControl(ctx context.Context, par type BatchImportEvidenceToAssessmentControlInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifier for the control. + // The identifier for the control. // // This member is required. ControlId *string - // The identifier for the control set. + // The identifier for the control set. // // This member is required. ControlSetId *string - // The list of manual evidence objects. + // The list of manual evidence objects. // // This member is required. ManualEvidence []types.ManualEvidence @@ -68,7 +75,7 @@ type BatchImportEvidenceToAssessmentControlInput struct { type BatchImportEvidenceToAssessmentControlOutput struct { - // A list of errors that the BatchImportEvidenceToAssessmentControl API returned. + // A list of errors that the BatchImportEvidenceToAssessmentControl API returned. Errors []types.BatchImportEvidenceToAssessmentControlError // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_CreateAssessment.go b/service/auditmanager/api_op_CreateAssessment.go index ce85a5c75e3..9fdaf5c2627 100644 --- a/service/auditmanager/api_op_CreateAssessment.go +++ b/service/auditmanager/api_op_CreateAssessment.go @@ -29,37 +29,37 @@ func (c *Client) CreateAssessment(ctx context.Context, params *CreateAssessmentI type CreateAssessmentInput struct { - // The assessment report storage destination for the assessment that's being + // The assessment report storage destination for the assessment that's being // created. // // This member is required. AssessmentReportsDestination *types.AssessmentReportsDestination - // The identifier for the framework that the assessment will be created from. + // The identifier for the framework that the assessment will be created from. // // This member is required. FrameworkId *string - // The name of the assessment to be created. + // The name of the assessment to be created. // // This member is required. Name *string - // The list of roles for the assessment. + // The list of roles for the assessment. // // This member is required. Roles []types.Role - // The wrapper that contains the Amazon Web Services accounts and services that + // 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 - // The optional description of the assessment to be created. + // The optional description of the assessment to be created. Description *string - // The tags that are associated with the assessment. + // The tags that are associated with the assessment. Tags map[string]string noSmithyDocumentSerde @@ -67,7 +67,7 @@ type CreateAssessmentInput struct { type CreateAssessmentOutput struct { - // An entity that defines the scope of audit evidence collected by Audit Manager. + // An entity that defines the scope of audit evidence collected by Audit Manager. // An Audit Manager assessment is an implementation of an Audit Manager framework. Assessment *types.Assessment diff --git a/service/auditmanager/api_op_CreateAssessmentFramework.go b/service/auditmanager/api_op_CreateAssessmentFramework.go index 8fe345a7a2f..e3622f93b83 100644 --- a/service/auditmanager/api_op_CreateAssessmentFramework.go +++ b/service/auditmanager/api_op_CreateAssessmentFramework.go @@ -29,24 +29,24 @@ func (c *Client) CreateAssessmentFramework(ctx context.Context, params *CreateAs type CreateAssessmentFrameworkInput struct { - // The control sets that are associated with the framework. + // The control sets that are associated with the framework. // // This member is required. ControlSets []types.CreateAssessmentFrameworkControlSet - // The name of the new custom framework. + // The name of the new custom framework. // // This member is required. Name *string - // The compliance type that the new custom framework supports, such as CIS or + // The compliance type that the new custom framework supports, such as CIS or // HIPAA. ComplianceType *string - // An optional description for the new custom framework. + // An optional description for the new custom framework. Description *string - // The tags that are associated with the framework. + // The tags that are associated with the framework. Tags map[string]string noSmithyDocumentSerde @@ -54,7 +54,7 @@ type CreateAssessmentFrameworkInput struct { type CreateAssessmentFrameworkOutput struct { - // The name of the new framework that the CreateAssessmentFramework API returned. + // The name of the new framework that the CreateAssessmentFramework API returned. Framework *types.Framework // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_CreateAssessmentReport.go b/service/auditmanager/api_op_CreateAssessmentReport.go index c400af571ad..fa374288be3 100644 --- a/service/auditmanager/api_op_CreateAssessmentReport.go +++ b/service/auditmanager/api_op_CreateAssessmentReport.go @@ -29,30 +29,36 @@ func (c *Client) CreateAssessmentReport(ctx context.Context, params *CreateAsses type CreateAssessmentReportInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The name of the new assessment report. + // The name of the new assessment report. // // This member is required. Name *string - // The description of the assessment report. + // 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) - // in the Audit Manager User Guide. + // 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] + // , or [associated with a report using the API]. + // + // To use this parameter, the [enablementStatus] of evidence finder must be ENABLED . + // + // For examples and help resolving queryStatement validation exceptions, see [Troubleshooting evidence finder issues] in + // the Audit Manager User Guide. + // + // [associated with a report using the API]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html + // [Troubleshooting evidence finder issues]: https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions + // [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 + // [enablementStatus]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus QueryStatement *string noSmithyDocumentSerde @@ -60,7 +66,7 @@ type CreateAssessmentReportInput struct { type CreateAssessmentReportOutput struct { - // The new assessment report that the CreateAssessmentReport API returned. + // The new assessment report that the CreateAssessmentReport API returned. AssessmentReport *types.AssessmentReport // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_CreateControl.go b/service/auditmanager/api_op_CreateControl.go index 19bd8ca124f..54d45a1f8eb 100644 --- a/service/auditmanager/api_op_CreateControl.go +++ b/service/auditmanager/api_op_CreateControl.go @@ -29,29 +29,29 @@ func (c *Client) CreateControl(ctx context.Context, params *CreateControlInput, type CreateControlInput struct { - // The data mapping sources for the control. + // The data mapping sources for the control. // // This member is required. ControlMappingSources []types.CreateControlMappingSource - // The name of the control. + // The name of the control. // // This member is required. Name *string - // The recommended actions to carry out if the control isn't fulfilled. + // The recommended actions to carry out if the control isn't fulfilled. ActionPlanInstructions *string - // The title of the action plan for remediating the control. + // The title of the action plan for remediating the control. ActionPlanTitle *string - // The description of the control. + // The description of the control. Description *string - // The tags that are associated with the control. + // The tags that are associated with the control. Tags map[string]string - // The steps to follow to determine if the control is satisfied. + // The steps to follow to determine if the control is satisfied. TestingInformation *string noSmithyDocumentSerde @@ -59,7 +59,7 @@ type CreateControlInput struct { type CreateControlOutput struct { - // The new control that the CreateControl API returned. + // The new control that the CreateControl API returned. Control *types.Control // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_DeleteAssessment.go b/service/auditmanager/api_op_DeleteAssessment.go index acbfbeeb90a..42b2dac1b52 100644 --- a/service/auditmanager/api_op_DeleteAssessment.go +++ b/service/auditmanager/api_op_DeleteAssessment.go @@ -28,7 +28,7 @@ func (c *Client) DeleteAssessment(ctx context.Context, params *DeleteAssessmentI type DeleteAssessmentInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string diff --git a/service/auditmanager/api_op_DeleteAssessmentFramework.go b/service/auditmanager/api_op_DeleteAssessmentFramework.go index e535d08ae48..591a10d7b63 100644 --- a/service/auditmanager/api_op_DeleteAssessmentFramework.go +++ b/service/auditmanager/api_op_DeleteAssessmentFramework.go @@ -28,7 +28,7 @@ func (c *Client) DeleteAssessmentFramework(ctx context.Context, params *DeleteAs type DeleteAssessmentFrameworkInput struct { - // The identifier for the custom framework. + // The identifier for the custom framework. // // This member is required. FrameworkId *string diff --git a/service/auditmanager/api_op_DeleteAssessmentReport.go b/service/auditmanager/api_op_DeleteAssessmentReport.go index af846243834..97507a47ffd 100644 --- a/service/auditmanager/api_op_DeleteAssessmentReport.go +++ b/service/auditmanager/api_op_DeleteAssessmentReport.go @@ -10,25 +10,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an assessment report in Audit Manager. When you run the -// DeleteAssessmentReport operation, Audit Manager attempts to delete the following -// data: +// 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 // // 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 +// 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) +// can use, see [Assessment report destination permissions]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] // in the Amazon Simple Storage Service API Reference. +// +// [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList +// [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 func (c *Client) DeleteAssessmentReport(ctx context.Context, params *DeleteAssessmentReportInput, optFns ...func(*Options)) (*DeleteAssessmentReportOutput, error) { if params == nil { params = &DeleteAssessmentReportInput{} @@ -46,12 +51,12 @@ func (c *Client) DeleteAssessmentReport(ctx context.Context, params *DeleteAsses type DeleteAssessmentReportInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The unique identifier for the assessment report. + // The unique identifier for the assessment report. // // This member is required. AssessmentReportId *string diff --git a/service/auditmanager/api_op_DeleteControl.go b/service/auditmanager/api_op_DeleteControl.go index 63a871520c8..d0eb3959518 100644 --- a/service/auditmanager/api_op_DeleteControl.go +++ b/service/auditmanager/api_op_DeleteControl.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a custom control in Audit Manager. When you invoke this operation, the -// custom control is deleted from any frameworks or assessments that it’s currently -// part of. As a result, Audit Manager will stop collecting evidence for that -// custom control in all of your assessments. This includes assessments that you -// previously created before you deleted the custom control. +// Deletes a custom control in Audit Manager. +// +// When you invoke this operation, the custom control is deleted from any +// frameworks or assessments that it’s currently part of. As a result, Audit +// Manager will stop collecting evidence for that custom control in all of your +// assessments. This includes assessments that you previously created before you +// deleted the custom control. func (c *Client) DeleteControl(ctx context.Context, params *DeleteControlInput, optFns ...func(*Options)) (*DeleteControlOutput, error) { if params == nil { params = &DeleteControlInput{} @@ -32,7 +34,7 @@ func (c *Client) DeleteControl(ctx context.Context, params *DeleteControlInput, type DeleteControlInput struct { - // The unique identifier for the control. + // The unique identifier for the control. // // This member is required. ControlId *string diff --git a/service/auditmanager/api_op_DeregisterAccount.go b/service/auditmanager/api_op_DeregisterAccount.go index 01e7df9d51c..c24518bcf29 100644 --- a/service/auditmanager/api_op_DeregisterAccount.go +++ b/service/auditmanager/api_op_DeregisterAccount.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// in the Audit Manager User Guide. +// Deregisters an account in Audit Manager. +// +// Before you deregister, you can use the [UpdateSettings] 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] in the Audit Manager User +// Guide. +// +// [Data Protection]: https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html +// [UpdateSettings]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html func (c *Client) DeregisterAccount(ctx context.Context, params *DeregisterAccountInput, optFns ...func(*Options)) (*DeregisterAccountOutput, error) { if params == nil { params = &DeregisterAccountInput{} @@ -39,7 +44,7 @@ type DeregisterAccountInput struct { type DeregisterAccountOutput struct { - // The registration status of the account. + // The registration status of the account. Status types.AccountStatus // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go b/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go index d977f3090b1..c4fe0fb5dbf 100644 --- a/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go +++ b/service/auditmanager/api_op_DeregisterOrganizationAdminAccount.go @@ -11,51 +11,70 @@ import ( ) // Removes the specified Amazon Web Services account as a delegated administrator -// for Audit Manager. When you remove a delegated administrator from your Audit -// Manager settings, you continue to have access to the evidence that you -// previously collected under that account. This is also the case when you -// deregister a delegated administrator from Organizations. However, Audit Manager -// stops collecting and attaching evidence to that delegated administrator account -// moving forward. Keep in mind the following cleanup task if you use evidence -// finder: Before you use your management account to remove a delegated -// administrator, make sure that the current delegated administrator account signs -// in to Audit Manager and disables evidence finder first. Disabling evidence -// finder automatically deletes the event data store that was created in their -// 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 +// for Audit Manager. +// +// When you remove a delegated administrator from your Audit Manager settings, you +// continue to have access to the evidence that you previously collected under that +// account. This is also the case when you deregister a delegated administrator +// from Organizations. However, Audit Manager stops collecting and attaching +// evidence to that delegated administrator account moving forward. +// +// Keep in mind the following cleanup task if you use evidence finder: +// +// Before you use your management account to remove a delegated administrator, +// make sure that the current delegated administrator account signs in to Audit +// Manager and disables evidence finder first. Disabling evidence finder +// automatically deletes the event data store that was created in their 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]. +// +// 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 -// delete it. When you deregister a delegated administrator account for Audit -// Manager, the data for that account isn’t deleted. If you want to delete resource -// data for a delegated administrator account, you must perform that task -// separately before you deregister the account. Either, you can do this in the -// 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) +// delete it. +// +// When you deregister a delegated administrator account for Audit Manager, the +// data for that account isn’t deleted. If you want to delete resource data for a +// delegated administrator account, you must perform that task separately before +// you deregister the account. Either, you can do this in the 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] +// - (see also: [Deleting an assessment]in the Audit Manager User Guide) +// +// [DeleteAssessmentFramework] +// - (see also: [Deleting a custom framework]in the Audit Manager User Guide) +// +// [DeleteAssessmentFrameworkShare] +// - (see also: [Deleting a share request]in the Audit Manager User Guide) +// +// [DeleteAssessmentReport] +// - (see also: [Deleting an assessment report]in the Audit Manager User Guide) +// +// [DeleteControl] +// - (see also: [Deleting a custom control]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. +// +// [DeleteControl]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html +// [deletes the event data store]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html +// [DeleteAssessmentFrameworkShare]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html +// [Deleting a custom control]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html +// [Deleting an assessment report]: https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps +// [Deleting a custom framework]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html +// [Deleting a share request]: https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html +// [Deleting an assessment]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html +// [DeleteAssessment]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html +// [DeleteAssessmentReport]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html +// [DeleteAssessmentFramework]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html func (c *Client) DeregisterOrganizationAdminAccount(ctx context.Context, params *DeregisterOrganizationAdminAccountInput, optFns ...func(*Options)) (*DeregisterOrganizationAdminAccountOutput, error) { if params == nil { params = &DeregisterOrganizationAdminAccountInput{} @@ -73,7 +92,7 @@ func (c *Client) DeregisterOrganizationAdminAccount(ctx context.Context, params type DeregisterOrganizationAdminAccountInput struct { - // The identifier for the administrator account. + // The identifier for the administrator account. AdminAccountId *string noSmithyDocumentSerde diff --git a/service/auditmanager/api_op_DisassociateAssessmentReportEvidenceFolder.go b/service/auditmanager/api_op_DisassociateAssessmentReportEvidenceFolder.go index b3ede9dd88f..72f81f5bb23 100644 --- a/service/auditmanager/api_op_DisassociateAssessmentReportEvidenceFolder.go +++ b/service/auditmanager/api_op_DisassociateAssessmentReportEvidenceFolder.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates an evidence folder from the specified assessment report in Audit +// Disassociates an evidence folder from the specified assessment report in Audit +// // Manager. func (c *Client) DisassociateAssessmentReportEvidenceFolder(ctx context.Context, params *DisassociateAssessmentReportEvidenceFolderInput, optFns ...func(*Options)) (*DisassociateAssessmentReportEvidenceFolderOutput, error) { if params == nil { @@ -29,12 +30,12 @@ func (c *Client) DisassociateAssessmentReportEvidenceFolder(ctx context.Context, type DisassociateAssessmentReportEvidenceFolderInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The unique identifier for the folder that the evidence is stored in. + // The unique identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string diff --git a/service/auditmanager/api_op_GetAccountStatus.go b/service/auditmanager/api_op_GetAccountStatus.go index 819147eecd5..0c9a65a0cee 100644 --- a/service/auditmanager/api_op_GetAccountStatus.go +++ b/service/auditmanager/api_op_GetAccountStatus.go @@ -33,7 +33,7 @@ type GetAccountStatusInput struct { type GetAccountStatusOutput struct { - // The status of the Amazon Web Services account. + // The status of the Amazon Web Services account. Status types.AccountStatus // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetAssessment.go b/service/auditmanager/api_op_GetAssessment.go index e9880cc3d5e..4d46e52aef1 100644 --- a/service/auditmanager/api_op_GetAssessment.go +++ b/service/auditmanager/api_op_GetAssessment.go @@ -39,11 +39,11 @@ type GetAssessmentInput struct { type GetAssessmentOutput struct { - // An entity that defines the scope of audit evidence collected by Audit Manager. + // An entity that defines the scope of audit evidence collected by Audit Manager. // An Audit Manager assessment is an implementation of an Audit Manager framework. Assessment *types.Assessment - // The wrapper that contains the Audit Manager role information of the current + // The wrapper that contains the Audit Manager role information of the current // user. This includes the role type and IAM Amazon Resource Name (ARN). UserRole *types.Role diff --git a/service/auditmanager/api_op_GetAssessmentFramework.go b/service/auditmanager/api_op_GetAssessmentFramework.go index 2af841037ce..e72bab309a3 100644 --- a/service/auditmanager/api_op_GetAssessmentFramework.go +++ b/service/auditmanager/api_op_GetAssessmentFramework.go @@ -29,7 +29,7 @@ func (c *Client) GetAssessmentFramework(ctx context.Context, params *GetAssessme type GetAssessmentFrameworkInput struct { - // The identifier for the framework. + // The identifier for the framework. // // This member is required. FrameworkId *string @@ -39,7 +39,7 @@ type GetAssessmentFrameworkInput struct { type GetAssessmentFrameworkOutput struct { - // The framework that the GetAssessmentFramework API returned. + // The framework that the GetAssessmentFramework API returned. Framework *types.Framework // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetAssessmentReportUrl.go b/service/auditmanager/api_op_GetAssessmentReportUrl.go index c625d428a04..b98732a5502 100644 --- a/service/auditmanager/api_op_GetAssessmentReportUrl.go +++ b/service/auditmanager/api_op_GetAssessmentReportUrl.go @@ -29,12 +29,12 @@ func (c *Client) GetAssessmentReportUrl(ctx context.Context, params *GetAssessme type GetAssessmentReportUrlInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The unique identifier for the assessment report. + // The unique identifier for the assessment report. // // This member is required. AssessmentReportId *string @@ -44,7 +44,7 @@ type GetAssessmentReportUrlInput struct { type GetAssessmentReportUrlOutput struct { - // Short for uniform resource locator. A URL is used as a unique identifier to + // Short for uniform resource locator. A URL is used as a unique identifier to // locate a resource on the internet. PreSignedUrl *types.URL diff --git a/service/auditmanager/api_op_GetChangeLogs.go b/service/auditmanager/api_op_GetChangeLogs.go index 2b919039202..9852fcc7417 100644 --- a/service/auditmanager/api_op_GetChangeLogs.go +++ b/service/auditmanager/api_op_GetChangeLogs.go @@ -34,16 +34,16 @@ type GetChangeLogsInput struct { // This member is required. AssessmentId *string - // The unique identifier for the control. + // The unique identifier for the control. ControlId *string - // The unique identifier for the control set. + // The unique identifier for the control set. ControlSetId *string // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde diff --git a/service/auditmanager/api_op_GetControl.go b/service/auditmanager/api_op_GetControl.go index 0acf34c16be..c7620d4d6b3 100644 --- a/service/auditmanager/api_op_GetControl.go +++ b/service/auditmanager/api_op_GetControl.go @@ -29,7 +29,7 @@ func (c *Client) GetControl(ctx context.Context, params *GetControlInput, optFns type GetControlInput struct { - // The identifier for the control. + // The identifier for the control. // // This member is required. ControlId *string @@ -39,7 +39,7 @@ type GetControlInput struct { type GetControlOutput struct { - // The details of the control that the GetControl API returned. + // The details of the control that the GetControl API returned. Control *types.Control // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetDelegations.go b/service/auditmanager/api_op_GetDelegations.go index 3344a51454b..70a35da6885 100644 --- a/service/auditmanager/api_op_GetDelegations.go +++ b/service/auditmanager/api_op_GetDelegations.go @@ -29,10 +29,10 @@ func (c *Client) GetDelegations(ctx context.Context, params *GetDelegationsInput type GetDelegationsInput struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -40,10 +40,10 @@ type GetDelegationsInput struct { type GetDelegationsOutput struct { - // The list of delegations that the GetDelegations API returned. + // The list of delegations that the GetDelegations API returned. Delegations []types.DelegationMetadata - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -138,7 +138,7 @@ var _ GetDelegationsAPIClient = (*Client)(nil) // GetDelegationsPaginatorOptions is the paginator options for GetDelegations type GetDelegationsPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_GetEvidence.go b/service/auditmanager/api_op_GetEvidence.go index 6108d3e6165..0719be26385 100644 --- a/service/auditmanager/api_op_GetEvidence.go +++ b/service/auditmanager/api_op_GetEvidence.go @@ -29,22 +29,22 @@ func (c *Client) GetEvidence(ctx context.Context, params *GetEvidenceInput, optF type GetEvidenceInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The unique identifier for the control set. + // The unique identifier for the control set. // // This member is required. ControlSetId *string - // The unique identifier for the folder that the evidence is stored in. + // The unique identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string - // The unique identifier for the evidence. + // The unique identifier for the evidence. // // This member is required. EvidenceId *string @@ -54,7 +54,7 @@ type GetEvidenceInput struct { type GetEvidenceOutput struct { - // The evidence that the GetEvidence API returned. + // The evidence that the GetEvidence API returned. Evidence *types.Evidence // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetEvidenceByEvidenceFolder.go b/service/auditmanager/api_op_GetEvidenceByEvidenceFolder.go index f9746812a20..3c3f7e9e917 100644 --- a/service/auditmanager/api_op_GetEvidenceByEvidenceFolder.go +++ b/service/auditmanager/api_op_GetEvidenceByEvidenceFolder.go @@ -29,25 +29,25 @@ func (c *Client) GetEvidenceByEvidenceFolder(ctx context.Context, params *GetEvi type GetEvidenceByEvidenceFolderInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifier for the control set. + // The identifier for the control set. // // This member is required. ControlSetId *string - // The unique identifier for the folder that the evidence is stored in. + // The unique identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -55,10 +55,10 @@ type GetEvidenceByEvidenceFolderInput struct { type GetEvidenceByEvidenceFolderOutput struct { - // The list of evidence that the GetEvidenceByEvidenceFolder API returned. + // The list of evidence that the GetEvidenceByEvidenceFolder API returned. Evidence []types.Evidence - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -157,7 +157,7 @@ var _ GetEvidenceByEvidenceFolderAPIClient = (*Client)(nil) // GetEvidenceByEvidenceFolderPaginatorOptions is the paginator options for // GetEvidenceByEvidenceFolder type GetEvidenceByEvidenceFolderPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_GetEvidenceFileUploadUrl.go b/service/auditmanager/api_op_GetEvidenceFileUploadUrl.go index f60196757e6..425558bbcda 100644 --- a/service/auditmanager/api_op_GetEvidenceFileUploadUrl.go +++ b/service/auditmanager/api_op_GetEvidenceFileUploadUrl.go @@ -11,18 +11,22 @@ import ( ) // Creates a presigned Amazon S3 URL that can be used to upload a file as manual -// evidence. For instructions on how to use this operation, see Upload a file from -// your browser (https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files) -// in the Audit Manager User Guide. The following restrictions apply to this -// operation: +// evidence. For instructions on how to use this operation, see [Upload a file from your browser]in the Audit +// Manager User Guide. +// +// The following restrictions apply to this operation: +// // - 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) -// . +// - Supported file formats: See [Supported file types for manual evidence]in the Audit Manager User Guide +// +// For more information about Audit Manager service restrictions, see [Quotas and restrictions for Audit Manager]. +// +// [Supported file types for manual evidence]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files +// [Upload a file from your browser]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files +// [Quotas and restrictions for Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html func (c *Client) GetEvidenceFileUploadUrl(ctx context.Context, params *GetEvidenceFileUploadUrlInput, optFns ...func(*Options)) (*GetEvidenceFileUploadUrlOutput, error) { if params == nil { params = &GetEvidenceFileUploadUrlInput{} @@ -40,9 +44,10 @@ func (c *Client) GetEvidenceFileUploadUrl(ctx context.Context, params *GetEviden type GetEvidenceFileUploadUrlInput struct { - // The file that you want to upload. For a list of 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. + // The file that you want to upload. For a list of supported file formats, see [Supported file types for manual evidence] in + // the Audit Manager User Guide. + // + // [Supported file types for manual evidence]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files // // This member is required. FileName *string diff --git a/service/auditmanager/api_op_GetEvidenceFolder.go b/service/auditmanager/api_op_GetEvidenceFolder.go index c2318654d5f..fea705d13f5 100644 --- a/service/auditmanager/api_op_GetEvidenceFolder.go +++ b/service/auditmanager/api_op_GetEvidenceFolder.go @@ -29,17 +29,17 @@ func (c *Client) GetEvidenceFolder(ctx context.Context, params *GetEvidenceFolde type GetEvidenceFolderInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The unique identifier for the control set. + // The unique identifier for the control set. // // This member is required. ControlSetId *string - // The unique identifier for the folder that the evidence is stored in. + // The unique identifier for the folder that the evidence is stored in. // // This member is required. EvidenceFolderId *string @@ -49,7 +49,7 @@ type GetEvidenceFolderInput struct { type GetEvidenceFolderOutput struct { - // The folder that the evidence is stored in. + // The folder that the evidence is stored in. EvidenceFolder *types.AssessmentEvidenceFolder // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetEvidenceFoldersByAssessment.go b/service/auditmanager/api_op_GetEvidenceFoldersByAssessment.go index b777d709cef..9b239c8bc91 100644 --- a/service/auditmanager/api_op_GetEvidenceFoldersByAssessment.go +++ b/service/auditmanager/api_op_GetEvidenceFoldersByAssessment.go @@ -29,15 +29,15 @@ func (c *Client) GetEvidenceFoldersByAssessment(ctx context.Context, params *Get type GetEvidenceFoldersByAssessmentInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -45,11 +45,11 @@ type GetEvidenceFoldersByAssessmentInput struct { type GetEvidenceFoldersByAssessmentOutput struct { - // The list of evidence folders that the GetEvidenceFoldersByAssessment API + // The list of evidence folders that the GetEvidenceFoldersByAssessment API // returned. EvidenceFolders []types.AssessmentEvidenceFolder - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -148,7 +148,7 @@ var _ GetEvidenceFoldersByAssessmentAPIClient = (*Client)(nil) // GetEvidenceFoldersByAssessmentPaginatorOptions is the paginator options for // GetEvidenceFoldersByAssessment type GetEvidenceFoldersByAssessmentPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_GetEvidenceFoldersByAssessmentControl.go b/service/auditmanager/api_op_GetEvidenceFoldersByAssessmentControl.go index aaefdb7af8e..75ea1fe93ef 100644 --- a/service/auditmanager/api_op_GetEvidenceFoldersByAssessmentControl.go +++ b/service/auditmanager/api_op_GetEvidenceFoldersByAssessmentControl.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of evidence folders that are associated with a specified control in -// an Audit Manager assessment. +// Gets a list of evidence folders that are associated with a specified control +// +// in an Audit Manager assessment. func (c *Client) GetEvidenceFoldersByAssessmentControl(ctx context.Context, params *GetEvidenceFoldersByAssessmentControlInput, optFns ...func(*Options)) (*GetEvidenceFoldersByAssessmentControlOutput, error) { if params == nil { params = &GetEvidenceFoldersByAssessmentControlInput{} @@ -30,25 +31,25 @@ func (c *Client) GetEvidenceFoldersByAssessmentControl(ctx context.Context, para type GetEvidenceFoldersByAssessmentControlInput struct { - // The identifier for the assessment. + // The identifier for the assessment. // // This member is required. AssessmentId *string - // The identifier for the control. + // The identifier for the control. // // This member is required. ControlId *string - // The identifier for the control set. + // The identifier for the control set. // // This member is required. ControlSetId *string - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -56,11 +57,11 @@ type GetEvidenceFoldersByAssessmentControlInput struct { type GetEvidenceFoldersByAssessmentControlOutput struct { - // The list of evidence folders that the GetEvidenceFoldersByAssessmentControl API - // returned. + // The list of evidence folders that the GetEvidenceFoldersByAssessmentControl + // API returned. EvidenceFolders []types.AssessmentEvidenceFolder - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -159,7 +160,7 @@ var _ GetEvidenceFoldersByAssessmentControlAPIClient = (*Client)(nil) // GetEvidenceFoldersByAssessmentControlPaginatorOptions is the paginator options // for GetEvidenceFoldersByAssessmentControl type GetEvidenceFoldersByAssessmentControlPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_GetInsightsByAssessment.go b/service/auditmanager/api_op_GetInsightsByAssessment.go index ddd0ec94268..21514785513 100644 --- a/service/auditmanager/api_op_GetInsightsByAssessment.go +++ b/service/auditmanager/api_op_GetInsightsByAssessment.go @@ -39,7 +39,7 @@ type GetInsightsByAssessmentInput struct { type GetInsightsByAssessmentOutput struct { - // The assessment analytics data that the GetInsightsByAssessment API returned. + // The assessment analytics data that the GetInsightsByAssessment API returned. Insights *types.InsightsByAssessment // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetOrganizationAdminAccount.go b/service/auditmanager/api_op_GetOrganizationAdminAccount.go index 95ec2896ec9..51078f29a30 100644 --- a/service/auditmanager/api_op_GetOrganizationAdminAccount.go +++ b/service/auditmanager/api_op_GetOrganizationAdminAccount.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the name of the delegated Amazon Web Services administrator account for a +// Gets the name of the delegated Amazon Web Services administrator account for a +// // specified organization. func (c *Client) GetOrganizationAdminAccount(ctx context.Context, params *GetOrganizationAdminAccountInput, optFns ...func(*Options)) (*GetOrganizationAdminAccountOutput, error) { if params == nil { @@ -33,10 +34,10 @@ type GetOrganizationAdminAccountInput struct { type GetOrganizationAdminAccountOutput struct { - // The identifier for the administrator account. + // The identifier for the administrator account. AdminAccountId *string - // The identifier for the organization. + // The identifier for the organization. OrganizationId *string // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetServicesInScope.go b/service/auditmanager/api_op_GetServicesInScope.go index 8037eef07ba..1caa21a80c5 100644 --- a/service/auditmanager/api_op_GetServicesInScope.go +++ b/service/auditmanager/api_op_GetServicesInScope.go @@ -12,10 +12,11 @@ import ( ) // Gets 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) -// . +// your assessment. When you [create an assessment], specify which of these services you want to include +// to narrow the assessment's [scope]. +// +// [create an assessment]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html +// [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{} @@ -37,7 +38,7 @@ type GetServicesInScopeInput struct { type GetServicesInScopeOutput struct { - // The metadata that's associated with the Amazon Web Service. + // The metadata that's associated with the Amazon Web Service. ServiceMetadata []types.ServiceMetadata // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_GetSettings.go b/service/auditmanager/api_op_GetSettings.go index 1bc9770fded..c44add54740 100644 --- a/service/auditmanager/api_op_GetSettings.go +++ b/service/auditmanager/api_op_GetSettings.go @@ -29,7 +29,7 @@ func (c *Client) GetSettings(ctx context.Context, params *GetSettingsInput, optF type GetSettingsInput struct { - // The list of setting attribute enum values. + // The list of setting attribute enum values. // // This member is required. Attribute types.SettingAttribute @@ -39,7 +39,7 @@ type GetSettingsInput struct { type GetSettingsOutput struct { - // The settings object that holds all supported Audit Manager settings. + // The settings object that holds all supported Audit Manager settings. Settings *types.Settings // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go b/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go index 72c1de3282b..4b3f0324cd8 100644 --- a/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go +++ b/service/auditmanager/api_op_ListAssessmentControlInsightsByControlDomain.go @@ -12,11 +12,12 @@ import ( ) // Lists the latest analytics data for controls within a specific control domain -// 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 -// listed for that control. +// 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 listed for that control. func (c *Client) ListAssessmentControlInsightsByControlDomain(ctx context.Context, params *ListAssessmentControlInsightsByControlDomainInput, optFns ...func(*Options)) (*ListAssessmentControlInsightsByControlDomainOutput, error) { if params == nil { params = &ListAssessmentControlInsightsByControlDomainInput{} diff --git a/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go b/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go index f32a81da5b0..c6f807d0d60 100644 --- a/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go +++ b/service/auditmanager/api_op_ListAssessmentFrameworkShareRequests.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of sent or received share requests for custom frameworks in +// 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 { @@ -30,15 +31,15 @@ func (c *Client) ListAssessmentFrameworkShareRequests(ctx context.Context, param type ListAssessmentFrameworkShareRequestsInput struct { - // Specifies whether the share request is a sent request or a received request. + // Specifies whether the share request is a sent request or a received request. // // This member is required. RequestType types.ShareRequestType - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -46,11 +47,11 @@ type ListAssessmentFrameworkShareRequestsInput struct { type ListAssessmentFrameworkShareRequestsOutput struct { - // The list of share requests that the ListAssessmentFrameworkShareRequests API + // The list of share requests that the ListAssessmentFrameworkShareRequests API // returned. AssessmentFrameworkShareRequests []types.AssessmentFrameworkShareRequest - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -149,7 +150,7 @@ var _ ListAssessmentFrameworkShareRequestsAPIClient = (*Client)(nil) // ListAssessmentFrameworkShareRequestsPaginatorOptions is the paginator options // for ListAssessmentFrameworkShareRequests type ListAssessmentFrameworkShareRequestsPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListAssessmentFrameworks.go b/service/auditmanager/api_op_ListAssessmentFrameworks.go index 4ef9c2a8c82..dac1dd40157 100644 --- a/service/auditmanager/api_op_ListAssessmentFrameworks.go +++ b/service/auditmanager/api_op_ListAssessmentFrameworks.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the frameworks that are available in the Audit Manager +// Returns a list of the frameworks that are available in the Audit Manager +// // framework library. func (c *Client) ListAssessmentFrameworks(ctx context.Context, params *ListAssessmentFrameworksInput, optFns ...func(*Options)) (*ListAssessmentFrameworksOutput, error) { if params == nil { @@ -30,15 +31,15 @@ func (c *Client) ListAssessmentFrameworks(ctx context.Context, params *ListAsses type ListAssessmentFrameworksInput struct { - // The type of framework, such as a standard framework or a custom framework. + // The type of framework, such as a standard framework or a custom framework. // // This member is required. FrameworkType types.FrameworkType - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -46,11 +47,11 @@ type ListAssessmentFrameworksInput struct { type ListAssessmentFrameworksOutput struct { - // A list of metadata that the ListAssessmentFrameworks API returns for each + // A list of metadata that the ListAssessmentFrameworks API returns for each // framework. FrameworkMetadataList []types.AssessmentFrameworkMetadata - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -149,7 +150,7 @@ var _ ListAssessmentFrameworksAPIClient = (*Client)(nil) // ListAssessmentFrameworksPaginatorOptions is the paginator options for // ListAssessmentFrameworks type ListAssessmentFrameworksPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListAssessmentReports.go b/service/auditmanager/api_op_ListAssessmentReports.go index b3e37fccbdf..767bd4521a5 100644 --- a/service/auditmanager/api_op_ListAssessmentReports.go +++ b/service/auditmanager/api_op_ListAssessmentReports.go @@ -29,10 +29,10 @@ func (c *Client) ListAssessmentReports(ctx context.Context, params *ListAssessme type ListAssessmentReportsInput struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -40,10 +40,10 @@ type ListAssessmentReportsInput struct { type ListAssessmentReportsOutput struct { - // The list of assessment reports that the ListAssessmentReports API returned. + // The list of assessment reports that the ListAssessmentReports API returned. AssessmentReports []types.AssessmentReportMetadata - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -139,7 +139,7 @@ var _ ListAssessmentReportsAPIClient = (*Client)(nil) // ListAssessmentReportsPaginatorOptions is the paginator options for // ListAssessmentReports type ListAssessmentReportsPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListAssessments.go b/service/auditmanager/api_op_ListAssessments.go index aa2c3241b01..4c2ef07d55c 100644 --- a/service/auditmanager/api_op_ListAssessments.go +++ b/service/auditmanager/api_op_ListAssessments.go @@ -29,13 +29,13 @@ func (c *Client) ListAssessments(ctx context.Context, params *ListAssessmentsInp type ListAssessmentsInput struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string - // The current status of the assessment. + // The current status of the assessment. Status types.AssessmentStatus noSmithyDocumentSerde @@ -46,7 +46,7 @@ type ListAssessmentsOutput struct { // The metadata that the ListAssessments API returns for each assessment. AssessmentMetadata []types.AssessmentMetadataItem - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -141,7 +141,7 @@ var _ ListAssessmentsAPIClient = (*Client)(nil) // ListAssessmentsPaginatorOptions is the paginator options for ListAssessments type ListAssessmentsPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListControlDomainInsights.go b/service/auditmanager/api_op_ListControlDomainInsights.go index 4d4466a7a3f..0addd4ab983 100644 --- a/service/auditmanager/api_op_ListControlDomainInsights.go +++ b/service/auditmanager/api_op_ListControlDomainInsights.go @@ -12,10 +12,11 @@ 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 -// control domain. +// 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 control domain. func (c *Client) ListControlDomainInsights(ctx context.Context, params *ListControlDomainInsightsInput, optFns ...func(*Options)) (*ListControlDomainInsightsOutput, error) { if params == nil { params = &ListControlDomainInsightsInput{} diff --git a/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go b/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go index 83d762e64a4..c7d235886ee 100644 --- a/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go +++ b/service/auditmanager/api_op_ListControlDomainInsightsByAssessment.go @@ -12,6 +12,7 @@ import ( ) // 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. diff --git a/service/auditmanager/api_op_ListControlInsightsByControlDomain.go b/service/auditmanager/api_op_ListControlInsightsByControlDomain.go index 41ba52ac079..c74778aa95b 100644 --- a/service/auditmanager/api_op_ListControlInsightsByControlDomain.go +++ b/service/auditmanager/api_op_ListControlInsightsByControlDomain.go @@ -12,10 +12,12 @@ 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. +// 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. 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_ListControls.go b/service/auditmanager/api_op_ListControls.go index fa7f94bfd1e..9a1fc7e11de 100644 --- a/service/auditmanager/api_op_ListControls.go +++ b/service/auditmanager/api_op_ListControls.go @@ -29,15 +29,15 @@ func (c *Client) ListControls(ctx context.Context, params *ListControlsInput, op type ListControlsInput struct { - // The type of control, such as a standard control or a custom control. + // The type of control, such as a standard control or a custom control. // // This member is required. ControlType types.ControlType - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -45,10 +45,10 @@ type ListControlsInput struct { type ListControlsOutput struct { - // A list of metadata that the ListControls API returns for each control. + // A list of metadata that the ListControls API returns for each control. ControlMetadataList []types.ControlMetadata - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -145,7 +145,7 @@ var _ ListControlsAPIClient = (*Client)(nil) // ListControlsPaginatorOptions is the paginator options for ListControls type ListControlsPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListKeywordsForDataSource.go b/service/auditmanager/api_op_ListKeywordsForDataSource.go index f1410793ac5..aae7b63b3f2 100644 --- a/service/auditmanager/api_op_ListKeywordsForDataSource.go +++ b/service/auditmanager/api_op_ListKeywordsForDataSource.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of keywords that are pre-mapped to the specified control data +// Returns a list of keywords that are pre-mapped to the specified control data +// // source. func (c *Client) ListKeywordsForDataSource(ctx context.Context, params *ListKeywordsForDataSourceInput, optFns ...func(*Options)) (*ListKeywordsForDataSourceOutput, error) { if params == nil { @@ -30,15 +31,15 @@ func (c *Client) ListKeywordsForDataSource(ctx context.Context, params *ListKeyw type ListKeywordsForDataSourceInput struct { - // The control mapping data source that the keywords apply to. + // The control mapping data source that the keywords apply to. // // This member is required. Source types.SourceType - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -46,10 +47,10 @@ type ListKeywordsForDataSourceInput struct { type ListKeywordsForDataSourceOutput struct { - // The list of keywords for the event mapping source. + // The list of keywords for the event mapping source. Keywords []string - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string // Metadata pertaining to the operation's result. @@ -148,7 +149,7 @@ var _ ListKeywordsForDataSourceAPIClient = (*Client)(nil) // ListKeywordsForDataSourcePaginatorOptions is the paginator options for // ListKeywordsForDataSource type ListKeywordsForDataSourcePaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListNotifications.go b/service/auditmanager/api_op_ListNotifications.go index ade7dd88b40..19cb3202c13 100644 --- a/service/auditmanager/api_op_ListNotifications.go +++ b/service/auditmanager/api_op_ListNotifications.go @@ -29,10 +29,10 @@ func (c *Client) ListNotifications(ctx context.Context, params *ListNotification type ListNotificationsInput struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. MaxResults *int32 - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string noSmithyDocumentSerde @@ -40,10 +40,10 @@ type ListNotificationsInput struct { type ListNotificationsOutput struct { - // The pagination token that's used to fetch the next set of results. + // The pagination token that's used to fetch the next set of results. NextToken *string - // The returned list of notifications. + // The returned list of notifications. Notifications []types.Notification // Metadata pertaining to the operation's result. @@ -138,7 +138,7 @@ var _ ListNotificationsAPIClient = (*Client)(nil) // ListNotificationsPaginatorOptions is the paginator options for ListNotifications type ListNotificationsPaginatorOptions struct { - // Represents the maximum number of results on a page or for an API request call. + // Represents the maximum number of results on a page or for an API request call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/auditmanager/api_op_ListTagsForResource.go b/service/auditmanager/api_op_ListTagsForResource.go index f1ad4c93604..2d5cd280dbd 100644 --- a/service/auditmanager/api_op_ListTagsForResource.go +++ b/service/auditmanager/api_op_ListTagsForResource.go @@ -28,7 +28,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resource. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string @@ -38,7 +38,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The list of tags that the ListTagsForResource API returned. + // The list of tags that the ListTagsForResource API returned. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_RegisterAccount.go b/service/auditmanager/api_op_RegisterAccount.go index 28947fce917..0a7780f8857 100644 --- a/service/auditmanager/api_op_RegisterAccount.go +++ b/service/auditmanager/api_op_RegisterAccount.go @@ -29,10 +29,10 @@ func (c *Client) RegisterAccount(ctx context.Context, params *RegisterAccountInp type RegisterAccountInput struct { - // The delegated administrator account for Audit Manager. + // The delegated administrator account for Audit Manager. DelegatedAdminAccount *string - // The KMS key details. + // The KMS key details. KmsKey *string noSmithyDocumentSerde @@ -40,7 +40,7 @@ type RegisterAccountInput struct { type RegisterAccountOutput struct { - // The status of the account registration request. + // The status of the account registration request. Status types.AccountStatus // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_RegisterOrganizationAdminAccount.go b/service/auditmanager/api_op_RegisterOrganizationAdminAccount.go index 0a8944ac8e7..be15fe8bfeb 100644 --- a/service/auditmanager/api_op_RegisterOrganizationAdminAccount.go +++ b/service/auditmanager/api_op_RegisterOrganizationAdminAccount.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables an Amazon Web Services account within the organization as the delegated -// administrator for Audit Manager. +// Enables an Amazon Web Services account within the organization as the +// +// delegated administrator for Audit Manager. func (c *Client) RegisterOrganizationAdminAccount(ctx context.Context, params *RegisterOrganizationAdminAccountInput, optFns ...func(*Options)) (*RegisterOrganizationAdminAccountOutput, error) { if params == nil { params = &RegisterOrganizationAdminAccountInput{} @@ -29,7 +30,7 @@ func (c *Client) RegisterOrganizationAdminAccount(ctx context.Context, params *R type RegisterOrganizationAdminAccountInput struct { - // The identifier for the delegated administrator account. + // The identifier for the delegated administrator account. // // This member is required. AdminAccountId *string @@ -39,10 +40,10 @@ type RegisterOrganizationAdminAccountInput struct { type RegisterOrganizationAdminAccountOutput struct { - // The identifier for the delegated administrator account. + // The identifier for the delegated administrator account. AdminAccountId *string - // The identifier for the organization. + // The identifier for the organization. OrganizationId *string // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_StartAssessmentFrameworkShare.go b/service/auditmanager/api_op_StartAssessmentFrameworkShare.go index 899ef30c462..8a209beac34 100644 --- a/service/auditmanager/api_op_StartAssessmentFrameworkShare.go +++ b/service/auditmanager/api_op_StartAssessmentFrameworkShare.go @@ -11,34 +11,46 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a share request for a custom framework in Audit Manager. The share -// request specifies a recipient and notifies them that a custom framework is -// available. Recipients have 120 days to accept or decline the request. If no -// action is taken, the share request expires. When you create a share request, -// Audit Manager stores a snapshot of your custom framework in the US East (N. -// Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the -// 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: +// Creates a share request for a custom framework in Audit Manager. +// +// The share request specifies a recipient and notifies them that a custom +// framework is available. Recipients have 120 days to accept or decline the +// request. If no action is taken, the share request expires. +// +// When you create a share request, Audit Manager stores a snapshot of your custom +// framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager +// also stores a backup of the 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. // -// 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 -// invoke the StartAssessmentFrameworkShare API, you are about to share a custom -// framework with another Amazon Web Services account. You may not share a custom -// framework that is derived from a standard framework if the standard framework is -// 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) -// in the Audit Manager User Guide. +// When a sender [resends a share request], 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 invoke the StartAssessmentFrameworkShare API, you are about to share a +// custom framework with another Amazon Web Services account. You may not share a +// custom framework that is derived from a standard framework if the standard +// framework is 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]in the Audit Manager User Guide. +// +// [resends a share request]: https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend +// [Framework sharing eligibility]: https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility func (c *Client) StartAssessmentFrameworkShare(ctx context.Context, params *StartAssessmentFrameworkShareInput, optFns ...func(*Options)) (*StartAssessmentFrameworkShareOutput, error) { if params == nil { params = &StartAssessmentFrameworkShareInput{} @@ -56,22 +68,22 @@ func (c *Client) StartAssessmentFrameworkShare(ctx context.Context, params *Star type StartAssessmentFrameworkShareInput struct { - // The Amazon Web Services account of the recipient. + // The Amazon Web Services account of the recipient. // // This member is required. DestinationAccount *string - // The Amazon Web Services Region of the recipient. + // The Amazon Web Services Region of the recipient. // // This member is required. DestinationRegion *string - // The unique identifier for the custom framework to be shared. + // The unique identifier for the custom framework to be shared. // // This member is required. FrameworkId *string - // An optional comment from the sender about the share request. + // An optional comment from the sender about the share request. Comment *string noSmithyDocumentSerde @@ -79,7 +91,7 @@ type StartAssessmentFrameworkShareInput struct { type StartAssessmentFrameworkShareOutput struct { - // The share request that's created by the StartAssessmentFrameworkShare API. + // The share request that's created by the StartAssessmentFrameworkShare API. AssessmentFrameworkShareRequest *types.AssessmentFrameworkShareRequest // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_TagResource.go b/service/auditmanager/api_op_TagResource.go index 3b34cca34ee..085af28de8c 100644 --- a/service/auditmanager/api_op_TagResource.go +++ b/service/auditmanager/api_op_TagResource.go @@ -28,12 +28,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string - // The tags that are associated with the resource. + // The tags that are associated with the resource. // // This member is required. Tags map[string]string diff --git a/service/auditmanager/api_op_UntagResource.go b/service/auditmanager/api_op_UntagResource.go index 39b170f8e1c..8194ec1242d 100644 --- a/service/auditmanager/api_op_UntagResource.go +++ b/service/auditmanager/api_op_UntagResource.go @@ -28,12 +28,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the specified resource. + // The Amazon Resource Name (ARN) of the specified resource. // // This member is required. ResourceArn *string - // The name or key of the tag. + // The name or key of the tag. // // This member is required. TagKeys []string diff --git a/service/auditmanager/api_op_UpdateAssessment.go b/service/auditmanager/api_op_UpdateAssessment.go index 22210ce86dd..8467b32184d 100644 --- a/service/auditmanager/api_op_UpdateAssessment.go +++ b/service/auditmanager/api_op_UpdateAssessment.go @@ -29,27 +29,27 @@ func (c *Client) UpdateAssessment(ctx context.Context, params *UpdateAssessmentI type UpdateAssessmentInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The scope of the assessment. + // The scope of the assessment. // // This member is required. Scope *types.Scope - // The description of the assessment. + // The description of the assessment. AssessmentDescription *string - // The name of the assessment to be updated. + // The name of the assessment to be updated. AssessmentName *string - // The assessment report storage destination for the assessment that's being + // The assessment report storage destination for the assessment that's being // updated. AssessmentReportsDestination *types.AssessmentReportsDestination - // The list of roles for the assessment. + // The list of roles for the assessment. Roles []types.Role noSmithyDocumentSerde @@ -57,7 +57,7 @@ type UpdateAssessmentInput struct { type UpdateAssessmentOutput struct { - // The response object for the UpdateAssessment API. This is the name of the + // The response object for the UpdateAssessment API. This is the name of the // updated assessment. Assessment *types.Assessment diff --git a/service/auditmanager/api_op_UpdateAssessmentControl.go b/service/auditmanager/api_op_UpdateAssessmentControl.go index a5f05483b04..0154bece94c 100644 --- a/service/auditmanager/api_op_UpdateAssessmentControl.go +++ b/service/auditmanager/api_op_UpdateAssessmentControl.go @@ -29,25 +29,25 @@ func (c *Client) UpdateAssessmentControl(ctx context.Context, params *UpdateAsse type UpdateAssessmentControlInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The unique identifier for the control. + // The unique identifier for the control. // // This member is required. ControlId *string - // The unique identifier for the control set. + // The unique identifier for the control set. // // This member is required. ControlSetId *string - // The comment body text for the control. + // The comment body text for the control. CommentBody *string - // The status of the control. + // The status of the control. ControlStatus types.ControlStatus noSmithyDocumentSerde @@ -55,7 +55,7 @@ type UpdateAssessmentControlInput struct { type UpdateAssessmentControlOutput struct { - // The name of the updated control set that the UpdateAssessmentControl API + // The name of the updated control set that the UpdateAssessmentControl API // returned. Control *types.AssessmentControl diff --git a/service/auditmanager/api_op_UpdateAssessmentControlSetStatus.go b/service/auditmanager/api_op_UpdateAssessmentControlSetStatus.go index 010a72a9642..b5e02d9a088 100644 --- a/service/auditmanager/api_op_UpdateAssessmentControlSetStatus.go +++ b/service/auditmanager/api_op_UpdateAssessmentControlSetStatus.go @@ -29,22 +29,22 @@ func (c *Client) UpdateAssessmentControlSetStatus(ctx context.Context, params *U type UpdateAssessmentControlSetStatusInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The comment that's related to the status update. + // The comment that's related to the status update. // // This member is required. Comment *string - // The unique identifier for the control set. + // The unique identifier for the control set. // // This member is required. ControlSetId *string - // The status of the control set that's being updated. + // The status of the control set that's being updated. // // This member is required. Status types.ControlSetStatus @@ -54,7 +54,7 @@ type UpdateAssessmentControlSetStatusInput struct { type UpdateAssessmentControlSetStatusOutput struct { - // The name of the updated control set that the UpdateAssessmentControlSetStatus + // The name of the updated control set that the UpdateAssessmentControlSetStatus // API returned. ControlSet *types.AssessmentControlSet diff --git a/service/auditmanager/api_op_UpdateAssessmentFramework.go b/service/auditmanager/api_op_UpdateAssessmentFramework.go index 9735422d6ee..b3985a7625b 100644 --- a/service/auditmanager/api_op_UpdateAssessmentFramework.go +++ b/service/auditmanager/api_op_UpdateAssessmentFramework.go @@ -29,26 +29,26 @@ func (c *Client) UpdateAssessmentFramework(ctx context.Context, params *UpdateAs type UpdateAssessmentFrameworkInput struct { - // The control sets that are associated with the framework. + // The control sets that are associated with the framework. // // This member is required. ControlSets []types.UpdateAssessmentFrameworkControlSet - // The unique identifier for the framework. + // The unique identifier for the framework. // // This member is required. FrameworkId *string - // The name of the framework to be updated. + // The name of the framework to be updated. // // This member is required. Name *string - // The compliance type that the new custom framework supports, such as CIS or + // The compliance type that the new custom framework supports, such as CIS or // HIPAA. ComplianceType *string - // The description of the updated framework. + // The description of the updated framework. Description *string noSmithyDocumentSerde @@ -56,7 +56,7 @@ type UpdateAssessmentFrameworkInput struct { type UpdateAssessmentFrameworkOutput struct { - // The name of the framework. + // The name of the framework. Framework *types.Framework // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_UpdateAssessmentFrameworkShare.go b/service/auditmanager/api_op_UpdateAssessmentFrameworkShare.go index 099910bad40..6d0f1b5f5cd 100644 --- a/service/auditmanager/api_op_UpdateAssessmentFrameworkShare.go +++ b/service/auditmanager/api_op_UpdateAssessmentFrameworkShare.go @@ -34,7 +34,7 @@ type UpdateAssessmentFrameworkShareInput struct { // This member is required. Action types.ShareRequestAction - // The unique identifier for the share request. + // The unique identifier for the share request. // // This member is required. RequestId *string @@ -49,7 +49,7 @@ type UpdateAssessmentFrameworkShareInput struct { type UpdateAssessmentFrameworkShareOutput struct { - // The updated share request that's returned by the UpdateAssessmentFrameworkShare + // The updated share request that's returned by the UpdateAssessmentFrameworkShare // operation. AssessmentFrameworkShareRequest *types.AssessmentFrameworkShareRequest diff --git a/service/auditmanager/api_op_UpdateAssessmentStatus.go b/service/auditmanager/api_op_UpdateAssessmentStatus.go index 901129170c9..529f520abc0 100644 --- a/service/auditmanager/api_op_UpdateAssessmentStatus.go +++ b/service/auditmanager/api_op_UpdateAssessmentStatus.go @@ -29,12 +29,12 @@ func (c *Client) UpdateAssessmentStatus(ctx context.Context, params *UpdateAsses type UpdateAssessmentStatusInput struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. // // This member is required. AssessmentId *string - // The current status of the assessment. + // The current status of the assessment. // // This member is required. Status types.AssessmentStatus @@ -44,7 +44,8 @@ type UpdateAssessmentStatusInput struct { type UpdateAssessmentStatusOutput struct { - // The name of the updated assessment that the UpdateAssessmentStatus API returned. + // The name of the updated assessment that the UpdateAssessmentStatus API + // returned. Assessment *types.Assessment // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_UpdateControl.go b/service/auditmanager/api_op_UpdateControl.go index a8e9a341d5a..d3d9edc1773 100644 --- a/service/auditmanager/api_op_UpdateControl.go +++ b/service/auditmanager/api_op_UpdateControl.go @@ -29,31 +29,31 @@ func (c *Client) UpdateControl(ctx context.Context, params *UpdateControlInput, type UpdateControlInput struct { - // The identifier for the control. + // The identifier for the control. // // This member is required. ControlId *string - // The data mapping sources for the control. + // The data mapping sources for the control. // // This member is required. ControlMappingSources []types.ControlMappingSource - // The name of the updated control. + // The name of the updated control. // // This member is required. Name *string - // The recommended actions to carry out if the control isn't fulfilled. + // The recommended actions to carry out if the control isn't fulfilled. ActionPlanInstructions *string - // The title of the action plan for remediating the control. + // The title of the action plan for remediating the control. ActionPlanTitle *string - // The optional description of the control. + // The optional description of the control. Description *string - // The steps that you should follow to determine if the control is met. + // The steps that you should follow to determine if the control is met. TestingInformation *string noSmithyDocumentSerde @@ -61,7 +61,7 @@ type UpdateControlInput struct { type UpdateControlOutput struct { - // The name of the updated control set that the UpdateControl API returned. + // The name of the updated control set that the UpdateControl API returned. Control *types.Control // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_UpdateSettings.go b/service/auditmanager/api_op_UpdateSettings.go index fc3d80ad93c..b1d874f5164 100644 --- a/service/auditmanager/api_op_UpdateSettings.go +++ b/service/auditmanager/api_op_UpdateSettings.go @@ -29,13 +29,13 @@ func (c *Client) UpdateSettings(ctx context.Context, params *UpdateSettingsInput type UpdateSettingsInput struct { - // The default S3 destination bucket for storing assessment reports. + // The default S3 destination bucket for storing assessment reports. DefaultAssessmentReportsDestination *types.AssessmentReportsDestination - // The default S3 destination bucket for storing evidence finder exports. + // The default S3 destination bucket for storing evidence finder exports. DefaultExportDestination *types.DefaultExportDestination - // A list of the default audit owners. + // A list of the default audit owners. DefaultProcessOwners []types.Role // The deregistration policy for your Audit Manager data. You can use this @@ -44,18 +44,21 @@ type UpdateSettingsInput struct { DeregistrationPolicy *types.DeregistrationPolicy // Specifies whether the evidence finder feature is enabled. Change this attribute - // 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) - // Audit Manager. + // 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]and then [re-register] Audit Manager. + // + // [deregister]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html + // [re-register]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html EvidenceFinderEnabled *bool - // The KMS key details. + // The KMS key details. KmsKey *string - // The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager + // The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager // sends notifications to. SnsTopic *string @@ -64,7 +67,7 @@ type UpdateSettingsInput struct { type UpdateSettingsOutput struct { - // The current list of settings. + // The current list of settings. Settings *types.Settings // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/api_op_ValidateAssessmentReportIntegrity.go b/service/auditmanager/api_op_ValidateAssessmentReportIntegrity.go index f41aa171e6f..306166fb641 100644 --- a/service/auditmanager/api_op_ValidateAssessmentReportIntegrity.go +++ b/service/auditmanager/api_op_ValidateAssessmentReportIntegrity.go @@ -28,7 +28,7 @@ func (c *Client) ValidateAssessmentReportIntegrity(ctx context.Context, params * type ValidateAssessmentReportIntegrityInput struct { - // The relative path of the Amazon S3 bucket that the assessment report is stored + // The relative path of the Amazon S3 bucket that the assessment report is stored // in. // // This member is required. @@ -39,20 +39,20 @@ type ValidateAssessmentReportIntegrityInput struct { type ValidateAssessmentReportIntegrityOutput struct { - // The signature algorithm that's used to code sign the assessment report file. + // The signature algorithm that's used to code sign the assessment report file. SignatureAlgorithm *string - // The date and time signature that specifies when the assessment report was + // The date and time signature that specifies when the assessment report was // created. SignatureDateTime *string - // The unique identifier for the validation signature key. + // The unique identifier for the validation signature key. SignatureKeyId *string - // Specifies whether the signature key is valid. + // Specifies whether the signature key is valid. SignatureValid *bool - // Represents any errors that occurred when validating the assessment report. + // Represents any errors that occurred when validating the assessment report. ValidationErrors []string // Metadata pertaining to the operation's result. diff --git a/service/auditmanager/doc.go b/service/auditmanager/doc.go index 37d37ad9e70..be1a491e8db 100644 --- a/service/auditmanager/doc.go +++ b/service/auditmanager/doc.go @@ -5,26 +5,38 @@ // // Welcome to the Audit Manager API reference. This guide is for developers who // need detailed information about the Audit Manager API operations, data types, -// and errors. Audit Manager is a service that provides automated evidence -// collection so that you can continually audit your Amazon Web Services usage. You -// can use it to assess the effectiveness of your controls, manage risk, and -// simplify compliance. Audit Manager provides prebuilt frameworks that structure -// and automate assessments for a given compliance standard. Frameworks include a -// prebuilt collection of controls with descriptions and testing procedures. These -// controls are grouped according to the requirements of the specified compliance -// 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. -// -// 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) -// . +// and errors. +// +// Audit Manager is a service that provides automated evidence collection so that +// you can continually audit your Amazon Web Services usage. You can use it to +// assess the effectiveness of your controls, manage risk, and simplify compliance. +// +// Audit Manager provides prebuilt frameworks that structure and automate +// assessments for a given compliance standard. Frameworks include a prebuilt +// collection of controls with descriptions and testing procedures. These controls +// are grouped according to the requirements of the specified compliance 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] +// - : An alphabetical list of all Audit Manager API operations. +// +// [Data types] +// - : An alphabetical list of all Audit Manager data types. +// +// [Common parameters] +// - : Parameters that all operations can use. +// +// [Common errors] +// - : 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]. +// +// [Common errors]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html +// [Actions]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html +// [Data types]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html +// [Common parameters]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html +// [Audit Manager User Guide]: https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html package auditmanager diff --git a/service/auditmanager/options.go b/service/auditmanager/options.go index 2844f7ba499..a0e04695a74 100644 --- a/service/auditmanager/options.go +++ b/service/auditmanager/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/auditmanager/types/enums.go b/service/auditmanager/types/enums.go index 18a7cb96c7f..8f8e43fa16d 100644 --- a/service/auditmanager/types/enums.go +++ b/service/auditmanager/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AccountStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountStatus) Values() []AccountStatus { return []AccountStatus{ "ACTIVE", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for ActionEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionEnum) Values() []ActionEnum { return []ActionEnum{ "CREATE", @@ -61,8 +63,9 @@ const ( // Values returns all known values for AssessmentReportDestinationType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentReportDestinationType) Values() []AssessmentReportDestinationType { return []AssessmentReportDestinationType{ "S3", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for AssessmentReportStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentReportStatus) Values() []AssessmentReportStatus { return []AssessmentReportStatus{ "COMPLETE", @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for AssessmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentStatus) Values() []AssessmentStatus { return []AssessmentStatus{ "ACTIVE", @@ -118,8 +123,9 @@ const ( ) // Values returns all known values for ControlResponse. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlResponse) Values() []ControlResponse { return []ControlResponse{ "MANUAL", @@ -139,8 +145,9 @@ const ( ) // Values returns all known values for ControlSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlSetStatus) Values() []ControlSetStatus { return []ControlSetStatus{ "ACTIVE", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for ControlStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlStatus) Values() []ControlStatus { return []ControlStatus{ "UNDER_REVIEW", @@ -178,8 +186,9 @@ const ( ) // Values returns all known values for ControlType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlType) Values() []ControlType { return []ControlType{ "Standard", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for DelegationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DelegationStatus) Values() []DelegationStatus { return []DelegationStatus{ "IN_PROGRESS", @@ -216,8 +226,9 @@ const ( ) // Values returns all known values for DeleteResources. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteResources) Values() []DeleteResources { return []DeleteResources{ "ALL", @@ -236,8 +247,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvidenceFinderBackfillStatus) Values() []EvidenceFinderBackfillStatus { return []EvidenceFinderBackfillStatus{ "NOT_STARTED", @@ -258,8 +270,9 @@ const ( // Values returns all known values for EvidenceFinderEnablementStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvidenceFinderEnablementStatus) Values() []EvidenceFinderEnablementStatus { return []EvidenceFinderEnablementStatus{ "ENABLED", @@ -277,8 +290,9 @@ const ( ) // Values returns all known values for ExportDestinationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportDestinationType) Values() []ExportDestinationType { return []ExportDestinationType{ "S3", @@ -294,8 +308,9 @@ const ( ) // Values returns all known values for FrameworkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FrameworkType) Values() []FrameworkType { return []FrameworkType{ "Standard", @@ -313,8 +328,9 @@ const ( ) // Values returns all known values for KeywordInputType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeywordInputType) Values() []KeywordInputType { return []KeywordInputType{ "SELECT_FROM_LIST", @@ -335,8 +351,9 @@ const ( ) // Values returns all known values for ObjectTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectTypeEnum) Values() []ObjectTypeEnum { return []ObjectTypeEnum{ "ASSESSMENT", @@ -356,8 +373,9 @@ const ( ) // Values returns all known values for RoleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoleType) Values() []RoleType { return []RoleType{ "PROCESS_OWNER", @@ -380,8 +398,9 @@ const ( ) // Values returns all known values for SettingAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SettingAttribute) Values() []SettingAttribute { return []SettingAttribute{ "ALL", @@ -405,8 +424,9 @@ const ( ) // Values returns all known values for ShareRequestAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareRequestAction) Values() []ShareRequestAction { return []ShareRequestAction{ "ACCEPT", @@ -430,8 +450,9 @@ const ( ) // Values returns all known values for ShareRequestStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareRequestStatus) Values() []ShareRequestStatus { return []ShareRequestStatus{ "ACTIVE", @@ -454,8 +475,9 @@ const ( ) // Values returns all known values for ShareRequestType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareRequestType) Values() []ShareRequestType { return []ShareRequestType{ "SENT", @@ -473,8 +495,9 @@ const ( ) // Values returns all known values for SourceFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceFrequency) Values() []SourceFrequency { return []SourceFrequency{ "DAILY", @@ -492,8 +515,9 @@ const ( ) // Values returns all known values for SourceSetUpOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceSetUpOption) Values() []SourceSetUpOption { return []SourceSetUpOption{ "System_Controls_Mapping", @@ -513,8 +537,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "AWS_Cloudtrail", @@ -537,6 +562,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/auditmanager/types/errors.go b/service/auditmanager/types/errors.go index 73e1c5d86f8..2213a6dbdb4 100644 --- a/service/auditmanager/types/errors.go +++ b/service/auditmanager/types/errors.go @@ -7,7 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// Your account isn't registered with Audit Manager. Check the delegated +// Your account isn't registered with Audit Manager. Check the delegated +// // administrator setup on the Audit Manager settings page, and try again. type AccessDeniedException struct { Message *string @@ -34,7 +35,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An internal service error occurred during the processing of your request. Try +// An internal service error occurred during the processing of your request. Try +// // again later. type InternalServerException struct { Message *string @@ -91,10 +93,11 @@ 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]from the Service Quotas +// console. For a list of Audit Manager service quotas, see [Quotas and restrictions for Audit Manager]. +// +// [request a quota increase]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html +// [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 efc930c4762..aa5b62354ce 100644 --- a/service/auditmanager/types/types.go +++ b/service/auditmanager/types/types.go @@ -7,57 +7,59 @@ import ( "time" ) -// An entity that defines the scope of audit evidence collected by Audit Manager. +// An entity that defines the scope of audit evidence collected by Audit Manager. +// // An Audit Manager assessment is an implementation of an Audit Manager framework. type Assessment struct { - // The Amazon Resource Name (ARN) of the assessment. + // The Amazon Resource Name (ARN) of the assessment. Arn *string - // The Amazon Web Services account that's associated with the assessment. + // The Amazon Web Services account that's associated with the assessment. AwsAccount *AWSAccount - // The framework that the assessment was created from. + // The framework that the assessment was created from. Framework *AssessmentFramework - // The metadata for the assessment. + // The metadata for the assessment. Metadata *AssessmentMetadata - // The tags that are associated with the assessment. + // The tags that are associated with the assessment. Tags map[string]string noSmithyDocumentSerde } -// The control entity that represents a standard control or a custom control in an -// Audit Manager assessment. +// The control entity that represents a standard control or a custom control in +// +// an Audit Manager assessment. type AssessmentControl struct { - // The amount of evidence in the assessment report. + // The amount of evidence in the assessment report. AssessmentReportEvidenceCount int32 - // The list of comments that's attached to the control. + // The list of comments that's attached to the control. Comments []ControlComment - // The description of the control. + // The description of the control. Description *string - // The amount of evidence that's collected for the control. + // The amount of evidence that's collected for the control. EvidenceCount int32 - // The list of data sources for the evidence. + // The list of data sources for the evidence. EvidenceSources []string - // The identifier for the control. + // The identifier for the control. Id *string - // The name of the control. + // The name of the control. Name *string - // The response of the control. + // The response of the control. Response ControlResponse - // The status of the control. + // The status of the control. Status ControlStatus noSmithyDocumentSerde @@ -66,30 +68,30 @@ type AssessmentControl struct { // Represents a set of controls in an Audit Manager assessment. type AssessmentControlSet struct { - // The list of controls that's contained with the control set. + // The list of controls that's contained with the control set. Controls []AssessmentControl - // The delegations that are associated with the control set. + // The delegations that are associated with the control set. Delegations []Delegation - // The description for the control set. + // The description for the control set. Description *string - // The identifier of the control set in the assessment. This is the control set + // The identifier of the control set in the assessment. This is the control set // name in a plain string format. Id *string - // The total number of evidence objects that are uploaded manually to the control + // The total number of evidence objects that are uploaded manually to the control // set. ManualEvidenceCount int32 - // The roles that are associated with the control set. + // The roles that are associated with the control set. Roles []Role - // The current status of the control set. + // The current status of the control set. Status ControlSetStatus - // The total number of evidence objects that are retrieved automatically for the + // The total number of evidence objects that are retrieved automatically for the // control set. SystemEvidenceCount int32 @@ -99,124 +101,127 @@ type AssessmentControlSet struct { // The folder where Audit Manager stores evidence for an assessment. type AssessmentEvidenceFolder struct { - // The identifier for the assessment. + // The identifier for the assessment. AssessmentId *string - // The total count of evidence that's included in the assessment report. + // The total count of evidence that's included in the assessment report. AssessmentReportSelectionCount int32 - // The name of the user who created the evidence folder. + // The name of the user who created the evidence folder. Author *string - // The unique identifier for the control. + // The unique identifier for the control. ControlId *string - // The name of the control. + // The name of the control. ControlName *string - // The identifier for the control set. + // The identifier for the control set. ControlSetId *string - // The Amazon Web Service that the evidence was collected from. + // The Amazon Web Service that the evidence was collected from. DataSource *string - // The date when the first evidence was added to the evidence folder. + // 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 + // 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 + // The number of evidence that falls under the compliance check category. This // evidence is collected from Config or Security Hub. EvidenceByTypeComplianceCheckCount int32 - // The total number of issues that were reported directly from Security Hub, + // The total number of issues that were reported directly from Security Hub, // Config, or both. EvidenceByTypeComplianceCheckIssuesCount int32 - // The number of evidence that falls under the configuration data category. This + // The number of evidence that falls under the configuration data category. This // evidence is collected from configuration snapshots of other Amazon Web Services // such as Amazon EC2, Amazon S3, or IAM. EvidenceByTypeConfigurationDataCount int32 - // The number of evidence that falls under the manual category. This evidence is + // The number of evidence that falls under the manual category. This evidence is // imported manually. EvidenceByTypeManualCount int32 - // The number of evidence that falls under the user activity category. This + // The number of evidence that falls under the user activity category. This // evidence is collected from CloudTrail logs. EvidenceByTypeUserActivityCount int32 - // The amount of evidence that's included in the evidence folder. + // The amount of evidence that's included in the evidence folder. EvidenceResourcesIncludedCount int32 - // The identifier for the folder that the evidence is stored in. + // The identifier for the folder that the evidence is stored in. Id *string - // The name of the evidence folder. + // The name of the evidence folder. Name *string - // The total amount of evidence in the evidence folder. + // The total amount of evidence in the evidence folder. TotalEvidence int32 noSmithyDocumentSerde } -// The file used to structure and automate Audit Manager assessments for a given +// The file used to structure and automate Audit Manager assessments for a given +// // compliance standard. type AssessmentFramework struct { - // The Amazon Resource Name (ARN) of the framework. + // The Amazon Resource Name (ARN) of the framework. Arn *string - // The control sets that are associated with the framework. + // The control sets that are associated with the framework. ControlSets []AssessmentControlSet - // The unique identifier for the framework. + // The unique identifier for the framework. Id *string - // The metadata of a framework, such as the name, ID, or description. + // The metadata of a framework, such as the name, ID, or description. Metadata *FrameworkMetadata noSmithyDocumentSerde } -// The metadata that's associated with a standard framework or a custom framework. +// The metadata that's associated with a standard framework or a custom +// +// framework. type AssessmentFrameworkMetadata struct { - // The Amazon Resource Name (ARN) of the framework. + // The Amazon Resource Name (ARN) of the framework. Arn *string - // The compliance type that the new custom framework supports, such as CIS or + // The compliance type that the new custom framework supports, such as CIS or // HIPAA. ComplianceType *string - // The number of control sets that are associated with the framework. + // The number of control sets that are associated with the framework. ControlSetsCount int32 - // The number of controls that are associated with the framework. + // The number of controls that are associated with the framework. ControlsCount int32 - // The time when the framework was created. + // The time when the framework was created. CreatedAt *time.Time - // The description of the framework. + // The description of the framework. Description *string - // The unique identifier for the framework. + // The unique identifier for the framework. Id *string - // The time when the framework was most recently updated. + // The time when the framework was most recently updated. LastUpdatedAt *time.Time - // The logo that's associated with the framework. + // The logo that's associated with the framework. Logo *string - // The name of the framework. + // The name of the framework. Name *string - // The framework type, such as a standard framework or a custom framework. + // The framework type, such as a standard framework or a custom framework. Type FrameworkType noSmithyDocumentSerde @@ -225,26 +230,26 @@ type AssessmentFrameworkMetadata struct { // Represents a share request for a custom framework in Audit Manager. type AssessmentFrameworkShareRequest struct { - // An optional comment from the sender about the share request. + // An optional comment from the sender about the share request. Comment *string // The compliance type that the shared custom framework supports, such as CIS or // HIPAA. ComplianceType *string - // The time when the share request was created. + // The time when the share request was created. CreationTime *time.Time // The number of custom controls that are part of the shared custom framework. CustomControlsCount *int32 - // The Amazon Web Services account of the recipient. + // The Amazon Web Services account of the recipient. DestinationAccount *string - // The Amazon Web Services Region of the recipient. + // The Amazon Web Services Region of the recipient. DestinationRegion *string - // The time when the share request expires. + // The time when the share request expires. ExpirationTime *time.Time // The description of the shared custom framework. @@ -253,22 +258,22 @@ type AssessmentFrameworkShareRequest struct { // The unique identifier for the shared custom framework. FrameworkId *string - // The name of the custom framework that the share request is for. + // The name of the custom framework that the share request is for. FrameworkName *string - // The unique identifier for the share request. + // The unique identifier for the share request. Id *string - // Specifies when the share request was last updated. + // Specifies when the share request was last updated. LastUpdated *time.Time - // The Amazon Web Services account of the sender. + // The Amazon Web Services account of the sender. SourceAccount *string // The number of standard controls that are part of the shared custom framework. StandardControlsCount *int32 - // The status of the share request. + // The status of the share request. Status ShareRequestStatus noSmithyDocumentSerde @@ -277,39 +282,39 @@ type AssessmentFrameworkShareRequest struct { // The metadata that's associated with the specified assessment. type AssessmentMetadata struct { - // The destination that evidence reports are stored in for the assessment. + // The destination that evidence reports are stored in for the assessment. AssessmentReportsDestination *AssessmentReportsDestination - // The name of the compliance standard that's related to the assessment, such as + // The name of the compliance standard that's related to the assessment, such as // PCI-DSS. ComplianceType *string - // Specifies when the assessment was created. + // Specifies when the assessment was created. CreationTime *time.Time - // The delegations that are associated with the assessment. + // The delegations that are associated with the assessment. Delegations []Delegation - // The description of the assessment. + // The description of the assessment. Description *string - // The unique identifier for the assessment. + // The unique identifier for the assessment. Id *string - // The time of the most recent update. + // The time of the most recent update. LastUpdated *time.Time - // The name of the assessment. + // The name of the assessment. Name *string - // The roles that are associated with the assessment. + // The roles that are associated with the assessment. Roles []Role - // The wrapper of Amazon Web Services accounts and services that are in scope for + // The wrapper of Amazon Web Services accounts and services that are in scope for // the assessment. Scope *Scope - // The overall status of the assessment. + // The overall status of the assessment. Status AssessmentStatus noSmithyDocumentSerde @@ -318,81 +323,83 @@ type AssessmentMetadata struct { // A metadata object that's associated with an assessment in Audit Manager. type AssessmentMetadataItem struct { - // The name of the compliance standard that's related to the assessment, such as + // The name of the compliance standard that's related to the assessment, such as // PCI-DSS. ComplianceType *string - // Specifies when the assessment was created. + // Specifies when the assessment was created. CreationTime *time.Time - // The delegations that are associated with the assessment. + // The delegations that are associated with the assessment. Delegations []Delegation - // The unique identifier for the assessment. + // The unique identifier for the assessment. Id *string - // The time of the most recent update. + // The time of the most recent update. LastUpdated *time.Time - // The name of the assessment. + // The name of the assessment. Name *string - // The roles that are associated with the assessment. + // The roles that are associated with the assessment. Roles []Role - // The current status of the assessment. + // The current status of the assessment. Status AssessmentStatus noSmithyDocumentSerde } -// A finalized document that's generated from an Audit Manager assessment. These +// A finalized document that's generated from an Audit Manager assessment. These +// // reports summarize the relevant evidence that was collected for your audit, and // link to the relevant evidence folders. These evidence folders are named and // organized according to the controls that are specified in your assessment. type AssessmentReport struct { - // The identifier for the specified assessment. + // The identifier for the specified assessment. AssessmentId *string - // The name of the associated assessment. + // The name of the associated assessment. AssessmentName *string - // The name of the user who created the assessment report. + // The name of the user who created the assessment report. Author *string - // The identifier for the specified Amazon Web Services account. + // The identifier for the specified Amazon Web Services account. AwsAccountId *string - // Specifies when the assessment report was created. + // Specifies when the assessment report was created. CreationTime *time.Time - // The description of the specified assessment report. + // The description of the specified assessment report. Description *string - // The unique identifier for the assessment report. + // The unique identifier for the assessment report. Id *string - // The name that's given to the assessment report. + // The name that's given to the assessment report. Name *string - // The current status of the specified assessment report. + // The current status of the specified assessment report. Status AssessmentReportStatus noSmithyDocumentSerde } -// An error entity for assessment report evidence errors. This is used to provide +// An error entity for assessment report evidence errors. This is used to provide +// // more meaningful errors than a simple string message. type AssessmentReportEvidenceError struct { - // The error code that was returned. + // The error code that was returned. ErrorCode *string - // The error message that was returned. + // The error message that was returned. ErrorMessage *string - // The identifier for the evidence. + // The identifier for the evidence. EvidenceId *string noSmithyDocumentSerde @@ -401,141 +408,154 @@ type AssessmentReportEvidenceError struct { // The metadata objects that are associated with the specified assessment report. type AssessmentReportMetadata struct { - // The unique identifier for the associated assessment. + // The unique identifier for the associated assessment. AssessmentId *string // The name of the associated assessment. AssessmentName *string - // The name of the user who created the assessment report. + // The name of the user who created the assessment report. Author *string - // Specifies when the assessment report was created. + // Specifies when the assessment report was created. CreationTime *time.Time - // The description of the assessment report. + // The description of the assessment report. Description *string - // The unique identifier for the assessment report. + // The unique identifier for the assessment report. Id *string - // The name of the assessment report. + // The name of the assessment report. Name *string - // The current status of the assessment report. + // The current status of the assessment report. Status AssessmentReportStatus noSmithyDocumentSerde } -// The location where Audit Manager saves assessment reports for the given +// The location where Audit Manager saves assessment reports for the given +// // assessment. type AssessmentReportsDestination struct { - // The destination bucket where Audit Manager stores assessment reports. + // The destination bucket where Audit Manager stores assessment reports. Destination *string - // The destination type, such as Amazon S3. + // The destination type, such as Amazon S3. DestinationType AssessmentReportDestinationType noSmithyDocumentSerde } -// The wrapper of Amazon Web Services account details, such as account ID or email -// address. +// The wrapper of Amazon Web Services account details, such as account ID or +// +// email address. type AWSAccount struct { - // The email address that's associated with the Amazon Web Services account. + // The email address that's associated with the Amazon Web Services account. EmailAddress *string - // The identifier for the Amazon Web Services account. + // The identifier for the Amazon Web Services account. Id *string - // The name of the Amazon Web Services account. + // The name of the Amazon Web Services account. Name *string noSmithyDocumentSerde } -// 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) +// 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] +// +// [Defining an Amazon Web Service name in your assessment scope] +// +// [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 type AWSService struct { - // The name of the Amazon Web Service. + // The name of the Amazon Web Service. ServiceName *string noSmithyDocumentSerde } -// An error entity for the BatchCreateDelegationByAssessment API. This is used to +// An error entity for the BatchCreateDelegationByAssessment API. This is used to +// // provide more meaningful errors than a simple string message. type BatchCreateDelegationByAssessmentError struct { - // The API request to batch create delegations in Audit Manager. + // The API request to batch create delegations in Audit Manager. CreateDelegationRequest *CreateDelegationRequest - // The error code that the BatchCreateDelegationByAssessment API returned. + // The error code that the BatchCreateDelegationByAssessment API returned. ErrorCode *string - // The error message that the BatchCreateDelegationByAssessment API returned. + // The error message that the BatchCreateDelegationByAssessment API returned. ErrorMessage *string noSmithyDocumentSerde } -// An error entity for the BatchDeleteDelegationByAssessment API. This is used to +// An error entity for the BatchDeleteDelegationByAssessment API. This is used to +// // provide more meaningful errors than a simple string message. type BatchDeleteDelegationByAssessmentError struct { - // The identifier for the delegation. + // The identifier for the delegation. DelegationId *string - // The error code that the BatchDeleteDelegationByAssessment API returned. + // The error code that the BatchDeleteDelegationByAssessment API returned. ErrorCode *string - // The error message that the BatchDeleteDelegationByAssessment API returned. + // The error message that the BatchDeleteDelegationByAssessment API returned. ErrorMessage *string noSmithyDocumentSerde } -// An error entity for the BatchImportEvidenceToAssessmentControl API. This is +// 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. + // The error code that the BatchImportEvidenceToAssessmentControl API returned. ErrorCode *string - // The error message that the BatchImportEvidenceToAssessmentControl API returned. + // The error message that the BatchImportEvidenceToAssessmentControl API + // returned. ErrorMessage *string - // Manual evidence that can't be collected automatically by Audit Manager. + // Manual evidence that can't be collected automatically by Audit Manager. ManualEvidence *ManualEvidence noSmithyDocumentSerde } -// The record of a change within Audit Manager. For example, this could be the +// The record of a change within Audit Manager. For example, this could be the +// // status change of an assessment or the delegation of a control set. type ChangeLog struct { - // The action that was performed. + // The action that was performed. Action ActionEnum - // The time when the action was performed and the changelog record was created. + // The time when the action was performed and the changelog record was created. CreatedAt *time.Time - // The user or role that performed the action. + // The user or role that performed the action. CreatedBy *string - // The name of the object that changed. This could be the name of an assessment, + // The name of the object that changed. This could be the name of an assessment, // control, or control set. ObjectName *string - // The object that was changed, such as an assessment, control, or control set. + // The object that was changed, such as an assessment, control, or control set. ObjectType ObjectTypeEnum noSmithyDocumentSerde @@ -544,74 +564,77 @@ type ChangeLog struct { // A control in Audit Manager. type Control struct { - // The recommended actions to carry out if the control isn't fulfilled. + // The recommended actions to carry out if the control isn't fulfilled. ActionPlanInstructions *string - // The title of the action plan for remediating the control. + // The title of the action plan for remediating the control. ActionPlanTitle *string - // The Amazon Resource Name (ARN) of the control. + // The Amazon Resource Name (ARN) of the control. Arn *string - // The data mapping sources for the control. + // The data mapping sources for the control. ControlMappingSources []ControlMappingSource - // The data source types that determine where Audit Manager collects evidence from - // for the control. + // The data source types that determine where Audit Manager collects evidence + // from for the control. ControlSources *string - // The time when the control was created. + // The time when the control was created. CreatedAt *time.Time - // The user or role that created the control. + // The user or role that created the control. CreatedBy *string - // The description of the control. + // The description of the control. Description *string - // The unique identifier for the control. + // The unique identifier for the control. Id *string - // The time when the control was most recently updated. + // The time when the control was most recently updated. LastUpdatedAt *time.Time - // The user or role that most recently updated the control. + // The user or role that most recently updated the control. LastUpdatedBy *string - // The name of the control. + // The name of the control. Name *string - // The tags associated with the control. + // The tags associated with the control. Tags map[string]string - // The steps that you should follow to determine if the control has been satisfied. + // The steps that you should follow to determine if the control has been + // satisfied. TestingInformation *string - // Specifies whether the control is a standard control or a custom control. + // Specifies whether the control is a standard control or a custom control. Type ControlType noSmithyDocumentSerde } -// A comment that's posted by a user on a control. This includes the author's +// 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. + // The name of the user who authored the comment. AuthorName *string - // The body text of a control comment. + // The body text of a control comment. CommentBody *string - // The time when the comment was posted. + // The time when the comment was posted. PostedDate *time.Time noSmithyDocumentSerde } -// A summary of the latest analytics data for a specific control domain. Control -// domain insights are grouped by control domain, and ranked by the highest total -// count of non-compliant evidence. +// A summary of the latest analytics data for a specific control domain. +// +// Control domain insights are grouped by control domain, and ranked by the +// highest total count of non-compliant evidence. type ControlDomainInsights struct { // The number of controls in the control domain that collected non-compliant @@ -638,8 +661,10 @@ type ControlDomainInsights struct { } // A summary of the latest analytics data for a specific control in a specific -// active assessment. Control insights are grouped by control domain, and ranked by -// the highest total count of non-compliant evidence. +// active assessment. +// +// Control insights are grouped by control domain, and ranked by the highest total +// count of non-compliant evidence. type ControlInsightsMetadataByAssessmentItem struct { // The name of the control set that the assessment control belongs to. @@ -661,8 +686,9 @@ type ControlInsightsMetadataByAssessmentItem struct { noSmithyDocumentSerde } -// A summary of the latest analytics data for a specific control. This data -// reflects the total counts for the specified control across all active +// A summary of the latest analytics data for a specific control. +// +// This data reflects the total counts for the specified control across all active // assessments. Control insights are grouped by control domain, and ranked by the // highest total count of non-compliant evidence. type ControlInsightsMetadataItem struct { @@ -683,42 +709,56 @@ type ControlInsightsMetadataItem struct { noSmithyDocumentSerde } -// The data source that determines where Audit Manager collects evidence from for +// The data source that determines where Audit Manager collects evidence from for +// // the control. type ControlMappingSource struct { - // The description of the source. + // The description of the source. SourceDescription *string // Specifies how often evidence is collected from the control mapping source. SourceFrequency SourceFrequency - // The unique identifier for the source. + // The unique identifier for the source. SourceId *string - // A keyword that relates to the control data source. For manual evidence, this - // keyword indicates if the manual evidence is a file or text. For automated - // evidence, this keyword identifies a specific CloudTrail event, Config rule, - // Security Hub control, or Amazon Web Services API name. 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-config.html) - // - Security Hub controls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.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) + // A keyword that relates to the control data source. + // + // For manual evidence, this keyword indicates if the manual evidence is a file or + // text. + // + // For automated evidence, this keyword identifies a specific CloudTrail event, + // Config rule, Security Hub control, or Amazon Web Services API name. + // + // 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] + // + // [Security Hub controls supported by Audit Manager] + // + // [API calls supported by Audit Manager] + // + // [CloudTrail event names supported by Audit Manager] + // + // [Config rules supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html + // [CloudTrail event names supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html + // [Security Hub controls supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html + // [API calls supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html SourceKeyword *SourceKeyword - // The name of the source. + // The name of the source. SourceName *string - // The setup option for the data source. This option reflects if the evidence + // The setup option for the data source. This option reflects if the evidence // collection is automated or manual. SourceSetUpOption SourceSetUpOption - // Specifies one of the five data source types for evidence collection. + // Specifies one of the five data source types for evidence collection. SourceType SourceType - // The instructions for troubleshooting the control. + // The instructions for troubleshooting the control. TroubleshootingText *string noSmithyDocumentSerde @@ -727,23 +767,23 @@ type ControlMappingSource struct { // The metadata that's associated with the standard control or custom control. type ControlMetadata struct { - // The Amazon Resource Name (ARN) of the control. + // The Amazon Resource Name (ARN) of the control. Arn *string - // The data source that determines where Audit Manager collects evidence from for + // The data source that determines where Audit Manager collects evidence from for // the control. ControlSources *string - // The time when the control was created. + // The time when the control was created. CreatedAt *time.Time - // The unique identifier for the control. + // The unique identifier for the control. Id *string - // The time when the control was most recently updated. + // The time when the control was most recently updated. LastUpdatedAt *time.Time - // The name of the control. + // The name of the control. Name *string noSmithyDocumentSerde @@ -752,24 +792,25 @@ type ControlMetadata struct { // A set of controls in Audit Manager. type ControlSet struct { - // The list of controls within the control set. + // The list of controls within the control set. Controls []Control - // The identifier of the control set in the assessment. This is the control set + // The identifier of the control set in the assessment. This is the control set // name in a plain string format. Id *string - // The name of the control set. + // The name of the control set. Name *string noSmithyDocumentSerde } -// The control entity attributes that uniquely identify an existing control to be +// The control entity attributes that uniquely identify an existing control to be +// // added to a framework in Audit Manager. type CreateAssessmentFrameworkControl struct { - // The unique identifier of the control. + // The unique identifier of the control. // // This member is required. Id *string @@ -777,77 +818,97 @@ type CreateAssessmentFrameworkControl struct { noSmithyDocumentSerde } -// A controlSet entity that represents a collection of controls in Audit Manager. +// A controlSet entity that represents a collection of controls in Audit Manager. +// // This doesn't contain the control set ID. type CreateAssessmentFrameworkControlSet struct { - // The name of the control set. + // The name of the control set. // // This member is required. Name *string - // The list of controls within the control set. This doesn't contain the control + // The list of controls within the control set. This doesn't contain the control // set ID. Controls []CreateAssessmentFrameworkControl noSmithyDocumentSerde } -// The control mapping fields that represent the source for evidence collection, +// The control mapping fields that represent the source for evidence collection, +// // 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 - // evidence from for the control. + // The description of the data source that determines where Audit Manager + // collects evidence from for the control. SourceDescription *string // Specifies how often evidence is collected from the control mapping source. SourceFrequency SourceFrequency - // A keyword that relates to the control data source. For manual evidence, this - // keyword indicates if the manual evidence is a file or text. For automated - // evidence, this keyword identifies a specific CloudTrail event, Config rule, - // Security Hub control, or Amazon Web Services API name. 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-config.html) - // - Security Hub controls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.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) + // A keyword that relates to the control data source. + // + // For manual evidence, this keyword indicates if the manual evidence is a file or + // text. + // + // For automated evidence, this keyword identifies a specific CloudTrail event, + // Config rule, Security Hub control, or Amazon Web Services API name. + // + // 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] + // + // [Security Hub controls supported by Audit Manager] + // + // [API calls supported by Audit Manager] + // + // [CloudTrail event names supported by Audit Manager] + // + // [Config rules supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html + // [CloudTrail event names supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html + // [Security Hub controls supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html + // [API calls supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html SourceKeyword *SourceKeyword - // The name of the control mapping data source. + // The name of the control mapping data source. SourceName *string - // The setup option for the data source, which reflects if the evidence collection - // is automated or manual. + // The setup option for the data source, which reflects if the evidence + // collection is automated or manual. SourceSetUpOption SourceSetUpOption - // Specifies one of the five types of data sources for evidence collection. + // Specifies one of the five types of data sources for evidence collection. SourceType SourceType - // The instructions for troubleshooting the control. + // The instructions for troubleshooting the control. TroubleshootingText *string noSmithyDocumentSerde } -// A collection of attributes that's used to create a delegation for an assessment -// in Audit Manager. +// A collection of attributes that's used to create a delegation for an +// +// assessment in Audit Manager. type CreateDelegationRequest struct { - // A comment that's related to the delegation request. + // A comment that's related to the delegation request. Comment *string - // The unique identifier for the control set. + // The unique identifier for the control set. ControlSetId *string - // The Amazon Resource Name (ARN) of the IAM role. + // 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 @@ -869,39 +930,43 @@ type DefaultExportDestination struct { // The assignment of a control set to a delegate for review. type Delegation struct { - // The identifier for the assessment that's associated with the delegation. + // The identifier for the assessment that's associated with the delegation. AssessmentId *string - // The name of the assessment that's associated with the delegation. + // The name of the assessment that's associated with the delegation. AssessmentName *string - // The comment that's related to the delegation. + // The comment that's related to the delegation. Comment *string - // The identifier for the control set that's associated with the delegation. + // The identifier for the control set that's associated with the delegation. ControlSetId *string - // The user or role that created the delegation. + // The user or role that created the delegation. CreatedBy *string - // Specifies when the delegation was created. + // Specifies when the delegation was created. CreationTime *time.Time - // The unique identifier for the delegation. + // The unique identifier for the delegation. Id *string - // Specifies when the delegation was last updated. + // Specifies when the delegation was last updated. LastUpdated *time.Time - // The Amazon Resource Name (ARN) of the IAM role. + // 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. + // The status of the delegation. Status DelegationStatus noSmithyDocumentSerde @@ -910,49 +975,56 @@ type Delegation struct { // The metadata that's associated with the delegation. type DelegationMetadata struct { - // The unique identifier for the assessment. + // The unique identifier for the assessment. AssessmentId *string - // The name of the associated assessment. + // The name of the associated assessment. AssessmentName *string - // Specifies the name of the control set that was delegated for review. + // Specifies the name of the control set that was delegated for review. ControlSetName *string - // Specifies when the delegation was created. + // Specifies when the delegation was created. CreationTime *time.Time - // The unique identifier for the delegation. + // The unique identifier for the delegation. Id *string - // The Amazon Resource Name (ARN) of the IAM role. + // The Amazon Resource Name (ARN) of the IAM role. RoleArn *string - // The current status of the delegation. + // The current status of the delegation. Status DelegationStatus noSmithyDocumentSerde } // 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 +// use this attribute to determine how your data is handled when you [deregister Audit Manager]. +// +// 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) -// 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 -// assessments, custom controls, and custom frameworks. Your data will not be -// available if you re-register Audit Manager in the future. +// available if you [re-register Audit Manager]in the future. For more information about data retention, see [Data Protection] +// 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 assessments, custom controls, and custom +// frameworks. Your data will not be available if you re-register Audit Manager in +// the future. +// +// [Data Protection]: https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html +// [re-register Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html +// [deregister Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html 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 @@ -963,32 +1035,36 @@ type DeregistrationPolicy struct { noSmithyDocumentSerde } -// A record that contains the information needed to demonstrate compliance with +// 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 { - // Specifies whether the evidence is included in the assessment report. + // Specifies whether the evidence is included in the assessment report. AssessmentReportSelection *string - // The names and values that are used by the evidence event. This includes an + // 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 ). Attributes map[string]string - // The identifier for the Amazon Web Services account. + // The identifier for the Amazon Web Services account. AwsAccountId *string - // The Amazon Web Services account that the evidence is collected from, and its + // The Amazon Web Services account that the evidence is collected from, and its // organization path. AwsOrganization *string // 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 @@ -997,34 +1073,35 @@ type Evidence struct { // Amazon Web Services API calls, or CloudTrail). ComplianceCheck *string - // The data source where the evidence was collected from. + // The data source where the evidence was collected from. DataSource *string - // The name of the evidence event. + // The name of the evidence event. EventName *string - // The Amazon Web Service that the evidence is collected from. + // The Amazon Web Service that the evidence is collected from. EventSource *string - // The identifier for the Amazon Web Services account. + // The identifier for the Amazon Web Services account. EvidenceAwsAccountId *string - // The type of automated evidence. + // The type of automated evidence. EvidenceByType *string - // The identifier for the folder that the evidence is stored in. + // The identifier for the folder that the evidence is stored in. EvidenceFolderId *string - // The unique identifier for the user or role that's associated with the evidence. + // The unique identifier for the user or role that's associated with the + // evidence. IamId *string - // The identifier for the evidence. + // The identifier for the evidence. Id *string - // The list of resources that are assessed to generate the evidence. + // The list of resources that are assessed to generate the evidence. ResourcesIncluded []Resource - // The timestamp that represents when the evidence was collected. + // The timestamp that represents when the evidence was collected. Time *time.Time noSmithyDocumentSerde @@ -1035,28 +1112,36 @@ type Evidence struct { // populating the event data store with evidence data. type EvidenceFinderEnablement struct { - // The current status of the evidence data backfill process. The backfill starts - // 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. + // The current status of the evidence data backfill process. + // + // The backfill starts 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. 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. @@ -1086,9 +1171,10 @@ type EvidenceInsights struct { // Evidence is inconclusive when the associated control uses Security Hub or Config // as a data source but you didn't enable those services. This is also the case // when a control uses a data source that doesn’t support compliance checks (for - // example, manual evidence, API calls, or CloudTrail). If evidence has a - // compliance check status of not applicable in the console, it's classified as - // inconclusive in EvidenceInsights data. + // example, manual evidence, API calls, or CloudTrail). + // + // If evidence has a compliance check status of not applicable in the console, + // it's classified as inconclusive in EvidenceInsights data. InconclusiveEvidenceCount *int32 // The number of compliance check evidence that Audit Manager classified as @@ -1099,50 +1185,51 @@ type EvidenceInsights struct { noSmithyDocumentSerde } -// The file that's used to structure and automate Audit Manager assessments for a +// The file that's used to structure and automate Audit Manager assessments for a +// // given compliance standard. type Framework struct { - // The Amazon Resource Name (ARN) of the framework. + // The Amazon Resource Name (ARN) of the framework. Arn *string - // The compliance type that the framework supports, such as CIS or HIPAA. + // The compliance type that the framework supports, such as CIS or HIPAA. ComplianceType *string - // The control sets that are associated with the framework. + // The control sets that are associated with the framework. ControlSets []ControlSet - // The control data sources where Audit Manager collects evidence from. + // The control data sources where Audit Manager collects evidence from. ControlSources *string - // The time when the framework was created. + // The time when the framework was created. CreatedAt *time.Time - // The user or role that created the framework. + // The user or role that created the framework. CreatedBy *string - // The description of the framework. + // The description of the framework. Description *string - // The unique identifier for the framework. + // The unique identifier for the framework. Id *string - // The time when the framework was most recently updated. + // The time when the framework was most recently updated. LastUpdatedAt *time.Time - // The user or role that most recently updated the framework. + // The user or role that most recently updated the framework. LastUpdatedBy *string - // The logo that's associated with the framework. + // The logo that's associated with the framework. Logo *string - // The name of the framework. + // The name of the framework. Name *string - // The tags that are associated with the framework. + // The tags that are associated with the framework. Tags map[string]string - // Specifies whether the framework is a standard framework or a custom framework. + // Specifies whether the framework is a standard framework or a custom framework. Type FrameworkType noSmithyDocumentSerde @@ -1151,35 +1238,40 @@ type Framework struct { // The metadata of a framework, such as the name, ID, or description. type FrameworkMetadata struct { - // The compliance standard that's associated with the framework. For example, this - // could be PCI DSS or HIPAA. + // The compliance standard that's associated with the framework. For example, + // this could be PCI DSS or HIPAA. ComplianceType *string - // The description of the framework. + // The description of the framework. Description *string - // The logo that's associated with the framework. + // The logo that's associated with the framework. Logo *string - // The name of the framework. + // The name of the framework. Name *string noSmithyDocumentSerde } -// A summary of the latest analytics data for all your active assessments. This -// 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 -// assessment as follows. +// A summary of the latest analytics data for all your active assessments. +// +// This 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 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. @@ -1202,8 +1294,10 @@ type Insights struct { // inconclusive when the associated control uses Security Hub or Config as a data // source but you didn't enable those services. This is also the case when a // control uses a data source that doesn’t support compliance checks (for example: - // manual evidence, API calls, or CloudTrail). If evidence has a compliance check - // status of not applicable, it's classed as inconclusive in Insights data. + // manual evidence, API calls, or CloudTrail). + // + // If evidence has a compliance check status of not applicable, it's classed as + // inconclusive in Insights data. InconclusiveEvidenceCount *int32 // The time when the cross-assessment insights were last updated. @@ -1221,19 +1315,25 @@ type Insights struct { noSmithyDocumentSerde } -// A summary of the latest analytics data for a specific active assessment. This -// summary is a snapshot of the data that was collected on the lastUpdated date. -// 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 -// 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. +// A summary of the latest analytics data for a specific active assessment. +// +// This summary is a snapshot of the data that was collected on the lastUpdated +// date. 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 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. @@ -1252,8 +1352,10 @@ type InsightsByAssessment struct { // inconclusive if the associated control uses Security Hub or Config as a data // source and you didn't enable those services. This is also the case if a control // uses a data source that doesn’t support compliance checks (for example, manual - // evidence, API calls, or CloudTrail). If evidence has a compliance check status - // of not applicable, it's classified as inconclusive in InsightsByAssessment data. + // evidence, API calls, or CloudTrail). + // + // If evidence has a compliance check status of not applicable, it's classified as + // inconclusive in InsightsByAssessment data. InconclusiveEvidenceCount *int32 // The time when the assessment insights were last updated. @@ -1270,14 +1372,16 @@ type InsightsByAssessment struct { noSmithyDocumentSerde } -// Evidence that's manually added to a control in Audit Manager. manualEvidence +// Evidence that's manually added to a control in Audit Manager. manualEvidence +// // can be one of the following: evidenceFileName , s3ResourcePath , or textResponse // . type ManualEvidence struct { // The name of the file that's uploaded as manual evidence. This name is populated - // using the evidenceFileName value from the GetEvidenceFileUploadUrl (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetEvidenceFileUploadUrl.html) - // API response. + // using the evidenceFileName value from the [GetEvidenceFileUploadUrl]GetEvidenceFileUploadUrl API response. + // + // [GetEvidenceFileUploadUrl]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetEvidenceFileUploadUrl.html EvidenceFileName *string // The S3 URL of the object that's imported as manual evidence. @@ -1289,33 +1393,34 @@ type ManualEvidence struct { noSmithyDocumentSerde } -// The notification that informs a user of an update in Audit Manager. For +// 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. + // The identifier for the assessment. AssessmentId *string - // The name of the related assessment. + // The name of the related assessment. AssessmentName *string - // The identifier for the control set. + // The identifier for the control set. ControlSetId *string - // Specifies the name of the control set that the notification is about. + // Specifies the name of the control set that the notification is about. ControlSetName *string - // The description of the notification. + // The description of the notification. Description *string - // The time when the notification was sent. + // The time when the notification was sent. EventTime *time.Time - // The unique identifier for the notification. + // The unique identifier for the notification. Id *string - // The sender of the notification. + // The sender of the notification. Source *string noSmithyDocumentSerde @@ -1324,15 +1429,18 @@ type Notification struct { // A system asset that's evaluated in an Audit Manager assessment. type Resource struct { - // The Amazon Resource Name (ARN) for the resource. + // The Amazon Resource Name (ARN) for the resource. Arn *string - // The evaluation status for a resource that was assessed when collecting + // 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 @@ -1341,24 +1449,29 @@ type Resource struct { // as manual evidence, Amazon Web Services API calls, or CloudTrail). ComplianceCheck *string - // The value of the resource. + // The value of the resource. Value *string noSmithyDocumentSerde } -// The wrapper that contains the Audit Manager role information of the current +// The wrapper that contains the Audit Manager role information of the current +// // user. This includes the role type and IAM Amazon Resource Name (ARN). type Role struct { - // The Amazon Resource Name (ARN) of the IAM role. + // The Amazon Resource Name (ARN) of the IAM role. // // 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 @@ -1366,15 +1479,16 @@ type Role struct { noSmithyDocumentSerde } -// The wrapper that contains the Amazon Web Services accounts and services that +// 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 + // The Amazon Web Services accounts that are included in the scope of the // assessment. AwsAccounts []AWSAccount - // The Amazon Web Services services that are included in the scope of the + // The Amazon Web Services services that are included in the scope of the // assessment. AwsServices []AWSService @@ -1384,17 +1498,17 @@ type Scope struct { // The metadata that's associated with the Amazon Web Service. type ServiceMetadata struct { - // The category that the Amazon Web Service belongs to, such as compute, storage, + // The category that the Amazon Web Service belongs to, such as compute, storage, // or database. Category *string - // The description of the Amazon Web Service. + // The description of the Amazon Web Service. Description *string - // The display name of the Amazon Web Service. + // The display name of the Amazon Web Service. DisplayName *string - // The name of the Amazon Web Service. + // The name of the Amazon Web Service. Name *string noSmithyDocumentSerde @@ -1409,7 +1523,7 @@ type Settings struct { // The default S3 destination bucket for storing evidence finder exports. DefaultExportDestination *DefaultExportDestination - // The designated default audit owners. + // The designated default audit owners. DefaultProcessOwners []Role // The deregistration policy for your Audit Manager data. You can use this @@ -1420,134 +1534,180 @@ type Settings struct { // The current evidence finder status and event data store details. EvidenceFinderEnablement *EvidenceFinderEnablement - // Specifies whether Organizations is enabled. + // Specifies whether Organizations is enabled. IsAwsOrgEnabled *bool - // The KMS key details. + // The KMS key details. KmsKey *string - // The designated Amazon Simple Notification Service (Amazon SNS) topic. + // The designated Amazon Simple Notification Service (Amazon SNS) topic. SnsTopic *string noSmithyDocumentSerde } -// A keyword that relates to the control data source. For manual evidence, this -// keyword indicates if the manual evidence is a file or text. For automated -// evidence, this keyword identifies a specific CloudTrail event, Config rule, -// Security Hub control, or Amazon Web Services API name. 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-config.html) -// - Security Hub controls supported by Audit Manager (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.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) +// A keyword that relates to the control data source. +// +// For manual evidence, this keyword indicates if the manual evidence is a file or +// text. +// +// For automated evidence, this keyword identifies a specific CloudTrail event, +// Config rule, Security Hub control, or Amazon Web Services API name. +// +// 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] +// +// [Security Hub controls supported by Audit Manager] +// +// [API calls supported by Audit Manager] +// +// [CloudTrail event names supported by Audit Manager] +// +// [Config rules supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html +// [CloudTrail event names supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html +// [Security Hub controls supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html +// [API calls supported by Audit Manager]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html type SourceKeyword struct { - // The input method for the keyword. + // The input method for the keyword. + // // - SELECT_FROM_LIST is used when mapping a data source for automated evidence. + // // - When keywordInputType is SELECT_FROM_LIST , a keyword must be selected to // collect automated evidence. For example, this keyword can be a CloudTrail event // name, a rule name for Config, a Security Hub control, or the name of an Amazon // Web Services API call. + // // - UPLOAD_FILE and INPUT_TEXT are only used when mapping a data source for // manual evidence. + // // - When keywordInputType is UPLOAD_FILE , a file must be uploaded as manual // evidence. + // // - When keywordInputType is INPUT_TEXT , text must be entered as manual // evidence. KeywordInputType KeywordInputType - // The value of the keyword that's used when mapping a control data source. For + // The value of the keyword that's used when mapping a control data source. For // example, this can be a CloudTrail event name, a rule name for Config, a Security - // 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) - // . For some rules, the rule identifier is different from the rule name. For - // example, the rule name restricted-ssh has the following rule identifier: - // INCOMING_SSH_DISABLED . Make sure to use the rule identifier, not the rule - // name. Keyword example for managed rules: - // - 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 custom rule from a managed rule. Keyword example - // for custom rules: - // - 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. - // Keyword examples for service-linked rules: + // 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], you can use the rule identifier as the keywordValue . You can find the + // rule identifier from the [list of Config managed rules]. For some rules, the rule identifier is different + // from the rule name. For example, the rule name restricted-ssh has the + // following rule identifier: INCOMING_SSH_DISABLED . Make sure to use the rule + // identifier, not the rule name. + // + // Keyword example for managed rules: + // + // - Managed rule name: [s3-bucket-acl-prohibited] + // + // keywordValue : S3_BUCKET_ACL_PROHIBITED + // + // - For [custom rules], you form the keywordValue by adding the Custom_ prefix to the rule + // name. This prefix distinguishes the custom rule from a managed rule. + // + // Keyword example for custom rules: + // + // - Custom rule name: my-custom-config-rule + // + // keywordValue : Custom_my-custom-config-rule + // + // - For [service-linked rules], 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. + // + // Keyword examples for service-linked rules: + // // - Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w - // keywordValue : Custom_CustomRuleForAccount-conformance-pack + // + // keywordValue : Custom_CustomRuleForAccount-conformance-pack + // // - Service-linked rule name: - // OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue : - // Custom_OrgConfigRule-s3-bucket-versioning-enabled + // OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba + // + // keywordValue : Custom_OrgConfigRule-s3-bucket-versioning-enabled + // // The keywordValue is case sensitive. If you enter a value incorrectly, Audit // Manager might not recognize the data source mapping. As a result, you might not - // successfully collect evidence from that data source as intended. Keep in mind - // the following requirements, depending on the data source type that you're using. + // successfully collect evidence from that data source as intended. + // + // Keep in mind the following requirements, depending on the data source type that + // you're using. // // - For Config: + // // - For managed rules, make sure that the keywordValue is the rule identifier in // ALL_CAPS_WITH_UNDERSCORES . For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED . For - // accuracy, we recommend that you reference the list of supported Config - // managed rules (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html) - // . + // accuracy, we recommend that you reference the list of [supported Config managed rules]. + // // - For custom rules, make sure that the keywordValue has the Custom_ prefix // followed by the custom rule name. The format of the custom rule name itself may - // vary. For accuracy, we recommend that you visit the Config console (https://console.aws.amazon.com/config/) - // to verify your custom rule name. + // vary. For accuracy, we recommend that you visit the [Config console]to verify your custom + // rule name. + // // - For Security Hub: The format varies for Security Hub control names. For - // accuracy, we recommend that you reference the list of supported Security Hub - // controls (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html) - // . + // accuracy, we recommend that you reference the list of [supported Security Hub controls]. + // // - For Amazon Web Services API calls: Make sure that the keywordValue is // written as serviceprefix_ActionName . For example, iam_ListGroups . For - // accuracy, we recommend that you reference the list of supported API calls (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html) - // . + // accuracy, we recommend that you reference the list of [supported API calls]. + // // - For CloudTrail: Make sure that the keywordValue is written as // serviceprefix_ActionName . For example, cloudtrail_StartLogging . For // accuracy, we recommend that you review the Amazon Web Service prefix and action - // names in the Service Authorization Reference (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) - // . + // names in the [Service Authorization Reference]. + // + // [custom rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html + // [service-linked rules]: https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html + // [supported API calls]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html + // [Service Authorization Reference]: https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html + // [list of Config managed rules]: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html + // [s3-bucket-acl-prohibited]: https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html + // [Config console]: https://console.aws.amazon.com/config/ + // [managed rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html + // [supported Config managed rules]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html + // [supported Security Hub controls]: https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html KeywordValue *string noSmithyDocumentSerde } -// A controlSet entity that represents a collection of controls in Audit Manager. +// A controlSet entity that represents a collection of controls in Audit Manager. +// // This doesn't contain the control set ID. type UpdateAssessmentFrameworkControlSet struct { - // The list of controls that are contained within the control set. + // The list of controls that are contained within the control set. // // This member is required. Controls []CreateAssessmentFrameworkControl - // The name of the control set. + // The name of the control set. // // This member is required. Name *string - // The unique identifier for the control set. + // The unique identifier for the control set. Id *string noSmithyDocumentSerde } -// Short for uniform resource locator. A URL is used as a unique identifier to +// Short for uniform resource locator. A URL is used as a unique identifier to +// // locate a resource on the internet. type URL struct { - // The name or word that's used as a hyperlink to the URL. + // The name or word that's used as a hyperlink to the URL. HyperlinkName *string - // The unique identifier for the internet resource. + // The unique identifier for the internet resource. Link *string noSmithyDocumentSerde @@ -1556,12 +1716,12 @@ type URL struct { // Indicates that the request has invalid or missing parameters for the field. type ValidationExceptionField struct { - // The body of the error message. + // The body of the error message. // // This member is required. Message *string - // The name of the validation error. + // The name of the validation error. // // This member is required. Name *string diff --git a/service/autoscaling/api_op_AttachInstances.go b/service/autoscaling/api_op_AttachInstances.go index c99059a7c35..a37942c0ad7 100644 --- a/service/autoscaling/api_op_AttachInstances.go +++ b/service/autoscaling/api_op_AttachInstances.go @@ -10,16 +10,21 @@ 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 -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Attach EC2 instances to your Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html func (c *Client) AttachInstances(ctx context.Context, params *AttachInstancesInput, optFns ...func(*Options)) (*AttachInstancesOutput, error) { if params == nil { params = &AttachInstancesInput{} diff --git a/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go b/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go index ad51e5abeab..d855d63dc3e 100644 --- a/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_AttachLoadBalancerTargetGroups.go @@ -10,27 +10,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 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: +// 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 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). // -// 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. +// 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 DetachLoadBalancerTargetGroupsAPI. +// +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [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 func (c *Client) AttachLoadBalancerTargetGroups(ctx context.Context, params *AttachLoadBalancerTargetGroupsInput, optFns ...func(*Options)) (*AttachLoadBalancerTargetGroupsOutput, error) { if params == nil { params = &AttachLoadBalancerTargetGroupsInput{} @@ -54,10 +60,11 @@ type AttachLoadBalancerTargetGroupsInput struct { AutoScalingGroupName *string // 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) + // target groups. To get the ARN of a target group, use the Elastic Load Balancing [DescribeTargetGroups] // API operation. // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // // This member is required. TargetGroupARNs []string diff --git a/service/autoscaling/api_op_AttachLoadBalancers.go b/service/autoscaling/api_op_AttachLoadBalancers.go index 1b98fa7c473..b2a5221d497 100644 --- a/service/autoscaling/api_op_AttachLoadBalancers.go +++ b/service/autoscaling/api_op_AttachLoadBalancers.go @@ -10,20 +10,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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 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 DetachLoadBalancersAPI. +// +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [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 func (c *Client) AttachLoadBalancers(ctx context.Context, params *AttachLoadBalancersInput, optFns ...func(*Options)) (*AttachLoadBalancersOutput, error) { if params == nil { params = &AttachLoadBalancersInput{} diff --git a/service/autoscaling/api_op_AttachTrafficSources.go b/service/autoscaling/api_op_AttachTrafficSources.go index 37e583fad04..0f60bc0d399 100644 --- a/service/autoscaling/api_op_AttachTrafficSources.go +++ b/service/autoscaling/api_op_AttachTrafficSources.go @@ -11,19 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // // 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. +// 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 DetachTrafficSourcesAPI. 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_CancelInstanceRefresh.go b/service/autoscaling/api_op_CancelInstanceRefresh.go index 1a84ca189de..ebca0281984 100644 --- a/service/autoscaling/api_op_CancelInstanceRefresh.go +++ b/service/autoscaling/api_op_CancelInstanceRefresh.go @@ -12,11 +12,16 @@ 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) -// 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 -// RollbackInstanceRefresh API to roll back instead. +// occurs. +// +// This operation is part of the [instance refresh feature] 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 RollbackInstanceRefreshAPI to roll back instead. +// +// [instance refresh feature]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html func (c *Client) CancelInstanceRefresh(ctx context.Context, params *CancelInstanceRefreshInput, optFns ...func(*Options)) (*CancelInstanceRefreshOutput, error) { if params == nil { params = &CancelInstanceRefreshInput{} diff --git a/service/autoscaling/api_op_CompleteLifecycleAction.go b/service/autoscaling/api_op_CompleteLifecycleAction.go index c794fbd747f..e663946ce1b 100644 --- a/service/autoscaling/api_op_CompleteLifecycleAction.go +++ b/service/autoscaling/api_op_CompleteLifecycleAction.go @@ -11,26 +11,35 @@ 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: +// 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. // -// For more information, see Complete a lifecycle action (https://docs.aws.amazon.com/autoscaling/ec2/userguide/completing-lifecycle-hooks.html) -// in the Amazon EC2 Auto Scaling User Guide. +// - If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction +// API call. +// +// For more information, see [Complete a lifecycle action] in the Amazon EC2 Auto Scaling User Guide. +// +// [Complete a lifecycle action]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/completing-lifecycle-hooks.html func (c *Client) CompleteLifecycleAction(ctx context.Context, params *CompleteLifecycleActionInput, optFns ...func(*Options)) (*CompleteLifecycleActionOutput, error) { if params == nil { params = &CompleteLifecycleActionInput{} diff --git a/service/autoscaling/api_op_CreateAutoScalingGroup.go b/service/autoscaling/api_op_CreateAutoScalingGroup.go index b7645939d01..69365e05687 100644 --- a/service/autoscaling/api_op_CreateAutoScalingGroup.go +++ b/service/autoscaling/api_op_CreateAutoScalingGroup.go @@ -11,20 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We strongly recommend using a launch template when calling this operation to -// ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an -// 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) -// in the Amazon EC2 Auto Scaling User Guide. If you're new to Amazon EC2 Auto -// Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto -// Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/get-started-with-ec2-auto-scaling.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. +// We strongly recommend using a launch template when calling this operation to +// +// ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. +// +// Creates an 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 DescribeAccountLimitsAPI. For information about updating this limit, see [Quotas for Amazon EC2 Auto Scaling] +// in the Amazon EC2 Auto Scaling User Guide. +// +// If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in [Get started with Amazon EC2 Auto Scaling] 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. +// +// [Get started with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/get-started-with-ec2-auto-scaling.html +// [Quotas for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html func (c *Client) CreateAutoScalingGroup(ctx context.Context, params *CreateAutoScalingGroupInput, optFns ...func(*Options)) (*CreateAutoScalingGroupOutput, error) { if params == nil { params = &CreateAutoScalingGroupInput{} @@ -43,18 +50,23 @@ func (c *Client) CreateAutoScalingGroup(ctx context.Context, params *CreateAutoS type CreateAutoScalingGroupInput struct { // The name of the Auto Scaling group. This name must be unique per Region per - // account. The name can contain any ASCII character 33 to 126 including most - // punctuation characters, digits, and upper and lowercased letters. You cannot use - // a colon (:) in the name. + // account. + // + // The name can contain any ASCII character 33 to 126 including most punctuation + // characters, digits, and upper and lowercased letters. + // + // You cannot use a colon (:) in the name. // // This member is required. AutoScalingGroupName *string - // 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). + // 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). // // This member is required. MaxSize *int32 @@ -75,36 +87,46 @@ type CreateAutoScalingGroupInput struct { // Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto // 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) - // in the in the Amazon EC2 Auto Scaling User Guide. + // instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions]in the + // in the Amazon EC2 Auto Scaling User Guide. + // + // [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html CapacityRebalance *bool // Reserved. Context *string - // 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 + // 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]in the + // Amazon EC2 Auto Scaling User Guide. + // + // Default: 300 seconds + // + // [Scaling cooldowns for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html DefaultCooldown *int32 // The amount of time, in seconds, until a new instance is considered to have // finished initializing and resource consumption to become stable after it enters - // the InService state. During an instance refresh, Amazon EC2 Auto Scaling waits - // for the warm-up period after it replaces an instance before it moves on to - // replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up - // 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) - // 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 - // property but specify -1 for the value. However, we strongly recommend keeping - // the default instance warmup enabled by specifying a value of 0 or other nominal - // value. Default: None + // the InService state. + // + // During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up + // period after it replaces an instance before it moves on to replacing the next + // instance. Amazon EC2 Auto Scaling also waits for the warm-up 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]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 property but specify -1 for the + // value. However, we strongly recommend keeping the default instance warmup + // enabled by specifying a value of 0 or other nominal value. + // + // Default: None + // + // [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 DefaultInstanceWarmup *int32 // The desired capacity is the initial capacity of the Auto Scaling group at the @@ -117,57 +139,75 @@ type CreateAutoScalingGroupInput struct { // 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) - // 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 - // | vcpu | memory-mib + // selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection]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 | vcpu | memory-mib + // + // [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 DesiredCapacityType *string // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before // 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) - // in the Amazon EC2 Auto Scaling User Guide. Default: 0 seconds + // InService state. For more information, see [Set the health check grace period for an Auto Scaling group] in the Amazon EC2 Auto Scaling User + // Guide. + // + // Default: 0 seconds + // + // [Set the health check grace period for an Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html 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. + // 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]in the Amazon EC2 Auto + // Scaling User Guide. + // + // Only specify EC2 if you must clear a value that was previously set. + // + // [Health checks for Auto Scaling instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // Amazon EC2 [DescribeInstances]API operation. For more information, see [Creating an Auto Scaling group using an EC2 instance] in the Amazon EC2 Auto + // Scaling User Guide. + // + // [Creating an Auto Scaling group using an EC2 instance]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html + // [DescribeInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html InstanceId *string - // An instance maintenance policy. For more information, see Set instance - // maintenance policy (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) - // in the Amazon EC2 Auto Scaling User Guide. + // An instance maintenance policy. For more information, see [Set instance maintenance policy] in the Amazon EC2 + // Auto Scaling User Guide. + // + // [Set instance maintenance policy]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html InstanceMaintenancePolicy *types.InstanceMaintenancePolicy - // The name of the launch configuration to use to launch instances. Conditional: - // You must specify either a launch template ( LaunchTemplate or + // 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 ). 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 - // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // 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]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Creating a launch template for an Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html LaunchTemplate *types.LaunchTemplateSpecification // One or more lifecycle hooks to add to the Auto Scaling group before instances @@ -181,35 +221,43 @@ 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) - // in the Amazon EC2 Auto Scaling User Guide. + // or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime]in the Amazon + // EC2 Auto Scaling User Guide. + // + // [Replacing Auto Scaling instances based on maximum instance lifetime]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // The mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options] in the Amazon EC2 Auto + // Scaling User Guide. + // + // [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 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) - // in the Amazon EC2 Auto Scaling User Guide. + // instances from terminating on scale in, see [Using instance scale-in protection]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Using instance scale-in protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html 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 - // logical grouping of instances within a single Availability Zone. You cannot - // specify multiple Availability Zones and a cluster placement group. + // information, see [Placement groups]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. + // + // [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html PlacementGroup *string // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // information, see [Service-linked roles]in the Amazon EC2 Auto Scaling User Guide. + // + // [Service-linked roles]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html ServiceLinkedRoleARN *string // One or more tags. You can tag your Auto Scaling group and propagate the tags to @@ -218,25 +266,31 @@ 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) - // in the Amazon EC2 Auto Scaling User Guide. + // Scaling group. For more information, see [Tag Auto Scaling groups and instances]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Tag Auto Scaling groups and instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html Tags []types.Tag // The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // 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]in the Amazon EC2 + // Auto Scaling User Guide. + // + // [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 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) - // in the Amazon EC2 Auto Scaling User Guide. Valid values: Default | - // AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance - // | OldestLaunchConfiguration | OldestLaunchTemplate | + // information, see [Work with Amazon EC2 Auto Scaling termination policies]in the Amazon EC2 Auto Scaling User Guide. + // + // Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | + // NewestInstance | OldestInstance | OldestLaunchConfiguration | + // OldestLaunchTemplate | // arn:aws:lambda:region:account-id:function:my-function:my-alias + // + // [Work with Amazon EC2 Auto Scaling termination policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html TerminationPolicies []string // The list of traffic sources to attach to this Auto Scaling group. You can use diff --git a/service/autoscaling/api_op_CreateLaunchConfiguration.go b/service/autoscaling/api_op_CreateLaunchConfiguration.go index acbfbac8c0c..4f3492e4802 100644 --- a/service/autoscaling/api_op_CreateLaunchConfiguration.go +++ b/service/autoscaling/api_op_CreateLaunchConfiguration.go @@ -11,19 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch -// 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) +// Creates a launch configuration. +// +// If you exceed your maximum limit of launch configurations, the call fails. To +// query this limit, call the DescribeAccountLimitsAPI. For information about updating this limit, see [Quotas for Amazon EC2 Auto Scaling] // in the Amazon EC2 Auto Scaling User Guide. +// +// For more information, see [Launch configurations] 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]in the Amazon EC2 Auto Scaling +// User Guide. +// +// [Quotas for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html +// [Launch configurations]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html +// [Launch templates]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html func (c *Client) CreateLaunchConfiguration(ctx context.Context, params *CreateLaunchConfigurationInput, optFns ...func(*Options)) (*CreateLaunchConfigurationOutput, error) { if params == nil { params = &CreateLaunchConfigurationInput{} @@ -52,18 +57,24 @@ 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 - // 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. + // 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]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. + // + // [Launching Auto Scaling instances in a VPC]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html 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) - // in the Amazon EC2 User Guide for Linux Instances. + // mapping for the AMI are used. For more information, see [Block device mappings]in the Amazon EC2 User + // Guide for Linux Instances. + // + // [Block device mappings]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html BlockDeviceMappings []types.BlockDeviceMapping // Available for backward compatibility. @@ -77,102 +88,132 @@ type CreateLaunchConfigurationInput struct { // 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 . + // EBS-optimized by default. For more information, see [Amazon EBS-optimized instances]in the Amazon EC2 User + // Guide for Linux Instances. + // + // The default value is false . + // + // [Amazon EBS-optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html 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. + // For more information, see [IAM role for applications that run on Amazon EC2 instances]in the Amazon EC2 Auto Scaling User Guide. + // + // [IAM role for applications that run on Amazon EC2 instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html 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]in the Amazon EC2 User Guide for Linux Instances. + // + // If you specify InstanceId , an ImageId is not required. + // + // [Finding a Linux AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html 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 - // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // 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] in the Amazon EC2 Auto Scaling User Guide. + // + // [Creating a launch configuration using an EC2 instance]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html 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 - // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // 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]in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Configure Monitoring for Auto Scaling Instances]: https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html 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 - // InstanceType is not required. + // available instance types, see [Available instance types]in the Amazon EC2 User Guide for Linux Instances. + // + // If you specify InstanceId , an InstanceType is not required. + // + // [Available instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes 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) - // in the Amazon EC2 User Guide for Linux Instances. + // 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]in the Amazon EC2 User Guide for Linux Instances. + // + // [User provided kernels]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html 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. + // The name of the key pair. For more information, see [Amazon EC2 key pairs and Linux instances] in the Amazon EC2 User + // Guide for Linux Instances. + // + // [Amazon EC2 key pairs and Linux instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // The metadata options for the instances. For more information, see [Configuring the Instance Metadata Options] in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Configuring the Instance Metadata Options]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds MetadataOptions *types.InstanceMetadataOptions // 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 - // must specify at least one subnet for VPCZoneIdentifier when you create your - // group. Valid values: default | dedicated + // the value of this property to dedicated . For more information, see [Configuring instance tenancy with Amazon EC2 Auto Scaling] 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 + // + // [Configuring instance tenancy with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html 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) - // in the Amazon EC2 User Guide for Linux Instances. + // 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]in the Amazon EC2 User Guide for Linux Instances. + // + // [User provided kernels]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html 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) - // in the Amazon Virtual Private Cloud User Guide. + // Auto Scaling group. For more information, see [Control traffic to resources using security groups]in the Amazon Virtual Private + // Cloud User Guide. + // + // [Control traffic to resources using security groups]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html 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) - // in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 0.001 + // current Spot price. For more information, see [Request Spot Instances for fault-tolerant and flexible applications]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 // running instances is higher than the current Spot price. + // + // [Request Spot Instances for fault-tolerant and flexible applications]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html 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) - // (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. + // information, see [Instance metadata and user data](Linux) and [Instance metadata and user data] (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. + // + // [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html UserData *string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_CreateOrUpdateTags.go b/service/autoscaling/api_op_CreateOrUpdateTags.go index 08c27481003..223bdace6e1 100644 --- a/service/autoscaling/api_op_CreateOrUpdateTags.go +++ b/service/autoscaling/api_op_CreateOrUpdateTags.go @@ -11,11 +11,14 @@ 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 -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Tag Auto Scaling groups and instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html func (c *Client) CreateOrUpdateTags(ctx context.Context, params *CreateOrUpdateTagsInput, optFns ...func(*Options)) (*CreateOrUpdateTagsOutput, error) { if params == nil { params = &CreateOrUpdateTagsInput{} diff --git a/service/autoscaling/api_op_DeleteAutoScalingGroup.go b/service/autoscaling/api_op_DeleteAutoScalingGroup.go index d914d61f317..8b4aca098da 100644 --- a/service/autoscaling/api_op_DeleteAutoScalingGroup.go +++ b/service/autoscaling/api_op_DeleteAutoScalingGroup.go @@ -10,20 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Auto Scaling group. If the group has instances or scaling -// activities in progress, you must specify the option to force the deletion in -// order for it to succeed. The force delete operation will also terminate the EC2 -// instances. If the group has a warm pool, the force delete option also deletes -// the warm pool. To remove instances from the Auto Scaling group before deleting -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Deletes the specified Auto Scaling group. +// +// If the group has instances or scaling activities in progress, you must specify +// the option to force the deletion in order for it to succeed. The force delete +// operation will also terminate the EC2 instances. If the group has a warm pool, +// the force delete option also deletes the warm pool. +// +// To remove instances from the Auto Scaling group before deleting 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Delete your Auto Scaling infrastructure]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html func (c *Client) DeleteAutoScalingGroup(ctx context.Context, params *DeleteAutoScalingGroupInput, optFns ...func(*Options)) (*DeleteAutoScalingGroupOutput, error) { if params == nil { params = &DeleteAutoScalingGroupInput{} diff --git a/service/autoscaling/api_op_DeleteLaunchConfiguration.go b/service/autoscaling/api_op_DeleteLaunchConfiguration.go index b3536381f44..6c3e1882358 100644 --- a/service/autoscaling/api_op_DeleteLaunchConfiguration.go +++ b/service/autoscaling/api_op_DeleteLaunchConfiguration.go @@ -10,9 +10,10 @@ 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 -// configuration is no longer available for use. +// 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 { params = &DeleteLaunchConfigurationInput{} diff --git a/service/autoscaling/api_op_DeleteLifecycleHook.go b/service/autoscaling/api_op_DeleteLifecycleHook.go index 7a940f93cca..a2ce097701f 100644 --- a/service/autoscaling/api_op_DeleteLifecycleHook.go +++ b/service/autoscaling/api_op_DeleteLifecycleHook.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified lifecycle hook. If there are any outstanding lifecycle -// actions, they are completed first ( ABANDON for launching instances, CONTINUE -// for terminating instances). +// Deletes the specified lifecycle hook. +// +// If there are any outstanding lifecycle 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 c77d0d29dfd..fe0f6b1c750 100644 --- a/service/autoscaling/api_op_DeletePolicy.go +++ b/service/autoscaling/api_op_DeletePolicy.go @@ -10,11 +10,15 @@ 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 -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Deleting a scaling policy]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} diff --git a/service/autoscaling/api_op_DeleteWarmPool.go b/service/autoscaling/api_op_DeleteWarmPool.go index 4df2edf96b9..065f2d632c6 100644 --- a/service/autoscaling/api_op_DeleteWarmPool.go +++ b/service/autoscaling/api_op_DeleteWarmPool.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Deletes the warm pool for the specified Auto Scaling group. +// +// For more information, see [Warm pools for Amazon EC2 Auto Scaling] in the Amazon EC2 Auto Scaling User Guide. +// +// [Warm pools for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html func (c *Client) DeleteWarmPool(ctx context.Context, params *DeleteWarmPoolInput, optFns ...func(*Options)) (*DeleteWarmPoolOutput, error) { if params == nil { params = &DeleteWarmPoolInput{} diff --git a/service/autoscaling/api_op_DescribeAccountLimits.go b/service/autoscaling/api_op_DescribeAccountLimits.go index aec15bd35af..7aeacbc7430 100644 --- a/service/autoscaling/api_op_DescribeAccountLimits.go +++ b/service/autoscaling/api_op_DescribeAccountLimits.go @@ -11,11 +11,13 @@ import ( ) // Describes the current Amazon EC2 Auto Scaling resource quotas for your account. +// // 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) -// in the Amazon EC2 Auto Scaling User Guide. +// that you can create in a given Region. For more information, see [Quotas for Amazon EC2 Auto Scaling]in the Amazon +// EC2 Auto Scaling User Guide. +// +// [Quotas for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { params = &DescribeAccountLimitsInput{} diff --git a/service/autoscaling/api_op_DescribeAdjustmentTypes.go b/service/autoscaling/api_op_DescribeAdjustmentTypes.go index f492e127e30..7718dab6f93 100644 --- a/service/autoscaling/api_op_DescribeAdjustmentTypes.go +++ b/service/autoscaling/api_op_DescribeAdjustmentTypes.go @@ -12,9 +12,14 @@ import ( ) // Describes the available adjustment types for step scaling and simple scaling -// policies. The following adjustment types are supported: +// policies. +// +// The following adjustment types are supported: +// // - ChangeInCapacity +// // - ExactCapacity +// // - PercentChangeInCapacity func (c *Client) DescribeAdjustmentTypes(ctx context.Context, params *DescribeAdjustmentTypesInput, optFns ...func(*Options)) (*DescribeAdjustmentTypesOutput, error) { if params == nil { diff --git a/service/autoscaling/api_op_DescribeAutoScalingGroups.go b/service/autoscaling/api_op_DescribeAutoScalingGroups.go index bbe69937e0c..8012c1467b2 100644 --- a/service/autoscaling/api_op_DescribeAutoScalingGroups.go +++ b/service/autoscaling/api_op_DescribeAutoScalingGroups.go @@ -16,14 +16,17 @@ 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 -// 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 -// in Auto Scaling groups. To retrieve information about the instances in a warm -// pool, you must call the DescribeWarmPool API. +// 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 in Auto Scaling groups. +// To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool +// API. func (c *Client) DescribeAutoScalingGroups(ctx context.Context, params *DescribeAutoScalingGroupsInput, optFns ...func(*Options)) (*DescribeAutoScalingGroupsOutput, error) { if params == nil { params = &DescribeAutoScalingGroupsInput{} @@ -42,8 +45,9 @@ func (c *Client) DescribeAutoScalingGroups(ctx context.Context, params *Describe type DescribeAutoScalingGroupsInput struct { // The names of the Auto Scaling groups. By default, you can only specify up to 50 - // names. You can optionally increase this limit using the MaxRecords property. If - // you omit this property, all Auto Scaling groups are described. + // names. You can optionally increase this limit using the MaxRecords property. + // + // If you omit this property, all Auto Scaling groups are described. AutoScalingGroupNames []string // One or more filters to limit the results based on specific tags. @@ -280,12 +284,13 @@ type GroupExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAutoScalingGroupsInput, *DescribeAutoScalingGroupsOutput, error) (bool, error) } @@ -476,12 +481,13 @@ type GroupInServiceWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAutoScalingGroupsInput, *DescribeAutoScalingGroupsOutput, error) (bool, error) } @@ -673,12 +679,13 @@ type GroupNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAutoScalingGroupsInput, *DescribeAutoScalingGroupsOutput, error) (bool, error) } diff --git a/service/autoscaling/api_op_DescribeAutoScalingInstances.go b/service/autoscaling/api_op_DescribeAutoScalingInstances.go index 3a0c1febbe6..9bc3ac6989a 100644 --- a/service/autoscaling/api_op_DescribeAutoScalingInstances.go +++ b/service/autoscaling/api_op_DescribeAutoScalingInstances.go @@ -31,7 +31,9 @@ type DescribeAutoScalingInstancesInput struct { // The IDs of the instances. If you omit this property, all Auto Scaling instances // are described. If you specify an ID that does not exist, it is ignored with no - // error. Array Members: Maximum number of 50 items. + // error. + // + // Array Members: Maximum number of 50 items. InstanceIds []string // The maximum number of items to return with this call. The default value is 50 diff --git a/service/autoscaling/api_op_DescribeInstanceRefreshes.go b/service/autoscaling/api_op_DescribeInstanceRefreshes.go index 1f05b142dea..218522d59c7 100644 --- a/service/autoscaling/api_op_DescribeInstanceRefreshes.go +++ b/service/autoscaling/api_op_DescribeInstanceRefreshes.go @@ -12,17 +12,21 @@ import ( ) // Gets information about the instance refreshes for the specified Auto Scaling -// group from the previous six weeks. 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 -// the instance refreshes you previously initiated, including their status, start -// time, end time, the percentage of the instance refresh that is complete, and the -// number of instances remaining to update before the instance refresh is complete. -// If a rollback is initiated while an instance refresh is in progress, Amazon EC2 -// Auto Scaling also returns information about the rollback of the instance -// refresh. +// group from the previous six weeks. +// +// This operation is part of the [instance refresh feature] 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 the instance refreshes you previously +// initiated, including their status, start time, end time, the percentage of the +// instance refresh that is complete, and the number of instances remaining to +// update before the instance refresh is complete. If a rollback is initiated while +// an instance refresh is in progress, Amazon EC2 Auto Scaling also returns +// information about the rollback of the instance refresh. +// +// [instance refresh feature]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html func (c *Client) DescribeInstanceRefreshes(ctx context.Context, params *DescribeInstanceRefreshesInput, optFns ...func(*Options)) (*DescribeInstanceRefreshesOutput, error) { if params == nil { params = &DescribeInstanceRefreshesInput{} diff --git a/service/autoscaling/api_op_DescribeLaunchConfigurations.go b/service/autoscaling/api_op_DescribeLaunchConfigurations.go index 44e35943a2d..60261abbc7d 100644 --- a/service/autoscaling/api_op_DescribeLaunchConfigurations.go +++ b/service/autoscaling/api_op_DescribeLaunchConfigurations.go @@ -30,7 +30,9 @@ func (c *Client) DescribeLaunchConfigurations(ctx context.Context, params *Descr type DescribeLaunchConfigurationsInput struct { // The launch configuration names. If you omit this property, all launch - // configurations are described. Array Members: Maximum number of 50 items. + // configurations are described. + // + // Array Members: Maximum number of 50 items. LaunchConfigurationNames []string // The maximum number of items to return with this call. The default value is 50 diff --git a/service/autoscaling/api_op_DescribeLifecycleHookTypes.go b/service/autoscaling/api_op_DescribeLifecycleHookTypes.go index f0647682f25..1f061058825 100644 --- a/service/autoscaling/api_op_DescribeLifecycleHookTypes.go +++ b/service/autoscaling/api_op_DescribeLifecycleHookTypes.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the available types of lifecycle hooks. The following hook types are -// supported: +// Describes the available types of lifecycle hooks. +// +// The following hook types are supported: +// // - 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 { diff --git a/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go b/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go index e7214fcd0b5..c58cbc938c7 100644 --- a/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_DescribeLoadBalancerTargetGroups.go @@ -11,35 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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 -// 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 -// 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) -// 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 . +// 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 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 DescribeScalingActivitiesand take any corrective actions necessary. +// +// For help with failed health checks, see [Troubleshooting Amazon EC2 Auto Scaling: Health checks] 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]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. +// +// [Troubleshooting Amazon EC2 Auto Scaling: Health checks]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html +// [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 func (c *Client) DescribeLoadBalancerTargetGroups(ctx context.Context, params *DescribeLoadBalancerTargetGroupsInput, optFns ...func(*Options)) (*DescribeLoadBalancerTargetGroupsOutput, error) { if params == nil { params = &DescribeLoadBalancerTargetGroupsInput{} diff --git a/service/autoscaling/api_op_DescribeLoadBalancers.go b/service/autoscaling/api_op_DescribeLoadBalancers.go index d588d86b8cf..4992ff62a2d 100644 --- a/service/autoscaling/api_op_DescribeLoadBalancers.go +++ b/service/autoscaling/api_op_DescribeLoadBalancers.go @@ -11,33 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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 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 DescribeLoadBalancerTargetGroupsAPI +// 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 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 DescribeScalingActivitiesand take any corrective actions +// necessary. +// +// For help with failed health checks, see [Troubleshooting Amazon EC2 Auto Scaling: Health checks] 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]in the Amazon EC2 Auto Scaling User Guide. +// +// [Troubleshooting Amazon EC2 Auto Scaling: Health checks]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html +// [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 func (c *Client) DescribeLoadBalancers(ctx context.Context, params *DescribeLoadBalancersInput, optFns ...func(*Options)) (*DescribeLoadBalancersOutput, error) { if params == nil { params = &DescribeLoadBalancersInput{} diff --git a/service/autoscaling/api_op_DescribePolicies.go b/service/autoscaling/api_op_DescribePolicies.go index 2cbf4d47c35..9b796a2a61b 100644 --- a/service/autoscaling/api_op_DescribePolicies.go +++ b/service/autoscaling/api_op_DescribePolicies.go @@ -42,8 +42,9 @@ type DescribePoliciesInput struct { // The names of one or more policies. If you omit this property, all policies are // described. If a group name is provided, the results are limited to that group. - // If you specify an unknown policy name, it is ignored with no error. Array - // Members: Maximum number of 50 items. + // If you specify an unknown policy name, it is ignored with no error. + // + // Array Members: Maximum number of 50 items. PolicyNames []string // One or more policy types. The valid values are SimpleScaling , StepScaling , diff --git a/service/autoscaling/api_op_DescribeScalingActivities.go b/service/autoscaling/api_op_DescribeScalingActivities.go index 576f7016853..0a1009e739c 100644 --- a/service/autoscaling/api_op_DescribeScalingActivities.go +++ b/service/autoscaling/api_op_DescribeScalingActivities.go @@ -11,17 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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]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 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Verifying a scaling activity for an Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html +// [Troubleshooting Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html func (c *Client) DescribeScalingActivities(ctx context.Context, params *DescribeScalingActivitiesInput, optFns ...func(*Options)) (*DescribeScalingActivitiesOutput, error) { if params == nil { params = &DescribeScalingActivitiesInput{} @@ -42,7 +45,9 @@ type DescribeScalingActivitiesInput struct { // The activity IDs of the desired scaling activities. If you omit this property, // all activities for the past six weeks are described. If unknown activities are // requested, they are ignored with no error. If you specify an Auto Scaling group, - // the results are limited to that group. Array Members: Maximum number of 50 IDs. + // the results are limited to that group. + // + // Array Members: Maximum number of 50 IDs. ActivityIds []string // The name of the Auto Scaling group. diff --git a/service/autoscaling/api_op_DescribeScalingProcessTypes.go b/service/autoscaling/api_op_DescribeScalingProcessTypes.go index 59c8507b924..af40705c195 100644 --- a/service/autoscaling/api_op_DescribeScalingProcessTypes.go +++ b/service/autoscaling/api_op_DescribeScalingProcessTypes.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the scaling process types for use with the ResumeProcesses and -// SuspendProcesses APIs. +// Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs. func (c *Client) DescribeScalingProcessTypes(ctx context.Context, params *DescribeScalingProcessTypesInput, optFns ...func(*Options)) (*DescribeScalingProcessTypesOutput, error) { if params == nil { params = &DescribeScalingProcessTypesInput{} diff --git a/service/autoscaling/api_op_DescribeScheduledActions.go b/service/autoscaling/api_op_DescribeScheduledActions.go index ee229db29e6..2ccce2e6c97 100644 --- a/service/autoscaling/api_op_DescribeScheduledActions.go +++ b/service/autoscaling/api_op_DescribeScheduledActions.go @@ -13,8 +13,10 @@ import ( ) // Gets information about the scheduled actions that haven't run or that have not -// reached their end time. To describe the scaling activities for scheduled actions -// that have already run, call the DescribeScalingActivities API. +// reached their end time. +// +// To describe the scaling activities for scheduled actions that have already run, +// call the DescribeScalingActivitiesAPI. func (c *Client) DescribeScheduledActions(ctx context.Context, params *DescribeScheduledActionsInput, optFns ...func(*Options)) (*DescribeScheduledActionsOutput, error) { if params == nil { params = &DescribeScheduledActionsInput{} @@ -49,7 +51,9 @@ type DescribeScheduledActionsInput struct { // The names of one or more scheduled actions. If you omit this property, all // scheduled actions are described. If you specify an unknown scheduled action, it - // is ignored with no error. Array Members: Maximum number of 50 actions. + // is ignored with no error. + // + // Array Members: Maximum number of 50 actions. ScheduledActionNames []string // The earliest scheduled start time to return. If scheduled action names are diff --git a/service/autoscaling/api_op_DescribeTags.go b/service/autoscaling/api_op_DescribeTags.go index edbb093c650..7b86c349efd 100644 --- a/service/autoscaling/api_op_DescribeTags.go +++ b/service/autoscaling/api_op_DescribeTags.go @@ -11,14 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified tags. You can use filters to limit the results. For -// example, you can query for the tags for a specific Auto Scaling group. You can -// specify multiple values for a filter. A tag must match at least one of the -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Describes the specified tags. +// +// You can use filters to limit the results. For example, you can query for the +// tags for a specific Auto Scaling group. You can specify multiple values for a +// filter. A tag must match at least one of the 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Tag Auto Scaling groups and instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error) { if params == nil { params = &DescribeTagsInput{} diff --git a/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go b/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go index e7324f349c7..999ef6c9012 100644 --- a/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go +++ b/service/autoscaling/api_op_DescribeTerminationPolicyTypes.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Describes the termination policies supported by Amazon EC2 Auto Scaling. +// +// For more information, see [Work with Amazon EC2 Auto Scaling termination policies] in the Amazon EC2 Auto Scaling User Guide. +// +// [Work with Amazon EC2 Auto Scaling termination policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html func (c *Client) DescribeTerminationPolicyTypes(ctx context.Context, params *DescribeTerminationPolicyTypesInput, optFns ...func(*Options)) (*DescribeTerminationPolicyTypesOutput, error) { if params == nil { params = &DescribeTerminationPolicyTypesInput{} diff --git a/service/autoscaling/api_op_DescribeTrafficSources.go b/service/autoscaling/api_op_DescribeTrafficSources.go index 920b9ccfbc5..1b1e44e5548 100644 --- a/service/autoscaling/api_op_DescribeTrafficSources.go +++ b/service/autoscaling/api_op_DescribeTrafficSources.go @@ -11,10 +11,12 @@ 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 +// 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 { @@ -45,11 +47,15 @@ type DescribeTrafficSourcesInput struct { // previous call.) NextToken *string - // The traffic source type that you want to describe. The following lists the - // valid values: + // 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 diff --git a/service/autoscaling/api_op_DescribeWarmPool.go b/service/autoscaling/api_op_DescribeWarmPool.go index 1322568436f..4112602612e 100644 --- a/service/autoscaling/api_op_DescribeWarmPool.go +++ b/service/autoscaling/api_op_DescribeWarmPool.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Gets information about a warm pool and its instances. +// +// For more information, see [Warm pools for Amazon EC2 Auto Scaling] in the Amazon EC2 Auto Scaling User Guide. +// +// [Warm pools for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html func (c *Client) DescribeWarmPool(ctx context.Context, params *DescribeWarmPoolInput, optFns ...func(*Options)) (*DescribeWarmPoolOutput, error) { if params == nil { params = &DescribeWarmPoolInput{} diff --git a/service/autoscaling/api_op_DetachInstances.go b/service/autoscaling/api_op_DetachInstances.go index e82e4167415..7155c6c7927 100644 --- a/service/autoscaling/api_op_DetachInstances.go +++ b/service/autoscaling/api_op_DetachInstances.go @@ -11,16 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes one or more instances from the specified Auto Scaling group. After the -// instances are detached, you can manage them independent of the Auto Scaling -// group. If you do not specify the option to decrement the desired capacity, -// Amazon EC2 Auto Scaling launches instances to replace the ones that are -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Removes one or more instances from the specified Auto Scaling group. +// +// After the instances are detached, you can manage them independent of the Auto +// Scaling group. +// +// If you do not specify the option to decrement the desired capacity, Amazon EC2 +// Auto Scaling launches instances to replace the ones that are 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Detach EC2 instances from your Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html func (c *Client) DetachInstances(ctx context.Context, params *DetachInstancesInput, optFns ...func(*Options)) (*DetachInstancesOutput, error) { if params == nil { params = &DetachInstancesInput{} diff --git a/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go b/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go index a8262e3fa66..d6b132c5f5c 100644 --- a/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go +++ b/service/autoscaling/api_op_DetachLoadBalancerTargetGroups.go @@ -10,19 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 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 -// 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 . +// 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 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 deregistered, +// then you can no longer describe the target group using the DescribeLoadBalancerTargetGroupsAPI 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. 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 ec7e4a6abe3..667295e9bdd 100644 --- a/service/autoscaling/api_op_DetachLoadBalancers.go +++ b/service/autoscaling/api_op_DetachLoadBalancers.go @@ -10,18 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// Balancers, Network Load Balancers, or Gateway Load Balancers, use the -// DetachLoadBalancerTargetGroups API instead. When you detach a load balancer, it -// enters the Removing state while deregistering the instances in the group. When -// all instances are deregistered, then you can no longer describe the load -// balancer using the DescribeLoadBalancers API call. The instances remain running. +// 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 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 Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroupsAPI +// instead. +// +// When you detach a load balancer, it enters the Removing state while +// deregistering the instances in the group. When all instances are deregistered, +// then you can no longer describe the load balancer using the DescribeLoadBalancersAPI call. The +// instances remain running. func (c *Client) DetachLoadBalancers(ctx context.Context, params *DetachLoadBalancersInput, optFns ...func(*Options)) (*DetachLoadBalancersOutput, error) { if params == nil { params = &DetachLoadBalancersInput{} diff --git a/service/autoscaling/api_op_DetachTrafficSources.go b/service/autoscaling/api_op_DetachTrafficSources.go index 7835a2f27a7..cf31d0f805a 100644 --- a/service/autoscaling/api_op_DetachTrafficSources.go +++ b/service/autoscaling/api_op_DetachTrafficSources.go @@ -12,10 +12,11 @@ import ( ) // Detaches one or more traffic sources from the specified Auto Scaling group. +// // When you detach a traffic source, 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. +// then you can no longer describe the traffic source using the DescribeTrafficSourcesAPI call. The +// instances continue to run. func (c *Client) DetachTrafficSources(ctx context.Context, params *DetachTrafficSourcesInput, optFns ...func(*Options)) (*DetachTrafficSourcesOutput, error) { if params == nil { params = &DetachTrafficSourcesInput{} diff --git a/service/autoscaling/api_op_DisableMetricsCollection.go b/service/autoscaling/api_op_DisableMetricsCollection.go index 22c04fd41b2..78b607a3340 100644 --- a/service/autoscaling/api_op_DisableMetricsCollection.go +++ b/service/autoscaling/api_op_DisableMetricsCollection.go @@ -33,31 +33,55 @@ type DisableMetricsCollectionInput struct { // This member is required. AutoScalingGroupName *string - // Identifies the metrics to disable. You can specify one or more of the following - // metrics: + // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // + // If you omit this property, all metrics are disabled. + // + // For more information, see [Auto Scaling group metrics] in the Amazon EC2 Auto Scaling User Guide. + // + // [Auto Scaling group metrics]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics Metrics []string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_EnableMetricsCollection.go b/service/autoscaling/api_op_EnableMetricsCollection.go index 60dfd1f8a49..a2757d3af0a 100644 --- a/service/autoscaling/api_op_EnableMetricsCollection.go +++ b/service/autoscaling/api_op_EnableMetricsCollection.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables group metrics collection for the specified Auto Scaling group. You can -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Enables group metrics collection for the specified Auto Scaling group. +// +// You can 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]in the +// Amazon EC2 Auto Scaling User Guide. +// +// [Monitor CloudWatch metrics for your Auto Scaling groups and instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html func (c *Client) EnableMetricsCollection(ctx context.Context, params *EnableMetricsCollectionInput, optFns ...func(*Options)) (*EnableMetricsCollectionOutput, error) { if params == nil { params = &EnableMetricsCollectionInput{} @@ -44,31 +46,56 @@ type EnableMetricsCollectionInput struct { // This member is required. Granularity *string - // Identifies the metrics to enable. You can specify one or more of the following - // metrics: + // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // enabled. + // + // For more information, see [Auto Scaling group metrics] in the Amazon EC2 Auto Scaling User Guide. + // + // [Auto Scaling group metrics]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics Metrics []string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_EnterStandby.go b/service/autoscaling/api_op_EnterStandby.go index 97a8dd11422..4c4016edc7c 100644 --- a/service/autoscaling/api_op_EnterStandby.go +++ b/service/autoscaling/api_op_EnterStandby.go @@ -11,15 +11,20 @@ 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Temporarily removing instances from your Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html func (c *Client) EnterStandby(ctx context.Context, params *EnterStandbyInput, optFns ...func(*Options)) (*EnterStandbyOutput, error) { if params == nil { params = &EnterStandbyInput{} diff --git a/service/autoscaling/api_op_ExecutePolicy.go b/service/autoscaling/api_op_ExecutePolicy.go index a2281d21de4..30880bb2107 100644 --- a/service/autoscaling/api_op_ExecutePolicy.go +++ b/service/autoscaling/api_op_ExecutePolicy.go @@ -37,24 +37,30 @@ type ExecutePolicyInput struct { // The name of the Auto Scaling group. AutoScalingGroupName *string - // The breach threshold for the alarm. Required if the policy type is StepScaling - // and not supported otherwise. + // The breach threshold for the alarm. + // + // Required if the policy type is StepScaling and not supported otherwise. BreachThreshold *float64 // 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 - // Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in + // complete before executing the policy. + // + // Valid only if the policy type is SimpleScaling . For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling] in // the Amazon EC2 Auto Scaling User Guide. + // + // [Scaling cooldowns for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html HonorCooldown *bool // 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 - // to 59. If you specify a metric value that doesn't correspond to a step - // adjustment for the policy, the call returns an error. Required if the policy - // type is StepScaling and not supported otherwise. + // to 59. + // + // If you specify a metric value that doesn't correspond to a step adjustment for + // the policy, the call returns an error. + // + // Required if the policy type is StepScaling and not supported otherwise. MetricValue *float64 noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_ExitStandby.go b/service/autoscaling/api_op_ExitStandby.go index b441b4de859..5f8b6616d5f 100644 --- a/service/autoscaling/api_op_ExitStandby.go +++ b/service/autoscaling/api_op_ExitStandby.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Temporarily removing instances from your Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html func (c *Client) ExitStandby(ctx context.Context, params *ExitStandbyInput, optFns ...func(*Options)) (*ExitStandbyOutput, error) { if params == nil { params = &ExitStandbyInput{} diff --git a/service/autoscaling/api_op_GetPredictiveScalingForecast.go b/service/autoscaling/api_op_GetPredictiveScalingForecast.go index 6e9b77e25ea..32a7f4c24b1 100644 --- a/service/autoscaling/api_op_GetPredictiveScalingForecast.go +++ b/service/autoscaling/api_op_GetPredictiveScalingForecast.go @@ -12,15 +12,20 @@ import ( "time" ) -// Retrieves the forecast data for a predictive scaling policy. Load forecasts are -// predictions of the hourly load values using historical load data from CloudWatch -// and an analysis of historical trends. Capacity forecasts are represented as -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Retrieves the forecast data for a predictive scaling policy. +// +// Load forecasts are predictions of the hourly load values using historical load +// data from CloudWatch and an analysis of historical trends. Capacity forecasts +// are represented as 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Predictive scaling for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html func (c *Client) GetPredictiveScalingForecast(ctx context.Context, params *GetPredictiveScalingForecastInput, optFns ...func(*Options)) (*GetPredictiveScalingForecastOutput, error) { if params == nil { params = &GetPredictiveScalingForecastInput{} @@ -44,10 +49,11 @@ type GetPredictiveScalingForecastInput struct { AutoScalingGroupName *string // The exclusive end time of the time range for the forecast data to get. The - // maximum time duration between the start and end time is 30 days. Although this - // parameter can accept a date and time that is more than two days in the future, - // the availability of forecast data has limits. Amazon EC2 Auto Scaling only - // issues forecasts for periods of two days in advance. + // maximum time duration between the start and end time is 30 days. + // + // Although this parameter can accept a date and time that is more than two days + // in the future, the availability of forecast data has limits. Amazon EC2 Auto + // Scaling only issues forecasts for periods of two days in advance. // // This member is required. EndTime *time.Time diff --git a/service/autoscaling/api_op_PutLifecycleHook.go b/service/autoscaling/api_op_PutLifecycleHook.go index d54b9c44d2b..b6a8abddef1 100644 --- a/service/autoscaling/api_op_PutLifecycleHook.go +++ b/service/autoscaling/api_op_PutLifecycleHook.go @@ -11,32 +11,45 @@ import ( ) // Creates or updates a lifecycle hook for the specified Auto Scaling group. +// // Lifecycle hooks let you create solutions that are aware of events in the Auto // 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: +// 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. +// instance in a wait state using the RecordLifecycleActionHeartbeatAPI 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] 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. // -// 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, -// you can delete it by calling the DeleteLifecycleHook API. +// 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, you can delete it by calling the DeleteLifecycleHook +// API. +// +// [Amazon EC2 Auto Scaling lifecycle hooks]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html func (c *Client) PutLifecycleHook(ctx context.Context, params *PutLifecycleHookInput, optFns ...func(*Options)) (*PutLifecycleHookOutput, error) { if params == nil { params = &PutLifecycleHookInput{} @@ -65,8 +78,9 @@ 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: - // CONTINUE | ABANDON + // or if an unexpected failure occurs. The default value is ABANDON . + // + // Valid values: CONTINUE | ABANDON DefaultResult *string // The maximum time, in seconds, that can elapse before the lifecycle hook times @@ -76,10 +90,13 @@ type PutLifecycleHookInput struct { // 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 @@ -89,19 +106,25 @@ type PutLifecycleHookInput struct { // The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto // Scaling uses to notify you when an instance is in a wait state for the lifecycle - // hook. You can specify either an Amazon SNS topic or an Amazon SQS queue. If you - // specify an empty string, this overrides the current ARN. This operation uses the - // 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 + // hook. You can specify either an Amazon SNS topic or an Amazon SQS queue. + // + // If you specify an empty string, this overrides the current ARN. + // + // This operation uses the 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" . NotificationTargetARN *string // The ARN of the IAM role that allows the Auto Scaling group to publish to the - // specified notification target. Valid only if the notification target is an - // Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but - // optional when updating existing hooks. + // specified notification target. + // + // Valid only if the notification target is an Amazon SNS topic or an Amazon SQS + // queue. Required for new lifecycle hooks, but optional when updating existing + // hooks. RoleARN *string noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_PutNotificationConfiguration.go b/service/autoscaling/api_op_PutNotificationConfiguration.go index 14d2c8183ad..64a7eeaf548 100644 --- a/service/autoscaling/api_op_PutNotificationConfiguration.go +++ b/service/autoscaling/api_op_PutNotificationConfiguration.go @@ -12,11 +12,16 @@ import ( // Configures an Auto Scaling group to send notifications when specified events // 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) -// 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. +// 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] 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. +// +// [Getting Amazon SNS notifications when your Auto Scaling group scales]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html func (c *Client) PutNotificationConfiguration(ctx context.Context, params *PutNotificationConfigurationInput, optFns ...func(*Options)) (*PutNotificationConfigurationOutput, error) { if params == nil { params = &PutNotificationConfigurationInput{} @@ -40,8 +45,7 @@ type PutNotificationConfigurationInput struct { AutoScalingGroupName *string // The type of event that causes the notification to be sent. To query the - // notification types supported by Amazon EC2 Auto Scaling, call the - // DescribeAutoScalingNotificationTypes API. + // notification types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypesAPI. // // This member is required. NotificationTypes []string diff --git a/service/autoscaling/api_op_PutScalingPolicy.go b/service/autoscaling/api_op_PutScalingPolicy.go index 5e78299c19c..a2d682db49f 100644 --- a/service/autoscaling/api_op_PutScalingPolicy.go +++ b/service/autoscaling/api_op_PutScalingPolicy.go @@ -14,14 +14,21 @@ import ( // Creates or updates a scaling policy for an Auto Scaling group. Scaling policies // 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) -// 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) -// 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. +// not used. +// +// For more information about using dynamic scaling, see [Target tracking scaling policies] and [Step and simple scaling policies] in the Amazon EC2 +// Auto Scaling User Guide. +// +// For more information about using predictive scaling, see [Predictive scaling for Amazon EC2 Auto Scaling] 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 DeletePolicyAPI. +// +// [Step and simple scaling policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html +// [Target tracking scaling policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html +// [Predictive scaling for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyInput, optFns ...func(*Options)) (*PutScalingPolicyOutput, error) { if params == nil { params = &PutScalingPolicyInput{} @@ -51,38 +58,51 @@ type PutScalingPolicyInput struct { // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // and PercentChangeInCapacity . + // + // Required if the policy type is StepScaling or SimpleScaling . For more + // information, see [Scaling adjustment types]in the Amazon EC2 Auto Scaling User Guide. + // + // [Scaling adjustment types]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment 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 + // cooldown. + // + // Valid only if the policy type is SimpleScaling . For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling] in + // the Amazon EC2 Auto Scaling User Guide. + // + // Default: None + // + // [Scaling cooldowns for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // enabled. For more information, see [Disabling a scaling policy for an Auto Scaling group]in the Amazon EC2 Auto Scaling User Guide. + // + // [Disabling a scaling policy for an Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html Enabled *bool - // Not needed if the default instance warmup is defined for the group. The - // estimated time, in seconds, until a newly launched instance can contribute to - // 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 - // 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. + // Not needed if the default instance warmup is defined for the group. + // + // The estimated time, in seconds, until a newly launched instance can contribute + // to 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 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 . + // Average . + // + // Valid only if the policy type is StepScaling . MetricAggregationType *string // The minimum value to scale by when the adjustment type is @@ -91,11 +111,16 @@ type PutScalingPolicyInput struct { // 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) - // 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. + // instances. + // + // Valid only if the policy type is StepScaling or SimpleScaling . For more + // information, see [Scaling adjustment types]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. + // + // [Scaling adjustment types]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment MinAdjustmentMagnitude *int32 // Available for backward compatibility. Use MinAdjustmentMagnitude instead. @@ -104,43 +129,64 @@ type PutScalingPolicyInput struct { MinAdjustmentStep *int32 // One of the following policy types: + // // - 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) - // in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is - // PredictiveScaling . + // 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] in the Amazon EC2 Auto Scaling API Reference. + // + // Required if the policy type is PredictiveScaling . + // + // [PredictiveScalingConfiguration]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html 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 non-negative 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 - // policy type.) + // 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: + // 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) - // in the Amazon EC2 Auto Scaling API Reference. Required if the policy type is - // TargetTrackingScaling . + // ResourceLabel property with the PredefinedMetricSpecification . + // + // For more information, see [TargetTrackingConfiguration] in the Amazon EC2 Auto Scaling API Reference. + // + // Required if the policy type is TargetTrackingScaling . + // + // [TargetTrackingConfiguration]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html TargetTrackingConfiguration *types.TargetTrackingConfiguration noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go b/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go index 80ddba415a8..76bb5f58b47 100644 --- a/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go +++ b/service/autoscaling/api_op_PutScheduledUpdateGroupAction.go @@ -11,13 +11,18 @@ import ( "time" ) -// 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 -// DeleteScheduledAction API. If you try to schedule your action in the past, -// Amazon EC2 Auto Scaling returns an error message. +// Creates or updates a scheduled scaling action for an Auto Scaling group. +// +// For more information, see [Scheduled scaling] 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 DeleteScheduledActionAPI. +// +// If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns +// an error message. +// +// [Scheduled scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html func (c *Client) PutScheduledUpdateGroupAction(ctx context.Context, params *PutScheduledUpdateGroupActionInput, optFns ...func(*Options)) (*PutScheduledUpdateGroupActionOutput, error) { if params == nil { params = &PutScheduledUpdateGroupActionInput{} @@ -47,8 +52,10 @@ type PutScheduledUpdateGroupActionInput struct { // 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 . + // beyond this capacity if you add more scaling conditions. + // + // You must specify at 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, @@ -64,27 +71,35 @@ 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 - // Coordinated Time (UTC) by default. + // For more information about this format, see [Crontab]. + // + // 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. + // + // [Crontab]: http://crontab.org 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. Time *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) - // . + // 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]: 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 19a8301b15c..077722addc1 100644 --- a/service/autoscaling/api_op_PutWarmPool.go +++ b/service/autoscaling/api_op_PutWarmPool.go @@ -15,14 +15,18 @@ import ( // 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 -// template or launch configuration that requests Spot Instances. You can view the -// instances in the warm pool using the DescribeWarmPool API call. If you are no -// longer using a warm pool, you can delete it by calling the DeleteWarmPool API. +// information and example configurations, see [Warm pools for Amazon EC2 Auto Scaling]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 template or launch configuration that +// requests Spot Instances. +// +// You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no +// longer using a warm pool, you can delete it by calling the DeleteWarmPoolAPI. +// +// [Warm pools for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html func (c *Client) PutWarmPool(ctx context.Context, params *PutWarmPoolInput, optFns ...func(*Options)) (*PutWarmPoolOutput, error) { if params == nil { params = &PutWarmPoolInput{} @@ -54,17 +58,21 @@ type PutWarmPoolInput struct { // pool or in any state except Terminated for the Auto Scaling group. This is an // optional property. Specify it only if you do not want the warm pool size to be // determined by the difference between the group's maximum capacity and its - // 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 + // 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 - // 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 - // remove a value that you previously set, include the property but specify -1 for - // the value. + // 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 remove a value that you previously set, include + // the property but specify -1 for the value. MaxGroupPreparedCapacity *int32 // Specifies the minimum number of instances to maintain in the warm pool. This diff --git a/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go b/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go index e5ef6838f95..ba7b560f862 100644 --- a/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go +++ b/service/autoscaling/api_op_RecordLifecycleActionHeartbeat.go @@ -12,26 +12,35 @@ import ( // 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: +// the PutLifecycleHookAPI 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. // -// 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 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Amazon EC2 Auto Scaling lifecycle hooks]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html 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 c75b39a064c..3e6c78abb86 100644 --- a/service/autoscaling/api_op_ResumeProcesses.go +++ b/service/autoscaling/api_op_ResumeProcesses.go @@ -11,9 +11,11 @@ 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) -// in the Amazon EC2 Auto Scaling User Guide. +// process, for the specified Auto Scaling group. +// +// For more information, see [Suspending and resuming scaling processes] in the Amazon EC2 Auto Scaling User Guide. +// +// [Suspending and resuming scaling processes]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html func (c *Client) ResumeProcesses(ctx context.Context, params *ResumeProcessesInput, optFns ...func(*Options)) (*ResumeProcessesOutput, error) { if params == nil { params = &ResumeProcessesInput{} @@ -37,15 +39,25 @@ 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. ScalingProcesses []string diff --git a/service/autoscaling/api_op_RollbackInstanceRefresh.go b/service/autoscaling/api_op_RollbackInstanceRefresh.go index fc98f038e3c..75ba1bcaf1c 100644 --- a/service/autoscaling/api_op_RollbackInstanceRefresh.go +++ b/service/autoscaling/api_op_RollbackInstanceRefresh.go @@ -13,21 +13,28 @@ import ( // Cancels an instance refresh that is in progress and rolls back any changes that // 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) -// 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: +// configuration that it was using before the start of the instance refresh. +// +// This operation is part of the [instance refresh feature] 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. // // 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. +// operation through the DescribeInstanceRefreshesAPI operation. +// +// [instance refresh feature]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html 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 531f94a1f2d..9c6d610b7cd 100644 --- a/service/autoscaling/api_op_SetDesiredCapacity.go +++ b/service/autoscaling/api_op_SetDesiredCapacity.go @@ -10,11 +10,15 @@ 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Manual scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html func (c *Client) SetDesiredCapacity(ctx context.Context, params *SetDesiredCapacityInput, optFns ...func(*Options)) (*SetDesiredCapacityOutput, error) { if params == nil { params = &SetDesiredCapacityInput{} diff --git a/service/autoscaling/api_op_SetInstanceHealth.go b/service/autoscaling/api_op_SetInstanceHealth.go index 04b2e68380e..769e3358a48 100644 --- a/service/autoscaling/api_op_SetInstanceHealth.go +++ b/service/autoscaling/api_op_SetInstanceHealth.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Sets the health status of the specified instance. +// +// For more information, see [Health checks for Auto Scaling instances] in the Amazon EC2 Auto Scaling User Guide. +// +// [Health checks for Auto Scaling instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html func (c *Client) SetInstanceHealth(ctx context.Context, params *SetInstanceHealthInput, optFns ...func(*Options)) (*SetInstanceHealthOutput, error) { if params == nil { params = &SetInstanceHealthInput{} @@ -45,9 +47,12 @@ 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) - // in the Amazon EC2 Auto Scaling API Reference. + // the group. + // + // For more information about the health check grace period, see [CreateAutoScalingGroup] in the Amazon + // EC2 Auto Scaling API Reference. + // + // [CreateAutoScalingGroup]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html ShouldRespectGracePeriod *bool noSmithyDocumentSerde diff --git a/service/autoscaling/api_op_SetInstanceProtection.go b/service/autoscaling/api_op_SetInstanceProtection.go index 93e2eb3204e..5f5dd3e16c5 100644 --- a/service/autoscaling/api_op_SetInstanceProtection.go +++ b/service/autoscaling/api_op_SetInstanceProtection.go @@ -11,11 +11,16 @@ 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) -// 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. +// 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]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. +// +// [Using instance scale-in protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html func (c *Client) SetInstanceProtection(ctx context.Context, params *SetInstanceProtectionInput, optFns ...func(*Options)) (*SetInstanceProtectionOutput, error) { if params == nil { params = &SetInstanceProtectionInput{} diff --git a/service/autoscaling/api_op_StartInstanceRefresh.go b/service/autoscaling/api_op_StartInstanceRefresh.go index 0389cd5d66a..7cceee51ae9 100644 --- a/service/autoscaling/api_op_StartInstanceRefresh.go +++ b/service/autoscaling/api_op_StartInstanceRefresh.go @@ -11,28 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an instance refresh. 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 -// specifies the new AMI or user data script. Then start an instance refresh to -// immediately begin the process of updating instances in the group. If successful, -// the request's response contains a unique ID that you can use to track the -// progress of the instance refresh. To query its status, call the -// DescribeInstanceRefreshes API. To describe the instance refreshes that have -// already run, call the DescribeInstanceRefreshes API. To cancel an instance -// refresh that is in progress, use the CancelInstanceRefresh API. An instance -// refresh might fail for several reasons, such as EC2 launch failures, -// 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. +// Starts an instance refresh. +// +// This operation is part of the [instance refresh feature] 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 specifies the new AMI or user data script. +// Then start an instance refresh to immediately begin the process of updating +// instances in the group. +// +// If successful, the request's response contains a unique ID that you can use to +// track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshesAPI. +// To describe the instance refreshes that have already run, call the DescribeInstanceRefreshesAPI. To +// cancel an instance refresh that is in progress, use the CancelInstanceRefreshAPI. +// +// An instance refresh might fail for several reasons, such as EC2 launch +// failures, 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 DescribeScalingActivitiesAPI. +// +// 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 RollbackInstanceRefreshAPI. +// +// [instance refresh feature]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html func (c *Client) StartInstanceRefresh(ctx context.Context, params *StartInstanceRefreshInput, optFns ...func(*Options)) (*StartInstanceRefreshOutput, error) { if params == nil { params = &StartInstanceRefreshInput{} @@ -56,14 +61,17 @@ type StartInstanceRefreshInput struct { AutoScalingGroupName *string // The desired configuration. For example, the desired configuration can specify a - // new launch template or a new version of the current launch template. Once the - // instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the - // Auto Scaling group to reflect the new desired configuration. When you specify a - // new launch template or a new version of the current launch template for your - // desired configuration, consider enabling the SkipMatching property in - // preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances - // that already use the specified launch template and instance types. This can help - // you reduce the number of replacements that are required to apply updates. + // new launch template or a new version of the current launch template. + // + // Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the + // settings of the Auto Scaling group to reflect the new desired configuration. + // + // When you specify a new launch template or a new version of the current launch + // template for your desired configuration, consider enabling the SkipMatching + // property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips + // replacing instances that already use the specified launch template and instance + // types. This can help you reduce the number of replacements that are required to + // apply updates. DesiredConfiguration *types.DesiredConfiguration // Sets your preferences for the instance refresh so that it performs as expected @@ -73,8 +81,11 @@ type StartInstanceRefreshInput struct { // found. You can also choose to enable additional features, such as the following: // // - Auto rollback + // // - Checkpoints + // // - CloudWatch alarms + // // - Skip matching Preferences *types.RefreshPreferences diff --git a/service/autoscaling/api_op_SuspendProcesses.go b/service/autoscaling/api_op_SuspendProcesses.go index 59def834097..c2c05e60678 100644 --- a/service/autoscaling/api_op_SuspendProcesses.go +++ b/service/autoscaling/api_op_SuspendProcesses.go @@ -11,11 +11,15 @@ 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) -// in the Amazon EC2 Auto Scaling User Guide. To resume processes that have been -// suspended, call the ResumeProcesses API. +// 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]in the +// Amazon EC2 Auto Scaling User Guide. +// +// To resume processes that have been suspended, call the ResumeProcesses API. +// +// [Suspending and resuming scaling processes]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html func (c *Client) SuspendProcesses(ctx context.Context, params *SuspendProcessesInput, optFns ...func(*Options)) (*SuspendProcessesOutput, error) { if params == nil { params = &SuspendProcessesInput{} @@ -39,15 +43,25 @@ 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. ScalingProcesses []string diff --git a/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go b/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go index 991edbad6b0..779a01001f9 100644 --- a/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go +++ b/service/autoscaling/api_op_TerminateInstanceInAutoScalingGroup.go @@ -12,18 +12,23 @@ import ( ) // 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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]in the Amazon EC2 Auto Scaling User Guide. +// +// [Rebalancing activities]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage func (c *Client) TerminateInstanceInAutoScalingGroup(ctx context.Context, params *TerminateInstanceInAutoScalingGroupInput, optFns ...func(*Options)) (*TerminateInstanceInAutoScalingGroupOutput, error) { if params == nil { params = &TerminateInstanceInAutoScalingGroupInput{} diff --git a/service/autoscaling/api_op_UpdateAutoScalingGroup.go b/service/autoscaling/api_op_UpdateAutoScalingGroup.go index 6f4244ad957..2b61dc6e14e 100644 --- a/service/autoscaling/api_op_UpdateAutoScalingGroup.go +++ b/service/autoscaling/api_op_UpdateAutoScalingGroup.go @@ -11,39 +11,47 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We strongly recommend that all Auto Scaling groups use launch templates to -// ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Updates -// the configuration for the specified Auto Scaling group. To update an Auto -// Scaling group, specify the name of the group and the property that you want to -// change. Any properties that you don't specify are not changed by this update -// request. The new settings take effect on any scaling activities after this call -// returns. If you associate a new launch configuration or template with an Auto -// Scaling group, all new instances will get the updated configuration. Existing -// instances continue to run with the configuration that they were originally -// launched with. When you update a group to specify a mixed instances policy -// instead of a launch configuration or template, existing instances may be -// replaced to match the new purchasing options that you specified in the policy. -// For example, if the group currently has 100% On-Demand capacity and the policy -// specifies 50% Spot capacity, this means that half of your instances will be -// 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 : +// We strongly recommend that all Auto Scaling groups use launch templates to +// +// ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. +// +// Updates the configuration for the specified Auto Scaling group. +// +// To update an Auto Scaling group, specify the name of the group and the property +// that you want to change. Any properties that you don't specify are not changed +// by this update request. The new settings take effect on any scaling activities +// after this call returns. +// +// If you associate a new launch configuration or template with an Auto Scaling +// group, all new instances will get the updated configuration. Existing instances +// continue to run with the configuration that they were originally launched with. +// When you update a group to specify a mixed instances policy instead of a launch +// configuration or template, existing instances may be replaced to match the new +// purchasing options that you specified in the policy. For example, if the group +// currently has 100% On-Demand capacity and the policy specifies 50% Spot +// capacity, this means that half of your instances will be 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 : +// // - 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 DescribePoliciesAPI. If the group has scaling +// policies, you can update them by calling the PutScalingPolicyAPI. func (c *Client) UpdateAutoScalingGroup(ctx context.Context, params *UpdateAutoScalingGroupInput, optFns ...func(*Options)) (*UpdateAutoScalingGroupOutput, error) { if params == nil { params = &UpdateAutoScalingGroupInput{} @@ -69,36 +77,42 @@ 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) - // in the Amazon EC2 Auto Scaling User Guide. + // Enables or disables Capacity Rebalancing. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions] in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html CapacityRebalance *bool // Reserved. Context *string - // 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. + // 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]in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Scaling cooldowns for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html DefaultCooldown *int32 // The amount of time, in seconds, until a new instance is considered to have // finished initializing and resource consumption to become stable after it enters - // the InService state. During an instance refresh, Amazon EC2 Auto Scaling waits - // for the warm-up period after it replaces an instance before it moves on to - // replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up - // 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) - // 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 - // property but specify -1 for the value. However, we strongly recommend keeping - // the default instance warmup enabled by specifying a value of 0 or other nominal - // value. + // the InService state. + // + // During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up + // period after it replaces an instance before it moves on to replacing the next + // instance. Amazon EC2 Auto Scaling also waits for the warm-up 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]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 property but specify -1 for the + // value. However, we strongly recommend keeping the default instance warmup + // enabled by specifying a value of 0 or other nominal value. + // + // [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 DefaultInstanceWarmup *int32 // The desired capacity is the initial capacity of the Auto Scaling group after @@ -109,33 +123,42 @@ type UpdateAutoScalingGroupInput struct { // 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) - // 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 - // | vcpu | memory-mib + // selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection]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 | vcpu | memory-mib + // + // [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 DesiredCapacityType *string // The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // InService state. For more information, see [Set the health check grace period for an Auto Scaling group] in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Set the health check grace period for an Auto Scaling group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html 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. + // 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]in the Amazon EC2 Auto + // Scaling User Guide. + // + // Only specify EC2 if you must clear a value that was previously set. + // + // [Health checks for Auto Scaling instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html HealthCheckType *string - // An instance maintenance policy. For more information, see Set instance - // maintenance policy (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) - // in the Amazon EC2 Auto Scaling User Guide. + // An instance maintenance policy. For more information, see [Set instance maintenance policy] in the Amazon EC2 + // Auto Scaling User Guide. + // + // [Set instance maintenance policy]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html InstanceMaintenancePolicy *types.InstanceMaintenancePolicy // The name of the launch configuration. If you specify LaunchConfigurationName in @@ -150,53 +173,65 @@ type UpdateAutoScalingGroupInput 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). 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) - // in the Amazon EC2 Auto Scaling User Guide. + // a new value of 0. For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Replacing Auto Scaling instances based on maximum instance lifetime]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html 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 - // 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). + // 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 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). MaxSize *int32 // The minimum size of the Auto Scaling group. 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) - // in the Amazon EC2 Auto Scaling User Guide. + // The mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options] in the Amazon EC2 Auto + // Scaling User Guide. + // + // [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 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) - // in the Amazon EC2 Auto Scaling User Guide. + // instances from terminating on scale in, see [Using instance scale-in protection]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Using instance scale-in protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html 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 - // logical grouping of instances within a single Availability Zone. You cannot - // specify multiple Availability Zones and a cluster placement group. + // For more information, see [Placement groups]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. + // + // [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // information, see [Service-linked roles]in the Amazon EC2 Auto Scaling User Guide. + // + // [Service-linked roles]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html 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) - // in the Amazon EC2 Auto Scaling User Guide. Valid values: Default | - // AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance - // | OldestLaunchConfiguration | OldestLaunchTemplate | + // information, see [Work with Amazon EC2 Auto Scaling termination policies]in the Amazon EC2 Auto Scaling User Guide. + // + // Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | + // NewestInstance | OldestInstance | OldestLaunchConfiguration | + // OldestLaunchTemplate | // arn:aws:lambda:region:account-id:function:my-function:my-alias + // + // [Work with Amazon EC2 Auto Scaling termination policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html TerminationPolicies []string // A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you diff --git a/service/autoscaling/doc.go b/service/autoscaling/doc.go index 27a42792e23..4876c847e14 100644 --- a/service/autoscaling/doc.go +++ b/service/autoscaling/doc.go @@ -3,10 +3,14 @@ // 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) -// . +// # 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] and the [Amazon EC2 Auto Scaling API Reference]. +// +// [Amazon EC2 Auto Scaling User Guide]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ +// [Amazon EC2 Auto Scaling API Reference]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html package autoscaling diff --git a/service/autoscaling/options.go b/service/autoscaling/options.go index 9a183095a31..0521c697473 100644 --- a/service/autoscaling/options.go +++ b/service/autoscaling/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/autoscaling/types/enums.go b/service/autoscaling/types/enums.go index c93c221f21a..32c4502e50b 100644 --- a/service/autoscaling/types/enums.go +++ b/service/autoscaling/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AcceleratorManufacturer. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorManufacturer) Values() []AcceleratorManufacturer { return []AcceleratorManufacturer{ "nvidia", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for AcceleratorName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorName) Values() []AcceleratorName { return []AcceleratorName{ "a100", @@ -62,8 +64,9 @@ const ( ) // Values returns all known values for AcceleratorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorType) Values() []AcceleratorType { return []AcceleratorType{ "gpu", @@ -82,8 +85,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for BurstablePerformance. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurstablePerformance) Values() []BurstablePerformance { return []BurstablePerformance{ "included", @@ -122,8 +127,9 @@ const ( ) // Values returns all known values for CpuManufacturer. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CpuManufacturer) Values() []CpuManufacturer { return []CpuManufacturer{ "intel", @@ -141,8 +147,9 @@ const ( ) // Values returns all known values for InstanceGeneration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceGeneration) Values() []InstanceGeneration { return []InstanceGeneration{ "current", @@ -160,8 +167,9 @@ const ( // Values returns all known values for InstanceMetadataEndpointState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataEndpointState) Values() []InstanceMetadataEndpointState { return []InstanceMetadataEndpointState{ "disabled", @@ -179,8 +187,9 @@ const ( // Values returns all known values for InstanceMetadataHttpTokensState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataHttpTokensState) Values() []InstanceMetadataHttpTokensState { return []InstanceMetadataHttpTokensState{ "optional", @@ -204,8 +213,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Pending", @@ -250,8 +260,9 @@ const ( ) // Values returns all known values for LifecycleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleState) Values() []LifecycleState { return []LifecycleState{ "Pending", @@ -290,8 +301,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -309,8 +321,9 @@ const ( ) // Values returns all known values for LocalStorageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocalStorageType) Values() []LocalStorageType { return []LocalStorageType{ "hdd", @@ -330,8 +343,9 @@ const ( ) // Values returns all known values for MetricStatistic. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricStatistic) Values() []MetricStatistic { return []MetricStatistic{ "Average", @@ -353,8 +367,9 @@ const ( ) // Values returns all known values for MetricType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricType) Values() []MetricType { return []MetricType{ "ASGAverageCPUUtilization", @@ -376,6 +391,7 @@ const ( // 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{ @@ -398,6 +414,7 @@ const ( // 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{ @@ -420,6 +437,7 @@ const ( // Values returns all known values for PredefinedScalingMetricType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PredefinedScalingMetricType) Values() []PredefinedScalingMetricType { return []PredefinedScalingMetricType{ @@ -440,8 +458,9 @@ const ( // Values returns all known values for PredictiveScalingMaxCapacityBreachBehavior. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PredictiveScalingMaxCapacityBreachBehavior) Values() []PredictiveScalingMaxCapacityBreachBehavior { return []PredictiveScalingMaxCapacityBreachBehavior{ "HonorMaxCapacity", @@ -458,8 +477,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ForecastAndScale", @@ -475,8 +495,9 @@ const ( ) // Values returns all known values for RefreshStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RefreshStrategy) Values() []RefreshStrategy { return []RefreshStrategy{ "Rolling", @@ -494,6 +515,7 @@ const ( // Values returns all known values for ScaleInProtectedInstances. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScaleInProtectedInstances) Values() []ScaleInProtectedInstances { return []ScaleInProtectedInstances{ @@ -524,6 +546,7 @@ const ( // Values returns all known values for ScalingActivityStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScalingActivityStatusCode) Values() []ScalingActivityStatusCode { return []ScalingActivityStatusCode{ @@ -553,8 +576,9 @@ const ( ) // Values returns all known values for StandbyInstances. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StandbyInstances) Values() []StandbyInstances { return []StandbyInstances{ "Terminate", @@ -573,8 +597,9 @@ const ( ) // Values returns all known values for WarmPoolState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WarmPoolState) Values() []WarmPoolState { return []WarmPoolState{ "Stopped", @@ -591,8 +616,9 @@ const ( ) // Values returns all known values for WarmPoolStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WarmPoolStatus) Values() []WarmPoolStatus { return []WarmPoolStatus{ "PendingDelete", diff --git a/service/autoscaling/types/errors.go b/service/autoscaling/types/errors.go index 948d6242c6a..8ce65cce8ff 100644 --- a/service/autoscaling/types/errors.go +++ b/service/autoscaling/types/errors.go @@ -146,8 +146,9 @@ func (e *IrreversibleInstanceRefreshFault) ErrorFault() smithy.ErrorFault { retu // 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. +// For more information, see [DescribeAccountLimits]in the Amazon EC2 Auto Scaling API Reference. +// +// [DescribeAccountLimits]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html type LimitExceededFault struct { Message *string diff --git a/service/autoscaling/types/types.go b/service/autoscaling/types/types.go index cc705438581..003a0f847c7 100644 --- a/service/autoscaling/types/types.go +++ b/service/autoscaling/types/types.go @@ -8,7 +8,7 @@ import ( ) // Specifies the minimum and maximum for the AcceleratorCount object when you -// specify InstanceRequirements for an Auto Scaling group. +// specify InstanceRequirementsfor an Auto Scaling group. type AcceleratorCountRequest struct { // The maximum value. @@ -21,7 +21,7 @@ type AcceleratorCountRequest struct { } // Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB object when -// you specify InstanceRequirements for an Auto Scaling group. +// you specify InstanceRequirementsfor an Auto Scaling group. type AcceleratorTotalMemoryMiBRequest struct { // The memory maximum in MiB. @@ -201,6 +201,7 @@ type AutoScalingGroup struct { LoadBalancerNames []string // The maximum amount of time, in seconds, that an instance can be in service. + // // Valid Range: Minimum value of 0. MaxInstanceLifetime *int32 @@ -221,8 +222,7 @@ type AutoScalingGroup struct { // group uses to call other Amazon Web Services on your behalf. ServiceLinkedRoleARN *string - // The current state of the group when the DeleteAutoScalingGroup operation is in - // progress. + // The current state of the group when the DeleteAutoScalingGroup operation is in progress. Status *string // The suspended processes associated with the group. @@ -279,13 +279,16 @@ 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) - // 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 | - // Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | - // Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | - // Warmed:Terminated | Warmed:Stopped | Warmed:Running + // information about lifecycle states, see [Instance lifecycle]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 | Standby | Warmed:Pending | Warmed:Pending:Wait | + // Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | + // Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running + // + // [Instance lifecycle]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html // // This member is required. LifecycleState *string @@ -307,14 +310,16 @@ type AutoScalingInstanceDetails struct { LaunchTemplate *LaunchTemplateSpecification // The number of capacity units contributed by the instance based on its instance - // type. Valid Range: Minimum value of 1. Maximum value of 999. + // type. + // + // Valid Range: Minimum value of 1. Maximum value of 999. WeightedCapacity *string noSmithyDocumentSerde } // Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object when -// you specify InstanceRequirements for an Auto Scaling group. +// you specify InstanceRequirementsfor an Auto Scaling group. type BaselineEbsBandwidthMbpsRequest struct { // The maximum value in Mbps. @@ -330,10 +335,12 @@ type BaselineEbsBandwidthMbpsRequest struct { 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 . + // more information, see [Device naming on Linux instances]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 . + // + // [Device naming on Linux instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html // // This member is required. DeviceName *string @@ -343,9 +350,10 @@ type BlockDeviceMapping struct { // Setting this value to true prevents a volume that is included in the block // device mapping of the AMI from being mapped to the specified device name at - // launch. If NoDevice is true for the root device, instances might fail the EC2 - // health check. In that case, Amazon EC2 Auto Scaling launches replacement - // instances. + // launch. + // + // If NoDevice is true for the root device, instances might fail the EC2 health + // check. In that case, Amazon EC2 Auto Scaling launches replacement instances. NoDevice *bool // The name of the instance store volume (virtual device) to attach to an instance @@ -375,34 +383,42 @@ 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: +// 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. +// must first publish the metric to CloudWatch. For more information, see [Publish custom metrics]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) -// in the Amazon CloudWatch User Guide. +// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts]. +// +// 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]in the Amazon CloudWatch User +// Guide. +// +// [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html +// [Amazon CloudWatch concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html +// [Publish custom metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html type CustomizedMetricSpecification struct { - // The dimensions of the metric. Conditional: If you published your metric with - // dimensions, you must specify the same dimensions in your scaling policy. + // The dimensions of the metric. + // + // Conditional: If you published your metric with 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) - // . + // dimensions, inspect the [Metric]object that is returned by a call to [ListMetrics]. + // + // [ListMetrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html + // [Metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html MetricName *string // The metrics to include in the target tracking scaling policy, as a metric data @@ -416,30 +432,36 @@ 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) - // data type in the Amazon CloudWatch API Reference. + // supports, see the [MetricDatum]data type in the Amazon CloudWatch API Reference. + // + // [MetricDatum]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html Unit *string noSmithyDocumentSerde } -// Describes the desired configuration for an instance refresh. If you specify a -// desired configuration, you must specify either a LaunchTemplate or a -// MixedInstancesPolicy . +// Describes the desired configuration for an instance refresh. +// +// If you specify a desired configuration, you must specify either a LaunchTemplate +// or a 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. + // information about launch templates, see [Launch templates]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Launch templates]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html 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 - // 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 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] // in the Amazon EC2 Auto Scaling User Guide. + // + // [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 MixedInstancesPolicy *MixedInstancesPolicy noSmithyDocumentSerde @@ -455,35 +477,47 @@ type Ebs struct { // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // information, see [Supported instance types]. 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] in the Amazon EC2 Auto Scaling User Guide. + // + // [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 + // [Supported instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances 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 // 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: + // 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 - // 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.) + // + // For io1 volumes, we guarantee 64,000 IOPS only for [Instances built on the Nitro System]. 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.) + // + // [Instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances Iops *int32 - // The snapshot ID of the volume to use. You must specify either a VolumeSize or a - // SnapshotId . + // The snapshot ID of the volume to use. + // + // You must specify either a VolumeSize or a SnapshotId . SnapshotId *string // The throughput (MiBps) to provision for a gp3 volume. @@ -491,18 +525,26 @@ type Ebs struct { // 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] in the Amazon EC2 User Guide for + // Linux Instances. + // + // Valid values: standard | io1 | gp2 | st1 | sc1 | gp3 + // + // [Amazon EBS volume types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html VolumeType *string noSmithyDocumentSerde @@ -515,28 +557,50 @@ type EnabledMetric struct { 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) - // in the Amazon EC2 Auto Scaling User Guide. + // + // For more information, see [Auto Scaling group metrics] in the Amazon EC2 Auto Scaling User Guide. + // + // [Auto Scaling group metrics]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics Metric *string noSmithyDocumentSerde @@ -560,43 +624,63 @@ type FailedScheduledUpdateGroupActionRequest struct { } // 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Tag Auto Scaling groups and instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html 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 ). - // DescribeAutoScalingGroups Valid values for Name include the following: + // The name of the filter. + // + // The valid values for Name depend on which API operation 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: + // + // 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 - // 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". + // 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 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". Values []string noSmithyDocumentSerde @@ -624,8 +708,10 @@ type Instance struct { 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) - // in the Amazon EC2 Auto Scaling User Guide. + // used. For information about lifecycle states, see [Instance lifecycle]in the Amazon EC2 Auto + // Scaling User Guide. + // + // [Instance lifecycle]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html // // This member is required. LifecycleState LifecycleState @@ -646,24 +732,30 @@ type Instance struct { LaunchTemplate *LaunchTemplateSpecification // The number of capacity units contributed by the instance based on its instance - // type. Valid Range: Minimum value of 1. Maximum value of 999. + // type. + // + // Valid Range: Minimum value of 1. Maximum value of 999. WeightedCapacity *string noSmithyDocumentSerde } -// Describes an instance maintenance policy. For more information, see Set -// instance maintenance policy (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) -// in the Amazon EC2 Auto Scaling User Guide. +// Describes an instance maintenance policy. +// +// For more information, see [Set instance maintenance policy] in the Amazon EC2 Auto Scaling User Guide. +// +// [Set instance maintenance policy]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html type InstanceMaintenancePolicy struct { // Specifies the upper threshold as a percentage of the desired capacity of the // Auto Scaling group. It represents the maximum percentage of the group that can // be in service and healthy, or pending, to support your workload when replacing // instances. Value range is 100 to 200. To clear a previously set value, specify a - // value of -1 . Both MinHealthyPercentage and MaxHealthyPercentage must be - // specified, and the difference between them cannot be greater than 100. A large - // range increases the number of instances that can be replaced at the same time. + // value of -1 . + // + // Both MinHealthyPercentage and MaxHealthyPercentage must be specified, and the + // difference between them cannot be greater than 100. A large range increases the + // number of instances that can be replaced at the same time. MaxHealthyPercentage *int32 // Specifies the lower threshold as a percentage of the desired capacity of the @@ -676,31 +768,38 @@ type InstanceMaintenancePolicy struct { noSmithyDocumentSerde } -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// The metadata options for the instances. For more information, see [Configuring the Instance Metadata Options] in the +// Amazon EC2 Auto Scaling User Guide. +// +// [Configuring the Instance Metadata Options]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds 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. + // 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 - // larger the number, the further instance metadata requests can travel. Default: 1 + // larger the number, the further instance metadata requests can travel. + // + // Default: 1 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 - // 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 - // credentials are not available. + // 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 credentials are not + // available. HttpTokens InstanceMetadataHttpTokensState noSmithyDocumentSerde @@ -731,18 +830,21 @@ 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. - // Therefore, these instances don't need to be replaced as part of the rollback. + // 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 // The percentage of the instance refresh that is complete. For each instance // replacement, Amazon EC2 Auto Scaling tracks the instance's health status and // warm-up time. When the instance's health status changes to healthy and the // specified warm-up time passes, the instance is considered updated and is added - // to the percentage complete. PercentageComplete does not include instances that - // are replaced during a rollback. This value gradually goes back down to zero - // during a rollback. + // to the percentage complete. + // + // PercentageComplete does not include instances that are replaced during a + // rollback. This value gradually goes back down to zero during a rollback. PercentageComplete *int32 // The preferences for an instance refresh. @@ -758,16 +860,25 @@ 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. Status InstanceRefreshStatus @@ -826,24 +937,31 @@ type InstanceRefreshWarmPoolProgress struct { // The attributes for the instance types for a mixed instances policy. Amazon EC2 // Auto Scaling uses your specified requirements to identify instance types. Then, // it uses your On-Demand and Spot allocation strategies to launch instances from -// these instance types. When you specify multiple attributes, you get instance -// types that satisfy all of the specified attributes. If you specify multiple -// values for an attribute, you get instance types that satisfy any of the -// 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: +// these instance types. +// +// When you specify multiple attributes, you get instance types that satisfy all +// of the specified attributes. If you specify multiple values for an attribute, +// you get instance types that satisfy any of the 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. // // 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) -// in the Amazon EC2 User Guide for Linux Instances. +// Any unspecified optional attribute is set to its default. +// +// For more information, see [Creating an Auto Scaling group using attribute-based instance type selection] 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]in the Amazon EC2 User Guide for Linux Instances. +// +// [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 +// [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 type InstanceRequirements struct { // The minimum and maximum instance memory size for an instance type, in MiB. @@ -857,108 +975,163 @@ type InstanceRequirements struct { VCpuCount *VCpuCountRequest // 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 + // Services Inferentia chips) for an instance type. + // + // To exclude accelerator-enabled 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 . + // // 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 . + // // Default: Any accelerator AcceleratorNames []AcceleratorName // The minimum and maximum total memory size for the accelerators on an instance - // type, in MiB. Default: No minimum or maximum limits + // type, in MiB. + // + // Default: No minimum or maximum limits 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 . + // // 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 - // instance types + // 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 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]in the Amazon EC2 User Guide for Linux + // Instances. + // + // Default: No minimum or maximum limits + // + // [Amazon EBS–optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html 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) - // in the Amazon EC2 User Guide for Linux Instances. Default: excluded + // or required. For more information, see [Burstable performance instances]in the Amazon EC2 User Guide for Linux + // Instances. + // + // Default: excluded + // + // [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html 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 + // 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 + // 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 more information, see [Instance types]in the Amazon EC2 User Guide for Linux Instances. + // // - For previous generation instance types, specify previous . + // // Default: Any current or previous generation + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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]in the Amazon EC2 User Guide + // for Linux Instances. + // + // Default: included + // + // [Amazon EC2 instance store]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html 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 . + // // Default: Any local storage type LocalStorageTypes []LocalStorageType @@ -970,11 +1143,16 @@ type InstanceRequirements struct { // priced current generation instance types or, failing that, the lowest priced // previous generation instance types that match your attributes. When Amazon EC2 // Auto Scaling selects instance types with your attributes, we will exclude - // instance types whose price exceeds your specified threshold. The parameter - // accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. If - // you set DesiredCapacityType to vcpu or memory-mib , the price protection + // instance types whose price exceeds your specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a + // percentage. + // + // If you set DesiredCapacityType to vcpu or memory-mib , the price protection // threshold is based on the per-vCPU or per-memory price instead of the per - // instance price. Only one of SpotMaxPricePercentageOverLowestPrice or + // instance price. + // + // Only one of SpotMaxPricePercentageOverLowestPrice or // MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't // specify either, Amazon EC2 Auto Scaling will automatically apply optimal price // protection to consistently select from a wide range of instance types. To @@ -984,14 +1162,18 @@ type InstanceRequirements struct { MaxSpotPriceAsPercentageOfOptimalOnDemandPrice *int32 // The minimum and maximum amount of memory per vCPU for an instance type, in GiB. + // // Default: No minimum or maximum limits MemoryGiBPerVCpu *MemoryGiBPerVCpuRequest // The minimum and maximum amount of network bandwidth, in gigabits per second - // (Gbps). Default: No minimum or maximum limits + // (Gbps). + // + // Default: No minimum or maximum limits NetworkBandwidthGbps *NetworkBandwidthGbpsRequest // The minimum and maximum number of network interfaces for an instance type. + // // Default: No minimum or maximum limits NetworkInterfaceCount *NetworkInterfaceCountRequest @@ -1003,16 +1185,24 @@ type InstanceRequirements struct { // the lowest priced current generation instance types or, failing that, the lowest // priced previous generation instance types that match your attributes. When // Amazon EC2 Auto Scaling selects instance types with your attributes, we will - // exclude instance types whose price exceeds your specified 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 . + // exclude instance types whose price exceeds your specified 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 instead of the - // per instance price. Default: 20 + // per instance price. + // + // Default: 20 OnDemandMaxPricePercentageOverLowestPrice *int32 // Indicates whether instance types must provide On-Demand Instance hibernation - // support. Default: false + // support. + // + // Default: false RequireHibernateSupport *bool // [Price protection] The price protection threshold for Spot Instances, as a @@ -1023,11 +1213,16 @@ type InstanceRequirements struct { // priced current generation instance types or, failing that, the lowest priced // previous generation instance types that match your attributes. When Amazon EC2 // Auto Scaling selects instance types with your attributes, we will exclude - // instance types whose price exceeds your specified threshold. The parameter - // accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. If - // you set DesiredCapacityType to vcpu or memory-mib , the price protection + // instance types whose price exceeds your specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a + // percentage. + // + // If you set DesiredCapacityType to vcpu or memory-mib , the price protection // threshold is based on the per-vCPU or per-memory price instead of the per - // instance price. Only one of SpotMaxPricePercentageOverLowestPrice or + // instance price. + // + // Only one of SpotMaxPricePercentageOverLowestPrice or // MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't // specify either, Amazon EC2 Auto Scaling will automatically apply optimal price // protection to consistently select from a wide range of instance types. To @@ -1037,15 +1232,18 @@ type InstanceRequirements struct { SpotMaxPricePercentageOverLowestPrice *int32 // The minimum and maximum total local storage size for an instance type, in GB. + // // Default: No minimum or maximum limits TotalLocalStorageGB *TotalLocalStorageGBRequest noSmithyDocumentSerde } -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Describes an instance reuse policy for a warm pool. +// +// For more information, see [Warm pools for Amazon EC2 Auto Scaling] in the Amazon EC2 Auto Scaling User Guide. +// +// [Warm pools for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html type InstanceReusePolicy struct { // Specifies whether instances in the Auto Scaling group can be returned to the @@ -1062,63 +1260,83 @@ type InstancesDistribution struct { // The allocation strategy to apply to your On-Demand Instances when they are // launched. Possible instance types are determined by the launch template - // 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 . + // 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. + // // 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 // all your On-Demand capacity cannot be fulfilled using your highest priority // instance type, then Amazon EC2 Auto Scaling launches the remaining capacity // using the second priority instance type, and so on. This is the default value - // for Auto Scaling groups that don't specify InstanceRequirements and cannot be - // used for groups that do. + // for Auto Scaling groups that don't specify InstanceRequirementsand cannot be used for groups that + // do. OnDemandAllocationStrategy *string // The minimum amount of the Auto Scaling group's capacity that must be fulfilled // by On-Demand Instances. This base portion is launched first as your group - // scales. This number has the same unit of measurement as the group's desired - // capacity. If you change the default unit of measurement (number of instances) by + // scales. + // + // This number has the same unit of measurement as the group's desired capacity. + // If you change the default unit of measurement (number of instances) by // specifying weighted capacity values in your launch template overrides list, or // by changing the default desired capacity type setting of the group, you must - // specify this number using the same unit of measurement. Default: 0 + // specify this number using the same unit of measurement. + // + // Default: 0 OnDemandBaseCapacity *int32 // Controls the percentages of On-Demand Instances and Spot Instances for your // 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 + // 100, only On-Demand Instances are used. + // + // Default: 100 OnDemandPercentageAboveBaseCapacity *int32 // The allocation strategy to apply to your Spot Instances when they are launched. // Possible instance types are determined by the launch template overrides that you - // specify. The following lists the valid values: capacity-optimized Requests Spot - // 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 - // 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 . + // specify. + // + // The following lists the valid values: + // + // capacity-optimized Requests Spot 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 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. + // 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 - // must be in the range of 1–20. Default: 2 + // 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 @@ -1127,8 +1345,11 @@ type InstancesDistribution struct { // 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. + // 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 @@ -1144,15 +1365,17 @@ 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]in the Amazon EC2 User Guide for Linux Instances. + // + // [Find a Linux AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html // // 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) - // in the Amazon EC2 User Guide for Linux Instances. + // types, see [Available instance types]in the Amazon EC2 User Guide for Linux Instances. + // + // [Available instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes // // This member is required. InstanceType *string @@ -1167,15 +1390,18 @@ type LaunchConfiguration 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. 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. + // assign a public IPv4 address on the subnet. For more information, see [Launching Auto Scaling instances in a VPC]in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Launching Auto Scaling instances in a VPC]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html 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) - // in the Amazon EC2 User Guide for Linux Instances. + // mapping for the AMI are used. For more information, see [Block Device Mapping]in the Amazon EC2 User + // Guide for Linux Instances. + // + // [Block Device Mapping]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html BlockDeviceMappings []BlockDeviceMapping // Available for backward compatibility. @@ -1185,65 +1411,79 @@ type LaunchConfiguration struct { 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. + // not ( false ). For more information, see [Amazon EBS-Optimized Instances] in the Amazon EC2 User Guide for + // Linux Instances. + // + // [Amazon EBS-Optimized Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html 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. + // For more information, see [IAM role for applications that run on Amazon EC2 instances]in the Amazon EC2 Auto Scaling User Guide. + // + // [IAM role for applications that run on Amazon EC2 instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // basic ( false ) monitoring. + // + // For more information, see [Configure Monitoring for Auto Scaling Instances] in the Amazon EC2 Auto Scaling User Guide. + // + // [Configure Monitoring for Auto Scaling Instances]: https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html 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] in the Amazon EC2 User Guide for Linux Instances. + // + // [Amazon EC2 Key Pairs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // The metadata options for the instances. For more information, see [Configuring the Instance Metadata Options] in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Configuring the Instance Metadata Options]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds MetadataOptions *InstanceMetadataOptions // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // launched into a VPC. + // + // For more information, see [Configuring instance tenancy with Amazon EC2 Auto Scaling] in the Amazon EC2 Auto Scaling User Guide. + // + // [Configuring instance tenancy with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html PlacementTenancy *string // The ID of the RAM disk associated with the AMI. 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) - // in the Amazon Virtual Private Cloud User Guide. + // Scaling group. For more information, see [Security Groups for Your VPC]in the Amazon Virtual Private Cloud + // User Guide. + // + // [Security Groups for Your VPC]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html 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) - // in the Amazon EC2 Auto Scaling User Guide. + // current Spot price. For more information, see [Requesting Spot Instances]in the Amazon EC2 Auto Scaling + // User Guide. + // + // [Requesting Spot Instances]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html 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) - // (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. + // information, see [Instance metadata and user data](Linux) and [Instance metadata and user data] (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. + // + // [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html UserData *string noSmithyDocumentSerde @@ -1265,7 +1505,9 @@ type LaunchTemplate struct { // 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. // // Specify the instance types that you want, or define your instance requirements @@ -1273,39 +1515,47 @@ type LaunchTemplate struct { // 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. +// 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 // requirements to identify instance types. Then, it uses your On-Demand and Spot - // allocation strategies to launch instances from these instance types. You can - // specify up to four separate sets of instance requirements per Auto Scaling - // group. This is useful for provisioning instances from different Amazon Machine - // 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 . + // allocation strategies to launch instances from these instance types. + // + // You can specify up to four separate sets of instance requirements per Auto + // Scaling group. This is useful for provisioning instances from different Amazon + // Machine 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 *InstanceRequirements // 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]in the Amazon Elastic Compute Cloud User Guide. + // + // You can specify up to 40 instance types per Auto Scaling group. + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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) - // 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. + // information, see [Specifying a different launch template for an instance type]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. + // + // [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 LaunchTemplateSpecification *LaunchTemplateSpecification // If you provide a list of instance types to use, you can specify the number of @@ -1317,15 +1567,19 @@ 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) - // in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999. + // information, see [Configuring instance weighting for Amazon EC2 Auto Scaling]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 - // 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. + // 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 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. + // + // [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 WeightedCapacity *string noSmithyDocumentSerde @@ -1333,34 +1587,39 @@ type LaunchTemplateOverrides 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. +// information about launch templates, see [Launch templates]in the Amazon EC2 Auto Scaling User +// Guide. +// +// [Launch templates]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html 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) - // API operation. New launch templates can be created using the Amazon EC2 - // CreateLaunchTemplate (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) - // API. Conditional: You must specify either a LaunchTemplateId or a - // LaunchTemplateName . + // The ID of the launch template. To get the template ID, use the Amazon EC2 [DescribeLaunchTemplates] API + // operation. New launch templates can be created using the Amazon EC2 [CreateLaunchTemplate]API. + // + // Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName . + // + // [CreateLaunchTemplate]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html + // [DescribeLaunchTemplates]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html 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) - // API operation. New launch templates can be created using the Amazon EC2 - // CreateLaunchTemplate (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html) - // API. Conditional: You must specify either a LaunchTemplateId or a - // LaunchTemplateName . + // The name of the launch template. To get the template name, use the Amazon EC2 [DescribeLaunchTemplates] + // API operation. New launch templates can be created using the Amazon EC2 [CreateLaunchTemplate]API. + // + // Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName . + // + // [CreateLaunchTemplate]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html + // [DescribeLaunchTemplates]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html 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) - // 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 + // Amazon EC2 [DescribeLaunchTemplateVersions]API operation. New launch template versions can be created using the + // Amazon EC2 [CreateLaunchTemplateVersion]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 + // [DescribeLaunchTemplateVersions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html Version *string noSmithyDocumentSerde @@ -1375,7 +1634,9 @@ type LifecycleHook struct { AutoScalingGroupName *string // The action the Auto Scaling group takes when the lifecycle hook timeout elapses - // or if an unexpected failure occurs. Valid values: CONTINUE | ABANDON + // or if an unexpected failure occurs. + // + // Valid values: CONTINUE | ABANDON DefaultResult *string // The maximum time, in seconds, that an instance can remain in a wait state. The @@ -1391,7 +1652,9 @@ type LifecycleHook struct { // The name of the lifecycle hook. LifecycleHookName *string - // The lifecycle transition. Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | + // The lifecycle transition. + // + // Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | // autoscaling:EC2_INSTANCE_TERMINATING LifecycleTransition *string @@ -1411,8 +1674,11 @@ 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] in the Amazon EC2 Auto Scaling User Guide. +// +// [Amazon EC2 Auto Scaling lifecycle hooks]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html type LifecycleHookSpecification struct { // The name of the lifecycle hook. @@ -1422,8 +1688,10 @@ type LifecycleHookSpecification struct { // 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 . // @@ -1431,8 +1699,9 @@ type LifecycleHookSpecification struct { 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: - // CONTINUE | ABANDON + // or if an unexpected failure occurs. The default value is ABANDON . + // + // Valid values: CONTINUE | ABANDON DefaultResult *string // The maximum time, in seconds, that can elapse before the lifecycle hook times @@ -1450,10 +1719,13 @@ type LifecycleHookSpecification struct { NotificationTargetARN *string // 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) - // in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target - // is an Amazon SNS topic or an Amazon SQS queue. + // specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook]in + // the Amazon EC2 Auto Scaling User Guide. + // + // Valid only if the notification target is an Amazon SNS topic or an Amazon SQS + // queue. + // + // [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 RoleARN *string noSmithyDocumentSerde @@ -1466,15 +1738,19 @@ 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. + // + // - Removed - All Auto Scaling instances are deregistered from the load balancer. State *string noSmithyDocumentSerde @@ -1487,13 +1763,18 @@ 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. State *string @@ -1524,7 +1805,7 @@ type LoadForecast struct { } // Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you -// specify InstanceRequirements for an Auto Scaling group. +// specify InstanceRequirementsfor an Auto Scaling group. type MemoryGiBPerVCpuRequest struct { // The memory maximum in GiB. @@ -1536,8 +1817,8 @@ type MemoryGiBPerVCpuRequest struct { noSmithyDocumentSerde } -// Specifies the minimum and maximum for the MemoryMiB object when you specify -// InstanceRequirements for an Auto Scaling group. +// Specifies the minimum and maximum for the MemoryMiB object when you specify InstanceRequirements +// for an Auto Scaling group. type MemoryMiBRequest struct { // The memory minimum in MiB. @@ -1559,18 +1840,22 @@ type Metric struct { // This member is required. 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) - // in the Amazon CloudWatch User Guide. + // The namespace of the metric. For more information, see the table in [Amazon Web Services services that publish CloudWatch metrics] in the + // Amazon CloudWatch User Guide. + // + // [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html // // This member is required. Namespace *string // 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) - // in the Amazon CloudWatch User Guide. Conditional: If you published your metric - // with dimensions, you must specify the same dimensions in your scaling policy. + // Amazon Web Services documentation available from the table in [Amazon Web Services services that publish CloudWatch metrics]in the Amazon + // CloudWatch User Guide. + // + // Conditional: If you published your metric with dimensions, you must specify the + // same dimensions in your scaling policy. + // + // [Amazon Web Services services that publish CloudWatch metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html Dimensions []MetricDimension noSmithyDocumentSerde @@ -1580,25 +1865,45 @@ 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 Metric *string @@ -1608,10 +1913,12 @@ type MetricCollectionType struct { // The metric data to return. Also defines whether this call is returning data for // one metric only, or whether it is performing a math expression on the values of // 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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] in the Amazon EC2 Auto Scaling User +// Guide. +// +// [Advanced predictive scaling policy configurations using custom metrics]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html type MetricDataQuery struct { // A short name that identifies the object's results in the response. This name @@ -1627,26 +1934,31 @@ type MetricDataQuery struct { // The math expression to perform on the returned data, if this object is // 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. + // to use the result of those expressions. + // + // Conditional: Within each MetricDataQuery 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 // if this is a math expression, so that you know what the value represents. Label *string - // Information about the metric data to return. Conditional: Within each - // MetricDataQuery object, you must specify either Expression or MetricStat , but - // not both. + // Information about the metric data to return. + // + // Conditional: Within each MetricDataQuery object, you must specify either + // Expression or MetricStat , but not both. MetricStat *MetricStat // Indicates whether to return the timestamps and raw data values of this metric. + // // If you use any math expressions, specify true for this value for only the final // 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 ). + // 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 ). ReturnData *bool noSmithyDocumentSerde @@ -1678,42 +1990,53 @@ type MetricGranularityType struct { } // 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. +// statistic and unit. +// +// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts] in the Amazon +// CloudWatch User Guide. +// +// [Amazon CloudWatch concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html 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]object that is returned by a call to [ListMetrics]. + // + // [ListMetrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html + // [Metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.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) - // in the Amazon CloudWatch User Guide. The most commonly used metrics for - // predictive scaling are Average and Sum . + // statistic. For a list of valid values, see the table in [Statistics]in the Amazon + // CloudWatch User Guide. + // + // The most commonly used metrics for predictive scaling are Average and Sum . + // + // [Statistics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic // // 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) - // data type in the Amazon CloudWatch API Reference. + // that CloudWatch supports, see the [MetricDatum]data type in the Amazon CloudWatch API + // Reference. + // + // [MetricDatum]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html 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 -// 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 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] // in the Amazon EC2 Auto Scaling User Guide. +// +// [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 type MixedInstancesPolicy struct { // The instances distribution. @@ -1727,13 +2050,15 @@ type MixedInstancesPolicy struct { } // Specifies the minimum and maximum for the NetworkBandwidthGbps object when you -// specify InstanceRequirements for an Auto Scaling group. Setting the minimum -// bandwidth does not guarantee that your instance will 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) -// in the Amazon EC2 User Guide for Linux Instances. +// specify InstanceRequirementsfor an Auto Scaling group. +// +// Setting the minimum bandwidth does not guarantee that your instance will +// 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]in the Amazon EC2 User Guide for Linux Instances. +// +// [Available instance bandwidth]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth type NetworkBandwidthGbpsRequest struct { // The maximum amount of network bandwidth, in gigabits per second (Gbps). @@ -1746,7 +2071,7 @@ type NetworkBandwidthGbpsRequest struct { } // Specifies the minimum and maximum for the NetworkInterfaceCount object when you -// specify InstanceRequirements for an Auto Scaling group. +// specify InstanceRequirementsfor an Auto Scaling group. type NetworkInterfaceCountRequest struct { // The maximum number of network interfaces. @@ -1765,10 +2090,15 @@ 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 NotificationType *string @@ -1783,12 +2113,15 @@ type NotificationConfiguration struct { type PredefinedMetricSpecification struct { // The metric type. The following predefined metrics are available: - // - ASGAverageCPUUtilization - Average CPU utilization of the 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. // @@ -1798,18 +2131,25 @@ type PredefinedMetricSpecification struct { // A label that uniquely identifies a specific Application Load Balancer target // group from which to determine the average request count served by your Auto // Scaling group. You can't specify a resource label unless the target group is - // 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 of - // the resource label is: + // 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 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ResourceLabel *string noSmithyDocumentSerde @@ -1820,18 +2160,24 @@ type PredefinedMetricSpecification struct { 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. + // 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 // 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 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 @@ -1842,10 +2188,13 @@ type PredictiveScalingConfiguration struct { // 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. + // 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. @@ -1857,9 +2206,10 @@ type PredictiveScalingConfiguration struct { // launched at 9:55 AM. The intention is to give resources time to be provisioned. // It can take a few minutes to launch an EC2 instance. The actual amount of time // required depends on several factors, such as the size of the instance and - // whether there are startup scripts to complete. The value must be less than the - // forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds - // if not specified. + // whether there are startup scripts to complete. + // + // The value must be less than the forecast interval duration of 3600 seconds (60 + // minutes). Defaults to 300 seconds if not specified. SchedulingBufferTime *int32 noSmithyDocumentSerde @@ -1905,43 +2255,54 @@ type PredictiveScalingCustomizedScalingMetric struct { } // This structure specifies the metrics and target utilization settings for a -// predictive scaling policy. You must specify either a metric pair, or a load -// metric and a scaling metric individually. Specifying a metric pair instead of -// individual metrics provides a simpler way to configure metrics for a scaling -// 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 +// predictive scaling policy. +// +// You must specify either a metric pair, or a load metric and a scaling metric +// individually. Specifying a metric pair instead of individual metrics provides a +// simpler way to configure metrics for a scaling 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. // -// 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. +// For information about using custom metrics with predictive scaling, see [Advanced predictive scaling policy configurations using custom metrics] in the +// Amazon EC2 Auto Scaling User Guide. +// +// [Advanced predictive scaling policy configurations using custom metrics]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html 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 - // 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. + // 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. // // This member is required. TargetValue *float64 @@ -1968,9 +2329,11 @@ type PredictiveScalingMetricSpecification struct { noSmithyDocumentSerde } -// Describes a load 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 load 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 PredictiveScalingPredefinedLoadMetric struct { // The metric type. @@ -1981,18 +2344,25 @@ type PredictiveScalingPredefinedLoadMetric struct { // A label that uniquely identifies a specific Application Load Balancer target // group from which to determine the request count served by your Auto Scaling // group. You can't specify a resource label unless the target group is 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 of the - // resource label is: + // 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 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ResourceLabel *string noSmithyDocumentSerde @@ -2013,26 +2383,35 @@ type PredictiveScalingPredefinedMetricPair struct { // A label that uniquely identifies a specific Application Load Balancer target // group from which to determine the total and average request count served by your // Auto Scaling group. You can't specify a resource label unless the target group - // is 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 of the resource label is: + // is 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 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html 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. @@ -2043,36 +2422,55 @@ type PredictiveScalingPredefinedScalingMetric struct { // A label that uniquely identifies a specific Application Load Balancer target // group from which to determine the average request count served by your Auto // Scaling group. You can't specify a resource label unless the target group is - // 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 of - // the resource label is: + // 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 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Describes a process type. +// +// For more information, see [Scaling processes] in the Amazon EC2 Auto Scaling User Guide. +// +// [Scaling processes]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types type ProcessType struct { // One of the following processes: + // // - Launch + // // - Terminate + // // - AddToLoadBalancer + // // - AlarmNotification + // // - AZRebalance + // // - HealthCheck + // // - InstanceRefresh + // // - ReplaceUnhealthy + // // - ScheduledActions // // This member is required. @@ -2090,16 +2488,22 @@ type RefreshPreferences struct { // (Optional) Indicates whether to roll back the Auto Scaling group to its // previous configuration if the instance refresh fails or a CloudWatch alarm - // threshold is met. The default is false . A rollback is not supported in the - // following situations: + // threshold is met. 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. - // For more information, see Undo changes with a rollback (https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-refresh-rollback.html) - // in the Amazon EC2 Auto Scaling User Guide. + // + // For more information, see [Undo changes with a rollback] in the Amazon EC2 Auto Scaling User Guide. + // + // [Undo changes with a rollback]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-refresh-rollback.html AutoRollback *bool // (Optional) The amount of time, in seconds, to wait after a checkpoint before @@ -2111,48 +2515,64 @@ type RefreshPreferences struct { // (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) - // in the Amazon EC2 Auto Scaling User Guide. + // number in the array must be 100 . + // + // For usage examples, see [Adding checkpoints to an instance refresh] in the Amazon EC2 Auto Scaling User Guide. + // + // [Adding checkpoints to an instance refresh]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html 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 + // 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, if defined (which is recommended in all cases), - // or the HealthCheckGracePeriod property otherwise. + // 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 // Specifies the maximum percentage of the group that can be in service and // healthy, or pending, to support your workload when replacing instances. The // value is expressed as a percentage of the desired capacity of the Auto Scaling - // group. Value range is 100 to 200. If you specify MaxHealthyPercentage , you must - // also specify MinHealthyPercentage , and the difference between them cannot be - // greater than 100. A larger range increases the number of instances that can be - // replaced at the same time. If you do not specify this property, the default is - // 100 percent, or the percentage set in the instance maintenance policy for the - // Auto Scaling group, if defined. + // group. Value range is 100 to 200. + // + // If you specify MaxHealthyPercentage , you must also specify MinHealthyPercentage + // , and the difference between them cannot be greater than 100. A larger range + // increases the number of instances that can be replaced at the same time. + // + // If you do not specify this property, the default is 100 percent, or the + // percentage set in the instance maintenance policy for the Auto Scaling group, if + // defined. MaxHealthyPercentage *int32 // Specifies the minimum percentage of the group to keep in service, healthy, and // ready to use to support your workload to allow the operation to continue. The // value is expressed as a percentage of the desired capacity of the Auto Scaling - // group. Value range is 0 to 100. If you do not specify this property, the default - // is 90 percent, or the percentage set in the instance maintenance policy for the - // Auto Scaling group, if defined. + // group. Value range is 0 to 100. + // + // If you do not specify this property, the default is 90 percent, or the + // percentage set in the instance maintenance policy for the Auto Scaling group, if + // defined. MinHealthyPercentage *int32 // Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances - // protected from scale in are found. The following lists the valid values: Refresh - // Amazon EC2 Auto Scaling replaces instances that are protected from scale in. + // protected from scale in are found. + // + // The following lists the valid values: + // + // Refresh Amazon EC2 Auto Scaling replaces instances that are protected from + // scale in. + // // Ignore Amazon EC2 Auto Scaling ignores instances that are protected from scale - // in and continues to replace instances that are not protected. Wait (default) - // Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. - // Otherwise, the instance refresh will fail. + // in and continues to replace instances that are not protected. + // + // Wait (default) Amazon EC2 Auto Scaling waits one hour for you to remove + // scale-in protection. Otherwise, the instance refresh will fail. ScaleInProtectedInstances ScaleInProtectedInstances // (Optional) Indicates whether skip matching is enabled. If enabled ( true ), then @@ -2160,17 +2580,25 @@ type RefreshPreferences struct { // 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) - // in the Amazon EC2 Auto Scaling User Guide. + // false . + // + // For more information, see [Use an instance refresh with skip matching] in the Amazon EC2 Auto Scaling User Guide. + // + // [Use an instance refresh with skip matching]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh-skip-matching.html 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 - // 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. + // 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. StandbyInstances StandbyInstances noSmithyDocumentSerde @@ -2244,13 +2672,19 @@ 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) - // in the Amazon EC2 Auto Scaling User Guide. + // + // For more information, see [Target tracking scaling policies] and [Step and simple scaling policies] in the Amazon EC2 Auto Scaling User Guide. + // + // [Step and simple scaling policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html + // [Target tracking scaling policies]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html PolicyType *string // A predictive scaling policy. @@ -2291,9 +2725,10 @@ type ScheduledUpdateGroupAction struct { // The minimum size of the Auto Scaling group. 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. + // 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. Recurrence *string // The Amazon Resource Name (ARN) of the scheduled action. @@ -2316,7 +2751,7 @@ type ScheduledUpdateGroupAction struct { } // Describes information used for one or more scheduled scaling action updates in -// a BatchPutScheduledUpdateGroupAction operation. +// a BatchPutScheduledUpdateGroupActionoperation. type ScheduledUpdateGroupActionRequest struct { // The name of the scaling action. @@ -2340,51 +2775,69 @@ 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]. + // + // 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. + // + // [Crontab]: http://crontab.org 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) - // . + // 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]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones TimeZone *string noSmithyDocumentSerde } // 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 +// 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. // // 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. // -// 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. +// For more information, see [Step adjustments] in the Amazon EC2 Auto Scaling User Guide. +// +// [Step adjustments]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps type StepAdjustment struct { // The amount by which to scale, based on the specified adjustment type. A @@ -2406,16 +2859,19 @@ type StepAdjustment struct { // CloudWatch metric. If the metric value is above the breach threshold, the upper // bound is exclusive (the metric must be less than the threshold plus the upper // bound). Otherwise, it is inclusive (the metric must be less than or equal to the - // threshold plus the upper bound). A null value indicates positive infinity. The - // upper bound must be greater than the lower bound. + // threshold plus the upper bound). A null value indicates positive infinity. + // + // The upper bound must be greater than the lower bound. MetricIntervalUpperBound *float64 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) -// in the Amazon EC2 Auto Scaling User Guide. +// Describes an auto scaling process that has been suspended. +// +// For more information, see [Scaling processes] in the Amazon EC2 Auto Scaling User Guide. +// +// [Scaling processes]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types type SuspendedProcess struct { // The name of the suspended process. @@ -2477,11 +2933,13 @@ type TagDescription struct { // EC2 Auto Scaling. type TargetTrackingConfiguration struct { - // The target value for the metric. 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. + // The target value for the metric. + // + // 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. // // This member is required. TargetValue *float64 @@ -2522,36 +2980,43 @@ type TargetTrackingMetricDataQuery struct { // The math expression to perform on the returned data, if this object is // 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 - // TargetTrackingMetricDataQuery object, you must specify either Expression or - // MetricStat , but not both. + // to use the result of those expressions. + // + // Conditional: Within each TargetTrackingMetricDataQuery 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 // if this is a math expression, so that you know what the value represents. Label *string - // Information about the metric data to return. Conditional: Within each - // TargetTrackingMetricDataQuery object, you must specify either Expression or - // MetricStat , but not both. + // Information about the metric data to return. + // + // Conditional: Within each TargetTrackingMetricDataQuery object, you must specify + // either Expression or MetricStat , but not both. MetricStat *TargetTrackingMetricStat // Indicates whether to return the timestamps and raw data values of this metric. + // // If you use any math expressions, specify true for this value for only the final // 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 ). + // 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 ). 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) -// in the Amazon CloudWatch User Guide. +// statistic and unit. +// +// For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts] in the Amazon +// CloudWatch User Guide. +// +// [Amazon CloudWatch concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html type TargetTrackingMetricStat struct { // The metric to use. @@ -2560,23 +3025,28 @@ 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) - // in the Amazon CloudWatch User Guide. The most commonly used metric for scaling - // is Average . + // statistic. For a list of valid values, see the table in [Statistics]in the Amazon + // CloudWatch User Guide. + // + // The most commonly used metric for scaling is Average . + // + // [Statistics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic // // 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) - // data type in the Amazon CloudWatch API Reference. + // that CloudWatch supports, see the [MetricDatum]data type in the Amazon CloudWatch API + // Reference. + // + // [MetricDatum]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html Unit *string noSmithyDocumentSerde } // Specifies the minimum and maximum for the TotalLocalStorageGB object when you -// specify InstanceRequirements for an Auto Scaling group. +// specify InstanceRequirementsfor an Auto Scaling group. type TotalLocalStorageGBRequest struct { // The storage maximum in GB. @@ -2591,33 +3061,48 @@ type TotalLocalStorageGBRequest struct { // Identifying information for a traffic source. type TrafficSourceIdentifier struct { - // Identifies the traffic source. For Application Load Balancers, Gateway Load - // Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon - // 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: + // Identifies the traffic source. + // + // For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, + // and VPC Lattice, this will be the Amazon 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 // 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) - // 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) - // API operation. + // the Elastic Load Balancing [DescribeTargetGroups]and [DescribeLoadBalancers] API operations. + // + // To get the ARN of a target group for VPC Lattice, use the VPC Lattice [GetTargetGroup] API + // operation. + // + // [GetTargetGroup]: https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html // // This member is required. Identifier *string - // Provides additional context for the value of Identifier . The following lists - // the valid values: + // 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 @@ -2630,19 +3115,25 @@ type TrafficSourceState struct { // The unique identifier of the traffic source. Identifier *string - // Describes the current state of a traffic source. The state values are as - // follows: + // 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. State *string @@ -2652,20 +3143,25 @@ type TrafficSourceState struct { // Deprecated: TrafficSource has been replaced by Identifier TrafficSource *string - // Provides additional context for the value of Identifier . The following lists - // the valid values: + // 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 } -// Specifies the minimum and maximum for the VCpuCount object when you specify -// InstanceRequirements for an Auto Scaling group. +// Specifies the minimum and maximum for the VCpuCount object when you specify InstanceRequirements +// for an Auto Scaling group. type VCpuCountRequest struct { // The minimum number of vCPUs. diff --git a/service/autoscalingplans/api_op_CreateScalingPlan.go b/service/autoscalingplans/api_op_CreateScalingPlan.go index 25573637949..719bc0ba118 100644 --- a/service/autoscalingplans/api_op_CreateScalingPlan.go +++ b/service/autoscalingplans/api_op_CreateScalingPlan.go @@ -30,14 +30,20 @@ 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) - // in the AWS Auto Scaling API Reference. + // application source. + // + // For more information, see [ApplicationSource] in the AWS Auto Scaling API Reference. + // + // [ApplicationSource]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html // // 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) - // in the AWS Auto Scaling API Reference. + // The scaling instructions. + // + // For more information, see [ScalingInstruction] in the AWS Auto Scaling API Reference. + // + // [ScalingInstruction]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html // // This member is required. ScalingInstructions []types.ScalingInstruction diff --git a/service/autoscalingplans/api_op_DeleteScalingPlan.go b/service/autoscalingplans/api_op_DeleteScalingPlan.go index 67c9c7f609e..7d90622e4aa 100644 --- a/service/autoscalingplans/api_op_DeleteScalingPlan.go +++ b/service/autoscalingplans/api_op_DeleteScalingPlan.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) DeleteScalingPlan(ctx context.Context, params *DeleteScalingPlanInput, optFns ...func(*Options)) (*DeleteScalingPlanOutput, error) { if params == nil { params = &DeleteScalingPlanInput{} diff --git a/service/autoscalingplans/api_op_DescribeScalingPlans.go b/service/autoscalingplans/api_op_DescribeScalingPlans.go index 894bbbafcc7..f6ec92024a9 100644 --- a/service/autoscalingplans/api_op_DescribeScalingPlans.go +++ b/service/autoscalingplans/api_op_DescribeScalingPlans.go @@ -45,6 +45,7 @@ type DescribeScalingPlansInput struct { 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. ScalingPlanVersion *int64 diff --git a/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go b/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go index 881d282512b..51fec896611 100644 --- a/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go +++ b/service/autoscalingplans/api_op_GetScalingPlanResourceForecastData.go @@ -12,10 +12,11 @@ import ( "time" ) -// Retrieves the forecast data for a scalable resource. Capacity forecasts are -// represented as predicted values, or data points, that are calculated using -// historical data points from a specified CloudWatch load metric. Data points are -// available for up to 56 days. +// Retrieves the forecast data for a scalable resource. +// +// Capacity forecasts are represented as predicted values, or data points, that +// are calculated using historical data points from a specified CloudWatch load +// metric. Data points are available for up to 56 days. func (c *Client) GetScalingPlanResourceForecastData(ctx context.Context, params *GetScalingPlanResourceForecastDataInput, optFns ...func(*Options)) (*GetScalingPlanResourceForecastDataOutput, error) { if params == nil { params = &GetScalingPlanResourceForecastDataInput{} @@ -34,20 +35,25 @@ func (c *Client) GetScalingPlanResourceForecastData(ctx context.Context, params type GetScalingPlanResourceForecastDataInput struct { // The exclusive end time of the time range for the forecast data to get. The - // maximum time duration between the start and end time is seven days. Although - // this parameter can accept a date and time that is more than two days in the - // future, the availability of forecast data has limits. AWS Auto Scaling only - // issues forecasts for periods of two days in advance. + // maximum time duration between the start and end time is seven days. + // + // Although this parameter can accept a date and time that is more than two days + // in the future, the availability of forecast data has limits. AWS Auto Scaling + // only issues forecasts for periods of two days in advance. // // This member is required. 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. diff --git a/service/autoscalingplans/api_op_UpdateScalingPlan.go b/service/autoscalingplans/api_op_UpdateScalingPlan.go index cdb8b3e3958..623c3d56021 100644 --- a/service/autoscalingplans/api_op_UpdateScalingPlan.go +++ b/service/autoscalingplans/api_op_UpdateScalingPlan.go @@ -11,8 +11,10 @@ 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{} @@ -41,13 +43,18 @@ type UpdateScalingPlanInput struct { // 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) - // in the AWS Auto Scaling API Reference. + // A CloudFormation stack or set of tags. + // + // For more information, see [ApplicationSource] in the AWS Auto Scaling API Reference. + // + // [ApplicationSource]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html ApplicationSource *types.ApplicationSource - // 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. + // The scaling instructions. + // + // For more information, see [ScalingInstruction] in the AWS Auto Scaling API Reference. + // + // [ScalingInstruction]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html ScalingInstructions []types.ScalingInstruction noSmithyDocumentSerde diff --git a/service/autoscalingplans/doc.go b/service/autoscalingplans/doc.go index d95b09f3d4e..0b17180d0b9 100644 --- a/service/autoscalingplans/doc.go +++ b/service/autoscalingplans/doc.go @@ -3,21 +3,32 @@ // Package autoscalingplans provides the API client, operations, and parameter // types for AWS Auto Scaling Plans. // -// 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: +// # 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) -// . +// users required permissions for AWS Auto Scaling actions, see the [AWS Auto Scaling User Guide]. +// +// [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/options.go b/service/autoscalingplans/options.go index 05f31b55b77..c9de53d20b9 100644 --- a/service/autoscalingplans/options.go +++ b/service/autoscalingplans/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/autoscalingplans/types/enums.go b/service/autoscalingplans/types/enums.go index a9db0ac6e48..e94c042c0ef 100644 --- a/service/autoscalingplans/types/enums.go +++ b/service/autoscalingplans/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for ForecastDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ForecastDataType) Values() []ForecastDataType { return []ForecastDataType{ "CapacityForecast", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for LoadMetricType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadMetricType) Values() []LoadMetricType { return []LoadMetricType{ "ASGTotalCPUUtilization", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for MetricStatistic. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricStatistic) Values() []MetricStatistic { return []MetricStatistic{ "Average", @@ -78,8 +81,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "TargetTrackingScaling", @@ -97,8 +101,9 @@ const ( // Values returns all known values for PredictiveScalingMaxCapacityBehavior. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PredictiveScalingMaxCapacityBehavior) Values() []PredictiveScalingMaxCapacityBehavior { return []PredictiveScalingMaxCapacityBehavior{ "SetForecastCapacityToMaxCapacity", @@ -116,8 +121,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ForecastAndScale", @@ -140,8 +146,9 @@ const ( ) // Values returns all known values for ScalableDimension. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalableDimension) Values() []ScalableDimension { return []ScalableDimension{ "autoscaling:autoScalingGroup:DesiredCapacity", @@ -175,8 +182,9 @@ const ( ) // Values returns all known values for ScalingMetricType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingMetricType) Values() []ScalingMetricType { return []ScalingMetricType{ "ASGAverageCPUUtilization", @@ -210,8 +218,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Active", @@ -235,6 +244,7 @@ const ( // Values returns all known values for ScalingPolicyUpdateBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScalingPolicyUpdateBehavior) Values() []ScalingPolicyUpdateBehavior { return []ScalingPolicyUpdateBehavior{ @@ -253,8 +263,9 @@ const ( ) // Values returns all known values for ScalingStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingStatusCode) Values() []ScalingStatusCode { return []ScalingStatusCode{ "Inactive", @@ -275,8 +286,9 @@ const ( ) // Values returns all known values for ServiceNamespace. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNamespace) Values() []ServiceNamespace { return []ServiceNamespace{ "autoscaling", diff --git a/service/autoscalingplans/types/types.go b/service/autoscalingplans/types/types.go index 714bc689320..fbf0ead5143 100644 --- a/service/autoscalingplans/types/types.go +++ b/service/autoscalingplans/types/types.go @@ -20,27 +20,37 @@ type ApplicationSource struct { } // Represents a CloudWatch metric of your choosing that can be used for predictive -// scaling. For predictive scaling to work with a customized load metric -// specification, AWS Auto Scaling needs access to the Sum and Average statistics -// that CloudWatch computes from metric data. When you choose a load metric, make -// sure that the required Sum and Average statistics for your metric are available -// in CloudWatch and that they provide relevant data for predictive scaling. The -// Sum statistic must represent the total load on the resource, and the Average -// 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) -// 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) -// in the AWS Auto Scaling User Guide. +// scaling. +// +// For predictive scaling to work with a customized load metric specification, AWS +// Auto Scaling needs access to the Sum and Average statistics that CloudWatch +// computes from metric data. +// +// When you choose a load metric, make sure that the required Sum and Average +// statistics for your metric are available in CloudWatch and that they provide +// relevant data for predictive scaling. The Sum statistic must represent the +// total load on the resource, and the Average 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]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]in the +// AWS Auto Scaling User Guide. +// +// [View Scaling Information for a Resource]: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource +// [Amazon CloudWatch Concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html type CustomizedLoadMetricSpecification struct { // The name of the metric. @@ -58,9 +68,10 @@ type CustomizedLoadMetricSpecification struct { // This member is required. Statistic MetricStatistic - // The dimensions of the metric. Conditional: If you published your metric with - // dimensions, you must specify the same dimensions in your customized load metric - // specification. + // The dimensions of the metric. + // + // Conditional: If you published your metric with dimensions, you must specify the + // same dimensions in your customized load metric specification. Dimensions []MetricDimension // The unit of the metric. @@ -70,21 +81,25 @@ 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: +// 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. +// must first publish the metric to CloudWatch. For more information, see [Publish Custom Metrics]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) -// in the Amazon CloudWatch User Guide. +// metrics, see [Amazon CloudWatch Concepts]in the Amazon CloudWatch User Guide. +// +// [Amazon CloudWatch Concepts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html +// [Publish Custom Metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html type CustomizedScalingMetricSpecification struct { // The name of the metric. @@ -102,9 +117,10 @@ type CustomizedScalingMetricSpecification struct { // This member is required. Statistic MetricStatistic - // The dimensions of the metric. Conditional: If you published your metric with - // dimensions, you must specify the same dimensions in your customized scaling - // metric specification. + // The dimensions of the metric. + // + // Conditional: If you published your metric with dimensions, you must specify the + // same dimensions in your customized scaling metric specification. Dimensions []MetricDimension // The unit of the metric. @@ -141,11 +157,13 @@ type MetricDimension struct { noSmithyDocumentSerde } -// 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) -// in the AWS Auto Scaling User Guide. +// 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]in the +// AWS Auto Scaling User Guide. +// +// [View Scaling Information for a Resource]: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource type PredefinedLoadMetricSpecification struct { // The metric type. @@ -156,17 +174,24 @@ type PredefinedLoadMetricSpecification struct { // 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 - // group. You create the resource label by appending the final portion of the load + // 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. + // // 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ResourceLabel *string noSmithyDocumentSerde @@ -185,40 +210,52 @@ type PredefinedScalingMetricSpecification struct { // 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 - // 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: + // 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. + // // 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) - // API operation. To find the ARN for the target group, use the - // DescribeTargetGroups (https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) - // API operation. + // + // To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers] API operation. To + // find the ARN for the target group, use the [DescribeTargetGroups]API operation. + // + // [DescribeTargetGroups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html ResourceLabel *string noSmithyDocumentSerde } // Describes a scaling instruction for a scalable resource in a scaling plan. Each -// scaling instruction applies to one resource. AWS Auto Scaling creates target -// tracking scaling policies based on the scaling instructions. Target tracking -// scaling policies adjust the capacity of your scalable resource as required to -// maintain resource utilization at the target value that you specified. AWS Auto -// Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling -// groups using a subset of parameters, including the load metric, the scaling -// metric, the target value for the scaling metric, the predictive scaling mode -// (forecast and scale or forecast only), and the desired behavior when the +// scaling instruction applies to one resource. +// +// AWS Auto Scaling creates target tracking scaling policies based on the scaling +// instructions. Target tracking scaling policies adjust the capacity of your +// scalable resource as required to maintain resource utilization at the target +// value that you specified. +// +// AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto +// Scaling groups using a subset of parameters, including the load metric, the +// scaling metric, the target value for the scaling metric, the predictive scaling +// mode (forecast and scale or forecast only), and the desired behavior when the // forecast capacity exceeds the maximum capacity of the resource. With predictive // scaling, AWS Auto Scaling generates forecasts with traffic predictions for the // two days ahead and schedules scaling actions that proactively add and remove -// 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) -// in the AWS Auto Scaling User Guide. +// 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]in the AWS +// Auto Scaling User Guide. +// +// [Best Practices for AWS Auto Scaling]: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html type ScalingInstruction struct { // The maximum capacity of the resource. The exception to this upper limit is if @@ -234,18 +271,24 @@ 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 . // @@ -253,19 +296,27 @@ type ScalingInstruction struct { 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. @@ -291,8 +342,9 @@ 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 @@ -302,17 +354,23 @@ 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 . + // + // 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 @@ -320,11 +378,13 @@ type ScalingInstruction struct { // 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 + // 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. + // SetMaxCapacityAboveForecastCapacity , and cannot be used otherwise. + // + // The range is 1-100. PredictiveScalingMaxCapacityBuffer *int32 // The predictive scaling mode. The default value is ForecastAndScale . Otherwise, @@ -333,13 +393,17 @@ type ScalingInstruction struct { 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 + // 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 - // to be replaced, AWS Auto Scaling keeps all existing policies and does not create - // new ones. + // 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 to be replaced, AWS Auto Scaling + // keeps all existing policies and does not create new ones. ScalingPolicyUpdateBehavior ScalingPolicyUpdateBehavior // The amount of time, in seconds, to buffer the run time of scheduled scaling @@ -349,9 +413,12 @@ type ScalingInstruction struct { // resources time to be provisioned. For example, it can take a few minutes to // launch an EC2 instance. The actual amount of time required depends on several // factors, such as the size of the instance and whether there are startup scripts - // to complete. The value must be less than the forecast interval duration of 3600 - // seconds (60 minutes). The default is 300 seconds. Only valid when configuring - // predictive scaling. + // to complete. + // + // The value must be less than the forecast interval duration of 3600 seconds (60 + // minutes). The default is 300 seconds. + // + // Only valid when configuring predictive scaling. ScheduledActionBufferTime *int32 noSmithyDocumentSerde @@ -382,14 +449,22 @@ 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. // // This member is required. @@ -412,18 +487,24 @@ 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 . // @@ -431,19 +512,27 @@ type ScalingPlanResource struct { 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. @@ -462,10 +551,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. @@ -520,7 +612,7 @@ type TagFilter struct { } // Describes a target tracking configuration to use with AWS Auto Scaling. Used -// with ScalingInstruction and ScalingPolicy . +// with ScalingInstructionand ScalingPolicy. type TargetTrackingConfiguration struct { // The target value for the metric. Although this property accepts numbers of type @@ -538,7 +630,9 @@ type TargetTrackingConfiguration struct { // 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 . + // scalable resource. + // + // The default value is false . DisableScaleIn *bool // The estimated time, in seconds, until a newly launched instance can contribute @@ -552,21 +646,25 @@ type TargetTrackingConfiguration struct { // The amount of time, in seconds, after a scale-in activity completes before // another scale-in activity can start. This property is not used if the scalable - // resource is an Auto Scaling group. With the scale-in cooldown period, the - // intention is to scale in conservatively to protect your application’s - // availability, so scale-in activities are blocked until the cooldown period has - // expired. However, if another alarm triggers a scale-out activity during the - // scale-in cooldown period, Auto Scaling scales out the target immediately. In - // this case, the scale-in cooldown period stops and doesn't complete. + // resource is an Auto Scaling group. + // + // With the scale-in cooldown period, the intention is to scale in conservatively + // to protect your application’s availability, so scale-in activities are blocked + // until the cooldown period has expired. However, if another alarm triggers a + // scale-out activity during the scale-in cooldown period, Auto Scaling scales out + // the target immediately. In this case, the scale-in cooldown period stops and + // doesn't complete. ScaleInCooldown *int32 // The amount of time, in seconds, to wait for a previous scale-out activity to // take effect. This property is not used if the scalable resource is an Auto - // Scaling group. With the scale-out cooldown period, the intention is to - // continuously (but not excessively) scale out. After Auto Scaling successfully - // scales out using a target tracking scaling policy, it starts to calculate the - // cooldown time. The scaling policy won't increase the desired capacity again - // unless either a larger scale out is triggered or the cooldown period ends. + // Scaling group. + // + // With the scale-out cooldown period, the intention is to continuously (but not + // excessively) scale out. After Auto Scaling successfully scales out using a + // target tracking scaling policy, it starts to calculate the cooldown time. The + // scaling policy won't increase the desired capacity again unless either a larger + // scale out is triggered or the cooldown period ends. ScaleOutCooldown *int32 noSmithyDocumentSerde diff --git a/service/b2bi/api_op_ListTransformers.go b/service/b2bi/api_op_ListTransformers.go index 46d53f0166d..436608767b1 100644 --- a/service/b2bi/api_op_ListTransformers.go +++ b/service/b2bi/api_op_ListTransformers.go @@ -43,9 +43,10 @@ type ListTransformersInput struct { type ListTransformersOutput struct { - // Returns an array of one or more transformer objects. For each transformer, a - // TransformerSummary object is returned. The TransformerSummary contains all the - // details for a specific transformer. + // Returns an array of one or more transformer objects. + // + // For each transformer, a TransformerSummary object is returned. The + // TransformerSummary contains all the details for a specific transformer. // // This member is required. Transformers []types.TransformerSummary diff --git a/service/b2bi/api_op_StartTransformerJob.go b/service/b2bi/api_op_StartTransformerJob.go index 9f01fd409e9..3e882ed0107 100644 --- a/service/b2bi/api_op_StartTransformerJob.go +++ b/service/b2bi/api_op_StartTransformerJob.go @@ -13,10 +13,12 @@ import ( // Runs a job, using a transformer, to parse input EDI (electronic data // interchange) file into the output structures used by Amazon Web Services B2BI -// Data Interchange. If you only want to transform EDI (electronic data -// interchange) documents, you don't need to create profiles, partnerships or -// capabilities. Just create and configure a transformer, and then run the -// StartTransformerJob API to process your files. +// Data Interchange. +// +// If you only want to transform EDI (electronic data interchange) documents, you +// don't need to create profiles, partnerships or capabilities. Just create and +// configure a transformer, and then run the StartTransformerJob API to process +// your files. func (c *Client) StartTransformerJob(ctx context.Context, params *StartTransformerJobInput, optFns ...func(*Options)) (*StartTransformerJobOutput, error) { if params == nil { params = &StartTransformerJobInput{} diff --git a/service/b2bi/api_op_TagResource.go b/service/b2bi/api_op_TagResource.go index 3dd70b363c9..00eae690517 100644 --- a/service/b2bi/api_op_TagResource.go +++ b/service/b2bi/api_op_TagResource.go @@ -13,7 +13,9 @@ import ( // Attaches a key-value pair to a resource, as identified by its Amazon Resource // Name (ARN). Resources are capability, partnership, profile, transformers and -// other entities. There is no response returned from this call. +// other entities. +// +// There is no response returned from this call. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/b2bi/doc.go b/service/b2bi/doc.go index 89d2d9a1385..a18159154c7 100644 --- a/service/b2bi/doc.go +++ b/service/b2bi/doc.go @@ -5,14 +5,18 @@ // // This is the Amazon Web Services B2B Data Interchange API Reference. It provides // descriptions, API request parameters, and the XML response for each of the B2BI -// API actions. B2BI enables automated exchange of EDI (electronic data -// interchange) based business-critical transactions at cloud scale, with -// elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange -// transactional data with trading partners, such as suppliers and end customers, -// using standardized formats such as X12. Rather than actually running a command, -// you can use the --generate-cli-skeleton parameter with any API call to generate -// and display a parameter template. You can then use the generated template to -// customize and use as input on a later command. For details, see Generate and -// use a parameter skeleton file (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate) -// . +// API actions. +// +// B2BI enables automated exchange of EDI (electronic data interchange) based +// business-critical transactions at cloud scale, with elasticity and pay-as-you-go +// pricing. Businesses use EDI documents to exchange transactional data with +// trading partners, such as suppliers and end customers, using standardized +// formats such as X12. +// +// Rather than actually running a command, you can use the --generate-cli-skeleton +// parameter with any API call to generate and display a parameter template. You +// can then use the generated template to customize and use as input on a later +// command. For details, see [Generate and use a parameter skeleton file]. +// +// [Generate and use a parameter skeleton file]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate package b2bi diff --git a/service/b2bi/options.go b/service/b2bi/options.go index 83b7f186c3a..22624e6d1d7 100644 --- a/service/b2bi/options.go +++ b/service/b2bi/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/b2bi/types/enums.go b/service/b2bi/types/enums.go index 6283b32174d..474a5ab6c16 100644 --- a/service/b2bi/types/enums.go +++ b/service/b2bi/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for CapabilityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapabilityType) Values() []CapabilityType { return []CapabilityType{ "edi", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for FileFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileFormat) Values() []FileFormat { return []FileFormat{ "XML", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for Logging. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Logging) Values() []Logging { return []Logging{ "ENABLED", @@ -64,8 +67,9 @@ const ( ) // Values returns all known values for TransformerJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformerJobStatus) Values() []TransformerJobStatus { return []TransformerJobStatus{ "running", @@ -83,8 +87,9 @@ const ( ) // Values returns all known values for TransformerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformerStatus) Values() []TransformerStatus { return []TransformerStatus{ "active", @@ -174,8 +179,9 @@ const ( ) // Values returns all known values for X12TransactionSet. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (X12TransactionSet) Values() []X12TransactionSet { return []X12TransactionSet{ "X12_110", @@ -267,8 +273,9 @@ const ( ) // Values returns all known values for X12Version. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (X12Version) Values() []X12Version { return []X12Version{ "VERSION_4010", diff --git a/service/b2bi/types/types.go b/service/b2bi/types/types.go index 069ade1b4ea..6d5f2d31f67 100644 --- a/service/b2bi/types/types.go +++ b/service/b2bi/types/types.go @@ -278,9 +278,11 @@ type TransformerSummary struct { // A structure that contains the X12 transaction set and version. The X12 // structure is used when the system transforms an EDI (electronic data -// interchange) file. If an EDI input file contains more than one transaction, each -// transaction must have the same transaction set and version, for example -// 214/4010. If not, the transformer cannot parse the file. +// interchange) file. +// +// If an EDI input file contains more than one transaction, each transaction must +// have the same transaction set and version, for example 214/4010. If not, the +// transformer cannot parse the file. type X12Details struct { // Returns an enumerated type where each value identifies an X12 transaction set. diff --git a/service/backup/api_op_CreateBackupPlan.go b/service/backup/api_op_CreateBackupPlan.go index 484b4ffbe84..d275e8894b8 100644 --- a/service/backup/api_op_CreateBackupPlan.go +++ b/service/backup/api_op_CreateBackupPlan.go @@ -14,8 +14,10 @@ import ( // Creates a backup plan using a backup plan name and backup rules. A backup plan // is a document that contains information that Backup uses to schedule tasks that -// create recovery points for resources. If you call CreateBackupPlan with a plan -// that already exists, you receive an AlreadyExistsException exception. +// create recovery points for resources. +// +// If you call CreateBackupPlan with a plan that already exists, you receive an +// AlreadyExistsException exception. func (c *Client) CreateBackupPlan(ctx context.Context, params *CreateBackupPlanInput, optFns ...func(*Options)) (*CreateBackupPlanOutput, error) { if params == nil { params = &CreateBackupPlanInput{} @@ -47,8 +49,9 @@ type CreateBackupPlanInput struct { // 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. + // optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string noSmithyDocumentSerde diff --git a/service/backup/api_op_CreateBackupSelection.go b/service/backup/api_op_CreateBackupSelection.go index ab4a3312588..e9e17e29bb0 100644 --- a/service/backup/api_op_CreateBackupSelection.go +++ b/service/backup/api_op_CreateBackupSelection.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} @@ -45,8 +46,9 @@ type CreateBackupSelectionInput struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is - // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' - // characters. + // optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string noSmithyDocumentSerde diff --git a/service/backup/api_op_CreateBackupVault.go b/service/backup/api_op_CreateBackupVault.go index e527c38d2da..4828504f093 100644 --- a/service/backup/api_op_CreateBackupVault.go +++ b/service/backup/api_op_CreateBackupVault.go @@ -13,8 +13,10 @@ import ( // Creates a logical container where backups are stored. A CreateBackupVault // request includes a name, optionally one or more resource tags, an encryption -// key, and a request ID. Do not include sensitive data, such as passport numbers, -// in the name of a backup vault. +// key, and a request ID. +// +// Do not include sensitive data, such as passport numbers, in the name of a +// backup vault. func (c *Client) CreateBackupVault(ctx context.Context, params *CreateBackupVaultInput, optFns ...func(*Options)) (*CreateBackupVaultOutput, error) { if params == nil { params = &CreateBackupVaultInput{} @@ -46,8 +48,9 @@ type CreateBackupVaultInput struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is - // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' - // characters. + // optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string // The server-side encryption key that is used to protect your backups; for diff --git a/service/backup/api_op_CreateLogicallyAirGappedBackupVault.go b/service/backup/api_op_CreateLogicallyAirGappedBackupVault.go index cd47bbf784b..49382d668f2 100644 --- a/service/backup/api_op_CreateLogicallyAirGappedBackupVault.go +++ b/service/backup/api_op_CreateLogicallyAirGappedBackupVault.go @@ -12,11 +12,14 @@ import ( "time" ) -// This request creates a logical container to where backups may be copied. This -// request includes a name, the Region, the maximum number of retention days, the -// minimum number of retention days, and optionally can include tags and a creator -// request ID. Do not include sensitive data, such as passport numbers, in the name -// of a backup vault. +// This request creates a logical container to where backups may be copied. +// +// This request includes a name, the Region, the maximum number of retention days, +// the minimum number of retention days, and optionally can include tags and a +// creator request ID. +// +// Do not include sensitive data, such as passport numbers, in the name of a +// backup vault. func (c *Client) CreateLogicallyAirGappedBackupVault(ctx context.Context, params *CreateLogicallyAirGappedBackupVaultInput, optFns ...func(*Options)) (*CreateLogicallyAirGappedBackupVaultOutput, error) { if params == nil { params = &CreateLogicallyAirGappedBackupVaultInput{} @@ -42,22 +45,26 @@ type CreateLogicallyAirGappedBackupVaultInput struct { // This is the setting that specifies the maximum retention period that the vault // retains its recovery points. If this parameter is not specified, Backup does not // enforce a maximum retention period on the recovery points in the vault (allowing - // indefinite storage). If specified, any backup or copy job to the vault must have - // a lifecycle policy with a retention period equal to or shorter than the maximum - // retention period. If the job retention period is longer than that maximum - // retention period, then the vault fails the backup or copy job, and you should - // either modify your lifecycle settings or use a different vault. + // indefinite storage). + // + // If specified, any backup or copy job to the vault must have a lifecycle policy + // with a retention period equal to or shorter than the maximum retention period. + // If the job retention period is longer than that maximum retention period, then + // the vault fails the backup or copy job, and you should either modify your + // lifecycle settings or use a different vault. // // This member is required. MaxRetentionDays *int64 // This setting specifies the minimum retention period that the vault retains its // recovery points. If this parameter is not specified, no minimum retention period - // is enforced. If specified, any backup or copy job to the vault must have a - // lifecycle policy with a retention period equal to or longer than the minimum - // retention period. If a job retention period is shorter than that minimum - // retention period, then the vault fails the backup or copy job, and you should - // either modify your lifecycle settings or use a different vault. + // is enforced. + // + // If specified, any backup or copy job to the vault must have a lifecycle policy + // with a retention period equal to or longer than the minimum retention period. If + // a job retention period is shorter than that minimum retention period, then the + // vault fails the backup or copy job, and you should either modify your lifecycle + // settings or use a different vault. // // This member is required. MinRetentionDays *int64 @@ -65,8 +72,10 @@ type CreateLogicallyAirGappedBackupVaultInput struct { // These are the tags that will be included in the newly-created vault. BackupVaultTags map[string]string - // This is the ID of the creation request. This parameter is optional. If used, - // this parameter must contain 1 to 50 alphanumeric or '-_.' characters. + // This is the ID of the creation request. + // + // This parameter is optional. If used, this parameter must contain 1 to 50 + // alphanumeric or '-_.' characters. CreatorRequestId *string noSmithyDocumentSerde @@ -83,9 +92,11 @@ type CreateLogicallyAirGappedBackupVaultOutput struct { // letters, numbers, and hyphens. BackupVaultName *string - // The date and time when the vault was created. This value is in Unix format, - // Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the - // value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + // The date and time when the vault was created. + // + // This value is in Unix format, Coordinated Universal Time (UTC), and accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. CreationDate *time.Time // This is the current state of the vault. diff --git a/service/backup/api_op_CreateReportPlan.go b/service/backup/api_op_CreateReportPlan.go index 06b659fe231..bea789d7de6 100644 --- a/service/backup/api_op_CreateReportPlan.go +++ b/service/backup/api_op_CreateReportPlan.go @@ -13,8 +13,9 @@ import ( ) // Creates a report plan. A report plan is a document that contains information -// about the contents of the report and where Backup will deliver it. If you call -// CreateReportPlan with a plan that already exists, you receive an +// about the contents of the report and where Backup will deliver it. +// +// If you call CreateReportPlan with a plan that already exists, you receive an // AlreadyExistsException exception. func (c *Client) CreateReportPlan(ctx context.Context, params *CreateReportPlanInput, optFns ...func(*Options)) (*CreateReportPlanOutput, error) { if params == nil { @@ -48,9 +49,12 @@ type CreateReportPlanInput struct { ReportPlanName *string // Identifies the report template for the report. Reports are built using a report - // 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 + // 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 // by Amazon Web Services Regions and frameworks. // diff --git a/service/backup/api_op_CreateRestoreTestingPlan.go b/service/backup/api_op_CreateRestoreTestingPlan.go index 851805f7a34..229f85009b8 100644 --- a/service/backup/api_op_CreateRestoreTestingPlan.go +++ b/service/backup/api_op_CreateRestoreTestingPlan.go @@ -14,8 +14,10 @@ import ( // This is the first of two steps to create a restore testing plan; once this // request is successful, finish the procedure with request -// CreateRestoreTestingSelection. You must include the parameter -// RestoreTestingPlan. You may optionally include CreatorRequestId and Tags. +// CreateRestoreTestingSelection. +// +// You must include the parameter RestoreTestingPlan. You may optionally include +// CreatorRequestId and Tags. func (c *Client) CreateRestoreTestingPlan(ctx context.Context, params *CreateRestoreTestingPlanInput, optFns ...func(*Options)) (*CreateRestoreTestingPlanOutput, error) { if params == nil { params = &CreateRestoreTestingPlanInput{} @@ -35,8 +37,9 @@ type CreateRestoreTestingPlanInput struct { // A restore testing plan must contain a unique RestoreTestingPlanName string you // create and must contain a ScheduleExpression cron. You may optionally include a - // StartWindowHours integer and a CreatorRequestId string. The - // RestoreTestingPlanName is a unique string that is the name of the restore + // StartWindowHours integer and a CreatorRequestId string. + // + // The RestoreTestingPlanName is a unique string that is the name of the restore // testing plan. This cannot be changed after creation, and it must consist of only // alphanumeric characters and underscores. // @@ -73,9 +76,10 @@ type CreateRestoreTestingPlanOutput struct { // This member is required. RestoreTestingPlanArn *string - // This unique string is the name of the restore testing plan. The name cannot be - // changed after creation. The name consists of only alphanumeric characters and - // underscores. Maximum length is 50. + // This unique string is the name of the restore testing plan. + // + // The name cannot be changed after creation. The name consists of only + // alphanumeric characters and underscores. Maximum length is 50. // // This member is required. RestoreTestingPlanName *string diff --git a/service/backup/api_op_CreateRestoreTestingSelection.go b/service/backup/api_op_CreateRestoreTestingSelection.go index 3c3c755abfa..7cb1def8b0a 100644 --- a/service/backup/api_op_CreateRestoreTestingSelection.go +++ b/service/backup/api_op_CreateRestoreTestingSelection.go @@ -14,17 +14,24 @@ import ( // This request can be sent after CreateRestoreTestingPlan request returns // successfully. This is the second part of creating a resource testing plan, and -// it must be completed sequentially. This consists of RestoreTestingSelectionName -// , ProtectedResourceType , and one of the following: +// it must be completed sequentially. +// +// This consists of RestoreTestingSelectionName , ProtectedResourceType , and one +// of the following: +// // - ProtectedResourceArns +// // - ProtectedResourceConditions // -// Each protected resource type can have one single value. A restore testing -// selection can include a wildcard value ("*") for ProtectedResourceArns along -// with ProtectedResourceConditions . Alternatively, you can include up to 30 -// specific protected resource ARNs in ProtectedResourceArns . Cannot select by -// both protected resource types AND specific ARNs. Request will fail if both are -// included. +// Each protected resource type can have one single value. +// +// A restore testing selection can include a wildcard value ("*") for +// ProtectedResourceArns along with ProtectedResourceConditions . Alternatively, +// you can include up to 30 specific protected resource ARNs in +// ProtectedResourceArns . +// +// Cannot select by both protected resource types AND specific ARNs. Request will +// fail if both are included. func (c *Client) CreateRestoreTestingSelection(ctx context.Context, params *CreateRestoreTestingSelectionInput, optFns ...func(*Options)) (*CreateRestoreTestingSelectionOutput, error) { if params == nil { params = &CreateRestoreTestingSelectionInput{} @@ -50,12 +57,17 @@ type CreateRestoreTestingSelectionInput struct { // This consists of RestoreTestingSelectionName , ProtectedResourceType , and one // of the following: + // // - ProtectedResourceArns + // // - ProtectedResourceConditions - // Each protected resource type can have one single value. A restore testing - // selection can include a wildcard value ("*") for ProtectedResourceArns along - // with ProtectedResourceConditions . Alternatively, you can include up to 30 - // specific protected resource ARNs in ProtectedResourceArns . + // + // Each protected resource type can have one single value. + // + // A restore testing selection can include a wildcard value ("*") for + // ProtectedResourceArns along with ProtectedResourceConditions . Alternatively, + // you can include up to 30 specific protected resource ARNs in + // ProtectedResourceArns . // // This member is required. RestoreTestingSelection *types.RestoreTestingSelectionForCreate @@ -81,9 +93,10 @@ type CreateRestoreTestingSelectionOutput struct { // This member is required. RestoreTestingPlanArn *string - // Unique string that is the name of the restore testing plan. The name cannot be - // changed after creation. The name consists of only alphanumeric characters and - // underscores. Maximum length is 50. + // Unique string that is the name of the restore testing plan. + // + // The name cannot be changed after creation. The name consists of only + // alphanumeric characters and underscores. Maximum length is 50. // // This member is required. RestoreTestingPlanName *string diff --git a/service/backup/api_op_DeleteBackupVaultLockConfiguration.go b/service/backup/api_op_DeleteBackupVaultLockConfiguration.go index 5c8c4bab397..cfe7785cfe0 100644 --- a/service/backup/api_op_DeleteBackupVaultLockConfiguration.go +++ b/service/backup/api_op_DeleteBackupVaultLockConfiguration.go @@ -11,10 +11,12 @@ 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]in the Backup Developer Guide. +// +// [Vault Lock]: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html 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 bab628ebd28..7ecbd51e8eb 100644 --- a/service/backup/api_op_DeleteRecoveryPoint.go +++ b/service/backup/api_op_DeleteRecoveryPoint.go @@ -10,17 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the recovery point specified by a recovery point ID. If the recovery -// point ID belongs to a continuous backup, calling this endpoint deletes the -// existing continuous backup and stops future continuous backup. When an IAM -// role's permissions are insufficient to call this API, the service sends back an -// 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, +// Deletes the recovery point specified by a recovery point ID. +// +// If the recovery point ID belongs to a continuous backup, calling this endpoint +// deletes the existing continuous backup and stops future continuous backup. +// +// When an IAM role's permissions are insufficient to call this API, the service +// sends back an 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]. +// +// 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. +// +// [Troubleshooting manual deletions]: https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting func (c *Client) DeleteRecoveryPoint(ctx context.Context, params *DeleteRecoveryPointInput, optFns ...func(*Options)) (*DeleteRecoveryPointOutput, error) { if params == nil { params = &DeleteRecoveryPointInput{} diff --git a/service/backup/api_op_DeleteRestoreTestingPlan.go b/service/backup/api_op_DeleteRestoreTestingPlan.go index 486fa637bbd..a038855c9b1 100644 --- a/service/backup/api_op_DeleteRestoreTestingPlan.go +++ b/service/backup/api_op_DeleteRestoreTestingPlan.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This request deletes the specified restore testing plan. Deletion can only -// successfully occur if all associated restore testing selections are deleted -// first. +// This request deletes the specified restore testing plan. +// +// Deletion can only successfully occur if all associated restore testing +// selections are deleted first. func (c *Client) DeleteRestoreTestingPlan(ctx context.Context, params *DeleteRestoreTestingPlanInput, optFns ...func(*Options)) (*DeleteRestoreTestingPlanOutput, error) { if params == nil { params = &DeleteRestoreTestingPlanInput{} diff --git a/service/backup/api_op_DeleteRestoreTestingSelection.go b/service/backup/api_op_DeleteRestoreTestingSelection.go index 834b6752118..863b83765bb 100644 --- a/service/backup/api_op_DeleteRestoreTestingSelection.go +++ b/service/backup/api_op_DeleteRestoreTestingSelection.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Input the Restore Testing Plan name and Restore Testing Selection name. All -// testing selections associated with a restore testing plan must be deleted before -// the restore testing plan can be deleted. +// Input the Restore Testing Plan name and Restore Testing Selection name. +// +// All testing selections associated with a restore testing plan must be deleted +// before the restore testing plan can be deleted. func (c *Client) DeleteRestoreTestingSelection(ctx context.Context, params *DeleteRestoreTestingSelectionInput, optFns ...func(*Options)) (*DeleteRestoreTestingSelectionOutput, error) { if params == nil { params = &DeleteRestoreTestingSelectionInput{} diff --git a/service/backup/api_op_DescribeBackupJob.go b/service/backup/api_op_DescribeBackupJob.go index 9ad262c84a4..bed35f988c0 100644 --- a/service/backup/api_op_DescribeBackupJob.go +++ b/service/backup/api_op_DescribeBackupJob.go @@ -108,10 +108,12 @@ type DescribeBackupJobOutput struct { // This returns the boolean value that a backup job is a parent (composite) job. IsParent bool - // This is the job count for the specified message category. Example strings may - // include AccessDenied , SUCCESS , AGGREGATE_ALL , and INVALIDPARAMETERS . View - // Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of accepted MessageCategory strings. + // This is the job count for the specified message category. + // + // Example strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and + // INVALIDPARAMETERS . View [Monitoring] for a list of accepted MessageCategory strings. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // This returns the number of child (nested) backup jobs. diff --git a/service/backup/api_op_DescribeBackupVault.go b/service/backup/api_op_DescribeBackupVault.go index 9a56d008a83..34791fa2c9a 100644 --- a/service/backup/api_op_DescribeBackupVault.go +++ b/service/backup/api_op_DescribeBackupVault.go @@ -74,11 +74,15 @@ type DescribeBackupVaultOutput struct { EncryptionKeyArn *string // The date and time when Backup Vault Lock configuration cannot be changed or - // deleted. If you applied Vault Lock to your vault without specifying a lock date, - // you can change any of your Vault Lock settings, or delete Vault Lock from the - // vault entirely, at any time. This value is in Unix format, Coordinated Universal - // Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 - // represents Friday, January 26, 2018 12:11:30.087 AM. + // deleted. + // + // If you applied Vault Lock to your vault without specifying a lock date, you can + // change any of your Vault Lock settings, or delete Vault Lock from the vault + // entirely, at any time. + // + // This value is in Unix format, Coordinated Universal Time (UTC), and accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. LockDate *time.Time // A Boolean that indicates whether Backup Vault Lock is currently protecting the @@ -89,24 +93,26 @@ type DescribeBackupVaultOutput struct { // The Backup Vault Lock setting that specifies the maximum retention period that // the vault retains its recovery points. If this parameter is not specified, Vault // Lock does not enforce a maximum retention period on the recovery points in the - // vault (allowing indefinite storage). If specified, any backup or copy job to the - // vault must have a lifecycle policy with a retention period equal to or shorter - // than the maximum retention period. If the job's retention period is longer than - // that maximum retention period, then the vault fails the backup or copy job, and - // you should either modify your lifecycle settings or use a different vault. - // Recovery points already stored in the vault prior to Vault Lock are not - // affected. + // vault (allowing indefinite storage). + // + // If specified, any backup or copy job to the vault must have a lifecycle policy + // with a retention period equal to or shorter than the maximum retention period. + // If the job's retention period is longer than that maximum retention period, then + // the vault fails the backup or copy job, and you should either modify your + // lifecycle settings or use a different vault. Recovery points already stored in + // the vault prior to Vault Lock are not affected. MaxRetentionDays *int64 // The Backup Vault Lock setting that specifies the minimum retention period that // the vault retains its recovery points. If this parameter is not specified, Vault - // Lock does not enforce a minimum retention period. If specified, any backup or - // copy job to the vault must have a lifecycle policy with a retention period equal - // to or longer than the minimum retention period. If the job's retention period is - // shorter than that minimum retention period, then the vault fails the backup or - // copy job, and you should either modify your lifecycle settings or use a - // different vault. Recovery points already stored in the vault prior to Vault Lock - // are not affected. + // Lock does not enforce a minimum retention period. + // + // If specified, any backup or copy job to the vault must have a lifecycle policy + // with a retention period equal to or longer than the minimum retention period. If + // the job's retention period is shorter than that minimum retention period, then + // the vault fails the backup or copy job, and you should either modify your + // lifecycle settings or use a different vault. Recovery points already stored in + // the vault prior to Vault Lock are not affected. MinRetentionDays *int64 // The number of recovery points that are stored in a backup vault. diff --git a/service/backup/api_op_DescribeFramework.go b/service/backup/api_op_DescribeFramework.go index 377e8f3ead4..c7514516188 100644 --- a/service/backup/api_op_DescribeFramework.go +++ b/service/backup/api_op_DescribeFramework.go @@ -46,8 +46,10 @@ type DescribeFrameworkOutput struct { // hours behind UTC. CreationTime *time.Time - // The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | - // UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED + // The deployment status of a framework. The statuses are: + // + // CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | + // FAILED DeploymentStatus *string // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format @@ -67,12 +69,16 @@ 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. FrameworkStatus *string diff --git a/service/backup/api_op_DescribeRecoveryPoint.go b/service/backup/api_op_DescribeRecoveryPoint.go index cc4b94e5540..78eecc80057 100644 --- a/service/backup/api_op_DescribeRecoveryPoint.go +++ b/service/backup/api_op_DescribeRecoveryPoint.go @@ -80,8 +80,9 @@ 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) - // within a stack. + // transferred from the [logical ID]within a stack. + // + // [logical ID]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax CompositeMemberIdentifier *string // Contains identifying information about the creation of a recovery point, @@ -119,14 +120,19 @@ type DescribeRecoveryPointOutput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically - // according to the lifecycle that you define. Backups that are transitioned to - // cold storage must be stored in cold storage for a minimum of 90 days. Therefore, - // the “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. + // according to the lifecycle that you define. + // + // Backups that are transitioned to cold storage must be stored in cold storage + // for a minimum of 90 days. Therefore, the “retention” setting must be 90 days + // 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]table. Backup ignores this + // expression for other resource types. + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *types.Lifecycle // This is an ARN that uniquely identifies a parent (composite) recovery point; @@ -160,27 +166,36 @@ type DescribeRecoveryPointOutput struct { // 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 + // 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]. + // 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]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. For SAP HANA on Amazon EC2 STOPPED status occurs due to - // user action, application misconfiguration, or backup failure. To ensure that - // future continuous backups succeed, refer to the recovery point status and check - // SAP HANA for details. + // need to be deleted. + // + // For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, + // application misconfiguration, or backup failure. To ensure that future + // continuous backups succeed, refer to the recovery point status and check SAP + // HANA for details. + // + // [Step 3: Delete the recovery points]: https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups + // [UpdateBackupPlan]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html Status types.RecoveryPointStatus // A status message explaining the status of the recovery point. diff --git a/service/backup/api_op_DescribeRegionSettings.go b/service/backup/api_op_DescribeRegionSettings.go index de20aa04a27..ceca0c51e53 100644 --- a/service/backup/api_op_DescribeRegionSettings.go +++ b/service/backup/api_op_DescribeRegionSettings.go @@ -36,13 +36,19 @@ 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) - // . + // Returns whether Backup fully manages the backups for a resource type. + // + // For the benefits of full Backup management, see [Full Backup management]. + // + // For a list of resource types and whether each supports full Backup management, + // see the [Feature availability by resource]table. + // + // If "DynamoDB":false , you can enable full Backup management for DynamoDB backup + // by enabling [Backup's advanced DynamoDB backup features]. + // + // [Full Backup management]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource + // [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_DisassociateRecoveryPoint.go b/service/backup/api_op_DisassociateRecoveryPoint.go index 9fc4f75085c..afbbf0c2134 100644 --- a/service/backup/api_op_DisassociateRecoveryPoint.go +++ b/service/backup/api_op_DisassociateRecoveryPoint.go @@ -13,8 +13,9 @@ import ( // Deletes the specified continuous backup recovery point from Backup and releases // control of that continuous backup to the source service, such as Amazon RDS. The // source service will continue to create and retain continuous backups using the -// lifecycle that you specified in your original backup plan. Does not support -// snapshot backup recovery points. +// lifecycle that you specified in your original backup plan. +// +// Does not support snapshot backup recovery points. func (c *Client) DisassociateRecoveryPoint(ctx context.Context, params *DisassociateRecoveryPointInput, optFns ...func(*Options)) (*DisassociateRecoveryPointOutput, error) { if params == nil { params = &DisassociateRecoveryPointInput{} diff --git a/service/backup/api_op_ExportBackupPlanTemplate.go b/service/backup/api_op_ExportBackupPlanTemplate.go index 3c647a2e00b..572f2ee4081 100644 --- a/service/backup/api_op_ExportBackupPlanTemplate.go +++ b/service/backup/api_op_ExportBackupPlanTemplate.go @@ -38,8 +38,10 @@ type ExportBackupPlanTemplateInput struct { type ExportBackupPlanTemplateOutput struct { - // The body of a backup plan template in JSON format. This is a signed JSON - // document that cannot be modified before being passed to GetBackupPlanFromJSON. + // The body of a backup plan template in JSON format. + // + // This is a signed JSON document that cannot be modified before being passed to + // GetBackupPlanFromJSON. BackupPlanTemplateJson *string // Metadata pertaining to the operation's result. diff --git a/service/backup/api_op_GetSupportedResourceTypes.go b/service/backup/api_op_GetSupportedResourceTypes.go index 96110158326..bea23a6d30a 100644 --- a/service/backup/api_op_GetSupportedResourceTypes.go +++ b/service/backup/api_op_GetSupportedResourceTypes.go @@ -33,15 +33,25 @@ 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 ResourceTypes []string diff --git a/service/backup/api_op_ListBackupJobSummaries.go b/service/backup/api_op_ListBackupJobSummaries.go index ce7132bab8e..2bcad39e6c5 100644 --- a/service/backup/api_op_ListBackupJobSummaries.go +++ b/service/backup/api_op_ListBackupJobSummaries.go @@ -14,6 +14,7 @@ import ( // This is a request for a summary of backup jobs created or running within the // most recent 30 days. You can include parameters AccountID, State, ResourceType, // MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. +// // This request returns a summary that contains Region, Account, State, // ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. func (c *Client) ListBackupJobSummaries(ctx context.Context, params *ListBackupJobSummariesInput, optFns ...func(*Options)) (*ListBackupJobSummariesOutput, error) { @@ -33,31 +34,45 @@ func (c *Client) ListBackupJobSummaries(ctx context.Context, params *ListBackupJ type ListBackupJobSummariesInput struct { - // Returns the job count for the specified account. If the request is sent from a - // member account or an account not part of Amazon Web Services Organizations, jobs - // within requestor's account will be returned. Root, admin, and delegated - // administrator accounts can use the value ANY to return job counts from every - // account in the organization. AGGREGATE_ALL aggregates job counts from all - // accounts within the authenticated organization, then returns the sum. + // Returns the job count for the specified account. + // + // If the request is sent from a member account or an account not part of Amazon + // Web Services Organizations, jobs within requestor's account will be returned. + // + // Root, admin, and delegated administrator accounts can use the value ANY to + // return job counts from every account in the organization. + // + // AGGREGATE_ALL aggregates job counts from all accounts within the authenticated + // organization, then returns the sum. AccountId *string - // This is the period that sets the boundaries for returned results. Acceptable - // values include + // This is the period that sets the boundaries for returned results. + // + // Acceptable values include + // // - ONE_DAY for daily job count for the prior 14 days. + // // - SEVEN_DAYS for the aggregated job count for the prior 7 days. + // // - FOURTEEN_DAYS for aggregated job count for prior 14 days. AggregationPeriod types.AggregationPeriod - // This parameter sets the maximum number of items to be returned. The value is an - // integer. Range of accepted values is from 1 to 500. + // This parameter sets the maximum number of items to be returned. + // + // The value is an integer. Range of accepted values is from 1 to 500. MaxResults *int32 // This parameter returns the job count for the specified message category. + // // Example accepted strings include AccessDenied , Success , and InvalidParameters - // . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of accepted MessageCategory strings. The the value ANY returns count - // of all message categories. AGGREGATE_ALL aggregates job counts for all message - // categories and returns the sum. + // . See [Monitoring]for a list of accepted MessageCategory strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // The next item following a partial list of returned resources. For example, if a @@ -67,23 +82,32 @@ type ListBackupJobSummariesInput struct { NextToken *string // Returns the job count for the specified resource type. Use request - // GetSupportedResourceTypes to obtain strings for supported resource types. The - // the value ANY returns count of all resource types. AGGREGATE_ALL aggregates job - // counts for all resource types and returns the sum. 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. + // GetSupportedResourceTypes to obtain strings for supported resource types. + // + // The the value ANY returns count of all resource types. + // + // AGGREGATE_ALL aggregates job counts for all resource types and returns the sum. + // + // 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 - // This parameter returns the job count for jobs with the specified state. The the - // value ANY returns count of all states. AGGREGATE_ALL aggregates job counts for - // all states and returns the sum. Completed with issues is a status found only in - // the Backup console. For API, this status refers to jobs with a state of - // COMPLETED and a MessageCategory with a value other than SUCCESS ; that is, the - // status is completed but comes with a status message. To obtain the job count for - // Completed with issues , run two GET requests, and subtract the second, smaller - // number: GET - // /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED GET + // This parameter returns the job count for jobs with the specified state. + // + // The the value ANY returns count of all states. + // + // AGGREGATE_ALL aggregates job counts for all states and returns the sum. + // + // Completed with issues is a status found only in the Backup console. For API, + // this status refers to jobs with a state of COMPLETED and a MessageCategory with + // a value other than SUCCESS ; that is, the status is completed but comes with a + // status message. To obtain the job count for Completed with issues , run two GET + // requests, and subtract the second, smaller number: + // + // GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED + // + // GET // /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED State types.BackupJobStatus @@ -93,8 +117,11 @@ type ListBackupJobSummariesInput struct { type ListBackupJobSummariesOutput struct { // This is the period that sets the boundaries for returned results. + // // - ONE_DAY for daily job count for the prior 14 days. + // // - SEVEN_DAYS for the aggregated job count for the prior 7 days. + // // - FOURTEEN_DAYS for aggregated job count for prior 14 days. AggregationPeriod *string @@ -201,8 +228,9 @@ var _ ListBackupJobSummariesAPIClient = (*Client)(nil) // ListBackupJobSummariesPaginatorOptions is the paginator options for // ListBackupJobSummaries type ListBackupJobSummariesPaginatorOptions struct { - // This parameter sets the maximum number of items to be returned. The value is an - // integer. Range of accepted values is from 1 to 500. + // This parameter sets the maximum number of items to be returned. + // + // The value is an integer. Range of accepted values is from 1 to 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/backup/api_op_ListBackupJobs.go b/service/backup/api_op_ListBackupJobs.go index 682fc9338ec..d6c41376f7c 100644 --- a/service/backup/api_op_ListBackupJobs.go +++ b/service/backup/api_op_ListBackupJobs.go @@ -13,8 +13,9 @@ import ( ) // 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) -// . +// last 30 days. For a longer period of time, consider using these [monitoring tools]. +// +// [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{} @@ -33,8 +34,10 @@ func (c *Client) ListBackupJobs(ctx context.Context, params *ListBackupJobsInput type ListBackupJobsInput struct { // The account ID to list the jobs from. Returns only backup jobs associated with - // the specified account ID. If used from an Organizations management account, - // passing * returns all jobs across the organization. + // the specified account ID. + // + // If used from an Organizations management account, passing * returns all jobs + // across the organization. ByAccountId *string // Returns only backup jobs that will be stored in the specified backup vault. @@ -58,10 +61,19 @@ type ListBackupJobsInput struct { ByCreatedBefore *time.Time // This is an optional parameter that can be used to filter out jobs with a - // MessageCategory which matches the value you input. Example strings may include - // AccessDenied , SUCCESS , AGGREGATE_ALL , and InvalidParameters . View Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // The wildcard () returns count of all message categories. AGGREGATE_ALL - // aggregates job counts for all message categories and returns the sum. + // MessageCategory which matches the value you input. + // + // Example strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and + // InvalidParameters . + // + // View [Monitoring] + // + // The wildcard () returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html ByMessageCategory *string // This is a filter to list child (nested) jobs based on parent job ID. @@ -72,31 +84,53 @@ type ListBackupJobsInput struct { ByResourceArn *string // Returns only backup jobs for the specified resources: + // // - Aurora for Amazon Aurora + // // - CloudFormation for CloudFormation + // // - 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 + // // - Redshift for Amazon Redshift + // // - RDS for Amazon Relational Database Service + // // - SAP HANA on Amazon EC2 for SAP HANA databases + // // - Storage Gateway for Storage Gateway + // // - S3 for Amazon S3 + // // - Timestream for Amazon Timestream + // // - VirtualMachine for virtual machines ByResourceType *string - // Returns only backup jobs that are in the specified state. Completed with issues - // is a status found only in the Backup console. For API, this status refers to - // jobs with a state of COMPLETED and a MessageCategory with a value other than - // SUCCESS ; that is, the status is completed but comes with a status message. To - // obtain the job count for Completed with issues , run two GET requests, and - // subtract the second, smaller number: GET /backup-jobs/?state=COMPLETED GET - // /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED + // Returns only backup jobs that are in the specified state. + // + // Completed with issues is a status found only in the Backup console. For API, + // this status refers to jobs with a state of COMPLETED and a MessageCategory with + // a value other than SUCCESS ; that is, the status is completed but comes with a + // status message. + // + // To obtain the job count for Completed with issues , run two GET requests, and + // subtract the second, smaller number: + // + // GET /backup-jobs/?state=COMPLETED + // + // GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED ByState types.BackupJobState // The maximum number of items to be returned. diff --git a/service/backup/api_op_ListCopyJobSummaries.go b/service/backup/api_op_ListCopyJobSummaries.go index 11fefbb267b..8a8f9e621db 100644 --- a/service/backup/api_op_ListCopyJobSummaries.go +++ b/service/backup/api_op_ListCopyJobSummaries.go @@ -14,6 +14,7 @@ import ( // This request obtains a list of copy jobs created or running within the the most // recent 30 days. You can include parameters AccountID, State, ResourceType, // MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. +// // This request returns a summary that contains Region, Account, State, // RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. func (c *Client) ListCopyJobSummaries(ctx context.Context, params *ListCopyJobSummariesInput, optFns ...func(*Options)) (*ListCopyJobSummariesOutput, error) { @@ -33,30 +34,43 @@ func (c *Client) ListCopyJobSummaries(ctx context.Context, params *ListCopyJobSu type ListCopyJobSummariesInput struct { - // Returns the job count for the specified account. If the request is sent from a - // member account or an account not part of Amazon Web Services Organizations, jobs - // within requestor's account will be returned. Root, admin, and delegated - // administrator accounts can use the value ANY to return job counts from every - // account in the organization. AGGREGATE_ALL aggregates job counts from all - // accounts within the authenticated organization, then returns the sum. + // Returns the job count for the specified account. + // + // If the request is sent from a member account or an account not part of Amazon + // Web Services Organizations, jobs within requestor's account will be returned. + // + // Root, admin, and delegated administrator accounts can use the value ANY to + // return job counts from every account in the organization. + // + // AGGREGATE_ALL aggregates job counts from all accounts within the authenticated + // organization, then returns the sum. AccountId *string // This is the period that sets the boundaries for returned results. + // // - ONE_DAY for daily job count for the prior 14 days. + // // - SEVEN_DAYS for the aggregated job count for the prior 7 days. + // // - FOURTEEN_DAYS for aggregated job count for prior 14 days. AggregationPeriod types.AggregationPeriod - // This parameter sets the maximum number of items to be returned. The value is an - // integer. Range of accepted values is from 1 to 500. + // This parameter sets the maximum number of items to be returned. + // + // The value is an integer. Range of accepted values is from 1 to 500. MaxResults *int32 // This parameter returns the job count for the specified message category. + // // Example accepted strings include AccessDenied , Success , and InvalidParameters - // . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of accepted MessageCategory strings. The the value ANY returns count - // of all message categories. AGGREGATE_ALL aggregates job counts for all message - // categories and returns the sum. + // . See [Monitoring]for a list of accepted MessageCategory strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // The next item following a partial list of returned resources. For example, if a @@ -66,17 +80,22 @@ type ListCopyJobSummariesInput struct { NextToken *string // Returns the job count for the specified resource type. Use request - // GetSupportedResourceTypes to obtain strings for supported resource types. The - // the value ANY returns count of all resource types. AGGREGATE_ALL aggregates job - // counts for all resource types and returns the sum. 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. + // GetSupportedResourceTypes to obtain strings for supported resource types. + // + // The the value ANY returns count of all resource types. + // + // AGGREGATE_ALL aggregates job counts for all resource types and returns the sum. + // + // 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 - // This parameter returns the job count for jobs with the specified state. The the - // value ANY returns count of all states. AGGREGATE_ALL aggregates job counts for - // all states and returns the sum. + // This parameter returns the job count for jobs with the specified state. + // + // The the value ANY returns count of all states. + // + // AGGREGATE_ALL aggregates job counts for all states and returns the sum. State types.CopyJobStatus noSmithyDocumentSerde @@ -85,8 +104,11 @@ type ListCopyJobSummariesInput struct { type ListCopyJobSummariesOutput struct { // This is the period that sets the boundaries for returned results. + // // - ONE_DAY for daily job count for the prior 14 days. + // // - SEVEN_DAYS for the aggregated job count for the prior 7 days. + // // - FOURTEEN_DAYS for aggregated job count for prior 14 days. AggregationPeriod *string @@ -193,8 +215,9 @@ var _ ListCopyJobSummariesAPIClient = (*Client)(nil) // ListCopyJobSummariesPaginatorOptions is the paginator options for // ListCopyJobSummaries type ListCopyJobSummariesPaginatorOptions struct { - // This parameter sets the maximum number of items to be returned. The value is an - // integer. Range of accepted values is from 1 to 500. + // This parameter sets the maximum number of items to be returned. + // + // The value is an integer. Range of accepted values is from 1 to 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/backup/api_op_ListCopyJobs.go b/service/backup/api_op_ListCopyJobs.go index a22569600a3..a915caf3531 100644 --- a/service/backup/api_op_ListCopyJobs.go +++ b/service/backup/api_op_ListCopyJobs.go @@ -54,11 +54,19 @@ type ListCopyJobsInput struct { ByDestinationVaultArn *string // This is an optional parameter that can be used to filter out jobs with a - // MessageCategory which matches the value you input. Example strings may include - // AccessDenied , SUCCESS , AGGREGATE_ALL , and INVALIDPARAMETERS . View Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of accepted strings. The the value ANY returns count of all message - // categories. AGGREGATE_ALL aggregates job counts for all message categories and - // returns the sum. + // MessageCategory which matches the value you input. + // + // Example strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and + // INVALIDPARAMETERS . + // + // View [Monitoring] for a list of accepted strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html ByMessageCategory *string // This is a filter to list child (nested) jobs based on parent job ID. @@ -69,21 +77,37 @@ type ListCopyJobsInput struct { ByResourceArn *string // Returns only backup jobs for the specified resources: + // // - Aurora for Amazon Aurora + // // - CloudFormation for CloudFormation + // // - 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 + // // - Redshift for Amazon Redshift + // // - RDS for Amazon Relational Database Service + // // - SAP HANA on Amazon EC2 for SAP HANA databases + // // - Storage Gateway for Storage Gateway + // // - S3 for Amazon S3 + // // - Timestream for Amazon Timestream + // // - VirtualMachine for virtual machines ByResourceType *string diff --git a/service/backup/api_op_ListRecoveryPointsByBackupVault.go b/service/backup/api_op_ListRecoveryPointsByBackupVault.go index 46997d5382c..568c7d0ae79 100644 --- a/service/backup/api_op_ListRecoveryPointsByBackupVault.go +++ b/service/backup/api_op_ListRecoveryPointsByBackupVault.go @@ -33,8 +33,10 @@ type ListRecoveryPointsByBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase - // letters, numbers, and hyphens. Backup vault name might not be available when a - // supported service creates the backup. + // letters, numbers, and hyphens. + // + // Backup vault name might not be available when a supported service creates the + // backup. // // This member is required. BackupVaultName *string @@ -60,21 +62,37 @@ type ListRecoveryPointsByBackupVaultInput struct { ByResourceArn *string // Returns only recovery points that match the specified resource type(s): + // // - Aurora for Amazon Aurora + // // - CloudFormation for CloudFormation + // // - 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 + // // - Redshift for Amazon Redshift + // // - RDS for Amazon Relational Database Service + // // - SAP HANA on Amazon EC2 for SAP HANA databases + // // - Storage Gateway for Storage Gateway + // // - S3 for Amazon S3 + // // - Timestream for Amazon Timestream + // // - VirtualMachine for virtual machines ByResourceType *string diff --git a/service/backup/api_op_ListRecoveryPointsByResource.go b/service/backup/api_op_ListRecoveryPointsByResource.go index 447dddacc91..cfc2cf38dcf 100644 --- a/service/backup/api_op_ListRecoveryPointsByResource.go +++ b/service/backup/api_op_ListRecoveryPointsByResource.go @@ -12,8 +12,10 @@ import ( ) // 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. +// 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{} @@ -37,15 +39,20 @@ type ListRecoveryPointsByResourceInput struct { // This member is required. ResourceArn *string - // This attribute filters recovery points based on ownership. If this is set to - // TRUE , the response will contain recovery points associated with the selected - // resources that are managed by Backup. If this is set to FALSE , the response - // will contain all recovery points associated with the selected resource. Type: - // Boolean + // This attribute filters recovery points based on ownership. + // + // If this is set to TRUE , the response will contain recovery points associated + // with the selected resources that are managed by Backup. + // + // If this is set to FALSE , the response will contain all recovery points + // associated with the selected resource. + // + // Type: Boolean ManagedByAWSBackupOnly bool - // The maximum number of items to be returned. Amazon RDS requires a value of at - // least 20. + // The maximum number of items to be returned. + // + // Amazon RDS requires a value of at least 20. MaxResults *int32 // The next item following a partial list of returned items. For example, if a @@ -66,8 +73,9 @@ type ListRecoveryPointsByResourceOutput struct { NextToken *string // An array of objects that contain detailed information about recovery points of - // the specified resource type. Only Amazon EFS and Amazon EC2 recovery points - // return BackupVaultName. + // the specified resource type. + // + // Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName. RecoveryPoints []types.RecoveryPointByResource // Metadata pertaining to the operation's result. @@ -166,8 +174,9 @@ var _ ListRecoveryPointsByResourceAPIClient = (*Client)(nil) // ListRecoveryPointsByResourcePaginatorOptions is the paginator options for // ListRecoveryPointsByResource type ListRecoveryPointsByResourcePaginatorOptions struct { - // The maximum number of items to be returned. Amazon RDS requires a value of at - // least 20. + // The maximum number of items to be returned. + // + // Amazon RDS requires a value of at least 20. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/backup/api_op_ListReportJobs.go b/service/backup/api_op_ListReportJobs.go index d1f004dbb86..0a7e9473d8a 100644 --- a/service/backup/api_op_ListReportJobs.go +++ b/service/backup/api_op_ListReportJobs.go @@ -44,7 +44,8 @@ type ListReportJobsInput struct { ByReportPlanName *string // Returns only report jobs that are in the specified status. The statuses are: - // CREATED | RUNNING | COMPLETED | FAILED + // + // CREATED | RUNNING | COMPLETED | FAILED ByStatus *string // The number of desired results from 1 to 1000. Optional. If unspecified, the diff --git a/service/backup/api_op_ListRestoreJobSummaries.go b/service/backup/api_op_ListRestoreJobSummaries.go index cc72c375cdd..4b198c342a4 100644 --- a/service/backup/api_op_ListRestoreJobSummaries.go +++ b/service/backup/api_op_ListRestoreJobSummaries.go @@ -14,6 +14,7 @@ import ( // This request obtains a summary of restore jobs created or running within the // the most recent 30 days. You can include parameters AccountID, State, // ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results. +// // This request returns a summary that contains Region, Account, State, // RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. func (c *Client) ListRestoreJobSummaries(ctx context.Context, params *ListRestoreJobSummariesInput, optFns ...func(*Options)) (*ListRestoreJobSummariesOutput, error) { @@ -33,23 +34,32 @@ func (c *Client) ListRestoreJobSummaries(ctx context.Context, params *ListRestor type ListRestoreJobSummariesInput struct { - // Returns the job count for the specified account. If the request is sent from a - // member account or an account not part of Amazon Web Services Organizations, jobs - // within requestor's account will be returned. Root, admin, and delegated - // administrator accounts can use the value ANY to return job counts from every - // account in the organization. AGGREGATE_ALL aggregates job counts from all - // accounts within the authenticated organization, then returns the sum. + // Returns the job count for the specified account. + // + // If the request is sent from a member account or an account not part of Amazon + // Web Services Organizations, jobs within requestor's account will be returned. + // + // Root, admin, and delegated administrator accounts can use the value ANY to + // return job counts from every account in the organization. + // + // AGGREGATE_ALL aggregates job counts from all accounts within the authenticated + // organization, then returns the sum. AccountId *string - // This is the period that sets the boundaries for returned results. Acceptable - // values include + // This is the period that sets the boundaries for returned results. + // + // Acceptable values include + // // - ONE_DAY for daily job count for the prior 14 days. + // // - SEVEN_DAYS for the aggregated job count for the prior 7 days. + // // - FOURTEEN_DAYS for aggregated job count for prior 14 days. AggregationPeriod types.AggregationPeriod - // This parameter sets the maximum number of items to be returned. The value is an - // integer. Range of accepted values is from 1 to 500. + // This parameter sets the maximum number of items to be returned. + // + // The value is an integer. Range of accepted values is from 1 to 500. MaxResults *int32 // The next item following a partial list of returned resources. For example, if a @@ -59,17 +69,22 @@ type ListRestoreJobSummariesInput struct { NextToken *string // Returns the job count for the specified resource type. Use request - // GetSupportedResourceTypes to obtain strings for supported resource types. The - // the value ANY returns count of all resource types. AGGREGATE_ALL aggregates job - // counts for all resource types and returns the sum. 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. + // GetSupportedResourceTypes to obtain strings for supported resource types. + // + // The the value ANY returns count of all resource types. + // + // AGGREGATE_ALL aggregates job counts for all resource types and returns the sum. + // + // 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 - // This parameter returns the job count for jobs with the specified state. The the - // value ANY returns count of all states. AGGREGATE_ALL aggregates job counts for - // all states and returns the sum. + // This parameter returns the job count for jobs with the specified state. + // + // The the value ANY returns count of all states. + // + // AGGREGATE_ALL aggregates job counts for all states and returns the sum. State types.RestoreJobState noSmithyDocumentSerde @@ -78,8 +93,11 @@ type ListRestoreJobSummariesInput struct { type ListRestoreJobSummariesOutput struct { // This is the period that sets the boundaries for returned results. + // // - ONE_DAY for daily job count for the prior 14 days. + // // - SEVEN_DAYS for the aggregated job count for the prior 7 days. + // // - FOURTEEN_DAYS for aggregated job count for prior 14 days. AggregationPeriod *string @@ -186,8 +204,9 @@ var _ ListRestoreJobSummariesAPIClient = (*Client)(nil) // ListRestoreJobSummariesPaginatorOptions is the paginator options for // ListRestoreJobSummaries type ListRestoreJobSummariesPaginatorOptions struct { - // This parameter sets the maximum number of items to be returned. The value is an - // integer. Range of accepted values is from 1 to 500. + // This parameter sets the maximum number of items to be returned. + // + // The value is an integer. Range of accepted values is from 1 to 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/backup/api_op_ListRestoreJobs.go b/service/backup/api_op_ListRestoreJobs.go index d3d9a848914..9408cdfcc5f 100644 --- a/service/backup/api_op_ListRestoreJobs.go +++ b/service/backup/api_op_ListRestoreJobs.go @@ -50,21 +50,37 @@ type ListRestoreJobsInput struct { ByCreatedBefore *time.Time // Include this parameter to return only restore jobs for the specified resources: + // // - Aurora for Amazon Aurora + // // - CloudFormation for CloudFormation + // // - 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 + // // - Redshift for Amazon Redshift + // // - RDS for Amazon Relational Database Service + // // - SAP HANA on Amazon EC2 for SAP HANA databases + // // - Storage Gateway for Storage Gateway + // // - S3 for Amazon S3 + // // - Timestream for Amazon Timestream + // // - VirtualMachine for virtual machines ByResourceType *string diff --git a/service/backup/api_op_ListRestoreJobsByProtectedResource.go b/service/backup/api_op_ListRestoreJobsByProtectedResource.go index fe9cb804a49..2932edb7553 100644 --- a/service/backup/api_op_ListRestoreJobsByProtectedResource.go +++ b/service/backup/api_op_ListRestoreJobsByProtectedResource.go @@ -12,8 +12,9 @@ import ( "time" ) -// This returns restore jobs that contain the specified protected resource. You -// must include ResourceArn . You can optionally include NextToken , ByStatus , +// This returns restore jobs that contain the specified protected resource. +// +// You must include ResourceArn . You can optionally include NextToken , ByStatus , // MaxResults , ByRecoveryPointCreationDateAfter , and // ByRecoveryPointCreationDateBefore . func (c *Client) ListRestoreJobsByProtectedResource(ctx context.Context, params *ListRestoreJobsByProtectedResourceInput, optFns ...func(*Options)) (*ListRestoreJobsByProtectedResourceOutput, error) { diff --git a/service/backup/api_op_ListTags.go b/service/backup/api_op_ListTags.go index 45c96af7efb..c99befb7d37 100644 --- a/service/backup/api_op_ListTags.go +++ b/service/backup/api_op_ListTags.go @@ -11,10 +11,13 @@ 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) -// table. +// 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]table. +// +// [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} diff --git a/service/backup/api_op_PutBackupVaultLockConfiguration.go b/service/backup/api_op_PutBackupVaultLockConfiguration.go index 6b0b0d5429c..dc67d6c6c34 100644 --- a/service/backup/api_op_PutBackupVaultLockConfiguration.go +++ b/service/backup/api_op_PutBackupVaultLockConfiguration.go @@ -15,10 +15,12 @@ import ( // attempts to update the lifecycle policy that controls the retention period of // any recovery point currently stored in a backup vault. If specified, Vault Lock // enforces a minimum and maximum retention period for future backup and copy jobs -// that target a backup vault. Backup Vault Lock has been assessed by Cohasset -// Associates for use in environments that are subject to SEC 17a-4, CFTC, and -// FINRA regulations. For more information about how Backup Vault Lock relates to -// these regulations, see the Cohasset Associates Compliance Assessment. +// that target a backup vault. +// +// Backup Vault Lock has been assessed by Cohasset Associates for use in +// environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For +// more information about how Backup Vault Lock relates to these regulations, see +// the Cohasset Associates Compliance Assessment. func (c *Client) PutBackupVaultLockConfiguration(ctx context.Context, params *PutBackupVaultLockConfigurationInput, optFns ...func(*Options)) (*PutBackupVaultLockConfigurationOutput, error) { if params == nil { params = &PutBackupVaultLockConfigurationInput{} @@ -44,46 +46,56 @@ type PutBackupVaultLockConfigurationInput struct { // 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 + // 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 // DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using // 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 - // PutBackupVaultLockConfiguration at any time. + // 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 PutBackupVaultLockConfiguration at any time. ChangeableForDays *int64 // The Backup Vault Lock configuration that specifies the maximum retention period // that the vault retains its recovery points. This setting can be useful if, for // example, your organization's policies require you to destroy certain data after - // retaining it for four years (1460 days). If this parameter is not included, - // Vault Lock does not enforce a maximum retention period on the recovery points in - // the vault. If this parameter is included without a value, Vault Lock will not - // enforce a maximum retention period. If this parameter is specified, any backup - // or copy job to the vault must have a lifecycle policy with a retention period - // equal to or shorter than the maximum retention period. If the job's retention - // period is longer than that maximum retention period, then the vault fails the - // backup or copy job, and you should either modify your lifecycle settings or use - // a different vault. The longest maximum retention period you can specify is 36500 - // days (approximately 100 years). Recovery points already saved in the vault prior - // to Vault Lock are not affected. + // retaining it for four years (1460 days). + // + // If this parameter is not included, Vault Lock does not enforce a maximum + // retention period on the recovery points in the vault. If this parameter is + // included without a value, Vault Lock will not enforce a maximum retention + // period. + // + // If this parameter is specified, any backup or copy job to the vault must have a + // lifecycle policy with a retention period equal to or shorter than the maximum + // retention period. If the job's retention period is longer than that maximum + // retention period, then the vault fails the backup or copy job, and you should + // either modify your lifecycle settings or use a different vault. The longest + // maximum retention period you can specify is 36500 days (approximately 100 + // years). Recovery points already saved in the vault prior to Vault Lock are not + // affected. MaxRetentionDays *int64 // The Backup Vault Lock configuration that specifies the minimum retention period // that the vault retains its recovery points. This setting can be useful if, for // example, your organization's policies require you to retain certain data for at - // least seven years (2555 days). If this parameter is not specified, Vault Lock - // will not enforce a minimum retention period. If this parameter is specified, any - // backup or copy job to the vault must have a lifecycle policy with a retention - // period equal to or longer than the minimum retention period. If the job's - // retention period is shorter than that minimum retention period, then the vault - // fails that backup or copy job, and you should either modify your lifecycle - // settings or use a different vault. The shortest minimum retention period you can - // specify is 1 day. Recovery points already saved in the vault prior to Vault Lock - // are not affected. + // least seven years (2555 days). + // + // If this parameter is not specified, Vault Lock will not enforce a minimum + // retention period. + // + // If this parameter is specified, any backup or copy job to the vault must have a + // lifecycle policy with a retention period equal to or longer than the minimum + // retention period. If the job's retention period is shorter than that minimum + // retention period, then the vault fails that backup or copy job, and you should + // either modify your lifecycle settings or use a different vault. The shortest + // minimum retention period you can specify is 1 day. Recovery points already saved + // in the vault prior to Vault Lock are not affected. MinRetentionDays *int64 noSmithyDocumentSerde diff --git a/service/backup/api_op_PutBackupVaultNotifications.go b/service/backup/api_op_PutBackupVaultNotifications.go index 69fdccbba5d..ebf26514860 100644 --- a/service/backup/api_op_PutBackupVaultNotifications.go +++ b/service/backup/api_op_PutBackupVaultNotifications.go @@ -30,17 +30,26 @@ func (c *Client) PutBackupVaultNotifications(ctx context.Context, params *PutBac 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 vault. + // + // For common use cases and code samples, see [Using Amazon SNS to track Backup events]. + // + // 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. // + // [Using Amazon SNS to track Backup events]: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html + // // This member is required. BackupVaultEvents []types.BackupVaultEvent diff --git a/service/backup/api_op_StartBackupJob.go b/service/backup/api_op_StartBackupJob.go index 85da6bea06c..6c9a45a9a39 100644 --- a/service/backup/api_op_StartBackupJob.go +++ b/service/backup/api_op_StartBackupJob.go @@ -51,16 +51,18 @@ type StartBackupJobInput struct { 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. + // 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. 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. + // // Like StartWindowMinutes , this parameter has a maximum value of 100 years // (52,560,000 minutes). CompleteWindowMinutes *int64 @@ -72,15 +74,20 @@ type StartBackupJobInput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup will transition and expire backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the - // “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. This parameter - // has a maximum value of 100 years (36,500 days). + // according to the lifecycle that you define. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // This parameter has a maximum value of 100 years (36,500 days). + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *types.Lifecycle // To help organize your resources, you can assign your own metadata to the @@ -90,7 +97,10 @@ type StartBackupJobInput struct { // A value in minutes after a backup is scheduled before a job will be canceled if // it doesn't start successfully. This value is optional, and the default is 8 // hours. If this value is included, it must be at least 60 minutes to avoid - // errors. This parameter has a maximum value of 100 years (52,560,000 minutes). + // errors. + // + // This parameter has a maximum value of 100 years (52,560,000 minutes). + // // During the start window, the backup job status remains in CREATED status until // it has successfully begun or until the start window time has run out. If within // the start window time Backup receives an error that allows the job to be @@ -118,8 +128,10 @@ type StartBackupJobOutput struct { // job. IsParent bool - // Note: This field is only returned for Amazon EFS and Advanced DynamoDB - // resources. An ARN that uniquely identifies a recovery point; for example, + // 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 // . RecoveryPointArn *string diff --git a/service/backup/api_op_StartCopyJob.go b/service/backup/api_op_StartCopyJob.go index 50f42436c95..dd5e940a8f9 100644 --- a/service/backup/api_op_StartCopyJob.go +++ b/service/backup/api_op_StartCopyJob.go @@ -12,8 +12,9 @@ import ( "time" ) -// Starts a job to create a one-time copy of the specified resource. Does not -// support continuous backups. +// Starts a job to create a one-time copy of the specified resource. +// +// Does not support continuous backups. func (c *Client) StartCopyJob(ctx context.Context, params *StartCopyJobInput, optFns ...func(*Options)) (*StartCopyJobOutput, error) { if params == nil { params = &StartCopyJobInput{} @@ -65,14 +66,19 @@ type StartCopyJobInput struct { IdempotencyToken *string // Contains an array of Transition objects specifying how long in days before a - // recovery point transitions to cold storage or is deleted. Backups transitioned - // to cold storage must be stored in cold storage for a minimum of 90 days. - // Therefore, on the console, the “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. + // recovery point transitions to cold storage or is deleted. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, on the console, the “retention” setting must be + // 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *types.Lifecycle noSmithyDocumentSerde diff --git a/service/backup/api_op_StartRestoreJob.go b/service/backup/api_op_StartRestoreJob.go index d8665a0c21b..e7a3deedb0f 100644 --- a/service/backup/api_op_StartRestoreJob.go +++ b/service/backup/api_op_StartRestoreJob.go @@ -29,26 +29,36 @@ func (c *Client) StartRestoreJob(ctx context.Context, params *StartRestoreJobInp 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 - // 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: + // 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 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, @@ -65,8 +75,9 @@ type StartRestoreJobInput struct { RecoveryPointArn *string // This is an optional parameter. If this equals True , tags included in the backup - // will be copied to the restored resource. This can only be applied to backups - // created through Backup. + // will be copied to the restored resource. + // + // This can only be applied to backups created through Backup. CopySourceTagsToRestoredResource bool // The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the @@ -79,20 +90,35 @@ type StartRestoreJobInput struct { 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) + // // - CloudFormation for CloudFormation + // // - 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 + // // - Redshift for Amazon Redshift + // // - Storage Gateway for Storage Gateway + // // - S3 for Amazon S3 + // // - Timestream for Amazon Timestream + // // - VirtualMachine for virtual machines ResourceType *string diff --git a/service/backup/api_op_StopBackupJob.go b/service/backup/api_op_StopBackupJob.go index c8be2fd908c..e3239895d26 100644 --- a/service/backup/api_op_StopBackupJob.go +++ b/service/backup/api_op_StopBackupJob.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attempts to cancel a job to create a one-time backup of a resource. This action -// is not supported for the following services: Amazon FSx for Windows File Server, -// Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, -// Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and -// Amazon Neptune. +// Attempts to cancel a job to create a one-time backup of a resource. +// +// This action is not supported for the following services: Amazon FSx for Windows +// File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for +// OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon +// Aurora, and Amazon Neptune. func (c *Client) StopBackupJob(ctx context.Context, params *StopBackupJobInput, optFns ...func(*Options)) (*StopBackupJobOutput, error) { if params == nil { params = &StopBackupJobInput{} diff --git a/service/backup/api_op_UpdateRecoveryPointLifecycle.go b/service/backup/api_op_UpdateRecoveryPointLifecycle.go index b72cd34d2b9..f767136a323 100644 --- a/service/backup/api_op_UpdateRecoveryPointLifecycle.go +++ b/service/backup/api_op_UpdateRecoveryPointLifecycle.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the transition lifecycle of a recovery point. The lifecycle defines when a -// protected resource is transitioned to cold storage and when it expires. Backup -// transitions and expires backups automatically according to the lifecycle that -// you define. Backups transitioned to cold storage must be stored in cold storage -// for a minimum of 90 days. Therefore, the “retention” setting must be 90 days -// 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) -// table. Backup ignores this expression for other resource types. This operation -// does not support continuous backups. +// Sets the transition lifecycle of a recovery point. +// +// The lifecycle defines when a protected resource is transitioned to cold storage +// and when it expires. Backup transitions and expires backups automatically +// according to the lifecycle that you define. +// +// Backups transitioned to cold storage must be stored in cold storage for a +// minimum of 90 days. Therefore, the “retention” setting must be 90 days 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]table. Backup ignores this +// expression for other resource types. +// +// This operation does not support continuous backups. +// +// [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *UpdateRecoveryPointLifecycleInput, optFns ...func(*Options)) (*UpdateRecoveryPointLifecycleOutput, error) { if params == nil { params = &UpdateRecoveryPointLifecycleInput{} @@ -58,11 +64,12 @@ type UpdateRecoveryPointLifecycleInput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the - // “retention” setting must be 90 days 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. + // according to the lifecycle that you define. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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. Lifecycle *types.Lifecycle noSmithyDocumentSerde @@ -80,14 +87,18 @@ type UpdateRecoveryPointLifecycleOutput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the - // “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. + // according to the lifecycle that you define. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *types.Lifecycle // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for diff --git a/service/backup/api_op_UpdateRegionSettings.go b/service/backup/api_op_UpdateRegionSettings.go index 507ba123f95..bf2050aaf74 100644 --- a/service/backup/api_op_UpdateRegionSettings.go +++ b/service/backup/api_op_UpdateRegionSettings.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the current service opt-in settings for the Region. Use the -// DescribeRegionSettings API to determine the resource types that are supported. +// Updates the current service opt-in settings for the 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{} @@ -30,15 +32,17 @@ 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], follow the procedure to [enable advanced DynamoDB backup programmatically] // . + // + // [Backup's advanced DynamoDB backup features]: https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html + // [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. - // If resource assignments are only based on tags, then service opt-in settings are - // applied. If a resource type is explicitly assigned to a backup plan, such as + // + // If resource assignments are only based on tags, then service opt-in settings + // are applied. If a resource type is explicitly assigned to a backup plan, such as // Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if // the opt-in is not enabled for that particular service. If both a resource type // and tags are specified in a resource assignment, the resource type specified in diff --git a/service/backup/api_op_UpdateReportPlan.go b/service/backup/api_op_UpdateReportPlan.go index 24ef1570c57..511c5569ddf 100644 --- a/service/backup/api_op_UpdateReportPlan.go +++ b/service/backup/api_op_UpdateReportPlan.go @@ -52,9 +52,12 @@ type UpdateReportPlanInput struct { ReportPlanDescription *string // Identifies the report template for the report. Reports are built using a report - // 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 + // 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 // by Amazon Web Services Regions and frameworks. ReportSetting *types.ReportSetting diff --git a/service/backup/api_op_UpdateRestoreTestingPlan.go b/service/backup/api_op_UpdateRestoreTestingPlan.go index 70af83255e5..0e03cd612f5 100644 --- a/service/backup/api_op_UpdateRestoreTestingPlan.go +++ b/service/backup/api_op_UpdateRestoreTestingPlan.go @@ -14,11 +14,17 @@ import ( // This request will send changes to your specified restore testing plan. // RestoreTestingPlanName cannot be updated after it is created. +// // RecoveryPointSelection can contain: +// // - Algorithm +// // - ExcludeVaults +// // - IncludeVaults +// // - RecoveryPointTypes +// // - SelectionWindowDays func (c *Client) UpdateRestoreTestingPlan(ctx context.Context, params *UpdateRestoreTestingPlanInput, optFns ...func(*Options)) (*UpdateRestoreTestingPlanOutput, error) { if params == nil { diff --git a/service/backup/api_op_UpdateRestoreTestingSelection.go b/service/backup/api_op_UpdateRestoreTestingSelection.go index 38e8bfff542..f999f6adf24 100644 --- a/service/backup/api_op_UpdateRestoreTestingSelection.go +++ b/service/backup/api_op_UpdateRestoreTestingSelection.go @@ -13,10 +13,11 @@ import ( ) // Most elements except the RestoreTestingSelectionName can be updated with this -// request. RestoreTestingSelection can use either protected resource ARNs or -// conditions, but not both. That is, if your selection has ProtectedResourceArns , -// requesting an update with the parameter ProtectedResourceConditions will be -// unsuccessful. +// request. +// +// RestoreTestingSelection can use either protected resource ARNs or conditions, +// but not both. That is, if your selection has ProtectedResourceArns , requesting +// an update with the parameter ProtectedResourceConditions will be unsuccessful. func (c *Client) UpdateRestoreTestingSelection(ctx context.Context, params *UpdateRestoreTestingSelectionInput, optFns ...func(*Options)) (*UpdateRestoreTestingSelectionOutput, error) { if params == nil { params = &UpdateRestoreTestingSelectionInput{} diff --git a/service/backup/doc.go b/service/backup/doc.go index c3da15acd47..a95c3895a76 100644 --- a/service/backup/doc.go +++ b/service/backup/doc.go @@ -3,8 +3,10 @@ // Package backup provides the API client, operations, and parameter types for AWS // Backup. // -// Backup Backup is a unified backup service designed to protect Amazon Web -// Services services and their associated data. Backup simplifies the creation, -// migration, restoration, and deletion of backups, while also providing reporting -// and auditing. +// # Backup +// +// Backup is a unified backup service designed to protect Amazon Web Services +// services and their associated data. Backup simplifies the creation, migration, +// restoration, and deletion of backups, while also providing reporting and +// auditing. package backup diff --git a/service/backup/options.go b/service/backup/options.go index b6d89e22e7b..ebdd294c8f4 100644 --- a/service/backup/options.go +++ b/service/backup/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/backup/types/enums.go b/service/backup/types/enums.go index 127aff200f2..d329687d254 100644 --- a/service/backup/types/enums.go +++ b/service/backup/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AggregationPeriod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationPeriod) Values() []AggregationPeriod { return []AggregationPeriod{ "ONE_DAY", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for BackupJobState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupJobState) Values() []BackupJobState { return []BackupJobState{ "CREATED", @@ -72,8 +74,9 @@ const ( ) // Values returns all known values for BackupJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupJobStatus) Values() []BackupJobStatus { return []BackupJobStatus{ "CREATED", @@ -114,8 +117,9 @@ const ( ) // Values returns all known values for BackupVaultEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupVaultEvent) Values() []BackupVaultEvent { return []BackupVaultEvent{ "BACKUP_JOB_STARTED", @@ -146,8 +150,9 @@ const ( ) // Values returns all known values for ConditionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConditionType) Values() []ConditionType { return []ConditionType{ "STRINGEQUALS", @@ -166,8 +171,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -196,8 +202,9 @@ const ( ) // Values returns all known values for CopyJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CopyJobStatus) Values() []CopyJobStatus { return []CopyJobStatus{ "CREATED", @@ -225,8 +232,9 @@ const ( ) // Values returns all known values for LegalHoldStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LegalHoldStatus) Values() []LegalHoldStatus { return []LegalHoldStatus{ "CREATING", @@ -247,8 +255,9 @@ const ( ) // Values returns all known values for RecoveryPointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoveryPointStatus) Values() []RecoveryPointStatus { return []RecoveryPointStatus{ "COMPLETED", @@ -268,8 +277,9 @@ const ( ) // Values returns all known values for RestoreDeletionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreDeletionStatus) Values() []RestoreDeletionStatus { return []RestoreDeletionStatus{ "DELETING", @@ -293,8 +303,9 @@ const ( ) // Values returns all known values for RestoreJobState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreJobState) Values() []RestoreJobState { return []RestoreJobState{ "CREATED", @@ -320,8 +331,9 @@ const ( ) // Values returns all known values for RestoreJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreJobStatus) Values() []RestoreJobStatus { return []RestoreJobStatus{ "PENDING", @@ -342,8 +354,9 @@ const ( // Values returns all known values for // RestoreTestingRecoveryPointSelectionAlgorithm. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreTestingRecoveryPointSelectionAlgorithm) Values() []RestoreTestingRecoveryPointSelectionAlgorithm { return []RestoreTestingRecoveryPointSelectionAlgorithm{ "LATEST_WITHIN_WINDOW", @@ -361,8 +374,9 @@ const ( // Values returns all known values for RestoreTestingRecoveryPointType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreTestingRecoveryPointType) Values() []RestoreTestingRecoveryPointType { return []RestoreTestingRecoveryPointType{ "CONTINUOUS", @@ -381,8 +395,9 @@ const ( ) // Values returns all known values for RestoreValidationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreValidationStatus) Values() []RestoreValidationStatus { return []RestoreValidationStatus{ "FAILED", @@ -402,8 +417,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -422,8 +438,9 @@ const ( ) // Values returns all known values for VaultState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VaultState) Values() []VaultState { return []VaultState{ "CREATING", @@ -441,8 +458,9 @@ const ( ) // Values returns all known values for VaultType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VaultType) Values() []VaultType { return []VaultType{ "BACKUP_VAULT", diff --git a/service/backup/types/types.go b/service/backup/types/types.go index 4d1b32d208b..d5b5ab99a53 100644 --- a/service/backup/types/types.go +++ b/service/backup/types/types.go @@ -11,20 +11,31 @@ import ( type AdvancedBackupSetting struct { // Specifies the backup option for a selected resource. This option is only - // available for Windows 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. 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) - // . + // available for Windows 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. + // + // 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]. + // + // [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 . + // Service (VSS). For a CloudFormation example, see the [sample CloudFormation template to enable Windows VSS]in the Backup User Guide. + // + // Valid values: EC2 . + // + // [sample CloudFormation template to enable Windows VSS]: https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html ResourceType *string noSmithyDocumentSerde @@ -40,10 +51,11 @@ type BackupJob struct { BackupJobId *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. If you specify an invalid option, you get an + // 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 // InvalidParameterValueException exception. BackupOptions map[string]string @@ -102,12 +114,17 @@ type BackupJob struct { // This is a boolean value indicating this is a parent (composite) backup job. IsParent bool - // This parameter is the job count for the specified message category. Example - // strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and - // INVALIDPARAMETERS . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of MessageCategory strings. The the value ANY returns count of all - // message categories. AGGREGATE_ALL aggregates job counts for all message - // categories and returns the sum. + // This parameter is the job count for the specified message category. + // + // Example strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and + // INVALIDPARAMETERS . See [Monitoring] for a list of MessageCategory strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // This uniquely identifies a request to Backup to back up a resource. The return @@ -156,6 +173,7 @@ type BackupJob struct { } // This is a summary of jobs created or running within the most recent 30 days. +// // The returned summary may contain the following: Region, Account, State, // RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. type BackupJobSummary struct { @@ -166,17 +184,24 @@ type BackupJobSummary struct { // The value as a number of jobs in a job summary. Count int32 - // The value of time in number format of a job end time. This value is the time in - // Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The value of time in number format of a job end time. + // + // This value is the time in Unix format, Coordinated Universal Time (UTC), and + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. EndTime *time.Time - // This parameter is the job count for the specified message category. Example - // strings include AccessDenied , Success , and InvalidParameters . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of MessageCategory strings. The the value ANY returns count of all - // message categories. AGGREGATE_ALL aggregates job counts for all message - // categories and returns the sum. + // This parameter is the job count for the specified message category. + // + // Example strings include AccessDenied , Success , and InvalidParameters . See [Monitoring] + // for a list of MessageCategory strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // The Amazon Web Services Regions within the job summary. @@ -186,10 +211,11 @@ type BackupJobSummary struct { // GetSupportedResourceTypes returns strings for supported resource types. ResourceType *string - // The value of time in number format of a job start time. This value is the time - // in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. - // For example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The value of time in number format of a job start time. + // + // This value is the time in Unix format, Coordinated Universal Time (UTC), and + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. StartTime *time.Time // This value is job count for jobs with the specified state. @@ -271,8 +297,9 @@ type BackupPlansListMember struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is - // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' - // characters. + // optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string // The date and time a backup plan is deleted, in Unix format and Coordinated @@ -338,14 +365,18 @@ type BackupRule struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the - // “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. + // according to the lifecycle that you define. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *Lifecycle // An array of key-value pair strings that are assigned to resources that are @@ -357,12 +388,13 @@ type BackupRule struct { 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) - // 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. + // more information about Amazon Web Services cron expressions, see [Schedule Expressions for Rules]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. + // + // [Schedule Expressions for Rules]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html ScheduleExpression *string // This is the timezone in which the schedule expression is set. By default, @@ -371,14 +403,15 @@ type BackupRule struct { // A value in minutes after a backup is scheduled before a job will be canceled if // it doesn't start successfully. This value is optional. If this value is - // included, it must be at least 60 minutes to avoid errors. During the start - // window, the backup job status remains in CREATED status until it has - // successfully begun or until the start window time has run out. If within the - // start window time Backup receives an error that allows the job to be retried, - // Backup will automatically retry to begin the job at least every 10 minutes until - // the backup successfully begins (the job status changes to RUNNING ) or until the - // job status changes to EXPIRED (which is expected to occur when the start window - // time is over). + // included, it must be at least 60 minutes to avoid errors. + // + // During the start window, the backup job status remains in CREATED status until + // it has successfully begun or until the start window time has run out. If within + // the start window time Backup receives an error that allows the job to be + // retried, Backup will automatically retry to begin the job at least every 10 + // minutes until the backup successfully begins (the job status changes to RUNNING + // ) or until the job status changes to EXPIRED (which is expected to occur when + // the start window time is over). StartWindowMinutes *int64 noSmithyDocumentSerde @@ -416,15 +449,20 @@ type BackupRuleInput struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup will transition and expire backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the - // “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. This parameter - // has a maximum value of 100 years (36,500 days). + // according to the lifecycle that you define. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // This parameter has a maximum value of 100 years (36,500 days). + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *Lifecycle // To help organize your resources, you can assign your own metadata to the @@ -440,23 +478,28 @@ type BackupRuleInput struct { // A value in minutes after a backup is scheduled before a job will be canceled if // it doesn't start successfully. This value is optional. If this value is - // included, it must be at least 60 minutes to avoid errors. This parameter has a - // maximum value of 100 years (52,560,000 minutes). During the start window, the - // backup job status remains in CREATED status until it has successfully begun or - // until the start window time has run out. If within the start window time Backup - // receives an error that allows the job to be retried, Backup will automatically - // retry to begin the job at least every 10 minutes until the backup successfully - // begins (the job status changes to RUNNING ) or until the job status changes to - // EXPIRED (which is expected to occur when the start window time is over). + // included, it must be at least 60 minutes to avoid errors. + // + // This parameter has a maximum value of 100 years (52,560,000 minutes). + // + // During the start window, the backup job status remains in CREATED status until + // it has successfully begun or until the start window time has run out. If within + // the start window time Backup receives an error that allows the job to be + // retried, Backup will automatically retry to begin the job at least every 10 + // minutes until the backup successfully begins (the job status changes to RUNNING + // ) or until the job status changes to EXPIRED (which is expected to occur when + // the start window time is over). StartWindowMinutes *int64 noSmithyDocumentSerde } -// 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. +// 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. type BackupSelection struct { // The ARN of the IAM role that Backup uses to authenticate when backing up the @@ -474,9 +517,13 @@ type BackupSelection struct { // A list of conditions that you define to assign resources to your backup plans // using tags. For example, "StringEquals": { "Key": // "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are - // case sensitive. Conditions differs from ListOfTags as follows: + // 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 . Conditions *Conditions @@ -484,25 +531,31 @@ type BackupSelection struct { // A list of conditions that you define to assign resources to your backup plans // using tags. For example, "StringEquals": { "Key": // "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are - // case sensitive. ListOfTags differs from Conditions as follows: + // 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 . ListOfTags []Condition // A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The - // maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If - // you need to exclude many resources from a backup plan, consider a different + // maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. + // + // If you need to exclude many resources from a backup plan, consider a different // resource selection strategy, such as assigning only one or a few resource types // or refining your resource selection using tags. NotResources []string // A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum - // number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need - // to assign many resources to a backup plan, consider a different resource - // selection strategy, such as assigning all resources of a resource type or - // refining your resource selection using tags. + // number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. + // + // If you need to assign many resources to a backup plan, consider a different + // resource selection strategy, such as assigning all resources of a resource type + // or refining your resource selection using tags. Resources []string noSmithyDocumentSerde @@ -522,8 +575,9 @@ type BackupSelectionsListMember struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is - // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' - // characters. + // optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string // Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery @@ -560,27 +614,34 @@ type BackupVaultListMember struct { // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is - // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' - // characters. + // optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string // 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 // 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) + // 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] + // + // [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, - // meaning it cannot be changed or deleted. If you applied Vault Lock to your vault - // without specifying a lock date, you can change your Vault Lock settings, or - // delete Vault Lock from the vault entirely, at any time. This value is in Unix - // format, Coordinated Universal Time (UTC), and accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // meaning it cannot be changed or deleted. + // + // If you applied Vault Lock to your vault without specifying a lock date, you can + // change your Vault Lock settings, or delete Vault Lock from the vault entirely, + // at any time. + // + // This value is in Unix format, Coordinated Universal Time (UTC), and accurate to + // milliseconds. For example, the value 1516925490.087 represents Friday, January + // 26, 2018 12:11:30.087 AM. LockDate *time.Time // A Boolean value that indicates whether Backup Vault Lock applies to the @@ -591,24 +652,26 @@ type BackupVaultListMember struct { // The Backup Vault Lock setting that specifies the maximum retention period that // the vault retains its recovery points. If this parameter is not specified, Vault // Lock does not enforce a maximum retention period on the recovery points in the - // vault (allowing indefinite storage). If specified, any backup or copy job to the - // vault must have a lifecycle policy with a retention period equal to or shorter - // than the maximum retention period. If the job's retention period is longer than - // that maximum retention period, then the vault fails the backup or copy job, and - // you should either modify your lifecycle settings or use a different vault. - // Recovery points already stored in the vault prior to Vault Lock are not - // affected. + // vault (allowing indefinite storage). + // + // If specified, any backup or copy job to the vault must have a lifecycle policy + // with a retention period equal to or shorter than the maximum retention period. + // If the job's retention period is longer than that maximum retention period, then + // the vault fails the backup or copy job, and you should either modify your + // lifecycle settings or use a different vault. Recovery points already stored in + // the vault prior to Vault Lock are not affected. MaxRetentionDays *int64 // The Backup Vault Lock setting that specifies the minimum retention period that // the vault retains its recovery points. If this parameter is not specified, Vault - // Lock does not enforce a minimum retention period. If specified, any backup or - // copy job to the vault must have a lifecycle policy with a retention period equal - // to or longer than the minimum retention period. If the job's retention period is - // shorter than that minimum retention period, then the vault fails the backup or - // copy job, and you should either modify your lifecycle settings or use a - // different vault. Recovery points already stored in the vault prior to Vault Lock - // are not affected. + // Lock does not enforce a minimum retention period. + // + // If specified, any backup or copy job to the vault must have a lifecycle policy + // with a retention period equal to or longer than the minimum retention period. If + // the job's retention period is shorter than that minimum retention period, then + // the vault fails the backup or copy job, and you should either modify your + // lifecycle settings or use a different vault. Recovery points already stored in + // the vault prior to Vault Lock are not affected. MinRetentionDays *int64 // The number of recovery points that are stored in a backup vault. @@ -618,16 +681,22 @@ type BackupVaultListMember struct { } // Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify -// a lifecycle for a recovery point. The lifecycle defines when a protected -// resource is transitioned to cold storage and when it expires. Backup transitions -// and expires backups automatically according to the lifecycle that you define. +// a lifecycle for a recovery point. +// +// The lifecycle defines when a protected resource is transitioned to cold storage +// and when it expires. Backup transitions and expires backups automatically +// according to the lifecycle that you define. +// // Backups transitioned to cold storage must be stored in cold storage for a // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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) -// table. Backup ignores this expression for other resource types. +// the "Lifecycle to cold storage" section of the [Feature availability by resource]table. Backup ignores this +// expression for other resource types. +// +// [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource type CalculatedLifecycle struct { // A timestamp that specifies when to delete a recovery point. @@ -653,8 +722,9 @@ type Condition struct { // 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]BackupSelection . + // + // [BackupSelection]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html // // This member is required. ConditionType ConditionType @@ -726,9 +796,10 @@ type ControlInputParameter struct { // scope. The control scope can include one or more resource types, a combination // of a tag key and value, or a combination of one resource type and one resource // 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 . +// 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 . type ControlScope struct { // The ID of the only Amazon Web Services resource that you want your control @@ -759,14 +830,19 @@ type CopyAction struct { DestinationBackupVaultArn *string // Contains an array of Transition objects specifying how long in days before a - // recovery point transitions to cold storage or is deleted. Backups transitioned - // to cold storage must be stored in cold storage for a minimum of 90 days. - // Therefore, on the console, the “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. + // recovery point transitions to cold storage or is deleted. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, on the console, the “retention” setting must be + // 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *Lifecycle noSmithyDocumentSerde @@ -792,8 +868,9 @@ 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) - // within a stack. + // transferred from the [logical ID]within a stack. + // + // [logical ID]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax CompositeMemberIdentifier *string // Uniquely identifies a copy job. @@ -825,12 +902,17 @@ type CopyJob struct { // This is a boolean value indicating this is a parent (composite) copy job. IsParent bool - // This parameter is the job count for the specified message category. Example - // strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and - // InvalidParameters . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of MessageCategory strings. The the value ANY returns count of all - // message categories. AGGREGATE_ALL aggregates job counts for all message - // categories and returns the sum + // This parameter is the job count for the specified message category. + // + // Example strings may include AccessDenied , SUCCESS , AGGREGATE_ALL , and + // InvalidParameters . See [Monitoring] for a list of MessageCategory strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // This is the number of child (nested) copy jobs. @@ -873,7 +955,9 @@ type CopyJob struct { } // This is a summary of copy jobs created or running within the most recent 30 -// days. The returned summary may contain the following: Region, Account, State, +// days. +// +// The returned summary may contain the following: Region, Account, State, // RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. type CopyJobSummary struct { @@ -883,17 +967,24 @@ type CopyJobSummary struct { // The value as a number of jobs in a job summary. Count int32 - // The value of time in number format of a job end time. This value is the time in - // Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The value of time in number format of a job end time. + // + // This value is the time in Unix format, Coordinated Universal Time (UTC), and + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. EndTime *time.Time - // This parameter is the job count for the specified message category. Example - // strings include AccessDenied , Success , and InvalidParameters . See Monitoring (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) - // for a list of MessageCategory strings. The the value ANY returns count of all - // message categories. AGGREGATE_ALL aggregates job counts for all message - // categories and returns the sum. + // This parameter is the job count for the specified message category. + // + // Example strings include AccessDenied , Success , and InvalidParameters . See [Monitoring] + // for a list of MessageCategory strings. + // + // The the value ANY returns count of all message categories. + // + // AGGREGATE_ALL aggregates job counts for all message categories and returns the + // sum. + // + // [Monitoring]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html MessageCategory *string // This is the Amazon Web Services Regions within the job summary. @@ -903,10 +994,11 @@ type CopyJobSummary struct { // GetSupportedResourceTypes returns strings for supported resource types ResourceType *string - // The value of time in number format of a job start time. This value is the time - // in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. - // For example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The value of time in number format of a job start time. + // + // This value is the time in Unix format, Coordinated Universal Time (UTC), and + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. StartTime *time.Time // This value is job count for jobs with the specified state. @@ -916,22 +1008,25 @@ type CopyJobSummary struct { } // This is a resource filter containing FromDate: DateTime and ToDate: DateTime. -// Both values are required. Future DateTime values are not permitted. The date and -// time are in Unix format and Coordinated Universal Time (UTC), and it is accurate -// to milliseconds ((milliseconds are optional). For example, the value -// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. +// Both values are required. Future DateTime values are not permitted. +// +// The date and time are in Unix format and Coordinated Universal Time (UTC), and +// it is accurate to milliseconds ((milliseconds are optional). For example, the +// value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. type DateRange struct { - // This value is the beginning date, inclusive. The date and time are in Unix - // format and Coordinated Universal Time (UTC), and it is accurate to milliseconds - // (milliseconds are optional). + // This value is the beginning date, inclusive. + // + // The date and time are in Unix format and Coordinated Universal Time (UTC), and + // it is accurate to milliseconds (milliseconds are optional). // // This member is required. FromDate *time.Time - // This value is the end date, inclusive. The date and time are in Unix format and - // Coordinated Universal Time (UTC), and it is accurate to milliseconds - // (milliseconds are optional). + // This value is the end date, inclusive. + // + // The date and time are in Unix format and Coordinated Universal Time (UTC), and + // it is accurate to milliseconds (milliseconds are optional). // // This member is required. ToDate *time.Time @@ -950,8 +1045,10 @@ type Framework struct { // hours behind UTC. CreationTime *time.Time - // The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | - // UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED + // The deployment status of a framework. The statuses are: + // + // CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | + // FAILED DeploymentStatus *string // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format @@ -986,8 +1083,11 @@ 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 . (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html) + // backup plans with a specific tag, or all backup plans. + // + // For more information, see [ControlScope.]ControlScope + // + // [ControlScope.]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html ControlScope *ControlScope noSmithyDocumentSerde @@ -998,15 +1098,20 @@ type FrameworkControl struct { // _ : / type KeyValue struct { - // The tag key (String). The key can't start with aws: . Length Constraints: - // Minimum length of 1. Maximum length of 128. Pattern: - // ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$ + // The tag key (String). The key can't start with aws: . + // + // Length Constraints: Minimum length of 1. Maximum length of 128. + // + // Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$ // // This member is required. Key *string - // The value of the key. Length Constraints: Maximum length of 256. Pattern: - // ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + // The value of the key. + // + // Length Constraints: Maximum length of 256. + // + // Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ // // This member is required. Value *string @@ -1052,14 +1157,19 @@ type LegalHold struct { } // Contains an array of Transition objects specifying how long in days before a -// recovery point transitions to cold storage or is deleted. Backups transitioned -// to cold storage must be stored in cold storage for a minimum of 90 days. -// Therefore, on the console, the “retention” setting must be 90 days 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) -// table. Backup ignores this expression for other resource types. +// recovery point transitions to cold storage or is deleted. +// +// Backups transitioned to cold storage must be stored in cold storage for a +// minimum of 90 days. Therefore, on the console, the “retention” setting must be +// 90 days 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]table. Backup ignores this +// expression for other resource types. +// +// [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource type Lifecycle struct { // Specifies the number of days after creation that a recovery point is deleted. @@ -1112,9 +1222,10 @@ type ProtectedResource struct { } // A list of conditions that you define for resources in your restore testing plan -// using tags. For example, "StringEquals": { "Key": -// "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are -// case sensitive. +// using tags. +// +// For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": +// "true" }, . Condition operators are case sensitive. type ProtectedResourceConditions struct { // Filters the values of your tagged resources for only those resources that you @@ -1157,8 +1268,9 @@ type RecoveryPointByBackupVault 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) - // within a stack. + // transferred from the [logical ID]within a stack. + // + // [logical ID]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax CompositeMemberIdentifier *string // Contains identifying information about the creation of a recovery point, @@ -1196,14 +1308,18 @@ type RecoveryPointByBackupVault struct { // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically - // according to the lifecycle that you define. Backups transitioned to cold storage - // must be stored in cold storage for a minimum of 90 days. Therefore, the - // “retention” setting must be 90 days 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) - // table. Backup ignores this expression for other resource types. + // according to the lifecycle that you define. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Therefore, the “retention” setting must be 90 days 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]table. Backup ignores this + // expression for other resource types. + // + // [Feature availability by resource]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource Lifecycle *Lifecycle // This is the Amazon Resource Name (ARN) of the parent (composite) recovery point. @@ -1347,10 +1463,11 @@ type RecoveryPointMember struct { type RecoveryPointSelection struct { // This is a resource filter containing FromDate: DateTime and ToDate: DateTime. - // Both values are required. Future DateTime values are not permitted. The date and - // time are in Unix format and Coordinated Universal Time (UTC), and it is accurate - // to milliseconds ((milliseconds are optional). For example, the value - // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + // Both values are required. Future DateTime values are not permitted. + // + // The date and time are in Unix format and Coordinated Universal Time (UTC), and + // it is accurate to milliseconds ((milliseconds are optional). For example, the + // value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. DateRange *DateRange // These are the resources included in the resource selection (including type of @@ -1429,15 +1546,18 @@ type ReportJob struct { ReportPlanArn *string // Identifies the report template for the report. Reports are built using a report - // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | - // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | - // RESTORE_JOB_REPORT + // template. The report templates are: + // + // RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | + // COPY_JOB_REPORT | RESTORE_JOB_REPORT ReportTemplate *string - // The status of a report job. The statuses are: CREATED | RUNNING | COMPLETED | - // 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. + // The status of a report job. The statuses are: + // + // CREATED | RUNNING | COMPLETED | 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 // A message explaining the status of the report job. @@ -1455,8 +1575,9 @@ type ReportPlan struct { // 12:11:30.087 AM. CreationTime *time.Time - // The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | - // UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED + // The deployment status of a report plan. The statuses are: + // + // CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED DeploymentStatus *string // The date and time that a report job associated with this report plan last @@ -1488,9 +1609,12 @@ type ReportPlan struct { ReportPlanName *string // Identifies the report template for the report. Reports are built using a report - // 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 + // 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 // by Amazon Web Services Regions and frameworks. ReportSetting *ReportSetting @@ -1502,9 +1626,10 @@ type ReportPlan struct { type ReportSetting struct { // Identifies the report template for the report. Reports are built using a report - // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | - // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | - // RESTORE_JOB_REPORT + // template. The report templates are: + // + // RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | + // COPY_JOB_REPORT | RESTORE_JOB_REPORT // // This member is required. ReportTemplate *string @@ -1618,7 +1743,9 @@ type RestoreJobsListMember struct { } // This is a summary of restore jobs created or running within the most recent 30 -// days. The returned summary may contain the following: Region, Account, State, +// days. +// +// The returned summary may contain the following: Region, Account, State, // ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. type RestoreJobSummary struct { @@ -1628,10 +1755,11 @@ type RestoreJobSummary struct { // The value as a number of jobs in a job summary. Count int32 - // The value of time in number format of a job end time. This value is the time in - // Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For - // example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The value of time in number format of a job end time. + // + // This value is the time in Unix format, Coordinated Universal Time (UTC), and + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. EndTime *time.Time // The Amazon Web Services Regions within the job summary. @@ -1641,10 +1769,11 @@ type RestoreJobSummary struct { // GetSupportedResourceTypes returns strings for supported resource types. ResourceType *string - // The value of time in number format of a job start time. This value is the time - // in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. - // For example, the value 1516925490.087 represents Friday, January 26, 2018 - // 12:11:30.087 AM. + // The value of time in number format of a job start time. + // + // This value is the time in Unix format, Coordinated Universal Time (UTC), and + // accurate to milliseconds. For example, the value 1516925490.087 represents + // Friday, January 26, 2018 12:11:30.087 AM. StartTime *time.Time // This value is job count for jobs with the specified state. @@ -1680,10 +1809,11 @@ type RestoreTestingPlanForCreate struct { // timezone. ScheduleExpressionTimezone *string - // Defaults to 24 hours. A value in hours after a restore test is scheduled before - // a job will be canceled if it doesn't start successfully. This value is optional. - // If this value is included, this parameter has a maximum value of 168 hours (one - // week). + // Defaults to 24 hours. + // + // A value in hours after a restore test is scheduled before a job will be + // canceled if it doesn't start successfully. This value is optional. If this value + // is included, this parameter has a maximum value of 168 hours (one week). StartWindowHours int32 noSmithyDocumentSerde @@ -1724,8 +1854,9 @@ type RestoreTestingPlanForGet struct { // This 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. + // This parameter is optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string // The last time a restore test was run with the specified restore testing plan. A @@ -1745,10 +1876,11 @@ type RestoreTestingPlanForGet struct { // timezone. ScheduleExpressionTimezone *string - // Defaults to 24 hours. A value in hours after a restore test is scheduled before - // a job will be canceled if it doesn't start successfully. This value is optional. - // If this value is included, this parameter has a maximum value of 168 hours (one - // week). + // Defaults to 24 hours. + // + // A value in hours after a restore test is scheduled before a job will be + // canceled if it doesn't start successfully. This value is optional. If this value + // is included, this parameter has a maximum value of 168 hours (one week). StartWindowHours int32 noSmithyDocumentSerde @@ -1797,10 +1929,11 @@ type RestoreTestingPlanForList struct { // timezone. ScheduleExpressionTimezone *string - // Defaults to 24 hours. A value in hours after a restore test is scheduled before - // a job will be canceled if it doesn't start successfully. This value is optional. - // If this value is included, this parameter has a maximum value of 168 hours (one - // week). + // Defaults to 24 hours. + // + // A value in hours after a restore test is scheduled before a job will be + // canceled if it doesn't start successfully. This value is optional. If this value + // is included, this parameter has a maximum value of 168 hours (one week). StartWindowHours int32 noSmithyDocumentSerde @@ -1810,6 +1943,7 @@ type RestoreTestingPlanForList struct { type RestoreTestingPlanForUpdate struct { // Required: Algorithm ; RecoveryPointTypes ; IncludeVaults (one or more). + // // Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults // to empty list if not listed). RecoveryPointSelection *RestoreTestingRecoveryPointSelection @@ -1822,10 +1956,11 @@ type RestoreTestingPlanForUpdate struct { // timezone. ScheduleExpressionTimezone *string - // Defaults to 24 hours. A value in hours after a restore test is scheduled before - // a job will be canceled if it doesn't start successfully. This value is optional. - // If this value is included, this parameter has a maximum value of 168 hours (one - // week). + // Defaults to 24 hours. + // + // A value in hours after a restore test is scheduled before a job will be + // canceled if it doesn't start successfully. This value is optional. If this value + // is included, this parameter has a maximum value of 168 hours (one week). StartWindowHours int32 noSmithyDocumentSerde @@ -1858,16 +1993,23 @@ type RestoreTestingRecoveryPointSelection struct { } // This contains metadata about a specific restore testing selection. -// ProtectedResourceType is required, such as Amazon EBS or Amazon EC2. This -// consists of RestoreTestingSelectionName , ProtectedResourceType , and one of the -// following: +// +// ProtectedResourceType is required, such as Amazon EBS or Amazon EC2. +// +// This consists of RestoreTestingSelectionName , ProtectedResourceType , and one +// of the following: +// // - ProtectedResourceArns +// // - ProtectedResourceConditions // -// Each protected resource type can have one single value. A restore testing -// selection can include a wildcard value ("*") for ProtectedResourceArns along -// with ProtectedResourceConditions . Alternatively, you can include up to 30 -// specific protected resource ARNs in ProtectedResourceArns . +// Each protected resource type can have one single value. +// +// A restore testing selection can include a wildcard value ("*") for +// ProtectedResourceArns along with ProtectedResourceConditions . Alternatively, +// you can include up to 30 specific protected resource ARNs in +// ProtectedResourceArns . +// // ProtectedResourceConditions examples include as StringEquals and StringNotEquals // . type RestoreTestingSelectionForCreate struct { @@ -1880,16 +2022,27 @@ type RestoreTestingSelectionForCreate struct { // The type of Amazon Web Services resource included in a restore testing // selection; for example, an Amazon EBS volume or an Amazon RDS database. + // // Supported resource types accepted include: + // // - 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 + // // - S3 for Amazon S3 // // This member is required. @@ -1913,8 +2066,11 @@ type RestoreTestingSelectionForCreate struct { // You can override certain restore metadata keys by including the parameter // RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are - // not case sensitive. See the complete list of restore testing inferred metadata (https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html) - // . + // not case sensitive. + // + // See the complete list of [restore testing inferred metadata]. + // + // [restore testing inferred metadata]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html RestoreMetadataOverrides map[string]string // This is amount of hours (1 to 168) available to run a validation script on the @@ -1963,8 +2119,9 @@ type RestoreTestingSelectionForGet struct { // This 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. + // This parameter is optional. + // + // If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. CreatorRequestId *string // You can include specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", @@ -1978,8 +2135,11 @@ type RestoreTestingSelectionForGet struct { // You can override certain restore metadata keys by including the parameter // RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are - // not case sensitive. See the complete list of restore testing inferred metadata (https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html) - // . + // not case sensitive. + // + // See the complete list of [restore testing inferred metadata]. + // + // [restore testing inferred metadata]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html RestoreMetadataOverrides map[string]string // This is amount of hours (1 to 168) available to run a validation script on the @@ -2013,9 +2173,10 @@ type RestoreTestingSelectionForList struct { // This member is required. ProtectedResourceType *string - // Unique string that is the name of the restore testing plan. The name cannot be - // changed after creation. The name must consist of only alphanumeric characters - // and underscores. Maximum length is 50. + // Unique string that is the name of the restore testing plan. + // + // The name cannot be changed after creation. The name must consist of only + // alphanumeric characters and underscores. Maximum length is 50. // // This member is required. RestoreTestingPlanName *string @@ -2026,8 +2187,10 @@ type RestoreTestingSelectionForList struct { RestoreTestingSelectionName *string // This value represents the time, in hours, data is retained after a restore test - // so that optional validation can be completed. Accepted value is an integer - // between 0 and 168 (the hourly equivalent of seven days). + // so that optional validation can be completed. + // + // Accepted value is an integer between 0 and 168 (the hourly equivalent of seven + // days). ValidationWindowHours int32 noSmithyDocumentSerde @@ -2046,20 +2209,26 @@ type RestoreTestingSelectionForUpdate struct { ProtectedResourceArns []string // A list of conditions that you define for resources in your restore testing plan - // using tags. For example, "StringEquals": { "Key": - // "aws:ResourceTag/CreatedByCryo", "Value": "true" }, . Condition operators are - // case sensitive. + // using tags. + // + // For example, "StringEquals": { "Key": "aws:ResourceTag/CreatedByCryo", "Value": + // "true" }, . Condition operators are case sensitive. ProtectedResourceConditions *ProtectedResourceConditions // You can override certain restore metadata keys by including the parameter // RestoreMetadataOverrides in the body of RestoreTestingSelection . Key values are - // not case sensitive. See the complete list of restore testing inferred metadata (https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html) - // . + // not case sensitive. + // + // See the complete list of [restore testing inferred metadata]. + // + // [restore testing inferred metadata]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html RestoreMetadataOverrides map[string]string // This value represents the time, in hours, data is retained after a restore test - // so that optional validation can be completed. Accepted value is an integer - // between 0 and 168 (the hourly equivalent of seven days). + // so that optional validation can be completed. + // + // Accepted value is an integer between 0 and 168 (the hourly equivalent of seven + // days). ValidationWindowHours int32 noSmithyDocumentSerde diff --git a/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go b/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go index 6597bfe27f7..dd14a57fddd 100644 --- a/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go +++ b/service/backupgateway/api_op_GetBandwidthRateLimitSchedule.go @@ -32,9 +32,10 @@ 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) - // 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]ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. + // + // [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html // // This member is required. GatewayArn *string @@ -48,9 +49,10 @@ 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) - // 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]ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. + // + // [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html GatewayArn *string // Metadata pertaining to the operation's result. diff --git a/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go b/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go index 3735093a0fa..be87c35b0fc 100644 --- a/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go +++ b/service/backupgateway/api_op_PutBandwidthRateLimitSchedule.go @@ -38,9 +38,10 @@ 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) - // 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]ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. + // + // [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html // // This member is required. GatewayArn *string @@ -50,9 +51,10 @@ 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) - // 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]ListGateways operation + // to return a list of gateways for your account and Amazon Web Services Region. + // + // [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html GatewayArn *string // Metadata pertaining to the operation's result. diff --git a/service/backupgateway/api_op_PutMaintenanceStartTime.go b/service/backupgateway/api_op_PutMaintenanceStartTime.go index ed347886af1..9141e32a235 100644 --- a/service/backupgateway/api_op_PutMaintenanceStartTime.go +++ b/service/backupgateway/api_op_PutMaintenanceStartTime.go @@ -44,8 +44,9 @@ type PutMaintenanceStartTimeInput struct { // This member is required. MinuteOfHour *int32 - // The day of the month start maintenance on a gateway. Valid values range from - // Sunday to Saturday . + // The day of the month start maintenance on a gateway. + // + // Valid values range from Sunday to Saturday . DayOfMonth *int32 // The day of the week to start maintenance on a gateway. diff --git a/service/backupgateway/api_op_UpdateGatewaySoftwareNow.go b/service/backupgateway/api_op_UpdateGatewaySoftwareNow.go index 3820f7b6cbe..56f8d65b830 100644 --- a/service/backupgateway/api_op_UpdateGatewaySoftwareNow.go +++ b/service/backupgateway/api_op_UpdateGatewaySoftwareNow.go @@ -11,9 +11,10 @@ import ( ) // Updates the gateway virtual machine (VM) software. The request immediately -// triggers the software update. When you make this request, you get a 200 OK -// success response immediately. However, it might take some time for the update to -// complete. +// triggers the software update. +// +// When you make this request, you get a 200 OK success response immediately. +// However, it might take some time for the update to complete. func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGatewaySoftwareNowInput, optFns ...func(*Options)) (*UpdateGatewaySoftwareNowOutput, error) { if params == nil { params = &UpdateGatewaySoftwareNowInput{} diff --git a/service/backupgateway/doc.go b/service/backupgateway/doc.go index 07758dbfc18..f75cd1e8163 100644 --- a/service/backupgateway/doc.go +++ b/service/backupgateway/doc.go @@ -3,14 +3,19 @@ // Package backupgateway provides the API client, operations, and parameter types // for AWS Backup Gateway. // -// Backup gateway Backup gateway connects Backup to your hypervisor, so you can -// create, store, and restore backups of your virtual machines (VMs) anywhere, -// whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services. Add -// on-premises resources by connecting to a hypervisor through a gateway. Backup -// will automatically discover the resources in your hypervisor. Use Backup to -// assign virtual or on-premises resources to a backup plan, or run on-demand -// backups. Once you have backed up your resources, you can view them and restore -// them like any resource supported by Backup. To download the Amazon Web Services -// software to get started, navigate to the Backup console, choose Gateways, then -// choose Create gateway. +// # Backup gateway +// +// Backup gateway connects Backup to your hypervisor, so you can create, store, +// and restore backups of your virtual machines (VMs) anywhere, whether on-premises +// or in the VMware Cloud (VMC) on Amazon Web Services. +// +// Add on-premises resources by connecting to a hypervisor through a gateway. +// Backup will automatically discover the resources in your hypervisor. +// +// Use Backup to assign virtual or on-premises resources to a backup plan, or run +// on-demand backups. Once you have backed up your resources, you can view them and +// restore them like any resource supported by Backup. +// +// To download the Amazon Web Services software to get started, navigate to the +// Backup console, choose Gateways, then choose Create gateway. package backupgateway diff --git a/service/backupgateway/options.go b/service/backupgateway/options.go index ebb2d074e92..7faf76bfd0d 100644 --- a/service/backupgateway/options.go +++ b/service/backupgateway/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/backupgateway/types/enums.go b/service/backupgateway/types/enums.go index bd4ee430460..f5031e5e8f0 100644 --- a/service/backupgateway/types/enums.go +++ b/service/backupgateway/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for GatewayType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayType) Values() []GatewayType { return []GatewayType{ "BACKUP_VM", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for HypervisorState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HypervisorState) Values() []HypervisorState { return []HypervisorState{ "PENDING", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for SyncMetadataStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncMetadataStatus) Values() []SyncMetadataStatus { return []SyncMetadataStatus{ "CREATED", diff --git a/service/backupgateway/types/types.go b/service/backupgateway/types/types.go index d1f0cc391d2..9008b2de458 100644 --- a/service/backupgateway/types/types.go +++ b/service/backupgateway/types/types.go @@ -26,9 +26,10 @@ type BandwidthRateLimitInterval struct { // This member is required. EndHourOfDay *int32 - // 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 . + // 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 . // // This member is required. EndMinuteOfHour *int32 @@ -47,7 +48,9 @@ type BandwidthRateLimitInterval struct { // 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) . + // rate limit is not set. + // + // For Backup Gateway, the minimum value is (Value) . AverageUploadRateLimitInBitsPerSec *int64 noSmithyDocumentSerde @@ -113,9 +116,10 @@ type GatewayDetails struct { noSmithyDocumentSerde } -// Represents the hypervisor's permissions to which the gateway will connect. A -// hypervisor is hardware, software, or firmware that creates and manages virtual -// machines, and allocates resources to them. +// Represents the hypervisor's permissions to which the gateway will connect. +// +// A hypervisor is hardware, software, or firmware that creates and manages +// virtual machines, and allocates resources to them. type Hypervisor struct { // The server host of the hypervisor. This can be either an IP address or a @@ -169,8 +173,9 @@ type HypervisorDetails struct { // This is the name of the specified hypervisor. Name *string - // This is the current state of the specified hypervisor. The possible states are - // PENDING , ONLINE , OFFLINE , or ERROR . + // This is the current state of the specified hypervisor. + // + // The possible states are PENDING , ONLINE , OFFLINE , or ERROR . State HypervisorState noSmithyDocumentSerde @@ -281,10 +286,12 @@ 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] 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. +// +// [tag]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html type VmwareTag struct { // The is the category of VMware. diff --git a/service/backupstorage/options.go b/service/backupstorage/options.go index 83701b74b14..12c399a8ae0 100644 --- a/service/backupstorage/options.go +++ b/service/backupstorage/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/backupstorage/types/enums.go b/service/backupstorage/types/enums.go index 66c07f3ca85..1a202364584 100644 --- a/service/backupstorage/types/enums.go +++ b/service/backupstorage/types/enums.go @@ -10,8 +10,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SHA256", @@ -27,6 +28,7 @@ const ( // 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{ diff --git a/service/batch/api_op_CancelJob.go b/service/batch/api_op_CancelJob.go index d6d07458b88..eb4d360de2b 100644 --- a/service/batch/api_op_CancelJob.go +++ b/service/batch/api_op_CancelJob.go @@ -12,14 +12,18 @@ import ( // Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING // 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 . A PENDING job is -// canceled after all dependency jobs are completed. Therefore, it may take longer -// than expected to cancel a job in PENDING status. When you try to cancel an -// array parent job in PENDING , Batch attempts to cancel all child jobs. The array -// parent job is canceled when all child jobs are completed. 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. +// of the job queue. Then the job status is updated to FAILED . +// +// A PENDING job is canceled after all dependency jobs are completed. Therefore, +// it may take longer than expected to cancel a job in PENDING status. +// +// When you try to cancel an array parent job in PENDING , Batch attempts to cancel +// all child jobs. The array parent job is canceled when all child jobs are +// completed. +// +// 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 TerminateJoboperation. func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { params = &CancelJobInput{} @@ -44,8 +48,8 @@ type CancelJobInput struct { JobId *string // A message to attach to the job that explains the reason for canceling it. This - // message is returned by future DescribeJobs operations on the job. This message - // is also recorded in the Batch activity logs. + // message is returned by future DescribeJobsoperations on the job. This message is also + // recorded in the Batch activity logs. // // This member is required. Reason *string diff --git a/service/batch/api_op_CreateComputeEnvironment.go b/service/batch/api_op_CreateComputeEnvironment.go index 12cb1fcd62c..71048823487 100644 --- a/service/batch/api_op_CreateComputeEnvironment.go +++ b/service/batch/api_op_CreateComputeEnvironment.go @@ -14,56 +14,67 @@ 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) -// 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 -// optionally set a maximum price so that Spot Instances only launch when the Spot -// Instance price is less than a specified percentage of the On-Demand price. -// Multi-node parallel jobs aren't supported on Spot Instances. In an unmanaged -// compute environment, you can manage your own EC2 compute resources and have -// 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) -// 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) -// 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 -// 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. -// This includes any updates and security patches. You're also responsible for any +// resource specification that you define or the [launch template]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 optionally set a maximum price so that +// Spot Instances only launch when the Spot Instance price is less than a specified +// percentage of the On-Demand price. +// +// Multi-node parallel jobs aren't supported on Spot Instances. +// +// In an unmanaged compute environment, you can manage your own EC2 compute +// resources and have 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]in the Amazon Elastic Container Service Developer Guide. After +// you created your unmanaged compute environment, you can use the DescribeComputeEnvironmentsoperation 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]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 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. This +// includes any updates and security patches. You're also responsible for any // 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. // // 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: +// For more information, see [Updating compute environments]. 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 , SPOT_CAPACITY_OPTIMIZED , or // SPOT_PRICE_CAPACITY_OPTIMIZED . +// // - Set the update to latest image version ( updateToLatestImageVersion ) // parameter to true . The updateToLatestImageVersion parameter is used when you // update a compute environment. This parameter is ignored when you create a // compute environment. -// - 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 +// +// - Don't specify an AMI ID in imageId , imageIdOverride (in [ec2Configuration]ec2Configuration ), +// 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 @@ -79,6 +90,12 @@ import ( // 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. +// +// [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html +// [launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html +// [Launching an Amazon ECS container instance]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html +// [ec2Configuration]: https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html +// [container instance AMIs]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html func (c *Client) CreateComputeEnvironment(ctx context.Context, params *CreateComputeEnvironmentInput, optFns ...func(*Options)) (*CreateComputeEnvironmentOutput, error) { if params == nil { params = &CreateComputeEnvironmentInput{} @@ -105,16 +122,18 @@ type CreateComputeEnvironmentInput struct { 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) - // in the Batch User Guide. + // information, see [Compute Environments]in the Batch User Guide. + // + // [Compute Environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html // // This member is required. Type types.CEType // 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) - // in the Batch User Guide. + // see [Compute Environments]in the Batch User Guide. + // + // [Compute Environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html ComputeResources *types.ComputeResource // The details for the Amazon EKS cluster that supports the compute environment. @@ -122,55 +141,73 @@ 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) - // 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 - // path prefix. Because of this, we recommend that you specify the full ARN of your - // service role when you create compute environments. + // information, see [Batch service IAM role]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]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 path prefix. Because + // of this, we recommend that you specify the full ARN of your service role when + // you create compute environments. + // + // [Friendly names and paths]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names + // [Batch service IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html ServiceRole *string // 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 - // 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) - // 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. + // 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 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]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. + // + // [State]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state 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) - // API operations. These tags don't propagate to the underlying compute resources. + // more information, see [Tagging Amazon Web Services Resources]in Amazon Web Services General Reference. + // + // These tags can be updated or removed using the [TagResource] and [UntagResource] API operations. These tags + // don't propagate to the underlying compute resources. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html + // [TagResource]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html 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 . + // queue, no vCPU capacity is reserved. + // + // This parameter is only supported when the type parameter is set to UNMANAGED . UnmanagedvCpus *int32 noSmithyDocumentSerde diff --git a/service/batch/api_op_CreateJobQueue.go b/service/batch/api_op_CreateJobQueue.go index 52a3dd0206a..5db644d928b 100644 --- a/service/batch/api_op_CreateJobQueue.go +++ b/service/batch/api_op_CreateJobQueue.go @@ -13,11 +13,13 @@ import ( // Creates an Batch job queue. When you create a job queue, you associate one or // more compute environments to the queue and assign an order of preference for the -// compute environments. You also set a priority to the job queue that determines -// the order that the Batch scheduler places jobs onto its associated compute -// environments. For example, if a compute environment is associated with more than -// one job queue, the job queue with a higher priority is given preference for -// scheduling jobs to that compute environment. +// compute environments. +// +// You also set a priority to the job queue that determines the order that the +// Batch scheduler places jobs onto its associated compute environments. For +// example, if a compute environment is associated with more than one job queue, +// the job queue with a higher priority is given preference for scheduling jobs to +// that compute environment. func (c *Client) CreateJobQueue(ctx context.Context, params *CreateJobQueueInput, optFns ...func(*Options)) (*CreateJobQueueOutput, error) { if params == nil { params = &CreateJobQueueInput{} @@ -42,9 +44,11 @@ type CreateJobQueueInput struct { // 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. + // 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. ComputeEnvironmentOrder []types.ComputeEnvironmentOrder @@ -87,8 +91,9 @@ type CreateJobQueueInput struct { // 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]in Batch User Guide. + // + // [Tagging your Batch resources]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/batch/api_op_CreateSchedulingPolicy.go b/service/batch/api_op_CreateSchedulingPolicy.go index c953e37007e..369ff67b238 100644 --- a/service/batch/api_op_CreateSchedulingPolicy.go +++ b/service/batch/api_op_CreateSchedulingPolicy.go @@ -42,11 +42,13 @@ 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) - // API operations. + // more information, see [Tagging Amazon Web Services Resources]in Amazon Web Services General Reference. + // + // These tags can be updated or removed using the [TagResource] and [UntagResource] API operations. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html + // [TagResource]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/batch/api_op_DeleteComputeEnvironment.go b/service/batch/api_op_DeleteComputeEnvironment.go index cd91f4cf117..ecc8f70d054 100644 --- a/service/batch/api_op_DeleteComputeEnvironment.go +++ b/service/batch/api_op_DeleteComputeEnvironment.go @@ -10,13 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Batch compute environment. Before you can delete a compute -// environment, you must set its state to DISABLED with the -// UpdateComputeEnvironment API operation and disassociate it from any job queues -// with the UpdateJobQueue API operation. Compute environments that use Fargate -// resources must terminate all active jobs on that compute environment before -// deleting the compute environment. If this isn't done, the compute environment -// enters an invalid state. +// Deletes an Batch compute environment. +// +// Before you can delete a compute environment, you must set its state to DISABLED +// with the UpdateComputeEnvironmentAPI operation and disassociate it from any job queues with the UpdateJobQueue API +// operation. Compute environments that use Fargate resources must terminate all +// active jobs on that compute environment before deleting the compute environment. +// If this isn't done, the compute environment enters an invalid state. func (c *Client) DeleteComputeEnvironment(ctx context.Context, params *DeleteComputeEnvironmentInput, optFns ...func(*Options)) (*DeleteComputeEnvironmentOutput, error) { if params == nil { params = &DeleteComputeEnvironmentInput{} diff --git a/service/batch/api_op_DeleteJobQueue.go b/service/batch/api_op_DeleteJobQueue.go index f18469f0302..d982f6a92dd 100644 --- a/service/batch/api_op_DeleteJobQueue.go +++ b/service/batch/api_op_DeleteJobQueue.go @@ -11,10 +11,12 @@ import ( ) // Deletes the specified job queue. You must first disable submissions for a queue -// with the UpdateJobQueue operation. All jobs in the queue are eventually -// terminated when you delete a job queue. The jobs are terminated at a rate of -// about 16 jobs each second. It's not necessary to disassociate compute -// environments from a queue before submitting a DeleteJobQueue request. +// with the UpdateJobQueueoperation. All jobs in the queue are eventually terminated when you +// delete a job queue. The jobs are terminated at a rate of about 16 jobs each +// second. +// +// It's not necessary to disassociate compute environments from a queue before +// submitting a DeleteJobQueue request. func (c *Client) DeleteJobQueue(ctx context.Context, params *DeleteJobQueueInput, optFns ...func(*Options)) (*DeleteJobQueueOutput, error) { if params == nil { params = &DeleteJobQueueInput{} diff --git a/service/batch/api_op_DeleteSchedulingPolicy.go b/service/batch/api_op_DeleteSchedulingPolicy.go index 43218ae071e..0bba04e43c9 100644 --- a/service/batch/api_op_DeleteSchedulingPolicy.go +++ b/service/batch/api_op_DeleteSchedulingPolicy.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified scheduling policy. You can't delete a scheduling policy -// that's used in any job queues. +// Deletes the specified scheduling policy. +// +// You can't delete a scheduling policy that's used in any job queues. func (c *Client) DeleteSchedulingPolicy(ctx context.Context, params *DeleteSchedulingPolicyInput, optFns ...func(*Options)) (*DeleteSchedulingPolicyOutput, error) { if params == nil { params = &DeleteSchedulingPolicyInput{} diff --git a/service/batch/api_op_DescribeComputeEnvironments.go b/service/batch/api_op_DescribeComputeEnvironments.go index 2a99e8993c3..468d18a44a9 100644 --- a/service/batch/api_op_DescribeComputeEnvironments.go +++ b/service/batch/api_op_DescribeComputeEnvironments.go @@ -11,10 +11,11 @@ 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{} @@ -51,9 +52,10 @@ type DescribeComputeEnvironmentsInput struct { // DescribeComputeEnvironments 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. + // 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 diff --git a/service/batch/api_op_DescribeJobDefinitions.go b/service/batch/api_op_DescribeJobDefinitions.go index 6cf39b7df3b..d207f1786a7 100644 --- a/service/batch/api_op_DescribeJobDefinitions.go +++ b/service/batch/api_op_DescribeJobDefinitions.go @@ -55,8 +55,10 @@ type DescribeJobDefinitionsInput struct { // 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. + // 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 // The status used to filter job definitions. diff --git a/service/batch/api_op_DescribeJobQueues.go b/service/batch/api_op_DescribeJobQueues.go index 6971b3ccee5..7d375a6fba7 100644 --- a/service/batch/api_op_DescribeJobQueues.go +++ b/service/batch/api_op_DescribeJobQueues.go @@ -47,8 +47,10 @@ type DescribeJobQueuesInput struct { // 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. + // 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 diff --git a/service/batch/api_op_ListJobs.go b/service/batch/api_op_ListJobs.go index 99c2f638f2d..6ef7c3d96c8 100644 --- a/service/batch/api_op_ListJobs.go +++ b/service/batch/api_op_ListJobs.go @@ -11,9 +11,14 @@ 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 // // You can filter the results by job status with the jobStatus parameter. If you @@ -43,15 +48,18 @@ type ListJobsInput struct { // 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 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 @@ -60,10 +68,13 @@ type ListJobsInput struct { // 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. + // 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 @@ -97,6 +108,7 @@ type ListJobsInput struct { // 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 diff --git a/service/batch/api_op_ListSchedulingPolicies.go b/service/batch/api_op_ListSchedulingPolicies.go index b4796c9da66..f6434bb068e 100644 --- a/service/batch/api_op_ListSchedulingPolicies.go +++ b/service/batch/api_op_ListSchedulingPolicies.go @@ -43,9 +43,10 @@ type ListSchedulingPoliciesInput struct { // ListSchedulingPolicies 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. + // 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 diff --git a/service/batch/api_op_RegisterJobDefinition.go b/service/batch/api_op_RegisterJobDefinition.go index 463d98787c2..26a2dbc81a3 100644 --- a/service/batch/api_op_RegisterJobDefinition.go +++ b/service/batch/api_op_RegisterJobDefinition.go @@ -38,22 +38,27 @@ type RegisterJobDefinitionInput struct { 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. + // jobs, see [Creating a multi-node parallel job definition]in the Batch User Guide. + // // - If the value is container , then one of the following is required: // containerProperties , ecsProperties , or eksProperties . + // // - If the value is multinode , then nodeProperties is required. + // // If the job is run on Fargate resources, then multinode isn't supported. // + // [Creating a multi-node parallel job definition]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html + // // This member is required. Type types.JobDefinitionType // An object with 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 - // specified for Amazon EKS-based job definitions. If the job runs on Fargate - // resources, then you must not specify nodeProperties ; use only - // containerProperties . + // specified for Amazon EKS-based job definitions. + // + // If the job runs on Fargate resources, then you must not specify nodeProperties ; + // use only containerProperties . ContainerProperties *types.ContainerProperties // An object with properties that are specific to Amazon ECS-based jobs. This must @@ -66,10 +71,15 @@ type RegisterJobDefinitionInput struct { // An object with 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 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 . + // information, see [Multi-node Parallel Jobs]in the Batch User Guide. + // + // 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 . + // + // [Multi-node Parallel Jobs]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html NodeProperties *types.NodeProperties // Default parameter substitution placeholders to set in the job definition. @@ -79,7 +89,9 @@ type RegisterJobDefinitionInput struct { // 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 + // FARGATE . + // + // If the job runs on Amazon EKS resources, then you must not specify // platformCapabilities . PlatformCapabilities []types.PlatformCapability @@ -88,36 +100,41 @@ type RegisterJobDefinitionInput struct { // propagated. Tags can only be propagated to the tasks during task creation. For // 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 . + // the job is moved to the FAILED state. + // + // If the job runs on Amazon EKS resources, then you must not specify propagateTags + // . PropagateTags *bool // The retry strategy to use for failed jobs that are submitted with this job - // definition. Any retry strategy that's specified during a SubmitJob operation - // overrides the retry strategy defined here. If a job is terminated due to a - // timeout, it isn't retried. + // definition. Any retry strategy that's specified during a SubmitJoboperation overrides + // the retry strategy defined here. If a job is terminated due to a timeout, it + // isn't retried. RetryStrategy *types.RetryStrategy // The scheduling priority for jobs that are submitted with this job definition. // 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. The minimum supported value is 0 and the maximum supported value is - // 9999. + // priority. + // + // The minimum supported value is 0 and the maximum supported value is 9999. SchedulingPriority *int32 // 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]in Batch User Guide. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html Tags map[string]string // The timeout configuration for jobs that are submitted with this job definition, // after which Batch terminates your jobs if they have not finished. If a job is // 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. + // is 60 seconds. Any timeout configuration that's specified during a SubmitJoboperation + // overrides the timeout configuration defined here. For more information, see [Job Timeouts]in + // the Batch User Guide. + // + // [Job Timeouts]: https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html Timeout *types.JobTimeout noSmithyDocumentSerde diff --git a/service/batch/api_op_SubmitJob.go b/service/batch/api_op_SubmitJob.go index e8b052d7579..d5001956f5c 100644 --- a/service/batch/api_op_SubmitJob.go +++ b/service/batch/api_op_SubmitJob.go @@ -12,15 +12,19 @@ import ( ) // 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 -// days, Fargate resources might become unavailable and job might be terminated. +// during SubmitJoboverride 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 days, Fargate resources might become unavailable +// and job might be terminated. func (c *Client) SubmitJob(ctx context.Context, params *SubmitJobInput, optFns ...func(*Options)) (*SubmitJobOutput, error) { if params == nil { params = &SubmitJobInput{} @@ -43,8 +47,9 @@ type SubmitJobInput struct { // 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. + // arn:aws:batch:region:account:job-definition/definition-name ). + // + // If the revision is not specified, then the latest active revision is used. // // This member is required. JobDefinition *string @@ -64,8 +69,9 @@ type SubmitJobInput struct { // 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]in the Batch User Guide. + // + // [Array Jobs]: https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html ArrayProperties *types.ArrayProperties // An object with properties that override the defaults for the job definition @@ -93,8 +99,10 @@ type SubmitJobInput struct { EksPropertiesOverride *types.EksPropertiesOverride // A list of node overrides in JSON format that specify the node range to target - // and the container overrides for that node range. This parameter isn't applicable - // to jobs that are running on Fargate resources; use containerOverrides instead. + // and the container overrides for that node range. + // + // This parameter isn't applicable to jobs that are running on Fargate resources; + // use containerOverrides instead. NodeOverrides *types.NodeOverrides // Additional parameters passed to the job that replace parameter substitution @@ -112,38 +120,43 @@ type SubmitJobInput struct { // propagation setting in the job definition. PropagateTags *bool - // The retry strategy to use for failed jobs from this SubmitJob operation. When a - // retry strategy is specified here, it overrides the retry strategy defined in the - // job definition. + // The retry strategy to use for failed jobs from this SubmitJob operation. When a retry + // strategy is specified here, it overrides the retry strategy defined in the 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 // jobs with a lower scheduling priority. This overrides any scheduling priority in - // the job definition and works only within a single share identifier. The minimum - // supported value is 0 and the maximum supported value is 9999. + // the job definition and works only within a single share identifier. + // + // The minimum supported value is 0 and the maximum supported value is 9999. SchedulingPriorityOverride *int32 // The share identifier for the job. Don't specify this parameter if the job queue // doesn't have a scheduling policy. If the job queue has a scheduling policy, then - // this parameter must be specified. This string is limited to 255 alphanumeric - // characters, and can be followed by an asterisk (*). + // this parameter must be specified. + // + // This string is limited to 255 alphanumeric characters, and can be followed by + // an asterisk (*). ShareIdentifier *string // 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]in Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string - // The timeout configuration for this SubmitJob operation. You can specify a - // timeout duration after which Batch terminates your jobs if they haven't - // finished. If a job is terminated due to a timeout, it isn't retried. The minimum - // 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) - // in the Amazon Elastic Container Service Developer Guide. + // The timeout configuration for this SubmitJob operation. You can specify a timeout + // duration after which Batch terminates your jobs if they haven't finished. If a + // job is terminated due to a timeout, it isn't retried. The minimum 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Job Timeouts]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html Timeout *types.JobTimeout noSmithyDocumentSerde diff --git a/service/batch/api_op_TagResource.go b/service/batch/api_op_TagResource.go index 1d2b262b957..588ba867fcd 100644 --- a/service/batch/api_op_TagResource.go +++ b/service/batch/api_op_TagResource.go @@ -44,8 +44,9 @@ type TagResourceInput struct { // 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. + // information, see [Tagging Amazon Web Services Resources]in Amazon Web Services General Reference. + // + // [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/batch/api_op_TerminateJob.go b/service/batch/api_op_TerminateJob.go index a033712586d..de9973c1f21 100644 --- a/service/batch/api_op_TerminateJob.go +++ b/service/batch/api_op_TerminateJob.go @@ -37,8 +37,8 @@ type TerminateJobInput struct { JobId *string // A message to attach to the job that explains the reason for canceling it. This - // message is returned by future DescribeJobs operations on the job. This message - // is also recorded in the Batch activity logs. + // message is returned by future DescribeJobsoperations on the job. This message is also + // recorded in the Batch activity logs. // // This member is required. Reason *string diff --git a/service/batch/api_op_UpdateComputeEnvironment.go b/service/batch/api_op_UpdateComputeEnvironment.go index a18e9fe363d..9d4a85242df 100644 --- a/service/batch/api_op_UpdateComputeEnvironment.go +++ b/service/batch/api_op_UpdateComputeEnvironment.go @@ -37,45 +37,60 @@ type UpdateComputeEnvironmentInput struct { ComputeEnvironment *string // 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) - // in the Batch User Guide. + // for a managed compute environment. For more information, see [Compute Environments]in the Batch User + // Guide. + // + // [Compute Environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html 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 - // 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 - // the service role, Batch assumes that your ARN doesn't use the service-role path - // prefix. Because of this, we recommend that you specify the full ARN of your - // service role when you create compute environments. + // information, see [Batch service IAM role]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]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 the service role, + // Batch assumes that your ARN doesn't use the service-role path prefix. Because + // of this, we recommend that you specify the full ARN of your service role when + // you create compute environments. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Batch service IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html ServiceRole *string // 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 - // 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) - // 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. + // 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 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]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. + // + // [State]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state State types.CEState // The maximum number of vCPUs expected to be used for an unmanaged compute @@ -86,9 +101,9 @@ type UpdateComputeEnvironmentInput struct { UnmanagedvCpus *int32 // 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) - // in the Batch User Guide. + // For more information about infrastructure updates, see [Updating compute environments]in the Batch User Guide. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html UpdatePolicy *types.UpdatePolicy noSmithyDocumentSerde diff --git a/service/batch/api_op_UpdateJobQueue.go b/service/batch/api_op_UpdateJobQueue.go index a245737d1c4..a426e6a56a9 100644 --- a/service/batch/api_op_UpdateJobQueue.go +++ b/service/batch/api_op_UpdateJobQueue.go @@ -41,6 +41,7 @@ type UpdateJobQueueInput struct { // 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. diff --git a/service/batch/doc.go b/service/batch/doc.go index b0f2d2247db..2ecc722eccc 100644 --- a/service/batch/doc.go +++ b/service/batch/doc.go @@ -3,18 +3,22 @@ // Package batch provides the API client, operations, and parameter types for AWS // Batch. // -// Batch Using Batch, you can run batch computing workloads on the Amazon Web -// Services Cloud. Batch computing is a common means for developers, scientists, -// and engineers to access large amounts of compute resources. Batch uses the +// # Batch +// +// Using Batch, you can run batch computing workloads on the Amazon Web Services +// Cloud. Batch computing is a common means for developers, scientists, and +// engineers to access large amounts of compute resources. Batch uses the // advantages of the batch computing to remove the undifferentiated heavy lifting // of configuring and managing required infrastructure. At the same time, it also // adopts a familiar batch computing software approach. You can use Batch to // efficiently provision resources, and work toward eliminating capacity // constraints, reducing your overall compute costs, and delivering results more -// quickly. As a fully managed service, Batch can run batch computing workloads of -// any scale. Batch automatically provisions compute resources and optimizes -// workload distribution based on the quantity and scale of your specific -// workloads. With Batch, there's no need to install or manage batch computing -// software. This means that you can focus on analyzing results and solving your -// specific problems instead. +// quickly. +// +// As a fully managed service, Batch can run batch computing workloads of any +// scale. Batch automatically provisions compute resources and optimizes workload +// distribution based on the quantity and scale of your specific workloads. With +// Batch, there's no need to install or manage batch computing software. This means +// that you can focus on analyzing results and solving your specific problems +// instead. package batch diff --git a/service/batch/options.go b/service/batch/options.go index c9038923519..295ecca06df 100644 --- a/service/batch/options.go +++ b/service/batch/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/batch/types/enums.go b/service/batch/types/enums.go index 4446711790d..681c2348b61 100644 --- a/service/batch/types/enums.go +++ b/service/batch/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ArrayJobDependency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArrayJobDependency) Values() []ArrayJobDependency { return []ArrayJobDependency{ "N_TO_N", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AssignPublicIp. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignPublicIp) Values() []AssignPublicIp { return []AssignPublicIp{ "ENABLED", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for CEState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CEState) Values() []CEState { return []CEState{ "ENABLED", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for CEStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CEStatus) Values() []CEStatus { return []CEStatus{ "CREATING", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for CEType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CEType) Values() []CEType { return []CEType{ "MANAGED", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for CRAllocationStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CRAllocationStrategy) Values() []CRAllocationStrategy { return []CRAllocationStrategy{ "BEST_FIT", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for CRType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CRType) Values() []CRType { return []CRType{ "EC2", @@ -155,6 +162,7 @@ const ( // Values returns all known values for CRUpdateAllocationStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CRUpdateAllocationStrategy) Values() []CRUpdateAllocationStrategy { return []CRUpdateAllocationStrategy{ @@ -174,8 +182,9 @@ const ( ) // Values returns all known values for DeviceCgroupPermission. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceCgroupPermission) Values() []DeviceCgroupPermission { return []DeviceCgroupPermission{ "READ", @@ -194,6 +203,7 @@ const ( // Values returns all known values for EFSAuthorizationConfigIAM. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EFSAuthorizationConfigIAM) Values() []EFSAuthorizationConfigIAM { return []EFSAuthorizationConfigIAM{ @@ -211,8 +221,9 @@ const ( ) // Values returns all known values for EFSTransitEncryption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EFSTransitEncryption) Values() []EFSTransitEncryption { return []EFSTransitEncryption{ "ENABLED", @@ -229,8 +240,9 @@ const ( ) // Values returns all known values for JobDefinitionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobDefinitionType) Values() []JobDefinitionType { return []JobDefinitionType{ "container", @@ -247,8 +259,9 @@ const ( // Values returns all known values for JobStateTimeLimitActionsAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobStateTimeLimitActionsAction) Values() []JobStateTimeLimitActionsAction { return []JobStateTimeLimitActionsAction{ "CANCEL", @@ -264,8 +277,9 @@ const ( // Values returns all known values for JobStateTimeLimitActionsState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobStateTimeLimitActionsState) Values() []JobStateTimeLimitActionsState { return []JobStateTimeLimitActionsState{ "RUNNABLE", @@ -286,8 +300,9 @@ const ( ) // 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. +// in the future, and so 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,8 +324,9 @@ const ( ) // Values returns all known values for JQState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JQState) Values() []JQState { return []JQState{ "ENABLED", @@ -331,8 +347,9 @@ const ( ) // Values returns all known values for JQStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JQStatus) Values() []JQStatus { return []JQStatus{ "CREATING", @@ -358,8 +375,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -381,8 +399,9 @@ const ( ) // Values returns all known values for OrchestrationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrchestrationType) Values() []OrchestrationType { return []OrchestrationType{ "ECS", @@ -399,8 +418,9 @@ const ( ) // Values returns all known values for PlatformCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlatformCapability) Values() []PlatformCapability { return []PlatformCapability{ "EC2", @@ -418,8 +438,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -437,8 +458,9 @@ const ( ) // Values returns all known values for RetryAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetryAction) Values() []RetryAction { return []RetryAction{ "RETRY", diff --git a/service/batch/types/types.go b/service/batch/types/types.go index 7a23fd04e00..9656d0a9ade 100644 --- a/service/batch/types/types.go +++ b/service/batch/types/types.go @@ -159,8 +159,9 @@ type ComputeEnvironmentDetail struct { 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) - // in the Batch User Guide. + // information, see [Compute environments]in the Batch User Guide. + // + // [Compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html ComputeResources *ComputeResource // The orchestration type of the compute environment. The valid values are ECS @@ -178,25 +179,33 @@ type ComputeEnvironmentDetail struct { // 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]in the Batch User Guide. + // + // [Batch service IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html 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 - // 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) - // 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. + // 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]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. + // + // [State]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state State CEState // The current status of the compute environment (for example, CREATING or VALID ). @@ -210,8 +219,9 @@ type ComputeEnvironmentDetail struct { 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) - // in the Batch User Guide. + // information, see [Compute environments]in the Batch User Guide. + // + // [Compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html Type CEType // The maximum number of VCPUs expected to be used for an unmanaged compute @@ -219,8 +229,9 @@ type ComputeEnvironmentDetail struct { 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) - // in the Batch User Guide. + // more information about infrastructure updates, see [Updating compute environments]in the Batch User Guide. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html UpdatePolicy *UpdatePolicy // Unique identifier for the compute environment. @@ -236,9 +247,11 @@ type ComputeEnvironmentDetail struct { // 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 ); Amazon 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. +// 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 { // The Amazon Resource Name (ARN) of the compute environment. @@ -257,80 +270,97 @@ type ComputeEnvironmentOrder struct { noSmithyDocumentSerde } -// 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) +// An object that represents an Batch compute resource. For more information, see [Compute environments] // in the Batch User Guide. +// +// [Compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html type ComputeResource struct { - // The maximum number of vCPUs that a compute environment can support. With - // BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED - // (recommended) 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. + // The maximum number of vCPUs that a compute environment can support. + // + // With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and + // SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) 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. // // This member is required. MaxvCpus *int32 // 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) - // 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) - // in the Amazon ECS Developer Guide. Batch on Fargate doesn't currently support - // Local Zones. + // more information, see [VPCs and subnets]in the Amazon VPC User Guide. + // + // Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more + // information, see [Local Zones]in the Amazon EC2 User Guide for Linux Instances, [Amazon EKS and Amazon Web Services Local Zones] in the + // Amazon EKS User Guide and [Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts]in the Amazon ECS Developer Guide. + // + // Batch on Fargate doesn't currently support Local Zones. + // + // [VPCs and subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html + // [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 + // [Local Zones]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones + // [Amazon EKS and Amazon Web Services Local Zones]: https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html // // 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. + // more information, see [Compute environments]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] in the Batch User + // Guide. + // + // [Amazon EC2 spot fleet role]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html + // [Compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html // // 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) - // 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) - // 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 - // instances of the previously selected instance types aren't available, Batch - // selects new instance types. SPOT_CAPACITY_OPTIMIZED Batch selects one or more - // instance types that are large enough to meet the requirements of the jobs in the - // queue. Its preference is for instance types that are less likely to be - // interrupted. This allocation strategy is only available for Spot Instance - // compute resources. SPOT_PRICE_CAPACITY_OPTIMIZED 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. This allocation strategy is only available for Spot - // Instance compute resources. With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED - // and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) 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. + // availability of the instance type in the Region or [Amazon EC2 service limits]. For more information, see [Allocation strategies] + // 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], 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]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 instances of the previously + // selected instance types aren't available, Batch selects new instance types. + // + // SPOT_CAPACITY_OPTIMIZED Batch selects one or more instance types that are large + // enough to meet the requirements of the jobs in the queue. Its preference is for + // instance types that are less likely to be interrupted. This allocation strategy + // is only available for Spot Instance compute resources. + // + // SPOT_PRICE_CAPACITY_OPTIMIZED 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. This + // allocation strategy is only available for Spot Instance compute resources. + // + // With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and + // SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) 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. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Allocation strategies]: https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html + // [Amazon EC2 service limits]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html AllocationStrategy CRAllocationStrategy // The maximum percentage that a Spot Instance price can be when compared with the @@ -339,40 +369,51 @@ type ComputeResource struct { // than 20% of the current On-Demand price for that Amazon EC2 instance. You always // pay the lowest (market) price and never more than your maximum percentage. If // you leave this field empty, the default value is 100% of the On-Demand price. - // For most use cases, we recommend leaving this field empty. This parameter isn't - // applicable to jobs that are running on Fargate resources. Don't specify it. + // For most use cases, we recommend leaving this field empty. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. BidPercentage *int32 // The desired number of vCPUS in the compute environment. Batch modifies this - // value between the minimum and maximum values based on job queue demand. This - // parameter isn't applicable to jobs that are running on Fargate resources. Don't - // specify it. + // value between the minimum and maximum values based on job queue demand. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. DesiredvCpus *int32 // Provides information that's used to select Amazon Machine Images (AMIs) for // Amazon 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 applicable to jobs that are running on Fargate resources. Don't - // specify it. + // specified, the 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 // The Amazon EC2 key pair that's used for instances launched in the compute // environment. You can use this key pair to log in to your instances with SSH. + // // This parameter isn't applicable to jobs that are running on Fargate resources. // Don't specify it. Ec2KeyPair *string // The Amazon Machine Image (AMI) ID used for instances launched in the compute // environment. This parameter is overridden by the imageIdOverride member of the - // Ec2Configuration structure. 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 - // 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) - // in the Amazon Elastic Container Service Developer Guide. + // Ec2Configuration structure. + // + // 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 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]in the Amazon Elastic Container Service Developer Guide. + // + // [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 // // Deprecated: This field is deprecated, use ec2Configuration[].imageIdOverride // instead. @@ -382,38 +423,51 @@ type ComputeResource struct { // environment. This parameter is required for Amazon EC2 instances types. You can // specify the short name or full Amazon Resource Name (ARN) 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. + // arn:aws:iam:::instance-profile/ecsInstanceRole . For more information, see [Amazon ECS instance role] 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 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 // 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 - // you create a compute environment, the instance types that you select for the - // compute environment must share the same architecture. For example, you can't mix - // x86 and ARM instances in the same compute environment. Currently, optimal uses - // instance types from the C4, M4, and R4 instance families. In Regions that don't - // have instance types from those instance families, instance types from the C5, - // M5, and R5 instance families are used. + // 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 you create a compute environment, the instance types that you select for + // the compute environment must share the same architecture. For example, you can't + // mix x86 and ARM instances in the same compute environment. + // + // Currently, optimal uses instance types from the C4, M4, and R4 instance + // families. In Regions that don't have instance types from those instance + // families, instance types from the C5, M5, and R5 instance families are used. InstanceTypes []string // The launch template to use for your compute resources. Any other compute - // resource parameters that you specify in a CreateComputeEnvironment (https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html) - // 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]in the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [CreateComputeEnvironment]: https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html + // [Launch template support]: https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html LaunchTemplate *LaunchTemplateSpecification // The minimum number of vCPUs that a compute 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 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 @@ -421,9 +475,12 @@ 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]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. + // + // [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html PlacementGroup *string // The Amazon EC2 security groups that are associated with instances launched in @@ -438,15 +495,19 @@ type ComputeResource struct { // 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 - // 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) - // in the Batch User Guide. + // information, see [Amazon EC2 spot fleet role]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]in the Batch User + // Guide. + // + // [Spot instances not tagged on creation]: https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag + // [Amazon EC2 spot fleet role]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html SpotIamFleetRole *string // Key-value pair tags to be applied to Amazon EC2 resources that are launched in @@ -454,48 +515,62 @@ type ComputeResource struct { // , 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) - // 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. + // infrastructure update to the compute environment. For more information, see [Updating compute environments]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. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Tags map[string]string noSmithyDocumentSerde } // 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) -// in the Batch User Guide. +// updated. For more information, see [Updating compute environments]in the Batch User Guide. +// +// [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html 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) - // 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) + // because of availability of the instance type in the Region or [Amazon EC2 service limits]. For more + // information, see [Allocation strategies]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] // 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 - // 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 - // instances of the previously selected instance types aren't available, Batch - // selects new instance types. SPOT_CAPACITY_OPTIMIZED Batch selects one or more - // instance types that are large enough to meet the requirements of the jobs in the - // queue. Its preference is for instance types that are less likely to be - // interrupted. This allocation strategy is only available for Spot Instance - // compute resources. SPOT_PRICE_CAPACITY_OPTIMIZED 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. This allocation strategy is only available for Spot - // Instance compute resources. With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED - // and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) 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. + // environment. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // 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 instances of the previously + // selected instance types aren't available, Batch selects new instance types. + // + // SPOT_CAPACITY_OPTIMIZED Batch selects one or more instance types that are large + // enough to meet the requirements of the jobs in the queue. Its preference is for + // instance types that are less likely to be interrupted. This allocation strategy + // is only available for Spot Instance compute resources. + // + // SPOT_PRICE_CAPACITY_OPTIMIZED 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. This + // allocation strategy is only available for Spot Instance compute resources. + // + // With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and + // SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) 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. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Allocation strategies]: https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html + // [Amazon EC2 service limits]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html AllocationStrategy CRUpdateAllocationStrategy // The maximum percentage that a Spot Instance price can be when compared with the @@ -503,119 +578,168 @@ type ComputeResourceUpdate struct { // example, if your maximum percentage is 20%, the Spot price must be less than 20% // of the current On-Demand price for that Amazon EC2 instance. You always pay the // 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) - // in the Batch User Guide. This parameter isn't applicable to jobs that are - // running on Fargate resources. Don't specify it. + // 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]in + // the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html BidPercentage *int32 // The desired number of vCPUS in the compute environment. Batch modifies this - // value between the minimum and maximum values based on job queue demand. This - // parameter isn't applicable to jobs that are running on Fargate resources. Don't - // specify it. Batch doesn't support changing the desired number of vCPUs of an - // existing compute environment. Don't specify this parameter for compute - // environments using Amazon EKS clusters. When you update the desiredvCpus - // setting, the value must be between the minvCpus and maxvCpus values. + // value between the minimum and maximum values based on job queue demand. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // Batch doesn't support changing the desired number of vCPUs of an existing + // compute environment. Don't specify this parameter for 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) - // in the Batch User Guide. + // the current desiredvCpus value. For more information, see [Troubleshooting Batch] in the Batch User + // Guide. + // + // [Troubleshooting Batch]: https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update DesiredvCpus *int32 // Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 // instances in the compute environment. If Ec2Configuration isn't specified, the - // 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) - // in the Batch User Guide. To remove the Amazon EC2 configuration and any custom - // AMI ID 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. + // 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]in + // the Batch User Guide. To remove the Amazon EC2 configuration and any custom AMI + // ID 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. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Ec2Configuration []Ec2Configuration // The Amazon EC2 key pair that's used for instances launched in the compute // environment. You can use this key pair to log in to your instances with SSH. To - // remove the Amazon EC2 key pair, set this value to an empty string. When updating - // a compute environment, changing the Amazon 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) - // in the Batch User Guide. This parameter isn't applicable to jobs that are - // running on Fargate resources. Don't specify it. + // remove the Amazon EC2 key pair, set this value to an empty string. + // + // When updating a compute environment, changing the Amazon EC2 key pair requires + // an infrastructure update of the compute environment. For more information, see [Updating compute environments] + // in the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Ec2KeyPair *string // The Amazon Machine Image (AMI) ID used for instances launched in the compute // environment. This parameter is overridden by the imageIdOverride member of the // 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) - // 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 - // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]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 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]in the Amazon Elastic Container Service Developer Guide. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [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 ImageId *string // The Amazon ECS instance profile applied to Amazon EC2 instances in a compute // environment. Required for Amazon EC2 instances. You can specify the short name // or full Amazon Resource Name (ARN) 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) - // in the Batch User Guide. This parameter isn't applicable to jobs that are - // running on Fargate resources. Don't specify it. + // information, see [Amazon ECS instance role]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]in + // the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [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 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 // 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) - // 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 - // share the same architecture. For example, you can't mix x86 and ARM instances in - // the same compute environment. Currently, optimal uses instance types from the - // C4, M4, and R4 instance families. In Regions that don't have instance types from - // those instance families, instance types from the C5, M5, and R5 instance - // families are used. + // 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]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 share the same architecture. For example, you can't + // mix x86 and ARM instances in the same compute environment. + // + // Currently, optimal uses instance types from the C4, M4, and R4 instance + // families. In Regions that don't have instance types from those instance + // families, instance types from the C5, M5, and R5 instance families are used. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html InstanceTypes []string // 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 - // 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. This parameter isn't applicable to jobs that are - // running on Fargate resources. Don't specify it. + // both. For more information, see [Launch template support]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]in + // the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Launch template support]: https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html LaunchTemplate *LaunchTemplateSpecification - // The maximum number of Amazon EC2 vCPUs that an environment can reach. With - // BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED - // (recommended) 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. + // The maximum number of Amazon EC2 vCPUs that an environment can reach. + // + // With BEST_FIT_PROGRESSIVE , SPOT_CAPACITY_OPTIMIZED and + // SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) 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. MaxvCpus *int32 // The minimum number of 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. + // 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 @@ -623,12 +747,17 @@ 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 - // 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) - // in the Batch User Guide. This parameter isn't applicable to jobs that are - // running on Fargate resources. Don't specify it. + // For more information, see [Placement groups]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]in + // the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html PlacementGroup *string // The Amazon EC2 security groups that are associated with instances launched in @@ -636,30 +765,37 @@ type ComputeResourceUpdate struct { // resources, where it can contain up to 5 security groups. For Fargate compute // resources, providing an empty list is handled as if this parameter wasn't // specified and no change is made. For Amazon EC2 compute resources, providing an - // empty list removes the security groups from the compute resource. When updating - // a compute environment, changing the Amazon 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) - // in the Batch User Guide. + // empty list removes the security groups from the compute resource. + // + // When updating a compute environment, changing the Amazon EC2 security groups + // requires an infrastructure update of the compute environment. For more + // information, see [Updating compute environments]in the Batch User Guide. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html SecurityGroupIds []string // The VPC subnets where the compute resources are launched. Fargate compute // resources can contain up to 16 subnets. For Fargate compute resources, providing // an empty list will be handled as if this parameter wasn't specified and no // change is made. For Amazon EC2 compute resources, providing an empty list - // removes the VPC subnets from the compute resource. For more information, see - // VPCs and 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) - // 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) - // 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) - // in the Amazon ECS Developer Guide. Batch on Fargate doesn't currently support - // Local Zones. + // removes the VPC subnets from the compute resource. For more information, see [VPCs and subnets]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]in + // the Batch User Guide. + // + // Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more + // information, see [Local Zones]in the Amazon EC2 User Guide for Linux Instances, [Amazon EKS and Amazon Web Services Local Zones] in the + // Amazon EKS User Guide and [Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts]in the Amazon ECS Developer Guide. + // + // Batch on Fargate doesn't currently support Local Zones. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [VPCs and subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html + // [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 + // [Local Zones]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones + // [Amazon EKS and Amazon Web Services Local Zones]: https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html Subnets []string // Key-value pair tags to be applied to Amazon EC2 resources that are launched in @@ -667,35 +803,50 @@ type ComputeResourceUpdate struct { // , 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. + // 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]in + // the Batch User Guide. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // Don't specify it. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html 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) - // in the Batch User Guide. + // more information, see [Compute environments]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] 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]in the Batch User Guide. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Amazon EC2 spot fleet role]: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html + // [Compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html 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 - // 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) - // 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. + // 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]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]in + // the Batch User Guide. + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html + // [Updating the AMI ID]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami UpdateToLatestImageVersion *bool noSmithyDocumentSerde @@ -711,9 +862,10 @@ type ContainerDetail struct { // running on. 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 - // Batch sets. + // The environment variables to pass to a container. + // + // Environment variables cannot start with " AWS_BATCH ". This naming convention is + // reserved for variables that Batch sets. Environment []KeyValuePair // The amount of ephemeral storage allocated for the task. This parameter is used @@ -722,8 +874,9 @@ 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]in the Batch User Guide. + // + // [Batch execution IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html ExecutionRoleArn *string // The exit code returned upon completion. @@ -737,8 +890,9 @@ type ContainerDetail struct { 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. + // 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,31 +902,39 @@ type ContainerDetail struct { // for device mappings. 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) - // 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 + // The log configuration specification for the container. + // + // This parameter maps to LogConfig in the [Create a container] section of the [Docker Remote API] and the --log-driver + // option to [docker 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]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. + // [Amazon ECS container agent configuration]in the Amazon Elastic Container Service Developer Guide. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ + // [Amazon ECS container agent configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ + // [LogConfiguration]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html LogConfiguration *LogConfiguration // The name of the Amazon CloudWatch Logs log stream that's associated with the @@ -798,16 +960,18 @@ type ContainerDetail struct { // 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 . + // // 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 (https://docs.docker.com/engine/reference/commandline/run/) - // . + // root file system. This parameter maps to ReadonlyRootfs in the [Create a container] section of the [Docker Remote API] + // and the --read-only option to [docker run]docker run . + // + // [docker run]: https://docs.docker.com/engine/reference/commandline/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ ReadonlyRootFilesystem *bool // A short (255 max characters) human-readable string to provide additional @@ -825,9 +989,10 @@ type ContainerDetail struct { // on Fargate. RuntimePlatform *RuntimePlatform - // 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) - // in the Batch User Guide. + // The secrets to pass to the container. For more information, see [Specifying sensitive data] in the Batch + // User Guide. + // + // [Specifying sensitive data]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html Secrets []Secret // The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with @@ -836,31 +1001,39 @@ type ContainerDetail struct { 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]section of the [Docker Remote API] and the --ulimit option to [docker run]. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ 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/) - // . + // The user name to use inside the container. This parameter maps to User in the [Create a container] + // section of the [Docker Remote API]and the --user option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ User *string // The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 // resources, you can specify the vCPU requirement for the job using // 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 . + // vcpus and resourceRequirements object. This parameter maps to CpuShares in the [Create a container] + // section of the [Docker Remote API]and the --cpu-shares option to [docker 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 . + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ Vcpus *int32 // A list of volumes that are associated with the job. @@ -869,27 +1042,32 @@ type ContainerDetail struct { noSmithyDocumentSerde } -// The overrides that should be sent to a container. For information about using -// Batch overrides when you connect event sources to targets, see -// BatchContainerOverrides (https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html) -// . +// The overrides that should be sent to a container. +// +// For information about using Batch overrides when you connect event sources to +// targets, see [BatchContainerOverrides]. +// +// [BatchContainerOverrides]: https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html type ContainerOverrides struct { // The command to send to the container that overrides the default command from - // the Docker image or the job definition. This parameter can't contain an empty - // string. + // the Docker image or the job definition. + // + // This parameter can't contain an empty string. 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 // reserved for variables that Batch sets. Environment []KeyValuePair - // The instance type to use for a multi-node parallel job. This parameter isn't - // applicable to single-node container jobs or jobs that run on Fargate resources, - // and shouldn't be provided. + // The instance type to use for a multi-node parallel job. + // + // This parameter isn't applicable to single-node container jobs or jobs that run + // on Fargate resources, and shouldn't be provided. InstanceType *string // This parameter is deprecated, use resourceRequirements to override the memory @@ -900,9 +1078,9 @@ type ContainerOverrides struct { // in the job definition. To override memory requirements that are specified in the // 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) - // in the Batch User Guide. + // the new value. For more information, see [Can't override job definition resource requirements]in the Batch User Guide. + // + // [Can't override job definition resource requirements]: https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements // // Deprecated: This field is deprecated, use resourceRequirements instead. Memory *int32 @@ -920,9 +1098,9 @@ type ContainerOverrides struct { // definition. To 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) - // in the Batch User Guide. + // the new value. For more information, see [Can't override job definition resource requirements]in the Batch User Guide. + // + // [Can't override job definition resource requirements]: https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements // // Deprecated: This field is deprecated, use resourceRequirements instead. Vcpus *int32 @@ -934,22 +1112,27 @@ type ContainerOverrides struct { // properties to describe the container that's launched as part of a job. 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) - // . + // The command that's passed to the container. This parameter maps to Cmd in the [Create a container] + // section of the [Docker Remote API]and the COMMAND parameter to [docker run]. For more information, see [https://docs.docker.com/engine/reference/builder/#cmd]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ + // [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]section of the [Docker Remote API] and the --env option to [docker 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ Environment []KeyValuePair // The amount of ephemeral storage to allocate for the task. This parameter is @@ -959,8 +1142,9 @@ type ContainerProperties struct { // 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]in the Batch User Guide. + // + // [Batch execution IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html ExecutionRoleArn *string // The platform configuration for jobs that are running on Fargate resources. Jobs @@ -972,65 +1156,83 @@ type ContainerProperties struct { // default. Other 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/) . + // (/), and number signs (#). This parameter maps to Image in the [Create a container] section of the [Docker Remote API] + // and the IMAGE parameter of [docker 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 ). + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ Image *string // The instance type to use for a multi-node parallel job. All node groups in a - // multi-node parallel job must use the same instance type. This parameter isn't - // applicable to single-node container jobs or jobs that run on Fargate resources, - // and shouldn't be provided. + // multi-node parallel job must use the same instance type. + // + // This parameter isn't applicable to single-node container jobs or jobs that run + // on Fargate resources, 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) - // in the Amazon Elastic Container Service Developer Guide. + // for Amazon Web Services permissions. For more information, see [IAM roles for tasks]in the Amazon + // Elastic Container Service Developer Guide. + // + // [IAM roles for tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html JobRoleArn *string // Linux-specific modifications that are applied to the container, such as details // for device mappings. 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 + // The log configuration specification for the container. + // + // This parameter maps to LogConfig in the [Create a container] section of the [Docker Remote API] and the --log-driver + // option to [docker 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) - // 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. + // different supported log drivers, see [Configure logging drivers]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]in the Amazon Elastic Container Service Developer Guide. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ + // [Amazon ECS container agent configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ + // [LogConfiguration]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html LogConfiguration *LogConfiguration // This parameter is deprecated, use resourceRequirements to specify the memory @@ -1045,10 +1247,11 @@ 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] section of the [Docker Remote API] and the --volume option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ MountPoints []MountPoint // The network configuration for jobs that are running on Fargate resources. Jobs @@ -1057,18 +1260,23 @@ 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] section of the [Docker Remote API] and the --privileged option to [docker 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ 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 . + // root file system. This parameter maps to ReadonlyRootfs in the [Create a container] section of the [Docker Remote API] + // and the --read-only option to docker run . + // + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ ReadonlyRootFilesystem *bool // The private repository authentication credentials to use. @@ -1082,35 +1290,44 @@ type ContainerProperties struct { // on Fargate. RuntimePlatform *RuntimePlatform - // The secrets for the container. For more information, see Specifying sensitive - // data (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) - // in the Batch User Guide. + // The secrets for the container. For more information, see [Specifying sensitive data] in the Batch User + // Guide. + // + // [Specifying sensitive data]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html 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 + // the [Create a container]section of the [Docker Remote API] and the --ulimit option to [docker run]. + // + // This parameter isn't applicable to jobs that are running on Fargate resources // and shouldn't be provided. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ 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/) - // . + // The user name to use inside the container. This parameter maps to User in the [Create a container] + // section of the [Docker Remote API]and the --user option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ 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 Amazon 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. + // 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]section of the [Docker Remote API] and the --cpu-shares option to [docker 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ // // Deprecated: This field is deprecated, use resourceRequirements instead. Vcpus *int32 @@ -1134,9 +1351,10 @@ type ContainerSummary struct { noSmithyDocumentSerde } -// An object that represents a container instance host device. This object isn't -// applicable to jobs that are running on Fargate resources and shouldn't be -// provided. +// An object that represents a container instance host device. +// +// This object isn't applicable to jobs that are running on Fargate resources and +// shouldn't be provided. type Device struct { // The path for the device on the host container instance. @@ -1158,48 +1376,67 @@ 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] ). +// +// This object isn't applicable to jobs that are running on Fargate resources. +// +// [Amazon Linux 2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami 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 - // for all non Amazon Web Services Graviton-based instance types. ECS_AL2023 - // Amazon Linux 2023 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) - // : Batch supports Amazon Linux 2023. Amazon Linux 2023 does not support A1 - // instances. 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. + // 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] ( 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]: Default for all non-GPU instance families. + // + // ECS_AL2_NVIDIA [Amazon Linux 2 (GPU)]: 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_AL2023 [Amazon Linux 2023]: Batch supports Amazon Linux 2023. + // + // Amazon Linux 2023 does not support A1 instances. + // + // ECS_AL1 [Amazon Linux]. Amazon Linux has reached the end-of-life of standard support. For + // more information, see [Amazon Linux AMI]. + // + // EKS If the imageIdOverride parameter isn't specified, then a recent [Amazon EKS-optimized Amazon Linux AMI] ( 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]: Default for all non-GPU instance families. + // + // EKS_AL2_NVIDIA [Amazon Linux 2 (accelerated)]: 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. + // + // [Amazon Linux AMI]: http://aws.amazon.com/amazon-linux-ami/ + // [Amazon Linux 2023]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html + // [Amazon EKS-optimized Amazon Linux AMI]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html + // [Amazon Linux 2 (GPU)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami + // [Amazon Linux 2 (accelerated)]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html + // [Amazon ECS-optimized Amazon Linux 2 AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami + // [Amazon Linux 2]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html + // [Amazon Linux]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami // // 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 - // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service Developer Guide. + // + // [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 ImageIdOverride *string // The Kubernetes version for the compute environment. If you don't specify a @@ -1213,7 +1450,9 @@ type Ec2Configuration struct { type EcsProperties struct { // An object that contains the properties for the Amazon ECS task definition of a - // job. This object is currently limited to one element. + // job. + // + // This object is currently limited to one element. // // This member is required. TaskProperties []EcsTaskProperties @@ -1233,8 +1472,9 @@ type EcsPropertiesDetail struct { // An object that contains overrides for the Amazon ECS task definition of a job. type EcsPropertiesOverride struct { - // The overrides for the Amazon ECS task definition of a job. This object is - // currently limited to one element. + // The overrides for the Amazon ECS task definition of a job. + // + // This object is currently limited to one element. TaskProperties []TaskPropertiesOverride noSmithyDocumentSerde @@ -1254,8 +1494,9 @@ type EcsTaskDetails 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]in the Batch User Guide. + // + // [Batch execution IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html ExecutionRoleArn *string // The IPC resource namespace to use for the containers in the task. @@ -1279,11 +1520,13 @@ type EcsTaskDetails struct { TaskArn *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) - // in the Amazon Elastic Container Service Developer Guide. This is object is - // comparable to ContainerProperties:jobRoleArn (https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html) - // . + // for Amazon Web Services permissions. For more information, see [IAM roles for tasks]in the Amazon + // Elastic Container Service Developer Guide. + // + // This is object is comparable to [ContainerProperties:jobRoleArn]. + // + // [ContainerProperties:jobRoleArn]: https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html + // [IAM roles for tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html TaskRoleArn *string // A list of data volumes used in a job. @@ -1310,21 +1553,30 @@ type EcsTaskProperties struct { // 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]in the Batch User Guide. + // + // [Batch execution IAM role]: https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html ExecutionRoleArn *string // The IPC resource namespace to use for the containers in the task. The valid - // values are host , task , or none . If host is specified, 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, the IPC resources within the containers of a task are private, and - // are 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. + // values are host , task , or none . + // + // If host is specified, 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, the IPC resources within the containers of a task are + // private, and are 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] + // in the Docker run reference. + // + // [IPC settings]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc IpcMode *string // The network configuration for jobs that are running on Fargate resources. Jobs @@ -1333,30 +1585,39 @@ type EcsTaskProperties struct { // The process namespace to use for the containers in the task. The valid values // are host or task . For example, monitoring sidecars might need pidMode to - // access information about other containers running in the same task. If host is - // specified, all containers within the tasks that specified the host PID mode on - // the same container instance share the 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 each container. For more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid) - // in the Docker run reference. + // access information about other containers running in the same task. + // + // If host is specified, all containers within the tasks that specified the host + // PID mode on the same container instance share the 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 each + // container. For more information, see [PID settings]in the Docker run reference. + // + // [PID settings]: https://docs.docker.com/engine/reference/run/#pid-settings---pid PidMode *string // The Fargate platform version where the jobs are running. A platform version is // 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Fargate platform versions]in the Amazon Elastic Container Service Developer Guide. + // + // [Fargate platform versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // An object that represents the compute environment architecture for Batch jobs // on Fargate. RuntimePlatform *RuntimePlatform - // The Amazon Resource Name (ARN) that's associated with the Amazon ECS task. This - // is object is comparable to ContainerProperties:jobRoleArn (https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html) - // . + // The Amazon Resource Name (ARN) that's associated with the Amazon ECS task. + // + // This is object is comparable to [ContainerProperties:jobRoleArn]. + // + // [ContainerProperties:jobRoleArn]: https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html TaskRoleArn *string // A list of volumes that are associated with the job. @@ -1372,26 +1633,29 @@ type EFSAuthorizationConfig struct { // 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. + // EFSVolumeConfiguration . For more information, see [Working with Amazon EFS access points] in the Amazon Elastic File + // System User Guide. + // + // [Working with Amazon EFS access points]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html 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) - // in the Batch User Guide. EFS IAM authorization requires that TransitEncryption - // be ENABLED and that a JobRoleArn is specified. + // default value of DISABLED is used. For more information, see [Using Amazon EFS access points] in the Batch User + // Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and + // that a JobRoleArn is specified. + // + // [Using Amazon EFS access points]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints Iam EFSAuthorizationConfigIAM 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. +// job storage. For more information, see [Amazon EFS Volumes]in the Batch User Guide. +// +// [Amazon EFS Volumes]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html type EFSVolumeConfiguration struct { // The Amazon EFS file system ID to use. @@ -1405,24 +1669,29 @@ 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 // 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 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. 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] in the Amazon + // Elastic File System User Guide. + // + // [Encrypting data in transit]: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html 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]in the Amazon Elastic File + // System User Guide. + // + // [EFS mount helper]: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html TransitEncryptionPort *int32 noSmithyDocumentSerde @@ -1492,10 +1761,11 @@ 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/) + // regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ . For more information, see [Namespaces] // in the Kubernetes documentation. // + // [Namespaces]: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + // // This member is required. KubernetesNamespace *string @@ -1514,46 +1784,54 @@ type EksContainer struct { 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/) - // 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 Dockerfile reference: CMD (https://docs.docker.com/engine/reference/builder/#cmd) - // 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. + // the container image is used. This corresponds to the args member in the [Entrypoint] + // portion of the [Pod]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 [Dockerfile reference: CMD]and [Define a command and arguments for a pod] in the Kubernetes + // documentation. + // + // [Entrypoint]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint + // [Pod]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/ + // [Dockerfile reference: CMD]: https://docs.docker.com/engine/reference/builder/#cmd + // [Define a command and arguments for a pod]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/ Args []string // The entrypoint for the container. This isn't run within a shell. If this isn't // 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 - // 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 + // 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) 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) - // in the Kubernetes documentation. + // information, see [ENTRYPOINT]in the Dockerfile reference and [Define a command and arguments for a container] and [Entrypoint] in the Kubernetes + // documentation. + // + // [Define a command and arguments for a container]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/ + // [Entrypoint]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint + // [ENTRYPOINT]: https://docs.docker.com/engine/reference/builder/#entrypoint 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 - // Batch sets. + // The environment variables to pass to a container. + // + // Environment variables cannot 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) + // the :latest tag is specified, it defaults to Always . For more information, see [Updating images] // in the Kubernetes documentation. + // + // [Updating images]: https://kubernetes.io/docs/concepts/containers/images/#updating-images ImagePullPolicy *string // The name of the container. If the name isn't specified, the default name " @@ -1561,20 +1839,23 @@ type EksContainer struct { 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] // in the Kubernetes documentation. + // + // [Resource management for pods and containers]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ 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. + // The security context for a job. For more information, see [Configure a security context for a pod or container] in the Kubernetes + // documentation. + // + // [Configure a security context for a pod or container]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ SecurityContext *EksContainerSecurityContext // 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. + // Kubernetes, see [Volumes]in the Kubernetes documentation. + // + // [Volumes]: https://kubernetes.io/docs/concepts/storage/volumes/ VolumeMounts []EksContainerVolumeMount noSmithyDocumentSerde @@ -1585,28 +1866,34 @@ type EksContainer struct { 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/) - // 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 - // Dockerfile reference: CMD (https://docs.docker.com/engine/reference/builder/#cmd) - // 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. + // the container image is used. This corresponds to the args member in the [Entrypoint] + // portion of the [Pod]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 [Dockerfile reference: CMD]and [Define a command and arguments for a pod] in the Kubernetes + // documentation. + // + // [Entrypoint]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint + // [Pod]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/ + // [Dockerfile reference: CMD]: https://docs.docker.com/engine/reference/builder/#cmd + // [Define a command and arguments for a pod]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/ Args []string - // 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. + // The entrypoint for the container. For more information, see [Entrypoint] in the Kubernetes + // documentation. + // + // [Entrypoint]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint 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 - // Batch sets. + // The environment variables to pass to a container. + // + // Environment variables cannot start with " AWS_BATCH ". This naming convention is + // reserved for variables that Batch sets. Env []EksContainerEnvironmentVariable // The exit code returned for the job attempt. A non-zero exit code is considered @@ -1618,8 +1905,10 @@ type EksContainerDetail struct { // 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. + // is specified, IfNotPresent otherwise. For more information, see [Updating images] in the + // Kubernetes documentation. + // + // [Updating images]: https://kubernetes.io/docs/concepts/containers/images/#updating-images ImagePullPolicy *string // The name of the container. If the name isn't specified, the default name " @@ -1631,20 +1920,23 @@ 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] // in the Kubernetes documentation. + // + // [Resource management for pods and containers]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ 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. + // The security context for a job. For more information, see [Configure a security context for a pod or container] in the Kubernetes + // documentation. + // + // [Configure a security context for a pod or container]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ SecurityContext *EksContainerSecurityContext // 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. + // Kubernetes, see [Volumes]in the Kubernetes documentation. + // + // [Volumes]: https://kubernetes.io/docs/concepts/storage/volumes/ VolumeMounts []EksContainerVolumeMount noSmithyDocumentSerde @@ -1665,15 +1957,17 @@ type EksContainerEnvironmentVariable struct { } // Object representing any Kubernetes overrides to a job definition that's used in -// a SubmitJob (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) -// API operation. +// a [SubmitJob]API operation. +// +// [SubmitJob]: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html 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 Dockerfile reference: CMD (https://docs.docker.com/engine/reference/builder/#cmd) - // 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. + // information, see [Dockerfile reference: CMD]and [Define a command an arguments for a pod] in the Kubernetes documentation. + // + // [Define a command an arguments for a pod]: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/ + // [Dockerfile reference: CMD]: https://docs.docker.com/engine/reference/builder/#cmd Args []string // The command to send to the container that overrides the default command from @@ -1683,6 +1977,7 @@ type EksContainerOverride 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 job definition. + // // Environment variables cannot start with " AWS_BATCH ". This naming convention is // reserved for variables that Batch sets. Env []EksContainerEnvironmentVariable @@ -1696,70 +1991,84 @@ type EksContainerOverride struct { // 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/) - // in the Kubernetes documentation. + // and nvidia.com/gpu . For more information, see [Resource management for pods and containers] in the Kubernetes documentation. + // + // [Resource management for pods and containers]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Resources *EksContainerResourceRequirements noSmithyDocumentSerde } // 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] // in the Kubernetes documentation. +// +// [Resource management for pods and containers]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ 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 . + // 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] + // 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 . + // + // [Memory management]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html 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 - // 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 . + // 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]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 . + // + // [Memory management]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html 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. +// The security context for a job. For more information, see [Configure a security context for a pod or container] in the Kubernetes +// documentation. +// +// [Configure a security context for a pod or container]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ type EksContainerSecurityContext struct { // Whether or not a container or a Kubernetes pod is allowed to gain more @@ -1769,44 +2078,50 @@ type EksContainerSecurityContext struct { // 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) - // in the Kubernetes documentation. + // policy in the [Privileged pod security policies]in the Kubernetes documentation. + // + // [Privileged pod security policies]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged 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 - // ReadOnlyRootFilesystem policy in the Volumes and file systems pod security - // policies (https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems) - // in the Kubernetes documentation. + // ReadOnlyRootFilesystem policy in the [Volumes and file systems pod security policies] in the Kubernetes documentation. + // + // [Volumes and file systems pod security policies]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems 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 // 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) - // in the Kubernetes documentation. + // policy in the [Users and groups pod security policies]in the Kubernetes documentation. + // + // [Users and groups pod security policies]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups 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) - // in the Kubernetes documentation. + // parameter maps to RunAsUser and MustRunAsNonRoot policy in the [Users and groups pod security policies] in the + // Kubernetes documentation. + // + // [Users and groups pod security policies]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups 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 // 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) - // in the Kubernetes documentation. + // policy in the [Users and groups pod security policies]in the Kubernetes documentation. + // + // [Users and groups pod security policies]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups RunAsUser *int64 noSmithyDocumentSerde } // 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]in the Kubernetes +// documentation. +// +// [Volumes]: https://kubernetes.io/docs/concepts/storage/volumes/ type EksContainerVolumeMount struct { // The path on the container where the volume is mounted. @@ -1829,12 +2144,16 @@ 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]in the Kubernetes documentation. +// +// [emptyDir]: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir 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. + // 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. @@ -1848,8 +2167,9 @@ 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]in the Kubernetes documentation. +// +// [hostPath]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath type EksHostPath struct { // The path of the file or directory on the host to mount into containers on the @@ -1861,8 +2181,9 @@ type EksHostPath struct { // 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. +// pod. For more information, see [Understanding Kubernetes Objects]in the Kubernetes documentation. +// +// [Understanding Kubernetes Objects]: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ type EksMetadata struct { // Key-value pairs used to identify, sort, and organize cube resources. Can @@ -1884,21 +2205,26 @@ type EksPodProperties struct { // 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) - // in the Kubernetes documentation. Valid values: Default | ClusterFirst | - // ClusterFirstWithHostNet + // node. For more information, see [Pod's DNS policy]in the Kubernetes documentation. + // + // Valid values: Default | ClusterFirst | ClusterFirstWithHostNet + // + // [Pod's DNS policy]: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy 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 // 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]and [Pod networking] in the + // Kubernetes documentation. + // + // [Pod networking]: https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking + // [Host namespaces]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces HostNetwork *bool // References a Kubernetes secret resource. It holds a list of secrets. These // secrets help to gain access to pull an images from a private registry. + // // ImagePullSecret$name is required when this object is used. ImagePullSecrets []ImagePullSecret @@ -1906,26 +2232,32 @@ type EksPodProperties struct { // and must complete successfully before the next container starts. These // containers are registered with the Amazon EKS Connector agent and persists the // registration information in the Kubernetes backend data store. For more - // information, see Init Containers (https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) - // in the Kubernetes documentation. This object is limited to 10 elements + // information, see [Init Containers]in the Kubernetes documentation. + // + // This object is limited to 10 elements + // + // [Init Containers]: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers []EksContainer - // Metadata about the Kubernetes pod. For more information, see Understanding - // Kubernetes Objects (https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) - // in the Kubernetes documentation. + // Metadata about the Kubernetes pod. For more information, see [Understanding Kubernetes Objects] in the Kubernetes + // documentation. + // + // [Understanding Kubernetes Objects]: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ 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/) - // in the Kubernetes documentation. + // information, see [Kubernetes service accounts]and [Configure a Kubernetes service account to assume an IAM role] in the Amazon EKS User Guide and [Configure service accounts for pods] in the Kubernetes + // documentation. + // + // [Kubernetes service accounts]: https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html + // [Configure service accounts for pods]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + // [Configure a Kubernetes service account to assume an IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html ServiceAccountName *string // Indicates if the processes in a container are shared, or visible, to other - // containers in the same pod. For more information, see Share Process Namespace - // between Containers in a Pod (https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) - // . + // containers in the same pod. For more information, see [Share Process Namespace between Containers in a Pod]. + // + // [Share Process Namespace between Containers in a Pod]: https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ ShareProcessNamespace *bool // Specifies the volumes for a job definition that uses Amazon EKS resources. @@ -1944,23 +2276,28 @@ type EksPodPropertiesDetail struct { // 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) - // 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) - // 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) - // in the Kubernetes documentation. Valid values: Default | ClusterFirst | - // ClusterFirstWithHostNet + // node. If no value was specified for dnsPolicy in the [RegisterJobDefinition] API operation, then no + // value will be returned for dnsPolicy by either of [DescribeJobDefinitions] or [DescribeJobs] 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] + // in the Kubernetes documentation. + // + // Valid values: Default | ClusterFirst | ClusterFirstWithHostNet + // + // [DescribeJobs]: https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobs.html + // [RegisterJobDefinition]: https://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html + // [DescribeJobDefinitions]: https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobDefinitions.html + // [Pod's DNS policy]: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy 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 // 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]and [Pod networking] in the + // Kubernetes documentation. + // + // [Pod networking]: https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking + // [Host namespaces]: https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces HostNetwork *bool // Displays the reference pointer to the Kubernetes secret resource. These secrets @@ -1973,8 +2310,9 @@ type EksPodPropertiesDetail struct { // 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. + // pod. For more information, see [Understanding Kubernetes Objects]in the Kubernetes documentation. + // + // [Understanding Kubernetes Objects]: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ Metadata *EksMetadata // The name of the node for this job. @@ -1984,16 +2322,18 @@ 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/) - // in the Kubernetes documentation. + // information, see [Kubernetes service accounts]and [Configure a Kubernetes service account to assume an IAM role] in the Amazon EKS User Guide and [Configure service accounts for pods] in the Kubernetes + // documentation. + // + // [Kubernetes service accounts]: https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html + // [Configure service accounts for pods]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + // [Configure a Kubernetes service account to assume an IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html ServiceAccountName *string // Indicates if the processes in a container are shared, or visible, to other - // containers in the same pod. For more information, see Share Process Namespace - // between Containers in a Pod (https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) - // . + // containers in the same pod. For more information, see [Share Process Namespace between Containers in a Pod]. + // + // [Share Process Namespace between Containers in a Pod]: https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ ShareProcessNamespace *bool // Specifies the volumes for a job definition using Amazon EKS resources. @@ -2012,9 +2352,12 @@ type EksPodPropertiesOverride struct { // containers run before application containers, always runs to completion, and // must complete successfully before the next container starts. These containers // are registered with the Amazon EKS Connector agent and persists the registration - // information in the Kubernetes backend data store. For more information, see - // Init Containers (https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) - // in the Kubernetes documentation. This object is limited to 10 elements + // information in the Kubernetes backend data store. For more information, see [Init Containers]in + // the Kubernetes documentation. + // + // This object is limited to 10 elements + // + // [Init Containers]: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers []EksContainerOverride // Metadata about the overrides for the container that's used on the Amazon EKS @@ -2052,13 +2395,15 @@ type EksPropertiesOverride struct { } // 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. +// information, see [secret]in the Kubernetes documentation. +// +// [secret]: https://kubernetes.io/docs/concepts/storage/volumes/#secret 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) - // in the Kubernetes documentation. + // more information, see [DNS subdomain names]in the Kubernetes documentation. + // + // [DNS subdomain names]: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names // // This member is required. SecretName *string @@ -2073,25 +2418,29 @@ 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) - // in the Kubernetes documentation. + // more information, see [DNS subdomain names]in the Kubernetes documentation. + // + // [DNS subdomain names]: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names // // 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]in the Kubernetes documentation. + // + // [emptyDir]: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir 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]in the Kubernetes documentation. + // + // [hostPath]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath 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. + // information, see [secret]in the Kubernetes documentation. + // + // [secret]: https://kubernetes.io/docs/concepts/storage/volumes/#secret Secret *EksSecret noSmithyDocumentSerde @@ -2125,8 +2474,9 @@ type EvaluateOnExit struct { // Contains a glob pattern to match against the decimal representation of the // ExitCode returned for a job. The pattern can be up to 512 characters long. It // can contain only numbers, and can end with an asterisk (*) so that only the - // start of the string needs to be an exact match. The string can contain up to 512 - // characters. + // start of the string needs to be an exact match. + // + // The string can contain up to 512 characters. OnExitCode *string // Contains a glob pattern to match against the Reason returned for a job. The @@ -2150,16 +2500,20 @@ type EvaluateOnExit struct { 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 Batch reserves 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. + // 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 Batch reserves 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. ComputeReservation *int32 // The amount of time (in seconds) to use to calculate a fair share percentage for @@ -2185,8 +2539,9 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Fargate platform versions]in the Amazon Elastic Container Service Developer Guide. + // + // [Fargate platform versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string noSmithyDocumentSerde @@ -2204,8 +2559,10 @@ type Host struct { // at the specified location on the host container instance until you delete it // manually. If the source path location doesn't exist on the host container // instance, the Docker daemon creates it. If the location does exist, the contents - // of the source path folder are exported. This parameter isn't applicable to jobs - // that run on Fargate resources. Don't provide this for these jobs. + // of the source path folder are exported. + // + // This parameter isn't applicable to jobs that run on Fargate resources. Don't + // provide this for these jobs. SourcePath *string noSmithyDocumentSerde @@ -2245,9 +2602,9 @@ type JobDefinition struct { // 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. + // about multi-node parallel jobs, see [Creating a multi-node parallel job definition]in the Batch User Guide. + // + // [Creating a multi-node parallel job definition]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html // // This member is required. Type *string @@ -2273,17 +2630,19 @@ type JobDefinition struct { // An object with properties that are specific to multi-node parallel jobs. When // nodeProperties is used in the job definition, it can't be used in addition to - // containerProperties , ecsProperties , or eksProperties . If the job runs on - // Fargate resources, don't specify nodeProperties . Use containerProperties - // instead. + // containerProperties , ecsProperties , or eksProperties . + // + // 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) - // in the Batch User Guide. + // job definition. For more information about specifying parameters, see [Job definition parameters]in the + // Batch User Guide. + // + // [Job definition parameters]: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html Parameters map[string]string // The platform capabilities required by the job definition. If no value is @@ -2363,9 +2722,12 @@ 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) - // in the troubleshooting section of the Batch User Guide. + // The current status for the job. + // + // If your jobs don't progress to STARTING , see [Jobs stuck in RUNNABLE status] in the troubleshooting section + // of the Batch User Guide. + // + // [Jobs stuck in RUNNABLE status]: https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable // // This member is required. Status JobStatus @@ -2383,9 +2745,10 @@ type JobDetail struct { // 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 (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) - // was called. For array child jobs, this is when the child job was spawned by its - // parent and entered the PENDING state. + // 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. + // + // [SubmitJob]: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html CreatedAt *int64 // A list of job IDs that this job depends on. @@ -2414,6 +2777,7 @@ type JobDetail struct { 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. NodeProperties *NodeProperties @@ -2447,12 +2811,16 @@ type JobDetail struct { // A short, human-readable string to provide more details for the current status // of the job. + // // - CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have // insufficient capacity to service the job. + // // - MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments // have a maxVcpu setting that is smaller than the job requirements. + // // - MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no // connected instances that meet the job requirements. + // // - MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have // problems with the service role permissions. StatusReason *string @@ -2526,9 +2894,10 @@ type JobQueueDetail struct { // status of the job queue. 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. + // The tags that are applied to the job queue. For more information, see [Tagging your Batch resources] in Batch + // User Guide. + // + // [Tagging your Batch resources]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html Tags map[string]string noSmithyDocumentSerde @@ -2588,9 +2957,10 @@ type JobSummary struct { // 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 (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) - // was called). For array child jobs, this is when the child job was spawned by its - // parent and entered the PENDING state. + // 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. + // + // [SubmitJob]: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html CreatedAt *int64 // The Amazon Resource Name (ARN) of the job. @@ -2599,8 +2969,9 @@ type JobSummary struct { // The Amazon Resource Name (ARN) of the job definition. JobDefinition *string - // The node properties for a single node in a job summary list. This isn't - // applicable to jobs that are running on Fargate resources. + // The node properties for a single node in a job summary list. + // + // This isn't applicable to jobs that are running on Fargate resources. NodeProperties *NodePropertiesSummary // The Unix timestamp for when the job was started. More specifically, it's when @@ -2627,10 +2998,13 @@ type JobTimeout struct { // The job timeout time (in seconds) that's measured from the job attempt's // startedAt timestamp. After this time passes, Batch terminates your jobs if they - // aren't finished. The minimum value for the timeout is 60 seconds. For array - // jobs, the timeout applies to the child jobs, not to the parent array job. For - // multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the - // individual nodes. + // aren't finished. The minimum value for the timeout is 60 seconds. + // + // For array jobs, the timeout applies to the child jobs, not to the parent array + // job. + // + // For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not + // to the individual nodes. AttemptDurationSeconds *int32 noSmithyDocumentSerde @@ -2665,11 +3039,13 @@ type KeyValuesPair struct { // An object that represents a launch template that's associated with a compute // 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 -// resources. +// 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 resources. type LaunchTemplateSpecification struct { // The ID of the launch template. @@ -2678,19 +3054,24 @@ 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 - // 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, - // 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 . + // 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, 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]in the Batch User Guide. + // + // Default: $Default . + // + // [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html Version *string noSmithyDocumentSerde @@ -2701,38 +3082,51 @@ 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. + // Devices in the [Create a container] section of the [Docker Remote API] and the --device option to [docker run]. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. // Don't provide it for these jobs. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ 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]. 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" + // + // [docker run]: https://docs.docker.com/engine/reference/run/ 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] where the value is the sum of the + // container memory plus the maxSwap value. For more information, see [--memory-swap details]--memory-swap + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [--memory-swap details]: https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details 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. + // the --shm-size option to [docker run]. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. // Don't provide it for these jobs. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ SharedMemorySize *int32 // You can use this parameter to tune a container's memory swappiness behavior. A @@ -2741,27 +3135,39 @@ type LinuxParameters struct { // 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. + // use swap. This parameter maps to the --memory-swappiness option to [docker 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/) + // 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]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?] + // // - 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Instance store swap volumes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html + // [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/ 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. + // parameter maps to the --tmpfs option to [docker run]. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. // Don't provide this parameter for this resource type. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ Tmpfs []Tmpfs noSmithyDocumentSerde @@ -2772,35 +3178,55 @@ 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]in the Batch User Guide and [Amazon CloudWatch Logs logging driver] in the Docker documentation. + // + // fluentd Specifies the Fluentd logging driver. For more information including + // usage and options, see [Fluentd logging driver]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]in the Docker documentation. + // + // journald Specifies the journald logging driver. For more information including + // usage and options, see [Journald logging driver]in the Docker documentation. + // + // json-file Specifies the JSON file logging driver. For more information + // including usage and options, see [JSON File logging driver]in the Docker documentation. + // + // splunk Specifies the Splunk logging driver. For more information including + // usage and options, see [Splunk logging driver]in the Docker documentation. + // + // syslog Specifies the syslog logging driver. For more information including + // usage and options, see [Syslog logging driver]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]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" + // + // [Journald logging driver]: https://docs.docker.com/config/containers/logging/journald/ + // [Syslog logging driver]: https://docs.docker.com/config/containers/logging/syslog/ + // [JSON File logging driver]: https://docs.docker.com/config/containers/logging/json-file/ + // [Splunk logging driver]: https://docs.docker.com/config/containers/logging/splunk/ + // [Amazon CloudWatch Logs logging driver]: https://docs.docker.com/config/containers/logging/awslogs/ + // [available on GitHub]: https://github.com/aws/amazon-ecs-agent + // [Using the awslogs log driver]: https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html + // [Fluentd logging driver]: https://docs.docker.com/config/containers/logging/fluentd/ + // [Graylog Extended Format logging driver]: https://docs.docker.com/config/containers/logging/gelf/ // // This member is required. LogDriver LogDriver @@ -2812,17 +3238,20 @@ type LogConfiguration struct { // "Server API version" 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) - // in the Batch User Guide. + // The secrets to pass to the log configuration. For more information, see [Specifying sensitive data] in the + // Batch User Guide. + // + // [Specifying sensitive data]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html SecretOptions []Secret noSmithyDocumentSerde } // 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/api/v1.43/#tag/Container/operation/ContainerCreate) -// section of the Docker Remote API and the --volume option to docker run. +// properties. This parameter maps to Volumes in the [Create a container] section of the Docker Remote +// API and the --volume option to docker run. +// +// [Create a container]: https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate type MountPoint struct { // The path on the container where the host volume is mounted. @@ -2846,9 +3275,10 @@ 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 " + // [Amazon ECS task networking]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 AssignPublicIp AssignPublicIp noSmithyDocumentSerde @@ -2886,10 +3316,12 @@ type NodeDetails struct { } // An object that represents any node overrides to a job definition that's used in -// a SubmitJob (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) -// API operation. This parameter isn't applicable to jobs that are running on -// Fargate resources. Don't provide it for these jobs. Rather, use -// containerOverrides instead. +// a [SubmitJob]API operation. +// +// This parameter isn't applicable to jobs that are running on Fargate resources. +// Don't provide it for these jobs. Rather, use containerOverrides instead. +// +// [SubmitJob]: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html type NodeOverrides struct { // The node property overrides for the job. @@ -2898,10 +3330,13 @@ 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. NumNodes *int32 @@ -2910,6 +3345,7 @@ type NodeOverrides struct { } // 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 { @@ -2953,8 +3389,9 @@ type NodePropertiesSummary struct { } // The object that represents any node overrides to a job definition that's used -// in a SubmitJob (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) -// API operation. +// in a [SubmitJob]API operation. +// +// [SubmitJob]: https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html type NodePropertyOverride struct { // The range of nodes, using node index values, that's used to override. A range @@ -3003,9 +3440,11 @@ type NodeRangeProperty struct { EcsProperties *EcsProperties // The instance types of the underlying host infrastructure of a multi-node - // parallel job. This parameter isn't applicable to jobs that are running on - // Fargate resources. In addition, this list object is currently limited to one - // element. + // parallel job. + // + // This parameter isn't applicable to jobs that are running on Fargate resources. + // + // In addition, this list object is currently limited to one element. InstanceTypes []string noSmithyDocumentSerde @@ -3034,58 +3473,98 @@ type ResourceRequirement struct { Type ResourceType // The quantity of the specified resource to reserve for the container. The values - // vary based on the type specified. type="GPU" The number of physical GPUs to - // reserve for the container. Make sure that the number of GPUs reserved for all - // containers in a job doesn't exceed the number of available GPUs on the compute - // resource that the job is launched on. GPUs aren't available for jobs that are - // 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 Amazon 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 - // 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 Amazon 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, + // vary based on the type specified. + // + // type="GPU" The number of physical GPUs to reserve for the container. Make sure + // that the number of GPUs reserved for all containers in a job doesn't exceed the + // number of available GPUs on the compute resource that the job is launched on. + // + // GPUs aren't available for jobs that are 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 Amazon 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] section of the [Docker Remote API] and the + // --memory option to [docker 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] section of the [Docker Remote API] and the --memory option to [docker 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]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] section of the [Docker Remote API] and the --cpu-shares option to [docker run]. Each vCPU + // is equivalent to 1,024 CPU shares. For Amazon 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]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 + // 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 + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Memory management]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ + // [Fargate quotas]: https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate // // This member is required. Value *string @@ -3093,9 +3572,10 @@ type ResourceRequirement struct { noSmithyDocumentSerde } -// 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. +// The retry strategy that's associated with a job. For more information, see [Automated job retries] in +// the Batch User Guide. +// +// [Automated job retries]: https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html type RetryStrategy struct { // The number of times to move a job to the RUNNABLE status. You can specify @@ -3111,12 +3591,16 @@ type RetryStrategy struct { noSmithyDocumentSerde } -// An object that represents the compute environment architecture for Batch jobs +// An object that represents the compute environment architecture for Batch jobs +// // on Fargate. type RuntimePlatform struct { - // The vCPU architecture. The default value is X86_64 . Valid values are X86_64 - // and ARM64 . This parameter must be set to X86_64 for Windows containers. + // The vCPU architecture. The default value is X86_64 . Valid values are X86_64 + // and ARM64 . + // + // This parameter must be set to X86_64 for Windows containers. + // // Fargate Spot is not supported for ARM64 and Windows-based containers on // Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is // submitted to a job queue with only Fargate Spot compute environments. However, @@ -3126,19 +3610,24 @@ type RuntimePlatform struct { // The operating system for the compute environment. Valid values are: LINUX // (default), WINDOWS_SERVER_2019_CORE , WINDOWS_SERVER_2019_FULL , - // WINDOWS_SERVER_2022_CORE , and WINDOWS_SERVER_2022_FULL . The following - // parameters can’t be set for Windows containers: linuxParameters , privileged , - // user , ulimits , readonlyRootFilesystem , and efsVolumeConfiguration . The Batch - // Scheduler checks the compute environments that are attached to the job queue - // before registering a task definition with Fargate. In this scenario, the job - // queue is where the job is submitted. If the job requires a Windows container and - // the first compute environment is LINUX , the compute environment is skipped and - // the next compute environment is checked until a Windows-based compute - // environment is found. Fargate Spot is not supported for ARM64 and Windows-based - // containers on Fargate. A job queue will be blocked if a Fargate ARM64 or - // Windows job is submitted to a job queue with only Fargate Spot compute - // environments. However, you can attach both FARGATE and FARGATE_SPOT compute - // environments to the same job queue. + // WINDOWS_SERVER_2022_CORE , and WINDOWS_SERVER_2022_FULL . + // + // The following parameters can’t be set for Windows containers: linuxParameters , + // privileged , user , ulimits , readonlyRootFilesystem , and + // efsVolumeConfiguration . + // + // The Batch Scheduler checks the compute environments that are attached to the + // job queue before registering a task definition with Fargate. In this scenario, + // the job queue is where the job is submitted. If the job requires a Windows + // container and the first compute environment is LINUX , the compute environment + // is skipped and the next compute environment is checked until a Windows-based + // compute environment is found. + // + // Fargate Spot is not supported for ARM64 and Windows-based containers on + // Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is + // submitted to a job queue with only Fargate Spot compute environments. However, + // you can attach both FARGATE and FARGATE_SPOT compute environments to the same + // job queue. OperatingSystemFamily *string noSmithyDocumentSerde @@ -3163,8 +3652,9 @@ type SchedulingPolicyDetail struct { // 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. + // information, see [Tagging Amazon Web Services resources]in Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -3184,13 +3674,16 @@ type SchedulingPolicyListingDetail struct { // 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) -// in the Batch User Guide. +// For more information, see [Specifying sensitive data] in the Batch User Guide. +// +// [Specifying sensitive data]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html type Secret struct { // The name of the secret. @@ -3200,11 +3693,12 @@ type Secret struct { // The secret to expose to the container. The supported values are 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 - // Region as the job you're launching, then you can use either the full Amazon - // Resource Name (ARN) or name of the parameter. If the parameter exists in a - // different Region, then the full ARN must be specified. + // parameter in the Amazon Web Services Systems Manager Parameter Store. + // + // If the Amazon Web Services Systems Manager Parameter Store parameter exists in + // the same Region as the job you're launching, then you can use either the full + // Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in + // a different Region, then the full ARN must be specified. // // This member is required. ValueFrom *string @@ -3221,9 +3715,12 @@ type ShareAttributes struct { // 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 (*). + // 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 @@ -3232,6 +3729,7 @@ type ShareAttributes struct { // lower value has a higher priority for compute resources. For example, jobs that // use a share identifier with a weight factor of 0.125 (1/8) get 8 times the // compute resources of jobs that use a share identifier with a weight factor of 1. + // // The smallest supported value is 0.0001, and the largest supported value is // 999.9999. WeightFactor *float32 @@ -3244,13 +3742,16 @@ type TaskContainerDependency 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. @@ -3265,36 +3766,42 @@ type TaskContainerDependency struct { // The details for the container in this task attempt. type TaskContainerDetails 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) - // . + // The command that's passed to the container. This parameter maps to Cmd in the [Create a container] + // section of the [Docker Remote API]and the COMMAND parameter to [docker run]. For more information, see [https://docs.docker.com/engine/reference/builder/#cmd]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ + // [https://docs.docker.com/engine/reference/builder/#cmd]: https://docs.docker.com/engine/reference/builder/#cmd Command []string // A list of containers that this container depends on. DependsOn []TaskContainerDependency // 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 + // the [Create a container]section of the [Docker Remote API] and the --env option to [docker run]. + // + // We don't recommend using plaintext environment variables for sensitive // information, such as credential data. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ Environment []KeyValuePair // 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 // 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 jobs 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) - // in the Amazon Elastic Container Service Developer Guide. + // is omitted, a container is assumed to be essential. + // + // All jobs 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]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Application Architecture]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html Essential *bool // The exit code returned upon completion. @@ -3305,41 +3812,55 @@ type TaskContainerDetails struct { // 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 the docker run (https://docs.docker.com/engine/reference/run/#security-configuration) - // . + // signs are allowed. This parameter maps to Image in the [Create a container] section of the [Docker Remote API] and the + // IMAGE parameter of the [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Image *string // Linux-specific modifications that are applied to the container, such as Linux - // kernel capabilities. For more information, see KernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) - // . This parameter is not supported for Windows containers. + // kernel capabilities. For more information, see [KernelCapabilities]. + // + // This parameter is not supported for Windows containers. + // + // [KernelCapabilities]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html 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 + // The log configuration specification for the container. + // + // This parameter maps to LogConfig in the [Create a container] section of the [Docker Remote API] and the --log-driver + // option to [docker run]. + // + // 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]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. + // [Amazon ECS container agent configuration]in the Amazon Elastic Container Service Developer Guide. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ + // [Amazon ECS container agent configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ LogConfiguration *LogConfiguration // The name of the CloudWatch Logs log stream that's associated with the @@ -3347,13 +3868,17 @@ type TaskContainerDetails struct { // attempt receives a log stream name when they reach the RUNNING status. LogStreamName *string - // 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 + // The mount points for data volumes in your container. + // + // This parameter maps to Volumes in the [Create a container] section of the [Docker Remote API] and the --volume option to [docker run]. + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ MountPoints []MountPoint // The name of a container. @@ -3364,19 +3889,24 @@ type TaskContainerDetails struct { // 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] section of the [Docker Remote API] and the --privileged option to [docker run]. + // + // This parameter is not supported for Windows containers or tasks run on Fargate. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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.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. + // root file system. This parameter maps to ReadonlyRootfs in the [Create a container] section of the [Docker Remote API] + // and the --read-only option to [docker run]. + // + // This parameter is not supported for Windows containers. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ ReadonlyRootFilesystem *bool // A short (255 max characters) human-readable string to provide additional @@ -3390,59 +3920,80 @@ type TaskContainerDetails struct { // resource is a GPU. 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) - // in the Amazon Elastic Container Service Developer Guide. + // The secrets to pass to the container. For more information, see [Specifying Sensitive Data] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Specifying Sensitive Data]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html Secrets []Secret // 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) - // . 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 65535 . 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] section of the [Docker Remote API] and the --ulimit option to [docker run]. + // + // 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 65535 . + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Ulimits []Ulimit // The user to use inside the container. This parameter maps to User in the Create // a container section of the Docker Remote API and the --user option to docker - // run. 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. + // run. + // + // 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:gi + // // - uid:group + // // This parameter is not supported for Windows containers. User *string noSmithyDocumentSerde } -// The overrides that should be sent to a container. For information about using -// Batch overrides when you connect event sources to targets, see -// BatchContainerOverrides (https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html) -// . +// The overrides that should be sent to a container. +// +// For information about using Batch overrides when you connect event sources to +// targets, see [BatchContainerOverrides]. +// +// [BatchContainerOverrides]: https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html type TaskContainerOverrides struct { // The command to send to the container that overrides the default command from - // the Docker image or the job definition. This parameter can't contain an empty - // string. + // the Docker image or the job definition. + // + // This parameter can't contain an empty string. 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 // reserved for variables that Batch sets. Environment []KeyValuePair @@ -3468,84 +4019,109 @@ type TaskContainerProperties struct { // 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 the docker run (https://docs.docker.com/engine/reference/run/#security-configuration) - // . + // signs are allowed. This parameter maps to Image in the [Create a container] section of the [Docker Remote API] and the + // IMAGE parameter of the [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ // // This member is required. Image *string - // 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 Dockerfile reference: CMD (https://docs.docker.com/engine/reference/builder/#cmd) - // . + // The command that's passed to the container. This parameter maps to Cmd in the [Create a container] + // section of the [Docker Remote API]and the COMMAND parameter to [docker run]. For more information, see [Dockerfile reference: CMD]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Dockerfile reference: CMD]: https://docs.docker.com/engine/reference/builder/#cmd + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ Command []string // A list of containers that this container depends on. DependsOn []TaskContainerDependency // The environment variables to pass to a container. This parameter maps to Env - // inthe 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 parameter 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. + // inthe [Create a container]section of the [Docker Remote API] and the --env parameter to [docker 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ Environment []KeyValuePair // 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 // 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 jobs 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) - // in the Amazon Elastic Container Service Developer Guide. + // is omitted, a container is assumed to be essential. + // + // All jobs 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]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Application Architecture]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html Essential *bool // Linux-specific modifications that are applied to the container, such as Linux - // kernel capabilities. For more information, see KernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) - // . + // kernel capabilities. For more information, see [KernelCapabilities]. + // + // [KernelCapabilities]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html 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 + // The log configuration specification for the container. + // + // This parameter maps to LogConfig in the [Create a container] section of the [Docker Remote API] and the --log-driver + // option to [docker run]. + // + // 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]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. + // [Amazon ECS container agent configuration]in the Amazon Elastic Container Service Developer Guide. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ + // [Amazon ECS container agent configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ LogConfiguration *LogConfiguration - // 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 + // The mount points for data volumes in your container. + // + // This parameter maps to Volumes in the [Create a container] section of the [Docker Remote API] and the --volume option to [docker run]. + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ MountPoints []MountPoint // The name of a container. The name can be used as a unique identifier to target @@ -3554,19 +4130,24 @@ type TaskContainerProperties struct { // 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] section of the [Docker Remote API] and the --privileged option to [docker run]. + // + // This parameter is not supported for Windows containers or tasks run on Fargate. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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.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. + // root file system. This parameter maps to ReadonlyRootfs in the [Create a container] section of the [Docker Remote API] + // and the --read-only option to [docker run]. + // + // This parameter is not supported for Windows containers. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ ReadonlyRootFilesystem *bool // The private repository authentication credentials to use. @@ -3576,39 +4157,56 @@ type TaskContainerProperties struct { // resource is a GPU. 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) - // in the Amazon Elastic Container Service Developer Guide. + // The secrets to pass to the container. For more information, see [Specifying Sensitive Data] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Specifying Sensitive Data]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html Secrets []Secret // 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) - // . 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 65535 . 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] section of the [Docker Remote API] and the --ulimit option to [docker run]. + // + // 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 65535 . + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Ulimits []Ulimit // The user to use inside the container. This parameter maps to User in the Create // a container section of the Docker Remote API and the --user option to docker - // run. 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. + // run. + // + // 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:gi + // // - uid:group + // // This parameter is not supported for Windows containers. User *string @@ -3624,8 +4222,9 @@ type TaskPropertiesOverride struct { noSmithyDocumentSerde } -// The container path, mount options, and size of the tmpfs mount. This object -// isn't applicable to jobs that are running on Fargate resources. +// The container path, mount options, and size of the tmpfs mount. +// +// This object isn't applicable to jobs that are running on Fargate resources. type Tmpfs struct { // The absolute file path in the container where the tmpfs volume is mounted. @@ -3638,21 +4237,25 @@ 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 } -// The ulimit settings to pass to the container. For more information, see Ulimit (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) -// . This object isn't applicable to jobs that are running on Fargate resources. +// The ulimit settings to pass to the container. For more information, see [Ulimit]. +// +// This object isn't applicable to jobs that are running on Fargate resources. +// +// [Ulimit]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html type Ulimit struct { // The hard limit for the ulimit type. @@ -3676,8 +4279,9 @@ type Ulimit struct { } // 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. +// more information about infrastructure updates, see [Updating compute environments]in the Batch User Guide. +// +// [Updating compute environments]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html type UpdatePolicy struct { // Specifies the job timeout (in minutes) when the compute environment @@ -3703,8 +4307,10 @@ type Volume struct { // on the host container instance and where it's stored. If the host parameter is // 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. This parameter isn't applicable to jobs that are running - // on Fargate resources and shouldn't be provided. + // with it stop running. + // + // This parameter isn't applicable to jobs that are running on Fargate resources + // and shouldn't be provided. Host *Host // The name of the volume. It can be up to 255 characters long. It can contain diff --git a/service/bcmdataexports/api_op_CreateExport.go b/service/bcmdataexports/api_op_CreateExport.go index 483b3a6467b..def9c669280 100644 --- a/service/bcmdataexports/api_op_CreateExport.go +++ b/service/bcmdataexports/api_op_CreateExport.go @@ -12,23 +12,25 @@ import ( ) // Creates a data export and specifies the data query, the delivery preference, -// and any optional resource tags. A DataQuery consists of both a QueryStatement -// and TableConfigurations . The QueryStatement is an SQL statement. Data Exports -// only supports a limited subset of the SQL syntax. For more information on the -// SQL syntax that is supported, see Data query (https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html) -// . To view the available tables and columns, see the Data Exports table -// dictionary (https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html) -// . The TableConfigurations is a collection of specified TableProperties for the +// and any optional resource tags. +// +// A DataQuery consists of both a QueryStatement and TableConfigurations . +// +// The QueryStatement is an SQL statement. Data Exports only supports a limited +// subset of the SQL syntax. For more information on the SQL syntax that is +// supported, see [Data query]. To view the available tables and columns, see the [Data Exports table dictionary]. +// +// The TableConfigurations is a collection of specified TableProperties for the // table being queried in the QueryStatement . TableProperties are additional // configurations you can provide to change the data and schema of a table. Each // table can have different TableProperties. However, tables are not required to // have any TableProperties. Each table property has a default value that it -// assumes if not specified. For more information on table configurations, see -// Data query (https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html) -// . To view the table properties available for each table, see the Data Exports -// table dictionary (https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html) -// or use the ListTables API to get a response of all tables and their available -// properties. +// assumes if not specified. For more information on table configurations, see [Data query]. +// To view the table properties available for each table, see the [Data Exports table dictionary]or use the +// ListTables API to get a response of all tables and their available properties. +// +// [Data Exports table dictionary]: https://docs.aws.amazon.com/cur/latest/userguide/de-table-dictionary.html +// [Data query]: https://docs.aws.amazon.com/cur/latest/userguide/de-data-query.html func (c *Client) CreateExport(ctx context.Context, params *CreateExportInput, optFns ...func(*Options)) (*CreateExportOutput, error) { if params == nil { params = &CreateExportInput{} diff --git a/service/bcmdataexports/doc.go b/service/bcmdataexports/doc.go index 7fdba615c77..a1ebb9eb1ed 100644 --- a/service/bcmdataexports/doc.go +++ b/service/bcmdataexports/doc.go @@ -5,7 +5,9 @@ // // You can use the Data Exports API to create customized exports from multiple // Amazon Web Services cost management and billing datasets, such as cost and usage -// data and cost optimization recommendations. The Data Exports API provides the -// following endpoint: +// data and cost optimization recommendations. +// +// The Data Exports API provides the following endpoint: +// // - https://bcm-data-exports.us-east-1.api.aws package bcmdataexports diff --git a/service/bcmdataexports/options.go b/service/bcmdataexports/options.go index 396bd2bb7b2..0515a8d1cf5 100644 --- a/service/bcmdataexports/options.go +++ b/service/bcmdataexports/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/bcmdataexports/types/enums.go b/service/bcmdataexports/types/enums.go index fb19b6806f3..0da24f34c07 100644 --- a/service/bcmdataexports/types/enums.go +++ b/service/bcmdataexports/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for CompressionOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionOption) Values() []CompressionOption { return []CompressionOption{ "GZIP", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for ExecutionStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatusCode) Values() []ExecutionStatusCode { return []ExecutionStatusCode{ "INITIATION_IN_PROCESS", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for ExecutionStatusReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatusReason) Values() []ExecutionStatusReason { return []ExecutionStatusReason{ "INSUFFICIENT_PERMISSION", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for ExportStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportStatusCode) Values() []ExportStatusCode { return []ExportStatusCode{ "HEALTHY", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for FormatOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormatOption) Values() []FormatOption { return []FormatOption{ "TEXT_OR_CSV", @@ -112,8 +117,9 @@ const ( ) // Values returns all known values for FrequencyOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FrequencyOption) Values() []FrequencyOption { return []FrequencyOption{ "SYNCHRONOUS", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for OverwriteOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverwriteOption) Values() []OverwriteOption { return []OverwriteOption{ "CREATE_NEW_REPORT", @@ -146,8 +153,9 @@ const ( ) // Values returns all known values for S3OutputType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3OutputType) Values() []S3OutputType { return []S3OutputType{ "CUSTOM", @@ -166,6 +174,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/bedrock/api_op_CreateEvaluationJob.go b/service/bedrock/api_op_CreateEvaluationJob.go index dc4ab627c6d..086eafe9021 100644 --- a/service/bedrock/api_op_CreateEvaluationJob.go +++ b/service/bedrock/api_op_CreateEvaluationJob.go @@ -13,9 +13,9 @@ import ( // API operation for creating and managing Amazon Bedrock automatic model // evaluation jobs and model evaluation jobs that use human workers. To learn more -// about the requirements for creating a model evaluation job see, Model -// evaluations (https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation.html) -// . +// about the requirements for creating a model evaluation job see, [Model evaluations]. +// +// [Model evaluations]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation.html func (c *Client) CreateEvaluationJob(ctx context.Context, params *CreateEvaluationJobInput, optFns ...func(*Options)) (*CreateEvaluationJobOutput, error) { if params == nil { params = &CreateEvaluationJobInput{} @@ -62,17 +62,18 @@ type CreateEvaluationJobInput struct { // Bedrock as the service principal, and provide access to any Amazon S3 buckets // specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, // the caller of this API must have the iam:PassRole permission. To learn more - // about the required permissions, see Required permissions (https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html) - // . + // about the required permissions, see [Required permissions]. + // + // [Required permissions]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html // // This member is required. RoleArn *string // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientRequestToken *string // Specify your customer managed key ARN that will be used to encrypt your model diff --git a/service/bedrock/api_op_CreateGuardrail.go b/service/bedrock/api_op_CreateGuardrail.go index 44295a501b2..817a4b26caa 100644 --- a/service/bedrock/api_op_CreateGuardrail.go +++ b/service/bedrock/api_op_CreateGuardrail.go @@ -13,34 +13,42 @@ import ( ) // Creates a guardrail to block topics and to filter out harmful content. +// // - Specify a name and optional description . +// // - Specify messages for when the guardrail successfully blocks a prompt or a -// model response in the blockedInputMessaging and blockedOutputsMessaging -// fields. +// model response in the blockedInputMessaging and blockedOutputsMessaging fields. +// // - Specify topics for the guardrail to deny in the topicPolicyConfig object. -// Each GuardrailTopicConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html) -// object in the topicsConfig list pertains to one topic. +// Each [GuardrailTopicConfig]object in the topicsConfig list pertains to one topic. +// // - Give a name and description so that the guardrail can properly identify the // topic. +// // - Specify DENY in the type field. +// // - (Optional) Provide up to five prompts that you would categorize as // belonging to the topic in the examples list. +// // - Specify filter strengths for the harmful categories defined in Amazon -// Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) -// object in the filtersConfig list pertains to a harmful category. For more -// information, see Content filters (https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters) -// . For more information about the fields in a content filter, see -// GuardrailContentFilterConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) -// . +// Bedrock in the contentPolicyConfig object. Each [GuardrailContentFilterConfig]object in the filtersConfig +// list pertains to a harmful category. For more information, see [Content filters]. For more +// information about the fields in a content filter, see [GuardrailContentFilterConfig]. +// // - Specify the category in the type field. +// // - Specify the strength of the filter for prompts in the inputStrength field -// and for model responses in the strength field of the -// GuardrailContentFilterConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) -// . +// and for model responses in the strength field of the [GuardrailContentFilterConfig]. +// // - (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. +// // - (Optional) Attach any tags to the guardrail in the tags object. For more -// information, see Tag resources (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging) -// . +// information, see [Tag resources]. +// +// [GuardrailContentFilterConfig]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html +// [Content filters]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters +// [Tag resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging +// [GuardrailTopicConfig]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html func (c *Client) CreateGuardrail(ctx context.Context, params *CreateGuardrailInput, optFns ...func(*Options)) (*CreateGuardrailOutput, error) { if params == nil { params = &CreateGuardrailInput{} @@ -75,9 +83,10 @@ type CreateGuardrailInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than once. If this token matches a previous request, Amazon Bedrock ignores - // the request, but does not return an error. For more information, see Ensuring - // idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // in the Amazon S3 User Guide. + // the request, but does not return an error. For more information, see [Ensuring idempotency]in the + // Amazon S3 User Guide. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientRequestToken *string // The content filter policies to configure for the guardrail. diff --git a/service/bedrock/api_op_CreateGuardrailVersion.go b/service/bedrock/api_op_CreateGuardrailVersion.go index 48d6576af36..0604d2bfedc 100644 --- a/service/bedrock/api_op_CreateGuardrailVersion.go +++ b/service/bedrock/api_op_CreateGuardrailVersion.go @@ -37,9 +37,10 @@ type CreateGuardrailVersionInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than once. If this token matches a previous request, Amazon Bedrock ignores - // the request, but does not return an error. For more information, see Ensuring - // idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // in the Amazon S3 User Guide. + // the request, but does not return an error. For more information, see [Ensuring idempotency]in the + // Amazon S3 User Guide. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientRequestToken *string // A description of the guardrail version. diff --git a/service/bedrock/api_op_CreateModelCustomizationJob.go b/service/bedrock/api_op_CreateModelCustomizationJob.go index bd2f304c084..4f20881303c 100644 --- a/service/bedrock/api_op_CreateModelCustomizationJob.go +++ b/service/bedrock/api_op_CreateModelCustomizationJob.go @@ -11,17 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a fine-tuning job to customize a base model. You specify the base -// foundation model and the location of the training data. After the -// model-customization job completes successfully, your custom model resource will -// be ready to use. Amazon Bedrock returns validation loss metrics and output -// generations after the job completes. For information on the format of training -// and validation data, see Prepare the datasets (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-prepare.html) -// . Model-customization jobs are asynchronous and the completion time depends on +// Creates a fine-tuning job to customize a base model. +// +// You specify the base foundation model and the location of the training data. +// After the model-customization job completes successfully, your custom model +// resource will be ready to use. Amazon Bedrock returns validation loss metrics +// and output generations after the job completes. +// +// For information on the format of training and validation data, see [Prepare the datasets]. +// +// Model-customization jobs are asynchronous and the completion time depends on // the base model and the training/validation data size. To monitor a job, use the -// GetModelCustomizationJob operation to retrieve the job status. For more -// information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// GetModelCustomizationJob operation to retrieve the job status. +// +// For more information, see [Custom models] in the Amazon Bedrock User Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html +// [Prepare the datasets]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-prepare.html func (c *Client) CreateModelCustomizationJob(ctx context.Context, params *CreateModelCustomizationJobInput, optFns ...func(*Options)) (*CreateModelCustomizationJobOutput, error) { if params == nil { params = &CreateModelCustomizationJobInput{} @@ -50,8 +56,9 @@ type CreateModelCustomizationJobInput struct { CustomModelName *string // Parameters related to tuning the model. For details on the format for different - // models, see Custom model hyperparameters (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html) - // . + // models, see [Custom model hyperparameters]. + // + // [Custom model hyperparameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html // // This member is required. HyperParameters map[string]string @@ -82,9 +89,9 @@ type CreateModelCustomizationJobInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientRequestToken *string // The custom model is encrypted at rest using this key. diff --git a/service/bedrock/api_op_CreateProvisionedModelThroughput.go b/service/bedrock/api_op_CreateProvisionedModelThroughput.go index c934cddc040..5ea0f295356 100644 --- a/service/bedrock/api_op_CreateProvisionedModelThroughput.go +++ b/service/bedrock/api_op_CreateProvisionedModelThroughput.go @@ -12,10 +12,11 @@ import ( ) // Creates dedicated throughput for a base or custom model with the model units -// and for the duration that you specify. For pricing details, see Amazon Bedrock -// Pricing (http://aws.amazon.com/bedrock/pricing/) . For more information, see -// Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) -// in the Amazon Bedrock User Guide. +// and for the duration that you specify. For pricing details, see [Amazon Bedrock Pricing]. For more +// information, see [Provisioned Throughput]in the Amazon Bedrock User Guide. +// +// [Amazon Bedrock Pricing]: http://aws.amazon.com/bedrock/pricing/ +// [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html func (c *Client) CreateProvisionedModelThroughput(ctx context.Context, params *CreateProvisionedModelThroughputInput, optFns ...func(*Options)) (*CreateProvisionedModelThroughputOutput, error) { if params == nil { params = &CreateProvisionedModelThroughputInput{} @@ -35,9 +36,9 @@ type CreateProvisionedModelThroughputInput struct { // The Amazon Resource Name (ARN) or name of the model to associate with this // Provisioned Throughput. For a list of models for which you can purchase - // Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned - // Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models) - // in the Amazon Bedrock User Guide. + // Provisioned Throughput, see [Amazon Bedrock model IDs for purchasing Provisioned Throughput]in the Amazon Bedrock User Guide. + // + // [Amazon Bedrock model IDs for purchasing Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models // // This member is required. ModelId *string @@ -46,11 +47,16 @@ type CreateProvisionedModelThroughputInput struct { // level for the specified model. The throughput level of a model unit specifies // the total number of input and output tokens that it can process and generate // within a span of one minute. By default, your account has no model units for - // purchasing Provisioned Throughputs with commitment. You must first visit the - // Amazon Web Services support center (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase) - // to request MUs. For model unit quotas, see Provisioned Throughput quotas (https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas) - // in the Amazon Bedrock User Guide. For more information about what an MU - // specifies, contact your Amazon Web Services account manager. + // purchasing Provisioned Throughputs with commitment. You must first visit the [Amazon Web Services support center]to + // request MUs. + // + // For model unit quotas, see [Provisioned Throughput quotas] in the Amazon Bedrock User Guide. + // + // For more information about what an MU specifies, contact your Amazon Web + // Services account manager. + // + // [Amazon Web Services support center]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase + // [Provisioned Throughput quotas]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas // // This member is required. ModelUnits *int32 @@ -62,17 +68,20 @@ type CreateProvisionedModelThroughputInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // in the Amazon S3 User Guide. + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]in + // the Amazon S3 User Guide. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientRequestToken *string // The commitment duration requested for the Provisioned Throughput. Billing // occurs hourly and is discounted for longer commitment terms. To request a - // no-commit Provisioned Throughput, omit this field. Custom models support all - // levels of commitment. To see which base models support no commitment, see - // Supported regions and models for Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html) - // in the Amazon Bedrock User Guide + // no-commit Provisioned Throughput, omit this field. + // + // Custom models support all levels of commitment. To see which base models + // support no commitment, see [Supported regions and models for Provisioned Throughput]in the Amazon Bedrock User Guide + // + // [Supported regions and models for Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html CommitmentDuration types.CommitmentDuration // Tags to associate with this Provisioned Throughput. diff --git a/service/bedrock/api_op_DeleteCustomModel.go b/service/bedrock/api_op_DeleteCustomModel.go index d1e691af869..517b866653f 100644 --- a/service/bedrock/api_op_DeleteCustomModel.go +++ b/service/bedrock/api_op_DeleteCustomModel.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a custom model that you created earlier. For more information, see -// Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// Deletes a custom model that you created earlier. For more information, see [Custom models] in +// the Amazon Bedrock User Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html func (c *Client) DeleteCustomModel(ctx context.Context, params *DeleteCustomModelInput, optFns ...func(*Options)) (*DeleteCustomModelOutput, error) { if params == nil { params = &DeleteCustomModelInput{} diff --git a/service/bedrock/api_op_DeleteGuardrail.go b/service/bedrock/api_op_DeleteGuardrail.go index 2f9d632cf8f..09bdb0a05b0 100644 --- a/service/bedrock/api_op_DeleteGuardrail.go +++ b/service/bedrock/api_op_DeleteGuardrail.go @@ -11,9 +11,11 @@ import ( ) // Deletes a guardrail. +// // - To delete a guardrail, only specify the ARN of the guardrail in the // guardrailIdentifier field. If you delete a guardrail, all of its versions will // be deleted. +// // - To delete a version of a guardrail, specify the ARN of the guardrail in the // guardrailIdentifier field and the version in the guardrailVersion field. func (c *Client) DeleteGuardrail(ctx context.Context, params *DeleteGuardrailInput, optFns ...func(*Options)) (*DeleteGuardrailOutput, error) { diff --git a/service/bedrock/api_op_DeleteProvisionedModelThroughput.go b/service/bedrock/api_op_DeleteProvisionedModelThroughput.go index c6d04a194bd..f016c9f8790 100644 --- a/service/bedrock/api_op_DeleteProvisionedModelThroughput.go +++ b/service/bedrock/api_op_DeleteProvisionedModelThroughput.go @@ -11,9 +11,10 @@ import ( ) // Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput -// before the commitment term is over. For more information, see Provisioned -// Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) -// in the Amazon Bedrock User Guide. +// before the commitment term is over. For more information, see [Provisioned Throughput]in the Amazon +// Bedrock User Guide. +// +// [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html func (c *Client) DeleteProvisionedModelThroughput(ctx context.Context, params *DeleteProvisionedModelThroughputInput, optFns ...func(*Options)) (*DeleteProvisionedModelThroughputOutput, error) { if params == nil { params = &DeleteProvisionedModelThroughputInput{} diff --git a/service/bedrock/api_op_GetCustomModel.go b/service/bedrock/api_op_GetCustomModel.go index 3cb76b09fdc..6c648b520ad 100644 --- a/service/bedrock/api_op_GetCustomModel.go +++ b/service/bedrock/api_op_GetCustomModel.go @@ -13,8 +13,9 @@ import ( ) // Get the properties associated with a Amazon Bedrock custom model that you have -// created.For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// created.For more information, see [Custom models]in the Amazon Bedrock User Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html func (c *Client) GetCustomModel(ctx context.Context, params *GetCustomModelInput, optFns ...func(*Options)) (*GetCustomModelOutput, error) { if params == nil { params = &GetCustomModelInput{} @@ -81,8 +82,9 @@ type GetCustomModelOutput struct { CustomizationType types.CustomizationType // Hyperparameter values associated with this model. For details on the format for - // different models, see Custom model hyperparameters (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html) - // . + // different models, see [Custom model hyperparameters]. + // + // [Custom model hyperparameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html HyperParameters map[string]string // Job name associated with this model. diff --git a/service/bedrock/api_op_GetEvaluationJob.go b/service/bedrock/api_op_GetEvaluationJob.go index b51b5344c17..1ebcf45e77d 100644 --- a/service/bedrock/api_op_GetEvaluationJob.go +++ b/service/bedrock/api_op_GetEvaluationJob.go @@ -13,8 +13,9 @@ import ( ) // Retrieves the properties associated with a model evaluation job, including the -// status of the job. For more information, see Model evaluations (https://docs.aws.amazon.com/bedrock/latest/userguide/latest/userguide/model-evaluation.html) -// . +// status of the job. For more information, see [Model evaluations]. +// +// [Model evaluations]: https://docs.aws.amazon.com/bedrock/latest/userguide/latest/userguide/model-evaluation.html func (c *Client) GetEvaluationJob(ctx context.Context, params *GetEvaluationJobInput, optFns ...func(*Options)) (*GetEvaluationJobOutput, error) { if params == nil { params = &GetEvaluationJobInput{} diff --git a/service/bedrock/api_op_GetModelCustomizationJob.go b/service/bedrock/api_op_GetModelCustomizationJob.go index a8caec41d04..08522c3ad07 100644 --- a/service/bedrock/api_op_GetModelCustomizationJob.go +++ b/service/bedrock/api_op_GetModelCustomizationJob.go @@ -13,8 +13,10 @@ import ( ) // Retrieves the properties associated with a model-customization job, including -// the status of the job. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// the status of the job. For more information, see [Custom models]in the Amazon Bedrock User +// Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html func (c *Client) GetModelCustomizationJob(ctx context.Context, params *GetModelCustomizationJobInput, optFns ...func(*Options)) (*GetModelCustomizationJobOutput, error) { if params == nil { params = &GetModelCustomizationJobInput{} @@ -53,8 +55,9 @@ type GetModelCustomizationJobOutput struct { CreationTime *time.Time // The hyperparameter values for the job. For details on the format for different - // models, see Custom model hyperparameters (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html) - // . + // models, see [Custom model hyperparameters]. + // + // [Custom model hyperparameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html // // This member is required. HyperParameters map[string]string diff --git a/service/bedrock/api_op_GetProvisionedModelThroughput.go b/service/bedrock/api_op_GetProvisionedModelThroughput.go index 2bd125171c9..ea8c8a80e35 100644 --- a/service/bedrock/api_op_GetProvisionedModelThroughput.go +++ b/service/bedrock/api_op_GetProvisionedModelThroughput.go @@ -12,9 +12,10 @@ import ( "time" ) -// Returns details for a Provisioned Throughput. For more information, see -// Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) -// in the Amazon Bedrock User Guide. +// Returns details for a Provisioned Throughput. For more information, see [Provisioned Throughput] in the +// Amazon Bedrock User Guide. +// +// [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html func (c *Client) GetProvisionedModelThroughput(ctx context.Context, params *GetProvisionedModelThroughputInput, optFns ...func(*Options)) (*GetProvisionedModelThroughputOutput, error) { if params == nil { params = &GetProvisionedModelThroughputInput{} diff --git a/service/bedrock/api_op_ListCustomModels.go b/service/bedrock/api_op_ListCustomModels.go index 048ba8f613f..7ae4da4d8d4 100644 --- a/service/bedrock/api_op_ListCustomModels.go +++ b/service/bedrock/api_op_ListCustomModels.go @@ -13,8 +13,11 @@ import ( ) // Returns a list of the custom models that you have created with the -// CreateModelCustomizationJob operation. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// CreateModelCustomizationJob operation. +// +// For more information, see [Custom models] in the Amazon Bedrock User Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html func (c *Client) ListCustomModels(ctx context.Context, params *ListCustomModelsInput, optFns ...func(*Options)) (*ListCustomModelsOutput, error) { if params == nil { params = &ListCustomModelsInput{} diff --git a/service/bedrock/api_op_ListFoundationModels.go b/service/bedrock/api_op_ListFoundationModels.go index 01718575f96..16d99904272 100644 --- a/service/bedrock/api_op_ListFoundationModels.go +++ b/service/bedrock/api_op_ListFoundationModels.go @@ -12,8 +12,10 @@ import ( ) // Lists Amazon Bedrock foundation models that you can use. You can filter the -// results with the request parameters. For more information, see Foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html) -// in the Amazon Bedrock User Guide. +// results with the request parameters. For more information, see [Foundation models]in the Amazon +// Bedrock User Guide. +// +// [Foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html func (c *Client) ListFoundationModels(ctx context.Context, params *ListFoundationModelsInput, optFns ...func(*Options)) (*ListFoundationModelsOutput, error) { if params == nil { params = &ListFoundationModelsInput{} @@ -32,13 +34,15 @@ func (c *Client) ListFoundationModels(ctx context.Context, params *ListFoundatio type ListFoundationModelsInput struct { // Return models that support the customization type that you specify. For more - // information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) - // in the Amazon Bedrock User Guide. + // information, see [Custom models]in the Amazon Bedrock User Guide. + // + // [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html ByCustomizationType types.ModelCustomization // Return models that support the inference type that you specify. For more - // information, see Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) - // in the Amazon Bedrock User Guide. + // information, see [Provisioned Throughput]in the Amazon Bedrock User Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html ByInferenceType types.InferenceType // Return models that support the output modality that you specify. diff --git a/service/bedrock/api_op_ListGuardrails.go b/service/bedrock/api_op_ListGuardrails.go index 3f469e6632c..a89bf98385a 100644 --- a/service/bedrock/api_op_ListGuardrails.go +++ b/service/bedrock/api_op_ListGuardrails.go @@ -14,10 +14,12 @@ import ( // Lists details about all the guardrails in an account. To list the DRAFT version // of all your guardrails, don't specify the guardrailIdentifier field. To list // all versions of a guardrail, specify the ARN of the guardrail in the -// guardrailIdentifier field. You can set the maximum number of results to return -// in a response in the maxResults field. If there are more results than the -// number you set, the response returns a nextToken that you can send in another -// ListGuardrails request to see the next batch of results. +// guardrailIdentifier field. +// +// You can set the maximum number of results to return in a response in the +// maxResults field. If there are more results than the number you set, the +// response returns a nextToken that you can send in another ListGuardrails +// request to see the next batch of results. func (c *Client) ListGuardrails(ctx context.Context, params *ListGuardrailsInput, optFns ...func(*Options)) (*ListGuardrailsOutput, error) { if params == nil { params = &ListGuardrailsInput{} diff --git a/service/bedrock/api_op_ListModelCustomizationJobs.go b/service/bedrock/api_op_ListModelCustomizationJobs.go index e801f7c74e5..82910b8f4bd 100644 --- a/service/bedrock/api_op_ListModelCustomizationJobs.go +++ b/service/bedrock/api_op_ListModelCustomizationJobs.go @@ -13,9 +13,11 @@ import ( ) // Returns a list of model customization jobs that you have submitted. You can -// filter the jobs to return based on one or more criteria. For more information, -// see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// filter the jobs to return based on one or more criteria. +// +// For more information, see [Custom models] in the Amazon Bedrock User Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html func (c *Client) ListModelCustomizationJobs(ctx context.Context, params *ListModelCustomizationJobsInput, optFns ...func(*Options)) (*ListModelCustomizationJobsOutput, error) { if params == nil { params = &ListModelCustomizationJobsInput{} diff --git a/service/bedrock/api_op_ListProvisionedModelThroughputs.go b/service/bedrock/api_op_ListProvisionedModelThroughputs.go index 17c05b31d7a..7e2064ad1cf 100644 --- a/service/bedrock/api_op_ListProvisionedModelThroughputs.go +++ b/service/bedrock/api_op_ListProvisionedModelThroughputs.go @@ -12,9 +12,10 @@ import ( "time" ) -// Lists the Provisioned Throughputs in the account. For more information, see -// Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) -// in the Amazon Bedrock User Guide. +// Lists the Provisioned Throughputs in the account. For more information, see [Provisioned Throughput] in +// the Amazon Bedrock User Guide. +// +// [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html func (c *Client) ListProvisionedModelThroughputs(ctx context.Context, params *ListProvisionedModelThroughputsInput, optFns ...func(*Options)) (*ListProvisionedModelThroughputsOutput, error) { if params == nil { params = &ListProvisionedModelThroughputsInput{} @@ -35,7 +36,8 @@ type ListProvisionedModelThroughputsInput struct { // A filter that returns Provisioned Throughputs created after the specified time. CreationTimeAfter *time.Time - // A filter that returns Provisioned Throughputs created before the specified time. + // A filter that returns Provisioned Throughputs created before the specified + // time. CreationTimeBefore *time.Time // THe maximum number of results to return in the response. If there are more diff --git a/service/bedrock/api_op_ListTagsForResource.go b/service/bedrock/api_op_ListTagsForResource.go index 4a4aa4da545..250add1fcbc 100644 --- a/service/bedrock/api_op_ListTagsForResource.go +++ b/service/bedrock/api_op_ListTagsForResource.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the tags associated with the specified resource. For more information, see -// Tagging resources (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) -// in the Amazon Bedrock User Guide. +// List the tags associated with the specified resource. +// +// For more information, see [Tagging resources] in the Amazon Bedrock User Guide. +// +// [Tagging resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/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/bedrock/api_op_StopModelCustomizationJob.go b/service/bedrock/api_op_StopModelCustomizationJob.go index 568a3c06452..f1408183fd8 100644 --- a/service/bedrock/api_op_StopModelCustomizationJob.go +++ b/service/bedrock/api_op_StopModelCustomizationJob.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops an active model customization job. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) -// in the Amazon Bedrock User Guide. +// Stops an active model customization job. For more information, see [Custom models] in the +// Amazon Bedrock User Guide. +// +// [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html func (c *Client) StopModelCustomizationJob(ctx context.Context, params *StopModelCustomizationJobInput, optFns ...func(*Options)) (*StopModelCustomizationJobOutput, error) { if params == nil { params = &StopModelCustomizationJobInput{} diff --git a/service/bedrock/api_op_TagResource.go b/service/bedrock/api_op_TagResource.go index 83dabb4451e..28d01a837f9 100644 --- a/service/bedrock/api_op_TagResource.go +++ b/service/bedrock/api_op_TagResource.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate tags with a resource. For more information, see Tagging resources (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) -// in the Amazon Bedrock User Guide. +// Associate tags with a resource. For more information, see [Tagging resources] in the Amazon +// Bedrock User Guide. +// +// [Tagging resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/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/bedrock/api_op_UntagResource.go b/service/bedrock/api_op_UntagResource.go index de56fb18681..8bfbec37f34 100644 --- a/service/bedrock/api_op_UntagResource.go +++ b/service/bedrock/api_op_UntagResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Remove one or more tags from a resource. For more information, see Tagging -// resources (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) in -// the Amazon Bedrock User Guide. +// Remove one or more tags from a resource. For more information, see [Tagging resources] in the +// Amazon Bedrock User Guide. +// +// [Tagging resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/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/bedrock/api_op_UpdateGuardrail.go b/service/bedrock/api_op_UpdateGuardrail.go index a94f1ec8623..9baf5c347aa 100644 --- a/service/bedrock/api_op_UpdateGuardrail.go +++ b/service/bedrock/api_op_UpdateGuardrail.go @@ -13,34 +13,42 @@ import ( ) // Updates a guardrail with the values you specify. +// // - Specify a name and optional description . +// // - Specify messages for when the guardrail successfully blocks a prompt or a -// model response in the blockedInputMessaging and blockedOutputsMessaging -// fields. +// model response in the blockedInputMessaging and blockedOutputsMessaging fields. +// // - Specify topics for the guardrail to deny in the topicPolicyConfig object. -// Each GuardrailTopicConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html) -// object in the topicsConfig list pertains to one topic. +// Each [GuardrailTopicConfig]object in the topicsConfig list pertains to one topic. +// // - Give a name and description so that the guardrail can properly identify the // topic. +// // - Specify DENY in the type field. +// // - (Optional) Provide up to five prompts that you would categorize as // belonging to the topic in the examples list. +// // - Specify filter strengths for the harmful categories defined in Amazon -// Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) -// object in the filtersConfig list pertains to a harmful category. For more -// information, see Content filters (https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters) -// . For more information about the fields in a content filter, see -// GuardrailContentFilterConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) -// . +// Bedrock in the contentPolicyConfig object. Each [GuardrailContentFilterConfig]object in the filtersConfig +// list pertains to a harmful category. For more information, see [Content filters]. For more +// information about the fields in a content filter, see [GuardrailContentFilterConfig]. +// // - Specify the category in the type field. +// // - Specify the strength of the filter for prompts in the inputStrength field -// and for model responses in the strength field of the -// GuardrailContentFilterConfig (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) -// . +// and for model responses in the strength field of the [GuardrailContentFilterConfig]. +// // - (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. +// // - (Optional) Attach any tags to the guardrail in the tags object. For more -// information, see Tag resources (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging) -// . +// information, see [Tag resources]. +// +// [GuardrailContentFilterConfig]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html +// [Content filters]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters +// [Tag resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging +// [GuardrailTopicConfig]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html func (c *Client) UpdateGuardrail(ctx context.Context, params *UpdateGuardrailInput, optFns ...func(*Options)) (*UpdateGuardrailOutput, error) { if params == nil { params = &UpdateGuardrailInput{} diff --git a/service/bedrock/api_op_UpdateProvisionedModelThroughput.go b/service/bedrock/api_op_UpdateProvisionedModelThroughput.go index 16f5b21eed7..7e9456c53c5 100644 --- a/service/bedrock/api_op_UpdateProvisionedModelThroughput.go +++ b/service/bedrock/api_op_UpdateProvisionedModelThroughput.go @@ -11,8 +11,9 @@ import ( ) // Updates the name or associated model for a Provisioned Throughput. For more -// information, see Provisioned Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) -// in the Amazon Bedrock User Guide. +// information, see [Provisioned Throughput]in the Amazon Bedrock User Guide. +// +// [Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html func (c *Client) UpdateProvisionedModelThroughput(ctx context.Context, params *UpdateProvisionedModelThroughputInput, optFns ...func(*Options)) (*UpdateProvisionedModelThroughputOutput, error) { if params == nil { params = &UpdateProvisionedModelThroughputInput{} @@ -37,9 +38,13 @@ type UpdateProvisionedModelThroughputInput struct { // The Amazon Resource Name (ARN) of the new model to associate with this // Provisioned Throughput. You can't specify this field if this Provisioned - // Throughput is associated with a base model. If this Provisioned Throughput is - // associated with a custom model, you can specify one of the following options: + // Throughput is associated with a base model. + // + // If this Provisioned Throughput is associated with a custom model, you can + // specify one of the following options: + // // - The base model from which the custom model was customized. + // // - Another custom model that was customized from the same base model as the // custom model. DesiredModelId *string diff --git a/service/bedrock/options.go b/service/bedrock/options.go index 0faea81e708..a3dcd879401 100644 --- a/service/bedrock/options.go +++ b/service/bedrock/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/bedrock/types/enums.go b/service/bedrock/types/enums.go index 7db7f877000..9430803b30d 100644 --- a/service/bedrock/types/enums.go +++ b/service/bedrock/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for CommitmentDuration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommitmentDuration) Values() []CommitmentDuration { return []CommitmentDuration{ "OneMonth", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for CustomizationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomizationType) Values() []CustomizationType { return []CustomizationType{ "FINE_TUNING", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for EvaluationJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationJobStatus) Values() []EvaluationJobStatus { return []EvaluationJobStatus{ "InProgress", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for EvaluationJobType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationJobType) Values() []EvaluationJobType { return []EvaluationJobType{ "Human", @@ -92,8 +96,9 @@ const ( ) // Values returns all known values for EvaluationTaskType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationTaskType) Values() []EvaluationTaskType { return []EvaluationTaskType{ "Summarization", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for FineTuningJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FineTuningJobStatus) Values() []FineTuningJobStatus { return []FineTuningJobStatus{ "InProgress", @@ -138,8 +144,9 @@ const ( // Values returns all known values for FoundationModelLifecycleStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FoundationModelLifecycleStatus) Values() []FoundationModelLifecycleStatus { return []FoundationModelLifecycleStatus{ "ACTIVE", @@ -161,6 +168,7 @@ const ( // Values returns all known values for GuardrailContentFilterType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailContentFilterType) Values() []GuardrailContentFilterType { return []GuardrailContentFilterType{ @@ -184,8 +192,9 @@ const ( ) // Values returns all known values for GuardrailFilterStrength. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailFilterStrength) Values() []GuardrailFilterStrength { return []GuardrailFilterStrength{ "NONE", @@ -204,6 +213,7 @@ const ( // Values returns all known values for GuardrailManagedWordsType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailManagedWordsType) Values() []GuardrailManagedWordsType { return []GuardrailManagedWordsType{ @@ -249,8 +259,9 @@ const ( ) // Values returns all known values for GuardrailPiiEntityType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailPiiEntityType) Values() []GuardrailPiiEntityType { return []GuardrailPiiEntityType{ "ADDRESS", @@ -297,8 +308,9 @@ const ( // Values returns all known values for GuardrailSensitiveInformationAction. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailSensitiveInformationAction) Values() []GuardrailSensitiveInformationAction { return []GuardrailSensitiveInformationAction{ "BLOCK", @@ -319,8 +331,9 @@ const ( ) // Values returns all known values for GuardrailStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailStatus) Values() []GuardrailStatus { return []GuardrailStatus{ "CREATING", @@ -340,8 +353,9 @@ const ( ) // Values returns all known values for GuardrailTopicType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GuardrailTopicType) Values() []GuardrailTopicType { return []GuardrailTopicType{ "DENY", @@ -357,8 +371,9 @@ const ( ) // Values returns all known values for InferenceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InferenceType) Values() []InferenceType { return []InferenceType{ "ON_DEMAND", @@ -375,8 +390,9 @@ const ( ) // Values returns all known values for ModelCustomization. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCustomization) Values() []ModelCustomization { return []ModelCustomization{ "FINE_TUNING", @@ -397,6 +413,7 @@ const ( // Values returns all known values for ModelCustomizationJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ModelCustomizationJobStatus) Values() []ModelCustomizationJobStatus { return []ModelCustomizationJobStatus{ @@ -418,8 +435,9 @@ const ( ) // Values returns all known values for ModelModality. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelModality) Values() []ModelModality { return []ModelModality{ "TEXT", @@ -439,8 +457,9 @@ const ( ) // Values returns all known values for ProvisionedModelStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedModelStatus) Values() []ProvisionedModelStatus { return []ProvisionedModelStatus{ "Creating", @@ -458,8 +477,9 @@ const ( ) // Values returns all known values for SortByProvisionedModels. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortByProvisionedModels) Values() []SortByProvisionedModels { return []SortByProvisionedModels{ "CreationTime", @@ -474,8 +494,9 @@ const ( ) // Values returns all known values for SortJobsBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortJobsBy) Values() []SortJobsBy { return []SortJobsBy{ "CreationTime", @@ -490,8 +511,9 @@ const ( ) // Values returns all known values for SortModelsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortModelsBy) Values() []SortModelsBy { return []SortModelsBy{ "CreationTime", @@ -507,8 +529,9 @@ const ( ) // 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. +// in the future, and so 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/bedrock/types/types.go b/service/bedrock/types/types.go index 5f06ba40dbd..d78d6b1ffed 100644 --- a/service/bedrock/types/types.go +++ b/service/bedrock/types/types.go @@ -68,8 +68,9 @@ type CustomModelSummary struct { ModelName *string // Specifies whether to carry out continued pre-training of a model or whether to - // fine-tune it. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) - // . + // fine-tune it. For more information, see [Custom models]. + // + // [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html CustomizationType CustomizationType noSmithyDocumentSerde @@ -78,11 +79,14 @@ type CustomModelSummary struct { // Contains the ARN of the Amazon Bedrock models specified in your model // evaluation job. Each Amazon Bedrock model supports different inferenceParams . // To learn more about supported inference parameters for Amazon Bedrock models, -// see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html) -// . The inferenceParams are specified using JSON. To successfully insert JSON as +// see [Inference parameters for foundation models]. +// +// The inferenceParams are specified using JSON. To successfully insert JSON as // string make sure that all quotations are properly escaped. For example, // "temperature":"0.25" key value pair would need to be formatted as // \"temperature\":\"0.25\" to successfully accepted in the request. +// +// [Inference parameters for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html type EvaluationBedrockModel struct { // Each Amazon Bedrock support different inference parameters that change how the @@ -379,16 +383,20 @@ type FoundationModelSummary struct { // Contains filter strengths for harmful content. Guardrails support the following // content filters to detect and filter harmful user inputs and FM-generated // outputs. +// // - Hate – Describes language or a statement that discriminates, criticizes, // insults, denounces, or dehumanizes a person or group on the basis of an identity // (such as race, ethnicity, gender, religion, sexual orientation, ability, and // national origin). +// // - Insults – Describes language or a statement that includes demeaning, // humiliating, mocking, insulting, or belittling language. This type of language // is also labeled as bullying. +// // - Sexual – Describes language or a statement that indicates sexual interest, // activity, or arousal using direct or indirect references to body parts, physical // traits, or sex. +// // - Violence – Describes language or a statement that includes glorification of // or threats to inflict physical pain, hurt, or injury toward a person, group or // thing. @@ -401,10 +409,16 @@ type FoundationModelSummary struct { // content is high. A single statement can be classified across multiple categories // with varying confidence levels. For example, a single statement can be // classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual -// with NONE confidence, and Violence with MEDIUM confidence. For more information, -// see Guardrails content filters (https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html) -// . This data type is used in the following API operations: -// - GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax) +// with NONE confidence, and Violence with MEDIUM confidence. +// +// For more information, see [Guardrails content filters]. +// +// This data type is used in the following API operations: +// +// [GetGuardrail response body] +// +// [GetGuardrail response body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax +// [Guardrails content filters]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html type GuardrailContentFilter struct { // The strength of the content filter to apply to prompts. As you increase the @@ -432,16 +446,20 @@ type GuardrailContentFilter struct { // Contains filter strengths for harmful content. Guardrails support the following // content filters to detect and filter harmful user inputs and FM-generated // outputs. +// // - Hate – Describes language or a statement that discriminates, criticizes, // insults, denounces, or dehumanizes a person or group on the basis of an identity // (such as race, ethnicity, gender, religion, sexual orientation, ability, and // national origin). +// // - Insults – Describes language or a statement that includes demeaning, // humiliating, mocking, insulting, or belittling language. This type of language // is also labeled as bullying. +// // - Sexual – Describes language or a statement that indicates sexual interest, // activity, or arousal using direct or indirect references to body parts, physical // traits, or sex. +// // - Violence – Describes language or a statement that includes glorification of // or threats to inflict physical pain, hurt, or injury toward a person, group or // thing. @@ -454,11 +472,19 @@ type GuardrailContentFilter struct { // content is high. A single statement can be classified across multiple categories // with varying confidence levels. For example, a single statement can be // classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual -// with NONE confidence, and Violence with MEDIUM confidence. For more information, -// see Guardrails content filters (https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html) -// . This data type is used in the following API operations: -// - CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax) -// - UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax) +// with NONE confidence, and Violence with MEDIUM confidence. +// +// For more information, see [Guardrails content filters]. +// +// This data type is used in the following API operations: +// +// [CreateGuardrail request body] +// +// [UpdateGuardrail request body] +// +// [UpdateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax +// [Guardrails content filters]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html +// [CreateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax type GuardrailContentFilterConfig struct { // The strength of the content filter to apply to prompts. As you increase the @@ -483,9 +509,13 @@ type GuardrailContentFilterConfig struct { noSmithyDocumentSerde } -// Contains details about how to handle harmful content. This data type is used in -// the following API operations: -// - GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax) +// Contains details about how to handle harmful content. +// +// This data type is used in the following API operations: +// +// [GetGuardrail response body] +// +// [GetGuardrail response body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax type GuardrailContentPolicy struct { // Contains the type of the content filter and how strongly it should apply to @@ -495,10 +525,16 @@ type GuardrailContentPolicy struct { noSmithyDocumentSerde } -// Contains details about how to handle harmful content. This data type is used in -// the following API operations: -// - CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax) -// - UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax) +// Contains details about how to handle harmful content. +// +// This data type is used in the following API operations: +// +// [CreateGuardrail request body] +// +// [UpdateGuardrail request body] +// +// [UpdateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax +// [CreateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax type GuardrailContentPolicyConfig struct { // Contains the type of the content filter and how strongly it should apply to @@ -640,9 +676,13 @@ type GuardrailSensitiveInformationPolicyConfig struct { noSmithyDocumentSerde } -// Contains details about a guardrail. This data type is used in the following API -// operations: -// - ListGuardrails response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax) +// Contains details about a guardrail. +// +// This data type is used in the following API operations: +// +// [ListGuardrails response body] +// +// [ListGuardrails response body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax type GuardrailSummary struct { // The ARN of the guardrail. @@ -686,9 +726,13 @@ type GuardrailSummary struct { noSmithyDocumentSerde } -// Details about topics for the guardrail to identify and deny. This data type is -// used in the following API operations: -// - GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax) +// Details about topics for the guardrail to identify and deny. +// +// This data type is used in the following API operations: +// +// [GetGuardrail response body] +// +// [GetGuardrail response body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax type GuardrailTopic struct { // A definition of the topic to deny. @@ -711,10 +755,16 @@ type GuardrailTopic struct { noSmithyDocumentSerde } -// Details about topics for the guardrail to identify and deny. This data type is -// used in the following API operations: -// - CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax) -// - UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax) +// Details about topics for the guardrail to identify and deny. +// +// This data type is used in the following API operations: +// +// [CreateGuardrail request body] +// +// [UpdateGuardrail request body] +// +// [UpdateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax +// [CreateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax type GuardrailTopicConfig struct { // A definition of the topic to deny. @@ -739,9 +789,13 @@ type GuardrailTopicConfig struct { noSmithyDocumentSerde } -// Contains details about topics that the guardrail should identify and deny. This -// data type is used in the following API operations: -// - GetGuardrail response body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax) +// Contains details about topics that the guardrail should identify and deny. +// +// This data type is used in the following API operations: +// +// [GetGuardrail response body] +// +// [GetGuardrail response body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax type GuardrailTopicPolicy struct { // A list of policies related to topics that the guardrail should deny. @@ -752,10 +806,16 @@ type GuardrailTopicPolicy struct { noSmithyDocumentSerde } -// Contains details about topics that the guardrail should identify and deny. This -// data type is used in the following API operations: -// - CreateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax) -// - UpdateGuardrail request body (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax) +// Contains details about topics that the guardrail should identify and deny. +// +// This data type is used in the following API operations: +// +// [CreateGuardrail request body] +// +// [UpdateGuardrail request body] +// +// [UpdateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax +// [CreateGuardrail request body]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax type GuardrailTopicPolicyConfig struct { // A list of policies related to topics that the guardrail should deny. @@ -815,15 +875,18 @@ type GuardrailWordPolicyConfig struct { // Specifies the custom metrics, how tasks will be rated, the flow definition ARN, // and your custom prompt datasets. Model evaluation jobs use human workers only // support the use of custom prompt datasets. To learn more about custom prompt -// datasets and the required format, see Custom prompt datasets (https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html) -// . When you create custom metrics in HumanEvaluationCustomMetric you must -// specify the metric's name . The list of names specified in the +// datasets and the required format, see [Custom prompt datasets]. +// +// When you create custom metrics in HumanEvaluationCustomMetric you must specify +// the metric's name . The list of names specified in the // HumanEvaluationCustomMetric array, must match the metricNames array of strings // specified in EvaluationDatasetMetricConfig . For example, if in the // HumanEvaluationCustomMetric array your specified the names "accuracy", // "toxicity", "readability" as custom metrics then the metricNames array would // need to look like the following ["accuracy", "toxicity", "readability"] in // EvaluationDatasetMetricConfig . +// +// [Custom prompt datasets]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html type HumanEvaluationConfig struct { // Use to specify the metrics, task, and prompt dataset to be used in your model @@ -938,8 +1001,9 @@ type ModelCustomizationJobSummary struct { CustomModelName *string // Specifies whether to carry out continued pre-training of a model or whether to - // fine-tune it. For more information, see Custom models (https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) - // . + // fine-tune it. For more information, see [Custom models]. + // + // [Custom models]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html CustomizationType CustomizationType // Time that the customization job ended. @@ -962,9 +1026,13 @@ type OutputDataConfig struct { noSmithyDocumentSerde } -// A summary of information about a Provisioned Throughput. This data type is used -// in the following API operations: -// - ListProvisionedThroughputs response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax) +// A summary of information about a Provisioned Throughput. +// +// This data type is used in the following API operations: +// +// [ListProvisionedThroughputs response] +// +// [ListProvisionedThroughputs response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax type ProvisionedModelSummary struct { // The time that the Provisioned Throughput was created. diff --git a/service/bedrockagent/api_op_AssociateAgentKnowledgeBase.go b/service/bedrockagent/api_op_AssociateAgentKnowledgeBase.go index 44274f05618..f09676db452 100644 --- a/service/bedrockagent/api_op_AssociateAgentKnowledgeBase.go +++ b/service/bedrockagent/api_op_AssociateAgentKnowledgeBase.go @@ -52,8 +52,9 @@ type AssociateAgentKnowledgeBaseInput struct { // This member is required. KnowledgeBaseId *string - // Specifies whether to use the knowledge base or not when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) - // request. + // Specifies whether to use the knowledge base or not when sending an [InvokeAgent] request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html KnowledgeBaseState types.KnowledgeBaseState noSmithyDocumentSerde diff --git a/service/bedrockagent/api_op_CreateAgent.go b/service/bedrockagent/api_op_CreateAgent.go index 9f1d2812283..d1c0959cd7e 100644 --- a/service/bedrockagent/api_op_CreateAgent.go +++ b/service/bedrockagent/api_op_CreateAgent.go @@ -14,20 +14,27 @@ import ( // Creates an agent that orchestrates interactions between foundation models, data // sources, software applications, user conversations, and APIs to carry out tasks // to help customers. +// // - Specify the following fields for security purposes. +// // - agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with // permissions to invoke API operations on an agent. +// // - (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a // KMS key to encrypt the creation of the agent. +// // - (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which // the agent should maintain session information. After this time expires, the // subsequent InvokeAgent request begins a new session. +// // - To override the default prompt behavior for agent orchestration and to use // advanced prompts, include a promptOverrideConfiguration object. For more -// information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) -// . +// information, see [Advanced prompts]. +// // - If you agent fails to be created, the response returns a list of // failureReasons alongside a list of recommendedActions for you to troubleshoot. +// +// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error) { if params == nil { params = &CreateAgentInput{} @@ -56,9 +63,9 @@ type CreateAgentInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent. @@ -71,9 +78,11 @@ type CreateAgentInput struct { FoundationModel *string // The number of seconds for which Amazon Bedrock keeps information about a user's - // conversation with the agent. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Bedrock deletes any data provided before the timeout. + // conversation with the agent. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Bedrock + // deletes any data provided before the timeout. IdleSessionTTLInSeconds *int32 // Instructions that tell the agent what it should do and how it should interact @@ -81,8 +90,9 @@ type CreateAgentInput struct { Instruction *string // Contains configurations to override prompts in different parts of an agent - // sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) - // . + // sequence. For more information, see [Advanced prompts]. + // + // [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html PromptOverrideConfiguration *types.PromptOverrideConfiguration // Any tags that you want to attach to the agent. diff --git a/service/bedrockagent/api_op_CreateAgentActionGroup.go b/service/bedrockagent/api_op_CreateAgentActionGroup.go index 172d9f62923..e0de719f4e5 100644 --- a/service/bedrockagent/api_op_CreateAgentActionGroup.go +++ b/service/bedrockagent/api_op_CreateAgentActionGroup.go @@ -13,15 +13,17 @@ import ( // Creates an action group for an agent. An action group represents the actions // that an agent can carry out for the customer by defining the APIs that an agent -// can call and the logic for calling them. To allow your agent to request the user -// for additional information when trying to complete a task, add an action group -// with the parentActionGroupSignature field set to AMAZON.UserInput . You must -// leave the description , apiSchema , and actionGroupExecutor fields blank for -// this action group. During orchestration, if your agent determines that it needs -// to invoke an API in an action group, but doesn't have enough information to -// complete the API request, it will invoke this action group instead and return an -// Observation (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) -// reprompting the user for more information. +// can call and the logic for calling them. +// +// To allow your agent to request the user for additional information when trying +// to complete a task, add an action group with the parentActionGroupSignature +// field set to AMAZON.UserInput . You must leave the description , apiSchema , and +// actionGroupExecutor fields blank for this action group. During orchestration, if +// your agent determines that it needs to invoke an API in an action group, but +// doesn't have enough information to complete the API request, it will invoke this +// action group instead and return an [Observation]reprompting the user for more information. +// +// [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html func (c *Client) CreateAgentActionGroup(ctx context.Context, params *CreateAgentActionGroupInput, optFns ...func(*Options)) (*CreateAgentActionGroupOutput, error) { if params == nil { params = &CreateAgentActionGroupInput{} @@ -60,21 +62,23 @@ type CreateAgentActionGroupInput struct { ActionGroupExecutor types.ActionGroupExecutor // Specifies whether the action group is available for the agent to invoke or not - // when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) - // request. + // when sending an [InvokeAgent]request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html ActionGroupState types.ActionGroupState // Contains either details about the S3 object containing the OpenAPI schema for // the action group or the JSON or YAML-formatted payload defining the schema. For - // more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html) - // . + // more information, see [Action group OpenAPI schemas]. + // + // [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html ApiSchema types.APISchema // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description of the action group. @@ -87,10 +91,14 @@ type CreateAgentActionGroupInput struct { // To allow your agent to request the user for additional information when trying // to complete a task, set this field to AMAZON.UserInput . You must leave the // description , apiSchema , and actionGroupExecutor fields blank for this action - // group. During orchestration, if your agent determines that it needs to invoke an - // API in an action group, but doesn't have enough information to complete the API - // request, it will invoke this action group instead and return an Observation (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) - // reprompting the user for more information. + // group. + // + // During orchestration, if your agent determines that it needs to invoke an API + // in an action group, but doesn't have enough information to complete the API + // request, it will invoke this action group instead and return an [Observation]reprompting the + // user for more information. + // + // [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html ParentActionGroupSignature types.ActionGroupSignature noSmithyDocumentSerde diff --git a/service/bedrockagent/api_op_CreateAgentAlias.go b/service/bedrockagent/api_op_CreateAgentAlias.go index b594e9f784c..72004345681 100644 --- a/service/bedrockagent/api_op_CreateAgentAlias.go +++ b/service/bedrockagent/api_op_CreateAgentAlias.go @@ -41,9 +41,9 @@ type CreateAgentAliasInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description of the alias of the agent. diff --git a/service/bedrockagent/api_op_CreateDataSource.go b/service/bedrockagent/api_op_CreateDataSource.go index ab29d4977ef..31e9f139afc 100644 --- a/service/bedrockagent/api_op_CreateDataSource.go +++ b/service/bedrockagent/api_op_CreateDataSource.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets up a data source to be added to a knowledge base. You can't change the -// chunkingConfiguration after you create the data source. +// Sets up a data source to be added to a knowledge base. +// +// You can't change the chunkingConfiguration after you create the data source. func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error) { if params == nil { params = &CreateDataSourceInput{} @@ -47,9 +48,9 @@ type CreateDataSourceInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The data deletion policy assigned to the data source. diff --git a/service/bedrockagent/api_op_CreateKnowledgeBase.go b/service/bedrockagent/api_op_CreateKnowledgeBase.go index 5b57c18abc2..b534a21aaa9 100644 --- a/service/bedrockagent/api_op_CreateKnowledgeBase.go +++ b/service/bedrockagent/api_op_CreateKnowledgeBase.go @@ -14,32 +14,40 @@ import ( // Creates a knowledge base that contains data sources from which information can // be queried and used by LLMs. To create a knowledge base, you must first set up // your data sources and configure a supported vector store. For more information, -// see Set up your data for ingestion (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html) -// . If you prefer to let Amazon Bedrock create and manage a vector store for you -// in Amazon OpenSearch Service, use the console. For more information, see Create -// a knowledge base (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create) -// . +// see [Set up your data for ingestion]. +// +// If you prefer to let Amazon Bedrock create and manage a vector store for you in +// Amazon OpenSearch Service, use the console. For more information, see [Create a knowledge base]. +// // - Provide the name and an optional description . +// // - Provide the Amazon Resource Name (ARN) with permissions to create a // knowledge base in the roleArn field. +// // - Provide the embedding model to use in the embeddingModelArn field in the // knowledgeBaseConfiguration object. +// // - Provide the configuration for your vector store in the storageConfiguration // object. +// // - For an Amazon OpenSearch Service database, use the -// opensearchServerlessConfiguration object. For more information, see Create a -// vector store in Amazon OpenSearch Service (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html) -// . +// opensearchServerlessConfiguration object. For more information, see [Create a vector store in Amazon OpenSearch Service]. +// // - For an Amazon Aurora database, use the RdsConfiguration object. For more -// information, see Create a vector store in Amazon Aurora (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) -// . +// information, see [Create a vector store in Amazon Aurora]. +// // - For a Pinecone database, use the pineconeConfiguration object. For more -// information, see Create a vector store in Pinecone (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html) -// . +// information, see [Create a vector store in Pinecone]. +// // - For a Redis Enterprise Cloud database, use the -// redisEnterpriseCloudConfiguration object. For more information, see Create a -// vector store in Redis Enterprise Cloud (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html) -// . +// redisEnterpriseCloudConfiguration object. For more information, see [Create a vector store in Redis Enterprise Cloud]. +// +// [Set up your data for ingestion]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html +// [Create a knowledge base]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create +// [Create a vector store in Amazon OpenSearch Service]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html +// [Create a vector store in Redis Enterprise Cloud]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html +// [Create a vector store in Amazon Aurora]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html +// [Create a vector store in Pinecone]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error) { if params == nil { params = &CreateKnowledgeBaseInput{} @@ -81,9 +89,9 @@ type CreateKnowledgeBaseInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description of the knowledge base. diff --git a/service/bedrockagent/api_op_DeleteKnowledgeBase.go b/service/bedrockagent/api_op_DeleteKnowledgeBase.go index ea77eabecdb..62a0c673cf1 100644 --- a/service/bedrockagent/api_op_DeleteKnowledgeBase.go +++ b/service/bedrockagent/api_op_DeleteKnowledgeBase.go @@ -13,8 +13,9 @@ import ( // Deletes a knowledge base. Before deleting a knowledge base, you should // disassociate the knowledge base from any agents that it is associated with by -// making a DisassociateAgentKnowledgeBase (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html) -// request. +// making a [DisassociateAgentKnowledgeBase]request. +// +// [DisassociateAgentKnowledgeBase]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error) { if params == nil { params = &DeleteKnowledgeBaseInput{} diff --git a/service/bedrockagent/api_op_StartIngestionJob.go b/service/bedrockagent/api_op_StartIngestionJob.go index 8ad8c4c5408..ec4cb06b0e5 100644 --- a/service/bedrockagent/api_op_StartIngestionJob.go +++ b/service/bedrockagent/api_op_StartIngestionJob.go @@ -41,9 +41,9 @@ type StartIngestionJobInput struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description of the ingestion job. diff --git a/service/bedrockagent/api_op_TagResource.go b/service/bedrockagent/api_op_TagResource.go index 7ba322e2144..d736af699f9 100644 --- a/service/bedrockagent/api_op_TagResource.go +++ b/service/bedrockagent/api_op_TagResource.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate tags with a resource. For more information, see Tagging resources (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) -// in the Amazon Bedrock User Guide. +// Associate tags with a resource. For more information, see [Tagging resources] in the Amazon +// Bedrock User Guide. +// +// [Tagging resources]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/bedrockagent/api_op_UpdateAgent.go b/service/bedrockagent/api_op_UpdateAgent.go index 54d03708816..407d2dae089 100644 --- a/service/bedrockagent/api_op_UpdateAgent.go +++ b/service/bedrockagent/api_op_UpdateAgent.go @@ -57,9 +57,11 @@ type UpdateAgentInput struct { Description *string // The number of seconds for which Amazon Bedrock keeps information about a user's - // conversation with the agent. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Bedrock deletes any data provided before the timeout. + // conversation with the agent. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Bedrock + // deletes any data provided before the timeout. IdleSessionTTLInSeconds *int32 // Specifies new instructions that tell the agent what it should do and how it @@ -67,8 +69,9 @@ type UpdateAgentInput struct { Instruction *string // Contains configurations to override prompts in different parts of an agent - // sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) - // . + // sequence. For more information, see [Advanced prompts]. + // + // [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html PromptOverrideConfiguration *types.PromptOverrideConfiguration noSmithyDocumentSerde diff --git a/service/bedrockagent/api_op_UpdateAgentActionGroup.go b/service/bedrockagent/api_op_UpdateAgentActionGroup.go index cbf045cd10a..3cab670090e 100644 --- a/service/bedrockagent/api_op_UpdateAgentActionGroup.go +++ b/service/bedrockagent/api_op_UpdateAgentActionGroup.go @@ -54,14 +54,16 @@ type UpdateAgentActionGroupInput struct { ActionGroupExecutor types.ActionGroupExecutor // Specifies whether the action group is available for the agent to invoke or not - // when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) - // request. + // when sending an [InvokeAgent]request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html ActionGroupState types.ActionGroupState // Contains either details about the S3 object containing the OpenAPI schema for // the action group or the JSON or YAML-formatted payload defining the schema. For - // more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html) - // . + // more information, see [Action group OpenAPI schemas]. + // + // [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html ApiSchema types.APISchema // Specifies a new name for the action group. @@ -74,10 +76,14 @@ type UpdateAgentActionGroupInput struct { // To allow your agent to request the user for additional information when trying // to complete a task, set this field to AMAZON.UserInput . You must leave the // description , apiSchema , and actionGroupExecutor fields blank for this action - // group. During orchestration, if your agent determines that it needs to invoke an - // API in an action group, but doesn't have enough information to complete the API - // request, it will invoke this action group instead and return an Observation (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) - // reprompting the user for more information. + // group. + // + // During orchestration, if your agent determines that it needs to invoke an API + // in an action group, but doesn't have enough information to complete the API + // request, it will invoke this action group instead and return an [Observation]reprompting the + // user for more information. + // + // [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html ParentActionGroupSignature types.ActionGroupSignature noSmithyDocumentSerde diff --git a/service/bedrockagent/api_op_UpdateAgentKnowledgeBase.go b/service/bedrockagent/api_op_UpdateAgentKnowledgeBase.go index b8201573aa5..3088176ede4 100644 --- a/service/bedrockagent/api_op_UpdateAgentKnowledgeBase.go +++ b/service/bedrockagent/api_op_UpdateAgentKnowledgeBase.go @@ -51,9 +51,10 @@ type UpdateAgentKnowledgeBaseInput struct { // Specifies a new description for the knowledge base associated with an agent. Description *string - // Specifies whether the agent uses the knowledge base or not when sending an - // InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // Specifies whether the agent uses the knowledge base or not when sending an [InvokeAgent] // request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html KnowledgeBaseState types.KnowledgeBaseState noSmithyDocumentSerde diff --git a/service/bedrockagent/api_op_UpdateDataSource.go b/service/bedrockagent/api_op_UpdateDataSource.go index ebdd89141a4..7816a588556 100644 --- a/service/bedrockagent/api_op_UpdateDataSource.go +++ b/service/bedrockagent/api_op_UpdateDataSource.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates configurations for a data source. You can't change the -// chunkingConfiguration after you create the data source. Specify the existing -// chunkingConfiguration . +// Updates configurations for a data source. +// +// You can't change the chunkingConfiguration after you create the data source. +// Specify the existing chunkingConfiguration . func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error) { if params == nil { params = &UpdateDataSourceInput{} diff --git a/service/bedrockagent/api_op_UpdateKnowledgeBase.go b/service/bedrockagent/api_op_UpdateKnowledgeBase.go index 600a2e72f89..7918b2a317f 100644 --- a/service/bedrockagent/api_op_UpdateKnowledgeBase.go +++ b/service/bedrockagent/api_op_UpdateKnowledgeBase.go @@ -13,15 +13,21 @@ import ( // Updates the configuration of a knowledge base with the fields that you specify. // Because all fields will be overwritten, you must include the same values for -// fields that you want to keep the same. You can change the following fields: +// fields that you want to keep the same. +// +// You can change the following fields: +// // - name +// // - description +// // - roleArn // // You can't change the knowledgeBaseConfiguration or storageConfiguration fields, // so you must specify the same configurations as when you created the knowledge -// base. You can send a GetKnowledgeBase (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html) -// request and copy the same configurations. +// base. You can send a [GetKnowledgeBase]request and copy the same configurations. +// +// [GetKnowledgeBase]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html func (c *Client) UpdateKnowledgeBase(ctx context.Context, params *UpdateKnowledgeBaseInput, optFns ...func(*Options)) (*UpdateKnowledgeBaseOutput, error) { if params == nil { params = &UpdateKnowledgeBaseInput{} diff --git a/service/bedrockagent/options.go b/service/bedrockagent/options.go index 763f8c1e7d7..d5244741bcd 100644 --- a/service/bedrockagent/options.go +++ b/service/bedrockagent/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/bedrockagent/types/enums.go b/service/bedrockagent/types/enums.go index 6521a8a3203..57af6193e04 100644 --- a/service/bedrockagent/types/enums.go +++ b/service/bedrockagent/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for ActionGroupSignature. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionGroupSignature) Values() []ActionGroupSignature { return []ActionGroupSignature{ "AMAZON.UserInput", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for ActionGroupState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionGroupState) Values() []ActionGroupState { return []ActionGroupState{ "ENABLED", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for AgentAliasStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentAliasStatus) Values() []AgentAliasStatus { return []AgentAliasStatus{ "CREATING", @@ -75,8 +78,9 @@ const ( ) // Values returns all known values for AgentStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentStatus) Values() []AgentStatus { return []AgentStatus{ "CREATING", @@ -99,8 +103,9 @@ const ( ) // Values returns all known values for ChunkingStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChunkingStrategy) Values() []ChunkingStrategy { return []ChunkingStrategy{ "FIXED_SIZE", @@ -117,8 +122,9 @@ const ( ) // Values returns all known values for CreationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreationMode) Values() []CreationMode { return []CreationMode{ "DEFAULT", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for CustomControlMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomControlMethod) Values() []CustomControlMethod { return []CustomControlMethod{ "RETURN_CONTROL", @@ -151,8 +158,9 @@ const ( ) // Values returns all known values for DataDeletionPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataDeletionPolicy) Values() []DataDeletionPolicy { return []DataDeletionPolicy{ "RETAIN", @@ -170,8 +178,9 @@ const ( ) // Values returns all known values for DataSourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceStatus) Values() []DataSourceStatus { return []DataSourceStatus{ "AVAILABLE", @@ -188,8 +197,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "S3", @@ -205,6 +215,7 @@ const ( // Values returns all known values for IngestionJobFilterAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IngestionJobFilterAttribute) Values() []IngestionJobFilterAttribute { return []IngestionJobFilterAttribute{ @@ -221,6 +232,7 @@ const ( // Values returns all known values for IngestionJobFilterOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IngestionJobFilterOperator) Values() []IngestionJobFilterOperator { return []IngestionJobFilterOperator{ @@ -238,6 +250,7 @@ const ( // Values returns all known values for IngestionJobSortByAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IngestionJobSortByAttribute) Values() []IngestionJobSortByAttribute { return []IngestionJobSortByAttribute{ @@ -257,8 +270,9 @@ const ( ) // Values returns all known values for IngestionJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionJobStatus) Values() []IngestionJobStatus { return []IngestionJobStatus{ "STARTING", @@ -277,8 +291,9 @@ const ( ) // Values returns all known values for KnowledgeBaseState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseState) Values() []KnowledgeBaseState { return []KnowledgeBaseState{ "ENABLED", @@ -299,8 +314,9 @@ const ( ) // Values returns all known values for KnowledgeBaseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus { return []KnowledgeBaseStatus{ "CREATING", @@ -325,6 +341,7 @@ const ( // Values returns all known values for KnowledgeBaseStorageType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseStorageType) Values() []KnowledgeBaseStorageType { return []KnowledgeBaseStorageType{ @@ -344,8 +361,9 @@ const ( ) // Values returns all known values for KnowledgeBaseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseType) Values() []KnowledgeBaseType { return []KnowledgeBaseType{ "VECTOR", @@ -361,8 +379,9 @@ const ( ) // Values returns all known values for PromptState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PromptState) Values() []PromptState { return []PromptState{ "ENABLED", @@ -381,8 +400,9 @@ const ( ) // Values returns all known values for PromptType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PromptType) Values() []PromptType { return []PromptType{ "PRE_PROCESSING", @@ -401,8 +421,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -422,8 +443,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "string", diff --git a/service/bedrockagent/types/types.go b/service/bedrockagent/types/types.go index 142b699b5ff..27f4f48d1f6 100644 --- a/service/bedrockagent/types/types.go +++ b/service/bedrockagent/types/types.go @@ -53,8 +53,9 @@ type ActionGroupSummary struct { ActionGroupName *string // Specifies whether the action group is available for the agent to invoke or not - // when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) - // request. + // when sending an [InvokeAgent]request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html // // This member is required. ActionGroupState ActionGroupState @@ -96,12 +97,19 @@ type Agent struct { // The status of the agent and whether it is ready for use. The following statuses // are possible: + // // - CREATING – The agent is being created. + // // - PREPARING – The agent is being prepared. + // // - PREPARED – The agent is prepared and ready to be invoked. + // // - NOT_PREPARED – The agent has been created but not yet prepared. + // // - FAILED – The agent API operation failed. + // // - UPDATING – The agent is being updated. + // // - DELETING – The agent is being deleted. // // This member is required. @@ -118,9 +126,11 @@ type Agent struct { CreatedAt *time.Time // The number of seconds for which Amazon Bedrock keeps information about a user's - // conversation with the agent. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Bedrock deletes any data provided before the timeout. + // conversation with the agent. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Bedrock + // deletes any data provided before the timeout. // // This member is required. IdleSessionTTLInSeconds *int32 @@ -132,9 +142,9 @@ type Agent struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The Amazon Resource Name (ARN) of the KMS key that encrypts the agent. @@ -157,8 +167,9 @@ type Agent struct { PreparedAt *time.Time // Contains configurations to override prompt templates in different parts of an - // agent sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) - // . + // agent sequence. For more information, see [Advanced prompts]. + // + // [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html PromptOverrideConfiguration *PromptOverrideConfiguration // Contains recommended actions to take for the agent-related API that you invoked @@ -182,8 +193,9 @@ type AgentActionGroup struct { ActionGroupName *string // Specifies whether the action group is available for the agent to invoke or not - // when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) - // request. + // when sending an [InvokeAgent]request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html // // This member is required. ActionGroupState ActionGroupState @@ -215,15 +227,16 @@ type AgentActionGroup struct { // Contains either details about the S3 object containing the OpenAPI schema for // the action group or the JSON or YAML-formatted payload defining the schema. For - // more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html) - // . + // more information, see [Action group OpenAPI schemas]. + // + // [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html ApiSchema APISchema // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The description of the action group. @@ -236,10 +249,13 @@ type AgentActionGroup struct { // If this field is set as AMAZON.UserInput , the agent can request the user for // additional information when trying to complete a task. The description , // apiSchema , and actionGroupExecutor fields must be blank for this action group. + // // During orchestration, if the agent determines that it needs to invoke an API in // an action group, but doesn't have enough information to complete the API - // request, it will invoke this action group instead and return an Observation (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) - // reprompting the user for more information. + // request, it will invoke this action group instead and return an [Observation]reprompting the + // user for more information. + // + // [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html ParentActionSignature ActionGroupSignature noSmithyDocumentSerde @@ -265,11 +281,16 @@ type AgentAlias struct { // The status of the alias of the agent and whether it is ready for use. The // following statuses are possible: + // // - CREATING – The agent alias is being created. + // // - PREPARED – The agent alias is finished being created or updated and is // ready to be invoked. + // // - FAILED – The agent alias API operation failed. + // // - UPDATING – The agent alias is being updated. + // // - DELETING – The agent alias is being deleted. // // This member is required. @@ -300,9 +321,9 @@ type AgentAlias struct { // A unique, case-sensitive identifier to ensure that the API request completes no // more than one time. If this token matches a previous request, Amazon Bedrock - // ignores the request, but does not return an error. For more information, see - // Ensuring idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) - // . + // ignores the request, but does not return an error. For more information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The description of the alias of the agent. @@ -412,8 +433,9 @@ type AgentKnowledgeBase struct { // This member is required. KnowledgeBaseId *string - // Specifies whether to use the knowledge base or not when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) - // request. + // Specifies whether to use the knowledge base or not when sending an [InvokeAgent] request. + // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html // // This member is required. KnowledgeBaseState KnowledgeBaseState @@ -435,10 +457,11 @@ type AgentKnowledgeBaseSummary struct { // This member is required. KnowledgeBaseId *string - // Specifies whether the agent uses the knowledge base or not when sending an - // InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // Specifies whether the agent uses the knowledge base or not when sending an [InvokeAgent] // request. // + // [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html + // // This member is required. KnowledgeBaseState KnowledgeBaseState @@ -520,9 +543,11 @@ type AgentVersion struct { CreatedAt *time.Time // The number of seconds for which Amazon Bedrock keeps information about a user's - // conversation with the agent. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Bedrock deletes any data provided before the timeout. + // conversation with the agent. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Bedrock + // deletes any data provided before the timeout. // // This member is required. IdleSessionTTLInSeconds *int32 @@ -553,8 +578,9 @@ type AgentVersion struct { Instruction *string // Contains configurations to override prompt templates in different parts of an - // agent sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) - // . + // agent sequence. For more information, see [Advanced prompts]. + // + // [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html PromptOverrideConfiguration *PromptOverrideConfiguration // A list of recommended actions to take for the failed API operation on the @@ -599,21 +625,24 @@ type AgentVersionSummary struct { } // Contains details about the OpenAPI schema for the action group. For more -// information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html) -// . You can either include the schema directly in the payload field or you can -// upload it to an S3 bucket and specify the S3 bucket location in the s3 field. +// information, see [Action group OpenAPI schemas]. You can either include the schema directly in the payload +// field or you can upload it to an S3 bucket and specify the S3 bucket location in +// the s3 field. // // The following types satisfy this interface: // // APISchemaMemberPayload // APISchemaMemberS3 +// +// [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html type APISchema interface { isAPISchema() } // The JSON or YAML-formatted payload defining the OpenAPI schema for the action -// group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html) -// . +// group. For more information, see [Action group OpenAPI schemas]. +// +// [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html type APISchemaMemberPayload struct { Value string @@ -623,8 +652,9 @@ type APISchemaMemberPayload struct { func (*APISchemaMemberPayload) isAPISchema() {} // Contains details about the S3 object containing the OpenAPI schema for the -// action group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html) -// . +// action group. For more information, see [Action group OpenAPI schemas]. +// +// [Action group OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html type APISchemaMemberS3 struct { Value S3Identifier @@ -643,8 +673,10 @@ type ChunkingConfiguration struct { // belongs to is queried. You have the following options for chunking your data. If // you opt for NONE , then you may want to pre-process your files by splitting them // up such that each file corresponds to a chunk. + // // - FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the // approximate size that you set in the fixedSizeChunkingConfiguration . + // // - NONE – Amazon Bedrock treats each file as one chunk. If you choose this // option, you may want to pre-process your documents by splitting them into // separate files. @@ -688,8 +720,10 @@ type DataSource struct { Name *string // The status of the data source. The following statuses are possible: + // // - Available – The data source has been created and is ready for ingestion // into the knowledge base. + // // - Deleting – The data source is being deleted. // // This member is required. @@ -785,13 +819,25 @@ type FixedSizeChunkingConfiguration struct { } // Defines parameters that the agent needs to invoke from the user to complete the -// function. Corresponds to an action in an action group. This data type is used in -// the following API operations: -// - CreateAgentActionGroup request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax) -// - CreateAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax) -// - UpdateAgentActionGroup request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax) -// - UpdateAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax) -// - GetAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax) +// function. Corresponds to an action in an action group. +// +// This data type is used in the following API operations: +// +// [CreateAgentActionGroup request] +// +// [CreateAgentActionGroup response] +// +// [UpdateAgentActionGroup request] +// +// [UpdateAgentActionGroup response] +// +// [GetAgentActionGroup response] +// +// [CreateAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax +// [GetAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax +// [UpdateAgentActionGroup request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax +// [CreateAgentActionGroup request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax +// [UpdateAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax type Function struct { // A name for the function. @@ -809,17 +855,29 @@ type Function struct { } // Defines functions that each define parameters that the agent needs to invoke -// from the user. Each function represents an action in an action group. This data -// type is used in the following API operations: -// - CreateAgentActionGroup request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax) -// - CreateAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax) -// - UpdateAgentActionGroup request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax) -// - UpdateAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax) -// - GetAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax) +// from the user. Each function represents an action in an action group. +// +// This data type is used in the following API operations: +// +// [CreateAgentActionGroup request] +// +// [CreateAgentActionGroup response] +// +// [UpdateAgentActionGroup request] +// +// [UpdateAgentActionGroup response] +// +// [GetAgentActionGroup response] // // The following types satisfy this interface: // // FunctionSchemaMemberFunctions +// +// [CreateAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax +// [GetAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax +// [UpdateAgentActionGroup request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax +// [CreateAgentActionGroup request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax +// [UpdateAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax type FunctionSchema interface { isFunctionSchema() } @@ -835,8 +893,9 @@ func (*FunctionSchemaMemberFunctions) isFunctionSchema() {} // Contains inference parameters to use when the agent invokes a foundation model // in the part of the agent sequence defined by the promptType . For more -// information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) -// . +// information, see [Inference parameters for foundation models]. +// +// [Inference parameters for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html type InferenceConfiguration struct { // The maximum number of tokens to allow in the generated response. @@ -871,11 +930,19 @@ type InferenceConfiguration struct { } // Contains details about an ingestion job, which converts a data source to -// embeddings for a vector store in knowledge base. This data type is used in the -// following API operations: -// - StartIngestionJob response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax) -// - GetIngestionJob response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax) -// - ListIngestionJob response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax) +// embeddings for a vector store in knowledge base. +// +// This data type is used in the following API operations: +// +// [StartIngestionJob response] +// +// [GetIngestionJob response] +// +// [ListIngestionJob response] +// +// [StartIngestionJob response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax +// [ListIngestionJob response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax +// [GetIngestionJob response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax type IngestionJob struct { // The unique identifier of the ingested data source. @@ -1066,10 +1133,15 @@ type KnowledgeBase struct { RoleArn *string // The status of the knowledge base. The following statuses are possible: + // // - CREATING – The knowledge base is being created. + // // - ACTIVE – The knowledge base is ready to be queried. + // // - DELETING – The knowledge base is being deleted. + // // - UPDATING – The knowledge base is being updated. + // // - FAILED – The knowledge base API operation failed. // // This member is required. @@ -1207,9 +1279,9 @@ type MongoDbAtlasFieldMapping struct { } // Contains details about the storage configuration of the knowledge base in -// Amazon OpenSearch Service. For more information, see Create a vector index in -// Amazon OpenSearch Service (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html) -// . +// Amazon OpenSearch Service. For more information, see [Create a vector index in Amazon OpenSearch Service]. +// +// [Create a vector index in Amazon OpenSearch Service]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html type OpenSearchServerlessConfiguration struct { // The Amazon Resource Name (ARN) of the OpenSearch Service vector store. @@ -1256,13 +1328,25 @@ type OpenSearchServerlessFieldMapping struct { noSmithyDocumentSerde } -// Contains details about a parameter in a function for an action group. This data -// type is used in the following API operations: -// - CreateAgentActionGroup request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax) -// - CreateAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax) -// - UpdateAgentActionGroup request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax) -// - UpdateAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax) -// - GetAgentActionGroup response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax) +// Contains details about a parameter in a function for an action group. +// +// This data type is used in the following API operations: +// +// [CreateAgentActionGroup request] +// +// [CreateAgentActionGroup response] +// +// [UpdateAgentActionGroup request] +// +// [UpdateAgentActionGroup response] +// +// [GetAgentActionGroup response] +// +// [CreateAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax +// [GetAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax +// [UpdateAgentActionGroup request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax +// [CreateAgentActionGroup request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax +// [UpdateAgentActionGroup response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax type ParameterDetail struct { // The data type of the parameter. @@ -1282,8 +1366,9 @@ type ParameterDetail struct { } // Contains details about the storage configuration of the knowledge base in -// Pinecone. For more information, see Create a vector index in Pinecone (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html) -// . +// Pinecone. For more information, see [Create a vector index in Pinecone]. +// +// [Create a vector index in Pinecone]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html type PineconeConfiguration struct { // The endpoint URL for your index management page. @@ -1329,27 +1414,31 @@ type PineconeFieldMapping struct { } // Contains configurations to override a prompt template in one part of an agent -// sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) -// . +// sequence. For more information, see [Advanced prompts]. +// +// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html type PromptConfiguration struct { // Defines the prompt template with which to replace the default prompt template. // You can use placeholder variables in the base prompt template to customize the - // prompt. For more information, see Prompt template placeholder variables (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html) - // . + // prompt. For more information, see [Prompt template placeholder variables]. + // + // [Prompt template placeholder variables]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html BasePromptTemplate *string // Contains inference parameters to use when the agent invokes a foundation model // in the part of the agent sequence defined by the promptType . For more - // information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) - // . + // information, see [Inference parameters for foundation models]. + // + // [Inference parameters for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html InferenceConfiguration *InferenceConfiguration // Specifies whether to override the default parser Lambda function when parsing // the raw foundation model output in the part of the agent sequence defined by the // promptType . If you set the field as OVERRIDEN , the overrideLambda field in - // the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) - // must be specified with the ARN of a Lambda function. + // the [PromptOverrideConfiguration]must be specified with the ARN of a Lambda function. + // + // [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html ParserMode CreationMode // Specifies whether to override the default prompt template for this promptType . @@ -1361,9 +1450,13 @@ type PromptConfiguration struct { // Specifies whether to allow the agent to carry out the step specified in the // promptType . If you set this value to DISABLED , the agent skips that step. The // default state for each promptType is as follows. + // // - PRE_PROCESSING – ENABLED + // // - ORCHESTRATION – ENABLED + // // - KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED + // // - POST_PROCESSING – DISABLED PromptState PromptState @@ -1374,13 +1467,15 @@ type PromptConfiguration struct { } // Contains configurations to override prompts in different parts of an agent -// sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) -// . +// sequence. For more information, see [Advanced prompts]. +// +// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html type PromptOverrideConfiguration struct { // Contains configurations to override a prompt template in one part of an agent - // sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) - // . + // sequence. For more information, see [Advanced prompts]. + // + // [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html // // This member is required. PromptConfigurations []PromptConfiguration @@ -1395,8 +1490,9 @@ type PromptOverrideConfiguration struct { } // Contains details about the storage configuration of the knowledge base in -// Amazon RDS. For more information, see Create a vector index in Amazon RDS (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) -// . +// Amazon RDS. For more information, see [Create a vector index in Amazon RDS]. +// +// [Create a vector index in Amazon RDS]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html type RdsConfiguration struct { // The Amazon Resource Name (ARN) of the secret that you created in Secrets @@ -1460,9 +1556,9 @@ type RdsFieldMapping struct { } // Contains details about the storage configuration of the knowledge base in Redis -// Enterprise Cloud. For more information, see Create a vector index in Redis -// Enterprise Cloud (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html) -// . +// Enterprise Cloud. For more information, see [Create a vector index in Redis Enterprise Cloud]. +// +// [Create a vector index in Redis Enterprise Cloud]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html type RedisEnterpriseCloudConfiguration struct { // The Amazon Resource Name (ARN) of the secret that you created in Secrets @@ -1527,8 +1623,9 @@ type S3DataSourceConfiguration struct { BucketOwnerAccountId *string // A list of S3 prefixes that define the object containing the data sources. For - // more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) - // . + // more information, see [Organizing objects using prefixes]. + // + // [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html InclusionPrefixes []string noSmithyDocumentSerde @@ -1574,8 +1671,9 @@ type StorageConfiguration struct { PineconeConfiguration *PineconeConfiguration // Contains details about the storage configuration of the knowledge base in - // Amazon RDS. For more information, see Create a vector index in Amazon RDS (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) - // . + // Amazon RDS. For more information, see [Create a vector index in Amazon RDS]. + // + // [Create a vector index in Amazon RDS]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html RdsConfiguration *RdsConfiguration // Contains the storage configuration of the knowledge base in Redis Enterprise diff --git a/service/bedrockagentruntime/api_op_InvokeAgent.go b/service/bedrockagentruntime/api_op_InvokeAgent.go index 0bca212e288..d4228f73e77 100644 --- a/service/bedrockagentruntime/api_op_InvokeAgent.go +++ b/service/bedrockagentruntime/api_op_InvokeAgent.go @@ -13,24 +13,35 @@ import ( ) // Sends a prompt for the agent to process and respond to. Use return control -// event type for function calling. The CLI doesn't support InvokeAgent . +// event type for function calling. +// +// The CLI doesn't support InvokeAgent . +// // - To continue the same conversation with an agent, use the same sessionId // value in the request. +// // - To activate trace enablement, turn enableTrace to true . Trace enablement // helps you follow the agent's reasoning process that led it to the information it // processed, the actions it took, and the final result it yielded. For more -// information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events) -// . +// information, see [Trace enablement]. +// // - End a conversation by setting endSession to true . +// // - In the sessionState object, you can include attributes for the session or // prompt or parameters returned from the action group. +// // - Use return control event type for function calling. // // The response is returned in the bytes field of the chunk object. +// // - The attribution object contains citations for parts of the response. +// // - If you set enableTrace to true in the request, you can trace the agent's // steps and reasoning process that led it to the response. +// // - Errors are also surfaced in the response. +// +// [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events func (c *Client) InvokeAgent(ctx context.Context, params *InvokeAgentInput, optFns ...func(*Options)) (*InvokeAgentOutput, error) { if params == nil { params = &InvokeAgentInput{} @@ -65,8 +76,9 @@ type InvokeAgentInput struct { SessionId *string // Specifies whether to turn on the trace or not to track the agent's reasoning - // process. For more information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events) - // . + // process. For more information, see [Trace enablement]. + // + // [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events EnableTrace *bool // Specifies whether to end the session with the agent or not. @@ -76,8 +88,9 @@ type InvokeAgentInput struct { InputText *string // Contains parameters that specify various attributes of the session. For more - // information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html) - // . + // information, see [Control session context]. + // + // [Control session context]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html SessionState *types.SessionState noSmithyDocumentSerde diff --git a/service/bedrockagentruntime/api_op_Retrieve.go b/service/bedrockagentruntime/api_op_Retrieve.go index edb4d74465e..5b4e28cc0c1 100644 --- a/service/bedrockagentruntime/api_op_Retrieve.go +++ b/service/bedrockagentruntime/api_op_Retrieve.go @@ -45,8 +45,9 @@ type RetrieveInput struct { NextToken *string // Contains configurations for the knowledge base query and retrieval process. For - // more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) - // . + // more information, see [Query configurations]. + // + // [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html RetrievalConfiguration *types.KnowledgeBaseRetrievalConfiguration noSmithyDocumentSerde diff --git a/service/bedrockagentruntime/api_op_RetrieveAndGenerate.go b/service/bedrockagentruntime/api_op_RetrieveAndGenerate.go index 626ae8744a5..69948b925e7 100644 --- a/service/bedrockagentruntime/api_op_RetrieveAndGenerate.go +++ b/service/bedrockagentruntime/api_op_RetrieveAndGenerate.go @@ -36,8 +36,9 @@ type RetrieveAndGenerateInput struct { Input *types.RetrieveAndGenerateInput // Contains configurations for the knowledge base query and retrieval process. For - // more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) - // . + // more information, see [Query configurations]. + // + // [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html RetrieveAndGenerateConfiguration *types.RetrieveAndGenerateConfiguration // Contains details about the session with the knowledge base. diff --git a/service/bedrockagentruntime/options.go b/service/bedrockagentruntime/options.go index bb0d5954e9c..a392f72ca93 100644 --- a/service/bedrockagentruntime/options.go +++ b/service/bedrockagentruntime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/bedrockagentruntime/types/enums.go b/service/bedrockagentruntime/types/enums.go index 964cebaa2aa..62b3e5d1174 100644 --- a/service/bedrockagentruntime/types/enums.go +++ b/service/bedrockagentruntime/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for CreationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreationMode) Values() []CreationMode { return []CreationMode{ "DEFAULT", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ExternalSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExternalSourceType) Values() []ExternalSourceType { return []ExternalSourceType{ "S3", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for InvocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvocationType) Values() []InvocationType { return []InvocationType{ "ACTION_GROUP", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for PromptType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PromptType) Values() []PromptType { return []PromptType{ "PRE_PROCESSING", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for ResponseState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResponseState) Values() []ResponseState { return []ResponseState{ "FAILURE", @@ -107,6 +112,7 @@ const ( // Values returns all known values for RetrievalResultLocationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RetrievalResultLocationType) Values() []RetrievalResultLocationType { return []RetrievalResultLocationType{ @@ -123,8 +129,9 @@ const ( ) // Values returns all known values for RetrieveAndGenerateType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetrieveAndGenerateType) Values() []RetrieveAndGenerateType { return []RetrieveAndGenerateType{ "KNOWLEDGE_BASE", @@ -141,8 +148,9 @@ const ( ) // Values returns all known values for SearchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchType) Values() []SearchType { return []SearchType{ "HYBRID", @@ -160,8 +168,9 @@ const ( ) // Values returns all known values for Source. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Source) Values() []Source { return []Source{ "ACTION_GROUP", @@ -182,8 +191,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "ACTION_GROUP", diff --git a/service/bedrockagentruntime/types/types.go b/service/bedrockagentruntime/types/types.go index 98330a1127f..0e26429e985 100644 --- a/service/bedrockagentruntime/types/types.go +++ b/service/bedrockagentruntime/types/types.go @@ -8,8 +8,10 @@ import ( ) // Contains information about the action group being invoked. For more information -// about the possible structures, see the InvocationInput tab in OrchestrationTrace (https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html) -// in the Amazon Bedrock User Guide. +// about the possible structures, see the InvocationInput tab in [OrchestrationTrace]in the Amazon +// Bedrock User Guide. +// +// [OrchestrationTrace]: https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html type ActionGroupInvocationInput struct { // The name of the action group. @@ -44,8 +46,13 @@ type ActionGroupInvocationOutput struct { } // Contains information about the API operation that the agent predicts should be -// called. This data type is used in the following API operations: -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// called. +// +// This data type is used in the following API operations: +// +// - In the returnControl field of the [Retrieve response] +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type ApiInvocationInput struct { // The action group that the API operation belongs to. @@ -70,9 +77,13 @@ type ApiInvocationInput struct { noSmithyDocumentSerde } -// Information about a parameter to provide to the API request. This data type is -// used in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// Information about a parameter to provide to the API request. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type ApiParameter struct { // The name of the parameter. @@ -88,8 +99,13 @@ type ApiParameter struct { } // The request body to provide for the API request, as the agent elicited from the -// user. This data type is used in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// user. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type ApiRequestBody struct { // The content of the request body. The key of the object in this field is a media @@ -100,9 +116,13 @@ type ApiRequestBody struct { } // Contains information about the API operation that was called from the action -// group and the response body that was returned. This data type is used in the -// following API operations: -// - In the returnControlInvocationResults of the Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// group and the response body that was returned. +// +// This data type is used in the following API operations: +// +// - In the returnControlInvocationResults of the [Retrieve request] +// +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax type ApiResult struct { // The action group that the API operation belongs to. @@ -163,12 +183,18 @@ type ByteContentDoc struct { } // An object containing a segment of the generated response that is based on a -// source in the knowledge base, alongside information about the source. This data -// type is used in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the citations field -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the citations field +// source in the knowledge base, alongside information about the source. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// - – in the citations field +// +// [RetrieveAndGenerate response] +// - – in the citations field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type Citation struct { // Contains the generated response and metadata @@ -180,9 +206,13 @@ type Citation struct { noSmithyDocumentSerde } -// Contains the body of the API response. This data type is used in the following -// API operations: -// - In the returnControlInvocationResults field of the Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// Contains the body of the API response. +// +// This data type is used in the following API operations: +// +// - In the returnControlInvocationResults field of the [Retrieve request] +// +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax type ContentBody struct { // The body of the API response. @@ -253,10 +283,15 @@ type FailureTrace struct { } // Specifies the name that the metadata attribute must match and the value to -// which to compare the value of the metadata attribute. For more information, see -// Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) -// . This data type is used in the following API operations: -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) +// which to compare the value of the metadata attribute. For more information, see [Query configurations] +// . +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate request] +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax +// [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html type FilterAttribute struct { // The name that the metadata attribute must match. @@ -282,8 +317,13 @@ type FinalResponse struct { } // Contains information about the function that the agent predicts should be -// called. This data type is used in the following API operations: -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// called. +// +// This data type is used in the following API operations: +// +// - In the returnControl field of the [Retrieve response] +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type FunctionInvocationInput struct { // The action group that the function belongs to. @@ -300,9 +340,13 @@ type FunctionInvocationInput struct { noSmithyDocumentSerde } -// Contains information about a parameter of the function. This data type is used -// in the following API operations: -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// Contains information about a parameter of the function. +// +// This data type is used in the following API operations: +// +// - In the returnControl field of the [Retrieve response] +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type FunctionParameter struct { // The name of the parameter. @@ -318,9 +362,13 @@ type FunctionParameter struct { } // Contains information about the function that was called from the action group -// and the response that was returned. This data type is used in the following API -// operations: -// - In the returnControlInvocationResults of the Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// and the response that was returned. +// +// This data type is used in the following API operations: +// +// - In the returnControlInvocationResults of the [Retrieve request] +// +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax type FunctionResult struct { // The action group that the function belongs to. @@ -345,11 +393,18 @@ type FunctionResult struct { } // Contains metadata about a part of the generated response that is accompanied by -// a citation. This data type is used in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the generatedResponsePart field -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the generatedResponsePart field +// a citation. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// - – in the generatedResponsePart field +// +// [RetrieveAndGenerate response] +// - – in the generatedResponsePart field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type GeneratedResponsePart struct { // Contains metadata about a textual part of the generated response that is @@ -360,8 +415,13 @@ type GeneratedResponsePart struct { } // Contains configurations for response generation based on the knowledge base -// query results. This data type is used in the following API operations: -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) +// query results. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate request] +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax type GenerationConfiguration struct { // Contains the template for the prompt that's sent to the model for response @@ -372,10 +432,11 @@ type GenerationConfiguration struct { } // Specifications about the inference parameters that were provided alongside the -// prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) -// object that was set when the agent was created or updated. For more information, -// see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) -// . +// prompt. These are specified in the [PromptOverrideConfiguration]object that was set when the agent was +// created or updated. For more information, see [Inference parameters for foundation models]. +// +// [Inference parameters for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html +// [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html type InferenceConfiguration struct { // The maximum number of tokens allowed in the generated response. @@ -429,13 +490,18 @@ type InvocationInput struct { } // Contains details about the API operation or function that the agent predicts -// should be called. This data type is used in the following API operations: -// - In the returnControl field of the Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// should be called. +// +// This data type is used in the following API operations: +// +// - In the returnControl field of the [Retrieve response] // // The following types satisfy this interface: // // InvocationInputMemberMemberApiInvocationInput // InvocationInputMemberMemberFunctionInvocationInput +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type InvocationInputMember interface { isInvocationInputMember() } @@ -460,14 +526,18 @@ type InvocationInputMemberMemberFunctionInvocationInput struct { func (*InvocationInputMemberMemberFunctionInvocationInput) isInvocationInputMember() {} -// A result from the action group invocation. This data type is used in the -// following API operations: -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// A result from the action group invocation. +// +// This data type is used in the following API operations: +// +// [Retrieve request] // // The following types satisfy this interface: // // InvocationResultMemberMemberApiResult // InvocationResultMemberMemberFunctionResult +// +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax type InvocationResultMember interface { isInvocationResultMember() } @@ -511,10 +581,14 @@ type KnowledgeBaseLookupOutput struct { noSmithyDocumentSerde } -// Contains the query made to the knowledge base. This data type is used in the -// following API operations: -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) -// – in the retrievalQuery field +// Contains the query made to the knowledge base. +// +// This data type is used in the following API operations: +// +// [Retrieve request] +// - – in the retrievalQuery field +// +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax type KnowledgeBaseQuery struct { // The text of the query made to the knowledge base. @@ -526,17 +600,25 @@ type KnowledgeBaseQuery struct { } // Contains configurations for the knowledge base query and retrieval process. For -// more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) -// . This data type is used in the following API operations: -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) -// – in the retrievalConfiguration field -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the retrievalConfiguration field +// more information, see [Query configurations]. +// +// This data type is used in the following API operations: +// +// [Retrieve request] +// - – in the retrievalConfiguration field +// +// [RetrieveAndGenerate request] +// - – in the retrievalConfiguration field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax +// [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html type KnowledgeBaseRetrievalConfiguration struct { // Contains details about how the results from the vector search should be - // returned. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) - // . + // returned. For more information, see [Query configurations]. + // + // [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html // // This member is required. VectorSearchConfiguration *KnowledgeBaseVectorSearchConfiguration @@ -544,10 +626,14 @@ type KnowledgeBaseRetrievalConfiguration struct { noSmithyDocumentSerde } -// Details about a result from querying the knowledge base. This data type is used -// in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the retrievalResults field +// Details about a result from querying the knowledge base. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// - – in the retrievalResults field +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type KnowledgeBaseRetrievalResult struct { // Contains a chunk of text from a data source in the knowledge base. @@ -559,8 +645,9 @@ type KnowledgeBaseRetrievalResult struct { Location *RetrievalResultLocation // Contains metadata attributes and their values for the file in the data source. - // For more information, see Metadata and filtering (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata) - // . + // For more information, see [Metadata and filtering]. + // + // [Metadata and filtering]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata Metadata map[string]document.Interface // The level of relevance of the result to the query. @@ -569,12 +656,18 @@ type KnowledgeBaseRetrievalResult struct { noSmithyDocumentSerde } -// Contains details about the resource being queried. This data type is used in -// the following API operations: -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) -// – in the knowledgeBaseConfiguration field -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the knowledgeBaseConfiguration field +// Contains details about the resource being queried. +// +// This data type is used in the following API operations: +// +// [Retrieve request] +// - – in the knowledgeBaseConfiguration field +// +// [RetrieveAndGenerate request] +// - – in the knowledgeBaseConfiguration field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax type KnowledgeBaseRetrieveAndGenerateConfiguration struct { // The unique identifier of the knowledge base that is queried and the foundation @@ -599,17 +692,25 @@ type KnowledgeBaseRetrieveAndGenerateConfiguration struct { } // Configurations for how to perform the search query and return results. For more -// information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) -// . This data type is used in the following API operations: -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) -// – in the vectorSearchConfiguration field -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the vectorSearchConfiguration field +// information, see [Query configurations]. +// +// This data type is used in the following API operations: +// +// [Retrieve request] +// - – in the vectorSearchConfiguration field +// +// [RetrieveAndGenerate request] +// - – in the vectorSearchConfiguration field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax +// [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html type KnowledgeBaseVectorSearchConfiguration struct { // Specifies the filters to use on the metadata in the knowledge base data sources - // before returning results. For more information, see Query configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) - // . + // before returning results. For more information, see [Query configurations]. + // + // [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html Filter RetrievalFilter // The number of source chunks to retrieve. @@ -620,26 +721,32 @@ type KnowledgeBaseVectorSearchConfiguration struct { // field, you can specify whether to query the knowledge base with a HYBRID search // using both vector embeddings and raw text, or SEMANTIC search using only vector // embeddings. For other vector store configurations, only SEMANTIC search is - // available. For more information, see Test a knowledge base (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html) - // . + // available. For more information, see [Test a knowledge base]. + // + // [Test a knowledge base]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html OverrideSearchType SearchType noSmithyDocumentSerde } // The input for the pre-processing step. +// // - The type matches the agent step. +// // - The text contains the prompt. +// // - The inferenceConfiguration , parserMode , and overrideLambda values are set -// in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) -// object that was set when the agent was created or updated. +// in the [PromptOverrideConfiguration]object that was set when the agent was created or updated. +// +// [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html type ModelInvocationInput struct { // Specifications about the inference parameters that were provided alongside the - // prompt. These are specified in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) - // object that was set when the agent was created or updated. For more information, - // see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) - // . + // prompt. These are specified in the [PromptOverrideConfiguration]object that was set when the agent was + // created or updated. For more information, see [Inference parameters for foundation models]. + // + // [Inference parameters for foundation models]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html + // [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html InferenceConfiguration *InferenceConfiguration // The ARN of the Lambda function to use when parsing the raw foundation model @@ -652,8 +759,10 @@ type ModelInvocationInput struct { ParserMode CreationMode // Specifies whether the default prompt template was OVERRIDDEN . If it was, the - // basePromptTemplate that was set in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) - // object when the agent was created or updated is used instead. + // basePromptTemplate that was set in the [PromptOverrideConfiguration] object when the agent was created or + // updated is used instead. + // + // [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html PromptCreationMode CreationMode // The text that prompted the agent at this step. @@ -690,10 +799,15 @@ type Observation struct { // Specifies what kind of information the agent returns in the observation. The // following values are possible. + // // - ACTION_GROUP – The agent returns the result of an action group. + // // - KNOWLEDGE_BASE – The agent returns information from a knowledge base. + // // - FINISH – The agent returns a final response to the user with no follow-up. + // // - ASK_USER – The agent asks the user a question. + // // - REPROMPT – The agent prompts the user again for the same information. Type Type @@ -724,11 +838,15 @@ type OrchestrationTraceMemberInvocationInput struct { func (*OrchestrationTraceMemberInvocationInput) isOrchestrationTrace() {} // The input for the orchestration step. +// // - The type is ORCHESTRATION . +// // - The text contains the prompt. +// // - The inferenceConfiguration , parserMode , and overrideLambda values are set -// in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) -// object that was set when the agent was created or updated. +// in the [PromptOverrideConfiguration]object that was set when the agent was created or updated. +// +// [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html type OrchestrationTraceMemberModelInvocationInput struct { Value ModelInvocationInput @@ -818,11 +936,15 @@ type PostProcessingTrace interface { } // The input for the post-processing step. +// // - The type is POST_PROCESSING . +// // - The text contains the prompt. +// // - The inferenceConfiguration , parserMode , and overrideLambda values are set -// in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) -// object that was set when the agent was created or updated. +// in the [PromptOverrideConfiguration]object that was set when the agent was created or updated. +// +// [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html type PostProcessingTraceMemberModelInvocationInput struct { Value ModelInvocationInput @@ -880,11 +1002,15 @@ type PreProcessingTrace interface { } // The input for the pre-processing step. +// // - The type is PRE_PROCESSING . +// // - The text contains the prompt. +// // - The inferenceConfiguration , parserMode , and overrideLambda values are set -// in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) -// object that was set when the agent was created or updated. +// in the [PromptOverrideConfiguration]object that was set when the agent was created or updated. +// +// [PromptOverrideConfiguration]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html type PreProcessingTraceMemberModelInvocationInput struct { Value ModelInvocationInput @@ -903,19 +1029,31 @@ type PreProcessingTraceMemberModelInvocationOutput struct { func (*PreProcessingTraceMemberModelInvocationOutput) isPreProcessingTrace() {} // Contains the template for the prompt that's sent to the model for response -// generation. For more information, see Knowledge base prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt) -// . This data type is used in the following API operations: -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the filter field +// generation. For more information, see [Knowledge base prompt templates]. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate request] +// - – in the filter field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax +// [Knowledge base prompt templates]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt type PromptTemplate struct { // The template for the prompt that's sent to the model for response generation. // You can include prompt placeholders, which become replaced before the prompt is // sent to the model to provide instructions and context to the model. In addition, // you can include XML tags to delineate meaningful sections of the prompt - // template. For more information, see the following resources: - // - Knowledge base prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt) - // - Use XML tags with Anthropic Claude models (https://docs.anthropic.com/claude/docs/use-xml-tags) + // template. + // + // For more information, see the following resources: + // + // [Knowledge base prompt templates] + // + // [Use XML tags with Anthropic Claude models] + // + // [Use XML tags with Anthropic Claude models]: https://docs.anthropic.com/claude/docs/use-xml-tags + // [Knowledge base prompt templates]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt TextPromptTemplate *string noSmithyDocumentSerde @@ -999,9 +1137,9 @@ func (*ResponseStreamMemberReturnControl) isResponseStream() {} // Contains information about the agent and session, alongside the agent's // reasoning process and results from calling actions and querying knowledge bases // and metadata about the trace. You can use the trace to understand how the agent -// arrived at the response it provided the customer. For more information, see -// Trace events (https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html) -// . +// arrived at the response it provided the customer. For more information, see [Trace events]. +// +// [Trace events]: https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html type ResponseStreamMemberTrace struct { Value TracePart @@ -1011,13 +1149,15 @@ type ResponseStreamMemberTrace struct { func (*ResponseStreamMemberTrace) isResponseStream() {} // Specifies the filters to use on the metadata attributes in the knowledge base -// data sources before returning results. For more information, see Query -// configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) -// . This data type is used in the following API operations: -// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) -// – in the filter field -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the filter field +// data sources before returning results. For more information, see [Query configurations]. +// +// This data type is used in the following API operations: +// +// [Retrieve request] +// - – in the filter field +// +// [RetrieveAndGenerate request] +// - – in the filter field // // The following types satisfy this interface: // @@ -1032,6 +1172,10 @@ func (*ResponseStreamMemberTrace) isResponseStream() {} // RetrievalFilterMemberNotIn // RetrievalFilterMemberOrAll // RetrievalFilterMemberStartsWith +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax +// [Retrieve request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax +// [Query configurations]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html type RetrievalFilter interface { isRetrievalFilter() } @@ -1155,14 +1299,21 @@ type RetrievalFilterMemberStartsWith struct { func (*RetrievalFilterMemberStartsWith) isRetrievalFilter() {} -// Contains the cited text from the data source. This data type is used in the -// following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the content field -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the content field -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the content field +// Contains the cited text from the data source. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// - – in the content field +// +// [RetrieveAndGenerate response] +// - – in the content field +// +// [Retrieve response] +// - – in the content field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type RetrievalResultContent struct { // The cited text from the data source. @@ -1173,14 +1324,21 @@ type RetrievalResultContent struct { noSmithyDocumentSerde } -// Contains information about the location of the data source. This data type is -// used in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the location field -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the location field -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the locatino field +// Contains information about the location of the data source. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// - – in the location field +// +// [RetrieveAndGenerate response] +// - – in the location field +// +// [Retrieve response] +// - – in the locatino field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type RetrievalResultLocation struct { // The type of the location of the data source. @@ -1194,14 +1352,21 @@ type RetrievalResultLocation struct { noSmithyDocumentSerde } -// Contains the S3 location of the data source. This data type is used in the -// following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the s3Location field -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the s3Location field -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the s3Location field +// Contains the S3 location of the data source. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// - – in the s3Location field +// +// [RetrieveAndGenerate response] +// - – in the s3Location field +// +// [Retrieve response] +// - – in the s3Location field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type RetrievalResultS3Location struct { // The S3 URI of the data source. @@ -1210,10 +1375,14 @@ type RetrievalResultS3Location struct { noSmithyDocumentSerde } -// Contains details about the resource being queried. This data type is used in -// the following API operations: -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the retrieveAndGenerateConfiguration field +// Contains details about the resource being queried. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate request] +// - – in the retrieveAndGenerateConfiguration field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax type RetrieveAndGenerateConfiguration struct { // The type of resource that is queried by the request. @@ -1231,10 +1400,14 @@ type RetrieveAndGenerateConfiguration struct { noSmithyDocumentSerde } -// Contains the query made to the knowledge base. This data type is used in the -// following API operations: -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the input field +// Contains the query made to the knowledge base. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate request] +// - – in the input field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax type RetrieveAndGenerateInput struct { // The query made to the knowledge base. @@ -1245,10 +1418,14 @@ type RetrieveAndGenerateInput struct { noSmithyDocumentSerde } -// Contains the response generated from querying the knowledge base. This data -// type is used in the following API operations: -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the output field +// Contains the response generated from querying the knowledge base. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate response] +// - – in the output field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax type RetrieveAndGenerateOutput struct { // The response generated from querying the knowledge base. @@ -1259,10 +1436,14 @@ type RetrieveAndGenerateOutput struct { noSmithyDocumentSerde } -// Contains configuration about the session with the knowledge base. This data -// type is used in the following API operations: -// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) -// – in the sessionConfiguration field +// Contains configuration about the session with the knowledge base. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate request] +// - – in the sessionConfiguration field +// +// [RetrieveAndGenerate request]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax type RetrieveAndGenerateSessionConfiguration struct { // The ARN of the KMS key encrypting the session. @@ -1273,12 +1454,18 @@ type RetrieveAndGenerateSessionConfiguration struct { noSmithyDocumentSerde } -// Contains metadata about a source cited for the generated response. This data -// type is used in the following API operations: -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the retrievedReferences field -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the retrievedReferences field +// Contains metadata about a source cited for the generated response. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate response] +// - – in the retrievedReferences field +// +// [Retrieve response] +// - – in the retrievedReferences field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type RetrievedReference struct { // Contains the cited text from the data source. @@ -1288,16 +1475,22 @@ type RetrievedReference struct { Location *RetrievalResultLocation // Contains metadata attributes and their values for the file in the data source. - // For more information, see Metadata and filtering (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata) - // . + // For more information, see [Metadata and filtering]. + // + // [Metadata and filtering]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata Metadata map[string]document.Interface noSmithyDocumentSerde } // Contains information to return from the action group that the agent has -// predicted to invoke. This data type is used in the following API operations: -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) +// predicted to invoke. +// +// This data type is used in the following API operations: +// +// [Retrieve response] +// +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type ReturnControlPayload struct { // The identifier of the action group invocation. @@ -1324,12 +1517,13 @@ type S3ObjectDoc struct { // Contains parameters that specify various attributes that persist across a // session or prompt. You can define session state attributes as key-value pairs -// when writing a Lambda function (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html) -// for an action group or pass them when making an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) -// request. Use session state attributes to control and provide conversational -// context for your agent and to help customize your agent's behavior. For more -// information, see Control session context (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html) -// . +// when writing a [Lambda function]for an action group or pass them when making an [InvokeAgent] request. Use +// session state attributes to control and provide conversational context for your +// agent and to help customize your agent's behavior. For more information, see [Control session context]. +// +// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html +// [Control session context]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html +// [Lambda function]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html type SessionState struct { // The identifier of the invocation. @@ -1338,8 +1532,9 @@ type SessionState struct { // Contains attributes that persist across a prompt and the values of those // attributes. These attributes replace the $prompt_session_attributes$ // placeholder variable in the orchestration prompt template. For more information, - // see Prompt template placeholder variables (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html) - // . + // see [Prompt template placeholder variables]. + // + // [Prompt template placeholder variables]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html PromptSessionAttributes map[string]string // Contains information about the results from the action group invocation. @@ -1353,11 +1548,18 @@ type SessionState struct { } // Contains information about where the text with a citation begins and ends in -// the generated output. This data type is used in the following API operations: -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the span field -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the span field +// the generated output. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate response] +// - – in the span field +// +// [Retrieve response] +// - – in the span field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type Span struct { // Where the text with a citation ends in the generated output. @@ -1370,12 +1572,18 @@ type Span struct { } // Contains the part of the generated text that contains a citation, alongside -// where it begins and ends. This data type is used in the following API -// operations: -// - RetrieveAndGenerate response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) -// – in the textResponsePart field -// - Retrieve response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) -// – in the textResponsePart field +// where it begins and ends. +// +// This data type is used in the following API operations: +// +// [RetrieveAndGenerate response] +// - – in the textResponsePart field +// +// [Retrieve response] +// - – in the textResponsePart field +// +// [RetrieveAndGenerate response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax +// [Retrieve response]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax type TextResponsePart struct { // Contains information about where the text with a citation begins and ends in @@ -1391,8 +1599,7 @@ type TextResponsePart struct { // Contains one part of the agent's reasoning process and results from calling API // actions and querying knowledge bases. You can use the trace to understand how // the agent arrived at the response it provided the customer. For more -// information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement) -// . +// information, see [Trace enablement]. // // The following types satisfy this interface: // @@ -1400,6 +1607,8 @@ type TextResponsePart struct { // TraceMemberOrchestrationTrace // TraceMemberPostProcessingTrace // TraceMemberPreProcessingTrace +// +// [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement type Trace interface { isTrace() } @@ -1446,8 +1655,9 @@ func (*TraceMemberPreProcessingTrace) isTrace() {} // reasoning process and results from calling API actions and querying knowledge // bases and metadata about the trace. You can use the trace to understand how the // agent arrived at the response it provided the customer. For more information, -// see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement) -// . +// see [Trace enablement]. +// +// [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement type TracePart struct { // The unique identifier of the alias of the agent. @@ -1465,8 +1675,9 @@ type TracePart struct { // Contains one part of the agent's reasoning process and results from calling API // actions and querying knowledge bases. You can use the trace to understand how // the agent arrived at the response it provided the customer. For more - // information, see Trace enablement (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement) - // . + // information, see [Trace enablement]. + // + // [Trace enablement]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement Trace Trace noSmithyDocumentSerde diff --git a/service/bedrockruntime/api_op_InvokeModel.go b/service/bedrockruntime/api_op_InvokeModel.go index aeb2dccbe8b..228e78f9ac8 100644 --- a/service/bedrockruntime/api_op_InvokeModel.go +++ b/service/bedrockruntime/api_op_InvokeModel.go @@ -13,9 +13,12 @@ import ( // Invokes the specified Amazon Bedrock model to run inference using the prompt // and inference parameters provided in the request body. You use model inference -// to generate text, images, and embeddings. For example code, see Invoke model -// code examples in the Amazon Bedrock User Guide. This operation requires -// permission for the bedrock:InvokeModel action. +// to generate text, images, and embeddings. +// +// For example code, see Invoke model code examples in the Amazon Bedrock User +// Guide. +// +// This operation requires permission for the bedrock:InvokeModel action. func (c *Client) InvokeModel(ctx context.Context, params *InvokeModelInput, optFns ...func(*Options)) (*InvokeModelOutput, error) { if params == nil { params = &InvokeModelInput{} @@ -35,27 +38,32 @@ type InvokeModelInput struct { // The prompt and inference parameters in the format specified in the contentType // in the header. To see the format and content of the request and response bodies - // for different models, refer to Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) - // . For more information, see Run inference (https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html) - // in the Bedrock User Guide. + // for different models, refer to [Inference parameters]. For more information, see [Run inference] in the Bedrock User + // Guide. + // + // [Inference parameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html + // [Run inference]: https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html // // This member is required. Body []byte - // The unique identifier of the model to invoke to run inference. The modelId to - // provide depends on the type of model that you use: + // The unique identifier of the model to invoke to run inference. + // + // The modelId to provide depends on the type of model that you use: + // // - If you use a base model, specify the model ID or its ARN. For a list of - // model IDs for base models, see Amazon Bedrock base model IDs (on-demand - // throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) - // in the Amazon Bedrock User Guide. + // model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)]in the Amazon Bedrock User Guide. + // // - If you use a provisioned model, specify the ARN of the Provisioned - // Throughput. For more information, see Run inference using a Provisioned - // Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) - // in the Amazon Bedrock User Guide. + // Throughput. For more information, see [Run inference using a Provisioned Throughput]in the Amazon Bedrock User Guide. + // // - If you use a custom model, first purchase Provisioned Throughput for it. // Then specify the ARN of the resulting provisioned model. For more information, - // see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) - // in the Amazon Bedrock User Guide. + // see [Use a custom model in Amazon Bedrock]in the Amazon Bedrock User Guide. + // + // [Run inference using a Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html + // [Use a custom model in Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html + // [Amazon Bedrock base model IDs (on-demand throughput)]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns // // This member is required. ModelId *string @@ -69,11 +77,15 @@ type InvokeModelInput struct { ContentType *string // The unique identifier of the guardrail that you want to use. If you don't - // provide a value, no guardrail is applied to the invocation. An error will be - // thrown in the following situations. + // provide a value, no guardrail is applied to the invocation. + // + // An error will be thrown in the following situations. + // // - You don't provide a guardrail identifier but you specify the // amazon-bedrock-guardrailConfig field in the request body. + // // - You enable the guardrail but the contentType isn't application/json . + // // - You provide a guardrail identifier, but guardrailVersion isn't specified. GuardrailIdentifier *string @@ -91,8 +103,9 @@ type InvokeModelOutput struct { // Inference response from the model in the format specified in the contentType // header. To see the format and content of the request and response bodies for - // different models, refer to Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) - // . + // different models, refer to [Inference parameters]. + // + // [Inference parameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html // // This member is required. Body []byte diff --git a/service/bedrockruntime/api_op_InvokeModelWithResponseStream.go b/service/bedrockruntime/api_op_InvokeModelWithResponseStream.go index 51c901e4591..b32354e35bf 100644 --- a/service/bedrockruntime/api_op_InvokeModelWithResponseStream.go +++ b/service/bedrockruntime/api_op_InvokeModelWithResponseStream.go @@ -14,11 +14,20 @@ import ( // Invoke the specified Amazon Bedrock model to run inference using the prompt and // inference parameters provided in the request body. The response is returned in a -// stream. To see if a model supports streaming, call GetFoundationModel (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html) -// and check the responseStreamingSupported field in the response. The CLI doesn't -// support InvokeModelWithResponseStream . For example code, see Invoke model with -// streaming code example in the Amazon Bedrock User Guide. This operation requires -// permissions to perform the bedrock:InvokeModelWithResponseStream action. +// stream. +// +// To see if a model supports streaming, call [GetFoundationModel] and check the +// responseStreamingSupported field in the response. +// +// The CLI doesn't support InvokeModelWithResponseStream . +// +// For example code, see Invoke model with streaming code example in the Amazon +// Bedrock User Guide. +// +// This operation requires permissions to perform the +// bedrock:InvokeModelWithResponseStream action. +// +// [GetFoundationModel]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html func (c *Client) InvokeModelWithResponseStream(ctx context.Context, params *InvokeModelWithResponseStreamInput, optFns ...func(*Options)) (*InvokeModelWithResponseStreamOutput, error) { if params == nil { params = &InvokeModelWithResponseStreamInput{} @@ -38,27 +47,32 @@ type InvokeModelWithResponseStreamInput struct { // The prompt and inference parameters in the format specified in the contentType // in the header. To see the format and content of the request and response bodies - // for different models, refer to Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) - // . For more information, see Run inference (https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html) - // in the Bedrock User Guide. + // for different models, refer to [Inference parameters]. For more information, see [Run inference] in the Bedrock User + // Guide. + // + // [Inference parameters]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html + // [Run inference]: https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html // // This member is required. Body []byte - // The unique identifier of the model to invoke to run inference. The modelId to - // provide depends on the type of model that you use: + // The unique identifier of the model to invoke to run inference. + // + // The modelId to provide depends on the type of model that you use: + // // - If you use a base model, specify the model ID or its ARN. For a list of - // model IDs for base models, see Amazon Bedrock base model IDs (on-demand - // throughput) (https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) - // in the Amazon Bedrock User Guide. + // model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)]in the Amazon Bedrock User Guide. + // // - If you use a provisioned model, specify the ARN of the Provisioned - // Throughput. For more information, see Run inference using a Provisioned - // Throughput (https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) - // in the Amazon Bedrock User Guide. + // Throughput. For more information, see [Run inference using a Provisioned Throughput]in the Amazon Bedrock User Guide. + // // - If you use a custom model, first purchase Provisioned Throughput for it. // Then specify the ARN of the resulting provisioned model. For more information, - // see Use a custom model in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) - // in the Amazon Bedrock User Guide. + // see [Use a custom model in Amazon Bedrock]in the Amazon Bedrock User Guide. + // + // [Run inference using a Provisioned Throughput]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html + // [Use a custom model in Amazon Bedrock]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html + // [Amazon Bedrock base model IDs (on-demand throughput)]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns // // This member is required. ModelId *string @@ -72,11 +86,15 @@ type InvokeModelWithResponseStreamInput struct { ContentType *string // The unique identifier of the guardrail that you want to use. If you don't - // provide a value, no guardrail is applied to the invocation. An error is thrown - // in the following situations. + // provide a value, no guardrail is applied to the invocation. + // + // An error is thrown in the following situations. + // // - You don't provide a guardrail identifier but you specify the // amazon-bedrock-guardrailConfig field in the request body. + // // - You enable the guardrail but the contentType isn't application/json . + // // - You provide a guardrail identifier, but guardrailVersion isn't specified. GuardrailIdentifier *string diff --git a/service/bedrockruntime/options.go b/service/bedrockruntime/options.go index 78b258a178b..8fdfd4c3b53 100644 --- a/service/bedrockruntime/options.go +++ b/service/bedrockruntime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/bedrockruntime/types/enums.go b/service/bedrockruntime/types/enums.go index 6b10e105427..d8b730d7caf 100644 --- a/service/bedrockruntime/types/enums.go +++ b/service/bedrockruntime/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for Trace. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Trace) Values() []Trace { return []Trace{ "ENABLED", diff --git a/service/billingconductor/api_op_AssociateAccounts.go b/service/billingconductor/api_op_AssociateAccounts.go index 6351fc72ac5..537fd539a2c 100644 --- a/service/billingconductor/api_op_AssociateAccounts.go +++ b/service/billingconductor/api_op_AssociateAccounts.go @@ -32,12 +32,12 @@ func (c *Client) AssociateAccounts(ctx context.Context, params *AssociateAccount type AssociateAccountsInput struct { - // The associating array of account IDs. + // The associating array of account IDs. // // This member is required. AccountIds []string - // The Amazon Resource Name (ARN) of the billing group that associates the array + // The Amazon Resource Name (ARN) of the billing group that associates the array // of account IDs. // // This member is required. @@ -48,7 +48,7 @@ type AssociateAccountsInput struct { type AssociateAccountsOutput struct { - // The Amazon Resource Name (ARN) of the billing group that associates the array + // The Amazon Resource Name (ARN) of the billing group that associates the array // of account IDs. Arn *string diff --git a/service/billingconductor/api_op_AssociatePricingRules.go b/service/billingconductor/api_op_AssociatePricingRules.go index 110406a613f..e03c1e8535f 100644 --- a/service/billingconductor/api_op_AssociatePricingRules.go +++ b/service/billingconductor/api_op_AssociatePricingRules.go @@ -29,12 +29,12 @@ func (c *Client) AssociatePricingRules(ctx context.Context, params *AssociatePri type AssociatePricingRulesInput struct { - // The PricingPlanArn that the PricingRuleArns are associated with. + // The PricingPlanArn that the PricingRuleArns are associated with. // // This member is required. Arn *string - // The PricingRuleArns that are associated with the Pricing Plan. + // The PricingRuleArns that are associated with the Pricing Plan. // // This member is required. PricingRuleArns []string @@ -44,7 +44,7 @@ type AssociatePricingRulesInput struct { type AssociatePricingRulesOutput struct { - // The PricingPlanArn that the PricingRuleArns are associated with. + // The PricingPlanArn that the PricingRuleArns are associated with. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_BatchAssociateResourcesToCustomLineItem.go b/service/billingconductor/api_op_BatchAssociateResourcesToCustomLineItem.go index adc4fee763e..b6188925d25 100644 --- a/service/billingconductor/api_op_BatchAssociateResourcesToCustomLineItem.go +++ b/service/billingconductor/api_op_BatchAssociateResourcesToCustomLineItem.go @@ -29,12 +29,12 @@ func (c *Client) BatchAssociateResourcesToCustomLineItem(ctx context.Context, pa type BatchAssociateResourcesToCustomLineItemInput struct { - // A list containing the ARNs of the resources to be associated. + // A list containing the ARNs of the resources to be associated. // // This member is required. ResourceArns []string - // A percentage custom line item ARN to associate the resources to. + // A percentage custom line item ARN to associate the resources to. // // This member is required. TargetArn *string @@ -47,11 +47,11 @@ type BatchAssociateResourcesToCustomLineItemInput struct { type BatchAssociateResourcesToCustomLineItemOutput struct { - // A list of AssociateResourceResponseElement for each resource that failed + // A list of AssociateResourceResponseElement for each resource that failed // association to a percentage custom line item. FailedAssociatedResources []types.AssociateResourceResponseElement - // A list of AssociateResourceResponseElement for each resource that's been + // A list of AssociateResourceResponseElement for each resource that's been // associated to a percentage custom line item successfully. SuccessfullyAssociatedResources []types.AssociateResourceResponseElement diff --git a/service/billingconductor/api_op_BatchDisassociateResourcesFromCustomLineItem.go b/service/billingconductor/api_op_BatchDisassociateResourcesFromCustomLineItem.go index f117b403d3f..29d187b8b4f 100644 --- a/service/billingconductor/api_op_BatchDisassociateResourcesFromCustomLineItem.go +++ b/service/billingconductor/api_op_BatchDisassociateResourcesFromCustomLineItem.go @@ -29,12 +29,12 @@ func (c *Client) BatchDisassociateResourcesFromCustomLineItem(ctx context.Contex type BatchDisassociateResourcesFromCustomLineItemInput struct { - // A list containing the ARNs of resources to be disassociated. + // A list containing the ARNs of resources to be disassociated. // // This member is required. ResourceArns []string - // A percentage custom line item ARN to disassociate the resources from. + // A percentage custom line item ARN to disassociate the resources from. // // This member is required. TargetArn *string @@ -47,11 +47,11 @@ type BatchDisassociateResourcesFromCustomLineItemInput struct { type BatchDisassociateResourcesFromCustomLineItemOutput struct { - // A list of DisassociateResourceResponseElement for each resource that failed + // A list of DisassociateResourceResponseElement for each resource that failed // disassociation from a percentage custom line item. FailedDisassociatedResources []types.DisassociateResourceResponseElement - // A list of DisassociateResourceResponseElement for each resource that's been + // A list of DisassociateResourceResponseElement for each resource that's been // disassociated from a percentage custom line item successfully. SuccessfullyDisassociatedResources []types.DisassociateResourceResponseElement diff --git a/service/billingconductor/api_op_CreateBillingGroup.go b/service/billingconductor/api_op_CreateBillingGroup.go index 447a9cbc4b2..2af0feaeeb9 100644 --- a/service/billingconductor/api_op_CreateBillingGroup.go +++ b/service/billingconductor/api_op_CreateBillingGroup.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a billing group that resembles a consolidated billing family that +// 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) { @@ -31,34 +32,34 @@ func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGr type CreateBillingGroupInput struct { - // The set of accounts that will be under the billing group. The set of accounts + // The set of accounts that will be under the billing group. The set of accounts // resemble the linked accounts in a consolidated billing family. // // This member is required. AccountGrouping *types.AccountGrouping - // The preferences and settings that will be used to compute the Amazon Web + // The preferences and settings that will be used to compute the Amazon Web // Services charges for a billing group. // // This member is required. ComputationPreference *types.ComputationPreference - // The billing group name. The names must be unique. + // The billing group name. The names must be unique. // // This member is required. Name *string - // The token that is needed to support idempotency. Idempotency isn't currently + // The token that is needed to support idempotency. Idempotency isn't currently // supported, but will be implemented in a future update. ClientToken *string // The description of the billing group. Description *string - // The account ID that serves as the main account in a billing group. + // The account ID that serves as the main account in a billing group. PrimaryAccountId *string - // A map that contains tag keys and tag values that are attached to a billing + // A map that contains tag keys and tag values that are attached to a billing // group. This feature isn't available during the beta. Tags map[string]string diff --git a/service/billingconductor/api_op_CreateCustomLineItem.go b/service/billingconductor/api_op_CreateCustomLineItem.go index c39227ceedc..915c089106d 100644 --- a/service/billingconductor/api_op_CreateCustomLineItem.go +++ b/service/billingconductor/api_op_CreateCustomLineItem.go @@ -31,25 +31,25 @@ func (c *Client) CreateCustomLineItem(ctx context.Context, params *CreateCustomL type CreateCustomLineItemInput struct { - // The Amazon Resource Name (ARN) that references the billing group where the + // The Amazon Resource Name (ARN) that references the billing group where the // custom line item applies to. // // This member is required. BillingGroupArn *string - // A CustomLineItemChargeDetails that describes the charge details for a custom + // A CustomLineItemChargeDetails that describes the charge details for a custom // line item. // // This member is required. ChargeDetails *types.CustomLineItemChargeDetails - // The description of the custom line item. This is shown on the Bills page in + // The description of the custom line item. This is shown on the Bills page in // association with the charge value. // // This member is required. Description *string - // The name of the custom line item. + // The name of the custom line item. // // This member is required. Name *string @@ -58,14 +58,14 @@ type CreateCustomLineItemInput struct { // to. AccountId *string - // A time range for which the custom line item is effective. + // A time range for which the custom line item is effective. BillingPeriodRange *types.CustomLineItemBillingPeriodRange - // The token that is needed to support idempotency. Idempotency isn't currently + // The token that is needed to support idempotency. Idempotency isn't currently // supported, but will be implemented in a future update. ClientToken *string - // A map that contains tag keys and tag values that are attached to a custom line + // A map that contains tag keys and tag values that are attached to a custom line // item. Tags map[string]string @@ -74,7 +74,7 @@ type CreateCustomLineItemInput struct { type CreateCustomLineItemOutput struct { - // The Amazon Resource Name (ARN) of the created custom line item. + // The Amazon Resource Name (ARN) of the created custom line item. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_CreatePricingPlan.go b/service/billingconductor/api_op_CreatePricingPlan.go index 32157b19e85..8c1855d92ac 100644 --- a/service/billingconductor/api_op_CreatePricingPlan.go +++ b/service/billingconductor/api_op_CreatePricingPlan.go @@ -34,17 +34,19 @@ type CreatePricingPlanInput struct { // This member is required. Name *string - // The token that is needed to support idempotency. Idempotency isn't currently + // The token that is needed to support idempotency. Idempotency isn't currently // supported, but will be implemented in a future update. ClientToken *string // The description of the pricing plan. Description *string - // A list of Amazon Resource Names (ARNs) that define the pricing plan parameters. + // A list of Amazon Resource Names (ARNs) that define the pricing plan + // parameters. PricingRuleArns []string - // A map that contains tag keys and tag values that are attached to a pricing plan. + // A map that contains tag keys and tag values that are attached to a pricing + // plan. Tags map[string]string noSmithyDocumentSerde diff --git a/service/billingconductor/api_op_CreatePricingRule.go b/service/billingconductor/api_op_CreatePricingRule.go index 61e026b7a96..51e5dc7bb89 100644 --- a/service/billingconductor/api_op_CreatePricingRule.go +++ b/service/billingconductor/api_op_CreatePricingRule.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a pricing rule can be associated to a pricing plan, or a set of pricing -// plans. +// Creates a pricing rule can be associated to a pricing plan, or a set of +// +// pricing plans. func (c *Client) CreatePricingRule(ctx context.Context, params *CreatePricingRuleInput, optFns ...func(*Options)) (*CreatePricingRuleOutput, error) { if params == nil { params = &CreatePricingRuleInput{} @@ -30,58 +31,61 @@ func (c *Client) CreatePricingRule(ctx context.Context, params *CreatePricingRul type CreatePricingRuleInput struct { - // The pricing rule name. The names must be unique to each pricing rule. + // The pricing rule name. The names must be unique to each pricing rule. // // This member is required. Name *string - // The scope of pricing rule that indicates if it's globally applicable, or it's + // The scope of pricing rule that indicates if it's globally applicable, or it's // service-specific. // // This member is required. Scope types.PricingRuleScope - // The type of pricing rule. + // The type of pricing rule. // // This member is required. Type types.PricingRuleType - // The seller of services provided by Amazon Web Services, their affiliates, or + // The seller of services provided by Amazon Web Services, their affiliates, or // third-party providers selling services via Amazon Web Services Marketplace. BillingEntity *string - // The token that's needed to support idempotency. Idempotency isn't currently + // The token that's needed to support idempotency. Idempotency isn't currently // supported, but will be implemented in a future update. ClientToken *string - // The pricing rule description. + // The pricing rule description. Description *string - // A percentage modifier that's applied on the public pricing rates. + // A percentage modifier that's applied on the public pricing rates. ModifierPercentage *float64 - // 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 - // modifying. For example, a value of RunInstances:0202 indicates the operation of - // running an Amazon EC2 instance. + // 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 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 - // A map that contains tag keys and tag values that are attached to a pricing rule. + // A map that contains tag keys and tag values that are attached to a pricing + // rule. Tags map[string]string - // The set of tiering configurations for the pricing rule. + // 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 @@ -89,7 +93,7 @@ type CreatePricingRuleInput struct { type CreatePricingRuleOutput struct { - // The Amazon Resource Name (ARN) of the created pricing rule. + // The Amazon Resource Name (ARN) of the created pricing rule. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_DeleteCustomLineItem.go b/service/billingconductor/api_op_DeleteCustomLineItem.go index b7cc89a6197..0b8a34be5e9 100644 --- a/service/billingconductor/api_op_DeleteCustomLineItem.go +++ b/service/billingconductor/api_op_DeleteCustomLineItem.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the custom line item identified by the given ARN in the current, or +// Deletes the custom line item identified by the given ARN in the current, or +// // previous billing period. func (c *Client) DeleteCustomLineItem(ctx context.Context, params *DeleteCustomLineItemInput, optFns ...func(*Options)) (*DeleteCustomLineItemOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) DeleteCustomLineItem(ctx context.Context, params *DeleteCustomL type DeleteCustomLineItemInput struct { - // The ARN of the custom line item to be deleted. + // The ARN of the custom line item to be deleted. // // This member is required. Arn *string diff --git a/service/billingconductor/api_op_DeletePricingPlan.go b/service/billingconductor/api_op_DeletePricingPlan.go index a649178063b..c2089f8932c 100644 --- a/service/billingconductor/api_op_DeletePricingPlan.go +++ b/service/billingconductor/api_op_DeletePricingPlan.go @@ -39,7 +39,7 @@ type DeletePricingPlanInput struct { type DeletePricingPlanOutput struct { - // The Amazon Resource Name (ARN) of the deleted pricing plan. + // The Amazon Resource Name (ARN) of the deleted pricing plan. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_DeletePricingRule.go b/service/billingconductor/api_op_DeletePricingRule.go index e1f9aa0f95c..afa15d27f24 100644 --- a/service/billingconductor/api_op_DeletePricingRule.go +++ b/service/billingconductor/api_op_DeletePricingRule.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the pricing rule that's identified by the input Amazon Resource Name +// Deletes the pricing rule that's identified by the input Amazon Resource Name +// // (ARN). func (c *Client) DeletePricingRule(ctx context.Context, params *DeletePricingRuleInput, optFns ...func(*Options)) (*DeletePricingRuleOutput, error) { if params == nil { @@ -29,7 +30,7 @@ func (c *Client) DeletePricingRule(ctx context.Context, params *DeletePricingRul type DeletePricingRuleInput struct { - // The Amazon Resource Name (ARN) of the pricing rule that you are deleting. + // The Amazon Resource Name (ARN) of the pricing rule that you are deleting. // // This member is required. Arn *string @@ -39,7 +40,7 @@ type DeletePricingRuleInput struct { type DeletePricingRuleOutput struct { - // The Amazon Resource Name (ARN) of the deleted pricing rule. + // The Amazon Resource Name (ARN) of the deleted pricing rule. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_DisassociatePricingRules.go b/service/billingconductor/api_op_DisassociatePricingRules.go index b9741d01749..6b852fd0cea 100644 --- a/service/billingconductor/api_op_DisassociatePricingRules.go +++ b/service/billingconductor/api_op_DisassociatePricingRules.go @@ -28,13 +28,14 @@ func (c *Client) DisassociatePricingRules(ctx context.Context, params *Disassoci type DisassociatePricingRulesInput struct { - // The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from. + // The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules + // from. // // This member is required. Arn *string - // A list containing the Amazon Resource Name (ARN) of the pricing rules that will - // be disassociated. + // A list containing the Amazon Resource Name (ARN) of the pricing rules that + // will be disassociated. // // This member is required. PricingRuleArns []string @@ -44,7 +45,7 @@ type DisassociatePricingRulesInput struct { type DisassociatePricingRulesOutput struct { - // The Amazon Resource Name (ARN) of the pricing plan that the pricing rules + // The Amazon Resource Name (ARN) of the pricing plan that the pricing rules // successfully disassociated from. Arn *string diff --git a/service/billingconductor/api_op_ListAccountAssociations.go b/service/billingconductor/api_op_ListAccountAssociations.go index 8863b270923..159ad2d7896 100644 --- a/service/billingconductor/api_op_ListAccountAssociations.go +++ b/service/billingconductor/api_op_ListAccountAssociations.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This is a paginated call to list linked accounts that are linked to the payer +// This is a paginated call to list linked accounts that are linked to the payer +// // account for the specified time period. If no information is provided, the // current billing period is used. The response will optionally include the billing // group that's associated with the linked account. @@ -32,16 +33,20 @@ func (c *Client) ListAccountAssociations(ctx context.Context, params *ListAccoun type ListAccountAssociationsInput struct { - // The preferred billing period to get account associations. + // The preferred billing period to get account associations. 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 : - // linked accounts that are associated to the provided 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 - // The pagination token that's used on subsequent calls to retrieve accounts. + // The pagination token that's used on subsequent calls to retrieve accounts. NextToken *string noSmithyDocumentSerde @@ -49,10 +54,10 @@ type ListAccountAssociationsInput struct { type ListAccountAssociationsOutput struct { - // The list of linked accounts in the payer account. + // The list of linked accounts in the payer account. LinkedAccounts []types.AccountAssociationsListElement - // The pagination token that's used on subsequent calls to get accounts. + // The pagination token that's used on subsequent calls to get accounts. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_ListCustomLineItems.go b/service/billingconductor/api_op_ListCustomLineItems.go index 987f26898d1..2d1d9b08280 100644 --- a/service/billingconductor/api_op_ListCustomLineItems.go +++ b/service/billingconductor/api_op_ListCustomLineItems.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A paginated call to get a list of all custom line items (FFLIs) for the given +// A paginated call to get a list of all custom line items (FFLIs) for the given +// // billing period. If you don't provide a billing period, the current billing // period is used. func (c *Client) ListCustomLineItems(ctx context.Context, params *ListCustomLineItemsInput, optFns ...func(*Options)) (*ListCustomLineItemsOutput, error) { @@ -31,17 +32,17 @@ func (c *Client) ListCustomLineItems(ctx context.Context, params *ListCustomLine type ListCustomLineItemsInput struct { - // The preferred billing period to get custom line items (FFLIs). + // The preferred billing period to get custom line items (FFLIs). BillingPeriod *string // A ListCustomLineItemsFilter that specifies the custom line item names and/or // billing group Amazon Resource Names (ARNs) to retrieve FFLI information. Filters *types.ListCustomLineItemsFilter - // The maximum number of billing groups to retrieve. + // The maximum number of billing groups to retrieve. MaxResults *int32 - // The pagination token that's used on subsequent calls to get custom line items + // The pagination token that's used on subsequent calls to get custom line items // (FFLIs). NextToken *string @@ -50,10 +51,10 @@ type ListCustomLineItemsInput struct { type ListCustomLineItemsOutput struct { - // A list of FreeFormLineItemListElements received. + // A list of FreeFormLineItemListElements received. CustomLineItems []types.CustomLineItemListElement - // The pagination token that's used on subsequent calls to get custom line items + // The pagination token that's used on subsequent calls to get custom line items // (FFLIs). NextToken *string @@ -150,7 +151,7 @@ var _ ListCustomLineItemsAPIClient = (*Client)(nil) // ListCustomLineItemsPaginatorOptions is the paginator options for // ListCustomLineItems type ListCustomLineItemsPaginatorOptions struct { - // The maximum number of billing groups to retrieve. + // The maximum number of billing groups to retrieve. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/billingconductor/api_op_ListPricingPlans.go b/service/billingconductor/api_op_ListPricingPlans.go index f37955be375..b21f0f25b8f 100644 --- a/service/billingconductor/api_op_ListPricingPlans.go +++ b/service/billingconductor/api_op_ListPricingPlans.go @@ -48,7 +48,7 @@ type ListPricingPlansInput struct { type ListPricingPlansOutput struct { - // The billing period for which the described pricing plans are applicable. + // The billing period for which the described pricing plans are applicable. BillingPeriod *string // The pagination token that's used on subsequent calls to get pricing plans. diff --git a/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go b/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go index caaeacb2f87..c5d30d8f379 100644 --- a/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go +++ b/service/billingconductor/api_op_ListPricingPlansAssociatedWithPricingRule.go @@ -28,19 +28,19 @@ func (c *Client) ListPricingPlansAssociatedWithPricingRule(ctx context.Context, type ListPricingPlansAssociatedWithPricingRuleInput struct { - // The pricing rule Amazon Resource Name (ARN) for which associations will be + // The pricing rule Amazon Resource Name (ARN) for which associations will be // listed. // // This member is required. PricingRuleArn *string - // The pricing plan billing period for which associations will be listed. + // The pricing plan billing period for which associations will be listed. BillingPeriod *string - // The optional maximum number of pricing rule associations to retrieve. + // The optional maximum number of pricing rule associations to retrieve. MaxResults *int32 - // The optional pagination token returned by a previous call. + // The optional pagination token returned by a previous call. NextToken *string noSmithyDocumentSerde @@ -48,17 +48,17 @@ type ListPricingPlansAssociatedWithPricingRuleInput struct { type ListPricingPlansAssociatedWithPricingRuleOutput struct { - // The pricing plan billing period for which associations will be listed. + // The pricing plan billing period for which associations will be listed. BillingPeriod *string - // The pagination token to be used on subsequent calls. + // The pagination token to be used on subsequent calls. NextToken *string - // The list containing pricing plans that are associated with the requested + // 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 + // The pricing rule Amazon Resource Name (ARN) for which associations will be // listed. PricingRuleArn *string @@ -158,7 +158,7 @@ var _ ListPricingPlansAssociatedWithPricingRuleAPIClient = (*Client)(nil) // ListPricingPlansAssociatedWithPricingRulePaginatorOptions is the paginator // options for ListPricingPlansAssociatedWithPricingRule type ListPricingPlansAssociatedWithPricingRulePaginatorOptions struct { - // The optional maximum number of pricing rule associations to retrieve. + // The optional maximum number of pricing rule associations to retrieve. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/billingconductor/api_op_ListPricingRules.go b/service/billingconductor/api_op_ListPricingRules.go index 91a30474231..794c287a99d 100644 --- a/service/billingconductor/api_op_ListPricingRules.go +++ b/service/billingconductor/api_op_ListPricingRules.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a pricing rule that can be associated to a pricing plan, or set of +// Describes a pricing rule that can be associated to a pricing plan, or set of +// // pricing plans. func (c *Client) ListPricingRules(ctx context.Context, params *ListPricingRulesInput, optFns ...func(*Options)) (*ListPricingRulesOutput, error) { if params == nil { @@ -30,17 +31,17 @@ func (c *Client) ListPricingRules(ctx context.Context, params *ListPricingRulesI type ListPricingRulesInput struct { - // The preferred billing period to get the pricing plan. + // The preferred billing period to get the pricing plan. BillingPeriod *string - // A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of + // A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of // pricing rules to retrieve pricing rules information. Filters *types.ListPricingRulesFilter - // The maximum number of pricing rules to retrieve. + // The maximum number of pricing rules to retrieve. MaxResults *int32 - // The pagination token that's used on subsequent call to get pricing rules. + // The pagination token that's used on subsequent call to get pricing rules. NextToken *string noSmithyDocumentSerde @@ -48,13 +49,13 @@ type ListPricingRulesInput struct { type ListPricingRulesOutput struct { - // The billing period for which the described pricing rules are applicable. + // The billing period for which the described pricing rules are applicable. BillingPeriod *string - // The pagination token that's used on subsequent calls to get pricing rules. + // The pagination token that's used on subsequent calls to get pricing rules. NextToken *string - // A list containing the described pricing rules. + // A list containing the described pricing rules. PricingRules []types.PricingRuleListElement // Metadata pertaining to the operation's result. @@ -149,7 +150,7 @@ var _ ListPricingRulesAPIClient = (*Client)(nil) // ListPricingRulesPaginatorOptions is the paginator options for ListPricingRules type ListPricingRulesPaginatorOptions struct { - // The maximum number of pricing rules to retrieve. + // The maximum number of pricing rules to retrieve. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go b/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go index 68d22d9a1a9..ad5a88b206b 100644 --- a/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go +++ b/service/billingconductor/api_op_ListPricingRulesAssociatedToPricingPlan.go @@ -28,19 +28,19 @@ func (c *Client) ListPricingRulesAssociatedToPricingPlan(ctx context.Context, pa type ListPricingRulesAssociatedToPricingPlanInput struct { - // The Amazon Resource Name (ARN) of the pricing plan for which associations are + // The Amazon Resource Name (ARN) of the pricing plan for which associations are // to be listed. // // This member is required. PricingPlanArn *string - // The billing period for which the pricing rule associations are to be listed. + // The billing period for which the pricing rule associations are to be listed. BillingPeriod *string // The optional maximum number of pricing rule associations to retrieve. MaxResults *int32 - // The optional pagination token returned by a previous call. + // The optional pagination token returned by a previous call. NextToken *string noSmithyDocumentSerde @@ -48,17 +48,17 @@ type ListPricingRulesAssociatedToPricingPlanInput struct { type ListPricingRulesAssociatedToPricingPlanOutput struct { - // The billing period for which the pricing rule associations are listed. + // The billing period for which the pricing rule associations are listed. BillingPeriod *string - // The pagination token to be used on subsequent calls. + // The pagination token to be used on subsequent calls. NextToken *string - // The Amazon Resource Name (ARN) of the pricing plan for which associations are + // The Amazon Resource Name (ARN) of the pricing plan for which associations are // listed. PricingPlanArn *string - // A list containing pricing rules that are associated with the requested pricing + // A list containing pricing rules that are associated with the requested pricing // plan. PricingRuleArns []string diff --git a/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go b/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go index eedef6119da..d7896af12c0 100644 --- a/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go +++ b/service/billingconductor/api_op_ListResourcesAssociatedToCustomLineItem.go @@ -29,23 +29,23 @@ func (c *Client) ListResourcesAssociatedToCustomLineItem(ctx context.Context, pa type ListResourcesAssociatedToCustomLineItemInput struct { - // The ARN of the custom line item for which the resource associations will be + // The ARN of the custom line item for which the resource associations will be // listed. // // This member is required. Arn *string - // The billing period for which the resource associations will be listed. + // The billing period for which the resource associations will be listed. BillingPeriod *string - // (Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the - // types of resources that should be retrieved. + // (Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify + // the types of resources that should be retrieved. Filters *types.ListResourcesAssociatedToCustomLineItemFilter - // (Optional) The maximum number of resource associations to be retrieved. + // (Optional) The maximum number of resource associations to be retrieved. MaxResults *int32 - // (Optional) The pagination token that's returned by a previous request. + // (Optional) The pagination token that's returned by a previous request. NextToken *string noSmithyDocumentSerde @@ -53,14 +53,14 @@ type ListResourcesAssociatedToCustomLineItemInput struct { type ListResourcesAssociatedToCustomLineItemOutput struct { - // The custom line item ARN for which the resource associations are listed. + // The custom line item ARN for which the resource associations are listed. Arn *string - // A list of ListResourcesAssociatedToCustomLineItemResponseElement for each + // A list of ListResourcesAssociatedToCustomLineItemResponseElement for each // resource association retrieved. AssociatedResources []types.ListResourcesAssociatedToCustomLineItemResponseElement - // The pagination token to be used in subsequent requests to retrieve additional + // The pagination token to be used in subsequent requests to retrieve additional // results. NextToken *string @@ -160,7 +160,7 @@ var _ ListResourcesAssociatedToCustomLineItemAPIClient = (*Client)(nil) // ListResourcesAssociatedToCustomLineItemPaginatorOptions is the paginator // options for ListResourcesAssociatedToCustomLineItem type ListResourcesAssociatedToCustomLineItemPaginatorOptions struct { - // (Optional) The maximum number of resource associations to be retrieved. + // (Optional) The maximum number of resource associations to be retrieved. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/billingconductor/api_op_ListTagsForResource.go b/service/billingconductor/api_op_ListTagsForResource.go index 4d943142a2a..69cba4bde76 100644 --- a/service/billingconductor/api_op_ListTagsForResource.go +++ b/service/billingconductor/api_op_ListTagsForResource.go @@ -28,7 +28,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) that identifies the resource to list the tags. + // The Amazon Resource Name (ARN) that identifies the resource to list the tags. // // This member is required. ResourceArn *string @@ -38,7 +38,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags for the resource. + // The tags for the resource. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_TagResource.go b/service/billingconductor/api_op_TagResource.go index 14b353fc4a5..52cc5ed8323 100644 --- a/service/billingconductor/api_op_TagResource.go +++ b/service/billingconductor/api_op_TagResource.go @@ -10,7 +10,8 @@ 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) { @@ -30,12 +31,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource to which to add tags. + // The Amazon Resource Name (ARN) of the resource to which to add tags. // // This member is required. ResourceArn *string - // The tags to add to the resource as a list of key-value pairs. + // The tags to add to the resource as a list of key-value pairs. // // This member is required. Tags map[string]string diff --git a/service/billingconductor/api_op_UntagResource.go b/service/billingconductor/api_op_UntagResource.go index 702b114c307..beb43f30f61 100644 --- a/service/billingconductor/api_op_UntagResource.go +++ b/service/billingconductor/api_op_UntagResource.go @@ -28,12 +28,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource to which to delete tags. + // The Amazon Resource Name (ARN) of the resource to which to delete tags. // // This member is required. ResourceArn *string - // The tags to delete from the resource as a list of key-value pairs. + // The tags to delete from the resource as a list of key-value pairs. // // This member is required. TagKeys []string diff --git a/service/billingconductor/api_op_UpdateBillingGroup.go b/service/billingconductor/api_op_UpdateBillingGroup.go index 9595e41cf1a..532171951c0 100644 --- a/service/billingconductor/api_op_UpdateBillingGroup.go +++ b/service/billingconductor/api_op_UpdateBillingGroup.go @@ -38,7 +38,7 @@ type UpdateBillingGroupInput struct { // ) enabled. AccountGrouping *types.UpdateBillingGroupAccountGrouping - // The preferences and settings that will be used to compute the Amazon Web + // The preferences and settings that will be used to compute the Amazon Web // Services charges for a billing group. ComputationPreference *types.ComputationPreference @@ -63,29 +63,29 @@ type UpdateBillingGroupOutput struct { // The Amazon Resource Name (ARN) of the billing group that was updated. Arn *string - // A description of the billing group. + // A description of the billing group. Description *string - // The most recent time when the billing group was modified. + // The most recent time when the billing group was modified. LastModifiedTime int64 - // The name of the billing group. The names must be unique to each billing group. + // The name of the billing group. The names must be unique to each billing group. Name *string - // The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web + // The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web // Services charges for the billing group. PricingPlanArn *string - // The account ID that serves as the main account in a billing group. + // The account ID that serves as the main account in a billing group. PrimaryAccountId *string - // The number of accounts in the particular billing group. + // The number of accounts in the particular billing group. Size int64 - // The status of the billing group. Only one of the valid values can be used. + // The status of the billing group. Only one of the valid values can be used. Status types.BillingGroupStatus - // The reason why the billing group is in its current status. + // The reason why the billing group is in its current status. StatusReason *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_UpdateCustomLineItem.go b/service/billingconductor/api_op_UpdateCustomLineItem.go index 6493a694b4e..dbbb87619d6 100644 --- a/service/billingconductor/api_op_UpdateCustomLineItem.go +++ b/service/billingconductor/api_op_UpdateCustomLineItem.go @@ -29,7 +29,7 @@ func (c *Client) UpdateCustomLineItem(ctx context.Context, params *UpdateCustomL type UpdateCustomLineItemInput struct { - // The ARN of the custom line item to be updated. + // The ARN of the custom line item to be updated. // // This member is required. Arn *string @@ -37,14 +37,14 @@ type UpdateCustomLineItemInput struct { // The billing period range in which the custom line item request will be applied. BillingPeriodRange *types.CustomLineItemBillingPeriodRange - // A ListCustomLineItemChargeDetails containing the new charge details for the + // A ListCustomLineItemChargeDetails containing the new charge details for the // custom line item. ChargeDetails *types.UpdateCustomLineItemChargeDetails - // The new line item description of the custom line item. + // The new line item description of the custom line item. Description *string - // The new name for the custom line item. + // The new name for the custom line item. Name *string noSmithyDocumentSerde @@ -52,26 +52,26 @@ type UpdateCustomLineItemInput struct { type UpdateCustomLineItemOutput struct { - // The ARN of the successfully updated custom line item. + // The ARN of the successfully updated custom line item. Arn *string - // The number of resources that are associated to the custom line item. + // The number of resources that are associated to the custom line item. AssociationSize int64 - // The ARN of the billing group that the custom line item is applied to. + // The ARN of the billing group that the custom line item is applied to. BillingGroupArn *string - // A ListCustomLineItemChargeDetails containing the charge details of the + // A ListCustomLineItemChargeDetails containing the charge details of the // successfully updated custom line item. ChargeDetails *types.ListCustomLineItemChargeDetails - // The description of the successfully updated custom line item. + // The description of the successfully updated custom line item. Description *string - // The most recent time when the custom line item was modified. + // The most recent time when the custom line item was modified. LastModifiedTime int64 - // The name of the successfully updated custom line item. + // The name of the successfully updated custom line item. Name *string // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_UpdatePricingPlan.go b/service/billingconductor/api_op_UpdatePricingPlan.go index 5470dbb27f1..aaa604dee74 100644 --- a/service/billingconductor/api_op_UpdatePricingPlan.go +++ b/service/billingconductor/api_op_UpdatePricingPlan.go @@ -47,16 +47,17 @@ type UpdatePricingPlanOutput struct { // The Amazon Resource Name (ARN) of the updated pricing plan. Arn *string - // The new description for the pricing rule. + // The new description for the pricing rule. Description *string - // The most recent time when the pricing plan was modified. + // The most recent time when the pricing plan was modified. LastModifiedTime int64 - // The name of the pricing plan. The name must be unique to each pricing plan. + // The name of the pricing plan. The name must be unique to each pricing plan. Name *string - // The pricing rules count that's currently associated with this pricing plan list. + // The pricing rules count that's currently associated with this pricing plan + // list. Size int64 // Metadata pertaining to the operation's result. diff --git a/service/billingconductor/api_op_UpdatePricingRule.go b/service/billingconductor/api_op_UpdatePricingRule.go index e0e9da225b2..ae1fac7c046 100644 --- a/service/billingconductor/api_op_UpdatePricingRule.go +++ b/service/billingconductor/api_op_UpdatePricingRule.go @@ -29,24 +29,25 @@ func (c *Client) UpdatePricingRule(ctx context.Context, params *UpdatePricingRul type UpdatePricingRuleInput struct { - // The Amazon Resource Name (ARN) of the pricing rule to update. + // The Amazon Resource Name (ARN) of the pricing rule to update. // // This member is required. Arn *string - // The new description for the pricing rule. + // The new description for the pricing rule. Description *string - // The new modifier to show pricing plan rates as a percentage. + // The new modifier to show pricing plan rates as a percentage. ModifierPercentage *float64 - // The new name of the pricing rule. The name must be unique to each pricing rule. + // The new name of the pricing rule. The name must be unique to each pricing + // rule. Name *string - // The set of tiering configurations for the pricing rule. + // The set of tiering configurations for the pricing rule. Tiering *types.UpdateTieringInput - // The new pricing rule type. + // The new pricing rule type. Type types.PricingRuleType noSmithyDocumentSerde @@ -54,54 +55,57 @@ type UpdatePricingRuleInput struct { type UpdatePricingRuleOutput struct { - // The Amazon Resource Name (ARN) of the successfully updated pricing rule. + // The Amazon Resource Name (ARN) of the successfully updated pricing rule. Arn *string - // The pricing plans count that this pricing rule is associated with. + // The pricing plans count that this pricing rule is associated with. AssociatedPricingPlanCount int64 - // The seller of services provided by Amazon Web Services, their affiliates, or + // The seller of services provided by Amazon Web Services, their affiliates, or // third-party providers selling services via Amazon Web Services Marketplace. BillingEntity *string - // The new description for the pricing rule. + // The new description for the pricing rule. Description *string - // The most recent time the pricing rule was modified. + // The most recent time the pricing rule was modified. LastModifiedTime int64 - // The new modifier to show pricing plan rates as a percentage. + // The new modifier to show pricing plan rates as a percentage. ModifierPercentage *float64 - // The new name of the pricing rule. The name must be unique to each pricing rule. + // The new name of the pricing rule. The name must be unique to each pricing + // rule. Name *string // 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 - // modifying. For example, a value of RunInstances:0202 indicates the operation of - // running an Amazon EC2 instance. + // 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 modifying. For example, a value of RunInstances:0202 + // indicates the operation of running an Amazon EC2 instance. Operation *string - // The scope of pricing rule that indicates if it's globally applicable, or it's + // The scope of pricing rule that indicates if it's globally applicable, or it's // service-specific. Scope types.PricingRuleScope - // If the Scope attribute is set to SERVICE , the attribute indicates which service - // the PricingRule is applicable for. + // If the Scope attribute is set to SERVICE , the attribute indicates which + // service the PricingRule is applicable for. Service *string - // The set of tiering configurations for the pricing rule. + // The set of tiering configurations for the pricing rule. Tiering *types.UpdateTieringInput - // The new pricing rule type. + // 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. + // 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 32096e6f113..cf3a6b881b1 100644 --- a/service/billingconductor/doc.go +++ b/service/billingconductor/doc.go @@ -4,19 +4,23 @@ // types for AWSBillingConductor. // // Amazon Web Services Billing Conductor is a fully managed service that you can -// use to customize a proforma (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 -// you with a mechanism to configure, generate, and display rates to certain -// customers over a given billing period. You can also analyze the difference -// 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) -// . +// use to customize a [proforma]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 you with a mechanism to configure, generate, and display +// rates to certain customers over a given billing period. You can also analyze the +// difference 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], 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]user interface, +// see the [Amazon Web Services Billing Conductor User Guide]. +// +// [Amazon Web Services Billing console]: https://console.aws.amazon.com/billing +// [Amazon Web Services Billing Conductor]: https://console.aws.amazon.com/billingconductor/ +// [proforma]: https://docs.aws.amazon.com/billingconductor/latest/userguide/understanding-eb.html#eb-other-definitions +// [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/options.go b/service/billingconductor/options.go index 7e5c4bf6393..c6c1e09366c 100644 --- a/service/billingconductor/options.go +++ b/service/billingconductor/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/billingconductor/types/enums.go b/service/billingconductor/types/enums.go index 6bab2aafe9a..c3c06fb2cd1 100644 --- a/service/billingconductor/types/enums.go +++ b/service/billingconductor/types/enums.go @@ -15,8 +15,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociateResourceErrorReason) Values() []AssociateResourceErrorReason { return []AssociateResourceErrorReason{ "INVALID_ARN", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for BillingGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BillingGroupStatus) Values() []BillingGroupStatus { return []BillingGroupStatus{ "ACTIVE", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "RESOURCE_NAME_CONFLICT", @@ -78,8 +81,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -97,6 +101,7 @@ const ( // Values returns all known values for CustomLineItemRelationship. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CustomLineItemRelationship) Values() []CustomLineItemRelationship { return []CustomLineItemRelationship{ @@ -114,8 +119,9 @@ const ( ) // Values returns all known values for CustomLineItemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomLineItemType) Values() []CustomLineItemType { return []CustomLineItemType{ "CREDIT", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for GroupByAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupByAttributeName) Values() []GroupByAttributeName { return []GroupByAttributeName{ "PRODUCT_NAME", @@ -150,6 +157,7 @@ const ( // Values returns all known values for LineItemFilterAttributeName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LineItemFilterAttributeName) Values() []LineItemFilterAttributeName { return []LineItemFilterAttributeName{ @@ -165,8 +173,9 @@ const ( ) // Values returns all known values for LineItemFilterValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineItemFilterValue) Values() []LineItemFilterValue { return []LineItemFilterValue{ "SAVINGS_PLAN_NEGATION", @@ -181,8 +190,9 @@ const ( ) // Values returns all known values for MatchOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchOption) Values() []MatchOption { return []MatchOption{ "NOT_EQUAL", @@ -200,8 +210,9 @@ const ( ) // Values returns all known values for PricingRuleScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingRuleScope) Values() []PricingRuleScope { return []PricingRuleScope{ "GLOBAL", @@ -221,8 +232,9 @@ const ( ) // Values returns all known values for PricingRuleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingRuleType) Values() []PricingRuleType { return []PricingRuleType{ "MARKUP", @@ -299,6 +311,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/billingconductor/types/types.go b/service/billingconductor/types/types.go index 4a1cffa2a13..810e78acadb 100644 --- a/service/billingconductor/types/types.go +++ b/service/billingconductor/types/types.go @@ -208,7 +208,7 @@ type BillingPeriodRange struct { // Services charges for a billing group. type ComputationPreference struct { - // The Amazon Resource Name (ARN) of the pricing plan that's used to compute the + // The Amazon Resource Name (ARN) of the pricing plan that's used to compute the // Amazon Web Services charges for a billing group. // // This member is required. @@ -220,7 +220,7 @@ type ComputationPreference struct { // The possible Amazon Web Services Free Tier configurations. type CreateFreeTierConfig struct { - // Activate or deactivate Amazon Web Services Free Tier. + // Activate or deactivate Amazon Web Services Free Tier. // // This member is required. Activated *bool @@ -231,7 +231,7 @@ type CreateFreeTierConfig struct { // The set of tiering configurations for the pricing rule. type CreateTieringInput struct { - // The possible Amazon Web Services Free Tier configurations. + // The possible Amazon Web Services Free Tier configurations. // // This member is required. FreeTier *CreateFreeTierConfig @@ -358,7 +358,8 @@ type CustomLineItemVersionListElement struct { // to. AccountId *string - // A list of custom line item Amazon Resource Names (ARNs) to retrieve information. + // A list of custom line item Amazon Resource Names (ARNs) to retrieve + // information. Arn *string // The number of resources that are associated with the custom line item. @@ -368,7 +369,7 @@ type CustomLineItemVersionListElement struct { // applies to. BillingGroupArn *string - // A representation of the charge details of a custom line item. + // A representation of the charge details of a custom line item. ChargeDetails *ListCustomLineItemChargeDetails // The time when the custom line item version was created. @@ -395,7 +396,7 @@ type CustomLineItemVersionListElement struct { // The start billing period of the custom line item version. StartBillingPeriod *string - // The inclusive start time. + // The inclusive start time. StartTime int64 noSmithyDocumentSerde @@ -407,7 +408,7 @@ type DisassociateResourceResponseElement struct { // The resource ARN that was disassociated from the custom line item. Arn *string - // An AssociateResourceError that's shown if the resource disassociation fails. + // An AssociateResourceError that's shown if the resource disassociation fails. Error *AssociateResourceError noSmithyDocumentSerde @@ -416,7 +417,7 @@ type DisassociateResourceResponseElement struct { // The possible Amazon Web Services Free Tier configurations. type FreeTierConfig struct { - // Activate or deactivate Amazon Web Services Free Tier application. + // Activate or deactivate Amazon Web Services Free Tier application. // // This member is required. Activated *bool @@ -453,21 +454,28 @@ type LineItemFilter 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 : -// linked accounts that are associated to the provided 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 { // The Amazon Web Services account ID to filter on. AccountId *string - // The list of Amazon Web Services IDs to retrieve their associated billing group + // The list of Amazon Web Services IDs to retrieve their associated billing group // 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 : - // linked accounts that are associated to the provided 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 @@ -507,7 +515,7 @@ type ListBillingGroupsFilter struct { // The pricing plan Amazon Resource Names (ARNs) to retrieve information. PricingPlan *string - // A list of billing groups to retrieve their current status for a specific time + // A list of billing groups to retrieve their current status for a specific time // range Statuses []BillingGroupStatus @@ -517,31 +525,32 @@ type ListBillingGroupsFilter struct { // A representation of the charge details of a custom line item. type ListCustomLineItemChargeDetails struct { - // The type of the custom line item that indicates whether the charge is a fee or + // The type of the custom line item that indicates whether the charge is a fee or // credit . // // This member is required. Type CustomLineItemType - // A ListCustomLineItemFlatChargeDetails that describes the charge details of a + // A ListCustomLineItemFlatChargeDetails that describes the charge details of a // flat custom line item. Flat *ListCustomLineItemFlatChargeDetails // A representation of the line item filter. LineItemFilters []LineItemFilter - // A ListCustomLineItemPercentageChargeDetails that describes the charge details + // A ListCustomLineItemPercentageChargeDetails that describes the charge details // of a percentage custom line item. Percentage *ListCustomLineItemPercentageChargeDetails noSmithyDocumentSerde } -// A representation of the charge details that are associated with a flat custom +// A representation of the charge details that are associated with a flat custom +// // line item. type ListCustomLineItemFlatChargeDetails struct { - // The custom line item's fixed charge value in USD. + // The custom line item's fixed charge value in USD. // // This member is required. ChargeValue *float64 @@ -549,11 +558,12 @@ type ListCustomLineItemFlatChargeDetails struct { noSmithyDocumentSerde } -// A representation of the charge details that are associated with a percentage +// A representation of the charge details that are associated with a percentage +// // custom line item. type ListCustomLineItemPercentageChargeDetails struct { - // The custom line item's percentage value. This will be multiplied against the + // The custom line item's percentage value. This will be multiplied against the // combined value of its associated resources to determine its charge value. // // This member is required. @@ -617,7 +627,8 @@ type ListPricingPlansFilter struct { noSmithyDocumentSerde } -// The filter that specifies criteria that the pricing rules returned by the +// The filter that specifies criteria that the pricing rules returned by the +// // ListPricingRules API will adhere to. type ListPricingRulesFilter struct { @@ -628,11 +639,12 @@ type ListPricingRulesFilter struct { noSmithyDocumentSerde } -// A filter that specifies the type of resource associations that should be +// A filter that specifies the type of resource associations that should be +// // retrieved for a custom line item. type ListResourcesAssociatedToCustomLineItemFilter struct { - // The type of relationship between the custom line item and the associated + // The type of relationship between the custom line item and the associated // resource. Relationship CustomLineItemRelationship @@ -642,13 +654,13 @@ type ListResourcesAssociatedToCustomLineItemFilter struct { // A representation of a resource association for a custom line item. type ListResourcesAssociatedToCustomLineItemResponseElement struct { - // The ARN of the associated resource. + // The ARN of the associated resource. Arn *string // The end billing period of the associated resource. EndBillingPeriod *string - // The type of relationship between the custom line item and the associated + // The type of relationship between the custom line item and the associated // resource. Relationship CustomLineItemRelationship @@ -690,7 +702,7 @@ type PricingRuleListElement struct { // The pricing plans count that this pricing rule is associated with. AssociatedPricingPlanCount int64 - // The seller of services provided by Amazon Web Services, their affiliates, or + // The seller of services provided by Amazon Web Services, their affiliates, or // third-party providers selling services via Amazon Web Services Marketplace. BillingEntity *string @@ -700,7 +712,7 @@ type PricingRuleListElement struct { // The pricing rule description. Description *string - // The most recent time when the pricing rule was modified. + // The most recent time when the pricing rule was modified. LastModifiedTime int64 // A percentage modifier applied on the public pricing rates. @@ -709,11 +721,12 @@ type PricingRuleListElement struct { // The name of a pricing rule. Name *string - // 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 - // modifying. For example, a value of RunInstances:0202 indicates the operation of - // running an Amazon EC2 instance. + // 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 modifying. For example, a value of RunInstances:0202 + // indicates the operation of running an Amazon EC2 instance. Operation *string // The scope of pricing rule that indicates if it is globally applicable, or if it @@ -724,17 +737,18 @@ type PricingRuleListElement struct { // PricingRule is applicable for. Service *string - // The set of tiering configurations for the pricing rule. + // The set of tiering configurations for the pricing rule. Tiering *Tiering // 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 @@ -743,7 +757,7 @@ type PricingRuleListElement struct { // The set of tiering configurations for the pricing rule. type Tiering struct { - // The possible Amazon Web Services Free Tier configurations. + // The possible Amazon Web Services Free Tier configurations. // // This member is required. FreeTier *FreeTierConfig @@ -761,29 +775,31 @@ type UpdateBillingGroupAccountGrouping struct { noSmithyDocumentSerde } -// A representation of the new charge details of a custom line item. This should +// A representation of the new charge details of a custom line item. This should +// // contain only one of Flat or Percentage . type UpdateCustomLineItemChargeDetails struct { - // An UpdateCustomLineItemFlatChargeDetails that describes the new charge details + // An UpdateCustomLineItemFlatChargeDetails that describes the new charge details // of a flat custom line item. Flat *UpdateCustomLineItemFlatChargeDetails // A representation of the line item filter. LineItemFilters []LineItemFilter - // An UpdateCustomLineItemPercentageChargeDetails that describes the new charge + // An UpdateCustomLineItemPercentageChargeDetails that describes the new charge // details of a percentage custom line item. Percentage *UpdateCustomLineItemPercentageChargeDetails noSmithyDocumentSerde } -// A representation of the new charge details that are associated with a flat +// A representation of the new charge details that are associated with a flat +// // custom line item. type UpdateCustomLineItemFlatChargeDetails struct { - // The custom line item's new fixed charge value in USD. + // The custom line item's new fixed charge value in USD. // // This member is required. ChargeValue *float64 @@ -791,11 +807,12 @@ type UpdateCustomLineItemFlatChargeDetails struct { noSmithyDocumentSerde } -// A representation of the new charge details that are associated with a +// 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 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. @@ -807,7 +824,7 @@ type UpdateCustomLineItemPercentageChargeDetails struct { // The possible Amazon Web Services Free Tier configurations. type UpdateFreeTierConfig struct { - // Activate or deactivate application of Amazon Web Services Free Tier. + // Activate or deactivate application of Amazon Web Services Free Tier. // // This member is required. Activated *bool @@ -818,7 +835,7 @@ type UpdateFreeTierConfig struct { // The set of tiering configurations for the pricing rule. type UpdateTieringInput struct { - // The possible Amazon Web Services Free Tier configurations. + // The possible Amazon Web Services Free Tier configurations. // // This member is required. FreeTier *UpdateFreeTierConfig diff --git a/service/braket/api_op_CreateJob.go b/service/braket/api_op_CreateJob.go index 2b6fca9e84e..0c468ad1cc6 100644 --- a/service/braket/api_op_CreateJob.go +++ b/service/braket/api_op_CreateJob.go @@ -88,7 +88,7 @@ type CreateJobInput struct { // is located. InputDataConfig []types.InputFileConfig - // The user-defined criteria that specifies when a job stops running. + // The user-defined criteria that specifies when a job stops running. StoppingCondition *types.JobStoppingCondition // A tag object that consists of a key and an optional value, used to manage diff --git a/service/braket/api_op_GetDevice.go b/service/braket/api_op_GetDevice.go index f4719270984..eaecfe61921 100644 --- a/service/braket/api_op_GetDevice.go +++ b/service/braket/api_op_GetDevice.go @@ -11,15 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the devices available in Amazon Braket. For backwards compatibility -// with older versions of BraketSchemas, OpenQASM information is omitted from -// GetDevice API calls. To get this information the user-agent needs to present a -// recent version of the BraketSchemas (1.8.0 or later). The Braket SDK -// automatically reports this for you. If you do not see OpenQASM results in the -// GetDevice response when using a Braket SDK, you may need to set -// AWS_EXECUTION_ENV environment variable to configure user-agent. See the code -// examples provided below for how to do this for the AWS CLI, Boto3, and the Go, -// Java, and JavaScript/TypeScript SDKs. +// Retrieves the devices available in Amazon Braket. +// +// For backwards compatibility with older versions of BraketSchemas, OpenQASM +// information is omitted from GetDevice API calls. To get this information the +// user-agent needs to present a recent version of the BraketSchemas (1.8.0 or +// later). The Braket SDK automatically reports this for you. If you do not see +// OpenQASM results in the GetDevice response when using a Braket SDK, you may need +// to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the +// code examples provided below for how to do this for the AWS CLI, Boto3, and the +// Go, Java, and JavaScript/TypeScript SDKs. func (c *Client) GetDevice(ctx context.Context, params *GetDeviceInput, optFns ...func(*Options)) (*GetDeviceOutput, error) { if params == nil { params = &GetDeviceInput{} diff --git a/service/braket/doc.go b/service/braket/doc.go index eb998d81a2a..019ca518693 100644 --- a/service/braket/doc.go +++ b/service/braket/doc.go @@ -4,6 +4,11 @@ // Braket. // // 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) +// structures supported in Amazon Braket. +// +// Additional Resources: +// +// [Amazon Braket Developer Guide] +// +// [Amazon Braket Developer Guide]: https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html package braket diff --git a/service/braket/options.go b/service/braket/options.go index 6f2478af3c7..fad2827922f 100644 --- a/service/braket/options.go +++ b/service/braket/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/braket/types/enums.go b/service/braket/types/enums.go index a5461764eca..2b9aaca03ee 100644 --- a/service/braket/types/enums.go +++ b/service/braket/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for AssociationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationType) Values() []AssociationType { return []AssociationType{ "RESERVATION_TIME_WINDOW_ARN", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for CancellationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CancellationStatus) Values() []CancellationStatus { return []CancellationStatus{ "CANCELLING", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for CompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionType) Values() []CompressionType { return []CompressionType{ "NONE", @@ -64,8 +67,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -83,8 +87,9 @@ const ( ) // Values returns all known values for DeviceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceType) Values() []DeviceType { return []DeviceType{ "QPU", @@ -101,8 +106,9 @@ const ( // Values returns all known values for HybridJobAdditionalAttributeName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HybridJobAdditionalAttributeName) Values() []HybridJobAdditionalAttributeName { return []HybridJobAdditionalAttributeName{ "QueueInfo", @@ -155,8 +161,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -219,8 +226,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -250,8 +258,9 @@ const ( ) // Values returns all known values for JobPrimaryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobPrimaryStatus) Values() []JobPrimaryStatus { return []JobPrimaryStatus{ "QUEUED", @@ -272,8 +281,9 @@ const ( // Values returns all known values for QuantumTaskAdditionalAttributeName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuantumTaskAdditionalAttributeName) Values() []QuantumTaskAdditionalAttributeName { return []QuantumTaskAdditionalAttributeName{ "QueueInfo", @@ -294,8 +304,9 @@ const ( ) // Values returns all known values for QuantumTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuantumTaskStatus) Values() []QuantumTaskStatus { return []QuantumTaskStatus{ "CREATED", @@ -317,8 +328,9 @@ const ( ) // Values returns all known values for QueueName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueName) Values() []QueueName { return []QueueName{ "QUANTUM_TASKS_QUEUE", @@ -335,8 +347,9 @@ const ( ) // Values returns all known values for QueuePriority. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueuePriority) Values() []QueuePriority { return []QueuePriority{ "Normal", @@ -359,6 +372,7 @@ const ( // 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{ @@ -386,8 +400,9 @@ const ( // Values returns all known values for SearchQuantumTasksFilterOperator. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchQuantumTasksFilterOperator) Values() []SearchQuantumTasksFilterOperator { return []SearchQuantumTasksFilterOperator{ "LT", diff --git a/service/budgets/api_op_CreateBudget.go b/service/budgets/api_op_CreateBudget.go index 6b112f1bff6..434a39be957 100644 --- a/service/budgets/api_op_CreateBudget.go +++ b/service/budgets/api_op_CreateBudget.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// section. +// 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] section. +// +// [Examples]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples func (c *Client) CreateBudget(ctx context.Context, params *CreateBudgetInput, optFns ...func(*Options)) (*CreateBudgetOutput, error) { if params == nil { params = &CreateBudgetInput{} diff --git a/service/budgets/api_op_CreateBudgetAction.go b/service/budgets/api_op_CreateBudgetAction.go index 0d2107393f9..d205f9ce281 100644 --- a/service/budgets/api_op_CreateBudgetAction.go +++ b/service/budgets/api_op_CreateBudgetAction.go @@ -39,18 +39,18 @@ type CreateBudgetActionInput struct { // This member is required. ActionThreshold *types.ActionThreshold - // The type of action. This defines the type of tasks that can be carried out by + // The type of action. This defines the type of tasks that can be carried out by // this action. This field also determines the format for definition. // // This member is required. ActionType types.ActionType - // This specifies if the action needs manual or automatic approval. + // This specifies if the action needs manual or automatic approval. // // This member is required. ApprovalModel types.ApprovalModel - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. @@ -61,18 +61,18 @@ type CreateBudgetActionInput struct { // This member is required. Definition *types.Definition - // The role passed for action execution and reversion. Roles and actions must be + // The role passed for action execution and reversion. Roles and actions must be // in the same account. // // This member is required. ExecutionRoleArn *string - // The type of a notification. It must be ACTUAL or FORECASTED. + // The type of a notification. It must be ACTUAL or FORECASTED. // // This member is required. NotificationType types.NotificationType - // A list of subscribers. + // A list of subscribers. // // This member is required. Subscribers []types.Subscriber @@ -91,12 +91,12 @@ type CreateBudgetActionOutput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. diff --git a/service/budgets/api_op_DeleteBudget.go b/service/budgets/api_op_DeleteBudget.go index 2bfd6e418a7..cae2b782450 100644 --- a/service/budgets/api_op_DeleteBudget.go +++ b/service/budgets/api_op_DeleteBudget.go @@ -10,9 +10,10 @@ 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_DeleteBudgetAction.go b/service/budgets/api_op_DeleteBudgetAction.go index 2fd4fc4c890..9115345ac80 100644 --- a/service/budgets/api_op_DeleteBudgetAction.go +++ b/service/budgets/api_op_DeleteBudgetAction.go @@ -34,12 +34,12 @@ type DeleteBudgetActionInput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. @@ -60,7 +60,7 @@ type DeleteBudgetActionOutput struct { // This member is required. Action *types.Action - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. diff --git a/service/budgets/api_op_DeleteNotification.go b/service/budgets/api_op_DeleteNotification.go index 99eff58a517..8b5c2dae32e 100644 --- a/service/budgets/api_op_DeleteNotification.go +++ b/service/budgets/api_op_DeleteNotification.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a notification. Deleting a notification also deletes the subscribers -// that are associated with the notification. +// Deletes a notification. +// +// Deleting a notification also deletes the subscribers that are associated with +// the notification. func (c *Client) DeleteNotification(ctx context.Context, params *DeleteNotificationInput, optFns ...func(*Options)) (*DeleteNotificationOutput, error) { if params == nil { params = &DeleteNotificationInput{} diff --git a/service/budgets/api_op_DeleteSubscriber.go b/service/budgets/api_op_DeleteSubscriber.go index 9001192c0fc..a5ec2ed3303 100644 --- a/service/budgets/api_op_DeleteSubscriber.go +++ b/service/budgets/api_op_DeleteSubscriber.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a subscriber. Deleting the last subscriber to a notification also -// deletes the notification. +// Deletes a subscriber. +// +// Deleting the last subscriber to a notification also deletes the notification. func (c *Client) DeleteSubscriber(ctx context.Context, params *DeleteSubscriberInput, optFns ...func(*Options)) (*DeleteSubscriberOutput, error) { if params == nil { params = &DeleteSubscriberInput{} diff --git a/service/budgets/api_op_DescribeBudget.go b/service/budgets/api_op_DescribeBudget.go index 3a8e265bb8f..b8458ddb1f5 100644 --- a/service/budgets/api_op_DescribeBudget.go +++ b/service/budgets/api_op_DescribeBudget.go @@ -11,9 +11,12 @@ 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) -// section. +// Describes a budget. +// +// The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits +// , see the [Examples]section. +// +// [Examples]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples func (c *Client) DescribeBudget(ctx context.Context, params *DescribeBudgetInput, optFns ...func(*Options)) (*DescribeBudgetOutput, error) { if params == nil { params = &DescribeBudgetInput{} diff --git a/service/budgets/api_op_DescribeBudgetAction.go b/service/budgets/api_op_DescribeBudgetAction.go index 7702b815c03..95a91dace4e 100644 --- a/service/budgets/api_op_DescribeBudgetAction.go +++ b/service/budgets/api_op_DescribeBudgetAction.go @@ -34,12 +34,12 @@ type DescribeBudgetActionInput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. @@ -55,12 +55,12 @@ type DescribeBudgetActionOutput struct { // This member is required. AccountId *string - // A budget action resource. + // A budget action resource. // // This member is required. Action *types.Action - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. diff --git a/service/budgets/api_op_DescribeBudgetActionHistories.go b/service/budgets/api_op_DescribeBudgetActionHistories.go index dbaa3b5c692..138b7af6805 100644 --- a/service/budgets/api_op_DescribeBudgetActionHistories.go +++ b/service/budgets/api_op_DescribeBudgetActionHistories.go @@ -34,22 +34,22 @@ type DescribeBudgetActionHistoriesInput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. BudgetName *string - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. MaxResults *int32 - // A generic string. + // A generic string. NextToken *string // The period of time that's covered by a budget. The period has a start date and @@ -62,12 +62,12 @@ type DescribeBudgetActionHistoriesInput struct { type DescribeBudgetActionHistoriesOutput struct { - // The historical record of the budget action resource. + // The historical record of the budget action resource. // // This member is required. ActionHistories []types.ActionHistory - // A generic string. + // A generic string. NextToken *string // Metadata pertaining to the operation's result. @@ -166,7 +166,7 @@ var _ DescribeBudgetActionHistoriesAPIClient = (*Client)(nil) // DescribeBudgetActionHistoriesPaginatorOptions is the paginator options for // DescribeBudgetActionHistories type DescribeBudgetActionHistoriesPaginatorOptions struct { - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. Limit int32 diff --git a/service/budgets/api_op_DescribeBudgetActionsForAccount.go b/service/budgets/api_op_DescribeBudgetActionsForAccount.go index 365dd595d45..2585617809b 100644 --- a/service/budgets/api_op_DescribeBudgetActionsForAccount.go +++ b/service/budgets/api_op_DescribeBudgetActionsForAccount.go @@ -34,11 +34,11 @@ type DescribeBudgetActionsForAccountInput struct { // This member is required. AccountId *string - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. MaxResults *int32 - // A generic string. + // A generic string. NextToken *string noSmithyDocumentSerde @@ -46,12 +46,12 @@ type DescribeBudgetActionsForAccountInput struct { type DescribeBudgetActionsForAccountOutput struct { - // A list of the budget action resources information. + // A list of the budget action resources information. // // This member is required. Actions []types.Action - // A generic string. + // A generic string. NextToken *string // Metadata pertaining to the operation's result. @@ -150,7 +150,7 @@ var _ DescribeBudgetActionsForAccountAPIClient = (*Client)(nil) // DescribeBudgetActionsForAccountPaginatorOptions is the paginator options for // DescribeBudgetActionsForAccount type DescribeBudgetActionsForAccountPaginatorOptions struct { - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. Limit int32 diff --git a/service/budgets/api_op_DescribeBudgetActionsForBudget.go b/service/budgets/api_op_DescribeBudgetActionsForBudget.go index 85cb070cfb1..2d9869da77c 100644 --- a/service/budgets/api_op_DescribeBudgetActionsForBudget.go +++ b/service/budgets/api_op_DescribeBudgetActionsForBudget.go @@ -34,17 +34,17 @@ type DescribeBudgetActionsForBudgetInput struct { // This member is required. AccountId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. BudgetName *string - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. MaxResults *int32 - // A generic string. + // A generic string. NextToken *string noSmithyDocumentSerde @@ -52,12 +52,12 @@ type DescribeBudgetActionsForBudgetInput struct { type DescribeBudgetActionsForBudgetOutput struct { - // A list of the budget action resources information. + // A list of the budget action resources information. // // This member is required. Actions []types.Action - // A generic string. + // A generic string. NextToken *string // Metadata pertaining to the operation's result. @@ -156,7 +156,7 @@ var _ DescribeBudgetActionsForBudgetAPIClient = (*Client)(nil) // DescribeBudgetActionsForBudgetPaginatorOptions is the paginator options for // DescribeBudgetActionsForBudget type DescribeBudgetActionsForBudgetPaginatorOptions struct { - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. Limit int32 diff --git a/service/budgets/api_op_DescribeBudgetNotificationsForAccount.go b/service/budgets/api_op_DescribeBudgetNotificationsForAccount.go index 8fc8df23da1..9fd76f86d05 100644 --- a/service/budgets/api_op_DescribeBudgetNotificationsForAccount.go +++ b/service/budgets/api_op_DescribeBudgetNotificationsForAccount.go @@ -34,11 +34,11 @@ type DescribeBudgetNotificationsForAccountInput struct { // This member is required. AccountId *string - // An integer that represents how many budgets a paginated response contains. The + // An integer that represents how many budgets a paginated response contains. The // default is 50. MaxResults *int32 - // A generic string. + // A generic string. NextToken *string noSmithyDocumentSerde @@ -46,10 +46,10 @@ type DescribeBudgetNotificationsForAccountInput struct { type DescribeBudgetNotificationsForAccountOutput struct { - // A list of budget names and associated notifications for an account. + // A list of budget names and associated notifications for an account. BudgetNotificationsForAccount []types.BudgetNotificationsForAccount - // A generic string. + // A generic string. NextToken *string // Metadata pertaining to the operation's result. @@ -148,7 +148,7 @@ var _ DescribeBudgetNotificationsForAccountAPIClient = (*Client)(nil) // DescribeBudgetNotificationsForAccountPaginatorOptions is the paginator options // for DescribeBudgetNotificationsForAccount type DescribeBudgetNotificationsForAccountPaginatorOptions struct { - // An integer that represents how many budgets a paginated response contains. The + // An integer that represents how many budgets a paginated response contains. The // default is 50. Limit int32 diff --git a/service/budgets/api_op_DescribeBudgetPerformanceHistory.go b/service/budgets/api_op_DescribeBudgetPerformanceHistory.go index 952522ac012..a4191d7046e 100644 --- a/service/budgets/api_op_DescribeBudgetPerformanceHistory.go +++ b/service/budgets/api_op_DescribeBudgetPerformanceHistory.go @@ -35,17 +35,17 @@ type DescribeBudgetPerformanceHistoryInput struct { // This member is required. AccountId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. BudgetName *string - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. MaxResults *int32 - // A generic string. + // A generic string. NextToken *string // Retrieves how often the budget went into an ALARM state for the specified time @@ -57,14 +57,15 @@ type DescribeBudgetPerformanceHistoryInput struct { type DescribeBudgetPerformanceHistoryOutput struct { - // The history of how often the budget has gone into an ALARM state. For DAILY - // budgets, the history saves the state of the budget for the last 60 days. For - // MONTHLY budgets, the history saves the state of the budget for the current month - // plus the last 12 months. For QUARTERLY budgets, the history saves the state of - // the budget for the last four quarters. + // The history of how often the budget has gone into an ALARM state. + // + // For DAILY budgets, the history saves the state of the budget for the last 60 + // days. For MONTHLY budgets, the history saves the state of the budget for the + // current month plus the last 12 months. For QUARTERLY budgets, the history saves + // the state of the budget for the last four quarters. BudgetPerformanceHistory *types.BudgetPerformanceHistory - // A generic string. + // A generic string. NextToken *string // Metadata pertaining to the operation's result. @@ -163,7 +164,7 @@ var _ DescribeBudgetPerformanceHistoryAPIClient = (*Client)(nil) // DescribeBudgetPerformanceHistoryPaginatorOptions is the paginator options for // DescribeBudgetPerformanceHistory type DescribeBudgetPerformanceHistoryPaginatorOptions struct { - // An integer that represents how many entries a paginated response contains. The + // An integer that represents how many entries a paginated response contains. The // maximum is 100. Limit int32 diff --git a/service/budgets/api_op_DescribeBudgets.go b/service/budgets/api_op_DescribeBudgets.go index 6b35f7307f5..79171ddeb13 100644 --- a/service/budgets/api_op_DescribeBudgets.go +++ b/service/budgets/api_op_DescribeBudgets.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Lists the budgets that are associated with an account. +// +// The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits +// , see the [Examples]section. +// +// [Examples]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples func (c *Client) DescribeBudgets(ctx context.Context, params *DescribeBudgetsInput, optFns ...func(*Options)) (*DescribeBudgetsOutput, error) { if params == nil { params = &DescribeBudgetsInput{} diff --git a/service/budgets/api_op_ExecuteBudgetAction.go b/service/budgets/api_op_ExecuteBudgetAction.go index e907424acde..ca886a8572f 100644 --- a/service/budgets/api_op_ExecuteBudgetAction.go +++ b/service/budgets/api_op_ExecuteBudgetAction.go @@ -34,18 +34,18 @@ type ExecuteBudgetActionInput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. BudgetName *string - // The type of execution. + // The type of execution. // // This member is required. ExecutionType types.ExecutionType @@ -60,18 +60,18 @@ type ExecuteBudgetActionOutput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. BudgetName *string - // The type of execution. + // The type of execution. // // This member is required. ExecutionType types.ExecutionType diff --git a/service/budgets/api_op_UpdateBudget.go b/service/budgets/api_op_UpdateBudget.go index 52c621f9a56..2554eeed56f 100644 --- a/service/budgets/api_op_UpdateBudget.go +++ b/service/budgets/api_op_UpdateBudget.go @@ -14,11 +14,13 @@ 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 // 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) -// section. +// 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] section. +// +// [Examples]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples func (c *Client) UpdateBudget(ctx context.Context, params *UpdateBudgetInput, optFns ...func(*Options)) (*UpdateBudgetOutput, error) { if params == nil { params = &UpdateBudgetInput{} diff --git a/service/budgets/api_op_UpdateBudgetAction.go b/service/budgets/api_op_UpdateBudgetAction.go index 4accad709bd..afd4e09c88f 100644 --- a/service/budgets/api_op_UpdateBudgetAction.go +++ b/service/budgets/api_op_UpdateBudgetAction.go @@ -34,12 +34,12 @@ type UpdateBudgetActionInput struct { // This member is required. AccountId *string - // A system-generated universally unique identifier (UUID) for the action. + // A system-generated universally unique identifier (UUID) for the action. // // This member is required. ActionId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. @@ -48,20 +48,20 @@ type UpdateBudgetActionInput struct { // The trigger threshold of the action. ActionThreshold *types.ActionThreshold - // This specifies if the action needs manual or automatic approval. + // This specifies if the action needs manual or automatic approval. ApprovalModel types.ApprovalModel // Specifies all of the type-specific parameters. Definition *types.Definition - // The role passed for action execution and reversion. Roles and actions must be + // 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. + // The type of a notification. It must be ACTUAL or FORECASTED. NotificationType types.NotificationType - // A list of subscribers. + // A list of subscribers. Subscribers []types.Subscriber noSmithyDocumentSerde @@ -74,18 +74,18 @@ type UpdateBudgetActionOutput struct { // This member is required. AccountId *string - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. BudgetName *string - // The updated action resource information. + // The updated action resource information. // // This member is required. NewAction *types.Action - // The previous action resource information. + // The previous action resource information. // // This member is required. OldAction *types.Action diff --git a/service/budgets/doc.go b/service/budgets/doc.go index 46cac25234b..1a8f0dbc33a 100644 --- a/service/budgets/doc.go +++ b/service/budgets/doc.go @@ -6,33 +6,45 @@ // 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: +// 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: +// # 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/) -// . +// Budgets API, see [Amazon Web Services Cost Management Pricing]. +// +// [Amazon Web Services Cost Management Pricing]: https://aws.amazon.com/aws-cost-management/pricing/ package budgets diff --git a/service/budgets/options.go b/service/budgets/options.go index d34e144ab4a..c2c75b70b5a 100644 --- a/service/budgets/options.go +++ b/service/budgets/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/budgets/types/enums.go b/service/budgets/types/enums.go index b51121dd2aa..9fe0a5d309a 100644 --- a/service/budgets/types/enums.go +++ b/service/budgets/types/enums.go @@ -19,8 +19,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -45,8 +46,9 @@ const ( ) // Values returns all known values for ActionSubType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionSubType) Values() []ActionSubType { return []ActionSubType{ "STOP_EC2_INSTANCES", @@ -64,8 +66,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "APPLY_IAM_POLICY", @@ -83,8 +86,9 @@ const ( ) // Values returns all known values for ApprovalModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApprovalModel) Values() []ApprovalModel { return []ApprovalModel{ "AUTOMATIC", @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for AutoAdjustType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoAdjustType) Values() []AutoAdjustType { return []AutoAdjustType{ "HISTORICAL", @@ -123,8 +128,9 @@ const ( ) // Values returns all known values for BudgetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BudgetType) Values() []BudgetType { return []BudgetType{ "USAGE", @@ -146,8 +152,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GREATER_THAN", @@ -168,8 +175,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -191,8 +199,9 @@ const ( ) // Values returns all known values for ExecutionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionType) Values() []ExecutionType { return []ExecutionType{ "APPROVE_BUDGET_ACTION", @@ -211,8 +220,9 @@ const ( ) // Values returns all known values for NotificationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationState) Values() []NotificationState { return []NotificationState{ "OK", @@ -229,8 +239,9 @@ const ( ) // Values returns all known values for NotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationType) Values() []NotificationType { return []NotificationType{ "ACTUAL", @@ -247,8 +258,9 @@ const ( ) // Values returns all known values for SubscriptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionType) Values() []SubscriptionType { return []SubscriptionType{ "SNS", @@ -265,8 +277,9 @@ const ( ) // Values returns all known values for ThresholdType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThresholdType) Values() []ThresholdType { return []ThresholdType{ "PERCENTAGE", @@ -285,8 +298,9 @@ const ( ) // Values returns all known values for TimeUnit. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeUnit) Values() []TimeUnit { return []TimeUnit{ "DAILY", diff --git a/service/budgets/types/types.go b/service/budgets/types/types.go index d6ac187b67f..79ecde915c6 100644 --- a/service/budgets/types/types.go +++ b/service/budgets/types/types.go @@ -31,7 +31,7 @@ type Action struct { // This member is required. ApprovalModel ApprovalModel - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. // // This member is required. @@ -48,7 +48,7 @@ type Action struct { // This member is required. ExecutionRoleArn *string - // The type of a notification. It must be ACTUAL or FORECASTED. + // The type of a notification. It must be ACTUAL or FORECASTED. // // This member is required. NotificationType NotificationType @@ -58,7 +58,7 @@ type Action struct { // This member is required. Status ActionStatus - // A list of subscribers. + // A list of subscribers. // // This member is required. Subscribers []Subscriber @@ -85,7 +85,7 @@ type ActionHistory struct { // This member is required. Status ActionStatus - // A generic time stamp. In Java, it's transformed to a Date object. + // A generic time stamp. In Java, it's transformed to a Date object. // // This member is required. Timestamp *time.Time @@ -101,7 +101,7 @@ type ActionHistoryDetails struct { // This member is required. Action *Action - // A generic string. + // A generic string. // // This member is required. Message *string @@ -112,12 +112,12 @@ type ActionHistoryDetails struct { // The trigger threshold of the action. type ActionThreshold struct { - // The type of threshold for a notification. + // The type of threshold for a notification. // // This member is required. ActionThresholdType ThresholdType - // The threshold of a notification. + // The threshold of a notification. // // This member is required. ActionThresholdValue float64 @@ -146,8 +146,11 @@ type AutoAdjustData struct { // 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 +// 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 \ @@ -172,6 +175,7 @@ type Budget struct { // The total amount of cost, usage, RI utilization, RI coverage, Savings Plans // 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 @@ -183,38 +187,56 @@ type Budget struct { CalculatedSpend *CalculatedSpend // The cost filters, such as Region , Service , LinkedAccount , Tag , or - // CostCategory , that are applied to a budget. Amazon Web Services Budgets - // supports the following services as a Service filter for RI budgets: + // CostCategory , 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. + // // PlannedBudgetLimits is available for cost or usage budget and supports both - // 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. + // 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. + // 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 @@ -224,17 +246,21 @@ type Budget struct { // 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 - // 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. + // 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. TimePeriod *TimePeriod noSmithyDocumentSerde @@ -259,11 +285,11 @@ type BudgetedAndActualAmounts struct { // The budget name and associated notifications for an account. type BudgetNotificationsForAccount struct { - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't allowed. BudgetName *string - // A list of notifications. + // A list of notifications. Notifications []Notification noSmithyDocumentSerde @@ -273,12 +299,13 @@ type BudgetNotificationsForAccount struct { // period. type BudgetPerformanceHistory struct { - // A string that represents the budget name. The ":" and "\" characters, and the + // A string that represents the budget name. The ":" and "\" characters, and the // "/action/" substring, aren't 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 + // 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 @@ -292,7 +319,7 @@ type BudgetPerformanceHistory struct { // The history of the cost types for a budget during the specified time period. CostTypes *CostTypes - // The time unit of the budget, such as MONTHLY or QUARTERLY. + // The time unit of the budget, such as MONTHLY or QUARTERLY. TimeUnit TimeUnit noSmithyDocumentSerde @@ -301,9 +328,10 @@ type BudgetPerformanceHistory struct { // The spend objects that are associated with this budget. The actualSpend tracks // 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 . +// 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 . type CalculatedSpend struct { // The amount of cost, usage, RI units, or Savings Plans units that you used. @@ -319,44 +347,65 @@ 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 . + // Specifies whether a budget includes recurring fees such as monthly RI fees. + // + // The 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 @@ -384,9 +433,13 @@ 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 . // // This member is required. @@ -396,12 +449,15 @@ type HistoricalOptions struct { // BudgetAdjustmentPeriod are included in the calculation of your current // 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 - // BudgetAdjustmentPeriod and your historical cost data. + // 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 noSmithyDocumentSerde @@ -428,14 +484,22 @@ type IamActionDefinition struct { } // A notification that's associated with a budget. A budget can have up to ten -// notifications. Each notification must have at least one subscriber. A -// notification can have one SNS subscriber and up to 10 email subscribers, for a -// 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: +// notifications. +// +// Each notification must have at least one subscriber. A notification can have +// one SNS subscriber and up to 10 email subscribers, for a 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 type Notification struct { @@ -523,13 +587,18 @@ type ScpActionDefinition struct { noSmithyDocumentSerde } -// The amount of cost or usage that's measured for a budget. Cost example: A Spend -// for 3 USD of costs has the following parameters: +// The amount of cost or usage that's measured for a budget. +// +// Cost example: A Spend for 3 USD of costs has the following parameters: +// // - An Amount of 3 +// // - A Unit of USD // // Usage example: A Spend for 3 GB of S3 usage has the following parameters: +// // - An Amount of 3 +// // - A Unit of GB type Spend struct { @@ -570,15 +639,19 @@ 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: +// 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 type Subscriber struct { // The address that Amazon Web Services sends budget notifications to, either an - // SNS topic or an email. When you create a subscriber, the value of Address can't - // contain line breaks. + // SNS topic or an email. + // + // When you create a subscriber, the value of Address can't contain line breaks. // // This member is required. Address *string @@ -598,9 +671,11 @@ 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 - // 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. + // 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. End *time.Time // The start date for a budget. If you created your budget and didn't specify a @@ -609,8 +684,9 @@ type TimePeriod struct { // 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. + // 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 noSmithyDocumentSerde diff --git a/service/chatbot/options.go b/service/chatbot/options.go index 651d0dd6477..1f00d062c30 100644 --- a/service/chatbot/options.go +++ b/service/chatbot/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go index 6211b71dc3f..a501bd32dc0 100644 --- a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go +++ b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnector.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates phone numbers with the specified Amazon Chime Voice Connector. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, AssociatePhoneNumbersWithVoiceConnector (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnector.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Associates phone numbers with the specified Amazon Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [AssociatePhoneNumbersWithVoiceConnector], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by AssociatePhoneNumbersWithVoiceConnector in the Amazon // Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [AssociatePhoneNumbersWithVoiceConnector]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnector.html func (c *Client) AssociatePhoneNumbersWithVoiceConnector(ctx context.Context, params *AssociatePhoneNumbersWithVoiceConnectorInput, optFns ...func(*Options)) (*AssociatePhoneNumbersWithVoiceConnectorOutput, error) { if params == nil { params = &AssociatePhoneNumbersWithVoiceConnectorInput{} diff --git a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go index 6e7f3b14f52..af635aa782d 100644 --- a/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go +++ b/service/chime/api_op_AssociatePhoneNumbersWithVoiceConnectorGroup.go @@ -12,15 +12,18 @@ import ( ) // Associates phone numbers with the specified Amazon Chime Voice Connector group. +// // This API is is no longer supported and will not be updated. We recommend using -// the latest version, AssociatePhoneNumbersWithVoiceConnectorGroup (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the latest version, [AssociatePhoneNumbersWithVoiceConnectorGroup], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by AssociatePhoneNumbersWithVoiceConnectorGroup in the // Amazon Chime SDK Voice Namespace +// +// [AssociatePhoneNumbersWithVoiceConnectorGroup]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_AssociatePhoneNumbersWithVoiceConnectorGroup.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) AssociatePhoneNumbersWithVoiceConnectorGroup(ctx context.Context, params *AssociatePhoneNumbersWithVoiceConnectorGroupInput, optFns ...func(*Options)) (*AssociatePhoneNumbersWithVoiceConnectorGroupOutput, error) { if params == nil { params = &AssociatePhoneNumbersWithVoiceConnectorGroupInput{} diff --git a/service/chime/api_op_BatchCreateAttendee.go b/service/chime/api_op_BatchCreateAttendee.go index e7de04b4ae1..e61ea533923 100644 --- a/service/chime/api_op_BatchCreateAttendee.go +++ b/service/chime/api_op_BatchCreateAttendee.go @@ -11,18 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates up to 100 new attendees for an active Amazon Chime SDK meeting. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, BatchCreateAttendee (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_BatchCreateAttendee.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. For more information about the Amazon -// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. +// Creates up to 100 new attendees for an active Amazon Chime SDK meeting. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [BatchCreateAttendee], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. +// +// For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK] in the Amazon Chime SDK +// Developer Guide. // // Deprecated: Replaced by BatchCreateAttendee in the Amazon Chime SDK Meetings // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [BatchCreateAttendee]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_BatchCreateAttendee.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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 6c75c9fc71a..5c8d90fbcbd 100644 --- a/service/chime/api_op_BatchCreateChannelMembership.go +++ b/service/chime/api_op_BatchCreateChannelMembership.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a specified number of users to a channel. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// BatchCreateChannelMembership (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_BatchCreateChannelMembership.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Adds a specified number of users to a channel. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [BatchCreateChannelMembership], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by BatchCreateChannelMembership in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [BatchCreateChannelMembership]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_BatchCreateChannelMembership.html func (c *Client) BatchCreateChannelMembership(ctx context.Context, params *BatchCreateChannelMembershipInput, optFns ...func(*Options)) (*BatchCreateChannelMembershipOutput, error) { if params == nil { params = &BatchCreateChannelMembershipInput{} diff --git a/service/chime/api_op_BatchDeletePhoneNumber.go b/service/chime/api_op_BatchDeletePhoneNumber.go index 0642cfcce08..228ef32276c 100644 --- a/service/chime/api_op_BatchDeletePhoneNumber.go +++ b/service/chime/api_op_BatchDeletePhoneNumber.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves phone numbers into the Deletion queue. Phone numbers must be +// 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. +// 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_BatchSuspendUser.go b/service/chime/api_op_BatchSuspendUser.go index d3d5eea2d49..7be33d84fad 100644 --- a/service/chime/api_op_BatchSuspendUser.go +++ b/service/chime/api_op_BatchSuspendUser.go @@ -12,16 +12,21 @@ import ( ) // Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. 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. Users suspended from a Team account -// are disassociated from the account,but they can continue to use Amazon Chime as -// free users. To remove the suspension from suspended Team account users, invite -// them to the Team account again. You can use the InviteUsers action to do so. +// more information about different account types, see [Managing Your Amazon Chime Accounts]in the Amazon Chime +// Administration Guide. +// +// Users suspended from a Team account are disassociated from the account,but they +// can continue to use Amazon Chime as free users. To remove the suspension from +// suspended Team account users, invite them to the Team account again. You can +// use the InviteUsersaction to do so. +// // Users suspended from an EnterpriseLWA account are immediately signed out of // Amazon Chime and can no longer sign in. To remove the suspension from suspended -// EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out -// users without suspending them, use the LogoutUser action. +// EnterpriseLWA account users, use the BatchUnsuspendUser action. +// +// To sign out users without suspending them, use the LogoutUser action. +// +// [Managing Your Amazon Chime Accounts]: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html func (c *Client) BatchSuspendUser(ctx context.Context, params *BatchSuspendUserInput, optFns ...func(*Options)) (*BatchSuspendUserOutput, error) { if params == nil { params = &BatchSuspendUserInput{} @@ -54,9 +59,8 @@ type BatchSuspendUserInput struct { type BatchSuspendUserOutput struct { - // If the BatchSuspendUser action fails for one or more of the user IDs in the - // request, a list of the user IDs is returned, along with error codes and error - // messages. + // If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of + // the user IDs is returned, along with error codes and error messages. UserErrors []types.UserError // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_BatchUnsuspendUser.go b/service/chime/api_op_BatchUnsuspendUser.go index 84115379315..0f5783d0494 100644 --- a/service/chime/api_op_BatchUnsuspendUser.go +++ b/service/chime/api_op_BatchUnsuspendUser.go @@ -14,10 +14,13 @@ 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]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. +// +// [Managing Your Amazon Chime Accounts]: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html func (c *Client) BatchUnsuspendUser(ctx context.Context, params *BatchUnsuspendUserInput, optFns ...func(*Options)) (*BatchUnsuspendUserOutput, error) { if params == nil { params = &BatchUnsuspendUserInput{} @@ -50,9 +53,8 @@ type BatchUnsuspendUserInput struct { type BatchUnsuspendUserOutput struct { - // If the BatchUnsuspendUser action fails for one or more of the user IDs in the - // request, a list of the user IDs is returned, along with error codes and error - // messages. + // If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of + // the user IDs is returned, along with error codes and error messages. UserErrors []types.UserError // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_BatchUpdatePhoneNumber.go b/service/chime/api_op_BatchUpdatePhoneNumber.go index a9bacdbb783..feeb8c6f649 100644 --- a/service/chime/api_op_BatchUpdatePhoneNumber.go +++ b/service/chime/api_op_BatchUpdatePhoneNumber.go @@ -13,9 +13,12 @@ import ( // Updates phone number product types or calling names. You can update one // 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. +// 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. +// // Updates to outbound calling names can take up to 72 hours to complete. Pending // updates to outbound calling names must be complete before you can request // another update. diff --git a/service/chime/api_op_BatchUpdateUser.go b/service/chime/api_op_BatchUpdateUser.go index c15063ca80b..c4e0f0987c5 100644 --- a/service/chime/api_op_BatchUpdateUser.go +++ b/service/chime/api_op_BatchUpdateUser.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates user details within the UpdateUserRequestItem object for up to 20 users -// for the specified Amazon Chime account. Currently, only LicenseType updates are -// supported for this action. +// Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified +// Amazon Chime account. Currently, only LicenseType updates are supported for +// this action. func (c *Client) BatchUpdateUser(ctx context.Context, params *BatchUpdateUserInput, optFns ...func(*Options)) (*BatchUpdateUserOutput, error) { if params == nil { params = &BatchUpdateUserInput{} @@ -46,9 +46,8 @@ type BatchUpdateUserInput struct { type BatchUpdateUserOutput struct { - // If the BatchUpdateUser action fails for one or more of the user IDs in the - // request, a list of the user IDs is returned, along with error codes and error - // messages. + // If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of + // the user IDs is returned, along with error codes and error messages. UserErrors []types.UserError // Metadata pertaining to the operation's result. diff --git a/service/chime/api_op_CreateAccount.go b/service/chime/api_op_CreateAccount.go index 75049c33e86..a9eb61d566e 100644 --- a/service/chime/api_op_CreateAccount.go +++ b/service/chime/api_op_CreateAccount.go @@ -13,8 +13,9 @@ 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]in the Amazon Chime Administration Guide. +// +// [Managing Your Amazon Chime Accounts]: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html 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 f64ec2e8db8..c5a2d8c8d6d 100644 --- a/service/chime/api_op_CreateAppInstance.go +++ b/service/chime/api_op_CreateAppInstance.go @@ -13,16 +13,19 @@ import ( // 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. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// CreateAppInstance (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstance.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// behavior as described in the AWS API Standard. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateAppInstance], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateAppInstance in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateAppInstance]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstance.html func (c *Client) CreateAppInstance(ctx context.Context, params *CreateAppInstanceInput, optFns ...func(*Options)) (*CreateAppInstanceOutput, error) { if params == nil { params = &CreateAppInstanceInput{} diff --git a/service/chime/api_op_CreateAppInstanceAdmin.go b/service/chime/api_op_CreateAppInstanceAdmin.go index 66e455568e0..6601043ced7 100644 --- a/service/chime/api_op_CreateAppInstanceAdmin.go +++ b/service/chime/api_op_CreateAppInstanceAdmin.go @@ -12,19 +12,25 @@ import ( ) // Promotes an AppInstanceUser to an AppInstanceAdmin . The promoted user can -// perform the following actions. This API is is no longer supported and will not -// be updated. We recommend using the latest version, CreateAppInstanceAdmin (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceAdmin.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// perform the following actions. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateAppInstanceAdmin], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. +// // - ChannelModerator actions across all channels in the AppInstance . +// // - DeleteChannelMessage actions. // // Only an AppInstanceUser can be promoted to an AppInstanceAdmin role. // // Deprecated: Replaced by CreateAppInstanceAdmin in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateAppInstanceAdmin]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceAdmin.html func (c *Client) CreateAppInstanceAdmin(ctx context.Context, params *CreateAppInstanceAdminInput, optFns ...func(*Options)) (*CreateAppInstanceAdminOutput, error) { if params == nil { params = &CreateAppInstanceAdminInput{} diff --git a/service/chime/api_op_CreateAppInstanceUser.go b/service/chime/api_op_CreateAppInstanceUser.go index 8033bd50d87..e89a49169a2 100644 --- a/service/chime/api_op_CreateAppInstanceUser.go +++ b/service/chime/api_op_CreateAppInstanceUser.go @@ -12,16 +12,19 @@ import ( ) // Creates a user under an Amazon Chime AppInstance . The request consists of a -// unique appInstanceUserId and Name for that user. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// CreateAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// unique appInstanceUserId and Name for that user. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateAppInstanceUser in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_CreateAppInstanceUser.html func (c *Client) CreateAppInstanceUser(ctx context.Context, params *CreateAppInstanceUserInput, optFns ...func(*Options)) (*CreateAppInstanceUserOutput, error) { if params == nil { params = &CreateAppInstanceUserInput{} diff --git a/service/chime/api_op_CreateAttendee.go b/service/chime/api_op_CreateAttendee.go index 1f7c2b7a5e6..fce51c19889 100644 --- a/service/chime/api_op_CreateAttendee.go +++ b/service/chime/api_op_CreateAttendee.go @@ -11,17 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. This API is is no longer supported and -// will not be updated. We recommend using the latest version, CreateAttendee (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateAttendee.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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]in the Amazon Chime SDK Developer +// Guide. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateAttendee], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateAttendee in the Amazon Chime SDK Meetings // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html +// [CreateAttendee]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateAttendee.html 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 9f8d2afbaf1..b52ed64c4d9 100644 --- a/service/chime/api_op_CreateChannel.go +++ b/service/chime/api_op_CreateChannel.go @@ -11,18 +11,24 @@ 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, CreateChannel (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannel.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateChannel], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateChannel in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateChannel]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannel.html func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error) { if params == nil { params = &CreateChannelInput{} diff --git a/service/chime/api_op_CreateChannelBan.go b/service/chime/api_op_CreateChannelBan.go index 0fb159ad169..c8225b0946c 100644 --- a/service/chime/api_op_CreateChannelBan.go +++ b/service/chime/api_op_CreateChannelBan.go @@ -14,18 +14,24 @@ import ( // 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. This API is is no longer supported and will not be updated. We -// recommend using the latest version, CreateChannelBan (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelBan.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateChannelBan], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateChannelBan in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateChannelBan]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelBan.html 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 be30df059ab..b9239e967a1 100644 --- a/service/chime/api_op_CreateChannelMembership.go +++ b/service/chime/api_op_CreateChannelMembership.go @@ -13,28 +13,38 @@ 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 // // 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. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, CreateChannelMembership (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelMembership.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// of the user that makes the API call as the value in the header. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateChannelMembership], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateChannelMembership in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateChannelMembership]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelMembership.html func (c *Client) CreateChannelMembership(ctx context.Context, params *CreateChannelMembershipInput, optFns ...func(*Options)) (*CreateChannelMembershipOutput, error) { if params == nil { params = &CreateChannelMembershipInput{} diff --git a/service/chime/api_op_CreateChannelModerator.go b/service/chime/api_op_CreateChannelModerator.go index 5947d2f6f3b..bbd55baff97 100644 --- a/service/chime/api_op_CreateChannelModerator.go +++ b/service/chime/api_op_CreateChannelModerator.go @@ -12,23 +12,31 @@ import ( ) // 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. // // 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. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, CreateChannelModerator (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelModerator.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// of the user that makes the API call as the value in the header. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateChannelModerator], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateChannelModerator in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateChannelModerator]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelModerator.html 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 a8dbfaa693b..444ef870a77 100644 --- a/service/chime/api_op_CreateMediaCapturePipeline.go +++ b/service/chime/api_op_CreateMediaCapturePipeline.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a media capture pipeline. This API is is no longer supported and will -// not be updated. We recommend using the latest version, -// CreateMediaCapturePipeline (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_CreateMediaCapturePipeline) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Creates a media capture pipeline. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateMediaCapturePipeline], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateMediaCapturePipeline in the Amazon Chime SDK // Media Pipelines Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateMediaCapturePipeline]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_CreateMediaCapturePipeline func (c *Client) CreateMediaCapturePipeline(ctx context.Context, params *CreateMediaCapturePipelineInput, optFns ...func(*Options)) (*CreateMediaCapturePipelineOutput, error) { if params == nil { params = &CreateMediaCapturePipelineInput{} diff --git a/service/chime/api_op_CreateMeeting.go b/service/chime/api_op_CreateMeeting.go index 67b037005c9..bb57b45b8f6 100644 --- a/service/chime/api_op_CreateMeeting.go +++ b/service/chime/api_op_CreateMeeting.go @@ -12,18 +12,22 @@ 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-sdk/latest/dg/chime-sdk-meetings-regions.html) -// in the Amazon Chime SDK Developer Guide . For more information about the Amazon -// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. This API is is no longer supported and -// will not be updated. We recommend using the latest version, CreateMeeting (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// initial attendees. For more information about specifying media Regions, see [Amazon Chime SDK Media Regions]in +// the Amazon Chime SDK Developer Guide . For more information about the Amazon +// Chime SDK, see [Using the Amazon Chime SDK]in the Amazon Chime SDK Developer Guide. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateMeeting], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateMeeting in the Amazon Chime SDK Meetings Namespace +// +// [CreateMeeting]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Amazon Chime SDK Media Regions]: https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html func (c *Client) CreateMeeting(ctx context.Context, params *CreateMeetingInput, optFns ...func(*Options)) (*CreateMeetingOutput, error) { if params == nil { params = &CreateMeetingInput{} @@ -50,8 +54,9 @@ 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 , + // 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 . @@ -72,7 +77,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/chime/api_op_CreateMeetingDialOut.go b/service/chime/api_op_CreateMeetingDialOut.go index 379e512fbe6..67dada501e1 100644 --- a/service/chime/api_op_CreateMeetingDialOut.go +++ b/service/chime/api_op_CreateMeetingDialOut.go @@ -13,10 +13,13 @@ import ( // Uses the join token and call metadata in a meeting request (From number, To // number, and so forth) to initiate an outbound call to a public switched // telephone network (PSTN) and join them into a Chime meeting. Also ensures that -// the From number belongs to the customer. To play welcome audio or implement an -// interactive voice response (IVR), use the CreateSipMediaApplicationCall action -// with the corresponding SIP media application ID. This API is is not available in -// a dedicated namespace. +// the From number belongs to the customer. +// +// To play welcome audio or implement an interactive voice response (IVR), use the +// CreateSipMediaApplicationCall action with the corresponding SIP media +// application ID. +// +// This API is is not available in a dedicated namespace. func (c *Client) CreateMeetingDialOut(ctx context.Context, params *CreateMeetingDialOutInput, optFns ...func(*Options)) (*CreateMeetingDialOutOutput, error) { if params == nil { params = &CreateMeetingDialOutInput{} @@ -39,8 +42,10 @@ 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) - // action to get a join token. + // Token used by the Amazon Chime SDK attendee. Call the [CreateAttendee] action to get a join + // token. + // + // [CreateAttendee]: https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html // // This member is required. JoinToken *string diff --git a/service/chime/api_op_CreateMeetingWithAttendees.go b/service/chime/api_op_CreateMeetingWithAttendees.go index 5d927e20eaf..a1e0d8c36f4 100644 --- a/service/chime/api_op_CreateMeetingWithAttendees.go +++ b/service/chime/api_op_CreateMeetingWithAttendees.go @@ -11,21 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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-sdk/latest/dg/chime-sdk-meetings-regions.html) -// in the Amazon Chime SDK Developer Guide . For more information about the Amazon -// Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide . This API is is no longer supported and -// will not be updated. We recommend using the latest version, -// CreateMeetingWithAttendees (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeetingWithAttendees.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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]in the +// Amazon Chime SDK Developer Guide . For more information about the Amazon Chime +// SDK, see [Using the Amazon Chime SDK]in the Amazon Chime SDK Developer Guide . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateMeetingWithAttendees], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateMeetingWithAttendees in the Amazon Chime SDK // Meetings Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Amazon Chime SDK Media Regions]: https://docs.aws.amazon.com/chime-sdk/latest/dg/chime-sdk-meetings-regions.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html +// [CreateMeetingWithAttendees]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeetingWithAttendees.html func (c *Client) CreateMeetingWithAttendees(ctx context.Context, params *CreateMeetingWithAttendeesInput, optFns ...func(*Options)) (*CreateMeetingWithAttendeesOutput, error) { if params == nil { params = &CreateMeetingWithAttendeesInput{} @@ -55,8 +59,9 @@ type CreateMeetingWithAttendeesInput 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 , + // 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 . diff --git a/service/chime/api_op_CreateProxySession.go b/service/chime/api_op_CreateProxySession.go index b3c03f10108..8ef11ccf1bc 100644 --- a/service/chime/api_op_CreateProxySession.go +++ b/service/chime/api_op_CreateProxySession.go @@ -12,15 +12,19 @@ import ( ) // Creates a proxy session on the specified Amazon Chime Voice Connector for the -// specified participant phone numbers. This API is is no longer supported and will -// not be updated. We recommend using the latest version, CreateProxySession (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateProxySession.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// specified participant phone numbers. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateProxySession], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateProxySession in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateProxySession]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateProxySession.html func (c *Client) CreateProxySession(ctx context.Context, params *CreateProxySessionInput, optFns ...func(*Options)) (*CreateProxySessionOutput, error) { if params == nil { params = &CreateProxySessionInput{} diff --git a/service/chime/api_op_CreateSipMediaApplication.go b/service/chime/api_op_CreateSipMediaApplication.go index 8332de4f070..d581cfa0445 100644 --- a/service/chime/api_op_CreateSipMediaApplication.go +++ b/service/chime/api_op_CreateSipMediaApplication.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a SIP media application. This API is is no longer supported and will -// not be updated. We recommend using the latest version, CreateSipMediaApplication (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplication.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Creates a SIP media application. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateSipMediaApplication], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateSipMediaApplication in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateSipMediaApplication]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplication.html func (c *Client) CreateSipMediaApplication(ctx context.Context, params *CreateSipMediaApplicationInput, optFns ...func(*Options)) (*CreateSipMediaApplicationOutput, error) { if params == nil { params = &CreateSipMediaApplicationInput{} diff --git a/service/chime/api_op_CreateSipMediaApplicationCall.go b/service/chime/api_op_CreateSipMediaApplicationCall.go index 6cbabc65821..8c3d6148093 100644 --- a/service/chime/api_op_CreateSipMediaApplicationCall.go +++ b/service/chime/api_op_CreateSipMediaApplicationCall.go @@ -12,16 +12,19 @@ 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 -// . This API is is no longer supported and will not be updated. We recommend using -// the latest version, CreateSipMediaApplicationCall (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplicationCall.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the request, and it invokes the endpoint of the specified sipMediaApplicationId . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateSipMediaApplicationCall], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateSipMediaApplicationCall in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateSipMediaApplicationCall]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipMediaApplicationCall.html 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 fa75df0659a..d8a3a87dd0b 100644 --- a/service/chime/api_op_CreateSipRule.go +++ b/service/chime/api_op_CreateSipRule.go @@ -12,14 +12,18 @@ import ( ) // Creates a SIP rule which can be used to run a SIP media application as a target -// for a specific trigger type. This API is is no longer supported and will not be -// updated. We recommend using the latest version, CreateSipRule (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipRule.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// for a specific trigger type. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateSipRule], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateSipRule in the Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateSipRule]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateSipRule.html func (c *Client) CreateSipRule(ctx context.Context, params *CreateSipRuleInput, optFns ...func(*Options)) (*CreateSipRuleOutput, error) { if params == nil { params = &CreateSipRuleInput{} diff --git a/service/chime/api_op_CreateVoiceConnector.go b/service/chime/api_op_CreateVoiceConnector.go index d4aa62caf86..9c0511e1a33 100644 --- a/service/chime/api_op_CreateVoiceConnector.go +++ b/service/chime/api_op_CreateVoiceConnector.go @@ -13,18 +13,23 @@ import ( // Creates an Amazon Chime Voice Connector under the administrator's AWS account. // You can choose to create an Amazon Chime Voice Connector in a specific AWS -// Region. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your -// Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure -// RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound -// calls are blocked. This API is is no longer supported and will not be updated. -// We recommend using the latest version, CreateVoiceConnector (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnector.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Region. +// +// Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for +// SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, +// and unencrypted outbound calls are blocked. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateVoiceConnector], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateVoiceConnector in the Amazon Chime SDK Voice // Namespace +// +// [CreateVoiceConnector]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnector.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) CreateVoiceConnector(ctx context.Context, params *CreateVoiceConnectorInput, optFns ...func(*Options)) (*CreateVoiceConnectorOutput, error) { if params == nil { params = &CreateVoiceConnectorInput{} @@ -52,7 +57,7 @@ type CreateVoiceConnectorInput struct { // This member is required. RequireEncryption *bool - // The AWS Region in which the Amazon Chime Voice Connector is created. Default + // The AWS Region in which the Amazon Chime Voice Connector is created. Default // value: us-east-1 . AwsRegion types.VoiceConnectorAwsRegion diff --git a/service/chime/api_op_CreateVoiceConnectorGroup.go b/service/chime/api_op_CreateVoiceConnectorGroup.go index b62716625da..cdf6a44e61a 100644 --- a/service/chime/api_op_CreateVoiceConnectorGroup.go +++ b/service/chime/api_op_CreateVoiceConnectorGroup.go @@ -13,18 +13,23 @@ import ( // Creates an Amazon Chime Voice Connector group under the administrator's AWS // account. You can associate Amazon Chime Voice Connectors with the Amazon Chime -// Voice Connector group by including VoiceConnectorItems in the request. You can -// include Amazon Chime Voice Connectors from different AWS Regions in your group. -// This creates a fault tolerant mechanism for fallback in case of availability -// events. This API is is no longer supported and will not be updated. We recommend -// using the latest version, CreateVoiceConnectorGroup (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnectorGroup.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Voice Connector group by including VoiceConnectorItems in the request. +// +// You can include Amazon Chime Voice Connectors from different AWS Regions in +// your group. This creates a fault tolerant mechanism for fallback in case of +// availability events. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [CreateVoiceConnectorGroup], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by CreateVoiceConnectorGroup in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [CreateVoiceConnectorGroup]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_CreateVoiceConnectorGroup.html func (c *Client) CreateVoiceConnectorGroup(ctx context.Context, params *CreateVoiceConnectorGroupInput, optFns ...func(*Options)) (*CreateVoiceConnectorGroupOutput, error) { if params == nil { params = &CreateVoiceConnectorGroupInput{} diff --git a/service/chime/api_op_DeleteAccount.go b/service/chime/api_op_DeleteAccount.go index 94117fbaa44..fd9ecdc16ab 100644 --- a/service/chime/api_op_DeleteAccount.go +++ b/service/chime/api_op_DeleteAccount.go @@ -11,13 +11,17 @@ import ( ) // Deletes the specified Amazon Chime account. You must suspend all users before -// deleting Team account. You can use the BatchSuspendUser action to dodo. For -// EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains -// for your Amazon Chime account before deletion. As soon as you release the -// domain, all users under that account are suspended. Deleted accounts appear in -// your Disabled accounts list for 90 days. To restore deleted account from your -// Disabled accounts list, you must contact AWS Support. After 90 days, deleted -// accounts are permanently removed from your Disabled accounts list. +// deleting Team account. You can use the BatchSuspendUser action to dodo. +// +// For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed +// domains for your Amazon Chime account before deletion. As soon as you release +// the domain, all users under that account are suspended. +// +// Deleted accounts appear in your Disabled accounts list for 90 days. To restore +// deleted account from your Disabled accounts list, you must contact AWS Support. +// +// After 90 days, deleted accounts are permanently removed from your Disabled +// accounts list. func (c *Client) DeleteAccount(ctx context.Context, params *DeleteAccountInput, optFns ...func(*Options)) (*DeleteAccountOutput, error) { if params == nil { params = &DeleteAccountInput{} diff --git a/service/chime/api_op_DeleteAppInstance.go b/service/chime/api_op_DeleteAppInstance.go index 17ffc037a10..05ca3f70bf2 100644 --- a/service/chime/api_op_DeleteAppInstance.go +++ b/service/chime/api_op_DeleteAppInstance.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AppInstance and all associated data asynchronously. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, DeleteAppInstance (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstance.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes an AppInstance and all associated data asynchronously. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteAppInstance], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteAppInstance in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteAppInstance]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstance.html func (c *Client) DeleteAppInstance(ctx context.Context, params *DeleteAppInstanceInput, optFns ...func(*Options)) (*DeleteAppInstanceOutput, error) { if params == nil { params = &DeleteAppInstanceInput{} diff --git a/service/chime/api_op_DeleteAppInstanceAdmin.go b/service/chime/api_op_DeleteAppInstanceAdmin.go index ddef546e7b6..759d6b9956d 100644 --- a/service/chime/api_op_DeleteAppInstanceAdmin.go +++ b/service/chime/api_op_DeleteAppInstanceAdmin.go @@ -11,15 +11,19 @@ import ( ) // Demotes an AppInstanceAdmin to an AppInstanceUser . This action does not delete -// the user. This API is is no longer supported and will not be updated. We -// recommend using the latest version, DeleteAppInstanceAdmin (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceAdmin.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the user. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteAppInstanceAdmin], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteAppInstanceAdmin in the Amazon Chime SDK Identity // Namespace +// +// [DeleteAppInstanceAdmin]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceAdmin.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) DeleteAppInstanceAdmin(ctx context.Context, params *DeleteAppInstanceAdminInput, optFns ...func(*Options)) (*DeleteAppInstanceAdminOutput, error) { if params == nil { params = &DeleteAppInstanceAdminInput{} diff --git a/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go b/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go index dc197383637..799e4fdf8d9 100644 --- a/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go +++ b/service/chime/api_op_DeleteAppInstanceStreamingConfigurations.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the streaming configurations of an AppInstance . This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// DeleteAppInstanceStreamingConfigurations (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceStreamingConfigurations.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes the streaming configurations of an AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteAppInstanceStreamingConfigurations], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteAppInstanceStreamingConfigurations in the Amazon // Chime SDK Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteAppInstanceStreamingConfigurations]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceStreamingConfigurations.html 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 541b67e77a4..9cd4570f6c2 100644 --- a/service/chime/api_op_DeleteAppInstanceUser.go +++ b/service/chime/api_op_DeleteAppInstanceUser.go @@ -10,15 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AppInstanceUser . This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes an AppInstanceUser . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteAppInstanceUser in the Amazon Chime SDK Identity // Namespace +// +// [DeleteAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DeleteAppInstanceUser.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html 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 ba4c38f808b..1daad4d4ac2 100644 --- a/service/chime/api_op_DeleteAttendee.go +++ b/service/chime/api_op_DeleteAttendee.go @@ -12,17 +12,21 @@ import ( // Deletes an attendee from the specified Amazon Chime SDK meeting and deletes // 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-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. This API is is no longer supported and -// will not be updated. We recommend using the latest version, DeleteAttendee (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteAttendee.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// meeting is deleted. For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the +// Amazon Chime SDK Developer Guide. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteAttendee], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteAttendee in the Amazon Chime SDK Meetings // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteAttendee]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteAttendee.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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 ef015257951..daadee3d2fb 100644 --- a/service/chime/api_op_DeleteChannel.go +++ b/service/chime/api_op_DeleteChannel.go @@ -11,17 +11,22 @@ 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. This API is is no longer supported and will not -// be updated. We recommend using the latest version, DeleteChannel (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannel.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteChannel], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteChannel in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteChannel]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannel.html 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_DeleteChannelBan.go b/service/chime/api_op_DeleteChannelBan.go index 8a8c9f2bcfb..bf7f904506c 100644 --- a/service/chime/api_op_DeleteChannelBan.go +++ b/service/chime/api_op_DeleteChannelBan.go @@ -10,17 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a user from a channel's ban list. 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteChannelBan (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelBan.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Removes a user from a channel's ban list. +// +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteChannelBan], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteChannelBan in the Amazon Chime SDK Messaging // Namespace +// +// [DeleteChannelBan]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelBan.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) DeleteChannelBan(ctx context.Context, params *DeleteChannelBanInput, optFns ...func(*Options)) (*DeleteChannelBanOutput, error) { if params == nil { params = &DeleteChannelBanInput{} diff --git a/service/chime/api_op_DeleteChannelMembership.go b/service/chime/api_op_DeleteChannelMembership.go index 8048973fc13..bb9934d6587 100644 --- a/service/chime/api_op_DeleteChannelMembership.go +++ b/service/chime/api_op_DeleteChannelMembership.go @@ -10,17 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteChannelMembership (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMembership.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteChannelMembership], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteChannelMembership in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteChannelMembership]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMembership.html 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 14ed6a5044b..f4a37d06c94 100644 --- a/service/chime/api_op_DeleteChannelMessage.go +++ b/service/chime/api_op_DeleteChannelMessage.go @@ -12,17 +12,22 @@ 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteChannelMessage (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMessage.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteChannelMessage], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteChannelMessage in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteChannelMessage]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelMessage.html 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 01f42d4bfc0..0f686d98885 100644 --- a/service/chime/api_op_DeleteChannelModerator.go +++ b/service/chime/api_op_DeleteChannelModerator.go @@ -10,17 +10,22 @@ 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteChannelModerator (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelModerator.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteChannelModerator], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteChannelModerator in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteChannelModerator]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DeleteChannelModerator.html 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_DeleteMediaCapturePipeline.go b/service/chime/api_op_DeleteMediaCapturePipeline.go index 27258873c71..9041a1cf263 100644 --- a/service/chime/api_op_DeleteMediaCapturePipeline.go +++ b/service/chime/api_op_DeleteMediaCapturePipeline.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the media capture pipeline. This API is is no longer supported and will -// not be updated. We recommend using the latest version, -// DeleteMediaCapturePipeline (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_DeleteMediaCapturePipeline.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes the media capture pipeline. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteMediaCapturePipeline], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteMediaCapturePipeline in the Amazon Chime SDK // Media Pipelines Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteMediaCapturePipeline]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_DeleteMediaCapturePipeline.html func (c *Client) DeleteMediaCapturePipeline(ctx context.Context, params *DeleteMediaCapturePipelineInput, optFns ...func(*Options)) (*DeleteMediaCapturePipelineOutput, error) { if params == nil { params = &DeleteMediaCapturePipelineInput{} diff --git a/service/chime/api_op_DeleteMeeting.go b/service/chime/api_op_DeleteMeeting.go index ddd04ca7f1a..4da2bd65340 100644 --- a/service/chime/api_op_DeleteMeeting.go +++ b/service/chime/api_op_DeleteMeeting.go @@ -12,16 +12,20 @@ import ( // Deletes the specified Amazon Chime SDK meeting. The operation deletes all // attendees, disconnects all clients, and prevents new clients from joining the -// meeting. For more information about the Amazon Chime SDK, see Using the Amazon -// Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) in -// the Amazon Chime SDK Developer Guide. This API is is no longer supported and -// will not be updated. We recommend using the latest version, DeleteMeeting (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteMeeting.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// meeting. For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon +// Chime SDK Developer Guide. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteMeeting], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteMeeting in the Amazon Chime SDK Meetings Namespace +// +// [DeleteMeeting]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_DeleteMeeting.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html func (c *Client) DeleteMeeting(ctx context.Context, params *DeleteMeetingInput, optFns ...func(*Options)) (*DeleteMeetingOutput, error) { if params == nil { params = &DeleteMeetingInput{} diff --git a/service/chime/api_op_DeletePhoneNumber.go b/service/chime/api_op_DeletePhoneNumber.go index ea13a0003f5..dfd26509b9c 100644 --- a/service/chime/api_op_DeletePhoneNumber.go +++ b/service/chime/api_op_DeletePhoneNumber.go @@ -12,8 +12,10 @@ import ( // 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. +// 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 { params = &DeletePhoneNumberInput{} diff --git a/service/chime/api_op_DeleteProxySession.go b/service/chime/api_op_DeleteProxySession.go index cdd936f0d24..8fab20467ca 100644 --- a/service/chime/api_op_DeleteProxySession.go +++ b/service/chime/api_op_DeleteProxySession.go @@ -11,15 +11,19 @@ import ( ) // Deletes the specified proxy session from the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, DeleteProxySession (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteProxySession.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteProxySession], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteProxySession in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteProxySession]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteProxySession.html func (c *Client) DeleteProxySession(ctx context.Context, params *DeleteProxySessionInput, optFns ...func(*Options)) (*DeleteProxySessionOutput, error) { if params == nil { params = &DeleteProxySessionInput{} diff --git a/service/chime/api_op_DeleteSipMediaApplication.go b/service/chime/api_op_DeleteSipMediaApplication.go index 4b4c0969fd9..a79b0a21a34 100644 --- a/service/chime/api_op_DeleteSipMediaApplication.go +++ b/service/chime/api_op_DeleteSipMediaApplication.go @@ -10,15 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a SIP media application. This API is is no longer supported and will -// not be updated. We recommend using the latest version, DeleteSipMediaApplication (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipMediaApplication.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes a SIP media application. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteSipMediaApplication], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteSipMediaApplication in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteSipMediaApplication]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipMediaApplication.html func (c *Client) DeleteSipMediaApplication(ctx context.Context, params *DeleteSipMediaApplicationInput, optFns ...func(*Options)) (*DeleteSipMediaApplicationOutput, error) { if params == nil { params = &DeleteSipMediaApplicationInput{} diff --git a/service/chime/api_op_DeleteSipRule.go b/service/chime/api_op_DeleteSipRule.go index 94fb5ee5744..298081c644f 100644 --- a/service/chime/api_op_DeleteSipRule.go +++ b/service/chime/api_op_DeleteSipRule.go @@ -10,15 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a SIP rule. You must disable a SIP rule before you can delete it. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, DeleteSipRule (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipRule.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes a SIP rule. You must disable a SIP rule before you can delete it. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteSipRule], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteSipRule in the Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteSipRule]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteSipRule.html func (c *Client) DeleteSipRule(ctx context.Context, params *DeleteSipRuleInput, optFns ...func(*Options)) (*DeleteSipRuleOutput, error) { if params == nil { params = &DeleteSipRuleInput{} diff --git a/service/chime/api_op_DeleteVoiceConnector.go b/service/chime/api_op_DeleteVoiceConnector.go index 9185858f676..5132430c718 100644 --- a/service/chime/api_op_DeleteVoiceConnector.go +++ b/service/chime/api_op_DeleteVoiceConnector.go @@ -12,15 +12,19 @@ import ( // 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteVoiceConnector (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnector.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// before it can be deleted. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnector], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnector in the Amazon Chime SDK Voice // Namespace +// +// [DeleteVoiceConnector]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnector.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html 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_DeleteVoiceConnectorEmergencyCallingConfiguration.go b/service/chime/api_op_DeleteVoiceConnectorEmergencyCallingConfiguration.go index 87a29c3c650..53609f37b1c 100644 --- a/service/chime/api_op_DeleteVoiceConnectorEmergencyCallingConfiguration.go +++ b/service/chime/api_op_DeleteVoiceConnectorEmergencyCallingConfiguration.go @@ -11,16 +11,19 @@ import ( ) // Deletes the emergency calling configuration details from the specified Amazon -// Chime Voice Connector. This API is is no longer supported and will not be -// updated. We recommend using the latest version, -// DeleteVoiceConnectorEmergencyCallingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnectorEmergencyCallingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorEmergencyCallingConfiguration in // the Amazon Chime SDK Voice Namespace +// +// [DeleteVoiceConnectorEmergencyCallingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorEmergencyCallingConfiguration.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) DeleteVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *DeleteVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorEmergencyCallingConfigurationOutput, error) { if params == nil { params = &DeleteVoiceConnectorEmergencyCallingConfigurationInput{} diff --git a/service/chime/api_op_DeleteVoiceConnectorGroup.go b/service/chime/api_op_DeleteVoiceConnectorGroup.go index a4a885dcf04..95db532e3b9 100644 --- a/service/chime/api_op_DeleteVoiceConnectorGroup.go +++ b/service/chime/api_op_DeleteVoiceConnectorGroup.go @@ -12,15 +12,19 @@ import ( // Deletes the specified Amazon Chime Voice Connector group. Any // VoiceConnectorItems and phone numbers associated with the group must be removed -// before it can be deleted. This API is is no longer supported and will not be -// updated. We recommend using the latest version, DeleteVoiceConnectorGroup (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorGroup.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// before it can be deleted. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnectorGroup], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorGroup in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteVoiceConnectorGroup]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorGroup.html func (c *Client) DeleteVoiceConnectorGroup(ctx context.Context, params *DeleteVoiceConnectorGroupInput, optFns ...func(*Options)) (*DeleteVoiceConnectorGroupOutput, error) { if params == nil { params = &DeleteVoiceConnectorGroupInput{} diff --git a/service/chime/api_op_DeleteVoiceConnectorOrigination.go b/service/chime/api_op_DeleteVoiceConnectorOrigination.go index 523135e4f6c..2b22481e86d 100644 --- a/service/chime/api_op_DeleteVoiceConnectorOrigination.go +++ b/service/chime/api_op_DeleteVoiceConnectorOrigination.go @@ -10,18 +10,22 @@ 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. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, DeleteVoiceConnectorOrigination (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorOrigination.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnectorOrigination], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorOrigination in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteVoiceConnectorOrigination]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorOrigination.html 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_DeleteVoiceConnectorProxy.go b/service/chime/api_op_DeleteVoiceConnectorProxy.go index 60c2dc0a46a..b73c3f0eb6f 100644 --- a/service/chime/api_op_DeleteVoiceConnectorProxy.go +++ b/service/chime/api_op_DeleteVoiceConnectorProxy.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the proxy configuration from the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, DeleteVoiceProxy (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorProxy.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Deletes the proxy configuration from the specified Amazon Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceProxy], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorProxy in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteVoiceProxy]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorProxy.html func (c *Client) DeleteVoiceConnectorProxy(ctx context.Context, params *DeleteVoiceConnectorProxyInput, optFns ...func(*Options)) (*DeleteVoiceConnectorProxyOutput, error) { if params == nil { params = &DeleteVoiceConnectorProxyInput{} diff --git a/service/chime/api_op_DeleteVoiceConnectorStreamingConfiguration.go b/service/chime/api_op_DeleteVoiceConnectorStreamingConfiguration.go index e346b314588..8528dc8aee1 100644 --- a/service/chime/api_op_DeleteVoiceConnectorStreamingConfiguration.go +++ b/service/chime/api_op_DeleteVoiceConnectorStreamingConfiguration.go @@ -11,15 +11,19 @@ import ( ) // Deletes the streaming configuration for the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, DeleteVoiceConnectorStreamingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorStreamingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnectorStreamingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorStreamingConfiguration in the // Amazon Chime SDK Voice Namespace +// +// [DeleteVoiceConnectorStreamingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorStreamingConfiguration.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) DeleteVoiceConnectorStreamingConfiguration(ctx context.Context, params *DeleteVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*DeleteVoiceConnectorStreamingConfigurationOutput, error) { if params == nil { params = &DeleteVoiceConnectorStreamingConfigurationInput{} diff --git a/service/chime/api_op_DeleteVoiceConnectorTermination.go b/service/chime/api_op_DeleteVoiceConnectorTermination.go index c799efb3b65..121a0bf26a3 100644 --- a/service/chime/api_op_DeleteVoiceConnectorTermination.go +++ b/service/chime/api_op_DeleteVoiceConnectorTermination.go @@ -10,18 +10,22 @@ 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. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, DeleteVoiceConnectorTermination (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTermination.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnectorTermination], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorTermination in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteVoiceConnectorTermination]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTermination.html 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_DeleteVoiceConnectorTerminationCredentials.go b/service/chime/api_op_DeleteVoiceConnectorTerminationCredentials.go index a9a71e1e189..94ffbea0da6 100644 --- a/service/chime/api_op_DeleteVoiceConnectorTerminationCredentials.go +++ b/service/chime/api_op_DeleteVoiceConnectorTerminationCredentials.go @@ -11,16 +11,19 @@ import ( ) // Deletes the specified SIP credentials used by your equipment to authenticate -// during call termination. This API is is no longer supported and will not be -// updated. We recommend using the latest version, -// DeleteVoiceConnectorTerminationCredentials (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTerminationCredentials.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// during call termination. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DeleteVoiceConnectorTerminationCredentials], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DeleteVoiceConnectorTerminationCredentials in the // Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DeleteVoiceConnectorTerminationCredentials]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DeleteVoiceConnectorTerminationCredentials.html func (c *Client) DeleteVoiceConnectorTerminationCredentials(ctx context.Context, params *DeleteVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*DeleteVoiceConnectorTerminationCredentialsOutput, error) { if params == nil { params = &DeleteVoiceConnectorTerminationCredentialsInput{} diff --git a/service/chime/api_op_DescribeAppInstance.go b/service/chime/api_op_DescribeAppInstance.go index 2df46c50599..c28639aaaba 100644 --- a/service/chime/api_op_DescribeAppInstance.go +++ b/service/chime/api_op_DescribeAppInstance.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstance . This API is is no longer supported -// and will not be updated. We recommend using the latest version, -// DescribeAppInstance (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstance.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns the full details of an AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeAppInstance], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeAppInstance in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeAppInstance]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstance.html func (c *Client) DescribeAppInstance(ctx context.Context, params *DescribeAppInstanceInput, optFns ...func(*Options)) (*DescribeAppInstanceOutput, error) { if params == nil { params = &DescribeAppInstanceInput{} diff --git a/service/chime/api_op_DescribeAppInstanceAdmin.go b/service/chime/api_op_DescribeAppInstanceAdmin.go index e92854babcb..42460fbb161 100644 --- a/service/chime/api_op_DescribeAppInstanceAdmin.go +++ b/service/chime/api_op_DescribeAppInstanceAdmin.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceAdmin . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// DescribeAppInstanceAdmin (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceAdmin.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns the full details of an AppInstanceAdmin . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeAppInstanceAdmin], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeAppInstanceAdmin in the Amazon Chime SDK // Identity Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeAppInstanceAdmin]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceAdmin.html func (c *Client) DescribeAppInstanceAdmin(ctx context.Context, params *DescribeAppInstanceAdminInput, optFns ...func(*Options)) (*DescribeAppInstanceAdminOutput, error) { if params == nil { params = &DescribeAppInstanceAdminInput{} diff --git a/service/chime/api_op_DescribeAppInstanceUser.go b/service/chime/api_op_DescribeAppInstanceUser.go index 1ab4f1fe05d..ea0f17981fb 100644 --- a/service/chime/api_op_DescribeAppInstanceUser.go +++ b/service/chime/api_op_DescribeAppInstanceUser.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of an AppInstanceUser . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// DescribeAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns the full details of an AppInstanceUser . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeAppInstanceUser in the Amazon Chime SDK // Identity Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_DescribeAppInstanceUser.html func (c *Client) DescribeAppInstanceUser(ctx context.Context, params *DescribeAppInstanceUserInput, optFns ...func(*Options)) (*DescribeAppInstanceUserOutput, error) { if params == nil { params = &DescribeAppInstanceUserInput{} diff --git a/service/chime/api_op_DescribeChannel.go b/service/chime/api_op_DescribeChannel.go index 33aa23bff38..807a1a3830f 100644 --- a/service/chime/api_op_DescribeChannel.go +++ b/service/chime/api_op_DescribeChannel.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// DescribeChannel (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannel.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeChannel], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeChannel in the Amazon Chime SDK Messaging // Namespace +// +// [DescribeChannel]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannel.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error) { if params == nil { params = &DescribeChannelInput{} diff --git a/service/chime/api_op_DescribeChannelBan.go b/service/chime/api_op_DescribeChannelBan.go index 84bab69c8c1..10e97f90cf4 100644 --- a/service/chime/api_op_DescribeChannelBan.go +++ b/service/chime/api_op_DescribeChannelBan.go @@ -11,17 +11,22 @@ 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. This API is is no longer supported and will not -// be updated. We recommend using the latest version, DescribeChannelBan (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelBan.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeChannelBan], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeChannelBan in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeChannelBan]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelBan.html 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_DescribeChannelMembership.go b/service/chime/api_op_DescribeChannelMembership.go index 4eb9c78dde8..2f2fead0286 100644 --- a/service/chime/api_op_DescribeChannelMembership.go +++ b/service/chime/api_op_DescribeChannelMembership.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a user's channel membership. 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. This API is is no longer supported and -// will not be updated. We recommend using the latest version, -// DescribeChannelMembership (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembership.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns the full details of a user's channel membership. +// +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeChannelMembership], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeChannelMembership in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeChannelMembership]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembership.html func (c *Client) DescribeChannelMembership(ctx context.Context, params *DescribeChannelMembershipInput, optFns ...func(*Options)) (*DescribeChannelMembershipOutput, error) { if params == nil { params = &DescribeChannelMembershipInput{} diff --git a/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go b/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go index 8145e446589..3e1d692f5ac 100644 --- a/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go +++ b/service/chime/api_op_DescribeChannelMembershipForAppInstanceUser.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// AppInstanceUserArn of the user that makes the API call as the value in the -// header. This API is is no longer supported and will not be updated. We recommend -// using the latest version, DescribeChannelMembershipForAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembershipForAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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 AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeChannelMembershipForAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeChannelMembershipForAppInstanceUser in the // Amazon Chime SDK Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeChannelMembershipForAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelMembershipForAppInstanceUser.html func (c *Client) DescribeChannelMembershipForAppInstanceUser(ctx context.Context, params *DescribeChannelMembershipForAppInstanceUserInput, optFns ...func(*Options)) (*DescribeChannelMembershipForAppInstanceUserOutput, error) { if params == nil { params = &DescribeChannelMembershipForAppInstanceUserInput{} diff --git a/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go b/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go index 11fccc81017..1013d5f633e 100644 --- a/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go +++ b/service/chime/api_op_DescribeChannelModeratedByAppInstanceUser.go @@ -12,17 +12,22 @@ import ( ) // 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. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, DescribeChannelModeratedByAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModeratedByAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// . +// +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeChannelModeratedByAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeChannelModeratedByAppInstanceUser in the Amazon // Chime SDK Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DescribeChannelModeratedByAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModeratedByAppInstanceUser.html 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_DescribeChannelModerator.go b/service/chime/api_op_DescribeChannelModerator.go index 16b8298a252..3cb8d528f75 100644 --- a/service/chime/api_op_DescribeChannelModerator.go +++ b/service/chime/api_op_DescribeChannelModerator.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a single ChannelModerator. 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. This API is is no longer supported and -// will not be updated. We recommend using the latest version, -// DescribeChannelModerator (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModerator.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns the full details of a single ChannelModerator. +// +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DescribeChannelModerator], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DescribeChannelModerator in the Amazon Chime SDK // Messaging Namespace +// +// [DescribeChannelModerator]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_DescribeChannelModerator.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) DescribeChannelModerator(ctx context.Context, params *DescribeChannelModeratorInput, optFns ...func(*Options)) (*DescribeChannelModeratorOutput, error) { if params == nil { params = &DescribeChannelModeratorInput{} diff --git a/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnector.go b/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnector.go index 4fb11cad33f..02b6cd8dc38 100644 --- a/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnector.go +++ b/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnector.go @@ -12,15 +12,19 @@ import ( ) // Disassociates the specified phone numbers from the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, DisassociatePhoneNumbersFromVoiceConnector (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DisassociatePhoneNumbersFromVoiceConnector], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DisassociatePhoneNumbersFromVoiceConnector in the // Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DisassociatePhoneNumbersFromVoiceConnector]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnector.html func (c *Client) DisassociatePhoneNumbersFromVoiceConnector(ctx context.Context, params *DisassociatePhoneNumbersFromVoiceConnectorInput, optFns ...func(*Options)) (*DisassociatePhoneNumbersFromVoiceConnectorOutput, error) { if params == nil { params = &DisassociatePhoneNumbersFromVoiceConnectorInput{} diff --git a/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go b/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go index 0105a2bfff3..a746178c4c1 100644 --- a/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go +++ b/service/chime/api_op_DisassociatePhoneNumbersFromVoiceConnectorGroup.go @@ -12,16 +12,19 @@ import ( ) // Disassociates the specified phone numbers from the specified Amazon Chime Voice -// Connector group. This API is is no longer supported and will not be updated. We -// recommend using the latest version, -// DisassociatePhoneNumbersFromVoiceConnectorGroup (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector group. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [DisassociatePhoneNumbersFromVoiceConnectorGroup], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by DisassociatePhoneNumbersFromVoiceConnectorGroup in the // Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [DisassociatePhoneNumbersFromVoiceConnectorGroup]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_DisassociatePhoneNumbersFromVoiceConnectorGroup.html func (c *Client) DisassociatePhoneNumbersFromVoiceConnectorGroup(ctx context.Context, params *DisassociatePhoneNumbersFromVoiceConnectorGroupInput, optFns ...func(*Options)) (*DisassociatePhoneNumbersFromVoiceConnectorGroupOutput, error) { if params == nil { params = &DisassociatePhoneNumbersFromVoiceConnectorGroupInput{} diff --git a/service/chime/api_op_GetAccountSettings.go b/service/chime/api_op_GetAccountSettings.go index 3d5733aa5b2..2a17842e884 100644 --- a/service/chime/api_op_GetAccountSettings.go +++ b/service/chime/api_op_GetAccountSettings.go @@ -13,8 +13,9 @@ 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]in the Amazon Chime Administration Guide. +// +// [Use the Policies Page]: https://docs.aws.amazon.com/chime/latest/ag/policies.html 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 7e074f9d465..05e3f7072bd 100644 --- a/service/chime/api_op_GetAppInstanceRetentionSettings.go +++ b/service/chime/api_op_GetAppInstanceRetentionSettings.go @@ -12,16 +12,19 @@ import ( "time" ) -// Gets the retention settings for an AppInstance . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// GetMessagingRetentionSettings (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_GetAppInstanceRetentionSettings.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Gets the retention settings for an AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetMessagingRetentionSettings], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetAppInstanceRetentionSettings in the Amazon Chime SDK // Identity Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetMessagingRetentionSettings]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_GetAppInstanceRetentionSettings.html func (c *Client) GetAppInstanceRetentionSettings(ctx context.Context, params *GetAppInstanceRetentionSettingsInput, optFns ...func(*Options)) (*GetAppInstanceRetentionSettingsOutput, error) { if params == nil { params = &GetAppInstanceRetentionSettingsInput{} diff --git a/service/chime/api_op_GetAppInstanceStreamingConfigurations.go b/service/chime/api_op_GetAppInstanceStreamingConfigurations.go index 395c9fc4667..67331e54f29 100644 --- a/service/chime/api_op_GetAppInstanceStreamingConfigurations.go +++ b/service/chime/api_op_GetAppInstanceStreamingConfigurations.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the streaming settings for an AppInstance . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// GetMessagingStreamingConfigurations (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingStreamingConfigurations.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Gets the streaming settings for an AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetMessagingStreamingConfigurations], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetAppInstanceStreamingConfigurations in the Amazon // Chime SDK Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetMessagingStreamingConfigurations]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingStreamingConfigurations.html func (c *Client) GetAppInstanceStreamingConfigurations(ctx context.Context, params *GetAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*GetAppInstanceStreamingConfigurationsOutput, error) { if params == nil { params = &GetAppInstanceStreamingConfigurationsInput{} diff --git a/service/chime/api_op_GetAttendee.go b/service/chime/api_op_GetAttendee.go index b94116744dd..b67c779d02d 100644 --- a/service/chime/api_op_GetAttendee.go +++ b/service/chime/api_op_GetAttendee.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the Amazon Chime SDK attendee details for a specified meeting ID and -// attendee ID. For more information about the Amazon Chime SDK, see Using the -// Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. This API is is no longer supported and -// will not be updated. We recommend using the latest version, GetAttendee (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetAttendee.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Gets the Amazon Chime SDK attendee details for a specified meeting ID and +// +// attendee ID. For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon +// Chime SDK Developer Guide. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetAttendee], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetAttendee in the Amazon Chime SDK Meetings Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html +// [GetAttendee]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetAttendee.html func (c *Client) GetAttendee(ctx context.Context, params *GetAttendeeInput, optFns ...func(*Options)) (*GetAttendeeOutput, error) { if params == nil { params = &GetAttendeeInput{} diff --git a/service/chime/api_op_GetChannelMessage.go b/service/chime/api_op_GetChannelMessage.go index cc3dbfb8f77..3fb9045f093 100644 --- a/service/chime/api_op_GetChannelMessage.go +++ b/service/chime/api_op_GetChannelMessage.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the full details of a channel 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. This API is is no longer supported and will not -// be updated. We recommend using the latest version, GetChannelMessage (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetChannelMessage.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Gets the full details of a channel 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetChannelMessage], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetChannelMessage in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetChannelMessage]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetChannelMessage.html func (c *Client) GetChannelMessage(ctx context.Context, params *GetChannelMessageInput, optFns ...func(*Options)) (*GetChannelMessageOutput, error) { if params == nil { params = &GetChannelMessageInput{} diff --git a/service/chime/api_op_GetMediaCapturePipeline.go b/service/chime/api_op_GetMediaCapturePipeline.go index ae414b1cbdf..ff3014a926c 100644 --- a/service/chime/api_op_GetMediaCapturePipeline.go +++ b/service/chime/api_op_GetMediaCapturePipeline.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets an existing media capture pipeline. This API is is no longer supported and -// will not be updated. We recommend using the latest version, -// GetMediaCapturePipeline (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_GetMediaCapturePipeline.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Gets an existing media capture pipeline. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetMediaCapturePipeline], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetMediaCapturePipeline in the Amazon Chime SDK Media // Pipelines Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetMediaCapturePipeline]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_GetMediaCapturePipeline.html func (c *Client) GetMediaCapturePipeline(ctx context.Context, params *GetMediaCapturePipelineInput, optFns ...func(*Options)) (*GetMediaCapturePipelineOutput, error) { if params == nil { params = &GetMediaCapturePipelineInput{} diff --git a/service/chime/api_op_GetMeeting.go b/service/chime/api_op_GetMeeting.go index 9b8c4cd9a22..7dacb2d7ec0 100644 --- a/service/chime/api_op_GetMeeting.go +++ b/service/chime/api_op_GetMeeting.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is is no longer supported and will not be updated. We recommend using -// the latest version, GetMeeting (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK 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-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide . +// This API is is no longer supported and will not be updated. We recommend using +// +// the latest version, [GetMeeting], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK 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]in the Amazon Chime SDK +// Developer Guide . // // Deprecated: Replaced by GetMeeting in the Amazon Chime SDK Meetings Namespace +// +// [GetMeeting]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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_GetMessagingSessionEndpoint.go b/service/chime/api_op_GetMessagingSessionEndpoint.go index 62e3c96d6ba..d41adb6f5b7 100644 --- a/service/chime/api_op_GetMessagingSessionEndpoint.go +++ b/service/chime/api_op_GetMessagingSessionEndpoint.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The details of the endpoint for the messaging session. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// GetMessagingSessionEndpoint (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingSessionEndpoint.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// The details of the endpoint for the messaging session. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetMessagingSessionEndpoint], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetMessagingSessionEndpoint in the Amazon Chime SDK // Messaging Namespace +// +// [GetMessagingSessionEndpoint]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_GetMessagingSessionEndpoint.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) GetMessagingSessionEndpoint(ctx context.Context, params *GetMessagingSessionEndpointInput, optFns ...func(*Options)) (*GetMessagingSessionEndpointOutput, error) { if params == nil { params = &GetMessagingSessionEndpointInput{} diff --git a/service/chime/api_op_GetProxySession.go b/service/chime/api_op_GetProxySession.go index d83ac15a5f0..8ca155f3fc4 100644 --- a/service/chime/api_op_GetProxySession.go +++ b/service/chime/api_op_GetProxySession.go @@ -12,14 +12,18 @@ import ( ) // Gets the specified proxy session details for the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, GetProxySession (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetProxySession.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetProxySession], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetProxySession in the Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetProxySession]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetProxySession.html func (c *Client) GetProxySession(ctx context.Context, params *GetProxySessionInput, optFns ...func(*Options)) (*GetProxySessionOutput, error) { if params == nil { params = &GetProxySessionInput{} diff --git a/service/chime/api_op_GetRetentionSettings.go b/service/chime/api_op_GetRetentionSettings.go index 7f0cf78fdc4..a36953104bb 100644 --- a/service/chime/api_op_GetRetentionSettings.go +++ b/service/chime/api_op_GetRetentionSettings.go @@ -12,10 +12,12 @@ import ( "time" ) -// Gets the retention settings for the specified Amazon Chime Enterprise account. -// 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. +// Gets the retention settings for the specified Amazon Chime Enterprise account. +// +// For more information about retention settings, see [Managing Chat Retention Policies]in the Amazon Chime +// Administration Guide. +// +// [Managing Chat Retention Policies]: https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html func (c *Client) GetRetentionSettings(ctx context.Context, params *GetRetentionSettingsInput, optFns ...func(*Options)) (*GetRetentionSettingsOutput, error) { if params == nil { params = &GetRetentionSettingsInput{} diff --git a/service/chime/api_op_GetSipMediaApplication.go b/service/chime/api_op_GetSipMediaApplication.go index f27c53fd357..524a84e542e 100644 --- a/service/chime/api_op_GetSipMediaApplication.go +++ b/service/chime/api_op_GetSipMediaApplication.go @@ -12,15 +12,19 @@ import ( ) // Retrieves the information for a SIP media application, including name, AWS -// Region, and endpoints. This API is is no longer supported and will not be -// updated. We recommend using the latest version, GetSipMediaApplication (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplication.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Region, and endpoints. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetSipMediaApplication], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetSipMediaApplication in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetSipMediaApplication]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplication.html func (c *Client) GetSipMediaApplication(ctx context.Context, params *GetSipMediaApplicationInput, optFns ...func(*Options)) (*GetSipMediaApplicationOutput, error) { if params == nil { params = &GetSipMediaApplicationInput{} diff --git a/service/chime/api_op_GetSipMediaApplicationLoggingConfiguration.go b/service/chime/api_op_GetSipMediaApplicationLoggingConfiguration.go index 313d3b1681c..fe943770bb6 100644 --- a/service/chime/api_op_GetSipMediaApplicationLoggingConfiguration.go +++ b/service/chime/api_op_GetSipMediaApplicationLoggingConfiguration.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the logging configuration for the specified SIP media application. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, GetSipMediaApplicationLoggingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplicationLoggingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns the logging configuration for the specified SIP media application. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetSipMediaApplicationLoggingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetSipMediaApplicationLoggingConfiguration in the // Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetSipMediaApplicationLoggingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipMediaApplicationLoggingConfiguration.html func (c *Client) GetSipMediaApplicationLoggingConfiguration(ctx context.Context, params *GetSipMediaApplicationLoggingConfigurationInput, optFns ...func(*Options)) (*GetSipMediaApplicationLoggingConfigurationOutput, error) { if params == nil { params = &GetSipMediaApplicationLoggingConfigurationInput{} diff --git a/service/chime/api_op_GetSipRule.go b/service/chime/api_op_GetSipRule.go index 1dc5edee5c2..a79f635af79 100644 --- a/service/chime/api_op_GetSipRule.go +++ b/service/chime/api_op_GetSipRule.go @@ -12,14 +12,18 @@ import ( ) // Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and -// target endpoints. This API is is no longer supported and will not be updated. We -// recommend using the latest version, GetSipRule (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipRule.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// target endpoints. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetSipRule], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetSipRule in the Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetSipRule]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetSipRule.html func (c *Client) GetSipRule(ctx context.Context, params *GetSipRuleInput, optFns ...func(*Options)) (*GetSipRuleOutput, error) { if params == nil { params = &GetSipRuleInput{} diff --git a/service/chime/api_op_GetUser.go b/service/chime/api_op_GetUser.go index 28d989a1447..d78b6fb3d88 100644 --- a/service/chime/api_op_GetUser.go +++ b/service/chime/api_op_GetUser.go @@ -12,9 +12,10 @@ 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. +// 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. 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_GetVoiceConnector.go b/service/chime/api_op_GetVoiceConnector.go index 6bf7e728c4f..3442155c615 100644 --- a/service/chime/api_op_GetVoiceConnector.go +++ b/service/chime/api_op_GetVoiceConnector.go @@ -12,16 +12,19 @@ import ( ) // Retrieves details for the specified Amazon Chime Voice Connector, such as -// timestamps,name, outbound host, and encryption requirements. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// GetVoiceConnector (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnector.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// timestamps,name, outbound host, and encryption requirements. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnector], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnector in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetVoiceConnector]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnector.html func (c *Client) GetVoiceConnector(ctx context.Context, params *GetVoiceConnectorInput, optFns ...func(*Options)) (*GetVoiceConnectorOutput, error) { if params == nil { params = &GetVoiceConnectorInput{} diff --git a/service/chime/api_op_GetVoiceConnectorEmergencyCallingConfiguration.go b/service/chime/api_op_GetVoiceConnectorEmergencyCallingConfiguration.go index 3b9ea2b0097..060574c6fb2 100644 --- a/service/chime/api_op_GetVoiceConnectorEmergencyCallingConfiguration.go +++ b/service/chime/api_op_GetVoiceConnectorEmergencyCallingConfiguration.go @@ -12,16 +12,19 @@ import ( ) // Gets the emergency calling configuration details for the specified Amazon Chime -// Voice Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, -// GetVoiceConnectorEmergencyCallingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorEmergencyCallingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorEmergencyCallingConfiguration in the // Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetVoiceConnectorEmergencyCallingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorEmergencyCallingConfiguration.html func (c *Client) GetVoiceConnectorEmergencyCallingConfiguration(ctx context.Context, params *GetVoiceConnectorEmergencyCallingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorEmergencyCallingConfigurationOutput, error) { if params == nil { params = &GetVoiceConnectorEmergencyCallingConfigurationInput{} diff --git a/service/chime/api_op_GetVoiceConnectorGroup.go b/service/chime/api_op_GetVoiceConnectorGroup.go index c564978a72b..4facc96f89e 100644 --- a/service/chime/api_op_GetVoiceConnectorGroup.go +++ b/service/chime/api_op_GetVoiceConnectorGroup.go @@ -11,17 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves details for the specified Amazon Chime Voice Connector group, such as -// timestamps,name, and associated VoiceConnectorItems . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// GetVoiceConnectorGroup (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorGroup.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Retrieves details for the specified Amazon Chime Voice Connector group, such +// +// as timestamps,name, and associated VoiceConnectorItems . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorGroup], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorGroup in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetVoiceConnectorGroup]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorGroup.html 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 693df5878c9..95d9d60da9e 100644 --- a/service/chime/api_op_GetVoiceConnectorLoggingConfiguration.go +++ b/service/chime/api_op_GetVoiceConnectorLoggingConfiguration.go @@ -13,16 +13,19 @@ import ( // 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, -// GetVoiceConnectorLoggingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorLoggingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Amazon CloudWatch Logs. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorLoggingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorLoggingConfiguration in the Amazon // Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetVoiceConnectorLoggingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorLoggingConfiguration.html 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_GetVoiceConnectorOrigination.go b/service/chime/api_op_GetVoiceConnectorOrigination.go index c5a63782572..0b78f96fa16 100644 --- a/service/chime/api_op_GetVoiceConnectorOrigination.go +++ b/service/chime/api_op_GetVoiceConnectorOrigination.go @@ -12,15 +12,19 @@ import ( ) // Retrieves origination setting details for the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, GetVoiceConnectorOrigination (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorOrigination.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorOrigination], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorOrigination in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetVoiceConnectorOrigination]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorOrigination.html func (c *Client) GetVoiceConnectorOrigination(ctx context.Context, params *GetVoiceConnectorOriginationInput, optFns ...func(*Options)) (*GetVoiceConnectorOriginationOutput, error) { if params == nil { params = &GetVoiceConnectorOriginationInput{} diff --git a/service/chime/api_op_GetVoiceConnectorProxy.go b/service/chime/api_op_GetVoiceConnectorProxy.go index 00cad603cdf..fac9aa2e07a 100644 --- a/service/chime/api_op_GetVoiceConnectorProxy.go +++ b/service/chime/api_op_GetVoiceConnectorProxy.go @@ -12,15 +12,19 @@ import ( ) // Gets the proxy configuration details for the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, GetVoiceConnectorProxy (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorProxy.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorProxy], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorProxy in the Amazon Chime SDK Voice // Namespace +// +// [GetVoiceConnectorProxy]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorProxy.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) GetVoiceConnectorProxy(ctx context.Context, params *GetVoiceConnectorProxyInput, optFns ...func(*Options)) (*GetVoiceConnectorProxyOutput, error) { if params == nil { params = &GetVoiceConnectorProxyInput{} diff --git a/service/chime/api_op_GetVoiceConnectorStreamingConfiguration.go b/service/chime/api_op_GetVoiceConnectorStreamingConfiguration.go index cc519abdc45..8d27b1757ae 100644 --- a/service/chime/api_op_GetVoiceConnectorStreamingConfiguration.go +++ b/service/chime/api_op_GetVoiceConnectorStreamingConfiguration.go @@ -14,15 +14,19 @@ import ( // Retrieves the streaming configuration details for the specified Amazon Chime // 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. This API is is no longer supported and will not be updated. We recommend -// using the latest version, GetVoiceConnectorStreamingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorStreamingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// data. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorStreamingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorStreamingConfiguration in the Amazon // Chime SDK Voice Namespace +// +// [GetVoiceConnectorStreamingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorStreamingConfiguration.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) GetVoiceConnectorStreamingConfiguration(ctx context.Context, params *GetVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*GetVoiceConnectorStreamingConfigurationOutput, error) { if params == nil { params = &GetVoiceConnectorStreamingConfigurationInput{} diff --git a/service/chime/api_op_GetVoiceConnectorTermination.go b/service/chime/api_op_GetVoiceConnectorTermination.go index 8e321ad7433..09f6a5a88a2 100644 --- a/service/chime/api_op_GetVoiceConnectorTermination.go +++ b/service/chime/api_op_GetVoiceConnectorTermination.go @@ -12,15 +12,19 @@ import ( ) // Retrieves termination setting details for the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, GetVoiceConnectorTermination (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTermination.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [GetVoiceConnectorTermination], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by GetVoiceConnectorTermination in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [GetVoiceConnectorTermination]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTermination.html func (c *Client) GetVoiceConnectorTermination(ctx context.Context, params *GetVoiceConnectorTerminationInput, optFns ...func(*Options)) (*GetVoiceConnectorTerminationOutput, error) { if params == nil { params = &GetVoiceConnectorTerminationInput{} diff --git a/service/chime/api_op_GetVoiceConnectorTerminationHealth.go b/service/chime/api_op_GetVoiceConnectorTerminationHealth.go index 8a3e18b7e28..37f4682abbf 100644 --- a/service/chime/api_op_GetVoiceConnectorTerminationHealth.go +++ b/service/chime/api_op_GetVoiceConnectorTerminationHealth.go @@ -11,17 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is is no longer supported and will not be updated. We recommend using -// the latest version, GetVoiceConnectorTerminationHealth (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTerminationHealth.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. Retrieves information about the last -// time a SIP OPTIONS ping was received from your SIP infrastructure for the -// specified Amazon Chime Voice Connector. +// This API is is no longer supported and will not be updated. We recommend using +// +// the latest version, [GetVoiceConnectorTerminationHealth], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. +// +// Retrieves information about the last time a SIP OPTIONS ping was received from +// your SIP infrastructure for the specified Amazon Chime Voice Connector. // // Deprecated: Replaced by GetVoiceConnectorTerminationHealth in the Amazon Chime // SDK Voice Namespace +// +// [GetVoiceConnectorTerminationHealth]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_GetVoiceConnectorTerminationHealth.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) GetVoiceConnectorTerminationHealth(ctx context.Context, params *GetVoiceConnectorTerminationHealthInput, optFns ...func(*Options)) (*GetVoiceConnectorTerminationHealthOutput, error) { if params == nil { params = &GetVoiceConnectorTerminationHealthInput{} diff --git a/service/chime/api_op_ListAppInstanceAdmins.go b/service/chime/api_op_ListAppInstanceAdmins.go index 063aa932c29..06917eaa12f 100644 --- a/service/chime/api_op_ListAppInstanceAdmins.go +++ b/service/chime/api_op_ListAppInstanceAdmins.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the administrators in the AppInstance . This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// ListAppInstanceAdmins (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstanceAdmins.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns a list of the administrators in the AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListAppInstanceAdmins], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListAppInstanceAdmins in the Amazon Chime SDK Identity // Namespace +// +// [ListAppInstanceAdmins]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstanceAdmins.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) ListAppInstanceAdmins(ctx context.Context, params *ListAppInstanceAdminsInput, optFns ...func(*Options)) (*ListAppInstanceAdminsOutput, error) { if params == nil { params = &ListAppInstanceAdminsInput{} diff --git a/service/chime/api_op_ListAppInstanceUsers.go b/service/chime/api_op_ListAppInstanceUsers.go index ef5c588beea..e8556db6c54 100644 --- a/service/chime/api_op_ListAppInstanceUsers.go +++ b/service/chime/api_op_ListAppInstanceUsers.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all AppInstanceUsers created under a single AppInstance . This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// ListAppInstanceUsers (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstanceUsers.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// List all AppInstanceUsers created under a single AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListAppInstanceUsers], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListAppInstanceUsers in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListAppInstanceUsers]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstanceUsers.html func (c *Client) ListAppInstanceUsers(ctx context.Context, params *ListAppInstanceUsersInput, optFns ...func(*Options)) (*ListAppInstanceUsersOutput, error) { if params == nil { params = &ListAppInstanceUsersInput{} diff --git a/service/chime/api_op_ListAppInstances.go b/service/chime/api_op_ListAppInstances.go index 0fc3334f222..532447b5dd6 100644 --- a/service/chime/api_op_ListAppInstances.go +++ b/service/chime/api_op_ListAppInstances.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all Amazon Chime AppInstance s created under a single AWS account. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, ListAppInstances (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstances.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists all Amazon Chime AppInstance s created under a single AWS account. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListAppInstances], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListAppInstances in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListAppInstances]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_ListAppInstances.html func (c *Client) ListAppInstances(ctx context.Context, params *ListAppInstancesInput, optFns ...func(*Options)) (*ListAppInstancesOutput, error) { if params == nil { params = &ListAppInstancesInput{} diff --git a/service/chime/api_op_ListAttendeeTags.go b/service/chime/api_op_ListAttendeeTags.go index aba9b614db0..41ed56c59c6 100644 --- a/service/chime/api_op_ListAttendeeTags.go +++ b/service/chime/api_op_ListAttendeeTags.go @@ -12,6 +12,7 @@ import ( ) // Lists the tags applied to an Amazon Chime SDK attendee resource. +// // ListAttendeeTags is not supported in the Amazon Chime SDK Meetings Namespace. // Update your application to remove calls to this API. // diff --git a/service/chime/api_op_ListAttendees.go b/service/chime/api_op_ListAttendees.go index d014bc45a14..d2e86d96681 100644 --- a/service/chime/api_op_ListAttendees.go +++ b/service/chime/api_op_ListAttendees.go @@ -11,16 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. This API is is no longer supported and -// will not be updated. We recommend using the latest version, ListAttendees (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListAttendees.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists the attendees for the specified Amazon Chime SDK meeting. For more +// +// information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon Chime SDK Developer +// Guide. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListAttendees], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListAttendees in the Amazon Chime SDK Meetings Namespace +// +// [ListAttendees]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListAttendees.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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_ListChannelBans.go b/service/chime/api_op_ListChannelBans.go index 8b32b70693a..67c6cf9f4e6 100644 --- a/service/chime/api_op_ListChannelBans.go +++ b/service/chime/api_op_ListChannelBans.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the users banned from a particular 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. This API is is no longer supported and -// will not be updated. We recommend using the latest version, ListChannelBans (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelBans.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists all the users banned from a particular 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannelBans], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelBans in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListChannelBans]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelBans.html func (c *Client) ListChannelBans(ctx context.Context, params *ListChannelBansInput, optFns ...func(*Options)) (*ListChannelBansOutput, error) { if params == nil { params = &ListChannelBansInput{} diff --git a/service/chime/api_op_ListChannelMemberships.go b/service/chime/api_op_ListChannelMemberships.go index 1044cfa4459..4fabaaafd32 100644 --- a/service/chime/api_op_ListChannelMemberships.go +++ b/service/chime/api_op_ListChannelMemberships.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all channel memberships in 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. This API is is no longer supported and will not -// be updated. We recommend using the latest version, ListChannelMemberships (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMemberships.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists all channel memberships in 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannelMemberships], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelMemberships in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListChannelMemberships]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMemberships.html func (c *Client) ListChannelMemberships(ctx context.Context, params *ListChannelMembershipsInput, optFns ...func(*Options)) (*ListChannelMembershipsOutput, error) { if params == nil { params = &ListChannelMembershipsInput{} diff --git a/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go b/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go index 454831c9bee..76f7cd05133 100644 --- a/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go +++ b/service/chime/api_op_ListChannelMembershipsForAppInstanceUser.go @@ -11,19 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all channels that a particular AppInstanceUser 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 AppInstanceUserArn of -// the user that makes the API call as the value in the header. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// ListChannelMembershipsForAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists all channels that a particular AppInstanceUser 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 AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannelMembershipsForAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelMembershipsForAppInstanceUser in the Amazon // Chime SDK Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListChannelMembershipsForAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html func (c *Client) ListChannelMembershipsForAppInstanceUser(ctx context.Context, params *ListChannelMembershipsForAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelMembershipsForAppInstanceUserOutput, error) { if params == nil { params = &ListChannelMembershipsForAppInstanceUserInput{} diff --git a/service/chime/api_op_ListChannelMessages.go b/service/chime/api_op_ListChannelMessages.go index c1dd106ab64..1dc81fe20f2 100644 --- a/service/chime/api_op_ListChannelMessages.go +++ b/service/chime/api_op_ListChannelMessages.go @@ -13,20 +13,27 @@ import ( ) // 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. This API is is no longer supported and -// will not be updated. We recommend using the latest version, ListChannelMessages (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMessages.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// . 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannelMessages], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelMessages in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListChannelMessages]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMessages.html func (c *Client) ListChannelMessages(ctx context.Context, params *ListChannelMessagesInput, optFns ...func(*Options)) (*ListChannelMessagesOutput, error) { if params == nil { params = &ListChannelMessagesInput{} diff --git a/service/chime/api_op_ListChannelModerators.go b/service/chime/api_op_ListChannelModerators.go index 708d9ce9ce9..a89beffb0bb 100644 --- a/service/chime/api_op_ListChannelModerators.go +++ b/service/chime/api_op_ListChannelModerators.go @@ -11,17 +11,22 @@ 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, ListChannelModerators (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelModerators.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannelModerators], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelModerators in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListChannelModerators]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelModerators.html 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 924713da5a9..eefa7bfe5dc 100644 --- a/service/chime/api_op_ListChannels.go +++ b/service/chime/api_op_ListChannels.go @@ -12,21 +12,28 @@ import ( ) // Lists all Channels created under a single Chime App as a paginated list. You -// can specify filters to narrow results. Functionality & restrictions +// 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 AppInstanceUserArn -// of the user that makes the API call as the value in the header. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, ListChannels (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannels.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// of the user that makes the API call as the value in the header. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannels], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannels in the Amazon Chime SDK Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListChannels]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannels.html func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error) { if params == nil { params = &ListChannelsInput{} diff --git a/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go b/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go index f8c9df1cea4..44616adbb75 100644 --- a/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go +++ b/service/chime/api_op_ListChannelsModeratedByAppInstanceUser.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. This API is is no longer supported and -// will not be updated. We recommend using the latest version, -// ListChannelsModeratedByAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelsModeratedByAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListChannelsModeratedByAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListChannelsModeratedByAppInstanceUser in the Amazon // Chime SDK Messaging Namespace +// +// [ListChannelsModeratedByAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelsModeratedByAppInstanceUser.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) ListChannelsModeratedByAppInstanceUser(ctx context.Context, params *ListChannelsModeratedByAppInstanceUserInput, optFns ...func(*Options)) (*ListChannelsModeratedByAppInstanceUserOutput, error) { if params == nil { params = &ListChannelsModeratedByAppInstanceUserInput{} diff --git a/service/chime/api_op_ListMediaCapturePipelines.go b/service/chime/api_op_ListMediaCapturePipelines.go index 1c0bd25c7de..13c062e63d0 100644 --- a/service/chime/api_op_ListMediaCapturePipelines.go +++ b/service/chime/api_op_ListMediaCapturePipelines.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of media capture pipelines. This API is is no longer supported -// and will not be updated. We recommend using the latest version, -// ListMediaCapturePipelines (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_ListMediaCapturePipelines.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Returns a list of media capture pipelines. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListMediaCapturePipelines], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListMediaCapturePipelines in the Amazon Chime SDK Media // Pipelines Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListMediaCapturePipelines]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_media-pipelines-chime_ListMediaCapturePipelines.html func (c *Client) ListMediaCapturePipelines(ctx context.Context, params *ListMediaCapturePipelinesInput, optFns ...func(*Options)) (*ListMediaCapturePipelinesOutput, error) { if params == nil { params = &ListMediaCapturePipelinesInput{} diff --git a/service/chime/api_op_ListMeetingTags.go b/service/chime/api_op_ListMeetingTags.go index 9d8673513d5..9af03dd2108 100644 --- a/service/chime/api_op_ListMeetingTags.go +++ b/service/chime/api_op_ListMeetingTags.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags applied to an Amazon Chime SDK meeting resource. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, ListTagsForResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListTagsForResource.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists the tags applied to an Amazon Chime SDK meeting resource. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListTagsForResource], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Use ListTagsForResource in the Amazon Chime SDK Meetings Namespace. +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListTagsForResource]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListTagsForResource.html func (c *Client) ListMeetingTags(ctx context.Context, params *ListMeetingTagsInput, optFns ...func(*Options)) (*ListMeetingTagsOutput, error) { if params == nil { params = &ListMeetingTagsInput{} diff --git a/service/chime/api_op_ListMeetings.go b/service/chime/api_op_ListMeetings.go index 99adb1e17c0..39f06c0c277 100644 --- a/service/chime/api_op_ListMeetings.go +++ b/service/chime/api_op_ListMeetings.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists up to 100 active Amazon Chime SDK meetings. ListMeetings is not supported -// in the Amazon Chime SDK Meetings Namespace. Update your application to remove -// calls to this API. For more information about the Amazon Chime SDK, see Using -// the Amazon Chime SDK (https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html) -// in the Amazon Chime SDK Developer Guide. +// Lists up to 100 active Amazon Chime SDK meetings. +// +// ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. +// Update your application to remove calls to this API. +// +// For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK] in the Amazon Chime SDK +// Developer Guide. // // Deprecated: ListMeetings is not supported in the Amazon Chime SDK Meetings // Namespace. Update your application to remove calls to this API. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meetings-sdk.html 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_ListProxySessions.go b/service/chime/api_op_ListProxySessions.go index 063bf278f6b..921b80f2f6a 100644 --- a/service/chime/api_op_ListProxySessions.go +++ b/service/chime/api_op_ListProxySessions.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the proxy sessions for the specified Amazon Chime Voice Connector. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, ListProxySessions (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListProxySessions.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists the proxy sessions for the specified Amazon Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListProxySessions], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListProxySessions in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListProxySessions]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListProxySessions.html func (c *Client) ListProxySessions(ctx context.Context, params *ListProxySessionsInput, optFns ...func(*Options)) (*ListProxySessionsOutput, error) { if params == nil { params = &ListProxySessionsInput{} diff --git a/service/chime/api_op_ListSipMediaApplications.go b/service/chime/api_op_ListSipMediaApplications.go index fd3b83de37b..aade4ac2d8f 100644 --- a/service/chime/api_op_ListSipMediaApplications.go +++ b/service/chime/api_op_ListSipMediaApplications.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the SIP media applications under the administrator's AWS account. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, ListSipMediaApplications (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListSipMediaApplications.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists the SIP media applications under the administrator's AWS account. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListSipMediaApplications], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListSipMediaApplications in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListSipMediaApplications]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListSipMediaApplications.html func (c *Client) ListSipMediaApplications(ctx context.Context, params *ListSipMediaApplicationsInput, optFns ...func(*Options)) (*ListSipMediaApplicationsOutput, error) { if params == nil { params = &ListSipMediaApplicationsInput{} diff --git a/service/chime/api_op_ListSipRules.go b/service/chime/api_op_ListSipRules.go index f5359d106b8..ca6ced66df0 100644 --- a/service/chime/api_op_ListSipRules.go +++ b/service/chime/api_op_ListSipRules.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the SIP rules under the administrator's AWS account. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// ListSipRules (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListSipRules.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists the SIP rules under the administrator's AWS account. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListSipRules], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListSipRules in the Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListSipRules]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListSipRules.html func (c *Client) ListSipRules(ctx context.Context, params *ListSipRulesInput, optFns ...func(*Options)) (*ListSipRulesOutput, error) { if params == nil { params = &ListSipRulesInput{} diff --git a/service/chime/api_op_ListTagsForResource.go b/service/chime/api_op_ListTagsForResource.go index 18f88ed3dab..20da622601c 100644 --- a/service/chime/api_op_ListTagsForResource.go +++ b/service/chime/api_op_ListTagsForResource.go @@ -12,20 +12,23 @@ import ( ) // Lists the tags applied to an Amazon Chime SDK meeting and messaging resources. +// // This API is is no longer supported and will not be updated. We recommend using // the applicable latest version in the Amazon Chime SDK. -// - For meetings: ListTagsForResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_ListTagsForResource.html) -// . -// - For messaging: ListTagsForResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListTagsForResource.html) -// . +// +// - For meetings: [ListTagsForResource]. +// +// - For messaging: [ListTagsForResource]. // // Using the latest version requires migrating to a dedicated namespace. For more -// information, refer to Migrating from the Amazon Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListTagsForResource in the Amazon Chime SDK Voice, // Amazon Chime SDK Meetings, Amazon Chime SDK Identity, Amazon Chime SDK // Messaging, and Amazon Chime SDK Media Pipelines Namespaces +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListTagsForResource]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListTagsForResource.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/chime/api_op_ListVoiceConnectorGroups.go b/service/chime/api_op_ListVoiceConnectorGroups.go index 3bc2a20ca86..7fed994b46d 100644 --- a/service/chime/api_op_ListVoiceConnectorGroups.go +++ b/service/chime/api_op_ListVoiceConnectorGroups.go @@ -12,15 +12,19 @@ import ( ) // Lists the Amazon Chime Voice Connector groups for the administrator's AWS -// account. This API is is no longer supported and will not be updated. We -// recommend using the latest version, ListVoiceConnectorGroups (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectorGroups.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// account. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListVoiceConnectorGroups], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListVoiceConnectorGroups in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListVoiceConnectorGroups]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectorGroups.html func (c *Client) ListVoiceConnectorGroups(ctx context.Context, params *ListVoiceConnectorGroupsInput, optFns ...func(*Options)) (*ListVoiceConnectorGroupsOutput, error) { if params == nil { params = &ListVoiceConnectorGroupsInput{} diff --git a/service/chime/api_op_ListVoiceConnectorTerminationCredentials.go b/service/chime/api_op_ListVoiceConnectorTerminationCredentials.go index dc6068e6c5d..f6fb058fbbb 100644 --- a/service/chime/api_op_ListVoiceConnectorTerminationCredentials.go +++ b/service/chime/api_op_ListVoiceConnectorTerminationCredentials.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the SIP credentials for the specified Amazon Chime Voice Connector. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, ListVoiceConnectorTerminationCredentials (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectorTerminationCredentials.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Lists the SIP credentials for the specified Amazon Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ListVoiceConnectorTerminationCredentials], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListVoiceConnectorTerminationCredentials in the Amazon // Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListVoiceConnectorTerminationCredentials]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectorTerminationCredentials.html func (c *Client) ListVoiceConnectorTerminationCredentials(ctx context.Context, params *ListVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*ListVoiceConnectorTerminationCredentialsOutput, error) { if params == nil { params = &ListVoiceConnectorTerminationCredentialsInput{} diff --git a/service/chime/api_op_ListVoiceConnectors.go b/service/chime/api_op_ListVoiceConnectors.go index 5c0733815f9..88c83d3f812 100644 --- a/service/chime/api_op_ListVoiceConnectors.go +++ b/service/chime/api_op_ListVoiceConnectors.go @@ -12,15 +12,18 @@ import ( ) // Lists the Amazon Chime Voice Connectors for the administrator's AWS account. +// // This API is is no longer supported and will not be updated. We recommend using -// the latest version, ListVoiceConnectors (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectors.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the latest version, [ListVoiceConnectors], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ListVoiceConnectors in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ListVoiceConnectors]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ListVoiceConnectors.html func (c *Client) ListVoiceConnectors(ctx context.Context, params *ListVoiceConnectorsInput, optFns ...func(*Options)) (*ListVoiceConnectorsOutput, error) { if params == nil { params = &ListVoiceConnectorsInput{} diff --git a/service/chime/api_op_PutAppInstanceRetentionSettings.go b/service/chime/api_op_PutAppInstanceRetentionSettings.go index caedfab85bc..78968181775 100644 --- a/service/chime/api_op_PutAppInstanceRetentionSettings.go +++ b/service/chime/api_op_PutAppInstanceRetentionSettings.go @@ -12,16 +12,19 @@ import ( "time" ) -// Sets the amount of time in days that a given AppInstance retains data. This API -// is is no longer supported and will not be updated. We recommend using the latest -// version, PutAppInstanceRetentionSettings (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_PutAppInstanceRetentionSettings.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Sets the amount of time in days that a given AppInstance retains data. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutAppInstanceRetentionSettings], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutAppInstanceRetentionSettings in the Amazon Chime SDK // Identity Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutAppInstanceRetentionSettings]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_PutAppInstanceRetentionSettings.html func (c *Client) PutAppInstanceRetentionSettings(ctx context.Context, params *PutAppInstanceRetentionSettingsInput, optFns ...func(*Options)) (*PutAppInstanceRetentionSettingsOutput, error) { if params == nil { params = &PutAppInstanceRetentionSettingsInput{} diff --git a/service/chime/api_op_PutAppInstanceStreamingConfigurations.go b/service/chime/api_op_PutAppInstanceStreamingConfigurations.go index ff0ec90dfd4..3dd02e35b37 100644 --- a/service/chime/api_op_PutAppInstanceStreamingConfigurations.go +++ b/service/chime/api_op_PutAppInstanceStreamingConfigurations.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The data streaming configurations of an AppInstance . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// PutMessagingStreamingConfigurations (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_PutMessagingStreamingConfigurations.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// The data streaming configurations of an AppInstance . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutMessagingStreamingConfigurations], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutAppInstanceStreamingConfigurations in the Amazon // Chime SDK Messaging Namespace +// +// [PutMessagingStreamingConfigurations]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_PutMessagingStreamingConfigurations.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) PutAppInstanceStreamingConfigurations(ctx context.Context, params *PutAppInstanceStreamingConfigurationsInput, optFns ...func(*Options)) (*PutAppInstanceStreamingConfigurationsOutput, error) { if params == nil { params = &PutAppInstanceStreamingConfigurationsInput{} diff --git a/service/chime/api_op_PutEventsConfiguration.go b/service/chime/api_op_PutEventsConfiguration.go index 9a27f9c64c4..838b9a8be0a 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{} diff --git a/service/chime/api_op_PutRetentionSettings.go b/service/chime/api_op_PutRetentionSettings.go index 24f77de230f..3a8ce005d3d 100644 --- a/service/chime/api_op_PutRetentionSettings.go +++ b/service/chime/api_op_PutRetentionSettings.go @@ -12,14 +12,18 @@ import ( "time" ) -// Puts retention settings for the specified Amazon Chime Enterprise account. We +// 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]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]in the Amazon Chime Administration +// Guide. +// +// [Managing Chat Retention Policies]: https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html +// [Logging Amazon Chime API Calls with AWS CloudTrail]: https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html func (c *Client) PutRetentionSettings(ctx context.Context, params *PutRetentionSettingsInput, optFns ...func(*Options)) (*PutRetentionSettingsOutput, error) { if params == nil { params = &PutRetentionSettingsInput{} diff --git a/service/chime/api_op_PutSipMediaApplicationLoggingConfiguration.go b/service/chime/api_op_PutSipMediaApplicationLoggingConfiguration.go index 56161209caf..071f81bf3df 100644 --- a/service/chime/api_op_PutSipMediaApplicationLoggingConfiguration.go +++ b/service/chime/api_op_PutSipMediaApplicationLoggingConfiguration.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the logging configuration for the specified SIP media application. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, PutSipMediaApplicationLoggingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutSipMediaApplicationLoggingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Updates the logging configuration for the specified SIP media application. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutSipMediaApplicationLoggingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutSipMediaApplicationLoggingConfiguration in the // Amazon Chime SDK Voice Namespace +// +// [PutSipMediaApplicationLoggingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutSipMediaApplicationLoggingConfiguration.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) PutSipMediaApplicationLoggingConfiguration(ctx context.Context, params *PutSipMediaApplicationLoggingConfigurationInput, optFns ...func(*Options)) (*PutSipMediaApplicationLoggingConfigurationOutput, error) { if params == nil { params = &PutSipMediaApplicationLoggingConfigurationInput{} diff --git a/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go b/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go index d58b0d87f32..b843eb297a0 100644 --- a/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go +++ b/service/chime/api_op_PutVoiceConnectorEmergencyCallingConfiguration.go @@ -14,16 +14,19 @@ import ( // 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. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// PutVoiceConnectorEmergencyCallingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector before emergency calling can be configured. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorEmergencyCallingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorEmergencyCallingConfiguration in the // Amazon Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutVoiceConnectorEmergencyCallingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorEmergencyCallingConfiguration.html 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 81b1b371d64..bfc109b877a 100644 --- a/service/chime/api_op_PutVoiceConnectorLoggingConfiguration.go +++ b/service/chime/api_op_PutVoiceConnectorLoggingConfiguration.go @@ -13,16 +13,19 @@ import ( // 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. This API is is no longer supported and will -// not be updated. We recommend using the latest version, -// PutVoiceConnectorLoggingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorLoggingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// sending to Amazon CloudWatch Logs. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorLoggingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorLoggingConfiguration in the Amazon // Chime SDK Voice Namespace +// +// [PutVoiceConnectorLoggingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorLoggingConfiguration.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html 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_PutVoiceConnectorOrigination.go b/service/chime/api_op_PutVoiceConnectorOrigination.go index 679cd1e55bb..36ea1fe23ef 100644 --- a/service/chime/api_op_PutVoiceConnectorOrigination.go +++ b/service/chime/api_op_PutVoiceConnectorOrigination.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds 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 turning off origination settings. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// PutVoiceConnectorOrigination (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorOrigination.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Adds 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 turning off origination settings. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorOrigination], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorOrigination in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutVoiceConnectorOrigination]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorOrigination.html func (c *Client) PutVoiceConnectorOrigination(ctx context.Context, params *PutVoiceConnectorOriginationInput, optFns ...func(*Options)) (*PutVoiceConnectorOriginationOutput, error) { if params == nil { params = &PutVoiceConnectorOriginationInput{} diff --git a/service/chime/api_op_PutVoiceConnectorProxy.go b/service/chime/api_op_PutVoiceConnectorProxy.go index 8142af466be..ead70c8fa00 100644 --- a/service/chime/api_op_PutVoiceConnectorProxy.go +++ b/service/chime/api_op_PutVoiceConnectorProxy.go @@ -12,15 +12,19 @@ import ( ) // Puts the specified proxy configuration to the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, PutVoiceConnectorProxy (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorProxy.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorProxy], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorProxy in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutVoiceConnectorProxy]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorProxy.html func (c *Client) PutVoiceConnectorProxy(ctx context.Context, params *PutVoiceConnectorProxyInput, optFns ...func(*Options)) (*PutVoiceConnectorProxyOutput, error) { if params == nil { params = &PutVoiceConnectorProxyInput{} diff --git a/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go b/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go index 10251908efb..9a72d2a4daf 100644 --- a/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go +++ b/service/chime/api_op_PutVoiceConnectorStreamingConfiguration.go @@ -14,15 +14,19 @@ import ( // Adds a streaming configuration for the specified Amazon Chime Voice Connector. // The streaming configuration specifies whether media streaming is enabled for // sending to Kinesis. It also sets the retention period, in hours, for the Amazon -// Kinesis data. This API is is no longer supported and will not be updated. We -// recommend using the latest version, PutVoiceConnectorStreamingConfiguration (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorStreamingConfiguration.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Kinesis data. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorStreamingConfiguration], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorStreamingConfiguration in the Amazon // Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutVoiceConnectorStreamingConfiguration]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorStreamingConfiguration.html func (c *Client) PutVoiceConnectorStreamingConfiguration(ctx context.Context, params *PutVoiceConnectorStreamingConfigurationInput, optFns ...func(*Options)) (*PutVoiceConnectorStreamingConfigurationOutput, error) { if params == nil { params = &PutVoiceConnectorStreamingConfigurationInput{} diff --git a/service/chime/api_op_PutVoiceConnectorTermination.go b/service/chime/api_op_PutVoiceConnectorTermination.go index 160334e5cbc..85a72a71d2f 100644 --- a/service/chime/api_op_PutVoiceConnectorTermination.go +++ b/service/chime/api_op_PutVoiceConnectorTermination.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds 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 turning off termination settings. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// PutVoiceConnectorTermination (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorTermination.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Adds 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 turning off termination settings. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorTermination], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorTermination in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutVoiceConnectorTermination]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorTermination.html func (c *Client) PutVoiceConnectorTermination(ctx context.Context, params *PutVoiceConnectorTerminationInput, optFns ...func(*Options)) (*PutVoiceConnectorTerminationOutput, error) { if params == nil { params = &PutVoiceConnectorTerminationInput{} diff --git a/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go b/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go index 31f7e854312..3c48f24515b 100644 --- a/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go +++ b/service/chime/api_op_PutVoiceConnectorTerminationCredentials.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds termination SIP credentials for the specified Amazon Chime Voice -// Connector. This API is is no longer supported and will not be updated. We -// recommend using the latest version, PutVoiceConnectorTerminationCredentials (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorTerminationCredentials.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Adds termination SIP credentials for the specified Amazon Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [PutVoiceConnectorTerminationCredentials], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by PutVoiceConnectorTerminationCredentials in the Amazon // Chime SDK Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [PutVoiceConnectorTerminationCredentials]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_PutVoiceConnectorTerminationCredentials.html func (c *Client) PutVoiceConnectorTerminationCredentials(ctx context.Context, params *PutVoiceConnectorTerminationCredentialsInput, optFns ...func(*Options)) (*PutVoiceConnectorTerminationCredentialsOutput, error) { if params == nil { params = &PutVoiceConnectorTerminationCredentialsInput{} diff --git a/service/chime/api_op_RedactChannelMessage.go b/service/chime/api_op_RedactChannelMessage.go index 42ffa61915a..063c61079ce 100644 --- a/service/chime/api_op_RedactChannelMessage.go +++ b/service/chime/api_op_RedactChannelMessage.go @@ -11,18 +11,22 @@ import ( ) // Redacts message content, but not metadata. The message exists in the back end, -// but the action returns null content, and the state shows as redacted. 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. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// RedactChannelMessage (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_RedactChannelMessage.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// but the action returns null content, and the state shows as redacted. +// +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [RedactChannelMessage], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by RedactChannelMessage in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [RedactChannelMessage]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_RedactChannelMessage.html func (c *Client) RedactChannelMessage(ctx context.Context, params *RedactChannelMessageInput, optFns ...func(*Options)) (*RedactChannelMessageOutput, error) { if params == nil { params = &RedactChannelMessageInput{} diff --git a/service/chime/api_op_ResetPersonalPIN.go b/service/chime/api_op_ResetPersonalPIN.go index 8f0f58271a3..15e7f0fefbf 100644 --- a/service/chime/api_op_ResetPersonalPIN.go +++ b/service/chime/api_op_ResetPersonalPIN.go @@ -12,7 +12,7 @@ import ( ) // Resets the personal meeting PIN for the specified user on an Amazon Chime -// account. Returns the User object with the updated personal meeting PIN. +// account. Returns the Userobject with the updated personal meeting PIN. func (c *Client) ResetPersonalPIN(ctx context.Context, params *ResetPersonalPINInput, optFns ...func(*Options)) (*ResetPersonalPINOutput, error) { if params == nil { params = &ResetPersonalPINInput{} diff --git a/service/chime/api_op_SendChannelMessage.go b/service/chime/api_op_SendChannelMessage.go index 04e1047ccab..45047f74215 100644 --- a/service/chime/api_op_SendChannelMessage.go +++ b/service/chime/api_op_SendChannelMessage.go @@ -11,19 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 AppInstanceUserArn of -// the user 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. This API is is no longer supported and -// will not be updated. We recommend using the latest version, SendChannelMessage (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_SendChannelMessage.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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 AppInstanceUserArn +// of the user 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [SendChannelMessage], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by SendChannelMessage in the Amazon Chime SDK Messaging // Namespace +// +// [SendChannelMessage]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_SendChannelMessage.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) SendChannelMessage(ctx context.Context, params *SendChannelMessageInput, optFns ...func(*Options)) (*SendChannelMessageOutput, error) { if params == nil { params = &SendChannelMessageInput{} diff --git a/service/chime/api_op_StartMeetingTranscription.go b/service/chime/api_op_StartMeetingTranscription.go index deb2a0740f2..e133173a492 100644 --- a/service/chime/api_op_StartMeetingTranscription.go +++ b/service/chime/api_op_StartMeetingTranscription.go @@ -12,25 +12,31 @@ import ( ) // 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. If you specify an invalid -// configuration, a TranscriptFailed event will be sent with the contents of the -// BadRequestException generated by Amazon Transcribe. For more information on each -// parameter and which combinations are valid, refer to the -// StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) -// API in the Amazon Transcribe 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 specific to the AWS Machine Learning and Artificial -// Intelligence Services. This API is is no longer supported and will not be -// updated. We recommend using the latest version, StartMeetingTranscription (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_StartMeetingTranscription.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// to [Using Amazon Chime SDK live transcription]in the Amazon Chime SDK Developer Guide. +// +// If you specify an invalid configuration, a TranscriptFailed event will be sent +// with the contents of the BadRequestException generated by Amazon Transcribe. +// For more information on each parameter and which combinations are valid, refer +// to the [StartStreamTranscription]API in the Amazon Transcribe Developer Guide. +// +// Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of +// Amazon Transcribe is subject to the [AWS Service Terms], including the terms specific to the AWS +// Machine Learning and Artificial Intelligence Services. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [StartMeetingTranscription], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by StartMeetingTranscription in the Amazon Chime SDK // Meetings Namespace +// +// [AWS Service Terms]: https://aws.amazon.com/service-terms/ +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Using Amazon Chime SDK live transcription]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html +// [StartMeetingTranscription]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_StartMeetingTranscription.html +// [StartStreamTranscription]: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html func (c *Client) StartMeetingTranscription(ctx context.Context, params *StartMeetingTranscriptionInput, optFns ...func(*Options)) (*StartMeetingTranscriptionOutput, error) { if params == nil { params = &StartMeetingTranscriptionInput{} diff --git a/service/chime/api_op_StopMeetingTranscription.go b/service/chime/api_op_StopMeetingTranscription.go index b40af6c0001..72472a89436 100644 --- a/service/chime/api_op_StopMeetingTranscription.go +++ b/service/chime/api_op_StopMeetingTranscription.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops transcription for the specified meetingId . This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// StopMeetingTranscription (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_StopMeetingTranscription.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Stops transcription for the specified meetingId . +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [StopMeetingTranscription], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by StopMeetingTranscription in the Amazon Chime SDK // Meetings Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [StopMeetingTranscription]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_StopMeetingTranscription.html 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_TagAttendee.go b/service/chime/api_op_TagAttendee.go index 2d49cc22d0c..68f1cff1022 100644 --- a/service/chime/api_op_TagAttendee.go +++ b/service/chime/api_op_TagAttendee.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Applies the specified tags to the specified Amazon Chime attendee. TagAttendee -// is not supported in the Amazon Chime SDK Meetings Namespace. Update your -// application to remove calls to this API. +// Applies the specified tags to the specified Amazon Chime attendee. +// +// TagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. Update +// your application to remove calls to this API. // // Deprecated: Attendee Tags are not supported in the Amazon Chime SDK Meetings // Namespace. Update your application to remove calls to this API. diff --git a/service/chime/api_op_TagMeeting.go b/service/chime/api_op_TagMeeting.go index cd1861f20a0..27333b17b6f 100644 --- a/service/chime/api_op_TagMeeting.go +++ b/service/chime/api_op_TagMeeting.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Applies the specified tags to the specified Amazon Chime SDK meeting. This API -// is is no longer supported and will not be updated. We recommend using the latest -// version, TagResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_TagResource.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Applies the specified tags to the specified Amazon Chime SDK meeting. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [TagResource], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Use TagResource in the Amazon Chime SDK Meetings Namespace. +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [TagResource]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_TagResource.html func (c *Client) TagMeeting(ctx context.Context, params *TagMeetingInput, optFns ...func(*Options)) (*TagMeetingOutput, error) { if params == nil { params = &TagMeetingInput{} diff --git a/service/chime/api_op_TagResource.go b/service/chime/api_op_TagResource.go index c639312584c..64fa0798928 100644 --- a/service/chime/api_op_TagResource.go +++ b/service/chime/api_op_TagResource.go @@ -12,16 +12,19 @@ import ( ) // Applies the specified tags to the specified Amazon Chime SDK meeting resource. +// // This API is is no longer supported and will not be updated. We recommend using -// the latest version, TagResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_TagResource.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the latest version, [TagResource], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by TagResource in the Amazon Chime SDK Voice, Amazon Chime // SDK Meetings, Amazon Chime SDK Identity, Amazon Chime SDK Messaging, and Amazon // Chime SDK Media Pipelines Namespaces +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [TagResource]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_TagResource.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/chime/api_op_UntagAttendee.go b/service/chime/api_op_UntagAttendee.go index 1b271484970..6263508c168 100644 --- a/service/chime/api_op_UntagAttendee.go +++ b/service/chime/api_op_UntagAttendee.go @@ -11,6 +11,7 @@ import ( ) // Untags the specified tags from the specified Amazon Chime SDK attendee. +// // UntagAttendee is not supported in the Amazon Chime SDK Meetings Namespace. // Update your application to remove calls to this API. // diff --git a/service/chime/api_op_UntagMeeting.go b/service/chime/api_op_UntagMeeting.go index 4a1c23ced1d..ca98e19dffe 100644 --- a/service/chime/api_op_UntagMeeting.go +++ b/service/chime/api_op_UntagMeeting.go @@ -10,15 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Untags the specified tags from the specified Amazon Chime SDK meeting. This API -// is is no longer supported and will not be updated. We recommend using the latest -// version, UntagResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_UntagResource.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Untags the specified tags from the specified Amazon Chime SDK meeting. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UntagResource], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Use UntagResource in the Amazon Chime SDK Meetings Namespace. +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UntagResource]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_UntagResource.html func (c *Client) UntagMeeting(ctx context.Context, params *UntagMeetingInput, optFns ...func(*Options)) (*UntagMeetingOutput, error) { if params == nil { params = &UntagMeetingInput{} diff --git a/service/chime/api_op_UntagResource.go b/service/chime/api_op_UntagResource.go index c4958851876..22848fc64fb 100644 --- a/service/chime/api_op_UntagResource.go +++ b/service/chime/api_op_UntagResource.go @@ -11,17 +11,21 @@ import ( ) // Untags the specified tags from the specified Amazon Chime SDK meeting resource. +// // Applies the specified tags to the specified Amazon Chime SDK meeting resource. +// // This API is is no longer supported and will not be updated. We recommend using -// the latest version, UntagResource (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_UntagResource.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the latest version, [UntagResource], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UntagResource in the Amazon Chime SDK Voice, Amazon // Chime SDK Meetings, Amazon Chime SDK Identity, Amazon Chime SDK Messaging, and // Amazon Chime SDK Media Pipelines Namespaces +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UntagResource]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_UntagResource.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/chime/api_op_UpdateAccountSettings.go b/service/chime/api_op_UpdateAccountSettings.go index f688e8d6b34..da48b6c18b4 100644 --- a/service/chime/api_op_UpdateAccountSettings.go +++ b/service/chime/api_op_UpdateAccountSettings.go @@ -13,8 +13,10 @@ 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]in the Amazon Chime Administration +// Guide. +// +// [Use the Policies Page]: https://docs.aws.amazon.com/chime/latest/ag/policies.html 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 6b0a7ade59b..457a73fee1a 100644 --- a/service/chime/api_op_UpdateAppInstance.go +++ b/service/chime/api_op_UpdateAppInstance.go @@ -10,15 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates AppInstance metadata. This API is is no longer supported and will not -// be updated. We recommend using the latest version, UpdateAppInstance (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_UpdateAppInstance.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Updates AppInstance metadata. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateAppInstance], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateAppInstance in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateAppInstance]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_UpdateAppInstance.html func (c *Client) UpdateAppInstance(ctx context.Context, params *UpdateAppInstanceInput, optFns ...func(*Options)) (*UpdateAppInstanceOutput, error) { if params == nil { params = &UpdateAppInstanceInput{} diff --git a/service/chime/api_op_UpdateAppInstanceUser.go b/service/chime/api_op_UpdateAppInstanceUser.go index 5fb0c14f22b..9b1ce0eca31 100644 --- a/service/chime/api_op_UpdateAppInstanceUser.go +++ b/service/chime/api_op_UpdateAppInstanceUser.go @@ -11,15 +11,18 @@ import ( ) // Updates the details of an AppInstanceUser . You can update names and metadata. +// // This API is is no longer supported and will not be updated. We recommend using -// the latest version, UpdateAppInstanceUser (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_UpdateAppInstanceUser.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the latest version, [UpdateAppInstanceUser], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateAppInstanceUser in the Amazon Chime SDK Identity // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateAppInstanceUser]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_identity-chime_UpdateAppInstanceUser.html func (c *Client) UpdateAppInstanceUser(ctx context.Context, params *UpdateAppInstanceUserInput, optFns ...func(*Options)) (*UpdateAppInstanceUserOutput, error) { if params == nil { params = &UpdateAppInstanceUserInput{} diff --git a/service/chime/api_op_UpdateChannel.go b/service/chime/api_op_UpdateChannel.go index 52b5c9b1813..2a02c7157b4 100644 --- a/service/chime/api_op_UpdateChannel.go +++ b/service/chime/api_op_UpdateChannel.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a channel's attributes. 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. This API is is no longer supported and will not be updated. We recommend -// using the latest version, UpdateChannel (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannel.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Update a channel's attributes. +// +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateChannel], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateChannel in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateChannel]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannel.html func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error) { if params == nil { params = &UpdateChannelInput{} diff --git a/service/chime/api_op_UpdateChannelMessage.go b/service/chime/api_op_UpdateChannelMessage.go index f58c0348578..859331ad354 100644 --- a/service/chime/api_op_UpdateChannelMessage.go +++ b/service/chime/api_op_UpdateChannelMessage.go @@ -10,17 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. This API is is no longer supported and will not be -// updated. We recommend using the latest version, UpdateChannelMessage (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannelMessage.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateChannelMessage], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateChannelMessage in the Amazon Chime SDK Messaging // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateChannelMessage]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannelMessage.html 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_UpdateChannelReadMarker.go b/service/chime/api_op_UpdateChannelReadMarker.go index 73765ecbc94..66f245d856d 100644 --- a/service/chime/api_op_UpdateChannelReadMarker.go +++ b/service/chime/api_op_UpdateChannelReadMarker.go @@ -10,18 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The details of the time when a user last read messages in 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. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// UpdateChannelReadMarker (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannelReadMarker.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// The details of the time when a user last read messages in 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. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateChannelReadMarker], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateChannelReadMarker in the Amazon Chime SDK // Messaging Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateChannelReadMarker]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_UpdateChannelReadMarker.html func (c *Client) UpdateChannelReadMarker(ctx context.Context, params *UpdateChannelReadMarkerInput, optFns ...func(*Options)) (*UpdateChannelReadMarkerOutput, error) { if params == nil { params = &UpdateChannelReadMarkerInput{} diff --git a/service/chime/api_op_UpdatePhoneNumber.go b/service/chime/api_op_UpdatePhoneNumber.go index 9201813d960..19f5a903a89 100644 --- a/service/chime/api_op_UpdatePhoneNumber.go +++ b/service/chime/api_op_UpdatePhoneNumber.go @@ -14,11 +14,15 @@ import ( // Updates phone number details, such as product type or calling name, for the // specified phone number ID. You can update one phone number detail at a time. For // example, you can update either the product type or the calling name in one -// action. 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. Updates to outbound calling names can -// take 72 hours to complete. Pending updates to outbound calling names must be -// complete before you can request another update. +// action. +// +// 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. +// +// Updates to outbound calling names can take 72 hours to complete. Pending +// updates to outbound calling names must be complete before you can request +// another update. func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error) { if params == nil { params = &UpdatePhoneNumberInput{} diff --git a/service/chime/api_op_UpdateProxySession.go b/service/chime/api_op_UpdateProxySession.go index 51658fbcc8a..d5231ec5619 100644 --- a/service/chime/api_op_UpdateProxySession.go +++ b/service/chime/api_op_UpdateProxySession.go @@ -12,15 +12,18 @@ import ( ) // Updates the specified proxy session details, such as voice or SMS capabilities. +// // This API is is no longer supported and will not be updated. We recommend using -// the latest version, UpdateProxySession (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateProxySession.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the latest version, [UpdateProxySession], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateProxySession in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateProxySession]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateProxySession.html func (c *Client) UpdateProxySession(ctx context.Context, params *UpdateProxySessionInput, optFns ...func(*Options)) (*UpdateProxySessionOutput, error) { if params == nil { params = &UpdateProxySessionInput{} diff --git a/service/chime/api_op_UpdateSipMediaApplication.go b/service/chime/api_op_UpdateSipMediaApplication.go index 6b3265d9d9b..c27e1d42eda 100644 --- a/service/chime/api_op_UpdateSipMediaApplication.go +++ b/service/chime/api_op_UpdateSipMediaApplication.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the details of the specified SIP media application. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// UpdateSipMediaApplication (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipMediaApplication.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Updates the details of the specified SIP media application. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateSipMediaApplication], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateSipMediaApplication in the Amazon Chime SDK Voice // Namespace +// +// [UpdateSipMediaApplication]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipMediaApplication.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) UpdateSipMediaApplication(ctx context.Context, params *UpdateSipMediaApplicationInput, optFns ...func(*Options)) (*UpdateSipMediaApplicationOutput, error) { if params == nil { params = &UpdateSipMediaApplicationInput{} diff --git a/service/chime/api_op_UpdateSipMediaApplicationCall.go b/service/chime/api_op_UpdateSipMediaApplicationCall.go index 8e004a028ea..de5979d83e1 100644 --- a/service/chime/api_op_UpdateSipMediaApplicationCall.go +++ b/service/chime/api_op_UpdateSipMediaApplicationCall.go @@ -13,15 +13,19 @@ import ( // Invokes the AWS Lambda function associated with the SIP media application and // transaction ID in an update request. The Lambda function can then return a new -// set of actions. This API is is no longer supported and will not be updated. We -// recommend using the latest version, UpdateSipMediaApplicationCall (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipMediaApplicationCall.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// set of actions. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateSipMediaApplicationCall], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateSipMediaApplicationCall in the Amazon Chime SDK // Voice Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateSipMediaApplicationCall]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipMediaApplicationCall.html func (c *Client) UpdateSipMediaApplicationCall(ctx context.Context, params *UpdateSipMediaApplicationCallInput, optFns ...func(*Options)) (*UpdateSipMediaApplicationCallOutput, error) { if params == nil { params = &UpdateSipMediaApplicationCallInput{} diff --git a/service/chime/api_op_UpdateSipRule.go b/service/chime/api_op_UpdateSipRule.go index 5774c3e2f11..693d77ab997 100644 --- a/service/chime/api_op_UpdateSipRule.go +++ b/service/chime/api_op_UpdateSipRule.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the details of the specified SIP rule. This API is is no longer -// supported and will not be updated. We recommend using the latest version, -// UpdateSipRule (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipRule.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Updates the details of the specified SIP rule. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateSipRule], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateSipRule in the Amazon Chime SDK Voice Namespace +// +// [UpdateSipRule]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateSipRule.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html func (c *Client) UpdateSipRule(ctx context.Context, params *UpdateSipRuleInput, optFns ...func(*Options)) (*UpdateSipRuleOutput, error) { if params == nil { params = &UpdateSipRuleInput{} diff --git a/service/chime/api_op_UpdateVoiceConnector.go b/service/chime/api_op_UpdateVoiceConnector.go index 93b86d045a1..bf3df887b54 100644 --- a/service/chime/api_op_UpdateVoiceConnector.go +++ b/service/chime/api_op_UpdateVoiceConnector.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates details for the specified Amazon Chime Voice Connector. This API is is -// no longer supported and will not be updated. We recommend using the latest -// version, UpdateVoiceConnector (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateVoiceConnector.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// Updates details for the specified Amazon Chime Voice Connector. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateVoiceConnector], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateVoiceConnector in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [UpdateVoiceConnector]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateVoiceConnector.html func (c *Client) UpdateVoiceConnector(ctx context.Context, params *UpdateVoiceConnectorInput, optFns ...func(*Options)) (*UpdateVoiceConnectorOutput, error) { if params == nil { params = &UpdateVoiceConnectorInput{} diff --git a/service/chime/api_op_UpdateVoiceConnectorGroup.go b/service/chime/api_op_UpdateVoiceConnectorGroup.go index 68a00a6fd17..8b82aaf0445 100644 --- a/service/chime/api_op_UpdateVoiceConnectorGroup.go +++ b/service/chime/api_op_UpdateVoiceConnectorGroup.go @@ -12,16 +12,19 @@ import ( ) // Updates details of the specified Amazon Chime Voice Connector group, such as -// the name and Amazon Chime Voice Connector priority ranking. This API is is no -// longer supported and will not be updated. We recommend using the latest version, -// UpdateVoiceConnectorGroup (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateVoiceConnectorGroup.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// the name and Amazon Chime Voice Connector priority ranking. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [UpdateVoiceConnectorGroup], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by UpdateVoiceConnectorGroup in the Amazon Chime SDK Voice // Namespace +// +// [UpdateVoiceConnectorGroup]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_UpdateVoiceConnectorGroup.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html 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 0bed2756291..17e4b782a54 100644 --- a/service/chime/api_op_ValidateE911Address.go +++ b/service/chime/api_op_ValidateE911Address.go @@ -14,16 +14,19 @@ import ( // Validates an address to be used for 911 calls made with Amazon Chime Voice // Connectors. You can use validated addresses in a Presence Information Data // Format Location Object file that you include in SIP requests. That helps ensure -// that addresses are routed to the appropriate Public Safety Answering Point. This -// API is is no longer supported and will not be updated. We recommend using the -// latest version, ValidateE911Address (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ValidateE911Address.html) -// , in the Amazon Chime SDK. Using the latest version requires migrating to a -// dedicated namespace. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. +// that addresses are routed to the appropriate Public Safety Answering Point. +// +// This API is is no longer supported and will not be updated. We recommend using +// the latest version, [ValidateE911Address], in the Amazon Chime SDK. +// +// Using the latest version requires migrating to a dedicated namespace. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. // // Deprecated: Replaced by ValidateE911Address in the Amazon Chime SDK Voice // Namespace +// +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [ValidateE911Address]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_voice-chime_ValidateE911Address.html func (c *Client) ValidateE911Address(ctx context.Context, params *ValidateE911AddressInput, optFns ...func(*Options)) (*ValidateE911AddressOutput, error) { if params == nil { params = &ValidateE911AddressInput{} diff --git a/service/chime/doc.go b/service/chime/doc.go index 157d108400c..0f2914c904f 100644 --- a/service/chime/doc.go +++ b/service/chime/doc.go @@ -3,36 +3,50 @@ // Package chime provides the API client, operations, and parameter types for // Amazon Chime. // -// Most of these APIs are no longer supported and will not be updated. We -// recommend using the latest versions in the Amazon Chime SDK API reference (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/welcome.html) -// , in the Amazon Chime SDK. Using the latest versions requires migrating to -// dedicated namespaces. For more information, refer to Migrating from the Amazon -// Chime namespace (https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html) -// in the Amazon Chime SDK Developer Guide. The Amazon Chime application -// programming interface (API) is designed so administrators can perform key tasks, -// such as creating and managing Amazon Chime accounts, users, and Voice -// Connectors. This guide provides detailed information about the Amazon Chime API, -// including operations, types, inputs and outputs, and error codes. You can use an -// AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API -// calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page -// for each API action contains a See Also section that includes links to -// information about using the action 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 +// Most of these APIs are no longer supported and will not be updated. We +// +// recommend using the latest versions in the [Amazon Chime SDK API reference], in the Amazon Chime SDK. +// +// Using the latest versions requires migrating to dedicated namespaces. For more +// information, refer to [Migrating from the Amazon Chime namespace]in the Amazon Chime SDK Developer Guide. +// +// The Amazon Chime application programming interface (API) is designed so +// administrators can perform key tasks, such as creating and managing Amazon Chime +// accounts, users, and Voice Connectors. This guide provides detailed information +// about the Amazon Chime API, including operations, types, inputs and outputs, and +// error codes. +// +// You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST +// API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS +// CLI. The page for each API action contains a See Also section that includes +// links to information about using the action 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 . +// access keys that you provide. For more information about AWS SDKs, see the [AWS Developer Center]. +// +// 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]in the AWS Command Line Interface +// User Guide. For a list of available Amazon Chime commands, see the [Amazon Chime commands]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]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 . +// // 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 -// the Amazon Chime Administration Guide. +// Management (IAM). For more information, see [Identity and Access Management for Amazon Chime]in the Amazon Chime Administration +// Guide. +// +// [Identity and Access Management for Amazon Chime]: https://docs.aws.amazon.com/chime/latest/ag/security-iam.html +// [Migrating from the Amazon Chime namespace]: https://docs.aws.amazon.com/chime-sdk/latest/dg/migrate-from-chm-namespace.html +// [Installing the AWS Command Line Interface]: https://docs.aws.amazon.com/cli/latest/userguide/installing.html +// [AWS Developer Center]: http://aws.amazon.com/developer/ +// [Amazon Chime SDK API reference]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/welcome.html +// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html +// [Amazon Chime commands]: https://docs.aws.amazon.com/cli/latest/reference/chime/index.html package chime diff --git a/service/chime/options.go b/service/chime/options.go index daea71c83fe..524f542f34c 100644 --- a/service/chime/options.go +++ b/service/chime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chime/types/enums.go b/service/chime/types/enums.go index dfc24d6672a..2ada837b1a2 100644 --- a/service/chime/types/enums.go +++ b/service/chime/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccountStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountStatus) Values() []AccountStatus { return []AccountStatus{ "Suspended", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AccountType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountType) Values() []AccountType { return []AccountType{ "Team", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for AppInstanceDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppInstanceDataType) Values() []AppInstanceDataType { return []AppInstanceDataType{ "Channel", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for ArtifactsState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactsState) Values() []ArtifactsState { return []ArtifactsState{ "Enabled", @@ -87,8 +91,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -104,8 +109,9 @@ const ( ) // Values returns all known values for BotType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotType) Values() []BotType { return []BotType{ "ChatBot", @@ -123,8 +129,9 @@ const ( ) // Values returns all known values for CallingNameStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallingNameStatus) Values() []CallingNameStatus { return []CallingNameStatus{ "Unassigned", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for Capability. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Capability) Values() []Capability { return []Capability{ "Voice", @@ -161,8 +169,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DEFAULT", @@ -180,8 +189,9 @@ const ( // Values returns all known values for ChannelMessagePersistenceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMessagePersistenceType) Values() []ChannelMessagePersistenceType { return []ChannelMessagePersistenceType{ "PERSISTENT", @@ -198,8 +208,9 @@ const ( ) // Values returns all known values for ChannelMessageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMessageType) Values() []ChannelMessageType { return []ChannelMessageType{ "STANDARD", @@ -216,8 +227,9 @@ const ( ) // Values returns all known values for ChannelMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMode) Values() []ChannelMode { return []ChannelMode{ "UNRESTRICTED", @@ -234,8 +246,9 @@ const ( ) // Values returns all known values for ChannelPrivacy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelPrivacy) Values() []ChannelPrivacy { return []ChannelPrivacy{ "PUBLIC", @@ -251,8 +264,9 @@ const ( ) // Values returns all known values for ContentMuxType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentMuxType) Values() []ContentMuxType { return []ContentMuxType{ "ContentOnly", @@ -269,8 +283,9 @@ const ( ) // Values returns all known values for EmailStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmailStatus) Values() []EmailStatus { return []EmailStatus{ "NotSent", @@ -301,8 +316,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -332,8 +348,9 @@ const ( ) // Values returns all known values for GeoMatchLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoMatchLevel) Values() []GeoMatchLevel { return []GeoMatchLevel{ "Country", @@ -351,8 +368,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -372,8 +390,9 @@ const ( ) // Values returns all known values for License. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (License) Values() []License { return []License{ "Basic", @@ -391,8 +410,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "S3Bucket", @@ -407,8 +427,9 @@ const ( ) // Values returns all known values for MediaPipelineSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineSourceType) Values() []MediaPipelineSourceType { return []MediaPipelineSourceType{ "ChimeSdkMeeting", @@ -427,8 +448,9 @@ const ( ) // Values returns all known values for MediaPipelineStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineStatus) Values() []MediaPipelineStatus { return []MediaPipelineStatus{ "Initializing", @@ -449,8 +471,9 @@ const ( ) // Values returns all known values for MemberType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberType) Values() []MemberType { return []MemberType{ "User", @@ -469,8 +492,9 @@ const ( ) // Values returns all known values for NotificationTarget. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationTarget) Values() []NotificationTarget { return []NotificationTarget{ "EventBridge", @@ -488,8 +512,9 @@ const ( ) // Values returns all known values for NumberSelectionBehavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumberSelectionBehavior) Values() []NumberSelectionBehavior { return []NumberSelectionBehavior{ "PreferSticky", @@ -508,6 +533,7 @@ const ( // 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{ @@ -527,6 +553,7 @@ const ( // 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{ @@ -548,6 +575,7 @@ const ( // Values returns all known values for PhoneNumberAssociationName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberAssociationName) Values() []PhoneNumberAssociationName { return []PhoneNumberAssociationName{ @@ -570,8 +598,9 @@ const ( ) // Values returns all known values for PhoneNumberOrderStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberOrderStatus) Values() []PhoneNumberOrderStatus { return []PhoneNumberOrderStatus{ "Processing", @@ -591,8 +620,9 @@ const ( ) // Values returns all known values for PhoneNumberProductType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberProductType) Values() []PhoneNumberProductType { return []PhoneNumberProductType{ "BusinessCalling", @@ -616,8 +646,9 @@ const ( ) // Values returns all known values for PhoneNumberStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberStatus) Values() []PhoneNumberStatus { return []PhoneNumberStatus{ "AcquireInProgress", @@ -640,8 +671,9 @@ const ( ) // Values returns all known values for PhoneNumberType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberType) Values() []PhoneNumberType { return []PhoneNumberType{ "Local", @@ -659,8 +691,9 @@ const ( ) // Values returns all known values for ProxySessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProxySessionStatus) Values() []ProxySessionStatus { return []ProxySessionStatus{ "Open", @@ -679,8 +712,9 @@ const ( ) // Values returns all known values for RegistrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationStatus) Values() []RegistrationStatus { return []RegistrationStatus{ "Unregistered", @@ -698,8 +732,9 @@ const ( ) // Values returns all known values for RoomMembershipRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoomMembershipRole) Values() []RoomMembershipRole { return []RoomMembershipRole{ "Administrator", @@ -716,8 +751,9 @@ const ( ) // Values returns all known values for SipRuleTriggerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SipRuleTriggerType) Values() []SipRuleTriggerType { return []SipRuleTriggerType{ "ToPhoneNumber", @@ -734,8 +770,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -752,8 +789,9 @@ const ( // Values returns all known values for TranscribeContentIdentificationType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeContentIdentificationType) Values() []TranscribeContentIdentificationType { return []TranscribeContentIdentificationType{ "PII", @@ -769,8 +807,9 @@ const ( // Values returns all known values for TranscribeContentRedactionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeContentRedactionType) Values() []TranscribeContentRedactionType { return []TranscribeContentRedactionType{ "PII", @@ -798,8 +837,9 @@ const ( ) // Values returns all known values for TranscribeLanguageCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeLanguageCode) Values() []TranscribeLanguageCode { return []TranscribeLanguageCode{ "en-US", @@ -828,8 +868,9 @@ const ( // Values returns all known values for TranscribeMedicalContentIdentificationType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalContentIdentificationType) Values() []TranscribeMedicalContentIdentificationType { return []TranscribeMedicalContentIdentificationType{ "PHI", @@ -845,8 +886,9 @@ const ( // Values returns all known values for TranscribeMedicalLanguageCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalLanguageCode) Values() []TranscribeMedicalLanguageCode { return []TranscribeMedicalLanguageCode{ "en-US", @@ -867,8 +909,9 @@ const ( ) // Values returns all known values for TranscribeMedicalRegion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalRegion) Values() []TranscribeMedicalRegion { return []TranscribeMedicalRegion{ "us-east-1", @@ -895,6 +938,7 @@ const ( // Values returns all known values for TranscribeMedicalSpecialty. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalSpecialty) Values() []TranscribeMedicalSpecialty { return []TranscribeMedicalSpecialty{ @@ -916,8 +960,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CONVERSATION", @@ -936,8 +981,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribePartialResultsStability) Values() []TranscribePartialResultsStability { return []TranscribePartialResultsStability{ "low", @@ -965,8 +1011,9 @@ const ( ) // Values returns all known values for TranscribeRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeRegion) Values() []TranscribeRegion { return []TranscribeRegion{ "us-east-2", @@ -995,8 +1042,9 @@ const ( // Values returns all known values for TranscribeVocabularyFilterMethod. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeVocabularyFilterMethod) Values() []TranscribeVocabularyFilterMethod { return []TranscribeVocabularyFilterMethod{ "remove", @@ -1014,8 +1062,9 @@ const ( ) // Values returns all known values for UserType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserType) Values() []UserType { return []UserType{ "PrivateUser", @@ -1031,8 +1080,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1048,8 +1098,9 @@ const ( ) // Values returns all known values for VoiceConnectorAwsRegion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceConnectorAwsRegion) Values() []VoiceConnectorAwsRegion { return []VoiceConnectorAwsRegion{ "us-east-1", diff --git a/service/chime/types/types.go b/service/chime/types/types.go index 44a8625d8cf..478cc783cc7 100644 --- a/service/chime/types/types.go +++ b/service/chime/types/types.go @@ -30,8 +30,9 @@ 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]in the Amazon Chime Administration Guide. + // + // [Managing Your Amazon Chime Accounts]: https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html AccountType AccountType // The Amazon Chime account creation timestamp, in ISO 8601 format. @@ -52,16 +53,18 @@ 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]in the Amazon Chime Administration Guide. +// +// [Use the Policies Page]: https://docs.aws.amazon.com/chime/latest/ag/policies.html 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) . + // number option. For more information, see [Join a Meeting without the Amazon Chime App]. + // + // [Join a Meeting without the Amazon Chime App]: https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html EnableDialOut *bool noSmithyDocumentSerde @@ -271,13 +274,15 @@ type ArtifactsConfiguration struct { noSmithyDocumentSerde } -// 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. @@ -794,8 +799,9 @@ type EngineTranscribeMedicalSettings struct { Type TranscribeMedicalType // Labels all personally identifiable information (PII) identified in your - // transcript. If you don't include PiiEntityTypes , all PII is identified. You - // can’t set ContentIdentificationType and ContentRedactionType . + // transcript. If you don't include PiiEntityTypes , all PII is identified. + // + // You can’t set ContentIdentificationType and ContentRedactionType . ContentIdentificationType TranscribeMedicalContentIdentificationType // The AWS Region passed to Amazon Transcribe Medical. If you don't specify a @@ -808,127 +814,168 @@ type EngineTranscribeMedicalSettings struct { noSmithyDocumentSerde } -// Settings specific for Amazon Transcribe as the live transcription engine. If -// you specify an invalid combination of parameters, a TranscriptFailed event will -// be sent with the contents of the BadRequestException generated by Amazon +// Settings specific for Amazon Transcribe as the live transcription engine. +// +// If you specify an invalid combination of parameters, a TranscriptFailed event +// will be sent with the contents of the BadRequestException generated by Amazon // Transcribe. For more information on each parameter and which combinations are -// valid, refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) -// API in the Amazon Transcribe Developer Guide. +// valid, refer to the [StartStreamTranscription]API in the Amazon Transcribe Developer Guide. +// +// [StartStreamTranscription]: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html type EngineTranscribeSettings struct { // Labels all personally identifiable information (PII) identified in your - // transcript. If you don't include PiiEntityTypes , all PII is identified. You - // can’t set ContentIdentificationType and ContentRedactionType . + // transcript. If you don't include PiiEntityTypes , all PII is identified. + // + // You can’t set ContentIdentificationType and ContentRedactionType . ContentIdentificationType TranscribeContentIdentificationType // Content redaction is performed at the segment level. If you don't include - // PiiEntityTypes , all PII is redacted. You can’t set ContentIdentificationType - // and ContentRedactionType . + // PiiEntityTypes , all PII is redacted. + // + // You can’t set ContentIdentificationType and ContentRedactionType . ContentRedactionType TranscribeContentRedactionType // Enables partial result stabilization for your transcription. Partial result // stabilization can reduce latency in your output, but may impact accuracy. EnablePartialResultsStabilization *bool - // Enables automatic language identification for your transcription. If you - // include IdentifyLanguage , you can optionally use LanguageOptions to include a - // list of language codes that you think may be present in your audio stream. - // Including language options can improve transcription accuracy. You can also use - // PreferredLanguage to include a preferred language. Doing so can help Amazon - // Transcribe identify the language faster. You must include either LanguageCode - // or IdentifyLanguage . 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 use LanguageOptions to + // include a list of language codes that you think may be present in your audio + // stream. Including language options can improve transcription accuracy. + // + // You can also use PreferredLanguage to include a preferred language. Doing so + // can help Amazon Transcribe identify the language faster. + // + // You must include either LanguageCode or IdentifyLanguage . + // + // Language identification can't be combined with custom language models or + // redaction. IdentifyLanguage *bool - // Specify the language code that represents the language spoken. If you're unsure - // of the language spoken in your audio, consider using IdentifyLanguage to enable - // automatic language identification. + // Specify the language code that represents the language spoken. + // + // If you're unsure of the language spoken in your audio, consider using + // IdentifyLanguage to enable automatic language identification. LanguageCode TranscribeLanguageCode // Specify the name of the custom language model that you want to use when // processing your transcription. Note that language model names are case - // sensitive. The language of the specified language model must match the language - // code. If the languages don't match, the custom language model isn't applied. - // There are no errors or warnings associated with a language mismatch. If you use - // Amazon Transcribe in multiple Regions, the custom language model must be - // available in Amazon Transcribe in each Region. + // sensitive. + // + // The language of the specified language model must match the language code. If + // the languages don't match, the custom language model isn't applied. There are no + // errors or warnings associated with a language mismatch. + // + // If you use Amazon Transcribe in multiple Regions, the custom language model + // must be available in Amazon Transcribe in each Region. 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 - // unsure what languages are present, do not include this parameter. Including - // language options can improve the accuracy of language identification. If you - // include LanguageOptions , you must also include IdentifyLanguage . You can only - // include one language dialect per language. For example, you cannot include en-US - // and en-AU . + // unsure what languages are present, do not include this parameter. + // + // Including language options can improve the accuracy of language identification. + // + // If you include LanguageOptions , you must also include IdentifyLanguage . + // + // You can only include one language dialect per language. For example, you cannot + // include en-US and en-AU . LanguageOptions *string // Specify 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. + // stabilization ( EnablePartialResultsStabilization ). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. PartialResultsStability TranscribePartialResultsStability // 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 . 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 . Note that if - // you include PiiEntityTypes , you must also include ContentIdentificationType or - // ContentRedactionType . If you include ContentRedactionType or - // ContentIdentificationType , but do not include PiiEntityTypes , all PII is - // redacted or identified. + // can select ALL . + // + // 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 . + // + // Note that if you include PiiEntityTypes , you must also include + // ContentIdentificationType or ContentRedactionType . + // + // If you include ContentRedactionType or ContentIdentificationType , but do not + // include PiiEntityTypes , all PII is redacted or identified. PiiEntityTypes *string // Specify a preferred language from the subset of languages codes you specified - // in LanguageOptions . You can only use this parameter if you include - // IdentifyLanguage and LanguageOptions . + // in LanguageOptions . + // + // You can only use this parameter if you include IdentifyLanguage and + // LanguageOptions . PreferredLanguage TranscribeLanguageCode - // The AWS Region in which to use Amazon Transcribe. If you don't specify a - // Region, then the MediaRegion parameter of the CreateMeeting.html (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html) - // API will be used. However, if Amazon Transcribe is not available in the - // MediaRegion , then a TranscriptFailed event is sent. Use auto to use Amazon - // Transcribe in a Region near the meeting’s MediaRegion . For more information, - // refer to Choosing a transcription Region (https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region) - // in the Amazon Chime SDK Developer Guide. + // The AWS Region in which to use Amazon Transcribe. + // + // If you don't specify a Region, then the MediaRegion parameter of the [CreateMeeting.html] API will + // be used. However, if Amazon Transcribe is not available in the MediaRegion , + // then a TranscriptFailed event is sent. + // + // Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion . + // For more information, refer to [Choosing a transcription Region]in the Amazon Chime SDK Developer Guide. + // + // [CreateMeeting.html]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html + // [Choosing a transcription Region]: https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region Region TranscribeRegion - // 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 . + // 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 . VocabularyFilterMethod TranscribeVocabularyFilterMethod // Specify the name of the custom vocabulary filter that you want to use when // processing your transcription. Note that vocabulary filter names are case - // sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary - // filter must be available in Amazon Transcribe in each Region. If you include - // IdentifyLanguage and want to use one or more vocabulary filters with your - // transcription, use the VocabularyFilterNames parameter instead. + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be + // available in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more vocabulary filters + // with your transcription, use the VocabularyFilterNames parameter instead. VocabularyFilterName *string // Specify the names of the custom vocabulary filters that you want to use when // processing your transcription. Note that vocabulary filter names are case - // sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary - // filter must be available in Amazon Transcribe in each Region. If you're not - // including IdentifyLanguage and want to use a custom vocabulary filter with your - // transcription, use the VocabularyFilterName parameter instead. + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be + // available in Amazon Transcribe in each Region. + // + // If you're not including IdentifyLanguage and want to use a custom vocabulary + // filter with your transcription, use the VocabularyFilterName parameter instead. VocabularyFilterNames *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 you use - // Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon - // Transcribe in each Region. If you include IdentifyLanguage and want to use one - // or more custom vocabularies with your transcription, use the VocabularyNames - // parameter instead. + // your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe multiple Regions, the vocabulary must be available + // in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more custom vocabularies + // with your transcription, use the VocabularyNames parameter instead. VocabularyName *string // Specify the names of the custom vocabularies that you want to use when - // processing your transcription. Note that vocabulary names are case sensitive. If - // you use Amazon Transcribe in multiple Regions, the vocabulary must be available - // in Amazon Transcribe in each Region. If you don't include IdentifyLanguage and - // want to use a custom vocabulary with your transcription, use the VocabularyName - // parameter instead. + // processing your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary must be + // available in Amazon Transcribe in each Region. + // + // If you don't include IdentifyLanguage and want to use a custom vocabulary with + // your transcription, use the VocabularyName parameter instead. VocabularyNames *string noSmithyDocumentSerde @@ -1061,23 +1108,31 @@ type MediaPlacement struct { // The event ingestion URL to which you send client meeting events. EventIngestionUrl *string - // The screen data URL. This parameter is is no longer supported and no longer - // used by the Amazon Chime SDK. + // The screen data URL. + // + // This parameter is is no longer supported and no longer used by the Amazon Chime + // SDK. ScreenDataUrl *string - // The screen sharing URL. This parameter is is no longer supported and no longer - // used by the Amazon Chime SDK.. + // The screen sharing URL. + // + // This parameter is is no longer supported and no longer used by the Amazon Chime + // SDK.. ScreenSharingUrl *string - // The screen viewing URL. This parameter is is no longer supported and no longer - // used by the Amazon Chime SDK. + // The screen viewing URL. + // + // This parameter is is no longer supported and no longer used by the Amazon Chime + // SDK. ScreenViewingUrl *string // The signaling URL. SignalingUrl *string - // The turn control URL. This parameter is is no longer supported and no longer - // used by the Amazon Chime SDK. + // The turn control URL. + // + // This parameter is is no longer supported and no longer used by the Amazon Chime + // SDK. TurnControlUrl *string noSmithyDocumentSerde @@ -1104,7 +1159,8 @@ type Meeting struct { noSmithyDocumentSerde } -// The resource target configurations for receiving Amazon Chime SDK meeting and +// 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 ). type MeetingNotificationConfiguration struct { @@ -1188,8 +1244,9 @@ type OrderedPhoneNumber struct { } // Origination settings enable your SIP hosts to receive inbound calls using your -// Amazon Chime Voice Connector. The parameters listed below are not required, but -// you must use at least one. +// Amazon Chime Voice Connector. +// +// The parameters listed below are not required, but you must use at least one. type Origination struct { // When origination settings are disabled, inbound calls are not enabled for your @@ -1207,8 +1264,9 @@ type Origination struct { // Origination routes define call distribution properties for your SIP hosts to // receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten -// origination routes for each Amazon Chime Voice Connector. The parameters listed -// below are not required, but you must use at least one. +// origination routes for each Amazon Chime Voice Connector. +// +// The parameters listed below are not required, but you must use at least one. type OriginationRoute struct { // The FQDN or IP address to contact for origination traffic. @@ -1785,7 +1843,7 @@ type TranscriptionConfiguration struct { } // The phone number ID, product type, or calling name fields to update, used with -// the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. +// the BatchUpdatePhoneNumberand UpdatePhoneNumber actions. type UpdatePhoneNumberRequestItem struct { // The phone number ID to update. @@ -1870,9 +1928,8 @@ type User struct { noSmithyDocumentSerde } -// 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. +// 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. type UserError struct { // The error code. @@ -1917,7 +1974,7 @@ type VideoArtifactsConfiguration struct { // and encryption settings. type VoiceConnector struct { - // The AWS Region in which the Amazon Chime Voice Connector is created. Default: + // The AWS Region in which the Amazon Chime Voice Connector is created. Default: // us-east-1 . AwsRegion VoiceConnectorAwsRegion diff --git a/service/chimesdkidentity/api_op_CreateAppInstance.go b/service/chimesdkidentity/api_op_CreateAppInstance.go index 20f38d7c04d..b65f84ab5ad 100644 --- a/service/chimesdkidentity/api_op_CreateAppInstance.go +++ b/service/chimesdkidentity/api_op_CreateAppInstance.go @@ -13,7 +13,9 @@ import ( // 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 +// 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 { params = &CreateAppInstanceInput{} diff --git a/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go b/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go index af4e759351f..b54d6725987 100644 --- a/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go +++ b/service/chimesdkidentity/api_op_CreateAppInstanceAdmin.go @@ -13,7 +13,9 @@ import ( // 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. // // Only an AppInstanceUser and AppInstanceBot can be promoted to an diff --git a/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go b/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go index 97e555b44cb..4ce285206dd 100644 --- a/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go +++ b/service/chimesdkidentity/api_op_PutAppInstanceUserExpirationSettings.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the number of days before the AppInstanceUser is automatically deleted. A -// background process deletes expired AppInstanceUsers within 6 hours of -// expiration. Actual deletion times may vary. Expired AppInstanceUsers that have -// not yet been deleted appear as active, and you can update their expiration -// settings. The system honors the new settings. +// Sets the number of days before the AppInstanceUser is automatically deleted. +// +// A background process deletes expired AppInstanceUsers within 6 hours of +// expiration. Actual deletion times may vary. +// +// Expired AppInstanceUsers that have not yet been deleted appear as active, and +// you can update their expiration settings. The system honors the new settings. func (c *Client) PutAppInstanceUserExpirationSettings(ctx context.Context, params *PutAppInstanceUserExpirationSettingsInput, optFns ...func(*Options)) (*PutAppInstanceUserExpirationSettingsOutput, error) { if params == nil { params = &PutAppInstanceUserExpirationSettingsInput{} diff --git a/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go b/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go index 73c5ee7ddba..e954adbb8e9 100644 --- a/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go +++ b/service/chimesdkidentity/api_op_RegisterAppInstanceUserEndpoint.go @@ -53,10 +53,14 @@ type RegisterAppInstanceUserEndpointInput struct { 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 . // // This member is required. diff --git a/service/chimesdkidentity/doc.go b/service/chimesdkidentity/doc.go index 185bccda9ec..b21723a858b 100644 --- a/service/chimesdkidentity/doc.go +++ b/service/chimesdkidentity/doc.go @@ -6,6 +6,7 @@ // 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]. +// +// [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/options.go b/service/chimesdkidentity/options.go index ab06461c37d..b50fad143d2 100644 --- a/service/chimesdkidentity/options.go +++ b/service/chimesdkidentity/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chimesdkidentity/types/enums.go b/service/chimesdkidentity/types/enums.go index 1937da8229a..eab2a56ff09 100644 --- a/service/chimesdkidentity/types/enums.go +++ b/service/chimesdkidentity/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AllowMessages. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllowMessages) Values() []AllowMessages { return []AllowMessages{ "ALL", @@ -31,6 +32,7 @@ const ( // Values returns all known values for AppInstanceUserEndpointType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AppInstanceUserEndpointType) Values() []AppInstanceUserEndpointType { return []AppInstanceUserEndpointType{ @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for EndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointStatus) Values() []EndpointStatus { return []EndpointStatus{ "ACTIVE", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for EndpointStatusReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointStatusReason) Values() []EndpointStatusReason { return []EndpointStatusReason{ "INVALID_DEVICE_TOKEN", @@ -98,8 +102,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -128,8 +133,9 @@ const ( ) // Values returns all known values for ExpirationCriterion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpirationCriterion) Values() []ExpirationCriterion { return []ExpirationCriterion{ "CREATED_TIMESTAMP", @@ -144,8 +150,9 @@ const ( ) // Values returns all known values for RespondsTo. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RespondsTo) Values() []RespondsTo { return []RespondsTo{ "STANDARD_MESSAGES", @@ -163,8 +170,9 @@ const ( ) // Values returns all known values for StandardMessages. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StandardMessages) Values() []StandardMessages { return []StandardMessages{ "AUTO", @@ -183,8 +191,9 @@ const ( ) // Values returns all known values for TargetedMessages. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetedMessages) Values() []TargetedMessages { return []TargetedMessages{ "ALL", diff --git a/service/chimesdkidentity/types/types.go b/service/chimesdkidentity/types/types.go index e51d77644ff..d01d1fa8ed1 100644 --- a/service/chimesdkidentity/types/types.go +++ b/service/chimesdkidentity/types/types.go @@ -164,13 +164,17 @@ type AppInstanceUserEndpoint struct { // 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. EndpointState *EndpointState @@ -267,13 +271,17 @@ type EndpointAttributes struct { // 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. type EndpointState struct { @@ -321,20 +329,26 @@ type Identity struct { type InvokedBy struct { // Sets standard messages as the bot trigger. For standard messages: + // // - ALL : The bot processes all standard messages. + // // - AUTO : The bot responds to ALL messages when the channel has one other // non-hidden member, and responds to MENTIONS when the channel has more than one // other non-hidden member. + // // - MENTIONS : The bot processes all standard messages that have a message // attribute with CHIME.mentions and a value of the bot ARN. + // // - NONE : The bot processes no standard messages. // // This member is required. StandardMessages StandardMessages // Sets targeted messages as the bot trigger. For targeted messages: + // // - ALL : The bot processes all TargetedMessages sent to it. The bot then // responds with a targeted message back to the sender. + // // - NONE : The bot processes no targeted messages. // // This member is required. @@ -354,18 +368,21 @@ 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) + // and slots used in the bot must have the same locale. For more information, see [Supported languages] // in the Amazon Lex V2 Developer Guide. // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html + // // This member is required. LocaleId *string // Specifies the type of message that triggers a bot. InvokedBy *InvokedBy - // Deprecated. Use InvokedBy instead. Determines whether the Amazon Lex V2 bot - // responds to all standard messages. Control messages are not supported. + // Deprecated. Use InvokedBy instead. + // + // Determines whether the Amazon Lex V2 bot responds to all standard messages. + // Control messages are not supported. RespondsTo RespondsTo // The name of the welcome intent configured in the Amazon Lex V2 bot. diff --git a/service/chimesdkmediapipelines/api_op_StartSpeakerSearchTask.go b/service/chimesdkmediapipelines/api_op_StartSpeakerSearchTask.go index 2354679bc85..9b0f3dea778 100644 --- a/service/chimesdkmediapipelines/api_op_StartSpeakerSearchTask.go +++ b/service/chimesdkmediapipelines/api_op_StartSpeakerSearchTask.go @@ -11,10 +11,13 @@ 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]for the Amazon Chime SDK. +// +// [AWS service terms]: https://aws.amazon.com/service-terms/ func (c *Client) StartSpeakerSearchTask(ctx context.Context, params *StartSpeakerSearchTaskInput, optFns ...func(*Options)) (*StartSpeakerSearchTaskOutput, error) { if params == nil { params = &StartSpeakerSearchTaskInput{} diff --git a/service/chimesdkmediapipelines/api_op_StartVoiceToneAnalysisTask.go b/service/chimesdkmediapipelines/api_op_StartVoiceToneAnalysisTask.go index db8181de2ba..8e0ffa317ad 100644 --- a/service/chimesdkmediapipelines/api_op_StartVoiceToneAnalysisTask.go +++ b/service/chimesdkmediapipelines/api_op_StartVoiceToneAnalysisTask.go @@ -12,12 +12,14 @@ 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/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 -// SDK. +// analysis, see [Using Amazon Chime SDK voice analytics]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]for the Amazon Chime SDK. +// +// [Using Amazon Chime SDK voice analytics]: https://docs.aws.amazon.com/chime-sdk/latest/dg/voice-analytics.html +// [AWS service terms]: https://aws.amazon.com/service-terms/ func (c *Client) StartVoiceToneAnalysisTask(ctx context.Context, params *StartVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*StartVoiceToneAnalysisTaskOutput, error) { if params == nil { params = &StartVoiceToneAnalysisTaskInput{} diff --git a/service/chimesdkmediapipelines/doc.go b/service/chimesdkmediapipelines/doc.go index 28fa673056e..edd3801f9db 100644 --- a/service/chimesdkmediapipelines/doc.go +++ b/service/chimesdkmediapipelines/doc.go @@ -6,6 +6,7 @@ // 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]. +// +// [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/options.go b/service/chimesdkmediapipelines/options.go index aa4bc74301a..2367c1ec289 100644 --- a/service/chimesdkmediapipelines/options.go +++ b/service/chimesdkmediapipelines/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chimesdkmediapipelines/types/enums.go b/service/chimesdkmediapipelines/types/enums.go index b357ddc343b..316f0b69b65 100644 --- a/service/chimesdkmediapipelines/types/enums.go +++ b/service/chimesdkmediapipelines/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for ActiveSpeakerPosition. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActiveSpeakerPosition) Values() []ActiveSpeakerPosition { return []ActiveSpeakerPosition{ "TopLeft", @@ -34,6 +35,7 @@ const ( // Values returns all known values for ArtifactsConcatenationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactsConcatenationState) Values() []ArtifactsConcatenationState { return []ArtifactsConcatenationState{ @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for ArtifactsState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactsState) Values() []ArtifactsState { return []ArtifactsState{ "Enabled", @@ -69,8 +72,9 @@ const ( // Values returns all known values for AudioArtifactsConcatenationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioArtifactsConcatenationState) Values() []AudioArtifactsConcatenationState { return []AudioArtifactsConcatenationState{ "Enabled", @@ -86,8 +90,9 @@ const ( ) // Values returns all known values for AudioChannelsOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioChannelsOption) Values() []AudioChannelsOption { return []AudioChannelsOption{ "Stereo", @@ -105,8 +110,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -128,8 +134,9 @@ const ( ) // Values returns all known values for BorderColor. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BorderColor) Values() []BorderColor { return []BorderColor{ "Black", @@ -158,6 +165,7 @@ const ( // Values returns all known values for CallAnalyticsLanguageCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CallAnalyticsLanguageCode) Values() []CallAnalyticsLanguageCode { return []CallAnalyticsLanguageCode{ @@ -182,8 +190,9 @@ const ( ) // Values returns all known values for CanvasOrientation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CanvasOrientation) Values() []CanvasOrientation { return []CanvasOrientation{ "Landscape", @@ -199,8 +208,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "S3Bucket", @@ -215,8 +225,9 @@ const ( ) // Values returns all known values for ConcatenationSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConcatenationSourceType) Values() []ConcatenationSourceType { return []ConcatenationSourceType{ "MediaCapturePipeline", @@ -231,8 +242,9 @@ const ( ) // Values returns all known values for ContentMuxType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentMuxType) Values() []ContentMuxType { return []ContentMuxType{ "ContentOnly", @@ -248,8 +260,9 @@ const ( ) // Values returns all known values for ContentRedactionOutput. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentRedactionOutput) Values() []ContentRedactionOutput { return []ContentRedactionOutput{ "redacted", @@ -269,6 +282,7 @@ const ( // 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{ @@ -287,8 +301,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "PII", @@ -309,8 +324,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -332,8 +348,9 @@ const ( ) // Values returns all known values for FragmentSelectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FragmentSelectorType) Values() []FragmentSelectorType { return []FragmentSelectorType{ "ProducerTimestamp", @@ -354,8 +371,9 @@ const ( ) // Values returns all known values for HighlightColor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HighlightColor) Values() []HighlightColor { return []HighlightColor{ "Black", @@ -376,8 +394,9 @@ const ( ) // Values returns all known values for HorizontalTilePosition. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HorizontalTilePosition) Values() []HorizontalTilePosition { return []HorizontalTilePosition{ "Top", @@ -398,8 +417,9 @@ const ( // Values returns all known values for KinesisVideoStreamPoolStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KinesisVideoStreamPoolStatus) Values() []KinesisVideoStreamPoolStatus { return []KinesisVideoStreamPoolStatus{ "CREATING", @@ -418,8 +438,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -435,8 +456,9 @@ const ( ) // Values returns all known values for LiveConnectorMuxType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LiveConnectorMuxType) Values() []LiveConnectorMuxType { return []LiveConnectorMuxType{ "AudioWithCompositedVideo", @@ -452,8 +474,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RTMP", @@ -468,8 +491,9 @@ const ( ) // Values returns all known values for LiveConnectorSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LiveConnectorSourceType) Values() []LiveConnectorSourceType { return []LiveConnectorSourceType{ "ChimeSdkMeeting", @@ -484,8 +508,9 @@ const ( ) // Values returns all known values for MediaEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaEncoding) Values() []MediaEncoding { return []MediaEncoding{ "pcm", @@ -509,8 +534,9 @@ const ( // Values returns all known values for // MediaInsightsPipelineConfigurationElementType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaInsightsPipelineConfigurationElementType) Values() []MediaInsightsPipelineConfigurationElementType { return []MediaInsightsPipelineConfigurationElementType{ "AmazonTranscribeCallAnalyticsProcessor", @@ -541,6 +567,7 @@ const ( // Values returns all known values for MediaPipelineElementStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineElementStatus) Values() []MediaPipelineElementStatus { return []MediaPipelineElementStatus{ @@ -563,8 +590,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "S3Bucket", @@ -579,8 +607,9 @@ const ( ) // Values returns all known values for MediaPipelineSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineSourceType) Values() []MediaPipelineSourceType { return []MediaPipelineSourceType{ "ChimeSdkMeeting", @@ -601,8 +630,9 @@ const ( ) // Values returns all known values for MediaPipelineStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineStatus) Values() []MediaPipelineStatus { return []MediaPipelineStatus{ "Initializing", @@ -625,6 +655,7 @@ const ( // Values returns all known values for MediaPipelineStatusUpdate. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineStatusUpdate) Values() []MediaPipelineStatusUpdate { return []MediaPipelineStatusUpdate{ @@ -646,8 +677,9 @@ const ( ) // Values returns all known values for MediaPipelineTaskStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaPipelineTaskStatus) Values() []MediaPipelineTaskStatus { return []MediaPipelineTaskStatus{ "NotStarted", @@ -668,6 +700,7 @@ const ( // Values returns all known values for MediaStreamPipelineSinkType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MediaStreamPipelineSinkType) Values() []MediaStreamPipelineSinkType { return []MediaStreamPipelineSinkType{ @@ -684,8 +717,9 @@ const ( ) // Values returns all known values for MediaStreamType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaStreamType) Values() []MediaStreamType { return []MediaStreamType{ "MixedAudio", @@ -703,8 +737,9 @@ const ( ) // Values returns all known values for PartialResultsStability. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartialResultsStability) Values() []PartialResultsStability { return []PartialResultsStability{ "high", @@ -722,8 +757,9 @@ const ( ) // Values returns all known values for ParticipantRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantRole) Values() []ParticipantRole { return []ParticipantRole{ "AGENT", @@ -742,8 +778,9 @@ const ( ) // Values returns all known values for PresenterPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresenterPosition) Values() []PresenterPosition { return []PresenterPosition{ "TopLeft", @@ -763,8 +800,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "KeywordMatch", @@ -782,8 +820,9 @@ const ( ) // Values returns all known values for RecordingFileFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordingFileFormat) Values() []RecordingFileFormat { return []RecordingFileFormat{ "Wav", @@ -800,8 +839,9 @@ const ( ) // Values returns all known values for ResolutionOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolutionOption) Values() []ResolutionOption { return []ResolutionOption{ "HD", @@ -817,8 +857,9 @@ const ( ) // Values returns all known values for SentimentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SentimentType) Values() []SentimentType { return []SentimentType{ "NEGATIVE", @@ -834,8 +875,9 @@ const ( ) // Values returns all known values for TileOrder. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TileOrder) Values() []TileOrder { return []TileOrder{ "JoinSequence", @@ -852,8 +894,9 @@ const ( ) // Values returns all known values for VerticalTilePosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerticalTilePosition) Values() []VerticalTilePosition { return []VerticalTilePosition{ "Left", @@ -869,8 +912,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -887,8 +931,9 @@ const ( ) // Values returns all known values for VocabularyFilterMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VocabularyFilterMethod) Values() []VocabularyFilterMethod { return []VocabularyFilterMethod{ "remove", @@ -907,8 +952,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceAnalyticsConfigurationStatus) Values() []VoiceAnalyticsConfigurationStatus { return []VoiceAnalyticsConfigurationStatus{ "Enabled", @@ -925,6 +971,7 @@ const ( // Values returns all known values for VoiceAnalyticsLanguageCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VoiceAnalyticsLanguageCode) Values() []VoiceAnalyticsLanguageCode { return []VoiceAnalyticsLanguageCode{ diff --git a/service/chimesdkmediapipelines/types/types.go b/service/chimesdkmediapipelines/types/types.go index f2b647b2190..23266497e02 100644 --- a/service/chimesdkmediapipelines/types/types.go +++ b/service/chimesdkmediapipelines/types/types.go @@ -31,28 +31,38 @@ type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { CallAnalyticsStreamCategories []string // 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. + // 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] in the Amazon Transcribe Developer Guide. + // + // [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html 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. + // 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] in the Amazon Transcribe Developer Guide. + // + // [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html 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) - // in the Amazon Transcribe Developer Guide. + // more information, see [Partial-result stabilization]in the Amazon Transcribe Developer Guide. + // + // [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization EnablePartialResultsStabilization bool // If true, UtteranceEvents with IsPartial: true are filtered out of the insights @@ -60,56 +70,81 @@ type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { FilterPartialResults bool // Specifies the name of the custom language model to use when processing a - // transcription. Note that language model names are case sensitive. The language - // 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) - // in the Amazon Transcribe Developer Guide. + // transcription. Note that language model names are case sensitive. + // + // The language 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] in the Amazon Transcribe Developer Guide. + // + // [Custom language models]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html LanguageModelName *string // Specifies 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) - // in the Amazon Transcribe Developer Guide. + // stabilization ( EnablePartialResultsStabilization ). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. + // + // For more information, see [Partial-result stabilization] in the Amazon Transcribe Developer Guide. + // + // [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization 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. + // . + // + // 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 . + // 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 . VocabularyFilterMethod VocabularyFilterMethod // Specifies the name of the custom vocabulary filter to use when processing a - // transcription. Note that vocabulary filter names are case 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) - // in the Amazon Transcribe Developer Guide. Length Constraints: Minimum length of - // 1. Maximum length of 200. + // transcription. Note that vocabulary filter names are case 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] in the Amazon Transcribe Developer Guide. + // + // Length Constraints: Minimum length of 1. Maximum length of 200. + // + // [Using vocabulary filtering with unwanted words]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html 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. + // 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] in the Amazon Transcribe Developer Guide. + // + // Length Constraints: Minimum length of 1. Maximum length of 200. + // + // [Custom vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html VocabularyName *string noSmithyDocumentSerde @@ -120,28 +155,39 @@ type AmazonTranscribeCallAnalyticsProcessorConfiguration struct { 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. + // 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] in the Amazon Transcribe Developer Guide. + // + // [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html 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. + // 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] in the Amazon Transcribe Developer Guide. + // + // [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html 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) - // in the Amazon Transcribe Developer Guide. + // stabilization can reduce latency in your output, but may impact accuracy. + // + // For more information, see [Partial-result stabilization] in the Amazon Transcribe Developer Guide. + // + // [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization EnablePartialResultsStabilization bool // If true, TranscriptEvents with IsPartial: true are filtered out of the insights @@ -151,20 +197,28 @@ type AmazonTranscribeProcessorConfiguration struct { // Turns language identification on or off. IdentifyLanguage bool - // 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. + // 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] in the + // Amazon Transcribe Developer Guide. + // + // [Supported languages table]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageCode CallAnalyticsLanguageCode // The name of the custom language model that you want to use when processing your - // transcription. Note that language model names are case sensitive. The language - // 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) - // in the Amazon Transcribe Developer Guide. + // transcription. Note that language model names are case sensitive. + // + // The language 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] in the Amazon Transcribe Developer Guide. + // + // [Custom language models]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html LanguageModelName *string // The language options for the transcription, such as automatic language @@ -172,20 +226,27 @@ type AmazonTranscribeProcessorConfiguration struct { LanguageOptions *string // 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) - // in the Amazon Transcribe Developer Guide. + // EnablePartialResultsStabilization ). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. + // + // For more information, see [Partial-result stabilization] in the Amazon Transcribe Developer Guide. + // + // [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization 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 . + // // 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 . If you leave this parameter empty, - // the default behavior is equivalent to ALL . + // EMAIL , NAME , PHONE , PIN , SSN , or ALL . + // + // If you leave this parameter empty, the default behavior is equivalent to ALL . PiiEntityTypes *string // The preferred language for the transcription. @@ -193,23 +254,29 @@ type AmazonTranscribeProcessorConfiguration struct { // 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. + // file. + // + // For more information, see [Partitioning speakers (diarization)] in the Amazon Transcribe Developer Guide. + // + // [Partitioning speakers (diarization)]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html ShowSpeakerLabel bool // The vocabulary filtering method used in your Call Analytics transcription. VocabularyFilterMethod VocabularyFilterMethod // The name of the custom vocabulary filter that you specified in your Call - // Analytics request. Length Constraints: Minimum length of 1. Maximum length of - // 200. + // Analytics request. + // + // Length Constraints: Minimum length of 1. Maximum length of 200. VocabularyFilterName *string // The names of the custom vocabulary filter or filters using during transcription. VocabularyFilterNames *string // The name of the custom vocabulary that you specified in your Call Analytics - // request. Length Constraints: Minimum length of 1. Maximum length of 200. + // request. + // + // Length Constraints: Minimum length of 1. Maximum length of 200. VocabularyName *string // The names of the custom vocabulary or vocabularies used during transcription. @@ -467,12 +534,17 @@ type DataChannelConcatenationConfiguration struct { } // 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 // // A fragment selector range with a start time of 00:00:01 and end time of @@ -480,8 +552,9 @@ type DataChannelConcatenationConfiguration struct { type FragmentSelector struct { // The origin of the timestamps to use, Server or Producer . For more information, - // see StartSelectorType (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_StartSelector.html) - // in the Amazon Kinesis Video Streams Developer Guide. + // see [StartSelectorType]in the Amazon Kinesis Video Streams Developer Guide. + // + // [StartSelectorType]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_StartSelector.html // // This member is required. FragmentSelectorType FragmentSelectorType @@ -674,9 +747,11 @@ type KinesisVideoStreamRecordingSourceRuntimeConfiguration struct { 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) - // in the Amazon Transcribe Developer Guide. + // 16-bit little-endian audio formats, which does not include WAV) + // + // For more information, see [Media formats] in the Amazon Transcribe Developer Guide. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio // // This member is required. MediaEncoding MediaEncoding @@ -684,8 +759,9 @@ type KinesisVideoStreamSourceRuntimeConfiguration struct { // The sample rate of the input audio (in hertz). Low-quality audio, such as // telephone audio, is typically around 8,000 Hz. High-quality audio typically // ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must - // match that of your audio. Valid Range: Minimum value of 8000. Maximum value of - // 48000. + // match that of your audio. + // + // Valid Range: Minimum value of 8000. Maximum value of 48000. // // This member is required. MediaSampleRate *int32 @@ -1160,17 +1236,22 @@ type MeetingEventsConcatenationConfiguration struct { // Allows you to specify additional settings for your Call Analytics post-call // request, including output locations for your redacted transcript, which IAM role -// to use, and which encryption key to use. DataAccessRoleArn and OutputLocation -// are required fields. PostCallAnalyticsSettings provides the same insights as a -// Call Analytics post-call transcription. For more information, refer to -// 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. +// to use, and which encryption key to use. +// +// DataAccessRoleArn and OutputLocation are required fields. +// +// PostCallAnalyticsSettings provides the same insights as a Call Analytics +// post-call transcription. For more information, refer to [Post-call analytics with real-time transcriptions]in the Amazon +// Transcribe Developer Guide. +// +// [Post-call analytics with real-time transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html 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. + // call analysis. For more information, see [Post-call analytics with real-time transcriptions]in the Amazon Transcribe Developer + // Guide. + // + // [Post-call analytics with real-time transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html // // This member is required. DataAccessRoleArn *string diff --git a/service/chimesdkmeetings/api_op_BatchCreateAttendee.go b/service/chimesdkmeetings/api_op_BatchCreateAttendee.go index dc198eba68e..d115ddb49dd 100644 --- a/service/chimesdkmeetings/api_op_BatchCreateAttendee.go +++ b/service/chimesdkmeetings/api_op_BatchCreateAttendee.go @@ -12,8 +12,9 @@ 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]in the Amazon Chime Developer Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html 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 c6f272ffe8a..57224973a73 100644 --- a/service/chimesdkmeetings/api_op_BatchUpdateAttendeeCapabilitiesExcept.go +++ b/service/chimesdkmeetings/api_op_BatchUpdateAttendeeCapabilitiesExcept.go @@ -12,24 +12,32 @@ import ( ) // Updates AttendeeCapabilities except the capabilities listed in an -// ExcludedAttendeeIds table. 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: +// ExcludedAttendeeIds table. +// +// 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: +// // - If you specify MeetingFeatures:Video:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Video will be rejected with ValidationError 400 . +// // - If you specify MeetingFeatures:Content:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Content will be rejected with ValidationError 400 . +// // - 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 attendees can receive those streams, but only after media renegotiation diff --git a/service/chimesdkmeetings/api_op_CreateAttendee.go b/service/chimesdkmeetings/api_op_CreateAttendee.go index abe0e6ab0b2..4ae0a863a4b 100644 --- a/service/chimesdkmeetings/api_op_CreateAttendee.go +++ b/service/chimesdkmeetings/api_op_CreateAttendee.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Amazon Chime Developer +// Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html func (c *Client) CreateAttendee(ctx context.Context, params *CreateAttendeeInput, optFns ...func(*Options)) (*CreateAttendeeOutput, error) { if params == nil { params = &CreateAttendeeInput{} @@ -32,9 +35,12 @@ func (c *Client) CreateAttendee(ctx context.Context, params *CreateAttendeeInput type CreateAttendeeInput struct { // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. Pattern: - // [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are - // reserved. You can't configure a value that uses this prefix. + // to an identity managed by a builder application. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // + // Values that begin with aws: are reserved. You can't configure a value that uses + // this prefix. // // This member is required. ExternalUserId *string @@ -46,24 +52,32 @@ type CreateAttendeeInput struct { // 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: + // 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: + // // - If you specify MeetingFeatures:Video:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Video will be rejected with ValidationError 400 . + // // - If you specify MeetingFeatures:Content:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Content will be rejected with ValidationError 400 . + // // - 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 attendees can receive those streams, but only after media renegotiation diff --git a/service/chimesdkmeetings/api_op_CreateMeeting.go b/service/chimesdkmeetings/api_op_CreateMeeting.go index dbf0ac1203b..51d8333fae9 100644 --- a/service/chimesdkmeetings/api_op_CreateMeeting.go +++ b/service/chimesdkmeetings/api_op_CreateMeeting.go @@ -12,11 +12,12 @@ 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. +// initial attendees. For more information about specifying media Regions, see [Amazon Chime SDK Media Regions]in +// the Amazon Chime Developer Guide. For more information about the Amazon Chime +// SDK, see [Using the Amazon Chime SDK]in the Amazon Chime Developer Guide. +// +// [Amazon Chime SDK Media Regions]: https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html func (c *Client) CreateMeeting(ctx context.Context, params *CreateMeetingInput, optFns ...func(*Options)) (*CreateMeetingOutput, error) { if params == nil { params = &CreateMeetingInput{} @@ -40,17 +41,23 @@ type CreateMeetingInput struct { // This member is required. ClientRequestToken *string - // The external meeting ID. Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // The external meeting ID. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // // Values that begin with aws: are reserved. You can't configure a value that uses // this prefix. Case insensitive. // // 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 . + // 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 Amazon Web Services GovCloud (US) Regions: us-gov-east-1 , // us-gov-west-1 . // @@ -73,32 +80,46 @@ 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. + // support tagging using this operation, see [Services that support the Resource Groups Tagging API]. 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]in the AWS + // 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 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 + // 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. + // + // [Services that support the Resource Groups Tagging API]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html + // [Tag Naming and Usage Conventions]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions Tags []types.Tag // A consistent and opaque identifier, created and maintained by the builder to diff --git a/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go b/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go index d4e1b207cee..5b2aa213fb4 100644 --- a/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go +++ b/service/chimesdkmeetings/api_op_CreateMeetingWithAttendees.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the +// Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, +// see [Using the Amazon Chime SDK]in the Amazon Chime Developer Guide. +// +// [Amazon Chime SDK Media Regions]: https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html func (c *Client) CreateMeetingWithAttendees(ctx context.Context, params *CreateMeetingWithAttendeesInput, optFns ...func(*Options)) (*CreateMeetingWithAttendeesOutput, error) { if params == nil { params = &CreateMeetingWithAttendeesInput{} @@ -45,17 +47,23 @@ type CreateMeetingWithAttendeesInput struct { // This member is required. ClientRequestToken *string - // The external meeting ID. Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // The external meeting ID. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // // Values that begin with aws: are reserved. You can't configure a value that uses // this prefix. Case insensitive. // // 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 . + // 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 Amazon Web Services GovCloud (US) Regions: us-gov-east-1 , // us-gov-west-1 . // diff --git a/service/chimesdkmeetings/api_op_DeleteAttendee.go b/service/chimesdkmeetings/api_op_DeleteAttendee.go index 59331a55452..3257b06b343 100644 --- a/service/chimesdkmeetings/api_op_DeleteAttendee.go +++ b/service/chimesdkmeetings/api_op_DeleteAttendee.go @@ -12,9 +12,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 -// 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. +// meeting is deleted. For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the +// Amazon Chime Developer Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html 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_DeleteMeeting.go b/service/chimesdkmeetings/api_op_DeleteMeeting.go index fff9817c928..2473837780f 100644 --- a/service/chimesdkmeetings/api_op_DeleteMeeting.go +++ b/service/chimesdkmeetings/api_op_DeleteMeeting.go @@ -12,9 +12,10 @@ import ( // Deletes the specified Amazon Chime SDK meeting. The operation deletes all // attendees, disconnects all clients, and prevents new clients from joining the -// 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. +// meeting. For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon +// Chime Developer Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html func (c *Client) DeleteMeeting(ctx context.Context, params *DeleteMeetingInput, optFns ...func(*Options)) (*DeleteMeetingOutput, error) { if params == nil { params = &DeleteMeetingInput{} diff --git a/service/chimesdkmeetings/api_op_GetAttendee.go b/service/chimesdkmeetings/api_op_GetAttendee.go index 0de5953cc6b..04b8ad09c26 100644 --- a/service/chimesdkmeetings/api_op_GetAttendee.go +++ b/service/chimesdkmeetings/api_op_GetAttendee.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the Amazon Chime SDK attendee details for a specified meeting ID and -// attendee 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 attendee details for a specified meeting ID and +// +// attendee ID. For more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon +// Chime Developer Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html func (c *Client) GetAttendee(ctx context.Context, params *GetAttendeeInput, optFns ...func(*Options)) (*GetAttendeeOutput, error) { if params == nil { params = &GetAttendeeInput{} diff --git a/service/chimesdkmeetings/api_op_GetMeeting.go b/service/chimesdkmeetings/api_op_GetMeeting.go index 72d87083cc6..536685aa14e 100644 --- a/service/chimesdkmeetings/api_op_GetMeeting.go +++ b/service/chimesdkmeetings/api_op_GetMeeting.go @@ -12,8 +12,10 @@ import ( ) // 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. +// more information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon Chime Developer +// Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html 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 251de15344a..642f67af490 100644 --- a/service/chimesdkmeetings/api_op_ListAttendees.go +++ b/service/chimesdkmeetings/api_op_ListAttendees.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Lists the attendees for the specified Amazon Chime SDK meeting. For more +// +// information about the Amazon Chime SDK, see [Using the Amazon Chime SDK]in the Amazon Chime Developer +// Guide. +// +// [Using the Amazon Chime SDK]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html 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 f33e8cb8063..790b127f024 100644 --- a/service/chimesdkmeetings/api_op_StartMeetingTranscription.go +++ b/service/chimesdkmeetings/api_op_StartMeetingTranscription.go @@ -12,24 +12,28 @@ import ( ) // 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. If you specify an invalid -// configuration, a TranscriptFailed event will be sent with the contents of the -// BadRequestException generated by Amazon Transcribe. For more information on each -// parameter and which combinations are valid, refer to the -// StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) -// API in the Amazon Transcribe Developer Guide. By default, Amazon Transcribe may -// use and store audio content processed by the service to develop and improve -// Amazon Web Services AI/ML services as further described in section 50 of the -// Amazon Web Services Service Terms (https://aws.amazon.com/service-terms/) . -// Using Amazon Transcribe may be subject to federal and state laws or regulations -// regarding the recording or interception of electronic communications. It is your -// and your end users’ responsibility to comply with all applicable laws regarding -// the recording, including properly notifying all participants in a recorded -// session or communication that the session or communication is being recorded, -// and obtaining all necessary consents. You can opt out from Amazon Web Services -// using audio content to develop and improve AWS AI/ML services by configuring an -// AI services opt out policy using Amazon Web Services Organizations. +// to [Using Amazon Chime SDK live transcription]in the Amazon Chime SDK Developer Guide. +// +// If you specify an invalid configuration, a TranscriptFailed event will be sent +// with the contents of the BadRequestException generated by Amazon Transcribe. +// For more information on each parameter and which combinations are valid, refer +// to the [StartStreamTranscription]API in the Amazon Transcribe Developer Guide. +// +// By default, Amazon Transcribe may use and store audio content processed by the +// service to develop and improve Amazon Web Services AI/ML services as further +// described in section 50 of the [Amazon Web Services Service Terms]. Using Amazon Transcribe may be subject to +// federal and state laws or regulations regarding the recording or interception of +// electronic communications. It is your and your end users’ responsibility to +// comply with all applicable laws regarding the recording, including properly +// notifying all participants in a recorded session or communication that the +// session or communication is being recorded, and obtaining all necessary +// consents. You can opt out from Amazon Web Services using audio content to +// develop and improve AWS AI/ML services by configuring an AI services opt out +// policy using Amazon Web Services Organizations. +// +// [Amazon Web Services Service Terms]: https://aws.amazon.com/service-terms/ +// [Using Amazon Chime SDK live transcription]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html +// [StartStreamTranscription]: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html func (c *Client) StartMeetingTranscription(ctx context.Context, params *StartMeetingTranscriptionInput, optFns ...func(*Options)) (*StartMeetingTranscriptionOutput, error) { if params == nil { params = &StartMeetingTranscriptionInput{} diff --git a/service/chimesdkmeetings/api_op_StopMeetingTranscription.go b/service/chimesdkmeetings/api_op_StopMeetingTranscription.go index 96103f50d21..76122b66890 100644 --- a/service/chimesdkmeetings/api_op_StopMeetingTranscription.go +++ b/service/chimesdkmeetings/api_op_StopMeetingTranscription.go @@ -10,21 +10,23 @@ 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. By default, Amazon Transcribe may use -// and store audio content processed by the service to develop and improve Amazon -// Web Services AI/ML services as further described in section 50 of the Amazon -// Web Services Service Terms (https://aws.amazon.com/service-terms/) . Using -// Amazon Transcribe may be subject to federal and state laws or regulations -// regarding the recording or interception of electronic communications. It is your -// and your end users’ responsibility to comply with all applicable laws regarding -// the recording, including properly notifying all participants in a recorded -// session or communication that the session or communication is being recorded, -// and obtaining all necessary consents. You can opt out from Amazon Web Services -// using audio content to develop and improve Amazon Web Services AI/ML services by -// configuring an AI services opt out policy using Amazon Web Services -// Organizations. +// Stops transcription for the specified meetingId . For more information, refer to [Using Amazon Chime SDK live transcription] +// in the Amazon Chime SDK Developer Guide. +// +// By default, Amazon Transcribe may use and store audio content processed by the +// service to develop and improve Amazon Web Services AI/ML services as further +// described in section 50 of the [Amazon Web Services Service Terms]. Using Amazon Transcribe may be subject to +// federal and state laws or regulations regarding the recording or interception of +// electronic communications. It is your and your end users’ responsibility to +// comply with all applicable laws regarding the recording, including properly +// notifying all participants in a recorded session or communication that the +// session or communication is being recorded, and obtaining all necessary +// consents. You can opt out from Amazon Web Services using audio content to +// develop and improve Amazon Web Services AI/ML services by configuring an AI +// services opt out policy using Amazon Web Services Organizations. +// +// [Amazon Web Services Service Terms]: https://aws.amazon.com/service-terms/ +// [Using Amazon Chime SDK live transcription]: https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html func (c *Client) StopMeetingTranscription(ctx context.Context, params *StopMeetingTranscriptionInput, optFns ...func(*Options)) (*StopMeetingTranscriptionOutput, error) { if params == nil { params = &StopMeetingTranscriptionInput{} diff --git a/service/chimesdkmeetings/api_op_UntagResource.go b/service/chimesdkmeetings/api_op_UntagResource.go index ccc204d667c..8e41fa47b10 100644 --- a/service/chimesdkmeetings/api_op_UntagResource.go +++ b/service/chimesdkmeetings/api_op_UntagResource.go @@ -14,18 +14,24 @@ 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. // -// 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 e981ef90179..0b5d30709d2 100644 --- a/service/chimesdkmeetings/api_op_UpdateAttendeeCapabilities.go +++ b/service/chimesdkmeetings/api_op_UpdateAttendeeCapabilities.go @@ -11,24 +11,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The capabilities that you want to update. 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: +// The capabilities that you want to update. +// +// 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: +// // - If you specify MeetingFeatures:Video:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Video will be rejected with ValidationError 400 . +// // - If you specify MeetingFeatures:Content:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Content will be rejected with ValidationError 400 . +// // - 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 attendees can receive those streams, but only after media renegotiation diff --git a/service/chimesdkmeetings/doc.go b/service/chimesdkmeetings/doc.go index fa931d4f21f..1a125d157fd 100644 --- a/service/chimesdkmeetings/doc.go +++ b/service/chimesdkmeetings/doc.go @@ -6,6 +6,7 @@ // The Amazon Chime SDK meetings APIs in this section allow software developers to // create Amazon Chime SDK meetings, set the Amazon Web Services 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) -// . +// For more information about the meeting APIs, see [Amazon Chime SDK meetings]. +// +// [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/options.go b/service/chimesdkmeetings/options.go index 4818b1c243b..4a6a88361fd 100644 --- a/service/chimesdkmeetings/options.go +++ b/service/chimesdkmeetings/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chimesdkmeetings/types/enums.go b/service/chimesdkmeetings/types/enums.go index df4d5e66a0e..37cb7b6451e 100644 --- a/service/chimesdkmeetings/types/enums.go +++ b/service/chimesdkmeetings/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ContentResolution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentResolution) Values() []ContentResolution { return []ContentResolution{ "None", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for MediaCapabilities. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaCapabilities) Values() []MediaCapabilities { return []MediaCapabilities{ "SendReceive", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for MeetingFeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MeetingFeatureStatus) Values() []MeetingFeatureStatus { return []MeetingFeatureStatus{ "AVAILABLE", @@ -71,8 +74,9 @@ const ( // Values returns all known values for TranscribeContentIdentificationType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeContentIdentificationType) Values() []TranscribeContentIdentificationType { return []TranscribeContentIdentificationType{ "PII", @@ -88,8 +92,9 @@ const ( // Values returns all known values for TranscribeContentRedactionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeContentRedactionType) Values() []TranscribeContentRedactionType { return []TranscribeContentRedactionType{ "PII", @@ -117,8 +122,9 @@ const ( ) // Values returns all known values for TranscribeLanguageCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeLanguageCode) Values() []TranscribeLanguageCode { return []TranscribeLanguageCode{ "en-US", @@ -147,8 +153,9 @@ const ( // Values returns all known values for TranscribeMedicalContentIdentificationType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalContentIdentificationType) Values() []TranscribeMedicalContentIdentificationType { return []TranscribeMedicalContentIdentificationType{ "PHI", @@ -164,8 +171,9 @@ const ( // Values returns all known values for TranscribeMedicalLanguageCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalLanguageCode) Values() []TranscribeMedicalLanguageCode { return []TranscribeMedicalLanguageCode{ "en-US", @@ -186,8 +194,9 @@ const ( ) // Values returns all known values for TranscribeMedicalRegion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalRegion) Values() []TranscribeMedicalRegion { return []TranscribeMedicalRegion{ "us-east-1", @@ -214,6 +223,7 @@ const ( // Values returns all known values for TranscribeMedicalSpecialty. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeMedicalSpecialty) Values() []TranscribeMedicalSpecialty { return []TranscribeMedicalSpecialty{ @@ -235,8 +245,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CONVERSATION", @@ -255,8 +266,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribePartialResultsStability) Values() []TranscribePartialResultsStability { return []TranscribePartialResultsStability{ "low", @@ -285,8 +297,9 @@ const ( ) // Values returns all known values for TranscribeRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeRegion) Values() []TranscribeRegion { return []TranscribeRegion{ "us-east-2", @@ -316,8 +329,9 @@ const ( // Values returns all known values for TranscribeVocabularyFilterMethod. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscribeVocabularyFilterMethod) Values() []TranscribeVocabularyFilterMethod { return []TranscribeVocabularyFilterMethod{ "remove", @@ -336,8 +350,9 @@ const ( ) // Values returns all known values for VideoResolution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoResolution) Values() []VideoResolution { return []VideoResolution{ "None", diff --git a/service/chimesdkmeetings/types/types.go b/service/chimesdkmeetings/types/types.go index 2cc905b290e..5dc7dc5cb0b 100644 --- a/service/chimesdkmeetings/types/types.go +++ b/service/chimesdkmeetings/types/types.go @@ -8,34 +8,43 @@ import ( // 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. +// 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. AttendeeId *string - // The capabilities assigned to an attendee: audio, video, or content. 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: + // The capabilities assigned to an attendee: audio, video, or content. + // + // 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: + // // - If you specify MeetingFeatures:Video:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Video will be rejected with ValidationError 400 . + // // - If you specify MeetingFeatures:Content:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Content will be rejected with ValidationError 400 . + // // - 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 attendees can receive those streams, but only after media renegotiation @@ -43,9 +52,12 @@ type Attendee struct { Capabilities *AttendeeCapabilities // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. Pattern: - // [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are - // reserved. You can't configure a value that uses this prefix. Case insensitive. + // to an identity managed by a builder application. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // + // Values that begin with aws: are reserved. You can't configure a value that uses + // this prefix. Case insensitive. ExternalUserId *string // The join token used by the Amazon Chime SDK attendee. @@ -54,24 +66,32 @@ type Attendee struct { noSmithyDocumentSerde } -// The media capabilities of an attendee: audio, video, or content. You use the -// capabilities with a set of values that control what the capabilities can do, -// such as SendReceive data. For more information, refer to and . When using -// capabilities, be aware of these corner cases: +// The media capabilities of an attendee: audio, video, or content. +// +// You use the capabilities with a set of values that control what the +// capabilities can do, such as SendReceive data. For more information, refer to +// and . +// +// When using capabilities, be aware of these corner cases: +// // - If you specify MeetingFeatures:Video:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Video will be rejected with ValidationError 400 . +// // - If you specify MeetingFeatures:Content:MaxResolution:None when you create a // meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Content will be rejected with ValidationError 400 . +// // - 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 an attendee unmutes their microphone, audio flows 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 the attendee turns on their video or content streams, // remote attendees can receive those streams, but only after media renegotiation @@ -96,10 +116,11 @@ type AttendeeCapabilities struct { noSmithyDocumentSerde } -// Lists the maximum number of attendees allowed into the meeting. If you specify -// FHD for MeetingFeatures:Video:MaxResolution , or if you specify UHD for -// MeetingFeatures:Content:MaxResolution , the maximum number of attendees changes -// from the default of 250 to 25 . +// Lists the maximum number of attendees allowed into the meeting. +// +// If you specify FHD for MeetingFeatures:Video:MaxResolution , or if you specify +// UHD for MeetingFeatures:Content:MaxResolution , the maximum number of attendees +// changes from the default of 250 to 25 . type AttendeeFeatures struct { // The maximum number of attendees allowed into the meeting. @@ -130,14 +151,18 @@ type AudioFeatures struct { } // Lists the content (screen share) features for the meeting. Applies to all -// attendees. If you specify MeetingFeatures:Content:MaxResolution:None when you -// create a meeting, all API requests that include SendReceive , Send , or Receive -// for AttendeeCapabilities:Content will be rejected with ValidationError 400 . +// attendees. +// +// If you specify MeetingFeatures:Content:MaxResolution:None when you create a +// meeting, all API requests that include SendReceive , Send , or Receive for +// AttendeeCapabilities:Content will be rejected with ValidationError 400 . type ContentFeatures struct { - // The maximum resolution for the meeting content. Defaults to FHD . To use UHD , - // you must also provide a MeetingFeatures:Attendee:MaxCount value and override - // the default size limit of 250 attendees. + // The maximum resolution for the meeting content. + // + // Defaults to FHD . To use UHD , you must also provide a + // MeetingFeatures:Attendee:MaxCount value and override the default size limit of + // 250 attendees. MaxResolution ContentResolution noSmithyDocumentSerde @@ -155,9 +180,12 @@ type CreateAttendeeError struct { ErrorMessage *string // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. Pattern: - // [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are - // reserved. You can't configure a value that uses this prefix. Case insensitive. + // to an identity managed by a builder application. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // + // Values that begin with aws: are reserved. You can't configure a value that uses + // this prefix. Case insensitive. ExternalUserId *string noSmithyDocumentSerde @@ -168,9 +196,12 @@ type CreateAttendeeError struct { type CreateAttendeeRequestItem struct { // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. Pattern: - // [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* Values that begin with aws: are - // reserved. You can't configure a value that uses this prefix. Case insensitive. + // to an identity managed by a builder application. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // + // Values that begin with aws: are reserved. You can't configure a value that uses + // this prefix. Case insensitive. // // This member is required. ExternalUserId *string @@ -213,127 +244,168 @@ type EngineTranscribeMedicalSettings struct { noSmithyDocumentSerde } -// Settings specific for Amazon Transcribe as the live transcription engine. If -// you specify an invalid combination of parameters, a TranscriptFailed event will -// be sent with the contents of the BadRequestException generated by Amazon +// Settings specific for Amazon Transcribe as the live transcription engine. +// +// If you specify an invalid combination of parameters, a TranscriptFailed event +// will be sent with the contents of the BadRequestException generated by Amazon // Transcribe. For more information on each parameter and which combinations are -// valid, refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html) -// API in the Amazon Transcribe Developer Guide. +// valid, refer to the [StartStreamTranscription]API in the Amazon Transcribe Developer Guide. +// +// [StartStreamTranscription]: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html type EngineTranscribeSettings struct { // Labels all personally identifiable information (PII) identified in your - // transcript. If you don't include PiiEntityTypes , all PII is identified. You - // can’t set ContentIdentificationType and ContentRedactionType . + // transcript. If you don't include PiiEntityTypes , all PII is identified. + // + // You can’t set ContentIdentificationType and ContentRedactionType . ContentIdentificationType TranscribeContentIdentificationType // Content redaction is performed at the segment level. If you don't include - // PiiEntityTypes , all PII is redacted. You can’t set ContentRedactionType and - // ContentIdentificationType . + // PiiEntityTypes , all PII is redacted. + // + // You can’t set ContentRedactionType and ContentIdentificationType . ContentRedactionType TranscribeContentRedactionType // Enables partial result stabilization for your transcription. Partial result // stabilization can reduce latency in your output, but may impact accuracy. EnablePartialResultsStabilization bool - // Enables automatic language identification for your transcription. If you - // include IdentifyLanguage , you can optionally use LanguageOptions to include a - // list of language codes that you think may be present in your audio stream. - // Including language options can improve transcription accuracy. You can also use - // PreferredLanguage to include a preferred language. Doing so can help Amazon - // Transcribe identify the language faster. You must include either LanguageCode - // or IdentifyLanguage . 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 use LanguageOptions to + // include a list of language codes that you think may be present in your audio + // stream. Including language options can improve transcription accuracy. + // + // You can also use PreferredLanguage to include a preferred language. Doing so + // can help Amazon Transcribe identify the language faster. + // + // You must include either LanguageCode or IdentifyLanguage . + // + // Language identification can't be combined with custom language models or + // redaction. IdentifyLanguage bool - // Specify the language code that represents the language spoken. If you're unsure - // of the language spoken in your audio, consider using IdentifyLanguage to enable - // automatic language identification. + // Specify the language code that represents the language spoken. + // + // If you're unsure of the language spoken in your audio, consider using + // IdentifyLanguage to enable automatic language identification. LanguageCode TranscribeLanguageCode // Specify the name of the custom language model that you want to use when // processing your transcription. Note that language model names are case - // sensitive. The language of the specified language model must match the language - // code. If the languages don't match, the custom language model isn't applied. - // There are no errors or warnings associated with a language mismatch. If you use - // Amazon Transcribe in multiple Regions, the custom language model must be - // available in Amazon Transcribe in each Region. + // sensitive. + // + // The language of the specified language model must match the language code. If + // the languages don't match, the custom language model isn't applied. There are no + // errors or warnings associated with a language mismatch. + // + // If you use Amazon Transcribe in multiple Regions, the custom language model + // must be available in Amazon Transcribe in each Region. 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 - // unsure what languages are present, do not include this parameter. Including - // language options can improve the accuracy of language identification. If you - // include LanguageOptions , you must also include IdentifyLanguage . You can only - // include one language dialect per language. For example, you cannot include en-US - // and en-AU . + // unsure what languages are present, do not include this parameter. + // + // Including language options can improve the accuracy of language identification. + // + // If you include LanguageOptions , you must also include IdentifyLanguage . + // + // You can only include one language dialect per language. For example, you cannot + // include en-US and en-AU . LanguageOptions *string // Specify 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. + // stabilization ( EnablePartialResultsStabilization ). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. PartialResultsStability TranscribePartialResultsStability // 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 . 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 . Note that if - // you include PiiEntityTypes , you must also include ContentIdentificationType or - // ContentRedactionType . If you include ContentRedactionType or - // ContentIdentificationType , but do not include PiiEntityTypes, all PII is - // redacted or identified. + // can select ALL . + // + // 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 . + // + // Note that if you include PiiEntityTypes , you must also include + // ContentIdentificationType or ContentRedactionType . + // + // If you include ContentRedactionType or ContentIdentificationType , but do not + // include PiiEntityTypes, all PII is redacted or identified. PiiEntityTypes *string // Specify a preferred language from the subset of languages codes you specified - // in LanguageOptions . You can only use this parameter if you include - // IdentifyLanguage and LanguageOptions . + // in LanguageOptions . + // + // You can only use this parameter if you include IdentifyLanguage and + // LanguageOptions . PreferredLanguage TranscribeLanguageCode - // The Amazon Web Services Region in which to use Amazon Transcribe. If you don't - // specify a Region, then the MediaRegion (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html) - // of the meeting is used. However, if Amazon Transcribe is not available in the - // MediaRegion , then a TranscriptFailed event is sent. Use auto to use Amazon - // Transcribe in a Region near the meeting’s MediaRegion . For more information, - // refer to Choosing a transcription Region (https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region) - // in the Amazon Chime SDK Developer Guide. + // The Amazon Web Services Region in which to use Amazon Transcribe. + // + // If you don't specify a Region, then the [MediaRegion] of the meeting is used. However, if + // Amazon Transcribe is not available in the MediaRegion , then a TranscriptFailed + // event is sent. + // + // Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion . + // For more information, refer to [Choosing a transcription Region]in the Amazon Chime SDK Developer Guide. + // + // [Choosing a transcription Region]: https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region + // [MediaRegion]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html Region TranscribeRegion - // 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 . + // 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 . VocabularyFilterMethod TranscribeVocabularyFilterMethod // Specify the name of the custom vocabulary filter that you want to use when // processing your transcription. Note that vocabulary filter names are case - // sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary - // filter must be available in Amazon Transcribe in each Region. If you include - // IdentifyLanguage and want to use one or more vocabulary filters with your - // transcription, use the VocabularyFilterNames parameter instead. + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be + // available in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more vocabulary filters + // with your transcription, use the VocabularyFilterNames parameter instead. VocabularyFilterName *string // Specify the names of the custom vocabulary filters that you want to use when // processing your transcription. Note that vocabulary filter names are case - // sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary - // filter must be available in Amazon Transcribe in each Region. If you're not - // including IdentifyLanguage and want to use a custom vocabulary filter with your - // transcription, use the VocabularyFilterName parameter instead. + // sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be + // available in Amazon Transcribe in each Region. + // + // If you're not including IdentifyLanguage and want to use a custom vocabulary + // filter with your transcription, use the VocabularyFilterName parameter instead. VocabularyFilterNames *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 you use - // Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon - // Transcribe in each Region. If you include IdentifyLanguage and want to use one - // or more custom vocabularies with your transcription, use the VocabularyNames - // parameter instead. + // your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe multiple Regions, the vocabulary must be available + // in Amazon Transcribe in each Region. + // + // If you include IdentifyLanguage and want to use one or more custom vocabularies + // with your transcription, use the VocabularyNames parameter instead. VocabularyName *string // Specify the names of the custom vocabularies that you want to use when - // processing your transcription. Note that vocabulary names are case sensitive. If - // you use Amazon Transcribe in multiple Regions, the vocabulary must be available - // in Amazon Transcribe in each Region. If you don't include IdentifyLanguage and - // want to use a custom vocabulary with your transcription, use the VocabularyName - // parameter instead. + // processing your transcription. Note that vocabulary names are case sensitive. + // + // If you use Amazon Transcribe in multiple Regions, the vocabulary must be + // available in Amazon Transcribe in each Region. + // + // If you don't include IdentifyLanguage and want to use a custom vocabulary with + // your transcription, use the VocabularyName parameter instead. VocabularyNames *string noSmithyDocumentSerde @@ -352,23 +424,27 @@ type MediaPlacement struct { // The event ingestion URL. EventIngestionUrl *string - // The screen data URL. This parameter is deprecated and no longer used by the - // Amazon Chime SDK. + // The screen data URL. + // + // This parameter is deprecated and no longer used by the Amazon Chime SDK. ScreenDataUrl *string - // The screen sharing URL. This parameter is deprecated and no longer used by the - // Amazon Chime SDK. + // The screen sharing URL. + // + // This parameter is deprecated and no longer used by the Amazon Chime SDK. ScreenSharingUrl *string - // The screen viewing URL. This parameter is deprecated and no longer used by the - // Amazon Chime SDK. + // The screen viewing URL. + // + // This parameter is deprecated and no longer used by the Amazon Chime SDK. ScreenViewingUrl *string // The signaling URL. SignalingUrl *string - // The turn control URL. This parameter is deprecated and no longer used by the - // Amazon Chime SDK. + // The turn control URL. + // + // This parameter is deprecated and no longer used by the Amazon Chime SDK. TurnControlUrl *string noSmithyDocumentSerde @@ -377,7 +453,10 @@ type MediaPlacement struct { // A meeting created using the Amazon Chime SDK. type Meeting struct { - // The external meeting ID. Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // The external meeting ID. + // + // Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]* + // // Values that begin with aws: are reserved. You can't configure a value that uses // this prefix. Case insensitive. ExternalMeetingId *string @@ -389,6 +468,7 @@ type Meeting struct { // 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 Amazon Web Services GovCloud (US) Regions: us-gov-east-1 , // us-gov-west-1 . MediaRegion *string @@ -478,13 +558,15 @@ type TranscriptionConfiguration struct { noSmithyDocumentSerde } -// The video features set for the meeting. Applies to all attendees. If you -// specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all -// API requests that include SendReceive , Send , or Receive for +// The video features set for the meeting. Applies to all attendees. +// +// If you specify MeetingFeatures:Video:MaxResolution:None when you create a +// meeting, all API requests that include SendReceive , Send , or Receive for // AttendeeCapabilities:Video will be rejected with ValidationError 400 . type VideoFeatures struct { // The maximum video resolution for the meeting. Applies to all attendees. + // // Defaults to HD . To use FHD , you must also provide a // MeetingFeatures:Attendee:MaxCount value and override the default size limit of // 250 attendees. diff --git a/service/chimesdkmessaging/api_op_AssociateChannelFlow.go b/service/chimesdkmessaging/api_op_AssociateChannelFlow.go index 79486f64d4b..2f9d8172168 100644 --- a/service/chimesdkmessaging/api_op_AssociateChannelFlow.go +++ b/service/chimesdkmessaging/api_op_AssociateChannelFlow.go @@ -12,10 +12,12 @@ import ( // Associates a channel flow with a channel. Once associated, all messages to that // channel go through channel flow processors. To stop processing, use the -// DisassociateChannelFlow API. Only administrators or channel moderators can -// associate a channel flow. 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. +// DisassociateChannelFlow API. +// +// Only administrators or channel moderators can associate a channel flow. 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) AssociateChannelFlow(ctx context.Context, params *AssociateChannelFlowInput, optFns ...func(*Options)) (*AssociateChannelFlowOutput, error) { if params == nil { params = &AssociateChannelFlowInput{} diff --git a/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go b/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go index 93f5224ce4b..af9b8e623d7 100644 --- a/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go +++ b/service/chimesdkmessaging/api_op_BatchCreateChannelMembership.go @@ -45,8 +45,10 @@ type BatchCreateChannelMembershipInput struct { // This member is required. MemberArns []string - // The ID of the SubChannel in the request. Only required when creating membership - // in a SubChannel for a moderator in an elastic channel. + // The ID of the SubChannel in the request. + // + // Only required when creating membership 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 diff --git a/service/chimesdkmessaging/api_op_ChannelFlowCallback.go b/service/chimesdkmessaging/api_op_ChannelFlowCallback.go index 2e6279c8d7a..8279137f217 100644 --- a/service/chimesdkmessaging/api_op_ChannelFlowCallback.go +++ b/service/chimesdkmessaging/api_op_ChannelFlowCallback.go @@ -12,10 +12,14 @@ import ( ) // Calls back Amazon 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: +// 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 func (c *Client) ChannelFlowCallback(ctx context.Context, params *ChannelFlowCallbackInput, optFns ...func(*Options)) (*ChannelFlowCallbackOutput, error) { if params == nil { diff --git a/service/chimesdkmessaging/api_op_CreateChannel.go b/service/chimesdkmessaging/api_op_CreateChannel.go index ec5151489c1..773930e4f03 100644 --- a/service/chimesdkmessaging/api_op_CreateChannel.go +++ b/service/chimesdkmessaging/api_op_CreateChannel.go @@ -11,10 +11,13 @@ 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 ARN of the AppInstanceUser or AppInstanceBot 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 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) { if params == nil { params = &CreateChannelInput{} diff --git a/service/chimesdkmessaging/api_op_CreateChannelBan.go b/service/chimesdkmessaging/api_op_CreateChannelBan.go index 2fc0b35791d..3baac4de790 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelBan.go +++ b/service/chimesdkmessaging/api_op_CreateChannelBan.go @@ -14,10 +14,13 @@ import ( // 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 ea652cf8d6c..54956a0b95a 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelFlow.go +++ b/service/chimesdkmessaging/api_op_CreateChannelFlow.go @@ -15,14 +15,21 @@ import ( // functions that perform actions on chat messages, such as stripping out // 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: +// a developer API. +// +// Channel flows process the following items: +// // - 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) -// in the Amazon Chime developer guide. +// about the message types provided by Chime SDK messaging, refer to [Message types]in the Amazon +// Chime developer guide. +// +// [Message types]: https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types func (c *Client) CreateChannelFlow(ctx context.Context, params *CreateChannelFlowInput, optFns ...func(*Options)) (*CreateChannelFlowOutput, error) { if params == nil { params = &CreateChannelFlowInput{} diff --git a/service/chimesdkmessaging/api_op_CreateChannelMembership.go b/service/chimesdkmessaging/api_op_CreateChannelMembership.go index 88e7fe0c493..58250c20bdb 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelMembership.go +++ b/service/chimesdkmessaging/api_op_CreateChannelMembership.go @@ -13,15 +13,22 @@ 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 // // 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 ARN of the @@ -67,8 +74,10 @@ type CreateChannelMembershipInput struct { // This member is required. Type types.ChannelMembershipType - // The ID of the SubChannel in the request. Only required when creating membership - // in a SubChannel for a moderator in an elastic channel. + // The ID of the SubChannel in the request. + // + // Only required when creating membership in a SubChannel for a moderator in an + // elastic channel. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_CreateChannelModerator.go b/service/chimesdkmessaging/api_op_CreateChannelModerator.go index d503fb239a1..54a284ee1b9 100644 --- a/service/chimesdkmessaging/api_op_CreateChannelModerator.go +++ b/service/chimesdkmessaging/api_op_CreateChannelModerator.go @@ -12,10 +12,15 @@ import ( ) // 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. // // The x-amz-chime-bearer request header is mandatory. Use the ARN of the diff --git a/service/chimesdkmessaging/api_op_DeleteChannel.go b/service/chimesdkmessaging/api_op_DeleteChannel.go index 0cdb476c226..8dddb836838 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannel.go +++ b/service/chimesdkmessaging/api_op_DeleteChannel.go @@ -11,9 +11,11 @@ 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_DeleteChannelBan.go b/service/chimesdkmessaging/api_op_DeleteChannelBan.go index b7144b3c3ee..f2ec9bfc1d4 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelBan.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelBan.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a member from a channel's ban list. 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. +// Removes a member from a channel's ban list. +// +// 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) DeleteChannelBan(ctx context.Context, params *DeleteChannelBanInput, optFns ...func(*Options)) (*DeleteChannelBanOutput, error) { if params == nil { params = &DeleteChannelBanInput{} diff --git a/service/chimesdkmessaging/api_op_DeleteChannelFlow.go b/service/chimesdkmessaging/api_op_DeleteChannelFlow.go index 07edf435ce9..28b0bf725dc 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelFlow.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelFlow.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a channel flow, an irreversible process. This is a developer API. This -// API works only when the channel flow is not associated with any channel. To get -// a list of all channels that a channel flow is associated with, use the +// Deletes a channel flow, an irreversible process. This is a developer API. +// +// This API works only when the channel flow is not associated with any channel. +// To get a list of all channels that a channel flow is associated with, use the // ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API // to disassociate a channel flow from all channels. func (c *Client) DeleteChannelFlow(ctx context.Context, params *DeleteChannelFlowInput, optFns ...func(*Options)) (*DeleteChannelFlowOutput, error) { diff --git a/service/chimesdkmessaging/api_op_DeleteChannelMembership.go b/service/chimesdkmessaging/api_op_DeleteChannelMembership.go index 09c41f295a9..c8adbbdaba8 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelMembership.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelMembership.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) DeleteChannelMembership(ctx context.Context, params *DeleteChannelMembershipInput, optFns ...func(*Options)) (*DeleteChannelMembershipOutput, error) { if params == nil { params = &DeleteChannelMembershipInput{} @@ -45,7 +46,9 @@ type DeleteChannelMembershipInput struct { // This member is required. MemberArn *string - // The ID of the SubChannel in the request. Only for use by moderators. + // The ID of the SubChannel in the request. + // + // Only for use by moderators. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_DeleteChannelMessage.go b/service/chimesdkmessaging/api_op_DeleteChannelMessage.go index 1ad5d4648f3..b32d0744351 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelMessage.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelMessage.go @@ -12,9 +12,11 @@ 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 ARN of the AppInstanceUser or AppInstanceBot 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 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) { if params == nil { params = &DeleteChannelMessageInput{} @@ -47,8 +49,9 @@ 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 f7070f72e11..b6434b6d955 100644 --- a/service/chimesdkmessaging/api_op_DeleteChannelModerator.go +++ b/service/chimesdkmessaging/api_op_DeleteChannelModerator.go @@ -10,9 +10,11 @@ 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 67abc59cee2..c2a2d64d721 100644 --- a/service/chimesdkmessaging/api_op_DeleteMessagingStreamingConfigurations.go +++ b/service/chimesdkmessaging/api_op_DeleteMessagingStreamingConfigurations.go @@ -11,8 +11,9 @@ import ( ) // 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. +// see [Streaming messaging data]in the Amazon Chime SDK Developer Guide. +// +// [Streaming messaging data]: https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html 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 22219e2cc90..3e16a0445a5 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannel.go +++ b/service/chimesdkmessaging/api_op_DescribeChannel.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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. func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error) { diff --git a/service/chimesdkmessaging/api_op_DescribeChannelBan.go b/service/chimesdkmessaging/api_op_DescribeChannelBan.go index a20c6baa448..d75459dffe7 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelBan.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelBan.go @@ -11,9 +11,11 @@ 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_DescribeChannelMembership.go b/service/chimesdkmessaging/api_op_DescribeChannelMembership.go index 92a51f01981..3e72aae0f5b 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelMembership.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelMembership.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a user's channel membership. 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 user's channel membership. +// +// 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) DescribeChannelMembership(ctx context.Context, params *DescribeChannelMembershipInput, optFns ...func(*Options)) (*DescribeChannelMembershipOutput, error) { if params == nil { params = &DescribeChannelMembershipInput{} @@ -47,8 +49,9 @@ type DescribeChannelMembershipInput struct { MemberArn *string // The ID of the SubChannel in the request. The response contains an - // ElasticChannelConfiguration object. Only required to get a user’s SubChannel - // membership details. + // ElasticChannelConfiguration object. + // + // Only required to get a user’s SubChannel membership details. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go b/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go index 410a02e2325..62e3bb770eb 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelMembershipForAppInstanceUser.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the details of a channel based on the membership of the specified -// 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. +// Returns the details of a channel based on the membership of the specified +// +// 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) { if params == nil { params = &DescribeChannelMembershipForAppInstanceUserInput{} diff --git a/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go b/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go index 5adc638fe81..2130ff44a39 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelModeratedByAppInstanceUser.go @@ -12,9 +12,11 @@ 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 -// ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the -// value in the header. +// 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) { if params == nil { params = &DescribeChannelModeratedByAppInstanceUserInput{} diff --git a/service/chimesdkmessaging/api_op_DescribeChannelModerator.go b/service/chimesdkmessaging/api_op_DescribeChannelModerator.go index 3d182166b44..b10f1f00d7c 100644 --- a/service/chimesdkmessaging/api_op_DescribeChannelModerator.go +++ b/service/chimesdkmessaging/api_op_DescribeChannelModerator.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the full details of a single ChannelModerator. 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 single ChannelModerator. +// +// 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) DescribeChannelModerator(ctx context.Context, params *DescribeChannelModeratorInput, optFns ...func(*Options)) (*DescribeChannelModeratorOutput, error) { if params == nil { params = &DescribeChannelModeratorInput{} diff --git a/service/chimesdkmessaging/api_op_DisassociateChannelFlow.go b/service/chimesdkmessaging/api_op_DisassociateChannelFlow.go index d6b12b912ee..711943cfcae 100644 --- a/service/chimesdkmessaging/api_op_DisassociateChannelFlow.go +++ b/service/chimesdkmessaging/api_op_DisassociateChannelFlow.go @@ -11,9 +11,11 @@ import ( ) // Disassociates a channel flow from all its channels. Once disassociated, all -// messages to that channel stop going through the channel flow processor. Only -// administrators or channel moderators can disassociate a channel flow. The -// x-amz-chime-bearer request header is mandatory. Use the ARN of the +// messages to that channel stop going through the channel flow processor. +// +// Only administrators or channel moderators can disassociate a channel flow. +// +// 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) DisassociateChannelFlow(ctx context.Context, params *DisassociateChannelFlowInput, optFns ...func(*Options)) (*DisassociateChannelFlowOutput, error) { diff --git a/service/chimesdkmessaging/api_op_GetChannelMembershipPreferences.go b/service/chimesdkmessaging/api_op_GetChannelMembershipPreferences.go index 9dec35ec91e..bb84a0eb977 100644 --- a/service/chimesdkmessaging/api_op_GetChannelMembershipPreferences.go +++ b/service/chimesdkmessaging/api_op_GetChannelMembershipPreferences.go @@ -16,9 +16,11 @@ import ( // membership in order to retrieve membership preferences. Users or bots in the // AppInstanceAdmin and channel moderator roles can't retrieve preferences for // other users or bots. Banned users or bots can't retrieve membership preferences -// for the channel from which they are banned. 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. +// for the channel from which they are banned. +// +// 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) GetChannelMembershipPreferences(ctx context.Context, params *GetChannelMembershipPreferencesInput, optFns ...func(*Options)) (*GetChannelMembershipPreferencesOutput, error) { if params == nil { params = &GetChannelMembershipPreferencesInput{} diff --git a/service/chimesdkmessaging/api_op_GetChannelMessage.go b/service/chimesdkmessaging/api_op_GetChannelMessage.go index ddd1edd1bd8..8b71d5371fc 100644 --- a/service/chimesdkmessaging/api_op_GetChannelMessage.go +++ b/service/chimesdkmessaging/api_op_GetChannelMessage.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the full details of a channel message. 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. +// Gets the full details of a channel message. +// +// 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) GetChannelMessage(ctx context.Context, params *GetChannelMessageInput, optFns ...func(*Options)) (*GetChannelMessageOutput, error) { if params == nil { params = &GetChannelMessageInput{} @@ -46,8 +48,9 @@ type GetChannelMessageInput struct { // This member is required. MessageId *string - // The ID of the SubChannel in the request. Only required when getting messages in - // a SubChannel that the user belongs to. + // The ID of the SubChannel in the request. + // + // Only required when getting messages in a SubChannel that the user belongs to. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go b/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go index 2388bcca927..7939421a00f 100644 --- a/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go +++ b/service/chimesdkmessaging/api_op_GetChannelMessageStatus.go @@ -14,12 +14,23 @@ import ( // 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 Message denied by the processor +// 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 Message 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. @@ -55,8 +66,10 @@ type GetChannelMessageStatusInput struct { // This member is required. MessageId *string - // The ID of the SubChannel in the request. Only required when getting message - // status in a SubChannel that the user belongs to. + // The ID of the SubChannel in the request. + // + // Only required when getting message status in a SubChannel that the user belongs + // to. SubChannelId *string noSmithyDocumentSerde diff --git a/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go b/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go index 167d66df962..ee470d8e2e6 100644 --- a/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go +++ b/service/chimesdkmessaging/api_op_GetMessagingStreamingConfigurations.go @@ -12,8 +12,9 @@ import ( ) // 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. +// information, see [Streaming messaging data]in the Amazon Chime SDK Developer Guide. +// +// [Streaming messaging data]: https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html 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_ListChannelBans.go b/service/chimesdkmessaging/api_op_ListChannelBans.go index 3685adac282..185b2980efb 100644 --- a/service/chimesdkmessaging/api_op_ListChannelBans.go +++ b/service/chimesdkmessaging/api_op_ListChannelBans.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the users and bots banned from a particular channel. The -// x-amz-chime-bearer request header is mandatory. Use the ARN of the +// Lists all the users and bots banned from a particular 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) ListChannelBans(ctx context.Context, params *ListChannelBansInput, optFns ...func(*Options)) (*ListChannelBansOutput, error) { diff --git a/service/chimesdkmessaging/api_op_ListChannelMemberships.go b/service/chimesdkmessaging/api_op_ListChannelMemberships.go index 5fa528066e6..c6394ecb4ce 100644 --- a/service/chimesdkmessaging/api_op_ListChannelMemberships.go +++ b/service/chimesdkmessaging/api_op_ListChannelMemberships.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all channel memberships in 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. 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) -// API. +// Lists all channel memberships in 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. +// +// If you want to list the channels to which a specific app instance user belongs, +// see the [ListChannelMembershipsForAppInstanceUser]API. +// +// [ListChannelMembershipsForAppInstanceUser]: https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html func (c *Client) ListChannelMemberships(ctx context.Context, params *ListChannelMembershipsInput, optFns ...func(*Options)) (*ListChannelMembershipsOutput, error) { if params == nil { params = &ListChannelMembershipsInput{} @@ -51,8 +55,10 @@ type ListChannelMembershipsInput struct { // are returned. NextToken *string - // The ID of the SubChannel in the request. Only required when listing a user's - // memberships in a particular sub-channel of an elastic channel. + // The ID of the SubChannel in the request. + // + // Only required when listing a user's 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 diff --git a/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go b/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go index 24d50763aaa..4482f729af6 100644 --- a/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_ListChannelMembershipsForAppInstanceUser.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all channels that an 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 an 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 7f38bed16da..0246e73cf0a 100644 --- a/service/chimesdkmessaging/api_op_ListChannelMessages.go +++ b/service/chimesdkmessaging/api_op_ListChannelMessages.go @@ -13,12 +13,15 @@ import ( ) // 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. +// . 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{} @@ -63,8 +66,10 @@ 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 diff --git a/service/chimesdkmessaging/api_op_ListChannelModerators.go b/service/chimesdkmessaging/api_op_ListChannelModerators.go index 87af9543371..9e3de69d465 100644 --- a/service/chimesdkmessaging/api_op_ListChannelModerators.go +++ b/service/chimesdkmessaging/api_op_ListChannelModerators.go @@ -11,9 +11,11 @@ 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 1e9d8ee055c..b6d46cc4ccd 100644 --- a/service/chimesdkmessaging/api_op_ListChannels.go +++ b/service/chimesdkmessaging/api_op_ListChannels.go @@ -12,8 +12,12 @@ import ( ) // Lists all Channels created under a single Chime App as a paginated list. You -// can specify filters to narrow results. Functionality & restrictions +// 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. // diff --git a/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go b/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go index 82d7264993b..13f6a2bcee4 100644 --- a/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go +++ b/service/chimesdkmessaging/api_op_ListChannelsModeratedByAppInstanceUser.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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) { if params == nil { params = &ListChannelsModeratedByAppInstanceUserInput{} diff --git a/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go b/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go index f2c8ce4341c..e672d1098d4 100644 --- a/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go +++ b/service/chimesdkmessaging/api_op_PutChannelExpirationSettings.go @@ -12,10 +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. diff --git a/service/chimesdkmessaging/api_op_PutChannelMembershipPreferences.go b/service/chimesdkmessaging/api_op_PutChannelMembershipPreferences.go index 670f90e45ce..c617caee927 100644 --- a/service/chimesdkmessaging/api_op_PutChannelMembershipPreferences.go +++ b/service/chimesdkmessaging/api_op_PutChannelMembershipPreferences.go @@ -16,9 +16,11 @@ import ( // user or bot who owns the membership can set preferences. Users or bots in the // AppInstanceAdmin and channel moderator roles can't set preferences for other // users. Banned users or bots can't set membership preferences for the channel -// from which they are banned. The x-amz-chime-bearer request header is mandatory. -// Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as -// the value in the header. +// from which they are banned. +// +// The x-amz-chime-bearer request header is mandatory. Use the ARN of an +// AppInstanceUser or AppInstanceBot that makes the API call as the value in the +// header. func (c *Client) PutChannelMembershipPreferences(ctx context.Context, params *PutChannelMembershipPreferencesInput, optFns ...func(*Options)) (*PutChannelMembershipPreferencesOutput, error) { if params == nil { params = &PutChannelMembershipPreferencesInput{} diff --git a/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go b/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go index b89ad90c69f..b722c5b8f3a 100644 --- a/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go +++ b/service/chimesdkmessaging/api_op_PutMessagingStreamingConfigurations.go @@ -12,8 +12,9 @@ import ( ) // 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. +// see [Streaming messaging data]in the Amazon Chime SDK Developer Guide. +// +// [Streaming messaging data]: https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html 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_RedactChannelMessage.go b/service/chimesdkmessaging/api_op_RedactChannelMessage.go index 64c198fda23..fce5a03cacf 100644 --- a/service/chimesdkmessaging/api_op_RedactChannelMessage.go +++ b/service/chimesdkmessaging/api_op_RedactChannelMessage.go @@ -11,8 +11,9 @@ import ( ) // Redacts message content, but not metadata. The message exists in the back end, -// but the action returns null content, and the state shows as redacted. The -// x-amz-chime-bearer request header is mandatory. Use the ARN of the +// but the action returns null content, and the state shows as redacted. +// +// 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) RedactChannelMessage(ctx context.Context, params *RedactChannelMessageInput, optFns ...func(*Options)) (*RedactChannelMessageOutput, error) { @@ -61,8 +62,9 @@ type RedactChannelMessageOutput struct { // The ID of the message being redacted. MessageId *string - // The ID of the SubChannel in the response. Only required when redacting messages - // in a SubChannel that the user belongs to. + // The ID of the SubChannel in the response. + // + // Only required when redacting messages in a SubChannel that the user belongs to. SubChannelId *string // Metadata pertaining to the operation's result. diff --git a/service/chimesdkmessaging/api_op_SearchChannels.go b/service/chimesdkmessaging/api_op_SearchChannels.go index 6c390e7d49f..6abba03b426 100644 --- a/service/chimesdkmessaging/api_op_SearchChannels.go +++ b/service/chimesdkmessaging/api_op_SearchChannels.go @@ -13,9 +13,11 @@ import ( // Allows the ChimeBearer to search channels by channel members. Users or bots can // search across the channels that they belong to. Users in the AppInstanceAdmin -// role can search across all channels. 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. +// role can search across all channels. +// +// 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) SearchChannels(ctx context.Context, params *SearchChannelsInput, optFns ...func(*Options)) (*SearchChannelsOutput, error) { if params == nil { params = &SearchChannelsInput{} diff --git a/service/chimesdkmessaging/api_op_SendChannelMessage.go b/service/chimesdkmessaging/api_op_SendChannelMessage.go index 6d16477f3aa..2e0ba613bde 100644 --- a/service/chimesdkmessaging/api_op_SendChannelMessage.go +++ b/service/chimesdkmessaging/api_op_SendChannelMessage.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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 be up to 4KB in size and contain metadata. -// Metadata is arbitrary, and you can use it in a variety of ways, such as -// containing a link to an attachment. CONTROL messages are limited to 30 bytes -// and do not contain metadata. +// header. +// +// Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata +// is arbitrary, and you can use it in a variety of ways, such as containing a link +// to an attachment. +// +// CONTROL messages are limited to 30 bytes and do not contain metadata. func (c *Client) SendChannelMessage(ctx context.Context, params *SendChannelMessageInput, optFns ...func(*Options)) (*SendChannelMessageOutput, error) { if params == nil { params = &SendChannelMessageInput{} @@ -61,10 +65,13 @@ type SendChannelMessageInput struct { // This member is required. Persistence types.ChannelMessagePersistenceType - // The type of message, STANDARD or CONTROL . STANDARD messages can be up to 4KB - // in size and contain metadata. Metadata is arbitrary, and you can use it in a - // variety of ways, such as containing a link to an attachment. CONTROL messages - // are limited to 30 bytes and do not contain metadata. + // The type of message, STANDARD or CONTROL . + // + // STANDARD messages can be up to 4KB in size and contain metadata. Metadata is + // arbitrary, and you can use it in a variety of ways, such as containing a link to + // an attachment. + // + // CONTROL messages are limited to 30 bytes and do not contain metadata. // // This member is required. Type types.ChannelMessageType diff --git a/service/chimesdkmessaging/api_op_UpdateChannel.go b/service/chimesdkmessaging/api_op_UpdateChannel.go index c8cb5544c0d..301969882fb 100644 --- a/service/chimesdkmessaging/api_op_UpdateChannel.go +++ b/service/chimesdkmessaging/api_op_UpdateChannel.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a channel's attributes. Restriction: You can't change a channel's -// privacy. The x-amz-chime-bearer request header is mandatory. Use the ARN of the +// Update a channel's attributes. +// +// 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) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error) { diff --git a/service/chimesdkmessaging/api_op_UpdateChannelMessage.go b/service/chimesdkmessaging/api_op_UpdateChannelMessage.go index 66b91bf64fb..4d30cc400ae 100644 --- a/service/chimesdkmessaging/api_op_UpdateChannelMessage.go +++ b/service/chimesdkmessaging/api_op_UpdateChannelMessage.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the content of a message. 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. +// Updates the content of a message. +// +// 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) UpdateChannelMessage(ctx context.Context, params *UpdateChannelMessageInput, optFns ...func(*Options)) (*UpdateChannelMessageOutput, error) { if params == nil { params = &UpdateChannelMessageInput{} @@ -57,8 +59,9 @@ 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/api_op_UpdateChannelReadMarker.go b/service/chimesdkmessaging/api_op_UpdateChannelReadMarker.go index 100e05a0e39..53108b847f1 100644 --- a/service/chimesdkmessaging/api_op_UpdateChannelReadMarker.go +++ b/service/chimesdkmessaging/api_op_UpdateChannelReadMarker.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The details of the time when a user last read messages in a channel. The -// x-amz-chime-bearer request header is mandatory. Use the ARN of the +// The details of the time when a user last read messages in 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) UpdateChannelReadMarker(ctx context.Context, params *UpdateChannelReadMarkerInput, optFns ...func(*Options)) (*UpdateChannelReadMarkerOutput, error) { diff --git a/service/chimesdkmessaging/doc.go b/service/chimesdkmessaging/doc.go index 2b942eedb6c..12d43ab9816 100644 --- a/service/chimesdkmessaging/doc.go +++ b/service/chimesdkmessaging/doc.go @@ -6,6 +6,7 @@ // 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) -// . +// information about the messaging APIs, see [Amazon Chime SDK messaging]. +// +// [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/options.go b/service/chimesdkmessaging/options.go index b397f55846c..c1d38c75129 100644 --- a/service/chimesdkmessaging/options.go +++ b/service/chimesdkmessaging/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chimesdkmessaging/types/enums.go b/service/chimesdkmessaging/types/enums.go index 8ec0490aa31..e89c31081db 100644 --- a/service/chimesdkmessaging/types/enums.go +++ b/service/chimesdkmessaging/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AllowNotifications. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllowNotifications) Values() []AllowNotifications { return []AllowNotifications{ "ALL", @@ -31,8 +32,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DEFAULT", @@ -50,8 +52,9 @@ const ( // Values returns all known values for ChannelMessagePersistenceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMessagePersistenceType) Values() []ChannelMessagePersistenceType { return []ChannelMessagePersistenceType{ "PERSISTENT", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for ChannelMessageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMessageStatus) Values() []ChannelMessageStatus { return []ChannelMessageStatus{ "SENT", @@ -90,8 +94,9 @@ const ( ) // Values returns all known values for ChannelMessageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMessageType) Values() []ChannelMessageType { return []ChannelMessageType{ "STANDARD", @@ -108,8 +113,9 @@ const ( ) // Values returns all known values for ChannelMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelMode) Values() []ChannelMode { return []ChannelMode{ "UNRESTRICTED", @@ -126,8 +132,9 @@ const ( ) // Values returns all known values for ChannelPrivacy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelPrivacy) Values() []ChannelPrivacy { return []ChannelPrivacy{ "PUBLIC", @@ -157,8 +164,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -188,8 +196,9 @@ const ( ) // Values returns all known values for ExpirationCriterion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpirationCriterion) Values() []ExpirationCriterion { return []ExpirationCriterion{ "CREATED_TIMESTAMP", @@ -206,8 +215,9 @@ const ( ) // Values returns all known values for FallbackAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FallbackAction) Values() []FallbackAction { return []FallbackAction{ "CONTINUE", @@ -223,8 +233,9 @@ const ( ) // Values returns all known values for InvocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvocationType) Values() []InvocationType { return []InvocationType{ "ASYNC", @@ -240,8 +251,9 @@ const ( ) // Values returns all known values for MessagingDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessagingDataType) Values() []MessagingDataType { return []MessagingDataType{ "Channel", @@ -258,8 +270,9 @@ const ( ) // Values returns all known values for PushNotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PushNotificationType) Values() []PushNotificationType { return []PushNotificationType{ "DEFAULT", @@ -275,8 +288,9 @@ const ( ) // Values returns all known values for SearchFieldKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchFieldKey) Values() []SearchFieldKey { return []SearchFieldKey{ "MEMBERS", @@ -292,8 +306,9 @@ const ( ) // Values returns all known values for SearchFieldOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchFieldOperator) Values() []SearchFieldOperator { return []SearchFieldOperator{ "EQUALS", @@ -310,8 +325,9 @@ const ( ) // 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. +// in the future, and so 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 beedb296a09..643905a66df 100644 --- a/service/chimesdkmessaging/types/types.go +++ b/service/chimesdkmessaging/types/types.go @@ -251,15 +251,17 @@ type ChannelMessage struct { // The content of the channel message. For Amazon Lex V2 bot responses, this field // holds a list of messages originating from the bot. For more information, refer - // to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html Content *string // The content type of the channel message. For Amazon Lex V2 bot responses, the // content type is application/amz-chime-lex-msgs for success responses and // application/amz-chime-lex-error for failure responses. For more information, - // refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // refer to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html ContentType *string // The time at which the message was created. @@ -273,8 +275,9 @@ type ChannelMessage struct { // The attributes for the channel message. For Amazon Lex V2 bot responses, the // attributes are mapped to specific fields from the bot. For more information, - // refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // refer to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html MessageAttributes map[string]MessageAttributeValue // The ID of a message. @@ -319,22 +322,25 @@ type ChannelMessageCallback struct { MessageId *string // The message content. For Amazon Lex V2 bot responses, this field holds a list - // of messages originating from the bot. For more information, refer to Processing - // responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // of messages originating from the bot. For more information, refer to [Processing responses from an AppInstanceBot]in the + // Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html Content *string // The content type of the call-back message. For Amazon Lex V2 bot responses, the // content type is application/amz-chime-lex-msgs for success responses and // application/amz-chime-lex-error for failure responses. For more information, - // refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // refer to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html ContentType *string // The attributes for the channel message. For Amazon Lex V2 bot responses, the // attributes are mapped to specific fields from the bot. For more information, - // refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // refer to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html MessageAttributes map[string]MessageAttributeValue // The message metadata. @@ -366,15 +372,18 @@ type ChannelMessageSummary struct { // The content of the channel message. For Amazon Lex V2 bot responses, this field // holds a list of messages originating from the bot. For more information, refer - // to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html Content *string // The content type of the channel message listed in the summary. For Amazon Lex // V2 bot responses, the content type is application/amz-chime-lex-msgs for // success responses and application/amz-chime-lex-error for failure responses. - // For more information, refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // For more information, refer to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer + // Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html ContentType *string // The time at which the message summary was created. @@ -388,8 +397,9 @@ type ChannelMessageSummary struct { // The attributes for the channel message. For Amazon Lex V2 bot responses, the // attributes are mapped to specific fields from the bot. For more information, - // refer to Processing responses from an AppInstanceBot (https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html) - // in the Amazon Chime SDK Messaging Developer Guide. + // refer to [Processing responses from an AppInstanceBot]in the Amazon Chime SDK Messaging Developer Guide. + // + // [Processing responses from an AppInstanceBot]: https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html MessageAttributes map[string]MessageAttributeValue // The ID of the message. @@ -668,8 +678,10 @@ type SearchField struct { Operator SearchFieldOperator // The values that you want to search for, a list of strings. The values must be - // AppInstanceUserArns specified as a list of strings. This operation isn't - // supported for AppInstanceUsers with large number of memberships. + // AppInstanceUserArns specified as a list of strings. + // + // This operation isn't supported for AppInstanceUsers with large number of + // memberships. // // This member is required. Values []string diff --git a/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go b/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go index 9d9561dd7c4..8ee8a8f98c7 100644 --- a/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go +++ b/service/chimesdkvoice/api_op_BatchDeletePhoneNumber.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves phone numbers into the Deletion queue. Phone numbers must be +// 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. +// 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_BatchUpdatePhoneNumber.go b/service/chimesdkvoice/api_op_BatchUpdatePhoneNumber.go index 0d41757ee39..7c9738fc772 100644 --- a/service/chimesdkvoice/api_op_BatchUpdatePhoneNumber.go +++ b/service/chimesdkvoice/api_op_BatchUpdatePhoneNumber.go @@ -13,8 +13,9 @@ import ( // Updates phone number product types, calling names, or phone number names. You // can update one attribute at a time for each UpdatePhoneNumberRequestItem . For -// example, you can update the product type, the calling name, or phone name. You -// cannot have a duplicate phoneNumberId in a request. +// example, you can update the product type, the calling name, or phone name. +// +// You cannot have a duplicate phoneNumberId in a request. func (c *Client) BatchUpdatePhoneNumber(ctx context.Context, params *BatchUpdatePhoneNumberInput, optFns ...func(*Options)) (*BatchUpdatePhoneNumberOutput, error) { if params == nil { params = &BatchUpdatePhoneNumberInput{} diff --git a/service/chimesdkvoice/api_op_CreateSipMediaApplication.go b/service/chimesdkvoice/api_op_CreateSipMediaApplication.go index dd330d3aadf..7efdc14d180 100644 --- a/service/chimesdkvoice/api_op_CreateSipMediaApplication.go +++ b/service/chimesdkvoice/api_op_CreateSipMediaApplication.go @@ -12,8 +12,9 @@ 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) -// in the Amazon Chime SDK Administrator Guide. +// applications, see [Managing SIP media applications and rules]in the Amazon Chime SDK Administrator Guide. +// +// [Managing SIP media applications and rules]: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html func (c *Client) CreateSipMediaApplication(ctx context.Context, params *CreateSipMediaApplicationInput, optFns ...func(*Options)) (*CreateSipMediaApplicationOutput, error) { if params == nil { params = &CreateSipMediaApplicationInput{} diff --git a/service/chimesdkvoice/api_op_CreateSipRule.go b/service/chimesdkvoice/api_op_CreateSipRule.go index b4779bf2ff0..cccadca0ecf 100644 --- a/service/chimesdkvoice/api_op_CreateSipRule.go +++ b/service/chimesdkvoice/api_op_CreateSipRule.go @@ -12,9 +12,10 @@ import ( ) // 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) +// target for a specific trigger type. For more information about SIP rules, see [Managing SIP media applications and rules] // in the Amazon Chime SDK Administrator Guide. +// +// [Managing SIP media applications and rules]: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html func (c *Client) CreateSipRule(ctx context.Context, params *CreateSipRuleInput, optFns ...func(*Options)) (*CreateSipRuleOutput, error) { if params == nil { params = &CreateSipRuleInput{} diff --git a/service/chimesdkvoice/api_op_CreateVoiceConnector.go b/service/chimesdkvoice/api_op_CreateVoiceConnector.go index 129d2336d8c..1fdba3612b6 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceConnector.go +++ b/service/chimesdkvoice/api_op_CreateVoiceConnector.go @@ -12,8 +12,9 @@ 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]in the Amazon Chime SDK Administrator Guide. +// +// [Managing Amazon Chime SDK Voice Connector groups]: https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html func (c *Client) CreateVoiceConnector(ctx context.Context, params *CreateVoiceConnectorInput, optFns ...func(*Options)) (*CreateVoiceConnectorOutput, error) { if params == nil { params = &CreateVoiceConnectorInput{} diff --git a/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go b/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go index bdded57d70f..e5d608e51ba 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go +++ b/service/chimesdkvoice/api_op_CreateVoiceConnectorGroup.go @@ -13,9 +13,10 @@ 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 0853b1af4ff..31c738e6796 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceProfile.go +++ b/service/chimesdkvoice/api_op_CreateVoiceProfile.go @@ -12,12 +12,17 @@ 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. +// 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]for the Amazon Chime SDK. +// +// For more information about voice profiles and voice analytics, see [Using Amazon Chime SDK Voice Analytics] in the +// Amazon Chime SDK Developer Guide. +// +// [AWS service terms]: https://aws.amazon.com/service-terms/ +// [Using Amazon Chime SDK Voice Analytics]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html 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 e971d7f2da4..69eddde6d3b 100644 --- a/service/chimesdkvoice/api_op_CreateVoiceProfileDomain.go +++ b/service/chimesdkvoice/api_op_CreateVoiceProfileDomain.go @@ -12,13 +12,17 @@ import ( ) // Creates a voice profile domain, a collection of voice profiles, their voice -// prints, and encrypted enrollment audio. 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 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. +// prints, and encrypted enrollment audio. +// +// 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]for the Amazon Chime SDK. +// +// For more information about voice profile domains, see [Using Amazon Chime SDK Voice Analytics] in the Amazon Chime SDK +// Developer Guide. +// +// [AWS service terms]: https://aws.amazon.com/service-terms/ +// [Using Amazon Chime SDK Voice Analytics]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html 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 17b5955544a..a043fb09e8d 100644 --- a/service/chimesdkvoice/api_op_DeletePhoneNumber.go +++ b/service/chimesdkvoice/api_op_DeletePhoneNumber.go @@ -12,8 +12,10 @@ import ( // 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. +// 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_DeleteVoiceConnectorOrigination.go b/service/chimesdkvoice/api_op_DeleteVoiceConnectorOrigination.go index 3354cab353b..b46d8507c24 100644 --- a/service/chimesdkvoice/api_op_DeleteVoiceConnectorOrigination.go +++ b/service/chimesdkvoice/api_op_DeleteVoiceConnectorOrigination.go @@ -11,8 +11,10 @@ import ( ) // Deletes the origination settings for the specified Amazon Chime SDK Voice -// Connector. If emergency calling is configured for the Voice Connector, it must -// be deleted prior to deleting the origination settings. +// Connector. +// +// If emergency calling is configured for the 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/chimesdkvoice/api_op_DeleteVoiceConnectorTermination.go b/service/chimesdkvoice/api_op_DeleteVoiceConnectorTermination.go index ed52e6c77e8..81ff3992da7 100644 --- a/service/chimesdkvoice/api_op_DeleteVoiceConnectorTermination.go +++ b/service/chimesdkvoice/api_op_DeleteVoiceConnectorTermination.go @@ -11,8 +11,10 @@ import ( ) // Deletes the termination settings for the specified Amazon Chime SDK Voice -// Connector. If emergency calling is configured for the Voice Connector, it must -// be deleted prior to deleting the termination settings. +// Connector. +// +// If emergency calling is configured for the 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/chimesdkvoice/api_op_GetSipMediaApplicationAlexaSkillConfiguration.go b/service/chimesdkvoice/api_op_GetSipMediaApplicationAlexaSkillConfiguration.go index 44586974146..b2bd551fd9c 100644 --- a/service/chimesdkvoice/api_op_GetSipMediaApplicationAlexaSkillConfiguration.go +++ b/service/chimesdkvoice/api_op_GetSipMediaApplicationAlexaSkillConfiguration.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the Alexa Skill configuration for the SIP media application. Due to -// changes made by the Amazon Alexa service, this API is no longer available for -// use. For more information, refer to the Alexa Smart Properties (https://developer.amazon.com/en-US/alexa/alexasmartproperties) -// page. +// Gets the Alexa Skill configuration for the SIP media application. +// +// Due to changes made by the Amazon Alexa service, this API is no longer +// available for use. For more information, refer to the [Alexa Smart Properties]page. // // Deprecated: Due to changes made by the Amazon Alexa service, this API is no // longer available for use. For more information, refer to the Alexa Smart // Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties). +// +// [Alexa Smart Properties]: https://developer.amazon.com/en-US/alexa/alexasmartproperties func (c *Client) GetSipMediaApplicationAlexaSkillConfiguration(ctx context.Context, params *GetSipMediaApplicationAlexaSkillConfigurationInput, optFns ...func(*Options)) (*GetSipMediaApplicationAlexaSkillConfigurationOutput, error) { if params == nil { params = &GetSipMediaApplicationAlexaSkillConfigurationInput{} diff --git a/service/chimesdkvoice/api_op_PutSipMediaApplicationAlexaSkillConfiguration.go b/service/chimesdkvoice/api_op_PutSipMediaApplicationAlexaSkillConfiguration.go index 913bc4a054b..aa9452033e4 100644 --- a/service/chimesdkvoice/api_op_PutSipMediaApplicationAlexaSkillConfiguration.go +++ b/service/chimesdkvoice/api_op_PutSipMediaApplicationAlexaSkillConfiguration.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the Alexa Skill configuration for the SIP media application. Due to -// changes made by the Amazon Alexa service, this API is no longer available for -// use. For more information, refer to the Alexa Smart Properties (https://developer.amazon.com/en-US/alexa/alexasmartproperties) -// page. +// Updates the Alexa Skill configuration for the SIP media application. +// +// Due to changes made by the Amazon Alexa service, this API is no longer +// available for use. For more information, refer to the [Alexa Smart Properties]page. // // Deprecated: Due to changes made by the Amazon Alexa service, this API is no // longer available for use. For more information, refer to the Alexa Smart // Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties). +// +// [Alexa Smart Properties]: https://developer.amazon.com/en-US/alexa/alexasmartproperties func (c *Client) PutSipMediaApplicationAlexaSkillConfiguration(ctx context.Context, params *PutSipMediaApplicationAlexaSkillConfigurationInput, optFns ...func(*Options)) (*PutSipMediaApplicationAlexaSkillConfigurationOutput, error) { if params == nil { params = &PutSipMediaApplicationAlexaSkillConfigurationInput{} diff --git a/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go b/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go index 8ec7ba50d70..bd2168923dc 100644 --- a/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go +++ b/service/chimesdkvoice/api_op_StartSpeakerSearchTask.go @@ -11,10 +11,13 @@ 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]for the Amazon Chime SDK. +// +// [AWS service terms]: https://aws.amazon.com/service-terms/ 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 c9660535812..56d094e1513 100644 --- a/service/chimesdkvoice/api_op_StartVoiceToneAnalysisTask.go +++ b/service/chimesdkvoice/api_op_StartVoiceToneAnalysisTask.go @@ -12,12 +12,14 @@ 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 -// 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. +// analysis, see [Using Amazon Chime SDK voice analytics]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]for the Amazon Chime SDK. +// +// [Using Amazon Chime SDK voice analytics]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html +// [AWS service terms]: https://aws.amazon.com/service-terms/ func (c *Client) StartVoiceToneAnalysisTask(ctx context.Context, params *StartVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*StartVoiceToneAnalysisTaskOutput, error) { if params == nil { params = &StartVoiceToneAnalysisTaskInput{} diff --git a/service/chimesdkvoice/api_op_UpdatePhoneNumber.go b/service/chimesdkvoice/api_op_UpdatePhoneNumber.go index 4990f385211..2d1082795f7 100644 --- a/service/chimesdkvoice/api_op_UpdatePhoneNumber.go +++ b/service/chimesdkvoice/api_op_UpdatePhoneNumber.go @@ -14,10 +14,14 @@ import ( // Updates phone number details, such as product type, calling name, or phone // number name for the specified phone number ID. You can update one phone number // detail at a time. For example, you can update either the product type, calling -// name, or phone number name in one action. For numbers outside the U.S., you must -// use the Amazon Chime SDK SIP Media Application Dial-In product type. Updates to -// outbound calling names can take 72 hours to complete. Pending updates to -// outbound calling names must be complete before you can request another update. +// name, or phone number name in one action. +// +// For numbers outside the U.S., you must use the Amazon Chime SDK SIP Media +// Application Dial-In product type. +// +// Updates to outbound calling names can take 72 hours to complete. Pending +// updates to outbound calling names must be complete before you can request +// another update. func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error) { if params == nil { params = &UpdatePhoneNumberInput{} diff --git a/service/chimesdkvoice/api_op_UpdateVoiceProfile.go b/service/chimesdkvoice/api_op_UpdateVoiceProfile.go index db4f40c167f..72dd0c41864 100644 --- a/service/chimesdkvoice/api_op_UpdateVoiceProfile.go +++ b/service/chimesdkvoice/api_op_UpdateVoiceProfile.go @@ -12,15 +12,19 @@ import ( ) // Updates the specified voice profile’s voice print and refreshes its expiration -// timestamp. As a condition of using this feature, you acknowledge that the -// collection, use, storage, and retention of your caller’s biometric identifiers -// and biometric information (“biometric data”) in the form of a digital voiceprint -// requires the caller’s informed consent via a written release. Such consent is -// required under various state laws, including biometrics laws in Illinois, Texas, -// Washington and other state privacy laws. You must provide a written release to -// each caller through a process that clearly reflects each caller’s informed -// consent before using Amazon Chime SDK Voice Insights service, as required under -// the terms of your agreement with AWS governing your use of the service. +// timestamp. +// +// As a condition of using this feature, you acknowledge that the collection, use, +// storage, and retention of your caller’s biometric identifiers and biometric +// information (“biometric data”) in the form of a digital voiceprint requires the +// caller’s informed consent via a written release. Such consent is required under +// various state laws, including biometrics laws in Illinois, Texas, Washington and +// other state privacy laws. +// +// You must provide a written release to each caller through a process that +// clearly reflects each caller’s informed consent before using Amazon Chime SDK +// Voice Insights service, as required under the terms of your agreement with AWS +// governing your use of the service. func (c *Client) UpdateVoiceProfile(ctx context.Context, params *UpdateVoiceProfileInput, optFns ...func(*Options)) (*UpdateVoiceProfileOutput, error) { if params == nil { params = &UpdateVoiceProfileInput{} diff --git a/service/chimesdkvoice/options.go b/service/chimesdkvoice/options.go index b74af6f12eb..755d0b77f64 100644 --- a/service/chimesdkvoice/options.go +++ b/service/chimesdkvoice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/chimesdkvoice/types/enums.go b/service/chimesdkvoice/types/enums.go index 882bfd7aa97..fbe8b3ee3d3 100644 --- a/service/chimesdkvoice/types/enums.go +++ b/service/chimesdkvoice/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AlexaSkillStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlexaSkillStatus) Values() []AlexaSkillStatus { return []AlexaSkillStatus{ "ACTIVE", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for CallingNameStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallingNameStatus) Values() []CallingNameStatus { return []CallingNameStatus{ "Unassigned", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for CallLegType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallLegType) Values() []CallLegType { return []CallLegType{ "Caller", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for Capability. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Capability) Values() []Capability { return []Capability{ "Voice", @@ -101,8 +105,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -133,8 +138,9 @@ const ( ) // Values returns all known values for GeoMatchLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoMatchLevel) Values() []GeoMatchLevel { return []GeoMatchLevel{ "Country", @@ -150,8 +156,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -168,8 +175,9 @@ const ( ) // Values returns all known values for NotificationTarget. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationTarget) Values() []NotificationTarget { return []NotificationTarget{ "EventBridge", @@ -187,8 +195,9 @@ const ( ) // Values returns all known values for NumberSelectionBehavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumberSelectionBehavior) Values() []NumberSelectionBehavior { return []NumberSelectionBehavior{ "PreferSticky", @@ -207,6 +216,7 @@ const ( // 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{ @@ -226,6 +236,7 @@ const ( // 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{ @@ -245,6 +256,7 @@ const ( // Values returns all known values for PhoneNumberAssociationName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberAssociationName) Values() []PhoneNumberAssociationName { return []PhoneNumberAssociationName{ @@ -272,8 +284,9 @@ const ( ) // Values returns all known values for PhoneNumberOrderStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberOrderStatus) Values() []PhoneNumberOrderStatus { return []PhoneNumberOrderStatus{ "Processing", @@ -299,8 +312,9 @@ const ( ) // Values returns all known values for PhoneNumberOrderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberOrderType) Values() []PhoneNumberOrderType { return []PhoneNumberOrderType{ "New", @@ -317,8 +331,9 @@ const ( ) // Values returns all known values for PhoneNumberProductType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberProductType) Values() []PhoneNumberProductType { return []PhoneNumberProductType{ "VoiceConnector", @@ -344,8 +359,9 @@ const ( ) // Values returns all known values for PhoneNumberStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberStatus) Values() []PhoneNumberStatus { return []PhoneNumberStatus{ "Cancelled", @@ -371,8 +387,9 @@ const ( ) // Values returns all known values for PhoneNumberType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberType) Values() []PhoneNumberType { return []PhoneNumberType{ "Local", @@ -390,8 +407,9 @@ const ( ) // Values returns all known values for ProxySessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProxySessionStatus) Values() []ProxySessionStatus { return []ProxySessionStatus{ "Open", @@ -409,8 +427,9 @@ const ( ) // Values returns all known values for SipRuleTriggerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SipRuleTriggerType) Values() []SipRuleTriggerType { return []SipRuleTriggerType{ "ToPhoneNumber", @@ -435,8 +454,9 @@ const ( ) // Values returns all known values for VoiceConnectorAwsRegion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceConnectorAwsRegion) Values() []VoiceConnectorAwsRegion { return []VoiceConnectorAwsRegion{ "us-east-1", diff --git a/service/chimesdkvoice/types/types.go b/service/chimesdkvoice/types/types.go index 8b8eece7209..582eda35ce3 100644 --- a/service/chimesdkvoice/types/types.go +++ b/service/chimesdkvoice/types/types.go @@ -187,8 +187,9 @@ type OrderedPhoneNumber struct { } // Origination settings enable your SIP hosts to receive inbound calls using your -// Amazon Chime SDK Voice Connector. The parameters listed below are not required, -// but you must use at least one. +// Amazon Chime SDK Voice Connector. +// +// The parameters listed below are not required, but you must use at least one. type Origination struct { // When origination settings are disabled, inbound calls are not enabled for your @@ -206,8 +207,9 @@ type Origination struct { // Origination routes define call distribution properties for your SIP hosts to // receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten -// origination routes for each Voice Connector. The parameters listed below are not -// required, but you must use at least one. +// origination routes for each Voice Connector. +// +// The parameters listed below are not required, but you must use at least one. type OriginationRoute struct { // The FQDN or IP address to contact for origination traffic. @@ -460,9 +462,10 @@ 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 @@ -503,10 +506,12 @@ type SipMediaApplication struct { noSmithyDocumentSerde } -// The Alexa Skill configuration of a SIP media application. Due to changes made -// by the Amazon Alexa service, this data type is no longer available for use. For -// more information, refer to the Alexa Smart Properties (https://developer.amazon.com/en-US/alexa/alexasmartproperties) -// page. +// The Alexa Skill configuration of a SIP media application. +// +// Due to changes made by the Amazon Alexa service, this data type is no longer +// available for use. For more information, refer to the [Alexa Smart Properties]page. +// +// [Alexa Smart Properties]: https://developer.amazon.com/en-US/alexa/alexasmartproperties type SipMediaApplicationAlexaSkillConfiguration struct { // The ID of the Alexa Skill configuration. @@ -747,7 +752,7 @@ type TerminationHealth struct { } // The phone number ID, product type, or calling name fields to update, used with -// the BatchUpdatePhoneNumber and UpdatePhoneNumber actions. +// the BatchUpdatePhoneNumberand UpdatePhoneNumber actions. type UpdatePhoneNumberRequestItem struct { // The phone number ID to update. diff --git a/service/cleanrooms/api_op_CreateCollaboration.go b/service/cleanrooms/api_op_CreateCollaboration.go index 6b9dab39dc6..e292a22d553 100644 --- a/service/cleanrooms/api_op_CreateCollaboration.go +++ b/service/cleanrooms/api_op_CreateCollaboration.go @@ -61,9 +61,10 @@ type CreateCollaborationInput struct { QueryLogStatus types.CollaborationQueryLogStatus // The collaboration creator's payment responsibilities set by the collaboration - // creator. If the collaboration creator hasn't specified anyone as the member - // paying for query compute costs, then the member who can query is the default - // payer. + // creator. + // + // If the collaboration creator hasn't specified anyone as the member paying for + // query compute costs, then the member who can query is the default payer. CreatorPaymentConfiguration *types.PaymentConfiguration // The settings for client-side encryption with Cryptographic Computing for Clean diff --git a/service/cleanrooms/api_op_CreateConfiguredAudienceModelAssociation.go b/service/cleanrooms/api_op_CreateConfiguredAudienceModelAssociation.go index 588ebc6bbfe..b169e379f2b 100644 --- a/service/cleanrooms/api_op_CreateConfiguredAudienceModelAssociation.go +++ b/service/cleanrooms/api_op_CreateConfiguredAudienceModelAssociation.go @@ -45,11 +45,12 @@ type CreateConfiguredAudienceModelAssociationInput struct { // resource being associated is configured for Clean Rooms to manage permissions // related to the given collaboration. When FALSE , indicates that the configured // audience model resource owner will manage permissions related to the given - // collaboration. Setting this to TRUE requires you to have permissions to create, - // update, and delete the resource policy for the cleanrooms-ml resource when you - // call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you - // are the collaboration creator and specify TRUE , you must have the same - // permissions when you call the DeleteMember and DeleteCollaboration APIs. + // collaboration. + // + // Setting this to TRUE requires you to have permissions to create, update, and + // delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation + // resource. In addition, if you are the collaboration creator and specify TRUE , + // you must have the same permissions when you call the DeleteMemberand DeleteCollaboration APIs. // // This member is required. ManageResourcePolicies *bool diff --git a/service/cleanrooms/api_op_CreateMembership.go b/service/cleanrooms/api_op_CreateMembership.go index 1e2a529a48b..2c08bc63642 100644 --- a/service/cleanrooms/api_op_CreateMembership.go +++ b/service/cleanrooms/api_op_CreateMembership.go @@ -45,10 +45,12 @@ type CreateMembershipInput struct { // can receive results. DefaultResultConfiguration *types.MembershipProtectedQueryResultConfiguration - // The payment responsibilities accepted by the collaboration member. Not required - // if the collaboration member has the member ability to run queries. Required if - // the collaboration member doesn't have the member ability to run queries but is - // configured as a payer by the collaboration creator. + // The payment responsibilities accepted by the collaboration member. + // + // Not required if the collaboration member has the member ability to run queries. + // + // Required if the collaboration member doesn't have the member ability to run + // queries but is configured as a payer by the collaboration creator. PaymentConfiguration *types.MembershipPaymentConfiguration // An optional label that you can assign to a resource when you create it. Each diff --git a/service/cleanrooms/api_op_CreatePrivacyBudgetTemplate.go b/service/cleanrooms/api_op_CreatePrivacyBudgetTemplate.go index 6c7b45bc283..a616659fd4b 100644 --- a/service/cleanrooms/api_op_CreatePrivacyBudgetTemplate.go +++ b/service/cleanrooms/api_op_CreatePrivacyBudgetTemplate.go @@ -13,8 +13,8 @@ import ( // Creates a privacy budget template for a specified membership. Each membership // can have only one privacy budget template, but it can be deleted and recreated. -// If you need to change the privacy budget template for a membership, use the -// UpdatePrivacyBudgetTemplate operation. +// If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate +// operation. func (c *Client) CreatePrivacyBudgetTemplate(ctx context.Context, params *CreatePrivacyBudgetTemplateInput, optFns ...func(*Options)) (*CreatePrivacyBudgetTemplateOutput, error) { if params == nil { params = &CreatePrivacyBudgetTemplateInput{} @@ -32,12 +32,14 @@ func (c *Client) CreatePrivacyBudgetTemplate(ctx context.Context, params *Create type CreatePrivacyBudgetTemplateInput struct { - // How often the privacy budget refreshes. If you plan to regularly bring new data - // into the collaboration, you can use CALENDAR_MONTH to automatically get a new - // privacy budget for the collaboration every calendar month. Choosing this option - // allows arbitrary amounts of information to be revealed about rows of the data - // when repeatedly queries across refreshes. Avoid choosing this if the same rows - // will be repeatedly queried between privacy budget refreshes. + // How often the privacy budget refreshes. + // + // If you plan to regularly bring new data into the collaboration, you can use + // CALENDAR_MONTH to automatically get a new privacy budget for the collaboration + // every calendar month. Choosing this option allows arbitrary amounts of + // information to be revealed about rows of the data when repeatedly queries across + // refreshes. Avoid choosing this if the same rows will be repeatedly queried + // between privacy budget refreshes. // // This member is required. AutoRefresh types.PrivacyBudgetTemplateAutoRefresh diff --git a/service/cleanrooms/doc.go b/service/cleanrooms/doc.go index bb0090724ab..3eaa1c0e1a1 100644 --- a/service/cleanrooms/doc.go +++ b/service/cleanrooms/doc.go @@ -3,13 +3,20 @@ // Package cleanrooms provides the API client, operations, and parameter types for // AWS Clean Rooms Service. // -// Welcome to the Clean Rooms API Reference. Clean Rooms is an Amazon Web Services -// service that helps multiple parties to join their data together in a secure -// collaboration workspace. In the collaboration, members who can query and receive -// results can get insights into the collective datasets without either party -// getting access to the other party's raw data. To learn more about Clean Rooms -// concepts, procedures, and best practices, see the Clean Rooms User Guide (https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html) -// . To learn more about SQL commands, functions, and conditions supported in Clean -// Rooms, see the Clean Rooms SQL Reference (https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html) -// . +// Welcome to the Clean Rooms API Reference. +// +// Clean Rooms is an Amazon Web Services service that helps multiple parties to +// join their data together in a secure collaboration workspace. In the +// collaboration, members who can query and receive results can get insights into +// the collective datasets without either party getting access to the other party's +// raw data. +// +// To learn more about Clean Rooms concepts, procedures, and best practices, see +// the [Clean Rooms User Guide]. +// +// To learn more about SQL commands, functions, and conditions supported in Clean +// Rooms, see the [Clean Rooms SQL Reference]. +// +// [Clean Rooms User Guide]: https://docs.aws.amazon.com/clean-rooms/latest/userguide/what-is.html +// [Clean Rooms SQL Reference]: https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html package cleanrooms diff --git a/service/cleanrooms/options.go b/service/cleanrooms/options.go index 722ec717498..b9c945cc997 100644 --- a/service/cleanrooms/options.go +++ b/service/cleanrooms/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cleanrooms/types/enums.go b/service/cleanrooms/types/enums.go index c26af830d80..d40d36800bb 100644 --- a/service/cleanrooms/types/enums.go +++ b/service/cleanrooms/types/enums.go @@ -11,6 +11,7 @@ const ( // Values returns all known values for AccessDeniedExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AccessDeniedExceptionReason) Values() []AccessDeniedExceptionReason { return []AccessDeniedExceptionReason{ @@ -30,8 +31,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SUM", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for AggregationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationType) Values() []AggregationType { return []AggregationType{ "COUNT_DISTINCT", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for AnalysisFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisFormat) Values() []AnalysisFormat { return []AnalysisFormat{ "SQL", @@ -82,8 +86,9 @@ const ( ) // Values returns all known values for AnalysisMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisMethod) Values() []AnalysisMethod { return []AnalysisMethod{ "DIRECT_QUERY", @@ -100,8 +105,9 @@ const ( ) // Values returns all known values for AnalysisRuleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisRuleType) Values() []AnalysisRuleType { return []AnalysisRuleType{ "AGGREGATION", @@ -121,8 +127,9 @@ const ( // Values returns all known values for AnalysisTemplateValidationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisTemplateValidationStatus) Values() []AnalysisTemplateValidationStatus { return []AnalysisTemplateValidationStatus{ "VALID", @@ -140,8 +147,9 @@ const ( // Values returns all known values for AnalysisTemplateValidationType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisTemplateValidationType) Values() []AnalysisTemplateValidationType { return []AnalysisTemplateValidationType{ "DIFFERENTIAL_PRIVACY", @@ -158,6 +166,7 @@ const ( // Values returns all known values for CollaborationQueryLogStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CollaborationQueryLogStatus) Values() []CollaborationQueryLogStatus { return []CollaborationQueryLogStatus{ @@ -177,8 +186,9 @@ const ( // Values returns all known values for ConfiguredTableAnalysisRuleType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfiguredTableAnalysisRuleType) Values() []ConfiguredTableAnalysisRuleType { return []ConfiguredTableAnalysisRuleType{ "AGGREGATION", @@ -197,8 +207,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "ALREADY_EXISTS", @@ -220,8 +231,9 @@ const ( // Values returns all known values for DifferentialPrivacyAggregationType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DifferentialPrivacyAggregationType) Values() []DifferentialPrivacyAggregationType { return []DifferentialPrivacyAggregationType{ "AVG", @@ -241,8 +253,9 @@ const ( ) // Values returns all known values for FilterableMemberStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterableMemberStatus) Values() []FilterableMemberStatus { return []FilterableMemberStatus{ "INVITED", @@ -259,8 +272,9 @@ const ( ) // Values returns all known values for JoinOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JoinOperator) Values() []JoinOperator { return []JoinOperator{ "OR", @@ -276,8 +290,9 @@ const ( ) // Values returns all known values for JoinRequiredOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JoinRequiredOption) Values() []JoinRequiredOption { return []JoinRequiredOption{ "QUERY_RUNNER", @@ -293,8 +308,9 @@ const ( ) // Values returns all known values for MemberAbility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberAbility) Values() []MemberAbility { return []MemberAbility{ "CAN_QUERY", @@ -312,6 +328,7 @@ const ( // 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{ @@ -330,8 +347,9 @@ const ( ) // Values returns all known values for MembershipStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MembershipStatus) Values() []MembershipStatus { return []MembershipStatus{ "ACTIVE", @@ -351,8 +369,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -384,8 +403,9 @@ const ( ) // Values returns all known values for ParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterType) Values() []ParameterType { return []ParameterType{ "SMALLINT", @@ -416,8 +436,9 @@ const ( // Values returns all known values for PrivacyBudgetTemplateAutoRefresh. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrivacyBudgetTemplateAutoRefresh) Values() []PrivacyBudgetTemplateAutoRefresh { return []PrivacyBudgetTemplateAutoRefresh{ "CALENDAR_MONTH", @@ -433,8 +454,9 @@ const ( ) // Values returns all known values for PrivacyBudgetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrivacyBudgetType) Values() []PrivacyBudgetType { return []PrivacyBudgetType{ "DIFFERENTIAL_PRIVACY", @@ -455,8 +477,9 @@ const ( ) // Values returns all known values for ProtectedQueryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectedQueryStatus) Values() []ProtectedQueryStatus { return []ProtectedQueryStatus{ "SUBMITTED", @@ -477,8 +500,9 @@ const ( ) // Values returns all known values for ProtectedQueryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectedQueryType) Values() []ProtectedQueryType { return []ProtectedQueryType{ "SQL", @@ -496,8 +520,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -516,8 +541,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -556,8 +582,9 @@ const ( ) // Values returns all known values for ScalarFunctions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalarFunctions) Values() []ScalarFunctions { return []ScalarFunctions{ "ABS", @@ -595,8 +622,9 @@ const ( ) // Values returns all known values for SchemaConfiguration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaConfiguration) Values() []SchemaConfiguration { return []SchemaConfiguration{ "DIFFERENTIAL_PRIVACY", @@ -612,8 +640,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "READY", @@ -632,8 +661,9 @@ const ( ) // Values returns all known values for SchemaStatusReasonCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaStatusReasonCode) Values() []SchemaStatusReasonCode { return []SchemaStatusReasonCode{ "ANALYSIS_RULE_MISSING", @@ -651,8 +681,9 @@ const ( ) // Values returns all known values for SchemaType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaType) Values() []SchemaType { return []SchemaType{ "TABLE", @@ -668,6 +699,7 @@ const ( // Values returns all known values for TargetProtectedQueryStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TargetProtectedQueryStatus) Values() []TargetProtectedQueryStatus { return []TargetProtectedQueryStatus{ @@ -687,6 +719,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/cleanrooms/types/types.go b/service/cleanrooms/types/types.go index 00f9a942ecf..582e6a4ee0a 100644 --- a/service/cleanrooms/types/types.go +++ b/service/cleanrooms/types/types.go @@ -409,9 +409,11 @@ type AnalysisTemplateSummary struct { // query structure. Validation is performed when analysis templates are created and // fetched. Because analysis templates are immutable by design, we recommend that // you create analysis templates after you associate the configured tables with -// their analysis rule to your collaboration. For more information, see -// https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy (https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy) -// . +// their analysis rule to your collaboration. +// +// For more information, see [https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy]. +// +// [https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy]: https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy type AnalysisTemplateValidationStatusDetail struct { // The status of the validation. @@ -878,12 +880,14 @@ type CollaborationPrivacyBudgetTemplate struct { // This member is required. Arn *string - // How often the privacy budget refreshes. If you plan to regularly bring new data - // into the collaboration, use CALENDAR_MONTH to automatically get a new privacy - // budget for the collaboration every calendar month. Choosing this option allows - // arbitrary amounts of information to be revealed about rows of the data when - // repeatedly queried across refreshes. Avoid choosing this if the same rows will - // be repeatedly queried between privacy budget refreshes. + // How often the privacy budget refreshes. + // + // If you plan to regularly bring new data into the collaboration, use + // CALENDAR_MONTH to automatically get a new privacy budget for the collaboration + // every calendar month. Choosing this option allows arbitrary amounts of + // information to be revealed about rows of the data when repeatedly queried across + // refreshes. Avoid choosing this if the same rows will be repeatedly queried + // between privacy budget refreshes. // // This member is required. AutoRefresh PrivacyBudgetTemplateAutoRefresh @@ -1890,11 +1894,16 @@ type MembershipQueryComputePaymentConfig struct { // Indicates whether the collaboration member has accepted to pay for query // compute costs ( TRUE ) or has not accepted to pay for query compute costs ( FALSE - // ). If the collaboration creator has not specified anyone to pay for query - // compute costs, then the member who can query is the default payer. An error - // message is returned for the following reasons: + // ). + // + // If the collaboration creator has not specified anyone to pay for query compute + // costs, then the member who can query is the default payer. + // + // An error message is returned for the following reasons: + // // - If you set the value to FALSE but you are responsible to pay for query // compute costs. + // // - If you set the value to TRUE but you are not responsible to pay for query // compute costs. // @@ -1991,9 +2000,10 @@ type MemberSpecification struct { MemberAbilities []MemberAbility // The collaboration member's payment responsibilities set by the collaboration - // creator. If the collaboration creator hasn't specified anyone as the member - // paying for query compute costs, then the member who can query is the default - // payer. + // creator. + // + // If the collaboration creator hasn't specified anyone as the member paying for + // query compute costs, then the member who can query is the default payer. PaymentConfiguration *PaymentConfiguration noSmithyDocumentSerde @@ -2174,12 +2184,14 @@ type PrivacyBudgetTemplate struct { // This member is required. Arn *string - // How often the privacy budget refreshes. If you plan to regularly bring new data - // into the collaboration, use CALENDAR_MONTH to automatically get a new privacy - // budget for the collaboration every calendar month. Choosing this option allows - // arbitrary amounts of information to be revealed about rows of the data when - // repeatedly queried across refreshes. Avoid choosing this if the same rows will - // be repeatedly queried between privacy budget refreshes. + // How often the privacy budget refreshes. + // + // If you plan to regularly bring new data into the collaboration, use + // CALENDAR_MONTH to automatically get a new privacy budget for the collaboration + // every calendar month. Choosing this option allows arbitrary amounts of + // information to be revealed about rows of the data when repeatedly queried across + // refreshes. Avoid choosing this if the same rows will be repeatedly queried + // between privacy budget refreshes. // // This member is required. AutoRefresh PrivacyBudgetTemplateAutoRefresh @@ -2605,13 +2617,16 @@ type QueryComputePaymentConfig struct { // Indicates whether the collaboration creator has configured the collaboration // member to pay for query compute costs ( TRUE ) or has not configured the - // collaboration member to pay for query compute costs ( FALSE ). Exactly one - // member can be configured to pay for query compute costs. An error is returned if - // the collaboration creator sets a TRUE value for more than one member in the - // collaboration. If the collaboration creator hasn't specified anyone as the - // member paying for query compute costs, then the member who can query is the - // default payer. An error is returned if the collaboration creator sets a FALSE - // value for the member who can query. + // collaboration member to pay for query compute costs ( FALSE ). + // + // Exactly one member can be configured to pay for query compute costs. An error + // is returned if the collaboration creator sets a TRUE value for more than one + // member in the collaboration. + // + // If the collaboration creator hasn't specified anyone as the member paying for + // query compute costs, then the member who can query is the default payer. An + // error is returned if the collaboration creator sets a FALSE value for the + // member who can query. // // This member is required. IsResponsible *bool @@ -2709,9 +2724,10 @@ type SchemaAnalysisRuleRequest struct { noSmithyDocumentSerde } -// Information about the schema status. A status of READY means that based on the -// schema analysis rule, queries of the given analysis rule type are properly -// configured to run queries on this schema. +// Information about the schema status. +// +// A status of READY means that based on the schema analysis rule, queries of the +// given analysis rule type are properly configured to run queries on this schema. type SchemaStatusDetail struct { // The status of the schema. diff --git a/service/cleanroomsml/api_op_CreateAudienceModel.go b/service/cleanroomsml/api_op_CreateAudienceModel.go index 2a4eadfa579..d91574e05d9 100644 --- a/service/cleanroomsml/api_op_CreateAudienceModel.go +++ b/service/cleanroomsml/api_op_CreateAudienceModel.go @@ -14,8 +14,7 @@ import ( // Defines the information necessary to create an audience model. An audience // model is a machine learning model that Clean Rooms ML trains to measure // similarity between users. Clean Rooms ML manages training and storing the -// audience model. The audience model can be used in multiple calls to the -// StartAudienceGenerationJob API. +// audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJobAPI. func (c *Client) CreateAudienceModel(ctx context.Context, params *CreateAudienceModelInput, optFns ...func(*Options)) (*CreateAudienceModelOutput, error) { if params == nil { params = &CreateAudienceModelInput{} @@ -52,17 +51,26 @@ type CreateAudienceModelInput struct { // The optional metadata that you apply to the 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: + // 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 AWS use. You cannot edit or delete tag // keys with this prefix. Values can have this prefix. If a tag value has aws as diff --git a/service/cleanroomsml/api_op_CreateConfiguredAudienceModel.go b/service/cleanroomsml/api_op_CreateConfiguredAudienceModel.go index 5eb8834ac49..8c312478167 100644 --- a/service/cleanroomsml/api_op_CreateConfiguredAudienceModel.go +++ b/service/cleanroomsml/api_op_CreateConfiguredAudienceModel.go @@ -55,21 +55,22 @@ type CreateConfiguredAudienceModelInput struct { SharedAudienceMetrics []types.SharedAudienceMetrics // Configure the list of output sizes of audiences that can be created using this - // configured audience model. A request to StartAudienceGenerationJob that uses - // this configured audience model must have an audienceSize selected from this - // list. You can use the ABSOLUTE AudienceSize to configure out audience sizes - // using the count of identifiers in the output. You can use the Percentage - // AudienceSize to configure sizes in the range 1-100 percent. + // configured audience model. A request to StartAudienceGenerationJobthat uses this configured audience + // model must have an audienceSize selected from this list. You can use the + // ABSOLUTEAudienceSize to configure out audience sizes using the count of identifiers in the + // output. You can use the PercentageAudienceSize to configure sizes in the range 1-100 + // percent. AudienceSizeConfig *types.AudienceSizeConfig // Configure how the service tags audience generation jobs created using this - // configured audience model. If you specify NONE , the tags from the - // StartAudienceGenerationJob request determine the tags of the audience generation - // job. If you specify FROM_PARENT_RESOURCE , the audience generation job inherits - // the tags from the configured audience model, by default. Tags in the - // StartAudienceGenerationJob will override the default. When the client is in a - // different account than the configured audience model, the tags from the client - // are never applied to a resource in the caller's account. + // configured audience model. If you specify NONE , the tags from the StartAudienceGenerationJob request + // determine the tags of the audience generation job. If you specify + // FROM_PARENT_RESOURCE , the audience generation job inherits the tags from the + // configured audience model, by default. Tags in the StartAudienceGenerationJobwill override the default. + // + // When the client is in a different account than the configured audience model, + // the tags from the client are never applied to a resource in the caller's + // account. ChildResourceTagOnCreatePolicy types.TagOnCreatePolicy // The description of the configured audience model. @@ -81,17 +82,26 @@ type CreateConfiguredAudienceModelInput struct { // The optional metadata that you apply to the 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: + // 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 AWS use. You cannot edit or delete tag // keys with this prefix. Values can have this prefix. If a tag value has aws as diff --git a/service/cleanroomsml/api_op_CreateTrainingDataset.go b/service/cleanroomsml/api_op_CreateTrainingDataset.go index 221d37d7777..6675ff66cdf 100644 --- a/service/cleanroomsml/api_op_CreateTrainingDataset.go +++ b/service/cleanroomsml/api_op_CreateTrainingDataset.go @@ -38,9 +38,10 @@ type CreateTrainingDatasetInput struct { Name *string // The ARN of the IAM role that Clean Rooms ML can assume to read the data - // referred to in the dataSource field of each dataset. Passing a role across AWS - // accounts is not allowed. If you pass a role that isn't in your account, you get - // an AccessDeniedException error. + // referred to in the dataSource field of each dataset. + // + // Passing a role across AWS accounts is not allowed. If you pass a role that + // isn't in your account, you get an AccessDeniedException error. // // This member is required. RoleArn *string @@ -57,17 +58,26 @@ type CreateTrainingDatasetInput struct { // The optional metadata that you apply to the 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: + // 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 AWS use. You cannot edit or delete tag // keys with this prefix. Values can have this prefix. If a tag value has aws as diff --git a/service/cleanroomsml/api_op_GetConfiguredAudienceModel.go b/service/cleanroomsml/api_op_GetConfiguredAudienceModel.go index a8313434288..fa475c0bfd5 100644 --- a/service/cleanroomsml/api_op_GetConfiguredAudienceModel.go +++ b/service/cleanroomsml/api_op_GetConfiguredAudienceModel.go @@ -83,11 +83,10 @@ type GetConfiguredAudienceModelOutput struct { UpdateTime *time.Time // The list of output sizes of audiences that can be created using this configured - // audience model. A request to StartAudienceGenerationJob that uses this - // configured audience model must have an audienceSize selected from this list. - // You can use the ABSOLUTE AudienceSize to configure out audience sizes using the - // count of identifiers in the output. You can use the Percentage AudienceSize to - // configure sizes in the range 1-100 percent. + // audience model. A request to StartAudienceGenerationJobthat uses this configured audience model must have + // an audienceSize selected from this list. You can use the ABSOLUTEAudienceSize to configure + // out audience sizes using the count of identifiers in the output. You can use the + // PercentageAudienceSize to configure sizes in the range 1-100 percent. AudienceSizeConfig *types.AudienceSizeConfig // Provides the childResourceTagOnCreatePolicy that was used for this configured diff --git a/service/cleanroomsml/api_op_StartAudienceGenerationJob.go b/service/cleanroomsml/api_op_StartAudienceGenerationJob.go index 8d1194e5460..b23896497c3 100644 --- a/service/cleanroomsml/api_op_StartAudienceGenerationJob.go +++ b/service/cleanroomsml/api_op_StartAudienceGenerationJob.go @@ -56,17 +56,26 @@ type StartAudienceGenerationJobInput struct { // The optional metadata that you apply to the 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: + // 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 AWS use. You cannot edit or delete tag // keys with this prefix. Values can have this prefix. If a tag value has aws as diff --git a/service/cleanroomsml/api_op_TagResource.go b/service/cleanroomsml/api_op_TagResource.go index 6d19eafe150..2f09cd3a432 100644 --- a/service/cleanroomsml/api_op_TagResource.go +++ b/service/cleanroomsml/api_op_TagResource.go @@ -35,17 +35,26 @@ type TagResourceInput struct { // The optional metadata that you apply to the 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: + // 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 AWS use. You cannot edit or delete tag // keys with this prefix. Values can have this prefix. If a tag value has aws as diff --git a/service/cleanroomsml/doc.go b/service/cleanroomsml/doc.go index a6091b6fb57..ab23f179f63 100644 --- a/service/cleanroomsml/doc.go +++ b/service/cleanroomsml/doc.go @@ -3,16 +3,22 @@ // Package cleanroomsml provides the API client, operations, and parameter types // for AWS Clean Rooms ML. // -// Welcome to the Amazon Web Services Clean Rooms ML API Reference. Amazon Web -// Services Clean Rooms ML provides a privacy-enhancing method for two parties to -// identify similar users in their data without the need to share their data with -// each other. The first party brings the training data to Clean Rooms so that they -// can create and configure an audience model (lookalike model) and associate it -// with a collaboration. The second party then brings their seed data to Clean -// Rooms and generates an audience (lookalike segment) that resembles the training -// data. To learn more about Amazon Web Services Clean Rooms ML concepts, -// procedures, and best practices, see the Clean Rooms User Guide (https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html) -// . To learn more about SQL commands, functions, and conditions supported in Clean -// Rooms, see the Clean Rooms SQL Reference (https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html) -// . +// Welcome to the Amazon Web Services Clean Rooms ML API Reference. +// +// Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two +// parties to identify similar users in their data without the need to share their +// data with each other. The first party brings the training data to Clean Rooms so +// that they can create and configure an audience model (lookalike model) and +// associate it with a collaboration. The second party then brings their seed data +// to Clean Rooms and generates an audience (lookalike segment) that resembles the +// training data. +// +// To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, +// and best practices, see the [Clean Rooms User Guide]. +// +// To learn more about SQL commands, functions, and conditions supported in Clean +// Rooms, see the [Clean Rooms SQL Reference]. +// +// [Clean Rooms User Guide]: https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html +// [Clean Rooms SQL Reference]: https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html package cleanroomsml diff --git a/service/cleanroomsml/options.go b/service/cleanroomsml/options.go index cc25fe03792..7a61b93eb6b 100644 --- a/service/cleanroomsml/options.go +++ b/service/cleanroomsml/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cleanroomsml/types/enums.go b/service/cleanroomsml/types/enums.go index 19dd49df025..e63e32dbb76 100644 --- a/service/cleanroomsml/types/enums.go +++ b/service/cleanroomsml/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AudienceExportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudienceExportJobStatus) Values() []AudienceExportJobStatus { return []AudienceExportJobStatus{ "CREATE_PENDING", @@ -39,6 +40,7 @@ const ( // Values returns all known values for AudienceGenerationJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AudienceGenerationJobStatus) Values() []AudienceGenerationJobStatus { return []AudienceGenerationJobStatus{ @@ -66,8 +68,9 @@ const ( ) // Values returns all known values for AudienceModelStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudienceModelStatus) Values() []AudienceModelStatus { return []AudienceModelStatus{ "CREATE_PENDING", @@ -89,8 +92,9 @@ const ( ) // Values returns all known values for AudienceSizeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudienceSizeType) Values() []AudienceSizeType { return []AudienceSizeType{ "ABSOLUTE", @@ -110,8 +114,9 @@ const ( ) // Values returns all known values for ColumnType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnType) Values() []ColumnType { return []ColumnType{ "USER_ID", @@ -131,8 +136,9 @@ const ( // Values returns all known values for ConfiguredAudienceModelStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfiguredAudienceModelStatus) Values() []ConfiguredAudienceModelStatus { return []ConfiguredAudienceModelStatus{ "ACTIVE", @@ -147,8 +153,9 @@ const ( ) // Values returns all known values for DatasetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetType) Values() []DatasetType { return []DatasetType{ "INTERACTIONS", @@ -165,6 +172,7 @@ const ( // Values returns all known values for PolicyExistenceCondition. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PolicyExistenceCondition) Values() []PolicyExistenceCondition { return []PolicyExistenceCondition{ @@ -182,8 +190,9 @@ const ( ) // Values returns all known values for SharedAudienceMetrics. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SharedAudienceMetrics) Values() []SharedAudienceMetrics { return []SharedAudienceMetrics{ "ALL", @@ -200,8 +209,9 @@ const ( ) // Values returns all known values for TagOnCreatePolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TagOnCreatePolicy) Values() []TagOnCreatePolicy { return []TagOnCreatePolicy{ "FROM_PARENT_RESOURCE", @@ -217,8 +227,9 @@ const ( ) // Values returns all known values for TrainingDatasetStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingDatasetStatus) Values() []TrainingDatasetStatus { return []TrainingDatasetStatus{ "ACTIVE", diff --git a/service/cleanroomsml/types/types.go b/service/cleanroomsml/types/types.go index e64ebdcc56a..ad72195ad70 100644 --- a/service/cleanroomsml/types/types.go +++ b/service/cleanroomsml/types/types.go @@ -70,7 +70,10 @@ type AudienceGenerationJobDataSource struct { // Defines the Amazon S3 bucket where the seed audience for the generating // audience is stored. A valid data source is a JSON line file in the following - // format: {"user_id": "111111"} + // format: + // + // {"user_id": "111111"} + // // {"user_id": "222222"} // // ... @@ -197,9 +200,9 @@ type AudienceQualityMetrics struct { type AudienceSize struct { // Whether the audience size is defined in absolute terms or as a percentage. You - // can use the ABSOLUTE AudienceSize to configure out audience sizes using the - // count of identifiers in the output. You can use the Percentage AudienceSize to - // configure sizes in the range 1-100 percent. + // can use the ABSOLUTEAudienceSize to configure out audience sizes using the count of + // identifiers in the output. You can use the PercentageAudienceSize to configure sizes in the + // range 1-100 percent. // // This member is required. Type AudienceSizeType @@ -212,12 +215,11 @@ type AudienceSize struct { noSmithyDocumentSerde } -// Configure the list of audience output sizes that can be created. A request to -// StartAudienceGenerationJob that uses this configured audience model must have an -// audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to -// configure out audience sizes using the count of identifiers in the output. You -// can use the Percentage AudienceSize to configure sizes in the range 1-100 -// percent. +// Configure the list of audience output sizes that can be created. A request to StartAudienceGenerationJob +// that uses this configured audience model must have an audienceSize selected +// from this list. You can use the ABSOLUTEAudienceSize to configure out audience sizes using +// the count of identifiers in the output. You can use the PercentageAudienceSize to configure +// sizes in the range 1-100 percent. type AudienceSizeConfig struct { // An array of the different audience output sizes. diff --git a/service/cloud9/api_op_CreateEnvironmentEC2.go b/service/cloud9/api_op_CreateEnvironmentEC2.go index 5ba26ca3100..c818c5108be 100644 --- a/service/cloud9/api_op_CreateEnvironmentEC2.go +++ b/service/cloud9/api_op_CreateEnvironmentEC2.go @@ -33,24 +33,39 @@ type CreateEnvironmentEC2Input struct { // The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 // instance. To choose an AMI for the instance, you must specify a valid AMI alias - // or a valid Amazon EC2 Systems Manager (SSM) path. From December 04, 2023, you - // will be required to include the imageId parameter for the CreateEnvironmentEC2 - // action. This change will be reflected across all direct methods of communicating - // with the API, such as Amazon Web Services SDK, Amazon Web Services CLI and - // Amazon Web Services CloudFormation. This change will only affect direct API - // consumers, and not Cloud9 console users. We recommend using Amazon Linux 2023 as - // the AMI to create your environment as it is fully supported. Since Ubuntu 18.04 - // has ended standard support as of May 31, 2023, we recommend you choose Ubuntu - // 22.04. AMI aliases + // or a valid Amazon EC2 Systems Manager (SSM) path. + // + // From December 04, 2023, you will be required to include the imageId parameter + // for the CreateEnvironmentEC2 action. This change will be reflected across all + // direct methods of communicating with the API, such as Amazon Web Services SDK, + // Amazon Web Services CLI and Amazon Web Services CloudFormation. This change will + // only affect direct API consumers, and not Cloud9 console users. + // + // We recommend using Amazon Linux 2023 as the AMI to create your environment as + // it is fully supported. + // + // Since Ubuntu 18.04 has ended standard support as of May 31, 2023, we recommend + // you choose Ubuntu 22.04. + // + // AMI aliases + // // - Amazon Linux 2: amazonlinux-2-x86_64 + // // - Amazon Linux 2023 (recommended): amazonlinux-2023-x86_64 + // // - Ubuntu 18.04: ubuntu-18.04-x86_64 + // // - Ubuntu 22.04: ubuntu-22.04-x86_64 + // // SSM paths + // // - Amazon Linux 2: resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64 + // // - Amazon Linux 2023 (recommended): // resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2023-x86_64 + // // - Ubuntu 18.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64 + // // - Ubuntu 22.04: resolve:ssm:/aws/service/cloud9/amis/ubuntu-22.04-x86_64 // // This member is required. @@ -61,8 +76,9 @@ type CreateEnvironmentEC2Input struct { // This member is required. InstanceType *string - // The name of the environment to create. This name is visible to other IAM users - // in the same Amazon Web Services account. + // The name of the environment to create. + // + // This name is visible to other IAM users in the same Amazon Web Services account. // // This member is required. Name *string @@ -72,15 +88,20 @@ 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) - // in the Amazon EC2 API Reference. + // completes no more than one time. + // + // For more information, see [Client Tokens] in the Amazon EC2 API Reference. + // + // [Client Tokens]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html 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. + // Systems Manager). + // + // For more information, see [Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager] in the Cloud9 User Guide. + // + // [Accessing no-ingress EC2 instances with Amazon EC2 Systems Manager]: https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html ConnectionType types.ConnectionType // The description of the environment to create. diff --git a/service/cloud9/api_op_CreateEnvironmentMembership.go b/service/cloud9/api_op_CreateEnvironmentMembership.go index 94fe1b667e0..77355587624 100644 --- a/service/cloud9/api_op_CreateEnvironmentMembership.go +++ b/service/cloud9/api_op_CreateEnvironmentMembership.go @@ -36,7 +36,9 @@ 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. // // This member is required. diff --git a/service/cloud9/api_op_DescribeEnvironmentMemberships.go b/service/cloud9/api_op_DescribeEnvironmentMemberships.go index 14e121dae80..197b1396803 100644 --- a/service/cloud9/api_op_DescribeEnvironmentMemberships.go +++ b/service/cloud9/api_op_DescribeEnvironmentMemberships.go @@ -46,9 +46,13 @@ 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. Permissions []types.Permissions diff --git a/service/cloud9/api_op_DescribeEnvironmentStatus.go b/service/cloud9/api_op_DescribeEnvironmentStatus.go index 84edc1a6d75..0d524568f4b 100644 --- a/service/cloud9/api_op_DescribeEnvironmentStatus.go +++ b/service/cloud9/api_op_DescribeEnvironmentStatus.go @@ -45,12 +45,19 @@ 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. // // This member is required. diff --git a/service/cloud9/api_op_TagResource.go b/service/cloud9/api_op_TagResource.go index a7fc290078e..43163956d4f 100644 --- a/service/cloud9/api_op_TagResource.go +++ b/service/cloud9/api_op_TagResource.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds tags to an Cloud9 development environment. Tags that you add to an Cloud9 -// environment by using this method will NOT be automatically propagated to -// underlying resources. +// Adds tags to an Cloud9 development environment. +// +// Tags that you add to an Cloud9 environment by using this method will NOT be +// automatically propagated to underlying resources. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/cloud9/api_op_UpdateEnvironment.go b/service/cloud9/api_op_UpdateEnvironment.go index 49e43eff2cf..9edfd882f08 100644 --- a/service/cloud9/api_op_UpdateEnvironment.go +++ b/service/cloud9/api_op_UpdateEnvironment.go @@ -40,8 +40,11 @@ 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 diff --git a/service/cloud9/api_op_UpdateEnvironmentMembership.go b/service/cloud9/api_op_UpdateEnvironmentMembership.go index 03c2cf0ac5f..3e78a8c27ea 100644 --- a/service/cloud9/api_op_UpdateEnvironmentMembership.go +++ b/service/cloud9/api_op_UpdateEnvironmentMembership.go @@ -38,7 +38,9 @@ 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. // // This member is required. diff --git a/service/cloud9/doc.go b/service/cloud9/doc.go index b94bfac652e..665ffac62f5 100644 --- a/service/cloud9/doc.go +++ b/service/cloud9/doc.go @@ -3,26 +3,45 @@ // Package cloud9 provides the API client, operations, and parameter types for AWS // Cloud9. // -// 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: +// # 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]. +// +// 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 User Guide]: https://docs.aws.amazon.com/cloud9/latest/user-guide package cloud9 diff --git a/service/cloud9/options.go b/service/cloud9/options.go index b7b714646a8..79415a44046 100644 --- a/service/cloud9/options.go +++ b/service/cloud9/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloud9/types/enums.go b/service/cloud9/types/enums.go index 8dffa83e9c3..f9a0daadb75 100644 --- a/service/cloud9/types/enums.go +++ b/service/cloud9/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "CONNECT_SSH", @@ -33,6 +34,7 @@ const ( // Values returns all known values for EnvironmentLifecycleStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentLifecycleStatus) Values() []EnvironmentLifecycleStatus { return []EnvironmentLifecycleStatus{ @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for EnvironmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentStatus) Values() []EnvironmentStatus { return []EnvironmentStatus{ "error", @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for EnvironmentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentType) Values() []EnvironmentType { return []EnvironmentType{ "ssh", @@ -100,6 +104,7 @@ const ( // 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{ @@ -127,6 +132,7 @@ const ( // 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{ @@ -153,8 +159,9 @@ const ( ) // Values returns all known values for MemberPermissions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberPermissions) Values() []MemberPermissions { return []MemberPermissions{ "read-write", @@ -172,8 +179,9 @@ const ( ) // Values returns all known values for Permissions. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permissions) Values() []Permissions { return []Permissions{ "owner", diff --git a/service/cloud9/types/types.go b/service/cloud9/types/types.go index 55bc0f84ec0..107a8d81ba8 100644 --- a/service/cloud9/types/types.go +++ b/service/cloud9/types/types.go @@ -21,8 +21,10 @@ 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. // // This member is required. @@ -43,15 +45,25 @@ 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 ManagedCredentialsStatus ManagedCredentialsStatus @@ -73,10 +85,15 @@ 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. Status EnvironmentLifecycleStatus @@ -93,8 +110,11 @@ 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. // // This member is required. diff --git a/service/cloudcontrol/api_op_CancelResourceRequest.go b/service/cloudcontrol/api_op_CancelResourceRequest.go index 63386d77fbb..811461d1969 100644 --- a/service/cloudcontrol/api_op_CancelResourceRequest.go +++ b/service/cloudcontrol/api_op_CancelResourceRequest.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// Cancels the specified resource operation request. For more information, see [Canceling resource operation requests] 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. +// +// [Canceling resource operation requests]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel func (c *Client) CancelResourceRequest(ctx context.Context, params *CancelResourceRequestInput, optFns ...func(*Options)) (*CancelResourceRequestOutput, error) { if params == nil { params = &CancelResourceRequestInput{} @@ -44,8 +47,9 @@ 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) - // in the Amazon Web Services Cloud Control API User Guide. + // information, see [Managing resource operation requests]in the Amazon Web Services Cloud Control API User Guide. + // + // [Managing resource operation requests]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html ProgressEvent *types.ProgressEvent // Metadata pertaining to the operation's result. diff --git a/service/cloudcontrol/api_op_CreateResource.go b/service/cloudcontrol/api_op_CreateResource.go index e6a5e5c0cf3..a756df60328 100644 --- a/service/cloudcontrol/api_op_CreateResource.go +++ b/service/cloudcontrol/api_op_CreateResource.go @@ -11,11 +11,15 @@ 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) -// 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 . +// Creates the specified resource. For more information, see [Creating a resource] 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]using the RequestToken of the ProgressEvent +// type returned by CreateResource . +// +// [Creating a resource]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html +// [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput, optFns ...func(*Options)) (*CreateResourceOutput, error) { if params == nil { params = &CreateResourceInput{} @@ -34,16 +38,24 @@ func (c *Client) CreateResource(ctx context.Context, params *CreateResourceInput type CreateResourceInput struct { // Structured data format representing the desired state of the resource, - // 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: + // 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) - // 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) - // in the CloudFormation Users Guide. + // + // For more information, see [Composing the desired state of the resource] 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]in the CloudFormation Users Guide. + // + // [Resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html + // [Composing the desired state of the resource]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate // // This member is required. DesiredState *string @@ -57,23 +69,34 @@ type CreateResourceInput struct { // 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. + // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // request. + // + // For more information, see [Ensuring resource operation requests are unique] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Ensuring resource operation requests are unique]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency 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) - // in the Amazon Web Services Cloud Control API User Guide. + // permissions for each event handler are defined in the [handlers]section of the [resource type definition schema]. + // + // 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [handlers]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers + // [Specifying credentials]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions + // [resource type definition schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html RoleArn *string // For private resource types, the type version to use in this resource operation. @@ -86,10 +109,13 @@ type CreateResourceInput struct { 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 . + // 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]using the RequestToken of the ProgressEvent + // returned by CreateResource . + // + // [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html 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 a567bcde5d1..39dece186d8 100644 --- a/service/cloudcontrol/api_op_DeleteResource.go +++ b/service/cloudcontrol/api_op_DeleteResource.go @@ -11,11 +11,15 @@ 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) -// 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 . +// Deletes the specified resource. For details, see [Deleting a resource] 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]using the RequestToken of the ProgressEvent +// returned by DeleteResource . +// +// [Deleting a resource]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html +// [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput, optFns ...func(*Options)) (*DeleteResourceOutput, error) { if params == nil { params = &DeleteResourceInput{} @@ -33,15 +37,22 @@ func (c *Client) DeleteResource(ctx context.Context, params *DeleteResourceInput type DeleteResourceInput struct { - // The identifier for the resource. You can specify the primary identifier, or any - // secondary identifier defined for the resource type in its resource schema. You - // can only specify one identifier. Primary identifiers can be specified as a - // string or JSON; secondary identifiers must be specified as JSON. For compound - // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // The identifier for the resource. + // + // You can specify the primary identifier, or any secondary identifier defined for + // the resource type in its resource schema. You can only specify one identifier. + // Primary identifiers can be specified as a string or JSON; secondary identifiers + // must be specified as JSON. + // + // For compound 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Identifying resources]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html // // This member is required. Identifier *string @@ -55,23 +66,34 @@ type DeleteResourceInput struct { // 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. + // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // request. + // + // For more information, see [Ensuring resource operation requests are unique] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Ensuring resource operation requests are unique]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency 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) - // in the Amazon Web Services Cloud Control API User Guide. + // permissions for each event handler are defined in the [handlers]section of the [resource type definition schema]. + // + // 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [handlers]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers + // [Specifying credentials]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions + // [resource type definition schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html RoleArn *string // For private resource types, the type version to use in this resource operation. @@ -84,10 +106,13 @@ type DeleteResourceInput struct { 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 . + // 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]using the RequestToken of the ProgressEvent + // returned by DeleteResource . + // + // [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html 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 10a687eebb5..5fcc4523a28 100644 --- a/service/cloudcontrol/api_op_GetResource.go +++ b/service/cloudcontrol/api_op_GetResource.go @@ -12,10 +12,13 @@ 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 +// details, see [Reading a resource's current state]. +// +// 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. +// +// [Reading a resource's current state]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optFns ...func(*Options)) (*GetResourceOutput, error) { if params == nil { params = &GetResourceInput{} @@ -33,15 +36,22 @@ func (c *Client) GetResource(ctx context.Context, params *GetResourceInput, optF type GetResourceInput struct { - // The identifier for the resource. You can specify the primary identifier, or any - // secondary identifier defined for the resource type in its resource schema. You - // can only specify one identifier. Primary identifiers can be specified as a - // string or JSON; secondary identifiers must be specified as JSON. For compound - // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // The identifier for the resource. + // + // You can specify the primary identifier, or any secondary identifier defined for + // the resource type in its resource schema. You can only specify one identifier. + // Primary identifiers can be specified as a string or JSON; secondary identifiers + // must be specified as JSON. + // + // For compound 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Identifying resources]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html // // This member is required. Identifier *string @@ -54,12 +64,17 @@ 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) - // in the Amazon Web Services Cloud Control API User Guide. + // permissions for each event handler are defined in the [handlers]section of the [resource type definition schema]. + // + // 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [handlers]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers + // [Specifying credentials]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions + // [resource type definition schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html RoleArn *string // For private resource types, the type version to use in this resource operation. diff --git a/service/cloudcontrol/api_op_GetResourceRequestStatus.go b/service/cloudcontrol/api_op_GetResourceRequestStatus.go index 491103ed195..3fa3981a902 100644 --- a/service/cloudcontrol/api_op_GetResourceRequestStatus.go +++ b/service/cloudcontrol/api_op_GetResourceRequestStatus.go @@ -16,8 +16,9 @@ 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) -// in the Amazon Web Services Cloud Control API User Guide. +// information, see [Tracking the progress of resource operation requests]in the Amazon Web Services Cloud Control API User Guide. +// +// [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 func (c *Client) GetResourceRequestStatus(ctx context.Context, params *GetResourceRequestStatusInput, optFns ...func(*Options)) (*GetResourceRequestStatusOutput, error) { if params == nil { params = &GetResourceRequestStatusInput{} @@ -36,6 +37,7 @@ func (c *Client) GetResourceRequestStatus(ctx context.Context, params *GetResour type GetResourceRequestStatusInput struct { // A unique token used to track the progress of the resource operation request. + // // Request tokens are included in the ProgressEvent type returned by a resource // operation request. // @@ -177,12 +179,13 @@ type ResourceRequestSuccessWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetResourceRequestStatusInput, *GetResourceRequestStatusOutput, error) (bool, error) } diff --git a/service/cloudcontrol/api_op_ListResourceRequests.go b/service/cloudcontrol/api_op_ListResourceRequests.go index 8d01390a7f9..11d3117bd7e 100644 --- a/service/cloudcontrol/api_op_ListResourceRequests.go +++ b/service/cloudcontrol/api_op_ListResourceRequests.go @@ -12,10 +12,12 @@ 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) -// in the Amazon Web Services Cloud Control API User Guide. Resource operation -// requests expire after 7 days. +// status types. For more information, see [Listing active resource operation requests]in the Amazon Web Services Cloud +// Control API User Guide. +// +// Resource operation requests expire after 7 days. +// +// [Listing active resource operation requests]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list func (c *Client) ListResourceRequests(ctx context.Context, params *ListResourceRequestsInput, optFns ...func(*Options)) (*ListResourceRequestsOutput, error) { if params == nil { params = &ListResourceRequestsInput{} @@ -36,7 +38,9 @@ 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 . + // set of results. + // + // The default is 20 . MaxResults *int32 // If the previous paginated request didn't return all of the remaining results, @@ -159,7 +163,9 @@ 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 . + // 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 22b74422856..9c7c45b0c6e 100644 --- a/service/cloudcontrol/api_op_ListResources.go +++ b/service/cloudcontrol/api_op_ListResources.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the specified resources. For more information, see -// 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 -// API. +// Returns information about the specified resources. For more information, see [Discovering resources] +// 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 API. +// +// [Discovering resources]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error) { if params == nil { params = &ListResourcesInput{} @@ -55,12 +57,17 @@ 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) - // in the Amazon Web Services Cloud Control API User Guide. + // permissions for each event handler are defined in the [handlers]section of the [resource type definition schema]. + // + // 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [handlers]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers + // [Specifying credentials]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions + // [resource type definition schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html RoleArn *string // For private resource types, the type version to use in this resource operation. diff --git a/service/cloudcontrol/api_op_UpdateResource.go b/service/cloudcontrol/api_op_UpdateResource.go index e2e9192b246..f1a62d073fd 100644 --- a/service/cloudcontrol/api_op_UpdateResource.go +++ b/service/cloudcontrol/api_op_UpdateResource.go @@ -11,19 +11,25 @@ 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) -// 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) -// in the CloudFormation Users Guide. +// 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]standard. +// +// For details on how Cloud Control API performs resource update operations, see [Updating a resource] +// 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]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]in the CloudFormation Users Guide. +// +// [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html +// [RFC 6902 - JavaScript Object Notation (JSON) Patch]: https://datatracker.ietf.org/doc/html/rfc6902 +// [Updating a resource]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html +// [Resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput, optFns ...func(*Options)) (*UpdateResourceOutput, error) { if params == nil { params = &UpdateResourceInput{} @@ -41,23 +47,31 @@ func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput type UpdateResourceInput struct { - // The identifier for the resource. You can specify the primary identifier, or any - // secondary identifier defined for the resource type in its resource schema. You - // can only specify one identifier. Primary identifiers can be specified as a - // string or JSON; secondary identifiers must be specified as JSON. For compound - // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // The identifier for the resource. + // + // You can specify the primary identifier, or any secondary identifier defined for + // the resource type in its resource schema. You can only specify one identifier. + // Primary identifiers can be specified as a string or JSON; secondary identifiers + // must be specified as JSON. + // + // For compound 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Identifying resources]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html // // This member is required. Identifier *string // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // see [Composing the patch document]in the Amazon Web Services Cloud Control API User Guide. + // + // [Composing the patch document]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch // // This member is required. PatchDocument *string @@ -71,23 +85,34 @@ type UpdateResourceInput struct { // 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. + // 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) - // in the Amazon Web Services Cloud Control API User Guide. + // request. + // + // For more information, see [Ensuring resource operation requests are unique] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Ensuring resource operation requests are unique]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency 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) - // in the Amazon Web Services Cloud Control API User Guide. + // permissions for each event handler are defined in the [handlers]section of the [resource type definition schema]. + // + // 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] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [handlers]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers + // [Specifying credentials]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions + // [resource type definition schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html RoleArn *string // For private resource types, the type version to use in this resource operation. @@ -100,9 +125,12 @@ 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) - // to return the current status of a resource operation request. + // Represents the current status of the resource update request. + // + // Use the RequestToken of the ProgressEvent with [GetResourceRequestStatus] to return the current status of + // a resource operation request. + // + // [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html ProgressEvent *types.ProgressEvent // Metadata pertaining to the operation's result. diff --git a/service/cloudcontrol/doc.go b/service/cloudcontrol/doc.go index 786abf814f4..6053cc798f2 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]. +// +// [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/options.go b/service/cloudcontrol/options.go index 10c7257720e..8c5e1356983 100644 --- a/service/cloudcontrol/options.go +++ b/service/cloudcontrol/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudcontrol/types/enums.go b/service/cloudcontrol/types/enums.go index b95d9e90fe5..d7e8058c539 100644 --- a/service/cloudcontrol/types/enums.go +++ b/service/cloudcontrol/types/enums.go @@ -24,8 +24,9 @@ const ( ) // Values returns all known values for HandlerErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HandlerErrorCode) Values() []HandlerErrorCode { return []HandlerErrorCode{ "NotUpdatable", @@ -56,8 +57,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -79,8 +81,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "PENDING", diff --git a/service/cloudcontrol/types/errors.go b/service/cloudcontrol/types/errors.go index 5b657850ec6..9a0d66f4790 100644 --- a/service/cloudcontrol/types/errors.go +++ b/service/cloudcontrol/types/errors.go @@ -34,6 +34,7 @@ func (e *AlreadyExistsException) ErrorCode() string { func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The specified client token has already been used in another resource request. +// // It's best practice for client tokens to be unique for each resource operation // request. However, client token expire after 36 hours. type ClientTokenConflictException struct { diff --git a/service/cloudcontrol/types/types.go b/service/cloudcontrol/types/types.go index 518b7cf2eec..aaf4dd38688 100644 --- a/service/cloudcontrol/types/types.go +++ b/service/cloudcontrol/types/types.go @@ -8,40 +8,54 @@ 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) -// in the Amazon Web Services Cloud Control API User Guide. +// information, see [Managing resource operation requests]in the Amazon Web Services Cloud Control API User Guide. +// +// [Managing resource operation requests]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html 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) - // in the CloudFormation Command Line Interface User Guide for Extension - // Development. + // For requests with a status of FAILED , the associated error code. + // + // For error code definitions, see [Handler error codes] in the CloudFormation Command Line Interface + // User Guide for Extension Development. + // + // [Handler error codes]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html ErrorCode HandlerErrorCode // When the resource operation request was initiated. 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 . + // 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 . 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. 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) - // to return the current status of a resource operation request. + // The unique token representing this resource operation request. + // + // Use the RequestToken with [GetResourceRequestStatus] to return the current status of a resource operation + // request. + // + // [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html RequestToken *string // A JSON string containing the resource model, consisting of each resource @@ -63,9 +77,12 @@ type ProgressEvent struct { // Represents information about a provisioned resource. 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) - // in the Amazon Web Services Cloud Control API User Guide. + // The primary identifier for the resource. + // + // For more information, see [Identifying resources] in the Amazon Web Services Cloud Control API User + // Guide. + // + // [Identifying resources]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html Identifier *string // A list of the resource properties and their current values. @@ -78,11 +95,17 @@ 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. OperationStatuses []OperationStatus diff --git a/service/clouddirectory/api_op_AddFacetToObject.go b/service/clouddirectory/api_op_AddFacetToObject.go index 905ccf7f56b..1207512dc9f 100644 --- a/service/clouddirectory/api_op_AddFacetToObject.go +++ b/service/clouddirectory/api_op_AddFacetToObject.go @@ -11,8 +11,7 @@ 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{} @@ -30,8 +29,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where the object + // resides. For more information, see arns. // // This member is required. DirectoryArn *string @@ -41,8 +40,7 @@ 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 c9ccf63dea4..5587fb4a123 100644 --- a/service/clouddirectory/api_op_ApplySchema.go +++ b/service/clouddirectory/api_op_ApplySchema.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies the input published schema, at the specified version, into the Directory -// with the same name and version as that of the published schema. +// Copies the input published schema, at the specified version, into the Directory with the +// same name and version as that of the published schema. func (c *Client) ApplySchema(ctx context.Context, params *ApplySchemaInput, optFns ...func(*Options)) (*ApplySchemaOutput, error) { if params == nil { params = &ApplySchemaInput{} @@ -29,14 +29,14 @@ 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 Amazon Resource Name (ARN) that is associated with the Directory into which 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 @@ -46,12 +46,12 @@ 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 . + // 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. 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 bb907725a00..6916d25ac09 100644 --- a/service/clouddirectory/api_op_AttachObject.go +++ b/service/clouddirectory/api_op_AttachObject.go @@ -13,7 +13,9 @@ import ( // Attaches an existing object to another object. An object can be accessed in two // ways: +// // - Using the path +// // - Using ObjectIdentifier func (c *Client) AttachObject(ctx context.Context, params *AttachObjectInput, optFns ...func(*Options)) (*AttachObjectOutput, error) { if params == nil { @@ -37,8 +39,8 @@ type AttachObjectInput struct { // This member is required. ChildReference *types.ObjectReference - // Amazon Resource Name (ARN) that is associated with the Directory where both - // objects reside. For more information, see arns . + // Amazon Resource Name (ARN) that is associated with the Directory where both objects + // reside. For more information, see arns. // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_AttachPolicy.go b/service/clouddirectory/api_op_AttachPolicy.go index 8f49fda3bbf..e36bb1edc7e 100644 --- a/service/clouddirectory/api_op_AttachPolicy.go +++ b/service/clouddirectory/api_op_AttachPolicy.go @@ -30,8 +30,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where both 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 0479cbb94be..c8f4b56b79f 100644 --- a/service/clouddirectory/api_op_AttachTypedLink.go +++ b/service/clouddirectory/api_op_AttachTypedLink.go @@ -12,8 +12,9 @@ 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]. +// +// [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 9f523554d00..2153d2d706a 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 75dd12ec2e5..14d66674e77 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 d6bc78a75b1..8cc8fc8fc01 100644 --- a/service/clouddirectory/api_op_CreateDirectory.go +++ b/service/clouddirectory/api_op_CreateDirectory.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Cloud Directory Developer Guide. +// 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] in the Amazon Cloud Directory +// Developer Guide. +// +// [Managed Schema]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error) { if params == nil { params = &CreateDirectoryInput{} @@ -32,13 +35,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 @@ -48,19 +51,19 @@ type CreateDirectoryInput struct { type CreateDirectoryOutput struct { - // 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 . + // 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. // // 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 ce8efe73735..f60e8f11737 100644 --- a/service/clouddirectory/api_op_CreateFacet.go +++ b/service/clouddirectory/api_op_CreateFacet.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Facet in a schema. Facet creation is allowed only in development -// or applied schemas. +// Creates a new Facet in a schema. Facet creation is allowed only in development or +// applied schemas. func (c *Client) CreateFacet(ctx context.Context, params *CreateFacetInput, optFns ...func(*Options)) (*CreateFacetOutput, error) { if params == nil { params = &CreateFacetInput{} @@ -30,18 +30,17 @@ 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 @@ -51,15 +50,17 @@ type CreateFacetInput struct { // 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. // // - 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) - // . + // information, see [Policies]. // // - Index: Can be created with the Index API. + // + // [Policies]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies ObjectType types.ObjectType noSmithyDocumentSerde diff --git a/service/clouddirectory/api_op_CreateIndex.go b/service/clouddirectory/api_op_CreateIndex.go index 5c60b0c06ce..7879dbc745d 100644 --- a/service/clouddirectory/api_op_CreateIndex.go +++ b/service/clouddirectory/api_op_CreateIndex.go @@ -11,8 +11,9 @@ 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) -// for more information. +// Creates an index object. See [Indexing and search] for more information. +// +// [Indexing and search]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) { if params == nil { params = &CreateIndexInput{} diff --git a/service/clouddirectory/api_op_CreateObject.go b/service/clouddirectory/api_op_CreateObject.go index d5e99838bb1..203760c811a 100644 --- a/service/clouddirectory/api_op_CreateObject.go +++ b/service/clouddirectory/api_op_CreateObject.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) CreateObject(ctx context.Context, params *CreateObjectInput, optFns ...func(*Options)) (*CreateObjectOutput, error) { if params == nil { params = &CreateObjectInput{} @@ -32,14 +32,14 @@ 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 Amazon Resource Name (ARN) that is associated with the Directory in which the object + // will be created. For more information, see arns. // // This member is required. DirectoryArn *string // A list of schema facets to be associated with the object. Do not provide minor - // version components. See SchemaFacet for details. + // version components. See SchemaFacetfor details. // // This member is required. SchemaFacets []types.SchemaFacet diff --git a/service/clouddirectory/api_op_CreateSchema.go b/service/clouddirectory/api_op_CreateSchema.go index 85776593893..952ed9a88cb 100644 --- a/service/clouddirectory/api_op_CreateSchema.go +++ b/service/clouddirectory/api_op_CreateSchema.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new schema in a development state. A schema can exist in three -// phases: +// 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. @@ -48,7 +50,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 928629134c4..83b6adb656c 100644 --- a/service/clouddirectory/api_op_CreateTypedLinkFacet.go +++ b/service/clouddirectory/api_op_CreateTypedLinkFacet.go @@ -11,8 +11,9 @@ 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]. +// +// [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 +37,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 9036541281e..cbcd55b03f4 100644 --- a/service/clouddirectory/api_op_DeleteFacet.go +++ b/service/clouddirectory/api_op_DeleteFacet.go @@ -10,8 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Deletes a given Facet. All attributes and Rules 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 { params = &DeleteFacetInput{} @@ -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 e127f197a96..1fd8f5ef42c 100644 --- a/service/clouddirectory/api_op_DeleteObject.go +++ b/service/clouddirectory/api_op_DeleteObject.go @@ -13,9 +13,9 @@ 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) -// . +// deleted during an object deletion is 30. For more information, see [Amazon Cloud Directory Limits]. +// +// [Amazon Cloud 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{} @@ -33,8 +33,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where the 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 96460ced5a4..680540409dc 100644 --- a/service/clouddirectory/api_op_DeleteSchema.go +++ b/service/clouddirectory/api_op_DeleteSchema.go @@ -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 95b7d6b501d..6d997e7365e 100644 --- a/service/clouddirectory/api_op_DeleteTypedLinkFacet.go +++ b/service/clouddirectory/api_op_DeleteTypedLinkFacet.go @@ -10,8 +10,9 @@ 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]. +// +// [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 +36,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 781366eed02..198e39fe2be 100644 --- a/service/clouddirectory/api_op_DetachObject.go +++ b/service/clouddirectory/api_op_DetachObject.go @@ -30,8 +30,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where 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 86330a41ced..3e9ba7fb62c 100644 --- a/service/clouddirectory/api_op_DetachPolicy.go +++ b/service/clouddirectory/api_op_DetachPolicy.go @@ -29,8 +29,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where both 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 0b8ef0c3d22..731c7a69ceb 100644 --- a/service/clouddirectory/api_op_DetachTypedLink.go +++ b/service/clouddirectory/api_op_DetachTypedLink.go @@ -12,8 +12,9 @@ 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]. +// +// [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_GetFacet.go b/service/clouddirectory/api_op_GetFacet.go index 85061190220..f121cf36e31 100644 --- a/service/clouddirectory/api_op_GetFacet.go +++ b/service/clouddirectory/api_op_GetFacet.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) GetFacet(ctx context.Context, params *GetFacetInput, optFns ...func(*Options)) (*GetFacetOutput, error) { if params == nil { params = &GetFacetInput{} @@ -36,8 +35,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 83756f6f028..798ecf7cc2e 100644 --- a/service/clouddirectory/api_op_GetLinkAttributes.go +++ b/service/clouddirectory/api_op_GetLinkAttributes.go @@ -35,8 +35,9 @@ 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 arnsor [Typed Links]. + // + // [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 4928da22fe6..ea7a01ed0ef 100644 --- a/service/clouddirectory/api_op_GetObjectAttributes.go +++ b/service/clouddirectory/api_op_GetObjectAttributes.go @@ -34,8 +34,8 @@ type GetObjectAttributesInput struct { // This member is required. AttributeNames []string - // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. + // The Amazon Resource Name (ARN) that is associated with the Directory where the object + // resides. // // This member is required. DirectoryArn *string @@ -45,8 +45,7 @@ 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_GetObjectInformation.go b/service/clouddirectory/api_op_GetObjectInformation.go index 44409453e91..ca27c651068 100644 --- a/service/clouddirectory/api_op_GetObjectInformation.go +++ b/service/clouddirectory/api_op_GetObjectInformation.go @@ -52,7 +52,7 @@ type GetObjectInformationOutput struct { // The facets attached to the specified object. Although the response does not // include minor version information, the most recently applied minor version of - // each Facet is in effect. See GetAppliedSchemaVersion for details. + // each Facet is in effect. See GetAppliedSchemaVersionfor details. SchemaFacets []types.SchemaFacet // Metadata pertaining to the operation's result. diff --git a/service/clouddirectory/api_op_GetSchemaAsJson.go b/service/clouddirectory/api_op_GetSchemaAsJson.go index c5ff870b562..7e9c9ad8c8a 100644 --- a/service/clouddirectory/api_op_GetSchemaAsJson.go +++ b/service/clouddirectory/api_op_GetSchemaAsJson.go @@ -10,8 +10,9 @@ 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) -// for more information. +// Retrieves a JSON representation of the schema. See [JSON Schema Format] for more information. +// +// [JSON Schema Format]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json func (c *Client) GetSchemaAsJson(ctx context.Context, params *GetSchemaAsJsonInput, optFns ...func(*Options)) (*GetSchemaAsJsonOutput, error) { if params == nil { params = &GetSchemaAsJsonInput{} diff --git a/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go b/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go index 323687018da..82a51103468 100644 --- a/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go +++ b/service/clouddirectory/api_op_GetTypedLinkFacetInformation.go @@ -10,9 +10,10 @@ 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] // . +// +// [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 +37,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 +54,9 @@ 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]. + // + // [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_ListIncomingTypedLinks.go b/service/clouddirectory/api_op_ListIncomingTypedLinks.go index bfdedbc9dde..2753021258b 100644 --- a/service/clouddirectory/api_op_ListIncomingTypedLinks.go +++ b/service/clouddirectory/api_op_ListIncomingTypedLinks.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} diff --git a/service/clouddirectory/api_op_ListIndex.go b/service/clouddirectory/api_op_ListIndex.go index 7cfc7c3f470..95377fb035f 100644 --- a/service/clouddirectory/api_op_ListIndex.go +++ b/service/clouddirectory/api_op_ListIndex.go @@ -43,8 +43,9 @@ type ListIndexInput struct { 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) - // . + // during a request. For more information, see [Amazon Cloud Directory Limits]. + // + // [Amazon Cloud Directory Limits]: http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html MaxResults *int32 // The pagination token. @@ -159,8 +160,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) - // . + // during a request. For more information, see [Amazon Cloud Directory Limits]. + // + // [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 9d52c27f5a9..4a4d217c8f4 100644 --- a/service/clouddirectory/api_op_ListObjectAttributes.go +++ b/service/clouddirectory/api_op_ListObjectAttributes.go @@ -29,8 +29,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where the 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 1641330c72c..841f0d822ef 100644 --- a/service/clouddirectory/api_op_ListObjectChildren.go +++ b/service/clouddirectory/api_op_ListObjectChildren.go @@ -30,8 +30,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where the 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 d93ce9503c0..7bd8a404b45 100644 --- a/service/clouddirectory/api_op_ListObjectParentPaths.go +++ b/service/clouddirectory/api_op_ListObjectParentPaths.go @@ -13,13 +13,16 @@ 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 +// see [Directory Structure]. +// +// 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. +// +// [Directory Structure]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html 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 84acd820778..98c97c32216 100644 --- a/service/clouddirectory/api_op_ListObjectParents.go +++ b/service/clouddirectory/api_op_ListObjectParents.go @@ -30,8 +30,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where the object + // resides. For more information, see arns. // // This member is required. DirectoryArn *string @@ -46,8 +46,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 221a0f2f164..f1e63ae78d7 100644 --- a/service/clouddirectory/api_op_ListObjectPolicies.go +++ b/service/clouddirectory/api_op_ListObjectPolicies.go @@ -29,8 +29,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where objects + // reside. For more information, see arns. // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_ListOutgoingTypedLinks.go b/service/clouddirectory/api_op_ListOutgoingTypedLinks.go index b7f9b02680e..860f198c572 100644 --- a/service/clouddirectory/api_op_ListOutgoingTypedLinks.go +++ b/service/clouddirectory/api_op_ListOutgoingTypedLinks.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} diff --git a/service/clouddirectory/api_op_ListPolicyAttachments.go b/service/clouddirectory/api_op_ListPolicyAttachments.go index 6437eac8878..f8d9446b7bf 100644 --- a/service/clouddirectory/api_op_ListPolicyAttachments.go +++ b/service/clouddirectory/api_op_ListPolicyAttachments.go @@ -29,8 +29,8 @@ 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 . + // The Amazon Resource Name (ARN) that is associated with the Directory where objects + // reside. For more information, see arns. // // This member is required. DirectoryArn *string diff --git a/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go b/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go index a1f5ffdfbc2..65c1afce45a 100644 --- a/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go +++ b/service/clouddirectory/api_op_ListTypedLinkFacetAttributes.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For +// more information, see [Typed Links]. +// +// [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{} @@ -37,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 244118ad2fb..8778370789d 100644 --- a/service/clouddirectory/api_op_ListTypedLinkFacetNames.go +++ b/service/clouddirectory/api_op_ListTypedLinkFacetNames.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} @@ -31,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 7b3b8b767a1..0a2d2a454d1 100644 --- a/service/clouddirectory/api_op_LookupPolicy.go +++ b/service/clouddirectory/api_op_LookupPolicy.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all policies from the root of the Directory to the object specified. If -// 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) -// . +// Lists all policies from the root of the Directory to the object specified. If 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]. +// +// [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{} @@ -35,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,8 +63,9 @@ type LookupPolicyOutput struct { 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) - // . + // , and PolicyType . For more information, see [Policies]. + // + // [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 f6cfc41bd4e..fedfa65c628 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 @@ -54,8 +54,8 @@ type PublishSchemaInput struct { type PublishSchemaOutput struct { - // The ARN that is associated with the published schema. For more information, see - // arns . + // The ARN that is associated with the published schema. For more information, see 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 e3f5e69d7b0..f023b87ba26 100644 --- a/service/clouddirectory/api_op_PutSchemaFromJson.go +++ b/service/clouddirectory/api_op_PutSchemaFromJson.go @@ -11,8 +11,9 @@ 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) -// for more information. +// schemas. See [JSON Schema Format]for more information. +// +// [JSON Schema Format]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json func (c *Client) PutSchemaFromJson(ctx context.Context, params *PutSchemaFromJsonInput, optFns ...func(*Options)) (*PutSchemaFromJsonOutput, error) { if params == nil { params = &PutSchemaFromJsonInput{} diff --git a/service/clouddirectory/api_op_UpdateFacet.go b/service/clouddirectory/api_op_UpdateFacet.go index 8016effdda8..f852691ff04 100644 --- a/service/clouddirectory/api_op_UpdateFacet.go +++ b/service/clouddirectory/api_op_UpdateFacet.go @@ -12,8 +12,11 @@ import ( ) // Does the following: +// // - 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 { @@ -37,19 +40,18 @@ 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 - // operation to perform. + // 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 - // The object type that is associated with the facet. See - // CreateFacetRequest$ObjectType for more details. + // The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details. ObjectType types.ObjectType noSmithyDocumentSerde diff --git a/service/clouddirectory/api_op_UpdateLinkAttributes.go b/service/clouddirectory/api_op_UpdateLinkAttributes.go index bbf09730b0c..59af2372800 100644 --- a/service/clouddirectory/api_op_UpdateLinkAttributes.go +++ b/service/clouddirectory/api_op_UpdateLinkAttributes.go @@ -37,8 +37,9 @@ 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 arnsor [Typed Links]. + // + // [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 562a35cdde5..cc17a7271e1 100644 --- a/service/clouddirectory/api_op_UpdateObjectAttributes.go +++ b/service/clouddirectory/api_op_UpdateObjectAttributes.go @@ -34,8 +34,8 @@ type UpdateObjectAttributesInput struct { // This member is required. AttributeUpdates []types.ObjectAttributeUpdate - // The Amazon Resource Name (ARN) that is associated with the Directory where the - // object resides. For more information, see arns . + // The Amazon Resource Name (ARN) that is associated with the Directory where the 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 eb97c45d836..ff68e8e1875 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 @@ -45,8 +45,7 @@ type UpdateSchemaInput struct { type UpdateSchemaOutput struct { - // The ARN that is associated with the updated schema. For more information, see - // arns . + // The ARN that is associated with the updated schema. For more information, see 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 be18a3268a7..f0b38d9a7a5 100644 --- a/service/clouddirectory/api_op_UpdateTypedLinkFacet.go +++ b/service/clouddirectory/api_op_UpdateTypedLinkFacet.go @@ -11,8 +11,9 @@ 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]. +// +// [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 +43,9 @@ 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]. + // + // [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 +56,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/doc.go b/service/clouddirectory/doc.go index fce3f89f7d3..eb196769ea0 100644 --- a/service/clouddirectory/doc.go +++ b/service/clouddirectory/doc.go @@ -3,12 +3,14 @@ // Package clouddirectory provides the API client, operations, and parameter types // for Amazon CloudDirectory. // -// Amazon Cloud Directory Amazon Cloud Directory is a component of the AWS -// Directory Service that simplifies the development and management of cloud-scale -// web, mobile, and IoT applications. This guide describes the Cloud Directory -// 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) -// . +// # Amazon Cloud Directory +// +// Amazon Cloud Directory is a component of the AWS Directory Service that +// simplifies the development and management of cloud-scale web, mobile, and IoT +// applications. This guide describes the Cloud Directory 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]and the [Amazon Cloud Directory Developer Guide]. +// +// [Amazon Cloud Directory Developer Guide]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html +// [AWS Directory Service]: https://aws.amazon.com/directoryservice/ package clouddirectory diff --git a/service/clouddirectory/options.go b/service/clouddirectory/options.go index 6d320e151e0..f344bc7ba6c 100644 --- a/service/clouddirectory/options.go +++ b/service/clouddirectory/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/clouddirectory/types/enums.go b/service/clouddirectory/types/enums.go index 3c679327cbe..b23af1a2106 100644 --- a/service/clouddirectory/types/enums.go +++ b/service/clouddirectory/types/enums.go @@ -22,8 +22,9 @@ const ( ) // Values returns all known values for BatchReadExceptionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchReadExceptionType) Values() []BatchReadExceptionType { return []BatchReadExceptionType{ "ValidationException", @@ -67,8 +68,9 @@ const ( ) // Values returns all known values for BatchWriteExceptionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchWriteExceptionType) Values() []BatchWriteExceptionType { return []BatchWriteExceptionType{ "InternalServiceException", @@ -101,8 +103,9 @@ const ( ) // Values returns all known values for ConsistencyLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConsistencyLevel) Values() []ConsistencyLevel { return []ConsistencyLevel{ "SERIALIZABLE", @@ -120,8 +123,9 @@ const ( ) // Values returns all known values for DirectoryState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryState) Values() []DirectoryState { return []DirectoryState{ "ENABLED", @@ -143,8 +147,9 @@ const ( ) // Values returns all known values for FacetAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FacetAttributeType) Values() []FacetAttributeType { return []FacetAttributeType{ "STRING", @@ -165,8 +170,9 @@ const ( ) // Values returns all known values for FacetStyle. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FacetStyle) Values() []FacetStyle { return []FacetStyle{ "STATIC", @@ -185,8 +191,9 @@ const ( ) // Values returns all known values for ObjectType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectType) Values() []ObjectType { return []ObjectType{ "NODE", @@ -208,8 +215,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -230,6 +238,7 @@ const ( // Values returns all known values for RequiredAttributeBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RequiredAttributeBehavior) Values() []RequiredAttributeBehavior { return []RequiredAttributeBehavior{ @@ -249,8 +258,9 @@ const ( ) // Values returns all known values for RuleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleType) Values() []RuleType { return []RuleType{ "BINARY_LENGTH", @@ -269,8 +279,9 @@ const ( ) // Values returns all known values for UpdateActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateActionType) Values() []UpdateActionType { return []UpdateActionType{ "CREATE_OR_UPDATE", diff --git a/service/clouddirectory/types/errors.go b/service/clouddirectory/types/errors.go index 2aaee325ee2..53ee7edaa4d 100644 --- a/service/clouddirectory/types/errors.go +++ b/service/clouddirectory/types/errors.go @@ -8,8 +8,8 @@ import ( ) // 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. +// this directory or the directory does not exist. Try calling ListDirectoriesand 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 @@ -275,8 +275,8 @@ func (e *FacetNotFoundException) ErrorCode() string { } func (e *FacetNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Facet that you provided was not well formed or could not be validated with -// the schema. +// The Facet that you provided was not well formed or could not be validated with the +// schema. type FacetValidationException struct { Message *string @@ -359,8 +359,10 @@ 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]site to see if there are any operational issues with the +// service. +// +// [AWS Service Health Dashboard]: http://status.aws.amazon.com/ type InternalServiceException struct { Message *string @@ -572,8 +574,9 @@ 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) -// for more information. +// Indicates that limits are exceeded. See [Limits] for more information. +// +// [Limits]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html type LimitExceededException struct { Message *string diff --git a/service/clouddirectory/types/types.go b/service/clouddirectory/types/types.go index ff9beb4811b..2e3df2f4382 100644 --- a/service/clouddirectory/types/types.go +++ b/service/clouddirectory/types/types.go @@ -117,8 +117,8 @@ type BatchAttachObjectResponse struct { noSmithyDocumentSerde } -// Attaches a policy object to a regular object inside a BatchRead operation. For -// more information, see AttachPolicy and BatchReadRequest$Operations . +// Attaches a policy object to a regular object inside a BatchRead operation. For more +// information, see AttachPolicyand BatchReadRequest$Operations. type BatchAttachPolicy struct { // The reference that identifies the object to which the policy will be attached. @@ -139,9 +139,8 @@ type BatchAttachPolicyResponse struct { noSmithyDocumentSerde } -// Attaches the specified object to the specified index inside a BatchRead -// operation. For more information, see AttachToIndex and -// BatchReadRequest$Operations . +// Attaches the specified object to the specified index inside a BatchRead operation. For +// more information, see AttachToIndexand BatchReadRequest$Operations. type BatchAttachToIndex struct { // A reference to the index that you are attaching the object to. @@ -167,8 +166,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 . +// operation. For more information, see AttachTypedLinkand BatchReadRequest$Operations. type BatchAttachTypedLink struct { // A set of attributes that are associated with the typed link. @@ -203,8 +201,7 @@ type BatchAttachTypedLinkResponse struct { noSmithyDocumentSerde } -// Creates an index object inside of a BatchRead operation. For more information, -// see CreateIndex and BatchReadRequest$Operations . +// Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations. type BatchCreateIndex struct { // Indicates whether the attribute that is being indexed has unique values or not. @@ -218,8 +215,9 @@ 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) - // for more information. + // The batch reference name. See [Transaction Support] for more information. + // + // [Transaction Support]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html BatchReferenceName *string // The name of the link between the parent object and the index object. @@ -250,13 +248,14 @@ type BatchCreateObject struct { 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) - // for more information. + // The batch reference name. See [Transaction Support] for more information. + // + // [Transaction Support]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html BatchReferenceName *string // The name of the link. @@ -293,9 +292,8 @@ type BatchDeleteObjectResponse struct { noSmithyDocumentSerde } -// Detaches the specified object from the specified index inside a BatchRead -// operation. For more information, see DetachFromIndex and -// BatchReadRequest$Operations . +// Detaches the specified object from the specified index inside a BatchRead operation. For +// more information, see DetachFromIndexand BatchReadRequest$Operations. type BatchDetachFromIndex struct { // A reference to the index object. @@ -333,8 +331,9 @@ 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) - // for more information. + // The batch reference name. See [Transaction Support] for more information. + // + // [Transaction Support]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html BatchReferenceName *string noSmithyDocumentSerde @@ -349,9 +348,8 @@ type BatchDetachObjectResponse struct { noSmithyDocumentSerde } -// Detaches the specified policy from the specified directory inside a BatchWrite -// operation. For more information, see DetachPolicy and -// BatchWriteRequest$Operations . +// Detaches the specified policy from the specified directory inside a BatchWrite operation. +// For more information, see DetachPolicyand BatchWriteRequest$Operations. type BatchDetachPolicy struct { // Reference that identifies the object whose policy object will be detached. @@ -372,9 +370,8 @@ type BatchDetachPolicyResponse struct { noSmithyDocumentSerde } -// Detaches a typed link from a specified source and target object inside a -// BatchRead operation. For more information, see DetachTypedLink and -// BatchReadRequest$Operations . +// Detaches a typed link from a specified source and target object inside a BatchRead +// operation. For more information, see DetachTypedLinkand BatchReadRequest$Operations. type BatchDetachTypedLink struct { // Used to accept a typed link specifier as input. @@ -390,9 +387,8 @@ type BatchDetachTypedLinkResponse struct { noSmithyDocumentSerde } -// Retrieves attributes that are associated with a typed link inside a BatchRead -// operation. For more information, see GetLinkAttributes and -// BatchReadRequest$Operations . +// Retrieves attributes that are associated with a typed link inside a BatchRead operation. +// For more information, see GetLinkAttributesand BatchReadRequest$Operations. type BatchGetLinkAttributes struct { // A list of attribute names whose values will be retrieved. @@ -418,8 +414,7 @@ type BatchGetLinkAttributesResponse struct { } // Retrieves attributes within a facet that are associated with an object inside -// an BatchRead operation. For more information, see GetObjectAttributes and -// BatchReadRequest$Operations . +// an BatchReadoperation. For more information, see GetObjectAttributes and BatchReadRequest$Operations. type BatchGetObjectAttributes struct { // List of attribute names whose values will be retrieved. @@ -432,8 +427,7 @@ 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 @@ -450,8 +444,8 @@ type BatchGetObjectAttributesResponse struct { noSmithyDocumentSerde } -// Retrieves metadata about an object inside a BatchRead operation. For more -// information, see GetObjectInformation and BatchReadRequest$Operations . +// Retrieves metadata about an object inside a BatchRead operation. For more information, +// see GetObjectInformationand BatchReadRequest$Operations. type BatchGetObjectInformation struct { // A reference to the object. @@ -474,8 +468,8 @@ type BatchGetObjectInformationResponse struct { noSmithyDocumentSerde } -// Lists indices attached to an object inside a BatchRead operation. For more -// information, see ListAttachedIndices and BatchReadRequest$Operations . +// Lists indices attached to an object inside a BatchRead operation. For more information, +// see ListAttachedIndicesand BatchReadRequest$Operations. type BatchListAttachedIndices struct { // A reference to the object that has indices attached. @@ -504,9 +498,8 @@ type BatchListAttachedIndicesResponse struct { noSmithyDocumentSerde } -// 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 . +// Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside +// a BatchReadoperation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations. type BatchListIncomingTypedLinks struct { // The reference that identifies the object whose attributes will be listed. @@ -544,8 +537,8 @@ type BatchListIncomingTypedLinksResponse struct { noSmithyDocumentSerde } -// Lists objects attached to the specified index inside a BatchRead operation. For -// more information, see ListIndex and BatchReadRequest$Operations . +// Lists objects attached to the specified index inside a BatchRead operation. For more +// information, see ListIndexand BatchReadRequest$Operations. type BatchListIndex struct { // The reference to the index to list. @@ -644,8 +637,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 BatchReadoperation. For more +// information, see ListObjectParentPathsand BatchReadRequest$Operations. type BatchListObjectParentPaths struct { // The reference that identifies the object whose attributes will be listed. @@ -707,8 +700,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 . +// operation. For more information, see ListObjectPoliciesand BatchReadRequest$Operations. type BatchListObjectPolicies struct { // The reference that identifies the object whose attributes will be listed. @@ -737,9 +729,8 @@ type BatchListObjectPoliciesResponse struct { noSmithyDocumentSerde } -// 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 . +// Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside +// a BatchReadoperation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations. type BatchListOutgoingTypedLinks struct { // The reference that identifies the object whose attributes will be listed. @@ -778,8 +769,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 . +// a BatchReadoperation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations. type BatchListPolicyAttachments struct { // The reference that identifies the policy object. @@ -809,8 +799,7 @@ type BatchListPolicyAttachmentsResponse struct { } // 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 . +// inside a BatchReadoperation. For more information, see LookupPolicy and BatchReadRequest$Operations. type BatchLookupPolicy struct { // Reference that identifies the object whose policies will be looked up. @@ -834,8 +823,9 @@ type BatchLookupPolicyResponse struct { 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) - // . + // , and PolicyType . For more information, see [Policies]. + // + // [Policies]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies PolicyToPathList []PolicyToPath noSmithyDocumentSerde @@ -869,10 +859,11 @@ type BatchReadOperation struct { // Lists indices attached to an object. ListAttachedIndices *BatchListAttachedIndices - // 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) - // . + // 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]. + // + // [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. @@ -887,8 +878,9 @@ 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]. + // + // [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 @@ -898,22 +890,24 @@ type BatchReadOperation struct { // Returns policies attached to an object in pagination fashion. ListObjectPolicies *BatchListObjectPolicies - // 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) - // . + // 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]. + // + // [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. ListPolicyAttachments *BatchListPolicyAttachments - // Lists all policies from the root of the Directory to the object specified. If - // 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) - // . + // Lists all policies from the root of the Directory to the object specified. If 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]. + // + // [Policies]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies LookupPolicy *BatchLookupPolicy noSmithyDocumentSerde @@ -946,10 +940,11 @@ type BatchReadSuccessfulResponse struct { // Lists indices attached to an object. ListAttachedIndices *BatchListAttachedIndicesResponse - // 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) - // . + // 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]. + // + // [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. @@ -964,8 +959,9 @@ 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]. + // + // [Directory Structure]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html ListObjectParentPaths *BatchListObjectParentPathsResponse // The list of parent objects to retrieve. @@ -974,22 +970,24 @@ type BatchReadSuccessfulResponse struct { // Returns policies attached to an object in pagination fashion. ListObjectPolicies *BatchListObjectPoliciesResponse - // 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) - // . + // 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]. + // + // [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. ListPolicyAttachments *BatchListPolicyAttachmentsResponse - // Lists all policies from the root of the Directory to the object specified. If - // 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) - // . + // Lists all policies from the root of the Directory to the object specified. If 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]. + // + // [Policies]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies LookupPolicy *BatchLookupPolicyResponse noSmithyDocumentSerde @@ -1016,10 +1014,9 @@ 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. @@ -1071,7 +1068,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 @@ -1082,32 +1079,35 @@ 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]. + // + // [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) - // for more information. + // Creates an index object. See [Indexing and search] for more information. + // + // [Indexing and search]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm 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]. + // + // [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. @@ -1128,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 @@ -1139,32 +1139,35 @@ 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]. + // + // [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) - // for more information. + // Creates an index object. See [Indexing and search] for more information. + // + // [Indexing and search]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm 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]. + // + // [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. @@ -1186,7 +1189,7 @@ 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. @@ -1198,9 +1201,10 @@ type Directory struct { noSmithyDocumentSerde } -// A structure that contains Name , ARN , Attributes , Rule s , and ObjectTypes . -// See Facets (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html) +// A structure that contains Name , ARN , Attributes , Rules , and ObjectTypes . See [Facets] // for more information. +// +// [Facets]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html type Facet struct { // There are two different styles that you can define on any given facet, Static @@ -1208,17 +1212,16 @@ type Facet struct { // 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 - // CreateFacetRequest$ObjectType for more details. + // The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details. ObjectType ObjectType 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. @@ -1227,13 +1230,15 @@ type FacetAttribute struct { 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) - // for more information. + // structure contains the attribute definition. See [Attribute References]for more information. + // + // [Attribute References]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html 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) - // for more information. + // An attribute reference that is associated with the attribute. See [Attribute References] for more + // information. + // + // [Attribute References]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html AttributeReference *FacetAttributeReference // The required behavior of the FacetAttribute . @@ -1242,8 +1247,9 @@ type FacetAttribute struct { noSmithyDocumentSerde } -// A facet attribute definition. See Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) -// for more information. +// A facet attribute definition. See [Attribute References] for more information. +// +// [Attribute References]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html type FacetAttributeDefinition struct { // The type of the attribute. @@ -1267,16 +1273,18 @@ type FacetAttributeDefinition struct { // contains the attribute facet name and attribute name. 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) - // for more information. + // The target attribute name that is associated with the facet reference. See [Attribute References] for + // more information. + // + // [Attribute References]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html // // 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) - // for more information. + // The target facet name that is associated with the facet reference. See [Attribute References] for + // more information. + // + // [Attribute References]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html // // This member is required. TargetFacetName *string @@ -1302,10 +1310,10 @@ 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 - // 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. + // 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 noSmithyDocumentSerde @@ -1390,15 +1398,20 @@ 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: + // are separated by slashes. For more information about paths, see [Access Objects]. 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 + // + // [Access Objects]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html Selector *string noSmithyDocumentSerde @@ -1418,8 +1431,9 @@ type PathToObjectIdentifiers struct { } // 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) -// . +// attached. For more information, see [Policies]. +// +// [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 . @@ -1434,8 +1448,8 @@ type PolicyAttachment struct { 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. @@ -1466,10 +1480,11 @@ type SchemaFacet struct { // The name of the facet. If this value is set, SchemaArn must also be set. 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) + // The ARN of the schema that contains the facet with no minor component. See arns and [In-Place Schema Upgrade] // for a description of when to provide minor versions. If this value is set, // FacetName must also be set. + // + // [In-Place Schema Upgrade]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html SchemaArn *string noSmithyDocumentSerde @@ -1547,8 +1562,9 @@ 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]. +// +// [Range Filters]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html type TypedAttributeValueRange struct { // The inclusive or exclusive range end. @@ -1615,7 +1631,7 @@ type TypedLinkAttributeRange struct { } // Defines the typed links structure and its attributes. To create a typed link -// facet, use the CreateTypedLinkFacet API. +// facet, use the CreateTypedLinkFacetAPI. type TypedLinkFacet struct { // A set of key-value pairs associated with the typed link. Typed link attributes @@ -1628,8 +1644,7 @@ type TypedLinkFacet struct { // The set of attributes that distinguish links made from this facet from each // other, in the order of significance. Listing typed links can filter on the - // values of these attributes. See ListOutgoingTypedLinks and - // ListIncomingTypedLinks for details. + // values of these attributes. See ListOutgoingTypedLinksand ListIncomingTypedLinks for details. // // This member is required. IdentityAttributeOrder []string @@ -1663,7 +1678,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 @@ -1678,10 +1693,9 @@ type TypedLinkSchemaAndFacetName struct { // 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 +// link being operated on. The AttachTypedLinkAPI returns a typed link specifier while the DetachTypedLink API +// accepts one as input. Similarly, the ListIncomingTypedLinksand ListOutgoingTypedLinks API operations provide typed link +// specifiers as output. You can also construct a typed link specifier from // scratch. type TypedLinkSpecifier struct { diff --git a/service/cloudformation/api_op_ActivateType.go b/service/cloudformation/api_op_ActivateType.go index 16ebb75f018..a241f60c464 100644 --- a/service/cloudformation/api_op_ActivateType.go +++ b/service/cloudformation/api_op_ActivateType.go @@ -12,12 +12,15 @@ 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) -// in the CloudFormation User Guide. Once you have activated a public third-party -// extension in your account and Region, use SetTypeConfiguration (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) -// 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-private.html#registry-set-configuration) -// in the CloudFormation User Guide. +// templates. For more information, see [Using public extensions]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]in the CloudFormation User Guide. +// +// [SetTypeConfiguration]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html +// [Using public extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html +// [Configuring extensions at the account level]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration func (c *Client) ActivateType(ctx context.Context, params *ActivateTypeInput, optFns ...func(*Options)) (*ActivateTypeOutput, error) { if params == nil { params = &ActivateTypeInput{} @@ -37,7 +40,9 @@ 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. @@ -48,40 +53,51 @@ 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. + // uses the latest available minor version of the major version selected. + // + // You can 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 . + // The Amazon Resource Name (ARN) of the public extension. + // + // Conditional: You must 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 // specify an alias for the extension, CloudFormation treats the alias as the // extension type name within this account and Region. You must use the alias to // refer to the extension in your templates, API calls, and CloudFormation console. + // // An extension alias must be unique within a given account and Region. You can // activate the same public resource multiple times in the same account and Region, // 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 - // . + // 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 diff --git a/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go b/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go index 3667dfd1457..a891c8d1470 100644 --- a/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go +++ b/service/cloudformation/api_op_BatchDescribeTypeConfigurations.go @@ -12,9 +12,11 @@ import ( ) // 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-private.html#registry-set-configuration) -// in the CloudFormation User Guide. +// the CloudFormation registry for the account and Region. +// +// For more information, see [Configuring extensions at the account level] in the CloudFormation User Guide. +// +// [Configuring extensions at the account level]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration func (c *Client) BatchDescribeTypeConfigurations(ctx context.Context, params *BatchDescribeTypeConfigurationsInput, optFns ...func(*Options)) (*BatchDescribeTypeConfigurationsOutput, error) { if params == nil { params = &BatchDescribeTypeConfigurationsInput{} diff --git a/service/cloudformation/api_op_CancelUpdateStack.go b/service/cloudformation/api_op_CancelUpdateStack.go index 5dde74d7f91..04684aaa781 100644 --- a/service/cloudformation/api_op_CancelUpdateStack.go +++ b/service/cloudformation/api_op_CancelUpdateStack.go @@ -12,6 +12,7 @@ import ( // Cancels an update on the specified stack. If the call completes successfully, // the stack rolls back the update and reverts to the previous stack configuration. +// // You can cancel only stacks that are in the UPDATE_IN_PROGRESS state. func (c *Client) CancelUpdateStack(ctx context.Context, params *CancelUpdateStackInput, optFns ...func(*Options)) (*CancelUpdateStackOutput, error) { if params == nil { @@ -32,12 +33,17 @@ func (c *Client) CancelUpdateStack(ctx context.Context, params *CancelUpdateStac type CancelUpdateStackInput struct { // If you don't pass a parameter to StackName , the API returns a response that - // describes all resources in the account. The IAM policy below can be added to IAM - // policies when you want to limit resource-level permissions and avoid returning a - // response when no parameter is sent in the request: { "Version": "2012-10-17", - // "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", - // "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] } The name or the - // unique stack ID that's associated with the stack. + // describes all resources in the account. + // + // The IAM policy below can be added to IAM policies when you want to limit + // resource-level permissions and avoid returning a response when no parameter is + // sent in the request: + // + // { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": + // "cloudformation:DescribeStacks", "NotResource": + // "arn:aws:cloudformation:*:*:stack/*/*" }] } + // + // The name or the unique stack ID that's associated with the stack. // // This member is required. StackName *string diff --git a/service/cloudformation/api_op_ContinueUpdateRollback.go b/service/cloudformation/api_op_ContinueUpdateRollback.go index 4d594155396..3330e3b6b87 100644 --- a/service/cloudformation/api_op_ContinueUpdateRollback.go +++ b/service/cloudformation/api_op_ContinueUpdateRollback.go @@ -12,15 +12,18 @@ 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) -// 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 -// CloudFormation can't roll back all changes after a failed stack update. For -// example, you might have a stack that's rolling back to an old database instance -// that was deleted outside of CloudFormation. Because CloudFormation doesn't know -// the database was deleted, it assumes that the database instance still exists and -// attempts to roll back to it, causing the update rollback to fail. +// of the failure, you can manually [fix the error]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 CloudFormation can't +// roll back all changes after a failed stack update. For example, you might have a +// stack that's rolling back to an old database instance that was deleted outside +// of CloudFormation. Because CloudFormation doesn't know the database was deleted, +// it assumes that the database instance still exists and attempts to roll back to +// it, causing the update rollback to fail. +// +// [fix the error]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed func (c *Client) ContinueUpdateRollback(ctx context.Context, params *ContinueUpdateRollbackInput, optFns ...func(*Options)) (*ContinueUpdateRollbackOutput, error) { if params == nil { params = &ContinueUpdateRollbackInput{} @@ -40,6 +43,7 @@ func (c *Client) ContinueUpdateRollback(ctx context.Context, params *ContinueUpd type ContinueUpdateRollbackInput struct { // The name or the unique ID of the stack that you want to continue rolling back. + // // Don't specify the name of a nested stack (a stack that was created by using the // AWS::CloudFormation::Stack resource). Instead, use this operation on the parent // stack (the stack that contains the AWS::CloudFormation::Stack resource). @@ -58,29 +62,34 @@ type ContinueUpdateRollbackInput struct { // continue update rollback operation. You can specify only resources that are in // the UPDATE_FAILED state because a rollback failed. You can't specify resources // that are in the UPDATE_FAILED state for other reasons, for example, because an - // 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) - // 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 - // with the state of the resources in the stack template. Before performing another - // stack update, you must update the stack or resources to be consistent with each - // other. If you don't, subsequent stack updates might fail, and the stack will - // become unrecoverable. Specify the minimum number of resources required to - // 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) - // . + // update was canceled. To check why a resource update failed, use the DescribeStackResourcesaction, 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]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 with the state of the resources in + // the stack template. Before performing another stack update, you must update the + // stack or resources to be consistent with each other. If you don't, subsequent + // stack updates might fail, and the stack will become unrecoverable. + // + // Specify the minimum number of resources required to 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]. + // + // [troubleshoot]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed + // [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 @@ -88,8 +97,9 @@ type ContinueUpdateRollbackInput struct { // role's credentials to make calls on your behalf. CloudFormation always uses this // role for all future operations on the stack. Provided that users have permission // to operate on the stack, CloudFormation uses this role even if the users don't - // have permission to pass it. Ensure that the role grants least permission. If you - // don't specify a value, CloudFormation uses the role that was previously + // have permission to pass it. Ensure that the role grants least permission. + // + // If you don't specify a value, CloudFormation uses the role that was previously // associated with the stack. If no role is available, CloudFormation uses a // temporary session that's generated from your user credentials. RoleARN *string diff --git a/service/cloudformation/api_op_CreateChangeSet.go b/service/cloudformation/api_op_CreateChangeSet.go index 50d1be62587..788245a0eb7 100644 --- a/service/cloudformation/api_op_CreateChangeSet.go +++ b/service/cloudformation/api_op_CreateChangeSet.go @@ -19,17 +19,22 @@ import ( // 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 +// 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 . +// 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 ExecuteChangeSetaction. 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{} @@ -49,9 +54,11 @@ func (c *Client) CreateChangeSet(ctx context.Context, params *CreateChangeSetInp type CreateChangeSetInput struct { // The name of the change set. The name must be unique among all change sets that - // are associated with the specified stack. A change set name can contain only - // alphanumeric, case sensitive characters, and hyphens. It must start with an - // alphabetical character and can't exceed 128 characters. + // are associated with the specified stack. + // + // A change set name can contain only alphanumeric, case sensitive characters, and + // hyphens. It must start with an alphabetical character and can't exceed 128 + // characters. // // This member is required. ChangeSetName *string @@ -66,58 +73,93 @@ type CreateChangeSetInput struct { // 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. + // + // - 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 (https://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 (https://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 (https://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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) - // . + // 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] + // + // [AWS::IAM::Group] + // + // [AWS::IAM::InstanceProfile] + // + // [AWS::IAM::Policy] + // + // [AWS::IAM::Role] + // + // [AWS::IAM::User] + // + // [AWS::IAM::UserToGroupAddition] + // + // For more information, see [Acknowledging IAM resources in CloudFormation templates]. + // + // - 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]and [AWS::Serverless]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 CreateStackor UpdateStackaction, and specifying this capability. + // + // For more information about macros, see [Using CloudFormation macros to perform custom processing on templates]. + // // Only one of the Capabilities and ResourceType parameters can be specified. + // + // [AWS::IAM::AccessKey]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html + // [AWS::Include]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html + // [AWS::IAM::User]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html + // [AWS::IAM::InstanceProfile]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html + // [Acknowledging IAM resources in CloudFormation templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities + // [AWS::IAM::Policy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html + // [AWS::IAM::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::UserToGroupAddition]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [Using CloudFormation macros to perform custom processing on templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html + // [AWS::Serverless]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.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 - // 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) - // 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. + // 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]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. + // + // [REVIEW_IN_PROGRESS]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995 ChangeSetType types.ChangeSetType // A unique identifier for this CreateChangeSet request. Specify this token if you @@ -129,13 +171,15 @@ type CreateChangeSetInput struct { // A description to help you identify this change set. Description *string - // Indicates if the change set imports resources that already exist. This - // parameter can only import resources that have custom names in templates. For - // more information, see name type (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) - // in the CloudFormation User Guide. To import resources that do not accept custom - // names, such as EC2 instances, use the resource import feature instead. For more - // information, see Bringing existing resources into CloudFormation management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html) - // in the CloudFormation User Guide. + // Indicates if the change set imports resources that already exist. + // + // This parameter can only import resources that have custom names in templates. + // For more information, see [name type]in the CloudFormation User Guide. To import resources + // that do not accept custom names, such as EC2 instances, use the resource import + // feature instead. For more information, see [Bringing existing resources into CloudFormation management]in the CloudFormation User Guide. + // + // [Bringing existing resources into CloudFormation management]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html + // [name type]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html ImportExistingResources *bool // Creates a change set for the all nested stacks specified in the template. The @@ -149,37 +193,44 @@ type CreateChangeSetInput struct { NotificationARNs []string // Determines what action will be taken if stack creation fails. If this parameter - // is specified, the DisableRollback parameter to the ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) - // API operation must not be specified. This must be one of these values: + // is specified, the DisableRollback parameter to the [ExecuteChangeSet] API operation must not be + // specified. This must be one of these values: + // // - DELETE - Deletes the change set if the stack creation fails. This is only // valid when the ChangeSetType parameter is set to CREATE . If the deletion of // the stack fails, the status of the stack is DELETE_FAILED . + // // - DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to - // specifying true for the DisableRollback parameter to the ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) - // API operation. + // specifying true for the DisableRollback parameter to the [ExecuteChangeSet]API operation. + // // - ROLLBACK - if the stack creation fails, roll back the stack. This is - // equivalent to specifying false for the DisableRollback parameter to the - // ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) - // API operation. + // equivalent to specifying false for the DisableRollback parameter to the [ExecuteChangeSet]API + // operation. + // // For nested stacks, when the OnStackFailure parameter is set to DELETE for the // change set for the parent stack, any failure in a child stack will cause the // parent stack creation to fail and all stacks to be deleted. + // + // [ExecuteChangeSet]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html OnStackFailure types.OnStackFailure // A list of Parameter structures that specify input parameters for the change - // set. For more information, see the Parameter data type. + // set. For more information, see the Parameterdata 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 - // 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) - // in the CloudFormation User Guide. Only one of the Capabilities and ResourceType - // parameters can be specified. + // 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]in the CloudFormation User Guide. + // + // Only one of the Capabilities and ResourceType parameters can be specified. + // + // [Controlling access with Identity and Access Management]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html ResourceTypes []string // The resources to import into your stack. @@ -190,8 +241,9 @@ type CreateChangeSetInput struct { // the role's credentials to make calls on your behalf. CloudFormation uses this // role for all future operations on the stack. Provided that users have permission // to operate on the stack, CloudFormation uses this role even if the users don't - // have permission to pass it. Ensure that the role grants least permission. If you - // don't specify a value, CloudFormation uses the role that was previously + // have permission to pass it. Ensure that the role grants least permission. + // + // If you don't specify a value, CloudFormation uses the role that was previously // associated with the stack. If no role is available, CloudFormation uses a // temporary session that is generated from your user credentials. RoleARN *string @@ -207,15 +259,18 @@ 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. The location for an Amazon S3 - // bucket must start with https:// . Conditional: You must specify only - // TemplateBody or TemplateURL . + // bucket must start with https:// . + // + // Conditional: You must specify 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_CreateGeneratedTemplate.go b/service/cloudformation/api_op_CreateGeneratedTemplate.go index 5f4fb17096e..7add400e20f 100644 --- a/service/cloudformation/api_op_CreateGeneratedTemplate.go +++ b/service/cloudformation/api_op_CreateGeneratedTemplate.go @@ -36,10 +36,11 @@ type CreateGeneratedTemplateInput struct { // This member is required. GeneratedTemplateName *string - // An optional list of resources to be included in the generated template. If no - // resources are specified,the template will be created without any resources. - // Resources can be added to the template using the UpdateGeneratedTemplate API - // action. + // An optional list of resources to be included in the generated template. + // + // If no resources are specified,the template will be created without any + // resources. Resources can be added to the template using the + // UpdateGeneratedTemplate API action. Resources []types.ResourceDefinition // An optional name or ARN of a stack to use as the base stack for the generated diff --git a/service/cloudformation/api_op_CreateStack.go b/service/cloudformation/api_op_CreateStack.go index 53824180234..f71a488519b 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 DescribeStacks operation. +// through the DescribeStacksoperation. func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error) { if params == nil { params = &CreateStackInput{} @@ -33,88 +33,130 @@ func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optF 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. + // 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. + // + // - 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 (https://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 (https://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 (https://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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) - // . + // 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] + // + // [AWS::IAM::Group] + // + // [AWS::IAM::InstanceProfile] + // + // [AWS::IAM::Policy] + // + // [AWS::IAM::Role] + // + // [AWS::IAM::User] + // + // [AWS::IAM::UserToGroupAddition] + // + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates]. + // + // - 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]and [AWS::Serverless]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]. + // // Only one of the Capabilities and ResourceType parameters can be specified. + // + // [AWS::IAM::AccessKey]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html + // [AWS::Include]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html + // [AWS::IAM::User]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.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::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::UserToGroupAddition]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [Using CloudFormation macros to perform custom processing on templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html + // [AWS::Serverless]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html + // [Acknowledging IAM Resources in CloudFormation Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities 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 - // 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 . + // 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 . 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 (https://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 (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. + // fails and the stack remains unchanged. For more information, see [Protecting a Stack From Being Deleted]in the + // CloudFormation User Guide. Termination protection is deactivated on stacks by + // default. + // + // For [nested stacks], termination protection is set on the root stack and can't be changed + // directly on the nested stack. + // + // [Protecting a Stack From Being Deleted]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html + // [nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html EnableTerminationProtection *bool // The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack @@ -124,12 +166,15 @@ type CreateStackInput struct { // 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 + // 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) - // data type. + // more information, see the [Parameter]data type. + // + // [Parameter]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html Parameters []types.Parameter // The template resource types that you have permissions to work with for this @@ -139,17 +184,24 @@ type CreateStackInput struct { // 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 - // 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) - // . Only one of the Capabilities and ResourceType parameters can be specified. + // 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]. + // + // Only one of the Capabilities and ResourceType parameters can be specified. + // + // [Controlling Access with Identity and Access Management]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html ResourceTypes []string // When set to true , newly created resources are deleted when the operation rolls // back. This includes newly created resources marked with a deletion policy of - // Retain . Default: false + // Retain . + // + // Default: false RetainExceptOnCreate *bool // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role @@ -157,20 +209,22 @@ type CreateStackInput struct { // credentials to make calls on your behalf. CloudFormation always uses this role // for all future operations on the stack. Provided that users have permission to // operate on the stack, CloudFormation uses this role even if the users don't have - // permission to pass it. Ensure that the role grants least privilege. If you don't - // specify a value, CloudFormation uses the role that was previously associated - // with the stack. If no role is available, CloudFormation uses a temporary session - // that's generated from your user credentials. + // permission to pass it. Ensure that the role grants least privilege. + // + // If you don't specify a value, CloudFormation uses the role that was previously + // associated with the stack. If no role is available, CloudFormation uses a + // temporary session that's generated from your user credentials. RoleARN *string // The rollback triggers for CloudFormation to monitor during stack creation and // 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) - // in the CloudFormation User Guide. You can specify either the StackPolicyBody or - // the StackPolicyURL parameter, but not both. + // Structure containing the stack policy body. For more information, go to [Prevent Updates to Stack Resources] in the + // CloudFormation User Guide. You can specify either the StackPolicyBody or the + // StackPolicyURL parameter, but not both. + // + // [Prevent Updates to Stack Resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html StackPolicyBody *string // Location of a file containing the stack policy. The URL must point to a policy @@ -185,17 +239,24 @@ 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) - // in the CloudFormation User Guide. Conditional: You must specify either the - // TemplateBody or the TemplateURL parameter, but not both. + // maximum length of 51,200 bytes. For more information, go to [Template anatomy]in the + // CloudFormation User Guide. + // + // Conditional: You must specify either the TemplateBody or the TemplateURL + // parameter, but not both. + // + // [Template anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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) - // in the CloudFormation User Guide. The location for an Amazon S3 bucket must - // start with https:// . Conditional: You must specify either the TemplateBody or - // the TemplateURL parameter, but not both. + // Manager document. For more information, go to the [Template anatomy]in the CloudFormation User + // Guide. The location for an Amazon S3 bucket must start with https:// . + // + // Conditional: You must specify either the TemplateBody or the TemplateURL + // parameter, but not both. + // + // [Template anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateURL *string // The amount of time that can pass before the stack status becomes CREATE_FAILED ; diff --git a/service/cloudformation/api_op_CreateStackInstances.go b/service/cloudformation/api_op_CreateStackInstances.go index 34bcfd00baa..f53e5f3f785 100644 --- a/service/cloudformation/api_op_CreateStackInstances.go +++ b/service/cloudformation/api_op_CreateStackInstances.go @@ -46,57 +46,79 @@ type CreateStackInstancesInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html 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. + // stack instances in the specified Amazon Web Services Regions. + // + // You can specify Accounts or DeploymentTargets , but not both. DeploymentTargets *types.DeploymentTargets - // The unique identifier for this stack set operation. The operation ID also - // functions as an idempotency token, to ensure that CloudFormation performs the - // stack set operation only once, even if you retry the request multiple times. You - // 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 . + // The unique identifier for this stack set operation. + // + // The operation ID also functions as an idempotency token, to ensure that + // CloudFormation performs the stack set operation only once, even if you retry the + // request multiple times. You 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 . 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 - // specifying parameters and their values, be aware of how CloudFormation sets - // parameter values during stack instance operations: + // 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 update the stack set template. + // 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. + // + // [UpdateStackSet]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html ParameterOverrides []types.Parameter noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_CreateStackSet.go b/service/cloudformation/api_op_CreateStackSet.go index 6f672bf0715..fabb926161e 100644 --- a/service/cloudformation/api_op_CreateStackSet.go +++ b/service/cloudformation/api_op_CreateStackSet.go @@ -30,19 +30,23 @@ func (c *Client) CreateStackSet(ctx context.Context, params *CreateStackSetInput type CreateStackSetInput struct { // The name to associate with the stack set. The name must be unique in the Region - // where you create your stack set. A stack name can contain only alphanumeric - // characters (case-sensitive) and hyphens. It must start with an alphabetic - // character and can't be longer than 128 characters. + // where you create your stack set. + // + // A stack name can contain only alphanumeric characters (case-sensitive) and + // hyphens. It must start with an alphabetic character and can't be longer than 128 + // characters. // // This member is required. StackSetName *string // The Amazon Resource Name (ARN) of the IAM role to use to create this stack set. + // // 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) - // in the CloudFormation User Guide. + // administrator account. For more information, see [Prerequisites: Granting Permissions for Stack Set Operations]in the CloudFormation User + // Guide. + // + // [Prerequisites: Granting Permissions for Stack Set Operations]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html AdministrationRoleARN *string // Describes whether StackSets automatically deploys to Organizations accounts @@ -52,64 +56,101 @@ type CreateStackSetInput struct { // [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. + // 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. + // 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]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. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html 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. + // + // - 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 (https://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 (https://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 (https://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 (https://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. + // 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] + // + // [AWS::IAM::Group] + // + // [AWS::IAM::InstanceProfile] + // + // [AWS::IAM::Policy] + // + // [AWS::IAM::Role] + // + // [AWS::IAM::User] + // + // [AWS::IAM::UserToGroupAddition] + // + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates]. + // + // - 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]. + // + // Stack sets with service-managed permissions don't currently support the use of + // macros in templates. (This includes the [AWS::Include]and [AWS::Serverless]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. + // + // [AWS::IAM::AccessKey]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html + // [AWS::Include]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html + // [AWS::IAM::User]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.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::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::UserToGroupAddition]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [Using CloudFormation Macros to Perform Custom Processing on Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html + // [AWS::Serverless]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html + // [Acknowledging IAM Resources in CloudFormation Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities Capabilities []types.Capability // A unique identifier for this CreateStackSet request. Specify this token if you // plan to retry requests so that CloudFormation knows that you're not attempting // to create another stack set with the same name. You might retry CreateStackSet - // requests to ensure that CloudFormation successfully received them. If you don't - // specify an operation ID, the SDK generates one automatically. + // requests to ensure that CloudFormation successfully received them. + // + // If you don't specify an operation ID, the SDK generates one automatically. ClientRequestToken *string // A description of the stack set. You can use the description to identify the @@ -118,9 +159,10 @@ type CreateStackSetInput struct { // 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. + // 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 @@ -132,14 +174,17 @@ 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) - // . + // [Grant Self-Managed Stack Set Permissions]. + // // - 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) - // . + // information, see [Grant Service-Managed Stack Set Permissions]. + // + // [Grant Self-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html + // [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 @@ -148,24 +193,33 @@ type CreateStackSetInput struct { // 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. + // 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) - // in the CloudFormation User Guide. Conditional: You must specify either the - // TemplateBody or the TemplateURL parameter, but not both. + // and a maximum length of 51,200 bytes. For more information, see [Template Anatomy]in the + // CloudFormation User Guide. + // + // Conditional: You must specify either the TemplateBody or the TemplateURL + // parameter, but not both. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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) - // in the CloudFormation User Guide. Conditional: You must specify either the - // TemplateBody or the TemplateURL parameter, but not both. + // or a Systems Manager document. For more information, see [Template Anatomy]in the CloudFormation + // User Guide. + // + // Conditional: You must specify either the TemplateBody or the TemplateURL + // parameter, but not both. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateURL *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DeactivateType.go b/service/cloudformation/api_op_DeactivateType.go index a6072bbacb7..c2c8db522e2 100644 --- a/service/cloudformation/api_op_DeactivateType.go +++ b/service/cloudformation/api_op_DeactivateType.go @@ -12,11 +12,13 @@ import ( ) // 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 -// of the extension is released. +// 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 of the +// extension is released. func (c *Client) DeactivateType(ctx context.Context, params *DeactivateTypeInput, optFns ...func(*Options)) (*DeactivateTypeOutput, error) { if params == nil { params = &DeactivateTypeInput{} @@ -35,15 +37,18 @@ 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 . 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 . TypeName *string diff --git a/service/cloudformation/api_op_DeleteChangeSet.go b/service/cloudformation/api_op_DeleteChangeSet.go index 1459bc6b4fc..f63f09c7b7d 100644 --- a/service/cloudformation/api_op_DeleteChangeSet.go +++ b/service/cloudformation/api_op_DeleteChangeSet.go @@ -11,12 +11,15 @@ import ( ) // Deletes the specified change set. Deleting change sets ensures that no one -// executes the wrong change set. If the call successfully completes, -// CloudFormation successfully deleted the change set. If IncludeNestedStacks -// 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 . +// executes the wrong change set. +// +// If the call successfully completes, CloudFormation successfully deleted the +// change set. +// +// If IncludeNestedStacks 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 . 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 61ee2f1329f..3be408fb2a7 100644 --- a/service/cloudformation/api_op_DeleteStack.go +++ b/service/cloudformation/api_op_DeleteStack.go @@ -11,8 +11,8 @@ import ( ) // Deletes a specified stack. Once the call completes successfully, stack deletion -// starts. Deleted stacks don't show up in the DescribeStacks operation if the -// deletion has been completed successfully. +// starts. Deleted stacks don't show up in the DescribeStacksoperation if the deletion has been +// completed successfully. func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optFns ...func(*Options)) (*DeleteStackOutput, error) { if params == nil { params = &DeleteStackInput{} @@ -39,31 +39,36 @@ type DeleteStackInput struct { // 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 . + // 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 . ClientRequestToken *string // For stacks in the DELETE_FAILED state, a list of resource logical IDs that are // associated with the resources you want to retain. During deletion, // CloudFormation deletes the stack but doesn't delete the retained resources. + // // Retaining resources is useful when you can't delete a resource, such as a // non-empty S3 bucket, but you want to delete the stack. RetainResources []string // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role // that CloudFormation assumes to delete the stack. CloudFormation uses the role's - // credentials to make calls on your behalf. If you don't specify a value, - // CloudFormation uses the role that was previously associated with the stack. If - // no role is available, CloudFormation uses a temporary session that's generated - // from your user credentials. + // credentials to make calls on your behalf. + // + // If you don't specify a value, CloudFormation uses the role that was previously + // associated with the stack. If no role is available, CloudFormation uses a + // temporary session that's generated from your user credentials. RoleARN *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DeleteStackInstances.go b/service/cloudformation/api_op_DeleteStackInstances.go index a91738b66ae..9fa47278df0 100644 --- a/service/cloudformation/api_op_DeleteStackInstances.go +++ b/service/cloudformation/api_op_DeleteStackInstances.go @@ -37,8 +37,11 @@ type DeleteStackInstancesInput struct { // 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) - // . + // stack to a new stack set. + // + // For more information, see [Stack set operation options]. + // + // [Stack set operation options]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options // // This member is required. RetainStacks *bool @@ -50,33 +53,47 @@ type DeleteStackInstancesInput struct { StackSetName *string // [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. + // you want to delete stack instances 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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html 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 - // operation ID, the SDK generates one automatically. The operation ID also - // functions as an idempotency token, to ensure that CloudFormation performs the - // 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 . + // The unique identifier for this stack set operation. + // + // If you don't specify an operation ID, the SDK generates one automatically. + // + // The operation ID also functions as an idempotency token, to ensure that + // CloudFormation performs the 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 . 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 8986ca194f5..0c2f7c85f6d 100644 --- a/service/cloudformation/api_op_DeleteStackSet.go +++ b/service/cloudformation/api_op_DeleteStackSet.go @@ -12,8 +12,8 @@ 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 . +// instances must be deleted. For more information about how to complete this, see DeleteStackInstances +// . func (c *Client) DeleteStackSet(ctx context.Context, params *DeleteStackSetInput, optFns ...func(*Options)) (*DeleteStackSetOutput, error) { if params == nil { params = &DeleteStackSetInput{} @@ -32,21 +32,28 @@ 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 . + // this value by running ListStackSets. // // This member is required. StackSetName *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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DeregisterType.go b/service/cloudformation/api_op_DeregisterType.go index 9a99245d44b..7d9f694a1c3 100644 --- a/service/cloudformation/api_op_DeregisterType.go +++ b/service/cloudformation/api_op_DeregisterType.go @@ -13,16 +13,21 @@ import ( // Marks an extension or extension version as DEPRECATED in the CloudFormation // registry, removing it from active use. Deprecated extensions or extension -// versions cannot be used in CloudFormation operations. To deregister an entire -// extension, you must individually deregister all active versions of that -// extension. If an extension has only a single active version, deregistering that -// version results in the extension itself being deregistered and marked as -// deprecated in the registry. You can't deregister the default version of an -// 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) -// . +// versions cannot be used in CloudFormation operations. +// +// To deregister an entire extension, you must individually deregister all active +// versions of that extension. If an extension has only a single active version, +// deregistering that version results in the extension itself being deregistered +// and marked as deprecated in the registry. +// +// You can't deregister the default version of an 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]. +// +// [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{} @@ -40,16 +45,19 @@ 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 . + // The Amazon Resource Name (ARN) of the extension. + // + // 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 . + // The name of the extension. + // + // Conditional: You must specify either TypeName and 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 a3e77b76012..17e329a3a0c 100644 --- a/service/cloudformation/api_op_DescribeAccountLimits.go +++ b/service/cloudformation/api_op_DescribeAccountLimits.go @@ -13,8 +13,9 @@ 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) -// in the CloudFormation User Guide. +// limits, see [CloudFormation Quotas]in the CloudFormation User Guide. +// +// [CloudFormation Quotas]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { params = &DescribeAccountLimitsInput{} diff --git a/service/cloudformation/api_op_DescribeChangeSet.go b/service/cloudformation/api_op_DescribeChangeSet.go index 7b049bfda04..cbb01db6078 100644 --- a/service/cloudformation/api_op_DescribeChangeSet.go +++ b/service/cloudformation/api_op_DescribeChangeSet.go @@ -18,9 +18,10 @@ 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) -// in the CloudFormation User Guide. +// will make if you execute the change set. For more information, see [Updating Stacks Using Change Sets]in the +// CloudFormation User Guide. +// +// [Updating Stacks Using Change Sets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error) { if params == nil { params = &DescribeChangeSetInput{} @@ -48,8 +49,8 @@ type DescribeChangeSetInput struct { // If true , the returned changes include detailed changes in the property values. IncludePropertyValues *bool - // 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) @@ -88,11 +89,14 @@ type DescribeChangeSetOutput struct { // creating it or in an OBSOLETE state because the stack was already updated. ExecutionStatus types.ExecutionStatus - // Indicates if the change set imports resources that already exist. This - // parameter can only import resources that have custom names (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) - // in templates. To import resources that do not accept custom names, such as EC2 - // instances, use the resource import (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html) + // Indicates if the change set imports resources that already exist. + // + // This parameter can only import resources that have [custom names] in templates. To import + // resources that do not accept custom names, such as EC2 instances, use the [resource import] // feature instead. + // + // [custom names]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html + // [resource import]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html ImportExistingResources *bool // Verifies if IncludeNestedStacks is set to True . @@ -107,23 +111,27 @@ type DescribeChangeSetOutput struct { NotificationARNs []string // Determines what action will be taken if stack creation fails. When this - // parameter is specified, the DisableRollback parameter to the ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) - // API operation must not be specified. This must be one of these values: + // parameter is specified, the DisableRollback parameter to the [ExecuteChangeSet] API operation + // must not be specified. This must be one of these values: + // // - DELETE - Deletes the change set if the stack creation fails. This is only // valid when the ChangeSetType parameter is set to CREATE . If the deletion of // the stack fails, the status of the stack is DELETE_FAILED . + // // - DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to - // specifying true for the DisableRollback parameter to the ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) - // API operation. + // specifying true for the DisableRollback parameter to the [ExecuteChangeSet]API operation. + // // - ROLLBACK - if the stack creation fails, roll back the stack. This is - // equivalent to specifying false for the DisableRollback parameter to the - // ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) - // API operation. + // equivalent to specifying false for the DisableRollback parameter to the [ExecuteChangeSet]API + // operation. + // + // [ExecuteChangeSet]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html OnStackFailure types.OnStackFailure // 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) - // data type. + // values used to create the change set. For more information, see the [Parameter]data type. + // + // [Parameter]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html Parameters []types.Parameter // Specifies the change set ID of the parent change set in the current nested @@ -283,12 +291,13 @@ type ChangeSetCreateCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeChangeSetInput, *DescribeChangeSetOutput, error) (bool, error) } diff --git a/service/cloudformation/api_op_DescribeGeneratedTemplate.go b/service/cloudformation/api_op_DescribeGeneratedTemplate.go index ee641785451..0f8ac5411fd 100644 --- a/service/cloudformation/api_op_DescribeGeneratedTemplate.go +++ b/service/cloudformation/api_op_DescribeGeneratedTemplate.go @@ -71,13 +71,21 @@ type DescribeGeneratedTemplateOutput struct { StackId *string // The status of the template generation. Supported values are: + // // - CreatePending - the creation of the template is pending. + // // - CreateInProgress - the creation of the template is in progress. + // // - DeletePending - the deletion of the template is pending. + // // - DeleteInProgress - the deletion of the template is in progress. + // // - UpdatePending - the update of the template is pending. + // // - UpdateInProgress - the update of the template is in progress. + // // - Failed - the template operation failed. + // // - Complete - the template operation is complete. Status types.GeneratedTemplateStatus diff --git a/service/cloudformation/api_op_DescribeOrganizationsAccess.go b/service/cloudformation/api_op_DescribeOrganizationsAccess.go index bf60bc77486..5bcbf51c39b 100644 --- a/service/cloudformation/api_op_DescribeOrganizationsAccess.go +++ b/service/cloudformation/api_op_DescribeOrganizationsAccess.go @@ -34,13 +34,20 @@ type DescribeOrganizationsAccessInput struct { // [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. + // administrator in a member account. + // + // By default, SELF is specified. + // // - 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribePublisher.go b/service/cloudformation/api_op_DescribePublisher.go index 12c71020c85..d2a5ff310e1 100644 --- a/service/cloudformation/api_op_DescribePublisher.go +++ b/service/cloudformation/api_op_DescribePublisher.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a CloudFormation 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. 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 +// Returns information about a CloudFormation 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. +// +// For more information about registering as a publisher, see: +// +// [RegisterPublisher] +// +// [Publishing extensions to make them available for public use] +// - in the CloudFormation CLI User Guide +// +// [Publishing extensions to make them available for public use]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html +// [RegisterPublisher]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html func (c *Client) DescribePublisher(ctx context.Context, params *DescribePublisherInput, optFns ...func(*Options)) (*DescribePublisherOutput, error) { if params == nil { params = &DescribePublisherInput{} @@ -35,9 +43,11 @@ 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_DescribeResourceScan.go b/service/cloudformation/api_op_DescribeResourceScan.go index 41d91e58b16..5ad49ecb4ca 100644 --- a/service/cloudformation/api_op_DescribeResourceScan.go +++ b/service/cloudformation/api_op_DescribeResourceScan.go @@ -58,8 +58,10 @@ type DescribeResourceScanOutput struct { ResourceTypes []string // The number of resources that were read. This is only available for scans with a - // Status set to COMPLETE , EXPIRED , or FAILED . This field may be 0 if the - // resource scan failed with a ResourceScanLimitExceededException . + // Status set to COMPLETE , EXPIRED , or FAILED . + // + // This field may be 0 if the resource scan failed with a + // ResourceScanLimitExceededException . ResourcesRead *int32 // The number of resources that were listed. This is only available for scans with @@ -69,8 +71,14 @@ type DescribeResourceScanOutput struct { // The time that the resource scan was started. StartTime *time.Time - // Status of the resource scan. INPROGRESS The resource scan is still in progress. - // COMPLETE The resource scan is complete. EXPIRED The resource scan has expired. + // Status of the resource scan. + // + // INPROGRESS The resource scan is still in progress. + // + // COMPLETE The resource scan is complete. + // + // EXPIRED The resource scan has expired. + // // FAILED The resource scan has failed. Status types.ResourceScanStatus diff --git a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go index cd3926b11b2..f462d55d4c8 100644 --- a/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go +++ b/service/cloudformation/api_op_DescribeStackDriftDetectionStatus.go @@ -17,13 +17,14 @@ import ( // has drifted, from its expected configuration, as defined in the stack template // 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. -// DetectStackDrift returns a StackDriftDetectionId you can use to monitor 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. +// stack and resource drift, see [Detecting Unregulated Configuration Changes to Stacks and Resources]. +// +// 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 drift detection operation has +// completed, use DescribeStackResourceDriftsto return drift information about the stack and its resources. +// +// [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html func (c *Client) DescribeStackDriftDetectionStatus(ctx context.Context, params *DescribeStackDriftDetectionStatusInput, optFns ...func(*Options)) (*DescribeStackDriftDetectionStatusOutput, error) { if params == nil { params = &DescribeStackDriftDetectionStatusInput{} @@ -41,10 +42,11 @@ func (c *Client) DescribeStackDriftDetectionStatus(ctx context.Context, params * type DescribeStackDriftDetectionStatusInput struct { - // The ID of the drift detection results of this operation. CloudFormation - // generates new results, with a new drift detection ID, each time this operation - // is run. However, the number of drift results CloudFormation retains for any - // given stack, and for how long, may vary. + // The ID of the drift detection results of this operation. + // + // CloudFormation generates new results, with a new drift detection ID, each time + // this operation is run. However, the number of drift results CloudFormation + // retains for any given stack, and for how long, may vary. // // This member is required. StackDriftDetectionId *string @@ -55,25 +57,30 @@ 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. + // (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 - // The ID of the drift detection results of this operation. CloudFormation - // generates new results, with a new drift detection ID, each time this operation - // is run. However, the number of reports CloudFormation retains for any given - // stack, and for how long, may vary. + // The ID of the drift detection results of this operation. + // + // CloudFormation generates new results, with a new drift detection ID, each time + // this operation is run. However, the number of reports CloudFormation retains for + // any given stack, and for how long, may vary. // // This member is required. StackDriftDetectionId *string @@ -98,13 +105,17 @@ type DescribeStackDriftDetectionStatusOutput struct { // 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. StackDriftStatus types.StackDriftStatus diff --git a/service/cloudformation/api_op_DescribeStackEvents.go b/service/cloudformation/api_op_DescribeStackEvents.go index 9501cc66e04..7f5f7b7aff6 100644 --- a/service/cloudformation/api_op_DescribeStackEvents.go +++ b/service/cloudformation/api_op_DescribeStackEvents.go @@ -12,11 +12,13 @@ import ( ) // Returns all stack related events for a specified stack in reverse chronological -// order. For more information about a stack's event history, see CloudFormation -// stack creation events (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.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). +// order. For more information about a stack's event history, see [CloudFormation stack creation events]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). +// +// [CloudFormation stack creation events]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html func (c *Client) DescribeStackEvents(ctx context.Context, params *DescribeStackEventsInput, optFns ...func(*Options)) (*DescribeStackEventsOutput, error) { if params == nil { params = &DescribeStackEventsInput{} @@ -40,9 +42,12 @@ 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. + // // Default: There is no default value. StackName *string diff --git a/service/cloudformation/api_op_DescribeStackInstance.go b/service/cloudformation/api_op_DescribeStackInstance.go index 5d1d4b81f23..d864c0e2467 100644 --- a/service/cloudformation/api_op_DescribeStackInstance.go +++ b/service/cloudformation/api_op_DescribeStackInstance.go @@ -12,8 +12,10 @@ import ( ) // Returns the stack instance that's associated with the specified StackSet, -// Amazon Web Services account, and Amazon Web Services Region. For a list of stack -// instances that are associated with a specific StackSet, use ListStackInstances . +// Amazon Web Services account, and Amazon Web Services Region. +// +// For a list of stack instances that are associated with a specific StackSet, use ListStackInstances +// . func (c *Client) DescribeStackInstance(ctx context.Context, params *DescribeStackInstanceInput, optFns ...func(*Options)) (*DescribeStackInstanceOutput, error) { if params == nil { params = &DescribeStackInstanceInput{} @@ -50,14 +52,21 @@ type DescribeStackInstanceInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStackResource.go b/service/cloudformation/api_op_DescribeStackResource.go index 1654f9c2c02..a1cd7fa37ab 100644 --- a/service/cloudformation/api_op_DescribeStackResource.go +++ b/service/cloudformation/api_op_DescribeStackResource.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a description of the specified resource in the specified stack. For -// deleted stacks, DescribeStackResource returns resource information for up to 90 -// days after the stack has been deleted. +// Returns a description of the specified resource in the specified stack. +// +// For deleted stacks, DescribeStackResource returns resource information for up +// to 90 days after the stack has been deleted. func (c *Client) DescribeStackResource(ctx context.Context, params *DescribeStackResourceInput, optFns ...func(*Options)) (*DescribeStackResourceOutput, error) { if params == nil { params = &DescribeStackResourceInput{} @@ -32,17 +33,21 @@ 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. + // // 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 c46982539a8..18da90dfd23 100644 --- a/service/cloudformation/api_op_DescribeStackResourceDrifts.go +++ b/service/cloudformation/api_op_DescribeStackResourceDrifts.go @@ -13,14 +13,18 @@ import ( // Returns drift information for the resources that have been checked for drift in // the specified stack. This includes actual and expected configuration values for -// resources where CloudFormation detects configuration drift. For a given stack, -// there will be one StackResourceDrift for each stack resource that has been -// 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 -// DetectStackDrift to detect drift on all supported resources for a given stack. +// resources where CloudFormation detects configuration drift. +// +// For a given stack, there will be one StackResourceDrift for each stack resource +// that has been 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]. +// +// Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all +// supported resources for a given stack. +// +// [Resources that Support Drift Detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html func (c *Client) DescribeStackResourceDrifts(ctx context.Context, params *DescribeStackResourceDriftsInput, optFns ...func(*Options)) (*DescribeStackResourceDriftsOutput, error) { if params == nil { params = &DescribeStackResourceDriftsInput{} @@ -54,12 +58,16 @@ 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. StackResourceDriftStatusFilters []types.StackResourceDriftStatus @@ -70,13 +78,15 @@ type DescribeStackResourceDriftsOutput struct { // Drift information for the resources that have been checked for drift in the // specified stack. This includes actual and expected configuration values for - // resources where CloudFormation detects drift. For a given stack, there will be - // one StackResourceDrift for each stack resource that has been checked for drift. - // 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) - // . + // resources where CloudFormation detects drift. + // + // For a given stack, there will be one StackResourceDrift for each stack resource + // that has been checked for drift. 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]. + // + // [Resources 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 diff --git a/service/cloudformation/api_op_DescribeStackResources.go b/service/cloudformation/api_op_DescribeStackResources.go index e74b00c12e5..51ab1101b38 100644 --- a/service/cloudformation/api_op_DescribeStackResources.go +++ b/service/cloudformation/api_op_DescribeStackResources.go @@ -14,16 +14,23 @@ 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 -// 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 +// 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]. +// +// A ValidationError is returned if you specify both StackName and // PhysicalResourceId in the same request. +// +// [CloudFormation User Guide]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ func (c *Client) DescribeStackResources(ctx context.Context, params *DescribeStackResourcesInput, optFns ...func(*Options)) (*DescribeStackResourcesOutput, error) { if params == nil { params = &DescribeStackResourcesInput{} @@ -42,26 +49,37 @@ 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 - // 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. + // resource supported by CloudFormation. + // + // For example, for an Amazon Elastic Compute 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. 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 . + // + // 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 061d7c982e4..9862162141b 100644 --- a/service/cloudformation/api_op_DescribeStackSet.go +++ b/service/cloudformation/api_op_DescribeStackSet.go @@ -36,14 +36,21 @@ type DescribeStackSetInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStackSetOperation.go b/service/cloudformation/api_op_DescribeStackSetOperation.go index e436bfbdd78..4c9ff3521b8 100644 --- a/service/cloudformation/api_op_DescribeStackSetOperation.go +++ b/service/cloudformation/api_op_DescribeStackSetOperation.go @@ -41,14 +41,21 @@ type DescribeStackSetOperationInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_DescribeStacks.go b/service/cloudformation/api_op_DescribeStacks.go index 0225a3e17e3..df79c1a0a2d 100644 --- a/service/cloudformation/api_op_DescribeStacks.go +++ b/service/cloudformation/api_op_DescribeStacks.go @@ -19,10 +19,11 @@ import ( // Returns the description for the specified stack; if no stack name was // specified, then it returns the description for all the stacks created. For more -// information about a stack's event history, see CloudFormation stack creation -// events (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) -// in the CloudFormation User Guide. If the stack doesn't exist, a ValidationError -// is returned. +// information about a stack's event history, see [CloudFormation stack creation events]in the CloudFormation User Guide. +// +// If the stack doesn't exist, a ValidationError is returned. +// +// [CloudFormation stack creation events]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error) { if params == nil { params = &DescribeStacksInput{} @@ -46,17 +47,26 @@ type DescribeStacksInput struct { // If you don't pass a parameter to StackName , the API returns a response that // describes all resources in the account, which can impact performance. This - // requires ListStacks and DescribeStacks permissions. Consider using the - // ListStacks API if you're not passing a parameter to StackName . The IAM policy - // below can be added to IAM policies when you want to limit resource-level - // permissions and avoid returning a response when no parameter is sent in the - // request: { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": + // requires ListStacks and DescribeStacks permissions. + // + // Consider using the ListStacks API if you're not passing a parameter to StackName . + // + // The IAM policy below can be added to IAM policies when you want to limit + // resource-level permissions and avoid returning a response when no parameter is + // sent in the request: + // + // { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": // "cloudformation:DescribeStacks", "NotResource": - // "arn:aws:cloudformation:*:*:stack/*/*" }] } The name or the unique stack ID - // that's associated with the stack, which aren't always interchangeable: + // "arn:aws:cloudformation:*:*:stack/*/*" }] } + // + // 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. + // // Default: There is no default value. StackName *string @@ -267,12 +277,13 @@ type StackCreateCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStacksInput, *DescribeStacksOutput, error) (bool, error) } @@ -844,12 +855,13 @@ type StackDeleteCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStacksInput, *DescribeStacksOutput, error) (bool, error) } @@ -1211,12 +1223,13 @@ type StackExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStacksInput, *DescribeStacksOutput, error) (bool, error) } @@ -1383,12 +1396,13 @@ type StackImportCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStacksInput, *DescribeStacksOutput, error) (bool, error) } @@ -1704,12 +1718,13 @@ type StackRollbackCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStacksInput, *DescribeStacksOutput, error) (bool, error) } @@ -1977,12 +1992,13 @@ type StackUpdateCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStacksInput, *DescribeStacksOutput, error) (bool, error) } diff --git a/service/cloudformation/api_op_DescribeType.go b/service/cloudformation/api_op_DescribeType.go index 5c2b367be91..b776955c6e3 100644 --- a/service/cloudformation/api_op_DescribeType.go +++ b/service/cloudformation/api_op_DescribeType.go @@ -12,10 +12,11 @@ import ( "time" ) -// 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. +// 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) { if params == nil { params = &DescribeTypeInput{} @@ -33,30 +34,36 @@ 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 . + // The Amazon Resource Name (ARN) of the extension. + // + // Conditional: You must specify either TypeName and Type , or Arn . Arn *string // The version number of a public third-party extension. PublicVersionNumber *string - // The publisher ID of the extension publisher. Extensions provided by Amazon Web - // Services are not assigned a publisher ID. + // The publisher ID of the extension publisher. + // + // Extensions provided by Amazon Web 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 . + // The name of the extension. + // + // Conditional: You must specify either TypeName and 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 - // about that specific extension version. Otherwise, it returns information about - // the default extension version. + // 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 noSmithyDocumentSerde @@ -70,31 +77,44 @@ type DescribeTypeOutput struct { // Whether CloudFormation automatically updates 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. For more - // information, see Activating public extensions for use in your account (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable) - // in the CloudFormation User Guide. + // information, see [Activating public extensions for use in your account]in the CloudFormation User Guide. + // + // [Activating public extensions for use in your account]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable 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-private.html#registry-set-configuration) + // in this account and Region. + // + // To set the configuration data for an extension, use [SetTypeConfiguration]. For more information, see [Configuring extensions at the account level] // in the CloudFormation User Guide. + // + // [SetTypeConfiguration]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html + // [Configuring extensions at the account level]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration 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 . + // 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]. + // + // To set the default version of an extension, use SetTypeDefaultVersion. + // + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html DefaultVersionId *string - // The deprecation status of the extension version. Valid values include: + // 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 . DeprecatedStatus types.DeprecatedStatus @@ -106,44 +126,56 @@ 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]. + // + // If the registered extension calls any Amazon Web Services APIs, you must create + // an [IAM execution role]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. + // + // [IAM execution role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html 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 . + // 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 . 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 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 . 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) - // . + // information, see [RegisterType]. + // // - 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) - // . + // specified. For more information, see [ActivateType]. + // + // [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.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 . + // 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 . 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]. + // + // [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 @@ -151,47 +183,62 @@ type DescribeTypeOutput struct { OriginalTypeArn *string // For public extensions that have been activated for this account and Region, the - // type name of the public extension. If you specified a TypeNameAlias when - // 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) - // in the CloudFormation User Guide. + // type name of the public extension. + // + // If you specified a TypeNameAlias when 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]in the CloudFormation User Guide. + // + // [Specifying aliases to refer to extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias OriginalTypeName *string // For resource type extensions, 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: + // 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 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 . + // 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 . 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 . + // 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 . PublisherId *string // For extensions that are modules, the public third-party extensions that must be // activated in your account in order for the module itself to be activated. 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) - // in the CloudFormation CLI User Guide. + // The schema that defines the extension. + // + // For more information about extension schemas, see [Resource Provider Schema] in the CloudFormation CLI + // User Guide. + // + // [Resource Provider Schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html Schema *string // The URL of the source code for the extension. @@ -204,37 +251,54 @@ type DescribeTypeOutput struct { // The kind of extension. Type types.RegistryType - // 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) - // . + // 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]. + // + // [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. - // 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. + // 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]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. + // + // [Publishing extensions to make them available for public use]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html 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 - // registered private extension versions. CloudFormation doesn't return this - // information for public extensions, whether they are activated in your account. + // 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: + // 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. Visibility types.Visibility diff --git a/service/cloudformation/api_op_DescribeTypeRegistration.go b/service/cloudformation/api_op_DescribeTypeRegistration.go index a77bab2eefb..0b8b469d150 100644 --- a/service/cloudformation/api_op_DescribeTypeRegistration.go +++ b/service/cloudformation/api_op_DescribeTypeRegistration.go @@ -16,11 +16,13 @@ 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. +// 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. func (c *Client) DescribeTypeRegistration(ctx context.Context, params *DescribeTypeRegistrationInput, optFns ...func(*Options)) (*DescribeTypeRegistrationOutput, error) { if params == nil { params = &DescribeTypeRegistrationInput{} @@ -38,9 +40,10 @@ func (c *Client) DescribeTypeRegistration(ctx context.Context, params *DescribeT type DescribeTypeRegistrationInput struct { - // The identifier for this registration request. This registration token is - // generated by CloudFormation when you initiate a registration request using - // RegisterType . + // The identifier for this registration request. + // + // This registration token is generated by CloudFormation when you initiate a + // registration request using RegisterType. // // This member is required. RegistrationToken *string @@ -56,14 +59,17 @@ type DescribeTypeRegistrationOutput struct { // The current status of the extension registration request. 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 . + // The Amazon Resource Name (ARN) of the extension being registered. + // + // For 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 . + // registered. + // + // For registration requests with a ProgressStatus of other than COMPLETE , this + // will be null . TypeVersionArn *string // Metadata pertaining to the operation's result. @@ -193,12 +199,13 @@ type TypeRegistrationCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTypeRegistrationInput, *DescribeTypeRegistrationOutput, error) (bool, error) } diff --git a/service/cloudformation/api_op_DetectStackDrift.go b/service/cloudformation/api_op_DetectStackDrift.go index 4873111f94f..874dda866d7 100644 --- a/service/cloudformation/api_op_DetectStackDrift.go +++ b/service/cloudformation/api_op_DetectStackDrift.go @@ -17,19 +17,24 @@ import ( // resource with its expected template configuration. Only resource properties // 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 -// 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 -// 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 -// information about the stack and its resources. When detecting drift on a stack, -// CloudFormation doesn't detect drift on any nested stacks belonging to that -// stack. Perform DetectStackDrift directly on the nested stack itself. +// expected template configurations. For more information, see [Detecting Unregulated Configuration Changes to Stacks and Resources]. +// +// Use DetectStackDrift to detect drift on all supported resources for a given +// stack, or DetectStackResourceDriftto detect drift on individual resources. +// +// For a list of stack resources that currently support drift detection, see [Resources that Support Drift Detection]. +// +// DetectStackDrift can take up to several minutes, depending on the number of +// resources contained within the stack. Use DescribeStackDriftDetectionStatusto monitor the progress of a detect +// stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDriftsto +// return drift information about the stack and its resources. +// +// When detecting drift on a stack, CloudFormation doesn't detect drift on any +// nested stacks belonging to that stack. Perform DetectStackDrift directly on the +// nested stack itself. +// +// [Resources that Support Drift Detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html +// [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html func (c *Client) DetectStackDrift(ctx context.Context, params *DetectStackDriftInput, optFns ...func(*Options)) (*DetectStackDriftOutput, error) { if params == nil { params = &DetectStackDriftInput{} @@ -60,10 +65,11 @@ type DetectStackDriftInput struct { type DetectStackDriftOutput struct { - // The ID of the drift detection results of this operation. CloudFormation - // generates new results, with a new drift detection ID, each time this operation - // is run. However, the number of drift results CloudFormation retains for any - // given stack, and for how long, may vary. + // The ID of the drift detection results of this operation. + // + // CloudFormation generates new results, with a new drift detection ID, each time + // this operation is run. However, the number of drift results CloudFormation + // retains for any given stack, and for how long, may vary. // // This member is required. StackDriftDetectionId *string diff --git a/service/cloudformation/api_op_DetectStackResourceDrift.go b/service/cloudformation/api_op_DetectStackResourceDrift.go index ac2a4927824..8b9a4a34ee5 100644 --- a/service/cloudformation/api_op_DetectStackResourceDrift.go +++ b/service/cloudformation/api_op_DetectStackResourceDrift.go @@ -16,14 +16,17 @@ import ( // and any values specified as template parameters. This information includes // 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 -// 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) +// are checked for drift. For more information about stack and resource drift, see [Detecting Unregulated Configuration Changes to Stacks and Resources] // . +// +// 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]. +// +// [Resources that Support Drift Detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html +// [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.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 c4a0e3abef4..e55c1e24fef 100644 --- a/service/cloudformation/api_op_DetectStackSetDrift.go +++ b/service/cloudformation/api_op_DetectStackSetDrift.go @@ -13,29 +13,37 @@ 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 -// 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: -// - 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. +// instance in the stack set. For more information, see [How CloudFormation performs drift detection on a stack set]. +// +// DetectStackSetDrift returns the OperationId of the stack set drift detection +// operation. Use this operation id with DescribeStackSetOperationto 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: +// +// - Use DescribeStackSetto 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 ListStackInstancesto return a list of stack instances belonging to the stack set, +// including the drift status and last drift time checked of each instance. +// +// - Use DescribeStackInstanceto 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 . +// set, see [Detecting unmanaged changes in stack sets]. +// +// 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. +// +// [Detecting unmanaged changes in stack sets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html +// [How CloudFormation performs drift detection on a stack set]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html func (c *Client) DetectStackSetDrift(ctx context.Context, params *DetectStackSetDriftInput, optFns ...func(*Options)) (*DetectStackSetDriftOutput, error) { if params == nil { params = &DetectStackSetDriftInput{} @@ -60,23 +68,33 @@ type DetectStackSetDriftInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs - // The ID of the stack set operation. + // The ID of the stack set operation. OperationId *string // 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) - // . + // operation. + // + // For more information about maximum concurrent accounts and failure tolerance, + // see [Stack set operation options]. + // + // [Stack set operation options]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options OperationPreferences *types.StackSetOperationPreferences noSmithyDocumentSerde @@ -84,8 +102,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 + // 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 diff --git a/service/cloudformation/api_op_EstimateTemplateCost.go b/service/cloudformation/api_op_EstimateTemplateCost.go index 704af514706..36042068518 100644 --- a/service/cloudformation/api_op_EstimateTemplateCost.go +++ b/service/cloudformation/api_op_EstimateTemplateCost.go @@ -36,17 +36,24 @@ 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) - // in the CloudFormation User Guide.) Conditional: You must pass TemplateBody or - // TemplateURL . If both are passed, only TemplateBody is used. + // maximum length of 51,200 bytes. (For more information, go to [Template Anatomy]in the + // CloudFormation User Guide.) + // + // Conditional: You must pass TemplateBody or TemplateURL . If both are passed, + // only TemplateBody is used. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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) - // in the CloudFormation User Guide. The location for an Amazon S3 bucket must - // start with https:// . Conditional: You must pass TemplateURL or TemplateBody . - // If both are passed, only TemplateBody is used. + // information, go to [Template Anatomy]in the CloudFormation User Guide. The location for an Amazon + // S3 bucket must start with https:// . + // + // Conditional: You must pass TemplateURL or TemplateBody . If both are passed, + // only TemplateBody is used. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateURL *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ExecuteChangeSet.go b/service/cloudformation/api_op_ExecuteChangeSet.go index b2b3d9ce5f3..615a06f75c9 100644 --- a/service/cloudformation/api_op_ExecuteChangeSet.go +++ b/service/cloudformation/api_op_ExecuteChangeSet.go @@ -12,13 +12,18 @@ import ( // 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 . +// CloudFormation starts updating the stack. Use the DescribeStacksaction 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{} @@ -52,20 +57,24 @@ type ExecuteChangeSetInput struct { // Preserves the state of previously provisioned resources when an operation // fails. This parameter can't be specified when the OnStackFailure parameter to - // the CreateChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) - // API operation was specified. + // the [CreateChangeSet]API operation was specified. + // // - True - if the stack creation fails, do nothing. This is equivalent to - // specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) - // API operation. + // specifying DO_NOTHING for the OnStackFailure parameter to the [CreateChangeSet]API operation. + // // - False - if the stack creation fails, roll back the stack. This is equivalent - // to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) - // API operation. + // to specifying ROLLBACK for the OnStackFailure parameter to the [CreateChangeSet]API operation. + // // Default: True + // + // [CreateChangeSet]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html DisableRollback *bool // When set to true , newly created resources are deleted when the operation rolls // back. This includes newly created resources marked with a deletion policy of - // Retain . Default: false + // Retain . + // + // Default: false RetainExceptOnCreate *bool // If you specified the name of a change set, specify the stack name or Amazon diff --git a/service/cloudformation/api_op_GetGeneratedTemplate.go b/service/cloudformation/api_op_GetGeneratedTemplate.go index e2a79559d17..9f9670c90c7 100644 --- a/service/cloudformation/api_op_GetGeneratedTemplate.go +++ b/service/cloudformation/api_op_GetGeneratedTemplate.go @@ -43,7 +43,9 @@ type GetGeneratedTemplateInput struct { // The language to use to retrieve for the generated template. Supported values // are: + // // - JSON + // // - YAML Format types.TemplateFormat @@ -53,13 +55,21 @@ type GetGeneratedTemplateInput struct { type GetGeneratedTemplateOutput struct { // The status of the template generation. Supported values are: + // // - CreatePending - the creation of the template is pending. + // // - CreateInProgress - the creation of the template is in progress. + // // - DeletePending - the deletion of the template is pending. + // // - DeleteInProgress - the deletion of the template is in progress. + // // - UpdatePending - the update of the template is pending. + // // - UpdateInProgress - the update of the template is in progress. + // // - Failed - the template operation failed. + // // - Complete - the template operation is complete. Status types.GeneratedTemplateStatus diff --git a/service/cloudformation/api_op_GetStackPolicy.go b/service/cloudformation/api_op_GetStackPolicy.go index 9f53448d923..e9af500ada8 100644 --- a/service/cloudformation/api_op_GetStackPolicy.go +++ b/service/cloudformation/api_op_GetStackPolicy.go @@ -42,9 +42,10 @@ type GetStackPolicyInput struct { // The output for the GetStackPolicy action. 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) - // in the CloudFormation User Guide.) + // Structure containing the stack policy body. (For more information, go to [Prevent Updates to Stack Resources] in + // the CloudFormation User Guide.) + // + // [Prevent Updates to Stack Resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html StackPolicyBody *string // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_GetTemplate.go b/service/cloudformation/api_op_GetTemplate.go index b5fc63332f9..aa35bd74ede 100644 --- a/service/cloudformation/api_op_GetTemplate.go +++ b/service/cloudformation/api_op_GetTemplate.go @@ -12,9 +12,12 @@ import ( ) // Returns the template body for a specified stack. You can get the template for -// running or deleted stacks. For deleted stacks, GetTemplate returns the template -// for up to 90 days after the stack has been deleted. If the template doesn't -// exist, a ValidationError is returned. +// running or deleted stacks. +// +// For deleted stacks, GetTemplate returns the template for up to 90 days after +// the stack has been deleted. +// +// If the template doesn't exist, a ValidationError is returned. func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error) { if params == nil { params = &GetTemplateInput{} @@ -40,17 +43,22 @@ type GetTemplateInput 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. + // // 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 . + // Processed . + // + // If the template doesn't include transforms, Original and Processed return the + // same template. By default, CloudFormation specifies Processed . TemplateStage types.TemplateStage noSmithyDocumentSerde @@ -65,10 +73,13 @@ type GetTemplateOutput struct { // 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) - // in the CloudFormation User Guide.) CloudFormation returns the same template that - // was used when the stack was created. + // Structure containing the template body. (For more information, go to [Template Anatomy] in the + // CloudFormation User Guide.) + // + // CloudFormation returns the same template that was used when the stack was + // created. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateBody *string // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_GetTemplateSummary.go b/service/cloudformation/api_op_GetTemplateSummary.go index 481256fd379..c12d5bc504e 100644 --- a/service/cloudformation/api_op_GetTemplateSummary.go +++ b/service/cloudformation/api_op_GetTemplateSummary.go @@ -14,10 +14,12 @@ 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 +// 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 { @@ -39,33 +41,45 @@ type GetTemplateSummaryInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html 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 . 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 . 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) - // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: StackName , StackSetName , TemplateBody , or TemplateURL . + // maximum length of 51,200 bytes. For more information about templates, see [Template anatomy]in + // the CloudFormation User Guide. + // + // Conditional: You must specify only one of the following parameters: StackName , + // StackSetName , TemplateBody , or TemplateURL . + // + // [Template anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateBody *string // Specifies options for the GetTemplateSummary API action. @@ -73,10 +87,14 @@ type GetTemplateSummaryInput struct { // 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) - // in the CloudFormation User Guide. The location for an Amazon S3 bucket must - // start with https:// . Conditional: You must specify only one of the following - // parameters: StackName , StackSetName , TemplateBody , or TemplateURL . + // Manager document. For more information about templates, see [Template anatomy]in the + // CloudFormation User Guide. The location for an Amazon S3 bucket must start with + // https:// . + // + // Conditional: You must specify only one of the following parameters: StackName , + // StackSetName , TemplateBody , or TemplateURL . + // + // [Template anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateURL *string noSmithyDocumentSerde @@ -87,11 +105,12 @@ 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) - // . + // for this parameter when you use the CreateStackor UpdateStack actions with your template; otherwise, + // those actions return an InsufficientCapabilities error. + // + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates]. + // + // [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/api_op_ImportStacksToStackSet.go b/service/cloudformation/api_op_ImportStacksToStackSet.go index fa536d53610..4f53835796e 100644 --- a/service/cloudformation/api_op_ImportStacksToStackSet.go +++ b/service/cloudformation/api_op_ImportStacksToStackSet.go @@ -40,7 +40,9 @@ 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 . CallAs types.CallAs @@ -48,9 +50,12 @@ type ImportStacksToStackSetInput struct { OperationId *string // 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) - // . + // operation. + // + // For more information about maximum concurrent accounts and failure tolerance, + // see [Stack set operation options]. + // + // [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 @@ -58,11 +63,14 @@ 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 . + // The Amazon S3 URL which contains list of stack ids to be inputted. + // + // Specify either StackIds or StackIdsUrl . StackIdsUrl *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ListChangeSets.go b/service/cloudformation/api_op_ListChangeSets.go index b8322316e09..9e81c79c523 100644 --- a/service/cloudformation/api_op_ListChangeSets.go +++ b/service/cloudformation/api_op_ListChangeSets.go @@ -38,8 +38,8 @@ type ListChangeSetsInput struct { // This member is required. StackName *string - // A string (provided by the ListChangeSets response output) that identifies the - // next page of change sets that you want to retrieve. + // A string (provided by the ListChangeSets response output) that identifies the next page of + // change sets that you want to retrieve. NextToken *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ListExports.go b/service/cloudformation/api_op_ListExports.go index e843588ade6..3c7f0355eb9 100644 --- a/service/cloudformation/api_op_ListExports.go +++ b/service/cloudformation/api_op_ListExports.go @@ -13,9 +13,12 @@ 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]function. +// +// For more information, see [CloudFormation export stack output values]. +// +// [CloudFormation export stack output values]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html +// [Fn::ImportValue]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html func (c *Client) ListExports(ctx context.Context, params *ListExportsInput, optFns ...func(*Options)) (*ListExportsOutput, error) { if params == nil { params = &ListExportsInput{} @@ -33,8 +36,8 @@ func (c *Client) ListExports(ctx context.Context, params *ListExportsInput, optF type ListExportsInput struct { - // A string (provided by the ListExports response output) that identifies the next - // page of exported output values that you asked to retrieve. + // A string (provided by the ListExports response output) that identifies the next page of + // exported output values that you asked to retrieve. NextToken *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ListGeneratedTemplates.go b/service/cloudformation/api_op_ListGeneratedTemplates.go index be26c4567cf..d40b5403452 100644 --- a/service/cloudformation/api_op_ListGeneratedTemplates.go +++ b/service/cloudformation/api_op_ListGeneratedTemplates.go @@ -29,7 +29,7 @@ func (c *Client) ListGeneratedTemplates(ctx context.Context, params *ListGenerat type ListGeneratedTemplatesInput struct { - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. By default the ListGeneratedTemplates API action will return at // most 50 results in each response. The maximum value is 100. @@ -145,7 +145,7 @@ var _ ListGeneratedTemplatesAPIClient = (*Client)(nil) // ListGeneratedTemplatesPaginatorOptions is the paginator options for // ListGeneratedTemplates type ListGeneratedTemplatesPaginatorOptions struct { - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. By default the ListGeneratedTemplates API action will return at // most 50 results in each response. The maximum value is 100. diff --git a/service/cloudformation/api_op_ListImports.go b/service/cloudformation/api_op_ListImports.go index 7a89f210f2a..bfcc5445fc2 100644 --- a/service/cloudformation/api_op_ListImports.go +++ b/service/cloudformation/api_op_ListImports.go @@ -12,10 +12,12 @@ 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 . -// 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) +// 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] // function. +// +// [Fn::ImportValue]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error) { if params == nil { params = &ListImportsInput{} @@ -39,8 +41,8 @@ type ListImportsInput struct { // This member is required. ExportName *string - // A string (provided by the ListImports response output) that identifies the next - // page of stacks that are importing the specified exported output value. + // A string (provided by the ListImports response output) that identifies the next page of + // stacks that are importing the specified exported output value. NextToken *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_ListResourceScanRelatedResources.go b/service/cloudformation/api_op_ListResourceScanRelatedResources.go index 811e7f4abb7..4f8b6ff0ba6 100644 --- a/service/cloudformation/api_op_ListResourceScanRelatedResources.go +++ b/service/cloudformation/api_op_ListResourceScanRelatedResources.go @@ -42,7 +42,7 @@ type ListResourceScanRelatedResourcesInput struct { // This member is required. Resources []types.ScannedResourceIdentifier - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. By default the ListResourceScanRelatedResources API action will // return up to 100 results in each response. The maximum value is 100. @@ -163,7 +163,7 @@ var _ ListResourceScanRelatedResourcesAPIClient = (*Client)(nil) // ListResourceScanRelatedResourcesPaginatorOptions is the paginator options for // ListResourceScanRelatedResources type ListResourceScanRelatedResourcesPaginatorOptions struct { - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. By default the ListResourceScanRelatedResources API action will // return up to 100 results in each response. The maximum value is 100. diff --git a/service/cloudformation/api_op_ListResourceScanResources.go b/service/cloudformation/api_op_ListResourceScanResources.go index f013da5c9c4..9e9145161db 100644 --- a/service/cloudformation/api_op_ListResourceScanResources.go +++ b/service/cloudformation/api_op_ListResourceScanResources.go @@ -37,7 +37,7 @@ type ListResourceScanResourcesInput struct { // This member is required. ResourceScanId *string - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. By default the ListResourceScanResources API action will return // at most 100 results in each response. The maximum value is 100. @@ -172,7 +172,7 @@ var _ ListResourceScanResourcesAPIClient = (*Client)(nil) // ListResourceScanResourcesPaginatorOptions is the paginator options for // ListResourceScanResources type ListResourceScanResourcesPaginatorOptions struct { - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. By default the ListResourceScanResources API action will return // at most 100 results in each response. The maximum value is 100. diff --git a/service/cloudformation/api_op_ListResourceScans.go b/service/cloudformation/api_op_ListResourceScans.go index 4608bfa1184..3b9220f7f6a 100644 --- a/service/cloudformation/api_op_ListResourceScans.go +++ b/service/cloudformation/api_op_ListResourceScans.go @@ -30,7 +30,7 @@ func (c *Client) ListResourceScans(ctx context.Context, params *ListResourceScan type ListResourceScansInput struct { - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. The default value is 10. The maximum value is 100. MaxResults *int32 @@ -144,7 +144,7 @@ var _ ListResourceScansAPIClient = (*Client)(nil) // ListResourceScansPaginatorOptions is the paginator options for ListResourceScans type ListResourceScansPaginatorOptions struct { - // If the number of available results exceeds this maximum, the response includes + // If the number of available results exceeds this maximum, the response includes // a NextToken value that you can use for the NextToken parameter to get the next // set of results. The default value is 10. The maximum value is 100. Limit int32 diff --git a/service/cloudformation/api_op_ListStackInstanceResourceDrifts.go b/service/cloudformation/api_op_ListStackInstanceResourceDrifts.go index 9d7e0c46396..61157d1d277 100644 --- a/service/cloudformation/api_op_ListStackInstanceResourceDrifts.go +++ b/service/cloudformation/api_op_ListStackInstanceResourceDrifts.go @@ -12,6 +12,7 @@ import ( ) // Returns drift information for resources in a stack instance. +// // ListStackInstanceResourceDrifts returns drift information for the most recent // drift detection operation. If an operation is in progress, it may only return // partial results. @@ -56,14 +57,21 @@ type ListStackInstanceResourceDriftsInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // The maximum number of results to be returned with a single call. If the number @@ -80,12 +88,16 @@ type ListStackInstanceResourceDriftsInput struct { NextToken *string // The resource drift status of the stack instance. + // // - 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. StackInstanceResourceDriftStatuses []types.StackResourceDriftStatus diff --git a/service/cloudformation/api_op_ListStackInstances.go b/service/cloudformation/api_op_ListStackInstances.go index cf106ada81b..1cc9b1e68a5 100644 --- a/service/cloudformation/api_op_ListStackInstances.go +++ b/service/cloudformation/api_op_ListStackInstances.go @@ -40,14 +40,21 @@ type ListStackInstancesInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // The filter to apply to stack instances diff --git a/service/cloudformation/api_op_ListStackResources.go b/service/cloudformation/api_op_ListStackResources.go index 6fb22a8bc83..e16e0cd4821 100644 --- a/service/cloudformation/api_op_ListStackResources.go +++ b/service/cloudformation/api_op_ListStackResources.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns descriptions of all resources of the specified stack. For deleted -// stacks, ListStackResources returns resource information for up to 90 days after -// the stack has been deleted. +// Returns descriptions of all resources of the specified stack. +// +// For deleted stacks, ListStackResources returns resource information for up to +// 90 days after the stack has been deleted. func (c *Client) ListStackResources(ctx context.Context, params *ListStackResourcesInput, optFns ...func(*Options)) (*ListStackResourcesOutput, error) { if params == nil { params = &ListStackResourcesInput{} @@ -34,9 +35,12 @@ 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. + // // Default: There is no default value. // // This member is required. diff --git a/service/cloudformation/api_op_ListStackSetAutoDeploymentTargets.go b/service/cloudformation/api_op_ListStackSetAutoDeploymentTargets.go index 96512eb7b72..29532161ba8 100644 --- a/service/cloudformation/api_op_ListStackSetAutoDeploymentTargets.go +++ b/service/cloudformation/api_op_ListStackSetAutoDeploymentTargets.go @@ -37,14 +37,21 @@ type ListStackSetAutoDeploymentTargetsInput struct { // 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 StackSets with - // self-managed permissions. + // account. + // + // By default, SELF is specified. Use SELF for StackSets 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // The maximum number of results to be returned with a single call. If the number @@ -63,10 +70,11 @@ type ListStackSetAutoDeploymentTargetsInput struct { type ListStackSetAutoDeploymentTargetsOutput 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 - // ListStackSetAutoDeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html) - // again and use that value for the NextToken parameter. If the request returns - // all results, NextToken is set to an empty string. + // token. To retrieve the next set of results, call [ListStackSetAutoDeploymentTargets]again and use that value for + // the NextToken parameter. If the request returns all results, NextToken is set + // to an empty string. + // + // [ListStackSetAutoDeploymentTargets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html NextToken *string // An array of summaries of the deployment targets for the stack set. diff --git a/service/cloudformation/api_op_ListStackSetOperationResults.go b/service/cloudformation/api_op_ListStackSetOperationResults.go index ea14464348d..6b6761a0fab 100644 --- a/service/cloudformation/api_op_ListStackSetOperationResults.go +++ b/service/cloudformation/api_op_ListStackSetOperationResults.go @@ -42,14 +42,21 @@ type ListStackSetOperationResultsInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // The filter to apply to operation results. diff --git a/service/cloudformation/api_op_ListStackSetOperations.go b/service/cloudformation/api_op_ListStackSetOperations.go index a941c675886..c0948bafdb7 100644 --- a/service/cloudformation/api_op_ListStackSetOperations.go +++ b/service/cloudformation/api_op_ListStackSetOperations.go @@ -37,14 +37,21 @@ type ListStackSetOperationsInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // The maximum number of results to be returned with a single call. If the number diff --git a/service/cloudformation/api_op_ListStackSets.go b/service/cloudformation/api_op_ListStackSets.go index 1d988bfe1c7..6716cfbe8f5 100644 --- a/service/cloudformation/api_op_ListStackSets.go +++ b/service/cloudformation/api_op_ListStackSets.go @@ -12,12 +12,15 @@ import ( ) // 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. @@ -40,14 +43,21 @@ type ListStackSetsInput struct { // [Service-managed permissions] Specifies whether you are acting as an account // 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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // The maximum number of results to be returned with a single call. If the number diff --git a/service/cloudformation/api_op_ListTypeRegistrations.go b/service/cloudformation/api_op_ListTypeRegistrations.go index 2d7870ca0c1..aed97ba559f 100644 --- a/service/cloudformation/api_op_ListTypeRegistrations.go +++ b/service/cloudformation/api_op_ListTypeRegistrations.go @@ -42,20 +42,24 @@ type ListTypeRegistrationsInput struct { // response object's NextToken parameter is set to null . NextToken *string - // The current status of the extension registration request. The default is - // IN_PROGRESS . + // The current status of the extension registration request. + // + // The default is 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 . + // The Amazon Resource Name (ARN) of the extension. + // + // Conditional: You must specify either TypeName and Type , or Arn . TypeArn *string - // The name of the extension. Conditional: You must specify either TypeName and - // Type , or Arn . + // The name of the extension. + // + // Conditional: You must specify either TypeName and Type , or Arn . TypeName *string noSmithyDocumentSerde @@ -69,8 +73,9 @@ type ListTypeRegistrationsOutput struct { // all results, NextToken is set to null . NextToken *string - // A list of extension registration tokens. Use DescribeTypeRegistration to return - // detailed information about a type registration request. + // A list of extension registration tokens. + // + // Use DescribeTypeRegistration to return detailed information about a type registration request. RegistrationTokenList []string // Metadata pertaining to the operation's result. diff --git a/service/cloudformation/api_op_ListTypeVersions.go b/service/cloudformation/api_op_ListTypeVersions.go index 67c14955fd0..e3745531c6b 100644 --- a/service/cloudformation/api_op_ListTypeVersions.go +++ b/service/cloudformation/api_op_ListTypeVersions.go @@ -30,16 +30,22 @@ 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: + // 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 . DeprecatedStatus types.DeprecatedStatus @@ -56,15 +62,18 @@ type ListTypeVersionsInput struct { // previous response object's NextToken parameter is set to null . NextToken *string - // The publisher ID of the extension publisher. Extensions published by Amazon - // aren't assigned a publisher ID. + // The publisher ID of the extension publisher. + // + // Extensions published by Amazon aren't assigned a publisher ID. PublisherId *string - // The kind of the extension. Conditional: You must specify either TypeName and - // Type , or Arn . + // The kind of the extension. + // + // Conditional: You must specify either TypeName and 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 . TypeName *string diff --git a/service/cloudformation/api_op_ListTypes.go b/service/cloudformation/api_op_ListTypes.go index 6d7b64c31c3..50d6403fb17 100644 --- a/service/cloudformation/api_op_ListTypes.go +++ b/service/cloudformation/api_op_ListTypes.go @@ -31,16 +31,22 @@ 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: + // 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 - // be compatible with Visibility to return valid results. For example, specifying - // AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of - // types, but specifying PUBLIC for Visibility returns the desired list. + // Filter criteria to use in determining which extensions to return. + // + // Filters must be compatible with Visibility to return valid results. For + // example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns + // an empty list of types, but specifying PUBLIC for Visibility returns the + // desired list. Filters *types.TypeFilters // The maximum number of results to be returned with a single call. If the number @@ -58,14 +64,19 @@ type ListTypesInput struct { // 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: + // 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 . ProvisioningType types.ProvisioningType @@ -73,14 +84,21 @@ type ListTypesInput struct { Type types.RegistryType // The scope at which the extensions are visible and usable in CloudFormation - // operations. Valid values include: + // 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 . Visibility types.Visibility diff --git a/service/cloudformation/api_op_PublishType.go b/service/cloudformation/api_op_PublishType.go index 143cc2fed13..34091af1e89 100644 --- a/service/cloudformation/api_op_PublishType.go +++ b/service/cloudformation/api_op_PublishType.go @@ -13,12 +13,14 @@ 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) -// 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) -// . +// CloudFormation users. For more information about publishing extensions, see [Publishing extensions to make them available for public use]in +// the CloudFormation CLI User Guide. +// +// To publish an extension, you must be registered as a publisher with +// CloudFormation. For more information, see [RegisterPublisher]. +// +// [Publishing extensions to make them available for public use]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.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{} @@ -36,25 +38,37 @@ 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 . + // The Amazon Resource Name (ARN) of the extension. + // + // Conditional: You must specify 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, - // CloudFormation increments the version number by one minor version release. You - // cannot specify a version number the first time you publish a type. + // 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]. + // + // 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 . + // + // [Semantic Versioning 2.0.0]: https://semver.org/ 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 b3a99eb0bea..9b27dbf58fe 100644 --- a/service/cloudformation/api_op_RecordHandlerProgress.go +++ b/service/cloudformation/api_op_RecordHandlerProgress.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Reports progress of a resource handler to CloudFormation. +// +// Reserved for use by the [CloudFormation CLI]. Don't use this API in your code. +// +// [CloudFormation CLI]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html func (c *Client) RecordHandlerProgress(ctx context.Context, params *RecordHandlerProgressInput, optFns ...func(*Options)) (*RecordHandlerProgressOutput, error) { if params == nil { params = &RecordHandlerProgressInput{} @@ -31,36 +33,43 @@ 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]. + // + // [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]. + // + // [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]. + // + // [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]. + // + // [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]. + // + // [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]. + // + // [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]. + // + // [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 1369d97922e..f26dea44644 100644 --- a/service/cloudformation/api_op_RegisterPublisher.go +++ b/service/cloudformation/api_op_RegisterPublisher.go @@ -13,10 +13,12 @@ import ( // 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. +// Web Services Regions. +// +// For information about requirements for registering as a public extension +// publisher, see [Registering your account to publish CloudFormation extensions]in the CloudFormation CLI User Guide. +// +// [Registering your account to publish CloudFormation extensions]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs func (c *Client) RegisterPublisher(ctx context.Context, params *RegisterPublisherInput, optFns ...func(*Options)) (*RegisterPublisherOutput, error) { if params == nil { params = &RegisterPublisherInput{} @@ -34,16 +36,21 @@ 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) - // 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 . + // Whether you accept the [Terms and Conditions] 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 . + // + // [Terms and Conditions]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf 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) - // in the CloudFormation CLI User Guide. + // Amazon Resource Name (ARN) for your connection to that account. + // + // For more information, see [Registering your account to publish CloudFormation extensions] in the CloudFormation CLI User Guide. + // + // [Registering your account to publish CloudFormation extensions]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs ConnectionArn *string noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_RegisterType.go b/service/cloudformation/api_op_RegisterType.go index af3f4998c43..6d92a89d1ac 100644 --- a/service/cloudformation/api_op_RegisterType.go +++ b/service/cloudformation/api_op_RegisterType.go @@ -14,22 +14,31 @@ import ( // 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. // // 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html) -// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) +// registration, see [Creating Resource Providers]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-private.html#registry-set-configuration) -// in the CloudFormation User Guide. +// [Configuring extensions at the account level]in the CloudFormation User Guide. +// +// [SetTypeConfiguration]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html +// [Creating Resource Providers]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html +// [Configuring extensions at the account level]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration +// [DeregisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, optFns ...func(*Options)) (*RegisterTypeOutput, error) { if params == nil { params = &RegisterTypeInput{} @@ -48,31 +57,46 @@ func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, op 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) - // 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. + // 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]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]permissions for the schema handler + // package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3]in the Identity and Access Management User + // Guide. + // + // [submit]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html + // [Actions, Resources, and Condition Keys for Amazon S3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html + // [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html // // This member is required. SchemaHandlerPackage *string - // The name of the extension being registered. We suggest that extension names - // adhere to the following patterns: + // 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 // // This member is required. @@ -85,18 +109,23 @@ type RegisterTypeInput struct { 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 principal ( resources.cloudformation.amazonaws.com ). For - // more information about adding trust relationships, see Modifying a role trust - // policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-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. + // when invoking the extension. + // + // For CloudFormation to assume the specified execution role, the role must + // contain a trust relationship with the CloudFormation service principal ( + // 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]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. + // + // [IAM execution role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html + // [Modifying a role trust policy]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy ExecutionRoleArn *string // Specifies logging configuration information for an extension. @@ -110,9 +139,10 @@ 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. + // 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. 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 1874b291319..d29fcc5b262 100644 --- a/service/cloudformation/api_op_RollbackStack.go +++ b/service/cloudformation/api_op_RollbackStack.go @@ -12,15 +12,23 @@ import ( // 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 -// following stack statuses. +// the DescribeStacksoperation. +// +// 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 following stack statuses. +// // - 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 { @@ -49,7 +57,9 @@ type RollbackStackInput struct { // When set to true , newly created resources are deleted when the operation rolls // back. This includes newly created resources marked with a deletion policy of - // Retain . Default: false + // Retain . + // + // Default: false RetainExceptOnCreate *bool // The Amazon Resource Name (ARN) of an Identity and Access Management role that diff --git a/service/cloudformation/api_op_SetStackPolicy.go b/service/cloudformation/api_op_SetStackPolicy.go index c04c4910350..9b65f70c466 100644 --- a/service/cloudformation/api_op_SetStackPolicy.go +++ b/service/cloudformation/api_op_SetStackPolicy.go @@ -34,10 +34,11 @@ 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) - // in the CloudFormation User Guide. You can specify either the StackPolicyBody or - // the StackPolicyURL parameter, but not both. + // Structure containing the stack policy body. For more information, go to [Prevent updates to stack resources] in the + // CloudFormation User Guide. You can specify either the StackPolicyBody or the + // StackPolicyURL parameter, but not both. + // + // [Prevent updates to stack resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html StackPolicyBody *string // Location of a file containing the stack policy. The URL must point to a policy diff --git a/service/cloudformation/api_op_SetTypeConfiguration.go b/service/cloudformation/api_op_SetTypeConfiguration.go index 6f8e3c23c4a..a302a9a04d8 100644 --- a/service/cloudformation/api_op_SetTypeConfiguration.go +++ b/service/cloudformation/api_op_SetTypeConfiguration.go @@ -12,14 +12,19 @@ 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) -// . For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.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 -// references to specify template values (https://docs.aws.amazon.com/) in the +// 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] 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 references to specify template values]in the CloudFormation User Guide. +// +// [DescribeType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html +// [Using dynamic references to specify template values]: https://docs.aws.amazon.com/ +// [Configuring extensions at the account level]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration func (c *Client) SetTypeConfiguration(ctx context.Context, params *SetTypeConfigurationInput, optFns ...func(*Options)) (*SetTypeConfigurationOutput, error) { if params == nil { params = &SetTypeConfigurationInput{} @@ -37,37 +42,45 @@ func (c *Client) SetTypeConfiguration(ctx context.Context, params *SetTypeConfig 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 DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) - // . 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. + // 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 [DescribeType]. For more + // information, see [Defining account-level configuration data for an extension]in the CloudFormation CLI User Guide. + // + // [DescribeType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html + // [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 // // This member is required. Configuration *string - // An alias by which to refer to this extension configuration data. Conditional: - // Specifying a configuration alias is required when setting a configuration for a - // resource type extension. + // An alias by which to refer to this extension configuration data. + // + // Conditional: Specifying a configuration alias is required when setting a + // configuration for a 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 call the - // ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // API operation in this account and Region. For private extensions, this will be - // the ARN assigned when you call the RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) - // API operation 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. + // + // For public extensions, this will be the ARN assigned when you call the [ActivateType] API + // operation in this account and Region. For private extensions, this will be the + // ARN assigned when you call the [RegisterType]API operation 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. + // + // [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html 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 @@ -76,7 +89,9 @@ 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 2e504884bca..a4018be90e8 100644 --- a/service/cloudformation/api_op_SetTypeDefaultVersion.go +++ b/service/cloudformation/api_op_SetTypeDefaultVersion.go @@ -31,16 +31,19 @@ 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 . + // The name of the extension. + // + // Conditional: You must specify either TypeName and 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_StopStackSetOperation.go b/service/cloudformation/api_op_StopStackSetOperation.go index 9eca3b5bd01..121e370f54e 100644 --- a/service/cloudformation/api_op_StopStackSetOperation.go +++ b/service/cloudformation/api_op_StopStackSetOperation.go @@ -43,14 +43,21 @@ type StopStackSetOperationInput struct { // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_TestType.go b/service/cloudformation/api_op_TestType.go index bd5a838c84e..b132b4ca841 100644 --- a/service/cloudformation/api_op_TestType.go +++ b/service/cloudformation/api_op_TestType.go @@ -13,24 +13,32 @@ 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 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) -// . 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) -// in the CloudFormation CLI User Guide. +// For more information, see [Testing your public extension prior to publishing] 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] 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]in the CloudFormation CLI User Guide. +// +// [DescribeType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html +// [Testing your public extension prior to publishing]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing +// [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html +// [Publishing extensions to make them available for public use]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html func (c *Client) TestType(ctx context.Context, params *TestTypeInput, optFns ...func(*Options)) (*TestTypeOutput, error) { if params == nil { params = &TestTypeInput{} @@ -48,33 +56,45 @@ 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 . + // The Amazon Resource Name (ARN) of the extension. + // + // Conditional: You must specify 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: + // 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. + // + // For more information, see [Actions, Resources, and Condition Keys for Amazon S3] in the Amazon Web Services Identity and Access + // Management User Guide. + // + // [Actions, Resources, and Condition Keys for Amazon S3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html 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 68fccd3e365..85d6c6b3661 100644 --- a/service/cloudformation/api_op_UpdateStack.go +++ b/service/cloudformation/api_op_UpdateStack.go @@ -13,11 +13,14 @@ 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 DescribeStacksaction. +// +// 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]. +// +// [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{} @@ -43,68 +46,104 @@ type UpdateStackInput struct { // 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. + // + // - 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 (https://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 (https://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 (https://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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) - // . + // 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] + // + // [AWS::IAM::Group] + // + // [AWS::IAM::InstanceProfile] + // + // [AWS::IAM::Policy] + // + // [AWS::IAM::Role] + // + // [AWS::IAM::User] + // + // [AWS::IAM::UserToGroupAddition] + // + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates]. + // + // - 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]and [AWS::Serverless]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]. + // // Only one of the Capabilities and ResourceType parameters can be specified. + // + // [AWS::IAM::AccessKey]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html + // [AWS::Include]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html + // [AWS::IAM::User]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.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::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::UserToGroupAddition]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [Using CloudFormation Macros to Perform Custom Processing on Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html + // [AWS::Serverless]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html + // [Acknowledging IAM Resources in CloudFormation Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities 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 - // 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 . + // 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 . ClientRequestToken *string // Preserve the state of previously provisioned resources when an operation fails. + // // Default: False DisableRollback *bool @@ -114,24 +153,31 @@ 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) - // data type. + // more information, see the [Parameter]data type. + // + // [Parameter]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html 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 - // 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) - // . Only one of the Capabilities and ResourceType parameters can be specified. + // 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]. + // + // Only one of the Capabilities and ResourceType parameters can be specified. + // + // [Controlling Access with Identity and Access Management]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html ResourceTypes []string // When set to true , newly created resources are deleted when the operation rolls // back. This includes newly created resources marked with a deletion policy of - // Retain . Default: false + // Retain . + // + // Default: false RetainExceptOnCreate *bool // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role @@ -139,10 +185,11 @@ type UpdateStackInput struct { // credentials to make calls on your behalf. CloudFormation always uses this role // for all future operations on the stack. Provided that users have permission to // operate on the stack, CloudFormation uses this role even if the users don't have - // permission to pass it. Ensure that the role grants least privilege. If you don't - // specify a value, CloudFormation uses the role that was previously associated - // with the stack. If no role is available, CloudFormation uses a temporary session - // that is generated from your user credentials. + // permission to pass it. Ensure that the role grants least privilege. + // + // If you don't specify a value, CloudFormation uses the role that was previously + // associated with the stack. If no role is available, CloudFormation uses a + // temporary session that is generated from your user credentials. RoleARN *string // The rollback triggers for CloudFormation to monitor during stack creation and @@ -150,63 +197,77 @@ type UpdateStackInput struct { RollbackConfiguration *types.RollbackConfiguration // Structure containing a new stack policy body. You can specify either the - // StackPolicyBody or the StackPolicyURL parameter, but not both. You might update - // the stack policy, for example, in order to protect a new resource that you - // created during a stack update. If you don't specify a stack policy, the current - // policy that is associated with the stack is unchanged. + // StackPolicyBody or the StackPolicyURL parameter, but not both. + // + // You might update the stack policy, for example, in order to protect a new + // resource that you created during a stack update. If you don't specify a stack + // policy, the current 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 - // 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. + // 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. StackPolicyDuringUpdateBody *string // Location of a file containing the temporary overriding stack policy. The URL // must point to a policy (max size: 16KB) located in an S3 bucket in the same // Region as the stack. The location for an Amazon S3 bucket must start with // https:// . 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. + // 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. StackPolicyDuringUpdateURL *string // Location of a file containing the updated stack policy. The URL must point to a // policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. // The location for an Amazon S3 bucket must start with https:// . You can specify - // either the StackPolicyBody or the StackPolicyURL parameter, but not both. You - // might update the stack policy, for example, in order to protect a new resource - // that you created during a stack update. If you don't specify a stack policy, the - // current policy that is associated with the stack is unchanged. + // either the StackPolicyBody or the StackPolicyURL parameter, but not both. + // + // You might update the stack policy, for example, in order to protect a new + // resource that you created during a stack update. If you don't specify a stack + // policy, the current policy that is associated with the stack is unchanged. StackPolicyURL *string // Key-value pairs to associate with this stack. CloudFormation also propagates // these tags to supported resources in the stack. You can specify a maximum number - // of 50 tags. If you don't specify this parameter, CloudFormation doesn't modify - // the stack's tags. If you specify an empty value, CloudFormation removes all - // associated tags. + // of 50 tags. + // + // If you don't specify this parameter, CloudFormation doesn't modify the stack's + // tags. If you specify an empty value, CloudFormation removes all associated tags. 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) - // in the CloudFormation User Guide.) Conditional: You must specify only one of the - // following parameters: TemplateBody , TemplateURL , or set the - // UsePreviousTemplate to true . + // maximum length of 51,200 bytes. (For more information, go to [Template Anatomy]in the + // CloudFormation User Guide.) + // + // Conditional: You must specify only one of the following parameters: TemplateBody + // , TemplateURL , or set the UsePreviousTemplate to true . + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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) - // in the CloudFormation User Guide. The location for an Amazon S3 bucket must - // start with https:// . Conditional: You must specify only one of the following - // parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true . + // information, go to [Template Anatomy]in the CloudFormation User Guide. The location for an Amazon + // S3 bucket must start with https:// . + // + // Conditional: You must specify only one of the following parameters: TemplateBody + // , TemplateURL , or set the UsePreviousTemplate to true . + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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 . + // updating. + // + // Conditional: You must specify only one of the following parameters: 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 41fc3da25e3..bd07b0d5fbb 100644 --- a/service/cloudformation/api_op_UpdateStackInstances.go +++ b/service/cloudformation/api_op_UpdateStackInstances.go @@ -13,19 +13,24 @@ import ( // Updates the parameter values for 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 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) -// 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 . +// 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]. +// +// 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]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]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 . +// +// [CreateStackInstances]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html +// [UpdateStackSet]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html func (c *Client) UpdateStackInstances(ctx context.Context, params *UpdateStackInstancesInput, optFns ...func(*Options)) (*UpdateStackInstancesOutput, error) { if params == nil { params = &UpdateStackInstancesInput{} @@ -59,64 +64,85 @@ type UpdateStackInstancesInput struct { // [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. + // specified accounts and Amazon Web Services Regions. + // + // 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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html CallAs types.CallAs // [Service-managed permissions] The Organizations accounts for which you want to // update parameter values for stack instances. If your update targets OUs, the // 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. + // OUs in the future won't use the overridden values. + // + // You can specify Accounts or DeploymentTargets , but not both. DeploymentTargets *types.DeploymentTargets - // The unique identifier for this stack set operation. The operation ID also - // functions as an idempotency token, to ensure that CloudFormation performs the - // stack set operation only once, even if you retry the request multiple times. You - // 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. + // The unique identifier for this stack set operation. + // + // The operation ID also functions as an idempotency token, to ensure that + // CloudFormation performs the stack set operation only once, even if you retry the + // request multiple times. You 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. OperationId *string // Preferences for how CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences // A list of input parameters whose values you want to update for the specified - // 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 update operations: + // 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 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 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 . + // 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]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 . + // + // [UpdateStackSet]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html ParameterOverrides []types.Parameter noSmithyDocumentSerde diff --git a/service/cloudformation/api_op_UpdateStackSet.go b/service/cloudformation/api_op_UpdateStackSet.go index 2304e7f4a3e..d55e1be356d 100644 --- a/service/cloudformation/api_op_UpdateStackSet.go +++ b/service/cloudformation/api_op_UpdateStackSet.go @@ -12,11 +12,12 @@ import ( ) // Updates the stack set, and associated stack instances in the specified accounts -// 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. +// 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 CreateStackInstancescalls 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{} @@ -41,10 +42,13 @@ type UpdateStackSetInput struct { // [Self-managed permissions] The accounts in which to update associated stack // instances. If you specify accounts, you must also specify the Amazon Web - // Services Regions in which to update stack set instances. To update all the stack - // instances associated with this stack set, don't specify the Accounts or Regions - // properties. If the stack set update includes changes to the template (that is, - // if the TemplateBody or TemplateURL properties are specified), or the Parameters + // Services Regions in which to update stack set instances. + // + // To update all the stack instances associated with this stack set, don't specify + // the Accounts or Regions properties. + // + // If the stack set update includes changes to the template (that is, if the + // TemplateBody or TemplateURL properties are specified), or the Parameters // property, 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 does not include changes to the @@ -54,84 +58,127 @@ type UpdateStackSetInput struct { Accounts []string // The Amazon Resource Name (ARN) of the IAM role to use to update this stack set. + // // 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 (https://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 - // set previously. + // administrator account. For more information, see [Granting Permissions for Stack Set Operations]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 set previously. + // + // [Granting Permissions for Stack Set Operations]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html AdministrationRoleARN *string // [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. + // 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. + // 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]in the + // CloudFormation User Guide. + // + // [Register a delegated administrator]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html 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. + // + // - 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 (https://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 (https://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 (https://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 (https://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. + // 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] + // + // [AWS::IAM::Group] + // + // [AWS::IAM::InstanceProfile] + // + // [AWS::IAM::Policy] + // + // [AWS::IAM::Role] + // + // [AWS::IAM::User] + // + // [AWS::IAM::UserToGroupAddition] + // + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates]. + // + // - 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]. + // + // Stack sets with service-managed permissions do not currently support the use of + // macros in templates. (This includes the [AWS::Include]and [AWS::Serverless]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. + // + // [AWS::IAM::AccessKey]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html + // [AWS::Include]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html + // [AWS::IAM::User]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.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::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::UserToGroupAddition]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [Using CloudFormation Macros to Perform Custom Processing on Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html + // [AWS::Serverless]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html + // [Acknowledging IAM Resources in CloudFormation Templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities 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 - // update includes changes to the template (that is, if TemplateBody or TemplateURL - // 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 - // instances in the specified accounts and Regions, while leaving all other stack - // instances with their existing stack instance status. + // associated stack instances. + // + // To update all the stack instances associated with 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 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 instances in the specified accounts and + // Regions, while leaving all other stack instances with their existing stack + // instance status. DeploymentTargets *types.DeploymentTargets // A brief description of updates that you are making. @@ -139,26 +186,34 @@ type UpdateStackSetInput struct { // 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 - // a customized execution role, CloudFormation uses that role to update the stack. - // If you do not specify a customized execution role, CloudFormation performs the - // update using the role previously associated with the stack set, so long as you - // have permissions to perform operations on the stack set. + // 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 a customized execution role, CloudFormation uses that role to + // update the stack. If you do not specify a customized execution role, + // CloudFormation performs the update using the role previously associated with the + // stack set, so long as you have permissions to perform operations on the stack + // set. ExecutionRoleName *string // 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 - // an idempotency token, to ensure that CloudFormation performs the stack set - // operation only once, even if you retry the request multiple times. You might - // 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 . + // The unique ID for this stack set operation. + // + // The operation ID also functions as an idempotency token, to ensure that + // CloudFormation performs the stack set operation only once, even if you retry the + // request multiple times. You might 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 . OperationId *string // Preferences for how CloudFormation performs this stack set operation. @@ -170,36 +225,46 @@ 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) - // . + // [Grant Self-Managed Stack Set Permissions]. + // // - 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) - // . + // information, see [Grant Service-Managed Stack Set Permissions]. + // + // [Grant Self-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html + // [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. // If you specify Regions, you must also specify accounts in which to update stack - // set instances. To update all the stack instances associated with this stack set, - // do not specify the Accounts or Regions properties. If the stack set update - // includes changes to the template (that is, if the TemplateBody or TemplateURL - // properties are specified), or the Parameters property, CloudFormation marks all - // stack instances with a status of OUTDATED prior to updating the stack instances - // in the specified accounts and Regions. If the stack set update does not include - // changes to the template or parameters, CloudFormation updates the stack - // instances in the specified accounts and Regions, while leaving all other stack - // instances with their existing stack instance status. + // set instances. + // + // To update all the stack instances associated with this stack set, do not + // specify the Accounts or Regions properties. + // + // If the stack set update includes changes to the template (that is, if the + // TemplateBody or TemplateURL properties are specified), or the Parameters + // property, CloudFormation marks all stack instances with a status of OUTDATED + // prior to updating the stack instances in the specified accounts and Regions. If + // the stack set update does not include changes to the template or parameters, + // CloudFormation updates the stack instances in the specified accounts and + // Regions, while leaving all other stack 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 - // specify tags for this parameter, those tags replace any list of tags that are - // currently associated with this stack set. This means: + // 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 @@ -208,6 +273,7 @@ type UpdateStackSetInput struct { // // - 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 @@ -218,23 +284,31 @@ type UpdateStackSetInput struct { 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) - // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: TemplateBody or TemplateURL —or set UsePreviousTemplate - // to true. + // and a maximum length of 51,200 bytes. For more information, see [Template Anatomy]in the + // CloudFormation User Guide. + // + // Conditional: You must specify only one of the following parameters: TemplateBody + // or TemplateURL —or set UsePreviousTemplate to true. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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) - // in the CloudFormation User Guide. Conditional: You must specify only one of the - // following parameters: TemplateBody or TemplateURL —or set UsePreviousTemplate - // to true. + // or a Systems Manager document. For more information, see [Template Anatomy]in the CloudFormation + // User Guide. + // + // Conditional: You must specify only one of the following parameters: TemplateBody + // or TemplateURL —or set UsePreviousTemplate to true. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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. + // updating. + // + // Conditional: You must specify only one of the following parameters: 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 3bfab5633fd..d43911df28e 100644 --- a/service/cloudformation/api_op_UpdateTerminationProtection.go +++ b/service/cloudformation/api_op_UpdateTerminationProtection.go @@ -12,11 +12,14 @@ 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]in the CloudFormation User +// Guide. +// +// For [nested stacks], termination protection is set on the root stack and can't be changed +// directly on the nested stack. +// +// [Protecting a Stack From Being Deleted]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html +// [nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html 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 a2c44208771..6c147a930c9 100644 --- a/service/cloudformation/api_op_ValidateTemplate.go +++ b/service/cloudformation/api_op_ValidateTemplate.go @@ -33,17 +33,24 @@ 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) - // in the CloudFormation User Guide. Conditional: You must pass TemplateURL or - // TemplateBody . If both are passed, only TemplateBody is used. + // maximum length of 51,200 bytes. For more information, go to [Template Anatomy]in the + // CloudFormation User Guide. + // + // Conditional: You must pass TemplateURL or TemplateBody . If both are passed, + // only TemplateBody is used. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html 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) - // in the CloudFormation User Guide. The location for an Amazon S3 bucket must - // start with https:// . Conditional: You must pass TemplateURL or TemplateBody . - // If both are passed, only TemplateBody is used. + // Manager document. For more information, go to [Template Anatomy]in the CloudFormation User Guide. + // The location for an Amazon S3 bucket must start with https:// . + // + // Conditional: You must pass TemplateURL or TemplateBody . If both are passed, + // only TemplateBody is used. + // + // [Template Anatomy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html TemplateURL *string noSmithyDocumentSerde @@ -54,10 +61,12 @@ type ValidateTemplateOutput 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) - // . + // this parameter when you use the CreateStackor UpdateStack actions with your template; otherwise, + // those actions return an InsufficientCapabilities error. + // + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates]. + // + // [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 db08705c8b6..d2a8288629f 100644 --- a/service/cloudformation/doc.go +++ b/service/cloudformation/doc.go @@ -3,20 +3,27 @@ // Package cloudformation provides the API client, operations, and parameter types // for AWS CloudFormation. // -// CloudFormation CloudFormation allows you to create and manage Amazon Web -// Services infrastructure deployments predictably and repeatedly. You can use +// # CloudFormation +// +// CloudFormation allows you to create and manage Amazon Web Services +// infrastructure deployments predictably and repeatedly. You can use // CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic // Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, // Elastic Load Balancing, and Auto Scaling to build highly reliable, highly // scalable, cost-effective applications without creating or configuring the -// underlying Amazon Web Services infrastructure. With CloudFormation, you declare -// all your resources and dependencies in a template file. The template defines a -// 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 +// underlying Amazon Web Services infrastructure. +// +// With CloudFormation, you declare all your resources and dependencies in a +// template file. The template defines a 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]. +// +// 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/) -// . +// you can find the product's technical documentation at [docs.aws.amazon.com]. +// +// [docs.aws.amazon.com]: https://docs.aws.amazon.com/ +// [CloudFormation product page]: http://aws.amazon.com/cloudformation/ package cloudformation diff --git a/service/cloudformation/options.go b/service/cloudformation/options.go index 5357466b7bd..4b6dd3bf9e1 100644 --- a/service/cloudformation/options.go +++ b/service/cloudformation/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudformation/types/enums.go b/service/cloudformation/types/enums.go index 1ca6ef305e2..7028309c816 100644 --- a/service/cloudformation/types/enums.go +++ b/service/cloudformation/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AccountFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountFilterType) Values() []AccountFilterType { return []AccountFilterType{ "NONE", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for AccountGateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountGateStatus) Values() []AccountGateStatus { return []AccountGateStatus{ "SUCCEEDED", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for AttributeChangeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeChangeType) Values() []AttributeChangeType { return []AttributeChangeType{ "Add", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for CallAs. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallAs) Values() []CallAs { return []CallAs{ "SELF", @@ -92,8 +96,9 @@ const ( ) // Values returns all known values for Capability. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Capability) Values() []Capability { return []Capability{ "CAPABILITY_IAM", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for Category. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Category) Values() []Category { return []Category{ "REGISTERED", @@ -136,8 +142,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -158,8 +165,9 @@ const ( ) // Values returns all known values for ChangeSetHooksStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeSetHooksStatus) Values() []ChangeSetHooksStatus { return []ChangeSetHooksStatus{ "PLANNING", @@ -183,8 +191,9 @@ const ( ) // Values returns all known values for ChangeSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeSetStatus) Values() []ChangeSetStatus { return []ChangeSetStatus{ "CREATE_PENDING", @@ -208,8 +217,9 @@ const ( ) // Values returns all known values for ChangeSetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeSetType) Values() []ChangeSetType { return []ChangeSetType{ "CREATE", @@ -230,8 +240,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -250,8 +261,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "Resource", @@ -267,8 +279,9 @@ const ( ) // Values returns all known values for ConcurrencyMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConcurrencyMode) Values() []ConcurrencyMode { return []ConcurrencyMode{ "STRICT_FAILURE_TOLERANCE", @@ -285,8 +298,9 @@ const ( ) // Values returns all known values for DeprecatedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeprecatedStatus) Values() []DeprecatedStatus { return []DeprecatedStatus{ "LIVE", @@ -303,8 +317,9 @@ const ( ) // Values returns all known values for DetailedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetailedStatus) Values() []DetailedStatus { return []DetailedStatus{ "CONFIGURATION_COMPLETE", @@ -322,8 +337,9 @@ const ( ) // Values returns all known values for DifferenceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DifferenceType) Values() []DifferenceType { return []DifferenceType{ "ADD", @@ -341,8 +357,9 @@ const ( ) // Values returns all known values for EvaluationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationType) Values() []EvaluationType { return []EvaluationType{ "Static", @@ -363,8 +380,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "UNAVAILABLE", @@ -386,8 +404,9 @@ const ( // Values returns all known values for GeneratedTemplateDeletionPolicy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeneratedTemplateDeletionPolicy) Values() []GeneratedTemplateDeletionPolicy { return []GeneratedTemplateDeletionPolicy{ "DELETE", @@ -407,8 +426,9 @@ const ( // Values returns all known values for GeneratedTemplateResourceStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeneratedTemplateResourceStatus) Values() []GeneratedTemplateResourceStatus { return []GeneratedTemplateResourceStatus{ "PENDING", @@ -433,8 +453,9 @@ const ( ) // Values returns all known values for GeneratedTemplateStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeneratedTemplateStatus) Values() []GeneratedTemplateStatus { return []GeneratedTemplateStatus{ "CREATE_PENDING", @@ -458,8 +479,9 @@ const ( // Values returns all known values for GeneratedTemplateUpdateReplacePolicy. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeneratedTemplateUpdateReplacePolicy) Values() []GeneratedTemplateUpdateReplacePolicy { return []GeneratedTemplateUpdateReplacePolicy{ "DELETE", @@ -493,8 +515,9 @@ const ( ) // Values returns all known values for HandlerErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HandlerErrorCode) Values() []HandlerErrorCode { return []HandlerErrorCode{ "NotUpdatable", @@ -528,8 +551,9 @@ const ( ) // Values returns all known values for HookFailureMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HookFailureMode) Values() []HookFailureMode { return []HookFailureMode{ "FAIL", @@ -545,8 +569,9 @@ const ( ) // Values returns all known values for HookInvocationPoint. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HookInvocationPoint) Values() []HookInvocationPoint { return []HookInvocationPoint{ "PRE_PROVISION", @@ -564,8 +589,9 @@ const ( ) // Values returns all known values for HookStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HookStatus) Values() []HookStatus { return []HookStatus{ "HOOK_IN_PROGRESS", @@ -583,8 +609,9 @@ const ( ) // Values returns all known values for HookTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HookTargetType) Values() []HookTargetType { return []HookTargetType{ "RESOURCE", @@ -601,8 +628,9 @@ const ( ) // Values returns all known values for IdentityProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentityProvider) Values() []IdentityProvider { return []IdentityProvider{ "AWS_Marketplace", @@ -621,8 +649,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -641,8 +670,9 @@ const ( ) // Values returns all known values for OnStackFailure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnStackFailure) Values() []OnStackFailure { return []OnStackFailure{ "DO_NOTHING", @@ -660,6 +690,7 @@ const ( // Values returns all known values for OperationResultFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OperationResultFilterName) Values() []OperationResultFilterName { return []OperationResultFilterName{ @@ -678,8 +709,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "PENDING", @@ -699,8 +731,9 @@ const ( ) // Values returns all known values for OrganizationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationStatus) Values() []OrganizationStatus { return []OrganizationStatus{ "ENABLED", @@ -718,8 +751,9 @@ const ( ) // Values returns all known values for PermissionModels. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionModels) Values() []PermissionModels { return []PermissionModels{ "SERVICE_MANAGED", @@ -740,8 +774,9 @@ const ( ) // Values returns all known values for PolicyAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyAction) Values() []PolicyAction { return []PolicyAction{ "Delete", @@ -763,8 +798,9 @@ const ( ) // Values returns all known values for ProvisioningType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisioningType) Values() []ProvisioningType { return []ProvisioningType{ "NON_PROVISIONABLE", @@ -782,8 +818,9 @@ const ( ) // Values returns all known values for PublisherStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PublisherStatus) Values() []PublisherStatus { return []PublisherStatus{ "VERIFIED", @@ -800,8 +837,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SEQUENTIAL", @@ -819,8 +857,9 @@ const ( ) // Values returns all known values for RegistrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationStatus) Values() []RegistrationStatus { return []RegistrationStatus{ "COMPLETE", @@ -839,8 +878,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -859,8 +899,9 @@ const ( ) // Values returns all known values for Replacement. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Replacement) Values() []Replacement { return []Replacement{ "True", @@ -879,8 +920,9 @@ const ( ) // Values returns all known values for RequiresRecreation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequiresRecreation) Values() []RequiresRecreation { return []RequiresRecreation{ "Never", @@ -903,8 +945,9 @@ const ( ) // Values returns all known values for ResourceAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceAttribute) Values() []ResourceAttribute { return []ResourceAttribute{ "Properties", @@ -928,8 +971,9 @@ const ( ) // Values returns all known values for ResourceScanStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceScanStatus) Values() []ResourceScanStatus { return []ResourceScanStatus{ "IN_PROGRESS", @@ -948,8 +992,9 @@ const ( ) // Values returns all known values for ResourceSignalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSignalStatus) Values() []ResourceSignalStatus { return []ResourceSignalStatus{ "SUCCESS", @@ -986,8 +1031,9 @@ const ( ) // Values returns all known values for ResourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStatus) Values() []ResourceStatus { return []ResourceStatus{ "CREATE_IN_PROGRESS", @@ -1026,6 +1072,7 @@ const ( // Values returns all known values for StackDriftDetectionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StackDriftDetectionStatus) Values() []StackDriftDetectionStatus { return []StackDriftDetectionStatus{ @@ -1046,8 +1093,9 @@ const ( ) // Values returns all known values for StackDriftStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackDriftStatus) Values() []StackDriftStatus { return []StackDriftStatus{ "DRIFTED", @@ -1073,6 +1121,7 @@ const ( // Values returns all known values for StackInstanceDetailedStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StackInstanceDetailedStatus) Values() []StackInstanceDetailedStatus { return []StackInstanceDetailedStatus{ @@ -1097,8 +1146,9 @@ const ( ) // Values returns all known values for StackInstanceFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackInstanceFilterName) Values() []StackInstanceFilterName { return []StackInstanceFilterName{ "DETAILED_STATUS", @@ -1117,8 +1167,9 @@ const ( ) // Values returns all known values for StackInstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackInstanceStatus) Values() []StackInstanceStatus { return []StackInstanceStatus{ "CURRENT", @@ -1139,6 +1190,7 @@ const ( // 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{ @@ -1162,8 +1214,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackSetDriftDetectionStatus) Values() []StackSetDriftDetectionStatus { return []StackSetDriftDetectionStatus{ "COMPLETED", @@ -1184,8 +1237,9 @@ const ( ) // Values returns all known values for StackSetDriftStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackSetDriftStatus) Values() []StackSetDriftStatus { return []StackSetDriftStatus{ "DRIFTED", @@ -1205,8 +1259,9 @@ const ( ) // Values returns all known values for StackSetOperationAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackSetOperationAction) Values() []StackSetOperationAction { return []StackSetOperationAction{ "CREATE", @@ -1229,8 +1284,9 @@ const ( // Values returns all known values for StackSetOperationResultStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackSetOperationResultStatus) Values() []StackSetOperationResultStatus { return []StackSetOperationResultStatus{ "PENDING", @@ -1254,8 +1310,9 @@ const ( ) // Values returns all known values for StackSetOperationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackSetOperationStatus) Values() []StackSetOperationStatus { return []StackSetOperationStatus{ "RUNNING", @@ -1276,8 +1333,9 @@ const ( ) // Values returns all known values for StackSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackSetStatus) Values() []StackSetStatus { return []StackSetStatus{ "ACTIVE", @@ -1315,8 +1373,9 @@ const ( ) // Values returns all known values for StackStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackStatus) Values() []StackStatus { return []StackStatus{ "CREATE_IN_PROGRESS", @@ -1354,8 +1413,9 @@ const ( ) // Values returns all known values for TemplateFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateFormat) Values() []TemplateFormat { return []TemplateFormat{ "JSON", @@ -1372,8 +1432,9 @@ const ( ) // Values returns all known values for TemplateStage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateStage) Values() []TemplateStage { return []TemplateStage{ "Original", @@ -1391,8 +1452,9 @@ const ( ) // Values returns all known values for ThirdPartyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThirdPartyType) Values() []ThirdPartyType { return []ThirdPartyType{ "RESOURCE", @@ -1412,8 +1474,9 @@ const ( ) // Values returns all known values for TypeTestsStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TypeTestsStatus) Values() []TypeTestsStatus { return []TypeTestsStatus{ "PASSED", @@ -1432,8 +1495,9 @@ const ( ) // Values returns all known values for VersionBump. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VersionBump) Values() []VersionBump { return []VersionBump{ "MAJOR", @@ -1450,8 +1514,9 @@ const ( ) // Values returns all known values for Visibility. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Visibility) Values() []Visibility { return []Visibility{ "PUBLIC", @@ -1469,8 +1534,9 @@ const ( ) // Values returns all known values for WarningType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WarningType) Values() []WarningType { return []WarningType{ "MUTUALLY_EXCLUSIVE_PROPERTIES", diff --git a/service/cloudformation/types/errors.go b/service/cloudformation/types/errors.go index 76be9122349..984a0352154 100644 --- a/service/cloudformation/types/errors.go +++ b/service/cloudformation/types/errors.go @@ -251,8 +251,10 @@ 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]. CloudFormation doesn't return this error to +// users. +// +// [CloudFormation CLI]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html type InvalidStateTransitionException struct { Message *string @@ -278,9 +280,12 @@ 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) -// in the CloudFormation User Guide. +// The quota for the resource has already been reached. +// +// For information about resource and stack limitations, see [CloudFormation quotas] in the +// CloudFormation User Guide. +// +// [CloudFormation quotas]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html type LimitExceededException struct { Message *string @@ -411,8 +416,10 @@ 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]. CloudFormation doesn't return this error to +// users. +// +// [CloudFormation CLI]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html type OperationStatusCheckFailedException struct { Message *string @@ -468,9 +475,12 @@ func (e *ResourceScanInProgressException) ErrorCode() string { func (e *ResourceScanInProgressException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The limit on resource scans has been exceeded. Reasons include: +// // - Exceeded the daily quota for resource scans. +// // - A resource scan recently failed. You must wait 10 minutes before starting a // new resource scan. +// // - The last resource scan failed after exceeding 100,000 resources. When this // happens, you must wait 24 hours before starting a new resource scan. type ResourceScanLimitExceededException struct { diff --git a/service/cloudformation/types/types.go b/service/cloudformation/types/types.go index aeb1eae5a1d..706a36bef10 100644 --- a/service/cloudformation/types/types.go +++ b/service/cloudformation/types/types.go @@ -9,34 +9,43 @@ import ( // Structure that contains the results of the account gate function which // CloudFormation invokes, if present, before proceeding with a stack set operation -// in an account and Region. For each account and Region, CloudFormation lets you -// 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 , -// 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) -// . +// in an account and Region. +// +// For each account and Region, CloudFormation lets you 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 , 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]. +// +// [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. Status AccountGateStatus @@ -48,19 +57,25 @@ type AccountGateResult struct { noSmithyDocumentSerde } -// The AccountLimit data type. CloudFormation has the following limits per -// account: +// The AccountLimit data type. +// +// CloudFormation has the following limits per account: +// // - 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) -// in the CloudFormation User Guide. +// limits, see [CloudFormation quotas]in the CloudFormation User Guide. +// +// [CloudFormation quotas]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html type AccountLimit struct { - // The name of the account limit. Values: ConcurrentResourcesLimit | StackLimit | - // StackOutputsLimit + // The name of the account limit. + // + // Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit Name *string // The value that's associated with the account limit name. @@ -118,6 +133,7 @@ type Change struct { ResourceChange *ResourceChange // The type of entity that CloudFormation changes. + // // - Resource This change is for a resource. Type ChangeType @@ -129,7 +145,9 @@ 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. FailureMode HookFailureMode @@ -143,14 +161,23 @@ 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: + // 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 @@ -241,23 +268,30 @@ type ChangeSetSummary struct { // [Service-managed permissions] The Organizations accounts to which StackSets // 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 . +// in an OU in your organization. +// +// For update operations, you can specify either 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. + // 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. + // + // - 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 @@ -317,37 +351,51 @@ 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 - // 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. + // 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. Active *bool noSmithyDocumentSerde } // Contains information about the module from which the resource was created, if -// the resource was created from a module included in the stack template. For more -// information about modules, see Using modules to encapsulate and reuse resource -// configurations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) -// in the CloudFormation User Guide. +// the resource was created from a module included in the stack template. +// +// For more information about modules, see [Using modules to encapsulate and reuse resource configurations] in the CloudFormation User Guide. +// +// [Using modules to encapsulate and reuse resource configurations]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources) - // 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. + // + // [Referencing resources in a module]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources 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 + // 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 + // + // AWS::First::Example::MODULE/AWS::Second::Example::MODULE TypeHierarchy *string noSmithyDocumentSerde @@ -395,8 +443,9 @@ 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) - // parameter types in the template. + // returned only for [SSM]parameter types in the template. + // + // [SSM]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types ResolvedValue *string // During a stack update, use the existing parameter value that the stack is using @@ -466,9 +515,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]. +// +// [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. @@ -477,10 +526,13 @@ 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). // @@ -502,17 +554,21 @@ 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) -// in the CloudFormation User Guide. +// 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] in the CloudFormation User Guide. +// +// [Activating public modules for use in your account]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling type RequiredActivatedType struct { - // The type name of the public extension. If you specified a TypeNameAlias when - // 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) - // in the CloudFormation User Guide. + // The type name of the public extension. + // + // If you specified a TypeNameAlias when 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]in the CloudFormation User Guide. + // + // [Specifying aliases to refer to extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias OriginalTypeName *string // The publisher ID of the extension publisher. @@ -568,11 +624,17 @@ type ResourceChange struct { // The action that will be taken on the physical resource when the change set is // executed. + // // - Delete The resource will be deleted. + // // - Retain The resource will be retained. + // // - Snapshot The resource will have a snapshot taken. + // // - ReplaceAndDelete The resource will be replaced and then deleted. + // // - ReplaceAndRetain The resource will be replaced and then retained. + // // - ReplaceAndSnapshot The resource will be replaced and then have a snapshot // taken. PolicyAction PolicyAction @@ -583,8 +645,10 @@ type ResourceChange struct { // 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 + // 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 . Replacement Replacement @@ -607,21 +671,28 @@ 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 @@ -631,18 +702,20 @@ type ResourceChangeDetail struct { 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 - // 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 - // value, so this is a Static evaluation. For Dynamic evaluations, can't determine - // the target value because it depends on the result of an intrinsic function, such - // as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For - // example, if your template includes a reference to a resource that's - // conditionally recreated, the value of the reference (the physical ID of the - // resource) might change, depending on if the resource is recreated. If the - // resource is recreated, it will have a new physical ID, so all references to that - // resource will also be updated. + // 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 value, so this is a Static evaluation. + // + // For Dynamic evaluations, can't determine the target value because it depends on + // the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic + // function, when the stack is updated. For example, if your template includes a + // reference to a resource that's conditionally recreated, the value of the + // reference (the physical ID of the resource) might change, depending on if the + // resource is recreated. If the resource is recreated, it will have a new physical + // ID, so all references to that resource will also be updated. Evaluation EvaluationType // A ResourceTargetDefinition structure that describes the field that @@ -661,17 +734,19 @@ type ResourceDefinition struct { // identifiers are specified in the primaryIdentifier list in the resource // schema.) The value is the value of that primary identifier. For example, for a // AWS::DynamoDB::Table resource, the primary identifiers is TableName so the - // key-value pair could be "TableName": "MyDDBTable" . For more information, see - // primaryIdentifier (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier) + // key-value pair could be "TableName": "MyDDBTable" . For more information, see [primaryIdentifier] // in the CloudFormation Command Line Interface User guide for extension // development. // + // [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier + // // This member is required. ResourceIdentifier map[string]string // The type of the resource, such as AWS::DynamoDB::Table . For the list of - // supported resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) - // in the CloudFormation User Guide + // supported resources, see [IaC generator supported resource types]in the CloudFormation User Guide + // + // [IaC generator supported resource types]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html // // This member is required. ResourceType *string @@ -694,15 +769,21 @@ type ResourceDetail struct { // in the resource schema.) The value is the value of that primary identifier. For // example, for a AWS::DynamoDB::Table resource, the primary identifiers is // TableName so the key-value pair could be "TableName": "MyDDBTable" . For more - // information, see primaryIdentifier (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier) - // in the CloudFormation Command Line Interface User guide for extension - // development. + // information, see [primaryIdentifier]in the CloudFormation Command Line Interface User guide for + // extension development. + // + // [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier ResourceIdentifier map[string]string - // Status of the processing of a resource in a generated template. InProgress The - // resource processing is still in progress. Complete The resource processing is - // complete. Pending The resource processing is pending. Failed The resource - // processing has failed. + // Status of the processing of a resource in a generated template. + // + // InProgress The resource processing is still in progress. + // + // Complete The resource processing is complete. + // + // Pending The resource processing is pending. + // + // Failed The resource processing has failed. ResourceStatus GeneratedTemplateResourceStatus // The reason for the resource detail, providing more information if a failure @@ -710,8 +791,9 @@ type ResourceDetail struct { ResourceStatusReason *string // The type of the resource, such as AWS::DynamoDB::Table . For the list of - // supported resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) - // In the CloudFormation User Guide + // supported resources, see [IaC generator supported resource types]In the CloudFormation User Guide + // + // [IaC generator supported resource types]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html ResourceType *string // The warnings generated for this resource. @@ -756,8 +838,14 @@ type ResourceScanSummary struct { // The time that the resource scan was started. StartTime *time.Time - // Status of the resource scan. INPROGRESS The resource scan is still in progress. - // COMPLETE The resource scan is complete. EXPIRED The resource scan has expired. + // Status of the resource scan. + // + // INPROGRESS The resource scan is still in progress. + // + // COMPLETE The resource scan is complete. + // + // EXPIRED The resource scan has expired. + // // FAILED The resource scan has failed. Status ResourceScanStatus @@ -781,8 +869,11 @@ type ResourceTargetDefinition struct { Attribute ResourceAttribute // The type of change to be made to the property if the change is executed. + // // - Add The item will be added. + // // - Remove The item will be removed. + // // - Modify The item will be modified. AttributeChangeType AttributeChangeType @@ -800,8 +891,9 @@ type ResourceTargetDefinition struct { // 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. + // see the update behavior for that [property]in the CloudFormation User Guide. + // + // [property]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html RequiresRecreation RequiresRecreation noSmithyDocumentSerde @@ -823,8 +915,9 @@ type ResourceToImport struct { 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) - // in the CloudFormation User Guide. + // list of supported resource types, see [Resources that support import operations]in the CloudFormation User Guide. + // + // [Resources that support import operations]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html // // This member is required. ResourceType *string @@ -834,43 +927,56 @@ type ResourceToImport struct { // Structure containing the rollback triggers for CloudFormation to monitor during // stack creation and updating operations, and for the specified monitoring period -// afterwards. Rollback triggers enable you to have CloudFormation monitor the -// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html) -// . +// afterwards. +// +// Rollback triggers enable you to have CloudFormation monitor the 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]. +// +// [Monitor and Roll Back Stack Operations]: https://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 // the rollback triggers after the stack creation or update operation deploys all - // necessary resources. The default is 0 minutes. If you specify a monitoring - // period but don't specify any rollback triggers, CloudFormation still waits the - // 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 - // 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. + // necessary resources. + // + // The default is 0 minutes. + // + // If you specify a monitoring period but don't specify any rollback triggers, + // CloudFormation still waits the 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], 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. + // + // [CancelUpdateStack]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html MonitoringTimeInMinutes *int32 - // The triggers to monitor during stack creation or update actions. By default, - // CloudFormation saves the rollback triggers specified for a stack and applies - // them to any subsequent update operations for the stack, unless you specify - // otherwise. If you do specify rollback triggers for this parameter, those + // The triggers to monitor during stack creation or update actions. + // + // By default, CloudFormation saves the rollback triggers specified for a stack + // and applies them to any subsequent update operations for the stack, unless you + // specify 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. RollbackTriggers []RollbackTrigger @@ -884,15 +990,18 @@ type RollbackConfiguration struct { // rolls back the entire stack operation. type RollbackTrigger struct { - // The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger - // is missing, the entire stack operation fails and is rolled back. + // The Amazon Resource Name (ARN) of the rollback trigger. + // + // If a specified trigger is missing, the entire stack operation fails and is + // rolled back. // // 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) - // resource types. + // The resource type of the rollback trigger. Specify either [AWS::CloudWatch::Alarm] or [AWS::CloudWatch::CompositeAlarm] resource types. + // + // [AWS::CloudWatch::CompositeAlarm]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html + // [AWS::CloudWatch::Alarm]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html // // This member is required. Type *string @@ -912,15 +1021,17 @@ type ScannedResource struct { // identifiers are specified in the primaryIdentifier list in the resource // schema.) The value is the value of that primary identifier. For example, for a // AWS::DynamoDB::Table resource, the primary identifiers is TableName so the - // key-value pair could be "TableName": "MyDDBTable" . For more information, see - // primaryIdentifier (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier) + // key-value pair could be "TableName": "MyDDBTable" . For more information, see [primaryIdentifier] // in the CloudFormation Command Line Interface User guide for extension // development. + // + // [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier ResourceIdentifier map[string]string // The type of the resource, such as AWS::DynamoDB::Table . For the list of - // supported resources, see Resource type support (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) - // In the CloudFormation User Guide + // supported resources, see [Resource type support]In the CloudFormation User Guide + // + // [Resource type support]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html ResourceType *string noSmithyDocumentSerde @@ -935,17 +1046,19 @@ type ScannedResourceIdentifier struct { // identifiers are specified in the primaryIdentifier list in the resource // schema.) The value is the value of that primary identifier. For example, for a // AWS::DynamoDB::Table resource, the primary identifiers is TableName so the - // key-value pair could be "TableName": "MyDDBTable" . For more information, see - // primaryIdentifier (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier) + // key-value pair could be "TableName": "MyDDBTable" . For more information, see [primaryIdentifier] // in the CloudFormation Command Line Interface User guide for extension // development. // + // [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier + // // This member is required. ResourceIdentifier map[string]string // The type of the resource, such as AWS::DynamoDB::Table . For the list of - // supported resources, see IaC generator supported resource types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) - // In the CloudFormation User Guide. + // supported resources, see [IaC generator supported resource types]In the CloudFormation User Guide. + // + // [IaC generator supported resource types]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html // // This member is required. ResourceType *string @@ -987,27 +1100,33 @@ type Stack struct { // present, the resource or resource configuration phase has completed and the // stabilization of the resources is in progress. The stack sets // CONFIGURATION_COMPLETE when all of the resources in the stack have reached that - // event. For more information, see CloudFormation stack deployment (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) - // in the CloudFormation User Guide. + // event. For more information, see [CloudFormation stack deployment]in the CloudFormation User Guide. + // + // [CloudFormation stack deployment]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html DetailedStatus DetailedStatus // Boolean to enable or disable rollback on stack creation failures: + // // - true : disable rollback. + // // - false : enable rollback. DisableRollback *bool // Information about whether a stack'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 (https://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]. + // + // [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://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 (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. 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. + // Whether termination protection is enabled for the stack. + // + // For [nested stacks], 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]in the CloudFormation + // User Guide. + // + // [Protecting a Stack From Being Deleted]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html + // [nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html EnableTerminationProtection *bool // The time the stack was last updated. This field will only be returned if the @@ -1026,14 +1145,18 @@ 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) - // in the CloudFormation User Guide. + // root stack is also the parent stack. + // + // For more information, see [Working with Nested Stacks] in the CloudFormation User Guide. + // + // [Working with Nested Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html ParentId *string // When set to true , newly created resources are deleted when the operation rolls // back. This includes newly created resources marked with a deletion policy of - // Retain . Default: false + // Retain . + // + // Default: false RetainExceptOnCreate *bool // The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role @@ -1046,9 +1169,11 @@ type Stack struct { RollbackConfiguration *RollbackConfiguration // 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) - // in the CloudFormation User Guide. + // of the top-level stack to which the nested stack ultimately belongs. + // + // For more information, see [Working with Nested Stacks] in the CloudFormation User Guide. + // + // [Working with Nested Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html RootId *string // Unique identifier of the stack. @@ -1074,13 +1199,17 @@ 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. // // This member is required. @@ -1101,13 +1230,17 @@ 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. // // This member is required. @@ -1143,13 +1276,15 @@ type StackEvent struct { // This member is required. Timestamp *time.Time - // 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 - // operations display the client request token on the Events tab. Stack operations - // that are initiated from the console use the token format + // 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 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: @@ -1158,18 +1293,22 @@ type StackEvent struct { // An optional field containing information about the detailed status of the stack // event. + // // - CONFIGURATION_COMPLETE - all of the resources in the stack have reached that - // event. For more information, see CloudFormation stack deployment (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) - // in the CloudFormation User Guide. + // event. For more information, see [CloudFormation stack deployment]in the CloudFormation User Guide. // // - VALIDATION_FAILED - template validation failed because of invalid properties // in the template. The ResourceStatusReason field shows what properties are // defined incorrectly. + // + // [CloudFormation stack deployment]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html DetailedStatus DetailedStatus // 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. HookFailureMode HookFailureMode @@ -1201,9 +1340,10 @@ type StackEvent struct { // Success/failure message associated with the resource. 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) - // in the CloudFormation User Guide.) + // Type of resource. (For more information, go to [Amazon Web Services Resource Types Reference] in the CloudFormation User + // Guide.) + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html ResourceType *string noSmithyDocumentSerde @@ -1224,14 +1364,18 @@ 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. DriftStatus StackDriftStatus @@ -1244,8 +1388,9 @@ 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]. + // + // [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 @@ -1268,6 +1413,7 @@ 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 @@ -1277,11 +1423,15 @@ type StackInstance struct { // once the failures are fixed. To see if this is due to a failed import, look at // the DetailedStatus member in the StackInstanceSummary member that is a peer to // this Status member. + // // - 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 @@ -1298,26 +1448,32 @@ 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. + // // - FAILED_IMPORT : The import of the stack instance in the specified account // and Region failed and left the stack in an unstable state. Once the issues // causing the failure are fixed, the import operation can be retried. If enough // stack set operations fail 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. + // + // - 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. + // // - SKIPPED_SUSPENDED_ACCOUNT : The operation in the specified account and // Region has been skipped because the account was suspended at the time of the // operation. + // // - SUCCEEDED : The operation in the specified account and Region completed // successfully. DetailedStatus StackInstanceDetailedStatus @@ -1346,9 +1502,9 @@ type StackInstanceResourceDriftsSummary struct { // This member is required. LogicalResourceId *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) - // in the CloudFormation User Guide. + // Type of resource. For more information, go to [Amazon Web Services Resource Types Reference] in the CloudFormation User Guide. + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html // // This member is required. ResourceType *string @@ -1359,12 +1515,16 @@ type StackInstanceResourceDriftsSummary struct { StackId *string // The drift status of the resource in a stack instance. + // // - 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. // // This member is required. @@ -1403,14 +1563,18 @@ 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. DriftStatus StackDriftStatus @@ -1423,8 +1587,9 @@ 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]. + // + // [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 @@ -1443,20 +1608,25 @@ 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. INOPERABLE can be returned here when the cause // is a failed import. If it's due to a failed import, the operation can be retried - // once the failures are fixed. To see if this is due to a failed import, call the - // DescribeStackInstance API operation, look at the DetailedStatus member - // returned in the StackInstanceSummary member. + // once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance + // API operation, look at the DetailedStatus member returned in the + // StackInstanceSummary member. + // // - 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 @@ -1479,9 +1649,9 @@ 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) - // in the CloudFormation User Guide. + // Type of resource. For more information, go to [Amazon Web Services Resource Types Reference] in the CloudFormation User Guide. + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html // // This member is required. ResourceType *string @@ -1496,9 +1666,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 (https://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]. + // + // [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://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 @@ -1539,9 +1709,9 @@ 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) - // in the CloudFormation User Guide. + // Type of resource. For more information, go to [Amazon Web Services Resource Types Reference] in the CloudFormation User Guide. + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html // // This member is required. ResourceType *string @@ -1551,14 +1721,15 @@ 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 (https://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]. + // + // [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://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) - // in the CloudFormation User Guide. + // information, see [Metadata Attribute]in the CloudFormation User Guide. + // + // [Metadata Attribute]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html Metadata *string // Contains information about the module from which the resource was created, if @@ -1584,14 +1755,16 @@ 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 (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 resources in a given stack that support -// drift detection. +// in the stack template are checked for drift. For more information, see [Detecting Unregulated Configuration Changes to Stacks and Resources]. +// +// 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]. +// +// 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 Support Drift Detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html +// [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html type StackResourceDrift struct { // The logical name of the resource specified in the template. @@ -1611,13 +1784,17 @@ 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. // // This member is required. @@ -1629,14 +1806,17 @@ 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. 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 - // structure will not be present. + // parameters. + // + // For resources whose StackResourceDriftStatus is DELETED , this structure will + // not be present. ExpectedProperties *string // Contains information about the module from which the resource was created, if @@ -1668,17 +1848,23 @@ 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) - // . + // 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]. + // // - IN_SYNC : The resource's actual configuration matches its expected // configuration. // + // [Resources that Support Drift Detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + // // This member is required. StackResourceDriftStatus StackResourceDriftStatus @@ -1695,21 +1881,27 @@ 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. + // 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]. If you performed an ContinueUpdateRollbackoperation 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]in the CloudFormation User Guide. + // // - IN_SYNC : The resource's actual configuration matches its expected // configuration. // + // [Continue Rolling Back an Update]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html + // [Resources that Support Drift Detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html + // // This member is required. StackResourceDriftStatus StackResourceDriftStatus @@ -1738,18 +1930,19 @@ type StackResourceSummary 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) - // in the CloudFormation User Guide.) + // Type of resource. (For more information, go to [Amazon Web Services Resource Types Reference] in the CloudFormation User + // Guide.) + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html // // This member is required. ResourceType *string // 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 (https://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]. + // + // [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://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 @@ -1774,10 +1967,13 @@ type StackResourceSummary struct { 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) - // in the CloudFormation User Guide. + // 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]in the CloudFormation User Guide. + // + // [Prerequisites: Granting Permissions for Stack Set Operations]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html AdministrationRoleARN *string // [Service-managed permissions] Describes whether StackSets automatically deploys @@ -1788,17 +1984,19 @@ type StackSet struct { // The capabilities that are allowed in the stack set. Some stack set 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 more information, see Acknowledging IAM Resources in CloudFormation - // Templates. (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) + // For more information, see [Acknowledging IAM Resources in CloudFormation Templates.] + // + // [Acknowledging IAM Resources in CloudFormation 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. Description *string - // The name of the IAM execution role used to create or update the stack set. Use - // customized execution roles to control which stack resources users and groups can - // include in their stack sets. + // The name of the IAM execution role used to create or update the stack set. + // + // Use 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 @@ -1806,22 +2004,26 @@ type StackSet struct { 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]. + // + // [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) - // . + // [Grant Self-Managed Stack Set Permissions]. + // // - 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) - // . + // information, see [Grant Service-Managed Stack Set Permissions]. + // + // [Grant Self-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html + // [Grant Service-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html PermissionModel PermissionModels // Returns a list of all Amazon Web Services Regions the given StackSet has stack @@ -1832,10 +2034,11 @@ type StackSet struct { // The Amazon Resource Name (ARN) of the stack set. StackSetARN *string - // Detailed information about the drift status of the stack set. For stack sets, - // contains information about the last completed drift operation performed on the - // stack set. Information about drift operations currently in progress isn't - // included. + // Detailed information about the drift status of the stack set. + // + // For stack sets, contains information about the last completed drift operation + // performed on the stack set. Information about drift operations currently in + // progress isn't included. StackSetDriftDetectionDetails *StackSetDriftDetectionDetails // The ID of the stack set. @@ -1858,9 +2061,9 @@ type StackSet struct { noSmithyDocumentSerde } -// One of the targets for the stack set. Returned by the -// ListStackSetAutoDeploymentTargets (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html) -// API operation. +// One of the targets for the stack set. Returned by the [ListStackSetAutoDeploymentTargets] API operation. +// +// [ListStackSetAutoDeploymentTargets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html type StackSetAutoDeploymentTargetSummary struct { // The organization root ID or organizational unit (OU) IDs where the stack set is @@ -1873,23 +2076,33 @@ type StackSetAutoDeploymentTargetSummary struct { noSmithyDocumentSerde } -// Detailed information about the drift status of the stack set. For stack sets, -// contains information about the last completed drift operation performed on the -// 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) -// in the CloudFormation User Guide. +// Detailed information about the drift status of the stack set. +// +// For stack sets, contains information about the last completed drift operation +// performed on the 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] in the CloudFormation User Guide. +// +// [Detecting unmanaged changes in stack sets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html 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. DriftDetectionStatus StackSetDriftDetectionStatus @@ -1897,11 +2110,14 @@ type StackSetDriftDetectionDetails struct { // 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 @@ -1927,11 +2143,16 @@ type StackSetDriftDetectionDetails struct { // detection hasn't yet been performed. LastDriftCheckTimestamp *time.Time - // The total number of stack instances belonging to this stack set. The total - // number of stack instances is equal to the total of: + // 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. TotalStackInstancesCount *int32 @@ -1948,10 +2169,13 @@ type StackSetOperation struct { Action StackSetOperationAction // 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) - // in the CloudFormation User Guide. + // 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]in the CloudFormation User Guide. + // + // [Define Permissions for Multiple Administrators]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html AdministrationRoleARN *string // The time at which the operation was initiated. Note that the creation times for @@ -1970,9 +2194,10 @@ type StackSetOperation struct { // 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 - // customized execution roles to control which stack resources users and groups can - // include in their stack sets. + // The name of the IAM execution role used to create or update the stack set. + // + // Use customized execution roles to control which stack resources users and + // groups can include in their stack sets. ExecutionRoleName *string // The unique ID of a stack set operation. @@ -1989,16 +2214,20 @@ 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) - // in the CloudFormation User Guide. + // type is DETECT_DRIFT . + // + // For more information, see [Detecting Unmanaged Changes in Stack Sets] in the CloudFormation User Guide. + // + // [Detecting Unmanaged Changes in Stack Sets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html StackSetDriftDetectionDetails *StackSetDriftDetectionDetails // The ID of the stack set. 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 @@ -2006,15 +2235,21 @@ type StackSetOperation struct { // 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. + // more information, see the [stack set operation 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. + // + // [stack set operation status codes]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes Status StackSetOperationStatus // Detailed information about the StackSet operation. @@ -2027,19 +2262,26 @@ 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) -// . +// operation. +// +// For more information about maximum concurrent accounts and failure tolerance, +// see [Stack set operation options]. +// +// [Stack set operation options]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options type StackSetOperationPreferences struct { // Specifies how the concurrency level behaves during the operation execution. + // // - STRICT_FAILURE_TOLERANCE : This option dynamically lowers the concurrency // level to ensure the number of failed accounts never exceeds the value of // FailureToleranceCount +1. The initial actual concurrency is set to the lower // of either the value of the MaxConcurrentCount , or the value of // MaxConcurrentCount +1. The actual concurrency is then reduced proportionally - // by the number of failures. This is the default behavior. If failure tolerance or - // Maximum concurrent accounts are set to percentages, the behavior is similar. + // by the number of failures. This is the default behavior. + // + // If failure tolerance or Maximum concurrent accounts are set to percentages, the + // behavior is similar. + // // - SOFT_FAILURE_TOLERANCE : This option decouples FailureToleranceCount from // the actual concurrency. This allows stack set operations to run at the // concurrency level set by the MaxConcurrentCount value, or @@ -2049,39 +2291,59 @@ type StackSetOperationPreferences struct { // The number of accounts, per Region, for which this operation can fail before // CloudFormation stops the operation in that Region. If the operation is stopped // in a Region, CloudFormation doesn't attempt the operation in any subsequent - // Regions. Conditional: You must specify either FailureToleranceCount or - // FailureTolerancePercentage (but not both). By default, 0 is specified. + // Regions. + // + // Conditional: You must specify either FailureToleranceCount or + // FailureTolerancePercentage (but not both). + // + // By default, 0 is specified. FailureToleranceCount *int32 // The percentage of accounts, per Region, for which this stack operation can fail // before CloudFormation stops the operation in that Region. If the operation is // stopped in a Region, CloudFormation doesn't attempt the operation in any - // subsequent Regions. When calculating the number of accounts based on the - // specified percentage, CloudFormation rounds down to the next whole number. + // 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 can depend on the value of FailureToleranceCount depending on your // ConcurrencyMode . MaxConcurrentCount is at most one more than the - // FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE . 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 specified. + // FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE . + // + // 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 specified. MaxConcurrentCount *int32 // The maximum percentage of accounts in which to perform this operation at one - // time. When calculating the number of accounts based on the specified percentage, + // time. + // + // When calculating the number of accounts based on the specified percentage, // CloudFormation rounds down to the next whole number. This is true except in // cases where rounding down would result is zero. In this case, CloudFormation - // sets the number as one instead. 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 specified. + // sets the number as one instead. + // + // 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 specified. MaxConcurrentPercentage *int32 // The concurrency type of deploying StackSets operations in Regions, could be in @@ -2089,6 +2351,7 @@ type StackSetOperationPreferences struct { RegionConcurrencyType RegionConcurrencyType // The order of the Regions where you want to perform the stack operation. + // // RegionOrder isn't followed if AutoDeployment is enabled. RegionOrder []string @@ -2108,8 +2371,9 @@ 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]. + // + // [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. @@ -2117,16 +2381,21 @@ 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. + // + // - 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. + // + // - 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 @@ -2171,12 +2440,16 @@ type StackSetOperationSummary struct { OperationId *string // 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) - // . + // operation. + // + // For more information about maximum concurrent accounts and failure tolerance, + // see [Stack set operation options]. + // + // [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 @@ -2184,15 +2457,21 @@ type StackSetOperationSummary struct { // 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. + // more information, see the [stack set operation 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. + // + // [stack set operation status codes]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes Status StackSetOperationStatus // Detailed information about the stack set operation. @@ -2219,13 +2498,17 @@ type StackSetSummary struct { // 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 @@ -2239,14 +2522,17 @@ type StackSetSummary struct { 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) - // . + // [Grant Self-Managed Stack Set Permissions]. + // // - 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) - // . + // information, see [Grant Service-Managed Stack Set Permissions]. + // + // [Grant Self-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html + // [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. @@ -2284,9 +2570,9 @@ type StackSummary struct { // Summarizes information about whether a stack'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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html) - // . + // and any values specified as template parameters. For more information, see [Detecting Unregulated Configuration Changes to Stacks and Resources]. + // + // [Detecting Unregulated Configuration Changes to Stacks and Resources]: https://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 @@ -2295,15 +2581,19 @@ 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) - // in the CloudFormation User Guide. + // root stack is also the parent stack. + // + // For more information, see [Working with Nested Stacks] in the CloudFormation User Guide. + // + // [Working with Nested Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) - // in the CloudFormation User Guide. + // of the top-level stack to which the nested stack ultimately belongs. + // + // For more information, see [Working with Nested Stacks] in the CloudFormation User Guide. + // + // [Working with Nested Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html RootId *string // Unique stack identifier. @@ -2322,15 +2612,15 @@ type StackSummary struct { // information about an CloudFormation stack. type Tag struct { - // Required. A string used to identify this tag. You can specify a maximum of 128 + // 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: . // // This member is required. Key *string - // Required. A string containing the value for this tag. You can specify a maximum - // of 256 characters for a tag value. + // Required. A string containing the value for this tag. You can specify a + // maximum of 256 characters for a tag value. // // This member is required. Value *string @@ -2343,20 +2633,28 @@ type TemplateConfiguration struct { // The DeletionPolicy assigned to resources in the generated template. Supported // values are: + // // - DELETE - delete all resources when the stack is deleted. + // // - RETAIN - retain all resources when the stack is deleted. - // For more information, see DeletionPolicy attribute (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) - // in the CloudFormation User Guide. + // + // For more information, see [DeletionPolicy attribute] in the CloudFormation User Guide. + // + // [DeletionPolicy attribute]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html DeletionPolicy GeneratedTemplateDeletionPolicy // The UpdateReplacePolicy assigned to resources in the generated template. // Supported values are: + // // - DELETE - delete all resources when the resource is replaced during an update // operation. + // // - RETAIN - retain all resources when the resource is replaced during an update // operation. - // For more information, see UpdateReplacePolicy attribute (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) - // in the CloudFormation User Guide. + // + // For more information, see [UpdateReplacePolicy attribute] in the CloudFormation User Guide. + // + // [UpdateReplacePolicy attribute]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html UpdateReplacePolicy GeneratedTemplateUpdateReplacePolicy noSmithyDocumentSerde @@ -2423,13 +2721,21 @@ type TemplateSummary struct { NumberOfResources *int32 // The status of the template generation. Supported values are: + // // - CreatePending - the creation of the template is pending. + // // - CreateInProgress - the creation of the template is in progress. + // // - DeletePending - the deletion of the template is pending. + // // - DeleteInProgress - the deletion of the template is in progress. + // // - UpdatePending - the update of the template is pending. + // // - UpdateInProgress - the update of the template is in progress. + // // - Failed - the template operation failed. + // // - Complete - the template operation is complete. Status GeneratedTemplateStatus @@ -2452,9 +2758,11 @@ type TemplateSummaryConfig 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-private.html#registry-set-configuration) -// in the CloudFormation User Guide. +// in a given account and Region. +// +// For more information, see [Configuring extensions at the account level] in the CloudFormation User Guide. +// +// [Configuring extensions at the account level]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private.html#registry-set-configuration type TypeConfigurationDetails struct { // The alias specified for this configuration, if one was specified when the @@ -2466,24 +2774,29 @@ type TypeConfigurationDetails struct { Arn *string // 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 {} . + // account and Region. + // + // If a configuration hasn't been set for a specified extension, CloudFormation + // returns {} . Configuration *string // Whether this configuration data is the default configuration for the extension. IsDefaultConfiguration *bool - // When the configuration data was last updated for this extension. If a - // configuration hasn't been set for a specified extension, CloudFormation returns - // null . + // When the configuration data was last updated for this extension. + // + // If a configuration hasn't been set for a specified extension, CloudFormation + // returns 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 call the - // ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // API operation in this account and Region. For private extensions, this will be - // the ARN assigned when you call the RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) - // API operation in this account and Region. + // + // For public extensions, this will be the ARN assigned when you call the [ActivateType] API + // operation in this account and Region. For private extensions, this will be the + // ARN assigned when you call the [RegisterType]API operation in this account and Region. + // + // [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html TypeArn *string // The name of the extension. @@ -2499,11 +2812,13 @@ 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 call the - // ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // API operation in this account and Region. For private extensions, this will be - // the ARN assigned when you call the RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) - // API operation in this account and Region. + // + // For public extensions, this will be the ARN assigned when you call the [ActivateType] API + // operation in this account and Region. For private extensions, this will be the + // ARN assigned when you call the [RegisterType]API operation in this account and Region. + // + // [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html TypeArn *string // The alias specified for this configuration, if one was specified when the @@ -2524,21 +2839,28 @@ 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. Category Category - // The id of the publisher of the extension. Extensions published by Amazon aren't - // assigned a publisher ID. Use the AWS_TYPES category to specify a list of types - // published by Amazon. + // The id of the publisher of the extension. + // + // Extensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES + // category to specify a list of types published by Amazon. PublisherId *string // A prefix to use as a filter for results. @@ -2551,66 +2873,84 @@ type TypeFilters struct { 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 . + // 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]. + // + // To set the default version of an extension, use SetTypeDefaultVersion. + // + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html DefaultVersionId *string // The description of the extension. Description *string - // Whether the extension is activated for this account and Region. This applies - // only to third-party public extensions. Extensions published by Amazon are - // activated by default. + // Whether the extension is activated for this account and Region. + // + // This applies only to third-party public extensions. Extensions published by + // Amazon are activated by default. 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) - // . + // information, see [RegisterType]. + // // - 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) - // . + // specified. For more information, see [ActivateType]. + // // For all other extension types, CloudFormation returns null . + // + // [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html + // [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html 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 + // 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. + // when a new version is released. For more information, see [Setting CloudFormation to automatically use new versions of extensions]in the CloudFormation + // User Guide. + // + // [Setting CloudFormation to automatically use new versions of extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto LatestPublicVersion *string // For public extensions that have been activated for this account and Region, the - // type name of the public extension. If you specified a TypeNameAlias when - // 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) - // in the CloudFormation User Guide. + // type name of the public extension. + // + // If you specified a TypeNameAlias when 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]in the CloudFormation User Guide. + // + // [Specifying aliases to refer to extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias OriginalTypeName *string // 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. 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. + // 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]in the CloudFormation + // User Guide. + // + // [Setting CloudFormation to automatically use new versions of extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto PublicVersionNumber *string // The ID of the extension publisher, if the extension is published by a third // party. Extensions published by Amazon don't return a publisher ID. 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) - // in the CFN-CLI User Guide for Extension Development. + // The service used to verify the publisher identity. + // + // For more information, see [Registering your account to publish CloudFormation extensions] in the CFN-CLI User Guide for Extension Development. + // + // [Registering your account to publish CloudFormation extensions]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html PublisherIdentity IdentityProvider // The publisher name, as defined in the public profile for that publisher in the @@ -2623,10 +2963,12 @@ type TypeSummary struct { // The Amazon Resource Name (ARN) of the extension. TypeArn *string - // The name of the extension. If you specified a TypeNameAlias when you call the - // ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) - // API operation in your account and Region, CloudFormation considers that alias as - // the type name. + // The name of the extension. + // + // If you specified a TypeNameAlias when you call the [ActivateType] API operation in your + // account and Region, CloudFormation considers that alias as the type name. + // + // [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html TypeName *string noSmithyDocumentSerde @@ -2642,21 +2984,24 @@ type TypeVersionSummary struct { // The description of the extension version. Description *string - // 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, + // 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 . 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 - // 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. + // 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]in the CloudFormation + // User Guide. + // + // [Setting CloudFormation to automatically use new versions of extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto PublicVersionNumber *string // When the version was registered. @@ -2682,24 +3027,29 @@ type WarningDetail struct { // The properties of the resource that are impacted by this warning. Properties []WarningProperty - // The type of this warning. For more information, see IaC generator and - // write-only properties (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html) - // in the CloudFormation User Guide. + // The type of this warning. For more information, see [IaC generator and write-only properties] in the CloudFormation User + // Guide. + // // - MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive // write-only properties. The IaC generator selects one set of mutually exclusive // properties and converts the included properties into parameters. The parameter // names have a suffix OneOf and the parameter descriptions indicate that the // corresponding property can be replaced with other exclusive properties. + // // - UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. // One example of unsupported properties would be a required write-only property // that is an array, because a parameter cannot be an array. Another example is an // optional write-only property. + // // - MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are // found in the resource, and the type of that property can be any of several // types. + // // Currently the resource and property reference documentation does not indicate // if a property uses a type of oneOf or anyOf . You need to look at the resource // provider schema. + // + // [IaC generator and write-only properties]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html Type WarningType noSmithyDocumentSerde diff --git a/service/cloudfront/api_op_AssociateAlias.go b/service/cloudfront/api_op_AssociateAlias.go index 6bc4f1e63d1..26c9749a183 100644 --- a/service/cloudfront/api_op_AssociateAlias.go +++ b/service/cloudfront/api_op_AssociateAlias.go @@ -11,16 +11,20 @@ import ( ) // Associates an alias (also known as a CNAME or an alternate domain name) with a -// CloudFront distribution. With this operation you can move an alias that's -// already in use on a CloudFront distribution to a different distribution in one -// step. This prevents the downtime that could occur if you first remove the alias -// from one distribution and then separately add the alias to another distribution. -// To use this operation to associate an alias with a distribution, you provide the -// 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) -// in the Amazon CloudFront Developer Guide. +// CloudFront distribution. +// +// With this operation you can move an alias that's already in use on a CloudFront +// distribution to a different distribution in one step. This prevents the downtime +// that could occur if you first remove the alias from one distribution and then +// separately add the alias to another distribution. +// +// To use this operation to associate an alias with a distribution, you provide +// the 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]in the Amazon CloudFront +// Developer Guide. +// +// [Moving an alternate domain name to a different distribution]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move func (c *Client) AssociateAlias(ctx context.Context, params *AssociateAliasInput, optFns ...func(*Options)) (*AssociateAliasOutput, error) { if params == nil { params = &AssociateAliasInput{} diff --git a/service/cloudfront/api_op_CopyDistribution.go b/service/cloudfront/api_op_CopyDistribution.go index 89d4e430ee0..7a84a3f1dac 100644 --- a/service/cloudfront/api_op_CopyDistribution.go +++ b/service/cloudfront/api_op_CopyDistribution.go @@ -14,14 +14,24 @@ import ( // Creates a staging distribution using the configuration of the provided primary // distribution. A staging distribution is a copy of an existing distribution // (called the primary distribution) that you can use in a continuous deployment -// workflow. After you create a staging distribution, you can use -// UpdateDistribution to modify the staging distribution's configuration. Then you -// can use CreateContinuousDeploymentPolicy to incrementally move traffic to the -// staging distribution. This API operation requires the following IAM permissions: +// workflow. // -// - GetDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html) -// - CreateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html) -// - CopyDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CopyDistribution.html) +// After you create a staging distribution, you can use UpdateDistribution to +// modify the staging distribution's configuration. Then you can use +// CreateContinuousDeploymentPolicy to incrementally move traffic to the staging +// distribution. +// +// This API operation requires the following IAM permissions: +// +// [GetDistribution] +// +// [CreateDistribution] +// +// [CopyDistribution] +// +// [CopyDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CopyDistribution.html +// [GetDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html +// [CreateDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html func (c *Client) CopyDistribution(ctx context.Context, params *CopyDistributionInput, optFns ...func(*Options)) (*CopyDistributionOutput, error) { if params == nil { params = &CopyDistributionInput{} @@ -54,8 +64,9 @@ type CopyDistributionInput struct { // A Boolean flag to specify the state of the staging distribution when it's // created. When you set this value to True , the staging distribution is enabled. - // When you set this value to False , the staging distribution is disabled. If you - // omit this field, the default value is True . + // When you set this value to False , the staging distribution is disabled. + // + // If you omit this field, the default value is True . Enabled *bool // The version identifier of the primary distribution whose configuration you are diff --git a/service/cloudfront/api_op_CreateCachePolicy.go b/service/cloudfront/api_op_CreateCachePolicy.go index 642369b4af8..64795003d52 100644 --- a/service/cloudfront/api_op_CreateCachePolicy.go +++ b/service/cloudfront/api_op_CreateCachePolicy.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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. // @@ -24,9 +28,12 @@ import ( // 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) -// in the Amazon CloudFront Developer Guide. +// cache key, use OriginRequestPolicy . +// +// For more information about cache policies, see [Controlling the cache key] in the Amazon CloudFront +// Developer Guide. +// +// [Controlling the cache key]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html func (c *Client) CreateCachePolicy(ctx context.Context, params *CreateCachePolicyInput, optFns ...func(*Options)) (*CreateCachePolicyOutput, error) { if params == nil { params = &CreateCachePolicyInput{} diff --git a/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go b/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go index 32f3cf73d1c..e4edb279d78 100644 --- a/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go +++ b/service/cloudfront/api_op_CreateCloudFrontOriginAccessIdentity.go @@ -14,9 +14,10 @@ import ( // 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. +// information about how to use origin access identities, see [Serving Private Content through CloudFront]in the Amazon +// CloudFront Developer Guide. +// +// [Serving Private Content through CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html func (c *Client) CreateCloudFrontOriginAccessIdentity(ctx context.Context, params *CreateCloudFrontOriginAccessIdentityInput, optFns ...func(*Options)) (*CreateCloudFrontOriginAccessIdentityOutput, error) { if params == nil { params = &CreateCloudFrontOriginAccessIdentityInput{} @@ -35,9 +36,9 @@ 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) -// in the Amazon CloudFront Developer Guide. +// more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity]in the Amazon CloudFront Developer Guide. +// +// [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 type CreateCloudFrontOriginAccessIdentityInput struct { // The current configuration information for the identity. diff --git a/service/cloudfront/api_op_CreateContinuousDeploymentPolicy.go b/service/cloudfront/api_op_CreateContinuousDeploymentPolicy.go index ad030a1718d..46d8bce083f 100644 --- a/service/cloudfront/api_op_CreateContinuousDeploymentPolicy.go +++ b/service/cloudfront/api_op_CreateContinuousDeploymentPolicy.go @@ -12,9 +12,12 @@ import ( ) // Creates a continuous deployment policy that distributes traffic for a custom -// domain name to two different CloudFront distributions. To use a continuous -// deployment policy, first use CopyDistribution to create a staging distribution, -// then use UpdateDistribution to modify the staging distribution's configuration. +// domain name to two different CloudFront distributions. +// +// To use a continuous deployment policy, first use CopyDistribution to create a +// staging distribution, then use UpdateDistribution to modify the staging +// distribution's configuration. +// // After you create and update a staging distribution, you can use a continuous // deployment policy to incrementally move traffic to the staging distribution. // This workflow enables you to test changes to a distribution's configuration diff --git a/service/cloudfront/api_op_CreateDistributionWithTags.go b/service/cloudfront/api_op_CreateDistributionWithTags.go index e3b5f74ec68..2045eacc2b5 100644 --- a/service/cloudfront/api_op_CreateDistributionWithTags.go +++ b/service/cloudfront/api_op_CreateDistributionWithTags.go @@ -13,8 +13,13 @@ import ( // Create a new distribution with tags. This API operation requires the following // IAM permissions: -// - CreateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html) -// - TagResource (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_TagResource.html) +// +// [CreateDistribution] +// +// [TagResource] +// +// [TagResource]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_TagResource.html +// [CreateDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html func (c *Client) CreateDistributionWithTags(ctx context.Context, params *CreateDistributionWithTagsInput, optFns ...func(*Options)) (*CreateDistributionWithTagsOutput, error) { if params == nil { params = &CreateDistributionWithTagsInput{} diff --git a/service/cloudfront/api_op_CreateFunction.go b/service/cloudfront/api_op_CreateFunction.go index ded50be3878..607b2abab5e 100644 --- a/service/cloudfront/api_op_CreateFunction.go +++ b/service/cloudfront/api_op_CreateFunction.go @@ -11,11 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a CloudFront function. To create a function, you provide the function -// code and some configuration information about the function. The response -// contains an Amazon Resource Name (ARN) that uniquely identifies the function. +// Creates a CloudFront function. +// +// To create a function, you provide the function 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 // it's live, you can attach the function to a distribution's cache behavior, using @@ -38,8 +42,9 @@ 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) - // in the Amazon CloudFront Developer Guide. + // see [Writing function code for CloudFront Functions]in the Amazon CloudFront Developer Guide. + // + // [Writing function code for CloudFront Functions]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html // // This member is required. FunctionCode []byte diff --git a/service/cloudfront/api_op_CreateInvalidation.go b/service/cloudfront/api_op_CreateInvalidation.go index 095bab56b04..41112df4684 100644 --- a/service/cloudfront/api_op_CreateInvalidation.go +++ b/service/cloudfront/api_op_CreateInvalidation.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new invalidation. For more information, see Invalidating files (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html) -// in the Amazon CloudFront Developer Guide. +// Create a new invalidation. For more information, see [Invalidating files] in the Amazon CloudFront +// Developer Guide. +// +// [Invalidating files]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html func (c *Client) CreateInvalidation(ctx context.Context, params *CreateInvalidationInput, optFns ...func(*Options)) (*CreateInvalidationOutput, error) { if params == nil { params = &CreateInvalidationInput{} diff --git a/service/cloudfront/api_op_CreateKeyGroup.go b/service/cloudfront/api_op_CreateKeyGroup.go index ba181834719..d5cd0f61739 100644 --- a/service/cloudfront/api_op_CreateKeyGroup.go +++ b/service/cloudfront/api_op_CreateKeyGroup.go @@ -11,17 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Creates a key group that you can use with [CloudFront signed URLs and signed cookies]. +// +// 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) -// in the Amazon CloudFront Developer Guide. +// signature. For more information, see [Serving private content]in the Amazon CloudFront Developer Guide. +// +// [Serving private content]: 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 func (c *Client) CreateKeyGroup(ctx context.Context, params *CreateKeyGroupInput, optFns ...func(*Options)) (*CreateKeyGroupOutput, error) { if params == nil { params = &CreateKeyGroupInput{} diff --git a/service/cloudfront/api_op_CreateMonitoringSubscription.go b/service/cloudfront/api_op_CreateMonitoringSubscription.go index 43b5dcb07f9..1f5f5a230c9 100644 --- a/service/cloudfront/api_op_CreateMonitoringSubscription.go +++ b/service/cloudfront/api_op_CreateMonitoringSubscription.go @@ -12,9 +12,11 @@ import ( ) // 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. +// distribution. The additional metrics incur an additional cost. +// +// For more information, see [Viewing additional CloudFront distribution metrics] in the Amazon CloudFront Developer Guide. +// +// [Viewing additional CloudFront distribution metrics]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional func (c *Client) CreateMonitoringSubscription(ctx context.Context, params *CreateMonitoringSubscriptionInput, optFns ...func(*Options)) (*CreateMonitoringSubscriptionOutput, error) { if params == nil { params = &CreateMonitoringSubscriptionInput{} diff --git a/service/cloudfront/api_op_CreateOriginAccessControl.go b/service/cloudfront/api_op_CreateOriginAccessControl.go index 505c495a4f3..41e9c1cc86e 100644 --- a/service/cloudfront/api_op_CreateOriginAccessControl.go +++ b/service/cloudfront/api_op_CreateOriginAccessControl.go @@ -13,12 +13,15 @@ import ( // Creates a new origin access control in CloudFront. After you create an origin // access control, you can add it to an origin in a CloudFront distribution so that -// CloudFront sends authenticated (signed) requests to the origin. This makes it -// 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) -// in the Amazon CloudFront Developer Guide. +// CloudFront sends authenticated (signed) requests to the origin. +// +// This makes it 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] in +// the Amazon CloudFront Developer Guide. +// +// [Restricting access to an Amazon Web Services origin]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html func (c *Client) CreateOriginAccessControl(ctx context.Context, params *CreateOriginAccessControlInput, optFns ...func(*Options)) (*CreateOriginAccessControlOutput, error) { if params == nil { params = &CreateOriginAccessControlInput{} diff --git a/service/cloudfront/api_op_CreateOriginRequestPolicy.go b/service/cloudfront/api_op_CreateOriginRequestPolicy.go index d33a1c6863e..6f67db4ad11 100644 --- a/service/cloudfront/api_op_CreateOriginRequestPolicy.go +++ b/service/cloudfront/api_op_CreateOriginRequestPolicy.go @@ -11,15 +11,20 @@ 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 -// 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: +// 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 @@ -27,9 +32,12 @@ import ( // // 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. +// them in the cache key, use CachePolicy . +// +// For more information about origin request policies, see [Controlling origin requests] in the Amazon +// CloudFront Developer Guide. +// +// [Controlling origin requests]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html func (c *Client) CreateOriginRequestPolicy(ctx context.Context, params *CreateOriginRequestPolicyInput, optFns ...func(*Options)) (*CreateOriginRequestPolicyOutput, error) { if params == nil { params = &CreateOriginRequestPolicyInput{} diff --git a/service/cloudfront/api_op_CreatePublicKey.go b/service/cloudfront/api_op_CreatePublicKey.go index 06c1fe456d3..e2448110ee1 100644 --- a/service/cloudfront/api_op_CreatePublicKey.go +++ b/service/cloudfront/api_op_CreatePublicKey.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Uploads a public key to CloudFront that you can use with [signed URLs and signed cookies], or with [field-level encryption]. +// +// [signed URLs and signed cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html +// [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 8e21800f082..2df69aa05e5 100644 --- a/service/cloudfront/api_op_CreateRealtimeLogConfig.go +++ b/service/cloudfront/api_op_CreateRealtimeLogConfig.go @@ -11,11 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon CloudFront Developer Guide. +// 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] in the Amazon +// CloudFront Developer Guide. +// +// [Real-time logs]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html func (c *Client) CreateRealtimeLogConfig(ctx context.Context, params *CreateRealtimeLogConfigInput, optFns ...func(*Options)) (*CreateRealtimeLogConfigOutput, error) { if params == nil { params = &CreateRealtimeLogConfigInput{} @@ -39,9 +44,12 @@ type CreateRealtimeLogConfigInput struct { // This member is required. 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) - // in the Amazon CloudFront Developer Guide. + // A list of fields to include in each real-time log record. + // + // For more information about fields, see [Real-time log configuration fields] in the Amazon CloudFront Developer + // Guide. + // + // [Real-time log configuration fields]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields // // This member is required. Fields []string diff --git a/service/cloudfront/api_op_CreateResponseHeadersPolicy.go b/service/cloudfront/api_op_CreateResponseHeadersPolicy.go index fc0a02567cb..8d576245cb6 100644 --- a/service/cloudfront/api_op_CreateResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_CreateResponseHeadersPolicy.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a response headers policy. A response headers policy contains -// information about a set of HTTP headers. To create a response headers policy, -// you provide some metadata about the policy and a set of configurations that -// specify the headers. After you create a response headers policy, you can use its -// ID to attach it to one or more cache behaviors in a CloudFront distribution. -// When it's attached to a cache behavior, the response headers 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) -// in the Amazon CloudFront Developer Guide. +// Creates a response headers policy. +// +// A response headers policy contains information about a set of HTTP headers. To +// create a response headers policy, you provide some metadata about the policy and +// a set of configurations that specify the headers. +// +// After you create a response headers policy, you can use its ID to attach it to +// one or more cache behaviors in a CloudFront distribution. When it's attached to +// a cache behavior, the response headers 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] in the Amazon CloudFront Developer Guide. +// +// [Adding or removing HTTP headers in CloudFront responses]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html func (c *Client) CreateResponseHeadersPolicy(ctx context.Context, params *CreateResponseHeadersPolicyInput, optFns ...func(*Options)) (*CreateResponseHeadersPolicyOutput, error) { if params == nil { params = &CreateResponseHeadersPolicyInput{} diff --git a/service/cloudfront/api_op_CreateStreamingDistribution.go b/service/cloudfront/api_op_CreateStreamingDistribution.go index be10bc1d1cb..77ccefb48e1 100644 --- a/service/cloudfront/api_op_CreateStreamingDistribution.go +++ b/service/cloudfront/api_op_CreateStreamingDistribution.go @@ -12,9 +12,10 @@ import ( ) // This API is deprecated. Amazon CloudFront is deprecating real-time messaging -// protocol (RTMP) distributions on December 31, 2020. For more information, read -// the announcement (http://forums.aws.amazon.com/ann.jspa?annID=7356) on the -// Amazon CloudFront discussion forum. +// protocol (RTMP) distributions on December 31, 2020. For more information, [read the announcement]on +// the Amazon CloudFront discussion forum. +// +// [read the announcement]: http://forums.aws.amazon.com/ann.jspa?annID=7356 func (c *Client) CreateStreamingDistribution(ctx context.Context, params *CreateStreamingDistributionInput, optFns ...func(*Options)) (*CreateStreamingDistributionOutput, error) { if params == nil { params = &CreateStreamingDistributionInput{} diff --git a/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go b/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go index 1cc0113178a..c61d835934a 100644 --- a/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go +++ b/service/cloudfront/api_op_CreateStreamingDistributionWithTags.go @@ -12,9 +12,10 @@ import ( ) // This API is deprecated. Amazon CloudFront is deprecating real-time messaging -// protocol (RTMP) distributions on December 31, 2020. For more information, read -// the announcement (http://forums.aws.amazon.com/ann.jspa?annID=7356) on the -// Amazon CloudFront discussion forum. +// protocol (RTMP) distributions on December 31, 2020. For more information, [read the announcement]on +// the Amazon CloudFront discussion forum. +// +// [read the announcement]: http://forums.aws.amazon.com/ann.jspa?annID=7356 func (c *Client) CreateStreamingDistributionWithTags(ctx context.Context, params *CreateStreamingDistributionWithTagsInput, optFns ...func(*Options)) (*CreateStreamingDistributionWithTagsOutput, error) { if params == nil { params = &CreateStreamingDistributionWithTagsInput{} diff --git a/service/cloudfront/api_op_DeleteCachePolicy.go b/service/cloudfront/api_op_DeleteCachePolicy.go index eccda45ffc8..62457c95fdf 100644 --- a/service/cloudfront/api_op_DeleteCachePolicy.go +++ b/service/cloudfront/api_op_DeleteCachePolicy.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a cache policy. You cannot delete a cache policy if it's attached to a -// 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 . +// Deletes a cache policy. +// +// You cannot delete a cache policy if it's attached to a 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 . func (c *Client) DeleteCachePolicy(ctx context.Context, params *DeleteCachePolicyInput, optFns ...func(*Options)) (*DeleteCachePolicyOutput, error) { if params == nil { params = &DeleteCachePolicyInput{} diff --git a/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go b/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go index 7aacfbad9f2..326228e83c1 100644 --- a/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go +++ b/service/cloudfront/api_op_DeleteContinuousDeploymentPolicy.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a continuous deployment policy. You cannot delete a continuous -// deployment policy that's attached to a primary distribution. First update your -// distribution to remove the continuous deployment policy, then you can delete the -// policy. +// Deletes a continuous deployment policy. +// +// You cannot delete a continuous deployment policy that's attached to a primary +// distribution. First update your distribution to remove the continuous deployment +// policy, then you can delete the policy. func (c *Client) DeleteContinuousDeploymentPolicy(ctx context.Context, params *DeleteContinuousDeploymentPolicyInput, optFns ...func(*Options)) (*DeleteContinuousDeploymentPolicyOutput, error) { if params == nil { params = &DeleteContinuousDeploymentPolicyInput{} diff --git a/service/cloudfront/api_op_DeleteDistribution.go b/service/cloudfront/api_op_DeleteDistribution.go index 5e76c6c71fd..15f5b8cb954 100644 --- a/service/cloudfront/api_op_DeleteDistribution.go +++ b/service/cloudfront/api_op_DeleteDistribution.go @@ -27,31 +27,41 @@ 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: +// 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. // -// 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] // in the Amazon CloudFront Developer Guide. +// +// [Deleting a Distribution]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html type DeleteDistributionInput struct { // The distribution ID. diff --git a/service/cloudfront/api_op_DeleteFunction.go b/service/cloudfront/api_op_DeleteFunction.go index 7aa1f7a168a..ab1ed40a544 100644 --- a/service/cloudfront/api_op_DeleteFunction.go +++ b/service/cloudfront/api_op_DeleteFunction.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error) { if params == nil { params = &DeleteFunctionInput{} diff --git a/service/cloudfront/api_op_DeleteKeyGroup.go b/service/cloudfront/api_op_DeleteKeyGroup.go index 95de611aae1..118782282db 100644 --- a/service/cloudfront/api_op_DeleteKeyGroup.go +++ b/service/cloudfront/api_op_DeleteKeyGroup.go @@ -10,11 +10,15 @@ 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{} diff --git a/service/cloudfront/api_op_DeleteOriginAccessControl.go b/service/cloudfront/api_op_DeleteOriginAccessControl.go index c0f6b302960..b5b6056d862 100644 --- a/service/cloudfront/api_op_DeleteOriginAccessControl.go +++ b/service/cloudfront/api_op_DeleteOriginAccessControl.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a CloudFront origin access control. You cannot delete an origin access -// control if it's in use. First, update all distributions to remove the origin -// access control from all origins, then delete the origin access control. +// Deletes a CloudFront origin access control. +// +// You cannot delete an origin access control if it's in use. First, update all +// distributions to remove the origin access control from all origins, then delete +// the origin access control. func (c *Client) DeleteOriginAccessControl(ctx context.Context, params *DeleteOriginAccessControlInput, optFns ...func(*Options)) (*DeleteOriginAccessControlOutput, error) { if params == nil { params = &DeleteOriginAccessControlInput{} diff --git a/service/cloudfront/api_op_DeleteOriginRequestPolicy.go b/service/cloudfront/api_op_DeleteOriginRequestPolicy.go index 3800aa016a7..32649756b86 100644 --- a/service/cloudfront/api_op_DeleteOriginRequestPolicy.go +++ b/service/cloudfront/api_op_DeleteOriginRequestPolicy.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an origin request policy. You cannot delete an origin request policy if -// it's attached to any cache behaviors. First update your distributions to remove -// 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 . +// Deletes an origin request policy. +// +// You cannot delete an origin request policy if it's attached to any cache +// behaviors. First update your distributions to remove 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 . func (c *Client) DeleteOriginRequestPolicy(ctx context.Context, params *DeleteOriginRequestPolicyInput, optFns ...func(*Options)) (*DeleteOriginRequestPolicyOutput, error) { if params == nil { params = &DeleteOriginRequestPolicyInput{} diff --git a/service/cloudfront/api_op_DeleteRealtimeLogConfig.go b/service/cloudfront/api_op_DeleteRealtimeLogConfig.go index 3fdbb854264..3d9bb443f11 100644 --- a/service/cloudfront/api_op_DeleteRealtimeLogConfig.go +++ b/service/cloudfront/api_op_DeleteRealtimeLogConfig.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a real-time log configuration. You cannot delete a real-time log -// configuration if it's attached to a cache behavior. First update your -// distributions to remove the real-time log configuration from all cache -// behaviors, then delete the real-time log configuration. To delete a real-time -// log configuration, you can provide the configuration's name or its Amazon -// Resource Name (ARN). You must provide at least one. If you provide both, -// CloudFront uses the name to identify the real-time log configuration to delete. +// Deletes a real-time log configuration. +// +// You cannot delete a real-time log configuration if it's attached to a cache +// behavior. First update your distributions to remove the real-time log +// configuration from all cache behaviors, then delete the real-time log +// configuration. +// +// To delete a real-time log configuration, you can provide the configuration's +// name or its Amazon Resource Name (ARN). You must provide at least one. If you +// provide both, CloudFront uses the name to identify the real-time log +// configuration to delete. func (c *Client) DeleteRealtimeLogConfig(ctx context.Context, params *DeleteRealtimeLogConfigInput, optFns ...func(*Options)) (*DeleteRealtimeLogConfigOutput, error) { if params == nil { params = &DeleteRealtimeLogConfigInput{} diff --git a/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go b/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go index 368166b6d29..e5e22f4b0c1 100644 --- a/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_DeleteResponseHeadersPolicy.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a response headers policy. You cannot delete a response headers policy -// if it's attached to a cache behavior. First update your distributions to remove -// 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 . +// Deletes a response headers policy. +// +// You cannot delete a response headers policy if it's attached to a cache +// behavior. First update your distributions to remove 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 . func (c *Client) DeleteResponseHeadersPolicy(ctx context.Context, params *DeleteResponseHeadersPolicyInput, optFns ...func(*Options)) (*DeleteResponseHeadersPolicyOutput, error) { if params == nil { params = &DeleteResponseHeadersPolicyInput{} @@ -33,15 +36,17 @@ 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 + // 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 diff --git a/service/cloudfront/api_op_DeleteStreamingDistribution.go b/service/cloudfront/api_op_DeleteStreamingDistribution.go index 855f7191fc7..8b6a84c0ca3 100644 --- a/service/cloudfront/api_op_DeleteStreamingDistribution.go +++ b/service/cloudfront/api_op_DeleteStreamingDistribution.go @@ -11,33 +11,42 @@ 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: +// 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 -// . +// 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] // in the Amazon CloudFront Developer Guide. +// +// [Deleting a Distribution]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html func (c *Client) DeleteStreamingDistribution(ctx context.Context, params *DeleteStreamingDistributionInput, optFns ...func(*Options)) (*DeleteStreamingDistributionOutput, error) { if params == nil { params = &DeleteStreamingDistributionInput{} diff --git a/service/cloudfront/api_op_DescribeFunction.go b/service/cloudfront/api_op_DescribeFunction.go index eca6aae8a4f..207fd918c28 100644 --- a/service/cloudfront/api_op_DescribeFunction.go +++ b/service/cloudfront/api_op_DescribeFunction.go @@ -12,9 +12,11 @@ import ( ) // 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 . +// 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 . func (c *Client) DescribeFunction(ctx context.Context, params *DescribeFunctionInput, optFns ...func(*Options)) (*DescribeFunctionOutput, error) { if params == nil { params = &DescribeFunctionInput{} diff --git a/service/cloudfront/api_op_GetCachePolicy.go b/service/cloudfront/api_op_GetCachePolicy.go index 6366c72c77f..e58083d5754 100644 --- a/service/cloudfront/api_op_GetCachePolicy.go +++ b/service/cloudfront/api_op_GetCachePolicy.go @@ -12,7 +12,9 @@ import ( ) // Gets a cache policy, including the following metadata: +// // - 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 diff --git a/service/cloudfront/api_op_GetCachePolicyConfig.go b/service/cloudfront/api_op_GetCachePolicyConfig.go index 8b9598172ba..3483f7170e7 100644 --- a/service/cloudfront/api_op_GetCachePolicyConfig.go +++ b/service/cloudfront/api_op_GetCachePolicyConfig.go @@ -11,11 +11,13 @@ 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 -// 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 . +// 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 . func (c *Client) GetCachePolicyConfig(ctx context.Context, params *GetCachePolicyConfigInput, optFns ...func(*Options)) (*GetCachePolicyConfigOutput, error) { if params == nil { params = &GetCachePolicyConfigInput{} diff --git a/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go b/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go index c87beb215ab..78f8f87e18d 100644 --- a/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go +++ b/service/cloudfront/api_op_GetCloudFrontOriginAccessIdentityConfig.go @@ -28,8 +28,9 @@ 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]. +// +// [CloudFrontOriginAccessIdentityConfig]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CloudFrontOriginAccessIdentityConfig.html type GetCloudFrontOriginAccessIdentityConfigInput struct { // The identity's ID. diff --git a/service/cloudfront/api_op_GetDistribution.go b/service/cloudfront/api_op_GetDistribution.go index 97e3a1371c4..d17c2e9ea77 100644 --- a/service/cloudfront/api_op_GetDistribution.go +++ b/service/cloudfront/api_op_GetDistribution.go @@ -180,12 +180,13 @@ type DistributionDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetDistributionInput, *GetDistributionOutput, error) (bool, error) } diff --git a/service/cloudfront/api_op_GetFunction.go b/service/cloudfront/api_op_GetFunction.go index 0b6ab7973dc..9743d4c4d0b 100644 --- a/service/cloudfront/api_op_GetFunction.go +++ b/service/cloudfront/api_op_GetFunction.go @@ -12,9 +12,10 @@ 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 -// must provide the function's name and stage. To get these values, you can use -// ListFunctions . +// 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 . func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optFns ...func(*Options)) (*GetFunctionOutput, error) { if params == nil { params = &GetFunctionInput{} diff --git a/service/cloudfront/api_op_GetInvalidation.go b/service/cloudfront/api_op_GetInvalidation.go index ec7a815111c..fc040a033b6 100644 --- a/service/cloudfront/api_op_GetInvalidation.go +++ b/service/cloudfront/api_op_GetInvalidation.go @@ -50,9 +50,9 @@ type GetInvalidationInput struct { // The returned result of the corresponding request. type GetInvalidationOutput struct { - // The invalidation's information. For more information, see Invalidation Complex - // Type (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html) - // . + // The invalidation's information. For more information, see [Invalidation Complex Type]. + // + // [Invalidation Complex Type]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html Invalidation *types.Invalidation // Metadata pertaining to the operation's result. @@ -182,12 +182,13 @@ type InvalidationCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetInvalidationInput, *GetInvalidationOutput, error) (bool, error) } diff --git a/service/cloudfront/api_op_GetKeyGroup.go b/service/cloudfront/api_op_GetKeyGroup.go index de2e5f23d14..c524760348c 100644 --- a/service/cloudfront/api_op_GetKeyGroup.go +++ b/service/cloudfront/api_op_GetKeyGroup.go @@ -12,10 +12,12 @@ 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 -// group is not referenced in a cache behavior, you can get the identifier using +// 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 group +// is not referenced in a cache behavior, you can get the identifier using // ListKeyGroups . func (c *Client) GetKeyGroup(ctx context.Context, params *GetKeyGroupInput, optFns ...func(*Options)) (*GetKeyGroupOutput, error) { if params == nil { diff --git a/service/cloudfront/api_op_GetKeyGroupConfig.go b/service/cloudfront/api_op_GetKeyGroupConfig.go index 9f8aa87ff23..e9780b45ae0 100644 --- a/service/cloudfront/api_op_GetKeyGroupConfig.go +++ b/service/cloudfront/api_op_GetKeyGroupConfig.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . func (c *Client) GetKeyGroupConfig(ctx context.Context, params *GetKeyGroupConfigInput, optFns ...func(*Options)) (*GetKeyGroupConfigOutput, error) { if params == nil { params = &GetKeyGroupConfigInput{} diff --git a/service/cloudfront/api_op_GetOriginRequestPolicy.go b/service/cloudfront/api_op_GetOriginRequestPolicy.go index e35e4a51730..93022bbfc91 100644 --- a/service/cloudfront/api_op_GetOriginRequestPolicy.go +++ b/service/cloudfront/api_op_GetOriginRequestPolicy.go @@ -12,7 +12,9 @@ import ( ) // Gets an origin request policy, including the following metadata: +// // - 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 diff --git a/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go b/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go index 7e3f6379f41..c34ee74723f 100644 --- a/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go +++ b/service/cloudfront/api_op_GetOriginRequestPolicyConfig.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// policy is not attached to a cache behavior, you can get the identifier using -// ListOriginRequestPolicies . +// 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 policy is not attached to a cache +// behavior, you can get the identifier using ListOriginRequestPolicies . func (c *Client) GetOriginRequestPolicyConfig(ctx context.Context, params *GetOriginRequestPolicyConfigInput, optFns ...func(*Options)) (*GetOriginRequestPolicyConfigOutput, error) { if params == nil { params = &GetOriginRequestPolicyConfigInput{} diff --git a/service/cloudfront/api_op_GetRealtimeLogConfig.go b/service/cloudfront/api_op_GetRealtimeLogConfig.go index dfcc748c9ed..f6cf74c2f60 100644 --- a/service/cloudfront/api_op_GetRealtimeLogConfig.go +++ b/service/cloudfront/api_op_GetRealtimeLogConfig.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a real-time log configuration. To get a real-time log configuration, you -// can provide the configuration's name or its Amazon Resource Name (ARN). You must -// provide at least one. If you provide both, CloudFront uses the name to identify -// the real-time log configuration to get. +// Gets a real-time log configuration. +// +// To get a real-time log configuration, you can provide the configuration's name +// or its Amazon Resource Name (ARN). You must provide at least one. If you provide +// both, CloudFront uses the name to identify the real-time log configuration to +// get. func (c *Client) GetRealtimeLogConfig(ctx context.Context, params *GetRealtimeLogConfigInput, optFns ...func(*Options)) (*GetRealtimeLogConfigOutput, error) { if params == nil { params = &GetRealtimeLogConfigInput{} diff --git a/service/cloudfront/api_op_GetResponseHeadersPolicy.go b/service/cloudfront/api_op_GetResponseHeadersPolicy.go index 2885c96a652..fd2c464d34d 100644 --- a/service/cloudfront/api_op_GetResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_GetResponseHeadersPolicy.go @@ -12,12 +12,13 @@ import ( ) // Gets a response headers policy, including metadata (the policy's identifier and -// 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 -// policy is not attached to a cache behavior, you can get the identifier using -// ListResponseHeadersPolicies . +// 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 policy is not attached to a cache behavior, you can get the +// identifier using ListResponseHeadersPolicies . func (c *Client) GetResponseHeadersPolicy(ctx context.Context, params *GetResponseHeadersPolicyInput, optFns ...func(*Options)) (*GetResponseHeadersPolicyOutput, error) { if params == nil { params = &GetResponseHeadersPolicyInput{} @@ -35,11 +36,12 @@ func (c *Client) GetResponseHeadersPolicy(ctx context.Context, params *GetRespon 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 - // policy is not attached to a cache behavior, you can get the identifier using - // ListResponseHeadersPolicies . + // 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 policy is not attached to a cache behavior, you can get + // the identifier using ListResponseHeadersPolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go b/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go index df7b2c76005..19257161ddd 100644 --- a/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go +++ b/service/cloudfront/api_op_GetResponseHeadersPolicyConfig.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// policy is not attached to a cache behavior, you can get the identifier using -// ListResponseHeadersPolicies . +// 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 policy is not attached to a cache +// behavior, you can get the identifier using ListResponseHeadersPolicies . func (c *Client) GetResponseHeadersPolicyConfig(ctx context.Context, params *GetResponseHeadersPolicyConfigInput, optFns ...func(*Options)) (*GetResponseHeadersPolicyConfigOutput, error) { if params == nil { params = &GetResponseHeadersPolicyConfigInput{} @@ -34,11 +35,12 @@ func (c *Client) GetResponseHeadersPolicyConfig(ctx context.Context, params *Get 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 - // policy is not attached to a cache behavior, you can get the identifier using - // ListResponseHeadersPolicies . + // 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 policy is not attached to a cache behavior, you can get + // the identifier using ListResponseHeadersPolicies . // // This member is required. Id *string diff --git a/service/cloudfront/api_op_GetStreamingDistribution.go b/service/cloudfront/api_op_GetStreamingDistribution.go index be29f71d349..d50f09955b4 100644 --- a/service/cloudfront/api_op_GetStreamingDistribution.go +++ b/service/cloudfront/api_op_GetStreamingDistribution.go @@ -181,12 +181,13 @@ type StreamingDistributionDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingDistributionInput, *GetStreamingDistributionOutput, error) (bool, error) } diff --git a/service/cloudfront/api_op_ListCachePolicies.go b/service/cloudfront/api_op_ListCachePolicies.go index 1b90a20f59e..dcade530ba6 100644 --- a/service/cloudfront/api_op_ListCachePolicies.go +++ b/service/cloudfront/api_op_ListCachePolicies.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of cache policies. You can optionally apply a filter to return only -// the managed policies created by Amazon Web Services, or only the custom policies -// created in your Amazon Web Services 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 a subsequent request -// that specifies the NextMarker value from the current response as the Marker -// value in the subsequent request. +// Gets a list of cache policies. +// +// You can optionally apply a filter to return only the managed policies created +// by Amazon Web Services, or only the custom policies created in your Amazon Web +// Services 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 a subsequent request that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListCachePolicies(ctx context.Context, params *ListCachePoliciesInput, optFns ...func(*Options)) (*ListCachePoliciesOutput, error) { if params == nil { params = &ListCachePoliciesInput{} @@ -45,9 +48,10 @@ type ListCachePoliciesInput struct { // The maximum number of cache policies that you want in the response. MaxItems *int32 - // A filter to return only the specified kinds of cache policies. Valid values - // are: + // 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. Type types.CachePolicyType diff --git a/service/cloudfront/api_op_ListConflictingAliases.go b/service/cloudfront/api_op_ListConflictingAliases.go index 697874db546..fc86240a8ff 100644 --- a/service/cloudfront/api_op_ListConflictingAliases.go +++ b/service/cloudfront/api_op_ListConflictingAliases.go @@ -16,24 +16,28 @@ import ( // distributions and Amazon Web Services accounts for each conflicting alias. In // the returned list, the distribution and account IDs are partially hidden, which // allows you to identify the distributions and accounts that you own, but helps to -// 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 -// 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 -// 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) -// 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 -// 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. +// 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 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 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]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 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. +// +// [Moving an alternate domain name to a different distribution]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move func (c *Client) ListConflictingAliases(ctx context.Context, params *ListConflictingAliasesInput, optFns ...func(*Options)) (*ListConflictingAliasesOutput, error) { if params == nil { params = &ListConflictingAliasesInput{} diff --git a/service/cloudfront/api_op_ListContinuousDeploymentPolicies.go b/service/cloudfront/api_op_ListContinuousDeploymentPolicies.go index 7b5c6fa504d..149a9aeb3c1 100644 --- a/service/cloudfront/api_op_ListContinuousDeploymentPolicies.go +++ b/service/cloudfront/api_op_ListContinuousDeploymentPolicies.go @@ -12,11 +12,13 @@ import ( ) // Gets a list of the continuous deployment policies in your Amazon Web Services -// 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 a subsequent request that specifies the NextMarker value -// from the current response as the Marker value in the subsequent request. +// 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 a subsequent request that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListContinuousDeploymentPolicies(ctx context.Context, params *ListContinuousDeploymentPoliciesInput, optFns ...func(*Options)) (*ListContinuousDeploymentPoliciesOutput, error) { if params == nil { params = &ListContinuousDeploymentPoliciesInput{} diff --git a/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go b/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go index 0e00eec6064..d1c900bcc6a 100644 --- a/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByCachePolicyId.go @@ -12,12 +12,13 @@ import ( ) // Gets a list of distribution IDs for distributions that have a cache behavior -// that's associated with the specified cache policy. 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 that specifies the NextMarker value from the current response as the -// Marker value in the subsequent request. +// that's associated with the specified cache policy. +// +// 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 that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListDistributionsByCachePolicyId(ctx context.Context, params *ListDistributionsByCachePolicyIdInput, optFns ...func(*Options)) (*ListDistributionsByCachePolicyIdOutput, error) { if params == nil { params = &ListDistributionsByCachePolicyIdInput{} diff --git a/service/cloudfront/api_op_ListDistributionsByKeyGroup.go b/service/cloudfront/api_op_ListDistributionsByKeyGroup.go index c31a1eaf3a2..5631e0e84e9 100644 --- a/service/cloudfront/api_op_ListDistributionsByKeyGroup.go +++ b/service/cloudfront/api_op_ListDistributionsByKeyGroup.go @@ -12,12 +12,13 @@ import ( ) // Gets a list of distribution IDs for distributions that have a cache behavior -// that references the specified key group. 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 that -// specifies the NextMarker value from the current response as the Marker value in -// the subsequent request. +// that references the specified key group. +// +// 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 that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListDistributionsByKeyGroup(ctx context.Context, params *ListDistributionsByKeyGroupInput, optFns ...func(*Options)) (*ListDistributionsByKeyGroupOutput, error) { if params == nil { params = &ListDistributionsByKeyGroupInput{} diff --git a/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go b/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go index 91e8cc4759c..ad4083b7832 100644 --- a/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByOriginRequestPolicyId.go @@ -12,12 +12,13 @@ import ( ) // Gets a list of distribution IDs for distributions that have a cache behavior -// that's associated with the specified origin request policy. 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 that specifies the NextMarker value from the current -// response as the Marker value in the subsequent request. +// that's associated with the specified origin request policy. +// +// 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 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 cacdef20fca..e062c50f1c0 100644 --- a/service/cloudfront/api_op_ListDistributionsByRealtimeLogConfig.go +++ b/service/cloudfront/api_op_ListDistributionsByRealtimeLogConfig.go @@ -12,15 +12,18 @@ import ( ) // Gets a list of distributions that have a cache behavior that's associated with -// the specified real-time log configuration. You can specify the real-time log -// configuration by its name or its Amazon Resource Name (ARN). You must provide at -// least one. If you provide both, CloudFront uses the name to identify the -// real-time log configuration to list distributions for. 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 that specifies the NextMarker value from the current -// response as the Marker value in the subsequent request. +// the specified real-time log configuration. +// +// You can specify the real-time log configuration by its name or its Amazon +// Resource Name (ARN). You must provide at least one. If you provide both, +// CloudFront uses the name to identify the real-time log configuration to list +// distributions for. +// +// 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 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 5bd905b0000..45b8bf5d5f4 100644 --- a/service/cloudfront/api_op_ListDistributionsByResponseHeadersPolicyId.go +++ b/service/cloudfront/api_op_ListDistributionsByResponseHeadersPolicyId.go @@ -12,12 +12,13 @@ import ( ) // Gets a list of distribution IDs for distributions that have a cache behavior -// that's associated with the specified response headers policy. 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 that specifies the NextMarker value from the current -// response as the Marker value in the subsequent request. +// that's associated with the specified response headers policy. +// +// 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 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{} diff --git a/service/cloudfront/api_op_ListDistributionsByWebACLId.go b/service/cloudfront/api_op_ListDistributionsByWebACLId.go index fee09601c58..883cd8d38de 100644 --- a/service/cloudfront/api_op_ListDistributionsByWebACLId.go +++ b/service/cloudfront/api_op_ListDistributionsByWebACLId.go @@ -33,10 +33,13 @@ 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. For WAFV2, this is the ARN - // of the web ACL, such as + // distributions that aren't associated with a web ACL. + // + // For WAFV2, this is the ARN of the web ACL, such as // arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 - // . For WAF Classic, this is the ID of the web ACL, such as + // . + // + // For WAF Classic, this is the ID of the web ACL, such as // a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . // // This member is required. diff --git a/service/cloudfront/api_op_ListFunctions.go b/service/cloudfront/api_op_ListFunctions.go index a4ebe31c1d7..24c0c515a52 100644 --- a/service/cloudfront/api_op_ListFunctions.go +++ b/service/cloudfront/api_op_ListFunctions.go @@ -12,13 +12,15 @@ import ( ) // 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 -// that specifies the NextMarker value from the current response as the Marker -// value in the subsequent request. +// 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 that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListFunctions(ctx context.Context, params *ListFunctionsInput, optFns ...func(*Options)) (*ListFunctionsOutput, error) { if params == nil { params = &ListFunctionsInput{} diff --git a/service/cloudfront/api_op_ListKeyGroups.go b/service/cloudfront/api_op_ListKeyGroups.go index 1ce48bd2c58..e0554115d7d 100644 --- a/service/cloudfront/api_op_ListKeyGroups.go +++ b/service/cloudfront/api_op_ListKeyGroups.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of key groups. 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 that -// specifies the NextMarker value from the current response as the Marker value in -// the subsequent request. +// Gets a list of key groups. +// +// 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 that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListKeyGroups(ctx context.Context, params *ListKeyGroupsInput, optFns ...func(*Options)) (*ListKeyGroupsOutput, error) { if params == nil { params = &ListKeyGroupsInput{} diff --git a/service/cloudfront/api_op_ListOriginAccessControls.go b/service/cloudfront/api_op_ListOriginAccessControls.go index ce20e768546..a79a38484e7 100644 --- a/service/cloudfront/api_op_ListOriginAccessControls.go +++ b/service/cloudfront/api_op_ListOriginAccessControls.go @@ -12,11 +12,13 @@ import ( ) // Gets the list of CloudFront origin access controls in this Amazon Web Services -// 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. +// 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. 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 7ab39e75bbf..bc87ea8e2e6 100644 --- a/service/cloudfront/api_op_ListOriginRequestPolicies.go +++ b/service/cloudfront/api_op_ListOriginRequestPolicies.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of origin request policies. You can optionally apply a filter to -// return only the managed policies created by Amazon Web Services, or only the -// custom policies created in your Amazon Web Services 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 a -// subsequent request that specifies the NextMarker value from the current -// response as the Marker value in the subsequent request. +// Gets a list of origin request policies. +// +// You can optionally apply a filter to return only the managed policies created +// by Amazon Web Services, or only the custom policies created in your Amazon Web +// Services 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 a 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,7 +50,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. Type types.OriginRequestPolicyType diff --git a/service/cloudfront/api_op_ListRealtimeLogConfigs.go b/service/cloudfront/api_op_ListRealtimeLogConfigs.go index 34562638384..ec901262b6b 100644 --- a/service/cloudfront/api_op_ListRealtimeLogConfigs.go +++ b/service/cloudfront/api_op_ListRealtimeLogConfigs.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of real-time log configurations. 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 -// that specifies the NextMarker value from the current response as the Marker -// value in the subsequent request. +// Gets a list of real-time log configurations. +// +// 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 that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListRealtimeLogConfigs(ctx context.Context, params *ListRealtimeLogConfigsInput, optFns ...func(*Options)) (*ListRealtimeLogConfigsOutput, error) { if params == nil { params = &ListRealtimeLogConfigsInput{} diff --git a/service/cloudfront/api_op_ListResponseHeadersPolicies.go b/service/cloudfront/api_op_ListResponseHeadersPolicies.go index b7c0a5b9463..c479d811675 100644 --- a/service/cloudfront/api_op_ListResponseHeadersPolicies.go +++ b/service/cloudfront/api_op_ListResponseHeadersPolicies.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of response headers policies. You can optionally apply a filter to -// get only the managed policies created by Amazon Web Services, or only the custom -// policies created in your Amazon Web Services 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 a subsequent -// request that specifies the NextMarker value from the current response as the -// Marker value in the subsequent request. +// Gets a list of response headers policies. +// +// You can optionally apply a filter to get only the managed policies created by +// Amazon Web Services, or only the custom policies created in your Amazon Web +// Services 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 a subsequent request that specifies the NextMarker value from +// the current response as the Marker value in the subsequent request. func (c *Client) ListResponseHeadersPolicies(ctx context.Context, params *ListResponseHeadersPoliciesInput, optFns ...func(*Options)) (*ListResponseHeadersPoliciesOutput, error) { if params == nil { params = &ListResponseHeadersPoliciesInput{} @@ -48,7 +51,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. Type types.ResponseHeadersPolicyType diff --git a/service/cloudfront/api_op_PublishFunction.go b/service/cloudfront/api_op_PublishFunction.go index dca058534f3..fac1a5d85ce 100644 --- a/service/cloudfront/api_op_PublishFunction.go +++ b/service/cloudfront/api_op_PublishFunction.go @@ -13,9 +13,12 @@ import ( // Publishes a CloudFront function by copying the function code from the // 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). +// 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 . func (c *Client) PublishFunction(ctx context.Context, params *PublishFunctionInput, optFns ...func(*Options)) (*PublishFunctionOutput, error) { diff --git a/service/cloudfront/api_op_TestFunction.go b/service/cloudfront/api_op_TestFunction.go index b3b58dbf9be..8331f7be1d8 100644 --- a/service/cloudfront/api_op_TestFunction.go +++ b/service/cloudfront/api_op_TestFunction.go @@ -11,16 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tests a CloudFront function. To test a function, you provide an event object -// that represents an HTTP request or response that your CloudFront distribution -// could receive in production. CloudFront runs the function, passing it the event -// 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) -// 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 . +// Tests a CloudFront function. +// +// To test a function, you provide an event object that represents an HTTP request +// or response that your CloudFront distribution could receive in production. +// CloudFront runs the function, passing it the event 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]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 . +// +// [Testing functions]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function func (c *Client) TestFunction(ctx context.Context, params *TestFunctionInput, optFns ...func(*Options)) (*TestFunctionOutput, error) { if params == nil { params = &TestFunctionInput{} @@ -39,8 +44,9 @@ 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) - // in the Amazon CloudFront Developer Guide. + // structure of the event object, see [Testing functions]in the Amazon CloudFront Developer Guide. + // + // [Testing functions]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function // // This member is required. EventObject []byte diff --git a/service/cloudfront/api_op_UpdateCachePolicy.go b/service/cloudfront/api_op_UpdateCachePolicy.go index 355a5306782..0505a803d1c 100644 --- a/service/cloudfront/api_op_UpdateCachePolicy.go +++ b/service/cloudfront/api_op_UpdateCachePolicy.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a cache policy configuration. When you update a cache policy -// 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: +// Updates a cache policy configuration. +// +// When you update a cache policy 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. func (c *Client) UpdateCachePolicy(ctx context.Context, params *UpdateCachePolicyInput, optFns ...func(*Options)) (*UpdateCachePolicyOutput, error) { diff --git a/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go b/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go index 2ac58c697c2..d046b3ace23 100644 --- a/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go +++ b/service/cloudfront/api_op_UpdateContinuousDeploymentPolicy.go @@ -14,13 +14,18 @@ import ( // Updates a continuous deployment policy. You can update a continuous deployment // policy to enable or disable it, to change the percentage of traffic that it // sends to the staging distribution, or to change the staging distribution that it -// sends traffic to. When you update a continuous deployment policy configuration, -// 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: +// sends traffic to. +// +// When you update a continuous deployment policy configuration, 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. diff --git a/service/cloudfront/api_op_UpdateDistribution.go b/service/cloudfront/api_op_UpdateDistribution.go index 74e1f4c4ae1..94404310d3a 100644 --- a/service/cloudfront/api_op_UpdateDistribution.go +++ b/service/cloudfront/api_op_UpdateDistribution.go @@ -11,17 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the configuration for a CloudFront distribution. The update process -// 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 +// Updates the configuration for a CloudFront distribution. +// +// The update process 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 diff --git a/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go b/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go index 206b607176e..4475807af93 100644 --- a/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go +++ b/service/cloudfront/api_op_UpdateDistributionWithStagingConfig.go @@ -15,16 +15,23 @@ import ( // distribution. The primary distribution retains its Aliases (also known as // alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, but // otherwise its configuration is overwritten to match the staging distribution. +// // You can use this operation in a continuous deployment workflow after you have // tested configuration changes on the staging distribution. After using a // continuous deployment policy to move a portion of your domain name's traffic to // the staging distribution and verifying that it works as intended, you can use // this operation to copy the staging distribution's configuration to the primary // distribution. This action will disable the continuous deployment policy and move -// your domain's traffic back to the primary distribution. This API operation -// requires the following IAM permissions: -// - GetDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html) -// - UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html) +// your domain's traffic back to the primary distribution. +// +// This API operation requires the following IAM permissions: +// +// [GetDistribution] +// +// [UpdateDistribution] +// +// [GetDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html +// [UpdateDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html func (c *Client) UpdateDistributionWithStagingConfig(ctx context.Context, params *UpdateDistributionWithStagingConfigInput, optFns ...func(*Options)) (*UpdateDistributionWithStagingConfigOutput, error) { if params == nil { params = &UpdateDistributionWithStagingConfigInput{} @@ -49,7 +56,9 @@ type UpdateDistributionWithStagingConfigInput struct { Id *string // The current versions ( ETag values) of both primary and staging distributions. - // Provide these in the following format: , + // Provide these in the following format: + // + // , IfMatch *string // The identifier of the staging distribution whose configuration you are copying diff --git a/service/cloudfront/api_op_UpdateFunction.go b/service/cloudfront/api_op_UpdateFunction.go index 2449f93ee73..a688f0fa40e 100644 --- a/service/cloudfront/api_op_UpdateFunction.go +++ b/service/cloudfront/api_op_UpdateFunction.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// the updated function code. To get the name and version, you can use +// 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 the updated function code. To get the name and version, you can use // ListFunctions and DescribeFunction . func (c *Client) UpdateFunction(ctx context.Context, params *UpdateFunctionInput, optFns ...func(*Options)) (*UpdateFunctionOutput, error) { if params == nil { @@ -34,8 +37,9 @@ 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) - // in the Amazon CloudFront Developer Guide. + // see [Writing function code for CloudFront Functions]in the Amazon CloudFront Developer Guide. + // + // [Writing function code for CloudFront Functions]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html // // This member is required. FunctionCode []byte diff --git a/service/cloudfront/api_op_UpdateKeyGroup.go b/service/cloudfront/api_op_UpdateKeyGroup.go index 1014fa6d63b..2c81e202431 100644 --- a/service/cloudfront/api_op_UpdateKeyGroup.go +++ b/service/cloudfront/api_op_UpdateKeyGroup.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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. func (c *Client) UpdateKeyGroup(ctx context.Context, params *UpdateKeyGroupInput, optFns ...func(*Options)) (*UpdateKeyGroupOutput, error) { diff --git a/service/cloudfront/api_op_UpdateOriginRequestPolicy.go b/service/cloudfront/api_op_UpdateOriginRequestPolicy.go index bb05384cfdc..b6e7cb13caa 100644 --- a/service/cloudfront/api_op_UpdateOriginRequestPolicy.go +++ b/service/cloudfront/api_op_UpdateOriginRequestPolicy.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an origin request policy configuration. When you update an origin -// 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: +// Updates an origin request policy configuration. +// +// When you update an origin 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. func (c *Client) UpdateOriginRequestPolicy(ctx context.Context, params *UpdateOriginRequestPolicyInput, optFns ...func(*Options)) (*UpdateOriginRequestPolicyOutput, error) { diff --git a/service/cloudfront/api_op_UpdateRealtimeLogConfig.go b/service/cloudfront/api_op_UpdateRealtimeLogConfig.go index 6caa9caab42..293dbb9e250 100644 --- a/service/cloudfront/api_op_UpdateRealtimeLogConfig.go +++ b/service/cloudfront/api_op_UpdateRealtimeLogConfig.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a real-time log configuration. When you update a real-time log -// 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: +// Updates a real-time log configuration. +// +// When you update a real-time log 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. @@ -47,9 +51,12 @@ type UpdateRealtimeLogConfigInput struct { // real-time log data. 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) - // in the Amazon CloudFront Developer Guide. + // A list of fields to include in each real-time log record. + // + // For more information about fields, see [Real-time log configuration fields] in the Amazon CloudFront Developer + // Guide. + // + // [Real-time log configuration fields]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields Fields []string // The name for this real-time log configuration. diff --git a/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go b/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go index 5831ac7651a..5b275009f58 100644 --- a/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go +++ b/service/cloudfront/api_op_UpdateResponseHeadersPolicy.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. @@ -48,8 +52,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 + // 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 diff --git a/service/cloudfront/doc.go b/service/cloudfront/doc.go index 2ee6909ec70..4990906f987 100644 --- a/service/cloudfront/doc.go +++ b/service/cloudfront/doc.go @@ -3,9 +3,11 @@ // 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 -// types, and errors. For detailed information about CloudFront features, see the -// Amazon CloudFront Developer Guide (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html) -// . +// # 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]. +// +// [Amazon CloudFront Developer Guide]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html package cloudfront diff --git a/service/cloudfront/options.go b/service/cloudfront/options.go index 502c0ce28de..d66af19e7ed 100644 --- a/service/cloudfront/options.go +++ b/service/cloudfront/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudfront/types/enums.go b/service/cloudfront/types/enums.go index ec063218316..c530f123fe4 100644 --- a/service/cloudfront/types/enums.go +++ b/service/cloudfront/types/enums.go @@ -14,6 +14,7 @@ const ( // Values returns all known values for CachePolicyCookieBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CachePolicyCookieBehavior) Values() []CachePolicyCookieBehavior { return []CachePolicyCookieBehavior{ @@ -34,6 +35,7 @@ const ( // Values returns all known values for CachePolicyHeaderBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CachePolicyHeaderBehavior) Values() []CachePolicyHeaderBehavior { return []CachePolicyHeaderBehavior{ @@ -54,8 +56,9 @@ const ( // Values returns all known values for CachePolicyQueryStringBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CachePolicyQueryStringBehavior) Values() []CachePolicyQueryStringBehavior { return []CachePolicyQueryStringBehavior{ "none", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for CachePolicyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CachePolicyType) Values() []CachePolicyType { return []CachePolicyType{ "managed", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for CertificateSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateSource) Values() []CertificateSource { return []CertificateSource{ "cloudfront", @@ -113,8 +118,9 @@ const ( // Values returns all known values for ContinuousDeploymentPolicyType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContinuousDeploymentPolicyType) Values() []ContinuousDeploymentPolicyType { return []ContinuousDeploymentPolicyType{ "SingleWeight", @@ -133,8 +139,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -152,8 +159,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "URLEncoded", @@ -169,8 +177,9 @@ const ( ) // Values returns all known values for FrameOptionsList. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FrameOptionsList) Values() []FrameOptionsList { return []FrameOptionsList{ "DENY", @@ -187,8 +196,9 @@ const ( ) // Values returns all known values for FunctionRuntime. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FunctionRuntime) Values() []FunctionRuntime { return []FunctionRuntime{ "cloudfront-js-1.0", @@ -205,8 +215,9 @@ const ( ) // Values returns all known values for FunctionStage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FunctionStage) Values() []FunctionStage { return []FunctionStage{ "DEVELOPMENT", @@ -224,8 +235,9 @@ const ( ) // Values returns all known values for GeoRestrictionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoRestrictionType) Values() []GeoRestrictionType { return []GeoRestrictionType{ "blacklist", @@ -245,8 +257,9 @@ const ( ) // Values returns all known values for HttpVersion. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpVersion) Values() []HttpVersion { return []HttpVersion{ "http1.1", @@ -266,8 +279,9 @@ const ( ) // Values returns all known values for ICPRecordalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ICPRecordalStatus) Values() []ICPRecordalStatus { return []ICPRecordalStatus{ "APPROVED", @@ -284,8 +298,9 @@ const ( ) // Values returns all known values for ImportSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportSourceType) Values() []ImportSourceType { return []ImportSourceType{ "S3", @@ -302,8 +317,9 @@ const ( ) // Values returns all known values for ItemSelection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ItemSelection) Values() []ItemSelection { return []ItemSelection{ "none", @@ -326,8 +342,9 @@ const ( ) // Values returns all known values for Method. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Method) Values() []Method { return []Method{ "GET", @@ -354,8 +371,9 @@ const ( ) // Values returns all known values for MinimumProtocolVersion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MinimumProtocolVersion) Values() []MinimumProtocolVersion { return []MinimumProtocolVersion{ "SSLv3", @@ -380,8 +398,9 @@ const ( // Values returns all known values for OriginAccessControlOriginTypes. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginAccessControlOriginTypes) Values() []OriginAccessControlOriginTypes { return []OriginAccessControlOriginTypes{ "s3", @@ -402,8 +421,9 @@ const ( // Values returns all known values for OriginAccessControlSigningBehaviors. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginAccessControlSigningBehaviors) Values() []OriginAccessControlSigningBehaviors { return []OriginAccessControlSigningBehaviors{ "never", @@ -421,8 +441,9 @@ const ( // Values returns all known values for OriginAccessControlSigningProtocols. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginAccessControlSigningProtocols) Values() []OriginAccessControlSigningProtocols { return []OriginAccessControlSigningProtocols{ "sigv4", @@ -439,8 +460,9 @@ const ( ) // Values returns all known values for OriginProtocolPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginProtocolPolicy) Values() []OriginProtocolPolicy { return []OriginProtocolPolicy{ "http-only", @@ -461,8 +483,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginRequestPolicyCookieBehavior) Values() []OriginRequestPolicyCookieBehavior { return []OriginRequestPolicyCookieBehavior{ "none", @@ -485,8 +508,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginRequestPolicyHeaderBehavior) Values() []OriginRequestPolicyHeaderBehavior { return []OriginRequestPolicyHeaderBehavior{ "none", @@ -509,8 +533,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginRequestPolicyQueryStringBehavior) Values() []OriginRequestPolicyQueryStringBehavior { return []OriginRequestPolicyQueryStringBehavior{ "none", @@ -529,8 +554,9 @@ const ( ) // Values returns all known values for OriginRequestPolicyType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginRequestPolicyType) Values() []OriginRequestPolicyType { return []OriginRequestPolicyType{ "managed", @@ -548,8 +574,9 @@ const ( ) // Values returns all known values for PriceClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PriceClass) Values() []PriceClass { return []PriceClass{ "PriceClass_100", @@ -568,8 +595,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealtimeMetricsSubscriptionStatus) Values() []RealtimeMetricsSubscriptionStatus { return []RealtimeMetricsSubscriptionStatus{ "Enabled", @@ -592,8 +620,9 @@ const ( ) // Values returns all known values for ReferrerPolicyList. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferrerPolicyList) Values() []ReferrerPolicyList { return []ReferrerPolicyList{ "no-referrer", @@ -623,8 +652,9 @@ const ( // Values returns all known values for // ResponseHeadersPolicyAccessControlAllowMethodsValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResponseHeadersPolicyAccessControlAllowMethodsValues) Values() []ResponseHeadersPolicyAccessControlAllowMethodsValues { return []ResponseHeadersPolicyAccessControlAllowMethodsValues{ "GET", @@ -648,6 +678,7 @@ const ( // Values returns all known values for ResponseHeadersPolicyType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResponseHeadersPolicyType) Values() []ResponseHeadersPolicyType { return []ResponseHeadersPolicyType{ @@ -667,8 +698,9 @@ const ( ) // Values returns all known values for SslProtocol. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SslProtocol) Values() []SslProtocol { return []SslProtocol{ "SSLv3", @@ -688,8 +720,9 @@ const ( ) // Values returns all known values for SSLSupportMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SSLSupportMethod) Values() []SSLSupportMethod { return []SSLSupportMethod{ "sni-only", @@ -708,8 +741,9 @@ const ( ) // Values returns all known values for ViewerProtocolPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViewerProtocolPolicy) Values() []ViewerProtocolPolicy { return []ViewerProtocolPolicy{ "allow-all", diff --git a/service/cloudfront/types/errors.go b/service/cloudfront/types/errors.go index fdfcdb3ce6e..c0043671003 100644 --- a/service/cloudfront/types/errors.go +++ b/service/cloudfront/types/errors.go @@ -656,8 +656,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// The function is too large. For more information, see [Quotas] (formerly known as +// limits) in the Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type FunctionSizeLimitExceeded struct { Message *string @@ -2520,8 +2522,12 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// policy exceeds the maximum. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooLongCSPInResponseHeadersPolicy struct { Message *string @@ -2574,8 +2580,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// Services account. For more information, see [Quotas](formerly known as limits) in the +// Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyCachePolicies struct { Message *string @@ -2713,8 +2721,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// information, see [Quotas](formerly known as limits) in the Amazon CloudFront Developer +// Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyCookiesInCachePolicy struct { Message *string @@ -2741,8 +2751,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// more information, see [Quotas](formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyCookiesInOriginRequestPolicy struct { Message *string @@ -2770,9 +2782,12 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// The number of custom headers in the response headers policy exceeds the maximum. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyCustomHeadersInResponseHeadersPolicy struct { Message *string @@ -2854,8 +2869,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// cache policy. For more information, see [Quotas](formerly known as limits) in the +// Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyDistributionsAssociatedToCachePolicy struct { Message *string @@ -2913,8 +2930,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// maximum allowed. For more information, see [Quotas](formerly known as limits) in the +// Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyDistributionsAssociatedToKeyGroup struct { Message *string @@ -2943,8 +2962,12 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// origin access control. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyDistributionsAssociatedToOriginAccessControl struct { Message *string @@ -2973,8 +2996,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// origin request policy. For more information, see [Quotas](formerly known as limits) in +// the Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyDistributionsAssociatedToOriginRequestPolicy struct { Message *string @@ -3003,8 +3028,12 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// response headers policy. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyDistributionsAssociatedToResponseHeadersPolicy struct { Message *string @@ -3033,8 +3062,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// CloudFront function. For more information, see [Quotas](formerly known as limits) in +// the Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyDistributionsWithFunctionAssociations struct { Message *string @@ -3294,8 +3325,10 @@ func (e *TooManyFieldLevelEncryptionQueryArgProfiles) ErrorFault() smithy.ErrorF } // 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. +// this distribution. For more information, see [Quotas](formerly known as limits) in the +// Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyFunctionAssociations struct { Message *string @@ -3322,8 +3355,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// Services account. For more information, see [Quotas](formerly known as limits) in the +// Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyFunctions struct { Message *string @@ -3350,8 +3385,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// information, see [Quotas](formerly known as limits) in the Amazon CloudFront Developer +// Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyHeadersInCachePolicy struct { Message *string @@ -3404,8 +3441,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// more information, see [Quotas](formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyHeadersInOriginRequestPolicy struct { Message *string @@ -3461,8 +3500,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// account. For more information, see [Quotas](formerly known as limits) in the Amazon +// CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyKeyGroups struct { Message *string @@ -3489,8 +3530,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// maximum allowed. For more information, see [Quotas](formerly known as limits) in the +// Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyKeyGroupsAssociatedToDistribution struct { Message *string @@ -3546,8 +3589,12 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// exceeds the maximum allowed. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyOriginAccessControls struct { Message *string @@ -3629,8 +3676,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// Web Services account. For more information, see [Quotas](formerly known as limits) in +// the Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyOriginRequestPolicies struct { Message *string @@ -3710,8 +3759,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// For more information, see [Quotas](formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyPublicKeysInKeyGroup struct { Message *string @@ -3764,8 +3815,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// information, see [Quotas](formerly known as limits) in the Amazon CloudFront Developer +// Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyQueryStringsInCachePolicy struct { Message *string @@ -3792,8 +3845,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// For more information, see [Quotas](formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyQueryStringsInOriginRequestPolicy struct { Message *string @@ -3822,8 +3877,10 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// Amazon Web Services account. For more information, see [Quotas](formerly known as +// limits) in the Amazon CloudFront Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyRealtimeLogConfigs struct { Message *string @@ -3850,8 +3907,12 @@ 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) -// (formerly known as limits) in the Amazon CloudFront Developer Guide. +// exceeds the maximum. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyRemoveHeadersInResponseHeadersPolicy struct { Message *string @@ -3880,8 +3941,12 @@ func (e *TooManyRemoveHeadersInResponseHeadersPolicy) ErrorFault() smithy.ErrorF } // 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. +// Amazon Web Services account. +// +// For more information, see [Quotas] (formerly known as limits) in the Amazon CloudFront +// Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html type TooManyResponseHeadersPolicies struct { Message *string diff --git a/service/cloudfront/types/types.go b/service/cloudfront/types/types.go index 1f64e6ca82b..ee46aaf0526 100644 --- a/service/cloudfront/types/types.go +++ b/service/cloudfront/types/types.go @@ -77,9 +77,12 @@ 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) -// in Getting Started with Amazon Web Services services in China. +// configure it yourself. +// +// For more information about ICP recordals, see [Signup, Accounts, and Credentials] in Getting Started with Amazon +// Web Services services in China. +// +// [Signup, Accounts, and Credentials]: https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html type AliasICPRecordal struct { // A domain name associated with a distribution. @@ -87,14 +90,19 @@ 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: + // 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 @@ -107,8 +115,11 @@ 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. // @@ -134,8 +145,11 @@ type AllowedMethods 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. + // // 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. @@ -144,38 +158,54 @@ type AllowedMethods struct { 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 +// 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. For more information, -// see CacheBehaviors (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html) -// . Don't include an empty CacheBehavior element because this is invalid. To -// delete all cache behaviors in an existing distribution, update the distribution -// configuration and include only 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) -// in the Amazon CloudFront Developer Guide. +// 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]in the Amazon CloudFront +// Developer Guide. +// +// If you don't want to specify any cache behaviors, include only an empty +// CacheBehaviors element. For more information, see [CacheBehaviors]. Don't include an empty +// CacheBehavior element because this is invalid. +// +// To delete all cache behaviors in an existing distribution, update the +// distribution configuration and include only 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] in the Amazon CloudFront +// Developer Guide. +// +// [Cache Behavior Settings]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior +// [Quotas]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html +// [CacheBehaviors]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html type CacheBehavior struct { // 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 Amazon CloudFront Developer Guide. + // 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] in the Amazon CloudFront Developer Guide. + // + // [Path Pattern]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern // // This member is required. PathPattern *string @@ -189,22 +219,29 @@ type CacheBehavior struct { // 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) - // in the Amazon CloudFront Developer Guide. + // + // For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront] 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]in the Amazon CloudFront Developer Guide. + // + // [Requiring HTTPS Between Viewers and CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html + // [Managing Cache Expiration]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // This member is required. ViewerProtocolPolicy ViewerProtocolPolicy @@ -212,10 +249,14 @@ 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 @@ -223,30 +264,37 @@ type CacheBehavior struct { 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) - // in the Amazon CloudFront Developer Guide. A CacheBehavior must include either a - // CachePolicyId or ForwardedValues . We recommend that you use a CachePolicyId . + // behavior. For more information, see [Creating cache policies]or [Using the managed cache policies] in the Amazon CloudFront Developer + // Guide. + // + // A CacheBehavior must include either a CachePolicyId or ForwardedValues . We + // recommend that you use a CachePolicyId . + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html 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) - // in the Amazon CloudFront Developer Guide. + // information, see [Serving Compressed Files]in the Amazon CloudFront Developer Guide. + // + // [Serving Compressed Files]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html 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) - // 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) - // in the Amazon CloudFront Developer Guide. + // cache policy instead of this field. For more information, see [Creating cache policies]or [Using the managed cache policies] 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)] in the Amazon + // CloudFront Developer Guide. + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // Deprecated: This member has been deprecated. DefaultTTL *int64 @@ -257,19 +305,27 @@ type CacheBehavior struct { FieldLevelEncryptionId *string // 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) - // 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) - // 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) - // in the Amazon CloudFront Developer Guide. A CacheBehavior must include 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. + // request policy instead of this field. For more information, see [Working with policies]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]or [Using the managed cache policies] 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]or [Using the managed origin request policies] in the Amazon + // CloudFront Developer Guide. + // + // A CacheBehavior must include 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. + // + // [Working with policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html + // [Using the managed origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html // // Deprecated: This member has been deprecated. ForwardedValues *ForwardedValues @@ -284,44 +340,56 @@ 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) - // 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) - // in the Amazon CloudFront Developer Guide. + // policy instead of this field. For more information, see [Creating cache policies]or [Using the managed cache policies] 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)] in the Amazon CloudFront + // Developer Guide. + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // 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) - // 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) - // 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 ). + // policy instead of this field. For more information, see [Creating cache policies]or [Using the managed cache policies] 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)]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 ). + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // 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) - // in the Amazon CloudFront Developer Guide. + // cache behavior. For more information, see [Creating origin request policies]or [Using the managed origin request policies] in the Amazon CloudFront + // Developer Guide. + // + // [Using the managed origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy 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) - // in the Amazon CloudFront Developer Guide. + // attached to this cache behavior. For more information, see [Real-time logs]in the Amazon + // CloudFront Developer Guide. + // + // [Real-time logs]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html RealtimeLogConfigArn *string // The identifier for a response headers policy. @@ -335,25 +403,31 @@ type CacheBehavior struct { SmoothStreaming *bool // A list of key groups that CloudFront can use to validate signed URLs or signed - // cookies. When a cache behavior contains trusted key groups, 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) - // in the Amazon CloudFront Developer Guide. + // cookies. + // + // When a cache behavior contains trusted key groups, 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]in the Amazon CloudFront Developer Guide. + // + // [Serving private content]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html TrustedKeyGroups *TrustedKeyGroups - // 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 - // the cache behavior. The URLs or cookies must be signed with the private key of a - // 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) - // in the Amazon CloudFront Developer Guide. + // 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 the cache behavior. The URLs or + // cookies must be signed with the private key of a 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]in the Amazon CloudFront Developer Guide. + // + // [Serving private content]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html TrustedSigners *TrustedSigners noSmithyDocumentSerde @@ -376,7 +450,9 @@ 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. // // If you pick the second choice for your Amazon S3 Origin, you may need to @@ -400,11 +476,15 @@ type CachedMethods struct { noSmithyDocumentSerde } -// A cache policy. When it's attached to a cache behavior, the cache policy -// determines the following: +// 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. // @@ -433,10 +513,14 @@ type CachePolicy struct { noSmithyDocumentSerde } -// A cache policy configuration. This configuration determines the following: +// 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. // @@ -449,9 +533,10 @@ 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) - // in the Amazon CloudFront Developer Guide. + // the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)]in the Amazon CloudFront + // Developer Guide. + // + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // This member is required. MinTTL *int64 @@ -469,22 +554,27 @@ 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) - // 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 . + // with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)]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 . + // + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html 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) - // 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 . + // Cache-Control or Expires headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)] 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 . + // + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html MaxTTL *int64 // The HTTP headers, cookies, and URL query strings to include in the cache key. @@ -502,16 +592,20 @@ 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. // @@ -531,10 +625,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. // @@ -583,12 +679,15 @@ type CachePolicyQueryStringsConfig struct { // 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. // @@ -648,16 +747,21 @@ type CloudFrontOriginAccessIdentity struct { 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 - // 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 - // the original request. If the CallerReference is a value you already sent in a - // previous request to create an identity, but the content of the - // CloudFrontOriginAccessIdentityConfig is different from the original request, - // CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. + // 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 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 the original request. + // + // If the CallerReference is a value you already sent in a previous request to + // create an identity, but the content of the CloudFrontOriginAccessIdentityConfig + // is different from the original request, CloudFront returns a + // CloudFrontOriginAccessIdentityAlreadyExists error. // // This member is required. CallerReference *string @@ -974,59 +1078,85 @@ 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 -// send cookies to the origin but not include them in the cache key, use -// 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) -// in the Amazon CloudFront Developer Guide. +// 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 send cookies to the origin but not include them in the cache +// key, use 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]in the Amazon CloudFront Developer Guide. +// +// [Caching Content Based on Cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html 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) - // 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) - // 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 - // the cache behavior is forwarding requests to an Amazon S3 origin, specify none - // for the Forward element. + // 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]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]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 the cache behavior is forwarding + // requests to an Amazon S3 origin, specify none for the Forward element. + // + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy // // This member is required. Forward ItemSelection // 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) - // 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) - // 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 - // 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 - // 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) - // in the Amazon Web Services General Reference. + // 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]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]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 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 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]in the Amazon Web Services General Reference. + // + // [CloudFront Limits]: https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy WhitelistedNames *CookieNames noSmithyDocumentSerde } // 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. // -// 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. +// For more information about custom error pages, see [Customizing Error Responses] in the Amazon CloudFront +// Developer Guide. +// +// [Customizing Error Responses]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html type CustomErrorResponse struct { // The HTTP status code for which you want to specify a custom error page and/or a @@ -1038,23 +1168,29 @@ type CustomErrorResponse struct { // 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, // 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) - // in the Amazon CloudFront Developer Guide. + // has been resolved and the requested object is now available. + // + // For more information, see [Customizing Error Responses] in the Amazon CloudFront Developer Guide. + // + // [Customizing Error Responses]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html 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 // 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 . ResponseCode *string @@ -1064,30 +1200,39 @@ type CustomErrorResponse struct { // 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. + // 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. ResponsePagePath *string noSmithyDocumentSerde } // 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. // -// 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. +// For more information about custom error pages, see [Customizing Error Responses] in the Amazon CloudFront +// Developer Guide. +// +// [Customizing Error Responses]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html type CustomErrorResponses struct { // The number of HTTP status codes for which you want to specify a custom error @@ -1112,7 +1257,7 @@ type CustomHeaders struct { // This member is required. Quantity *int32 - // Optional: A list that contains one OriginCustomHeader element for each custom + // 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 . Items []OriginCustomHeader @@ -1121,9 +1266,9 @@ type CustomHeaders struct { } // A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, -// with one exception. An Amazon S3 bucket that is configured with static website -// hosting (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) is -// a custom origin. +// with one exception. An Amazon S3 bucket that is [configured with static website hosting]is a custom origin. +// +// [configured with static website hosting]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html type CustomOriginConfig struct { // The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP @@ -1140,9 +1285,12 @@ 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. // // This member is required. @@ -1150,22 +1298,30 @@ 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) - // in the Amazon CloudFront Developer Guide. + // default (if you don't specify otherwise) is 5 seconds. + // + // For more information, see [Origin Keep-alive Timeout] in the Amazon CloudFront Developer Guide. + // + // [Origin Keep-alive Timeout]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout 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) - // in the Amazon CloudFront Developer Guide. + // otherwise) is 30 seconds. + // + // For more information, see [Origin Response Timeout] in the Amazon CloudFront Developer Guide. + // + // [Origin Response Timeout]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout 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) - // in the Amazon CloudFront Developer Guide. + // TLSv1.2 . + // + // For more information, see [Minimum Origin SSL Protocol] in the Amazon CloudFront Developer Guide. + // + // [Minimum Origin SSL Protocol]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols OriginSslProtocols *OriginSslProtocols noSmithyDocumentSerde @@ -1186,22 +1342,29 @@ type DefaultCacheBehavior struct { // 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) - // in the Amazon CloudFront Developer Guide. + // + // For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront] 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]in the Amazon CloudFront Developer Guide. + // + // [Requiring HTTPS Between Viewers and CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html + // [Managing Cache Expiration]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // This member is required. ViewerProtocolPolicy ViewerProtocolPolicy @@ -1209,10 +1372,14 @@ 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 @@ -1220,31 +1387,37 @@ type DefaultCacheBehavior struct { 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) - // in the Amazon CloudFront Developer Guide. A DefaultCacheBehavior must include - // either a CachePolicyId or ForwardedValues . We recommend that you use a - // CachePolicyId . + // behavior. For more information, see [Creating cache policies]or [Using the managed cache policies] in the Amazon CloudFront Developer + // Guide. + // + // A DefaultCacheBehavior must include either a CachePolicyId or ForwardedValues . + // We recommend that you use a CachePolicyId . + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html 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) - // in the Amazon CloudFront Developer Guide. + // information, see [Serving Compressed Files]in the Amazon CloudFront Developer Guide. + // + // [Serving Compressed Files]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html 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) - // 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) - // in the Amazon CloudFront Developer Guide. + // cache policy instead of this field. For more information, see [Creating cache policies]or [Using the managed cache policies] 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)] in the Amazon + // CloudFront Developer Guide. + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // Deprecated: This member has been deprecated. DefaultTTL *int64 @@ -1255,19 +1428,27 @@ type DefaultCacheBehavior struct { FieldLevelEncryptionId *string // 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) - // 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) - // 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) - // 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 - // strings, cookies, and HTTP headers. + // request policy instead of this field. For more information, see [Working with policies]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]or [Using the managed cache policies] 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]or [Using the managed origin request policies] 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 strings, cookies, + // and HTTP headers. + // + // [Working with policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html + // [Using the managed origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html // // Deprecated: This member has been deprecated. ForwardedValues *ForwardedValues @@ -1282,45 +1463,56 @@ 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) - // 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) - // in the Amazon CloudFront Developer Guide. + // policy instead of this field. For more information, see [Creating cache policies]or [Using the managed cache policies] 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)] in the Amazon CloudFront + // Developer Guide. + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // 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) - // 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) - // 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 ). + // policy instead of this field. For more information, see [Creating cache policies]or [Using the managed cache policies] 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)]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 ). + // + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Using the managed cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html + // [Managing How Long Content Stays in an Edge Cache (Expiration)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html // // 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) - // in the Amazon CloudFront Developer Guide. + // default cache behavior. For more information, see [Creating origin request policies]or [Using the managed origin request policies] in the Amazon CloudFront + // Developer Guide. + // + // [Using the managed origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy 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) - // in the Amazon CloudFront Developer Guide. + // attached to this cache behavior. For more information, see [Real-time logs]in the Amazon + // CloudFront Developer Guide. + // + // [Real-time logs]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html RealtimeLogConfigArn *string // The identifier for a response headers policy. @@ -1334,25 +1526,31 @@ type DefaultCacheBehavior struct { SmoothStreaming *bool // A list of key groups that CloudFront can use to validate signed URLs or signed - // cookies. When a cache behavior contains trusted key groups, 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) - // in the Amazon CloudFront Developer Guide. + // cookies. + // + // When a cache behavior contains trusted key groups, 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]in the Amazon CloudFront Developer Guide. + // + // [Serving private content]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html TrustedKeyGroups *TrustedKeyGroups - // 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 - // the cache behavior. The URLs or cookies must be signed with the private key of a - // 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) - // in the Amazon CloudFront Developer Guide. + // 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 the cache behavior. The URLs or + // cookies must be signed with the private key of a 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]in the Amazon CloudFront Developer Guide. + // + // [Serving private content]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html TrustedSigners *TrustedSigners noSmithyDocumentSerde @@ -1404,19 +1602,23 @@ type Distribution struct { // cookies. ActiveTrustedKeyGroups *ActiveTrustedKeyGroups - // 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. + // 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. ActiveTrustedSigners *ActiveTrustedSigners // Amazon Web Services services in China customers must file for an Internet // 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) - // in Getting Started with Amazon Web Services services in China. + // distributions. + // + // For more information about ICP recordals, see [Signup, Accounts, and Credentials] in Getting Started with Amazon + // Web Services services in China. + // + // [Signup, Accounts, and Credentials]: https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html AliasICPRecordals []AliasICPRecordal noSmithyDocumentSerde @@ -1426,11 +1628,13 @@ type Distribution struct { type DistributionConfig 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 DistributionConfig object), CloudFront creates a new - // distribution. If CallerReference is a value that you already sent in a previous - // request to create a distribution, CloudFront returns a DistributionAlreadyExists - // error. + // can't be replayed. + // + // If the value of CallerReference is new (regardless of the content of the + // DistributionConfig object), CloudFront creates a new distribution. + // + // If CallerReference is a value that you already sent in a previous request to + // create a distribution, CloudFront returns a DistributionAlreadyExists error. // // This member is required. CallerReference *string @@ -1470,73 +1674,102 @@ type DistributionConfig struct { 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) - // in the Amazon CloudFront Developer Guide. + // + // For more information about custom error pages, see [Customizing Error Responses] in the Amazon CloudFront + // Developer Guide. + // + // [Customizing Error Responses]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html 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 - // 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 - // 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) - // in the Amazon CloudFront Developer Guide. + // 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 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] in the Amazon + // CloudFront Developer Guide. + // + // [Creating a Default Root Object]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html DefaultRootObject *string // (Optional) Specify the 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 - // 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) - // . + // 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]at RFC 9000. For more information + // about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront]. + // + // [Connection Migration]: https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration + // [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 // 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) - // 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: + // 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] + // 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) - // 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 - // CNAME record will route traffic to your distribution regardless of the IP - // address format of the viewer request. + // + // For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name] 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 CNAME record will route traffic to your distribution regardless of + // the IP address format of the viewer request. + // + // [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 + // [Creating a Signed URL Using a Custom Policy]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html 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) - // in the Amazon CloudFront Developer Guide. + // distribution. + // + // For more information about logging, see [Access Logs] in the Amazon CloudFront Developer + // Guide. + // + // [Access Logs]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html Logging *LoggingConfig // A complex type that contains information about origin groups for this @@ -1545,16 +1778,19 @@ type DistributionConfig struct { // 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 - // 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) - // 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/) - // . + // 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 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] 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]. + // + // [Choosing the Price Class for a CloudFront Distribution]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html + // [Amazon CloudFront Pricing]: http://aws.amazon.com/cloudfront/pricing/ PriceClass PriceClass // A complex type that identifies ways in which you want to restrict distribution @@ -1575,15 +1811,17 @@ type DistributionConfig struct { // use the ACL ARN, for example // arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 // . To specify a web ACL created using WAF Classic, use the ACL ID, for example - // a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . 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) - // . + // a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . + // + // 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]. + // + // [WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html WebACLId *string noSmithyDocumentSerde @@ -1796,9 +2034,12 @@ 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) - // in Getting Started with Amazon Web Services services in China. + // distributions. + // + // For more information about ICP recordals, see [Signup, Accounts, and Credentials] in Getting Started with Amazon + // Web Services services in China. + // + // [Signup, Accounts, and Credentials]: https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html AliasICPRecordals []AliasICPRecordal // A complex type that contains information about origin groups for this @@ -2095,83 +2336,119 @@ 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) -// 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) -// in the Amazon CloudFront Developer Guide. A complex type that specifies how -// CloudFront handles query strings, cookies, and HTTP headers. +// 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]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]in the Amazon +// CloudFront Developer Guide. +// +// A complex type that specifies how CloudFront handles query strings, cookies, +// and HTTP headers. +// +// [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy +// [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy 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) - // 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) - // 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) - // in the Amazon CloudFront Developer Guide. + // 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]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]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]in the Amazon CloudFront Developer Guide. + // + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [How CloudFront Forwards, Caches, and Logs Cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html // // This member is required. Cookies *CookiePreference // 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) - // 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) - // 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) - // in the Amazon CloudFront Developer Guide. + // 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]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]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] in the Amazon CloudFront Developer Guide. + // + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Configuring CloudFront to Cache Based on Query String Parameters]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html // // This member is required. QueryString *bool // 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) - // 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) - // 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 - // 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) - // in the Amazon CloudFront Developer Guide. + // 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]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]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 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] in the Amazon CloudFront Developer Guide. + // + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy + // [Caching Content Based on Request Headers]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html 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) - // 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) - // 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. + // 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]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]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. + // + // [Creating origin request policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy + // [Creating cache policies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy QueryStringCacheKeys *QueryStringCacheKeys noSmithyDocumentSerde @@ -2274,11 +2551,13 @@ 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 - // attach the function to a distribution's cache behavior, using the function's - // ARN. + // 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 noSmithyDocumentSerde @@ -2322,10 +2601,13 @@ type GeoRestriction struct { // 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. // @@ -2334,13 +2616,17 @@ type GeoRestriction struct { // 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 - // Organization for Standardization website. You can also refer to the country list - // on the CloudFront console, which includes both country names and codes. + // 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 noSmithyDocumentSerde @@ -2411,21 +2697,25 @@ 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) - // in the Amazon CloudFront Developer Guide. + // invalidate. For more information, see [Specifying the Objects to Invalidate]in the Amazon CloudFront Developer Guide. + // + // [Specifying the Objects to Invalidate]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects // // This member is required. Paths *Paths @@ -2434,9 +2724,10 @@ 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) -// in the Amazon CloudFront Developer Guide. +// For more information about invalidation, see [Invalidating Objects (Web Distributions Only)]in the Amazon CloudFront Developer +// Guide. +// +// [Invalidating Objects (Web Distributions Only)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html type InvalidationList struct { // A flag that indicates whether more invalidation batch requests remain to be @@ -2496,9 +2787,11 @@ type InvalidationSummary struct { noSmithyDocumentSerde } -// 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) -// . +// A key group. +// +// A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies]. +// +// [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. @@ -2519,9 +2812,11 @@ type KeyGroup struct { noSmithyDocumentSerde } -// 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) -// . +// A key group configuration. +// +// A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies]. +// +// [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. @@ -2692,8 +2987,11 @@ 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) - // in the Amazon CloudFront Developer Guide. + // + // For more information the IAM role, see [Real-time log configuration IAM role] in the Amazon CloudFront Developer + // Guide. + // + // [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 // // This member is required. RoleARN *string @@ -2712,19 +3010,25 @@ 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. + // 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 @@ -2736,22 +3040,25 @@ type LambdaFunctionAssociation struct { LambdaFunctionARN *string // 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) - // in the Amazon CloudFront Developer Guide. + // content. For more information, see [Accessing the Request Body by Choosing the Include Body Option]in the Amazon CloudFront Developer Guide. + // + // [Accessing the Request Body by Choosing the Include Body Option]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html 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 -// 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 +// 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 // LambdaFunctionAssociation items in this list (one for each possible value of -// 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 . +// 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 . type LambdaFunctionAssociations struct { // The number of Lambda@Edge function associations for this cache behavior. @@ -2759,8 +3066,8 @@ type LambdaFunctionAssociations struct { // This member is required. Quantity *int32 - // Optional: A complex type that contains LambdaFunctionAssociation items for this - // cache behavior. If Quantity is 0 , you can omit Items . + // Optional: A complex type that contains LambdaFunctionAssociation items for + // this cache behavior. If Quantity is 0 , you can omit Items . Items []LambdaFunctionAssociation noSmithyDocumentSerde @@ -2817,58 +3124,81 @@ type MonitoringSubscription struct { noSmithyDocumentSerde } -// 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: +// 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 Elemental MediaPackage endpoint +// // - An 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) -// in the Amazon CloudFront Developer Guide (quotas were formerly referred to as -// limits). +// distribution, see [General Quotas on Web Distributions]in the Amazon CloudFront Developer Guide (quotas were +// formerly referred to as limits). +// +// [General Quotas on Web Distributions]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions 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) - // in the Amazon CloudFront Developer Guide. + // The domain name for the origin. + // + // For more information, see [Origin Domain Name] in the Amazon CloudFront Developer Guide. + // + // [Origin Domain Name]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName // // 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 // The number of times that CloudFront attempts to connect to the origin. The // minimum number is 1, the maximum is 3, and the default (if you don't specify - // 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) - // in the Amazon CloudFront Developer Guide. + // 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]. + // + // For more information, see [Origin Connection Attempts] in the Amazon CloudFront Developer Guide. + // + // [Origin Connection Attempts]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts + // [Origin Response Timeout]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout 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) - // in the Amazon CloudFront Developer Guide. + // seconds, and the default (if you don't specify otherwise) is 10 seconds. + // + // For more information, see [Origin Connection Timeout] in the Amazon CloudFront Developer Guide. + // + // [Origin Connection Timeout]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout 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) - // in the Amazon CloudFront Developer Guide. + // that it sends to the origin. + // + // For more information, see [Adding Custom Headers to Origin Requests] in the Amazon CloudFront Developer Guide. + // + // [Adding Custom Headers to Origin Requests]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html CustomHeaders *CustomHeaders // Use this type to specify an origin that is not an Amazon S3 bucket, with one @@ -2877,20 +3207,27 @@ type Origin struct { // hosting, use the S3OriginConfig type instead. 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) - // in the Amazon CloudFront Developer Guide. + // The unique identifier of an origin access control for this origin. + // + // For more information, see [Restricting access to an Amazon S3 origin] in the Amazon CloudFront Developer Guide. + // + // [Restricting access to an Amazon S3 origin]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html 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) - // in the Amazon CloudFront Developer Guide. + // CloudFront requests content from the origin. + // + // For more information, see [Origin Path] in the Amazon CloudFront Developer Guide. + // + // [Origin Path]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath 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) - // in the Amazon CloudFront Developer Guide. + // origin. + // + // For more information, see [Using Origin Shield] in the Amazon CloudFront Developer Guide. + // + // [Using Origin Shield]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html OriginShield *OriginShield // Use this type to specify an origin that is an Amazon S3 bucket that is not @@ -2931,23 +3268,28 @@ type OriginAccessControlConfig struct { OriginAccessControlOriginType OriginAccessControlOriginTypes // 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) - // in the Amazon CloudFront Developer Guide. This field can have one of the - // following values: + // Specify always for the most common use case. For more information, see [origin access control 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. + // must add the Authorization header to a [cache policy]for all cache behaviors that use + // origins associated with this origin access control. + // + // [origin access control advanced settings]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings + // [cache policy]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html // // This member is required. SigningBehavior OriginAccessControlSigningBehaviors @@ -3024,9 +3366,12 @@ 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 @@ -3050,8 +3395,9 @@ 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) - // in the Amazon CloudFront Developer Guide. + // information, see [Adding Custom Headers to Origin Requests]in the Amazon CloudFront Developer Guide. + // + // [Adding Custom Headers to Origin Requests]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html // // This member is required. HeaderName *string @@ -3146,14 +3492,18 @@ type OriginGroups struct { noSmithyDocumentSerde } -// An origin request policy. 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: +// An origin request policy. +// +// 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 @@ -3182,13 +3532,18 @@ 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: +// 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 @@ -3233,13 +3588,17 @@ 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. @@ -3259,17 +3618,22 @@ 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. @@ -3315,15 +3679,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. + // 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. @@ -3375,27 +3742,35 @@ type Origins struct { noSmithyDocumentSerde } -// 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) -// in the Amazon CloudFront Developer Guide. +// CloudFront Origin Shield. +// +// Using Origin Shield can help reduce the load on your origin. For more +// information, see [Using Origin Shield]in the Amazon CloudFront Developer Guide. +// +// [Using Origin Shield]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html type OriginShield struct { - // A flag that specifies whether Origin Shield is enabled. When it's enabled, - // CloudFront routes all requests through Origin Shield, which can help protect - // your origin. When it's disabled, CloudFront might send requests directly to your - // origin from multiple edge locations or regional edge caches. + // A flag that specifies whether Origin Shield is enabled. + // + // When it's enabled, CloudFront routes all requests through Origin Shield, which + // can help protect your origin. When it's disabled, CloudFront might send requests + // directly to your origin from multiple edge locations or regional edge caches. // // This member is required. Enabled *bool - // 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 - // 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) - // in the Amazon CloudFront Developer Guide. + // 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 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]in the Amazon CloudFront Developer Guide. + // + // [Choosing the Amazon Web Services Region for Origin Shield]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region OriginShieldRegion *string noSmithyDocumentSerde @@ -3422,11 +3797,13 @@ type OriginSslProtocols struct { // This object determines 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 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 . +// to the viewer. +// +// 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 . type ParametersInCacheKeyAndForwardedToOrigin struct { // An object that determines whether any cookies in viewer requests (and if so, @@ -3437,25 +3814,34 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { CookiesConfig *CachePolicyCookiesConfig // 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 + // 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 - // 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 - // 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 - // whitelist like any other HTTP header. + // + // For more information, see [Compression support] 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 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 whitelist like any + // other HTTP header. + // + // [Compression support]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects // // This member is required. EnableAcceptEncodingGzip *bool @@ -3475,33 +3861,43 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { QueryStringsConfig *CachePolicyQueryStringsConfig // 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 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: + // the cache key and included in requests that CloudFront sends to the origin. + // + // This 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 - // 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 - // 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 - // whitelist like any other HTTP header. + // + // For more information, see [Compression support] 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 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 whitelist like any + // other HTTP header. + // + // [Compression support]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects EnableAcceptEncodingBrotli *bool noSmithyDocumentSerde } // 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) -// in the Amazon CloudFront Developer Guide. +// invalidate. For more information, see [Specifying the Objects to Invalidate]in the Amazon CloudFront Developer Guide. +// +// [Specifying the Objects to Invalidate]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects type Paths struct { // The number of invalidation paths specified for the objects that you want to @@ -3516,9 +3912,10 @@ 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], or with [field-level encryption]. +// +// [signed URLs and signed cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html +// [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. @@ -3531,10 +3928,10 @@ type PublicKey struct { // This member is required. 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) - // . + // Configuration information about a public key that you can use with [signed URLs and signed cookies], or with [field-level encryption]. + // + // [signed URLs and signed cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html + // [field-level encryption]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html // // This member is required. PublicKeyConfig *PublicKeyConfig @@ -3542,10 +3939,10 @@ type PublicKey struct { noSmithyDocumentSerde } -// 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) -// . +// Configuration information about a public key that you can use with [signed URLs and signed cookies], or with [field-level encryption]. +// +// [signed URLs and signed cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html +// [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 @@ -3554,9 +3951,10 @@ 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], or with [field-level encryption]. + // + // [signed URLs and signed cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html + // [field-level encryption]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html // // This member is required. EncodedKey *string @@ -3573,9 +3971,10 @@ 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], or with [field-level encryption]. +// +// [signed URLs and signed cookies]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html +// [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. @@ -3678,12 +4077,17 @@ 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. +// 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. type QueryStringCacheKeys struct { // The number of whitelisted query string parameters for a cache behavior. @@ -3729,9 +4133,12 @@ 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) - // in the Amazon CloudFront Developer Guide. + // the Amazon Kinesis data stream. + // + // For more information about fields, see [Real-time log configuration fields] in the Amazon CloudFront Developer + // Guide. + // + // [Real-time log configuration fields]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields // // This member is required. Fields []string @@ -3797,15 +4204,21 @@ type RealtimeMetricsSubscriptionConfig struct { noSmithyDocumentSerde } -// A response headers policy. A response headers policy contains information about -// a set of HTTP response headers. After you create a response headers policy, you -// can use its ID to attach it to one or more cache behaviors in a CloudFront -// distribution. When it's attached to a cache behavior, the response headers -// 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) -// in the Amazon CloudFront Developer Guide. +// A response headers policy. +// +// A response headers policy contains information about a set of HTTP response +// headers. +// +// After you create a response headers policy, you can use its ID to attach it to +// one or more cache behaviors in a CloudFront distribution. When it's attached to +// a cache behavior, the response headers 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] in the Amazon CloudFront Developer Guide. +// +// [Adding or removing HTTP headers in CloudFront responses]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html type ResponseHeadersPolicy struct { // The identifier for the response headers policy. @@ -3827,10 +4240,12 @@ 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) -// in the MDN Web Docs. +// Access-Control-Allow-Headers HTTP response header. +// +// For more information about the Access-Control-Allow-Headers HTTP response +// header, see [Access-Control-Allow-Headers]in the MDN Web Docs. +// +// [Access-Control-Allow-Headers]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers type ResponseHeadersPolicyAccessControlAllowHeaders struct { // The list of HTTP header names. You can specify * to allow all headers. @@ -3847,21 +4262,32 @@ 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) -// in the MDN Web Docs. +// Access-Control-Allow-Methods HTTP response header. +// +// For more information about the Access-Control-Allow-Methods HTTP response +// header, see [Access-Control-Allow-Methods]in the MDN Web Docs. +// +// [Access-Control-Allow-Methods]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods 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. // // This member is required. @@ -3876,10 +4302,12 @@ 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) -// in the MDN Web Docs. +// Access-Control-Allow-Origin HTTP response header. +// +// For more information about the Access-Control-Allow-Origin HTTP response +// header, see [Access-Control-Allow-Origin]in the MDN Web Docs. +// +// [Access-Control-Allow-Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin type ResponseHeadersPolicyAccessControlAllowOrigins struct { // The list of origins (domain names). You can specify * to allow all origins. @@ -3896,10 +4324,12 @@ 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) -// in the MDN Web Docs. +// Access-Control-Expose-Headers HTTP response header. +// +// For more information about the Access-Control-Expose-Headers HTTP response +// header, see [Access-Control-Expose-Headers]in the MDN Web Docs. +// +// [Access-Control-Expose-Headers]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers type ResponseHeadersPolicyAccessControlExposeHeaders struct { // The number of HTTP headers in the list. @@ -3913,19 +4343,23 @@ 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 - // response headers policies in this Amazon Web Services account. + // A name to identify the response headers policy. + // + // The name must be unique for response headers policies in this Amazon Web + // Services account. // // This member is required. Name *string - // A comment to describe the response headers policy. The comment cannot be longer - // than 128 characters. + // A comment to describe the response headers policy. + // + // The comment cannot be longer than 128 characters. Comment *string // A configuration for a set of HTTP response headers that are used for @@ -3949,9 +4383,12 @@ 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) -// in the MDN Web Docs. +// the Content-Security-Policy HTTP response header. +// +// For more information about the Content-Security-Policy HTTP response header, +// see [Content-Security-Policy]in the MDN Web Docs. +// +// [Content-Security-Policy]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy type ResponseHeadersPolicyContentSecurityPolicy struct { // The policy directives and their values that CloudFront includes as values for @@ -3971,9 +4408,12 @@ 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] // in the MDN Web Docs. +// +// [X-Content-Type-Options]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options type ResponseHeadersPolicyContentTypeOptions struct { // A Boolean that determines whether CloudFront overrides the @@ -3989,43 +4429,53 @@ type ResponseHeadersPolicyContentTypeOptions struct { // A configuration for a set of HTTP response headers that are used for // 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. +// with this response headers policy. +// +// For more information about CORS, see [Cross-Origin Resource Sharing (CORS)] in the MDN Web Docs. +// +// [Cross-Origin Resource Sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // in the MDN Web Docs. + // Access-Control-Allow-Credentials HTTP response header. + // + // For more information about the Access-Control-Allow-Credentials HTTP response + // header, see [Access-Control-Allow-Credentials]in the MDN Web Docs. + // + // [Access-Control-Allow-Credentials]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials // // This member is required. AccessControlAllowCredentials *bool // 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) - // in the MDN Web Docs. + // Access-Control-Allow-Headers HTTP response header. + // + // For more information about the Access-Control-Allow-Headers HTTP response + // header, see [Access-Control-Allow-Headers]in the MDN Web Docs. + // + // [Access-Control-Allow-Headers]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers // // This member is required. AccessControlAllowHeaders *ResponseHeadersPolicyAccessControlAllowHeaders // 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) - // in the MDN Web Docs. + // Access-Control-Allow-Methods HTTP response header. + // + // For more information about the Access-Control-Allow-Methods HTTP response + // header, see [Access-Control-Allow-Methods]in the MDN Web Docs. + // + // [Access-Control-Allow-Methods]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods // // This member is required. AccessControlAllowMethods *ResponseHeadersPolicyAccessControlAllowMethods // 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) - // in the MDN Web Docs. + // Access-Control-Allow-Origin HTTP response header. + // + // For more information about the Access-Control-Allow-Origin HTTP response + // header, see [Access-Control-Allow-Origin]in the MDN Web Docs. + // + // [Access-Control-Allow-Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin // // This member is required. AccessControlAllowOrigins *ResponseHeadersPolicyAccessControlAllowOrigins @@ -4038,16 +4488,21 @@ type ResponseHeadersPolicyCorsConfig struct { OriginOverride *bool // 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) - // in the MDN Web Docs. + // Access-Control-Expose-Headers HTTP response header. + // + // For more information about the Access-Control-Expose-Headers HTTP response + // header, see [Access-Control-Expose-Headers]in the MDN Web Docs. + // + // [Access-Control-Expose-Headers]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers 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. + // + // For more information about the Access-Control-Max-Age HTTP response header, see [Access-Control-Max-Age] // in the MDN Web Docs. + // + // [Access-Control-Max-Age]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age AccessControlMaxAgeSec *int32 noSmithyDocumentSerde @@ -4094,14 +4549,20 @@ 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. +// and the header's value. +// +// For more information about the X-Frame-Options HTTP response header, see [X-Frame-Options] in +// the MDN Web Docs. +// +// [X-Frame-Options]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options 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. + // and SAMEORIGIN . + // + // For more information about these values, see [X-Frame-Options] in the MDN Web Docs. + // + // [X-Frame-Options]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options // // This member is required. FrameOption FrameOptionsList @@ -4142,9 +4603,12 @@ 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. +// and the header's value. +// +// For more information about the Referrer-Policy HTTP response header, see [Referrer-Policy] in +// the MDN Web Docs. +// +// [Referrer-Policy]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy type ResponseHeadersPolicyReferrerPolicy struct { // A Boolean that determines whether CloudFront overrides the Referrer-Policy HTTP @@ -4155,16 +4619,26 @@ 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. + // + // For more information about these values, see [Referrer-Policy] in the MDN Web Docs. + // + // [Referrer-Policy]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy // // This member is required. ReferrerPolicy ReferrerPolicyList @@ -4207,40 +4681,58 @@ 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) - // in the MDN Web Docs. + // the Content-Security-Policy HTTP response header. + // + // For more information about the Content-Security-Policy HTTP response header, + // see [Content-Security-Policy]in the MDN Web Docs. + // + // [Content-Security-Policy]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy 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] // in the MDN Web Docs. + // + // [X-Content-Type-Options]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options 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. + // and the header's value. + // + // For more information about the X-Frame-Options HTTP response header, see [X-Frame-Options] in + // the MDN Web Docs. + // + // [X-Frame-Options]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options 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. + // and the header's value. + // + // For more information about the Referrer-Policy HTTP response header, see [Referrer-Policy] in + // the MDN Web Docs. + // + // [Referrer-Policy]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy 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 Security headers (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#understanding-response-headers-policies-security) - // in the Amazon CloudFront Developer Guide and Strict-Transport-Security (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) - // in the MDN Web Docs. + // response header and the header's value. + // + // For more information about the Strict-Transport-Security HTTP response header, + // see [Security headers]in the Amazon CloudFront Developer Guide and [Strict-Transport-Security] in the MDN Web Docs. + // + // [Strict-Transport-Security]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security + // [Security headers]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#understanding-response-headers-policies-security 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. + // header and the header's value. + // + // For more information about the X-XSS-Protection HTTP response header, see [X-XSS-Protection] in + // the MDN Web Docs. + // + // [X-XSS-Protection]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection XSSProtection *ResponseHeadersPolicyXSSProtection noSmithyDocumentSerde @@ -4249,14 +4741,17 @@ type ResponseHeadersPolicySecurityHeadersConfig struct { // A configuration for enabling the Server-Timing header in HTTP responses sent // from CloudFront. CloudFront adds this header to HTTP responses that it sends in // response to requests that match a cache behavior that's associated with this -// response headers policy. You can use the Server-Timing header to view metrics -// that can help you gain insights about the behavior and performance of -// CloudFront. For example, you can see which cache layer served a cache hit, or -// 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) -// in the Amazon CloudFront Developer Guide. +// response headers policy. +// +// You can use the Server-Timing header to view metrics that can help you gain +// insights about the behavior and performance of CloudFront. For example, you can +// see which cache layer served a cache hit, or 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]in the Amazon CloudFront Developer +// Guide. +// +// [Server-Timing header]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#server-timing-header type ResponseHeadersPolicyServerTimingHeadersConfig struct { // A Boolean that determines whether CloudFront adds the Server-Timing header to @@ -4279,9 +4774,12 @@ 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) -// in the MDN Web Docs. +// response header and the header's value. +// +// For more information about the Strict-Transport-Security HTTP response header, +// see [Strict-Transport-Security]in the MDN Web Docs. +// +// [Strict-Transport-Security]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security type ResponseHeadersPolicyStrictTransportSecurity struct { // A number that CloudFront uses as the value for the max-age directive in the @@ -4326,9 +4824,12 @@ type ResponseHeadersPolicySummary struct { } // 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. +// header and the header's value. +// +// For more information about the X-XSS-Protection HTTP response header, see [X-XSS-Protection] in +// the MDN Web Docs. +// +// [X-XSS-Protection]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection type ResponseHeadersPolicyXSSProtection struct { // A Boolean that determines whether CloudFront overrides the X-XSS-Protection @@ -4341,22 +4842,30 @@ type ResponseHeadersPolicyXSSProtection struct { // 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. + // + // For more information about these settings, see [X-XSS-Protection] in the MDN Web Docs. + // + // [X-XSS-Protection]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection // // 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. + // in the X-XSS-Protection header. + // + // For more information about this directive, see [X-XSS-Protection] in the MDN Web Docs. + // + // [X-XSS-Protection]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection 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. + // 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] in the MDN Web Docs. + // + // [X-XSS-Protection]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection ReportUri *string noSmithyDocumentSerde @@ -4387,15 +4896,20 @@ type S3Origin struct { // 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. + // 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] in the Amazon CloudFront Developer Guide. + // + // [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 // // This member is required. OriginAccessIdentity *string @@ -4409,23 +4923,32 @@ type S3Origin struct { type S3OriginConfig struct { // If you're using origin access control (OAC) instead of origin access identity, - // specify an empty OriginAccessIdentity element. For more information, see - // Restricting access to an Amazon Web Services (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) - // in the Amazon CloudFront Developer Guide. The CloudFront origin access identity - // to associate with the origin. Use an 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 The - // 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 - // 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 about the origin access identity, see - // Serving Private Content through CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) - // in the Amazon CloudFront Developer Guide. + // specify an empty OriginAccessIdentity element. For more information, see [Restricting access to an Amazon Web Services] in + // the Amazon CloudFront Developer Guide. + // + // The CloudFront origin access identity to associate with the origin. Use an + // 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 + // + // The 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 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 about the origin access identity, see [Serving Private Content through CloudFront] in the Amazon + // CloudFront Developer Guide. + // + // [Serving Private Content through CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html + // [Restricting access to an Amazon Web Services]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html // // This member is required. OriginAccessIdentity *string @@ -4441,15 +4964,17 @@ type S3OriginConfig struct { 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 . + // received. Allowed values are 300–3600 seconds (5–60 minutes). + // + // The value must be 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 greater than or equal to IdleTTL . + // of the same session. Allowed values are 300–3600 seconds (5–60 minutes). + // + // The value must be greater than or equal to IdleTTL . // // This member is required. MaximumTTL *int32 @@ -4519,14 +5044,17 @@ type StreamingDistribution struct { // 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) - // in the Amazon CloudFront Developer Guide. + // can't create signed URLs. + // + // For more information, see [Serving Private Content through CloudFront] in the Amazon CloudFront Developer Guide. + // + // [Serving Private Content through CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html // // This member is required. ActiveTrustedSigners *ActiveTrustedSigners @@ -4563,11 +5091,13 @@ type StreamingDistribution struct { type StreamingDistributionConfig 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 StreamingDistributionConfig object), CloudFront creates a new - // distribution. If CallerReference is a value that you already sent in a previous - // request to create a distribution, CloudFront returns a DistributionAlreadyExists - // error. + // can't be replayed. + // + // If the value of CallerReference is new (regardless of the content of the + // StreamingDistributionConfig object), CloudFront creates a new distribution. + // + // If CallerReference is a value that you already sent in a previous request to + // create a distribution, CloudFront returns a DistributionAlreadyExists error. // // This member is required. CallerReference *string @@ -4592,9 +5122,10 @@ type StreamingDistributionConfig struct { // A complex type that specifies any Amazon Web Services accounts that you want to // 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) - // in the Amazon CloudFront Developer Guide. + // public URLs, remove this element. For more information, see [Serving Private Content through CloudFront]in the Amazon + // CloudFront Developer Guide. + // + // [Serving Private Content through CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html // // This member is required. TrustedSigners *TrustedSigners @@ -4739,9 +5270,11 @@ type StreamingDistributionSummary struct { // 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) - // in the Amazon CloudFront Developer Guide. + // the updated distribution. + // + // For more information, see [Serving Private Content through CloudFront] in the Amazon CloudFront Developer Guide. + // + // [Serving Private Content through CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html // // This member is required. TrustedSigners *TrustedSigners @@ -4783,16 +5316,18 @@ type StreamingLoggingConfig struct { // A complex type that contains Tag key and Tag value. 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 _ - . : / = + @ . + // 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 _ - . : / = + @ . // // 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 _ - . : / = + @ . + // 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 _ - . : / = + @ . Value *string noSmithyDocumentSerde @@ -4832,8 +5367,9 @@ 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) - // in the Amazon CloudFront Developer Guide. + // structure of the event object, see [Event object structure]in the Amazon CloudFront Developer Guide. + // + // [Event object structure]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html FunctionOutput *string // Contains configuration information and metadata about the CloudFront function @@ -4904,113 +5440,156 @@ 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 -// 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: +// 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 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. +// that support [server name indication (SNI)](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): +// MinimumProtocolVersion . For more information, see [Security Policy]in the Amazon CloudFront +// Developer Guide. +// +// - The location of the SSL/TLS certificate, [Certificate Manager (ACM)](recommended) or [Identity and Access Management (IAM)]. 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) -// in the Amazon CloudFront Developer Guide. +// use SSL/TLS to communicate with your custom origin, use CustomOriginConfig . +// +// For more information, see [Using HTTPS with CloudFront] and [Using Alternate Domain Names and HTTPS] in the Amazon CloudFront Developer Guide. +// +// [Using HTTPS with CloudFront]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html +// [Security Policy]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy +// [Certificate Manager (ACM)]: https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html +// [Using Alternate Domain Names and HTTPS]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html +// [server name indication (SNI)]: https://en.wikipedia.org/wiki/Server_Name_Indication +// [Identity and Access Management (IAM)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html 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 + // SSL/TLS certificate is stored in [Certificate Manager (ACM)], 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 . + // + // [Certificate Manager (ACM)]: https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html ACMCertificateArn *string // This field is deprecated. Use one of the following fields instead: + // // - 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 // // 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: + // 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)], provide the ID of the IAM certificate. + // + // If you specify an IAM certificate ID, you must also specify values for + // MinimumProtocolVersion and SSLSupportMethod . + // + // [Identity and Access Management (IAM)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html 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 // 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) - // 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 - // distribution uses the CloudFront domain name such as + // + // For more information, see [Security Policy] and [Supported Protocols and Ciphers Between Viewers and CloudFront] 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 distribution uses the CloudFront domain name such as // d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true ), // CloudFront automatically sets the security policy to TLSv1 regardless of the // value that you set here. + // + // [Security Policy]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy + // [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 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. + // support [server name indication (SNI)]. 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) + // requires static IP addresses for a distribution, contact CloudFront through the [Amazon Web Services Support Center] // . + // // If the distribution uses the CloudFront domain name such as // d111111abcdef8.cloudfront.net , don't set a value for this field. + // + // [server name indication (SNI)]: https://en.wikipedia.org/wiki/Server_Name_Indication + // [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/home SSLSupportMethod SSLSupportMethod noSmithyDocumentSerde diff --git a/service/cloudfrontkeyvaluestore/options.go b/service/cloudfrontkeyvaluestore/options.go index a3c1d3548ba..9aa7e4eba4d 100644 --- a/service/cloudfrontkeyvaluestore/options.go +++ b/service/cloudfrontkeyvaluestore/options.go @@ -52,8 +52,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -72,17 +74,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -102,8 +107,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -151,6 +157,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudhsm/api_op_AddTagsToResource.go b/service/cloudhsm/api_op_AddTagsToResource.go index 6b6502fdf9b..1496004753a 100644 --- a/service/cloudhsm/api_op_AddTagsToResource.go +++ b/service/cloudhsm/api_op_AddTagsToResource.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 576647eced5..5a827b5701b 100644 --- a/service/cloudhsm/api_op_CreateHapg.go +++ b/service/cloudhsm/api_op_CreateHapg.go @@ -10,17 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Creates a high-availability partition group. A high-availability partition // group is a group of partitions that spans multiple physical HSMs. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 cd6a119ec10..fa1a79a58a9 100644 --- a/service/cloudhsm/api_op_CreateHsm.go +++ b/service/cloudhsm/api_op_CreateHsm.go @@ -11,23 +11,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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 DeleteHsmoperation, go to the [AWS Support Center], 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 DescribeHsmoperation. The HSM is ready to be initialized +// when the status changes to RUNNING . // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ +// [AWS Support Center]: https://console.aws.amazon.com/support/home func (c *Client) CreateHsm(ctx context.Context, params *CreateHsmInput, optFns ...func(*Options)) (*CreateHsmOutput, error) { if params == nil { params = &CreateHsmInput{} @@ -63,7 +71,9 @@ 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. // // This member is required. @@ -73,8 +83,10 @@ 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. diff --git a/service/cloudhsm/api_op_CreateLunaClient.go b/service/cloudhsm/api_op_CreateLunaClient.go index 24286dea0fe..bcd7545574e 100644 --- a/service/cloudhsm/api_op_CreateLunaClient.go +++ b/service/cloudhsm/api_op_CreateLunaClient.go @@ -10,16 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Creates an HSM client. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 a264139d9b8..c8d4cfe3bdd 100644 --- a/service/cloudhsm/api_op_DeleteHapg.go +++ b/service/cloudhsm/api_op_DeleteHapg.go @@ -10,16 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Deletes a high-availability partition group. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 2002a9ba68b..4985d625428 100644 --- a/service/cloudhsm/api_op_DeleteHsm.go +++ b/service/cloudhsm/api_op_DeleteHsm.go @@ -10,17 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Deletes an HSM. After completion, this operation cannot be undone and your key // material cannot be recovered. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) DeleteHsm(ctx context.Context, params *DeleteHsmInput, optFns ...func(*Options)) (*DeleteHsmOutput, error) { if params == nil { params = &DeleteHsmInput{} diff --git a/service/cloudhsm/api_op_DeleteLunaClient.go b/service/cloudhsm/api_op_DeleteLunaClient.go index e4c9d438bb1..1c9e2ea3bdd 100644 --- a/service/cloudhsm/api_op_DeleteLunaClient.go +++ b/service/cloudhsm/api_op_DeleteLunaClient.go @@ -10,16 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Deletes a client. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 0e5ed9dbcf0..52294e66c70 100644 --- a/service/cloudhsm/api_op_DescribeHapg.go +++ b/service/cloudhsm/api_op_DescribeHapg.go @@ -11,16 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Retrieves information about a high-availability partition group. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 b3f68bb539e..dace28389e3 100644 --- a/service/cloudhsm/api_op_DescribeHsm.go +++ b/service/cloudhsm/api_op_DescribeHsm.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Retrieves information about an HSM. You can identify the HSM by its ARN or its // serial number. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) DescribeHsm(ctx context.Context, params *DescribeHsmInput, optFns ...func(*Options)) (*DescribeHsmOutput, error) { if params == nil { params = &DescribeHsmInput{} @@ -109,7 +114,9 @@ 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. SubscriptionType types.SubscriptionType diff --git a/service/cloudhsm/api_op_DescribeLunaClient.go b/service/cloudhsm/api_op_DescribeLunaClient.go index 7940df7f803..773ed339795 100644 --- a/service/cloudhsm/api_op_DescribeLunaClient.go +++ b/service/cloudhsm/api_op_DescribeLunaClient.go @@ -10,16 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Retrieves information about an HSM client. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 032e8a1e986..7fc650cd71c 100644 --- a/service/cloudhsm/api_op_GetConfig.go +++ b/service/cloudhsm/api_op_GetConfig.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Gets the configuration files necessary to connect to all high availability // partition groups the client is associated with. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 016e181aba5..a91c94d734e 100644 --- a/service/cloudhsm/api_op_ListAvailableZones.go +++ b/service/cloudhsm/api_op_ListAvailableZones.go @@ -10,16 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Lists the Availability Zones that have available AWS CloudHSM capacity. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 32962fc0ace..8106c52a521 100644 --- a/service/cloudhsm/api_op_ListHapgs.go +++ b/service/cloudhsm/api_op_ListHapgs.go @@ -10,19 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) ListHapgs(ctx context.Context, params *ListHapgsInput, optFns ...func(*Options)) (*ListHapgsOutput, error) { if params == nil { params = &ListHapgsInput{} diff --git a/service/cloudhsm/api_op_ListHsms.go b/service/cloudhsm/api_op_ListHsms.go index dbf71705db0..772877da0c1 100644 --- a/service/cloudhsm/api_op_ListHsms.go +++ b/service/cloudhsm/api_op_ListHsms.go @@ -10,20 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) ListHsms(ctx context.Context, params *ListHsmsInput, optFns ...func(*Options)) (*ListHsmsOutput, error) { if params == nil { params = &ListHsmsInput{} diff --git a/service/cloudhsm/api_op_ListLunaClients.go b/service/cloudhsm/api_op_ListLunaClients.go index db6785dacbc..713cdcd2ac5 100644 --- a/service/cloudhsm/api_op_ListLunaClients.go +++ b/service/cloudhsm/api_op_ListLunaClients.go @@ -10,19 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) ListLunaClients(ctx context.Context, params *ListLunaClientsInput, optFns ...func(*Options)) (*ListLunaClientsOutput, error) { if params == nil { params = &ListLunaClientsInput{} diff --git a/service/cloudhsm/api_op_ListTagsForResource.go b/service/cloudhsm/api_op_ListTagsForResource.go index 2968b59eea2..aa121373c72 100644 --- a/service/cloudhsm/api_op_ListTagsForResource.go +++ b/service/cloudhsm/api_op_ListTagsForResource.go @@ -11,16 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Returns a list of all tags for the specified AWS CloudHSM resource. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 0c7820f4b7d..575fb3b5770 100644 --- a/service/cloudhsm/api_op_ModifyHapg.go +++ b/service/cloudhsm/api_op_ModifyHapg.go @@ -10,16 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Modifies an existing high-availability partition group. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 2fe76e8b3bf..373c8c5f90c 100644 --- a/service/cloudhsm/api_op_ModifyHsm.go +++ b/service/cloudhsm/api_op_ModifyHsm.go @@ -10,20 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// for high availability, and consider executing this operation during a -// maintenance window. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) ModifyHsm(ctx context.Context, params *ModifyHsmInput, optFns ...func(*Options)) (*ModifyHsmOutput, error) { if params == nil { params = &ModifyHsmInput{} @@ -48,6 +54,7 @@ type ModifyHsmInput struct { HsmArn *string // The new IP address for the elastic network interface (ENI) attached to the HSM. + // // If the HSM is moved to a different subnet, and an IP address is not specified, // an IP address will be randomly chosen from the CIDR range of the new subnet. EniIp *string diff --git a/service/cloudhsm/api_op_ModifyLunaClient.go b/service/cloudhsm/api_op_ModifyLunaClient.go index 17f902103bf..6908bbb21bd 100644 --- a/service/cloudhsm/api_op_ModifyLunaClient.go +++ b/service/cloudhsm/api_op_ModifyLunaClient.go @@ -10,17 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// Modifies the certificate used by the client. +// +// This action can potentially start a workflow to install the new certificate on +// the client's HSMs. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ 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 05a3a8f5981..5afab6ba6ea 100644 --- a/service/cloudhsm/api_op_RemoveTagsFromResource.go +++ b/service/cloudhsm/api_op_RemoveTagsFromResource.go @@ -10,18 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// tag, specify only the tag key to remove (not the value). To overwrite the value -// for an existing tag, use AddTagsToResource . +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// 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. // // Deprecated: This API is deprecated. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error) { if params == nil { params = &RemoveTagsFromResourceInput{} @@ -44,8 +50,10 @@ type RemoveTagsFromResourceInput struct { // This member is required. 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 . + // 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. // // This member is required. TagKeyList []string diff --git a/service/cloudhsm/doc.go b/service/cloudhsm/doc.go index c7e6e3b564d..82ea89fdf71 100644 --- a/service/cloudhsm/doc.go +++ b/service/cloudhsm/doc.go @@ -3,12 +3,17 @@ // Package cloudhsm provides the API client, operations, and parameter types for // 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/) -// . +// # AWS CloudHSM Service +// +// This is documentation for AWS CloudHSM Classic. For more information, see [AWS CloudHSM Classic FAQs], the [AWS CloudHSM Classic User Guide] +// , and the [AWS CloudHSM Classic API Reference]. +// +// For information about the current version of AWS CloudHSM, see [AWS CloudHSM], the [AWS CloudHSM User Guide], and the [AWS CloudHSM API Reference]. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM Classic FAQs]: http://aws.amazon.com/cloudhsm/faqs-classic/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ +// [AWS CloudHSM API Reference]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/ +// [AWS CloudHSM Classic User Guide]: https://docs.aws.amazon.com/cloudhsm/classic/userguide/ +// [AWS CloudHSM Classic API Reference]: https://docs.aws.amazon.com/cloudhsm/classic/APIReference/ package cloudhsm diff --git a/service/cloudhsm/options.go b/service/cloudhsm/options.go index 9dc12483622..f5c36b00231 100644 --- a/service/cloudhsm/options.go +++ b/service/cloudhsm/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudhsm/types/enums.go b/service/cloudhsm/types/enums.go index 467cae13d45..9eba8bf2268 100644 --- a/service/cloudhsm/types/enums.go +++ b/service/cloudhsm/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ClientVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientVersion) Values() []ClientVersion { return []ClientVersion{ "5.1", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for CloudHsmObjectState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudHsmObjectState) Values() []CloudHsmObjectState { return []CloudHsmObjectState{ "READY", @@ -54,8 +56,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for SubscriptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionType) Values() []SubscriptionType { return []SubscriptionType{ "PRODUCTION", diff --git a/service/cloudhsmv2/api_op_CopyBackupToRegion.go b/service/cloudhsmv2/api_op_CopyBackupToRegion.go index 7699d27d6bb..8898821075d 100644 --- a/service/cloudhsmv2/api_op_CopyBackupToRegion.go +++ b/service/cloudhsmv2/api_op_CopyBackupToRegion.go @@ -52,9 +52,10 @@ type CopyBackupToRegionOutput struct { // Information on the backup that will be copied to the destination region, // including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. // CreateTimestamp of the destination backup will be the same as that of the source - // backup. You will need to use the sourceBackupID returned in this operation to - // use the DescribeBackups operation on the backup that will be copied to the - // destination region. + // backup. + // + // You will need to use the sourceBackupID returned in this operation to use the DescribeBackups + // operation on the backup that will be copied to the destination region. DestinationBackup *types.DestinationBackup // Metadata pertaining to the operation's result. diff --git a/service/cloudhsmv2/api_op_CreateCluster.go b/service/cloudhsmv2/api_op_CreateCluster.go index 79d2dc1d7f9..3c8aee1d841 100644 --- a/service/cloudhsmv2/api_op_CreateCluster.go +++ b/service/cloudhsmv2/api_op_CreateCluster.go @@ -38,7 +38,9 @@ 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. // // This member is required. @@ -49,7 +51,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 61abd4cb85f..6babad036c8 100644 --- a/service/cloudhsmv2/api_op_CreateHsm.go +++ b/service/cloudhsmv2/api_op_CreateHsm.go @@ -31,13 +31,12 @@ 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 . + // The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters. // // This member is required. ClusterId *string diff --git a/service/cloudhsmv2/api_op_DeleteBackup.go b/service/cloudhsmv2/api_op_DeleteBackup.go index ab442e74923..389688b50dc 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{} @@ -31,8 +31,8 @@ func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, op type DeleteBackupInput struct { - // The ID of the backup to be deleted. To find the ID of a backup, use the - // DescribeBackups operation. + // The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups + // operation. // // This member is required. BackupId *string diff --git a/service/cloudhsmv2/api_op_DeleteCluster.go b/service/cloudhsmv2/api_op_DeleteCluster.go index 7881a85db67..36e56c79950 100644 --- a/service/cloudhsmv2/api_op_DeleteCluster.go +++ b/service/cloudhsmv2/api_op_DeleteCluster.go @@ -13,7 +13,7 @@ import ( // 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 . +// 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 9f0fdbba550..3cd99e6c18e 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 eeddb441599..3b0b4a0843b 100644 --- a/service/cloudhsmv2/api_op_DescribeBackups.go +++ b/service/cloudhsmv2/api_op_DescribeBackups.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about backups of AWS CloudHSM clusters. This is a paginated -// 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. +// Gets information about backups of AWS CloudHSM clusters. +// +// This is a paginated 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. func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInput, optFns ...func(*Options)) (*DescribeBackupsOutput, error) { if params == nil { params = &DescribeBackupsInput{} @@ -34,17 +36,23 @@ func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInp type DescribeBackupsInput struct { - // One or more filters to limit the items returned in the response. Use the - // backupIds filter to return only the specified backups. Specify backups by their - // backup identifier (ID). Use the sourceBackupIds filter to return only the - // 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. + // One or more filters to limit the items returned in the response. + // + // Use the backupIds filter to return only the specified backups. Specify backups + // by their backup identifier (ID). + // + // Use the sourceBackupIds filter to return only the 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. 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 4233a89b323..6747300c572 100644 --- a/service/cloudhsmv2/api_op_DescribeClusters.go +++ b/service/cloudhsmv2/api_op_DescribeClusters.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about AWS CloudHSM clusters. This is a paginated operation, -// which means that each response might contain only a subset of all the clusters. -// When the response contains only a subset of clusters, it includes a NextToken -// value. Use this value in a subsequent DescribeClusters request to get more -// clusters. When you receive a response with no NextToken (or an empty or null -// value), that means there are no more clusters to get. +// Gets information about AWS CloudHSM clusters. +// +// This is a paginated operation, which means that each response might contain +// only a subset of all the clusters. When the response contains only a subset of +// clusters, it includes a NextToken value. Use this value in a subsequent +// DescribeClusters request to get more clusters. When you receive a response with +// no NextToken (or an empty or null value), that means there are no more clusters +// to get. func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersInput, optFns ...func(*Options)) (*DescribeClustersOutput, error) { if params == nil { params = &DescribeClustersInput{} @@ -34,12 +36,15 @@ func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersI 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. + // 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. 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 4ed9b937b74..3b1329a14cc 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 045b5c99681..07e86db75e6 100644 --- a/service/cloudhsmv2/api_op_ListTags.go +++ b/service/cloudhsmv2/api_op_ListTags.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of tags for the specified AWS CloudHSM cluster. This is a paginated -// 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. +// Gets a list of tags for the specified AWS CloudHSM cluster. +// +// This is a paginated 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. func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error) { if params == nil { params = &ListTagsInput{} @@ -35,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 059e89097b8..631f13cc89f 100644 --- a/service/cloudhsmv2/api_op_ModifyBackupAttributes.go +++ b/service/cloudhsmv2/api_op_ModifyBackupAttributes.go @@ -30,7 +30,7 @@ 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 DescribeBackupsoperation. // // This member is required. BackupId *string diff --git a/service/cloudhsmv2/api_op_ModifyCluster.go b/service/cloudhsmv2/api_op_ModifyCluster.go index 2c487dfad2c..c0775078b84 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 a149d0639a9..b471cfb311a 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{} @@ -30,8 +30,8 @@ func (c *Client) RestoreBackup(ctx context.Context, params *RestoreBackupInput, type RestoreBackupInput struct { - // The ID of the backup to be restored. To find the ID of a backup, use the - // DescribeBackups operation. + // The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups + // operation. // // This member is required. BackupId *string diff --git a/service/cloudhsmv2/api_op_TagResource.go b/service/cloudhsmv2/api_op_TagResource.go index 86a6adb8b45..4210d931f34 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 d69dc145d44..fc62fe0d1f4 100644 --- a/service/cloudhsmv2/api_op_UntagResource.go +++ b/service/cloudhsmv2/api_op_UntagResource.go @@ -29,7 +29,7 @@ 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 . + // 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 6c86685ce8d..ed691474650 100644 --- a/service/cloudhsmv2/doc.go +++ b/service/cloudhsmv2/doc.go @@ -3,7 +3,8 @@ // 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] and the [AWS CloudHSM User Guide]. +// +// [AWS CloudHSM User Guide]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/ +// [AWS CloudHSM]: http://aws.amazon.com/cloudhsm/ package cloudhsmv2 diff --git a/service/cloudhsmv2/options.go b/service/cloudhsmv2/options.go index 44c25a26f27..e5a3d1b26eb 100644 --- a/service/cloudhsmv2/options.go +++ b/service/cloudhsmv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudhsmv2/types/enums.go b/service/cloudhsmv2/types/enums.go index 4b9c9f46aa3..be9a2f6d1d2 100644 --- a/service/cloudhsmv2/types/enums.go +++ b/service/cloudhsmv2/types/enums.go @@ -10,8 +10,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -26,8 +27,9 @@ const ( ) // Values returns all known values for BackupRetentionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupRetentionType) Values() []BackupRetentionType { return []BackupRetentionType{ "DAYS", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for BackupState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupState) Values() []BackupState { return []BackupState{ "CREATE_IN_PROGRESS", @@ -72,8 +75,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -100,8 +104,9 @@ const ( ) // Values returns all known values for HsmState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HsmState) Values() []HsmState { return []HsmState{ "CREATE_IN_PROGRESS", diff --git a/service/cloudhsmv2/types/types.go b/service/cloudhsmv2/types/types.go index 44ffa9e510b..754ea807f64 100644 --- a/service/cloudhsmv2/types/types.go +++ b/service/cloudhsmv2/types/types.go @@ -146,8 +146,8 @@ type Cluster struct { noSmithyDocumentSerde } -// Contains information about the backup that will be copied and created by the -// CopyBackupToRegion operation. +// Contains information about the backup that will be copied and created by the CopyBackupToRegion +// operation. type DestinationBackup struct { // The date and time when both the source backup was created. diff --git a/service/cloudsearch/api_op_BuildSuggesters.go b/service/cloudsearch/api_op_BuildSuggesters.go index e91de59a8e4..c14b201d752 100644 --- a/service/cloudsearch/api_op_BuildSuggesters.go +++ b/service/cloudsearch/api_op_BuildSuggesters.go @@ -10,8 +10,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// Indexes the search suggestions. For more information, see [Configuring Suggesters] in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Suggesters]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters func (c *Client) BuildSuggesters(ctx context.Context, params *BuildSuggestersInput, optFns ...func(*Options)) (*BuildSuggestersOutput, error) { if params == nil { params = &BuildSuggestersInput{} @@ -27,8 +29,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 e310b479e23..2f38f8e32c7 100644 --- a/service/cloudsearch/api_op_CreateDomain.go +++ b/service/cloudsearch/api_op_CreateDomain.go @@ -11,8 +11,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// Creates a new search domain. For more information, see [Creating a Search Domain] in the Amazon +// CloudSearch Developer Guide. +// +// [Creating a Search Domain]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} @@ -28,8 +30,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 diff --git a/service/cloudsearch/api_op_DefineAnalysisScheme.go b/service/cloudsearch/api_op_DefineAnalysisScheme.go index 511628598af..1fd74f6a1aa 100644 --- a/service/cloudsearch/api_op_DefineAnalysisScheme.go +++ b/service/cloudsearch/api_op_DefineAnalysisScheme.go @@ -12,9 +12,10 @@ 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) +// to define language-specific text processing options. For more information, see [Configuring Analysis Schemes] // in the Amazon CloudSearch Developer Guide. +// +// [Configuring Analysis Schemes]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html func (c *Client) DefineAnalysisScheme(ctx context.Context, params *DefineAnalysisSchemeInput, optFns ...func(*Options)) (*DefineAnalysisSchemeOutput, error) { if params == nil { params = &DefineAnalysisSchemeInput{} @@ -30,8 +31,8 @@ func (c *Client) DefineAnalysisScheme(ctx context.Context, params *DefineAnalysi return out, nil } -// Container for the parameters to the DefineAnalysisScheme operation. Specifies -// the name of the domain you want to update and the analysis scheme configuration. +// Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the +// domain you want to update and the analysis scheme configuration. type DefineAnalysisSchemeInput struct { // Configuration information for an analysis scheme. Each analysis scheme has a @@ -53,8 +54,8 @@ type DefineAnalysisSchemeInput struct { noSmithyDocumentSerde } -// The result of a DefineAnalysisScheme request. Contains the status of the -// newly-configured analysis scheme. +// The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis +// scheme. type DefineAnalysisSchemeOutput struct { // The status and configuration of an AnalysisScheme . diff --git a/service/cloudsearch/api_op_DefineExpression.go b/service/cloudsearch/api_op_DefineExpression.go index d91bb4b65e7..fbfac697c81 100644 --- a/service/cloudsearch/api_op_DefineExpression.go +++ b/service/cloudsearch/api_op_DefineExpression.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon CloudSearch Developer Guide. +// 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]in the Amazon CloudSearch Developer Guide. +// +// [Configuring Expressions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html func (c *Client) DefineExpression(ctx context.Context, params *DefineExpressionInput, optFns ...func(*Options)) (*DefineExpressionOutput, error) { if params == nil { params = &DefineExpressionInput{} @@ -30,8 +31,8 @@ func (c *Client) DefineExpression(ctx context.Context, params *DefineExpressionI return out, nil } -// Container for the parameters to the DefineExpression operation. Specifies the -// name of the domain you want to update and the expression you want to configure. +// Container for the parameters to the DefineExpression operation. Specifies the name of the +// domain you want to update and the expression you want to configure. type DefineExpressionInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_DefineIndexField.go b/service/cloudsearch/api_op_DefineIndexField.go index fcdc5955457..9edf891d8ed 100644 --- a/service/cloudsearch/api_op_DefineIndexField.go +++ b/service/cloudsearch/api_op_DefineIndexField.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Configures an IndexField for the search domain. Used to create new fields and -// modify existing ones. You must specify the name of the domain you are -// 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) -// in the Amazon CloudSearch Developer Guide. +// Configures an IndexField for the search domain. Used to create new fields and modify +// existing ones. You must specify the name of the domain you are 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]in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Index Fields]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html func (c *Client) DefineIndexField(ctx context.Context, params *DefineIndexFieldInput, optFns ...func(*Options)) (*DefineIndexFieldOutput, error) { if params == nil { params = &DefineIndexFieldInput{} @@ -34,8 +35,8 @@ func (c *Client) DefineIndexField(ctx context.Context, params *DefineIndexFieldI return out, nil } -// Container for the parameters to the DefineIndexField operation. Specifies the -// name of the domain you want to update and the index field configuration. +// Container for the parameters to the DefineIndexField operation. Specifies the name of the +// domain you want to update and the index field configuration. type DefineIndexFieldInput struct { // A string that represents the name of a domain. Domain names are unique across @@ -54,8 +55,8 @@ type DefineIndexFieldInput struct { noSmithyDocumentSerde } -// The result of a DefineIndexField request. Contains the status of the -// newly-configured index field. +// The result of a DefineIndexField request. Contains the status of the newly-configured index +// field. type DefineIndexFieldOutput struct { // The value of an IndexField and its current status. diff --git a/service/cloudsearch/api_op_DefineSuggester.go b/service/cloudsearch/api_op_DefineSuggester.go index 975c9adacae..e1d573ad421 100644 --- a/service/cloudsearch/api_op_DefineSuggester.go +++ b/service/cloudsearch/api_op_DefineSuggester.go @@ -14,9 +14,10 @@ import ( // 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) +// possible matches and a unique name for the suggester. For more information, see [Getting Search Suggestions] // in the Amazon CloudSearch Developer Guide. +// +// [Getting Search Suggestions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html func (c *Client) DefineSuggester(ctx context.Context, params *DefineSuggesterInput, optFns ...func(*Options)) (*DefineSuggesterOutput, error) { if params == nil { params = &DefineSuggesterInput{} @@ -32,8 +33,8 @@ func (c *Client) DefineSuggester(ctx context.Context, params *DefineSuggesterInp return out, nil } -// Container for the parameters to the DefineSuggester operation. Specifies the -// name of the domain you want to update and the suggester configuration. +// Container for the parameters to the DefineSuggester operation. Specifies the name of the +// domain you want to update and the suggester configuration. type DefineSuggesterInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_DeleteAnalysisScheme.go b/service/cloudsearch/api_op_DeleteAnalysisScheme.go index f457590cce4..02ca3d8611c 100644 --- a/service/cloudsearch/api_op_DeleteAnalysisScheme.go +++ b/service/cloudsearch/api_op_DeleteAnalysisScheme.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an analysis scheme. For more information, see Configuring Analysis -// Schemes (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html) -// in the Amazon CloudSearch Developer Guide. +// Deletes an analysis scheme. For more information, see [Configuring Analysis Schemes] in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Analysis Schemes]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html func (c *Client) DeleteAnalysisScheme(ctx context.Context, params *DeleteAnalysisSchemeInput, optFns ...func(*Options)) (*DeleteAnalysisSchemeOutput, error) { if params == nil { params = &DeleteAnalysisSchemeInput{} @@ -29,9 +30,8 @@ func (c *Client) DeleteAnalysisScheme(ctx context.Context, params *DeleteAnalysi return out, nil } -// Container for the parameters to the DeleteAnalysisScheme operation. Specifies -// the name of the domain you want to update and the analysis scheme you want to -// delete. +// Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the +// domain you want to update and the analysis scheme you want to delete. type DeleteAnalysisSchemeInput struct { // The name of the analysis scheme you want to delete. diff --git a/service/cloudsearch/api_op_DeleteDomain.go b/service/cloudsearch/api_op_DeleteDomain.go index 5da094587b5..485d2241c6a 100644 --- a/service/cloudsearch/api_op_DeleteDomain.go +++ b/service/cloudsearch/api_op_DeleteDomain.go @@ -12,9 +12,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// deleted, it cannot be recovered. For more information, see [Deleting a Search Domain]in the Amazon +// CloudSearch Developer Guide. +// +// [Deleting a Search Domain]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} @@ -30,8 +31,8 @@ func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, op return out, nil } -// Container for the parameters to the DeleteDomain operation. Specifies the name -// of the domain you want to delete. +// Container for the parameters to the DeleteDomain operation. Specifies the name of the +// domain you want to delete. type DeleteDomainInput struct { // The name of the domain you want to permanently delete. diff --git a/service/cloudsearch/api_op_DeleteExpression.go b/service/cloudsearch/api_op_DeleteExpression.go index 58b346b8ac3..7b58ebb8ee4 100644 --- a/service/cloudsearch/api_op_DeleteExpression.go +++ b/service/cloudsearch/api_op_DeleteExpression.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes an Expression from the search domain. For more information, see -// Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html) -// in the Amazon CloudSearch Developer Guide. +// Removes an Expression from the search domain. For more information, see [Configuring Expressions] in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Expressions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html func (c *Client) DeleteExpression(ctx context.Context, params *DeleteExpressionInput, optFns ...func(*Options)) (*DeleteExpressionOutput, error) { if params == nil { params = &DeleteExpressionInput{} @@ -29,9 +30,8 @@ func (c *Client) DeleteExpression(ctx context.Context, params *DeleteExpressionI return out, nil } -// Container for the parameters to the DeleteExpression operation. Specifies the -// name of the domain you want to update and the name of the expression you want to -// delete. +// Container for the parameters to the DeleteExpression operation. Specifies the name of the +// domain you want to update and the name of the expression you want to delete. type DeleteExpressionInput struct { // A string that represents the name of a domain. Domain names are unique across @@ -50,8 +50,7 @@ type DeleteExpressionInput struct { noSmithyDocumentSerde } -// The result of a DeleteExpression request. Specifies the expression being -// deleted. +// The result of a DeleteExpression request. Specifies the expression being deleted. type DeleteExpressionOutput struct { // The status of the expression being deleted. diff --git a/service/cloudsearch/api_op_DeleteIndexField.go b/service/cloudsearch/api_op_DeleteIndexField.go index 6555e594933..b4788db8273 100644 --- a/service/cloudsearch/api_op_DeleteIndexField.go +++ b/service/cloudsearch/api_op_DeleteIndexField.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon CloudSearch Developer Guide. +// Removes an IndexField from the search domain. For more information, see [Configuring Index Fields] in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Index Fields]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html func (c *Client) DeleteIndexField(ctx context.Context, params *DeleteIndexFieldInput, optFns ...func(*Options)) (*DeleteIndexFieldOutput, error) { if params == nil { params = &DeleteIndexFieldInput{} @@ -29,9 +30,8 @@ func (c *Client) DeleteIndexField(ctx context.Context, params *DeleteIndexFieldI return out, nil } -// Container for the parameters to the DeleteIndexField operation. Specifies the -// name of the domain you want to update and the name of the index field you want -// to delete. +// Container for the parameters to the DeleteIndexField operation. Specifies the name of the +// domain you want to update and the name of the index field you want to delete. type DeleteIndexFieldInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_DeleteSuggester.go b/service/cloudsearch/api_op_DeleteSuggester.go index 8c5e2a4bb96..5758500fe9b 100644 --- a/service/cloudsearch/api_op_DeleteSuggester.go +++ b/service/cloudsearch/api_op_DeleteSuggester.go @@ -11,8 +11,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// Deletes a suggester. For more information, see [Getting Search Suggestions] in the Amazon CloudSearch +// Developer Guide. +// +// [Getting Search Suggestions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html func (c *Client) DeleteSuggester(ctx context.Context, params *DeleteSuggesterInput, optFns ...func(*Options)) (*DeleteSuggesterOutput, error) { if params == nil { params = &DeleteSuggesterInput{} @@ -28,9 +30,8 @@ func (c *Client) DeleteSuggester(ctx context.Context, params *DeleteSuggesterInp return out, nil } -// Container for the parameters to the DeleteSuggester operation. Specifies the -// name of the domain you want to update and name of the suggester you want to -// delete. +// Container for the parameters to the DeleteSuggester operation. Specifies the name of the +// domain you want to update and name of the suggester you want to delete. type DeleteSuggesterInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_DescribeAnalysisSchemes.go b/service/cloudsearch/api_op_DescribeAnalysisSchemes.go index 8958fe68a73..c6fb77c1d96 100644 --- a/service/cloudsearch/api_op_DescribeAnalysisSchemes.go +++ b/service/cloudsearch/api_op_DescribeAnalysisSchemes.go @@ -16,8 +16,9 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// information, see [Configuring Analysis Schemes]in the Amazon CloudSearch Developer Guide. +// +// [Configuring Analysis Schemes]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html func (c *Client) DescribeAnalysisSchemes(ctx context.Context, params *DescribeAnalysisSchemesInput, optFns ...func(*Options)) (*DescribeAnalysisSchemesOutput, error) { if params == nil { params = &DescribeAnalysisSchemesInput{} @@ -33,11 +34,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. diff --git a/service/cloudsearch/api_op_DescribeAvailabilityOptions.go b/service/cloudsearch/api_op_DescribeAvailabilityOptions.go index f03759e5a85..6ee86990732 100644 --- a/service/cloudsearch/api_op_DescribeAvailabilityOptions.go +++ b/service/cloudsearch/api_op_DescribeAvailabilityOptions.go @@ -13,9 +13,10 @@ 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) +// the active configuration and exclude pending changes. For more information, see [Configuring Availability Options] // in the Amazon CloudSearch Developer Guide. +// +// [Configuring Availability Options]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html func (c *Client) DescribeAvailabilityOptions(ctx context.Context, params *DescribeAvailabilityOptionsInput, optFns ...func(*Options)) (*DescribeAvailabilityOptionsOutput, error) { if params == nil { params = &DescribeAvailabilityOptionsInput{} @@ -31,9 +32,9 @@ func (c *Client) DescribeAvailabilityOptions(ctx context.Context, params *Descri return out, nil } -// 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 . +// 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 . type DescribeAvailabilityOptionsInput struct { // The name of the domain you want to describe. diff --git a/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go b/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go index 8fdfd503f60..f9776b482c4 100644 --- a/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go +++ b/service/cloudsearch/api_op_DescribeDomainEndpointOptions.go @@ -12,9 +12,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// domain must arrive over HTTPS. For more information, see [Configuring Domain Endpoint Options]in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Domain Endpoint Options]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html func (c *Client) DescribeDomainEndpointOptions(ctx context.Context, params *DescribeDomainEndpointOptionsInput, optFns ...func(*Options)) (*DescribeDomainEndpointOptionsOutput, error) { if params == nil { params = &DescribeDomainEndpointOptionsInput{} @@ -30,9 +31,9 @@ func (c *Client) DescribeDomainEndpointOptions(ctx context.Context, params *Desc return out, nil } -// 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 . +// 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 . type DescribeDomainEndpointOptionsInput struct { // A string that represents the name of a domain. diff --git a/service/cloudsearch/api_op_DescribeDomains.go b/service/cloudsearch/api_op_DescribeDomains.go index 3961887f9d2..bf3de4f853a 100644 --- a/service/cloudsearch/api_op_DescribeDomains.go +++ b/service/cloudsearch/api_op_DescribeDomains.go @@ -15,8 +15,9 @@ import ( // 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) -// in the Amazon CloudSearch Developer Guide. +// more information, see [Getting Information about a Search Domain]in the Amazon CloudSearch Developer Guide. +// +// [Getting Information about a Search Domain]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html func (c *Client) DescribeDomains(ctx context.Context, params *DescribeDomainsInput, optFns ...func(*Options)) (*DescribeDomainsOutput, error) { if params == nil { params = &DescribeDomainsInput{} @@ -32,9 +33,9 @@ func (c *Client) DescribeDomains(ctx context.Context, params *DescribeDomainsInp return out, nil } -// Container for the parameters to the DescribeDomains operation. By default shows -// the status of all domains. To restrict the response to particular domains, -// specify the names of the domains you want to describe. +// Container for the parameters to the DescribeDomains operation. By default shows the status of +// all domains. To restrict the response to particular domains, specify the names +// of the domains you want to describe. type DescribeDomainsInput struct { // The names of the domains you want to include in the response. diff --git a/service/cloudsearch/api_op_DescribeExpressions.go b/service/cloudsearch/api_op_DescribeExpressions.go index 4e9cfbf87e2..a607883471a 100644 --- a/service/cloudsearch/api_op_DescribeExpressions.go +++ b/service/cloudsearch/api_op_DescribeExpressions.go @@ -14,9 +14,10 @@ import ( // Gets the expressions configured for the search domain. Can be limited to // 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) +// the active configuration and exclude pending changes. For more information, see [Configuring Expressions] // in the Amazon CloudSearch Developer Guide. +// +// [Configuring Expressions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html func (c *Client) DescribeExpressions(ctx context.Context, params *DescribeExpressionsInput, optFns ...func(*Options)) (*DescribeExpressionsOutput, error) { if params == nil { params = &DescribeExpressionsInput{} @@ -32,11 +33,10 @@ func (c *Client) DescribeExpressions(ctx context.Context, params *DescribeExpres return out, nil } -// Container for the parameters to the DescribeDomains operation. Specifies the -// 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 . +// Container for the parameters to the DescribeDomains operation. Specifies the 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 . type DescribeExpressionsInput struct { // The name of the domain you want to describe. @@ -48,8 +48,8 @@ type DescribeExpressionsInput struct { // changes ( false ). Defaults to false . Deployed *bool - // Limits the DescribeExpressions response to the specified expressions. If not - // specified, all expressions are shown. + // Limits the DescribeExpressions response to the specified expressions. If not specified, all + // expressions are shown. ExpressionNames []string noSmithyDocumentSerde diff --git a/service/cloudsearch/api_op_DescribeIndexFields.go b/service/cloudsearch/api_op_DescribeIndexFields.go index de8d052c42f..0d1673eb33b 100644 --- a/service/cloudsearch/api_op_DescribeIndexFields.go +++ b/service/cloudsearch/api_op_DescribeIndexFields.go @@ -15,8 +15,9 @@ import ( // 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) -// in the Amazon CloudSearch Developer Guide. +// see [Getting Domain Information]in the Amazon CloudSearch Developer Guide. +// +// [Getting Domain Information]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html func (c *Client) DescribeIndexFields(ctx context.Context, params *DescribeIndexFieldsInput, optFns ...func(*Options)) (*DescribeIndexFieldsOutput, error) { if params == nil { params = &DescribeIndexFieldsInput{} @@ -32,11 +33,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. diff --git a/service/cloudsearch/api_op_DescribeScalingParameters.go b/service/cloudsearch/api_op_DescribeScalingParameters.go index 1829ed6de49..ece4b578f20 100644 --- a/service/cloudsearch/api_op_DescribeScalingParameters.go +++ b/service/cloudsearch/api_op_DescribeScalingParameters.go @@ -13,8 +13,9 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// more information, see [Configuring Scaling Options]in the Amazon CloudSearch Developer Guide. +// +// [Configuring Scaling Options]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html func (c *Client) DescribeScalingParameters(ctx context.Context, params *DescribeScalingParametersInput, optFns ...func(*Options)) (*DescribeScalingParametersOutput, error) { if params == nil { params = &DescribeScalingParametersInput{} @@ -30,8 +31,8 @@ func (c *Client) DescribeScalingParameters(ctx context.Context, params *Describe return out, nil } -// Container for the parameters to the DescribeScalingParameters operation. -// Specifies the name of the domain you want to describe. +// Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the +// domain you want to describe. type DescribeScalingParametersInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go b/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go index 405b37e201a..68e5e26bcba 100644 --- a/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go +++ b/service/cloudsearch/api_op_DescribeServiceAccessPolicies.go @@ -14,9 +14,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// configuration and exclude pending changes. For more information, see [Configuring Access for a Search Domain]in the +// Amazon CloudSearch Developer Guide. +// +// [Configuring Access for a Search Domain]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html func (c *Client) DescribeServiceAccessPolicies(ctx context.Context, params *DescribeServiceAccessPoliciesInput, optFns ...func(*Options)) (*DescribeServiceAccessPoliciesOutput, error) { if params == nil { params = &DescribeServiceAccessPoliciesInput{} @@ -32,9 +33,9 @@ func (c *Client) DescribeServiceAccessPolicies(ctx context.Context, params *Desc return out, nil } -// 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 . +// 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 . type DescribeServiceAccessPoliciesInput struct { // The name of the domain you want to describe. diff --git a/service/cloudsearch/api_op_DescribeSuggesters.go b/service/cloudsearch/api_op_DescribeSuggesters.go index 8a9b93710f5..3a5c7e3f5a1 100644 --- a/service/cloudsearch/api_op_DescribeSuggesters.go +++ b/service/cloudsearch/api_op_DescribeSuggesters.go @@ -15,9 +15,10 @@ import ( // possible matches before users finish typing their queries. Can be limited to // 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) +// the active configuration and exclude pending changes. For more information, see [Getting Search Suggestions] // in the Amazon CloudSearch Developer Guide. +// +// [Getting Search Suggestions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html func (c *Client) DescribeSuggesters(ctx context.Context, params *DescribeSuggestersInput, optFns ...func(*Options)) (*DescribeSuggestersOutput, error) { if params == nil { params = &DescribeSuggestersInput{} @@ -33,11 +34,10 @@ func (c *Client) DescribeSuggesters(ctx context.Context, params *DescribeSuggest return out, nil } -// Container for the parameters to the DescribeSuggester operation. Specifies the -// 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 . +// Container for the parameters to the DescribeSuggester operation. Specifies the 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 . type DescribeSuggestersInput struct { // The name of the domain you want to describe. diff --git a/service/cloudsearch/api_op_IndexDocuments.go b/service/cloudsearch/api_op_IndexDocuments.go index 0ae9ff91d6b..fd6b11bfc6c 100644 --- a/service/cloudsearch/api_op_IndexDocuments.go +++ b/service/cloudsearch/api_op_IndexDocuments.go @@ -11,8 +11,8 @@ 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 . +// indexing options. This operation must be invoked to activate options whose OptionStatusis +// 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_UpdateAvailabilityOptions.go b/service/cloudsearch/api_op_UpdateAvailabilityOptions.go index a2735c521f7..d46a90ebcdc 100644 --- a/service/cloudsearch/api_op_UpdateAvailabilityOptions.go +++ b/service/cloudsearch/api_op_UpdateAvailabilityOptions.go @@ -15,8 +15,9 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// more information, see [Configuring Availability Options]in the Amazon CloudSearch Developer Guide. +// +// [Configuring Availability Options]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html func (c *Client) UpdateAvailabilityOptions(ctx context.Context, params *UpdateAvailabilityOptionsInput, optFns ...func(*Options)) (*UpdateAvailabilityOptionsOutput, error) { if params == nil { params = &UpdateAvailabilityOptionsInput{} @@ -32,9 +33,8 @@ func (c *Client) UpdateAvailabilityOptions(ctx context.Context, params *UpdateAv return out, nil } -// Container for the parameters to the UpdateAvailabilityOptions operation. -// Specifies the name of the domain you want to update and the Multi-AZ -// availability option. +// Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the +// domain you want to update and the Multi-AZ availability option. type UpdateAvailabilityOptionsInput struct { // A string that represents the name of a domain. Domain names are unique across diff --git a/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go b/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go index 10ca86ccb56..49af3466502 100644 --- a/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go +++ b/service/cloudsearch/api_op_UpdateDomainEndpointOptions.go @@ -12,9 +12,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// domain must arrive over HTTPS. For more information, see [Configuring Domain Endpoint Options]in the Amazon +// CloudSearch Developer Guide. +// +// [Configuring Domain Endpoint Options]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-domain-endpoint-options.html func (c *Client) UpdateDomainEndpointOptions(ctx context.Context, params *UpdateDomainEndpointOptionsInput, optFns ...func(*Options)) (*UpdateDomainEndpointOptionsOutput, error) { if params == nil { params = &UpdateDomainEndpointOptionsInput{} @@ -30,9 +31,8 @@ func (c *Client) UpdateDomainEndpointOptions(ctx context.Context, params *Update return out, nil } -// Container for the parameters to the UpdateDomainEndpointOptions operation. -// Specifies the name of the domain you want to update and the domain endpoint -// options. +// Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the +// domain you want to update and the domain endpoint options. type UpdateDomainEndpointOptionsInput struct { // Whether to require that all requests to the domain arrive over HTTPS. We diff --git a/service/cloudsearch/api_op_UpdateScalingParameters.go b/service/cloudsearch/api_op_UpdateScalingParameters.go index 3ef7fa7cc9f..d6928d07da3 100644 --- a/service/cloudsearch/api_op_UpdateScalingParameters.go +++ b/service/cloudsearch/api_op_UpdateScalingParameters.go @@ -16,8 +16,10 @@ 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) -// in the Amazon CloudSearch Developer Guide. +// Availability Zone. For more information, see [Configuring Scaling Options]in the Amazon CloudSearch +// Developer Guide. +// +// [Configuring Scaling Options]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html func (c *Client) UpdateScalingParameters(ctx context.Context, params *UpdateScalingParametersInput, optFns ...func(*Options)) (*UpdateScalingParametersOutput, error) { if params == nil { params = &UpdateScalingParametersInput{} @@ -33,9 +35,8 @@ 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 0a4a3bddde0..16e8d8feb92 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]. +// +// [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{} @@ -30,9 +30,8 @@ func (c *Client) UpdateServiceAccessPolicies(ctx context.Context, params *Update return out, nil } -// Container for the parameters to the UpdateServiceAccessPolicies operation. -// Specifies the name of the domain you want to update and the access rules you -// want to configure. +// Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the +// domain you want to update and the access rules you want to configure. type UpdateServiceAccessPoliciesInput struct { // The access rules you want to configure. These rules replace any existing rules. diff --git a/service/cloudsearch/doc.go b/service/cloudsearch/doc.go index 800d931176c..ef704a4444b 100644 --- a/service/cloudsearch/doc.go +++ b/service/cloudsearch/doc.go @@ -3,13 +3,17 @@ // 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. -// Configuration service requests are submitted using the AWS Query protocol. AWS -// Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a -// query parameter named Action. The endpoint for configuration service requests is -// region-specific: cloudsearch.region.amazonaws.com. For example, +// # Amazon CloudSearch Configuration Service +// +// You use the Amazon CloudSearch configuration service to create, configure, and +// manage search domains. Configuration service requests are submitted using the +// AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via +// HTTP GET or POST with a 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]. +// +// [Regions and Endpoints]: http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region package cloudsearch diff --git a/service/cloudsearch/options.go b/service/cloudsearch/options.go index a5d00c96a33..1264c38d165 100644 --- a/service/cloudsearch/options.go +++ b/service/cloudsearch/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudsearch/types/enums.go b/service/cloudsearch/types/enums.go index e1af516b5fa..c82efb688bd 100644 --- a/service/cloudsearch/types/enums.go +++ b/service/cloudsearch/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AlgorithmicStemming. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmicStemming) Values() []AlgorithmicStemming { return []AlgorithmicStemming{ "none", @@ -66,8 +67,9 @@ const ( ) // Values returns all known values for AnalysisSchemeLanguage. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisSchemeLanguage) Values() []AnalysisSchemeLanguage { return []AnalysisSchemeLanguage{ "ar", @@ -126,8 +128,9 @@ const ( ) // Values returns all known values for IndexFieldType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndexFieldType) Values() []IndexFieldType { return []IndexFieldType{ "int", @@ -155,8 +158,9 @@ const ( ) // Values returns all known values for OptionState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptionState) Values() []OptionState { return []OptionState{ "RequiresIndexDocuments", @@ -190,8 +194,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "search.m1.small", @@ -224,8 +229,9 @@ const ( ) // Values returns all known values for SuggesterFuzzyMatching. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SuggesterFuzzyMatching) Values() []SuggesterFuzzyMatching { return []SuggesterFuzzyMatching{ "none", @@ -243,8 +249,9 @@ const ( ) // Values returns all known values for TLSSecurityPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TLSSecurityPolicy) Values() []TLSSecurityPolicy { return []TLSSecurityPolicy{ "Policy-Min-TLS-1-0-2019-07", diff --git a/service/cloudsearch/types/errors.go b/service/cloudsearch/types/errors.go index 27e41d68d20..5b743f434a8 100644 --- a/service/cloudsearch/types/errors.go +++ b/service/cloudsearch/types/errors.go @@ -64,8 +64,9 @@ 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]. +// +// [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 00b538e4272..2809a1b92b6 100644 --- a/service/cloudsearch/types/types.go +++ b/service/cloudsearch/types/types.go @@ -12,9 +12,10 @@ 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) - // in the Amazon CloudSearch Developer Guide. The maximum size of a policy document - // is 100 KB. + // information, see [Configuring Access for a Search Domain]in the Amazon CloudSearch Developer Guide. The maximum size of + // a policy document is 100 KB. + // + // [Configuring Access for a Search Domain]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html // // This member is required. Options *string @@ -32,9 +33,10 @@ type AccessPoliciesStatus struct { 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 available levels vary depending on the language. For more information, see [Language Specific Text Processing Settings] // in the Amazon CloudSearch Developer Guide + // + // [Language Specific Text Processing Settings]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings AlgorithmicStemming AlgorithmicStemming // A JSON array that contains a collection of terms, tokens, readings and part of @@ -63,8 +65,9 @@ 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) - // in the Amazon CloudSearch Developer Guide. + // specifying synonyms, see [Synonyms]in the Amazon CloudSearch Developer Guide. + // + // [Synonyms]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms Synonyms *string noSmithyDocumentSerde @@ -76,8 +79,9 @@ type AnalysisOptions struct { // , StemmingDictionary , JapaneseTokenizationDictionary and AlgorithmicStemming . type AnalysisScheme struct { - // An IETF RFC 4646 (http://tools.ietf.org/html/rfc4646) language code or mul for - // multiple languages. + // An [IETF RFC 4646] language code or mul for multiple languages. + // + // [IETF RFC 4646]: http://tools.ietf.org/html/rfc4646 // // This member is required. AnalysisSchemeLanguage AnalysisSchemeLanguage @@ -177,13 +181,16 @@ type DateOptions struct { // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map // to a regular index field but do match a dynamic field's pattern are configured - // with the dynamic field's indexing options. Regular field names begin with a - // letter and can contain the following characters: a-z (lowercase), 0-9, and _ - // (underscore). Dynamic field names must begin or end with a wildcard (*). The - // 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 . + // with the dynamic field's indexing options. + // + // Regular field names begin with a letter and can contain the following + // characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must + // begin or end with a wildcard (*). The 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 . SourceField *string noSmithyDocumentSerde @@ -260,27 +267,26 @@ type DomainStatus struct { // This member is required. DomainName *string - // True if IndexDocuments needs to be called to activate the current domain - // configuration. + // True if IndexDocuments needs to be called to activate the current domain configuration. // // This member is required. 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) - // in Using AWS Identity and Access Management for more information. + // The Amazon Resource Name (ARN) of the search domain. See [Identifiers for IAM Entities] in Using AWS Identity + // and Access Management for more information. + // + // [Identifiers for IAM Entities]: http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html ARN *string // True if the search domain is created. It can take several minutes to initialize - // a domain when CreateDomain is called. Newly created search domains are returned - // from DescribeDomains with a false value for Created until domain creation is - // complete. + // a domain when CreateDomainis called. Newly created search domains are returned from DescribeDomains with a + // false value for Created until domain creation is complete. 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 DeleteDomainis called. Newly deleted search domains are + // returned from DescribeDomainswith 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. @@ -369,10 +375,11 @@ type Expression struct { ExpressionName *string // 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) + // Expression syntax is based on JavaScript expressions. For more information, see [Configuring Expressions] // in the Amazon CloudSearch Developer Guide. // + // [Configuring Expressions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html + // // This member is required. ExpressionValue *string @@ -396,27 +403,32 @@ 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 // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map // to a regular index field but do match a dynamic field's pattern are configured - // with the dynamic field's indexing options. Regular field names begin with a - // letter and can contain the following characters: a-z (lowercase), 0-9, and _ - // (underscore). Dynamic field names must begin or end with a wildcard (*). The - // 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 . + // with the dynamic field's indexing options. + // + // Regular field names begin with a letter and can contain the following + // characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must + // begin or end with a wildcard (*). The 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 . // // 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) - // in the Amazon CloudSearch Developer Guide. + // more information about the supported field types, see [Configuring Index Fields]in the Amazon CloudSearch + // Developer Guide. + // + // [Configuring Index Fields]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html // // This member is required. IndexFieldType IndexFieldType @@ -481,7 +493,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 @@ -568,13 +580,16 @@ type LatLonOptions struct { // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map // to a regular index field but do match a dynamic field's pattern are configured - // with the dynamic field's indexing options. Regular field names begin with a - // letter and can contain the following characters: a-z (lowercase), 0-9, and _ - // (underscore). Dynamic field names must begin or end with a wildcard (*). The - // 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 . + // with the dynamic field's indexing options. + // + // Regular field names begin with a letter and can contain the following + // characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must + // begin or end with a wildcard (*). The 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 . SourceField *string noSmithyDocumentSerde @@ -637,13 +652,16 @@ type LiteralOptions struct { // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map // to a regular index field but do match a dynamic field's pattern are configured - // with the dynamic field's indexing options. Regular field names begin with a - // letter and can contain the following characters: a-z (lowercase), 0-9, and _ - // (underscore). Dynamic field names must begin or end with a wildcard (*). The - // 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 . + // with the dynamic field's indexing options. + // + // Regular field names begin with a letter and can contain the following + // characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must + // begin or end with a wildcard (*). The 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 . SourceField *string noSmithyDocumentSerde @@ -658,8 +676,9 @@ 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. + // until IndexDocumentshas 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 @@ -814,13 +833,16 @@ type TextOptions struct { // regular index fields as well as dynamic fields. A dynamic field's name defines a // pattern that begins or ends with a wildcard. Any document fields that don't map // to a regular index field but do match a dynamic field's pattern are configured - // with the dynamic field's indexing options. Regular field names begin with a - // letter and can contain the following characters: a-z (lowercase), 0-9, and _ - // (underscore). Dynamic field names must begin or end with a wildcard (*). The - // 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 . + // with the dynamic field's indexing options. + // + // Regular field names begin with a letter and can contain the following + // characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must + // begin or end with a wildcard (*). The 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 . SourceField *string noSmithyDocumentSerde diff --git a/service/cloudsearchdomain/api_op_Search.go b/service/cloudsearchdomain/api_op_Search.go index 745c93a5cf4..dc0af0c84c9 100644 --- a/service/cloudsearchdomain/api_op_Search.go +++ b/service/cloudsearchdomain/api_op_Search.go @@ -14,6 +14,7 @@ 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 @@ -23,12 +24,15 @@ import ( // - 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 -// 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 -// displayed on the domain dashboard in the Amazon CloudSearch console. +// For more information, see [Searching Your Data] 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 displayed on the domain dashboard in the +// Amazon CloudSearch console. +// +// [Searching Your Data]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error) { if params == nil { params = &SearchInput{} @@ -51,9 +55,12 @@ type SearchInput struct { // 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. + // parser, you must also specify the queryParser parameter. + // + // For more information about specifying search criteria, see [Searching Your Data] in the Amazon + // CloudSearch Developer Guide. + // + // [Searching Your Data]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html // // This member is required. Query *string @@ -63,18 +70,27 @@ type SearchInput struct { // 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. + // the response. + // + // For more information, see [Paginating Results] in the Amazon CloudSearch Developer Guide. + // + // [Paginating Results]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html 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 + // 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) - // in the Amazon CloudSearch Developer Guide. + // 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]in the Amazon CloudSearch Developer Guide. + // + // [Writing Expressions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions Expr *string // Specifies one or more fields for which to get facet information, and options @@ -82,38 +98,54 @@ type SearchInput struct { // 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: + // . + // + // 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 . + // values. For more information, see [Searching for a Range of Values]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,}"]}} + // 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 - // 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":"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] in the Amazon CloudSearch Developer Guide. + // + // [Searching for a Range of Values]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html + // [Getting and Using Facet Information]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html Facet *string // Specifies a structured query that filters the results of a search without @@ -122,16 +154,22 @@ 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) - // in the Amazon CloudSearch Developer Guide. + // structured query syntax. + // + // For more information about using filters, see [Filtering Matching Documents] in the Amazon CloudSearch + // Developer Guide. + // + // [Filtering Matching Documents]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html 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: + // . + // + // 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 . @@ -145,9 +183,13 @@ type SearchInput struct { // * . // 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": ""} } + // 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 // Enables partial results to be returned if one or more index partitions are @@ -165,8 +207,10 @@ type SearchInput struct { // Configures options for the query parser specified in the queryParser parameter. // 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: + // {"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 @@ -236,15 +280,18 @@ type SearchInput struct { // 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 . + // (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: + // 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 @@ -254,20 +301,21 @@ type SearchInput struct { // 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. + // information, see [Searching for Text]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. + // matchall , and near . For more information, see [Constructing Compound Queries]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) - // . + // information, see [Apache Lucene Query Parser Syntax]. // - 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) - // . + // parser syntax defined by the DisMax query parser. For more information, see [DisMax Query Parser Syntax]. + // + // [DisMax Query Parser Syntax]: http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax + // [Apache Lucene Query Parser Syntax]: http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description + // [Constructing Compound Queries]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html + // [Searching for Text]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html QueryParser types.QueryParser // Specifies the field and expression values to include in the response. Multiple @@ -287,21 +335,29 @@ type SearchInput struct { // 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) - // in the Amazon CloudSearch Developer Guide. + // asc ) and version ( _version desc ). + // + // For more information, see [Sorting Results] in the Amazon CloudSearch Developer Guide. + // + // [Sorting Results]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html 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) - // in the Amazon CloudSearch Developer Guide. + // the start or cursor parameter in a request, they are mutually exclusive. + // + // For more information, see [Paginating Results] in the Amazon CloudSearch Developer Guide. + // + // [Paginating Results]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html Start int64 // Specifies one or more fields for which to get statistics information. Each // specified field must be facet-enabled in the domain configuration. The fields - // are specified in JSON using the form: {"FIELD-A":{},"FIELD-B":{}} There are - // currently no options supported for statistics. + // are specified in JSON using the form: + // + // {"FIELD-A":{},"FIELD-B":{}} + // + // There are currently no options supported for statistics. Stats *string noSmithyDocumentSerde diff --git a/service/cloudsearchdomain/api_op_Suggest.go b/service/cloudsearchdomain/api_op_Suggest.go index ba515dae359..e6c0c2a8e37 100644 --- a/service/cloudsearchdomain/api_op_Suggest.go +++ b/service/cloudsearchdomain/api_op_Suggest.go @@ -17,13 +17,18 @@ import ( // field. When you request suggestions, Amazon CloudSearch finds all of the // 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) -// 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 -// configuration service DescribeDomains action. A domain's endpoints are also -// displayed on the domain dashboard in the Amazon CloudSearch console. +// a match. +// +// For more information about configuring suggesters and retrieving suggestions, +// see [Getting Suggestions]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 configuration service DescribeDomains +// action. A domain's endpoints are also displayed on the domain dashboard in the +// Amazon CloudSearch console. +// +// [Getting Suggestions]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html func (c *Client) Suggest(ctx context.Context, params *SuggestInput, optFns ...func(*Options)) (*SuggestOutput, error) { if params == nil { params = &SuggestInput{} diff --git a/service/cloudsearchdomain/api_op_UploadDocuments.go b/service/cloudsearchdomain/api_op_UploadDocuments.go index efade21d5f6..29604fbb27c 100644 --- a/service/cloudsearchdomain/api_op_UploadDocuments.go +++ b/service/cloudsearchdomain/api_op_UploadDocuments.go @@ -22,15 +22,19 @@ import ( // data. The entire batch cannot exceed 5 MB. To get the best possible upload // performance, group add and delete operations in batches that are close the 5 MB // limit. Submitting a large volume of single-document batches can overload a -// domain's document service. The endpoint for submitting UploadDocuments requests -// is domain-specific. To get the document endpoint for your domain, use the Amazon -// 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) -// 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) -// in the Amazon CloudSearch Developer Guide. +// domain's document service. +// +// The endpoint for submitting UploadDocuments requests is domain-specific. To get +// the document endpoint for your domain, use the Amazon 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] in +// the Amazon CloudSearch Developer Guide. For more information about uploading +// data for indexing, see [Uploading Data]in the Amazon CloudSearch Developer Guide. +// +// [Preparing Your Data]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html +// [Uploading Data]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html func (c *Client) UploadDocuments(ctx context.Context, params *UploadDocumentsInput, optFns ...func(*Options)) (*UploadDocumentsOutput, error) { if params == nil { params = &UploadDocumentsInput{} @@ -51,6 +55,7 @@ type UploadDocumentsInput struct { // The format of the batch you are uploading. Amazon CloudSearch supports two // document batch formats: + // // - application/json // - application/xml // diff --git a/service/cloudsearchdomain/doc.go b/service/cloudsearchdomain/doc.go index 9ad14e4bf74..e94e47fff20 100644 --- a/service/cloudsearchdomain/doc.go +++ b/service/cloudsearchdomain/doc.go @@ -4,11 +4,15 @@ // 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) -// . +// 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]. +// +// [Amazon CloudSearch Developer Guide]: http://docs.aws.amazon.com/cloudsearch/latest/developerguide package cloudsearchdomain diff --git a/service/cloudsearchdomain/options.go b/service/cloudsearchdomain/options.go index 5858235da40..c9189d16f2d 100644 --- a/service/cloudsearchdomain/options.go +++ b/service/cloudsearchdomain/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudsearchdomain/types/enums.go b/service/cloudsearchdomain/types/enums.go index efdcbb66e75..9ed7b5fddda 100644 --- a/service/cloudsearchdomain/types/enums.go +++ b/service/cloudsearchdomain/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "application/json", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for QueryParser. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryParser) Values() []QueryParser { return []QueryParser{ "simple", diff --git a/service/cloudsearchdomain/types/types.go b/service/cloudsearchdomain/types/types.go index e19262bec00..a297e334b1a 100644 --- a/service/cloudsearchdomain/types/types.go +++ b/service/cloudsearchdomain/types/types.go @@ -44,28 +44,34 @@ type FieldStats struct { // result set. 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 - // 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) : - // yyyy-mm-ddTHH:mm:ss.SSSZ. + // 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 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]: yyyy-mm-ddTHH:mm:ss.SSSZ. + // + // [IETF RFC3339]: http://tools.ietf.org/html/rfc3339 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 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. + // with the format specified in [IETF RFC3339]: yyyy-mm-ddTHH:mm:ss.SSSZ. + // + // [IETF RFC3339]: http://tools.ietf.org/html/rfc3339 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 - // 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) : - // yyyy-mm-ddTHH:mm:ss.SSSZ. + // 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 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]: yyyy-mm-ddTHH:mm:ss.SSSZ. + // + // [IETF RFC3339]: http://tools.ietf.org/html/rfc3339 Min *string // The number of documents that do not contain a value in the specified field in diff --git a/service/cloudtrail/api_op_AddTags.go b/service/cloudtrail/api_op_AddTags.go index dbecb2f22bd..51ee44e0557 100644 --- a/service/cloudtrail/api_op_AddTags.go +++ b/service/cloudtrail/api_op_AddTags.go @@ -38,10 +38,14 @@ func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...fu type AddTagsInput struct { // Specifies the ARN of the trail, event data store, or channel to which one or - // more tags will be added. The format of a trail ARN is: - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail The format of an event - // data store ARN is: + // more tags will be added. + // + // The format of a trail ARN is: + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // The format of an event data store ARN is: // arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE + // // The format of a channel ARN is: // arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 // diff --git a/service/cloudtrail/api_op_CreateChannel.go b/service/cloudtrail/api_op_CreateChannel.go index 52f7f030a22..83ee9e83975 100644 --- a/service/cloudtrail/api_op_CreateChannel.go +++ b/service/cloudtrail/api_op_CreateChannel.go @@ -43,11 +43,13 @@ type CreateChannelInput struct { Name *string // 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 + // 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) - // in the CloudTrail User Guide. + // available partners, see [Additional information about integration partners]in the CloudTrail User Guide. + // + // [Additional information about integration partners]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information // // This member is required. Source *string diff --git a/service/cloudtrail/api_op_CreateEventDataStore.go b/service/cloudtrail/api_op_CreateEventDataStore.go index 98ab37d6b29..27edbe827d3 100644 --- a/service/cloudtrail/api_op_CreateEventDataStore.go +++ b/service/cloudtrail/api_op_CreateEventDataStore.go @@ -37,49 +37,70 @@ type CreateEventDataStoreInput struct { // 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) - // 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) - // in the CloudTrail User Guide. + // + // For more information about how to use advanced event selectors to log + // CloudTrail events, see [Log events by using advanced event selectors]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]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]in the CloudTrail + // User Guide. + // + // [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 + // [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 + // [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 AdvancedEventSelectors []types.AdvancedEventSelector // The billing mode for the event data store determines the cost for ingesting // events and the default and maximum retention period for the event data store. + // // The following are the possible values: + // // - EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if // you want a flexible retention period of up to 3653 days (about 10 years). The // default retention period for this billing mode is 366 days. + // // - FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to // ingest more than 25 TB of event data per month and need a retention period of up // to 2557 days (about 7 years). The default retention period for this billing mode // is 2557 days. - // The default value is EXTENDABLE_RETENTION_PRICING . For more information about - // CloudTrail pricing, see CloudTrail Pricing (http://aws.amazon.com/cloudtrail/pricing/) - // and Managing CloudTrail Lake costs (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html) - // . + // + // The default value is EXTENDABLE_RETENTION_PRICING . + // + // For more information about CloudTrail pricing, see [CloudTrail Pricing] and [Managing CloudTrail Lake costs]. + // + // [CloudTrail Pricing]: http://aws.amazon.com/cloudtrail/pricing/ + // [Managing CloudTrail Lake costs]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html BillingMode types.BillingMode // 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 // 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 // prevents users from querying the data in the event data store that was encrypted // with the key. After you associate an event data store with a KMS key, the KMS // 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) - // in the Key Management Service Developer Guide. Examples: + // multi-Region keys, see [Using multi-Region keys]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 + // + // [Using multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html KmsKeyId *string // Specifies whether the event data store includes events from all Regions, or @@ -94,15 +115,18 @@ type CreateEventDataStoreInput struct { // EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 // days, the equivalent of 10 years. If BillingMode is set to // FIXED_RETENTION_PRICING , you can set a retention period of up to 2557 days, the - // equivalent of seven years. CloudTrail Lake determines whether to retain an event - // by checking if the eventTime of the event is within the specified retention - // period. For example, if you set a retention period of 90 days, CloudTrail will - // remove events when the eventTime is older than 90 days. If you plan to copy - // trail events to this event data store, we recommend that you consider both the - // age of the events that you want to copy as well as how long you want to keep the - // copied events in your event data store. For example, if you copy trail events - // that are 5 years old and specify a retention period of 7 years, the event data - // store will retain those events for two years. + // equivalent of seven years. + // + // CloudTrail Lake determines whether to retain an event by checking if the + // eventTime of the event is within the specified retention period. For example, if + // you set a retention period of 90 days, CloudTrail will remove events when the + // eventTime is older than 90 days. + // + // If you plan to copy trail events to this event data store, we recommend that + // you consider both the age of the events that you want to copy as well as how + // long you want to keep the copied events in your event data store. For example, + // if you copy trail events that are 5 years old and specify a retention period of + // 7 years, the event data store will retain those events for two years. RetentionPeriod *int32 // Specifies whether the event data store should start ingesting live events. The @@ -137,7 +161,8 @@ type CreateEventDataStoreOutput struct { // Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // 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 diff --git a/service/cloudtrail/api_op_CreateTrail.go b/service/cloudtrail/api_op_CreateTrail.go index 8c230159fa4..6aebffa54f6 100644 --- a/service/cloudtrail/api_op_CreateTrail.go +++ b/service/cloudtrail/api_op_CreateTrail.go @@ -32,28 +32,35 @@ func (c *Client) CreateTrail(ctx context.Context, params *CreateTrailInput, optF 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) // // 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]. + // + // [Amazon S3 Bucket Naming Requirements]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html // // This member is required. S3BucketName *string // 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 . + // delivered. You must use a log group that exists in your account. + // + // Not required unless you specify CloudWatchLogsRoleArn . CloudWatchLogsLogGroupArn *string // Specifies the role for the CloudWatch Logs endpoint to assume to write to a @@ -61,8 +68,10 @@ type CreateTrailInput struct { CloudWatchLogsRoleArn *string // Specifies whether log file integrity 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 + // 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 @@ -91,19 +100,28 @@ type CreateTrailInput struct { // 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) - // in the Key Management Service Developer Guide. Examples: + // multi-Region keys, see [Using multi-Region keys]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 + // + // [Using multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html 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. + // have designated for log file delivery. For more information, see [Finding Your CloudTrail Log Files]. The maximum + // length is 200 characters. + // + // [Finding Your CloudTrail Log Files]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html S3KeyPrefix *string // Specifies the name of the Amazon SNS topic defined for notification of log file @@ -140,7 +158,8 @@ type CreateTrailOutput struct { // Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string // Specifies whether log file integrity validation is enabled. @@ -153,14 +172,15 @@ type CreateTrailOutput struct { 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) - // . + // have designated for log file delivery. For more information, see [Finding Your CloudTrail Log Files]. + // + // [Finding Your 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 // notifications when log files are delivered. The format of a topic ARN is: - // arn:aws:sns:us-east-2:123456789012:MyTopic + // + // arn:aws:sns:us-east-2:123456789012:MyTopic SnsTopicARN *string // This field is no longer in use. Use SnsTopicARN . @@ -169,7 +189,8 @@ type CreateTrailOutput struct { SnsTopicName *string // Specifies the ARN of the trail that was created. 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 TrailARN *string // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_DeleteEventDataStore.go b/service/cloudtrail/api_op_DeleteEventDataStore.go index f794dab7d92..1847b2d070d 100644 --- a/service/cloudtrail/api_op_DeleteEventDataStore.go +++ b/service/cloudtrail/api_op_DeleteEventDataStore.go @@ -16,10 +16,12 @@ import ( // period of seven days. TerminationProtectionEnabled must be set to False on the // event data store and the FederationStatus must be DISABLED . You cannot delete // an event data store if TerminationProtectionEnabled is True or the -// FederationStatus is ENABLED . 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. +// FederationStatus is ENABLED . +// +// 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 { params = &DeleteEventDataStoreInput{} diff --git a/service/cloudtrail/api_op_DeleteResourcePolicy.go b/service/cloudtrail/api_op_DeleteResourcePolicy.go index 04126fa1584..07c1d971f92 100644 --- a/service/cloudtrail/api_op_DeleteResourcePolicy.go +++ b/service/cloudtrail/api_op_DeleteResourcePolicy.go @@ -28,7 +28,7 @@ func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourc type DeleteResourcePolicyInput struct { - // The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the + // 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 . // diff --git a/service/cloudtrail/api_op_DescribeQuery.go b/service/cloudtrail/api_op_DescribeQuery.go index 8e77df335a9..72b9f5c862a 100644 --- a/service/cloudtrail/api_op_DescribeQuery.go +++ b/service/cloudtrail/api_op_DescribeQuery.go @@ -14,9 +14,10 @@ import ( // Returns metadata about a query, including query run time in milliseconds, // number of events scanned and matched, and query status. If the query results // were delivered to an S3 bucket, the response also provides the S3 URI and the -// delivery status. You must specify either a QueryID or a QueryAlias . Specifying -// the QueryAlias parameter returns information about the last query run for the -// alias. +// delivery status. +// +// You must specify either a QueryID or a QueryAlias . Specifying the QueryAlias +// parameter returns information about the last query run for the alias. func (c *Client) DescribeQuery(ctx context.Context, params *DescribeQueryInput, optFns ...func(*Options)) (*DescribeQueryOutput, error) { if params == nil { params = &DescribeQueryInput{} @@ -40,7 +41,7 @@ type DescribeQueryInput struct { // Deprecated: EventDataStore is no longer required by DescribeQueryRequest EventDataStore *string - // The alias that identifies a query template. + // The alias that identifies a query template. QueryAlias *string // The query ID. diff --git a/service/cloudtrail/api_op_DescribeTrails.go b/service/cloudtrail/api_op_DescribeTrails.go index b1c706dd576..190e176c914 100644 --- a/service/cloudtrail/api_op_DescribeTrails.go +++ b/service/cloudtrail/api_op_DescribeTrails.go @@ -41,13 +41,19 @@ type DescribeTrailsInput struct { // 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. + // + // 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 diff --git a/service/cloudtrail/api_op_DisableFederation.go b/service/cloudtrail/api_op_DisableFederation.go index 3b944ed1613..798d8e78342 100644 --- a/service/cloudtrail/api_op_DisableFederation.go +++ b/service/cloudtrail/api_op_DisableFederation.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables Lake query federation on the specified event data store. When you +// Disables Lake query federation on the specified event data store. When you +// // disable federation, CloudTrail disables the integration with Glue, Lake // Formation, and Amazon Athena. After disabling Lake query federation, you can no -// longer query your event data in Amazon Athena. No CloudTrail Lake data is -// deleted when you disable federation and you can continue to run queries in -// CloudTrail Lake. +// longer query your event data in Amazon Athena. +// +// No CloudTrail Lake data is deleted when you disable federation and you can +// continue to run queries in CloudTrail Lake. func (c *Client) DisableFederation(ctx context.Context, params *DisableFederationInput, optFns ...func(*Options)) (*DisableFederationOutput, error) { if params == nil { params = &DisableFederationInput{} @@ -34,8 +36,8 @@ func (c *Client) DisableFederation(ctx context.Context, params *DisableFederatio type DisableFederationInput struct { - // The ARN (or ID suffix of the ARN) of the event data store for which you want to - // disable Lake query federation. + // The ARN (or ID suffix of the ARN) of the event data store for which you want + // to disable Lake query federation. // // This member is required. EventDataStore *string @@ -45,10 +47,10 @@ type DisableFederationInput struct { type DisableFederationOutput struct { - // The ARN of the event data store for which you disabled Lake query federation. + // The ARN of the event data store for which you disabled Lake query federation. EventDataStoreArn *string - // The federation status. + // The federation status. FederationStatus types.FederationStatus // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_EnableFederation.go b/service/cloudtrail/api_op_EnableFederation.go index 07049c08d57..58cbddf434f 100644 --- a/service/cloudtrail/api_op_EnableFederation.go +++ b/service/cloudtrail/api_op_EnableFederation.go @@ -11,20 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables Lake query federation on the specified event data store. Federating an +// Enables Lake query federation on the specified event data store. Federating an +// // event data store lets you view the metadata associated with the event data store -// in the Glue Data Catalog (https://docs.aws.amazon.com/glue/latest/dg/components-overview.html#data-catalog-intro) -// and run SQL queries against your event data using Amazon Athena. The table -// metadata stored in the Glue Data Catalog lets the Athena query engine know how -// to find, read, and process the data that you want to query. When you enable Lake -// query federation, CloudTrail creates a managed database named aws:cloudtrail -// (if the database doesn't already exist) and a managed federated table in the -// Glue Data Catalog. The event data store ID is used for the table name. -// CloudTrail registers the role ARN and event data store in Lake Formation (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation-lake-formation.html) -// , the service responsible for allowing fine-grained access control of the -// federated resources in the Glue Data Catalog. For more information about Lake -// query federation, see Federate an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) -// . +// in the Glue [Data Catalog]and run SQL queries against your event data using Amazon Athena. +// The table metadata stored in the Glue Data Catalog lets the Athena query engine +// know how to find, read, and process the data that you want to query. +// +// When you enable Lake query federation, CloudTrail creates a managed database +// named aws:cloudtrail (if the database doesn't already exist) and a managed +// federated table in the Glue Data Catalog. The event data store ID is used for +// the table name. CloudTrail registers the role ARN and event data store in [Lake Formation], the +// service responsible for allowing fine-grained access control of the federated +// resources in the Glue Data Catalog. +// +// For more information about Lake query federation, see [Federate an event data store]. +// +// [Federate an event data store]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html +// [Lake Formation]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation-lake-formation.html +// [Data Catalog]: https://docs.aws.amazon.com/glue/latest/dg/components-overview.html#data-catalog-intro func (c *Client) EnableFederation(ctx context.Context, params *EnableFederationInput, optFns ...func(*Options)) (*EnableFederationOutput, error) { if params == nil { params = &EnableFederationInput{} @@ -48,11 +53,12 @@ type EnableFederationInput struct { // This member is required. EventDataStore *string - // The ARN of the federation role to use for the event data store. Amazon Web + // The ARN of the federation role to use for the event data store. Amazon Web // Services services like Lake Formation use this federation role to access data // for the federated event data store. The federation role must exist in your - // account and provide the required minimum permissions (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html#query-federation-permissions-role) - // . + // account and provide the [required minimum permissions]. + // + // [required minimum permissions]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html#query-federation-permissions-role // // This member is required. FederationRoleArn *string @@ -62,13 +68,13 @@ type EnableFederationInput struct { type EnableFederationOutput struct { - // The ARN of the event data store for which you enabled Lake query federation. + // The ARN of the event data store for which you enabled Lake query federation. EventDataStoreArn *string - // The ARN of the federation role. + // The ARN of the federation role. FederationRoleArn *string - // The federation status. + // The federation status. FederationStatus types.FederationStatus // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_GetChannel.go b/service/cloudtrail/api_op_GetChannel.go index c360a87896e..8601f966406 100644 --- a/service/cloudtrail/api_op_GetChannel.go +++ b/service/cloudtrail/api_op_GetChannel.go @@ -52,16 +52,17 @@ type GetChannelOutput struct { // attempts to ingest events. IngestionStatus *types.IngestionStatus - // The name of the CloudTrail channel. For service-linked channels, the name is + // 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. + // custom-suffix represents the suffix generated by the Amazon Web Services + // service. Name *string // The source for the CloudTrail channel. Source *string - // Provides information about the advanced event selectors configured for the + // Provides information about the advanced event selectors configured for the // channel, and whether the channel applies to all Regions or a single Region. SourceConfig *types.SourceConfig diff --git a/service/cloudtrail/api_op_GetEventDataStore.go b/service/cloudtrail/api_op_GetEventDataStore.go index f5d5ca5677b..d0679e3a910 100644 --- a/service/cloudtrail/api_op_GetEventDataStore.go +++ b/service/cloudtrail/api_op_GetEventDataStore.go @@ -54,19 +54,21 @@ type GetEventDataStoreOutput struct { // The event data store Amazon Resource Number (ARN). EventDataStoreArn *string - // If Lake query federation is enabled, provides the ARN of the federation role + // If Lake query federation is enabled, provides the ARN of the federation role // used to access the resources for the federated event data store. FederationRoleArn *string - // Indicates the Lake query federation (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) - // status. The status is ENABLED if Lake query federation is enabled, or DISABLED - // if Lake query federation is disabled. You cannot delete an event data store if - // the FederationStatus is ENABLED . + // Indicates the [Lake query federation] status. The status is ENABLED if Lake query federation is + // enabled, or DISABLED if Lake query federation is disabled. You cannot delete an + // event data store if the FederationStatus is ENABLED . + // + // [Lake query federation]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html FederationStatus types.FederationStatus // Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // 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 diff --git a/service/cloudtrail/api_op_GetEventSelectors.go b/service/cloudtrail/api_op_GetEventSelectors.go index cb039ba6b2e..30164153c16 100644 --- a/service/cloudtrail/api_op_GetEventSelectors.go +++ b/service/cloudtrail/api_op_GetEventSelectors.go @@ -16,14 +16,21 @@ import ( // // - 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 (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) -// - Logging data events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) +// +// [Logging management events] +// +// [Logging data events] +// +// [Logging management events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html +// [Logging data events]: 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{} @@ -43,15 +50,22 @@ 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 + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. TrailName *string @@ -61,7 +75,7 @@ type GetEventSelectorsInput struct { type GetEventSelectorsOutput struct { - // The advanced event selectors that are configured for the trail. + // The advanced event selectors that are configured for the trail. AdvancedEventSelectors []types.AdvancedEventSelector // The event selectors that are configured for the trail. diff --git a/service/cloudtrail/api_op_GetImport.go b/service/cloudtrail/api_op_GetImport.go index 4241ea19bce..4893fe70e88 100644 --- a/service/cloudtrail/api_op_GetImport.go +++ b/service/cloudtrail/api_op_GetImport.go @@ -30,7 +30,7 @@ func (c *Client) GetImport(ctx context.Context, params *GetImportInput, optFns . type GetImportInput struct { - // The ID for the import. + // The ID for the import. // // This member is required. ImportId *string @@ -40,36 +40,36 @@ type GetImportInput struct { type GetImportOutput struct { - // The timestamp of the import's creation. + // The timestamp of the import's creation. CreatedTimestamp *time.Time - // The ARN of the destination event data store. + // The ARN of the destination event data store. Destinations []string - // Used with StartEventTime to bound a StartImport request, and limit imported + // Used with StartEventTime to bound a StartImport request, and limit imported // trail events to only those events logged within a specified time period. EndEventTime *time.Time - // The ID of the import. + // The ID of the import. ImportId *string - // The source S3 bucket. + // The source S3 bucket. ImportSource *types.ImportSource - // Provides statistics for the import. CloudTrail does not update 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. + // The status of the import. ImportStatus types.ImportStatus - // Used with EndEventTime to bound a StartImport request, and limit imported trail - // events to only those events logged within a specified time period. + // Used with EndEventTime to bound a StartImport request, and limit imported + // trail events to only those events logged within a specified time period. StartEventTime *time.Time - // The timestamp of when the import was updated. + // The timestamp of when the import was updated. UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_GetInsightSelectors.go b/service/cloudtrail/api_op_GetInsightSelectors.go index 9a74e9d23dd..ad5607748af 100644 --- a/service/cloudtrail/api_op_GetInsightSelectors.go +++ b/service/cloudtrail/api_op_GetInsightSelectors.go @@ -16,12 +16,15 @@ import ( // Insights event logging is enabled on the trail or event data store, and if it // is, which Insights types are enabled. If you run GetInsightSelectors on a trail // or event data store that does not have Insights events enabled, the operation -// throws the exception InsightNotEnabledException Specify either the -// EventDataStore parameter to get Insights event selectors for an event data -// store, or the TrailName parameter to the get Insights event selectors for a -// trail. You cannot specify these parameters together. For more information, see -// Logging CloudTrail Insights events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) -// in the CloudTrail User Guide. +// throws the exception InsightNotEnabledException +// +// Specify either the EventDataStore parameter to get Insights event selectors for +// an event data store, or the TrailName parameter to the get Insights event +// selectors for a trail. You cannot specify these parameters together. +// +// For more information, see [Logging CloudTrail Insights events] in the CloudTrail User Guide. +// +// [Logging CloudTrail Insights events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html func (c *Client) GetInsightSelectors(ctx context.Context, params *GetInsightSelectorsInput, optFns ...func(*Options)) (*GetInsightSelectorsOutput, error) { if params == nil { params = &GetInsightSelectorsInput{} @@ -39,23 +42,32 @@ func (c *Client) GetInsightSelectors(ctx context.Context, params *GetInsightSele type GetInsightSelectorsInput struct { - // Specifies the ARN (or ID suffix of the ARN) of the event data store for which - // you want to get Insights selectors. You cannot use this parameter with the - // TrailName parameter. + // Specifies the ARN (or ID suffix of the ARN) of the event data store for which + // you want to get Insights selectors. + // + // You cannot use this parameter with the TrailName parameter. EventDataStore *string // 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 You cannot use this - // parameter with the EventDataStore parameter. + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // You cannot use this parameter with the EventDataStore parameter. TrailName *string noSmithyDocumentSerde @@ -63,7 +75,7 @@ type GetInsightSelectorsInput struct { type GetInsightSelectorsOutput struct { - // The ARN of the source event data store that enabled Insights events. + // The ARN of the source event data store that enabled Insights events. EventDataStoreArn *string // A JSON string that contains the Insight types you want to log on a trail or @@ -71,7 +83,7 @@ type GetInsightSelectorsOutput struct { // Insights types. InsightSelectors []types.InsightSelector - // The ARN of the destination event data store that logs Insights events. + // The ARN of the destination event data store that logs Insights events. InsightsDestination *string // The Amazon Resource Name (ARN) of a trail for which you want to get Insights diff --git a/service/cloudtrail/api_op_GetResourcePolicy.go b/service/cloudtrail/api_op_GetResourcePolicy.go index a1cb8c750a6..835aeb85932 100644 --- a/service/cloudtrail/api_op_GetResourcePolicy.go +++ b/service/cloudtrail/api_op_GetResourcePolicy.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the JSON text of the resource-based policy document attached to the +// Retrieves the JSON text of the resource-based policy document attached to the +// // CloudTrail channel. func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) { if params == nil { @@ -29,7 +30,7 @@ func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolic type GetResourcePolicyInput struct { - // The Amazon Resource Name (ARN) of the CloudTrail channel attached to the + // 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 . // @@ -41,12 +42,12 @@ type GetResourcePolicyInput struct { type GetResourcePolicyOutput struct { - // The Amazon Resource Name (ARN) of the CloudTrail channel attached to + // The Amazon Resource Name (ARN) of the CloudTrail channel attached to // resource-based policy. ResourceArn *string - // A JSON-formatted string that contains the resource-based policy attached to the - // CloudTrail channel. + // A JSON-formatted string that contains the resource-based policy attached to + // the CloudTrail channel. ResourcePolicy *string // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_GetTrailStatus.go b/service/cloudtrail/api_op_GetTrailStatus.go index ba69e2855cb..6012e4313a9 100644 --- a/service/cloudtrail/api_op_GetTrailStatus.go +++ b/service/cloudtrail/api_op_GetTrailStatus.go @@ -37,7 +37,9 @@ type GetTrailStatusInput struct { // Specifies the name or the CloudTrail ARN of the trail for which you are // requesting status. To get the status of a shadow trail (a replication of the // trail in another Region), you must specify its ARN. The following is the format - // of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // of a trail ARN. + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. Name *string @@ -67,13 +69,15 @@ type GetTrailStatusOutput struct { LatestDeliveryAttemptTime *string // Displays any Amazon S3 error that CloudTrail encountered when attempting to - // deliver log files to the designated bucket. For more information, see Error - // Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) - // in the Amazon S3 API Reference. This error occurs only when there is a problem - // with the destination S3 bucket, and does not occur for requests that time out. - // To resolve the issue, create a new bucket, and then call UpdateTrail to specify - // the new bucket; or fix the existing objects so that CloudTrail can again write - // to the bucket. + // deliver log files to the designated bucket. For more information, see [Error Responses]in the + // Amazon S3 API Reference. + // + // This error occurs only when there is a problem with the destination S3 bucket, + // and does not occur for requests that time out. To resolve the issue, create a + // new bucket, and then call UpdateTrail to specify the new bucket; or fix the + // existing objects so that CloudTrail can again write to the bucket. + // + // [Error Responses]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html LatestDeliveryError *string // Specifies the date and time that CloudTrail last delivered log files to an @@ -81,13 +85,15 @@ type GetTrailStatusOutput struct { LatestDeliveryTime *time.Time // Displays any Amazon S3 error that CloudTrail encountered when attempting to - // deliver a digest file to the designated bucket. For more information, see Error - // Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) - // in the Amazon S3 API Reference. This error occurs only when there is a problem - // with the destination S3 bucket, and does not occur for requests that time out. - // To resolve the issue, create a new bucket, and then call UpdateTrail to specify - // the new bucket; or fix the existing objects so that CloudTrail can again write - // to the bucket. + // deliver a digest file to the designated bucket. For more information, see [Error Responses]in + // the Amazon S3 API Reference. + // + // This error occurs only when there is a problem with the destination S3 bucket, + // and does not occur for requests that time out. To resolve the issue, create a + // new bucket, and then call UpdateTrail to specify the new bucket; or fix the + // existing objects so that CloudTrail can again write to the bucket. + // + // [Error Responses]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html LatestDigestDeliveryError *string // Specifies the date and time that CloudTrail last delivered a digest file to an @@ -101,9 +107,9 @@ type GetTrailStatusOutput struct { LatestNotificationAttemptTime *string // 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) - // . + // send a notification. For more information about Amazon SNS errors, see the [Amazon SNS Developer Guide]. + // + // [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 cbd7d51a1ff..1342d7cbdce 100644 --- a/service/cloudtrail/api_op_ListChannels.go +++ b/service/cloudtrail/api_op_ListChannels.go @@ -29,7 +29,7 @@ func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, op type ListChannelsInput struct { - // The maximum number of CloudTrail channels to display on a single page. + // 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. @@ -44,7 +44,7 @@ type ListChannelsInput struct { type ListChannelsOutput struct { - // The list of channels in the account. + // The list of channels in the account. Channels []types.Channel // The token to use to get the next page of results after a previous API call. @@ -141,7 +141,7 @@ var _ ListChannelsAPIClient = (*Client)(nil) // ListChannelsPaginatorOptions is the paginator options for ListChannels type ListChannelsPaginatorOptions struct { - // The maximum number of CloudTrail channels to display on a single page. + // The maximum number of CloudTrail channels to display on a single page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudtrail/api_op_ListImportFailures.go b/service/cloudtrail/api_op_ListImportFailures.go index e40ab98fc52..aec4d5380c6 100644 --- a/service/cloudtrail/api_op_ListImportFailures.go +++ b/service/cloudtrail/api_op_ListImportFailures.go @@ -29,15 +29,15 @@ func (c *Client) ListImportFailures(ctx context.Context, params *ListImportFailu type ListImportFailuresInput struct { - // The ID of the import. + // The ID of the import. // // This member is required. ImportId *string - // The maximum number of failures to display on a single page. + // The maximum number of failures to display on a single page. MaxResults *int32 - // A token you can use to get the next page of import failures. + // A token you can use to get the next page of import failures. NextToken *string noSmithyDocumentSerde @@ -45,10 +45,10 @@ type ListImportFailuresInput struct { type ListImportFailuresOutput struct { - // Contains information about the import failures. + // Contains information about the import failures. Failures []types.ImportFailureListItem - // A token you can use to get the next page of results. + // A token you can use to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. @@ -147,7 +147,7 @@ var _ ListImportFailuresAPIClient = (*Client)(nil) // ListImportFailuresPaginatorOptions is the paginator options for // ListImportFailures type ListImportFailuresPaginatorOptions struct { - // The maximum number of failures to display on a single page. + // The maximum number of failures to display on a single page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudtrail/api_op_ListImports.go b/service/cloudtrail/api_op_ListImports.go index 86a0f2f5267..21f785ad4ff 100644 --- a/service/cloudtrail/api_op_ListImports.go +++ b/service/cloudtrail/api_op_ListImports.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information on all imports, or a select set of imports by ImportStatus +// Returns information on all imports, or a select set of imports by ImportStatus +// // or Destination . func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error) { if params == nil { @@ -30,16 +31,16 @@ func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optF type ListImportsInput struct { - // The ARN of the destination event data store. + // The ARN of the destination event data store. Destination *string - // The status of the import. + // The status of the import. ImportStatus types.ImportStatus - // The maximum number of imports to display on a single page. + // The maximum number of imports to display on a single page. MaxResults *int32 - // A token you can use to get the next page of import results. + // A token you can use to get the next page of import results. NextToken *string noSmithyDocumentSerde @@ -47,10 +48,10 @@ type ListImportsInput struct { type ListImportsOutput struct { - // The list of returned imports. + // The list of returned imports. Imports []types.ImportsListItem - // A token you can use to get the next page of import results. + // A token you can use to get the next page of import results. NextToken *string // Metadata pertaining to the operation's result. @@ -144,7 +145,7 @@ var _ ListImportsAPIClient = (*Client)(nil) // ListImportsPaginatorOptions is the paginator options for ListImports type ListImportsPaginatorOptions struct { - // The maximum number of imports to display on a single page. + // The maximum number of imports to display on a single page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/cloudtrail/api_op_ListInsightsMetricData.go b/service/cloudtrail/api_op_ListInsightsMetricData.go index f549dc159aa..8788864fbfa 100644 --- a/service/cloudtrail/api_op_ListInsightsMetricData.go +++ b/service/cloudtrail/api_op_ListInsightsMetricData.go @@ -14,13 +14,19 @@ import ( // Returns Insights metrics data for trails that have enabled Insights. The // request must include the EventSource , EventName , and InsightType parameters. +// // If the InsightType is set to ApiErrorRateInsight , the request must also include -// the ErrorCode parameter. The following are the available time periods for -// ListInsightsMetricData . Each cutoff is inclusive. +// the ErrorCode parameter. +// +// The following are the available time periods for ListInsightsMetricData . Each +// cutoff is inclusive. +// // - 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 90 // days. // @@ -70,13 +76,16 @@ type ListInsightsMetricDataInput struct { DataType types.InsightsMetricDataType // Specifies, in UTC, the end time for time-series data. The value specified is - // exclusive; results include data points up to the specified time stamp. The - // default is the time of request. + // exclusive; results include data points up to the specified time stamp. + // + // The default is the time of request. EndTime *time.Time // Conditionally required if the InsightType parameter is set to - // ApiErrorRateInsight . If returning metrics for the ApiErrorRateInsight Insights - // type, this is the error to retrieve data for. For example, AccessDenied . + // ApiErrorRateInsight . + // + // If returning metrics for the ApiErrorRateInsight Insights type, this is the + // error to retrieve data for. For example, AccessDenied . ErrorCode *string // The maximum number of datapoints to return. Valid values are integers from 1 to @@ -84,8 +93,10 @@ type ListInsightsMetricDataInput struct { MaxResults *int32 // Returned if all datapoints can't be returned in a single call. For example, due - // to reaching MaxResults . Add this parameter to the request to continue - // retrieving results starting from the last evaluated point. + // to reaching MaxResults . + // + // Add this parameter to the request to continue retrieving results starting from + // the last evaluated point. NextToken *string // Granularity of data to retrieve, in seconds. Valid values are 60 , 300 , and @@ -94,8 +105,9 @@ type ListInsightsMetricDataInput struct { Period *int32 // Specifies, in UTC, the start time for time-series data. The value specified is - // inclusive; results include data points with the specified time stamp. The - // default is 90 days before the time of request. + // inclusive; results include data points with the specified time stamp. + // + // The default is 90 days before the time of request. StartTime *time.Time noSmithyDocumentSerde @@ -103,9 +115,10 @@ type ListInsightsMetricDataInput struct { type ListInsightsMetricDataOutput struct { - // Only returned if InsightType parameter was set to ApiErrorRateInsight . If - // returning metrics for the ApiErrorRateInsight Insights type, this is the error - // to retrieve data for. For example, AccessDenied . + // Only returned if InsightType parameter was set to ApiErrorRateInsight . + // + // If returning metrics for the ApiErrorRateInsight Insights type, this is the + // error to retrieve data for. For example, AccessDenied . ErrorCode *string // The name of the event, typically the Amazon Web Services API on which unusual diff --git a/service/cloudtrail/api_op_ListPublicKeys.go b/service/cloudtrail/api_op_ListPublicKeys.go index d3b22de40aa..9fb42c73f8a 100644 --- a/service/cloudtrail/api_op_ListPublicKeys.go +++ b/service/cloudtrail/api_op_ListPublicKeys.go @@ -14,11 +14,12 @@ import ( // Returns all public keys whose private keys were used to sign the digest files // within the specified time range. The public key is needed to validate digest -// files that were signed with its corresponding private key. CloudTrail uses -// different private and public key pairs per Region. Each digest file is signed -// with a private key unique to its Region. When you validate a digest file from a -// specific Region, you must look in the same Region for its corresponding public -// key. +// files that were signed with its corresponding private key. +// +// CloudTrail uses different private and public key pairs per Region. Each digest +// file is signed with a private key unique to its Region. When you validate a +// digest file from a specific Region, you must look in the same Region for its +// corresponding public key. func (c *Client) ListPublicKeys(ctx context.Context, params *ListPublicKeysInput, optFns ...func(*Options)) (*ListPublicKeysOutput, error) { if params == nil { params = &ListPublicKeysInput{} @@ -59,8 +60,9 @@ type ListPublicKeysOutput struct { // Reserved for future use. NextToken *string - // Contains an array of PublicKey objects. The returned public keys may have - // validity time ranges that overlap. + // Contains an array of PublicKey objects. + // + // The returned public keys may have validity time ranges that overlap. PublicKeyList []types.PublicKey // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_ListTags.go b/service/cloudtrail/api_op_ListTags.go index 5e60debf990..1f4dd805eb8 100644 --- a/service/cloudtrail/api_op_ListTags.go +++ b/service/cloudtrail/api_op_ListTags.go @@ -32,10 +32,14 @@ func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ... type ListTagsInput struct { // Specifies a list of trail, event data store, or channel ARNs whose tags will be - // listed. The list has a limit of 20 ARNs. Example trail ARN format: - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail Example event data store - // ARN format: + // listed. The list has a limit of 20 ARNs. + // + // Example trail ARN format: + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // Example event data store ARN format: // arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE + // // Example channel ARN format: // arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 // diff --git a/service/cloudtrail/api_op_LookupEvents.go b/service/cloudtrail/api_op_LookupEvents.go index e55fcf455ba..37812b184a3 100644 --- a/service/cloudtrail/api_op_LookupEvents.go +++ b/service/cloudtrail/api_op_LookupEvents.go @@ -12,33 +12,49 @@ 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) -// that are captured by CloudTrail. You can look up events that occurred in a -// Region within the last 90 days. LookupEvents returns recent Insights events for -// trails that enable Insights. To view Insights events for an event data store, -// you can run queries on your Insights event data store, and you can also view the -// Lake dashboard for Insights. Lookup supports the following attributes for -// management events: +// Looks up [management events] or [CloudTrail Insights events] that are captured by CloudTrail. You can look up events that +// occurred in a Region within the last 90 days. +// +// LookupEvents returns recent Insights events for trails that enable Insights. To +// view Insights events for an event data store, you can run queries on your +// Insights event data store, and you can also view the Lake dashboard for +// Insights. +// +// 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 // // Lookup supports the following attributes for Insights events: +// // - 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. +// 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. +// +// [CloudTrail Insights events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events +// [management events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events func (c *Client) LookupEvents(ctx context.Context, params *LookupEventsInput, optFns ...func(*Options)) (*LookupEventsOutput, error) { if params == nil { params = &LookupEventsInput{} diff --git a/service/cloudtrail/api_op_PutEventSelectors.go b/service/cloudtrail/api_op_PutEventSelectors.go index fbf0871cbeb..eab81eed5a3 100644 --- a/service/cloudtrail/api_op_PutEventSelectors.go +++ b/service/cloudtrail/api_op_PutEventSelectors.go @@ -16,37 +16,48 @@ import ( // settings for your trail. If you want your trail to log Insights events, be sure // the event selector enables logging of the Insights event types you want // configured for your trail. For more information about logging Insights events, -// see Logging Insights events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) -// in the CloudTrail User Guide. By default, trails created without specific event -// selectors are configured to log all read and write management events, and no -// data events. When an event occurs in your account, CloudTrail evaluates the -// event selectors or advanced event selectors in all trails. For each trail, if -// 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. +// see [Logging Insights events for trails]in the CloudTrail User Guide. By default, trails created without specific +// event selectors are configured to log all read and write management events, and +// no data events. +// +// When an event occurs in your account, CloudTrail evaluates the event selectors +// or advanced event selectors in all trails. For each trail, if 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. // // 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 (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) -// , Logging data events (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 to a trail, any existing EventSelectors are overwritten. -// For more information about advanced event selectors, see Logging data events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) -// in the CloudTrail User Guide. +// 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], [Logging data events], and [Quotas in CloudTrail] 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 to a trail, any existing +// EventSelectors are overwritten. For more information about advanced event +// selectors, see [Logging data events]in the CloudTrail User Guide. +// +// [Logging management events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html +// [Logging Insights events for trails]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html +// [Quotas in CloudTrail]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html +// [Logging data events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html func (c *Client) PutEventSelectors(ctx context.Context, params *PutEventSelectorsInput, optFns ...func(*Options)) (*PutEventSelectorsOutput, error) { if params == nil { params = &PutEventSelectorsInput{} @@ -66,26 +77,35 @@ 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 + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. TrailName *string - // 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 + // 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 to a trail, any existing EventSelectors are overwritten. - // For more information about advanced event selectors, see Logging data events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) - // in the CloudTrail User Guide. + // For more information about advanced event selectors, see [Logging data events]in the CloudTrail User + // Guide. + // + // [Logging data events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html AdvancedEventSelectors []types.AdvancedEventSelector // Specifies the settings for your event selectors. You can configure up to five @@ -108,7 +128,8 @@ type PutEventSelectorsOutput struct { // Specifies the ARN of the trail that was updated with event selectors. The // following is the format of a trail ARN. - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail TrailARN *string // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_PutInsightSelectors.go b/service/cloudtrail/api_op_PutInsightSelectors.go index 16c5177f557..8650906d3e9 100644 --- a/service/cloudtrail/api_op_PutInsightSelectors.go +++ b/service/cloudtrail/api_op_PutInsightSelectors.go @@ -15,23 +15,29 @@ import ( // that you want to enable on an existing trail or event data store. You also use // PutInsightSelectors to turn off Insights event logging, by passing an empty list // of Insights types. The valid Insights event types are ApiErrorRateInsight and -// ApiCallRateInsight . To enable Insights on an event data store, you must specify -// the ARNs (or ID suffix of the ARNs) for the source event data store ( -// EventDataStore ) and the destination event data store ( InsightsDestination ). -// The source event data store logs management events and enables Insights. The -// destination event data store logs Insights events based upon the management -// event activity of the source event data store. The source and destination event -// data stores must belong to the same Amazon Web Services account. To log Insights -// events for a trail, you must specify the name ( TrailName ) of the CloudTrail -// trail for which you want to change or add Insights selectors. To log CloudTrail -// Insights events on API call volume, the trail or event data store must log write -// management events. To log CloudTrail Insights events on API error rate, the -// trail or event data store must log read or write management events. You can -// call GetEventSelectors on a trail to check whether the trail logs management -// events. You can call GetEventDataStore on an event data store to check whether -// the event data store logs management events. For more information, see Logging -// CloudTrail Insights events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) -// in the CloudTrail User Guide. +// ApiCallRateInsight . +// +// To enable Insights on an event data store, you must specify the ARNs (or ID +// suffix of the ARNs) for the source event data store ( EventDataStore ) and the +// destination event data store ( InsightsDestination ). The source event data +// store logs management events and enables Insights. The destination event data +// store logs Insights events based upon the management event activity of the +// source event data store. The source and destination event data stores must +// belong to the same Amazon Web Services account. +// +// To log Insights events for a trail, you must specify the name ( TrailName ) of +// the CloudTrail trail for which you want to change or add Insights selectors. +// +// To log CloudTrail Insights events on API call volume, the trail or event data +// store must log write management events. To log CloudTrail Insights events on +// API error rate, the trail or event data store must log read or write management +// events. You can call GetEventSelectors on a trail to check whether the trail +// logs management events. You can call GetEventDataStore on an event data store +// to check whether the event data store logs management events. +// +// For more information, see [Logging CloudTrail Insights events] in the CloudTrail User Guide. +// +// [Logging CloudTrail Insights events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html func (c *Client) PutInsightSelectors(ctx context.Context, params *PutInsightSelectorsInput, optFns ...func(*Options)) (*PutInsightSelectorsOutput, error) { if params == nil { params = &PutInsightSelectorsInput{} @@ -51,10 +57,13 @@ type PutInsightSelectorsInput struct { // A JSON string that contains the Insights types you want to log on a trail or // event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight - // types. The ApiCallRateInsight Insights type analyzes write-only management API - // calls that are aggregated per minute against a baseline API call volume. The - // ApiErrorRateInsight Insights type analyzes management API calls that result in - // error codes. The error is shown if the API call is unsuccessful. + // types. + // + // The ApiCallRateInsight Insights type analyzes write-only management API calls + // that are aggregated per minute against a baseline API call volume. + // + // The ApiErrorRateInsight Insights type analyzes management API calls that result + // in error codes. The error is shown if the API call is unsuccessful. // // This member is required. InsightSelectors []types.InsightSelector @@ -62,18 +71,23 @@ type PutInsightSelectorsInput struct { // The ARN (or ID suffix of the ARN) of the source event data store for which you // want to change or add Insights selectors. To enable Insights on an event data // store, you must provide both the EventDataStore and InsightsDestination - // parameters. You cannot use this parameter with the TrailName parameter. + // parameters. + // + // You cannot use this parameter with the TrailName parameter. EventDataStore *string - // The ARN (or ID suffix of the ARN) of the destination event data store that logs - // Insights events. To enable Insights on an event data store, you must provide - // both the EventDataStore and InsightsDestination parameters. You cannot use this - // parameter with the TrailName parameter. + // The ARN (or ID suffix of the ARN) of the destination event data store that + // logs Insights events. To enable Insights on an event data store, you must + // provide both the EventDataStore and InsightsDestination parameters. + // + // You cannot use this parameter with the TrailName parameter. InsightsDestination *string // The name of the CloudTrail trail for which you want to change or add Insights - // selectors. You cannot use this parameter with the EventDataStore and - // InsightsDestination parameters. + // selectors. + // + // You cannot use this parameter with the EventDataStore and InsightsDestination + // parameters. TrailName *string noSmithyDocumentSerde @@ -90,7 +104,7 @@ type PutInsightSelectorsOutput struct { // ApiCallRateInsight . InsightSelectors []types.InsightSelector - // The ARN of the destination event data store that logs Insights events. + // The ARN of the destination event data store that logs Insights events. InsightsDestination *string // 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 560877d6c1f..f1b92f5bd0c 100644 --- a/service/cloudtrail/api_op_PutResourcePolicy.go +++ b/service/cloudtrail/api_op_PutResourcePolicy.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a resource-based permission policy to a CloudTrail channel that is +// 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. +// more information about resource-based policies, see [CloudTrail resource-based policy examples]in the CloudTrail User +// Guide. +// +// [CloudTrail resource-based policy examples]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} @@ -32,18 +34,22 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { - // The Amazon Resource Name (ARN) of the CloudTrail channel attached to the + // 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 . // // 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: + // 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. // @@ -55,11 +61,11 @@ type PutResourcePolicyInput struct { type PutResourcePolicyOutput struct { - // The Amazon Resource Name (ARN) of the CloudTrail channel attached to the + // The Amazon Resource Name (ARN) of the CloudTrail channel attached to the // resource-based policy. ResourceArn *string - // The JSON-formatted string of the Amazon Web Services resource-based policy + // The JSON-formatted string of the Amazon Web Services resource-based policy // attached to the CloudTrail channel. ResourcePolicy *string diff --git a/service/cloudtrail/api_op_RegisterOrganizationDelegatedAdmin.go b/service/cloudtrail/api_op_RegisterOrganizationDelegatedAdmin.go index 7ca350d27a2..203008bc074 100644 --- a/service/cloudtrail/api_op_RegisterOrganizationDelegatedAdmin.go +++ b/service/cloudtrail/api_op_RegisterOrganizationDelegatedAdmin.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers an organization’s member account as the CloudTrail delegated -// administrator (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-delegated-administrator.html) -// . +// Registers an organization’s member account as the CloudTrail [delegated administrator]. +// +// [delegated administrator]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-delegated-administrator.html func (c *Client) RegisterOrganizationDelegatedAdmin(ctx context.Context, params *RegisterOrganizationDelegatedAdminInput, optFns ...func(*Options)) (*RegisterOrganizationDelegatedAdminOutput, error) { if params == nil { params = &RegisterOrganizationDelegatedAdminInput{} diff --git a/service/cloudtrail/api_op_RemoveTags.go b/service/cloudtrail/api_op_RemoveTags.go index fd7bf8a327d..f0a3f2ed0bb 100644 --- a/service/cloudtrail/api_op_RemoveTags.go +++ b/service/cloudtrail/api_op_RemoveTags.go @@ -31,10 +31,14 @@ func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns type RemoveTagsInput struct { // Specifies the ARN of the trail, event data store, or channel from which tags - // should be removed. Example trail ARN format: - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail Example event data store - // ARN format: + // should be removed. + // + // Example trail ARN format: + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // Example event data store ARN format: // arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE + // // Example channel ARN format: // arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 // diff --git a/service/cloudtrail/api_op_RestoreEventDataStore.go b/service/cloudtrail/api_op_RestoreEventDataStore.go index 54a8bdf1367..825b87b05a0 100644 --- a/service/cloudtrail/api_op_RestoreEventDataStore.go +++ b/service/cloudtrail/api_op_RestoreEventDataStore.go @@ -58,7 +58,8 @@ type RestoreEventDataStoreOutput struct { // Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // 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, diff --git a/service/cloudtrail/api_op_StartImport.go b/service/cloudtrail/api_op_StartImport.go index 1bd3b08fecc..955f740434f 100644 --- a/service/cloudtrail/api_op_StartImport.go +++ b/service/cloudtrail/api_op_StartImport.go @@ -12,21 +12,28 @@ import ( "time" ) -// Starts an import of logged trail events from a source S3 bucket to a +// 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 +// importing trail events, see [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]. +// +// 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. +// +// [Considerations]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-copy-trail-to-lake.html#cloudtrail-trail-copy-considerations +// [Controlling ownership of objects and disabling ACLs for your bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optFns ...func(*Options)) (*StartImportOutput, error) { if params == nil { params = &StartImportInput{} @@ -44,24 +51,24 @@ func (c *Client) StartImport(ctx context.Context, params *StartImportInput, optF type StartImportInput struct { - // The ARN of the destination event data store. Use this parameter for a new + // The ARN of the destination event data store. Use this parameter for a new // import. Destinations []string - // Use with StartEventTime to bound a StartImport request, and limit imported + // 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. + // The ID of the import. Use this parameter when you are retrying an import. ImportId *string - // The source S3 bucket for the import. Use this parameter for a new import. + // The source S3 bucket for the import. Use this parameter for a new import. ImportSource *types.ImportSource - // Use with EndEventTime to bound a StartImport request, and limit imported trail + // Use with EndEventTime 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 @@ -73,32 +80,32 @@ type StartImportInput struct { type StartImportOutput struct { - // The timestamp for the import's creation. + // The timestamp for the import's creation. CreatedTimestamp *time.Time - // The ARN of the destination event data store. + // The ARN of the destination event data store. Destinations []string - // Used with StartEventTime to bound a StartImport request, and limit imported + // Used with StartEventTime to bound a StartImport request, and limit imported // trail events to only those events logged within a specified time period. EndEventTime *time.Time - // The ID of the import. + // The ID of the import. ImportId *string - // The source S3 bucket for the import. + // The source S3 bucket for the import. ImportSource *types.ImportSource - // Shows the status of the import after a StartImport request. An import finishes + // Shows the status of the import after a StartImport request. An import finishes // with a status of COMPLETED if there were no failures, or FAILED if there were // failures. ImportStatus types.ImportStatus - // Used with EndEventTime to bound a StartImport request, and limit imported trail - // events to only those events logged within a specified time period. + // Used with EndEventTime to bound a StartImport request, and limit imported + // trail events to only those events logged within a specified time period. StartEventTime *time.Time - // The timestamp of the import's last update, if applicable. + // The timestamp of the import's last update, if applicable. UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_StartLogging.go b/service/cloudtrail/api_op_StartLogging.go index afb07981834..04dbbf88b33 100644 --- a/service/cloudtrail/api_op_StartLogging.go +++ b/service/cloudtrail/api_op_StartLogging.go @@ -36,7 +36,8 @@ type StartLoggingInput struct { // Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs // Amazon Web Services API calls. The following is the format of a trail ARN. - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. Name *string diff --git a/service/cloudtrail/api_op_StartQuery.go b/service/cloudtrail/api_op_StartQuery.go index 682efaa96d2..0000c357516 100644 --- a/service/cloudtrail/api_op_StartQuery.go +++ b/service/cloudtrail/api_op_StartQuery.go @@ -12,11 +12,12 @@ import ( // Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide // your SQL query, enclosed in single quotation marks. Use the optional -// DeliveryS3Uri parameter to deliver the query results to an S3 bucket. StartQuery -// requires you specify either the QueryStatement parameter, or a QueryAlias and -// any QueryParameters . In the current release, the QueryAlias and QueryParameters -// parameters are used only for the queries that populate the CloudTrail Lake -// dashboards. +// DeliveryS3Uri parameter to deliver the query results to an S3 bucket. +// +// StartQuery requires you specify either the QueryStatement parameter, or a +// QueryAlias and any QueryParameters . In the current release, the QueryAlias and +// QueryParameters parameters are used only for the queries that populate the +// CloudTrail Lake dashboards. func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns ...func(*Options)) (*StartQueryOutput, error) { if params == nil { params = &StartQueryInput{} @@ -34,13 +35,13 @@ func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns type StartQueryInput struct { - // The URI for the S3 bucket where CloudTrail delivers the query results. + // The URI for the S3 bucket where CloudTrail delivers the query results. DeliveryS3Uri *string - // The alias that identifies a query template. + // The alias that identifies a query template. QueryAlias *string - // The query parameters for the specified QueryAlias . + // The query parameters for the specified QueryAlias . QueryParameters []string // The SQL code of your query. diff --git a/service/cloudtrail/api_op_StopImport.go b/service/cloudtrail/api_op_StopImport.go index cfe3a32939e..25e6f13102d 100644 --- a/service/cloudtrail/api_op_StopImport.go +++ b/service/cloudtrail/api_op_StopImport.go @@ -30,7 +30,7 @@ func (c *Client) StopImport(ctx context.Context, params *StopImportInput, optFns type StopImportInput struct { - // The ID of the import. + // The ID of the import. // // This member is required. ImportId *string @@ -40,33 +40,33 @@ type StopImportInput struct { type StopImportOutput struct { - // The timestamp of the import's creation. + // The timestamp of the import's creation. CreatedTimestamp *time.Time - // The ARN of the destination event data store. + // The ARN of the destination event data store. Destinations []string - // Used with StartEventTime to bound a StartImport request, and limit imported + // Used with StartEventTime to bound a StartImport request, and limit imported // trail events to only those events logged within a specified time period. EndEventTime *time.Time - // The ID for the import. + // The ID for the import. ImportId *string - // The source S3 bucket for the import. + // The source S3 bucket for the import. ImportSource *types.ImportSource - // Returns information on the stopped import. + // Returns information on the stopped import. ImportStatistics *types.ImportStatistics - // The status of the import. + // The status of the import. ImportStatus types.ImportStatus - // Used with EndEventTime to bound a StartImport request, and limit imported trail - // events to only those events logged within a specified time period. + // Used with EndEventTime to bound a StartImport request, and limit imported + // trail events to only those events logged within a specified time period. StartEventTime *time.Time - // The timestamp of the import's last update. + // The timestamp of the import's last update. UpdatedTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/api_op_StopLogging.go b/service/cloudtrail/api_op_StopLogging.go index 08ae866ae6a..ab324e00126 100644 --- a/service/cloudtrail/api_op_StopLogging.go +++ b/service/cloudtrail/api_op_StopLogging.go @@ -39,7 +39,9 @@ type StopLoggingInput struct { // Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will // stop logging Amazon Web Services API calls. The following is the format of a - // trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // trail ARN. + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. Name *string diff --git a/service/cloudtrail/api_op_UpdateChannel.go b/service/cloudtrail/api_op_UpdateChannel.go index d5a3a6f4342..bd8e2892545 100644 --- a/service/cloudtrail/api_op_UpdateChannel.go +++ b/service/cloudtrail/api_op_UpdateChannel.go @@ -38,7 +38,7 @@ type UpdateChannelInput struct { // channel. Destinations []types.Destination - // Changes the name of the channel. + // Changes the name of the channel. Name *string noSmithyDocumentSerde diff --git a/service/cloudtrail/api_op_UpdateEventDataStore.go b/service/cloudtrail/api_op_UpdateEventDataStore.go index e9a9053e2ad..580267075e7 100644 --- a/service/cloudtrail/api_op_UpdateEventDataStore.go +++ b/service/cloudtrail/api_op_UpdateEventDataStore.go @@ -18,12 +18,16 @@ import ( // in days, and valid values are integers between 7 and 3653 if the BillingMode is // set to EXTENDABLE_RETENTION_PRICING , or between 7 and 2557 if BillingMode is // set to FIXED_RETENTION_PRICING . By default, TerminationProtection is enabled. +// // For event data stores for CloudTrail events, AdvancedEventSelectors includes or // excludes management or data events in your event data store. For more -// information about AdvancedEventSelectors , see AdvancedEventSelectors (https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html) -// . For event data stores for CloudTrail Insights events, Config configuration +// information about AdvancedEventSelectors , see [AdvancedEventSelectors]. +// +// For event data stores for CloudTrail Insights events, Config configuration // items, Audit Manager evidence, or non-Amazon Web Services events, // AdvancedEventSelectors includes events of that type in your event data store. +// +// [AdvancedEventSelectors]: https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html func (c *Client) UpdateEventDataStore(ctx context.Context, params *UpdateEventDataStoreInput, optFns ...func(*Options)) (*UpdateEventDataStoreOutput, error) { if params == nil { params = &UpdateEventDataStoreInput{} @@ -55,37 +59,53 @@ type UpdateEventDataStoreInput struct { // FIXED_RETENTION_PRICING . If BillingMode is set to EXTENDABLE_RETENTION_PRICING // and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop // ingestion on the event data store and create a new event data store that uses - // FIXED_RETENTION_PRICING . The billing mode for the event data store determines - // the cost for ingesting events and the default and maximum retention period for - // the event data store. The following are the possible values: + // FIXED_RETENTION_PRICING . + // + // The billing mode for the event data store determines the cost for ingesting + // events and the default and maximum retention period for the event data store. + // + // The following are the possible values: + // // - EXTENDABLE_RETENTION_PRICING - This billing mode is generally recommended if // you want a flexible retention period of up to 3653 days (about 10 years). The // default retention period for this billing mode is 366 days. + // // - FIXED_RETENTION_PRICING - This billing mode is recommended if you expect to // ingest more than 25 TB of event data per month and need a retention period of up // to 2557 days (about 7 years). The default retention period for this billing mode // is 2557 days. - // For more information about CloudTrail pricing, see CloudTrail Pricing (http://aws.amazon.com/cloudtrail/pricing/) - // and Managing CloudTrail Lake costs (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html) - // . + // + // For more information about CloudTrail pricing, see [CloudTrail Pricing] and [Managing CloudTrail Lake costs]. + // + // [CloudTrail Pricing]: http://aws.amazon.com/cloudtrail/pricing/ + // [Managing CloudTrail Lake costs]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html BillingMode types.BillingMode // 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 // 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 // prevents users from querying the data in the event data store that was encrypted // with the key. After you associate an event data store with a KMS key, the KMS // 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) - // in the Key Management Service Developer Guide. Examples: + // multi-Region keys, see [Using multi-Region keys]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 + // + // [Using multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html KmsKeyId *string // Specifies whether an event data store collects events from all Regions, or only @@ -96,24 +116,28 @@ type UpdateEventDataStoreInput struct { Name *string // Specifies whether an event data store collects events logged for an - // organization in Organizations. Only the management account for the organization - // can convert an organization event data store to a non-organization event data - // store, or convert a non-organization event data store to an organization event - // data store. + // organization in Organizations. + // + // Only the management account for the organization can convert an organization + // event data store to a non-organization event data store, or convert a + // non-organization event data store to an organization event data store. OrganizationEnabled *bool // The retention period of the event data store, in days. If BillingMode is set to // EXTENDABLE_RETENTION_PRICING , you can set a retention period of up to 3653 // days, the equivalent of 10 years. If BillingMode is set to // FIXED_RETENTION_PRICING , you can set a retention period of up to 2557 days, the - // equivalent of seven years. CloudTrail Lake determines whether to retain an event - // by checking if the eventTime of the event is within the specified retention - // period. For example, if you set a retention period of 90 days, CloudTrail will - // remove events when the eventTime is older than 90 days. If you decrease the - // retention period of an event data store, CloudTrail will remove any events with - // an eventTime older than the new retention period. For example, if the previous - // retention period was 365 days and you decrease it to 100 days, CloudTrail will - // remove events with an eventTime older than 100 days. + // equivalent of seven years. + // + // CloudTrail Lake determines whether to retain an event by checking if the + // eventTime of the event is within the specified retention period. For example, if + // you set a retention period of 90 days, CloudTrail will remove events when the + // eventTime is older than 90 days. + // + // If you decrease the retention period of an event data store, CloudTrail will + // remove any events with an eventTime older than the new retention period. For + // example, if the previous retention period was 365 days and you decrease it to + // 100 days, CloudTrail will remove events with an eventTime older than 100 days. RetentionPeriod *int32 // Indicates that termination protection is enabled and the event data store @@ -137,19 +161,21 @@ type UpdateEventDataStoreOutput struct { // The ARN of the event data store. EventDataStoreArn *string - // If Lake query federation is enabled, provides the ARN of the federation role + // If Lake query federation is enabled, provides the ARN of the federation role // used to access the resources for the federated event data store. FederationRoleArn *string - // Indicates the Lake query federation (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html) - // status. The status is ENABLED if Lake query federation is enabled, or DISABLED - // if Lake query federation is disabled. You cannot delete an event data store if - // the FederationStatus is ENABLED . + // Indicates the [Lake query federation] status. The status is ENABLED if Lake query federation is + // enabled, or DISABLED if Lake query federation is disabled. You cannot delete an + // event data store if the FederationStatus is ENABLED . + // + // [Lake query federation]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html FederationStatus types.FederationStatus // Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // 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 diff --git a/service/cloudtrail/api_op_UpdateTrail.go b/service/cloudtrail/api_op_UpdateTrail.go index 8d665d6da38..d5b334c85c4 100644 --- a/service/cloudtrail/api_op_UpdateTrail.go +++ b/service/cloudtrail/api_op_UpdateTrail.go @@ -36,38 +36,47 @@ 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 + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // // This member is required. Name *string // 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 . + // You must use a log group that exists in your account. + // + // Not required unless you 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 - // 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 - // files will not be created for the log files delivered from noon on January 2 to - // noon on January 10. The same applies whenever you stop CloudTrail logging or - // delete a trail. + // 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 files will not be created for the log files delivered from noon on + // January 2 to noon on January 10. The same applies whenever you stop CloudTrail + // logging or delete a trail. EnableLogFileValidation *bool // Specifies whether the trail is publishing events from global services such as @@ -91,33 +100,44 @@ type UpdateTrailInput struct { // , 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 current Amazon Web Services account but be - // deleted from all member accounts in the organization. Only the management - // account for the organization can convert an organization trail to a - // non-organization trail, or convert a non-organization trail to an organization - // trail. + // deleted from all member accounts in the organization. + // + // Only the management account for the organization can convert an organization + // trail to a non-organization trail, or convert a non-organization trail to an + // organization trail. 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 // 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) - // in the Key Management Service Developer Guide. Examples: + // multi-Region keys, see [Using multi-Region keys]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 + // + // [Using multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html 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]. + // + // [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. + // have designated for log file delivery. For more information, see [Finding Your CloudTrail Log Files]. The maximum + // length is 200 characters. + // + // [Finding Your CloudTrail Log Files]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html S3KeyPrefix *string // Specifies the name of the Amazon SNS topic defined for notification of log file @@ -151,7 +171,8 @@ type UpdateTrailOutput struct { // Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string // Specifies whether log file integrity validation is enabled. @@ -164,14 +185,16 @@ type UpdateTrailOutput struct { 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 - // IAM Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html) - // . + // have designated for log file delivery. For more information, see [Finding Your IAM Log Files]. + // + // [Finding Your 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 // notifications when log files are delivered. The following is the format of a - // topic ARN. arn:aws:sns:us-east-2:123456789012:MyTopic + // topic ARN. + // + // arn:aws:sns:us-east-2:123456789012:MyTopic SnsTopicARN *string // This field is no longer in use. Use SnsTopicARN . @@ -180,7 +203,9 @@ type UpdateTrailOutput struct { SnsTopicName *string // Specifies the ARN of the trail that was updated. The following is the format of - // a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // a trail ARN. + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail TrailARN *string // Metadata pertaining to the operation's result. diff --git a/service/cloudtrail/doc.go b/service/cloudtrail/doc.go index 3255cf64078..c483c517729 100644 --- a/service/cloudtrail/doc.go +++ b/service/cloudtrail/doc.go @@ -3,21 +3,28 @@ // Package cloudtrail provides the API client, operations, and parameter types for // AWS CloudTrail. // -// CloudTrail This is the CloudTrail API Reference. It provides descriptions of -// actions, data types, common parameters, and common errors for CloudTrail. +// # CloudTrail +// +// This is the CloudTrail API Reference. It provides descriptions of actions, data +// types, common parameters, and common errors for CloudTrail. +// // CloudTrail is a web service that records Amazon Web Services API calls for your // Amazon Web Services account and delivers log files to an Amazon S3 bucket. The // recorded information includes the identity of the user, the start time of the // Amazon Web Services API call, the source IP address, the request parameters, and -// the response elements returned by the service. As an alternative to the API, you -// can use one of the Amazon Web Services SDKs, which consist of libraries and -// sample code for various programming languages and platforms (Java, Ruby, .NET, -// 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) -// for information about the data that is included with each Amazon Web Services -// API call listed in the log files. +// the response elements returned by the service. +// +// As an alternative to the API, you can use one of the Amazon Web Services SDKs, +// which consist of libraries and sample code for various programming languages and +// platforms (Java, Ruby, .NET, 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]. +// +// See the [CloudTrail User Guide] for information about the data that is included with each Amazon Web +// Services API call listed in the log files. +// +// [CloudTrail User Guide]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html +// [Tools to Build on Amazon Web Services]: http://aws.amazon.com/tools/ package cloudtrail diff --git a/service/cloudtrail/options.go b/service/cloudtrail/options.go index 3f41deae494..0d61d3f13fa 100644 --- a/service/cloudtrail/options.go +++ b/service/cloudtrail/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudtrail/types/enums.go b/service/cloudtrail/types/enums.go index 3befd99d8b6..6f4c522d3d0 100644 --- a/service/cloudtrail/types/enums.go +++ b/service/cloudtrail/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BillingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BillingMode) Values() []BillingMode { return []BillingMode{ "EXTENDABLE_RETENTION_PRICING", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for DeliveryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStatus) Values() []DeliveryStatus { return []DeliveryStatus{ "SUCCESS", @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for DestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationType) Values() []DestinationType { return []DestinationType{ "EVENT_DATA_STORE", @@ -78,8 +81,9 @@ const ( ) // Values returns all known values for EventCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventCategory) Values() []EventCategory { return []EventCategory{ "insight", @@ -99,8 +103,9 @@ const ( ) // Values returns all known values for EventDataStoreStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventDataStoreStatus) Values() []EventDataStoreStatus { return []EventDataStoreStatus{ "CREATED", @@ -123,8 +128,9 @@ const ( ) // Values returns all known values for FederationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FederationStatus) Values() []FederationStatus { return []FederationStatus{ "ENABLING", @@ -144,8 +150,9 @@ const ( ) // Values returns all known values for ImportFailureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportFailureStatus) Values() []ImportFailureStatus { return []ImportFailureStatus{ "FAILED", @@ -166,8 +173,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -187,8 +195,9 @@ const ( ) // Values returns all known values for InsightsMetricDataType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightsMetricDataType) Values() []InsightsMetricDataType { return []InsightsMetricDataType{ "FillWithZeros", @@ -205,8 +214,9 @@ const ( ) // Values returns all known values for InsightType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightType) Values() []InsightType { return []InsightType{ "ApiCallRateInsight", @@ -229,8 +239,9 @@ const ( ) // Values returns all known values for LookupAttributeKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LookupAttributeKey) Values() []LookupAttributeKey { return []LookupAttributeKey{ "EventId", @@ -257,8 +268,9 @@ const ( ) // Values returns all known values for QueryStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryStatus) Values() []QueryStatus { return []QueryStatus{ "QUEUED", @@ -280,8 +292,9 @@ const ( ) // Values returns all known values for ReadWriteType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadWriteType) Values() []ReadWriteType { return []ReadWriteType{ "ReadOnly", diff --git a/service/cloudtrail/types/errors.go b/service/cloudtrail/types/errors.go index be0c03a1c28..4d84c650a52 100644 --- a/service/cloudtrail/types/errors.go +++ b/service/cloudtrail/types/errors.go @@ -33,7 +33,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when you start a new import and a previous import is +// This exception is thrown when you start a new import and a previous import is +// // still in progress. type AccountHasOngoingImportException struct { Message *string @@ -249,7 +250,9 @@ func (e *ChannelExistsForEDSException) ErrorCode() string { } func (e *ChannelExistsForEDSException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when the maximum number of channels limit is exceeded. +// This exception is thrown when the maximum number of channels limit is +// +// exceeded. type ChannelMaxLimitExceededException struct { Message *string @@ -302,10 +305,10 @@ func (e *ChannelNotFoundException) ErrorCode() string { func (e *ChannelNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// . +// CloudTrail and Organizations. For more information, see [Enabling Trusted Access with Other Amazon Web Services Services]and [Prepare For Creating a Trail For Your Organization]. +// +// [Prepare For Creating a Trail For Your Organization]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html +// [Enabling Trusted Access with Other Amazon Web Services Services]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html type CloudTrailAccessNotEnabledException struct { Message *string @@ -334,10 +337,14 @@ func (e *CloudTrailAccessNotEnabledException) ErrorFault() smithy.ErrorFault { } // This exception is thrown when an operation is called with an ARN that is not -// valid. The following is the format of a trail ARN: -// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail The following is the -// format of an event data store ARN: +// valid. +// +// The following is the format of a trail ARN: +// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail +// +// The following is the format of an event data store ARN: // arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE +// // The following is the format of a channel ARN: // arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890 type CloudTrailARNInvalidException struct { @@ -424,7 +431,8 @@ func (e *CloudWatchLogsDeliveryUnavailableException) ErrorFault() smithy.ErrorFa return smithy.FaultClient } -// You are trying to update a resource when another request is in progress. Allow +// You are trying to update a resource when another request is in progress. Allow +// // sufficient wait time for the previous request to complete, then retry your // request. type ConcurrentModificationException struct { @@ -566,7 +574,8 @@ func (e *EventDataStoreARNInvalidException) ErrorCode() string { } func (e *EventDataStoreARNInvalidException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You cannot delete the event data store because Lake query federation is +// You cannot delete the event data store because Lake query federation is +// // enabled. To delete the event data store, run the DisableFederation operation to // disable Lake query federation on the event data store. type EventDataStoreFederationEnabledException struct { @@ -596,7 +605,8 @@ func (e *EventDataStoreFederationEnabledException) ErrorFault() smithy.ErrorFaul return smithy.FaultClient } -// This exception is thrown when you try to update or delete an event data store +// This exception is thrown when you try to update or delete an event data store +// // that currently has an import in progress. type EventDataStoreHasOngoingImportException struct { Message *string @@ -990,8 +1000,9 @@ 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) -// in the CloudTrail User Guide. +// writing a query, see [Create or edit a query]in the CloudTrail User Guide. +// +// [Create or edit a query]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html type InvalidDateRangeException struct { Message *string @@ -1108,14 +1119,20 @@ func (e *InvalidEventDataStoreStatusException) ErrorFault() smithy.ErrorFault { // trail uses advanced event selectors, a maximum of 500 total values for all // 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: +// 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. type InvalidEventSelectorsException struct { @@ -1170,7 +1187,8 @@ func (e *InvalidHomeRegionException) ErrorCode() string { } func (e *InvalidHomeRegionException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when the provided source S3 bucket is not valid for +// This exception is thrown when the provided source S3 bucket is not valid for +// // import. type InvalidImportSourceException struct { Message *string @@ -1203,9 +1221,10 @@ func (e *InvalidImportSourceException) ErrorFault() smithy.ErrorFault { return s // InsightType are ApiCallRateInsight and ApiErrorRateInsight . To enable Insights // on an event data store, the destination event data store specified by the // InsightsDestination parameter must log Insights events and the source event data -// store specified by the EventDataStore parameter must log management events. For -// UpdateEventDataStore , this exception is thrown if Insights are enabled on the -// event data store and the updated advanced event selectors are not compatible +// store specified by the EventDataStore parameter must log management events. +// +// For UpdateEventDataStore , this exception is thrown if Insights are enabled on +// the event data store and the updated advanced event selectors are not compatible // with the configured InsightSelectors . If the InsightSelectors includes an // InsightType of ApiCallRateInsight , the source event data store must log write // management events. If the InsightSelectors includes an InsightType of @@ -1396,9 +1415,10 @@ func (e *InvalidParameterException) ErrorCode() string { func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// in the CloudTrail User Guide. +// unsupported keywords. For more information about writing a query, see [Create or edit a query]in the +// CloudTrail User Guide. +// +// [Create or edit a query]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html type InvalidQueryStatementException struct { Message *string @@ -1636,12 +1656,17 @@ 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) type InvalidTrailNameException struct { Message *string @@ -1805,7 +1830,8 @@ func (e *MaximumNumberOfTrailsExceededException) ErrorFault() smithy.ErrorFault return smithy.FaultClient } -// This exception is thrown when the management account does not have a +// This exception is thrown when the management account does not have a +// // service-linked role. type NoManagementAccountSLRExistsException struct { Message *string @@ -1834,7 +1860,8 @@ func (e *NoManagementAccountSLRExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when the account making the request is not the +// This exception is thrown when the account making the request is not the +// // organization's management account. type NotOrganizationManagementAccountException struct { Message *string @@ -1866,9 +1893,10 @@ func (e *NotOrganizationManagementAccountException) ErrorFault() smithy.ErrorFau // 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]or [Create an event data store]. +// +// [Prepare For Creating a Trail For Your Organization]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html +// [Create an event data store]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html type NotOrganizationMasterAccountException struct { Message *string @@ -2006,7 +2034,8 @@ func (e *QueryIdNotFoundException) ErrorCode() string { } func (e *QueryIdNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// This exception is thrown when the provided resource does not exist, or the ARN +// 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 . type ResourceARNNotValidException struct { @@ -2086,12 +2115,17 @@ func (e *ResourcePolicyNotFoundException) ErrorCode() string { } func (e *ResourcePolicyNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// 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: +// 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. type ResourcePolicyNotValidException struct { diff --git a/service/cloudtrail/types/types.go b/service/cloudtrail/types/types.go index e7e56c7ae33..6c460fb0d9b 100644 --- a/service/cloudtrail/types/types.go +++ b/service/cloudtrail/types/types.go @@ -10,25 +10,36 @@ import ( // Advanced event selectors let you create fine-grained selectors for CloudTrail // management and data events. They help you control costs by logging only those // events that are important to you. For more information about advanced event -// selectors, see Logging management events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) -// and Logging data events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) -// in the CloudTrail User Guide. You cannot apply both event selectors and advanced -// event selectors to a trail. Supported CloudTrail event record fields for -// management events +// selectors, see [Logging management events]and [Logging data events] in the CloudTrail User Guide. +// +// You cannot apply both event selectors and advanced event selectors to a trail. +// +// Supported CloudTrail event record fields for management events +// // - eventCategory (required) +// // - eventSource +// // - readOnly // // Supported CloudTrail event record fields for data events +// // - eventCategory (required) +// // - resources.type (required) +// // - readOnly +// // - eventName +// // - resources.ARN // // For event data stores for CloudTrail Insights events, Config configuration // items, Audit Manager evidence, or events outside of Amazon Web Services, the // only supported field is eventCategory . +// +// [Logging management events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html +// [Logging data events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html type AdvancedEventSelector struct { // Contains all selector statements in an advanced event selector. @@ -46,278 +57,477 @@ 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. + // A field in a CloudTrail event record on which to filter events to be logged. // For event data stores for CloudTrail Insights events, Config configuration // items, Audit Manager evidence, or events outside of Amazon Web Services, the - // field is used only for selecting events as filtering is not supported. For - // CloudTrail management events, supported fields include readOnly , eventCategory - // , and eventSource . For CloudTrail data events, supported fields include - // readOnly , eventCategory , eventName , resources.type , and resources.ARN . For - // event data stores for CloudTrail Insights events, Config configuration items, - // Audit Manager evidence, or events outside of Amazon Web Services, the only - // supported field is eventCategory . + // field is used only for selecting events as filtering is not supported. + // + // For CloudTrail management events, supported fields include readOnly , + // eventCategory , and eventSource . + // + // For CloudTrail data events, supported fields include readOnly , eventCategory , + // eventName , resources.type , and resources.ARN . + // + // For event data stores for CloudTrail Insights events, Config configuration + // items, Audit Manager evidence, or events outside of Amazon Web Services, 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 to // NotEquals kms.amazonaws.com or NotEquals rdsdata.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 management events, the value must be Management . - // - For CloudTrail data events, the value must be Data . The following are used - // only for event data stores: + // + // - For CloudTrail data events, the value must be Data . + // + // The following are used only for event data stores: + // // - For CloudTrail Insights events, the value must be Insight . + // // - 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::DynamoDB::Table + // // - AWS::Lambda::Function + // // - AWS::S3::Object + // // - AWS::AppConfig::Configuration + // // - AWS::B2BI::Transformer + // // - AWS::Bedrock::AgentAlias + // // - AWS::Bedrock::KnowledgeBase + // // - AWS::Cassandra::Table + // // - AWS::CloudFront::KeyValueStore + // // - AWS::CloudTrail::Channel + // // - AWS::CodeWhisperer::Customization + // // - AWS::CodeWhisperer::Profile + // // - AWS::Cognito::IdentityPool + // // - AWS::DynamoDB::Stream + // // - AWS::EC2::Snapshot + // // - AWS::EMRWAL::Workspace + // // - AWS::FinSpace::Environment + // // - AWS::Glue::Table + // // - AWS::GreengrassV2::ComponentVersion + // // - AWS::GreengrassV2::Deployment + // // - AWS::GuardDuty::Detector + // // - AWS::IoT::Certificate + // // - AWS::IoT::Thing + // // - AWS::IoTSiteWise::Asset + // // - AWS::IoTSiteWise::TimeSeries + // // - AWS::IoTTwinMaker::Entity + // // - AWS::IoTTwinMaker::Workspace + // // - AWS::KendraRanking::ExecutionPlan + // // - AWS::KinesisVideo::Stream + // // - AWS::ManagedBlockchain::Network + // // - AWS::ManagedBlockchain::Node + // // - AWS::MedicalImaging::Datastore + // // - AWS::NeptuneGraph::Graph + // // - AWS::PCAConnectorAD::Connector + // // - AWS::QBusiness::Application + // // - AWS::QBusiness::DataSource + // // - AWS::QBusiness::Index + // // - AWS::QBusiness::WebExperience + // // - AWS::RDS::DBCluster + // // - AWS::S3::AccessPoint + // // - AWS::S3ObjectLambda::AccessPoint + // // - AWS::S3Outposts::Object + // // - AWS::SageMaker::Endpoint + // // - AWS::SageMaker::ExperimentTrialComponent + // // - AWS::SageMaker::FeatureGroup + // // - AWS::ServiceDiscovery::Namespace + // // - AWS::ServiceDiscovery::Service + // // - AWS::SCN::Instance + // // - AWS::SNS::PlatformEndpoint + // // - AWS::SNS::Topic + // // - AWS::SWF::Domain + // // - AWS::SQS::Queue + // // - AWS::SSMMessages::ControlChannel + // // - AWS::ThinClient::Device + // // - AWS::ThinClient::Environment + // // - AWS::Timestream::Database + // // - AWS::Timestream::Table - // - AWS::VerifiedPermissions::PolicyStore You can have only one resources.type - // field per selector. To log data events on more than one resource type, add - // another selector. + // + // - AWS::VerifiedPermissions::PolicyStore + // + // 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. + // 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::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::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::AppConfig::Configuration , and the operator is set to Equals or NotEquals - // , the ARN must be in the following format: - // - arn::appconfig:::application//environment//configuration/ When - // resources.type equals AWS::B2BI::Transformer , and the operator is set to + // + // - arn::s3:::// + // + // 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::b2bi:::transformer/ When resources.type equals AWS::Bedrock::AgentAlias - // , and the operator is set to Equals or NotEquals , the ARN must be in the - // following format: - // - arn::bedrock:::agent-alias// When resources.type equals - // AWS::Bedrock::KnowledgeBase , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::bedrock:::knowledge-base/ When resources.type equals - // AWS::Cassandra::Table , and the operator is set to Equals or NotEquals , the - // ARN must be in the following format: - // - arn::cassandra:::/keyspace//table/ When resources.type equals - // AWS::CloudFront::KeyValueStore , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::cloudfront:::key-value-store/ 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::CodeWhisperer::Customization , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::codewhisperer:::customization/ When resources.type equals - // AWS::CodeWhisperer::Profile , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::codewhisperer:::profile/ When resources.type equals - // AWS::Cognito::IdentityPool , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::cognito-identity:::identitypool/ 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::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::EMRWAL::Workspace , and - // the operator is set to Equals or NotEquals , the ARN must be in the following - // format: - // - arn::emrwal:::workspace/ 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::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::GreengrassV2::ComponentVersion , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::greengrass:::components/ When resources.type equals - // AWS::GreengrassV2::Deployment , and the operator is set to Equals or NotEquals - // , the ARN must be in the following format: - // - arn::greengrass:::deployments/ When resources.type equals - // AWS::GuardDuty::Detector , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::guardduty:::detector/ When resources.type equals AWS::IoT::Certificate - // , and the operator is set to Equals or NotEquals , the ARN must be in the - // following format: - // - arn::iot:::cert/ When resources.type equals AWS::IoT::Thing , and the + // + // - arn::dynamodb:::table/ + // + // 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::AppConfig::Configuration , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::appconfig:::application//environment//configuration/ + // + // When resources.type equals AWS::B2BI::Transformer , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::b2bi:::transformer/ + // + // When resources.type equals AWS::Bedrock::AgentAlias , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::bedrock:::agent-alias// + // + // When resources.type equals AWS::Bedrock::KnowledgeBase , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::bedrock:::knowledge-base/ + // + // When resources.type equals AWS::Cassandra::Table , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::cassandra:::/keyspace//table/ + // + // When resources.type equals AWS::CloudFront::KeyValueStore , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::cloudfront:::key-value-store/ + // + // 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::CodeWhisperer::Customization , and the operator + // is set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::codewhisperer:::customization/ + // + // When resources.type equals AWS::CodeWhisperer::Profile , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::codewhisperer:::profile/ + // + // When resources.type equals AWS::Cognito::IdentityPool , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::cognito-identity:::identitypool/ + // + // 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::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::EMRWAL::Workspace , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::emrwal:::workspace/ + // + // 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::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::GreengrassV2::ComponentVersion , and the // operator is set to Equals or NotEquals , the ARN must be in the following // format: - // - arn::iot:::thing/ When resources.type equals AWS::IoTSiteWise::Asset , and - // the operator is set to Equals or NotEquals , the ARN must be in the following - // format: - // - arn::iotsitewise:::asset/ When resources.type equals - // AWS::IoTSiteWise::TimeSeries , and the operator is set to Equals or NotEquals - // , the ARN must be in the following format: - // - arn::iotsitewise:::timeseries/ When resources.type equals - // AWS::IoTTwinMaker::Entity , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::iottwinmaker:::workspace//entity/ When resources.type equals - // AWS::IoTTwinMaker::Workspace , and the operator is set to Equals or NotEquals - // , the ARN must be in the following format: - // - arn::iottwinmaker:::workspace/ When resources.type equals - // AWS::KendraRanking::ExecutionPlan , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::kendra-ranking:::rescore-execution-plan/ When resources.type equals - // AWS::KinesisVideo::Stream , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::kinesisvideo:::stream// When resources.type equals - // AWS::ManagedBlockchain::Network , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::managedblockchain:::networks/ 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::MedicalImaging::Datastore , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::medical-imaging:::datastore/ When resources.type equals - // AWS::NeptuneGraph::Graph , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::neptune-graph:::graph/ When resources.type equals - // AWS::PCAConnectorAD::Connector , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::pca-connector-ad:::connector/ When resources.type equals - // AWS::QBusiness::Application , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::qbusiness:::application/ When resources.type equals - // AWS::QBusiness::DataSource , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::qbusiness:::application//index//data-source/ When resources.type equals - // AWS::QBusiness::Index , and the operator is set to Equals or NotEquals , the - // ARN must be in the following format: - // - arn::qbusiness:::application//index/ When resources.type equals - // AWS::QBusiness::WebExperience , and the operator is set to Equals or NotEquals - // , the ARN must be in the following format: - // - arn::qbusiness:::application//web-experience/ When resources.type equals - // AWS::RDS::DBCluster , and the operator is set to Equals or NotEquals , the ARN - // must be in the following format: - // - arn::rds:::cluster/ 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::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::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::SageMaker::Endpoint , - // and the operator is set to Equals or NotEquals , the ARN must be in the - // following format: - // - arn::sagemaker:::endpoint/ When resources.type equals - // AWS::SageMaker::ExperimentTrialComponent , and the operator is set to Equals + // + // - arn::greengrass:::components/ + // + // When resources.type equals AWS::GreengrassV2::Deployment , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::greengrass:::deployments/ + // + // When resources.type equals AWS::GuardDuty::Detector , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::guardduty:::detector/ + // + // When resources.type equals AWS::IoT::Certificate , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::iot:::cert/ + // + // When resources.type equals AWS::IoT::Thing , 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/ When resources.type equals - // AWS::SCN::Instance , and the operator is set to Equals or NotEquals , the ARN - // must be in the following format: - // - arn::scn:::instance/ When resources.type equals - // AWS::ServiceDiscovery::Namespace , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::servicediscovery:::namespace/ When resources.type equals - // AWS::ServiceDiscovery::Service , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: - // - arn::servicediscovery:::service/ When resources.type equals - // AWS::SNS::PlatformEndpoint , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::sns:::endpoint/// When resources.type equals AWS::SNS::Topic , and the + // + // - arn::iot:::thing/ + // + // When resources.type equals AWS::IoTSiteWise::Asset , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::iotsitewise:::asset/ + // + // When resources.type equals AWS::IoTSiteWise::TimeSeries , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::iotsitewise:::timeseries/ + // + // When resources.type equals AWS::IoTTwinMaker::Entity , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::iottwinmaker:::workspace//entity/ + // + // When resources.type equals AWS::IoTTwinMaker::Workspace , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::iottwinmaker:::workspace/ + // + // When resources.type equals AWS::KendraRanking::ExecutionPlan , and the operator + // is set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::kendra-ranking:::rescore-execution-plan/ + // + // When resources.type equals AWS::KinesisVideo::Stream , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::kinesisvideo:::stream// + // + // When resources.type equals AWS::ManagedBlockchain::Network , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::managedblockchain:::networks/ + // + // 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::MedicalImaging::Datastore , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::medical-imaging:::datastore/ + // + // When resources.type equals AWS::NeptuneGraph::Graph , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::neptune-graph:::graph/ + // + // When resources.type equals AWS::PCAConnectorAD::Connector , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::pca-connector-ad:::connector/ + // + // When resources.type equals AWS::QBusiness::Application , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::qbusiness:::application/ + // + // When resources.type equals AWS::QBusiness::DataSource , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::qbusiness:::application//index//data-source/ + // + // When resources.type equals AWS::QBusiness::Index , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::qbusiness:::application//index/ + // + // When resources.type equals AWS::QBusiness::WebExperience , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::qbusiness:::application//web-experience/ + // + // When resources.type equals AWS::RDS::DBCluster , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::rds:::cluster/ + // + // 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::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::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::SageMaker::Endpoint , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::sagemaker:::endpoint/ + // + // 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::sns::: When resources.type equals AWS::SWF::Domain , and the operator + // + // - 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/ + // + // When resources.type equals AWS::SCN::Instance , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::scn:::instance/ + // + // When resources.type equals AWS::ServiceDiscovery::Namespace , and the operator + // is set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::servicediscovery:::namespace/ + // + // When resources.type equals AWS::ServiceDiscovery::Service , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::servicediscovery:::service/ + // + // When resources.type equals AWS::SNS::PlatformEndpoint , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::sns:::endpoint/// + // + // When resources.type equals AWS::SNS::Topic , and the operator is set to Equals + // or NotEquals , the ARN must be in the following format: + // + // - arn::sns::: + // + // When resources.type equals AWS::SWF::Domain , and the operator is set to Equals + // or NotEquals , the ARN must be in the following format: + // + // - arn::swf:::domain/ + // + // When resources.type equals AWS::SQS::Queue , and the operator is set to Equals + // or NotEquals , the ARN must be in the following format: + // + // - arn::sqs::: + // + // When resources.type equals AWS::SSMMessages::ControlChannel , and the operator // is set to Equals or NotEquals , the ARN must be in the following format: - // - arn::swf:::domain/ When resources.type equals AWS::SQS::Queue , and the + // + // - arn::ssmmessages:::control-channel/ + // + // When resources.type equals AWS::ThinClient::Device , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::thinclient:::device/ + // + // When resources.type equals AWS::ThinClient::Environment , and the operator is + // set to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::thinclient:::environment/ + // + // When resources.type equals AWS::Timestream::Database , and the operator is set + // to Equals or NotEquals , the ARN must be in the following format: + // + // - arn::timestream:::database/ + // + // When resources.type equals AWS::Timestream::Table , and the operator is set to + // Equals or NotEquals , the ARN must be in the following format: + // + // - arn::timestream:::database//table/ + // + // When resources.type equals AWS::VerifiedPermissions::PolicyStore , and the // operator is set to Equals or NotEquals , the ARN must be in the following // format: - // - arn::sqs::: When resources.type equals AWS::SSMMessages::ControlChannel , - // and the operator is set to Equals or NotEquals , the ARN must be in the - // following format: - // - arn::ssmmessages:::control-channel/ When resources.type equals - // AWS::ThinClient::Device , and the operator is set to Equals or NotEquals , the - // ARN must be in the following format: - // - arn::thinclient:::device/ When resources.type equals - // AWS::ThinClient::Environment , and the operator is set to Equals or NotEquals - // , the ARN must be in the following format: - // - arn::thinclient:::environment/ When resources.type equals - // AWS::Timestream::Database , and the operator is set to Equals or NotEquals , - // the ARN must be in the following format: - // - arn::timestream:::database/ When resources.type equals - // AWS::Timestream::Table , and the operator is set to Equals or NotEquals , the - // ARN must be in the following format: - // - arn::timestream:::database//table/ When resources.type equals - // AWS::VerifiedPermissions::PolicyStore , and the operator is set to Equals or - // NotEquals , the ARN must be in the following format: + // // - arn::verifiedpermissions:::policy-store/ // // This member is required. @@ -327,20 +537,20 @@ type AdvancedFieldSelector struct { // 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. + // 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. Equals []string - // An operator that excludes events that match the last few characters of the + // 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 . + // An operator that excludes events that match the exact value of the event + // record field specified as the value of Field . NotEquals []string - // An operator that excludes events that match the first few characters of the + // An operator that excludes events that match the first few characters of the // event record field specified as the value of Field . NotStartsWith []string @@ -357,7 +567,7 @@ type Channel struct { // The Amazon Resource Name (ARN) of a channel. ChannelArn *string - // The name of the CloudTrail channel. For service-linked channels, the name is + // 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 created by the Amazon Web Services service. @@ -370,33 +580,44 @@ type Channel struct { // specify in your event selectors for your trail to log data events. Data events // provide information about the resource operations performed on or within a // resource itself. These are also known as data plane operations. You can specify -// up to 250 data resources for a trail. The total number of allowed data resources -// is 250. This number can be distributed between 1 and 5 event selectors, but the -// total cannot exceed 250 across all selectors for the trail. If you are using -// 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 -// empty prefix, and the option to log both Read and Write data events. +// up to 250 data resources for a trail. +// +// The total number of allowed data resources is 250. This number can be +// distributed between 1 and 5 event selectors, but the total cannot exceed 250 +// across all selectors for the trail. +// +// If you are using 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 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 -// . +// +// - 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 @@ -405,39 +626,52 @@ 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::DynamoDB::Table + // // - AWS::Lambda::Function + // // - AWS::S3::Object + // // Additional resource types are available through advanced event selectors. For - // more information about these additional resource types, see - // AdvancedFieldSelector (https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html) - // . + // more information about these additional resource types, see [AdvancedFieldSelector]. + // + // [AdvancedFieldSelector]: https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html 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. + // 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 + // 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 @@ -448,8 +682,8 @@ type DataResource struct { // Contains information about the destination receiving events. type Destination struct { - // For channels used for a CloudTrail Lake integration, the location is the ARN of - // an event data store that receives events from a channel. For service-linked + // For channels used for a CloudTrail Lake integration, the location is the ARN + // of an event data store that receives events from a channel. For service-linked // channels, the location is the name of the Amazon Web Services service. // // This member is required. @@ -504,8 +738,9 @@ 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. 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) -// . +// account. To select events for an event data store, use [advanced event selectors]. +// +// [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. @@ -568,19 +803,23 @@ type EventDataStore struct { // When an event occurs in your account, CloudTrail evaluates the event selector // for all trails. For each trail, if 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. You can configure up to five event -// selectors for a trail. You cannot apply both event selectors and advanced event -// selectors to a trail. +// selector, the trail doesn't log the event. +// +// You can configure up to five event selectors for a trail. +// +// You cannot apply both event selectors and advanced event selectors to a trail. type EventSelector struct { // CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, // and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 // 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) - // in the CloudTrail User Guide. + // does not apply if you configure resource logging for all data events. + // + // For more information, see [Data Events] and [Limits in CloudTrail] in the CloudTrail User Guide. + // + // [Data Events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html + // [Limits in CloudTrail]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html DataResources []DataResource // An optional list of service event sources from which you do not want management @@ -593,17 +832,25 @@ type EventSelector struct { 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 - // 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/) - // . + // trail. + // + // For more information, see [Management Events] 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]. + // + // [CloudTrail Pricing]: http://aws.amazon.com/cloudtrail/pricing/ + // [Management Events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html 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 @@ -612,19 +859,19 @@ type EventSelector struct { // Provides information about an import failure. type ImportFailureListItem struct { - // Provides the reason the import failed. + // Provides the reason the import failed. ErrorMessage *string - // The type of import error. + // The type of import error. ErrorType *string - // When the import was last updated. + // When the import was last updated. LastUpdatedTime *time.Time - // The location of the failure in the S3 bucket. + // The location of the failure in the S3 bucket. Location *string - // The status of the import. + // The status of the import. Status ImportFailureStatus noSmithyDocumentSerde @@ -633,19 +880,19 @@ type ImportFailureListItem struct { // Contains information about an import that was returned by a lookup request. type ImportsListItem struct { - // The timestamp of the import's creation. + // The timestamp of the import's creation. CreatedTimestamp *time.Time - // The ARN of the destination event data store. + // The ARN of the destination event data store. Destinations []string - // The ID of the import. + // The ID of the import. ImportId *string - // The status of the import. + // The status of the import. ImportStatus ImportStatus - // The timestamp of the import's last update. + // The timestamp of the import's last update. UpdatedTimestamp *time.Time noSmithyDocumentSerde @@ -654,7 +901,7 @@ type ImportsListItem struct { // The import source. type ImportSource struct { - // The source S3 bucket. + // The source S3 bucket. // // This member is required. S3 *S3ImportSource @@ -662,25 +909,26 @@ 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. type ImportStatistics struct { - // The number of trail events imported into the event data store. + // The number of trail events imported into the event data store. EventsCompleted *int64 - // The number of failed entries. + // The number of failed entries. FailedEntries *int64 // The number of log files that completed import. FilesCompleted *int64 - // The number of S3 prefixes that completed import. + // The number of S3 prefixes that completed import. PrefixesCompleted *int64 - // The number of S3 prefixes found for the import. + // The number of S3 prefixes found for the import. PrefixesFound *int64 noSmithyDocumentSerde @@ -714,11 +962,13 @@ type IngestionStatus struct { type InsightSelector struct { // The type of Insights events to log on a trail or event data store. - // ApiCallRateInsight and ApiErrorRateInsight are valid Insight types. The - // ApiCallRateInsight Insights type analyzes write-only management API calls that - // are aggregated per minute against a baseline API call volume. The - // ApiErrorRateInsight Insights type analyzes management API calls that result in - // error codes. The error is shown if the API call is unsuccessful. + // ApiCallRateInsight and ApiErrorRateInsight are valid Insight types. + // + // The ApiCallRateInsight Insights type analyzes write-only management API calls + // that are aggregated per minute against a baseline API call volume. + // + // The ApiErrorRateInsight Insights type analyzes management API calls that result + // in error codes. The error is shown if the API call is unsuccessful. InsightType InsightType noSmithyDocumentSerde @@ -732,9 +982,11 @@ type LookupAttribute struct { // This member is required. AttributeKey LookupAttributeKey - // Specifies a value for the specified AttributeKey . The maximum length for the - // AttributeValue is 2000 characters. The following characters (' _ ', ' ', ' , ', ' - // \\n ') count as two characters towards the 2000 character limit. + // Specifies a value for the specified AttributeKey . + // + // The maximum length for the AttributeValue is 2000 characters. The following + // characters (' _ ', ' ', ' , ', ' \\n ') count as two characters towards the 2000 + // character limit. // // This member is required. AttributeValue *string @@ -832,8 +1084,9 @@ 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]. + // + // [Filtering CloudTrail Events]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-console.html#filtering-cloudtrail-events ResourceType *string noSmithyDocumentSerde @@ -854,17 +1107,17 @@ type ResourceTag struct { // The settings for the source S3 bucket. type S3ImportSource struct { - // The IAM ARN role used to access the source S3 bucket. + // The IAM ARN role used to access the source S3 bucket. // // This member is required. S3BucketAccessRoleArn *string - // The Region associated with the source S3 bucket. + // The Region associated with the source S3 bucket. // // This member is required. S3BucketRegion *string - // The URI for the source S3 bucket. + // The URI for the source S3 bucket. // // This member is required. S3LocationUri *string @@ -875,10 +1128,10 @@ type S3ImportSource struct { // Contains configuration information about the channel. type SourceConfig struct { - // The advanced event selectors that are configured for the channel. + // The advanced event selectors that are configured for the channel. AdvancedEventSelectors []AdvancedEventSelector - // Specifies whether the channel applies to a single Region or to all Regions. + // Specifies whether the channel applies to a single Region or to all Regions. ApplyToAllRegions *bool noSmithyDocumentSerde @@ -934,30 +1187,34 @@ type Trail struct { // Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The // value is a fully specified ARN to a KMS key in the following format. - // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 + // + // arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 KmsKeyId *string // Specifies whether log file validation is enabled. LogFileValidationEnabled *bool - // Name of the trail set by calling CreateTrail . The maximum length is 128 - // characters. + // 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]. + // + // [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. + // have designated for log file delivery. For more information, see [Finding Your CloudTrail Log Files]. The maximum + // length is 200 characters. + // + // [Finding Your 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 // notifications when log files are delivered. The following is the format of a - // topic ARN. arn:aws:sns:us-east-2:123456789012:MyTopic + // topic ARN. + // + // arn:aws:sns:us-east-2:123456789012:MyTopic SnsTopicARN *string // This field is no longer in use. Use SnsTopicARN . @@ -966,7 +1223,8 @@ type Trail struct { SnsTopicName *string // Specifies the ARN of the trail. The following is the format of a trail ARN. - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail TrailARN *string noSmithyDocumentSerde diff --git a/service/cloudtraildata/options.go b/service/cloudtraildata/options.go index e483254413e..b3ae6e8a169 100644 --- a/service/cloudtraildata/options.go +++ b/service/cloudtraildata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudtraildata/types/types.go b/service/cloudtraildata/types/types.go index 0ce3ffafcd0..bacd2647c9d 100644 --- a/service/cloudtraildata/types/types.go +++ b/service/cloudtraildata/types/types.go @@ -23,8 +23,9 @@ type AuditEvent struct { // A checksum is a base64-SHA256 algorithm that helps you verify that CloudTrail // receives the event that matches with the checksum. Calculate the checksum by - // running a command like the following: printf %s $eventdata | openssl dgst - // -binary -sha256 | base64 + // running a command like the following: + // + // printf %s $eventdata | openssl dgst -binary -sha256 | base64 EventDataChecksum *string noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_DeleteAlarms.go b/service/cloudwatch/api_op_DeleteAlarms.go index d1f49051f27..02a5410683f 100644 --- a/service/cloudwatch/api_op_DeleteAlarms.go +++ b/service/cloudwatch/api_op_DeleteAlarms.go @@ -13,20 +13,27 @@ import ( // Deletes the specified alarms. You can delete up to 100 alarms in one operation. // However, this total can include no more than one composite alarm. For example, // you could delete 99 metric alarms and one composite alarms with one operation, -// 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 -// 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 -// still a composite alarm that depends on that alarm that you want 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 composite alarms -// stops if CloudWatch detects a cycle in the evaluation path. +// 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]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 still a composite alarm that +// depends on that alarm that you want 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 composite alarms stops if CloudWatch detects a +// cycle in the evaluation path. +// +// [DescribeAlarms]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html func (c *Client) DeleteAlarms(ctx context.Context, params *DeleteAlarmsInput, optFns ...func(*Options)) (*DeleteAlarmsOutput, error) { if params == nil { params = &DeleteAlarmsInput{} diff --git a/service/cloudwatch/api_op_DeleteAnomalyDetector.go b/service/cloudwatch/api_op_DeleteAnomalyDetector.go index c4f85fa0dfa..6ba912d3ccb 100644 --- a/service/cloudwatch/api_op_DeleteAnomalyDetector.go +++ b/service/cloudwatch/api_op_DeleteAnomalyDetector.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the CloudWatch User Guide. +// 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]in the +// CloudWatch User Guide. +// +// [Deleting an anomaly detection model]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model func (c *Client) DeleteAnomalyDetector(ctx context.Context, params *DeleteAnomalyDetectorInput, optFns ...func(*Options)) (*DeleteAnomalyDetectorOutput, error) { if params == nil { params = &DeleteAnomalyDetectorInput{} @@ -37,14 +39,21 @@ type DeleteAnomalyDetectorInput struct { // Deprecated: Use SingleMetricAnomalyDetector. Dimensions []types.Dimension - // The metric math anomaly detector to be deleted. When using - // MetricMathAnomalyDetector , you cannot include following parameters in the same - // operation: + // The metric math anomaly detector to be deleted. + // + // When using 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 // MetricMathAnomalyDetector property. MetricMathAnomalyDetector *types.MetricMathAnomalyDetector @@ -59,14 +68,21 @@ type DeleteAnomalyDetectorInput struct { // Deprecated: Use SingleMetricAnomalyDetector. Namespace *string - // A single metric anomaly detector to be deleted. When using - // SingleMetricAnomalyDetector , you cannot include the following parameters in the - // same operation: + // A single metric anomaly detector to be deleted. + // + // When using 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 // SingleMetricAnomalyDetector property. SingleMetricAnomalyDetector *types.SingleMetricAnomalyDetector diff --git a/service/cloudwatch/api_op_DeleteInsightRules.go b/service/cloudwatch/api_op_DeleteInsightRules.go index 3ce1c6af29f..bdc1218c827 100644 --- a/service/cloudwatch/api_op_DeleteInsightRules.go +++ b/service/cloudwatch/api_op_DeleteInsightRules.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Permanently deletes the specified Contributor Insights rules. 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. +// Permanently deletes the specified Contributor Insights rules. +// +// 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) DeleteInsightRules(ctx context.Context, params *DeleteInsightRulesInput, optFns ...func(*Options)) (*DeleteInsightRulesOutput, error) { if params == nil { params = &DeleteInsightRulesInput{} @@ -32,8 +33,9 @@ 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]. + // + // [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_DescribeAlarmHistory.go b/service/cloudwatch/api_op_DescribeAlarmHistory.go index 8e5b24fdbe1..f09afa3fffa 100644 --- a/service/cloudwatch/api_op_DescribeAlarmHistory.go +++ b/service/cloudwatch/api_op_DescribeAlarmHistory.go @@ -14,11 +14,13 @@ import ( // Retrieves the history for the specified alarm. You can filter the results by // date range or item type. If an alarm name is not specified, the histories for -// 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 -// can't return information about composite alarms if your +// 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 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) { if params == nil { diff --git a/service/cloudwatch/api_op_DescribeAlarms.go b/service/cloudwatch/api_op_DescribeAlarms.go index cea6fcad8f1..ef9f1313d53 100644 --- a/service/cloudwatch/api_op_DescribeAlarms.go +++ b/service/cloudwatch/api_op_DescribeAlarms.go @@ -17,11 +17,12 @@ 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 -// return information about composite alarms if your cloudwatch:DescribeAlarms -// permission has a narrower scope. +// 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 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) { if params == nil { params = &DescribeAlarmsInput{} @@ -45,8 +46,9 @@ type DescribeAlarmsInput struct { ActionPrefix *string // 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 . + // about all alarms that have names that start with this prefix. + // + // If this parameter is specified, you cannot specify AlarmNames . AlarmNamePrefix *string // The names of the alarms to retrieve information about. @@ -54,11 +56,14 @@ type DescribeAlarmsInput struct { // Use this parameter to specify whether you want the operation to return metric // alarms or composite alarms. If you omit this parameter, only metric alarms are - // returned, even if composite alarms exist in the account. For example, if you - // omit this parameter or specify MetricAlarms , the operation returns only a list - // of metric alarms. It does not return any composite alarms, even if composite - // alarms exist in the account. If you specify CompositeAlarms , the operation - // returns only a list of composite alarms, and does not return any metric alarms. + // returned, even if composite alarms exist in the account. + // + // For example, if you omit this parameter or specify MetricAlarms , the operation + // returns only a list of metric alarms. It does not return any composite alarms, + // even if composite alarms exist in the account. + // + // If you specify CompositeAlarms , the operation returns only a list of composite + // alarms, and does not return any metric alarms. AlarmTypes []types.AlarmType // If you use this parameter and specify the name of a composite alarm, the @@ -66,13 +71,17 @@ type DescribeAlarmsInput struct { // specify. These are the metric alarms and composite alarms referenced in the // 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. @@ -86,11 +95,14 @@ type DescribeAlarmsInput struct { // 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 - // 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 - // 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 + // 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 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 // parameter. ParentsOfAlarmName *string @@ -317,12 +329,13 @@ type AlarmExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAlarmsInput, *DescribeAlarmsOutput, error) (bool, error) } @@ -494,12 +507,13 @@ type CompositeAlarmExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAlarmsInput, *DescribeAlarmsOutput, error) (bool, error) } diff --git a/service/cloudwatch/api_op_DescribeAlarmsForMetric.go b/service/cloudwatch/api_op_DescribeAlarmsForMetric.go index 10f6a7891c3..5c697dbf829 100644 --- a/service/cloudwatch/api_op_DescribeAlarmsForMetric.go +++ b/service/cloudwatch/api_op_DescribeAlarmsForMetric.go @@ -12,10 +12,11 @@ import ( ) // Retrieves the alarms for the specified metric. To filter the results, specify a -// statistic, period, or unit. This operation retrieves only standard alarms that -// are based on the specified metric. It does not return alarms based on math -// expressions that use the specified metric, or composite alarms that use the -// specified metric. +// statistic, period, or unit. +// +// This operation retrieves only standard alarms that are based on the specified +// metric. It does not return alarms based on math expressions that use the +// specified metric, or composite alarms that use the specified metric. func (c *Client) DescribeAlarmsForMetric(ctx context.Context, params *DescribeAlarmsForMetricInput, optFns ...func(*Options)) (*DescribeAlarmsForMetricOutput, error) { if params == nil { params = &DescribeAlarmsForMetricInput{} diff --git a/service/cloudwatch/api_op_DescribeAnomalyDetectors.go b/service/cloudwatch/api_op_DescribeAnomalyDetectors.go index 2b7d514966a..7f266e41b7d 100644 --- a/service/cloudwatch/api_op_DescribeAnomalyDetectors.go +++ b/service/cloudwatch/api_op_DescribeAnomalyDetectors.go @@ -45,8 +45,10 @@ type DescribeAnomalyDetectorsInput struct { 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. + // 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 @@ -171,8 +173,10 @@ var _ DescribeAnomalyDetectorsAPIClient = (*Client)(nil) // 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. + // 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 b0956ebe2ad..405770f2f97 100644 --- a/service/cloudwatch/api_op_DescribeInsightRules.go +++ b/service/cloudwatch/api_op_DescribeInsightRules.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [Using Contributor Insights to 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 9de449e1ef8..0a476544cec 100644 --- a/service/cloudwatch/api_op_DisableInsightRules.go +++ b/service/cloudwatch/api_op_DisableInsightRules.go @@ -31,8 +31,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) - // . + // your rules, use [DescribeInsightRules]. + // + // [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 9e25e9f982f..a6a9741dac4 100644 --- a/service/cloudwatch/api_op_EnableInsightRules.go +++ b/service/cloudwatch/api_op_EnableInsightRules.go @@ -31,8 +31,9 @@ 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]. + // + // [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 d31711302ad..a6db1aec3cb 100644 --- a/service/cloudwatch/api_op_GetDashboard.go +++ b/service/cloudwatch/api_op_GetDashboard.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) GetDashboard(ctx context.Context, params *GetDashboardInput, optFns ...func(*Options)) (*GetDashboardOutput, error) { if params == nil { params = &GetDashboardInput{} @@ -46,8 +47,9 @@ 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]. + // + // [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 d7f4e8ff4bf..bff48b2e358 100644 --- a/service/cloudwatch/api_op_GetInsightRuleReport.go +++ b/service/cloudwatch/api_op_GetInsightRuleReport.go @@ -14,24 +14,35 @@ import ( // This operation returns the time series data collected by a Contributor Insights // 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: +// 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. +// +// 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{} @@ -80,20 +91,28 @@ 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 + // + // 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 diff --git a/service/cloudwatch/api_op_GetMetricData.go b/service/cloudwatch/api_op_GetMetricData.go index c1dc7d95fcd..0a3edcf48a0 100644 --- a/service/cloudwatch/api_op_GetMetricData.go +++ b/service/cloudwatch/api_op_GetMetricData.go @@ -14,31 +14,37 @@ import ( // You can use the GetMetricData API to retrieve CloudWatch metric values. The // operation can also include a CloudWatch Metrics Insights query, and one or more -// metric math functions. A GetMetricData operation that does not include a query -// can retrieve as many as 500 different metrics in a single request, with a total -// of as many as 100,800 data points. You can also optionally perform metric math -// 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) -// 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: +// metric math functions. +// +// A GetMetricData operation that does not include a query can retrieve as many as +// 500 different metrics in a single request, with a total of as many as 100,800 +// data points. You can also optionally perform metric math 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]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]. +// +// Calls to the GetMetricData API have a different pricing structure than calls to +// GetMetricStatistics . For more information about pricing, see [Amazon 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). // @@ -47,20 +53,28 @@ import ( // 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. +// 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. +// +// [Metric Math Syntax and Functions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax +// [Query your metrics with CloudWatch Metrics Insights]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html +// [Amazon CloudWatch Pricing]: https://aws.amazon.com/cloudwatch/pricing/ func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, optFns ...func(*Options)) (*GetMetricDataOutput, error) { if params == nil { params = &GetMetricDataInput{} @@ -78,13 +92,16 @@ 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 - // 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 . + // 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 . // // This member is required. EndTime *time.Time @@ -97,26 +114,35 @@ type GetMetricDataInput struct { // This member is required. MetricDataQueries []types.MetricDataQuery - // The time stamp indicating the earliest data to be returned. The value specified - // is inclusive; results include data points with the specified time stamp. + // 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 . + // 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 @@ -137,8 +163,9 @@ type GetMetricDataInput struct { // The order in which data points should be returned. TimestampDescending returns // the newest data first and paginates when the MaxDatapoints limit is reached. // TimestampAscending returns the oldest data first and paginates when the - // MaxDatapoints limit is reached. If you omit this parameter, the default of - // TimestampDescending is used. + // MaxDatapoints limit is reached. + // + // If you omit this parameter, the default of TimestampDescending is used. ScanBy types.ScanBy noSmithyDocumentSerde @@ -149,10 +176,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 - // 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. + // 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. 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 5ace4e4d187..eda1f096b16 100644 --- a/service/cloudwatch/api_op_GetMetricStatistics.go +++ b/service/cloudwatch/api_op_GetMetricStatistics.go @@ -12,31 +12,43 @@ import ( "time" ) -// Gets statistics for the specified metric. The maximum number of data points -// returned from a single call is 1,440. If you request more than 1,440 data -// points, CloudWatch returns an error. To reduce the number of data points, you -// can narrow the specified time range and make multiple requests across adjacent -// time ranges, or you can increase the specified period. Data points are not -// returned in chronological order. CloudWatch aggregates data points based on the -// length of the period that you specify. For example, if you request statistics -// with a one-hour period, CloudWatch aggregates all data points with time stamps -// that fall within each one-hour period. Therefore, the number of values -// aggregated by CloudWatch is larger than the number of data points returned. +// Gets statistics for the specified metric. +// +// The maximum number of data points returned from a single call is 1,440. If you +// request more than 1,440 data points, CloudWatch returns an error. To reduce the +// number of data points, you can narrow the specified time range and make multiple +// requests across adjacent time ranges, or you can increase the specified period. +// Data points are not returned in chronological order. +// +// CloudWatch aggregates data points based on the length of the period that you +// specify. For example, if you request statistics with a one-hour period, +// CloudWatch aggregates all data points with time stamps that fall within each +// one-hour period. Therefore, the number of values aggregated by CloudWatch is +// larger than the number of data points returned. +// // 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. // // Percentile statistics are not available for metrics when any of the metric -// values are negative numbers. Amazon CloudWatch retains metric data as follows: +// 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). // @@ -45,11 +57,14 @@ import ( // 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. +// 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]in the Amazon CloudWatch User Guide. +// +// [Amazon CloudWatch Metrics and Dimensions Reference]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html func (c *Client) GetMetricStatistics(ctx context.Context, params *GetMetricStatisticsInput, optFns ...func(*Options)) (*GetMetricStatisticsOutput, error) { if params == nil { params = &GetMetricStatisticsInput{} @@ -67,10 +82,11 @@ func (c *Client) GetMetricStatistics(ctx context.Context, params *GetMetricStati type GetMetricStatisticsInput struct { - // The time stamp that determines the last data point to return. The value - // specified is exclusive; results include data points up to the specified time - // stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for - // example, 2016-10-10T23:00:00Z). + // The time stamp that determines the last data point to return. + // + // The value specified is exclusive; results include data points up to the + // specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 + // UTC format (for example, 2016-10-10T23:00:00Z). // // This member is required. EndTime *time.Time @@ -90,13 +106,18 @@ type GetMetricStatisticsInput 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 call - // 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: + // 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). // @@ -104,17 +125,23 @@ type GetMetricStatisticsInput struct { Period *int32 // The time stamp that determines the first data point to return. Start times are - // evaluated relative to the time that CloudWatch receives the request. The value - // specified is inclusive; results include data points with the specified time - // 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: + // evaluated relative to the time that CloudWatch receives the request. + // + // The value specified is inclusive; results include data points with the + // specified time 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 @@ -130,11 +157,12 @@ type GetMetricStatisticsInput struct { // value for each dimension. CloudWatch treats each unique combination of // 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) - // 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) - // in the Amazon CloudWatch User Guide. + // dimensions that were used when the metrics were created. For an example, see [Dimension Combinations]in + // the Amazon CloudWatch User Guide. For more information about specifying + // dimensions, see [Publishing Metrics]in the Amazon CloudWatch User Guide. + // + // [Dimension Combinations]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations + // [Publishing Metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html Dimensions []types.Dimension // The percentile statistics. Specify values between p0.0 and p100. When calling diff --git a/service/cloudwatch/api_op_GetMetricStream.go b/service/cloudwatch/api_op_GetMetricStream.go index 84e4dfaeb40..acd5c88c8ba 100644 --- a/service/cloudwatch/api_op_GetMetricStream.go +++ b/service/cloudwatch/api_op_GetMetricStream.go @@ -72,9 +72,10 @@ type GetMetricStreamOutput struct { Name *string // The output format for the stream. Valid values are json , opentelemetry1.0 , 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) + // opentelemetry0.7 . For more information about metric stream output formats, see [Metric streams output formats] // . + // + // [Metric streams 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. @@ -85,8 +86,9 @@ type GetMetricStreamOutput struct { // 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]. + // + // [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 ff8376956b0..300a89f844b 100644 --- a/service/cloudwatch/api_op_GetMetricWidgetImage.go +++ b/service/cloudwatch/api_op_GetMetricWidgetImage.go @@ -14,11 +14,16 @@ import ( // more Amazon CloudWatch metrics as a bitmap image. You can then embed this image // into your services and products, such as wiki pages, reports, and documents. You // could also retrieve images regularly, such as every minute, and create your own -// custom live dashboard. The graph you retrieve can include all CloudWatch metric -// graph features, including metric math and horizontal and vertical annotations. +// custom live dashboard. +// +// The graph you retrieve can include all CloudWatch metric 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. func (c *Client) GetMetricWidgetImage(ctx context.Context, params *GetMetricWidgetImageInput, optFns ...func(*Options)) (*GetMetricWidgetImageOutput, error) { if params == nil { @@ -40,18 +45,25 @@ 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 - // 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 + // GetMetricWidgetImage call. + // + // For more information about the syntax of MetricWidget see [GetMetricWidgetImage: Metric Widget Structure and Syntax]. + // + // 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. // + // [GetMetricWidgetImage: Metric Widget Structure and Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html + // // 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... // diff --git a/service/cloudwatch/api_op_ListDashboards.go b/service/cloudwatch/api_op_ListDashboards.go index 89679e6eca5..b9514a45a9e 100644 --- a/service/cloudwatch/api_op_ListDashboards.go +++ b/service/cloudwatch/api_op_ListDashboards.go @@ -13,10 +13,11 @@ import ( // Returns a list of the dashboards for your account. If you include // 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 -// NextToken in the first call, to receive the next 1000 results. +// 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 NextToken in the first call, to receive the next 1000 results. func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error) { if params == nil { params = &ListDashboardsInput{} diff --git a/service/cloudwatch/api_op_ListManagedInsightRules.go b/service/cloudwatch/api_op_ListManagedInsightRules.go index 7c659a0448e..aadb90e8c8c 100644 --- a/service/cloudwatch/api_op_ListManagedInsightRules.go +++ b/service/cloudwatch/api_op_ListManagedInsightRules.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list that contains the number of managed Contributor Insights rules +// 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 { @@ -30,17 +31,17 @@ func (c *Client) ListManagedInsightRules(ctx context.Context, params *ListManage type ListManagedInsightRulesInput struct { - // The ARN of an Amazon Web Services resource that has managed Contributor + // 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 + // 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 . MaxResults *int32 - // Include this value to get the next set of rules if the value was returned by + // Include this value to get the next set of rules if the value was returned by // the previous operation. NextToken *string @@ -49,11 +50,11 @@ type ListManagedInsightRulesInput struct { type ListManagedInsightRulesOutput struct { - // The managed rules that are available for the specified Amazon Web Services + // The managed rules that are available for the specified Amazon Web Services // resource. ManagedRules []types.ManagedRuleDescription - // Include this value to get the next set of rules if the value was returned by + // Include this value to get the next set of rules if the value was returned by // the previous operation. NextToken *string @@ -153,7 +154,7 @@ var _ ListManagedInsightRulesAPIClient = (*Client)(nil) // ListManagedInsightRulesPaginatorOptions is the paginator options for // ListManagedInsightRules type ListManagedInsightRulesPaginatorOptions struct { - // The maximum number of results to return in one operation. If you omit this + // 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 . Limit int32 diff --git a/service/cloudwatch/api_op_ListMetrics.go b/service/cloudwatch/api_op_ListMetrics.go index d4e4febbae1..c85394f8957 100644 --- a/service/cloudwatch/api_op_ListMetrics.go +++ b/service/cloudwatch/api_op_ListMetrics.go @@ -11,21 +11,25 @@ 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) -// 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 +// List the specified metrics. You can use the returned metrics with [GetMetricData] or [GetMetricStatistics] 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]or [GetMetricStatistics]. +// +// 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 -// 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) -// . +// accounts. For more information, see [CloudWatch cross-account observability]. +// +// 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]or [GetMetricStatistics]. +// +// [GetMetricData]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html +// [GetMetricStatistics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html +// [CloudWatch cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html func (c *Client) ListMetrics(ctx context.Context, params *ListMetricsInput, optFns ...func(*Options)) (*ListMetricsOutput, error) { if params == nil { params = &ListMetricsInput{} @@ -48,7 +52,9 @@ type ListMetricsInput struct { 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 . + // 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 @@ -70,10 +76,11 @@ type ListMetricsInput struct { // 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 - // 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 - // more than the specified time interval. + // 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 more than the specified time interval. RecentlyActive types.RecentlyActive noSmithyDocumentSerde @@ -89,8 +96,10 @@ type ListMetricsOutput struct { // 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. + // 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 a675576a1bc..76f87a6a7e4 100644 --- a/service/cloudwatch/api_op_ListTagsForResource.go +++ b/service/cloudwatch/api_op_ListTagsForResource.go @@ -30,12 +30,18 @@ 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 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) - // in the Amazon Web Services General Reference. + // arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name + // + // For more information about ARN format, see [Resource Types Defined by Amazon CloudWatch] in the Amazon Web Services General + // Reference. + // + // [Resource Types Defined by Amazon CloudWatch]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies // // This member is required. ResourceARN *string diff --git a/service/cloudwatch/api_op_PutAnomalyDetector.go b/service/cloudwatch/api_op_PutAnomalyDetector.go index 4afd4b531b9..7126a35381c 100644 --- a/service/cloudwatch/api_op_PutAnomalyDetector.go +++ b/service/cloudwatch/api_op_PutAnomalyDetector.go @@ -12,13 +12,16 @@ 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. If -// you have enabled unified cross-account observability, and this account is a +// model to display a band of expected normal values when the metric is graphed. +// +// If you have enabled unified cross-account observability, and this account is a // monitoring account, the metric can be in the same account or a source account. // You can specify the account ID in the object you specify in the -// SingleMetricAnomalyDetector parameter. For more information, see CloudWatch -// Anomaly Detection (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) -// . +// SingleMetricAnomalyDetector parameter. +// +// For more information, see [CloudWatch Anomaly Detection]. +// +// [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{} @@ -38,8 +41,9 @@ type PutAnomalyDetectorInput struct { // The configuration specifies details about how the anomaly detection model is to // be trained, including time ranges to exclude when training and updating the - // model. You can specify as many as 10 time ranges. The configuration can also - // include the time zone to use for the metric. + // model. You can specify as many as 10 time ranges. + // + // The configuration can also include the time zone to use for the metric. Configuration *types.AnomalyDetectorConfiguration // The metric dimensions to create the anomaly detection model for. @@ -52,14 +56,21 @@ type PutAnomalyDetectorInput struct { // Currently, it includes the PeriodicSpikes parameter. MetricCharacteristics *types.MetricCharacteristics - // The metric math anomaly detector to be created. When using - // MetricMathAnomalyDetector , you cannot include the following parameters in the - // same operation: + // The metric math anomaly detector to be created. + // + // When using 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 . MetricMathAnomalyDetector *types.MetricMathAnomalyDetector @@ -74,14 +85,21 @@ type PutAnomalyDetectorInput struct { // Deprecated: Use SingleMetricAnomalyDetector. Namespace *string - // A single metric anomaly detector to be created. When using - // SingleMetricAnomalyDetector , you cannot include the following parameters in the - // same operation: + // A single metric anomaly detector to be created. + // + // When using SingleMetricAnomalyDetector , you cannot include the following + // parameters in the same operation: + // // - Dimensions + // // - MetricName + // // - Namespace + // // - Stat + // // - the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput + // // Instead, specify the single metric anomaly detector attributes as part of the // property SingleMetricAnomalyDetector . SingleMetricAnomalyDetector *types.SingleMetricAnomalyDetector diff --git a/service/cloudwatch/api_op_PutCompositeAlarm.go b/service/cloudwatch/api_op_PutCompositeAlarm.go index 8d97adaeece..840750555cd 100644 --- a/service/cloudwatch/api_op_PutCompositeAlarm.go +++ b/service/cloudwatch/api_op_PutCompositeAlarm.go @@ -14,42 +14,59 @@ import ( // Creates or updates a composite alarm. When you create a composite alarm, you // specify a rule expression for the alarm that takes into account the alarm states // of other alarms that you have created. The composite alarm goes into ALARM state -// only if all conditions of the rule are met. The alarms specified in a composite -// alarm's rule expression can include metric alarms and other composite alarms. -// The rule expression of a composite alarm can include as many as 100 underlying -// alarms. Any single alarm can be included in the rule expressions of as many as -// 150 composite alarms. Using composite alarms can reduce alarm noise. You can -// create multiple metric alarms, and also create a composite alarm and set up -// alerts only for the composite alarm. For example, you could create a composite -// alarm that goes into ALARM state only when more than one of the underlying -// metric alarms are in ALARM state. Composite alarms can take the following -// actions: +// only if all conditions of the rule are met. +// +// The alarms specified in a composite alarm's rule expression can include metric +// alarms and other composite alarms. The rule expression of a composite alarm can +// include as many as 100 underlying alarms. Any single alarm can be included in +// the rule expressions of as many as 150 composite alarms. +// +// Using composite alarms can reduce alarm noise. You can create multiple metric +// alarms, and also create a composite alarm and set up alerts only for the +// composite alarm. For example, you could create a composite alarm that goes into +// ALARM state only when more than one of the underlying metric alarms are in ALARM +// state. +// +// Composite alarms can take the following actions: +// // - Notify Amazon SNS topics. +// // - Invoke Lambda functions. +// // - Create OpsItems in Systems Manager Ops Center. +// // - Create incidents in Systems Manager Incident Manager. // // 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 still a composite alarm that -// depends on that alarm that you want 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 . +// depends on that alarm that you want 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 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 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 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 OpsItem actions. +// 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 +// 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 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 OpsItem actions. func (c *Client) PutCompositeAlarm(ctx context.Context, params *PutCompositeAlarmInput, optFns ...func(*Options)) (*PutCompositeAlarmOutput, error) { if params == nil { params = &PutCompositeAlarmInput{} @@ -77,33 +94,49 @@ type PutCompositeAlarmInput struct { // 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: + // 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 : + // 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. @@ -115,33 +148,48 @@ type PutCompositeAlarmInput struct { // state of the composite alarm. The default is TRUE . ActionsEnabled *bool - // Actions will be suppressed if the suppressor alarm is in the ALARM state. + // Actions will be suppressed if the suppressor alarm is in the ALARM state. // ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an // existing alarm. ActionsSuppressor *string - // The maximum time in seconds that the composite alarm waits after suppressor + // 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. + // 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 + // The maximum time in seconds that the composite alarm waits for the suppressor // alarm to go into the ALARM state. After this time, the composite alarm performs - // its actions. WaitPeriod is required only when ActionsSuppressor is specified. + // its actions. + // + // WaitPeriod is required only when ActionsSuppressor is specified. ActionsSuppressorWaitPeriod *int32 // 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: ] Amazon SNS actions: arn:aws:sns:region:account-id:sns-topic-name + // other state. Each action is specified as an Amazon Resource Name (ARN). + // + // Valid Values: ] + // + // Amazon SNS actions: + // + // arn:aws:sns:region:account-id:sns-topic-name + // // Lambda actions: + // // - Invoke the latest version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name + // // - Invoke a specific version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name:version-number + // // - Invoke a function by using an alias Lambda function: // arn:aws:lambda:region:account-id:function:function-name:alias-name - // Systems Manager actions: arn:aws:ssm:region:account-id:opsitem:severity + // + // Systems Manager actions: + // + // arn:aws:ssm:region:account-id:opsitem:severity AlarmActions []string // The description for the composite alarm. @@ -149,38 +197,61 @@ type PutCompositeAlarmInput struct { // 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: ] Amazon SNS actions: - // arn:aws:sns:region:account-id:sns-topic-name Lambda actions: + // (ARN). + // + // Valid Values: ] + // + // Amazon SNS actions: + // + // arn:aws:sns:region:account-id:sns-topic-name + // + // Lambda actions: + // // - Invoke the latest version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name + // // - Invoke a specific version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name:version-number + // // - Invoke a function by using an alias Lambda function: // arn:aws:lambda:region:account-id:function:function-name:alias-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: ] Amazon SNS actions: arn:aws:sns:region:account-id:sns-topic-name + // other state. Each action is specified as an Amazon Resource Name (ARN). + // + // Valid Values: ] + // + // Amazon SNS actions: + // + // arn:aws:sns:region:account-id:sns-topic-name + // // Lambda actions: + // // - Invoke the latest version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name + // // - Invoke a specific version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name:version-number + // // - Invoke a function by using an alias Lambda function: // arn:aws:lambda:region:account-id:function:function-name:alias-name OKActions []string // A list of key-value pairs to associate with the alarm. You can associate as // many as 50 tags with an alarm. To be able to associate tags with the alarm when - // you create the alarm, you must have the cloudwatch:TagResource permission. 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) - // . + // you create the alarm, you must have the cloudwatch:TagResource permission. + // + // 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]or [UntagResource]. + // + // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_PutDashboard.go b/service/cloudwatch/api_op_PutDashboard.go index dc0ad9620e8..3b51a634239 100644 --- a/service/cloudwatch/api_op_PutDashboard.go +++ b/service/cloudwatch/api_op_PutDashboard.go @@ -13,13 +13,17 @@ import ( // Creates a dashboard if it does not already exist, or updates an existing // dashboard. If you update a dashboard, the entire contents are replaced with what -// you specify here. All dashboards in your account are global, not -// region-specific. A simple way to create a dashboard using PutDashboard is to -// 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 . +// you specify here. +// +// All dashboards in your account are global, not region-specific. +// +// A simple way to create a dashboard using PutDashboard is to 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 // 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 @@ -44,9 +48,11 @@ 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) - // . + // required. + // + // For more information about the syntax, see [Dashboard Body Structure and Syntax]. + // + // [Dashboard Body Structure and Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html // // This member is required. DashboardBody *string @@ -65,10 +71,14 @@ type PutDashboardInput struct { type PutDashboardOutput struct { // If the input for PutDashboard was correct and the dashboard was successfully - // created or modified, this result is empty. If this result includes only warning - // messages, then the input was valid enough for the dashboard to be created or - // modified, but some elements of the dashboard might not render. If this result - // includes error messages, the input was not valid and the operation failed. + // created or modified, this result is empty. + // + // If this result includes only warning messages, then the input was valid enough + // for the dashboard to be created or modified, but some elements of the dashboard + // might not render. + // + // If this result includes error messages, the input was not valid and the + // operation failed. DashboardValidationMessages []types.DashboardValidationMessage // Metadata pertaining to the operation's result. diff --git a/service/cloudwatch/api_op_PutInsightRule.go b/service/cloudwatch/api_op_PutInsightRule.go index 2f585c67b60..ddaede8794d 100644 --- a/service/cloudwatch/api_op_PutInsightRule.go +++ b/service/cloudwatch/api_op_PutInsightRule.go @@ -13,10 +13,12 @@ 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, +// log group. For more information, see [Using Contributor Insights to Analyze High-Cardinality Data]. +// +// 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. +// +// [Using Contributor Insights to Analyze High-Cardinality Data]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html func (c *Client) PutInsightRule(ctx context.Context, params *PutInsightRuleInput, optFns ...func(*Options)) (*PutInsightRuleOutput, error) { if params == nil { params = &PutInsightRuleInput{} @@ -35,8 +37,9 @@ 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]. + // + // [Contributor Insights Rule Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html // // This member is required. RuleDefinition *string @@ -50,15 +53,21 @@ type PutInsightRuleInput struct { RuleState *string // A list of key-value pairs to associate with the Contributor Insights rule. You - // can associate as many as 50 tags with a 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 the resources that have - // certain tag values. To be able to associate tags with a rule, you must have the + // can associate as many as 50 tags with a 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 the resources that have certain tag values. + // + // To be able to associate tags with a rule, you must have the // 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) - // . + // 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]. + // + // [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 f664daf8ae3..0956b07f9d6 100644 --- a/service/cloudwatch/api_op_PutManagedInsightRules.go +++ b/service/cloudwatch/api_op_PutManagedInsightRules.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) PutManagedInsightRules(ctx context.Context, params *PutManagedInsightRulesInput, optFns ...func(*Options)) (*PutManagedInsightRulesOutput, error) { if params == nil { params = &PutManagedInsightRulesInput{} @@ -36,7 +37,7 @@ func (c *Client) PutManagedInsightRules(ctx context.Context, params *PutManagedI type PutManagedInsightRulesInput struct { - // A list of ManagedRules to enable. + // A list of ManagedRules to enable. // // This member is required. ManagedRules []types.ManagedRule @@ -46,7 +47,7 @@ type PutManagedInsightRulesInput struct { type PutManagedInsightRulesOutput struct { - // An array that lists the rules that could not be enabled. + // An array that lists the rules that could not be enabled. Failures []types.PartialFailure // Metadata pertaining to the operation's result. diff --git a/service/cloudwatch/api_op_PutMetricAlarm.go b/service/cloudwatch/api_op_PutMetricAlarm.go index c16d0f0463e..7226c522ecc 100644 --- a/service/cloudwatch/api_op_PutMetricAlarm.go +++ b/service/cloudwatch/api_op_PutMetricAlarm.go @@ -13,16 +13,22 @@ 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. +// information about using a Metrics Insights query for an alarm, see [Create alarms on Metrics Insights queries]. +// +// 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: +// 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. // @@ -30,24 +36,31 @@ import ( // 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) -// . Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB. -// 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: +// AWSServiceRoleForCloudWatchAlarms_ActionSSM . For more information, see [Amazon Web Services service-linked role]. +// +// Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB. +// +// # 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. +// a sharing account in [Cross-account cross-Region CloudWatch console]. 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) -// . +// account in [Cross-account cross-Region CloudWatch console]. +// +// [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 +// [Create alarms on Metrics Insights queries]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html +// [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{} @@ -65,17 +78,20 @@ func (c *Client) PutMetricAlarm(ctx context.Context, params *PutMetricAlarmInput type PutMetricAlarmInput struct { - // The name for the alarm. This name must be unique within the Region. The name - // must contain only UTF-8 characters, and can't contain ASCII control characters + // The name for the alarm. This name must be unique within the Region. + // + // The name must contain only UTF-8 characters, and can't contain ASCII control + // characters // // This member is required. AlarmName *string - // 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 - // GreaterThanUpperThreshold are used only for alarms based on anomaly detection - // models. + // 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 GreaterThanUpperThreshold are used only for alarms based on anomaly + // detection models. // // This member is required. ComparisonOperator types.ComparisonOperator @@ -83,9 +99,10 @@ type PutMetricAlarmInput struct { // 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. + // 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 @@ -96,31 +113,51 @@ type PutMetricAlarmInput struct { // 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: + // 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 // // Lambda actions: + // // - Invoke the latest version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name + // // - Invoke a specific version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name:version-number + // // - Invoke a function by using an alias Lambda function: // arn:aws:lambda:region:account-id:function:function-name:alias-name + // // SNS notification action: + // // - arn:aws:sns:region:account-id:sns-topic-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 @@ -129,91 +166,134 @@ 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) - // in the Amazon CloudWatch User Guide. + // the M. For more information, see [Evaluating an Alarm]in the Amazon CloudWatch User Guide. + // + // [Evaluating an Alarm]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation DatapointsToAlarm *int32 // 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 + // points are available. For more information, see [Percentile-Based CloudWatch Alarms and Low Data Samples]. + // + // Valid Values: evaluate | ignore + // + // [Percentile-Based CloudWatch Alarms and Low Data Samples]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples EvaluateLowSampleCountPercentile *string // The extended statistic for the metric specified in MetricName . When you call // PutMetricAlarm and specify a MetricName , you must specify either Statistic or - // ExtendedStatistic but not both. If you specify ExtendedStatistic , the following - // are valid values: + // ExtendedStatistic but not both. + // + // If you specify ExtendedStatistic , the following are valid values: + // // - p90 + // // - tm90 + // // - tc90 + // // - ts90 + // // - wm90 + // // - IQM + // // - PR(n:m) where n and m are values of the metric + // // - TC(X%:X%) where X is between 10 and 90 inclusive. + // // - TM(X%:X%) where X is between 10 and 90 inclusive. + // // - TS(X%:X%) where X is between 10 and 90 inclusive. + // // - WM(X%:X%) where X is between 10 and 90 inclusive. - // For more information about these extended statistics, see CloudWatch statistics - // definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html) - // . + // + // For more information about these extended statistics, see [CloudWatch statistics definitions]. + // + // [CloudWatch statistics definitions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html 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). 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 // // Lambda actions: + // // - Invoke the latest version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name + // // - Invoke a specific version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name:version-number + // // - Invoke a function by using an alias Lambda function: // arn:aws:lambda:region:account-id:function:function-name:alias-name + // // SNS notification action: + // // - arn:aws:sns:region:account-id:sns-topic-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 Namespace , Dimensions , Period , Unit , Statistic , or - // ExtendedStatistic parameters. Instead, you specify all this information in the - // Metrics array. + // 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 Namespace , Dimensions , Period , Unit , Statistic + // , or ExtendedStatistic parameters. Instead, you specify all this information in + // the Metrics array. MetricName *string // An array of MetricDataQuery structures that enable you to create an alarm based // on the result of a metric math expression. For each PutMetricAlarm operation, - // you must specify either MetricName or a Metrics array. Each item in the Metrics - // 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 Namespace , - // MetricName , Dimensions , Period , Unit , 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. + // you must specify either MetricName or a Metrics array. + // + // Each item in the Metrics 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]. + // + // If you use the Metrics parameter, you cannot include the Namespace , MetricName + // , Dimensions , Period , Unit , 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. + // + // [MetricDataQuery]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html Metrics []types.MetricDataQuery // The namespace for the metric associated specified in MetricName . @@ -221,49 +301,74 @@ type PutMetricAlarmInput struct { // 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: + // 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 // // Lambda actions: + // // - Invoke the latest version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name + // // - Invoke a specific version of a Lambda function: // arn:aws:lambda:region:account-id:function:function-name:version-number + // // - Invoke a function by using an alias Lambda function: // arn:aws:lambda:region:account-id:function:function-name:alias-name + // // SNS notification action: + // // - arn:aws:sns:region:account-id:sns-topic-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 - // evaluated. Valid values are 10, 30, and any multiple of 60. Period is required - // 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 - // 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 + // evaluated. Valid values are 10, 30, and any multiple of 60. + // + // Period is required 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 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]. + // + // 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. + // + // [Amazon CloudWatch Pricing]: https://aws.amazon.com/cloudwatch/pricing/ Period *int32 // The statistic for the metric specified in MetricName , other than percentile. @@ -274,35 +379,46 @@ type PutMetricAlarmInput struct { // A list of key-value pairs to associate with the alarm. You can associate as // many as 50 tags with an alarm. To be able to associate tags with the alarm when - // you create the alarm, you must have the cloudwatch:TagResource permission. 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) - // . + // you create the alarm, you must have the cloudwatch:TagResource permission. + // + // 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]or [UntagResource]. + // + // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html + // [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 - // required for alarms based on static thresholds, but should not be used for - // alarms based on anomaly detection models. + // The value against which the specified statistic is compared. + // + // This parameter is required for alarms based on static thresholds, but should + // not be used for alarms based on anomaly detection models. 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. + // 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]. + // + // 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 TreatMissingData *string // The unit of measure for the statistic. For example, the units for the Amazon @@ -312,14 +428,19 @@ type PutMetricAlarmInput struct { // Metric data points that specify a unit of measure, such as Percent, are // aggregated separately. If you are creating an alarm based on a metric math // expression, you can specify the unit for each metric (if needed) within the - // objects in the Metrics array. 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 you don't specify a unit, the alarm's behavior is not defined and it behaves - // unpredictably. We recommend omitting Unit so that you don't inadvertently - // specify an incorrect unit that is not published for this metric. Doing so causes - // the alarm to be stuck in the INSUFFICIENT DATA state. + // objects in the Metrics array. + // + // 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 you don't + // specify a unit, the alarm's behavior is not defined and it behaves + // unpredictably. + // + // We recommend omitting Unit so that you don't inadvertently specify an incorrect + // unit that is not published for this metric. Doing so causes the alarm to be + // stuck in the INSUFFICIENT DATA state. Unit types.StandardUnit noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_PutMetricData.go b/service/cloudwatch/api_op_PutMetricData.go index e8fe999300d..a07d987a2cf 100644 --- a/service/cloudwatch/api_op_PutMetricData.go +++ b/service/cloudwatch/api_op_PutMetricData.go @@ -15,37 +15,52 @@ 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]. +// +// 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 MetricData 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 -// 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) -// 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. +// +// 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 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]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) -// 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 to become available for [GetMetricData]or [GetMetricStatistics] 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]or [GetMetricStatistics]. +// +// 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 // . +// +// [GetMetricData]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html +// [GetMetricStatistics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html +// [ListMetrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html +// [Publishing Metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html func (c *Client) PutMetricData(ctx context.Context, params *PutMetricDataInput, optFns ...func(*Options)) (*PutMetricDataOutput, error) { if params == nil { params = &PutMetricDataInput{} @@ -70,9 +85,10 @@ type PutMetricDataInput struct { MetricData []types.MetricDatum // The namespace for the metric data. You can use ASCII characters for the - // namespace, except for control characters which are not supported. To avoid - // conflicts with Amazon Web Services service namespaces, you should not specify a - // namespace that begins with AWS/ + // namespace, except for control characters which are not supported. + // + // To avoid conflicts with Amazon Web Services service namespaces, you should not + // specify a namespace that begins with AWS/ // // This member is required. Namespace *string diff --git a/service/cloudwatch/api_op_PutMetricStream.go b/service/cloudwatch/api_op_PutMetricStream.go index d1b6264420c..ad56b7e4fd0 100644 --- a/service/cloudwatch/api_op_PutMetricStream.go +++ b/service/cloudwatch/api_op_PutMetricStream.go @@ -13,14 +13,21 @@ 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]. +// +// 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: +// 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 . // @@ -28,14 +35,19 @@ import ( // 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 +// costs. For more information, see [Amazon 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) -// . +// 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]. +// +// [Using Metric Streams]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html +// [CloudWatch cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html +// [Amazon CloudWatch Pricing]: https://aws.amazon.com/cloudwatch/pricing/ func (c *Client) PutMetricStream(ctx context.Context, params *PutMetricStreamInput, optFns ...func(*Options)) (*PutMetricStreamOutput, error) { if params == nil { params = &PutMetricStreamInput{} @@ -62,17 +74,21 @@ type PutMetricStreamInput struct { // If you are creating a new metric stream, this is the name for the new stream. // The name must be different than the names of other metric streams in this - // account and Region. If you are updating a metric stream, specify the name of - // that stream here. Valid characters are A-Z, a-z, 0-9, "-" and "_". + // account and Region. + // + // If you are updating a metric stream, specify the name of that stream here. + // + // Valid characters are A-Z, a-z, 0-9, "-" and "_". // // This member is required. Name *string // The output format for the stream. Valid values are json , opentelemetry1.0 , 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) + // opentelemetry0.7 . For more information about metric stream output formats, see [Metric streams output formats] // . // + // [Metric streams output formats]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html + // // This member is required. OutputFormat types.MetricStreamOutputFormat @@ -80,20 +96,24 @@ type PutMetricStreamInput struct { // 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 // // This member is required. RoleArn *string // If you specify this parameter, the stream sends metrics from all metric - // namespaces except for the namespaces that you specify here. You cannot include - // ExcludeFilters and IncludeFilters in the same operation. + // namespaces except for the namespaces that you specify here. + // + // You cannot include 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 - // ExcludeFilters in the same operation. + // metric namespaces that you specify here. + // + // You cannot include IncludeFilters and ExcludeFilters in the same operation. IncludeFilters []types.MetricStreamFilter // If you are creating a metric stream in a monitoring account, specify true to @@ -103,25 +123,33 @@ type PutMetricStreamInput struct { // 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 opentelemetry1.0 or opentelemetry0.7 , you can stream - // percentile statistics such as p95, p99.9, and so on. + // 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]. If the OutputFormat is opentelemetry1.0 or + // opentelemetry0.7 , you can stream percentile statistics such as p95, p99.9, and + // so on. + // + // [CloudWatch statistics definitions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html 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 - // 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) - // . + // 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]or [UntagResource]. + // + // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html + // [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 cf3a2942451..d678700ab90 100644 --- a/service/cloudwatch/api_op_SetAlarmState.go +++ b/service/cloudwatch/api_op_SetAlarmState.go @@ -15,16 +15,22 @@ import ( // state differs from the previous value, the action configured for the appropriate // state is invoked. For example, if your alarm is configured to send an Amazon SNS // message when an alarm is triggered, temporarily changing the alarm state to -// 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 +// 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]. +// +// 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 -// application Auto Scaling policies, you must include information in the -// StateReasonData parameter to enable the policy to take the correct action. +// update its configuration. +// +// If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling +// policies, you must include information in the StateReasonData parameter to +// enable the policy to take the correct action. +// +// [DescribeAlarmHistory]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html func (c *Client) SetAlarmState(ctx context.Context, params *SetAlarmStateInput, optFns ...func(*Options)) (*SetAlarmStateOutput, error) { if params == nil { params = &SetAlarmStateInput{} @@ -57,10 +63,11 @@ type SetAlarmStateInput struct { // This member is required. StateValue types.StateValue - // The reason that this alarm is set to this specific state, in JSON format. For - // SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling - // or application Auto Scaling alarm actions, the Auto Scaling policy uses the - // information in this field to take the correct action. + // The reason that this alarm is set to this specific state, in JSON format. + // + // For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto + // Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses + // the information in this field to take the correct action. StateReasonData *string noSmithyDocumentSerde diff --git a/service/cloudwatch/api_op_StartMetricStreams.go b/service/cloudwatch/api_op_StartMetricStreams.go index 176974958f7..2248e7ea0e7 100644 --- a/service/cloudwatch/api_op_StartMetricStreams.go +++ b/service/cloudwatch/api_op_StartMetricStreams.go @@ -28,10 +28,11 @@ func (c *Client) StartMetricStreams(ctx context.Context, params *StartMetricStre type StartMetricStreamsInput struct { - // The array of the names of metric streams to start streaming. This is an "all or - // nothing" operation. If you do not have permission to access all of the metric - // streams that you list here, then none of the streams that you list in the - // operation will start streaming. + // The array of the names of metric streams to start streaming. + // + // This is an "all or nothing" operation. If you do not have permission to access + // all of the metric streams that you list here, then none of the streams that you + // list in the operation will start streaming. // // This member is required. Names []string diff --git a/service/cloudwatch/api_op_StopMetricStreams.go b/service/cloudwatch/api_op_StopMetricStreams.go index e886c05bf1e..a83f8dfe858 100644 --- a/service/cloudwatch/api_op_StopMetricStreams.go +++ b/service/cloudwatch/api_op_StopMetricStreams.go @@ -28,10 +28,11 @@ func (c *Client) StopMetricStreams(ctx context.Context, params *StopMetricStream type StopMetricStreamsInput struct { - // The array of the names of metric streams to stop streaming. This is an "all or - // nothing" operation. If you do not have permission to access all of the metric - // streams that you list here, then none of the streams that you list in the - // operation will stop streaming. + // The array of the names of metric streams to stop streaming. + // + // This is an "all or nothing" operation. If you do not have permission to access + // all of the metric streams that you list here, then none of the streams that you + // list in the operation will stop streaming. // // This member is required. Names []string diff --git a/service/cloudwatch/api_op_TagResource.go b/service/cloudwatch/api_op_TagResource.go index fc70adfc545..4696998aa54 100644 --- a/service/cloudwatch/api_op_TagResource.go +++ b/service/cloudwatch/api_op_TagResource.go @@ -13,16 +13,22 @@ import ( // 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 -// strictly as strings of characters. You can use the TagResource action with an -// alarm that already has tags. If you specify a new tag key for the alarm, this -// tag is appended to the list of tags associated with the alarm. If you specify a -// tag key that is already associated with the alarm, the new tag value that you -// specify replaces the previous value for that tag. You can associate as many as -// 50 tags with a CloudWatch resource. +// 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 +// strictly as strings of characters. +// +// You can use the TagResource action with an alarm that already has tags. If you +// specify a new tag key for the alarm, this tag is appended to the list of tags +// associated with the alarm. If you specify a tag key that is already associated +// with the alarm, the new tag value that you specify replaces the previous value +// for that tag. +// +// You can associate as many as 50 tags with a CloudWatch resource. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -40,12 +46,18 @@ 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 - // 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. + // 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] in the Amazon Web Services General + // Reference. + // + // [Resource Types Defined by Amazon CloudWatch]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies // // This member is required. ResourceARN *string diff --git a/service/cloudwatch/api_op_UntagResource.go b/service/cloudwatch/api_op_UntagResource.go index 5f287905b89..f6537b01a70 100644 --- a/service/cloudwatch/api_op_UntagResource.go +++ b/service/cloudwatch/api_op_UntagResource.go @@ -28,12 +28,18 @@ 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 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) - // in the Amazon Web Services General Reference. + // arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name + // + // For more information about ARN format, see [Resource Types Defined by Amazon CloudWatch] in the Amazon Web Services General + // Reference. + // + // [Resource Types Defined by Amazon CloudWatch]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies // // This member is required. ResourceARN *string diff --git a/service/cloudwatch/doc.go b/service/cloudwatch/doc.go index 7c7a039e6f2..f65ff3db874 100644 --- a/service/cloudwatch/doc.go +++ b/service/cloudwatch/doc.go @@ -6,14 +6,17 @@ // Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) // resources and the applications you run on Amazon Web Services in real time. You // can use CloudWatch to collect and track metrics, which are the variables you -// want to measure for your resources and applications. CloudWatch alarms send -// notifications or automatically change the resources you are monitoring based on -// rules that you define. For example, you can monitor the CPU usage and disk reads -// and writes of your Amazon EC2 instances. Then, use this data to determine -// whether you should launch additional instances to handle increased load. You can -// also use this data to stop under-used instances to save money. In addition to -// monitoring the built-in metrics that come with Amazon Web Services, you can -// monitor your own custom metrics. With CloudWatch, you gain system-wide -// visibility into resource utilization, application performance, and operational -// health. +// want to measure for your resources and applications. +// +// CloudWatch alarms send notifications or automatically change the resources you +// are monitoring based on rules that you define. For example, you can monitor the +// CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this +// data to determine whether you should launch additional instances to handle +// increased load. You can also use this data to stop under-used instances to save +// money. +// +// In addition to monitoring the built-in metrics that come with Amazon Web +// Services, you can monitor your own custom metrics. With CloudWatch, you gain +// system-wide visibility into resource utilization, application performance, and +// operational health. package cloudwatch diff --git a/service/cloudwatch/options.go b/service/cloudwatch/options.go index d6114e6c17c..84238e8f894 100644 --- a/service/cloudwatch/options.go +++ b/service/cloudwatch/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -77,17 +79,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -104,8 +109,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -150,6 +156,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudwatch/types/enums.go b/service/cloudwatch/types/enums.go index 1b62b8b9218..78906bbb8a5 100644 --- a/service/cloudwatch/types/enums.go +++ b/service/cloudwatch/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ActionsSuppressedBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionsSuppressedBy) Values() []ActionsSuppressedBy { return []ActionsSuppressedBy{ "WaitPeriod", @@ -31,8 +32,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -51,6 +53,7 @@ const ( // Values returns all known values for AnomalyDetectorStateValue. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyDetectorStateValue) Values() []AnomalyDetectorStateValue { return []AnomalyDetectorStateValue{ @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for AnomalyDetectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyDetectorType) Values() []AnomalyDetectorType { return []AnomalyDetectorType{ "SINGLE_METRIC", @@ -92,8 +96,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GreaterThanOrEqualToThreshold", @@ -114,8 +119,9 @@ const ( ) // Values returns all known values for EvaluationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationState) Values() []EvaluationState { return []EvaluationState{ "PARTIAL_DATA", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for HistoryItemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HistoryItemType) Values() []HistoryItemType { return []HistoryItemType{ "ConfigurationUpdate", @@ -153,6 +160,7 @@ const ( // 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{ @@ -170,8 +178,9 @@ const ( ) // Values returns all known values for RecentlyActive. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecentlyActive) Values() []RecentlyActive { return []RecentlyActive{ "PT3H", @@ -187,8 +196,9 @@ const ( ) // Values returns all known values for ScanBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanBy) Values() []ScanBy { return []ScanBy{ "TimestampDescending", @@ -230,8 +240,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -274,8 +285,9 @@ const ( ) // Values returns all known values for StateValue. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StateValue) Values() []StateValue { return []StateValue{ "OK", @@ -296,8 +308,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -319,8 +332,9 @@ const ( ) // Values returns all known values for StatusCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusCode) Values() []StatusCode { return []StatusCode{ "Complete", diff --git a/service/cloudwatch/types/types.go b/service/cloudwatch/types/types.go index b33d90b5891..e5d7e8eff46 100644 --- a/service/cloudwatch/types/types.go +++ b/service/cloudwatch/types/types.go @@ -33,9 +33,10 @@ type AlarmHistoryItem struct { // An anomaly detection model associated with a particular CloudWatch metric, // statistic, or metric math expression. You can use the model to display a band of -// expected, normal values when the metric is graphed. If you have enabled unified -// cross-account observability, and this account is a monitoring account, the -// metric can be in the same account or a source account. +// expected, normal values when the metric is graphed. +// +// If you have enabled unified cross-account observability, and this account is a +// monitoring account, the metric can be in the same account or a source account. type AnomalyDetector struct { // The configuration specifies details about how the anomaly detection model is to @@ -92,9 +93,12 @@ type AnomalyDetectorConfiguration struct { // The time zone to use for the metric. This is useful to enable the model to // 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) . + // 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]. + // + // [tz database]: https://en.wikipedia.org/wiki/Tz_database MetricTimezone *string noSmithyDocumentSerde @@ -107,7 +111,7 @@ type CompositeAlarm struct { // state. ActionsEnabled *bool - // When the value is ALARM , it means that the actions are suppressed because 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 @@ -119,23 +123,26 @@ type CompositeAlarm struct { // its actions. ActionsSuppressedBy ActionsSuppressedBy - // Captures the reason for action suppression. + // Captures the reason for action suppression. ActionsSuppressedReason *string - // Actions will be suppressed if the suppressor alarm is in the ALARM state. + // Actions will be suppressed if the suppressor alarm is in the ALARM state. // ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an // existing alarm. ActionsSuppressor *string - // The maximum time in seconds that the composite alarm waits after suppressor + // 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. + // 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 + // The maximum time in seconds that the composite alarm waits for the suppressor // alarm to go into the ALARM state. After this time, the composite alarm performs - // its actions. WaitPeriod is required only when ActionsSuppressor is specified. + // its actions. + // + // WaitPeriod is required only when ActionsSuppressor is specified. ActionsSuppressorWaitPeriod *int32 // The actions to execute when this alarm transitions to the ALARM state from any @@ -172,7 +179,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. @@ -252,7 +259,9 @@ type Datapoint struct { // add a unique name/value pair to one of your metrics, you are creating a new // variation of that metric. For example, many Amazon EC2 metrics publish // InstanceId as a dimension name, and the actual instance ID as the value for that -// dimension. You can assign up to 30 dimensions to a metric. +// dimension. +// +// You can assign up to 30 dimensions to a metric. type Dimension struct { // The name of the dimension. Dimension names must contain only ASCII characters, @@ -288,16 +297,17 @@ type DimensionFilter struct { } // 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. +// more information about this rule, see[Using Constributor Insights to analyze high-cardinality data] in the Amazon CloudWatch User Guide. +// +// [Using Constributor Insights to analyze high-cardinality data]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html 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]. + // + // [Contributor Insights Rule Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html // // This member is required. Definition *string @@ -319,7 +329,7 @@ type InsightRule struct { // This member is required. State *string - // An optional built-in rule that Amazon Web Services manages. + // An optional built-in rule that Amazon Web Services manages. ManagedRule *bool noSmithyDocumentSerde @@ -327,10 +337,14 @@ type InsightRule struct { // 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) -// . +// 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]. +// +// [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. @@ -353,10 +367,12 @@ type InsightRuleContributor struct { noSmithyDocumentSerde } -// 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) -// . +// One data point related to one contributor. +// +// For more information, see [GetInsightRuleReport] and [InsightRuleContributor]. +// +// [GetInsightRuleReport]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html +// [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. @@ -373,8 +389,11 @@ 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]. +// +// [GetInsightRuleReport]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html type InsightRuleMetricDatapoint struct { // The timestamp of the data point. @@ -383,37 +402,49 @@ type InsightRuleMetricDatapoint struct { Timestamp *time.Time // The average value from all contributors during the time period represented by - // that data point. This statistic is returned only if you included it in the - // Metrics array in your request. + // that data point. + // + // This statistic is returned only if you included it in the Metrics array in your + // request. Average *float64 // The maximum value provided by one contributor during this timestamp. Each // timestamp is evaluated separately, so the identity of the max contributor could - // be different for each timestamp. This statistic is returned only if you included - // it in the Metrics array in your request. + // be different for each timestamp. + // + // This statistic is returned only if you included it in the Metrics array in your + // request. MaxContributorValue *float64 // The maximum value from a single occurence from a single contributor during the - // time period represented by that data point. This statistic is returned only if - // you included it in the Metrics array in your request. + // time period represented by that data point. + // + // This statistic is returned only if you included it in the Metrics array in your + // request. Maximum *float64 // The minimum value from a single contributor during the time period represented - // by that data point. This statistic is returned only if you included it in the - // Metrics array in your request. + // by that data point. + // + // This statistic is returned only if you included it in the Metrics array in your + // request. Minimum *float64 - // The number of occurrences that matched the rule during this data point. This - // statistic is returned only if you included it in the Metrics array in your + // The number of occurrences that matched the rule during this data point. + // + // This statistic is returned only if you included it in the Metrics array in your // request. SampleCount *float64 // The sum of the values from all contributors during the time period represented - // by that data point. This statistic is returned only if you included it in the - // Metrics array in your request. + // by that data point. + // + // This statistic is returned only if you included it in the 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 // request. UniqueContributors *float64 @@ -423,10 +454,13 @@ type InsightRuleMetricDatapoint struct { // This structure includes the Timezone parameter, which you can use to specify // 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) -// . +// 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]. +// +// [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,23 +473,24 @@ type LabelOptions struct { noSmithyDocumentSerde } -// Contains the information that's required to enable a managed Contributor +// Contains the information that's required to enable a managed Contributor +// // Insights rule for an Amazon Web Services resource. type ManagedRule struct { - // The ARN of an Amazon Web Services resource that has managed Contributor + // 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 + // The template name for the managed Contributor Insights rule, as returned by // ListManagedInsightRules . // // This member is required. TemplateName *string - // A list of key-value pairs that you can associate with a managed Contributor + // A list of key-value pairs that you can associate with a managed Contributor // Insights rule. You can associate as many as 50 tags with a rule. Tags can help // you organize and categorize your resources. You also can use them to scope user // permissions by granting a user permission to access or change only the resources @@ -469,20 +504,21 @@ type ManagedRule struct { noSmithyDocumentSerde } -// Contains information about managed Contributor Insights rules, as returned by +// Contains information about managed Contributor Insights rules, as returned by +// // ListManagedInsightRules . type ManagedRuleDescription struct { - // If a managed rule is enabled, this is the ARN for the related Amazon Web + // 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 + // 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 + // The template name for the managed rule. Used to enable managed rules using // PutManagedInsightRules . TemplateName *string @@ -492,13 +528,13 @@ type ManagedRuleDescription struct { // The status of a managed Contributor Insights rule. type ManagedRuleState struct { - // The name of the Contributor Insights rule that contains data for the specified + // The name of the Contributor Insights rule that contains data for the specified // Amazon Web Services resource. // // This member is required. RuleName *string - // Indicates whether the rule is enabled or disabled. + // Indicates whether the rule is enabled or disabled. // // This member is required. State *string @@ -507,6 +543,7 @@ type ManagedRuleState struct { } // 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 // correct the problem by running the GetMetricData operation in the same Region @@ -581,9 +618,9 @@ type MetricAlarm struct { // 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]. + // + // [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 @@ -601,8 +638,10 @@ type MetricAlarm struct { // An array of MetricDataQuery structures, used in an alarm based on a metric math // expression. Each structure either retrieves a metric or performs a math - // expression. One item in the Metrics array is the math expression that the alarm - // watches. This expression by designated by having ReturnData set to true. + // expression. + // + // One item in the Metrics array is the math expression that the alarm watches. + // This expression by designated by having ReturnData set to true. Metrics []MetricDataQuery // The namespace of the metric associated with the alarm. @@ -643,9 +682,11 @@ 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]. + // + // If this parameter is omitted, the default behavior of missing is used. + // + // [Configuring how CloudWatch alarms treat missing data]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data TreatMissingData *string // The unit of the metric associated with the alarm. @@ -668,25 +709,31 @@ type MetricCharacteristics struct { } // 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 -// 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 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) -// 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 -// following parameter list. +// 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 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 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]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 following parameter list. +// +// [Metric Math Syntax and Functions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax type MetricDataQuery struct { // A short name used to tie this object to the results in the response. This name @@ -699,37 +746,48 @@ type MetricDataQuery struct { // This member is required. Id *string - // The ID of the account where the metrics are located. If you are performing a - // GetMetricData operation in a monitoring account, use this to specify which - // account to retrieve this metric from. If you are performing a PutMetricAlarm - // operation, use this to specify which account contains the metric that the alarm - // is watching. + // The ID of the account where the metrics are located. + // + // If you are performing a GetMetricData operation in a monitoring account, use + // this to specify which account to retrieve this metric from. + // + // If you are performing a PutMetricAlarm operation, use this to specify which + // account contains the metric that the alarm is watching. AccountId *string // 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) - // 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) - // in the Amazon CloudWatch User Guide. Within each MetricDataQuery object, you - // must specify either Expression or MetricStat but not both. + // Metrics Insights queries, see [Metrics Insights query components and syntax]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] + // in the Amazon CloudWatch User Guide. + // + // Within each MetricDataQuery object, you must specify either Expression or + // MetricStat but not both. + // + // [Metrics Insights query components and syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage + // [Metric Math Syntax and Functions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax Expression *string // A human-readable label for this metric or expression. This is especially useful // if this is an expression, so that you know what the value represents. If the // 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) - // . + // 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]. + // + // [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 // parameter only if this object is retrieving a metric and not performing a math - // expression on returned data. Within one MetricDataQuery object, you must specify - // either Expression or MetricStat but not both. + // expression on returned data. + // + // Within one MetricDataQuery object, you must specify either Expression or + // MetricStat but not both. MetricStat *MetricStat // The granularity, in seconds, of the returned data points. For metrics with @@ -743,9 +801,10 @@ type MetricDataQuery struct { // 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 + // 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 @@ -798,9 +857,11 @@ 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. + // 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. Counts []float64 // The dimensions associated with the metric. @@ -814,9 +875,12 @@ 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) - // in the Amazon CloudWatch User Guide. This field is optional, if you do not - // specify it the default of 60 is used. + // information about high-resolution metrics, see [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. + // + // [High-Resolution Metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics StorageResolution *int32 // The time the metric data was received, expressed as the number of milliseconds @@ -824,24 +888,29 @@ type MetricDatum struct { Timestamp *time.Time // When you are using a Put operation, this defines what unit you want to use when - // storing the metric. In a Get operation, this displays the unit that is used for - // the metric. + // storing the metric. + // + // In a Get operation, this displays the unit that is used for 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 - // example, NaN, +Infinity, -Infinity) are not supported. + // 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 noSmithyDocumentSerde @@ -879,13 +948,18 @@ type MetricStat 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 call - // 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: + // 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). // @@ -899,12 +973,14 @@ type MetricStat struct { Stat *string // When you are using a Put operation, this defines what unit you want to use when - // storing the metric. In a Get operation, if you omit Unit then 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. + // storing the metric. + // + // In a Get operation, if you omit Unit then 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. Unit StandardUnit noSmithyDocumentSerde @@ -940,24 +1016,29 @@ type MetricStreamEntry struct { } // This structure contains a metric namespace and optionally, a list of metric -// names, to either include in a metric stream or exclude from a metric stream. A -// metric stream's filters can include up to 1000 total names. This limit applies -// to the sum of namespace names and metric names in the filters. For example, this -// could include 10 metric namespace filters with 99 metrics each, or 20 namespace -// filters with 49 metrics specified in each filter. +// names, to either include in a metric stream or exclude from a metric stream. +// +// A metric stream's filters can include up to 1000 total names. This limit +// applies to the sum of namespace names and metric names in the filters. For +// example, this could include 10 metric namespace filters with 99 metrics each, or +// 20 namespace filters with 49 metrics specified in each filter. type MetricStreamFilter struct { // The names of the metrics to either include or exclude from the metric stream. + // // If you omit this parameter, all metrics in the namespace are included or // excluded, depending on whether this filter is specified as an exclude filter or - // an include filter. Each metric name can contain only ASCII printable characters - // (ASCII range 32 through 126). Each metric name must contain at least one - // non-whitespace character. + // an include filter. + // + // Each metric name can contain only ASCII printable characters (ASCII range 32 + // through 126). Each metric name must contain at least one non-whitespace + // character. MetricNames []string - // The name of the metric namespace for this filter. The namespace can contain - // only ASCII printable characters (ASCII range 32 through 126). It must contain at - // least one non-whitespace character. + // The name of the metric namespace for this filter. + // + // The namespace can contain only ASCII printable characters (ASCII range 32 + // through 126). It must contain at least one non-whitespace character. Namespace *string noSmithyDocumentSerde @@ -966,28 +1047,33 @@ type MetricStreamFilter struct { // 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]. +// +// [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 opentelemetry1.0 - // or 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. + // many as 20 statistics. + // + // If the OutputFormat for the stream is opentelemetry1.0 or 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]. For example, this includes + // tm98, wm90 , PR(:300) , and so on. + // + // [CloudWatch statistics definitions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html // // This member is required. AdditionalStatistics []string // An array of metric name and namespace pairs that stream the additional // statistics listed in the value of the AdditionalStatistics parameter. There can - // be as many as 100 pairs in the array. All metrics that match the combination of - // metric name and namespace will be streamed with the additional statistics, no - // matter their dimensions. + // be as many as 100 pairs in the array. + // + // All metrics that match the combination of metric name and namespace will be + // streamed with the additional statistics, no matter their dimensions. // // This member is required. IncludeMetrics []MetricStreamStatisticsMetric diff --git a/service/cloudwatchevents/api_op_CreateEventBus.go b/service/cloudwatchevents/api_op_CreateEventBus.go index 8586b388ac6..b547866aaaf 100644 --- a/service/cloudwatchevents/api_op_CreateEventBus.go +++ b/service/cloudwatchevents/api_op_CreateEventBus.go @@ -31,11 +31,14 @@ func (c *Client) CreateEventBus(ctx context.Context, params *CreateEventBusInput type CreateEventBusInput struct { - // The name of the new event bus. Event bus names cannot contain the / character. - // You can't use the name default for a custom event bus, as this name is already - // used for your account's default event bus. If this is a partner event bus, the - // name must exactly match the name of the partner event source that this event bus - // is matched to. + // The name of the new event bus. + // + // Event bus names cannot contain the / character. You can't use the name default + // for a custom event bus, as this name is already used for your account's default + // event bus. + // + // If this is a partner event bus, the name must exactly match the name of the + // partner event source that this event bus is matched to. // // This member is required. Name *string diff --git a/service/cloudwatchevents/api_op_CreatePartnerEventSource.go b/service/cloudwatchevents/api_op_CreatePartnerEventSource.go index 45f2206f93c..f184a807640 100644 --- a/service/cloudwatchevents/api_op_CreatePartnerEventSource.go +++ b/service/cloudwatchevents/api_op_CreatePartnerEventSource.go @@ -11,23 +11,32 @@ import ( ) // Called by an SaaS partner to create a partner event source. This operation is -// not used by Amazon Web Services customers. Each partner event source can be used -// by one Amazon Web Services account to create a matching partner event bus in -// that Amazon Web Services account. A SaaS partner must create one partner event -// source for each Amazon Web Services account that wants to receive those event -// types. A partner event source creates events based on resources within the SaaS -// partner's service or application. An Amazon Web Services account that creates a -// 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 -// 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 -// should uniquely identify an event-generating resource within the partner system. -// The combination of event_namespace and event_name should help Amazon Web -// Services customers decide whether to create an event bus to receive these -// events. +// not used by Amazon Web Services customers. +// +// Each partner event source can be used by one Amazon Web Services account to +// create a matching partner event bus in that Amazon Web Services account. A SaaS +// partner must create one partner event source for each Amazon Web Services +// account that wants to receive those event types. +// +// A partner event source creates events based on resources within the SaaS +// partner's service or application. +// +// An Amazon Web Services account that creates a 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 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 should uniquely identify an event-generating +// resource within the partner system. The combination of event_namespace and +// event_name should help Amazon Web Services customers decide whether to create an +// event bus to receive these events. func (c *Client) CreatePartnerEventSource(ctx context.Context, params *CreatePartnerEventSourceInput, optFns ...func(*Options)) (*CreatePartnerEventSourceOutput, error) { if params == nil { params = &CreatePartnerEventSourceInput{} diff --git a/service/cloudwatchevents/api_op_DeactivateEventSource.go b/service/cloudwatchevents/api_op_DeactivateEventSource.go index 9ca5368af91..3bcd295563f 100644 --- a/service/cloudwatchevents/api_op_DeactivateEventSource.go +++ b/service/cloudwatchevents/api_op_DeactivateEventSource.go @@ -11,11 +11,14 @@ import ( ) // You can use this operation to temporarily stop receiving events from the -// 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) -// . +// 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]. +// +// [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_DeletePartnerEventSource.go b/service/cloudwatchevents/api_op_DeletePartnerEventSource.go index 372dec90fc8..8d648af64c9 100644 --- a/service/cloudwatchevents/api_op_DeletePartnerEventSource.go +++ b/service/cloudwatchevents/api_op_DeletePartnerEventSource.go @@ -11,9 +11,10 @@ import ( ) // This operation is used by SaaS partners to delete a partner event source. This -// operation is not used by Amazon Web Services customers. When you delete an event -// source, the status of the corresponding partner event bus in the Amazon Web -// Services customer account becomes DELETED. +// operation is not used by Amazon Web Services customers. +// +// When you delete an event source, the status of the corresponding partner event +// bus in the Amazon Web Services customer account becomes DELETED. func (c *Client) DeletePartnerEventSource(ctx context.Context, params *DeletePartnerEventSourceInput, optFns ...func(*Options)) (*DeletePartnerEventSourceOutput, error) { if params == nil { params = &DeletePartnerEventSourceInput{} diff --git a/service/cloudwatchevents/api_op_DeleteRule.go b/service/cloudwatchevents/api_op_DeleteRule.go index 0e878420c4c..0b8cc1b0964 100644 --- a/service/cloudwatchevents/api_op_DeleteRule.go +++ b/service/cloudwatchevents/api_op_DeleteRule.go @@ -10,17 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// is returned. Managed rules are rules created and managed by another Amazon Web -// Services service on your behalf. These rules are created by those other Amazon -// Web Services services to support functionality in those services. You can delete +// Deletes the specified rule. +// +// Before you can delete the rule, you must remove all targets, using [RemoveTargets]. +// +// 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 is returned. +// +// Managed rules are rules created and managed by another Amazon Web Services +// service on your behalf. These rules are created by those other Amazon Web +// Services services to support functionality in those services. You can delete // these rules using the Force option, but you should do so only if you are sure // the other service is not still using that rule. +// +// [RemoveTargets]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} diff --git a/service/cloudwatchevents/api_op_DescribeEventBus.go b/service/cloudwatchevents/api_op_DescribeEventBus.go index 946bfcd477b..a4076ce3008 100644 --- a/service/cloudwatchevents/api_op_DescribeEventBus.go +++ b/service/cloudwatchevents/api_op_DescribeEventBus.go @@ -13,11 +13,15 @@ import ( // Displays details about an event bus in your account. This can include the // external Amazon Web Services accounts that are permitted to write events to your // 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) -// . +// 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]. +// +// For more information about partner event buses, see [CreateEventBus]. +// +// [PutPermission]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html +// [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{} diff --git a/service/cloudwatchevents/api_op_DescribePartnerEventSource.go b/service/cloudwatchevents/api_op_DescribePartnerEventSource.go index 6880fa8d41b..6c81b94fef6 100644 --- a/service/cloudwatchevents/api_op_DescribePartnerEventSource.go +++ b/service/cloudwatchevents/api_op_DescribePartnerEventSource.go @@ -12,8 +12,10 @@ 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) -// to see details about a partner event source that is shared with them. +// operation. Instead, Amazon Web Services customers can use [DescribeEventSource]to see details about +// a partner event source that is shared with them. +// +// [DescribeEventSource]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html func (c *Client) DescribePartnerEventSource(ctx context.Context, params *DescribePartnerEventSourceInput, optFns ...func(*Options)) (*DescribePartnerEventSourceOutput, error) { if params == nil { params = &DescribePartnerEventSourceInput{} diff --git a/service/cloudwatchevents/api_op_DescribeRule.go b/service/cloudwatchevents/api_op_DescribeRule.go index 6781137f2ca..4d6a84765c4 100644 --- a/service/cloudwatchevents/api_op_DescribeRule.go +++ b/service/cloudwatchevents/api_op_DescribeRule.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Describes the specified rule. +// +// DescribeRule does not list the targets of a rule. To see the targets associated +// with a rule, use [ListTargetsByRule]. +// +// [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{} @@ -61,8 +64,10 @@ 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) - // in the Amazon EventBridge User Guide. + // The event pattern. For more information, see [Events and Event Patterns] in the Amazon EventBridge User + // Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html EventPattern *string // If this is a managed rule, created by an Amazon Web Services service on your diff --git a/service/cloudwatchevents/api_op_DisableRule.go b/service/cloudwatchevents/api_op_DisableRule.go index 24e89e41d0c..99d2e567a0f 100644 --- a/service/cloudwatchevents/api_op_DisableRule.go +++ b/service/cloudwatchevents/api_op_DisableRule.go @@ -11,9 +11,10 @@ import ( ) // Disables the specified rule. A disabled rule won't match any events, and won't -// self-trigger if it has a schedule expression. When you disable a rule, incoming -// events might continue to match to the disabled rule. Allow a short period of -// time for changes to take effect. +// self-trigger if it has a schedule expression. +// +// When you disable a rule, incoming events might continue to match to the +// disabled rule. Allow a short period of time for changes to take effect. func (c *Client) DisableRule(ctx context.Context, params *DisableRuleInput, optFns ...func(*Options)) (*DisableRuleOutput, error) { if params == nil { params = &DisableRuleInput{} diff --git a/service/cloudwatchevents/api_op_EnableRule.go b/service/cloudwatchevents/api_op_EnableRule.go index ef9090ce073..3ebafc670a3 100644 --- a/service/cloudwatchevents/api_op_EnableRule.go +++ b/service/cloudwatchevents/api_op_EnableRule.go @@ -11,6 +11,7 @@ import ( ) // Enables the specified rule. If the rule does not exist, the operation fails. +// // When you enable a rule, incoming events might not immediately start matching to // a newly enabled rule. Allow a short period of time for changes to take effect. func (c *Client) EnableRule(ctx context.Context, params *EnableRuleInput, optFns ...func(*Options)) (*EnableRuleOutput, error) { diff --git a/service/cloudwatchevents/api_op_ListEventSources.go b/service/cloudwatchevents/api_op_ListEventSources.go index f97d7029db7..012a031220b 100644 --- a/service/cloudwatchevents/api_op_ListEventSources.go +++ b/service/cloudwatchevents/api_op_ListEventSources.go @@ -13,8 +13,9 @@ import ( // 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) -// . +// sources, see [CreateEventBus]. +// +// [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_ListRules.go b/service/cloudwatchevents/api_op_ListRules.go index 53ce6d53d8d..d06de88fb4d 100644 --- a/service/cloudwatchevents/api_op_ListRules.go +++ b/service/cloudwatchevents/api_op_ListRules.go @@ -12,10 +12,12 @@ 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) -// . +// 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]. +// +// [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{} diff --git a/service/cloudwatchevents/api_op_PutPermission.go b/service/cloudwatchevents/api_op_PutPermission.go index ce488590933..b611a1c863f 100644 --- a/service/cloudwatchevents/api_op_PutPermission.go +++ b/service/cloudwatchevents/api_op_PutPermission.go @@ -14,20 +14,26 @@ import ( // Running PutPermission permits the specified Amazon Web Services account or // Amazon Web Services organization to put events to the specified event bus. // Amazon EventBridge (CloudWatch Events) rules in your account are triggered by -// these events arriving to an event bus in your account. For another account to -// send events to your account, that external account must have an EventBridge rule -// with your account's event bus as a target. To enable multiple Amazon Web -// 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 -// 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) -// in the Amazon EventBridge User Guide. The permission policy on the event bus -// cannot exceed 10 KB in size. +// these events arriving to an event bus in your account. +// +// For another account to send events to your account, that external account must +// have an EventBridge rule with your account's event bus as a target. +// +// To enable multiple Amazon Web 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 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] +// in the Amazon EventBridge User Guide. +// +// The permission policy on the event bus cannot exceed 10 KB in size. +// +// [Sending and Receiving Events Between Amazon Web Services Accounts]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error) { if params == nil { params = &PutPermissionInput{} @@ -50,12 +56,16 @@ 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) - // 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. + // organization. For more information about Amazon Web Services Organizations, see [What Is Amazon Web Services Organizations] + // 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. + // + // [What Is Amazon Web Services Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html Condition *types.Condition // The name of the event bus associated with the rule. If you omit this, the @@ -69,17 +79,20 @@ type PutPermissionInput struct { // 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 - // 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. + // events to your default event bus. + // + // If you specify "*" without specifying 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. Principal *string // 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]. + // + // [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 c9bdad92240..d4dd4a449ce 100644 --- a/service/cloudwatchevents/api_op_PutRule.go +++ b/service/cloudwatchevents/api_op_PutRule.go @@ -12,48 +12,64 @@ import ( ) // 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 +// on value of the state. You can disable a rule using [DisableRule]. +// +// 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 +// created. For more information, see [CreateEventBus]. +// +// 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 +// 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 +// 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]and [UntagResource]. +// +// 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. +// // In EventBridge, it is possible to create rules that lead to infinite loops, // where a rule is fired repeatedly. For example, a rule might detect that ACLs // have changed on an S3 bucket, and trigger software to change them to the desired // state. If the rule is not written carefully, the subsequent change to the ACLs -// fires the rule again, creating an infinite loop. To prevent this, write the -// rules so that the triggered actions do not re-fire the same rule. For example, -// your rule could fire only if ACLs are found to be in a bad state, instead of -// 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) -// . +// fires the rule again, creating an infinite loop. +// +// To prevent this, write the rules so that the triggered actions do not re-fire +// the same rule. For example, your rule could fire only if ACLs are found to be in +// a bad state, instead of 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]. +// +// [CreateEventBus]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html +// [TagResource]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html +// [UntagResource]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html +// [DisableRule]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html +// [Managing Your Costs with 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{} @@ -83,15 +99,18 @@ 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) - // in the Amazon EventBridge User Guide. + // The event pattern. For more information, see [Events and Event Patterns] in the Amazon EventBridge User + // Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html EventPattern *string - // The Amazon Resource Name (ARN) of the IAM role associated with the rule. If - // you're setting an event bus in another account as the target and that account - // granted permission to your account through an organization instead of directly - // by the account ID, you must specify a RoleArn with proper permissions in the - // Target structure, instead of here in this parameter. + // The Amazon Resource Name (ARN) of the IAM role associated with the rule. + // + // If you're setting an event bus in another account as the target and that + // account granted permission to your account through an organization instead of + // directly by the account ID, you must specify a RoleArn with proper permissions + // in the Target structure, instead of here in this parameter. RoleArn *string // The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 diff --git a/service/cloudwatchevents/api_op_PutTargets.go b/service/cloudwatchevents/api_op_PutTargets.go index 55266d9bac9..ccfd22264b9 100644 --- a/service/cloudwatchevents/api_op_PutTargets.go +++ b/service/cloudwatchevents/api_op_PutTargets.go @@ -12,90 +12,138 @@ import ( ) // 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) +// 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] +// // - 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 +// +// - 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 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 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 -// 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 -// 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 -// 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) -// 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 +// 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] 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 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 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]. +// +// 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] in the Amazon +// EventBridge User Guide. +// +// For more information about enabling cross-account events, see [PutPermission]. +// +// 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. +// 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. +// +// [Authentication and Access Control]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html +// [Amazon EventBridge Pricing]: http://aws.amazon.com/eventbridge/pricing/ +// [API destination]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html +// [Sending and Receiving Events Between Amazon Web Services Accounts]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html +// [PutPermission]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html func (c *Client) PutTargets(ctx context.Context, params *PutTargetsInput, optFns ...func(*Options)) (*PutTargetsOutput, error) { if params == nil { params = &PutTargetsInput{} diff --git a/service/cloudwatchevents/api_op_RemovePermission.go b/service/cloudwatchevents/api_op_RemovePermission.go index 857522f5ea3..0056ee1eea1 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]. +// +// [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 85317a0db51..1ac6badf02f 100644 --- a/service/cloudwatchevents/api_op_RemoveTargets.go +++ b/service/cloudwatchevents/api_op_RemoveTargets.go @@ -12,12 +12,15 @@ import ( ) // Removes the specified targets from the specified rule. When the rule is -// triggered, those targets are no longer be invoked. When you remove a target, -// when the associated rule triggers, removed targets might continue to be 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. +// triggered, those targets are no longer be invoked. +// +// When you remove a target, when the associated rule triggers, removed targets +// might continue to be 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) RemoveTargets(ctx context.Context, params *RemoveTargetsInput, optFns ...func(*Options)) (*RemoveTargetsOutput, error) { if params == nil { params = &RemoveTargetsInput{} diff --git a/service/cloudwatchevents/api_op_TagResource.go b/service/cloudwatchevents/api_op_TagResource.go index 77afc48a9c1..bd37f079517 100644 --- a/service/cloudwatchevents/api_op_TagResource.go +++ b/service/cloudwatchevents/api_op_TagResource.go @@ -15,13 +15,18 @@ import ( // resource. 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. In EventBridge, rules and event -// buses can be tagged. 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 specify a new -// tag key, this tag is appended to the list of tags associated with the resource. -// 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. +// buses can be tagged. +// +// 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 specify a new tag key, this tag is appended to the list of tags associated +// with the resource. 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/cloudwatchevents/api_op_TestEventPattern.go b/service/cloudwatchevents/api_op_TestEventPattern.go index 7221a9a8cd0..cae2471a506 100644 --- a/service/cloudwatchevents/api_op_TestEventPattern.go +++ b/service/cloudwatchevents/api_op_TestEventPattern.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tests whether the specified event pattern matches the provided event. 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 +// Tests whether the specified event pattern matches the provided event. +// +// 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. func (c *Client) TestEventPattern(ctx context.Context, params *TestEventPatternInput, optFns ...func(*Options)) (*TestEventPatternOutput, error) { @@ -33,21 +34,31 @@ 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: + // follow the format specified in [Amazon Web Services Events], and the following fields are mandatory: + // // - id + // // - account + // // - source + // // - time + // // - region + // // - resources + // // - detail-type // + // [Amazon Web Services Events]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html + // // 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) - // in the Amazon EventBridge User Guide. + // The event pattern. For more information, see [Events and Event Patterns] in the Amazon EventBridge User + // Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html // // This member is required. EventPattern *string diff --git a/service/cloudwatchevents/doc.go b/service/cloudwatchevents/doc.go index 58f2c070b3c..234f5164dc2 100644 --- a/service/cloudwatchevents/doc.go +++ b/service/cloudwatchevents/doc.go @@ -9,14 +9,17 @@ // 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. // -// 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]. +// +// [Amazon EventBridge User Guide]: https://docs.aws.amazon.com/eventbridge/latest/userguide package cloudwatchevents diff --git a/service/cloudwatchevents/options.go b/service/cloudwatchevents/options.go index 2552376ac33..9785c68aa86 100644 --- a/service/cloudwatchevents/options.go +++ b/service/cloudwatchevents/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudwatchevents/types/enums.go b/service/cloudwatchevents/types/enums.go index 65e0253d58b..00f6fc9804f 100644 --- a/service/cloudwatchevents/types/enums.go +++ b/service/cloudwatchevents/types/enums.go @@ -17,6 +17,7 @@ const ( // 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{ @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for ApiDestinationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiDestinationState) Values() []ApiDestinationState { return []ApiDestinationState{ "ACTIVE", @@ -61,8 +63,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -83,8 +86,9 @@ const ( ) // Values returns all known values for AssignPublicIp. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignPublicIp) Values() []AssignPublicIp { return []AssignPublicIp{ "ENABLED", @@ -103,6 +107,7 @@ const ( // Values returns all known values for ConnectionAuthorizationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionAuthorizationType) Values() []ConnectionAuthorizationType { return []ConnectionAuthorizationType{ @@ -123,6 +128,7 @@ const ( // Values returns all known values for ConnectionOAuthHttpMethod. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionOAuthHttpMethod) Values() []ConnectionOAuthHttpMethod { return []ConnectionOAuthHttpMethod{ @@ -146,8 +152,9 @@ const ( ) // Values returns all known values for ConnectionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionState) Values() []ConnectionState { return []ConnectionState{ "CREATING", @@ -170,8 +177,9 @@ const ( ) // Values returns all known values for EventSourceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourceState) Values() []EventSourceState { return []EventSourceState{ "PENDING", @@ -190,8 +198,9 @@ const ( ) // Values returns all known values for LaunchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchType) Values() []LaunchType { return []LaunchType{ "EC2", @@ -209,8 +218,9 @@ const ( ) // Values returns all known values for PlacementConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementConstraintType) Values() []PlacementConstraintType { return []PlacementConstraintType{ "distinctInstance", @@ -228,8 +238,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "random", @@ -246,8 +257,9 @@ const ( ) // Values returns all known values for PropagateTags. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropagateTags) Values() []PropagateTags { return []PropagateTags{ "TASK_DEFINITION", @@ -267,8 +279,9 @@ const ( ) // Values returns all known values for ReplayState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplayState) Values() []ReplayState { return []ReplayState{ "STARTING", @@ -289,8 +302,9 @@ const ( ) // 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. +// in the future, and so 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/types.go b/service/cloudwatchevents/types/types.go index 638861f9f9b..305376fa035 100644 --- a/service/cloudwatchevents/types/types.go +++ b/service/cloudwatchevents/types/types.go @@ -150,9 +150,10 @@ type BatchRetryStrategy struct { noSmithyDocumentSerde } -// The details of a capacity provider strategy. To learn more, see -// CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) -// in the Amazon ECS API Reference. +// The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem] in the Amazon +// ECS API Reference. +// +// [CapacityProviderStrategyItem]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html type CapacityProviderStrategyItem struct { // The short name of the capacity provider. @@ -179,8 +180,10 @@ type CapacityProviderStrategyItem struct { // 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"}' +// 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 @@ -481,20 +484,23 @@ type DeadLetterConfig struct { // The custom parameters to be used when the target is an Amazon ECS task. type EcsParameters struct { - // The ARN of the task definition to use if the event target is an Amazon ECS task. + // The ARN of the task definition to use if the event target is an Amazon ECS + // task. // // This member is required. TaskDefinitionArn *string - // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be + // 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 // 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Tagging Your Amazon ECS Resources]in the Amazon Elastic Container Service Developer Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags bool // Whether or not to enable the execute command functionality for the containers @@ -508,14 +514,17 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // witt Amazon ECS is supported. For more information, see [Fargate on Amazon ECS]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Fargate on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html LaunchType LaunchType // Use this structure if the Amazon ECS task uses the awsvpc network mode. This // structure specifies the VPC subnets and security groups associated with the // task, and whether a public IP address is to be used. This structure is required // if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. + // // If you specify NetworkConfiguration when the target ECS task does not use the // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration @@ -530,10 +539,13 @@ type EcsParameters struct { 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // Specifies whether to propagate the tags from the task definition to the task. @@ -547,8 +559,9 @@ 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) - // in the Amazon ECS API Reference. + // define. To learn more, see [RunTask]in the Amazon ECS API Reference. + // + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags Tags []Tag // The number of tasks to create based on TaskDefinition . The default is 1. @@ -637,27 +650,46 @@ 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: + // 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": + // . + // + // "InputTransformer": + // // { // // "InputPathsMap": {"instance": "$.detail.instance","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"}, // // "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": @@ -672,10 +704,13 @@ type InputTransformer struct { // Map of JSON paths to be extracted from the event. You can then insert these in // the template in InputTemplate to produce the output you want to be sent to the - // target. InputPathsMap is an array key-value pairs, where each value is a valid - // JSON path. You can have as many as 100 key-value pairs. You must use JSON dot - // notation, not bracket notation. The keys cannot start with "Amazon Web - // Services." + // target. + // + // InputPathsMap is an array key-value pairs, where each value is a valid JSON + // path. You can have as many as 100 key-value pairs. You must use JSON dot + // notation, not bracket notation. + // + // The keys cannot start with "Amazon Web Services." InputPathsMap map[string]string noSmithyDocumentSerde @@ -688,8 +723,9 @@ type InputTransformer struct { 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) - // in the Amazon Kinesis Streams Developer Guide. + // more information, see [Amazon Kinesis Streams Key Concepts]in the Amazon Kinesis Streams Developer Guide. + // + // [Amazon Kinesis Streams Key Concepts]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key // // This member is required. PartitionKeyPath *string @@ -745,15 +781,17 @@ type PartnerEventSourceAccount struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// An object representing a constraint on task placement. To learn more, see [Task Placement Constraints] in +// the Amazon Elastic Container Service Developer Guide. +// +// [Task Placement Constraints]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // more, see [Cluster Query Language]in the Amazon Elastic Container Service Developer Guide. + // + // [Cluster Query Language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html Expression *string // The type of constraint. Use distinctInstance to ensure that each task in a @@ -764,9 +802,10 @@ type PlacementConstraint struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Service Developer Guide. +// The task placement strategy for a task or service. To learn more, see [Task Placement Strategies] in the +// Amazon Elastic Container Service Service Developer Guide. +// +// [Task Placement Strategies]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement @@ -811,15 +850,19 @@ 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) - // call is used. + // The time stamp of the event, per [RFC3339]. If no time stamp is provided, the time stamp + // of the [PutEvents]call is used. + // + // [PutEvents]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html + // [RFC3339]: https://www.rfc-editor.org/rfc/rfc3339.txt 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) - // in the X-Ray Developer Guide. + // the trace-id associated with the event. + // + // To learn more about X-Ray trace headers, see [Tracing header] in the X-Ray Developer Guide. + // + // [Tracing header]: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader TraceHeader *string noSmithyDocumentSerde @@ -959,8 +1002,9 @@ 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]. + // + // [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. @@ -1023,9 +1067,10 @@ type Rule struct { // 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) - // in the Amazon EventBridge User Guide. + // The event pattern of the rule. For more information, see [Events and Event Patterns] in the Amazon + // EventBridge User Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html EventPattern *string // If the rule was created on behalf of your account by an Amazon Web Services @@ -1037,16 +1082,17 @@ type Rule struct { Name *string // The Amazon Resource Name (ARN) of the role that is used for target invocation. - // If you're setting an event bus in another account as the target and that account - // granted permission to your account through an organization instead of directly - // by the account ID, you must specify a RoleArn with proper permissions in the - // Target structure, instead of here in this parameter. + // + // If you're setting an event bus in another account as the target and that + // account granted permission to your account through an organization instead of + // directly by the account ID, you must specify a RoleArn with proper permissions + // in the 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) - // . + // minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule]. + // + // [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. @@ -1144,14 +1190,16 @@ type Tag struct { } // 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 +// complete list of services and resources that can be set as a target, see [PutTargets]. +// +// 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) -// in the Amazon EventBridge User Guide. +// permissions in the Target structure. For more information, see [Sending and Receiving Events Between Amazon Web Services Accounts] in the Amazon +// EventBridge User Guide. +// +// [Sending and Receiving Events Between Amazon Web Services Accounts]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html +// [PutTargets]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html type Target struct { // The Amazon Resource Name (ARN) of the target. @@ -1165,8 +1213,9 @@ type Target struct { 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. + // name, and other parameters. For more information, see [Jobs]in the Batch User Guide. + // + // [Jobs]: https://docs.aws.amazon.com/batch/latest/userguide/jobs.html BatchParameters *BatchParameters // The DeadLetterConfig that defines the target queue to send dead-letter queue @@ -1174,30 +1223,34 @@ type Target struct { DeadLetterConfig *DeadLetterConfig // 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) + // target is an Amazon ECS task. For more information about Amazon ECS tasks, see [Task Definitions] // in the Amazon EC2 Container Service Developer Guide. + // + // [Task Definitions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html EcsParameters *EcsParameters // Contains the HTTP parameters to use when the target is a API Gateway REST - // endpoint or EventBridge ApiDestination. If you specify an API Gateway REST 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 have these values configured. In case of any conflicting keys, values - // from the Connection take precedence. + // endpoint or EventBridge ApiDestination. + // + // If you specify an API Gateway REST 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 have these values + // configured. In case of any conflicting keys, values from the Connection take + // precedence. HttpParameters *HttpParameters // 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) - // . + // itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format]. + // + // [The JavaScript Object 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]. + // + // [JSONPath]: http://goessner.net/articles/JsonPath/ InputPath *string // Settings to enable you to provide custom input to a target based on certain @@ -1211,9 +1264,11 @@ type Target struct { KinesisParameters *KinesisParameters // Contains the Amazon Redshift Data API parameters to use when the target is a - // Amazon Redshift cluster. If you specify a Amazon Redshift Cluster as a Target, - // you can use this to specify parameters to invoke the Amazon Redshift Data API - // ExecuteStatement based on EventBridge events. + // Amazon Redshift cluster. + // + // If you specify a Amazon Redshift Cluster as a Target, you can use this to + // specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based + // on EventBridge events. RedshiftDataParameters *RedshiftDataParameters // The RetryPolicy object that contains the retry policy configuration to use for @@ -1229,13 +1284,16 @@ type Target struct { RunCommandParameters *RunCommandParameters // Contains the SageMaker Model Building Pipeline parameters to start execution of - // a SageMaker Model Building Pipeline. If you specify a SageMaker Model Building - // Pipeline as a target, you can use this to specify parameters to start a pipeline - // execution based on EventBridge events. + // a SageMaker Model Building Pipeline. + // + // If you specify a SageMaker Model Building Pipeline as a target, you can use + // this to specify parameters to start a pipeline execution based on EventBridge + // events. SageMakerPipelineParameters *SageMakerPipelineParameters - // Contains the message group ID to use when the target is a FIFO queue. If you - // specify an SQS FIFO queue as a target, the queue must have content-based + // Contains the message group ID to use when the target is a FIFO queue. + // + // If you specify an SQS FIFO queue as a target, the queue must have content-based // deduplication enabled. SqsParameters *SqsParameters diff --git a/service/cloudwatchlogs/api_op_AssociateKmsKey.go b/service/cloudwatchlogs/api_op_AssociateKmsKey.go index d41843c0794..cecd27275ad 100644 --- a/service/cloudwatchlogs/api_op_AssociateKmsKey.go +++ b/service/cloudwatchlogs/api_op_AssociateKmsKey.go @@ -11,40 +11,61 @@ import ( ) // Associates the specified KMS key with either one log group in the account, or -// with all stored CloudWatch Logs query insights results in the account. When you -// use AssociateKmsKey , you specify either the logGroupName parameter or the -// resourceIdentifier parameter. You can't specify both of those parameters in the -// same operation. +// with all stored CloudWatch Logs query insights results in the account. +// +// When you use AssociateKmsKey , you specify either the logGroupName parameter or +// the resourceIdentifier parameter. You can't specify both of those parameters in +// the same operation. +// // - Specify the logGroupName parameter to cause all log events stored in the log // group to be encrypted with that key. Only the log events ingested after the key -// is associated are encrypted with that key. 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 key is still within CloudWatch Logs. This -// enables CloudWatch Logs to decrypt this data whenever it is requested. -// Associating a key with a log group does not cause the results of queries of that -// log group to be encrypted with that key. To have query results encrypted with a -// KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier -// parameter that specifies a query-result resource. -// - Specify the resourceIdentifier parameter with a query-result resource, to -// use that key to encrypt the stored results of all future StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) -// operations in the account. The response from a GetQueryResults (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html) -// operation will still return the query results in plain text. Even if you have -// not associated a key with your query results, the query results are encrypted -// when stored, using the default CloudWatch Logs method. If you run a query from a -// monitoring account that queries logs in a source account, the query results key -// from the monitoring account, if any, is used. +// is associated are encrypted with that key. +// +// 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 key is +// still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data +// whenever it is requested. +// +// Associating a key with a log group does not cause the results of queries of +// +// that log group to be encrypted with that key. To have query results encrypted +// with a KMS key, you must use an AssociateKmsKey operation with the +// resourceIdentifier parameter that specifies a query-result resource. +// +// - Specify the resourceIdentifier parameter with a query-result resource, to +// use that key to encrypt the stored results of all future [StartQuery]operations in the +// account. The response from a [GetQueryResults]operation will still return the query results in +// plain text. +// +// Even if you have not associated a key with your query results, the query +// +// results are encrypted when stored, using the default CloudWatch Logs method. +// +// If you run a query from a monitoring account that queries logs in a source +// +// account, the query results key from the monitoring account, if any, is used. // // If you delete the key that is used to encrypt log events or log group query // results, then all the associated stored log events or query results that were -// encrypted with that key will be unencryptable and unusable. CloudWatch Logs -// supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key -// with your log group or query results. 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. +// encrypted with that key will be unencryptable and unusable. +// +// CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an +// asymmetric KMS key with your log group or query results. For more information, +// see [Using Symmetric and Asymmetric Keys]. +// +// 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 +// +// [StartQuery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html +// [GetQueryResults]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html func (c *Client) AssociateKmsKey(ctx context.Context, params *AssociateKmsKeyInput, optFns ...func(*Options)) (*AssociateKmsKeyOutput, error) { if params == nil { params = &AssociateKmsKeyInput{} @@ -63,32 +84,41 @@ func (c *Client) AssociateKmsKey(ctx context.Context, params *AssociateKmsKeyInp 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) - // . + // This must be a symmetric KMS key. For more information, see [Amazon Resource Names]and [Using Symmetric and Asymmetric Keys]. + // + // [Amazon Resource Names]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms + // [Using Symmetric and Asymmetric Keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html // // This member is required. KmsKeyId *string - // The name of the log group. In your AssociateKmsKey operation, you must specify - // either the resourceIdentifier parameter or the logGroup parameter, but you - // can't specify both. + // The name of the log group. + // + // In your AssociateKmsKey operation, you must specify either the + // resourceIdentifier parameter or the logGroup parameter, but you can't specify + // both. LogGroupName *string // Specifies the target for this operation. You must specify one of the following: - // - Specify the following ARN to have future GetQueryResults (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html) - // operations in this account encrypt the results with the specified KMS key. - // Replace REGION and ACCOUNT_ID with your Region and account ID. - // arn:aws:logs:REGION:ACCOUNT_ID:query-result:* + // + // - Specify the following ARN to have future [GetQueryResults]operations in this account encrypt + // the results with the specified KMS key. Replace REGION and ACCOUNT_ID with your + // Region and account ID. + // + // arn:aws:logs:REGION:ACCOUNT_ID:query-result:* + // // - Specify the ARN of a log group to have CloudWatch Logs use the KMS key to // encrypt log events that are ingested and stored by that log group. The log group // ARN must be in the following format. Replace REGION and ACCOUNT_ID with your // Region and account ID. - // arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME + // + // arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME + // // In your AssociateKmsKey operation, you must specify either the // resourceIdentifier parameter or the logGroup parameter, but you can't specify // both. + // + // [GetQueryResults]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html ResourceIdentifier *string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_CancelExportTask.go b/service/cloudwatchlogs/api_op_CancelExportTask.go index 85519b686b6..7a5f9fc0de3 100644 --- a/service/cloudwatchlogs/api_op_CancelExportTask.go +++ b/service/cloudwatchlogs/api_op_CancelExportTask.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels the specified export task. The task must be in the PENDING or RUNNING -// state. +// Cancels the specified export task. +// +// The task must be in the PENDING or RUNNING state. func (c *Client) CancelExportTask(ctx context.Context, params *CancelExportTaskInput, optFns ...func(*Options)) (*CancelExportTaskOutput, error) { if params == nil { params = &CancelExportTaskInput{} diff --git a/service/cloudwatchlogs/api_op_CreateDelivery.go b/service/cloudwatchlogs/api_op_CreateDelivery.go index 2216154163c..704acf3f129 100644 --- a/service/cloudwatchlogs/api_op_CreateDelivery.go +++ b/service/cloudwatchlogs/api_op_CreateDelivery.go @@ -12,34 +12,43 @@ import ( ) // Creates a delivery. A delivery is a connection between a logical delivery -// source and a logical delivery destination that you have already created. Only -// some Amazon Web Services services support being configured as a delivery source -// using this operation. These services are listed as Supported [V2 Permissions] in -// the table at Enabling logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) +// source and a logical delivery destination that you have already created. +// +// Only some Amazon Web Services services support being configured as a delivery +// source using this operation. These services are listed as Supported [V2 +// Permissions] in the table at [Enabling logging from Amazon Web Services services.] +// // A delivery destination can represent a log group in CloudWatch Logs, an Amazon -// S3 bucket, or a delivery stream in Firehose. To configure logs delivery between -// a supported Amazon Web Services service and a destination, you must do the -// following: +// S3 bucket, or a delivery stream in Firehose. +// +// To configure logs delivery between a supported Amazon Web Services service and +// a destination, you must do the following: +// // - Create a delivery source, which is a logical object that represents the -// resource that is actually sending the logs. For more information, see -// PutDeliverySource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// . +// resource that is actually sending the logs. For more information, see [PutDeliverySource]. +// // - Create a delivery destination, which is a logical object that represents -// the actual delivery destination. For more information, see -// PutDeliveryDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html) -// . -// - If you are delivering logs cross-account, you must use -// PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// in the destination account to assign an IAM policy to the destination. This -// policy allows delivery to that destination. +// the actual delivery destination. For more information, see [PutDeliveryDestination]. +// +// - If you are delivering logs cross-account, you must use [PutDeliveryDestinationPolicy]in the destination +// account to assign an IAM policy to the destination. This policy allows delivery +// to that destination. +// // - Use CreateDelivery to create a delivery by pairing exactly one delivery // source and one delivery destination. // // You can configure a single delivery source to send logs to multiple // destinations by creating multiple deliveries. You can also create multiple // deliveries to configure multiple delivery sources to send logs to the same -// delivery destination. You can't update an existing delivery. You can only create -// and delete deliveries. +// delivery destination. +// +// You can't update an existing delivery. You can only create and delete +// deliveries. +// +// [PutDeliveryDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html +// [PutDeliverySource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [Enabling logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html func (c *Client) CreateDelivery(ctx context.Context, params *CreateDeliveryInput, optFns ...func(*Options)) (*CreateDeliveryOutput, error) { if params == nil { params = &CreateDeliveryInput{} @@ -67,8 +76,11 @@ type CreateDeliveryInput struct { // This member is required. DeliverySourceName *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) + // An optional list of key-value pairs to associate with the resource. + // + // For more information about tagging, see [Tagging Amazon Web Services resources] + // + // [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_CreateExportTask.go b/service/cloudwatchlogs/api_op_CreateExportTask.go index 23eb8e8686e..79c8fe5a4f4 100644 --- a/service/cloudwatchlogs/api_op_CreateExportTask.go +++ b/service/cloudwatchlogs/api_op_CreateExportTask.go @@ -13,21 +13,29 @@ import ( // Creates an export task so that you can efficiently export data from a log group // to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must // use credentials that have permission to write to the S3 bucket that you specify -// as the destination. Exporting log data to S3 buckets that are encrypted by KMS -// is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock -// enabled with a retention period is also supported. Exporting to S3 buckets that -// 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 +// as the destination. +// +// Exporting log data to S3 buckets that are encrypted by KMS is supported. +// Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a +// retention period is also supported. +// +// Exporting to S3 buckets that 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]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]. +// +// 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. +// 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. +// +// [CancelExportTask]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html +// [DescribeExportTasks]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html func (c *Client) CreateExportTask(ctx context.Context, params *CreateExportTaskInput, optFns ...func(*Options)) (*CreateExportTaskOutput, error) { if params == nil { params = &CreateExportTaskInput{} @@ -65,8 +73,10 @@ type CreateExportTaskInput struct { // 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 - // this time are not exported. You must specify a time that is not earlier than - // when this log group was created. + // this time are not exported. + // + // You must specify a time that is not earlier than when this log group was + // created. // // This member is required. To *int64 diff --git a/service/cloudwatchlogs/api_op_CreateLogAnomalyDetector.go b/service/cloudwatchlogs/api_op_CreateLogAnomalyDetector.go index dd9a1f7bc99..c8cb0a36e0b 100644 --- a/service/cloudwatchlogs/api_op_CreateLogAnomalyDetector.go +++ b/service/cloudwatchlogs/api_op_CreateLogAnomalyDetector.go @@ -12,24 +12,38 @@ import ( ) // Creates an anomaly detector that regularly scans one or more log groups and -// look for patterns and anomalies in the logs. An anomaly detector can help -// surface issues by automatically discovering anomalies in your log event traffic. -// An anomaly detector uses machine learning algorithms to scan log events and find -// patterns. A pattern is a shared text structure that recurs among your log -// fields. Patterns provide a useful tool for analyzing large sets of logs because -// a large number of log events can often be compressed into a few patterns. The -// anomaly detector uses pattern recognition to find anomalies , which are unusual -// log events. It uses the evaluationFrequency to compare current log events and -// patterns with trained baselines. Fields within a pattern are called tokens. -// Fields that vary within a pattern, such as a request ID or timestamp, are -// referred to as dynamic tokens and represented by <> . The following is an -// example of a pattern: [INFO] Request time: < > ms This pattern represents log -// events like [INFO] Request time: 327 ms and other similar log events that -// differ only by the number, in this csse 327. When the pattern is displayed, the -// different numbers are replaced by <*> Any parts of log events that are masked -// as sensitive data are not scanned for anomalies. For more information about -// masking sensitive data, see Help protect sensitive log data with masking (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) -// . +// look for patterns and anomalies in the logs. +// +// An anomaly detector can help surface issues by automatically discovering +// anomalies in your log event traffic. An anomaly detector uses machine learning +// algorithms to scan log events and find patterns. +// +// A pattern is a shared text structure that recurs among your log fields. +// Patterns provide a useful tool for analyzing large sets of logs because a large +// number of log events can often be compressed into a few patterns. +// +// The anomaly detector uses pattern recognition to find anomalies , which are +// unusual log events. It uses the evaluationFrequency to compare current log +// events and patterns with trained baselines. +// +// Fields within a pattern are called tokens. Fields that vary within a pattern, +// such as a request ID or timestamp, are referred to as dynamic tokens and +// represented by <> . +// +// The following is an example of a pattern: +// +// [INFO] Request time: < +// +// > ms +// +// This pattern represents log events like [INFO] Request time: 327 ms and other +// similar log events that differ only by the number, in this csse 327. When the +// pattern is displayed, the different numbers are replaced by <*> +// +// Any parts of log events that are masked as sensitive data are not scanned for +// anomalies. For more information about masking sensitive data, see [Help protect sensitive log data with masking]. +// +// [Help protect sensitive log data with masking]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html func (c *Client) CreateLogAnomalyDetector(ctx context.Context, params *CreateLogAnomalyDetectorInput, optFns ...func(*Options)) (*CreateLogAnomalyDetectorOutput, error) { if params == nil { params = &CreateLogAnomalyDetectorInput{} @@ -71,23 +85,28 @@ type CreateLogAnomalyDetectorInput struct { EvaluationFrequency types.EvaluationFrequency // You can use this parameter to limit the anomaly detection model to examine only - // log events that match the pattern you specify here. For more information, see - // Filter and Pattern Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) - // . + // log events that match the pattern you specify here. For more information, see [Filter and Pattern Syntax]. + // + // [Filter and Pattern Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html FilterPattern *string // Optionally assigns a KMS key to secure this anomaly detector and its findings. // If a key is assigned, the anomalies found and the model used by this detector // are encrypted at rest with the key. If a key is assigned to an anomaly detector, // a user must have permissions for both this key and for the anomaly detector to - // retrieve information about the anomalies that it finds. For more information - // about using a KMS key and to see the required IAM policy, see Use a KMS key - // with an anomaly detector (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html) - // . + // retrieve information about the anomalies that it finds. + // + // For more information about using a KMS key and to see the required IAM policy, + // see [Use a KMS key with an anomaly detector]. + // + // [Use a KMS key with an anomaly detector]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html KmsKeyId *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) + // An optional list of key-value pairs to associate with the resource. + // + // For more information about tagging, see [Tagging Amazon Web Services resources] + // + // [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_CreateLogGroup.go b/service/cloudwatchlogs/api_op_CreateLogGroup.go index 8d828b449c4..25980102f08 100644 --- a/service/cloudwatchlogs/api_op_CreateLogGroup.go +++ b/service/cloudwatchlogs/api_op_CreateLogGroup.go @@ -12,28 +12,39 @@ import ( ) // Creates a log group with the specified name. You can create up to 1,000,000 log -// groups per Region per account. You must use the following guidelines when naming -// a log group: +// groups per Region 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 can't start with the string aws/ // // 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 +// specified time, use [PutRetentionPolicy]. +// +// 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 key does 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) -// . +// decrypt this data whenever it is requested. +// +// If you attempt to associate a KMS key with the log group but the KMS key does +// 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]. +// +// [Using Symmetric and Asymmetric Keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [PutRetentionPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html func (c *Client) CreateLogGroup(ctx context.Context, params *CreateLogGroupInput, optFns ...func(*Options)) (*CreateLogGroupOutput, error) { if params == nil { params = &CreateLogGroupInput{} @@ -57,29 +68,39 @@ 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]. + // + // [Amazon Resource Names]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms KmsKeyId *string // Use this parameter to specify the log group class for this log group. There are // two classes: + // // - The Standard log class supports all CloudWatch Logs features. + // // - The Infrequent Access log class supports a subset of CloudWatch Logs // features and incurs lower costs. - // If you omit this parameter, the default of STANDARD is used. The value of - // logGroupClass can't be changed after a log group is created. For details about - // the features supported by each class, see Log classes (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html) + // + // If you omit this parameter, the default of STANDARD is used. + // + // The value of logGroupClass can't be changed after a log group is created. + // + // For details about the features supported by each class, see [Log classes] + // + // [Log classes]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html LogGroupClass types.LogGroupClass - // The key-value pairs to use for the tags. You can grant users access to certain - // log groups while preventing them from accessing other log groups. To do so, tag - // 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) - // . + // The key-value pairs to use for the tags. + // + // You can grant users access to certain log groups while preventing them from + // accessing other log groups. To do so, tag 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]. For more information about using tags to + // control access, see [Controlling access to Amazon Web Services resources using tags]. + // + // [Controlling access to Amazon Web Services resources using tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.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/cloudwatchlogs/api_op_CreateLogStream.go b/service/cloudwatchlogs/api_op_CreateLogStream.go index b5cc7bb33bc..f259eb5b3c0 100644 --- a/service/cloudwatchlogs/api_op_CreateLogStream.go +++ b/service/cloudwatchlogs/api_op_CreateLogStream.go @@ -12,12 +12,18 @@ import ( // Creates a log stream for the specified log group. A log stream is a sequence of // log events that originate from a single source, such as an application instance -// or a resource that is being monitored. There is no limit on the number of log -// 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: +// or a resource that is being monitored. +// +// There is no limit on the number of log 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. func (c *Client) CreateLogStream(ctx context.Context, params *CreateLogStreamInput, optFns ...func(*Options)) (*CreateLogStreamOutput, error) { if params == nil { diff --git a/service/cloudwatchlogs/api_op_DeleteAccountPolicy.go b/service/cloudwatchlogs/api_op_DeleteAccountPolicy.go index 0976781964b..a4e7c62a150 100644 --- a/service/cloudwatchlogs/api_op_DeleteAccountPolicy.go +++ b/service/cloudwatchlogs/api_op_DeleteAccountPolicy.go @@ -13,11 +13,14 @@ import ( // Deletes a CloudWatch Logs account policy. This stops the policy from applying // to all log groups or a subset of log groups in the account. Log-group level -// policies will still be in effect. To use this operation, you must be signed on -// with the correct permissions depending on the type of policy that you are -// deleting. +// policies will still be in effect. +// +// To use this operation, you must be signed on with the correct permissions +// depending on the type of policy that you are deleting. +// // - To delete a data protection policy, you must have the // logs:DeleteDataProtectionPolicy and logs:DeleteAccountPolicy permissions. +// // - To delete a subscription filter policy, you must have the // logs:DeleteSubscriptionFilter and logs:DeleteAccountPolicy permissions. func (c *Client) DeleteAccountPolicy(ctx context.Context, params *DeleteAccountPolicyInput, optFns ...func(*Options)) (*DeleteAccountPolicyOutput, error) { diff --git a/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go b/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go index 392c775ee83..8c6ec252e5f 100644 --- a/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go +++ b/service/cloudwatchlogs/api_op_DeleteDataProtectionPolicy.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Deletes the data protection policy from the specified log group. +// +// For more information about data protection policies, see [PutDataProtectionPolicy]. +// +// [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_DeleteDelivery.go b/service/cloudwatchlogs/api_op_DeleteDelivery.go index 7a8844288b5..1bf53c0020d 100644 --- a/service/cloudwatchlogs/api_op_DeleteDelivery.go +++ b/service/cloudwatchlogs/api_op_DeleteDelivery.go @@ -32,8 +32,9 @@ func (c *Client) DeleteDelivery(ctx context.Context, params *DeleteDeliveryInput type DeleteDeliveryInput struct { // The unique ID of the delivery to delete. You can find the ID of a delivery with - // the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) - // operation. + // the [DescribeDeliveries]operation. + // + // [DescribeDeliveries]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html // // This member is required. Id *string diff --git a/service/cloudwatchlogs/api_op_DeleteDeliveryDestination.go b/service/cloudwatchlogs/api_op_DeleteDeliveryDestination.go index abb505c0312..5bf480ae7c2 100644 --- a/service/cloudwatchlogs/api_op_DeleteDeliveryDestination.go +++ b/service/cloudwatchlogs/api_op_DeleteDeliveryDestination.go @@ -11,11 +11,14 @@ import ( ) // Deletes a delivery destination. A delivery is a connection between a logical -// delivery source and a logical delivery destination. You can't delete a delivery -// destination if any current deliveries are associated with it. To find whether -// any deliveries are associated with this delivery destination, use the -// DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) -// operation and check the deliveryDestinationArn field in the results. +// delivery source and a logical delivery destination. +// +// You can't delete a delivery destination if any current deliveries are +// associated with it. To find whether any deliveries are associated with this +// delivery destination, use the [DescribeDeliveries]operation and check the deliveryDestinationArn +// field in the results. +// +// [DescribeDeliveries]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html func (c *Client) DeleteDeliveryDestination(ctx context.Context, params *DeleteDeliveryDestinationInput, optFns ...func(*Options)) (*DeleteDeliveryDestinationOutput, error) { if params == nil { params = &DeleteDeliveryDestinationInput{} @@ -34,8 +37,9 @@ func (c *Client) DeleteDeliveryDestination(ctx context.Context, params *DeleteDe type DeleteDeliveryDestinationInput struct { // The name of the delivery destination that you want to delete. You can find a - // list of delivery destionation names by using the DescribeDeliveryDestinations (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveryDestinations.html) - // operation. + // list of delivery destionation names by using the [DescribeDeliveryDestinations]operation. + // + // [DescribeDeliveryDestinations]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveryDestinations.html // // This member is required. Name *string diff --git a/service/cloudwatchlogs/api_op_DeleteDeliveryDestinationPolicy.go b/service/cloudwatchlogs/api_op_DeleteDeliveryDestinationPolicy.go index 48f1f738d12..9b3bfc191b6 100644 --- a/service/cloudwatchlogs/api_op_DeleteDeliveryDestinationPolicy.go +++ b/service/cloudwatchlogs/api_op_DeleteDeliveryDestinationPolicy.go @@ -11,8 +11,9 @@ import ( ) // Deletes a delivery destination policy. For more information about these -// policies, see PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// . +// policies, see [PutDeliveryDestinationPolicy]. +// +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html func (c *Client) DeleteDeliveryDestinationPolicy(ctx context.Context, params *DeleteDeliveryDestinationPolicyInput, optFns ...func(*Options)) (*DeleteDeliveryDestinationPolicyOutput, error) { if params == nil { params = &DeleteDeliveryDestinationPolicyInput{} diff --git a/service/cloudwatchlogs/api_op_DeleteDeliverySource.go b/service/cloudwatchlogs/api_op_DeleteDeliverySource.go index b842f3a4d21..b3c88866395 100644 --- a/service/cloudwatchlogs/api_op_DeleteDeliverySource.go +++ b/service/cloudwatchlogs/api_op_DeleteDeliverySource.go @@ -11,10 +11,13 @@ import ( ) // Deletes a delivery source. A delivery is a connection between a logical -// delivery source and a logical delivery destination. You can't delete a delivery -// source if any current deliveries are associated with it. To find whether any -// deliveries are associated with this delivery source, use the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) -// operation and check the deliverySourceName field in the results. +// delivery source and a logical delivery destination. +// +// You can't delete a delivery source if any current deliveries are associated +// with it. To find whether any deliveries are associated with this delivery +// source, use the [DescribeDeliveries]operation and check the deliverySourceName field in the results. +// +// [DescribeDeliveries]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html func (c *Client) DeleteDeliverySource(ctx context.Context, params *DeleteDeliverySourceInput, optFns ...func(*Options)) (*DeleteDeliverySourceOutput, error) { if params == nil { params = &DeleteDeliverySourceInput{} diff --git a/service/cloudwatchlogs/api_op_DeleteLogAnomalyDetector.go b/service/cloudwatchlogs/api_op_DeleteLogAnomalyDetector.go index 34d5377f838..46826a724af 100644 --- a/service/cloudwatchlogs/api_op_DeleteLogAnomalyDetector.go +++ b/service/cloudwatchlogs/api_op_DeleteLogAnomalyDetector.go @@ -29,8 +29,9 @@ func (c *Client) DeleteLogAnomalyDetector(ctx context.Context, params *DeleteLog type DeleteLogAnomalyDetectorInput struct { // The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly - // detectors in your account by using the ListLogAnomalyDetectors (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html) - // operation. + // detectors in your account by using the [ListLogAnomalyDetectors]operation. + // + // [ListLogAnomalyDetectors]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html // // This member is required. AnomalyDetectorArn *string diff --git a/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go b/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go index fd72d633bd0..8526a358e0a 100644 --- a/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go +++ b/service/cloudwatchlogs/api_op_DeleteQueryDefinition.go @@ -11,9 +11,12 @@ import ( ) // Deletes a saved CloudWatch Logs Insights query definition. A query definition -// contains details about a saved CloudWatch Logs Insights query. Each -// DeleteQueryDefinition operation can delete one query definition. You must have -// the logs:DeleteQueryDefinition permission to be able to perform this operation. +// contains details about a saved CloudWatch Logs Insights query. +// +// Each DeleteQueryDefinition operation can delete one query definition. +// +// You must have the logs:DeleteQueryDefinition permission to be able to perform +// this operation. func (c *Client) DeleteQueryDefinition(ctx context.Context, params *DeleteQueryDefinitionInput, optFns ...func(*Options)) (*DeleteQueryDefinitionOutput, error) { if params == nil { params = &DeleteQueryDefinitionInput{} @@ -31,9 +34,10 @@ 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) - // to retrieve the IDs of your saved query definitions. + // The ID of the query definition that you want to delete. You can use [DescribeQueryDefinitions] to + // retrieve the IDs of your saved query definitions. + // + // [DescribeQueryDefinitions]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html // // This member is required. QueryDefinitionId *string diff --git a/service/cloudwatchlogs/api_op_DeleteRetentionPolicy.go b/service/cloudwatchlogs/api_op_DeleteRetentionPolicy.go index 54e1009ebdd..ce7087e68b1 100644 --- a/service/cloudwatchlogs/api_op_DeleteRetentionPolicy.go +++ b/service/cloudwatchlogs/api_op_DeleteRetentionPolicy.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified retention policy. Log events do not expire if they belong -// to log groups without a retention policy. +// Deletes the specified retention policy. +// +// Log events do not expire if they belong to log groups without a retention +// policy. func (c *Client) DeleteRetentionPolicy(ctx context.Context, params *DeleteRetentionPolicyInput, optFns ...func(*Options)) (*DeleteRetentionPolicyOutput, error) { if params == nil { params = &DeleteRetentionPolicyInput{} diff --git a/service/cloudwatchlogs/api_op_DescribeAccountPolicies.go b/service/cloudwatchlogs/api_op_DescribeAccountPolicies.go index 0c11caae980..34362ab260c 100644 --- a/service/cloudwatchlogs/api_op_DescribeAccountPolicies.go +++ b/service/cloudwatchlogs/api_op_DescribeAccountPolicies.go @@ -39,8 +39,9 @@ type DescribeAccountPoliciesInput struct { // CloudWatch unified cross-account observability, you can use this to specify the // account ID of a source account. If you do, the operation returns the account // policy for the specified account. Currently, you can specify only one account ID - // in this parameter. If you omit this parameter, only the policy in the current - // account is returned. + // in this parameter. + // + // If you omit this parameter, only the policy in the current account is returned. AccountIdentifiers []string // Use this parameter to limit the returned policies to only the policy with the diff --git a/service/cloudwatchlogs/api_op_DescribeDeliveries.go b/service/cloudwatchlogs/api_op_DescribeDeliveries.go index 7f12033e05d..b9bb9f7c88c 100644 --- a/service/cloudwatchlogs/api_op_DescribeDeliveries.go +++ b/service/cloudwatchlogs/api_op_DescribeDeliveries.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of the deliveries that have been created in the account. A -// delivery is a connection between a delivery source (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// and a delivery destination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html) -// . A delivery source represents an Amazon Web Services resource that sends logs -// to an logs delivery destination. The destination can be CloudWatch Logs, Amazon -// S3, or Firehose. Only some Amazon Web Services services support being configured -// as a delivery source. These services are listed in Enable logging from Amazon -// Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) +// Retrieves a list of the deliveries that have been created in the account. +// +// A delivery is a connection between a [delivery source] and a [delivery destination]. +// +// A delivery source represents an Amazon Web Services resource that sends logs to +// an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, +// or Firehose. Only some Amazon Web Services services support being configured as +// a delivery source. These services are listed in [Enable logging from Amazon Web Services services.] +// +// [delivery destination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html +// [delivery source]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [Enable logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html func (c *Client) DescribeDeliveries(ctx context.Context, params *DescribeDeliveriesInput, optFns ...func(*Options)) (*DescribeDeliveriesOutput, error) { if params == nil { params = &DescribeDeliveriesInput{} diff --git a/service/cloudwatchlogs/api_op_DescribeLogGroups.go b/service/cloudwatchlogs/api_op_DescribeLogGroups.go index cc437cf2eb5..1c333b22292 100644 --- a/service/cloudwatchlogs/api_op_DescribeLogGroups.go +++ b/service/cloudwatchlogs/api_op_DescribeLogGroups.go @@ -12,16 +12,20 @@ import ( ) // Lists the specified log groups. You can list all your log groups or filter the -// results by prefix. The results are ASCII-sorted by log group name. CloudWatch -// Logs doesn’t support IAM policies that control access to the DescribeLogGroups -// 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 +// results by prefix. The results are ASCII-sorted by log group name. +// +// CloudWatch Logs doesn’t support IAM policies that control access to the +// DescribeLogGroups 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]. +// +// 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) -// . +// For more information, see [CloudWatch cross-account observability]. +// +// [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 func (c *Client) DescribeLogGroups(ctx context.Context, params *DescribeLogGroupsInput, optFns ...func(*Options)) (*DescribeLogGroupsOutput, error) { if params == nil { params = &DescribeLogGroupsInput{} @@ -45,10 +49,13 @@ type DescribeLogGroupsInput struct { 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 - // 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. + // 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. IncludeLinkedAccounts *bool // The maximum number of items returned. If you don't specify a value, the default @@ -56,24 +63,33 @@ type DescribeLogGroupsInput struct { Limit *int32 // Specifies the log group class for this log group. There are two classes: + // // - The Standard log class supports all CloudWatch Logs features. + // // - The Infrequent Access log class supports a subset of CloudWatch Logs // features and incurs lower costs. - // For details about the features supported by each class, see Log classes (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html) + // + // For details about the features supported by each class, see [Log classes] + // + // [Log classes]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html LogGroupClass types.LogGroupClass // 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. If you - // specify logGroupNamePattern in your request, then only arn , creationTime , and - // logGroupName are included in the response. logGroupNamePattern and - // logGroupNamePrefix are mutually exclusive. Only one of these parameters can be - // passed. + // and GroupFoo would match, but foo , F/o/o and Froo would not match. + // + // If you specify logGroupNamePattern in your request, then only arn , creationTime + // , and logGroupName are included in the response. + // + // logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of + // these parameters can be passed. LogGroupNamePattern *string - // The prefix to match. logGroupNamePrefix and logGroupNamePattern are mutually - // exclusive. Only one of these parameters can be passed. + // The prefix to match. + // + // logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of + // these parameters can be passed. LogGroupNamePrefix *string // The token for the next set of items to return. (You received this token from a @@ -85,8 +101,10 @@ type DescribeLogGroupsInput struct { type DescribeLogGroupsOutput struct { - // The log groups. If the retentionInDays value is not included for a log group, - // then that log group's events do not expire. + // The log groups. + // + // If the retentionInDays value is not included for a log group, then that log + // group's events do not expire. LogGroups []types.LogGroup // The token for the next set of items to return. The token expires after 24 hours. diff --git a/service/cloudwatchlogs/api_op_DescribeLogStreams.go b/service/cloudwatchlogs/api_op_DescribeLogStreams.go index 68912371ed7..a405ca32b4c 100644 --- a/service/cloudwatchlogs/api_op_DescribeLogStreams.go +++ b/service/cloudwatchlogs/api_op_DescribeLogStreams.go @@ -13,14 +13,20 @@ 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 -// 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) -// . +// are ordered. +// +// 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. +// +// 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]. +// +// [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{} @@ -48,16 +54,19 @@ 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 - // both. + // 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. + // The name of the log group. + // + // You must include either logGroupIdentifier or logGroupName , but not both. LogGroupName *string - // The prefix to match. If orderBy is LastEventTime , you cannot specify this - // parameter. + // The prefix to match. + // + // If orderBy is LastEventTime , you cannot specify this parameter. LogStreamNamePrefix *string // The token for the next set of items to return. (You received this token from a @@ -66,13 +75,16 @@ type DescribeLogStreamsInput struct { // 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 - // updates in less than an hour from ingestion, but in rare situations might take - // longer. + // 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 updates in less than an hour from + // ingestion, but in rare situations might take longer. OrderBy types.OrderBy noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go b/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go index ce3fd916861..52406b4d272 100644 --- a/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go +++ b/service/cloudwatchlogs/api_op_DescribeQueryDefinitions.go @@ -13,9 +13,10 @@ import ( // This operation returns a paginated list of your saved CloudWatch Logs Insights // query definitions. You can retrieve query definitions from the current account -// or from a source account that is linked to the current account. You can use the -// queryDefinitionNamePrefix parameter to limit the results to only the query -// definitions that have names that start with a certain string. +// or from a source account that is linked to the current account. +// +// You can use the queryDefinitionNamePrefix parameter to limit the results to +// only the query definitions that have names that start with a certain string. func (c *Client) DescribeQueryDefinitions(ctx context.Context, params *DescribeQueryDefinitionsInput, optFns ...func(*Options)) (*DescribeQueryDefinitionsOutput, error) { if params == nil { params = &DescribeQueryDefinitionsInput{} diff --git a/service/cloudwatchlogs/api_op_DisassociateKmsKey.go b/service/cloudwatchlogs/api_op_DisassociateKmsKey.go index 46fbb668ee5..2cfad0fbe2e 100644 --- a/service/cloudwatchlogs/api_op_DisassociateKmsKey.go +++ b/service/cloudwatchlogs/api_op_DisassociateKmsKey.go @@ -11,25 +11,29 @@ import ( ) // Disassociates the specified KMS key from the specified log group or from all -// CloudWatch Logs Insights query results in the account. When you use -// DisassociateKmsKey , you specify either the logGroupName parameter or the -// resourceIdentifier parameter. You can't specify both of those parameters in the -// same operation. +// CloudWatch Logs Insights query results in the account. +// +// When you use DisassociateKmsKey , you specify either the logGroupName parameter +// or the resourceIdentifier parameter. You can't specify both of those parameters +// in the same operation. +// // - Specify the logGroupName parameter to stop using the KMS key to encrypt // future log events ingested and stored in the log group. Instead, they will be // encrypted with the default CloudWatch Logs method. The log events that were // ingested while the key was associated with the log group are still encrypted // with that key. Therefore, CloudWatch Logs will need permissions for the key // whenever that data is accessed. +// // - Specify the resourceIdentifier parameter with the query-result resource to -// stop using the KMS key to encrypt the results of all future StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) -// operations in the account. They will instead be encrypted with the default -// CloudWatch Logs method. The results from queries that ran while the key was -// associated with the account are still encrypted with that key. Therefore, -// CloudWatch Logs will need permissions for the key whenever that data is -// accessed. +// stop using the KMS key to encrypt the results of all future [StartQuery]operations in the +// account. They will instead be encrypted with the default CloudWatch Logs method. +// The results from queries that ran while the key was associated with the account +// are still encrypted with that key. Therefore, CloudWatch Logs will need +// permissions for the key whenever that data is accessed. // // It can take up to 5 minutes for this operation to take effect. +// +// [StartQuery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html func (c *Client) DisassociateKmsKey(ctx context.Context, params *DisassociateKmsKeyInput, optFns ...func(*Options)) (*DisassociateKmsKeyOutput, error) { if params == nil { params = &DisassociateKmsKeyInput{} @@ -47,25 +51,34 @@ func (c *Client) DisassociateKmsKey(ctx context.Context, params *DisassociateKms type DisassociateKmsKeyInput struct { - // The name of the log group. In your DisassociateKmsKey operation, you must - // specify either the resourceIdentifier parameter or the logGroup parameter, but - // you can't specify both. + // The name of the log group. + // + // In your DisassociateKmsKey operation, you must specify either the + // resourceIdentifier parameter or the logGroup parameter, but you can't specify + // both. LogGroupName *string // Specifies the target for this operation. You must specify one of the following: + // // - Specify the ARN of a log group to stop having CloudWatch Logs use the KMS // key to encrypt log events that are ingested and stored by that log group. After // you run this operation, CloudWatch Logs encrypts ingested log events with the // default CloudWatch Logs method. The log group ARN must be in the following // format. Replace REGION and ACCOUNT_ID with your Region and account ID. - // arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME + // + // arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME + // // - Specify the following ARN to stop using this key to encrypt the results of - // future StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) - // operations in this account. Replace REGION and ACCOUNT_ID with your Region and - // account ID. arn:aws:logs:REGION:ACCOUNT_ID:query-result:* + // future [StartQuery]operations in this account. Replace REGION and ACCOUNT_ID with your + // Region and account ID. + // + // arn:aws:logs:REGION:ACCOUNT_ID:query-result:* + // // In your DisssociateKmsKey operation, you must specify either the // resourceIdentifier parameter or the logGroup parameter, but you can't specify // both. + // + // [StartQuery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html ResourceIdentifier *string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_FilterLogEvents.go b/service/cloudwatchlogs/api_op_FilterLogEvents.go index bc4173fbede..96ed82633cb 100644 --- a/service/cloudwatchlogs/api_op_FilterLogEvents.go +++ b/service/cloudwatchlogs/api_op_FilterLogEvents.go @@ -13,21 +13,29 @@ import ( // Lists log events from the specified log group. You can list all the log events // 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 -// 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 -// means there are more log events available. You can get additional results by -// specifying the token in a subsequent call. This operation can return empty -// results while there are more log events available through the token. The -// returned log events are sorted by event timestamp, the timestamp when the event -// 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) -// . +// 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 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 means there are more log events available. You +// can get additional results by specifying the token in a subsequent call. This +// operation can return empty results while there are more log events available +// through the token. +// +// The returned log events are sorted by event timestamp, the timestamp when the +// event 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]. +// +// [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{} @@ -50,14 +58,18 @@ type FilterLogEventsInput struct { // 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]. + // + // If not provided, all the events are matched. + // + // [Filter and Pattern Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html FilterPattern *string // If the value is true, the operation attempts to provide responses that contain // events from multiple log streams within the log group, interleaved in a single // response. If the value is false, all the matched log events in the first log // stream are searched first, then those in the next log stream, and so on. + // // Important As of June 17, 2019, this parameter is ignored and the value is // assumed to be true. The response from this operation always interleaves events // from multiple log streams within a log group. @@ -72,24 +84,28 @@ 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. + // must use the log group 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. + // The name of the log group to search. + // + // You must include either logGroupIdentifier 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 - // InvalidParameterException error. + // 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 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 - // returns an InvalidParameterException error. + // 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 returns an InvalidParameterException error. LogStreamNames []string // The token for the next set of events to return. (You received this token from a @@ -101,8 +117,10 @@ type FilterLogEventsInput struct { 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, - // you must be signed into an account with the logs:Unmask permission. + // 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 noSmithyDocumentSerde @@ -117,9 +135,11 @@ type FilterLogEventsOutput struct { // 24 hours. NextToken *string - // Important As of May 15, 2020, this parameter is no longer supported. This - // parameter returns an empty list. Indicates which log streams have been searched - // and whether each has been searched completely. + // Important As of May 15, 2020, this parameter is no longer supported. This + // parameter returns an empty list. + // + // Indicates which log streams have been searched and whether each has been + // searched completely. SearchedLogStreams []types.SearchedLogStream // Metadata pertaining to the operation's result. diff --git a/service/cloudwatchlogs/api_op_GetDelivery.go b/service/cloudwatchlogs/api_op_GetDelivery.go index 8c6c5fa7620..239330c92d5 100644 --- a/service/cloudwatchlogs/api_op_GetDelivery.go +++ b/service/cloudwatchlogs/api_op_GetDelivery.go @@ -12,16 +12,20 @@ import ( ) // Returns complete information about one logical delivery. A delivery is a -// connection between a delivery source (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// and a delivery destination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html) -// . A delivery source represents an Amazon Web Services resource that sends logs -// to an logs delivery destination. The destination can be CloudWatch Logs, Amazon -// S3, or Firehose. Only some Amazon Web Services services support being configured -// as a delivery source. These services are listed in Enable logging from Amazon -// Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) +// connection between a [delivery source]and a [delivery destination]. +// +// A delivery source represents an Amazon Web Services resource that sends logs to +// an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, +// or Firehose. Only some Amazon Web Services services support being configured as +// a delivery source. These services are listed in [Enable logging from Amazon Web Services services.] +// // You need to specify the delivery id in this operation. You can find the IDs of -// the deliveries in your account with the DescribeDeliveries (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html) -// operation. +// the deliveries in your account with the [DescribeDeliveries]operation. +// +// [delivery destination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html +// [delivery source]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [Enable logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html +// [DescribeDeliveries]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html func (c *Client) GetDelivery(ctx context.Context, params *GetDeliveryInput, optFns ...func(*Options)) (*GetDeliveryOutput, error) { if params == nil { params = &GetDeliveryInput{} diff --git a/service/cloudwatchlogs/api_op_GetDeliveryDestinationPolicy.go b/service/cloudwatchlogs/api_op_GetDeliveryDestinationPolicy.go index 0677e9f82f7..a4796ef5ea4 100644 --- a/service/cloudwatchlogs/api_op_GetDeliveryDestinationPolicy.go +++ b/service/cloudwatchlogs/api_op_GetDeliveryDestinationPolicy.go @@ -13,8 +13,9 @@ import ( // Retrieves the delivery destination policy assigned to the delivery destination // that you specify. For more information about delivery destinations and their -// policies, see PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// . +// policies, see [PutDeliveryDestinationPolicy]. +// +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html func (c *Client) GetDeliveryDestinationPolicy(ctx context.Context, params *GetDeliveryDestinationPolicyInput, optFns ...func(*Options)) (*GetDeliveryDestinationPolicyOutput, error) { if params == nil { params = &GetDeliveryDestinationPolicyInput{} diff --git a/service/cloudwatchlogs/api_op_GetLogAnomalyDetector.go b/service/cloudwatchlogs/api_op_GetLogAnomalyDetector.go index 9b1e2d42a5a..2beb626a465 100644 --- a/service/cloudwatchlogs/api_op_GetLogAnomalyDetector.go +++ b/service/cloudwatchlogs/api_op_GetLogAnomalyDetector.go @@ -30,9 +30,9 @@ func (c *Client) GetLogAnomalyDetector(ctx context.Context, params *GetLogAnomal type GetLogAnomalyDetectorInput struct { // The ARN of the anomaly detector to retrieve information about. You can find the - // ARNs of log anomaly detectors in your account by using the - // ListLogAnomalyDetectors (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html) - // operation. + // ARNs of log anomaly detectors in your account by using the [ListLogAnomalyDetectors]operation. + // + // [ListLogAnomalyDetectors]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html // // This member is required. AnomalyDetectorArn *string @@ -43,8 +43,9 @@ type GetLogAnomalyDetectorInput struct { type GetLogAnomalyDetectorOutput struct { // Specifies whether the anomaly detector is currently active. To change its - // status, use the enabled parameter in the UpdateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html) - // operation. + // status, use the enabled parameter in the [UpdateLogAnomalyDetector] operation. + // + // [UpdateLogAnomalyDetector]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html AnomalyDetectorStatus types.AnomalyDetectorStatus // The number of days used as the life cycle of anomalies. After this time, diff --git a/service/cloudwatchlogs/api_op_GetLogEvents.go b/service/cloudwatchlogs/api_op_GetLogEvents.go index 5d551c56339..61ec7e584df 100644 --- a/service/cloudwatchlogs/api_op_GetLogEvents.go +++ b/service/cloudwatchlogs/api_op_GetLogEvents.go @@ -12,17 +12,22 @@ import ( ) // Lists log events from the specified log stream. You can list all of the log -// events or filter using a time range. By default, this operation returns as many -// log events as can fit in a response size of 1MB (up to 10,000 log events). You -// can get additional log events by specifying one of the tokens in a subsequent -// call. This operation can return empty results while there are more log events -// 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 +// events or filter using a time range. +// +// By default, this operation returns as many log events as can fit in a response +// size of 1MB (up to 10,000 log events). You can get additional log events by +// specifying one of the tokens in a subsequent call. This operation can return +// empty results while there are more log events 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]. +// +// 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. +// +// [CloudWatch cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html func (c *Client) GetLogEvents(ctx context.Context, params *GetLogEventsInput, optFns ...func(*Options)) (*GetLogEventsOutput, error) { if params == nil { params = &GetLogEventsInput{} @@ -57,12 +62,14 @@ 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. + // use the log 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. + // The name of the log group. + // + // You must include either logGroupIdentifier or logGroupName , but not both. LogGroupName *string // The token for the next set of items to return. (You received this token from a @@ -71,6 +78,7 @@ 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 . StartFromHead *bool @@ -82,8 +90,10 @@ type GetLogEventsInput struct { 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, - // you must be signed into an account with the logs:Unmask permission. + // 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 noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_GetLogGroupFields.go b/service/cloudwatchlogs/api_op_GetLogGroupFields.go index 0b96461f3d7..c1e8c45acea 100644 --- a/service/cloudwatchlogs/api_op_GetLogGroupFields.go +++ b/service/cloudwatchlogs/api_op_GetLogGroupFields.go @@ -13,19 +13,25 @@ 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 -// 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 -// 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) -// . +// 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 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]. +// +// 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]. +// +// [CloudWatch cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html +// [Supported Logs and Discovered Fields]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html func (c *Client) GetLogGroupFields(ctx context.Context, params *GetLogGroupFieldsInput, optFns ...func(*Options)) (*GetLogGroupFieldsOutput, error) { if params == nil { params = &GetLogGroupFieldsInput{} @@ -45,18 +51,22 @@ 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. + // The name of the log group to search. + // + // You must include either logGroupIdentifier or logGroupName , but not both. LogGroupName *string // The time to set as the center of the query. If you specify time , the 8 minutes // before and 8 minutes after this time are searched. If you omit time , the most - // recent 15 minutes up to the current 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 . + // recent 15 minutes up to the current 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 2c22a40e459..a3a8ebbda8f 100644 --- a/service/cloudwatchlogs/api_op_GetLogRecord.go +++ b/service/cloudwatchlogs/api_op_GetLogRecord.go @@ -13,7 +13,9 @@ 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,8 +42,10 @@ 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, - // you must be signed into an account with the logs:Unmask permission. + // 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 noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_GetQueryResults.go b/service/cloudwatchlogs/api_op_GetQueryResults.go index 8f40c7d395b..b86968791e2 100644 --- a/service/cloudwatchlogs/api_op_GetQueryResults.go +++ b/service/cloudwatchlogs/api_op_GetQueryResults.go @@ -11,20 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// . For more information about how long results of previous queries are available, -// see CloudWatch Logs quotas (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html) -// . If the value of the Status field in the output is Running , this operation +// 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] +// operation to get the full log record. +// +// GetQueryResults does not start running a query. To run a query, use [StartQuery]. For more +// information about how long results of previous queries are available, see [CloudWatch Logs quotas]. +// +// 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) -// . +// 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]. +// +// [CloudWatch cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html +// [GetLogRecord]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html +// [CloudWatch Logs quotas]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html +// [StartQuery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInput, optFns ...func(*Options)) (*GetQueryResultsOutput, error) { if params == nil { params = &GetQueryResultsInput{} @@ -54,13 +61,16 @@ type GetQueryResultsOutput struct { // If you associated an KMS key with the CloudWatch Logs Insights query results in // this account, this field displays the ARN of the key that's used to encrypt the - // query results when StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) - // stores them. + // query results when [StartQuery]stores them. + // + // [StartQuery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html EncryptionKey *string // 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 + // 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 // pairs. Results [][]types.ResultField @@ -71,6 +81,7 @@ type GetQueryResultsOutput struct { // 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 60 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. diff --git a/service/cloudwatchlogs/api_op_ListTagsForResource.go b/service/cloudwatchlogs/api_op_ListTagsForResource.go index 48ba8813f12..e1cc4c05ee3 100644 --- a/service/cloudwatchlogs/api_op_ListTagsForResource.go +++ b/service/cloudwatchlogs/api_op_ListTagsForResource.go @@ -29,12 +29,17 @@ 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) - // . + // 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]. + // + // [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 61c69c39771..088e2b4b574 100644 --- a/service/cloudwatchlogs/api_op_ListTagsLogGroup.go +++ b/service/cloudwatchlogs/api_op_ListTagsLogGroup.go @@ -11,10 +11,13 @@ 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) -// instead. Lists the tags for the specified log group. +// you use [ListTagsForResource]instead. +// +// Lists the tags for the specified log group. // // Deprecated: Please use the generic tagging API ListTagsForResource +// +// [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html func (c *Client) ListTagsLogGroup(ctx context.Context, params *ListTagsLogGroupInput, optFns ...func(*Options)) (*ListTagsLogGroupOutput, error) { if params == nil { params = &ListTagsLogGroupInput{} diff --git a/service/cloudwatchlogs/api_op_PutAccountPolicy.go b/service/cloudwatchlogs/api_op_PutAccountPolicy.go index 7a893f43bbc..996125f69b5 100644 --- a/service/cloudwatchlogs/api_op_PutAccountPolicy.go +++ b/service/cloudwatchlogs/api_op_PutAccountPolicy.go @@ -12,55 +12,78 @@ import ( ) // Creates an account-level data protection policy or subscription filter policy -// that applies to all log groups or a subset of log groups in the account. Data -// protection policy A data protection policy can help safeguard sensitive data -// that's ingested by your log groups by auditing and masking the sensitive log -// data. Each account can have only one account-level data protection policy. -// Sensitive data is detected and masked when it is ingested into a log group. When -// you set a data protection policy, log events ingested into the log groups before -// that time are not masked. If you use PutAccountPolicy to create a data -// protection policy for your whole account, it applies to both existing log groups -// and all log groups that are created later in this account. The account-level -// policy is applied to existing log groups with eventual consistency. It might -// take up to 5 minutes before sensitive data in existing log groups begins to be -// masked. By default, when a user views a log event that includes masked data, the +// that applies to all log groups or a subset of log groups in the account. +// +// # Data protection policy +// +// A data protection policy can help safeguard sensitive data that's ingested by +// your log groups by auditing and masking the sensitive log data. Each account can +// have only one account-level data protection policy. +// +// Sensitive data is detected and masked when it is ingested into a log group. +// When you set a data protection policy, log events ingested into the log groups +// before that time are not masked. +// +// If you use PutAccountPolicy to create a data protection policy for your whole +// account, it applies to both existing log groups and all log groups that are +// created later in this account. The account-level policy is applied to existing +// log groups with eventual consistency. It might take up to 5 minutes before +// sensitive data in existing log groups begins to be 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) -// . To use the PutAccountPolicy operation for a data protection policy, you must -// be signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy -// permissions. The PutAccountPolicy operation applies to all log groups in the -// account. You can use PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html) -// to create a data protection policy that applies to just one log group. If a log -// group has its own data protection policy and the account also has an +// permission can use a [GetLogEvents]or [FilterLogEvents] 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]. +// +// To use the PutAccountPolicy operation for a data protection policy, you must be +// signed on with the logs:PutDataProtectionPolicy and logs:PutAccountPolicy +// permissions. +// +// The PutAccountPolicy operation applies to all log groups in the account. You +// can use [PutDataProtectionPolicy]to create a data protection policy that applies to just one log group. +// If a log group has its own data protection policy and the account also has an // account-level data protection policy, then the two policies are cumulative. Any -// sensitive term specified in either policy is masked. Subscription filter policy +// sensitive term specified in either policy is masked. +// +// # Subscription filter policy +// // A subscription filter policy sets up a real-time feed of log events from // CloudWatch Logs to other Amazon Web Services services. Account-level // subscription filter policies apply to both existing log groups and log groups // that are created later in this account. Supported destinations are Kinesis Data // Streams, Firehose, and Lambda. 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: +// service, they are Base64 encoded and compressed with the GZIP format. +// +// The following destinations are supported for subscription filters: +// // - An Kinesis Data Streams data stream in the same account as the subscription // policy, for same-account delivery. +// // - An Firehose data stream in the same account as the subscription policy, for // same-account delivery. +// // - A Lambda function in the same account as the subscription policy, for // same-account delivery. -// - A logical destination in a different account created with PutDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html) -// , for cross-account delivery. Kinesis Data Streams and Firehose are supported as +// +// - A logical destination in a different account created with [PutDestination], for +// cross-account delivery. Kinesis Data Streams and Firehose are supported as // logical destinations. // // Each account can have one account-level subscription filter policy. If you are // updating an existing filter, you must specify the correct name in PolicyName . // To perform a PutAccountPolicy subscription filter operation for any destination // except a Lambda function, you must also have the iam:PassRole permission. +// +// [PutDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html +// [PutDataProtectionPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html +// [Protect sensitive log data with masking]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html +// [FilterLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html +// [GetLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html func (c *Client) PutAccountPolicy(ctx context.Context, params *PutAccountPolicyInput, optFns ...func(*Options)) (*PutAccountPolicyOutput, error) { if params == nil { params = &PutAccountPolicyInput{} @@ -78,53 +101,79 @@ func (c *Client) PutAccountPolicy(ctx context.Context, params *PutAccountPolicyI type PutAccountPolicyInput struct { - // Specify the policy, in JSON. Data protection policy A data protection policy - // must include two JSON blocks: + // Specify the policy, in JSON. + // + // Data protection policy + // + // A data protection 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, Firehose streams, and S3 buckets, they must already exist. + // options, see [Types of data that you can mask]. + // + // 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, 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. + // 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 the two DataIdentifer arrays must match exactly. In addition to - // the two JSON blocks, the policyDocument can also include Name , Description , - // and Version fields. The Name is different than the operation's policyName - // parameter, and is used as a dimension when CloudWatch Logs reports audit - // findings metrics to CloudWatch. The JSON specified in policyDocument can be up - // to 30,720 characters long. Subscription filter policy A subscription filter - // policy can include the following attributes in a JSON block: + // + // The contents of the two DataIdentifer arrays must match exactly. + // + // In addition to the two JSON blocks, the policyDocument can also include Name , + // Description , and Version fields. The Name is different than the operation's + // policyName parameter, and is used as a dimension when CloudWatch Logs reports + // audit findings metrics to CloudWatch. + // + // The JSON specified in policyDocument can be up to 30,720 characters long. + // + // Subscription filter policy + // + // A subscription filter policy can include the following attributes in a JSON + // block: + // // - DestinationArn The ARN of the destination to deliver log events to. // Supported destinations are: + // // - An Kinesis Data Streams data stream in the same account as the subscription // policy, for same-account delivery. + // // - An Firehose data stream in the same account as the subscription policy, for // same-account delivery. + // // - A Lambda function in the same account as the subscription policy, for // same-account delivery. - // - A logical destination in a different account created with PutDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html) - // , for cross-account delivery. Kinesis Data Streams and Firehose are supported as + // + // - A logical destination in a different account created with [PutDestination], for + // cross-account delivery. Kinesis Data Streams and Firehose are supported as // logical destinations. + // // - RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to // deliver ingested log events to the destination stream. You don't need to provide // the ARN when you are working with a logical destination for cross-account // delivery. + // // - FilterPattern A filter pattern for subscribing to a filtered stream of log // events. + // // - DistributionThe method used to distribute log data to the destination. By // default, log data is grouped by log stream, but the grouping can be set to // Random for a more even distribution. This property is only applicable when the // destination is an Kinesis Data Streams data stream. // + // [PutDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html + // [Types of data that you can mask]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html + // // This member is required. PolicyDocument *string @@ -146,11 +195,15 @@ type PutAccountPolicyInput struct { // Use this parameter to apply the subscription filter policy to a subset of log // groups in the account. Currently, the only supported filter is LogGroupName NOT // IN [] . The selectionCriteria string can be up to 25KB in length. The length is - // determined by using its UTF-8 bytes. Using the selectionCriteria parameter is - // useful to help prevent infinite loops. For more information, see Log recursion - // prevention (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions-recursion-prevention.html) - // . Specifing selectionCriteria is valid only when you specify + // determined by using its UTF-8 bytes. + // + // Using the selectionCriteria parameter is useful to help prevent infinite loops. + // For more information, see [Log recursion prevention]. + // + // Specifing selectionCriteria is valid only when you specify // SUBSCRIPTION_FILTER_POLICY for policyType . + // + // [Log recursion prevention]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions-recursion-prevention.html SelectionCriteria *string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go b/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go index 58ffd49a42f..89845973920 100644 --- a/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go +++ b/service/cloudwatchlogs/api_op_PutDataProtectionPolicy.go @@ -12,25 +12,34 @@ import ( // Creates a data protection policy for the specified log group. A data protection // policy can help safeguard sensitive data that's ingested by the log group by -// auditing and masking the sensitive log data. Sensitive data is detected and -// masked when it is ingested into the log group. When you set a data protection -// policy, log events ingested into the log group before that time are not masked. +// auditing and masking the sensitive log data. +// +// Sensitive data is detected and masked when it is ingested into the log group. +// When you set a data protection 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) -// . The PutDataProtectionPolicy operation applies to only the specified log -// group. You can also use PutAccountPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html) -// to create an account-level data protection policy that applies to all log groups -// in the account, including both existing log groups and log groups that are -// created level. If a log group has its own data protection policy and the account -// also has an account-level data protection policy, then the two policies are -// cumulative. Any sensitive term specified in either policy is masked. +// permission can use a [GetLogEvents]or [FilterLogEvents] 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]. +// +// The PutDataProtectionPolicy operation applies to only the specified log group. +// You can also use [PutAccountPolicy]to create an account-level data protection policy that applies +// to all log groups in the account, including both existing log groups and log +// groups that are created level. If a log group has its own data protection policy +// and the account also has an account-level data protection policy, then the two +// policies are cumulative. Any sensitive term specified in either policy is +// masked. +// +// [Protect sensitive log data with masking]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html +// [FilterLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html +// [PutAccountPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html +// [GetLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html func (c *Client) PutDataProtectionPolicy(ctx context.Context, params *PutDataProtectionPolicyInput, optFns ...func(*Options)) (*PutDataProtectionPolicyOutput, error) { if params == nil { params = &PutDataProtectionPolicyInput{} @@ -53,29 +62,40 @@ type PutDataProtectionPolicyInput struct { // This member is required. LogGroupIdentifier *string - // Specify the data protection policy, in JSON. This policy must include two JSON - // blocks: + // 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, Firehose streams, and S3 buckets, they must already exist. + // options, see [Types of data that you can mask]. + // + // 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, 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. + // 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 the two DataIdentifer arrays must match exactly. In addition to - // the two JSON blocks, the policyDocument can also include Name , Description , - // and Version fields. The Name is used as a dimension when CloudWatch Logs - // reports audit findings metrics to CloudWatch. The JSON specified in - // policyDocument can be up to 30,720 characters. + // + // The contents of the two DataIdentifer arrays must match exactly. + // + // In addition to the two JSON blocks, the policyDocument can also include Name , + // Description , and Version fields. The Name is used as a dimension when + // CloudWatch Logs reports audit findings metrics to CloudWatch. + // + // The JSON specified in policyDocument can be up to 30,720 characters. + // + // [Types of data that you can mask]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html // // This member is required. PolicyDocument *string diff --git a/service/cloudwatchlogs/api_op_PutDeliveryDestination.go b/service/cloudwatchlogs/api_op_PutDeliveryDestination.go index ddf1a1dbf8e..b241887ca52 100644 --- a/service/cloudwatchlogs/api_op_PutDeliveryDestination.go +++ b/service/cloudwatchlogs/api_op_PutDeliveryDestination.go @@ -14,31 +14,40 @@ import ( // Creates or updates a logical delivery destination. A delivery destination is an // Amazon Web Services resource that represents an Amazon Web Services service that // logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as -// logs delivery destinations. To configure logs delivery between a supported -// Amazon Web Services service and a destination, you must do the following: +// logs delivery destinations. +// +// To configure logs delivery between a supported Amazon Web Services service and +// a destination, you must do the following: +// // - Create a delivery source, which is a logical object that represents the -// resource that is actually sending the logs. For more information, see -// PutDeliverySource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// . +// resource that is actually sending the logs. For more information, see [PutDeliverySource]. +// // - Use PutDeliveryDestination to create a delivery destination, which is a // logical object that represents the actual delivery destination. -// - If you are delivering logs cross-account, you must use -// PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// in the destination account to assign an IAM policy to the destination. This -// policy allows delivery to that destination. +// +// - If you are delivering logs cross-account, you must use [PutDeliveryDestinationPolicy]in the destination +// account to assign an IAM policy to the destination. This policy allows delivery +// to that destination. +// // - Use CreateDelivery to create a delivery by pairing exactly one delivery -// source and one delivery destination. For more information, see CreateDelivery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) -// . +// source and one delivery destination. For more information, see [CreateDelivery]. // // You can configure a single delivery source to send logs to multiple // destinations by creating multiple deliveries. You can also create multiple // deliveries to configure multiple delivery sources to send logs to the same -// delivery destination. Only some Amazon Web Services services support being -// configured as a delivery source. These services are listed as Supported [V2 -// Permissions] in the table at Enabling logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) +// delivery destination. +// +// Only some Amazon Web Services services support being configured as a delivery +// source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from Amazon Web Services services.] +// // If you use this operation to update an existing delivery destination, all the // current delivery destination parameters are overwritten with the new parameter // values that you specify. +// +// [PutDeliverySource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [Enabling logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html +// [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html func (c *Client) PutDeliveryDestination(ctx context.Context, params *PutDeliveryDestinationInput, optFns ...func(*Options)) (*PutDeliveryDestinationOutput, error) { if params == nil { params = &PutDeliveryDestinationInput{} @@ -71,8 +80,11 @@ type PutDeliveryDestinationInput struct { // The format for the logs that this delivery destination will receive. OutputFormat types.OutputFormat - // 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) + // An optional list of key-value pairs to associate with the resource. + // + // For more information about tagging, see [Tagging Amazon Web Services resources] + // + // [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_PutDeliveryDestinationPolicy.go b/service/cloudwatchlogs/api_op_PutDeliveryDestinationPolicy.go index aa4bc90c8ba..656f5095087 100644 --- a/service/cloudwatchlogs/api_op_PutDeliveryDestinationPolicy.go +++ b/service/cloudwatchlogs/api_op_PutDeliveryDestinationPolicy.go @@ -16,26 +16,30 @@ import ( // configure the delivery of logs from an Amazon Web Services service in another // account to a logs delivery destination in the current account, you must do the // following: +// // - Create a delivery source, which is a logical object that represents the -// resource that is actually sending the logs. For more information, see -// PutDeliverySource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// . +// resource that is actually sending the logs. For more information, see [PutDeliverySource]. +// // - Create a delivery destination, which is a logical object that represents -// the actual delivery destination. For more information, see -// PutDeliveryDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html) -// . +// the actual delivery destination. For more information, see [PutDeliveryDestination]. +// // - Use this operation in the destination account to assign an IAM policy to // the destination. This policy allows delivery to that destination. +// // - Create a delivery by pairing exactly one delivery source and one delivery -// destination. For more information, see CreateDelivery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) -// . +// destination. For more information, see [CreateDelivery]. // // Only some Amazon Web Services services support being configured as a delivery -// source. These services are listed as Supported [V2 Permissions] in the table at -// Enabling logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) +// source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from Amazon Web Services services.] +// // The contents of the policy must include two statements. One statement enables // general logs delivery, and the other allows delivery to the chosen destination. // See the examples for the needed policies. +// +// [PutDeliveryDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html +// [PutDeliverySource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [Enabling logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html +// [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html func (c *Client) PutDeliveryDestinationPolicy(ctx context.Context, params *PutDeliveryDestinationPolicyInput, optFns ...func(*Options)) (*PutDeliveryDestinationPolicyOutput, error) { if params == nil { params = &PutDeliveryDestinationPolicyInput{} diff --git a/service/cloudwatchlogs/api_op_PutDeliverySource.go b/service/cloudwatchlogs/api_op_PutDeliverySource.go index ae6e6903f93..db7f3bcc972 100644 --- a/service/cloudwatchlogs/api_op_PutDeliverySource.go +++ b/service/cloudwatchlogs/api_op_PutDeliverySource.go @@ -13,32 +13,42 @@ import ( // Creates or updates a logical delivery source. A delivery source represents an // Amazon Web Services resource that sends logs to an logs delivery destination. -// The destination can be CloudWatch Logs, Amazon S3, or Firehose. To configure -// logs delivery between a delivery destination and an Amazon Web Services service -// that is supported as a delivery source, you must do the following: +// The destination can be CloudWatch Logs, Amazon S3, or Firehose. +// +// To configure logs delivery between a delivery destination and an Amazon Web +// Services service that is supported as a delivery source, you must do the +// following: +// // - Use PutDeliverySource to create a delivery source, which is a logical object // that represents the resource that is actually sending the logs. +// // - Use PutDeliveryDestination to create a delivery destination, which is a // logical object that represents the actual delivery destination. For more -// information, see PutDeliveryDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html) -// . -// - If you are delivering logs cross-account, you must use -// PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// in the destination account to assign an IAM policy to the destination. This -// policy allows delivery to that destination. +// information, see [PutDeliveryDestination]. +// +// - If you are delivering logs cross-account, you must use [PutDeliveryDestinationPolicy]in the destination +// account to assign an IAM policy to the destination. This policy allows delivery +// to that destination. +// // - Use CreateDelivery to create a delivery by pairing exactly one delivery -// source and one delivery destination. For more information, see CreateDelivery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) -// . +// source and one delivery destination. For more information, see [CreateDelivery]. // // You can configure a single delivery source to send logs to multiple // destinations by creating multiple deliveries. You can also create multiple // deliveries to configure multiple delivery sources to send logs to the same -// delivery destination. Only some Amazon Web Services services support being -// configured as a delivery source. These services are listed as Supported [V2 -// Permissions] in the table at Enabling logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) -// If you use this operation to update an existing delivery source, all the current -// delivery source parameters are overwritten with the new parameter values that -// you specify. +// delivery destination. +// +// Only some Amazon Web Services services support being configured as a delivery +// source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from Amazon Web Services services.] +// +// If you use this operation to update an existing delivery source, all the +// current delivery source parameters are overwritten with the new parameter values +// that you specify. +// +// [PutDeliveryDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html +// [Enabling logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html +// [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html func (c *Client) PutDeliverySource(ctx context.Context, params *PutDeliverySourceInput, optFns ...func(*Options)) (*PutDeliverySourceOutput, error) { if params == nil { params = &PutDeliverySourceInput{} @@ -57,8 +67,11 @@ func (c *Client) PutDeliverySource(ctx context.Context, params *PutDeliverySourc type PutDeliverySourceInput struct { // Defines the type of log that the source is sending. + // // - For Amazon CodeWhisperer, the valid value is EVENT_LOGS . + // // - For IAM Identity Centerr, the valid value is ERROR_LOGS . + // // - For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS , // AUTHENTICATION_LOGS , WORKMAIL_AVAILABILITY_PROVIDER_LOGS , and // WORKMAIL_MAILBOX_ACCESS_LOGS . @@ -79,8 +92,11 @@ type PutDeliverySourceInput struct { // This member is required. ResourceArn *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) + // An optional list of key-value pairs to associate with the resource. + // + // For more information about tagging, see [Tagging Amazon Web Services resources] + // + // [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_PutDestination.go b/service/cloudwatchlogs/api_op_PutDestination.go index 89327ba821b..921abd31271 100644 --- a/service/cloudwatchlogs/api_op_PutDestination.go +++ b/service/cloudwatchlogs/api_op_PutDestination.go @@ -12,17 +12,23 @@ import ( ) // Creates or updates a destination. This operation is used only to create -// 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 +// 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]. +// +// 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) -// 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. +// which means a cross-account user cannot call [PutSubscriptionFilter]against this destination. To +// enable this, the destination owner must call [PutDestinationPolicy]after PutDestination . +// +// To perform a PutDestination operation, you must also have the iam:PassRole +// permission. +// +// [PutSubscriptionFilter]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html +// [PutLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html +// [PutDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html func (c *Client) PutDestination(ctx context.Context, params *PutDestinationInput, optFns ...func(*Options)) (*PutDestinationOutput, error) { if params == nil { params = &PutDestinationInput{} @@ -56,8 +62,11 @@ type PutDestinationInput struct { // This member is required. 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) + // An optional list of key-value pairs to associate with the resource. + // + // For more information about tagging, see [Tagging Amazon Web Services resources] + // + // [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 37cfd9c5159..a754cb62ad2 100644 --- a/service/cloudwatchlogs/api_op_PutDestinationPolicy.go +++ b/service/cloudwatchlogs/api_op_PutDestinationPolicy.go @@ -11,9 +11,10 @@ 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]that is used to authorize claims to register a subscription +// filter against a given destination. +// +// [IAM policy document]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html func (c *Client) PutDestinationPolicy(ctx context.Context, params *PutDestinationPolicyInput, optFns ...func(*Options)) (*PutDestinationPolicyOutput, error) { if params == nil { params = &PutDestinationPolicyInput{} @@ -48,9 +49,11 @@ type PutDestinationPolicyInput struct { // 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) + // updated the subscription filters. For more information, see [Updating an existing cross-account subscription] + // // If you omit this parameter, the default of false is used. + // + // [Updating an existing cross-account subscription]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html ForceUpdate *bool noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_PutLogEvents.go b/service/cloudwatchlogs/api_op_PutLogEvents.go index 492a46c9ff8..e8e21507e2b 100644 --- a/service/cloudwatchlogs/api_op_PutLogEvents.go +++ b/service/cloudwatchlogs/api_op_PutLogEvents.go @@ -11,28 +11,38 @@ 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 +// 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: +// 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. +// // - Each log event can be no larger than 256 KB. +// // - 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 @@ -72,11 +82,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 @@ -84,11 +94,15 @@ type PutLogEventsInput struct { type PutLogEventsOutput struct { - // The next sequence token. This field has been deprecated. The sequence token is - // now ignored in PutLogEvents actions. PutLogEvents actions are always accepted - // even if the sequence token is not valid. You can use parallel PutLogEvents - // actions on the same log stream and you do not need to wait for the response of a - // previous PutLogEvents action to obtain the nextSequenceToken value. + // The next sequence token. + // + // This field has been deprecated. + // + // The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions + // are always accepted even if the sequence token is not valid. You can use + // parallel PutLogEvents actions on the same log stream and you do not need to + // wait for the response of a previous PutLogEvents action to obtain the + // nextSequenceToken value. NextSequenceToken *string // The rejected events. diff --git a/service/cloudwatchlogs/api_op_PutMetricFilter.go b/service/cloudwatchlogs/api_op_PutMetricFilter.go index 41ebeeaa77e..55ed0f4ec33 100644 --- a/service/cloudwatchlogs/api_op_PutMetricFilter.go +++ b/service/cloudwatchlogs/api_op_PutMetricFilter.go @@ -13,19 +13,28 @@ 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 -// accrues charges as a separate custom metric. CloudWatch Logs might disable a -// metric filter if it generates 1,000 different name/value pairs for your -// specified dimensions within one hour. 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) -// . +// log events ingested through [PutLogEvents]. +// +// 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 might disable a metric filter if it generates 1,000 different +// name/value pairs for your specified dimensions within one hour. +// +// 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]. +// +// [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 +// [PutLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.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 651272ba3c6..d53c6574a50 100644 --- a/service/cloudwatchlogs/api_op_PutQueryDefinition.go +++ b/service/cloudwatchlogs/api_op_PutQueryDefinition.go @@ -11,15 +11,20 @@ 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. +// information, see [Analyzing Log Data with CloudWatch Logs Insights]. +// +// 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 -// perform this operation. +// log groups. +// +// You must have the logs:PutQueryDefinition permission to be able to perform this +// operation. +// +// [Analyzing Log Data with CloudWatch Logs Insights]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html func (c *Client) PutQueryDefinition(ctx context.Context, params *PutQueryDefinitionInput, optFns ...func(*Options)) (*PutQueryDefinitionOutput, error) { if params == nil { params = &PutQueryDefinitionInput{} @@ -40,34 +45,42 @@ 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]. + // + // [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) - // . + // The query string to use for this definition. For more information, see [CloudWatch Logs Insights Query Syntax]. + // + // [CloudWatch Logs Insights Query Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html // // This member is required. QueryString *string // Used as an idempotency token, to avoid returning an exception if the service - // receives the same request twice because of a network error. + // receives the same request twice because of a network + // + // error. ClientToken *string // Use this parameter to include specific log groups as part of your query - // definition. If you are updating a query definition and you omit this parameter, - // then the updated definition will contain no log groups. + // definition. + // + // If you are updating a query definition and you omit this parameter, then the + // updated definition will contain no log groups. LogGroupNames []string // 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) - // 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. + // the query definition that you want to update. You can use [DescribeQueryDefinitions]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. + // + // [DescribeQueryDefinitions]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html QueryDefinitionId *string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_PutResourcePolicy.go b/service/cloudwatchlogs/api_op_PutResourcePolicy.go index 2de8fd9887d..adb8559981c 100644 --- a/service/cloudwatchlogs/api_op_PutResourcePolicy.go +++ b/service/cloudwatchlogs/api_op_PutResourcePolicy.go @@ -33,20 +33,27 @@ type PutResourcePolicyInput struct { // Details of the new policy, including the identity of the principal that is // enabled to put logs to this account. This is formatted as a JSON string. This - // 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) - // 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" } } } ] } + // 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] and [aws: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" } } } ] } + // + // [aws:SourceAccount]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount + // [aws:SourceArn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn 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 158bed25443..7c75f65bd65 100644 --- a/service/cloudwatchlogs/api_op_PutRetentionPolicy.go +++ b/service/cloudwatchlogs/api_op_PutRetentionPolicy.go @@ -12,21 +12,25 @@ import ( // Sets the retention of the specified log group. With a retention policy, you can // configure the number of days for which to retain log events in the specified log -// group. CloudWatch Logs doesn’t immediately delete log events when they reach -// their retention setting. It typically takes up to 72 hours after that before log -// events are deleted, but in rare situations might take longer. To illustrate, -// imagine that you change a log group to have a longer retention setting when it -// contains log events that are past the expiration date, but haven’t been deleted. -// Those log events will take up to 72 hours to be deleted after the new retention -// date is reached. To make sure that log data is deleted permanently, keep a log -// group at its lower retention setting until 72 hours after the previous retention -// period ends. Alternatively, wait to change the retention setting until you -// confirm that the earlier log events are deleted. When log events reach their -// retention setting they are marked for deletion. After they are marked for -// deletion, they do not add to your archival storage costs anymore, even if they -// are not actually deleted until later. These log events marked for deletion are -// also not included when you use an API to retrieve the storedBytes value to see -// how many bytes a log group is storing. +// group. +// +// CloudWatch Logs doesn’t immediately delete log events when they reach their +// retention setting. It typically takes up to 72 hours after that before log +// events are deleted, but in rare situations might take longer. +// +// To illustrate, imagine that you change a log group to have a longer retention +// setting when it contains log events that are past the expiration date, but +// haven’t been deleted. Those log events will take up to 72 hours to be deleted +// after the new retention date is reached. To make sure that log data is deleted +// permanently, keep a log group at its lower retention setting until 72 hours +// after the previous retention period ends. Alternatively, wait to change the +// retention setting until you confirm that the earlier log events are deleted. +// +// When log events reach their retention setting they are marked for deletion. +// After they are marked for deletion, they do not add to your archival storage +// costs anymore, even if they are not actually deleted until later. These log +// events marked for deletion are also not included when you use an API to retrieve +// the storedBytes value to see how many bytes a log group is storing. func (c *Client) PutRetentionPolicy(ctx context.Context, params *PutRetentionPolicyInput, optFns ...func(*Options)) (*PutRetentionPolicyOutput, error) { if params == nil { params = &PutRetentionPolicyInput{} @@ -51,9 +55,11 @@ type PutRetentionPolicyInput struct { // 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, 1096, 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) - // . + // 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. + // + // To set a log group so that its log events do not expire, use [DeleteRetentionPolicy]. + // + // [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 91e999f12de..4b6f97151b5 100644 --- a/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go +++ b/service/cloudwatchlogs/api_op_PutSubscriptionFilter.go @@ -13,24 +13,34 @@ 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) -// 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: +// log events ingested through [PutLogEvents]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 created with PutDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html) -// that belongs to a different account, for cross-account delivery. We currently -// support Kinesis Data Streams and Firehose as logical destinations. +// +// - A logical destination created with [PutDestination]that belongs to a different account, for +// cross-account delivery. We currently support Kinesis Data Streams and Firehose +// as logical destinations. +// // - 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 for any destination -// except a Lambda function, you must also have the iam:PassRole permission. +// filterName . +// +// To perform a PutSubscriptionFilter operation for any destination except a +// Lambda function, you must also have the iam:PassRole permission. +// +// [PutDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html +// [PutLogEvents]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html func (c *Client) PutSubscriptionFilter(ctx context.Context, params *PutSubscriptionFilterInput, optFns ...func(*Options)) (*PutSubscriptionFilterOutput, error) { if params == nil { params = &PutSubscriptionFilterInput{} @@ -50,26 +60,33 @@ 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) - // . + // 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]. + // // - 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. // + // [PutDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html + // // 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) - // . + // currently associated with a log group, use [DescribeSubscriptionFilters]. + // + // [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_StartLiveTail.go b/service/cloudwatchlogs/api_op_StartLiveTail.go index 92f3566bb51..41a94ffe77d 100644 --- a/service/cloudwatchlogs/api_op_StartLiveTail.go +++ b/service/cloudwatchlogs/api_op_StartLiveTail.go @@ -15,36 +15,51 @@ import ( // Starts a Live Tail streaming session for one or more log groups. A Live Tail // session returns a stream of log events that have been recently ingested in the -// log groups. For more information, see Use Live Tail to view logs in near real -// time (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html) -// . The response to this operation is a response stream, over which the server -// sends live log events and the client receives them. The following objects are -// sent over the stream: -// - A single LiveTailSessionStart (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionStart.html) -// object is sent at the start of the session. -// - Every second, a LiveTailSessionUpdate (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionUpdate.html) -// object is sent. Each of these objects contains an array of the actual log -// events. If no new log events were ingested in the past second, the -// LiveTailSessionUpdate object will contain an empty array. The array of log -// events contained in a LiveTailSessionUpdate can include as many as 500 log -// events. If the number of log events matching the request exceeds 500 per second, -// the log events are sampled down to 500 log events to be included in each -// LiveTailSessionUpdate object. If your client consumes the log events slower -// than the server produces them, CloudWatch Logs buffers up to 10 -// LiveTailSessionUpdate events or 5000 log events, after which it starts -// dropping the oldest events. -// - A SessionStreamingException (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionStreamingException.html) -// object is returned if an unknown error occurs on the server side. -// - A SessionTimeoutException (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionTimeoutException.html) -// object is returned when the session times out, after it has been kept open for -// three hours. +// log groups. For more information, see [Use Live Tail to view logs in near real time]. +// +// The response to this operation is a response stream, over which the server +// sends live log events and the client receives them. +// +// The following objects are sent over the stream: +// +// - A single [LiveTailSessionStart]object is sent at the start of the session. +// +// - Every second, a [LiveTailSessionUpdate]object is sent. Each of these objects contains an array of +// the actual log events. +// +// If no new log events were ingested in the past second, the LiveTailSessionUpdate +// +// object will contain an empty array. +// +// The array of log events contained in a LiveTailSessionUpdate can include as many +// +// as 500 log events. If the number of log events matching the request exceeds 500 +// per second, the log events are sampled down to 500 log events to be included in +// each LiveTailSessionUpdate object. +// +// If your client consumes the log events slower than the server produces them, +// +// CloudWatch Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log +// events, after which it starts dropping the oldest events. +// +// - A [SessionStreamingException]object is returned if an unknown error occurs on the server side. +// +// - A [SessionTimeoutException]object is returned when the session times out, after it has been kept +// open for three hours. // // You can end a session before it times out by closing the session stream or by // closing the client that is receiving the stream. The session also ends if the -// established connection between the client and the server breaks. For examples of -// using an SDK to start a Live Tail session, see Start a Live Tail session using -// an Amazon Web Services SDK (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/example_cloudwatch-logs_StartLiveTail_section.html) -// . +// established connection between the client and the server breaks. +// +// For examples of using an SDK to start a Live Tail session, see [Start a Live Tail session using an Amazon Web Services SDK]. +// +// [LiveTailSessionStart]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionStart.html +// [LiveTailSessionUpdate]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionUpdate.html +// [Use Live Tail to view logs in near real time]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html +// [Start a Live Tail session using an Amazon Web Services SDK]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/example_cloudwatch-logs_StartLiveTail_section.html +// +// [SessionTimeoutException]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionTimeoutException.html +// [SessionStreamingException]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionStreamingException.html func (c *Client) StartLiveTail(ctx context.Context, params *StartLiveTailInput, optFns ...func(*Options)) (*StartLiveTailOutput, error) { if params == nil { params = &StartLiveTailInput{} @@ -63,8 +78,13 @@ func (c *Client) StartLiveTail(ctx context.Context, params *StartLiveTailInput, type StartLiveTailInput struct { // An array where each item in the array is a log group to include in the Live - // Tail session. Specify each log group by its ARN. If you specify an ARN, the ARN - // can't end with an asterisk (*). You can include up to 10 log groups. + // Tail session. + // + // Specify each log group by its ARN. + // + // If you specify an ARN, the ARN can't end with an asterisk (*). + // + // You can include up to 10 log groups. // // This member is required. LogGroupIdentifiers []string @@ -72,22 +92,33 @@ type StartLiveTailInput struct { // An optional pattern to use to filter the results to include only log events // that match the pattern. For example, a filter pattern of error 404 causes only // log events that include both error and 404 to be included in the Live Tail - // stream. Regular expression filter patterns are supported. For more information - // about filter pattern syntax, see Filter and Pattern Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) - // . + // stream. + // + // Regular expression filter patterns are supported. + // + // For more information about filter pattern syntax, see [Filter and Pattern Syntax]. + // + // [Filter and Pattern Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html LogEventFilterPattern *string // If you specify this parameter, then only log events in the log streams that // have names that start with the prefixes that you specify here are included in - // the Live Tail session. If you specify this field, you can't also specify the - // logStreamNames field. You can specify this parameter only if you specify only - // one log group in logGroupIdentifiers . + // the Live Tail session. + // + // If you specify this field, you can't also specify the logStreamNames field. + // + // You can specify this parameter only if you specify only one log group in + // logGroupIdentifiers . LogStreamNamePrefixes []string // If you specify this parameter, then only log events in the log streams that you - // specify here are included in the Live Tail session. If you specify this field, - // you can't also specify the logStreamNamePrefixes field. You can specify this - // parameter only if you specify only one log group in logGroupIdentifiers . + // specify here are included in the Live Tail session. + // + // If you specify this field, you can't also specify the logStreamNamePrefixes + // field. + // + // You can specify this parameter only if you specify only one log group in + // logGroupIdentifiers . LogStreamNames []string noSmithyDocumentSerde diff --git a/service/cloudwatchlogs/api_op_StartQuery.go b/service/cloudwatchlogs/api_op_StartQuery.go index 3f55512254b..19186d75314 100644 --- a/service/cloudwatchlogs/api_op_StartQuery.go +++ b/service/cloudwatchlogs/api_op_StartQuery.go @@ -11,24 +11,35 @@ import ( ) // 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) -// . After you run a query using StartQuery , the query results are stored by -// CloudWatch Logs. You can use GetQueryResults (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html) -// to retrieve the results of a query, using the queryId that StartQuery returns. -// If you have associated a KMS key with the query results in this account, then -// StartQuery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html) +// the log group and time range to query and the query string to use. +// +// For more information, see [CloudWatch Logs Insights Query Syntax]. +// +// After you run a query using StartQuery , the query results are stored by +// CloudWatch Logs. You can use [GetQueryResults]to retrieve the results of a query, using the +// queryId that StartQuery returns. +// +// If you have associated a KMS key with the query results in this account, then [StartQuery] // uses that key to encrypt the results when it stores them. If no key is // associated with query results, the query results are encrypted with the default -// CloudWatch Logs encryption method. Queries time out after 60 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 30 concurrent CloudWatch -// Logs insights queries, including queries that have been added to dashboards. +// CloudWatch Logs encryption method. +// +// Queries time out after 60 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]. For a cross-account StartQuery operation, the query +// definition must be defined in the monitoring account. +// +// You can have up to 30 concurrent CloudWatch Logs insights queries, including +// queries that have been added to dashboards. +// +// [CloudWatch Logs Insights Query Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html +// [CloudWatch cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html +// [GetQueryResults]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html +// [StartQuery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns ...func(*Options)) (*StartQueryOutput, error) { if params == nil { params = &StartQueryInput{} @@ -53,9 +64,9 @@ type StartQueryInput struct { // 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) - // . + // The query string to use. For more information, see [CloudWatch Logs Insights Query Syntax]. + // + // [CloudWatch Logs Insights Query Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html // // This member is required. QueryString *string @@ -72,22 +83,28 @@ type StartQueryInput struct { // returned. The default is 1000. Limit *int32 - // The list of log groups to query. You can include up to 50 log groups. You can - // specify them by the log group name or ARN. If a log group that you're querying - // is in a source account and you're using a monitoring account, you must specify - // 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 . + // The list of log groups to query. You can include up to 50 log groups. + // + // You can specify them by the log group name or ARN. If a log group that you're + // querying is in a source account and you're using a monitoring account, you must + // specify 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 . 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: + // 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 . LogGroupNames []string diff --git a/service/cloudwatchlogs/api_op_TagLogGroup.go b/service/cloudwatchlogs/api_op_TagLogGroup.go index 77d05cd9ee1..fde3ee6e8f1 100644 --- a/service/cloudwatchlogs/api_op_TagLogGroup.go +++ b/service/cloudwatchlogs/api_op_TagLogGroup.go @@ -11,19 +11,25 @@ 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) -// 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) -// 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) -// . +// use [TagResource]instead. +// +// Adds or updates the specified tags for the specified log group. +// +// To list the tags for a log group, use [ListTagsForResource]. To remove tags, use [UntagResource]. +// +// For more information about tags, see [Tag Log Groups in Amazon CloudWatch Logs] 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]. // // Deprecated: Please use the generic tagging API TagResource +// +// [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html +// [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html +// [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 +// [Controlling access to Amazon Web Services resources using tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html func (c *Client) TagLogGroup(ctx context.Context, params *TagLogGroupInput, optFns ...func(*Options)) (*TagLogGroupOutput, error) { if params == nil { params = &TagLogGroupInput{} diff --git a/service/cloudwatchlogs/api_op_TagResource.go b/service/cloudwatchlogs/api_op_TagResource.go index 5771a1893c1..e7c6af22b7e 100644 --- a/service/cloudwatchlogs/api_op_TagResource.go +++ b/service/cloudwatchlogs/api_op_TagResource.go @@ -12,16 +12,22 @@ import ( // Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs // resource. Currently, the only CloudWatch Logs resources that can be tagged are -// log groups and destinations. 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 specify a new tag key for the alarm, this -// tag is appended to the list of tags associated with the alarm. If you specify a -// tag key that is already associated with the alarm, the new tag value that you -// specify replaces the previous value for that tag. You can associate as many as -// 50 tags with a CloudWatch Logs resource. +// log groups and destinations. +// +// 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 specify a new tag key for the alarm, this tag is appended to the list of +// tags associated with the alarm. If you specify a tag key that is already +// associated with the alarm, the new tag value that you specify replaces the +// previous value for that tag. +// +// You can associate as many as 50 tags with a CloudWatch Logs resource. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -39,12 +45,17 @@ 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) - // . + // 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]. + // + // [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 7173b342018..34d96a258ab 100644 --- a/service/cloudwatchlogs/api_op_UntagLogGroup.go +++ b/service/cloudwatchlogs/api_op_UntagLogGroup.go @@ -11,15 +11,21 @@ import ( ) // 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 +// you use [UntagResource]instead. +// +// Removes the specified tags from the specified log group. +// +// To list the tags for a log group, use [ListTagsForResource]. To add tags, use [TagResource]. +// +// 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. // // Deprecated: Please use the generic tagging API UntagResource +// +// [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html +// [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html +// [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html func (c *Client) UntagLogGroup(ctx context.Context, params *UntagLogGroupInput, optFns ...func(*Options)) (*UntagLogGroupOutput, error) { if params == nil { params = &UntagLogGroupInput{} diff --git a/service/cloudwatchlogs/api_op_UntagResource.go b/service/cloudwatchlogs/api_op_UntagResource.go index 522e322bf02..282ce12fb6c 100644 --- a/service/cloudwatchlogs/api_op_UntagResource.go +++ b/service/cloudwatchlogs/api_op_UntagResource.go @@ -28,12 +28,17 @@ 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) - // . + // 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]. + // + // [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_UpdateAnomaly.go b/service/cloudwatchlogs/api_op_UpdateAnomaly.go index 02144d220d9..264d3867b81 100644 --- a/service/cloudwatchlogs/api_op_UpdateAnomaly.go +++ b/service/cloudwatchlogs/api_op_UpdateAnomaly.go @@ -15,12 +15,16 @@ import ( // pattern. If you suppress an anomaly, CloudWatch Logs won’t report new // occurrences of that anomaly and won't update that anomaly with new data. If you // suppress a pattern, CloudWatch Logs won’t report any anomalies related to that -// pattern. You must specify either anomalyId or patternId , but you can't specify -// both parameters in the same operation. If you have previously used this -// operation to suppress detection of a pattern or anomaly, you can use it again to -// cause CloudWatch Logs to end the suppression. To do this, use this operation and -// specify the anomaly or pattern to stop suppressing, and omit the suppressionType -// and suppressionPeriod parameters. +// pattern. +// +// You must specify either anomalyId or patternId , but you can't specify both +// parameters in the same operation. +// +// If you have previously used this operation to suppress detection of a pattern +// or anomaly, you can use it again to cause CloudWatch Logs to end the +// suppression. To do this, use this operation and specify the anomaly or pattern +// to stop suppressing, and omit the suppressionType and suppressionPeriod +// parameters. func (c *Client) UpdateAnomaly(ctx context.Context, params *UpdateAnomalyInput, optFns ...func(*Options)) (*UpdateAnomalyOutput, error) { if params == nil { params = &UpdateAnomalyInput{} @@ -44,13 +48,15 @@ type UpdateAnomalyInput struct { AnomalyDetectorArn *string // If you are suppressing or unsuppressing an anomaly, specify its unique ID here. - // You can find anomaly IDs by using the ListAnomalies (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html) - // operation. + // You can find anomaly IDs by using the [ListAnomalies]operation. + // + // [ListAnomalies]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html AnomalyId *string // If you are suppressing or unsuppressing an pattern, specify its unique ID here. - // You can find pattern IDs by using the ListAnomalies (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html) - // operation. + // You can find pattern IDs by using the [ListAnomalies]operation. + // + // [ListAnomalies]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html PatternId *string // If you are temporarily suppressing an anomaly or pattern, use this structure to diff --git a/service/cloudwatchlogs/doc.go b/service/cloudwatchlogs/doc.go index c8642b3eb87..a74e5e1eade 100644 --- a/service/cloudwatchlogs/doc.go +++ b/service/cloudwatchlogs/doc.go @@ -7,8 +7,10 @@ // from EC2 instances, CloudTrail, and other sources. You can then retrieve the // associated log data from CloudWatch Logs using the CloudWatch console. // 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: +// 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 @@ -20,9 +22,11 @@ // "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 diff --git a/service/cloudwatchlogs/options.go b/service/cloudwatchlogs/options.go index 33256f3d76f..ac17de67e2f 100644 --- a/service/cloudwatchlogs/options.go +++ b/service/cloudwatchlogs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cloudwatchlogs/types/enums.go b/service/cloudwatchlogs/types/enums.go index d99578837f5..46fd244a5ad 100644 --- a/service/cloudwatchlogs/types/enums.go +++ b/service/cloudwatchlogs/types/enums.go @@ -15,8 +15,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INITIALIZING", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for DataProtectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataProtectionStatus) Values() []DataProtectionStatus { return []DataProtectionStatus{ "ACTIVATED", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for DeliveryDestinationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryDestinationType) Values() []DeliveryDestinationType { return []DeliveryDestinationType{ "S3", @@ -79,8 +82,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for EvaluationFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFrequency) Values() []EvaluationFrequency { return []EvaluationFrequency{ "ONE_MIN", @@ -127,8 +132,9 @@ const ( ) // Values returns all known values for ExportTaskStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportTaskStatusCode) Values() []ExportTaskStatusCode { return []ExportTaskStatusCode{ "CANCELLED", @@ -148,8 +154,9 @@ const ( ) // Values returns all known values for InheritedProperty. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InheritedProperty) Values() []InheritedProperty { return []InheritedProperty{ "ACCOUNT_DATA_PROTECTION", @@ -165,8 +172,9 @@ const ( ) // Values returns all known values for LogGroupClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogGroupClass) Values() []LogGroupClass { return []LogGroupClass{ "STANDARD", @@ -183,8 +191,9 @@ const ( ) // Values returns all known values for OrderBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderBy) Values() []OrderBy { return []OrderBy{ "LogStreamName", @@ -204,8 +213,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -225,8 +235,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "DATA_PROTECTION_POLICY", @@ -248,8 +259,9 @@ const ( ) // Values returns all known values for QueryStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryStatus) Values() []QueryStatus { return []QueryStatus{ "Scheduled", @@ -270,8 +282,9 @@ const ( ) // 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. +// the future, and so 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{ "ALL", @@ -312,8 +325,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -356,8 +370,9 @@ const ( ) // 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. +// the future, and so 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{ "Active", @@ -375,8 +390,9 @@ const ( ) // Values returns all known values for SuppressionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SuppressionState) Values() []SuppressionState { return []SuppressionState{ "SUPPRESSED", @@ -393,8 +409,9 @@ const ( ) // Values returns all known values for SuppressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SuppressionType) Values() []SuppressionType { return []SuppressionType{ "LIMITED", @@ -412,8 +429,9 @@ const ( ) // Values returns all known values for SuppressionUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SuppressionUnit) Values() []SuppressionUnit { return []SuppressionUnit{ "SECONDS", diff --git a/service/cloudwatchlogs/types/errors.go b/service/cloudwatchlogs/types/errors.go index c903802df8a..e35e5809a1b 100644 --- a/service/cloudwatchlogs/types/errors.go +++ b/service/cloudwatchlogs/types/errors.go @@ -59,9 +59,11 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// 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. +// 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. type DataAlreadyAcceptedException struct { Message *string @@ -143,6 +145,7 @@ func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smit // The sequence token is not valid. You can get the correct sequence token in the // expectedSequenceToken field in the InvalidSequenceTokenException message. +// // PutLogEvents actions are now always accepted and never return // InvalidSequenceTokenException regardless of receiving an invalid sequence token. type InvalidSequenceTokenException struct { @@ -199,10 +202,12 @@ 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]. +// +// For more information about valid query syntax, see [CloudWatch Logs Insights Query Syntax]. +// +// [CloudWatch Logs Insights Query Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html +// [QueryCompileError]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html type MalformedQueryException struct { Message *string diff --git a/service/cloudwatchlogs/types/types.go b/service/cloudwatchlogs/types/types.go index beaef415310..b3e33ce2e33 100644 --- a/service/cloudwatchlogs/types/types.go +++ b/service/cloudwatchlogs/types/types.go @@ -15,8 +15,9 @@ type AccountPolicy struct { // The date and time that this policy was most recently updated. LastUpdatedTime *int64 - // The policy document for this account policy. The JSON specified in - // policyDocument can be up to 30,720 characters. + // The policy document for this account policy. + // + // The JSON specified in policyDocument can be up to 30,720 characters. PolicyDocument *string // The name of the account policy. @@ -35,9 +36,11 @@ type AccountPolicy struct { } // This structure represents one anomaly that has been found by a logs anomaly -// detector. For more information about patterns and anomalies, see -// CreateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html) -// . +// detector. +// +// For more information about patterns and anomalies, see [CreateLogAnomalyDetector]. +// +// [CreateLogAnomalyDetector]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html type Anomaly struct { // Specifies whether this anomaly is still ongoing. @@ -112,11 +115,12 @@ type Anomaly struct { PatternTokens []PatternToken // Indicates the current state of this anomaly. If it is still being treated as an - // anomaly, the value is Active . If you have suppressed this anomaly by using the - // UpdateAnomaly (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html) + // anomaly, the value is Active . If you have suppressed this anomaly by using the [UpdateAnomaly] // operation, the value is Suppressed . If this behavior is now considered to be // normal, the value is Baseline . // + // [UpdateAnomaly]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html + // // This member is required. State State @@ -134,8 +138,9 @@ type Anomaly struct { Priority *string // Indicates whether this anomaly is currently suppressed. To suppress an anomaly, - // use UpdateAnomaly (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html) - // . + // use [UpdateAnomaly]. + // + // [UpdateAnomaly]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html Suppressed *bool // If the anomaly is suppressed, this indicates when it was suppressed. @@ -156,8 +161,9 @@ type AnomalyDetector struct { AnomalyDetectorArn *string // Specifies the current status of the anomaly detector. To pause an anomaly - // detector, use the enabled parameter in the UpdateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html) - // operation. + // detector, use the enabled parameter in the [UpdateLogAnomalyDetector] operation. + // + // [UpdateLogAnomalyDetector]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html AnomalyDetectorStatus AnomalyDetectorStatus // The number of days used as the life cycle of anomalies. After this time, @@ -192,11 +198,17 @@ type AnomalyDetector struct { noSmithyDocumentSerde } -// This structure contains information about one delivery in your account. A -// delivery is a connection between a logical delivery source and a logical -// delivery destination. For more information, see CreateDelivery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) -// . You can't update an existing delivery. You can only create and delete +// This structure contains information about one delivery in your account. +// +// A delivery is a connection between a logical delivery source and a logical +// delivery destination. +// +// For more information, see [CreateDelivery]. +// +// You can't update an existing delivery. You can only create and delete // deliveries. +// +// [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html type Delivery struct { // The Amazon Resource Name (ARN) that uniquely identifies this delivery. @@ -224,27 +236,32 @@ type Delivery struct { // This structure contains information about one delivery destination in your // account. A delivery destination is an Amazon Web Services resource that // represents an Amazon Web Services service that logs can be sent to. CloudWatch -// Logs, Amazon S3, are supported as Firehose delivery destinations. To configure -// logs delivery between a supported Amazon Web Services service and a destination, -// you must do the following: +// Logs, Amazon S3, are supported as Firehose delivery destinations. +// +// To configure logs delivery between a supported Amazon Web Services service and +// a destination, you must do the following: +// // - Create a delivery source, which is a logical object that represents the -// resource that is actually sending the logs. For more information, see -// PutDeliverySource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// . +// resource that is actually sending the logs. For more information, see [PutDeliverySource]. +// // - Create a delivery destination, which is a logical object that represents // the actual delivery destination. -// - If you are delivering logs cross-account, you must use -// PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// in the destination account to assign an IAM policy to the destination. This -// policy allows delivery to that destination. +// +// - If you are delivering logs cross-account, you must use [PutDeliveryDestinationPolicy]in the destination +// account to assign an IAM policy to the destination. This policy allows delivery +// to that destination. +// // - Create a delivery by pairing exactly one delivery source and one delivery -// destination. For more information, see CreateDelivery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) -// . +// destination. For more information, see [CreateDelivery]. // // You can configure a single delivery source to send logs to multiple // destinations by creating multiple deliveries. You can also create multiple // deliveries to configure multiple delivery sources to send logs to the same // delivery destination. +// +// [PutDeliverySource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html type DeliveryDestination struct { // The Amazon Resource Name (ARN) that uniquely identifies this delivery @@ -287,31 +304,37 @@ type DeliveryDestinationConfiguration struct { // This structure contains information about one delivery source in your account. // A delivery source is an Amazon Web Services resource that sends logs to an // Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon -// S3, or Firehose. Only some Amazon Web Services services support being configured -// as a delivery source. These services are listed as Supported [V2 Permissions] in -// the table at Enabling logging from Amazon Web Services services. (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) -// To configure logs delivery between a supported Amazon Web Services service and a -// destination, you must do the following: +// S3, or Firehose. +// +// Only some Amazon Web Services services support being configured as a delivery +// source. These services are listed as Supported [V2 Permissions] in the table at [Enabling logging from Amazon Web Services services.] +// +// To configure logs delivery between a supported Amazon Web Services service and +// a destination, you must do the following: +// // - Create a delivery source, which is a logical object that represents the -// resource that is actually sending the logs. For more information, see -// PutDeliverySource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) -// . +// resource that is actually sending the logs. For more information, see [PutDeliverySource]. +// // - Create a delivery destination, which is a logical object that represents -// the actual delivery destination. For more information, see -// PutDeliveryDestination (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html) -// . -// - If you are delivering logs cross-account, you must use -// PutDeliveryDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html) -// in the destination account to assign an IAM policy to the destination. This -// policy allows delivery to that destination. +// the actual delivery destination. For more information, see [PutDeliveryDestination]. +// +// - If you are delivering logs cross-account, you must use [PutDeliveryDestinationPolicy]in the destination +// account to assign an IAM policy to the destination. This policy allows delivery +// to that destination. +// // - Create a delivery by pairing exactly one delivery source and one delivery -// destination. For more information, see CreateDelivery (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) -// . +// destination. For more information, see [CreateDelivery]. // // You can configure a single delivery source to send logs to multiple // destinations by creating multiple deliveries. You can also create multiple // deliveries to configure multiple delivery sources to send logs to the same // delivery destination. +// +// [PutDeliveryDestination]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html +// [PutDeliverySource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html +// [Enabling logging from Amazon Web Services services.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html +// [CreateDelivery]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html +// [PutDeliveryDestinationPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html type DeliverySource struct { // The Amazon Resource Name (ARN) that uniquely identifies this delivery source. @@ -497,8 +520,9 @@ type LiveTailSessionLogEvent struct { type LiveTailSessionMetadata struct { // If this is true , then more than 500 log events matched the request for this - // update, and the sessionResults includes a sample of 500 of those events. If - // this is false , then 500 or fewer log events matched the request for this + // update, and the sessionResults includes a sample of 500 of those events. + // + // If this is false , then 500 or fewer log events matched the request for this // update, so no sampling was necessary. In this case, the sessionResults array // includes all log events that matched your request during this time. Sampled bool @@ -512,9 +536,11 @@ type LiveTailSessionStart struct { // An optional pattern to filter the results to include only log events that match // the pattern. For example, a filter pattern of error 404 displays only log - // events that include both error and 404 . For more information about filter - // pattern syntax, see Filter and Pattern Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) - // . + // events that include both error and 404 . + // + // For more information about filter pattern syntax, see [Filter and Pattern Syntax]. + // + // [Filter and Pattern Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html LogEventFilterPattern *string // An array of the names and ARNs of the log groups included in this Live Tail @@ -548,10 +574,11 @@ type LiveTailSessionUpdate struct { SessionMetadata *LiveTailSessionMetadata // An array, where each member of the array includes the information for one log - // event in the Live Tail session. A sessionResults array can include as many as - // 500 log events. If the number of log events matching the request exceeds 500 per - // second, the log events are sampled down to 500 log events to be included in each - // sessionUpdate structure. + // event in the Live Tail session. + // + // A sessionResults array can include as many as 500 log events. If the number of + // log events matching the request exceeds 500 per second, the log events are + // sampled down to 500 log events to be included in each sessionUpdate structure. SessionResults []LiveTailSessionLogEvent noSmithyDocumentSerde @@ -574,13 +601,16 @@ type LogEvent struct { type LogGroup struct { // The Amazon Resource Name (ARN) of the log group. This version of the ARN - // includes a trailing :* after the log group name. Use this version to refer to - // the ARN in IAM policies when specifying permissions for most API actions. The - // exception is when specifying permissions for TagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html) - // , UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html) - // , and ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) - // . The permissions for those three actions require the ARN version that doesn't - // include a trailing :* . + // includes a trailing :* after the log group name. + // + // Use this version to refer to the ARN in IAM policies when specifying + // permissions for most API actions. The exception is when specifying permissions + // for [TagResource], [UntagResource], and [ListTagsForResource]. The permissions for those three actions require the ARN version + // that doesn't include a trailing :* . + // + // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html + // [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html Arn *string // The creation time of the log group, expressed as the number of milliseconds @@ -588,8 +618,9 @@ 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]. + // + // [PutDataProtectionPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html DataProtectionStatus DataProtectionStatus // Displays all the properties that this log group has inherited from @@ -600,21 +631,31 @@ type LogGroup struct { KmsKeyId *string // The Amazon Resource Name (ARN) of the log group. This version of the ARN - // doesn't include a trailing :* after the log group name. Use this version to - // refer to the ARN in the following situations: + // doesn't include a trailing :* after the log group name. + // + // Use this version to refer to the ARN in the following situations: + // // - In the logGroupIdentifier input field in many CloudWatch Logs APIs. + // // - In the resourceArn field in tagging APIs - // - In IAM policies, when specifying permissions for TagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html) - // , UntagResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html) - // , and ListTagsForResource (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html) - // . + // + // - In IAM policies, when specifying permissions for [TagResource], [UntagResource], and [ListTagsForResource]. + // + // [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html + // [ListTagsForResource]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html LogGroupArn *string // This specifies the log group class for this log group. There are two classes: + // // - The Standard log class supports all CloudWatch Logs features. + // // - The Infrequent Access log class supports a subset of CloudWatch Logs // features and incurs lower costs. - // For details about the features supported by each class, see Log classes (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html) + // + // For details about the features supported by each class, see [Log classes] + // + // [Log classes]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html LogGroupClass LogGroupClass // The name of the log group. @@ -625,9 +666,11 @@ type LogGroup struct { // 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, 1096, 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) - // . + // 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. + // + // To set a log group so that its log events do not expire, use [DeleteRetentionPolicy]. + // + // [DeleteRetentionPolicy]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html RetentionInDays *int32 // The number of bytes stored. @@ -680,20 +723,22 @@ 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 - // applies only to log streams. The storedBytes parameter for log groups is not - // affected. + // 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. StoredBytes *int64 - // The sequence token. The sequence token is now ignored in PutLogEvents actions. - // PutLogEvents actions are always accepted regardless of receiving an invalid - // sequence token. You don't need to obtain uploadSequenceToken to use a - // PutLogEvents action. + // The sequence token. + // + // The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions + // are always accepted regardless of receiving an invalid sequence token. You don't + // need to obtain uploadSequenceToken to use a PutLogEvents action. UploadSequenceToken *string noSmithyDocumentSerde @@ -751,8 +796,9 @@ type MetricTransformation struct { 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) - // . + // group together metrics that are similar. For more information, see [Namespaces]. + // + // [Namespaces]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace // // This member is required. MetricNamespace *string @@ -768,17 +814,22 @@ type MetricTransformation struct { 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 - // 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 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) - // . + // 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 accrues charges as a separate + // custom metric. + // + // CloudWatch Logs disables a metric 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]. + // + // [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 . @@ -805,9 +856,11 @@ type OutputLogEvent struct { } // A tructures that contains information about one pattern token related to an -// anomaly. For more information about patterns and tokens, see -// CreateLogAnomalyDetector (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html) -// . +// anomaly. +// +// For more information about patterns and tokens, see [CreateLogAnomalyDetector]. +// +// [CreateLogAnomalyDetector]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html type PatternToken struct { // For a dynamic token, this indicates where in the pattern that this token @@ -879,9 +932,9 @@ type QueryDefinition struct { // The unique ID of the query definition. 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) - // . + // The query string to use for this definition. For more information, see [CloudWatch Logs Insights Query Syntax]. + // + // [CloudWatch Logs Insights Query Syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html QueryString *string noSmithyDocumentSerde @@ -960,9 +1013,12 @@ 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) -// . +// 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]. +// +// [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. @@ -986,13 +1042,14 @@ type SearchedLogStream struct { noSmithyDocumentSerde } -// This object includes the stream returned by your StartLiveTail (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html) -// request. +// This object includes the stream returned by your [StartLiveTail] request. // // The following types satisfy this interface: // // StartLiveTailResponseStreamMemberSessionStart // StartLiveTailResponseStreamMemberSessionUpdate +// +// [StartLiveTail]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html type StartLiveTailResponseStream interface { isStartLiveTailResponseStream() } diff --git a/service/codeartifact/api_op_AssociateExternalConnection.go b/service/codeartifact/api_op_AssociateExternalConnection.go index b363bbb23a9..ebd115d3cf6 100644 --- a/service/codeartifact/api_op_AssociateExternalConnection.go +++ b/service/codeartifact/api_op_AssociateExternalConnection.go @@ -12,8 +12,10 @@ import ( ) // 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. +// 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{} @@ -36,26 +38,34 @@ type AssociateExternalConnectionInput struct { // This member is required. Domain *string - // The name of the external connection to add to the repository. The following + // 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. // // This member is required. ExternalConnection *string - // The name of the repository to which the external connection is added. + // The name of the repository to which the external connection is added. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -64,7 +74,7 @@ type AssociateExternalConnectionInput struct { type AssociateExternalConnectionOutput struct { - // Information about the connected repository after processing the request. + // Information about the connected repository after processing the request. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_CopyPackageVersions.go b/service/codeartifact/api_op_CopyPackageVersions.go index c32e6bdd3be..661c842de03 100644 --- a/service/codeartifact/api_op_CopyPackageVersions.go +++ b/service/codeartifact/api_op_CopyPackageVersions.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies package versions from one repository to another repository in the same -// domain. You must specify versions or versionRevisions . You cannot specify both. +// Copies package versions from one repository to another repository in the same +// +// 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{} @@ -30,70 +33,81 @@ func (c *Client) CopyPackageVersions(ctx context.Context, params *CopyPackageVer type CopyPackageVersionsInput struct { - // The name of the repository into which package versions are copied. + // The name of the repository into which package versions are copied. // // This member is required. DestinationRepository *string - // The name of the domain that contains the source and destination repositories. + // The name of the domain that contains the source and destination repositories. // // This member is required. Domain *string - // The format of the package versions to be copied. + // The format of the package versions to be copied. // // This member is required. Format types.PackageFormat - // The name of the package that contains the versions to be copied. + // The name of the package that contains the versions to be copied. // // This member is required. Package *string - // The name of the repository that contains the package versions to be copied. + // The name of the repository that contains the package versions to be copied. // // This member is required. SourceRepository *string - // Set to true to overwrite a package version that already exists in the + // Set to true to overwrite a package version that already exists in the // destination repository. If set to false and the package version already exists // in the destination repository, the package version is returned in the // failedVersions field of the response with an ALREADY_EXISTS error code. AllowOverwrite *bool - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // Set to true to copy packages from repositories that are upstream from the + // 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) - // . + // For more information, see [Working with upstream repositories]. + // + // [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 component that - // specifies its namespace depends on its type. For example: The namespace is - // required when copying package versions of the following formats: + // specifies its namespace depends on its type. For example: + // + // The namespace is required when copying package versions of the following + // formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string - // A list of key-value pairs. The keys are package versions and the values are + // 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 - // both. + // 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. + // The versions of the package to be copied. + // + // You must specify versions or versionRevisions . You cannot specify both. Versions []string noSmithyDocumentSerde @@ -101,17 +115,24 @@ type CopyPackageVersionsInput struct { type CopyPackageVersionsOutput struct { - // A map of package versions that failed to copy and their error codes. The + // 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 FailedVersions map[string]types.PackageVersionError - // A list of the package versions that were successfully copied to your repository. + // A list of the package versions that were successfully copied to your + // repository. SuccessfulVersions map[string]types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_CreateDomain.go b/service/codeartifact/api_op_CreateDomain.go index 9e1d159f2eb..cea2648343a 100644 --- a/service/codeartifact/api_op_CreateDomain.go +++ b/service/codeartifact/api_op_CreateDomain.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a domain. CodeArtifact domains make it easier to manage multiple +// Creates a domain. CodeArtifact domains make it easier to manage multiple +// // repositories across an organization. You can use a domain to apply permissions // across many repositories owned by different Amazon Web Services accounts. An // asset is stored only once in a domain, even if it's in multiple repositories. +// // Although you can have multiple domains, we recommend a single production domain // that contains all published artifacts so that your development teams can find // and share packages. You can use a second pre-production domain to test changes @@ -36,7 +38,7 @@ func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, op type CreateDomainInput struct { - // The name of the domain to create. All domain names in an Amazon Web Services + // The name of the domain to create. All domain names in an Amazon Web Services // Region that are in the same Amazon Web Services account must be unique. The // domain name is used as the prefix in DNS hostnames. Do not use sensitive // information in a domain name because it is publicly discoverable. @@ -44,17 +46,20 @@ type CreateDomainInput struct { // This member is required. Domain *string - // The encryption key for the domain. This is used to encrypt content stored in a + // 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 // 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) - // 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) - // 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) - // in the Key Management Service Developer Guide. + // is used. For more information, see [DescribeKey]in the Key Management Service API Reference + // and [Key Management Service API Permissions Reference]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]in the Key Management Service + // Developer Guide. + // + // [Using symmetric and asymmetric keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + // [DescribeKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax + // [Key Management Service API Permissions Reference]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html EncryptionKey *string // One or more tag key-value pairs for the domain. @@ -65,7 +70,7 @@ type CreateDomainInput struct { type CreateDomainOutput struct { - // Contains information about the created domain after processing the request. + // Contains information about the created domain after processing the request. Domain *types.DomainDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_CreatePackageGroup.go b/service/codeartifact/api_op_CreatePackageGroup.go index 23f4e561cac..17d83cfca58 100644 --- a/service/codeartifact/api_op_CreatePackageGroup.go +++ b/service/codeartifact/api_op_CreatePackageGroup.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a package group. For more information about creating package groups, -// including example CLI commands, see Create a package group (https://docs.aws.amazon.com/codeartifact/latest/ug/create-package-group.html) -// in the CodeArtifact User Guide. +// Creates a package group. For more information about creating package groups, +// +// including example CLI commands, see [Create a package group]in the CodeArtifact User Guide. +// +// [Create a package group]: https://docs.aws.amazon.com/codeartifact/latest/ug/create-package-group.html func (c *Client) CreatePackageGroup(ctx context.Context, params *CreatePackageGroupInput, optFns ...func(*Options)) (*CreatePackageGroupOutput, error) { if params == nil { params = &CreatePackageGroupInput{} @@ -31,7 +33,7 @@ func (c *Client) CreatePackageGroup(ctx context.Context, params *CreatePackageGr type CreatePackageGroupInput struct { - // The name of the domain in which you want to create a package group. + // The name of the domain in which you want to create a package group. // // This member is required. Domain *string @@ -42,13 +44,13 @@ type CreatePackageGroupInput struct { // This member is required. PackageGroup *string - // The contact information for the created package group. + // The contact information for the created package group. ContactInfo *string - // A description of the package group. + // A description of the package group. Description *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -60,7 +62,7 @@ type CreatePackageGroupInput struct { type CreatePackageGroupOutput struct { - // Information about the created package group after processing the request. + // Information about the created package group after processing the request. PackageGroup *types.PackageGroupDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_CreateRepository.go b/service/codeartifact/api_op_CreateRepository.go index fd7e14cfe95..2ff0ea09c5f 100644 --- a/service/codeartifact/api_op_CreateRepository.go +++ b/service/codeartifact/api_op_CreateRepository.go @@ -29,7 +29,7 @@ func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryI type CreateRepositoryInput struct { - // The name of the domain that contains the created repository. + // The name of the domain that contains the created repository. // // This member is required. Domain *string @@ -39,21 +39,21 @@ type CreateRepositoryInput struct { // This member is required. Repository *string - // A description of the created repository. + // A description of the created repository. Description *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // One or more tag key-value pairs for the repository. Tags []types.Tag - // A list of upstream repositories to associate with the repository. The order of + // 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) - // . + // CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories]. + // + // [Working with upstream repositories]: https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html Upstreams []types.UpstreamRepository noSmithyDocumentSerde @@ -61,7 +61,7 @@ type CreateRepositoryInput struct { type CreateRepositoryOutput struct { - // Information about the created repository after processing the request. + // Information about the created repository after processing the request. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeleteDomain.go b/service/codeartifact/api_op_DeleteDomain.go index f79881cf6fd..69c75cf630a 100644 --- a/service/codeartifact/api_op_DeleteDomain.go +++ b/service/codeartifact/api_op_DeleteDomain.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a domain. You cannot delete a domain that contains repositories. If you -// want to delete a domain with repositories, first delete its repositories. +// Deletes a domain. You cannot delete a domain that contains repositories. If +// +// you want to delete a domain with repositories, first delete its repositories. func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} @@ -30,12 +31,12 @@ func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, op type DeleteDomainInput struct { - // The name of the domain to delete. + // The name of the domain to delete. // // This member is required. Domain *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -44,7 +45,7 @@ type DeleteDomainInput struct { type DeleteDomainOutput struct { - // Contains information about the deleted domain after processing the request. + // Contains information about the deleted domain after processing the request. Domain *types.DomainDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go b/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go index ba5ed7833dd..8bde84ae81e 100644 --- a/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_DeleteDomainPermissionsPolicy.go @@ -29,16 +29,16 @@ func (c *Client) DeleteDomainPermissionsPolicy(ctx context.Context, params *Dele type DeleteDomainPermissionsPolicyInput struct { - // The name of the domain associated with the resource policy to be deleted. + // The name of the domain associated with the resource policy to be deleted. // // This member is required. Domain *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The current revision of the resource policy to be deleted. This revision is + // 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 @@ -48,7 +48,7 @@ type DeleteDomainPermissionsPolicyInput struct { type DeleteDomainPermissionsPolicyOutput struct { - // Information about the deleted resource policy after processing the request. + // Information about the deleted resource policy after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeletePackage.go b/service/codeartifact/api_op_DeletePackage.go index 5bf2dae1655..95407cc24c9 100644 --- a/service/codeartifact/api_op_DeletePackage.go +++ b/service/codeartifact/api_op_DeletePackage.go @@ -12,9 +12,9 @@ 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) -// API. +// be restored. To delete one or more package versions, use the [DeletePackageVersions]API. +// +// [DeletePackageVersions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error) { if params == nil { params = &DeletePackageInput{} @@ -52,20 +52,27 @@ type DeletePackageInput struct { // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // 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 is required when - // deleting packages of the following formats: + // its namespace depends on its type. For example: + // + // The namespace is required when deleting packages of the following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -75,7 +82,7 @@ type DeletePackageInput struct { type DeletePackageOutput struct { - // Details about a package, including its format, namespace, and name. + // Details about a package, including its format, namespace, and name. DeletedPackage *types.PackageSummary // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeletePackageGroup.go b/service/codeartifact/api_op_DeletePackageGroup.go index 5734544d4a5..5a728afa6be 100644 --- a/service/codeartifact/api_op_DeletePackageGroup.go +++ b/service/codeartifact/api_op_DeletePackageGroup.go @@ -33,7 +33,7 @@ func (c *Client) DeletePackageGroup(ctx context.Context, params *DeletePackageGr type DeletePackageGroupInput struct { - // The domain that contains the package group to be deleted. + // The domain that contains the package group to be deleted. // // This member is required. Domain *string @@ -43,7 +43,7 @@ type DeletePackageGroupInput struct { // This member is required. PackageGroup *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -52,7 +52,7 @@ type DeletePackageGroupInput struct { type DeletePackageGroupOutput struct { - // Information about the deleted package group after processing the request. + // Information about the deleted package group after processing the request. PackageGroup *types.PackageGroupDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeletePackageVersions.go b/service/codeartifact/api_op_DeletePackageVersions.go index 1f79b5bdaa0..590455d48a9 100644 --- a/service/codeartifact/api_op_DeletePackageVersions.go +++ b/service/codeartifact/api_op_DeletePackageVersions.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes one or more versions of a package. A deleted package version cannot be +// 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) -// . +// list package APIs (for example, [ListPackageVersions]), but you can restore them using [UpdatePackageVersionsStatus]. +// +// [ListPackageVersions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html +// [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{} @@ -35,48 +37,56 @@ func (c *Client) DeletePackageVersions(ctx context.Context, params *DeletePackag type DeletePackageVersionsInput struct { - // The name of the domain that contains the package to delete. + // The name of the domain that contains the package to delete. // // This member is required. Domain *string - // The format of the package versions to delete. + // The format of the package versions to delete. // // This member is required. Format types.PackageFormat - // The name of the package with the versions to delete. + // The name of the package with the versions to delete. // // This member is required. Package *string - // The name of the repository that contains the package versions to delete. + // The name of the repository that contains the package versions to delete. // // This member is required. Repository *string - // An array of strings that specify the versions of the package to delete. + // An array of strings that specify the versions of the package to delete. // // This member is required. Versions []string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The expected status of the package version to delete. + // The expected status of the package version to delete. ExpectedStatus types.PackageVersionStatus // The namespace of the package versions to be deleted. The package component that - // specifies its namespace depends on its type. For example: The namespace is - // required when deleting package versions of the following formats: + // specifies its namespace depends on its type. For example: + // + // The namespace is required when deleting package versions of the following + // formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -86,17 +96,23 @@ type DeletePackageVersionsInput struct { type DeletePackageVersionsOutput struct { - // A PackageVersionError object that contains a map of errors codes for the + // 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 + // A list of the package versions that were successfully deleted. The status of // every successful version will be Deleted . SuccessfulVersions map[string]types.SuccessfulPackageVersionInfo diff --git a/service/codeartifact/api_op_DeleteRepository.go b/service/codeartifact/api_op_DeleteRepository.go index 715656c1ff8..5aac07033dd 100644 --- a/service/codeartifact/api_op_DeleteRepository.go +++ b/service/codeartifact/api_op_DeleteRepository.go @@ -29,17 +29,17 @@ func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryI type DeleteRepositoryInput struct { - // The name of the domain that contains the repository to delete. + // The name of the domain that contains the repository to delete. // // This member is required. Domain *string - // The name of the repository to delete. + // The name of the repository to delete. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -48,7 +48,7 @@ type DeleteRepositoryInput struct { type DeleteRepositoryOutput struct { - // Information about the deleted repository after processing the request. + // Information about the deleted repository after processing the request. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go index 80050d88a8d..0f5d74232a5 100644 --- a/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_DeleteRepositoryPermissionsPolicy.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the resource policy that is set on a repository. After a resource +// 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, +// 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 // repository actions granted by the deleted policy. func (c *Client) DeleteRepositoryPermissionsPolicy(ctx context.Context, params *DeleteRepositoryPermissionsPolicyInput, optFns ...func(*Options)) (*DeleteRepositoryPermissionsPolicyOutput, error) { @@ -34,23 +36,23 @@ func (c *Client) DeleteRepositoryPermissionsPolicy(ctx context.Context, params * type DeleteRepositoryPermissionsPolicyInput struct { - // The name of the domain that contains the repository associated with the + // The name of the domain that contains the repository associated with the // resource policy to be deleted. // // This member is required. Domain *string - // The name of the repository that is associated with the resource policy to be + // The name of the repository that is associated with the resource policy to be // deleted // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The revision of the repository's resource policy to be deleted. This revision + // 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 @@ -60,7 +62,7 @@ type DeleteRepositoryPermissionsPolicyInput struct { type DeleteRepositoryPermissionsPolicyOutput struct { - // Information about the deleted policy after processing the request. + // Information about the deleted policy after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DescribeDomain.go b/service/codeartifact/api_op_DescribeDomain.go index 16673f73512..6a364b9722b 100644 --- a/service/codeartifact/api_op_DescribeDomain.go +++ b/service/codeartifact/api_op_DescribeDomain.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a DomainDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html) -// object that contains information about the requested domain. +// Returns a [DomainDescription] object that contains information about the requested domain. +// +// [DomainDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error) { if params == nil { params = &DescribeDomainInput{} @@ -30,12 +31,12 @@ func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput type DescribeDomainInput struct { - // A string that specifies the name of the requested domain. + // A string that specifies the name of the requested domain. // // This member is required. Domain *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -44,7 +45,7 @@ type DescribeDomainInput struct { type DescribeDomainOutput struct { - // Information about a domain. A domain is a container for repositories. When you + // Information about a domain. A domain is a container for repositories. When you // create a domain, it is empty until you add one or more repositories. Domain *types.DomainDescription diff --git a/service/codeartifact/api_op_DescribePackage.go b/service/codeartifact/api_op_DescribePackage.go index c344bb420e5..11b66a0b03b 100644 --- a/service/codeartifact/api_op_DescribePackage.go +++ b/service/codeartifact/api_op_DescribePackage.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) -// object that contains information about the requested package. +// Returns a [PackageDescription] object that contains information about the requested package. +// +// [PackageDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html func (c *Client) DescribePackage(ctx context.Context, params *DescribePackageInput, optFns ...func(*Options)) (*DescribePackageOutput, error) { if params == nil { params = &DescribePackageInput{} @@ -50,20 +51,27 @@ type DescribePackageInput struct { // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // 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 is required when - // requesting packages of the following formats: + // its namespace depends on its type. For example: + // + // The namespace is required when requesting packages of the following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -73,8 +81,9 @@ type DescribePackageInput struct { type DescribePackageOutput struct { - // A PackageDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html) - // object that contains information about the requested package. + // A [PackageDescription] object that contains information about the requested package. + // + // [PackageDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html // // This member is required. Package *types.PackageDescription diff --git a/service/codeartifact/api_op_DescribePackageGroup.go b/service/codeartifact/api_op_DescribePackageGroup.go index 7ca6b36b02d..94df5bc8d64 100644 --- a/service/codeartifact/api_op_DescribePackageGroup.go +++ b/service/codeartifact/api_op_DescribePackageGroup.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a PackageGroupDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html) -// object that contains information about the requested package group. +// Returns a [PackageGroupDescription] object that contains information about the requested package group. +// +// [PackageGroupDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html func (c *Client) DescribePackageGroup(ctx context.Context, params *DescribePackageGroupInput, optFns ...func(*Options)) (*DescribePackageGroupOutput, error) { if params == nil { params = &DescribePackageGroupInput{} @@ -30,7 +31,7 @@ func (c *Client) DescribePackageGroup(ctx context.Context, params *DescribePacka type DescribePackageGroupInput struct { - // The name of the domain that contains the package group. + // The name of the domain that contains the package group. // // This member is required. Domain *string @@ -40,7 +41,7 @@ type DescribePackageGroupInput struct { // This member is required. PackageGroup *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -49,8 +50,9 @@ type DescribePackageGroupInput struct { type DescribePackageGroupOutput struct { - // A PackageGroupDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html) - // object that contains information about the requested package group. + // A [PackageGroupDescription] object that contains information about the requested package group. + // + // [PackageGroupDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html PackageGroup *types.PackageGroupDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DescribePackageVersion.go b/service/codeartifact/api_op_DescribePackageVersion.go index bef7fbe731b..c404320347a 100644 --- a/service/codeartifact/api_op_DescribePackageVersion.go +++ b/service/codeartifact/api_op_DescribePackageVersion.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) -// object that contains information about the requested package version. +// Returns a [PackageVersionDescription] object that contains information about the requested package +// +// version. +// +// [PackageVersionDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html func (c *Client) DescribePackageVersion(ctx context.Context, params *DescribePackageVersionInput, optFns ...func(*Options)) (*DescribePackageVersionOutput, error) { if params == nil { params = &DescribePackageVersionInput{} @@ -30,46 +33,54 @@ func (c *Client) DescribePackageVersion(ctx context.Context, params *DescribePac type DescribePackageVersionInput struct { - // The name of the domain that contains the repository that contains the package + // The name of the domain that contains the repository that contains the package // version. // // This member is required. Domain *string - // A format that specifies the type of the requested package version. + // A format that specifies the type of the requested package version. // // This member is required. Format types.PackageFormat - // The name of the requested package version. + // The name of the requested package version. // // 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 version. + // The name of the repository that contains the package version. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // The namespace of the requested package version. The package component that - // specifies its namespace depends on its type. For example: The namespace is - // required when requesting package versions of the following formats: + // specifies its namespace depends on its type. For example: + // + // The namespace is required when requesting package versions of the following + // formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -79,8 +90,9 @@ type DescribePackageVersionInput struct { type DescribePackageVersionOutput struct { - // A PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) - // object that contains information about the requested package version. + // A [PackageVersionDescription] object that contains information about the requested package version. + // + // [PackageVersionDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html // // This member is required. PackageVersion *types.PackageVersionDescription diff --git a/service/codeartifact/api_op_DescribeRepository.go b/service/codeartifact/api_op_DescribeRepository.go index 996adb89920..9babe0953d2 100644 --- a/service/codeartifact/api_op_DescribeRepository.go +++ b/service/codeartifact/api_op_DescribeRepository.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a RepositoryDescription object that contains detailed information about -// the requested repository. +// Returns a RepositoryDescription object that contains detailed information +// +// about the requested repository. func (c *Client) DescribeRepository(ctx context.Context, params *DescribeRepositoryInput, optFns ...func(*Options)) (*DescribeRepositoryOutput, error) { if params == nil { params = &DescribeRepositoryInput{} @@ -30,17 +31,17 @@ func (c *Client) DescribeRepository(ctx context.Context, params *DescribeReposit type DescribeRepositoryInput struct { - // The name of the domain that contains the repository to describe. + // The name of the domain that contains the repository to describe. // // This member is required. Domain *string - // A string that specifies the name of the requested repository. + // A string that specifies the name of the requested repository. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -49,7 +50,7 @@ type DescribeRepositoryInput struct { type DescribeRepositoryOutput struct { - // A RepositoryDescription object that contains the requested repository + // A RepositoryDescription object that contains the requested repository // information. Repository *types.RepositoryDescription diff --git a/service/codeartifact/api_op_DisassociateExternalConnection.go b/service/codeartifact/api_op_DisassociateExternalConnection.go index b0ae827e7cc..faef1b67f4f 100644 --- a/service/codeartifact/api_op_DisassociateExternalConnection.go +++ b/service/codeartifact/api_op_DisassociateExternalConnection.go @@ -45,7 +45,7 @@ type DisassociateExternalConnectionInput struct { // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -54,7 +54,7 @@ type DisassociateExternalConnectionInput struct { type DisassociateExternalConnectionOutput struct { - // The repository associated with the removed external connection. + // The repository associated with the removed external connection. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_DisposePackageVersions.go b/service/codeartifact/api_op_DisposePackageVersions.go index 93beb2e357e..aaf9b192ee6 100644 --- a/service/codeartifact/api_op_DisposePackageVersions.go +++ b/service/codeartifact/api_op_DisposePackageVersions.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the assets in package versions and sets the package versions' status to -// 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) -// . +// Deletes the assets in package versions and sets the package versions' status +// +// to 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] and set the [status] +// parameter to Disposed . +// +// To view information about a disposed package version, use [DescribePackageVersion]. +// +// [DescribePackageVersion]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html +// [ListPackageVersions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html +// [status]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax func (c *Client) DisposePackageVersions(ctx context.Context, params *DisposePackageVersionsInput, optFns ...func(*Options)) (*DisposePackageVersionsOutput, error) { if params == nil { params = &DisposePackageVersionsInput{} @@ -36,54 +41,62 @@ func (c *Client) DisposePackageVersions(ctx context.Context, params *DisposePack type DisposePackageVersionsInput struct { - // The name of the domain that contains the repository you want to dispose. + // The name of the domain that contains the repository you want to dispose. // // This member is required. Domain *string - // A format that specifies the type of package versions you want to dispose. + // A format that specifies the type of package versions you want to dispose. // // This member is required. Format types.PackageFormat - // The name of the package with the versions you want to dispose. + // The name of the package with the versions you want to dispose. // // This member is required. Package *string - // The name of the repository that contains the package versions you want to + // The name of the repository that contains the package versions you want to // dispose. // // This member is required. Repository *string - // The versions of the package you want to dispose. + // The versions of the package you want to dispose. // // This member is required. Versions []string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The expected status of the package version to dispose. + // The expected status of the package version to dispose. ExpectedStatus types.PackageVersionStatus // The namespace of the package versions to be disposed. The package component - // that specifies its namespace depends on its type. For example: The namespace is - // required when disposing package versions of the following formats: + // that specifies its namespace depends on its type. For example: + // + // The namespace is required when disposing package versions of the following + // formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string - // The revisions of the package versions you want to dispose. + // The revisions of the package versions you want to dispose. VersionRevisions map[string]string noSmithyDocumentSerde @@ -91,17 +104,23 @@ type DisposePackageVersionsInput struct { type DisposePackageVersionsOutput struct { - // A PackageVersionError object that contains a map of errors codes for the + // 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 FailedVersions map[string]types.PackageVersionError - // A list of the package versions that were successfully disposed. + // A list of the package versions that were successfully disposed. SuccessfulVersions map[string]types.SuccessfulPackageVersionInfo // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_GetAssociatedPackageGroup.go b/service/codeartifact/api_op_GetAssociatedPackageGroup.go index c41287997a9..6aa194b9e33 100644 --- a/service/codeartifact/api_op_GetAssociatedPackageGroup.go +++ b/service/codeartifact/api_op_GetAssociatedPackageGroup.go @@ -16,9 +16,12 @@ import ( // domain. As such, GetAssociatedPackageGroup can be used to see which package // group's origin configuration applies to a package before that package is in a // repository. This can be helpful to check if public packages are blocked without -// ingesting them. For information package group association and matching, see -// Package group definition syntax and matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) -// in the CodeArtifact User Guide. +// ingesting them. +// +// For information package group association and matching, see [Package group definition syntax and matching behavior] in the +// CodeArtifact User Guide. +// +// [Package group definition syntax and matching behavior]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html func (c *Client) GetAssociatedPackageGroup(ctx context.Context, params *GetAssociatedPackageGroupInput, optFns ...func(*Options)) (*GetAssociatedPackageGroupOutput, error) { if params == nil { params = &GetAssociatedPackageGroupInput{} @@ -36,37 +39,45 @@ func (c *Client) GetAssociatedPackageGroup(ctx context.Context, params *GetAssoc type GetAssociatedPackageGroupInput struct { - // The name of the domain that contains the package from which to get the + // The name of the domain that contains the package from which to get the // associated package group. // // This member is required. Domain *string - // The format of the package from which to get the associated package group. + // The format of the package from which to get the associated package group. // // This member is required. Format types.PackageFormat - // The package from which to get the associated package group. + // The package from which to get the associated package group. // // This member is required. Package *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // The namespace of the package from which to get the associated package group. // The package component that specifies its namespace depends on its type. For - // example: The namespace is required when getting associated package groups from - // packages of the following formats: + // example: + // + // The namespace is required when getting associated package groups from packages + // of the following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string diff --git a/service/codeartifact/api_op_GetAuthorizationToken.go b/service/codeartifact/api_op_GetAuthorizationToken.go index 08bbb99f87f..d951944dac7 100644 --- a/service/codeartifact/api_op_GetAuthorizationToken.go +++ b/service/codeartifact/api_op_GetAuthorizationToken.go @@ -11,22 +11,30 @@ import ( "time" ) -// Generates a temporary authorization token for accessing repositories in the +// 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]. +// +// 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, -// with the durationSeconds parameter. The authorization period begins after login -// or GetAuthorizationToken is called. If login or GetAuthorizationToken is called -// while assuming a role, the token lifetime is independent of the maximum session -// 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. +// with the durationSeconds parameter. +// +// The authorization period begins after login or GetAuthorizationToken is called. +// If login or GetAuthorizationToken is called while assuming a role, the token +// lifetime is independent of the maximum session 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] for more information on controlling session duration. +// +// [Using IAM Roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html +// [CodeArtifact authentication and tokens]: https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error) { if params == nil { params = &GetAuthorizationTokenInput{} @@ -44,12 +52,12 @@ func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthoriza type GetAuthorizationTokenInput struct { - // The name of the domain that is in scope for the generated authorization token. + // The name of the domain that is in scope for the generated authorization token. // // This member is required. Domain *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -64,10 +72,10 @@ type GetAuthorizationTokenInput struct { type GetAuthorizationTokenOutput struct { - // The returned authentication token. + // The returned authentication token. AuthorizationToken *string - // A timestamp that specifies the date and time the authorization token expires. + // A timestamp that specifies the date and time the authorization token expires. Expiration *time.Time // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_GetDomainPermissionsPolicy.go b/service/codeartifact/api_op_GetDomainPermissionsPolicy.go index 0c440572e55..413a72372f9 100644 --- a/service/codeartifact/api_op_GetDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_GetDomainPermissionsPolicy.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IAM User Guide. +// 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]in the IAM User Guide. +// +// [Identity-based policies and resource-based policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html func (c *Client) GetDomainPermissionsPolicy(ctx context.Context, params *GetDomainPermissionsPolicyInput, optFns ...func(*Options)) (*GetDomainPermissionsPolicyOutput, error) { if params == nil { params = &GetDomainPermissionsPolicyInput{} @@ -32,12 +34,12 @@ func (c *Client) GetDomainPermissionsPolicy(ctx context.Context, params *GetDoma type GetDomainPermissionsPolicyInput struct { - // The name of the domain to which the resource policy is attached. + // The name of the domain to which the resource policy is attached. // // This member is required. Domain *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -46,7 +48,7 @@ type GetDomainPermissionsPolicyInput struct { type GetDomainPermissionsPolicyOutput struct { - // The returned resource policy. + // The returned resource policy. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_GetPackageVersionAsset.go b/service/codeartifact/api_op_GetPackageVersionAsset.go index cf35f4bda34..2ae9ba4c810 100644 --- a/service/codeartifact/api_op_GetPackageVersionAsset.go +++ b/service/codeartifact/api_op_GetPackageVersionAsset.go @@ -12,7 +12,8 @@ import ( "io" ) -// Returns an asset (or file) that is in a package. For example, for a Maven +// Returns an asset (or file) that is in a package. For example, for a Maven +// // package version, use GetPackageVersionAsset to download a JAR file, a POM file, // or any other assets in the package version. func (c *Client) GetPackageVersionAsset(ctx context.Context, params *GetPackageVersionAssetInput, optFns ...func(*Options)) (*GetPackageVersionAssetOutput, error) { @@ -32,58 +33,65 @@ func (c *Client) GetPackageVersionAsset(ctx context.Context, params *GetPackageV type GetPackageVersionAssetInput struct { - // The name of the requested asset. + // The name of the requested asset. // // This member is required. Asset *string - // The name of the domain that contains the repository that contains the package + // The name of the domain that contains the repository that contains the package // version with the requested asset. // // This member is required. Domain *string - // A format that specifies the type of the package version with the requested + // A format that specifies the type of the package version with the requested // asset file. // // This member is required. Format types.PackageFormat - // The name of the package that contains the requested asset. + // The name of the package that contains the requested asset. // // 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 repository that contains the package version with the requested asset. + // The repository that contains the package version with the requested asset. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // The namespace of the package version with the requested asset file. The package - // component that specifies its namespace depends on its type. For example: The - // namespace is required when requesting assets from package versions of the + // component that specifies its namespace depends on its type. For example: + // + // The namespace is required when requesting assets from package versions of the // following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 version revision that contains the requested asset. + // The name of the package version revision that contains the requested asset. PackageVersionRevision *string noSmithyDocumentSerde @@ -91,16 +99,16 @@ type GetPackageVersionAssetInput struct { type GetPackageVersionAssetOutput struct { - // The binary file, or asset, that is downloaded. + // The binary file, or asset, that is downloaded. Asset io.ReadCloser - // The name of the asset that is downloaded. + // 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. + // The name of the package version revision that contains the downloaded asset. PackageVersionRevision *string // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_GetPackageVersionReadme.go b/service/codeartifact/api_op_GetPackageVersionReadme.go index 21253f07e25..8fd7cab7002 100644 --- a/service/codeartifact/api_op_GetPackageVersionReadme.go +++ b/service/codeartifact/api_op_GetPackageVersionReadme.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the readme file or descriptive text for a package version. The returned -// text might contain formatting. For example, it might contain formatting for -// Markdown or reStructuredText. +// Gets the readme file or descriptive text for a package version. +// +// The returned text might contain formatting. For example, it might contain +// formatting for Markdown or reStructuredText. func (c *Client) GetPackageVersionReadme(ctx context.Context, params *GetPackageVersionReadmeInput, optFns ...func(*Options)) (*GetPackageVersionReadmeOutput, error) { if params == nil { params = &GetPackageVersionReadmeInput{} @@ -31,48 +32,55 @@ func (c *Client) GetPackageVersionReadme(ctx context.Context, params *GetPackage type GetPackageVersionReadmeInput struct { - // The name of the domain that contains the repository that contains the package + // The name of the domain that contains the repository that contains the package // version with the requested readme file. // // This member is required. Domain *string - // A format that specifies the type of the package version with the requested + // A format that specifies the type of the package version with the requested // readme file. // // This member is required. Format types.PackageFormat - // The name of the package version that contains the requested readme file. + // The name of the package version that contains the requested readme file. // // 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 repository that contains the package with the requested readme file. + // The repository that contains the package with the requested readme file. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // The namespace of the package version with the requested readme file. The // package component that specifies its namespace depends on its type. For example: + // // The namespace is required when requesting the readme from package versions of // the following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -82,29 +90,32 @@ type GetPackageVersionReadmeInput struct { type GetPackageVersionReadmeOutput struct { - // The format of the package with the requested readme file. + // 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 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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. + // The name of the package that contains the returned readme file. Package *string - // The text of the returned readme file. + // The text of the returned readme file. Readme *string - // The version of the package with the requested readme file. + // The version of the package with the requested readme file. Version *string - // The current revision associated with the package version. + // The current revision associated with the package version. VersionRevision *string // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_GetRepositoryEndpoint.go b/service/codeartifact/api_op_GetRepositoryEndpoint.go index 1dfe6c23205..a5c190f9b0b 100644 --- a/service/codeartifact/api_op_GetRepositoryEndpoint.go +++ b/service/codeartifact/api_op_GetRepositoryEndpoint.go @@ -11,14 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the endpoint of a repository for a specific package format. A +// Returns the endpoint of a repository for a specific package format. A +// // repository has one endpoint for each package format: +// // - generic +// // - maven +// // - npm +// // - nuget +// // - pypi +// // - ruby +// // - swift func (c *Client) GetRepositoryEndpoint(ctx context.Context, params *GetRepositoryEndpointInput, optFns ...func(*Options)) (*GetRepositoryEndpointOutput, error) { if params == nil { @@ -37,23 +45,23 @@ func (c *Client) GetRepositoryEndpoint(ctx context.Context, params *GetRepositor type GetRepositoryEndpointInput struct { - // The name of the domain that contains the repository. + // The name of the domain that contains the repository. // // This member is required. Domain *string - // Returns which endpoint of a repository to return. A repository has one endpoint - // for each package format. + // Returns which endpoint of a repository to return. A repository has one + // endpoint for each package format. // // This member is required. Format types.PackageFormat - // The name of the repository. + // The name of the repository. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain that contains the repository. It does not include dashes or spaces. DomainOwner *string @@ -62,7 +70,7 @@ type GetRepositoryEndpointInput struct { type GetRepositoryEndpointOutput struct { - // A string that specifies the URL of the returned endpoint. + // A string that specifies the URL of the returned endpoint. RepositoryEndpoint *string // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go index 180696b2acd..97728fd8537 100644 --- a/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_GetRepositoryPermissionsPolicy.go @@ -29,18 +29,19 @@ func (c *Client) GetRepositoryPermissionsPolicy(ctx context.Context, params *Get type GetRepositoryPermissionsPolicyInput struct { - // The name of the domain containing the repository whose associated resource + // The name of the domain containing the repository whose associated resource // policy is to be retrieved. // // This member is required. Domain *string - // The name of the repository whose associated resource policy is to be retrieved. + // The name of the repository whose associated resource policy is to be + // retrieved. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -49,7 +50,7 @@ type GetRepositoryPermissionsPolicyInput struct { type GetRepositoryPermissionsPolicyOutput struct { - // The returned resource policy. + // The returned resource policy. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_ListAllowedRepositoriesForGroup.go b/service/codeartifact/api_op_ListAllowedRepositoriesForGroup.go index 792d912d7f6..a626b3371f4 100644 --- a/service/codeartifact/api_op_ListAllowedRepositoriesForGroup.go +++ b/service/codeartifact/api_op_ListAllowedRepositoriesForGroup.go @@ -13,8 +13,9 @@ import ( // Lists the repositories in the added repositories list of the specified // restriction type for a package group. For more information about restriction -// types and added repository lists, see Package group origin controls (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html) -// in the CodeArtifact User Guide. +// types and added repository lists, see [Package group origin controls]in the CodeArtifact User Guide. +// +// [Package group origin controls]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html func (c *Client) ListAllowedRepositoriesForGroup(ctx context.Context, params *ListAllowedRepositoriesForGroupInput, optFns ...func(*Options)) (*ListAllowedRepositoriesForGroupOutput, error) { if params == nil { params = &ListAllowedRepositoriesForGroupInput{} @@ -32,7 +33,7 @@ func (c *Client) ListAllowedRepositoriesForGroup(ctx context.Context, params *Li type ListAllowedRepositoriesForGroupInput struct { - // The name of the domain that contains the package group from which to list + // The name of the domain that contains the package group from which to list // allowed repositories. // // This member is required. @@ -48,14 +49,14 @@ type ListAllowedRepositoriesForGroupInput struct { // This member is required. PackageGroup *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -68,7 +69,7 @@ type ListAllowedRepositoriesForGroupOutput struct { // restriction type. AllowedRepositories []string - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -168,7 +169,7 @@ var _ ListAllowedRepositoriesForGroupAPIClient = (*Client)(nil) // ListAllowedRepositoriesForGroupPaginatorOptions is the paginator options for // ListAllowedRepositoriesForGroup type ListAllowedRepositoriesForGroupPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListAssociatedPackages.go b/service/codeartifact/api_op_ListAssociatedPackages.go index ac13d34e876..efa56ac80b3 100644 --- a/service/codeartifact/api_op_ListAssociatedPackages.go +++ b/service/codeartifact/api_op_ListAssociatedPackages.go @@ -12,9 +12,10 @@ import ( ) // Returns a list of packages associated with the requested package group. For -// information package group association and matching, see Package group -// definition syntax and matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) -// in the CodeArtifact User Guide. +// information package group association and matching, see [Package group definition syntax and matching behavior]in the CodeArtifact +// User Guide. +// +// [Package group definition syntax and matching behavior]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html func (c *Client) ListAssociatedPackages(ctx context.Context, params *ListAssociatedPackagesInput, optFns ...func(*Options)) (*ListAssociatedPackagesOutput, error) { if params == nil { params = &ListAssociatedPackagesInput{} @@ -32,29 +33,29 @@ func (c *Client) ListAssociatedPackages(ctx context.Context, params *ListAssocia type ListAssociatedPackagesInput struct { - // The name of the domain that contains the package group from which to list + // The name of the domain that contains the package group from which to list // associated packages. // // This member is required. Domain *string - // The pattern of the package group from which to list associated packages. + // The pattern of the package group from which to list associated packages. // // This member is required. PackageGroup *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // When this flag is included, ListAssociatedPackages will return a list of + // When this flag is included, ListAssociatedPackages will return a list of // packages that would be associated with a package group, even if it does not // exist. Preview *bool @@ -64,11 +65,11 @@ type ListAssociatedPackagesInput struct { type ListAssociatedPackagesOutput struct { - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // The list of packages associated with the requested package group. + // The list of packages associated with the requested package group. Packages []types.AssociatedPackage // Metadata pertaining to the operation's result. @@ -167,7 +168,7 @@ var _ ListAssociatedPackagesAPIClient = (*Client)(nil) // ListAssociatedPackagesPaginatorOptions is the paginator options for // ListAssociatedPackages type ListAssociatedPackagesPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListDomains.go b/service/codeartifact/api_op_ListDomains.go index 0176729bef0..db51337522e 100644 --- a/service/codeartifact/api_op_ListDomains.go +++ b/service/codeartifact/api_op_ListDomains.go @@ -11,9 +11,12 @@ 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) -// objects for all domains owned by the Amazon Web Services account that makes this -// call. Each returned DomainSummary object contains information about a domain. +// Returns a list of [DomainSummary] objects for all domains owned by the Amazon Web Services +// +// account that makes this call. Each returned DomainSummary object contains +// information about a domain. +// +// [DomainSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error) { if params == nil { params = &ListDomainsInput{} @@ -31,10 +34,10 @@ func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optF type ListDomainsInput struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -43,11 +46,12 @@ type ListDomainsInput struct { type ListDomainsOutput struct { - // The returned list of DomainSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainSummary.html) - // objects. + // The returned list of [DomainSummary] objects. + // + // [DomainSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainSummary.html Domains []types.DomainSummary - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -142,7 +146,7 @@ var _ ListDomainsAPIClient = (*Client)(nil) // ListDomainsPaginatorOptions is the paginator options for ListDomains type ListDomainsPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListPackageGroups.go b/service/codeartifact/api_op_ListPackageGroups.go index b35a9668a4c..1cff6804f68 100644 --- a/service/codeartifact/api_op_ListPackageGroups.go +++ b/service/codeartifact/api_op_ListPackageGroups.go @@ -29,23 +29,23 @@ func (c *Client) ListPackageGroups(ctx context.Context, params *ListPackageGroup type ListPackageGroupsInput struct { - // The domain for which you want to list package groups. + // The domain for which you want to list package groups. // // This member is required. Domain *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // A prefix for which to search package groups. When included, ListPackageGroups + // A prefix for which to search package groups. When included, ListPackageGroups // will return only package groups with patterns that match the prefix. Prefix *string @@ -54,11 +54,11 @@ type ListPackageGroupsInput struct { type ListPackageGroupsOutput struct { - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // The list of package groups in the requested domain. + // The list of package groups in the requested domain. PackageGroups []types.PackageGroupSummary // Metadata pertaining to the operation's result. @@ -156,7 +156,7 @@ var _ ListPackageGroupsAPIClient = (*Client)(nil) // ListPackageGroupsPaginatorOptions is the paginator options for ListPackageGroups type ListPackageGroupsPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListPackageVersionAssets.go b/service/codeartifact/api_op_ListPackageVersionAssets.go index 860944eda0d..ee832edbc81 100644 --- a/service/codeartifact/api_op_ListPackageVersionAssets.go +++ b/service/codeartifact/api_op_ListPackageVersionAssets.go @@ -11,8 +11,9 @@ 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) -// objects for assets in a package version. +// Returns a list of [AssetSummary] objects for assets in a package version. +// +// [AssetSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html func (c *Client) ListPackageVersionAssets(ctx context.Context, params *ListPackageVersionAssetsInput, optFns ...func(*Options)) (*ListPackageVersionAssetsOutput, error) { if params == nil { params = &ListPackageVersionAssetsInput{} @@ -30,56 +31,64 @@ func (c *Client) ListPackageVersionAssets(ctx context.Context, params *ListPacka type ListPackageVersionAssetsInput struct { - // The name of the domain that contains the repository associated with the package - // version assets. + // The name of the domain that contains the repository associated with the + // package version assets. // // This member is required. Domain *string - // The format of the package that contains the requested package version assets. + // The format of the package that contains the requested package version assets. // // This member is required. Format types.PackageFormat - // The name of the package that contains the requested package version assets. + // The name of the package that contains the requested package version assets. // // 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 + // The name of the repository that contains the package that contains the // requested package version assets. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // 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 component that specifies its namespace depends on - // its type. For example: The namespace is required requesting assets from package - // versions of the following formats: + // its type. For example: + // + // The namespace is required requesting assets from package versions of the + // following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -88,33 +97,39 @@ type ListPackageVersionAssetsInput struct { type ListPackageVersionAssetsOutput struct { - // The returned list of AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) - // objects. + // The returned list of [AssetSummary] objects. + // + // [AssetSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html Assets []types.AssetSummary - // The format of the package that contains the requested package version assets. + // 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 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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. + // If there are additional results, this is the token for the next set of + // results. NextToken *string - // The name of the package that contains the requested package version assets. + // The name of the package that contains the requested package version assets. Package *string - // The version of the package associated with the requested assets. + // The version of the package associated with the requested assets. Version *string - // The current revision associated with the package version. + // The current revision associated with the package version. VersionRevision *string // Metadata pertaining to the operation's result. @@ -213,7 +228,7 @@ var _ ListPackageVersionAssetsAPIClient = (*Client)(nil) // ListPackageVersionAssetsPaginatorOptions is the paginator options for // ListPackageVersionAssets type ListPackageVersionAssetsPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListPackageVersionDependencies.go b/service/codeartifact/api_op_ListPackageVersionDependencies.go index 174d21c686b..f303a579ca6 100644 --- a/service/codeartifact/api_op_ListPackageVersionDependencies.go +++ b/service/codeartifact/api_op_ListPackageVersionDependencies.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// Returns the direct dependencies for a package version. The dependencies are +// +// returned as [PackageDependency]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. +// +// [PackageDependency]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html func (c *Client) ListPackageVersionDependencies(ctx context.Context, params *ListPackageVersionDependenciesInput, optFns ...func(*Options)) (*ListPackageVersionDependenciesOutput, error) { if params == nil { params = &ListPackageVersionDependenciesInput{} @@ -34,52 +37,59 @@ func (c *Client) ListPackageVersionDependencies(ctx context.Context, params *Lis type ListPackageVersionDependenciesInput struct { - // The name of the domain that contains the repository that contains the requested - // package version dependencies. + // The name of the domain that contains the repository that contains the + // requested package version dependencies. // // This member is required. Domain *string - // The format of the package with the requested dependencies. + // The format of the package with the requested dependencies. // // This member is required. Format types.PackageFormat - // The name of the package versions' package. + // The name of the package versions' package. // // 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 requested package version. + // The name of the repository that contains the requested package version. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // The namespace of the package version with the requested dependencies. The // package component that specifies its namespace depends on its type. For example: - // The namespace is required when listing dependencies from package versions of the - // following formats: + // + // The namespace is required when listing dependencies from package versions of + // the following formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -88,36 +98,41 @@ type ListPackageVersionDependenciesInput struct { type ListPackageVersionDependenciesOutput struct { - // The returned list of PackageDependency (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) - // objects. + // The returned list of [PackageDependency] objects. + // + // [PackageDependency]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html Dependencies []types.PackageDependency - // A format that specifies the type of the package that contains the returned + // A format that specifies the type of the package that contains the returned // dependencies. Format types.PackageFormat // The namespace of the package version that contains the returned dependencies. // The package 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // The name of the package that contains the returned package versions + // The name of the package that contains the returned package versions // dependencies. Package *string - // The version of the package that is specified in the request. + // The version of the package that is specified in the request. Version *string - // The current revision associated with the package version. + // The current revision associated with the package version. VersionRevision *string // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_ListPackageVersions.go b/service/codeartifact/api_op_ListPackageVersions.go index 1191b74b22e..1141cdcdd9d 100644 --- a/service/codeartifact/api_op_ListPackageVersions.go +++ b/service/codeartifact/api_op_ListPackageVersions.go @@ -11,10 +11,12 @@ 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) -// 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. +// Returns a list of [PackageVersionSummary] 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. +// +// [PackageVersionSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVersionsInput, optFns ...func(*Options)) (*ListPackageVersionsOutput, error) { if params == nil { params = &ListPackageVersionsInput{} @@ -32,50 +34,57 @@ func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVer type ListPackageVersionsInput struct { - // The name of the domain that contains the repository that contains the requested - // package versions. + // The name of the domain that contains the repository that contains the + // requested package versions. // // This member is required. Domain *string - // The format of the package versions you want to list. + // The format of the package versions you want to list. // // This member is required. Format types.PackageFormat - // The name of the package for which you want to request package versions. + // The name of the package for which you want to request package versions. // // This member is required. Package *string - // The name of the repository that contains the requested package versions. + // The name of the repository that contains the requested package versions. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // The maximum number of results to return per page. 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: + // // The namespace is required when deleting package versions of the following // formats: + // // - Maven + // // - Swift + // // - generic // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -83,10 +92,10 @@ type ListPackageVersionsInput struct { // provided originType will be returned. OriginType types.PackageVersionOriginType - // How to sort the requested list of package versions. + // How to sort the requested list of package versions. SortBy types.PackageVersionSortType - // A string that filters the requested package versions by status. + // A string that filters the requested package versions by status. Status types.PackageVersionStatus noSmithyDocumentSerde @@ -94,34 +103,41 @@ type ListPackageVersionsInput struct { type ListPackageVersionsOutput struct { - // The default package version to display. This depends on the package format: + // 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. DefaultDisplayVersion *string - // A format of the package. + // 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 version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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. + // If there are additional results, this is the token for the next set of + // results. NextToken *string - // The name of the package. + // The name of the package. Package *string - // The returned list of PackageVersionSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) - // objects. + // The returned list of [PackageVersionSummary] objects. + // + // [PackageVersionSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html Versions []types.PackageVersionSummary // Metadata pertaining to the operation's result. @@ -220,7 +236,7 @@ var _ ListPackageVersionsAPIClient = (*Client)(nil) // ListPackageVersionsPaginatorOptions is the paginator options for // ListPackageVersions type ListPackageVersionsPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListPackages.go b/service/codeartifact/api_op_ListPackages.go index 21af680ff04..a00a3c78288 100644 --- a/service/codeartifact/api_op_ListPackages.go +++ b/service/codeartifact/api_op_ListPackages.go @@ -11,8 +11,11 @@ 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) -// objects for packages in a repository that match the request parameters. +// Returns a list of [PackageSummary] objects for packages in a repository that match the request +// +// parameters. +// +// [PackageSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, optFns ...func(*Options)) (*ListPackagesOutput, error) { if params == nil { params = &ListPackagesInput{} @@ -30,18 +33,18 @@ func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, op type ListPackagesInput struct { - // The name of the domain that contains the repository that contains the requested - // packages. + // The name of the domain that contains the repository that contains the + // requested packages. // // This member is required. Domain *string - // The name of the repository that contains the requested packages. + // The name of the repository that contains the requested packages. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -49,38 +52,46 @@ type ListPackagesInput struct { // format will be returned. Format types.PackageFormat - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 // 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 - // prefix-matching behavior. Each package format uses namespace as follows: + // prefix-matching behavior. + // + // Each package format uses namespace as follows: + // // - The namespace of a Maven package version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // A prefix used to filter requested packages. Only packages with names that start - // with packagePrefix are returned. + // A prefix used to filter requested packages. Only packages with names that + // start with packagePrefix are returned. PackagePrefix *string // 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]. + // + // [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]. + // + // [PackageOriginRestrictions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html Upstream types.AllowUpstream noSmithyDocumentSerde @@ -88,11 +99,13 @@ type ListPackagesInput struct { type ListPackagesOutput struct { - // If there are additional results, this is the token for the next set of results. + // 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) - // objects. + // The list of returned [PackageSummary] objects. + // + // [PackageSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html Packages []types.PackageSummary // Metadata pertaining to the operation's result. @@ -189,7 +202,7 @@ var _ ListPackagesAPIClient = (*Client)(nil) // ListPackagesPaginatorOptions is the paginator options for ListPackages type ListPackagesPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListRepositories.go b/service/codeartifact/api_op_ListRepositories.go index 963ab63bbde..e336b48b036 100644 --- a/service/codeartifact/api_op_ListRepositories.go +++ b/service/codeartifact/api_op_ListRepositories.go @@ -11,9 +11,12 @@ 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) -// objects. Each RepositorySummary contains information about a repository in the -// specified Amazon Web Services account and that matches the input parameters. +// Returns a list of [RepositorySummary] objects. Each RepositorySummary contains information about +// +// a repository in the specified Amazon Web Services account and that matches the +// input parameters. +// +// [RepositorySummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesInput, optFns ...func(*Options)) (*ListRepositoriesOutput, error) { if params == nil { params = &ListRepositoriesInput{} @@ -31,14 +34,14 @@ func (c *Client) ListRepositories(ctx context.Context, params *ListRepositoriesI type ListRepositoriesInput struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // A prefix used to filter returned repositories. Only repositories with names + // A prefix used to filter returned repositories. Only repositories with names // that start with repositoryPrefix are returned. RepositoryPrefix *string @@ -47,11 +50,13 @@ type ListRepositoriesInput struct { type ListRepositoriesOutput struct { - // If there are additional results, this is the token for the next set of results. + // 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) - // objects. + // The returned list of [RepositorySummary] objects. + // + // [RepositorySummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html Repositories []types.RepositorySummary // Metadata pertaining to the operation's result. @@ -146,7 +151,7 @@ var _ ListRepositoriesAPIClient = (*Client)(nil) // ListRepositoriesPaginatorOptions is the paginator options for ListRepositories type ListRepositoriesPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListRepositoriesInDomain.go b/service/codeartifact/api_op_ListRepositoriesInDomain.go index 4e323fe1a38..e0341fffd5b 100644 --- a/service/codeartifact/api_op_ListRepositoriesInDomain.go +++ b/service/codeartifact/api_op_ListRepositoriesInDomain.go @@ -11,9 +11,11 @@ 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) -// objects. Each RepositorySummary contains information about a repository in the -// specified domain and that matches the input parameters. +// Returns a list of [RepositorySummary] objects. Each RepositorySummary contains information about +// +// a repository in the specified domain and that matches the input parameters. +// +// [RepositorySummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html func (c *Client) ListRepositoriesInDomain(ctx context.Context, params *ListRepositoriesInDomainInput, optFns ...func(*Options)) (*ListRepositoriesInDomainOutput, error) { if params == nil { params = &ListRepositoriesInDomainInput{} @@ -31,27 +33,27 @@ func (c *Client) ListRepositoriesInDomain(ctx context.Context, params *ListRepos type ListRepositoriesInDomainInput struct { - // The name of the domain that contains the returned list of repositories. + // The name of the domain that contains the returned list of repositories. // // This member is required. Domain *string - // Filter the list of repositories to only include those that are managed by the + // Filter the list of repositories to only include those that are managed by the // Amazon Web Services account ID. AdministratorAccount *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string - // A prefix used to filter returned repositories. Only repositories with names + // A prefix used to filter returned repositories. Only repositories with names // that start with repositoryPrefix are returned. RepositoryPrefix *string @@ -60,10 +62,11 @@ type ListRepositoriesInDomainInput struct { type ListRepositoriesInDomainOutput struct { - // If there are additional results, this is the token for the next set of results. + // If there are additional results, this is the token for the next set of + // results. NextToken *string - // The returned list of repositories. + // The returned list of repositories. Repositories []types.RepositorySummary // Metadata pertaining to the operation's result. @@ -162,7 +165,7 @@ var _ ListRepositoriesInDomainAPIClient = (*Client)(nil) // ListRepositoriesInDomainPaginatorOptions is the paginator options for // ListRepositoriesInDomain type ListRepositoriesInDomainPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_ListSubPackageGroups.go b/service/codeartifact/api_op_ListSubPackageGroups.go index 49d68a026dc..9c82c33c6f8 100644 --- a/service/codeartifact/api_op_ListSubPackageGroups.go +++ b/service/codeartifact/api_op_ListSubPackageGroups.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of direct children of the specified package group. For -// information package group hierarchy, see Package group definition syntax and -// matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) -// in the CodeArtifact User Guide. +// Returns a list of direct children of the specified package group. +// +// For information package group hierarchy, see [Package group definition syntax and matching behavior] in the CodeArtifact User Guide. +// +// [Package group definition syntax and matching behavior]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html func (c *Client) ListSubPackageGroups(ctx context.Context, params *ListSubPackageGroupsInput, optFns ...func(*Options)) (*ListSubPackageGroupsOutput, error) { if params == nil { params = &ListSubPackageGroupsInput{} @@ -32,25 +33,25 @@ func (c *Client) ListSubPackageGroups(ctx context.Context, params *ListSubPackag type ListSubPackageGroupsInput struct { - // The name of the domain which contains the package group from which to list sub + // The name of the domain which contains the package group from which to list sub // package groups. // // This member is required. Domain *string - // The pattern of the package group from which to list sub package groups. + // The pattern of the package group from which to list sub package groups. // // This member is required. PackageGroup *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The maximum number of results to return per page. + // The maximum number of results to return per page. MaxResults *int32 - // The token for the next set of results. Use the value returned in the previous + // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string @@ -59,10 +60,11 @@ type ListSubPackageGroupsInput struct { type ListSubPackageGroupsOutput struct { - // If there are additional results, this is the token for the next set of results. + // If there are additional results, this is the token for the next set of + // results. NextToken *string - // A list of sub package groups for the requested package group. + // A list of sub package groups for the requested package group. PackageGroups []types.PackageGroupSummary // Metadata pertaining to the operation's result. @@ -161,7 +163,7 @@ var _ ListSubPackageGroupsAPIClient = (*Client)(nil) // ListSubPackageGroupsPaginatorOptions is the paginator options for // ListSubPackageGroups type ListSubPackageGroupsPaginatorOptions struct { - // The maximum number of results to return per page. + // The maximum number of results to return per page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeartifact/api_op_PublishPackageVersion.go b/service/codeartifact/api_op_PublishPackageVersion.go index 165e7d5c202..beeea46f91b 100644 --- a/service/codeartifact/api_op_PublishPackageVersion.go +++ b/service/codeartifact/api_op_PublishPackageVersion.go @@ -12,16 +12,20 @@ import ( "io" ) -// 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) -// 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. +// 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]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]. 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]in the CodeArtifact User Guide. +// +// [Using generic packages]: https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html +// [UpdatePackageVersionStatus]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html +// [Package version status]: https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status func (c *Client) PublishPackageVersion(ctx context.Context, params *PublishPackageVersionInput, optFns ...func(*Options)) (*PublishPackageVersionOutput, error) { if params == nil { params = &PublishPackageVersionInput{} @@ -52,9 +56,13 @@ type PublishPackageVersionInput struct { 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) - // 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. + // by the caller and provided with the request (see [Publishing a generic package]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. + // + // [Publishing a generic package]: https://docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html#publishing-generic-packages // // This member is required. AssetSHA256 *string @@ -66,7 +74,9 @@ type PublishPackageVersionInput struct { Domain *string // A format that specifies the type of the package version with the requested - // asset file. The only supported value is generic . + // asset file. + // + // The only supported value is generic . // // This member is required. Format types.PackageFormat @@ -94,9 +104,12 @@ type PublishPackageVersionInput struct { Namespace *string // 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) - // in the CodeArtifact User Guide). Valid values: unfinished + // omitted, the package version status will be set to Published (see [Package version status] in the + // CodeArtifact User Guide). + // + // Valid values: unfinished + // + // [Package version status]: https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status Unfinished *bool noSmithyDocumentSerde @@ -104,8 +117,9 @@ type PublishPackageVersionInput struct { type PublishPackageVersionOutput struct { - // An AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) - // for the published asset. + // An [AssetSummary] for the published asset. + // + // [AssetSummary]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html Asset *types.AssetSummary // The format of the package version. @@ -118,8 +132,9 @@ 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) - // in the CodeArtifact User Guide. + // see [Package version status]in the CodeArtifact User Guide. + // + // [Package version status]: https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status Status types.PackageVersionStatus // The version of the package. diff --git a/service/codeartifact/api_op_PutDomainPermissionsPolicy.go b/service/codeartifact/api_op_PutDomainPermissionsPolicy.go index 54deb23908a..37774bc3cb3 100644 --- a/service/codeartifact/api_op_PutDomainPermissionsPolicy.go +++ b/service/codeartifact/api_op_PutDomainPermissionsPolicy.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets a resource policy on a domain that specifies permissions to access it. +// 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 @@ -33,22 +34,22 @@ func (c *Client) PutDomainPermissionsPolicy(ctx context.Context, params *PutDoma type PutDomainPermissionsPolicyInput struct { - // The name of the domain on which to set the resource policy. + // The name of the domain on which to set the resource policy. // // This member is required. Domain *string - // A valid displayable JSON Aspen policy string to be set as the access control + // A valid displayable JSON Aspen policy string to be set as the access control // resource policy on the provided domain. // // This member is required. PolicyDocument *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The current revision of the resource policy to be set. This revision is used + // 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 @@ -58,7 +59,7 @@ type PutDomainPermissionsPolicyInput struct { type PutDomainPermissionsPolicyOutput struct { - // The resource policy that was set after processing the request. + // The resource policy that was set after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_PutPackageOriginConfiguration.go b/service/codeartifact/api_op_PutPackageOriginConfiguration.go index c045f41e56b..82168bcec84 100644 --- a/service/codeartifact/api_op_PutPackageOriginConfiguration.go +++ b/service/codeartifact/api_op_PutPackageOriginConfiguration.go @@ -11,20 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the package origin configuration for a package. The package origin -// configuration determines how new versions of a package can be added to a -// 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 -// repository. +// Sets the package origin configuration for a package. +// +// The package origin configuration determines how new versions of a package can +// be added to a 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]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. +// +// [Editing package origin controls]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html func (c *Client) PutPackageOriginConfiguration(ctx context.Context, params *PutPackageOriginConfigurationInput, optFns ...func(*Options)) (*PutPackageOriginConfigurationOutput, error) { if params == nil { params = &PutPackageOriginConfigurationInput{} @@ -62,26 +65,32 @@ type PutPackageOriginConfigurationInput struct { // This member is required. Repository *string - // 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 - // publish restriction determines if new package versions can be published directly - // to the repository. You must include both the desired upstream and publish - // restrictions. + // A [PackageOriginRestrictions] 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 publish restriction determines if new package versions can be + // published directly to the repository. + // + // You must include both the desired upstream and publish restrictions. + // + // [PackageOriginRestrictions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html // // This member is required. Restrictions *types.PackageOriginRestrictions - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // 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 version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -91,11 +100,12 @@ type PutPackageOriginConfigurationInput struct { type PutPackageOriginConfigurationOutput struct { - // 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) - // object that describes how new versions of the package can be introduced to the - // repository. + // A [PackageOriginConfiguration] object that describes the origin configuration set for the package. It + // contains a [PackageOriginRestrictions]object that describes how new versions of the package can be + // introduced to the repository. + // + // [PackageOriginRestrictions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html + // [PackageOriginConfiguration]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html OriginConfiguration *types.PackageOriginConfiguration // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go b/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go index 0a1d59dafab..c9b64e3e038 100644 --- a/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go +++ b/service/codeartifact/api_op_PutRepositoryPermissionsPolicy.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the resource policy on a repository that specifies permissions to access -// it. When you call PutRepositoryPermissionsPolicy , the resource policy on the +// Sets the resource policy on a repository that specifies permissions to access +// +// 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. @@ -33,27 +36,28 @@ func (c *Client) PutRepositoryPermissionsPolicy(ctx context.Context, params *Put type PutRepositoryPermissionsPolicyInput struct { - // The name of the domain containing the repository to set the resource policy on. + // The name of the domain containing the repository to set the resource policy + // on. // // This member is required. Domain *string - // A valid displayable JSON Aspen policy string to be set as the access control + // A valid displayable JSON Aspen policy string to be set as the access control // resource policy on the provided repository. // // This member is required. PolicyDocument *string - // The name of the repository to set the resource policy on. + // The name of the repository to set the resource policy on. // // This member is required. Repository *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // Sets the revision of the resource policy that specifies permissions to access + // Sets the revision of the resource policy that specifies permissions to access // the repository. This revision is used for optimistic locking, which prevents // others from overwriting your changes to the repository's resource policy. PolicyRevision *string @@ -63,7 +67,7 @@ type PutRepositoryPermissionsPolicyInput struct { type PutRepositoryPermissionsPolicyOutput struct { - // The resource policy that was set after processing the request. + // The resource policy that was set after processing the request. Policy *types.ResourcePolicy // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_UpdatePackageGroup.go b/service/codeartifact/api_op_UpdatePackageGroup.go index a7c19da68f7..eb041d16eff 100644 --- a/service/codeartifact/api_op_UpdatePackageGroup.go +++ b/service/codeartifact/api_op_UpdatePackageGroup.go @@ -13,8 +13,9 @@ import ( // Updates a package group. This API cannot be used to update a package group's // origin configuration or pattern. To update a package group's origin -// configuration, use UpdatePackageGroupOriginConfiguration (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageGroupOriginConfiguration.html) -// . +// configuration, use [UpdatePackageGroupOriginConfiguration]. +// +// [UpdatePackageGroupOriginConfiguration]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageGroupOriginConfiguration.html func (c *Client) UpdatePackageGroup(ctx context.Context, params *UpdatePackageGroupInput, optFns ...func(*Options)) (*UpdatePackageGroupOutput, error) { if params == nil { params = &UpdatePackageGroupInput{} @@ -32,23 +33,23 @@ func (c *Client) UpdatePackageGroup(ctx context.Context, params *UpdatePackageGr type UpdatePackageGroupInput struct { - // The name of the domain which contains the package group to be updated. + // The name of the domain which contains the package group to be updated. // // This member is required. Domain *string - // The pattern of the package group to be updated. + // The pattern of the package group to be updated. // // This member is required. PackageGroup *string - // Contact information which you want to update the requested package group with. + // Contact information which you want to update the requested package group with. ContactInfo *string - // The description you want to update the requested package group with. + // The description you want to update the requested package group with. Description *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -57,7 +58,8 @@ type UpdatePackageGroupInput struct { type UpdatePackageGroupOutput struct { - // The package group and information about it after the request has been processed. + // The package group and information about it after the request has been + // processed. PackageGroup *types.PackageGroupDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_UpdatePackageGroupOriginConfiguration.go b/service/codeartifact/api_op_UpdatePackageGroupOriginConfiguration.go index e67df4ba6e3..9da6894018e 100644 --- a/service/codeartifact/api_op_UpdatePackageGroupOriginConfiguration.go +++ b/service/codeartifact/api_op_UpdatePackageGroupOriginConfiguration.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the package origin configuration for a package group. The package -// origin configuration determines how new versions of a package can be added to a -// 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 group origin controls and -// configuration, see Package group origin controls (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html) -// in the CodeArtifact User Guide. +// Updates the package origin configuration for a package group. +// +// The package origin configuration determines how new versions of a package can +// be added to a 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 group +// origin controls and configuration, see [Package group origin controls]in the CodeArtifact User Guide. +// +// [Package group origin controls]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html func (c *Client) UpdatePackageGroupOriginConfiguration(ctx context.Context, params *UpdatePackageGroupOriginConfigurationInput, optFns ...func(*Options)) (*UpdatePackageGroupOriginConfigurationOutput, error) { if params == nil { params = &UpdatePackageGroupOriginConfigurationInput{} @@ -35,13 +37,13 @@ func (c *Client) UpdatePackageGroupOriginConfiguration(ctx context.Context, para type UpdatePackageGroupOriginConfigurationInput struct { - // The name of the domain which contains the package group for which to update the - // origin configuration. + // The name of the domain which contains the package group for which to update + // the origin configuration. // // This member is required. Domain *string - // The pattern of the package group for which to update the origin configuration. + // The pattern of the package group for which to update the origin configuration. // // This member is required. PackageGroup *string @@ -50,7 +52,7 @@ type UpdatePackageGroupOriginConfigurationInput struct { // the specified package group. AddAllowedRepositories []types.PackageGroupAllowedRepository - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -58,8 +60,8 @@ type UpdatePackageGroupOriginConfigurationInput struct { // of the specified package group. RemoveAllowedRepositories []types.PackageGroupAllowedRepository - // The origin configuration settings that determine how package versions can enter - // repositories. + // The origin configuration settings that determine how package versions can + // enter repositories. Restrictions map[string]types.PackageGroupOriginRestrictionMode noSmithyDocumentSerde @@ -70,7 +72,7 @@ type UpdatePackageGroupOriginConfigurationOutput struct { // Information about the updated allowed repositories after processing the request. AllowedRepositoryUpdates map[string]map[string][]string - // The package group and information about it after processing the request. + // The package group and information about it after processing the request. PackageGroup *types.PackageGroupDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/api_op_UpdatePackageVersionsStatus.go b/service/codeartifact/api_op_UpdatePackageVersionsStatus.go index 89f7453e073..1701bb0192e 100644 --- a/service/codeartifact/api_op_UpdatePackageVersionsStatus.go +++ b/service/codeartifact/api_op_UpdatePackageVersionsStatus.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the status of one or more versions of a package. Using +// 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) -// . +// Disposed , use [DisposePackageVersions]. +// +// [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{} @@ -33,58 +35,62 @@ func (c *Client) UpdatePackageVersionsStatus(ctx context.Context, params *Update type UpdatePackageVersionsStatusInput struct { - // The name of the domain that contains the repository that contains the package + // The name of the domain that contains the repository that contains the package // versions with a status to be updated. // // This member is required. Domain *string - // A format that specifies the type of the package with the statuses to update. + // A format that specifies the type of the package with the statuses to update. // // This member is required. Format types.PackageFormat - // The name of the package with the version statuses to update. + // The name of the package with the version statuses to update. // // This member is required. Package *string - // The repository that contains the package versions with the status you want to + // The repository that contains the package versions with the status you want to // update. // // This member is required. Repository *string - // The status you want to change the package version status to. + // The status you want to change the package version status to. // // This member is required. TargetStatus types.PackageVersionStatus - // An array of strings that specify the versions of the package with the statuses + // An array of strings that specify the versions of the package with the statuses // to update. // // This member is required. Versions []string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The package version’s expected status before it is updated. If 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 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string - // A map of package versions and package version revisions. The map key is the + // 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 // revision. VersionRevisions map[string]string @@ -94,11 +100,11 @@ type UpdatePackageVersionsStatusInput struct { type UpdatePackageVersionsStatusOutput struct { - // A list of SuccessfulPackageVersionInfo objects, one for each package version + // A list of SuccessfulPackageVersionInfo objects, one for each package version // with a status that successfully updated. FailedVersions map[string]types.PackageVersionError - // A list of PackageVersionError objects, one for each package version with a + // A list of PackageVersionError objects, one for each package version with a // status that failed to update. SuccessfulVersions map[string]types.SuccessfulPackageVersionInfo diff --git a/service/codeartifact/api_op_UpdateRepository.go b/service/codeartifact/api_op_UpdateRepository.go index 03bc9efb3d6..727f705ffd0 100644 --- a/service/codeartifact/api_op_UpdateRepository.go +++ b/service/codeartifact/api_op_UpdateRepository.go @@ -29,28 +29,28 @@ func (c *Client) UpdateRepository(ctx context.Context, params *UpdateRepositoryI type UpdateRepositoryInput struct { - // The name of the domain associated with the repository to update. + // The name of the domain associated with the repository to update. // // This member is required. Domain *string - // The name of the repository to update. + // The name of the repository to update. // // This member is required. Repository *string - // An updated repository description. + // An updated repository description. Description *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // A list of upstream repositories to associate with the repository. The order of + // 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) - // . + // CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories]. + // + // [Working with upstream repositories]: https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html Upstreams []types.UpstreamRepository noSmithyDocumentSerde @@ -58,7 +58,7 @@ type UpdateRepositoryInput struct { type UpdateRepositoryOutput struct { - // The updated repository. + // The updated repository. Repository *types.RepositoryDescription // Metadata pertaining to the operation's result. diff --git a/service/codeartifact/doc.go b/service/codeartifact/doc.go index 9b099a69243..7cda0fec3eb 100644 --- a/service/codeartifact/doc.go +++ b/service/codeartifact/doc.go @@ -3,44 +3,60 @@ // Package codeartifact provides the API client, operations, and parameter types // for CodeArtifact. // -// CodeArtifact is a fully managed artifact repository compatible with +// CodeArtifact is a fully managed artifact repository compatible with +// // language-native package managers and build tools such as npm, Apache Maven, pip, // and dotnet. You can use CodeArtifact to share packages with development teams // and pull packages. Packages can be pulled from both public and CodeArtifact // repositories. You can also create an upstream relationship between a // CodeArtifact repository and another repository, which effectively merges their -// contents from the point of view of a package manager client. CodeArtifact -// concepts -// - 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 such as the -// npm CLI or the Maven CLI ( mvn ). For a list of supported package managers, -// see the CodeArtifact User Guide (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html) -// . +// contents from the point of view of a package manager client. +// +// CodeArtifact concepts +// +// - Repository: A CodeArtifact repository contains a set of [package versions], 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 such as the npm CLI +// or the Maven CLI ( mvn ). For a list of supported package managers, see the [CodeArtifact User Guide]. +// // - 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, PyPI, -// Maven, NuGet, Swift, Ruby, and generic package formats. For more information -// about the supported package formats and how to use CodeArtifact with them, see -// the CodeArtifact User Guide (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html) -// . In CodeArtifact, a package consists of: +// 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, PyPI, +// Maven, NuGet, Swift, Ruby, and generic package formats. For more information +// about the supported package formats and how to use CodeArtifact with them, see +// the [CodeArtifact User Guide]. +// +// 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 group: A group of packages that match a specified definition. // Package groups can be used to apply configuration to multiple packages that // match a defined pattern using package format, package namespace, and package @@ -48,112 +64,171 @@ // controls for multiple packages. Package origin controls are used to block or // allow ingestion or publishing of new package versions, which protects users from // malicious actions known as dependency substitution attacks. +// // - 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. +// example, npm package versions must conform to the [Semantic Versioning specification]. 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 supported API 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. +// // - CreatePackageGroup : Creates a package group. +// // - 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. +// // - DeletePackageGroup : Deletes a package group. Does not delete packages or // package versions that are associated with a package group. +// // - 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. -// - DescribePackageGroup : Returns a PackageGroup (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroup.html) -// object that contains details about a package group. -// - DescribePackageVersion : Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) -// object that contains details about a package version. +// +// - DescribePackage : Returns a [PackageDescription]object that contains details about a package. +// +// - DescribePackageGroup : Returns a [PackageGroup]object that contains details about a +// package group. +// +// - DescribePackageVersion : Returns a [PackageVersionDescription]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. +// // - GetAssociatedPackageGroup : Returns the most closely associated package // group to the specified package. +// // - 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: +// // - generic +// // - maven +// // - npm +// // - nuget +// // - pypi +// // - ruby +// // - swift +// // - GetRepositoryPermissionsPolicy : Returns the resource policy that is set on // a repository. +// // - ListAllowedRepositoriesForGroup : Lists the allowed repositories for a // package group that has origin configuration set to ALLOW_SPECIFIC_REPOSITORIES // . +// // - ListAssociatedPackages : Returns a list of packages associated with the // requested package group. +// // - ListDomains : Returns a list of DomainSummary objects. Each returned // DomainSummary object contains information about a domain. +// // - ListPackages : Lists the packages in a repository. -// - ListPackageGroups : Returns a list of package groups in the requested -// domain. +// +// - ListPackageGroups : Returns a list of package groups in the requested domain. +// // - 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. +// // - ListSubPackageGroups : Returns a list of direct children of the specified // package group. +// // - 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. +// // - UpdatePackageGroup : Updates a package group. This API cannot be used to // update a package group's origin configuration or pattern. +// // - UpdatePackageGroupOriginConfiguration : Updates the package origin // configuration for a package group. +// // - UpdatePackageVersionsStatus : Updates the status of one or more versions of // a package. +// // - UpdateRepository : Updates the properties of a repository. +// +// [Semantic Versioning specification]: https://semver.org/ +// [package versions]: https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version +// [CodeArtifact User Guide]: https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html +// [PackageDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html +// [PackageGroup]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroup.html +// [PackageVersionDescription]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html package codeartifact diff --git a/service/codeartifact/options.go b/service/codeartifact/options.go index 5e5558ae758..6f2aa11f35a 100644 --- a/service/codeartifact/options.go +++ b/service/codeartifact/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codeartifact/types/enums.go b/service/codeartifact/types/enums.go index 817edc87e5b..a27d85ba727 100644 --- a/service/codeartifact/types/enums.go +++ b/service/codeartifact/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AllowUpstream. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllowUpstream) Values() []AllowUpstream { return []AllowUpstream{ "ALLOW", @@ -47,8 +49,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -65,6 +68,7 @@ const ( // 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{ @@ -83,8 +87,9 @@ const ( ) // Values returns all known values for HashAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HashAlgorithm) Values() []HashAlgorithm { return []HashAlgorithm{ "MD5", @@ -108,8 +113,9 @@ const ( ) // Values returns all known values for PackageFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageFormat) Values() []PackageFormat { return []PackageFormat{ "npm", @@ -132,8 +138,9 @@ const ( // Values returns all known values for PackageGroupAllowedRepositoryUpdateType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageGroupAllowedRepositoryUpdateType) Values() []PackageGroupAllowedRepositoryUpdateType { return []PackageGroupAllowedRepositoryUpdateType{ "ADDED", @@ -151,6 +158,7 @@ const ( // Values returns all known values for PackageGroupAssociationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PackageGroupAssociationType) Values() []PackageGroupAssociationType { return []PackageGroupAssociationType{ @@ -171,8 +179,9 @@ const ( // Values returns all known values for PackageGroupOriginRestrictionMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageGroupOriginRestrictionMode) Values() []PackageGroupOriginRestrictionMode { return []PackageGroupOriginRestrictionMode{ "ALLOW", @@ -193,8 +202,9 @@ const ( // Values returns all known values for PackageGroupOriginRestrictionType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageGroupOriginRestrictionType) Values() []PackageGroupOriginRestrictionType { return []PackageGroupOriginRestrictionType{ "EXTERNAL_UPSTREAM", @@ -216,8 +226,9 @@ const ( ) // Values returns all known values for PackageVersionErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionErrorCode) Values() []PackageVersionErrorCode { return []PackageVersionErrorCode{ "ALREADY_EXISTS", @@ -240,6 +251,7 @@ const ( // 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{ @@ -257,8 +269,9 @@ const ( ) // Values returns all known values for PackageVersionSortType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionSortType) Values() []PackageVersionSortType { return []PackageVersionSortType{ "PUBLISHED_TIME", @@ -278,8 +291,9 @@ const ( ) // Values returns all known values for PackageVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionStatus) Values() []PackageVersionStatus { return []PackageVersionStatus{ "Published", @@ -303,8 +317,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -328,6 +343,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/codeartifact/types/errors.go b/service/codeartifact/types/errors.go index 26eda5d72de..f444f9c5fb9 100644 --- a/service/codeartifact/types/errors.go +++ b/service/codeartifact/types/errors.go @@ -62,7 +62,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation did not succeed because of an error that occurred inside +// The operation did not succeed because of an error that occurred inside +// // CodeArtifact. type InternalServerException struct { Message *string @@ -89,7 +90,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 operation did not succeed because the resource requested is not found in +// // the service. type ResourceNotFoundException struct { Message *string @@ -119,7 +121,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 +// The operation did not succeed because it would have exceeded a service limit +// // for your account. type ServiceQuotaExceededException struct { Message *string @@ -149,7 +152,9 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation did not succeed because too many requests are sent to the service. +// The operation did not succeed because too many requests are sent to the +// +// service. type ThrottlingException struct { Message *string @@ -177,7 +182,8 @@ func (e *ThrottlingException) ErrorCode() string { } func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation did not succeed because a parameter in the request was sent with +// The operation did not succeed because a parameter in the request was sent with +// // an invalid value. type ValidationException struct { Message *string diff --git a/service/codeartifact/types/types.go b/service/codeartifact/types/types.go index 3c299a7c38f..d8cca6c864f 100644 --- a/service/codeartifact/types/types.go +++ b/service/codeartifact/types/types.go @@ -10,15 +10,15 @@ import ( // Contains details about a package version asset. type AssetSummary struct { - // The name of the asset. + // The name of the asset. // // This member is required. Name *string - // The hashes of the asset. + // The hashes of the asset. Hashes map[string]string - // The size of the asset. + // The size of the asset. Size *int64 noSmithyDocumentSerde @@ -31,9 +31,10 @@ type AssociatedPackage struct { // group. A strong match can be thought of as an exact match, and a weak match can // be thought of as a variation match, for example, the package name matches a // variation of the package group pattern. For more information about package group - // pattern matching, including strong and weak matches, see Package group - // definition syntax and matching behavior (https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html) - // in the CodeArtifact User Guide. + // pattern matching, including strong and weak matches, see [Package group definition syntax and matching behavior]in the CodeArtifact + // User Guide. + // + // [Package group definition syntax and matching behavior]: https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html AssociationType PackageGroupAssociationType // A format that specifies the type of the associated package. @@ -41,49 +42,54 @@ type AssociatedPackage struct { // The namespace of the associated package. The package 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string - // The name of the associated package. + // The name of the associated package. Package *string noSmithyDocumentSerde } -// Information about a domain. A domain is a container for repositories. When you +// Information about a domain. A domain is a container for repositories. When you +// // create a domain, it is empty until you add one or more repositories. type DomainDescription struct { - // The Amazon Resource Name (ARN) of the domain. + // The Amazon Resource Name (ARN) of the domain. Arn *string - // The total size of all assets in the domain. + // The total size of all assets in the domain. AssetSizeBytes int64 - // A timestamp that represents the date and time the domain was created. + // A timestamp that represents the date and time the domain was created. CreatedTime *time.Time - // The ARN of an Key Management Service (KMS) key associated with a domain. + // The ARN of an Key Management Service (KMS) key associated with a domain. EncryptionKey *string - // The name of the domain. + // The name of the domain. Name *string - // The Amazon Web Services account ID that owns the domain. + // The Amazon Web Services account ID that owns the domain. Owner *string - // The number of repositories in the domain. + // The number of repositories in the domain. RepositoryCount int32 // The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store // package assets in the domain. S3BucketArn *string - // The current status of a domain. + // The current status of a domain. Status DomainStatus noSmithyDocumentSerde @@ -94,10 +100,12 @@ type DomainDescription struct { // it was published to. For packages ingested from an external repository, the // entry point is the external connection that it was ingested from. An external // connection is a CodeArtifact repository that is connected to an external -// repository such as the npm registry or NuGet gallery. If a package version -// exists in a repository and is updated, for example if a package of the same -// version is added with additional assets, the package version's DomainEntryPoint -// will not change from the original package version's value. +// repository such as the npm registry or NuGet gallery. +// +// If a package version exists in a repository and is updated, for example if a +// package of the same version is added with additional assets, the package +// version's DomainEntryPoint will not change from the original package version's +// value. type DomainEntryPoint struct { // The name of the external connection that a package was ingested from. @@ -109,28 +117,30 @@ type DomainEntryPoint struct { noSmithyDocumentSerde } -// 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) -// operation returns a list of DomainSummary objects. +// Information about a domain, including its name, Amazon Resource Name (ARN), +// +// and status. The [ListDomains]operation returns a list of DomainSummary objects. +// +// [ListDomains]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html type DomainSummary struct { - // The ARN of the domain. + // The ARN of the domain. Arn *string - // A timestamp that contains the date and time the domain was created. + // A timestamp that contains the date and time the domain was created. CreatedTime *time.Time - // The key used to encrypt the domain. + // The key used to encrypt the domain. EncryptionKey *string - // The name of the domain. + // The name of the domain. Name *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. Owner *string - // A string that contains the status of the domain. + // A string that contains the status of the domain. Status DomainStatus noSmithyDocumentSerde @@ -139,10 +149,10 @@ type DomainSummary struct { // Details of the license data. type LicenseInfo struct { - // Name of the license. + // Name of the license. Name *string - // The URL for license data. + // The URL for license data. Url *string noSmithyDocumentSerde @@ -151,30 +161,39 @@ type LicenseInfo struct { // Details about a package dependency. type PackageDependency struct { - // The type of a package dependency. The possible values depend on the package + // 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 + // + // 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 version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby 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 this package depends on. + // The name of the package that this package depends on. Package *string - // The required version, or version range, of the package that this package + // 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 @@ -193,9 +212,13 @@ type PackageDescription struct { // The namespace of the package. The package 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string @@ -206,14 +229,15 @@ type PackageDescription struct { noSmithyDocumentSerde } -// Details about an allowed repository for a package group, including its name and -// origin configuration. +// Details about an allowed repository for a package group, including its name +// +// and origin configuration. type PackageGroupAllowedRepository struct { // The origin configuration restriction type of the allowed repository. OriginRestrictionType PackageGroupOriginRestrictionType - // The name of the allowed repository. + // The name of the allowed repository. RepositoryName *string noSmithyDocumentSerde @@ -222,22 +246,22 @@ type PackageGroupAllowedRepository struct { // The description of the package group. type PackageGroupDescription struct { - // The ARN of the package group. + // The ARN of the package group. Arn *string - // The contact information of the package group. + // The contact information of the package group. ContactInfo *string // A timestamp that represents the date and time the package group was created. CreatedTime *time.Time - // The description of the package group. + // The description of the package group. Description *string - // The name of the domain that contains the package group. + // The name of the domain that contains the package group. DomainName *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string @@ -245,10 +269,10 @@ type PackageGroupDescription struct { // enter repositories. OriginConfiguration *PackageGroupOriginConfiguration - // The direct parent package group of the package group. + // The direct parent package group of the package group. Parent *PackageGroupReference - // The pattern of the package group. The pattern determines which packages are + // The pattern of the package group. The pattern determines which packages are // associated with the package group. Pattern *string @@ -297,10 +321,10 @@ type PackageGroupOriginRestriction struct { // Information about the identifiers of a package group. type PackageGroupReference struct { - // The ARN of the package group. + // The ARN of the package group. Arn *string - // The pattern of the package group. The pattern determines which packages are + // The pattern of the package group. The pattern determines which packages are // associated with the package group, and is also the identifier of the package // group. Pattern *string @@ -311,32 +335,32 @@ type PackageGroupReference struct { // Details about a package group. type PackageGroupSummary struct { - // The ARN of the package group. + // The ARN of the package group. Arn *string - // The contact information of the package group. + // The contact information of the package group. ContactInfo *string // A timestamp that represents the date and time the repository was created. CreatedTime *time.Time - // The description of the package group. + // The description of the package group. Description *string - // The domain that contains the package group. + // The domain that contains the package group. DomainName *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string // Details about the package origin configuration of a package group. OriginConfiguration *PackageGroupOriginConfiguration - // The direct parent package group of the package group. + // The direct parent package group of the package group. Parent *PackageGroupReference - // The pattern of the package group. The pattern determines which packages are + // The pattern of the package group. The pattern determines which packages are // associated with the package group. Pattern *string @@ -376,25 +400,30 @@ type PackageOriginRestrictions struct { // Details about a package, including its format, namespace, and name. type PackageSummary struct { - // The format of the package. + // 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 version is its groupId . + // // - The namespace of an npm or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a 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) - // object that contains information about the upstream and publish package origin - // restrictions. + // A [PackageOriginConfiguration] object that contains a [PackageOriginRestrictions] object that contains information about the upstream + // and publish package origin restrictions. + // + // [PackageOriginRestrictions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html + // [PackageOriginConfiguration]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html OriginConfiguration *PackageOriginConfiguration - // The name of the package. + // The name of the package. Package *string noSmithyDocumentSerde @@ -403,56 +432,61 @@ type PackageSummary struct { // Details about a package version. type PackageVersionDescription struct { - // The name of the package that is displayed. The displayName varies depending on + // 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 . DisplayName *string - // The format of the package version. + // The format of the package version. Format PackageFormat - // The homepage associated with the package. + // The homepage associated with the package. HomePage *string - // Information about licenses associated with the package version. + // Information about licenses associated with the package version. Licenses []LicenseInfo // The namespace of the package version. The package 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 or Swift package version is its scope . + // // - The namespace of a generic package is its namespace . + // // - Python, NuGet, and Ruby package versions do not contain a corresponding // component, package versions of those formats do not have a namespace. Namespace *string - // 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. + // A [PackageVersionOrigin] object that contains information about how the package version was added to + // the repository. + // + // [PackageVersionOrigin]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html Origin *PackageVersionOrigin - // The name of the requested package. + // The name of the requested package. PackageName *string - // A timestamp that contains the date and time the package version was published. + // A timestamp that contains the date and time the package version was published. PublishedTime *time.Time - // The revision of the package version. + // The revision of the package version. Revision *string - // The repository for the source code in the package version, or the source code + // The repository for the source code in the package version, or the source code // used to build it. SourceCodeRepository *string - // A string that contains the status of the package version. + // 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. + // 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. + // The version of the package. Version *string noSmithyDocumentSerde @@ -461,16 +495,22 @@ type PackageVersionDescription struct { // l An error associated with package. type PackageVersionError struct { - // The error code associated with the error. Valid error codes are: + // The error code associated with the error. Valid error codes are: + // // - ALREADY_EXISTS + // // - MISMATCHED_REVISION + // // - MISMATCHED_STATUS + // // - NOT_ALLOWED + // // - NOT_FOUND + // // - SKIPPED ErrorCode PackageVersionErrorCode - // The error message associated with the error. + // The error message associated with the error. ErrorMessage *string noSmithyDocumentSerde @@ -479,9 +519,10 @@ 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) - // object that contains information about from which repository or external + // A [DomainEntryPoint] object that contains information about from which repository or external // connection the package version was added to the domain. + // + // [DomainEntryPoint]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainEntryPoint.html DomainEntryPoint *DomainEntryPoint // Describes how the package version was originally added to the domain. An @@ -493,34 +534,38 @@ type PackageVersionOrigin struct { noSmithyDocumentSerde } -// Details about a package version, including its status, version, and revision. -// The ListPackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) -// operation returns a list of PackageVersionSummary objects. +// Details about a package version, including its status, version, and revision. +// +// The [ListPackageVersions]operation returns a list of PackageVersionSummary objects. +// +// [ListPackageVersions]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html type PackageVersionSummary struct { - // A string that contains the status of the package version. It can be one of the + // A string that contains the status of the package version. It can be one of the // following: // // This member is required. Status PackageVersionStatus - // Information about a package version. + // Information about a package version. // // This member is required. Version *string - // 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. + // A [PackageVersionOrigin] object that contains information about how the package version was added to + // the repository. + // + // [PackageVersionOrigin]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html Origin *PackageVersionOrigin - // The revision associated with a package version. + // The revision associated with a package version. Revision *string noSmithyDocumentSerde } -// The details of a repository stored in CodeArtifact. A CodeArtifact repository +// The details of a repository stored in CodeArtifact. A CodeArtifact repository +// // 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 @@ -528,37 +573,37 @@ type PackageVersionSummary struct { // create up to 100 repositories per Amazon Web Services account. type RepositoryDescription struct { - // The 12-digit account number of the Amazon Web Services account that manages the - // repository. + // The 12-digit account number of the Amazon Web Services account that manages + // the repository. AdministratorAccount *string - // The Amazon Resource Name (ARN) of the repository. + // The Amazon Resource Name (ARN) of the repository. Arn *string // A timestamp that represents the date and time the repository was created. CreatedTime *time.Time - // A text description of the repository. + // A text description of the repository. Description *string - // The name of the domain that contains the repository. + // The name of the domain that contains the repository. DomainName *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain that contains the repository. It does not include dashes or spaces. DomainOwner *string - // An array of external connections associated with the repository. + // An array of external connections associated with the repository. ExternalConnections []RepositoryExternalConnectionInfo - // The name of the repository. + // The name of the repository. Name *string - // A list of upstream repositories to associate with the repository. The order of + // 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) - // . + // CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories]. + // + // [Working with upstream repositories]: https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html Upstreams []UpstreamRepositoryInfo noSmithyDocumentSerde @@ -567,66 +612,74 @@ type RepositoryDescription struct { // Contains information about the external connection of a repository. type RepositoryExternalConnectionInfo struct { - // The name of the external connection associated with a repository. + // The name of the external connection associated with a repository. ExternalConnectionName *string - // The package format associated with a repository's external connection. The + // 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 + // 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) -// operation returns a list of RepositorySummary objects. +// Details about a repository, including its Amazon Resource Name (ARN), +// +// description, and domain information. The [ListRepositories]operation returns a list of +// RepositorySummary objects. +// +// [ListRepositories]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html type RepositorySummary struct { - // The Amazon Web Services account ID that manages the repository. + // The Amazon Web Services account ID that manages the repository. AdministratorAccount *string - // The ARN of the repository. + // The ARN of the repository. Arn *string // A timestamp that represents the date and time the repository was created. CreatedTime *time.Time - // The description of the repository. + // The description of the repository. Description *string - // The name of the domain that contains the repository. + // The name of the domain that contains the repository. DomainName *string - // The 12-digit account number of the Amazon Web Services account that owns the + // The 12-digit account number of the Amazon Web Services account that owns the // domain. It does not include dashes or spaces. DomainOwner *string - // The name of the repository. + // The name of the repository. Name *string noSmithyDocumentSerde } -// An CodeArtifact resource policy that contains a resource ARN, document details, -// and a revision. +// An CodeArtifact resource policy that contains a resource ARN, document +// +// details, and a revision. type ResourcePolicy struct { - // The resource policy formatted in JSON. + // The resource policy formatted in JSON. Document *string - // The ARN of the resource associated with the resource policy + // The ARN of the resource associated with the resource policy ResourceArn *string - // The current revision of the resource policy. + // The current revision of the resource policy. Revision *string noSmithyDocumentSerde @@ -635,10 +688,10 @@ type ResourcePolicy struct { // Contains the revision and status of a package version. type SuccessfulPackageVersionInfo struct { - // The revision of a package version. + // The revision of a package version. Revision *string - // The status of a package version. + // The status of a package version. Status PackageVersionStatus noSmithyDocumentSerde @@ -661,13 +714,15 @@ type Tag struct { noSmithyDocumentSerde } -// 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) -// . +// Information about an upstream repository. A list of UpstreamRepository objects +// +// is an input parameter to [CreateRepository]and [UpdateRepository]. +// +// [UpdateRepository]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html +// [CreateRepository]: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html type UpstreamRepository struct { - // The name of an upstream repository. + // The name of an upstream repository. // // This member is required. RepositoryName *string @@ -678,7 +733,7 @@ type UpstreamRepository struct { // Information about an upstream repository. type UpstreamRepositoryInfo struct { - // The name of an upstream repository. + // The name of an upstream repository. RepositoryName *string noSmithyDocumentSerde diff --git a/service/codebuild/api_op_BatchGetReportGroups.go b/service/codebuild/api_op_BatchGetReportGroups.go index 5ae29403829..a5d9220a0de 100644 --- a/service/codebuild/api_op_BatchGetReportGroups.go +++ b/service/codebuild/api_op_BatchGetReportGroups.go @@ -29,7 +29,7 @@ func (c *Client) BatchGetReportGroups(ctx context.Context, params *BatchGetRepor type BatchGetReportGroupsInput struct { - // An array of report group ARNs that identify the report groups to return. + // An array of report group ARNs that identify the report groups to return. // // This member is required. ReportGroupArns []string @@ -39,10 +39,10 @@ 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 + // An array of ARNs passed to BatchGetReportGroups that are not associated with a // ReportGroup . ReportGroupsNotFound []string diff --git a/service/codebuild/api_op_BatchGetReports.go b/service/codebuild/api_op_BatchGetReports.go index dd2b492901a..d47c85dd5c0 100644 --- a/service/codebuild/api_op_BatchGetReports.go +++ b/service/codebuild/api_op_BatchGetReports.go @@ -29,7 +29,7 @@ func (c *Client) BatchGetReports(ctx context.Context, params *BatchGetReportsInp type BatchGetReportsInput struct { - // An array of ARNs that identify the Report objects to return. + // An array of ARNs that identify the Report objects to return. // // This member is required. ReportArns []string @@ -39,10 +39,10 @@ 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 + // An array of ARNs passed to BatchGetReportGroups that are not associated with a // Report . ReportsNotFound []string diff --git a/service/codebuild/api_op_CreateFleet.go b/service/codebuild/api_op_CreateFleet.go index a1c79635fd1..bfec033b8d0 100644 --- a/service/codebuild/api_op_CreateFleet.go +++ b/service/codebuild/api_op_CreateFleet.go @@ -37,56 +37,78 @@ type CreateFleetInput struct { // Information about the compute resources the compute fleet 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_XLARGE : Use up to 70 GB memory and 36 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_SMALL : + // // - For environment type LINUX_CONTAINER , you can use up to 3 GB memory and 2 // vCPUs for builds. + // // - For environment type LINUX_GPU_CONTAINER , you can use up to 16 GB memory, 4 // vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. + // // - For environment type ARM_CONTAINER , you can use up to 4 GB memory and 2 // vCPUs on ARM-based processors for builds. + // // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild User Guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html // // This member is required. ComputeType types.ComputeType // The environment type of the compute fleet. + // // - 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 (Singapore), Asia Pacific (Sydney), // EU (Frankfurt), and South America (São Paulo). + // // - The environment type LINUX_CONTAINER is available only in regions US East // (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), // Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South // America (São Paulo), and Asia Pacific (Mumbai). + // // - The environment type LINUX_GPU_CONTAINER is available only in regions US // East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU // (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney). + // // - The environment type WINDOWS_SERVER_2019_CONTAINER is available only in // regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific // (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland). + // // - The environment type WINDOWS_SERVER_2022_CONTAINER is available only in // regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), // EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific // (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai). - // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild user guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html // // This member is required. EnvironmentType types.EnvironmentType @@ -97,8 +119,10 @@ type CreateFleetInput struct { Name *string // The compute fleet overflow behavior. + // // - For overflow behavior QUEUE , your overflow builds need to wait on the // existing fleet instance to become available. + // // - For overflow behavior ON_DEMAND , your overflow builds run on CodeBuild // on-demand. OverflowBehavior types.FleetOverflowBehavior @@ -106,8 +130,9 @@ type CreateFleetInput struct { // The scaling configuration of the compute fleet. ScalingConfiguration *types.ScalingConfigurationInput - // A list of tag key and value pairs associated with this compute fleet. These - // tags are available for use by Amazon Web Services services that support + // A list of tag key and value pairs associated with this compute fleet. + // + // These tags are available for use by Amazon Web Services services that support // CodeBuild build project tags. Tags []types.Tag diff --git a/service/codebuild/api_op_CreateProject.go b/service/codebuild/api_op_CreateProject.go index 9ccaff334e1..d60a48a32bd 100644 --- a/service/codebuild/api_op_CreateProject.go +++ b/service/codebuild/api_op_CreateProject.go @@ -59,17 +59,17 @@ type CreateProjectInput struct { // badge. BadgeEnabled *bool - // A ProjectBuildBatchConfig object that defines the batch build options for the - // project. + // A ProjectBuildBatchConfig object that defines the batch build options for the project. BuildBatchConfig *types.ProjectBuildBatchConfig // Stores recently used information so that it can be quickly accessed at a later // time. Cache *types.ProjectCache - // The maximum number of concurrent builds that are allowed for this project. New - // builds are only started if the current number of builds is less than or equal to - // this limit. If the current build count meets this limit, new builds are + // The maximum number of concurrent builds that are allowed for this project. + // + // New builds are only started if the current number of builds is less than or + // equal to this limit. If the current build count meets this limit, new builds are // throttled and are not run. ConcurrentBuildLimit *int32 @@ -77,13 +77,16 @@ type CreateProjectInput struct { Description *string // The Key Management Service customer master key (CMK) to be used for encrypting - // 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/ ). + // 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/ ). EncryptionKey *string - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // 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. @@ -109,26 +112,34 @@ type CreateProjectInput struct { // 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. + // precedence over this sourceVersion (at the project level). + // + // For more information, see [Source Version Sample with CodeBuild] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html 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 + // 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 diff --git a/service/codebuild/api_op_CreateReportGroup.go b/service/codebuild/api_op_CreateReportGroup.go index bb785370efb..5f0c2d5f7c1 100644 --- a/service/codebuild/api_op_CreateReportGroup.go +++ b/service/codebuild/api_op_CreateReportGroup.go @@ -29,25 +29,26 @@ func (c *Client) CreateReportGroup(ctx context.Context, params *CreateReportGrou type CreateReportGroupInput struct { - // A ReportExportConfig object that contains information about where the report + // A ReportExportConfig object that contains information about where the report // group test results are exported. // // This member is required. ExportConfig *types.ReportExportConfig - // The name of the report group. + // The name of the report group. // // This member is required. Name *string - // The type of report group. + // The type of report group. // // This member is required. Type types.ReportType - // A list of tag key and value pairs associated with this report group. These tags - // are available for use by Amazon Web Services services that support CodeBuild - // report group tags. + // A list of tag key and value pairs associated with this report group. + // + // These tags are available for use by Amazon Web Services services that support + // CodeBuild report group tags. Tags []types.Tag noSmithyDocumentSerde @@ -55,7 +56,7 @@ type CreateReportGroupInput struct { type CreateReportGroupOutput struct { - // Information about the report group that was created. + // Information about the report group that was created. ReportGroup *types.ReportGroup // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_CreateWebhook.go b/service/codebuild/api_op_CreateWebhook.go index fa28570cdc8..86b152ad5c4 100644 --- a/service/codebuild/api_op_CreateWebhook.go +++ b/service/codebuild/api_op_CreateWebhook.go @@ -13,15 +13,17 @@ import ( // For an existing CodeBuild build project that has its source code stored in a // GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source -// code every time a code change is pushed to the repository. If you enable -// webhooks for an CodeBuild project, and the project is used as a build step in -// CodePipeline, then two identical builds are created for each commit. One build -// is triggered through webhooks, and one through CodePipeline. Because billing is -// 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) -// . +// code every time a code change is pushed to the repository. +// +// If you enable webhooks for an CodeBuild project, and the project is used as a +// build step in CodePipeline, then two identical builds are created for each +// commit. One build is triggered through webhooks, and one through CodePipeline. +// Because billing is 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]. +// +// [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{} @@ -46,8 +48,9 @@ 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 . + // then it is built. If branchFilter is empty, then all branches are built. + // + // It is recommended that you use filterGroups instead of branchFilter . BranchFilter *string // Specifies the type of build this webhook will trigger. @@ -55,9 +58,10 @@ type CreateWebhookInput struct { // 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. + // 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_DeleteProject.go b/service/codebuild/api_op_DeleteProject.go index 1cb92599a13..f0c387a555c 100644 --- a/service/codebuild/api_op_DeleteProject.go +++ b/service/codebuild/api_op_DeleteProject.go @@ -10,7 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a build project. When you delete a project, its builds are not deleted. +// Deletes a build project. When you delete a project, its builds are not +// +// deleted. func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { if params == nil { params = &DeleteProjectInput{} diff --git a/service/codebuild/api_op_DeleteReport.go b/service/codebuild/api_op_DeleteReport.go index f6f2339768f..72b07fefa20 100644 --- a/service/codebuild/api_op_DeleteReport.go +++ b/service/codebuild/api_op_DeleteReport.go @@ -28,7 +28,7 @@ func (c *Client) DeleteReport(ctx context.Context, params *DeleteReportInput, op type DeleteReportInput struct { - // The ARN of the report to delete. + // The ARN of the report to delete. // // This member is required. Arn *string diff --git a/service/codebuild/api_op_DeleteReportGroup.go b/service/codebuild/api_op_DeleteReportGroup.go index 2a2b9ffd1ac..02e1e477110 100644 --- a/service/codebuild/api_op_DeleteReportGroup.go +++ b/service/codebuild/api_op_DeleteReportGroup.go @@ -35,11 +35,15 @@ type DeleteReportGroupInput struct { 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) - // to delete the reports. If you call DeleteReportGroup for a report group that - // contains one or more reports, an exception is thrown. + // report group. + // + // If false , you must delete any reports in the report group. Use [ListReportsForReportGroup] to get the + // reports in a report group. Use [DeleteReport]to delete the reports. If you call + // DeleteReportGroup for a report group that contains one or more reports, an + // exception is thrown. + // + // [ListReportsForReportGroup]: https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html + // [DeleteReport]: https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html DeleteReports bool noSmithyDocumentSerde diff --git a/service/codebuild/api_op_DeleteResourcePolicy.go b/service/codebuild/api_op_DeleteResourcePolicy.go index e1cfc85722a..b9d26359b17 100644 --- a/service/codebuild/api_op_DeleteResourcePolicy.go +++ b/service/codebuild/api_op_DeleteResourcePolicy.go @@ -28,7 +28,7 @@ func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourc type DeleteResourcePolicyInput struct { - // The ARN of the resource that is associated with the resource policy. + // The ARN of the resource that is associated with the resource policy. // // This member is required. ResourceArn *string diff --git a/service/codebuild/api_op_DeleteSourceCredentials.go b/service/codebuild/api_op_DeleteSourceCredentials.go index 641a1ae2fe4..1a41aec3f2a 100644 --- a/service/codebuild/api_op_DeleteSourceCredentials.go +++ b/service/codebuild/api_op_DeleteSourceCredentials.go @@ -28,7 +28,7 @@ func (c *Client) DeleteSourceCredentials(ctx context.Context, params *DeleteSour type DeleteSourceCredentialsInput struct { - // The Amazon Resource Name (ARN) of the token. + // The Amazon Resource Name (ARN) of the token. // // This member is required. Arn *string @@ -38,7 +38,7 @@ type DeleteSourceCredentialsInput struct { type DeleteSourceCredentialsOutput struct { - // The Amazon Resource Name (ARN) of the token. + // The Amazon Resource Name (ARN) of the token. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_DescribeCodeCoverages.go b/service/codebuild/api_op_DescribeCodeCoverages.go index 7a65c5ca5b2..df54e567c26 100644 --- a/service/codebuild/api_op_DescribeCodeCoverages.go +++ b/service/codebuild/api_op_DescribeCodeCoverages.go @@ -29,7 +29,7 @@ func (c *Client) DescribeCodeCoverages(ctx context.Context, params *DescribeCode type DescribeCodeCoveragesInput struct { - // The ARN of the report for which test cases are returned. + // The ARN of the report for which test cases are returned. // // This member is required. ReportArn *string @@ -48,9 +48,12 @@ type DescribeCodeCoveragesInput struct { // 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 d57616d9d51..bd5851e69cc 100644 --- a/service/codebuild/api_op_DescribeTestCases.go +++ b/service/codebuild/api_op_DescribeTestCases.go @@ -29,25 +29,25 @@ func (c *Client) DescribeTestCases(ctx context.Context, params *DescribeTestCase type DescribeTestCasesInput struct { - // The ARN of the report for which test cases are returned. + // The ARN of the report for which test cases are returned. // // This member is required. ReportArn *string - // A TestCaseFilter object used to filter the returned reports. + // A TestCaseFilter object used to filter the returned reports. Filter *types.TestCaseFilter - // The maximum number of paginated test cases returned per response. Use nextToken + // The maximum number of paginated test cases returned per response. Use nextToken // to iterate pages in the list of returned TestCase 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string noSmithyDocumentSerde @@ -55,15 +55,15 @@ 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The returned list of test cases. + // The returned list of test cases. TestCases []types.TestCase // Metadata pertaining to the operation's result. @@ -161,7 +161,7 @@ var _ DescribeTestCasesAPIClient = (*Client)(nil) // DescribeTestCasesPaginatorOptions is the paginator options for DescribeTestCases type DescribeTestCasesPaginatorOptions struct { - // The maximum number of paginated test cases returned per response. Use nextToken + // The maximum number of paginated test cases returned per response. Use nextToken // to iterate pages in the list of returned TestCase objects. The default value is // 100. Limit int32 diff --git a/service/codebuild/api_op_GetReportGroupTrend.go b/service/codebuild/api_op_GetReportGroupTrend.go index 2d73ca0752b..8e3b6c69717 100644 --- a/service/codebuild/api_op_GetReportGroupTrend.go +++ b/service/codebuild/api_op_GetReportGroupTrend.go @@ -35,24 +35,39 @@ type GetReportGroupTrendInput struct { ReportGroupArn *string // The test report value to accumulate. This must be one of the following values: + // // Test reports: DURATION Accumulate the test run times for the specified reports. + // // PASS_RATE Accumulate the percentage of tests that passed for the specified test - // reports. TOTAL Accumulate the total number of tests for the specified test - // reports. Code coverage reports: BRANCH_COVERAGE Accumulate the branch coverage - // percentages for the specified test reports. BRANCHES_COVERED Accumulate the - // branches covered values for the specified test reports. BRANCHES_MISSED - // Accumulate the branches missed values for the specified test reports. + // reports. + // + // TOTAL Accumulate the total number of tests for the specified test reports. + // + // Code coverage reports: BRANCH_COVERAGE Accumulate the branch coverage + // percentages for the specified test reports. + // + // BRANCHES_COVERED Accumulate the branches covered values for the specified test + // reports. + // + // BRANCHES_MISSED Accumulate the branches missed values for the specified test + // reports. + // // LINE_COVERAGE Accumulate the line coverage percentages for the specified test - // reports. LINES_COVERED Accumulate the lines covered values for the specified - // test reports. LINES_MISSED Accumulate the lines not covered values for the - // specified test reports. + // reports. + // + // LINES_COVERED Accumulate the lines covered values for the specified test + // reports. + // + // LINES_MISSED Accumulate the lines not covered values for the specified test + // reports. // // This member is required. TrendField types.ReportGroupTrendFieldType // The number of reports to analyze. This operation always retrieves the most - // recent reports. If this parameter is omitted, the most recent 100 reports are - // analyzed. + // recent reports. + // + // If this parameter is omitted, the most recent 100 reports are analyzed. NumOfReports *int32 noSmithyDocumentSerde diff --git a/service/codebuild/api_op_GetResourcePolicy.go b/service/codebuild/api_op_GetResourcePolicy.go index ded1236f4d6..da0b1840eba 100644 --- a/service/codebuild/api_op_GetResourcePolicy.go +++ b/service/codebuild/api_op_GetResourcePolicy.go @@ -28,7 +28,7 @@ func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolic type GetResourcePolicyInput struct { - // The ARN of the resource that is associated with the resource policy. + // The ARN of the resource that is associated with the resource policy. // // This member is required. ResourceArn *string @@ -38,7 +38,7 @@ type GetResourcePolicyInput struct { type GetResourcePolicyOutput struct { - // The resource policy for the resource identified by the input ARN parameter. + // The resource policy for the resource identified by the input ARN parameter. Policy *string // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_ImportSourceCredentials.go b/service/codebuild/api_op_ImportSourceCredentials.go index b601dc409fd..4669db4d091 100644 --- a/service/codebuild/api_op_ImportSourceCredentials.go +++ b/service/codebuild/api_op_ImportSourceCredentials.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Imports the source repository credentials for an CodeBuild project that has its -// source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. +// Imports the source repository credentials for an CodeBuild project that has +// +// its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. func (c *Client) ImportSourceCredentials(ctx context.Context, params *ImportSourceCredentialsInput, optFns ...func(*Options)) (*ImportSourceCredentialsOutput, error) { if params == nil { params = &ImportSourceCredentialsInput{} @@ -30,29 +31,29 @@ func (c *Client) ImportSourceCredentials(ctx context.Context, params *ImportSour type ImportSourceCredentialsInput struct { - // The type of authentication used to connect to a GitHub, GitHub Enterprise, or + // The type of authentication used to connect to a GitHub, GitHub Enterprise, or // Bitbucket repository. An OAUTH connection is not supported by the API and must // be created using the CodeBuild console. // // This member is required. AuthType types.AuthType - // The source provider used for this project. + // The source provider used for this project. // // This member is required. ServerType types.ServerType - // For GitHub or GitHub Enterprise, this is the personal access token. For + // For GitHub or GitHub Enterprise, this is the personal access token. For // Bitbucket, this is either the access token or the app password. // // This member is required. Token *string - // Set to false to prevent overwriting the repository source credentials. Set to + // Set to false to prevent overwriting the repository source credentials. Set to // 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 + // The Bitbucket username when the authType is BASIC_AUTH. This parameter is not // valid for other types of source providers or connections. Username *string @@ -61,7 +62,7 @@ type ImportSourceCredentialsInput struct { type ImportSourceCredentialsOutput struct { - // The Amazon Resource Name (ARN) of the token. + // The Amazon Resource Name (ARN) of the token. Arn *string // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_ListBuildBatches.go b/service/codebuild/api_op_ListBuildBatches.go index cfea8510c94..8027b5cb31d 100644 --- a/service/codebuild/api_op_ListBuildBatches.go +++ b/service/codebuild/api_op_ListBuildBatches.go @@ -41,8 +41,10 @@ type ListBuildBatchesInput struct { 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. SortOrder types.SortOrderType diff --git a/service/codebuild/api_op_ListBuildBatchesForProject.go b/service/codebuild/api_op_ListBuildBatchesForProject.go index 876f03ef77c..6da7f70e714 100644 --- a/service/codebuild/api_op_ListBuildBatchesForProject.go +++ b/service/codebuild/api_op_ListBuildBatchesForProject.go @@ -44,8 +44,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. SortOrder types.SortOrderType diff --git a/service/codebuild/api_op_ListBuilds.go b/service/codebuild/api_op_ListBuilds.go index 3ecf40a27df..ca842fef5a7 100644 --- a/service/codebuild/api_op_ListBuilds.go +++ b/service/codebuild/api_op_ListBuilds.go @@ -38,7 +38,9 @@ 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. SortOrder types.SortOrderType diff --git a/service/codebuild/api_op_ListBuildsForProject.go b/service/codebuild/api_op_ListBuildsForProject.go index 6cb6aedaef0..8ff01b1bbe7 100644 --- a/service/codebuild/api_op_ListBuildsForProject.go +++ b/service/codebuild/api_op_ListBuildsForProject.go @@ -45,10 +45,14 @@ 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: + // 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. + // + // - 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 diff --git a/service/codebuild/api_op_ListFleets.go b/service/codebuild/api_op_ListFleets.go index bb1a2228ef0..51d4ce9ff2e 100644 --- a/service/codebuild/api_op_ListFleets.go +++ b/service/codebuild/api_op_ListFleets.go @@ -43,17 +43,24 @@ type ListFleetsInput struct { NextToken *string // The criterion to be used to list compute fleet names. Valid values include: + // // - CREATED_TIME : List based on when each compute fleet was created. + // // - LAST_MODIFIED_TIME : List based on when information about each compute fleet // was last changed. + // // - NAME : List based on each compute fleet's name. + // // Use sortOrder to specify in what order to list the compute fleet names based on // the preceding criteria. SortBy types.FleetSortByType // The order in which to list compute fleets. Valid values include: + // // - ASCENDING : List in ascending order. + // // - DESCENDING : List in descending order. + // // Use sortBy to specify the criterion to be used to list compute fleet names. SortOrder types.SortOrderType diff --git a/service/codebuild/api_op_ListProjects.go b/service/codebuild/api_op_ListProjects.go index 353c33a8f84..dcbe979eb02 100644 --- a/service/codebuild/api_op_ListProjects.go +++ b/service/codebuild/api_op_ListProjects.go @@ -39,17 +39,24 @@ 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. 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. SortOrder types.SortOrderType diff --git a/service/codebuild/api_op_ListReportGroups.go b/service/codebuild/api_op_ListReportGroups.go index f64fad9dbac..be87517a602 100644 --- a/service/codebuild/api_op_ListReportGroups.go +++ b/service/codebuild/api_op_ListReportGroups.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list ARNs for the report groups in the current Amazon Web Services +// Gets a list ARNs for the report groups in the current Amazon Web Services +// // account. func (c *Client) ListReportGroups(ctx context.Context, params *ListReportGroupsInput, optFns ...func(*Options)) (*ListReportGroupsOutput, error) { if params == nil { @@ -30,26 +31,29 @@ func (c *Client) ListReportGroups(ctx context.Context, params *ListReportGroupsI type ListReportGroupsInput struct { - // The maximum number of paginated report groups returned per response. Use + // The maximum number of paginated report groups returned per response. Use // nextToken to iterate pages in the list of returned ReportGroup 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The criterion to be used to list build report groups. Valid values include: + // 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. SortBy types.ReportGroupSortByType - // Used to specify the order to sort the list of returned report groups. Valid + // Used to specify the order to sort the list of returned report groups. Valid // values are ASCENDING and DESCENDING . SortOrder types.SortOrderType @@ -58,15 +62,15 @@ 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The list of ARNs for the report groups in the current Amazon Web Services + // The list of ARNs for the report groups in the current Amazon Web Services // account. ReportGroups []string @@ -162,7 +166,7 @@ var _ ListReportGroupsAPIClient = (*Client)(nil) // ListReportGroupsPaginatorOptions is the paginator options for ListReportGroups type ListReportGroupsPaginatorOptions struct { - // The maximum number of paginated report groups returned per response. Use + // The maximum number of paginated report groups returned per response. Use // nextToken to iterate pages in the list of returned ReportGroup objects. The // default value is 100. Limit int32 diff --git a/service/codebuild/api_op_ListReports.go b/service/codebuild/api_op_ListReports.go index a2ed193149e..23f5de98214 100644 --- a/service/codebuild/api_op_ListReports.go +++ b/service/codebuild/api_op_ListReports.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of ARNs for the reports in the current Amazon Web Services +// Returns a list of ARNs for the reports in the current Amazon Web Services +// // account. func (c *Client) ListReports(ctx context.Context, params *ListReportsInput, optFns ...func(*Options)) (*ListReportsOutput, error) { if params == nil { @@ -30,24 +31,27 @@ func (c *Client) ListReports(ctx context.Context, params *ListReportsInput, optF type ListReportsInput struct { - // A ReportFilter object used to filter the returned reports. + // A ReportFilter object used to filter the returned reports. Filter *types.ReportFilter - // The maximum number of paginated reports returned per response. Use nextToken to - // iterate pages in the list of returned Report objects. The default value is 100. + // The maximum number of paginated reports returned per 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // Specifies the sort order for the list of returned reports. Valid values are: + // 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. SortOrder types.SortOrderType @@ -57,15 +61,15 @@ 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The list of returned ARNs for the reports in the current Amazon Web Services + // The list of returned ARNs for the reports in the current Amazon Web Services // account. Reports []string @@ -160,8 +164,9 @@ var _ ListReportsAPIClient = (*Client)(nil) // ListReportsPaginatorOptions is the paginator options for ListReports type ListReportsPaginatorOptions struct { - // The maximum number of paginated reports returned per response. Use nextToken to - // iterate pages in the list of returned Report objects. The default value is 100. + // The maximum number of paginated reports returned per 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_ListReportsForReportGroup.go b/service/codebuild/api_op_ListReportsForReportGroup.go index 027bc87eccd..6696e1590a9 100644 --- a/service/codebuild/api_op_ListReportsForReportGroup.go +++ b/service/codebuild/api_op_ListReportsForReportGroup.go @@ -29,28 +29,28 @@ func (c *Client) ListReportsForReportGroup(ctx context.Context, params *ListRepo type ListReportsForReportGroupInput struct { - // The ARN of the report group for which you want to return report ARNs. + // The ARN of the report group for which you want to return report ARNs. // // This member is required. ReportGroupArn *string - // A ReportFilter object used to filter the returned reports. + // A ReportFilter object used to filter the returned reports. Filter *types.ReportFilter - // The maximum number of paginated reports in this report group returned per + // 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. 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // Use to specify whether the results are returned in ascending or descending + // Use to specify whether the results are returned in ascending or descending // order. SortOrder types.SortOrderType @@ -59,15 +59,15 @@ 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The list of report ARNs. + // The list of report ARNs. Reports []string // Metadata pertaining to the operation's result. @@ -166,7 +166,7 @@ var _ ListReportsForReportGroupAPIClient = (*Client)(nil) // ListReportsForReportGroupPaginatorOptions is the paginator options for // ListReportsForReportGroup type ListReportsForReportGroupPaginatorOptions struct { - // The maximum number of paginated reports in this report group returned per + // 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. Limit int32 diff --git a/service/codebuild/api_op_ListSharedProjects.go b/service/codebuild/api_op_ListSharedProjects.go index 7b2854af3c7..c4f43a4838f 100644 --- a/service/codebuild/api_op_ListSharedProjects.go +++ b/service/codebuild/api_op_ListSharedProjects.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of projects that are shared with other Amazon Web Services accounts -// or users. +// Gets a list of projects that are shared with other Amazon Web Services +// +// accounts or users. func (c *Client) ListSharedProjects(ctx context.Context, params *ListSharedProjectsInput, optFns ...func(*Options)) (*ListSharedProjectsOutput, error) { if params == nil { params = &ListSharedProjectsInput{} @@ -30,28 +31,32 @@ func (c *Client) ListSharedProjects(ctx context.Context, params *ListSharedProje type ListSharedProjectsInput struct { - // The maximum number of paginated shared build projects returned per response. + // 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The criterion to be used to list build projects shared with the current Amazon + // 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. 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. SortOrder types.SortOrderType @@ -60,15 +65,15 @@ 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The list of ARNs for the build projects shared with the current Amazon Web + // The list of ARNs for the build projects shared with the current Amazon Web // Services account or user. Projects []string @@ -165,7 +170,7 @@ 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. + // 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 diff --git a/service/codebuild/api_op_ListSharedReportGroups.go b/service/codebuild/api_op_ListSharedReportGroups.go index cfe65e6ee60..ae4c1c97060 100644 --- a/service/codebuild/api_op_ListSharedReportGroups.go +++ b/service/codebuild/api_op_ListSharedReportGroups.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of report groups that are shared with other Amazon Web Services +// Gets a list of report groups that are shared with other Amazon Web Services +// // accounts or users. func (c *Client) ListSharedReportGroups(ctx context.Context, params *ListSharedReportGroupsInput, optFns ...func(*Options)) (*ListSharedReportGroupsOutput, error) { if params == nil { @@ -30,28 +31,32 @@ func (c *Client) ListSharedReportGroups(ctx context.Context, params *ListSharedR type ListSharedReportGroupsInput struct { - // The maximum number of paginated shared report groups per response. Use nextToken - // to iterate pages in the list of returned ReportGroup objects. The default value - // is 100. + // The maximum number of paginated shared report groups per response. Use + // nextToken to iterate pages in the list of returned ReportGroup 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The criterion to be used to list report groups shared with the current Amazon + // 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. 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. SortOrder types.SortOrderType @@ -60,15 +65,15 @@ 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 - // 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 - // token that is returned, until no more next tokens are returned. + // 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 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 token that is returned, until no more next tokens are returned. NextToken *string - // The list of ARNs for the report groups shared with the current Amazon Web + // The list of ARNs for the report groups shared with the current Amazon Web // Services account or user. ReportGroups []string @@ -165,9 +170,9 @@ var _ ListSharedReportGroupsAPIClient = (*Client)(nil) // ListSharedReportGroupsPaginatorOptions is the paginator options for // ListSharedReportGroups type ListSharedReportGroupsPaginatorOptions struct { - // The maximum number of paginated shared report groups per response. Use nextToken - // to iterate pages in the list of returned ReportGroup objects. The default value - // is 100. + // The maximum number of paginated shared report groups per response. Use + // nextToken to iterate pages in the list of returned ReportGroup 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_ListSourceCredentials.go b/service/codebuild/api_op_ListSourceCredentials.go index 4c1d35e8af4..8bb335ce38c 100644 --- a/service/codebuild/api_op_ListSourceCredentials.go +++ b/service/codebuild/api_op_ListSourceCredentials.go @@ -33,7 +33,7 @@ type ListSourceCredentialsInput struct { type ListSourceCredentialsOutput struct { - // A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object + // A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object // includes the authentication type, token ARN, and type of source provider for one // set of credentials. SourceCredentialsInfos []types.SourceCredentialsInfo diff --git a/service/codebuild/api_op_PutResourcePolicy.go b/service/codebuild/api_op_PutResourcePolicy.go index 42d66c7a2d3..57c9bbb8a92 100644 --- a/service/codebuild/api_op_PutResourcePolicy.go +++ b/service/codebuild/api_op_PutResourcePolicy.go @@ -28,14 +28,16 @@ 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) - // in the CodeBuild User Guide. + // A JSON-formatted resource policy. For more information, see [Sharing a Project] and [Sharing a Report Group] in the + // CodeBuild User Guide. + // + // [Sharing a Report Group]: https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share + // [Sharing a Project]: https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share // // This member is required. Policy *string - // The ARN of the Project or ReportGroup resource you want to associate with a + // The ARN of the Project or ReportGroup resource you want to associate with a // resource policy. // // This member is required. @@ -46,7 +48,7 @@ type PutResourcePolicyInput struct { type PutResourcePolicyOutput struct { - // The ARN of the Project or ReportGroup resource that is associated with a + // The ARN of the Project or ReportGroup resource that is associated with a // resource policy. ResourceArn *string diff --git a/service/codebuild/api_op_StartBuild.go b/service/codebuild/api_op_StartBuild.go index 632ca21c9e6..5ee7d881acd 100644 --- a/service/codebuild/api_op_StartBuild.go +++ b/service/codebuild/api_op_StartBuild.go @@ -14,9 +14,11 @@ import ( // Starts running a build with the settings defined in the project. These setting // include: how to run a build, where to get the source code, which build // environment to use, which build commands to run, and where to store the build -// output. You can also start a build run by overriding some of the build settings -// in the project. The overrides only apply for that specific start build request. -// The settings in the project are unaltered. +// output. +// +// You can also start a build run by overriding some of the build settings in the +// project. The overrides only apply for that specific start build request. The +// settings in the project are unaltered. func (c *Client) StartBuild(ctx context.Context, params *StartBuildInput, optFns ...func(*Options)) (*StartBuildOutput, error) { if params == nil { params = &StartBuildInput{} @@ -50,20 +52,24 @@ type StartBuildInput struct { // A buildspec file declaration that overrides the latest one defined in the build // project, for this build only. The buildspec defined on the project is not - // changed. 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 + // changed. + // + // 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) - // . Since this property allows you to change the build commands that will run in + // its root directory. For more information, see [Buildspec File Name and Storage Location]. + // + // Since this property allows you to change the build commands that will run in // the container, you should note that an IAM principal with the ability to call // this API and set this parameter can override the default settings. Moreover, we // encourage that you use a trustworthy buildspec location like a file in your // source repository or a Amazon S3 bucket. + // + // [Buildspec File Name and 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 @@ -79,16 +85,19 @@ 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]. + // + // [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 // specified in the build project. The CMK key encrypts 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/ ). + // 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/ ). EncryptionKeyOverride *string // A container type for this build that overrides the one specified in the build @@ -107,7 +116,7 @@ type StartBuildInput struct { // for this build only, any previous depth of history defined in the build project. GitCloneDepthOverride *int32 - // Information about the Git submodules configuration for this build of an + // Information about the Git submodules configuration for this build of an // CodeBuild build project. GitSubmodulesConfigOverride *types.GitSubmodulesConfig @@ -122,12 +131,16 @@ type StartBuildInput struct { ImageOverride *string // 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's - // service principal. SERVICE_ROLE Specifies that CodeBuild uses your build - // project's service role. When using a cross-account or private registry image, - // you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, - // you must use CODEBUILD credentials. + // 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 image, you must use SERVICE_ROLE + // credentials. When using an CodeBuild curated image, you must use CODEBUILD + // credentials. ImagePullCredentialsTypeOverride types.ImagePullCredentialsType // Enable this flag to override the insecure SSL setting that is specified in the @@ -136,37 +149,41 @@ type StartBuildInput struct { // if the build's source is GitHub Enterprise. InsecureSslOverride *bool - // Log settings for this build that override the log settings defined in the build - // project. + // Log settings for this build that override the log settings defined in the + // build project. LogsConfigOverride *types.LogsConfig // Enable this flag to override privileged mode in the build project. PrivilegedModeOverride *bool - // The number of minutes a build is allowed to be queued before it times out. + // The number of minutes a build is allowed to be queued before it times out. QueuedTimeoutInMinutesOverride *int32 - // The credentials for access to a private registry. + // The credentials for access to a private registry. RegistryCredentialOverride *types.RegistryCredential - // Set to true to report to your source provider the status of a 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. 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. + // Set to true to report to your source provider the status of a 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. + // + // 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]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 ReportBuildStatusOverride *bool - // An array of ProjectArtifacts objects. + // An array of ProjectArtifacts objects. SecondaryArtifactsOverride []types.ProjectArtifacts - // An array of ProjectSource objects. + // An array of ProjectSource objects. SecondarySourcesOverride []types.ProjectSource - // An array of ProjectSourceVersion objects that specify one or more versions of + // An array of ProjectSourceVersion objects that specify one or more versions of // the project's secondary sources to be used for this build only. SecondarySourcesVersionOverride []types.ProjectSourceVersion @@ -189,19 +206,30 @@ type StartBuildInput struct { // The version of the build input to be built, for this build only. If not // specified, the latest version is used. If specified, the contents depends on the - // 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 - // 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 - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // 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) - // in the CodeBuild User Guide. + // 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 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 branch name is specified, the + // branch's HEAD commit ID is used. If not specified, 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] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html SourceVersion *string // The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, diff --git a/service/codebuild/api_op_StartBuildBatch.go b/service/codebuild/api_op_StartBuildBatch.go index ed760d37252..d0f2e262d1c 100644 --- a/service/codebuild/api_op_StartBuildBatch.go +++ b/service/codebuild/api_op_StartBuildBatch.go @@ -46,16 +46,18 @@ type StartBuildBatchInput struct { 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, + // 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) - // . + // its root directory. For more information, see [Buildspec File Name and Storage Location]. + // + // [Buildspec File Name and 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. @@ -70,16 +72,21 @@ type StartBuildBatchInput struct { 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]. Batch session debugging is not supported for matrix batch + // builds. + // + // [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 // specified in the batch build project. The CMK key encrypts 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/ ). + // 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/ ). EncryptionKeyOverride *string // A container type for this batch build that overrides the one specified in the @@ -111,12 +118,16 @@ type StartBuildBatchInput struct { 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 - // 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 - // image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated - // image, you must use CODEBUILD credentials. + // 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 image, you must use SERVICE_ROLE + // credentials. When using an CodeBuild curated image, you must use CODEBUILD + // credentials. ImagePullCredentialsTypeOverride types.ImagePullCredentialsType // Enable this flag to override the insecure SSL setting that is specified in the @@ -142,6 +153,7 @@ 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 // provider. ReportBuildBatchStatusOverride *bool @@ -176,19 +188,30 @@ type StartBuildBatchInput struct { // The version of the batch build input to be built, for this build only. If not // specified, the latest version is used. If specified, the contents depends on the - // 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 - // 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 - // branch name is specified, the branch's HEAD commit ID is used. If not specified, - // 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) - // in the CodeBuild User Guide. + // 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 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 branch name is specified, the + // branch's HEAD commit ID is used. If not specified, 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] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html SourceVersion *string noSmithyDocumentSerde diff --git a/service/codebuild/api_op_UpdateFleet.go b/service/codebuild/api_op_UpdateFleet.go index 9a532baebe8..2d9bf75a93c 100644 --- a/service/codebuild/api_op_UpdateFleet.go +++ b/service/codebuild/api_op_UpdateFleet.go @@ -40,59 +40,83 @@ type UpdateFleetInput struct { // Information about the compute resources the compute fleet 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_XLARGE : Use up to 70 GB memory and 36 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_SMALL : + // // - For environment type LINUX_CONTAINER , you can use up to 3 GB memory and 2 // vCPUs for builds. + // // - For environment type LINUX_GPU_CONTAINER , you can use up to 16 GB memory, 4 // vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. + // // - For environment type ARM_CONTAINER , you can use up to 4 GB memory and 2 // vCPUs on ARM-based processors for builds. + // // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild User Guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html ComputeType types.ComputeType // The environment type of the compute fleet. + // // - 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 (Singapore), Asia Pacific (Sydney), // EU (Frankfurt), and South America (São Paulo). + // // - The environment type LINUX_CONTAINER is available only in regions US East // (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), // Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South // America (São Paulo), and Asia Pacific (Mumbai). + // // - The environment type LINUX_GPU_CONTAINER is available only in regions US // East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU // (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney). + // // - The environment type WINDOWS_SERVER_2019_CONTAINER is available only in // regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific // (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland). + // // - The environment type WINDOWS_SERVER_2022_CONTAINER is available only in // regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), // EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific // (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai). - // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild user guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html EnvironmentType types.EnvironmentType // The compute fleet overflow behavior. + // // - For overflow behavior QUEUE , your overflow builds need to wait on the // existing fleet instance to become available. + // // - For overflow behavior ON_DEMAND , your overflow builds run on CodeBuild // on-demand. OverflowBehavior types.FleetOverflowBehavior @@ -100,8 +124,9 @@ type UpdateFleetInput struct { // The scaling configuration of the compute fleet. ScalingConfiguration *types.ScalingConfigurationInput - // A list of tag key and value pairs associated with this compute fleet. These - // tags are available for use by Amazon Web Services services that support + // A list of tag key and value pairs associated with this compute fleet. + // + // These tags are available for use by Amazon Web Services services that support // CodeBuild build project tags. Tags []types.Tag diff --git a/service/codebuild/api_op_UpdateProject.go b/service/codebuild/api_op_UpdateProject.go index 13909e21865..8fd611b5209 100644 --- a/service/codebuild/api_op_UpdateProject.go +++ b/service/codebuild/api_op_UpdateProject.go @@ -29,7 +29,9 @@ func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, type UpdateProjectInput struct { - // The name of the build project. You cannot change a build project's name. + // The name of the build project. + // + // You cannot change a build project's name. // // This member is required. Name *string @@ -49,47 +51,53 @@ type UpdateProjectInput struct { // time. Cache *types.ProjectCache - // The maximum number of concurrent builds that are allowed for this project. New - // builds are only started if the current number of builds is less than or equal to - // this limit. If the current build count meets this limit, new builds are - // throttled and are not run. To remove this limit, set this value to -1. + // The maximum number of concurrent builds that are allowed for this project. + // + // New builds are only started if the current number of builds is less than or + // equal to this limit. If the current build count meets this limit, new builds are + // throttled and are not run. + // + // To remove this limit, set this value to -1. ConcurrentBuildLimit *int32 // A new or replacement description of the build project. Description *string // The Key Management Service customer master key (CMK) to be used for encrypting - // 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/ ). + // 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/ ). 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 + // 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. FileSystemLocations []types.ProjectFileSystemLocation - // Information about logs for the build project. A project can create logs in + // Information about logs for the build project. A project can create logs in // CloudWatch Logs, logs in an S3 bucket, or both. LogsConfig *types.LogsConfig - // The number of minutes a build is allowed to be queued before it times out. + // The number of minutes a build is allowed to be queued before it times out. QueuedTimeoutInMinutes *int32 - // An array of ProjectArtifact objects. + // An array of ProjectArtifact objects. SecondaryArtifacts []types.ProjectArtifacts - // An array of ProjectSourceVersion objects. If secondarySourceVersions is + // An array of ProjectSourceVersion objects. If secondarySourceVersions is // specified at the build level, then they take over these secondarySourceVersions // (at the project level). SecondarySourceVersions []types.ProjectSourceVersion - // An array of ProjectSource objects. + // An array of ProjectSource objects. SecondarySources []types.ProjectSource // The replacement ARN of the IAM role that enables CodeBuild to interact with @@ -101,27 +109,35 @@ type UpdateProjectInput struct { // project. Source *types.ProjectSource - // A version of the build input to be built for this project. If not specified, + // 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. + // precedence over this sourceVersion (at the project level). + // + // For more information, see [Source Version Sample with CodeBuild] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html SourceVersion *string // An updated 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 diff --git a/service/codebuild/api_op_UpdateProjectVisibility.go b/service/codebuild/api_op_UpdateProjectVisibility.go index 42fa1b072c7..f5cc4953670 100644 --- a/service/codebuild/api_op_UpdateProjectVisibility.go +++ b/service/codebuild/api_op_UpdateProjectVisibility.go @@ -12,10 +12,10 @@ 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: +// and artifacts are available to the general public. For more information, see [Public build projects]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. @@ -29,15 +29,17 @@ import ( // 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]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. +// +// [Public build projects]: https://docs.aws.amazon.com/codebuild/latest/userguide/public-builds.html +// [Best practices for using webhooks]: https://docs.aws.amazon.com/codebuild/latest/userguide/webhooks.html#webhook-best-practices func (c *Client) UpdateProjectVisibility(ctx context.Context, params *UpdateProjectVisibilityInput, optFns ...func(*Options)) (*UpdateProjectVisibilityOutput, error) { if params == nil { params = &UpdateProjectVisibilityInput{} @@ -61,8 +63,10 @@ type UpdateProjectVisibilityInput struct { ProjectArn *string // Specifies the visibility of the project's builds. Possible values are: - // PUBLIC_READ The project builds are visible to the public. PRIVATE The project - // builds are not visible to the public. + // + // PUBLIC_READ The project builds are visible to the public. + // + // PRIVATE The project builds are not visible to the public. // // This member is required. ProjectVisibility types.ProjectVisibilityType @@ -80,8 +84,10 @@ type UpdateProjectVisibilityOutput struct { ProjectArn *string // Specifies the visibility of the project's builds. Possible values are: - // PUBLIC_READ The project builds are visible to the public. PRIVATE The project - // builds are not visible to the public. + // + // PUBLIC_READ The project builds are visible to the public. + // + // PRIVATE The project builds are not visible to the public. ProjectVisibility types.ProjectVisibilityType // Contains the project identifier used with the public build APIs. diff --git a/service/codebuild/api_op_UpdateReportGroup.go b/service/codebuild/api_op_UpdateReportGroup.go index 8e7aea9456c..aa6573bcca3 100644 --- a/service/codebuild/api_op_UpdateReportGroup.go +++ b/service/codebuild/api_op_UpdateReportGroup.go @@ -29,17 +29,20 @@ func (c *Client) UpdateReportGroup(ctx context.Context, params *UpdateReportGrou type UpdateReportGroupInput struct { - // The ARN of the report group to update. + // The ARN of the report group to update. // // This member is required. Arn *string - // Used to specify an updated export type. Valid values are: + // 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. ExportConfig *types.ReportExportConfig - // An updated list of tag key and value pairs associated with this report group. + // An updated list of tag key and value pairs associated with this report group. + // // These tags are available for use by Amazon Web Services services that support // CodeBuild report group tags. Tags []types.Tag @@ -49,7 +52,7 @@ type UpdateReportGroupInput struct { type UpdateReportGroupOutput struct { - // Information about the updated report group. + // Information about the updated report group. ReportGroup *types.ReportGroup // Metadata pertaining to the operation's result. diff --git a/service/codebuild/api_op_UpdateWebhook.go b/service/codebuild/api_op_UpdateWebhook.go index fbe3cec09cd..3e4e3ff3770 100644 --- a/service/codebuild/api_op_UpdateWebhook.go +++ b/service/codebuild/api_op_UpdateWebhook.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the webhook associated with an CodeBuild build project. If you use -// Bitbucket for your repository, rotateSecret is ignored. +// Updates the webhook associated with an CodeBuild build project. +// +// If you use Bitbucket for your repository, rotateSecret is ignored. func (c *Client) UpdateWebhook(ctx context.Context, params *UpdateWebhookInput, optFns ...func(*Options)) (*UpdateWebhookOutput, error) { if params == nil { params = &UpdateWebhookInput{} @@ -37,19 +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 . + // then it is built. If branchFilter is empty, then all branches are built. + // + // It is 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 + // 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 + // 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 @@ -59,7 +61,7 @@ type UpdateWebhookInput struct { type UpdateWebhookOutput struct { - // Information about a repository's webhook that is associated with a project in + // Information about a repository's webhook that is associated with a project in // CodeBuild. Webhook *types.Webhook diff --git a/service/codebuild/doc.go b/service/codebuild/doc.go index 714b36ffdfd..e1fda93d875 100644 --- a/service/codebuild/doc.go +++ b/service/codebuild/doc.go @@ -3,14 +3,17 @@ // Package codebuild provides the API client, operations, and parameter types for // AWS CodeBuild. // -// CodeBuild CodeBuild is a fully managed build service in the cloud. CodeBuild -// compiles your source code, runs unit tests, and produces artifacts that are -// ready to deploy. CodeBuild eliminates the need to provision, manage, and scale -// your own build servers. It provides prepackaged build environments for the most -// popular programming languages and build tools, such as Apache Maven, Gradle, and -// 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) -// . +// # CodeBuild +// +// CodeBuild is a fully managed build service in the cloud. CodeBuild compiles +// your source code, runs unit tests, and produces artifacts that are ready to +// deploy. CodeBuild eliminates the need to provision, manage, and scale your own +// build servers. It provides prepackaged build environments for the most popular +// programming languages and build tools, such as Apache Maven, Gradle, and 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]. +// +// [CodeBuild User Guide]: https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html package codebuild diff --git a/service/codebuild/options.go b/service/codebuild/options.go index c8dce451d25..60a638fdd8c 100644 --- a/service/codebuild/options.go +++ b/service/codebuild/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codebuild/types/enums.go b/service/codebuild/types/enums.go index 5c881373eea..0f92010c682 100644 --- a/service/codebuild/types/enums.go +++ b/service/codebuild/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ArtifactNamespace. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactNamespace) Values() []ArtifactNamespace { return []ArtifactNamespace{ "NONE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ArtifactPackaging. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactPackaging) Values() []ArtifactPackaging { return []ArtifactPackaging{ "NONE", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for ArtifactsType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactsType) Values() []ArtifactsType { return []ArtifactsType{ "CODEPIPELINE", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for AuthType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthType) Values() []AuthType { return []AuthType{ "OAUTH", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for BatchReportModeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchReportModeType) Values() []BatchReportModeType { return []BatchReportModeType{ "REPORT_INDIVIDUAL_BUILDS", @@ -108,8 +113,9 @@ const ( ) // Values returns all known values for BucketOwnerAccess. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketOwnerAccess) Values() []BucketOwnerAccess { return []BucketOwnerAccess{ "NONE", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for BuildBatchPhaseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BuildBatchPhaseType) Values() []BuildBatchPhaseType { return []BuildBatchPhaseType{ "SUBMITTED", @@ -164,8 +171,9 @@ const ( ) // Values returns all known values for BuildPhaseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BuildPhaseType) Values() []BuildPhaseType { return []BuildPhaseType{ "SUBMITTED", @@ -192,8 +200,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -212,8 +221,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -239,8 +249,9 @@ const ( ) // Values returns all known values for ComputeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeType) Values() []ComputeType { return []ComputeType{ "BUILD_GENERAL1_SMALL", @@ -264,8 +275,9 @@ const ( ) // Values returns all known values for CredentialProviderType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CredentialProviderType) Values() []CredentialProviderType { return []CredentialProviderType{ "SECRETS_MANAGER", @@ -286,8 +298,9 @@ const ( ) // Values returns all known values for EnvironmentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentType) Values() []EnvironmentType { return []EnvironmentType{ "WINDOWS_CONTAINER", @@ -310,8 +323,9 @@ const ( ) // Values returns all known values for EnvironmentVariableType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentVariableType) Values() []EnvironmentVariableType { return []EnvironmentVariableType{ "PLAINTEXT", @@ -328,8 +342,9 @@ const ( ) // Values returns all known values for FileSystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemType) Values() []FileSystemType { return []FileSystemType{ "EFS", @@ -345,8 +360,9 @@ const ( ) // Values returns all known values for FleetContextCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetContextCode) Values() []FleetContextCode { return []FleetContextCode{ "CREATE_FAILED", @@ -363,8 +379,9 @@ const ( ) // Values returns all known values for FleetOverflowBehavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetOverflowBehavior) Values() []FleetOverflowBehavior { return []FleetOverflowBehavior{ "QUEUE", @@ -380,8 +397,9 @@ const ( ) // Values returns all known values for FleetScalingMetricType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetScalingMetricType) Values() []FleetScalingMetricType { return []FleetScalingMetricType{ "FLEET_UTILIZATION_RATE", @@ -396,8 +414,9 @@ const ( ) // Values returns all known values for FleetScalingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetScalingType) Values() []FleetScalingType { return []FleetScalingType{ "TARGET_TRACKING_SCALING", @@ -414,8 +433,9 @@ const ( ) // Values returns all known values for FleetSortByType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetSortByType) Values() []FleetSortByType { return []FleetSortByType{ "NAME", @@ -439,8 +459,9 @@ const ( ) // Values returns all known values for FleetStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetStatusCode) Values() []FleetStatusCode { return []FleetStatusCode{ "CREATING", @@ -464,6 +485,7 @@ const ( // 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{ @@ -489,8 +511,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -515,8 +538,9 @@ const ( ) // Values returns all known values for LogsConfigStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogsConfigStatusType) Values() []LogsConfigStatusType { return []LogsConfigStatusType{ "ENABLED", @@ -535,8 +559,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -556,8 +581,9 @@ const ( ) // Values returns all known values for ProjectSortByType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectSortByType) Values() []ProjectSortByType { return []ProjectSortByType{ "NAME", @@ -575,8 +601,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PUBLIC_READ", @@ -594,8 +621,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportCodeCoverageSortByType) Values() []ReportCodeCoverageSortByType { return []ReportCodeCoverageSortByType{ "LINE_COVERAGE_PERCENTAGE", @@ -612,8 +640,9 @@ const ( ) // Values returns all known values for ReportExportConfigType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportExportConfigType) Values() []ReportExportConfigType { return []ReportExportConfigType{ "S3", @@ -631,8 +660,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NAME", @@ -650,8 +680,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -676,6 +707,7 @@ const ( // Values returns all known values for ReportGroupTrendFieldType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReportGroupTrendFieldType) Values() []ReportGroupTrendFieldType { return []ReportGroupTrendFieldType{ @@ -700,8 +732,9 @@ const ( ) // Values returns all known values for ReportPackagingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportPackagingType) Values() []ReportPackagingType { return []ReportPackagingType{ "ZIP", @@ -721,8 +754,9 @@ const ( ) // Values returns all known values for ReportStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportStatusType) Values() []ReportStatusType { return []ReportStatusType{ "GENERATING", @@ -742,8 +776,9 @@ const ( ) // Values returns all known values for ReportType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportType) Values() []ReportType { return []ReportType{ "TEST", @@ -760,8 +795,9 @@ const ( ) // Values returns all known values for RetryBuildBatchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetryBuildBatchType) Values() []RetryBuildBatchType { return []RetryBuildBatchType{ "RETRY_ALL_BUILDS", @@ -781,8 +817,9 @@ const ( ) // Values returns all known values for ServerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerType) Values() []ServerType { return []ServerType{ "GITHUB", @@ -803,6 +840,7 @@ const ( // 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{ @@ -820,8 +858,9 @@ const ( ) // Values returns all known values for SortOrderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortOrderType) Values() []SortOrderType { return []SortOrderType{ "ASCENDING", @@ -838,8 +877,9 @@ const ( ) // Values returns all known values for SourceAuthType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceAuthType) Values() []SourceAuthType { return []SourceAuthType{ "OAUTH", @@ -863,8 +903,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "CODECOMMIT", @@ -892,8 +933,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "SUCCEEDED", @@ -914,8 +956,9 @@ const ( ) // Values returns all known values for WebhookBuildType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebhookBuildType) Values() []WebhookBuildType { return []WebhookBuildType{ "BUILD", @@ -939,8 +982,9 @@ const ( ) // Values returns all known values for WebhookFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebhookFilterType) Values() []WebhookFilterType { return []WebhookFilterType{ "EVENT", diff --git a/service/codebuild/types/types.go b/service/codebuild/types/types.go index a08914b1373..de2b2240dd2 100644 --- a/service/codebuild/types/types.go +++ b/service/codebuild/types/types.go @@ -11,8 +11,9 @@ 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) - // in the CodeBuild User Guide for these values. + // batch build. See [Build environment compute types]in the CodeBuild User Guide for these values. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html ComputeTypesAllowed []string // Specifies the maximum number of builds allowed. @@ -42,11 +43,17 @@ type Build struct { 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. BuildStatus StatusType @@ -60,10 +67,13 @@ type Build struct { DebugSession *DebugSession // The Key Management Service customer master key (CMK) to be used for encrypting - // 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/ ). + // 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/ ). EncryptionKey *string // When the build process ended, expressed in Unix time format. @@ -72,14 +82,16 @@ type Build struct { // Information about the build environment for this build. Environment *ProjectEnvironment - // 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) - // in the CodePipeline User Guide. + // 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]in the CodePipeline User Guide. + // + // [Working with variables]: https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html ExportedEnvironmentVariables []ExportedEnvironmentVariable - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // 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. @@ -89,9 +101,12 @@ type Build struct { 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 a 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 @@ -109,38 +124,45 @@ type Build struct { // The name of the CodeBuild project. ProjectName *string - // The number of minutes a build is allowed to be queued before it times out. + // The number of minutes a build is allowed to be queued before it times out. QueuedTimeoutInMinutes *int32 - // An array of the ARNs associated with this build's reports. + // An array of the ARNs associated with this build's reports. ReportArns []string - // An identifier for the version of this build's source code. + // 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. ResolvedSourceVersion *string - // An array of ProjectArtifacts objects. + // An array of ProjectArtifacts objects. SecondaryArtifacts []BuildArtifacts - // An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one - // of: + // 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. SecondarySourceVersions []ProjectSourceVersion - // An array of ProjectSource objects. + // An array of ProjectSource objects. SecondarySources []ProjectSource // The name of a service role used for this build. @@ -151,9 +173,11 @@ type Build struct { // 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) - // in the CodeBuild User Guide. + // the build level) takes precedence. + // + // For more information, see [Source Version Sample with CodeBuild] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html SourceVersion *string // When the build process started, expressed in Unix time format. @@ -175,49 +199,68 @@ type Build struct { // Information about build output artifacts. type BuildArtifacts struct { - // An identifier for this artifact definition. + // An identifier for this artifact definition. ArtifactIdentifier *string // Specifies the bucket owner's access for objects that another account uploads to // their Amazon S3 bucket. By default, only the account that uploads the objects to // the bucket has access to these objects. This property allows you to give the - // bucket owner access to these objects. To use this property, your CodeBuild - // service role must have the s3:PutBucketAcl permission. This permission allows - // CodeBuild to modify the access control list for the bucket. This property can be - // one of the following values: NONE The bucket owner does not have access to the - // objects. This is the default. READ_ONLY The bucket owner has read-only access to - // 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: + // bucket owner access to these objects. + // + // To use this property, your CodeBuild service role must have the s3:PutBucketAcl + // permission. This permission allows CodeBuild to modify the access control list + // for the bucket. + // + // This property can be one of the following values: + // + // NONE The bucket owner does not have access to the objects. This is the default. + // + // READ_ONLY The bucket owner has read-only access to 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) - // in the Amazon Simple Storage Service User Guide. + // + // For more information about Amazon S3 object ownership, see [Controlling ownership of uploaded objects using S3 Object Ownership] in the Amazon + // Simple Storage Service User Guide. + // + // [Controlling ownership of uploaded objects using S3 Object Ownership]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html BucketOwnerAccess BucketOwnerAccess - // Information that tells you if encryption for build artifacts is disabled. + // Information that tells you if encryption for build artifacts is disabled. EncryptionDisabled *bool // Information about the location of the build artifacts. Location *string - // 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 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 . Md5sum *string - // If this flag is set, a name specified in the buildspec file overrides the + // If this flag is set, a name specified in the buildspec file overrides the // artifact name. The name specified in a buildspec file is calculated at build // time and uses the Shell Command Language. For example, you can append a date and // time to your artifact name so that it is always unique. OverrideArtifactName *bool - // 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 . + // 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 . Sha256sum *string noSmithyDocumentSerde @@ -261,15 +304,20 @@ 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]. Batch session debugging is not supported for matrix batch + // builds. + // + // [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) 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 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/ ). EncryptionKey *string // The date and time that the batch build ended. @@ -288,14 +336,17 @@ type BuildBatch struct { 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 a 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 + // Information about logs for a build project. These can be logs in CloudWatch // Logs, built in a specified S3 bucket, or both. LogConfig *LogsConfig @@ -310,8 +361,11 @@ 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. ResolvedSourceVersion *string @@ -321,16 +375,20 @@ type BuildBatch 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. SecondarySourceVersions []ProjectSourceVersion @@ -380,18 +438,37 @@ type BuildBatchPhase struct { // When the batch build phase ended, expressed in Unix time format. EndTime *time.Time - // The current status of the batch build phase. Valid values include: FAILED The - // build phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase - // is still in progress. STOPPED The build phase stopped. SUCCEEDED The build phase - // succeeded. TIMED_OUT The build phase timed out. + // The current status of the batch build phase. Valid values include: + // + // FAILED The build phase failed. + // + // FAULT The build phase faulted. + // + // IN_PROGRESS The build phase is still in progress. + // + // STOPPED The build phase stopped. + // + // SUCCEEDED The build phase 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. - // 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 - // submitted. SUCCEEDED The batch build succeeded. + // 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 submitted. + // + // SUCCEEDED The batch build succeeded. PhaseType BuildBatchPhaseType // When the batch build phase started, expressed in Unix time format. @@ -451,22 +528,45 @@ type BuildPhase struct { // When the build phase ended, expressed in Unix time format. EndTime *time.Time - // The current status of the build phase. Valid values include: FAILED The build - // phase failed. FAULT The build phase faulted. IN_PROGRESS The build phase is - // still in progress. STOPPED The build phase stopped. SUCCEEDED The build phase - // succeeded. TIMED_OUT The build phase timed out. + // The current status of the build phase. Valid values include: + // + // FAILED The build phase failed. + // + // FAULT The build phase faulted. + // + // IN_PROGRESS The build phase is still in progress. + // + // STOPPED The build phase stopped. + // + // SUCCEEDED The build phase succeeded. + // + // TIMED_OUT The build phase timed out. PhaseStatus StatusType - // The name of the build phase. Valid values include: BUILD Core build activities - // typically occur in this build phase. COMPLETED The build has been completed. - // DOWNLOAD_SOURCE Source code is being downloaded in this build phase. FINALIZING - // The build process is completing in this build phase. INSTALL Installation - // activities typically occur in this build phase. POST_BUILD Post-build activities - // typically occur in this build phase. PRE_BUILD Pre-build activities typically - // occur in this build phase. PROVISIONING The build environment is being set up. + // The name of the build phase. Valid values include: + // + // BUILD Core build activities typically occur in this build phase. + // + // COMPLETED The build has been completed. + // + // DOWNLOAD_SOURCE Source code is being downloaded in this build phase. + // + // FINALIZING The build process is completing in this build phase. + // + // INSTALL Installation activities typically occur in this build phase. + // + // POST_BUILD Post-build activities typically occur in this build phase. + // + // PRE_BUILD Pre-build activities typically occur in this build phase. + // + // PROVISIONING The build environment is being set up. + // // QUEUED The build has been submitted and is queued behind other submitted builds. - // SUBMITTED The build has been submitted. UPLOAD_ARTIFACTS Build output artifacts - // are being uploaded to the output location. + // + // SUBMITTED The build has been submitted. + // + // UPLOAD_ARTIFACTS Build output artifacts are being uploaded to the output + // location. PhaseType BuildPhaseType // When the build phase started, expressed in Unix time format. @@ -480,23 +580,31 @@ type BuildPhase struct { 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) - // 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. + // 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]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]in the GitHub + // developer guide. + // + // [build]: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build + // [Create a commit status]: https://developer.github.com/v3/repos/statuses/#create-a-commit-status 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) - // 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. + // 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]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]in the GitHub + // developer guide. + // + // [build]: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build + // [Create a commit status]: https://developer.github.com/v3/repos/statuses/#create-a-commit-status TargetUrl *string noSmithyDocumentSerde @@ -508,10 +616,19 @@ type BuildSummary struct { // The batch build ARN. Arn *string - // The status of the build group. FAILED The build group failed. FAULT The build - // group faulted. IN_PROGRESS The build group is still in progress. STOPPED The - // build group stopped. SUCCEEDED The build group succeeded. TIMED_OUT The build - // group timed out. + // The status of the build group. + // + // FAILED The build group failed. + // + // FAULT The build group faulted. + // + // IN_PROGRESS The build group is still in progress. + // + // STOPPED The build group stopped. + // + // SUCCEEDED The build group succeeded. + // + // TIMED_OUT The build group timed out. BuildStatus StatusType // A ResolvedArtifact object that represents the primary build artifacts for the @@ -533,29 +650,35 @@ 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. // // 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]. + // + // [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) - // . + // The prefix of the stream name of the CloudWatch Logs. For more information, + // see [Working with Log Groups and Log Streams]. + // + // [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 } -// Contains code coverage report information. Line coverage measures how many -// statements your tests cover. A statement is a single instruction, not including -// comments, conditionals, etc. Branch coverage determines if your tests cover -// every possible branch of a control structure, such as an if or case statement. +// Contains code coverage report information. +// +// Line coverage measures how many statements your tests cover. A statement is a +// single instruction, not including comments, conditionals, etc. +// +// Branch coverage determines if your tests cover every possible branch of a +// control structure, such as an if or case statement. type CodeCoverage struct { // The percentage of branches that are covered by your tests. @@ -591,10 +714,13 @@ type CodeCoverage struct { noSmithyDocumentSerde } -// Contains a summary of a code coverage report. Line coverage measures how many -// statements your tests cover. A statement is a single instruction, not including -// comments, conditionals, etc. Branch coverage determines if your tests cover -// every possible branch of a control structure, such as an if or case statement. +// Contains a summary of a code coverage report. +// +// Line coverage measures how many statements your tests cover. A statement is a +// single instruction, not including comments, conditionals, etc. +// +// Branch coverage determines if your tests cover every possible branch of a +// control structure, such as an if or case statement. type CodeCoverageReportSummary struct { // The percentage of branches that are covered by your tests. @@ -619,8 +745,9 @@ 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]. +// +// [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. @@ -684,45 +811,54 @@ type EnvironmentVariable struct { // This member is required. Name *string - // The value of the environment variable. We strongly discourage the use of - // PLAINTEXT environment variables to store sensitive values, especially Amazon Web - // Services secret key IDs. 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 . + // The value of the environment variable. + // + // We strongly discourage the use of PLAINTEXT environment variables to store + // sensitive values, especially Amazon Web Services secret key IDs. 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 . // // 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. For environment variables of this type, specify the name of the // parameter as the value of the EnvironmentVariable. The parameter value will be // substituted for the name at runtime. You can also define Parameter Store - // environment variables in the buildspec. To learn how to do so, 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. + // environment variables in the buildspec. To learn how to do so, see [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. For // environment variables of this type, specify the name of the secret as the // value of the EnvironmentVariable. The secret value will be substituted for the // name at runtime. You can also define Secrets Manager environment variables in - // the buildspec. To learn how to do so, 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. + // the buildspec. To learn how to do so, see [env/secrets-manager]in the CodeBuild User Guide. + // + // [env/secrets-manager]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager + // [env/parameter-store]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store Type EnvironmentVariableType noSmithyDocumentSerde } -// 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) -// 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 -// phase ends, the value of exported variables cannot change. +// 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]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 phase ends, the value of exported +// variables cannot change. +// +// [Working with variables]: https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html type ExportedEnvironmentVariable struct { // The name of the exported environment variable. @@ -746,57 +882,79 @@ type Fleet struct { // Information about the compute resources the compute fleet 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_XLARGE : Use up to 70 GB memory and 36 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_SMALL : + // // - For environment type LINUX_CONTAINER , you can use up to 3 GB memory and 2 // vCPUs for builds. + // // - For environment type LINUX_GPU_CONTAINER , you can use up to 16 GB memory, 4 // vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. + // // - For environment type ARM_CONTAINER , you can use up to 4 GB memory and 2 // vCPUs on ARM-based processors for builds. + // // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild User Guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html ComputeType ComputeType // The time at which the compute fleet was created. Created *time.Time // The environment type of the compute fleet. + // // - 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 (Singapore), Asia Pacific (Sydney), // EU (Frankfurt), and South America (São Paulo). + // // - The environment type LINUX_CONTAINER is available only in regions US East // (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), // Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South // America (São Paulo), and Asia Pacific (Mumbai). + // // - The environment type LINUX_GPU_CONTAINER is available only in regions US // East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU // (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney). + // // - The environment type WINDOWS_SERVER_2019_CONTAINER is available only in // regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific // (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland). + // // - The environment type WINDOWS_SERVER_2022_CONTAINER is available only in // regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), // EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific // (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai). - // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild user guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html EnvironmentType EnvironmentType // The ID of the compute fleet. @@ -809,8 +967,10 @@ type Fleet struct { Name *string // The compute fleet overflow behavior. + // // - For overflow behavior QUEUE , your overflow builds need to wait on the // existing fleet instance to become available. + // // - For overflow behavior ON_DEMAND , your overflow builds run on CodeBuild // on-demand. OverflowBehavior FleetOverflowBehavior @@ -821,8 +981,9 @@ type Fleet struct { // The status of the compute fleet. Status *FleetStatus - // A list of tag key and value pairs associated with this compute fleet. These - // tags are available for use by Amazon Web Services services that support + // A list of tag key and value pairs associated with this compute fleet. + // + // These tags are available for use by Amazon Web Services services that support // CodeBuild build project tags. Tags []Tag @@ -833,7 +994,9 @@ type Fleet struct { type FleetStatus struct { // Additional information about a compute fleet. Valid values include: + // // - CREATE_FAILED : The compute fleet has failed to create. + // // - UPDATE_FAILED : The compute fleet has failed to update. Context FleetContextCode @@ -841,25 +1004,34 @@ type FleetStatus struct { Message *string // The status code of the compute fleet. Valid values include: + // // - CREATING : The compute fleet is being created. + // // - UPDATING : The compute fleet is being updated. + // // - ROTATING : The compute fleet is being rotated. + // // - PENDING_DELETION : The compute fleet is pending deletion. + // // - DELETING : The compute fleet is being deleted. + // // - CREATE_FAILED : The compute fleet has failed to create. + // // - UPDATE_ROLLBACK_FAILED : The compute fleet has failed to update and could // not rollback to previous state. + // // - ACTIVE : The compute fleet has succeeded and is active. StatusCode FleetStatusCode noSmithyDocumentSerde } -// Information about the Git submodules configuration for an CodeBuild build +// Information about the Git submodules configuration for an CodeBuild build +// // project. type GitSubmodulesConfig struct { - // Set to true to fetch Git submodules for your CodeBuild build project. + // Set to true to fetch Git submodules for your CodeBuild build project. // // This member is required. FetchSubmodules *bool @@ -867,15 +1039,16 @@ type GitSubmodulesConfig struct { noSmithyDocumentSerde } -// Information about logs for a build project. These can be logs in CloudWatch +// Information about logs for a build project. These can be logs in CloudWatch +// // Logs, built in a specified S3 bucket, or both. type LogsConfig struct { - // Information about CloudWatch Logs for a build project. CloudWatch Logs are + // Information about CloudWatch Logs for a build project. CloudWatch Logs are // enabled by default. CloudWatchLogs *CloudWatchLogsConfig - // Information about logs built to an S3 bucket for a build project. S3 logs are + // Information about logs built to an S3 bucket for a build project. S3 logs are // not enabled by default. S3Logs *S3LogsConfig @@ -885,15 +1058,15 @@ type LogsConfig struct { // Information about build logs in CloudWatch Logs. type LogsLocation struct { - // Information about CloudWatch Logs for a build project. + // Information about CloudWatch Logs for a build project. CloudWatchLogs *CloudWatchLogsConfig // The ARN of the CloudWatch Logs stream for a build execution. Its format is // arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName} // . The CloudWatch Logs stream is created during the PROVISIONING phase of a build - // and the ARN will not be valid until it is created. 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) - // . + // and the ARN will not be valid until it is created. For more information, see [Resources Defined by CloudWatch Logs]. + // + // [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. The log stream is @@ -904,16 +1077,16 @@ type LogsLocation struct { // The name of the CloudWatch Logs group for the build logs. GroupName *string - // The URL to a build log in an S3 bucket. + // The URL to a build log in an S3 bucket. S3DeepLink *string - // Information about S3 logs for a build project. + // Information about S3 logs for a build project. 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) - // . + // 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]. + // + // [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. @@ -960,16 +1133,16 @@ type Project struct { // Information about the build badge for the build project. Badge *ProjectBadge - // A ProjectBuildBatchConfig object that defines the batch build options for the - // project. + // A ProjectBuildBatchConfig object that defines the batch build options for the project. BuildBatchConfig *ProjectBuildBatchConfig // Information about the cache for the build project. Cache *ProjectCache - // The maximum number of concurrent builds that are allowed for this project. New - // builds are only started if the current number of builds is less than or equal to - // this limit. If the current build count meets this limit, new builds are + // The maximum number of concurrent builds that are allowed for this project. + // + // New builds are only started if the current number of builds is less than or + // equal to this limit. If the current build count meets this limit, new builds are // throttled and are not run. ConcurrentBuildLimit *int32 @@ -980,17 +1153,21 @@ type Project struct { Description *string // The Key Management Service customer master key (CMK) to be used for encrypting - // 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 - // uses the managed CMK for Amazon Simple Storage Service (Amazon S3). + // 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 uses the managed CMK for Amazon Simple Storage Service (Amazon + // S3). EncryptionKey *string // Information about the build environment for this build project. Environment *ProjectEnvironment - // An array of ProjectFileSystemLocation objects for a CodeBuild build project. A + // 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. @@ -1008,8 +1185,10 @@ type Project struct { Name *string // Specifies the visibility of the project's builds. Possible values are: - // PUBLIC_READ The project builds are visible to the public. PRIVATE The project - // builds are not visible to the public. + // + // PUBLIC_READ The project builds are visible to the public. + // + // PRIVATE The project builds are not visible to the public. ProjectVisibility ProjectVisibilityType // Contains the project identifier used with the public build APIs. @@ -1042,26 +1221,34 @@ type Project struct { // 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. + // precedence over this sourceVersion (at the project level). + // + // For more information, see [Source Version Sample with CodeBuild] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html 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 + // 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 @@ -1084,116 +1271,156 @@ 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 . + // 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 - // An identifier for this artifact definition. + // An identifier for this artifact definition. ArtifactIdentifier *string // Specifies the bucket owner's access for objects that another account uploads to // their Amazon S3 bucket. By default, only the account that uploads the objects to // the bucket has access to these objects. This property allows you to give the - // bucket owner access to these objects. To use this property, your CodeBuild - // service role must have the s3:PutBucketAcl permission. This permission allows - // CodeBuild to modify the access control list for the bucket. This property can be - // one of the following values: NONE The bucket owner does not have access to the - // objects. This is the default. READ_ONLY The bucket owner has read-only access to - // 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: + // bucket owner access to these objects. + // + // To use this property, your CodeBuild service role must have the s3:PutBucketAcl + // permission. This permission allows CodeBuild to modify the access control list + // for the bucket. + // + // This property can be one of the following values: + // + // NONE The bucket owner does not have access to the objects. This is the default. + // + // READ_ONLY The bucket owner has read-only access to 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) - // in the Amazon Simple Storage Service User Guide. + // + // For more information about Amazon S3 object ownership, see [Controlling ownership of uploaded objects using S3 Object Ownership] in the Amazon + // Simple Storage Service User Guide. + // + // [Controlling ownership of uploaded objects using S3 Object Ownership]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html BucketOwnerAccess BucketOwnerAccess - // Set to true if you do not want your output artifacts encrypted. This option is + // Set to true if you do not want your output artifacts encrypted. This option is // valid only if your artifacts type is Amazon S3. If this is set with another // artifacts type, an invalidInputException is thrown. 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. Location *string // 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. + // // 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/ . Name *string // 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. + // + // - 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 + // If this flag is set, a name specified in the buildspec file overrides the // artifact name. The name specified in a buildspec file is calculated at build // time and uses the Shell Command Language. For example, you can append a date and // time to your artifact name so that it is always unique. 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. Packaging ArtifactPackaging // 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 . @@ -1223,9 +1450,12 @@ type ProjectBuildBatchConfig struct { // 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. + // 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 @@ -1249,8 +1479,11 @@ 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. // @@ -1258,32 +1491,45 @@ type ProjectCache struct { Type CacheType // Information about the cache location: + // // - 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 // local cache modes at the same time. This is only used for LOCAL cache types. - // Possible values are: LOCAL_SOURCE_CACHE Caches Git metadata for primary and - // secondary sources. After the cache is created, subsequent builds pull only the - // change between commits. This mode is a good choice for projects with a clean - // working directory and a source that is a large Git repository. If you choose - // this option and your project does not use a Git repository (GitHub, GitHub - // Enterprise, or Bitbucket), the option is ignored. LOCAL_DOCKER_LAYER_CACHE - // 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. + // + // Possible values are: + // + // LOCAL_SOURCE_CACHE Caches Git metadata for primary and secondary sources. After + // the cache is created, subsequent builds pull only the change between commits. + // This mode is a good choice for projects with a clean working directory and a + // source that is a large Git repository. If you choose this option and your + // project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), + // the option is ignored. + // + // LOCAL_DOCKER_LAYER_CACHE 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. @@ -1297,68 +1543,97 @@ 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_XLARGE : Use up to 70 GB memory and 36 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. + // // - BUILD_LAMBDA_1GB : Use up to 1 GB memory for builds. Only available for // environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER . + // // - BUILD_LAMBDA_2GB : Use up to 2 GB memory for builds. Only available for // environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER . + // // - BUILD_LAMBDA_4GB : Use up to 4 GB memory for builds. Only available for // environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER . + // // - BUILD_LAMBDA_8GB : Use up to 8 GB memory for builds. Only available for // environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER . + // // - BUILD_LAMBDA_10GB : Use up to 10 GB memory for builds. Only available for // environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER . + // // If you use BUILD_GENERAL1_SMALL : + // // - For environment type LINUX_CONTAINER , you can use up to 3 GB memory and 2 // vCPUs for builds. + // // - For environment type LINUX_GPU_CONTAINER , you can use up to 16 GB memory, 4 // vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. + // // - For environment type ARM_CONTAINER , you can use up to 4 GB memory and 2 // vCPUs on ARM-based processors for builds. + // // 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. + // // If you're using compute fleets during project creation, computeType will be - // ignored. 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. + // ignored. + // + // For more information, see [Build Environment Compute Types] in the CodeBuild User Guide. + // + // [Build Environment Compute Types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html // // This member is required. ComputeType ComputeType // 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) - // in the CodeBuild user guide. + // + // For more information, see [Docker images provided by CodeBuild] in the CodeBuild user guide. + // + // [Docker images provided by CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html // // 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 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 @@ -1374,17 +1649,21 @@ type ProjectEnvironment struct { // - 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). + // // If you're using compute fleets during project creation, type will be ignored. - // 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. + // + // For more information, see [Build environment compute types] in the CodeBuild user guide. + // + // [Build environment compute types]: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html // // This member is required. Type EnvironmentType // 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) - // in the CodeBuild User Guide. + // PEM-encoded certificate for the build project. For more information, see [certificate]in the + // CodeBuild User Guide. + // + // [certificate]: https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate Certificate *string // A set of environment variables to make available to builds for this build @@ -1394,13 +1673,15 @@ type ProjectEnvironment struct { // A ProjectFleet object to use for this build project. Fleet *ProjectFleet - // The type of credentials CodeBuild uses to pull images in your build. There are + // 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. @@ -1408,34 +1689,47 @@ type ProjectEnvironment struct { // 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 + // 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 - // 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 - // --host=tcp://0.0.0.0:2375 --storage-driver=overlay& + // 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 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 + // --host=tcp://0.0.0.0:2375 --storage-driver=overlay& + // // - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done" PrivilegedMode *bool - // The credentials for access to a private registry. + // The credentials for access to a private registry. RegistryCredential *RegistryCredential 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?] +// +// [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. + // 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. @@ -1444,31 +1738,34 @@ type ProjectFileSystemLocation struct { // 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 - // 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. + // 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. Location *string - // The mount options for a file system created by Amazon EFS. The default mount + // 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) - // . + // information, see [Recommended NFS Mount Options]. + // + // [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 } // Information about the compute fleet of the build project. For more information, -// see Working with reserved capacity in CodeBuild (https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html) -// . +// see [Working with reserved capacity in CodeBuild]. +// +// [Working with reserved capacity in CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html type ProjectFleet struct { // Specifies the compute fleet ARN for the build project. @@ -1482,25 +1779,35 @@ 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 repository. + // // - GITHUB_ENTERPRISE : The source code is in a GitHub Enterprise Server // repository. + // // - GITLAB : The source code is in a GitLab repository. - // - GITLAB_SELF_MANAGED : The source code is in a self-managed GitLab - // repository. + // + // - GITLAB_SELF_MANAGED : The source code is in a self-managed GitLab 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 // Information about the authorization settings for CodeBuild to access the source - // code to be built. This information is for the CodeBuild console's use only. Your - // code should not get or set this information directly. + // code to be built. + // + // This information is for the CodeBuild console's use only. Your code should not + // get or set this information directly. Auth *SourceAuth // Contains information that defines how the build project reports the build @@ -1508,23 +1815,24 @@ type ProjectSource struct { // is GITHUB , GITHUB_ENTERPRISE , or BITBUCKET . BuildStatusConfig *BuildStatusConfig - // The buildspec file declaration to use for the builds in this 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 + // The buildspec file declaration to use for the builds in this 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) - // . + // its root directory. For more information, see [Buildspec File Name and Storage Location]. + // + // [Buildspec File Name and 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. GitCloneDepth *int32 - // Information about the Git submodules configuration for the build project. + // Information about the Git submodules configuration for the build project. GitSubmodulesConfig *GitSubmodulesConfig // Enable this flag to ignore SSL warnings while connecting to the project source @@ -1533,17 +1841,23 @@ 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 @@ -1555,6 +1869,7 @@ type ProjectSource struct { // 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 an GitLab or self-managed GitLab 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 GitLab account. Use the @@ -1566,6 +1881,7 @@ type ProjectSource struct { // CodeBuild console.) To instruct CodeBuild to override the default connection and // use this connection instead, set the auth object's type value to // CODECONNECTIONS in the source object. + // // - 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 @@ -1575,22 +1891,28 @@ type ProjectSource struct { // 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 + // Set to true to report the status of a build's start and finish to your source // provider. This option is valid only when your source provider is GitHub, GitHub // Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you - // use a different source 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. + // use a different source 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]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. + // + // [Source provider access]: https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html ReportBuildStatus *bool // An identifier for this project source. The identifier can only contain @@ -1613,20 +1935,26 @@ type ProjectSourceVersion struct { // 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 or GitLab: 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. + // + // For more information, see [Source Version Sample with CodeBuild] in the CodeBuild User Guide. + // + // [Source Version Sample with CodeBuild]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html // // This member is required. SourceVersion *string @@ -1634,24 +1962,29 @@ type ProjectSourceVersion struct { noSmithyDocumentSerde } -// Information about credentials that provide access to a private Docker registry. -// When this is set: +// 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. // -// 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]. +// +// [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 - // Manager. The credential can use the name of the credentials only if they exist - // in your current Amazon Web Services Region. + // The Amazon Resource Name (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. // // This member is required. Credential *string - // The service that created the credentials to access a private Docker registry. + // The service that created the credentials to access a private Docker registry. // The valid value, SECRETS_MANAGER, is for Secrets Manager. // // This member is required. @@ -1667,44 +2000,48 @@ type RegistryCredential struct { // functional tests. type Report struct { - // The ARN of the report run. + // The ARN of the report run. Arn *string // A CodeCoverageReportSummary object that contains a code coverage summary for // this report. CodeCoverageSummary *CodeCoverageReportSummary - // The date and time this report run occurred. + // The date and time this report run occurred. Created *time.Time - // The ARN of the build run that generated this report. + // The ARN of the build run that generated this report. ExecutionId *string - // The date and time a report expires. A report expires 30 days after it is + // The date and time a report expires. A report expires 30 days after it is // created. An expired report is not available to view in CodeBuild. Expired *time.Time - // Information about where the raw data used to generate this report was exported. + // Information about where the raw data used to generate this report was + // exported. ExportConfig *ReportExportConfig - // The name of the report that was run. + // The name of the report that was run. Name *string - // The ARN of the report group associated with this report. + // The ARN of the report group associated with this report. ReportGroupArn *string - // The status of this report. + // The status of this report. Status ReportStatusType - // A TestReportSummary object that contains information about this test report. + // 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 + // 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 - // A test report. + // The type of the report that was run. + // + // CODE_COVERAGE A code coverage report. + // + // TEST A test report. Type ReportType noSmithyDocumentSerde @@ -1713,23 +2050,26 @@ type Report struct { // Information about the location where the run of a report is exported. type ReportExportConfig struct { - // The export configuration type. Valid values are: + // 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. ExportConfigType ReportExportConfigType - // A S3ReportExportConfig object that contains information about the S3 bucket + // A S3ReportExportConfig object that contains information about the S3 bucket // where the run of a report is exported. S3Destination *S3ReportExportConfig noSmithyDocumentSerde } -// A filter used to return reports with the status specified by the input status +// A filter used to return reports with the status specified by the input status +// // parameter. type ReportFilter struct { - // The status used to filter reports. You can filter using one status only. + // The status used to filter reports. You can filter using one status only. Status ReportStatusType noSmithyDocumentSerde @@ -1757,19 +2097,26 @@ type ReportGroup struct { // The name of the ReportGroup . Name *string - // The status of the report group. This property is read-only. This can be one of - // the following values: ACTIVE The report group is active. DELETING The report - // group is in the process of being deleted. + // The status of the report group. This property is read-only. + // + // This can be one of the following values: + // + // ACTIVE The report group is active. + // + // DELETING The report group is in the process of being deleted. Status ReportGroupStatusType - // A list of tag key and value pairs associated with this report group. These tags - // are available for use by Amazon Web Services services that support CodeBuild - // report group tags. + // A list of tag key and value pairs associated with this report group. + // + // These tags are available for use by Amazon Web Services services that support + // CodeBuild report group tags. Tags []Tag // 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. + // + // CODE_COVERAGE The report group contains code coverage reports. + // + // TEST The report group contains test reports. Type ReportType noSmithyDocumentSerde @@ -1823,7 +2170,9 @@ 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. // // This member is required. @@ -1832,28 +2181,39 @@ type S3LogsConfig struct { // Specifies the bucket owner's access for objects that another account uploads to // their Amazon S3 bucket. By default, only the account that uploads the objects to // the bucket has access to these objects. This property allows you to give the - // bucket owner access to these objects. To use this property, your CodeBuild - // service role must have the s3:PutBucketAcl permission. This permission allows - // CodeBuild to modify the access control list for the bucket. This property can be - // one of the following values: NONE The bucket owner does not have access to the - // objects. This is the default. READ_ONLY The bucket owner has read-only access to - // 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: + // bucket owner access to these objects. + // + // To use this property, your CodeBuild service role must have the s3:PutBucketAcl + // permission. This permission allows CodeBuild to modify the access control list + // for the bucket. + // + // This property can be one of the following values: + // + // NONE The bucket owner does not have access to the objects. This is the default. + // + // READ_ONLY The bucket owner has read-only access to 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) - // in the Amazon Simple Storage Service User Guide. + // + // For more information about Amazon S3 object ownership, see [Controlling ownership of uploaded objects using S3 Object Ownership] in the Amazon + // Simple Storage Service User Guide. + // + // [Controlling ownership of uploaded objects using S3 Object Ownership]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html BucketOwnerAccess BucketOwnerAccess - // Set to true if you do not want your S3 build log output encrypted. By default + // 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 + // 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 . Location *string @@ -1864,7 +2224,7 @@ type S3LogsConfig struct { // Information about the S3 bucket where the raw data of a report are exported. type S3ReportExportConfig struct { - // The name of the S3 bucket where the raw data of a report are exported. + // 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 @@ -1872,19 +2232,21 @@ type S3ReportExportConfig struct { // 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. + // A boolean value that specifies if the results of a report are encrypted. EncryptionDisabled *bool - // The encryption key for the report's encrypted raw data. + // The encryption key for the report's encrypted raw data. EncryptionKey *string - // The type of build output artifact to create. Valid values include: + // 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. Packaging ReportPackagingType - // The path to the exported report's raw data results. + // The path to the exported report's raw data results. Path *string noSmithyDocumentSerde @@ -1924,8 +2286,10 @@ type ScalingConfigurationOutput struct { } // Information about the authorization settings for CodeBuild to access the source -// code to be built. This information is for the CodeBuild console's use only. Your -// code should not get or set this information directly. +// code to be built. +// +// This information is for the CodeBuild console's use only. Your code should not +// get or set this information directly. type SourceAuth struct { // The authorization type to use. Valid options are OAUTH or CODECONNECTIONS. @@ -1939,14 +2303,15 @@ type SourceAuth struct { noSmithyDocumentSerde } -// Information about the credentials for a GitHub, GitHub Enterprise, GitLab, +// Information about the credentials for a GitHub, GitHub Enterprise, GitLab, +// // GitLab Self Managed, or Bitbucket repository. type SourceCredentialsInfo struct { - // The Amazon Resource Name (ARN) of the token. + // The Amazon Resource Name (ARN) of the token. Arn *string - // The type of authentication used by the credentials. Valid options are OAUTH, + // The type of authentication used by the credentials. Valid options are OAUTH, // BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS. AuthType AuthType @@ -1954,15 +2319,17 @@ type SourceCredentialsInfo struct { // your authType is CODECONNECTIONS. Resource *string - // The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, + // The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, // GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET. ServerType ServerType noSmithyDocumentSerde } -// A tag, consisting of a key and a value. This tag is available for use by Amazon -// Web Services services that support tags in CodeBuild. +// A tag, consisting of a key and a value. +// +// This tag is available for use by Amazon Web Services services that support tags +// in CodeBuild. type Tag struct { // The tag's key. @@ -1986,36 +2353,38 @@ type TargetTrackingScalingConfiguration struct { noSmithyDocumentSerde } -// Information about a test case created using a framework such as NUnit or +// Information about a test case created using a framework such as NUnit or +// // Cucumber. A test case might be a unit test or a configuration test. type TestCase struct { - // The number of nanoseconds it took to run this test case. + // The number of nanoseconds it took to run this test case. DurationInNanoSeconds *int64 - // The date and time a test case expires. A test case expires 30 days after it is + // The date and time a test case expires. A test case expires 30 days after it is // created. An expired test case is not available to view in CodeBuild. Expired *time.Time - // A message associated with a test case. For example, an error message or stack + // A message associated with a test case. For example, an error message or stack // trace. Message *string - // The name of the test case. + // The name of the test case. Name *string - // A string that is applied to a series of related test cases. CodeBuild generates - // the prefix. The prefix depends on the framework used to generate the tests. + // A string that is applied to a series of related test cases. CodeBuild + // generates the prefix. The prefix depends on the framework used to generate the + // tests. Prefix *string - // The ARN of the report to which the test case belongs. + // The ARN of the report to which the test case belongs. ReportArn *string - // The status returned by the test case after it was run. Valid statuses are + // The status returned by the test case after it was run. Valid statuses are // SUCCEEDED , FAILED , ERROR , SKIPPED , and UNKNOWN . Status *string - // The path to the raw data file that contains the test result. + // The path to the raw data file that contains the test result. TestRawDataPath *string noSmithyDocumentSerde @@ -2032,10 +2401,15 @@ type TestCaseFilter struct { // The status used to filter test cases. A TestCaseFilter can have one status. // Valid values are: + // // - SUCCEEDED + // // - FAILED + // // - ERROR + // // - SKIPPED + // // - UNKNOWN Status *string @@ -2045,18 +2419,18 @@ type TestCaseFilter struct { // Information about a test report. type TestReportSummary struct { - // The number of nanoseconds it took to run all of the test cases in this report. + // The number of nanoseconds it took to run all of the test cases in this report. // // This member is required. DurationInNanoSeconds *int64 - // A map that contains the number of each type of status returned by the test + // A map that contains the number of each type of status returned by the test // results in this TestReportSummary . // // This member is required. StatusCounts map[string]int32 - // The number of test cases in this TestReportSummary . The total includes + // The number of test cases in this TestReportSummary . The total includes // truncated test cases. // // This member is required. @@ -2086,8 +2460,9 @@ 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 . + // then it is built. If branchFilter is empty, then all branches are built. + // + // It is recommended that you use filterGroups instead of branchFilter . BranchFilter *string // Specifies the type of build this webhook will trigger. @@ -2095,9 +2470,10 @@ type Webhook struct { // 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. + // 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 @@ -2107,8 +2483,9 @@ type Webhook struct { // The CodeBuild endpoint where webhook events are sent. PayloadUrl *string - // The secret token of the associated repository. A Bitbucket webhook does not - // support secret . + // The secret token of the associated repository. + // + // A Bitbucket webhook does not support secret . Secret *string // The URL to the webhook. @@ -2120,68 +2497,100 @@ type Webhook struct { // A filter used to determine which webhooks trigger a build. type WebhookFilter struct { - // For a WebHookFilter that uses EVENT type, a comma-separated string that + // For a WebHookFilter that uses EVENT type, a comma-separated string that // specifies one or more events. For example, the webhook filter PUSH, // PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request - // created, and pull request updated events to trigger a build. For a WebHookFilter - // 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 . + // created, and pull request updated events to trigger a build. + // + // For a WebHookFilter 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 . // // This member is required. Pattern *string - // The type of webhook filter. There are nine webhook filter types: EVENT , + // The type of webhook filter. There are nine webhook filter types: EVENT , // ACTOR_ACCOUNT_ID , HEAD_REF , BASE_REF , FILE_PATH , COMMIT_MESSAGE , TAG_NAME , // RELEASE_NAME , and WORKFLOW_NAME . + // // - EVENT + // // - A webhook event triggers a build when the provided pattern matches one of // nine event types: PUSH , PULL_REQUEST_CREATED , PULL_REQUEST_UPDATED , // PULL_REQUEST_CLOSED , PULL_REQUEST_REOPENED , PULL_REQUEST_MERGED , RELEASED , // PRERELEASED , and WORKFLOW_JOB_QUEUED . 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. The RELEASED , PRERELEASED , and WORKFLOW_JOB_QUEUED work - // with GitHub only. + // updated events. + // + // The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The + // RELEASED , PRERELEASED , and WORKFLOW_JOB_QUEUED work with GitHub 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 Enterprise push, GitHub and - // GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request - // events. + // 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. + // 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. + // 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. + // 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. + // // - TAG_NAME + // // - A webhook triggers a build when the tag name of the release matches the - // regular expression pattern . Works with RELEASED and PRERELEASED events only. + // regular expression pattern . + // + // Works with RELEASED and PRERELEASED events only. + // // - RELEASE_NAME + // // - A webhook triggers a build when the release name matches the regular - // expression pattern . Works with RELEASED and PRERELEASED events only. + // expression pattern . + // + // Works with RELEASED and PRERELEASED events only. + // // - WORKFLOW_NAME + // // - A webhook triggers a build when the workflow name matches the regular - // expression pattern . Works with WORKFLOW_JOB_QUEUED events only. + // expression pattern . + // + // Works with WORKFLOW_JOB_QUEUED events only. // // This member is required. Type WebhookFilterType - // Used to indicate that the pattern determines which webhook events do not + // 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. diff --git a/service/codecatalyst/api_op_CreateAccessToken.go b/service/codecatalyst/api_op_CreateAccessToken.go index 375c1be1154..2cbb52f564d 100644 --- a/service/codecatalyst/api_op_CreateAccessToken.go +++ b/service/codecatalyst/api_op_CreateAccessToken.go @@ -17,8 +17,9 @@ import ( // access CodeCatalyst from resources that include integrated development // environments (IDEs) and Git-based source repositories. PATs represent you in // Amazon CodeCatalyst and you can manage them in your user settings.For more -// information, see Managing personal access tokens in Amazon CodeCatalyst (https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html) -// . +// information, see [Managing personal access tokens in Amazon CodeCatalyst]. +// +// [Managing personal access tokens in Amazon 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{} @@ -42,8 +43,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 ExpiresTime *time.Time noSmithyDocumentSerde @@ -57,8 +59,10 @@ 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]. If not specified, the default is + // one year from creation. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. ExpiresTime *time.Time diff --git a/service/codecatalyst/api_op_CreateDevEnvironment.go b/service/codecatalyst/api_op_CreateDevEnvironment.go index ba0acf03ec2..fff4d9f4a4e 100644 --- a/service/codecatalyst/api_op_CreateDevEnvironment.go +++ b/service/codecatalyst/api_op_CreateDevEnvironment.go @@ -13,10 +13,12 @@ import ( // Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development // environment that you can use to quickly work on the code stored in the source -// repositories of your project. When created in the Amazon CodeCatalyst console, -// by default a Dev Environment is configured to have a 2 core processor, 4GB of -// RAM, and 16GB of persistent storage. None of these defaults apply to a Dev -// Environment created programmatically. +// repositories of your project. +// +// When created in the Amazon CodeCatalyst console, by default a Dev Environment +// is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent +// storage. None of these defaults apply to a Dev Environment created +// programmatically. func (c *Client) CreateDevEnvironment(ctx context.Context, params *CreateDevEnvironmentInput, optFns ...func(*Options)) (*CreateDevEnvironmentOutput, error) { if params == nil { params = &CreateDevEnvironmentInput{} @@ -39,9 +41,10 @@ type CreateDevEnvironmentInput struct { // This member is required. InstanceType types.InstanceType - // Information about the amount of storage allocated to the Dev Environment. By - // default, a Dev Environment is configured to have 16GB of persistent storage when - // created from the Amazon CodeCatalyst console, but there is no default when + // Information about the amount of storage allocated to the Dev Environment. + // + // By default, a Dev Environment is configured to have 16GB of persistent storage + // when created from the Amazon CodeCatalyst console, but there is no default when // programmatically creating a Dev Environment. Valid values for persistent storage // are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64. // @@ -68,9 +71,10 @@ type CreateDevEnvironmentInput struct { ClientToken *string // Information about the integrated development environment (IDE) configured for a - // Dev Environment. An IDE is required to create a Dev Environment. For Dev - // Environment creation, this field contains configuration information and must be - // provided. + // Dev Environment. + // + // An IDE is required to create a Dev Environment. For Dev Environment creation, + // this field contains configuration information and must be provided. Ides []types.IdeConfiguration // The amount of time the Dev Environment will run without any activity detected diff --git a/service/codecatalyst/api_op_CreateSourceRepository.go b/service/codecatalyst/api_op_CreateSourceRepository.go index 716d2b34dbf..c39272d7ca4 100644 --- a/service/codecatalyst/api_op_CreateSourceRepository.go +++ b/service/codecatalyst/api_op_CreateSourceRepository.go @@ -31,8 +31,9 @@ func (c *Client) CreateSourceRepository(ctx context.Context, params *CreateSourc type CreateSourceRepositoryInput struct { // The name of the source repository. For more information about name - // requirements, see Quotas for source repositories (https://docs.aws.amazon.com/codecatalyst/latest/userguide/source-quotas.html) - // . + // requirements, see [Quotas for source repositories]. + // + // [Quotas for source repositories]: https://docs.aws.amazon.com/codecatalyst/latest/userguide/source-quotas.html // // This member is required. Name *string diff --git a/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go b/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go index d3b38cd1110..0331d1a9dd8 100644 --- a/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go +++ b/service/codecatalyst/api_op_CreateSourceRepositoryBranch.go @@ -11,9 +11,10 @@ import ( "time" ) -// Creates a branch in a specified source repository in Amazon CodeCatalyst. This -// API only creates a branch in a source repository hosted in Amazon CodeCatalyst. -// You cannot use this API to create a branch in a linked repository. +// Creates a branch in a specified source repository in Amazon CodeCatalyst. +// +// This API only creates a branch in a source repository hosted in Amazon +// CodeCatalyst. You cannot use this API to create a branch in a linked repository. func (c *Client) CreateSourceRepositoryBranch(ctx context.Context, params *CreateSourceRepositoryBranchInput, optFns ...func(*Options)) (*CreateSourceRepositoryBranchOutput, error) { if params == nil { params = &CreateSourceRepositoryBranchInput{} @@ -64,8 +65,9 @@ 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]. + // + // [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 0c8619d3ea0..1acabf1684b 100644 --- a/service/codecatalyst/api_op_DeleteAccessToken.go +++ b/service/codecatalyst/api_op_DeleteAccessToken.go @@ -30,8 +30,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 Amazon Web Services Builder ID in a space by calling - // ListAccessTokens . + // associated with your Amazon Web Services Builder ID in a space 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 e570785b0de..dab8272d5a0 100644 --- a/service/codecatalyst/api_op_DeleteDevEnvironment.go +++ b/service/codecatalyst/api_op_DeleteDevEnvironment.go @@ -29,7 +29,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_DeleteProject.go b/service/codecatalyst/api_op_DeleteProject.go index dab591f13bc..028e2185948 100644 --- a/service/codecatalyst/api_op_DeleteProject.go +++ b/service/codecatalyst/api_op_DeleteProject.go @@ -28,8 +28,7 @@ func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, type DeleteProjectInput struct { - // The name of the project in the space. To retrieve a list of project names, use - // ListProjects . + // The name of the project in the space. To retrieve a list of project names, use ListProjects. // // This member is required. Name *string diff --git a/service/codecatalyst/api_op_DeleteSpace.go b/service/codecatalyst/api_op_DeleteSpace.go index aaae13140d1..d94ad98f888 100644 --- a/service/codecatalyst/api_op_DeleteSpace.go +++ b/service/codecatalyst/api_op_DeleteSpace.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a space. Deleting a space cannot be undone. Additionally, since space -// names must be unique across Amazon CodeCatalyst, you cannot reuse names of -// deleted spaces. +// Deletes a space. +// +// Deleting a space cannot be undone. Additionally, since space names must be +// unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces. func (c *Client) DeleteSpace(ctx context.Context, params *DeleteSpaceInput, optFns ...func(*Options)) (*DeleteSpaceOutput, error) { if params == nil { params = &DeleteSpaceInput{} @@ -30,7 +31,7 @@ func (c *Client) DeleteSpace(ctx context.Context, params *DeleteSpaceInput, optF type DeleteSpaceInput struct { - // The name of the space. To retrieve a list of space names, use ListSpaces . + // The name of the space. To retrieve a list of space names, use ListSpaces. // // This member is required. Name *string diff --git a/service/codecatalyst/api_op_GetDevEnvironment.go b/service/codecatalyst/api_op_GetDevEnvironment.go index 1d5c5361e0c..f4879ab0c2a 100644 --- a/service/codecatalyst/api_op_GetDevEnvironment.go +++ b/service/codecatalyst/api_op_GetDevEnvironment.go @@ -32,8 +32,7 @@ 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 . + // view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments. // // This member is required. Id *string @@ -75,8 +74,9 @@ 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]. + // + // [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_GetSourceRepository.go b/service/codecatalyst/api_op_GetSourceRepository.go index 54a74acc340..86fb9ec56bb 100644 --- a/service/codecatalyst/api_op_GetSourceRepository.go +++ b/service/codecatalyst/api_op_GetSourceRepository.go @@ -50,15 +50,17 @@ type GetSourceRepositoryInput struct { type GetSourceRepositoryOutput 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. CreatedTime *time.Time // 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]. + // + // [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_GetSubscription.go b/service/codecatalyst/api_op_GetSubscription.go index 61dd3ef2e79..16b68d62f43 100644 --- a/service/codecatalyst/api_op_GetSubscription.go +++ b/service/codecatalyst/api_op_GetSubscription.go @@ -45,15 +45,17 @@ type GetSubscriptionOutput struct { AwsAccountName *string // The day and time the pending change will be applied to the space, in - // coordinated universal time (UTC) timestamp format as specified in RFC 3339 (https://www.rfc-editor.org/rfc/rfc3339#section-5.6) - // . + // coordinated universal time (UTC) timestamp format as specified in [RFC 3339]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 PendingSubscriptionStartTime *time.Time // The type of the billing plan that the space will be changed to at the start of // the next billing cycle. This applies only to changes that reduce the // functionality available for the space. Billing plan changes that increase - // functionality are applied immediately. For more information, see Pricing (https://codecatalyst.aws/explore/pricing) - // . + // functionality are applied immediately. For more information, see [Pricing]. + // + // [Pricing]: https://codecatalyst.aws/explore/pricing PendingSubscriptionType *string // The type of the billing plan for the space. diff --git a/service/codecatalyst/api_op_GetWorkflow.go b/service/codecatalyst/api_op_GetWorkflow.go index ea22e7594dd..ef6b8c0ebbb 100644 --- a/service/codecatalyst/api_op_GetWorkflow.go +++ b/service/codecatalyst/api_op_GetWorkflow.go @@ -30,7 +30,7 @@ func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optF type GetWorkflowInput struct { - // The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows . + // The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows. // // This member is required. Id *string @@ -51,7 +51,9 @@ type GetWorkflowInput struct { type GetWorkflowOutput struct { // The date and time the workflow 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. CreatedTime *time.Time @@ -67,7 +69,9 @@ type GetWorkflowOutput struct { Id *string // The date and time the workflow 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. LastUpdatedTime *time.Time @@ -83,9 +87,9 @@ type GetWorkflowOutput struct { ProjectName *string // The behavior to use when multiple workflows occur at the same time. For more - // information, see - // https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html (https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html) - // in the Amazon CodeCatalyst User Guide. + // information, see [https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html]in the Amazon CodeCatalyst User Guide. + // + // [https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html]: https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html // // This member is required. RunMode types.WorkflowRunMode diff --git a/service/codecatalyst/api_op_GetWorkflowRun.go b/service/codecatalyst/api_op_GetWorkflowRun.go index 2e22c051544..1af99b9f5fa 100644 --- a/service/codecatalyst/api_op_GetWorkflowRun.go +++ b/service/codecatalyst/api_op_GetWorkflowRun.go @@ -30,8 +30,7 @@ func (c *Client) GetWorkflowRun(ctx context.Context, params *GetWorkflowRunInput type GetWorkflowRunInput struct { - // The ID of the workflow run. To retrieve a list of workflow run IDs, use - // ListWorkflowRuns . + // The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns. // // This member is required. Id *string @@ -57,7 +56,9 @@ type GetWorkflowRunOutput struct { Id *string // The date and time the workflow run status 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) + // universal time (UTC) timestamp format as specified in [RFC 3339] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. LastUpdatedTime *time.Time @@ -73,7 +74,9 @@ type GetWorkflowRunOutput struct { SpaceName *string // The date and time the workflow run began, 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. StartTime *time.Time @@ -89,8 +92,9 @@ type GetWorkflowRunOutput struct { WorkflowId *string // The date and time the workflow run ended, 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 EndTime *time.Time // Information about the reasons for the status of the workflow run. diff --git a/service/codecatalyst/api_op_ListEventLogs.go b/service/codecatalyst/api_op_ListEventLogs.go index 21be4ad8e37..77a40416026 100644 --- a/service/codecatalyst/api_op_ListEventLogs.go +++ b/service/codecatalyst/api_op_ListEventLogs.go @@ -14,15 +14,17 @@ import ( // Retrieves a list of events that occurred during a specific time in a space. You // can use these events to audit user and system activity in a space. For more -// information, see Monitoring (https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-monitoring.html) -// in the Amazon CodeCatalyst User Guide. ListEventLogs guarantees events for the -// last 30 days in a given space. You can also view and retrieve a list of -// management events over the last 90 days for Amazon CodeCatalyst in the -// CloudTrail console by viewing Event history, or by creating a trail to create -// and maintain a record of events that extends past 90 days. For more information, -// see Working with CloudTrail Event History (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) -// and Working with CloudTrail trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-getting-started.html) -// . +// information, see [Monitoring]in the Amazon CodeCatalyst User Guide. +// +// ListEventLogs guarantees events for the last 30 days in a given space. You can +// also view and retrieve a list of management events over the last 90 days for +// Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by +// creating a trail to create and maintain a record of events that extends past 90 +// days. For more information, see [Working with CloudTrail Event History]and [Working with CloudTrail trails]. +// +// [Working with CloudTrail Event History]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html +// [Working with CloudTrail trails]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-getting-started.html +// [Monitoring]: https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-monitoring.html func (c *Client) ListEventLogs(ctx context.Context, params *ListEventLogsInput, optFns ...func(*Options)) (*ListEventLogsOutput, error) { if params == nil { params = &ListEventLogsInput{} @@ -41,8 +43,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. EndTime *time.Time @@ -53,8 +56,9 @@ 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]. + // + // [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_ListWorkflowRuns.go b/service/codecatalyst/api_op_ListWorkflowRuns.go index d9de373de2c..290c7504d4d 100644 --- a/service/codecatalyst/api_op_ListWorkflowRuns.go +++ b/service/codecatalyst/api_op_ListWorkflowRuns.go @@ -51,7 +51,7 @@ type ListWorkflowRunsInput struct { // Information used to sort the items in the returned list. SortBy []types.WorkflowRunSortCriteria - // The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows . + // The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows. WorkflowId *string noSmithyDocumentSerde diff --git a/service/codecatalyst/api_op_StartWorkflowRun.go b/service/codecatalyst/api_op_StartWorkflowRun.go index 0f3590b24e2..69774eb4363 100644 --- a/service/codecatalyst/api_op_StartWorkflowRun.go +++ b/service/codecatalyst/api_op_StartWorkflowRun.go @@ -39,7 +39,7 @@ type StartWorkflowRunInput struct { SpaceName *string // The system-generated unique ID of the workflow. To retrieve a list of workflow - // IDs, use ListWorkflows . + // IDs, use ListWorkflows. // // This member is required. WorkflowId *string diff --git a/service/codecatalyst/api_op_StopDevEnvironmentSession.go b/service/codecatalyst/api_op_StopDevEnvironmentSession.go index 6c575fdfe30..8e50eac3bfd 100644 --- a/service/codecatalyst/api_op_StopDevEnvironmentSession.go +++ b/service/codecatalyst/api_op_StopDevEnvironmentSession.go @@ -28,8 +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 . + // The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments. // // This member is required. Id *string @@ -40,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 5f1a39216b8..bd3c4ff59a7 100644 --- a/service/codecatalyst/api_op_UpdateDevEnvironment.go +++ b/service/codecatalyst/api_op_UpdateDevEnvironment.go @@ -61,12 +61,16 @@ type UpdateDevEnvironmentInput struct { // The amount of time the Dev Environment will run without any activity detected // before stopping, in minutes. Only whole integers are allowed. Dev Environments - // consume compute minutes when running. Changing this value will cause a restart - // of the Dev Environment if it is running. + // consume compute minutes when running. + // + // Changing this value will cause a restart of the Dev Environment if it is + // running. InactivityTimeoutMinutes int32 - // The Amazon EC2 instace type to use for the Dev Environment. Changing this value - // will cause a restart of the Dev Environment if it is running. + // The Amazon EC2 instace type to use for the Dev Environment. + // + // Changing this value will cause a restart of the Dev Environment if it is + // running. InstanceType types.InstanceType noSmithyDocumentSerde diff --git a/service/codecatalyst/doc.go b/service/codecatalyst/doc.go index ee4236ff66a..9bc69dad67d 100644 --- a/service/codecatalyst/doc.go +++ b/service/codecatalyst/doc.go @@ -5,82 +5,140 @@ // // Welcome to the Amazon CodeCatalyst API reference. This reference provides // descriptions of operations and data types for Amazon CodeCatalyst. You can use -// the Amazon CodeCatalyst API to work with the following objects. Spaces, by -// calling the following: -// - DeleteSpace , which deletes a space. -// - GetSpace , which returns information about a space. -// - GetSubscription , which returns information about the Amazon Web Services -// account used for billing purposes and the billing plan for the space. -// - ListSpaces , which retrieves a list of spaces. -// - UpdateSpace , which changes one or more values for a space. +// the Amazon CodeCatalyst API to work with the following objects. +// +// Spaces, by calling the following: +// +// DeleteSpace +// - , which deletes a space. +// +// GetSpace +// - , which returns information about a space. +// +// GetSubscription +// - , which returns information about the Amazon Web Services account used for +// billing purposes and the billing plan for the space. +// +// ListSpaces +// - , which retrieves a list of spaces. +// +// UpdateSpace +// - , which changes one or more values for a space. // // Projects, by calling the following: -// - CreateProject which creates a project in a specified space. -// - GetProject , which returns information about a project. -// - ListProjects , which retrieves a list of projects in a space. +// +// CreateProject +// - which creates a project in a specified space. +// +// GetProject +// - , which returns information about a project. +// +// ListProjects +// - , which retrieves a list of projects in a space. // // Users, by calling the following: -// - GetUserDetails , which returns information about a user in Amazon -// CodeCatalyst. +// +// GetUserDetails +// - , which returns information about a user in Amazon CodeCatalyst. // // Source repositories, by calling the following: -// - CreateSourceRepository , which creates an empty Git-based source repository -// in a specified project. -// - CreateSourceRepositoryBranch , which creates a branch in a specified -// repository where you can work on code. -// - DeleteSourceRepository , which deletes a source repository. -// - GetSourceRepository , which returns information about a source repository. -// - GetSourceRepositoryCloneUrls , which returns information about the URLs that -// can be used with a Git client to clone a source repository. -// - ListSourceRepositories , which retrieves a list of source repositories in a -// project. -// - ListSourceRepositoryBranches , which retrieves a list of branches in a -// source repository. -// -// Dev Environments and the Amazon Web Services Toolkits, by calling the -// following: -// - CreateDevEnvironment , which creates a Dev Environment, where you can -// quickly work on the code stored in the source repositories of your project. -// - DeleteDevEnvironment , which deletes a Dev Environment. -// - GetDevEnvironment , which returns information about a Dev Environment. -// - ListDevEnvironments , which retrieves a list of Dev Environments in a -// project. -// - ListDevEnvironmentSessions , which retrieves a list of active Dev -// Environment sessions in a project. -// - 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. +// +// CreateSourceRepository +// - , which creates an empty Git-based source repository in a specified project. +// +// CreateSourceRepositoryBranch +// - , which creates a branch in a specified repository where you can work on +// code. +// +// DeleteSourceRepository +// - , which deletes a source repository. +// +// GetSourceRepository +// - , which returns information about a source repository. +// +// GetSourceRepositoryCloneUrls +// - , which returns information about the URLs that can be used with a Git +// client to clone a source repository. +// +// ListSourceRepositories +// - , which retrieves a list of source repositories in a project. +// +// ListSourceRepositoryBranches +// - , which retrieves a list of branches in a source repository. +// +// Dev Environments and the Amazon Web Services Toolkits, by calling the following: +// +// CreateDevEnvironment +// - , which creates a Dev Environment, where you can quickly work on the code +// stored in the source repositories of your project. +// +// DeleteDevEnvironment +// - , which deletes a Dev Environment. +// +// GetDevEnvironment +// - , which returns information about a Dev Environment. +// +// ListDevEnvironments +// - , which retrieves a list of Dev Environments in a project. +// +// ListDevEnvironmentSessions +// - , which retrieves a list of active Dev Environment sessions in a project. +// +// 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. // // Workflows, by calling the following: -// - GetWorkflow , which returns information about a workflow. -// - GetWorkflowRun , which returns information about a specified run of a -// workflow. -// - ListWorkflowRuns , which retrieves a list of runs of a specified workflow. -// - ListWorkflows , which retrieves a list of workflows in a specified project. -// - StartWorkflowRun , which starts a run of a specified workflow. +// +// GetWorkflow +// - , which returns information about a workflow. +// +// GetWorkflowRun +// - , which returns information about a specified run of a workflow. +// +// ListWorkflowRuns +// - , which retrieves a list of runs of a specified workflow. +// +// ListWorkflows +// - , which retrieves a list of workflows in a specified project. +// +// StartWorkflowRun +// - , which starts a run of a specified workflow. // // Security, activity, and resource management in Amazon CodeCatalyst, by calling // the following: -// - CreateAccessToken , which creates a personal access token (PAT) for the -// current user. -// - 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. -// - VerifySession , which verifies whether the calling user has a valid Amazon -// CodeCatalyst login and session. +// +// CreateAccessToken +// - , which creates a personal access token (PAT) for the current user. +// +// 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. +// +// VerifySession +// - , which verifies whether the calling user has a valid Amazon CodeCatalyst +// login and session. // // If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must // configure your computer to work with Amazon CodeCatalyst and single sign-on -// (SSO). For more information, see Setting up to use the CLI with Amazon -// CodeCatalyst (https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html) -// and the SSO documentation for your SDK. +// (SSO). For more information, see [Setting up to use the CLI with Amazon CodeCatalyst]and the SSO documentation for your SDK. +// +// [Setting up to use the CLI with Amazon CodeCatalyst]: https://docs.aws.amazon.com/codecatalyst/latest/userguide/set-up-cli.html package codecatalyst diff --git a/service/codecatalyst/options.go b/service/codecatalyst/options.go index 742da5bef2f..0fd5d7c519c 100644 --- a/service/codecatalyst/options.go +++ b/service/codecatalyst/options.go @@ -52,8 +52,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -73,17 +75,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -100,8 +105,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -146,6 +152,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codecatalyst/types/enums.go b/service/codecatalyst/types/enums.go index 233b298fecd..043847f1f06 100644 --- a/service/codecatalyst/types/enums.go +++ b/service/codecatalyst/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQ", @@ -38,6 +39,7 @@ const ( // Values returns all known values for DevEnvironmentSessionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DevEnvironmentSessionType) Values() []DevEnvironmentSessionType { return []DevEnvironmentSessionType{ @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for DevEnvironmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DevEnvironmentStatus) Values() []DevEnvironmentStatus { return []DevEnvironmentStatus{ "PENDING", @@ -85,8 +88,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -105,8 +109,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -125,8 +130,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "READONLY", @@ -144,8 +150,9 @@ const ( ) // Values returns all known values for UserType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserType) Values() []UserType { return []UserType{ "USER", @@ -164,8 +171,9 @@ const ( ) // Values returns all known values for WorkflowRunMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowRunMode) Values() []WorkflowRunMode { return []WorkflowRunMode{ "QUEUED", @@ -192,8 +200,9 @@ const ( ) // Values returns all known values for WorkflowRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowRunStatus) Values() []WorkflowRunStatus { return []WorkflowRunStatus{ "SUCCEEDED", @@ -219,8 +228,9 @@ const ( ) // Values returns all known values for WorkflowStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStatus) Values() []WorkflowStatus { return []WorkflowStatus{ "INVALID", diff --git a/service/codecatalyst/types/types.go b/service/codecatalyst/types/types.go index 21019caa623..215ddf7d8d4 100644 --- a/service/codecatalyst/types/types.go +++ b/service/codecatalyst/types/types.go @@ -21,8 +21,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 ExpiresTime *time.Time noSmithyDocumentSerde @@ -98,7 +99,9 @@ type DevEnvironmentSessionSummary struct { SpaceName *string // The date and time the session started, 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. StartedTime *time.Time @@ -132,8 +135,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. LastUpdatedTime *time.Time @@ -209,8 +213,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. EventTime *time.Time @@ -328,7 +333,9 @@ type IdeConfiguration struct { // 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 @@ -338,8 +345,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. CreatedTime *time.Time @@ -350,8 +358,9 @@ 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. LastUpdatedTime *time.Time @@ -376,8 +385,9 @@ type ListSourceRepositoryBranchesItem 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 LastUpdatedTime *time.Time // The name of the branch. @@ -392,9 +402,10 @@ 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 @@ -402,12 +413,14 @@ type PersistentStorage struct { noSmithyDocumentSerde } -// Information about the configuration of persistent storage for a Dev Environment. +// 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 @@ -567,14 +580,17 @@ type WorkflowRunSummary struct { Id *string // The date and time the workflow 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. LastUpdatedTime *time.Time // The date and time the workflow run began, 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]. + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. StartTime *time.Time @@ -595,7 +611,9 @@ type WorkflowRunSummary struct { WorkflowName *string // The date and time the workflow run ended, 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 EndTime *time.Time // The reasons for the workflow run status. @@ -613,7 +631,9 @@ type WorkflowSortCriteria struct { type WorkflowSummary struct { // The date and time the workflow 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. CreatedTime *time.Time @@ -629,7 +649,9 @@ type WorkflowSummary struct { Id *string // The date and time the workflow 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] + // + // [RFC 3339]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6 // // This member is required. LastUpdatedTime *time.Time diff --git a/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go b/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go index 3596aa6708e..1603fe166cb 100644 --- a/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go +++ b/service/codecommit/api_op_BatchAssociateApprovalRuleTemplateWithRepositories.go @@ -35,9 +35,10 @@ type BatchAssociateApprovalRuleTemplateWithRepositoriesInput struct { // This member is required. ApprovalRuleTemplateName *string - // The names of the repositories you want to associate with the template. The - // length constraint limit is for each string in the array. The array itself can be - // empty. + // The names of the repositories you want to associate with the template. + // + // The length constraint limit is for each string in the array. The array itself + // can be empty. // // This member is required. RepositoryNames []string diff --git a/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go b/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go index 483f0123a3f..423b5b4ae52 100644 --- a/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go +++ b/service/codecommit/api_op_BatchDisassociateApprovalRuleTemplateFromRepositories.go @@ -37,8 +37,10 @@ type BatchDisassociateApprovalRuleTemplateFromRepositoriesInput struct { ApprovalRuleTemplateName *string // The repository names that you want to disassociate from the approval rule - // template. The length constraint limit is for each string in the array. The array - // itself can be empty. + // template. + // + // The length constraint limit is for each string in the array. The array itself + // can be empty. // // This member is required. RepositoryNames []string diff --git a/service/codecommit/api_op_BatchGetCommits.go b/service/codecommit/api_op_BatchGetCommits.go index 0f7f26d98f0..e6b9a30f01b 100644 --- a/service/codecommit/api_op_BatchGetCommits.go +++ b/service/codecommit/api_op_BatchGetCommits.go @@ -29,8 +29,10 @@ 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 diff --git a/service/codecommit/api_op_BatchGetRepositories.go b/service/codecommit/api_op_BatchGetRepositories.go index d6223c275c6..2c1d69961ce 100644 --- a/service/codecommit/api_op_BatchGetRepositories.go +++ b/service/codecommit/api_op_BatchGetRepositories.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about one or more repositories. The description field for a -// repository accepts all HTML characters and all valid Unicode characters. -// Applications that do not HTML-encode the description and display it in a webpage -// can expose users to potentially malicious code. Make sure that you HTML-encode -// the description field in any application that uses this API to display the -// repository description on a webpage. +// Returns information about one or more repositories. +// +// The description field for a repository accepts all HTML characters and all +// valid Unicode characters. Applications that do not HTML-encode the description +// and display it in a webpage can expose users to potentially malicious code. Make +// sure that you HTML-encode the description field in any application that uses +// this API to display the repository description on a webpage. func (c *Client) BatchGetRepositories(ctx context.Context, params *BatchGetRepositoriesInput, optFns ...func(*Options)) (*BatchGetRepositoriesOutput, error) { if params == nil { params = &BatchGetRepositoriesInput{} @@ -35,8 +36,10 @@ func (c *Client) BatchGetRepositories(ctx context.Context, params *BatchGetRepos // Represents the input of a batch get repositories operation. type BatchGetRepositoriesInput struct { - // The names of the repositories to get information about. The length constraint - // limit is for each string in the array. The array itself can be empty. + // The names of the repositories to get information about. + // + // The length constraint limit is for each string in the array. The array itself + // can be empty. // // This member is required. RepositoryNames []string diff --git a/service/codecommit/api_op_CreateApprovalRuleTemplate.go b/service/codecommit/api_op_CreateApprovalRuleTemplate.go index 639c83d145c..7bfff33b531 100644 --- a/service/codecommit/api_op_CreateApprovalRuleTemplate.go +++ b/service/codecommit/api_op_CreateApprovalRuleTemplate.go @@ -15,7 +15,7 @@ import ( // more repositories in your Amazon Web Services account. When you associate a // template with a repository, 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 . +// template. For more information, see AssociateApprovalRuleTemplateWithRepository. func (c *Client) CreateApprovalRuleTemplate(ctx context.Context, params *CreateApprovalRuleTemplateInput, optFns ...func(*Options)) (*CreateApprovalRuleTemplateOutput, error) { if params == nil { params = &CreateApprovalRuleTemplateInput{} @@ -36,26 +36,35 @@ type CreateApprovalRuleTemplateInput struct { // The content of the approval rule that is created on pull requests in associated // repositories. If you specify one or more destination references (branches), // approval rules are created in an associated repository only if their destination - // 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: + // 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 Amazon Web Services // 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 // Amazon Web Services 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: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. + // + // For more information about IAM ARNs, wildcards, and formats, see [IAM Identifiers] in the IAM + // User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. ApprovalRuleTemplateContent *string diff --git a/service/codecommit/api_op_CreateBranch.go b/service/codecommit/api_op_CreateBranch.go index 2bd9c4bf2cf..3ce2c0bad14 100644 --- a/service/codecommit/api_op_CreateBranch.go +++ b/service/codecommit/api_op_CreateBranch.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a branch in a repository and points the branch to a commit. Calling the -// create branch operation does not set a repository's default branch. To do this, -// call the update default branch operation. +// Creates a branch in a repository and points the branch to a commit. +// +// Calling the create branch operation does not set a repository's default branch. +// To do this, call the update default branch operation. func (c *Client) CreateBranch(ctx context.Context, params *CreateBranchInput, optFns ...func(*Options)) (*CreateBranchOutput, error) { if params == nil { params = &CreateBranchInput{} diff --git a/service/codecommit/api_op_CreatePullRequest.go b/service/codecommit/api_op_CreatePullRequest.go index 21fcd1b0493..146c2c7261d 100644 --- a/service/codecommit/api_op_CreatePullRequest.go +++ b/service/codecommit/api_op_CreatePullRequest.go @@ -46,9 +46,10 @@ type CreatePullRequestInput struct { // A unique, client-generated idempotency token that, when provided in a request, // ensures the request cannot be repeated with a changed parameter. If a request is // received with the same parameters and a token is included, the request returns - // information about the initial request that used that token. The Amazon Web - // ServicesSDKs prepopulate client request tokens. If you are using an Amazon Web - // ServicesSDK, an idempotency token is created for you. + // information about the initial request that used that token. + // + // The Amazon Web ServicesSDKs prepopulate client request tokens. If you are using + // an Amazon Web ServicesSDK, an idempotency token is created for you. ClientRequestToken *string // A description of the pull request. diff --git a/service/codecommit/api_op_CreatePullRequestApprovalRule.go b/service/codecommit/api_op_CreatePullRequestApprovalRule.go index ecf98fb333b..50ad50d9a34 100644 --- a/service/codecommit/api_op_CreatePullRequestApprovalRule.go +++ b/service/codecommit/api_op_CreatePullRequestApprovalRule.go @@ -31,26 +31,35 @@ type CreatePullRequestApprovalRuleInput struct { // The content of the approval rule, including the number of approvals needed and // the structure of an approval pool defined for approvals, if any. For more - // information about approval pools, see the 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: + // information about approval pools, see the 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 Amazon Web Services // 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 // Amazon Web Services 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: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. + // + // For more information about IAM ARNs, wildcards, and formats, see [IAM Identifiers] in the IAM + // User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. ApprovalRuleContent *string diff --git a/service/codecommit/api_op_CreateRepository.go b/service/codecommit/api_op_CreateRepository.go index 0c0ec34ff0b..af3503449db 100644 --- a/service/codecommit/api_op_CreateRepository.go +++ b/service/codecommit/api_op_CreateRepository.go @@ -30,30 +30,37 @@ 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 Amazon Web Services 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 Quotas (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) - // in the CodeCommit User Guide. The suffix .git is prohibited. + // The name of the new repository to be created. + // + // The repository name must be unique across the calling Amazon Web Services + // 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 [Quotas]in the CodeCommit User Guide. The suffix + // .git is prohibited. + // + // [Quotas]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html // // This member is required. RepositoryName *string // The ID of the encryption key. You can view the ID of an encryption key in the // KMS console, or use the KMS APIs to programmatically retrieve a key ID. For more - // information about acceptable values for kmsKeyID, see KeyId (https://docs.aws.amazon.com/APIReference/API_Decrypt.html#KMS-Decrypt-request-KeyId) - // in the Decrypt API description in the Key Management Service API Reference. If - // no key is specified, the default aws/codecommit Amazon Web Services managed key - // is used. + // information about acceptable values for kmsKeyID, see [KeyId]in the Decrypt API + // description in the Key Management Service API Reference. + // + // If no key is specified, the default aws/codecommit Amazon Web Services managed + // key is used. + // + // [KeyId]: https://docs.aws.amazon.com/APIReference/API_Decrypt.html#KMS-Decrypt-request-KeyId KmsKeyId *string - // A comment or description about the new repository. The description field for a - // repository accepts all HTML characters and all valid Unicode characters. - // Applications that do not HTML-encode the description and display it in a webpage - // can expose users to potentially malicious code. Make sure that you HTML-encode - // the description field in any application that uses this API to display the - // repository description on a webpage. + // A comment or description about the new repository. + // + // The description field for a repository accepts all HTML characters and all + // valid Unicode characters. Applications that do not HTML-encode the description + // and display it in a webpage can expose users to potentially malicious code. Make + // sure that you HTML-encode the description field in any application that uses + // this API to display the repository description on a webpage. RepositoryDescription *string // One or more tag key-value pairs to use when tagging this repository. diff --git a/service/codecommit/api_op_CreateUnreferencedMergeCommit.go b/service/codecommit/api_op_CreateUnreferencedMergeCommit.go index b2164fbbcb4..77e06563d71 100644 --- a/service/codecommit/api_op_CreateUnreferencedMergeCommit.go +++ b/service/codecommit/api_op_CreateUnreferencedMergeCommit.go @@ -14,8 +14,9 @@ import ( // Creates an unreferenced commit that represents the result of merging two // branches using a specified merge strategy. This can help you determine the // outcome of a potential merge. This API cannot be used with the fast-forward -// merge strategy because that strategy does not create a merge commit. This -// unreferenced merge commit can only be accessed using the GetCommit API or +// merge strategy because that strategy does not create a merge commit. +// +// This unreferenced merge commit can only be accessed using the GetCommit API or // through git commands such as git fetch. To retrieve this commit, you must // specify its commit ID or otherwise reference it. func (c *Client) CreateUnreferencedMergeCommit(ctx context.Context, params *CreateUnreferencedMergeCommitInput, optFns ...func(*Options)) (*CreateUnreferencedMergeCommitOutput, error) { diff --git a/service/codecommit/api_op_DeleteCommentContent.go b/service/codecommit/api_op_DeleteCommentContent.go index 6adaa6c439b..86da1035f2f 100644 --- a/service/codecommit/api_op_DeleteCommentContent.go +++ b/service/codecommit/api_op_DeleteCommentContent.go @@ -30,8 +30,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 . + // The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. // // This member is required. CommentId *string diff --git a/service/codecommit/api_op_DeletePullRequestApprovalRule.go b/service/codecommit/api_op_DeletePullRequestApprovalRule.go index 5daf51b400b..f9cb08a3dec 100644 --- a/service/codecommit/api_op_DeletePullRequestApprovalRule.go +++ b/service/codecommit/api_op_DeletePullRequestApprovalRule.go @@ -49,8 +49,10 @@ type DeletePullRequestApprovalRuleInput struct { type DeletePullRequestApprovalRuleOutput struct { - // The ID of the deleted approval rule. If the approval rule was deleted in an - // earlier API call, the response is 200 OK without content. + // The ID of the deleted approval rule. + // + // If the approval rule was deleted in an earlier API call, the response is 200 OK + // without content. // // This member is required. ApprovalRuleId *string diff --git a/service/codecommit/api_op_DeleteRepository.go b/service/codecommit/api_op_DeleteRepository.go index a79b2fc832f..2886c23146a 100644 --- a/service/codecommit/api_op_DeleteRepository.go +++ b/service/codecommit/api_op_DeleteRepository.go @@ -11,9 +11,10 @@ import ( ) // Deletes a repository. If a specified repository was already deleted, a null -// repository ID is returned. Deleting a repository also deletes all associated -// objects and metadata. After a repository is deleted, all future push calls to -// the deleted repository fail. +// repository ID is returned. +// +// Deleting a repository also deletes all associated objects and metadata. After a +// repository is deleted, all future push calls to the deleted repository fail. func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryInput, optFns ...func(*Options)) (*DeleteRepositoryOutput, error) { if params == nil { params = &DeleteRepositoryInput{} diff --git a/service/codecommit/api_op_DescribePullRequestEvents.go b/service/codecommit/api_op_DescribePullRequestEvents.go index 9f5cf5246fa..507e26ada9e 100644 --- a/service/codecommit/api_op_DescribePullRequestEvents.go +++ b/service/codecommit/api_op_DescribePullRequestEvents.go @@ -29,8 +29,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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go b/service/codecommit/api_op_EvaluatePullRequestApprovalRules.go index f65d6a2c945..fcfeb41b81f 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 ab37f165b49..f1ac932b9c3 100644 --- a/service/codecommit/api_op_GetComment.go +++ b/service/codecommit/api_op_GetComment.go @@ -12,9 +12,11 @@ import ( ) // Returns the content of a comment made on a change, file, or commit in a -// repository. Reaction counts might include numbers from user identities who were -// deleted after the reaction was made. For a count of reactions from active -// identities, use GetCommentReactions. +// repository. +// +// Reaction counts might include numbers from user identities who were deleted +// after the reaction was made. For a count of reactions from active identities, +// use GetCommentReactions. func (c *Client) GetComment(ctx context.Context, params *GetCommentInput, optFns ...func(*Options)) (*GetCommentOutput, error) { if params == nil { params = &GetCommentInput{} @@ -32,8 +34,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 . + // The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest. // // This member is required. CommentId *string diff --git a/service/codecommit/api_op_GetCommentsForComparedCommit.go b/service/codecommit/api_op_GetCommentsForComparedCommit.go index b867e8efcba..713c40680f3 100644 --- a/service/codecommit/api_op_GetCommentsForComparedCommit.go +++ b/service/codecommit/api_op_GetCommentsForComparedCommit.go @@ -12,6 +12,7 @@ import ( ) // Returns information about comments made on the comparison between two commits. +// // Reaction counts might include numbers from user identities who were deleted // after the reaction was made. For a count of reactions from active identities, // use GetCommentReactions. diff --git a/service/codecommit/api_op_GetCommentsForPullRequest.go b/service/codecommit/api_op_GetCommentsForPullRequest.go index e64bc484d48..eb053cd21ec 100644 --- a/service/codecommit/api_op_GetCommentsForPullRequest.go +++ b/service/codecommit/api_op_GetCommentsForPullRequest.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns comments made on a pull request. Reaction counts might include numbers -// from user identities who were deleted after the reaction was made. For a count -// of reactions from active identities, use GetCommentReactions. +// Returns comments made on a pull request. +// +// Reaction counts might include numbers from user identities who were deleted +// after the reaction was made. For a count of reactions from active identities, +// use GetCommentReactions. func (c *Client) GetCommentsForPullRequest(ctx context.Context, params *GetCommentsForPullRequestInput, optFns ...func(*Options)) (*GetCommentsForPullRequestOutput, error) { if params == nil { params = &GetCommentsForPullRequestInput{} @@ -31,8 +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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_GetFile.go b/service/codecommit/api_op_GetFile.go index 441b02e2a3d..5ee15485060 100644 --- a/service/codecommit/api_op_GetFile.go +++ b/service/codecommit/api_op_GetFile.go @@ -67,9 +67,11 @@ type GetFileOutput struct { 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. + // 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_GetPullRequest.go b/service/codecommit/api_op_GetPullRequest.go index 5c4744d3d63..a29ade618ff 100644 --- a/service/codecommit/api_op_GetPullRequest.go +++ b/service/codecommit/api_op_GetPullRequest.go @@ -29,8 +29,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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_GetPullRequestOverrideState.go b/service/codecommit/api_op_GetPullRequestOverrideState.go index 215465522e9..7062d332cf1 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_GetRepository.go b/service/codecommit/api_op_GetRepository.go index cc6de32178a..9cdb2c19002 100644 --- a/service/codecommit/api_op_GetRepository.go +++ b/service/codecommit/api_op_GetRepository.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a repository. The description field for a repository -// accepts all HTML characters and all valid Unicode characters. Applications that -// do not HTML-encode the description and display it in a webpage can expose users -// to potentially malicious code. Make sure that you HTML-encode the description -// field in any application that uses this API to display the repository -// description on a webpage. +// Returns information about a repository. +// +// The description field for a repository accepts all HTML characters and all +// valid Unicode characters. Applications that do not HTML-encode the description +// and display it in a webpage can expose users to potentially malicious code. Make +// sure that you HTML-encode the description field in any application that uses +// this API to display the repository description on a webpage. func (c *Client) GetRepository(ctx context.Context, params *GetRepositoryInput, optFns ...func(*Options)) (*GetRepositoryOutput, error) { if params == nil { params = &GetRepositoryInput{} diff --git a/service/codecommit/api_op_ListTagsForResource.go b/service/codecommit/api_op_ListTagsForResource.go index ae0987b9a08..99013829ee9 100644 --- a/service/codecommit/api_op_ListTagsForResource.go +++ b/service/codecommit/api_op_ListTagsForResource.go @@ -11,9 +11,10 @@ import ( ) // Gets information about Amazon Web Servicestags for a specified Amazon Resource -// Name (ARN) in CodeCommit. For a list of valid resources in 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 CodeCommit User Guide. +// Name (ARN) in CodeCommit. For a list of valid resources in CodeCommit, see [CodeCommit Resources and Operations]in +// the CodeCommit User Guide. +// +// [CodeCommit Resources and Operations]: https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/codecommit/api_op_MergePullRequestByFastForward.go b/service/codecommit/api_op_MergePullRequestByFastForward.go index 0f61fd7f928..1b7f6f7f620 100644 --- a/service/codecommit/api_op_MergePullRequestByFastForward.go +++ b/service/codecommit/api_op_MergePullRequestByFastForward.go @@ -32,8 +32,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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_MergePullRequestBySquash.go b/service/codecommit/api_op_MergePullRequestBySquash.go index a2ec5468189..720809f824b 100644 --- a/service/codecommit/api_op_MergePullRequestBySquash.go +++ b/service/codecommit/api_op_MergePullRequestBySquash.go @@ -31,8 +31,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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_MergePullRequestByThreeWay.go b/service/codecommit/api_op_MergePullRequestByThreeWay.go index d7b97c8d4a9..5fbedb454bd 100644 --- a/service/codecommit/api_op_MergePullRequestByThreeWay.go +++ b/service/codecommit/api_op_MergePullRequestByThreeWay.go @@ -32,8 +32,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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_OverridePullRequestApprovalRules.go b/service/codecommit/api_op_OverridePullRequestApprovalRules.go index 26c1ff7e4a9..1ca95828724 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 fc688c1c33d..8b2b97a7ff2 100644 --- a/service/codecommit/api_op_PostCommentForPullRequest.go +++ b/service/codecommit/api_op_PostCommentForPullRequest.go @@ -46,8 +46,7 @@ type PostCommentForPullRequestInput struct { // This member is required. Content *string - // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_PostCommentReply.go b/service/codecommit/api_op_PostCommentReply.go index 96d4c37ea99..48cc0146411 100644 --- a/service/codecommit/api_op_PostCommentReply.go +++ b/service/codecommit/api_op_PostCommentReply.go @@ -36,7 +36,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 GetCommentsForComparedCommitor GetCommentsForPullRequest. // // This member is required. InReplyTo *string diff --git a/service/codecommit/api_op_PutCommentReaction.go b/service/codecommit/api_op_PutCommentReaction.go index 04f5ad3f20b..2d236387d2f 100644 --- a/service/codecommit/api_op_PutCommentReaction.go +++ b/service/codecommit/api_op_PutCommentReaction.go @@ -37,9 +37,9 @@ 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 CodeCommit, see the CodeCommit User - // Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#emoji-reaction-table) - // . + // about emoji reaction values supported in CodeCommit, see the [CodeCommit User Guide]. + // + // [CodeCommit 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 8513893902b..21763e46427 100644 --- a/service/codecommit/api_op_PutFile.go +++ b/service/codecommit/api_op_PutFile.go @@ -42,8 +42,10 @@ type PutFileInput struct { FileContent []byte // The name of the file you want to add or update, including the relative path to - // the file in the repository. If the path does not currently exist in the - // repository, the path is created as part of adding the file. + // the file in the repository. + // + // If the path does not currently exist in the repository, the path is created as + // part of adding the file. // // This member is required. FilePath *string @@ -70,9 +72,10 @@ type PutFileInput struct { // The full commit ID of the head commit in the branch where you want to add or // update the file. If this is an empty repository, no commit ID is required. If - // this is not an empty repository, a commit ID is required. The commit ID must - // match the ID of the head commit at the time of the operation. Otherwise, an - // error occurs, and the file is not added or updated. + // this is not an empty repository, a commit ID is required. + // + // The commit ID must match the ID of the head commit at the time of the + // operation. Otherwise, an error occurs, and the file is not added or updated. ParentCommitId *string noSmithyDocumentSerde diff --git a/service/codecommit/api_op_TagResource.go b/service/codecommit/api_op_TagResource.go index e4532d8be0a..832fb091372 100644 --- a/service/codecommit/api_op_TagResource.go +++ b/service/codecommit/api_op_TagResource.go @@ -11,8 +11,9 @@ import ( ) // Adds or updates tags for a resource in CodeCommit. For a list of valid -// resources in 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 CodeCommit User Guide. +// resources in CodeCommit, see [CodeCommit Resources and Operations]in the CodeCommit User Guide. +// +// [CodeCommit Resources and Operations]: https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/codecommit/api_op_UntagResource.go b/service/codecommit/api_op_UntagResource.go index c955ff83952..73c62f43f56 100644 --- a/service/codecommit/api_op_UntagResource.go +++ b/service/codecommit/api_op_UntagResource.go @@ -11,8 +11,9 @@ import ( ) // Removes tags for a resource in CodeCommit. For a list of valid resources in -// 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 CodeCommit User Guide. +// CodeCommit, see [CodeCommit Resources and Operations]in the CodeCommit User Guide. +// +// [CodeCommit Resources and Operations]: https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go b/service/codecommit/api_op_UpdateApprovalRuleTemplateContent.go index 60310d29dd8..1e903090e99 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 4cdf7a69fc1..ced58218ba7 100644 --- a/service/codecommit/api_op_UpdateComment.go +++ b/service/codecommit/api_op_UpdateComment.go @@ -29,8 +29,8 @@ 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 . + // The system-generated ID of the comment you want to update. To get this ID, use 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 0221d7c6b7d..79fcdb4177c 100644 --- a/service/codecommit/api_op_UpdateDefaultBranch.go +++ b/service/codecommit/api_op_UpdateDefaultBranch.go @@ -10,10 +10,11 @@ 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 924d0b85e42..dedc7234cf1 100644 --- a/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go +++ b/service/codecommit/api_op_UpdatePullRequestApprovalRuleContent.go @@ -36,8 +36,10 @@ type UpdatePullRequestApprovalRuleContentInput struct { // This member is required. 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: + // 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: // // - CodeCommitApprovers: This option only requires an Amazon Web Services // account and a resource. It can be used for both IAM users and federated access @@ -45,17 +47,24 @@ type UpdatePullRequestApprovalRuleContentInput struct { // option that offers a great deal of flexibility. For example, if you specify the // Amazon Web Services 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: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. + // + // For more information about IAM ARNs, wildcards, and formats, see [IAM Identifiers] in the IAM + // User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. NewRuleContent *string @@ -66,7 +75,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 5f9b253341f..77936a68f78 100644 --- a/service/codecommit/api_op_UpdatePullRequestDescription.go +++ b/service/codecommit/api_op_UpdatePullRequestDescription.go @@ -35,8 +35,7 @@ type UpdatePullRequestDescriptionInput struct { // This member is required. Description *string - // The system-generated ID of the pull request. To get this ID, use - // ListPullRequests . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_UpdatePullRequestStatus.go b/service/codecommit/api_op_UpdatePullRequestStatus.go index 7e28579d9c8..7ef4cb9bc61 100644 --- a/service/codecommit/api_op_UpdatePullRequestStatus.go +++ b/service/codecommit/api_op_UpdatePullRequestStatus.go @@ -29,8 +29,7 @@ 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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_UpdatePullRequestTitle.go b/service/codecommit/api_op_UpdatePullRequestTitle.go index 3310f8f8a0e..da16edac796 100644 --- a/service/codecommit/api_op_UpdatePullRequestTitle.go +++ b/service/codecommit/api_op_UpdatePullRequestTitle.go @@ -29,8 +29,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 . + // The system-generated ID of the pull request. To get this ID, use ListPullRequests. // // This member is required. PullRequestId *string diff --git a/service/codecommit/api_op_UpdateRepositoryDescription.go b/service/codecommit/api_op_UpdateRepositoryDescription.go index 50a09ea0df6..ed82af4e273 100644 --- a/service/codecommit/api_op_UpdateRepositoryDescription.go +++ b/service/codecommit/api_op_UpdateRepositoryDescription.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets or changes the comment or description for a repository. The description -// field for a repository accepts all HTML characters and all valid Unicode -// characters. Applications that do not HTML-encode the description and display it -// in a webpage can expose users to potentially malicious code. Make sure that you -// HTML-encode the description field in any application that uses this API to -// display the repository description on a webpage. +// Sets or changes the comment or description for a repository. +// +// The description field for a repository accepts all HTML characters and all +// valid Unicode characters. Applications that do not HTML-encode the description +// and display it in a webpage can expose users to potentially malicious code. Make +// sure that you HTML-encode the description field in any application that uses +// this API to display the repository description on a webpage. func (c *Client) UpdateRepositoryDescription(ctx context.Context, params *UpdateRepositoryDescriptionInput, optFns ...func(*Options)) (*UpdateRepositoryDescriptionOutput, error) { if params == nil { params = &UpdateRepositoryDescriptionInput{} diff --git a/service/codecommit/api_op_UpdateRepositoryEncryptionKey.go b/service/codecommit/api_op_UpdateRepositoryEncryptionKey.go index a16a76cf59a..6bd0bdc12c4 100644 --- a/service/codecommit/api_op_UpdateRepositoryEncryptionKey.go +++ b/service/codecommit/api_op_UpdateRepositoryEncryptionKey.go @@ -31,8 +31,10 @@ type UpdateRepositoryEncryptionKeyInput struct { // The ID of the encryption key. You can view the ID of an encryption key in the // KMS console, or use the KMS APIs to programmatically retrieve a key ID. For more - // information about acceptable values for keyID, see KeyId (https://docs.aws.amazon.com/APIReference/API_Decrypt.html#KMS-Decrypt-request-KeyId) - // in the Decrypt API description in the Key Management Service API Reference. + // information about acceptable values for keyID, see [KeyId]in the Decrypt API + // description in the Key Management Service API Reference. + // + // [KeyId]: https://docs.aws.amazon.com/APIReference/API_Decrypt.html#KMS-Decrypt-request-KeyId // // This member is required. KmsKeyId *string diff --git a/service/codecommit/api_op_UpdateRepositoryName.go b/service/codecommit/api_op_UpdateRepositoryName.go index 61c85cbc8e7..b3ca1186d80 100644 --- a/service/codecommit/api_op_UpdateRepositoryName.go +++ b/service/codecommit/api_op_UpdateRepositoryName.go @@ -14,8 +14,9 @@ import ( // Amazon Web Services account. Repository names are limited to 100 alphanumeric, // dash, and underscore characters, and cannot include certain characters. The // suffix .git is prohibited. For more information about the limits on repository -// names, see Quotas (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) -// in the CodeCommit User Guide. +// names, see [Quotas]in the CodeCommit User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html func (c *Client) UpdateRepositoryName(ctx context.Context, params *UpdateRepositoryNameInput, optFns ...func(*Options)) (*UpdateRepositoryNameOutput, error) { if params == nil { params = &UpdateRepositoryNameInput{} diff --git a/service/codecommit/doc.go b/service/codecommit/doc.go index dd5faf9cb72..0cafb4debd7 100644 --- a/service/codecommit/doc.go +++ b/service/codecommit/doc.go @@ -3,200 +3,320 @@ // Package codecommit provides the API client, operations, and parameter types for // AWS CodeCommit. // -// CodeCommit This is the CodeCommit API Reference. This reference provides -// descriptions of the operations and data types for CodeCommit API along with -// usage examples. You can use the 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 Amazon Web Services account. -// - CreateRepository , which creates an CodeCommit repository. -// - DeleteRepository , which deletes an CodeCommit repository. -// - GetRepository , which returns information about a specified repository. -// - ListRepositories , which lists all CodeCommit repositories associated with +// # CodeCommit +// +// This is the CodeCommit API Reference. This reference provides descriptions of +// the operations and data types for CodeCommit API along with usage examples. +// +// You can use the 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 Amazon Web Services account. -// - UpdateRepositoryDescription , which sets or updates the description of the -// repository. -// - UpdateRepositoryEncryptionKey , which updates the Key Management Service -// encryption key used to encrypt and decrypt a 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. +// +// CreateRepository +// - , which creates an CodeCommit repository. +// +// DeleteRepository +// - , which deletes an CodeCommit repository. +// +// GetRepository +// - , which returns information about a specified repository. +// +// ListRepositories +// - , which lists all CodeCommit repositories associated with your Amazon Web +// Services account. +// +// UpdateRepositoryDescription +// - , which sets or updates the description of the repository. +// +// UpdateRepositoryEncryptionKey +// - , which updates the Key Management Service encryption key used to encrypt +// and decrypt a 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. +// +// 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. -// - ListFileCommitHistory , which retrieves a list of commits and changes to a -// specified file. -// - 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. +// +// ListFileCommitHistory +// - , which retrieves a list of commits and changes to a specified file. +// +// 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 +// +// 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. -// - UpdatePullRequestDescription , which updates the description of a pull +// +// 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. -// - UpdatePullRequestStatus , which updates the status of a pull request. -// - UpdatePullRequestTitle , which updates the title of a pull 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, -// CodeCommit creates approval rules that match the template conditions on every -// pull request created in the specified repository. +// AssociateApprovalRuleTemplateWithRepository +// - , which associates a template with a specified repository. After the +// template is associated with a repository, 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, CodeCommit creates approval rules that match the -// template conditions on every pull request created in the specified repositories. +// BatchAssociateApprovalRuleTemplateWithRepositories +// - , which associates a template with one or more specified repositories. +// After the template is associated with a repository, 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. +// 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 Amazon Web -// Services account. +// CreateApprovalRuleTemplate +// - , which creates a template for approval rules that can then be associated +// with one or more repositories in your Amazon Web Services 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. // -// - DeleteApprovalRuleTemplate , which deletes the specified template. It does -// not remove approval rules on pull requests already created with the template. +// GetApprovalRuleTemplate +// - , which returns information about an approval rule 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 +// ListApprovalRuleTemplates +// - , which lists all approval rule templates in the Amazon Web Services Region +// in your Amazon Web Services account. +// +// ListAssociatedApprovalRuleTemplatesForRepository +// - , which lists all approval rule templates that are associated with a // specified repository. // -// - GetApprovalRuleTemplate , which returns information about an approval rule +// ListRepositoriesForApprovalRuleTemplate +// - , which lists all repositories associated with the specified approval rule // template. // -// - ListApprovalRuleTemplates , which lists all approval rule templates in the -// Amazon Web Services Region in your Amazon Web Services account. +// UpdateApprovalRuleTemplateDescription +// - , which updates the description of an approval rule template. // -// - ListAssociatedApprovalRuleTemplatesForRepository , which lists all approval -// rule templates that are associated with a specified repository. +// UpdateApprovalRuleTemplateName +// - , which updates the name of an approval rule template. // -// - ListRepositoriesForApprovalRuleTemplate , which lists all repositories -// associated with the specified approval rule template. +// UpdateApprovalRuleTemplateContent +// - , which updates the content of an approval rule template. // -// - UpdateApprovalRuleTemplateDescription , which updates the description of an -// approval rule template. +// Comments in a repository, by calling the following: // -// - UpdateApprovalRuleTemplateName , which updates the name of an approval rule -// template. +// DeleteCommentContent +// - , which deletes the content of a comment on a commit in a repository. // -// - UpdateApprovalRuleTemplateContent , which updates the content of an approval -// rule template. +// GetComment +// - , which returns information about a comment on a commit. // -// 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. +// 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 CodeCommit (not Git tags), by calling the // following: -// - ListTagsForResource , which gets information about Amazon Web Servicestags -// for a specified Amazon Resource Name (ARN) in CodeCommit. -// - TagResource , which adds or updates tags for a resource in CodeCommit. -// - UntagResource , which removes tags for a resource in CodeCommit. +// +// ListTagsForResource +// - , which gets information about Amazon Web Servicestags for a specified +// Amazon Resource Name (ARN) in CodeCommit. +// +// TagResource +// - , which adds or updates tags for a resource in CodeCommit. +// +// UntagResource +// - , which removes tags for a resource in 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 CodeCommit, see the 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 CodeCommit, see the [CodeCommit User Guide]. +// +// [CodeCommit User Guide]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html package codecommit diff --git a/service/codecommit/options.go b/service/codecommit/options.go index 22ae7feaed4..691f5eb953b 100644 --- a/service/codecommit/options.go +++ b/service/codecommit/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codecommit/types/enums.go b/service/codecommit/types/enums.go index 9d807cbf6ab..55afc79f812 100644 --- a/service/codecommit/types/enums.go +++ b/service/codecommit/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApprovalState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApprovalState) Values() []ApprovalState { return []ApprovalState{ "APPROVE", @@ -34,8 +35,9 @@ const ( // Values returns all known values for BatchGetRepositoriesErrorCodeEnum. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchGetRepositoriesErrorCodeEnum) Values() []BatchGetRepositoriesErrorCodeEnum { return []BatchGetRepositoriesErrorCodeEnum{ "EncryptionIntegrityChecksFailedException", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for ChangeTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeTypeEnum) Values() []ChangeTypeEnum { return []ChangeTypeEnum{ "A", @@ -77,6 +80,7 @@ const ( // Values returns all known values for ConflictDetailLevelTypeEnum. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConflictDetailLevelTypeEnum) Values() []ConflictDetailLevelTypeEnum { return []ConflictDetailLevelTypeEnum{ @@ -97,8 +101,9 @@ const ( // Values returns all known values for ConflictResolutionStrategyTypeEnum. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictResolutionStrategyTypeEnum) Values() []ConflictResolutionStrategyTypeEnum { return []ConflictResolutionStrategyTypeEnum{ "NONE", @@ -118,8 +123,9 @@ const ( ) // Values returns all known values for FileModeTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileModeTypeEnum) Values() []FileModeTypeEnum { return []FileModeTypeEnum{ "EXECUTABLE", @@ -138,8 +144,9 @@ const ( ) // Values returns all known values for MergeOptionTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MergeOptionTypeEnum) Values() []MergeOptionTypeEnum { return []MergeOptionTypeEnum{ "FAST_FORWARD_MERGE", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for ObjectTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectTypeEnum) Values() []ObjectTypeEnum { return []ObjectTypeEnum{ "FILE", @@ -179,8 +187,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for OverrideStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverrideStatus) Values() []OverrideStatus { return []OverrideStatus{ "OVERRIDE", @@ -222,8 +232,9 @@ const ( ) // Values returns all known values for PullRequestEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PullRequestEventType) Values() []PullRequestEventType { return []PullRequestEventType{ "PULL_REQUEST_CREATED", @@ -247,8 +258,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "OPEN", @@ -265,8 +277,9 @@ const ( ) // Values returns all known values for RelativeFileVersionEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelativeFileVersionEnum) Values() []RelativeFileVersionEnum { return []RelativeFileVersionEnum{ "BEFORE", @@ -285,8 +298,9 @@ const ( ) // Values returns all known values for ReplacementTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplacementTypeEnum) Values() []ReplacementTypeEnum { return []ReplacementTypeEnum{ "KEEP_BASE", @@ -308,6 +322,7 @@ const ( // Values returns all known values for RepositoryTriggerEventEnum. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RepositoryTriggerEventEnum) Values() []RepositoryTriggerEventEnum { return []RepositoryTriggerEventEnum{ @@ -327,8 +342,9 @@ const ( ) // Values returns all known values for SortByEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortByEnum) Values() []SortByEnum { return []SortByEnum{ "repositoryName", diff --git a/service/codecommit/types/errors.go b/service/codecommit/types/errors.go index 19f96aa172c..0812364427b 100644 --- a/service/codecommit/types/errors.go +++ b/service/codecommit/types/errors.go @@ -452,7 +452,9 @@ func (e *BranchDoesNotExistException) ErrorCode() string { func (e *BranchDoesNotExistException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Cannot create the branch with the specified name because the commit conflicts -// with an existing branch with the same name. Branch names must be unique. +// with an existing branch with the same name. +// +// Branch names must be unique. type BranchNameExistsException struct { Message *string @@ -479,8 +481,7 @@ func (e *BranchNameExistsException) ErrorCode() string { func (e *BranchNameExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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 . +// of a branch in the repository. For a list of valid branch names, use ListBranches. type BranchNameIsTagNameException struct { Message *string @@ -1510,8 +1511,9 @@ func (e *FilePathConflictsWithSubmodulePathException) ErrorFault() smithy.ErrorF } // The specified file exceeds the file size limit for CodeCommit. For more -// information about limits in CodeCommit, see Quotas (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) -// in the CodeCommit User Guide. +// information about limits in CodeCommit, see [Quotas]in the CodeCommit User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html type FileTooLargeException struct { Message *string @@ -1736,8 +1738,9 @@ 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 CodeCommit, see Quotas (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) -// in the CodeCommit User Guide. +// limits in CodeCommit, see [Quotas]in the CodeCommit User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html type InvalidApprovalRuleTemplateDescriptionException struct { Message *string @@ -1767,8 +1770,9 @@ 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 CodeCommit, see Quotas (https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html) -// in the CodeCommit User Guide. +// in CodeCommit, see [Quotas]in the CodeCommit User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/codecommit/latest/userguide/limits.html type InvalidApprovalRuleTemplateNameException struct { Message *string @@ -2257,7 +2261,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 @@ -2657,9 +2661,9 @@ 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 -// CodeCommit User Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) -// . +// The value of the reaction is not valid. For more information, see the [CodeCommit User Guide]. +// +// [CodeCommit User Guide]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html type InvalidReactionValueException struct { Message *string @@ -2687,8 +2691,9 @@ 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/main). 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]or consult your Git documentation. +// +// [Git Internals - Git References]: https://git-scm.com/book/en/v2/Git-Internals-Git-References type InvalidReferenceNameException struct { Message *string @@ -2827,9 +2832,11 @@ func (e *InvalidRepositoryDescriptionException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A specified repository name is not valid. This exception occurs only when a -// specified repository name is not valid. Other exceptions occur when a required -// repository parameter is missing, or when a specified repository does not exist. +// A specified repository name is not valid. +// +// This exception occurs only when a specified repository name is not valid. Other +// exceptions occur when a required repository parameter is missing, or when a +// specified repository does not exist. type InvalidRepositoryNameException struct { Message *string @@ -3029,8 +3036,9 @@ func (e *InvalidRepositoryTriggerRegionException) ErrorFault() smithy.ErrorFault } // The value for the resource ARN is not valid. For more information about -// resources in 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 CodeCommit User Guide. +// resources in CodeCommit, see [CodeCommit Resources and Operations]in the CodeCommit User Guide. +// +// [CodeCommit Resources and Operations]: https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats type InvalidResourceArnException struct { Message *string @@ -3941,7 +3949,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 @@ -3968,7 +3976,7 @@ func (e *ParentCommitIdOutdatedException) ErrorCode() string { func (e *ParentCommitIdOutdatedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // A parent commit ID is required. To view the full commit ID of a branch in a -// repository, use GetBranch or a Git command (for example, git pull or git log). +// repository, use GetBranchor a Git command (for example, git pull or git log). type ParentCommitIdRequiredException struct { Message *string @@ -4729,8 +4737,9 @@ func (e *RepositoryTriggersListRequiredException) ErrorFault() smithy.ErrorFault } // A valid Amazon Resource Name (ARN) for an CodeCommit resource is required. For -// a list of valid resources in 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 CodeCommit User Guide. +// a list of valid resources in CodeCommit, see [CodeCommit Resources and Operations]in the CodeCommit User Guide. +// +// [CodeCommit Resources and Operations]: https://docs.aws.amazon.com/codecommit/latest/userguide/auth-and-access-control-iam-access-control-identity-based.html#arn-formats type ResourceArnRequiredException struct { Message *string diff --git a/service/codecommit/types/types.go b/service/codecommit/types/types.go index c6737cab977..4724f73a525 100644 --- a/service/codecommit/types/types.go +++ b/service/codecommit/types/types.go @@ -224,9 +224,13 @@ 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 Mode *string @@ -374,9 +378,12 @@ type Commit struct { // Information about the person who committed the specified commit, also known as // 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. + // configured in Git. + // + // For more information about the difference between an author and a committer in + // Git, see [Viewing the Commit History]in Pro Git by Scott Chacon and Ben Straub. + // + // [Viewing the Commit History]: http://git-scm.com/book/ch2-3.html Committer *UserInfo // The commit message associated with the specified commit. @@ -1078,11 +1085,12 @@ type RepositoryNameIdPair struct { noSmithyDocumentSerde } -// Information about a trigger for a repository. If you want to receive -// notifications about repository events, consider using notifications instead of -// triggers. For more information, see Configuring notifications for repository -// events (https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-repository-email.html) -// . +// Information about a trigger for a repository. +// +// If you want to receive notifications about repository events, consider using +// notifications instead of triggers. For more information, see [Configuring notifications for repository events]. +// +// [Configuring notifications for repository events]: https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-repository-email.html type RepositoryTrigger struct { // The ARN of the resource that is the target for a trigger (for example, the ARN @@ -1092,8 +1100,9 @@ type RepositoryTrigger struct { DestinationArn *string // The repository events that cause the trigger to run actions in another service, - // such as sending a notification through Amazon SNS. The valid value "all" cannot - // be used with any other values. + // such as sending a notification through Amazon SNS. + // + // The valid value "all" cannot be used with any other values. // // This member is required. Events []RepositoryTriggerEventEnum @@ -1104,8 +1113,9 @@ type RepositoryTrigger struct { Name *string // The branches to be included in the trigger configuration. If you specify an - // empty array, the trigger applies to all branches. Although no content is - // required in the array, you must include the array itself. + // empty array, the trigger applies to all branches. + // + // Although no content is required in the array, you must include the array itself. Branches []string // Any custom data associated with the trigger to be included in the information diff --git a/service/codeconnections/api_op_CreateConnection.go b/service/codeconnections/api_op_CreateConnection.go index 8c14d305665..1a9964baace 100644 --- a/service/codeconnections/api_op_CreateConnection.go +++ b/service/codeconnections/api_op_CreateConnection.go @@ -55,7 +55,9 @@ type CreateConnectionOutput struct { // The Amazon Resource Name (ARN) of the connection to be created. The ARN is used // as the connection reference when the connection is shared between Amazon Web - // Services services. The ARN is never reused if the connection is deleted. + // Services services. + // + // The ARN is never reused if the connection is deleted. // // This member is required. ConnectionArn *string diff --git a/service/codeconnections/api_op_CreateHost.go b/service/codeconnections/api_op_CreateHost.go index c56ca429947..0039eb6d010 100644 --- a/service/codeconnections/api_op_CreateHost.go +++ b/service/codeconnections/api_op_CreateHost.go @@ -14,9 +14,10 @@ import ( // Creates a resource that represents the infrastructure where a third-party // provider is installed. The host is used when you create connections to an // installed third-party provider type, such as GitHub Enterprise Server. You -// create one host for all connections to that provider. A host created through the -// CLI or the SDK is in `PENDING` status by default. You can make its status -// `AVAILABLE` by setting up the host in the console. +// create one host for all connections to that provider. +// +// A host created through the CLI or the SDK is in `PENDING` status by default. +// You can make its status `AVAILABLE` by setting up the host in the console. func (c *Client) CreateHost(ctx context.Context, params *CreateHostInput, optFns ...func(*Options)) (*CreateHostOutput, error) { if params == nil { params = &CreateHostInput{} diff --git a/service/codeconnections/api_op_DeleteConnection.go b/service/codeconnections/api_op_DeleteConnection.go index 2a3ad699c0c..1f76aeb1ae8 100644 --- a/service/codeconnections/api_op_DeleteConnection.go +++ b/service/codeconnections/api_op_DeleteConnection.go @@ -28,8 +28,9 @@ 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/codeconnections/api_op_DeleteHost.go b/service/codeconnections/api_op_DeleteHost.go index 2703254fb51..75b0f76a6f8 100644 --- a/service/codeconnections/api_op_DeleteHost.go +++ b/service/codeconnections/api_op_DeleteHost.go @@ -11,8 +11,10 @@ import ( ) // The host to be deleted. Before you delete a host, all connections associated to -// the host must be deleted. A host cannot be deleted if it is in the -// VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state. +// the host must be deleted. +// +// A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or +// VPC_CONFIG_DELETING state. func (c *Client) DeleteHost(ctx context.Context, params *DeleteHostInput, optFns ...func(*Options)) (*DeleteHostOutput, error) { if params == nil { params = &DeleteHostInput{} diff --git a/service/codeconnections/api_op_ListRepositoryLinks.go b/service/codeconnections/api_op_ListRepositoryLinks.go index 0c69aa351c5..c29cbfbf353 100644 --- a/service/codeconnections/api_op_ListRepositoryLinks.go +++ b/service/codeconnections/api_op_ListRepositoryLinks.go @@ -29,10 +29,10 @@ func (c *Client) ListRepositoryLinks(ctx context.Context, params *ListRepository type ListRepositoryLinksInput struct { - // A non-zero, non-negative integer used to limit the number of returned results. + // 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 + // An enumeration token that, when provided in a request, returns the next batch // of the results. NextToken *string @@ -143,7 +143,7 @@ var _ ListRepositoryLinksAPIClient = (*Client)(nil) // ListRepositoryLinksPaginatorOptions is the paginator options for // ListRepositoryLinks type ListRepositoryLinksPaginatorOptions struct { - // A non-zero, non-negative integer used to limit the number of returned results. + // A non-zero, non-negative integer used to limit the number of returned results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codeconnections/doc.go b/service/codeconnections/doc.go index a2214a3e8eb..3cb0af3f3ea 100644 --- a/service/codeconnections/doc.go +++ b/service/codeconnections/doc.go @@ -3,49 +3,76 @@ // Package codeconnections provides the API client, operations, and parameter // types for AWS CodeConnections. // -// AWS CodeConnections This Amazon Web Services CodeConnections API Reference -// provides descriptions and usage examples of the operations and data types for -// the Amazon Web Services CodeConnections API. You can use the connections API to -// work with connections and installations. Connections are configurations that you -// use to connect Amazon Web Services resources to external code repositories. Each -// connection is a resource that can be given to services such as CodePipeline to -// connect to a third-party repository such as Bitbucket. For example, you can add -// the connection in CodePipeline so that it triggers your pipeline when a code -// change is made to your third-party code repository. Each connection is named and -// associated with a unique ARN that is used to reference the connection. When you -// create a connection, the console initiates a third-party connection handshake. -// Installations are the apps that are used to conduct this handshake. For example, -// the installation for the Bitbucket provider type is the Bitbucket app. When you -// create a connection, you can choose an existing installation or create one. When -// 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. +// # AWS CodeConnections // -// 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 +// This Amazon Web Services CodeConnections API Reference provides descriptions +// and usage examples of the operations and data types for the Amazon Web Services +// CodeConnections API. You can use the connections API to work with connections +// and installations. +// +// Connections are configurations that you use to connect Amazon Web Services +// resources to external code repositories. Each connection is a resource that can +// be given to services such as CodePipeline to connect to a third-party repository +// such as Bitbucket. For example, you can add the connection in CodePipeline so +// that it triggers your pipeline when a code change is made to your third-party +// code repository. Each connection is named and associated with a unique ARN that +// is used to reference the connection. +// +// When you create a connection, the console initiates a third-party connection +// handshake. Installations are the apps that are used to conduct this handshake. +// For example, the installation for the Bitbucket provider type is the Bitbucket +// app. When you create a connection, you can choose an existing installation or +// create one. +// +// When 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. -// - ListHosts , which lists the hosts associated with your account. +// +// 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 Amazon Web Services CodeConnections by calling the // following: -// - ListTagsForResource , which gets information about Amazon Web Services tags -// for a specified Amazon Resource Name (ARN) in Amazon Web Services -// CodeConnections. -// - TagResource , which adds or updates tags for a resource in Amazon Web -// Services CodeConnections. -// - UntagResource , which removes tags for a resource in Amazon Web Services +// +// ListTagsForResource +// - , which gets information about Amazon Web Services tags for a specified +// Amazon Resource Name (ARN) in Amazon Web Services CodeConnections. +// +// TagResource +// - , which adds or updates tags for a resource in Amazon Web Services // CodeConnections. // -// For information about how to use Amazon Web Services CodeConnections, see the -// Developer Tools User Guide (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html) -// . +// UntagResource +// - , which removes tags for a resource in Amazon Web Services CodeConnections. +// +// For information about how to use Amazon Web Services CodeConnections, see the [Developer Tools User Guide]. +// +// [Developer Tools User Guide]: https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html package codeconnections diff --git a/service/codeconnections/options.go b/service/codeconnections/options.go index 4054b50a76c..0f7ce822c31 100644 --- a/service/codeconnections/options.go +++ b/service/codeconnections/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codeconnections/types/enums.go b/service/codeconnections/types/enums.go index b21a1dea607..9ee79db00a7 100644 --- a/service/codeconnections/types/enums.go +++ b/service/codeconnections/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BlockerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerStatus) Values() []BlockerStatus { return []BlockerStatus{ "ACTIVE", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for BlockerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerType) Values() []BlockerType { return []BlockerType{ "AUTOMATED", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "PENDING", @@ -68,8 +71,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for PublishDeploymentStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PublishDeploymentStatus) Values() []PublishDeploymentStatus { return []PublishDeploymentStatus{ "ENABLED", @@ -110,8 +115,9 @@ const ( ) // Values returns all known values for RepositorySyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositorySyncStatus) Values() []RepositorySyncStatus { return []RepositorySyncStatus{ "FAILED", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for ResourceSyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSyncStatus) Values() []ResourceSyncStatus { return []ResourceSyncStatus{ "FAILED", @@ -152,8 +159,9 @@ const ( ) // Values returns all known values for SyncConfigurationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncConfigurationType) Values() []SyncConfigurationType { return []SyncConfigurationType{ "CFN_STACK_SYNC", @@ -169,8 +177,9 @@ const ( ) // Values returns all known values for TriggerResourceUpdateOn. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerResourceUpdateOn) Values() []TriggerResourceUpdateOn { return []TriggerResourceUpdateOn{ "ANY_CHANGE", diff --git a/service/codeconnections/types/types.go b/service/codeconnections/types/types.go index 91edb55b3c1..93a3c56a315 100644 --- a/service/codeconnections/types/types.go +++ b/service/codeconnections/types/types.go @@ -8,13 +8,16 @@ import ( ) // A resource that is used to connect third-party source providers with services -// like CodePipeline. Note: A connection created through CloudFormation, the CLI, -// or the SDK is in `PENDING` status by default. You can make its status -// `AVAILABLE` by updating the connection in the console. +// like CodePipeline. +// +// Note: A connection created through CloudFormation, the CLI, or the SDK is in +// `PENDING` status by default. You can make its status `AVAILABLE` by updating the +// connection in the console. type Connection struct { // The Amazon Resource Name (ARN) of the connection. The ARN is used as the // connection reference when the connection is shared between Amazon Web Services. + // // The ARN is never reused if the connection is deleted. ConnectionArn *string @@ -43,9 +46,10 @@ type Connection struct { // A resource that represents the infrastructure where a third-party provider is // installed. The host is used when you create connections to an installed // third-party provider type, such as GitHub Enterprise Server. You create one host -// for all connections to that provider. A host created through the CLI or the SDK -// is in `PENDING` status by default. You can make its status `AVAILABLE` by -// setting up the host in the console. +// for all connections to that provider. +// +// A host created through the CLI or the SDK is in `PENDING` status by default. +// You can make its status `AVAILABLE` by setting up the host in the console. type Host struct { // The Amazon Resource Name (ARN) of the host. @@ -134,11 +138,16 @@ type RepositorySyncAttempt struct { StartedAt *time.Time // The status of a specific sync attempt. The following are valid statuses: + // // - INITIATED - A repository sync attempt has been created and will begin soon. + // // - IN_PROGRESS - A repository sync attempt has started and work is being done // to reconcile the branch. + // // - SUCCEEDED - The repository sync attempt has completed successfully. + // // - FAILED - The repository sync attempt has failed. + // // - QUEUED - The repository sync attempt didn't execute and was queued. // // This member is required. @@ -219,10 +228,14 @@ type ResourceSyncAttempt struct { StartedAt *time.Time // The status for a resource sync attempt. The follow are valid statuses: + // // - SYNC-INITIATED - A resource sync attempt has been created and will begin // soon. + // // - SYNCING - Syncing has started and work is being done to reconcile state. + // // - SYNCED - Syncing has completed successfully. + // // - SYNC_FAILED - A resource sync attempt has failed. // // This member is required. @@ -442,8 +455,9 @@ type SyncConfiguration struct { noSmithyDocumentSerde } -// A tag is a key-value pair that is used to manage the resource. This tag is -// available for use by Amazon Web Services services that support tags. +// A tag is a key-value pair that is used to manage the resource. +// +// This tag is available for use by Amazon Web Services services that support tags. type Tag struct { // The tag's key. diff --git a/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go b/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go index 5677b231802..9fb2534afb3 100644 --- a/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go +++ b/service/codedeploy/api_op_AddTagsToOnPremisesInstances.go @@ -35,9 +35,10 @@ 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 - // allowed. + // 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. Tags []types.Tag diff --git a/service/codedeploy/api_op_BatchGetDeploymentInstances.go b/service/codedeploy/api_op_BatchGetDeploymentInstances.go index 5edc6d5d0d2..439ed28d967 100644 --- a/service/codedeploy/api_op_BatchGetDeploymentInstances.go +++ b/service/codedeploy/api_op_BatchGetDeploymentInstances.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This method works, but is deprecated. Use BatchGetDeploymentTargets instead. +// This method works, but is deprecated. Use BatchGetDeploymentTargets instead. +// // Returns an array of one or more instances associated with a deployment. This // method works with EC2/On-premises and Lambda compute platforms. The newer // BatchGetDeploymentTargets works with all compute platforms. The maximum number @@ -36,7 +37,7 @@ func (c *Client) BatchGetDeploymentInstances(ctx context.Context, params *BatchG // Represents the input of a BatchGetDeploymentInstances operation. type BatchGetDeploymentInstancesInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. DeploymentId *string diff --git a/service/codedeploy/api_op_BatchGetDeploymentTargets.go b/service/codedeploy/api_op_BatchGetDeploymentTargets.go index b65f6274a07..f5a9d505279 100644 --- a/service/codedeploy/api_op_BatchGetDeploymentTargets.go +++ b/service/codedeploy/api_op_BatchGetDeploymentTargets.go @@ -11,14 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an array of one or more targets associated with a deployment. This +// 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 -// is 25. The type of targets returned depends on the deployment's compute platform -// or deployment method: +// 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. func (c *Client) BatchGetDeploymentTargets(ctx context.Context, params *BatchGetDeploymentTargetsInput, optFns ...func(*Options)) (*BatchGetDeploymentTargetsOutput, error) { @@ -38,22 +45,26 @@ func (c *Client) BatchGetDeploymentTargets(ctx context.Context, params *BatchGet type BatchGetDeploymentTargetsInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. DeploymentId *string - // The unique IDs of the deployment targets. The compute platform of the + // 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 . // @@ -65,13 +76,17 @@ type BatchGetDeploymentTargetsInput struct { type BatchGetDeploymentTargetsOutput struct { - // A list of target objects for a deployment. Each target object contains details + // 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. DeploymentTargets []types.DeploymentTarget diff --git a/service/codedeploy/api_op_BatchGetDeployments.go b/service/codedeploy/api_op_BatchGetDeployments.go index 75fd2bf9fe7..3f06d4073e7 100644 --- a/service/codedeploy/api_op_BatchGetDeployments.go +++ b/service/codedeploy/api_op_BatchGetDeployments.go @@ -31,8 +31,8 @@ func (c *Client) BatchGetDeployments(ctx context.Context, params *BatchGetDeploy // Represents the input of a BatchGetDeployments operation. type BatchGetDeploymentsInput struct { - // A list of deployment IDs, separated by spaces. The maximum number of deployment - // IDs you can specify is 25. + // A list of deployment IDs, separated by spaces. The maximum number of + // deployment IDs you can specify is 25. // // This member is required. DeploymentIds []string @@ -43,7 +43,7 @@ type BatchGetDeploymentsInput struct { // Represents the output of a BatchGetDeployments operation. type BatchGetDeploymentsOutput struct { - // Information about the deployments. + // Information about the deployments. DeploymentsInfo []types.DeploymentInfo // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_ContinueDeployment.go b/service/codedeploy/api_op_ContinueDeployment.go index a2c4891a522..1ed20a9245a 100644 --- a/service/codedeploy/api_op_ContinueDeployment.go +++ b/service/codedeploy/api_op_ContinueDeployment.go @@ -34,11 +34,11 @@ func (c *Client) ContinueDeployment(ctx context.Context, params *ContinueDeploym type ContinueDeploymentInput struct { - // The unique ID of a blue/green deployment for which you want to start rerouting + // The unique ID of a blue/green deployment for which you want to start rerouting // traffic to the replacement environment. DeploymentId *string - // The status of the deployment's waiting period. READY_WAIT indicates that the + // The status of the deployment's waiting period. READY_WAIT indicates that the // deployment is ready to start shifting traffic. TERMINATION_WAIT indicates that // the traffic is shifted, but the original target is not terminated. DeploymentWaitType types.DeploymentWaitType diff --git a/service/codedeploy/api_op_CreateApplication.go b/service/codedeploy/api_op_CreateApplication.go index 5751ed162d6..244123292b4 100644 --- a/service/codedeploy/api_op_CreateApplication.go +++ b/service/codedeploy/api_op_CreateApplication.go @@ -36,12 +36,12 @@ type CreateApplicationInput struct { // 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 - // categorize them. Each tag consists of a key and an optional value, both of which - // you define. + // The metadata that you apply to CodeDeploy applications 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 noSmithyDocumentSerde diff --git a/service/codedeploy/api_op_CreateDeployment.go b/service/codedeploy/api_op_CreateDeployment.go index 83a584cebb4..0d596d5ebcb 100644 --- a/service/codedeploy/api_op_CreateDeployment.go +++ b/service/codedeploy/api_op_CreateDeployment.go @@ -41,10 +41,11 @@ type CreateDeploymentInput struct { AutoRollbackConfiguration *types.AutoRollbackConfiguration // The name of a deployment configuration associated with the 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 - // default. + // 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 default. DeploymentConfigName *string // The name of the deployment group. @@ -55,34 +56,43 @@ 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: + // 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 - // 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. + // 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. IgnoreApplicationStopFailures bool // Allows you to specify information about alarms associated with a deployment. @@ -93,19 +103,20 @@ type CreateDeploymentInput struct { // 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 . + // 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. + // The type and location of the revision to deploy. Revision *types.RevisionLocation - // Information about the instances that belong to the replacement environment in a - // blue/green deployment. + // Information about the instances that belong to the replacement environment in + // a blue/green deployment. TargetInstances *types.TargetInstances - // Indicates whether to deploy to all instances or only to instances that are not + // Indicates whether to deploy to all instances or only to instances that are not // running the latest application revision. UpdateOutdatedInstancesOnly bool @@ -115,7 +126,7 @@ type CreateDeploymentInput struct { // Represents the output of a CreateDeployment operation. type CreateDeploymentOutput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. DeploymentId *string // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_CreateDeploymentConfig.go b/service/codedeploy/api_op_CreateDeploymentConfig.go index 2b78d90a6df..48ca1a89a91 100644 --- a/service/codedeploy/api_op_CreateDeploymentConfig.go +++ b/service/codedeploy/api_op_CreateDeploymentConfig.go @@ -40,26 +40,36 @@ type CreateDeploymentConfigInput struct { // 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: + // 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. + // + // 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. TrafficRoutingConfig *types.TrafficRoutingConfig // Configure the ZonalConfig object if you want CodeDeploy to deploy your - // application to one Availability Zone (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) - // at a time, within an Amazon Web Services Region. For more information about the - // zonal configuration feature, see zonal configuration (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) - // in the CodeDeploy User Guide. + // application to one [Availability Zone]at a time, within an Amazon Web Services Region. + // + // For more information about the zonal configuration feature, see [zonal configuration] in the + // CodeDeploy User Guide. + // + // [zonal configuration]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config + // [Availability Zone]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones ZonalConfig *types.ZonalConfig noSmithyDocumentSerde diff --git a/service/codedeploy/api_op_CreateDeploymentGroup.go b/service/codedeploy/api_op_CreateDeploymentGroup.go index 8ee222152cf..8e8de0400c0 100644 --- a/service/codedeploy/api_op_CreateDeploymentGroup.go +++ b/service/codedeploy/api_op_CreateDeploymentGroup.go @@ -64,12 +64,15 @@ 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) - // in the CodeDeploy User Guide. + // 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]in the CodeDeploy User Guide. + // + // [Working with Deployment Configurations in CodeDeploy]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html DeploymentConfigName *string // Information about the type of deployment, in-place or blue/green, that you want @@ -86,7 +89,7 @@ type CreateDeploymentGroupInput struct { // 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 + // 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 : . @@ -106,35 +109,44 @@ type CreateDeploymentGroupInput struct { 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. + // 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 + // 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 // This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto - // Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto - // Scaling (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html) - // in the CodeDeploy User Guide. Set terminationHookEnabled to true to have - // CodeDeploy install a termination hook into your Auto Scaling group when you - // create a deployment group. When this hook is installed, CodeDeploy will perform - // termination deployments. For information about termination deployments, see - // Enabling termination deployments during Auto Scaling scale-in events (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable) - // in the CodeDeploy User Guide. For more information about Auto Scaling scale-in - // events, see the Scale in (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in) - // topic in the Amazon EC2 Auto Scaling User Guide. + // Scaling. For more information, see [Integrating CodeDeploy with Amazon EC2 Auto Scaling]in the CodeDeploy User Guide. + // + // Set terminationHookEnabled to true to have CodeDeploy install a termination + // hook into your Auto Scaling group when you create a deployment group. When this + // hook is installed, CodeDeploy will perform termination deployments. + // + // For information about termination deployments, see [Enabling termination deployments during Auto Scaling scale-in events] in the CodeDeploy User + // Guide. + // + // For more information about Auto Scaling scale-in events, see the [Scale in] topic in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Enabling termination deployments during Auto Scaling scale-in events]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable + // [Integrating CodeDeploy with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html + // [Scale in]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in TerminationHookEnabled *bool // 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) - // in the CodeDeploy User Guide. + // examples, see [Create a Trigger for an CodeDeploy Event]in the CodeDeploy User Guide. + // + // [Create a Trigger for an CodeDeploy Event]: https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-sns.html TriggerConfigurations []types.TriggerConfig noSmithyDocumentSerde diff --git a/service/codedeploy/api_op_DeleteDeploymentConfig.go b/service/codedeploy/api_op_DeleteDeploymentConfig.go index 48952915735..c79d0317852 100644 --- a/service/codedeploy/api_op_DeleteDeploymentConfig.go +++ b/service/codedeploy/api_op_DeleteDeploymentConfig.go @@ -10,8 +10,10 @@ 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_DeleteResourcesByExternalId.go b/service/codedeploy/api_op_DeleteResourcesByExternalId.go index 8458f700a6d..5c6eba6c14c 100644 --- a/service/codedeploy/api_op_DeleteResourcesByExternalId.go +++ b/service/codedeploy/api_op_DeleteResourcesByExternalId.go @@ -11,11 +11,12 @@ import ( ) // Deletes resources linked to an external ID. This action only applies if you -// have configured blue/green deployments through CloudFormation. It is not -// necessary to call this action directly. CloudFormation calls it on your behalf -// when it needs to delete stack resources. This action is offered publicly in case -// you need to delete resources to comply with General Data Protection Regulation -// (GDPR) requirements. +// have configured blue/green deployments through CloudFormation. +// +// It is not necessary to call this action directly. CloudFormation calls it on +// your behalf when it needs to delete stack resources. This action is offered +// publicly in case you need to delete resources to comply with General Data +// Protection Regulation (GDPR) requirements. func (c *Client) DeleteResourcesByExternalId(ctx context.Context, params *DeleteResourcesByExternalIdInput, optFns ...func(*Options)) (*DeleteResourcesByExternalIdOutput, error) { if params == nil { params = &DeleteResourcesByExternalIdInput{} diff --git a/service/codedeploy/api_op_GetDeployment.go b/service/codedeploy/api_op_GetDeployment.go index 412bae7aa9a..e940c2913d6 100644 --- a/service/codedeploy/api_op_GetDeployment.go +++ b/service/codedeploy/api_op_GetDeployment.go @@ -15,10 +15,11 @@ import ( "time" ) -// Gets information about a deployment. The content property of the appSpecContent -// object in the returned revision is always null. Use GetApplicationRevision and -// the sha256 property of the returned appSpecContent object to get the content of -// the deployment’s AppSpec file. +// Gets information about a deployment. +// +// The content property of the appSpecContent object in the returned revision is +// always null. Use GetApplicationRevision and the sha256 property of the returned +// appSpecContent object to get the content of the deployment’s AppSpec file. func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error) { if params == nil { params = &GetDeploymentInput{} @@ -37,7 +38,7 @@ func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, // Represents the input of a GetDeployment operation. type GetDeploymentInput struct { - // The unique ID of a deployment associated with the user or Amazon Web Services + // The unique ID of a deployment associated with the user or Amazon Web Services // account. // // This member is required. @@ -178,12 +179,13 @@ type DeploymentSuccessfulWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetDeploymentInput, *GetDeploymentOutput, error) (bool, error) } diff --git a/service/codedeploy/api_op_GetDeploymentInstance.go b/service/codedeploy/api_op_GetDeploymentInstance.go index 26dcb6097a8..80aecee7268 100644 --- a/service/codedeploy/api_op_GetDeploymentInstance.go +++ b/service/codedeploy/api_op_GetDeploymentInstance.go @@ -32,12 +32,12 @@ func (c *Client) GetDeploymentInstance(ctx context.Context, params *GetDeploymen // Represents the input of a GetDeploymentInstance operation. type GetDeploymentInstanceInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. DeploymentId *string - // The unique ID of an instance in the deployment group. + // The unique ID of an instance in the deployment group. // // This member is required. InstanceId *string @@ -48,7 +48,7 @@ type GetDeploymentInstanceInput struct { // Represents the output of a GetDeploymentInstance operation. type GetDeploymentInstanceOutput struct { - // Information about the instance. + // Information about the instance. // // Deprecated: InstanceSummary is deprecated, use DeploymentTarget instead. InstanceSummary *types.InstanceSummary diff --git a/service/codedeploy/api_op_GetDeploymentTarget.go b/service/codedeploy/api_op_GetDeploymentTarget.go index 782450444a4..6f871fd8fd9 100644 --- a/service/codedeploy/api_op_GetDeploymentTarget.go +++ b/service/codedeploy/api_op_GetDeploymentTarget.go @@ -29,12 +29,12 @@ func (c *Client) GetDeploymentTarget(ctx context.Context, params *GetDeploymentT type GetDeploymentTargetInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. DeploymentId *string - // The unique ID of a deployment target. + // The unique ID of a deployment target. // // This member is required. TargetId *string @@ -44,7 +44,7 @@ type GetDeploymentTargetInput struct { type GetDeploymentTargetOutput struct { - // A deployment target that contains information about a deployment such as its + // 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 ). diff --git a/service/codedeploy/api_op_GetOnPremisesInstance.go b/service/codedeploy/api_op_GetOnPremisesInstance.go index 93120c0a3ee..ca89a798a4d 100644 --- a/service/codedeploy/api_op_GetOnPremisesInstance.go +++ b/service/codedeploy/api_op_GetOnPremisesInstance.go @@ -30,7 +30,7 @@ func (c *Client) GetOnPremisesInstance(ctx context.Context, params *GetOnPremise // Represents the input of a GetOnPremisesInstance operation. type GetOnPremisesInstanceInput struct { - // The name of the on-premises instance about which to get information. + // The name of the on-premises instance about which to get information. // // This member is required. InstanceName *string @@ -41,7 +41,7 @@ type GetOnPremisesInstanceInput struct { // Represents the output of a GetOnPremisesInstance operation. type GetOnPremisesInstanceOutput struct { - // Information about the on-premises instance. + // Information about the on-premises instance. InstanceInfo *types.InstanceInfo // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_ListApplicationRevisions.go b/service/codedeploy/api_op_ListApplicationRevisions.go index 7fad29d4596..3a8485e66ac 100644 --- a/service/codedeploy/api_op_ListApplicationRevisions.go +++ b/service/codedeploy/api_op_ListApplicationRevisions.go @@ -30,17 +30,20 @@ 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 user or Amazon Web + // The name of an CodeDeploy application associated with the 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 + // 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. Deployed types.ListStateFilterAction @@ -48,28 +51,38 @@ type ListApplicationRevisionsInput struct { // be used to return the next set of applications in the list. NextToken *string - // An Amazon S3 bucket name to limit the search for revisions. If set to null, all - // of the user's buckets are searched. + // An Amazon S3 bucket name to limit the search for revisions. + // + // If set to null, all of the user's buckets are searched. S3Bucket *string - // A key prefix for the set of Amazon S3 objects to limit the search for revisions. + // A key prefix for the set of Amazon S3 objects to limit the search for + // revisions. 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. + // + // - 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: + // 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. + // + // 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 diff --git a/service/codedeploy/api_op_ListDeploymentInstances.go b/service/codedeploy/api_op_ListDeploymentInstances.go index 24d7cb621d1..525b7a1325c 100644 --- a/service/codedeploy/api_op_ListDeploymentInstances.go +++ b/service/codedeploy/api_op_ListDeploymentInstances.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The newer BatchGetDeploymentTargets should be used instead because it works +// 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 user or Amazon Web Services -// account. +// used with a compute platform other than EC2/On-premises or Lambda. +// +// Lists the instance for a deployment associated with the 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) { @@ -36,18 +38,23 @@ func (c *Client) ListDeploymentInstances(ctx context.Context, params *ListDeploy // Represents the input of a ListDeploymentInstances operation. type ListDeploymentInstancesInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. 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. + // + // - 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 diff --git a/service/codedeploy/api_op_ListDeploymentTargets.go b/service/codedeploy/api_op_ListDeploymentTargets.go index 199a680eb5a..12bdec1b971 100644 --- a/service/codedeploy/api_op_ListDeploymentTargets.go +++ b/service/codedeploy/api_op_ListDeploymentTargets.go @@ -28,18 +28,20 @@ func (c *Client) ListDeploymentTargets(ctx context.Context, params *ListDeployme type ListDeploymentTargetsInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. DeploymentId *string - // A token identifier returned from the previous ListDeploymentTargets call. It + // 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: + // 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 . TargetFilters map[string][]string @@ -49,12 +51,12 @@ type ListDeploymentTargetsInput struct { type ListDeploymentTargetsOutput struct { - // If a large amount of information is returned, a token identifier is also + // If a large amount of information is returned, a token identifier is also // returned. It can be used in a subsequent ListDeploymentTargets call to return // the next set of deployment targets in the list. NextToken *string - // The unique IDs of deployment targets. + // The unique IDs of deployment targets. TargetIds []string // Metadata pertaining to the operation's result. diff --git a/service/codedeploy/api_op_ListDeployments.go b/service/codedeploy/api_op_ListDeployments.go index d351d046d6b..77b9d55316a 100644 --- a/service/codedeploy/api_op_ListDeployments.go +++ b/service/codedeploy/api_op_ListDeployments.go @@ -32,17 +32,19 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp type ListDeploymentsInput struct { // The name of an CodeDeploy application associated with the 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. + // Services account. + // + // If applicationName is specified, then deploymentGroupName must be specified. If + // it is not specified, then deploymentGroupName must not be specified. ApplicationName *string // A time range (start and end) for returning a subset of the list of deployments. CreateTimeRange *types.TimeRange - // The name of a deployment group for the specified application. If - // deploymentGroupName is specified, then applicationName must be specified. If it - // is not specified, then applicationName must not be specified. + // The name of a deployment group for the specified application. + // + // If deploymentGroupName is specified, then applicationName must be specified. If + // it is not specified, then applicationName must not be specified. DeploymentGroupName *string // The unique ID of an external resource for returning deployments linked to the @@ -50,11 +52,17 @@ 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. IncludeOnlyStatuses []types.DeploymentStatus diff --git a/service/codedeploy/api_op_ListOnPremisesInstances.go b/service/codedeploy/api_op_ListOnPremisesInstances.go index 43091e74870..99e0956f813 100644 --- a/service/codedeploy/api_op_ListOnPremisesInstances.go +++ b/service/codedeploy/api_op_ListOnPremisesInstances.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of names for one or more on-premises instances. Unless otherwise -// specified, both registered and deregistered on-premises instance names are -// listed. To list only registered or deregistered on-premises instance names, use -// the registration status parameter. +// Gets a list of names for one or more on-premises instances. +// +// Unless otherwise specified, both registered and deregistered on-premises +// instance names are listed. To list only registered or deregistered on-premises +// instance names, use the registration status parameter. func (c *Client) ListOnPremisesInstances(ctx context.Context, params *ListOnPremisesInstancesInput, optFns ...func(*Options)) (*ListOnPremisesInstancesOutput, error) { if params == nil { params = &ListOnPremisesInstancesInput{} @@ -38,8 +39,10 @@ type ListOnPremisesInstancesInput struct { 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. RegistrationStatus types.RegistrationStatus diff --git a/service/codedeploy/api_op_ListTagsForResource.go b/service/codedeploy/api_op_ListTagsForResource.go index be2f750c137..0cab5103eac 100644 --- a/service/codedeploy/api_op_ListTagsForResource.go +++ b/service/codedeploy/api_op_ListTagsForResource.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of tags for the resource identified by a specified Amazon +// Returns a list of tags for the resource identified by a specified Amazon +// // Resource Name (ARN). Tags are used to organize and categorize your CodeDeploy // resources. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { @@ -31,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 + // The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags // associated with the resource that is identified by the ResourceArn . // // This member is required. @@ -51,7 +52,7 @@ type ListTagsForResourceOutput struct { // next set of application revisions in the list. NextToken *string - // A list of tags returned by ListTagsForResource . The tags are associated with + // A list of tags returned by ListTagsForResource . The tags are associated with // the resource identified by the input ResourceArn parameter. Tags []types.Tag diff --git a/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go b/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go index 1b9ff8572b3..fba66e87f18 100644 --- a/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go +++ b/service/codedeploy/api_op_PutLifecycleEventHookExecutionStatus.go @@ -11,16 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the result of a Lambda validation function. The function validates +// 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) -// . +// validation functions return Succeeded or Failed . For more information, see [AppSpec 'hooks' Section for an Lambda Deployment] +// and [AppSpec 'hooks' Section for an Amazon ECS Deployment]. +// +// [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 +// [AppSpec 'hooks' Section for an Lambda Deployment]: https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-hooks.html#appspec-hooks-lambda func (c *Client) PutLifecycleEventHookExecutionStatus(ctx context.Context, params *PutLifecycleEventHookExecutionStatusInput, optFns ...func(*Options)) (*PutLifecycleEventHookExecutionStatusOutput, error) { if params == nil { params = &PutLifecycleEventHookExecutionStatusInput{} @@ -38,11 +40,11 @@ func (c *Client) PutLifecycleEventHookExecutionStatus(ctx context.Context, param type PutLifecycleEventHookExecutionStatusInput struct { - // The unique ID of a deployment. Pass this ID to a Lambda function that validates - // a deployment lifecycle event. + // The unique ID of a deployment. Pass this ID to a Lambda function that + // validates a deployment lifecycle event. DeploymentId *string - // The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook + // The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook // is specified in the hooks section of the AppSpec file. LifecycleEventHookExecutionId *string diff --git a/service/codedeploy/api_op_RegisterOnPremisesInstance.go b/service/codedeploy/api_op_RegisterOnPremisesInstance.go index d650ad43850..74678534e65 100644 --- a/service/codedeploy/api_op_RegisterOnPremisesInstance.go +++ b/service/codedeploy/api_op_RegisterOnPremisesInstance.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM -// user ARN) is supported in the request. You cannot use both. +// Registers an on-premises instance. +// +// Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the +// request. You cannot use both. func (c *Client) RegisterOnPremisesInstance(ctx context.Context, params *RegisterOnPremisesInstanceInput, optFns ...func(*Options)) (*RegisterOnPremisesInstanceOutput, error) { if params == nil { params = &RegisterOnPremisesInstanceInput{} diff --git a/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go b/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go index db2219c7d65..4e7f0877292 100644 --- a/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go +++ b/service/codedeploy/api_op_SkipWaitTimeForInstanceTermination.go @@ -32,7 +32,7 @@ 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 + // The unique ID of a blue/green deployment for which you want to skip the // instance termination wait time. DeploymentId *string diff --git a/service/codedeploy/api_op_StopDeployment.go b/service/codedeploy/api_op_StopDeployment.go index 0d42a3eebea..9ec0bb61b1c 100644 --- a/service/codedeploy/api_op_StopDeployment.go +++ b/service/codedeploy/api_op_StopDeployment.go @@ -30,12 +30,12 @@ func (c *Client) StopDeployment(ctx context.Context, params *StopDeploymentInput // Represents the input of a StopDeployment operation. type StopDeploymentInput struct { - // The unique ID of a deployment. + // The unique ID of a deployment. // // This member is required. DeploymentId *string - // Indicates, when a deployment is stopped, whether instances that have been + // Indicates, when a deployment is stopped, whether instances that have been // updated should be rolled back to the previous version of the application // revision. AutoRollbackEnabled *bool @@ -47,7 +47,9 @@ 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. Status types.StopStatus diff --git a/service/codedeploy/api_op_TagResource.go b/service/codedeploy/api_op_TagResource.go index ba153b8bfe7..01d868d9c0b 100644 --- a/service/codedeploy/api_op_TagResource.go +++ b/service/codedeploy/api_op_TagResource.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the list of tags in the input Tags parameter with the resource +// Associates the list of tags in the input Tags parameter with the resource +// // identified by the ResourceArn input parameter. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { @@ -30,12 +31,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ARN of a resource, such as a CodeDeploy application or deployment group. + // The ARN of a resource, such as a CodeDeploy application or deployment group. // // This member is required. ResourceArn *string - // A list of tags that TagResource associates with a resource. The resource is + // A list of tags that TagResource associates with a resource. The resource is // identified by the ResourceArn input parameter. // // This member is required. diff --git a/service/codedeploy/api_op_UntagResource.go b/service/codedeploy/api_op_UntagResource.go index b892481e226..ead3683c9b0 100644 --- a/service/codedeploy/api_op_UntagResource.go +++ b/service/codedeploy/api_op_UntagResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a resource from a list of tags. The resource is identified by the -// ResourceArn input parameter. The tags are identified by the list of keys in the -// TagKeys input parameter. +// Disassociates a resource from a list of tags. The resource is identified by +// +// the ResourceArn input parameter. The tags are identified by the list of keys in +// the TagKeys input parameter. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -30,13 +31,13 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) that specifies from which resource to + // The Amazon Resource Name (ARN) that specifies from which resource to // disassociate the tags with the keys in the TagKeys input parameter. // // This member is required. ResourceArn *string - // A list of keys of Tag objects. The Tag objects identified by the keys are + // A list of keys of Tag objects. The Tag objects identified by the keys are // disassociated from the resource specified by the ResourceArn input parameter. // // This member is required. diff --git a/service/codedeploy/api_op_UpdateDeploymentGroup.go b/service/codedeploy/api_op_UpdateDeploymentGroup.go index 76c6d7fab96..b126d8dd213 100644 --- a/service/codedeploy/api_op_UpdateDeploymentGroup.go +++ b/service/codedeploy/api_op_UpdateDeploymentGroup.go @@ -50,13 +50,15 @@ 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/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat) - // in the CodeDeploy User Guide. + // hooks. For examples, see [Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout"]in the CodeDeploy User Guide. + // + // [Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout"]: https://docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat AutoScalingGroups []string // Information about blue/green deployment options for a deployment group. @@ -79,7 +81,7 @@ type UpdateDeploymentGroupInput struct { // groups. Ec2TagSet *types.EC2TagSet - // The target Amazon ECS services in the deployment group. This applies only to + // 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 : . @@ -101,33 +103,42 @@ type UpdateDeploymentGroupInput struct { 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. + // 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 // This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto - // Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto - // Scaling (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html) - // in the CodeDeploy User Guide. Set terminationHookEnabled to true to have - // CodeDeploy install a termination hook into your Auto Scaling group when you - // update a deployment group. When this hook is installed, CodeDeploy will perform - // termination deployments. For information about termination deployments, see - // Enabling termination deployments during Auto Scaling scale-in events (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable) - // in the CodeDeploy User Guide. For more information about Auto Scaling scale-in - // events, see the Scale in (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in) - // topic in the Amazon EC2 Auto Scaling User Guide. + // Scaling. For more information, see [Integrating CodeDeploy with Amazon EC2 Auto Scaling]in the CodeDeploy User Guide. + // + // Set terminationHookEnabled to true to have CodeDeploy install a termination + // hook into your Auto Scaling group when you update a deployment group. When this + // hook is installed, CodeDeploy will perform termination deployments. + // + // For information about termination deployments, see [Enabling termination deployments during Auto Scaling scale-in events] in the CodeDeploy User + // Guide. + // + // For more information about Auto Scaling scale-in events, see the [Scale in] topic in the + // Amazon EC2 Auto Scaling User Guide. + // + // [Enabling termination deployments during Auto Scaling scale-in events]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable + // [Integrating CodeDeploy with Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html + // [Scale in]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in TerminationHookEnabled *bool // 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) - // in the CodeDeploy User Guide. + // examples, see [Edit a Trigger in a CodeDeploy Deployment Group]in the CodeDeploy User Guide. + // + // [Edit a Trigger in a CodeDeploy Deployment Group]: https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html TriggerConfigurations []types.TriggerConfig noSmithyDocumentSerde diff --git a/service/codedeploy/doc.go b/service/codedeploy/doc.go index 1a3849fba40..8e9530b7bcf 100644 --- a/service/codedeploy/doc.go +++ b/service/codedeploy/doc.go @@ -5,22 +5,30 @@ // // CodeDeploy is a deployment service that automates application deployments to // Amazon EC2 instances, on-premises instances running in your own facility, -// serverless Lambda functions, or applications in an Amazon ECS service. You can -// deploy a nearly unlimited variety of application content, such as an updated -// Lambda function, updated applications in an Amazon ECS service, code, web and -// configuration files, executables, packages, scripts, multimedia files, and so -// on. CodeDeploy can deploy application content stored in Amazon S3 buckets, -// GitHub repositories, or Bitbucket repositories. You do not need to make changes -// to your existing code before you can use CodeDeploy. CodeDeploy makes it easier -// for you to rapidly release new features, helps you avoid downtime during -// application deployment, and handles the complexity of updating your -// 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: +// serverless Lambda functions, or applications in an Amazon ECS service. +// +// You can deploy a nearly unlimited variety of application content, such as an +// updated Lambda function, updated applications in an Amazon ECS service, code, +// web and configuration files, executables, packages, scripts, multimedia files, +// and so on. CodeDeploy can deploy application content stored in Amazon S3 +// buckets, GitHub repositories, or Bitbucket repositories. You do not need to make +// changes to your existing code before you can use CodeDeploy. +// +// CodeDeploy makes it easier for you to rapidly release new features, helps you +// avoid downtime during application deployment, and handles the complexity of +// updating your 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 @@ -30,11 +38,14 @@ // 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 @@ -49,10 +60,20 @@ // 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) +// to get details about Amazon ECS service deployments. +// +// # CodeDeploy Information Resources +// +// [CodeDeploy User Guide] +// +// [CodeDeploy API Reference Guide] +// +// [CLI Reference for CodeDeploy] +// +// [CodeDeploy Developer Forum] +// +// [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/options.go b/service/codedeploy/options.go index 33557f60913..56ad5c94f72 100644 --- a/service/codedeploy/options.go +++ b/service/codedeploy/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codedeploy/types/enums.go b/service/codedeploy/types/enums.go index f57d9454f6a..e261e79752b 100644 --- a/service/codedeploy/types/enums.go +++ b/service/codedeploy/types/enums.go @@ -13,6 +13,7 @@ const ( // Values returns all known values for ApplicationRevisionSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationRevisionSortBy) Values() []ApplicationRevisionSortBy { return []ApplicationRevisionSortBy{ @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for AutoRollbackEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoRollbackEvent) Values() []AutoRollbackEvent { return []AutoRollbackEvent{ "DEPLOYMENT_FAILURE", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for BundleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BundleType) Values() []BundleType { return []BundleType{ "tar", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for ComputePlatform. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputePlatform) Values() []ComputePlatform { return []ComputePlatform{ "Server", @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for DeploymentCreator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentCreator) Values() []DeploymentCreator { return []DeploymentCreator{ "user", @@ -125,8 +130,9 @@ const ( ) // Values returns all known values for DeploymentOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentOption) Values() []DeploymentOption { return []DeploymentOption{ "WITH_TRAFFIC_CONTROL", @@ -143,8 +149,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CONTINUE_DEPLOYMENT", @@ -167,8 +174,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "Created", @@ -193,8 +201,9 @@ const ( ) // Values returns all known values for DeploymentTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentTargetType) Values() []DeploymentTargetType { return []DeploymentTargetType{ "InstanceTarget", @@ -213,8 +222,9 @@ const ( ) // Values returns all known values for DeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentType) Values() []DeploymentType { return []DeploymentType{ "IN_PLACE", @@ -231,8 +241,9 @@ const ( ) // Values returns all known values for DeploymentWaitType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentWaitType) Values() []DeploymentWaitType { return []DeploymentWaitType{ "READY_WAIT", @@ -250,8 +261,9 @@ const ( ) // Values returns all known values for EC2TagFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EC2TagFilterType) Values() []EC2TagFilterType { return []EC2TagFilterType{ "KEY_ONLY", @@ -301,8 +313,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -352,8 +365,9 @@ const ( ) // Values returns all known values for FileExistsBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileExistsBehavior) Values() []FileExistsBehavior { return []FileExistsBehavior{ "DISALLOW", @@ -372,8 +386,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GreenFleetProvisioningAction) Values() []GreenFleetProvisioningAction { return []GreenFleetProvisioningAction{ "DISCOVER_EXISTING", @@ -390,8 +405,9 @@ const ( ) // Values returns all known values for InstanceAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceAction) Values() []InstanceAction { return []InstanceAction{ "TERMINATE", @@ -413,8 +429,9 @@ const ( ) // Values returns all known values for InstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStatus) Values() []InstanceStatus { return []InstanceStatus{ "Pending", @@ -436,8 +453,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -458,8 +476,9 @@ const ( ) // Values returns all known values for LifecycleErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleErrorCode) Values() []LifecycleErrorCode { return []LifecycleErrorCode{ "Success", @@ -484,8 +503,9 @@ const ( ) // Values returns all known values for LifecycleEventStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleEventStatus) Values() []LifecycleEventStatus { return []LifecycleEventStatus{ "Pending", @@ -507,8 +527,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "include", @@ -527,8 +548,9 @@ const ( // Values returns all known values for MinimumHealthyHostsPerZoneType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MinimumHealthyHostsPerZoneType) Values() []MinimumHealthyHostsPerZoneType { return []MinimumHealthyHostsPerZoneType{ "HOST_COUNT", @@ -545,8 +567,9 @@ const ( ) // Values returns all known values for MinimumHealthyHostsType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MinimumHealthyHostsType) Values() []MinimumHealthyHostsType { return []MinimumHealthyHostsType{ "HOST_COUNT", @@ -564,6 +587,7 @@ const ( // Values returns all known values for OutdatedInstancesStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OutdatedInstancesStrategy) Values() []OutdatedInstancesStrategy { return []OutdatedInstancesStrategy{ @@ -581,8 +605,9 @@ const ( ) // Values returns all known values for RegistrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationStatus) Values() []RegistrationStatus { return []RegistrationStatus{ "Registered", @@ -601,8 +626,9 @@ const ( ) // Values returns all known values for RevisionLocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RevisionLocationType) Values() []RevisionLocationType { return []RevisionLocationType{ "S3", @@ -621,8 +647,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -639,8 +666,9 @@ const ( ) // Values returns all known values for StopStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StopStatus) Values() []StopStatus { return []StopStatus{ "Pending", @@ -658,8 +686,9 @@ const ( ) // Values returns all known values for TagFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TagFilterType) Values() []TagFilterType { return []TagFilterType{ "KEY_ONLY", @@ -677,8 +706,9 @@ const ( ) // Values returns all known values for TargetFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetFilterName) Values() []TargetFilterName { return []TargetFilterName{ "TargetStatus", @@ -695,8 +725,9 @@ const ( ) // Values returns all known values for TargetLabel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetLabel) Values() []TargetLabel { return []TargetLabel{ "Blue", @@ -718,8 +749,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -742,8 +774,9 @@ const ( ) // Values returns all known values for TrafficRoutingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficRoutingType) Values() []TrafficRoutingType { return []TrafficRoutingType{ "TimeBasedCanary", @@ -769,8 +802,9 @@ const ( ) // Values returns all known values for TriggerEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerEventType) Values() []TriggerEventType { return []TriggerEventType{ "DeploymentStart", diff --git a/service/codedeploy/types/errors.go b/service/codedeploy/types/errors.go index b82756c4e75..5cde5083893 100644 --- a/service/codedeploy/types/errors.go +++ b/service/codedeploy/types/errors.go @@ -138,7 +138,8 @@ func (e *ApplicationNameRequiredException) ErrorCode() string { } func (e *ApplicationNameRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified ARN is not supported. For example, it might be an ARN for a +// The specified ARN is not supported. For example, it might be an ARN for a +// // resource that is not expected. type ArnNotSupportedException struct { Message *string @@ -687,7 +688,8 @@ func (e *DeploymentTargetIdRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The maximum number of targets that can be associated with an Amazon ECS or +// The maximum number of targets that can be associated with an Amazon ECS or +// // Lambda deployment was exceeded. The target list of both types of deployments // must have exactly one item. This exception does not apply to EC2/On-premises // deployments. @@ -744,7 +746,8 @@ func (e *DescriptionTooLongException) ErrorCode() string { } func (e *DescriptionTooLongException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Amazon ECS service is associated with more than one deployment groups. An +// The Amazon ECS service is associated with more than one deployment groups. An +// // Amazon ECS service can be associated with only one deployment group. type ECSServiceMappingLimitExceededException struct { Message *string @@ -1099,10 +1102,15 @@ 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. type InvalidAlarmConfigException struct { Message *string @@ -1238,8 +1246,7 @@ 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 . +// invalid format. For information about deployment configuration format, see CreateDeploymentConfig. type InvalidBlueGreenDeploymentConfigurationException struct { Message *string @@ -2433,10 +2440,14 @@ 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. type InvalidTargetInstancesException struct { Message *string @@ -2489,7 +2500,8 @@ func (e *InvalidTimeRangeException) ErrorCode() string { } func (e *InvalidTimeRangeException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The configuration that specifies how traffic is routed during a deployment is +// The configuration that specifies how traffic is routed during a deployment is +// // invalid. type InvalidTrafficRoutingConfigurationException struct { Message *string diff --git a/service/codedeploy/types/types.go b/service/codedeploy/types/types.go index 2f3f2c47725..a3b21119734 100644 --- a/service/codedeploy/types/types.go +++ b/service/codedeploy/types/types.go @@ -30,8 +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. IgnorePollAlarmFailure bool @@ -65,23 +67,28 @@ type ApplicationInfo struct { noSmithyDocumentSerde } -// A revision for an Lambda or Amazon ECS deployment that is a YAML-formatted or +// 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. type AppSpecContent struct { - // The YAML-formatted or JSON-formatted revision string. For an Lambda deployment, - // the content includes a Lambda function name, the alias for its original version, - // and the alias for its replacement version. The deployment shifts traffic from - // the original version of the Lambda function to the replacement version. For an - // 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. + // The YAML-formatted or JSON-formatted revision string. + // + // For an Lambda deployment, the content includes a Lambda function name, the + // alias for its original version, and the alias for its replacement version. The + // deployment shifts traffic from the original version of the Lambda function to + // the replacement version. + // + // For an 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. Content *string - // The SHA256 hash value of the revision content. + // The SHA256 hash value of the revision content. Sha256 *string noSmithyDocumentSerde @@ -106,18 +113,23 @@ type AutoRollbackConfiguration struct { type AutoScalingGroup struct { // The name of the launch hook that CodeDeploy installed into the Auto Scaling - // group. For more information about the launch hook, see How Amazon EC2 Auto - // Scaling works with CodeDeploy (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors) - // in the CodeDeploy User Guide. + // group. + // + // For more information about the launch hook, see [How Amazon EC2 Auto Scaling works with CodeDeploy] in the CodeDeploy User Guide. + // + // [How Amazon EC2 Auto Scaling works with CodeDeploy]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors Hook *string // The Auto Scaling group name. Name *string // The name of the termination hook that CodeDeploy installed into the Auto - // Scaling group. For more information about the termination hook, see Enabling - // termination deployments during Auto Scaling scale-in events (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable) - // in the CodeDeploy User Guide. + // Scaling group. + // + // For more information about the termination hook, see [Enabling termination deployments during Auto Scaling scale-in events] in the CodeDeploy User + // Guide. + // + // [Enabling termination deployments during Auto Scaling scale-in events]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable TerminationHook *string noSmithyDocumentSerde @@ -148,23 +160,29 @@ 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. Action InstanceAction // For an Amazon EC2 deployment, the number of minutes to wait after a successful // blue/green deployment before terminating instances from the original - // environment. For an Amazon ECS deployment, the number of minutes before deleting - // the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts - // traffic from the original (blue) task set to a replacement (green) task set. The - // maximum setting is 2880 minutes (2 days). + // environment. + // + // For an Amazon ECS deployment, the number of minutes before deleting the + // original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts + // traffic from the original (blue) task set to a replacement (green) task set. + // + // The maximum setting is 2880 minutes (2 days). TerminationWaitTimeInMinutes int32 noSmithyDocumentSerde } -// Information about the target to be updated by an CloudFormation blue/green +// Information about the target to be updated by an CloudFormation blue/green +// // deployment. This target type is used for all deployments initiated by a // CloudFormation stack update. type CloudFormationTarget struct { @@ -172,21 +190,21 @@ type CloudFormationTarget struct { // The unique ID of an CloudFormation blue/green deployment. DeploymentId *string - // The date and time when the target application was updated by an CloudFormation + // The date and time when the target application was updated by an CloudFormation // blue/green deployment. LastUpdatedAt *time.Time - // The lifecycle events of the CloudFormation blue/green deployment to this target - // application. + // The lifecycle events of the CloudFormation blue/green deployment to this + // target application. LifecycleEvents []LifecycleEvent // The resource type for the CloudFormation blue/green deployment. ResourceType *string - // The status of an CloudFormation blue/green deployment's target application. + // 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 @@ -268,7 +286,7 @@ type DeploymentGroupInfo struct { // groups. Cannot be used in the same call as ec2TagFilters. Ec2TagSet *EC2TagSet - // The target Amazon ECS services in the deployment group. This applies only to + // 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 : . @@ -293,18 +311,22 @@ type DeploymentGroupInfo struct { 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. + // 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) - // in the CodeDeploy User Guide. + // see [Create a Service Role for CodeDeploy]in the CodeDeploy User Guide. + // + // [Create a Service Role for CodeDeploy]: https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html ServiceRoleArn *string // Information about the deployment group's target revision, including type and @@ -312,10 +334,12 @@ type DeploymentGroupInfo struct { TargetRevision *RevisionLocation // Indicates whether the deployment group was configured to have CodeDeploy - // install a termination hook into an Auto Scaling group. For more information - // about the termination hook, see How Amazon EC2 Auto Scaling works with - // CodeDeploy (https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors) - // in the CodeDeploy User Guide. + // install a termination hook into an Auto Scaling group. + // + // For more information about the termination hook, see [How Amazon EC2 Auto Scaling works with CodeDeploy] in the CodeDeploy User + // Guide. + // + // [How Amazon EC2 Auto Scaling works with CodeDeploy]: https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors TerminationHookEnabled bool // Information about triggers associated with the deployment group. @@ -355,20 +379,24 @@ type DeploymentInfo struct { 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. Creator DeploymentCreator - // The deployment configuration name. + // The deployment configuration name. DeploymentConfigName *string - // The deployment group name. + // The deployment group name. DeploymentGroupName *string - // The unique ID of a deployment. + // The unique ID of a deployment. DeploymentId *string // A summary of the deployment status of the instances in the deployment. @@ -394,33 +422,40 @@ 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. 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 - // 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. + // 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. IgnoreApplicationStopFailures bool // Indicates whether the wait period set for the termination of instances in the @@ -449,8 +484,10 @@ type DeploymentInfo struct { RollbackInfo *RollbackInfo // A timestamp that indicates when the deployment was deployed to the deployment - // group. In some cases, the reported value of the start time might be later than - // the complete time. This is due to differences in the clock settings of backend + // group. + // + // In some cases, the reported value of the start time might be later than the + // complete time. This is due to differences in the clock settings of backend // servers that participate in the deployment process. StartTime *time.Time @@ -500,13 +537,15 @@ 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. + // 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 @@ -533,7 +572,7 @@ type DeploymentStyle struct { // Information about the deployment target. type DeploymentTarget struct { - // Information about the target to be updated by an CloudFormation blue/green + // Information about the target to be updated by an CloudFormation blue/green // deployment. This target type is used for all deployments initiated by a // CloudFormation stack update. CloudFormationTarget *CloudFormationTarget @@ -542,15 +581,15 @@ type DeploymentTarget struct { // deployments initiated by a CloudFormation stack update. DeploymentTargetType DeploymentTargetType - // Information about the target for a deployment that uses the Amazon ECS compute + // Information about the target for a deployment that uses the Amazon ECS compute // platform. EcsTarget *ECSTarget - // Information about the target for a deployment that uses the EC2/On-premises + // Information about the target for a deployment that uses the EC2/On-premises // compute platform. InstanceTarget *InstanceTarget - // Information about the target for a deployment that uses the Lambda compute + // Information about the target for a deployment that uses the Lambda compute // platform. LambdaTarget *LambdaTarget @@ -561,19 +600,25 @@ 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. + // + // - 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 - // the last 4 KB of the diagnostic log. + // The last portion of the diagnostic log. + // + // If available, CodeDeploy returns up to the last 4 KB of the diagnostic log. LogTail *string // The message associated with the error. @@ -592,8 +637,11 @@ type EC2TagFilter struct { Key *string // The tag filter type: + // // - KEY_ONLY : Key only. + // // - VALUE_ONLY : Value only. + // // - KEY_AND_VALUE : Key and value. Type EC2TagFilterType @@ -614,14 +662,15 @@ type EC2TagSet struct { noSmithyDocumentSerde } -// Contains the service and cluster names used to identify an Amazon ECS +// Contains the service and cluster names used to identify an Amazon ECS +// // deployment's target. type ECSService struct { - // The name of the cluster that the Amazon ECS service is associated with. + // The name of the cluster that the Amazon ECS service is associated with. ClusterName *string - // The name of the target Amazon ECS service. + // The name of the target Amazon ECS service. ServiceName *string noSmithyDocumentSerde @@ -630,73 +679,78 @@ type ECSService struct { // Information about the target of an Amazon ECS deployment. type ECSTarget struct { - // The unique ID of a deployment. + // The unique ID of a deployment. DeploymentId *string - // The date and time when the target Amazon ECS application was updated by a + // The date and time when the target Amazon ECS application was updated by a // deployment. LastUpdatedAt *time.Time - // The lifecycle events of the deployment to this target Amazon ECS application. + // The lifecycle events of the deployment to this target Amazon ECS application. LifecycleEvents []LifecycleEvent - // The status an Amazon ECS deployment's target ECS application. + // The status an Amazon ECS deployment's target ECS application. Status TargetStatus - // The Amazon Resource Name (ARN) of the target. + // 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. + // The ECSTaskSet objects associated with the ECS target. TaskSetsInfo []ECSTaskSet noSmithyDocumentSerde } -// Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An +// Information about a set of Amazon ECS tasks in an CodeDeploy deployment. An +// // Amazon ECS task set includes details such as the desired number of tasks, how // many tasks are running, and whether the task set serves production traffic. An // CodeDeploy application that uses the Amazon ECS compute platform deploys a // containerized application in an Amazon ECS service as a task set. type ECSTaskSet struct { - // The number of tasks in a task set. During a deployment that uses the Amazon ECS - // compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses - // this value to determine how many tasks to create. After the updated task set is - // created, CodeDeploy shifts traffic to the new task set. + // The number of tasks in a task set. During a deployment that uses the Amazon + // ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and + // uses this value to determine how many tasks to create. After the updated task + // set is 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 + // The number of tasks in the task set that are in the PENDING status during an // Amazon ECS 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 is restarted after being in the STOPPED state. PendingCount int64 - // The number of tasks in the task set that are in the RUNNING status during an - // Amazon ECS deployment. A task in the RUNNING state is running and ready for use. + // The number of tasks in the task set that are in the RUNNING status during an + // Amazon ECS deployment. A task in the RUNNING state is running and ready for + // use. RunningCount int64 - // The status of the task set. There are three valid task set statuses: + // 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. Status *string - // The target group associated with the task set. The target group is used by + // 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 ) + // 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. + // The percentage of traffic served by this task set. TrafficWeight float64 noSmithyDocumentSerde @@ -721,32 +775,48 @@ 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: + // For more information, see [Error Codes for CodeDeploy] in the [CodeDeploy User Guide]. + // + // 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. + // + // [CodeDeploy User Guide]: https://docs.aws.amazon.com/codedeploy/latest/userguide + // [Error Codes for CodeDeploy]: https://docs.aws.amazon.com/codedeploy/latest/userguide/error-codes.html Code ErrorCode // An accompanying error message. @@ -784,8 +854,9 @@ type GitHubLocation struct { CommitId *string // The GitHub account and repository pair that stores a reference to the commit - // that represents the bundled artifacts for the application revision. Specified as - // account/repository. + // that represents the bundled artifacts for the application revision. + // + // Specified as account/repository. Repository *string noSmithyDocumentSerde @@ -796,8 +867,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. Action GreenFleetProvisioningAction @@ -836,7 +909,7 @@ type InstanceInfo struct { // Information about an instance in a deployment. type InstanceSummary struct { - // The unique ID of a deployment. + // The unique ID of a deployment. DeploymentId *string // The instance ID. @@ -844,7 +917,9 @@ 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. InstanceType InstanceType @@ -855,11 +930,17 @@ 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. // // Deprecated: InstanceStatus is deprecated, use TargetStatus instead. @@ -868,30 +949,31 @@ type InstanceSummary struct { noSmithyDocumentSerde } -// A target Amazon EC2 or on-premises instance during a deployment that uses the +// A target Amazon EC2 or on-premises instance during a deployment that uses the +// // EC2/On-premises compute platform. type InstanceTarget struct { - // The unique ID of a deployment. + // 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. + // The date and time when the target instance was updated by a deployment. LastUpdatedAt *time.Time - // The lifecycle events of the deployment to this target instance. + // The lifecycle events of the deployment to this target instance. LifecycleEvents []LifecycleEvent - // The status an EC2/On-premises deployment's target instance. + // The status an EC2/On-premises deployment's target instance. Status TargetStatus - // The Amazon Resource Name (ARN) of the target. + // 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 @@ -900,22 +982,23 @@ type InstanceTarget struct { // Information about a Lambda function specified in a deployment. type LambdaFunctionInfo struct { - // The version of a Lambda function that production traffic points to. + // The version of a Lambda function that production traffic points to. CurrentVersion *string - // The alias of a Lambda function. For more information, see Lambda Function - // Aliases (https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html) in the - // Lambda Developer Guide. + // The alias of a Lambda function. For more information, see [Lambda Function Aliases] in the Lambda + // Developer Guide. + // + // [Lambda Function Aliases]: https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html FunctionAlias *string - // The name of a Lambda function. + // The name of a Lambda function. FunctionName *string - // The version of a Lambda function that production traffic points to after the + // The version of a Lambda function that production traffic points to after the // Lambda function is deployed. TargetVersion *string - // The percentage of production traffic that the target version of a Lambda + // The percentage of production traffic that the target version of a Lambda // function receives. TargetVersionWeight float64 @@ -925,25 +1008,25 @@ type LambdaFunctionInfo struct { // Information about the target Lambda function during an Lambda deployment. type LambdaTarget struct { - // The unique ID of a deployment. + // The unique ID of a deployment. DeploymentId *string - // A LambdaFunctionInfo object that describes a target Lambda function. + // A LambdaFunctionInfo object that describes a target Lambda function. LambdaFunctionInfo *LambdaFunctionInfo - // The date and time when the target Lambda function was updated by a deployment. + // The date and time when the target Lambda function was updated by a deployment. LastUpdatedAt *time.Time - // The lifecycle events of the deployment to this target Lambda function. + // The lifecycle events of the deployment to this target Lambda function. LifecycleEvents []LifecycleEvent - // The status an Lambda deployment's target Lambda function. + // The status an Lambda deployment's target Lambda function. Status TargetStatus - // The Amazon Resource Name (ARN) of the target. + // 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 @@ -957,7 +1040,7 @@ type LastDeploymentInfo struct { // group started. CreateTime *time.Time - // The unique ID of a deployment. + // The unique ID of a deployment. DeploymentId *string // A timestamp that indicates when the most recent deployment to the deployment @@ -987,11 +1070,17 @@ type LifecycleEvent struct { 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. Status LifecycleEventStatus @@ -999,15 +1088,20 @@ type LifecycleEvent struct { } // Information about the Elastic Load Balancing load balancer or target group used -// in a deployment. You can use load balancers and target groups in combination. -// For example, if you have two Classic Load Balancers, and five target groups tied -// to an Application Load Balancer, you can specify the two Classic Load Balancers -// in elbInfoList , and the five target groups in targetGroupInfoList . +// in a deployment. +// +// You can use load balancers and target groups in combination. For example, if +// you have two Classic Load Balancers, and five target groups tied to an +// Application Load Balancer, you can specify the two Classic Load Balancers in +// elbInfoList , and the five target groups in targetGroupInfoList . type LoadBalancerInfo struct { // An array that contains information about the load balancers to use for load // balancing in a deployment. If you're using Classic Load Balancers, specify those - // load balancers in this array. You can add up to 10 load balancers to the array. + // load balancers in this array. + // + // You can add up to 10 load balancers to the array. + // // If you're using Application Load Balancers or Network Load Balancers, use the // targetGroupInfoList array instead of this one. ElbInfoList []ELBInfo @@ -1015,11 +1109,14 @@ type LoadBalancerInfo struct { // An array that contains information about the target groups to use for load // balancing in a deployment. If you're using Application Load Balancers and // Network Load Balancers, specify their associated target groups in this array. - // You can add up to 10 target groups to the array. If you're using Classic Load - // Balancers, use the elbInfoList array instead of this one. + // + // You can add up to 10 target groups to the array. + // + // If you're using Classic Load Balancers, use the elbInfoList array instead of + // this one. TargetGroupInfoList []TargetGroupInfo - // The target group pair information. This is an array of TargeGroupPairInfo + // The target group pair information. This is an array of TargeGroupPairInfo // objects with a maximum size of one. TargetGroupPairInfoList []TargetGroupPairInfo @@ -1030,25 +1127,32 @@ 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) - // in the CodeDeploy User Guide. + // 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] in the CodeDeploy User Guide. + // + // [CodeDeploy Instance Health]: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html Type MinimumHealthyHostsType // The minimum healthy instance value. @@ -1124,7 +1228,7 @@ type RevisionInfo struct { // Information about the location of an application revision. type RevisionLocation struct { - // The content of an AppSpec file for an Lambda or Amazon ECS deployment. The + // The content of an AppSpec file for an Lambda or Amazon ECS deployment. The // content is formatted as JSON or YAML and stored as a RawString. AppSpecContent *AppSpecContent @@ -1132,11 +1236,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). + // + // - 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. @@ -1180,16 +1287,23 @@ 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. + // // - YAML : A YAML-formatted file. + // // - JSON : A JSON-formatted file. BundleType BundleType // The ETag of the Amazon S3 object that represents the bundled artifacts for the - // application revision. If the ETag is not specified as an input parameter, ETag - // validation of the object is skipped. + // application revision. + // + // If the ETag is not specified as an input parameter, ETag validation of the + // object is skipped. ETag *string // The name of the Amazon S3 object that represents the bundled artifacts for the @@ -1197,8 +1311,10 @@ type S3Location struct { 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. + // artifacts for the application revision. + // + // If the version is not specified, the system uses the most recent version by + // default. Version *string noSmithyDocumentSerde @@ -1223,8 +1339,11 @@ 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. Type TagFilterType @@ -1250,20 +1369,21 @@ type TargetGroupInfo struct { noSmithyDocumentSerde } -// Information about two target groups and how traffic is routed during an Amazon +// Information about two target groups and how traffic is routed during an Amazon +// // ECS deployment. An optional test traffic route can be specified. type TargetGroupPairInfo struct { - // The path used by a load balancer to route production traffic when an Amazon ECS - // deployment is complete. + // The path used by a load balancer to route production traffic when an Amazon + // ECS deployment is complete. ProdTrafficRoute *TrafficRoute - // One pair of target groups. One is associated with the original task set. The + // One pair of target groups. One is associated with the original task set. The // second is associated with the task set that serves traffic after the deployment // is complete. TargetGroups []TargetGroupInfo - // An optional path used by a load balancer to route test traffic after an Amazon + // An optional path used by a load balancer to route test traffic after an Amazon // ECS deployment. Validation can occur while test traffic is served during a // deployment. TestTrafficRoute *TrafficRoute @@ -1329,21 +1449,25 @@ type TimeBasedLinear struct { // Information about a time range. type TimeRange struct { - // The end time of the time range. Specify null to leave the end time open-ended. + // The end time of the time range. + // + // Specify null to leave the end time open-ended. End *time.Time - // The start time of the time range. Specify null to leave the start time - // open-ended. + // The start time of the time range. + // + // Specify null to leave the start time open-ended. Start *time.Time noSmithyDocumentSerde } -// Information about a listener. The listener contains the path used to route +// Information about a listener. The listener contains the path used to route +// // traffic that is received from the load balancer to a target group. type TrafficRoute struct { - // The Amazon Resource Name (ARN) of one listener. The listener identifies the + // The Amazon Resource Name (ARN) of one listener. The listener identifies the // route between a target group and a load balancer. This is an array of strings // with a maximum size of one. ListenerArns []string @@ -1392,14 +1516,17 @@ type TriggerConfig struct { } // Configure the ZonalConfig object if you want CodeDeploy to deploy your -// application to one Availability Zone (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones) -// at a time, within an Amazon Web Services Region. By deploying to one -// Availability Zone at a time, you can expose your deployment to a progressively -// larger audience as confidence in the deployment's performance and viability -// grows. If you don't configure the ZonalConfig object, CodeDeploy deploys your -// application to a random selection of hosts across a Region. For more information -// about the zonal configuration feature, see zonal configuration (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) -// in the CodeDeploy User Guide. +// application to one [Availability Zone]at a time, within an Amazon Web Services Region. By +// deploying to one Availability Zone at a time, you can expose your deployment to +// a progressively larger audience as confidence in the deployment's performance +// and viability grows. If you don't configure the ZonalConfig object, CodeDeploy +// deploys your application to a random selection of hosts across a Region. +// +// For more information about the zonal configuration feature, see [zonal configuration] in the +// CodeDeploy User Guide. +// +// [zonal configuration]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config +// [Availability Zone]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones type ZonalConfig struct { // The period of time, in seconds, that CodeDeploy must wait after completing a @@ -1408,20 +1535,27 @@ type ZonalConfig struct { // this option if you want to allow extra bake time for the first Availability // Zone. If you don't specify a value for firstZoneMonitorDurationInSeconds , then // CodeDeploy uses the monitorDurationInSeconds value for the first Availability - // Zone. For more information about the zonal configuration feature, see zonal - // configuration (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) - // in the CodeDeploy User Guide. + // Zone. + // + // For more information about the zonal configuration feature, see [zonal configuration] in the + // CodeDeploy User Guide. + // + // [zonal configuration]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config FirstZoneMonitorDurationInSeconds *int64 // The number or percentage of instances that must remain available per // Availability Zone during a deployment. This option works in conjunction with the - // MinimumHealthyHosts option. For more information, see About the minimum number - // of healthy hosts per Availability Zone (https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html#minimum-healthy-hosts-az) - // in the CodeDeploy User Guide. If you don't specify the - // minimumHealthyHostsPerZone option, then CodeDeploy uses a default value of 0 - // percent. For more information about the zonal configuration feature, see zonal - // configuration (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) - // in the CodeDeploy User Guide. + // MinimumHealthyHosts option. For more information, see [About the minimum number of healthy hosts per Availability Zone] in the CodeDeploy User + // Guide. + // + // If you don't specify the minimumHealthyHostsPerZone option, then CodeDeploy + // uses a default value of 0 percent. + // + // For more information about the zonal configuration feature, see [zonal configuration] in the + // CodeDeploy User Guide. + // + // [About the minimum number of healthy hosts per Availability Zone]: https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html#minimum-healthy-hosts-az + // [zonal configuration]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config MinimumHealthyHostsPerZone *MinimumHealthyHostsPerZone // The period of time, in seconds, that CodeDeploy must wait after completing a @@ -1430,9 +1564,12 @@ type ZonalConfig struct { // monitor duration to give the deployment some time to prove itself (or 'bake') in // one Availability Zone before it is released in the next zone. If you don't // specify a monitorDurationInSeconds , CodeDeploy starts deploying to the next - // Availability Zone immediately. For more information about the zonal - // configuration feature, see zonal configuration (https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) - // in the CodeDeploy User Guide. + // Availability Zone immediately. + // + // For more information about the zonal configuration feature, see [zonal configuration] in the + // CodeDeploy User Guide. + // + // [zonal configuration]: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config MonitorDurationInSeconds *int64 noSmithyDocumentSerde diff --git a/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go b/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go index 74508a98a6e..f21d5f330fe 100644 --- a/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go +++ b/service/codeguruprofiler/api_op_BatchGetFrameMetricData.go @@ -12,7 +12,8 @@ import ( "time" ) -// Returns the time series of values for a requested list of frame metrics from a +// Returns the time series of values for a requested list of frame metrics from a +// // time period. func (c *Client) BatchGetFrameMetricData(ctx context.Context, params *BatchGetFrameMetricDataInput, optFns ...func(*Options)) (*BatchGetFrameMetricDataOutput, error) { if params == nil { @@ -32,30 +33,30 @@ func (c *Client) BatchGetFrameMetricData(ctx context.Context, params *BatchGetFr // The structure representing the BatchGetFrameMetricDataRequest. type BatchGetFrameMetricDataInput struct { - // The name of the profiling group associated with the the frame metrics used to + // The name of the profiling group associated with the the frame metrics used to // return the time series values. // // This member is required. ProfilingGroupName *string - // The end time of the time period for the returned time series values. This is + // The end time of the time period for the returned time series values. 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 - // The details of the metrics that are used to request a time series of values. + // 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. + // 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 - // series values. This is specified using the ISO 8601 format. For example, + // The start time of the time period for the frame metrics used to return the + // time series values. 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 *time.Time @@ -64,8 +65,11 @@ 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 TargetResolution types.AggregationPeriod @@ -75,16 +79,16 @@ type BatchGetFrameMetricDataInput struct { // The structure representing the BatchGetFrameMetricDataResponse. type BatchGetFrameMetricDataOutput struct { - // The end time of the time period for the returned time series values. This is + // The end time of the time period for the returned time series values. 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 - // 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. + // 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. // // This member is required. EndTimes []types.TimestampStructure @@ -100,14 +104,17 @@ 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 // // This member is required. Resolution types.AggregationPeriod - // The start time of the time period for the returned time series values. This is + // The start time of the time period for the returned time series values. 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/codeguruprofiler/api_op_ConfigureAgent.go b/service/codeguruprofiler/api_op_ConfigureAgent.go index f5a6f199e64..21fce68cec0 100644 --- a/service/codeguruprofiler/api_op_ConfigureAgent.go +++ b/service/codeguruprofiler/api_op_ConfigureAgent.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by profiler agents to report their current state and to receive remote +// Used by profiler agents to report their current state and to receive remote +// // configuration updates. For example, ConfigureAgent can be used to tell an agent // whether to profile or not and for how long to return profiling data. func (c *Client) ConfigureAgent(ctx context.Context, params *ConfigureAgentInput, optFns ...func(*Options)) (*ConfigureAgentOutput, error) { @@ -32,31 +33,40 @@ func (c *Client) ConfigureAgent(ctx context.Context, params *ConfigureAgentInput // The structure representing the configureAgentRequest. type ConfigureAgentInput struct { - // The name of the profiling group for which the configured agent is collecting + // The name of the profiling group for which the configured agent is collecting // profiling data. // // This member is required. ProfilingGroupName *string - // A universally unique identifier (UUID) for a profiling instance. For example, + // 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 + // 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. Metadata map[string]string @@ -67,9 +77,10 @@ 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) - // object that specifies if an agent profiles or not and for how long to return - // profiling data. + // An [AgentConfiguration]AgentConfiguration object that specifies if an agent profiles or not and + // for how long to return profiling data. + // + // [AgentConfiguration]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html // // This member is required. Configuration *types.AgentConfiguration diff --git a/service/codeguruprofiler/api_op_CreateProfilingGroup.go b/service/codeguruprofiler/api_op_CreateProfilingGroup.go index 7033ae1e007..3b2730a9ef4 100644 --- a/service/codeguruprofiler/api_op_CreateProfilingGroup.go +++ b/service/codeguruprofiler/api_op_CreateProfilingGroup.go @@ -30,7 +30,7 @@ func (c *Client) CreateProfilingGroup(ctx context.Context, params *CreateProfili // The structure representing the createProfiliingGroupRequest. type CreateProfilingGroupInput struct { - // Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to + // Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to // prevent the accidental creation of duplicate profiling groups if there are // failures and retries. // @@ -42,17 +42,17 @@ type CreateProfilingGroupInput struct { // This member is required. ProfilingGroupName *string - // Specifies whether profiling is enabled or disabled for the created profiling + // Specifies whether profiling is enabled or disabled for the created profiling // group. AgentOrchestrationConfig *types.AgentOrchestrationConfig - // The compute platform of the profiling group. Use AWSLambda if your application + // The compute platform of the profiling group. Use AWSLambda if your application // runs on AWS Lambda. Use Default if your application runs on a compute platform // that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a // different platform. If not specified, Default is used. ComputePlatform types.ComputePlatform - // A list of tags to add to the created profiling group. + // A list of tags to add to the created profiling group. Tags map[string]string noSmithyDocumentSerde @@ -61,8 +61,10 @@ 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) - // object that contains information about the created profiling group. + // The returned [ProfilingGroupDescription]ProfilingGroupDescription object that contains information about + // the created profiling group. + // + // [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html // // This member is required. ProfilingGroup *types.ProfilingGroupDescription diff --git a/service/codeguruprofiler/api_op_DescribeProfilingGroup.go b/service/codeguruprofiler/api_op_DescribeProfilingGroup.go index 4c92cedb53c..9713396b79b 100644 --- a/service/codeguruprofiler/api_op_DescribeProfilingGroup.go +++ b/service/codeguruprofiler/api_op_DescribeProfilingGroup.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) -// object that contains information about the requested profiling group. +// Returns a [ProfilingGroupDescription]ProfilingGroupDescription object that contains information about the +// +// requested profiling group. +// +// [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html func (c *Client) DescribeProfilingGroup(ctx context.Context, params *DescribeProfilingGroupInput, optFns ...func(*Options)) (*DescribeProfilingGroupOutput, error) { if params == nil { params = &DescribeProfilingGroupInput{} @@ -31,7 +34,7 @@ func (c *Client) DescribeProfilingGroup(ctx context.Context, params *DescribePro // The structure representing the describeProfilingGroupRequest. type DescribeProfilingGroupInput struct { - // The name of the profiling group to get information about. + // The name of the profiling group to get information about. // // This member is required. ProfilingGroupName *string @@ -42,8 +45,10 @@ 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) - // object that contains information about the requested profiling group. + // The returned [ProfilingGroupDescription]ProfilingGroupDescription object that contains information about + // the requested profiling group. + // + // [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html // // This member is required. ProfilingGroup *types.ProfilingGroupDescription diff --git a/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go b/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go index d83f9fbf605..f562354832a 100644 --- a/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go +++ b/service/codeguruprofiler/api_op_GetFindingsReportAccountSummary.go @@ -11,9 +11,11 @@ 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) -// objects that contain analysis results for all profiling groups in your AWS -// account. +// Returns a list of [FindingsReportSummary]FindingsReportSummary objects that contain analysis results +// +// for all profiling groups in your AWS account. +// +// [FindingsReportSummary]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html func (c *Client) GetFindingsReportAccountSummary(ctx context.Context, params *GetFindingsReportAccountSummaryInput, optFns ...func(*Options)) (*GetFindingsReportAccountSummaryOutput, error) { if params == nil { params = &GetFindingsReportAccountSummaryInput{} @@ -49,9 +51,10 @@ type GetFindingsReportAccountSummaryInput struct { // The nextToken value returned from a previous paginated // GetFindingsReportAccountSummary 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. + // 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. NextToken *string noSmithyDocumentSerde @@ -60,9 +63,10 @@ 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) - // objects taht contain summaries of analysis results for all profiling groups in - // your AWS account. + // The return list of [FindingsReportSummary]FindingsReportSummary objects taht contain summaries of + // analysis results for all profiling groups in your AWS account. + // + // [FindingsReportSummary]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html // // This member is required. ReportSummaries []types.FindingsReportSummary diff --git a/service/codeguruprofiler/api_op_GetProfile.go b/service/codeguruprofiler/api_op_GetProfile.go index e6c4ffd5a55..427ecfd6fe4 100644 --- a/service/codeguruprofiler/api_op_GetProfile.go +++ b/service/codeguruprofiler/api_op_GetProfile.go @@ -11,40 +11,56 @@ import ( "time" ) -// Gets the aggregated profile of a profiling group for a specified time range. +// Gets the aggregated profile of a profiling group for a specified time range. +// // 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 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 +// 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 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] +// AggregatedProfileTime . The aggregated profile's aggregation period determines +// how long // // 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. // // 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 that already exists, use [ListProfileTimes] +// ListProfileTimes 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. +// 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. +// +// [ListProfileTimes]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html +// [AggregatedProfileTime]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error) { if params == nil { params = &GetProfileInput{} @@ -68,36 +84,45 @@ type GetProfileInput struct { // This member is required. ProfilingGroupName *string - // The format of the returned profiling data. The format maps to the Accept and + // 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/) . + // see [Amazon Ion]. + // + // [Amazon Ion]: http://amzn.github.io/ion-docs/ Accept *string - // The end time of the requested profile. Specify using the ISO 8601 format. For + // 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 + // 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 . MaxDepth *int32 - // Used with startTime or endTime to specify the time range for the returned + // 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 . 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 diff --git a/service/codeguruprofiler/api_op_GetRecommendations.go b/service/codeguruprofiler/api_op_GetRecommendations.go index 2b28fe209fe..2572f9b2b7e 100644 --- a/service/codeguruprofiler/api_op_GetRecommendations.go +++ b/service/codeguruprofiler/api_op_GetRecommendations.go @@ -12,11 +12,15 @@ import ( "time" ) -// 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) -// objects that contains details about anomalies detected in the profiling group -// for the same time period is also returned. +// Returns a list of [Recommendation]Recommendation objects that contain recommendations for a +// +// profiling group for a given time period. A list of [Anomaly]Anomaly objects that +// contains details about anomalies detected in the profiling group for the same +// time period is also returned. +// +// [Anomaly]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html +// +// [Recommendation]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error) { if params == nil { params = &GetRecommendationsInput{} @@ -35,7 +39,7 @@ func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendati // The structure representing the GetRecommendationsRequest. type GetRecommendationsInput struct { - // The start time of the profile to get analysis data about. You must specify + // 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. @@ -43,12 +47,12 @@ type GetRecommendationsInput struct { // This member is required. EndTime *time.Time - // The name of the profiling group to get analysis data about. + // The name of the profiling group to get analysis data about. // // This member is required. ProfilingGroupName *string - // The end time of the profile to get analysis data about. You must specify + // 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. @@ -56,18 +60,29 @@ type GetRecommendationsInput struct { // This member is required. StartTime *time.Time - // The language used to provide analysis. Specify using a string that is one of + // 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 @@ -77,19 +92,19 @@ type GetRecommendationsInput struct { // The structure representing the GetRecommendationsResponse. type GetRecommendationsOutput struct { - // The list of anomalies that the analysis has found for this profile. + // The list of anomalies that the analysis has found for this profile. // // This member is required. Anomalies []types.Anomaly - // The end time of the profile the analysis data is about. This is specified using - // the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 + // The end time of the profile the analysis data is about. 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. ProfileEndTime *time.Time - // The start time of the profile the analysis data is about. This is specified + // The start time of the profile the analysis data is about. 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/codeguruprofiler/api_op_ListFindingsReports.go b/service/codeguruprofiler/api_op_ListFindingsReports.go index f4d8951a35f..7a33eef3855 100644 --- a/service/codeguruprofiler/api_op_ListFindingsReports.go +++ b/service/codeguruprofiler/api_op_ListFindingsReports.go @@ -31,7 +31,7 @@ func (c *Client) ListFindingsReports(ctx context.Context, params *ListFindingsRe // The structure representing the ListFindingsReportsRequest. type ListFindingsReportsInput struct { - // The end time of the profile to get analysis data about. You must specify + // 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. @@ -44,7 +44,7 @@ type ListFindingsReportsInput struct { // This member is required. ProfilingGroupName *string - // The start time of the profile to get analysis data about. You must specify + // 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. @@ -68,9 +68,10 @@ type ListFindingsReportsInput struct { // 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 diff --git a/service/codeguruprofiler/api_op_ListProfileTimes.go b/service/codeguruprofiler/api_op_ListProfileTimes.go index c49c89aa4c1..e76508abec5 100644 --- a/service/codeguruprofiler/api_op_ListProfileTimes.go +++ b/service/codeguruprofiler/api_op_ListProfileTimes.go @@ -37,11 +37,14 @@ type ListProfileTimesInput struct { // This member is required. EndTime *time.Time - // The aggregation period. This specifies the period during which an aggregation + // 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 // // This member is required. @@ -67,9 +70,10 @@ type ListProfileTimesInput struct { // The nextToken value returned from a previous paginated ListProfileTimes 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. + // 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 // The order (ascending or descending by start time of the profile) to use when diff --git a/service/codeguruprofiler/api_op_ListProfilingGroups.go b/service/codeguruprofiler/api_op_ListProfilingGroups.go index ef577b3b4dc..58ef394bc72 100644 --- a/service/codeguruprofiler/api_op_ListProfilingGroups.go +++ b/service/codeguruprofiler/api_op_ListProfilingGroups.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// objects. +// Returns a list of profiling groups. The profiling groups are returned as [ProfilingGroupDescription] +// +// ProfilingGroupDescription objects. +// +// [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html func (c *Client) ListProfilingGroups(ctx context.Context, params *ListProfilingGroupsInput, optFns ...func(*Options)) (*ListProfilingGroupsOutput, error) { if params == nil { params = &ListProfilingGroupsInput{} @@ -33,9 +35,11 @@ func (c *Client) ListProfilingGroups(ctx context.Context, params *ListProfilingG 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) - // objects that contain detailed information about profiling groups is returned. If - // false , then a list of profiling group names is returned. + // list of [ProfilingGroupDescription]ProfilingGroupDescription objects that contain detailed information + // about profiling groups is returned. If false , then a list of profiling group + // names is returned. + // + // [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html IncludeDescription *bool // The maximum number of profiling groups results returned by ListProfilingGroups @@ -48,9 +52,10 @@ type ListProfilingGroupsInput struct { // The nextToken value returned from a previous paginated ListProfilingGroups // 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. + // 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 @@ -59,10 +64,12 @@ type ListProfilingGroupsInput struct { // The structure representing the listProfilingGroupsResponse. 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) + // A returned list of profiling group names. A list of the names is returned only + // if includeDescription is false , otherwise a list of [ProfilingGroupDescription]ProfilingGroupDescription // objects is returned. // + // [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html + // // This member is required. ProfilingGroupNames []string @@ -72,10 +79,11 @@ type ListProfilingGroupsOutput struct { // 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 - // profiling group names is returned. + // A returned list [ProfilingGroupDescription]ProfilingGroupDescription objects. A list of [ProfilingGroupDescription] + // ProfilingGroupDescription objects is returned only if includeDescription is true + // , otherwise a list of profiling group names is returned. + // + // [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html ProfilingGroups []types.ProfilingGroupDescription // Metadata pertaining to the operation's result. diff --git a/service/codeguruprofiler/api_op_ListTagsForResource.go b/service/codeguruprofiler/api_op_ListTagsForResource.go index e5ee5bbf806..a714047deb2 100644 --- a/service/codeguruprofiler/api_op_ListTagsForResource.go +++ b/service/codeguruprofiler/api_op_ListTagsForResource.go @@ -28,7 +28,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resource that contains the tags to return. + // The Amazon Resource Name (ARN) of the resource that contains the tags to + // return. // // This member is required. ResourceArn *string @@ -38,7 +39,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The list of tags assigned to the specified resource. This is the list of tags + // The list of tags assigned to the specified resource. This is the list of tags // returned in the response. Tags map[string]string diff --git a/service/codeguruprofiler/api_op_PostAgentProfile.go b/service/codeguruprofiler/api_op_PostAgentProfile.go index ac39ae8d9c1..0648cddd841 100644 --- a/service/codeguruprofiler/api_op_PostAgentProfile.go +++ b/service/codeguruprofiler/api_op_PostAgentProfile.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]GetProfile . +// +// [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{} @@ -31,28 +33,32 @@ func (c *Client) PostAgentProfile(ctx context.Context, params *PostAgentProfileI // The structure representing the postAgentProfileRequest. type PostAgentProfileInput struct { - // The submitted profiling data. + // The submitted profiling data. // // This member is required. AgentProfile []byte - // The format of the submitted profiling data. The format maps to the Accept and + // 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/) . + // see [Amazon Ion]. + // + // [Amazon Ion]: http://amzn.github.io/ion-docs/ // // This member is required. ContentType *string - // The name of the profiling group with the aggregated profile that receives the + // The name of the profiling group with the aggregated profile that receives the // submitted profiling data. // // This member is required. ProfilingGroupName *string - // Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to + // Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to // prevent the accidental submission of duplicate profiling data if there are // failures and retries. ProfileToken *string diff --git a/service/codeguruprofiler/api_op_PutPermission.go b/service/codeguruprofiler/api_op_PutPermission.go index a6f6606fa3d..c6fcfa4ef99 100644 --- a/service/codeguruprofiler/api_op_PutPermission.go +++ b/service/codeguruprofiler/api_op_PutPermission.go @@ -11,20 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 +// 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 permissions. For more information, see [Resource-based policies in CodeGuru Profiler] in +// the Amazon CodeGuru Profiler User Guide, [ConfigureAgent]ConfigureAgent , and [PostAgentProfile]PostAgentProfile . +// +// 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 -// JSON-formatted resource policy. +// policy to add the permissions to. +// +// The response contains the profiling group's JSON-formatted resource policy. +// +// [ConfigureAgent]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html +// [Resource-based policies in CodeGuru Profiler]: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html +// [PostAgentProfile]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error) { if params == nil { params = &PutPermissionInput{} @@ -43,15 +49,15 @@ func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, // 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 + // Specifies an action group that contains permissions to add to a profiling + // group resource. One action group is supported, agentPermissions , which grants // permission to perform actions required by the profiling agent, ConfigureAgent // and PostAgentProfile permissions. // // This member is required. ActionGroup types.ActionGroup - // A list ARNs for the roles and users you want to grant access to the profiling + // A list ARNs for the roles and users you want to grant access to the profiling // group. Wildcards are not are supported in the ARNs. // // This member is required. @@ -62,7 +68,7 @@ type PutPermissionInput struct { // This member is required. ProfilingGroupName *string - // A universally unique identifier (UUID) for the revision of the policy you are + // 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 . @@ -74,13 +80,13 @@ type PutPermissionInput struct { // The structure representing the putPermissionResponse . type PutPermissionOutput struct { - // The JSON-formatted resource-based policy on the profiling group that includes + // The JSON-formatted resource-based policy on the profiling group that includes // the added permissions. // // This member is required. Policy *string - // A universally unique identifier (UUID) for the revision of the resource-based + // A universally unique identifier (UUID) for the revision of the resource-based // policy that includes the added permissions. The JSON-formatted policy is in the // policy element of the response. // diff --git a/service/codeguruprofiler/api_op_RemovePermission.go b/service/codeguruprofiler/api_op_RemovePermission.go index 897b2f612d5..7391a3cbc1d 100644 --- a/service/codeguruprofiler/api_op_RemovePermission.go +++ b/service/codeguruprofiler/api_op_RemovePermission.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes permissions from a profiling group's resource-based policy that are +// Removes permissions from a profiling group's resource-based policy that are +// // 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) -// . +// permissions. For more information, see [Resource-based policies in CodeGuru Profiler]in the Amazon CodeGuru Profiler User +// Guide, [ConfigureAgent]ConfigureAgent , and [PostAgentProfile]PostAgentProfile . +// +// [ConfigureAgent]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html +// [Resource-based policies in CodeGuru Profiler]: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html +// [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{} @@ -37,9 +39,10 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI // The structure representing the removePermissionRequest . type RemovePermissionInput struct { - // Specifies an action group that contains the permissions to remove from a + // 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 @@ -49,7 +52,7 @@ type RemovePermissionInput struct { // This member is required. ProfilingGroupName *string - // A universally unique identifier (UUID) for the revision of the resource-based + // A universally unique identifier (UUID) for the revision of the resource-based // policy from which you want to remove permissions. // // This member is required. @@ -61,13 +64,13 @@ type RemovePermissionInput struct { // The structure representing the removePermissionResponse . type RemovePermissionOutput struct { - // The JSON-formatted resource-based policy on the profiling group after the + // The JSON-formatted resource-based policy on the profiling group after the // specified permissions were removed. // // This member is required. Policy *string - // A universally unique identifier (UUID) for the revision of the resource-based + // A universally unique identifier (UUID) for the revision of the resource-based // policy after the specified permissions were removed. The updated JSON-formatted // policy is in the policy element of the response. // diff --git a/service/codeguruprofiler/api_op_SubmitFeedback.go b/service/codeguruprofiler/api_op_SubmitFeedback.go index 002ee803928..56392186979 100644 --- a/service/codeguruprofiler/api_op_SubmitFeedback.go +++ b/service/codeguruprofiler/api_op_SubmitFeedback.go @@ -31,8 +31,10 @@ 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) - // object that is included in the analysis data. + // The universally unique identifier (UUID) of the [AnomalyInstance]AnomalyInstance object that is + // included in the analysis data. + // + // [AnomalyInstance]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html // // This member is required. AnomalyInstanceId *string @@ -42,7 +44,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_TagResource.go b/service/codeguruprofiler/api_op_TagResource.go index 6c41ed159fe..11508d096c6 100644 --- a/service/codeguruprofiler/api_op_TagResource.go +++ b/service/codeguruprofiler/api_op_TagResource.go @@ -28,12 +28,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource that the tags are added to. + // The Amazon Resource Name (ARN) of the resource that the tags are added to. // // This member is required. ResourceArn *string - // The list of tags that are added to the specified resource. + // The list of tags that are added to the specified resource. // // This member is required. Tags map[string]string diff --git a/service/codeguruprofiler/api_op_UntagResource.go b/service/codeguruprofiler/api_op_UntagResource.go index 07391828f0b..4d326ead435 100644 --- a/service/codeguruprofiler/api_op_UntagResource.go +++ b/service/codeguruprofiler/api_op_UntagResource.go @@ -28,12 +28,13 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource that contains the tags to remove. + // The Amazon Resource Name (ARN) of the resource that contains the tags to + // remove. // // This member is required. ResourceArn *string - // A list of tag keys. Existing tags of resources with keys in this list are + // A list of tag keys. Existing tags of resources with keys in this list are // removed from the specified resource. // // This member is required. diff --git a/service/codeguruprofiler/api_op_UpdateProfilingGroup.go b/service/codeguruprofiler/api_op_UpdateProfilingGroup.go index 8ae7277023f..fd914e33150 100644 --- a/service/codeguruprofiler/api_op_UpdateProfilingGroup.go +++ b/service/codeguruprofiler/api_op_UpdateProfilingGroup.go @@ -30,7 +30,7 @@ func (c *Client) UpdateProfilingGroup(ctx context.Context, params *UpdateProfili // The structure representing the updateProfilingGroupRequest. type UpdateProfilingGroupInput struct { - // Specifies whether profiling is enabled or disabled for a profiling group. + // Specifies whether profiling is enabled or disabled for a profiling group. // // This member is required. AgentOrchestrationConfig *types.AgentOrchestrationConfig @@ -46,8 +46,10 @@ 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) - // that contains information about the returned updated profiling group. + // A [ProfilingGroupDescription]ProfilingGroupDescription that contains information about the returned + // updated profiling group. + // + // [ProfilingGroupDescription]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html // // This member is required. ProfilingGroup *types.ProfilingGroupDescription diff --git a/service/codeguruprofiler/doc.go b/service/codeguruprofiler/doc.go index 85cb2ccb6d4..6c3b3688865 100644 --- a/service/codeguruprofiler/doc.go +++ b/service/codeguruprofiler/doc.go @@ -3,19 +3,27 @@ // Package codeguruprofiler provides the API client, operations, and parameter // types for Amazon CodeGuru Profiler. // -// This section provides documentation for the Amazon CodeGuru Profiler API -// operations. Amazon CodeGuru Profiler collects runtime performance data from your -// live applications, and provides recommendations that can help you fine-tune your +// This section provides documentation for the Amazon CodeGuru Profiler API +// +// operations. +// +// Amazon CodeGuru Profiler collects runtime performance data from your live +// applications, and provides recommendations that can help you fine-tune your // application performance. Using machine learning algorithms, CodeGuru Profiler // can help you find your most expensive lines of code and suggest ways you can -// improve efficiency and remove CPU bottlenecks. Amazon CodeGuru Profiler provides -// different visualizations of profiling data to help you identify what code is -// running on the CPU, see how much time is consumed, and suggest ways to reduce -// CPU utilization. Amazon CodeGuru Profiler currently supports applications -// written in all Java virtual machine (JVM) languages and Python. While CodeGuru -// 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) -// in the Amazon CodeGuru Profiler User Guide. +// improve efficiency and remove CPU bottlenecks. +// +// Amazon CodeGuru Profiler provides different visualizations of profiling data to +// help you identify what code is running on the CPU, see how much time is +// consumed, and suggest ways to reduce CPU utilization. +// +// Amazon CodeGuru Profiler currently supports applications written in all Java +// virtual machine (JVM) languages and Python. While CodeGuru 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] in the Amazon CodeGuru Profiler User Guide. +// +// [What is Amazon CodeGuru Profiler]: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html package codeguruprofiler diff --git a/service/codeguruprofiler/options.go b/service/codeguruprofiler/options.go index 79b4bbbc346..77c7077a18b 100644 --- a/service/codeguruprofiler/options.go +++ b/service/codeguruprofiler/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codeguruprofiler/types/enums.go b/service/codeguruprofiler/types/enums.go index 4bf447aa77b..894ad439c46 100644 --- a/service/codeguruprofiler/types/enums.go +++ b/service/codeguruprofiler/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ActionGroup. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionGroup) Values() []ActionGroup { return []ActionGroup{ "agentPermissions", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for AgentParameterField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentParameterField) Values() []AgentParameterField { return []AgentParameterField{ "SamplingIntervalInMilliseconds", @@ -62,8 +64,9 @@ const ( ) // Values returns all known values for AggregationPeriod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationPeriod) Values() []AggregationPeriod { return []AggregationPeriod{ "PT5M", @@ -84,8 +87,9 @@ const ( ) // Values returns all known values for ComputePlatform. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputePlatform) Values() []ComputePlatform { return []ComputePlatform{ "Default", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for EventPublisher. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventPublisher) Values() []EventPublisher { return []EventPublisher{ "AnomalyDetection", @@ -121,8 +126,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -155,8 +161,9 @@ const ( ) // Values returns all known values for MetadataField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetadataField) Values() []MetadataField { return []MetadataField{ "ComputePlatform", @@ -181,8 +188,9 @@ const ( ) // Values returns all known values for MetricType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricType) Values() []MetricType { return []MetricType{ "AggregatedRelativeTotalTime", @@ -200,8 +208,9 @@ const ( ) // Values returns all known values for OrderBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderBy) Values() []OrderBy { return []OrderBy{ "TimestampDescending", diff --git a/service/codeguruprofiler/types/errors.go b/service/codeguruprofiler/types/errors.go index 56fa4b7faa4..a467bf276fa 100644 --- a/service/codeguruprofiler/types/errors.go +++ b/service/codeguruprofiler/types/errors.go @@ -88,8 +88,9 @@ 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]to request a service quota increase. +// +// [Service Quotas]: https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/codeguruprofiler/types/types.go b/service/codeguruprofiler/types/types.go index 03a5ec2c979..7ef39b50947 100644 --- a/service/codeguruprofiler/types/types.go +++ b/service/codeguruprofiler/types/types.go @@ -7,36 +7,45 @@ import ( "time" ) -// 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. +// The response of [ConfigureAgent]ConfigureAgent that specifies if an agent profiles or not and +// +// for how long to return profiling data. +// +// [ConfigureAgent]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html 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]ConfigureAgent . + // For example, if this is set to 300, the profiling agent calls [ConfigureAgent]ConfigureAgent // every 5 minutes to submit the profiled data collected during that period. // + // [ConfigureAgent]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html + // // This member is required. PeriodInSeconds *int32 - // A Boolean that specifies whether the profiling agent collects profiling data or - // not. Set to true to enable profiling. + // A Boolean that specifies whether the profiling agent collects profiling data + // or not. Set to true to enable profiling. // // This member is required. ShouldProfile *bool - // Parameters used by the profiler. The valid parameters are: + // 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. AgentParameters map[string]string @@ -44,13 +53,15 @@ type AgentConfiguration struct { 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) -// to enable or disable profiling for a profiling group. +// Specifies whether profiling is enabled or disabled for a profiling group. It +// +// is used by [ConfigureAgent]ConfigureAgent to enable or disable profiling for a profiling group. +// +// [ConfigureAgent]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html type AgentOrchestrationConfig struct { - // A Boolean that specifies whether the profiling agent collects profiling data or - // not. Set to true to enable profiling. + // A Boolean that specifies whether the profiling agent collects profiling data + // or not. Set to true to enable profiling. // // This member is required. ProfilingEnabled *bool @@ -58,41 +69,47 @@ type AgentOrchestrationConfig struct { noSmithyDocumentSerde } -// Specifies the aggregation period and aggregation start time for an aggregated +// Specifies the aggregation period and aggregation start time for an aggregated +// // profile. An aggregated profile is used to collect posted agent profiles during // an aggregation period. There are three possible aggregation periods (1 day, 1 // hour, or 5 minutes). type AggregatedProfileTime struct { - // The aggregation period. This indicates the period during which an aggregation + // 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 Period AggregationPeriod - // The time that aggregation of posted agent profiles for a profiling group + // 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. + // 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. Start *time.Time noSmithyDocumentSerde } -// Details about an anomaly in a specific metric of application profile. The +// Details about an anomaly in a specific metric of application profile. The +// // anomaly is detected using analysis of the metric data over a period of time. type Anomaly struct { - // A list of the instances of the detected anomalies during the requested period. + // A list of the instances of the detected anomalies during the requested period. // // This member is required. Instances []AnomalyInstance - // Details about the metric that the analysis used when it detected the anomaly. + // Details about the metric that the analysis used when it detected the anomaly. // The metric includes the name of the frame that was analyzed with the type and // thread states used to derive the metric value for that frame. // @@ -110,13 +127,13 @@ type Anomaly struct { // The specific duration in which the metric is flagged as anomalous. type AnomalyInstance struct { - // The universally unique identifier (UUID) of an instance of an anomaly in a + // The universally unique identifier (UUID) of an instance of an anomaly in a // metric. // // This member is required. Id *string - // The start time of the period during which the metric is flagged as anomalous. + // The start 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. @@ -124,7 +141,7 @@ type AnomalyInstance struct { // This member is required. StartTime *time.Time - // The end time of the period during which the metric is flagged as anomalous. + // 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. @@ -161,14 +178,15 @@ type Channel struct { noSmithyDocumentSerde } -// Information about potential recommendations that might be created from the +// Information about potential recommendations that might be created from the +// // analysis of profiling data. 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. + // 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. @@ -188,11 +206,12 @@ type FindingsReportSummary struct { noSmithyDocumentSerde } -// The frame name, metric type, and thread states. These are used to derive the +// The frame name, metric type, and thread states. These are used to derive the +// // value of the metric for the frame. type FrameMetric struct { - // Name of the method common across the multiple occurrences of a frame in an + // Name of the method common across the multiple occurrences of a frame in an // application profile. // // This member is required. @@ -204,7 +223,7 @@ type FrameMetric struct { // This member is required. ThreadStates []string - // A type of aggregation that specifies how a metric for a frame is analyzed. The + // A type of aggregation that specifies how a metric for a frame is analyzed. The // supported value AggregatedRelativeTotalTime is an aggregation of the metric // value for one frame that is calculated across the occurrences of all frames in a // profile. @@ -218,13 +237,13 @@ type FrameMetric struct { // Information about a frame metric and its values. type FrameMetricDatum struct { - // The frame name, metric type, and thread states. These are used to derive the + // The frame name, metric type, and thread states. These are used to derive the // value of the metric for the frame. // // This member is required. FrameMetric *FrameMetric - // A list of values that are associated with a frame metric. + // A list of values that are associated with a frame metric. // // This member is required. Values []float64 @@ -248,26 +267,27 @@ type Match struct { noSmithyDocumentSerde } -// Details about the metric that the analysis used when it detected the anomaly. +// Details about the metric that the analysis used when it detected the anomaly. +// // The metric what is analyzed to create recommendations. It includes the name of // the frame that was analyzed and the type and thread states used to derive the // metric value for that frame. type Metric struct { - // The name of the method that appears as a frame in any stack in a profile. + // The name of the method that appears as a frame in any stack in a profile. // // This member is required. FrameName *string - // The list of application runtime thread states that is used to calculate the + // The list of application runtime thread states that is used to calculate the // metric value for the frame. // // This member is required. ThreadStates []string - // A type that specifies how a metric for a frame is analyzed. The supported value - // AggregatedRelativeTotalTime is an aggregation of the metric value for one frame - // that is calculated across the occurences of all frames in a profile. + // A type that specifies how a metric for a frame is analyzed. The supported + // value AggregatedRelativeTotalTime is an aggregation of the metric value for one + // frame that is calculated across the occurences of all frames in a profile. // // This member is required. Type MetricType @@ -290,7 +310,7 @@ type NotificationConfiguration struct { // A set of rules used to make a recommendation during an analysis. type Pattern struct { - // A list of the different counters used to determine if there is a match. + // 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 @@ -303,7 +323,7 @@ type Pattern struct { // The name for this pattern. Name *string - // A string that contains the steps recommended to address the potential + // A string that contains the steps recommended to address the potential // inefficiency. ResolutionSteps *string @@ -311,7 +331,7 @@ type Pattern struct { // recommendation. TargetFrames [][]string - // The percentage of time an application spends in one method that triggers a + // The percentage of time an application spends in one method that triggers a // recommendation. The percentage of time is the same as the percentage of the // total gathered sample counts during analysis. ThresholdPercent float64 @@ -333,14 +353,16 @@ 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) - // object that indicates if the profiling group is enabled for profiled or not. + // An [AgentOrchestrationConfig]AgentOrchestrationConfig object that indicates if the profiling group is + // enabled for profiled or not. + // + // [AgentOrchestrationConfig]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html 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 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 @@ -355,16 +377,17 @@ 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) - // 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. + // A [ProfilingStatus]ProfilingStatus 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. + // + // [ProfilingStatus]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html ProfilingStatus *ProfilingStatus - // A list of the tags that belong to this profiling group. + // A list of the tags that belong to this profiling group. Tags map[string]string - // The date and time when the profiling group was last updated. Specify using the + // The date and time when the profiling group was last updated. 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. UpdatedAt *time.Time @@ -372,7 +395,8 @@ type ProfilingGroupDescription struct { noSmithyDocumentSerde } -// Profiling status includes information about the last time a profile agent +// 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 { @@ -387,9 +411,10 @@ 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) - // object that contains the aggregation period and start time for an aggregated - // profile. + // An [AggregatedProfileTime]AggregatedProfileTime object that contains the aggregation period and start + // time for an aggregated profile. + // + // [AggregatedProfileTime]: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html LatestAggregatedProfile *AggregatedProfileTime noSmithyDocumentSerde @@ -435,12 +460,13 @@ type Recommendation struct { noSmithyDocumentSerde } -// A data type that contains a Timestamp object. This is specified using the ISO +// A data type that contains a Timestamp object. 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. 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_op_AssociateRepository.go b/service/codegurureviewer/api_op_AssociateRepository.go index 597a1d35cd5..fbae010446f 100644 --- a/service/codegurureviewer/api_op_AssociateRepository.go +++ b/service/codegurureviewer/api_op_AssociateRepository.go @@ -16,18 +16,24 @@ 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) -// 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. +// console. For more information, see [Recommendations in Amazon CodeGuru Reviewer]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) -// 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) -// in the CodeGuru Reviewer User Guide. +// information, see [Associate a repository]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]in the CodeGuru +// Reviewer User Guide. +// +// [Recommendations in Amazon CodeGuru Reviewer]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html +// [Getting started with CodeGuru Reviewer]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html +// [Associate a repository]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html func (c *Client) AssociateRepository(ctx context.Context, params *AssociateRepositoryInput, optFns ...func(*Options)) (*AssociateRepositoryOutput, error) { if params == nil { params = &AssociateRepositoryInput{} @@ -55,17 +61,21 @@ 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. 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. @@ -81,8 +91,10 @@ 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. diff --git a/service/codegurureviewer/api_op_CreateCodeReview.go b/service/codegurureviewer/api_op_CreateCodeReview.go index c10975b5287..a9379823c48 100644 --- a/service/codegurureviewer/api_op_CreateCodeReview.go +++ b/service/codegurureviewer/api_op_CreateCodeReview.go @@ -11,10 +11,11 @@ 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 -// specified branch in an associated repository. PullRequest code reviews are -// automatically triggered by a pull request. +// Use to create a code review with a [CodeReviewType] 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. +// +// [CodeReviewType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html func (c *Client) CreateCodeReview(ctx context.Context, params *CreateCodeReviewInput, optFns ...func(*Options)) (*CreateCodeReviewOutput, error) { if params == nil { params = &CreateCodeReviewInput{} @@ -38,16 +39,22 @@ 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // A code review can only be created on an associated repository. This is the ARN // of the associated repository. // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html + // // 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] object. You can + // create a code review only of type RepositoryAnalysis . + // + // [CodeReviewType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html // // This member is required. Type *types.CodeReviewType diff --git a/service/codegurureviewer/api_op_DescribeCodeReview.go b/service/codegurureviewer/api_op_DescribeCodeReview.go index 3501d37870f..c0418a80cdf 100644 --- a/service/codegurureviewer/api_op_DescribeCodeReview.go +++ b/service/codegurureviewer/api_op_DescribeCodeReview.go @@ -33,8 +33,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html // // This member is required. CodeReviewArn *string @@ -174,12 +175,13 @@ type CodeReviewCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCodeReviewInput, *DescribeCodeReviewOutput, error) (bool, error) } diff --git a/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go b/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go index 2cc21e09af8..55c4e32da09 100644 --- a/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_DescribeRecommendationFeedback.go @@ -29,8 +29,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html // // This member is required. CodeReviewArn *string @@ -42,10 +43,13 @@ type DescribeRecommendationFeedbackInput struct { RecommendationId *string // 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) - // in the Amazon Web Services Identity and Access Management User Guide. + // 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]in the + // Amazon Web Services Identity and Access Management User Guide. + // + // [Specifying a Principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying UserId *string noSmithyDocumentSerde diff --git a/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go b/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go index 5869eab51f2..3eff51af168 100644 --- a/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go +++ b/service/codegurureviewer/api_op_DescribeRepositoryAssociation.go @@ -15,8 +15,10 @@ import ( "time" ) -// Returns a RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) -// object that contains information about the requested repository association. +// Returns a [RepositoryAssociation] object that contains information about the requested repository +// association. +// +// [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html func (c *Client) DescribeRepositoryAssociation(ctx context.Context, params *DescribeRepositoryAssociationInput, optFns ...func(*Options)) (*DescribeRepositoryAssociationOutput, error) { if params == nil { params = &DescribeRepositoryAssociationInput{} @@ -34,9 +36,11 @@ 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html // // This member is required. AssociationArn *string @@ -51,8 +55,10 @@ 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. @@ -186,12 +192,13 @@ type RepositoryAssociationSucceededWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeRepositoryAssociationInput, *DescribeRepositoryAssociationOutput, error) (bool, error) } diff --git a/service/codegurureviewer/api_op_DisassociateRepository.go b/service/codegurureviewer/api_op_DisassociateRepository.go index fe3f13a47ae..877e05420f5 100644 --- a/service/codegurureviewer/api_op_DisassociateRepository.go +++ b/service/codegurureviewer/api_op_DisassociateRepository.go @@ -29,9 +29,11 @@ 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html // // This member is required. AssociationArn *string @@ -46,8 +48,10 @@ 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. diff --git a/service/codegurureviewer/api_op_ListCodeReviews.go b/service/codegurureviewer/api_op_ListCodeReviews.go index 84688aa6b16..1c9cfe8c573 100644 --- a/service/codegurureviewer/api_op_ListCodeReviews.go +++ b/service/codegurureviewer/api_op_ListCodeReviews.go @@ -53,10 +53,15 @@ 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. States []types.JobState diff --git a/service/codegurureviewer/api_op_ListRecommendationFeedback.go b/service/codegurureviewer/api_op_ListRecommendationFeedback.go index b1c0eda369e..fff5af0c20c 100644 --- a/service/codegurureviewer/api_op_ListRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_ListRecommendationFeedback.go @@ -11,9 +11,10 @@ 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) -// objects that contain customer recommendation feedback for all CodeGuru Reviewer -// users. +// Returns a list of [RecommendationFeedbackSummary] objects that contain customer recommendation feedback for +// all CodeGuru Reviewer users. +// +// [RecommendationFeedbackSummary]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html func (c *Client) ListRecommendationFeedback(ctx context.Context, params *ListRecommendationFeedbackInput, optFns ...func(*Options)) (*ListRecommendationFeedbackOutput, error) { if params == nil { params = &ListRecommendationFeedbackInput{} @@ -31,8 +32,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html // // This member is required. CodeReviewArn *string @@ -51,10 +53,12 @@ type ListRecommendationFeedbackInput struct { // 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) - // in the Amazon Web Services Identity and Access Management User Guide. + // account ID or an Amazon Resource Name (ARN). For more information, see [Specifying a Principal]in the + // Amazon Web Services Identity and Access Management User Guide. + // + // [Specifying a Principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying UserIds []string noSmithyDocumentSerde diff --git a/service/codegurureviewer/api_op_ListRecommendations.go b/service/codegurureviewer/api_op_ListRecommendations.go index 11876fd4794..2938577cc45 100644 --- a/service/codegurureviewer/api_op_ListRecommendations.go +++ b/service/codegurureviewer/api_op_ListRecommendations.go @@ -29,8 +29,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html // // This member is required. CodeReviewArn *string diff --git a/service/codegurureviewer/api_op_ListRepositoryAssociations.go b/service/codegurureviewer/api_op_ListRepositoryAssociations.go index 3c73bcf253d..b3e7472451e 100644 --- a/service/codegurureviewer/api_op_ListRepositoryAssociations.go +++ b/service/codegurureviewer/api_op_ListRepositoryAssociations.go @@ -11,13 +11,14 @@ 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) -// 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) -// . +// Returns a list of [RepositoryAssociationSummary] objects that contain summary information about a repository +// association. You can filter the returned list by [ProviderType], [Name], [State], and [Owner]. +// +// [Owner]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner +// [State]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State +// [RepositoryAssociationSummary]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html +// [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 func (c *Client) ListRepositoryAssociations(ctx context.Context, params *ListRepositoryAssociationsInput, optFns ...func(*Options)) (*ListRepositoryAssociationsOutput, error) { if params == nil { params = &ListRepositoryAssociationsInput{} @@ -51,9 +52,10 @@ type ListRepositoryAssociationsInput struct { // The nextToken value returned from a previous paginated // ListRepositoryAssociations 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. Treat this token 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. + // + // Treat this token as an opaque identifier that is only used to retrieve the next + // items in a list and not for other programmatic purposes. NextToken *string // List of owners to use as a filter. For Amazon Web Services CodeCommit, it is @@ -65,26 +67,37 @@ type ListRepositoryAssociationsInput struct { // List of provider types to use as a filter. ProviderTypes []types.ProviderType - // List of repository association states to use as a filter. The valid repository - // association states are: + // 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. + // 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. + // information, see [Using tags to control access to associated repositories]in the Amazon CodeGuru Reviewer User Guide. + // + // [Using tags to control access to associated repositories]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html States []types.RepositoryAssociationState noSmithyDocumentSerde diff --git a/service/codegurureviewer/api_op_ListTagsForResource.go b/service/codegurureviewer/api_op_ListTagsForResource.go index ccf6c72e3d6..fa0ecd022cb 100644 --- a/service/codegurureviewer/api_op_ListTagsForResource.go +++ b/service/codegurureviewer/api_op_ListTagsForResource.go @@ -28,9 +28,11 @@ 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html // // This member is required. ResourceArn *string @@ -42,8 +44,10 @@ 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. diff --git a/service/codegurureviewer/api_op_PutRecommendationFeedback.go b/service/codegurureviewer/api_op_PutRecommendationFeedback.go index bfcb52d80b3..ddbfec1000e 100644 --- a/service/codegurureviewer/api_op_PutRecommendationFeedback.go +++ b/service/codegurureviewer/api_op_PutRecommendationFeedback.go @@ -30,8 +30,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html // // This member is required. CodeReviewArn *string diff --git a/service/codegurureviewer/api_op_TagResource.go b/service/codegurureviewer/api_op_TagResource.go index 12354aa7669..d8b4d7045ee 100644 --- a/service/codegurureviewer/api_op_TagResource.go +++ b/service/codegurureviewer/api_op_TagResource.go @@ -28,17 +28,21 @@ 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.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. diff --git a/service/codegurureviewer/api_op_UntagResource.go b/service/codegurureviewer/api_op_UntagResource.go index 55d56eb4d72..b95147a0367 100644 --- a/service/codegurureviewer/api_op_UntagResource.go +++ b/service/codegurureviewer/api_op_UntagResource.go @@ -28,9 +28,11 @@ 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html // // This member is required. ResourceArn *string diff --git a/service/codegurureviewer/doc.go b/service/codegurureviewer/doc.go index db064dce505..913f16af207 100644 --- a/service/codegurureviewer/doc.go +++ b/service/codegurureviewer/doc.go @@ -6,14 +6,18 @@ // This section provides documentation for the Amazon CodeGuru Reviewer API // operations. CodeGuru Reviewer is a service that uses program analysis and // machine learning to detect potential defects that are difficult for developers -// to find and recommends fixes in your Java and Python code. By proactively -// 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 +// to find and recommends fixes in your Java and Python code. +// +// By proactively 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]. +// +// 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) -// in the Amazon CodeGuru Reviewer User Guide. +// interface VPC endpoint. For more information, see [CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink)]in the Amazon CodeGuru +// Reviewer User Guide. +// +// [CodeGuru Reviewer and interface VPC endpoints (Amazon Web Services PrivateLink)]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html +// [Amazon CodeGuru Reviewer User Guide]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html package codegurureviewer diff --git a/service/codegurureviewer/options.go b/service/codegurureviewer/options.go index e2323cec481..a51be4e098e 100644 --- a/service/codegurureviewer/options.go +++ b/service/codegurureviewer/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codegurureviewer/types/enums.go b/service/codegurureviewer/types/enums.go index 44948dd917b..191eae9e263 100644 --- a/service/codegurureviewer/types/enums.go +++ b/service/codegurureviewer/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ConfigFileState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigFileState) Values() []ConfigFileState { return []ConfigFileState{ "Present", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for EncryptionOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionOption) Values() []EncryptionOption { return []EncryptionOption{ "AWS_OWNED_CMK", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for JobState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobState) Values() []JobState { return []JobState{ "Completed", @@ -92,8 +96,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for Reaction. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Reaction) Values() []Reaction { return []Reaction{ "ThumbsUp", @@ -140,8 +146,9 @@ const ( ) // Values returns all known values for RecommendationCategory. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationCategory) Values() []RecommendationCategory { return []RecommendationCategory{ "AWSBestPractices", @@ -171,6 +178,7 @@ const ( // Values returns all known values for RepositoryAssociationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RepositoryAssociationState) Values() []RepositoryAssociationState { return []RepositoryAssociationState{ @@ -194,8 +202,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "Info", @@ -215,8 +224,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "PullRequest", @@ -234,8 +244,9 @@ const ( ) // Values returns all known values for VendorName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VendorName) Values() []VendorName { return []VendorName{ "GitHub", diff --git a/service/codegurureviewer/types/types.go b/service/codegurureviewer/types/types.go index 77700e70987..afbcce18b9b 100644 --- a/service/codegurureviewer/types/types.go +++ b/service/codegurureviewer/types/types.go @@ -7,9 +7,10 @@ import ( "time" ) -// 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. +// A type of [SourceCodeType] that specifies a code diff between a source and destination branch +// in an associated repository. +// +// [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType type BranchDiffSourceCodeType struct { // The destination branch for a diff in an associated repository. @@ -27,10 +28,11 @@ 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. +// +// - 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 @@ -41,8 +43,9 @@ 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) - // in the Amazon CodeGuru Reviewer User Guide. + // information, see [Create code reviews with GitHub Actions]in the Amazon CodeGuru Reviewer User Guide. + // + // [Create code reviews with GitHub Actions]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html BuildArtifactsObjectKey *string noSmithyDocumentSerde @@ -54,8 +57,9 @@ type CodeArtifacts struct { 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) - // in the Amazon Web Services CodeCommit API Reference. + // information, see [repositoryName]in the Amazon Web Services CodeCommit API Reference. + // + // [repositoryName]: https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName // // This member is required. Name *string @@ -71,14 +75,16 @@ type CodeReview struct { // 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) - // 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) - // . + // The Amazon Resource Name (ARN) of the [RepositoryAssociation] that contains the reviewed source code. + // You can retrieve associated repository ARNs by calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html AssociationArn *string - // The Amazon Resource Name (ARN) of the CodeReview (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html CodeReviewArn *string // The state of the aws-codeguru-reviewer.yml configuration file that allows the @@ -120,9 +126,13 @@ 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. State JobState @@ -138,8 +148,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html CodeReviewArn *string // The time, in milliseconds since the epoch, when the code review was created. @@ -174,10 +185,16 @@ type CodeReviewSummary struct { // Specifies the source code that is analyzed in a code review. SourceCodeType *SourceCodeType - // The state of the code review. The valid code review states are: + // 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. State JobState @@ -188,18 +205,21 @@ 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) -// . +// its ARN in [CreateCodeReview]. +// +// [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) - // . + // repository. The associated repository is specified using its ARN in [CreateCodeReview]. + // + // [CreateCodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview // // This member is required. RepositoryAnalysis *RepositoryAnalysis @@ -211,10 +231,11 @@ type CodeReviewType struct { noSmithyDocumentSerde } -// 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. +// A type of [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. +// +// [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType type CommitDiffSourceCodeType struct { // The SHA of the destination commit used to generate a commit diff. This field is @@ -246,9 +267,11 @@ 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. type KMSKeyDetails struct { @@ -327,8 +350,9 @@ 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) - // object. + // The Amazon Resource Name (ARN) of the [CodeReview] object. + // + // [CodeReview]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html CodeReviewArn *string // The time at which the feedback was created. @@ -345,10 +369,13 @@ type RecommendationFeedback struct { // Later on it can be used to collect the feedback. RecommendationId *string - // 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) - // in the Amazon Web Services Identity and Access Management User Guide. + // 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]in the + // Amazon Web Services Identity and Access Management User Guide. + // + // [Specifying a Principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying UserId *string noSmithyDocumentSerde @@ -364,10 +391,13 @@ type RecommendationFeedbackSummary struct { // Later on it can be used to collect the feedback. RecommendationId *string - // 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) - // in the Amazon Web Services Identity and Access Management User Guide. + // 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]in the + // Amazon Web Services Identity and Access Management User Guide. + // + // [Specifying a Principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying UserId *string noSmithyDocumentSerde @@ -417,7 +447,7 @@ type RecommendationSummary struct { // your source code is in an associated GitHub repository. type Repository struct { - // Information about a Bitbucket repository. + // Information about a Bitbucket repository. Bitbucket *ThirdPartySourceRepository // Information about an Amazon Web Services CodeCommit repository. @@ -434,12 +464,14 @@ 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]. +// +// [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) - // that specifies the tip of a branch in an associated repository. + // A [SourceCodeType] that specifies the tip of a branch in an associated repository. + // + // [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType RepositoryHead *RepositoryHeadSourceCodeType // Specifies the source code that is analyzed in a code review. @@ -448,8 +480,10 @@ type RepositoryAnalysis struct { noSmithyDocumentSerde } -// Information about a repository association. The DescribeRepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html) -// operation returns a RepositoryAssociation object. +// Information about a repository association. The [DescribeRepositoryAssociation] operation returns a +// RepositoryAssociation object. +// +// [DescribeRepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html type RepositoryAssociation struct { // The Amazon Resource Name (ARN) identifying the repository association. @@ -461,8 +495,10 @@ 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) - // in the Amazon Web Services CodeStar Connections API Reference. + // For more information, see [Connection]in the Amazon Web Services CodeStar Connections API + // Reference. + // + // [Connection]: https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html ConnectionArn *string // The time, in milliseconds since the epoch, when the repository association was @@ -470,9 +506,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. KMSKeyDetails *KMSKeyDetails @@ -499,26 +537,37 @@ type RepositoryAssociation struct { // that contains .jar or .class files. S3RepositoryDetails *S3RepositoryDetails - // The state of the repository association. The valid repository association - // states are: + // 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. + // 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. + // information, see [Using tags to control access to associated repositories]in the Amazon CodeGuru Reviewer User Guide. + // + // [Using tags to control access to associated repositories]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html State RepositoryAssociationState // A description of why the repository association is in the current state. @@ -527,14 +576,17 @@ type RepositoryAssociation struct { noSmithyDocumentSerde } -// Summary information about a repository association. The -// ListRepositoryAssociations (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html) -// operation returns a list of RepositoryAssociationSummary objects. +// Summary information about a repository association. The [ListRepositoryAssociations] operation returns a +// list of RepositoryAssociationSummary objects. +// +// [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html 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] object. You can retrieve this ARN by + // calling [ListRepositoryAssociations]. + // + // [ListRepositoryAssociations]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html AssociationArn *string // The repository association ID. @@ -543,8 +595,10 @@ 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) - // in the Amazon Web Services CodeStar Connections API Reference. + // For more information, see [Connection]in the Amazon Web Services CodeStar Connections API + // Reference. + // + // [Connection]: https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html ConnectionArn *string // The time, in milliseconds since the epoch, since the repository association was @@ -564,33 +618,45 @@ type RepositoryAssociationSummary struct { // The provider type of the repository association. ProviderType ProviderType - // The state of the repository association. The valid repository association - // states are: + // 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. + // 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. + // information, see [Using tags to control access to associated repositories]in the Amazon CodeGuru Reviewer User Guide. + // + // [Using tags to control access to associated repositories]: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html State RepositoryAssociationState noSmithyDocumentSerde } -// A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) -// that specifies the tip of a branch in an associated repository. +// A [SourceCodeType] that specifies the tip of a branch in an associated repository. +// +// [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType type RepositoryHeadSourceCodeType struct { // The name of the branch in an associated repository. The @@ -622,8 +688,9 @@ 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]. + // + // [RepositoryAssociation]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html VendorName VendorName noSmithyDocumentSerde @@ -708,18 +775,21 @@ 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) - // that specifies a source branch name and a destination branch name in an - // associated repository. + // A type of [SourceCodeType] that specifies a source branch name and a destination branch name in + // an associated repository. + // + // [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType BranchDiff *BranchDiffSourceCodeType - // 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 + // A [SourceCodeType] that specifies a commit diff created by a pull request on an associated // repository. + // + // [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType CommitDiff *CommitDiffSourceCodeType - // A SourceCodeType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType) - // that specifies the tip of a branch in an associated repository. + // A [SourceCodeType] that specifies the tip of a branch in an associated repository. + // + // [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType RepositoryHead *RepositoryHeadSourceCodeType // Metadata that is associated with a code review. This applies to any type of @@ -731,9 +801,10 @@ type SourceCodeType struct { // 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) - // for S3BucketRepository based code reviews. + // for a build artifacts .zip file. S3BucketRepository is required in [SourceCodeType] for + // S3BucketRepository based code reviews. + // + // [SourceCodeType]: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType S3BucketRepository *S3BucketRepository noSmithyDocumentSerde @@ -746,8 +817,10 @@ 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) - // in the Amazon Web Services CodeStar Connections API Reference. + // For more information, see [Connection]in the Amazon Web Services CodeStar Connections API + // Reference. + // + // [Connection]: https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html // // This member is required. ConnectionArn *string diff --git a/service/codegurusecurity/api_op_BatchGetFindings.go b/service/codegurusecurity/api_op_BatchGetFindings.go index c2bc1d67557..ee9c5e0d730 100644 --- a/service/codegurusecurity/api_op_BatchGetFindings.go +++ b/service/codegurusecurity/api_op_BatchGetFindings.go @@ -47,7 +47,7 @@ type BatchGetFindingsOutput struct { // This member is required. FailedFindings []types.BatchGetFindingsError - // A list of all requested findings. + // A list of all requested findings. // // This member is required. Findings []types.Finding diff --git a/service/codegurusecurity/api_op_CreateScan.go b/service/codegurusecurity/api_op_CreateScan.go index 1d118ab891d..573a319d0ba 100644 --- a/service/codegurusecurity/api_op_CreateScan.go +++ b/service/codegurusecurity/api_op_CreateScan.go @@ -53,15 +53,19 @@ type CreateScanInput struct { ClientToken *string // The type of scan, either Standard or Express . Defaults to Standard type if - // missing. Express scans run on limited resources and use a limited set of - // detectors to analyze your code in near-real time. Standard scans have standard - // resource limits and use the full set of detectors to analyze your code. + // missing. + // + // Express scans run on limited resources and use a limited set of detectors to + // analyze your code in near-real time. Standard scans have standard resource + // limits and use the full set of detectors to analyze your code. ScanType types.ScanType // An array of key-value pairs used to tag a scan. A tag is a custom attribute // label with two parts: + // // - A tag key. For example, CostCenter , Environment , or Secret . Tag keys are // case sensitive. + // // - An optional tag value field. For example, 111122223333 , Production , or a // team name. Omitting the tag value is the same as using an empty string. Tag // values are case sensitive. diff --git a/service/codegurusecurity/api_op_CreateUploadUrl.go b/service/codegurusecurity/api_op_CreateUploadUrl.go index edaddeb7c4f..ddcd8b5ac3e 100644 --- a/service/codegurusecurity/api_op_CreateUploadUrl.go +++ b/service/codegurusecurity/api_op_CreateUploadUrl.go @@ -11,6 +11,7 @@ import ( ) // Generates a pre-signed URL and request headers used to upload a code resource. +// // You can upload your code resource to the URL and add the request headers using // any HTTP client. func (c *Client) CreateUploadUrl(ctx context.Context, params *CreateUploadUrlInput, optFns ...func(*Options)) (*CreateUploadUrlOutput, error) { diff --git a/service/codegurusecurity/api_op_ListTagsForResource.go b/service/codegurusecurity/api_op_ListTagsForResource.go index f83b19b41e9..7ee9f3727dc 100644 --- a/service/codegurusecurity/api_op_ListTagsForResource.go +++ b/service/codegurusecurity/api_op_ListTagsForResource.go @@ -41,8 +41,10 @@ type ListTagsForResourceOutput struct { // An array of key-value pairs used to tag an existing scan. A tag is a custom // attribute label with two parts: + // // - A tag key. For example, CostCenter , Environment , or Secret . Tag keys are // case sensitive. + // // - An optional tag value field. For example, 111122223333 , Production , or a // team name. Omitting the tag value is the same as using an empty string. Tag // values are case sensitive. diff --git a/service/codegurusecurity/api_op_TagResource.go b/service/codegurusecurity/api_op_TagResource.go index 0613c169075..0c6abb4aeb9 100644 --- a/service/codegurusecurity/api_op_TagResource.go +++ b/service/codegurusecurity/api_op_TagResource.go @@ -36,8 +36,10 @@ type TagResourceInput struct { // An array of key-value pairs used to tag an existing scan. A tag is a custom // attribute label with two parts: + // // - A tag key. For example, CostCenter , Environment , or Secret . Tag keys are // case sensitive. + // // - An optional tag value field. For example, 111122223333 , Production , or a // team name. Omitting the tag value is the same as using an empty string. Tag // values are case sensitive. diff --git a/service/codegurusecurity/doc.go b/service/codegurusecurity/doc.go index b185c76e7de..8dba41a158c 100644 --- a/service/codegurusecurity/doc.go +++ b/service/codegurusecurity/doc.go @@ -3,13 +3,16 @@ // Package codegurusecurity provides the API client, operations, and parameter // types for Amazon CodeGuru Security. // -// Amazon CodeGuru Security is in preview release and is subject to change. This -// section provides documentation for the Amazon CodeGuru Security API operations. -// CodeGuru Security is a service that uses program analysis and machine learning -// to detect security policy violations and vulnerabilities, and recommends ways to -// address these security risks. By proactively detecting and providing -// recommendations for addressing security risks, CodeGuru Security improves the -// overall security of your application code. For more information about CodeGuru -// Security, see the Amazon CodeGuru Security User Guide (https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html) -// . +// Amazon CodeGuru Security is in preview release and is subject to change. +// +// This section provides documentation for the Amazon CodeGuru Security API +// operations. CodeGuru Security is a service that uses program analysis and +// machine learning to detect security policy violations and vulnerabilities, and +// recommends ways to address these security risks. +// +// By proactively detecting and providing recommendations for addressing security +// risks, CodeGuru Security improves the overall security of your application code. +// For more information about CodeGuru Security, see the [Amazon CodeGuru Security User Guide]. +// +// [Amazon CodeGuru Security User Guide]: https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html package codegurusecurity diff --git a/service/codegurusecurity/options.go b/service/codegurusecurity/options.go index bd97b809f04..20aad72fc12 100644 --- a/service/codegurusecurity/options.go +++ b/service/codegurusecurity/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codegurusecurity/types/enums.go b/service/codegurusecurity/types/enums.go index c33bf7d30bb..baaf426a057 100644 --- a/service/codegurusecurity/types/enums.go +++ b/service/codegurusecurity/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -32,8 +33,9 @@ const ( ) // 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. +// in the future, and so 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_IDENTIFIER", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for ScanState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanState) Values() []ScanState { return []ScanState{ "InProgress", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for ScanType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanType) Values() []ScanType { return []ScanType{ "Standard", @@ -94,8 +98,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "Critical", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "Closed", @@ -139,6 +145,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/codegurusecurity/types/types.go b/service/codegurusecurity/types/types.go index eb06b1f4825..678f26e6872 100644 --- a/service/codegurusecurity/types/types.go +++ b/service/codegurusecurity/types/types.go @@ -316,7 +316,7 @@ type ScanNameWithFindingNum struct { // Information about a scan. type ScanSummary struct { - // The time when the scan was created. + // The time when the scan was created. // // This member is required. CreatedAt *time.Time @@ -377,14 +377,14 @@ type ValidationExceptionField struct { // detected. type Vulnerability struct { - // An object that describes the location of the detected security vulnerability in - // your code. + // An object that describes the location of the detected security vulnerability + // in your code. FilePath *FilePath // The identifier for the vulnerability. Id *string - // The number of times the vulnerability appears in your code. + // The number of times the vulnerability appears in your code. ItemCount *int32 // One or more URL addresses that contain details about a vulnerability. diff --git a/service/codepipeline/api_op_AcknowledgeJob.go b/service/codepipeline/api_op_AcknowledgeJob.go index 94308133cf6..92c8257f69f 100644 --- a/service/codepipeline/api_op_AcknowledgeJob.go +++ b/service/codepipeline/api_op_AcknowledgeJob.go @@ -38,7 +38,7 @@ type AcknowledgeJobInput struct { // A system-generated random number that CodePipeline uses to ensure that the job // is being worked on by only one job worker. Get this number from the response of - // the PollForJobs request that returned this job. + // the PollForJobsrequest that returned this job. // // This member is required. Nonce *string diff --git a/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go b/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go index 4ec3e5ce376..1ab4294f18e 100644 --- a/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go +++ b/service/codepipeline/api_op_AcknowledgeThirdPartyJob.go @@ -44,7 +44,7 @@ type AcknowledgeThirdPartyJobInput struct { // A system-generated random number that CodePipeline uses to ensure that the job // is being worked on by only one job worker. Get this number from the response to - // a GetThirdPartyJobDetails request. + // a GetThirdPartyJobDetailsrequest. // // This member is required. Nonce *string diff --git a/service/codepipeline/api_op_CreateCustomActionType.go b/service/codepipeline/api_op_CreateCustomActionType.go index 94525951017..72563ae6880 100644 --- a/service/codepipeline/api_op_CreateCustomActionType.go +++ b/service/codepipeline/api_op_CreateCustomActionType.go @@ -56,12 +56,14 @@ type CreateCustomActionTypeInput struct { // This member is required. Version *string - // The configuration properties for the custom action. You can refer to a name in - // 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) - // . + // The configuration properties for the custom action. + // + // You can refer to a name in 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]. + // + // [Create a Custom Action 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 0a8c47b06c6..f87c1054c9e 100644 --- a/service/codepipeline/api_op_CreatePipeline.go +++ b/service/codepipeline/api_op_CreatePipeline.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . 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_DeleteCustomActionType.go b/service/codepipeline/api_op_DeleteCustomActionType.go index fff68a5a233..e3e82c2742a 100644 --- a/service/codepipeline/api_op_DeleteCustomActionType.go +++ b/service/codepipeline/api_op_DeleteCustomActionType.go @@ -12,12 +12,13 @@ import ( ) // Marks a custom action as deleted. PollForJobs for the custom action fails after -// the action is marked for deletion. Used for custom actions only. To re-create a -// custom action after it has been deleted you must use a string in the version -// field that has never been used before. This string can be an incremented version -// number, for example. To restore a deleted custom action, use a JSON file that is -// identical to the deleted action, including the original string in the version -// field. +// the action is marked for deletion. Used for custom actions only. +// +// To re-create a custom action after it has been deleted you must use a string in +// the version field that has never been used before. This string can be an +// incremented version number, for example. To restore a deleted custom action, use +// a JSON file that is identical to the deleted action, including the original +// string in the version field. func (c *Client) DeleteCustomActionType(ctx context.Context, params *DeleteCustomActionTypeInput, optFns ...func(*Options)) (*DeleteCustomActionTypeOutput, error) { if params == nil { params = &DeleteCustomActionTypeInput{} diff --git a/service/codepipeline/api_op_GetActionType.go b/service/codepipeline/api_op_GetActionType.go index 9f709686e2b..a015542f14f 100644 --- a/service/codepipeline/api_op_GetActionType.go +++ b/service/codepipeline/api_op_GetActionType.go @@ -33,11 +33,17 @@ 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 // // This member is required. diff --git a/service/codepipeline/api_op_GetJobDetails.go b/service/codepipeline/api_op_GetJobDetails.go index 67441a49b43..4578fe3459e 100644 --- a/service/codepipeline/api_op_GetJobDetails.go +++ b/service/codepipeline/api_op_GetJobDetails.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a job. Used for custom actions only. When this API is -// called, 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. +// Returns information about a job. Used for custom actions only. +// +// When this API is called, 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) GetJobDetails(ctx context.Context, params *GetJobDetailsInput, optFns ...func(*Options)) (*GetJobDetailsOutput, error) { if params == nil { params = &GetJobDetailsInput{} @@ -45,8 +46,10 @@ 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 2dc2b1ad2c4..9cac3b18c6e 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{} diff --git a/service/codepipeline/api_op_GetPipelineState.go b/service/codepipeline/api_op_GetPipelineState.go index f16370d366b..cee9d9c76bf 100644 --- a/service/codepipeline/api_op_GetPipelineState.go +++ b/service/codepipeline/api_op_GetPipelineState.go @@ -13,8 +13,10 @@ import ( ) // Returns information about the state of a pipeline, including the stages and -// actions. Values returned in the revisionId and revisionUrl fields indicate the -// source revision information, such as the commit ID, for the current state. +// actions. +// +// Values returned in the revisionId and revisionUrl fields indicate the source +// revision information, such as the commit ID, for the current state. func (c *Client) GetPipelineState(ctx context.Context, params *GetPipelineStateInput, optFns ...func(*Options)) (*GetPipelineStateOutput, error) { if params == nil { params = &GetPipelineStateInput{} @@ -50,8 +52,9 @@ type GetPipelineStateOutput struct { // The name of the pipeline for which you want to get the state. PipelineName *string - // The version number of the pipeline. A newly created pipeline is always assigned - // a version number of 1 . + // The version number of the pipeline. + // + // A newly created pipeline is always assigned 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 8648a24e9f8..a8478557be4 100644 --- a/service/codepipeline/api_op_GetThirdPartyJobDetails.go +++ b/service/codepipeline/api_op_GetThirdPartyJobDetails.go @@ -12,10 +12,12 @@ import ( ) // Requests the details of a job for a third party action. Used for partner -// actions only. When this API is called, 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. +// actions only. +// +// When this API is called, 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{} diff --git a/service/codepipeline/api_op_ListActionExecutions.go b/service/codepipeline/api_op_ListActionExecutions.go index 37ddbf9cb22..ed3570bb5b6 100644 --- a/service/codepipeline/api_op_ListActionExecutions.go +++ b/service/codepipeline/api_op_ListActionExecutions.go @@ -29,7 +29,7 @@ func (c *Client) ListActionExecutions(ctx context.Context, params *ListActionExe type ListActionExecutionsInput struct { - // The name of the pipeline for which you want to list action execution history. + // The name of the pipeline for which you want to list action execution history. // // This member is required. PipelineName *string @@ -40,8 +40,10 @@ type ListActionExecutionsInput struct { // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. Action // execution history is retained for up to 12 months, based on action execution - // start times. Default value is 100. Detailed execution history is available for - // executions run on or after February 21, 2019. + // start times. Default value is 100. + // + // Detailed execution history is available for executions run on or after February + // 21, 2019. MaxResults *int32 // The token that was returned from the previous ListActionExecutions call, which @@ -160,8 +162,10 @@ type ListActionExecutionsPaginatorOptions struct { // The maximum number of results to return in a single call. To retrieve the // remaining results, make another call with the returned nextToken value. Action // execution history is retained for up to 12 months, based on action execution - // start times. Default value is 100. Detailed execution history is available for - // executions run on or after February 21, 2019. + // start times. Default value is 100. + // + // Detailed execution history is available for executions run on or after February + // 21, 2019. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codepipeline/api_op_PollForJobs.go b/service/codepipeline/api_op_PollForJobs.go index 91cbd776f9c..3fbc1f39800 100644 --- a/service/codepipeline/api_op_PollForJobs.go +++ b/service/codepipeline/api_op_PollForJobs.go @@ -14,10 +14,12 @@ import ( // Returns information about any jobs for CodePipeline to act on. PollForJobs is // valid only for action types with "Custom" in the owner field. If the action type // contains AWS or ThirdParty in the owner field, the PollForJobs action returns -// an error. When this API is called, 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. +// an error. +// +// When this API is called, 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) PollForJobs(ctx context.Context, params *PollForJobsInput, optFns ...func(*Options)) (*PollForJobsOutput, error) { if params == nil { params = &PollForJobsInput{} diff --git a/service/codepipeline/api_op_PollForThirdPartyJobs.go b/service/codepipeline/api_op_PollForThirdPartyJobs.go index 4b345878fb0..b36c6bdf58f 100644 --- a/service/codepipeline/api_op_PollForThirdPartyJobs.go +++ b/service/codepipeline/api_op_PollForThirdPartyJobs.go @@ -12,10 +12,11 @@ import ( ) // Determines whether there are any third party jobs for a job worker to act on. -// Used for partner actions only. When this API is called, 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. +// Used for partner actions only. +// +// When this API is called, 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. func (c *Client) PollForThirdPartyJobs(ctx context.Context, params *PollForThirdPartyJobsInput, optFns ...func(*Options)) (*PollForThirdPartyJobsOutput, error) { if params == nil { params = &PollForThirdPartyJobsInput{} diff --git a/service/codepipeline/api_op_PutApprovalResult.go b/service/codepipeline/api_op_PutApprovalResult.go index 23d541d18fa..67171cd9a23 100644 --- a/service/codepipeline/api_op_PutApprovalResult.go +++ b/service/codepipeline/api_op_PutApprovalResult.go @@ -53,9 +53,9 @@ type PutApprovalResultInput struct { 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 - // action. It is used to validate that the approval request corresponding to this - // token is still valid. + // token for each open approval request can be obtained using the GetPipelineStateaction. It is + // used to validate that the approval request corresponding to this token is still + // valid. // // This member is required. Token *string diff --git a/service/codepipeline/api_op_RetryStageExecution.go b/service/codepipeline/api_op_RetryStageExecution.go index f1372f0d8a5..0bc1e761ce9 100644 --- a/service/codepipeline/api_op_RetryStageExecution.go +++ b/service/codepipeline/api_op_RetryStageExecution.go @@ -37,9 +37,8 @@ func (c *Client) RetryStageExecution(ctx context.Context, params *RetryStageExec // Represents the input of a RetryStageExecution action. type RetryStageExecutionInput struct { - // The ID of the pipeline execution in the failed stage to be retried. Use the - // GetPipelineState action to retrieve the current pipelineExecutionId of the - // failed stage + // The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState + // action to retrieve the current pipelineExecutionId of the failed stage // // This member is required. PipelineExecutionId *string diff --git a/service/codepipeline/api_op_StopPipelineExecution.go b/service/codepipeline/api_op_StopPipelineExecution.go index 60ef14ae084..b436c25b07a 100644 --- a/service/codepipeline/api_op_StopPipelineExecution.go +++ b/service/codepipeline/api_op_StopPipelineExecution.go @@ -45,8 +45,9 @@ type StopPipelineExecutionInput struct { PipelineName *string // Use this option to stop the pipeline execution by abandoning, rather than - // finishing, in-progress actions. This option can lead to failed or - // out-of-sequence tasks. + // finishing, in-progress actions. + // + // This option can lead to failed or out-of-sequence tasks. Abandon bool // Use this option to enter comments, such as the reason the pipeline was stopped. diff --git a/service/codepipeline/api_op_UntagResource.go b/service/codepipeline/api_op_UntagResource.go index d4de1551dfa..fa872445a4a 100644 --- a/service/codepipeline/api_op_UntagResource.go +++ b/service/codepipeline/api_op_UntagResource.go @@ -28,7 +28,7 @@ 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 Amazon Resource Name (ARN) of the resource to remove tags from. // // This member is required. ResourceArn *string diff --git a/service/codepipeline/doc.go b/service/codepipeline/doc.go index 3e2cd2bf97f..06b4a7b4b2f 100644 --- a/service/codepipeline/doc.go +++ b/service/codepipeline/doc.go @@ -3,91 +3,152 @@ // Package codepipeline provides the API client, operations, and parameter types // for AWS CodePipeline. // -// CodePipeline Overview This is the CodePipeline API Reference. This guide -// provides descriptions of the actions and data types for CodePipeline. Some -// functionality for your pipeline can only be configured through the API. For more -// information, see the CodePipeline User Guide (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) -// . You can use the 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. +// # CodePipeline +// +// # Overview +// +// This is the CodePipeline API Reference. This guide provides descriptions of the +// actions and data types for CodePipeline. Some functionality for your pipeline +// can only be configured through the API. For more information, see the [CodePipeline User Guide]. +// +// You can use the 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 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 +// 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 [CodePipeline Pipeline Structure Reference]. +// +// 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: +// such as CreatePipelineand 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 CodePipeline For third-party integrators or -// developers who want to create their own integrations with CodePipeline, the -// expected sequence varies from the standard API user. To integrate with -// 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. +// 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 CodePipeline +// +// For third-party integrators or developers who want to create their own +// integrations with CodePipeline, the expected sequence varies from the standard +// API user. To integrate with 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 CodePipeline. Partner actions are created by members of the -// Amazon Web Services 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. +// Amazon Web Services 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. +// +// [CodePipeline User Guide]: https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html +// [CodePipeline Pipeline Structure Reference]: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html package codepipeline diff --git a/service/codepipeline/options.go b/service/codepipeline/options.go index 4d6c61126da..1e14c656c4d 100644 --- a/service/codepipeline/options.go +++ b/service/codepipeline/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codepipeline/types/enums.go b/service/codepipeline/types/enums.go index c2f2275e3f9..f63924a5338 100644 --- a/service/codepipeline/types/enums.go +++ b/service/codepipeline/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ActionCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionCategory) Values() []ActionCategory { return []ActionCategory{ "Source", @@ -39,8 +40,9 @@ const ( // Values returns all known values for ActionConfigurationPropertyType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionConfigurationPropertyType) Values() []ActionConfigurationPropertyType { return []ActionConfigurationPropertyType{ "String", @@ -60,8 +62,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "InProgress", @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for ActionOwner. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionOwner) Values() []ActionOwner { return []ActionOwner{ "AWS", @@ -100,8 +104,9 @@ const ( ) // Values returns all known values for ApprovalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApprovalStatus) Values() []ApprovalStatus { return []ApprovalStatus{ "Approved", @@ -117,8 +122,9 @@ const ( ) // Values returns all known values for ArtifactLocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactLocationType) Values() []ArtifactLocationType { return []ArtifactLocationType{ "S3", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for ArtifactStoreType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactStoreType) Values() []ArtifactStoreType { return []ArtifactStoreType{ "S3", @@ -149,8 +156,9 @@ const ( ) // Values returns all known values for BlockerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerType) Values() []BlockerType { return []BlockerType{ "Schedule", @@ -165,8 +173,9 @@ const ( ) // Values returns all known values for EncryptionKeyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionKeyType) Values() []EncryptionKeyType { return []EncryptionKeyType{ "KMS", @@ -183,8 +192,9 @@ const ( ) // Values returns all known values for ExecutionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionMode) Values() []ExecutionMode { return []ExecutionMode{ "QUEUED", @@ -202,8 +212,9 @@ const ( ) // Values returns all known values for ExecutionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionType) Values() []ExecutionType { return []ExecutionType{ "STANDARD", @@ -220,8 +231,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -242,8 +254,9 @@ const ( ) // Values returns all known values for FailureType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureType) Values() []FailureType { return []FailureType{ "JobFailed", @@ -265,8 +278,9 @@ const ( ) // Values returns all known values for GitPullRequestEventType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GitPullRequestEventType) Values() []GitPullRequestEventType { return []GitPullRequestEventType{ "OPEN", @@ -289,8 +303,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -317,8 +332,9 @@ const ( ) // Values returns all known values for PipelineExecutionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineExecutionStatus) Values() []PipelineExecutionStatus { return []PipelineExecutionStatus{ "Cancelled", @@ -340,6 +356,7 @@ const ( // Values returns all known values for PipelineTriggerProviderType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PipelineTriggerProviderType) Values() []PipelineTriggerProviderType { return []PipelineTriggerProviderType{ @@ -356,8 +373,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "V1", @@ -373,8 +391,9 @@ const ( ) // Values returns all known values for Result. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Result) Values() []Result { return []Result{ "ROLLBACK", @@ -391,8 +410,9 @@ const ( ) // Values returns all known values for SourceRevisionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceRevisionType) Values() []SourceRevisionType { return []SourceRevisionType{ "COMMIT_ID", @@ -414,8 +434,9 @@ const ( ) // Values returns all known values for StageExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StageExecutionStatus) Values() []StageExecutionStatus { return []StageExecutionStatus{ "Cancelled", @@ -436,8 +457,9 @@ const ( ) // Values returns all known values for StageRetryMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StageRetryMode) Values() []StageRetryMode { return []StageRetryMode{ "FAILED_ACTIONS", @@ -454,8 +476,9 @@ const ( ) // Values returns all known values for StageTransitionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StageTransitionType) Values() []StageTransitionType { return []StageTransitionType{ "Inbound", @@ -472,8 +495,9 @@ const ( ) // Values returns all known values for StartTimeRange. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StartTimeRange) Values() []StartTimeRange { return []StartTimeRange{ "Latest", @@ -497,8 +521,9 @@ const ( ) // Values returns all known values for TriggerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerType) Values() []TriggerType { return []TriggerType{ "CreatePipeline", @@ -524,6 +549,7 @@ const ( // Values returns all known values for WebhookAuthenticationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WebhookAuthenticationType) Values() []WebhookAuthenticationType { return []WebhookAuthenticationType{ diff --git a/service/codepipeline/types/types.go b/service/codepipeline/types/types.go index 3790e19e51d..ddac45ce979 100644 --- a/service/codepipeline/types/types.go +++ b/service/codepipeline/types/types.go @@ -36,9 +36,10 @@ type ActionConfigurationProperty struct { // 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 - // changing any other values of the action preserves the previous value of the - // secret. + // PollForThirdPartyJobs . + // + // When updating a pipeline, passing * * * * * without changing any other values + // of the action preserves the previous value of the secret. // // This member is required. Secret bool @@ -48,11 +49,13 @@ type ActionConfigurationProperty struct { // 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 - // value for that configuration property is subject to other restrictions. The - // value must be less than or equal to twenty (20) characters. The value can - // contain only alphanumeric characters, underscores, and hyphens. + // 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 value for that configuration property is + // subject to other restrictions. The value must be less than or equal to twenty + // (20) characters. The value can contain only alphanumeric characters, + // underscores, and hyphens. Queryable bool // The type of the configuration property. @@ -87,15 +90,21 @@ type ActionDeclaration struct { Name *string // 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 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 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) - // in the 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 }, + // for an action. For more information, see [Action Structure Requirements in CodePipeline]. For the list of configuration + // properties for the CloudFormation action type in CodePipeline, see [Configuration Properties Reference]in the + // CloudFormation User Guide. For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines]in the + // 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 }, + // + // [Action Structure Requirements in CodePipeline]: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements + // [Using Parameter Override Functions with CodePipeline Pipelines]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html + // [Configuration Properties Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html Configuration map[string]string // The name or ID of the artifact consumed by the action, such as a test or build @@ -121,8 +130,10 @@ type ActionDeclaration struct { RunOrder *int32 // A timeout duration in minutes that can be applied against the ActionType’s - // default timeout value specified in Quotas for CodePipeline (https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html) - // . This attribute is available only to the manual approval ActionType. + // default timeout value specified in [Quotas for CodePipeline]. This attribute is available only to the + // manual approval ActionType. + // + // [Quotas for CodePipeline]: https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html TimeoutInMinutes *int32 noSmithyDocumentSerde @@ -131,10 +142,11 @@ type ActionDeclaration struct { // Represents information about the run of an action. type ActionExecution struct { - // ID of the workflow action execution in the current stage. Use the - // GetPipelineState action to retrieve the current action execution details of the - // current stage. For older executions, this field might be empty. The action - // execution ID is available for executions run on or after March 2020. + // ID of the workflow action execution in the current stage. Use the GetPipelineState action to + // retrieve the current action execution details of the current stage. + // + // For older executions, this field might be empty. The action execution ID is + // available for executions run on or after March 2020. ActionExecutionId *string // The details of an error returned by a URL external to Amazon Web Services. @@ -204,8 +216,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 // The ARN of the user who changed the pipeline execution details. @@ -217,8 +229,10 @@ type ActionExecutionDetail struct { // Filter values for the action execution. type ActionExecutionFilter struct { - // The latest execution in the pipeline. Filtering on the latest execution is - // available for executions run on or after February 08, 2024. + // The latest execution in the pipeline. + // + // Filtering on the latest execution is available for executions run on or after + // February 08, 2024. LatestInPipelineExecution *LatestInPipelineExecutionFilter // The pipeline execution ID used to filter action execution history. @@ -458,11 +472,13 @@ type ActionTypeExecutor struct { JobTimeout *int32 // The policy statement that specifies the permissions in the CodePipeline - // customer 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 - // exceed 2048 characters. + // customer 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 exceed 2048 characters. PolicyStatementsTemplate *string noSmithyDocumentSerde @@ -474,11 +490,17 @@ 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 // // This member is required. @@ -486,9 +508,9 @@ type ActionTypeId struct { // 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) - // . + // ThirdParty , and Custom . For more information, see [Valid Action Types and Providers in CodePipeline]. + // + // [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 @@ -496,8 +518,9 @@ type ActionTypeId struct { // The provider of the service being called by the action. Valid providers are // determined by the action category. For example, an action in the Deploy category // type might have a provider of 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) - // . + // . For more information, see [Valid Action Types and Providers in CodePipeline]. + // + // [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. Provider *string @@ -514,11 +537,17 @@ 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 // // This member is required. @@ -751,10 +780,11 @@ type ArtifactRevision struct { noSmithyDocumentSerde } -// 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 . +// 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 . type ArtifactStore struct { // The S3 bucket used for storing the artifacts for a pipeline. You can specify @@ -848,11 +878,13 @@ type CurrentRevision struct { type EncryptionKey struct { // The ID used to identify the key. For an Amazon Web Services 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 KMS key. For cross-account actions, you can only - // use the key ID or key ARN to identify the key. Cross-account actions involve - // using the role from the other account (AccountB), so specifying the key ID will - // use the key from the other account (AccountB). + // use the key ID, the key ARN, or the alias ARN. + // + // Aliases are recognized only in the account that created the KMS key. For + // cross-account actions, you can only use the key ID or key ARN to identify the + // key. Cross-account actions involve using the role from the other account + // (AccountB), so specifying the key ID will use the key from the other account + // (AccountB). // // This member is required. Id *string @@ -969,15 +1001,18 @@ type GitBranchFilterCriteria struct { noSmithyDocumentSerde } -// A type of trigger configuration for Git-based source actions. You can specify -// the Git configuration trigger type for all third-party Git-based source actions -// that are supported by the CodeStarSourceConnection action type. +// A type of trigger configuration for Git-based source actions. +// +// You can specify the Git configuration trigger type for all third-party +// Git-based source actions that are supported by the CodeStarSourceConnection +// action type. type GitConfiguration struct { // The name of the pipeline source action where the trigger configuration, such as // Git tags, is specified. The trigger configuration will start the pipeline upon - // the specified change only. You can only specify one trigger configuration per - // source action. + // the specified change only. + // + // You can only specify one trigger configuration per source action. // // This member is required. SourceActionName *string @@ -1065,16 +1100,19 @@ type GitTagFilterCriteria struct { // build artifact. type InputArtifact struct { - // The name of the artifact to be worked on (for example, "My App"). Artifacts are - // the files that are worked on by actions in the pipeline. See the action - // configuration for each action for details about artifact parameters. For + // The name of the artifact to be worked on (for example, "My App"). + // + // Artifacts are the files that are worked on by actions in the pipeline. See the + // action configuration for each action for details about artifact parameters. For // example, the S3 source action input artifact is a file name (or file path), and // the files are generally provided as a ZIP file. Example artifact name: - // SampleApp_Windows.zip The input artifact of an action must exactly match the - // output artifact declared in a preceding action, but the input artifact does not - // have to be the next action in strict sequence from the action that provided the - // output artifact. Actions in parallel can declare different output artifacts, - // which are in turn consumed by different following actions. + // SampleApp_Windows.zip + // + // The input artifact of an action must exactly match the output artifact declared + // in a preceding action, but the input artifact does not have to be the next + // action in strict sequence from the action that provided the output artifact. + // Actions in parallel can declare different output artifacts, which are in turn + // consumed by different following actions. // // This member is required. Name *string @@ -1095,8 +1133,7 @@ type Job struct { Id *string // A system-generated random number that CodePipeline uses to ensure that the job - // is being worked on by only one job worker. Use this number in an AcknowledgeJob - // request. + // is being worked on by only one job worker. Use this number in an AcknowledgeJobrequest. Nonce *string noSmithyDocumentSerde @@ -1132,8 +1169,9 @@ type JobData struct { // The output of the job. OutputArtifacts []Artifact - // Represents information about a pipeline to a job worker. Includes pipelineArn - // and pipelineExecutionId for custom jobs. + // Represents information about a pipeline to a job worker. + // + // Includes pipelineArn and pipelineExecutionId for custom jobs. PipelineContext *PipelineContext noSmithyDocumentSerde @@ -1182,6 +1220,7 @@ type LambdaExecutorConfiguration struct { } // The field that specifies to filter on the latest execution in the pipeline. +// // Filtering on the latest execution is available for executions run on or after // February 08, 2024. type LatestInPipelineExecutionFilter struct { @@ -1193,7 +1232,9 @@ type LatestInPipelineExecutionFilter struct { // The start time to filter on for the latest execution in the pipeline. Valid // options: + // // - All + // // - Latest // // This member is required. @@ -1242,12 +1283,15 @@ type ListWebhookItem struct { // Represents information about the output of an action. type OutputArtifact struct { - // The name of the output of an artifact, such as "My App". The input artifact of - // an action must exactly match the output artifact declared in a preceding action, - // but the input artifact does not have to be the next action in strict sequence - // from the action that provided the output artifact. Actions in parallel can - // declare different output artifacts, which are in turn consumed by different - // following actions. Output artifact names must be unique within a pipeline. + // The name of the output of an artifact, such as "My App". + // + // The input artifact of an action must exactly match the output artifact declared + // in a preceding action, but the input artifact does not have to be the next + // action in strict sequence from the action that provided the output artifact. + // Actions in parallel can declare different output artifacts, which are in turn + // consumed by different following actions. + // + // Output artifact names must be unique within a pipeline. // // This member is required. Name *string @@ -1255,10 +1299,11 @@ type OutputArtifact struct { noSmithyDocumentSerde } -// Represents information about a pipeline to a job worker. PipelineContext -// contains pipelineArn and pipelineExecutionId for custom action jobs. The -// pipelineArn and pipelineExecutionId fields are not populated for ThirdParty -// action jobs. +// Represents information about a pipeline to a job worker. +// +// PipelineContext contains pipelineArn and pipelineExecutionId for custom action +// jobs. The pipelineArn and pipelineExecutionId fields are not populated for +// ThirdParty action jobs. type PipelineContext struct { // The context of an action to a job worker in the stage of a pipeline. @@ -1301,16 +1346,20 @@ type PipelineDeclaration struct { Stages []StageDeclaration // 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 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 . ArtifactStore *ArtifactStore // A mapping of artifactStore objects and their corresponding Amazon Web Services // 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 . + // 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 . ArtifactStores map[string]ArtifactStore // The method that the pipeline will use to handle multiple executions. The @@ -1320,22 +1369,30 @@ type PipelineDeclaration struct { // CodePipeline provides the following pipeline types, which differ in // characteristics and price, so that you can tailor your pipeline features and // cost to the needs of your applications. + // // - V1 type pipelines have a JSON structure that contains standard pipeline, // stage, and action-level parameters. + // // - V2 type pipelines have the same structure as a V1 type, along with // additional parameters for release safety and trigger configuration. + // // Including V2 parameters, such as triggers on Git tags, in the pipeline JSON // when creating or updating a pipeline will result in the pipeline having the V2 - // type of pipeline and the associated costs. For information about pricing for - // CodePipeline, see Pricing (http://aws.amazon.com/codepipeline/pricing/) . For - // information about which type of pipeline to choose, see What type of pipeline - // is right for me? (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html) - // . + // type of pipeline and the associated costs. + // + // For information about pricing for CodePipeline, see [Pricing]. + // + // For information about which type of pipeline to choose, see [What type of pipeline is right for me?]. + // + // [What type of pipeline is right for me?]: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html + // [Pricing]: http://aws.amazon.com/codepipeline/pricing/ PipelineType PipelineType // The trigger configuration specifying a type of event, such as Git tags, that - // starts the pipeline. When a trigger configuration is specified, default change - // detection for repository and branch commits is disabled. + // starts the pipeline. + // + // When a trigger configuration is specified, default change detection for + // repository and branch commits is disabled. Triggers []PipelineTriggerDeclaration // A list that defines the pipeline variables for a pipeline resource. Variable @@ -1376,22 +1433,29 @@ type PipelineExecution struct { RollbackMetadata *PipelineRollbackMetadata // 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) - // . + // see [Stopped Executions]. + // // - 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) - // . + // abandoning in-progress actions. For more information, see [Stopped Executions]. + // // - 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) - // . + // pipeline instead. For more information, see [Superseded Executions]. + // // - Failed: The pipeline execution was not completed successfully. + // + // [Superseded Executions]: https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded + // [Stopped Executions]: https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped Status PipelineExecutionStatus // A summary that contains a description of the pipeline execution status. @@ -1443,20 +1507,26 @@ 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) - // . + // see [Stopped Executions]. + // // - 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) - // . + // abandoning in-progress actions. For more information, see [Stopped Executions]. + // // - 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) - // . + // pipeline instead. For more information, see [Superseded Executions]. + // // - Failed: The pipeline execution was not completed successfully. + // + // [Superseded Executions]: https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-superseded + // [Stopped Executions]: https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#concepts-executions-stopped Status PipelineExecutionStatus // Status summary for the pipeline. @@ -1485,9 +1555,9 @@ type PipelineMetadata struct { // for the pipeline, in timestamp format. You can migrate (update) a polling // pipeline to use event-based change detection. For example, for a pipeline with a // CodeCommit source, we recommend you migrate (update) your pipeline to use - // CloudWatch Events. To learn more, see Migrate polling pipelines to use - // event-based change detection (https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html) - // in the CodePipeline User Guide. + // CloudWatch Events. To learn more, see [Migrate polling pipelines to use event-based change detection]in the CodePipeline User Guide. + // + // [Migrate polling pipelines to use event-based change detection]: https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html PollingDisabledAt *time.Time // The date and time the pipeline was last updated, in timestamp format. @@ -1521,17 +1591,23 @@ type PipelineSummary struct { // CodePipeline provides the following pipeline types, which differ in // characteristics and price, so that you can tailor your pipeline features and // cost to the needs of your applications. + // // - V1 type pipelines have a JSON structure that contains standard pipeline, // stage, and action-level parameters. + // // - V2 type pipelines have the same structure as a V1 type, along with // additional parameters for release safety and trigger configuration. + // // Including V2 parameters, such as triggers on Git tags, in the pipeline JSON // when creating or updating a pipeline will result in the pipeline having the V2 - // type of pipeline and the associated costs. For information about pricing for - // CodePipeline, see Pricing (http://aws.amazon.com/codepipeline/pricing/) . For - // information about which type of pipeline to choose, see What type of pipeline - // is right for me? (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html) - // . + // type of pipeline and the associated costs. + // + // For information about pricing for CodePipeline, see [Pricing]. + // + // For information about which type of pipeline to choose, see [What type of pipeline is right for me?]. + // + // [What type of pipeline is right for me?]: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html + // [Pricing]: http://aws.amazon.com/codepipeline/pricing/ PipelineType PipelineType // The date and time of the last update to the pipeline, in timestamp format. @@ -1545,9 +1621,11 @@ type PipelineSummary struct { // Represents information about the specified trigger configuration, such as the // filter criteria and the source stage for the action that contains the trigger. -// This is only supported for the CodeStarSourceConnection action type. When a -// trigger configuration is specified, default change detection for repository and -// branch commits is disabled. +// +// This is only supported for the CodeStarSourceConnection action type. +// +// When a trigger configuration is specified, default change detection for +// repository and branch commits is disabled. type PipelineTriggerDeclaration struct { // Provides the filter criteria and the source stage for the repository event that @@ -1733,9 +1811,10 @@ 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 @@ -1858,8 +1937,9 @@ type ThirdPartyJobData struct { // user when the action is created. OutputArtifacts []Artifact - // Represents information about a pipeline to a job worker. Does not include - // pipelineArn and pipelineExecutionId for ThirdParty jobs. + // Represents information about a pipeline to a job worker. + // + // Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs. PipelineContext *PipelineContext noSmithyDocumentSerde @@ -1875,8 +1955,7 @@ type ThirdPartyJobDetails struct { Id *string // A system-generated random number that CodePipeline uses to ensure that the job - // is being worked on by only one job worker. Use this number in an - // AcknowledgeThirdPartyJob request. + // is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJobrequest. Nonce *string noSmithyDocumentSerde @@ -1921,13 +2000,17 @@ 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. + // see [Securing your webhooks]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. // + // [Securing your webhooks]: https://developer.github.com/webhooks/securing/ + // // This member is required. Authentication WebhookAuthenticationType @@ -1971,8 +2054,10 @@ type WebhookFilterRule struct { // A JsonPath expression that is applied to the body/payload of the webhook. The // value selected by the JsonPath expression must match the value specified in the - // MatchEquals field. Otherwise, the request is ignored. For more information, see - // Java JsonPath implementation (https://github.com/json-path/JsonPath) in GitHub. + // MatchEquals field. Otherwise, the request is ignored. For more information, see [Java JsonPath implementation] + // in GitHub. + // + // [Java JsonPath implementation]: https://github.com/json-path/JsonPath // // This member is required. JsonPath *string @@ -1984,9 +2069,9 @@ type WebhookFilterRule struct { // the value supplied here is "refs/heads/{Branch}" and the target action has an // action configuration property called "Branch" with a value of "main", the // MatchEquals value is evaluated as "refs/heads/main". 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) - // . + // configuration properties for built-in action types, see [Pipeline Structure Reference Action Requirements]. + // + // [Pipeline Structure 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_op_UpdateTeamMember.go b/service/codestar/api_op_UpdateTeamMember.go index a18dc485e67..33b41bd3735 100644 --- a/service/codestar/api_op_UpdateTeamMember.go +++ b/service/codestar/api_op_UpdateTeamMember.go @@ -42,8 +42,9 @@ 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) - // in the AWS CodeStar User Guide. + // levels of access. For more information, see [Working with Teams]in the AWS CodeStar User Guide. + // + // [Working with Teams]: http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html ProjectRole *string // Whether a team member is allowed to remotely access project resources using the diff --git a/service/codestar/doc.go b/service/codestar/doc.go index a82aaaad16a..c1bf0fb80c2 100644 --- a/service/codestar/doc.go +++ b/service/codestar/doc.go @@ -3,33 +3,55 @@ // 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: +// # 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. package codestar diff --git a/service/codestar/options.go b/service/codestar/options.go index eb0b3a3769d..300246e5f3f 100644 --- a/service/codestar/options.go +++ b/service/codestar/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codestar/types/types.go b/service/codestar/types/types.go index 63c55b4df22..788de4e5f67 100644 --- a/service/codestar/types/types.go +++ b/service/codestar/types/types.go @@ -172,8 +172,9 @@ 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) - // in the AWS CodeStar User Guide. + // levels of access. For more information, see [Working with Teams]in the AWS CodeStar User Guide. + // + // [Working with Teams]: http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html // // This member is required. ProjectRole *string diff --git a/service/codestarconnections/api_op_CreateConnection.go b/service/codestarconnections/api_op_CreateConnection.go index 7d4e9ed9669..307eea8df35 100644 --- a/service/codestarconnections/api_op_CreateConnection.go +++ b/service/codestarconnections/api_op_CreateConnection.go @@ -55,7 +55,9 @@ type CreateConnectionOutput struct { // The Amazon Resource Name (ARN) of the connection to be created. The ARN is used // as the connection reference when the connection is shared between Amazon Web - // Services services. The ARN is never reused if the connection is deleted. + // Services services. + // + // The ARN is never reused if the connection is deleted. // // This member is required. ConnectionArn *string diff --git a/service/codestarconnections/api_op_CreateHost.go b/service/codestarconnections/api_op_CreateHost.go index 4174ab6e53d..f60645ddf1f 100644 --- a/service/codestarconnections/api_op_CreateHost.go +++ b/service/codestarconnections/api_op_CreateHost.go @@ -14,9 +14,10 @@ import ( // Creates a resource that represents the infrastructure where a third-party // provider is installed. The host is used when you create connections to an // installed third-party provider type, such as GitHub Enterprise Server. You -// create one host for all connections to that provider. A host created through the -// CLI or the SDK is in `PENDING` status by default. You can make its status -// `AVAILABLE` by setting up the host in the console. +// create one host for all connections to that provider. +// +// A host created through the CLI or the SDK is in `PENDING` status by default. +// You can make its status `AVAILABLE` by setting up the host in the console. func (c *Client) CreateHost(ctx context.Context, params *CreateHostInput, optFns ...func(*Options)) (*CreateHostOutput, error) { if params == nil { params = &CreateHostInput{} diff --git a/service/codestarconnections/api_op_DeleteConnection.go b/service/codestarconnections/api_op_DeleteConnection.go index 418b6f6b7e6..bda3423d7a9 100644 --- a/service/codestarconnections/api_op_DeleteConnection.go +++ b/service/codestarconnections/api_op_DeleteConnection.go @@ -28,8 +28,9 @@ 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_DeleteHost.go b/service/codestarconnections/api_op_DeleteHost.go index 76d87e6e174..9ad1caf0490 100644 --- a/service/codestarconnections/api_op_DeleteHost.go +++ b/service/codestarconnections/api_op_DeleteHost.go @@ -11,8 +11,10 @@ import ( ) // The host to be deleted. Before you delete a host, all connections associated to -// the host must be deleted. A host cannot be deleted if it is in the -// VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state. +// the host must be deleted. +// +// A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or +// VPC_CONFIG_DELETING state. func (c *Client) DeleteHost(ctx context.Context, params *DeleteHostInput, optFns ...func(*Options)) (*DeleteHostOutput, error) { if params == nil { params = &DeleteHostInput{} diff --git a/service/codestarconnections/api_op_ListRepositoryLinks.go b/service/codestarconnections/api_op_ListRepositoryLinks.go index 2c4b3bd6e34..21da5d39f18 100644 --- a/service/codestarconnections/api_op_ListRepositoryLinks.go +++ b/service/codestarconnections/api_op_ListRepositoryLinks.go @@ -29,10 +29,10 @@ func (c *Client) ListRepositoryLinks(ctx context.Context, params *ListRepository type ListRepositoryLinksInput struct { - // A non-zero, non-negative integer used to limit the number of returned results. + // 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 + // An enumeration token that, when provided in a request, returns the next batch // of the results. NextToken *string @@ -143,7 +143,7 @@ var _ ListRepositoryLinksAPIClient = (*Client)(nil) // ListRepositoryLinksPaginatorOptions is the paginator options for // ListRepositoryLinks type ListRepositoryLinksPaginatorOptions struct { - // A non-zero, non-negative integer used to limit the number of returned results. + // A non-zero, non-negative integer used to limit the number of returned results. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/codestarconnections/doc.go b/service/codestarconnections/doc.go index 47b98ddc174..d9dd28e3f03 100644 --- a/service/codestarconnections/doc.go +++ b/service/codestarconnections/doc.go @@ -3,49 +3,78 @@ // Package codestarconnections provides the API client, operations, and parameter // types for AWS CodeStar connections. // -// AWS CodeStar Connections This Amazon Web Services CodeStar Connections API -// Reference provides descriptions and usage examples of the operations and data -// types for the Amazon Web Services CodeStar Connections API. You can use the -// connections API to work with connections and installations. Connections are -// configurations that you use to connect Amazon Web Services resources to external -// code repositories. Each connection is a resource that can be given to services -// such as CodePipeline to connect to a third-party repository such as Bitbucket. -// For example, you can add the connection in CodePipeline so that it triggers your -// pipeline when a code change is made to your third-party code repository. Each -// connection is named and associated with a unique ARN that is used to reference -// the connection. When you create a connection, the console initiates a -// third-party connection handshake. Installations are the apps that are used to -// conduct this handshake. For example, the installation for the Bitbucket provider -// type is the Bitbucket app. When you create a connection, you can choose an -// existing installation or create one. When 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. +// # AWS CodeStar Connections // -// 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 +// This Amazon Web Services CodeStar Connections API Reference provides +// descriptions and usage examples of the operations and data types for the Amazon +// Web Services CodeStar Connections API. You can use the connections API to work +// with connections and installations. +// +// Connections are configurations that you use to connect Amazon Web Services +// resources to external code repositories. Each connection is a resource that can +// be given to services such as CodePipeline to connect to a third-party repository +// such as Bitbucket. For example, you can add the connection in CodePipeline so +// that it triggers your pipeline when a code change is made to your third-party +// code repository. Each connection is named and associated with a unique ARN that +// is used to reference the connection. +// +// When you create a connection, the console initiates a third-party connection +// handshake. Installations are the apps that are used to conduct this handshake. +// For example, the installation for the Bitbucket provider type is the Bitbucket +// app. When you create a connection, you can choose an existing installation or +// create one. +// +// When 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. -// - ListHosts , which lists the hosts associated with your account. +// +// 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 Amazon Web Services CodeStar Connections by calling // the following: -// - ListTagsForResource , which gets information about Amazon Web Services tags -// for a specified Amazon Resource Name (ARN) in Amazon Web Services CodeStar +// +// ListTagsForResource +// - , which gets information about Amazon Web Services tags for a specified +// Amazon Resource Name (ARN) in Amazon Web Services CodeStar Connections. +// +// TagResource +// - , which adds or updates tags for a resource in Amazon Web Services CodeStar +// Connections. +// +// UntagResource +// - , which removes tags for a resource in Amazon Web Services CodeStar // Connections. -// - TagResource , which adds or updates tags for a resource in Amazon Web -// Services CodeStar Connections. -// - UntagResource , which removes tags for a resource in Amazon Web Services -// CodeStar Connections. // // For information about how to use Amazon Web Services CodeStar Connections, see -// the Developer Tools User Guide (https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html) -// . +// the [Developer Tools User Guide]. +// +// [Developer Tools User Guide]: https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html package codestarconnections diff --git a/service/codestarconnections/options.go b/service/codestarconnections/options.go index a6b2a51cc33..6f6bb46754b 100644 --- a/service/codestarconnections/options.go +++ b/service/codestarconnections/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codestarconnections/types/enums.go b/service/codestarconnections/types/enums.go index b21a1dea607..9ee79db00a7 100644 --- a/service/codestarconnections/types/enums.go +++ b/service/codestarconnections/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BlockerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerStatus) Values() []BlockerStatus { return []BlockerStatus{ "ACTIVE", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for BlockerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerType) Values() []BlockerType { return []BlockerType{ "AUTOMATED", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "PENDING", @@ -68,8 +71,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for PublishDeploymentStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PublishDeploymentStatus) Values() []PublishDeploymentStatus { return []PublishDeploymentStatus{ "ENABLED", @@ -110,8 +115,9 @@ const ( ) // Values returns all known values for RepositorySyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositorySyncStatus) Values() []RepositorySyncStatus { return []RepositorySyncStatus{ "FAILED", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for ResourceSyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSyncStatus) Values() []ResourceSyncStatus { return []ResourceSyncStatus{ "FAILED", @@ -152,8 +159,9 @@ const ( ) // Values returns all known values for SyncConfigurationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncConfigurationType) Values() []SyncConfigurationType { return []SyncConfigurationType{ "CFN_STACK_SYNC", @@ -169,8 +177,9 @@ const ( ) // Values returns all known values for TriggerResourceUpdateOn. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerResourceUpdateOn) Values() []TriggerResourceUpdateOn { return []TriggerResourceUpdateOn{ "ANY_CHANGE", diff --git a/service/codestarconnections/types/types.go b/service/codestarconnections/types/types.go index 91edb55b3c1..93a3c56a315 100644 --- a/service/codestarconnections/types/types.go +++ b/service/codestarconnections/types/types.go @@ -8,13 +8,16 @@ import ( ) // A resource that is used to connect third-party source providers with services -// like CodePipeline. Note: A connection created through CloudFormation, the CLI, -// or the SDK is in `PENDING` status by default. You can make its status -// `AVAILABLE` by updating the connection in the console. +// like CodePipeline. +// +// Note: A connection created through CloudFormation, the CLI, or the SDK is in +// `PENDING` status by default. You can make its status `AVAILABLE` by updating the +// connection in the console. type Connection struct { // The Amazon Resource Name (ARN) of the connection. The ARN is used as the // connection reference when the connection is shared between Amazon Web Services. + // // The ARN is never reused if the connection is deleted. ConnectionArn *string @@ -43,9 +46,10 @@ type Connection struct { // A resource that represents the infrastructure where a third-party provider is // installed. The host is used when you create connections to an installed // third-party provider type, such as GitHub Enterprise Server. You create one host -// for all connections to that provider. A host created through the CLI or the SDK -// is in `PENDING` status by default. You can make its status `AVAILABLE` by -// setting up the host in the console. +// for all connections to that provider. +// +// A host created through the CLI or the SDK is in `PENDING` status by default. +// You can make its status `AVAILABLE` by setting up the host in the console. type Host struct { // The Amazon Resource Name (ARN) of the host. @@ -134,11 +138,16 @@ type RepositorySyncAttempt struct { StartedAt *time.Time // The status of a specific sync attempt. The following are valid statuses: + // // - INITIATED - A repository sync attempt has been created and will begin soon. + // // - IN_PROGRESS - A repository sync attempt has started and work is being done // to reconcile the branch. + // // - SUCCEEDED - The repository sync attempt has completed successfully. + // // - FAILED - The repository sync attempt has failed. + // // - QUEUED - The repository sync attempt didn't execute and was queued. // // This member is required. @@ -219,10 +228,14 @@ type ResourceSyncAttempt struct { StartedAt *time.Time // The status for a resource sync attempt. The follow are valid statuses: + // // - SYNC-INITIATED - A resource sync attempt has been created and will begin // soon. + // // - SYNCING - Syncing has started and work is being done to reconcile state. + // // - SYNCED - Syncing has completed successfully. + // // - SYNC_FAILED - A resource sync attempt has failed. // // This member is required. @@ -442,8 +455,9 @@ type SyncConfiguration struct { noSmithyDocumentSerde } -// A tag is a key-value pair that is used to manage the resource. This tag is -// available for use by Amazon Web Services services that support tags. +// A tag is a key-value pair that is used to manage the resource. +// +// This tag is available for use by Amazon Web Services services that support tags. type Tag struct { // The tag's key. diff --git a/service/codestarnotifications/api_op_CreateNotificationRule.go b/service/codestarnotifications/api_op_CreateNotificationRule.go index aa17b72cdff..05551f09ff2 100644 --- a/service/codestarnotifications/api_op_CreateNotificationRule.go +++ b/service/codestarnotifications/api_op_CreateNotificationRule.go @@ -41,7 +41,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 @@ -68,9 +68,10 @@ type CreateNotificationRuleInput struct { // A unique, client-generated idempotency token that, when provided in a request, // ensures the request cannot be repeated with a changed parameter. If a request // with the same parameters is received and a token is included, the request - // returns information about the initial request that used that token. The Amazon - // Web Services SDKs prepopulate client request tokens. If you are using an Amazon - // Web Services SDK, an idempotency token is created for you. + // returns information about the initial request that used that token. + // + // The Amazon Web Services SDKs prepopulate client request tokens. If you are + // using an Amazon 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 diff --git a/service/codestarnotifications/api_op_ListNotificationRules.go b/service/codestarnotifications/api_op_ListNotificationRules.go index 9d7bb9363c7..2f09d4dc8fe 100644 --- a/service/codestarnotifications/api_op_ListNotificationRules.go +++ b/service/codestarnotifications/api_op_ListNotificationRules.go @@ -30,9 +30,10 @@ 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 - // more than once when used with OR statements. Filters with different names should - // be applied with AND statements. + // 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 diff --git a/service/codestarnotifications/api_op_ListTargets.go b/service/codestarnotifications/api_op_ListTargets.go index c0fa8dccc18..d254709ac46 100644 --- a/service/codestarnotifications/api_op_ListTargets.go +++ b/service/codestarnotifications/api_op_ListTargets.go @@ -31,9 +31,10 @@ func (c *Client) ListTargets(ctx context.Context, params *ListTargetsInput, optF type ListTargetsInput struct { // The filters to use to return information by service or resource type. Valid - // filters include target type, target address, and target status. 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 include target type, target address, and target status. + // + // 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.ListTargetsFilter // A non-negative integer used to limit the number of returned results. The diff --git a/service/codestarnotifications/api_op_UpdateNotificationRule.go b/service/codestarnotifications/api_op_UpdateNotificationRule.go index fc137dba64e..3a85e3d004f 100644 --- a/service/codestarnotifications/api_op_UpdateNotificationRule.go +++ b/service/codestarnotifications/api_op_UpdateNotificationRule.go @@ -13,8 +13,9 @@ 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 . +// receive the notifications. +// +// To add or remove tags for a notification rule, you 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 +46,9 @@ 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) - // in the Developer Tools Console User Guide. + // list of event types and IDs, see [Notification concepts]in the Developer Tools Console User Guide. + // + // [Notification concepts]: https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api EventTypeIds []string // The name of the notification rule. diff --git a/service/codestarnotifications/doc.go b/service/codestarnotifications/doc.go index a3edf59b6c4..a5075fc18df 100644 --- a/service/codestarnotifications/doc.go +++ b/service/codestarnotifications/doc.go @@ -6,37 +6,59 @@ // 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 +// 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. -// - 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. +// +// 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. +// +// 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 +// +// ListTagsForResource +// - , which lists the tags already associated with 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) -// . +// 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]. +// +// [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/options.go b/service/codestarnotifications/options.go index 589676ba4fe..bfce3dfff05 100644 --- a/service/codestarnotifications/options.go +++ b/service/codestarnotifications/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/codestarnotifications/types/enums.go b/service/codestarnotifications/types/enums.go index 3def5382586..074cdf997e9 100644 --- a/service/codestarnotifications/types/enums.go +++ b/service/codestarnotifications/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for DetailType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetailType) Values() []DetailType { return []DetailType{ "BASIC", @@ -30,6 +31,7 @@ const ( // 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{ @@ -50,8 +52,9 @@ const ( // Values returns all known values for ListNotificationRulesFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListNotificationRulesFilterName) Values() []ListNotificationRulesFilterName { return []ListNotificationRulesFilterName{ "EVENT_TYPE_ID", @@ -71,8 +74,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TARGET_TYPE", @@ -90,8 +94,9 @@ const ( ) // Values returns all known values for NotificationRuleStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationRuleStatus) Values() []NotificationRuleStatus { return []NotificationRuleStatus{ "ENABLED", @@ -111,8 +116,9 @@ const ( ) // 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. +// expanded in the future, and so 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/types.go b/service/codestarnotifications/types/types.go index 3ff2f17159a..5d49e11476e 100644 --- a/service/codestarnotifications/types/types.go +++ b/service/codestarnotifications/types/types.go @@ -10,8 +10,9 @@ 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) - // in the Developer Tools Console User Guide. + // IDs, see [Notification concepts]in the Developer Tools Console User Guide. + // + // [Notification concepts]: https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api EventTypeId *string // The name of the event. @@ -106,7 +107,9 @@ 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 . TargetType *string @@ -123,7 +126,9 @@ type TargetSummary struct { TargetStatus TargetStatus // The type of the target (for example, SNS ). + // // - Chatbot topics are specified as SNS . + // // - Chatbot clients are specified as AWSChatbotSlack . TargetType *string diff --git a/service/cognitoidentity/api_op_CreateIdentityPool.go b/service/cognitoidentity/api_op_CreateIdentityPool.go index 1144127b607..f9b8f6875d6 100644 --- a/service/cognitoidentity/api_op_CreateIdentityPool.go +++ b/service/cognitoidentity/api_op_CreateIdentityPool.go @@ -14,10 +14,15 @@ 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 // // You must use AWS Developer credentials to call this API. @@ -50,8 +55,9 @@ 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) - // in the Amazon Cognito Developer Guide. + // information, see [Identity Pools (Federated Identities) Authentication Flow]in the Amazon Cognito Developer Guide. + // + // [Identity Pools (Federated Identities) Authentication Flow]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html AllowClassicFlow *bool // An array of Amazon Cognito user pools and their client IDs. @@ -60,9 +66,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. + // 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 @@ -102,8 +109,9 @@ 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) - // in the Amazon Cognito Developer Guide. + // information, see [Identity Pools (Federated Identities) Authentication Flow]in the Amazon Cognito Developer Guide. + // + // [Identity Pools (Federated Identities) Authentication Flow]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html AllowClassicFlow *bool // A list representing an Amazon Cognito user pool and its client ID. diff --git a/service/cognitoidentity/api_op_DeleteIdentities.go b/service/cognitoidentity/api_op_DeleteIdentities.go index c9f445b46d4..1d150d7603d 100644 --- a/service/cognitoidentity/api_op_DeleteIdentities.go +++ b/service/cognitoidentity/api_op_DeleteIdentities.go @@ -12,8 +12,9 @@ import ( ) // Deletes identities from an identity pool. You can specify a list of 1-60 -// identities that you want to delete. You must use AWS Developer credentials to -// call this API. +// identities that you want to delete. +// +// You must use AWS Developer credentials to call this API. func (c *Client) DeleteIdentities(ctx context.Context, params *DeleteIdentitiesInput, optFns ...func(*Options)) (*DeleteIdentitiesOutput, error) { if params == nil { params = &DeleteIdentitiesInput{} diff --git a/service/cognitoidentity/api_op_DeleteIdentityPool.go b/service/cognitoidentity/api_op_DeleteIdentityPool.go index 09c2cafa32f..e6b4ae03739 100644 --- a/service/cognitoidentity/api_op_DeleteIdentityPool.go +++ b/service/cognitoidentity/api_op_DeleteIdentityPool.go @@ -11,8 +11,9 @@ import ( ) // Deletes an identity pool. Once a pool is deleted, users will not be able to -// authenticate with the pool. You must use AWS Developer credentials to call this -// API. +// authenticate with the pool. +// +// You must use AWS Developer credentials to call this API. func (c *Client) DeleteIdentityPool(ctx context.Context, params *DeleteIdentityPoolInput, optFns ...func(*Options)) (*DeleteIdentityPoolOutput, error) { if params == nil { params = &DeleteIdentityPoolInput{} diff --git a/service/cognitoidentity/api_op_DescribeIdentity.go b/service/cognitoidentity/api_op_DescribeIdentity.go index bb27acf3244..04f4f57bd29 100644 --- a/service/cognitoidentity/api_op_DescribeIdentity.go +++ b/service/cognitoidentity/api_op_DescribeIdentity.go @@ -12,8 +12,9 @@ import ( ) // Returns metadata related to the given identity, including when the identity was -// created and any associated linked logins. You must use AWS Developer credentials -// to call this API. +// created and any associated linked logins. +// +// You must use AWS Developer credentials to call this API. func (c *Client) DescribeIdentity(ctx context.Context, params *DescribeIdentityInput, optFns ...func(*Options)) (*DescribeIdentityOutput, error) { if params == nil { params = &DescribeIdentityInput{} diff --git a/service/cognitoidentity/api_op_DescribeIdentityPool.go b/service/cognitoidentity/api_op_DescribeIdentityPool.go index dbcfccaa47a..eaeb3f88f97 100644 --- a/service/cognitoidentity/api_op_DescribeIdentityPool.go +++ b/service/cognitoidentity/api_op_DescribeIdentityPool.go @@ -12,8 +12,9 @@ import ( ) // Gets details about a particular identity pool, including the pool name, ID -// description, creation date, and current number of users. You must use AWS -// Developer credentials to call this API. +// description, creation date, and current number of users. +// +// You must use AWS Developer credentials to call this API. func (c *Client) DescribeIdentityPool(ctx context.Context, params *DescribeIdentityPoolInput, optFns ...func(*Options)) (*DescribeIdentityPoolOutput, error) { if params == nil { params = &DescribeIdentityPoolInput{} @@ -59,8 +60,9 @@ 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) - // in the Amazon Cognito Developer Guide. + // information, see [Identity Pools (Federated Identities) Authentication Flow]in the Amazon Cognito Developer Guide. + // + // [Identity Pools (Federated Identities) Authentication Flow]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html AllowClassicFlow *bool // A list representing an Amazon Cognito user pool and its client ID. diff --git a/service/cognitoidentity/api_op_GetCredentialsForIdentity.go b/service/cognitoidentity/api_op_GetCredentialsForIdentity.go index 97135e4d060..303576593e8 100644 --- a/service/cognitoidentity/api_op_GetCredentialsForIdentity.go +++ b/service/cognitoidentity/api_op_GetCredentialsForIdentity.go @@ -14,8 +14,9 @@ import ( // Returns credentials for the provided identity ID. Any provided logins will be // validated against supported login providers. If the token is for // cognito-identity.amazonaws.com, it will be passed through to AWS Security Token -// Service with the appropriate role for the token. This is a public API. You do -// not need any credentials to call this API. +// Service with the appropriate role for the token. +// +// This is a public API. You do not need any credentials to call this API. func (c *Client) GetCredentialsForIdentity(ctx context.Context, params *GetCredentialsForIdentityInput, optFns ...func(*Options)) (*GetCredentialsForIdentityOutput, error) { if params == nil { params = &GetCredentialsForIdentityInput{} @@ -47,12 +48,16 @@ type GetCredentialsForIdentityInput struct { // A set of optional name-value pairs that map provider names to provider tokens. // The name-value pair will follow the syntax "provider_name": - // "provider_user_identifier". Logins should not be specified when trying to get - // 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) - // section of the Amazon Cognito Developer Guide. + // "provider_user_identifier". + // + // Logins should not be specified when trying to get 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]section of the Amazon Cognito Developer Guide. + // + // [External Identity Providers]: https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html Logins map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentity/api_op_GetId.go b/service/cognitoidentity/api_op_GetId.go index affaaba2d96..156a10402bc 100644 --- a/service/cognitoidentity/api_op_GetId.go +++ b/service/cognitoidentity/api_op_GetId.go @@ -11,8 +11,9 @@ import ( ) // Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an -// implicit linked account. This is a public API. You do not need any credentials -// to call this API. +// implicit linked account. +// +// This is a public API. You do not need any credentials to call this API. func (c *Client) GetId(ctx context.Context, params *GetIdInput, optFns ...func(*Options)) (*GetIdOutput, error) { if params == nil { params = &GetIdInput{} @@ -41,12 +42,18 @@ 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 Logins map[string]string diff --git a/service/cognitoidentity/api_op_GetIdentityPoolRoles.go b/service/cognitoidentity/api_op_GetIdentityPoolRoles.go index 3b5700f49d7..5e92bbb95c4 100644 --- a/service/cognitoidentity/api_op_GetIdentityPoolRoles.go +++ b/service/cognitoidentity/api_op_GetIdentityPoolRoles.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the roles for an identity pool. You must use AWS Developer credentials to -// call this API. +// Gets the roles for an identity pool. +// +// You must use AWS Developer credentials to call this API. func (c *Client) GetIdentityPoolRoles(ctx context.Context, params *GetIdentityPoolRolesInput, optFns ...func(*Options)) (*GetIdentityPoolRolesOutput, error) { if params == nil { params = &GetIdentityPoolRolesInput{} @@ -46,8 +47,8 @@ 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, - // for example, "graph.facebook.com" or + // 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 f478354ee39..2e8f4a8f043 100644 --- a/service/cognitoidentity/api_op_GetOpenIdToken.go +++ b/service/cognitoidentity/api_op_GetOpenIdToken.go @@ -11,10 +11,12 @@ 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. -// 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. +// 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. func (c *Client) GetOpenIdToken(ctx context.Context, params *GetOpenIdTokenInput, optFns ...func(*Options)) (*GetOpenIdTokenOutput, error) { if params == nil { params = &GetOpenIdTokenInput{} diff --git a/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go b/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go index 605e809542f..40fd1bff420 100644 --- a/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_GetOpenIdTokenForDeveloperIdentity.go @@ -15,14 +15,17 @@ import ( // logins will create an implicit linked account. You can only specify one // developer provider as part of the Logins map, which is linked to the identity // pool. The developer provider is the "domain" by which Cognito will refer to your -// users. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity -// and to link new logins (that is, user credentials issued by a public provider or +// users. +// +// You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to +// link new logins (that is, user credentials issued by a public provider or // 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 -// API. +// 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 { params = &GetOpenIdTokenForDeveloperIdentityInput{} @@ -72,8 +75,10 @@ type GetOpenIdTokenForDeveloperIdentityInput struct { // one hour. The maximum token duration you can set is 24 hours. You should take // care in setting the expiration time for a token, as there are significant // security implications: an attacker could use a leaked token to access your AWS - // resources for the token's duration. Please provide for a small grace period, - // usually no more than 5 minutes, to account for clock skew. + // resources for the token's duration. + // + // Please provide for a small grace period, usually no more than 5 minutes, to + // account for clock skew. TokenDuration *int64 noSmithyDocumentSerde diff --git a/service/cognitoidentity/api_op_ListIdentities.go b/service/cognitoidentity/api_op_ListIdentities.go index 4890e68bd92..4a57d1bba26 100644 --- a/service/cognitoidentity/api_op_ListIdentities.go +++ b/service/cognitoidentity/api_op_ListIdentities.go @@ -11,8 +11,9 @@ 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_ListIdentityPools.go b/service/cognitoidentity/api_op_ListIdentityPools.go index 168cb962436..82d67c02a1f 100644 --- a/service/cognitoidentity/api_op_ListIdentityPools.go +++ b/service/cognitoidentity/api_op_ListIdentityPools.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all of the Cognito identity pools registered for your account. You must -// use AWS Developer credentials to call this API. +// Lists all of the Cognito identity pools registered for your account. +// +// You must use AWS Developer credentials to call this API. func (c *Client) ListIdentityPools(ctx context.Context, params *ListIdentityPoolsInput, optFns ...func(*Options)) (*ListIdentityPoolsOutput, error) { if params == nil { params = &ListIdentityPoolsInput{} diff --git a/service/cognitoidentity/api_op_ListTagsForResource.go b/service/cognitoidentity/api_op_ListTagsForResource.go index b74f9afd13a..745ea0bf214 100644 --- a/service/cognitoidentity/api_op_ListTagsForResource.go +++ b/service/cognitoidentity/api_op_ListTagsForResource.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags that are assigned to an Amazon Cognito identity pool. A tag is a -// label that you can apply to identity pools to categorize and manage them in -// different ways, such as by purpose, owner, environment, or other criteria. You -// can use this action up to 10 times per second, per account. +// Lists the tags that are assigned to an Amazon Cognito identity pool. +// +// A tag is a label that you can apply to identity pools to categorize and manage +// them in different ways, such as by purpose, owner, environment, or other +// criteria. +// +// You can use this action up to 10 times per second, per account. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/cognitoidentity/api_op_LookupDeveloperIdentity.go b/service/cognitoidentity/api_op_LookupDeveloperIdentity.go index 7318269b65b..c92b8dab7d7 100644 --- a/service/cognitoidentity/api_op_LookupDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_LookupDeveloperIdentity.go @@ -18,12 +18,14 @@ import ( // 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: -// for example, to enable customer service to locate an identity ID by username. If -// you are using it for higher-volume operations such as user authentication, your -// requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a -// better option for higher-volume operations for user authentication. You must use -// AWS Developer credentials to call this API. +// +// LookupDeveloperIdentity is intended for low-throughput control plane +// operations: for example, to enable customer service to locate an identity ID by +// username. If you are using it for higher-volume operations such as user +// authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentityis a better option +// for higher-volume operations for user authentication. +// +// You must use AWS Developer credentials to call this API. func (c *Client) LookupDeveloperIdentity(ctx context.Context, params *LookupDeveloperIdentityInput, optFns ...func(*Options)) (*LookupDeveloperIdentityOutput, error) { if params == nil { params = &LookupDeveloperIdentityInput{} diff --git a/service/cognitoidentity/api_op_MergeDeveloperIdentities.go b/service/cognitoidentity/api_op_MergeDeveloperIdentities.go index 4d6186a9fa1..3d5a8d4971f 100644 --- a/service/cognitoidentity/api_op_MergeDeveloperIdentities.go +++ b/service/cognitoidentity/api_op_MergeDeveloperIdentities.go @@ -17,11 +17,14 @@ import ( // 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 -// 20. Otherwise, an exception will be thrown. You must use AWS Developer -// credentials to call this API. +// 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 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) { if params == nil { params = &MergeDeveloperIdentitiesInput{} diff --git a/service/cognitoidentity/api_op_SetIdentityPoolRoles.go b/service/cognitoidentity/api_op_SetIdentityPoolRoles.go index 6b0b0b0e337..f2b3bda36fb 100644 --- a/service/cognitoidentity/api_op_SetIdentityPoolRoles.go +++ b/service/cognitoidentity/api_op_SetIdentityPoolRoles.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the roles for an identity pool. These roles are used when making calls to -// GetCredentialsForIdentity action. You must use AWS Developer credentials to call -// this API. +// Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity +// action. +// +// You must use AWS Developer credentials to call this API. func (c *Client) SetIdentityPoolRoles(ctx context.Context, params *SetIdentityPoolRolesInput, optFns ...func(*Options)) (*SetIdentityPoolRolesOutput, error) { if params == nil { params = &SetIdentityPoolRolesInput{} @@ -44,10 +45,11 @@ type SetIdentityPoolRolesInput struct { Roles map[string]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, - // for example, "graph.facebook.com" or - // "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to - // 25 rules can be specified per identity provider. + // string to RoleMappingobject 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". + // + // Up to 25 rules can be specified per identity provider. RoleMappings map[string]types.RoleMapping noSmithyDocumentSerde diff --git a/service/cognitoidentity/api_op_TagResource.go b/service/cognitoidentity/api_op_TagResource.go index 58c100d16b8..02ab498f630 100644 --- a/service/cognitoidentity/api_op_TagResource.go +++ b/service/cognitoidentity/api_op_TagResource.go @@ -12,18 +12,22 @@ import ( // Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a // label that you can use to categorize and manage identity pools in different -// ways, such as by 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 an -// identity pool, one for testing and another for production, you might assign an -// Environment tag key to both identity pools. The value of this key might be Test -// for one identity 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 identity pools. In an IAM policy, you can constrain -// permissions for identity pools based on specific tags or tag values. You can use -// this action up to 5 times per second, per account. An identity pool can have as -// many as 50 tags. +// ways, such as by 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 an identity pool, one for testing and another for production, you might +// assign an Environment tag key to both identity pools. The value of this key +// might be Test for one identity 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 identity pools. In an IAM policy, you +// can constrain permissions for identity pools based on specific tags or tag +// values. +// +// You can use this action up to 5 times per second, per account. An identity 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/cognitoidentity/api_op_UnlinkDeveloperIdentity.go b/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go index a285627a68b..bfa5516133b 100644 --- a/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go +++ b/service/cognitoidentity/api_op_UnlinkDeveloperIdentity.go @@ -13,8 +13,9 @@ import ( // Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer // users will be considered new identities next time they are seen. If, for a given // Cognito identity, you remove all federated identities as well as the developer -// user identifier, the Cognito identity becomes inaccessible. You must use AWS -// Developer credentials to call this API. +// user identifier, the Cognito identity becomes inaccessible. +// +// You must use AWS Developer credentials to call this API. func (c *Client) UnlinkDeveloperIdentity(ctx context.Context, params *UnlinkDeveloperIdentityInput, optFns ...func(*Options)) (*UnlinkDeveloperIdentityOutput, error) { if params == nil { params = &UnlinkDeveloperIdentityInput{} diff --git a/service/cognitoidentity/api_op_UnlinkIdentity.go b/service/cognitoidentity/api_op_UnlinkIdentity.go index 554497a1dd6..165e7527007 100644 --- a/service/cognitoidentity/api_op_UnlinkIdentity.go +++ b/service/cognitoidentity/api_op_UnlinkIdentity.go @@ -12,8 +12,9 @@ import ( // Unlinks a federated identity from an existing account. Unlinked logins will be // considered new identities next time they are seen. Removing the last linked -// login will make this identity inaccessible. This is a public API. You do not -// need any credentials to call this API. +// login will make this identity inaccessible. +// +// This is a public API. You do not need any credentials to call this API. func (c *Client) UnlinkIdentity(ctx context.Context, params *UnlinkIdentityInput, optFns ...func(*Options)) (*UnlinkIdentityOutput, error) { if params == nil { params = &UnlinkIdentityInput{} diff --git a/service/cognitoidentity/api_op_UpdateIdentityPool.go b/service/cognitoidentity/api_op_UpdateIdentityPool.go index 264cac8a77a..6e7e5f407b5 100644 --- a/service/cognitoidentity/api_op_UpdateIdentityPool.go +++ b/service/cognitoidentity/api_op_UpdateIdentityPool.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an identity pool. You must use AWS Developer credentials to call this -// API. +// Updates an identity pool. +// +// You must use AWS Developer credentials to call this API. func (c *Client) UpdateIdentityPool(ctx context.Context, params *UpdateIdentityPoolInput, optFns ...func(*Options)) (*UpdateIdentityPoolOutput, error) { if params == nil { params = &UpdateIdentityPoolInput{} @@ -47,8 +48,9 @@ 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) - // in the Amazon Cognito Developer Guide. + // information, see [Identity Pools (Federated Identities) Authentication Flow]in the Amazon Cognito Developer Guide. + // + // [Identity Pools (Federated Identities) Authentication Flow]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html AllowClassicFlow *bool // A list representing an Amazon Cognito user pool and its client ID. @@ -94,8 +96,9 @@ 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) - // in the Amazon Cognito Developer Guide. + // information, see [Identity Pools (Federated Identities) Authentication Flow]in the Amazon Cognito Developer Guide. + // + // [Identity Pools (Federated Identities) Authentication Flow]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html AllowClassicFlow *bool // A list representing an Amazon Cognito user pool and its client ID. diff --git a/service/cognitoidentity/doc.go b/service/cognitoidentity/doc.go index 846fb3e373a..823b58c5385 100644 --- a/service/cognitoidentity/doc.go +++ b/service/cognitoidentity/doc.go @@ -3,18 +3,25 @@ // 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 -// 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) -// . +// # 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]. +// +// For more information see [Amazon Cognito Federated Identities]. +// +// [Authentication Flow]: https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html +// [Amazon Cognito Federated Identities]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html package cognitoidentity diff --git a/service/cognitoidentity/options.go b/service/cognitoidentity/options.go index 118fe1e4b11..3f1079be008 100644 --- a/service/cognitoidentity/options.go +++ b/service/cognitoidentity/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cognitoidentity/types/enums.go b/service/cognitoidentity/types/enums.go index adb9a5d9538..73cb953b685 100644 --- a/service/cognitoidentity/types/enums.go +++ b/service/cognitoidentity/types/enums.go @@ -12,6 +12,7 @@ const ( // Values returns all known values for AmbiguousRoleResolutionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AmbiguousRoleResolutionType) Values() []AmbiguousRoleResolutionType { return []AmbiguousRoleResolutionType{ @@ -29,8 +30,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for MappingRuleMatchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MappingRuleMatchType) Values() []MappingRuleMatchType { return []MappingRuleMatchType{ "Equals", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for RoleMappingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoleMappingType) Values() []RoleMappingType { return []RoleMappingType{ "Token", diff --git a/service/cognitoidentity/types/types.go b/service/cognitoidentity/types/types.go index 9498d10df31..11e9b0337c8 100644 --- a/service/cognitoidentity/types/types.go +++ b/service/cognitoidentity/types/types.go @@ -18,11 +18,15 @@ type CognitoIdentityProvider struct { ProviderName *string // TRUE if server-side token validation is enabled for the identity provider’s - // token. Once you set ServerSideTokenCheck to TRUE for an identity pool, that - // identity pool will check with the integrated user pools to make sure that the - // user has not been globally signed out or deleted before the identity pool - // provides an OIDC token or AWS credentials for the user. If the user is signed - // out or deleted, the identity pool will return a 400 Not Authorized error. + // token. + // + // Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity + // pool will check with the integrated user pools to make sure that the user has + // not been globally signed out or deleted before the identity pool provides an + // OIDC token or AWS credentials for the user. + // + // If the user is signed out or deleted, the identity pool will return a 400 Not + // Authorized error. ServerSideTokenCheck *bool noSmithyDocumentSerde @@ -114,14 +118,16 @@ 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 - // role mapping type, RulesConfiguration is required. + // The rules to be used for mapping users to roles. + // + // If you specify Rules as the role mapping type, RulesConfiguration is required. RulesConfiguration *RulesConfigurationType noSmithyDocumentSerde @@ -130,8 +136,9 @@ type RoleMapping struct { // A container for rules. type RulesConfigurationType struct { - // An array of rules. You can specify up to 25 rules per identity provider. Rules - // are evaluated in order. The first one to match specifies the role. + // An array of rules. You can specify up to 25 rules per identity provider. + // + // Rules are evaluated in order. The first one to match specifies the role. // // This member is required. Rules []MappingRule diff --git a/service/cognitoidentityprovider/api_op_AddCustomAttributes.go b/service/cognitoidentityprovider/api_op_AddCustomAttributes.go index f14949bf4aa..faef3b12a01 100644 --- a/service/cognitoidentityprovider/api_op_AddCustomAttributes.go +++ b/service/cognitoidentityprovider/api_op_AddCustomAttributes.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds additional user attributes to the user pool schema. Amazon Cognito -// evaluates Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Adds additional user attributes to the user pool schema. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AddCustomAttributes(ctx context.Context, params *AddCustomAttributesInput, optFns ...func(*Options)) (*AddCustomAttributesOutput, error) { if params == nil { params = &AddCustomAttributesInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go b/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go index 9e5b2430b6d..c439c82ee01 100644 --- a/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go +++ b/service/cognitoidentityprovider/api_op_AdminAddUserToGroup.go @@ -12,12 +12,21 @@ import ( // Adds a user to a group. A user who is in a group can present a preferred-role // claim to an identity pool, and populates a cognito:groups claim to their access -// and identity tokens. Amazon Cognito evaluates Identity and Access Management -// (IAM) policies in requests for this API operation. For this operation, you must -// use IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// and identity tokens. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminAddUserToGroup(ctx context.Context, params *AdminAddUserToGroupInput, optFns ...func(*Options)) (*AdminAddUserToGroupOutput, error) { if params == nil { params = &AdminAddUserToGroupInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go b/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go index 852d6c3eaee..4a02ebc6181 100644 --- a/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go +++ b/service/cognitoidentityprovider/api_op_AdminConfirmSignUp.go @@ -15,17 +15,27 @@ import ( // code, they confirm ownership of the email address or phone number that they // provided, and their user account becomes active. Depending on your user pool // configuration, your users will receive their confirmation code in an email or -// SMS message. Local users who signed up in your user pool are the only type of -// user who can confirm sign-up with a code. Users who federate through an external -// identity provider (IdP) have already been confirmed by their IdP. -// Administrator-created users confirm their accounts when they respond to their -// invitation email message and choose a password. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// SMS message. +// +// Local users who signed up in your user pool are the only type of user who can +// confirm sign-up with a code. Users who federate through an external identity +// provider (IdP) have already been confirmed by their IdP. Administrator-created +// users confirm their accounts when they respond to their invitation email message +// and choose a password. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminConfirmSignUp(ctx context.Context, params *AdminConfirmSignUpInput, optFns ...func(*Options)) (*AdminConfirmSignUpOutput, error) { if params == nil { params = &AdminConfirmSignUpInput{} @@ -59,24 +69,33 @@ type AdminConfirmSignUpInput struct { Username *string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. If your user pool configuration includes - // triggers, the AdminConfirmSignUp API action invokes the Lambda function that is - // specified for the post confirmation trigger. When Amazon Cognito invokes this - // function, it passes a JSON payload, which the function receives as input. In - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // If your user pool configuration includes triggers, the AdminConfirmSignUp API + // action invokes the Lambda function that is specified for the post confirmation + // trigger. When Amazon Cognito invokes this function, it passes a JSON payload, + // which the function receives as input. In 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] 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. + // + // [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 ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminCreateUser.go b/service/cognitoidentityprovider/api_op_AdminCreateUser.go index 70cb30f072c..676ec443471 100644 --- a/service/cognitoidentityprovider/api_op_AdminCreateUser.go +++ b/service/cognitoidentityprovider/api_op_AdminCreateUser.go @@ -11,33 +11,52 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new user in the specified user pool. If MessageAction isn't set, the -// default is to send a welcome message via email or phone (SMS). 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/user-pool-sms-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. Amazon Cognito evaluates Identity and Access -// Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Creates a new user in the specified user pool. +// +// If MessageAction isn't set, the default is to send a welcome message via email +// or phone (SMS). +// +// 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]. 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], 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]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. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) AdminCreateUser(ctx context.Context, params *AdminCreateUserInput, optFns ...func(*Options)) (*AdminCreateUserOutput, error) { if params == nil { params = &AdminCreateUserInput{} @@ -63,38 +82,49 @@ type AdminCreateUserInput struct { // The value that you want to set as the username sign-in attribute. The following // conditions apply to the username parameter. - // - The username can't be a duplicate of another username in the same user - // pool. + // + // - The username can't be a duplicate of another username in the same user pool. + // // - You can't change the value of a username after you create it. + // // - You can only provide a value if usernames are a valid sign-in attribute for // your user pool. If your user pool only supports phone numbers or email addresses // as sign-in attributes, Amazon Cognito automatically generates a username value. - // For more information, see Customizing sign-in attributes (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases) - // . + // For more information, see [Customizing sign-in attributes]. + // + // [Customizing sign-in attributes]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases // // This member is required. Username *string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the AdminCreateUser API - // action, Amazon Cognito invokes the function that is assigned to the pre sign-up - // trigger. When Amazon Cognito invokes this function, it passes a JSON payload, - // which the function receives as input. This payload contains a clientMetadata - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes + // the function that is assigned to the pre sign-up trigger. When Amazon Cognito + // invokes this function, it passes a JSON payload, which the function receives as + // input. This payload contains a clientMetadata 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] 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. + // + // [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 ClientMetadata map[string]string // Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" @@ -103,13 +133,16 @@ type AdminCreateUserInput struct { 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 - // 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 . + // 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 . ForceAliasCreation bool // Set to RESEND to resend the invitation message to a user that already exists @@ -118,14 +151,19 @@ type AdminCreateUserInput struct { 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 - // value, Amazon Cognito generates one for you. The temporary password can only be - // used until the user account expiration limit that you set for your user pool. To - // reset the account after that time limit, you must call AdminCreateUser again - // and specify RESEND for the MessageAction parameter. + // 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 set for your user pool. To reset the account after that time limit, you + // must call AdminCreateUser again and specify RESEND for the MessageAction + // parameter. TemporaryPassword *string // An array of name-value pairs that contain user attributes and attribute values @@ -133,35 +171,45 @@ type AdminCreateUserInput struct { // 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 - // 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) - // . + // 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]. + // // - 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. + // + // [AdminUpdateUserAttributes]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html UserAttributes []types.AttributeType // Temporary user attributes that contribute to the outcomes of your pre sign-up // Lambda trigger. This set of key-value pairs are for custom validation of - // information that you collect from your users but don't need to retain. Your - // Lambda function can analyze this additional data and act on it. Your function - // might perform external API operations like logging user attributes and + // information that you collect from your users but don't need to retain. + // + // Your Lambda function can analyze this additional data and act on it. Your + // function might perform external API operations like logging user attributes and // validation data to Amazon CloudWatch Logs. Validation data might also affect the // response that your function returns to Amazon Cognito, like automatically - // confirming the user if they sign up from within your network. For more - // information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html) - // . + // confirming the user if they sign up from within your network. + // + // For more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger]. + // + // [Pre sign-up Lambda trigger]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html ValidationData []types.AttributeType noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminDeleteUser.go b/service/cognitoidentityprovider/api_op_AdminDeleteUser.go index f47245e9d4c..29bc00d35df 100644 --- a/service/cognitoidentityprovider/api_op_AdminDeleteUser.go +++ b/service/cognitoidentityprovider/api_op_AdminDeleteUser.go @@ -10,13 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a user as an administrator. Works on any user. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Deletes a user as an administrator. Works on any user. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminDeleteUser(ctx context.Context, params *AdminDeleteUserInput, optFns ...func(*Options)) (*AdminDeleteUserOutput, error) { if params == nil { params = &AdminDeleteUserInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminDeleteUserAttributes.go b/service/cognitoidentityprovider/api_op_AdminDeleteUserAttributes.go index 708e587962e..7d187466e61 100644 --- a/service/cognitoidentityprovider/api_op_AdminDeleteUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_AdminDeleteUserAttributes.go @@ -11,12 +11,21 @@ import ( ) // Deletes the user attributes in a user pool as an administrator. Works on any -// user. Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// user. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminDeleteUserAttributes(ctx context.Context, params *AdminDeleteUserAttributesInput, optFns ...func(*Options)) (*AdminDeleteUserAttributesOutput, error) { if params == nil { params = &AdminDeleteUserAttributesInput{} @@ -36,6 +45,7 @@ func (c *Client) AdminDeleteUserAttributes(ctx context.Context, params *AdminDel type AdminDeleteUserAttributesInput struct { // An array of strings representing the user attribute names you want to delete. + // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // diff --git a/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go b/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go index 0dcbc4ce12b..b1d1b7c4d5d 100644 --- a/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminDisableProviderForUser.go @@ -17,28 +17,43 @@ 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) -// . 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 +// DestinationUser , the user must create a new user account. See [AdminLinkProviderForUser]. +// +// 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. Amazon Cognito evaluates Identity and Access Management (IAM) -// policies in requests for this API operation. For this operation, you must use -// IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// 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. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [AdminLinkProviderForUser]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html 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_AdminDisableUser.go b/service/cognitoidentityprovider/api_op_AdminDisableUser.go index 6c6fa05a4fc..75fc82b1e3e 100644 --- a/service/cognitoidentityprovider/api_op_AdminDisableUser.go +++ b/service/cognitoidentityprovider/api_op_AdminDisableUser.go @@ -12,12 +12,21 @@ import ( // Deactivates a user and revokes all access tokens for the user. A deactivated // user can't sign in, but still appears in the responses to GetUser and ListUsers -// API requests. Amazon Cognito evaluates Identity and Access Management (IAM) -// policies in requests for this API operation. For this operation, you must use -// IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// API requests. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminDisableUser(ctx context.Context, params *AdminDisableUserInput, optFns ...func(*Options)) (*AdminDisableUserOutput, error) { if params == nil { params = &AdminDisableUserInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminEnableUser.go b/service/cognitoidentityprovider/api_op_AdminEnableUser.go index 555571cb881..39f4abdabc2 100644 --- a/service/cognitoidentityprovider/api_op_AdminEnableUser.go +++ b/service/cognitoidentityprovider/api_op_AdminEnableUser.go @@ -10,13 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables the specified user as an administrator. Works on any user. Amazon -// Cognito evaluates Identity and Access Management (IAM) policies in requests for -// this API operation. For this operation, you must use IAM credentials to -// authorize requests, and you must grant yourself the corresponding IAM permission -// in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Enables the specified user as an administrator. Works on any user. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminEnableUser(ctx context.Context, params *AdminEnableUserInput, optFns ...func(*Options)) (*AdminEnableUserOutput, error) { if params == nil { params = &AdminEnableUserInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminForgetDevice.go b/service/cognitoidentityprovider/api_op_AdminForgetDevice.go index b62928b5a62..5ebed4d2d86 100644 --- a/service/cognitoidentityprovider/api_op_AdminForgetDevice.go +++ b/service/cognitoidentityprovider/api_op_AdminForgetDevice.go @@ -10,12 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Forgets the device, as an administrator. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Forgets the device, as an administrator. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminForgetDevice(ctx context.Context, params *AdminForgetDeviceInput, optFns ...func(*Options)) (*AdminForgetDeviceOutput, error) { if params == nil { params = &AdminForgetDeviceInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminGetDevice.go b/service/cognitoidentityprovider/api_op_AdminGetDevice.go index 4aa0700e019..076834f39ce 100644 --- a/service/cognitoidentityprovider/api_op_AdminGetDevice.go +++ b/service/cognitoidentityprovider/api_op_AdminGetDevice.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the device, as an administrator. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Gets the device, as an administrator. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminGetDevice(ctx context.Context, params *AdminGetDeviceInput, optFns ...func(*Options)) (*AdminGetDeviceOutput, error) { if params == nil { params = &AdminGetDeviceInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminGetUser.go b/service/cognitoidentityprovider/api_op_AdminGetUser.go index 5af14b1acb2..25043cb9c83 100644 --- a/service/cognitoidentityprovider/api_op_AdminGetUser.go +++ b/service/cognitoidentityprovider/api_op_AdminGetUser.go @@ -13,12 +13,21 @@ import ( ) // Gets the specified user by user name in a user pool as an administrator. Works -// on any user. Amazon Cognito evaluates Identity and Access Management (IAM) -// policies in requests for this API operation. For this operation, you must use -// IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// on any user. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminGetUser(ctx context.Context, params *AdminGetUserInput, optFns ...func(*Options)) (*AdminGetUserOutput, error) { if params == nil { params = &AdminGetUserInput{} @@ -67,7 +76,7 @@ type AdminGetUserOutput struct { // Indicates that the status is enabled . Enabled bool - // This response parameter is no longer supported. It provides information only + // This response parameter is no longer supported. It provides information only // about SMS MFA configurations. It doesn't provide information about time-based // one-time password (TOTP) software token MFA configurations. To look up // information about either type of MFA configuration, use UserMFASettingList @@ -93,11 +102,16 @@ type AdminGetUserOutput struct { UserMFASettingList []string // The user status. Can be one of the following: + // // - UNCONFIRMED - User has been created but not confirmed. + // // - CONFIRMED - User has been confirmed. + // // - 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. diff --git a/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go b/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go index 842a7a5babb..ddc2f870814 100644 --- a/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go +++ b/service/cognitoidentityprovider/api_op_AdminInitiateAuth.go @@ -11,26 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates the authentication flow, as an administrator. 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Initiates the authentication flow, as an administrator. +// +// 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]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) AdminInitiateAuth(ctx context.Context, params *AdminInitiateAuthInput, optFns ...func(*Options)) (*AdminInitiateAuthOutput, error) { if params == nil { params = &AdminInitiateAuthInput{} @@ -51,20 +64,29 @@ 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. + // // 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 @@ -89,55 +111,80 @@ type AdminInitiateAuthInput struct { // 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 ADMIN_USER_PASSWORD_AUTH : USERNAME (required), PASSWORD (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) . - // For more information about SECRET_HASH , see Computing secret hash values (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash) - // . For information about DEVICE_KEY , see Working with user devices in your user - // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) - // . + // + // For more information about SECRET_HASH , see [Computing secret hash values]. For information about DEVICE_KEY + // , see [Working with user devices in your user pool]. + // + // [Computing secret hash values]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash + // [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html 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: + // 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: + // 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 - // 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: + // + // For more information, see [Customizing user pool Workflows with Lambda Triggers] 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. + // + // [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 ClientMetadata map[string]string // Contextual data about your user session, such as the device fingerprint, IP @@ -160,55 +207,70 @@ type AdminInitiateAuthOutput struct { // 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 + // user pool and that your app client can write. For more information, see [AdminRespondToAuthChallenge]. + // + // 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 MFAS_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. + // challenge parameters MFAS_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. + // + // [AdminRespondToAuthChallenge]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html 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 + // ). + // + // 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 diff --git a/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go b/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go index b19c805919d..cd211bbce9b 100644 --- a/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminLinkProviderForUser.go @@ -16,19 +16,32 @@ import ( // 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 +// 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 // external IdPs and provider attributes that have been trusted by the application -// owner. Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// owner. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminLinkProviderForUser(ctx context.Context, params *AdminLinkProviderForUserInput, optFns ...func(*Options)) (*AdminLinkProviderForUserOutput, error) { if params == nil { params = &AdminLinkProviderForUserInput{} @@ -51,35 +64,46 @@ type AdminLinkProviderForUserInput struct { // pools user or a federated user (for example, a SAML or Facebook user). If the // user doesn't exist, Amazon Cognito generates an exception. Amazon Cognito // 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 - // 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 - // operation won't succeed. + // 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 operation won't succeed. // // This member is required. DestinationUser *types.ProviderUserIdentifierType // An external IdP account for a user who doesn't exist yet in the user pool. This // 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 OIDC, the - // ProviderAttributeName can be any value that matches a claim in the ID token, or - // that your app retrieves from the userInfo endpoint. You must map the claim to a - // user pool attribute in your IdP configuration, and set the user pool attribute - // name as the value of ProviderAttributeName in your AdminLinkProviderForUser - // request. For SAML, the ProviderAttributeName can be any value that matches a - // claim in the SAML assertion. To link SAML users based on the subject of the SAML + // 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 OIDC, the ProviderAttributeName can be any value that matches a claim in + // the ID token, or that your app retrieves from the userInfo endpoint. You must + // map the claim to a user pool attribute in your IdP configuration, and set the + // user pool attribute name as the value of ProviderAttributeName in your + // AdminLinkProviderForUser request. + // + // For SAML, the ProviderAttributeName can be any value that matches a claim in + // the SAML assertion. To link SAML users based on the subject of the SAML // assertion, map the subject to a claim through the SAML IdP and set that claim // name as the value of ProviderAttributeName in your AdminLinkProviderForUser - // request. For both OIDC and SAML users, when you set ProviderAttributeName to + // request. + // + // For both OIDC and SAML users, when you set ProviderAttributeName to // Cognito_Subject , Amazon Cognito will automatically parse the default unique // identifier found in the subject from the IdP token. // diff --git a/service/cognitoidentityprovider/api_op_AdminListDevices.go b/service/cognitoidentityprovider/api_op_AdminListDevices.go index e0a4d283243..5f37c1ef551 100644 --- a/service/cognitoidentityprovider/api_op_AdminListDevices.go +++ b/service/cognitoidentityprovider/api_op_AdminListDevices.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists devices, as an administrator. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists devices, as an administrator. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminListDevices(ctx context.Context, params *AdminListDevicesInput, optFns ...func(*Options)) (*AdminListDevicesOutput, error) { if params == nil { params = &AdminListDevicesInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go b/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go index a95d6484f39..b37da81157a 100644 --- a/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go +++ b/service/cognitoidentityprovider/api_op_AdminListGroupsForUser.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the groups that a user belongs to. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists the groups that a user belongs to. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminListGroupsForUser(ctx context.Context, params *AdminListGroupsForUserInput, optFns ...func(*Options)) (*AdminListGroupsForUserOutput, error) { if params == nil { params = &AdminListGroupsForUserInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go b/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go index 83e7132f80f..f99434e0324 100644 --- a/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go +++ b/service/cognitoidentityprovider/api_op_AdminListUserAuthEvents.go @@ -12,12 +12,21 @@ import ( ) // A history of user activity and any risks detected as part of Amazon Cognito -// advanced security. Amazon Cognito evaluates Identity and Access Management (IAM) -// policies in requests for this API operation. For this operation, you must use -// IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// advanced security. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminListUserAuthEvents(ctx context.Context, params *AdminListUserAuthEventsInput, optFns ...func(*Options)) (*AdminListUserAuthEventsOutput, error) { if params == nil { params = &AdminListUserAuthEventsInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go b/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go index 0b88a6d4ead..652e1fdf845 100644 --- a/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go +++ b/service/cognitoidentityprovider/api_op_AdminRemoveUserFromGroup.go @@ -10,13 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified user from the specified group. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Removes the specified user from the specified group. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminRemoveUserFromGroup(ctx context.Context, params *AdminRemoveUserFromGroupInput, optFns ...func(*Options)) (*AdminRemoveUserFromGroupOutput, error) { if params == nil { params = &AdminRemoveUserFromGroupInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go b/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go index a66c20401b9..871a0a14d27 100644 --- a/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go +++ b/service/cognitoidentityprovider/api_op_AdminResetUserPassword.go @@ -11,36 +11,52 @@ import ( ) // Resets the specified user's password in a user pool as an administrator. Works -// on any user. To use this API operation, your user pool must have self-service -// account recovery configured. Use AdminSetUserPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html) -// if you manage passwords as an administrator. 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. Deactivates a user's password, requiring -// them to change it. If a user tries to sign in after the API is called, Amazon -// Cognito responds with a PasswordResetRequiredException error. Your app must -// then perform the actions that reset your user's password: the forgot-password -// flow. In addition, if the user pool has phone verification selected and a -// verified phone number exists for the user, or if email verification is selected -// and a verified email exists for the user, calling this API will also result in -// sending a message to the end user with the code to change their password. Amazon -// Cognito evaluates Identity and Access Management (IAM) policies in requests for -// this API operation. For this operation, you must use IAM credentials to -// authorize requests, and you must grant yourself the corresponding IAM permission -// in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// on any user. +// +// To use this API operation, your user pool must have self-service account +// recovery configured. Use [AdminSetUserPassword]if you manage passwords as an administrator. +// +// 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]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// Deactivates a user's password, requiring them to change it. If a user tries to +// sign in after the API is called, Amazon Cognito responds with a +// PasswordResetRequiredException error. Your app must then perform the actions +// that reset your user's password: the forgot-password flow. In addition, if the +// user pool has phone verification selected and a verified phone number exists for +// the user, or if email verification is selected and a verified email exists for +// the user, calling this API will also result in sending a message to the end user +// with the code to change their password. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [AdminSetUserPassword]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) AdminResetUserPassword(ctx context.Context, params *AdminResetUserPasswordInput, optFns ...func(*Options)) (*AdminResetUserPasswordOutput, error) { if params == nil { params = &AdminResetUserPasswordInput{} @@ -74,25 +90,33 @@ type AdminResetUserPasswordInput struct { Username *string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the AdminResetUserPassword - // API action, Amazon Cognito invokes the function that is assigned to the custom - // message trigger. When Amazon Cognito invokes this function, it passes a JSON - // payload, which the function receives as input. This payload contains a - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the AdminResetUserPassword API action, Amazon Cognito + // invokes the function that is assigned to the custom message trigger. When Amazon + // Cognito invokes this function, it passes a JSON payload, which the function + // receives as input. This payload contains a 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] 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. + // + // [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 ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go b/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go index 8ed6bf7754b..438389c57ce 100644 --- a/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go +++ b/service/cognitoidentityprovider/api_op_AdminRespondToAuthChallenge.go @@ -16,27 +16,42 @@ import ( // authentication challenge. An AdminRespondToAuthChallenge API request provides // the answer to that challenge, like a code or a secure remote password (SRP). The // parameters of a response to an authentication challenge vary with the type of -// challenge. For more information about custom authentication challenges, see -// Custom authentication challenge Lambda triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// challenge. +// +// For more information about custom authentication challenges, see [Custom authentication challenge Lambda triggers]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Custom authentication challenge Lambda triggers]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) AdminRespondToAuthChallenge(ctx context.Context, params *AdminRespondToAuthChallengeInput, optFns ...func(*Options)) (*AdminRespondToAuthChallengeOutput, error) { if params == nil { params = &AdminRespondToAuthChallengeInput{} @@ -55,8 +70,9 @@ 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]. + // + // [AdminInitiateAuth]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html // // This member is required. ChallengeName types.ChallengeNameType @@ -77,73 +93,110 @@ type AdminRespondToAuthChallengeInput struct { // The responses to the challenge that you received in the previous request. Each // challenge has its own required response parameters. The following examples are - // partial JSON request bodies that highlight challenge-response parameters. You - // must provide a SECRET_HASH parameter in all challenge responses to an app client - // that has a client secret. SMS_MFA "ChallengeName": "SMS_MFA", - // "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"} + // partial JSON request bodies that highlight challenge-response parameters. + // + // You must provide a SECRET_HASH parameter in all challenge responses to an app + // client that has a client secret. + // + // SMS_MFA "ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": + // "[SMS_code]", "USERNAME": "[username]"} + // // PASSWORD_VERIFIER "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": // {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": - // "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} Add - // "DEVICE_KEY" when you sign in with a remembered device. CUSTOM_CHALLENGE - // "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": - // "[username]", "ANSWER": "[challenge_answer]"} Add "DEVICE_KEY" when you sign in - // with a remembered device. NEW_PASSWORD_REQUIRED "ChallengeName": - // "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": - // "[new_password]", "USERNAME": "[username]"} To set any required attributes that - // InitiateAuth returned in an requiredAttributes parameter, add - // "userAttributes.[attribute_name]": "[attribute_value]" . 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 "ChallengeName": "SOFTWARE_TOKEN_MFA", - // "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": - // [authenticator_code]} DEVICE_SRP_AUTH "ChallengeName": "DEVICE_SRP_AUTH", - // "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", - // "SRP_A": "[srp_a]"} DEVICE_PASSWORD_VERIFIER "ChallengeName": - // "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", - // "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": - // "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} MFA_SETUP - // "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, - // "SESSION": "[Session ID from VerifySoftwareToken]" SELECT_MFA_TYPE - // "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": - // "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"} For more information - // about SECRET_HASH , see Computing secret hash values (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash) - // . For information about DEVICE_KEY , see Working with user devices in your user - // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) - // . + // "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} + // + // Add "DEVICE_KEY" when you sign in with a remembered device. + // + // CUSTOM_CHALLENGE "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": + // {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"} + // + // Add "DEVICE_KEY" when you sign in with a remembered device. + // + // NEW_PASSWORD_REQUIRED "ChallengeName": "NEW_PASSWORD_REQUIRED", + // "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": + // "[username]"} + // + // To set any required attributes that InitiateAuth returned in an + // requiredAttributes parameter, add "userAttributes.[attribute_name]": + // "[attribute_value]" . 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 "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": + // {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]} + // + // DEVICE_SRP_AUTH "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": + // {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"} + // + // DEVICE_PASSWORD_VERIFIER "ChallengeName": "DEVICE_PASSWORD_VERIFIER", + // "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": + // "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", + // "TIMESTAMP": [timestamp], "USERNAME": "[username]"} + // + // MFA_SETUP "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": + // "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]" + // + // SELECT_MFA_TYPE "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": + // {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"} + // + // For more information about SECRET_HASH , see [Computing secret hash values]. For information about DEVICE_KEY + // , see [Working with user devices in your user pool]. + // + // [Computing secret hash values]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash + // [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html ChallengeResponses map[string]string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // 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: + // workflows that this action triggers. + // + // You create custom workflows by assigning 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // your specific needs. + // + // For more information, see [Customizing user pool Workflows with Lambda Triggers] 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. + // + // [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 ClientMetadata map[string]string // Contextual data about your user session, such as the device fingerprint, IP @@ -168,12 +221,14 @@ 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]. + // + // [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]. + // + // [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_AdminSetUserMFAPreference.go b/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go index 46eb3a49db8..cf78d51231d 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserMFAPreference.go @@ -16,12 +16,21 @@ import ( // preferred. The preferred MFA factor will be used to authenticate a user if // multiple factors are activated. If multiple options are activated and no // preference is set, a challenge to choose an MFA option will be returned during -// sign-in. Amazon Cognito evaluates Identity and Access Management (IAM) policies -// in requests for this API operation. For this operation, you must use IAM +// sign-in. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminSetUserMFAPreference(ctx context.Context, params *AdminSetUserMFAPreferenceInput, optFns ...func(*Options)) (*AdminSetUserMFAPreferenceOutput, error) { if params == nil { params = &AdminSetUserMFAPreferenceInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go b/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go index b3730a826c1..bd4d8d77b65 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserPassword.go @@ -11,28 +11,42 @@ import ( ) // Sets the specified user's password in a user pool as an administrator. Works on -// any user. The password can be temporary or permanent. If it is temporary, the -// user status enters the FORCE_CHANGE_PASSWORD state. When the user next tries to -// sign in, the InitiateAuth/AdminInitiateAuth response will contain the +// any user. +// +// The password can be temporary or permanent. If it is temporary, the user status +// enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, +// the InitiateAuth/AdminInitiateAuth response will contain the // 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 . AdminSetUserPassword can set a password -// for the user profile that Amazon Cognito creates for third-party federated -// users. When you set a password, the federated user's status changes from -// EXTERNAL_PROVIDER to CONFIRMED . A user in this state can sign in as a federated -// user, and initiate authentication flows in the API like a linked native user. -// They can also modify their password and attributes in token-authenticated API -// requests like ChangePassword and UpdateUserAttributes . As a best security -// practice and to keep users in sync with your external IdP, don't set passwords -// on federated user profiles. To set up a federated user for native sign-in with a -// linked native user, refer to Linking federated users to an existing user profile (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) -// . Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// password. +// +// Once the user has set a new password, or the password is permanent, the user +// status is set to Confirmed . +// +// AdminSetUserPassword can set a password for the user profile that Amazon +// Cognito creates for third-party federated users. When you set a password, the +// federated user's status changes from EXTERNAL_PROVIDER to CONFIRMED . A user in +// this state can sign in as a federated user, and initiate authentication flows in +// the API like a linked native user. They can also modify their password and +// attributes in token-authenticated API requests like ChangePassword and +// UpdateUserAttributes . As a best security practice and to keep users in sync +// with your external IdP, don't set passwords on federated user profiles. To set +// up a federated user for native sign-in with a linked native user, refer to [Linking federated users to an existing user profile]. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Linking federated users to an existing user profile]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html 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 5cdd513d41b..d9f591cdf6a 100644 --- a/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go +++ b/service/cognitoidentityprovider/api_op_AdminSetUserSettings.go @@ -11,15 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is no longer supported. You can use it to configure only SMS MFA. +// 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) -// instead. Amazon Cognito evaluates Identity and Access Management (IAM) policies -// in requests for this API operation. For this operation, you must use IAM +// MFA. To configure either type of MFA, use [AdminSetUserMFAPreference]instead. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [AdminSetUserMFAPreference]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html func (c *Client) AdminSetUserSettings(ctx context.Context, params *AdminSetUserSettingsInput, optFns ...func(*Options)) (*AdminSetUserSettingsOutput, error) { if params == nil { params = &AdminSetUserSettingsInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go b/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go index 41ff0d5da6c..8ffacb18a50 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateAuthEventFeedback.go @@ -13,13 +13,21 @@ import ( // Provides feedback for an authentication event indicating if it was from a valid // user. This feedback is used for improving the risk evaluation decision for the -// user pool as part of Amazon Cognito advanced security. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// user pool as part of Amazon Cognito advanced security. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminUpdateAuthEventFeedback(ctx context.Context, params *AdminUpdateAuthEventFeedbackInput, optFns ...func(*Options)) (*AdminUpdateAuthEventFeedbackOutput, error) { if params == nil { params = &AdminUpdateAuthEventFeedbackInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go b/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go index 3054d1fce30..7e5a0927556 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateDeviceStatus.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the device status as an administrator. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Updates the device status as an administrator. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) AdminUpdateDeviceStatus(ctx context.Context, params *AdminUpdateDeviceStatusInput, optFns ...func(*Options)) (*AdminUpdateDeviceStatusOutput, error) { if params == nil { params = &AdminUpdateDeviceStatusInput{} diff --git a/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go b/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go index 5e98acc40ac..aa04d52243f 100644 --- a/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_AdminUpdateUserAttributes.go @@ -14,28 +14,44 @@ import ( // 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. Updates the specified user's attributes, -// including developer attributes, as an administrator. Works on any user. To -// delete an attribute from your user, submit the attribute in your API request -// with a blank value. For custom attributes, you must prepend the custom: prefix -// to the attribute name. In addition to updating user attributes, this API can -// also be used to mark phone and email as verified. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// Updates the specified user's attributes, including developer attributes, as an +// administrator. Works on any user. To delete an attribute from your user, submit +// the attribute in your API request with a blank value. +// +// For custom attributes, you must prepend the custom: prefix to the attribute +// name. +// +// In addition to updating user attributes, this API can also be used to mark +// phone and email as verified. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) AdminUpdateUserAttributes(ctx context.Context, params *AdminUpdateUserAttributesInput, optFns ...func(*Options)) (*AdminUpdateUserAttributesOutput, error) { if params == nil { params = &AdminUpdateUserAttributesInput{} @@ -54,19 +70,23 @@ func (c *Client) AdminUpdateUserAttributes(ctx context.Context, params *AdminUpd // Represents the request to update the user's attributes as an administrator. type AdminUpdateUserAttributesInput struct { - // An array of name-value pairs representing user attributes. For custom - // attributes, you must prepend the custom: prefix to the attribute name. If your - // user pool requires verification before Amazon Cognito updates an attribute value - // that you specify in this request, Amazon Cognito doesn’t immediately update the - // value of that attribute. After your user receives and responds to a verification - // message to verify the new value, Amazon Cognito updates the attribute value. - // 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 - // 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 - // verification message to your user. + // An array of name-value pairs representing user attributes. + // + // For custom attributes, you must prepend the custom: prefix to the attribute + // name. + // + // If your user pool requires verification before Amazon Cognito updates an + // attribute value that you specify in this request, Amazon Cognito doesn’t + // immediately update the value of that attribute. After your user receives and + // responds to a verification message to verify the new value, Amazon Cognito + // updates the attribute value. 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 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 verification message to your user. // // This member is required. UserAttributes []types.AttributeType @@ -86,25 +106,34 @@ type AdminUpdateUserAttributesInput struct { Username *string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the - // AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that - // is assigned to the custom message trigger. When Amazon Cognito invokes this - // function, it passes a JSON payload, which the function receives as input. This - // payload contains a clientMetadata attribute, which provides the data that you - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito + // invokes the function that is assigned to the custom message trigger. When Amazon + // Cognito invokes this function, it passes a JSON payload, which the function + // receives as input. This payload contains a clientMetadata attribute, which + // provides the data that you 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] 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. + // + // [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 ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go b/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go index c3b704ab43f..543b75595ce 100644 --- a/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go +++ b/service/cognitoidentityprovider/api_op_AdminUserGlobalSignOut.go @@ -13,26 +13,40 @@ import ( // Invalidates the identity, access, and refresh tokens that Amazon Cognito issued // to a user. Call this operation with your administrative credentials when your // user signs out of your app. This results in the following behavior. +// // - Amazon Cognito no longer accepts token-authorized user operations that you -// authorize with a signed-out user's access tokens. For more information, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . Amazon Cognito returns an Access Token has been revoked error when your app -// attempts to authorize a user pools API request with a revoked access token that -// contains the scope aws.cognito.signin.user.admin . -// - Amazon Cognito no longer accepts a signed-out user's ID token in a GetId (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html) -// request to an identity pool with ServerSideTokenCheck enabled for its user -// pool IdP configuration in CognitoIdentityProvider (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html) -// . -// - Amazon Cognito no longer accepts a signed-out user's refresh tokens in -// refresh requests. +// authorize with a signed-out user's access tokens. For more information, see [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// Amazon Cognito returns an Access Token has been revoked error when your app +// +// attempts to authorize a user pools API request with a revoked access token that +// contains the scope aws.cognito.signin.user.admin . +// +// - Amazon Cognito no longer accepts a signed-out user's ID token in a [GetId]request +// to an identity pool with ServerSideTokenCheck enabled for its user pool IdP +// configuration in [CognitoIdentityProvider]. +// +// - Amazon Cognito no longer accepts a signed-out user's refresh tokens in +// refresh requests. +// +// Other requests might be valid until your user's token expires. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html // -// Other requests might be valid until your user's token expires. Amazon Cognito -// evaluates Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// [CognitoIdentityProvider]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html +// [GetId]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html func (c *Client) AdminUserGlobalSignOut(ctx context.Context, params *AdminUserGlobalSignOutInput, optFns ...func(*Options)) (*AdminUserGlobalSignOutOutput, error) { if params == nil { params = &AdminUserGlobalSignOutInput{} diff --git a/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go b/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go index 76cfccebb08..d12c8896d2d 100644 --- a/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go +++ b/service/cognitoidentityprovider/api_op_AssociateSoftwareToken.go @@ -14,23 +14,27 @@ import ( // (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) -// 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 -// set up software token MFA for your user, Amazon Cognito generates 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]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 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. Amazon Cognito doesn't evaluate Identity and Access -// Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// with your user's TOTP. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [VerifySoftwareToken]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html func (c *Client) AssociateSoftwareToken(ctx context.Context, params *AssociateSoftwareTokenInput, optFns ...func(*Options)) (*AssociateSoftwareTokenOutput, error) { if params == nil { params = &AssociateSoftwareTokenInput{} diff --git a/service/cognitoidentityprovider/api_op_ChangePassword.go b/service/cognitoidentityprovider/api_op_ChangePassword.go index 4c184a9fd09..178aa7aa43e 100644 --- a/service/cognitoidentityprovider/api_op_ChangePassword.go +++ b/service/cognitoidentityprovider/api_op_ChangePassword.go @@ -10,15 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the password for a specified user in a user pool. Authorize this action -// with a signed-in user's access token. It must include the scope -// aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// Changes the password for a specified user in a user pool. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput, optFns ...func(*Options)) (*ChangePasswordOutput, error) { if params == nil { params = &ChangePasswordInput{} diff --git a/service/cognitoidentityprovider/api_op_ConfirmDevice.go b/service/cognitoidentityprovider/api_op_ConfirmDevice.go index cc306191076..9f561cf2395 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmDevice.go +++ b/service/cognitoidentityprovider/api_op_ConfirmDevice.go @@ -12,16 +12,19 @@ import ( ) // Confirms tracking of the device. This API call is the call that begins device -// tracking. For more information about device authentication, see Working with -// user devices in your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) -// . Authorize this action with a signed-in user's access token. It must include -// the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// tracking. For more information about device authentication, see [Working with user devices in your user pool]. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html func (c *Client) ConfirmDevice(ctx context.Context, params *ConfirmDeviceInput, optFns ...func(*Options)) (*ConfirmDeviceOutput, error) { if params == nil { params = &ConfirmDeviceInput{} diff --git a/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go b/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go index 65f3ff5646a..f53c8829f0a 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go +++ b/service/cognitoidentityprovider/api_op_ConfirmForgotPassword.go @@ -12,12 +12,14 @@ import ( ) // Allows a user to enter a confirmation code to reset a forgotten password. -// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in -// requests for this API operation. For this operation, you can't use IAM +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM // credentials to authorize requests, and you can't grant IAM permissions in // policies. For more information about authorization models in Amazon Cognito, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) ConfirmForgotPassword(ctx context.Context, params *ConfirmForgotPasswordInput, optFns ...func(*Options)) (*ConfirmForgotPasswordOutput, error) { if params == nil { params = &ConfirmForgotPasswordInput{} @@ -42,8 +44,9 @@ type ConfirmForgotPasswordInput struct { 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) - // . + // more information, see [ForgotPassword]. + // + // [ForgotPassword]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html // // This member is required. ConfirmationCode *string @@ -67,31 +70,41 @@ type ConfirmForgotPasswordInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the ConfirmForgotPassword - // API action, Amazon Cognito invokes the function that is assigned to the post - // confirmation trigger. When Amazon Cognito invokes this function, it passes a - // JSON payload, which the function receives as input. This payload contains a - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito + // invokes the function that is assigned to the post confirmation trigger. When + // Amazon Cognito invokes this function, it passes a JSON payload, which the + // function receives as input. This payload contains a 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] 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. + // + // [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 ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key // of a user pool client and username plus the client ID in the message. For more - // information about SecretHash , see Computing secret hash values (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash) - // . + // information about SecretHash , see [Computing secret hash values]. + // + // [Computing secret hash values]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash SecretHash *string // Contextual data about your user session, such as the device fingerprint, IP diff --git a/service/cognitoidentityprovider/api_op_ConfirmSignUp.go b/service/cognitoidentityprovider/api_op_ConfirmSignUp.go index 5fb8601c60f..d56afc8c940 100644 --- a/service/cognitoidentityprovider/api_op_ConfirmSignUp.go +++ b/service/cognitoidentityprovider/api_op_ConfirmSignUp.go @@ -12,24 +12,28 @@ import ( ) // This public API operation provides a code that Amazon Cognito sent to your user -// when they signed up in your user pool via the SignUp (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html) -// API operation. After your user enters their code, they confirm ownership of the -// email address or phone number that they provided, and their user account becomes -// active. Depending on your user pool configuration, your users will receive their -// confirmation code in an email or SMS message. Local users who signed up in your -// user pool are the only type of user who can confirm sign-up with a code. Users -// who federate through an external identity provider (IdP) have already been -// confirmed by their IdP. Administrator-created users, users created with the -// AdminCreateUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html) -// API operation, confirm their accounts when they respond to their invitation -// email message and choose a password. They do not receive a confirmation code. -// Instead, they receive a temporary password. Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// when they signed up in your user pool via the [SignUp]API operation. After your user +// enters their code, they confirm ownership of the email address or phone number +// that they provided, and their user account becomes active. Depending on your +// user pool configuration, your users will receive their confirmation code in an +// email or SMS message. +// +// Local users who signed up in your user pool are the only type of user who can +// confirm sign-up with a code. Users who federate through an external identity +// provider (IdP) have already been confirmed by their IdP. Administrator-created +// users, users created with the [AdminCreateUser]API operation, confirm their accounts when they +// respond to their invitation email message and choose a password. They do not +// receive a confirmation code. Instead, they receive a temporary password. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [SignUp]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [AdminCreateUser]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html func (c *Client) ConfirmSignUp(ctx context.Context, params *ConfirmSignUpInput, optFns ...func(*Options)) (*ConfirmSignUpOutput, error) { if params == nil { params = &ConfirmSignUpInput{} @@ -72,25 +76,33 @@ type ConfirmSignUpInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the ConfirmSignUp API - // action, Amazon Cognito invokes the function that is assigned to the post - // confirmation trigger. When Amazon Cognito invokes this function, it passes a - // JSON payload, which the function receives as input. This payload contains a - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the + // function that is assigned to the post confirmation trigger. When Amazon Cognito + // invokes this function, it passes a JSON payload, which the function receives as + // input. This payload contains a 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] 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. + // + // [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 ClientMetadata map[string]string // Boolean to be specified to force user confirmation irrespective of existing diff --git a/service/cognitoidentityprovider/api_op_CreateGroup.go b/service/cognitoidentityprovider/api_op_CreateGroup.go index 19715ff8ded..c68ac633200 100644 --- a/service/cognitoidentityprovider/api_op_CreateGroup.go +++ b/service/cognitoidentityprovider/api_op_CreateGroup.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new group in the specified user pool. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Creates a new group in the specified user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -54,13 +62,15 @@ 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 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 . + // 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 . 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 b9feee2dd16..f6dbc5ecdae 100644 --- a/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go +++ b/service/cognitoidentityprovider/api_op_CreateIdentityProvider.go @@ -12,12 +12,21 @@ import ( ) // Adds a configuration and trust relationship between a third-party identity -// provider (IdP) and a user pool. Amazon Cognito evaluates Identity and Access -// Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// provider (IdP) and a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) CreateIdentityProvider(ctx context.Context, params *CreateIdentityProviderInput, optFns ...func(*Options)) (*CreateIdentityProviderOutput, error) { if params == nil { params = &CreateIdentityProviderInput{} @@ -38,71 +47,96 @@ type CreateIdentityProviderInput struct { // The scopes, URLs, and identifiers for your external identity provider. The // following examples describe the provider detail keys for each IdP type. These // values and their schema are subject to change. Social IdP authorize_scopes - // values must match the values listed here. OpenID Connect (OIDC) Amazon Cognito - // accepts the following elements when it can't discover endpoint URLs from - // oidc_issuer : attributes_url , authorize_url , jwks_uri , token_url . Create or - // update request: "ProviderDetails": { "attributes_request_method": "GET", - // "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": - // "openid profile email", "authorize_url": "https://auth.example.com/authorize", - // "client_id": "1example23456789", "client_secret": "provider-app-client-secret", - // "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": - // "https://auth.example.com", "token_url": "https://example.com/token" } Describe - // response: "ProviderDetails": { "attributes_request_method": "GET", + // values must match the values listed here. + // + // OpenID Connect (OIDC) Amazon Cognito accepts the following elements when it + // can't discover endpoint URLs from oidc_issuer : attributes_url , authorize_url , + // jwks_uri , token_url . + // + // Create or update request: "ProviderDetails": { "attributes_request_method": + // "GET", "attributes_url": "https://auth.example.com/userInfo", + // "authorize_scopes": "openid profile email", "authorize_url": + // "https://auth.example.com/authorize", "client_id": "1example23456789", + // "client_secret": "provider-app-client-secret", "jwks_uri": + // "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": + // "https://auth.example.com", "token_url": "https://example.com/token" } + // + // Describe response: "ProviderDetails": { "attributes_request_method": "GET", // "attributes_url": "https://auth.example.com/userInfo", // "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile // email", "authorize_url": "https://auth.example.com/authorize", "client_id": // "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": // "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": - // "https://auth.example.com", "token_url": "https://example.com/token" } SAML - // Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": - // "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": - // "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": - // "rsa-sha256" } Create or update request with Metadata file: "ProviderDetails": - // { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", - // "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" } The - // value of MetadataFile must be the plaintext metadata document with all quote - // (") characters escaped by backslashes. Describe response: "ProviderDetails": { + // "https://auth.example.com", "token_url": "https://example.com/token" } + // + // SAML Create or update request with Metadata URL: "ProviderDetails": { // "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", - // "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": - // "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": - // "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", - // "SSORedirectBindingURI": "https://auth.example.com/sso/saml" } LoginWithAmazon - // Create or update request: "ProviderDetails": { "authorize_scopes": "profile - // postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", - // "client_secret": "provider-app-client-secret" Describe response: - // "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", - // "attributes_url_add_attributes": "false", "authorize_scopes": "profile - // postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": + // "MetadataURL": "https://auth.example.com/sso/saml/metadata", + // "RequestSigningAlgorithm": "rsa-sha256" } + // + // Create or update request with Metadata file: "ProviderDetails": { "IDPInit": + // "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": + // "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" } + // + // The value of MetadataFile must be the plaintext metadata document with all + // quote (") characters escaped by backslashes. + // + // Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": + // "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": + // "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", + // "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": + // "https://auth.example.com/slo/saml", "SSORedirectBindingURI": + // "https://auth.example.com/sso/saml" } + // + // LoginWithAmazon Create or update request: "ProviderDetails": { + // "authorize_scopes": "profile postal_code", "client_id": + // "amzn1.application-oa2-client.1example23456789", "client_secret": + // "provider-app-client-secret" + // + // Describe response: "ProviderDetails": { "attributes_url": + // "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", + // "authorize_scopes": "profile postal_code", "authorize_url": + // "https://www.amazon.com/ap/oa", "client_id": // "amzn1.application-oa2-client.1example23456789", "client_secret": // "provider-app-client-secret", "token_request_method": "POST", "token_url": - // "https://api.amazon.com/auth/o2/token" } Google Create or update request: - // "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": + // "https://api.amazon.com/auth/o2/token" } + // + // Google Create or update request: "ProviderDetails": { "authorize_scopes": + // "email profile openid", "client_id": // "1example23456789.apps.googleusercontent.com", "client_secret": - // "provider-app-client-secret" } Describe response: "ProviderDetails": { - // "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", + // "provider-app-client-secret" } + // + // Describe response: "ProviderDetails": { "attributes_url": + // "https://people.googleapis.com/v1/people/me?personFields=", // "attributes_url_add_attributes": "true", "authorize_scopes": "email profile // openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", // "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": // "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", // "token_request_method": "POST", "token_url": - // "https://www.googleapis.com/oauth2/v4/token" } SignInWithApple Create or update - // request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": - // "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", - // "team_id": "3EXAMPLE" } Describe response: "ProviderDetails": { - // "attributes_url_add_attributes": "false", "authorize_scopes": "email name", - // "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": - // "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": - // "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": - // "POST", "token_url": "https://appleid.apple.com/auth/token" } Facebook Create or - // update request: "ProviderDetails": { "api_version": "v17.0", + // "https://www.googleapis.com/oauth2/v4/token" } + // + // SignInWithApple Create or update request: "ProviderDetails": { + // "authorize_scopes": "email name", "client_id": "com.example.cognito", + // "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" } + // + // Describe response: "ProviderDetails": { "attributes_url_add_attributes": + // "false", "authorize_scopes": "email name", "authorize_url": + // "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", + // "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": + // "2EXAMPLE", "token_request_method": "POST", "token_url": + // "https://appleid.apple.com/auth/token" } + // + // Facebook Create or update request: "ProviderDetails": { "api_version": "v17.0", // "authorize_scopes": "public_profile, email", "client_id": "1example23456789", - // "client_secret": "provider-app-client-secret" } Describe response: - // "ProviderDetails": { "api_version": "v17.0", "attributes_url": - // "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": - // "true", "authorize_scopes": "public_profile, email", "authorize_url": - // "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", - // "client_secret": "provider-app-client-secret", "token_request_method": "GET", - // "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" } + // "client_secret": "provider-app-client-secret" } + // + // Describe response: "ProviderDetails": { "api_version": "v17.0", + // "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", + // "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, + // email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", + // "client_id": "1example23456789", "client_secret": "provider-app-client-secret", + // "token_request_method": "GET", "token_url": + // "https://graph.facebook.com/v17.0/oauth/access_token" } // // 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 e347efb1161..adda56f7371 100644 --- a/service/cognitoidentityprovider/api_op_CreateResourceServer.go +++ b/service/cognitoidentityprovider/api_op_CreateResourceServer.go @@ -12,12 +12,20 @@ import ( ) // Creates a new OAuth2.0 resource server and defines custom scopes within it. +// // Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) CreateResourceServer(ctx context.Context, params *CreateResourceServerInput, optFns ...func(*Options)) (*CreateResourceServerOutput, error) { if params == nil { params = &CreateResourceServerInput{} @@ -37,8 +45,9 @@ type CreateResourceServerInput struct { // A unique resource server identifier for the resource server. The identifier can // be an API friendly name like solar-system-data . You can also set an API URL - // like https://solar-system-data-api.example.com as your identifier. Amazon - // Cognito represents scopes in the access token in the format + // like https://solar-system-data-api.example.com as your identifier. + // + // Amazon Cognito represents scopes in the access token in the format // $resource-server-identifier/$scope . Longer scope-identifier strings increase // the size of your access tokens. // diff --git a/service/cognitoidentityprovider/api_op_CreateUserImportJob.go b/service/cognitoidentityprovider/api_op_CreateUserImportJob.go index 0b33542ae63..aeb34f8f417 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserImportJob.go +++ b/service/cognitoidentityprovider/api_op_CreateUserImportJob.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a user import job. Amazon Cognito evaluates Identity and Access -// Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Creates a user import job. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) CreateUserImportJob(ctx context.Context, params *CreateUserImportJobInput, optFns ...func(*Options)) (*CreateUserImportJobOutput, error) { if params == nil { params = &CreateUserImportJobInput{} diff --git a/service/cognitoidentityprovider/api_op_CreateUserPool.go b/service/cognitoidentityprovider/api_op_CreateUserPool.go index 758c682eed9..c0bd4b8ea13 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPool.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPool.go @@ -14,25 +14,40 @@ import ( // 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. Creates a new Amazon Cognito user pool -// and sets the password policy for the pool. If you don't provide a value for an -// attribute, Amazon Cognito sets it to its default value. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// Creates a new Amazon Cognito user pool and sets the password policy for the +// pool. +// +// If you don't provide a value for an attribute, Amazon Cognito sets it to its +// default value. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) CreateUserPool(ctx context.Context, params *CreateUserPoolInput, optFns ...func(*Options)) (*CreateUserPoolOutput, error) { if params == nil { params = &CreateUserPoolInput{} @@ -77,16 +92,19 @@ type CreateUserPoolInput struct { // When active, DeletionProtection prevents accidental deletion of your user pool. // Before you can delete a user pool that you have protected against deletion, you - // must deactivate this feature. When you try to delete a protected user pool in a - // DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException - // error. To delete a protected user pool, send a new DeleteUserPool request after - // you deactivate deletion protection in an UpdateUserPool API request. + // must deactivate this feature. + // + // When you try to delete a protected user pool in a DeleteUserPool API request, + // Amazon Cognito returns an InvalidParameterException error. To delete a + // protected user pool, send a new DeleteUserPool request after you deactivate + // deletion protection in an UpdateUserPool API request. DeletionProtection types.DeletionProtectionType // The device-remembering configuration for a user pool. A null value indicates - // that you have deactivated device remembering in your user pool. When you provide - // a value for any DeviceConfiguration field, you activate the Amazon Cognito - // device-remembering feature. + // that you have deactivated device remembering in your user pool. + // + // When you provide a value for any DeviceConfiguration field, you activate the + // Amazon Cognito device-remembering feature. DeviceConfiguration *types.DeviceConfigurationType // The email configuration of your user pool. The email configuration type sets @@ -94,21 +112,28 @@ 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]. + // + // [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]. + // + // [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) - // . + // 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] . + // + // For adding permission using the CLI, see[add-permission] . + // + // [AddPermission]: https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html + // [add-permission]: https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html LambdaConfig *types.LambdaConfigType // Specifies MFA configuration details. @@ -131,23 +156,27 @@ 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]. + // + // [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) - // . + // address and phone number attributes. For more information, see [Verifying updates to email addresses and phone numbers]. + // + // [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 // User pool add-ons. Contains settings for activation of advanced security // features. To log user security information but take no action, set to AUDIT . To // configure automatic security responses to risky traffic to your user pool, set - // to ENFORCED . For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) - // . + // to ENFORCED . + // + // For more information, see [Adding advanced security to a user pool]. + // + // [Adding advanced security to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html UserPoolAddOns *types.UserPoolAddOnsType // The tag keys and values to assign to the user pool. A tag is a label that you @@ -166,9 +195,11 @@ type CreateUserPoolInput struct { // use cases, set case sensitivity to False (case insensitive) as a best practice. // When usernames and email addresses are case insensitive, Amazon Cognito treats // any variation in case as the same user, and prevents a case variation from being - // assigned to the same attribute for a different user. This configuration is - // immutable after you set it. For more information, see UsernameConfigurationType (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html) - // . + // assigned to the same attribute for a different user. + // + // This configuration is immutable after you set it. For more information, see [UsernameConfigurationType]. + // + // [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 79c6288c186..ef987ea0eef 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPoolClient.go @@ -11,16 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . If you don't provide a value for an attribute, Amazon Cognito sets it to its -// default value. Amazon Cognito evaluates Identity and Access Management (IAM) -// policies in requests for this API operation. For this operation, you must use -// IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// 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]. +// +// If you don't provide a value for an attribute, Amazon Cognito sets it to its +// default value. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [RevokeToken]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) CreateUserPoolClient(ctx context.Context, params *CreateUserPoolClientInput, optFns ...func(*Options)) (*CreateUserPoolClientOutput, error) { if params == nil { params = &CreateUserPoolClientInput{} @@ -52,33 +64,48 @@ type CreateUserPoolClientInput 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. + // 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 OAuth grant types that you want your app client to generate. To create an // app client that generates client credentials grants, you must add - // client_credentials as the only allowed OAuth flow. code Use a code grant flow, - // which provides an authorization code as the response. This code can be exchanged - // for access tokens with the /oauth2/token endpoint. implicit Issue the access - // token (and, optionally, ID token, based on scopes) directly to your user. + // client_credentials as the only allowed OAuth flow. + // + // code Use a code grant flow, which provides an authorization code as the + // response. This code can be exchanged for access tokens with the /oauth2/token + // endpoint. + // + // implicit Issue the access token (and, optionally, ID token, based on scopes) + // directly to your user. + // // client_credentials Issue the access token from the /oauth2/token endpoint // directly to a non-person user using a combination of the client ID and client // secret. AllowedOAuthFlows []types.OAuthFlowType // Set to true to use OAuth 2.0 features in your user pool app client. + // // AllowedOAuthFlowsUserPoolClient must be true before you can configure the // following features in your app client. + // // - CallBackURLs : Callback URLs. + // // - LogoutURLs : Sign-out redirect URLs. + // // - AllowedOAuthScopes : OAuth 2.0 scopes. + // // - AllowedOAuthFlows : Support for authorization code, implicit, and client // credentials OAuth 2.0 grants. + // // To use OAuth 2.0 features, configure one of these features in the Amazon // Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a // CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a @@ -93,11 +120,13 @@ type CreateUserPoolClientInput struct { 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 - // 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. + // 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 @@ -106,61 +135,93 @@ type CreateUserPoolClientInput struct { // challenge before the session expires. AuthSessionValidity *int32 - // A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: + // 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. + // + // See [OAuth 2.0 - Redirection Endpoint]. + // + // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. + // + // App callback URLs such as myapp://example are also supported. + // + // [OAuth 2.0 - Redirection Endpoint]: https://tools.ietf.org/html/rfc6749#section-3.1.2 CallbackURLs []string // The default redirect URI. In app clients with one assigned IdP, replaces - // redirect_uri in authentication requests. Must be in the CallbackURLs list. A - // redirect URI must: + // redirect_uri in authentication requests. 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. - // For more information, see Default redirect URI (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about) - // . Amazon Cognito requires HTTPS over HTTP except for http://localhost for - // testing purposes only. App callback URLs such as myapp://example are also - // supported. + // + // For more information, see [Default redirect URI]. + // + // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. + // + // App callback URLs such as myapp://example are also supported. + // + // [Default redirect URI]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#cognito-user-pools-app-idp-settings-about 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 - // information, including source IP address, to Amazon Cognito advanced security. - // You can only activate EnablePropagateAdditionalUserContextData in an app client - // that has a client secret. + // about propagation of user context data, see [Adding advanced security to a user pool]. 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. + // + // [Adding advanced security to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html 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 + // tokens, see [RevokeToken]. + // + // If you don't include this parameter, token revocation is automatically // activated for the new user pool client. + // + // [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 // each app client in your user pool, you can sign in your users with any // 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: + // 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 @@ -173,12 +234,16 @@ type CreateUserPoolClientInput struct { // 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 IdTokenValidity 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. + // , 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 IdTokenValidity 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 // A list of allowed logout URLs for the IdPs. @@ -191,8 +256,12 @@ type CreateUserPoolClientInput struct { // 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: + // 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 @@ -201,27 +270,35 @@ type CreateUserPoolClientInput struct { // access to. After your user authenticates in your app, their access token // authorizes them to read their own attribute value for any attribute in this // list. An example of this kind of activity is when your user selects a link to - // view their profile information. Your app makes a GetUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) - // API request to retrieve and display your user's profile data. When you don't - // specify the ReadAttributes for your app client, your app can read the values of - // email_verified , phone_number_verified , and the Standard attributes of your - // user pool. When your user pool has read access to these default attributes, - // ReadAttributes doesn't return any information. Amazon Cognito only populates - // ReadAttributes in the API response if you have specified your own custom set of - // read attributes. + // view their profile information. Your app makes a [GetUser]API request to retrieve and + // display your user's profile data. + // + // When you don't specify the ReadAttributes for your app client, your app can + // read the values of email_verified , phone_number_verified , and the Standard + // attributes of your user pool. When your user pool has read access to these + // default attributes, ReadAttributes doesn't return any information. Amazon + // Cognito only populates ReadAttributes in the API response if you have specified + // your own custom set of read attributes. + // + // [GetUser]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html ReadAttributes []string // 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. + // 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 @@ -240,20 +317,23 @@ type CreateUserPoolClientInput struct { // them to set or modify their own attribute value for any attribute in this list. // An example of this kind of activity is when you present your user with a form to // update their profile information and they change their last name. Your app then - // makes an UpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) - // API request and sets family_name to the new value. When you don't specify the - // WriteAttributes for your app client, your app can write the values of the - // Standard attributes of your user pool. When your user pool has write access to - // these default attributes, WriteAttributes doesn't return any information. - // Amazon Cognito only populates WriteAttributes in the API response if you have - // specified your own custom set of write attributes. If your app client allows - // users to sign in through an IdP, this array must include all attributes that you - // have mapped to IdP attributes. Amazon Cognito updates mapped attributes 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) - // . + // makes an [UpdateUserAttributes]API request and sets family_name to the new value. + // + // When you don't specify the WriteAttributes for your app client, your app can + // write the values of the Standard attributes of your user pool. When your user + // pool has write access to these default attributes, WriteAttributes doesn't + // return any information. Amazon Cognito only populates WriteAttributes in the + // API response if you have specified your own custom set of write attributes. + // + // If your app client allows users to sign in through an IdP, this array must + // include all attributes that you have mapped to IdP attributes. Amazon Cognito + // updates mapped attributes 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]. + // + // [Specifying IdP Attribute Mappings for Your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html + // [UpdateUserAttributes]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html WriteAttributes []string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go b/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go index 52ef323238a..a05e0276d0f 100644 --- a/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_CreateUserPoolDomain.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new domain for a user pool. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Creates a new domain for a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) CreateUserPoolDomain(ctx context.Context, params *CreateUserPoolDomainInput, optFns ...func(*Options)) (*CreateUserPoolDomainOutput, error) { if params == nil { params = &CreateUserPoolDomainInput{} @@ -47,11 +56,15 @@ type CreateUserPoolDomainInput struct { UserPoolId *string // The configuration for a custom domain that hosts the sign-up and sign-in - // 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) - // . + // 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]. + // + // [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_DeleteGroup.go b/service/cognitoidentityprovider/api_op_DeleteGroup.go index 448a5b9fbe2..80c2fe776c4 100644 --- a/service/cognitoidentityprovider/api_op_DeleteGroup.go +++ b/service/cognitoidentityprovider/api_op_DeleteGroup.go @@ -10,7 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a group. Calling this action requires developer credentials. +// Deletes a group. +// +// Calling this action requires developer credentials. func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error) { if params == nil { params = &DeleteGroupInput{} diff --git a/service/cognitoidentityprovider/api_op_DeleteUser.go b/service/cognitoidentityprovider/api_op_DeleteUser.go index 0a48e20226e..4e77fd9666e 100644 --- a/service/cognitoidentityprovider/api_op_DeleteUser.go +++ b/service/cognitoidentityprovider/api_op_DeleteUser.go @@ -10,15 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows a user to delete their own user profile. Authorize this action with a -// signed-in user's access token. It must include the scope -// aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// Allows a user to delete their own user profile. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} diff --git a/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go b/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go index 1feee8eba25..c513d946de0 100644 --- a/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_DeleteUserAttributes.go @@ -10,14 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the attributes for a user. Authorize this action with a signed-in -// user's access token. It must include the scope aws.cognito.signin.user.admin . -// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in -// requests for this API operation. For this operation, you can't use IAM +// Deletes the attributes for a user. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM // credentials to authorize requests, and you can't grant IAM permissions in // policies. For more information about authorization models in Amazon Cognito, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) DeleteUserAttributes(ctx context.Context, params *DeleteUserAttributesInput, optFns ...func(*Options)) (*DeleteUserAttributesOutput, error) { if params == nil { params = &DeleteUserAttributesInput{} @@ -43,6 +47,7 @@ type DeleteUserAttributesInput struct { 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. // diff --git a/service/cognitoidentityprovider/api_op_DescribeResourceServer.go b/service/cognitoidentityprovider/api_op_DescribeResourceServer.go index 65d0c132462..d3525a80136 100644 --- a/service/cognitoidentityprovider/api_op_DescribeResourceServer.go +++ b/service/cognitoidentityprovider/api_op_DescribeResourceServer.go @@ -31,8 +31,9 @@ type DescribeResourceServerInput struct { // A unique resource server identifier for the resource server. The identifier can // be an API friendly name like solar-system-data . You can also set an API URL - // like https://solar-system-data-api.example.com as your identifier. Amazon - // Cognito represents scopes in the access token in the format + // like https://solar-system-data-api.example.com as your identifier. + // + // Amazon Cognito represents scopes in the access token in the format // $resource-server-identifier/$scope . Longer scope-identifier strings increase // the size of your access tokens. // diff --git a/service/cognitoidentityprovider/api_op_DescribeUserPool.go b/service/cognitoidentityprovider/api_op_DescribeUserPool.go index d9753c3c104..9c0215aba31 100644 --- a/service/cognitoidentityprovider/api_op_DescribeUserPool.go +++ b/service/cognitoidentityprovider/api_op_DescribeUserPool.go @@ -12,12 +12,20 @@ import ( ) // Returns the configuration information and metadata of the specified user pool. +// // Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) DescribeUserPool(ctx context.Context, params *DescribeUserPoolInput, optFns ...func(*Options)) (*DescribeUserPoolOutput, error) { if params == nil { params = &DescribeUserPoolInput{} diff --git a/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go b/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go index 7c90747c7cd..2dc65c2e436 100644 --- a/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_DescribeUserPoolClient.go @@ -12,12 +12,21 @@ import ( ) // Client method for returning the configuration information and metadata of the -// specified user pool app client. Amazon Cognito evaluates Identity and Access -// Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// specified user pool app client. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) DescribeUserPoolClient(ctx context.Context, params *DescribeUserPoolClientInput, optFns ...func(*Options)) (*DescribeUserPoolClientOutput, error) { if params == nil { params = &DescribeUserPoolClientInput{} diff --git a/service/cognitoidentityprovider/api_op_ForgetDevice.go b/service/cognitoidentityprovider/api_op_ForgetDevice.go index 42cd4a3d188..c865c190f14 100644 --- a/service/cognitoidentityprovider/api_op_ForgetDevice.go +++ b/service/cognitoidentityprovider/api_op_ForgetDevice.go @@ -11,15 +11,19 @@ import ( ) // Forgets the specified device. For more information about device authentication, -// see Working with user devices in your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) -// . Authorize this action with a signed-in user's access token. It must include -// the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// see [Working with user devices in your user pool]. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html func (c *Client) ForgetDevice(ctx context.Context, params *ForgetDeviceInput, optFns ...func(*Options)) (*ForgetDeviceOutput, error) { if params == nil { params = &ForgetDeviceInput{} diff --git a/service/cognitoidentityprovider/api_op_ForgotPassword.go b/service/cognitoidentityprovider/api_op_ForgotPassword.go index 8e14e748308..11885cfe45e 100644 --- a/service/cognitoidentityprovider/api_op_ForgotPassword.go +++ b/service/cognitoidentityprovider/api_op_ForgotPassword.go @@ -15,34 +15,46 @@ import ( // 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. 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) -// . If neither a verified phone number nor a verified email exists, this API +// AccountRecoverySetting. For more information, see [Recovering User Accounts]in the Amazon Cognito +// Developer Guide. To use the confirmation code for resetting the password, call [ConfirmForgotPassword] +// . +// +// If neither a verified phone number nor a verified email exists, this API // returns InvalidParameterException . If your app client has a client secret and // you don't provide a SECRET_HASH parameter, this API returns -// NotAuthorizedException . To use this API operation, your user pool must have -// self-service account recovery configured. Use AdminSetUserPassword (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html) -// if you manage passwords as an administrator. Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// NotAuthorizedException . +// +// To use this API operation, your user pool must have self-service account +// recovery configured. Use [AdminSetUserPassword]if you manage passwords as an administrator. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [ConfirmForgotPassword]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [AdminSetUserPassword]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html +// [Recovering User Accounts]: https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) ForgotPassword(ctx context.Context, params *ForgotPasswordInput, optFns ...func(*Options)) (*ForgotPasswordOutput, error) { if params == nil { params = &ForgotPasswordInput{} @@ -80,25 +92,34 @@ type ForgotPasswordInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the ForgotPassword API - // action, Amazon Cognito invokes any functions that are assigned to the following - // triggers: pre sign-up, custom message, and user migration. 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, which - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any + // functions that are assigned to the following triggers: pre sign-up, custom + // message, and user migration. 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, which 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] 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. + // + // [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 ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key diff --git a/service/cognitoidentityprovider/api_op_GetDevice.go b/service/cognitoidentityprovider/api_op_GetDevice.go index 0d3a95c215f..c7d808a9e9b 100644 --- a/service/cognitoidentityprovider/api_op_GetDevice.go +++ b/service/cognitoidentityprovider/api_op_GetDevice.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the device. For more information about device authentication, see Working -// with user devices in your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) -// . Authorize this action with a signed-in user's access token. It must include -// the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// Gets the device. For more information about device authentication, see [Working with user devices in your user pool]. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html func (c *Client) GetDevice(ctx context.Context, params *GetDeviceInput, optFns ...func(*Options)) (*GetDeviceOutput, error) { if params == nil { params = &GetDeviceInput{} diff --git a/service/cognitoidentityprovider/api_op_GetGroup.go b/service/cognitoidentityprovider/api_op_GetGroup.go index 8973216ef3e..a2254c487ce 100644 --- a/service/cognitoidentityprovider/api_op_GetGroup.go +++ b/service/cognitoidentityprovider/api_op_GetGroup.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a group. Calling this action requires developer credentials. +// Gets a group. +// +// Calling this action requires developer credentials. func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error) { if params == nil { params = &GetGroupInput{} diff --git a/service/cognitoidentityprovider/api_op_GetSigningCertificate.go b/service/cognitoidentityprovider/api_op_GetSigningCertificate.go index a0cfd8e2561..f33ad1165e9 100644 --- a/service/cognitoidentityprovider/api_op_GetSigningCertificate.go +++ b/service/cognitoidentityprovider/api_op_GetSigningCertificate.go @@ -11,10 +11,11 @@ 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 -// original certificate. +// 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 original certificate. func (c *Client) GetSigningCertificate(ctx context.Context, params *GetSigningCertificateInput, optFns ...func(*Options)) (*GetSigningCertificateOutput, error) { if params == nil { params = &GetSigningCertificateInput{} diff --git a/service/cognitoidentityprovider/api_op_GetUser.go b/service/cognitoidentityprovider/api_op_GetUser.go index cdb446c6eca..f7f30136fbf 100644 --- a/service/cognitoidentityprovider/api_op_GetUser.go +++ b/service/cognitoidentityprovider/api_op_GetUser.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the user attributes and metadata for a user. Authorize this action with a -// signed-in user's access token. It must include the scope -// aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// Gets the user attributes and metadata for a user. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error) { if params == nil { params = &GetUserInput{} @@ -50,8 +53,10 @@ type GetUserInput struct { // about the user. type GetUserOutput struct { - // An array of name-value pairs representing user attributes. For custom - // attributes, you must prepend the custom: prefix to the attribute name. + // An array of name-value pairs representing user attributes. + // + // For custom attributes, you must prepend the custom: prefix to the attribute + // name. // // This member is required. UserAttributes []types.AttributeType @@ -61,7 +66,7 @@ type GetUserOutput struct { // This member is required. Username *string - // This response parameter is no longer supported. It provides information only + // This response parameter is no longer supported. It provides information only // about SMS MFA configurations. It doesn't provide information about time-based // one-time password (TOTP) software token MFA configurations. To look up // information about either type of MFA configuration, use UserMFASettingList diff --git a/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go b/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go index c61ec5eb74f..6587740227c 100644 --- a/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go +++ b/service/cognitoidentityprovider/api_op_GetUserAttributeVerificationCode.go @@ -13,27 +13,36 @@ import ( // Generates a user attribute verification code for the specified attribute name. // Sends a message to a user with a code that they must return in a -// VerifyUserAttribute request. Authorize this action with a signed-in user's -// access token. It must include the scope aws.cognito.signin.user.admin . Amazon -// Cognito doesn't evaluate Identity and Access Management (IAM) policies in -// requests for this API operation. For this operation, you can't use IAM +// VerifyUserAttribute request. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM // credentials to authorize requests, and you can't grant IAM permissions in // policies. For more information about authorization models in Amazon Cognito, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) GetUserAttributeVerificationCode(ctx context.Context, params *GetUserAttributeVerificationCodeInput, optFns ...func(*Options)) (*GetUserAttributeVerificationCodeOutput, error) { if params == nil { params = &GetUserAttributeVerificationCodeInput{} @@ -65,26 +74,34 @@ type GetUserAttributeVerificationCodeInput struct { AttributeName *string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the - // GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function - // that is assigned to the custom message trigger. When Amazon Cognito invokes this - // function, it passes a JSON payload, which the function receives as input. This - // payload contains a clientMetadata attribute, which provides the data that you - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the GetUserAttributeVerificationCode API action, Amazon + // Cognito invokes the function that is assigned to the custom message trigger. + // When Amazon Cognito invokes this function, it passes a JSON payload, which the + // function receives as input. This payload contains a clientMetadata attribute, + // which provides the data that you 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] 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. + // + // [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 ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go b/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go index 5b14a1564a9..66112755a05 100644 --- a/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go +++ b/service/cognitoidentityprovider/api_op_GetUserPoolMfaConfig.go @@ -40,8 +40,11 @@ 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. MfaConfiguration types.UserPoolMfaType diff --git a/service/cognitoidentityprovider/api_op_GlobalSignOut.go b/service/cognitoidentityprovider/api_op_GlobalSignOut.go index a0c54bcafe1..955efa874c0 100644 --- a/service/cognitoidentityprovider/api_op_GlobalSignOut.go +++ b/service/cognitoidentityprovider/api_op_GlobalSignOut.go @@ -13,28 +13,37 @@ import ( // Invalidates the identity, access, and refresh tokens that Amazon Cognito issued // to a user. Call this operation when your user signs out of your app. This // results in the following behavior. +// // - Amazon Cognito no longer accepts token-authorized user operations that you -// authorize with a signed-out user's access tokens. For more information, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . Amazon Cognito returns an Access Token has been revoked error when your app -// attempts to authorize a user pools API request with a revoked access token that -// contains the scope aws.cognito.signin.user.admin . -// - Amazon Cognito no longer accepts a signed-out user's ID token in a GetId (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html) -// request to an identity pool with ServerSideTokenCheck enabled for its user -// pool IdP configuration in CognitoIdentityProvider (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html) -// . -// - Amazon Cognito no longer accepts a signed-out user's refresh tokens in -// refresh requests. +// authorize with a signed-out user's access tokens. For more information, see [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// Amazon Cognito returns an Access Token has been revoked error when your app +// +// attempts to authorize a user pools API request with a revoked access token that +// contains the scope aws.cognito.signin.user.admin . +// +// - Amazon Cognito no longer accepts a signed-out user's ID token in a [GetId]request +// to an identity pool with ServerSideTokenCheck enabled for its user pool IdP +// configuration in [CognitoIdentityProvider]. +// +// - Amazon Cognito no longer accepts a signed-out user's refresh tokens in +// refresh requests. +// +// Other requests might be valid until your user's token expires. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html // -// Other requests might be valid until your user's token expires. Authorize this -// action with a signed-in user's access token. It must include the scope -// aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// [CognitoIdentityProvider]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html +// [GetId]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html func (c *Client) GlobalSignOut(ctx context.Context, params *GlobalSignOutInput, optFns ...func(*Options)) (*GlobalSignOutOutput, error) { if params == nil { params = &GlobalSignOutInput{} diff --git a/service/cognitoidentityprovider/api_op_InitiateAuth.go b/service/cognitoidentityprovider/api_op_InitiateAuth.go index 4276dfefc14..fcbdda5bc26 100644 --- a/service/cognitoidentityprovider/api_op_InitiateAuth.go +++ b/service/cognitoidentityprovider/api_op_InitiateAuth.go @@ -13,26 +13,34 @@ 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) -// . Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// see [Adding user pool sign-in through a third party]. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies // in requests for this API operation. For this operation, you can't use IAM // credentials to authorize requests, and you can't grant IAM permissions in // policies. For more information about authorization models in Amazon Cognito, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [Adding user pool sign-in through a third party]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) InitiateAuth(ctx context.Context, params *InitiateAuthInput, optFns ...func(*Options)) (*InitiateAuthOutput, error) { if params == nil { params = &InitiateAuthInput{} @@ -53,21 +61,30 @@ 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. // // This member is required. @@ -84,55 +101,80 @@ type InitiateAuthInput struct { // 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 USER_PASSWORD_AUTH : USERNAME (required), PASSWORD (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) . - // For more information about SECRET_HASH , see Computing secret hash values (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash) - // . For information about DEVICE_KEY , see Working with user devices in your user - // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) - // . + // + // For more information about SECRET_HASH , see [Computing secret hash values]. For information about DEVICE_KEY + // , see [Working with user devices in your user pool]. + // + // [Computing secret hash values]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash + // [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html 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 - // various triggers. The ClientMetadata value is passed as input to the functions - // for only the following triggers: + // 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: + // 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 - // 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: + // + // For more information, see [Customizing user pool Workflows with Lambda Triggers] 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. + // + // [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 ClientMetadata map[string]string // Contextual data about your user session, such as the device fingerprint, IP @@ -155,46 +197,61 @@ type InitiateAuthOutput struct { // The name of the challenge that you're responding to with this call. This name // is returned in the InitiateAuth 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. + // + // 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 + // 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]. + // + // 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 MFAS_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. + // challenge parameters MFAS_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. + // + // [RespondToAuthChallenge]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html 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). + // 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_ListDevices.go b/service/cognitoidentityprovider/api_op_ListDevices.go index 5c58be2b021..b97dbdf2b59 100644 --- a/service/cognitoidentityprovider/api_op_ListDevices.go +++ b/service/cognitoidentityprovider/api_op_ListDevices.go @@ -12,16 +12,19 @@ import ( ) // Lists the sign-in devices that Amazon Cognito has registered to the current -// user. For more information about device authentication, see Working with user -// devices in your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) -// . Authorize this action with a signed-in user's access token. It must include -// the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// user. For more information about device authentication, see [Working with user devices in your user pool]. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error) { if params == nil { params = &ListDevicesInput{} diff --git a/service/cognitoidentityprovider/api_op_ListGroups.go b/service/cognitoidentityprovider/api_op_ListGroups.go index 6728312b4d0..1b5dbea7ab3 100644 --- a/service/cognitoidentityprovider/api_op_ListGroups.go +++ b/service/cognitoidentityprovider/api_op_ListGroups.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the groups associated with a user pool. Amazon Cognito evaluates Identity -// and Access Management (IAM) policies in requests for this API operation. For -// this operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists the groups associated with a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { params = &ListGroupsInput{} diff --git a/service/cognitoidentityprovider/api_op_ListIdentityProviders.go b/service/cognitoidentityprovider/api_op_ListIdentityProviders.go index 836ea25cc15..1a95a1780e1 100644 --- a/service/cognitoidentityprovider/api_op_ListIdentityProviders.go +++ b/service/cognitoidentityprovider/api_op_ListIdentityProviders.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists information about all IdPs for a user pool. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists information about all IdPs for a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListIdentityProviders(ctx context.Context, params *ListIdentityProvidersInput, optFns ...func(*Options)) (*ListIdentityProvidersOutput, error) { if params == nil { params = &ListIdentityProvidersInput{} diff --git a/service/cognitoidentityprovider/api_op_ListResourceServers.go b/service/cognitoidentityprovider/api_op_ListResourceServers.go index 44164f2caff..3a137dfb39e 100644 --- a/service/cognitoidentityprovider/api_op_ListResourceServers.go +++ b/service/cognitoidentityprovider/api_op_ListResourceServers.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the resource servers for a user pool. Amazon Cognito evaluates Identity -// and Access Management (IAM) policies in requests for this API operation. For -// this operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists the resource servers for a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListResourceServers(ctx context.Context, params *ListResourceServersInput, optFns ...func(*Options)) (*ListResourceServersOutput, error) { if params == nil { params = &ListResourceServersInput{} diff --git a/service/cognitoidentityprovider/api_op_ListTagsForResource.go b/service/cognitoidentityprovider/api_op_ListTagsForResource.go index 8cffa3a1814..e9c63db158e 100644 --- a/service/cognitoidentityprovider/api_op_ListTagsForResource.go +++ b/service/cognitoidentityprovider/api_op_ListTagsForResource.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags that are assigned to an Amazon Cognito 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. You -// can use this action up to 10 times per second, per account. +// Lists the tags that are assigned to an Amazon Cognito 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. +// +// You can use this action up to 10 times per second, per account. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/cognitoidentityprovider/api_op_ListUserImportJobs.go b/service/cognitoidentityprovider/api_op_ListUserImportJobs.go index d273c687398..60148d70406 100644 --- a/service/cognitoidentityprovider/api_op_ListUserImportJobs.go +++ b/service/cognitoidentityprovider/api_op_ListUserImportJobs.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists user import jobs for a user pool. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists user import jobs for a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListUserImportJobs(ctx context.Context, params *ListUserImportJobsInput, optFns ...func(*Options)) (*ListUserImportJobsOutput, error) { if params == nil { params = &ListUserImportJobsInput{} diff --git a/service/cognitoidentityprovider/api_op_ListUserPoolClients.go b/service/cognitoidentityprovider/api_op_ListUserPoolClients.go index 95176edfea9..1787d0afa3f 100644 --- a/service/cognitoidentityprovider/api_op_ListUserPoolClients.go +++ b/service/cognitoidentityprovider/api_op_ListUserPoolClients.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the clients that have been created for the specified user pool. Amazon -// Cognito evaluates Identity and Access Management (IAM) policies in requests for -// this API operation. For this operation, you must use IAM credentials to -// authorize requests, and you must grant yourself the corresponding IAM permission -// in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists the clients that have been created for the specified user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListUserPoolClients(ctx context.Context, params *ListUserPoolClientsInput, optFns ...func(*Options)) (*ListUserPoolClientsOutput, error) { if params == nil { params = &ListUserPoolClientsInput{} diff --git a/service/cognitoidentityprovider/api_op_ListUserPools.go b/service/cognitoidentityprovider/api_op_ListUserPools.go index ab14949efdd..4f45fa5bea6 100644 --- a/service/cognitoidentityprovider/api_op_ListUserPools.go +++ b/service/cognitoidentityprovider/api_op_ListUserPools.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the user pools associated with an Amazon Web Services account. Amazon -// Cognito evaluates Identity and Access Management (IAM) policies in requests for -// this API operation. For this operation, you must use IAM credentials to -// authorize requests, and you must grant yourself the corresponding IAM permission -// in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists the user pools associated with an Amazon Web Services account. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListUserPools(ctx context.Context, params *ListUserPoolsInput, optFns ...func(*Options)) (*ListUserPoolsOutput, error) { if params == nil { params = &ListUserPoolsInput{} diff --git a/service/cognitoidentityprovider/api_op_ListUsers.go b/service/cognitoidentityprovider/api_op_ListUsers.go index 56ad63a8f39..c4cf51d16f7 100644 --- a/service/cognitoidentityprovider/api_op_ListUsers.go +++ b/service/cognitoidentityprovider/api_op_ListUsers.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists users and their basic details in a user pool. Amazon Cognito evaluates -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists users and their basic details in a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error) { if params == nil { params = &ListUsersInput{} @@ -44,7 +52,9 @@ type ListUsersInput struct { // A JSON array of user attribute names, for example given_name , that you want // Amazon Cognito to include in the response for each user. When you don't provide // an AttributesToGet parameter, Amazon Cognito returns all attributes for each - // user. Use AttributesToGet with required attributes in your user pool, or in + // user. + // + // Use AttributesToGet with required attributes in your user pool, or in // conjunction with Filter . Amazon Cognito returns an error if not all users in // the results have set a value for the attribute you request. Attributes that you // can't filter on, including custom attributes, must have a value set in every @@ -54,37 +64,58 @@ 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) - // in the Amazon Cognito Developer Guide. + // + // 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] in the [Command Line Interface User Guide]. + // + // For more information, see [Searching for Users Using the ListUsers API] and [Examples of Using the ListUsers API] in the Amazon Cognito Developer Guide. + // + // [Command Line Interface User Guide]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html + // [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 + // [FilteringCLI output]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html + // [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 Filter *string // Maximum number of users to be returned. @@ -111,12 +142,15 @@ type ListUsersOutput struct { PaginationToken *string // A list of the user pool users, and their attributes, that match your query. + // // Amazon Cognito creates a profile in your user pool for each native user in your // user pool, and each unique user ID from your third-party identity providers - // (IdPs). When you link users with the AdminLinkProviderForUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html) - // API operation, the output of ListUsers displays both the IdP user and the - // native user that you linked. You can identify IdP users in the Users object of - // this API response by the IdP prefix that Amazon Cognito appends to Username . + // (IdPs). When you link users with the [AdminLinkProviderForUser]API operation, the output of ListUsers + // displays both the IdP user and the native user that you linked. You can identify + // IdP users in the Users object of this API response by the IdP prefix that + // Amazon Cognito appends to Username . + // + // [AdminLinkProviderForUser]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html Users []types.UserType // Metadata pertaining to the operation's result. diff --git a/service/cognitoidentityprovider/api_op_ListUsersInGroup.go b/service/cognitoidentityprovider/api_op_ListUsersInGroup.go index fa10dd49253..54ba7d2fd8b 100644 --- a/service/cognitoidentityprovider/api_op_ListUsersInGroup.go +++ b/service/cognitoidentityprovider/api_op_ListUsersInGroup.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the users in the specified group. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Lists the users in the specified group. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) ListUsersInGroup(ctx context.Context, params *ListUsersInGroupInput, optFns ...func(*Options)) (*ListUsersInGroupOutput, error) { if params == nil { params = &ListUsersInGroupInput{} diff --git a/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go b/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go index f569b86baa6..795548daa50 100644 --- a/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go +++ b/service/cognitoidentityprovider/api_op_ResendConfirmationCode.go @@ -12,25 +12,33 @@ import ( ) // Resends the confirmation (for confirmation of registration) to a specific user -// in the user pool. Amazon Cognito doesn't evaluate Identity and Access Management -// (IAM) policies in requests for this API operation. For this operation, you can't -// use IAM credentials to authorize requests, and you can't grant IAM permissions -// in policies. For more information about authorization models in Amazon Cognito, -// see Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// in the user pool. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) ResendConfirmationCode(ctx context.Context, params *ResendConfirmationCodeInput, optFns ...func(*Options)) (*ResendConfirmationCodeOutput, error) { if params == nil { params = &ResendConfirmationCodeInput{} @@ -68,25 +76,33 @@ type ResendConfirmationCodeInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the ResendConfirmationCode - // API action, Amazon Cognito invokes the function that is assigned to the custom - // message trigger. When Amazon Cognito invokes this function, it passes a JSON - // payload, which the function receives as input. This payload contains a - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the ResendConfirmationCode API action, Amazon Cognito + // invokes the function that is assigned to the custom message trigger. When Amazon + // Cognito invokes this function, it passes a JSON payload, which the function + // receives as input. This payload contains a 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] 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. + // + // [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 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 e3db30b4a97..397ca3778d8 100644 --- a/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go +++ b/service/cognitoidentityprovider/api_op_RespondToAuthChallenge.go @@ -16,27 +16,36 @@ import ( // authentication challenge. A RespondToAuthChallenge API request provides the // answer to that challenge, like a code or a secure remote password (SRP). The // parameters of a response to an authentication challenge vary with the type of -// challenge. For more information about custom authentication challenges, see -// Custom authentication challenge Lambda triggers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) -// . Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// challenge. +// +// For more information about custom authentication challenges, see [Custom authentication challenge Lambda triggers]. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies // in requests for this API operation. For this operation, you can't use IAM // credentials to authorize requests, and you can't grant IAM permissions in // policies. For more information about authorization models in Amazon Cognito, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Custom authentication challenge Lambda triggers]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) RespondToAuthChallenge(ctx context.Context, params *RespondToAuthChallengeInput, optFns ...func(*Options)) (*RespondToAuthChallengeOutput, error) { if params == nil { params = &RespondToAuthChallengeInput{} @@ -55,8 +64,11 @@ 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]. + // + // ADMIN_NO_SRP_AUTH isn't a valid value. + // + // [InitiateAuth]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html // // This member is required. ChallengeName types.ChallengeNameType @@ -72,65 +84,94 @@ type RespondToAuthChallengeInput struct { // The responses to the challenge that you received in the previous request. Each // challenge has its own required response parameters. The following examples are - // partial JSON request bodies that highlight challenge-response parameters. You - // must provide a SECRET_HASH parameter in all challenge responses to an app client - // that has a client secret. SMS_MFA "ChallengeName": "SMS_MFA", - // "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"} + // partial JSON request bodies that highlight challenge-response parameters. + // + // You must provide a SECRET_HASH parameter in all challenge responses to an app + // client that has a client secret. + // + // SMS_MFA "ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": + // "[SMS_code]", "USERNAME": "[username]"} + // // PASSWORD_VERIFIER "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": // {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": - // "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} Add - // "DEVICE_KEY" when you sign in with a remembered device. CUSTOM_CHALLENGE - // "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": - // "[username]", "ANSWER": "[challenge_answer]"} Add "DEVICE_KEY" when you sign in - // with a remembered device. NEW_PASSWORD_REQUIRED "ChallengeName": - // "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": - // "[new_password]", "USERNAME": "[username]"} To set any required attributes that - // InitiateAuth returned in an requiredAttributes parameter, add - // "userAttributes.[attribute_name]": "[attribute_value]" . 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 "ChallengeName": "SOFTWARE_TOKEN_MFA", - // "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": - // [authenticator_code]} DEVICE_SRP_AUTH "ChallengeName": "DEVICE_SRP_AUTH", - // "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", - // "SRP_A": "[srp_a]"} DEVICE_PASSWORD_VERIFIER "ChallengeName": - // "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", - // "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": - // "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} MFA_SETUP - // "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, - // "SESSION": "[Session ID from VerifySoftwareToken]" SELECT_MFA_TYPE - // "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": - // "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"} For more information - // about SECRET_HASH , see Computing secret hash values (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash) - // . For information about DEVICE_KEY , see Working with user devices in your user - // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) - // . + // "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"} + // + // Add "DEVICE_KEY" when you sign in with a remembered device. + // + // CUSTOM_CHALLENGE "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": + // {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"} + // + // Add "DEVICE_KEY" when you sign in with a remembered device. + // + // NEW_PASSWORD_REQUIRED "ChallengeName": "NEW_PASSWORD_REQUIRED", + // "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": + // "[username]"} + // + // To set any required attributes that InitiateAuth returned in an + // requiredAttributes parameter, add "userAttributes.[attribute_name]": + // "[attribute_value]" . 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 "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": + // {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]} + // + // DEVICE_SRP_AUTH "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": + // {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"} + // + // DEVICE_PASSWORD_VERIFIER "ChallengeName": "DEVICE_PASSWORD_VERIFIER", + // "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": + // "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", + // "TIMESTAMP": [timestamp], "USERNAME": "[username]"} + // + // MFA_SETUP "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": + // "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]" + // + // SELECT_MFA_TYPE "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": + // {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"} + // + // For more information about SECRET_HASH , see [Computing secret hash values]. For information about DEVICE_KEY + // , see [Working with user devices in your user pool]. + // + // [Computing secret hash values]: https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash + // [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html ChallengeResponses map[string]string // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the RespondToAuthChallenge - // API action, Amazon Cognito invokes any functions that are assigned to the - // following triggers: post authentication, pre token generation, define auth - // challenge, create auth challenge, and verify auth challenge. 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, which - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito + // invokes any functions that are assigned to the following triggers: post + // authentication, pre token generation, define auth challenge, create auth + // challenge, and verify auth challenge. 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, which 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] 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. + // + // [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 ClientMetadata map[string]string // The session that should be passed both ways in challenge-response calls to the @@ -156,12 +197,14 @@ 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]. + // + // [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]. + // + // [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_RevokeToken.go b/service/cognitoidentityprovider/api_op_RevokeToken.go index 8d7ff0186ab..da3b64e3f39 100644 --- a/service/cognitoidentityprovider/api_op_RevokeToken.go +++ b/service/cognitoidentityprovider/api_op_RevokeToken.go @@ -13,12 +13,15 @@ import ( // Revokes all of the access tokens generated by, and at the same time as, the // specified refresh token. After a token is revoked, you can't use the revoked // token to access Amazon Cognito user APIs, or to authorize access to your -// resource server. Amazon Cognito doesn't evaluate Identity and Access Management -// (IAM) policies in requests for this API operation. For this operation, you can't -// use IAM credentials to authorize requests, and you can't grant IAM permissions -// in policies. For more information about authorization models in Amazon Cognito, -// see Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// resource server. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) RevokeToken(ctx context.Context, params *RevokeTokenInput, optFns ...func(*Options)) (*RevokeTokenOutput, error) { if params == nil { params = &RevokeTokenInput{} diff --git a/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go b/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go index 13ae2f80cc8..7c9c31f8a7e 100644 --- a/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go +++ b/service/cognitoidentityprovider/api_op_SetRiskConfiguration.go @@ -12,8 +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 -// activate Amazon Cognito advanced security features, update the user pool 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 key AdvancedSecurityMode . func (c *Client) SetRiskConfiguration(ctx context.Context, params *SetRiskConfigurationInput, optFns ...func(*Options)) (*SetRiskConfigurationOutput, error) { if params == nil { @@ -42,9 +43,11 @@ type SetRiskConfigurationInput struct { // 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. + // 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 4f3529c56fa..a67cc9357b7 100644 --- a/service/cognitoidentityprovider/api_op_SetUICustomization.go +++ b/service/cognitoidentityprovider/api_op_SetUICustomization.go @@ -12,14 +12,17 @@ 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 -// with it. Otherwise, there is no place to host the app's pages, and the service -// will throw an error. +// 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 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) { if params == nil { params = &SetUICustomizationInput{} diff --git a/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go b/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go index 86b8577c528..df529827730 100644 --- a/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go +++ b/service/cognitoidentityprovider/api_op_SetUserMFAPreference.go @@ -20,15 +20,18 @@ import ( // MFA during all sign-in attempts unless device tracking is turned on and the // device has been trusted. If you want MFA to be applied selectively based on the // assessed risk level of sign-in attempts, deactivate MFA for users and turn on -// Adaptive Authentication for the user pool. Authorize this action with a -// signed-in user's access token. It must include the scope -// aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// Adaptive Authentication for the user pool. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) SetUserMFAPreference(ctx context.Context, params *SetUserMFAPreferenceInput, optFns ...func(*Options)) (*SetUserMFAPreferenceOutput, error) { if params == nil { params = &SetUserMFAPreferenceInput{} diff --git a/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go b/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go index 6aa1a1a8510..bc1f4bee12a 100644 --- a/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go +++ b/service/cognitoidentityprovider/api_op_SetUserPoolMfaConfig.go @@ -11,21 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the user pool multi-factor authentication (MFA) configuration. 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Sets the user pool multi-factor authentication (MFA) configuration. +// +// 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]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) SetUserPoolMfaConfig(ctx context.Context, params *SetUserPoolMfaConfigInput, optFns ...func(*Options)) (*SetUserPoolMfaConfigOutput, error) { if params == nil { params = &SetUserPoolMfaConfigInput{} @@ -49,13 +54,17 @@ type SetUserPoolMfaConfigInput struct { 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: + // users who have set up an MFA factor can sign in. To learn more, see [Adding Multi-Factor Authentication (MFA) to a user pool]. 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. + // + // [Adding Multi-Factor Authentication (MFA) to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html MfaConfiguration types.UserPoolMfaType // The SMS text message MFA configuration. @@ -70,8 +79,11 @@ 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. MfaConfiguration types.UserPoolMfaType diff --git a/service/cognitoidentityprovider/api_op_SetUserSettings.go b/service/cognitoidentityprovider/api_op_SetUserSettings.go index 2cac9e96f21..c7217bb7c40 100644 --- a/service/cognitoidentityprovider/api_op_SetUserSettings.go +++ b/service/cognitoidentityprovider/api_op_SetUserSettings.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is no longer supported. You can use it to configure only SMS MFA. +// 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) -// instead. Authorize this action with a signed-in user's access token. It must -// include the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't -// evaluate Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// MFA. To configure either type of MFA, use [SetUserMFAPreference]instead. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [SetUserMFAPreference]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html func (c *Client) SetUserSettings(ctx context.Context, params *SetUserSettingsInput, optFns ...func(*Options)) (*SetUserSettingsOutput, error) { if params == nil { params = &SetUserSettingsInput{} diff --git a/service/cognitoidentityprovider/api_op_SignUp.go b/service/cognitoidentityprovider/api_op_SignUp.go index 1d2e3a46d15..dc035ac5f85 100644 --- a/service/cognitoidentityprovider/api_op_SignUp.go +++ b/service/cognitoidentityprovider/api_op_SignUp.go @@ -12,26 +12,33 @@ import ( ) // Registers the user in the specified user pool and creates a user name, -// password, and user attributes. Amazon Cognito doesn't evaluate Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you can't use IAM credentials to authorize requests, and you can't -// grant IAM permissions in policies. For more information about authorization -// models in Amazon Cognito, see Using the Amazon Cognito user pools API and user -// pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// password, and user attributes. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) SignUp(ctx context.Context, params *SignUpInput, optFns ...func(*Options)) (*SignUpOutput, error) { if params == nil { params = &SignUpInput{} @@ -71,33 +78,44 @@ type SignUpInput struct { AnalyticsMetadata *types.AnalyticsMetadataType // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action triggers. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the SignUp API action, - // Amazon Cognito invokes any functions that are assigned to the following - // triggers: pre sign-up, custom message, and post confirmation. 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, - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action triggers. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the SignUp API action, Amazon Cognito invokes any + // functions that are assigned to the following triggers: pre sign-up, custom + // message, and post confirmation. 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, 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] 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. + // + // [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 ClientMetadata map[string]string // A keyed-hash message authentication code (HMAC) calculated using the secret key // of a user pool client and username plus the client ID in the message. SecretHash *string - // An array of name-value pairs representing user attributes. For custom - // attributes, you must prepend the custom: prefix to the attribute name. + // An array of name-value pairs representing user attributes. + // + // For custom attributes, you must prepend the custom: prefix to the attribute + // name. UserAttributes []types.AttributeType // Contextual data about your user session, such as the device fingerprint, IP @@ -108,14 +126,17 @@ type SignUpInput struct { // Temporary user attributes that contribute to the outcomes of your pre sign-up // Lambda trigger. This set of key-value pairs are for custom validation of - // information that you collect from your users but don't need to retain. Your - // Lambda function can analyze this additional data and act on it. Your function - // might perform external API operations like logging user attributes and + // information that you collect from your users but don't need to retain. + // + // Your Lambda function can analyze this additional data and act on it. Your + // function might perform external API operations like logging user attributes and // validation data to Amazon CloudWatch Logs. Validation data might also affect the // response that your function returns to Amazon Cognito, like automatically - // confirming the user if they sign up from within your network. For more - // information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html) - // . + // confirming the user if they sign up from within your network. + // + // For more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger]. + // + // [Pre sign-up Lambda trigger]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html ValidationData []types.AttributeType noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_TagResource.go b/service/cognitoidentityprovider/api_op_TagResource.go index 2c34f6d2293..7852019d195 100644 --- a/service/cognitoidentityprovider/api_op_TagResource.go +++ b/service/cognitoidentityprovider/api_op_TagResource.go @@ -12,18 +12,22 @@ import ( // Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you // can use to categorize and manage user pools in different ways, such as by -// 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. +// 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. 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_UpdateAuthEventFeedback.go b/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go index fa412ea6888..28610241bb6 100644 --- a/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go +++ b/service/cognitoidentityprovider/api_op_UpdateAuthEventFeedback.go @@ -13,13 +13,15 @@ import ( // Provides the feedback for an authentication event, whether it was from a valid // user or not. This feedback is used for improving the risk evaluation decision -// for the user pool as part of Amazon Cognito advanced security. Amazon Cognito -// doesn't evaluate Identity and Access Management (IAM) policies in requests for -// this API operation. For this operation, you can't use IAM credentials to -// authorize requests, and you can't grant IAM permissions in policies. For more -// information about authorization models in Amazon Cognito, see Using the Amazon -// Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// for the user pool as part of Amazon Cognito advanced security. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) UpdateAuthEventFeedback(ctx context.Context, params *UpdateAuthEventFeedbackInput, optFns ...func(*Options)) (*UpdateAuthEventFeedbackOutput, error) { if params == nil { params = &UpdateAuthEventFeedbackInput{} diff --git a/service/cognitoidentityprovider/api_op_UpdateDeviceStatus.go b/service/cognitoidentityprovider/api_op_UpdateDeviceStatus.go index d6b96517bd8..de58ac5794e 100644 --- a/service/cognitoidentityprovider/api_op_UpdateDeviceStatus.go +++ b/service/cognitoidentityprovider/api_op_UpdateDeviceStatus.go @@ -12,15 +12,19 @@ import ( ) // Updates the device status. For more information about device authentication, -// see Working with user devices in your user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html) -// . Authorize this action with a signed-in user's access token. It must include -// the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// see [Working with user devices in your user pool]. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Working with user devices in your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html func (c *Client) UpdateDeviceStatus(ctx context.Context, params *UpdateDeviceStatusInput, optFns ...func(*Options)) (*UpdateDeviceStatusOutput, error) { if params == nil { params = &UpdateDeviceStatusInput{} diff --git a/service/cognitoidentityprovider/api_op_UpdateGroup.go b/service/cognitoidentityprovider/api_op_UpdateGroup.go index 0fe23e050c8..e87d0aef91d 100644 --- a/service/cognitoidentityprovider/api_op_UpdateGroup.go +++ b/service/cognitoidentityprovider/api_op_UpdateGroup.go @@ -11,13 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified group with the specified attributes. Amazon Cognito -// evaluates Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you must use IAM credentials to authorize -// requests, and you must grant yourself the corresponding IAM permission in a -// policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Updates the specified group with the specified attributes. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error) { if params == nil { params = &UpdateGroupInput{} @@ -49,8 +57,9 @@ 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]. + // + // [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 d3ceb97235d..a12f5ac62bc 100644 --- a/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go +++ b/service/cognitoidentityprovider/api_op_UpdateIdentityProvider.go @@ -11,12 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates IdP information for a user pool. Amazon Cognito evaluates Identity and -// Access Management (IAM) policies in requests for this API operation. For this -// operation, you must use IAM credentials to authorize requests, and you must -// grant yourself the corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Updates IdP information for a user pool. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) UpdateIdentityProvider(ctx context.Context, params *UpdateIdentityProviderInput, optFns ...func(*Options)) (*UpdateIdentityProviderOutput, error) { if params == nil { params = &UpdateIdentityProviderInput{} @@ -53,71 +62,96 @@ type UpdateIdentityProviderInput struct { // The scopes, URLs, and identifiers for your external identity provider. The // following examples describe the provider detail keys for each IdP type. These // values and their schema are subject to change. Social IdP authorize_scopes - // values must match the values listed here. OpenID Connect (OIDC) Amazon Cognito - // accepts the following elements when it can't discover endpoint URLs from - // oidc_issuer : attributes_url , authorize_url , jwks_uri , token_url . Create or - // update request: "ProviderDetails": { "attributes_request_method": "GET", - // "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": - // "openid profile email", "authorize_url": "https://auth.example.com/authorize", - // "client_id": "1example23456789", "client_secret": "provider-app-client-secret", - // "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": - // "https://auth.example.com", "token_url": "https://example.com/token" } Describe - // response: "ProviderDetails": { "attributes_request_method": "GET", + // values must match the values listed here. + // + // OpenID Connect (OIDC) Amazon Cognito accepts the following elements when it + // can't discover endpoint URLs from oidc_issuer : attributes_url , authorize_url , + // jwks_uri , token_url . + // + // Create or update request: "ProviderDetails": { "attributes_request_method": + // "GET", "attributes_url": "https://auth.example.com/userInfo", + // "authorize_scopes": "openid profile email", "authorize_url": + // "https://auth.example.com/authorize", "client_id": "1example23456789", + // "client_secret": "provider-app-client-secret", "jwks_uri": + // "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": + // "https://auth.example.com", "token_url": "https://example.com/token" } + // + // Describe response: "ProviderDetails": { "attributes_request_method": "GET", // "attributes_url": "https://auth.example.com/userInfo", // "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile // email", "authorize_url": "https://auth.example.com/authorize", "client_id": // "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": // "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": - // "https://auth.example.com", "token_url": "https://example.com/token" } SAML - // Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": - // "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": - // "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": - // "rsa-sha256" } Create or update request with Metadata file: "ProviderDetails": - // { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", - // "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" } The - // value of MetadataFile must be the plaintext metadata document with all quote - // (") characters escaped by backslashes. Describe response: "ProviderDetails": { + // "https://auth.example.com", "token_url": "https://example.com/token" } + // + // SAML Create or update request with Metadata URL: "ProviderDetails": { // "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", - // "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": - // "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": - // "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", - // "SSORedirectBindingURI": "https://auth.example.com/sso/saml" } LoginWithAmazon - // Create or update request: "ProviderDetails": { "authorize_scopes": "profile - // postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", - // "client_secret": "provider-app-client-secret" Describe response: - // "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", - // "attributes_url_add_attributes": "false", "authorize_scopes": "profile - // postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": + // "MetadataURL": "https://auth.example.com/sso/saml/metadata", + // "RequestSigningAlgorithm": "rsa-sha256" } + // + // Create or update request with Metadata file: "ProviderDetails": { "IDPInit": + // "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": + // "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" } + // + // The value of MetadataFile must be the plaintext metadata document with all + // quote (") characters escaped by backslashes. + // + // Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": + // "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": + // "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", + // "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": + // "https://auth.example.com/slo/saml", "SSORedirectBindingURI": + // "https://auth.example.com/sso/saml" } + // + // LoginWithAmazon Create or update request: "ProviderDetails": { + // "authorize_scopes": "profile postal_code", "client_id": + // "amzn1.application-oa2-client.1example23456789", "client_secret": + // "provider-app-client-secret" + // + // Describe response: "ProviderDetails": { "attributes_url": + // "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", + // "authorize_scopes": "profile postal_code", "authorize_url": + // "https://www.amazon.com/ap/oa", "client_id": // "amzn1.application-oa2-client.1example23456789", "client_secret": // "provider-app-client-secret", "token_request_method": "POST", "token_url": - // "https://api.amazon.com/auth/o2/token" } Google Create or update request: - // "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": + // "https://api.amazon.com/auth/o2/token" } + // + // Google Create or update request: "ProviderDetails": { "authorize_scopes": + // "email profile openid", "client_id": // "1example23456789.apps.googleusercontent.com", "client_secret": - // "provider-app-client-secret" } Describe response: "ProviderDetails": { - // "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", + // "provider-app-client-secret" } + // + // Describe response: "ProviderDetails": { "attributes_url": + // "https://people.googleapis.com/v1/people/me?personFields=", // "attributes_url_add_attributes": "true", "authorize_scopes": "email profile // openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", // "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": // "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", // "token_request_method": "POST", "token_url": - // "https://www.googleapis.com/oauth2/v4/token" } SignInWithApple Create or update - // request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": - // "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", - // "team_id": "3EXAMPLE" } Describe response: "ProviderDetails": { - // "attributes_url_add_attributes": "false", "authorize_scopes": "email name", - // "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": - // "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": - // "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": - // "POST", "token_url": "https://appleid.apple.com/auth/token" } Facebook Create or - // update request: "ProviderDetails": { "api_version": "v17.0", + // "https://www.googleapis.com/oauth2/v4/token" } + // + // SignInWithApple Create or update request: "ProviderDetails": { + // "authorize_scopes": "email name", "client_id": "com.example.cognito", + // "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" } + // + // Describe response: "ProviderDetails": { "attributes_url_add_attributes": + // "false", "authorize_scopes": "email name", "authorize_url": + // "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", + // "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": + // "2EXAMPLE", "token_request_method": "POST", "token_url": + // "https://appleid.apple.com/auth/token" } + // + // Facebook Create or update request: "ProviderDetails": { "api_version": "v17.0", // "authorize_scopes": "public_profile, email", "client_id": "1example23456789", - // "client_secret": "provider-app-client-secret" } Describe response: - // "ProviderDetails": { "api_version": "v17.0", "attributes_url": - // "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": - // "true", "authorize_scopes": "public_profile, email", "authorize_url": - // "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", - // "client_secret": "provider-app-client-secret", "token_request_method": "GET", - // "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" } + // "client_secret": "provider-app-client-secret" } + // + // Describe response: "ProviderDetails": { "api_version": "v17.0", + // "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", + // "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, + // email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", + // "client_id": "1example23456789", "client_secret": "provider-app-client-secret", + // "token_request_method": "GET", "token_url": + // "https://graph.facebook.com/v17.0/oauth/access_token" } ProviderDetails map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_UpdateResourceServer.go b/service/cognitoidentityprovider/api_op_UpdateResourceServer.go index fc8bcb3fa4d..92d022e57bb 100644 --- a/service/cognitoidentityprovider/api_op_UpdateResourceServer.go +++ b/service/cognitoidentityprovider/api_op_UpdateResourceServer.go @@ -12,13 +12,22 @@ import ( ) // Updates the name and scopes of resource server. All other fields are read-only. +// // If you don't provide a value for an attribute, it is set to the default value. +// // Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) UpdateResourceServer(ctx context.Context, params *UpdateResourceServerInput, optFns ...func(*Options)) (*UpdateResourceServerOutput, error) { if params == nil { params = &UpdateResourceServerInput{} @@ -38,8 +47,9 @@ type UpdateResourceServerInput struct { // A unique resource server identifier for the resource server. The identifier can // be an API friendly name like solar-system-data . You can also set an API URL - // like https://solar-system-data-api.example.com as your identifier. Amazon - // Cognito represents scopes in the access token in the format + // like https://solar-system-data-api.example.com as your identifier. + // + // Amazon Cognito represents scopes in the access token in the format // $resource-server-identifier/$scope . Longer scope-identifier strings increase // the size of your access tokens. // diff --git a/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go b/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go index 19cc99dbd6d..21ce597f679 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserAttributes.go @@ -15,27 +15,36 @@ import ( // their own credentials. You authorize this API request with the user's access // token. To delete an attribute from your user, submit the attribute in your API // request with a blank value. Custom attribute values in this request must include -// the custom: prefix. Authorize this action with a signed-in user's access token. -// It must include the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't -// evaluate Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . This action might generate an SMS text message. Starting June 1, 2021, US +// the custom: prefix. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) UpdateUserAttributes(ctx context.Context, params *UpdateUserAttributesInput, optFns ...func(*Options)) (*UpdateUserAttributesOutput, error) { if params == nil { params = &UpdateUserAttributesInput{} @@ -60,38 +69,49 @@ type UpdateUserAttributesInput struct { // This member is required. AccessToken *string - // An array of name-value pairs representing user attributes. For custom - // attributes, you must prepend the custom: prefix to the attribute name. If you - // have set an attribute to require verification before Amazon Cognito updates its - // value, this request doesn’t immediately update the value of that attribute. - // After your user receives and responds to a verification message to verify the - // new value, Amazon Cognito updates the attribute value. Your user can sign in and - // receive messages with the original attribute value until they verify the new - // value. + // An array of name-value pairs representing user attributes. + // + // For custom attributes, you must prepend the custom: prefix to the attribute + // name. + // + // If you have set an attribute to require verification before Amazon Cognito + // updates its value, this request doesn’t immediately update the value of that + // attribute. After your user receives and responds to a verification message to + // verify the new value, Amazon Cognito updates the attribute value. Your user can + // sign in and receive messages with the original attribute value until they verify + // the new value. // // This member is required. UserAttributes []types.AttributeType // A map of custom key-value pairs that you can provide as input for any custom - // workflows that this action initiates. You create custom workflows by assigning - // Lambda functions to user pool triggers. When you use the UpdateUserAttributes - // API action, Amazon Cognito invokes the function that is assigned to the custom - // message trigger. When Amazon Cognito invokes this function, it passes a JSON - // payload, which the function receives as input. This payload contains a - // 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) - // in the Amazon Cognito Developer Guide. When you use the ClientMetadata - // parameter, remember that Amazon Cognito won't do the following: + // workflows that this action initiates. + // + // You create custom workflows by assigning Lambda functions to user pool + // triggers. When you use the UpdateUserAttributes API action, Amazon Cognito + // invokes the function that is assigned to the custom message trigger. When Amazon + // Cognito invokes this function, it passes a JSON payload, which the function + // receives as input. This payload contains a 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] 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. + // + // [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 ClientMetadata map[string]string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPool.go b/service/cognitoidentityprovider/api_op_UpdateUserPool.go index 97546d660f1..6e2785e6c44 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPool.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPool.go @@ -14,26 +14,41 @@ import ( // 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/user-pool-sms-settings.html) -// in the Amazon Cognito Developer Guide. 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, Amazon Cognito sets it to its -// default value. Amazon Cognito evaluates Identity and Access Management (IAM) -// policies in requests for this API operation. For this operation, you must use -// IAM credentials to authorize requests, and you must grant yourself the -// corresponding IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. 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], 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]in the Amazon +// Cognito Developer Guide. +// +// Updates the specified user pool with the specified attributes. You can get a +// list of the current user pool settings using [DescribeUserPool]. +// +// If you don't provide a value for an attribute, Amazon Cognito sets it to its +// default value. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// requests for this API operation. For this operation, you must use IAM +// credentials to authorize requests, and you must grant yourself the corresponding +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [DescribeUserPool]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html +// [sandbox mode]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html +// [Amazon Pinpoint]: https://console.aws.amazon.com/pinpoint/home/ func (c *Client) UpdateUserPool(ctx context.Context, params *UpdateUserPoolInput, optFns ...func(*Options)) (*UpdateUserPoolOutput, error) { if params == nil { params = &UpdateUserPoolInput{} @@ -75,16 +90,19 @@ type UpdateUserPoolInput struct { // When active, DeletionProtection prevents accidental deletion of your user pool. // Before you can delete a user pool that you have protected against deletion, you - // must deactivate this feature. When you try to delete a protected user pool in a - // DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException - // error. To delete a protected user pool, send a new DeleteUserPool request after - // you deactivate deletion protection in an UpdateUserPool API request. + // must deactivate this feature. + // + // When you try to delete a protected user pool in a DeleteUserPool API request, + // Amazon Cognito returns an InvalidParameterException error. To delete a + // protected user pool, send a new DeleteUserPool request after you deactivate + // deletion protection in an UpdateUserPool API request. DeletionProtection types.DeletionProtectionType // The device-remembering configuration for a user pool. A null value indicates - // that you have deactivated device remembering in your user pool. When you provide - // a value for any DeviceConfiguration field, you activate the Amazon Cognito - // device-remembering feature. + // that you have deactivated device remembering in your user pool. + // + // When you provide a value for any DeviceConfiguration field, you activate the + // Amazon Cognito device-remembering feature. DeviceConfiguration *types.DeviceConfigurationType // The email configuration of your user pool. The email configuration type sets @@ -92,25 +110,31 @@ 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]. + // + // [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]. + // + // [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. + // specify ON when you're initially creating a user pool. You can use the [SetUserPoolMfaConfig]API + // operation to turn MFA "ON" for existing user pools. + // // - OPTIONAL - Users have the option when registering to create an MFA token. + // + // [SetUserPoolMfaConfig]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html MfaConfiguration types.UserPoolMfaType // A container with the policies you want to update in a user pool. @@ -126,23 +150,27 @@ 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]. + // + // [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) - // . + // address and phone number attributes. For more information, see [Verifying updates to email addresses and phone numbers]. + // + // [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 // User pool add-ons. Contains settings for activation of advanced security // features. To log user security information but take no action, set to AUDIT . To // configure automatic security responses to risky traffic to your user pool, set - // to ENFORCED . For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) - // . + // to ENFORCED . + // + // For more information, see [Adding advanced security to a user pool]. + // + // [Adding advanced security to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html UserPoolAddOns *types.UserPoolAddOnsType // The tag keys and values to assign to the user pool. A tag is a label that you diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go b/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go index d7940b5ac57..4ca5267b991 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPoolClient.go @@ -12,17 +12,29 @@ 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, Amazon Cognito sets it to its -// 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) -// . Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// can get a list of the current user pool app client settings using [DescribeUserPoolClient]. +// +// If you don't provide a value for an attribute, Amazon Cognito sets it to its +// default value. +// +// You can also use this operation to enable token revocation for user pool +// clients. For more information about revoking tokens, see [RevokeToken]. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [RevokeToken]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [DescribeUserPoolClient]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) UpdateUserPoolClient(ctx context.Context, params *UpdateUserPoolClientInput, optFns ...func(*Options)) (*UpdateUserPoolClientOutput, error) { if params == nil { params = &UpdateUserPoolClientInput{} @@ -55,30 +67,46 @@ type UpdateUserPoolClientInput 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. + // 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 - // authorization code as the response. This code can be exchanged for access tokens - // with the /oauth2/token endpoint. implicit Issue the access token (and, - // optionally, ID token, based on scopes) directly to your user. client_credentials - // Issue the access token from the /oauth2/token endpoint directly to a non-person - // user using a combination of the client ID and client secret. + // The allowed OAuth flows. + // + // code Use a code grant flow, which provides an authorization code as the + // response. This code can be exchanged for access tokens with the /oauth2/token + // endpoint. + // + // implicit Issue the access token (and, optionally, ID token, based on scopes) + // directly to your user. + // + // client_credentials Issue the access token from the /oauth2/token endpoint + // directly to a non-person user using a combination of the client ID and client + // secret. AllowedOAuthFlows []types.OAuthFlowType // Set to true to use OAuth 2.0 features in your user pool app client. + // // AllowedOAuthFlowsUserPoolClient must be true before you can configure the // following features in your app client. + // // - CallBackURLs : Callback URLs. + // // - LogoutURLs : Sign-out redirect URLs. + // // - AllowedOAuthScopes : OAuth 2.0 scopes. + // // - AllowedOAuthFlows : Support for authorization code, implicit, and client // credentials OAuth 2.0 grants. + // // To use OAuth 2.0 features, configure one of these features in the Amazon // Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a // CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a @@ -93,10 +121,12 @@ type UpdateUserPoolClientInput struct { AllowedOAuthScopes []string // The Amazon Pinpoint analytics configuration necessary to collect metrics for - // this user pool. In Amazon Web Services Regions where Amazon Pinpoint isn't - // available, user pools only support sending events to Amazon Pinpoint projects in - // us-east-1. In Regions where Amazon Pinpoint is available, user pools support - // sending events to Amazon Pinpoint projects within that same Region. + // this user pool. + // + // In Amazon Web Services Regions where Amazon Pinpoint isn't available, user + // pools only support sending events to Amazon Pinpoint projects in 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 @@ -105,62 +135,92 @@ type UpdateUserPoolClientInput struct { // challenge before the session expires. AuthSessionValidity *int32 - // A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: + // 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. + // + // See [OAuth 2.0 - Redirection Endpoint]. + // + // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. + // + // App callback URLs such as myapp://example are also supported. + // + // [OAuth 2.0 - Redirection Endpoint]: https://tools.ietf.org/html/rfc6749#section-3.1.2 CallbackURLs []string // The client name from the update user pool client request. ClientName *string - // The default redirect URI. Must be in the CallbackURLs list. A redirect URI - // must: + // 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. + // + // See [OAuth 2.0 - Redirection Endpoint]. + // + // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. + // + // App callback URLs such as myapp://example are also supported. + // + // [OAuth 2.0 - Redirection Endpoint]: https://tools.ietf.org/html/rfc6749#section-3.1.2 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 - // information, including source IP address, to Amazon Cognito advanced security. - // You can only activate EnablePropagateAdditionalUserContextData in an app client - // that has a client secret. + // about propagation of user context data, see [Adding advanced security to a user pool]. 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. + // + // [Adding advanced security to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html 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]. + // + // [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 // each app client in your user pool, you can sign in your users with any // 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: + // 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 @@ -169,12 +229,16 @@ type UpdateUserPoolClientInput struct { // 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 IdTokenValidity 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. + // , 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 IdTokenValidity 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 // A list of allowed logout URLs for the IdPs. @@ -187,8 +251,12 @@ type UpdateUserPoolClientInput struct { // 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: + // 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 @@ -197,27 +265,35 @@ type UpdateUserPoolClientInput struct { // access to. After your user authenticates in your app, their access token // authorizes them to read their own attribute value for any attribute in this // list. An example of this kind of activity is when your user selects a link to - // view their profile information. Your app makes a GetUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) - // API request to retrieve and display your user's profile data. When you don't - // specify the ReadAttributes for your app client, your app can read the values of - // email_verified , phone_number_verified , and the Standard attributes of your - // user pool. When your user pool has read access to these default attributes, - // ReadAttributes doesn't return any information. Amazon Cognito only populates - // ReadAttributes in the API response if you have specified your own custom set of - // read attributes. + // view their profile information. Your app makes a [GetUser]API request to retrieve and + // display your user's profile data. + // + // When you don't specify the ReadAttributes for your app client, your app can + // read the values of email_verified , phone_number_verified , and the Standard + // attributes of your user pool. When your user pool has read access to these + // default attributes, ReadAttributes doesn't return any information. Amazon + // Cognito only populates ReadAttributes in the API response if you have specified + // your own custom set of read attributes. + // + // [GetUser]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html ReadAttributes []string // 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. + // 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 @@ -235,20 +311,23 @@ type UpdateUserPoolClientInput struct { // them to set or modify their own attribute value for any attribute in this list. // An example of this kind of activity is when you present your user with a form to // update their profile information and they change their last name. Your app then - // makes an UpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) - // API request and sets family_name to the new value. When you don't specify the - // WriteAttributes for your app client, your app can write the values of the - // Standard attributes of your user pool. When your user pool has write access to - // these default attributes, WriteAttributes doesn't return any information. - // Amazon Cognito only populates WriteAttributes in the API response if you have - // specified your own custom set of write attributes. If your app client allows - // users to sign in through an IdP, this array must include all attributes that you - // have mapped to IdP attributes. Amazon Cognito updates mapped attributes 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) - // . + // makes an [UpdateUserAttributes]API request and sets family_name to the new value. + // + // When you don't specify the WriteAttributes for your app client, your app can + // write the values of the Standard attributes of your user pool. When your user + // pool has write access to these default attributes, WriteAttributes doesn't + // return any information. Amazon Cognito only populates WriteAttributes in the + // API response if you have specified your own custom set of write attributes. + // + // If your app client allows users to sign in through an IdP, this array must + // include all attributes that you have mapped to IdP attributes. Amazon Cognito + // updates mapped attributes 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]. + // + // [Specifying IdP Attribute Mappings for Your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html + // [UpdateUserAttributes]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html WriteAttributes []string noSmithyDocumentSerde diff --git a/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go b/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go index 1c0061f3113..df468dd4d8b 100644 --- a/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go +++ b/service/cognitoidentityprovider/api_op_UpdateUserPoolDomain.go @@ -12,29 +12,48 @@ import ( ) // Updates the Secure Sockets Layer (SSL) certificate for the custom domain for -// your user pool. You can use this operation to provide the Amazon Resource Name -// (ARN) of a new certificate to Amazon Cognito. You can't use it to change the -// domain for a user pool. A custom domain is used to host the Amazon Cognito -// hosted UI, which provides sign-up and sign-in pages for your application. When -// you set up a custom domain, you provide a certificate that you manage with -// Certificate Manager (ACM). When necessary, you can use this operation to change -// the certificate that you applied to your custom domain. Usually, this is -// unnecessary following routine certificate renewal with ACM. When you renew your -// existing certificate in ACM, the ARN for your certificate remains the same, and -// your custom domain uses the new certificate automatically. However, if you -// replace your existing certificate with a new one, ACM gives the new certificate -// a new ARN. To apply the new certificate to your custom domain, you must provide -// this ARN to Amazon Cognito. When you add your new certificate in ACM, you must -// 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) -// . Amazon Cognito evaluates Identity and Access Management (IAM) policies in +// your user pool. +// +// You can use this operation to provide the Amazon Resource Name (ARN) of a new +// certificate to Amazon Cognito. You can't use it to change the domain for a user +// pool. +// +// A custom domain is used to host the Amazon Cognito hosted UI, which provides +// sign-up and sign-in pages for your application. When you set up a custom domain, +// you provide a certificate that you manage with Certificate Manager (ACM). When +// necessary, you can use this operation to change the certificate that you applied +// to your custom domain. +// +// Usually, this is unnecessary following routine certificate renewal with ACM. +// When you renew your existing certificate in ACM, the ARN for your certificate +// remains the same, and your custom domain uses the new certificate automatically. +// +// However, if you replace your existing certificate with a new one, ACM gives the +// new certificate a new ARN. To apply the new certificate to your custom domain, +// you must provide this ARN to Amazon Cognito. +// +// When you add your new certificate in ACM, you must 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]. +// +// Amazon Cognito evaluates Identity and Access Management (IAM) policies in // requests for this API operation. For this operation, you must use IAM // credentials to authorize requests, and you must grant yourself the corresponding -// IAM permission in a policy. Learn more -// - Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) -// - Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) +// IAM permission in a policy. +// +// # Learn more +// +// [Signing Amazon Web Services API Requests] +// +// [Using the Amazon Cognito user pools API and user pool endpoints] +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Using Your Own Domain for the Hosted UI]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html +// [Signing Amazon Web Services API Requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html func (c *Client) UpdateUserPoolDomain(ctx context.Context, params *UpdateUserPoolDomainInput, optFns ...func(*Options)) (*UpdateUserPoolDomainOutput, error) { if params == nil { params = &UpdateUserPoolDomainInput{} @@ -61,9 +80,11 @@ 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 - // include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the - // first or last character. Use periods to separate subdomain names. + // 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. // // This member is required. Domain *string diff --git a/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go b/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go index 9472c467e28..56dcd10e096 100644 --- a/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go +++ b/service/cognitoidentityprovider/api_op_VerifySoftwareToken.go @@ -13,13 +13,15 @@ import ( // Use this API to register a user's entered time-based one-time password (TOTP) // code and mark the user's software token MFA status as "verified" if successful. -// The request takes an access token or a session string, but not both. Amazon -// Cognito doesn't evaluate Identity and Access Management (IAM) policies in -// requests for this API operation. For this operation, you can't use IAM +// The request takes an access token or a session string, but not both. +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM // credentials to authorize requests, and you can't grant IAM permissions in // policies. For more information about authorization models in Amazon Cognito, see -// Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html func (c *Client) VerifySoftwareToken(ctx context.Context, params *VerifySoftwareTokenInput, optFns ...func(*Options)) (*VerifySoftwareTokenOutput, error) { if params == nil { params = &VerifySoftwareTokenInput{} @@ -37,9 +39,9 @@ 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) - // . + // The one- time password computed using the secret code returned by [AssociateSoftwareToken]. + // + // [AssociateSoftwareToken]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html // // This member is required. UserCode *string diff --git a/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go b/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go index d63f259fe2f..3c42a057475 100644 --- a/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go +++ b/service/cognitoidentityprovider/api_op_VerifyUserAttribute.go @@ -10,18 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . Authorize this action with a signed-in user's access token. It must include -// the scope aws.cognito.signin.user.admin . Amazon Cognito doesn't evaluate -// Identity and Access Management (IAM) policies in requests for this API -// operation. For this operation, you can't use IAM credentials to authorize -// requests, and you can't grant IAM permissions in policies. For more information -// about authorization models in Amazon Cognito, see Using the Amazon Cognito user -// pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// . +// 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]. +// +// Authorize this action with a signed-in user's access token. It must include the +// scope aws.cognito.signin.user.admin . +// +// Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies +// in requests for this API operation. For this operation, you can't use IAM +// credentials to authorize requests, and you can't grant IAM permissions in +// policies. For more information about authorization models in Amazon Cognito, see +// [Using the Amazon Cognito user pools API and user pool endpoints]. +// +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [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{} diff --git a/service/cognitoidentityprovider/doc.go b/service/cognitoidentityprovider/doc.go index 453db8a0f28..9b17b07b657 100644 --- a/service/cognitoidentityprovider/doc.go +++ b/service/cognitoidentityprovider/doc.go @@ -5,44 +5,68 @@ // // With the Amazon Cognito user pools API, you can configure user pools and // authenticate users. To authenticate users from third-party identity providers -// (IdPs) in this API, you can link IdP users to native user profiles (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) -// . Learn more about the authentication and authorization of federated users at -// Adding user pool sign-in through a third party (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html) -// and in the User pool federation endpoints and hosted UI reference (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html) -// . This API reference provides detailed information about API operations and -// object types in Amazon Cognito. Along with resource management operations, the -// Amazon Cognito user pools API includes classes of operations and authorization -// models for client-side and server-side authentication of users. You can interact -// with operations in the Amazon Cognito user pools API as any of the following -// subjects. +// (IdPs) in this API, you can [link IdP users to native user profiles]. Learn more about the authentication and +// authorization of federated users at [Adding user pool sign-in through a third party]and in the [User pool federation endpoints and hosted UI reference]. +// +// This API reference provides detailed information about API operations and +// object types in Amazon Cognito. +// +// Along with resource management operations, the Amazon Cognito user pools API +// includes classes of operations and authorization models for client-side and +// server-side authentication of users. You can interact with operations in the +// Amazon Cognito user pools API as any of the following subjects. +// // - An administrator who wants to configure user pools, app clients, users, // groups, or other user pool functions. +// // - A server-side app, like a web application, that wants to use its Amazon Web // Services privileges to manage, authenticate, or authorize a user. +// // - A client-side app, like a mobile app, that wants to make unauthenticated // requests to manage, authenticate, or authorize a user. // -// For more information, see Using the Amazon Cognito user pools API and user pool -// endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html) -// in the Amazon Cognito Developer Guide. With your Amazon Web Services SDK, you -// can build the logic to support operational flows in every use case for this API. -// You can also make direct REST API requests to Amazon Cognito user pools service -// endpoints (https://docs.aws.amazon.com/general/latest/gr/cognito_identity.html#cognito_identity_your_user_pools_region) -// . The following links can get you started with the CognitoIdentityProvider -// client in other supported Amazon Web Services SDKs. -// - Amazon Web Services Command Line Interface (https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp) -// - Amazon Web Services SDK for .NET (https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html) -// - Amazon Web Services SDK for C++ (https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html) -// - Amazon Web Services SDK for Go (https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider) -// - Amazon Web Services SDK for Java V2 (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html) -// - Amazon Web Services SDK for JavaScript (https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html) -// - Amazon Web Services SDK for PHP V3 (https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html) -// - Amazon Web Services SDK for Python (https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html) -// - Amazon Web Services SDK for Ruby V3 (https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html) -// -// To get started with an Amazon Web Services SDK, see Tools to Build on Amazon -// Web Services (http://aws.amazon.com/developer/tools/) . For example actions and -// scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon -// Web Services SDKs (https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html) -// . +// For more information, see [Using the Amazon Cognito user pools API and user pool endpoints] in the Amazon Cognito Developer Guide. +// +// With your Amazon Web Services SDK, you can build the logic to support +// operational flows in every use case for this API. You can also make direct REST +// API requests to [Amazon Cognito user pools service endpoints]. The following links can get you started with the +// CognitoIdentityProvider client in other supported Amazon Web Services SDKs. +// +// [Amazon Web Services Command Line Interface] +// +// [Amazon Web Services SDK for .NET] +// +// [Amazon Web Services SDK for C++] +// +// [Amazon Web Services SDK for Go] +// +// [Amazon Web Services SDK for Java V2] +// +// [Amazon Web Services SDK for JavaScript] +// +// [Amazon Web Services SDK for PHP V3] +// +// [Amazon Web Services SDK for Python] +// +// [Amazon Web Services SDK for Ruby V3] +// +// To get started with an Amazon Web Services SDK, see [Tools to Build on Amazon Web Services]. For example actions and +// scenarios, see [Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs]. +// +// [Adding user pool sign-in through a third party]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html +// [Amazon Web Services SDK for Java V2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html +// [Using the Amazon Cognito user pools API and user pool endpoints]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html +// [Amazon Cognito user pools service endpoints]: https://docs.aws.amazon.com/general/latest/gr/cognito_identity.html#cognito_identity_your_user_pools_region +// [link IdP users to native user profiles]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html +// [Amazon Web Services SDK for Python]: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html +// [Amazon Web Services SDK for Ruby V3]: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html +// [Amazon Web Services SDK for C++]: https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html +// [Tools to Build on Amazon Web Services]: http://aws.amazon.com/developer/tools/ +// [User pool federation endpoints and hosted UI reference]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html +// [Amazon Web Services SDK for PHP V3]: https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html +// [Amazon Web Services SDK for .NET]: https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html +// [Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs]: https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html +// [Amazon Web Services Command Line Interface]: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp +// [Amazon Web Services SDK for Go]: https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider +// [Amazon Web Services SDK for JavaScript]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html package cognitoidentityprovider diff --git a/service/cognitoidentityprovider/options.go b/service/cognitoidentityprovider/options.go index ee635438352..ff878a64949 100644 --- a/service/cognitoidentityprovider/options.go +++ b/service/cognitoidentityprovider/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cognitoidentityprovider/types/enums.go b/service/cognitoidentityprovider/types/enums.go index 53345740bb7..e9b84006a5e 100644 --- a/service/cognitoidentityprovider/types/enums.go +++ b/service/cognitoidentityprovider/types/enums.go @@ -14,8 +14,9 @@ const ( // Values returns all known values for AccountTakeoverEventActionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountTakeoverEventActionType) Values() []AccountTakeoverEventActionType { return []AccountTakeoverEventActionType{ "BLOCK", @@ -36,6 +37,7 @@ const ( // 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{ @@ -55,8 +57,9 @@ const ( ) // Values returns all known values for AliasAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AliasAttributeType) Values() []AliasAttributeType { return []AliasAttributeType{ "phone_number", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for AttributeDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeDataType) Values() []AttributeDataType { return []AttributeDataType{ "String", @@ -101,8 +105,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -124,8 +129,9 @@ const ( ) // Values returns all known values for ChallengeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChallengeName) Values() []ChallengeName { return []ChallengeName{ "Password", @@ -150,8 +156,9 @@ const ( ) // Values returns all known values for ChallengeNameType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChallengeNameType) Values() []ChallengeNameType { return []ChallengeNameType{ "SMS_MFA", @@ -176,8 +183,9 @@ const ( ) // Values returns all known values for ChallengeResponse. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChallengeResponse) Values() []ChallengeResponse { return []ChallengeResponse{ "Success", @@ -195,8 +203,9 @@ const ( // Values returns all known values for CompromisedCredentialsEventActionType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompromisedCredentialsEventActionType) Values() []CompromisedCredentialsEventActionType { return []CompromisedCredentialsEventActionType{ "BLOCK", @@ -213,8 +222,9 @@ const ( // Values returns all known values for CustomEmailSenderLambdaVersionType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomEmailSenderLambdaVersionType) Values() []CustomEmailSenderLambdaVersionType { return []CustomEmailSenderLambdaVersionType{ "V1_0", @@ -230,8 +240,9 @@ const ( // Values returns all known values for CustomSMSSenderLambdaVersionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomSMSSenderLambdaVersionType) Values() []CustomSMSSenderLambdaVersionType { return []CustomSMSSenderLambdaVersionType{ "V1_0", @@ -247,8 +258,9 @@ const ( ) // Values returns all known values for DefaultEmailOptionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultEmailOptionType) Values() []DefaultEmailOptionType { return []DefaultEmailOptionType{ "CONFIRM_WITH_LINK", @@ -265,8 +277,9 @@ const ( ) // Values returns all known values for DeletionProtectionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeletionProtectionType) Values() []DeletionProtectionType { return []DeletionProtectionType{ "ACTIVE", @@ -283,8 +296,9 @@ const ( ) // Values returns all known values for DeliveryMediumType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryMediumType) Values() []DeliveryMediumType { return []DeliveryMediumType{ "SMS", @@ -302,6 +316,7 @@ const ( // Values returns all known values for DeviceRememberedStatusType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DeviceRememberedStatusType) Values() []DeviceRememberedStatusType { return []DeviceRememberedStatusType{ @@ -322,8 +337,9 @@ const ( ) // Values returns all known values for DomainStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainStatusType) Values() []DomainStatusType { return []DomainStatusType{ "CREATING", @@ -343,8 +359,9 @@ const ( ) // Values returns all known values for EmailSendingAccountType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmailSendingAccountType) Values() []EmailSendingAccountType { return []EmailSendingAccountType{ "COGNITO_DEFAULT", @@ -362,8 +379,9 @@ const ( ) // Values returns all known values for EventFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventFilterType) Values() []EventFilterType { return []EventFilterType{ "SIGN_IN", @@ -382,8 +400,9 @@ const ( ) // Values returns all known values for EventResponseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventResponseType) Values() []EventResponseType { return []EventResponseType{ "Pass", @@ -400,8 +419,9 @@ const ( ) // Values returns all known values for EventSourceName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourceName) Values() []EventSourceName { return []EventSourceName{ "userNotification", @@ -420,8 +440,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -447,8 +468,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ADMIN_NO_SRP_AUTH", @@ -471,8 +493,9 @@ const ( ) // Values returns all known values for FeedbackValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeedbackValueType) Values() []FeedbackValueType { return []FeedbackValueType{ "Valid", @@ -494,6 +517,7 @@ const ( // 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{ @@ -514,8 +538,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "ERROR", @@ -531,8 +556,9 @@ const ( ) // Values returns all known values for MessageActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageActionType) Values() []MessageActionType { return []MessageActionType{ "RESEND", @@ -550,8 +576,9 @@ const ( ) // Values returns all known values for OAuthFlowType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OAuthFlowType) Values() []OAuthFlowType { return []OAuthFlowType{ "code", @@ -570,8 +597,9 @@ const ( // Values returns all known values for PreTokenGenerationLambdaVersionType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreTokenGenerationLambdaVersionType) Values() []PreTokenGenerationLambdaVersionType { return []PreTokenGenerationLambdaVersionType{ "V1_0", @@ -589,8 +617,9 @@ const ( // Values returns all known values for PreventUserExistenceErrorTypes. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreventUserExistenceErrorTypes) Values() []PreventUserExistenceErrorTypes { return []PreventUserExistenceErrorTypes{ "LEGACY", @@ -608,8 +637,9 @@ const ( ) // Values returns all known values for RecoveryOptionNameType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoveryOptionNameType) Values() []RecoveryOptionNameType { return []RecoveryOptionNameType{ "verified_email", @@ -628,8 +658,9 @@ const ( ) // Values returns all known values for RiskDecisionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RiskDecisionType) Values() []RiskDecisionType { return []RiskDecisionType{ "NoRisk", @@ -648,8 +679,9 @@ const ( ) // Values returns all known values for RiskLevelType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RiskLevelType) Values() []RiskLevelType { return []RiskLevelType{ "Low", @@ -667,8 +699,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "Enabled", @@ -687,8 +720,9 @@ const ( ) // Values returns all known values for TimeUnitsType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeUnitsType) Values() []TimeUnitsType { return []TimeUnitsType{ "seconds", @@ -713,8 +747,9 @@ const ( ) // Values returns all known values for UserImportJobStatusType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserImportJobStatusType) Values() []UserImportJobStatusType { return []UserImportJobStatusType{ "Created", @@ -737,8 +772,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "phone_number", @@ -756,8 +792,9 @@ const ( ) // Values returns all known values for UserPoolMfaType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserPoolMfaType) Values() []UserPoolMfaType { return []UserPoolMfaType{ "OFF", @@ -780,8 +817,9 @@ const ( ) // Values returns all known values for UserStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserStatusType) Values() []UserStatusType { return []UserStatusType{ "UNCONFIRMED", @@ -803,8 +841,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "phone_number", @@ -822,8 +861,9 @@ const ( // Values returns all known values for VerifySoftwareTokenResponseType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifySoftwareTokenResponseType) Values() []VerifySoftwareTokenResponseType { return []VerifySoftwareTokenResponseType{ "SUCCESS", diff --git a/service/cognitoidentityprovider/types/types.go b/service/cognitoidentityprovider/types/types.go index 5a067e3cb78..11edc7d4f11 100644 --- a/service/cognitoidentityprovider/types/types.go +++ b/service/cognitoidentityprovider/types/types.go @@ -36,11 +36,15 @@ 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. // // This member is required. @@ -76,28 +80,33 @@ type AdminCreateUserConfigType struct { // 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) - // . + // The message template to be used for the welcome message to new users. + // + // See also [Customizing User Invitation Messages]. + // + // [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 - // used, and UnusedAccountValidityDays will be no longer be an available parameter - // for that user pool. + // MessageAction parameter. The default value for this parameter is 7. + // + // If you set a 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 noSmithyDocumentSerde } // The Amazon Pinpoint analytics configuration necessary to collect metrics for a -// user pool. In Regions where Amazon Pinpoint isn't available, user pools only -// support sending events to Amazon Pinpoint projects in us-east-1. In Regions -// where Amazon Pinpoint is available, user pools support sending events to Amazon -// Pinpoint projects within that same Region. +// user pool. +// +// In Regions where Amazon Pinpoint isn't available, user pools only support +// sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon +// Pinpoint is available, user pools support sending events to Amazon Pinpoint +// projects within that same Region. type AnalyticsConfigurationType struct { // The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the @@ -123,12 +132,14 @@ type AnalyticsConfigurationType struct { noSmithyDocumentSerde } -// An Amazon Pinpoint analytics endpoint. An endpoint uniquely identifies a mobile -// 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) -// . +// An Amazon Pinpoint analytics endpoint. +// +// An endpoint uniquely identifies a mobile 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]. +// +// [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. @@ -229,12 +240,13 @@ type CloudWatchLogsConfigurationType struct { // The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user // pool sends logs. The log group must not be encrypted with Key Management Service - // and must be in the same Amazon Web Services account as your user pool. To send - // logs to log groups with a resource policy of a size greater than 5120 + // and must be in the same Amazon Web Services account as your user pool. + // + // To send logs to log groups with a resource policy of a size greater than 5120 // characters, configure a log group with a path that starts with /aws/vendedlogs . - // For more information, see Enabling logging from certain Amazon Web Services - // services (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) - // . + // For more information, see [Enabling logging from certain Amazon Web Services services]. + // + // [Enabling logging from certain Amazon Web Services services]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html LogGroupArn *string noSmithyDocumentSerde @@ -308,9 +320,9 @@ type ContextDataType struct { ServerPath *string // 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) - // . + // Cognito context data collection library. For more information, see [Adding user device and session data to API requests]. + // + // [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 EncodedData *string noSmithyDocumentSerde @@ -340,6 +352,7 @@ type CustomEmailLambdaVersionConfigType struct { // The user pool trigger version of the request that Amazon Cognito sends to your // Lambda function. Higher-numbered versions add fields that support new features. + // // You must use a LambdaVersion of V1_0 with a custom sender function. // // This member is required. @@ -359,6 +372,7 @@ type CustomSMSLambdaVersionConfigType struct { // The user pool trigger version of the request that Amazon Cognito sends to your // Lambda function. Higher-numbered versions add fields that support new features. + // // You must use a LambdaVersion of V1_0 with a custom sender function. // // This member is required. @@ -367,35 +381,48 @@ 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) -// 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) -// from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY -// 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. +// The device-remembering configuration for a user pool. A [DescribeUserPool] 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]API +// request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is +// true , you must follow ConfirmDevice with an [UpdateDeviceStatus] 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]request. If your app doesn't include a DEVICE_KEY +// parameter, the [response]from Amazon Cognito includes newly-generated DEVICE_KEY and +// DEVICE_GROUP_KEY 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. +// +// [UpdateDeviceStatus]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html +// [InitiateAuth]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html +// [response]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax +// [DescribeUserPool]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html +// [ConfirmDevice]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html 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. + // 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) - // 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 - // immediately remembers devices that you register in a ConfirmDevice API request. + // your app sends a [ConfirmDevice]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]API request. + // + // When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately + // remembers devices that you register in a ConfirmDevice API request. + // + // [UpdateDeviceStatus]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html + // [ConfirmDevice]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html DeviceOnlyRememberedOnUserPrompt bool noSmithyDocumentSerde @@ -407,7 +434,9 @@ type DeviceSecretVerifierConfigType struct { // The password verifier. PasswordVerifier *string - // The salt (https://en.wikipedia.org/wiki/Salt_(cryptography)) + // The [salt] + // + // [salt]: https://en.wikipedia.org/wiki/Salt_(cryptography) Salt *string noSmithyDocumentSerde @@ -472,12 +501,14 @@ type DomainDescriptionType struct { // The email configuration of your user pool. The email configuration type sets // your preferred sending method, Amazon Web Services Region, and sender for -// 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) -// . +// 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]. +// +// [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 @@ -485,41 +516,54 @@ type EmailConfigurationType struct { // reference to the configuration set in the headers of the email. Once applied, // all of the rules in that configuration set are applied to the email. // Configuration sets can be used to apply the following types of rules to emails: + // // Event publishing Amazon Simple Email Service can track the number of send, // delivery, open, click, bounce, and complaint events for each email sent. Use // event publishing to send information about these events to other Amazon Web - // Services services such as and Amazon CloudWatch IP pool management When leasing - // dedicated IP addresses with Amazon Simple Email Service, you can create groups - // of IP addresses, called dedicated IP pools. You can then associate the dedicated - // IP pools with configuration sets. + // Services services such as and Amazon CloudWatch + // + // IP pool management When leasing dedicated IP addresses with Amazon Simple Email + // Service, you can create groups of IP addresses, called dedicated IP pools. You + // can then associate the dedicated IP pools with configuration sets. ConfigurationSet *string // Specifies whether Amazon Cognito uses its built-in functionality to send your // users email messages, or uses your Amazon Simple Email Service email - // configuration. Specify one of the following values: COGNITO_DEFAULT When Amazon - // Cognito emails your users, it uses its built-in email functionality. When you - // use the default option, Amazon Cognito allows only a limited number of emails - // 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 - // 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 - // send email from your verified email address. When you use this option, the email - // delivery limits are the same limits that apply to your Amazon SES verified email - // address in your Amazon Web Services account. If you use this option, provide the - // ARN of an Amazon SES verified email address for the SourceArn parameter. Before - // Amazon Cognito can email your users, it requires additional permissions to call - // Amazon SES on your behalf. When you update your user pool with this option, - // 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) + // configuration. Specify one of the following values: + // + // COGNITO_DEFAULT When Amazon Cognito emails your users, it uses its built-in + // email functionality. When you use the default option, Amazon Cognito allows only + // a limited number of emails 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] 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 send email from + // your verified email address. When you use this option, the email delivery limits + // are the same limits that apply to your Amazon SES verified email address in your + // Amazon Web Services account. + // + // If you use this option, provide the ARN of an Amazon SES verified email address + // for the SourceArn parameter. + // + // Before Amazon Cognito can email your users, it requires additional permissions + // to call Amazon SES on your behalf. When you update your user pool with this + // option, 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] // in the Amazon Cognito Developer Guide. + // + // [Limits]: https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html + // [Using Service-Linked Roles for Amazon Cognito]: https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html EmailSendingAccount EmailSendingAccountType // Either the sender’s email address or the sender’s name with their email @@ -536,16 +580,19 @@ type EmailConfigurationType struct { // verified domain, in the Amazon Cognito console. Amazon Cognito uses the email // address that you provide 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) - // . + // and the user pool Region are the same. For more information, see [Amazon SES email configuration regions]in the [Amazon Cognito Developer Guide]. + // + // [Amazon SES email configuration regions]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping + // [Amazon Cognito Developer Guide]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html SourceArn *string noSmithyDocumentSerde @@ -636,12 +683,15 @@ 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 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. + // 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. Precedence *int32 // The role Amazon Resource Name (ARN) for the group. @@ -687,71 +737,96 @@ type IdentityProviderType struct { // The scopes, URLs, and identifiers for your external identity provider. The // following examples describe the provider detail keys for each IdP type. These // values and their schema are subject to change. Social IdP authorize_scopes - // values must match the values listed here. OpenID Connect (OIDC) Amazon Cognito - // accepts the following elements when it can't discover endpoint URLs from - // oidc_issuer : attributes_url , authorize_url , jwks_uri , token_url . Create or - // update request: "ProviderDetails": { "attributes_request_method": "GET", - // "attributes_url": "https://auth.example.com/userInfo", "authorize_scopes": - // "openid profile email", "authorize_url": "https://auth.example.com/authorize", - // "client_id": "1example23456789", "client_secret": "provider-app-client-secret", - // "jwks_uri": "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": - // "https://auth.example.com", "token_url": "https://example.com/token" } Describe - // response: "ProviderDetails": { "attributes_request_method": "GET", + // values must match the values listed here. + // + // OpenID Connect (OIDC) Amazon Cognito accepts the following elements when it + // can't discover endpoint URLs from oidc_issuer : attributes_url , authorize_url , + // jwks_uri , token_url . + // + // Create or update request: "ProviderDetails": { "attributes_request_method": + // "GET", "attributes_url": "https://auth.example.com/userInfo", + // "authorize_scopes": "openid profile email", "authorize_url": + // "https://auth.example.com/authorize", "client_id": "1example23456789", + // "client_secret": "provider-app-client-secret", "jwks_uri": + // "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": + // "https://auth.example.com", "token_url": "https://example.com/token" } + // + // Describe response: "ProviderDetails": { "attributes_request_method": "GET", // "attributes_url": "https://auth.example.com/userInfo", // "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile // email", "authorize_url": "https://auth.example.com/authorize", "client_id": // "1example23456789", "client_secret": "provider-app-client-secret", "jwks_uri": // "https://auth.example.com/.well-known/jwks.json", "oidc_issuer": - // "https://auth.example.com", "token_url": "https://example.com/token" } SAML - // Create or update request with Metadata URL: "ProviderDetails": { "IDPInit": - // "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL": - // "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": - // "rsa-sha256" } Create or update request with Metadata file: "ProviderDetails": - // { "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", - // "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" } The - // value of MetadataFile must be the plaintext metadata document with all quote - // (") characters escaped by backslashes. Describe response: "ProviderDetails": { + // "https://auth.example.com", "token_url": "https://example.com/token" } + // + // SAML Create or update request with Metadata URL: "ProviderDetails": { // "IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" : "true", - // "ActiveEncryptionCertificate": "[certificate]", "MetadataURL": - // "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": - // "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", - // "SSORedirectBindingURI": "https://auth.example.com/sso/saml" } LoginWithAmazon - // Create or update request: "ProviderDetails": { "authorize_scopes": "profile - // postal_code", "client_id": "amzn1.application-oa2-client.1example23456789", - // "client_secret": "provider-app-client-secret" Describe response: - // "ProviderDetails": { "attributes_url": "https://api.amazon.com/user/profile", - // "attributes_url_add_attributes": "false", "authorize_scopes": "profile - // postal_code", "authorize_url": "https://www.amazon.com/ap/oa", "client_id": + // "MetadataURL": "https://auth.example.com/sso/saml/metadata", + // "RequestSigningAlgorithm": "rsa-sha256" } + // + // Create or update request with Metadata file: "ProviderDetails": { "IDPInit": + // "true", "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataFile": + // "[metadata XML]", "RequestSigningAlgorithm": "rsa-sha256" } + // + // The value of MetadataFile must be the plaintext metadata document with all + // quote (") characters escaped by backslashes. + // + // Describe response: "ProviderDetails": { "IDPInit": "true", "IDPSignout": + // "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": + // "[certificate]", "MetadataURL": "https://auth.example.com/sso/saml/metadata", + // "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": + // "https://auth.example.com/slo/saml", "SSORedirectBindingURI": + // "https://auth.example.com/sso/saml" } + // + // LoginWithAmazon Create or update request: "ProviderDetails": { + // "authorize_scopes": "profile postal_code", "client_id": + // "amzn1.application-oa2-client.1example23456789", "client_secret": + // "provider-app-client-secret" + // + // Describe response: "ProviderDetails": { "attributes_url": + // "https://api.amazon.com/user/profile", "attributes_url_add_attributes": "false", + // "authorize_scopes": "profile postal_code", "authorize_url": + // "https://www.amazon.com/ap/oa", "client_id": // "amzn1.application-oa2-client.1example23456789", "client_secret": // "provider-app-client-secret", "token_request_method": "POST", "token_url": - // "https://api.amazon.com/auth/o2/token" } Google Create or update request: - // "ProviderDetails": { "authorize_scopes": "email profile openid", "client_id": + // "https://api.amazon.com/auth/o2/token" } + // + // Google Create or update request: "ProviderDetails": { "authorize_scopes": + // "email profile openid", "client_id": // "1example23456789.apps.googleusercontent.com", "client_secret": - // "provider-app-client-secret" } Describe response: "ProviderDetails": { - // "attributes_url": "https://people.googleapis.com/v1/people/me?personFields=", + // "provider-app-client-secret" } + // + // Describe response: "ProviderDetails": { "attributes_url": + // "https://people.googleapis.com/v1/people/me?personFields=", // "attributes_url_add_attributes": "true", "authorize_scopes": "email profile // openid", "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth", // "client_id": "1example23456789.apps.googleusercontent.com", "client_secret": // "provider-app-client-secret", "oidc_issuer": "https://accounts.google.com", // "token_request_method": "POST", "token_url": - // "https://www.googleapis.com/oauth2/v4/token" } SignInWithApple Create or update - // request: "ProviderDetails": { "authorize_scopes": "email name", "client_id": - // "com.example.cognito", "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", - // "team_id": "3EXAMPLE" } Describe response: "ProviderDetails": { - // "attributes_url_add_attributes": "false", "authorize_scopes": "email name", - // "authorize_url": "https://appleid.apple.com/auth/authorize", "client_id": - // "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer": - // "https://appleid.apple.com", "team_id": "2EXAMPLE", "token_request_method": - // "POST", "token_url": "https://appleid.apple.com/auth/token" } Facebook Create or - // update request: "ProviderDetails": { "api_version": "v17.0", + // "https://www.googleapis.com/oauth2/v4/token" } + // + // SignInWithApple Create or update request: "ProviderDetails": { + // "authorize_scopes": "email name", "client_id": "com.example.cognito", + // "private_key": "1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" } + // + // Describe response: "ProviderDetails": { "attributes_url_add_attributes": + // "false", "authorize_scopes": "email name", "authorize_url": + // "https://appleid.apple.com/auth/authorize", "client_id": "com.example.cognito", + // "key_id": "1EXAMPLE", "oidc_issuer": "https://appleid.apple.com", "team_id": + // "2EXAMPLE", "token_request_method": "POST", "token_url": + // "https://appleid.apple.com/auth/token" } + // + // Facebook Create or update request: "ProviderDetails": { "api_version": "v17.0", // "authorize_scopes": "public_profile, email", "client_id": "1example23456789", - // "client_secret": "provider-app-client-secret" } Describe response: - // "ProviderDetails": { "api_version": "v17.0", "attributes_url": - // "https://graph.facebook.com/v17.0/me?fields=", "attributes_url_add_attributes": - // "true", "authorize_scopes": "public_profile, email", "authorize_url": - // "https://www.facebook.com/v17.0/dialog/oauth", "client_id": "1example23456789", - // "client_secret": "provider-app-client-secret", "token_request_method": "GET", - // "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" } + // "client_secret": "provider-app-client-secret" } + // + // Describe response: "ProviderDetails": { "api_version": "v17.0", + // "attributes_url": "https://graph.facebook.com/v17.0/me?fields=", + // "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, + // email", "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", + // "client_id": "1example23456789", "client_secret": "provider-app-client-secret", + // "token_request_method": "GET", "token_url": + // "https://graph.facebook.com/v17.0/oauth/access_token" } ProviderDetails map[string]string // The IdP name. @@ -784,9 +859,8 @@ type LambdaConfigType struct { // Defines the authentication challenge. DefineAuthChallenge *string - // 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 . + // 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 . KMSKeyID *string // A post-authentication Lambda trigger. @@ -802,10 +876,14 @@ type LambdaConfigType struct { PreSignUp *string // The Amazon Resource Name (ARN) of the function that you want to assign to your - // Lambda trigger. Set this parameter for legacy purposes. If you also set an ARN - // in PreTokenGenerationConfig , its value must be identical to PreTokenGeneration - // . For new instances of pre token generation triggers, set the LambdaArn of - // PreTokenGenerationConfig . You can set + // Lambda trigger. + // + // Set this parameter for legacy purposes. If you also set an ARN in + // PreTokenGenerationConfig , its value must be identical to PreTokenGeneration . + // For new instances of pre token generation triggers, set the LambdaArn of + // PreTokenGenerationConfig . + // + // You can set PreTokenGeneration *string // The detailed configuration of a pre token generation trigger. If you also set @@ -861,14 +939,16 @@ type LogDeliveryConfigurationType struct { // The message template structure. 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) - // is DEVELOPER. + // The message template for email messages. EmailMessage is allowed only if [EmailSendingAccount] is + // DEVELOPER. + // + // [EmailSendingAccount]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount 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) - // is DEVELOPER. + // The subject line for email messages. EmailSubject is allowed only if [EmailSendingAccount] is + // DEVELOPER. + // + // [EmailSendingAccount]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount EmailSubject *string // The message template for SMS messages. @@ -877,7 +957,8 @@ type MessageTemplateType struct { noSmithyDocumentSerde } -// This data type is no longer supported. Applies only to SMS multi-factor +// This data type is no longer supported. Applies only to SMS multi-factor +// // authentication (MFA) configurations. Does not apply to time-based one-time // password (TOTP) software token MFA configurations. type MFAOptionType struct { @@ -993,6 +1074,7 @@ type PasswordPolicyType struct { // user doesn't sign in during this time, an administrator must reset their // password. Defaults to 7 . If you submit a value of 0 , Amazon Cognito treats it // as a null value and sets TemporaryPasswordValidityDays to its default value. + // // When you set TemporaryPasswordValidityDays for a user pool, you can no longer // set a value for the legacy UnusedAccountValidityDays parameter in that user // pool. @@ -1005,9 +1087,10 @@ type PasswordPolicyType struct { type PreTokenGenerationVersionConfigType struct { // The Amazon Resource Name (ARN) of the function that you want to assign to your - // Lambda trigger. This parameter and the PreTokenGeneration property of - // LambdaConfig have the same value. For new instances of pre token generation - // triggers, set LambdaArn . + // Lambda trigger. + // + // This parameter and the PreTokenGeneration property of LambdaConfig have the + // same value. For new instances of pre token generation triggers, set LambdaArn . // // This member is required. LambdaArn *string @@ -1094,8 +1177,9 @@ type ResourceServerType struct { // A unique resource server identifier for the resource server. The identifier can // be an API friendly name like solar-system-data . You can also set an API URL - // like https://solar-system-data-api.example.com as your identifier. Amazon - // Cognito represents scopes in the access token in the format + // like https://solar-system-data-api.example.com as your identifier. + // + // Amazon Cognito represents scopes in the access token in the format // $resource-server-identifier/$scope . Longer scope-identifier strings increase // the size of your access tokens. Identifier *string @@ -1157,11 +1241,13 @@ type RiskExceptionConfigurationType struct { // A list of the user attributes and their properties in your user pool. The // attribute schema contains standard attributes, custom attributes with a custom: -// prefix, and developer attributes with a dev: prefix. For more information, see -// User pool attributes (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) -// . Developer-only attributes are a legacy feature of user pools, are read-only to +// prefix, and developer attributes with a dev: prefix. For more information, see [User pool attributes]. +// +// Developer-only attributes are a legacy feature of user pools, are read-only to // all app clients. You can create and update developer-only attributes only with // IAM-authenticated API operations. Use app client read/write permissions instead. +// +// [User pool attributes]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html type SchemaAttributeType struct { // The data format of the values for your attribute. When you choose an @@ -1170,23 +1256,26 @@ type SchemaAttributeType struct { // "custom:isMember" : "true" or "custom:YearsAsMember" : "12" . AttributeDataType AttributeDataType - // 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 - // 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 - // but can't be updated using UpdateUserAttributes. + // You should use [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 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 but can't be updated using UpdateUserAttributes. + // + // [WriteAttributes]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes DeveloperOnlyAttribute *bool - // Specifies whether the value of the attribute can be changed. Any user pool - // attribute whose value you map from an IdP attribute must be mutable, with a - // parameter value of 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) - // . + // Specifies whether the value of the attribute can be changed. + // + // Any user pool attribute whose value you map from an IdP attribute must be + // mutable, with a parameter value of 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]. + // + // [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 // The name of your user pool attribute. When you create or update a user pool, @@ -1222,8 +1311,9 @@ 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]. + // + // [spending limit]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html // // This member is required. SnsCallerArn *string @@ -1236,18 +1326,22 @@ type SmsConfigurationType struct { // 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] + // + // [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 // choose the same Region as your user pool, or a supported Legacy Amazon SNS - // 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) - // . + // 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]. + // + // [SMS message settings for Amazon Cognito user pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html SnsRegion *string noSmithyDocumentSerde @@ -1338,7 +1432,7 @@ 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 + // 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. AccessTokenValidity duration can range from five minutes to one day. AccessToken TimeUnitsType @@ -1392,9 +1486,9 @@ type UICustomizationType struct { // 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) -// . +// address and phone number attributes. For more information, see [Verifying updates to email addresses and phone numbers]. +// +// [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 @@ -1402,15 +1496,20 @@ type UserAttributeUpdateSettingsType struct { // user attribute that has this option activated, Amazon Cognito sends a // 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 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 + // verification message and confirms the new value. + // + // You can verify an updated email address or phone number with a [VerifyUserAttribute] API request. + // You can also call the [AdminUpdateUserAttributes]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 // them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, // API operations that change attribute values can immediately update a user’s // email or phone_number attribute. + // + // [VerifyUserAttribute]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html + // [AdminUpdateUserAttributes]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html AttributesRequireVerificationBeforeUpdate []VerifiedAttributeType noSmithyDocumentSerde @@ -1422,9 +1521,9 @@ type UserAttributeUpdateSettingsType struct { 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) - // . + // Cognito context data collection library. For more information, see [Adding user device and session data to API requests]. + // + // [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 EncodedData *string // The source IP address of your user's device. @@ -1474,15 +1573,23 @@ 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. Status UserImportJobStatusType @@ -1500,14 +1607,18 @@ type UsernameConfigurationType struct { // the user pool through Amazon Cognito APIs. For most use cases, set case // sensitivity to False (case insensitive) as a best practice. When usernames and // email addresses are case insensitive, users can sign in as the same user when - // they enter a different capitalization of their user name. Valid values include: - // True Enables 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 username , USERNAME , or UserName . This option - // also enables both preferred_username and email alias to be case insensitive, in - // addition to the username attribute. + // they enter a different capitalization of their user name. + // + // Valid values include: + // + // True Enables 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 username , USERNAME , or + // UserName . This option also enables both preferred_username and email alias to + // be case insensitive, in addition to the username attribute. // // This member is required. CaseSensitive *bool @@ -1518,8 +1629,11 @@ type UsernameConfigurationType struct { // User pool add-ons. Contains settings for activation of advanced security // features. To log user security information but take no action, set to AUDIT . To // configure automatic security responses to risky traffic to your user pool, set -// to ENFORCED . For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) -// . +// to ENFORCED . +// +// For more information, see [Adding advanced security to a user pool]. +// +// [Adding advanced security to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html type UserPoolAddOnsType struct { // The operating mode of advanced security features in your user pool. @@ -1552,30 +1666,46 @@ 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. + // 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 - // authorization code as the response. This code can be exchanged for access tokens - // with the /oauth2/token endpoint. implicit Issue the access token (and, - // optionally, ID token, based on scopes) directly to your user. client_credentials - // Issue the access token from the /oauth2/token endpoint directly to a non-person - // user using a combination of the client ID and client secret. + // The allowed OAuth flows. + // + // code Use a code grant flow, which provides an authorization code as the + // response. This code can be exchanged for access tokens with the /oauth2/token + // endpoint. + // + // implicit Issue the access token (and, optionally, ID token, based on scopes) + // directly to your user. + // + // client_credentials Issue the access token from the /oauth2/token endpoint + // directly to a non-person user using a combination of the client ID and client + // secret. AllowedOAuthFlows []OAuthFlowType // Set to true to use OAuth 2.0 features in your user pool app client. + // // AllowedOAuthFlowsUserPoolClient must be true before you can configure the // following features in your app client. + // // - CallBackURLs : Callback URLs. + // // - LogoutURLs : Sign-out redirect URLs. + // // - AllowedOAuthScopes : OAuth 2.0 scopes. + // // - AllowedOAuthFlows : Support for authorization code, implicit, and client // credentials OAuth 2.0 grants. + // // To use OAuth 2.0 features, configure one of these features in the Amazon // Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a // CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a @@ -1589,10 +1719,11 @@ type UserPoolClientType struct { // supports custom scopes that you create in Resource Servers. AllowedOAuthScopes []string - // The Amazon Pinpoint analytics configuration for the user pool client. Amazon - // Cognito user pools only support sending events to Amazon Pinpoint projects in - // the US East (N. Virginia) us-east-1 Region, regardless of the Region where the - // user pool resides. + // The Amazon Pinpoint analytics configuration for the user pool client. + // + // Amazon Cognito user pools only support sending events to Amazon Pinpoint + // projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region + // where the user pool resides. AnalyticsConfiguration *AnalyticsConfigurationType // Amazon Cognito creates a session token for each API request in an @@ -1601,14 +1732,24 @@ type UserPoolClientType struct { // challenge before the session expires. AuthSessionValidity *int32 - // A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must: + // 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. + // + // See [OAuth 2.0 - Redirection Endpoint]. + // + // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. + // + // App callback URLs such as myapp://example are also supported. + // + // [OAuth 2.0 - Redirection Endpoint]: https://tools.ietf.org/html/rfc6749#section-3.1.2 CallbackURLs []string // The ID of the client associated with the user pool. @@ -1625,15 +1766,24 @@ type UserPoolClientType struct { // human-readable format like ISO 8601 or a Java Date object. CreationDate *time.Time - // The default redirect URI. Must be in the CallbackURLs list. A redirect URI - // must: + // 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. + // + // See [OAuth 2.0 - Redirection Endpoint]. + // + // Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing + // purposes only. + // + // App callback URLs such as myapp://example are also supported. + // + // [OAuth 2.0 - Redirection Endpoint]: https://tools.ietf.org/html/rfc6749#section-3.1.2 DefaultRedirectURI *string // When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts @@ -1641,42 +1791,55 @@ type UserPoolClientType struct { // 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 - // 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) - // . + // 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]. + // + // [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 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]. + // + // [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 // each app client in your user pool, you can sign in your users with any // 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: + // 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 @@ -1685,12 +1848,16 @@ type UserPoolClientType struct { // 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 IdTokenValidity 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. + // , 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 IdTokenValidity 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 // The date and time when the item was modified. Amazon Cognito returns this @@ -1708,8 +1875,12 @@ type UserPoolClientType struct { // 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: + // 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 @@ -1718,27 +1889,35 @@ type UserPoolClientType struct { // access to. After your user authenticates in your app, their access token // authorizes them to read their own attribute value for any attribute in this // list. An example of this kind of activity is when your user selects a link to - // view their profile information. Your app makes a GetUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html) - // API request to retrieve and display your user's profile data. When you don't - // specify the ReadAttributes for your app client, your app can read the values of - // email_verified , phone_number_verified , and the Standard attributes of your - // user pool. When your user pool has read access to these default attributes, - // ReadAttributes doesn't return any information. Amazon Cognito only populates - // ReadAttributes in the API response if you have specified your own custom set of - // read attributes. + // view their profile information. Your app makes a [GetUser]API request to retrieve and + // display your user's profile data. + // + // When you don't specify the ReadAttributes for your app client, your app can + // read the values of email_verified , phone_number_verified , and the Standard + // attributes of your user pool. When your user pool has read access to these + // default attributes, ReadAttributes doesn't return any information. Amazon + // Cognito only populates ReadAttributes in the API response if you have specified + // your own custom set of read attributes. + // + // [GetUser]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html ReadAttributes []string // 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. + // 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 @@ -1758,20 +1937,23 @@ type UserPoolClientType struct { // them to set or modify their own attribute value for any attribute in this list. // An example of this kind of activity is when you present your user with a form to // update their profile information and they change their last name. Your app then - // makes an UpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) - // API request and sets family_name to the new value. When you don't specify the - // WriteAttributes for your app client, your app can write the values of the - // Standard attributes of your user pool. When your user pool has write access to - // these default attributes, WriteAttributes doesn't return any information. - // Amazon Cognito only populates WriteAttributes in the API response if you have - // specified your own custom set of write attributes. If your app client allows - // users to sign in through an IdP, this array must include all attributes that you - // have mapped to IdP attributes. Amazon Cognito updates mapped attributes 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) - // . + // makes an [UpdateUserAttributes]API request and sets family_name to the new value. + // + // When you don't specify the WriteAttributes for your app client, your app can + // write the values of the Standard attributes of your user pool. When your user + // pool has write access to these default attributes, WriteAttributes doesn't + // return any information. Amazon Cognito only populates WriteAttributes in the + // API response if you have specified your own custom set of write attributes. + // + // If your app client allows users to sign in through an IdP, this array must + // include all attributes that you have mapped to IdP attributes. Amazon Cognito + // updates mapped attributes 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]. + // + // [Specifying IdP Attribute Mappings for Your user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html + // [UpdateUserAttributes]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html WriteAttributes []string noSmithyDocumentSerde @@ -1847,24 +2029,28 @@ 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 - // 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) - // . + // 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]. + // + // [Using Your 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. // Before you can delete a user pool that you have protected against deletion, you - // must deactivate this feature. When you try to delete a protected user pool in a - // DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException - // error. To delete a protected user pool, send a new DeleteUserPool request after - // you deactivate deletion protection in an UpdateUserPool API request. + // must deactivate this feature. + // + // When you try to delete a protected user pool in a DeleteUserPool API request, + // Amazon Cognito returns an InvalidParameterException error. To delete a + // protected user pool, send a new DeleteUserPool request after you deactivate + // deletion protection in an UpdateUserPool API request. DeletionProtection DeletionProtectionType // The device-remembering configuration for a user pool. A null value indicates - // that you have deactivated device remembering in your user pool. When you provide - // a value for any DeviceConfiguration field, you activate the Amazon Cognito - // device-remembering feature. + // that you have deactivated device remembering in your user pool. + // + // When you provide a value for any DeviceConfiguration field, you activate the + // Amazon Cognito device-remembering feature. DeviceConfiguration *DeviceConfigurationType // The domain prefix, if the user pool has a domain associated with it. @@ -1880,12 +2066,14 @@ 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]. + // + // [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]. + // + // [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. @@ -1903,10 +2091,13 @@ 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. MfaConfiguration UserPoolMfaType @@ -1918,11 +2109,13 @@ type UserPoolType struct { // A list of the user attributes and their properties in your user pool. The // attribute schema contains standard attributes, custom attributes with a custom: - // prefix, and developer attributes with a dev: prefix. For more information, see - // User pool attributes (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) - // . Developer-only attributes are a legacy feature of user pools, are read-only to + // prefix, and developer attributes with a dev: prefix. For more information, see [User pool attributes]. + // + // Developer-only attributes are a legacy feature of user pools, are read-only to // all app clients. You can create and update developer-only attributes only with // IAM-authenticated API operations. Use app client read/write permissions instead. + // + // [User pool attributes]: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html SchemaAttributes []SchemaAttributeType // The contents of the SMS authentication message. @@ -1936,21 +2129,26 @@ type UserPoolType struct { 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 // 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 + // + // InvalidSmsRoleAccessPolicyException The Identity and Access Management role + // that Amazon Cognito uses to send SMS messages isn't properly configured. For + // more information, see [SmsConfigurationType]. + // + // 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 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) - // . + // To learn how to move your Amazon Web Services account out of the sandbox, see [Moving out of the SMS sandbox]. + // + // [Moving out of the SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox-moving-to-production.html + // [SmsConfigurationType]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SmsConfigurationType.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]. + // + // [VerificationMessageTemplateType]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html SmsVerificationMessage *string // This parameter is no longer used. @@ -1961,16 +2159,19 @@ type UserPoolType struct { // 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) - // . + // address and phone number attributes. For more information, see [Verifying updates to email addresses and phone numbers]. + // + // [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 // User pool add-ons. Contains settings for activation of advanced security // features. To log user security information but take no action, set to AUDIT . To // configure automatic security responses to risky traffic to your user pool, set - // to ENFORCED . For more information, see Adding advanced security to a user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) - // . + // to ENFORCED . + // + // For more information, see [Adding advanced security to a user pool]. + // + // [Adding advanced security to a user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html UserPoolAddOns *UserPoolAddOnsType // The tags that are assigned to the user pool. A tag is a label that you can @@ -1985,8 +2186,9 @@ type UserPoolType struct { // 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 // "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]. + // + // [UsernameConfigurationType]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html UsernameConfiguration *UsernameConfigurationType // The template for verification messages. @@ -2016,12 +2218,18 @@ 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. + // // - 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. @@ -2040,32 +2248,34 @@ type VerificationMessageTemplateType struct { 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) + // can set an EmailMessage template only if the value of [EmailSendingAccount] is DEVELOPER . When your [EmailSendingAccount] // is DEVELOPER , your user pool sends email messages with your own Amazon SES // configuration. + // + // [EmailSendingAccount]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount 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] is DEVELOPER . When + // your [EmailSendingAccount]is DEVELOPER , your user pool sends email messages with your own Amazon SES // configuration. + // + // [EmailSendingAccount]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount 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 - // configuration. + // template only if the value of [EmailSendingAccount]is DEVELOPER . When your [EmailSendingAccount] is DEVELOPER , your user + // pool sends email messages with your own Amazon SES configuration. + // + // [EmailSendingAccount]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount 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 - // configuration. + // to the user. You can set an EmailSubjectByLink template only if the value of [EmailSendingAccount] + // is DEVELOPER . When your [EmailSendingAccount] is DEVELOPER , your user pool sends email messages + // with your own Amazon SES configuration. + // + // [EmailSendingAccount]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount EmailSubjectByLink *string // The template for SMS messages that Amazon Cognito sends to your users. diff --git a/service/cognitosync/api_op_BulkPublish.go b/service/cognitosync/api_op_BulkPublish.go index 85160a8ab35..106d1ded19f 100644 --- a/service/cognitosync/api_op_BulkPublish.go +++ b/service/cognitosync/api_op_BulkPublish.go @@ -13,9 +13,10 @@ import ( // Initiates a bulk publish of all existing datasets for an Identity Pool to the // configured stream. Customers are limited to one successful bulk publish per 24 // hours. Bulk publish is an asynchronous request, customers can see the status of -// the request via the GetBulkPublishDetails operation.This API can only be called -// with developer credentials. You cannot call this API with the temporary user -// credentials provided by Cognito Identity. +// the request via the GetBulkPublishDetails operation. +// +// This API can only be called with developer credentials. You cannot call this +// API with the temporary user credentials provided by Cognito Identity. func (c *Client) BulkPublish(ctx context.Context, params *BulkPublishInput, optFns ...func(*Options)) (*BulkPublishOutput, error) { if params == nil { params = &BulkPublishInput{} diff --git a/service/cognitosync/api_op_DeleteDataset.go b/service/cognitosync/api_op_DeleteDataset.go index 094cf125019..718f825c23e 100644 --- a/service/cognitosync/api_op_DeleteDataset.go +++ b/service/cognitosync/api_op_DeleteDataset.go @@ -14,8 +14,10 @@ import ( // Deletes the specific dataset. The dataset will be deleted permanently, and the // action can't be undone. Datasets that this dataset was merged with will no // longer report the merge. Any subsequent operation on this dataset will result in -// a ResourceNotFoundException. This API can be called with temporary user -// credentials provided by Cognito Identity or with developer credentials. +// a ResourceNotFoundException. +// +// This API can be called with temporary user credentials provided by Cognito +// Identity or with developer credentials. func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { params = &DeleteDatasetInput{} diff --git a/service/cognitosync/api_op_DescribeDataset.go b/service/cognitosync/api_op_DescribeDataset.go index 2de3dab2b22..c90f651a4af 100644 --- a/service/cognitosync/api_op_DescribeDataset.go +++ b/service/cognitosync/api_op_DescribeDataset.go @@ -14,6 +14,7 @@ import ( // 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. diff --git a/service/cognitosync/api_op_DescribeIdentityPoolUsage.go b/service/cognitosync/api_op_DescribeIdentityPoolUsage.go index 723fb42970e..4db8c95a5fb 100644 --- a/service/cognitosync/api_op_DescribeIdentityPoolUsage.go +++ b/service/cognitosync/api_op_DescribeIdentityPoolUsage.go @@ -11,9 +11,11 @@ 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: @@ -21,12 +23,15 @@ import ( // HOST: cognito-sync.us-east-1.amazonaws.com:443 X-AMZ-DATE: 20141111T205737Z // AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, // SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, -// Signature= { "Operation": -// "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsage", "Service": -// "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { +// Signature= +// +// { "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsage", +// "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { // "IdentityPoolId": "IDENTITY_POOL_ID" } } 1.1 200 OK x-amzn-requestid: // 8dc0e749-c8cd-48bd-8520-da6be00d528b content-type: application/json -// content-length: 271 date: Tue, 11 Nov 2014 20:57:37 GMT { "Output": { "__type": +// content-length: 271 date: Tue, 11 Nov 2014 20:57:37 GMT +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsageResponse", // "IdentityPoolUsage": { "DataStorage": 0, "IdentityPoolId": "IDENTITY_POOL_ID", // "LastModifiedDate": 1.413231134115E9, "SyncSessionsCount": null } }, "Version": diff --git a/service/cognitosync/api_op_DescribeIdentityUsage.go b/service/cognitosync/api_op_DescribeIdentityUsage.go index f2b2dde45db..9901e17ae77 100644 --- a/service/cognitosync/api_op_DescribeIdentityUsage.go +++ b/service/cognitosync/api_op_DescribeIdentityUsage.go @@ -12,10 +12,13 @@ import ( ) // Gets usage information for an identity, including number of datasets and data -// usage. This API can be called with temporary user credentials provided by -// Cognito Identity or with developer credentials. DescribeIdentityUsage The -// following examples have been edited for readability. POST / HTTP/1.1 -// CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// usage. +// +// This API can be called with temporary user credentials provided by Cognito +// Identity or with developer credentials. +// +// DescribeIdentityUsage The following examples have been edited for readability. +// POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // 33f9b4e4-a177-4aad-a3bb-6edb7980b283 X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityUsage // HOST: cognito-sync.us-east-1.amazonaws.com:443 X-AMZ-DATE: 20141111T215129Z @@ -26,8 +29,9 @@ import ( // "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { // "IdentityPoolId": "IDENTITY_POOL_ID", "IdentityId": "IDENTITY_ID" } } 1.1 200 OK // x-amzn-requestid: 33f9b4e4-a177-4aad-a3bb-6edb7980b283 content-type: -// application/json content-length: 318 date: Tue, 11 Nov 2014 21:51:29 GMT { -// "Output": { "__type": +// application/json content-length: 318 date: Tue, 11 Nov 2014 21:51:29 GMT +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#DescribeIdentityUsageResponse", // "IdentityUsage": { "DataStorage": 16, "DatasetCount": 1, "IdentityId": // "IDENTITY_ID", "IdentityPoolId": "IDENTITY_POOL_ID", "LastModifiedDate": diff --git a/service/cognitosync/api_op_GetBulkPublishDetails.go b/service/cognitosync/api_op_GetBulkPublishDetails.go index 4e63d4045dc..f24794173bd 100644 --- a/service/cognitosync/api_op_GetBulkPublishDetails.go +++ b/service/cognitosync/api_op_GetBulkPublishDetails.go @@ -12,9 +12,10 @@ import ( "time" ) -// Get the status of the last BulkPublish operation for an 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. +// Get the status of the last BulkPublish operation for an 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. func (c *Client) GetBulkPublishDetails(ctx context.Context, params *GetBulkPublishDetailsInput, optFns ...func(*Options)) (*GetBulkPublishDetailsOutput, error) { if params == nil { params = &GetBulkPublishDetailsInput{} @@ -53,11 +54,17 @@ type GetBulkPublishDetailsOutput struct { // The date/time at which the last bulk publish was initiated. BulkPublishStartTime *time.Time - // Status of the last bulk publish operation, valid values are: NOT_STARTED - No - // bulk publish has been requested for this identity pool IN_PROGRESS - Data is - // being published to the configured stream SUCCEEDED - All data for the identity - // pool has been published to the configured stream FAILED - Some portion of the - // data has failed to publish, check FailureMessage for the cause. + // Status of the last bulk publish operation, valid values are: + // + // NOT_STARTED - No bulk publish has been requested for this identity pool + // + // IN_PROGRESS - Data is being published to the configured stream + // + // SUCCEEDED - All data for the identity pool has been published to the configured + // stream + // + // FAILED - Some portion of the data has failed to publish, check FailureMessage + // for the cause. BulkPublishStatus types.BulkPublishStatus // If BulkPublishStatus is FAILED this field will contain the error message that diff --git a/service/cognitosync/api_op_GetCognitoEvents.go b/service/cognitosync/api_op_GetCognitoEvents.go index 0d649bd91a4..d8346ff20b4 100644 --- a/service/cognitosync/api_op_GetCognitoEvents.go +++ b/service/cognitosync/api_op_GetCognitoEvents.go @@ -11,8 +11,10 @@ import ( ) // Gets the events and the corresponding Lambda functions associated with an -// 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. +// 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. func (c *Client) GetCognitoEvents(ctx context.Context, params *GetCognitoEventsInput, optFns ...func(*Options)) (*GetCognitoEventsOutput, error) { if params == nil { params = &GetCognitoEventsInput{} diff --git a/service/cognitosync/api_op_GetIdentityPoolConfiguration.go b/service/cognitosync/api_op_GetIdentityPoolConfiguration.go index 99193f1d087..eddf4df9603 100644 --- a/service/cognitosync/api_op_GetIdentityPoolConfiguration.go +++ b/service/cognitosync/api_op_GetIdentityPoolConfiguration.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the configuration settings of an 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. GetIdentityPoolConfiguration The -// following examples have been edited for readability. POST / HTTP/1.1 -// CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// Gets the configuration settings of an 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. +// +// GetIdentityPoolConfiguration The following examples have been edited for +// readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // b1cfdd4b-f620-4fe4-be0f-02024a1d33da X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.GetIdentityPoolConfiguration // HOST: cognito-sync.us-east-1.amazonaws.com X-AMZ-DATE: 20141004T195722Z @@ -24,9 +26,12 @@ import ( // Signature= { "Operation": // "com.amazonaws.cognito.sync.model#GetIdentityPoolConfiguration", "Service": // "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { -// "IdentityPoolId": "ID_POOL_ID" } } 1.1 200 OK x-amzn-requestid: -// b1cfdd4b-f620-4fe4-be0f-02024a1d33da date: Sat, 04 Oct 2014 19:57:22 GMT -// content-type: application/json content-length: 332 { "Output": { "__type": +// "IdentityPoolId": "ID_POOL_ID" } } +// +// 1.1 200 OK x-amzn-requestid: b1cfdd4b-f620-4fe4-be0f-02024a1d33da date: Sat, 04 +// Oct 2014 19:57:22 GMT content-type: application/json content-length: 332 +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#GetIdentityPoolConfigurationResponse", // "IdentityPoolId": "ID_POOL_ID", "PushSync": { "ApplicationArns": // ["PLATFORMARN1", "PLATFORMARN2"], "RoleArn": "ROLEARN" } }, "Version": "1.0" } diff --git a/service/cognitosync/api_op_ListDatasets.go b/service/cognitosync/api_op_ListDatasets.go index cf0691461ed..50ac5b6a27e 100644 --- a/service/cognitosync/api_op_ListDatasets.go +++ b/service/cognitosync/api_op_ListDatasets.go @@ -13,11 +13,14 @@ import ( // Lists datasets for an identity. 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. ListDatasets can be called with -// temporary user credentials provided by Cognito Identity or with developer -// credentials. You should use the Cognito Identity credentials to make this API -// call. ListDatasets The following examples have been edited for readability. POST -// / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// need to have access to the identity data. +// +// ListDatasets can be called with temporary user credentials provided by Cognito +// Identity or with developer credentials. You should use the Cognito Identity +// credentials to make this API call. +// +// ListDatasets The following examples have been edited for readability. POST / +// HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // 15225768-209f-4078-aaed-7494ace9f2db X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListDatasets HOST: // cognito-sync.us-east-1.amazonaws.com:443 X-AMZ-DATE: 20141111T215640Z @@ -28,7 +31,9 @@ import ( // "IdentityPoolId": "IDENTITY_POOL_ID", "IdentityId": "IDENTITY_ID", "MaxResults": // "3" } } 1.1 200 OK x-amzn-requestid: 15225768-209f-4078-aaed-7494ace9f2db, // 15225768-209f-4078-aaed-7494ace9f2db content-type: application/json -// content-length: 355 date: Tue, 11 Nov 2014 21:56:40 GMT { "Output": { "__type": +// content-length: 355 date: Tue, 11 Nov 2014 21:56:40 GMT +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#ListDatasetsResponse", "Count": 1, "Datasets": // [ { "CreationDate": 1.412974057151E9, "DataStorage": 16, "DatasetName": // "my_list", "IdentityId": "IDENTITY_ID", "LastModifiedBy": "123456789012", diff --git a/service/cognitosync/api_op_ListIdentityPoolUsage.go b/service/cognitosync/api_op_ListIdentityPoolUsage.go index eb122e25da5..263ffc6dee1 100644 --- a/service/cognitosync/api_op_ListIdentityPoolUsage.go +++ b/service/cognitosync/api_op_ListIdentityPoolUsage.go @@ -11,9 +11,12 @@ 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: @@ -26,7 +29,9 @@ import ( // "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { // "MaxResults": "2" } } 1.1 200 OK x-amzn-requestid: // 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 content-type: application/json -// content-length: 519 date: Tue, 11 Nov 2014 21:14:14 GMT { "Output": { "__type": +// content-length: 519 date: Tue, 11 Nov 2014 21:14:14 GMT +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#ListIdentityPoolUsageResponse", "Count": 2, // "IdentityPoolUsages": [ { "DataStorage": 0, "IdentityPoolId": // "IDENTITY_POOL_ID", "LastModifiedDate": 1.413836234607E9, "SyncSessionsCount": diff --git a/service/cognitosync/api_op_ListRecords.go b/service/cognitosync/api_op_ListRecords.go index 72a3e9581d0..fd6ff644d28 100644 --- a/service/cognitosync/api_op_ListRecords.go +++ b/service/cognitosync/api_op_ListRecords.go @@ -14,11 +14,14 @@ import ( // Gets paginated records, optionally changed after a particular sync count for a // dataset and identity. 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. ListRecords 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. ListRecords The -// following examples have been edited for readability. POST / HTTP/1.1 -// CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// access to the identity data. +// +// ListRecords 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. +// +// ListRecords The following examples have been edited for readability. POST / +// HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // b3d2e31e-d6b7-4612-8e84-c9ba288dab5d X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListRecords HOST: // cognito-sync.us-east-1.amazonaws.com:443 X-AMZ-DATE: 20141111T183230Z @@ -29,12 +32,13 @@ import ( // "IdentityPoolId": "IDENTITY_POOL_ID", "IdentityId": "IDENTITY_ID", // "DatasetName": "newDataSet" } } 1.1 200 OK x-amzn-requestid: // b3d2e31e-d6b7-4612-8e84-c9ba288dab5d content-type: application/json -// content-length: 623 date: Tue, 11 Nov 2014 18:32:30 GMT { "Output": { "__type": -// "com.amazonaws.cognito.sync.model#ListRecordsResponse", "Count": 0, -// "DatasetDeletedAfterRequestedSyncCount": false, "DatasetExists": false, -// "DatasetSyncCount": 0, "LastModifiedBy": null, "MergedDatasetNames": null, -// "NextToken": null, "Records": [], "SyncSessionToken": "SYNC_SESSION_TOKEN" }, -// "Version": "1.0" } +// content-length: 623 date: Tue, 11 Nov 2014 18:32:30 GMT +// +// { "Output": { "__type": "com.amazonaws.cognito.sync.model#ListRecordsResponse", +// "Count": 0, "DatasetDeletedAfterRequestedSyncCount": false, "DatasetExists": +// false, "DatasetSyncCount": 0, "LastModifiedBy": null, "MergedDatasetNames": +// null, "NextToken": null, "Records": [], "SyncSessionToken": "SYNC_SESSION_TOKEN" +// }, "Version": "1.0" } func (c *Client) ListRecords(ctx context.Context, params *ListRecordsInput, optFns ...func(*Options)) (*ListRecordsOutput, error) { if params == nil { params = &ListRecordsInput{} diff --git a/service/cognitosync/api_op_RegisterDevice.go b/service/cognitosync/api_op_RegisterDevice.go index 4881eea0dd5..5bc73bf3e48 100644 --- a/service/cognitosync/api_op_RegisterDevice.go +++ b/service/cognitosync/api_op_RegisterDevice.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a device to receive push sync notifications.This API can only be -// called with temporary credentials provided by Cognito Identity. You cannot call -// this API with developer credentials. RegisterDevice The following examples have -// been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json -// X-AMZN-REQUESTID: 368f9200-3eca-449e-93b3-7b9c08d8e185 X-AMZ-TARGET: +// Registers a device to receive push sync notifications. +// +// This API can only be called with temporary credentials provided by Cognito +// Identity. You cannot call this API with developer credentials. +// +// RegisterDevice The following examples have been edited for readability. POST / +// HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// 368f9200-3eca-449e-93b3-7b9c08d8e185 X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.RegisterDevice HOST: // cognito-sync.us-east-1.amazonaws.com X-AMZ-DATE: 20141004T194643Z // X-AMZ-SECURITY-TOKEN: AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, @@ -25,7 +28,9 @@ import ( // "IdentityPoolId": "ID_POOL_ID", "IdentityId": "IDENTITY_ID", "Platform": "GCM", // "Token": "PUSH_TOKEN" } } 1.1 200 OK x-amzn-requestid: // 368f9200-3eca-449e-93b3-7b9c08d8e185 date: Sat, 04 Oct 2014 19:46:44 GMT -// content-type: application/json content-length: 145 { "Output": { "__type": +// content-type: application/json content-length: 145 +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#RegisterDeviceResponse", "DeviceId": // "5cd28fbe-dd83-47ab-9f83-19093a5fb014" }, "Version": "1.0" } func (c *Client) RegisterDevice(ctx context.Context, params *RegisterDeviceInput, optFns ...func(*Options)) (*RegisterDeviceOutput, error) { diff --git a/service/cognitosync/api_op_SetCognitoEvents.go b/service/cognitosync/api_op_SetCognitoEvents.go index 18f3ab983ba..ad84016723c 100644 --- a/service/cognitosync/api_op_SetCognitoEvents.go +++ b/service/cognitosync/api_op_SetCognitoEvents.go @@ -13,7 +13,9 @@ import ( // Sets the AWS Lambda function for a given event type for an identity pool. This // request only updates the key/value pair specified. Other key/values pairs are // not updated. To remove a key value pair, pass a empty value for the particular -// key.This API can only be called with developer credentials. You cannot call this +// key. +// +// This API can only be called with developer credentials. You cannot call this // API with the temporary user credentials provided by Cognito Identity. func (c *Client) SetCognitoEvents(ctx context.Context, params *SetCognitoEventsInput, optFns ...func(*Options)) (*SetCognitoEventsOutput, error) { if params == nil { @@ -30,7 +32,9 @@ func (c *Client) SetCognitoEvents(ctx context.Context, params *SetCognitoEventsI return out, nil } -// A request to configure Cognito Events"" +// A request to configure Cognito Events" +// +// " type SetCognitoEventsInput struct { // The events to configure diff --git a/service/cognitosync/api_op_SetIdentityPoolConfiguration.go b/service/cognitosync/api_op_SetIdentityPoolConfiguration.go index 1ed82539a3f..c3510764ed4 100644 --- a/service/cognitosync/api_op_SetIdentityPoolConfiguration.go +++ b/service/cognitosync/api_op_SetIdentityPoolConfiguration.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the necessary configuration for push sync.This API can only be called with -// developer credentials. You cannot call this API with the temporary user -// credentials provided by Cognito Identity. SetIdentityPoolConfiguration The -// following examples have been edited for readability. POST / HTTP/1.1 -// CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// Sets the necessary configuration for push sync. +// +// This API can only be called with developer credentials. You cannot call this +// API with the temporary user credentials provided by Cognito Identity. +// +// SetIdentityPoolConfiguration The following examples have been edited for +// readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // a46db021-f5dd-45d6-af5b-7069fa4a211b X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SetIdentityPoolConfiguration // HOST: cognito-sync.us-east-1.amazonaws.com X-AMZ-DATE: 20141004T200006Z @@ -27,8 +29,9 @@ import ( // "IdentityPoolId": "ID_POOL_ID", "PushSync": { "ApplicationArns": // ["PLATFORMARN1", "PLATFORMARN2"], "RoleArn": "ROLEARN" } } } 1.1 200 OK // x-amzn-requestid: a46db021-f5dd-45d6-af5b-7069fa4a211b date: Sat, 04 Oct 2014 -// 20:00:06 GMT content-type: application/json content-length: 332 { "Output": { -// "__type": +// 20:00:06 GMT content-type: application/json content-length: 332 +// +// { "Output": { "__type": // "com.amazonaws.cognito.sync.model#SetIdentityPoolConfigurationResponse", // "IdentityPoolId": "ID_POOL_ID", "PushSync": { "ApplicationArns": // ["PLATFORMARN1", "PLATFORMARN2"], "RoleArn": "ROLEARN" } }, "Version": "1.0" } diff --git a/service/cognitosync/api_op_SubscribeToDataset.go b/service/cognitosync/api_op_SubscribeToDataset.go index 7865c3dc50d..3dcfc5031c1 100644 --- a/service/cognitosync/api_op_SubscribeToDataset.go +++ b/service/cognitosync/api_op_SubscribeToDataset.go @@ -11,23 +11,29 @@ import ( ) // Subscribes to receive notifications when a dataset is modified by another -// device.This API can only be called with temporary credentials provided by -// Cognito Identity. You cannot call this API with developer credentials. -// SubscribeToDataset The following examples have been edited for readability. POST -// / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: +// device. +// +// This API can only be called with temporary credentials provided by Cognito +// Identity. You cannot call this API with developer credentials. +// +// SubscribeToDataset The following examples have been edited for readability. +// POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: // 8b9932b7-201d-4418-a960-0a470e11de9f X-AMZ-TARGET: // com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SubscribeToDataset HOST: // cognito-sync.us-east-1.amazonaws.com X-AMZ-DATE: 20141004T195350Z // X-AMZ-SECURITY-TOKEN: AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, // SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, -// Signature= { "Operation": "com.amazonaws.cognito.sync.model#SubscribeToDataset", -// "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { +// Signature= { "Operation": +// "com.amazonaws.cognito.sync.model#SubscribeToDataset", "Service": +// "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { // "IdentityPoolId": "ID_POOL_ID", "IdentityId": "IDENTITY_ID", "DatasetName": // "Rufus", "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014" } } 1.1 200 OK // x-amzn-requestid: 8b9932b7-201d-4418-a960-0a470e11de9f date: Sat, 04 Oct 2014 -// 19:53:50 GMT content-type: application/json content-length: 99 { "Output": { -// "__type": "com.amazonaws.cognito.sync.model#SubscribeToDatasetResponse" }, -// "Version": "1.0" } +// 19:53:50 GMT content-type: application/json content-length: 99 +// +// { "Output": { "__type": +// "com.amazonaws.cognito.sync.model#SubscribeToDatasetResponse" }, "Version": +// "1.0" } func (c *Client) SubscribeToDataset(ctx context.Context, params *SubscribeToDatasetInput, optFns ...func(*Options)) (*SubscribeToDatasetOutput, error) { if params == nil { params = &SubscribeToDatasetInput{} diff --git a/service/cognitosync/api_op_UnsubscribeFromDataset.go b/service/cognitosync/api_op_UnsubscribeFromDataset.go index f67b2f7db5d..f7876ddcce5 100644 --- a/service/cognitosync/api_op_UnsubscribeFromDataset.go +++ b/service/cognitosync/api_op_UnsubscribeFromDataset.go @@ -11,8 +11,11 @@ import ( ) // Unsubscribes from receiving notifications when a dataset is modified by another -// device.This API can only be called with temporary credentials provided by -// Cognito Identity. You cannot call this API with developer credentials. +// device. +// +// This API can only be called with temporary credentials provided by Cognito +// Identity. You cannot call this API with developer credentials. +// // UnsubscribeFromDataset The following examples have been edited for readability. // POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZ-REQUESTSUPERTRACE: true // X-AMZN-REQUESTID: 676896d6-14ca-45b1-8029-6d36b10a077e X-AMZ-TARGET: @@ -26,9 +29,11 @@ import ( // "IdentityPoolId": "ID_POOL_ID", "IdentityId": "IDENTITY_ID", "DatasetName": // "Rufus", "DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014" } } 1.1 200 OK // x-amzn-requestid: 676896d6-14ca-45b1-8029-6d36b10a077e date: Sat, 04 Oct 2014 -// 19:54:46 GMT content-type: application/json content-length: 103 { "Output": { -// "__type": "com.amazonaws.cognito.sync.model#UnsubscribeFromDatasetResponse" }, -// "Version": "1.0" } +// 19:54:46 GMT content-type: application/json content-length: 103 +// +// { "Output": { "__type": +// "com.amazonaws.cognito.sync.model#UnsubscribeFromDatasetResponse" }, "Version": +// "1.0" } func (c *Client) UnsubscribeFromDataset(ctx context.Context, params *UnsubscribeFromDatasetInput, optFns ...func(*Options)) (*UnsubscribeFromDatasetOutput, error) { if params == nil { params = &UnsubscribeFromDatasetInput{} diff --git a/service/cognitosync/api_op_UpdateRecords.go b/service/cognitosync/api_op_UpdateRecords.go index ff60e9193c2..d54d21d9287 100644 --- a/service/cognitosync/api_op_UpdateRecords.go +++ b/service/cognitosync/api_op_UpdateRecords.go @@ -12,17 +12,21 @@ import ( ) // Posts updates to records and adds and deletes records for a dataset and user. +// // The sync count in the record patch is your last known sync count for that // record. The server will reject an UpdateRecords request with a // ResourceConflictException if you try to patch a record with a new value but a -// stale sync count.For example, if the sync count on the server is 5 for a key -// called highScore and you try and submit a new highScore with sync count of 4, -// the request will be rejected. To obtain the current sync count for a record, -// call ListRecords. On a successful update of the record, the response returns the -// new sync count for that record. You should present that sync count the next time -// you try to update that same record. When the record does not exist, specify the -// sync count as 0. This API can be called with temporary user credentials provided -// by Cognito Identity or with developer credentials. +// stale sync count. +// +// For example, if the sync count on the server is 5 for a key called highScore +// and you try and submit a new highScore with sync count of 4, the request will be +// rejected. To obtain the current sync count for a record, call ListRecords. On a +// successful update of the record, the response returns the new sync count for +// that record. You should present that sync count the next time you try to update +// that same record. When the record does not exist, specify the sync count as 0. +// +// This API can be called with temporary user credentials provided by Cognito +// Identity or with developer credentials. func (c *Client) UpdateRecords(ctx context.Context, params *UpdateRecordsInput, optFns ...func(*Options)) (*UpdateRecordsOutput, error) { if params == nil { params = &UpdateRecordsInput{} diff --git a/service/cognitosync/doc.go b/service/cognitosync/doc.go index 604029e38ac..0cb42b4e639 100644 --- a/service/cognitosync/doc.go +++ b/service/cognitosync/doc.go @@ -3,21 +3,26 @@ // 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. -// High-level client libraries are available for both iOS and Android. You can use -// these libraries to persist data locally so that it's available even if the -// device is offline. Developer credentials don't need to be stored on the mobile -// device to access the service. You can use Amazon Cognito to obtain a normalized -// user ID and credentials. User data is persisted in a dataset that can store up -// to 1 MB of key-value pairs, and you can have up to 20 datasets per user -// 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 -// 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) -// . +// # Amazon Cognito Sync +// +// Amazon Cognito Sync provides an AWS service and client library that enable +// cross-device syncing of application-related user data. High-level client +// libraries are available for both iOS and Android. You can use these libraries to +// persist data locally so that it's available even if the device is offline. +// Developer credentials don't need to be stored on the mobile device to access the +// service. You can use Amazon Cognito to obtain a normalized user ID and +// credentials. User data is persisted in a dataset that can store up to 1 MB of +// key-value pairs, and you can have up to 20 datasets per user 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]. +// +// 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] +// and the [Developer Guide for iOS]. +// +// [Developer Guide for iOS]: http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html +// [Amazon Cognito Identity service]: http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html +// [Developer Guide for Android]: http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html package cognitosync diff --git a/service/cognitosync/options.go b/service/cognitosync/options.go index f8e75f64a9c..d09f1fdf198 100644 --- a/service/cognitosync/options.go +++ b/service/cognitosync/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/cognitosync/types/enums.go b/service/cognitosync/types/enums.go index 00cd12a2878..054473f9b66 100644 --- a/service/cognitosync/types/enums.go +++ b/service/cognitosync/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for BulkPublishStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BulkPublishStatus) Values() []BulkPublishStatus { return []BulkPublishStatus{ "NOT_STARTED", @@ -33,8 +34,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for Platform. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Platform) Values() []Platform { return []Platform{ "APNS", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for StreamingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingStatus) Values() []StreamingStatus { return []StreamingStatus{ "ENABLED", diff --git a/service/cognitosync/types/types.go b/service/cognitosync/types/types.go index 1a5675af84a..f1dde29d78c 100644 --- a/service/cognitosync/types/types.go +++ b/service/cognitosync/types/types.go @@ -19,9 +19,12 @@ type CognitoStreams struct { // developers account and in the same region as the identity pool. StreamName *string - // Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates - // to identity pool is enabled. DISABLED - Streaming of updates to identity pool is - // disabled. Bulk publish will also fail if StreamingStatus is DISABLED. + // Status of the Cognito streams. Valid values are: + // + // ENABLED - Streaming of updates to identity pool is enabled. + // + // DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will + // also fail if StreamingStatus is DISABLED. StreamingStatus StreamingStatus noSmithyDocumentSerde diff --git a/service/comprehend/api_op_BatchDetectDominantLanguage.go b/service/comprehend/api_op_BatchDetectDominantLanguage.go index 1ccc008e998..f14e25aa49b 100644 --- a/service/comprehend/api_op_BatchDetectDominantLanguage.go +++ b/service/comprehend/api_op_BatchDetectDominantLanguage.go @@ -12,9 +12,9 @@ import ( ) // 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) -// . +// For a list of languages that Amazon Comprehend can detect, see [Amazon Comprehend Supported Languages]. +// +// [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 84c87798386..62918b3d5a2 100644 --- a/service/comprehend/api_op_BatchDetectEntities.go +++ b/service/comprehend/api_op_BatchDetectEntities.go @@ -12,8 +12,10 @@ 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]in the +// Comprehend Developer Guide. +// +// [Entities]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html 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_BatchDetectSyntax.go b/service/comprehend/api_op_BatchDetectSyntax.go index c3beb2a9e85..2483ab4da06 100644 --- a/service/comprehend/api_op_BatchDetectSyntax.go +++ b/service/comprehend/api_op_BatchDetectSyntax.go @@ -13,8 +13,9 @@ 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]in the Comprehend Developer Guide. +// +// [Syntax]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html 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 329042f4a3d..9e176fa2105 100644 --- a/service/comprehend/api_op_BatchDetectTargetedSentiment.go +++ b/service/comprehend/api_op_BatchDetectTargetedSentiment.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Comprehend Developer Guide. +// identified in the documents. +// +// For more information about targeted sentiment, see [Targeted sentiment] in the Amazon Comprehend +// Developer Guide. +// +// [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 5fdd9b02dba..13de7486826 100644 --- a/service/comprehend/api_op_ClassifyDocument.go +++ b/service/comprehend/api_op_ClassifyDocument.go @@ -13,23 +13,28 @@ import ( // Creates a classification request to analyze a single document in real-time. // ClassifyDocument supports the following model types: +// // - Custom classifier - a custom model that you have created and trained. For // input, you can provide plain text, a single-page document (PDF, Word, or image), -// or Amazon Textract API output. For more information, see Custom classification (https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) -// in the Amazon Comprehend Developer Guide. +// or Amazon Textract API output. For more information, see [Custom classification]in the Amazon +// Comprehend Developer Guide. +// // - Prompt safety classifier - Amazon Comprehend provides a pre-trained model // for classifying input prompts for generative AI applications. For input, you // provide English plain text input. For prompt safety classification, the response // includes only the Classes field. For more information about prompt safety -// classifiers, see Prompt safety classification (https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification) -// in the Amazon Comprehend Developer Guide. +// classifiers, see [Prompt safety classification]in the Amazon Comprehend Developer Guide. // // If the system detects errors while processing a page in the input document, the -// API response includes an Errors field 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. +// API response includes an Errors field 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]in the Comprehend Developer Guide. +// +// [Custom classification]: https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html +// [Prompt safety classification]: https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification +// [Errors in semi-structured documents]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html func (c *Client) ClassifyDocument(ctx context.Context, params *ClassifyDocumentInput, optFns ...func(*Options)) (*ClassifyDocumentOutput, error) { if params == nil { params = &ClassifyDocumentInput{} @@ -47,28 +52,40 @@ func (c *Client) ClassifyDocument(ctx context.Context, params *ClassifyDocumentI type ClassifyDocumentInput struct { - // The Amazon Resource Number (ARN) of the endpoint. For prompt safety - // classification, Amazon Comprehend provides the endpoint ARN. For more - // information about prompt safety classifiers, see Prompt safety classification (https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification) - // in the Amazon Comprehend Developer Guide For custom classification, you create - // an endpoint for your custom model. For more information, see Using Amazon - // Comprehend endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html) - // . + // The Amazon Resource Number (ARN) of the endpoint. + // + // For prompt safety classification, Amazon Comprehend provides the endpoint ARN. + // For more information about prompt safety classifiers, see [Prompt safety classification]in the Amazon + // Comprehend Developer Guide + // + // For custom classification, you create an endpoint for your custom model. For + // more information, see [Using Amazon Comprehend endpoints]. + // + // [Prompt safety classification]: https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification + // [Using Amazon Comprehend endpoints]: https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html // // This member is required. EndpointArn *string - // Use the Bytes parameter to input a text, PDF, Word or image file. When you - // classify a document using a custom model, you can also use the Bytes parameter - // to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file. + // Use the Bytes parameter to input a text, PDF, Word or image file. + // + // When you classify a document using a custom model, you can also use the Bytes + // parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument + // output file. + // // To classify a document using the prompt safety classifier, use the Text - // parameter for input. Provide the input document as a sequence of 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. + // parameter for input. + // + // Provide the input document as a sequence of 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]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 Bytes []byte // Provides configuration parameters to override the default actions for @@ -87,10 +104,12 @@ type ClassifyDocumentOutput struct { // The classes used by the document being analyzed. These are used for models // trained in multi-class mode. Individual classes are mutually exclusive and each // document is expected to have only a single class assigned to it. For example, an - // animal can be a dog or a cat, but not both at the same time. For prompt safety - // classification, the response includes only two classes (SAFE_PROMPT and - // UNSAFE_PROMPT), along with a confidence score for each class. The value range of - // the score is zero to one, where one is the highest confidence. + // animal can be a dog or a cat, but not both at the same time. + // + // For prompt safety classification, the response includes only two classes + // (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. + // The value range of the score is zero to one, where one is the highest + // confidence. Classes []types.DocumentClass // Extraction information about the document. This field is present in the @@ -115,8 +134,9 @@ type ClassifyDocumentOutput struct { // Warnings detected while processing the input document. The response includes a // warning if there is a mismatch between the input document type and the model // type associated with the endpoint that you specified. The response can also - // include warnings for individual pages that have a mismatch. The field is empty - // if the system generated no warnings. + // include warnings for individual pages that have a mismatch. + // + // The field is empty if the system generated no warnings. Warnings []types.WarningsListItem // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_CreateDataset.go b/service/comprehend/api_op_CreateDataset.go index c4f0e4665ff..63667f2c3d0 100644 --- a/service/comprehend/api_op_CreateDataset.go +++ b/service/comprehend/api_op_CreateDataset.go @@ -12,8 +12,10 @@ 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]in the Amazon Comprehend +// Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} diff --git a/service/comprehend/api_op_CreateDocumentClassifier.go b/service/comprehend/api_op_CreateDocumentClassifier.go index c04fbef772c..1cd6fcea994 100644 --- a/service/comprehend/api_op_CreateDocumentClassifier.go +++ b/service/comprehend/api_op_CreateDocumentClassifier.go @@ -13,9 +13,10 @@ import ( // Creates a new document classifier that you can use to categorize documents. To // create a classifier, you provide a set of training documents that are labeled -// with the categories that you want to use. For more information, see Training -// classifier models (https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html) -// in the Comprehend Developer Guide. +// with the categories that you want to use. For more information, see [Training classifier models]in the +// Comprehend Developer Guide. +// +// [Training classifier models]: https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html func (c *Client) CreateDocumentClassifier(ctx context.Context, params *CreateDocumentClassifierInput, optFns ...func(*Options)) (*CreateDocumentClassifierOutput, error) { if params == nil { params = &CreateDocumentClassifierInput{} @@ -69,21 +70,28 @@ type CreateDocumentClassifierInput 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" ModelKmsKeyId *string // The resource-based policy to attach to your custom document classifier model. // You can use this policy to allow another Amazon Web Services account to import - // your custom model. Provide your policy as a JSON body that you enter as a UTF-8 - // encoded string without line breaks. To provide valid JSON, 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"]}' + // your custom model. + // + // Provide your policy as a JSON body that you enter as a UTF-8 encoded string + // without line breaks. To provide valid JSON, 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"]}' ModelPolicy *string // Specifies the location for the output files from a custom classifier job. This @@ -107,15 +115,18 @@ type CreateDocumentClassifierInput 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" 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]. + // + // [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 b5bfa13b257..2c4dca9e0eb 100644 --- a/service/comprehend/api_op_CreateEndpoint.go +++ b/service/comprehend/api_op_CreateEndpoint.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -31,9 +32,10 @@ func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput type CreateEndpointInput struct { - // The desired number of inference units to be used by the model using this - // endpoint. Each inference unit represents of a throughput of 100 characters per - // second. + // The desired number of inference units to be used by the model using this + // endpoint. + // + // Each inference unit represents of a throughput of 100 characters per second. // // This member is required. DesiredInferenceUnits *int32 diff --git a/service/comprehend/api_op_CreateEntityRecognizer.go b/service/comprehend/api_op_CreateEntityRecognizer.go index 16736684fb3..5a7a2a13d9d 100644 --- a/service/comprehend/api_op_CreateEntityRecognizer.go +++ b/service/comprehend/api_op_CreateEntityRecognizer.go @@ -44,10 +44,10 @@ type CreateEntityRecognizerInput struct { // This member is required. InputDataConfig *types.EntityRecognizerInputDataConfig - // You can specify any of the following languages: English ("en"), Spanish ("es"), - // French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan - // to use this entity recognizer with PDF, Word, or image input files, you must - // specify English as the language. All training documents must be in the same + // You can specify any of the following languages: English ("en"), Spanish + // ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If + // you plan to use this entity recognizer with PDF, Word, or image input files, you + // must specify English as the language. All training documents must be in the same // language. // // This member is required. @@ -60,27 +60,34 @@ type CreateEntityRecognizerInput struct { // This member is required. RecognizerName *string - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend generates one. + // A unique identifier for the request. If you don't set the client request + // token, 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" 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, - // 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"]}' + // 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 enclose the JSON names and values: + // + // '{"attribute": "value", "attribute": ["value"]}' ModelPolicy *string // Tags to associate with the entity recognizer. A tag is a key-value pair that @@ -99,15 +106,18 @@ 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" 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]. + // + // [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 a44ca1098f9..690544a9dd9 100644 --- a/service/comprehend/api_op_CreateFlywheel.go +++ b/service/comprehend/api_op_CreateFlywheel.go @@ -14,15 +14,23 @@ import ( // A flywheel is an Amazon Web Services resource that orchestrates the ongoing // training of a model for custom classification or custom entity recognition. You // can create a flywheel to start with an existing trained model, or Comprehend can -// create and train a new model. When you create the flywheel, Comprehend creates a -// data lake in your account. The data lake holds the training data and test data -// for all versions of the model. To use a flywheel with an existing trained model, -// you specify the active model version. Comprehend copies the model's training -// 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. +// create and train a new model. +// +// When you create the flywheel, Comprehend creates a data lake in your account. +// The data lake holds the training data and test data for all versions of the +// model. +// +// To use a flywheel with an existing trained model, you specify the active model +// version. Comprehend copies the model's training 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] in the Amazon Comprehend Developer +// Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html func (c *Client) CreateFlywheel(ctx context.Context, params *CreateFlywheelInput, optFns ...func(*Options)) (*CreateFlywheelOutput, error) { if params == nil { params = &CreateFlywheelInput{} diff --git a/service/comprehend/api_op_DeleteDocumentClassifier.go b/service/comprehend/api_op_DeleteDocumentClassifier.go index 9fe0970ec09..61768a1e0dd 100644 --- a/service/comprehend/api_op_DeleteDocumentClassifier.go +++ b/service/comprehend/api_op_DeleteDocumentClassifier.go @@ -10,9 +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. +// 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. diff --git a/service/comprehend/api_op_DeleteEndpoint.go b/service/comprehend/api_op_DeleteEndpoint.go index 768bc1b87cb..186829a78c1 100644 --- a/service/comprehend/api_op_DeleteEndpoint.go +++ b/service/comprehend/api_op_DeleteEndpoint.go @@ -12,8 +12,9 @@ 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]. +// +// [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_DeleteEntityRecognizer.go b/service/comprehend/api_op_DeleteEntityRecognizer.go index 8a8676b40e2..8db06e1b89b 100644 --- a/service/comprehend/api_op_DeleteEntityRecognizer.go +++ b/service/comprehend/api_op_DeleteEntityRecognizer.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an entity recognizer. Only those recognizers 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 recognizer into a DELETING state, and it is then removed by -// a background job. Once removed, the recognizer disappears from your account and -// is no longer available for use. +// Deletes an entity recognizer. +// +// Only those recognizers 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 recognizer into a DELETING state, +// and it is then removed by a background job. Once removed, the recognizer +// disappears from your account and is no longer available for use. func (c *Client) DeleteEntityRecognizer(ctx context.Context, params *DeleteEntityRecognizerInput, optFns ...func(*Options)) (*DeleteEntityRecognizerOutput, error) { if params == nil { params = &DeleteEntityRecognizerInput{} diff --git a/service/comprehend/api_op_DeleteFlywheel.go b/service/comprehend/api_op_DeleteFlywheel.go index f32fd16aa2f..6ad84198f2f 100644 --- a/service/comprehend/api_op_DeleteFlywheel.go +++ b/service/comprehend/api_op_DeleteFlywheel.go @@ -11,9 +11,12 @@ 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. +// delete the data lake or the model associated with the flywheel. +// +// For more information about flywheels, see [Flywheel overview] in the Amazon Comprehend Developer +// Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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 acc0544d516..a5d43df6a13 100644 --- a/service/comprehend/api_op_DescribeDataset.go +++ b/service/comprehend/api_op_DescribeDataset.go @@ -12,8 +12,9 @@ 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]in the Amazon Comprehend Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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_DescribeEndpoint.go b/service/comprehend/api_op_DescribeEndpoint.go index 350a27b8652..e23b579390d 100644 --- a/service/comprehend/api_op_DescribeEndpoint.go +++ b/service/comprehend/api_op_DescribeEndpoint.go @@ -12,9 +12,9 @@ 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) -// . +// get the status of an endpoint. For information about endpoints, see [Managing endpoints]. +// +// [Managing 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 5a79e9dbd8a..423f89bea92 100644 --- a/service/comprehend/api_op_DescribeFlywheel.go +++ b/service/comprehend/api_op_DescribeFlywheel.go @@ -12,8 +12,9 @@ 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]in the Amazon Comprehend Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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 bd298ead170..f2068a7c55d 100644 --- a/service/comprehend/api_op_DescribeFlywheelIteration.go +++ b/service/comprehend/api_op_DescribeFlywheelIteration.go @@ -12,8 +12,9 @@ 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]in the Amazon Comprehend Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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_DetectDominantLanguage.go b/service/comprehend/api_op_DetectDominantLanguage.go index af3a22db72d..7eeb1712015 100644 --- a/service/comprehend/api_op_DetectDominantLanguage.go +++ b/service/comprehend/api_op_DetectDominantLanguage.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// that Amazon Comprehend can detect, see [Amazon Comprehend Supported Languages]. +// +// [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{} @@ -44,11 +45,13 @@ type DetectDominantLanguageOutput struct { // Array of languages that Amazon Comprehend detected in the input text. The array // is sorted in descending order of the score (the dominant language is always the - // first element in the array). For each language, the response returns the RFC - // 5646 language code and the level of confidence that Amazon Comprehend has in the - // accuracy of its inference. For more information about RFC 5646, see Tags for - // Identifying Languages (https://tools.ietf.org/html/rfc5646) on the IETF Tools - // web site. + // first element in the array). + // + // For each language, the response returns the RFC 5646 language code and the + // level of confidence that Amazon Comprehend has in the accuracy of its inference. + // For more information about RFC 5646, see [Tags for Identifying Languages]on the IETF Tools web site. + // + // [Tags for Identifying Languages]: https://tools.ietf.org/html/rfc5646 Languages []types.DominantLanguage // Metadata pertaining to the operation's result. diff --git a/service/comprehend/api_op_DetectEntities.go b/service/comprehend/api_op_DetectEntities.go index f98176bc392..32c56d1b838 100644 --- a/service/comprehend/api_op_DetectEntities.go +++ b/service/comprehend/api_op_DetectEntities.go @@ -12,17 +12,24 @@ import ( ) // 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 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]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]in the Comprehend Developer Guide. +// +// [Errors in semi-structured documents]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html +// [Entities]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput, optFns ...func(*Options)) (*DetectEntitiesOutput, error) { if params == nil { params = &DetectEntitiesInput{} @@ -42,17 +49,25 @@ 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) - // in the Comprehend Developer Guide. If you use the Bytes parameter, do not use - // the Text parameter. + // 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]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 Bytes []byte // Provides configuration parameters to override the default actions for @@ -62,17 +77,22 @@ type DetectEntitiesInput struct { // The Amazon Resource Name of an endpoint that is associated with a custom entity // recognition model. Provide an endpoint if you want to detect entities by using // 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) - // . + // 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]. + // + // [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 // languages supported by Amazon Comprehend. If your request includes the endpoint // for a custom entity recognition model, Amazon Comprehend uses the language of - // your custom model, and it ignores any language code that you specify here. All - // input documents must be in the same language. + // your custom model, and it ignores any language code that you specify here. + // + // All input documents must be in the same language. LanguageCode types.LanguageCode // A UTF-8 text string. The maximum string size is 100 KB. If you enter text using @@ -86,9 +106,11 @@ 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 - // 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. + // 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 @@ -102,11 +124,13 @@ type DetectEntitiesOutput struct { // A collection of entities identified in the input text. For each entity, the // response provides the entity text, entity type, where the entity text begins and // ends, and the level of confidence that Amazon Comprehend has in the detection. + // // If your request uses a custom entity recognition model, Amazon Comprehend // detects the entities that the model is trained to recognize. Otherwise, it - // detects the default entity types. For a list of default entity types, see - // Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in + // detects the default entity types. For a list of default entity types, see [Entities]in // the Comprehend Developer Guide. + // + // [Entities]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html Entities []types.Entity // Page-level errors that the system detected while processing the input document. diff --git a/service/comprehend/api_op_DetectSyntax.go b/service/comprehend/api_op_DetectSyntax.go index 4ae7105464c..314afe9ddb1 100644 --- a/service/comprehend/api_op_DetectSyntax.go +++ b/service/comprehend/api_op_DetectSyntax.go @@ -12,8 +12,9 @@ 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]in the Comprehend Developer Guide. +// +// [Syntax]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html func (c *Client) DetectSyntax(ctx context.Context, params *DetectSyntaxInput, optFns ...func(*Options)) (*DetectSyntaxOutput, error) { if params == nil { params = &DetectSyntaxInput{} @@ -51,8 +52,9 @@ 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]in the Comprehend Developer Guide. + // + // [Syntax]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html 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 a85de367128..8e6796e356a 100644 --- a/service/comprehend/api_op_DetectTargetedSentiment.go +++ b/service/comprehend/api_op_DetectTargetedSentiment.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Comprehend Developer Guide. +// identified in the text. +// +// For more information about targeted sentiment, see [Targeted sentiment] in the Amazon Comprehend +// Developer Guide. +// +// [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_DetectToxicContent.go b/service/comprehend/api_op_DetectToxicContent.go index ebfd6e85b6d..416f27ab9d3 100644 --- a/service/comprehend/api_op_DetectToxicContent.go +++ b/service/comprehend/api_op_DetectToxicContent.go @@ -13,9 +13,10 @@ import ( // Performs toxicity analysis on the list of text strings that you provide as // input. The API response contains a results list that matches the size of the -// input list. For more information about toxicity detection, see Toxicity -// detection (https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html) -// in the Amazon Comprehend Developer Guide. +// input list. For more information about toxicity detection, see [Toxicity detection]in the Amazon +// Comprehend Developer Guide. +// +// [Toxicity detection]: https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html func (c *Client) DetectToxicContent(ctx context.Context, params *DetectToxicContentInput, optFns ...func(*Options)) (*DetectToxicContentOutput, error) { if params == nil { params = &DetectToxicContentInput{} diff --git a/service/comprehend/api_op_ImportModel.go b/service/comprehend/api_op_ImportModel.go index 6260a335f8d..8f38483c487 100644 --- a/service/comprehend/api_op_ImportModel.go +++ b/service/comprehend/api_op_ImportModel.go @@ -13,10 +13,13 @@ import ( // Creates a new custom model that replicates a source custom model that you // import. The source model can be in your Amazon Web Services account or another -// one. If the source model is in another Amazon Web Services account, then it must -// have a resource-based policy that authorizes you to import it. The source model -// must be in the same Amazon Web Services Region that you're using when you -// import. You can't import a model that's in a different Region. +// one. +// +// If the source model is in another Amazon Web Services account, then it must +// have a resource-based policy that authorizes you to import it. +// +// The source model must be in the same Amazon Web Services Region that you're +// using when you import. You can't import a model that's in a different Region. func (c *Client) ImportModel(ctx context.Context, params *ImportModelInput, optFns ...func(*Options)) (*ImportModelOutput, error) { if params == nil { params = &ImportModelInput{} @@ -46,7 +49,9 @@ type ImportModelInput 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" ModelKmsKeyId *string diff --git a/service/comprehend/api_op_ListDatasets.go b/service/comprehend/api_op_ListDatasets.go index 7974f252f0d..29c524b211b 100644 --- a/service/comprehend/api_op_ListDatasets.go +++ b/service/comprehend/api_op_ListDatasets.go @@ -12,8 +12,9 @@ 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]in the Amazon Comprehend Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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 74345b76afc..d3f07ec75a1 100644 --- a/service/comprehend/api_op_ListEndpoints.go +++ b/service/comprehend/api_op_ListEndpoints.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// about endpoints, see [Managing endpoints]. +// +// [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{} diff --git a/service/comprehend/api_op_ListEntityRecognizers.go b/service/comprehend/api_op_ListEntityRecognizers.go index 0f36c4d7b0f..8266e140608 100644 --- a/service/comprehend/api_op_ListEntityRecognizers.go +++ b/service/comprehend/api_op_ListEntityRecognizers.go @@ -15,8 +15,10 @@ import ( // including recognizers currently in training. Allows you to filter the list of // recognizers based on criteria such as status and submission time. This call // returns up to 500 entity recognizers in the list, with a default number of 100 -// recognizers in the list. The results of this list are not in any particular -// order. Please get the list and sort locally if needed. +// recognizers in the list. +// +// The results of this list are not in any particular order. Please get the list +// and sort locally if needed. func (c *Client) ListEntityRecognizers(ctx context.Context, params *ListEntityRecognizersInput, optFns ...func(*Options)) (*ListEntityRecognizersOutput, error) { if params == nil { params = &ListEntityRecognizersInput{} @@ -38,7 +40,7 @@ type ListEntityRecognizersInput struct { // 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. + // The maximum number of results to return on each page. The default is 100. MaxResults *int32 // Identifies the next page of results to return. @@ -148,7 +150,7 @@ var _ ListEntityRecognizersAPIClient = (*Client)(nil) // ListEntityRecognizersPaginatorOptions is the paginator options for // ListEntityRecognizers type ListEntityRecognizersPaginatorOptions struct { - // The maximum number of results to return on each page. The default is 100. + // The maximum number of results to return on each page. The default is 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/comprehend/api_op_ListFlywheelIterationHistory.go b/service/comprehend/api_op_ListFlywheelIterationHistory.go index 2ea17f20122..a8f69034093 100644 --- a/service/comprehend/api_op_ListFlywheelIterationHistory.go +++ b/service/comprehend/api_op_ListFlywheelIterationHistory.go @@ -12,8 +12,9 @@ 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]in the Amazon Comprehend Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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 9b115dffc2e..3ed93352f2a 100644 --- a/service/comprehend/api_op_PutResourcePolicy.go +++ b/service/comprehend/api_op_PutResourcePolicy.go @@ -39,10 +39,14 @@ type PutResourcePolicyInput struct { // 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"]}' + // 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"]}' // // This member is required. ResourcePolicy *string diff --git a/service/comprehend/api_op_StartDocumentClassificationJob.go b/service/comprehend/api_op_StartDocumentClassificationJob.go index c64c20e514a..cc09694f124 100644 --- a/service/comprehend/api_op_StartDocumentClassificationJob.go +++ b/service/comprehend/api_op_StartDocumentClassificationJob.go @@ -72,15 +72,18 @@ 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" 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -94,9 +97,13 @@ type StartDocumentClassificationJobOutput struct { // The Amazon Resource Name (ARN) of the document classification 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:::document-classification-job/ The following - // is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::document-classification-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier generated for the job. To get the status of the job, use this @@ -104,13 +111,19 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StartDominantLanguageDetectionJob.go b/service/comprehend/api_op_StartDominantLanguageDetectionJob.go index 213b71ffdb9..d07b536f6f9 100644 --- a/service/comprehend/api_op_StartDominantLanguageDetectionJob.go +++ b/service/comprehend/api_op_StartDominantLanguageDetectionJob.go @@ -31,8 +31,9 @@ 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]. + // + // [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 @@ -64,15 +65,18 @@ type StartDominantLanguageDetectionJobInput 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" 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -83,9 +87,13 @@ type StartDominantLanguageDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the dominant language 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:::dominant-language-detection-job/ The - // following is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::dominant-language-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier generated for the job. To get the status of a job, use this @@ -93,9 +101,13 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StartEntitiesDetectionJob.go b/service/comprehend/api_op_StartEntitiesDetectionJob.go index 436b724b81e..27f25c4c06e 100644 --- a/service/comprehend/api_op_StartEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StartEntitiesDetectionJob.go @@ -12,11 +12,12 @@ import ( ) // Starts an asynchronous entity detection job for a collection of documents. Use -// the operation to track the status of a job. This API can be used for either -// standard entity detection or custom entity recognition. In order to be used for -// custom entity recognition, the optional EntityRecognizerArn must be used in -// order to provide access to the recognizer being used to detect the custom -// entity. +// the operation to track the status of a job. +// +// This API can be used for either standard entity detection or custom entity +// recognition. In order to be used for custom entity recognition, the optional +// EntityRecognizerArn must be used in order to provide access to the recognizer +// being used to detect the custom entity. func (c *Client) StartEntitiesDetectionJob(ctx context.Context, params *StartEntitiesDetectionJobInput, optFns ...func(*Options)) (*StartEntitiesDetectionJobOutput, error) { if params == nil { params = &StartEntitiesDetectionJobInput{} @@ -35,8 +36,9 @@ 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]. + // + // [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 @@ -85,15 +87,18 @@ 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" 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -107,9 +112,13 @@ type StartEntitiesDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the entities 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:::entities-detection-job/ The following is an example - // job ARN: - // arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab + // follows: + // + // arn::comprehend:::entities-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier generated for the job. To get the status of job, use this @@ -117,12 +126,18 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StartEventsDetectionJob.go b/service/comprehend/api_op_StartEventsDetectionJob.go index c112439c32b..f51cd891d77 100644 --- a/service/comprehend/api_op_StartEventsDetectionJob.go +++ b/service/comprehend/api_op_StartEventsDetectionJob.go @@ -76,9 +76,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: - // arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab + // 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 diff --git a/service/comprehend/api_op_StartFlywheelIteration.go b/service/comprehend/api_op_StartFlywheelIteration.go index 2e53afb8c6b..f757bc61676 100644 --- a/service/comprehend/api_op_StartFlywheelIteration.go +++ b/service/comprehend/api_op_StartFlywheelIteration.go @@ -11,8 +11,10 @@ import ( ) // 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. +// new model version. For more information about flywheels, see [Flywheel overview]in the Amazon +// Comprehend Developer Guide. +// +// [Flywheel overview]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html 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 96f574b1aff..3d709721297 100644 --- a/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go +++ b/service/comprehend/api_op_StartKeyPhrasesDetectionJob.go @@ -31,8 +31,9 @@ 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]. + // + // [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 @@ -71,15 +72,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for an optional private Virtual Private Cloud (VPC) + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -90,9 +94,13 @@ type StartKeyPhrasesDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the key phrase 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 + // 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 // The identifier generated for the job. To get the status of a job, use this @@ -100,9 +108,13 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go b/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go index 5a1a2dd8434..c8e6132a1d2 100644 --- a/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StartPiiEntitiesDetectionJob.go @@ -64,10 +64,11 @@ type StartPiiEntitiesDetectionJobInput struct { // The identifier of the job. 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. + // 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. RedactionConfig *types.RedactionConfig // Tags to associate with the PII entities detection job. A tag is a key-value @@ -84,9 +85,13 @@ type StartPiiEntitiesDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the PII entity 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:::pii-entities-detection-job/ The following is an - // example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab + // follows: + // + // arn::comprehend:::pii-entities-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier generated for the job. diff --git a/service/comprehend/api_op_StartSentimentDetectionJob.go b/service/comprehend/api_op_StartSentimentDetectionJob.go index 71d8b993750..e24c6f8f34b 100644 --- a/service/comprehend/api_op_StartSentimentDetectionJob.go +++ b/service/comprehend/api_op_StartSentimentDetectionJob.go @@ -31,8 +31,9 @@ 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]. + // + // [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 @@ -71,15 +72,18 @@ 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" 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -90,9 +94,13 @@ type StartSentimentDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the sentiment 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:::sentiment-detection-job/ The following is an example - // job ARN: - // arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab + // follows: + // + // arn::comprehend:::sentiment-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier generated for the job. To get the status of a job, use this @@ -100,9 +108,13 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go b/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go index 6f7ec2844ec..feeba6e8224 100644 --- a/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go +++ b/service/comprehend/api_op_StartTargetedSentimentDetectionJob.go @@ -32,8 +32,9 @@ 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/security_iam_id-based-policy-examples.html#auth-role-permissions) - // . + // read access to your input data. For more information, see [Role-based permissions]. + // + // [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 @@ -71,15 +72,17 @@ 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" 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) - // . + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -90,9 +93,13 @@ type StartTargetedSentimentDetectionJobOutput struct { // The Amazon Resource Name (ARN) of the targeted sentiment 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:::targeted-sentiment-detection-job/ The - // following is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::targeted-sentiment-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier generated for the job. To get the status of a job, use this @@ -100,9 +107,13 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StartTopicsDetectionJob.go b/service/comprehend/api_op_StartTopicsDetectionJob.go index f06451bd46a..71ec1444607 100644 --- a/service/comprehend/api_op_StartTopicsDetectionJob.go +++ b/service/comprehend/api_op_StartTopicsDetectionJob.go @@ -31,8 +31,9 @@ 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]. + // + // [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 @@ -69,15 +70,18 @@ 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" 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde @@ -88,9 +92,13 @@ 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: - // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab + // 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 // The identifier generated for the job. To get the status of the job, use this @@ -98,9 +106,13 @@ 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. JobStatus types.JobStatus diff --git a/service/comprehend/api_op_StopDominantLanguageDetectionJob.go b/service/comprehend/api_op_StopDominantLanguageDetectionJob.go index 74e037b2c1e..3cc125dc208 100644 --- a/service/comprehend/api_op_StopDominantLanguageDetectionJob.go +++ b/service/comprehend/api_op_StopDominantLanguageDetectionJob.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 // 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. +// Request Exception. +// +// When a job is stopped, any documents already processed are written to the +// output location. func (c *Client) StopDominantLanguageDetectionJob(ctx context.Context, params *StopDominantLanguageDetectionJobInput, optFns ...func(*Options)) (*StopDominantLanguageDetectionJobOutput, error) { if params == nil { params = &StopDominantLanguageDetectionJobInput{} diff --git a/service/comprehend/api_op_StopEntitiesDetectionJob.go b/service/comprehend/api_op_StopEntitiesDetectionJob.go index 456e84d4d53..22b82d59e66 100644 --- a/service/comprehend/api_op_StopEntitiesDetectionJob.go +++ b/service/comprehend/api_op_StopEntitiesDetectionJob.go @@ -11,13 +11,19 @@ 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; -// 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. +// 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 stopped, any documents already processed are written to the +// output location. func (c *Client) StopEntitiesDetectionJob(ctx context.Context, params *StopEntitiesDetectionJobInput, optFns ...func(*Options)) (*StopEntitiesDetectionJobOutput, error) { if params == nil { params = &StopEntitiesDetectionJobInput{} diff --git a/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go b/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go index 19401b53807..d9377ea2643 100644 --- a/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go +++ b/service/comprehend/api_op_StopKeyPhrasesDetectionJob.go @@ -11,13 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a key phrases 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 -// stopped, any documents already processed are written to the output location. +// Stops a key phrases 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 stopped, any documents already processed are written to the +// output location. func (c *Client) StopKeyPhrasesDetectionJob(ctx context.Context, params *StopKeyPhrasesDetectionJobInput, optFns ...func(*Options)) (*StopKeyPhrasesDetectionJobOutput, error) { if params == nil { params = &StopKeyPhrasesDetectionJobInput{} diff --git a/service/comprehend/api_op_StopSentimentDetectionJob.go b/service/comprehend/api_op_StopSentimentDetectionJob.go index a9b38f18e76..c87a2728364 100644 --- a/service/comprehend/api_op_StopSentimentDetectionJob.go +++ b/service/comprehend/api_op_StopSentimentDetectionJob.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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. +// 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{} diff --git a/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go b/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go index 3ffccdca538..d1c192f5053 100644 --- a/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go +++ b/service/comprehend/api_op_StopTargetedSentimentDetectionJob.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 +// 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 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. +// Request Exception. +// +// When a job is stopped, any documents already processed are written to the +// output location. func (c *Client) StopTargetedSentimentDetectionJob(ctx context.Context, params *StopTargetedSentimentDetectionJobInput, optFns ...func(*Options)) (*StopTargetedSentimentDetectionJobOutput, error) { if params == nil { params = &StopTargetedSentimentDetectionJobInput{} diff --git a/service/comprehend/api_op_StopTrainingDocumentClassifier.go b/service/comprehend/api_op_StopTrainingDocumentClassifier.go index a9f95279936..2d04eaa787e 100644 --- a/service/comprehend/api_op_StopTrainingDocumentClassifier.go +++ b/service/comprehend/api_op_StopTrainingDocumentClassifier.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// STOPPED state and the service sends back an HTTP 200 response with an empty HTTP -// body. +// 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 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 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) { if params == nil { params = &StopTrainingDocumentClassifierInput{} diff --git a/service/comprehend/api_op_StopTrainingEntityRecognizer.go b/service/comprehend/api_op_StopTrainingEntityRecognizer.go index 8d2a244d7e4..a49abd51348 100644 --- a/service/comprehend/api_op_StopTrainingEntityRecognizer.go +++ b/service/comprehend/api_op_StopTrainingEntityRecognizer.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// the STOPPED state and the service sends back an HTTP 200 response with an empty -// HTTP body. +// 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 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 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) { if params == nil { params = &StopTrainingEntityRecognizerInput{} diff --git a/service/comprehend/api_op_UntagResource.go b/service/comprehend/api_op_UntagResource.go index a3cf1ee3849..e189e1d4721 100644 --- a/service/comprehend/api_op_UntagResource.go +++ b/service/comprehend/api_op_UntagResource.go @@ -28,7 +28,7 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from + // The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from // which you want to remove the tags. // // This member is required. diff --git a/service/comprehend/api_op_UpdateEndpoint.go b/service/comprehend/api_op_UpdateEndpoint.go index 6539442e0ba..cc52b2d7f16 100644 --- a/service/comprehend/api_op_UpdateEndpoint.go +++ b/service/comprehend/api_op_UpdateEndpoint.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} @@ -39,9 +40,10 @@ type UpdateEndpointInput struct { // CMK. DesiredDataAccessRoleArn *string - // The desired number of inference units to be used by the model using this - // endpoint. Each inference unit represents of a throughput of 100 characters per - // second. + // The desired number of inference units to be used by the model using this + // endpoint. + // + // Each inference unit represents of a throughput of 100 characters per second. DesiredInferenceUnits *int32 // The ARN of the new model to use when updating an existing endpoint. diff --git a/service/comprehend/options.go b/service/comprehend/options.go index 0c234fdb245..0a04ada6d80 100644 --- a/service/comprehend/options.go +++ b/service/comprehend/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/comprehend/types/enums.go b/service/comprehend/types/enums.go index ef9b95a67f4..0c96ac993e1 100644 --- a/service/comprehend/types/enums.go +++ b/service/comprehend/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for AugmentedManifestsDocumentTypeFormat. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AugmentedManifestsDocumentTypeFormat) Values() []AugmentedManifestsDocumentTypeFormat { return []AugmentedManifestsDocumentTypeFormat{ "PLAIN_TEXT_DOCUMENT", @@ -30,8 +31,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for DatasetDataFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetDataFormat) Values() []DatasetDataFormat { return []DatasetDataFormat{ "COMPREHEND_CSV", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for DatasetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatus) Values() []DatasetStatus { return []DatasetStatus{ "CREATING", @@ -86,8 +90,9 @@ const ( ) // Values returns all known values for DatasetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetType) Values() []DatasetType { return []DatasetType{ "TRAIN", @@ -105,8 +110,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentClassifierDataFormat) Values() []DocumentClassifierDataFormat { return []DocumentClassifierDataFormat{ "COMPREHEND_CSV", @@ -124,8 +130,9 @@ const ( // Values returns all known values for DocumentClassifierDocumentTypeFormat. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentClassifierDocumentTypeFormat) Values() []DocumentClassifierDocumentTypeFormat { return []DocumentClassifierDocumentTypeFormat{ "PLAIN_TEXT_DOCUMENT", @@ -142,8 +149,9 @@ const ( ) // Values returns all known values for DocumentClassifierMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentClassifierMode) Values() []DocumentClassifierMode { return []DocumentClassifierMode{ "MULTI_CLASS", @@ -160,8 +168,9 @@ const ( ) // Values returns all known values for DocumentReadAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentReadAction) Values() []DocumentReadAction { return []DocumentReadAction{ "TEXTRACT_DETECT_DOCUMENT_TEXT", @@ -179,6 +188,7 @@ const ( // 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{ @@ -196,8 +206,9 @@ const ( ) // Values returns all known values for DocumentReadMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentReadMode) Values() []DocumentReadMode { return []DocumentReadMode{ "SERVICE_DEFAULT", @@ -219,8 +230,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -245,8 +257,9 @@ const ( ) // Values returns all known values for EndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointStatus) Values() []EndpointStatus { return []EndpointStatus{ "CREATING", @@ -267,6 +280,7 @@ const ( // Values returns all known values for EntityRecognizerDataFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EntityRecognizerDataFormat) Values() []EntityRecognizerDataFormat { return []EntityRecognizerDataFormat{ @@ -291,8 +305,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "PERSON", @@ -320,8 +335,9 @@ const ( ) // Values returns all known values for FlywheelIterationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlywheelIterationStatus) Values() []FlywheelIterationStatus { return []FlywheelIterationStatus{ "TRAINING", @@ -345,8 +361,9 @@ const ( ) // Values returns all known values for FlywheelStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlywheelStatus) Values() []FlywheelStatus { return []FlywheelStatus{ "CREATING", @@ -366,8 +383,9 @@ const ( ) // Values returns all known values for InputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputFormat) Values() []InputFormat { return []InputFormat{ "ONE_DOC_PER_FILE", @@ -387,6 +405,7 @@ const ( // Values returns all known values for InvalidRequestDetailReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InvalidRequestDetailReason) Values() []InvalidRequestDetailReason { return []InvalidRequestDetailReason{ @@ -405,8 +424,9 @@ const ( ) // Values returns all known values for InvalidRequestReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvalidRequestReason) Values() []InvalidRequestReason { return []InvalidRequestReason{ "INVALID_DOCUMENT", @@ -426,8 +446,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -458,8 +479,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -492,8 +514,9 @@ const ( ) // Values returns all known values for ModelStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelStatus) Values() []ModelStatus { return []ModelStatus{ "SUBMITTED", @@ -516,8 +539,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -537,8 +561,9 @@ const ( ) // Values returns all known values for PageBasedErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PageBasedErrorCode) Values() []PageBasedErrorCode { return []PageBasedErrorCode{ "TEXTRACT_BAD_PAGE", @@ -558,8 +583,9 @@ const ( ) // Values returns all known values for PageBasedWarningCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PageBasedWarningCode) Values() []PageBasedWarningCode { return []PageBasedWarningCode{ "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL", @@ -592,8 +618,9 @@ const ( ) // Values returns all known values for PartOfSpeechTagType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartOfSpeechTagType) Values() []PartOfSpeechTagType { return []PartOfSpeechTagType{ "ADJ", @@ -627,8 +654,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PiiEntitiesDetectionMaskMode) Values() []PiiEntitiesDetectionMaskMode { return []PiiEntitiesDetectionMaskMode{ "MASK", @@ -646,6 +674,7 @@ const ( // 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{ @@ -698,8 +727,9 @@ const ( ) // Values returns all known values for PiiEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PiiEntityType) Values() []PiiEntityType { return []PiiEntityType{ "BANK_ACCOUNT_NUMBER", @@ -750,8 +780,9 @@ const ( ) // Values returns all known values for RelationshipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationshipType) Values() []RelationshipType { return []RelationshipType{ "CHILD", @@ -769,8 +800,9 @@ const ( ) // Values returns all known values for SentimentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SentimentType) Values() []SentimentType { return []SentimentType{ "POSITIVE", @@ -789,8 +821,9 @@ const ( ) // 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. +// the future, and so 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{ "TRAIN", @@ -811,8 +844,9 @@ const ( ) // Values returns all known values for SyntaxLanguageCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyntaxLanguageCode) Values() []SyntaxLanguageCode { return []SyntaxLanguageCode{ "en", @@ -849,6 +883,7 @@ const ( // Values returns all known values for TargetedSentimentEntityType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TargetedSentimentEntityType) Values() []TargetedSentimentEntityType { return []TargetedSentimentEntityType{ @@ -886,8 +921,9 @@ const ( ) // Values returns all known values for ToxicContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ToxicContentType) Values() []ToxicContentType { return []ToxicContentType{ "GRAPHIC", diff --git a/service/comprehend/types/errors.go b/service/comprehend/types/errors.go index 82c667c8860..9bb147346d6 100644 --- a/service/comprehend/types/errors.go +++ b/service/comprehend/types/errors.go @@ -411,8 +411,9 @@ func (e *TooManyTagsException) ErrorCode() string { func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Amazon Comprehend can't process the language of the input text. For a list of -// supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) -// in the Comprehend Developer Guide. +// supported languages, [Supported languages]in the Comprehend Developer Guide. +// +// [Supported languages]: https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html type UnsupportedLanguageException struct { Message *string diff --git a/service/comprehend/types/types.go b/service/comprehend/types/types.go index e931f5fba3d..d38cfabd92a 100644 --- a/service/comprehend/types/types.go +++ b/service/comprehend/types/types.go @@ -15,8 +15,10 @@ type AugmentedManifestsListItem struct { // The JSON attribute that contains the annotations for your training documents. // The number of attribute names that you specify depends on whether your augmented // manifest file is the output of a single labeling job or a chained labeling job. + // // If your file is the output of a single labeling job, specify the // LabelAttributeName key that was used when the job was created in Ground Truth. + // // If your file is the output of a chained labeling job, specify the // LabelAttributeName key for one or more jobs in the chain. Each // LabelAttributeName key provides the annotations from an individual job. @@ -35,8 +37,10 @@ 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. @@ -48,10 +52,12 @@ type AugmentedManifestsListItem struct { // The purpose of the data you've provided in the augmented manifest. You can // either train or test this data. If you don't specify, the default is train. + // // TRAIN - all of the documents in the manifest will be used for training. If no // test documents are provided, Amazon Comprehend will automatically reserve a - // portion of the training documents for testing. TEST - all of the documents in - // the manifest will be used for testing. + // portion of the training documents for testing. + // + // TEST - all of the documents in the manifest will be used for testing. Split Split noSmithyDocumentSerde @@ -64,8 +70,7 @@ type BatchDetectDominantLanguageItemResult struct { // The zero-based index of the document in the input list. Index *int32 - // One or more DominantLanguage objects describing the dominant languages in the - // document. + // One or more DominantLanguage objects describing the dominant languages in the document. Languages []DominantLanguage noSmithyDocumentSerde @@ -156,14 +161,18 @@ type BatchItemError struct { noSmithyDocumentSerde } -// 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. +// Information about each word or line of text in the input document. +// +// For additional information, see [Block] in the Amazon Textract API reference. +// +// [Block]: https://docs.aws.amazon.com/textract/latest/dg/API_Block.html 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 BlockType BlockType @@ -208,9 +217,11 @@ type BlockReference struct { // The bounding box around the detected page or around an element on a document // 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. +// corner of the image is the origin (0,0). +// +// For additional information, see [BoundingBox] in the Amazon Textract API reference. +// +// [BoundingBox]: https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html type BoundingBox struct { // The height of the bounding box as a ratio of the overall document page height. @@ -301,8 +312,8 @@ type ClassifierEvaluationMetrics struct { // Provides information about a document classifier. type ClassifierMetadata struct { - // Describes the result metrics for the test data associated with an documentation - // classifier. + // Describes the result metrics for the test data associated with an + // documentation classifier. EvaluationMetrics *ClassifierEvaluationMetrics // The number of labels in the input data. @@ -329,7 +340,9 @@ type DataSecurityConfig 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" ModelKmsKeyId *string @@ -337,10 +350,10 @@ type DataSecurityConfig struct { // ID for the KMS key that Amazon Comprehend uses to encrypt the volume. 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) - // . + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -354,8 +367,10 @@ type DatasetAugmentedManifestsListItem struct { // The JSON attribute that contains the annotations for your training documents. // The number of attribute names that you specify depends on whether your augmented // manifest file is the output of a single labeling job or a chained labeling job. + // // If your file is the output of a single labeling job, specify the // LabelAttributeName key that was used when the job was created in Ground Truth. + // // If your file is the output of a chained labeling job, specify the // LabelAttributeName key for one or more jobs in the chain. Each // LabelAttributeName key provides the annotations from an individual job. @@ -373,8 +388,10 @@ type DatasetAugmentedManifestsListItem struct { AnnotationDataS3Uri *string // The type of augmented manifest. 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. + // PlainTextDocument. + // + // PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is + // encoded in UTF-8. DocumentType AugmentedManifestsDocumentTypeFormat // The S3 prefix to the source files (PDFs) that are referred to in the augmented @@ -385,18 +402,22 @@ 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. +// +// For more information on how the input file is formatted, see [Preparing training data] in the Comprehend +// Developer Guide. +// +// [Preparing training data]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html 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, - // 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 . + // 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, 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 . // // This member is required. S3Uri *string @@ -415,7 +436,7 @@ type DatasetDocumentClassifierInputDataConfig struct { // Describes the annotations associated with a entity recognizer. type DatasetEntityRecognizerAnnotations struct { - // Specifies the Amazon S3 location where the training documents for an entity + // Specifies the Amazon S3 location where the training documents for an entity // recognizer are located. The URI must be in the same Region as the API endpoint // that you are calling. // @@ -428,13 +449,13 @@ type DatasetEntityRecognizerAnnotations struct { // Describes the documents submitted with a dataset for an entity recognizer model. type DatasetEntityRecognizerDocuments struct { - // Specifies the Amazon S3 location where the documents for the dataset are + // Specifies the Amazon S3 location where the documents for the dataset are // located. // // This member is required. S3Uri *string - // Specifies how the text in an input file should be processed. This is optional, + // Specifies how the text in an input file should be processed. This is optional, // and the default is ONE_DOC_PER_LINE. 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 @@ -445,9 +466,12 @@ type DatasetEntityRecognizerDocuments struct { noSmithyDocumentSerde } -// 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) -// in the Comprehend Developer Guide. +// Describes the dataset entity list for an entity recognizer model. +// +// For more information on how the input file is formatted, see [Preparing training data] in the Comprehend +// Developer Guide. +// +// [Preparing training data]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html type DatasetEntityRecognizerEntityList struct { // Specifies the Amazon S3 location where the entity list is located. @@ -505,12 +529,16 @@ type DatasetInputDataConfig struct { // 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. + // The input properties for training a document classifier model. + // + // For more information on how the input file is formatted, see [Preparing training data] in the Comprehend + // Developer Guide. + // + // [Preparing training data]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html DocumentClassifierInputDataConfig *DatasetDocumentClassifierInputDataConfig // The input properties for training an entity recognizer model. @@ -635,9 +663,13 @@ type DocumentClassificationJobProperties struct { // The Amazon Resource Name (ARN) of the document classification 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:::document-classification-job/ The following - // is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::document-classification-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier assigned to the document classification job. @@ -664,15 +696,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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/vpc/latest/userguide/what-is-amazon-vpc.html) - // . + // information, see [Amazon VPC]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -718,41 +753,58 @@ 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] in the Comprehend +// Developer Guide. +// +// [Preparing training data]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html 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 . + // Amazon SageMaker Ground Truth. + // + // This parameter is required if you set DataFormat 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. + // 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 // 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: + // 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/idp-set-textract-options.html) - // in the Comprehend Developer Guide. + // + // 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]in the Comprehend Developer + // Guide. + // + // [Setting text extraction options]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html DocumentReaderConfig *DocumentReaderConfig // The type of input documents for training the model. Provide plain-text @@ -774,11 +826,13 @@ 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, - // 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 . + // 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, 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 . S3Uri *string // This specifies the Amazon S3 location that contains the test annotations for @@ -799,10 +853,14 @@ 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" KmsKeyId *string @@ -811,10 +869,12 @@ type DocumentClassifierOutputDataConfig struct { // you specify the Amazon S3 location where you want to write the confusion matrix // and other output files. 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 confusion matrix. + // 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 confusion matrix. S3Uri *string noSmithyDocumentSerde @@ -860,12 +920,14 @@ type DocumentClassifierProperties 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" ModelKmsKeyId *string - // Provides output results configuration parameters for custom classifier jobs. + // Provides output results configuration parameters for custom classifier jobs. OutputDataConfig *DocumentClassifierOutputDataConfig // The Amazon Resource Name (ARN) of the source model. This model was imported @@ -876,9 +938,10 @@ type DocumentClassifierProperties struct { // The status of the document classifier. If the status is TRAINED the classifier // is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training // succeeded, but you should review the warnings returned in the - // CreateDocumentClassifier response. If the status is FAILED you can see - // additional information about why the classifier wasn't trained in the Message - // field. + // CreateDocumentClassifier response. + // + // If the status is FAILED you can see additional information about why the + // classifier wasn't trained in the Message field. Status ModelStatus // The time that the document classifier was submitted for training. @@ -901,15 +964,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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/vpc/latest/userguide/what-is-amazon-vpc.html) - // . + // see [Amazon VPC]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -968,25 +1034,34 @@ type DocumentMetadata struct { } // 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: +// 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/idp-set-textract-options.html) -// in the Comprehend Developer Guide. +// 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]in the Comprehend Developer +// Guide. +// +// [Setting text extraction options]: https://docs.aws.amazon.com/comprehend/latest/dg/idp-set-textract-options.html 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 // 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. // @@ -995,7 +1070,9 @@ type DocumentReaderConfig struct { // 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 @@ -1003,8 +1080,10 @@ type DocumentReaderConfig struct { // 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 additional information about any tables that are detected // in the input document. + // // - FORMS - Returns additional information about any forms that are detected in // the input document. FeatureTypes []DocumentReadFeatureTypes @@ -1029,8 +1108,9 @@ type DocumentTypeListItem struct { 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. + // about RFC 5646, see [Tags for Identifying Languages]on the IETF Tools web site. + // + // [Tags for Identifying Languages]: https://tools.ietf.org/html/rfc5646 LanguageCode *string // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -1081,9 +1161,13 @@ type DominantLanguageDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the dominant language 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:::dominant-language-detection-job/ The - // following is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::dominant-language-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier assigned to the dominant language detection job. @@ -1110,15 +1194,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -1146,8 +1233,9 @@ 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]. +// +// [Managing endpoints]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html type EndpointProperties struct { // The creation date and time of the endpoint. @@ -1166,8 +1254,9 @@ type EndpointProperties struct { DesiredDataAccessRoleArn *string // The desired number of inference units to be used by the model using this - // endpoint. Each inference unit represents of a throughput of 100 characters per - // second. + // endpoint. + // + // Each inference unit represents of a throughput of 100 characters per second. DesiredInferenceUnits *int32 // ARN of the new model to use for updating an existing endpoint. This ARN is @@ -1244,9 +1333,13 @@ type EntitiesDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the entities 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:::entities-detection-job/ The following is an example - // job ARN: - // arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab + // follows: + // + // arn::comprehend:::entities-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier assigned to the entities detection job. @@ -1276,15 +1369,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -1294,7 +1390,9 @@ type EntitiesDetectionJobProperties struct { type Entity struct { // The zero-based offset from the beginning of the source text to the first - // character in the entity. This field is empty for non-text input. + // character in the entity. + // + // This field is empty for non-text input. BeginOffset *int32 // A reference to each block for this entity. This field is empty for plain-text @@ -1302,7 +1400,9 @@ type Entity struct { BlockReferences []BlockReference // The zero-based offset from the beginning of the source text to the last - // character in the entity. This field is empty for non-text input. + // character in the entity. + // + // This field is empty for non-text input. EndOffset *int32 // The level of confidence that Amazon Comprehend has in the accuracy of the @@ -1313,9 +1413,10 @@ type Entity struct { Text *string // The entity type. For entity detection using the built-in model, this field - // contains one of the standard entity types listed below. For custom entity - // detection, this field contains one of the entity types that you specified when - // you trained your custom model. + // contains one of the standard entity types listed below. + // + // For custom entity detection, this field contains one of the entity types that + // you specified when you trained your custom model. Type EntityType noSmithyDocumentSerde @@ -1349,14 +1450,14 @@ type EntityRecognitionConfig struct { // Describes the annotations associated with a entity recognizer. type EntityRecognizerAnnotations struct { - // Specifies the Amazon S3 location where the annotations for an entity recognizer - // are located. The URI must be in the same Region as the API endpoint that you are - // calling. + // Specifies the Amazon S3 location where the annotations for an entity + // recognizer are located. The URI must be in the same Region as the API endpoint + // that you are calling. // // This member is required. S3Uri *string - // Specifies the Amazon S3 location where the test annotations for an entity + // Specifies the Amazon S3 location where the test annotations for an entity // recognizer are located. The URI must be in the same Region as the API endpoint // that you are calling. TestS3Uri *string @@ -1367,14 +1468,14 @@ type EntityRecognizerAnnotations struct { // Describes the training documents submitted with an entity recognizer. type EntityRecognizerDocuments struct { - // Specifies the Amazon S3 location where the training documents for an entity + // Specifies the Amazon S3 location where the training documents for an entity // recognizer are located. The URI must be in the same Region as the API endpoint // that you are calling. // // This member is required. S3Uri *string - // Specifies how the text in an input file should be processed. This is optional, + // Specifies how the text in an input file should be processed. This is optional, // and the default is ONE_DOC_PER_LINE. 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 @@ -1382,7 +1483,7 @@ type EntityRecognizerDocuments struct { // processing many short documents, such as text messages. InputFormat InputFormat - // Specifies the Amazon S3 location where the test documents for an entity + // Specifies the Amazon S3 location where the test documents for an entity // recognizer are located. The URI must be in the same Amazon Web Services Region // as the API endpoint that you are calling. TestS3Uri *string @@ -1453,7 +1554,9 @@ type EntityRecognizerInputDataConfig struct { // The entity types in the labeled training data that Amazon Comprehend uses to // train the custom entity recognizer. Any entity types that you don't specify are - // ignored. A maximum of 25 entity types can be used at one time to train an entity + // ignored. + // + // A maximum of 25 entity types can be used at one time to train an entity // recognizer. Entity types must not contain the following invalid characters: \n // (line break), \\n (escaped line break), \r (carriage return), \\r (escaped // carriage return), \t (tab), \\t (escaped tab), space, and , (comma). @@ -1466,29 +1569,38 @@ 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 . + // Amazon SageMaker Ground Truth. + // + // This parameter is required if you set DataFormat 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. + // 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. + // 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 . + // custom entity recognizer. + // + // This parameter is required if you set DataFormat to COMPREHEND_CSV . Documents *EntityRecognizerDocuments // The S3 location of the CSV file that has the entity list for your custom entity @@ -1507,11 +1619,11 @@ type EntityRecognizerMetadata struct { // Detailed information about the accuracy of an entity recognizer. EvaluationMetrics *EntityRecognizerEvaluationMetrics - // The number of documents in the input data that were used to test the entity + // The number of documents in the input data that were used to test the entity // recognizer. Typically this is 10 to 20 percent of the input documents. NumberOfTestDocuments *int32 - // The number of documents in the input data that were used to train the entity + // The number of documents in the input data that were used to train the entity // recognizer. Typically this is 80 to 90 percent of the input documents. NumberOfTrainedDocuments *int32 @@ -1549,7 +1661,7 @@ type EntityRecognizerOutputDataConfig struct { // Describes information about an entity recognizer. type EntityRecognizerProperties struct { - // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend + // The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend // read access to your input data. DataAccessRoleArn *string @@ -1565,16 +1677,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 + // 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. + // 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" ModelKmsKeyId *string @@ -1582,7 +1696,7 @@ type EntityRecognizerProperties struct { // Output data configuration. OutputDataConfig *EntityRecognizerOutputDataConfig - // Provides information about an entity recognizer. + // Provides information about an entity recognizer. RecognizerMetadata *EntityRecognizerMetadata // The Amazon Resource Name (ARN) of the source model. This model was imported @@ -1609,15 +1723,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -1626,19 +1743,20 @@ type EntityRecognizerProperties struct { // Describes the information about an entity recognizer and its versions. type EntityRecognizerSummary struct { - // The time that the latest entity recognizer version was submitted for processing. + // The time that the latest entity recognizer version was submitted for + // processing. LatestVersionCreatedAt *time.Time - // The version name you assigned to the latest entity recognizer version. + // The version name you assigned to the latest entity recognizer version. LatestVersionName *string - // Provides the status of the latest entity recognizer version. + // Provides the status of the latest entity recognizer version. LatestVersionStatus ModelStatus - // The number of versions you created. + // The number of versions you created. NumberOfVersions *int32 - // The name that you assigned the entity recognizer. + // The name that you assigned the entity recognizer. RecognizerName *string noSmithyDocumentSerde @@ -1672,10 +1790,11 @@ type EntityTypesEvaluationMetrics struct { type EntityTypesListItem struct { // An entity type within a labeled training dataset that Amazon Comprehend uses to - // train a custom entity recognizer. Entity types must not contain the following - // invalid characters: \n (line break), \\n (escaped line break, \r (carriage - // return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), and , - // (comma). + // train a custom entity recognizer. + // + // Entity types must not contain the following invalid characters: \n (line + // break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage + // return), \t (tab), \\t (escaped tab), and , (comma). // // This member is required. Type *string @@ -1683,21 +1802,27 @@ 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: +// 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) -// . +// information about page limits in Amazon Textract, see [Page Quotas in Amazon Textract]. +// // - 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) -// . +// Textract, see [Default quotas in Amazon Textract]. +// // - 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. +// +// [Default quotas in Amazon Textract]: https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html +// [Page Quotas in Amazon Textract]: https://docs.aws.amazon.com/textract/latest/dg/limits-document.html type ErrorsListItem struct { // Error code for the cause of the error. @@ -1752,9 +1877,13 @@ 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: - // arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab + // 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 // The identifier assigned to the events detection job. @@ -1959,9 +2088,11 @@ type FlywheelSummary struct { noSmithyDocumentSerde } -// 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 about the location of items on a document page. +// +// For additional information, see [Geometry] in the Amazon Textract API reference. +// +// [Geometry]: https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html type Geometry struct { // An axis-aligned coarse representation of the location of the recognized item on @@ -1980,10 +2111,11 @@ 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 - // Comprehend uses that file as input. If more than one file begins with the - // prefix, Amazon Comprehend uses all of them as input. + // 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 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 @@ -1993,9 +2125,11 @@ type InputDataConfig struct { 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. @@ -2008,19 +2142,26 @@ type InputDataConfig struct { type InvalidRequestDetail struct { // Reason codes include the following values: + // // - DOCUMENT_SIZE_EXCEEDED - Document size is too large. Check the size of your // file and resubmit the request. + // // - UNSUPPORTED_DOC_TYPE - Document type is not supported. Check the file type // and resubmit the request. + // // - PAGE_LIMIT_EXCEEDED - Too many pages in the document. Check the number of // pages in your file and resubmit the request. + // // - TEXTRACT_ACCESS_DENIED - Access denied to Amazon Textract. Verify that your // account has permission to use Amazon Textract API operations and resubmit the // request. + // // - NOT_TEXTRACT_JSON - Document is not Amazon Textract JSON format. Verify the // format and resubmit the request. + // // - MISMATCHED_TOTAL_PAGE_COUNT - Check the number of pages in your file and // resubmit the request. + // // - INVALID_DOCUMENT - Invalid document. Check the file and resubmit the // request. Reason InvalidRequestDetailReason @@ -2090,9 +2231,13 @@ type KeyPhrasesDetectionJobProperties struct { // 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 + // 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 // The identifier assigned to the key phrases detection job. @@ -2121,23 +2266,29 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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]. + // + // [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) -// in the Amazon Comprehend Developer Guide. +// Contains the sentiment and sentiment score for one mention of an entity. +// +// For more information about targeted sentiment, see [Targeted sentiment] in the Amazon Comprehend +// Developer Guide. +// +// [Targeted sentiment]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html type MentionSentiment struct { // The sentiment of the mention. @@ -2156,13 +2307,16 @@ type OutputDataConfig struct { // When you use the OutputDataConfig object with asynchronous operations, you // specify the Amazon S3 location where you want to write the output data. 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 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 + // 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 - // 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. + // 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. // // This member is required. S3Uri *string @@ -2170,11 +2324,17 @@ 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. Specify the // Key Id of a symmetric key, because you cannot use an asymmetric key for - // uploading data to S3. The KmsKeyId can be one of the following formats: + // uploading data to S3. + // + // 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" KmsKeyId *string @@ -2185,8 +2345,9 @@ 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]in the Comprehend Developer Guide. +// +// [Syntax]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html type PartOfSpeechTag struct { // The confidence that Amazon Comprehend has that the part of speech was correctly @@ -2238,9 +2399,13 @@ type PiiEntitiesDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the PII entities 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:::pii-entities-detection-job/ The following - // is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::pii-entities-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier assigned to the PII entities detection job. @@ -2267,10 +2432,11 @@ type PiiEntitiesDetectionJobProperties struct { // entities detection job. 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. + // 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. RedactionConfig *RedactionConfig // The time that the PII entities detection job was submitted for processing. @@ -2304,8 +2470,9 @@ type PiiEntity struct { type PiiOutputDataConfig struct { // When you use the PiiOutputDataConfig object with asynchronous operations, you - // specify the Amazon S3 location where you want to write the output data. For a - // PII entity detection job, the output file is plain text, not a compressed + // specify the Amazon S3 location where you want to write the output data. + // + // 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. // @@ -2319,9 +2486,11 @@ type PiiOutputDataConfig struct { noSmithyDocumentSerde } -// 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. +// The X and Y coordinates of a point on a document page. +// +// For additional information, see [Point] in the Amazon Textract API reference. +// +// [Point]: https://docs.aws.amazon.com/textract/latest/dg/API_Point.html type Point struct { // The value of the X coordinate for a point on a polygon @@ -2403,9 +2572,13 @@ type SentimentDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the sentiment 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:::sentiment-detection-job/ The following is an example - // job ARN: - // arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab + // follows: + // + // arn::comprehend:::sentiment-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier assigned to the sentiment detection job. @@ -2435,15 +2608,18 @@ 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" VolumeKmsKeyId *string - // Configuration parameters for a private Virtual Private Cloud (VPC) containing + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -2486,8 +2662,9 @@ 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]in the Comprehend Developer Guide. + // + // [Syntax]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html PartOfSpeech *PartOfSpeechTag // The word that was recognized in the source text. @@ -2512,7 +2689,7 @@ type Tag struct { // This member is required. Key *string - // The second part of a key-value pair that forms a tag associated with a given + // The second part of a key-value pair that forms a tag associated with a given // resource. For instance, if you want to show which resources are used by which // departments, you might use “Department” as the initial (key) portion of the // pair, with a value of “sales” to indicate the sales department. @@ -2562,9 +2739,13 @@ type TargetedSentimentDetectionJobProperties struct { // The Amazon Resource Name (ARN) of the targeted sentiment 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:::targeted-sentiment-detection-job/ The - // following is an example job ARN: - // arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab + // ARN is as follows: + // + // arn::comprehend:::targeted-sentiment-detection-job/ + // + // The following is an example job ARN: + // + // arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string // The identifier assigned to the targeted sentiment detection job. @@ -2593,23 +2774,28 @@ 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" 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) - // . + // 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]. + // + // [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) -// in the Amazon Comprehend Developer Guide. +// Information about one of the entities found by targeted sentiment analysis. +// +// For more information about targeted sentiment, see [Targeted sentiment] in the Amazon Comprehend +// Developer Guide. +// +// [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 @@ -2617,17 +2803,21 @@ 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) - // for an example. + // co-reference group. See [Co-reference group]for an example. + // + // [Co-reference group]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values 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) -// in the Amazon Comprehend Developer Guide. +// the location of the mention in the text and the sentiment of the mention. +// +// For more information about targeted sentiment, see [Targeted sentiment] in the Amazon Comprehend +// Developer Guide. +// +// [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. @@ -2650,8 +2840,9 @@ 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]. + // + // [entity types]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities Type TargetedSentimentEntityType noSmithyDocumentSerde @@ -2725,9 +2916,13 @@ 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: - // arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab + // 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 // The identifier assigned to the topic detection job. @@ -2757,29 +2952,33 @@ 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" 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde } // Toxic content analysis result for one string. For more information about -// toxicity detection, see Toxicity detection (https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html) -// in the Amazon Comprehend Developer Guide +// toxicity detection, see [Toxicity detection]in the Amazon Comprehend Developer Guide +// +// [Toxicity detection]: https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html type ToxicContent struct { // The name of the toxic content type. Name ToxicContentType - // Model confidence in the detected content type. Value range is zero to one, + // Model confidence in the detected content type. Value range is zero to one, // where one is highest confidence. Score *float32 @@ -2787,8 +2986,9 @@ type ToxicContent struct { } // Toxicity analysis result for one string. For more information about toxicity -// detection, see Toxicity detection (https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html) -// in the Amazon Comprehend Developer Guide. +// detection, see [Toxicity detection]in the Amazon Comprehend Developer Guide. +// +// [Toxicity detection]: https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html type ToxicLabels struct { // Array of toxic content types identified in the string. @@ -2806,7 +3006,9 @@ 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" ModelKmsKeyId *string @@ -2814,27 +3016,29 @@ type UpdateDataSecurityConfig struct { // ID for the KMS key that Amazon Comprehend uses to encrypt the volume. 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) - // . + // 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]. + // + // [Amazon VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [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]. + // + // [Security Groups for your VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html // // This member is required. SecurityGroupIds []string @@ -2842,8 +3046,9 @@ type VpcConfig struct { // The ID for each subnet being used in your private VPC. This subnet is a subset // 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) . + // for instance: "subnet-04ccf456919e69055". For more information, see [VPCs and Subnets]. + // + // [VPCs and Subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html // // This member is required. Subnets []string @@ -2853,8 +3058,10 @@ type VpcConfig struct { // The system identified one of the following warnings while processing the input // document: +// // - The document to classify is plain text, but the classifier is a native // document model. +// // - The document to classify is semi-structured, but the classifier is a // plain-text model. type WarningsListItem struct { diff --git a/service/comprehendmedical/api_op_DescribeSNOMEDCTInferenceJob.go b/service/comprehendmedical/api_op_DescribeSNOMEDCTInferenceJob.go index 3b6785b291a..c357f4cac72 100644 --- a/service/comprehendmedical/api_op_DescribeSNOMEDCTInferenceJob.go +++ b/service/comprehendmedical/api_op_DescribeSNOMEDCTInferenceJob.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the properties associated with an InferSNOMEDCT job. Use this operation to -// get the status of an inference job. +// Gets the properties associated with an InferSNOMEDCT job. Use this operation +// +// to get the status of an inference job. func (c *Client) DescribeSNOMEDCTInferenceJob(ctx context.Context, params *DescribeSNOMEDCTInferenceJobInput, optFns ...func(*Options)) (*DescribeSNOMEDCTInferenceJobOutput, error) { if params == nil { params = &DescribeSNOMEDCTInferenceJobInput{} @@ -30,7 +31,7 @@ func (c *Client) DescribeSNOMEDCTInferenceJob(ctx context.Context, params *Descr type DescribeSNOMEDCTInferenceJobInput struct { - // The identifier that Amazon Comprehend Medical generated for the job. The + // The identifier that Amazon Comprehend Medical generated for the job. The // StartSNOMEDCTInferenceJob operation returns this identifier in its response. // // This member is required. diff --git a/service/comprehendmedical/api_op_DetectEntities.go b/service/comprehendmedical/api_op_DetectEntities.go index 86ccd673920..db8fc1733b3 100644 --- a/service/comprehendmedical/api_op_DetectEntities.go +++ b/service/comprehendmedical/api_op_DetectEntities.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 -// operation instead. Inspects the clinical text for a variety of medical entities -// and returns specific information about them such as entity category, location, -// and confidence score on that information. +// The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation +// instead. +// +// Inspects the clinical text for a variety of medical entities and returns +// specific information about them such as entity category, location, and +// confidence score on that information. // // Deprecated: This operation is deprecated, use DetectEntitiesV2 instead. func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput, optFns ...func(*Options)) (*DetectEntitiesOutput, error) { @@ -34,7 +36,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. + // A UTF-8 text string containing the clinical content being examined for + // entities. // // This member is required. Text *string diff --git a/service/comprehendmedical/api_op_DetectEntitiesV2.go b/service/comprehendmedical/api_op_DetectEntitiesV2.go index 2a757ea16ed..aac02b9719b 100644 --- a/service/comprehendmedical/api_op_DetectEntitiesV2.go +++ b/service/comprehendmedical/api_op_DetectEntitiesV2.go @@ -14,12 +14,15 @@ import ( // Inspects the clinical text for a variety of medical entities and returns // specific information about them such as entity category, location, and // confidence score on that information. Amazon Comprehend Medical only detects -// medical entities in English language texts. The DetectEntitiesV2 operation -// replaces the DetectEntities operation. This new action uses a different model -// for determining the entities in your medical text and changes the way that some -// entities are returned in the output. You should use the DetectEntitiesV2 -// operation in all new applications. The DetectEntitiesV2 operation returns the -// Acuity and Direction entities as attributes instead of types. +// medical entities in English language texts. +// +// The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a +// different model for determining the entities in your medical text and changes +// the way that some entities are returned in the output. You should use the +// DetectEntitiesV2 operation in all new applications. +// +// The DetectEntitiesV2 operation returns the Acuity and Direction entities as +// attributes instead of types. func (c *Client) DetectEntitiesV2(ctx context.Context, params *DetectEntitiesV2Input, optFns ...func(*Options)) (*DetectEntitiesV2Output, error) { if params == nil { params = &DetectEntitiesV2Input{} diff --git a/service/comprehendmedical/api_op_InferSNOMEDCT.go b/service/comprehendmedical/api_op_InferSNOMEDCT.go index bc09f5a2b05..e388b4888d0 100644 --- a/service/comprehendmedical/api_op_InferSNOMEDCT.go +++ b/service/comprehendmedical/api_op_InferSNOMEDCT.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// InferSNOMEDCT detects possible medical concepts as entities and links them to +// InferSNOMEDCT detects possible medical concepts as entities and links them to +// // codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) // ontology func (c *Client) InferSNOMEDCT(ctx context.Context, params *InferSNOMEDCTInput, optFns ...func(*Options)) (*InferSNOMEDCTOutput, error) { @@ -41,7 +42,7 @@ type InferSNOMEDCTInput struct { type InferSNOMEDCTOutput struct { - // The collection of medical concept entities extracted from the input text and + // The collection of medical concept entities extracted from the input text and // their associated information. For each entity, the response provides the entity // text, the entity category, where the entity text begins and ends, and the level // of confidence that Amazon Comprehend Medical has in the detection and analysis. @@ -50,19 +51,19 @@ type InferSNOMEDCTOutput struct { // This member is required. Entities []types.SNOMEDCTEntity - // The number of characters in the input request documentation. + // The number of characters in the input request documentation. Characters *types.Characters - // The version of the model used to analyze the documents, in the format n.n.n You - // can use this information to track the model used for a particular batch of + // The version of the model used to analyze the documents, in the format n.n.n + // You can use this information to track the model used for a particular batch of // documents. ModelVersion *string - // If the result of the request is truncated, the pagination token can be used to + // If the result of the request is truncated, the pagination token can be used to // fetch the next page of entities. PaginationToken *string - // The details of the SNOMED-CT revision, including the edition, language, and + // The details of the SNOMED-CT revision, including the edition, language, and // version date. SNOMEDCTDetails *types.SNOMEDCTDetails diff --git a/service/comprehendmedical/api_op_ListSNOMEDCTInferenceJobs.go b/service/comprehendmedical/api_op_ListSNOMEDCTInferenceJobs.go index 0bff7afe45c..0fd0a838986 100644 --- a/service/comprehendmedical/api_op_ListSNOMEDCTInferenceJobs.go +++ b/service/comprehendmedical/api_op_ListSNOMEDCTInferenceJobs.go @@ -32,10 +32,10 @@ type ListSNOMEDCTInferenceJobsInput struct { // Provides information for filtering a list of detection jobs. Filter *types.ComprehendMedicalAsyncJobFilter - // The maximum number of results to return in each page. The default is 100. + // The maximum number of results to return in each page. The default is 100. MaxResults *int32 - // Identifies the next page of InferSNOMEDCT results to return. + // Identifies the next page of InferSNOMEDCT results to return. NextToken *string noSmithyDocumentSerde @@ -43,10 +43,10 @@ type ListSNOMEDCTInferenceJobsInput struct { type ListSNOMEDCTInferenceJobsOutput struct { - // A list containing the properties of each job that is returned. + // A list containing the properties of each job that is returned. ComprehendMedicalAsyncJobPropertiesList []types.ComprehendMedicalAsyncJobProperties - // Identifies the next page of results to return. + // Identifies the next page of results to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go b/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go index 5388f057a1b..51f6b40d320 100644 --- a/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go +++ b/service/comprehendmedical/api_op_StartEntitiesDetectionV2Job.go @@ -33,9 +33,9 @@ type StartEntitiesDetectionV2JobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon 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) - // . + // more information, see [Role-Based Permissions Required for Asynchronous Operations]. + // + // [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_StartICD10CMInferenceJob.go b/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go index 162d3f92764..4561cf41178 100644 --- a/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go +++ b/service/comprehendmedical/api_op_StartICD10CMInferenceJob.go @@ -33,9 +33,9 @@ type StartICD10CMInferenceJobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon 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) - // . + // more information, see [Role-Based Permissions Required for Asynchronous Operations]. + // + // [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 c1ccc3b9ef6..1c819dde3fa 100644 --- a/service/comprehendmedical/api_op_StartPHIDetectionJob.go +++ b/service/comprehendmedical/api_op_StartPHIDetectionJob.go @@ -32,9 +32,9 @@ type StartPHIDetectionJobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon 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) - // . + // more information, see [Role-Based Permissions Required for Asynchronous Operations]. + // + // [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 61b19e7267e..87171737c52 100644 --- a/service/comprehendmedical/api_op_StartRxNormInferenceJob.go +++ b/service/comprehendmedical/api_op_StartRxNormInferenceJob.go @@ -33,9 +33,9 @@ type StartRxNormInferenceJobInput struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon 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) - // . + // more information, see [Role-Based Permissions Required for Asynchronous Operations]. + // + // [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_StartSNOMEDCTInferenceJob.go b/service/comprehendmedical/api_op_StartSNOMEDCTInferenceJob.go index e2532463bcc..c91b85addce 100644 --- a/service/comprehendmedical/api_op_StartSNOMEDCTInferenceJob.go +++ b/service/comprehendmedical/api_op_StartSNOMEDCTInferenceJob.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an asynchronous job to detect medical concepts and link them to the +// Starts an asynchronous job to detect medical concepts and link them to the +// // SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the // status of a job. func (c *Client) StartSNOMEDCTInferenceJob(ctx context.Context, params *StartSNOMEDCTInferenceJobInput, optFns ...func(*Options)) (*StartSNOMEDCTInferenceJobOutput, error) { @@ -31,7 +32,7 @@ func (c *Client) StartSNOMEDCTInferenceJob(ctx context.Context, params *StartSNO type StartSNOMEDCTInferenceJobInput struct { - // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that grants Amazon Comprehend Medical read access to your input data. // // This member is required. @@ -43,7 +44,8 @@ type StartSNOMEDCTInferenceJobInput struct { // This member is required. InputDataConfig *types.InputDataConfig - // The language of the input documents. All documents must be in the same language. + // The language of the input documents. All documents must be in the same + // language. // // This member is required. LanguageCode types.LanguageCode @@ -53,14 +55,14 @@ type StartSNOMEDCTInferenceJobInput struct { // This member is required. OutputDataConfig *types.OutputDataConfig - // A unique identifier for the request. If you don't set the client request token, - // Amazon Comprehend Medical generates one. + // A unique identifier for the request. If you don't set the client request + // token, Amazon Comprehend Medical generates one. ClientRequestToken *string - // The user generated name the asynchronous InferSNOMEDCT job. + // The user generated name the asynchronous InferSNOMEDCT job. JobName *string - // An AWS Key Management Service key used to encrypt your output files. If you do + // An AWS Key Management Service key used to encrypt your output files. If you do // not specify a key, the files are written in plain text. KMSKey *string @@ -69,7 +71,7 @@ type StartSNOMEDCTInferenceJobInput struct { type StartSNOMEDCTInferenceJobOutput struct { - // The identifier generated for the job. To get the status of a job, use this + // The identifier generated for the job. To get the status of a job, use this // identifier with the StartSNOMEDCTInferenceJob operation. JobId *string diff --git a/service/comprehendmedical/api_op_StopSNOMEDCTInferenceJob.go b/service/comprehendmedical/api_op_StopSNOMEDCTInferenceJob.go index 3207e7ba539..8caa1165cb0 100644 --- a/service/comprehendmedical/api_op_StopSNOMEDCTInferenceJob.go +++ b/service/comprehendmedical/api_op_StopSNOMEDCTInferenceJob.go @@ -28,7 +28,7 @@ func (c *Client) StopSNOMEDCTInferenceJob(ctx context.Context, params *StopSNOME type StopSNOMEDCTInferenceJobInput struct { - // The job id of the asynchronous InferSNOMEDCT job to be stopped. + // The job id of the asynchronous InferSNOMEDCT job to be stopped. // // This member is required. JobId *string @@ -38,7 +38,7 @@ type StopSNOMEDCTInferenceJobInput struct { type StopSNOMEDCTInferenceJobOutput struct { - // The identifier generated for the job. To get the status of job, use this + // The identifier generated for the job. To get the status of job, use this // identifier with the DescribeSNOMEDCTInferenceJob operation. JobId *string diff --git a/service/comprehendmedical/doc.go b/service/comprehendmedical/doc.go index dbaf4cb86fd..11de4400124 100644 --- a/service/comprehendmedical/doc.go +++ b/service/comprehendmedical/doc.go @@ -7,6 +7,7 @@ // clinical text. Use these actions to gain insight in your documents. Amazon // Comprehend Medical only detects entities in English language texts. Amazon // Comprehend Medical places limits on the sizes of files allowed for different API -// operations. To learn more, see Guidelines and quotas (https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html) -// in the Amazon Comprehend Medical Developer Guide. +// operations. To learn more, see [Guidelines and quotas]in the Amazon Comprehend Medical Developer Guide. +// +// [Guidelines and quotas]: https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html package comprehendmedical diff --git a/service/comprehendmedical/options.go b/service/comprehendmedical/options.go index 35f3814474e..37610a3e122 100644 --- a/service/comprehendmedical/options.go +++ b/service/comprehendmedical/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/comprehendmedical/types/enums.go b/service/comprehendmedical/types/enums.go index 4ba6eda0fea..980497edf7c 100644 --- a/service/comprehendmedical/types/enums.go +++ b/service/comprehendmedical/types/enums.go @@ -18,8 +18,9 @@ const ( ) // Values returns all known values for AttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeName) Values() []AttributeName { return []AttributeName{ "SIGN", @@ -86,8 +87,9 @@ const ( ) // Values returns all known values for EntitySubType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntitySubType) Values() []EntitySubType { return []EntitySubType{ "NAME", @@ -152,8 +154,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "MEDICATION", @@ -180,8 +183,9 @@ const ( ) // Values returns all known values for ICD10CMAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ICD10CMAttributeType) Values() []ICD10CMAttributeType { return []ICD10CMAttributeType{ "ACUITY", @@ -202,8 +206,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MEDICAL_CONDITION", @@ -219,8 +224,9 @@ const ( ) // Values returns all known values for ICD10CMEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ICD10CMEntityType) Values() []ICD10CMEntityType { return []ICD10CMEntityType{ "DX_NAME", @@ -238,8 +244,9 @@ const ( ) // Values returns all known values for ICD10CMRelationshipType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ICD10CMRelationshipType) Values() []ICD10CMRelationshipType { return []ICD10CMRelationshipType{ "OVERLAP", @@ -262,8 +269,9 @@ const ( ) // Values returns all known values for ICD10CMTraitName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ICD10CMTraitName) Values() []ICD10CMTraitName { return []ICD10CMTraitName{ "NEGATION", @@ -290,8 +298,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -312,8 +321,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -349,8 +359,9 @@ const ( ) // Values returns all known values for RelationshipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationshipType) Values() []RelationshipType { return []RelationshipType{ "EVERY", @@ -392,8 +403,9 @@ const ( ) // Values returns all known values for RxNormAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RxNormAttributeType) Values() []RxNormAttributeType { return []RxNormAttributeType{ "DOSAGE", @@ -414,8 +426,9 @@ const ( ) // Values returns all known values for RxNormEntityCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RxNormEntityCategory) Values() []RxNormEntityCategory { return []RxNormEntityCategory{ "MEDICATION", @@ -431,8 +444,9 @@ const ( ) // Values returns all known values for RxNormEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RxNormEntityType) Values() []RxNormEntityType { return []RxNormEntityType{ "BRAND_NAME", @@ -449,8 +463,9 @@ const ( ) // Values returns all known values for RxNormTraitName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RxNormTraitName) Values() []RxNormTraitName { return []RxNormTraitName{ "NEGATION", @@ -471,8 +486,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACUITY", @@ -494,8 +510,9 @@ const ( ) // Values returns all known values for SNOMEDCTEntityCategory. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SNOMEDCTEntityCategory) Values() []SNOMEDCTEntityCategory { return []SNOMEDCTEntityCategory{ "MEDICAL_CONDITION", @@ -515,8 +532,9 @@ const ( ) // Values returns all known values for SNOMEDCTEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SNOMEDCTEntityType) Values() []SNOMEDCTEntityType { return []SNOMEDCTEntityType{ "DX_NAME", @@ -541,6 +559,7 @@ const ( // 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{ @@ -570,8 +589,9 @@ const ( ) // Values returns all known values for SNOMEDCTTraitName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SNOMEDCTTraitName) Values() []SNOMEDCTTraitName { return []SNOMEDCTTraitName{ "NEGATION", diff --git a/service/comprehendmedical/types/errors.go b/service/comprehendmedical/types/errors.go index 77c0f549f5d..99da3fb8672 100644 --- a/service/comprehendmedical/types/errors.go +++ b/service/comprehendmedical/types/errors.go @@ -33,7 +33,8 @@ func (e *InternalServerException) ErrorCode() string { } func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The input text was not in valid UTF-8 character encoding. Check your text then +// The input text was not in valid UTF-8 character encoding. Check your text then +// // retry your request. type InvalidEncodingException struct { Message *string @@ -60,7 +61,8 @@ func (e *InvalidEncodingException) ErrorCode() string { } func (e *InvalidEncodingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request that you made is invalid. Check your request to determine why it's +// The request that you made is invalid. Check your request to determine why it's +// // invalid and then retry the request. type InvalidRequestException struct { Message *string @@ -114,7 +116,8 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The Amazon Comprehend Medical service is temporarily unavailable. Please wait +// The Amazon Comprehend Medical service is temporarily unavailable. Please wait +// // and then retry your request. type ServiceUnavailableException struct { Message *string @@ -141,7 +144,8 @@ func (e *ServiceUnavailableException) ErrorCode() string { } func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// The size of the text you submitted exceeds the size limit. Reduce the size of +// The size of the text you submitted exceeds the size limit. Reduce the size of +// // the text or use a smaller document and then retry your request. type TextSizeLimitExceededException struct { Message *string @@ -168,8 +172,9 @@ func (e *TextSizeLimitExceededException) ErrorCode() string { } func (e *TextSizeLimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have made too many requests within a short period of time. Wait for a short -// time and then try your request again. Contact customer support for more +// You have made too many requests within a short period of time. Wait for a +// +// short time and then try your request again. Contact customer support for more // information about a service limit increase. type TooManyRequestsException struct { Message *string diff --git a/service/comprehendmedical/types/types.go b/service/comprehendmedical/types/types.go index 7be389f9fc2..280177936d5 100644 --- a/service/comprehendmedical/types/types.go +++ b/service/comprehendmedical/types/types.go @@ -7,28 +7,29 @@ import ( "time" ) -// An extracted segment of the text that is an attribute of an entity, or +// 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 + // 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. + // The category of attribute. Category EntityType - // The 0-based character offset in the input text that shows where the attribute + // 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 + // 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 + // The level of confidence that Amazon Comprehend Medical has that this attribute // is correctly related to this entity. RelationshipScore *float32 @@ -37,17 +38,17 @@ type Attribute struct { // as the Date_Expression . RelationshipType RelationshipType - // The level of confidence that Amazon Comprehend Medical has that the segment of + // The level of confidence that Amazon 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. + // The segment of input text extracted as this attribute. Text *string - // Contextual information for this attribute. + // Contextual information for this attribute. Traits []Trait - // The type of attribute. + // The type of attribute. Type EntitySubType noSmithyDocumentSerde @@ -56,7 +57,7 @@ type Attribute struct { // The number of characters in the input text to be analyzed. type Characters struct { - // The number of characters present in the input text document as processed by + // The number of characters present in the input text document as processed by // Amazon Comprehend Medical. OriginalTextCharacters *int32 @@ -146,21 +147,21 @@ type ComprehendMedicalAsyncJobProperties struct { // Provides information about an extracted medical entity. type Entity struct { - // The extracted attributes that relate to this entity. + // The extracted attributes that relate to this entity. Attributes []Attribute - // The 0-based character offset in the input text that shows where the entity + // 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 category of the entity. Category EntityType - // The 0-based character offset in the input text that shows where the entity + // 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 + // The numeric identifier for the entity. This is a monotonically increasing id // unique within this response rather than a global unique identifier. Id *int32 @@ -168,13 +169,13 @@ type Entity struct { // the detection. Score *float32 - // The segment of input text extracted as this entity. + // The segment of input text extracted as this entity. Text *string // Contextual information for the entity. Traits []Trait - // Describes the specific type of entity with category of entities. + // Describes the specific type of entity with category of entities. Type EntitySubType noSmithyDocumentSerde @@ -226,7 +227,8 @@ type ICD10CMAttribute struct { noSmithyDocumentSerde } -// The ICD-10-CM concepts that the entity could refer to, along with a score +// The ICD-10-CM concepts that the entity could refer to, along with a score +// // indicating the likelihood of the match. type ICD10CMConcept struct { @@ -260,7 +262,7 @@ type ICD10CMEntity struct { // begins. The offset returns the UTF-8 code point in the string. BeginOffset *int32 - // The category of the entity. InferICD10CM detects entities in the + // The category of the entity. InferICD10CM detects entities in the // MEDICAL_CONDITION category. Category ICD10CMEntityCategory @@ -440,7 +442,7 @@ type RxNormEntity struct { // Contextual information for the entity. Traits []RxNormTrait - // Describes the specific type of entity. For InferRxNorm, the recognized entity + // Describes the specific type of entity. For InferRxNorm, the recognized entity // type is MEDICATION . Type RxNormEntityType @@ -461,51 +463,52 @@ type RxNormTrait struct { noSmithyDocumentSerde } -// The extracted attributes that relate to an entity. An extracted segment of the +// The extracted attributes that relate to an entity. 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. type SNOMEDCTAttribute struct { - // The 0-based character offset in the input text that shows where the attribute + // 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 the detected attribute. Possible categories include + // The category of the detected attribute. Possible categories include // MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE. Category SNOMEDCTEntityCategory - // The 0-based character offset in the input text that shows where the attribute + // 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 + // 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 + // The level of confidence that Amazon Comprehend Medical has that this attribute // is correctly related to this entity. RelationshipScore *float32 - // The type of relationship that exists between the entity and the related + // The type of relationship that exists between the entity and the related // attribute. RelationshipType SNOMEDCTRelationshipType - // The SNOMED-CT concepts specific to an attribute, along with a score indicating + // The SNOMED-CT concepts specific to an attribute, along with a score indicating // the likelihood of the match. SNOMEDCTConcepts []SNOMEDCTConcept - // The level of confidence that Amazon Comprehend Medical has that the segment of + // The level of confidence that Amazon 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. + // The segment of input text extracted as this attribute. Text *string - // Contextual information for an attribute. Examples include signs, symptoms, + // Contextual information for an attribute. Examples include signs, symptoms, // diagnosis, and negation. Traits []SNOMEDCTTrait - // The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, + // The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, // SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and // TREATMENT_NAME. Type SNOMEDCTAttributeType @@ -513,86 +516,89 @@ type SNOMEDCTAttribute struct { noSmithyDocumentSerde } -// The SNOMED-CT concepts that the entity could refer to, along with a score +// The SNOMED-CT concepts that the entity could refer to, along with a score +// // indicating the likelihood of the match. type SNOMEDCTConcept struct { - // The numeric ID for the SNOMED-CT concept. + // The numeric ID for the SNOMED-CT concept. Code *string - // The description of the SNOMED-CT concept. + // The description of the SNOMED-CT concept. Description *string - // The level of confidence Amazon Comprehend Medical has that the entity should be - // linked to the identified SNOMED-CT concept. + // The level of confidence Amazon Comprehend Medical has that the entity should + // be linked to the identified SNOMED-CT concept. Score *float32 noSmithyDocumentSerde } -// The information about the revision of the SNOMED-CT ontology in the response. +// The information about the revision of the SNOMED-CT ontology in the response. +// // Specifically, the details include the SNOMED-CT edition, language, and version // date. type SNOMEDCTDetails struct { - // The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions + // The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions // is the US edition. Edition *string - // The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical + // The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical // operations are US English (en). Language *string - // The version date of the SNOMED-CT ontology used. + // The version date of the SNOMED-CT ontology used. VersionDate *string noSmithyDocumentSerde } -// The collection of medical entities extracted from the input text and their +// The collection of medical entities extracted from the input text and their +// // associated information. For each entity, the response provides the entity text, // the entity category, where the entity text begins and ends, and the level of // confidence that Amazon Comprehend Medical has in the detection and analysis. // Attributes 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 + // 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 + // 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 detected entity. Possible categories are MEDICAL_CONDITION, - // ANATOMY, or TEST_TREATMENT_PROCEDURE. + // The category of the detected entity. Possible categories are + // MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE. Category SNOMEDCTEntityCategory - // The 0-based character offset in the input text that shows where the entity + // 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 + // The numeric identifier for the entity. This is a monotonically increasing id // unique within this response rather than a global unique identifier. Id *int32 - // The SNOMED concepts that the entity could refer to, along with a score + // The SNOMED concepts that the entity could refer to, along with a score // indicating the likelihood of the match. SNOMEDCTConcepts []SNOMEDCTConcept - // The level of confidence that Amazon Comprehend Medical has in the accuracy of + // The level of confidence that Amazon Comprehend Medical has in the accuracy of // the detected entity. Score *float32 - // The segment of input text extracted as this entity. + // The segment of input text extracted as this entity. Text *string - // Contextual information for the entity. + // Contextual information for the entity. Traits []SNOMEDCTTrait - // Describes the specific type of entity with category of entities. Possible types - // include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, - // TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. + // Describes the specific type of entity with category of entities. Possible + // types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, + // TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. Type SNOMEDCTEntityType noSmithyDocumentSerde @@ -601,11 +607,11 @@ type SNOMEDCTEntity struct { // Contextual information for an entity. type SNOMEDCTTrait struct { - // The name or contextual description of a detected trait. + // The name or contextual description of a detected trait. Name SNOMEDCTTraitName - // The level of confidence that Amazon Comprehend Medical has in the accuracy of a - // detected trait. + // The level of confidence that Amazon Comprehend Medical has in the accuracy of + // a detected trait. Score *float32 noSmithyDocumentSerde @@ -614,10 +620,10 @@ type SNOMEDCTTrait struct { // Provides contextual information about the extracted entity. type Trait struct { - // Provides a name or contextual description about the trait. + // Provides a name or contextual description about the trait. Name AttributeName - // The level of confidence that Amazon Comprehend Medical has in the accuracy of + // The level of confidence that Amazon Comprehend Medical has in the accuracy of // this trait. Score *float32 @@ -628,10 +634,10 @@ type Trait struct { // relate to an entity. type UnmappedAttribute struct { - // The specific attribute that has been extracted but not mapped to an entity. + // The specific attribute that has been extracted but not mapped to an entity. Attribute *Attribute - // The type of the unmapped attribute, could be one of the following values: + // The type of the unmapped attribute, could be one of the following values: // "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or // "PROTECTED_HEALTH_INFORMATION". Type EntityType diff --git a/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go b/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go index 3a57202f92d..3a1f5eea0ec 100644 --- a/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_DeleteRecommendationPreferences.go @@ -12,8 +12,10 @@ 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) -// in the Compute Optimizer User Guide. +// +// For more information, see [Activating enhanced infrastructure metrics] in the Compute Optimizer User Guide. +// +// [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html func (c *Client) DeleteRecommendationPreferences(ctx context.Context, params *DeleteRecommendationPreferencesInput, optFns ...func(*Options)) (*DeleteRecommendationPreferencesOutput, error) { if params == nil { params = &DeleteRecommendationPreferencesInput{} @@ -36,21 +38,24 @@ type DeleteRecommendationPreferencesInput struct { // This member is required. RecommendationPreferenceNames []types.RecommendationPreferenceName - // The target resource type of the recommendation preference to delete. 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 . + // The target resource type of the recommendation preference to delete. + // + // 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 . // // This member is required. ResourceType types.ResourceType // An object that describes the scope of the recommendation preference to delete. + // // 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) - // in the Compute Optimizer User Guide. + // resource level. For more information, see [Activating enhanced infrastructure metrics]in the Compute Optimizer User Guide. + // + // [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html Scope *types.Scope noSmithyDocumentSerde diff --git a/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go b/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go index 19eea0721dc..87e0f2f2464 100644 --- a/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go +++ b/service/computeoptimizer/api_op_DescribeRecommendationExportJobs.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes recommendation export jobs created in the last seven days. Use the -// ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations -// actions to request an export of your recommendations. Then use the -// DescribeRecommendationExportJobs action to view your export jobs. +// Describes recommendation export jobs created in the last seven days. +// +// Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs +// action to view your export jobs. func (c *Client) DescribeRecommendationExportJobs(ctx context.Context, params *DescribeRecommendationExportJobsInput, optFns ...func(*Options)) (*DescribeRecommendationExportJobsOutput, error) { if params == nil { params = &DescribeRecommendationExportJobsInput{} @@ -36,15 +36,18 @@ type DescribeRecommendationExportJobsInput struct { // export jobs. Filters []types.JobFilter - // The identification numbers of the export jobs to return. An export job ID is - // returned when you create an export using the - // ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations - // actions. All export jobs created in the last seven days are returned if this - // parameter is omitted. + // The identification numbers of the export jobs to return. + // + // An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions. + // + // All export jobs created in the last seven days are returned if this parameter + // is omitted. JobIds []string - // The maximum number of export jobs to return with a single request. To retrieve - // the remaining results, make another request with the returned nextToken value. + // The maximum number of export jobs 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 export jobs. @@ -55,8 +58,9 @@ type DescribeRecommendationExportJobsInput struct { type DescribeRecommendationExportJobsOutput struct { - // The token to use to advance to the next page of export jobs. This value is null - // when there are no more pages of export jobs to return. + // The token to use to advance to the next page of export jobs. + // + // This value is null when there are no more pages of export jobs to return. NextToken *string // An array of objects that describe recommendation export jobs. @@ -155,8 +159,10 @@ var _ DescribeRecommendationExportJobsAPIClient = (*Client)(nil) // DescribeRecommendationExportJobsPaginatorOptions is the paginator options for // DescribeRecommendationExportJobs type DescribeRecommendationExportJobsPaginatorOptions struct { - // The maximum number of export jobs to return with a single request. To retrieve - // the remaining results, make another request with the returned nextToken value. + // The maximum number of export jobs to return with a single request. + // + // To retrieve the remaining results, make another 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/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go b/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go index c8fa8d4c502..617326f4616 100644 --- a/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go +++ b/service/computeoptimizer/api_op_ExportAutoScalingGroupRecommendations.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports optimization recommendations for Auto Scaling groups. 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) -// in the Compute Optimizer User Guide. You can have only one Auto Scaling group -// export job in progress per Amazon Web Services Region. +// Exports optimization recommendations for Auto Scaling groups. +// +// 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]in the Compute Optimizer User Guide. +// +// You can have only one Auto Scaling group export job in progress per Amazon Web +// Services Region. +// +// [Exporting Recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html func (c *Client) ExportAutoScalingGroupRecommendations(ctx context.Context, params *ExportAutoScalingGroupRecommendationsInput, optFns ...func(*Options)) (*ExportAutoScalingGroupRecommendationsOutput, error) { if params == nil { params = &ExportAutoScalingGroupRecommendationsInput{} @@ -36,36 +40,46 @@ func (c *Client) ExportAutoScalingGroupRecommendations(ctx context.Context, para type ExportAutoScalingGroupRecommendationsInput struct { // An object to specify the destination Amazon Simple Storage Service (Amazon S3) - // bucket name and key prefix for the export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // 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 Compute Optimizer User Guide. + // bucket name and key prefix for the export job. + // + // You must create the destination Amazon S3 bucket for your recommendations + // export before you create the export job. Compute Optimizer does not create the + // S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. + // + // [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html // // This member is required. S3DestinationConfig *types.S3DestinationConfig // The IDs of the Amazon Web Services accounts for which to export 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 export recommendations. This parameter cannot be specified together with - // the include member accounts parameter. The parameters are mutually exclusive. + // 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 export + // recommendations. + // + // This parameter cannot be specified together with the include member accounts + // parameter. The parameters are mutually exclusive. + // // Recommendations for member accounts are not included in the export if this - // parameter, or the include member accounts parameter, is omitted. You can specify - // multiple account IDs per request. + // parameter, or the include member accounts parameter, is omitted. + // + // You can specify multiple account IDs per request. 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) - // in the Compute Optimizer User Guide. + // about the fields that can be exported, see [Exported files]in the Compute Optimizer User Guide. + // + // [Exported files]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files FieldsToExport []types.ExportableAutoScalingGroupField - // The format of the export file. The only export file format currently supported - // is Csv . + // The format of the export file. + // + // The only export file format currently supported is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -74,16 +88,22 @@ type ExportAutoScalingGroupRecommendationsInput struct { // Indicates whether to include recommendations for resources in all member // accounts of the organization if your account is the management account of an - // 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) - // 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. + // 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]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 - // parameters are mutually exclusive. Recommendations for member accounts are not - // included in the export if this parameter, or the account IDs parameter, is - // omitted. + // parameters are mutually exclusive. + // + // Recommendations for member accounts are not included in the export if this + // parameter, or the account IDs parameter, is omitted. + // + // [Compute Optimizer and Amazon Web Services Organizations trusted access]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access IncludeMemberAccounts bool // An object to specify the preferences for the Auto Scaling group recommendations @@ -95,9 +115,9 @@ type ExportAutoScalingGroupRecommendationsInput struct { type ExportAutoScalingGroupRecommendationsOutput struct { - // The identification number of the export job. Use the - // DescribeRecommendationExportJobs action, and specify the job ID to view the - // status of an export job. + // The identification number of the export job. + // + // Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job. JobId *string // An object that describes the destination Amazon S3 bucket of a recommendations diff --git a/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go b/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go index 15472fb6b4d..57defe57b2b 100644 --- a/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go +++ b/service/computeoptimizer/api_op_ExportEBSVolumeRecommendations.go @@ -11,13 +11,17 @@ 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 -// 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) -// in the Compute Optimizer User Guide. You can have only one Amazon EBS volume -// export job in progress per Amazon Web Services Region. +// 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]in the Compute Optimizer User Guide. +// +// You can have only one Amazon EBS volume export job in progress per Amazon Web +// Services Region. +// +// [Exporting Recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html func (c *Client) ExportEBSVolumeRecommendations(ctx context.Context, params *ExportEBSVolumeRecommendationsInput, optFns ...func(*Options)) (*ExportEBSVolumeRecommendationsOutput, error) { if params == nil { params = &ExportEBSVolumeRecommendationsInput{} @@ -36,36 +40,46 @@ func (c *Client) ExportEBSVolumeRecommendations(ctx context.Context, params *Exp type ExportEBSVolumeRecommendationsInput struct { // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name - // and key prefix for a recommendations export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // 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 Compute Optimizer User Guide. + // and key prefix for a recommendations export job. + // + // You must create the destination Amazon S3 bucket for your recommendations + // export before you create the export job. Compute Optimizer does not create the + // S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. + // + // [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html // // This member is required. S3DestinationConfig *types.S3DestinationConfig // The IDs of the Amazon Web Services accounts for which to export Amazon EBS - // volume recommendations. If your account is the management account of an - // organization, use this parameter to specify the member account for which you - // want to export recommendations. This parameter cannot be specified together with - // the include member accounts parameter. The parameters are mutually exclusive. + // volume recommendations. + // + // If your account is the management account of an organization, use this + // parameter to specify the member account for which you want to export + // recommendations. + // + // This parameter cannot be specified together with the include member accounts + // parameter. The parameters are mutually exclusive. + // // Recommendations for member accounts are not included in the export if this - // parameter, or the include member accounts parameter, is omitted. You can specify - // multiple account IDs per request. + // parameter, or the include member accounts parameter, is omitted. + // + // You can specify multiple account IDs per request. 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) - // in the Compute Optimizer User Guide. + // about the fields that can be exported, see [Exported files]in the Compute Optimizer User Guide. + // + // [Exported files]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files FieldsToExport []types.ExportableVolumeField - // The format of the export file. The only export file format currently supported - // is Csv . + // The format of the export file. + // + // The only export file format currently supported is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -74,16 +88,22 @@ type ExportEBSVolumeRecommendationsInput struct { // Indicates whether to include recommendations for resources in all member // accounts of the organization if your account is the management account of an - // 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) - // 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. + // 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]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 - // parameters are mutually exclusive. Recommendations for member accounts are not - // included in the export if this parameter, or the account IDs parameter, is - // omitted. + // parameters are mutually exclusive. + // + // Recommendations for member accounts are not included in the export if this + // parameter, or the account IDs parameter, is omitted. + // + // [Compute Optimizer and Amazon Web Services Organizations trusted access]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access IncludeMemberAccounts bool noSmithyDocumentSerde @@ -91,9 +111,9 @@ type ExportEBSVolumeRecommendationsInput struct { type ExportEBSVolumeRecommendationsOutput struct { - // The identification number of the export job. Use the - // DescribeRecommendationExportJobs action, and specify the job ID to view the - // status of an export job. + // The identification number of the export job. + // + // Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job. JobId *string // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name diff --git a/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go b/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go index c62bd8f126a..b1cd64b4ea1 100644 --- a/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go +++ b/service/computeoptimizer/api_op_ExportEC2InstanceRecommendations.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports optimization recommendations for Amazon EC2 instances. 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) -// in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance -// export job in progress per Amazon Web Services Region. +// Exports optimization recommendations for Amazon EC2 instances. +// +// 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]in the Compute Optimizer User Guide. +// +// You can have only one Amazon EC2 instance export job in progress per Amazon Web +// Services Region. +// +// [Exporting Recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html func (c *Client) ExportEC2InstanceRecommendations(ctx context.Context, params *ExportEC2InstanceRecommendationsInput, optFns ...func(*Options)) (*ExportEC2InstanceRecommendationsOutput, error) { if params == nil { params = &ExportEC2InstanceRecommendationsInput{} @@ -36,36 +40,46 @@ func (c *Client) ExportEC2InstanceRecommendations(ctx context.Context, params *E type ExportEC2InstanceRecommendationsInput struct { // An object to specify the destination Amazon Simple Storage Service (Amazon S3) - // bucket name and key prefix for the export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // 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 Compute Optimizer User Guide. + // bucket name and key prefix for the export job. + // + // You must create the destination Amazon S3 bucket for your recommendations + // export before you create the export job. Compute Optimizer does not create the + // S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. + // + // [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html // // This member is required. S3DestinationConfig *types.S3DestinationConfig // The IDs of the Amazon Web Services accounts for which to export instance - // recommendations. If your account is the management account of an organization, - // use this parameter to specify the member account for which you want to export - // recommendations. This parameter cannot be specified together with the include - // member accounts parameter. The parameters are mutually exclusive. + // recommendations. + // + // If your account is the management account of an organization, use this + // parameter to specify the member account for which you want to export + // recommendations. + // + // This parameter cannot be specified together with the include member accounts + // parameter. The parameters are mutually exclusive. + // // Recommendations for member accounts are not included in the export if this - // parameter, or the include member accounts parameter, is omitted. You can specify - // multiple account IDs per request. + // parameter, or the include member accounts parameter, is omitted. + // + // You can specify multiple account IDs per request. 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) - // in the Compute Optimizer User Guide. + // about the fields that can be exported, see [Exported files]in the Compute Optimizer User Guide. + // + // [Exported files]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files FieldsToExport []types.ExportableInstanceField - // The format of the export file. The only export file format currently supported - // is Csv . + // The format of the export file. + // + // The only export file format currently supported is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -74,14 +88,19 @@ type ExportEC2InstanceRecommendationsInput struct { // Indicates whether to include recommendations for resources in all member // accounts of the organization if your account is the management account of an - // 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) - // 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. + // 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]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. + // + // [Compute Optimizer and Amazon Web Services Organizations trusted access]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access IncludeMemberAccounts bool // An object to specify the preferences for the Amazon EC2 instance @@ -93,9 +112,9 @@ type ExportEC2InstanceRecommendationsInput struct { type ExportEC2InstanceRecommendationsOutput struct { - // The identification number of the export job. Use the - // DescribeRecommendationExportJobs action, and specify the job ID to view the - // status of an export job. + // The identification number of the export job. + // + // Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job. JobId *string // An object that describes the destination Amazon S3 bucket of a recommendations diff --git a/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go b/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go index 2002476e82b..d26bd5ffc11 100644 --- a/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go +++ b/service/computeoptimizer/api_op_ExportECSServiceRecommendations.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports optimization recommendations for Amazon ECS services on Fargate. +// 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) -// in the Compute Optimizer User Guide. You can only have one Amazon ECS service -// export job in progress per Amazon Web Services Region. +// For more information, see [Exporting Recommendations]in the Compute Optimizer User Guide. +// +// You can only have one Amazon ECS service export job in progress per Amazon Web +// Services Region. +// +// [Exporting Recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html func (c *Client) ExportECSServiceRecommendations(ctx context.Context, params *ExportECSServiceRecommendationsInput, optFns ...func(*Options)) (*ExportECSServiceRecommendationsOutput, error) { if params == nil { params = &ExportECSServiceRecommendationsInput{} @@ -35,52 +39,67 @@ func (c *Client) ExportECSServiceRecommendations(ctx context.Context, params *Ex type ExportECSServiceRecommendationsInput struct { // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name - // and key prefix for a recommendations export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // 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 Compute Optimizer User Guide. + // and key prefix for a recommendations export job. + // + // You must create the destination Amazon S3 bucket for your recommendations + // export before you create the export job. Compute Optimizer does not create the + // S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. + // + // [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html // // This member is required. S3DestinationConfig *types.S3DestinationConfig - // The Amazon Web Services account IDs for the export Amazon ECS service - // recommendations. If your account is the management account or the delegated - // administrator of an organization, use this parameter to specify the member - // account you want to export recommendations to. This parameter can't be specified - // together with the include member accounts parameter. The parameters are mutually - // exclusive. If this parameter or the include member accounts parameter is - // omitted, the recommendations for member accounts aren't included in the export. + // The Amazon Web Services account IDs for the export Amazon ECS service + // recommendations. + // + // If your account is the management account or the delegated administrator of an + // organization, use this parameter to specify the member account you want to + // export recommendations to. + // + // This parameter can't be specified together with the include member accounts + // parameter. The parameters are mutually exclusive. + // + // If this parameter or the include member accounts parameter is omitted, the + // recommendations for member accounts aren't included in the export. + // // You can specify multiple account IDs per request. 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) - // in the Compute Optimizer User Guide. + // about the fields that can be exported, see [Exported files]in the Compute Optimizer User Guide. + // + // [Exported files]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files FieldsToExport []types.ExportableECSServiceField - // The format of the export file. The CSV file is the only export file format - // currently supported. + // The format of the export file. + // + // The CSV file is the only export file format currently supported. FileFormat types.FileFormat - // An array of objects to specify a filter that exports a more specific set of + // An array of objects to specify a filter that exports a more specific set of // Amazon ECS service recommendations. Filters []types.ECSServiceRecommendationFilter // If your account is the management account or the delegated administrator of an // organization, this parameter indicates whether to include recommendations for - // 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) - // 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, - // recommendations for member accounts aren't included in the export. + // 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]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, recommendations for + // member accounts aren't included in the export. + // + // [Compute Optimizer and Amazon Web Services Organizations trusted access]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access IncludeMemberAccounts bool noSmithyDocumentSerde @@ -88,8 +107,9 @@ type ExportECSServiceRecommendationsInput struct { type ExportECSServiceRecommendationsOutput struct { - // The identification number of the export job. To view the status of an export - // job, use the DescribeRecommendationExportJobs action and specify the job ID. + // The identification number of the export job. + // + // To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID. JobId *string // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name diff --git a/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go b/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go index 8e9d5f4166b..88e9eb6325c 100644 --- a/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go +++ b/service/computeoptimizer/api_op_ExportLambdaFunctionRecommendations.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports optimization recommendations for Lambda functions. 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) -// in the Compute Optimizer User Guide. You can have only one Lambda function -// export job in progress per Amazon Web Services Region. +// Exports optimization recommendations for Lambda functions. +// +// 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]in the Compute Optimizer User Guide. +// +// You can have only one Lambda function export job in progress per Amazon Web +// Services Region. +// +// [Exporting Recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html func (c *Client) ExportLambdaFunctionRecommendations(ctx context.Context, params *ExportLambdaFunctionRecommendationsInput, optFns ...func(*Options)) (*ExportLambdaFunctionRecommendationsOutput, error) { if params == nil { params = &ExportLambdaFunctionRecommendationsInput{} @@ -36,36 +40,46 @@ func (c *Client) ExportLambdaFunctionRecommendations(ctx context.Context, params type ExportLambdaFunctionRecommendationsInput struct { // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name - // and key prefix for a recommendations export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // 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 Compute Optimizer User Guide. + // and key prefix for a recommendations export job. + // + // You must create the destination Amazon S3 bucket for your recommendations + // export before you create the export job. Compute Optimizer does not create the + // S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. + // + // [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html // // This member is required. S3DestinationConfig *types.S3DestinationConfig // The IDs of the Amazon Web Services accounts for which to export Lambda function - // recommendations. If your account is the management account of an organization, - // use this parameter to specify the member account for which you want to export - // recommendations. This parameter cannot be specified together with the include - // member accounts parameter. The parameters are mutually exclusive. + // recommendations. + // + // If your account is the management account of an organization, use this + // parameter to specify the member account for which you want to export + // recommendations. + // + // This parameter cannot be specified together with the include member accounts + // parameter. The parameters are mutually exclusive. + // // Recommendations for member accounts are not included in the export if this - // parameter, or the include member accounts parameter, is omitted. You can specify - // multiple account IDs per request. + // parameter, or the include member accounts parameter, is omitted. + // + // You can specify multiple account IDs per request. 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) - // in the Compute Optimizer User Guide. + // about the fields that can be exported, see [Exported files]in the Compute Optimizer User Guide. + // + // [Exported files]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files FieldsToExport []types.ExportableLambdaFunctionField - // The format of the export file. The only export file format currently supported - // is Csv . + // The format of the export file. + // + // The only export file format currently supported is Csv . FileFormat types.FileFormat // An array of objects to specify a filter that exports a more specific set of @@ -74,16 +88,22 @@ type ExportLambdaFunctionRecommendationsInput struct { // Indicates whether to include recommendations for resources in all member // accounts of the organization if your account is the management account of an - // 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) - // 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. + // 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]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 - // parameters are mutually exclusive. Recommendations for member accounts are not - // included in the export if this parameter, or the account IDs parameter, is - // omitted. + // parameters are mutually exclusive. + // + // Recommendations for member accounts are not included in the export if this + // parameter, or the account IDs parameter, is omitted. + // + // [Compute Optimizer and Amazon Web Services Organizations trusted access]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access IncludeMemberAccounts bool noSmithyDocumentSerde @@ -91,9 +111,9 @@ type ExportLambdaFunctionRecommendationsInput struct { type ExportLambdaFunctionRecommendationsOutput struct { - // The identification number of the export job. Use the - // DescribeRecommendationExportJobs action, and specify the job ID to view the - // status of an export job. + // The identification number of the export job. + // + // Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job. JobId *string // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name diff --git a/service/computeoptimizer/api_op_ExportLicenseRecommendations.go b/service/computeoptimizer/api_op_ExportLicenseRecommendations.go index 1b677ba0887..366f173940c 100644 --- a/service/computeoptimizer/api_op_ExportLicenseRecommendations.go +++ b/service/computeoptimizer/api_op_ExportLicenseRecommendations.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Export optimization recommendations for your licenses. Recommendations are -// exported in a comma-separated values (CSV) file, and its metadata in a -// JavaScript Object Notation (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) -// in the Compute Optimizer User Guide. You can have only one license export job in -// progress per Amazon Web Services Region. +// Export optimization recommendations for your licenses. +// +// Recommendations are exported in a comma-separated values (CSV) file, and its +// metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon +// Simple Storage Service (Amazon S3) bucket that you specify. For more +// information, see [Exporting Recommendations]in the Compute Optimizer User Guide. +// +// You can have only one license export job in progress per Amazon Web Services +// Region. +// +// [Exporting Recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html func (c *Client) ExportLicenseRecommendations(ctx context.Context, params *ExportLicenseRecommendationsInput, optFns ...func(*Options)) (*ExportLicenseRecommendationsOutput, error) { if params == nil { params = &ExportLicenseRecommendationsInput{} @@ -36,51 +40,67 @@ func (c *Client) ExportLicenseRecommendations(ctx context.Context, params *Expor type ExportLicenseRecommendationsInput struct { // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name - // and key prefix for a recommendations export job. You must create the destination - // Amazon S3 bucket for your recommendations export before you create the export - // job. Compute Optimizer does not create the S3 bucket for you. After you create - // 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 Compute Optimizer User Guide. + // and key prefix for a recommendations export job. + // + // You must create the destination Amazon S3 bucket for your recommendations + // export before you create the export job. Compute Optimizer does not create the + // S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. + // + // [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html // // This member is required. S3DestinationConfig *types.S3DestinationConfig // The IDs of the Amazon Web Services accounts for which to export license - // recommendations. If your account is the management account of an organization, - // use this parameter to specify the member account for which you want to export - // recommendations. This parameter can't be specified together with the include - // member accounts parameter. The parameters are mutually exclusive. If this - // parameter is omitted, recommendations for member accounts aren't included in the - // export. You can specify multiple account IDs per request. + // recommendations. + // + // If your account is the management account of an organization, use this + // parameter to specify the member account for which you want to export + // recommendations. + // + // This parameter can't be specified together with the include member accounts + // parameter. The parameters are mutually exclusive. + // + // If this parameter is omitted, recommendations for member accounts aren't + // included in the export. + // + // You can specify multiple account IDs per request. 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) - // in the Compute Optimizer User Guide. + // about the fields that can be exported, see [Exported files]in the Compute Optimizer User Guide. + // + // [Exported files]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files FieldsToExport []types.ExportableLicenseField - // The format of the export file. A CSV file is the only export format currently - // supported. + // The format of the export file. + // + // A CSV file is the only export format currently supported. FileFormat types.FileFormat - // An array of objects to specify a filter that exports a more specific set of + // An array of objects to specify a filter that exports a more specific set of // license recommendations. Filters []types.LicenseRecommendationFilter // Indicates whether to include recommendations for resources in all member // accounts of the organization if your account is the management account of an - // 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) - // 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 . This parameter cannot be specified together with the account IDs - // parameter. The parameters are mutually exclusive. + // 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]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 . + // + // This parameter cannot be specified together with the account IDs parameter. The + // parameters are mutually exclusive. + // + // [Compute Optimizer and Amazon Web Services Organizations trusted access]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access IncludeMemberAccounts bool noSmithyDocumentSerde @@ -88,8 +108,9 @@ type ExportLicenseRecommendationsInput struct { type ExportLicenseRecommendationsOutput struct { - // The identification number of the export job. To view the status of an export - // job, use the DescribeRecommendationExportJobs action and specify the job ID. + // The identification number of the export job. + // + // To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID. JobId *string // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name diff --git a/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go b/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go index 6644ab6de34..f4bd0872ea8 100644 --- a/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go +++ b/service/computeoptimizer/api_op_GetAutoScalingGroupRecommendations.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the +// Compute Optimizer User Guide. +// +// [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html func (c *Client) GetAutoScalingGroupRecommendations(ctx context.Context, params *GetAutoScalingGroupRecommendationsInput, optFns ...func(*Options)) (*GetAutoScalingGroupRecommendationsOutput, error) { if params == nil { params = &GetAutoScalingGroupRecommendationsInput{} @@ -33,10 +36,13 @@ 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. + // 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 +54,10 @@ type GetAutoScalingGroupRecommendationsInput struct { 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 - // returned nextToken value. + // 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 Auto Scaling group recommendations. @@ -67,14 +75,17 @@ type GetAutoScalingGroupRecommendationsOutput struct { // An array of objects that describe Auto Scaling group recommendations. AutoScalingGroupRecommendations []types.AutoScalingGroupRecommendation - // An array of objects that describe errors of the request. For example, an error - // is returned if you request recommendations for an unsupported Auto Scaling - // group. + // An array of objects that describe errors of the request. + // + // For example, an error is returned if you request recommendations for an + // unsupported Auto Scaling group. Errors []types.GetRecommendationError // The token to use to advance to the next page of Auto Scaling group - // recommendations. This value is null when there are no more pages of Auto Scaling - // group recommendations to return. + // recommendations. + // + // This value is null when there are no more pages of Auto Scaling group + // recommendations to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go b/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go index dcab5a839df..32bf5a607f0 100644 --- a/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go +++ b/service/computeoptimizer/api_op_GetEBSVolumeRecommendations.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Compute +// Optimizer User Guide. +// +// [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html func (c *Client) GetEBSVolumeRecommendations(ctx context.Context, params *GetEBSVolumeRecommendationsInput, optFns ...func(*Options)) (*GetEBSVolumeRecommendationsOutput, error) { if params == nil { params = &GetEBSVolumeRecommendationsInput{} @@ -34,9 +36,13 @@ func (c *Client) GetEBSVolumeRecommendations(ctx context.Context, params *GetEBS type GetEBSVolumeRecommendationsInput struct { // The ID of the Amazon Web Services account for which to return volume - // 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 - // volume recommendations. Only one account ID can be specified per request. + // 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 volume + // recommendations. + // + // Only one account ID can be specified per request. AccountIds []string // An array of objects to specify a filter that returns a more specific list of @@ -44,6 +50,7 @@ type GetEBSVolumeRecommendationsInput struct { 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. MaxResults *int32 @@ -60,12 +67,16 @@ type GetEBSVolumeRecommendationsInput struct { type GetEBSVolumeRecommendationsOutput struct { - // An array of objects that describe errors of the request. For example, an error - // is returned if you request recommendations for an unsupported volume. + // An array of objects that describe errors of the request. + // + // For example, an error is returned if you request recommendations for an + // unsupported volume. Errors []types.GetRecommendationError - // The token to use to advance to the next page of volume recommendations. This - // value is null when there are no more pages of volume recommendations to return. + // The token to use to advance to the next page of volume recommendations. + // + // This value is null when there are no more pages of volume recommendations to + // return. NextToken *string // An array of objects that describe volume recommendations. diff --git a/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go b/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go index ca930c1daf7..32c6d10ffc0 100644 --- a/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go +++ b/service/computeoptimizer/api_op_GetEC2InstanceRecommendations.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Compute Optimizer User Guide. +// +// [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html func (c *Client) GetEC2InstanceRecommendations(ctx context.Context, params *GetEC2InstanceRecommendationsInput, optFns ...func(*Options)) (*GetEC2InstanceRecommendationsOutput, error) { if params == nil { params = &GetEC2InstanceRecommendationsInput{} @@ -34,9 +36,13 @@ func (c *Client) GetEC2InstanceRecommendations(ctx context.Context, params *GetE type GetEC2InstanceRecommendationsInput struct { // The ID of the Amazon Web Services account for which to return instance - // 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 - // instance recommendations. Only one account ID can be specified per request. + // 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 instance + // recommendations. + // + // Only one account ID can be specified per request. AccountIds []string // An array of objects to specify a filter that returns a more specific list of @@ -48,6 +54,7 @@ type GetEC2InstanceRecommendationsInput struct { InstanceArns []string // The maximum number of instance recommendations to return with a single request. + // // To retrieve the remaining results, make another request with the returned // nextToken value. MaxResults *int32 @@ -64,16 +71,18 @@ type GetEC2InstanceRecommendationsInput struct { type GetEC2InstanceRecommendationsOutput struct { - // An array of objects that describe errors of the request. For example, an error - // is returned if you request recommendations for an instance of an unsupported - // instance family. + // An array of objects that describe errors of the request. + // + // For example, an error is returned if you request recommendations for an + // instance of an unsupported instance family. Errors []types.GetRecommendationError // An array of objects that describe instance recommendations. InstanceRecommendations []types.InstanceRecommendation - // The token to use to advance to the next page of instance recommendations. This - // value is null when there are no more pages of instance recommendations to + // The token to use to advance to the next page of instance recommendations. + // + // This value is null when there are no more pages of instance recommendations to // return. NextToken *string diff --git a/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go b/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go index 7379ed54e6d..a095c61dc1e 100644 --- a/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go +++ b/service/computeoptimizer/api_op_GetEC2RecommendationProjectedMetrics.go @@ -13,12 +13,14 @@ import ( ) // Returns the projected utilization metrics of Amazon EC2 instance -// recommendations. The Cpu and Memory metrics are the only projected utilization -// 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) -// . +// recommendations. +// +// The Cpu and Memory metrics are the only projected utilization 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]. +// +// [Enabling Memory Utilization with the CloudWatch 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{} diff --git a/service/computeoptimizer/api_op_GetECSServiceRecommendationProjectedMetrics.go b/service/computeoptimizer/api_op_GetECSServiceRecommendationProjectedMetrics.go index da305eb1972..8fb457b8694 100644 --- a/service/computeoptimizer/api_op_GetECSServiceRecommendationProjectedMetrics.go +++ b/service/computeoptimizer/api_op_GetECSServiceRecommendationProjectedMetrics.go @@ -30,28 +30,31 @@ func (c *Client) GetECSServiceRecommendationProjectedMetrics(ctx context.Context type GetECSServiceRecommendationProjectedMetricsInput struct { - // The timestamp of the last projected metrics data point to return. + // The timestamp of the last projected metrics data point to return. // // This member is required. EndTime *time.Time - // The granularity, in seconds, of the projected metrics data points. + // The granularity, in seconds, of the projected metrics data points. // // This member is required. Period int32 - // The ARN that identifies the Amazon ECS service. The following is the format of - // the ARN: arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name + // The ARN that identifies the Amazon ECS service. + // + // The following is the format of the ARN: + // + // arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name // // This member is required. ServiceArn *string - // The timestamp of the first projected metrics data point to return. + // The timestamp of the first projected metrics data point to return. // // This member is required. StartTime *time.Time - // The statistic of the projected metrics. + // The statistic of the projected metrics. // // This member is required. Stat types.MetricStatistic @@ -61,7 +64,7 @@ type GetECSServiceRecommendationProjectedMetricsInput struct { type GetECSServiceRecommendationProjectedMetricsOutput struct { - // An array of objects that describes the projected metrics. + // An array of objects that describes the projected metrics. RecommendedOptionProjectedMetrics []types.ECSServiceRecommendedOptionProjectedMetric // Metadata pertaining to the operation's result. diff --git a/service/computeoptimizer/api_op_GetECSServiceRecommendations.go b/service/computeoptimizer/api_op_GetECSServiceRecommendations.go index 3b414e271d3..084eefd80d4 100644 --- a/service/computeoptimizer/api_op_GetECSServiceRecommendations.go +++ b/service/computeoptimizer/api_op_GetECSServiceRecommendations.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the +// Compute Optimizer User Guide. +// +// [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html func (c *Client) GetECSServiceRecommendations(ctx context.Context, params *GetECSServiceRecommendationsInput, optFns ...func(*Options)) (*GetECSServiceRecommendationsOutput, error) { if params == nil { params = &GetECSServiceRecommendationsInput{} @@ -32,27 +35,35 @@ func (c *Client) GetECSServiceRecommendations(ctx context.Context, params *GetEC type GetECSServiceRecommendationsInput struct { - // Return the Amazon ECS service recommendations to the specified Amazon Web - // Services account IDs. If your account is the management account or the delegated - // administrator of an organization, use this parameter to return the Amazon ECS - // service recommendations to specific member accounts. You can only specify one - // account ID per request. + // Return the Amazon ECS service recommendations to the specified Amazon Web + // Services account IDs. + // + // If your account is the management account or the delegated administrator of an + // organization, use this parameter to return the Amazon ECS service + // recommendations to specific member accounts. + // + // You can only specify one account ID per request. AccountIds []string - // An array of objects to specify a filter that returns a more specific list of + // An array of objects to specify a filter that returns a more specific list of // 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 - // returned nextToken value. + // 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 - // The token to advance to the next page of Amazon ECS service recommendations. + // The token to advance to the next page of Amazon ECS service recommendations. NextToken *string - // The ARN that identifies the Amazon ECS service. The following is the format of - // the ARN: arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name + // The ARN that identifies the Amazon ECS service. + // + // The following is the format of the ARN: + // + // arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name ServiceArns []string noSmithyDocumentSerde @@ -60,13 +71,13 @@ type GetECSServiceRecommendationsInput struct { type GetECSServiceRecommendationsOutput struct { - // An array of objects that describe the Amazon ECS service recommendations. + // An array of objects that describe the Amazon ECS service recommendations. EcsServiceRecommendations []types.ECSServiceRecommendation - // An array of objects that describe errors of the request. + // An array of objects that describe errors of the request. Errors []types.GetRecommendationError - // The token to advance to the next page of Amazon ECS service recommendations. + // The token to advance to the next page of Amazon ECS service recommendations. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go b/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go index 95be42c04e7..9e30b46d5d9 100644 --- a/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_GetEffectiveRecommendationPreferences.go @@ -13,9 +13,10 @@ import ( // Returns the recommendation preferences that are in effect for a given resource, // 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 +// 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 . func (c *Client) GetEffectiveRecommendationPreferences(ctx context.Context, params *GetEffectiveRecommendationPreferencesInput, optFns ...func(*Options)) (*GetEffectiveRecommendationPreferencesOutput, error) { if params == nil { @@ -48,51 +49,68 @@ 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 - // GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions. - // 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. + // 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 GetAutoScalingGroupRecommendationsand GetEC2InstanceRecommendations actions. + // + // For more information, see [Enhanced infrastructure metrics] in the Compute Optimizer User Guide. + // + // [Enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html EnhancedInfrastructureMetrics types.EnhancedInfrastructureMetrics // The provider of the external metrics recommendation preference. Considers all // applicable preferences that you might have set at the account and organization - // level. If the preference is applied in the latest recommendation refresh, an - // object with a valid source value appears in the response. If the preference - // isn't applied to the recommendations already, then this object doesn't appear in - // 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) - // in the Compute Optimizer User Guide. + // level. + // + // If the preference is applied in the latest recommendation refresh, an object + // with a valid source value appears in the response. If the preference isn't + // applied to the recommendations already, then this object doesn't appear in 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 GetEC2InstanceRecommendationsactions. + // + // For more information, see [Enhanced infrastructure metrics] in the Compute Optimizer User Guide. + // + // [Enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html ExternalMetricsPreference *types.ExternalMetricsPreference - // The number of days the utilization metrics of the Amazon Web Services resource - // are analyzed. To validate that the preference is applied to your last generated - // set of recommendations, review the effectiveRecommendationPreferences value in - // the response of the GetAutoScalingGroupRecommendations or + // The number of days the utilization metrics of the Amazon Web Services resource + // are analyzed. + // + // To validate that the preference is applied to your last generated set of + // recommendations, review the effectiveRecommendationPreferences value in the + // response of the GetAutoScalingGroupRecommendations or // GetEC2InstanceRecommendations actions. LookBackPeriod types.LookBackPeriodPreference - // The resource type values that are considered as candidates when generating + // The resource type values that are considered as candidates when generating // rightsizing recommendations. This object resolves any wildcard expressions and // returns the effective list of candidate resource type values. It also considers // all applicable preferences that you set at the resource, account, and - // organization level. To validate that the preference is applied to your last - // generated set of recommendations, review the effectiveRecommendationPreferences - // value in the response of the GetAutoScalingGroupRecommendations or + // organization level. + // + // To validate that the preference is applied to your last generated set of + // recommendations, review the effectiveRecommendationPreferences value in the + // response of the GetAutoScalingGroupRecommendations or // GetEC2InstanceRecommendations actions. PreferredResources []types.EffectivePreferredResource - // The resource’s CPU and memory utilization preferences, such as threshold and + // The resource’s CPU and memory utilization preferences, such as threshold and // headroom, that were used to generate rightsizing recommendations. It considers // all applicable preferences that you set at the resource, account, and - // organization level. To validate that the preference is applied to your last - // generated set of recommendations, review the effectiveRecommendationPreferences - // value in the response of the GetAutoScalingGroupRecommendations or + // organization level. + // + // To validate that the preference is applied to your last generated set of + // recommendations, review the effectiveRecommendationPreferences value in the + // response of the GetAutoScalingGroupRecommendations or // GetEC2InstanceRecommendations actions. UtilizationPreferences []types.UtilizationPreference diff --git a/service/computeoptimizer/api_op_GetEnrollmentStatus.go b/service/computeoptimizer/api_op_GetEnrollmentStatus.go index 751fa735d80..3088c8d7683 100644 --- a/service/computeoptimizer/api_op_GetEnrollmentStatus.go +++ b/service/computeoptimizer/api_op_GetEnrollmentStatus.go @@ -13,11 +13,12 @@ import ( ) // Returns the enrollment (opt in) status of an account to the Compute Optimizer -// service. If the account is the management account of an organization, this -// action also confirms the enrollment status of member accounts of the -// organization. Use the GetEnrollmentStatusesForOrganization action to get -// detailed information about the enrollment status of member accounts of an -// organization. +// service. +// +// If the account is the management account of an organization, this action also +// confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization +// action to get detailed information about the enrollment status of member +// accounts of an organization. func (c *Client) GetEnrollmentStatus(ctx context.Context, params *GetEnrollmentStatusInput, optFns ...func(*Options)) (*GetEnrollmentStatusOutput, error) { if params == nil { params = &GetEnrollmentStatusInput{} @@ -54,9 +55,10 @@ type GetEnrollmentStatusOutput struct { // The enrollment status of the account. Status types.Status - // The reason for the enrollment status of the account. 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 enrollment status of the account. + // + // 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 // Metadata pertaining to the operation's result. diff --git a/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go b/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go index 07560a481c1..e6e52255391 100644 --- a/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go +++ b/service/computeoptimizer/api_op_GetEnrollmentStatusesForOrganization.go @@ -12,8 +12,9 @@ import ( ) // Returns the Compute Optimizer enrollment (opt-in) status of organization member -// accounts, if your account is an organization management account. To get the -// enrollment status of standalone accounts, use the GetEnrollmentStatus action. +// accounts, if your account is an organization management account. +// +// To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action. func (c *Client) GetEnrollmentStatusesForOrganization(ctx context.Context, params *GetEnrollmentStatusesForOrganizationInput, optFns ...func(*Options)) (*GetEnrollmentStatusesForOrganizationOutput, error) { if params == nil { params = &GetEnrollmentStatusesForOrganizationInput{} @@ -36,9 +37,10 @@ type GetEnrollmentStatusesForOrganizationInput struct { Filters []types.EnrollmentFilter // The maximum number of account enrollment statuses to return with a single - // request. You can specify up to 100 statuses to return with each request. To - // retrieve the remaining results, make another request with the returned nextToken - // value. + // request. You can specify up to 100 statuses to return with each 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 account enrollment statuses. @@ -54,6 +56,7 @@ type GetEnrollmentStatusesForOrganizationOutput struct { AccountEnrollmentStatuses []types.AccountEnrollmentStatus // The token to use to advance to the next page of account enrollment statuses. + // // This value is null when there are no more pages of account enrollment statuses // to return. NextToken *string @@ -152,9 +155,10 @@ var _ GetEnrollmentStatusesForOrganizationAPIClient = (*Client)(nil) // for GetEnrollmentStatusesForOrganization type GetEnrollmentStatusesForOrganizationPaginatorOptions struct { // The maximum number of account enrollment statuses to return with a single - // request. You can specify up to 100 statuses to return with each request. To - // retrieve the remaining results, make another request with the returned nextToken - // value. + // request. You can specify up to 100 statuses to return with each request. + // + // To retrieve the remaining results, make another 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/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go b/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go index f018a8d11c8..1a2156da200 100644 --- a/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go +++ b/service/computeoptimizer/api_op_GetLambdaFunctionRecommendations.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Compute Optimizer +// User Guide. +// +// [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html func (c *Client) GetLambdaFunctionRecommendations(ctx context.Context, params *GetLambdaFunctionRecommendationsInput, optFns ...func(*Options)) (*GetLambdaFunctionRecommendationsOutput, error) { if params == nil { params = &GetLambdaFunctionRecommendationsInput{} @@ -33,9 +36,13 @@ func (c *Client) GetLambdaFunctionRecommendations(ctx context.Context, params *G type GetLambdaFunctionRecommendationsInput struct { // The ID of the Amazon Web Services account for which to return function - // 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 - // function recommendations. Only one account ID can be specified per request. + // 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 function + // recommendations. + // + // Only one account ID can be specified per request. AccountIds []string // An array of objects to specify a filter that returns a more specific list of @@ -43,16 +50,20 @@ type GetLambdaFunctionRecommendationsInput struct { Filters []types.LambdaFunctionRecommendationFilter // 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 + // 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 // 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) - // in the Lambda Developer Guide. + // using function versions, see [Using versions]in the Lambda Developer Guide. + // + // [Using versions]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using FunctionArns []string // The maximum number of function recommendations to return with a single request. + // // To retrieve the remaining results, make another request with the returned // nextToken value. MaxResults *int32 @@ -68,8 +79,9 @@ type GetLambdaFunctionRecommendationsOutput struct { // An array of objects that describe function recommendations. LambdaFunctionRecommendations []types.LambdaFunctionRecommendation - // The token to use to advance to the next page of function recommendations. This - // value is null when there are no more pages of function recommendations to + // The token to use to advance to the next page of function recommendations. + // + // This value is null when there are no more pages of function recommendations to // return. NextToken *string @@ -167,6 +179,7 @@ var _ GetLambdaFunctionRecommendationsAPIClient = (*Client)(nil) // GetLambdaFunctionRecommendations type GetLambdaFunctionRecommendationsPaginatorOptions struct { // The maximum number of function recommendations to return with a single request. + // // To retrieve the remaining results, make another request with the returned // nextToken value. Limit int32 diff --git a/service/computeoptimizer/api_op_GetLicenseRecommendations.go b/service/computeoptimizer/api_op_GetLicenseRecommendations.go index 6c67e6d02df..5c1c5258c10 100644 --- a/service/computeoptimizer/api_op_GetLicenseRecommendations.go +++ b/service/computeoptimizer/api_op_GetLicenseRecommendations.go @@ -12,10 +12,13 @@ import ( ) // Returns license recommendations for Amazon EC2 instances that run on a specific -// license. Compute Optimizer generates recommendations for licenses 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. +// license. +// +// Compute Optimizer generates recommendations for licenses that meet a specific +// set of requirements. For more information, see the [Supported resources and requirements]in the Compute Optimizer +// User Guide. +// +// [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html func (c *Client) GetLicenseRecommendations(ctx context.Context, params *GetLicenseRecommendationsInput, optFns ...func(*Options)) (*GetLicenseRecommendationsOutput, error) { if params == nil { params = &GetLicenseRecommendationsInput{} @@ -34,25 +37,33 @@ func (c *Client) GetLicenseRecommendations(ctx context.Context, params *GetLicen type GetLicenseRecommendationsInput struct { // The ID of the Amazon Web Services account for which to return license - // 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 - // license recommendations. Only one account ID can be specified per request. + // 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 license + // recommendations. + // + // Only one account ID can be specified per request. AccountIds []string - // An array of objects to specify a filter that returns a more specific list of + // An array of objects to specify a filter that returns a more specific list of // license recommendations. Filters []types.LicenseRecommendationFilter - // The maximum number of license recommendations to return with a single request. + // The maximum number of license 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 license recommendations. + // The token to advance to the next page of license recommendations. NextToken *string - // The ARN that identifies the Amazon EC2 instance. The following is the format of - // the ARN: arn:aws:ec2:region:aws_account_id:instance/instance-id + // The ARN that identifies the Amazon EC2 instance. + // + // The following is the format of the ARN: + // + // arn:aws:ec2:region:aws_account_id:instance/instance-id ResourceArns []string noSmithyDocumentSerde @@ -60,13 +71,13 @@ type GetLicenseRecommendationsInput struct { type GetLicenseRecommendationsOutput struct { - // An array of objects that describe errors of the request. + // An array of objects that describe errors of the request. Errors []types.GetRecommendationError - // An array of objects that describe license recommendations. + // An array of objects that describe license recommendations. LicenseRecommendations []types.LicenseRecommendation - // The token to use to advance to the next page of license recommendations. + // The token to use to advance to the next page of license recommendations. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/computeoptimizer/api_op_GetRecommendationPreferences.go b/service/computeoptimizer/api_op_GetRecommendationPreferences.go index 81e66ac1f6d..90497e8c26d 100644 --- a/service/computeoptimizer/api_op_GetRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_GetRecommendationPreferences.go @@ -12,11 +12,15 @@ 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) -// in the Compute Optimizer User Guide. +// 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] in the Compute Optimizer User Guide. +// +// [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html func (c *Client) GetRecommendationPreferences(ctx context.Context, params *GetRecommendationPreferencesInput, optFns ...func(*Options)) (*GetRecommendationPreferencesOutput, error) { if params == nil { params = &GetRecommendationPreferencesInput{} @@ -35,28 +39,34 @@ func (c *Client) GetRecommendationPreferences(ctx context.Context, params *GetRe type GetRecommendationPreferencesInput struct { // The target resource type of the recommendation preference for which to return - // 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 . + // 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 . // // This member is required. ResourceType types.ResourceType // The maximum number of recommendation preferences to return with a single - // request. To retrieve the remaining results, make another request with the - // returned nextToken value. + // 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 recommendation preferences. NextToken *string // An object that describes the scope of the recommendation preference to return. + // // 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) - // in the Compute Optimizer User Guide. + // resource level. For more information, see [Activating enhanced infrastructure metrics]in the Compute Optimizer User Guide. + // + // [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html Scope *types.Scope noSmithyDocumentSerde @@ -65,8 +75,9 @@ 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 - // return. + // + // This value is null when there are no more pages of recommendation preferences + // to return. NextToken *string // An array of objects that describe recommendation preferences. @@ -169,8 +180,10 @@ var _ GetRecommendationPreferencesAPIClient = (*Client)(nil) // GetRecommendationPreferences type GetRecommendationPreferencesPaginatorOptions struct { // The maximum number of recommendation preferences to return with a single - // request. To retrieve the remaining results, make another request with the - // returned nextToken value. + // request. + // + // To retrieve the remaining results, make another 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/computeoptimizer/api_op_GetRecommendationSummaries.go b/service/computeoptimizer/api_op_GetRecommendationSummaries.go index 7a3535f98b8..0f26ae28862 100644 --- a/service/computeoptimizer/api_op_GetRecommendationSummaries.go +++ b/service/computeoptimizer/api_op_GetRecommendationSummaries.go @@ -11,12 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the optimization findings for an account. It returns the number of: +// 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 . func (c *Client) GetRecommendationSummaries(ctx context.Context, params *GetRecommendationSummariesInput, optFns ...func(*Options)) (*GetRecommendationSummariesOutput, error) { @@ -37,12 +44,17 @@ func (c *Client) GetRecommendationSummaries(ctx context.Context, params *GetReco type GetRecommendationSummariesInput struct { // The ID of the Amazon Web Services account for which to return recommendation - // summaries. If your account is the management account of an organization, use - // this parameter to specify the member account for which you want to return - // recommendation summaries. Only one account ID can be specified per request. + // summaries. + // + // If your account is the management account of an organization, use this + // parameter to specify the member account for which you want to return + // recommendation summaries. + // + // Only one account ID can be specified per request. AccountIds []string // The maximum number of recommendation summaries to return with a single request. + // // To retrieve the remaining results, make another request with the returned // nextToken value. MaxResults *int32 @@ -55,8 +67,9 @@ type GetRecommendationSummariesInput struct { type GetRecommendationSummariesOutput struct { - // The token to use to advance to the next page of recommendation summaries. This - // value is null when there are no more pages of recommendation summaries to + // The token to use to advance to the next page of recommendation summaries. + // + // This value is null when there are no more pages of recommendation summaries to // return. NextToken *string @@ -157,6 +170,7 @@ var _ GetRecommendationSummariesAPIClient = (*Client)(nil) // GetRecommendationSummaries type GetRecommendationSummariesPaginatorOptions struct { // The maximum number of recommendation summaries to return with a single request. + // // To retrieve the remaining results, make another request with the returned // nextToken value. Limit int32 diff --git a/service/computeoptimizer/api_op_PutRecommendationPreferences.go b/service/computeoptimizer/api_op_PutRecommendationPreferences.go index 7a25dc1aa1e..7beeee44104 100644 --- a/service/computeoptimizer/api_op_PutRecommendationPreferences.go +++ b/service/computeoptimizer/api_op_PutRecommendationPreferences.go @@ -12,9 +12,11 @@ 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) -// in the Compute Optimizer User Guide. +// preference, such as enhanced infrastructure metrics. +// +// For more information, see [Activating enhanced infrastructure metrics] in the Compute Optimizer User Guide. +// +// [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html func (c *Client) PutRecommendationPreferences(ctx context.Context, params *PutRecommendationPreferencesInput, optFns ...func(*Options)) (*PutRecommendationPreferencesOutput, error) { if params == nil { params = &PutRecommendationPreferencesInput{} @@ -32,85 +34,122 @@ func (c *Client) PutRecommendationPreferences(ctx context.Context, params *PutRe type PutRecommendationPreferencesInput struct { - // The target resource type of the recommendation preference to create. 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 . + // The target resource type of the recommendation preference to create. + // + // 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 . // // This member is required. ResourceType types.ResourceType // 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) - // in the Compute Optimizer User Guide. + // 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] in the Compute Optimizer User Guide. + // + // [Enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html 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) - // in the Compute Optimizer User Guide. + // update. + // + // Specify a valid provider in the source field to activate the preference. To + // delete this preference, see the DeleteRecommendationPreferencesaction. + // + // This preference can only be set for the Ec2Instance resource type. + // + // For more information, see [External metrics ingestion] in the Compute Optimizer User Guide. + // + // [External metrics ingestion]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html 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) - // in the Compute Optimizer User Guide. + // 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] in the Compute Optimizer User Guide. + // + // [Inferred workload types]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/inferred-workload-types.html InferredWorkloadTypes types.InferredWorkloadTypesPreference - // The preference to control the number of days the utilization metrics of the + // The preference to control the number of days the utilization metrics of the // Amazon Web Services resource are analyzed. When this preference isn't specified, - // we use the default value DAYS_14 . You can only set this preference for the - // Amazon EC2 instance and Auto Scaling group resource types. + // we use the default value DAYS_14 . + // + // You can only set this preference for the Amazon EC2 instance and Auto Scaling + // group resource types. LookBackPeriod types.LookBackPeriodPreference - // The preference to control which resource type values are considered when + // The preference to control which resource type values are considered when // generating rightsizing recommendations. You can specify this preference as a // combination of include and exclude lists. You must specify either an includeList // or excludeList . If the preference is an empty set of resource type values, an - // error occurs. You can only set this preference for the Amazon EC2 instance and - // Auto Scaling group resource types. + // error occurs. + // + // You can only set this preference for the Amazon EC2 instance and Auto Scaling + // group resource types. PreferredResources []types.PreferredResource - // The status of the savings estimation mode preference to create or update. + // The status of the savings estimation mode preference to create or update. + // // Specify the AfterDiscounts status to activate the preference, or specify - // BeforeDiscounts to deactivate the preference. Only the account manager or - // delegated administrator of your organization can activate this preference. For - // more information, see Savings estimation mode (https://docs.aws.amazon.com/compute-optimizer/latest/ug/savings-estimation-mode.html) - // in the Compute Optimizer User Guide. + // BeforeDiscounts to deactivate the preference. + // + // Only the account manager or delegated administrator of your organization can + // activate this preference. + // + // For more information, see [Savings estimation mode] in the Compute Optimizer User Guide. + // + // [Savings estimation mode]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/savings-estimation-mode.html SavingsEstimationMode types.SavingsEstimationMode // 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) - // 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 - // resource level by specifying a scope name of ResourceArn and a scope value of - // the Auto Scaling group Amazon Resource Name (ARN). This will configure the - // preference for all instances that are part of the specified Auto Scaling group. - // You also cannot create recommendation preferences at the resource level for - // instances that are part of an Auto Scaling group. You can create recommendation - // preferences at the resource level only for standalone instances. + // For more information, see [Activating enhanced infrastructure metrics]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 resource level by specifying a scope name of + // ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name + // (ARN). This will configure the preference for all instances that are part of the + // specified Auto Scaling group. You also cannot create recommendation preferences + // at the resource level for instances that are part of an Auto Scaling group. You + // can create recommendation preferences at the resource level only for standalone + // instances. + // + // [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html Scope *types.Scope - // The preference to control the resource’s CPU utilization threshold, CPU + // The preference to control the resource’s CPU utilization threshold, CPU // utilization headroom, and memory utilization headroom. When this preference - // isn't specified, we use the following default values. CPU utilization: + // isn't specified, we use the following default values. + // + // CPU utilization: + // // - P99_5 for threshold + // // - PERCENT_20 for headroom + // // Memory utilization: + // // - PERCENT_20 for headroom // // - You can only set CPU and memory utilization preferences for the Amazon EC2 // instance resource type. + // // - The threshold setting isn’t available for memory utilization. UtilizationPreferences []types.UtilizationPreference diff --git a/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go b/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go index 144bc3897a2..d7a1172e9dd 100644 --- a/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go +++ b/service/computeoptimizer/api_op_UpdateEnrollmentStatus.go @@ -12,15 +12,21 @@ import ( ) // Updates the enrollment (opt in and opt out) status of an account to the Compute -// Optimizer service. If the account is a management account of an organization, -// 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 -// 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) -// in the Compute Optimizer User Guide. +// Optimizer service. +// +// If the account is a management account of an organization, 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]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]in the Compute +// Optimizer User Guide. +// +// [Controlling access with Amazon Web Services Identity and Access Management]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html +// [Using Service-Linked Roles for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/using-service-linked-roles.html func (c *Client) UpdateEnrollmentStatus(ctx context.Context, params *UpdateEnrollmentStatusInput, optFns ...func(*Options)) (*UpdateEnrollmentStatusOutput, error) { if params == nil { params = &UpdateEnrollmentStatusInput{} @@ -38,20 +44,25 @@ func (c *Client) UpdateEnrollmentStatus(ctx context.Context, params *UpdateEnrol type UpdateEnrollmentStatusInput struct { - // The new enrollment status of the account. The following status options are - // available: + // 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. + // Amazon Web Services resources after you opt in. For more information, see [Metrics analyzed by Compute Optimizer]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. // + // [Metrics analyzed by Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html + // // This member is required. Status types.Status diff --git a/service/computeoptimizer/doc.go b/service/computeoptimizer/doc.go index 557f8af664b..8dd5d6963fa 100644 --- a/service/computeoptimizer/doc.go +++ b/service/computeoptimizer/doc.go @@ -15,6 +15,7 @@ // 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]. +// +// [Compute Optimizer User Guide]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/ package computeoptimizer diff --git a/service/computeoptimizer/options.go b/service/computeoptimizer/options.go index 4de24e20256..972c2305642 100644 --- a/service/computeoptimizer/options.go +++ b/service/computeoptimizer/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/computeoptimizer/types/enums.go b/service/computeoptimizer/types/enums.go index 118090fcb39..f0cde3714b9 100644 --- a/service/computeoptimizer/types/enums.go +++ b/service/computeoptimizer/types/enums.go @@ -12,6 +12,7 @@ const ( // 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{ @@ -29,8 +30,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AWS_ARM64", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for Currency. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Currency) Values() []Currency { return []Currency{ "USD", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for CurrentPerformanceRisk. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CurrentPerformanceRisk) Values() []CurrentPerformanceRisk { return []CurrentPerformanceRisk{ "VeryLow", @@ -90,6 +94,7 @@ const ( // Values returns all known values for CustomizableMetricHeadroom. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CustomizableMetricHeadroom) Values() []CustomizableMetricHeadroom { return []CustomizableMetricHeadroom{ @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for CustomizableMetricName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomizableMetricName) Values() []CustomizableMetricName { return []CustomizableMetricName{ "CpuUtilization", @@ -129,6 +135,7 @@ const ( // Values returns all known values for CustomizableMetricThreshold. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CustomizableMetricThreshold) Values() []CustomizableMetricThreshold { return []CustomizableMetricThreshold{ @@ -146,8 +153,9 @@ const ( ) // Values returns all known values for EBSFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EBSFilterName) Values() []EBSFilterName { return []EBSFilterName{ "Finding", @@ -163,8 +171,9 @@ const ( ) // Values returns all known values for EBSFinding. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EBSFinding) Values() []EBSFinding { return []EBSFinding{ "Optimized", @@ -183,8 +192,9 @@ const ( ) // Values returns all known values for EBSMetricName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EBSMetricName) Values() []EBSMetricName { return []EBSMetricName{ "VolumeReadOpsPerSecond", @@ -205,8 +215,9 @@ const ( // Values returns all known values for EBSSavingsEstimationModeSource. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EBSSavingsEstimationModeSource) Values() []EBSSavingsEstimationModeSource { return []EBSSavingsEstimationModeSource{ "PublicPricing", @@ -226,8 +237,9 @@ const ( // Values returns all known values for ECSSavingsEstimationModeSource. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ECSSavingsEstimationModeSource) Values() []ECSSavingsEstimationModeSource { return []ECSSavingsEstimationModeSource{ "PublicPricing", @@ -245,8 +257,9 @@ const ( ) // Values returns all known values for ECSServiceLaunchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ECSServiceLaunchType) Values() []ECSServiceLaunchType { return []ECSServiceLaunchType{ "EC2", @@ -263,8 +276,9 @@ const ( ) // Values returns all known values for ECSServiceMetricName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ECSServiceMetricName) Values() []ECSServiceMetricName { return []ECSServiceMetricName{ "Cpu", @@ -282,6 +296,7 @@ const ( // Values returns all known values for ECSServiceMetricStatistic. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ECSServiceMetricStatistic) Values() []ECSServiceMetricStatistic { return []ECSServiceMetricStatistic{ @@ -300,8 +315,9 @@ const ( // Values returns all known values for ECSServiceRecommendationFilterName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ECSServiceRecommendationFilterName) Values() []ECSServiceRecommendationFilterName { return []ECSServiceRecommendationFilterName{ "Finding", @@ -320,8 +336,9 @@ const ( // Values returns all known values for ECSServiceRecommendationFinding. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ECSServiceRecommendationFinding) Values() []ECSServiceRecommendationFinding { return []ECSServiceRecommendationFinding{ "Optimized", @@ -342,8 +359,9 @@ const ( // Values returns all known values for ECSServiceRecommendationFindingReasonCode. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ECSServiceRecommendationFindingReasonCode) Values() []ECSServiceRecommendationFindingReasonCode { return []ECSServiceRecommendationFindingReasonCode{ "MemoryOverprovisioned", @@ -363,8 +381,9 @@ const ( // Values returns all known values for EnhancedInfrastructureMetrics. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnhancedInfrastructureMetrics) Values() []EnhancedInfrastructureMetrics { return []EnhancedInfrastructureMetrics{ "Active", @@ -380,8 +399,9 @@ const ( ) // Values returns all known values for EnrollmentFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnrollmentFilterName) Values() []EnrollmentFilterName { return []EnrollmentFilterName{ "Status", @@ -462,8 +482,9 @@ const ( // Values returns all known values for ExportableAutoScalingGroupField. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportableAutoScalingGroupField) Values() []ExportableAutoScalingGroupField { return []ExportableAutoScalingGroupField{ "AccountId", @@ -571,6 +592,7 @@ const ( // Values returns all known values for ExportableECSServiceField. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ExportableECSServiceField) Values() []ExportableECSServiceField { return []ExportableECSServiceField{ @@ -683,8 +705,9 @@ const ( ) // Values returns all known values for ExportableInstanceField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportableInstanceField) Values() []ExportableInstanceField { return []ExportableInstanceField{ "AccountId", @@ -800,8 +823,9 @@ const ( // Values returns all known values for ExportableLambdaFunctionField. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportableLambdaFunctionField) Values() []ExportableLambdaFunctionField { return []ExportableLambdaFunctionField{ "AccountId", @@ -866,8 +890,9 @@ const ( ) // Values returns all known values for ExportableLicenseField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportableLicenseField) Values() []ExportableLicenseField { return []ExportableLicenseField{ "AccountId", @@ -936,8 +961,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AccountId", @@ -989,8 +1015,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Datadog", @@ -1018,6 +1045,7 @@ const ( // Values returns all known values for ExternalMetricStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ExternalMetricStatusCode) Values() []ExternalMetricStatusCode { return []ExternalMetricStatusCode{ @@ -1042,8 +1070,9 @@ const ( ) // Values returns all known values for FileFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileFormat) Values() []FileFormat { return []FileFormat{ "Csv", @@ -1061,8 +1090,9 @@ const ( ) // Values returns all known values for FilterName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterName) Values() []FilterName { return []FilterName{ "Finding", @@ -1083,8 +1113,9 @@ const ( ) // Values returns all known values for Finding. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Finding) Values() []Finding { return []Finding{ "Underprovisioned", @@ -1103,8 +1134,9 @@ const ( ) // Values returns all known values for FindingReasonCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingReasonCode) Values() []FindingReasonCode { return []FindingReasonCode{ "MemoryOverprovisioned", @@ -1128,8 +1160,9 @@ const ( ) // Values returns all known values for InferredWorkloadType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InferredWorkloadType) Values() []InferredWorkloadType { return []InferredWorkloadType{ "AmazonEmr", @@ -1154,8 +1187,9 @@ const ( // Values returns all known values for InferredWorkloadTypesPreference. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InferredWorkloadTypesPreference) Values() []InferredWorkloadTypesPreference { return []InferredWorkloadTypesPreference{ "Active", @@ -1172,8 +1206,9 @@ const ( ) // Values returns all known values for InstanceIdle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceIdle) Values() []InstanceIdle { return []InstanceIdle{ "True", @@ -1209,8 +1244,9 @@ const ( // Values returns all known values for InstanceRecommendationFindingReasonCode. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceRecommendationFindingReasonCode) Values() []InstanceRecommendationFindingReasonCode { return []InstanceRecommendationFindingReasonCode{ "CPUOverprovisioned", @@ -1247,8 +1283,9 @@ const ( // Values returns all known values for InstanceSavingsEstimationModeSource. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceSavingsEstimationModeSource) Values() []InstanceSavingsEstimationModeSource { return []InstanceSavingsEstimationModeSource{ "PublicPricing", @@ -1270,8 +1307,9 @@ const ( ) // Values returns all known values for InstanceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceState) Values() []InstanceState { return []InstanceState{ "pending", @@ -1292,8 +1330,9 @@ const ( ) // Values returns all known values for JobFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobFilterName) Values() []JobFilterName { return []JobFilterName{ "ResourceType", @@ -1312,8 +1351,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1332,8 +1372,9 @@ const ( // Values returns all known values for LambdaFunctionMemoryMetricName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionMemoryMetricName) Values() []LambdaFunctionMemoryMetricName { return []LambdaFunctionMemoryMetricName{ "Duration", @@ -1351,8 +1392,9 @@ const ( // Values returns all known values for LambdaFunctionMemoryMetricStatistic. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionMemoryMetricStatistic) Values() []LambdaFunctionMemoryMetricStatistic { return []LambdaFunctionMemoryMetricStatistic{ "LowerBound", @@ -1371,6 +1413,7 @@ const ( // 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{ @@ -1389,8 +1432,9 @@ const ( // Values returns all known values for LambdaFunctionMetricStatistic. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionMetricStatistic) Values() []LambdaFunctionMetricStatistic { return []LambdaFunctionMetricStatistic{ "Maximum", @@ -1408,8 +1452,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionRecommendationFilterName) Values() []LambdaFunctionRecommendationFilterName { return []LambdaFunctionRecommendationFilterName{ "Finding", @@ -1428,8 +1473,9 @@ const ( // Values returns all known values for LambdaFunctionRecommendationFinding. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionRecommendationFinding) Values() []LambdaFunctionRecommendationFinding { return []LambdaFunctionRecommendationFinding{ "Optimized", @@ -1450,8 +1496,9 @@ const ( // Values returns all known values for // LambdaFunctionRecommendationFindingReasonCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionRecommendationFindingReasonCode) Values() []LambdaFunctionRecommendationFindingReasonCode { return []LambdaFunctionRecommendationFindingReasonCode{ "MemoryOverprovisioned", @@ -1472,8 +1519,9 @@ const ( // Values returns all known values for LambdaSavingsEstimationModeSource. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaSavingsEstimationModeSource) Values() []LambdaSavingsEstimationModeSource { return []LambdaSavingsEstimationModeSource{ "PublicPricing", @@ -1493,8 +1541,9 @@ const ( ) // Values returns all known values for LicenseEdition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseEdition) Values() []LicenseEdition { return []LicenseEdition{ "Enterprise", @@ -1514,8 +1563,9 @@ const ( ) // Values returns all known values for LicenseFinding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseFinding) Values() []LicenseFinding { return []LicenseFinding{ "InsufficientMetrics", @@ -1536,6 +1586,7 @@ const ( // Values returns all known values for LicenseFindingReasonCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LicenseFindingReasonCode) Values() []LicenseFindingReasonCode { return []LicenseFindingReasonCode{ @@ -1555,8 +1606,9 @@ const ( ) // Values returns all known values for LicenseModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseModel) Values() []LicenseModel { return []LicenseModel{ "LicenseIncluded", @@ -1572,8 +1624,9 @@ const ( ) // Values returns all known values for LicenseName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseName) Values() []LicenseName { return []LicenseName{ "SQLServer", @@ -1591,8 +1644,9 @@ const ( // Values returns all known values for LicenseRecommendationFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseRecommendationFilterName) Values() []LicenseRecommendationFilterName { return []LicenseRecommendationFilterName{ "Finding", @@ -1612,6 +1666,7 @@ const ( // Values returns all known values for LookBackPeriodPreference. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LookBackPeriodPreference) Values() []LookBackPeriodPreference { return []LookBackPeriodPreference{ @@ -1644,8 +1699,9 @@ const ( ) // Values returns all known values for MetricName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricName) Values() []MetricName { return []MetricName{ "Cpu", @@ -1675,8 +1731,9 @@ const ( ) // Values returns all known values for MetricSourceProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricSourceProvider) Values() []MetricSourceProvider { return []MetricSourceProvider{ "CloudWatchApplicationInsights", @@ -1692,8 +1749,9 @@ const ( ) // Values returns all known values for MetricStatistic. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricStatistic) Values() []MetricStatistic { return []MetricStatistic{ "Maximum", @@ -1712,8 +1770,9 @@ const ( ) // Values returns all known values for MigrationEffort. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationEffort) Values() []MigrationEffort { return []MigrationEffort{ "VeryLow", @@ -1736,8 +1795,9 @@ const ( ) // Values returns all known values for PlatformDifference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlatformDifference) Values() []PlatformDifference { return []PlatformDifference{ "Hypervisor", @@ -1757,8 +1817,9 @@ const ( ) // Values returns all known values for PreferredResourceName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreferredResourceName) Values() []PreferredResourceName { return []PreferredResourceName{ "Ec2InstanceTypes", @@ -1779,8 +1840,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationPreferenceName) Values() []RecommendationPreferenceName { return []RecommendationPreferenceName{ "EnhancedInfrastructureMetrics", @@ -1806,6 +1868,7 @@ const ( // 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{ @@ -1832,8 +1895,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1855,8 +1919,9 @@ const ( ) // Values returns all known values for SavingsEstimationMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsEstimationMode) Values() []SavingsEstimationMode { return []SavingsEstimationMode{ "AfterDiscounts", @@ -1874,8 +1939,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1895,8 +1961,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "Active", diff --git a/service/computeoptimizer/types/types.go b/service/computeoptimizer/types/types.go index ca0fcbb06ab..11d225ab6ff 100644 --- a/service/computeoptimizer/types/types.go +++ b/service/computeoptimizer/types/types.go @@ -21,9 +21,10 @@ 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 @@ -47,15 +48,16 @@ type AutoScalingGroupConfiguration struct { noSmithyDocumentSerde } -// An object that describes the estimated monthly savings possible by adopting +// An object that describes the estimated monthly savings possible by adopting +// // Compute Optimizer’s Auto Scaling group recommendations. This is based on the // Savings Plans and Reserved Instances discounts. type AutoScalingGroupEstimatedMonthlySavings struct { - // The currency of the estimated monthly savings. + // The currency of the estimated monthly savings. Currency Currency - // The value of the estimated monthly savings. + // The value of the estimated monthly savings. Value float64 noSmithyDocumentSerde @@ -77,7 +79,7 @@ type AutoScalingGroupRecommendation struct { // group. CurrentConfiguration *AutoScalingGroupConfiguration - // Describes the GPU accelerator settings for the current instance type of the + // Describes the GPU accelerator settings for the current instance type of the // Auto Scaling group. CurrentInstanceGpuInfo *GpuInfo @@ -91,11 +93,14 @@ type AutoScalingGroupRecommendation struct { // Scaling group. EffectiveRecommendationPreferences *EffectiveRecommendationPreferences - // The finding classification of the Auto Scaling group. Findings for Auto Scaling - // groups include: + // 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 @@ -103,17 +108,28 @@ type AutoScalingGroupRecommendation struct { 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: + // 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. + // // - Kafka - Infers that Kafka might be running on the instance. + // // - SQLServer - Infers that SQLServer might be running on the instance. InferredWorkloadTypes []InferredWorkloadType @@ -141,44 +157,51 @@ type AutoScalingGroupRecommendationOption struct { // An array of objects that describe an Auto Scaling group configuration. Configuration *AutoScalingGroupConfiguration - // Describes the GPU accelerator settings for the recommended instance type of the - // Auto Scaling group. + // Describes the GPU accelerator settings for the recommended instance type of + // the Auto Scaling group. InstanceGpuInfo *GpuInfo // The level of effort required to migrate from the current instance type to the - // recommended instance type. For example, the migration effort is Low if Amazon - // EMR is the inferred workload type and an Amazon Web Services Graviton instance - // type is recommended. The migration effort is Medium if a workload type couldn't - // be inferred but an Amazon Web Services Graviton instance type is recommended. - // The migration effort is VeryLow if both the current and recommended instance - // types are of the same CPU architecture. + // recommended instance type. + // + // For example, the migration effort is Low if Amazon EMR is the inferred workload + // type and an Amazon Web Services Graviton instance type is recommended. The + // migration effort is Medium if a workload type couldn't be inferred but an + // Amazon Web Services Graviton instance type is recommended. The migration effort + // is VeryLow if both the current and recommended instance types are of the same + // CPU architecture. MigrationEffort MigrationEffort // The performance risk of the Auto Scaling group configuration recommendation. + // // Performance risk indicates the likelihood of the recommended instance type not // meeting the resource needs of your workload. Compute Optimizer calculates an // individual performance risk score for each specification of the recommended // 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 - // 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 before migrating your resource. + // 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 requirements of your workload before + // migrating your resource. PerformanceRisk float64 // An array of objects that describe the projected utilization metrics of the Auto - // Scaling group recommendation option. The Cpu and Memory metrics are the only - // 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) - // . + // Scaling group recommendation option. + // + // The Cpu and Memory metrics are the only 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]. + // + // [Enabling Memory Utilization with the CloudWatch 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 @@ -186,7 +209,7 @@ type AutoScalingGroupRecommendationOption struct { // savings amount and percentage. SavingsOpportunity *SavingsOpportunity - // An object that describes the savings opportunity for the Auto Scaling group + // An object that describes the savings opportunity for the Auto Scaling group // recommendation option that includes Savings Plans and Reserved Instances // discounts. Savings opportunity includes the estimated monthly savings and // percentage. @@ -195,18 +218,20 @@ type AutoScalingGroupRecommendationOption struct { noSmithyDocumentSerde } -// Describes the savings opportunity for Auto Scaling group recommendations after -// applying the Savings Plans and Reserved Instances discounts. Savings opportunity -// represents the estimated monthly savings you can achieve by implementing Compute -// Optimizer recommendations. +// Describes the savings opportunity for Auto Scaling group recommendations after +// +// applying the Savings Plans and Reserved Instances discounts. +// +// Savings opportunity represents the estimated monthly savings you can achieve by +// implementing Compute Optimizer recommendations. type AutoScalingGroupSavingsOpportunityAfterDiscounts struct { - // An object that describes the estimated monthly savings possible by adopting + // An object that describes the estimated monthly savings possible by adopting // Compute Optimizer’s Auto Scaling group recommendations. This is based on the // Savings Plans and Reserved Instances pricing discounts. EstimatedMonthlySavings *AutoScalingGroupEstimatedMonthlySavings - // The estimated monthly savings possible as a percentage of monthly cost after + // The estimated monthly savings possible as a percentage of monthly cost after // applying the Savings Plans and Reserved Instances discounts. This saving can be // achieved by adopting Compute Optimizer’s Auto Scaling group recommendations. SavingsOpportunityPercentage float64 @@ -214,42 +239,45 @@ type AutoScalingGroupSavingsOpportunityAfterDiscounts struct { noSmithyDocumentSerde } -// Describes the container configurations within the tasks of your Amazon ECS +// Describes the container configurations within the tasks of your Amazon ECS +// // service. type ContainerConfiguration struct { - // The name of the container. + // The name of the container. ContainerName *string - // The number of CPU units reserved for the container. + // The number of CPU units reserved for the container. Cpu *int32 - // The memory size configurations for the container. + // The memory size configurations for the container. MemorySizeConfiguration *MemorySizeConfiguration noSmithyDocumentSerde } -// The CPU and memory recommendations for a container within the tasks of your +// The CPU and memory recommendations for a container within the tasks of your +// // Amazon ECS service. type ContainerRecommendation struct { - // The name of the container. + // The name of the container. ContainerName *string - // The recommended number of CPU units reserved for the container. + // The recommended number of CPU units reserved for the container. Cpu *int32 - // The recommended memory size configurations for the container. + // The recommended memory size configurations for the container. MemorySizeConfiguration *MemorySizeConfiguration 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. @@ -268,18 +296,23 @@ type CurrentPerformanceRiskRatings struct { noSmithyDocumentSerde } -// Defines the various metric parameters that can be customized, such as threshold -// and headroom. +// Defines the various metric parameters that can be customized, such as +// +// threshold and headroom. type CustomizableMetricParameters struct { - // The headroom value in percentage used for the specified metric parameter. The - // following lists the valid values for CPU and memory utilization. + // The headroom value in percentage used for the specified metric parameter. + // + // The following lists the valid values for CPU and memory utilization. + // // - CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0 + // // - Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10 Headroom CustomizableMetricHeadroom - // The threshold value used for the specified metric parameter. You can only - // specify the threshold value for CPU utilization. + // The threshold value used for the specified metric parameter. + // + // You can only specify the threshold value for CPU utilization. Threshold CustomizableMetricThreshold noSmithyDocumentSerde @@ -288,78 +321,87 @@ type CustomizableMetricParameters struct { // Describes the effective recommendation preferences for Amazon EBS volumes. type EBSEffectiveRecommendationPreferences struct { - // Describes the savings estimation mode preference applied for calculating + // Describes the savings estimation mode preference applied for calculating // savings opportunity for Amazon EBS volumes. SavingsEstimationMode *EBSSavingsEstimationMode noSmithyDocumentSerde } -// An object that describes the estimated monthly savings possible by adopting +// An object that describes the estimated monthly savings possible by adopting +// // Compute Optimizer’s Amazon EBS volume recommendations. This includes any // applicable discounts. type EBSEstimatedMonthlySavings struct { - // The currency of the estimated monthly savings. + // The currency of the estimated monthly savings. Currency Currency - // The value of the estimated monthly savings. + // The value of the estimated monthly savings. Value float64 noSmithyDocumentSerde } // Describes a filter that returns a more specific list of Amazon Elastic Block -// Store (Amazon EBS) volume recommendations. Use this filter with the -// GetEBSVolumeRecommendations action. You can use -// LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations -// action, JobFilter with the DescribeRecommendationExportJobs action, and Filter -// with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations -// actions. +// Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendationsaction. +// +// You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with +// the DescribeRecommendationExportJobsaction, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions. type EBSFilter struct { - // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification (for example, NotOptimized ). You can filter - // your Amazon EBS volume recommendations by tag:key and tag-key tags. A tag:key - // is a key and value combination of a tag assigned to your Amazon EBS volume - // recommendations. Use the tag key in the filter name and the tag value as the - // filter value. For example, to find all Amazon EBS volume recommendations that - // have a tag with the key of Owner and the value of TeamA , specify tag:Owner for - // the filter name and TeamA for the filter value. A tag-key is the key of a tag - // assigned to your Amazon EBS volume recommendations. Use this filter to find all - // of your Amazon EBS volume recommendations that have a tag with a specific key. - // This doesn’t consider the tag value. For example, you can find your Amazon EBS - // volume recommendations with a tag key value of Owner or without any tag keys - // assigned. + // The name of the filter. + // + // Specify Finding to return recommendations with a specific finding + // classification (for example, NotOptimized ). + // + // You can filter your Amazon EBS volume recommendations by tag:key and tag-key + // tags. + // + // A tag:key is a key and value combination of a tag assigned to your Amazon EBS + // volume recommendations. Use the tag key in the filter name and the tag value as + // the filter value. For example, to find all Amazon EBS volume recommendations + // that have a tag with the key of Owner and the value of TeamA , specify tag:Owner + // for the filter name and TeamA for the filter value. + // + // A tag-key is the key of a tag assigned to your Amazon EBS volume + // recommendations. Use this filter to find all of your Amazon EBS volume + // recommendations that have a tag with a specific key. This doesn’t consider the + // tag value. For example, you can find your Amazon EBS volume recommendations with + // a tag key value of Owner or without any tag keys assigned. 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 } -// Describes the savings estimation mode used for calculating savings opportunity +// Describes the savings estimation mode used for calculating savings opportunity +// // for Amazon EBS volumes. type EBSSavingsEstimationMode struct { - // Describes the source for calculating the savings opportunity for Amazon EBS + // Describes the source for calculating the savings opportunity for Amazon EBS // volumes. Source EBSSavingsEstimationModeSource noSmithyDocumentSerde } -// Describes the savings opportunity for Amazon EBS volume recommendations after +// Describes the savings opportunity for Amazon EBS volume recommendations after +// // applying specific discounts. type EBSSavingsOpportunityAfterDiscounts struct { - // The estimated monthly savings possible as a percentage of monthly cost by + // The estimated monthly savings possible as a percentage of monthly cost by // adopting Compute Optimizer’s Amazon EBS volume recommendations. This saving // includes any applicable discounts. EstimatedMonthlySavings *EBSEstimatedMonthlySavings - // The estimated monthly savings possible as a percentage of monthly cost after + // The estimated monthly savings possible as a percentage of monthly cost after // applying the specific discounts. This saving can be achieved by adopting Compute // Optimizer’s Amazon EBS volume recommendations. SavingsOpportunityPercentage float64 @@ -368,33 +410,52 @@ type EBSSavingsOpportunityAfterDiscounts struct { } // Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) -// volume. Compare the utilization metric data of your resource against its -// projected utilization metric data to determine the performance difference -// between your current resource and the recommended option. +// volume. +// +// Compare the utilization metric data of your resource against its projected +// utilization metric data to determine the performance difference between your +// current resource and the recommended option. type EBSUtilizationMetric struct { - // The name of the utilization metric. The following utilization metrics are - // available: + // 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 + // 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 + // 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 + // specified period of time. + // + // Unit: Bytes + // // - VolumeWriteBytesPerSecond - The bytes written to the volume in a specified - // period of time. Unit: Bytes + // 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 - // 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) - // 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) - // . + // 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]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]. + // + // [Viewing resource recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html + // [Amazon CloudWatch User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Statistic MetricStatistic // The value of the utilization metric. @@ -406,50 +467,55 @@ type EBSUtilizationMetric struct { // Describes the effective recommendation preferences for Amazon ECS services. type ECSEffectiveRecommendationPreferences struct { - // Describes the savings estimation mode preference applied for calculating + // Describes the savings estimation mode preference applied for calculating // savings opportunity for Amazon ECS services. SavingsEstimationMode *ECSSavingsEstimationMode noSmithyDocumentSerde } -// Describes the estimated monthly savings possible for Amazon ECS services by +// Describes the estimated monthly savings possible for Amazon ECS services by +// // adopting Compute Optimizer recommendations. This is based on Amazon ECS service // pricing after applying Savings Plans discounts. type ECSEstimatedMonthlySavings struct { - // The currency of the estimated monthly savings. + // The currency of the estimated monthly savings. Currency Currency - // The value of the estimated monthly savings for Amazon ECS services. + // The value of the estimated monthly savings for Amazon ECS services. Value float64 noSmithyDocumentSerde } -// Describes the savings estimation mode used for calculating savings opportunity +// Describes the savings estimation mode used for calculating savings opportunity +// // for Amazon ECS services. type ECSSavingsEstimationMode struct { - // Describes the source for calculating the savings opportunity for Amazon ECS + // Describes the source for calculating the savings opportunity for Amazon ECS // services. Source ECSSavingsEstimationModeSource noSmithyDocumentSerde } -// Describes the savings opportunity for Amazon ECS service recommendations after -// applying Savings Plans discounts. Savings opportunity represents the estimated -// monthly savings after applying Savings Plans discounts. You can achieve this by -// implementing a given Compute Optimizer recommendation. +// Describes the savings opportunity for Amazon ECS service recommendations after +// +// applying Savings Plans discounts. +// +// Savings opportunity represents the estimated monthly savings after applying +// Savings Plans discounts. You can achieve this by implementing a given Compute +// Optimizer recommendation. type ECSSavingsOpportunityAfterDiscounts struct { - // The estimated monthly savings possible by adopting Compute Optimizer’s Amazon + // The estimated monthly savings possible by adopting Compute Optimizer’s Amazon // ECS service recommendations. This includes any applicable Savings Plans // discounts. EstimatedMonthlySavings *ECSEstimatedMonthlySavings - // The estimated monthly savings possible as a percentage of monthly cost by + // The estimated monthly savings possible as a percentage of monthly cost by // adopting Compute Optimizer’s Amazon ECS service recommendations. This includes // any applicable Savings Plans discounts. SavingsOpportunityPercentage float64 @@ -457,62 +523,78 @@ type ECSSavingsOpportunityAfterDiscounts struct { noSmithyDocumentSerde } -// Describes the projected metrics of an Amazon ECS service recommendation option. +// Describes the projected metrics of an Amazon ECS service recommendation +// +// option. +// // To determine the performance difference between your current Amazon ECS service // and the recommended option, compare the metric data of your service against its // projected metric data. type ECSServiceProjectedMetric struct { - // The lower bound values for the projected metric. + // The lower bound values for the projected metric. LowerBoundValues []float64 - // The name of the projected metric. The following metrics are available: + // 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. Name ECSServiceMetricName - // The timestamps of the projected metric. + // The timestamps of the projected metric. Timestamps []time.Time - // The upper bound values for the projected metric. + // The upper bound values for the projected metric. UpperBoundValues []float64 noSmithyDocumentSerde } -// Describes the projected utilization metrics of an Amazon ECS service -// recommendation option. To determine the performance difference between your -// current Amazon ECS service and the recommended option, compare the utilization -// metric data of your service against its projected utilization metric data. +// Describes the projected utilization metrics of an Amazon ECS service +// +// recommendation option. +// +// To determine the performance difference between your current Amazon ECS service +// and the recommended option, compare the utilization metric data of your service +// against its projected utilization metric data. type ECSServiceProjectedUtilizationMetric struct { - // The lower bound values for the projected utilization metrics. + // The lower bound values for the projected utilization metrics. LowerBoundValue float64 - // The name of the projected utilization metric. The following utilization metrics - // are available: + // 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. Name ECSServiceMetricName - // The statistic of the projected 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) - // 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) - // . + // The statistic of the projected 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]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]. + // + // [Viewing resource recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html + // [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. + // The upper bound values for the projected utilization metrics. UpperBoundValue float64 noSmithyDocumentSerde @@ -521,101 +603,128 @@ type ECSServiceProjectedUtilizationMetric struct { // Describes an Amazon ECS service recommendation. type ECSServiceRecommendation struct { - // The Amazon Web Services account ID of the Amazon ECS service. + // The Amazon Web Services account ID of the Amazon ECS service. AccountId *string - // The risk of the current Amazon ECS service not meeting the performance needs of - // its workloads. The higher the risk, the more likely the current service can't + // The risk of the current Amazon ECS service not meeting the performance needs + // of its workloads. The higher the risk, the more likely the current service can't // meet the performance requirements of its workload. CurrentPerformanceRisk CurrentPerformanceRisk - // The configuration of the current Amazon ECS service. + // The configuration of the current Amazon ECS service. CurrentServiceConfiguration *ServiceConfiguration - // Describes the effective recommendation preferences for Amazon ECS services. + // Describes the effective recommendation preferences for Amazon ECS services. EffectiveRecommendationPreferences *ECSEffectiveRecommendationPreferences - // The finding classification of an Amazon ECS service. Findings for Amazon ECS - // services include: + // 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. Finding ECSServiceRecommendationFinding - // The reason for the finding classification of an Amazon ECS service. Finding - // reason codes for Amazon ECS services include: + // 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. FindingReasonCodes []ECSServiceRecommendationFindingReasonCode - // The timestamp of when the Amazon ECS service recommendation was last generated. + // 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. + // The number of days the Amazon ECS service utilization metrics were analyzed. LookbackPeriodInDays float64 - // The Amazon Resource Name (ARN) of the current Amazon ECS service. The following - // is the format of the ARN: - // arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name + // The Amazon Resource Name (ARN) of the current Amazon ECS service. + // + // The following is the format of the ARN: + // + // arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name ServiceArn *string - // An array of objects that describe the recommendation options for the Amazon ECS - // service. + // An array of objects that describe the recommendation options for the Amazon + // ECS service. ServiceRecommendationOptions []ECSServiceRecommendationOption - // A list of tags assigned to your Amazon ECS service recommendations. + // A list of tags assigned to your Amazon ECS service recommendations. Tags []Tag - // An array of objects that describe the utilization metrics of the Amazon ECS + // An array of objects that describe the utilization metrics of the Amazon ECS // service. UtilizationMetrics []ECSServiceUtilizationMetric noSmithyDocumentSerde } -// Describes a filter that returns a more specific list of Amazon ECS service -// recommendations. Use this filter with the GetECSServiceRecommendations action. +// Describes a filter that returns a more specific list of Amazon ECS service +// +// recommendations. Use this filter with the GetECSServiceRecommendationsaction. type ECSServiceRecommendationFilter struct { - // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification. Specify FindingReasonCode to return - // recommendations with a specific finding reason code. You can filter your Amazon - // ECS service recommendations by tag:key and tag-key tags. A tag:key is a key and - // value combination of a tag assigned to your Amazon ECS service recommendations. - // Use the tag key in the filter name and the tag value as the filter value. For - // example, to find all Amazon ECS service recommendations that have a tag with the - // key of Owner and the value of TeamA , specify tag:Owner for the filter name and - // TeamA for the filter value. A tag-key is the key of a tag assigned to your - // Amazon ECS service recommendations. Use this filter to find all of your Amazon - // ECS service recommendations that have a tag with a specific key. This doesn’t - // consider the tag value. For example, you can find your Amazon ECS service - // recommendations with a tag key value of Owner or without any tag keys assigned. + // The name of the filter. + // + // Specify Finding to return recommendations with a specific finding + // classification. + // + // Specify FindingReasonCode to return recommendations with a specific finding + // reason code. + // + // You can filter your Amazon ECS service recommendations by tag:key and tag-key + // tags. + // + // A tag:key is a key and value combination of a tag assigned to your Amazon ECS + // service recommendations. Use the tag key in the filter name and the tag value as + // the filter value. For example, to find all Amazon ECS service recommendations + // that have a tag with the key of Owner and the value of TeamA , specify tag:Owner + // for the filter name and TeamA for the filter value. + // + // A tag-key is the key of a tag assigned to your Amazon ECS service + // recommendations. Use this filter to find all of your Amazon ECS service + // recommendations that have a tag with a specific key. This doesn’t consider the + // tag value. For example, you can find your Amazon ECS service recommendations + // with a tag key value of Owner or without any tag keys assigned. Name ECSServiceRecommendationFilterName - // The value of the filter. The valid values for this parameter are as follows: + // 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 . @@ -627,109 +736,128 @@ type ECSServiceRecommendationFilter struct { // Describes the recommendation options for an Amazon ECS service. type ECSServiceRecommendationOption struct { - // The CPU and memory size recommendations for the containers within the task of + // The CPU and memory size recommendations for the containers within the task of // your Amazon ECS service. ContainerRecommendations []ContainerRecommendation - // The CPU size of the Amazon ECS service recommendation option. + // The CPU size of the Amazon ECS service recommendation option. Cpu *int32 - // The memory size of the Amazon ECS service recommendation option. + // The memory size of the Amazon ECS service recommendation option. Memory *int32 - // An array of objects that describe the projected utilization metrics of the + // An array of objects that describe the projected utilization metrics of the // Amazon ECS service recommendation option. ProjectedUtilizationMetrics []ECSServiceProjectedUtilizationMetric // Describes the savings opportunity for recommendations of a given resource type - // or for the recommendation option of an individual resource. Savings opportunity - // represents the estimated monthly savings you can achieve by implementing a given - // Compute Optimizer recommendation. Savings opportunity data requires that you opt - // in to Cost Explorer, as well as activate Receive Amazon EC2 resource - // recommendations in the Cost Explorer preferences page. That creates a connection - // between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer - // 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) - // in the Cost Management User Guide. + // or for the recommendation option of an individual resource. + // + // Savings opportunity represents the estimated monthly savings you can achieve by + // implementing a given Compute Optimizer recommendation. + // + // Savings opportunity data requires that you opt in to Cost Explorer, as well as + // activate Receive Amazon EC2 resource recommendations in the Cost Explorer + // preferences page. That creates a connection between Cost Explorer and Compute + // Optimizer. With this connection, Cost Explorer 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]and [Optimizing your cost with Rightsizing Recommendations] in the Cost Management User Guide. + // + // [Optimizing your cost with Rightsizing Recommendations]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html + // [Enabling Cost Explorer]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html SavingsOpportunity *SavingsOpportunity - // Describes the savings opportunity for Amazon ECS service recommendations or for - // the recommendation option. Savings opportunity represents the estimated monthly - // savings after applying Savings Plans discounts. You can achieve this by - // implementing a given Compute Optimizer recommendation. + // Describes the savings opportunity for Amazon ECS service recommendations or + // for the recommendation option. + // + // Savings opportunity represents the estimated monthly savings after applying + // Savings Plans discounts. You can achieve this by implementing a given Compute + // Optimizer recommendation. SavingsOpportunityAfterDiscounts *ECSSavingsOpportunityAfterDiscounts noSmithyDocumentSerde } -// Describes the projected metrics of an Amazon ECS service recommendation option. +// Describes the projected metrics of an Amazon ECS service recommendation +// +// option. +// // To determine the performance difference between your current Amazon ECS service // and the recommended option, compare the metric data of your service against its // projected metric data. type ECSServiceRecommendedOptionProjectedMetric struct { - // An array of objects that describe the projected metric. + // An array of objects that describe the projected metric. ProjectedMetrics []ECSServiceProjectedMetric - // The recommended CPU size for the Amazon ECS service. + // The recommended CPU size for the Amazon ECS service. RecommendedCpuUnits int32 - // The recommended memory size for the Amazon ECS service. + // The recommended memory size for the Amazon ECS service. RecommendedMemorySize int32 noSmithyDocumentSerde } -// Describes the utilization metric of an Amazon ECS service. To determine the -// performance difference between your current Amazon ECS service and the -// recommended option, compare the utilization metric data of your service against -// its projected utilization metric data. +// Describes the utilization metric of an Amazon ECS service. +// +// To determine the performance difference between your current Amazon ECS service +// and the recommended option, compare the utilization metric data of your service +// against its projected utilization metric data. type ECSServiceUtilizationMetric struct { - // The name of the utilization metric. The following utilization metrics are - // available: + // 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. 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 - // 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) - // 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) - // . + // 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]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]. + // + // [Viewing resource recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html + // [Amazon CloudWatch User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Statistic ECSServiceMetricStatistic - // The value of the utilization metric. + // The value of the utilization metric. Value float64 noSmithyDocumentSerde } -// Describes the effective preferred resources that Compute Optimizer considers as -// rightsizing recommendation candidates. Compute Optimizer only supports Amazon -// EC2 instance types. +// Describes the effective preferred resources that Compute Optimizer considers +// +// as rightsizing recommendation candidates. +// +// Compute Optimizer only supports Amazon EC2 instance types. type EffectivePreferredResource struct { - // The expanded version of your preferred resource's include list. + // The expanded version of your preferred resource's include list. EffectiveIncludeList []string - // The list of preferred resources values that you want excluded from rightsizing + // The list of preferred resources values that you want excluded from rightsizing // recommendation candidates. ExcludeList []string - // The list of preferred resource values that you want considered as rightsizing + // The list of preferred resource values that you want considered as rightsizing // recommendation candidates. IncludeList []string - // The name of the preferred resource list. + // The name of the preferred resource list. Name PreferredResourceName noSmithyDocumentSerde @@ -739,67 +867,81 @@ type EffectivePreferredResource struct { 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. + // recommendations. + // + // For example, when you specify AWS_ARM64 with: + // + // - A GetEC2InstanceRecommendationsor GetAutoScalingGroupRecommendationsrequest, Compute Optimizer returns recommendations that consist of + // Graviton2 instance types only. + // + // - A GetEC2RecommendationProjectedMetricsrequest, Compute Optimizer returns projected utilization metrics for + // Graviton2 instance type recommendations only. + // + // - A ExportEC2InstanceRecommendationsor ExportAutoScalingGroupRecommendationsrequest, 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) - // in the Compute Optimizer User Guide. + // 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] in the Compute Optimizer User Guide. + // + // [Enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html EnhancedInfrastructureMetrics EnhancedInfrastructureMetrics - // An object that describes the external metrics recommendation preference. If the - // preference is applied in the latest recommendation refresh, an object with a - // valid source value appears in the response. If the preference isn't applied to - // the recommendations already, then this object doesn't appear in the response. + // An object that describes the external metrics recommendation preference. + // + // If the preference is applied in the latest recommendation refresh, an object + // with a valid source value appears in the response. If the preference isn't + // applied to the recommendations already, then this object doesn't appear in the + // response. ExternalMetricsPreference *ExternalMetricsPreference - // Describes the activation status of the inferred workload types preference. A - // status of Active confirms that the preference is applied in the latest + // Describes the activation status of the inferred workload types preference. + // + // A status of Active confirms that the preference is applied in the latest // recommendation refresh. A status of Inactive confirms that it's not yet applied // to recommendations. InferredWorkloadTypes InferredWorkloadTypesPreference - // The number of days the utilization metrics of the Amazon Web Services resource + // The number of days the utilization metrics of the Amazon Web Services resource // are analyzed. LookBackPeriod LookBackPeriodPreference - // The resource type values that are considered as candidates when generating + // The resource type values that are considered as candidates when generating // rightsizing recommendations. PreferredResources []EffectivePreferredResource - // Describes the savings estimation mode applied for calculating savings + // Describes the savings estimation mode applied for calculating savings // opportunity for a resource. SavingsEstimationMode *InstanceSavingsEstimationMode - // The resource’s CPU and memory utilization preferences, such as threshold and - // headroom, that are used to generate rightsizing recommendations. This preference - // is only available for the Amazon EC2 instance resource type. + // The resource’s CPU and memory utilization preferences, such as threshold and + // headroom, that are used to generate rightsizing recommendations. + // + // This preference is only available for the Amazon EC2 instance resource type. UtilizationPreferences []UtilizationPreference noSmithyDocumentSerde } // Describes a filter that returns a more specific list of account enrollment -// statuses. Use this filter with the GetEnrollmentStatusesForOrganization action. +// statuses. Use this filter with the GetEnrollmentStatusesForOrganizationaction. type EnrollmentFilter struct { - // The name of the filter. Specify Status to return accounts with a specific - // enrollment status (for example, Active ). + // The name of the filter. + // + // Specify Status to return accounts with a specific 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 @@ -807,9 +949,11 @@ 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) -// in the Compute Optimizer User Guide. +// resource. +// +// For more information, see [Estimated monthly savings and savings opportunities] in the Compute Optimizer User Guide. +// +// [Estimated monthly savings and savings opportunities]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/view-ec2-recommendations.html#ec2-savings-calculation type EstimatedMonthlySavings struct { // The currency of the estimated monthly savings. @@ -832,111 +976,145 @@ type ExportDestination struct { noSmithyDocumentSerde } -// Describes the external metrics preferences for EC2 rightsizing recommendations. +// Describes the external metrics preferences for EC2 rightsizing +// +// recommendations. type ExternalMetricsPreference struct { - // Contains the source options for external metrics preferences. + // Contains the source options for external metrics preferences. Source ExternalMetricsSource noSmithyDocumentSerde } -// Describes Compute Optimizer's integration status with your chosen external +// Describes Compute Optimizer's integration status with your chosen external +// // metric provider. For example, Datadog. type ExternalMetricStatus struct { - // The status code for Compute Optimizer's integration with an external metrics + // The status code for Compute Optimizer's integration with an external metrics // provider. StatusCode ExternalMetricStatusCode - // The reason for Compute Optimizer's integration status with your external metric - // provider. + // The reason for Compute Optimizer's integration status with your external + // metric provider. StatusReason *string noSmithyDocumentSerde } // Describes a filter that returns a more specific list of recommendations. Use -// this filter with the GetAutoScalingGroupRecommendations and -// GetEC2InstanceRecommendations actions. You can use EBSFilter with the -// GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the -// GetLambdaFunctionRecommendations action, and JobFilter with the -// DescribeRecommendationExportJobs action. +// this filter with the GetAutoScalingGroupRecommendationsand GetEC2InstanceRecommendations actions. +// +// You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with +// the GetLambdaFunctionRecommendationsaction, and JobFilter with the DescribeRecommendationExportJobs action. type Filter struct { - // The name of the filter. Specify Finding to return recommendations with a - // 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 . Specify - // InferredWorkloadTypes to return recommendations of a specific inferred workload. - // For example, Redis . You can filter your EC2 instance recommendations by tag:key - // and tag-key tags. A tag:key is a key and value combination of a tag assigned to - // your recommendations. Use the tag key in the filter name and the tag value as - // the filter value. For example, to find all recommendations that have a tag with - // the key of Owner and the value of TeamA , specify tag:Owner for the filter name - // and TeamA for the filter value. A tag-key is the key of a tag assigned to your - // recommendations. Use this filter to find all of your recommendations that have a - // tag with a specific key. This doesn’t consider the tag value. For example, you - // can find your recommendations with a tag key value of Owner or without any tag - // keys assigned. + // The name of the filter. + // + // Specify Finding to return recommendations with a 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 . + // + // Specify InferredWorkloadTypes to return recommendations of a specific inferred + // workload. For example, Redis . + // + // You can filter your EC2 instance recommendations by tag:key and tag-key tags. + // + // A tag:key is a key and value combination of a tag assigned to your + // recommendations. Use the tag key in the filter name and the tag value as the + // filter value. For example, to find all recommendations that have a tag with the + // key of Owner and the value of TeamA , specify tag:Owner for the filter name and + // TeamA for the filter value. + // + // A tag-key is the key of a tag assigned to your recommendations. Use this filter + // to find all of your recommendations that have a tag with a specific key. This + // doesn’t consider the tag value. For example, you can find your recommendations + // with a tag key value of Owner or without any tag keys assigned. 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: + // 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 @@ -946,10 +1124,11 @@ type Filter struct { noSmithyDocumentSerde } -// Describes an error experienced when getting recommendations. For example, an -// error is returned if you request recommendations for an unsupported Auto Scaling -// group, or if you request recommendations for an instance of an unsupported -// instance family. +// Describes an error experienced when getting recommendations. +// +// For example, an error is returned if you request recommendations for an +// unsupported Auto Scaling group, or if you request recommendations for an +// instance of an unsupported instance family. type GetRecommendationError struct { // The error code. @@ -967,11 +1146,11 @@ type GetRecommendationError struct { // Describes the GPU accelerators for the instance type. type Gpu struct { - // The number of GPUs for the instance type. + // The number of GPUs for the instance type. GpuCount int32 - // The total size of the memory for the GPU accelerators for the instance type, in - // MiB. + // The total size of the memory for the GPU accelerators for the instance type, + // in MiB. GpuMemorySizeInMiB int32 noSmithyDocumentSerde @@ -980,13 +1159,14 @@ type Gpu struct { // Describes the GPU accelerator settings for the instance type. type GpuInfo struct { - // Describes the GPU accelerators for the instance type. + // Describes the GPU accelerators for the instance type. Gpus []Gpu noSmithyDocumentSerde } -// The estimated monthly savings after you adjust the configurations of your +// The estimated monthly savings after you adjust the configurations of your +// // instances running on the inferred workload types to the recommended // configurations. If the inferredWorkloadTypes list contains multiple entries, // then the savings are the sum of the monthly savings from instances that run the @@ -999,32 +1179,44 @@ type InferredWorkloadSaving struct { EstimatedMonthlySavings *EstimatedMonthlySavings // 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: + // 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. + // // - SQLServer - Infers that SQLServer might be running on the instance. InferredWorkloadTypes []InferredWorkloadType noSmithyDocumentSerde } -// An object that describes the estimated monthly savings possible by adopting +// An object that describes the estimated monthly savings possible by adopting +// // Compute Optimizer’s Amazon EC2 instance recommendations. This is based on the // Savings Plans and Reserved Instances pricing discounts. type InstanceEstimatedMonthlySavings struct { - // The currency of the estimated monthly savings. + // The currency of the estimated monthly savings. Currency Currency - // The value of the estimated monthly savings. + // The value of the estimated monthly savings. Value float64 noSmithyDocumentSerde @@ -1036,7 +1228,7 @@ type InstanceRecommendation struct { // The Amazon Web Services account ID of the instance. AccountId *string - // Describes the GPU accelerator settings for the current instance type. + // Describes the GPU accelerator settings for the current instance type. CurrentInstanceGpuInfo *GpuInfo // The instance type of the current instance. @@ -1051,75 +1243,92 @@ type InstanceRecommendation struct { // instance. EffectiveRecommendationPreferences *EffectiveRecommendationPreferences - // An object that describes Compute Optimizer's integration status with your + // An object that describes Compute Optimizer's integration status with your // external metrics provider. ExternalMetricStatus *ExternalMetricStatus - // The finding classification of the instance. Findings for instances include: + // 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. Finding Finding - // The reason for the finding classification of the instance. Finding reason codes - // for instances include: + // 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 + // 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]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 @@ -1127,55 +1336,75 @@ type InstanceRecommendation struct { // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // + // For more information about instance metrics, see [List the available CloudWatch metrics for your instances] in the Amazon Elastic Compute + // Cloud User Guide. For more information about EBS volume metrics, see [Amazon CloudWatch metrics for Amazon EBS]in the + // Amazon Elastic Compute Cloud User Guide. + // + // [Enabling memory utilization with the Amazon CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent + // [Amazon CloudWatch metrics for Amazon EBS]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cloudwatch_ebs.html + // [List the available CloudWatch metrics for your instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing_metrics_with_cloudwatch.html FindingReasonCodes []InstanceRecommendationFindingReasonCode - // Describes if an Amazon EC2 instance is idle. + // Describes if an Amazon EC2 instance is idle. Idle InstanceIdle // 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: + // 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. + // // - SQLServer - Infers that SQLServer might be running on the instance. InferredWorkloadTypes []InferredWorkloadType @@ -1185,7 +1414,7 @@ type InstanceRecommendation struct { // The name of the current instance. InstanceName *string - // The state of the instance when the recommendation was generated. + // The state of the instance when the recommendation was generated. InstanceState InstanceState // The timestamp of when the instance recommendation was last generated. @@ -1200,7 +1429,7 @@ type InstanceRecommendation struct { // An array of objects that describe the source resource of the recommendation. RecommendationSources []RecommendationSource - // A list of tags assigned to your Amazon EC2 instance recommendations. + // A list of tags assigned to your Amazon EC2 instance recommendations. Tags []Tag // An array of objects that describe the utilization metrics of the instance. @@ -1212,109 +1441,122 @@ type InstanceRecommendation struct { // Describes a recommendation option for an Amazon EC2 instance. type InstanceRecommendationOption struct { - // Describes the GPU accelerator settings for the recommended instance type. + // Describes the GPU accelerator settings for the recommended instance type. InstanceGpuInfo *GpuInfo // The instance type of the instance recommendation. InstanceType *string // The level of effort required to migrate from the current instance type to the - // recommended instance type. For example, the migration effort is Low if Amazon - // EMR is the inferred workload type and an Amazon Web Services Graviton instance - // type is recommended. The migration effort is Medium if a workload type couldn't - // be inferred but an Amazon Web Services Graviton instance type is recommended. - // The migration effort is VeryLow if both the current and recommended instance - // types are of the same CPU architecture. + // recommended instance type. + // + // For example, the migration effort is Low if Amazon EMR is the inferred workload + // type and an Amazon Web Services Graviton instance type is recommended. The + // migration effort is Medium if a workload type couldn't be inferred but an + // Amazon Web Services Graviton instance type is recommended. The migration effort + // is VeryLow if both the current and recommended instance types are of the same + // CPU architecture. MigrationEffort MigrationEffort - // The performance risk of the instance recommendation option. Performance risk - // indicates the likelihood of the recommended instance type not meeting the - // resource needs of your workload. Compute Optimizer calculates an individual - // performance risk score for each specification of the recommended 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 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 - // before migrating your resource. + // The performance risk of the instance recommendation option. + // + // Performance risk indicates the likelihood of the recommended instance type not + // meeting the resource needs of your workload. Compute Optimizer calculates an + // individual performance risk score for each specification of the recommended + // 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 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 before + // migrating your resource. PerformanceRisk float64 // 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) - // provide general guidance for getting started with an instance migration. + // instance type. The [Change the instance type guide for Linux]and [Change the instance type guide for Windows] 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. + // the [Nitro Hypervisor]section of the Amazon EC2 frequently asked questions. For more + // information, see [Instances built on the Nitro System]in the Amazon EC2 User Guide for Linux, or [Instances built on the Nitro System]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. + // Function driver. For more information, see [Networking and storage features]and [Enhanced networking on Linux]in the Amazon EC2 User Guide + // for Linux, or [Networking and storage features]and [Enhanced networking on Windows]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. + // install or upgrade the NVMe driver. For more information, see [Networking and storage features]and [Amazon EBS and NVMe on Linux instances]in the + // Amazon EC2 User Guide for Linux, or [Networking and storage features]and [Amazon EBS and NVMe on Windows instances]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. + // preserve them. For more information, see [How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS?]in the Amazon Web Services Premium + // Support Knowledge Base. For more information, see [Networking and storage features]and [Amazon EC2 instance store]in the Amazon EC2 User + // Guide for Linux, or see [Networking and storage features]and [Amazon EC2 instance store]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. + // these virtualization types, see [Linux AMI virtualization types]in the Amazon EC2 User Guide for Linux, or [Windows AMI 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/) . + // more information about the CPU architecture for each instance type, see [Amazon EC2 Instance Types]. + // + // [Enhanced networking on Linux]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html + // [Amazon EBS and NVMe on Linux instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nvme-ebs-volumes.html + // [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/ + // [Enhanced networking on Windows]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/enhanced-networking.html + // [Instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#ec2-nitro-instances + // [Networking and storage features]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage + // [Change the instance type guide for Windows]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-resize.html + // [Linux AMI virtualization types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/virtualization_types.html + // [Amazon EC2 instance store]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/InstanceStorage.html + // [Nitro Hypervisor]: http://aws.amazon.com/ec2/faqs/#Nitro_Hypervisor + // [Amazon EC2 Instance Types]: http://aws.amazon.com/ec2/instance-types/ + // [Amazon EBS and NVMe on Windows instances]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/nvme-ebs-volumes.html + // [Windows AMI virtualization types]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#virtualization-types + // [Change the instance type guide for Linux]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html PlatformDifferences []PlatformDifference // An array of objects that describe the projected utilization metrics of the - // instance recommendation option. The Cpu and Memory metrics are the only - // 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) - // . + // instance recommendation option. + // + // The Cpu and Memory metrics are the only 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]. + // + // [Enabling Memory Utilization with the CloudWatch 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 @@ -1322,7 +1564,7 @@ type InstanceRecommendationOption struct { // savings amount and percentage. SavingsOpportunity *SavingsOpportunity - // An object that describes the savings opportunity for the instance + // An object that describes the savings opportunity for the instance // recommendation option that includes Savings Plans and Reserved Instances // discounts. Savings opportunity includes the estimated monthly savings and // percentage. @@ -1331,29 +1573,32 @@ type InstanceRecommendationOption struct { noSmithyDocumentSerde } -// Describes the savings estimation mode used for calculating savings opportunity +// Describes the savings estimation mode used for calculating savings opportunity +// // for Amazon EC2 instances. type InstanceSavingsEstimationMode struct { - // Describes the source for calculating the savings opportunity for Amazon EC2 + // Describes the source for calculating the savings opportunity for Amazon EC2 // instances. Source InstanceSavingsEstimationModeSource noSmithyDocumentSerde } -// Describes the savings opportunity for instance recommendations after applying -// the Savings Plans and Reserved Instances discounts. Savings opportunity after -// discounts represents the estimated monthly savings you can achieve by -// implementing Compute Optimizer recommendations. +// Describes the savings opportunity for instance recommendations after applying +// +// the Savings Plans and Reserved Instances discounts. +// +// Savings opportunity after discounts represents the estimated monthly savings +// you can achieve by implementing Compute Optimizer recommendations. type InstanceSavingsOpportunityAfterDiscounts struct { - // An object that describes the estimated monthly savings possible by adopting + // An object that describes the estimated monthly savings possible by adopting // Compute Optimizer’s Amazon EC2 instance recommendations. This is based on // pricing after applying the Savings Plans and Reserved Instances discounts. EstimatedMonthlySavings *InstanceEstimatedMonthlySavings - // The estimated monthly savings possible as a percentage of monthly cost after + // The estimated monthly savings possible as a percentage of monthly cost after // applying the Savings Plans and Reserved Instances discounts. This saving can be // achieved by adopting Compute Optimizer’s EC2 instance recommendations. SavingsOpportunityPercentage float64 @@ -1362,23 +1607,29 @@ type InstanceSavingsOpportunityAfterDiscounts struct { } // Describes a filter that returns a more specific list of recommendation export -// jobs. Use this filter with the DescribeRecommendationExportJobs action. You can -// use EBSFilter with the GetEBSVolumeRecommendations action, -// LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations -// action, and Filter with the GetAutoScalingGroupRecommendations and -// GetEC2InstanceRecommendations actions. +// jobs. Use this filter with the DescribeRecommendationExportJobsaction. +// +// You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with +// the GetLambdaFunctionRecommendationsaction, and Filter with the GetAutoScalingGroupRecommendations and 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: + // 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 . Values []string @@ -1389,22 +1640,23 @@ type JobFilter struct { // Describes the effective recommendation preferences for Lambda functions. type LambdaEffectiveRecommendationPreferences struct { - // Describes the savings estimation mode applied for calculating savings + // Describes the savings estimation mode applied for calculating savings // opportunity for Lambda functions. SavingsEstimationMode *LambdaSavingsEstimationMode noSmithyDocumentSerde } -// Describes the estimated monthly savings possible for Lambda functions by +// Describes the estimated monthly savings possible for Lambda functions by +// // adopting Compute Optimizer recommendations. This is based on Lambda functions // pricing after applying Savings Plans discounts. type LambdaEstimatedMonthlySavings struct { - // The currency of the estimated monthly savings. + // The currency of the estimated monthly savings. Currency Currency - // The value of the estimated monthly savings. + // The value of the estimated monthly savings. Value float64 noSmithyDocumentSerde @@ -1436,8 +1688,9 @@ 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 @@ -1445,7 +1698,7 @@ type LambdaFunctionMemoryRecommendationOption struct { // savings amount and percentage. SavingsOpportunity *SavingsOpportunity - // An object that describes the savings opportunity for the Lambda recommendation + // An object that describes the savings opportunity for the Lambda recommendation // option which includes Saving Plans discounts. Savings opportunity includes the // estimated monthly savings and percentage. SavingsOpportunityAfterDiscounts *LambdaSavingsOpportunityAfterDiscounts @@ -1467,13 +1720,17 @@ type LambdaFunctionRecommendation struct { // requires more memory. CurrentPerformanceRisk CurrentPerformanceRisk - // Describes the effective recommendation preferences for Lambda functions. + // Describes the effective recommendation preferences for Lambda functions. EffectiveRecommendationPreferences *LambdaEffectiveRecommendationPreferences - // The finding classification of the function. Findings for functions include: + // 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 @@ -1481,36 +1738,47 @@ type LambdaFunctionRecommendation struct { // 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 + // 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 - // reason codes for functions include: + // 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) + // Compute Optimizer to generate a recommendation. For more information, see the [Supported resources and requirements] // 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. + // + // [Supported resources and requirements]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html FindingReasonCodes []LambdaFunctionRecommendationFindingReasonCode // The Amazon Resource Name (ARN) of the current function. @@ -1532,7 +1800,7 @@ type LambdaFunctionRecommendation struct { // The number of times your function code was applied during the look-back period. NumberOfInvocations int64 - // A list of tags assigned to your Lambda function recommendations. + // A list of tags assigned to your Lambda function recommendations. Tags []Tag // An array of objects that describe the utilization metrics of the function. @@ -1542,32 +1810,43 @@ type LambdaFunctionRecommendation struct { } // Describes a filter that returns a more specific list of Lambda function -// recommendations. Use this filter with the GetLambdaFunctionRecommendations -// action. You can use EBSFilter with the GetEBSVolumeRecommendations action, -// JobFilter with the DescribeRecommendationExportJobs action, and Filter with the -// GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions. +// recommendations. Use this filter with the GetLambdaFunctionRecommendationsaction. +// +// You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter +// with the GetAutoScalingGroupRecommendationsand GetEC2InstanceRecommendations actions. type LambdaFunctionRecommendationFilter struct { - // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification (for example, NotOptimized ). Specify - // FindingReasonCode to return recommendations with a specific finding reason code - // (for example, MemoryUnderprovisioned ). You can filter your Lambda function - // recommendations by tag:key and tag-key tags. A tag:key is a key and value - // combination of a tag assigned to your Lambda function recommendations. Use the - // tag key in the filter name and the tag value as the filter value. For example, - // to find all Lambda function recommendations that have a tag with the key of - // Owner and the value of TeamA , specify tag:Owner for the filter name and TeamA - // for the filter value. A tag-key is the key of a tag assigned to your Lambda - // function recommendations. Use this filter to find all of your Lambda function - // recommendations that have a tag with a specific key. This doesn’t consider the - // tag value. For example, you can find your Lambda function recommendations with a - // tag key value of Owner or without any tag keys assigned. + // The name of the filter. + // + // Specify Finding to return recommendations with a specific finding + // classification (for example, NotOptimized ). + // + // Specify FindingReasonCode to return recommendations with a specific finding + // reason code (for example, MemoryUnderprovisioned ). + // + // You can filter your Lambda function recommendations by tag:key and tag-key tags. + // + // A tag:key is a key and value combination of a tag assigned to your Lambda + // function recommendations. Use the tag key in the filter name and the tag value + // as the filter value. For example, to find all Lambda function recommendations + // that have a tag with the key of Owner and the value of TeamA , specify tag:Owner + // for the filter name and TeamA for the filter value. + // + // A tag-key is the key of a tag assigned to your Lambda function recommendations. + // Use this filter to find all of your Lambda function recommendations that have a + // tag with a specific key. This doesn’t consider the tag value. For example, you + // can find your Lambda function recommendations with a tag key value of Owner or + // without any tag keys assigned. 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: + // 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 . Values []string @@ -1578,23 +1857,30 @@ type LambdaFunctionRecommendationFilter struct { // Describes a utilization metric of an Lambda function. type LambdaFunctionUtilizationMetric struct { - // The name of the utilization metric. The following utilization metrics are - // available: + // 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. 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 - // 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) - // 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) - // . + // 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]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]. + // + // [Viewing resource recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html + // [Amazon CloudWatch User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Statistic LambdaFunctionMetricStatistic // The value of the utilization metric. @@ -1603,28 +1889,32 @@ type LambdaFunctionUtilizationMetric struct { noSmithyDocumentSerde } -// Describes the savings estimation used for calculating savings opportunity for +// Describes the savings estimation used for calculating savings opportunity for +// // Lambda functions. type LambdaSavingsEstimationMode struct { - // Describes the source for calculation of savings opportunity for Lambda + // Describes the source for calculation of savings opportunity for Lambda // functions. Source LambdaSavingsEstimationModeSource noSmithyDocumentSerde } -// Describes the savings opportunity for Lambda functions recommendations after -// applying Savings Plans discounts. Savings opportunity represents the estimated -// monthly savings after applying Savings Plans discounts. You can achieve this by -// implementing a given Compute Optimizer recommendation. +// Describes the savings opportunity for Lambda functions recommendations after +// +// applying Savings Plans discounts. +// +// Savings opportunity represents the estimated monthly savings after applying +// Savings Plans discounts. You can achieve this by implementing a given Compute +// Optimizer recommendation. type LambdaSavingsOpportunityAfterDiscounts struct { - // The estimated monthly savings possible by adopting Compute Optimizer’s Lambda + // The estimated monthly savings possible by adopting Compute Optimizer’s Lambda // function recommendations. This includes any applicable Savings Plans discounts. EstimatedMonthlySavings *LambdaEstimatedMonthlySavings - // The estimated monthly savings possible as a percentage of monthly cost by + // The estimated monthly savings possible as a percentage of monthly cost by // adopting Compute Optimizer’s Lambda function recommendations. This includes any // applicable Savings Plans discounts. SavingsOpportunityPercentage float64 @@ -1635,29 +1925,29 @@ type LambdaSavingsOpportunityAfterDiscounts struct { // Describes the configuration of a license for an Amazon EC2 instance. type LicenseConfiguration struct { - // The instance type used in the license. + // The instance type used in the license. InstanceType *string - // The edition of the license for the application that runs on the instance. + // The edition of the license for the application that runs on the instance. LicenseEdition LicenseEdition - // The license type associated with the instance. + // The license type associated with the instance. LicenseModel LicenseModel - // The name of the license for the application that runs on the instance. + // The name of the license for the application that runs on the instance. LicenseName LicenseName - // The version of the license for the application that runs on the instance. + // The version of the license for the application that runs on the instance. LicenseVersion *string - // The list of metric sources required to generate recommendations for commercial + // The list of metric sources required to generate recommendations for commercial // software licenses. MetricsSource []MetricSource - // The current number of cores associated with the instance. + // The current number of cores associated with the instance. NumberOfCores int32 - // The operating system of the instance. + // The operating system of the instance. OperatingSystem *string noSmithyDocumentSerde @@ -1666,79 +1956,102 @@ type LicenseConfiguration struct { // Describes a license recommendation for an EC2 instance. type LicenseRecommendation struct { - // The Amazon Web Services account ID of the license. + // The Amazon Web Services account ID of the license. AccountId *string - // An object that describes the current configuration of an instance that runs on + // An object that describes the current configuration of an instance that runs on // a license. CurrentLicenseConfiguration *LicenseConfiguration - // The finding classification for an instance that runs on a license. Findings - // include: + // The finding classification for an instance that runs on a license. + // + // Findings include: + // // - InsufficentMetrics — When Compute Optimizer detects that your CloudWatch // Application Insights isn't enabled or is enabled with insufficient permissions. + // // - NotOptimized — When Compute Optimizer detects that your EC2 infrastructure // isn't using any of the SQL server license features you're paying for, a license // is considered not optimized. + // // - Optimized — When Compute Optimizer detects that all specifications of your // license meet the performance requirements of your workload. Finding LicenseFinding - // The reason for the finding classification for an instance that runs on a - // license. Finding reason codes include: + // The reason for the finding classification for an instance that runs on a + // license. + // + // Finding reason codes include: + // // - Optimized — All specifications of your license meet the performance // requirements of your workload. + // // - LicenseOverprovisioned — A license is considered over-provisioned when your // license can be downgraded while still meeting the performance requirements of // your workload. + // // - InvalidCloudwatchApplicationInsights — CloudWatch Application Insights isn't // configured properly. + // // - CloudwatchApplicationInsightsError — There is a CloudWatch Application // Insights error. FindingReasonCodes []LicenseFindingReasonCode - // The timestamp of when the license recommendation was last generated. + // The timestamp of when the license recommendation was last generated. LastRefreshTimestamp *time.Time - // An array of objects that describe the license recommendation options. + // An array of objects that describe the license recommendation options. LicenseRecommendationOptions []LicenseRecommendationOption - // The number of days for which utilization metrics were analyzed for an instance + // The number of days for which utilization metrics were analyzed for an instance // that runs on a license. LookbackPeriodInDays float64 - // The ARN that identifies the Amazon EC2 instance. + // The ARN that identifies the Amazon EC2 instance. ResourceArn *string - // A list of tags assigned to an EC2 instance. + // A list of tags assigned to an EC2 instance. Tags []Tag noSmithyDocumentSerde } -// Describes a filter that returns a more specific list of license +// Describes a filter that returns a more specific list of license +// // recommendations. Use this filter with the GetLicenseRecommendation action. type LicenseRecommendationFilter struct { - // The name of the filter. Specify Finding to return recommendations with a - // specific finding classification. Specify FindingReasonCode to return - // recommendations with a specific finding reason code. You can filter your license - // recommendations by tag:key and tag-key tags. A tag:key is a key and value - // combination of a tag assigned to your license recommendations. Use the tag key - // in the filter name and the tag value as the filter value. For example, to find - // all license recommendations that have a tag with the key of Owner and the value - // of TeamA , specify tag:Owner for the filter name and TeamA for the filter - // value. A tag-key is the key of a tag assigned to your license recommendations. - // Use this filter to find all of your license recommendations that have a tag with - // a specific key. This doesn’t consider the tag value. For example, you can find + // The name of the filter. + // + // Specify Finding to return recommendations with a specific finding + // classification. + // + // Specify FindingReasonCode to return recommendations with a specific finding + // reason code. + // + // You can filter your license recommendations by tag:key and tag-key tags. + // + // A tag:key is a key and value combination of a tag assigned to your license + // recommendations. Use the tag key in the filter name and the tag value as the + // filter value. For example, to find all license recommendations that have a tag + // with the key of Owner and the value of TeamA , specify tag:Owner for the filter + // name and TeamA for the filter value. + // + // A tag-key is the key of a tag assigned to your license recommendations. Use + // this filter to find all of your license recommendations that have a tag with a + // specific key. This doesn’t consider the tag value. For example, you can find // your license recommendations with a tag key value of Owner or without any tag // keys assigned. Name LicenseRecommendationFilterName - // The value of the filter. The valid values for this parameter are as follows, - // depending on what you specify for the name parameter: + // The value of the filter. + // + // The valid values for this parameter are as follows, depending on what you + // specify for the name parameter: + // // - If you specify the name parameter as Finding , then specify Optimized , // NotOptimized , or InsufficentMetrics . + // // - If you specify the name parameter as FindingReasonCode , then specify // Optimized , LicenseOverprovisioned , InvalidCloudwatchApplicationInsights , or // CloudwatchApplicationInsightsError . @@ -1750,33 +2063,38 @@ type LicenseRecommendationFilter struct { // Describes the recommendation options for licenses. type LicenseRecommendationOption struct { - // The recommended edition of the license for the application that runs on the + // The recommended edition of the license for the application that runs on the // instance. LicenseEdition LicenseEdition - // The recommended license type associated with the instance. + // The recommended license type associated with the instance. LicenseModel LicenseModel - // The operating system of a license recommendation option. + // The operating system of a license recommendation option. OperatingSystem *string - // The rank of the license recommendation option. The top recommendation option is - // ranked as 1 . + // The rank of the license recommendation option. + // + // The top recommendation option is ranked as 1 . Rank int32 // Describes the savings opportunity for recommendations of a given resource type - // or for the recommendation option of an individual resource. Savings opportunity - // represents the estimated monthly savings you can achieve by implementing a given - // Compute Optimizer recommendation. Savings opportunity data requires that you opt - // in to Cost Explorer, as well as activate Receive Amazon EC2 resource - // recommendations in the Cost Explorer preferences page. That creates a connection - // between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer - // 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) - // in the Cost Management User Guide. + // or for the recommendation option of an individual resource. + // + // Savings opportunity represents the estimated monthly savings you can achieve by + // implementing a given Compute Optimizer recommendation. + // + // Savings opportunity data requires that you opt in to Cost Explorer, as well as + // activate Receive Amazon EC2 resource recommendations in the Cost Explorer + // preferences page. That creates a connection between Cost Explorer and Compute + // Optimizer. With this connection, Cost Explorer 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]and [Optimizing your cost with Rightsizing Recommendations] in the Cost Management User Guide. + // + // [Optimizing your cost with Rightsizing Recommendations]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html + // [Enabling Cost Explorer]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html SavingsOpportunity *SavingsOpportunity noSmithyDocumentSerde @@ -1785,52 +2103,59 @@ type LicenseRecommendationOption struct { // The memory size configurations of a container. type MemorySizeConfiguration struct { - // The amount of memory in the container. + // The amount of memory in the container. Memory *int32 - // The limit of memory reserve for the container. + // The limit of memory reserve for the container. MemoryReservation *int32 noSmithyDocumentSerde } -// The list of metric sources required to generate recommendations for commercial +// The list of metric sources required to generate recommendations for commercial +// // software licenses. type MetricSource struct { - // The name of the metric source provider. + // The name of the metric source provider. Provider MetricSourceProvider - // The ARN of the metric source provider. + // The ARN of the metric source provider. ProviderArn *string noSmithyDocumentSerde } -// The preference to control which resource type values are considered when +// The preference to control which resource type values are considered when +// // generating rightsizing recommendations. You can specify this preference as a // combination of include and exclude lists. You must specify either an includeList // or excludeList . If the preference is an empty set of resource type values, an -// error occurs. For more information, see Rightsizing recommendation preferences (https://docs.aws.amazon.com/compute-optimizer/latest/ug/rightsizing-preferences.html) -// in the Compute Optimizer User Guide. +// error occurs. For more information, see [Rightsizing recommendation preferences]in the Compute Optimizer User Guide. +// // - This preference is only available for the Amazon EC2 instance and Auto // Scaling group resource types. +// // - Compute Optimizer only supports the customization of Ec2InstanceTypes . +// +// [Rightsizing recommendation preferences]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/rightsizing-preferences.html type PreferredResource struct { - // The preferred resource type values to exclude from the recommendation + // The preferred resource type values to exclude from the recommendation // candidates. If this isn’t specified, all supported resources are included by // default. You can specify up to 1000 values in this list. ExcludeList []string - // The preferred resource type values to include in the recommendation candidates. - // You can specify the exact resource type value, such as m5.large, or use wild - // card expressions, such as m5. If this isn’t specified, all supported resources - // are included by default. You can specify up to 1000 values in this list. + // The preferred resource type values to include in the recommendation + // candidates. You can specify the exact resource type value, such as m5.large, or + // use wild card expressions, such as m5. If this isn’t specified, all supported + // resources are included by default. You can specify up to 1000 values in this + // list. IncludeList []string - // The type of preferred resource to customize. Compute Optimizer only supports - // the customization of Ec2InstanceTypes . + // The type of preferred resource to customize. + // + // Compute Optimizer only supports the customization of Ec2InstanceTypes . Name PreferredResourceName noSmithyDocumentSerde @@ -1839,41 +2164,54 @@ type PreferredResource struct { // Describes a projected utilization metric of a recommendation option, such as an // Amazon EC2 instance. This represents the projected utilization of a // recommendation option had you used that resource during the analyzed period. +// // Compare the utilization metric data of your resource against its projected // utilization metric data to determine the performance difference between your -// current resource and the recommended option. The Cpu , Memory , GPU , and -// GPU_MEMORY metrics are the only projected utilization metrics returned when you -// run the GetEC2RecommendationProjectedMetrics action. Additionally, these +// current resource and the recommended option. +// +// The Cpu , Memory , GPU , and GPU_MEMORY metrics are the only projected +// utilization metrics returned when you run the GetEC2RecommendationProjectedMetricsaction. Additionally, these // metrics are only returned for resources with 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) -// and Enabling NVIDIA GPU utilization with the CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent) -// . +// installed on them. For more information, see [Enabling Memory Utilization with the CloudWatch Agent]and [Enabling NVIDIA GPU utilization with the CloudWatch Agent]. +// +// [Enabling Memory Utilization with the CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent +// [Enabling NVIDIA GPU utilization with the CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent type ProjectedMetric struct { - // The name of the projected utilization metric. The following projected - // utilization metrics are returned: + // 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. + // 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. + // // - 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 only returned for - // resources with 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) - // . + // recommendation option. + // + // Units: Percent + // + // The Memory metric is only returned for resources with the unified CloudWatch + // agent installed on them. For more information, see [Enabling Memory Utilization with the CloudWatch Agent]. + // // - GPU - The projected percentage of allocated GPUs if you adjust your // configurations to Compute Optimizer's recommendation option. + // // - GPU_MEMORY - The projected percentage of total GPU memory if you adjust your - // configurations to Compute Optimizer's recommendation option. The GPU and - // GPU_MEMORY metrics are only returned for resources with the unified CloudWatch - // Agent installed on them. For more information, see Enabling NVIDIA GPU - // utilization with the CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent) - // . + // configurations to Compute Optimizer's recommendation option. + // + // The GPU and GPU_MEMORY metrics are only returned for resources with the unified + // CloudWatch Agent installed on them. For more information, see [Enabling NVIDIA GPU utilization with the CloudWatch Agent]. + // + // [Enabling Memory Utilization with the CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent + // [Enabling NVIDIA GPU utilization with the CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent Name MetricName // The timestamps of the projected utilization metric. @@ -1897,10 +2235,11 @@ type ReasonCodeSummary struct { noSmithyDocumentSerde } -// Describes a recommendation export job. Use the DescribeRecommendationExportJobs -// action to view your recommendation export jobs. Use the -// ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations -// actions to request an export of your recommendations. +// Describes a recommendation export job. +// +// Use the DescribeRecommendationExportJobs action to view your recommendation export jobs. +// +// Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. type RecommendationExportJob struct { // The timestamp of when the export job was created. @@ -1927,21 +2266,23 @@ type RecommendationExportJob struct { noSmithyDocumentSerde } -// Describes the recommendation preferences to return in the response of a -// GetAutoScalingGroupRecommendations , GetEC2InstanceRecommendations , and -// GetEC2RecommendationProjectedMetrics request. +// Describes the recommendation preferences to return in the response of a 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. + // Scaling group recommendations. + // + // For example, when you specify AWS_ARM64 with: + // + // - A GetEC2InstanceRecommendationsor GetAutoScalingGroupRecommendationsrequest, Compute Optimizer returns recommendations that consist of + // Graviton2 instance types only. + // + // - A GetEC2RecommendationProjectedMetricsrequest, Compute Optimizer returns projected utilization metrics for + // Graviton2 instance type recommendations only. + // + // - A ExportEC2InstanceRecommendationsor ExportAutoScalingGroupRecommendationsrequest, Compute Optimizer exports recommendations that consist of + // Graviton2 instance types only. CpuVendorArchitectures []CpuVendorArchitecture noSmithyDocumentSerde @@ -1951,58 +2292,70 @@ 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) - // in the Compute Optimizer User Guide. + // confirms that the preference isn't yet applied to recommendations. + // + // For more information, see [Enhanced infrastructure metrics] in the Compute Optimizer User Guide. + // + // [Enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html EnhancedInfrastructureMetrics EnhancedInfrastructureMetrics - // An object that describes the external metrics recommendation preference. If the - // preference is applied in the latest recommendation refresh, an object with a - // valid source value appears in the response. If the preference isn't applied to - // the recommendations already, then this object doesn't appear in the response. + // An object that describes the external metrics recommendation preference. + // + // If the preference is applied in the latest recommendation refresh, an object + // with a valid source value appears in the response. If the preference isn't + // applied to the recommendations already, then this object doesn't appear in the + // response. ExternalMetricsPreference *ExternalMetricsPreference - // The status of the inferred workload types 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. + // The status of the inferred workload types 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. InferredWorkloadTypes InferredWorkloadTypesPreference - // The preference to control the number of days the utilization metrics of the + // The preference to control the number of days the utilization metrics of the // Amazon Web Services resource are analyzed. If the preference isn’t set, this // object is null. LookBackPeriod LookBackPeriodPreference - // The preference to control which resource type values are considered when + // The preference to control which resource type values are considered when // generating rightsizing recommendations. This object resolves any wildcard // expressions and returns the effective list of candidate resource type values. If // the preference isn’t set, this object is null. PreferredResources []EffectivePreferredResource - // The target resource type of the recommendation preference to create. 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 target resource type of the recommendation preference to create. + // + // 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. ResourceType ResourceType - // Describes the savings estimation mode used for calculating savings opportunity. + // Describes the savings estimation mode used for calculating savings + // opportunity. + // // Only the account manager or delegated administrator of your organization can // activate this preference. SavingsEstimationMode SavingsEstimationMode // 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) - // in the Compute Optimizer User Guide. + // For more information, see [Activating enhanced infrastructure metrics]in the Compute Optimizer User Guide. + // + // [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html Scope *Scope - // The preference to control the resource’s CPU utilization threshold, CPU + // The preference to control the resource’s CPU utilization threshold, CPU // utilization headroom, and memory utilization headroom. If the preference isn’t - // set, this object is null. This preference is only available for the Amazon EC2 - // instance resource type. + // set, this object is null. + // + // This preference is only available for the Amazon EC2 instance resource type. UtilizationPreferences []UtilizationPreference noSmithyDocumentSerde @@ -2030,10 +2383,10 @@ type RecommendationSummary struct { // An object that describes the performance risk ratings for a given resource type. CurrentPerformanceRiskRatings *CurrentPerformanceRiskRatings - // An array of objects that describes the estimated monthly saving amounts for the - // instances running on the specified inferredWorkloadTypes . The array contains - // the top five savings opportunites for the instances that run inferred workload - // types. + // An array of objects that describes the estimated monthly saving amounts for + // the instances running on the specified inferredWorkloadTypes . The array + // contains the top five savings opportunites for the instances that run inferred + // workload types. InferredWorkloadSavings []InferredWorkloadSaving // The resource type that the recommendation summary applies to. @@ -2050,23 +2403,26 @@ 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 GetEC2RecommendationProjectedMetricsaction. 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]. +// +// [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 - // 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. + // The rank of the recommendation option projected metric. + // + // The top recommendation 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. Rank int32 // The recommended instance type. @@ -2083,27 +2439,31 @@ type S3Destination struct { // The name of the Amazon S3 bucket used as the destination of an export file. Bucket *string - // The Amazon S3 bucket key of an export file. The key uniquely identifies the - // object, or export file, in the S3 bucket. + // The Amazon S3 bucket key of an export file. + // + // The key uniquely identifies the object, or export file, in the S3 bucket. Key *string - // The Amazon S3 bucket key of a metadata file. The key uniquely identifies the - // object, or metadata file, in the S3 bucket. + // The Amazon S3 bucket key of a metadata file. + // + // The key uniquely identifies the object, or metadata file, in the S3 bucket. MetadataKey *string noSmithyDocumentSerde } // Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name -// and key prefix for a recommendations export job. You must create the destination -// Amazon S3 bucket for your recommendations export before you create the export -// job. Compute Optimizer does not create the S3 bucket for you. After you create -// 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 Compute Optimizer User Guide. +// and key prefix for a recommendations export job. +// +// You must create the destination Amazon S3 bucket for your recommendations +// export before you create the export job. Compute Optimizer does not create the +// S3 bucket for you. After you create 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]in the Compute Optimizer User Guide. +// +// [Amazon S3 Bucket Policy for Compute Optimizer]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html type S3DestinationConfig struct { // The name of the Amazon S3 bucket to use as the destination for an export job. @@ -2116,18 +2476,22 @@ type S3DestinationConfig struct { } // Describes the savings opportunity for recommendations of a given resource type -// or for the recommendation option of an individual resource. Savings opportunity -// represents the estimated monthly savings you can achieve by implementing a given -// Compute Optimizer recommendation. Savings opportunity data requires that you opt -// in to Cost Explorer, as well as activate Receive Amazon EC2 resource -// recommendations in the Cost Explorer preferences page. That creates a connection -// between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer -// 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) -// in the Cost Management User Guide. +// or for the recommendation option of an individual resource. +// +// Savings opportunity represents the estimated monthly savings you can achieve by +// implementing a given Compute Optimizer recommendation. +// +// Savings opportunity data requires that you opt in to Cost Explorer, as well as +// activate Receive Amazon EC2 resource recommendations in the Cost Explorer +// preferences page. That creates a connection between Cost Explorer and Compute +// Optimizer. With this connection, Cost Explorer 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]and [Optimizing your cost with Rightsizing Recommendations] in the Cost Management User Guide. +// +// [Optimizing your cost with Rightsizing Recommendations]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-rightsizing.html +// [Enabling Cost Explorer]: https://docs.aws.amazon.com/cost-management/latest/userguide/ce-enable.html type SavingsOpportunity struct { // An object that describes the estimated monthly savings amount possible by @@ -2142,35 +2506,50 @@ type SavingsOpportunity struct { noSmithyDocumentSerde } -// 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) -// 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 -// resource level by specifying a scope name of ResourceArn and a scope value of -// the Auto Scaling group Amazon Resource Name (ARN). This will configure the -// preference for all instances that are part of the specified Auto Scaling group. -// You also cannot create recommendation preferences at the resource level for -// instances that are part of an Auto Scaling group. You can create recommendation -// preferences at the resource level only for standalone instances. +// 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]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 resource level by specifying a scope name of +// ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name +// (ARN). This will configure the preference for all instances that are part of the +// specified Auto Scaling group. You also cannot create recommendation preferences +// at the resource level for instances that are part of an Auto Scaling group. You +// can create recommendation preferences at the resource level only for standalone +// instances. +// +// [Activating enhanced infrastructure metrics]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html type Scope struct { - // The name of the scope. The following scopes are possible: + // 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. Name ScopeName - // The value of the scope. If you specified the name of the scope as: + // 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. + // // Only EC2 instance and Auto Scaling group ARNs are currently supported. Value *string @@ -2180,31 +2559,37 @@ 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. + // 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: + // 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) - // in the Application Auto Scaling User Guide. + // + // For more information about step scaling and target scaling, see [Step scaling policies for Application Auto Scaling] and [Target tracking scaling policies for Application Auto Scaling] in the + // Application Auto Scaling User Guide. + // + // [Step scaling policies for Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html + // [Target tracking scaling policies for Application Auto Scaling]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html AutoScalingConfiguration AutoScalingConfiguration - // The container configurations within a task of an Amazon ECS service. + // The container configurations within a task of an Amazon ECS service. ContainerConfigurations []ContainerConfiguration - // The number of CPU units used by the tasks in the Amazon ECS service. + // The number of CPU units used by the tasks in the Amazon ECS service. Cpu *int32 - // The amount of memory used by the tasks in the Amazon ECS service. + // The amount of memory used by the tasks in the Amazon ECS service. Memory *int32 - // The task definition ARN used by the tasks in the Amazon ECS service. + // The task definition ARN used by the tasks in the Amazon ECS service. TaskDefinitionArn *string noSmithyDocumentSerde @@ -2228,11 +2613,11 @@ type Summary struct { // A list of tag key and value pairs that you define. type Tag struct { - // One part of a key-value pair that makes up a tag. A key is a general label that - // acts like a category for more specific tag values. + // One part of a key-value pair that makes up a tag. A key is a general label + // that acts like a category for more specific tag values. Key *string - // One part of a key-value pair that make up a tag. A value acts as a descriptor + // One part of a key-value pair that make up a tag. A value acts as a descriptor // within a tag category (key). The value can be empty or null. Value *string @@ -2240,80 +2625,125 @@ type Tag struct { } // Describes a utilization metric of a resource, such as an Amazon EC2 instance. +// // Compare the utilization metric data of your resource against its projected // utilization metric data to determine the performance difference between your // current resource and the recommended option. type UtilizationMetric struct { - // The name of the utilization metric. The following utilization metrics are - // available: + // 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 + // 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) - // . + // 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]. + // // - GPU - The percentage of allocated GPUs that currently run on the instance. + // // - GPU_MEMORY - The percentage of total GPU memory that currently runs on the - // instance. The GPU and GPU_MEMORY metrics are only returned for resources with - // the unified CloudWatch Agent installed on them. For more information, see - // Enabling NVIDIA GPU utilization with the CloudWatch Agent (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent) - // . + // instance. + // + // The GPU and GPU_MEMORY metrics are only returned for resources with the unified + // CloudWatch Agent installed on them. For more information, see [Enabling NVIDIA GPU utilization with the CloudWatch 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 + // 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 + // 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 + // 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 + // 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. + // 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. + // 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. + // 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. + // 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. + // + // [Enabling Memory Utilization with the CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent + // [Enabling NVIDIA GPU utilization with the CloudWatch Agent]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#nvidia-cw-agent 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 - // 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) - // 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) - // . + // 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]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]. + // + // [Viewing resource recommendations]: https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html + // [Amazon CloudWatch User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Statistic MetricStatistic // The value of the utilization metric. @@ -2322,15 +2752,17 @@ type UtilizationMetric struct { noSmithyDocumentSerde } -// The preference to control the resource’s CPU utilization thresholds - threshold -// and headroom. This preference is only available for the Amazon EC2 instance -// resource type. +// The preference to control the resource’s CPU utilization thresholds - +// +// threshold and headroom. +// +// This preference is only available for the Amazon EC2 instance resource type. type UtilizationPreference struct { - // The name of the resource utilization metric name to customize. + // The name of the resource utilization metric name to customize. MetricName CustomizableMetricName - // The parameters to set when customizing the resource utilization thresholds. + // The parameters to set when customizing the resource utilization thresholds. MetricParameters *CustomizableMetricParameters noSmithyDocumentSerde @@ -2340,7 +2772,7 @@ type UtilizationPreference struct { // volume. type VolumeConfiguration struct { - // Contains the image used to boot the instance during launch. + // Contains the image used to boot the instance during launch. RootVolume *bool // The baseline IOPS of the volume. @@ -2358,9 +2790,11 @@ type VolumeConfiguration struct { // The size of the volume, in GiB. VolumeSize int32 - // The volume type. This can be 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 volumes. + // The volume type. + // + // This can be 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 + // volumes. VolumeType *string noSmithyDocumentSerde @@ -2380,13 +2814,17 @@ type VolumeRecommendation struct { // have sufficient capacity. CurrentPerformanceRisk CurrentPerformanceRisk - // Describes the effective recommendation preferences for Amazon EBS volume. + // Describes the effective recommendation preferences for Amazon EBS volume. EffectiveRecommendationPreferences *EBSEffectiveRecommendationPreferences - // The finding classification of the volume. Findings for volumes include: + // 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 @@ -2399,7 +2837,7 @@ type VolumeRecommendation struct { // The number of days for which utilization metrics were analyzed for the volume. LookBackPeriodInDays float64 - // A list of tags assigned to your Amazon EBS volume recommendations. + // A list of tags assigned to your Amazon EBS volume recommendations. Tags []Tag // An array of objects that describe the utilization metrics of the volume. @@ -2421,17 +2859,21 @@ type VolumeRecommendationOption struct { // An array of objects that describe a volume configuration. Configuration *VolumeConfiguration - // 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 - // 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 before migrating your resource. + // 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 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 before + // migrating your resource. PerformanceRisk float64 - // The rank of the volume recommendation option. The top recommendation option is - // ranked as 1 . + // The rank of the volume recommendation option. + // + // The top recommendation option is ranked as 1 . Rank int32 // An object that describes the savings opportunity for the EBS volume @@ -2439,7 +2881,7 @@ type VolumeRecommendationOption struct { // savings amount and percentage. SavingsOpportunity *SavingsOpportunity - // An object that describes the savings opportunity for the Amazon EBS volume + // An object that describes the savings opportunity for the Amazon EBS volume // recommendation option with specific discounts. Savings opportunity includes the // estimated monthly savings and percentage. SavingsOpportunityAfterDiscounts *EBSSavingsOpportunityAfterDiscounts diff --git a/service/configservice/api_op_BatchGetAggregateResourceConfig.go b/service/configservice/api_op_BatchGetAggregateResourceConfig.go index fc8cdda284c..7013af78c36 100644 --- a/service/configservice/api_op_BatchGetAggregateResourceConfig.go +++ b/service/configservice/api_op_BatchGetAggregateResourceConfig.go @@ -15,7 +15,9 @@ 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. func (c *Client) BatchGetAggregateResourceConfig(ctx context.Context, params *BatchGetAggregateResourceConfigInput, optFns ...func(*Options)) (*BatchGetAggregateResourceConfigOutput, error) { if params == nil { diff --git a/service/configservice/api_op_BatchGetResourceConfig.go b/service/configservice/api_op_BatchGetResourceConfig.go index 86016d820df..007744ba65f 100644 --- a/service/configservice/api_op_BatchGetResourceConfig.go +++ b/service/configservice/api_op_BatchGetResourceConfig.go @@ -15,7 +15,9 @@ 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. @@ -52,8 +54,9 @@ type BatchGetResourceConfigOutput struct { // A list of resource keys that were not processed with the current response. The // unprocessesResourceKeys value is in the same form as ResourceKeys, so the value - // can be directly provided to a subsequent BatchGetResourceConfig operation. If - // there are no unprocessed resource keys, the response contains an empty + // can be directly provided to a subsequent BatchGetResourceConfig operation. + // + // If there are no unprocessed resource keys, the response contains an empty // unprocessedResourceKeys list. UnprocessedResourceKeys []types.ResourceKey diff --git a/service/configservice/api_op_DeleteConfigRule.go b/service/configservice/api_op_DeleteConfigRule.go index a4f646cd185..96a59fdd847 100644 --- a/service/configservice/api_op_DeleteConfigRule.go +++ b/service/configservice/api_op_DeleteConfigRule.go @@ -10,11 +10,14 @@ 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 -// update a rule while it is in this state. If you make a PutConfigRule or +// 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. +// . +// +// 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 01beae0c9bf..498928f05e5 100644 --- a/service/configservice/api_op_DeleteConfigurationRecorder.go +++ b/service/configservice/api_op_DeleteConfigurationRecorder.go @@ -10,13 +10,16 @@ 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 -// 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 -// you create a new configuration recorder. +// 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 you create a new configuration +// recorder. func (c *Client) DeleteConfigurationRecorder(ctx context.Context, params *DeleteConfigurationRecorderInput, optFns ...func(*Options)) (*DeleteConfigurationRecorderOutput, error) { if params == nil { params = &DeleteConfigurationRecorderInput{} diff --git a/service/configservice/api_op_DeleteConformancePack.go b/service/configservice/api_op_DeleteConformancePack.go index 9cecabe7e79..45f5ccc2ba8 100644 --- a/service/configservice/api_op_DeleteConformancePack.go +++ b/service/configservice/api_op_DeleteConformancePack.go @@ -11,9 +11,10 @@ import ( ) // Deletes the specified conformance pack and all the Config rules, remediation -// actions, and all evaluation results within that conformance pack. Config sets -// the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You -// cannot update a conformance pack while it is in this state. +// actions, and all evaluation results within that conformance pack. +// +// Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is +// complete. You cannot update a conformance pack while it is in this state. func (c *Client) DeleteConformancePack(ctx context.Context, params *DeleteConformancePackInput, optFns ...func(*Options)) (*DeleteConformancePackOutput, error) { if params == nil { params = &DeleteConformancePackInput{} diff --git a/service/configservice/api_op_DeleteDeliveryChannel.go b/service/configservice/api_op_DeleteDeliveryChannel.go index be717b388f7..3e29242f7ec 100644 --- a/service/configservice/api_op_DeleteDeliveryChannel.go +++ b/service/configservice/api_op_DeleteDeliveryChannel.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the delivery channel. Before you can delete the delivery channel, you -// must stop the configuration recorder by using the StopConfigurationRecorder -// action. +// Deletes the delivery channel. +// +// Before you can delete the delivery channel, you must stop the configuration +// recorder by using the StopConfigurationRecorderaction. func (c *Client) DeleteDeliveryChannel(ctx context.Context, params *DeleteDeliveryChannelInput, optFns ...func(*Options)) (*DeleteDeliveryChannelOutput, error) { if params == nil { params = &DeleteDeliveryChannelInput{} @@ -28,8 +29,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_DeleteEvaluationResults.go b/service/configservice/api_op_DeleteEvaluationResults.go index bc942461549..8d14d547e6b 100644 --- a/service/configservice/api_op_DeleteEvaluationResults.go +++ b/service/configservice/api_op_DeleteEvaluationResults.go @@ -12,8 +12,8 @@ import ( // Deletes the evaluation results for the specified Config rule. You can specify // one Config rule per request. After you delete the evaluation results, you can -// call the StartConfigRulesEvaluation API to start evaluating your Amazon Web -// Services resources against the rule. +// call the StartConfigRulesEvaluationAPI to start evaluating your Amazon Web Services resources against the +// rule. func (c *Client) DeleteEvaluationResults(ctx context.Context, params *DeleteEvaluationResultsInput, optFns ...func(*Options)) (*DeleteEvaluationResultsOutput, error) { if params == nil { params = &DeleteEvaluationResultsInput{} diff --git a/service/configservice/api_op_DeleteOrganizationConfigRule.go b/service/configservice/api_op_DeleteOrganizationConfigRule.go index 0525a0734dd..0ebf913298f 100644 --- a/service/configservice/api_op_DeleteOrganizationConfigRule.go +++ b/service/configservice/api_op_DeleteOrganizationConfigRule.go @@ -11,12 +11,14 @@ import ( ) // 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. +// 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_DeleteOrganizationConformancePack.go b/service/configservice/api_op_DeleteOrganizationConformancePack.go index bb5b313f795..fbd0c6385bc 100644 --- a/service/configservice/api_op_DeleteOrganizationConformancePack.go +++ b/service/configservice/api_op_DeleteOrganizationConformancePack.go @@ -11,13 +11,16 @@ import ( ) // Deletes the specified organization conformance pack and all of the Config rules -// and remediation actions from all member accounts in that organization. Only a -// management account or a delegated administrator account can delete an +// and remediation actions from all member accounts in that organization. +// +// Only a management account or a delegated administrator account can delete an // organization conformance pack. When calling this API with a delegated // administrator, you must ensure Organizations ListDelegatedAdministrator -// permissions are added. Config sets the state of a conformance pack to -// DELETE_IN_PROGRESS until the deletion is complete. You cannot update a -// conformance pack while it is in this state. +// permissions are added. +// +// Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the +// deletion is complete. You cannot update a conformance pack while it is in this +// state. func (c *Client) DeleteOrganizationConformancePack(ctx context.Context, params *DeleteOrganizationConformancePackInput, optFns ...func(*Options)) (*DeleteOrganizationConformancePackOutput, error) { if params == nil { params = &DeleteOrganizationConformancePackInput{} diff --git a/service/configservice/api_op_DeleteRemediationExceptions.go b/service/configservice/api_op_DeleteRemediationExceptions.go index dca533d2d17..81b9d79f79e 100644 --- a/service/configservice/api_op_DeleteRemediationExceptions.go +++ b/service/configservice/api_op_DeleteRemediationExceptions.go @@ -12,6 +12,7 @@ import ( ) // Deletes one or more remediation exceptions mentioned in the resource keys. +// // Config generates a remediation exception when a problem occurs executing a // remediation action to a specific resource. Remediation exceptions blocks // auto-remediation until the exception is cleared. diff --git a/service/configservice/api_op_DeliverConfigSnapshot.go b/service/configservice/api_op_DeliverConfigSnapshot.go index aa76fa5cd41..88f9577fe70 100644 --- a/service/configservice/api_op_DeliverConfigSnapshot.go +++ b/service/configservice/api_op_DeliverConfigSnapshot.go @@ -13,9 +13,12 @@ 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. func (c *Client) DeliverConfigSnapshot(ctx context.Context, params *DeliverConfigSnapshotInput, optFns ...func(*Options)) (*DeliverConfigSnapshotOutput, error) { if params == nil { diff --git a/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go b/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go index 5df19b5b226..500b1a02877 100644 --- a/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go +++ b/service/configservice/api_op_DescribeAggregateComplianceByConfigRules.go @@ -13,8 +13,10 @@ 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. +// compliance results. +// +// The results can return an empty result page, but if you have 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 9ab74832303..2f2b772d837 100644 --- a/service/configservice/api_op_DescribeAggregateComplianceByConformancePacks.go +++ b/service/configservice/api_op_DescribeAggregateComplianceByConformancePacks.go @@ -15,8 +15,10 @@ import ( // with the count of compliant and noncompliant Config rules within each // 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. +// insufficient data. +// +// The results can return an empty result page, but if you have 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 a1c67ae3254..83838ee3375 100644 --- a/service/configservice/api_op_DescribeComplianceByConfigRule.go +++ b/service/configservice/api_op_DescribeComplianceByConfigRule.go @@ -13,17 +13,23 @@ import ( // Indicates whether the specified Config rules are compliant. If a rule is // noncompliant, this action returns the number of Amazon Web Services resources -// 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 +// 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. diff --git a/service/configservice/api_op_DescribeComplianceByResource.go b/service/configservice/api_op_DescribeComplianceByResource.go index fd242addded..9d5366e2430 100644 --- a/service/configservice/api_op_DescribeComplianceByResource.go +++ b/service/configservice/api_op_DescribeComplianceByResource.go @@ -13,18 +13,24 @@ import ( // Indicates whether the specified Amazon Web Services resources are compliant. If // a resource is noncompliant, this action returns the number of Config rules that -// 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 following conditions about the rules that evaluate the resource: +// 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 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. diff --git a/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go b/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go index a1ccfa93326..42ca61c3ba1 100644 --- a/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go +++ b/service/configservice/api_op_DescribeConfigRuleEvaluationStatus.go @@ -37,10 +37,15 @@ type DescribeConfigRuleEvaluationStatusInput struct { // managed rules that you use. ConfigRuleNames []string - // 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 1000 - // 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. + // 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 1000 rules. + // + // For information about requesting a rule limit increase, see [Config Limits] in the Amazon Web + // Services General Reference Guide. + // + // [Config Limits]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config Limit int32 // The nextToken string returned on a previous page that you use to get the next @@ -152,10 +157,15 @@ var _ DescribeConfigRuleEvaluationStatusAPIClient = (*Client)(nil) // DescribeConfigRuleEvaluationStatusPaginatorOptions is the paginator options for // DescribeConfigRuleEvaluationStatus 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 1000 - // 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. + // 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 1000 rules. + // + // For information about requesting a rule limit increase, see [Config Limits] in the Amazon Web + // Services General Reference Guide. + // + // [Config Limits]: http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/configservice/api_op_DescribeConfigRules.go b/service/configservice/api_op_DescribeConfigRules.go index c8c6a77765c..8327f20ce90 100644 --- a/service/configservice/api_op_DescribeConfigRules.go +++ b/service/configservice/api_op_DescribeConfigRules.go @@ -35,8 +35,9 @@ 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) - // in the Config Developer Guide. + // Config rules, see [Evaluation Mode]in the Config Developer Guide. + // + // [Evaluation Mode]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html Filters *types.DescribeConfigRulesFilters // The nextToken string returned on a previous page that you use to get the next diff --git a/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go b/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go index ce171e40ed8..bd43b5bc91e 100644 --- a/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go +++ b/service/configservice/api_op_DescribeConfigurationAggregatorSourcesStatus.go @@ -46,8 +46,11 @@ 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. UpdateStatus []types.AggregatedSourceStatusType diff --git a/service/configservice/api_op_DescribeConfigurationRecorderStatus.go b/service/configservice/api_op_DescribeConfigurationRecorderStatus.go index 0e23191f02a..dab6442d321 100644 --- a/service/configservice/api_op_DescribeConfigurationRecorderStatus.go +++ b/service/configservice/api_op_DescribeConfigurationRecorderStatus.go @@ -14,10 +14,11 @@ import ( // Returns the current status of the specified configuration recorder as well as // the status of the last recording event for the recorder. If a configuration // recorder is not specified, this action returns the status of all configuration -// recorders associated with the account. >You can specify only one configuration -// recorder for each Amazon Web Services Region for each account. For a detailed -// status of recording events over time, add your Config events to Amazon -// CloudWatch metrics and use CloudWatch metrics. +// recorders associated with the account. +// +// >You can specify only one configuration recorder for each Amazon Web Services +// Region for each account. For a detailed status of recording events over time, +// add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics. func (c *Client) DescribeConfigurationRecorderStatus(ctx context.Context, params *DescribeConfigurationRecorderStatusInput, optFns ...func(*Options)) (*DescribeConfigurationRecorderStatusOutput, error) { if params == nil { params = &DescribeConfigurationRecorderStatusInput{} diff --git a/service/configservice/api_op_DescribeConfigurationRecorders.go b/service/configservice/api_op_DescribeConfigurationRecorders.go index 74f1a58d24c..1fe7b6909f6 100644 --- a/service/configservice/api_op_DescribeConfigurationRecorders.go +++ b/service/configservice/api_op_DescribeConfigurationRecorders.go @@ -13,8 +13,10 @@ import ( // Returns the details for the specified configuration recorders. If the // configuration recorder is not specified, this action returns the details for all -// configuration recorders associated with the account. You can specify only one -// configuration recorder for each Amazon Web Services Region for each account. +// configuration recorders associated with the account. +// +// You can specify only one configuration recorder for each Amazon Web Services +// Region for each account. func (c *Client) DescribeConfigurationRecorders(ctx context.Context, params *DescribeConfigurationRecordersInput, optFns ...func(*Options)) (*DescribeConfigurationRecordersOutput, error) { if params == nil { params = &DescribeConfigurationRecordersInput{} diff --git a/service/configservice/api_op_DescribeConformancePackCompliance.go b/service/configservice/api_op_DescribeConformancePackCompliance.go index 8d3fca4031b..38829fa2086 100644 --- a/service/configservice/api_op_DescribeConformancePackCompliance.go +++ b/service/configservice/api_op_DescribeConformancePackCompliance.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns compliance details for each rule in that conformance pack. You must -// provide exact rule names. +// Returns compliance details for each rule in that conformance pack. +// +// You must provide exact rule names. func (c *Client) DescribeConformancePackCompliance(ctx context.Context, params *DescribeConformancePackComplianceInput, optFns ...func(*Options)) (*DescribeConformancePackComplianceOutput, error) { if params == nil { params = &DescribeConformancePackComplianceInput{} diff --git a/service/configservice/api_op_DescribeConformancePackStatus.go b/service/configservice/api_op_DescribeConformancePackStatus.go index dbe238b3096..2eee2285d1c 100644 --- a/service/configservice/api_op_DescribeConformancePackStatus.go +++ b/service/configservice/api_op_DescribeConformancePackStatus.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides one or more conformance packs deployment status. If there are no -// conformance packs then you will see an empty result. +// Provides one or more conformance packs deployment status. +// +// If there are no conformance packs then you will see an empty result. func (c *Client) DescribeConformancePackStatus(ctx context.Context, params *DescribeConformancePackStatusInput, optFns ...func(*Options)) (*DescribeConformancePackStatusOutput, error) { if params == nil { params = &DescribeConformancePackStatusInput{} diff --git a/service/configservice/api_op_DescribeDeliveryChannelStatus.go b/service/configservice/api_op_DescribeDeliveryChannelStatus.go index b25e00664f9..56dec55ce70 100644 --- a/service/configservice/api_op_DescribeDeliveryChannelStatus.go +++ b/service/configservice/api_op_DescribeDeliveryChannelStatus.go @@ -13,8 +13,9 @@ import ( // Returns the current status of the specified delivery channel. If a delivery // channel is not specified, this action returns the current status of all delivery -// channels associated with the account. Currently, you can specify only one -// delivery channel per region in your account. +// channels associated with the account. +// +// Currently, you can specify only one delivery channel per region in your account. func (c *Client) DescribeDeliveryChannelStatus(ctx context.Context, params *DescribeDeliveryChannelStatusInput, optFns ...func(*Options)) (*DescribeDeliveryChannelStatusOutput, error) { if params == nil { params = &DescribeDeliveryChannelStatusInput{} diff --git a/service/configservice/api_op_DescribeDeliveryChannels.go b/service/configservice/api_op_DescribeDeliveryChannels.go index 548afd7993d..e83e21ef42e 100644 --- a/service/configservice/api_op_DescribeDeliveryChannels.go +++ b/service/configservice/api_op_DescribeDeliveryChannels.go @@ -13,8 +13,9 @@ import ( // Returns details about the specified delivery channel. If a delivery channel is // not specified, this action returns the details of all delivery channels -// associated with the account. Currently, you can specify only one delivery -// channel per region in your account. +// associated with the account. +// +// Currently, you can specify only one delivery channel per region in your account. func (c *Client) DescribeDeliveryChannels(ctx context.Context, params *DescribeDeliveryChannelsInput, optFns ...func(*Options)) (*DescribeDeliveryChannelsOutput, error) { if params == nil { params = &DescribeDeliveryChannelsInput{} diff --git a/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go b/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go index 05b00652c54..bba96e2c483 100644 --- a/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go +++ b/service/configservice/api_op_DescribeOrganizationConfigRuleStatuses.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides organization Config rule deployment status for an organization. The -// status is not considered successful until organization Config rule is +// Provides organization Config rule deployment status for an organization. +// +// The status is not considered successful until organization Config rule is // successfully deployed in all the member accounts with an exception of excluded -// accounts. When you specify the limit and the next token, you receive a paginated +// accounts. +// +// 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 // Config rule names. It is only applicable, when you request all the organization // Config rules. diff --git a/service/configservice/api_op_DescribeOrganizationConfigRules.go b/service/configservice/api_op_DescribeOrganizationConfigRules.go index fec0f441435..73a63e9c429 100644 --- a/service/configservice/api_op_DescribeOrganizationConfigRules.go +++ b/service/configservice/api_op_DescribeOrganizationConfigRules.go @@ -11,17 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of organization Config rules. 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 Config rule names. It is only applicable, -// when you request all the organization Config rules. For accounts within an -// organization 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 the delegated -// administrator account, you won't be able to see the organizational rule or -// conformance pack in the organization administrator account from the delegated -// administrator account or see the organizational rule or conformance pack in the -// delegated administrator account from organization administrator account. The +// Returns a list of organization Config rules. +// +// 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 Config rule +// names. It is only applicable, when you request all the organization Config +// rules. +// +// # For accounts within an organization +// +// 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 the delegated administrator +// account, you won't be able to see the organizational rule or conformance pack in +// the organization administrator account from the delegated administrator account +// or see the organizational rule or conformance pack in the delegated +// administrator account from organization administrator account. The // DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs // can only see and interact with the organization-related resource that were // deployed from within the account calling those APIs. diff --git a/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go b/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go index 45f423c9a0c..5a80020457f 100644 --- a/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go +++ b/service/configservice/api_op_DescribeOrganizationConformancePackStatuses.go @@ -12,9 +12,12 @@ import ( ) // Provides organization conformance pack deployment status for an organization. +// // The status is not considered successful until organization conformance pack is // successfully deployed in all the member accounts with an exception of excluded -// accounts. When you specify the limit and the next token, you receive a paginated +// accounts. +// +// 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 pack names. They are only applicable, when you request all the // organization conformance packs. diff --git a/service/configservice/api_op_DescribeOrganizationConformancePacks.go b/service/configservice/api_op_DescribeOrganizationConformancePacks.go index e1f134ba51c..1e7c30dc1eb 100644 --- a/service/configservice/api_op_DescribeOrganizationConformancePacks.go +++ b/service/configservice/api_op_DescribeOrganizationConformancePacks.go @@ -11,21 +11,27 @@ 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 -// accounts within an organization 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 -// the delegated administrator account, you won't be able to see the organizational -// rule or conformance pack in the organization administrator account from the -// delegated administrator account or see the organizational rule or conformance -// pack in the delegated administrator account from organization administrator -// account. The DescribeOrganizationConfigRules and -// DescribeOrganizationConformancePacks APIs can only see and interact with the -// organization-related resource that were deployed from within the account calling -// those APIs. +// 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 organization +// +// 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 the delegated administrator +// account, you won't be able to see the organizational rule or conformance pack in +// the organization administrator account from the delegated administrator account +// or see the organizational rule or conformance pack in the delegated +// administrator account from organization administrator account. The +// DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs +// can only see and interact with the organization-related resource that were +// deployed from within the account calling those APIs. func (c *Client) DescribeOrganizationConformancePacks(ctx context.Context, params *DescribeOrganizationConformancePacksInput, optFns ...func(*Options)) (*DescribeOrganizationConformancePacksOutput, error) { if params == nil { params = &DescribeOrganizationConformancePacksInput{} diff --git a/service/configservice/api_op_DescribeRemediationExceptions.go b/service/configservice/api_op_DescribeRemediationExceptions.go index a3183d9c438..00458629c8b 100644 --- a/service/configservice/api_op_DescribeRemediationExceptions.go +++ b/service/configservice/api_op_DescribeRemediationExceptions.go @@ -14,12 +14,17 @@ import ( // Returns the details of one or more remediation exceptions. A detailed view of a // remediation exception for a set of resources that includes an explanation of an // exception and the time when the exception will be deleted. When you specify the -// limit and the next token, you receive a paginated response. Config generates a -// remediation exception when a problem occurs executing a remediation action to a -// specific resource. Remediation exceptions blocks auto-remediation until the -// exception is cleared. When you specify the limit and the next token, you receive -// a paginated response. Limit and next token are not applicable if you request -// resources in batch. It is only applicable, when you request all resources. +// limit and the next token, you receive a paginated response. +// +// Config generates a remediation exception when a problem occurs executing a +// remediation action to a specific resource. Remediation exceptions blocks +// auto-remediation until the exception is cleared. +// +// When you specify the limit and the next token, you receive a paginated +// response. +// +// Limit and next token are not applicable if you request resources in batch. It +// is only applicable, when you request all resources. func (c *Client) DescribeRemediationExceptions(ctx context.Context, params *DescribeRemediationExceptionsInput, optFns ...func(*Options)) (*DescribeRemediationExceptionsOutput, error) { if params == nil { params = &DescribeRemediationExceptionsInput{} diff --git a/service/configservice/api_op_DescribeRetentionConfigurations.go b/service/configservice/api_op_DescribeRetentionConfigurations.go index bd256687d8d..cbf4bc8e58b 100644 --- a/service/configservice/api_op_DescribeRetentionConfigurations.go +++ b/service/configservice/api_op_DescribeRetentionConfigurations.go @@ -13,8 +13,10 @@ import ( // Returns the details of one or more retention configurations. If the retention // configuration name is not specified, this action returns the details for all the -// retention configurations for that account. Currently, Config supports only one -// retention configuration per region in your account. +// retention configurations for that account. +// +// Currently, Config supports only one retention configuration per region in your +// account. func (c *Client) DescribeRetentionConfigurations(ctx context.Context, params *DescribeRetentionConfigurationsInput, optFns ...func(*Options)) (*DescribeRetentionConfigurationsOutput, error) { if params == nil { params = &DescribeRetentionConfigurationsInput{} @@ -38,8 +40,10 @@ type DescribeRetentionConfigurationsInput struct { // A list of names of retention configurations for which you want details. If you // do not specify a name, Config returns details for all the retention - // configurations for that account. Currently, Config supports only one retention - // configuration per region in your account. + // configurations for that account. + // + // Currently, Config supports only one retention configuration per region in your + // account. RetentionConfigurationNames []string noSmithyDocumentSerde diff --git a/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go b/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go index 7dbb6355f41..8709546fe68 100644 --- a/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go +++ b/service/configservice/api_op_GetAggregateComplianceDetailsByConfigRule.go @@ -14,8 +14,10 @@ import ( // Returns the evaluation results for the specified Config rule for a specific // 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. +// 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. func (c *Client) GetAggregateComplianceDetailsByConfigRule(ctx context.Context, params *GetAggregateComplianceDetailsByConfigRuleInput, optFns ...func(*Options)) (*GetAggregateComplianceDetailsByConfigRuleOutput, error) { if params == nil { params = &GetAggregateComplianceDetailsByConfigRuleInput{} @@ -53,10 +55,11 @@ type GetAggregateComplianceDetailsByConfigRuleInput struct { // This member is required. ConfigurationAggregatorName *string - // 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 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. 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 62b525380f5..fb0b09a4de3 100644 --- a/service/configservice/api_op_GetAggregateConfigRuleComplianceSummary.go +++ b/service/configservice/api_op_GetAggregateConfigRuleComplianceSummary.go @@ -12,8 +12,10 @@ import ( ) // Returns the number of compliant and noncompliant rules for one or more accounts -// and regions in an aggregator. The results can return an empty result page, but -// if you have a nextToken, the results are displayed on the next page. +// and regions in an aggregator. +// +// The results can return an empty result page, but if you have a nextToken, the +// results are displayed on the next page. func (c *Client) GetAggregateConfigRuleComplianceSummary(ctx context.Context, params *GetAggregateConfigRuleComplianceSummaryInput, optFns ...func(*Options)) (*GetAggregateConfigRuleComplianceSummaryOutput, error) { if params == nil { params = &GetAggregateConfigRuleComplianceSummaryInput{} diff --git a/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go b/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go index 1d87ac49abf..c1a8e96ce27 100644 --- a/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go +++ b/service/configservice/api_op_GetAggregateConformancePackComplianceSummary.go @@ -14,8 +14,10 @@ import ( // Returns the count of compliant and noncompliant conformance packs across all // Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. // You can filter based on Amazon Web Services account ID or Amazon Web Services -// Region. The results can return an empty result page, but if you have a -// nextToken, the results are displayed on the next page. +// Region. +// +// The results can return an empty result page, but if you have a nextToken, the +// results are displayed on the next page. func (c *Client) GetAggregateConformancePackComplianceSummary(ctx context.Context, params *GetAggregateConformancePackComplianceSummaryInput, optFns ...func(*Options)) (*GetAggregateConformancePackComplianceSummaryOutput, error) { if params == nil { params = &GetAggregateConformancePackComplianceSummaryInput{} diff --git a/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go b/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go index 5be69a7bd07..ea7e1b3cf31 100644 --- a/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go +++ b/service/configservice/api_op_GetAggregateDiscoveredResourceCounts.go @@ -13,11 +13,13 @@ import ( // 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. +// 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) { if params == nil { params = &GetAggregateDiscoveredResourceCountsInput{} @@ -46,9 +48,9 @@ type GetAggregateDiscoveredResourceCountsInput struct { // The key to group the resource counts. GroupByKey types.ResourceCountGroupKey - // The maximum number of GroupedResourceCount objects returned on each page. The - // default is 1000. You cannot specify a number greater than 1000. If you specify - // 0, Config uses the default. + // The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You + // cannot specify a number greater than 1000. 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 @@ -173,9 +175,9 @@ var _ GetAggregateDiscoveredResourceCountsAPIClient = (*Client)(nil) // GetAggregateDiscoveredResourceCountsPaginatorOptions is the paginator options // for GetAggregateDiscoveredResourceCounts type GetAggregateDiscoveredResourceCountsPaginatorOptions struct { - // The maximum number of GroupedResourceCount objects returned on each page. The - // default is 1000. You cannot specify a number greater than 1000. If you specify - // 0, Config uses the default. + // The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You + // cannot specify a number greater than 1000. 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_GetComplianceDetailsByConfigRule.go b/service/configservice/api_op_GetComplianceDetailsByConfigRule.go index daec5910b11..07b5d6feeda 100644 --- a/service/configservice/api_op_GetComplianceDetailsByConfigRule.go +++ b/service/configservice/api_op_GetComplianceDetailsByConfigRule.go @@ -37,9 +37,11 @@ type GetComplianceDetailsByConfigRuleInput struct { // This member is required. ConfigRuleName *string - // Filters the results by compliance. INSUFFICIENT_DATA is a valid ComplianceType - // that is returned when an Config rule cannot be evaluated. However, - // INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results. + // Filters the results by compliance. + // + // INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config + // rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a + // ComplianceType for filtering results. ComplianceTypes []types.ComplianceType // The maximum number of evaluation results returned on each page. The default is diff --git a/service/configservice/api_op_GetComplianceDetailsByResource.go b/service/configservice/api_op_GetComplianceDetailsByResource.go index 1d049b9e6f3..48410f1f6ff 100644 --- a/service/configservice/api_op_GetComplianceDetailsByResource.go +++ b/service/configservice/api_op_GetComplianceDetailsByResource.go @@ -31,9 +31,11 @@ func (c *Client) GetComplianceDetailsByResource(ctx context.Context, params *Get type GetComplianceDetailsByResourceInput struct { - // Filters the results by compliance. INSUFFICIENT_DATA is a valid ComplianceType - // that is returned when an Config rule cannot be evaluated. However, - // INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results. + // Filters the results by compliance. + // + // INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config + // rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a + // ComplianceType for filtering results. ComplianceTypes []types.ComplianceType // The nextToken string returned on a previous page that you use to get the next @@ -41,8 +43,10 @@ type GetComplianceDetailsByResourceInput struct { NextToken *string // 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 . + // retrieve evaluation results. + // + // You need to only provide either a 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 9ba9e38a5da..cd57ab8d40b 100644 --- a/service/configservice/api_op_GetComplianceSummaryByResourceType.go +++ b/service/configservice/api_op_GetComplianceSummaryByResourceType.go @@ -32,8 +32,9 @@ func (c *Client) GetComplianceSummaryByResourceType(ctx context.Context, params 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 + // 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 . ResourceTypes []string diff --git a/service/configservice/api_op_GetDiscoveredResourceCounts.go b/service/configservice/api_op_GetDiscoveredResourceCounts.go index c7a69003b06..9bd28e82f00 100644 --- a/service/configservice/api_op_GetDiscoveredResourceCounts.go +++ b/service/configservice/api_op_GetDiscoveredResourceCounts.go @@ -13,27 +13,38 @@ 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 +// 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). // -// 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: +// 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. // // It might take a few minutes for Config to record and count your resources. Wait -// a few minutes and then retry the GetDiscoveredResourceCounts action. +// a few minutes and then retry the GetDiscoveredResourceCountsaction. func (c *Client) GetDiscoveredResourceCounts(ctx context.Context, params *GetDiscoveredResourceCountsInput, optFns ...func(*Options)) (*GetDiscoveredResourceCountsOutput, error) { if params == nil { params = &GetDiscoveredResourceCountsInput{} @@ -51,9 +62,9 @@ func (c *Client) GetDiscoveredResourceCounts(ctx context.Context, params *GetDis type GetDiscoveredResourceCountsInput struct { - // The maximum number of ResourceCount objects 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 ResourceCount objects 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 @@ -61,13 +72,15 @@ 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 @@ -85,12 +98,17 @@ 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 + // 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 . TotalDiscoveredResources int64 @@ -187,9 +205,9 @@ var _ GetDiscoveredResourceCountsAPIClient = (*Client)(nil) // GetDiscoveredResourceCountsPaginatorOptions is the paginator options for // GetDiscoveredResourceCounts type GetDiscoveredResourceCountsPaginatorOptions struct { - // The maximum number of ResourceCount objects 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 ResourceCount objects 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_GetResourceConfigHistory.go b/service/configservice/api_op_GetResourceConfigHistory.go index 359757fbc51..cc560130ade 100644 --- a/service/configservice/api_op_GetResourceConfigHistory.go +++ b/service/configservice/api_op_GetResourceConfigHistory.go @@ -13,20 +13,25 @@ import ( ) // For accurate reporting on the compliance status, you must record the -// AWS::Config::ResourceCompliance resource type. For more information, see -// Selecting Which Resources Config Records (https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html) -// . Returns a list of ConfigurationItems for the specified resource. The list +// AWS::Config::ResourceCompliance resource type. For more information, see [Selecting Which Resources Config Records]. +// +// Returns a list of ConfigurationItems for the specified resource. The list // contains details about each state of the resource during the specified time // interval. If you specified a retention period to retain your ConfigurationItems // between a minimum of 30 days and a maximum of 7 years (2557 days), Config -// returns the ConfigurationItems for the specified retention period. The response -// is paginated. By default, Config returns a limit of 10 configuration items per -// 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. 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 . +// returns the ConfigurationItems for the specified retention period. +// +// The response is paginated. By default, Config returns a limit of 10 +// configuration items per 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. +// +// 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 . +// +// [Selecting Which Resources Config Records]: https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html func (c *Client) GetResourceConfigHistory(ctx context.Context, params *GetResourceConfigHistoryInput, optFns ...func(*Options)) (*GetResourceConfigHistoryOutput, error) { if params == nil { params = &GetResourceConfigHistoryInput{} diff --git a/service/configservice/api_op_GetResourceEvaluationSummary.go b/service/configservice/api_op_GetResourceEvaluationSummary.go index e12454a8ed7..43f0d1bab59 100644 --- a/service/configservice/api_op_GetResourceEvaluationSummary.go +++ b/service/configservice/api_op_GetResourceEvaluationSummary.go @@ -16,11 +16,14 @@ import ( // ID from the proactive rules that were run. The results indicate which evaluation // context was used to evaluate the rules, which resource details were evaluated, // 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) +// 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]API. For more information, see the [Examples] // section. +// +// [GetComplianceDetailsByResource]: https://docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html +// [Examples]: https://docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples func (c *Client) GetResourceEvaluationSummary(ctx context.Context, params *GetResourceEvaluationSummaryInput, optFns ...func(*Options)) (*GetResourceEvaluationSummaryOutput, error) { if params == nil { params = &GetResourceEvaluationSummaryInput{} diff --git a/service/configservice/api_op_ListAggregateDiscoveredResources.go b/service/configservice/api_op_ListAggregateDiscoveredResources.go index 4e1cc9c3383..e8c1d904043 100644 --- a/service/configservice/api_op_ListAggregateDiscoveredResources.go +++ b/service/configservice/api_op_ListAggregateDiscoveredResources.go @@ -16,10 +16,11 @@ import ( // identifier includes the resource type, ID, (if available) the custom resource // name, source account, and source region. You can narrow the results to include // only resources that have specific resource IDs, or a resource name, or source -// account ID, or source region. For example, if the input consists of accountID -// 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance -// then the API returns all the EC2 instance identifiers of accountID 12345678910 -// and region us-east-1. +// account ID, or source region. +// +// For example, if the input consists of accountID 12345678910 and the region is +// us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 +// instance identifiers of accountID 12345678910 and region us-east-1. func (c *Client) ListAggregateDiscoveredResources(ctx context.Context, params *ListAggregateDiscoveredResourcesInput, optFns ...func(*Options)) (*ListAggregateDiscoveredResourcesOutput, error) { if params == nil { params = &ListAggregateDiscoveredResourcesInput{} diff --git a/service/configservice/api_op_ListConformancePackComplianceScores.go b/service/configservice/api_op_ListConformancePackComplianceScores.go index 85ccfa5f663..55521b775b0 100644 --- a/service/configservice/api_op_ListConformancePackComplianceScores.go +++ b/service/configservice/api_op_ListConformancePackComplianceScores.go @@ -17,8 +17,10 @@ import ( // combinations in the conformance pack. This metric provides you with a high-level // 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 . +// conformance packs. +// +// Conformance packs with no evaluation results will have a compliance score of +// INSUFFICIENT_DATA . func (c *Client) ListConformancePackComplianceScores(ctx context.Context, params *ListConformancePackComplianceScoresInput, optFns ...func(*Options)) (*ListConformancePackComplianceScoresOutput, error) { if params == nil { params = &ListConformancePackComplianceScoresInput{} @@ -47,21 +49,25 @@ 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 , - // to sort conformance pack compliance scores by the numerical value of the - // compliance 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 // Determines the order in which conformance pack compliance scores are sorted. - // 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 - // 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 - // score of INSUFFICIENT_DATA will be last when sorting by ascending order and - // first when sorting by descending order. + // 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 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 score of + // INSUFFICIENT_DATA will be last when sorting by ascending order and first when + // sorting by descending order. SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/configservice/api_op_ListDiscoveredResources.go b/service/configservice/api_op_ListDiscoveredResources.go index 03b8247025e..66a16ffbac5 100644 --- a/service/configservice/api_op_ListDiscoveredResources.go +++ b/service/configservice/api_op_ListDiscoveredResources.go @@ -16,12 +16,15 @@ import ( // and (if available) the custom resource name. The results consist of resources // that Config has discovered, including those that Config is not currently // recording. You can narrow the results to include only resources that have -// specific resource IDs or a resource name. You can specify either resource IDs or -// a resource name, but not both, in the same request. The response is paginated. -// By default, Config lists 100 resource identifiers 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. +// specific resource IDs or a resource name. +// +// You can specify either resource IDs or a resource name, but not both, in the +// same request. +// +// The response is paginated. By default, Config lists 100 resource identifiers 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. func (c *Client) ListDiscoveredResources(ctx context.Context, params *ListDiscoveredResourcesInput, optFns ...func(*Options)) (*ListDiscoveredResourcesOutput, error) { if params == nil { params = &ListDiscoveredResourcesInput{} diff --git a/service/configservice/api_op_PutAggregationAuthorization.go b/service/configservice/api_op_PutAggregationAuthorization.go index 2ec47bda652..734ab02050b 100644 --- a/service/configservice/api_op_PutAggregationAuthorization.go +++ b/service/configservice/api_op_PutAggregationAuthorization.go @@ -12,11 +12,13 @@ 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 13319f47e3d..a09ad7afed4 100644 --- a/service/configservice/api_op_PutConfigRule.go +++ b/service/configservice/api_op_PutConfigRule.go @@ -13,37 +13,53 @@ import ( // 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 -// differences and treat it as an idempotent request of the previous. In this case, -// tags will not be updated, even if they are different. +// Config rules you can have per account, see [Service Limits]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]. 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] ) and with Guard ([Guard GitHub Repository] ), 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] 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 differences and treat it as an +// idempotent request of the previous. In this case, tags will not be updated, +// even if they are different. +// +// [List of Config Managed Rules]: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html +// [Lambda Developer Guide]: https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function +// [Evaluating Resources with Config Rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html +// [Guard GitHub Repository]: https://github.com/aws-cloudformation/cloudformation-guard func (c *Client) PutConfigRule(ctx context.Context, params *PutConfigRuleInput, optFns ...func(*Options)) (*PutConfigRuleOutput, error) { if params == nil { params = &PutConfigRuleInput{} diff --git a/service/configservice/api_op_PutConfigurationAggregator.go b/service/configservice/api_op_PutConfigurationAggregator.go index fd62973c50e..39fa6d50ca5 100644 --- a/service/configservice/api_op_PutConfigurationAggregator.go +++ b/service/configservice/api_op_PutConfigurationAggregator.go @@ -13,23 +13,32 @@ import ( // Creates and updates the configuration aggregator with the selected source // accounts and regions. The source account can be individual account(s) or an -// organization. accountIds that are passed will be replaced with existing -// accounts. If you want to add additional accounts into the aggregator, call +// organization. +// +// accountIds that are passed will be replaced with existing accounts. If you want +// to add additional accounts into the aggregator, call // DescribeConfigurationAggregators to get the previous accounts and then append -// new ones. Config should be enabled in source accounts and regions you want to -// 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 +// new ones. +// +// Config should be enabled in source accounts and regions you want to 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 // 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) -// 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 -// 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. +// delegated administrator. +// +// To register a delegated administrator, see [Register a Delegated Administrator] 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 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. +// +// [Register a Delegated Administrator]: https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli func (c *Client) PutConfigurationAggregator(ctx context.Context, params *PutConfigurationAggregatorInput, optFns ...func(*Options)) (*PutConfigurationAggregatorOutput, error) { if params == nil { params = &PutConfigurationAggregatorInput{} diff --git a/service/configservice/api_op_PutConfigurationRecorder.go b/service/configservice/api_op_PutConfigurationRecorder.go index 6d8a8844cb1..d23d7e1897d 100644 --- a/service/configservice/api_op_PutConfigurationRecorder.go +++ b/service/configservice/api_op_PutConfigurationRecorder.go @@ -12,13 +12,18 @@ import ( ) // Creates a new configuration recorder to record configuration changes for -// specified resource types. You can also use this action to change the roleARN or -// the recordingGroup of an existing recorder. For more information, see Managing -// the Configuration Recorder (https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html) -// in the Config Developer Guide. You can specify only one configuration recorder -// for each Amazon Web Services Region for each account. If the configuration -// recorder does not have the recordingGroup field specified, the default is to -// record all supported resource types. +// specified resource types. +// +// You can also use this action to change the roleARN or the recordingGroup of an +// existing recorder. For more information, see [Managing the Configuration Recorder]in the Config Developer Guide. +// +// You can specify only one configuration recorder for each Amazon Web Services +// Region for each account. +// +// If the configuration recorder does not have the recordingGroup field specified, +// the default is to record all supported resource types. +// +// [Managing the Configuration Recorder]: https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html func (c *Client) PutConfigurationRecorder(ctx context.Context, params *PutConfigurationRecorderInput, optFns ...func(*Options)) (*PutConfigurationRecorderOutput, error) { if params == nil { params = &PutConfigurationRecorderInput{} diff --git a/service/configservice/api_op_PutConformancePack.go b/service/configservice/api_op_PutConformancePack.go index e0bb30d75dd..926ff0cd509 100644 --- a/service/configservice/api_op_PutConformancePack.go +++ b/service/configservice/api_op_PutConformancePack.go @@ -14,12 +14,16 @@ 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 -// 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 . +// account, see [Service Limits]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 . +// +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html func (c *Client) PutConformancePack(ctx context.Context, params *PutConformancePackInput, optFns ...func(*Options)) (*PutConformancePackOutput, error) { if params == nil { params = &PutConformancePackInput{} @@ -45,27 +49,34 @@ 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. + // The prefix for the Amazon S3 bucket. + // + // This field is optional. DeliveryS3KeyPrefix *string // 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 ( + // 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 ). 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 - // located in an Amazon S3 bucket in the same Region as the conformance pack. You - // must have access to read Amazon S3 bucket. In addition, in order to ensure a - // successful deployment, the template object must not be in an archived storage - // class (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html) - // if this parameter is passed. + // located in an Amazon S3 bucket in the same Region as the conformance pack. + // + // You must have access to read Amazon S3 bucket. In addition, in order to ensure + // a successful deployment, the template object must not be in an [archived storage class]if this + // parameter is passed. + // + // [archived storage class]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html TemplateS3Uri *string // An object of type TemplateSSMDocumentDetails , which contains the name or the diff --git a/service/configservice/api_op_PutDeliveryChannel.go b/service/configservice/api_op_PutDeliveryChannel.go index d590a5a7709..773633b6885 100644 --- a/service/configservice/api_op_PutDeliveryChannel.go +++ b/service/configservice/api_op_PutDeliveryChannel.go @@ -13,15 +13,21 @@ import ( // Creates a delivery channel object to deliver configuration information and // other compliance information to an Amazon S3 bucket and Amazon SNS topic. For -// more information, see Notifications that Config Sends to an Amazon SNS topic (https://docs.aws.amazon.com/config/latest/developerguide/notifications-for-AWS-Config.html) -// . Before you can create a delivery channel, you must create a configuration -// recorder. You can use this action to change the Amazon S3 bucket or an Amazon -// SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an -// Amazon SNS topic, call this action and specify the changed values for the S3 -// bucket and the SNS topic. If you specify a different value for either the S3 -// bucket or the SNS topic, this action will keep the existing value for the -// parameter that is not changed. You can have only one delivery channel per region -// in your account. +// more information, see [Notifications that Config Sends to an Amazon SNS topic]. +// +// Before you can create a delivery channel, you must create a configuration +// recorder. +// +// You can use this action to change the Amazon S3 bucket or an Amazon SNS topic +// of the existing delivery channel. To change the Amazon S3 bucket or an Amazon +// SNS topic, call this action and specify the changed values for the S3 bucket and +// the SNS topic. If you specify a different value for either the S3 bucket or the +// SNS topic, this action will keep the existing value for the parameter that is +// not changed. +// +// You can have only one delivery channel per region in your account. +// +// [Notifications that Config Sends to an Amazon SNS topic]: https://docs.aws.amazon.com/config/latest/developerguide/notifications-for-AWS-Config.html func (c *Client) PutDeliveryChannel(ctx context.Context, params *PutDeliveryChannelInput, optFns ...func(*Options)) (*PutDeliveryChannelOutput, error) { if params == nil { params = &PutDeliveryChannelInput{} diff --git a/service/configservice/api_op_PutEvaluations.go b/service/configservice/api_op_PutEvaluations.go index 1b278d60e52..45e8f9f0f2e 100644 --- a/service/configservice/api_op_PutEvaluations.go +++ b/service/configservice/api_op_PutEvaluations.go @@ -44,8 +44,10 @@ type PutEvaluationsInput struct { // 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 - // for the ResultToken parameter, but the value cannot be null. + // 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 noSmithyDocumentSerde diff --git a/service/configservice/api_op_PutOrganizationConfigRule.go b/service/configservice/api_op_PutOrganizationConfigRule.go index 93c1cf6e591..a5fab4c7419 100644 --- a/service/configservice/api_op_PutOrganizationConfigRule.go +++ b/service/configservice/api_op_PutOrganizationConfigRule.go @@ -13,43 +13,59 @@ 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 -// 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 -// 3 delegated administrators. This API enables organization service access through -// the EnableAWSServiceAccess action and creates a service-linked role +// information on how many organization Config rules you can have per account, see [Service Limits] +// 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 3 delegated administrators. +// +// This API enables organization service access 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. Config verifies the -// 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 -// 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, -// OrganizationCustomRuleMetadata for Custom Lambda rules, or +// 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 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]. 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] ) and with Guard ([Guard GitHub Repository] ), 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. +// +// [List of Config Managed Rules]: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html +// [Lambda Developer Guide]: https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html +// [Guard GitHub Repository]: https://github.com/aws-cloudformation/cloudformation-guard func (c *Client) PutOrganizationConfigRule(ctx context.Context, params *PutOrganizationConfigRuleInput, optFns ...func(*Options)) (*PutOrganizationConfigRuleOutput, error) { if params == nil { params = &PutOrganizationConfigRuleInput{} diff --git a/service/configservice/api_op_PutOrganizationConformancePack.go b/service/configservice/api_op_PutOrganizationConformancePack.go index 08f0bf1abbd..10f06f9eb65 100644 --- a/service/configservice/api_op_PutOrganizationConformancePack.go +++ b/service/configservice/api_op_PutOrganizationConformancePack.go @@ -13,12 +13,14 @@ 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 -// 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 +// many Config rules you can have per account, see [Service Limits]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 @@ -26,13 +28,20 @@ import ( // 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 . +// +// 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. +// +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html func (c *Client) PutOrganizationConformancePack(ctx context.Context, params *PutOrganizationConformancePackInput, optFns ...func(*Options)) (*PutOrganizationConformancePackOutput, error) { if params == nil { params = &PutOrganizationConformancePackInput{} @@ -58,12 +67,14 @@ 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. + // The prefix for the Amazon S3 bucket. + // + // This field is optional. DeliveryS3KeyPrefix *string // A list of Amazon Web Services accounts to be excluded from an organization @@ -76,10 +87,13 @@ type PutOrganizationConformancePackInput struct { TemplateBody *string // Location of file containing the template body. The uri must point to the - // conformance pack template (max size: 300 KB). You must have access to read - // Amazon S3 bucket. In addition, in order to ensure a successful deployment, the - // template object must not be in an archived storage class (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html) - // if this parameter is passed. + // conformance pack template (max size: 300 KB). + // + // You must have access to read Amazon S3 bucket. In addition, in order to ensure + // a successful deployment, the template object must not be in an [archived storage class]if this + // parameter is passed. + // + // [archived storage class]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html TemplateS3Uri *string noSmithyDocumentSerde diff --git a/service/configservice/api_op_PutRemediationConfigurations.go b/service/configservice/api_op_PutRemediationConfigurations.go index a4f00c9e91e..fd1f555771b 100644 --- a/service/configservice/api_op_PutRemediationConfigurations.go +++ b/service/configservice/api_op_PutRemediationConfigurations.go @@ -15,28 +15,42 @@ import ( // the selected target or action. The API creates the RemediationConfiguration // object for the Config rule. The Config rule must already exist for you to add a // remediation configuration. The target (SSM document) must exist and have -// permissions to use the target. Be aware of backward incompatible changes If you -// make backward incompatible changes to the SSM document, you must call this again -// to ensure the remediations can run. This API does not support adding remediation -// configurations for service-linked Config Rules such as Organization Config -// rules, the rules deployed by conformance packs, and rules deployed by Amazon Web -// Services Security Hub. Required fields For manual remediation configuration, you -// need to provide a value for automationAssumeRole 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 AutomationAssumeRole -// to remediate your resources. Auto remediation can be initiated even for -// compliant resources If you enable auto remediation for a specific Config rule -// using the PutRemediationConfigurations (https://docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html) -// API or the Config console, it initiates the remediation process for all -// non-compliant resources for that specific rule. The auto remediation process -// relies on the compliance data snapshot which is captured on a periodic basis. -// Any non-compliant resource that is updated between the snapshot schedule will -// continue to be remediated based on the last known compliance data snapshot. This -// means that in some cases auto remediation can be initiated even for compliant -// resources, since the bootstrap processor uses a database that can have stale -// evaluation results based on the last known compliance data snapshot. +// permissions to use the target. +// +// # Be aware of backward incompatible changes +// +// If you make backward incompatible changes to the SSM document, you must call +// this again to ensure the remediations can run. +// +// This API does not support adding remediation configurations for service-linked +// Config Rules such as Organization Config rules, the rules deployed by +// conformance packs, and rules deployed by Amazon Web Services Security Hub. +// +// # Required fields +// +// For manual remediation configuration, you need to provide a value for +// automationAssumeRole 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 +// AutomationAssumeRole to remediate your resources. +// +// # Auto remediation can be initiated even for compliant resources +// +// If you enable auto remediation for a specific Config rule using the [PutRemediationConfigurations] API or the +// Config console, it initiates the remediation process for all non-compliant +// resources for that specific rule. The auto remediation process relies on the +// compliance data snapshot which is captured on a periodic basis. Any +// non-compliant resource that is updated between the snapshot schedule will +// continue to be remediated based on the last known compliance data snapshot. +// +// This means that in some cases auto remediation can be initiated even for +// compliant resources, since the bootstrap processor uses a database that can have +// stale evaluation results based on the last known compliance data snapshot. +// +// [PutRemediationConfigurations]: https://docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html func (c *Client) PutRemediationConfigurations(ctx context.Context, params *PutRemediationConfigurationsInput, optFns ...func(*Options)) (*PutRemediationConfigurationsOutput, error) { if params == nil { params = &PutRemediationConfigurationsInput{} diff --git a/service/configservice/api_op_PutRemediationExceptions.go b/service/configservice/api_op_PutRemediationExceptions.go index 47a30a95b4a..e1712631eb5 100644 --- a/service/configservice/api_op_PutRemediationExceptions.go +++ b/service/configservice/api_op_PutRemediationExceptions.go @@ -14,34 +14,48 @@ import ( // 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. Exceptions -// block auto remediation 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. Manual -// remediation is recommended when placing an exception 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. Exceptions can only be performed on -// non-compliant resources 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. Auto remediation can be initiated even for -// compliant resources If you enable auto remediation for a specific Config rule -// using the PutRemediationConfigurations (https://docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html) -// API or the Config console, it initiates the remediation process for all -// non-compliant resources for that specific rule. The auto remediation process -// relies on the compliance data snapshot which is captured on a periodic basis. -// Any non-compliant resource that is updated between the snapshot schedule will -// continue to be remediated based on the last known compliance data snapshot. This -// means that in some cases auto remediation can be initiated even for compliant -// resources, since the bootstrap processor uses a database that can have stale -// evaluation results based on the last known compliance data snapshot. +// exception for a specified resource with a specified Config rule. +// +// # Exceptions block auto remediation +// +// 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. +// +// # Manual remediation is recommended when placing an exception +// +// 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. +// +// # Exceptions can only be performed on non-compliant resources +// +// 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]in the +// Config Developer Guide. +// +// # Auto remediation can be initiated even for compliant resources +// +// If you enable auto remediation for a specific Config rule using the [PutRemediationConfigurations] API or the +// Config console, it initiates the remediation process for all non-compliant +// resources for that specific rule. The auto remediation process relies on the +// compliance data snapshot which is captured on a periodic basis. Any +// non-compliant resource that is updated between the snapshot schedule will +// continue to be remediated based on the last known compliance data snapshot. +// +// This means that in some cases auto remediation can be initiated even for +// compliant resources, since the bootstrap processor uses a database that can have +// stale evaluation results based on the last known compliance data snapshot. +// +// [Concepts | Config Rules]: https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules +// [PutRemediationConfigurations]: https://docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html func (c *Client) PutRemediationExceptions(ctx context.Context, params *PutRemediationExceptionsInput, optFns ...func(*Options)) (*PutRemediationExceptionsOutput, error) { if params == nil { params = &PutRemediationExceptionsInput{} diff --git a/service/configservice/api_op_PutResourceConfig.go b/service/configservice/api_op_PutResourceConfig.go index dfe15473800..cfda8817567 100644 --- a/service/configservice/api_op_PutResourceConfig.go +++ b/service/configservice/api_op_PutResourceConfig.go @@ -10,15 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Records the configuration state for the resource provided in the request. The -// configuration state of a resource is represented in Config as Configuration +// Records the configuration state for the resource provided in the request. +// +// The configuration state of a resource is represented in Config as Configuration // Items. Once this API records the configuration item, you can retrieve the list // of configuration items for the custom resource type using existing Config APIs. +// // The custom resource type must be registered with CloudFormation. This API -// accepts the configuration item registered with CloudFormation. When you call -// this API, Config only stores configuration state of the resource provided in the -// request. This API does not change or remediate the configuration of the -// resource. Write-only schema properites are not recorded as part of the published +// accepts the configuration item registered with CloudFormation. +// +// When you call this API, Config only stores configuration state of the resource +// provided in the request. This API does not change or remediate the configuration +// of the resource. +// +// Write-only schema properites are not recorded as part of the published // configuration item. func (c *Client) PutResourceConfig(ctx context.Context, params *PutResourceConfigInput, optFns ...func(*Options)) (*PutResourceConfigOutput, error) { if params == nil { @@ -38,8 +43,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 schema registered with CloudFormation. + // + // The configuration JSON must not exceed 64 KB. // // This member is required. Configuration *string @@ -50,9 +56,11 @@ type PutResourceConfigInput struct { ResourceId *string // The type of the resource. The custom resource type must be registered with - // CloudFormation. You cannot use the organization names “amzn”, “amazon”, “alexa”, - // “custom” with custom resource types. It is the first part of the ResourceType up - // to the first ::. + // CloudFormation. + // + // You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with + // custom resource types. It is the first part of the ResourceType up to the first + // ::. // // This member is required. ResourceType *string @@ -65,10 +73,11 @@ type PutResourceConfigInput struct { // Name of the resource. ResourceName *string - // Tags associated with the resource. This field is not to be confused with the - // Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for - // PutResourceConfig are tags that you supply for the configuration items of your - // custom resources. + // Tags associated with the resource. + // + // This field is not to be confused with the Amazon Web Services-wide tag feature + // for Amazon Web Services resources. Tags for PutResourceConfig are tags that you + // supply for the configuration items of your custom resources. Tags map[string]string noSmithyDocumentSerde diff --git a/service/configservice/api_op_PutRetentionConfiguration.go b/service/configservice/api_op_PutRetentionConfiguration.go index d2ff8652484..8ed35ca0133 100644 --- a/service/configservice/api_op_PutRetentionConfiguration.go +++ b/service/configservice/api_op_PutRetentionConfiguration.go @@ -15,8 +15,10 @@ import ( // 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. +// 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{} @@ -34,8 +36,9 @@ func (c *Client) PutRetentionConfiguration(ctx context.Context, params *PutReten type PutRetentionConfigurationInput struct { - // Number of days Config stores your historical information. Currently, only - // applicable to the configuration item history. + // Number of days Config stores your historical information. + // + // Currently, only applicable to the configuration item history. // // This member is required. RetentionPeriodInDays *int32 diff --git a/service/configservice/api_op_PutStoredQuery.go b/service/configservice/api_op_PutStoredQuery.go index 7bf597c00d4..c3aa80ae5ba 100644 --- a/service/configservice/api_op_PutStoredQuery.go +++ b/service/configservice/api_op_PutStoredQuery.go @@ -14,11 +14,13 @@ import ( // Saves a new query or updates an existing saved query. The QueryName must be // unique for a single Amazon Web Services account and a single Amazon Web Services // Region. You can create upto 300 queries in a single Amazon Web Services account -// and a single Amazon Web Services Region. PutStoredQuery 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. +// and a single Amazon Web Services Region. +// +// PutStoredQuery 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) PutStoredQuery(ctx context.Context, params *PutStoredQueryInput, optFns ...func(*Options)) (*PutStoredQueryOutput, error) { if params == nil { params = &PutStoredQueryInput{} @@ -37,9 +39,11 @@ 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 - // expression. When you are updating a query, you must provide a query name but - // updating the description is optional. + // . + // + // 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. // // This member is required. StoredQuery *types.StoredQuery diff --git a/service/configservice/api_op_SelectAggregateResourceConfig.go b/service/configservice/api_op_SelectAggregateResourceConfig.go index a3272197489..eba8c509a38 100644 --- a/service/configservice/api_op_SelectAggregateResourceConfig.go +++ b/service/configservice/api_op_SelectAggregateResourceConfig.go @@ -14,16 +14,22 @@ import ( // Accepts a structured query language (SQL) SELECT command and an aggregator to // 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) -// 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 ) -// 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 -// parameters, the default page size is set to 25. +// configurations matching the properties. +// +// For more information about query components, see the [Query Components] 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 ) 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 parameters, the default page size is +// set to 25. +// +// [Query Components]: https://docs.aws.amazon.com/config/latest/developerguide/query-components.html func (c *Client) SelectAggregateResourceConfig(ctx context.Context, params *SelectAggregateResourceConfigInput, optFns ...func(*Options)) (*SelectAggregateResourceConfigOutput, error) { if params == nil { params = &SelectAggregateResourceConfigInput{} diff --git a/service/configservice/api_op_SelectResourceConfig.go b/service/configservice/api_op_SelectResourceConfig.go index 05da77342de..bd1022deba6 100644 --- a/service/configservice/api_op_SelectResourceConfig.go +++ b/service/configservice/api_op_SelectResourceConfig.go @@ -13,9 +13,12 @@ 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) -// section in the Config Developer Guide. +// properties. +// +// For more information about query components, see the [Query Components] section in the Config +// Developer Guide. +// +// [Query Components]: https://docs.aws.amazon.com/config/latest/developerguide/query-components.html func (c *Client) SelectResourceConfig(ctx context.Context, params *SelectResourceConfigInput, optFns ...func(*Options)) (*SelectResourceConfigOutput, error) { if params == nil { params = &SelectResourceConfigInput{} diff --git a/service/configservice/api_op_StartConfigRulesEvaluation.go b/service/configservice/api_op_StartConfigRulesEvaluation.go index 89f3a40f4d6..f0d10c33715 100644 --- a/service/configservice/api_op_StartConfigRulesEvaluation.go +++ b/service/configservice/api_op_StartConfigRulesEvaluation.go @@ -15,19 +15,31 @@ import ( // you want to test that a rule you updated is working as expected. // StartConfigRulesEvaluation does not re-record the latest configuration state for // your resources. It re-runs an evaluation against the last known state of your -// resources. You can specify up to 25 Config rules per request. An existing -// StartConfigRulesEvaluation call for the specified rules must complete before you -// can call the API again. If you chose to have Config stream to an Amazon SNS -// topic, you will receive a ConfigRuleEvaluationStarted notification when the -// 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: +// resources. +// +// You can specify up to 25 Config rules per request. +// +// An existing StartConfigRulesEvaluation call for the specified rules must +// complete before you can call the API again. If you chose to have Config stream +// to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted +// notification when the 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. func (c *Client) StartConfigRulesEvaluation(ctx context.Context, params *StartConfigRulesEvaluationInput, optFns ...func(*Options)) (*StartConfigRulesEvaluationOutput, error) { if params == nil { diff --git a/service/configservice/api_op_StartConfigurationRecorder.go b/service/configservice/api_op_StartConfigurationRecorder.go index 61ba2c726ac..e0ded6a7479 100644 --- a/service/configservice/api_op_StartConfigurationRecorder.go +++ b/service/configservice/api_op_StartConfigurationRecorder.go @@ -11,8 +11,10 @@ import ( ) // Starts recording configurations of the Amazon Web Services resources you have -// selected to record in your Amazon Web Services account. You must have created at -// least one delivery channel to successfully start the configuration recorder. +// selected to record in your Amazon Web Services account. +// +// You must have created at least one delivery channel to successfully start the +// configuration recorder. func (c *Client) StartConfigurationRecorder(ctx context.Context, params *StartConfigurationRecorderInput, optFns ...func(*Options)) (*StartConfigurationRecorderOutput, error) { if params == nil { params = &StartConfigurationRecorderInput{} diff --git a/service/configservice/api_op_StartRemediationExecution.go b/service/configservice/api_op_StartRemediationExecution.go index 03a1c99f2aa..1aae5e3d814 100644 --- a/service/configservice/api_op_StartRemediationExecution.go +++ b/service/configservice/api_op_StartRemediationExecution.go @@ -13,9 +13,11 @@ import ( // Runs an on-demand remediation for the specified Config rules against the last // known remediation configuration. It runs an execution against the current state -// of your resources. Remediation execution is asynchronous. You can specify up to -// 100 resource keys per request. An existing StartRemediationExecution call for -// the specified resource keys must complete before you can call the API again. +// of your resources. Remediation execution is asynchronous. +// +// You can specify up to 100 resource keys per request. An existing +// StartRemediationExecution call for the specified resource keys must complete +// before you can call the API again. func (c *Client) StartRemediationExecution(ctx context.Context, params *StartRemediationExecutionInput, optFns ...func(*Options)) (*StartRemediationExecutionOutput, error) { if params == nil { params = &StartRemediationExecutionInput{} diff --git a/service/configservice/api_op_StartResourceEvaluation.go b/service/configservice/api_op_StartResourceEvaluation.go index f0984f6a28a..8cc46a76b34 100644 --- a/service/configservice/api_op_StartResourceEvaluation.go +++ b/service/configservice/api_op_StartResourceEvaluation.go @@ -16,14 +16,19 @@ import ( // 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) -// in the CloudFormation User Guide. +// resource type schema. +// +// You can find the [Resource type 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] and [Amazon Web Services resource and property types reference] in the CloudFormation User Guide. +// +// [Resource type schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html +// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html +// [Managing extensions through the CloudFormation registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view func (c *Client) StartResourceEvaluation(ctx context.Context, params *StartResourceEvaluationInput, optFns ...func(*Options)) (*StartResourceEvaluationOutput, error) { if params == nil { params = &StartResourceEvaluationInput{} @@ -54,12 +59,14 @@ type StartResourceEvaluationInput struct { // 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. Avoid reusing the same client token for other API - // requests. If you retry a request that completed successfully using the same - // client token and the same parameters, the retry succeeds without performing any - // further actions. If you retry a successful request using the same client token, - // but one or more of the parameters are different, other than the Region or - // Availability Zone, the retry fails with an IdempotentParameterMismatch error. + // token in the request. + // + // Avoid reusing the same client token for other API requests. If you retry a + // request that completed successfully using the same client token and the same + // parameters, the retry succeeds without performing any further actions. If you + // retry a successful request using the same client token, but one or more of the + // parameters are different, other than the Region or Availability Zone, the retry + // fails with an IdempotentParameterMismatch error. ClientToken *string // Returns an EvaluationContext object. diff --git a/service/configservice/doc.go b/service/configservice/doc.go index 12818f8e367..2e09dbce3f1 100644 --- a/service/configservice/doc.go +++ b/service/configservice/doc.go @@ -3,23 +3,28 @@ // Package configservice provides the API client, operations, and parameter types // for AWS Config. // -// Config Config provides a way to keep track of the configurations of all the -// Amazon Web Services resources associated with your Amazon Web Services account. -// You can use Config to get the current and historical configurations of each -// Amazon Web Services resource and also to get information about the relationship -// 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 +// # Config +// +// Config provides a way to keep track of the configurations of all the Amazon Web +// Services resources associated with your Amazon Web Services account. You can use +// Config to get the current and historical configurations of each Amazon Web +// Services resource and also to get information about the relationship 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]. +// +// 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 -// 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. +// a request with this protocol, see [Signature Version 4 Signing Process]. 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]in the Config Developer Guide. +// +// [What Is Config]: https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html +// [Supported Amazon Web Services resources]: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources +// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html package configservice diff --git a/service/configservice/options.go b/service/configservice/options.go index 0d4c3c628c3..9c6e6c2f92a 100644 --- a/service/configservice/options.go +++ b/service/configservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/configservice/types/enums.go b/service/configservice/types/enums.go index d7f6b9e5749..55b6ed58186 100644 --- a/service/configservice/types/enums.go +++ b/service/configservice/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for // AggregateConformancePackComplianceSummaryGroupKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregateConformancePackComplianceSummaryGroupKey) Values() []AggregateConformancePackComplianceSummaryGroupKey { return []AggregateConformancePackComplianceSummaryGroupKey{ "ACCOUNT_ID", @@ -32,6 +33,7 @@ const ( // Values returns all known values for AggregatedSourceStatusType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AggregatedSourceStatusType) Values() []AggregatedSourceStatusType { return []AggregatedSourceStatusType{ @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for AggregatedSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregatedSourceType) Values() []AggregatedSourceType { return []AggregatedSourceType{ "ACCOUNT", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for ChronologicalOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChronologicalOrder) Values() []ChronologicalOrder { return []ChronologicalOrder{ "Reverse", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for ComplianceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceType) Values() []ComplianceType { return []ComplianceType{ "COMPLIANT", @@ -109,8 +114,9 @@ const ( // Values returns all known values for ConfigRuleComplianceSummaryGroupKey. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigRuleComplianceSummaryGroupKey) Values() []ConfigRuleComplianceSummaryGroupKey { return []ConfigRuleComplianceSummaryGroupKey{ "ACCOUNT_ID", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for ConfigRuleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigRuleState) Values() []ConfigRuleState { return []ConfigRuleState{ "ACTIVE", @@ -152,8 +159,9 @@ const ( ) // Values returns all known values for ConfigurationItemStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationItemStatus) Values() []ConfigurationItemStatus { return []ConfigurationItemStatus{ "OK", @@ -175,8 +183,9 @@ const ( // Values returns all known values for ConformancePackComplianceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConformancePackComplianceType) Values() []ConformancePackComplianceType { return []ConformancePackComplianceType{ "COMPLIANT", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for ConformancePackState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConformancePackState) Values() []ConformancePackState { return []ConformancePackState{ "CREATE_IN_PROGRESS", @@ -219,8 +229,9 @@ const ( ) // Values returns all known values for DeliveryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStatus) Values() []DeliveryStatus { return []DeliveryStatus{ "Success", @@ -238,8 +249,9 @@ const ( ) // Values returns all known values for EvaluationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationMode) Values() []EvaluationMode { return []EvaluationMode{ "DETECTIVE", @@ -255,8 +267,9 @@ const ( ) // Values returns all known values for EventSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSource) Values() []EventSource { return []EventSource{ "aws.config", @@ -276,6 +289,7 @@ const ( // Values returns all known values for MaximumExecutionFrequency. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MaximumExecutionFrequency) Values() []MaximumExecutionFrequency { return []MaximumExecutionFrequency{ @@ -303,8 +317,9 @@ const ( ) // Values returns all known values for MemberAccountRuleStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberAccountRuleStatus) Values() []MemberAccountRuleStatus { return []MemberAccountRuleStatus{ "CREATE_SUCCESSFUL", @@ -330,8 +345,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "ConfigurationItemChangeNotification", @@ -352,8 +368,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationConfigRuleTriggerType) Values() []OrganizationConfigRuleTriggerType { return []OrganizationConfigRuleTriggerType{ "ConfigurationItemChangeNotification", @@ -372,8 +389,9 @@ const ( // Values returns all known values for OrganizationConfigRuleTriggerTypeNoSN. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationConfigRuleTriggerTypeNoSN) Values() []OrganizationConfigRuleTriggerTypeNoSN { return []OrganizationConfigRuleTriggerTypeNoSN{ "ConfigurationItemChangeNotification", @@ -398,8 +416,9 @@ const ( // Values returns all known values for OrganizationResourceDetailedStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationResourceDetailedStatus) Values() []OrganizationResourceDetailedStatus { return []OrganizationResourceDetailedStatus{ "CREATE_SUCCESSFUL", @@ -431,6 +450,7 @@ const ( // Values returns all known values for OrganizationResourceStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationResourceStatus) Values() []OrganizationResourceStatus { return []OrganizationResourceStatus{ @@ -462,8 +482,9 @@ const ( ) // Values returns all known values for OrganizationRuleStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationRuleStatus) Values() []OrganizationRuleStatus { return []OrganizationRuleStatus{ "CREATE_SUCCESSFUL", @@ -488,8 +509,9 @@ const ( ) // 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. +// the future, and so 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{ "CUSTOM_LAMBDA", @@ -508,8 +530,9 @@ const ( ) // Values returns all known values for RecorderStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecorderStatus) Values() []RecorderStatus { return []RecorderStatus{ "Pending", @@ -527,8 +550,9 @@ const ( ) // Values returns all known values for RecordingFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordingFrequency) Values() []RecordingFrequency { return []RecordingFrequency{ "CONTINUOUS", @@ -546,8 +570,9 @@ const ( ) // Values returns all known values for RecordingStrategyType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordingStrategyType) Values() []RecordingStrategyType { return []RecordingStrategyType{ "ALL_SUPPORTED_RESOURCE_TYPES", @@ -568,6 +593,7 @@ const ( // Values returns all known values for RemediationExecutionState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RemediationExecutionState) Values() []RemediationExecutionState { return []RemediationExecutionState{ @@ -589,8 +615,9 @@ const ( // Values returns all known values for RemediationExecutionStepState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RemediationExecutionStepState) Values() []RemediationExecutionStepState { return []RemediationExecutionStepState{ "SUCCEEDED", @@ -607,8 +634,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SSM_DOCUMENT", @@ -624,8 +652,9 @@ const ( // Values returns all known values for ResourceConfigurationSchemaType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceConfigurationSchemaType) Values() []ResourceConfigurationSchemaType { return []ResourceConfigurationSchemaType{ "CFN_RESOURCE_SCHEMA", @@ -642,8 +671,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RESOURCE_TYPE", @@ -663,6 +693,7 @@ const ( // 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{ @@ -1086,8 +1117,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1508,8 +1540,9 @@ const ( ) // Values returns all known values for ResourceValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceValueType) Values() []ResourceValueType { return []ResourceValueType{ "RESOURCE_ID", @@ -1524,8 +1557,9 @@ const ( ) // Values returns all known values for SortBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortBy) Values() []SortBy { return []SortBy{ "SCORE", @@ -1541,8 +1575,9 @@ const ( ) // 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. +// in the future, and so 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 71091c29a5a..6df3e572aad 100644 --- a/service/configservice/types/errors.go +++ b/service/configservice/types/errors.go @@ -91,19 +91,24 @@ 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. +// +// - You do not have permission to read Amazon S3 bucket or call SSM:GetDocument. type InsufficientPermissionsException struct { Message *string @@ -292,20 +297,25 @@ func (e *InvalidParameterValueException) ErrorCode() string { func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Indicates one of the following errors: +// // - You have provided a combination of parameter values that is not valid. For // example: -// - Setting the allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) -// to true , but providing a non-empty list for the resourceTypes field of -// RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) -// . -// - Setting the allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) -// to true , but also setting the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) -// to EXCLUSION_BY_RESOURCE_TYPES . +// +// - Setting the allSupported field of [RecordingGroup]to true , but providing a non-empty list +// for the resourceTypes field of [RecordingGroup]. +// +// - Setting the allSupported field of [RecordingGroup]to true , but also setting the useOnly +// field of [RecordingStrategy]to EXCLUSION_BY_RESOURCE_TYPES . +// // - Every parameter is either null, false, or empty. +// // - You have reached the limit of the number of resource types you can provide // for the recording group. -// - You have provided resource types or a recording strategy that are not -// valid. +// +// - You have provided resource types or a recording strategy that are not valid. +// +// [RecordingStrategy]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html +// [RecordingGroup]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html type InvalidRecordingGroupException struct { Message *string @@ -519,9 +529,10 @@ func (e *LastDeliveryChannelDeleteFailedException) ErrorFault() smithy.ErrorFaul } // 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. +// is in progress or if you call the StartConfigRulesEvaluationAPI 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 @@ -548,8 +559,9 @@ 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]. +// +// [DeleteResourceConfig]: https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteResourceConfig.html type MaxActiveResourcesExceededException struct { Message *string @@ -637,8 +649,9 @@ 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]in the Config Developer Guide. +// +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html type MaxNumberOfConformancePacksExceededException struct { Message *string @@ -695,8 +708,9 @@ 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]in the Config Developer Guide. +// +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html type MaxNumberOfOrganizationConfigRulesExceededException struct { Message *string @@ -725,8 +739,10 @@ 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]in the Config Developer +// Guide. +// +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html type MaxNumberOfOrganizationConformancePacksExceededException struct { Message *string @@ -1115,8 +1131,10 @@ func (e *NoSuchOrganizationConfigRuleException) ErrorFault() smithy.ErrorFault { } // Config organization conformance pack that you passed in the filter does not -// exist. For DeleteOrganizationConformancePack, you tried to delete an -// organization conformance pack that does not exist. +// exist. +// +// For DeleteOrganizationConformancePack, you tried to delete an organization +// conformance pack that does not exist. type NoSuchOrganizationConformancePackException struct { Message *string @@ -1230,15 +1248,19 @@ func (e *NoSuchRetentionConfigurationException) ErrorFault() smithy.ErrorFault { // 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 @@ -1414,20 +1436,27 @@ 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. type ResourceInUseException struct { @@ -1508,8 +1537,9 @@ 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]in the Config Developer Guide. +// +// [Service Limits]: https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html type TooManyTagsException struct { Message *string @@ -1535,10 +1565,13 @@ func (e *TooManyTagsException) ErrorCode() string { } func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The requested action is not valid. For PutStoredQuery, you will see this -// exception if there are missing required fields or if the input value fails the -// validation, or if you are trying to create more than 300 queries. For -// GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this +// The requested action is not valid. +// +// For PutStoredQuery, you will see this exception if there are missing required +// fields or if the input value fails the validation, or if you are trying to +// create more than 300 queries. +// +// For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this // exception if there are missing required fields or if the input value fails the // validation. type ValidationException struct { diff --git a/service/configservice/types/types.go b/service/configservice/types/types.go index aaf0f793707..df7e03889ee 100644 --- a/service/configservice/types/types.go +++ b/service/configservice/types/types.go @@ -25,9 +25,10 @@ type AccountAggregationSource struct { } // Indicates whether an Config rule is compliant based on account ID, region, -// compliance, and rule name. A rule is compliant if all of the resources that the -// rule evaluated comply with it. It is noncompliant if any of these resources do -// not comply. +// compliance, and rule name. +// +// A rule is compliant if all of the resources that the rule evaluated comply with +// it. It is noncompliant if any of these resources do not comply. type AggregateComplianceByConfigRule struct { // The 12-digit account ID of the source account. @@ -48,13 +49,15 @@ type AggregateComplianceByConfigRule struct { // Provides aggregate compliance of the conformance pack. Indicates whether a // conformance pack is compliant based on the name of the conformance pack, account -// ID, and region. A conformance pack is compliant if all of the rules in a -// conformance packs are compliant. It is noncompliant if any of the rules are not -// compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only -// if all rules within a conformance pack cannot be evaluated due to insufficient -// data. If some of the rules in a conformance pack are compliant but the -// compliance status of other rules in that same conformance pack is -// INSUFFICIENT_DATA, the conformance pack shows compliant. +// ID, and region. +// +// A conformance pack is compliant if all of the rules in a conformance packs are +// compliant. It is noncompliant if any of the rules are not compliant. The +// compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules +// within a conformance pack cannot be evaluated due to insufficient data. If some +// of the rules in a conformance pack are compliant but the compliance status of +// other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance +// pack shows compliant. type AggregateComplianceByConformancePack struct { // The 12-digit Amazon Web Services account ID of the source account. @@ -88,13 +91,15 @@ type AggregateComplianceCount struct { // Provides the number of compliant and noncompliant rules within a conformance // pack. Also provides the compliance status of the conformance pack and the total // rule count which includes compliant rules, noncompliant rules, and rules that -// cannot be evaluated due to insufficient data. A conformance pack is compliant if -// all of the rules in a conformance packs are compliant. It is noncompliant if any -// of the rules are not compliant. The compliance status of a conformance pack is -// INSUFFICIENT_DATA only if all rules within a conformance pack cannot be -// evaluated due to insufficient data. If some of the rules in a conformance pack -// are compliant but the compliance status of other rules in that same conformance -// pack is INSUFFICIENT_DATA, the conformance pack shows compliant. +// cannot be evaluated due to insufficient data. +// +// A conformance pack is compliant if all of the rules in a conformance packs are +// compliant. It is noncompliant if any of the rules are not compliant. The +// compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules +// within a conformance pack cannot be evaluated due to insufficient data. If some +// of the rules in a conformance pack are compliant but the compliance status of +// other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance +// pack shows compliant. type AggregateConformancePackCompliance struct { // The compliance status of the conformance pack. @@ -184,8 +189,11 @@ 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. LastUpdateStatus AggregatedSourceStatusType @@ -216,9 +224,11 @@ type AggregateEvaluationResult struct { // The source region from where the data is aggregated. AwsRegion *string - // The resource compliance status. For the AggregationEvaluationResult data type, - // Config supports only the COMPLIANT and NON_COMPLIANT . Config does not support - // the NOT_APPLICABLE and INSUFFICIENT_DATA value. + // The resource compliance status. + // + // For the AggregationEvaluationResult data type, Config supports only the + // COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and + // INSUFFICIENT_DATA value. ComplianceType ComplianceType // The time when the Config rule evaluated the Amazon Web Services resource. @@ -305,21 +315,29 @@ type BaseConfigurationItem struct { // resource. ConfigurationItemCaptureTime *time.Time - // The time when configuration changes for the resource were delivered. This field - // is optional and is not guaranteed to be present in a configuration item (CI). If - // you are using daily recording, this field will be populated. However, if you are - // using continuous recording, this field will be omitted since the delivery time - // is instantaneous as the CI is available right away. For more information on - // daily recording and continuous recording, see Recording Frequency (https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency) - // in the Config Developer Guide. + // The time when configuration changes for the resource were delivered. + // + // This field is optional and is not guaranteed to be present in a configuration + // item (CI). If you are using daily recording, this field will be populated. + // However, if you are using continuous recording, this field will be omitted since + // the delivery time is instantaneous as the CI is available right away. For more + // information on daily recording and continuous recording, see [Recording Frequency]in the Config + // Developer Guide. + // + // [Recording Frequency]: https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency ConfigurationItemDeliveryTime *time.Time // The configuration item status. Valid values include: + // // - 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 doesn't record resources of this type. + // // - ResourceDeleted – The resource was deleted + // // - ResourceDeletedNotRecorded – The resource was deleted, but its // configuration was not recorded since the recorder doesn't record resources of // this type. @@ -364,15 +382,20 @@ type Compliance struct { 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 - // INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for - // the Compliance data type. + // 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 noSmithyDocumentSerde @@ -487,19 +510,30 @@ type ConfigExportDeliveryInfo struct { // resources. A rule can run when Config detects a configuration change to an // 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) -// 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 . +// 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]. +// +// 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] ) and with Guard ([Guard GitHub Repository] ), 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] 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. +// +// [List of Config Managed Rules]: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html +// [Evaluating Resource with Config Rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html +// [Lambda Developer Guide]: https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function +// [Guard GitHub Repository]: https://github.com/aws-cloudformation/cloudformation-guard type ConfigRule struct { // Provides the rule owner ( Amazon Web Services for managed rules, CUSTOM_POLICY @@ -521,20 +555,25 @@ type ConfigRule struct { ConfigRuleName *string // Indicates whether the Config rule is active or is currently being deleted by - // Config. It can also indicate the evaluation status for the Config rule. Config - // sets the state of the rule to EVALUATING temporarily after you use the + // Config. It can also indicate the evaluation status for the Config rule. + // + // Config sets the state of the rule to EVALUATING temporarily after you use the // StartConfigRulesEvaluation request to evaluate your resources against the Config - // rule. Config sets the state of the rule to DELETING_RESULTS temporarily after - // you use the DeleteEvaluationResults request to delete the current evaluation - // results for the Config rule. Config temporarily sets the state of a rule to - // DELETING after you use the DeleteConfigRule request to delete the rule. After - // Config deletes the rule, the rule and all of its evaluations are erased and are - // no longer available. + // rule. + // + // Config sets the state of the rule to DELETING_RESULTS temporarily after you use + // the DeleteEvaluationResults request to delete the current evaluation results + // for the Config rule. + // + // Config temporarily sets the state of a rule to DELETING after you use the + // DeleteConfigRule request to delete the rule. After Config deletes the rule, the + // rule and all of its evaluations are erased and are no longer available. ConfigRuleState ConfigRuleState - // Service principal name of the service that created the rule. The field is - // populated only if the service-linked rule is created by a service. The field is - // empty if you create your own rule. + // Service principal name of the service that created the rule. + // + // The field is populated only if the service-linked rule is created by a service. + // The field is empty if you create your own rule. CreatedBy *string // The description that you provide for the Config rule. @@ -549,10 +588,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 . + // 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. @@ -563,7 +605,9 @@ type ConfigRule struct { // resource ID, or a combination of a tag key and value. Specify a scope to // constrain the resources that can trigger an evaluation for the rule. If you do // not specify a scope, evaluations are triggered when any resource in the - // recording group changes. The scope can be empty. + // recording group changes. + // + // The scope can be empty. Scope *Scope noSmithyDocumentSerde @@ -579,9 +623,11 @@ type ConfigRuleComplianceFilters struct { // The source region where the data is aggregated. AwsRegion *string - // The rule compliance status. For the ConfigRuleComplianceFilters data type, - // Config supports only COMPLIANT and NON_COMPLIANT . Config does not support the - // NOT_APPLICABLE and the INSUFFICIENT_DATA values. + // The rule compliance status. + // + // For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT + // and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and the + // INSUFFICIENT_DATA values. ComplianceType ComplianceType // The name of the Config rule. @@ -604,8 +650,9 @@ type ConfigRuleComplianceSummaryFilters struct { // 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. +// 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. @@ -622,8 +669,10 @@ 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. FirstEvaluationStarted bool @@ -669,33 +718,42 @@ type ConfigRuleEvaluationStatus struct { } // Provides options for how often Config delivers configuration snapshots to the -// 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: +// 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 . +// 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. +// 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. @@ -714,10 +772,12 @@ type ConfigStreamDeliveryInfo struct { // The error message from the last attempted delivery. 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) - // for Config is optional. If the SNS delivery is turned off, the last status will - // be Not_Applicable. + // Status of the last attempted delivery. + // + // Note Providing an SNS topic on a [DeliveryChannel] for Config is optional. If the SNS delivery + // is turned off, the last status will be Not_Applicable. + // + // [DeliveryChannel]: https://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html LastStatus DeliveryStatus // The time from the last status change. @@ -776,26 +836,35 @@ type ConfigurationItem struct { // resource. ConfigurationItemCaptureTime *time.Time - // The time when configuration changes for the resource were delivered. This field - // is optional and is not guaranteed to be present in a configuration item (CI). If - // you are using daily recording, this field will be populated. However, if you are - // using continuous recording, this field will be omitted since the delivery time - // is instantaneous as the CI is available right away. For more information on - // daily recording and continuous recording, see Recording Frequency (https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency) - // in the Config Developer Guide. + // The time when configuration changes for the resource were delivered. + // + // This field is optional and is not guaranteed to be present in a configuration + // item (CI). If you are using daily recording, this field will be populated. + // However, if you are using continuous recording, this field will be omitted since + // the delivery time is instantaneous as the CI is available right away. For more + // information on daily recording and continuous recording, see [Recording Frequency]in the Config + // Developer Guide. + // + // [Recording Frequency]: https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency ConfigurationItemDeliveryTime *time.Time - // Unique MD5 hash that represents the configuration item's state. You can use MD5 - // hash to compare the states of two or more configuration items that are - // associated with the same resource. + // Unique MD5 hash that represents the configuration item's state. + // + // You can use MD5 hash to compare the states of two or more configuration items + // that are associated with the same resource. ConfigurationItemMD5Hash *string // The configuration item status. Valid values include: + // // - 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 doesn't record resources of this type + // // - ResourceDeleted – The resource was deleted + // // - ResourceDeletedNotRecorded – The resource was deleted but its configuration // was not recorded since the recorder doesn't record resources of this type ConfigurationItemStatus ConfigurationItemStatus @@ -808,13 +877,18 @@ type ConfigurationItem struct { // the resource. RecordingFrequency RecordingFrequency - // 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 + // 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]. + // + // 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. + // the [LookupEvents API]in the CloudTrail API Reference to retrieve the events for the resource. + // + // [LookupEvents API]: https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_LookupEvents.html + // [What Is CloudTrail]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html RelatedEvents []string // A list of related Amazon Web Services resources. @@ -846,26 +920,31 @@ type ConfigurationItem struct { } // Records configuration changes to your specified resource types. For more -// information about the configuration recorder, see Managing the Configuration -// Recorder (https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html) -// in the Config Developer Guide. +// information about the configuration recorder, see [Managing the Configuration Recorder]in the Config Developer Guide. +// +// [Managing the Configuration Recorder]: https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html type ConfigurationRecorder struct { // The name of the configuration recorder. Config automatically assigns the name - // of "default" when creating the configuration recorder. You cannot change the - // name of the configuration recorder after it has been created. To change the - // configuration recorder name, you must delete it and create a new configuration - // recorder with a new name. + // of "default" when creating the configuration recorder. + // + // You cannot change the name of the configuration recorder after it has been + // created. To change the configuration recorder name, you must delete it and + // create a new configuration recorder with a new name. Name *string - // Specifies which resource types Config records for configuration changes. High - // Number of Config Evaluations You may notice increased activity in your account - // during your initial month recording with Config when compared to subsequent - // months. During the initial bootstrapping process, Config runs evaluations on all - // the resources in your account that you have selected for Config to record. If - // you are running ephemeral workloads, you may see increased activity from Config - // as it records configuration changes associated with creating and deleting these - // temporary resources. An ephemeral workload is a temporary use of computing + // Specifies which resource types Config records for configuration changes. + // + // High Number of Config Evaluations + // + // You may notice increased activity in your account during your initial month + // recording with Config when compared to subsequent months. During the initial + // bootstrapping process, Config runs evaluations on all the resources in your + // account that you have selected for Config to record. + // + // If you are running ephemeral workloads, you may see increased activity from + // Config as it records configuration changes associated with creating and deleting + // these temporary resources. An ephemeral workload is a temporary use of computing // resources that are loaded and run when needed. Examples include Amazon Elastic // Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If // you want to avoid the increased activity from running ephemeral workloads, you @@ -874,42 +953,54 @@ type ConfigurationRecorder struct { RecordingGroup *RecordingGroup // Specifies the default recording frequency that Config uses to record - // configuration changes. Config supports Continuous recording and Daily recording. + // configuration changes. + // + // Config supports Continuous recording and Daily recording. // // - Continuous recording allows you to record configuration changes // continuously whenever a change occurs. + // // - Daily recording allows you to receive a configuration item (CI) // representing the most recent state of your resources over the last 24-hour // period, only if it’s different from the previous CI recorded. + // // Firewall Manager depends on continuous recording to monitor your resources. If // you are using Firewall Manager, it is recommended that you set the recording - // frequency to Continuous. You can also override the recording frequency for - // specific resource types. + // frequency to Continuous. + // + // You can also override the recording frequency for specific resource types. RecordingMode *RecordingMode // Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the - // configuration recorder. While the API model does not require this field, the - // server will reject a request without a defined roleARN for the configuration - // recorder. Pre-existing Config role If you have used an Amazon Web Services - // service that uses Config, such as Security Hub or Control Tower, and an Config - // role has already been created, make sure that the IAM role that you use when - // setting up Config keeps the same minimum permissions as the already created - // Config role. You must do this so that the other Amazon Web Services service - // continues to run as expected. For example, if Control Tower has an IAM role that - // allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make - // sure that the same permissions are granted within the IAM role you use when - // setting up Config. Otherwise, it may interfere with how Control Tower operates. - // For more information about IAM roles for Config, see Identity and Access - // Management for Config (https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html) - // in the Config Developer Guide. + // configuration recorder. + // + // While the API model does not require this field, the server will reject a + // request without a defined roleARN for the configuration recorder. + // + // Pre-existing Config role + // + // If you have used an Amazon Web Services service that uses Config, such as + // Security Hub or Control Tower, and an Config role has already been created, make + // sure that the IAM role that you use when setting up Config keeps the same + // minimum permissions as the already created Config role. You must do this so that + // the other Amazon Web Services service continues to run as expected. + // + // For example, if Control Tower has an IAM role that allows Config to read Amazon + // Simple Storage Service (Amazon S3) objects, make sure that the same permissions + // are granted within the IAM role you use when setting up Config. Otherwise, it + // may interfere with how Control Tower operates. For more information about IAM + // roles for Config, see [Identity and Access Management for Config]in the Config Developer Guide. + // + // [Identity and Access Management for Config]: https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html RoleARN *string noSmithyDocumentSerde } -// The current status of the configuration recorder. For a detailed status of -// recording events over time, add your Config events to CloudWatch metrics and use -// CloudWatch metrics. +// The current status of the configuration recorder. +// +// For a detailed status of recording events over time, add your Config events to +// CloudWatch metrics and use CloudWatch metrics. type ConfigurationRecorderStatus struct { // The latest error code from when the recorder last failed. @@ -943,8 +1034,10 @@ type ConfigurationRecorderStatus struct { // Filters the conformance pack by compliance types and Config rule names. type ConformancePackComplianceFilters struct { - // Filters the results by compliance. The allowed values are COMPLIANT and - // NON_COMPLIANT . INSUFFICIENT_DATA is not supported. + // Filters the results by compliance. + // + // The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not + // supported. ComplianceType ConformancePackComplianceType // Filters the results by Config rule names. @@ -1031,10 +1124,14 @@ type ConformancePackDetail struct { CreatedBy *string // The name of the Amazon S3 bucket where Config stores conformance pack - // templates. This field is optional. + // templates. + // + // This field is optional. DeliveryS3Bucket *string - // The prefix for the Amazon S3 bucket. This field is optional. + // The prefix for the Amazon S3 bucket. + // + // This field is optional. DeliveryS3KeyPrefix *string // The last time a conformation pack update was requested. @@ -1052,15 +1149,19 @@ type ConformancePackDetail struct { // Services resource types, and resource IDs. type ConformancePackEvaluationFilters struct { - // Filters the results by compliance. The allowed values are COMPLIANT and - // NON_COMPLIANT . INSUFFICIENT_DATA is not supported. + // Filters the results by compliance. + // + // The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not + // supported. ComplianceType ConformancePackComplianceType // Filters the results by Config rule names. ConfigRuleNames []string - // Filters the results by resource IDs. This is valid only when you provide - // resource type. If there is no resource type, you will see an error. + // Filters the results by resource IDs. + // + // This is valid only when you provide 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" ). @@ -1155,14 +1256,20 @@ type ConformancePackStatusDetail struct { // This member is required. ConformancePackName *string - // Indicates deployment status of conformance pack. Config sets the state of the - // conformance pack to: + // 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. // // This member is required. @@ -1194,8 +1301,9 @@ 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) . + // Config Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository]. + // + // [Guard GitHub Repository]: https://github.com/aws-cloudformation/cloudformation-guard // // This member is required. PolicyRuntime *string @@ -1228,11 +1336,13 @@ type DeliveryChannel struct { Name *string // The name of the Amazon S3 bucket to which Config delivers configuration - // 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) - // in the Config Developer Guide. + // 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]in the Config Developer Guide. + // + // [Permissions for the Amazon S3 Bucket]: https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html S3BucketName *string // The prefix for the specified Amazon S3 bucket. @@ -1244,16 +1354,21 @@ type DeliveryChannel struct { 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) - // in the Config Developer Guide. + // 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]in the Config + // Developer Guide. + // + // [Permissions for the Amazon SNS Topic]: https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html SnsTopicARN *string noSmithyDocumentSerde } -// The status of a specified delivery channel. Valid values: Success | Failure +// The status of a specified delivery channel. +// +// Valid values: Success | Failure type DeliveryChannelStatus struct { // A list that contains the status of the delivery of the configuration history to @@ -1276,8 +1391,10 @@ 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) -// in the Config Developer Guide. +// information on Detective or Proactive Config rules, see [Evaluation Mode]in the Config Developer +// Guide. +// +// [Evaluation Mode]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html type DescribeConfigRulesFilters struct { // The mode of an evaluation. The valid values are Detective or Proactive. @@ -1301,12 +1418,15 @@ type Evaluation struct { 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 - // PutEvaluations request. For example, an Lambda function for a custom Config rule - // cannot pass an INSUFFICIENT_DATA value to 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. // // This member is required. ComplianceType ComplianceType @@ -1356,9 +1476,11 @@ type EvaluationResult struct { 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. + // 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. @@ -1433,29 +1555,48 @@ type EvaluationStatus struct { // Specifies whether the configuration recorder excludes certain resource types // from being recorded. Use the resourceTypes field to enter a comma-separated -// list of resource types you want to exclude from recording. By default, when -// Config adds support for a new resource type in the Region where you set up the -// configuration recorder, including global resource types, Config starts recording -// resources of that type automatically. How to use the exclusion recording -// strategy To use this option, you must set the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) -// to EXCLUSION_BY_RESOURCE_TYPES . Config will then record configuration changes -// for all supported resource types, except the resource types that you specify to -// exclude from being recorded. Global resource types and the exclusion recording -// strategy Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will -// be recorded automatically in all supported Config Regions were the configuration -// recorder is enabled. IAM users, groups, roles, and customer managed policies -// will be recorded in the Region where you set up the configuration recorder if -// that is a Region where Config was available before February 2022. You cannot be -// record the global IAM resouce types in Regions supported by Config after -// February 2022. This list where you cannot record the global IAM resource types -// includes the following Regions: +// list of resource types you want to exclude from recording. +// +// By default, when Config adds support for a new resource type in the Region +// where you set up the configuration recorder, including global resource types, +// Config starts recording resources of that type automatically. +// +// # How to use the exclusion recording strategy +// +// To use this option, you must set the useOnly field of [RecordingStrategy] to +// EXCLUSION_BY_RESOURCE_TYPES . +// +// Config will then record configuration changes for all supported resource types, +// except the resource types that you specify to exclude from being recorded. +// +// # Global resource types and the exclusion recording strategy +// +// Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be +// recorded automatically in all supported Config Regions were the configuration +// recorder is enabled. +// +// IAM users, groups, roles, and customer managed policies will be recorded in the +// Region where you set up the configuration recorder if that is a Region where +// Config was available before February 2022. You cannot be record the global IAM +// resouce types in Regions supported by Config after February 2022. This list +// where you cannot record the global IAM resource types includes the following +// Regions: +// // - Asia Pacific (Hyderabad) +// // - Asia Pacific (Melbourne) +// // - Canada West (Calgary) +// // - Europe (Spain) +// // - Europe (Zurich) +// // - Israel (Tel Aviv) +// // - Middle East (UAE) +// +// [RecordingStrategy]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html type ExclusionByResourceTypes struct { // A comma-separated list of resource types to exclude from recording by the @@ -1592,16 +1733,26 @@ 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 - // to: + // 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. // // This member is required. @@ -1692,20 +1843,31 @@ 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: + // 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. // @@ -1749,11 +1911,14 @@ type OrganizationConformancePack struct { ConformancePackInputParameters []ConformancePackInputParameter // The name of the Amazon S3 bucket where Config stores conformance pack - // templates. This field is optional. + // templates. + // + // This field is optional. DeliveryS3Bucket *string - // Any folder structure you want to add to an Amazon S3 bucket. This field is - // optional. + // Any folder structure you want to add to an Amazon S3 bucket. + // + // This field is optional. DeliveryS3KeyPrefix *string // A comma-separated list of accounts excluded from organization conformance pack. @@ -1784,24 +1949,34 @@ 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: + // 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. // @@ -1838,24 +2013,34 @@ type OrganizationConformancePackStatus struct { // 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: + // 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. // @@ -1885,8 +2070,9 @@ 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) . + // Config Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository]. + // + // [Guard GitHub Repository]: https://github.com/aws-cloudformation/cloudformation-guard // // This member is required. PolicyRuntime *string @@ -1912,14 +2098,16 @@ type OrganizationCustomPolicyRuleMetadata struct { // 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 . + // 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 @@ -1943,7 +2131,8 @@ type OrganizationCustomPolicyRuleMetadata struct { noSmithyDocumentSerde } -// metadata for your organization Config Custom Policy rule including the runtime +// metadata for your organization Config Custom Policy rule including the runtime +// // system in use, which accounts have debug logging enabled, and other custom rule // metadata such as resource type, resource ID of Amazon Web Services resource, and // organization trigger types that trigger Config to evaluate Amazon Web Services @@ -1965,14 +2154,16 @@ type OrganizationCustomPolicyRuleMetadataNoPolicy struct { // 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 . + // 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 @@ -1981,8 +2172,9 @@ type OrganizationCustomPolicyRuleMetadataNoPolicy 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) . + // Config Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository]. + // + // [Guard GitHub Repository]: https://github.com/aws-cloudformation/cloudformation-guard PolicyRuntime *string // The ID of the Amazon Web Services resource that was evaluated. @@ -2016,12 +2208,15 @@ 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 . // @@ -2037,9 +2232,11 @@ type OrganizationCustomRuleMetadata struct { // 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. + // 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. @@ -2067,8 +2264,9 @@ 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) - // . + // see [Using Config managed rules]. + // + // [Using Config managed rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html // // This member is required. RuleIdentifier *string @@ -2081,9 +2279,10 @@ type OrganizationManagedRuleMetadata struct { 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 + // 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 @@ -2118,24 +2317,34 @@ 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: + // 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 @@ -2169,43 +2378,68 @@ type QueryInfo struct { // default, Config records configuration changes for all current and future // supported resource types in the Amazon Web Services Region where you have // enabled Config, excluding the global IAM resource types: IAM users, groups, -// roles, and customer managed policies. In the recording group, you specify -// whether you want to record all supported current and future supported resource -// types or to include or exclude specific resources types. 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) -// in the Config developer guide. If you don't want Config to record all current -// and future supported resource types (excluding the global IAM resource types), -// use one of the following recording strategies: +// roles, and customer managed policies. +// +// In the recording group, you specify whether you want to record all supported +// current and future supported resource types or to include or exclude specific +// resources types. For a list of supported resource types, see [Supported Resource Types]in the Config +// developer guide. +// +// If you don't want Config to record all current and future supported resource +// types (excluding the global IAM resource types), use one of the following +// recording strategies: +// // - Record all current and future resource types with exclusions ( // EXCLUSION_BY_RESOURCE_TYPES ), or +// // - Record specific resource types ( INCLUSION_BY_RESOURCE_TYPES ). // // If you use the recording strategy to Record all current and future resource // types ( ALL_SUPPORTED_RESOURCE_TYPES ), you can use the flag // includeGlobalResourceTypes to include the global IAM resource types in your -// recording. Aurora global clusters are recorded in all enabled Regions The -// AWS::RDS::GlobalCluster resource type will be recorded in all supported Config -// Regions where the configuration recorder is enabled. If you do not want to -// record AWS::RDS::GlobalCluster in all enabled Regions, use the -// EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_BY_RESOURCE_TYPES recording strategy. +// recording. +// +// # Aurora global clusters are recorded in all enabled Regions +// +// The AWS::RDS::GlobalCluster resource type will be recorded in all supported +// Config Regions where the configuration recorder is enabled. +// +// If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, +// use the EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_BY_RESOURCE_TYPES recording +// strategy. +// +// [Supported Resource Types]: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources type RecordingGroup struct { // Specifies whether Config records configuration changes for all supported - // resource types, excluding the global IAM resource types. If you set this field - // to true , when Config adds support for a new resource type, Config starts - // recording resources of that type automatically. If you set this field to true , - // you cannot enumerate specific resource types to record in the resourceTypes - // field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // , or to exclude in the resourceTypes field of ExclusionByResourceTypes (https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html) - // . Region availability Check Resource Coverage by Region Availability (https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html) - // to see if a resource type is supported in the Amazon Web Services Region where - // you set up Config. + // resource types, excluding the global IAM resource types. + // + // If you set this field to true , when Config adds support for a new resource + // type, Config starts recording resources of that type automatically. + // + // If you set this field to true , you cannot enumerate specific resource types to + // record in the resourceTypes field of [RecordingGroup], or to exclude in the resourceTypes field + // of [ExclusionByResourceTypes]. + // + // Region availability + // + // Check [Resource Coverage by Region Availability] to see if a resource type is supported in the Amazon Web Services Region + // where you set up Config. + // + // [ExclusionByResourceTypes]: https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html + // [RecordingGroup]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html + // [Resource Coverage by Region Availability]: https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html AllSupported bool // An object that specifies how Config excludes resource types from being recorded - // by the configuration recorder. Required fields To use this option, you must set - // the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) - // to EXCLUSION_BY_RESOURCE_TYPES . + // by the configuration recorder. + // + // Required fields + // + // To use this option, you must set the useOnly field of [RecordingStrategy] to + // EXCLUSION_BY_RESOURCE_TYPES . + // + // [RecordingStrategy]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html ExclusionByResourceTypes *ExclusionByResourceTypes // This option is a bundle which only applies to the global IAM resource types: @@ -2214,143 +2448,218 @@ type RecordingGroup struct { // available before February 2022. You cannot be record the global IAM resouce // types in Regions supported by Config after February 2022. This list where you // cannot record the global IAM resource types includes the following Regions: + // // - Asia Pacific (Hyderabad) + // // - Asia Pacific (Melbourne) + // // - Canada West (Calgary) + // // - Europe (Spain) + // // - Europe (Zurich) + // // - Israel (Tel Aviv) + // // - Middle East (UAE) - // Aurora global clusters are recorded in all enabled Regions The - // AWS::RDS::GlobalCluster resource type will be recorded in all supported Config - // Regions where the configuration recorder is enabled, even if + // + // Aurora global clusters are recorded in all enabled Regions + // + // The AWS::RDS::GlobalCluster resource type will be recorded in all supported + // Config Regions where the configuration recorder is enabled, even if // includeGlobalResourceTypes is set false . The includeGlobalResourceTypes option // is a bundle which only applies to IAM users, groups, roles, and customer managed - // policies. If you do not want to record AWS::RDS::GlobalCluster in all enabled - // Regions, use one of the following recording strategies: + // policies. + // + // If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, + // use one of the following recording strategies: + // // - Record all current and future resource types with exclusions ( // EXCLUSION_BY_RESOURCE_TYPES ), or + // // - Record specific resource types ( INCLUSION_BY_RESOURCE_TYPES ). - // For more information, see Selecting Which Resources are Recorded (https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all) - // in the Config developer guide. includeGlobalResourceTypes and the exclusion - // recording strategy The includeGlobalResourceTypes field has no impact on the + // + // For more information, see [Selecting Which Resources are Recorded] in the Config developer guide. + // + // includeGlobalResourceTypes and the exclusion recording strategy + // + // The includeGlobalResourceTypes field has no impact on the // EXCLUSION_BY_RESOURCE_TYPES recording strategy. This means that the global IAM // resource types (IAM users, groups, roles, and customer managed policies) will // not be automatically added as exclusions for exclusionByResourceTypes when - // includeGlobalResourceTypes is set to false . The includeGlobalResourceTypes - // field should only be used to modify the AllSupported field, as the default for - // the AllSupported field is to record configuration changes for all supported - // resource types excluding the global IAM resource types. To include the global - // IAM resource types when AllSupported is set to true , make sure to set - // includeGlobalResourceTypes to true . To exclude the global IAM resource types - // for the EXCLUSION_BY_RESOURCE_TYPES recording strategy, you need to manually - // add them to the resourceTypes field of exclusionByResourceTypes . Required and - // optional fields Before you set this field to true , set the allSupported field - // of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // to true . Optionally, you can set the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) - // to ALL_SUPPORTED_RESOURCE_TYPES . Overriding fields If you set this field to - // false but list global IAM resource types in the resourceTypes field of - // RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // , Config will still record configuration changes for those specified resource - // types regardless of if you set the includeGlobalResourceTypes field to false. + // includeGlobalResourceTypes is set to false . + // + // The includeGlobalResourceTypes field should only be used to modify the + // AllSupported field, as the default for the AllSupported field is to record + // configuration changes for all supported resource types excluding the global IAM + // resource types. To include the global IAM resource types when AllSupported is + // set to true , make sure to set includeGlobalResourceTypes to true . + // + // To exclude the global IAM resource types for the EXCLUSION_BY_RESOURCE_TYPES + // recording strategy, you need to manually add them to the resourceTypes field of + // exclusionByResourceTypes . + // + // Required and optional fields + // + // Before you set this field to true , set the allSupported field of [RecordingGroup] to true . + // Optionally, you can set the useOnly field of [RecordingStrategy] to ALL_SUPPORTED_RESOURCE_TYPES . + // + // Overriding fields + // + // If you set this field to false but list global IAM resource types in the + // resourceTypes field of [RecordingGroup], Config will still record configuration changes for + // those specified resource types regardless of if you set the + // includeGlobalResourceTypes field to false. + // // If you do not want to record configuration changes to the global IAM resource // types (IAM users, groups, roles, and customer managed policies), make sure to // not list them in the resourceTypes field in addition to setting the // includeGlobalResourceTypes field to false. + // + // [RecordingStrategy]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html + // [Selecting Which Resources are Recorded]: https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all + // [RecordingGroup]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html IncludeGlobalResourceTypes bool // An object that specifies the recording strategy for the configuration recorder. - // - If you set the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) - // to ALL_SUPPORTED_RESOURCE_TYPES , Config records configuration changes for all - // supported resource types, excluding the global IAM resource types. You also must - // set the allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // to true . When Config adds support for a new resource type, Config - // automatically starts recording resources of that type. - // - If you set the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) - // to INCLUSION_BY_RESOURCE_TYPES , Config records configuration changes for only - // the resource types you specify in the resourceTypes field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // . - // - If you set the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) - // to EXCLUSION_BY_RESOURCE_TYPES , Config records configuration changes for all - // supported resource types except the resource types that you specify to exclude - // from being recorded in the resourceTypes field of ExclusionByResourceTypes (https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html) - // . - // Required and optional fields The recordingStrategy field is optional when you - // set the allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // to true . The recordingStrategy field is optional when you list resource types - // in the resourceTypes field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // . The recordingStrategy field is required if you list resource types to exclude - // from recording in the resourceTypes field of ExclusionByResourceTypes (https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html) - // . Overriding fields If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording - // strategy, the exclusionByResourceTypes field will override other properties in - // the request. For example, even if you set includeGlobalResourceTypes to false, - // global IAM resource types will still be automatically recorded in this option - // unless those resource types are specifically listed as exclusions in the - // resourceTypes field of exclusionByResourceTypes . Global resources types and the - // resource exclusion recording strategy By default, if you choose the - // EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a - // new resource type in the Region where you set up the configuration recorder, - // including global resource types, Config starts recording resources of that type - // automatically. Unless specifically listed as exclusions, AWS::RDS::GlobalCluster - // will be recorded automatically in all supported Config Regions were the - // configuration recorder is enabled. IAM users, groups, roles, and customer - // managed policies will be recorded in the Region where you set up the - // configuration recorder if that is a Region where Config was available before - // February 2022. You cannot be record the global IAM resouce types in Regions - // supported by Config after February 2022. This list where you cannot record the - // global IAM resource types includes the following Regions: + // + // - If you set the useOnly field of [RecordingStrategy]to ALL_SUPPORTED_RESOURCE_TYPES , Config + // records configuration changes for all supported resource types, excluding the + // global IAM resource types. You also must set the allSupported field of [RecordingGroup]to true + // . When Config adds support for a new resource type, Config automatically starts + // recording resources of that type. + // + // - If you set the useOnly field of [RecordingStrategy]to INCLUSION_BY_RESOURCE_TYPES , Config + // records configuration changes for only the resource types you specify in the + // resourceTypes field of [RecordingGroup]. + // + // - If you set the useOnly field of [RecordingStrategy]to EXCLUSION_BY_RESOURCE_TYPES , Config + // records configuration changes for all supported resource types except the + // resource types that you specify to exclude from being recorded in the + // resourceTypes field of [ExclusionByResourceTypes]. + // + // Required and optional fields + // + // The recordingStrategy field is optional when you set the allSupported field of [RecordingGroup] + // to true . + // + // The recordingStrategy field is optional when you list resource types in the + // resourceTypes field of [RecordingGroup]. + // + // The recordingStrategy field is required if you list resource types to exclude + // from recording in the resourceTypes field of [ExclusionByResourceTypes]. + // + // Overriding fields + // + // If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the + // exclusionByResourceTypes field will override other properties in the request. + // + // For example, even if you set includeGlobalResourceTypes to false, global IAM + // resource types will still be automatically recorded in this option unless those + // resource types are specifically listed as exclusions in the resourceTypes field + // of exclusionByResourceTypes . + // + // Global resources types and the resource exclusion recording strategy + // + // By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, + // when Config adds support for a new resource type in the Region where you set up + // the configuration recorder, including global resource types, Config starts + // recording resources of that type automatically. + // + // Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be + // recorded automatically in all supported Config Regions were the configuration + // recorder is enabled. + // + // IAM users, groups, roles, and customer managed policies will be recorded in the + // Region where you set up the configuration recorder if that is a Region where + // Config was available before February 2022. You cannot be record the global IAM + // resouce types in Regions supported by Config after February 2022. This list + // where you cannot record the global IAM resource types includes the following + // Regions: + // // - Asia Pacific (Hyderabad) + // // - Asia Pacific (Melbourne) + // // - Canada West (Calgary) + // // - Europe (Spain) + // // - Europe (Zurich) + // // - Israel (Tel Aviv) + // // - Middle East (UAE) + // + // [RecordingStrategy]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html + // [ExclusionByResourceTypes]: https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html + // [RecordingGroup]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html RecordingStrategy *RecordingStrategy - // A comma-separated list that specifies which resource types Config records. For - // a list of valid resourceTypes values, see the Resource Type Value column in - // Supported Amazon Web Services resource Types (https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources) - // in the Config developer guide. Required and optional fields Optionally, you can - // set the useOnly field of RecordingStrategy (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html) - // to INCLUSION_BY_RESOURCE_TYPES . To record all configuration changes, set the - // allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // to true , and either omit this field or don't specify any resource types in this - // field. If you set the allSupported field to false and specify values for - // resourceTypes , 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. Region availability Before specifying a resource type for - // Config to track, check Resource Coverage by Region Availability (https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html) - // to see if the resource type is supported in the Amazon Web Services Region where - // you set up Config. If a resource type is supported by Config in at least one - // Region, you can enable the recording of that resource type in all Regions - // supported by Config, even if the specified resource type is not supported in the - // Amazon Web Services Region where you set up Config. + // A comma-separated list that specifies which resource types Config records. + // + // For a list of valid resourceTypes values, see the Resource Type Value column in [Supported Amazon Web Services resource Types] + // in the Config developer guide. + // + // Required and optional fields + // + // Optionally, you can set the useOnly field of [RecordingStrategy] to INCLUSION_BY_RESOURCE_TYPES . + // + // To record all configuration changes, set the allSupported field of [RecordingGroup] to true , + // and either omit this field or don't specify any resource types in this field. If + // you set the allSupported field to false and specify values for resourceTypes , + // 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. + // + // Region availability + // + // Before specifying a resource type for Config to track, check [Resource Coverage by Region Availability] to see if the + // resource type is supported in the Amazon Web Services Region where you set up + // Config. If a resource type is supported by Config in at least one Region, you + // can enable the recording of that resource type in all Regions supported by + // Config, even if the specified resource type is not supported in the Amazon Web + // Services Region where you set up Config. + // + // [RecordingStrategy]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html + // [Supported Amazon Web Services resource Types]: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources + // [RecordingGroup]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html + // [Resource Coverage by Region Availability]: https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html ResourceTypes []ResourceType noSmithyDocumentSerde } // Specifies the default recording frequency that Config uses to record -// configuration changes. Config supports Continuous recording and Daily recording. +// configuration changes. +// +// Config supports Continuous recording and Daily recording. // // - Continuous recording allows you to record configuration changes // continuously whenever a change occurs. +// // - Daily recording allows you to receive a configuration item (CI) // representing the most recent state of your resources over the last 24-hour // period, only if it’s different from the previous CI recorded. // // Firewall Manager depends on continuous recording to monitor your resources. If // you are using Firewall Manager, it is recommended that you set the recording -// frequency to Continuous. You can also override the recording frequency for -// specific resource types. +// frequency to Continuous. +// +// You can also override the recording frequency for specific resource types. type RecordingMode struct { // The default recording frequency that Config uses to record configuration - // changes. Daily recording is not supported for the following resource types: + // changes. + // + // Daily recording is not supported for the following resource types: + // // - AWS::Config::ResourceCompliance + // // - AWS::Config::ConformancePackCompliance + // // - AWS::Config::ConfigurationRecorder + // // For the allSupported ( ALL_SUPPORTED_RESOURCE_TYPES ) recording strategy, these // resource types will be set to Continuous recording. // @@ -2371,11 +2680,14 @@ type RecordingModeOverride struct { // The recording frequency that will be applied to all the resource types // specified in the override. + // // - Continuous recording allows you to record configuration changes // continuously whenever a change occurs. + // // - Daily recording allows you to receive a configuration item (CI) // representing the most recent state of your resources over the last 24-hour // period, only if it’s different from the previous CI recorded. + // // Firewall Manager depends on continuous recording to monitor your resources. If // you are using Firewall Manager, it is recommended that you set the recording // frequency to Continuous. @@ -2384,10 +2696,14 @@ type RecordingModeOverride struct { RecordingFrequency RecordingFrequency // A comma-separated list that specifies which resource types Config includes in - // the override. Daily recording is not supported for the following resource types: + // the override. + // + // Daily recording is not supported for the following resource types: // // - AWS::Config::ResourceCompliance + // // - AWS::Config::ConformancePackCompliance + // // - AWS::Config::ConfigurationRecorder // // This member is required. @@ -2403,53 +2719,79 @@ type RecordingModeOverride struct { type RecordingStrategy struct { // The recording strategy for the configuration recorder. + // // - If you set this option to ALL_SUPPORTED_RESOURCE_TYPES , Config records // configuration changes for all supported resource types, excluding the global IAM - // resource types. You also must set the allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // to true . When Config adds support for a new resource type, Config - // automatically starts recording resources of that type. 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) + // resource types. You also must set the allSupported field of [RecordingGroup]to true . When + // Config adds support for a new resource type, Config automatically starts + // recording resources of that type. For a list of supported resource types, see [Supported Resource Types] // in the Config developer guide. + // // - If you set this option to INCLUSION_BY_RESOURCE_TYPES , Config records // configuration changes for only the resource types that you specify in the - // resourceTypes field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // . + // resourceTypes field of [RecordingGroup]. + // // - If you set this option to EXCLUSION_BY_RESOURCE_TYPES , Config records // configuration changes for all supported resource types, except the resource // types that you specify to exclude from being recorded in the resourceTypes - // field of ExclusionByResourceTypes (https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html) - // . - // Required and optional fields The recordingStrategy field is optional when you - // set the allSupported field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // to true . The recordingStrategy field is optional when you list resource types - // in the resourceTypes field of RecordingGroup (https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html) - // . The recordingStrategy field is required if you list resource types to exclude - // from recording in the resourceTypes field of ExclusionByResourceTypes (https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html) - // . Overriding fields If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording - // strategy, the exclusionByResourceTypes field will override other properties in - // the request. For example, even if you set includeGlobalResourceTypes to false, - // global IAM resource types will still be automatically recorded in this option - // unless those resource types are specifically listed as exclusions in the - // resourceTypes field of exclusionByResourceTypes . Global resource types and the - // exclusion recording strategy By default, if you choose the - // EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a - // new resource type in the Region where you set up the configuration recorder, - // including global resource types, Config starts recording resources of that type - // automatically. Unless specifically listed as exclusions, AWS::RDS::GlobalCluster - // will be recorded automatically in all supported Config Regions were the - // configuration recorder is enabled. IAM users, groups, roles, and customer - // managed policies will be recorded in the Region where you set up the - // configuration recorder if that is a Region where Config was available before - // February 2022. You cannot be record the global IAM resouce types in Regions - // supported by Config after February 2022. This list where you cannot record the - // global IAM resource types includes the following Regions: + // field of [ExclusionByResourceTypes]. + // + // Required and optional fields + // + // The recordingStrategy field is optional when you set the allSupported field of [RecordingGroup] + // to true . + // + // The recordingStrategy field is optional when you list resource types in the + // resourceTypes field of [RecordingGroup]. + // + // The recordingStrategy field is required if you list resource types to exclude + // from recording in the resourceTypes field of [ExclusionByResourceTypes]. + // + // Overriding fields + // + // If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the + // exclusionByResourceTypes field will override other properties in the request. + // + // For example, even if you set includeGlobalResourceTypes to false, global IAM + // resource types will still be automatically recorded in this option unless those + // resource types are specifically listed as exclusions in the resourceTypes field + // of exclusionByResourceTypes . + // + // Global resource types and the exclusion recording strategy + // + // By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, + // when Config adds support for a new resource type in the Region where you set up + // the configuration recorder, including global resource types, Config starts + // recording resources of that type automatically. + // + // Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be + // recorded automatically in all supported Config Regions were the configuration + // recorder is enabled. + // + // IAM users, groups, roles, and customer managed policies will be recorded in the + // Region where you set up the configuration recorder if that is a Region where + // Config was available before February 2022. You cannot be record the global IAM + // resouce types in Regions supported by Config after February 2022. This list + // where you cannot record the global IAM resource types includes the following + // Regions: + // // - Asia Pacific (Hyderabad) + // // - Asia Pacific (Melbourne) + // // - Canada West (Calgary) + // // - Europe (Spain) + // // - Europe (Zurich) + // // - Israel (Tel Aviv) + // // - Middle East (UAE) + // + // [ExclusionByResourceTypes]: https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html + // [RecordingGroup]: https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html + // [Supported Resource Types]: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources UseOnly RecordingStrategyType noSmithyDocumentSerde @@ -2505,10 +2847,13 @@ type RemediationConfiguration struct { 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. + // 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. @@ -2521,13 +2866,16 @@ type RemediationConfiguration struct { // prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation // attempts have been made under RetryAttemptSeconds , a remediation exception will // be added to the resource. If you do not select a number, the default is 60 - // seconds. For example, if you specify RetryAttemptSeconds as 50 seconds and + // seconds. + // + // For example, if you specify RetryAttemptSeconds as 50 seconds and // MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within // 50 seconds before adding a remediation exception to the resource. RetryAttemptSeconds *int64 - // Version of the target. For example, version of the SSM document. If you make - // backward incompatible changes to the SSM document, you must call + // Version of the target. For example, version of the SSM document. + // + // If you make backward incompatible changes to the SSM document, you must call // PutRemediationConfiguration API again to ensure the remediations can run. TargetVersion *string @@ -2679,14 +3027,18 @@ type ResourceDetails struct { // This member is required. 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 - // 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) - // in the CloudFormation User Guide. + // The schema type of the resource configuration. + // + // You can find the [Resource type schema], 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] and [Amazon Web Services resource and property types reference] in the CloudFormation User Guide. + // + // [Resource type schema]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html + // [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html + // [Managing extensions through the CloudFormation registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view ResourceConfigurationSchemaType ResourceConfigurationSchemaType noSmithyDocumentSerde @@ -2715,6 +3067,7 @@ type ResourceEvaluationFilters struct { EvaluationContextIdentifier *string // Filters all resource evaluations results based on an evaluation mode. + // // Currently, DECTECTIVE is not supported as a valid value. Ignore other // documentation stating otherwise. EvaluationMode EvaluationMode @@ -2800,8 +3153,9 @@ type RetentionConfiguration struct { // This member is required. Name *string - // Number of days Config stores your historical information. Currently, only - // applicable to the configuration item history. + // Number of days Config stores your historical information. + // + // Currently, only applicable to the configuration item history. // // This member is required. RetentionPeriodInDays *int32 @@ -2846,12 +3200,17 @@ type Scope struct { 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) - // 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) - // in the Config developer guide. + // Config rule. + // + // Config Managed Rules are predefined rules owned by Amazon Web Services. For + // more information, see [Config Managed Rules]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] in the + // Config developer guide. + // + // [Config Custom Rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html + // [Config Managed Rules]: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html // // This member is required. Owner Owner @@ -2863,18 +3222,23 @@ type Source struct { // 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 - // for the Config rule trigger message type are ConfigurationItemChangeNotification - // and OversizedConfigurationItemChangeNotification . + // 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 . 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 + // IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see [List of Config Managed Rules]. + // + // 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. + // arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name . + // + // For Config Custom Policy rules, this field will be ignored. + // + // [List of Config Managed Rules]: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html SourceIdentifier *string noSmithyDocumentSerde @@ -2893,26 +3257,35 @@ type SourceDetail struct { // 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. + // 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 . @@ -2964,16 +3337,26 @@ 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 - // to: + // 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. MemberAccountRuleStatus MemberAccountRuleStatus @@ -3052,10 +3435,13 @@ 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]. You can also provide the +// DocumentVersion . +// +// The TemplateSSMDocumentDetails object contains the name of the SSM document and +// the version of the SSM document. +// +// [PutConformancePack API]: https://docs.aws.amazon.com/config/latest/APIReference/API_PutConformancePack.html type TemplateSSMDocumentDetails struct { // The name or Amazon Resource Name (ARN) of the SSM document to use to create a @@ -3066,7 +3452,9 @@ type TemplateSSMDocumentDetails struct { 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. + // default, Config uses the latest version. + // + // This field is optional. DocumentVersion *string noSmithyDocumentSerde diff --git a/service/connect/api_op_ActivateEvaluationForm.go b/service/connect/api_op_ActivateEvaluationForm.go index 60accfdd371..ebee25f95d6 100644 --- a/service/connect/api_op_ActivateEvaluationForm.go +++ b/service/connect/api_op_ActivateEvaluationForm.go @@ -41,8 +41,10 @@ type ActivateEvaluationFormInput struct { // This member is required. EvaluationFormVersion int32 - // The 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. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateAnalyticsDataSet.go b/service/connect/api_op_AssociateAnalyticsDataSet.go index 5403ca9667f..5e4ac68e366 100644 --- a/service/connect/api_op_AssociateAnalyticsDataSet.go +++ b/service/connect/api_op_AssociateAnalyticsDataSet.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Associates the specified dataset for a Amazon Connect instance with the target // account. You can associate only one dataset in a single call. func (c *Client) AssociateAnalyticsDataSet(ctx context.Context, params *AssociateAnalyticsDataSetInput, optFns ...func(*Options)) (*AssociateAnalyticsDataSetOutput, error) { @@ -35,8 +36,10 @@ type AssociateAnalyticsDataSetInput struct { // This member is required. DataSetId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateApprovedOrigin.go b/service/connect/api_op_AssociateApprovedOrigin.go index b10618ae4e4..d213d8ba308 100644 --- a/service/connect/api_op_AssociateApprovedOrigin.go +++ b/service/connect/api_op_AssociateApprovedOrigin.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Associates an approved origin to an Amazon Connect instance. func (c *Client) AssociateApprovedOrigin(ctx context.Context, params *AssociateApprovedOriginInput, optFns ...func(*Options)) (*AssociateApprovedOriginOutput, error) { if params == nil { @@ -29,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateBot.go b/service/connect/api_op_AssociateBot.go index a19c0c42bed..699175dff27 100644 --- a/service/connect/api_op_AssociateBot.go +++ b/service/connect/api_op_AssociateBot.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Allows the specified Amazon Connect instance to access the specified Amazon Lex // or Amazon Lex V2 bot. func (c *Client) AssociateBot(ctx context.Context, params *AssociateBotInput, optFns ...func(*Options)) (*AssociateBotOutput, error) { @@ -31,8 +32,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateDefaultVocabulary.go b/service/connect/api_op_AssociateDefaultVocabulary.go index 4e176c97f70..385eec9f141 100644 --- a/service/connect/api_op_AssociateDefaultVocabulary.go +++ b/service/connect/api_op_AssociateDefaultVocabulary.go @@ -31,14 +31,18 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // 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?] + // + // [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html // // This member is required. LanguageCode types.VocabularyLanguageCode diff --git a/service/connect/api_op_AssociateFlow.go b/service/connect/api_op_AssociateFlow.go index 53cc2628a18..bf09c1a2b39 100644 --- a/service/connect/api_op_AssociateFlow.go +++ b/service/connect/api_op_AssociateFlow.go @@ -34,8 +34,10 @@ type AssociateFlowInput struct { // This member is required. FlowId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateInstanceStorageConfig.go b/service/connect/api_op_AssociateInstanceStorageConfig.go index fe862739df1..84a864734c0 100644 --- a/service/connect/api_op_AssociateInstanceStorageConfig.go +++ b/service/connect/api_op_AssociateInstanceStorageConfig.go @@ -12,13 +12,15 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Associates a storage resource type for the first time. You can only associate // one type of storage configuration in a single call. This means, for example, // that you can't define an instance with multiple S3 buckets for storing chat -// transcripts. This API does not create a resource that doesn't exist. It only -// associates it to the instance. Ensure that the resource being specified in the -// storage configuration, like an S3 bucket, exists when being used for -// association. +// transcripts. +// +// This API does not create a resource that doesn't exist. It only associates it +// to the instance. Ensure that the resource being specified in the storage +// configuration, like an S3 bucket, exists when being used for association. func (c *Client) AssociateInstanceStorageConfig(ctx context.Context, params *AssociateInstanceStorageConfigInput, optFns ...func(*Options)) (*AssociateInstanceStorageConfigOutput, error) { if params == nil { params = &AssociateInstanceStorageConfigInput{} @@ -36,22 +38,29 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string - // A valid resource type. To enable streaming for real-time analysis of contacts (https://docs.aws.amazon.com/connect/latest/adminguide/enable-contact-analysis-segment-streams.html) - // , use the following types: + // A valid resource type. To [enable streaming for real-time analysis of contacts], use the following types: + // // - For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS . + // // - For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS . + // // REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported // and will apply only to VOICE channel contacts. Use - // REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. If - // you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS - // , no action is needed to update the stream to - // REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS . + // REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward. + // + // If you have previously associated a stream with + // REAL_TIME_CONTACT_ANALYSIS_SEGMENTS , no action is needed to update the stream + // to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS . + // + // [enable streaming for real-time analysis of contacts]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-contact-analysis-segment-streams.html // // This member is required. ResourceType types.InstanceStorageResourceType diff --git a/service/connect/api_op_AssociateLambdaFunction.go b/service/connect/api_op_AssociateLambdaFunction.go index cc72f9ea554..50db8342827 100644 --- a/service/connect/api_op_AssociateLambdaFunction.go +++ b/service/connect/api_op_AssociateLambdaFunction.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Allows the specified Amazon Connect instance to access the specified Lambda // function. func (c *Client) AssociateLambdaFunction(ctx context.Context, params *AssociateLambdaFunctionInput, optFns ...func(*Options)) (*AssociateLambdaFunctionOutput, error) { @@ -36,8 +37,10 @@ type AssociateLambdaFunctionInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateLexBot.go b/service/connect/api_op_AssociateLexBot.go index 1a856f4fb78..f20282cc6fd 100644 --- a/service/connect/api_op_AssociateLexBot.go +++ b/service/connect/api_op_AssociateLexBot.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Allows the specified Amazon Connect instance to access the specified Amazon Lex // V1 bot. This API only supports the association of Amazon Lex V1 bots. func (c *Client) AssociateLexBot(ctx context.Context, params *AssociateLexBotInput, optFns ...func(*Options)) (*AssociateLexBotOutput, error) { @@ -31,8 +32,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociatePhoneNumberContactFlow.go b/service/connect/api_op_AssociatePhoneNumberContactFlow.go index 7bfd335ec66..fcbc892fdec 100644 --- a/service/connect/api_op_AssociatePhoneNumberContactFlow.go +++ b/service/connect/api_op_AssociatePhoneNumberContactFlow.go @@ -11,6 +11,7 @@ import ( ) // Associates a flow with a phone number claimed to your Amazon Connect instance. +// // If the number is claimed to a traffic 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 @@ -41,8 +42,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateQueueQuickConnects.go b/service/connect/api_op_AssociateQueueQuickConnects.go index 55e8cc6f388..ad2f5093be5 100644 --- a/service/connect/api_op_AssociateQueueQuickConnects.go +++ b/service/connect/api_op_AssociateQueueQuickConnects.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Associates a set of quick connects with a queue. func (c *Client) AssociateQueueQuickConnects(ctx context.Context, params *AssociateQueueQuickConnectsInput, optFns ...func(*Options)) (*AssociateQueueQuickConnectsOutput, error) { if params == nil { @@ -29,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateRoutingProfileQueues.go b/service/connect/api_op_AssociateRoutingProfileQueues.go index 089d5fff322..f374b4e025b 100644 --- a/service/connect/api_op_AssociateRoutingProfileQueues.go +++ b/service/connect/api_op_AssociateRoutingProfileQueues.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateSecurityKey.go b/service/connect/api_op_AssociateSecurityKey.go index 60364d1fd2e..1f0b73ffbf9 100644 --- a/service/connect/api_op_AssociateSecurityKey.go +++ b/service/connect/api_op_AssociateSecurityKey.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Associates a security key to the instance. func (c *Client) AssociateSecurityKey(ctx context.Context, params *AssociateSecurityKeyInput, optFns ...func(*Options)) (*AssociateSecurityKeyOutput, error) { if params == nil { @@ -29,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_AssociateTrafficDistributionGroupUser.go b/service/connect/api_op_AssociateTrafficDistributionGroupUser.go index 04610cd8ae9..a00ee7401f0 100644 --- a/service/connect/api_op_AssociateTrafficDistributionGroupUser.go +++ b/service/connect/api_op_AssociateTrafficDistributionGroupUser.go @@ -28,8 +28,10 @@ func (c *Client) AssociateTrafficDistributionGroupUser(ctx context.Context, para type AssociateTrafficDistributionGroupUserInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_BatchAssociateAnalyticsDataSet.go b/service/connect/api_op_BatchAssociateAnalyticsDataSet.go index 28b8f90c7f7..26191c5112b 100644 --- a/service/connect/api_op_BatchAssociateAnalyticsDataSet.go +++ b/service/connect/api_op_BatchAssociateAnalyticsDataSet.go @@ -12,8 +12,9 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. -// Associates a list of analytics datasets for a given Amazon Connect instance to a -// target account. You can associate multiple datasets in a single call. +// +// Associates a list of analytics datasets for a given Amazon Connect instance to +// a target account. You can associate multiple datasets in a single call. func (c *Client) BatchAssociateAnalyticsDataSet(ctx context.Context, params *BatchAssociateAnalyticsDataSetInput, optFns ...func(*Options)) (*BatchAssociateAnalyticsDataSetOutput, error) { if params == nil { params = &BatchAssociateAnalyticsDataSetInput{} @@ -36,8 +37,10 @@ type BatchAssociateAnalyticsDataSetInput struct { // This member is required. DataSetIds []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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_BatchDisassociateAnalyticsDataSet.go b/service/connect/api_op_BatchDisassociateAnalyticsDataSet.go index 1472ad9de3a..897cea0cb09 100644 --- a/service/connect/api_op_BatchDisassociateAnalyticsDataSet.go +++ b/service/connect/api_op_BatchDisassociateAnalyticsDataSet.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Removes a list of analytics datasets associated with a given Amazon Connect // instance. You can disassociate multiple datasets in a single call. func (c *Client) BatchDisassociateAnalyticsDataSet(ctx context.Context, params *BatchDisassociateAnalyticsDataSetInput, optFns ...func(*Options)) (*BatchDisassociateAnalyticsDataSetOutput, error) { @@ -36,8 +37,10 @@ type BatchDisassociateAnalyticsDataSetInput struct { // This member is required. DataSetIds []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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_BatchGetAttachedFileMetadata.go b/service/connect/api_op_BatchGetAttachedFileMetadata.go index 2a11b8698a6..e6fa5ad90a5 100644 --- a/service/connect/api_op_BatchGetAttachedFileMetadata.go +++ b/service/connect/api_op_BatchGetAttachedFileMetadata.go @@ -31,8 +31,12 @@ func (c *Client) BatchGetAttachedFileMetadata(ctx context.Context, params *Batch type BatchGetAttachedFileMetadataInput struct { - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html // // This member is required. AssociatedResourceArn *string diff --git a/service/connect/api_op_BatchGetFlowAssociation.go b/service/connect/api_op_BatchGetFlowAssociation.go index 4b3549a340b..853bf75c99f 100644 --- a/service/connect/api_op_BatchGetFlowAssociation.go +++ b/service/connect/api_op_BatchGetFlowAssociation.go @@ -29,8 +29,10 @@ func (c *Client) BatchGetFlowAssociation(ctx context.Context, params *BatchGetFl type BatchGetFlowAssociationInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_BatchPutContact.go b/service/connect/api_op_BatchPutContact.go index a59da62be28..76efceb6486 100644 --- a/service/connect/api_op_BatchPutContact.go +++ b/service/connect/api_op_BatchPutContact.go @@ -12,13 +12,16 @@ import ( ) // Only the Amazon Connect outbound campaigns service principal is allowed to -// assume a role in your account and call this API. Allows you to create a batch of -// contacts in Amazon Connect. The outbound campaigns capability ingests dial -// requests via the PutDialRequestBatch (https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html) -// API. It then uses BatchPutContact to create contacts corresponding to those dial -// requests. If agents are available, the dial requests are dialed out, which -// results in a voice call. The resulting voice call uses the same contactId that -// was created by BatchPutContact. +// assume a role in your account and call this API. +// +// Allows you to create a batch of contacts in Amazon Connect. The outbound +// campaigns capability ingests dial requests via the [PutDialRequestBatch]API. It then uses +// BatchPutContact to create contacts corresponding to those dial requests. If +// agents are available, the dial requests are dialed out, which results in a voice +// call. The resulting voice call uses the same contactId that was created by +// BatchPutContact. +// +// [PutDialRequestBatch]: https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html func (c *Client) BatchPutContact(ctx context.Context, params *BatchPutContactInput, optFns ...func(*Options)) (*BatchPutContactOutput, error) { if params == nil { params = &BatchPutContactInput{} @@ -41,17 +44,19 @@ type BatchPutContactInput struct { // This member is required. ContactDataRequestList []types.ContactDataRequest - // The 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. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_ClaimPhoneNumber.go b/service/connect/api_op_ClaimPhoneNumber.go index 292d500cd24..f238c6421d4 100644 --- a/service/connect/api_op_ClaimPhoneNumber.go +++ b/service/connect/api_op_ClaimPhoneNumber.go @@ -13,26 +13,36 @@ 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) -// 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) -// operation. If you plan to claim and release numbers frequently during a 30 day -// period, contact us for a service quota exception. Otherwise, it is possible you -// will be blocked from claiming and releasing any more numbers until 30 days past -// the oldest number released has expired. By default you can claim and release up -// to 200% of your maximum number of active phone numbers during any 30 day period. -// If you claim and release phone numbers using the UI or API during a rolling 30 -// day cycle that exceeds 200% of your phone number service level quota, you will -// be blocked from claiming any more numbers until 30 days past the oldest number -// released has expired. For example, if you already have 99 claimed numbers and a -// service level quota of 99 phone numbers, and in any 30 day period you release -// 99, claim 99, and then release 99, you will have exceeded the 200% limit. At -// that point you are blocked from claiming any more numbers until you open an -// Amazon Web Services support ticket. +// created. +// +// For more information about how to use this operation, see [Claim a phone number in your country] and [Claim phone numbers to traffic distribution groups] in the Amazon +// Connect Administrator Guide. +// +// You can call the [SearchAvailablePhoneNumbers] API for available phone numbers that you can claim. Call the [DescribePhoneNumber] +// API to verify the status of a previous [ClaimPhoneNumber]operation. +// +// If you plan to claim and release numbers frequently during a 30 day period, +// contact us for a service quota exception. Otherwise, it is possible you will be +// blocked from claiming and releasing any more numbers until 30 days past the +// oldest number released has expired. +// +// By default you can claim and release up to 200% of your maximum number of +// active phone numbers during any 30 day period. If you claim and release phone +// numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of +// your phone number service level quota, you will be blocked from claiming any +// more numbers until 30 days past the oldest number released has expired. +// +// For example, if you already have 99 claimed numbers and a service level quota +// of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then +// release 99, you will have exceeded the 200% limit. At that point you are blocked +// from claiming any more numbers until you open an Amazon Web Services support +// ticket. +// +// [Claim phone numbers to traffic distribution groups]: https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html +// [Claim a phone number in your country]: https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html +// [SearchAvailablePhoneNumbers]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html +// [DescribePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html +// [ClaimPhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html func (c *Client) ClaimPhoneNumber(ctx context.Context, params *ClaimPhoneNumberInput, optFns ...func(*Options)) (*ClaimPhoneNumberOutput, error) { if params == nil { params = &ClaimPhoneNumberInput{} @@ -58,15 +68,18 @@ 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}$ + // field. For more information about idempotency, see [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}$ + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The identifier of the Amazon Connect instance that phone numbers are claimed - // to. 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 must enter InstanceId or - // TargetArn . + // to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance. You must enter + // InstanceId or TargetArn . + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The description of the phone number. diff --git a/service/connect/api_op_CompleteAttachedFileUpload.go b/service/connect/api_op_CompleteAttachedFileUpload.go index 62706756c32..bdf95c4224a 100644 --- a/service/connect/api_op_CompleteAttachedFileUpload.go +++ b/service/connect/api_op_CompleteAttachedFileUpload.go @@ -30,8 +30,12 @@ func (c *Client) CompleteAttachedFileUpload(ctx context.Context, params *Complet // Request to CompleteAttachedFileUpload API type CompleteAttachedFileUploadInput struct { - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html // // This member is required. AssociatedResourceArn *string diff --git a/service/connect/api_op_CreateAgentStatus.go b/service/connect/api_op_CreateAgentStatus.go index 03af3dd2764..f3e53fce233 100644 --- a/service/connect/api_op_CreateAgentStatus.go +++ b/service/connect/api_op_CreateAgentStatus.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Creates an agent status for the specified Amazon Connect instance. func (c *Client) CreateAgentStatus(ctx context.Context, params *CreateAgentStatusInput, optFns ...func(*Options)) (*CreateAgentStatusOutput, error) { if params == nil { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_CreateContactFlow.go b/service/connect/api_op_CreateContactFlow.go index 46b38f89d69..725a2da6b9d 100644 --- a/service/connect/api_op_CreateContactFlow.go +++ b/service/connect/api_op_CreateContactFlow.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates a flow for the specified Amazon Connect instance. +// +// You can also create and update flows using the [Amazon Connect Flow language]. +// +// [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{} @@ -31,9 +33,11 @@ func (c *Client) CreateContactFlow(ctx context.Context, params *CreateContactFlo type CreateContactFlowInput struct { - // The JSON string that represents the content of the flow. For an example, see - // Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) - // . Length Constraints: Minimum length of 1. Maximum length of 256000. + // The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language]. + // + // Length Constraints: Minimum length of 1. Maximum length of 256000. + // + // [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html // // This member is required. Content *string @@ -48,9 +52,10 @@ 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) - // in the Amazon Connect Administrator Guide. + // The type of the flow. For descriptions of the available types, see [Choose a flow type] in the + // Amazon Connect Administrator Guide. + // + // [Choose a flow type]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types // // This member is required. Type types.ContactFlowType diff --git a/service/connect/api_op_CreateContactFlowModule.go b/service/connect/api_op_CreateContactFlowModule.go index ac43a61ae51..51534a2040a 100644 --- a/service/connect/api_op_CreateContactFlowModule.go +++ b/service/connect/api_op_CreateContactFlowModule.go @@ -28,15 +28,17 @@ func (c *Client) CreateContactFlowModule(ctx context.Context, params *CreateCont type CreateContactFlowModuleInput struct { - // The JSON string that represents the content of the flow. For an example, see - // Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) - // . + // The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language]. + // + // [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html // // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -48,9 +50,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the flow module. diff --git a/service/connect/api_op_CreateEvaluationForm.go b/service/connect/api_op_CreateEvaluationForm.go index fd99c2e8303..944c933adf6 100644 --- a/service/connect/api_op_CreateEvaluationForm.go +++ b/service/connect/api_op_CreateEvaluationForm.go @@ -32,8 +32,10 @@ func (c *Client) CreateEvaluationForm(ctx context.Context, params *CreateEvaluat type CreateEvaluationFormInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -51,9 +53,9 @@ type CreateEvaluationFormInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the evaluation form. diff --git a/service/connect/api_op_CreateHoursOfOperation.go b/service/connect/api_op_CreateHoursOfOperation.go index 017d4a41962..fdc3fe84403 100644 --- a/service/connect/api_op_CreateHoursOfOperation.go +++ b/service/connect/api_op_CreateHoursOfOperation.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Creates hours of operation. func (c *Client) CreateHoursOfOperation(ctx context.Context, params *CreateHoursOfOperationInput, optFns ...func(*Options)) (*CreateHoursOfOperationOutput, error) { if params == nil { @@ -36,8 +37,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_CreateInstance.go b/service/connect/api_op_CreateInstance.go index 47585fa3605..1f0c8e72747 100644 --- a/service/connect/api_op_CreateInstance.go +++ b/service/connect/api_op_CreateInstance.go @@ -12,14 +12,17 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. -// Initiates an Amazon Connect instance with all the supported channels enabled. It -// does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) -// or Amazon Kinesis. It also does not allow for any configurations on features, -// such as Contact Lens for Amazon Connect. Amazon Connect enforces a limit on the -// total number of instances that you can create or delete in 30 days. If you -// exceed this limit, you will get an error message indicating there has been an -// excessive number of attempts at creating or deleting instances. You must wait 30 -// days before you can restart creating and deleting instances in your account. +// +// Initiates an Amazon Connect instance with all the supported channels enabled. +// It does not attach any storage, such as Amazon Simple Storage Service (Amazon +// S3) or Amazon Kinesis. It also does not allow for any configurations on +// features, such as Contact Lens for Amazon Connect. +// +// Amazon Connect enforces a limit on the total number of instances that you can +// create or delete in 30 days. If you exceed this limit, you will get an error +// message indicating there has been an excessive number of attempts at creating or +// deleting instances. You must wait 30 days before you can restart creating and +// deleting instances in your account. func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput, optFns ...func(*Options)) (*CreateInstanceOutput, error) { if params == nil { params = &CreateInstanceInput{} diff --git a/service/connect/api_op_CreateIntegrationAssociation.go b/service/connect/api_op_CreateIntegrationAssociation.go index b2fd51bc20b..55ed6ba47d8 100644 --- a/service/connect/api_op_CreateIntegrationAssociation.go +++ b/service/connect/api_op_CreateIntegrationAssociation.go @@ -30,15 +30,18 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string - // The Amazon Resource Name (ARN) of the integration. When integrating with Amazon - // Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same - // account. + // The Amazon Resource Name (ARN) of the integration. + // + // When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint + // instances must be in the same account. // // This member is required. IntegrationArn *string diff --git a/service/connect/api_op_CreateParticipant.go b/service/connect/api_op_CreateParticipant.go index 579f91e6903..a5ea14f3c01 100644 --- a/service/connect/api_op_CreateParticipant.go +++ b/service/connect/api_op_CreateParticipant.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a new participant into an on-going chat contact. For more information, see -// Customize chat flow experiences by integrating custom participants (https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html) +// Adds a new participant into an on-going chat contact. For more information, see [Customize chat flow experiences by integrating custom participants] // . +// +// [Customize chat flow experiences by integrating custom participants]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html func (c *Client) CreateParticipant(ctx context.Context, params *CreateParticipantInput, optFns ...func(*Options)) (*CreateParticipantOutput, error) { if params == nil { params = &CreateParticipantInput{} @@ -37,23 +38,28 @@ type CreateParticipantInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string - // Information identifying the participant. The only Valid value for - // ParticipantRole is CUSTOM_BOT . DisplayName is Required. + // Information identifying the participant. + // + // The only Valid value for ParticipantRole is CUSTOM_BOT . + // + // DisplayName is Required. // // This member is required. ParticipantDetails *types.ParticipantDetailsToAdd // 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_CreatePersistentContactAssociation.go b/service/connect/api_op_CreatePersistentContactAssociation.go index d0d254a9385..890430b13b8 100644 --- a/service/connect/api_op_CreatePersistentContactAssociation.go +++ b/service/connect/api_op_CreatePersistentContactAssociation.go @@ -12,8 +12,10 @@ import ( ) // Enables rehydration of chats for the lifespan of a contact. For more -// information about chat rehydration, see Enable persistent chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) -// in the Amazon Connect Administrator Guide. +// information about chat rehydration, see [Enable persistent chat]in the Amazon Connect Administrator +// Guide. +// +// [Enable persistent chat]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html func (c *Client) CreatePersistentContactAssociation(ctx context.Context, params *CreatePersistentContactAssociationInput, optFns ...func(*Options)) (*CreatePersistentContactAssociationOutput, error) { if params == nil { params = &CreatePersistentContactAssociationInput{} @@ -37,24 +39,31 @@ type CreatePersistentContactAssociationInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // The contactId chosen for rehydration depends on the type chosen. + // // - 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 what the most // recent chat contact on the past ended chat session and uses it to start a // persistent chat. + // // - FROM_SEGMENT : Rehydrates a chat from the specified past chat contact // provided in the sourceContactId field. + // // The actual contactId used for rehydration is provided in the response of this - // API. To illustrate how to use rehydration type, consider the following example: - // A customer starts a chat session. Agent a1 accepts the chat and a conversation + // API. + // + // To illustrate how to use rehydration type, consider the following example: A + // customer starts a chat session. Agent a1 accepts the chat and a conversation // starts between the customer and Agent a1. This first contact creates a contact // ID C1. Agent a1 then transfers the chat to Agent a2. This creates another // contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded @@ -62,24 +71,36 @@ type CreatePersistentContactAssociationInput struct { // C3. After the chat survey, the chat session ends. Later, the customer returns // and wants to resume their past chat session. At this point, the customer can // have following use cases: + // // - Use Case 1: The customer wants to continue the past chat session but they // want to hide the post chat survey. For this they will use the following // configuration: + // // - Configuration + // // - SourceContactId = "C2" + // // - RehydrationType = "FROM_SEGMENT" + // // - Expected behavior + // // - This starts a persistent chat session from the specified past ended contact // (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current // persistent chat session. Note that chat segment C3 is dropped from the // persistent chat session. + // // - Use Case 2: The customer wants to continue the past chat session and see // the transcript of the entire past engagement, including the post chat survey. // For this they will use the following configuration: + // // - Configuration + // // - SourceContactId = "C1" + // // - RehydrationType = "ENTIRE_PAST_SESSION" + // // - Expected behavior + // // - This starts a persistent chat session from the most recently ended chat // contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in // the current persistent chat session. @@ -94,9 +115,9 @@ type CreatePersistentContactAssociationInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_CreatePredefinedAttribute.go b/service/connect/api_op_CreatePredefinedAttribute.go index 26f5d733cb0..83718f2ce7b 100644 --- a/service/connect/api_op_CreatePredefinedAttribute.go +++ b/service/connect/api_op_CreatePredefinedAttribute.go @@ -35,12 +35,12 @@ type CreatePredefinedAttributeInput struct { // This member is required. InstanceId *string - // The name of the predefined attribute. + // The name of the predefined attribute. // // This member is required. Name *string - // The values of the predefined attribute. + // The values of the predefined attribute. // // This member is required. Values types.PredefinedAttributeValues diff --git a/service/connect/api_op_CreatePrompt.go b/service/connect/api_op_CreatePrompt.go index 10e6a3be593..6b6491ef7f7 100644 --- a/service/connect/api_op_CreatePrompt.go +++ b/service/connect/api_op_CreatePrompt.go @@ -11,8 +11,9 @@ import ( ) // Creates a prompt. For more information about prompts, such as supported file -// types and maximum length, see Create prompts (https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html) -// in the Amazon Connect Administrator's Guide. +// types and maximum length, see [Create prompts]in the Amazon Connect Administrator's Guide. +// +// [Create prompts]: https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html func (c *Client) CreatePrompt(ctx context.Context, params *CreatePromptInput, optFns ...func(*Options)) (*CreatePromptOutput, error) { if params == nil { params = &CreatePromptInput{} @@ -30,8 +31,10 @@ func (c *Client) CreatePrompt(ctx context.Context, params *CreatePromptInput, op type CreatePromptInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -42,8 +45,9 @@ type CreatePromptInput struct { Name *string // The URI for the S3 bucket where the prompt is stored. You can provide S3 - // pre-signed URLs returned by the GetPromptFile (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html) - // API instead of providing S3 URIs. + // pre-signed URLs returned by the [GetPromptFile]API instead of providing S3 URIs. + // + // [GetPromptFile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html // // This member is required. S3Uri *string diff --git a/service/connect/api_op_CreateQueue.go b/service/connect/api_op_CreateQueue.go index 80308298102..8c52fc3f521 100644 --- a/service/connect/api_op_CreateQueue.go +++ b/service/connect/api_op_CreateQueue.go @@ -12,7 +12,9 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Creates a new queue for the specified Amazon Connect instance. +// // - If the phone number is claimed to a traffic distribution group that was // created in the same Region as the Amazon Connect instance where you are calling // this API, then you can use a full phone number ARN or a UUID for @@ -22,15 +24,16 @@ import ( // 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 . +// // - Only use the phone number ARN format that doesn't contain instance in the // path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . -// This is the same ARN format that is returned when you call the -// ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) -// API. +// This is the same ARN format that is returned when you call the [ListPhoneNumbersV2]API. +// // - If you plan to use IAM policies to allow/deny access to this API for phone -// number resources claimed to a traffic distribution group, see Allow or Deny -// queue API actions for phone numbers in a replica Region (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region) -// . +// number resources claimed to a traffic distribution group, see [Allow or Deny queue API actions for phone numbers in a replica Region]. +// +// [ListPhoneNumbersV2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html +// [Allow or Deny queue API actions for phone numbers in a replica Region]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error) { if params == nil { params = &CreateQueueInput{} @@ -53,8 +56,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_CreateQuickConnect.go b/service/connect/api_op_CreateQuickConnect.go index 31c9997148e..2065f0f1eb6 100644 --- a/service/connect/api_op_CreateQuickConnect.go +++ b/service/connect/api_op_CreateQuickConnect.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_CreateRoutingProfile.go b/service/connect/api_op_CreateRoutingProfile.go index ba0bb829925..85b59a47d84 100644 --- a/service/connect/api_op_CreateRoutingProfile.go +++ b/service/connect/api_op_CreateRoutingProfile.go @@ -39,8 +39,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -61,12 +63,14 @@ type CreateRoutingProfileInput struct { AgentAvailabilityTimer types.AgentAvailabilityTimer // The inbound queues associated with the routing profile. If no queue is added, - // 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) - // . + // 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]. + // + // [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 b65e80ce6aa..af368f680b7 100644 --- a/service/connect/api_op_CreateRule.go +++ b/service/connect/api_op_CreateRule.go @@ -11,9 +11,11 @@ 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) -// to code conditions for the rule. +// Creates a rule for the specified Amazon Connect instance. +// +// Use the [Rules Function language] to code conditions for the rule. +// +// [Rules Function language]: https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { params = &CreateRuleInput{} @@ -41,8 +43,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -64,9 +68,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_CreateSecurityProfile.go b/service/connect/api_op_CreateSecurityProfile.go index 23345b86fb3..1c944f9ce6e 100644 --- a/service/connect/api_op_CreateSecurityProfile.go +++ b/service/connect/api_op_CreateSecurityProfile.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -60,8 +62,9 @@ type CreateSecurityProfileInput struct { HierarchyRestrictedResources []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]. + // + // [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_CreateTaskTemplate.go b/service/connect/api_op_CreateTaskTemplate.go index 4f0f489716b..81e4735cf86 100644 --- a/service/connect/api_op_CreateTaskTemplate.go +++ b/service/connect/api_op_CreateTaskTemplate.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -47,9 +49,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // Constraints that are applicable to the fields listed. diff --git a/service/connect/api_op_CreateTrafficDistributionGroup.go b/service/connect/api_op_CreateTrafficDistributionGroup.go index c2db28c3ced..9293019ef88 100644 --- a/service/connect/api_op_CreateTrafficDistributionGroup.go +++ b/service/connect/api_op_CreateTrafficDistributionGroup.go @@ -11,14 +11,18 @@ import ( ) // Creates a traffic distribution group given an Amazon Connect instance that has -// been replicated. The SignInConfig distribution is available only on a default -// TrafficDistributionGroup (see the IsDefault parameter in the -// TrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) -// data type). If you call UpdateTrafficDistribution with a modified SignInConfig -// and a non-default TrafficDistributionGroup , an InvalidRequestException is -// returned. 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) -// in the Amazon Connect Administrator Guide. +// been replicated. +// +// The SignInConfig distribution is available only on a default +// TrafficDistributionGroup (see the IsDefault parameter in the [TrafficDistributionGroup] data type). If +// you call UpdateTrafficDistribution with a modified SignInConfig and a +// non-default TrafficDistributionGroup , an InvalidRequestException is returned. +// +// For more information about creating traffic distribution groups, see [Set up traffic distribution groups] in the +// Amazon Connect Administrator Guide. +// +// [Set up traffic distribution groups]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html +// [TrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html func (c *Client) CreateTrafficDistributionGroup(ctx context.Context, params *CreateTrafficDistributionGroupInput, optFns ...func(*Options)) (*CreateTrafficDistributionGroupOutput, error) { if params == nil { params = &CreateTrafficDistributionGroupInput{} @@ -49,9 +53,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A description for the traffic distribution group. diff --git a/service/connect/api_op_CreateUseCase.go b/service/connect/api_op_CreateUseCase.go index 748d0c9ae22..810dbee5c18 100644 --- a/service/connect/api_op_CreateUseCase.go +++ b/service/connect/api_op_CreateUseCase.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_CreateUser.go b/service/connect/api_op_CreateUser.go index 18c4c728f3d..b37d9faade5 100644 --- a/service/connect/api_op_CreateUser.go +++ b/service/connect/api_op_CreateUser.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a user account for the specified Amazon Connect instance. Certain -// UserIdentityInfo (https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html) -// parameters are required in some situations. For example, Email is required if -// you are using SAML for identity management. FirstName and LastName are required -// if you are using Amazon Connect or SAML for identity management. For information -// about how to create users using the Amazon Connect admin website, see Add Users (https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) -// in the Amazon Connect Administrator Guide. +// Creates a user account for the specified Amazon Connect instance. +// +// Certain [UserIdentityInfo] parameters are required in some situations. For example, Email is +// required if you are using SAML for identity management. FirstName and LastName +// are required if you are using Amazon Connect or SAML for identity management. +// +// For information about how to create users using the Amazon Connect admin +// website, see [Add Users]in the Amazon Connect Administrator Guide. +// +// [Add Users]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html +// [UserIdentityInfo]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} @@ -35,8 +39,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -59,10 +65,14 @@ type CreateUserInput struct { // The user name for the account. For instances not using SAML for identity // management, the user name can include up to 20 characters. If you are using SAML // for identity management, the user name can include up to 64 characters from - // [a-zA-Z0-9_-.\@]+. Username can include @ only if used in an email format. For - // example: + // [a-zA-Z0-9_-.\@]+. + // + // Username can include @ only if used in an email format. For example: + // // - Correct: testuser + // // - Correct: testuser@example.com + // // - Incorrect: testuser@example // // This member is required. @@ -72,11 +82,12 @@ type CreateUserInput struct { // management. If Amazon Connect cannot access the directory, you can specify this // identifier to authenticate users. If you include the identifier, we assume that // Amazon Connect cannot access the directory. Otherwise, the identity information - // is used to authenticate users from your directory. This parameter is required if - // you are using an existing directory for identity management in Amazon Connect - // when Amazon Connect cannot access your directory to authenticate users. If you - // are using SAML for identity management and include this parameter, an error is - // returned. + // is used to authenticate users from your directory. + // + // This parameter is required if you are using an existing directory for identity + // management in Amazon Connect when Amazon Connect cannot access your directory to + // authenticate users. If you are using SAML for identity management and include + // this parameter, an error is returned. DirectoryUserId *string // The identifier of the hierarchy group for the user. diff --git a/service/connect/api_op_CreateUserHierarchyGroup.go b/service/connect/api_op_CreateUserHierarchyGroup.go index dc6b260ca44..948975fbfb4 100644 --- a/service/connect/api_op_CreateUserHierarchyGroup.go +++ b/service/connect/api_op_CreateUserHierarchyGroup.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_CreateView.go b/service/connect/api_op_CreateView.go index 598d02dff27..44194b8b6c6 100644 --- a/service/connect/api_op_CreateView.go +++ b/service/connect/api_op_CreateView.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new view with the possible status of SAVED or PUBLISHED . The views -// will have a unique name for each connect instance. It performs basic content -// validation if the status is SAVED or full content validation if the status is -// set to PUBLISHED . An error is returned if validation fails. It associates -// either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with -// the provided view content based on the status. The view is idempotent if -// ClientToken is provided. +// Creates a new view with the possible status of SAVED or PUBLISHED . +// +// The views will have a unique name for each connect instance. +// +// It performs basic content validation if the status is SAVED or full content +// validation if the status is set to PUBLISHED . An error is returned if +// validation fails. It associates either the $SAVED qualifier or both of the +// $SAVED and $LATEST qualifiers with the provided view content based on the +// status. The view is idempotent if ClientToken is provided. func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns ...func(*Options)) (*CreateViewOutput, error) { if params == nil { params = &CreateViewInput{} @@ -36,8 +38,9 @@ func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns type CreateViewInput struct { // View content containing all content necessary to render a view except for - // runtime input data. The total uncompressed content has a maximum file size of - // 400kB. + // runtime input data. + // + // The total uncompressed content has a maximum file size of 400kB. // // This member is required. Content *types.ViewInputContent diff --git a/service/connect/api_op_CreateViewVersion.go b/service/connect/api_op_CreateViewVersion.go index c309ad2fbc9..981fbb195b9 100644 --- a/service/connect/api_op_CreateViewVersion.go +++ b/service/connect/api_op_CreateViewVersion.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Publishes a new version of the view identifier. Versions are immutable and -// monotonically increasing. It returns the highest version if there is no change -// in content compared to that version. An error is displayed if the supplied -// ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias. +// Publishes a new version of the view identifier. +// +// Versions are immutable and monotonically increasing. +// +// It returns the highest version if there is no change in content compared to +// that version. An error is displayed if the supplied ViewContentSha256 is +// different from the ViewContentSha256 of the $LATEST alias. func (c *Client) CreateViewVersion(ctx context.Context, params *CreateViewVersionInput, optFns ...func(*Options)) (*CreateViewVersionOutput, error) { if params == nil { params = &CreateViewVersionInput{} diff --git a/service/connect/api_op_CreateVocabulary.go b/service/connect/api_op_CreateVocabulary.go index ce2c97edb02..247ed4ab8ab 100644 --- a/service/connect/api_op_CreateVocabulary.go +++ b/service/connect/api_op_CreateVocabulary.go @@ -35,21 +35,25 @@ 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 - // 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) - // . + // characters. The size limit is 50KB. For more information, see [Create a custom vocabulary using a table]. + // + // [Create a custom 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // 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?] + // + // [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html // // This member is required. LanguageCode types.VocabularyLanguageCode @@ -61,11 +65,11 @@ 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, - // subsequent requests return the previous response without creating a vocabulary - // again. + // field. For more information about idempotency, see [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. + // + // [Making retries safe with 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. For diff --git a/service/connect/api_op_DeactivateEvaluationForm.go b/service/connect/api_op_DeactivateEvaluationForm.go index a90a4dea36b..efabc442870 100644 --- a/service/connect/api_op_DeactivateEvaluationForm.go +++ b/service/connect/api_op_DeactivateEvaluationForm.go @@ -41,8 +41,10 @@ type DeactivateEvaluationFormInput struct { // This member is required. EvaluationFormVersion int32 - // The 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. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteAttachedFile.go b/service/connect/api_op_DeleteAttachedFile.go index f7b7b83f724..4924984e4e3 100644 --- a/service/connect/api_op_DeleteAttachedFile.go +++ b/service/connect/api_op_DeleteAttachedFile.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an attached file along with the underlying S3 Object. The attached file -// is permanently deleted if S3 bucket versioning is not enabled. +// Deletes an attached file along with the underlying S3 Object. +// +// The attached file is permanently deleted if S3 bucket versioning is not enabled. func (c *Client) DeleteAttachedFile(ctx context.Context, params *DeleteAttachedFileInput, optFns ...func(*Options)) (*DeleteAttachedFileOutput, error) { if params == nil { params = &DeleteAttachedFileInput{} @@ -30,8 +31,12 @@ func (c *Client) DeleteAttachedFile(ctx context.Context, params *DeleteAttachedF // Request to DeleteAttachedFile API type DeleteAttachedFileInput struct { - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html // // This member is required. AssociatedResourceArn *string diff --git a/service/connect/api_op_DeleteContactEvaluation.go b/service/connect/api_op_DeleteContactEvaluation.go index 8bf722ef7ce..ef4e81ef177 100644 --- a/service/connect/api_op_DeleteContactEvaluation.go +++ b/service/connect/api_op_DeleteContactEvaluation.go @@ -33,8 +33,10 @@ type DeleteContactEvaluationInput struct { // This member is required. EvaluationId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteContactFlow.go b/service/connect/api_op_DeleteContactFlow.go index 0fbfcfd2015..218c99d98e9 100644 --- a/service/connect/api_op_DeleteContactFlow.go +++ b/service/connect/api_op_DeleteContactFlow.go @@ -33,8 +33,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteContactFlowModule.go b/service/connect/api_op_DeleteContactFlowModule.go index bb9ea91447b..d089d6e0a6a 100644 --- a/service/connect/api_op_DeleteContactFlowModule.go +++ b/service/connect/api_op_DeleteContactFlowModule.go @@ -33,8 +33,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteEvaluationForm.go b/service/connect/api_op_DeleteEvaluationForm.go index f7542da841e..28548a32ba3 100644 --- a/service/connect/api_op_DeleteEvaluationForm.go +++ b/service/connect/api_op_DeleteEvaluationForm.go @@ -11,8 +11,10 @@ import ( ) // Deletes an evaluation form in the specified Amazon Connect instance. +// // - If the version property is provided, only the specified version of the // evaluation form is deleted. +// // - If no version is provided, then the full form (all versions) is deleted. func (c *Client) DeleteEvaluationForm(ctx context.Context, params *DeleteEvaluationFormInput, optFns ...func(*Options)) (*DeleteEvaluationFormOutput, error) { if params == nil { @@ -36,8 +38,10 @@ type DeleteEvaluationFormInput struct { // This member is required. EvaluationFormId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteHoursOfOperation.go b/service/connect/api_op_DeleteHoursOfOperation.go index 431d40fc321..d38d4963ade 100644 --- a/service/connect/api_op_DeleteHoursOfOperation.go +++ b/service/connect/api_op_DeleteHoursOfOperation.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Deletes an hours of operation. func (c *Client) DeleteHoursOfOperation(ctx context.Context, params *DeleteHoursOfOperationInput, optFns ...func(*Options)) (*DeleteHoursOfOperationOutput, error) { if params == nil { @@ -34,8 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteInstance.go b/service/connect/api_op_DeleteInstance.go index 47f15b6565d..02cd1e505cc 100644 --- a/service/connect/api_op_DeleteInstance.go +++ b/service/connect/api_op_DeleteInstance.go @@ -11,11 +11,14 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. -// Deletes the Amazon Connect instance. Amazon Connect enforces a limit on the -// total number of instances that you can create or delete in 30 days. If you -// exceed this limit, you will get an error message indicating there has been an -// excessive number of attempts at creating or deleting instances. You must wait 30 -// days before you can restart creating and deleting instances in your account. +// +// Deletes the Amazon Connect instance. +// +// Amazon Connect enforces a limit on the total number of instances that you can +// create or delete in 30 days. If you exceed this limit, you will get an error +// message indicating there has been an excessive number of attempts at creating or +// deleting instances. You must wait 30 days before you can restart creating and +// deleting instances in your account. func (c *Client) DeleteInstance(ctx context.Context, params *DeleteInstanceInput, optFns ...func(*Options)) (*DeleteInstanceOutput, error) { if params == nil { params = &DeleteInstanceInput{} @@ -33,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteIntegrationAssociation.go b/service/connect/api_op_DeleteIntegrationAssociation.go index e57bd4b1428..6acca01884d 100644 --- a/service/connect/api_op_DeleteIntegrationAssociation.go +++ b/service/connect/api_op_DeleteIntegrationAssociation.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeletePredefinedAttribute.go b/service/connect/api_op_DeletePredefinedAttribute.go index 31c043033ff..dbea9da0a3e 100644 --- a/service/connect/api_op_DeletePredefinedAttribute.go +++ b/service/connect/api_op_DeletePredefinedAttribute.go @@ -28,13 +28,13 @@ func (c *Client) DeletePredefinedAttribute(ctx context.Context, params *DeletePr type DeletePredefinedAttributeInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID in + // The identifier of the Amazon Connect instance. You can find the instance ID in // the Amazon Resource Name (ARN) of the instance. // // This member is required. InstanceId *string - // The name of the predefined attribute. + // The name of the predefined attribute. // // This member is required. Name *string diff --git a/service/connect/api_op_DeletePrompt.go b/service/connect/api_op_DeletePrompt.go index e375fe9bda8..27b811256ee 100644 --- a/service/connect/api_op_DeletePrompt.go +++ b/service/connect/api_op_DeletePrompt.go @@ -28,8 +28,10 @@ func (c *Client) DeletePrompt(ctx context.Context, params *DeletePromptInput, op type DeletePromptInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteQueue.go b/service/connect/api_op_DeleteQueue.go index e58ad16bebd..c013b7a51f5 100644 --- a/service/connect/api_op_DeleteQueue.go +++ b/service/connect/api_op_DeleteQueue.go @@ -28,8 +28,10 @@ func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optF type DeleteQueueInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteQuickConnect.go b/service/connect/api_op_DeleteQuickConnect.go index 87698a8c291..d6d778059c6 100644 --- a/service/connect/api_op_DeleteQuickConnect.go +++ b/service/connect/api_op_DeleteQuickConnect.go @@ -10,14 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a quick connect. After calling DeleteUser (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html) -// , it's important to call DeleteQuickConnect to delete any records related to -// the deleted users. This will help you: +// Deletes a quick connect. +// +// After calling [DeleteUser], it's important to call DeleteQuickConnect to delete any records +// related to the deleted users. This will help you: +// // - Avoid dangling resources that impact your service quotas. +// // - Remove deleted users so they don't appear to agents as transfer options. +// // - Avoid the disruption of other Amazon Connect processes, such as instance -// replication and syncing if you're using Amazon Connect Global Resiliency (https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html) -// . +// replication and syncing if you're using [Amazon Connect Global Resiliency]. +// +// [Amazon Connect Global Resiliency]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html +// [DeleteUser]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html func (c *Client) DeleteQuickConnect(ctx context.Context, params *DeleteQuickConnectInput, optFns ...func(*Options)) (*DeleteQuickConnectOutput, error) { if params == nil { params = &DeleteQuickConnectInput{} @@ -35,8 +41,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteRoutingProfile.go b/service/connect/api_op_DeleteRoutingProfile.go index 4af63002fcb..3dcfbb93f74 100644 --- a/service/connect/api_op_DeleteRoutingProfile.go +++ b/service/connect/api_op_DeleteRoutingProfile.go @@ -28,8 +28,10 @@ func (c *Client) DeleteRoutingProfile(ctx context.Context, params *DeleteRouting type DeleteRoutingProfileInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteRule.go b/service/connect/api_op_DeleteRule.go index 8777f19564b..8f39d7cb98f 100644 --- a/service/connect/api_op_DeleteRule.go +++ b/service/connect/api_op_DeleteRule.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteSecurityProfile.go b/service/connect/api_op_DeleteSecurityProfile.go index b8f304c6c17..eff5cc7dd93 100644 --- a/service/connect/api_op_DeleteSecurityProfile.go +++ b/service/connect/api_op_DeleteSecurityProfile.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteTaskTemplate.go b/service/connect/api_op_DeleteTaskTemplate.go index a503b493b4b..a0d0cad0256 100644 --- a/service/connect/api_op_DeleteTaskTemplate.go +++ b/service/connect/api_op_DeleteTaskTemplate.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteTrafficDistributionGroup.go b/service/connect/api_op_DeleteTrafficDistributionGroup.go index d74596c65f2..07c8b00fa3a 100644 --- a/service/connect/api_op_DeleteTrafficDistributionGroup.go +++ b/service/connect/api_op_DeleteTrafficDistributionGroup.go @@ -11,9 +11,12 @@ 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) -// in the Amazon Connect Administrator Guide. +// where the traffic distribution group is created. +// +// For more information about deleting traffic distribution groups, see [Delete traffic distribution groups] in the +// Amazon Connect Administrator Guide. +// +// [Delete traffic distribution groups]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html func (c *Client) DeleteTrafficDistributionGroup(ctx context.Context, params *DeleteTrafficDistributionGroupInput, optFns ...func(*Options)) (*DeleteTrafficDistributionGroupOutput, error) { if params == nil { params = &DeleteTrafficDistributionGroupInput{} diff --git a/service/connect/api_op_DeleteUseCase.go b/service/connect/api_op_DeleteUseCase.go index 956a41a22f5..3ba6155afc2 100644 --- a/service/connect/api_op_DeleteUseCase.go +++ b/service/connect/api_op_DeleteUseCase.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteUser.go b/service/connect/api_op_DeleteUser.go index 9e2c93a124c..5f0929a4ade 100644 --- a/service/connect/api_op_DeleteUser.go +++ b/service/connect/api_op_DeleteUser.go @@ -10,17 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. After calling DeleteUser, call -// DeleteQuickConnect (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html) -// to delete any records related to the deleted users. This will help you: +// 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]in the Amazon Connect Administrator Guide. +// +// After calling DeleteUser, call [DeleteQuickConnect] to delete any records related to the deleted +// users. This will help you: +// // - Avoid dangling resources that impact your service quotas. +// // - Remove deleted users so they don't appear to agents as transfer options. +// // - Avoid the disruption of other Amazon Connect processes, such as instance -// replication and syncing if you're using Amazon Connect Global Resiliency (https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html) -// . +// replication and syncing if you're using [Amazon Connect Global Resiliency]. +// +// [Delete Users from Your Amazon Connect Instance]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html +// [Amazon Connect Global Resiliency]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html +// [DeleteQuickConnect]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} @@ -38,8 +45,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteUserHierarchyGroup.go b/service/connect/api_op_DeleteUserHierarchyGroup.go index 15f6cda516f..e3be8cdcf06 100644 --- a/service/connect/api_op_DeleteUserHierarchyGroup.go +++ b/service/connect/api_op_DeleteUserHierarchyGroup.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DeleteVocabulary.go b/service/connect/api_op_DeleteVocabulary.go index 1e95c1ec5d4..de8249bb8dd 100644 --- a/service/connect/api_op_DeleteVocabulary.go +++ b/service/connect/api_op_DeleteVocabulary.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeAgentStatus.go b/service/connect/api_op_DescribeAgentStatus.go index bfa42f34018..c0f06f61c2f 100644 --- a/service/connect/api_op_DescribeAgentStatus.go +++ b/service/connect/api_op_DescribeAgentStatus.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Describes an agent status. func (c *Client) DescribeAgentStatus(ctx context.Context, params *DescribeAgentStatusInput, optFns ...func(*Options)) (*DescribeAgentStatusOutput, error) { if params == nil { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeContact.go b/service/connect/api_op_DescribeContact.go index b8b9e59adb8..3abc0fcee23 100644 --- a/service/connect/api_op_DescribeContact.go +++ b/service/connect/api_op_DescribeContact.go @@ -12,9 +12,13 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. -// Describes the specified contact. Contact information remains available in Amazon -// Connect for 24 months, and then it is deleted. Only data from November 12, 2021, -// and later is returned by this API. +// +// Describes the specified contact. +// +// Contact information remains available in Amazon Connect for 24 months, and then +// it is deleted. +// +// Only data from November 12, 2021, and later is returned by this API. func (c *Client) DescribeContact(ctx context.Context, params *DescribeContactInput, optFns ...func(*Options)) (*DescribeContactOutput, error) { if params == nil { params = &DescribeContactInput{} @@ -37,8 +41,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeContactEvaluation.go b/service/connect/api_op_DescribeContactEvaluation.go index 49fa4550104..d15bb4b146a 100644 --- a/service/connect/api_op_DescribeContactEvaluation.go +++ b/service/connect/api_op_DescribeContactEvaluation.go @@ -34,8 +34,10 @@ type DescribeContactEvaluationInput struct { // This member is required. EvaluationId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeContactFlow.go b/service/connect/api_op_DescribeContactFlow.go index 8d20262c96e..71829e8bc2e 100644 --- a/service/connect/api_op_DescribeContactFlow.go +++ b/service/connect/api_op_DescribeContactFlow.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Describes the specified flow. +// +// You can also create and update flows using the [Amazon Connect Flow language]. +// +// [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 3861d76497a..e50245775be 100644 --- a/service/connect/api_op_DescribeContactFlowModule.go +++ b/service/connect/api_op_DescribeContactFlowModule.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeEvaluationForm.go b/service/connect/api_op_DescribeEvaluationForm.go index 3db460cf63b..d01a225d857 100644 --- a/service/connect/api_op_DescribeEvaluationForm.go +++ b/service/connect/api_op_DescribeEvaluationForm.go @@ -36,8 +36,10 @@ type DescribeEvaluationFormInput struct { // This member is required. EvaluationFormId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeHoursOfOperation.go b/service/connect/api_op_DescribeHoursOfOperation.go index eba00240b2d..9a8d2916a70 100644 --- a/service/connect/api_op_DescribeHoursOfOperation.go +++ b/service/connect/api_op_DescribeHoursOfOperation.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Describes the hours of operation. func (c *Client) DescribeHoursOfOperation(ctx context.Context, params *DescribeHoursOfOperationInput, optFns ...func(*Options)) (*DescribeHoursOfOperationOutput, error) { if params == nil { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeInstance.go b/service/connect/api_op_DescribeInstance.go index bbc3e5d1157..79aa2f8d2b5 100644 --- a/service/connect/api_op_DescribeInstance.go +++ b/service/connect/api_op_DescribeInstance.go @@ -12,8 +12,10 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Returns the current state of the specified instance identifier. It tracks the // instance while it is being created and returns an error status, if applicable. +// // If an instance is not created successfully, the instance status reason field // returns details relevant to the reason. The instance in a failed state is // returned only for 24 hours after the CreateInstance API was invoked. @@ -34,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeInstanceAttribute.go b/service/connect/api_op_DescribeInstanceAttribute.go index 99d8fadf646..f2f33c64ae1 100644 --- a/service/connect/api_op_DescribeInstanceAttribute.go +++ b/service/connect/api_op_DescribeInstanceAttribute.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Describes the specified instance attribute. func (c *Client) DescribeInstanceAttribute(ctx context.Context, params *DescribeInstanceAttributeInput, optFns ...func(*Options)) (*DescribeInstanceAttributeOutput, error) { if params == nil { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeInstanceStorageConfig.go b/service/connect/api_op_DescribeInstanceStorageConfig.go index 277b25c1fc7..04481fccc19 100644 --- a/service/connect/api_op_DescribeInstanceStorageConfig.go +++ b/service/connect/api_op_DescribeInstanceStorageConfig.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Retrieves the current storage configurations for the specified resource type, // association ID, and instance ID. func (c *Client) DescribeInstanceStorageConfig(ctx context.Context, params *DescribeInstanceStorageConfigInput, optFns ...func(*Options)) (*DescribeInstanceStorageConfigOutput, error) { @@ -37,8 +38,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribePhoneNumber.go b/service/connect/api_op_DescribePhoneNumber.go index 073dbef6df2..94d09ca0ad0 100644 --- a/service/connect/api_op_DescribePhoneNumber.go +++ b/service/connect/api_op_DescribePhoneNumber.go @@ -12,14 +12,16 @@ import ( ) // Gets details and status of a phone number that’s claimed to your Amazon Connect -// instance or traffic distribution group. If the number is claimed to a traffic -// distribution group, and you are calling in the Amazon Web Services Region where -// the traffic distribution group was created, you can use either a phone number -// ARN or UUID value for the PhoneNumberId URI request parameter. However, if the -// 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 . +// instance or traffic distribution group. +// +// If the number is claimed to a traffic distribution group, and you are calling +// in the Amazon Web Services Region where the traffic distribution group was +// created, you can use either a phone number ARN or UUID value for the +// PhoneNumberId URI request parameter. However, if the 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 . 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_DescribePrompt.go b/service/connect/api_op_DescribePrompt.go index ebdbd496244..602ae2e3af3 100644 --- a/service/connect/api_op_DescribePrompt.go +++ b/service/connect/api_op_DescribePrompt.go @@ -29,8 +29,10 @@ func (c *Client) DescribePrompt(ctx context.Context, params *DescribePromptInput type DescribePromptInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeQueue.go b/service/connect/api_op_DescribeQueue.go index 7ac910d985b..39bcbdff0d4 100644 --- a/service/connect/api_op_DescribeQueue.go +++ b/service/connect/api_op_DescribeQueue.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Describes the specified queue. func (c *Client) DescribeQueue(ctx context.Context, params *DescribeQueueInput, optFns ...func(*Options)) (*DescribeQueueOutput, error) { if params == nil { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeQuickConnect.go b/service/connect/api_op_DescribeQuickConnect.go index 709890fed2c..c24503a7e85 100644 --- a/service/connect/api_op_DescribeQuickConnect.go +++ b/service/connect/api_op_DescribeQuickConnect.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeRoutingProfile.go b/service/connect/api_op_DescribeRoutingProfile.go index d7a220c9d29..5b5108f6b82 100644 --- a/service/connect/api_op_DescribeRoutingProfile.go +++ b/service/connect/api_op_DescribeRoutingProfile.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeRule.go b/service/connect/api_op_DescribeRule.go index 23788a7c3b6..22d23fa89f0 100644 --- a/service/connect/api_op_DescribeRule.go +++ b/service/connect/api_op_DescribeRule.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeSecurityProfile.go b/service/connect/api_op_DescribeSecurityProfile.go index e1aff41a9f5..8f664df18be 100644 --- a/service/connect/api_op_DescribeSecurityProfile.go +++ b/service/connect/api_op_DescribeSecurityProfile.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeUser.go b/service/connect/api_op_DescribeUser.go index dde6ea926f4..70f42e526ef 100644 --- a/service/connect/api_op_DescribeUser.go +++ b/service/connect/api_op_DescribeUser.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified user. 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. +// Describes the specified user. You can [find the instance ID in the Amazon Connect console] (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. +// +// [find the instance ID in the Amazon Connect console]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error) { if params == nil { params = &DescribeUserInput{} @@ -32,8 +33,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeUserHierarchyGroup.go b/service/connect/api_op_DescribeUserHierarchyGroup.go index 28d944255e6..fabd6726610 100644 --- a/service/connect/api_op_DescribeUserHierarchyGroup.go +++ b/service/connect/api_op_DescribeUserHierarchyGroup.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeUserHierarchyStructure.go b/service/connect/api_op_DescribeUserHierarchyStructure.go index 0a0077aa659..22a1626eec6 100644 --- a/service/connect/api_op_DescribeUserHierarchyStructure.go +++ b/service/connect/api_op_DescribeUserHierarchyStructure.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DescribeView.go b/service/connect/api_op_DescribeView.go index e078e4328d2..d191b68a931 100644 --- a/service/connect/api_op_DescribeView.go +++ b/service/connect/api_op_DescribeView.go @@ -12,13 +12,17 @@ import ( ) // Retrieves the view for the specified Amazon Connect instance and view -// identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED -// needs to be supplied if a view is unpublished. The view identifier can contain -// an optional qualifier, for example, :$SAVED , which is either an actual version -// number or an Amazon Connect managed qualifier $SAVED | $LATEST . If it is not -// supplied, then $LATEST is assumed for customer managed views and an error is -// returned if there is no published content available. Version 1 is assumed for -// Amazon Web Services managed views. +// identifier. +// +// The view identifier can be supplied as a ViewId or ARN. +// +// $SAVED needs to be supplied if a view is unpublished. +// +// The view identifier can contain an optional qualifier, for example, :$SAVED , +// which is either an actual version number or an Amazon Connect managed qualifier +// $SAVED | $LATEST . If it is not supplied, then $LATEST is assumed for customer +// managed views and an error is returned if there is no published content +// available. Version 1 is assumed for Amazon Web Services managed views. func (c *Client) DescribeView(ctx context.Context, params *DescribeViewInput, optFns ...func(*Options)) (*DescribeViewOutput, error) { if params == nil { params = &DescribeViewInput{} diff --git a/service/connect/api_op_DescribeVocabulary.go b/service/connect/api_op_DescribeVocabulary.go index 20b880798af..5260d9ee4f8 100644 --- a/service/connect/api_op_DescribeVocabulary.go +++ b/service/connect/api_op_DescribeVocabulary.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateAnalyticsDataSet.go b/service/connect/api_op_DisassociateAnalyticsDataSet.go index e0e520f9fc6..de00e4b2148 100644 --- a/service/connect/api_op_DisassociateAnalyticsDataSet.go +++ b/service/connect/api_op_DisassociateAnalyticsDataSet.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Removes the dataset ID associated with a given Amazon Connect instance. func (c *Client) DisassociateAnalyticsDataSet(ctx context.Context, params *DisassociateAnalyticsDataSetInput, optFns ...func(*Options)) (*DisassociateAnalyticsDataSetOutput, error) { if params == nil { @@ -34,8 +35,10 @@ type DisassociateAnalyticsDataSetInput struct { // This member is required. DataSetId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateApprovedOrigin.go b/service/connect/api_op_DisassociateApprovedOrigin.go index 61f9a1fa8e0..bfc686e3faa 100644 --- a/service/connect/api_op_DisassociateApprovedOrigin.go +++ b/service/connect/api_op_DisassociateApprovedOrigin.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Revokes access to integrated applications from Amazon Connect. func (c *Client) DisassociateApprovedOrigin(ctx context.Context, params *DisassociateApprovedOriginInput, optFns ...func(*Options)) (*DisassociateApprovedOriginOutput, error) { if params == nil { @@ -29,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateBot.go b/service/connect/api_op_DisassociateBot.go index d23a442a4f0..c80b203d561 100644 --- a/service/connect/api_op_DisassociateBot.go +++ b/service/connect/api_op_DisassociateBot.go @@ -12,8 +12,9 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. -// Revokes authorization from the specified instance to access the specified Amazon -// Lex or Amazon Lex V2 bot. +// +// Revokes authorization from the specified instance to access the specified +// Amazon Lex or Amazon Lex V2 bot. func (c *Client) DisassociateBot(ctx context.Context, params *DisassociateBotInput, optFns ...func(*Options)) (*DisassociateBotOutput, error) { if params == nil { params = &DisassociateBotInput{} @@ -31,8 +32,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateFlow.go b/service/connect/api_op_DisassociateFlow.go index 8cec697f8c4..6c14e2076e2 100644 --- a/service/connect/api_op_DisassociateFlow.go +++ b/service/connect/api_op_DisassociateFlow.go @@ -29,8 +29,10 @@ func (c *Client) DisassociateFlow(ctx context.Context, params *DisassociateFlowI type DisassociateFlowInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateInstanceStorageConfig.go b/service/connect/api_op_DisassociateInstanceStorageConfig.go index 9d23076f994..52f8cf510b0 100644 --- a/service/connect/api_op_DisassociateInstanceStorageConfig.go +++ b/service/connect/api_op_DisassociateInstanceStorageConfig.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Removes the storage type configurations for the specified resource type and // association ID. func (c *Client) DisassociateInstanceStorageConfig(ctx context.Context, params *DisassociateInstanceStorageConfigInput, optFns ...func(*Options)) (*DisassociateInstanceStorageConfigOutput, error) { @@ -37,8 +38,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateLambdaFunction.go b/service/connect/api_op_DisassociateLambdaFunction.go index b39e6803706..a434ea42420 100644 --- a/service/connect/api_op_DisassociateLambdaFunction.go +++ b/service/connect/api_op_DisassociateLambdaFunction.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Remove the Lambda function from the dropdown options available in the relevant // flow blocks. func (c *Client) DisassociateLambdaFunction(ctx context.Context, params *DisassociateLambdaFunctionInput, optFns ...func(*Options)) (*DisassociateLambdaFunctionOutput, error) { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance.. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance.. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateLexBot.go b/service/connect/api_op_DisassociateLexBot.go index cf0a9467ae6..27555dd532c 100644 --- a/service/connect/api_op_DisassociateLexBot.go +++ b/service/connect/api_op_DisassociateLexBot.go @@ -11,8 +11,9 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. -// Revokes authorization from the specified instance to access the specified Amazon -// Lex bot. +// +// Revokes authorization from the specified instance to access the specified +// Amazon Lex bot. func (c *Client) DisassociateLexBot(ctx context.Context, params *DisassociateLexBotInput, optFns ...func(*Options)) (*DisassociateLexBotOutput, error) { if params == nil { params = &DisassociateLexBotInput{} @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociatePhoneNumberContactFlow.go b/service/connect/api_op_DisassociatePhoneNumberContactFlow.go index aa4ede52fc6..2a36ba33a80 100644 --- a/service/connect/api_op_DisassociatePhoneNumberContactFlow.go +++ b/service/connect/api_op_DisassociatePhoneNumberContactFlow.go @@ -11,14 +11,16 @@ import ( ) // Removes the flow association from a phone number claimed to your Amazon Connect -// instance. If the number is claimed to a traffic 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 PhoneNumberId URI request 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 . +// instance. +// +// If the number is claimed to a traffic 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 PhoneNumberId URI request 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 . func (c *Client) DisassociatePhoneNumberContactFlow(ctx context.Context, params *DisassociatePhoneNumberContactFlowInput, optFns ...func(*Options)) (*DisassociatePhoneNumberContactFlowOutput, error) { if params == nil { params = &DisassociatePhoneNumberContactFlowInput{} @@ -36,8 +38,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateQueueQuickConnects.go b/service/connect/api_op_DisassociateQueueQuickConnects.go index e03dca88297..5352a288084 100644 --- a/service/connect/api_op_DisassociateQueueQuickConnects.go +++ b/service/connect/api_op_DisassociateQueueQuickConnects.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Disassociates a set of quick connects from a queue. func (c *Client) DisassociateQueueQuickConnects(ctx context.Context, params *DisassociateQueueQuickConnectsInput, optFns ...func(*Options)) (*DisassociateQueueQuickConnectsOutput, error) { if params == nil { @@ -29,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateRoutingProfileQueues.go b/service/connect/api_op_DisassociateRoutingProfileQueues.go index a791d758bb3..40a88ab39a8 100644 --- a/service/connect/api_op_DisassociateRoutingProfileQueues.go +++ b/service/connect/api_op_DisassociateRoutingProfileQueues.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateSecurityKey.go b/service/connect/api_op_DisassociateSecurityKey.go index 43deb4d3689..324f774369f 100644 --- a/service/connect/api_op_DisassociateSecurityKey.go +++ b/service/connect/api_op_DisassociateSecurityKey.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Deletes the specified security key. func (c *Client) DisassociateSecurityKey(ctx context.Context, params *DisassociateSecurityKeyInput, optFns ...func(*Options)) (*DisassociateSecurityKeyOutput, error) { if params == nil { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DisassociateTrafficDistributionGroupUser.go b/service/connect/api_op_DisassociateTrafficDistributionGroupUser.go index 828b34b9729..3d3ee0b10d2 100644 --- a/service/connect/api_op_DisassociateTrafficDistributionGroupUser.go +++ b/service/connect/api_op_DisassociateTrafficDistributionGroupUser.go @@ -28,8 +28,10 @@ func (c *Client) DisassociateTrafficDistributionGroupUser(ctx context.Context, p type DisassociateTrafficDistributionGroupUserInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_DismissUserContact.go b/service/connect/api_op_DismissUserContact.go index ba030c47d7b..12b28a75e35 100644 --- a/service/connect/api_op_DismissUserContact.go +++ b/service/connect/api_op_DismissUserContact.go @@ -12,9 +12,10 @@ 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] // . +// +// [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_GetAttachedFile.go b/service/connect/api_op_GetAttachedFile.go index 24160bf75a0..8b56d390330 100644 --- a/service/connect/api_op_GetAttachedFile.go +++ b/service/connect/api_op_GetAttachedFile.go @@ -32,8 +32,12 @@ func (c *Client) GetAttachedFile(ctx context.Context, params *GetAttachedFileInp // Request to GetAttachedFile API. type GetAttachedFileInput struct { - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html // // This member is required. AssociatedResourceArn *string @@ -62,8 +66,12 @@ type GetAttachedFileOutput struct { // This member is required. FileSizeInBytes *int64 - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html AssociatedResourceArn *string // Represents the identity that created the file. diff --git a/service/connect/api_op_GetCurrentMetricData.go b/service/connect/api_op_GetCurrentMetricData.go index 0e90edaa5f8..be1c7374fbc 100644 --- a/service/connect/api_op_GetCurrentMetricData.go +++ b/service/connect/api_op_GetCurrentMetricData.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Connect Administrator Guide. +// Gets the real-time metric data from the specified Amazon Connect instance. +// +// For a description of each metric, see [Real-time Metrics Definitions] in the Amazon Connect Administrator +// Guide. +// +// [Real-time Metrics Definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html func (c *Client) GetCurrentMetricData(ctx context.Context, params *GetCurrentMetricDataInput, optFns ...func(*Options)) (*GetCurrentMetricDataOutput, error) { if params == nil { params = &GetCurrentMetricDataInput{} @@ -33,56 +36,123 @@ func (c *Client) GetCurrentMetricData(ctx context.Context, params *GetCurrentMet 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) - // 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) - // 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) - // 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. + // following metrics are available. For a description of all the metrics, see [Real-time Metrics Definitions]in + // the Amazon Connect Administrator Guide. + // + // AGENTS_AFTER_CONTACT_WORK Unit: COUNT + // + // Name in real-time metrics report: [ACW] + // + // AGENTS_AVAILABLE Unit: COUNT + // + // Name in real-time metrics report: [Available] + // + // AGENTS_ERROR Unit: COUNT + // + // Name in real-time metrics report: [Error] + // + // AGENTS_NON_PRODUCTIVE Unit: COUNT + // + // Name in real-time metrics report: [NPT (Non-Productive Time)] + // + // AGENTS_ON_CALL Unit: COUNT + // + // Name in real-time metrics report: [On contact] + // + // AGENTS_ON_CONTACT Unit: COUNT + // + // Name in real-time metrics report: [On contact] + // + // AGENTS_ONLINE Unit: COUNT + // + // Name in real-time metrics report: [Online] + // + // AGENTS_STAFFED Unit: COUNT + // + // Name in real-time metrics report: [Staffed] + // + // CONTACTS_IN_QUEUE Unit: COUNT + // + // Name in real-time metrics report: [In queue] + // + // CONTACTS_SCHEDULED Unit: COUNT + // + // Name in real-time metrics report: [Scheduled] + // + // 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. + // // When the filter RoutingStepExpression is used, this metric is still calculated // from enqueue time. For example, if a contact that has been queued under for 10 // seconds has expired and becomes active, then OLDEST_CONTACT_AGE for this queue - // will be counted starting from 10, not 0. 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) + // will be counted starting from 10, not 0. + // + // Name in real-time metrics report: [Oldest] + // + // SLOTS_ACTIVE Unit: COUNT + // + // Name in real-time metrics report: [Active] + // + // SLOTS_AVAILABLE Unit: COUNT + // + // Name in real-time metrics report: [Availability] + // + // [Availability]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time + // [Staffed]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time + // [NPT (Non-Productive Time)]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time + // [Real-time Metrics Definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html + // [Error]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time + // [Scheduled]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time + // [Oldest]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time + // [On contact]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time + // [Active]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time + // [ACW]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time + // [Available]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time + // [In queue]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time + // [Online]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-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.) + // // - RoutingStepExpressions: 50 + // // 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. When using the RoutingStepExpression filter, - // you need to pass exactly one QueueId . The filter is also case sensitive so when - // using the RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is - // required. Currently tagging is only supported on the resources that are passed - // in the filter. + // resource ARNs in the same request. + // + // When using the RoutingStepExpression filter, you need to pass exactly one + // QueueId . The filter is also case sensitive so when using the + // RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is required. + // + // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -90,12 +160,16 @@ type GetCurrentMetricDataInput struct { // 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. + // // - When using the RoutingStepExpression filter, group by // ROUTING_STEP_EXPRESSION is required. Groupings []types.Grouping @@ -104,15 +178,19 @@ type GetCurrentMetricDataInput struct { MaxResults *int32 // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. The token - // expires after 5 minutes from the time it is created. Subsequent requests that - // use the token must use the same request parameters as the request that generated - // the token. + // response in the next request to retrieve the next set of results. + // + // The token expires after 5 minutes from the time it is created. Subsequent + // requests that use the token must use the same request parameters as the request + // that generated the token. 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: + // 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 @@ -131,6 +209,7 @@ type GetCurrentMetricDataOutput struct { MetricResults []types.CurrentMetricResult // If there are additional results, this is the token for the next set of results. + // // The token expires after 5 minutes from the time it is created. Subsequent // requests that use the token must use the same request parameters as the request // that generated the token. diff --git a/service/connect/api_op_GetCurrentUserData.go b/service/connect/api_op_GetCurrentUserData.go index acc05142762..7faaf10195e 100644 --- a/service/connect/api_op_GetCurrentUserData.go +++ b/service/connect/api_op_GetCurrentUserData.go @@ -31,21 +31,31 @@ 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. + // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_GetFederationToken.go b/service/connect/api_op_GetFederationToken.go index c6e4e821451..49c28806aad 100644 --- a/service/connect/api_op_GetFederationToken.go +++ b/service/connect/api_op_GetFederationToken.go @@ -13,13 +13,17 @@ import ( // Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The // token is for the Amazon Connect user which corresponds to the IAM credentials -// that were used to invoke this action. For more information about how SAML -// sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect -// in the Amazon Connect Administrator Guide. (https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html) +// that were used to invoke this action. +// +// For more information about how SAML sign-in works in Amazon Connect, see [Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.] +// // This API doesn't support root users. If you try to invoke GetFederationToken // with root credentials, an error message similar to the following one appears: -// Provided identity: Principal: .... User: .... cannot be used for federation with -// Amazon Connect +// +// Provided identity: Principal: .... User: .... cannot be used for federation +// with Amazon Connect +// +// [Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.]: https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTokenInput, optFns ...func(*Options)) (*GetFederationTokenOutput, error) { if params == nil { params = &GetFederationTokenInput{} @@ -37,8 +41,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_GetFlowAssociation.go b/service/connect/api_op_GetFlowAssociation.go index 4e713892f28..545c215049c 100644 --- a/service/connect/api_op_GetFlowAssociation.go +++ b/service/connect/api_op_GetFlowAssociation.go @@ -29,8 +29,10 @@ func (c *Client) GetFlowAssociation(ctx context.Context, params *GetFlowAssociat type GetFlowAssociationInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_GetMetricData.go b/service/connect/api_op_GetMetricData.go index edb5e538599..46cd37b2b55 100644 --- a/service/connect/api_op_GetMetricData.go +++ b/service/connect/api_op_GetMetricData.go @@ -12,16 +12,21 @@ import ( "time" ) -// 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) -// in the Amazon Connect Administrator Guide. We recommend using the -// GetMetricDataV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) -// API. It provides more flexibility, features, and the ability to query longer -// time ranges than GetMetricData . Use it to retrieve historical agent and contact -// metrics for the last 3 months, at varying intervals. You can also use it to -// build custom dashboards to measure historical queue and agent performance. For -// example, you can track the number of incoming contacts for the last 7 days, with -// data split by day, to see how contact volume changed per day of the week. +// Gets historical metric data from the specified Amazon Connect instance. +// +// For a description of each historical metric, see [Historical Metrics Definitions] in the Amazon Connect +// Administrator Guide. +// +// We recommend using the [GetMetricDataV2] API. It provides more flexibility, features, and the +// ability to query longer time ranges than GetMetricData . Use it to retrieve +// historical agent and contact metrics for the last 3 months, at varying +// intervals. You can also use it to build custom dashboards to measure historical +// queue and agent performance. For example, you can track the number of incoming +// contacts for the last 7 days, with data split by day, to see how contact volume +// changed per day of the week. +// +// [GetMetricDataV2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html +// [Historical Metrics Definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, optFns ...func(*Options)) (*GetMetricDataOutput, error) { if params == nil { params = &GetMetricDataInput{} @@ -42,8 +47,9 @@ 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. + // 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 @@ -52,61 +58,156 @@ 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. + // // RoutingStepExpression is not a valid filter for GetMetricData and we recommend - // switching to GetMetricDataV2 for more up-to-date features. To filter by Queues , - // enter the queue ID/ARN, not the name of the queue. + // switching to GetMetricDataV2 for more up-to-date features. + // + // To filter by 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) - // 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: - // SECONDS Statistic: AVG API_CONTACTS_HANDLED Unit: COUNT Statistic: SUM - // CALLBACK_CONTACTS_HANDLED Unit: COUNT Statistic: SUM CONTACTS_ABANDONED Unit: - // COUNT Statistic: SUM CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT Statistic: SUM - // CONTACTS_CONSULTED Unit: COUNT Statistic: SUM CONTACTS_HANDLED Unit: COUNT - // Statistic: SUM CONTACTS_HANDLED_INCOMING Unit: COUNT Statistic: SUM - // CONTACTS_HANDLED_OUTBOUND Unit: COUNT Statistic: SUM CONTACTS_HOLD_ABANDONS - // Unit: COUNT Statistic: SUM CONTACTS_MISSED Unit: COUNT Statistic: SUM - // CONTACTS_QUEUED Unit: COUNT Statistic: SUM CONTACTS_TRANSFERRED_IN Unit: COUNT - // Statistic: SUM CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT Statistic: SUM - // CONTACTS_TRANSFERRED_OUT Unit: COUNT Statistic: SUM - // CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT Statistic: SUM HANDLE_TIME Unit: - // SECONDS Statistic: AVG HOLD_TIME Unit: SECONDS Statistic: AVG - // INTERACTION_AND_HOLD_TIME Unit: SECONDS Statistic: AVG INTERACTION_TIME Unit: - // 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"). + // metric, see [Historical Metrics Definitions]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: SECONDS + // + // Statistic: AVG + // + // API_CONTACTS_HANDLED Unit: COUNT + // + // Statistic: SUM + // + // CALLBACK_CONTACTS_HANDLED Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_ABANDONED Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_AGENT_HUNG_UP_FIRST Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_CONSULTED Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_HANDLED Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_HANDLED_INCOMING Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_HANDLED_OUTBOUND Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_HOLD_ABANDONS Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_MISSED Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_QUEUED Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_TRANSFERRED_IN Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_TRANSFERRED_IN_FROM_QUEUE Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_TRANSFERRED_OUT Unit: COUNT + // + // Statistic: SUM + // + // CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: COUNT + // + // Statistic: SUM + // + // HANDLE_TIME Unit: SECONDS + // + // Statistic: AVG + // + // HOLD_TIME Unit: SECONDS + // + // Statistic: AVG + // + // INTERACTION_AND_HOLD_TIME Unit: SECONDS + // + // Statistic: AVG + // + // INTERACTION_TIME Unit: 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"). + // + // [Historical Metrics Definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html // // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // The timestamp, in UNIX Epoch time format, at which to start the reporting // interval for the retrieval of historical metrics data. The time must be - // specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15. The start - // time cannot be earlier than 24 hours before the time of the request. Historical - // metrics are available only for 24 hours. + // specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15. + // + // The start time cannot be earlier than 24 hours before the time of the request. + // Historical metrics are available only for 24 hours. // // This member is required. StartTime *time.Time // The grouping applied to the metrics returned. For example, when results are // grouped by queue, the metrics returned are grouped by queue. The values returned - // apply to the metrics for each queue rather than aggregated for all queues. If no - // grouping is specified, a summary of metrics for all queues is returned. + // apply to the metrics for each queue rather than aggregated for all queues. + // + // If no grouping is specified, a summary of metrics for all queues is returned. + // // RoutingStepExpression is not a valid filter for GetMetricData and we recommend // switching to GetMetricDataV2 for more up-to-date features. Groupings []types.Grouping @@ -123,11 +224,13 @@ 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. + // // The token expires after 5 minutes from the time it is created. Subsequent // requests that use the token must use the same request parameters as the request // that generated the token. diff --git a/service/connect/api_op_GetMetricDataV2.go b/service/connect/api_op_GetMetricDataV2.go index 49a67944679..78f3f60f8fc 100644 --- a/service/connect/api_op_GetMetricDataV2.go +++ b/service/connect/api_op_GetMetricDataV2.go @@ -12,15 +12,20 @@ import ( "time" ) -// 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 -// 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 3 months, at varying 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) -// in the Amazon Connect Administrator's Guide. +// Gets metric data from the specified Amazon Connect instance. +// +// GetMetricDataV2 offers more features than [GetMetricData], 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 3 months, +// at varying intervals. +// +// For a description of the historical metrics that are supported by +// GetMetricDataV2 and GetMetricData , see [Historical metrics definitions] in the Amazon Connect Administrator's +// Guide. +// +// [Historical metrics definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html +// [GetMetricData]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html func (c *Client) GetMetricDataV2(ctx context.Context, params *GetMetricDataV2Input, optFns ...func(*Options)) (*GetMetricDataV2Output, error) { if params == nil { params = &GetMetricDataV2Input{} @@ -47,304 +52,794 @@ type GetMetricDataV2Input struct { // The filters to apply to returned metrics. You can filter on the following // resources: + // // - Queues + // // - Routing profiles + // // - Agents + // // - Channels + // // - User hierarchy groups + // // - Feature + // // - Routing step expression + // // 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: + // user hierarchy groups. + // + // To filter by phone number, see [Create a historical metrics report] 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 | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS | // contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION + // // - Filter values: A maximum of 100 filter values are supported in a single // request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter // key. They do not count towards limitation of 100 filter values. For example, a // GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing // profiles for a total of 100 filter values, along with 3 channel filters. - // contact_lens_conversational_analytics is a valid filterValue for the FEATURE + // + // contact_lens_conversational_analytics is a valid filterValue for the FEATURE // filter key. It is available only to contacts analyzed by Contact Lens - // conversational analytics. connect:Chat , connect:SMS , connect:Telephony , and - // connect:WebRTC are valid filterValue examples (not exhaustive) for the - // contact/segmentAttributes/connect:Subtype filter key. ROUTING_STEP_EXPRESSION - // is a valid filter key with a filter value up to 3000 length. This filter is case - // and order sensitive. JSON string fields must be sorted in ascending order and - // JSON array order should be kept as is. + // conversational analytics. + // + // connect:Chat , connect:SMS , connect:Telephony , and connect:WebRTC are valid + // filterValue examples (not exhaustive) for the + // contact/segmentAttributes/connect:Subtype filter key. + // + // ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 + // length. This filter is case and order sensitive. JSON string fields must be + // sorted in ascending order and JSON array order should be kept as is. + // + // [Create a historical metrics report]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html // // 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) - // in the Amazon Connect Administrator's Guide. ABANDONMENT_RATE Unit: Percent - // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: - // Abandonment rate (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical) - // 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) - // is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy UI name: Adherent time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherent-time-historical) - // AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-answer-rate-historical) - // AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#non-adherent-time) - // AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-non-response) - // AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this - // metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent - // non-response without customer abandons (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-nonresponse-no-abandon-historical) - // AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, - // Agent, Agent Hierarchy UI name: Occupancy (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#occupancy-historical) + // each metric, see [Historical metrics definitions]in the Amazon Connect Administrator's Guide. + // + // ABANDONMENT_RATE Unit: Percent + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Abandonment rate] + // + // AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services + // Regions where [Forecasting, capacity planning, and scheduling]is available. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Adherent time] + // + // AGENT_ANSWER_RATE Unit: Percent + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Agent answer rate] + // + // AGENT_NON_ADHERENT_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Non-adherent time] + // + // AGENT_NON_RESPONSE Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Agent non-response] + // + // AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // Data for this metric is available starting from October 1, 2023 0:00:00 GMT. + // + // UI name: [Agent non-response without customer abandons] + // + // AGENT_OCCUPANCY Unit: Percentage + // + // Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy + // + // UI name: [Occupancy] + // // 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) - // is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy UI name: Adherence (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherence-historical) + // Regions where [Forecasting, capacity planning, and scheduling]is available. + // + // Unit: Percent + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Adherence] + // // 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) - // is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy UI name: Scheduled time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#scheduled-time-historical) - // AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy, Feature, - // contact/segmentAttributes/connect:Subtype UI name: Average queue abandon time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical) - // AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Average active time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical) - // AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: - // INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, - // Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI - // name: Average after contact work time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical) - // Feature is a valid filter but not a valid grouping. 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 Hierarchy UI name: Average agent API connecting time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-avg-agent-api-connecting-time) + // Regions where [Forecasting, capacity planning, and scheduling]is available. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Scheduled time] + // + // AVG_ABANDON_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average queue abandon time] + // + // AVG_ACTIVE_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Average active time] + // + // AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds + // + // Valid metric filter key: INITIATION_METHOD + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average after contact work time] + // + // Feature is a valid filter but not a valid grouping. + // + // 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 + // Hierarchy + // + // UI name: [Average agent API connecting time] + // // The Negate key in Metric Level Filters is not applicable for this metric. - // AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Average agent pause time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical) - // AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN - // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average - // contacts per case (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contacts-case-historical) - // AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN - // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average - // case resolution time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical) - // AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy, Feature, - // contact/segmentAttributes/connect:Subtype UI name: Average contact duration (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical) - // Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION - // Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, - // Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI - // name: Average conversation duration (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical) + // + // AVG_AGENT_PAUSE_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Average agent pause time] + // + // AVG_CASE_RELATED_CONTACTS Unit: Count + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Average contacts per case] + // + // AVG_CASE_RESOLUTION_TIME Unit: Seconds + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Average case resolution time] + // + // AVG_CONTACT_DURATION Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average contact duration] + // + // Feature is a valid filter but not a valid grouping. + // + // AVG_CONVERSATION_DURATION Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average conversation duration] + // // AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by - // Contact Lens conversational analytics. Unit: Seconds Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average agent greeting time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical) - // AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy, Feature, - // contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: - // Average handle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical) - // Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds - // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average - // customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical) - // Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME_ALL_CONTACTS - // Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, - // Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: - // Average customer hold time all contacts (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical) - // AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy, Feature, - // contact/segmentAttributes/connect:Subtype UI name: Average holds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical) + // Contact Lens conversational analytics. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average agent greeting time] + // + // AVG_HANDLE_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, + // RoutingStepExpression + // + // UI name: [Average handle time] + // + // Feature is a valid filter but not a valid grouping. + // + // AVG_HOLD_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average customer hold time] + // // Feature is a valid filter but not a valid grouping. - // AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average agent interaction - // and customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical) - // AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD + // + // AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average customer hold time all contacts] + // + // AVG_HOLDS Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average holds] + // + // Feature is a valid filter but not a valid grouping. + // + // AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average agent interaction and customer hold time] + // + // AVG_INTERACTION_TIME Unit: Seconds + // + // Valid metric filter key: INITIATION_METHOD + // // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, - // contact/segmentAttributes/connect:Subtype UI name: Average agent interaction - // time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical) - // Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This - // metric is available only for contacts analyzed by Contact Lens conversational - // analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI - // name: Average agent interruptions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical) + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Average agent interaction time] + // + // Feature is a valid filter but not a valid grouping. + // + // AVG_INTERRUPTIONS_AGENT This metric is available only for contacts analyzed by + // Contact Lens conversational analytics. + // + // Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average agent interruptions] + // // AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed - // by Contact Lens conversational analytics. Unit: Seconds Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average agent interruption - // time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical) - // AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact - // Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average non-talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical) - // AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: - // Average queue answer time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical) - // Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit: - // Seconds Valid groupings and filters: Queue, Channel, Routing Profile, - // contact/segmentAttributes/connect:Subtype UI name: Average resolution time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical) + // by Contact Lens conversational analytics. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average agent interruption time] + // + // AVG_NON_TALK_TIME This metric is available only for contacts analyzed by + // Contact Lens conversational analytics. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average non-talk time] + // + // AVG_QUEUE_ANSWER_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Average queue answer time] + // + // Feature is a valid filter but not a valid grouping. + // + // AVG_RESOLUTION_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Average resolution time] + // // AVG_TALK_TIME This metric is available only for contacts analyzed by Contact - // Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical) + // Lens conversational analytics. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average talk time] + // // AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by - // Contact Lens conversational analytics. Unit: Seconds Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average agent talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical) + // Contact Lens conversational analytics. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average agent talk time] + // // AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by - // Contact Lens conversational analytics. Unit: Seconds Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Average customer talk time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical) - // CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings - // and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##cases-created-historical) - // CONTACTS_ABANDONED Unit: Count Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: - // Contact abandoned (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical) - // CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid - // groupings and filters: Queue, Channel, Routing Profile, Feature, - // contact/segmentAttributes/connect:Subtype UI name: Contacts created (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical) - // Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count - // Valid metric filter key: INITIATION_METHOD , DISCONNECT_REASON Valid groupings - // and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, - // contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: API - // contacts handled (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical) + // Contact Lens conversational analytics. + // + // Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Average customer talk time] + // + // CASES_CREATED Unit: Count + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Cases created] + // + // CONTACTS_ABANDONED Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression + // + // UI name: [Contact abandoned] + // + // CONTACTS_CREATED Unit: Count + // + // Valid metric filter key: INITIATION_METHOD + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Feature, + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts created] + // + // Feature is a valid filter but not a valid grouping. + // + // CONTACTS_HANDLED Unit: Count + // + // Valid metric filter key: INITIATION_METHOD , DISCONNECT_REASON + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, + // RoutingStepExpression + // + // UI name: [API contacts handled] + // // Feature is a valid filter but not a valid grouping. - // CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key: - // INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts handled - // (connected to agent timestamp) (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical) - // CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Contacts hold disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical) - // CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold - // agent disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical) - // CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold - // customer disconnect (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical) - // CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Contacts put on hold (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical) - // CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts - // transferred out external (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical) - // CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts - // transferred out internal (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical) - // CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI - // name: Contacts queued (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical) - // CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, - // Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI - // name: Contacts queued (enqueue timestamp) (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical) - // CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, - // Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For - // ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. - // For Comparison , you must enter LT (for "Less than"). UI name: Contacts - // resolved in X (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical) - // CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy, Feature, - // contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical) + // + // CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count + // + // Valid metric filter key: INITIATION_METHOD + // + // Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts handled (connected to agent timestamp)] + // + // CONTACTS_HOLD_ABANDONS Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts hold disconnect] + // + // CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contacts hold agent disconnect] + // + // CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contacts hold customer disconnect] + // + // CONTACTS_PUT_ON_HOLD Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contacts put on hold] + // + // CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contacts transferred out external] + // + // CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contacts transferred out internal] + // + // CONTACTS_QUEUED Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts queued] + // + // CONTACTS_QUEUED_BY_ENQUEUE Unit: Count + // + // Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts queued (enqueue timestamp)] + // + // CONTACTS_RESOLVED_IN_X Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, + // contact/segmentAttributes/connect:Subtype + // + // Threshold: For ThresholdValue enter any whole number from 1 to 604800 + // (inclusive), in seconds. For Comparison , you must enter LT (for "Less than"). + // + // UI name: [Contacts resolved in X] + // + // CONTACTS_TRANSFERRED_OUT Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, Feature, contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts transferred out] + // // Feature is a valid filter but not a valid grouping. - // CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out by - // agent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical) - // CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out - // queue (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical) - // CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings - // and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical) - // MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Maximum queued time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical) - // PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: - // CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI - // name: Cases resolved on first contact (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical) - // PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue, - // RoutingStepExpression UI name: Not available PERCENT_CONTACTS_STEP_JOINED Unit: - // Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not - // available PERCENT_NON_TALK_TIME This metric is available only for contacts - // analyzed by Contact Lens conversational analytics. Unit: Percentage Valid - // groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Non-talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical) - // PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact - // Lens conversational analytics. Unit: Percentage Valid groupings and filters: - // Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical) + // + // CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts transferred out by agent] + // + // CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Contacts transferred out queue] + // + // CURRENT_CASES Unit: Count + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Current cases] + // + // MAX_QUEUED_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Maximum queued time] + // + // PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Cases resolved on first contact] + // + // PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent + // + // Valid groupings and filters: Queue, RoutingStepExpression + // + // UI name: Not available + // + // PERCENT_CONTACTS_STEP_JOINED Unit: Percent + // + // Valid groupings and filters: Queue, RoutingStepExpression + // + // UI name: Not available + // + // PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by + // Contact Lens conversational analytics. + // + // Unit: Percentage + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Non-talk time percent] + // + // PERCENT_TALK_TIME This metric is available only for contacts analyzed by + // Contact Lens conversational analytics. + // + // Unit: Percentage + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Talk time percent] + // // PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by - // Contact Lens conversational analytics. Unit: Percentage Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Agent talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical) + // Contact Lens conversational analytics. + // + // Unit: Percentage + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Agent talk time percent] + // // PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed - // by Contact Lens conversational analytics. Unit: Percentage Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, - // contact/segmentAttributes/connect:Subtype UI name: Customer talk time percent (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical) - // REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid - // groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical) - // RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid - // groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historicall) - // 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"). UI name: Service - // level X (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical) - // STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, - // RoutingStepExpression UI name: Not available SUM_AFTER_CONTACT_WORK_TIME Unit: - // Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, - // Agent Hierarchy UI name: After contact work time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical) - // SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: - // INITIATION_METHOD . This metric only supports the following filter keys as - // INITIATION_METHOD : INBOUND | OUTBOUND | CALLBACK | API Valid groupings and - // filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent - // API connecting time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time) + // by Contact Lens conversational analytics. + // + // Unit: Percentage + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Customer talk time percent] + // + // REOPENED_CASE_ACTIONS Unit: Count + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Cases reopened] + // + // RESOLVED_CASE_ACTIONS Unit: Count + // + // Required filter key: CASE_TEMPLATE_ARN + // + // Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS + // + // UI name: [Cases resolved] + // + // 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"). + // + // UI name: [Service level X] + // + // STEP_CONTACTS_QUEUED Unit: Count + // + // Valid groupings and filters: Queue, RoutingStepExpression + // + // UI name: Not available + // + // SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [After contact work time] + // + // SUM_CONNECTING_TIME_AGENT Unit: Seconds + // + // Valid metric filter key: INITIATION_METHOD . This metric only supports the + // following filter keys as INITIATION_METHOD : INBOUND | OUTBOUND | CALLBACK | API + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Agent API connecting time] + // // The Negate key in Metric Level Filters is not applicable for this metric. - // SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Contact flow time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical) - // SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical) - // SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, - // Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: - // For ThresholdValue , enter any whole number from 1 to 604800 (inclusive), in - // seconds. For Comparison , you must enter LT (for "Less than"). UI name: - // Contacts answered in X seconds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical) - // SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue, - // Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: - // For ThresholdValue , enter any whole number from 1 to 604800 (inclusive), in - // seconds. For Comparison , you must enter LT (for "Less than"). UI name: - // Contacts abandoned in X seconds (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical) - // SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit: - // Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent - // Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contact - // disconnected (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical) - // SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy UI name: Error status time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical) - // SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Contact handle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical) - // SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing - // Profile, Agent, Agent Hierarchy UI name: Customer hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical) - // SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, - // Agent, Agent Hierarchy UI name: Agent idle time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica) - // SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, - // Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction and - // hold time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical) - // SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, - // Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical) - // SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing - // Profile, Agent, Agent Hierarchy UI name: Non-Productive Time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical) - // SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing - // Profile, Agent, Agent Hierarchy UI name: Online time (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical) - // SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, - // Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: - // Callback attempts (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical) + // + // SUM_CONTACT_FLOW_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contact flow time] + // + // SUM_CONTACT_TIME_AGENT Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Agent on contact time] + // + // SUM_CONTACTS_ANSWERED_IN_X Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, + // contact/segmentAttributes/connect:Subtype + // + // Threshold: For ThresholdValue , enter any whole number from 1 to 604800 + // (inclusive), in seconds. For Comparison , you must enter LT (for "Less than"). + // + // UI name: [Contacts answered in X seconds] + // + // SUM_CONTACTS_ABANDONED_IN_X Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, + // contact/segmentAttributes/connect:Subtype + // + // Threshold: For ThresholdValue , enter any whole number from 1 to 604800 + // (inclusive), in seconds. For Comparison , you must enter LT (for "Less than"). + // + // UI name: [Contacts abandoned in X seconds] + // + // SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON + // + // Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy, contact/segmentAttributes/connect:Subtype + // + // UI name: [Contact disconnected] + // + // SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Error status time] + // + // SUM_HANDLE_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Contact handle time] + // + // SUM_HOLD_TIME Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Customer hold time] + // + // SUM_IDLE_TIME_AGENT Unit: Seconds + // + // Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy + // + // UI name: [Agent idle time] + // + // SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Agent interaction and hold time] + // + // SUM_INTERACTION_TIME Unit: Seconds + // + // Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent + // Hierarchy + // + // UI name: [Agent interaction time] + // + // SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds + // + // Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy + // + // UI name: [Non-Productive Time] + // + // SUM_ONLINE_TIME_AGENT Unit: Seconds + // + // Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy + // + // UI name: [Online time] + // + // SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count + // + // Valid groupings and filters: Queue, Channel, Routing Profile, + // contact/segmentAttributes/connect:Subtype + // + // UI name: [Callback attempts] + // + // [Historical metrics definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html + // [Contacts transferred out external]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical + // [Average agent greeting time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical + // [Non-talk time percent]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical + // [Average agent pause time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical + // [Average queue abandon time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical + // [Contacts transferred out by agent]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical + // [Average agent API connecting time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-avg-agent-api-connecting-time + // [Average contact duration]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical + // [Non-adherent time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#non-adherent-time + // [Average agent interaction and customer hold time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical + // [Contacts created]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical + // [Adherence]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherence-historical + // [Customer talk time percent]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical + // [Average conversation duration]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical + // [After contact work time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical + // [Average customer talk time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical + // [Contacts queued]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical + // [Occupancy]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#occupancy-historical + // [Error status time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical + // [Maximum queued time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical + // [Contacts answered in X seconds]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical + // [Average active time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical + // [Contacts transferred out queue]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical + // [Cases reopened]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical + // [Average case resolution time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical + // [Contact flow time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical + // [Average customer hold time all contacts]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical + // [Agent API connecting time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time + // [Average agent interaction time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical + // [Talk time percent]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical + // [Agent on contact time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical + // [Average non-talk time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical + // [Average agent talk time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical + // [Average agent interruption time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical + // [Contacts transferred out]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical + // [Average contacts per case]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contacts-case-historical + // [Agent talk time percent]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical + // [Average resolution time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical + // [Cases resolved]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historicall + // [Contacts queued (enqueue timestamp)]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical + // [Contacts hold disconnect]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical + // [Online time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical + // [Average holds]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical + // [API contacts handled]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical + // [Agent interaction time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical + // [Agent non-response without customer abandons]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-nonresponse-no-abandon-historical + // [Average agent interruptions]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical + // [Service level X]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical + // [Contact handle time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical + // [Contact disconnected]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical + // [Contacts handled (connected to agent timestamp)]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical + // [Agent idle time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica + // [Contacts resolved in X]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical + // [Contact abandoned]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical + // [Cases resolved on first contact]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical + // [Adherent time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherent-time-historical + // [Abandonment rate]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical + // [Average talk time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical + // [Scheduled time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#scheduled-time-historical + // [Average after contact work time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical + // [Contacts abandoned in X seconds]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical + // [Non-Productive Time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical + // [Cases created]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##cases-created-historical + // [Current cases]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical + // [Average queue answer time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical + // [Customer hold time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical + // [Average handle time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical + // [Average customer hold time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical + // [Agent interaction and hold time]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical + // [Contacts hold customer disconnect]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical + // [Contacts put on hold]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical + // [Contacts hold agent disconnect]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical + // [Contacts transferred out internal]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical + // [Agent non-response]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-non-response + // [Callback attempts]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical + // [Forecasting, capacity planning, and scheduling]: https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region + // [Agent answer rate]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-answer-rate-historical // // This member is required. Metrics []types.MetricV2 @@ -367,8 +862,11 @@ type GetMetricDataV2Input struct { // 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 | + // 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 | CASE_TEMPLATE_ARN | CASE_STATUS | @@ -376,26 +874,35 @@ type GetMetricDataV2Input struct { Groupings []string // The interval period and timezone to apply to returned metrics. + // // - IntervalPeriod : An aggregated grouping applied to request metrics. Valid // IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | - // TOTAL . For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and - // EndTime differs by 1 day, then Amazon Connect returns 48 results in the - // response. Each result is aggregated by the THIRTY_MIN period. By default Amazon - // Connect aggregates results based on the TOTAL interval period. The following - // list describes restrictions on StartTime and EndTime based on which - // IntervalPeriod is requested. + // TOTAL . + // + // For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and EndTime + // differs by 1 day, then Amazon Connect returns 48 results in the response. Each + // result is aggregated by the THIRTY_MIN period. By default Amazon Connect + // aggregates results based on the TOTAL interval period. + // + // The following list describes restrictions on StartTime and EndTime based on + // which IntervalPeriod is requested. + // // - FIFTEEN_MIN : The difference between StartTime and EndTime must be less than // 3 days. + // // - THIRTY_MIN : The difference between StartTime and EndTime must be less than // 3 days. - // - HOUR : The difference between StartTime and EndTime must be less than 3 - // days. - // - DAY : The difference between StartTime and EndTime must be less than 35 - // days. + // + // - HOUR : The difference between StartTime and EndTime must be less than 3 days. + // + // - DAY : The difference between StartTime and EndTime must be less than 35 days. + // // - WEEK : The difference between StartTime and EndTime must be less than 35 // days. + // // - TOTAL : The difference between StartTime and EndTime must be less than 35 // days. + // // - TimeZone : The timezone applied to requested metrics. Interval *types.IntervalDetails diff --git a/service/connect/api_op_GetPromptFile.go b/service/connect/api_op_GetPromptFile.go index e51e80bbd5a..5527c76f7a2 100644 --- a/service/connect/api_op_GetPromptFile.go +++ b/service/connect/api_op_GetPromptFile.go @@ -29,8 +29,10 @@ func (c *Client) GetPromptFile(ctx context.Context, params *GetPromptFileInput, type GetPromptFileInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_GetTaskTemplate.go b/service/connect/api_op_GetTaskTemplate.go index 02b419e068a..213ff2c55b7 100644 --- a/service/connect/api_op_GetTaskTemplate.go +++ b/service/connect/api_op_GetTaskTemplate.go @@ -31,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -86,8 +88,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The timestamp when the task template was last modified. diff --git a/service/connect/api_op_ImportPhoneNumber.go b/service/connect/api_op_ImportPhoneNumber.go index 188cc4640e1..438d262ade5 100644 --- a/service/connect/api_op_ImportPhoneNumber.go +++ b/service/connect/api_op_ImportPhoneNumber.go @@ -30,8 +30,10 @@ func (c *Client) ImportPhoneNumber(ctx context.Context, params *ImportPhoneNumbe type ImportPhoneNumberInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -45,9 +47,9 @@ type ImportPhoneNumberInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the phone number. diff --git a/service/connect/api_op_ListAgentStatuses.go b/service/connect/api_op_ListAgentStatuses.go index 35516242d0d..56e6accce82 100644 --- a/service/connect/api_op_ListAgentStatuses.go +++ b/service/connect/api_op_ListAgentStatuses.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Lists agent statuses. func (c *Client) ListAgentStatuses(ctx context.Context, params *ListAgentStatusesInput, optFns ...func(*Options)) (*ListAgentStatusesOutput, error) { if params == nil { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListAnalyticsDataAssociations.go b/service/connect/api_op_ListAnalyticsDataAssociations.go index e34d2ae580b..8d4f280138d 100644 --- a/service/connect/api_op_ListAnalyticsDataAssociations.go +++ b/service/connect/api_op_ListAnalyticsDataAssociations.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Lists the association status of requested dataset ID for a given Amazon Connect // instance. func (c *Client) ListAnalyticsDataAssociations(ctx context.Context, params *ListAnalyticsDataAssociationsInput, optFns ...func(*Options)) (*ListAnalyticsDataAssociationsOutput, error) { @@ -31,8 +32,10 @@ func (c *Client) ListAnalyticsDataAssociations(ctx context.Context, params *List type ListAnalyticsDataAssociationsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListApprovedOrigins.go b/service/connect/api_op_ListApprovedOrigins.go index abf5aa1ff02..1563497ff24 100644 --- a/service/connect/api_op_ListApprovedOrigins.go +++ b/service/connect/api_op_ListApprovedOrigins.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Returns a paginated list of all approved origins associated with the instance. func (c *Client) ListApprovedOrigins(ctx context.Context, params *ListApprovedOriginsInput, optFns ...func(*Options)) (*ListApprovedOriginsOutput, error) { if params == nil { @@ -29,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListBots.go b/service/connect/api_op_ListBots.go index a83c4ac0ae0..d5615971e37 100644 --- a/service/connect/api_op_ListBots.go +++ b/service/connect/api_op_ListBots.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This API is in preview release for Amazon Connect and is subject to change. For -// the specified version of Amazon Lex, returns a paginated list of all the Amazon -// Lex bots currently associated with the instance. Use this API to returns both -// Amazon Lex V1 and V2 bots. +// This API is in preview release for Amazon Connect and is subject to change. +// +// For the specified version of Amazon Lex, returns a paginated list of all the +// Amazon Lex bots currently associated with the instance. Use this API to returns +// both Amazon Lex V1 and V2 bots. func (c *Client) ListBots(ctx context.Context, params *ListBotsInput, optFns ...func(*Options)) (*ListBotsOutput, error) { if params == nil { params = &ListBotsInput{} @@ -32,8 +33,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListContactEvaluations.go b/service/connect/api_op_ListContactEvaluations.go index 5015f2a7665..3f568d2dbab 100644 --- a/service/connect/api_op_ListContactEvaluations.go +++ b/service/connect/api_op_ListContactEvaluations.go @@ -34,16 +34,19 @@ type ListContactEvaluationsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. This is not - // expected to be set because the value returned in the previous response is always - // null. + // response in the next request to retrieve the next set of results. + // + // This is not expected to be set because the value returned in the previous + // response is always null. NextToken *string noSmithyDocumentSerde @@ -57,6 +60,7 @@ type ListContactEvaluationsOutput struct { EvaluationSummaryList []types.EvaluationSummary // If there are additional results, this is the token for the next set of results. + // // This is always returned as null in the response. NextToken *string diff --git a/service/connect/api_op_ListContactFlowModules.go b/service/connect/api_op_ListContactFlowModules.go index 6b90e228e73..35a561974a6 100644 --- a/service/connect/api_op_ListContactFlowModules.go +++ b/service/connect/api_op_ListContactFlowModules.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListContactFlows.go b/service/connect/api_op_ListContactFlows.go index ae8ec67d634..26a22661c1b 100644 --- a/service/connect/api_op_ListContactFlows.go +++ b/service/connect/api_op_ListContactFlows.go @@ -12,9 +12,14 @@ 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) -// in the Amazon Connect Administrator Guide. +// +// You can also create and update flows using the [Amazon Connect Flow language]. +// +// For more information about flows, see [Flows] in the Amazon Connect Administrator +// Guide. +// +// [Flows]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html +// [Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html func (c *Client) ListContactFlows(ctx context.Context, params *ListContactFlowsInput, optFns ...func(*Options)) (*ListContactFlowsOutput, error) { if params == nil { params = &ListContactFlowsInput{} @@ -32,8 +37,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListContactReferences.go b/service/connect/api_op_ListContactReferences.go index b186420540f..3633a36eb5b 100644 --- a/service/connect/api_op_ListContactReferences.go +++ b/service/connect/api_op_ListContactReferences.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// contact. References are links to documents that are related to a contact, such -// as emails, attachments, or URLs. +// 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 contact. References are links to documents that are related to a contact, +// such as emails, attachments, or URLs. func (c *Client) ListContactReferences(ctx context.Context, params *ListContactReferencesInput, optFns ...func(*Options)) (*ListContactReferencesOutput, error) { if params == nil { params = &ListContactReferencesInput{} @@ -37,8 +38,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -49,9 +52,10 @@ type ListContactReferencesInput struct { ReferenceTypes []types.ReferenceType // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. This is not - // expected to be set, because the value returned in the previous response is - // always null. + // response in the next request to retrieve the next set of results. + // + // This is not expected to be set, because the value returned in the previous + // response is always null. NextToken *string noSmithyDocumentSerde @@ -60,6 +64,7 @@ type ListContactReferencesInput struct { type ListContactReferencesOutput struct { // If there are additional results, this is the token for the next set of results. + // // This is always returned as null in the response. NextToken *string diff --git a/service/connect/api_op_ListDefaultVocabularies.go b/service/connect/api_op_ListDefaultVocabularies.go index c992c518bb1..a1d57df3a34 100644 --- a/service/connect/api_op_ListDefaultVocabularies.go +++ b/service/connect/api_op_ListDefaultVocabularies.go @@ -29,14 +29,18 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // 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?] + // + // [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_ListEvaluationFormVersions.go b/service/connect/api_op_ListEvaluationFormVersions.go index 8d1c020e1ce..8bb1025b364 100644 --- a/service/connect/api_op_ListEvaluationFormVersions.go +++ b/service/connect/api_op_ListEvaluationFormVersions.go @@ -34,8 +34,10 @@ type ListEvaluationFormVersionsInput struct { // This member is required. EvaluationFormId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListEvaluationForms.go b/service/connect/api_op_ListEvaluationForms.go index 7913c942c17..fe28532475a 100644 --- a/service/connect/api_op_ListEvaluationForms.go +++ b/service/connect/api_op_ListEvaluationForms.go @@ -29,8 +29,10 @@ func (c *Client) ListEvaluationForms(ctx context.Context, params *ListEvaluation type ListEvaluationFormsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListFlowAssociations.go b/service/connect/api_op_ListFlowAssociations.go index 3c136a884cd..b2c355ff657 100644 --- a/service/connect/api_op_ListFlowAssociations.go +++ b/service/connect/api_op_ListFlowAssociations.go @@ -29,8 +29,10 @@ func (c *Client) ListFlowAssociations(ctx context.Context, params *ListFlowAssoc type ListFlowAssociationsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListHoursOfOperations.go b/service/connect/api_op_ListHoursOfOperations.go index dcf67a80d43..864c24d4c64 100644 --- a/service/connect/api_op_ListHoursOfOperations.go +++ b/service/connect/api_op_ListHoursOfOperations.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Connect Administrator Guide. +// Connect instance. +// +// For more information about hours of operation, see [Set the Hours of Operation for a Queue] in the Amazon Connect +// Administrator Guide. +// +// [Set the Hours of Operation for a Queue]: https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html func (c *Client) ListHoursOfOperations(ctx context.Context, params *ListHoursOfOperationsInput, optFns ...func(*Options)) (*ListHoursOfOperationsOutput, error) { if params == nil { params = &ListHoursOfOperationsInput{} @@ -32,8 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListInstanceAttributes.go b/service/connect/api_op_ListInstanceAttributes.go index 54a517d1ac2..0394a568f39 100644 --- a/service/connect/api_op_ListInstanceAttributes.go +++ b/service/connect/api_op_ListInstanceAttributes.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Returns a paginated list of all attribute types for the given instance. func (c *Client) ListInstanceAttributes(ctx context.Context, params *ListInstanceAttributesInput, optFns ...func(*Options)) (*ListInstanceAttributesOutput, error) { if params == nil { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListInstanceStorageConfigs.go b/service/connect/api_op_ListInstanceStorageConfigs.go index a04534c38d4..77ed67c9002 100644 --- a/service/connect/api_op_ListInstanceStorageConfigs.go +++ b/service/connect/api_op_ListInstanceStorageConfigs.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Returns a paginated list of storage configs for the identified instance and // resource type. func (c *Client) ListInstanceStorageConfigs(ctx context.Context, params *ListInstanceStorageConfigsInput, optFns ...func(*Options)) (*ListInstanceStorageConfigsOutput, error) { @@ -31,8 +32,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListInstances.go b/service/connect/api_op_ListInstances.go index 78a9583485d..b17f2ce157a 100644 --- a/service/connect/api_op_ListInstances.go +++ b/service/connect/api_op_ListInstances.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Return a list of instances which are in active state, creation-in-progress // state, and failed state. Instances that aren't successfully created (they are in // a failed state) are returned only for 24 hours after the CreateInstance API was diff --git a/service/connect/api_op_ListIntegrationAssociations.go b/service/connect/api_op_ListIntegrationAssociations.go index a2ac854a46b..67fd51b10af 100644 --- a/service/connect/api_op_ListIntegrationAssociations.go +++ b/service/connect/api_op_ListIntegrationAssociations.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListLambdaFunctions.go b/service/connect/api_op_ListLambdaFunctions.go index ca562baf7f4..724858559c2 100644 --- a/service/connect/api_op_ListLambdaFunctions.go +++ b/service/connect/api_op_ListLambdaFunctions.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Returns a paginated list of all Lambda functions that display in the dropdown // options in the relevant flow blocks. func (c *Client) ListLambdaFunctions(ctx context.Context, params *ListLambdaFunctionsInput, optFns ...func(*Options)) (*ListLambdaFunctionsOutput, error) { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListLexBots.go b/service/connect/api_op_ListLexBots.go index a5e82e294c1..255933dabe0 100644 --- a/service/connect/api_op_ListLexBots.go +++ b/service/connect/api_op_ListLexBots.go @@ -12,9 +12,11 @@ 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. +// +// 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]API. +// +// [ListBots]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html func (c *Client) ListLexBots(ctx context.Context, params *ListLexBotsInput, optFns ...func(*Options)) (*ListLexBotsOutput, error) { if params == nil { params = &ListLexBotsInput{} @@ -32,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListPhoneNumbers.go b/service/connect/api_op_ListPhoneNumbers.go index 2afda331854..6c374bef98a 100644 --- a/service/connect/api_op_ListPhoneNumbers.go +++ b/service/connect/api_op_ListPhoneNumbers.go @@ -12,19 +12,24 @@ 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) -// in the Amazon Connect Administrator Guide. -// - We recommend using ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) -// to return phone number types. ListPhoneNumbers doesn't support number types -// UIFN , SHARED , THIRD_PARTY_TF , and THIRD_PARTY_DID . While it returns -// numbers of those types, it incorrectly lists them as TOLL_FREE or DID . -// - 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) +// instance. +// +// For more information about phone numbers, see [Set Up Phone Numbers for Your Contact Center] in the Amazon Connect +// Administrator Guide. +// +// - We recommend using [ListPhoneNumbersV2]to return phone number types. ListPhoneNumbers doesn't +// support number types UIFN , SHARED , THIRD_PARTY_TF , and THIRD_PARTY_DID . +// While it returns numbers of those types, it incorrectly lists them as +// TOLL_FREE or DID . +// +// - The phone number Arn value that is returned from each of the items in the [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) -// API. It returns the new phone number ARN that can be used to tag phone number -// resources. +// ResourceNotFoundException . Instead, use the [ListPhoneNumbersV2]API. It returns the new phone +// number ARN that can be used to tag phone number resources. +// +// [ListPhoneNumbersV2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html +// [Set Up Phone Numbers for Your Contact Center]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html +// [PhoneNumberSummaryList]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList func (c *Client) ListPhoneNumbers(ctx context.Context, params *ListPhoneNumbersInput, optFns ...func(*Options)) (*ListPhoneNumbersOutput, error) { if params == nil { params = &ListPhoneNumbersInput{} @@ -42,8 +47,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -59,10 +66,13 @@ type ListPhoneNumbersInput struct { // The ISO country code. PhoneNumberCountryCodes []types.PhoneNumberCountryCode - // The type of phone number. We recommend using ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) - // to return phone number types. While ListPhoneNumbers returns number types UIFN , - // SHARED , THIRD_PARTY_TF , and THIRD_PARTY_DID , it incorrectly lists them as - // TOLL_FREE or DID . + // The type of phone number. + // + // We recommend using [ListPhoneNumbersV2] to return phone number types. While ListPhoneNumbers + // returns number types UIFN , SHARED , THIRD_PARTY_TF , and THIRD_PARTY_DID , it + // incorrectly lists them as TOLL_FREE or DID . + // + // [ListPhoneNumbersV2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html PhoneNumberTypes []types.PhoneNumberType noSmithyDocumentSerde diff --git a/service/connect/api_op_ListPhoneNumbersV2.go b/service/connect/api_op_ListPhoneNumbersV2.go index 8672c9648c2..ec84efd6149 100644 --- a/service/connect/api_op_ListPhoneNumbersV2.go +++ b/service/connect/api_op_ListPhoneNumbersV2.go @@ -14,13 +14,18 @@ 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) -// in the Amazon Connect Administrator Guide. +// traffic distribution group. +// +// For more information about phone numbers, see [Set Up Phone Numbers for Your Contact Center] in the Amazon Connect +// Administrator Guide. +// // - When given an instance ARN, ListPhoneNumbersV2 returns only the phone // numbers claimed to the instance. +// // - When given a traffic distribution group ARN ListPhoneNumbersV2 returns only // the phone numbers claimed to the traffic distribution group. +// +// [Set Up Phone Numbers for Your Contact Center]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html func (c *Client) ListPhoneNumbersV2(ctx context.Context, params *ListPhoneNumbersV2Input, optFns ...func(*Options)) (*ListPhoneNumbersV2Output, error) { if params == nil { params = &ListPhoneNumbersV2Input{} @@ -39,11 +44,12 @@ func (c *Client) ListPhoneNumbersV2(ctx context.Context, params *ListPhoneNumber type ListPhoneNumbersV2Input struct { // The identifier of the Amazon Connect instance that phone numbers are claimed - // to. 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. If both TargetArn and - // InstanceId are not provided, this API lists numbers claimed to all the Amazon - // Connect instances belonging to your account in the same AWS Region as the + // to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance. If both TargetArn + // and InstanceId are not provided, this API lists numbers claimed to all the + // Amazon Connect instances belonging to your account in the same AWS Region as the // request. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The maximum number of results to return per page. diff --git a/service/connect/api_op_ListQueueQuickConnects.go b/service/connect/api_op_ListQueueQuickConnects.go index c3c03418d0d..f4076e738a3 100644 --- a/service/connect/api_op_ListQueueQuickConnects.go +++ b/service/connect/api_op_ListQueueQuickConnects.go @@ -13,6 +13,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Lists the quick connects associated with a queue. func (c *Client) ListQueueQuickConnects(ctx context.Context, params *ListQueueQuickConnectsInput, optFns ...func(*Options)) (*ListQueueQuickConnectsOutput, error) { if params == nil { @@ -31,8 +32,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListQueues.go b/service/connect/api_op_ListQueues.go index 56e7d8356c3..3b6fbbee1aa 100644 --- a/service/connect/api_op_ListQueues.go +++ b/service/connect/api_op_ListQueues.go @@ -11,12 +11,17 @@ 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) -// in the Amazon Connect Administrator Guide. +// 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] in the Amazon Connect Administrator +// Guide. +// +// [Queues: Standard and Agent]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error) { if params == nil { params = &ListQueuesInput{} @@ -34,8 +39,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListQuickConnects.go b/service/connect/api_op_ListQuickConnects.go index a7e9345bbce..55b4d8fb749 100644 --- a/service/connect/api_op_ListQuickConnects.go +++ b/service/connect/api_op_ListQuickConnects.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListRealtimeContactAnalysisSegmentsV2.go b/service/connect/api_op_ListRealtimeContactAnalysisSegmentsV2.go index d92376452ce..ccf76a47fd4 100644 --- a/service/connect/api_op_ListRealtimeContactAnalysisSegmentsV2.go +++ b/service/connect/api_op_ListRealtimeContactAnalysisSegmentsV2.go @@ -34,8 +34,10 @@ type ListRealtimeContactAnalysisSegmentsV2Input 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListRoutingProfileQueues.go b/service/connect/api_op_ListRoutingProfileQueues.go index da952709c4e..6d4bf0f192b 100644 --- a/service/connect/api_op_ListRoutingProfileQueues.go +++ b/service/connect/api_op_ListRoutingProfileQueues.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListRoutingProfiles.go b/service/connect/api_op_ListRoutingProfiles.go index 477af7f735d..f2536f36cdb 100644 --- a/service/connect/api_op_ListRoutingProfiles.go +++ b/service/connect/api_op_ListRoutingProfiles.go @@ -12,10 +12,13 @@ import ( ) // 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. +// Amazon Connect instance. +// +// For more information about routing profiles, see [Routing Profiles] and [Create a Routing Profile] in the Amazon Connect +// Administrator Guide. +// +// [Create a Routing Profile]: https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html +// [Routing Profiles]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html func (c *Client) ListRoutingProfiles(ctx context.Context, params *ListRoutingProfilesInput, optFns ...func(*Options)) (*ListRoutingProfilesOutput, error) { if params == nil { params = &ListRoutingProfilesInput{} @@ -33,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListRules.go b/service/connect/api_op_ListRules.go index 628a91460ab..e90ca479888 100644 --- a/service/connect/api_op_ListRules.go +++ b/service/connect/api_op_ListRules.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListSecurityKeys.go b/service/connect/api_op_ListSecurityKeys.go index 0c57308facc..a45df73817d 100644 --- a/service/connect/api_op_ListSecurityKeys.go +++ b/service/connect/api_op_ListSecurityKeys.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Returns a paginated list of all security keys associated with the instance. func (c *Client) ListSecurityKeys(ctx context.Context, params *ListSecurityKeysInput, optFns ...func(*Options)) (*ListSecurityKeysOutput, error) { if params == nil { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListSecurityProfileApplications.go b/service/connect/api_op_ListSecurityProfileApplications.go index f5c41589d9e..27e4027e10b 100644 --- a/service/connect/api_op_ListSecurityProfileApplications.go +++ b/service/connect/api_op_ListSecurityProfileApplications.go @@ -30,8 +30,10 @@ func (c *Client) ListSecurityProfileApplications(ctx context.Context, params *Li type ListSecurityProfileApplicationsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListSecurityProfilePermissions.go b/service/connect/api_op_ListSecurityProfilePermissions.go index baacaaa1b72..7733a9446e7 100644 --- a/service/connect/api_op_ListSecurityProfilePermissions.go +++ b/service/connect/api_op_ListSecurityProfilePermissions.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -62,8 +64,9 @@ 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]. + // + // [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 19cfd5d342a..81376e6f4ca 100644 --- a/service/connect/api_op_ListSecurityProfiles.go +++ b/service/connect/api_op_ListSecurityProfiles.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Connect Administrator Guide. +// Amazon Connect instance. +// +// For more information about security profiles, see [Security Profiles] in the Amazon Connect +// Administrator Guide. +// +// [Security Profiles]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityProfilesInput, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error) { if params == nil { params = &ListSecurityProfilesInput{} @@ -32,8 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListTagsForResource.go b/service/connect/api_op_ListTagsForResource.go index e5a36806da3..7afb59d0dbe 100644 --- a/service/connect/api_op_ListTagsForResource.go +++ b/service/connect/api_op_ListTagsForResource.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Connect Administrator Guide. +// Lists the tags for the specified resource. +// +// For sample policies that use tags, see [Amazon Connect Identity-Based Policy Examples] in the Amazon Connect Administrator +// Guide. +// +// [Amazon Connect Identity-Based Policy Examples]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -32,8 +35,9 @@ 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]. + // + // [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 8cfa2d0908c..52adebf7936 100644 --- a/service/connect/api_op_ListTaskTemplates.go +++ b/service/connect/api_op_ListTaskTemplates.go @@ -29,23 +29,27 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string - // The maximum number of results to return per page. It is not expected that you - // set this. + // The maximum number of results to return per page. + // + // It is not expected that you set this. MaxResults *int32 // The name of the task template. Name *string // The token for the next set of results. Use the value returned in the previous - // response in the next request to retrieve the next set of results. It is not - // expected that you set this because the value returned in the previous response - // is always null. + // response in the next request to retrieve the next set of results. + // + // It is not expected that you set this because the value returned in the previous + // response is always null. NextToken *string // Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can @@ -59,6 +63,7 @@ type ListTaskTemplatesInput struct { type ListTaskTemplatesOutput struct { // If there are additional results, this is the token for the next set of results. + // // This is always returned as a null in the response. NextToken *string @@ -160,8 +165,9 @@ var _ ListTaskTemplatesAPIClient = (*Client)(nil) // ListTaskTemplatesPaginatorOptions is the paginator options for ListTaskTemplates type ListTaskTemplatesPaginatorOptions struct { - // The maximum number of results to return per page. It is not expected that you - // set this. + // The maximum number of results to return per page. + // + // It is not expected that you set this. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/connect/api_op_ListTrafficDistributionGroups.go b/service/connect/api_op_ListTrafficDistributionGroups.go index c2a414751b0..9bff317a93a 100644 --- a/service/connect/api_op_ListTrafficDistributionGroups.go +++ b/service/connect/api_op_ListTrafficDistributionGroups.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The maximum number of results to return per page. diff --git a/service/connect/api_op_ListUseCases.go b/service/connect/api_op_ListUseCases.go index a6083e57d20..03cd56c755c 100644 --- a/service/connect/api_op_ListUseCases.go +++ b/service/connect/api_op_ListUseCases.go @@ -31,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListUserHierarchyGroups.go b/service/connect/api_op_ListUserHierarchyGroups.go index 81937317d5b..13f3c89ae5f 100644 --- a/service/connect/api_op_ListUserHierarchyGroups.go +++ b/service/connect/api_op_ListUserHierarchyGroups.go @@ -12,9 +12,12 @@ import ( ) // 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. +// Amazon Connect instance. +// +// For more information about agent hierarchies, see [Set Up Agent Hierarchies] in the Amazon Connect +// Administrator Guide. +// +// [Set Up Agent Hierarchies]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html func (c *Client) ListUserHierarchyGroups(ctx context.Context, params *ListUserHierarchyGroupsInput, optFns ...func(*Options)) (*ListUserHierarchyGroupsOutput, error) { if params == nil { params = &ListUserHierarchyGroupsInput{} @@ -32,8 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListUsers.go b/service/connect/api_op_ListUsers.go index aa0286d8629..3f4fcab555b 100644 --- a/service/connect/api_op_ListUsers.go +++ b/service/connect/api_op_ListUsers.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ListViewVersions.go b/service/connect/api_op_ListViewVersions.go index b50f031abff..bd0202b9531 100644 --- a/service/connect/api_op_ListViewVersions.go +++ b/service/connect/api_op_ListViewVersions.go @@ -12,7 +12,9 @@ import ( ) // Returns all the available versions for the specified Amazon Connect instance -// and view identifier. Results will be sorted from highest to lowest. +// and view identifier. +// +// Results will be sorted from highest to lowest. func (c *Client) ListViewVersions(ctx context.Context, params *ListViewVersionsInput, optFns ...func(*Options)) (*ListViewVersionsOutput, error) { if params == nil { params = &ListViewVersionsInput{} diff --git a/service/connect/api_op_ListViews.go b/service/connect/api_op_ListViews.go index a541e269a32..f1fc3fbc0c7 100644 --- a/service/connect/api_op_ListViews.go +++ b/service/connect/api_op_ListViews.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns views in the given instance. Results are sorted primarily by type, and -// secondarily by name. +// Returns views in the given instance. +// +// Results are sorted primarily by type, and secondarily by name. func (c *Client) ListViews(ctx context.Context, params *ListViewsInput, optFns ...func(*Options)) (*ListViewsOutput, error) { if params == nil { params = &ListViewsInput{} diff --git a/service/connect/api_op_MonitorContact.go b/service/connect/api_op_MonitorContact.go index 7778e0be9fa..b6af8e0732b 100644 --- a/service/connect/api_op_MonitorContact.go +++ b/service/connect/api_op_MonitorContact.go @@ -54,9 +54,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_PutUserStatus.go b/service/connect/api_op_PutUserStatus.go index 6db53d24adf..9ad416f4212 100644 --- a/service/connect/api_op_PutUserStatus.go +++ b/service/connect/api_op_PutUserStatus.go @@ -11,10 +11,12 @@ import ( ) // 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. +// is currently handling a contact, this sets the agent's next status. +// +// For more information, see [Agent status] and [Set your next status] in the Amazon Connect Administrator Guide. +// +// [Agent status]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html +// [Set your next status]: https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html func (c *Client) PutUserStatus(ctx context.Context, params *PutUserStatusInput, optFns ...func(*Options)) (*PutUserStatusOutput, error) { if params == nil { params = &PutUserStatusInput{} @@ -37,8 +39,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_ReleasePhoneNumber.go b/service/connect/api_op_ReleasePhoneNumber.go index 7fc834298cf..f0668106fa6 100644 --- a/service/connect/api_op_ReleasePhoneNumber.go +++ b/service/connect/api_op_ReleasePhoneNumber.go @@ -12,24 +12,32 @@ import ( // Releases a phone number previously claimed to an Amazon Connect instance or // traffic distribution group. You can call this API only in the Amazon Web -// Services Region where the number was claimed. To release phone numbers from a -// traffic distribution group, use the ReleasePhoneNumber API, not the Amazon -// Connect admin website. After releasing a phone number, the phone number enters -// into a cooldown period of 30 days. It cannot be searched for or claimed again -// until the period has ended. If you accidentally release a phone number, contact -// Amazon Web Services Support. If you plan to claim and release numbers frequently -// during a 30 day period, contact us for a service quota exception. Otherwise, it -// is possible you will be blocked from claiming and releasing any more numbers -// until 30 days past the oldest number released has expired. By default you can -// claim and release up to 200% of your maximum number of active phone numbers -// during any 30 day period. If you claim and release phone numbers using the UI or -// API during a rolling 30 day cycle that exceeds 200% of your phone number service -// level quota, you will be blocked from claiming any more numbers until 30 days -// past the oldest number released has expired. For example, if you already have 99 -// claimed numbers and a service level quota of 99 phone numbers, and in any 30 day -// period you release 99, claim 99, and then release 99, you will have exceeded the -// 200% limit. At that point you are blocked from claiming any more numbers until -// you open an Amazon Web Services support ticket. +// Services Region where the number was claimed. +// +// To release phone numbers from a traffic distribution group, use the +// ReleasePhoneNumber API, not the Amazon Connect admin website. +// +// After releasing a phone number, the phone number enters into a cooldown period +// of 30 days. It cannot be searched for or claimed again until the period has +// ended. If you accidentally release a phone number, contact Amazon Web Services +// Support. +// +// If you plan to claim and release numbers frequently during a 30 day period, +// contact us for a service quota exception. Otherwise, it is possible you will be +// blocked from claiming and releasing any more numbers until 30 days past the +// oldest number released has expired. +// +// By default you can claim and release up to 200% of your maximum number of +// active phone numbers during any 30 day period. If you claim and release phone +// numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of +// your phone number service level quota, you will be blocked from claiming any +// more numbers until 30 days past the oldest number released has expired. +// +// For example, if you already have 99 claimed numbers and a service level quota +// of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then +// release 99, you will have exceeded the 200% limit. At that point you are blocked +// from claiming any more numbers until you open an Amazon Web Services support +// ticket. func (c *Client) ReleasePhoneNumber(ctx context.Context, params *ReleasePhoneNumberInput, optFns ...func(*Options)) (*ReleasePhoneNumberOutput, error) { if params == nil { params = &ReleasePhoneNumberInput{} @@ -54,9 +62,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_ReplicateInstance.go b/service/connect/api_op_ReplicateInstance.go index 90be7e65270..6689e4870da 100644 --- a/service/connect/api_op_ReplicateInstance.go +++ b/service/connect/api_op_ReplicateInstance.go @@ -12,9 +12,12 @@ import ( // Replicates an Amazon Connect instance in the specified Amazon Web Services // Region and copies configuration information for Amazon Connect resources across -// Amazon Web Services Regions. 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) -// in the Amazon Connect Administrator Guide. +// Amazon Web Services Regions. +// +// For more information about replicating an Amazon Connect instance, see [Create a replica of your existing Amazon Connect instance] in the +// Amazon Connect Administrator Guide. +// +// [Create a replica of your existing Amazon Connect instance]: https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html func (c *Client) ReplicateInstance(ctx context.Context, params *ReplicateInstanceInput, optFns ...func(*Options)) (*ReplicateInstanceOutput, error) { if params == nil { params = &ReplicateInstanceInput{} @@ -32,9 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. You can provide the - // InstanceId , or the entire ARN. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. You can provide the InstanceId , or the entire ARN. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -51,9 +55,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_ResumeContactRecording.go b/service/connect/api_op_ResumeContactRecording.go index 02c666b9b80..65030b3bc4e 100644 --- a/service/connect/api_op_ResumeContactRecording.go +++ b/service/connect/api_op_ResumeContactRecording.go @@ -13,8 +13,9 @@ import ( // When a contact is being recorded, and the recording has been suspended using // SuspendContactRecording, this API resumes recording whatever recording is // selected in the flow configuration: call, screen, or both. If only call -// recording or only screen recording is enabled, then it would resume. Voice and -// screen recordings are supported. +// recording or only screen recording is enabled, then it would resume. +// +// Voice and screen recordings are supported. func (c *Client) ResumeContactRecording(ctx context.Context, params *ResumeContactRecordingInput, optFns ...func(*Options)) (*ResumeContactRecordingOutput, error) { if params == nil { params = &ResumeContactRecordingInput{} @@ -43,8 +44,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_SearchAvailablePhoneNumbers.go b/service/connect/api_op_SearchAvailablePhoneNumbers.go index ac945547e4d..1cc93089599 100644 --- a/service/connect/api_op_SearchAvailablePhoneNumbers.go +++ b/service/connect/api_op_SearchAvailablePhoneNumbers.go @@ -43,9 +43,10 @@ type SearchAvailablePhoneNumbersInput struct { PhoneNumberType types.PhoneNumberType // The identifier of the Amazon Connect instance that phone numbers are claimed - // to. 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 must enter InstanceId or - // TargetArn . + // to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance. You must enter + // InstanceId or TargetArn . + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The maximum number of results to return per page. diff --git a/service/connect/api_op_SearchHoursOfOperations.go b/service/connect/api_op_SearchHoursOfOperations.go index 2bfbf79abc4..3aebd56d124 100644 --- a/service/connect/api_op_SearchHoursOfOperations.go +++ b/service/connect/api_op_SearchHoursOfOperations.go @@ -30,8 +30,10 @@ func (c *Client) SearchHoursOfOperations(ctx context.Context, params *SearchHour type SearchHoursOfOperationsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_SearchPrompts.go b/service/connect/api_op_SearchPrompts.go index 6fb8f8cfc88..3e7806dfb56 100644 --- a/service/connect/api_op_SearchPrompts.go +++ b/service/connect/api_op_SearchPrompts.go @@ -29,8 +29,10 @@ func (c *Client) SearchPrompts(ctx context.Context, params *SearchPromptsInput, type SearchPromptsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_SearchQueues.go b/service/connect/api_op_SearchQueues.go index a26695ad5e9..5b815a86b8f 100644 --- a/service/connect/api_op_SearchQueues.go +++ b/service/connect/api_op_SearchQueues.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -42,10 +44,11 @@ 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_SearchQuickConnects.go b/service/connect/api_op_SearchQuickConnects.go index 1e26270d7a9..145bc28190a 100644 --- a/service/connect/api_op_SearchQuickConnects.go +++ b/service/connect/api_op_SearchQuickConnects.go @@ -29,8 +29,10 @@ func (c *Client) SearchQuickConnects(ctx context.Context, params *SearchQuickCon type SearchQuickConnectsInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_SearchRoutingProfiles.go b/service/connect/api_op_SearchRoutingProfiles.go index 42c00c92c91..ef231baf0e7 100644 --- a/service/connect/api_op_SearchRoutingProfiles.go +++ b/service/connect/api_op_SearchRoutingProfiles.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -43,10 +45,11 @@ type SearchRoutingProfilesInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // The search criteria to be used to return routing profiles. 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 routing profiles. + // + // 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.RoutingProfileSearchCriteria // Filters to be applied to search results. diff --git a/service/connect/api_op_SearchSecurityProfiles.go b/service/connect/api_op_SearchSecurityProfiles.go index 1446917d8a4..482d55acebb 100644 --- a/service/connect/api_op_SearchSecurityProfiles.go +++ b/service/connect/api_op_SearchSecurityProfiles.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -43,10 +45,13 @@ type SearchSecurityProfilesInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // 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 + // 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 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 471d71c927e..76d9a1a2c39 100644 --- a/service/connect/api_op_SearchUsers.go +++ b/service/connect/api_op_SearchUsers.go @@ -12,6 +12,7 @@ import ( ) // Searches users in an Amazon Connect instance, with optional filtering. +// // AfterContactWorkTimeLimit is returned in milliseconds. func (c *Client) SearchUsers(ctx context.Context, params *SearchUsersInput, optFns ...func(*Options)) (*SearchUsersOutput, error) { if params == nil { @@ -30,9 +31,12 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. InstanceID is a required - // field. The "Required: No" below is incorrect. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // InstanceID is a required field. The "Required: No" below is incorrect. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -44,10 +48,11 @@ type SearchUsersInput struct { // response in the next request to retrieve the next set of results. NextToken *string - // The search criteria to be used to return users. 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 users. + // + // 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.UserSearchCriteria // Filters to be applied to search results. diff --git a/service/connect/api_op_SearchVocabularies.go b/service/connect/api_op_SearchVocabularies.go index 53e906dcc67..ab18f832d40 100644 --- a/service/connect/api_op_SearchVocabularies.go +++ b/service/connect/api_op_SearchVocabularies.go @@ -30,14 +30,18 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // 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?] + // + // [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_SendChatIntegrationEvent.go b/service/connect/api_op_SendChatIntegrationEvent.go index 71aad508132..4de4c1582fa 100644 --- a/service/connect/api_op_SendChatIntegrationEvent.go +++ b/service/connect/api_op_SendChatIntegrationEvent.go @@ -13,15 +13,19 @@ import ( // Processes chat integration events from Amazon Web Services or external // integrations to Amazon Connect. A chat integration event includes: +// // - SourceId, DestinationId, and Subtype: a set of identifiers, uniquely // representing a chat +// // - ChatEvent: details of the chat action to perform such as sending a message, // event, or disconnecting from a chat // // When a chat integration event is sent with chat identifiers that do not map to // an active chat contact, a new chat contact is also created before handling chat -// action. Access to this API is currently restricted to Amazon Pinpoint for -// supporting SMS integration. +// action. +// +// Access to this API is currently restricted to Amazon Pinpoint for supporting +// SMS integration. func (c *Client) SendChatIntegrationEvent(ctx context.Context, params *SendChatIntegrationEventInput, optFns ...func(*Options)) (*SendChatIntegrationEventOutput, error) { if params == nil { params = &SendChatIntegrationEventInput{} @@ -64,6 +68,7 @@ type SendChatIntegrationEventInput struct { NewSessionDetails *types.NewSessionDetails // Classification of a channel. This is used in part to uniquely identify chat. + // // Valid value: ["connect:sms"] Subtype *string diff --git a/service/connect/api_op_StartAttachedFileUpload.go b/service/connect/api_op_StartAttachedFileUpload.go index 00df02e8bc5..d4b37bf6994 100644 --- a/service/connect/api_op_StartAttachedFileUpload.go +++ b/service/connect/api_op_StartAttachedFileUpload.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides a pre-signed Amazon S3 URL in response for uploading your content. You -// may only use this API to upload attachments to a Connect Case (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) -// . +// Provides a pre-signed Amazon S3 URL in response for uploading your content. +// +// You may only use this API to upload attachments to a [Connect Case]. +// +// [Connect Case]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html func (c *Client) StartAttachedFileUpload(ctx context.Context, params *StartAttachedFileUploadInput, optFns ...func(*Options)) (*StartAttachedFileUploadOutput, error) { if params == nil { params = &StartAttachedFileUploadInput{} @@ -31,8 +33,12 @@ func (c *Client) StartAttachedFileUpload(ctx context.Context, params *StartAttac type StartAttachedFileUploadInput struct { - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html // // This member is required. AssociatedResourceArn *string @@ -59,9 +65,9 @@ type StartAttachedFileUploadInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // Represents the identity that created the file. diff --git a/service/connect/api_op_StartChatContact.go b/service/connect/api_op_StartChatContact.go index 378566ce409..76bf2b084b5 100644 --- a/service/connect/api_op_StartChatContact.go +++ b/service/connect/api_op_StartChatContact.go @@ -12,24 +12,29 @@ 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) -// 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) -// with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following -// situations: +// provides a token required to obtain credentials from the [CreateParticipantConnection]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]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 . +// +// - The [quota for concurrent active chats]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 -// 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. +// information, contact Amazon Web Services Support. +// +// For more information about chat, see [Chat] in the Amazon Connect Administrator Guide. +// +// [CreateParticipantConnection]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html +// [Chat]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html +// [quota for concurrent active chats]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html func (c *Client) StartChatContact(ctx context.Context, params *StartChatContactInput, optFns ...func(*Options)) (*StartChatContactOutput, error) { if params == nil { params = &StartChatContactInput{} @@ -52,13 +57,16 @@ type StartChatContactInput struct { // 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 // // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -70,9 +78,10 @@ type StartChatContactInput struct { // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes. They can be accessed in flows just like any other - // contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value - // pairs per contact. Attribute keys can include only alphanumeric, dash, and - // underscore characters. + // contact attributes. + // + // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. + // Attribute keys can include only alphanumeric, dash, and underscore characters. Attributes map[string]string // The total duration of the newly started chat session. If not specified, the @@ -82,9 +91,9 @@ type StartChatContactInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The initial message to be sent to the newly created chat. If you have a Lex bot @@ -92,20 +101,25 @@ type StartChatContactInput struct { InitialMessage *types.ChatMessage // 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) - // . + // and for example use cases and how to configure for them, see [Enable persistent chat]. + // + // [Enable persistent 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 - // to the chat starting. You cannot provide data for both RelatedContactId and - // PersistentChat. + // to the chat starting. + // + // You cannot provide data for both RelatedContactId and PersistentChat. RelatedContactId *string // A set of system defined key-value pairs stored on individual contact segments // using an attribute map. The attributes are standard Amazon Connect attributes. - // They can be accessed in flows. Attribute keys can include only alphanumeric, -, - // and _. This field can be used to show channel subtype, such as connect:Guide . + // They can be accessed in flows. + // + // Attribute keys can include only alphanumeric, -, and _. + // + // This field can be used to show channel subtype, such as connect:Guide . + // // The types application/vnd.amazonaws.connect.message.interactive and // application/vnd.amazonaws.connect.message.interactive.response must be present // in the SupportedMessagingContentTypes field of this API in order to set @@ -115,15 +129,18 @@ type StartChatContactInput struct { // 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) - // flow block. + // 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]flow block. + // + // [Show view]: https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html SupportedMessagingContentTypes []string noSmithyDocumentSerde @@ -142,8 +159,10 @@ 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]. The participant token is valid + // for the lifetime of a chat participant. + // + // [CreateParticipantConnection]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html ParticipantToken *string // Metadata pertaining to the operation's result. diff --git a/service/connect/api_op_StartContactEvaluation.go b/service/connect/api_op_StartContactEvaluation.go index fc889e7d73d..0b6156ce2a0 100644 --- a/service/connect/api_op_StartContactEvaluation.go +++ b/service/connect/api_op_StartContactEvaluation.go @@ -14,8 +14,10 @@ import ( // given evaluation form for the particular contact. The evaluation form version // used for the contact evaluation corresponds to the currently activated version. // If no version is activated for the evaluation form, the contact evaluation -// cannot be started. Evaluations created through the public API do not contain -// answer values suggested from automation. +// cannot be started. +// +// Evaluations created through the public API do not contain answer values +// suggested from automation. func (c *Client) StartContactEvaluation(ctx context.Context, params *StartContactEvaluationInput, optFns ...func(*Options)) (*StartContactEvaluationOutput, error) { if params == nil { params = &StartContactEvaluationInput{} @@ -43,17 +45,19 @@ type StartContactEvaluationInput struct { // This member is required. EvaluationFormId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connect/api_op_StartContactRecording.go b/service/connect/api_op_StartContactRecording.go index c0698d85650..6c3b5c68a3d 100644 --- a/service/connect/api_op_StartContactRecording.go +++ b/service/connect/api_op_StartContactRecording.go @@ -12,8 +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. // @@ -22,9 +24,14 @@ import ( // StartContactRecording to restart it. For scenarios where the recording has // 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) -// block. Only voice recordings are supported at this time. +// ResumeContactRecording. +// +// You can use this API to override the recording behavior configured in the [Set recording behavior] +// block. +// +// Only voice recordings are supported at this time. +// +// [Set recording behavior]: https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html func (c *Client) StartContactRecording(ctx context.Context, params *StartContactRecordingInput, optFns ...func(*Options)) (*StartContactRecordingOutput, error) { if params == nil { params = &StartContactRecordingInput{} @@ -53,8 +60,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_StartContactStreaming.go b/service/connect/api_op_StartContactStreaming.go index acd90ca1142..f61faebc0af 100644 --- a/service/connect/api_op_StartContactStreaming.go +++ b/service/connect/api_op_StartContactStreaming.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Connect Administrator Guide. +// Initiates real-time message streaming for a new chat contact. +// +// For more information about message streaming, see [Enable real-time chat message streaming] in the Amazon Connect +// Administrator Guide. +// +// [Enable real-time chat message streaming]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html func (c *Client) StartContactStreaming(ctx context.Context, params *StartContactStreamingInput, optFns ...func(*Options)) (*StartContactStreamingOutput, error) { if params == nil { params = &StartContactStreamingInput{} @@ -38,9 +41,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ // // This member is required. ClientToken *string @@ -51,8 +54,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_StartOutboundVoiceContact.go b/service/connect/api_op_StartOutboundVoiceContact.go index e701c7fcd21..41c1174ee08 100644 --- a/service/connect/api_op_StartOutboundVoiceContact.go +++ b/service/connect/api_op_StartOutboundVoiceContact.go @@ -12,18 +12,26 @@ 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 -// 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) -// 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) -// . +// 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]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]. +// +// [Amazon Connect Service Quotas]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html +// [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{} @@ -46,6 +54,7 @@ type StartOutboundVoiceContactInput struct { // 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 // // This member is required. @@ -56,8 +65,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -67,9 +78,10 @@ type StartOutboundVoiceContactInput struct { // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes, and can be accessed in flows just like any other - // contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value - // pairs per contact. Attribute keys can include only alphanumeric, dash, and - // underscore characters. + // contact attributes. + // + // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. + // Attribute keys can include only alphanumeric, dash, and underscore characters. Attributes map[string]string // The campaign identifier of the outbound communication. @@ -77,10 +89,11 @@ 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, - // the contact ID is returned. + // field. For more information about idempotency, see [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. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A description of the voice contact that is shown to an agent in the Contact diff --git a/service/connect/api_op_StartTaskContact.go b/service/connect/api_op_StartTaskContact.go index 285810a3e2f..6b275979d8e 100644 --- a/service/connect/api_op_StartTaskContact.go +++ b/service/connect/api_op_StartTaskContact.go @@ -13,18 +13,26 @@ import ( ) // Initiates a flow to start a new task contact. For more information about task -// contacts, see Concepts: Tasks in Amazon Connect (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html) -// in the Amazon Connect Administrator Guide. When using PreviousContactId and -// RelatedContactId input parameters, note the following: +// contacts, see [Concepts: Tasks in Amazon Connect]in the Amazon Connect Administrator Guide. +// +// When using PreviousContactId and RelatedContactId input parameters, note the +// following: +// // - PreviousContactId +// // - Any updates to user-defined task contact attributes on any contact linked // through the same PreviousContactId will affect every contact in the chain. +// // - There can be a maximum of 12 linked task contacts in a chain. That is, 12 // task contacts can be created that share the same PreviousContactId . +// // - RelatedContactId +// // - Copies contact attributes from the related task contact to the new contact. +// // - Any update on attributes in a new task contact does not update attributes // on previous contact. +// // - There’s no limit on the number of task contacts that can be created that // use the same RelatedContactId . // @@ -34,11 +42,15 @@ import ( // it. If more than one parameter is specified, or only the TaskTemplateID is // specified but it does not have a flow configured, the request returns an error // because Amazon Connect cannot identify the unique flow to run when the task is -// created. A ServiceQuotaExceededException occurs when the number of open tasks -// exceeds the active tasks quota or there are already 12 tasks referencing the -// same PreviousContactId . For more information about service quotas for task -// contacts, see Amazon Connect service quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) -// in the Amazon Connect Administrator Guide. +// created. +// +// A ServiceQuotaExceededException occurs when the number of open tasks exceeds +// the active tasks quota or there are already 12 tasks referencing the same +// PreviousContactId . For more information about service quotas for task contacts, +// see [Amazon Connect service quotas]in the Amazon Connect Administrator Guide. +// +// [Amazon Connect service quotas]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html +// [Concepts: Tasks in Amazon Connect]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html func (c *Client) StartTaskContact(ctx context.Context, params *StartTaskContactInput, optFns ...func(*Options)) (*StartTaskContactOutput, error) { if params == nil { params = &StartTaskContactInput{} @@ -56,8 +68,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -69,16 +83,17 @@ type StartTaskContactInput struct { // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes, and can be accessed in flows just like any other - // contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value - // pairs per contact. Attribute keys can include only alphanumeric, dash, and - // underscore characters. + // contact attributes. + // + // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. + // Attribute keys can include only alphanumeric, dash, and underscore characters. Attributes map[string]string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The identifier of the flow for initiating the tasks. To see the ContactFlowId @@ -86,6 +101,7 @@ type StartTaskContactInput struct { // 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 @@ -101,8 +117,9 @@ type StartTaskContactInput struct { // The identifier for the quick connect. Tasks that are created by using // QuickConnectId will use the flow that is defined on agent or queue quick - // connect. For more information about quick connects, see Create quick connects (https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html) - // . + // connect. For more information about quick connects, see [Create quick connects]. + // + // [Create quick connects]: https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html QuickConnectId *string // A formatted URL that is shown to an agent in the Contact Control Panel (CCP). @@ -111,13 +128,14 @@ type StartTaskContactInput struct { // during task creation. References map[string]types.Reference - // The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks) - // to this contact. Linking tasks together by using RelatedContactID copies over - // contact attributes from the related task contact to the new task contact. All - // updates to user-defined attributes in the new task contact are limited to the - // individual contact ID, unlike what happens when tasks are linked by using - // PreviousContactID . There are no limits to the number of contacts that can be - // linked by using RelatedContactId . + // The contactId that is [related] to this contact. Linking tasks together by using + // RelatedContactID copies over contact attributes from the related task contact to + // the new task contact. All updates to user-defined attributes in the new task + // contact are limited to the individual contact ID, unlike what happens when tasks + // are linked by using PreviousContactID . There are no limits to the number of + // contacts that can be linked by using RelatedContactId . + // + // [related]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks RelatedContactId *string // The timestamp, in Unix Epoch seconds format, at which to start running the @@ -126,8 +144,9 @@ type StartTaskContactInput struct { ScheduledTime *time.Time // A unique identifier for the task template. For more information about task - // templates, see Create task templates (https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html) - // in the Amazon Connect Administrator Guide. + // templates, see [Create task templates]in the Amazon Connect Administrator Guide. + // + // [Create task templates]: https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html TaskTemplateId *string noSmithyDocumentSerde diff --git a/service/connect/api_op_StartWebRTCContact.go b/service/connect/api_op_StartWebRTCContact.go index 179b415f444..119f5091ff2 100644 --- a/service/connect/api_op_StartWebRTCContact.go +++ b/service/connect/api_op_StartWebRTCContact.go @@ -37,13 +37,16 @@ type StartWebRTCContactInput struct { // 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 // // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -59,17 +62,20 @@ type StartWebRTCContactInput struct { // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes, and can be accessed in flows just like any other - // contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value - // pairs per contact. Attribute keys can include only alphanumeric, -, and _ - // characters. + // contact attributes. + // + // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. + // Attribute keys can include only alphanumeric, -, and _ characters. Attributes map[string]string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (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, + // field. For more information about idempotency, see [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. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A description of the task that is shown to an agent in the Contact Control @@ -102,9 +108,10 @@ type StartWebRTCContactOutput struct { // participant is the same throughout the contact lifecycle. ParticipantId *string - // The token used by the contact participant to call the - // CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) - // API. The participant token is valid for the lifetime of a contact participant. + // The token used by the contact participant to call the [CreateParticipantConnection] API. The participant + // token is valid for the lifetime of a contact participant. + // + // [CreateParticipantConnection]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html ParticipantToken *string // Metadata pertaining to the operation's result. diff --git a/service/connect/api_op_StopContact.go b/service/connect/api_op_StopContact.go index 59e0f105713..fab4fd709a3 100644 --- a/service/connect/api_op_StopContact.go +++ b/service/connect/api_op_StopContact.go @@ -13,8 +13,11 @@ import ( // Ends the specified contact. Use this API to stop queued callbacks. It does not // work for voice contacts that use the following initiation methods: +// // - DISCONNECT +// // - TRANSFER +// // - QUEUE_TRANSFER // // Chat and task contacts can be terminated in any state, regardless of initiation @@ -41,8 +44,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_StopContactRecording.go b/service/connect/api_op_StopContactRecording.go index d6546e650ad..897a6e92580 100644 --- a/service/connect/api_op_StopContactRecording.go +++ b/service/connect/api_op_StopContactRecording.go @@ -15,8 +15,9 @@ import ( // 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. +// 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 +46,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_StopContactStreaming.go b/service/connect/api_op_StopContactStreaming.go index 5547e2dbd23..410b291cdc3 100644 --- a/service/connect/api_op_StopContactStreaming.go +++ b/service/connect/api_op_StopContactStreaming.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API. +// Ends message streaming on a specified contact. To restart message streaming on +// +// that contact, call the [StartContactStreaming]API. +// +// [StartContactStreaming]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html func (c *Client) StopContactStreaming(ctx context.Context, params *StopContactStreamingInput, optFns ...func(*Options)) (*StopContactStreamingOutput, error) { if params == nil { params = &StopContactStreamingInput{} @@ -36,8 +38,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_SubmitContactEvaluation.go b/service/connect/api_op_SubmitContactEvaluation.go index b27db5521a8..a8eff8a6199 100644 --- a/service/connect/api_op_SubmitContactEvaluation.go +++ b/service/connect/api_op_SubmitContactEvaluation.go @@ -15,8 +15,10 @@ import ( // included in the request are merged with existing answers for the given // evaluation. If no answers or notes are passed, the evaluation is submitted with // the existing answers and notes. You can delete an answer or note by passing an -// empty object ( {} ) to the question identifier. If a contact evaluation is -// already in submitted state, this operation will trigger a resubmission. +// empty object ( {} ) to the question identifier. +// +// If a contact evaluation is already in submitted state, this operation will +// trigger a resubmission. func (c *Client) SubmitContactEvaluation(ctx context.Context, params *SubmitContactEvaluationInput, optFns ...func(*Options)) (*SubmitContactEvaluationOutput, error) { if params == nil { params = &SubmitContactEvaluationInput{} @@ -39,8 +41,10 @@ type SubmitContactEvaluationInput struct { // This member is required. EvaluationId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_SuspendContactRecording.go b/service/connect/api_op_SuspendContactRecording.go index ca86f1c297f..2479522075e 100644 --- a/service/connect/api_op_SuspendContactRecording.go +++ b/service/connect/api_op_SuspendContactRecording.go @@ -15,9 +15,12 @@ import ( // recording or only screen recording is enabled, then it would be suspended. For // example, you might suspend the screen recording while collecting sensitive // information, such as a credit card number. Then use ResumeContactRecording to -// restart recording the screen. The period of time that the recording is suspended -// is filled with silence in the final recording. Voice and screen recordings are -// supported. +// restart recording the screen. +// +// The period of time that the recording is suspended is filled with silence in +// the final recording. +// +// Voice and screen recordings are supported. func (c *Client) SuspendContactRecording(ctx context.Context, params *SuspendContactRecordingInput, optFns ...func(*Options)) (*SuspendContactRecordingOutput, error) { if params == nil { params = &SuspendContactRecordingInput{} @@ -46,8 +49,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_TagContact.go b/service/connect/api_op_TagContact.go index 3dfefc98e1c..a9d82f850e1 100644 --- a/service/connect/api_op_TagContact.go +++ b/service/connect/api_op_TagContact.go @@ -11,9 +11,9 @@ import ( ) // Adds the specified tags to the contact resource. For more information about -// this API is used, see Set up granular billing for a detailed view of your -// Amazon Connect usage (https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html) -// . +// this API is used, see [Set up granular billing for a detailed view of your Amazon Connect usage]. +// +// [Set up granular billing for a detailed view of your Amazon Connect usage]: https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html func (c *Client) TagContact(ctx context.Context, params *TagContactInput, optFns ...func(*Options)) (*TagContactOutput, error) { if params == nil { params = &TagContactInput{} @@ -36,15 +36,18 @@ type TagContactInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // The tags to be assigned to the contact resource. For example, { "Tags": - // {"key1":"value1", "key2":"value2"} }. Authorization is not supported by this - // tag. + // {"key1":"value1", "key2":"value2"} }. + // + // Authorization is not supported by this tag. // // This member is required. Tags map[string]string diff --git a/service/connect/api_op_TagResource.go b/service/connect/api_op_TagResource.go index 66d9df0a260..b22b5ecbcff 100644 --- a/service/connect/api_op_TagResource.go +++ b/service/connect/api_op_TagResource.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Connect Administrator Guide. +// 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]. +// +// For sample policies that use tags, see [Amazon Connect Identity-Based Policy Examples] in the Amazon Connect Administrator +// Guide. +// +// [Amazon Connect Identity-Based Policy Examples]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html +// [Tagging resources in Amazon Connect]: https://docs.aws.amazon.com/connect/latest/adminguide/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/connect/api_op_TransferContact.go b/service/connect/api_op_TransferContact.go index faa11c8ef58..7fbae8ef404 100644 --- a/service/connect/api_op_TransferContact.go +++ b/service/connect/api_op_TransferContact.go @@ -14,13 +14,19 @@ import ( // point after a contact is created. You can transfer a contact to another queue by // providing the flow which orchestrates the contact to the destination queue. This // 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: +// 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. func (c *Client) TransferContact(ctx context.Context, params *TransferContactInput, optFns ...func(*Options)) (*TransferContactOutput, error) { if params == nil { @@ -49,17 +55,19 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The identifier for the queue. diff --git a/service/connect/api_op_UntagContact.go b/service/connect/api_op_UntagContact.go index 68b63fd7153..2941754d335 100644 --- a/service/connect/api_op_UntagContact.go +++ b/service/connect/api_op_UntagContact.go @@ -11,9 +11,9 @@ import ( ) // Removes the specified tags from the contact resource. For more information -// about this API is used, see Set up granular billing for a detailed view of your -// Amazon Connect usage (https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html) -// . +// about this API is used, see [Set up granular billing for a detailed view of your Amazon Connect usage]. +// +// [Set up granular billing for a detailed view of your Amazon Connect usage]: https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html func (c *Client) UntagContact(ctx context.Context, params *UntagContactInput, optFns ...func(*Options)) (*UntagContactOutput, error) { if params == nil { params = &UntagContactInput{} @@ -36,8 +36,10 @@ type UntagContactInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateAgentStatus.go b/service/connect/api_op_UpdateAgentStatus.go index fdd077efa92..bd23a67437b 100644 --- a/service/connect/api_op_UpdateAgentStatus.go +++ b/service/connect/api_op_UpdateAgentStatus.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates agent status. func (c *Client) UpdateAgentStatus(ctx context.Context, params *UpdateAgentStatusInput, optFns ...func(*Options)) (*UpdateAgentStatusOutput, error) { if params == nil { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContact.go b/service/connect/api_op_UpdateContact.go index ec3cd522224..aab7cf0296f 100644 --- a/service/connect/api_op_UpdateContact.go +++ b/service/connect/api_op_UpdateContact.go @@ -12,9 +12,11 @@ import ( ) // 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 +// 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. func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, optFns ...func(*Options)) (*UpdateContactOutput, error) { if params == nil { @@ -39,8 +41,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactAttributes.go b/service/connect/api_op_UpdateContactAttributes.go index b6a2ba190df..4cbb80fe72a 100644 --- a/service/connect/api_op_UpdateContactAttributes.go +++ b/service/connect/api_op_UpdateContactAttributes.go @@ -11,18 +11,23 @@ import ( ) // 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. +// 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]in the Amazon Connect Administrator +// Guide. +// +// [Feature specifications]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits func (c *Client) UpdateContactAttributes(ctx context.Context, params *UpdateContactAttributesInput, optFns ...func(*Options)) (*UpdateContactAttributesOutput, error) { if params == nil { params = &UpdateContactAttributesInput{} @@ -41,18 +46,23 @@ func (c *Client) UpdateContactAttributes(ctx context.Context, params *UpdateCont type UpdateContactAttributesInput struct { // The Amazon Connect attributes. These attributes can be accessed in flows just - // like any other contact attributes. You can have up to 32,768 UTF-8 bytes across - // all attributes for a contact. Attribute keys can include only alphanumeric, - // dash, and underscore characters. When the attributes for a contact exceed 32 KB, - // the contact is routed down the Error branch of the flow. As a mitigation, - // consider the following options: + // like any other contact attributes. + // + // You can have up to 32,768 UTF-8 bytes across all attributes for a contact. + // Attribute keys can include only alphanumeric, dash, and underscore characters. + // + // When the attributes for a contact exceed 32 KB, the contact is routed down the + // Error branch of the flow. As a mitigation, consider the following options: + // // - Remove unnecessary attributes by setting their values to empty. + // // - If the attributes are only used in one flow and don't need to be referred // to outside of that flow (for example, by a Lambda or another flow), then use // flow attributes. This way you aren't needlessly persisting the 32 KB of - // information from one flow to another. For more information, see Flow block: - // Set contact attributes (https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html) - // in the Amazon Connect Administrator Guide. + // information from one flow to another. For more information, see [Flow block: Set contact attributes]in the Amazon + // Connect Administrator Guide. + // + // [Flow block: Set contact attributes]: https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html // // This member is required. Attributes map[string]string @@ -63,8 +73,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactEvaluation.go b/service/connect/api_op_UpdateContactEvaluation.go index 1ceb2bf23b0..a60cc09f627 100644 --- a/service/connect/api_op_UpdateContactEvaluation.go +++ b/service/connect/api_op_UpdateContactEvaluation.go @@ -14,7 +14,8 @@ import ( // Updates details about a contact evaluation in the specified Amazon Connect // instance. A contact evaluation must be in draft state. Answers included in the // request are merged with existing answers for the given evaluation. An answer or -// note can be deleted by passing an empty object ( {} ) to the question identifier. +// note can be deleted by passing an empty object ( {} ) to the question +// identifier. func (c *Client) UpdateContactEvaluation(ctx context.Context, params *UpdateContactEvaluationInput, optFns ...func(*Options)) (*UpdateContactEvaluationOutput, error) { if params == nil { params = &UpdateContactEvaluationInput{} @@ -37,8 +38,10 @@ type UpdateContactEvaluationInput struct { // This member is required. EvaluationId *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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactFlowContent.go b/service/connect/api_op_UpdateContactFlowContent.go index 80737783c52..0c6c9bb8613 100644 --- a/service/connect/api_op_UpdateContactFlowContent.go +++ b/service/connect/api_op_UpdateContactFlowContent.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates the specified flow. +// +// You can also create and update flows using the [Amazon Connect Flow language]. +// +// [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{} @@ -35,9 +37,11 @@ type UpdateContactFlowContentInput struct { // This member is required. ContactFlowId *string - // The JSON string that represents the content of the flow. For an example, see - // Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) - // . Length Constraints: Minimum length of 1. Maximum length of 256000. + // The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language]. + // + // Length Constraints: Minimum length of 1. Maximum length of 256000. + // + // [Example 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 d1bf481ad10..245e6c06808 100644 --- a/service/connect/api_op_UpdateContactFlowMetadata.go +++ b/service/connect/api_op_UpdateContactFlowMetadata.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactFlowModuleContent.go b/service/connect/api_op_UpdateContactFlowModuleContent.go index a7b0aaf5539..75dff4dd549 100644 --- a/service/connect/api_op_UpdateContactFlowModuleContent.go +++ b/service/connect/api_op_UpdateContactFlowModuleContent.go @@ -33,15 +33,17 @@ type UpdateContactFlowModuleContentInput struct { // This member is required. ContactFlowModuleId *string - // The JSON string that represents the content of the flow. For an example, see - // Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) - // . + // The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language]. + // + // [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html // // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactFlowModuleMetadata.go b/service/connect/api_op_UpdateContactFlowModuleMetadata.go index 10e25def5b4..296f879487b 100644 --- a/service/connect/api_op_UpdateContactFlowModuleMetadata.go +++ b/service/connect/api_op_UpdateContactFlowModuleMetadata.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactFlowName.go b/service/connect/api_op_UpdateContactFlowName.go index 3d7113fe395..ef7bb296ca4 100644 --- a/service/connect/api_op_UpdateContactFlowName.go +++ b/service/connect/api_op_UpdateContactFlowName.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// The name of the flow. +// +// You can also create and update flows using the [Amazon Connect Flow language]. +// +// [Amazon 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_UpdateContactRoutingData.go b/service/connect/api_op_UpdateContactRoutingData.go index e6e677a360c..799c37aedb7 100644 --- a/service/connect/api_op_UpdateContactRoutingData.go +++ b/service/connect/api_op_UpdateContactRoutingData.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates routing priority and age on the contact (QueuePriority and // QueueTimeAdjustmentInSeconds). These properties can be used to change a // customer's position in the queue. For example, you can move a contact to the @@ -20,8 +21,9 @@ import ( // higher up in the first-in-first-out routing order. Note that adjusting the // routing age of a contact affects only its position in queue, and not its actual // queue wait time as reported through metrics. These properties can also be -// updated by using the Set routing priority / age flow block (https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html) -// . +// updated by using [the Set routing priority / age flow block]. +// +// [the Set routing priority / age flow block]: https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html func (c *Client) UpdateContactRoutingData(ctx context.Context, params *UpdateContactRoutingDataInput, optFns ...func(*Options)) (*UpdateContactRoutingDataOutput, error) { if params == nil { params = &UpdateContactRoutingDataInput{} @@ -44,8 +46,10 @@ type UpdateContactRoutingDataInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateContactSchedule.go b/service/connect/api_op_UpdateContactSchedule.go index 268311add7b..dfbce774dbc 100644 --- a/service/connect/api_op_UpdateContactSchedule.go +++ b/service/connect/api_op_UpdateContactSchedule.go @@ -34,8 +34,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateEvaluationForm.go b/service/connect/api_op_UpdateEvaluationForm.go index b7ce974fd29..45000bd7da4 100644 --- a/service/connect/api_op_UpdateEvaluationForm.go +++ b/service/connect/api_op_UpdateEvaluationForm.go @@ -13,8 +13,10 @@ import ( // Updates details about a specific evaluation form version in the specified // Amazon Connect instance. Question and section identifiers cannot be duplicated -// within the same evaluation form. This operation does not support partial -// updates. Instead it does a full update of evaluation form content. +// within the same evaluation form. +// +// This operation does not support partial updates. Instead it does a full update +// of evaluation form content. func (c *Client) UpdateEvaluationForm(ctx context.Context, params *UpdateEvaluationFormInput, optFns ...func(*Options)) (*UpdateEvaluationFormOutput, error) { if params == nil { params = &UpdateEvaluationFormInput{} @@ -42,8 +44,10 @@ type UpdateEvaluationFormInput struct { // This member is required. EvaluationFormVersion int32 - // The 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. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -61,9 +65,9 @@ type UpdateEvaluationFormInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A flag indicating whether the operation must create a new version. diff --git a/service/connect/api_op_UpdateHoursOfOperation.go b/service/connect/api_op_UpdateHoursOfOperation.go index b4257c93297..6e83fe5a119 100644 --- a/service/connect/api_op_UpdateHoursOfOperation.go +++ b/service/connect/api_op_UpdateHoursOfOperation.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the hours of operation. func (c *Client) UpdateHoursOfOperation(ctx context.Context, params *UpdateHoursOfOperationInput, optFns ...func(*Options)) (*UpdateHoursOfOperationOutput, error) { if params == nil { @@ -35,8 +36,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateInstanceAttribute.go b/service/connect/api_op_UpdateInstanceAttribute.go index d1c19d87d57..4f2fdd84b77 100644 --- a/service/connect/api_op_UpdateInstanceAttribute.go +++ b/service/connect/api_op_UpdateInstanceAttribute.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the value for the specified attribute type. func (c *Client) UpdateInstanceAttribute(ctx context.Context, params *UpdateInstanceAttributeInput, optFns ...func(*Options)) (*UpdateInstanceAttributeOutput, error) { if params == nil { @@ -30,15 +31,18 @@ func (c *Client) UpdateInstanceAttribute(ctx context.Context, params *UpdateInst type UpdateInstanceAttributeInput struct { - // The type of attribute. Only allowlisted customers can consume - // USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services - // Support for allowlisting. + // The type of attribute. + // + // Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this + // feature, contact Amazon Web Services Support for allowlisting. // // 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateInstanceStorageConfig.go b/service/connect/api_op_UpdateInstanceStorageConfig.go index ed47c00e751..64df3a84972 100644 --- a/service/connect/api_op_UpdateInstanceStorageConfig.go +++ b/service/connect/api_op_UpdateInstanceStorageConfig.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates an existing configuration for a resource type. This API is idempotent. func (c *Client) UpdateInstanceStorageConfig(ctx context.Context, params *UpdateInstanceStorageConfigInput, optFns ...func(*Options)) (*UpdateInstanceStorageConfigOutput, error) { if params == nil { @@ -36,8 +37,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateParticipantRoleConfig.go b/service/connect/api_op_UpdateParticipantRoleConfig.go index 101182aaa91..df499bec576 100644 --- a/service/connect/api_op_UpdateParticipantRoleConfig.go +++ b/service/connect/api_op_UpdateParticipantRoleConfig.go @@ -14,14 +14,18 @@ import ( // 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 // -// 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]. +// +// [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{} @@ -49,8 +53,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdatePhoneNumber.go b/service/connect/api_op_UpdatePhoneNumber.go index 9e950df4b3c..283ce730cc5 100644 --- a/service/connect/api_op_UpdatePhoneNumber.go +++ b/service/connect/api_op_UpdatePhoneNumber.go @@ -12,14 +12,18 @@ 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. After using this API, -// you must verify that the phone number is attached to the correct flow in the -// target instance or traffic distribution group. You need to do this because the -// API switches only the phone number to a new instance or traffic distribution -// group. It doesn't migrate the flow configuration of the phone number, too. 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) -// operation. +// distribution group in the same Amazon Web Services Region. +// +// After using this API, you must verify that the phone number is attached to the +// correct flow in the target instance or traffic distribution group. You need to +// do this because the API switches only the phone number to a new instance or +// traffic distribution group. It doesn't migrate the flow configuration of the +// phone number, too. +// +// You can call [DescribePhoneNumber] API to verify the status of a previous [UpdatePhoneNumber] operation. +// +// [UpdatePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html +// [DescribePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error) { if params == nil { params = &UpdatePhoneNumberInput{} @@ -44,15 +48,16 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The identifier of the Amazon Connect instance that phone numbers are claimed - // to. 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 must enter InstanceId or - // TargetArn . + // to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance. You must enter + // InstanceId or TargetArn . + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The Amazon Resource Name (ARN) for Amazon Connect instances or traffic diff --git a/service/connect/api_op_UpdatePhoneNumberMetadata.go b/service/connect/api_op_UpdatePhoneNumberMetadata.go index 49344ffa41d..eb5b0edeb84 100644 --- a/service/connect/api_op_UpdatePhoneNumberMetadata.go +++ b/service/connect/api_op_UpdatePhoneNumberMetadata.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a phone number’s metadata. To verify the status of a previous -// UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) -// API. +// Updates a phone number’s metadata. +// +// To verify the status of a previous UpdatePhoneNumberMetadata operation, call +// the [DescribePhoneNumber]API. +// +// [DescribePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html func (c *Client) UpdatePhoneNumberMetadata(ctx context.Context, params *UpdatePhoneNumberMetadataInput, optFns ...func(*Options)) (*UpdatePhoneNumberMetadataOutput, error) { if params == nil { params = &UpdatePhoneNumberMetadataInput{} @@ -37,9 +40,9 @@ type UpdatePhoneNumberMetadataInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the phone number. diff --git a/service/connect/api_op_UpdatePrompt.go b/service/connect/api_op_UpdatePrompt.go index 865b815207f..971527dc974 100644 --- a/service/connect/api_op_UpdatePrompt.go +++ b/service/connect/api_op_UpdatePrompt.go @@ -28,8 +28,10 @@ func (c *Client) UpdatePrompt(ctx context.Context, params *UpdatePromptInput, op type UpdatePromptInput 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -46,8 +48,9 @@ type UpdatePromptInput struct { Name *string // The URI for the S3 bucket where the prompt is stored. You can provide S3 - // pre-signed URLs returned by the GetPromptFile (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html) - // API instead of providing S3 URIs. + // pre-signed URLs returned by the [GetPromptFile]API instead of providing S3 URIs. + // + // [GetPromptFile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html S3Uri *string noSmithyDocumentSerde diff --git a/service/connect/api_op_UpdateQueueHoursOfOperation.go b/service/connect/api_op_UpdateQueueHoursOfOperation.go index d62ade9d360..fd16f0c9ff6 100644 --- a/service/connect/api_op_UpdateQueueHoursOfOperation.go +++ b/service/connect/api_op_UpdateQueueHoursOfOperation.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the hours of operation for the specified queue. func (c *Client) UpdateQueueHoursOfOperation(ctx context.Context, params *UpdateQueueHoursOfOperationInput, optFns ...func(*Options)) (*UpdateQueueHoursOfOperationOutput, error) { if params == nil { @@ -34,8 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateQueueMaxContacts.go b/service/connect/api_op_UpdateQueueMaxContacts.go index fb73dd9cbbe..e5ef335a74b 100644 --- a/service/connect/api_op_UpdateQueueMaxContacts.go +++ b/service/connect/api_op_UpdateQueueMaxContacts.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the maximum number of contacts allowed in a queue before it is // considered full. func (c *Client) UpdateQueueMaxContacts(ctx context.Context, params *UpdateQueueMaxContactsInput, optFns ...func(*Options)) (*UpdateQueueMaxContactsOutput, error) { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateQueueName.go b/service/connect/api_op_UpdateQueueName.go index 00aa6a5432b..bd71fbc89cb 100644 --- a/service/connect/api_op_UpdateQueueName.go +++ b/service/connect/api_op_UpdateQueueName.go @@ -11,6 +11,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the name and description of a queue. At least Name or Description must // be provided. func (c *Client) UpdateQueueName(ctx context.Context, params *UpdateQueueNameInput, optFns ...func(*Options)) (*UpdateQueueNameOutput, error) { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateQueueOutboundCallerConfig.go b/service/connect/api_op_UpdateQueueOutboundCallerConfig.go index 2dfcc66d54f..86cd934e175 100644 --- a/service/connect/api_op_UpdateQueueOutboundCallerConfig.go +++ b/service/connect/api_op_UpdateQueueOutboundCallerConfig.go @@ -12,8 +12,10 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the outbound caller ID name, number, and outbound whisper flow for a // specified queue. +// // - If the phone number is claimed to a traffic distribution group that was // created in the same Region as the Amazon Connect instance where you are calling // this API, then you can use a full phone number ARN or a UUID for @@ -23,15 +25,16 @@ import ( // 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 . +// // - Only use the phone number ARN format that doesn't contain instance in the // path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . -// This is the same ARN format that is returned when you call the -// ListPhoneNumbersV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) -// API. +// This is the same ARN format that is returned when you call the [ListPhoneNumbersV2]API. +// // - If you plan to use IAM policies to allow/deny access to this API for phone -// number resources claimed to a traffic distribution group, see Allow or Deny -// queue API actions for phone numbers in a replica Region (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region) -// . +// number resources claimed to a traffic distribution group, see [Allow or Deny queue API actions for phone numbers in a replica Region]. +// +// [ListPhoneNumbersV2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html +// [Allow or Deny queue API actions for phone numbers in a replica Region]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region func (c *Client) UpdateQueueOutboundCallerConfig(ctx context.Context, params *UpdateQueueOutboundCallerConfigInput, optFns ...func(*Options)) (*UpdateQueueOutboundCallerConfigOutput, error) { if params == nil { params = &UpdateQueueOutboundCallerConfigInput{} @@ -49,8 +52,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateQueueStatus.go b/service/connect/api_op_UpdateQueueStatus.go index 3fdd5d3b527..08ed91b8459 100644 --- a/service/connect/api_op_UpdateQueueStatus.go +++ b/service/connect/api_op_UpdateQueueStatus.go @@ -12,6 +12,7 @@ import ( ) // This API is in preview release for Amazon Connect and is subject to change. +// // Updates the status of the queue. func (c *Client) UpdateQueueStatus(ctx context.Context, params *UpdateQueueStatusInput, optFns ...func(*Options)) (*UpdateQueueStatusOutput, error) { if params == nil { @@ -30,8 +31,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateQuickConnectConfig.go b/service/connect/api_op_UpdateQuickConnectConfig.go index ebffdb765b8..b8b422870b4 100644 --- a/service/connect/api_op_UpdateQuickConnectConfig.go +++ b/service/connect/api_op_UpdateQuickConnectConfig.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateQuickConnectName.go b/service/connect/api_op_UpdateQuickConnectName.go index 740190a6347..2dc28d7442f 100644 --- a/service/connect/api_op_UpdateQuickConnectName.go +++ b/service/connect/api_op_UpdateQuickConnectName.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateRoutingProfileAgentAvailabilityTimer.go b/service/connect/api_op_UpdateRoutingProfileAgentAvailabilityTimer.go index 92870562c4a..e589c6276ec 100644 --- a/service/connect/api_op_UpdateRoutingProfileAgentAvailabilityTimer.go +++ b/service/connect/api_op_UpdateRoutingProfileAgentAvailabilityTimer.go @@ -36,8 +36,10 @@ type UpdateRoutingProfileAgentAvailabilityTimerInput struct { // This member is required. AgentAvailabilityTimer types.AgentAvailabilityTimer - // The 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. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateRoutingProfileConcurrency.go b/service/connect/api_op_UpdateRoutingProfileConcurrency.go index 5be60cf11df..46ee1ca30e5 100644 --- a/service/connect/api_op_UpdateRoutingProfileConcurrency.go +++ b/service/connect/api_op_UpdateRoutingProfileConcurrency.go @@ -30,8 +30,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go b/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go index 5a7377f47e1..73dca23934a 100644 --- a/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go +++ b/service/connect/api_op_UpdateRoutingProfileDefaultOutboundQueue.go @@ -33,8 +33,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateRoutingProfileName.go b/service/connect/api_op_UpdateRoutingProfileName.go index 7caf7bfbca3..b0caa6433fe 100644 --- a/service/connect/api_op_UpdateRoutingProfileName.go +++ b/service/connect/api_op_UpdateRoutingProfileName.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateRoutingProfileQueues.go b/service/connect/api_op_UpdateRoutingProfileQueues.go index e8f1467abb9..777c7cbabe8 100644 --- a/service/connect/api_op_UpdateRoutingProfileQueues.go +++ b/service/connect/api_op_UpdateRoutingProfileQueues.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateRule.go b/service/connect/api_op_UpdateRule.go index 5efddd0c306..91acf1fef96 100644 --- a/service/connect/api_op_UpdateRule.go +++ b/service/connect/api_op_UpdateRule.go @@ -11,9 +11,11 @@ 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) -// to code conditions for the rule. +// Updates a rule for the specified Amazon Connect instance. +// +// Use the [Rules Function language] to code conditions for the rule. +// +// [Rules Function language]: https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { params = &UpdateRuleInput{} @@ -41,8 +43,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateSecurityProfile.go b/service/connect/api_op_UpdateSecurityProfile.go index cef3c0932af..5132573507f 100644 --- a/service/connect/api_op_UpdateSecurityProfile.go +++ b/service/connect/api_op_UpdateSecurityProfile.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -59,8 +61,9 @@ type UpdateSecurityProfileInput struct { HierarchyRestrictedResources []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]. + // + // [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 7f46c66019a..23c461a319d 100644 --- a/service/connect/api_op_UpdateTaskTemplate.go +++ b/service/connect/api_op_UpdateTaskTemplate.go @@ -32,8 +32,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string @@ -99,8 +101,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The timestamp when the task template was last modified. diff --git a/service/connect/api_op_UpdateTrafficDistribution.go b/service/connect/api_op_UpdateTrafficDistribution.go index c4a06ab0643..10205331bd4 100644 --- a/service/connect/api_op_UpdateTrafficDistribution.go +++ b/service/connect/api_op_UpdateTrafficDistribution.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the traffic distribution for a given traffic distribution group. The -// SignInConfig distribution is available only on a default -// TrafficDistributionGroup (see the IsDefault parameter in the -// TrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) -// data type). If you call UpdateTrafficDistribution with a modified SignInConfig -// and a non-default TrafficDistributionGroup , an InvalidRequestException is -// returned. 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) -// in the Amazon Connect Administrator Guide. +// Updates the traffic distribution for a given traffic distribution group. +// +// The SignInConfig distribution is available only on a default +// TrafficDistributionGroup (see the IsDefault parameter in the [TrafficDistributionGroup] data type). If +// you call UpdateTrafficDistribution with a modified SignInConfig and a +// non-default TrafficDistributionGroup , an InvalidRequestException is returned. +// +// For more information about updating a traffic distribution group, see [Update telephony traffic distribution across Amazon Web Services Regions] in the +// Amazon Connect Administrator Guide. +// +// [TrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html +// [Update telephony traffic distribution across Amazon Web Services Regions]: https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html func (c *Client) UpdateTrafficDistribution(ctx context.Context, params *UpdateTrafficDistributionInput, optFns ...func(*Options)) (*UpdateTrafficDistributionOutput, error) { if params == nil { params = &UpdateTrafficDistributionInput{} diff --git a/service/connect/api_op_UpdateUserHierarchy.go b/service/connect/api_op_UpdateUserHierarchy.go index 9d6d067d0b4..5b7317c9722 100644 --- a/service/connect/api_op_UpdateUserHierarchy.go +++ b/service/connect/api_op_UpdateUserHierarchy.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateUserHierarchyGroupName.go b/service/connect/api_op_UpdateUserHierarchyGroupName.go index ec1c2a097e4..d453f7ed4c8 100644 --- a/service/connect/api_op_UpdateUserHierarchyGroupName.go +++ b/service/connect/api_op_UpdateUserHierarchyGroupName.go @@ -33,8 +33,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateUserHierarchyStructure.go b/service/connect/api_op_UpdateUserHierarchyStructure.go index 569480c75f7..ba5444db3c8 100644 --- a/service/connect/api_op_UpdateUserHierarchyStructure.go +++ b/service/connect/api_op_UpdateUserHierarchyStructure.go @@ -35,8 +35,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateUserIdentityInfo.go b/service/connect/api_op_UpdateUserIdentityInfo.go index 96443179d45..0994669809e 100644 --- a/service/connect/api_op_UpdateUserIdentityInfo.go +++ b/service/connect/api_op_UpdateUserIdentityInfo.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the Amazon Connect Administrator Guide. +// 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 password through email. For +// more information, see [Best Practices for Security Profiles]in the Amazon Connect Administrator Guide. +// +// [Best Practices for Security Profiles]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html func (c *Client) UpdateUserIdentityInfo(ctx context.Context, params *UpdateUserIdentityInfoInput, optFns ...func(*Options)) (*UpdateUserIdentityInfoOutput, error) { if params == nil { params = &UpdateUserIdentityInfoInput{} @@ -41,8 +43,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateUserPhoneConfig.go b/service/connect/api_op_UpdateUserPhoneConfig.go index abac7642f0d..7046ab9a9ff 100644 --- a/service/connect/api_op_UpdateUserPhoneConfig.go +++ b/service/connect/api_op_UpdateUserPhoneConfig.go @@ -29,8 +29,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateUserProficiencies.go b/service/connect/api_op_UpdateUserProficiencies.go index 8790073010b..aefe33dc428 100644 --- a/service/connect/api_op_UpdateUserProficiencies.go +++ b/service/connect/api_op_UpdateUserProficiencies.go @@ -29,7 +29,7 @@ func (c *Client) UpdateUserProficiencies(ctx context.Context, params *UpdateUser type UpdateUserProficienciesInput struct { - // The identifier of the Amazon Connect instance. You can find the instance ID in + // The identifier of the Amazon Connect instance. You can find the instance ID 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 8062f7dbf03..20121c63dec 100644 --- a/service/connect/api_op_UpdateUserRoutingProfile.go +++ b/service/connect/api_op_UpdateUserRoutingProfile.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateUserSecurityProfiles.go b/service/connect/api_op_UpdateUserSecurityProfiles.go index 51752941d09..9d67ef0444e 100644 --- a/service/connect/api_op_UpdateUserSecurityProfiles.go +++ b/service/connect/api_op_UpdateUserSecurityProfiles.go @@ -28,8 +28,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // This member is required. InstanceId *string diff --git a/service/connect/api_op_UpdateViewContent.go b/service/connect/api_op_UpdateViewContent.go index 6e74f676590..5accf50a082 100644 --- a/service/connect/api_op_UpdateViewContent.go +++ b/service/connect/api_op_UpdateViewContent.go @@ -12,10 +12,12 @@ import ( ) // Updates the view content of the given view identifier in the specified Amazon -// Connect instance. It performs content validation if Status is set to SAVED and -// performs full content validation if Status is PUBLISHED . Note that the $SAVED -// alias' content will always be updated, but the $LATEST alias' content will only -// be updated if Status is PUBLISHED . +// Connect instance. +// +// It performs content validation if Status is set to SAVED and performs full +// content validation if Status is PUBLISHED . Note that the $SAVED alias' content +// will always be updated, but the $LATEST alias' content will only be updated if +// Status is PUBLISHED . func (c *Client) UpdateViewContent(ctx context.Context, params *UpdateViewContentInput, optFns ...func(*Options)) (*UpdateViewContentOutput, error) { if params == nil { params = &UpdateViewContentInput{} @@ -35,7 +37,9 @@ type UpdateViewContentInput struct { // View content containing all content necessary to render a view except for // runtime input data and the runtime input schema, which is auto-generated by this - // operation. The total uncompressed content has a maximum file size of 400kB. + // operation. + // + // The total uncompressed content has a maximum file size of 400kB. // // This member is required. Content *types.ViewInputContent diff --git a/service/connect/doc.go b/service/connect/doc.go index e65cb908942..785036a6b03 100644 --- a/service/connect/doc.go +++ b/service/connect/doc.go @@ -5,14 +5,19 @@ // // Amazon Connect is a cloud-based contact center solution that you use to set up // and manage a customer contact center and provide reliable customer engagement at -// any scale. Amazon Connect provides metrics and real-time reporting that enable -// you to optimize contact routing. You can also resolve customer issues more -// 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) -// 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) -// . +// any scale. +// +// Amazon Connect provides metrics and real-time reporting that enable you to +// optimize contact routing. You can also resolve customer issues more 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]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]. +// +// [Amazon Connect Endpoints]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html +// [Amazon Connect Service Quotas]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html package connect diff --git a/service/connect/options.go b/service/connect/options.go index 637a92c76a4..9e4dd3738f4 100644 --- a/service/connect/options.go +++ b/service/connect/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/connect/types/enums.go b/service/connect/types/enums.go index ba64a2e196f..955ac48bc2b 100644 --- a/service/connect/types/enums.go +++ b/service/connect/types/enums.go @@ -17,8 +17,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "CREATE_TASK", @@ -41,8 +42,9 @@ const ( ) // Values returns all known values for AgentAvailabilityTimer. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentAvailabilityTimer) Values() []AgentAvailabilityTimer { return []AgentAvailabilityTimer{ "TIME_SINCE_LAST_ACTIVITY", @@ -59,8 +61,9 @@ const ( ) // Values returns all known values for AgentStatusState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentStatusState) Values() []AgentStatusState { return []AgentStatusState{ "ENABLED", @@ -78,8 +81,9 @@ const ( ) // Values returns all known values for AgentStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentStatusType) Values() []AgentStatusType { return []AgentStatusType{ "ROUTABLE", @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for ArtifactStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactStatus) Values() []ArtifactStatus { return []ArtifactStatus{ "APPROVED", @@ -119,8 +124,9 @@ const ( // Values returns all known values for AttachedFileInvalidRequestExceptionReason. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachedFileInvalidRequestExceptionReason) Values() []AttachedFileInvalidRequestExceptionReason { return []AttachedFileInvalidRequestExceptionReason{ "INVALID_FILE_SIZE", @@ -138,8 +144,9 @@ const ( ) // Values returns all known values for BehaviorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BehaviorType) Values() []BehaviorType { return []BehaviorType{ "ROUTE_CURRENT_CHANNEL_ONLY", @@ -157,8 +164,9 @@ const ( ) // Values returns all known values for Channel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Channel) Values() []Channel { return []Channel{ "VOICE", @@ -177,8 +185,9 @@ const ( ) // Values returns all known values for ChatEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChatEventType) Values() []ChatEventType { return []ChatEventType{ "DISCONNECT", @@ -195,8 +204,9 @@ const ( ) // Values returns all known values for Comparison. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Comparison) Values() []Comparison { return []Comparison{ "LT", @@ -212,8 +222,9 @@ const ( ) // Values returns all known values for ContactFlowModuleState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactFlowModuleState) Values() []ContactFlowModuleState { return []ContactFlowModuleState{ "ACTIVE", @@ -230,8 +241,9 @@ const ( ) // Values returns all known values for ContactFlowModuleStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactFlowModuleStatus) Values() []ContactFlowModuleStatus { return []ContactFlowModuleStatus{ "PUBLISHED", @@ -248,8 +260,9 @@ const ( ) // Values returns all known values for ContactFlowState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactFlowState) Values() []ContactFlowState { return []ContactFlowState{ "ACTIVE", @@ -273,8 +286,9 @@ const ( ) // Values returns all known values for ContactFlowType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactFlowType) Values() []ContactFlowType { return []ContactFlowType{ "CONTACT_FLOW", @@ -305,8 +319,9 @@ const ( ) // Values returns all known values for ContactInitiationMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactInitiationMethod) Values() []ContactInitiationMethod { return []ContactInitiationMethod{ "INBOUND", @@ -337,8 +352,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -373,8 +389,9 @@ const ( ) // Values returns all known values for CurrentMetricName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CurrentMetricName) Values() []CurrentMetricName { return []CurrentMetricName{ "AGENTS_ONLINE", @@ -403,8 +420,9 @@ const ( ) // Values returns all known values for DirectoryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryType) Values() []DirectoryType { return []DirectoryType{ "SAML", @@ -421,8 +439,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "KMS", @@ -439,8 +458,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "TELEPHONE_NUMBER", @@ -460,6 +480,7 @@ const ( // Values returns all known values for EvaluationFormQuestionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFormQuestionType) Values() []EvaluationFormQuestionType { return []EvaluationFormQuestionType{ @@ -479,6 +500,7 @@ const ( // Values returns all known values for EvaluationFormScoringMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFormScoringMode) Values() []EvaluationFormScoringMode { return []EvaluationFormScoringMode{ @@ -497,6 +519,7 @@ const ( // Values returns all known values for EvaluationFormScoringStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFormScoringStatus) Values() []EvaluationFormScoringStatus { return []EvaluationFormScoringStatus{ @@ -515,8 +538,9 @@ const ( // Values returns all known values for // EvaluationFormSingleSelectQuestionDisplayMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFormSingleSelectQuestionDisplayMode) Values() []EvaluationFormSingleSelectQuestionDisplayMode { return []EvaluationFormSingleSelectQuestionDisplayMode{ "DROPDOWN", @@ -534,6 +558,7 @@ const ( // Values returns all known values for EvaluationFormVersionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationFormVersionStatus) Values() []EvaluationFormVersionStatus { return []EvaluationFormVersionStatus{ @@ -551,8 +576,9 @@ const ( ) // Values returns all known values for EvaluationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationStatus) Values() []EvaluationStatus { return []EvaluationStatus{ "DRAFT", @@ -578,8 +604,9 @@ const ( ) // Values returns all known values for EventSourceName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourceName) Values() []EventSourceName { return []EventSourceName{ "OnPostCallAnalysisAvailable", @@ -613,8 +640,9 @@ const ( ) // Values returns all known values for FailureReasonCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureReasonCode) Values() []FailureReasonCode { return []FailureReasonCode{ "INVALID_ATTRIBUTE_KEY", @@ -641,8 +669,9 @@ const ( ) // Values returns all known values for FileStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileStatusType) Values() []FileStatusType { return []FileStatusType{ "APPROVED", @@ -660,8 +689,9 @@ const ( ) // Values returns all known values for FileUseCaseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileUseCaseType) Values() []FileUseCaseType { return []FileUseCaseType{ "ATTACHMENT", @@ -677,6 +707,7 @@ const ( // Values returns all known values for FlowAssociationResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FlowAssociationResourceType) Values() []FlowAssociationResourceType { return []FlowAssociationResourceType{ @@ -695,8 +726,9 @@ const ( ) // Values returns all known values for Grouping. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Grouping) Values() []Grouping { return []Grouping{ "QUEUE", @@ -715,8 +747,9 @@ const ( ) // Values returns all known values for HierarchyGroupMatchType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HierarchyGroupMatchType) Values() []HierarchyGroupMatchType { return []HierarchyGroupMatchType{ "EXACT", @@ -756,8 +789,9 @@ const ( ) // Values returns all known values for HistoricalMetricName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HistoricalMetricName) Values() []HistoricalMetricName { return []HistoricalMetricName{ "CONTACTS_QUEUED", @@ -802,8 +836,9 @@ const ( ) // Values returns all known values for HoursOfOperationDays. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HoursOfOperationDays) Values() []HoursOfOperationDays { return []HoursOfOperationDays{ "SUNDAY", @@ -834,8 +869,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INBOUND_CALLS", @@ -862,8 +898,9 @@ const ( ) // Values returns all known values for InstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStatus) Values() []InstanceStatus { return []InstanceStatus{ "CREATION_IN_PROGRESS", @@ -892,6 +929,7 @@ const ( // Values returns all known values for InstanceStorageResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStorageResourceType) Values() []InstanceStorageResourceType { return []InstanceStorageResourceType{ @@ -926,8 +964,9 @@ const ( ) // Values returns all known values for IntegrationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationType) Values() []IntegrationType { return []IntegrationType{ "EVENT", @@ -955,8 +994,9 @@ const ( ) // Values returns all known values for IntervalPeriod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntervalPeriod) Values() []IntervalPeriod { return []IntervalPeriod{ "FIFTEEN_MIN", @@ -977,8 +1017,9 @@ const ( ) // Values returns all known values for LexVersion. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LexVersion) Values() []LexVersion { return []LexVersion{ "V1", @@ -995,8 +1036,9 @@ const ( // Values returns all known values for ListFlowAssociationResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListFlowAssociationResourceType) Values() []ListFlowAssociationResourceType { return []ListFlowAssociationResourceType{ "VOICE_PHONE_NUMBER", @@ -1012,8 +1054,9 @@ const ( ) // Values returns all known values for MeetingFeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MeetingFeatureStatus) Values() []MeetingFeatureStatus { return []MeetingFeatureStatus{ "AVAILABLE", @@ -1030,8 +1073,9 @@ const ( ) // Values returns all known values for MonitorCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitorCapability) Values() []MonitorCapability { return []MonitorCapability{ "SILENT_MONITOR", @@ -1047,8 +1091,9 @@ const ( ) // Values returns all known values for NotificationContentType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationContentType) Values() []NotificationContentType { return []NotificationContentType{ "PLAIN_TEXT", @@ -1064,6 +1109,7 @@ const ( // 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{ @@ -1087,8 +1133,9 @@ const ( // Values returns all known values for NumericQuestionPropertyAutomationLabel. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumericQuestionPropertyAutomationLabel) Values() []NumericQuestionPropertyAutomationLabel { return []NumericQuestionPropertyAutomationLabel{ "OVERALL_CUSTOMER_SENTIMENT_SCORE", @@ -1114,8 +1161,9 @@ const ( ) // Values returns all known values for ParticipantRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantRole) Values() []ParticipantRole { return []ParticipantRole{ "AGENT", @@ -1134,8 +1182,9 @@ const ( ) // Values returns all known values for ParticipantTimerAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantTimerAction) Values() []ParticipantTimerAction { return []ParticipantTimerAction{ "Unset", @@ -1151,8 +1200,9 @@ const ( ) // Values returns all known values for ParticipantTimerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantTimerType) Values() []ParticipantTimerType { return []ParticipantTimerType{ "IDLE", @@ -1404,8 +1454,9 @@ const ( ) // Values returns all known values for PhoneNumberCountryCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberCountryCode) Values() []PhoneNumberCountryCode { return []PhoneNumberCountryCode{ "AF", @@ -1662,8 +1713,9 @@ const ( ) // Values returns all known values for PhoneNumberType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberType) Values() []PhoneNumberType { return []PhoneNumberType{ "TOLL_FREE", @@ -1687,6 +1739,7 @@ const ( // Values returns all known values for PhoneNumberWorkflowStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PhoneNumberWorkflowStatus) Values() []PhoneNumberWorkflowStatus { return []PhoneNumberWorkflowStatus{ @@ -1705,8 +1758,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1728,8 +1782,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyValidationExceptionReason) Values() []PropertyValidationExceptionReason { return []PropertyValidationExceptionReason{ "INVALID_FORMAT", @@ -1750,8 +1805,9 @@ const ( ) // Values returns all known values for QueueStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueStatus) Values() []QueueStatus { return []QueueStatus{ "ENABLED", @@ -1768,8 +1824,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1787,8 +1844,9 @@ const ( ) // Values returns all known values for QuickConnectType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuickConnectType) Values() []QuickConnectType { return []QuickConnectType{ "USER", @@ -1807,8 +1865,9 @@ const ( // Values returns all known values for RealTimeContactAnalysisOutputType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealTimeContactAnalysisOutputType) Values() []RealTimeContactAnalysisOutputType { return []RealTimeContactAnalysisOutputType{ "Raw", @@ -1829,8 +1888,9 @@ const ( // Values returns all known values for RealTimeContactAnalysisSegmentType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealTimeContactAnalysisSegmentType) Values() []RealTimeContactAnalysisSegmentType { return []RealTimeContactAnalysisSegmentType{ "Transcript", @@ -1852,8 +1912,9 @@ const ( // Values returns all known values for RealTimeContactAnalysisSentimentLabel. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealTimeContactAnalysisSentimentLabel) Values() []RealTimeContactAnalysisSentimentLabel { return []RealTimeContactAnalysisSentimentLabel{ "POSITIVE", @@ -1873,8 +1934,9 @@ const ( // Values returns all known values for RealTimeContactAnalysisStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealTimeContactAnalysisStatus) Values() []RealTimeContactAnalysisStatus { return []RealTimeContactAnalysisStatus{ "IN_PROGRESS", @@ -1893,8 +1955,9 @@ const ( // Values returns all known values for RealTimeContactAnalysisSupportedChannel. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealTimeContactAnalysisSupportedChannel) Values() []RealTimeContactAnalysisSupportedChannel { return []RealTimeContactAnalysisSupportedChannel{ "VOICE", @@ -1911,8 +1974,9 @@ const ( ) // Values returns all known values for ReferenceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceStatus) Values() []ReferenceStatus { return []ReferenceStatus{ "APPROVED", @@ -1933,8 +1997,9 @@ const ( ) // Values returns all known values for ReferenceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceType) Values() []ReferenceType { return []ReferenceType{ "URL", @@ -1955,8 +2020,9 @@ const ( ) // Values returns all known values for RehydrationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RehydrationType) Values() []RehydrationType { return []RehydrationType{ "ENTIRE_PAST_SESSION", @@ -1979,8 +2045,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2003,8 +2070,9 @@ const ( ) // Values returns all known values for RulePublishStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RulePublishStatus) Values() []RulePublishStatus { return []RulePublishStatus{ "DRAFT", @@ -2020,8 +2088,9 @@ const ( ) // Values returns all known values for SearchableQueueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchableQueueType) Values() []SearchableQueueType { return []SearchableQueueType{ "STANDARD", @@ -2037,8 +2106,9 @@ const ( ) // Values returns all known values for SearchContactsMatchType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchContactsMatchType) Values() []SearchContactsMatchType { return []SearchContactsMatchType{ "MATCH_ALL", @@ -2058,6 +2128,7 @@ const ( // Values returns all known values for SearchContactsTimeRangeType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SearchContactsTimeRangeType) Values() []SearchContactsTimeRangeType { return []SearchContactsTimeRangeType{ @@ -2078,8 +2149,9 @@ const ( // Values returns all known values for // SingleSelectQuestionRuleCategoryAutomationCondition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SingleSelectQuestionRuleCategoryAutomationCondition) Values() []SingleSelectQuestionRuleCategoryAutomationCondition { return []SingleSelectQuestionRuleCategoryAutomationCondition{ "PRESENT", @@ -2100,8 +2172,9 @@ const ( ) // Values returns all known values for SortableFieldName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortableFieldName) Values() []SortableFieldName { return []SortableFieldName{ "INITIATION_TIMESTAMP", @@ -2122,8 +2195,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2141,8 +2215,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "SALESFORCE", @@ -2161,8 +2236,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2182,8 +2258,9 @@ const ( ) // Values returns all known values for StorageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageType) Values() []StorageType { return []StorageType{ "S3", @@ -2203,8 +2280,9 @@ const ( ) // Values returns all known values for StringComparisonType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StringComparisonType) Values() []StringComparisonType { return []StringComparisonType{ "STARTS_WITH", @@ -2232,8 +2310,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NAME", @@ -2260,8 +2339,9 @@ const ( ) // Values returns all known values for TaskTemplateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskTemplateStatus) Values() []TaskTemplateStatus { return []TaskTemplateStatus{ "ACTIVE", @@ -2279,8 +2359,9 @@ const ( // Values returns all known values for TimerEligibleParticipantRoles. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimerEligibleParticipantRoles) Values() []TimerEligibleParticipantRoles { return []TimerEligibleParticipantRoles{ "CUSTOMER", @@ -2302,8 +2383,9 @@ const ( // Values returns all known values for TrafficDistributionGroupStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficDistributionGroupStatus) Values() []TrafficDistributionGroupStatus { return []TrafficDistributionGroupStatus{ "CREATION_IN_PROGRESS", @@ -2324,8 +2406,9 @@ const ( ) // Values returns all known values for TrafficType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficType) Values() []TrafficType { return []TrafficType{ "GENERAL", @@ -2343,8 +2426,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "SECONDS", @@ -2362,8 +2446,9 @@ const ( ) // Values returns all known values for UseCaseType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UseCaseType) Values() []UseCaseType { return []UseCaseType{ "RULES_EVALUATION", @@ -2379,8 +2464,9 @@ const ( ) // Values returns all known values for VideoCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoCapability) Values() []VideoCapability { return []VideoCapability{ "SEND", @@ -2396,8 +2482,9 @@ const ( ) // Values returns all known values for ViewStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViewStatus) Values() []ViewStatus { return []ViewStatus{ "PUBLISHED", @@ -2414,8 +2501,9 @@ const ( ) // Values returns all known values for ViewType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViewType) Values() []ViewType { return []ViewType{ "CUSTOMER_MANAGED", @@ -2453,8 +2541,9 @@ const ( ) // Values returns all known values for VocabularyLanguageCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VocabularyLanguageCode) Values() []VocabularyLanguageCode { return []VocabularyLanguageCode{ "ar-AE", @@ -2494,8 +2583,9 @@ const ( ) // Values returns all known values for VocabularyState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VocabularyState) Values() []VocabularyState { return []VocabularyState{ "CREATION_IN_PROGRESS", @@ -2515,8 +2605,9 @@ const ( ) // Values returns all known values for VoiceRecordingTrack. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceRecordingTrack) Values() []VoiceRecordingTrack { return []VoiceRecordingTrack{ "FROM_AGENT", diff --git a/service/connect/types/types.go b/service/connect/types/types.go index f3b5fe7e5cf..dbe1e625981 100644 --- a/service/connect/types/types.go +++ b/service/connect/types/types.go @@ -29,14 +29,18 @@ type AgentConfig struct { noSmithyDocumentSerde } -// Information about the contact (https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html) -// associated to the user. +// Information about the [contact] associated to the user. +// +// [contact]: https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html type AgentContactReference struct { - // The state of the contact (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html) - // . When AgentContactState is set to CONNECTED_ONHOLD , StateStartTimestamp is - // not changed. Instead, StateStartTimestamp reflects the time the contact was + // The [state of the contact]. + // + // When AgentContactState is set to CONNECTED_ONHOLD , StateStartTimestamp is not + // changed. Instead, StateStartTimestamp reflects the time the contact was // CONNECTED to the agent. + // + // [state of the contact]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html AgentContactState ContactState // The channel of the contact. @@ -61,9 +65,10 @@ type AgentContactReference struct { } // A structure that defines search criteria for contacts using agent hierarchy -// group levels. 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. +// group levels. For more information about agent hierarchies, see [Set Up Agent Hierarchies]in the Amazon +// Connect Administrator Guide. +// +// [Set Up Agent Hierarchies]: https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html type AgentHierarchyGroups struct { // The identifiers for level 1 hierarchy groups. @@ -188,6 +193,7 @@ type AllowedCapabilities struct { } // This API is in preview release for Amazon Connect and is subject to change. +// // Information about associations that are successfully created: DataSetId , // TargetAccountId , ResourceShareId , ResourceShareArn . type AnalyticsDataAssociationResult struct { @@ -220,8 +226,9 @@ type AnswerMachineDetectionConfig struct { noSmithyDocumentSerde } -// This API is in preview release for Amazon Connect and is subject to change. A -// third-party application's metadata. +// This API is in preview release for Amazon Connect and is subject to change. +// +// A third-party application's metadata. type Application struct { // The permissions that the agent is granted on the application. Only the ACCESS @@ -237,7 +244,9 @@ type Application struct { // This action must be set if TriggerEventSource is one of the following values: // OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | // OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable . Contact is -// categorized using the rule name. RuleName is used as ContactCategory . +// categorized using the rule name. +// +// RuleName is used as ContactCategory . type AssignContactCategoryActionDefinition struct { noSmithyDocumentSerde } @@ -277,8 +286,12 @@ type AttachedFile struct { // This member is required. FileStatus FileStatusType - // The resource to which the attached file is (being) uploaded to. Cases (https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) - // are the only current supported resource. This value must be a valid ARN. + // The resource to which the attached file is (being) uploaded to. [Cases] are the only + // current supported resource. + // + // This value must be a valid ARN. + // + // [Cases]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html AssociatedResourceArn *string // Represents the identity that created the file. @@ -298,7 +311,7 @@ type AttachedFile struct { // BatchGetAttachedFileMetadata action. type AttachedFileError struct { - // Status code describing the failure. + // Status code describing the failure. ErrorCode *string // Why the attached file couldn't be retrieved. @@ -398,8 +411,11 @@ type Campaign struct { // Chat integration event containing payload to perform different chat actions // such as: +// // - Sending a chat message +// // - Sending a chat event, such as typing +// // - Disconnecting from a chat type ChatEvent struct { @@ -410,19 +426,27 @@ type ChatEvent struct { // Content of the message or event. This is required when Type is MESSAGE and for // certain ContentTypes when Type is EVENT . - // - For allowed message content, see the Content parameter in the SendMessage (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html) - // topic in the Amazon Connect Participant Service API Reference. - // - For allowed event content, see the Content parameter in the SendEvent (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html) - // topic in the Amazon Connect Participant Service API Reference. + // + // - For allowed message content, see the Content parameter in the [SendMessage]topic in the + // Amazon Connect Participant Service API Reference. + // + // - For allowed event content, see the Content parameter in the [SendEvent]topic in the + // Amazon Connect Participant Service API Reference. + // + // [SendEvent]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html + // [SendMessage]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html Content *string // Type of content. This is required when Type is MESSAGE or EVENT . - // - For allowed message content types, see the ContentType parameter in the - // SendMessage (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html) - // topic in the Amazon Connect Participant Service API Reference. - // - For allowed event content types, see the ContentType parameter in the - // SendEvent (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html) + // + // - For allowed message content types, see the ContentType parameter in the [SendMessage] // topic in the Amazon Connect Participant Service API Reference. + // + // - For allowed event content types, see the ContentType parameter in the [SendEvent]topic + // in the Amazon Connect Participant Service API Reference. + // + // [SendEvent]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html + // [SendMessage]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html ContentType *string noSmithyDocumentSerde @@ -432,10 +456,13 @@ type ChatEvent 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 application/vnd.amazonaws.connect.message.interactive.response , the // Length Constraints are Minimum of 1, Maximum of 12288. // @@ -482,8 +509,9 @@ type ChatStreamingConfiguration struct { type ClaimedPhoneNumberSummary struct { // The identifier of the Amazon Connect instance that phone numbers are claimed - // to. 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. + // to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The phone number. Phone numbers are formatted [+] [country code] [subscriber @@ -503,25 +531,28 @@ type ClaimedPhoneNumberSummary struct { PhoneNumberId *string // The status of the phone number. - // - CLAIMED means the previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) - // or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) - // operation succeeded. - // - IN_PROGRESS means a ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) - // , UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) - // , or UpdatePhoneNumberMetadata (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.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 ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.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 [ClaimPhoneNumber]or [UpdatePhoneNumber]operation succeeded. + // + // - IN_PROGRESS means a [ClaimPhoneNumber], [UpdatePhoneNumber], or [UpdatePhoneNumberMetadata]operation is still in progress and has not yet + // completed. You can call [DescribePhoneNumber]at a later time to verify if the previous operation + // has completed. + // + // - FAILED indicates that the previous [ClaimPhoneNumber]or [UpdatePhoneNumber]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. + // + // [UpdatePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html + // [UpdatePhoneNumberMetadata]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html + // [ClaimPhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html + // [DescribePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html PhoneNumberStatus *PhoneNumberStatus // The type of phone number. @@ -623,8 +654,9 @@ type Contact struct { // valid integer value. QueueTimeAdjustmentSeconds *int32 - // The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid) - // to this contact. + // The contactId that is [related] to this contact. + // + // [related]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid RelatedContactId *string // The timestamp, in Unix epoch time format, at which to start running the inbound @@ -684,12 +716,14 @@ type ContactDataRequest 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]. +// +// [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]. + // + // [contact states]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html ContactStates []ContactState noSmithyDocumentSerde @@ -701,9 +735,11 @@ type ContactFlow struct { // The Amazon Resource Name (ARN) of the flow. Arn *string - // The JSON string that represents the content of the flow. For an example, see - // Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) - // . Length Constraints: Minimum length of 1. Maximum length of 256000. + // The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language]. + // + // Length Constraints: Minimum length of 1. Maximum length of 256000. + // + // [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html Content *string // The description of the flow. @@ -722,9 +758,10 @@ 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) - // in the Amazon Connect Administrator Guide. + // The type of the flow. For descriptions of the available types, see [Choose a flow type] in the + // Amazon Connect Administrator Guide. + // + // [Choose a flow type]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types Type ContactFlowType noSmithyDocumentSerde @@ -736,9 +773,9 @@ type ContactFlowModule struct { // The Amazon Resource Name (ARN). Arn *string - // The JSON string that represents the content of the flow. For an example, see - // Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html) - // . + // The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language]. + // + // [Example flow in Amazon Connect Flow language]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html Content *string // The description of the flow module. @@ -781,9 +818,11 @@ type ContactFlowModuleSummary struct { noSmithyDocumentSerde } -// 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) -// . +// Contains summary information about a flow. +// +// You can also create and update flows using the [Amazon Connect Flow language]. +// +// [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. @@ -878,7 +917,9 @@ type ContactSearchSummaryQueueInfo struct { // 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. type ControlPlaneTagFilter struct { @@ -895,10 +936,13 @@ type ControlPlaneTagFilter struct { } // An object that can be used to specify Tag conditions or Hierarchy Group -// conditions inside the SearchFilter . This accepts an OR of AND (List of List) -// input where: +// conditions inside the SearchFilter . +// +// This accepts an OR of AND (List of List) input where: +// // - The top level list specifies conditions that need to be applied with OR // operator +// // - The inner list specifies conditions that need to be applied with AND // operator. // @@ -959,8 +1003,9 @@ type CreatedByInfoMemberAWSIdentityArn struct { func (*CreatedByInfoMemberAWSIdentityArn) isCreatedByInfo() {} -// An agent ARN representing a connect user (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-resources-for-iam-policies) -// . +// An agent ARN representing a [connect user]. +// +// [connect user]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-resources-for-iam-policies type CreatedByInfoMemberConnectUserArn struct { Value string @@ -1002,8 +1047,9 @@ type CrossChannelBehavior struct { } // 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. +// metric, see [Real-time Metrics Definitions]in the Amazon Connect Administrator Guide. +// +// [Real-time Metrics Definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html type CurrentMetric struct { // The name of the metric. @@ -1068,14 +1114,18 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html // // 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?] + // + // [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html // // This member is required. LanguageCode VocabularyLanguageCode @@ -1175,10 +1225,14 @@ type EncryptionConfig struct { // This member is required. EncryptionType EncryptionType - // 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) - // . + // 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] + // SYMMETRIC_DEFAULT . + // + // [SYMMETRIC_DEFAULT]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default // // This member is required. KeyId *string @@ -1204,6 +1258,7 @@ type Endpoint struct { } // This API is in preview release for Amazon Connect and is subject to change. +// // List of errors for dataset association failures. type ErrorResult struct { @@ -1768,7 +1823,7 @@ type EvaluationFormSummary struct { // The version of the active evaluation form version. ActiveVersion *int32 - // The Amazon Resource Name (ARN) of the user who last activated the evaluation + // The Amazon Resource Name (ARN) of the user who last activated the evaluation // form. LastActivatedBy *string @@ -1854,11 +1909,12 @@ type EvaluationMetadata struct { // Information about notes for a contact evaluation. type EvaluationNote struct { - // The note for an item (section or question) in a contact evaluation. Even though - // a note in an evaluation can have up to 3072 chars, there is also a limit on the - // total number of chars for all the notes in the evaluation combined. Assuming - // there are N questions in the evaluation being submitted, then the max char limit - // for all notes combined is N x 1024. + // The note for an item (section or question) in a contact evaluation. + // + // Even though a note in an evaluation can have up to 3072 chars, there is also a + // limit on the total number of chars for all the notes in the evaluation combined. + // Assuming there are N questions in the evaluation being submitted, then the max + // char limit for all notes combined is N x 1024. Value *string noSmithyDocumentSerde @@ -2011,8 +2067,9 @@ 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) -// API. +// Contains the filter to apply when retrieving metrics with the [GetMetricDataV2] API. +// +// [GetMetricDataV2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html type FilterV2 struct { // The key to use for filtering data. For example, QUEUE , ROUTING_PROFILE, AGENT , @@ -2236,8 +2293,9 @@ 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) -// in the Amazon Connect Administrator Guide. +// metric, see [Historical Metrics Definitions]in the Amazon Connect Administrator Guide. +// +// [Historical Metrics Definitions]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html type HistoricalMetric struct { // The name of the metric. @@ -2343,9 +2401,10 @@ type HoursOfOperationSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []HoursOfOperationSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name , description , timezone , and - // resourceID . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name , description , timezone , + // and resourceID . StringCondition *StringCondition noSmithyDocumentSerde @@ -2356,7 +2415,9 @@ type HoursOfOperationSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter @@ -2409,8 +2470,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html Id *string // The identity management type. @@ -2518,8 +2581,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The Amazon Resource Name (ARN) for the AppIntegration. @@ -2551,22 +2616,29 @@ type IntervalDetails struct { // IntervalPeriod : An aggregated grouping applied to request metrics. Valid // IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL - // . For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and EndTime + // . + // + // For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and EndTime // differs by 1 day, then Amazon Connect returns 48 results in the response. Each // result is aggregated by the THIRTY_MIN period. By default Amazon Connect - // aggregates results based on the TOTAL interval period. The following list - // describes restrictions on StartTime and EndTime based on what IntervalPeriod is - // requested. + // aggregates results based on the TOTAL interval period. + // + // The following list describes restrictions on StartTime and EndTime based on + // what IntervalPeriod is requested. + // // - FIFTEEN_MIN : The difference between StartTime and EndTime must be less than // 3 days. + // // - THIRTY_MIN : The difference between StartTime and EndTime must be less than // 3 days. - // - HOUR : The difference between StartTime and EndTime must be less than 3 - // days. - // - DAY : The difference between StartTime and EndTime must be less than 35 - // days. + // + // - HOUR : The difference between StartTime and EndTime must be less than 3 days. + // + // - DAY : The difference between StartTime and EndTime must be less than 35 days. + // // - WEEK : The difference between StartTime and EndTime must be less than 35 // days. + // // - TOTAL : The difference between StartTime and EndTime must be less than 35 // days. IntervalPeriod IntervalPeriod @@ -2641,8 +2713,9 @@ type KinesisVideoStreamConfig struct { Prefix *string // The number of hours data is retained in the stream. Kinesis Video Streams - // retains the data in a data store that is associated with the stream. The default - // value is 0, indicating that the stream does not persist data. + // retains the data in a data store that is associated with the stream. + // + // The default value is 0, indicating that the stream does not persist data. // // This member is required. RetentionPeriodHours int32 @@ -2692,8 +2765,9 @@ type LexV2Bot struct { type ListPhoneNumbersSummary struct { // The identifier of the Amazon Connect instance that phone numbers are claimed - // to. 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. + // to. You can [find the instance ID]in the Amazon Resource Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // The phone number. Phone numbers are formatted [+] [country code] [subscriber @@ -2736,10 +2810,13 @@ type MediaConcurrency struct { // This member is required. 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 - // 1. Maximum value of 10. + // 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 1. Maximum value of 10. // // This member is required. Concurrency *int32 @@ -2819,16 +2896,21 @@ type MetricDataV2 struct { // , CONTACTS_CREATED , CONTACTS_HANDLED , SUM_CONTACTS_DISCONNECTED . type MetricFilterV2 struct { - // The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD , - // DISCONNECT_REASON . These are the same values as the InitiationMethod and - // DisconnectReason in the contact record. For more information, see - // ContactTraceRecord (https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord) - // in the Amazon Connect Administrator's Guide. + // The key to use for filtering data. + // + // Valid metric filter keys: INITIATION_METHOD , DISCONNECT_REASON . These are the + // same values as the InitiationMethod and DisconnectReason in the contact record. + // For more information, see [ContactTraceRecord]in the Amazon Connect Administrator's Guide. + // + // [ContactTraceRecord]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord 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 | + // 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 | // AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | // CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API MetricFilterValues []string @@ -2882,8 +2964,9 @@ type MetricV2 struct { // Contains the filters to be used when returning data. MetricFilters []MetricFilterV2 - // The name of the metric. This parameter is required. The following Required = No - // is incorrect. + // The name of the metric. + // + // This parameter is required. The following Required = No is incorrect. Name *string // Contains information about the threshold for service level metrics. @@ -2895,11 +2978,12 @@ type MetricV2 struct { // Payload of chat properties to apply when starting a new contact. type NewSessionDetails struct { - // A custom key-value pair using an attribute map. The attributes are standard + // A custom key-value pair using an attribute map. The attributes are standard // Amazon Connect attributes. They can be accessed in flows just like any other - // contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value - // pairs per contact. Attribute keys can include only alphanumeric, dash, and - // underscore characters. + // contact attributes. + // + // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. + // Attribute keys can include only alphanumeric, dash, and underscore characters. Attributes map[string]string // The customer's details. @@ -2908,14 +2992,15 @@ type NewSessionDetails struct { // The streaming configuration, such as the Amazon SNS streaming endpoint. StreamingConfiguration *ChatStreamingConfiguration - // The supported chat message content types. Supported types are text/plain , + // 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 . + // + // 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] . SupportedMessagingContentTypes []string @@ -2951,11 +3036,15 @@ type NumberReference struct { // Information about the property value used in automation of a numeric questions. // Label values are associated with minimum and maximum values for the numeric // question. +// // - Sentiment scores have a minimum value of -5 and maximum value of 5. +// // - Duration labels, such as NON_TALK_TIME , CONTACT_DURATION , // AGENT_INTERACTION_DURATION , CUSTOMER_HOLD_TIME have a minimum value of 0 and // maximum value of 28800. +// // - Percentages have a minimum value of 0 and maximum value of 100. +// // - NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000. type NumericQuestionPropertyValueAutomation struct { @@ -3018,9 +3107,11 @@ type ParticipantDetailsToAdd 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) -// . +// chain, for example, transfer contacts. +// +// For more information about how chat timeouts work, see [Set up chat timeouts for human participants]. +// +// [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. @@ -3045,15 +3136,16 @@ type ParticipantTimerConfiguration struct { } // 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) -// . +// 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]. // // The following types satisfy this interface: // // ParticipantTimerValueMemberParticipantTimerAction // ParticipantTimerValueMemberParticipantTimerDurationInMinutes +// +// [Set up chat timeouts for human participants]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html type ParticipantTimerValue interface { isParticipantTimerValue() } @@ -3084,29 +3176,34 @@ type ParticipantTokenCredentials struct { // yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. Expiry *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]. The participant token is valid + // for the lifetime of a chat participant. + // + // [CreateParticipantConnection]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html ParticipantToken *string noSmithyDocumentSerde } // 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) -// . +// and for example use cases and how to configure for them, see [Enable persistent chat]. +// +// [Enable persistent 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. RehydrationType RehydrationType @@ -3129,23 +3226,25 @@ type PhoneNumberQuickConnectConfig struct { } // The status of the phone number. -// - CLAIMED means the previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) -// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) -// operation succeeded. -// - IN_PROGRESS means a ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) -// , UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) -// , or UpdatePhoneNumberMetadata (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.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 ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.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 [ClaimPhoneNumber]or [UpdatePhoneNumber]operation succeeded. +// +// - IN_PROGRESS means a [ClaimPhoneNumber], [UpdatePhoneNumber], or [UpdatePhoneNumberMetadata]operation is still in progress and has not yet +// completed. You can call [DescribePhoneNumber]at a later time to verify if the previous operation +// has completed. +// +// - FAILED indicates that the previous [ClaimPhoneNumber]or [UpdatePhoneNumber]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. +// +// [UpdatePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html +// [UpdatePhoneNumberMetadata]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html +// [ClaimPhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html +// [DescribePhoneNumber]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html type PhoneNumberStatus struct { // The status message. @@ -3205,8 +3304,9 @@ type PredefinedAttributeSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []PredefinedAttributeSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name and description . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name and description . StringCondition *StringCondition noSmithyDocumentSerde @@ -3291,9 +3391,10 @@ type PromptSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []PromptSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name , description , and resourceID - // . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name , description , and + // resourceID . StringCondition *StringCondition noSmithyDocumentSerde @@ -3304,7 +3405,9 @@ type PromptSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter @@ -3435,10 +3538,11 @@ 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. @@ -3450,9 +3554,10 @@ type QueueSearchCriteria struct { // The type of queue. QueueTypeCondition SearchableQueueType - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name , description , and resourceID - // . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name , description , and + // resourceID . StringCondition *StringCondition noSmithyDocumentSerde @@ -3463,7 +3568,9 @@ type QueueSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter @@ -3557,9 +3664,10 @@ type QuickConnectSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []QuickConnectSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name , description , and resourceID - // . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name , description , and + // resourceID . StringCondition *StringCondition noSmithyDocumentSerde @@ -3570,7 +3678,9 @@ type QuickConnectSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter @@ -3626,8 +3736,9 @@ type RealTimeContactAnalysisAttachment 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]in the Amazon Connect Administrator Guide. + // + // [Feature specifications]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html ContentType *string // Status of the attachment. @@ -4067,8 +4178,10 @@ 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) - // in the Amazon Resource Name (ARN) of the instance. + // The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource + // Name (ARN) of the instance. + // + // [find the instance ID]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html InstanceId *string // Whether this a default routing profile. @@ -4111,15 +4224,18 @@ 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) - // in the Amazon Connect Administrator Guide. + // to an available agent. For more information, see [Queues: priority and delay]in the Amazon Connect + // Administrator Guide. + // + // [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html // // 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]. + // + // [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html // // This member is required. Priority *int32 @@ -4141,16 +4257,18 @@ type RoutingProfileQueueConfigSummary struct { Channel Channel // 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) - // in the Amazon Connect Administrator Guide. + // routed to an available agent. For more information, see [Queues: priority and delay]in the Amazon Connect + // Administrator Guide. + // + // [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html // // 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]. + // + // [Queues: priority and delay]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html // // This member is required. Priority *int32 @@ -4202,10 +4320,11 @@ type RoutingProfileReference struct { noSmithyDocumentSerde } -// The search criteria to be used to return routing profiles. 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 routing profiles. +// +// 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 RoutingProfileSearchCriteria struct { // A list of conditions which would be applied together with an AND condition. @@ -4214,9 +4333,10 @@ type RoutingProfileSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []RoutingProfileSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name , description , and resourceID - // . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name , description , and + // resourceID . StringCondition *StringCondition noSmithyDocumentSerde @@ -4227,7 +4347,9 @@ type RoutingProfileSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter @@ -4323,29 +4445,35 @@ type RuleAction struct { // This member is required. ActionType ActionType - // Information about the contact category action. Supported only for - // TriggerEventSource values: OnPostCallAnalysisAvailable | + // Information about the contact category action. + // + // Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | // OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | // OnPostChatAnalysisAvailable | OnZendeskTicketCreate | // OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate AssignContactCategoryAction *AssignContactCategoryActionDefinition - // Information about the create case action. Supported only for TriggerEventSource - // values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable . + // Information about the create case action. + // + // Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | + // OnPostChatAnalysisAvailable . CreateCaseAction *CreateCaseActionDefinition - // Information about the end associated tasks action. Supported only for - // TriggerEventSource values: OnCaseUpdate . + // Information about the end associated tasks action. + // + // Supported only for TriggerEventSource values: OnCaseUpdate . EndAssociatedTasksAction *EndAssociatedTasksActionDefinition - // Information about the EventBridge action. Supported only for TriggerEventSource - // values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | - // OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | - // OnContactEvaluationSubmit | OnMetricDataUpdate + // Information about the EventBridge action. + // + // Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | + // OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | + // OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate EventBridgeAction *EventBridgeActionDefinition - // Information about the send notification action. Supported only for - // TriggerEventSource values: OnPostCallAnalysisAvailable | + // Information about the send notification action. + // + // Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | // OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | // OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate SendNotificationAction *SendNotificationActionDefinition @@ -4358,8 +4486,9 @@ type RuleAction struct { // OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate TaskAction *TaskActionDefinition - // Information about the update case action. Supported only for TriggerEventSource - // values: OnCaseCreate | OnCaseUpdate . + // Information about the update case action. + // + // Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate . UpdateCaseAction *UpdateCaseActionDefinition noSmithyDocumentSerde @@ -4523,13 +4652,15 @@ type SearchCriteria struct { QueueIds []string // The search criteria based on user-defined contact attributes that have been - // configured for contact search. For more information, see Search by customer - // contact attributes (https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html) - // in the Amazon Connect Administrator Guide. To use SearchableContactAttributes - // in a search request, the GetContactAttributes action is required to perform an - // API request. For more information, see - // https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions) - // Actions defined by Amazon Connect. + // configured for contact search. For more information, see [Search by customer contact attributes]in the Amazon Connect + // Administrator Guide. + // + // To use SearchableContactAttributes in a search request, the GetContactAttributes + // action is required to perform an API request. For more information, see [https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions]Actions + // defined by Amazon Connect. + // + // [https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions + // [Search by customer contact attributes]: https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html SearchableContactAttributes *SearchableContactAttributes noSmithyDocumentSerde @@ -4598,10 +4729,11 @@ type SecurityProfile struct { noSmithyDocumentSerde } -// 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 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. type SecurityProfileSearchCriteria struct { // A list of conditions which would be applied together with an AND condition. @@ -4610,8 +4742,9 @@ type SecurityProfileSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []SecurityProfileSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are name and description . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are name and description . StringCondition *StringCondition noSmithyDocumentSerde @@ -4647,7 +4780,9 @@ type SecurityProfilesSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter @@ -4688,10 +4823,11 @@ type SegmentAttributeValue struct { // Information about the send notification action. 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) + // Notification content. Supports variable injection. For more information, see [JSONPath reference] // in the Amazon Connect Administrators Guide. // + // [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html + // // This member is required. Content *string @@ -4711,8 +4847,9 @@ type SendNotificationActionDefinition struct { 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) - // in the Amazon Connect Administrators Guide. + // injection. For more information, see [JSONPath reference]in the Amazon Connect Administrators Guide. + // + // [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html Subject *string noSmithyDocumentSerde @@ -4750,7 +4887,7 @@ type SignInDistribution struct { // select question. type SingleSelectQuestionRuleCategoryAutomation struct { - // The category name, as defined in Rules. + // The category name, as defined in Rules. // // This member is required. Category *string @@ -4787,8 +4924,9 @@ type Sort struct { noSmithyDocumentSerde } -// A leaf node condition which can be used to specify a string condition. The -// currently supported values for FieldName are name and description . +// A leaf node condition which can be used to specify a string condition. +// +// The currently supported values for FieldName are name and description . type StringCondition struct { // The type of comparison to be made when evaluating the string condition. @@ -4892,16 +5030,18 @@ type TaskActionDefinition struct { // This member is required. 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) - // in the Amazon Connect Administrators Guide. + // The name. Supports variable injection. For more information, see [JSONPath reference] in the Amazon + // Connect Administrators Guide. + // + // [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html // // 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) - // in the Amazon Connect Administrators Guide. + // The description. Supports variable injection. For more information, see [JSONPath reference] in the + // Amazon Connect Administrators Guide. + // + // [JSONPath reference]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html Description *string // Information about the reference when the referenceType is URL . Otherwise, null. @@ -5060,30 +5200,39 @@ type TrafficDistributionGroup struct { // Whether this is the default traffic distribution group created during instance // replication. The default traffic distribution group cannot be deleted by the // DeleteTrafficDistributionGroup API. The default traffic distribution group is - // deleted as part of the process for deleting a replica. The SignInConfig - // distribution is available only on a default TrafficDistributionGroup (see the - // IsDefault parameter in the TrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) - // data type). If you call UpdateTrafficDistribution with a modified SignInConfig - // and a non-default TrafficDistributionGroup , an InvalidRequestException is - // returned. + // deleted as part of the process for deleting a replica. + // + // The SignInConfig distribution is available only on a default + // TrafficDistributionGroup (see the IsDefault parameter in the [TrafficDistributionGroup] data type). If + // you call UpdateTrafficDistribution with a modified SignInConfig and a + // non-default TrafficDistributionGroup , an InvalidRequestException is returned. + // + // [TrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html IsDefault bool // The name of the traffic distribution group. 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 UpdateTrafficDistribution (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html) - // operation is still in progress and has not yet completed. + // + // - CREATION_IN_PROGRESS means the previous [CreateTrafficDistributionGroup]operation is still in progress and + // has not yet completed. + // + // - ACTIVE means the previous [CreateTrafficDistributionGroup]operation has succeeded. + // + // - CREATION_FAILED indicates that the previous [CreateTrafficDistributionGroup]operation has failed. + // + // - PENDING_DELETION means the previous [DeleteTrafficDistributionGroup]operation is still in progress and has + // not yet completed. + // + // - DELETION_FAILED means the previous [DeleteTrafficDistributionGroup]operation has failed. + // + // - UPDATE_IN_PROGRESS means the previous [UpdateTrafficDistribution]operation is still in progress and + // has not yet completed. + // + // [UpdateTrafficDistribution]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html + // [DeleteTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html + // [CreateTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html Status TrafficDistributionGroupStatus // The tags used to organize, track, or control access for this resource. For @@ -5117,18 +5266,25 @@ 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]operation is still in progress and + // has not yet completed. + // + // - ACTIVE means the previous [CreateTrafficDistributionGroup]operation has succeeded. + // + // - CREATION_FAILED indicates that the previous [CreateTrafficDistributionGroup]operation has failed. + // + // - PENDING_DELETION means the previous [DeleteTrafficDistributionGroup]operation is still in progress and has + // not yet completed. + // + // - DELETION_FAILED means the previous [DeleteTrafficDistributionGroup]operation has failed. + // + // - UPDATE_IN_PROGRESS means the previous [UpdateTrafficDistributionGroup]operation is still in progress and + // has not yet completed. + // + // [DeleteTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html + // [CreateTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html + // [UpdateTrafficDistributionGroup]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html Status TrafficDistributionGroupStatus noSmithyDocumentSerde @@ -5302,7 +5458,7 @@ type User struct { // Data for a user. type UserData struct { - // A map of active slots by channel. The key is a channel name. The value is an + // A map of active slots by channel. The key is a channel name. The value is an // integer: the number of active slots. ActiveSlotsByChannel map[string]int32 @@ -5317,8 +5473,10 @@ 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) - // of the RoutingProfile assigned to the agent. + // integer: the maximum number of slots. This is calculated from [MediaConcurrency]of the + // RoutingProfile assigned to the agent. + // + // [MediaConcurrency]: https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html MaxSlotsByChannel map[string]int32 // The Next status of the agent. @@ -5360,10 +5518,11 @@ type UserDataFilters struct { noSmithyDocumentSerde } -// Contains information about the identity of a user. For Amazon Connect instances -// that are created with the EXISTING_DIRECTORY identity management type, FirstName -// , LastName , and Email cannot be updated from within Amazon Connect because -// they are managed by the directory. +// Contains information about the identity of a user. +// +// For Amazon Connect instances that are created with the EXISTING_DIRECTORY +// identity management type, FirstName , LastName , and Email cannot be updated +// from within Amazon Connect because they are managed by the directory. type UserIdentityInfo struct { // The email address. If you are using SAML for identity management and include @@ -5383,8 +5542,9 @@ type UserIdentityInfo struct { // The user's secondary email address. If you provide a secondary email, the user // receives email notifications - other than password reset notifications - to this - // email address instead of to their primary email address. Pattern: - // (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63} + // email address instead of to their primary email address. + // + // Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63} SecondaryEmail *string noSmithyDocumentSerde @@ -5414,8 +5574,10 @@ type UserPhoneConfig struct { // minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 // if you don't want to allocate a specific amount of ACW time. It essentially // means an indefinite amount of time. When the conversation ends, ACW starts; the - // agent must choose Close contact to end ACW. When returned by a SearchUsers - // call, AfterContactWorkTimeLimit is returned in milliseconds. + // agent must choose Close contact to end ACW. + // + // When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in + // milliseconds. AfterContactWorkTimeLimit int32 // The Auto accept setting. @@ -5495,10 +5657,11 @@ type UserReference struct { noSmithyDocumentSerde } -// The search criteria to be used to return users. 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 users. +// +// 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 UserSearchCriteria struct { // A list of conditions which would be applied together with an AND condition. @@ -5510,9 +5673,10 @@ type UserSearchCriteria struct { // A list of conditions which would be applied together with an OR condition. OrConditions []UserSearchCriteria - // A leaf node condition which can be used to specify a string condition. The - // currently supported values for FieldName are Username , FirstName , LastName , - // RoutingProfileId , SecurityProfileId , ResourceId . + // A leaf node condition which can be used to specify a string condition. + // + // The currently supported values for FieldName are Username , FirstName , LastName + // , RoutingProfileId , SecurityProfileId , ResourceId . StringCondition *StringCondition noSmithyDocumentSerde @@ -5523,17 +5687,23 @@ type UserSearchFilter struct { // 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. TagFilter *ControlPlaneTagFilter // An object that can be used to specify Tag conditions or Hierarchy Group - // conditions inside the SearchFilter. This accepts an OR of AND (List of List) - // input where: + // conditions inside the SearchFilter. + // + // This accepts an OR of AND (List of List) input where: + // // - The top level list specifies conditions that need to be applied with OR // operator. + // // - The inner list specifies conditions that need to be applied with AND // operator. + // // Only one field can be populated. This object can’t be used along with // TagFilter. Request can either contain TagFilter or UserAttributeFilter if // SearchFilter is specified, combination of both is not supported and such request @@ -5745,7 +5915,9 @@ 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?] + // + // [What is Amazon Transcribe?]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html // // This member is required. LanguageCode VocabularyLanguageCode @@ -5768,8 +5940,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) - // . + // characters. For more information, see [Create a custom vocabulary using a table]. + // + // [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. @@ -5796,7 +5969,9 @@ 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?] + // + // [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/options.go b/service/connectcampaigns/options.go index 9a90478641f..7874c37ad84 100644 --- a/service/connectcampaigns/options.go +++ b/service/connectcampaigns/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/connectcampaigns/types/enums.go b/service/connectcampaigns/types/enums.go index 15aaccda4cf..c7ad5b2f9e0 100644 --- a/service/connectcampaigns/types/enums.go +++ b/service/connectcampaigns/types/enums.go @@ -19,8 +19,9 @@ const ( ) // Values returns all known values for CampaignState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CampaignState) Values() []CampaignState { return []CampaignState{ "Initialized", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "KMS", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for FailureCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureCode) Values() []FailureCode { return []FailureCode{ "InvalidInput", @@ -82,8 +85,9 @@ const ( // Values returns all known values for GetCampaignStateBatchFailureCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GetCampaignStateBatchFailureCode) Values() []GetCampaignStateBatchFailureCode { return []GetCampaignStateBatchFailureCode{ "ResourceNotFound", @@ -101,6 +105,7 @@ const ( // 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{ @@ -122,8 +127,9 @@ const ( // Values returns all known values for InstanceOnboardingJobFailureCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceOnboardingJobFailureCode) Values() []InstanceOnboardingJobFailureCode { return []InstanceOnboardingJobFailureCode{ "EVENT_BRIDGE_ACCESS_DENIED", @@ -146,8 +152,9 @@ const ( // Values returns all known values for InstanceOnboardingJobStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceOnboardingJobStatusCode) Values() []InstanceOnboardingJobStatusCode { return []InstanceOnboardingJobStatusCode{ "IN_PROGRESS", diff --git a/service/connectcases/api_op_CreateCase.go b/service/connectcases/api_op_CreateCase.go index aee03049f36..5c3c56fc91c 100644 --- a/service/connectcases/api_op_CreateCase.go +++ b/service/connectcases/api_op_CreateCase.go @@ -11,16 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// If you provide a value for PerformedBy.UserArn you must also have -// connect:DescribeUser (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) -// permission on the User ARN resource that you provide Creates a case in the -// specified Cases domain. Case system and custom fields are taken as an array -// id/value pairs with a declared data types. The following fields are required -// when creating a case: +// If you provide a value for PerformedBy.UserArn you must also have [connect:DescribeUser] permission +// on the User ARN resource that you provide +// +// Creates a case in the specified Cases domain. Case system and custom fields are +// taken as an array id/value pairs with a declared data types. +// +// The following fields are required when creating a case: +// // - customer_id - You must provide the full customer profile ARN in this format: // arn:aws:profile:your_AWS_Region:your_AWS_account // ID:domains/your_profiles_domain_name/profiles/profile_ID +// // - title +// +// [connect:DescribeUser]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error) { if params == nil { params = &CreateCaseInput{} @@ -56,9 +61,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // Represents the identity of the person who performed the action. diff --git a/service/connectcases/api_op_CreateDomain.go b/service/connectcases/api_op_CreateDomain.go index 9e02e0356dd..de4fac0738d 100644 --- a/service/connectcases/api_op_CreateDomain.go +++ b/service/connectcases/api_op_CreateDomain.go @@ -13,11 +13,14 @@ import ( // 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) -// . +// with only one Cases domain. +// +// This will not associate your connect instance to Cases domain. Instead, use the +// Amazon Connect [CreateIntegrationAssociation]API. You need specific IAM permissions to successfully associate +// the Cases domain. For more information, see [Onboard to Cases]. +// +// [CreateIntegrationAssociation]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html +// [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 7bbfdbe1661..251451a1bef 100644 --- a/service/connectcases/api_op_CreateLayout.go +++ b/service/connectcases/api_op_CreateLayout.go @@ -13,7 +13,9 @@ import ( // Creates a layout in the Cases domain. Layouts define the following // configuration in the top section and More Info tab of the Cases user interface: +// // - Fields to display to the users +// // - Field ordering // // Title and Status fields cannot be part of layouts since they are not diff --git a/service/connectcases/api_op_CreateRelatedItem.go b/service/connectcases/api_op_CreateRelatedItem.go index 066988a72b4..5455b553525 100644 --- a/service/connectcases/api_op_CreateRelatedItem.go +++ b/service/connectcases/api_op_CreateRelatedItem.go @@ -13,13 +13,16 @@ 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 . -// - If you provide a value for performedBy.userArn you must also have -// DescribeUser (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) +// +// - If you provide a value for performedBy.userArn you must also have [DescribeUser] // permission on the ARN of the user that you provide. +// +// [DescribeUser]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html 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_DeleteDomain.go b/service/connectcases/api_op_DeleteDomain.go index c72831a1d82..5df4e23cc6b 100644 --- a/service/connectcases/api_op_DeleteDomain.go +++ b/service/connectcases/api_op_DeleteDomain.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Cases domain. After deleting your domain you must disassociate the -// deleted domain from your Amazon Connect instance with another API call before -// being able to use Cases again with this Amazon Connect instance. See -// DeleteIntegrationAssociation (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html) -// . +// Deletes a Cases domain. +// +// After deleting your domain you must disassociate the deleted domain from your +// Amazon Connect instance with another API call before being able to use Cases +// again with this Amazon Connect instance. See [DeleteIntegrationAssociation]. +// +// [DeleteIntegrationAssociation]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} diff --git a/service/connectcases/api_op_DeleteField.go b/service/connectcases/api_op_DeleteField.go index 0efb5a94ddf..5dcd4cc91bb 100644 --- a/service/connectcases/api_op_DeleteField.go +++ b/service/connectcases/api_op_DeleteField.go @@ -11,27 +11,41 @@ import ( ) // Deletes a field from a cases template. You can delete up to 100 fields per -// domain. After a field is deleted: +// domain. +// +// After a field is deleted: +// // - You can still retrieve the field by calling BatchGetField . +// // - You cannot update a deleted field by calling UpdateField ; it throws a // ValidationException . +// // - Deleted fields are not included in the ListFields response. +// // - Calling CreateCase with a deleted field throws a ValidationException // denoting which field IDs in the request have been deleted. +// // - Calling GetCase with a deleted field ID returns the deleted field's value if // one exists. +// // - Calling UpdateCase with a deleted field ID throws a ValidationException if // the case does not already contain a value for the deleted field. Otherwise it // succeeds, allowing you to update or remove (using emptyValue: {} ) the field's // value from the case. +// // - GetTemplate does not return field IDs for deleted fields. +// // - GetLayout does not return field IDs for deleted fields. +// // - Calling SearchCases with the deleted field ID as a filter returns any cases // that have a value for the deleted field that matches the filter criteria. +// // - Calling SearchCases with a searchTerm value that matches a deleted field's // value on a case returns the case in the response. +// // - Calling BatchPutFieldOptions with a deleted field ID throw a // ValidationException . +// // - Calling GetCaseEventConfiguration does not return field IDs for deleted // fields. func (c *Client) DeleteField(ctx context.Context, params *DeleteFieldInput, optFns ...func(*Options)) (*DeleteFieldOutput, error) { diff --git a/service/connectcases/api_op_DeleteLayout.go b/service/connectcases/api_op_DeleteLayout.go index 7fe783a6b02..50683efeeb1 100644 --- a/service/connectcases/api_op_DeleteLayout.go +++ b/service/connectcases/api_op_DeleteLayout.go @@ -11,10 +11,15 @@ import ( ) // Deletes a layout from a cases template. You can delete up to 100 layouts per -// domain. After a layout is deleted: +// domain. +// +// After a layout is deleted: +// // - You can still retrieve the layout by calling GetLayout . +// // - You cannot update a deleted layout by calling UpdateLayout ; it throws a // ValidationException . +// // - Deleted layouts are not included in the ListLayouts response. func (c *Client) DeleteLayout(ctx context.Context, params *DeleteLayoutInput, optFns ...func(*Options)) (*DeleteLayoutOutput, error) { if params == nil { diff --git a/service/connectcases/api_op_DeleteTemplate.go b/service/connectcases/api_op_DeleteTemplate.go index 71166bff147..98662658b5d 100644 --- a/service/connectcases/api_op_DeleteTemplate.go +++ b/service/connectcases/api_op_DeleteTemplate.go @@ -10,11 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a cases template. You can delete up to 100 templates per domain. After -// a cases template is deleted: +// Deletes a cases template. You can delete up to 100 templates per domain. +// +// After a cases template is deleted: +// // - You can still retrieve the template by calling GetTemplate . +// // - You cannot update the template. +// // - You cannot create a case by using the deleted template. +// // - Deleted templates are not included in the ListTemplates response. func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error) { if params == nil { diff --git a/service/connectcases/api_op_PutCaseEventConfiguration.go b/service/connectcases/api_op_PutCaseEventConfiguration.go index 109263f2642..2f0832631b7 100644 --- a/service/connectcases/api_op_PutCaseEventConfiguration.go +++ b/service/connectcases/api_op_PutCaseEventConfiguration.go @@ -12,8 +12,9 @@ import ( ) // Adds case event publishing configuration. For a complete list of fields you can -// add to the event message, see Create case fields (https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html) -// in the Amazon Connect Administrator Guide +// add to the event message, see [Create case fields]in the Amazon Connect Administrator Guide +// +// [Create case fields]: https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html func (c *Client) PutCaseEventConfiguration(ctx context.Context, params *PutCaseEventConfigurationInput, optFns ...func(*Options)) (*PutCaseEventConfigurationOutput, error) { if params == nil { params = &PutCaseEventConfigurationInput{} diff --git a/service/connectcases/api_op_SearchCases.go b/service/connectcases/api_op_SearchCases.go index 582736b6a52..f5b4a547fdc 100644 --- a/service/connectcases/api_op_SearchCases.go +++ b/service/connectcases/api_op_SearchCases.go @@ -12,9 +12,11 @@ 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 . +// returned as a paginated list of abridged case documents. +// +// For customer_id you must provide the full customer profile ARN in this format: +// arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain +// name/profiles/profile ID . func (c *Client) SearchCases(ctx context.Context, params *SearchCasesInput, optFns ...func(*Options)) (*SearchCasesOutput, error) { if params == nil { params = &SearchCasesInput{} diff --git a/service/connectcases/api_op_SearchRelatedItems.go b/service/connectcases/api_op_SearchRelatedItems.go index 0d5cd70e7ae..9ceeed45488 100644 --- a/service/connectcases/api_op_SearchRelatedItems.go +++ b/service/connectcases/api_op_SearchRelatedItems.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for related items that are associated with a case. If no filters are -// provided, this returns all related items associated with a case. +// Searches for related items that are associated with a case. +// +// If no filters are provided, this returns all related items associated with a +// case. func (c *Client) SearchRelatedItems(ctx context.Context, params *SearchRelatedItemsInput, optFns ...func(*Options)) (*SearchRelatedItemsOutput, error) { if params == nil { params = &SearchRelatedItemsInput{} diff --git a/service/connectcases/api_op_UpdateCase.go b/service/connectcases/api_op_UpdateCase.go index b38296b867e..76cce6daaa2 100644 --- a/service/connectcases/api_op_UpdateCase.go +++ b/service/connectcases/api_op_UpdateCase.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// If you provide a value for PerformedBy.UserArn you must also have -// connect:DescribeUser (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) -// permission on the User ARN resource that you provide Updates the values of -// fields on a case. Fields to be updated are received as an array of id/value -// pairs identical to the CreateCase input . If the action is successful, the -// service sends back an HTTP 200 response with an empty HTTP body. +// If you provide a value for PerformedBy.UserArn you must also have [connect:DescribeUser] permission +// on the User ARN resource that you provide +// +// Updates the values of fields on a case. Fields to be updated are received as an +// array of id/value pairs identical to the CreateCase input . +// +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. +// +// [connect:DescribeUser]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html func (c *Client) UpdateCase(ctx context.Context, params *UpdateCaseInput, optFns ...func(*Options)) (*UpdateCaseOutput, error) { if params == nil { params = &UpdateCaseInput{} diff --git a/service/connectcases/api_op_UpdateLayout.go b/service/connectcases/api_op_UpdateLayout.go index 7d08af7cc02..d174c23ea30 100644 --- a/service/connectcases/api_op_UpdateLayout.go +++ b/service/connectcases/api_op_UpdateLayout.go @@ -11,9 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the attributes of an existing layout. If the action is successful, the -// service sends back an HTTP 200 response with an empty HTTP body. A -// ValidationException is returned when you add non-existent fieldIds to a layout. +// Updates the attributes of an existing layout. +// +// If the action is successful, the service sends back an HTTP 200 response with +// an empty HTTP body. +// +// A ValidationException is returned when you add non-existent fieldIds to a +// layout. +// // Title and Status fields cannot be part of layouts because they are not // configurable. func (c *Client) UpdateLayout(ctx context.Context, params *UpdateLayoutInput, optFns ...func(*Options)) (*UpdateLayoutOutput, error) { diff --git a/service/connectcases/doc.go b/service/connectcases/doc.go index 64576ae50bb..17241710fe4 100644 --- a/service/connectcases/doc.go +++ b/service/connectcases/doc.go @@ -7,6 +7,7 @@ // 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]in the Amazon Connect Administrator Guide. +// +// [Amazon Connect Cases]: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html package connectcases diff --git a/service/connectcases/options.go b/service/connectcases/options.go index ad2305f38de..0aa0eec451f 100644 --- a/service/connectcases/options.go +++ b/service/connectcases/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/connectcases/types/enums.go b/service/connectcases/types/enums.go index 5a4a67df79f..2916c4daed8 100644 --- a/service/connectcases/types/enums.go +++ b/service/connectcases/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AuditEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditEventType) Values() []AuditEventType { return []AuditEventType{ "Case.Created", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for CommentBodyTextType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommentBodyTextType) Values() []CommentBodyTextType { return []CommentBodyTextType{ "Text/Plain", @@ -48,8 +50,9 @@ const ( ) // 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. +// expanded in the future, and so 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,8 +70,9 @@ const ( ) // Values returns all known values for FieldNamespace. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FieldNamespace) Values() []FieldNamespace { return []FieldNamespace{ "System", @@ -90,8 +94,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -113,8 +118,9 @@ const ( ) // 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. +// the future, and so 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{ "Asc", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for RelatedItemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelatedItemType) Values() []RelatedItemType { return []RelatedItemType{ "Contact", @@ -151,8 +158,9 @@ const ( ) // Values returns all known values for TemplateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateStatus) Values() []TemplateStatus { return []TemplateStatus{ "Active", diff --git a/service/connectcases/types/errors.go b/service/connectcases/types/errors.go index be01456c040..b4941689eba 100644 --- a/service/connectcases/types/errors.go +++ b/service/connectcases/types/errors.go @@ -121,9 +121,10 @@ 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) -// in the Amazon Connect Administrator Guide. +// The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas] in the +// Amazon Connect Administrator Guide. +// +// [Amazon Connect Service Quotas]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/connectcases/types/types.go b/service/connectcases/types/types.go index 05110feebf4..75d77337b83 100644 --- a/service/connectcases/types/types.go +++ b/service/connectcases/types/types.go @@ -91,8 +91,10 @@ type AuditEventFieldValueUnionMemberDoubleValue struct { func (*AuditEventFieldValueUnionMemberDoubleValue) isAuditEventFieldValueUnion() {} // An empty value. You cannot set EmptyFieldValue on a field that is required on a -// case template. This structure will never have any data members. It signifies an -// empty value on a case field. +// case template. +// +// This structure will never have any data members. It signifies an empty value on +// a case field. type AuditEventFieldValueUnionMemberEmptyValue struct { Value EmptyFieldValue @@ -310,8 +312,10 @@ type DomainSummary struct { } // An empty value. You cannot set EmptyFieldValue on a field that is required on a -// case template. This structure will never have any data members. It signifies an -// empty value on a case field. +// case template. +// +// This structure will never have any data members. It signifies an empty value on +// a case field. type EmptyFieldValue struct { noSmithyDocumentSerde } @@ -558,8 +562,10 @@ type FieldValue struct { noSmithyDocumentSerde } -// Object to store union of Field values. The Summary system field accepts 1500 -// characters while all other fields accept 500 characters. +// Object to store union of Field values. +// +// The Summary system field accepts 1500 characters while all other fields accept +// 500 characters. // // The following types satisfy this interface: // @@ -689,7 +695,7 @@ type GetFieldResponse struct { // Object to store configuration of layouts associated to the template. type LayoutConfiguration struct { - // Unique identifier of a layout. + // Unique identifier of a layout. DefaultLayout *string noSmithyDocumentSerde diff --git a/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go b/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go index ecd731e4776..5f253ddd166 100644 --- a/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go +++ b/service/connectcontactlens/api_op_ListRealtimeContactAnalysisSegments.go @@ -58,10 +58,13 @@ 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. NextToken *string diff --git a/service/connectcontactlens/doc.go b/service/connectcontactlens/doc.go index a0b564d91ee..eb7bbe4e22b 100644 --- a/service/connectcontactlens/doc.go +++ b/service/connectcontactlens/doc.go @@ -6,9 +6,11 @@ // Contact Lens for Amazon Connect enables you to analyze conversations between // customer and agents, by using speech transcription, natural language processing, // and intelligent search capabilities. It performs sentiment analysis, detects -// 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) -// in the Amazon Connect Administrator Guide. +// 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]in the Amazon +// Connect Administrator Guide. +// +// [Analyze conversations using Contact Lens]: https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html package connectcontactlens diff --git a/service/connectcontactlens/options.go b/service/connectcontactlens/options.go index fbbeed58bba..0d2af77a8ba 100644 --- a/service/connectcontactlens/options.go +++ b/service/connectcontactlens/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/connectcontactlens/types/enums.go b/service/connectcontactlens/types/enums.go index 6a8bac6feff..ea00bafcbb6 100644 --- a/service/connectcontactlens/types/enums.go +++ b/service/connectcontactlens/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for SentimentValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SentimentValue) Values() []SentimentValue { return []SentimentValue{ "POSITIVE", diff --git a/service/connectparticipant/api_op_CompleteAttachmentUpload.go b/service/connectparticipant/api_op_CompleteAttachmentUpload.go index 3d3996a80ec..8755802085d 100644 --- a/service/connectparticipant/api_op_CompleteAttachmentUpload.go +++ b/service/connectparticipant/api_op_CompleteAttachmentUpload.go @@ -13,10 +13,12 @@ import ( // Allows you to confirm that the attachment has been uploaded using the // pre-signed URL provided in StartAttachmentUpload API. A conflict exception is // thrown when an attachment with that identifier is already being uploaded. -// 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) -// . +// +// ConnectionToken is used for invoking this API instead of ParticipantToken . +// +// The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication]. +// +// [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,9 +43,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ // // This member is required. ClientToken *string diff --git a/service/connectparticipant/api_op_CreateParticipantConnection.go b/service/connectparticipant/api_op_CreateParticipantConnection.go index 7bbc20dc5ae..28b4026af11 100644 --- a/service/connectparticipant/api_op_CreateParticipantConnection.go +++ b/service/connectparticipant/api_op_CreateParticipantConnection.go @@ -11,26 +11,41 @@ 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 -// 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) -// 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) -// 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) -// 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) -// . +// 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] 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]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]in the +// Amazon Connect Administrator Guide. +// +// The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication]. +// +// [Feature specifications]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits +// [StartContactStreaming]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html +// [Enable real-time chat message streaming]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html +// [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{} @@ -48,9 +63,11 @@ 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) - // API response. + // This is a header parameter. + // + // The ParticipantToken as obtained from [StartChatContact] API response. + // + // [StartChatContact]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html // // This member is required. ParticipantToken *string diff --git a/service/connectparticipant/api_op_DisconnectParticipant.go b/service/connectparticipant/api_op_DisconnectParticipant.go index 433051fa99a..a7390cf8c40 100644 --- a/service/connectparticipant/api_op_DisconnectParticipant.go +++ b/service/connectparticipant/api_op_DisconnectParticipant.go @@ -10,10 +10,13 @@ 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]. +// +// [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{} @@ -38,9 +41,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde diff --git a/service/connectparticipant/api_op_GetAttachment.go b/service/connectparticipant/api_op_GetAttachment.go index 5f1107ae907..56cdce28192 100644 --- a/service/connectparticipant/api_op_GetAttachment.go +++ b/service/connectparticipant/api_op_GetAttachment.go @@ -11,10 +11,13 @@ 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) -// . +// 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]. +// +// [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 +51,9 @@ 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]. + // + // [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 7e0a2accd60..fddbb11687e 100644 --- a/service/connectparticipant/api_op_GetTranscript.go +++ b/service/connectparticipant/api_op_GetTranscript.go @@ -13,20 +13,28 @@ 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) -// . If you have a process that consumes events in the transcript of an chat that +// chat, see [Enable persistent chat]. +// +// If you have a process that consumes events in the transcript of an chat that // has ended, note that chat transcripts contain the following event content types // if the event has occurred during the chat session: +// // - application/vnd.amazonaws.connect.event.participant.left +// // - application/vnd.amazonaws.connect.event.participant.joined +// // - application/vnd.amazonaws.connect.event.chat.ended +// // - application/vnd.amazonaws.connect.event.transfer.succeeded +// // - application/vnd.amazonaws.connect.event.transfer.failed // -// 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) -// . +// ConnectionToken is used for invoking this API instead of ParticipantToken . +// +// The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication]. +// +// [Enable persistent chat]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html +// [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 39f12530b24..2cf12ab7821 100644 --- a/service/connectparticipant/api_op_SendEvent.go +++ b/service/connectparticipant/api_op_SendEvent.go @@ -12,14 +12,18 @@ import ( // The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType // will no longer be supported starting December 31, 2024. This event has been -// migrated to the CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) -// API using the ConnectParticipant field. Sends an event. Message receipts are -// not supported when there are more than two active participants in the chat. -// Using the SendEvent API for message receipts when a supervisor is barged-in will -// result in a conflict exception. 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) -// . +// migrated to the [CreateParticipantConnection]API using the ConnectParticipant field. +// +// Sends an event. Message receipts are not supported when there are more than two +// active participants in the chat. Using the SendEvent API for message receipts +// when a supervisor is barged-in will result in a conflict exception. +// +// ConnectionToken is used for invoking this API instead of ParticipantToken . +// +// The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication]. +// +// [CreateParticipantConnection]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html +// [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{} @@ -43,10 +47,14 @@ 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 (will be // deprecated on December 31, 2024) + // // - application/vnd.amazonaws.connect.event.message.delivered + // // - application/vnd.amazonaws.connect.event.message.read // // This member is required. @@ -54,13 +62,14 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The content of the event to be sent (for example, message text). For content // related to message receipts, this is supported in the form of a JSON string. + // // Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}" Content *string @@ -69,8 +78,10 @@ type SendEventInput struct { type SendEventOutput struct { - // The time when the event was sent. It's specified in ISO 8601 format: - // yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + // The time when the event was sent. + // + // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + // 2019-11-08T02:41:28.172Z. AbsoluteTime *string // The ID of the response. diff --git a/service/connectparticipant/api_op_SendMessage.go b/service/connectparticipant/api_op_SendMessage.go index fc68ec2c2f5..9b4c97d10f1 100644 --- a/service/connectparticipant/api_op_SendMessage.go +++ b/service/connectparticipant/api_op_SendMessage.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -37,10 +40,13 @@ 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. // @@ -56,9 +62,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string noSmithyDocumentSerde @@ -66,8 +72,10 @@ type SendMessageInput struct { type SendMessageOutput struct { - // The time when the message was sent. It's specified in ISO 8601 format: - // yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + // The time when the message was sent. + // + // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + // 2019-11-08T02:41:28.172Z. AbsoluteTime *string // The ID of the message. diff --git a/service/connectparticipant/api_op_StartAttachmentUpload.go b/service/connectparticipant/api_op_StartAttachmentUpload.go index ea7e15e35af..d106b6ab4cb 100644 --- a/service/connectparticipant/api_op_StartAttachmentUpload.go +++ b/service/connectparticipant/api_op_StartAttachmentUpload.go @@ -12,10 +12,13 @@ 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]. +// +// [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{} @@ -45,9 +48,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ // // This member is required. ClientToken *string @@ -58,8 +61,9 @@ 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]in the Amazon Connect Administrator Guide. + // + // [Feature specifications]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html // // This member is required. ContentType *string diff --git a/service/connectparticipant/doc.go b/service/connectparticipant/doc.go index ae4c9ff066e..a1ff0ded48b 100644 --- a/service/connectparticipant/doc.go +++ b/service/connectparticipant/doc.go @@ -7,6 +7,7 @@ // enables companies of any size to deliver superior customer service at a lower // cost. Amazon Connect communications capabilities make it easy for companies to // deliver personalized interactions across communication channels, including chat. +// // Use the Amazon Connect Participant Service to manage participants (for example, // agents, customers, and managers listening in), and to send messages and events // within a chat contact. The APIs in the service enable the following: sending diff --git a/service/connectparticipant/options.go b/service/connectparticipant/options.go index 014b8e0bd42..d3337478a0f 100644 --- a/service/connectparticipant/options.go +++ b/service/connectparticipant/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/connectparticipant/types/enums.go b/service/connectparticipant/types/enums.go index 0dfe33575f1..fbeec3e3967 100644 --- a/service/connectparticipant/types/enums.go +++ b/service/connectparticipant/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ArtifactStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactStatus) Values() []ArtifactStatus { return []ArtifactStatus{ "APPROVED", @@ -41,8 +42,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -69,8 +71,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "WEBSOCKET", @@ -90,8 +93,9 @@ const ( ) // Values returns all known values for ParticipantRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantRole) Values() []ParticipantRole { return []ParticipantRole{ "AGENT", @@ -117,8 +121,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -141,8 +146,9 @@ const ( ) // Values returns all known values for ScanDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanDirection) Values() []ScanDirection { return []ScanDirection{ "FORWARD", @@ -159,8 +165,9 @@ const ( ) // Values returns all known values for SortKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortKey) Values() []SortKey { return []SortKey{ "DESCENDING", diff --git a/service/connectparticipant/types/types.go b/service/connectparticipant/types/types.go index 4b441061245..44342168c0a 100644 --- a/service/connectparticipant/types/types.go +++ b/service/connectparticipant/types/types.go @@ -17,8 +17,9 @@ 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]in the Amazon Connect Administrator Guide. + // + // [Feature specifications]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html ContentType *string // Status of the attachment. @@ -33,8 +34,10 @@ type ConnectionCredentials struct { // The connection token. ConnectionToken *string - // The expiration of the token. It's specified in ISO 8601 format: - // yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + // The expiration of the token. + // + // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + // 2019-11-08T02:41:28.172Z. Expiry *string noSmithyDocumentSerde @@ -43,8 +46,10 @@ type ConnectionCredentials struct { // An item - message or event - that has been sent. type Item struct { - // The time when the message or event was sent. It's specified in ISO 8601 format: - // yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + // The time when the message or event was sent. + // + // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + // 2019-11-08T02:41:28.172Z. AbsoluteTime *string // Provides information about the attachments. @@ -78,8 +83,9 @@ 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]. + // + // [Enable persistent chat]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html RelatedContactId *string // Type of the item: message or event. @@ -119,8 +125,10 @@ type Receipt struct { // start with message 50. type StartPosition struct { - // The time in ISO format where to start. It's specified in ISO 8601 format: - // yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + // The time in ISO format where to start. + // + // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + // 2019-11-08T02:41:28.172Z. AbsoluteTime *string // The ID of the message or event where to start. @@ -139,8 +147,9 @@ 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]. + // + // [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 @@ -193,8 +202,10 @@ type ViewContent struct { // The websocket for the participant's connection. type Websocket struct { - // The URL expiration timestamp in ISO date format. It's specified in ISO 8601 - // format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z. + // The URL expiration timestamp in ISO date format. + // + // It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, + // 2019-11-08T02:41:28.172Z. ConnectionExpiry *string // The URL of the websocket. diff --git a/service/controlcatalog/api_op_ListCommonControls.go b/service/controlcatalog/api_op_ListCommonControls.go index 9682ae1840e..29ce53d67c0 100644 --- a/service/controlcatalog/api_op_ListCommonControls.go +++ b/service/controlcatalog/api_op_ListCommonControls.go @@ -12,9 +12,11 @@ import ( ) // Returns a paginated list of common controls from the Amazon Web Services -// Control Catalog. You can apply an optional filter to see common controls that -// have a specific objective. If you don’t provide a filter, the operation returns -// all common controls. +// Control Catalog. +// +// You can apply an optional filter to see common controls that have a specific +// objective. If you don’t provide a filter, the operation returns all common +// controls. func (c *Client) ListCommonControls(ctx context.Context, params *ListCommonControlsInput, optFns ...func(*Options)) (*ListCommonControlsOutput, error) { if params == nil { params = &ListCommonControlsInput{} @@ -32,9 +34,10 @@ func (c *Client) ListCommonControls(ctx context.Context, params *ListCommonContr type ListCommonControlsInput struct { - // An optional filter that narrows the results to a specific objective. This - // filter allows you to specify one objective ARN at a time. Passing multiple ARNs - // in the CommonControlFilter isn’t currently supported. + // An optional filter that narrows the results to a specific objective. + // + // This filter allows you to specify one objective ARN at a time. Passing multiple + // ARNs in the CommonControlFilter isn’t currently supported. CommonControlFilter *types.CommonControlFilter // The maximum number of results on a page or for an API request call. diff --git a/service/controlcatalog/api_op_ListObjectives.go b/service/controlcatalog/api_op_ListObjectives.go index 1bc9946fe97..cc26c18189c 100644 --- a/service/controlcatalog/api_op_ListObjectives.go +++ b/service/controlcatalog/api_op_ListObjectives.go @@ -12,7 +12,9 @@ import ( ) // Returns a paginated list of objectives from the Amazon Web Services Control -// Catalog. You can apply an optional filter to see the objectives that belong to a +// Catalog. +// +// You can apply an optional filter to see the objectives that belong to a // specific domain. If you don’t provide a filter, the operation returns all // objectives. func (c *Client) ListObjectives(ctx context.Context, params *ListObjectivesInput, optFns ...func(*Options)) (*ListObjectivesOutput, error) { @@ -38,9 +40,10 @@ type ListObjectivesInput struct { // The pagination token that's used to fetch the next set of results. NextToken *string - // An optional filter that narrows the results to a specific domain. This filter - // allows you to specify one domain ARN at a time. Passing multiple ARNs in the - // ObjectiveFilter isn’t currently supported. + // An optional filter that narrows the results to a specific domain. + // + // This filter allows you to specify one domain ARN at a time. Passing multiple + // ARNs in the ObjectiveFilter isn’t currently supported. ObjectiveFilter *types.ObjectiveFilter noSmithyDocumentSerde diff --git a/service/controlcatalog/doc.go b/service/controlcatalog/doc.go index e1039bfb29a..b76c3dee597 100644 --- a/service/controlcatalog/doc.go +++ b/service/controlcatalog/doc.go @@ -8,14 +8,25 @@ // identify and filter the common controls and related metadata that are available // to Amazon Web Services customers. This API reference provides descriptions, // syntax, and usage examples for each of the actions and data types that are -// supported by Amazon Web Services Control Catalog. Use the following links to get -// started with the Amazon Web Services Control Catalog API: -// - Actions (https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html) -// : An alphabetical list of all Control Catalog API operations. -// - Data types (https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html) -// : An alphabetical list of all Control Catalog data types. -// - Common parameters (https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html) -// : Parameters that all operations can use. -// - Common errors (https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html) -// : Client and server errors that all operations can return. +// supported by Amazon Web Services Control Catalog. +// +// Use the following links to get started with the Amazon Web Services Control +// Catalog API: +// +// [Actions] +// - : An alphabetical list of all Control Catalog API operations. +// +// [Data types] +// - : An alphabetical list of all Control Catalog data types. +// +// [Common parameters] +// - : Parameters that all operations can use. +// +// [Common errors] +// - : Client and server errors that all operations can return. +// +// [Common errors]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html +// [Actions]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html +// [Data types]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html +// [Common parameters]: https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html package controlcatalog diff --git a/service/controlcatalog/options.go b/service/controlcatalog/options.go index 89296da8527..63906ef581b 100644 --- a/service/controlcatalog/options.go +++ b/service/controlcatalog/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/controlcatalog/types/types.go b/service/controlcatalog/types/types.go index c807c15668e..183882a5616 100644 --- a/service/controlcatalog/types/types.go +++ b/service/controlcatalog/types/types.go @@ -34,9 +34,10 @@ type AssociatedObjectiveSummary struct { // An optional filter that narrows the results to a specific objective. type CommonControlFilter struct { - // The objective that's used as filter criteria. You can use this parameter to - // specify one objective ARN at a time. Passing multiple ARNs in the - // CommonControlFilter isn’t currently supported. + // The objective that's used as filter criteria. + // + // You can use this parameter to specify one objective ARN at a time. Passing + // multiple ARNs in the CommonControlFilter isn’t currently supported. Objectives []ObjectiveResourceFilter noSmithyDocumentSerde @@ -126,9 +127,10 @@ type DomainSummary struct { // An optional filter that narrows the list of objectives to a specific domain. type ObjectiveFilter struct { - // The domain that's used as filter criteria. You can use this parameter to - // specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter - // isn’t currently supported. + // The domain that's used as filter criteria. + // + // You can use this parameter to specify one domain ARN at a time. Passing + // multiple ARNs in the ObjectiveFilter isn’t currently supported. Domains []DomainResourceFilter noSmithyDocumentSerde diff --git a/service/controltower/api_op_CreateLandingZone.go b/service/controltower/api_op_CreateLandingZone.go index 79198ac0831..c567ef7e580 100644 --- a/service/controltower/api_op_CreateLandingZone.go +++ b/service/controltower/api_op_CreateLandingZone.go @@ -32,8 +32,9 @@ func (c *Client) CreateLandingZone(ctx context.Context, params *CreateLandingZon type CreateLandingZoneInput struct { // The manifest.yaml file is a text file that describes your Amazon Web Services - // resources. For examples, review The manifest file (https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file) - // . + // resources. For examples, review [The manifest file]. + // + // [The manifest file]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file // // This member is required. Manifest document.Interface diff --git a/service/controltower/api_op_DisableControl.go b/service/controltower/api_op_DisableControl.go index 9ffe322a55d..e7bf5363bae 100644 --- a/service/controltower/api_op_DisableControl.go +++ b/service/controltower/api_op_DisableControl.go @@ -13,8 +13,9 @@ import ( // This API call turns off a control. It starts an asynchronous operation that // deletes AWS resources on the specified organizational unit and the accounts it // contains. The resources will vary according to the control that you specify. For -// usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) DisableControl(ctx context.Context, params *DisableControlInput, optFns ...func(*Options)) (*DisableControlOutput, error) { if params == nil { params = &DisableControlInput{} @@ -34,15 +35,17 @@ type DisableControlInput struct { // The ARN of the control. Only Strongly recommended and Elective controls are // permitted, with the exception of the Region deny control. For information on how - // to find the controlIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // to find the controlIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html // // This member is required. ControlIdentifier *string // The ARN of the organizational unit. For information on how to find the - // targetIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // targetIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html // // This member is required. TargetIdentifier *string diff --git a/service/controltower/api_op_EnableControl.go b/service/controltower/api_op_EnableControl.go index 70de57a3284..0e8c8abc907 100644 --- a/service/controltower/api_op_EnableControl.go +++ b/service/controltower/api_op_EnableControl.go @@ -14,9 +14,9 @@ import ( // This API call activates a control. It starts an asynchronous operation that // creates Amazon Web Services resources on the specified organizational unit and // the accounts it contains. The resources created will vary according to the -// control that you specify. For usage examples, see the Amazon Web Services -// Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// control that you specify. For usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) EnableControl(ctx context.Context, params *EnableControlInput, optFns ...func(*Options)) (*EnableControlOutput, error) { if params == nil { params = &EnableControlInput{} @@ -36,15 +36,17 @@ type EnableControlInput struct { // The ARN of the control. Only Strongly recommended and Elective controls are // permitted, with the exception of the Region deny control. For information on how - // to find the controlIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // to find the controlIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html // // This member is required. ControlIdentifier *string // The ARN of the organizational unit. For information on how to find the - // targetIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // targetIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html // // This member is required. TargetIdentifier *string diff --git a/service/controltower/api_op_GetControlOperation.go b/service/controltower/api_op_GetControlOperation.go index be0edcb7147..7db2ed798bf 100644 --- a/service/controltower/api_op_GetControlOperation.go +++ b/service/controltower/api_op_GetControlOperation.go @@ -13,9 +13,9 @@ import ( // Returns the status of a particular EnableControl or DisableControl operation. // Displays a message in case of error. Details for an operation are available for -// 90 days. For usage examples, see the Amazon Web Services Control Tower User -// Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// 90 days. For usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) GetControlOperation(ctx context.Context, params *GetControlOperationInput, optFns ...func(*Options)) (*GetControlOperationOutput, error) { if params == nil { params = &GetControlOperationInput{} diff --git a/service/controltower/api_op_GetEnabledControl.go b/service/controltower/api_op_GetEnabledControl.go index 34fda22d25a..582452f02bf 100644 --- a/service/controltower/api_op_GetEnabledControl.go +++ b/service/controltower/api_op_GetEnabledControl.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves details about an enabled control. For usage examples, see the Amazon -// Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// Retrieves details about an enabled control. For usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) GetEnabledControl(ctx context.Context, params *GetEnabledControlInput, optFns ...func(*Options)) (*GetEnabledControlOutput, error) { if params == nil { params = &GetEnabledControlInput{} diff --git a/service/controltower/api_op_ListEnabledControls.go b/service/controltower/api_op_ListEnabledControls.go index fd6682d0c36..707693e39d8 100644 --- a/service/controltower/api_op_ListEnabledControls.go +++ b/service/controltower/api_op_ListEnabledControls.go @@ -13,8 +13,9 @@ import ( // Lists the controls enabled by Amazon Web Services Control Tower on the // specified organizational unit and the accounts it contains. For usage examples, -// see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) ListEnabledControls(ctx context.Context, params *ListEnabledControlsInput, optFns ...func(*Options)) (*ListEnabledControlsOutput, error) { if params == nil { params = &ListEnabledControlsInput{} @@ -33,8 +34,9 @@ func (c *Client) ListEnabledControls(ctx context.Context, params *ListEnabledCon type ListEnabledControlsInput struct { // The ARN of the organizational unit. For information on how to find the - // targetIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // targetIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html // // This member is required. TargetIdentifier *string diff --git a/service/controltower/api_op_ListLandingZones.go b/service/controltower/api_op_ListLandingZones.go index 380328498bf..8a252f986b2 100644 --- a/service/controltower/api_op_ListLandingZones.go +++ b/service/controltower/api_op_ListLandingZones.go @@ -13,7 +13,9 @@ import ( // Returns the landing zone ARN for the landing zone deployed in your managed // account. This API also creates an ARN for existing accounts that do not yet have -// a landing zone ARN. Returns one landing zone ARN. +// a landing zone ARN. +// +// Returns one landing zone ARN. func (c *Client) ListLandingZones(ctx context.Context, params *ListLandingZonesInput, optFns ...func(*Options)) (*ListLandingZonesOutput, error) { if params == nil { params = &ListLandingZonesInput{} diff --git a/service/controltower/api_op_ListTagsForResource.go b/service/controltower/api_op_ListTagsForResource.go index cf5b6e0af0f..22c4be9b0ab 100644 --- a/service/controltower/api_op_ListTagsForResource.go +++ b/service/controltower/api_op_ListTagsForResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of tags associated with the resource. For usage examples, see -// the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// Returns a list of tags associated with the resource. For usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -30,7 +30,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ARN of the resource. + // The ARN of the resource. // // This member is required. ResourceArn *string diff --git a/service/controltower/api_op_TagResource.go b/service/controltower/api_op_TagResource.go index 55899223813..517d8c7af8e 100644 --- a/service/controltower/api_op_TagResource.go +++ b/service/controltower/api_op_TagResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Applies tags to a resource. For usage examples, see the Amazon Web Services -// Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// Applies tags to a resource. For usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/controltower/api_op_UntagResource.go b/service/controltower/api_op_UntagResource.go index 5761c2d3969..e37faad3430 100644 --- a/service/controltower/api_op_UntagResource.go +++ b/service/controltower/api_op_UntagResource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes tags from a resource. For usage examples, see the Amazon Web Services -// Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// . +// Removes tags from a resource. For usage examples, see [the Amazon Web Services Control Tower User Guide]. +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/controltower/api_op_UpdateEnabledControl.go b/service/controltower/api_op_UpdateEnabledControl.go index 09bbce75157..12c8f1ac552 100644 --- a/service/controltower/api_op_UpdateEnabledControl.go +++ b/service/controltower/api_op_UpdateEnabledControl.go @@ -11,16 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the configuration of an already enabled control. If the enabled control -// shows an EnablementStatus of SUCCEEDED, supply parameters that are different -// from the currently configured parameters. Otherwise, Amazon Web Services Control -// Tower will not accept the request. If the enabled control shows an -// EnablementStatus of FAILED, Amazon Web Services Control Tower will update the -// control to match any valid parameters that you supply. If the DriftSummary -// status for the control shows as DRIFTED, you cannot call this API. Instead, you -// can update the control by calling DisableControl and again calling EnableControl -// , or you can run an extending governance operation. For usage examples, see the -// Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) +// Updates the configuration of an already enabled control. +// +// If the enabled control shows an EnablementStatus of SUCCEEDED, supply +// parameters that are different from the currently configured parameters. +// Otherwise, Amazon Web Services Control Tower will not accept the request. +// +// If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services +// Control Tower will update the control to match any valid parameters that you +// supply. +// +// If the DriftSummary status for the control shows as DRIFTED, you cannot call +// this API. Instead, you can update the control by calling DisableControl and +// again calling EnableControl , or you can run an extending governance operation. +// For usage examples, see [the Amazon Web Services Control Tower User Guide] +// +// [the Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html func (c *Client) UpdateEnabledControl(ctx context.Context, params *UpdateEnabledControlInput, optFns ...func(*Options)) (*UpdateEnabledControlOutput, error) { if params == nil { params = &UpdateEnabledControlInput{} @@ -38,7 +44,7 @@ func (c *Client) UpdateEnabledControl(ctx context.Context, params *UpdateEnabled type UpdateEnabledControlInput struct { - // The ARN of the enabled control that will be updated. + // The ARN of the enabled control that will be updated. // // This member is required. EnabledControlIdentifier *string @@ -53,7 +59,7 @@ type UpdateEnabledControlInput struct { type UpdateEnabledControlOutput struct { - // The operation identifier for this UpdateEnabledControl operation. + // The operation identifier for this UpdateEnabledControl operation. // // This member is required. OperationIdentifier *string diff --git a/service/controltower/api_op_UpdateLandingZone.go b/service/controltower/api_op_UpdateLandingZone.go index 1aee57f8eb8..74d49c9c694 100644 --- a/service/controltower/api_op_UpdateLandingZone.go +++ b/service/controltower/api_op_UpdateLandingZone.go @@ -37,8 +37,9 @@ type UpdateLandingZoneInput struct { LandingZoneIdentifier *string // The manifest.yaml file is a text file that describes your Amazon Web Services - // resources. For examples, review The manifest file (https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file) - // . + // resources. For examples, review [The manifest file]. + // + // [The manifest file]: https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file // // This member is required. Manifest document.Interface diff --git a/service/controltower/doc.go b/service/controltower/doc.go index 8ae72e6b1cd..722889d2a9f 100644 --- a/service/controltower/doc.go +++ b/service/controltower/doc.go @@ -5,53 +5,90 @@ // // These interfaces allow you to apply the Amazon Web Services library of // pre-defined controls to your organizational units, programmatically. In Amazon -// Web Services Control Tower, the terms "control" and "guardrail" are synonyms. To -// call these APIs, you'll need to know: +// Web Services Control Tower, the terms "control" and "guardrail" are synonyms. +// +// To call these APIs, you'll need to know: +// // - the controlIdentifier for the control--or guardrail--you are targeting. +// // - the ARN associated with the target organizational unit (OU), which we call // the targetIdentifier . +// // - the ARN associated with a resource that you wish to tag or untag. // // To get the controlIdentifier for your Amazon Web Services Control Tower -// control: The controlIdentifier is an ARN that is specified for each control. -// You can view the controlIdentifier in the console on the Control details page, -// as well as in the documentation. The controlIdentifier is unique in each Amazon -// Web Services Region for each control. You can find the controlIdentifier for -// each Region and control in the Tables of control metadata (https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html) -// in the Amazon Web Services Control Tower User Guide. A quick-reference list of -// control identifers for the Amazon Web Services Control Tower legacy Strongly -// recommended and Elective controls is given in Resource identifiers for APIs and -// controls (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html) -// in the Controls reference guide section (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) -// of the Amazon Web Services Control Tower User Guide. Remember that Mandatory -// controls cannot be added or removed. ARN format: -// arn:aws:controltower:{REGION}::control/{CONTROL_NAME} Example: -// arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED -// To get the targetIdentifier : The targetIdentifier is the ARN for an OU. In the -// Amazon Web Services Organizations console, you can find the ARN for the OU on -// the Organizational unit details page associated with that OU. OU ARN format: -// arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId} -// Details and examples -// - Control API input and output examples with CLI (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) -// - Enable controls with CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html) -// - Control metadata tables (https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html) -// - List of identifiers for legacy controls (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) -// - Controls reference guide (https://docs.aws.amazon.com/controltower/latest/userguide/controls.html) -// - Controls library groupings (https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.html) -// - Creating Amazon Web Services Control Tower resources with Amazon Web -// Services 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) -// Recording API Requests Amazon Web Services Control Tower 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 collected by CloudTrail, you can determine which requests -// the Amazon Web Services Control Tower service received, who made the request and -// when, and so on. For more about Amazon Web Services Control Tower and its -// support for CloudTrail, see Logging Amazon Web Services Control Tower Actions -// with Amazon Web Services CloudTrail (https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html) -// in the Amazon Web Services Control Tower User Guide. To learn more about -// CloudTrail, including how to turn it on and find your log files, see the Amazon -// Web Services CloudTrail User Guide. +// control: +// +// The controlIdentifier is an ARN that is specified for each control. You can +// view the controlIdentifier in the console on the Control details page, as well +// as in the documentation. +// +// The controlIdentifier is unique in each Amazon Web Services Region for each +// control. You can find the controlIdentifier for each Region and control in the [Tables of control metadata] +// in the Amazon Web Services Control Tower User Guide. +// +// A quick-reference list of control identifers for the Amazon Web Services +// Control Tower legacy Strongly recommended and Elective controls is given in [Resource identifiers for APIs and controls]in +// the [Controls reference guide section]of the Amazon Web Services Control Tower User Guide. Remember that +// Mandatory controls cannot be added or removed. +// +// ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME} +// +// Example: +// +// arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED +// +// To get the targetIdentifier : +// +// The targetIdentifier is the ARN for an OU. +// +// In the Amazon Web Services Organizations console, you can find the ARN for the +// OU on the Organizational unit details page associated with that OU. +// +// OU ARN format: +// +// arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId} +// +// # Details and examples +// +// [Control API input and output examples with CLI] +// +// [Enable controls with CloudFormation] +// +// [Control metadata tables] +// +// [List of identifiers for legacy controls] +// +// [Controls reference guide] +// +// [Controls library groupings] +// +// [Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation] +// +// To view the open source resource repository on GitHub, see [aws-cloudformation/aws-cloudformation-resource-providers-controltower] +// +// # Recording API Requests +// +// Amazon Web Services Control Tower 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 +// collected by CloudTrail, you can determine which requests the Amazon Web +// Services Control Tower service received, who made the request and when, and so +// on. For more about Amazon Web Services Control Tower and its support for +// CloudTrail, see [Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail]in the Amazon Web Services Control Tower User Guide. To learn +// more about CloudTrail, including how to turn it on and find your log files, see +// the Amazon Web Services CloudTrail User Guide. +// +// [Control metadata tables]: https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html +// [Controls library groupings]: https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.html +// [Controls reference guide section]: https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html +// [Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation]: https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html +// [Tables of control metadata]: https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html +// [List of identifiers for legacy controls]: https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html +// [aws-cloudformation/aws-cloudformation-resource-providers-controltower]: https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower +// [Resource identifiers for APIs and controls]: https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html +// [Control API input and output examples with CLI]: https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html +// [Controls reference guide]: https://docs.aws.amazon.com/controltower/latest/userguide/controls.html +// [Enable controls with CloudFormation]: https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html +// [Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail]: https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html package controltower diff --git a/service/controltower/options.go b/service/controltower/options.go index b4a656b1f8d..bdb39253b20 100644 --- a/service/controltower/options.go +++ b/service/controltower/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/controltower/types/enums.go b/service/controltower/types/enums.go index 8a7590d4c1d..7d9d88a756a 100644 --- a/service/controltower/types/enums.go +++ b/service/controltower/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for BaselineOperationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BaselineOperationStatus) Values() []BaselineOperationStatus { return []BaselineOperationStatus{ "SUCCEEDED", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for BaselineOperationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BaselineOperationType) Values() []BaselineOperationType { return []BaselineOperationType{ "ENABLE_BASELINE", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for ControlOperationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlOperationStatus) Values() []ControlOperationStatus { return []ControlOperationStatus{ "SUCCEEDED", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for ControlOperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlOperationType) Values() []ControlOperationType { return []ControlOperationType{ "ENABLE_CONTROL", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for DriftStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DriftStatus) Values() []DriftStatus { return []DriftStatus{ "DRIFTED", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for EnablementStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnablementStatus) Values() []EnablementStatus { return []EnablementStatus{ "SUCCEEDED", @@ -135,8 +141,9 @@ const ( ) // Values returns all known values for LandingZoneDriftStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LandingZoneDriftStatus) Values() []LandingZoneDriftStatus { return []LandingZoneDriftStatus{ "DRIFTED", @@ -155,6 +162,7 @@ const ( // Values returns all known values for LandingZoneOperationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LandingZoneOperationStatus) Values() []LandingZoneOperationStatus { return []LandingZoneOperationStatus{ @@ -176,6 +184,7 @@ const ( // Values returns all known values for LandingZoneOperationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LandingZoneOperationType) Values() []LandingZoneOperationType { return []LandingZoneOperationType{ @@ -196,8 +205,9 @@ const ( ) // Values returns all known values for LandingZoneStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LandingZoneStatus) Values() []LandingZoneStatus { return []LandingZoneStatus{ "ACTIVE", diff --git a/service/controltower/types/types.go b/service/controltower/types/types.go index 755328838cd..9b463b43c2d 100644 --- a/service/controltower/types/types.go +++ b/service/controltower/types/types.go @@ -77,20 +77,27 @@ type ControlOperation struct { noSmithyDocumentSerde } -// The drift summary of the enabled control. Amazon Web Services Control Tower -// expects the enabled control configuration to include all supported and governed -// Regions. If the enabled control differs from the expected configuration, it is -// defined to be in a state of drift. You can repair this drift by resetting the -// enabled control. +// The drift summary of the enabled control. +// +// Amazon Web Services Control Tower expects the enabled control configuration to +// include all supported and governed Regions. If the enabled control differs from +// the expected configuration, it is defined to be in a state of drift. You can +// repair this drift by resetting the enabled control. type DriftStatusSummary struct { - // The drift status of the enabled control. Valid values: + // The drift status of the enabled control. + // + // Valid values: + // // - DRIFTED : The enabledControl deployed in this configuration doesn’t match // the configuration that Amazon Web Services Control Tower expected. + // // - IN_SYNC : The enabledControl deployed in this configuration matches the // configuration that Amazon Web Services Control Tower expected. + // // - NOT_CHECKING : Amazon Web Services Control Tower does not check drift for // this enabled control. Drift is not supported for the control type. + // // - UNKNOWN : Amazon Web Services Control Tower is not able to check the drift // status for the enabled control. DriftStatus DriftStatus @@ -212,8 +219,9 @@ type EnabledControlDetails struct { Arn *string // The control identifier of the enabled control. For information on how to find - // the controlIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // the controlIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html ControlIdentifier *string // The drift status of the enabled control. @@ -226,8 +234,9 @@ type EnabledControlDetails struct { StatusSummary *EnablementStatusSummary // The ARN of the organizational unit. For information on how to find the - // targetIdentifier , see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html) - // . + // targetIdentifier , see [the overview page]. + // + // [the overview page]: https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html TargetIdentifier *string // Target Amazon Web Services Regions for the enabled control. @@ -295,9 +304,14 @@ type EnablementStatusSummary struct { // The last operation identifier for the enabled control. LastOperationIdentifier *string - // The deployment status of the enabled control. Valid values: + // The deployment status of the enabled control. + // + // Valid values: + // // - SUCCEEDED : The enabledControl configuration was deployed successfully. + // // - UNDER_CHANGE : The enabledControl configuration is changing. + // // - FAILED : The enabledControl configuration failed to deploy. Status EnablementStatus @@ -333,14 +347,19 @@ type LandingZoneDetail struct { noSmithyDocumentSerde } -// The drift status summary of the landing zone. If the landing zone differs from -// the expected configuration, it is defined to be in a state of drift. You can -// repair this drift by resetting the landing zone. +// The drift status summary of the landing zone. +// +// If the landing zone differs from the expected configuration, it is defined to +// be in a state of drift. You can repair this drift by resetting the landing zone. type LandingZoneDriftStatusSummary struct { - // The drift status of the landing zone. Valid values: + // The drift status of the landing zone. + // + // Valid values: + // // - DRIFTED : The landing zone deployed in this configuration does not match the // configuration that Amazon Web Services Control Tower expected. + // // - IN_SYNC : The landing zone deployed in this configuration matches the // configuration that Amazon Web Services Control Tower expected. Status LandingZoneDriftStatus @@ -354,10 +373,16 @@ type LandingZoneOperationDetail struct { // The landing zone operation end time. EndTime *time.Time - // The landing zone operation type. Valid values: + // The landing zone operation type. + // + // Valid values: + // // - DELETE : The DeleteLandingZone operation. + // // - CREATE : The CreateLandingZone operation. + // // - UPDATE : The UpdateLandingZone operation. + // // - RESET : The ResetLandingZone operation. OperationType LandingZoneOperationType @@ -365,8 +390,11 @@ type LandingZoneOperationDetail struct { StartTime *time.Time // Valid values: + // // - SUCCEEDED : The landing zone operation succeeded. + // // - IN_PROGRESS : The landing zone operation is in progress. + // // - FAILED : The landing zone operation failed. Status LandingZoneOperationStatus @@ -387,11 +415,13 @@ type LandingZoneSummary struct { } // An Amazon Web Services Region in which Amazon Web Services Control Tower -// expects to find the control deployed. The expected Regions are based on the -// Regions that are governed by the landing zone. In certain cases, a control is -// not actually enabled in the Region as expected, such as during drift, or mixed -// governance (https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance) -// . +// expects to find the control deployed. +// +// The expected Regions are based on the Regions that are governed by the landing +// zone. In certain cases, a control is not actually enabled in the Region as +// expected, such as during drift, or [mixed governance]. +// +// [mixed governance]: https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance type Region struct { // The Amazon Web Services Region name. diff --git a/service/costandusagereportservice/doc.go b/service/costandusagereportservice/doc.go index 36418e8d48b..b9657b3aa01 100644 --- a/service/costandusagereportservice/doc.go +++ b/service/costandusagereportservice/doc.go @@ -5,13 +5,22 @@ // // You can use the Amazon Web Services Cost and Usage Report API to // programmatically create, query, and delete Amazon Web Services Cost and Usage -// Report definitions. Amazon Web Services Cost and Usage Report track the monthly -// Amazon Web Services costs and usage associated with your Amazon Web Services -// account. The report contains line items for each unique combination of Amazon -// Web Services product, usage type, and operation that your Amazon Web Services -// account uses. You can configure the Amazon Web Services Cost and Usage Report to -// show only the data that you want, using the Amazon Web Services Cost and Usage -// Report API. Service Endpoint The Amazon Web Services Cost and Usage Report API -// provides the following endpoint: +// Report definitions. +// +// Amazon Web Services Cost and Usage Report track the monthly Amazon Web Services +// costs and usage associated with your Amazon Web Services account. +// +// The report contains line items for each unique combination of Amazon Web +// Services product, usage type, and operation that your Amazon Web Services +// account uses. +// +// You can configure the Amazon Web Services Cost and Usage Report to show only +// the data that you want, using the Amazon Web Services Cost and Usage Report API. +// +// # Service Endpoint +// +// The Amazon Web Services Cost and Usage Report API provides the following +// endpoint: +// // - cur.us-east-1.amazonaws.com package costandusagereportservice diff --git a/service/costandusagereportservice/options.go b/service/costandusagereportservice/options.go index 7efede34119..edfdc01fb9c 100644 --- a/service/costandusagereportservice/options.go +++ b/service/costandusagereportservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/costandusagereportservice/types/enums.go b/service/costandusagereportservice/types/enums.go index 94443aa98ed..cea674886bf 100644 --- a/service/costandusagereportservice/types/enums.go +++ b/service/costandusagereportservice/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AdditionalArtifact. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalArtifact) Values() []AdditionalArtifact { return []AdditionalArtifact{ "REDSHIFT", @@ -57,8 +58,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -102,8 +104,9 @@ const ( ) // Values returns all known values for CompressionFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionFormat) Values() []CompressionFormat { return []CompressionFormat{ "ZIP", @@ -122,8 +125,9 @@ const ( ) // Values returns all known values for LastStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastStatus) Values() []LastStatus { return []LastStatus{ "SUCCESS", @@ -141,8 +145,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -159,8 +164,9 @@ const ( ) // Values returns all known values for ReportVersioning. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportVersioning) Values() []ReportVersioning { return []ReportVersioning{ "CREATE_NEW_REPORT", @@ -178,8 +184,9 @@ const ( ) // Values returns all known values for SchemaElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaElement) Values() []SchemaElement { return []SchemaElement{ "RESOURCES", @@ -198,8 +205,9 @@ const ( ) // Values returns all known values for TimeUnit. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeUnit) Values() []TimeUnit { return []TimeUnit{ "HOURLY", diff --git a/service/costandusagereportservice/types/types.go b/service/costandusagereportservice/types/types.go index d393f9f7642..b11a7bbc134 100644 --- a/service/costandusagereportservice/types/types.go +++ b/service/costandusagereportservice/types/types.go @@ -57,7 +57,7 @@ type ReportDefinition struct { // A list of manifests that you want Amazon Web Services to create for this report. AdditionalArtifacts []AdditionalArtifact - // The Amazon resource name of the billing view. The BillingViewArn is needed to + // The Amazon resource name of the billing view. The BillingViewArn is needed to // create Amazon Web Services Cost and Usage Report for each billing group // maintained in the Amazon Web Services Billing Conductor service. The // BillingViewArn for a billing group can be constructed as: diff --git a/service/costexplorer/api_op_CreateAnomalyMonitor.go b/service/costexplorer/api_op_CreateAnomalyMonitor.go index b3ec7fa6adb..3d57bc53e7c 100644 --- a/service/costexplorer/api_op_CreateAnomalyMonitor.go +++ b/service/costexplorer/api_op_CreateAnomalyMonitor.go @@ -35,21 +35,31 @@ 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: + // An optional list of tags to associate with the specified [AnomalyMonitor]AnomalyMonitor . 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 + // + // [AnomalyMonitor]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html ResourceTags []types.ResourceTag noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_CreateAnomalySubscription.go b/service/costexplorer/api_op_CreateAnomalySubscription.go index 88f3e02aa02..54ec739d297 100644 --- a/service/costexplorer/api_op_CreateAnomalySubscription.go +++ b/service/costexplorer/api_op_CreateAnomalySubscription.go @@ -37,21 +37,32 @@ 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 - // 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: + // An optional list of tags to associate with the specified [AnomalySubscription]AnomalySubscription . + // 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 + // + // [AnomalySubscription]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html ResourceTags []types.ResourceTag noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_CreateCostCategoryDefinition.go b/service/costexplorer/api_op_CreateCostCategoryDefinition.go index 388a3472ad1..aab931e7cc2 100644 --- a/service/costexplorer/api_op_CreateCostCategoryDefinition.go +++ b/service/costexplorer/api_op_CreateCostCategoryDefinition.go @@ -39,9 +39,9 @@ type CreateCostCategoryDefinitionInput struct { // This member is required. 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) - // . + // The Cost Category rules used to categorize costs. For more information, see [CostCategoryRule]. + // + // [CostCategoryRule]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html // // This member is required. Rules []types.CostCategoryRule @@ -55,25 +55,35 @@ 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 - // 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: + // An optional list of tags to associate with the specified [CostCategory]CostCategory . 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 + // + // [CostCategory]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html ResourceTags []types.ResourceTag - // The split charge rules used to allocate your charges between your Cost Category - // values. + // The split charge rules used to allocate your charges between your Cost + // Category values. SplitChargeRules []types.CostCategorySplitChargeRule noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_DescribeCostCategoryDefinition.go b/service/costexplorer/api_op_DescribeCostCategoryDefinition.go index afc9a30f736..50f568fc4ea 100644 --- a/service/costexplorer/api_op_DescribeCostCategoryDefinition.go +++ b/service/costexplorer/api_op_DescribeCostCategoryDefinition.go @@ -12,11 +12,12 @@ import ( ) // Returns the name, Amazon Resource Name (ARN), rules, definition, and effective -// dates of a Cost Category that's defined in the account. You have the option to -// use EffectiveOn to return a Cost Category that's active on a specific date. If -// there's no EffectiveOn specified, you see a Cost Category that's effective on -// the current date. If Cost Category is still effective, EffectiveEnd is omitted -// in the response. +// dates of a Cost Category that's defined in the account. +// +// You have the option to use EffectiveOn to return a Cost Category that's active +// on a specific date. If there's no EffectiveOn specified, you see a Cost +// Category that's effective on the current date. If Cost Category is still +// effective, EffectiveEnd is omitted in the response. func (c *Client) DescribeCostCategoryDefinition(ctx context.Context, params *DescribeCostCategoryDefinitionInput, optFns ...func(*Options)) (*DescribeCostCategoryDefinitionOutput, error) { if params == nil { params = &DescribeCostCategoryDefinitionInput{} diff --git a/service/costexplorer/api_op_GetCostAndUsage.go b/service/costexplorer/api_op_GetCostAndUsage.go index 92e34300714..bfa19888a42 100644 --- a/service/costexplorer/api_op_GetCostAndUsage.go +++ b/service/costexplorer/api_op_GetCostAndUsage.go @@ -15,11 +15,14 @@ import ( // 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) -// 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) -// in the Billing and Cost Management User Guide. +// For a complete list of valid dimensions, see the [GetDimensionValues]operation. Management account +// in an organization in Organizations have access to all member accounts. +// +// For information about filter limitations, see [Quotas and restrictions] in the Billing and Cost +// Management User Guide. +// +// [GetDimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html +// [Quotas and restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-limits.html func (c *Client) GetCostAndUsage(ctx context.Context, params *GetCostAndUsageInput, optFns ...func(*Options)) (*GetCostAndUsageOutput, error) { if params == nil { params = &GetCostAndUsageInput{} @@ -45,16 +48,21 @@ type GetCostAndUsageInput struct { 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 , + // unblended rates, see [Why does the "blended" annotation appear on some line items in my bill?]. + // + // 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. + // UsageType or UsageTypeGroups . + // + // Metrics is required for GetCostAndUsage requests. + // + // [Why does the "blended" annotation appear on some line items in my bill?]: http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/ // // This member is required. Metrics []string @@ -70,19 +78,25 @@ 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 . + // any combination of dimension filters. For more information, see [Expression]. + // + // 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 . + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html 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 , + // 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. + // 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 76313919507..273b4ff18b0 100644 --- a/service/costexplorer/api_op_GetCostAndUsageWithResources.go +++ b/service/costexplorer/api_op_GetCostAndUsageWithResources.go @@ -15,14 +15,20 @@ import ( // 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) -// operation. Management account in an organization in Organizations have access to -// all member accounts. Hourly granularity is only available for EC2-Instances -// (Elastic Compute Cloud) resource-level data. All other resource-level data is -// available at daily granularity. 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. +// time range. For a complete list of valid dimensions, see the [GetDimensionValues]operation. +// Management account in an organization in Organizations have access to all member +// accounts. +// +// Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) +// resource-level data. All other resource-level data is available at daily +// granularity. +// +// 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]in the Billing and Cost Management User Guide. +// +// [GetDimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html +// [Controlling Access for Cost Explorer]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-access.html func (c *Client) GetCostAndUsageWithResources(ctx context.Context, params *GetCostAndUsageWithResourcesInput, optFns ...func(*Options)) (*GetCostAndUsageWithResourcesOutput, error) { if params == nil { params = &GetCostAndUsageWithResourcesInput{} @@ -43,13 +49,18 @@ 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]. + // + // The GetCostAndUsageWithResources operation requires that you either group by or + // filter by a ResourceId . It requires the [Expression]"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 . + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html // // This member is required. Filter *types.Expression @@ -76,17 +87,21 @@ type GetCostAndUsageWithResourcesInput struct { 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 , + // unblended rates, see [Why does the "blended" annotation appear on some line items in my bill?]. + // + // 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. + // UsageType or UsageTypeGroups . + // + // Metrics is required for GetCostAndUsageWithResources requests. + // + // [Why does the "blended" annotation appear on some line items in my bill?]: http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/ 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 502d0166d95..f1b4b5fe076 100644 --- a/service/costexplorer/api_op_GetCostCategories.go +++ b/service/costexplorer/api_op_GetCostCategories.go @@ -11,9 +11,10 @@ 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,64 +40,90 @@ 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: + // 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) - // . + // + // - Specify the Dimensions field to define a filter that acts on the [DimensionValues] + // DimensionValues . + // // - 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 + // + // 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" + // "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 . + // 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 . + // + // [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html 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 + // 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 @@ -105,22 +132,35 @@ type GetCostCategoriesInput struct { // call in your next request. 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. + // 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. SearchString *string - // The value that you sort the data by. The key represents the cost and usage - // metrics. The following values are supported: + // 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. SortBy []types.SortDefinition @@ -143,8 +183,10 @@ type GetCostCategoriesOutput struct { // The names of the Cost Categories. CostCategoryNames []string - // The Cost Category values. If the CostCategoryName key isn't specified in the - // request, the CostCategoryValues fields aren't returned. + // The Cost Category values. + // + // If the CostCategoryName key isn't specified in the request, the + // CostCategoryValues fields aren't returned. CostCategoryValues []string // If the number of objects that are still available for retrieval exceeds the diff --git a/service/costexplorer/api_op_GetCostForecast.go b/service/costexplorer/api_op_GetCostForecast.go index fdbc42819ee..5bb48903411 100644 --- a/service/costexplorer/api_op_GetCostForecast.go +++ b/service/costexplorer/api_op_GetCostForecast.go @@ -31,22 +31,30 @@ func (c *Client) GetCostForecast(ctx context.Context, params *GetCostForecastInp type GetCostForecastInput struct { // How granular you want the forecast to be. You can get 3 months of DAILY - // forecasts or 12 months of MONTHLY forecasts. The GetCostForecast operation - // supports only DAILY and MONTHLY granularities. + // forecasts or 12 months of MONTHLY forecasts. + // + // The GetCostForecast operation supports only DAILY and MONTHLY granularities. // // This member is required. Granularity types.Granularity // 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: + // about blended and unblended rates, see [Why does the "blended" annotation appear on some line items in my bill?]. + // + // Valid values for a GetCostForecast call are the following: + // // - AMORTIZED_COST + // // - BLENDED_COST + // // - NET_AMORTIZED_COST + // // - NET_UNBLENDED_COST + // // - UNBLENDED_COST // + // [Why does the "blended" annotation appear on some line items in my bill?]: http://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/ + // // This member is required. Metric types.Metric @@ -58,28 +66,51 @@ 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 Filter *types.Expression diff --git a/service/costexplorer/api_op_GetDimensionValues.go b/service/costexplorer/api_op_GetDimensionValues.go index b6552b1336d..80ab6eab780 100644 --- a/service/costexplorer/api_op_GetDimensionValues.go +++ b/service/costexplorer/api_op_GetDimensionValues.go @@ -32,8 +32,9 @@ 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) - // . + // be used in [CostCategoryRule]. + // + // [CostCategoryRule]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/AAPI_CostCategoryRule.html // // This member is required. Dimension types.Dimension @@ -50,146 +51,220 @@ type GetDimensionValuesInput struct { // 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 - // searching: + // 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 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. + // 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: + // 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) - // . + // + // - Specify the Dimensions field to define a filter that acts on the [DimensionValues] + // DimensionValues . + // // - 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 + // + // 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" + // "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 . + // 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 . + // + // [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html 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 @@ -200,18 +275,28 @@ type GetDimensionValuesInput struct { // The value that you want to search the filter values for. SearchString *string - // The value that you want to sort the data by. The key represents cost and usage - // metrics. The following values are supported: + // 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. + // + // 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 @@ -220,64 +305,98 @@ 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: + // 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 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. diff --git a/service/costexplorer/api_op_GetReservationCoverage.go b/service/costexplorer/api_op_GetReservationCoverage.go index 1465da2e1fd..96eae4feedb 100644 --- a/service/costexplorer/api_op_GetReservationCoverage.go +++ b/service/costexplorer/api_op_GetReservationCoverage.go @@ -18,20 +18,33 @@ 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 // -// 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{} @@ -63,43 +76,74 @@ type GetReservationCoverageInput struct { // 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) - // 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 - // defaults to EC2. Cost category is also supported. + // + // GetReservationCoverage uses the same [Expression] 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 defaults to EC2. + // + // Cost category is also supported. + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html 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 - // MONTHLY granularities. + // 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 GroupBy []types.GroupDefinition @@ -109,8 +153,10 @@ type GetReservationCoverageInput struct { // of objects. 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. + // 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. Metrics []string // The token to retrieve the next set of results. Amazon Web Services provides the @@ -118,18 +164,30 @@ type GetReservationCoverageInput struct { // page size. NextPageToken *string - // The value by which you want to sort the data. The following values are - // supported for Key : + // 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 diff --git a/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go b/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go index fe99e581cd0..4b14eb32df0 100644 --- a/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go +++ b/service/costexplorer/api_op_GetReservationPurchaseRecommendation.go @@ -13,21 +13,24 @@ import ( // 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 -// combination of reservations in each category of usage to identify the best -// number of each type of Reserved Instance (RI) to purchase to maximize your -// estimated savings. For example, Amazon Web Services automatically aggregates -// your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West -// (Oregon) Region and recommends that you buy size-flexible regional reservations -// to apply to the c4 family usage. Amazon Web Services recommends the smallest -// size instance in an instance family. This makes it easier to purchase a -// size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal -// number of normalized units. This way, you can purchase any instance size that -// you want. For this example, your RI recommendation is for c4.large because that -// is the smallest size instance in the c4 instance family. +// 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 combination of reservations in each +// category of usage to identify the best number of each type of Reserved Instance +// (RI) to purchase to maximize your estimated savings. +// +// For example, Amazon Web Services automatically aggregates your Amazon EC2 +// Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and +// recommends that you buy size-flexible regional reservations to apply to the c4 +// family usage. Amazon Web Services recommends the smallest size instance in an +// instance family. This makes it easier to purchase a size-flexible Reserved +// Instance (RI). Amazon Web Services also shows the equal number of normalized +// units. This way, you can purchase any instance size that you want. For this +// example, your RI recommendation is for c4.large because that is the smallest +// size instance in the c4 instance family. func (c *Client) GetReservationPurchaseRecommendation(ctx context.Context, params *GetReservationPurchaseRecommendationInput, optFns ...func(*Options)) (*GetReservationPurchaseRecommendationOutput, error) { if params == nil { params = &GetReservationPurchaseRecommendationInput{} @@ -59,57 +62,81 @@ type GetReservationPurchaseRecommendationInput struct { // 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: + // 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) - // . + // + // - Specify the Dimensions field to define a filter that acts on the [DimensionValues] + // DimensionValues . + // // - 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 + // + // 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" + // "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 . + // 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 . + // + // [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html 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 9becfd03e7a..b8c997555a2 100644 --- a/service/costexplorer/api_op_GetReservationUtilization.go +++ b/service/costexplorer/api_op_GetReservationUtilization.go @@ -43,27 +43,42 @@ type GetReservationUtilizationInput struct { // 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) - // 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. + // + // GetReservationUtilization uses the same [Expression] 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. + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html 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 + // GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY . + // + // The GetReservationUtilization operation supports only DAILY and MONTHLY // granularities. Granularity types.Granularity @@ -81,25 +96,44 @@ type GetReservationUtilizationInput struct { // page size. NextPageToken *string - // The value that you want to sort the data by. The following values are supported - // for Key : + // 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 . SortBy *types.SortDefinition diff --git a/service/costexplorer/api_op_GetRightsizingRecommendation.go b/service/costexplorer/api_op_GetRightsizingRecommendation.go index 15af92b25cc..9a020cbc2be 100644 --- a/service/costexplorer/api_op_GetRightsizingRecommendation.go +++ b/service/costexplorer/api_op_GetRightsizingRecommendation.go @@ -12,11 +12,13 @@ import ( ) // Creates recommendations that help you save cost by identifying idle and -// 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) -// in the Billing and Cost Management User Guide. +// 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]in the Billing and Cost Management User Guide. +// +// [Optimizing Your Cost with Rightsizing Recommendations]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html func (c *Client) GetRightsizingRecommendation(ctx context.Context, params *GetRightsizingRecommendationInput, optFns ...func(*Options)) (*GetRightsizingRecommendationOutput, error) { if params == nil { params = &GetRightsizingRecommendationInput{} @@ -47,57 +49,81 @@ 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: + // 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) - // . + // + // - Specify the Dimensions field to define a filter that acts on the [DimensionValues] + // DimensionValues . + // // - 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 + // + // 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" + // "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 . + // 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 . + // + // [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html 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 0a1ea30916d..a95054d2f8e 100644 --- a/service/costexplorer/api_op_GetSavingsPlansCoverage.go +++ b/service/costexplorer/api_op_GetSavingsPlansCoverage.go @@ -16,9 +16,13 @@ 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 // // To determine valid values for a dimension, use the GetDimensionValues operation. @@ -48,19 +52,29 @@ 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) - // 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. + // + // GetSavingsPlansCoverage uses the same [Expression] 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. + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html Filter *types.Expression // The granularity of the Amazon Web Services cost data for your Savings Plans. - // Granularity can't be set if GroupBy is set. The GetSavingsPlansCoverage - // operation supports only DAILY and MONTHLY granularities. + // Granularity can't be set if GroupBy is set. + // + // The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY + // granularities. Granularity types.Granularity // You can group the data using the attributes INSTANCE_FAMILY , REGION , or @@ -80,15 +94,24 @@ type GetSavingsPlansCoverageInput struct { // page size. NextToken *string - // The value that you want to sort the data by. The following values are supported - // for Key : + // 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 . SortBy *types.SortDefinition diff --git a/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go b/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go index 18cc22db2d2..a92988cb5d2 100644 --- a/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go +++ b/service/costexplorer/api_op_GetSavingsPlansPurchaseRecommendation.go @@ -62,12 +62,13 @@ type GetSavingsPlansPurchaseRecommendationInput struct { // You can filter your recommendations by Account ID with the LINKED_ACCOUNT // dimension. To filter your recommendations by Account ID, specify Key as // 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 - // 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. + // 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 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. Filter *types.Expression // The token to retrieve the next set of results. Amazon Web Services provides the diff --git a/service/costexplorer/api_op_GetSavingsPlansUtilization.go b/service/costexplorer/api_op_GetSavingsPlansUtilization.go index bc532167346..560b6ce277f 100644 --- a/service/costexplorer/api_op_GetSavingsPlansUtilization.go +++ b/service/costexplorer/api_op_GetSavingsPlansUtilization.go @@ -14,8 +14,9 @@ import ( // 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 . +// 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,28 +43,46 @@ 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) - // object as the other operations, but only AND is supported among each dimension. + // + // GetSavingsPlansUtilization uses the same [Expression] object as the other operations, but + // only AND is supported among each dimension. + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html Filter *types.Expression // The granularity of the Amazon Web Services utillization data for your Savings - // Plans. The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY + // Plans. + // + // The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY // granularities. Granularity types.Granularity - // The value that you want to sort the data by. The following values are supported - // for Key : + // 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 . SortBy *types.SortDefinition diff --git a/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go b/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go index 56bf5da487f..8226c94662b 100644 --- a/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go +++ b/service/costexplorer/api_op_GetSavingsPlansUtilizationDetails.go @@ -17,8 +17,9 @@ import ( // 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 . +// 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,13 +49,21 @@ 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) - // object as the other operations, but only AND is supported among each dimension. + // + // GetSavingsPlansUtilizationDetails uses the same [Expression] object as the other + // operations, but only AND is supported among each dimension. + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html Filter *types.Expression // The number of items to be returned in a response. The default is 20 , with a @@ -66,15 +75,24 @@ type GetSavingsPlansUtilizationDetailsInput struct { // page size. NextToken *string - // The value that you want to sort the data by. The following values are supported - // for Key : + // 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 . SortBy *types.SortDefinition diff --git a/service/costexplorer/api_op_GetTags.go b/service/costexplorer/api_op_GetTags.go index 69dd4cff62e..031065ff2e5 100644 --- a/service/costexplorer/api_op_GetTags.go +++ b/service/costexplorer/api_op_GetTags.go @@ -38,63 +38,89 @@ type GetTagsInput struct { // 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: + // 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) - // . + // + // - Specify the Dimensions field to define a filter that acts on the [DimensionValues] + // DimensionValues . + // // - 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 + // + // 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" + // "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 . + // 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 . + // + // [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html 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 @@ -105,17 +131,27 @@ type GetTagsInput struct { // The value that you want to search for. SearchString *string - // The value that you want to sort the data by. The key represents cost and usage - // metrics. The following values are supported: + // 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. + // + // 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 c7e5a048758..1403720534f 100644 --- a/service/costexplorer/api_op_GetUsageForecast.go +++ b/service/costexplorer/api_op_GetUsageForecast.go @@ -31,15 +31,19 @@ func (c *Client) GetUsageForecast(ctx context.Context, params *GetUsageForecastI type GetUsageForecastInput struct { // How granular you want the forecast to be. You can get 3 months of DAILY - // forecasts or 12 months of MONTHLY forecasts. The GetUsageForecast operation - // supports only DAILY and MONTHLY granularities. + // forecasts or 12 months of MONTHLY forecasts. + // + // The GetUsageForecast operation supports only DAILY and MONTHLY granularities. // // This member is required. Granularity types.Granularity - // Which metric Cost Explorer uses to create your forecast. Valid values for a - // GetUsageForecast call are the following: + // Which metric Cost Explorer uses to create your forecast. + // + // Valid values for a GetUsageForecast call are the following: + // // - USAGE_QUANTITY + // // - NORMALIZED_USAGE_AMOUNT // // This member is required. @@ -57,28 +61,51 @@ 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 Filter *types.Expression diff --git a/service/costexplorer/api_op_ListCostAllocationTagBackfillHistory.go b/service/costexplorer/api_op_ListCostAllocationTagBackfillHistory.go index c214c5f8431..83b7d0d8322 100644 --- a/service/costexplorer/api_op_ListCostAllocationTagBackfillHistory.go +++ b/service/costexplorer/api_op_ListCostAllocationTagBackfillHistory.go @@ -29,12 +29,12 @@ func (c *Client) ListCostAllocationTagBackfillHistory(ctx context.Context, param type ListCostAllocationTagBackfillHistoryInput struct { - // The maximum number of objects that are returned for this request. + // The maximum number of objects that are returned for this request. MaxResults *int32 - // The token to retrieve the next set of results. Amazon Web Services provides the - // token when the response from a previous call has more results than the maximum - // page size. + // The token to retrieve the next set of results. Amazon Web Services provides + // the token when the response from a previous call has more results than the + // maximum page size. NextToken *string noSmithyDocumentSerde @@ -42,12 +42,12 @@ type ListCostAllocationTagBackfillHistoryInput struct { type ListCostAllocationTagBackfillHistoryOutput struct { - // The list of historical cost allocation tag backfill requests. + // The list of historical cost allocation tag backfill requests. BackfillRequests []types.CostAllocationTagBackfillRequest - // The token to retrieve the next set of results. Amazon Web Services provides the - // token when the response from a previous call has more results than the maximum - // page size. + // The token to retrieve the next set of results. Amazon Web Services provides + // the token when the response from a previous call has more results than the + // maximum page size. NextToken *string // Metadata pertaining to the operation's result. @@ -143,7 +143,7 @@ var _ ListCostAllocationTagBackfillHistoryAPIClient = (*Client)(nil) // ListCostAllocationTagBackfillHistoryPaginatorOptions is the paginator options // for ListCostAllocationTagBackfillHistory type ListCostAllocationTagBackfillHistoryPaginatorOptions struct { - // The maximum number of objects that are returned for this request. + // The maximum number of objects that are returned for this request. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/costexplorer/api_op_ListCostAllocationTags.go b/service/costexplorer/api_op_ListCostAllocationTags.go index d2fba8f7eb4..d118e706911 100644 --- a/service/costexplorer/api_op_ListCostAllocationTags.go +++ b/service/costexplorer/api_op_ListCostAllocationTags.go @@ -56,7 +56,8 @@ type ListCostAllocationTagsInput struct { type ListCostAllocationTagsOutput struct { - // A list of cost allocation tags that includes the detailed metadata for each one. + // A list of cost allocation tags that includes the detailed metadata for each + // one. CostAllocationTags []types.CostAllocationTag // The token to retrieve the next set of results. Amazon Web Services provides the diff --git a/service/costexplorer/api_op_ListTagsForResource.go b/service/costexplorer/api_op_ListTagsForResource.go index 93f0e7d5040..7bf732c8419 100644 --- a/service/costexplorer/api_op_ListTagsForResource.go +++ b/service/costexplorer/api_op_ListTagsForResource.go @@ -31,8 +31,9 @@ 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]. + // + // [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_StartCostAllocationTagBackfill.go b/service/costexplorer/api_op_StartCostAllocationTagBackfill.go index 63a67e4757b..7c79a840bc4 100644 --- a/service/costexplorer/api_op_StartCostAllocationTagBackfill.go +++ b/service/costexplorer/api_op_StartCostAllocationTagBackfill.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Request a cost allocation tag backfill. This will backfill the activation +// Request a cost allocation tag backfill. This will backfill the activation +// // status (either active or inactive ) for all tag keys from para:BackfillFrom up -// to the when this request is made. You can request a backfill once every 24 -// hours. +// to the when this request is made. +// +// You can request a backfill once every 24 hours. func (c *Client) StartCostAllocationTagBackfill(ctx context.Context, params *StartCostAllocationTagBackfillInput, optFns ...func(*Options)) (*StartCostAllocationTagBackfillOutput, error) { if params == nil { params = &StartCostAllocationTagBackfillInput{} @@ -32,7 +34,7 @@ func (c *Client) StartCostAllocationTagBackfill(ctx context.Context, params *Sta type StartCostAllocationTagBackfillInput struct { - // The date you want the backfill to start from. The date can only be a first day + // The date you want the backfill to start from. The date can only be a first day // of the month (a billing start date). Dates can't precede the previous twelve // months, or in the future. // @@ -44,7 +46,7 @@ type StartCostAllocationTagBackfillInput struct { type StartCostAllocationTagBackfillOutput struct { - // An object containing detailed metadata of your new backfill request. + // An object containing detailed metadata of your new backfill request. BackfillRequest *types.CostAllocationTagBackfillRequest // Metadata pertaining to the operation's result. diff --git a/service/costexplorer/api_op_StartSavingsPlansPurchaseRecommendationGeneration.go b/service/costexplorer/api_op_StartSavingsPlansPurchaseRecommendationGeneration.go index 6b05f560baa..6da559d09b7 100644 --- a/service/costexplorer/api_op_StartSavingsPlansPurchaseRecommendationGeneration.go +++ b/service/costexplorer/api_op_StartSavingsPlansPurchaseRecommendationGeneration.go @@ -14,8 +14,10 @@ import ( // calculate a fresh set of Savings Plans recommendations that takes your latest // usage data and current Savings Plans inventory into account. You can refresh // Savings Plans recommendations up to three times daily for a consolidated billing -// family. StartSavingsPlansPurchaseRecommendationGeneration has no request syntax -// because no input parameters are needed to support this operation. +// family. +// +// StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because +// no input parameters are needed to support this operation. func (c *Client) StartSavingsPlansPurchaseRecommendationGeneration(ctx context.Context, params *StartSavingsPlansPurchaseRecommendationGenerationInput, optFns ...func(*Options)) (*StartSavingsPlansPurchaseRecommendationGenerationOutput, error) { if params == nil { params = &StartSavingsPlansPurchaseRecommendationGenerationInput{} diff --git a/service/costexplorer/api_op_TagResource.go b/service/costexplorer/api_op_TagResource.go index 4ea3487f80d..7a612b8135f 100644 --- a/service/costexplorer/api_op_TagResource.go +++ b/service/costexplorer/api_op_TagResource.go @@ -12,13 +12,15 @@ import ( ) // An API operation for adding one or more tags (key-value pairs) to a resource. +// // You can use the TagResource operation with a resource that already has tags. If // you specify a new tag key for the resource, this tag is appended to the list of // tags associated with the resource. If you specify a tag key that is already // associated with the resource, the new tag value you specify replaces the -// previous value for that tag. Although the maximum number of array members is -// 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services -// use. +// previous value for that tag. +// +// Although the maximum number of array members is 200, user-tag maximum is 50. +// The remaining are reserved for Amazon Web Services use. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -37,24 +39,33 @@ 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]. + // + // [ResourceTag]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_ResourceTag.html // // This member is required. ResourceArn *string - // 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: + // 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 // diff --git a/service/costexplorer/api_op_UntagResource.go b/service/costexplorer/api_op_UntagResource.go index e7a18b6bc96..e346f5a3d49 100644 --- a/service/costexplorer/api_op_UntagResource.go +++ b/service/costexplorer/api_op_UntagResource.go @@ -30,8 +30,9 @@ 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]. + // + // [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 7fb1f15a258..1df4f8fdc3d 100644 --- a/service/costexplorer/api_op_UpdateAnomalySubscription.go +++ b/service/costexplorer/api_op_UpdateAnomalySubscription.go @@ -12,9 +12,12 @@ import ( ) // Updates an existing cost anomaly subscription. Specify the fields that you want -// to update. Omitted fields are unchanged. The JSON below describes the generic -// construct for each type. See Request Parameters (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_UpdateAnomalySubscription.html#API_UpdateAnomalySubscription_RequestParameters) -// for possible values as they apply to AnomalySubscription . +// to update. Omitted fields are unchanged. +// +// The JSON below describes the generic construct for each type. See [Request Parameters] for possible +// values as they apply to AnomalySubscription . +// +// [Request Parameters]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_UpdateAnomalySubscription.html#API_UpdateAnomalySubscription_RequestParameters func (c *Client) UpdateAnomalySubscription(ctx context.Context, params *UpdateAnomalySubscriptionInput, optFns ...func(*Options)) (*UpdateAnomalySubscriptionOutput, error) { if params == nil { params = &UpdateAnomalySubscriptionInput{} @@ -49,42 +52,54 @@ type UpdateAnomalySubscriptionInput struct { // The new name of the subscription. SubscriptionName *string - // (deprecated) The update to the threshold value for receiving notifications. + // (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. You can specify either Threshold or ThresholdExpression, - // but not both. + // ThresholdExpression. + // + // You can specify either Threshold or ThresholdExpression, but not both. // // 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) - // 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 , - // corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, - // respectively (see Impact (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) - // for more details). 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 in string format. You can specify either Threshold or - // ThresholdExpression, but not both. The following are examples of valid - // ThresholdExpressions: + // The update to the [Expression] 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 , corresponding to an anomaly’s TotalImpact and + // TotalImpactPercentage, respectively (see [Impact]for more details). 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 in string + // format. + // + // You can specify either Threshold or ThresholdExpression, but not both. + // + // 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" ] } } ] } + // + // [Impact]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html ThresholdExpression *types.Expression noSmithyDocumentSerde diff --git a/service/costexplorer/api_op_UpdateCostCategoryDefinition.go b/service/costexplorer/api_op_UpdateCostCategoryDefinition.go index 96d1a2859f0..018ef53a2af 100644 --- a/service/costexplorer/api_op_UpdateCostCategoryDefinition.go +++ b/service/costexplorer/api_op_UpdateCostCategoryDefinition.go @@ -41,9 +41,9 @@ type UpdateCostCategoryDefinitionInput struct { // This member is required. 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) - // . + // The Expression object used to categorize costs. For more information, see [CostCategoryRule]. + // + // [CostCategoryRule]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html // // This member is required. Rules []types.CostCategoryRule @@ -57,8 +57,8 @@ type UpdateCostCategoryDefinitionInput struct { // future. EffectiveStart *string - // The split charge rules used to allocate your charges between your Cost Category - // values. + // The split charge rules used to allocate your charges between your Cost + // Category values. SplitChargeRules []types.CostCategorySplitChargeRule noSmithyDocumentSerde diff --git a/service/costexplorer/doc.go b/service/costexplorer/doc.go index 65de5ec43f0..3f00e298b64 100644 --- a/service/costexplorer/doc.go +++ b/service/costexplorer/doc.go @@ -7,11 +7,16 @@ // data. You can query for aggregated data such as total monthly costs or total // daily usage. You can also query for granular data. This might include the number // of daily write operations for Amazon DynamoDB database tables in your production -// environment. Service Endpoint The Cost Explorer API provides the following -// endpoint: +// environment. +// +// # Service Endpoint +// +// The Cost Explorer API provides the following endpoint: +// // - 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/) -// . +// see [Amazon Web Services Cost Management Pricing]. +// +// [Amazon Web Services Cost Management Pricing]: http://aws.amazon.com/aws-cost-management/pricing/ package costexplorer diff --git a/service/costexplorer/options.go b/service/costexplorer/options.go index 7303fa50a6e..141470eb1f9 100644 --- a/service/costexplorer/options.go +++ b/service/costexplorer/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/costexplorer/types/enums.go b/service/costexplorer/types/enums.go index 476b0048719..a3234df9c44 100644 --- a/service/costexplorer/types/enums.go +++ b/service/costexplorer/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AnomalyFeedbackType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyFeedbackType) Values() []AnomalyFeedbackType { return []AnomalyFeedbackType{ "YES", @@ -51,8 +53,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalySubscriptionFrequency) Values() []AnomalySubscriptionFrequency { return []AnomalySubscriptionFrequency{ "DAILY", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for ApproximationDimension. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApproximationDimension) Values() []ApproximationDimension { return []ApproximationDimension{ "SERVICE", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for Context. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Context) Values() []Context { return []Context{ "COST_AND_USAGE", @@ -110,8 +115,9 @@ const ( // Values returns all known values for CostAllocationTagBackfillStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostAllocationTagBackfillStatus) Values() []CostAllocationTagBackfillStatus { return []CostAllocationTagBackfillStatus{ "SUCCEEDED", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for CostAllocationTagStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostAllocationTagStatus) Values() []CostAllocationTagStatus { return []CostAllocationTagStatus{ "Active", @@ -147,8 +154,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AWSGenerated", @@ -166,8 +174,9 @@ const ( // Values returns all known values for CostCategoryInheritedValueDimensionName. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostCategoryInheritedValueDimensionName) Values() []CostCategoryInheritedValueDimensionName { return []CostCategoryInheritedValueDimensionName{ "LINKED_ACCOUNT_NAME", @@ -184,8 +193,9 @@ const ( ) // Values returns all known values for CostCategoryRuleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostCategoryRuleType) Values() []CostCategoryRuleType { return []CostCategoryRuleType{ "REGULAR", @@ -201,8 +211,9 @@ const ( ) // Values returns all known values for CostCategoryRuleVersion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostCategoryRuleVersion) Values() []CostCategoryRuleVersion { return []CostCategoryRuleVersion{ "CostCategoryExpression.v1", @@ -220,8 +231,9 @@ const ( // Values returns all known values for CostCategorySplitChargeMethod. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostCategorySplitChargeMethod) Values() []CostCategorySplitChargeMethod { return []CostCategorySplitChargeMethod{ "FIXED", @@ -239,8 +251,9 @@ const ( // Values returns all known values for CostCategorySplitChargeRuleParameterType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostCategorySplitChargeRuleParameterType) Values() []CostCategorySplitChargeRuleParameterType { return []CostCategorySplitChargeRuleParameterType{ "ALLOCATION_PERCENTAGES", @@ -256,8 +269,9 @@ const ( ) // Values returns all known values for CostCategoryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostCategoryStatus) Values() []CostCategoryStatus { return []CostCategoryStatus{ "PROCESSING", @@ -274,6 +288,7 @@ const ( // Values returns all known values for CostCategoryStatusComponent. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CostCategoryStatusComponent) Values() []CostCategoryStatusComponent { return []CostCategoryStatusComponent{ @@ -322,8 +337,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -386,8 +402,9 @@ const ( ) // Values returns all known values for FindingReasonCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingReasonCode) Values() []FindingReasonCode { return []FindingReasonCode{ "CPU_OVER_PROVISIONED", @@ -419,8 +436,9 @@ const ( ) // Values returns all known values for GenerationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GenerationStatus) Values() []GenerationStatus { return []GenerationStatus{ "SUCCEEDED", @@ -439,8 +457,9 @@ const ( ) // Values returns all known values for Granularity. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Granularity) Values() []Granularity { return []Granularity{ "DAILY", @@ -459,8 +478,9 @@ const ( ) // Values returns all known values for GroupDefinitionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupDefinitionType) Values() []GroupDefinitionType { return []GroupDefinitionType{ "DIMENSION", @@ -479,8 +499,9 @@ const ( ) // Values returns all known values for LookbackPeriodInDays. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LookbackPeriodInDays) Values() []LookbackPeriodInDays { return []LookbackPeriodInDays{ "SEVEN_DAYS", @@ -504,8 +525,9 @@ const ( ) // Values returns all known values for MatchOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchOption) Values() []MatchOption { return []MatchOption{ "EQUALS", @@ -533,8 +555,9 @@ const ( ) // Values returns all known values for Metric. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Metric) Values() []Metric { return []Metric{ "BLENDED_COST", @@ -555,8 +578,9 @@ const ( ) // Values returns all known values for MonitorDimension. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitorDimension) Values() []MonitorDimension { return []MonitorDimension{ "SERVICE", @@ -572,8 +596,9 @@ const ( ) // Values returns all known values for MonitorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitorType) Values() []MonitorType { return []MonitorType{ "DIMENSIONAL", @@ -594,8 +619,9 @@ const ( ) // Values returns all known values for NumericOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumericOperator) Values() []NumericOperator { return []NumericOperator{ "EQUAL", @@ -616,8 +642,9 @@ const ( ) // Values returns all known values for OfferingClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferingClass) Values() []OfferingClass { return []OfferingClass{ "STANDARD", @@ -638,8 +665,9 @@ const ( ) // Values returns all known values for PaymentOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PaymentOption) Values() []PaymentOption { return []PaymentOption{ "NO_UPFRONT", @@ -663,8 +691,9 @@ const ( ) // Values returns all known values for PlatformDifference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlatformDifference) Values() []PlatformDifference { return []PlatformDifference{ "HYPERVISOR", @@ -684,8 +713,9 @@ const ( ) // Values returns all known values for RecommendationTarget. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationTarget) Values() []RecommendationTarget { return []RecommendationTarget{ "SAME_INSTANCE_FAMILY", @@ -702,8 +732,9 @@ const ( ) // Values returns all known values for RightsizingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RightsizingType) Values() []RightsizingType { return []RightsizingType{ "TERMINATE", @@ -722,8 +753,9 @@ const ( ) // Values returns all known values for SavingsPlansDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlansDataType) Values() []SavingsPlansDataType { return []SavingsPlansDataType{ "ATTRIBUTES", @@ -742,8 +774,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -760,8 +793,9 @@ const ( ) // Values returns all known values for SubscriberStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriberStatus) Values() []SubscriberStatus { return []SubscriberStatus{ "CONFIRMED", @@ -778,8 +812,9 @@ const ( ) // Values returns all known values for SubscriberType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriberType) Values() []SubscriberType { return []SubscriberType{ "EMAIL", @@ -798,6 +833,7 @@ const ( // Values returns all known values for SupportedSavingsPlansType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SupportedSavingsPlansType) Values() []SupportedSavingsPlansType { return []SupportedSavingsPlansType{ @@ -816,8 +852,9 @@ const ( ) // Values returns all known values for TermInYears. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TermInYears) Values() []TermInYears { return []TermInYears{ "ONE_YEAR", diff --git a/service/costexplorer/types/errors.go b/service/costexplorer/types/errors.go index f6d6ab08efa..52355aa0eea 100644 --- a/service/costexplorer/types/errors.go +++ b/service/costexplorer/types/errors.go @@ -7,7 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// A request to backfill is already in progress. Once the previous request is +// A request to backfill is already in progress. Once the previous request is +// // complete, you can create another request. type BackfillLimitExceededException struct { Message *string @@ -219,8 +220,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You've reached the limit on the number of resources you can create, or exceeded -// the size of an individual resource. +// You've reached the limit on the number of resources you can create, or +// +// exceeded the size of an individual resource. type ServiceQuotaExceededException struct { Message *string diff --git a/service/costexplorer/types/types.go b/service/costexplorer/types/types.go index aa09b671180..cf0ff1fefc9 100644 --- a/service/costexplorer/types/types.go +++ b/service/costexplorer/types/types.go @@ -25,7 +25,8 @@ type Anomaly struct { // This member is required. Impact *Impact - // The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly. + // The Amazon Resource Name (ARN) for the cost monitor that generated this + // anomaly. // // This member is required. MonitorArn *string @@ -96,57 +97,81 @@ 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: + // 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) - // . + // + // - Specify the Dimensions field to define a filter that acts on the [DimensionValues] + // DimensionValues . + // // - 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 + // + // 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" + // "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 . + // 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 . + // + // [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html MonitorSpecification *Expression noSmithyDocumentSerde @@ -170,22 +195,28 @@ type AnomalyScore struct { // An AnomalySubscription resource (also referred to as an alert subscription) // sends notifications about specific anomalies that meet an alerting criteria -// defined by you. You can specify the frequency of the alerts and the subscribers -// to notify. Anomaly subscriptions can be associated with one or more -// AnomalyMonitor (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html) +// defined by you. +// +// You can specify the frequency of the alerts and the subscribers to notify. +// +// Anomaly subscriptions can be associated with one or more [AnomalyMonitor]AnomalyMonitor // resources, and they only send notifications about anomalies detected by those // associated monitors. You can also configure a threshold to further control which -// anomalies are included in the notifications. Anomalies that don’t exceed the -// chosen threshold and therefore don’t trigger notifications from an anomaly -// subscription will still be available on the console and from the GetAnomalies (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetAnomalies.html) -// API. +// anomalies are included in the notifications. +// +// Anomalies that don’t exceed the chosen threshold and therefore don’t trigger +// notifications from an anomaly subscription will still be available on the +// console and from the [GetAnomalies]GetAnomalies API. +// +// [AnomalyMonitor]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html +// [GetAnomalies]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetAnomalies.html type AnomalySubscription struct { // The frequency that anomaly notifications are sent. Notifications are sent // either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE - // frequency). For more information, see Creating an Amazon SNS topic for anomaly - // notifications (https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html) - // . + // frequency). For more information, see [Creating an Amazon SNS topic for anomaly notifications]. + // + // [Creating an Amazon SNS topic for anomaly notifications]: https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html // // This member is required. Frequency AnomalySubscriptionFrequency @@ -211,44 +242,58 @@ type AnomalySubscription struct { // The AnomalySubscription Amazon Resource Name (ARN). SubscriptionArn *string - // (deprecated) An absolute dollar value that must be exceeded by the anomaly's - // total impact (see Impact (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) - // for more details) for an anomaly notification to be generated. This field has - // been deprecated. To specify a threshold, use ThresholdExpression. Continued use - // of Threshold will be treated as shorthand syntax for a ThresholdExpression. One - // of Threshold or ThresholdExpression is required for this resource. You cannot - // specify both. + // (deprecated) + // + // An absolute dollar value that must be exceeded by the anomaly's total impact + // (see [Impact]for more details) for an anomaly notification to be generated. + // + // This field has been deprecated. To specify a threshold, use + // ThresholdExpression. Continued use of Threshold will be treated as shorthand + // syntax for a ThresholdExpression. + // + // One of Threshold or ThresholdExpression is required for this resource. You + // cannot specify both. + // + // [Impact]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html // // 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) - // object used to specify the anomalies that you want to generate alerts for. This - // supports dimensions and nested expressions. The supported dimensions are + // An [Expression] 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 , // corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, - // respectively (see Impact (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) - // for more details). 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 in string format. One of Threshold or ThresholdExpression - // is required for this resource. You cannot specify both. The following are - // examples of valid ThresholdExpressions: + // respectively (see [Impact]for more details). 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 in string format. + // + // One of Threshold or ThresholdExpression is required for this resource. You + // cannot specify both. + // + // 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" ] } } ] } + // + // [Impact]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html ThresholdExpression *Expression noSmithyDocumentSerde @@ -285,23 +330,24 @@ type CostAllocationTag struct { noSmithyDocumentSerde } -// The cost allocation tag backfill request structure that contains metadata and +// The cost allocation tag backfill request structure that contains metadata and +// // details of a certain backfill. type CostAllocationTagBackfillRequest struct { - // The date the backfill starts from. + // The date the backfill starts from. BackfillFrom *string - // The status of the cost allocation tag backfill request. + // The status of the cost allocation tag backfill request. BackfillStatus CostAllocationTagBackfillStatus - // The backfill completion time. + // The backfill completion time. CompletedAt *string - // The time when the backfill status was last updated. + // The time when the backfill status was last updated. LastUpdatedAt *string - // The time when the backfill was requested. + // The time when the backfill was requested. RequestedAt *string noSmithyDocumentSerde @@ -365,8 +411,8 @@ type CostCategory struct { // cost category. ProcessingStatus []CostCategoryProcessingStatus - // The split charge rules that are used to allocate your charges between your Cost - // Category values. + // The split charge rules that are used to allocate your charges between your + // Cost Category values. SplitChargeRules []CostCategorySplitChargeRule noSmithyDocumentSerde @@ -384,10 +430,11 @@ 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 - // key. + // 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 key. DimensionName CostCategoryInheritedValueDimensionName noSmithyDocumentSerde @@ -407,8 +454,10 @@ 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 . +// the Cost Category. +// +// You can use this information to retrieve the full Cost Category information +// using DescribeCostCategory . type CostCategoryReference struct { // The unique identifier for your Cost Category. @@ -448,15 +497,18 @@ type CostCategoryRule struct { // dimension. InheritedValue *CostCategoryInheritedValueDimension - // 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 + // An [Expression] object used to categorize costs. This supports dimensions, tags, and nested // expressions. Currently the only dimensions supported are LINKED_ACCOUNT , + // // SERVICE_CODE , RECORD_TYPE , LINKED_ACCOUNT_NAME , REGION , and USAGE_TYPE . + // // 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) - // in the Billing and Cost Management User Guide. + // see [Term Comparisons]in the Billing and Cost Management User Guide. + // + // [Expression]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html + // [Term Comparisons]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html#cost-categories-terms Rule *Expression // You can define the CostCategoryRule rule type as either REGULAR or @@ -479,10 +531,15 @@ type CostCategoryRule struct { 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. + // 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. // // This member is required. Method CostCategorySplitChargeMethod @@ -523,12 +580,15 @@ type CostCategorySplitChargeRuleParameter struct { noSmithyDocumentSerde } -// The Cost Categories values used for filtering the costs. If Values and Key are -// 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. +// The Cost Categories values used for filtering the costs. +// +// If Values and Key are 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. @@ -609,9 +669,12 @@ type CoverageHours struct { // as much of your reservation as the xlarge instance, even though both instances // 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. +// instance used 16 normalized units. +// +// For more information, see [Modifying Reserved Instances] in the Amazon Elastic Compute Cloud User Guide for +// Linux Instances. +// +// [Modifying Reserved Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html type CoverageNormalizedUnits struct { // The percentage of your used instance normalized units that a reservation covers. @@ -697,19 +760,27 @@ type DateInterval struct { type DimensionValues struct { // The names of the metadata types that you can use to filter and group your - // 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) - // . + // 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]. + // + // ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be + // used in [AnomalySubscriptions]. + // + // [AnomalySubscriptions]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html + // [CostCategoryRule]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.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 . + // 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 . MatchOptions []MatchOption // The metadata values that you can use to filter and group your results. You can @@ -923,58 +994,83 @@ 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: +// 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) -// . +// +// - Specify the Dimensions field to define a filter that acts on the [DimensionValues] +// DimensionValues . +// // - 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" +// +// 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 . +// 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 . +// +// [DimensionValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_DimensionValues.html type Expression struct { // Return results that match both Dimension objects. @@ -1634,11 +1730,14 @@ type ResourceDetails struct { noSmithyDocumentSerde } -// 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) -// . +// The tag structure that contains a tag key and value. +// +// Tagging is supported only for the following Cost Explorer resource types: [AnomalyMonitor] +// AnomalyMonitor , [AnomalySubscription]AnomalySubscription , [CostCategory]CostCategory . +// +// [AnomalySubscription]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html +// [AnomalyMonitor]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.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. @@ -1759,8 +1858,8 @@ type RightsizingRecommendationSummary struct { // The currency code that Amazon Web Services used to calculate the savings. SavingsCurrencyCode *string - // The savings percentage based on the recommended modifications. It's relative to - // the total On-Demand costs that are associated with these instances. + // The savings percentage based on the recommended modifications. It's relative + // to the total On-Demand costs that are associated with these instances. SavingsPercentage *string // The total number of instance recommendations. @@ -1929,7 +2028,7 @@ 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 + // 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 @@ -2182,11 +2281,14 @@ type Subscriber struct { noSmithyDocumentSerde } -// 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. +// 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 { // The key for the tag. diff --git a/service/costoptimizationhub/api_op_GetRecommendation.go b/service/costoptimizationhub/api_op_GetRecommendation.go index 2679a72f461..abe5913fadb 100644 --- a/service/costoptimizationhub/api_op_GetRecommendation.go +++ b/service/costoptimizationhub/api_op_GetRecommendation.go @@ -13,9 +13,11 @@ import ( ) // Returns both the current and recommended resource configuration and the -// estimated cost impact for a recommendation. The recommendationId is only valid -// for up to a maximum of 24 hours as recommendations are refreshed daily. To -// retrieve the recommendationId , use the ListRecommendations API. +// estimated cost impact for a recommendation. +// +// The recommendationId is only valid for up to a maximum of 24 hours as +// recommendations are refreshed daily. To retrieve the recommendationId , use the +// ListRecommendations API. func (c *Client) GetRecommendation(ctx context.Context, params *GetRecommendationInput, optFns ...func(*Options)) (*GetRecommendationOutput, error) { if params == nil { params = &GetRecommendationInput{} diff --git a/service/costoptimizationhub/api_op_ListRecommendationSummaries.go b/service/costoptimizationhub/api_op_ListRecommendationSummaries.go index c68132a4cfc..d77682e93f9 100644 --- a/service/costoptimizationhub/api_op_ListRecommendationSummaries.go +++ b/service/costoptimizationhub/api_op_ListRecommendationSummaries.go @@ -12,8 +12,9 @@ import ( ) // Returns a concise representation of savings estimates for resources. Also -// returns de-duped savings across different types of recommendations. The -// following filters are not supported for this API: recommendationIds , +// returns de-duped savings across different types of recommendations. +// +// The following filters are not supported for this API: recommendationIds , // resourceArns , and resourceIds . func (c *Client) ListRecommendationSummaries(ctx context.Context, params *ListRecommendationSummariesInput, optFns ...func(*Options)) (*ListRecommendationSummariesOutput, error) { if params == nil { diff --git a/service/costoptimizationhub/api_op_UpdateEnrollmentStatus.go b/service/costoptimizationhub/api_op_UpdateEnrollmentStatus.go index ca6846a397c..44b8ee462d8 100644 --- a/service/costoptimizationhub/api_op_UpdateEnrollmentStatus.go +++ b/service/costoptimizationhub/api_op_UpdateEnrollmentStatus.go @@ -12,12 +12,14 @@ import ( ) // Updates the enrollment (opt in and opt out) status of an account to the Cost -// Optimization Hub service. If the account is a management account of an -// organization, this action can also be used to enroll member accounts of the -// organization. You must have the appropriate permissions to opt in to Cost -// Optimization Hub and to view its recommendations. When you opt in, Cost -// Optimization Hub automatically creates a service-linked role in your account to -// access its data. +// Optimization Hub service. +// +// If the account is a management account of an organization, this action can also +// be used to enroll member accounts of the organization. +// +// You must have the appropriate permissions to opt in to Cost Optimization Hub +// and to view its recommendations. When you opt in, Cost Optimization Hub +// automatically creates a service-linked role in your account to access its data. func (c *Client) UpdateEnrollmentStatus(ctx context.Context, params *UpdateEnrollmentStatusInput, optFns ...func(*Options)) (*UpdateEnrollmentStatusOutput, error) { if params == nil { params = &UpdateEnrollmentStatusInput{} diff --git a/service/costoptimizationhub/doc.go b/service/costoptimizationhub/doc.go index 94816ea945b..ac6f69e027a 100644 --- a/service/costoptimizationhub/doc.go +++ b/service/costoptimizationhub/doc.go @@ -6,7 +6,9 @@ // You can use the Cost Optimization Hub API to programmatically identify, filter, // aggregate, and quantify savings for your cost optimization recommendations // across multiple Amazon Web Services Regions and Amazon Web Services accounts in -// your organization. The Cost Optimization Hub API provides the following -// endpoint: +// your organization. +// +// The Cost Optimization Hub API provides the following endpoint: +// // - https://cost-optimization-hub.us-east-1.amazonaws.com package costoptimizationhub diff --git a/service/costoptimizationhub/options.go b/service/costoptimizationhub/options.go index 3f035a3ed94..315ea542bbc 100644 --- a/service/costoptimizationhub/options.go +++ b/service/costoptimizationhub/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/costoptimizationhub/types/enums.go b/service/costoptimizationhub/types/enums.go index 8803ad57c10..c5e660a2564 100644 --- a/service/costoptimizationhub/types/enums.go +++ b/service/costoptimizationhub/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "Rightsize", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for EnrollmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnrollmentStatus) Values() []EnrollmentStatus { return []EnrollmentStatus{ "Active", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for ImplementationEffort. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImplementationEffort) Values() []ImplementationEffort { return []ImplementationEffort{ "VeryLow", @@ -80,8 +83,9 @@ const ( // Values returns all known values for MemberAccountDiscountVisibility. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberAccountDiscountVisibility) Values() []MemberAccountDiscountVisibility { return []MemberAccountDiscountVisibility{ "All", @@ -98,8 +102,9 @@ const ( ) // 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. +// the future, and so 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{ "Asc", @@ -127,8 +132,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -156,8 +162,9 @@ const ( ) // Values returns all known values for SavingsEstimationMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsEstimationMode) Values() []SavingsEstimationMode { return []SavingsEstimationMode{ "BeforeDiscounts", @@ -174,8 +181,9 @@ const ( ) // Values returns all known values for Source. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Source) Values() []Source { return []Source{ "ComputeOptimizer", @@ -193,6 +201,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/customerprofiles/api_op_AddProfileKey.go b/service/customerprofiles/api_op_AddProfileKey.go index 6cb684f6e9a..4ff6dfb079b 100644 --- a/service/customerprofiles/api_op_AddProfileKey.go +++ b/service/customerprofiles/api_op_AddProfileKey.go @@ -11,8 +11,10 @@ import ( ) // Associates a new key value with a specific profile, such as a Contact Record -// ContactId. A profile object can have a single unique key and any number of -// additional keys that can be used to identify the profile that it belongs to. +// ContactId. +// +// A profile object can have a single unique key and any number of additional keys +// that can be used to identify the profile that it belongs to. func (c *Client) AddProfileKey(ctx context.Context, params *AddProfileKeyInput, optFns ...func(*Options)) (*AddProfileKeyOutput, error) { if params == nil { params = &AddProfileKeyInput{} diff --git a/service/customerprofiles/api_op_CreateCalculatedAttributeDefinition.go b/service/customerprofiles/api_op_CreateCalculatedAttributeDefinition.go index f5ac1202622..f5377808bdc 100644 --- a/service/customerprofiles/api_op_CreateCalculatedAttributeDefinition.go +++ b/service/customerprofiles/api_op_CreateCalculatedAttributeDefinition.go @@ -14,10 +14,12 @@ import ( // Creates a new calculated attribute definition. After creation, new object data // ingested into Customer Profiles will be included in the calculated attribute, -// which can be retrieved for a profile using the GetCalculatedAttributeForProfile (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html) -// API. Defining a calculated attribute makes it available for all profiles within -// a domain. Each calculated attribute can only reference one ObjectType and at -// most, two fields from that ObjectType . +// which can be retrieved for a profile using the [GetCalculatedAttributeForProfile]API. Defining a calculated +// attribute makes it available for all profiles within a domain. Each calculated +// attribute can only reference one ObjectType and at most, two fields from that +// ObjectType . +// +// [GetCalculatedAttributeForProfile]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html func (c *Client) CreateCalculatedAttributeDefinition(ctx context.Context, params *CreateCalculatedAttributeDefinitionInput, optFns ...func(*Options)) (*CreateCalculatedAttributeDefinitionOutput, error) { if params == nil { params = &CreateCalculatedAttributeDefinitionInput{} diff --git a/service/customerprofiles/api_op_CreateDomain.go b/service/customerprofiles/api_op_CreateDomain.go index 9bc51667c9a..d5871ae2f62 100644 --- a/service/customerprofiles/api_op_CreateDomain.go +++ b/service/customerprofiles/api_op_CreateDomain.go @@ -15,13 +15,19 @@ import ( // Creates a domain, which is a container for all customer data, such as customer // profile attributes, object types, profile keys, and encryption keys. You can // 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) -// for sample policies that you should apply. +// 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] to enable [identity resolution]: set Matching to true. +// +// To prevent cross-service impersonation when you call this API, see [Cross-service confused deputy prevention] for sample +// policies that you should apply. +// +// [UpdateDomain]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html +// [Cross-service confused deputy prevention]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html +// [identity resolution]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} @@ -64,9 +70,13 @@ type CreateDomainInput struct { // 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) - // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest , you can download the results from S3. + // domains. + // + // After the Identity Resolution Job completes, use the [GetMatches] API to return and review + // the results. Or, if you have configured ExportingConfig in the MatchingRequest , + // you can download the results from S3. + // + // [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html Matching *types.MatchingRequest // The process of matching duplicate profiles using the Rule-Based matching. If @@ -119,9 +129,13 @@ type CreateDomainOutput struct { // 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) - // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest , you can download the results from S3. + // domains. + // + // After the Identity Resolution Job completes, use the [GetMatches] API to return and review + // the results. Or, if you have configured ExportingConfig in the MatchingRequest , + // you can download the results from S3. + // + // [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html Matching *types.MatchingResponse // The process of matching duplicate profiles using the Rule-Based matching. If diff --git a/service/customerprofiles/api_op_CreateEventStream.go b/service/customerprofiles/api_op_CreateEventStream.go index 648afe200b7..5c0831ab2a4 100644 --- a/service/customerprofiles/api_op_CreateEventStream.go +++ b/service/customerprofiles/api_op_CreateEventStream.go @@ -12,6 +12,7 @@ import ( // Creates an event stream, which is a subscription to real-time events, such as // when profiles are created and updated through Amazon Connect Customer Profiles. +// // Each event stream can be associated with only one Kinesis Data Stream // destination in the same region and Amazon Web Services account as the customer // profiles domain diff --git a/service/customerprofiles/api_op_CreateIntegrationWorkflow.go b/service/customerprofiles/api_op_CreateIntegrationWorkflow.go index 2b5449a3189..c17ae9fea1a 100644 --- a/service/customerprofiles/api_op_CreateIntegrationWorkflow.go +++ b/service/customerprofiles/api_op_CreateIntegrationWorkflow.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an integration workflow. An integration workflow is an async process +// Creates an integration workflow. An integration workflow is an async process +// // which ingests historic data and sets up an integration for ongoing updates. The // supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. func (c *Client) CreateIntegrationWorkflow(ctx context.Context, params *CreateIntegrationWorkflowInput, optFns ...func(*Options)) (*CreateIntegrationWorkflowOutput, error) { diff --git a/service/customerprofiles/api_op_CreateProfile.go b/service/customerprofiles/api_op_CreateProfile.go index e4c918fe347..eefff555b0e 100644 --- a/service/customerprofiles/api_op_CreateProfile.go +++ b/service/customerprofiles/api_op_CreateProfile.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a standard profile. A standard profile represents the following -// attributes for a customer profile in a domain. +// Creates a standard profile. +// +// A standard profile represents the following attributes for a customer profile +// in a domain. func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, optFns ...func(*Options)) (*CreateProfileOutput, error) { if params == nil { params = &CreateProfileInput{} diff --git a/service/customerprofiles/api_op_GetAutoMergingPreview.go b/service/customerprofiles/api_op_GetAutoMergingPreview.go index 968026d3af8..692754db746 100644 --- a/service/customerprofiles/api_op_GetAutoMergingPreview.go +++ b/service/customerprofiles/api_op_GetAutoMergingPreview.go @@ -16,12 +16,15 @@ import ( // matching results, and applies the automerging settings that you provided. You // can then view the number of profiles in the sample, the number of matches, and // the number of profiles identified to be merged. This enables you to evaluate the -// accuracy of the attributes in your matching list. You can't view which profiles -// 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 -// number of matches. This increases the chances of erroneous merges. +// accuracy of the attributes in your matching list. +// +// You can't view which profiles 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 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 { params = &GetAutoMergingPreviewInput{} diff --git a/service/customerprofiles/api_op_GetDomain.go b/service/customerprofiles/api_op_GetDomain.go index 1588c00cf3d..d050944500f 100644 --- a/service/customerprofiles/api_op_GetDomain.go +++ b/service/customerprofiles/api_op_GetDomain.go @@ -71,9 +71,13 @@ type GetDomainOutput struct { // 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) - // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest , you can download the results from S3. + // domains. + // + // After the Identity Resolution Job completes, use the [GetMatches] API to return and review + // the results. Or, if you have configured ExportingConfig in the MatchingRequest , + // you can download the results from S3. + // + // [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html Matching *types.MatchingResponse // The process of matching duplicate profiles using the Rule-Based matching. If diff --git a/service/customerprofiles/api_op_GetIdentityResolutionJob.go b/service/customerprofiles/api_op_GetIdentityResolutionJob.go index 03687cddb11..93c3fa464e4 100644 --- a/service/customerprofiles/api_op_GetIdentityResolutionJob.go +++ b/service/customerprofiles/api_op_GetIdentityResolutionJob.go @@ -13,9 +13,11 @@ 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]. +// +// [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,17 +82,24 @@ 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. Status types.IdentityResolutionJobStatus diff --git a/service/customerprofiles/api_op_GetMatches.go b/service/customerprofiles/api_op_GetMatches.go index 418440478fe..5a9b1a4690e 100644 --- a/service/customerprofiles/api_op_GetMatches.go +++ b/service/customerprofiles/api_op_GetMatches.go @@ -12,26 +12,38 @@ 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) -// 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 -// 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) -// 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 -// uses the following profile attributes to identify matches: +// Before calling this API, use [CreateDomain] or [UpdateDomain] 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 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] 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 uses the following profile attributes to identify matches: +// // - PhoneNumber +// // - HomePhoneNumber +// // - BusinessPhoneNumber +// // - MobilePhoneNumber +// // - EmailAddress +// // - PersonalEmailAddress +// // - BusinessEmailAddress +// // - FullName // // For example, two or more profiles—with spelling mistakes such as John Doe and @@ -39,6 +51,10 @@ import ( // 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. +// +// [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html +// [UpdateDomain]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html +// [CreateDomain]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html func (c *Client) GetMatches(ctx context.Context, params *GetMatchesInput, optFns ...func(*Options)) (*GetMatchesOutput, error) { if params == nil { params = &GetMatchesInput{} diff --git a/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go b/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go index 80e9d9e3f48..3b0d58e380d 100644 --- a/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go +++ b/service/customerprofiles/api_op_GetProfileObjectTypeTemplate.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the template information for a specific object type. A template is a -// predefined ProfileObjectType, such as “Salesforce-Account” or +// Returns the template information for a specific object type. +// +// A template is a predefined ProfileObjectType, such as “Salesforce-Account” or // “Salesforce-Contact.” When a user sends a ProfileObject, using the // PutProfileObject API, with an ObjectTypeName that matches one of the // TemplateIds, it uses the mappings from the template. diff --git a/service/customerprofiles/api_op_MergeProfiles.go b/service/customerprofiles/api_op_MergeProfiles.go index c99a1f49782..e123ff2641c 100644 --- a/service/customerprofiles/api_op_MergeProfiles.go +++ b/service/customerprofiles/api_op_MergeProfiles.go @@ -12,25 +12,35 @@ 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. // -// 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). +// You can use MergeProfiles together with [GetMatches], 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). +// +// [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html func (c *Client) MergeProfiles(ctx context.Context, params *MergeProfilesInput, optFns ...func(*Options)) (*MergeProfilesOutput, error) { if params == nil { params = &MergeProfilesInput{} diff --git a/service/customerprofiles/api_op_PutIntegration.go b/service/customerprofiles/api_op_PutIntegration.go index c01304c905b..7a9937bffbb 100644 --- a/service/customerprofiles/api_op_PutIntegration.go +++ b/service/customerprofiles/api_op_PutIntegration.go @@ -13,10 +13,14 @@ 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) -// . +// 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]/[UntagResource] . +// +// [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{} diff --git a/service/customerprofiles/api_op_PutProfileObject.go b/service/customerprofiles/api_op_PutProfileObject.go index 23e110f5250..d9f17660e2d 100644 --- a/service/customerprofiles/api_op_PutProfileObject.go +++ b/service/customerprofiles/api_op_PutProfileObject.go @@ -10,15 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds additional objects to customer profiles of a given ObjectType. When adding -// a specific profile object, like a Contact Record, an inferred profile can get -// created if it is not mapped to an existing profile. The resulting profile will -// only have a phone number populated in the standard ProfileObject. Any additional -// Contact Records with the same phone number will be mapped to the same inferred -// profile. When a ProfileObject is created and if a ProfileObjectType already -// exists for the ProfileObject, it will provide data to a standard profile -// depending on the ProfileObjectType definition. PutProfileObject needs an -// ObjectType, which can be created using PutProfileObjectType. +// Adds additional objects to customer profiles of a given ObjectType. +// +// When adding a specific profile object, like a Contact Record, an inferred +// profile can get created if it is not mapped to an existing profile. The +// resulting profile will only have a phone number populated in the standard +// ProfileObject. Any additional Contact Records with the same phone number will be +// mapped to the same inferred profile. +// +// When a ProfileObject is created and if a ProfileObjectType already exists for +// the ProfileObject, it will provide data to a standard profile depending on the +// ProfileObjectType definition. +// +// PutProfileObject needs an ObjectType, which can be created using +// PutProfileObjectType. func (c *Client) PutProfileObject(ctx context.Context, params *PutProfileObjectInput, optFns ...func(*Options)) (*PutProfileObjectOutput, error) { if params == nil { params = &PutProfileObjectInput{} diff --git a/service/customerprofiles/api_op_PutProfileObjectType.go b/service/customerprofiles/api_op_PutProfileObjectType.go index c52dc037532..d0042be7bc8 100644 --- a/service/customerprofiles/api_op_PutProfileObjectType.go +++ b/service/customerprofiles/api_op_PutProfileObjectType.go @@ -12,10 +12,12 @@ import ( "time" ) -// 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) -// . +// Defines a ProfileObjectType. +// +// To add or remove tags on an existing ObjectType, see [TagResource]/[UntagResource] . +// +// [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{} @@ -125,9 +127,10 @@ 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]. If you have sourceLastUpdatedTimestamp in your + // field, you must set up sourceLastUpdatedTimestampFormat . + // + // [SimpleDateFormat]: https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html 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 d726dcd4879..03864a1cd34 100644 --- a/service/customerprofiles/api_op_SearchProfiles.go +++ b/service/customerprofiles/api_op_SearchProfiles.go @@ -14,9 +14,10 @@ import ( // Searches for profiles within a specific domain using one or more predefined // search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or // custom-defined search keys. A search key is a data type pair that consists of a -// KeyName and Values list. This operation supports searching for profiles with a -// minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND -// or OR logic. +// KeyName and Values list. +// +// This operation supports searching for profiles with a minimum of 1 key-value(s) +// pair and up to 5 key-value(s) pairs using either AND or OR logic. func (c *Client) SearchProfiles(ctx context.Context, params *SearchProfilesInput, optFns ...func(*Options)) (*SearchProfilesOutput, error) { if params == nil { params = &SearchProfilesInput{} @@ -64,18 +65,23 @@ type SearchProfilesInput struct { // Relationship between all specified search keys that will be used to search for // profiles. This includes the required KeyName and Values parameters as well as - // 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: + // 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. LogicalOperator types.LogicalOperator - // The maximum number of objects returned per page. The default is 20 if this - // parameter is not included in the request. + // The maximum number of objects returned per page. + // + // The default is 20 if this parameter is not included in the request. MaxResults *int32 // The pagination token from the previous SearchProfiles API call. diff --git a/service/customerprofiles/api_op_TagResource.go b/service/customerprofiles/api_op_TagResource.go index a78ee79efa6..6d7794dde6c 100644 --- a/service/customerprofiles/api_op_TagResource.go +++ b/service/customerprofiles/api_op_TagResource.go @@ -15,13 +15,18 @@ import ( // 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. In // Connect Customer Profiles, domains, profile object types, and integrations can -// be tagged. Tags don't have any semantic meaning to AWS and are interpreted -// strictly as strings of characters. You can use the TagResource action with a -// resource that already has tags. If you specify a new tag key, this tag is -// appended to the list of tags associated with the resource. 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. +// be tagged. +// +// Tags don't have any semantic meaning to AWS and are interpreted strictly as +// strings of characters. +// +// You can use the TagResource action with a resource that already has tags. If +// you specify a new tag key, this tag is appended to the list of tags associated +// with the resource. 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/customerprofiles/api_op_UpdateDomain.go b/service/customerprofiles/api_op_UpdateDomain.go index aa4f61a6735..9f658d94f62 100644 --- a/service/customerprofiles/api_op_UpdateDomain.go +++ b/service/customerprofiles/api_op_UpdateDomain.go @@ -13,15 +13,22 @@ 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) -// 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) -// . +// letter queue or an encryption key. +// +// After a domain is created, the name can’t be changed. +// +// Use this API or [CreateDomain] to enable [identity resolution]: set Matching to true. +// +// To prevent cross-service impersonation when you call this API, see [Cross-service confused deputy prevention] for sample +// policies that you should apply. +// +// To add or remove tags on an existing Domain, see [TagResource]/[UntagResource] . +// +// [CreateDomain]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html +// [TagResource]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html +// [Cross-service confused deputy prevention]: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html +// [UntagResource]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html +// [identity resolution]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html func (c *Client) UpdateDomain(ctx context.Context, params *UpdateDomainInput, optFns ...func(*Options)) (*UpdateDomainOutput, error) { if params == nil { params = &UpdateDomainInput{} @@ -64,9 +71,13 @@ type UpdateDomainInput struct { // 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) - // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest , you can download the results from S3. + // domains. + // + // After the Identity Resolution Job completes, use the [GetMatches] API to return and review + // the results. Or, if you have configured ExportingConfig in the MatchingRequest , + // you can download the results from S3. + // + // [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html Matching *types.MatchingRequest // The process of matching duplicate profiles using the rule-Based matching. If @@ -117,9 +128,13 @@ type UpdateDomainOutput struct { // 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) - // API to return and review the results. Or, if you have configured ExportingConfig - // in the MatchingRequest , you can download the results from S3. + // domains. + // + // After the Identity Resolution Job completes, use the [GetMatches] API to return and review + // the results. Or, if you have configured ExportingConfig in the MatchingRequest , + // you can download the results from S3. + // + // [GetMatches]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html Matching *types.MatchingResponse // The process of matching duplicate profiles using the rule-Based matching. If diff --git a/service/customerprofiles/api_op_UpdateProfile.go b/service/customerprofiles/api_op_UpdateProfile.go index 8b021130f32..d743348afb0 100644 --- a/service/customerprofiles/api_op_UpdateProfile.go +++ b/service/customerprofiles/api_op_UpdateProfile.go @@ -12,9 +12,11 @@ import ( ) // Updates the properties of a profile. The ProfileId is required for updating a -// customer profile. When calling the UpdateProfile API, specifying an empty string -// value means that any existing value will be removed. Not specifying a string -// value means that any value already there will be kept. +// customer profile. +// +// When calling the UpdateProfile API, specifying an empty string value means that +// any existing value will be removed. Not specifying a string value means that any +// value already there will be kept. func (c *Client) UpdateProfile(ctx context.Context, params *UpdateProfileInput, optFns ...func(*Options)) (*UpdateProfileOutput, error) { if params == nil { params = &UpdateProfileInput{} diff --git a/service/customerprofiles/doc.go b/service/customerprofiles/doc.go index ab79abb833f..e59a44e9e08 100644 --- a/service/customerprofiles/doc.go +++ b/service/customerprofiles/doc.go @@ -3,12 +3,14 @@ // Package customerprofiles provides the API client, operations, and parameter // types for Amazon Connect Customer Profiles. // -// Amazon Connect Customer Profiles Amazon Connect Customer Profiles is a unified -// customer profile for your contact center that has pre-built connectors powered -// by AppFlow that make it easy to combine customer information from third party -// 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 Customer Profiles +// +// Amazon Connect Customer Profiles is a unified customer profile for your contact +// center that has pre-built connectors powered by AppFlow that make it easy to +// combine customer information from third party 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]. +// +// [Amazon Connect Administrator Guide]: https://docs.aws.amazon.com/connect/latest/adminguide/ package customerprofiles diff --git a/service/customerprofiles/options.go b/service/customerprofiles/options.go index a35d77298a9..c0a703eaf51 100644 --- a/service/customerprofiles/options.go +++ b/service/customerprofiles/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/customerprofiles/types/enums.go b/service/customerprofiles/types/enums.go index 3614b769cf9..9f7347afae6 100644 --- a/service/customerprofiles/types/enums.go +++ b/service/customerprofiles/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AttributeMatchingModel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeMatchingModel) Values() []AttributeMatchingModel { return []AttributeMatchingModel{ "ONE_TO_ONE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ConflictResolvingModel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictResolvingModel) Values() []ConflictResolvingModel { return []ConflictResolvingModel{ "RECENCY", @@ -47,8 +49,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -66,8 +69,9 @@ const ( // Values returns all known values for EventStreamDestinationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventStreamDestinationStatus) Values() []EventStreamDestinationStatus { return []EventStreamDestinationStatus{ "HEALTHY", @@ -84,8 +88,9 @@ const ( ) // Values returns all known values for EventStreamState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventStreamState) Values() []EventStreamState { return []EventStreamState{ "RUNNING", @@ -105,8 +110,9 @@ const ( ) // Values returns all known values for FieldContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FieldContentType) Values() []FieldContentType { return []FieldContentType{ "STRING", @@ -127,8 +133,9 @@ const ( ) // Values returns all known values for Gender. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Gender) Values() []Gender { return []Gender{ "MALE", @@ -152,6 +159,7 @@ const ( // Values returns all known values for IdentityResolutionJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IdentityResolutionJobStatus) Values() []IdentityResolutionJobStatus { return []IdentityResolutionJobStatus{ @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for JobScheduleDayOfTheWeek. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobScheduleDayOfTheWeek) Values() []JobScheduleDayOfTheWeek { return []JobScheduleDayOfTheWeek{ "SUNDAY", @@ -202,8 +211,9 @@ const ( ) // Values returns all known values for LogicalOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogicalOperator) Values() []LogicalOperator { return []LogicalOperator{ "AND", @@ -235,6 +245,7 @@ const ( // 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{ @@ -266,8 +277,9 @@ const ( ) // Values returns all known values for MatchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchType) Values() []MatchType { return []MatchType{ "RULE_BASED_MATCHING", @@ -286,8 +298,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "EQUAL_TO", @@ -318,8 +331,9 @@ const ( ) // Values returns all known values for OperatorPropertiesKeys. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperatorPropertiesKeys) Values() []OperatorPropertiesKeys { return []OperatorPropertiesKeys{ "VALUE", @@ -349,8 +363,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -369,8 +384,9 @@ const ( ) // Values returns all known values for RuleBasedMatchingStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleBasedMatchingStatus) Values() []RuleBasedMatchingStatus { return []RuleBasedMatchingStatus{ "PENDING", @@ -406,8 +422,9 @@ const ( ) // Values returns all known values for S3ConnectorOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ConnectorOperator) Values() []S3ConnectorOperator { return []S3ConnectorOperator{ "PROJECTION", @@ -462,6 +479,7 @@ const ( // Values returns all known values for SalesforceConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SalesforceConnectorOperator) Values() []SalesforceConnectorOperator { return []SalesforceConnectorOperator{ @@ -518,6 +536,7 @@ const ( // Values returns all known values for ServiceNowConnectorOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNowConnectorOperator) Values() []ServiceNowConnectorOperator { return []ServiceNowConnectorOperator{ @@ -557,8 +576,9 @@ const ( ) // Values returns all known values for SourceConnectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceConnectorType) Values() []SourceConnectorType { return []SourceConnectorType{ "Salesforce", @@ -584,8 +604,9 @@ const ( ) // Values returns all known values for StandardIdentifier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StandardIdentifier) Values() []StandardIdentifier { return []StandardIdentifier{ "PROFILE", @@ -614,8 +635,9 @@ const ( ) // 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. +// in the future, and so 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{ "FIRST_OCCURRENCE", @@ -643,8 +665,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "NOT_STARTED", @@ -671,8 +694,9 @@ const ( ) // Values returns all known values for TaskType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskType) Values() []TaskType { return []TaskType{ "Arithmetic", @@ -695,8 +719,9 @@ const ( ) // Values returns all known values for TriggerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerType) Values() []TriggerType { return []TriggerType{ "Scheduled", @@ -713,8 +738,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "DAYS", @@ -729,8 +755,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -759,6 +786,7 @@ const ( // 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{ diff --git a/service/customerprofiles/types/types.go b/service/customerprofiles/types/types.go index 7a3118eeb8d..c9df83e62b7 100644 --- a/service/customerprofiles/types/types.go +++ b/service/customerprofiles/types/types.go @@ -8,10 +8,11 @@ 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) -// API. +// conjunction with the [KeyName]and [Values] parameters to search for profiles using the [SearchProfiles] API. +// +// [KeyName]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName +// [SearchProfiles]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html +// [Values]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values type AdditionalSearchKey struct { // A searchable identifier of a customer profile. @@ -207,11 +208,17 @@ type AttributeItem struct { // identity resolution uses to match profiles. You can choose how profiles are // compared across attribute types and which attribute to use for matching from // each type. There are three attribute types you can configure: +// // - Email type +// // - You can choose from Email , BusinessEmail , and PersonalEmail +// // - Phone number type +// // - You can choose from Phone , HomePhone , and MobilePhone +// // - Address type +// // - You can choose from Address , BusinessAddress , MaillingAddress , and // ShippingAddress // @@ -232,26 +239,31 @@ type AttributeTypesSelector struct { AttributeMatchingModel AttributeMatchingModel // The Address type. You can choose from Address , BusinessAddress , - // MaillingAddress , and ShippingAddress . You only can use the Address type in the - // MatchingRule . For example, if you want to match profile based on - // BusinessAddress.City or MaillingAddress.City , you need to choose the - // BusinessAddress and the MaillingAddress to represent the Address type and - // specify the Address.City on the matching rule. + // MaillingAddress , and ShippingAddress . + // + // You only can use the Address type in the MatchingRule . For example, if you want + // to match profile based on BusinessAddress.City or MaillingAddress.City , you + // need to choose the BusinessAddress and the MaillingAddress to represent the + // Address type and specify the Address.City on the matching rule. Address []string // The Email type. You can choose from EmailAddress , BusinessEmailAddress and - // PersonalEmailAddress . You only can use the EmailAddress type in the - // MatchingRule . For example, if you want to match profile based on - // PersonalEmailAddress or BusinessEmailAddress , you need to choose the - // PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress - // type and only specify the EmailAddress on the matching rule. + // PersonalEmailAddress . + // + // You only can use the EmailAddress type in the MatchingRule . For example, if you + // want to match profile based on PersonalEmailAddress or BusinessEmailAddress , + // you need to choose the PersonalEmailAddress and the BusinessEmailAddress to + // represent the EmailAddress type and only specify the EmailAddress on the + // matching rule. EmailAddress []string // The PhoneNumber type. You can choose from PhoneNumber , HomePhoneNumber , and - // MobilePhoneNumber . You only can use the PhoneNumber type in the MatchingRule . - // For example, if you want to match a profile based on Phone or HomePhone , you - // need to choose the Phone and the HomePhone to represent the PhoneNumber type - // and only specify the PhoneNumber on the matching rule. + // MobilePhoneNumber . + // + // You only can use the PhoneNumber type in the MatchingRule . For example, if you + // want to match a profile based on Phone or HomePhone , you need to choose the + // Phone and the HomePhone to represent the PhoneNumber type and only specify the + // PhoneNumber on the matching rule. PhoneNumber []string noSmithyDocumentSerde @@ -267,7 +279,8 @@ type AutoMerging struct { // How the auto-merging process should resolve conflicts between different // profiles. For example, if Profile A and Profile B have the same FirstName and - // LastName (and that is the matching criteria), which EmailAddress should be used? + // LastName (and that is the matching criteria), which EmailAddress should be + // used? ConflictResolution *ConflictResolution // A list of matching attributes that represent matching criteria. If two profiles @@ -323,7 +336,9 @@ 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 @@ -487,11 +502,13 @@ type EventStreamSummary struct { } // Configuration information about the S3 bucket where Identity Resolution Jobs -// 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) -// . +// 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]. +// +// [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 type ExportingConfig struct { // The S3 location where Identity Resolution Jobs write result files. @@ -620,8 +637,9 @@ 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) -// request. +// find a profile returned in response to a [SearchProfiles]request. +// +// [SearchProfiles]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html type FoundByKeyValue struct { // A searchable identifier of a customer profile. @@ -658,17 +676,24 @@ 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. Status IdentityResolutionJobStatus @@ -990,22 +1015,39 @@ type MatchingResponse struct { // Specifies how does the rule-based matching process should match profiles. You // can choose from the following attributes to build the matching Rule: +// // - AccountNumber +// // - Address.Address +// // - Address.City +// // - Address.Country +// // - Address.County +// // - Address.PostalCode +// // - Address.State +// // - Address.Province +// // - BirthDate +// // - BusinessName +// // - EmailAddress +// // - FirstName +// // - Gender +// // - LastName +// // - MiddleName +// // - PhoneNumber +// // - Any customized profile attributes that start with the Attributes type MatchingRule struct { @@ -1138,22 +1180,26 @@ 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) - // 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) - // request, the FoundByItems list should be interpreted based on the - // LogicalOperator used in the request: + // A list of items used to find a profile returned in a [SearchProfiles] 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] 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) - // request. + // not included in the [SearchProfiles]request. + // + // [SearchProfiles]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html FoundByItems []FoundByKeyValue // The gender with which the customer identifies. @@ -1236,11 +1282,13 @@ type RuleBasedMatchingRequest struct { ConflictResolution *ConflictResolution // Configuration information about the S3 bucket where Identity Resolution Jobs - // 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) - // . + // 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]. + // + // [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 ExportingConfig *ExportingConfig // Configures how the rule-based matching process should match profiles. You can @@ -1250,7 +1298,9 @@ type RuleBasedMatchingRequest struct { // Indicates the maximum allowed rule level. MaxAllowedRuleLevelForMatching *int32 - // MatchingRule (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html) + // [MatchingRule] + // + // [MatchingRule]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html MaxAllowedRuleLevelForMerging *int32 noSmithyDocumentSerde @@ -1271,11 +1321,13 @@ type RuleBasedMatchingResponse struct { Enabled *bool // Configuration information about the S3 bucket where Identity Resolution Jobs - // 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) - // . + // 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]. + // + // [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 ExportingConfig *ExportingConfig // Configures how the rule-based matching process should match profiles. You can @@ -1285,19 +1337,26 @@ type RuleBasedMatchingResponse struct { // Indicates the maximum allowed rule level. MaxAllowedRuleLevelForMatching *int32 - // MatchingRule (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html) + // [MatchingRule] + // + // [MatchingRule]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html MaxAllowedRuleLevelForMerging *int32 // PENDING + // // - The first status after configuration a rule-based matching rule. If it is // an existing domain, the rule-based Identity Resolution waits one hour before // creating the matching rule. If it is a new domain, the system will skip the // PENDING stage. + // // IN_PROGRESS + // // - The system is creating the rule-based matching rule. Under this status, the // system is evaluating the existing data and you can no longer change the // Rule-based matching configuration. + // // ACTIVE + // // - The rule is ready to use. You can change the rule a day after the status is // in ACTIVE . Status RuleBasedMatchingStatus diff --git a/service/databasemigrationservice/api_op_AddTagsToResource.go b/service/databasemigrationservice/api_op_AddTagsToResource.go index a54ff64d081..1c66be343bf 100644 --- a/service/databasemigrationservice/api_op_AddTagsToResource.go +++ b/service/databasemigrationservice/api_op_AddTagsToResource.go @@ -14,8 +14,10 @@ import ( // 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) +// in a Condition statement in an IAM policy for DMS. For more information, see [Tag]Tag // data type description. +// +// [Tag]: https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} @@ -35,8 +37,9 @@ func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourc type AddTagsToResourceInput struct { // Identifies the DMS resource to which tags should be added. The value for this - // parameter is an Amazon Resource Name (ARN). For DMS, you can tag a replication - // instance, an endpoint, or a replication task. + // parameter is an Amazon Resource Name (ARN). + // + // For DMS, you can tag a replication instance, an endpoint, or a replication task. // // This member is required. ResourceArn *string diff --git a/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go b/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go index 339018ed193..592e64cce02 100644 --- a/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go +++ b/service/databasemigrationservice/api_op_ApplyPendingMaintenanceAction.go @@ -30,17 +30,23 @@ 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 + // The pending maintenance action to apply to this resource. + // + // Valid values: 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: + // 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. diff --git a/service/databasemigrationservice/api_op_BatchStartRecommendations.go b/service/databasemigrationservice/api_op_BatchStartRecommendations.go index ea3d97cc3cb..d7038a46060 100644 --- a/service/databasemigrationservice/api_op_BatchStartRecommendations.go +++ b/service/databasemigrationservice/api_op_BatchStartRecommendations.go @@ -12,11 +12,14 @@ import ( ) // 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 +// for each source database. This is a batch version of [StartRecommendations]. +// +// 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 . +// +// [StartRecommendations]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartRecommendations.html 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_CancelReplicationTaskAssessmentRun.go b/service/databasemigrationservice/api_op_CancelReplicationTaskAssessmentRun.go index d23c1962514..cee57e234be 100644 --- a/service/databasemigrationservice/api_op_CancelReplicationTaskAssessmentRun.go +++ b/service/databasemigrationservice/api_op_CancelReplicationTaskAssessmentRun.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a single premigration assessment run. This operation prevents any -// individual assessments from running if they haven't started running. It also -// attempts to cancel any individual assessments that are currently running. +// Cancels a single premigration assessment run. +// +// This operation prevents any individual assessments from running if they haven't +// started running. It also attempts to cancel any individual assessments that are +// currently running. func (c *Client) CancelReplicationTaskAssessmentRun(ctx context.Context, params *CancelReplicationTaskAssessmentRunInput, optFns ...func(*Options)) (*CancelReplicationTaskAssessmentRunOutput, error) { if params == nil { params = &CancelReplicationTaskAssessmentRunInput{} diff --git a/service/databasemigrationservice/api_op_CreateEndpoint.go b/service/databasemigrationservice/api_op_CreateEndpoint.go index 593829132cd..2d0e72c462d 100644 --- a/service/databasemigrationservice/api_op_CreateEndpoint.go +++ b/service/databasemigrationservice/api_op_CreateEndpoint.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an endpoint using the provided settings. For a MySQL source or target -// endpoint, don't explicitly specify the database using the DatabaseName request -// parameter on the CreateEndpoint API call. Specifying DatabaseName when you -// create a MySQL endpoint replicates all the task tables to this single database. -// For MySQL endpoints, you specify the database only when you specify the schema -// in the table-mapping rules of the DMS task. +// Creates an endpoint using the provided settings. +// +// For a MySQL source or target endpoint, don't explicitly specify the database +// using the DatabaseName request parameter on the CreateEndpoint API call. +// Specifying DatabaseName when you create a MySQL endpoint replicates all the +// task tables to this single database. For MySQL endpoints, you specify the +// database only when you specify the schema in the table-mapping rules of the DMS +// task. func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error) { if params == nil { params = &CreateEndpointInput{} @@ -64,28 +66,36 @@ type CreateEndpointInput struct { 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. + // // 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=string,BucketName=string + // + // JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": + // "string", "BucketName": "string", } DmsTransferSettings *types.DmsTransferSettings // 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB]in the Database Migration + // Service User Guide. + // + // [Using Object Mapping to Migrate Data to DynamoDB]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping 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) - // in the Database Migration Service User Guide. + // information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for DMS]in the Database Migration Service + // User Guide. + // + // [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 ElasticsearchSettings *types.ElasticsearchSettings // The external table definition. @@ -95,70 +105,81 @@ 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]in the Database Migration Service User Guide. + // + // [Working with DMS Endpoints]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html ExtraConnectionAttributes *string // Settings in JSON format for the source GCP MySQL endpoint. GcpMySQLSettings *types.GcpMySQLSettings // 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) - // in the Database Migration Service User Guide. + // about other available settings, see [Extra connection attributes when using Db2 LUW as a source for DMS]in the Database Migration Service User + // Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // information about the available settings, see [Using object mapping to migrate data to a Kafka topic]in the Database Migration Service + // User Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // Streams. For more information about the available settings, see [Using object mapping to migrate data to a Kinesis data stream]in the Database + // Migration Service User Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // endpoint. For information about other available settings, see [Extra connection attributes when using SQL Server as a source for DMS]and [Extra connection attributes when using SQL Server as a target for DMS] in the + // Database Migration Service User Guide. + // + // [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 + // [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 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) - // in the Database Migration Service User Guide. + // about the available settings, see [Endpoint configuration settings when using MongoDB as a source for Database Migration Service]in the Database Migration Service User Guide. + // + // [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 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) - // 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using MySQL as a source for DMS]and [Extra connection attributes when using a MySQL-compatible database as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 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) - // in the Database Migration Service User Guide. + // information about the available settings, see [Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target]in the Database Migration Service + // User Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using Oracle as a source for DMS]and [Extra connection attributes when using Oracle as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 OracleSettings *types.OracleSettings // The password to be used to log in to the endpoint database. @@ -168,10 +189,11 @@ 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using PostgreSQL as a source for DMS]and [Extra connection attributes when using PostgreSQL as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 PostgreSQLSettings *types.PostgreSQLSettings // Settings in JSON format for the target Redis endpoint. @@ -192,16 +214,16 @@ type CreateEndpointInput struct { 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) - // in the Database Migration Service User Guide. + // about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for DMS]in the Database Migration Service User Guide. + // + // [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 S3Settings *types.S3Settings // The name of the server where the endpoint database resides. ServerName *string - // The Amazon Resource Name (ARN) for the service access role that you want to use - // to create the endpoint. The role must allow the iam:PassRole action. + // The Amazon Resource Name (ARN) for the service access role that you want to + // use to create the endpoint. The role must allow the iam:PassRole action. ServiceAccessRoleArn *string // The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default @@ -209,10 +231,11 @@ 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using SAP ASE as a source for DMS]and [Extra connection attributes when using SAP ASE as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 SybaseSettings *types.SybaseSettings // One or more tags to be assigned to the endpoint. diff --git a/service/databasemigrationservice/api_op_CreateEventSubscription.go b/service/databasemigrationservice/api_op_CreateEventSubscription.go index 1dbee3aa83f..00c5e5bda62 100644 --- a/service/databasemigrationservice/api_op_CreateEventSubscription.go +++ b/service/databasemigrationservice/api_op_CreateEventSubscription.go @@ -11,19 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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] in the Database Migration Service +// User Guide. +// +// [Working with Events and Notifications]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error) { if params == nil { params = &CreateEventSubscriptionInput{} @@ -41,7 +45,7 @@ func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEven type CreateEventSubscriptionInput struct { - // The Amazon Resource Name (ARN) of the Amazon SNS topic created for event + // The Amazon Resource Name (ARN) of the Amazon SNS topic created for event // notification. The ARN is created by Amazon SNS when you create a topic and // subscribe to it. // @@ -54,26 +58,31 @@ type CreateEventSubscriptionInput struct { // This member is required. SubscriptionName *string - // A Boolean value; set to true to activate the subscription, or set to false to + // A Boolean value; set to true to activate the subscription, or set to false to // create the subscription but not activate it. 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]in the Database Migration Service User Guide. + // + // [Working with Events and Notifications]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html EventCategories []string - // A list of identifiers for which DMS provides notification events. If you don't - // specify a value, notifications are provided for all sources. If you specify - // multiple values, they must be of the same type. For example, if you specify a - // database instance ID, then all of the other values must be database instance - // IDs. + // A list of identifiers for which DMS provides notification events. + // + // If you don't specify a value, notifications are provided for all sources. + // + // If you specify multiple values, they must be of the same type. For example, if + // you specify a database instance ID, then all of the other values must be + // database instance IDs. SourceIds []string - // 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 + // 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 + // 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_CreateInstanceProfile.go b/service/databasemigrationservice/api_op_CreateInstanceProfile.go index d3d5809586c..2970f3ce362 100644 --- a/service/databasemigrationservice/api_op_CreateInstanceProfile.go +++ b/service/databasemigrationservice/api_op_CreateInstanceProfile.go @@ -41,11 +41,14 @@ type CreateInstanceProfileInput struct { InstanceProfileName *string // The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the - // connection parameters for the instance profile. If you don't specify a value for - // the KmsKeyArn 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. + // connection parameters for the instance profile. + // + // If you don't specify a value for the KmsKeyArn 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. KmsKeyArn *string // Specifies the network type for the instance profile. A value of IPV4 represents diff --git a/service/databasemigrationservice/api_op_CreateMigrationProject.go b/service/databasemigrationservice/api_op_CreateMigrationProject.go index 45e0e4cebe0..bc224bff433 100644 --- a/service/databasemigrationservice/api_op_CreateMigrationProject.go +++ b/service/databasemigrationservice/api_op_CreateMigrationProject.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates the migration project using the specified parameters. You can run this -// action only after you create an instance profile and data providers using -// CreateInstanceProfile (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateInstanceProfile.html) -// and CreateDataProvider (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateDataProvider.html) -// . +// Creates the migration project using the specified parameters. +// +// You can run this action only after you create an instance profile and data +// providers using [CreateInstanceProfile]and [CreateDataProvider]. +// +// [CreateDataProvider]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateDataProvider.html +// [CreateInstanceProfile]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateInstanceProfile.html func (c *Client) CreateMigrationProject(ctx context.Context, params *CreateMigrationProjectInput, optFns ...func(*Options)) (*CreateMigrationProjectOutput, error) { if params == nil { params = &CreateMigrationProjectInput{} diff --git a/service/databasemigrationservice/api_op_CreateReplicationConfig.go b/service/databasemigrationservice/api_op_CreateReplicationConfig.go index b4b3a9cbd03..806328811e4 100644 --- a/service/databasemigrationservice/api_op_CreateReplicationConfig.go +++ b/service/databasemigrationservice/api_op_CreateReplicationConfig.go @@ -49,9 +49,14 @@ type CreateReplicationConfigInput struct { ReplicationConfigIdentifier *string // The type of DMS Serverless replication to provision using this replication - // configuration. Possible values: + // configuration. + // + // Possible values: + // // - "full-load" + // // - "cdc" + // // - "full-load-and-cdc" // // This member is required. @@ -64,9 +69,9 @@ type CreateReplicationConfigInput struct { SourceEndpointArn *string // JSON table mappings for DMS Serverless replications that are provisioned using - // this replication configuration. For more information, see Specifying table - // selection and transformations rules using JSON (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.SelectionTransformation.html) - // . + // this replication configuration. For more information, see [Specifying table selection and transformations rules using JSON]. + // + // [Specifying table selection and transformations rules using JSON]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.SelectionTransformation.html // // This member is required. TableMappings *string @@ -78,25 +83,28 @@ type CreateReplicationConfigInput struct { TargetEndpointArn *string // Optional JSON settings for DMS Serverless replications that are provisioned - // using this replication configuration. For example, see Change processing tuning - // settings (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.ChangeProcessingTuning.html) - // . + // using this replication configuration. For example, see [Change processing tuning settings]. + // + // [Change processing tuning settings]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.ChangeProcessingTuning.html ReplicationSettings *string // Optional unique value or name that you set for a given resource that can be // used to construct an Amazon Resource Name (ARN) for that resource. For more - // information, see Fine-grained access control using resource names and tags (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.FineGrainedAccess) - // . + // information, see [Fine-grained access control using resource names and tags]. + // + // [Fine-grained access control using resource names and tags]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.FineGrainedAccess ResourceIdentifier *string // Optional JSON settings for specifying supplemental data. For more information, - // see Specifying supplemental data for task settings (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) - // . + // see [Specifying supplemental data for task settings]. + // + // [Specifying supplemental data for task settings]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html SupplementalSettings *string // One or more optional tags associated with resources used by the DMS Serverless - // replication. For more information, see Tagging resources in Database Migration - // Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html) . + // replication. For more information, see [Tagging resources in Database Migration Service]. + // + // [Tagging resources in Database Migration Service]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_CreateReplicationInstance.go b/service/databasemigrationservice/api_op_CreateReplicationInstance.go index a55881780f6..ec12a2415c4 100644 --- a/service/databasemigrationservice/api_op_CreateReplicationInstance.go +++ b/service/databasemigrationservice/api_op_CreateReplicationInstance.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . If you don't specify a version when creating a replication instance, DMS will +// 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]. For information on the required permissions, see [IAM Permissions Needed to Use DMS]. +// +// If you don't specify a version when creating a replication instance, DMS will // create the instance using the default engine version. For information about the -// default engine version, see Release Notes (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html) -// . +// default engine version, see [Release Notes]. +// +// [Release Notes]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html +// [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 +// [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{} @@ -40,20 +43,28 @@ 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 - // settings and capacities for the available replication instance classes, see - // Choosing the right DMS replication instance (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html) - // ; and, Selecting the best size for a replication instance (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_BestPractices.SizingReplicationInstance.html) - // . + // 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 [Choosing the right DMS replication instance]; and, [Selecting the best size for a replication instance]. + // + // [Selecting the best size for a replication instance]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_BestPractices.SizingReplicationInstance.html + // [Choosing the right DMS replication instance]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html // // This member is required. ReplicationInstanceClass *string // The replication instance identifier. This parameter is stored as a lowercase - // string. Constraints: + // 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. + // // Example: myrepinstance // // This member is required. @@ -65,7 +76,9 @@ 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 + // defaults to true . + // + // Default: true AutoMinorVersionUpgrade *bool // The Availability Zone where the replication instance will be created. The @@ -80,19 +93,24 @@ type CreateReplicationInstanceInput struct { // servers. For example: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4" DnsNameServers *string - // 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. + // 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. 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 + // 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 . MultiAZ *bool @@ -102,13 +120,19 @@ type CreateReplicationInstanceInput struct { NetworkType *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute - // window selected at random from an 8-hour block of time per 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. + // Coordinated Time (UTC). + // + // Format: ddd:hh24:mi-ddd:hh24:mi + // + // Default: A 30-minute window selected at random from an 8-hour block of time per + // 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 - // Specifies the accessibility options for the replication instance. A value of + // 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 . PubliclyAccessible *bool @@ -130,7 +154,7 @@ type CreateReplicationInstanceInput struct { // One or more tags to be assigned to the replication instance. Tags []types.Tag - // Specifies the VPC security group to be used with the replication instance. The + // Specifies the VPC security group to be used with the replication instance. The // VPC security group must work with the VPC containing the replication instance. VpcSecurityGroupIds []string diff --git a/service/databasemigrationservice/api_op_CreateReplicationSubnetGroup.go b/service/databasemigrationservice/api_op_CreateReplicationSubnetGroup.go index f39db7a98df..62d26fa305b 100644 --- a/service/databasemigrationservice/api_op_CreateReplicationSubnetGroup.go +++ b/service/databasemigrationservice/api_op_CreateReplicationSubnetGroup.go @@ -11,16 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a replication subnet group given a list of the subnet IDs in a VPC. The -// VPC needs to have at least one subnet in at least two availability zones in the -// Amazon Web Services Region, otherwise the service will throw a -// ReplicationSubnetGroupDoesNotCoverEnoughAZs exception. If a replication subnet -// group exists in your Amazon Web Services account, the +// Creates a replication subnet group given a list of the subnet IDs in a VPC. +// +// The VPC needs to have at least one subnet in at least two availability zones in +// the Amazon Web Services Region, otherwise the service will throw a +// ReplicationSubnetGroupDoesNotCoverEnoughAZs exception. +// +// If a replication subnet group exists in your Amazon Web Services account, the // CreateReplicationSubnetGroup action returns the following error message: The // Replication Subnet Group already exists. In this case, delete the existing -// replication subnet group. To do so, use the DeleteReplicationSubnetGroup (https://docs.aws.amazon.com/en_us/dms/latest/APIReference/API_DeleteReplicationSubnetGroup.html) -// action. Optionally, choose Subnet groups in the DMS console, then choose your -// subnet group. Next, choose Delete from Actions. +// replication subnet group. To do so, use the [DeleteReplicationSubnetGroup]action. Optionally, choose Subnet +// groups in the DMS console, then choose your subnet group. Next, choose Delete +// from Actions. +// +// [DeleteReplicationSubnetGroup]: https://docs.aws.amazon.com/en_us/dms/latest/APIReference/API_DeleteReplicationSubnetGroup.html func (c *Client) CreateReplicationSubnetGroup(ctx context.Context, params *CreateReplicationSubnetGroupInput, optFns ...func(*Options)) (*CreateReplicationSubnetGroupOutput, error) { if params == nil { params = &CreateReplicationSubnetGroupInput{} @@ -44,9 +48,12 @@ type CreateReplicationSubnetGroupInput struct { ReplicationSubnetGroupDescription *string // The name for the replication subnet group. This value is stored as a lowercase - // string. Constraints: Must contain no more than 255 alphanumeric characters, - // periods, spaces, underscores, or hyphens. Must not be "default". Example: - // mySubnetgroup + // string. + // + // Constraints: Must contain no more than 255 alphanumeric characters, periods, + // spaces, underscores, or hyphens. Must not be "default". + // + // Example: mySubnetgroup // // This member is required. ReplicationSubnetGroupIdentifier *string diff --git a/service/databasemigrationservice/api_op_CreateReplicationTask.go b/service/databasemigrationservice/api_op_CreateReplicationTask.go index 0bda760cba7..03bcfa11585 100644 --- a/service/databasemigrationservice/api_op_CreateReplicationTask.go +++ b/service/databasemigrationservice/api_op_CreateReplicationTask.go @@ -40,9 +40,14 @@ type CreateReplicationTaskInput struct { // This member is required. ReplicationInstanceArn *string - // An identifier for the replication task. Constraints: + // 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. // // This member is required. @@ -53,9 +58,10 @@ 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) - // in the Database Migration Service User Guide. + // The table mappings for the task, in JSON format. For more information, see [Using Table Mapping to Specify Task Settings] in + // the Database Migration Service User Guide. + // + // [Using Table Mapping to Specify Task Settings]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html // // This member is required. TableMappings *string @@ -67,34 +73,45 @@ type CreateReplicationTaskInput struct { // Indicates when you want a change data capture (CDC) operation to start. Use // either CdcStartPosition or CdcStartTime to specify when you want a CDC operation - // to start. Specifying both values results in an error. The value can be in date, - // checkpoint, or LSN/SCN format. Date Example: --cdc-start-position - // “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position + // to start. Specifying both values results in an error. + // + // The value can be in date, checkpoint, or LSN/SCN format. + // + // Date Example: --cdc-start-position “2018-03-08T12:12:12” + // + // Checkpoint Example: --cdc-start-position // "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" - // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” When you use - // this task setting with a source PostgreSQL database, a logical replication slot - // 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) - // . + // + // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + // + // When you use this task setting with a source PostgreSQL database, a logical + // replication slot 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]. + // + // [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 CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either // CdcStartTime or CdcStartPosition to specify when you want a CDC operation to - // start. Specifying both values results in an error. Timestamp Example: - // --cdc-start-time “2018-03-08T12:12:12” + // start. Specifying both values results in an error. + // + // Timestamp Example: --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: - // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: - // --cdc-stop-position “commit_time:2018-02-09T12:12:12“ + // 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) - // in the Database Migration Service User Guide. + // Overall settings for the task, in JSON format. For more information, see [Specifying Task Settings for Database Migration Service Tasks] in + // the Database Migration Service User Guide. + // + // [Specifying Task Settings for Database Migration Service Tasks]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html ReplicationTaskSettings *string // A friendly name for the resource identifier at the end of the EndpointArn @@ -112,9 +129,10 @@ type CreateReplicationTaskInput struct { Tags []types.Tag // 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. + // source and target endpoints. For more information, see [Specifying Supplemental Data for Task Settings]in the Database + // Migration Service User Guide. + // + // [Specifying Supplemental Data for Task Settings]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html TaskData *string noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_DeleteDataProvider.go b/service/databasemigrationservice/api_op_DeleteDataProvider.go index dc14dfb55b8..9709bbc11de 100644 --- a/service/databasemigrationservice/api_op_DeleteDataProvider.go +++ b/service/databasemigrationservice/api_op_DeleteDataProvider.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified data provider. All migration projects associated with the -// data provider must be deleted or modified before you can delete the data -// provider. +// Deletes the specified data provider. +// +// All migration projects associated with the data provider must be deleted or +// modified before you can delete the data provider. func (c *Client) DeleteDataProvider(ctx context.Context, params *DeleteDataProviderInput, optFns ...func(*Options)) (*DeleteDataProviderOutput, error) { if params == nil { params = &DeleteDataProviderInput{} diff --git a/service/databasemigrationservice/api_op_DeleteEndpoint.go b/service/databasemigrationservice/api_op_DeleteEndpoint.go index 93ea6cb98e3..c0150c3a3a2 100644 --- a/service/databasemigrationservice/api_op_DeleteEndpoint.go +++ b/service/databasemigrationservice/api_op_DeleteEndpoint.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified endpoint. All tasks associated with the endpoint must be -// deleted before you can delete the endpoint. +// Deletes the specified endpoint. +// +// All tasks associated with the endpoint must be deleted before you can delete +// the endpoint. func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error) { if params == nil { params = &DeleteEndpointInput{} diff --git a/service/databasemigrationservice/api_op_DeleteInstanceProfile.go b/service/databasemigrationservice/api_op_DeleteInstanceProfile.go index 1c738b79977..af8bd003dd3 100644 --- a/service/databasemigrationservice/api_op_DeleteInstanceProfile.go +++ b/service/databasemigrationservice/api_op_DeleteInstanceProfile.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified instance profile. All migration projects associated with -// the instance profile must be deleted or modified before you can delete the -// instance profile. +// Deletes the specified instance profile. +// +// All migration projects associated with the instance profile must be deleted or +// modified before you can delete the instance profile. func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstanceProfileInput, optFns ...func(*Options)) (*DeleteInstanceProfileOutput, error) { if params == nil { params = &DeleteInstanceProfileInput{} diff --git a/service/databasemigrationservice/api_op_DeleteMigrationProject.go b/service/databasemigrationservice/api_op_DeleteMigrationProject.go index d4ba5614bde..92ea06f0190 100644 --- a/service/databasemigrationservice/api_op_DeleteMigrationProject.go +++ b/service/databasemigrationservice/api_op_DeleteMigrationProject.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified migration project. The migration project must be closed -// before you can delete it. +// Deletes the specified migration project. +// +// The migration project must be closed before you can delete it. func (c *Client) DeleteMigrationProject(ctx context.Context, params *DeleteMigrationProjectInput, optFns ...func(*Options)) (*DeleteMigrationProjectOutput, error) { if params == nil { params = &DeleteMigrationProjectInput{} diff --git a/service/databasemigrationservice/api_op_DeleteReplicationInstance.go b/service/databasemigrationservice/api_op_DeleteReplicationInstance.go index 5e9211ad58b..bc505930d22 100644 --- a/service/databasemigrationservice/api_op_DeleteReplicationInstance.go +++ b/service/databasemigrationservice/api_op_DeleteReplicationInstance.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified replication instance. You must delete any migration tasks -// that are associated with the replication instance before you can delete it. +// Deletes the specified replication instance. +// +// You must delete any migration tasks that are associated with the replication +// instance before you can delete it. func (c *Client) DeleteReplicationInstance(ctx context.Context, params *DeleteReplicationInstanceInput, optFns ...func(*Options)) (*DeleteReplicationInstanceOutput, error) { if params == nil { params = &DeleteReplicationInstanceInput{} diff --git a/service/databasemigrationservice/api_op_DeleteReplicationTaskAssessmentRun.go b/service/databasemigrationservice/api_op_DeleteReplicationTaskAssessmentRun.go index a46d119cf8f..b1e07568d14 100644 --- a/service/databasemigrationservice/api_op_DeleteReplicationTaskAssessmentRun.go +++ b/service/databasemigrationservice/api_op_DeleteReplicationTaskAssessmentRun.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the record of a single premigration assessment run. This operation -// removes all metadata that DMS maintains about this assessment run. However, the -// operation leaves untouched all information about this assessment run that is -// stored in your Amazon S3 bucket. +// Deletes the record of a single premigration assessment run. +// +// This operation removes all metadata that DMS maintains about this assessment +// run. However, the operation leaves untouched all information about this +// assessment run that is stored in your Amazon S3 bucket. func (c *Client) DeleteReplicationTaskAssessmentRun(ctx context.Context, params *DeleteReplicationTaskAssessmentRunInput, optFns ...func(*Options)) (*DeleteReplicationTaskAssessmentRunOutput, error) { if params == nil { params = &DeleteReplicationTaskAssessmentRunInput{} diff --git a/service/databasemigrationservice/api_op_DescribeAccountAttributes.go b/service/databasemigrationservice/api_op_DescribeAccountAttributes.go index 4fe51285009..9d5bab4fdd3 100644 --- a/service/databasemigrationservice/api_op_DescribeAccountAttributes.go +++ b/service/databasemigrationservice/api_op_DescribeAccountAttributes.go @@ -17,8 +17,9 @@ import ( // 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. +// 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{} @@ -49,8 +50,9 @@ type DescribeAccountAttributesOutput struct { // 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. + // 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 86b8253abd1..079eabf00a2 100644 --- a/service/databasemigrationservice/api_op_DescribeApplicableIndividualAssessments.go +++ b/service/databasemigrationservice/api_op_DescribeApplicableIndividualAssessments.go @@ -12,22 +12,26 @@ import ( ) // Provides a list of individual assessments that you can specify for a new -// premigration assessment run, given one or more parameters. If you specify an -// existing migration task, this operation provides the default individual -// assessments you can specify for that task. Otherwise, the specified parameters -// model elements of a possible migration task on which to base a premigration -// assessment run. To use these migration task modeling parameters, you must -// specify an existing replication instance, a source database engine, a target -// database engine, and a migration type. This combination of parameters -// potentially limits the default individual assessments available for an -// assessment run created for a corresponding migration task. If you specify no -// parameters, this operation provides a list of all possible individual -// assessments that you can specify for an assessment run. If you specify any one -// of the task modeling parameters, you must specify all of them or the operation -// cannot provide a list of individual assessments. The only parameter that you can -// specify alone is for an existing migration task. The specified task definition -// then determines the default list of individual assessments that you can specify -// in an assessment run for the task. +// premigration assessment run, given one or more parameters. +// +// If you specify an existing migration task, this operation provides the default +// individual assessments you can specify for that task. Otherwise, the specified +// parameters model elements of a possible migration task on which to base a +// premigration assessment run. +// +// To use these migration task modeling parameters, you must specify an existing +// replication instance, a source database engine, a target database engine, and a +// migration type. This combination of parameters potentially limits the default +// individual assessments available for an assessment run created for a +// corresponding migration task. +// +// If you specify no parameters, this operation provides a list of all possible +// individual assessments that you can specify for an assessment run. If you +// specify any one of the task modeling parameters, you must specify all of them or +// the operation cannot provide a list of individual assessments. The only +// parameter that you can specify alone is for an existing migration task. The +// specified task definition then determines the default list of individual +// assessments that you can specify in an assessment run for the task. func (c *Client) DescribeApplicableIndividualAssessments(ctx context.Context, params *DescribeApplicableIndividualAssessmentsInput, optFns ...func(*Options)) (*DescribeApplicableIndividualAssessmentsOutput, error) { if params == nil { params = &DescribeApplicableIndividualAssessmentsInput{} @@ -83,9 +87,10 @@ type DescribeApplicableIndividualAssessmentsOutput struct { // List of names for the individual assessments supported by the premigration // 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) - // in the Database Migration Service User Guide. + // compatibility with different migration task configurations, see [Working with premigration assessment runs]in the Database + // Migration Service User Guide. + // + // [Working with premigration assessment runs]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html IndividualAssessmentNames []string // Pagination token returned for you to pass to a subsequent request. If you pass diff --git a/service/databasemigrationservice/api_op_DescribeCertificates.go b/service/databasemigrationservice/api_op_DescribeCertificates.go index db53701d27d..5e5f781a6f5 100644 --- a/service/databasemigrationservice/api_op_DescribeCertificates.go +++ b/service/databasemigrationservice/api_op_DescribeCertificates.go @@ -33,14 +33,15 @@ type DescribeCertificatesInput struct { // Valid values are certificate-arn and certificate-id . Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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: 10 MaxRecords *int32 @@ -152,9 +153,10 @@ var _ DescribeCertificatesAPIClient = (*Client)(nil) // DescribeCertificatesPaginatorOptions is the paginator options for // DescribeCertificates type DescribeCertificatesPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. + // 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: 10 Limit int32 diff --git a/service/databasemigrationservice/api_op_DescribeConnections.go b/service/databasemigrationservice/api_op_DescribeConnections.go index 5397100262e..6b608a32f31 100644 --- a/service/databasemigrationservice/api_op_DescribeConnections.go +++ b/service/databasemigrationservice/api_op_DescribeConnections.go @@ -35,19 +35,23 @@ func (c *Client) DescribeConnections(ctx context.Context, params *DescribeConnec type DescribeConnectionsInput struct { - // The filters applied to the connection. Valid filter names: endpoint-arn | - // replication-instance-arn + // The filters applied to the connection. + // + // Valid filter names: endpoint-arn | replication-instance-arn Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -58,7 +62,7 @@ type DescribeConnectionsOutput struct { // A description of the connections. Connections []types.Connection - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -159,10 +163,13 @@ var _ DescribeConnectionsAPIClient = (*Client)(nil) // DescribeConnectionsPaginatorOptions is the paginator options for // DescribeConnections type DescribeConnectionsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -276,12 +283,13 @@ type TestConnectionSucceedsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeConnectionsInput, *DescribeConnectionsOutput, error) (bool, error) } diff --git a/service/databasemigrationservice/api_op_DescribeDataProviders.go b/service/databasemigrationservice/api_op_DescribeDataProviders.go index 406e1ccb6be..7350e089582 100644 --- a/service/databasemigrationservice/api_op_DescribeDataProviders.go +++ b/service/databasemigrationservice/api_op_DescribeDataProviders.go @@ -31,15 +31,17 @@ func (c *Client) DescribeDataProviders(ctx context.Context, params *DescribeData type DescribeDataProvidersInput struct { // Filters applied to the data providers described in the form of key-value pairs. + // // Valid filter names: data-provider-identifier Filters []types.Filter // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -58,10 +60,11 @@ type DescribeDataProvidersOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeEndpointTypes.go b/service/databasemigrationservice/api_op_DescribeEndpointTypes.go index 396c24e1b81..b099fa71424 100644 --- a/service/databasemigrationservice/api_op_DescribeEndpointTypes.go +++ b/service/databasemigrationservice/api_op_DescribeEndpointTypes.go @@ -29,19 +29,23 @@ func (c *Client) DescribeEndpointTypes(ctx context.Context, params *DescribeEndp type DescribeEndpointTypesInput struct { - // Filters applied to the endpoint types. Valid filter names: engine-name | - // endpoint-type + // Filters applied to the endpoint types. + // + // Valid filter names: engine-name | endpoint-type Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -49,7 +53,7 @@ type DescribeEndpointTypesInput struct { type DescribeEndpointTypesOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -153,10 +157,13 @@ var _ DescribeEndpointTypesAPIClient = (*Client)(nil) // DescribeEndpointTypesPaginatorOptions is the paginator options for // DescribeEndpointTypes type DescribeEndpointTypesPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeEndpoints.go b/service/databasemigrationservice/api_op_DescribeEndpoints.go index a2cc3ee3f35..3b95f3be8f2 100644 --- a/service/databasemigrationservice/api_op_DescribeEndpoints.go +++ b/service/databasemigrationservice/api_op_DescribeEndpoints.go @@ -34,19 +34,23 @@ func (c *Client) DescribeEndpoints(ctx context.Context, params *DescribeEndpoint type DescribeEndpointsInput struct { - // Filters applied to the endpoints. Valid filter names: endpoint-arn | - // endpoint-type | endpoint-id | engine-name + // Filters applied to the endpoints. + // + // Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -57,7 +61,7 @@ type DescribeEndpointsOutput struct { // Endpoint description. Endpoints []types.Endpoint - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -157,10 +161,13 @@ var _ DescribeEndpointsAPIClient = (*Client)(nil) // DescribeEndpointsPaginatorOptions is the paginator options for DescribeEndpoints type DescribeEndpointsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -272,12 +279,13 @@ type EndpointDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEndpointsInput, *DescribeEndpointsOutput, error) (bool, error) } diff --git a/service/databasemigrationservice/api_op_DescribeEventCategories.go b/service/databasemigrationservice/api_op_DescribeEventCategories.go index 9f3e045fa6c..bf571d90cad 100644 --- a/service/databasemigrationservice/api_op_DescribeEventCategories.go +++ b/service/databasemigrationservice/api_op_DescribeEventCategories.go @@ -12,9 +12,10 @@ 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. +// source type. You can see a list of the event categories and source types in [Working with Events and Notifications]in +// the Database Migration Service User Guide. +// +// [Working with Events and Notifications]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEventCategoriesInput, optFns ...func(*Options)) (*DescribeEventCategoriesOutput, error) { if params == nil { params = &DescribeEventCategoriesInput{} @@ -35,8 +36,9 @@ type DescribeEventCategoriesInput struct { // Filters applied to the event categories. Filters []types.Filter - // The type of DMS resource that generates events. Valid values: - // replication-instance | replication-task + // The type of DMS resource that generates events. + // + // Valid values: replication-instance | replication-task SourceType *string noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go b/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go index b915b3739f7..2360232076d 100644 --- a/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go +++ b/service/databasemigrationservice/api_op_DescribeEventSubscriptions.go @@ -13,8 +13,10 @@ 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. +// 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{} @@ -32,19 +34,23 @@ func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *Describ type DescribeEventSubscriptionsInput struct { - // Filters applied to event subscriptions. Valid filter names: - // event-subscription-arn | event-subscription-id + // Filters applied to event subscriptions. + // + // Valid filter names: event-subscription-arn | event-subscription-id Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 // The name of the DMS event subscription to be described. @@ -58,7 +64,7 @@ type DescribeEventSubscriptionsOutput struct { // A list of event subscriptions. EventSubscriptionsList []types.EventSubscription - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -159,10 +165,13 @@ var _ DescribeEventSubscriptionsAPIClient = (*Client)(nil) // DescribeEventSubscriptionsPaginatorOptions is the paginator options for // DescribeEventSubscriptions type DescribeEventSubscriptionsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeEvents.go b/service/databasemigrationservice/api_op_DescribeEvents.go index e4dd52c73c7..ef9e96855d4 100644 --- a/service/databasemigrationservice/api_op_DescribeEvents.go +++ b/service/databasemigrationservice/api_op_DescribeEvents.go @@ -12,10 +12,12 @@ 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]in the +// Database Migration Service User Guide. +// +// [Working with Events and Notifications]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -45,22 +47,26 @@ type DescribeEventsInput struct { // 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 + // 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 . 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. + // 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. MaxRecords *int32 - // The identifier of an event source. + // The identifier of an event source. SourceIdentifier *string - // The type of DMS resource that generates events. Valid values: - // replication-instance | replication-task + // The type of DMS resource that generates events. + // + // Valid values: replication-instance | replication-task SourceType types.SourceType // The start time for the events to be listed. @@ -74,7 +80,7 @@ type DescribeEventsOutput struct { // The events described. Events []types.Event - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -174,10 +180,13 @@ var _ DescribeEventsAPIClient = (*Client)(nil) // DescribeEventsPaginatorOptions is the paginator options for DescribeEvents type DescribeEventsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeExtensionPackAssociations.go b/service/databasemigrationservice/api_op_DescribeExtensionPackAssociations.go index 33ade05cb71..bb134b91609 100644 --- a/service/databasemigrationservice/api_op_DescribeExtensionPackAssociations.go +++ b/service/databasemigrationservice/api_op_DescribeExtensionPackAssociations.go @@ -43,10 +43,11 @@ type DescribeExtensionPackAssociationsInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -62,10 +63,11 @@ type DescribeExtensionPackAssociationsOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go index bb7aa254056..f19e8f81276 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorCollectors.go @@ -29,11 +29,14 @@ func (c *Client) DescribeFleetAdvisorCollectors(ctx context.Context, params *Des type DescribeFleetAdvisorCollectorsInput struct { - // If you specify any of the following filters, the output includes information + // 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 diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go index 0dd47a1a26d..4e3325f0b4a 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorDatabases.go @@ -29,14 +29,21 @@ func (c *Client) DescribeFleetAdvisorDatabases(ctx context.Context, params *Desc type DescribeFleetAdvisorDatabasesInput struct { - // If you specify any of the following filters, the output includes information + // 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 diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go index f3fa2cc55fa..c879df298c0 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemaObjectSummary.go @@ -30,10 +30,12 @@ func (c *Client) DescribeFleetAdvisorSchemaObjectSummary(ctx context.Context, pa type DescribeFleetAdvisorSchemaObjectSummaryInput struct { - // If you specify any of the following filters, the output includes information + // 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 diff --git a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go index f0b25cc8934..0c0a1951105 100644 --- a/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go +++ b/service/databasemigrationservice/api_op_DescribeFleetAdvisorSchemas.go @@ -29,17 +29,27 @@ func (c *Client) DescribeFleetAdvisorSchemas(ctx context.Context, params *Descri type DescribeFleetAdvisorSchemasInput struct { - // If you specify any of the following filters, the output includes information + // 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 diff --git a/service/databasemigrationservice/api_op_DescribeInstanceProfiles.go b/service/databasemigrationservice/api_op_DescribeInstanceProfiles.go index 38b606ed203..439abe82ab1 100644 --- a/service/databasemigrationservice/api_op_DescribeInstanceProfiles.go +++ b/service/databasemigrationservice/api_op_DescribeInstanceProfiles.go @@ -36,10 +36,11 @@ type DescribeInstanceProfilesInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -58,10 +59,11 @@ type DescribeInstanceProfilesOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeMetadataModelAssessments.go b/service/databasemigrationservice/api_op_DescribeMetadataModelAssessments.go index 6e46d4a143a..b65d3eab1cd 100644 --- a/service/databasemigrationservice/api_op_DescribeMetadataModelAssessments.go +++ b/service/databasemigrationservice/api_op_DescribeMetadataModelAssessments.go @@ -41,10 +41,11 @@ type DescribeMetadataModelAssessmentsInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -60,10 +61,11 @@ type DescribeMetadataModelAssessmentsOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeMetadataModelConversions.go b/service/databasemigrationservice/api_op_DescribeMetadataModelConversions.go index 8e0177030fc..d1782882230 100644 --- a/service/databasemigrationservice/api_op_DescribeMetadataModelConversions.go +++ b/service/databasemigrationservice/api_op_DescribeMetadataModelConversions.go @@ -40,10 +40,11 @@ type DescribeMetadataModelConversionsInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -59,10 +60,11 @@ type DescribeMetadataModelConversionsOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeMetadataModelExportsAsScript.go b/service/databasemigrationservice/api_op_DescribeMetadataModelExportsAsScript.go index 309f6c834cc..422a424379e 100644 --- a/service/databasemigrationservice/api_op_DescribeMetadataModelExportsAsScript.go +++ b/service/databasemigrationservice/api_op_DescribeMetadataModelExportsAsScript.go @@ -40,10 +40,11 @@ type DescribeMetadataModelExportsAsScriptInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -59,10 +60,11 @@ type DescribeMetadataModelExportsAsScriptOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeMetadataModelExportsToTarget.go b/service/databasemigrationservice/api_op_DescribeMetadataModelExportsToTarget.go index f369692a7b7..a10ca2a6001 100644 --- a/service/databasemigrationservice/api_op_DescribeMetadataModelExportsToTarget.go +++ b/service/databasemigrationservice/api_op_DescribeMetadataModelExportsToTarget.go @@ -40,10 +40,11 @@ type DescribeMetadataModelExportsToTargetInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -59,10 +60,11 @@ type DescribeMetadataModelExportsToTargetOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeMetadataModelImports.go b/service/databasemigrationservice/api_op_DescribeMetadataModelImports.go index d7a32478a2e..b0220d1625a 100644 --- a/service/databasemigrationservice/api_op_DescribeMetadataModelImports.go +++ b/service/databasemigrationservice/api_op_DescribeMetadataModelImports.go @@ -40,10 +40,11 @@ type DescribeMetadataModelImportsInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -57,10 +58,11 @@ type DescribeMetadataModelImportsOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeMigrationProjects.go b/service/databasemigrationservice/api_op_DescribeMigrationProjects.go index 640dc5100ac..165d0034ca0 100644 --- a/service/databasemigrationservice/api_op_DescribeMigrationProjects.go +++ b/service/databasemigrationservice/api_op_DescribeMigrationProjects.go @@ -36,10 +36,11 @@ type DescribeMigrationProjectsInput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string @@ -55,10 +56,11 @@ type DescribeMigrationProjectsOutput struct { // 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 Marker - // is returned by a previous response, there are more results available. The value - // of Marker is a unique pagination token for each page. To retrieve the next - // page, make the call again using the returned token and keeping all other + // records beyond the marker, up to the value specified by MaxRecords . + // + // If Marker is returned by a previous response, there are more results available. + // The value of Marker is a unique pagination token for each page. To retrieve the + // next page, make the call again using the returned token and keeping all other // arguments unchanged. Marker *string diff --git a/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go b/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go index 47ad38ced7d..33de80e52d1 100644 --- a/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go +++ b/service/databasemigrationservice/api_op_DescribeOrderableReplicationInstances.go @@ -30,15 +30,18 @@ func (c *Client) DescribeOrderableReplicationInstances(ctx context.Context, para type DescribeOrderableReplicationInstancesInput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -46,7 +49,7 @@ type DescribeOrderableReplicationInstancesInput struct { type DescribeOrderableReplicationInstancesOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -147,10 +150,13 @@ var _ DescribeOrderableReplicationInstancesAPIClient = (*Client)(nil) // DescribeOrderableReplicationInstancesPaginatorOptions is the paginator options // for DescribeOrderableReplicationInstances type DescribeOrderableReplicationInstancesPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go b/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go index 35a09343061..90bd958d2c0 100644 --- a/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go +++ b/service/databasemigrationservice/api_op_DescribePendingMaintenanceActions.go @@ -32,15 +32,18 @@ type DescribePendingMaintenanceActionsInput struct { // Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 // The Amazon Resource Name (ARN) of the replication instance. @@ -51,7 +54,7 @@ type DescribePendingMaintenanceActionsInput struct { type DescribePendingMaintenanceActionsOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -155,10 +158,13 @@ var _ DescribePendingMaintenanceActionsAPIClient = (*Client)(nil) // DescribePendingMaintenanceActionsPaginatorOptions is the paginator options for // DescribePendingMaintenanceActions type DescribePendingMaintenanceActionsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go b/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go index 89fea6e744b..dcff299fc65 100644 --- a/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go +++ b/service/databasemigrationservice/api_op_DescribeRecommendationLimitations.go @@ -40,11 +40,12 @@ type DescribeRecommendationLimitationsInput struct { // 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. + // 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 3d9f23c2fa9..08a820d4cbd 100644 --- a/service/databasemigrationservice/api_op_DescribeRecommendations.go +++ b/service/databasemigrationservice/api_op_DescribeRecommendations.go @@ -41,11 +41,12 @@ type DescribeRecommendationsInput struct { // 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. + // 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_DescribeReplicationInstanceTaskLogs.go b/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go index e3a6b5a1742..e0eb33a5206 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationInstanceTaskLogs.go @@ -34,15 +34,18 @@ type DescribeReplicationInstanceTaskLogsInput struct { // This member is required. ReplicationInstanceArn *string - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -50,7 +53,7 @@ type DescribeReplicationInstanceTaskLogsInput struct { type DescribeReplicationInstanceTaskLogsOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -158,10 +161,13 @@ var _ DescribeReplicationInstanceTaskLogsAPIClient = (*Client)(nil) // 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeReplicationInstances.go b/service/databasemigrationservice/api_op_DescribeReplicationInstances.go index af8f13d6806..cde825e9e33 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationInstances.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationInstances.go @@ -35,20 +35,24 @@ func (c *Client) DescribeReplicationInstances(ctx context.Context, params *Descr type DescribeReplicationInstancesInput struct { - // Filters applied to replication instances. Valid filter names: - // replication-instance-arn | replication-instance-id | replication-instance-class - // | engine-version + // Filters applied to replication instances. + // + // Valid filter names: replication-instance-arn | replication-instance-id | + // replication-instance-class | engine-version Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -56,7 +60,7 @@ type DescribeReplicationInstancesInput struct { type DescribeReplicationInstancesOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -160,10 +164,13 @@ var _ DescribeReplicationInstancesAPIClient = (*Client)(nil) // DescribeReplicationInstancesPaginatorOptions is the paginator options for // DescribeReplicationInstances type DescribeReplicationInstancesPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -279,12 +286,13 @@ type ReplicationInstanceAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationInstancesInput, *DescribeReplicationInstancesOutput, error) (bool, error) } @@ -566,12 +574,13 @@ type ReplicationInstanceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationInstancesInput, *DescribeReplicationInstancesOutput, error) (bool, error) } diff --git a/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go b/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go index c2525473867..1a6ed239f79 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationSubnetGroups.go @@ -29,19 +29,23 @@ func (c *Client) DescribeReplicationSubnetGroups(ctx context.Context, params *De type DescribeReplicationSubnetGroupsInput struct { - // Filters applied to replication subnet groups. Valid filter names: - // replication-subnet-group-id + // Filters applied to replication subnet groups. + // + // Valid filter names: replication-subnet-group-id Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -49,7 +53,7 @@ type DescribeReplicationSubnetGroupsInput struct { type DescribeReplicationSubnetGroupsOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -153,10 +157,13 @@ var _ DescribeReplicationSubnetGroupsAPIClient = (*Client)(nil) // DescribeReplicationSubnetGroupsPaginatorOptions is the paginator options for // DescribeReplicationSubnetGroups type DescribeReplicationSubnetGroupsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go index 1e159a07a57..982c3522fe9 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentResults.go @@ -13,9 +13,12 @@ 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) -// in the Database Migration Service User Guide. +// results. +// +// For more information about DMS task assessments, see [Creating a task assessment report] in the Database Migration +// Service User Guide. +// +// [Creating a task assessment report]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html func (c *Client) DescribeReplicationTaskAssessmentResults(ctx context.Context, params *DescribeReplicationTaskAssessmentResultsInput, optFns ...func(*Options)) (*DescribeReplicationTaskAssessmentResultsOutput, error) { if params == nil { params = &DescribeReplicationTaskAssessmentResultsInput{} @@ -33,15 +36,18 @@ func (c *Client) DescribeReplicationTaskAssessmentResults(ctx context.Context, p type DescribeReplicationTaskAssessmentResultsInput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 // The Amazon Resource Name (ARN) string that uniquely identifies the task. When @@ -57,12 +63,12 @@ type DescribeReplicationTaskAssessmentResultsOutput struct { // - The Amazon S3 bucket where the task assessment report is located. BucketName *string - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string - // The task assessment report. + // The task assessment report. ReplicationTaskAssessmentResults []types.ReplicationTaskAssessmentResult // Metadata pertaining to the operation's result. @@ -158,10 +164,13 @@ var _ DescribeReplicationTaskAssessmentResultsAPIClient = (*Client)(nil) // DescribeReplicationTaskAssessmentResultsPaginatorOptions is the paginator // options for DescribeReplicationTaskAssessmentResults type DescribeReplicationTaskAssessmentResultsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go index 927d5b1b9fe..a9cf712a511 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTaskAssessmentRuns.go @@ -12,11 +12,14 @@ import ( ) // Returns a paginated list of premigration assessment runs based on filter -// settings. These filter settings can specify a combination of premigration -// assessment runs, migration tasks, replication instances, and assessment run -// status values. This operation doesn't return information about individual -// assessments. For this information, see the -// DescribeReplicationTaskIndividualAssessments operation. +// settings. +// +// These filter settings can specify a combination of premigration assessment +// runs, migration tasks, replication instances, and assessment run status values. +// +// This operation doesn't return information about individual assessments. For +// this information, see the DescribeReplicationTaskIndividualAssessments +// operation. func (c *Client) DescribeReplicationTaskAssessmentRuns(ctx context.Context, params *DescribeReplicationTaskAssessmentRunsInput, optFns ...func(*Options)) (*DescribeReplicationTaskAssessmentRunsOutput, error) { if params == nil { params = &DescribeReplicationTaskAssessmentRunsInput{} @@ -35,8 +38,10 @@ 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 diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go b/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go index 28faac60ab0..89a6b4c7d21 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTaskIndividualAssessments.go @@ -12,8 +12,9 @@ import ( ) // Returns a paginated list of individual assessments based on filter settings. -// These filter settings can specify a combination of premigration assessment runs, -// migration tasks, and assessment status values. +// +// These filter settings can specify a combination of premigration assessment +// runs, migration tasks, and assessment status values. func (c *Client) DescribeReplicationTaskIndividualAssessments(ctx context.Context, params *DescribeReplicationTaskIndividualAssessmentsInput, optFns ...func(*Options)) (*DescribeReplicationTaskIndividualAssessmentsOutput, error) { if params == nil { params = &DescribeReplicationTaskIndividualAssessmentsInput{} @@ -32,8 +33,10 @@ 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 + // 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 diff --git a/service/databasemigrationservice/api_op_DescribeReplicationTasks.go b/service/databasemigrationservice/api_op_DescribeReplicationTasks.go index e7310a08846..d9d8bee3ca8 100644 --- a/service/databasemigrationservice/api_op_DescribeReplicationTasks.go +++ b/service/databasemigrationservice/api_op_DescribeReplicationTasks.go @@ -35,19 +35,24 @@ 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 + // 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 . 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. + // 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. MaxRecords *int32 // An option to set to avoid returning information about settings. Use this to @@ -60,7 +65,7 @@ type DescribeReplicationTasksInput struct { type DescribeReplicationTasksOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -164,10 +169,13 @@ var _ DescribeReplicationTasksAPIClient = (*Client)(nil) // DescribeReplicationTasksPaginatorOptions is the paginator options for // DescribeReplicationTasks type DescribeReplicationTasksPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -282,12 +290,13 @@ type ReplicationTaskDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationTasksInput, *DescribeReplicationTasksOutput, error) (bool, error) } @@ -566,12 +575,13 @@ type ReplicationTaskReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationTasksInput, *DescribeReplicationTasksOutput, error) (bool, error) } @@ -947,12 +957,13 @@ type ReplicationTaskRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationTasksInput, *DescribeReplicationTasksOutput, error) (bool, error) } @@ -1328,12 +1339,13 @@ type ReplicationTaskStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationTasksInput, *DescribeReplicationTasksOutput, error) (bool, error) } diff --git a/service/databasemigrationservice/api_op_DescribeSchemas.go b/service/databasemigrationservice/api_op_DescribeSchemas.go index 0fa8f5f68ab..290061394c3 100644 --- a/service/databasemigrationservice/api_op_DescribeSchemas.go +++ b/service/databasemigrationservice/api_op_DescribeSchemas.go @@ -33,15 +33,18 @@ type DescribeSchemasInput struct { // This member is required. EndpointArn *string - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -49,7 +52,7 @@ type DescribeSchemasInput struct { type DescribeSchemasOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -152,10 +155,13 @@ var _ DescribeSchemasAPIClient = (*Client)(nil) // DescribeSchemasPaginatorOptions is the paginator options for DescribeSchemas type DescribeSchemasPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_DescribeTableStatistics.go b/service/databasemigrationservice/api_op_DescribeTableStatistics.go index 06dcb3c3260..5a228d7f4e0 100644 --- a/service/databasemigrationservice/api_op_DescribeTableStatistics.go +++ b/service/databasemigrationservice/api_op_DescribeTableStatistics.go @@ -12,10 +12,11 @@ import ( ) // Returns table statistics on the database migration task, including table name, -// rows inserted, rows updated, and rows deleted. Note that the "last updated" -// column the DMS console only indicates the time that DMS last updated the table -// statistics record for a table. It does not indicate the time of the last update -// to the table. +// rows inserted, rows updated, and rows deleted. +// +// Note that the "last updated" column the DMS console only indicates the time +// that DMS last updated the table statistics record for a table. It does not +// indicate the time of the last update to the table. func (c *Client) DescribeTableStatistics(ctx context.Context, params *DescribeTableStatisticsInput, optFns ...func(*Options)) (*DescribeTableStatisticsOutput, error) { if params == nil { params = &DescribeTableStatisticsInput{} @@ -38,20 +39,26 @@ type DescribeTableStatisticsInput struct { // This member is required. ReplicationTaskArn *string - // Filters applied to table statistics. Valid filter names: schema-name | - // table-name | table-state A combination of filters creates an AND condition where - // each record matches all specified filters. + // Filters applied to table statistics. + // + // Valid filter names: schema-name | table-name | table-state + // + // A combination of filters creates an AND condition where each record matches all + // specified filters. Filters []types.Filter - // An optional pagination token provided by a previous request. If this parameter + // 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 . 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 500. + // 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 500. MaxRecords *int32 noSmithyDocumentSerde @@ -59,7 +66,7 @@ type DescribeTableStatisticsInput struct { type DescribeTableStatisticsOutput struct { - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -166,10 +173,13 @@ var _ DescribeTableStatisticsAPIClient = (*Client)(nil) // DescribeTableStatisticsPaginatorOptions is the paginator options for // DescribeTableStatistics type DescribeTableStatisticsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 500. + // 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 500. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/databasemigrationservice/api_op_ImportCertificate.go b/service/databasemigrationservice/api_op_ImportCertificate.go index 518fcff0c62..3fdb7e49619 100644 --- a/service/databasemigrationservice/api_op_ImportCertificate.go +++ b/service/databasemigrationservice/api_op_ImportCertificate.go @@ -41,7 +41,9 @@ type ImportCertificateInput struct { // The location of an imported Oracle Wallet certificate for use with SSL. Provide // the name of a .sso file using the fileb:// prefix. You can't provide the - // certificate inline. Example: filebase64("${path.root}/rds-ca-2019-root.sso") + // certificate inline. + // + // Example: filebase64("${path.root}/rds-ca-2019-root.sso") CertificateWallet []byte // The tags associated with the certificate. diff --git a/service/databasemigrationservice/api_op_ListTagsForResource.go b/service/databasemigrationservice/api_op_ListTagsForResource.go index aae06eb36e4..732efedcc68 100644 --- a/service/databasemigrationservice/api_op_ListTagsForResource.go +++ b/service/databasemigrationservice/api_op_ListTagsForResource.go @@ -12,9 +12,10 @@ import ( ) // Lists all metadata tags attached to 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. +// instance, endpoint, subnet group, and migration task. For more information, see [Tag] +// Tag data type description. +// +// [Tag]: https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/databasemigrationservice/api_op_ModifyDataProvider.go b/service/databasemigrationservice/api_op_ModifyDataProvider.go index 9724dc03b26..0000cc8552d 100644 --- a/service/databasemigrationservice/api_op_ModifyDataProvider.go +++ b/service/databasemigrationservice/api_op_ModifyDataProvider.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified data provider using the provided settings. You must -// remove the data provider from all migration projects before you can modify it. +// Modifies the specified data provider using the provided settings. +// +// You must remove the data provider from all migration projects before you can +// modify it. func (c *Client) ModifyDataProvider(ctx context.Context, params *ModifyDataProviderInput, optFns ...func(*Options)) (*ModifyDataProviderOutput, error) { if params == nil { params = &ModifyDataProviderInput{} @@ -53,8 +55,10 @@ type ModifyDataProviderInput struct { // existing data provider settings with the exact settings that you specify in this // call. If this attribute is N, the current call to ModifyDataProvider does two // things: + // // - It replaces any data provider settings that already exist with new values, // for settings with the same names. + // // - It creates new data provider settings that you specify in the call, for // settings with different names. ExactSettings *bool diff --git a/service/databasemigrationservice/api_op_ModifyEndpoint.go b/service/databasemigrationservice/api_op_ModifyEndpoint.go index e0b96051bfb..6c1e1ee77a5 100644 --- a/service/databasemigrationservice/api_op_ModifyEndpoint.go +++ b/service/databasemigrationservice/api_op_ModifyEndpoint.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified endpoint. For a MySQL source or target endpoint, don't -// explicitly specify the database using the DatabaseName request parameter on the -// ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL -// endpoint replicates all the task tables to this single database. For MySQL -// endpoints, you specify the database only when you specify the schema in the -// table-mapping rules of the DMS task. +// Modifies the specified endpoint. +// +// For a MySQL source or target endpoint, don't explicitly specify the database +// using the DatabaseName request parameter on the ModifyEndpoint API call. +// Specifying DatabaseName when you modify a MySQL endpoint replicates all the +// task tables to this single database. For MySQL endpoints, you specify the +// database only when you specify the schema in the table-mapping rules of the DMS +// task. func (c *Client) ModifyEndpoint(ctx context.Context, params *ModifyEndpointInput, optFns ...func(*Options)) (*ModifyEndpointOutput, error) { if params == nil { params = &ModifyEndpointInput{} @@ -47,31 +49,40 @@ type ModifyEndpointInput struct { 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"} + // ,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) - // in the Database Migration Service User Guide. + // section in [Using DocumentDB as a Target for Database Migration Service]in the Database Migration Service User Guide. + // + // [Using DocumentDB as a Target for Database Migration Service]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB]in the Database Migration + // Service User Guide. + // + // [Using Object Mapping to Migrate Data to DynamoDB]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping 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) - // in the Database Migration Service User Guide. + // information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for DMS]in the Database Migration Service + // User Guide. + // + // [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 ElasticsearchSettings *types.ElasticsearchSettings // The database endpoint identifier. Identifiers must begin with a letter and must @@ -93,18 +104,22 @@ type ModifyEndpointInput struct { // 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. + // 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. @@ -118,56 +133,62 @@ type ModifyEndpointInput struct { GcpMySQLSettings *types.GcpMySQLSettings // 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) - // in the Database Migration Service User Guide. + // about other available settings, see [Extra connection attributes when using Db2 LUW as a source for DMS]in the Database Migration Service User + // Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // information about the available settings, see [Using object mapping to migrate data to a Kafka topic]in the Database Migration Service + // User Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // Streams. For more information about the available settings, see [Using object mapping to migrate data to a Kinesis data stream]in the Database + // Migration Service User Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // endpoint. For information about other available settings, see [Extra connection attributes when using SQL Server as a source for DMS]and [Extra connection attributes when using SQL Server as a target for DMS] in the + // Database Migration Service User Guide. + // + // [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 + // [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 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) - // in the Database Migration Service User Guide. + // about the available settings, see the configuration properties section in [Endpoint configuration settings when using MongoDB as a source for Database Migration Service]in + // the Database Migration Service User Guide. + // + // [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 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) - // 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using MySQL as a source for DMS]and [Extra connection attributes when using a MySQL-compatible database as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 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) - // in the Database Migration Service User Guide. + // information about the available settings, see [Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target]in the Database Migration Service + // User Guide. + // + // [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 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using Oracle as a source for DMS]and [Extra connection attributes when using Oracle as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 OracleSettings *types.OracleSettings // The password to be used to login to the endpoint database. @@ -177,10 +198,11 @@ 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using PostgreSQL as a source for DMS]and [Extra connection attributes when using PostgreSQL as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 PostgreSQLSettings *types.PostgreSQLSettings // Settings in JSON format for the Redis target endpoint. @@ -190,15 +212,15 @@ type ModifyEndpointInput struct { RedshiftSettings *types.RedshiftSettings // 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) - // in the Database Migration Service User Guide. + // about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for DMS]in the Database Migration Service User Guide. + // + // [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 S3Settings *types.S3Settings // The name of the server where the endpoint database resides. ServerName *string - // The Amazon Resource Name (ARN) for the IAM role you want to use to modify the + // The Amazon Resource Name (ARN) for the IAM role you want to use to modify the // endpoint. The role must allow the iam:PassRole action. ServiceAccessRoleArn *string @@ -206,10 +228,11 @@ type ModifyEndpointInput 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) - // in the Database Migration Service User Guide. + // information about other available settings, see [Extra connection attributes when using SAP ASE as a source for DMS]and [Extra connection attributes when using SAP ASE as a target for DMS] in the Database Migration + // Service User Guide. + // + // [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 + // [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 SybaseSettings *types.SybaseSettings // Settings in JSON format for the target Amazon Timestream endpoint. diff --git a/service/databasemigrationservice/api_op_ModifyEventSubscription.go b/service/databasemigrationservice/api_op_ModifyEventSubscription.go index be0239133f2..5896a79afe1 100644 --- a/service/databasemigrationservice/api_op_ModifyEventSubscription.go +++ b/service/databasemigrationservice/api_op_ModifyEventSubscription.go @@ -34,19 +34,20 @@ type ModifyEventSubscriptionInput struct { // This member is required. SubscriptionName *string - // A Boolean value; set to true to activate the subscription. + // A Boolean value; set to true to activate the subscription. Enabled *bool - // A list of event categories for a source type that you want to subscribe to. Use - // the DescribeEventCategories action to see a list of event categories. + // A list of event categories for a source type that you want to subscribe to. + // Use the DescribeEventCategories action to see a list of event categories. EventCategories []string - // The Amazon Resource Name (ARN) of the Amazon SNS topic created for event + // The Amazon Resource Name (ARN) of the Amazon SNS topic created for event // notification. The ARN is created by Amazon SNS when you create a topic and // subscribe to it. SnsTopicArn *string - // The type of DMS resource that generates the events you want to subscribe to. + // The type of DMS resource that generates the events you want to subscribe to. + // // Valid values: replication-instance | replication-task SourceType *string diff --git a/service/databasemigrationservice/api_op_ModifyInstanceProfile.go b/service/databasemigrationservice/api_op_ModifyInstanceProfile.go index d3e9975b87d..a150281bb4e 100644 --- a/service/databasemigrationservice/api_op_ModifyInstanceProfile.go +++ b/service/databasemigrationservice/api_op_ModifyInstanceProfile.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified instance profile using the provided parameters. All -// migration projects associated with the instance profile must be deleted or +// Modifies the specified instance profile using the provided parameters. +// +// All migration projects associated with the instance profile must be deleted or // modified before you can modify the instance profile. func (c *Client) ModifyInstanceProfile(ctx context.Context, params *ModifyInstanceProfileInput, optFns ...func(*Options)) (*ModifyInstanceProfileOutput, error) { if params == nil { @@ -48,11 +49,14 @@ type ModifyInstanceProfileInput struct { InstanceProfileName *string // The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the - // connection parameters for the instance profile. If you don't specify a value for - // the KmsKeyArn 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. + // connection parameters for the instance profile. + // + // If you don't specify a value for the KmsKeyArn 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. KmsKeyArn *string // Specifies the network type for the instance profile. A value of IPV4 represents diff --git a/service/databasemigrationservice/api_op_ModifyMigrationProject.go b/service/databasemigrationservice/api_op_ModifyMigrationProject.go index 92210504048..3389c94cb35 100644 --- a/service/databasemigrationservice/api_op_ModifyMigrationProject.go +++ b/service/databasemigrationservice/api_op_ModifyMigrationProject.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified migration project using the provided parameters. The -// migration project must be closed before you can modify it. +// Modifies the specified migration project using the provided parameters. +// +// The migration project must be closed before you can modify it. func (c *Client) ModifyMigrationProject(ctx context.Context, params *ModifyMigrationProjectInput, optFns ...func(*Options)) (*ModifyMigrationProjectOutput, error) { if params == nil { params = &ModifyMigrationProjectInput{} diff --git a/service/databasemigrationservice/api_op_ModifyReplicationConfig.go b/service/databasemigrationservice/api_op_ModifyReplicationConfig.go index 1857dad1f29..364b52ab4b3 100644 --- a/service/databasemigrationservice/api_op_ModifyReplicationConfig.go +++ b/service/databasemigrationservice/api_op_ModifyReplicationConfig.go @@ -16,9 +16,11 @@ import ( // check the state of any replication that uses this configuration. You can only // modify a replication configuration before any replication that uses it has // started. As soon as you have initially started a replication with a given -// configuiration, you can't modify that configuration, even if you stop it. Other -// run statuses that allow you to run this command include FAILED and CREATED. A -// provisioning state that allows you to run this command is FAILED_PROVISION. +// configuiration, you can't modify that configuration, even if you stop it. +// +// Other run statuses that allow you to run this command include FAILED and +// CREATED. A provisioning state that allows you to run this command is +// FAILED_PROVISION. func (c *Client) ModifyReplicationConfig(ctx context.Context, params *ModifyReplicationConfigInput, optFns ...func(*Options)) (*ModifyReplicationConfigOutput, error) { if params == nil { params = &ModifyReplicationConfigInput{} diff --git a/service/databasemigrationservice/api_op_ModifyReplicationInstance.go b/service/databasemigrationservice/api_op_ModifyReplicationInstance.go index 7f1e05cbfca..ecb8c3c0094 100644 --- a/service/databasemigrationservice/api_op_ModifyReplicationInstance.go +++ b/service/databasemigrationservice/api_op_ModifyReplicationInstance.go @@ -13,7 +13,9 @@ import ( // Modifies the replication instance to apply new settings. You can change one or // more parameters by specifying these parameters and the new values in the -// request. Some settings are applied during the maintenance window. +// request. +// +// Some settings are applied during the maintenance window. func (c *Client) ModifyReplicationInstance(ctx context.Context, params *ModifyReplicationInstanceInput, optFns ...func(*Options)) (*ModifyReplicationInstanceOutput, error) { if params == nil { params = &ModifyReplicationInstanceInput{} @@ -42,9 +44,11 @@ type ModifyReplicationInstanceInput struct { // Indicates that major version upgrades are allowed. Changing this parameter does // not result in an outage, and the change is asynchronously applied as soon as - // possible. This parameter must be set to true when specifying a value for the - // EngineVersion parameter that is a different major version than the replication - // instance's current version. + // possible. + // + // This parameter must be set to true when specifying a value for the EngineVersion + // parameter that is a different major version than the replication instance's + // current version. AllowMajorVersionUpgrade bool // Indicates whether the changes should be applied immediately or during the next @@ -54,18 +58,24 @@ type ModifyReplicationInstanceInput struct { // A value that indicates that minor version upgrades are applied automatically to // the replication instance during the maintenance window. Changing this parameter // 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: + // 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. AutoMinorVersionUpgrade *bool - // The engine version number of the replication instance. When modifying a major - // engine version of an instance, also set AllowMajorVersionUpgrade to true . + // The engine version number of the replication instance. + // + // When modifying a major 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 + // 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 . MultiAZ *bool @@ -79,24 +89,32 @@ type ModifyReplicationInstanceInput struct { // except in the following situation, and the change is asynchronously applied as // soon as possible. 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. Default: Uses existing setting Format: - // ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun + // pending changes are applied. + // + // 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 PreferredMaintenanceWindow *string // 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 - // 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) - // . + // 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]. + // + // [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 // string. ReplicationInstanceIdentifier *string - // Specifies the VPC security group to be used with the replication instance. The + // Specifies the VPC security group to be used with the replication instance. The // VPC security group must work with the VPC containing the replication instance. VpcSecurityGroupIds []string diff --git a/service/databasemigrationservice/api_op_ModifyReplicationTask.go b/service/databasemigrationservice/api_op_ModifyReplicationTask.go index 899f770adee..631aaccbe16 100644 --- a/service/databasemigrationservice/api_op_ModifyReplicationTask.go +++ b/service/databasemigrationservice/api_op_ModifyReplicationTask.go @@ -12,10 +12,15 @@ import ( "time" ) -// 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. +// 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] in the Database Migration Service +// User Guide. +// +// [Working with Migration Tasks]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html func (c *Client) ModifyReplicationTask(ctx context.Context, params *ModifyReplicationTaskInput, optFns ...func(*Options)) (*ModifyReplicationTaskOutput, error) { if params == nil { params = &ModifyReplicationTaskInput{} @@ -40,37 +45,52 @@ type ModifyReplicationTaskInput struct { // Indicates when you want a change data capture (CDC) operation to start. Use // either CdcStartPosition or CdcStartTime to specify when you want a CDC operation - // to start. Specifying both values results in an error. The value can be in date, - // checkpoint, or LSN/SCN format. Date Example: --cdc-start-position - // “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position + // to start. Specifying both values results in an error. + // + // The value can be in date, checkpoint, or LSN/SCN format. + // + // Date Example: --cdc-start-position “2018-03-08T12:12:12” + // + // Checkpoint Example: --cdc-start-position // "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" - // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” When you use - // this task setting with a source PostgreSQL database, a logical replication slot - // 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) - // . + // + // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + // + // When you use this task setting with a source PostgreSQL database, a logical + // replication slot 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]. + // + // [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 CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either // CdcStartTime or CdcStartPosition to specify when you want a CDC operation to - // start. Specifying both values results in an error. Timestamp Example: - // --cdc-start-time “2018-03-08T12:12:12” + // start. Specifying both values results in an error. + // + // Timestamp Example: --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: - // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: - // --cdc-stop-position “commit_time:2018-02-09T12:12:12“ + // 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 // The migration type. Valid values: full-load | cdc | full-load-and-cdc MigrationType types.MigrationTypeValue - // The replication task identifier. Constraints: + // 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. ReplicationTaskIdentifier *string @@ -84,9 +104,10 @@ type ModifyReplicationTaskInput struct { 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. + // source and target endpoints. For more information, see [Specifying Supplemental Data for Task Settings]in the Database + // Migration Service User Guide. + // + // [Specifying Supplemental Data for Task Settings]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html TaskData *string noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_ReloadReplicationTables.go b/service/databasemigrationservice/api_op_ReloadReplicationTables.go index e4c557e8ab8..75abbf133ab 100644 --- a/service/databasemigrationservice/api_op_ReloadReplicationTables.go +++ b/service/databasemigrationservice/api_op_ReloadReplicationTables.go @@ -12,9 +12,10 @@ import ( ) // Reloads the target database table with the source data for a given DMS -// Serverless replication configuration. You can only use this operation with a -// task in the RUNNING state, otherwise the service will throw an -// InvalidResourceStateFault exception. +// Serverless replication configuration. +// +// You can only use this operation with a task in the RUNNING state, otherwise the +// service will throw an InvalidResourceStateFault exception. func (c *Client) ReloadReplicationTables(ctx context.Context, params *ReloadReplicationTablesInput, optFns ...func(*Options)) (*ReloadReplicationTablesOutput, error) { if params == nil { params = &ReloadReplicationTablesInput{} diff --git a/service/databasemigrationservice/api_op_ReloadTables.go b/service/databasemigrationservice/api_op_ReloadTables.go index 9f8518108db..c11717af073 100644 --- a/service/databasemigrationservice/api_op_ReloadTables.go +++ b/service/databasemigrationservice/api_op_ReloadTables.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Reloads the target database table with the source data. You can only use this -// operation with a task in the RUNNING state, otherwise the service will throw an -// InvalidResourceStateFault exception. +// Reloads the target database table with the source data. +// +// You can only use this operation with a task in the RUNNING state, otherwise the +// service will throw an InvalidResourceStateFault exception. func (c *Client) ReloadTables(ctx context.Context, params *ReloadTablesInput, optFns ...func(*Options)) (*ReloadTablesOutput, error) { if params == nil { params = &ReloadTablesInput{} @@ -43,8 +44,11 @@ type ReloadTablesInput struct { // 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. + // option applies only when validation is enabled for the task. + // + // Valid values: data-reload, validate-only + // + // Default value is data-reload. ReloadOption types.ReloadOptionValue noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_RemoveTagsFromResource.go b/service/databasemigrationservice/api_op_RemoveTagsFromResource.go index 41f635b1c39..6d4624ef52a 100644 --- a/service/databasemigrationservice/api_op_RemoveTagsFromResource.go +++ b/service/databasemigrationservice/api_op_RemoveTagsFromResource.go @@ -11,8 +11,10 @@ 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]Tag data +// type description. +// +// [Tag]: https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html 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_StartMetadataModelImport.go b/service/databasemigrationservice/api_op_StartMetadataModelImport.go index 6ae1e5ae02a..3b72bf00926 100644 --- a/service/databasemigrationservice/api_op_StartMetadataModelImport.go +++ b/service/databasemigrationservice/api_op_StartMetadataModelImport.go @@ -12,6 +12,7 @@ import ( ) // Loads the metadata for all the dependent database objects of the parent object. +// // This operation uses your project's Amazon S3 bucket as a metadata cache to // improve performance. func (c *Client) StartMetadataModelImport(ctx context.Context, params *StartMetadataModelImportInput, optFns ...func(*Options)) (*StartMetadataModelImportOutput, error) { diff --git a/service/databasemigrationservice/api_op_StartRecommendations.go b/service/databasemigrationservice/api_op_StartRecommendations.go index 86fc17d737b..37b9c4fe2f1 100644 --- a/service/databasemigrationservice/api_op_StartRecommendations.go +++ b/service/databasemigrationservice/api_op_StartRecommendations.go @@ -12,9 +12,11 @@ import ( ) // 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) -// . +// target engines. +// +// You can create recommendations for multiple source databases using [BatchStartRecommendations]. +// +// [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_StartReplication.go b/service/databasemigrationservice/api_op_StartReplication.go index 0c2bf01dd2a..fe103ce7710 100644 --- a/service/databasemigrationservice/api_op_StartReplication.go +++ b/service/databasemigrationservice/api_op_StartReplication.go @@ -46,8 +46,9 @@ type StartReplicationInput struct { // Indicates when you want a change data capture (CDC) operation to start. Use // either CdcStartPosition or CdcStartTime to specify when you want a CDC - // operation to start. Specifying both values results in an error. The value can be - // in date, checkpoint, or LSN/SCN format. + // operation to start. Specifying both values results in an error. + // + // The value can be in date, checkpoint, or LSN/SCN format. CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either diff --git a/service/databasemigrationservice/api_op_StartReplicationTask.go b/service/databasemigrationservice/api_op_StartReplicationTask.go index 410df744d2c..de583135e15 100644 --- a/service/databasemigrationservice/api_op_StartReplicationTask.go +++ b/service/databasemigrationservice/api_op_StartReplicationTask.go @@ -12,9 +12,12 @@ import ( "time" ) -// 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. +// Starts the replication task. +// +// For more information about DMS tasks, see [Working with Migration Tasks] in the Database Migration Service +// User Guide. +// +// [Working with Migration Tasks]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html func (c *Client) StartReplicationTask(ctx context.Context, params *StartReplicationTaskInput, optFns ...func(*Options)) (*StartReplicationTaskOutput, error) { if params == nil { params = &StartReplicationTaskInput{} @@ -37,45 +40,61 @@ type StartReplicationTaskInput struct { // This member is required. 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 - // 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. + // 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 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. // // This member is required. StartReplicationTaskType types.StartReplicationTaskTypeValue // Indicates when you want a change data capture (CDC) operation to start. Use // either CdcStartPosition or CdcStartTime to specify when you want a CDC operation - // to start. Specifying both values results in an error. The value can be in date, - // checkpoint, or LSN/SCN format. Date Example: --cdc-start-position - // “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position + // to start. Specifying both values results in an error. + // + // The value can be in date, checkpoint, or LSN/SCN format. + // + // Date Example: --cdc-start-position “2018-03-08T12:12:12” + // + // Checkpoint Example: --cdc-start-position // "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" - // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” When you use - // this task setting with a source PostgreSQL database, a logical replication slot - // 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) - // . + // + // LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373” + // + // When you use this task setting with a source PostgreSQL database, a logical + // replication slot 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]. + // + // [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 CdcStartPosition *string // Indicates the start time for a change data capture (CDC) operation. Use either // CdcStartTime or CdcStartPosition to specify when you want a CDC operation to - // start. Specifying both values results in an error. Timestamp Example: - // --cdc-start-time “2018-03-08T12:12:12” + // start. Specifying both values results in an error. + // + // Timestamp Example: --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: - // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: - // --cdc-stop-position “commit_time:2018-02-09T12:12:12“ + // 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 noSmithyDocumentSerde diff --git a/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go b/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go index da2c9893af5..1921fbbeb6b 100644 --- a/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go +++ b/service/databasemigrationservice/api_op_StartReplicationTaskAssessment.go @@ -11,16 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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. // // 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. +// will result. +// +// For information about DMS task assessments, see [Creating a task assessment report] in the Database Migration +// Service User Guide. +// +// [Creating a task assessment report]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html func (c *Client) StartReplicationTaskAssessment(ctx context.Context, params *StartReplicationTaskAssessmentInput, optFns ...func(*Options)) (*StartReplicationTaskAssessmentOutput, error) { if params == nil { params = &StartReplicationTaskAssessmentInput{} @@ -38,7 +45,7 @@ func (c *Client) StartReplicationTaskAssessment(ctx context.Context, params *Sta type StartReplicationTaskAssessmentInput struct { - // The Amazon Resource Name (ARN) of the replication task. + // The Amazon Resource Name (ARN) of the replication task. // // This member is required. ReplicationTaskArn *string @@ -48,7 +55,7 @@ type StartReplicationTaskAssessmentInput struct { type StartReplicationTaskAssessmentOutput struct { - // The assessed replication task. + // The assessed replication task. ReplicationTask *types.ReplicationTask // Metadata pertaining to the operation's result. diff --git a/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go b/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go index 1e56fcc93e6..a020e644888 100644 --- a/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go +++ b/service/databasemigrationservice/api_op_StartReplicationTaskAssessmentRun.go @@ -12,12 +12,14 @@ import ( ) // Starts a new premigration assessment run for one or more individual assessments -// of a migration task. The assessments that you can specify depend on the source -// and target database engine and the migration type defined for the given task. To -// run this operation, your migration task must already be created. After you run -// this operation, you can review the status of each individual assessment. You can -// also run the migration task manually after the assessment run and its individual -// assessments complete. +// of a migration task. +// +// The assessments that you can specify depend on the source and target database +// engine and the migration type defined for the given task. To run this operation, +// your migration task must already be created. After you run this operation, you +// can review the status of each individual assessment. You can also run the +// migration task manually after the assessment run and its individual assessments +// complete. func (c *Client) StartReplicationTaskAssessmentRun(ctx context.Context, params *StartReplicationTaskAssessmentRunInput, optFns ...func(*Options)) (*StartReplicationTaskAssessmentRunOutput, error) { if params == nil { params = &StartReplicationTaskAssessmentRunInput{} @@ -60,27 +62,37 @@ 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 - // 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 + // 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 // ReplicationTaskArn request parameter. Exclude []string // 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 - // 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 + // 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 // ReplicationTaskArn request parameter. IncludeOnly []string // 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. diff --git a/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go b/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go index 94843a16bd8..994a9bf88dc 100644 --- a/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go +++ b/service/databasemigrationservice/api_op_UpdateSubscriptionsToEventBridge.go @@ -18,10 +18,13 @@ import ( // version 3.4.5 or higher. To enable migration regardless of version, set the // Force option to true. However, if you don't upgrade instances earlier than // version 3.4.5, 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) -// in the Amazon Web Services Database Migration Service User Guide. +// 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]in the Amazon Web Services +// Database Migration Service User Guide. +// +// [Migrating event subscriptions to Amazon EventBridge]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html#CHAP_Events-migrate-to-eventbridge func (c *Client) UpdateSubscriptionsToEventBridge(ctx context.Context, params *UpdateSubscriptionsToEventBridgeInput, optFns ...func(*Options)) (*UpdateSubscriptionsToEventBridgeOutput, error) { if params == nil { params = &UpdateSubscriptionsToEventBridgeInput{} diff --git a/service/databasemigrationservice/doc.go b/service/databasemigrationservice/doc.go index c09e1a8a705..7e54818e60f 100644 --- a/service/databasemigrationservice/doc.go +++ b/service/databasemigrationservice/doc.go @@ -3,13 +3,17 @@ // Package databasemigrationservice provides the API client, operations, and // parameter types for AWS Database Migration Service. // -// Database Migration Service Database Migration Service (DMS) can migrate your -// data to and from the most widely used commercial and open-source databases such -// as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon -// Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports -// 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. +// # Database Migration Service +// +// Database Migration Service (DMS) can migrate your data to and from the most +// widely used commercial and open-source databases such as Oracle, PostgreSQL, +// Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP +// Adaptive Server Enterprise (ASE). The service supports 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?] in the Database Migration Service User +// Guide. +// +// [What Is Database Migration Service?]: https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html package databasemigrationservice diff --git a/service/databasemigrationservice/options.go b/service/databasemigrationservice/options.go index 58bf0bb961d..3785b077f72 100644 --- a/service/databasemigrationservice/options.go +++ b/service/databasemigrationservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/databasemigrationservice/types/enums.go b/service/databasemigrationservice/types/enums.go index beeabad462c..77ba613f13b 100644 --- a/service/databasemigrationservice/types/enums.go +++ b/service/databasemigrationservice/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AssessmentReportType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentReportType) Values() []AssessmentReportType { return []AssessmentReportType{ "pdf", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AuthMechanismValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthMechanismValue) Values() []AuthMechanismValue { return []AuthMechanismValue{ "default", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for AuthTypeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthTypeValue) Values() []AuthTypeValue { return []AuthTypeValue{ "no", @@ -74,6 +77,7 @@ const ( // 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{ @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for CharLengthSemantics. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CharLengthSemantics) Values() []CharLengthSemantics { return []CharLengthSemantics{ "default", @@ -117,8 +122,9 @@ const ( ) // Values returns all known values for CollectorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CollectorStatus) Values() []CollectorStatus { return []CollectorStatus{ "UNREGISTERED", @@ -135,8 +141,9 @@ const ( ) // Values returns all known values for CompressionTypeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionTypeValue) Values() []CompressionTypeValue { return []CompressionTypeValue{ "none", @@ -153,8 +160,9 @@ const ( ) // Values returns all known values for DatabaseMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseMode) Values() []DatabaseMode { return []DatabaseMode{ "default", @@ -171,8 +179,9 @@ const ( ) // Values returns all known values for DataFormatValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataFormatValue) Values() []DataFormatValue { return []DataFormatValue{ "csv", @@ -192,6 +201,7 @@ const ( // Values returns all known values for DatePartitionDelimiterValue. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DatePartitionDelimiterValue) Values() []DatePartitionDelimiterValue { return []DatePartitionDelimiterValue{ @@ -215,6 +225,7 @@ const ( // Values returns all known values for DatePartitionSequenceValue. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DatePartitionSequenceValue) Values() []DatePartitionSequenceValue { return []DatePartitionSequenceValue{ @@ -237,8 +248,9 @@ const ( ) // Values returns all known values for DmsSslModeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DmsSslModeValue) Values() []DmsSslModeValue { return []DmsSslModeValue{ "none", @@ -258,8 +270,9 @@ const ( ) // Values returns all known values for EncodingTypeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncodingTypeValue) Values() []EncodingTypeValue { return []EncodingTypeValue{ "plain", @@ -277,8 +290,9 @@ const ( ) // Values returns all known values for EncryptionModeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionModeValue) Values() []EncryptionModeValue { return []EncryptionModeValue{ "sse-s3", @@ -298,6 +312,7 @@ const ( // 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{ @@ -317,8 +332,9 @@ const ( ) // Values returns all known values for KafkaSaslMechanism. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KafkaSaslMechanism) Values() []KafkaSaslMechanism { return []KafkaSaslMechanism{ "scram-sha-512", @@ -337,8 +353,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "plaintext", @@ -358,8 +375,9 @@ const ( // Values returns all known values for KafkaSslEndpointIdentificationAlgorithm. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KafkaSslEndpointIdentificationAlgorithm) Values() []KafkaSslEndpointIdentificationAlgorithm { return []KafkaSslEndpointIdentificationAlgorithm{ "none", @@ -377,8 +395,9 @@ const ( ) // Values returns all known values for LongVarcharMappingType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LongVarcharMappingType) Values() []LongVarcharMappingType { return []LongVarcharMappingType{ "wstring", @@ -396,8 +415,9 @@ const ( ) // Values returns all known values for MessageFormatValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageFormatValue) Values() []MessageFormatValue { return []MessageFormatValue{ "json", @@ -415,8 +435,9 @@ const ( ) // Values returns all known values for MigrationTypeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationTypeValue) Values() []MigrationTypeValue { return []MigrationTypeValue{ "full-load", @@ -434,8 +455,9 @@ const ( ) // Values returns all known values for NestingLevelValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NestingLevelValue) Values() []NestingLevelValue { return []NestingLevelValue{ "none", @@ -452,8 +474,9 @@ const ( ) // Values returns all known values for OriginTypeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginTypeValue) Values() []OriginTypeValue { return []OriginTypeValue{ "SOURCE", @@ -470,8 +493,9 @@ const ( ) // Values returns all known values for ParquetVersionValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParquetVersionValue) Values() []ParquetVersionValue { return []ParquetVersionValue{ "parquet-1-0", @@ -489,8 +513,9 @@ const ( ) // Values returns all known values for PluginNameValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PluginNameValue) Values() []PluginNameValue { return []PluginNameValue{ "no-preference", @@ -509,8 +534,9 @@ const ( ) // Values returns all known values for RedisAuthTypeValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedisAuthTypeValue) Values() []RedisAuthTypeValue { return []RedisAuthTypeValue{ "none", @@ -530,8 +556,9 @@ const ( // Values returns all known values for RefreshSchemasStatusTypeValue. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RefreshSchemasStatusTypeValue) Values() []RefreshSchemasStatusTypeValue { return []RefreshSchemasStatusTypeValue{ "successful", @@ -549,8 +576,9 @@ const ( ) // Values returns all known values for ReleaseStatusValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReleaseStatusValues) Values() []ReleaseStatusValues { return []ReleaseStatusValues{ "beta", @@ -567,8 +595,9 @@ const ( ) // Values returns all known values for ReloadOptionValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReloadOptionValue) Values() []ReloadOptionValue { return []ReloadOptionValue{ "data-reload", @@ -586,8 +615,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationEndpointTypeValue) Values() []ReplicationEndpointTypeValue { return []ReplicationEndpointTypeValue{ "source", @@ -605,8 +635,9 @@ const ( ) // Values returns all known values for SafeguardPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SafeguardPolicy) Values() []SafeguardPolicy { return []SafeguardPolicy{ "rely-on-sql-server-replication-agent", @@ -623,8 +654,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "replication-instance", @@ -641,6 +673,7 @@ const ( // 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{ @@ -660,8 +693,9 @@ const ( // Values returns all known values for StartReplicationTaskTypeValue. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StartReplicationTaskTypeValue) Values() []StartReplicationTaskTypeValue { return []StartReplicationTaskTypeValue{ "start-replication", @@ -679,8 +713,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -699,8 +734,9 @@ const ( ) // Values returns all known values for TlogAccessMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TlogAccessMode) Values() []TlogAccessMode { return []TlogAccessMode{ "BackupOnly", @@ -720,8 +756,9 @@ const ( ) // Values returns all known values for VersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VersionStatus) Values() []VersionStatus { return []VersionStatus{ "UP_TO_DATE", diff --git a/service/databasemigrationservice/types/types.go b/service/databasemigrationservice/types/types.go index 7ef29b5764a..37ca6e200b5 100644 --- a/service/databasemigrationservice/types/types.go +++ b/service/databasemigrationservice/types/types.go @@ -24,10 +24,12 @@ 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]CreateReplicationInstance // 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. +// +// [CreateReplicationInstance]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationInstance.html type AvailabilityZone struct { // The name of the Availability Zone. @@ -192,11 +194,14 @@ type ComputeConfig struct { DnsNameServers *string // An Key Management Service (KMS) key Amazon Resource Name (ARN) that is used to - // encrypt the data during DMS Serverless replication. If you don't specify a value - // for the KmsKeyId parameter, 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. + // encrypt the data during DMS Serverless replication. + // + // If you don't specify a value for the KmsKeyId parameter, 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 the maximum value of the DMS capacity units (DCUs) for which a given @@ -226,11 +231,14 @@ type ComputeConfig struct { // The weekly time range during which system maintenance can occur for the DMS // Serverless replication, in Universal Coordinated Time (UTC). The format is - // ddd:hh24:mi-ddd:hh24:mi . The default is a 30-minute window selected at random - // from an 8-hour block of time per Amazon Web Services Region. This maintenance - // occurs on a random day of the week. Valid values for days of the week include - // Mon , Tue , Wed , Thu , Fri , Sat , and Sun . Constraints include a minimum - // 30-minute window. + // ddd:hh24:mi-ddd:hh24:mi . + // + // The default is a 30-minute window selected at random from an 8-hour block of + // time per Amazon Web Services Region. This maintenance occurs on a random day of + // the week. Valid values for days of the week include Mon , Tue , Wed , Thu , Fri + // , Sat , and Sun . + // + // Constraints include a minimum 30-minute window. PreferredMaintenanceWindow *string // Specifies a subnet group identifier to associate with the DMS Serverless @@ -268,9 +276,13 @@ type Connection struct { ReplicationInstanceIdentifier *string // The connection status. This parameter can return one of the following values: + // // - "successful" + // // - "testing" + // // - "failed" + // // - "deleting" Status *string @@ -523,7 +535,7 @@ type DefaultErrorDetails struct { // The settings in JSON format for the DMS Transfer type source endpoint. type DmsTransferSettings struct { - // The name of the S3 bucket to use. + // The name of the S3 bucket to use. BucketName *string // The Amazon Resource Name (ARN) used by the service access IAM role. The role @@ -558,15 +570,18 @@ type DocDbDataProviderSettings struct { // Provides information that defines a DocumentDB endpoint. type DocDbSettings struct { - // The database name on the DocumentDB source endpoint. + // The database name on the DocumentDB 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 . + // 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 . DocsToInvestigate *int32 - // Specifies the document ID. Use this setting when NestingLevel is set to "none" . + // Specifies the document ID. Use this setting when NestingLevel is set to "none" + // . + // // Default value is "false" . ExtractDocId *bool @@ -577,21 +592,26 @@ type DocDbSettings struct { // 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 + // The password for the user account you use to access the DocumentDB source // endpoint. Password *string - // The port value for the DocumentDB source endpoint. + // The port value for the DocumentDB source endpoint. Port *int32 // If true , DMS replicates data to shard collections. DMS only uses this setting - // if the target endpoint is a DocumentDB elastic cluster. When this setting is - // true , note the following: + // if the target endpoint is a DocumentDB elastic cluster. + // + // When this setting is true , note the following: + // // - You must set TargetTablePrepMode to nothing . + // // - DMS automatically sets useUpdateLookup to false . ReplicateShardCollections *bool @@ -599,21 +619,23 @@ type DocDbSettings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that // contains the DocumentDB endpoint connection details. SecretsManagerSecretId *string - // The name of the server on the DocumentDB source endpoint. + // The name of the server on the DocumentDB source endpoint. ServerName *string // If true , DMS retrieves the entire document from the DocumentDB source during @@ -632,7 +654,7 @@ type DocDbSettings struct { // (IAM) role used to define an Amazon DynamoDB target endpoint. type DynamoDbSettings struct { - // The Amazon Resource Name (ARN) used by the service to access the IAM role. The + // The Amazon Resource Name (ARN) used by the service to access the IAM role. The // role must allow the iam:PassRole action. // // This member is required. @@ -661,10 +683,12 @@ type ElasticsearchSettings struct { 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 - // 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. + // 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 @@ -678,8 +702,11 @@ type ElasticsearchSettings struct { // Describes an endpoint of a database instance in response to operations such as // the following: +// // - CreateEndpoint +// // - DescribeEndpoint +// // - ModifyEndpoint type Endpoint struct { @@ -726,7 +753,7 @@ type Endpoint struct { // "documentdb" , "sqlserver" , "neptune" , and "babelfish" . EngineName *string - // Value returned by a call to CreateEndpoint that can be used for cross-account + // Value returned by a call to CreateEndpoint that can be used for cross-account // validation. Use it on a subsequent call to CreateEndpoint to create the endpoint // with a cross-account. ExternalId *string @@ -753,10 +780,14 @@ 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 @@ -924,26 +955,31 @@ type Event struct { // The event message. Message *string - // The identifier of an event source. + // The identifier of an event source. SourceIdentifier *string - // The type of DMS resource that generates events. Valid values: - // replication-instance | endpoint | replication-task + // The type of DMS resource that generates events. + // + // Valid values: replication-instance | endpoint | replication-task SourceType SourceType noSmithyDocumentSerde } // 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]DescribeEventCategories // action. +// +// [DescribeEventCategories]: https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html type EventCategoryGroup struct { - // A list of event categories from a source type that you've chosen. + // A list of event categories from a source type that you've chosen. EventCategories []string - // The type of DMS resource that generates events. Valid values: - // replication-instance | replication-server | security-group | replication-task + // The type of DMS resource that generates events. + // + // Valid values: replication-instance | replication-server | security-group | + // replication-task SourceType *string noSmithyDocumentSerde @@ -972,15 +1008,22 @@ type EventSubscription struct { // A list of source Ids for the event subscription. SourceIdsList []string - // The type of DMS resource that generates events. Valid values: - // replication-instance | replication-server | security-group | replication-task + // The type of DMS resource that generates events. + // + // Valid values: replication-instance | replication-server | security-group | + // replication-task SourceType *string - // The status of the DMS event notification subscription. Constraints: Can be one - // of the following: creating | modifying | deleting | active | no-permission | - // topic-not-exist The status "no-permission" indicates that DMS no longer has - // permission to post to the SNS topic. The status "topic-not-exist" indicates that - // the topic was deleted after the subscription was created. + // The status of the DMS event notification subscription. + // + // Constraints: + // + // Can be one of the following: creating | modifying | deleting | active | + // no-permission | topic-not-exist + // + // The status "no-permission" indicates that DMS no longer has permission to post + // to the SNS topic. The status "topic-not-exist" indicates that the topic was + // deleted after the subscription was created. Status *string // The time the DMS event notification subscription was created. @@ -1063,9 +1106,13 @@ type FleetAdvisorSchemaObjectResponse struct { // The type of the schema object, as reported by the database engine. Examples // include the following: + // // - function + // // - trigger + // // - SYSTEM_TABLE + // // - QUEUE ObjectType *string @@ -1080,8 +1127,10 @@ type GcpMySQLSettings struct { // Specifies a script to run immediately after DMS connects to the endpoint. The // migration task continues running regardless if the SQL statement succeeds or - // fails. For this parameter, provide the code of the script itself, not the name - // of a file containing the script. + // fails. + // + // For this parameter, provide the code of the script itself, not the name of a + // file containing the script. AfterConnectScript *string // Cleans and recreates table metadata information on the replication instance @@ -1099,19 +1148,26 @@ 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; + // 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 - // MySQL-compatible database. Example: maxFileSize=512 + // MySQL-compatible database. + // + // Example: maxFileSize=512 MaxFileSize *int32 // Improves performance when loading data into the MySQL-compatible target // database. Specifies how many threads to use to load the data into the // MySQL-compatible target database. Setting a large number of threads can have an // adverse effect on database performance, because a separate connection is - // required for each thread. The default is one. Example: parallelLoadThreads=1 + // required for each thread. The default is one. + // + // Example: parallelLoadThreads=1 ParallelLoadThreads *int32 // Endpoint connection password. @@ -1124,14 +1180,16 @@ type GcpMySQLSettings struct { // trusted entity and grants the required permissions to access the value in // 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 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) - // in the Database Migration Service User Guide. + // 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 required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that @@ -1141,12 +1199,17 @@ type GcpMySQLSettings struct { // The MySQL host name. ServerName *string - // Specifies the time zone for the source MySQL database. Example: - // serverTimezone=US/Pacific; Note: Do not enclose time zones in single quotes. + // Specifies the time zone for the source MySQL database. + // + // Example: serverTimezone=US/Pacific; + // + // Note: Do not enclose time zones in single quotes. ServerTimezone *string // Specifies where to migrate source tables on the target, either to a single - // database or multiple databases. Example: targetDbType=MULTIPLE_DATABASES + // database or multiple databases. + // + // Example: targetDbType=MULTIPLE_DATABASES TargetDbType TargetDbType // Endpoint connection user name. @@ -1166,8 +1229,9 @@ type IBMDb2Settings struct { DatabaseName *string // If true, DMS saves any .csv files to the Db2 LUW target that were used to - // replicate data. DMS uses these files for analysis and troubleshooting. The - // default value is false. + // replicate data. DMS uses these files for analysis and troubleshooting. + // + // The default value is false. KeepCsvFiles *bool // The amount of time (in milliseconds) before DMS times out operations performed @@ -1191,14 +1255,16 @@ type IBMDb2Settings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that @@ -1245,11 +1311,14 @@ type InstanceProfile struct { InstanceProfileName *string // The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the - // connection parameters for the instance profile. If you don't specify a value for - // the KmsKeyArn 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. + // connection parameters for the instance profile. + // + // If you don't specify a value for the KmsKeyArn 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. KmsKeyArn *string // Specifies the network type for the instance profile. A value of IPV4 represents @@ -1296,9 +1365,10 @@ type KafkaSettings struct { // 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 - // 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. + // examples of specifying a list of broker locations, see [Using Apache Kafka as a target for Database Migration Service]in the Database + // Migration Service User Guide. + // + // [Using Apache Kafka as a target for Database Migration Service]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html Broker *string // Shows detailed control information for table definition, column definition, and @@ -1357,7 +1427,7 @@ type KafkaSettings struct { // client using SASL-SSL authentication. SaslPassword *string - // The secure user name you created when you first set up your MSK cluster to + // The secure user name you created when you first set up your MSK cluster to // validate a client identity and make an encrypted connection between server and // client using SASL-SSL authentication. SaslUsername *string @@ -1367,7 +1437,7 @@ type KafkaSettings struct { // sasl-ssl requires SaslUsername and SaslPassword . SecurityProtocol KafkaSecurityProtocol - // The Amazon Resource Name (ARN) for the private certificate authority (CA) cert + // The Amazon Resource Name (ARN) for the private certificate authority (CA) cert // that DMS uses to securely connect to your Kafka target endpoint. SslCaCertificateArn *string @@ -1379,7 +1449,7 @@ type KafkaSettings struct { // connect to a Kafka target endpoint. SslClientKeyArn *string - // The password for the client private key used to securely connect to a Kafka + // The password for the client private key used to securely connect to a Kafka // target endpoint. SslClientKeyPassword *string @@ -1452,11 +1522,13 @@ type KinesisSettings struct { } // Provides information about the limitations of target Amazon Web Services -// engines. Your source database might include features that the target Amazon Web -// Services engine doesn't support. Fleet Advisor lists these features as -// limitations. You should consider these limitations during database migration. -// For each limitation, Fleet Advisor recommends an action that you can take to -// address or avoid this limitation. +// engines. +// +// Your source database might include features that the target Amazon Web Services +// engine doesn't support. Fleet Advisor lists these features as limitations. You +// should consider these limitations during database migration. For each +// limitation, Fleet Advisor recommends an action that you can take to address or +// avoid this limitation. type Limitation struct { // The identifier of the source database. @@ -1567,32 +1639,37 @@ type MicrosoftSQLServerSettings struct { ReadBackupOnly *bool // Use this attribute to minimize the need to access the backup log and enable DMS - // to prevent truncation using one of the following two methods. Start transactions - // in the database: This is the default method. When this method is used, DMS - // prevents TLOG truncation by mimicking a transaction in the database. As long as - // such a transaction is open, changes that appear after the transaction started - // aren't truncated. If you need Microsoft Replication to be enabled in your - // database, then you must choose this method. Exclusively use sp_repldone within a - // single task: When this method is used, DMS reads the changes and then uses - // sp_repldone to mark the TLOG transactions as ready for truncation. Although this - // method doesn't involve any transactional activities, it can only be used when - // Microsoft Replication isn't running. Also, when using this method, only one DMS - // task can access the database at any given time. Therefore, if you need to run - // parallel DMS tasks against the same database, use the default method. + // to prevent truncation using one of the following two methods. + // + // Start transactions in the database: This is the default method. When this + // method is used, DMS prevents TLOG truncation by mimicking a transaction in the + // database. As long as such a transaction is open, changes that appear after the + // transaction started aren't truncated. If you need Microsoft Replication to be + // enabled in your database, then you must choose this method. + // + // Exclusively use sp_repldone within a single task: When this method is used, DMS + // reads the changes and then uses sp_repldone to mark the TLOG transactions as + // ready for truncation. Although this method doesn't involve any transactional + // activities, it can only be used when Microsoft Replication isn't running. Also, + // when using this method, only one DMS task can access the database at any given + // time. Therefore, if you need to run parallel DMS tasks against the same + // database, use the default method. SafeguardPolicy SafeguardPolicy // 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 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that @@ -1600,9 +1677,10 @@ 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], in the [Endpoint].Address field. + // + // [Endpoint]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html + // [DescribeDBInstances]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html ServerName *string // Indicates the mode used to fetch CDC data. @@ -1678,8 +1756,10 @@ type MongoDbDataProviderSettings struct { // DEFAULT, MONGODB_CR, or SCRAM_SHA_1. 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 for the database connection. Valid values are PASSWORD @@ -1708,30 +1788,37 @@ type MongoDbDataProviderSettings struct { // Provides information that defines a MongoDB endpoint. 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 + // 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" . 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. + // 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 . + // 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 . DocsToInvestigate *string - // Specifies the document ID. Use this setting when NestingLevel is set to "none" . + // Specifies the document ID. Use this setting when NestingLevel is set to "none" + // . + // // Default value is "false" . ExtractDocId *string @@ -1742,20 +1829,26 @@ type MongoDbSettings struct { // 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. + // The password for the user account you use to access the MongoDB source + // endpoint. Password *string - // The port value for the MongoDB source endpoint. + // The port value for the MongoDB source endpoint. Port *int32 // If true , DMS replicates data to shard collections. DMS only uses this setting - // if the target endpoint is a DocumentDB elastic cluster. When this setting is - // true , note the following: + // if the target endpoint is a DocumentDB elastic cluster. + // + // When this setting is true , note the following: + // // - You must set TargetTablePrepMode to nothing . + // // - DMS automatically sets useUpdateLookup to false . ReplicateShardCollections *bool @@ -1763,21 +1856,23 @@ type MongoDbSettings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that // contains the MongoDB endpoint connection details. SecretsManagerSecretId *string - // The name of the server on the MongoDB source endpoint. For MongoDB Atlas, + // The name of the server on the MongoDB source endpoint. For MongoDB Atlas, // provide the server name for any of the servers in the replication set. ServerName *string @@ -1817,8 +1912,10 @@ type MySQLSettings struct { // Specifies a script to run immediately after DMS connects to the endpoint. The // migration task continues running regardless if the SQL statement succeeds or - // fails. For this parameter, provide the code of the script itself, not the name - // of a file containing the script. + // fails. + // + // For this parameter, provide the code of the script itself, not the name of a + // file containing the script. AfterConnectScript *string // Cleans and recreates table metadata information on the replication instance @@ -1836,7 +1933,10 @@ 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; + // 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 @@ -1844,14 +1944,18 @@ type MySQLSettings struct { ExecuteTimeout *int32 // Specifies the maximum size (in KB) of any .csv file used to transfer data to a - // MySQL-compatible database. Example: maxFileSize=512 + // MySQL-compatible database. + // + // Example: maxFileSize=512 MaxFileSize *int32 // Improves performance when loading data into the MySQL-compatible target // database. Specifies how many threads to use to load the data into the // MySQL-compatible target database. Setting a large number of threads can have an // adverse effect on database performance, because a separate connection is - // required for each thread. The default is one. Example: parallelLoadThreads=1 + // required for each thread. The default is one. + // + // Example: parallelLoadThreads=1 ParallelLoadThreads *int32 // Endpoint connection password. @@ -1864,36 +1968,45 @@ type MySQLSettings struct { // trusted entity and grants the required permissions to access the value in // 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 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) - // in the Database Migration Service User Guide. + // 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 required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that // contains the MySQL endpoint connection details. 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. + // The host name of the endpoint database. + // + // For an Amazon RDS MySQL instance, this is the output of [DescribeDBInstances], in the [Endpoint].Address field. + // + // For an Aurora MySQL instance, this is the output of [DescribeDBClusters], in the Endpoint field. + // + // [Endpoint]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html + // [DescribeDBInstances]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html + // [DescribeDBClusters]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html ServerName *string - // Specifies the time zone for the source MySQL database. Example: - // serverTimezone=US/Pacific; Note: Do not enclose time zones in single quotes. + // Specifies the time zone for the source MySQL database. + // + // Example: serverTimezone=US/Pacific; + // + // Note: Do not enclose time zones in single quotes. 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 name using the DatabaseName parameter of the Endpoint object. Example: - // targetDbType=MULTIPLE_DATABASES + // database name using the DatabaseName parameter of the Endpoint object. + // + // Example: targetDbType=MULTIPLE_DATABASES TargetDbType TargetDbType // Endpoint connection user name. @@ -1941,9 +2054,9 @@ 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) - // in the Database Migration Service User Guide. + // information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target]in the Database Migration Service User Guide. + // + // [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 ServiceAccessRoleArn *string noSmithyDocumentSerde @@ -1955,9 +2068,9 @@ type OracleDataProviderSettings struct { // The address of your Oracle Automatic Storage Management (ASM) server. 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) - // . + // that uses ASM. For more information, see [Configuration for change data capture (CDC) on an Oracle source database]. + // + // [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 AsmServer *string // The Amazon Resource Name (ARN) of the certificate used for SSL connection. @@ -1974,8 +2087,9 @@ type OracleDataProviderSettings struct { SecretsManagerOracleAsmAccessRoleArn *string // The identifier of the secret in Secrets Manager that contains the Oracle ASM - // connection details. Required only if your data provider uses the Oracle ASM - // server. + // connection details. + // + // Required only if your data provider uses the Oracle ASM server. SecretsManagerOracleAsmSecretId *string // The ARN of the IAM role that provides access to the secret in Secrets Manager @@ -2008,18 +2122,23 @@ type OracleSettings struct { // Set this attribute to set up table-level supplemental logging for the Oracle // database. This attribute enables PRIMARY KEY supplemental logging on all tables - // selected for a migration task. If you use this option, you still need to enable - // database-level supplemental logging. + // selected for a migration task. + // + // If you use this option, you still need to enable database-level supplemental + // logging. AddSupplementalLogging *bool // Set this attribute with ArchivedLogDestId in a primary/ standby setup. This // 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) - // in the Oracle Database Backup and Recovery User's Guide. + // 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] in the Oracle Database Backup and Recovery User's Guide. + // + // [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 AdditionalArchivedLogDestId *int32 // Set this attribute to true to enable replication of Oracle tables containing @@ -2043,30 +2162,31 @@ type OracleSettings struct { // 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) - // . + // Binary Reader. For more information, see [Configuration for change data capture (CDC) on an Oracle source database]. + // + // [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 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) - // . + // For more information, see [Configuration for change data capture (CDC) on an Oracle source database]. + // + // [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 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]. + // + // [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; CharLengthSemantics CharLengthSemantics @@ -2094,33 +2214,44 @@ type OracleSettings struct { // Specifies the IDs of one more destinations for one or more archived redo logs. // These IDs are the values of the dest_id column in the v$archived_log view. Use // this setting with the archivedLogDestId extra connection attribute in a - // primary-to-single setup or a primary-to-multiple-standby setup. This setting is - // useful in a switchover when you use an Oracle Data Guard database as a source. - // In this case, DMS needs information about what destination to get archive redo - // logs from to read changes. DMS needs this because after the switchover the - // previous primary is a standby instance. For example, in a primary-to-single - // standby setup you might apply the following settings. archivedLogDestId=1; - // ExtraArchivedLogDestIds=[2] In a primary-to-multiple-standby setup, you might - // 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) - // in the Oracle Database Backup and Recovery User's Guide. + // primary-to-single setup or a primary-to-multiple-standby setup. + // + // This setting is useful in a switchover when you use an Oracle Data Guard + // database as a source. In this case, DMS needs information about what destination + // to get archive redo logs from to read changes. DMS needs this because after the + // switchover the previous primary is a standby instance. For example, in a + // primary-to-single standby setup you might apply the following settings. + // + // archivedLogDestId=1; ExtraArchivedLogDestIds=[2] + // + // In a primary-to-multiple-standby setup, you might 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] in the Oracle Database Backup and Recovery User's Guide. + // + // [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 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. + // 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 // FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10. + // // Example: numberDataTypeScale=12 NumberDatatypeScale *int32 // The timeframe in minutes to check for open transactions for a CDC-only task. + // // You can specify an integer value between 0 (the default) and 240 (the maximum). + // // This parameter is only valid in DMS version 3.5.0 and later. DMS supports a // window of up to 9.5 hours including the value for OpenTransactionWindow . OpenTransactionWindow *int32 @@ -2158,6 +2289,7 @@ type OracleSettings struct { ReplacePathPrefix *bool // Specifies the number of seconds that the system waits before resending a query. + // // Example: retryInterval=6; RetryInterval *int32 @@ -2165,29 +2297,33 @@ type OracleSettings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager 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 // 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 - // AsmUser , 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) - // in the Database Migration Service User Guide. + // 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 AsmUser , 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] in the Database + // Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerOracleAsmAccessRoleArn *string // Required only if your Oracle endpoint uses Automatic Storage Management (ASM). @@ -2204,9 +2340,10 @@ type OracleSettings struct { // 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) - // in the Database Migration Service User Guide. + // setting. For more information, see [Supported encryption methods for using Oracle as a source for DMS]in the Database Migration Service User + // Guide. + // + // [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 SecurityDbEncryption *string // For an Oracle source endpoint, the name of a key used for the transparent data @@ -2214,15 +2351,19 @@ type OracleSettings struct { // 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 - // 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) - // in the Database Migration Service User Guide. + // securityDbEncryptionName extra connection attribute in [Supported encryption methods for using Oracle as a source for DMS] in the Database + // Migration Service User Guide. + // + // [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 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. + // Fully qualified domain name of the endpoint. + // + // For an Amazon RDS Oracle instance, this is the output of [DescribeDBInstances], in the [Endpoint].Address + // field. + // + // [Endpoint]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html + // [DescribeDBInstances]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html ServerName *string // Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS @@ -2233,10 +2374,12 @@ type OracleSettings struct { // Use this attribute to specify a time in minutes for the delay in standby sync. // If the source is an Oracle Active Data Guard standby database, use this - // attribute to specify the time lag between primary and standby databases. In DMS, - // you can create an Oracle CDC task that uses an Active Data Guard standby - // instance as a source for replicating ongoing changes. Doing this eliminates the - // need to connect to an active database that might be in production. + // attribute to specify the time lag between primary and standby databases. + // + // In DMS, you can create an Oracle CDC task that uses an Active Data Guard + // standby instance as a source for replicating ongoing changes. Doing this + // eliminates the need to connect to an active database that might be in + // production. StandbyDelayTime *int32 // Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR @@ -2252,8 +2395,9 @@ type OracleSettings struct { // 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) - // . + // Management (ASM), see [Using Oracle LogMiner or DMS Binary Reader for CDC]. + // + // [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 @@ -2265,9 +2409,10 @@ type OracleSettings struct { // 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. + // to Y. For more information on this setting and using Oracle ASM, see [Using Oracle LogMiner or DMS Binary Reader for CDC]in the DMS + // User Guide. + // + // [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 UseLogminerReader *bool // Set this string attribute to the required value in order to use the Binary @@ -2311,15 +2456,19 @@ type OrderableReplicationInstance struct { // The value returned when the specified EngineVersion of the replication instance // is in Beta or test mode. This indicates some features might not work as - // expected. DMS supports the ReleaseStatus parameter in versions 3.1.4 and later. + // expected. + // + // DMS supports the ReleaseStatus parameter in versions 3.1.4 and later. ReleaseStatus ReleaseStatusValues // 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 - // 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) - // . + // 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]. + // + // [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. @@ -2392,6 +2541,7 @@ type PostgreSQLSettings struct { // For use with change data capture (CDC) only, this attribute has DMS bypass // foreign keys and user triggers to reduce the time it takes to bulk load data. + // // Example: afterConnectScript=SET session_replication_role='replica' AfterConnectScript *string @@ -2399,8 +2549,10 @@ type PostgreSQLSettings struct { BabelfishDatabaseName *string // 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. + // 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. CaptureDdls *bool // Specifies the default behavior of the replication's handling of PostgreSQL- @@ -2412,17 +2564,21 @@ type PostgreSQLSettings struct { DatabaseName *string // 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; + // 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 - // mode and this option is set to true, the task fails instead of truncating the - // LOB data. + // 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 @@ -2449,7 +2605,9 @@ type PostgreSQLSettings struct { MapLongVarcharAs LongVarcharMappingType // Specifies the maximum size (in KB) of any .csv file used to transfer data to - // PostgreSQL. Example: maxFileSize=512 + // PostgreSQL. + // + // Example: maxFileSize=512 MaxFileSize *int32 // Endpoint connection password. @@ -2465,43 +2623,53 @@ type PostgreSQLSettings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that // contains the PostgreSQL endpoint connection details. 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. + // The host name of the endpoint database. + // + // For an Amazon RDS PostgreSQL instance, this is the output of [DescribeDBInstances], in the [Endpoint].Address + // field. + // + // For an Aurora PostgreSQL instance, this is the output of [DescribeDBClusters], in the Endpoint + // field. + // + // [Endpoint]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html + // [DescribeDBInstances]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html + // [DescribeDBClusters]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html 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 - // 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 - // 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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) + // 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 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) - // . + // CdcStartPosition , see [CreateReplicationTask], [StartReplicationTask], and [ModifyReplicationTask]. + // + // [ModifyReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html + // [Determining a CDC native start point]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native + // [CreateReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html + // [StartReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html SlotName *string // Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR @@ -2574,9 +2742,11 @@ type RdsConfiguration struct { StorageSize *int32 // Describes the storage type of the recommended Amazon RDS DB instance that meets - // your requirements. Amazon RDS provides three storage types: General Purpose SSD - // (also known as gp2 and gp3), Provisioned IOPS SSD (also known as io1), and - // magnetic (also known as standard). + // your requirements. + // + // Amazon RDS provides three storage types: General Purpose SSD (also known as gp2 + // and gp3), Provisioned IOPS SSD (also known as io1), and magnetic (also known as + // standard). StorageType *string noSmithyDocumentSerde @@ -2628,13 +2798,15 @@ type RdsRequirements struct { noSmithyDocumentSerde } -// Provides information that describes a recommendation of a target engine. A -// recommendation is a set of possible Amazon Web Services target engines that you -// can choose to migrate your source on-premises database. In this set, Fleet +// Provides information that describes a recommendation of a target engine. +// +// A recommendation is a set of possible Amazon Web Services target engines that +// you can choose to migrate your source on-premises database. In this set, Fleet // Advisor suggests a single target engine as the right sized migration // destination. To determine this rightsized migration destination, Fleet Advisor // uses the inventory metadata and metrics from data collector. You can use // recommendations before the start of migration to save costs and reduce risks. +// // With recommendations, you can explore different target options and compare // metrics, so you can make an informed decision when you choose the migration // target. @@ -2736,9 +2908,10 @@ type RedisSettings struct { // 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 - // provide Transport Layer Security (TLS) encryption for traffic between endpoint - // and database. + // isn't given for a CA, DMS uses the Amazon root CA. + // + // The plaintext option doesn't provide Transport Layer Security (TLS) encryption + // for traffic between endpoint and database. SslSecurityProtocol SslSecurityProtocolValue noSmithyDocumentSerde @@ -2764,10 +2937,12 @@ type RedshiftSettings struct { // A value that indicates to allow any date format, including invalid formats such // as 00/00/00 00:00:00, to be loaded without generating an error. You can choose - // true or false (the default). This parameter applies only to TIMESTAMP and DATE - // columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date - // format for the data doesn't match the DATEFORMAT specification, Amazon Redshift - // inserts a NULL value into that field. + // true or false (the default). + // + // This parameter applies only to TIMESTAMP and DATE columns. Always use + // ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data + // doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value + // into that field. AcceptAnyDate *bool // Code to run after connecting. This parameter should contain the code itself, @@ -2775,14 +2950,18 @@ type RedshiftSettings struct { 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 - // BucketFolder/NetChangesTableID path. + // 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]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. + // + // [COPY]: https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html BucketFolder *string // The name of the intermediate S3 bucket used to store .csv files before @@ -2812,6 +2991,7 @@ type RedshiftSettings struct { // 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 @@ -2824,11 +3004,15 @@ type RedshiftSettings struct { // 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 + // . + // + // 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" + // 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 // This setting is only valid for a full-load migration task. Set ExplicitIds to @@ -2838,11 +3022,14 @@ type RedshiftSettings struct { 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. + // 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]. + // + // FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10. + // + // [Multipart upload overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html FileTransferUploadStreams *int32 // The amount of time to wait (in milliseconds) before timing out of operations @@ -2883,14 +3070,16 @@ type RedshiftSettings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that @@ -2912,8 +3101,10 @@ type RedshiftSettings struct { // 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 . + // 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 @@ -3026,24 +3217,38 @@ type Replication struct { // 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" StopReason *string @@ -3113,13 +3318,16 @@ type ReplicationInstance struct { // on-premise source or target database. DnsNameServers *string - // 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 . + // 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 . EngineVersion *string - // The expiration date of the free replication instance that is part of the Free + // The expiration date of the free replication instance that is part of the Free // DMS program. FreeUntil *time.Time @@ -3127,13 +3335,17 @@ 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 + // 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 . MultiAZ bool @@ -3149,7 +3361,7 @@ type ReplicationInstance struct { // to the replication instance are performed during this time. PreferredMaintenanceWindow *string - // Specifies the accessibility options for the replication instance. A value of + // 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 . PubliclyAccessible bool @@ -3159,17 +3371,25 @@ type ReplicationInstance struct { // The compute and memory capacity of the replication instance as defined for the // 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) - // . + // 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]. + // + // [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: + // 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. + // // Example: myrepinstance ReplicationInstanceIdentifier *string @@ -3193,18 +3413,31 @@ 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" ReplicationInstanceStatus *string @@ -3237,8 +3470,10 @@ 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) -// user-defined data type. +// instance. This data type is an object of the [ReplicationInstance]ReplicationInstance user-defined +// data type. +// +// [ReplicationInstance]: https://docs.aws.amazon.com/dms/latest/APIReference/API_ReplicationInstance.html type ReplicationPendingModifiedValues struct { // The amount of storage (in gigabytes) that is allocated for the replication @@ -3248,7 +3483,7 @@ type ReplicationPendingModifiedValues struct { // The engine version number of the replication instance. EngineVersion *string - // Specifies whether the replication instance is a Multi-AZ deployment. You can't + // 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 . MultiAZ *bool @@ -3258,10 +3493,12 @@ type ReplicationPendingModifiedValues struct { NetworkType *string // 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) - // . + // 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]. + // + // [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 @@ -3340,17 +3577,24 @@ type ReplicationTask struct { // Indicates when you want a change data capture (CDC) operation to start. Use // either CdcStartPosition or CdcStartTime to specify when you want the CDC - // operation to start. Specifying both values results in an error. The value can be - // in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position - // “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position + // operation to start. Specifying both values results in an error. + // + // The value can be in date, checkpoint, or LSN/SCN format. + // + // Date Example: --cdc-start-position “2018-03-08T12:12:12” + // + // Checkpoint Example: --cdc-start-position // "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93" + // // 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: - // --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: - // --cdc-stop-position “commit_time:2018-02-09T12:12:12“ + // 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 // The last error (failure) message generated for the replication task. @@ -3373,9 +3617,14 @@ type ReplicationTask struct { // The date the replication task was created. ReplicationTaskCreationDate *time.Time - // The user-assigned replication task identifier or name. Constraints: + // 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. ReplicationTaskIdentifier *string @@ -3394,75 +3643,96 @@ 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. + // + // - "moving" – The task is being moved in response to running the [MoveReplicationTask] + // MoveReplicationTask operation. + // + // - "creating" – The task is being created in response to running the [CreateReplicationTask] + // CreateReplicationTask operation. + // + // - "deleting" – The task is being deleted in response to running the [DeleteReplicationTask] + // DeleteReplicationTask 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. + // in response to running the [StartReplicationTask]StartReplicationTask operation. + // + // - "failed-move" – The task failed to move in response to running the [MoveReplicationTask] + // MoveReplicationTask 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. + // the [ModifyReplicationTask]ModifyReplicationTask 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) - // . + // operations, such as [StartReplicationTask]StartReplicationTask or [DeleteReplicationTask]DeleteReplicationTask . + // // - "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. + // running the [StartReplicationTask]StartReplicationTask 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. + // response to running the [StartReplicationTask]StartReplicationTask operation. + // + // - "stopped" – The task has stopped in response to running the [StopReplicationTask] + // StopReplicationTask operation. + // + // - "stopping" – The task is preparing to stop in response to running the [StopReplicationTask] + // StopReplicationTask 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. + // in response to running either the [StartReplicationTaskAssessmentRun]StartReplicationTaskAssessmentRun or the [StartReplicationTaskAssessment] + // StartReplicationTaskAssessment operation. + // + // [StartReplicationTaskAssessmentRun]StartReplicationTaskAssessmentRun is an improved premigration task assessment + // operation. The [StartReplicationTaskAssessment]StartReplicationTaskAssessment operation assesses data type + // compatibility only between the source and target database of a given migration + // task. In contrast, [StartReplicationTaskAssessmentRun]StartReplicationTaskAssessmentRun 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. + // + // [ModifyReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html + // [DeleteReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html + // [CreateReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html + // [StartReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html + // [StopReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html + // [StartReplicationTaskAssessment]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html + // [MoveReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html + // [StartReplicationTaskAssessmentRun]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html 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" StopReason *string @@ -3473,15 +3743,17 @@ 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) - // operation. Otherwise, this response parameter isn't a member of the - // ReplicationTask object. + // running the [MoveReplicationTask]MoveReplicationTask operation. Otherwise, this response parameter + // isn't a member of the ReplicationTask object. + // + // [MoveReplicationTask]: https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html 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. + // source and target endpoints. For more information, see [Specifying Supplemental Data for Task Settings]in the Database + // Migration Service User Guide. + // + // [Specifying Supplemental Data for Task Settings]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html TaskData *string noSmithyDocumentSerde @@ -3490,40 +3762,39 @@ type ReplicationTask struct { // The task assessment report in JSON format. type ReplicationTaskAssessmentResult struct { - // The task assessment results in JSON format. The response object only contains - // this field if you provide - // DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the - // request. + // The task assessment results in JSON format. + // + // The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request. AssessmentResults *string - // The file containing the results of the task assessment. + // The file containing the results of the task assessment. AssessmentResultsFile *string - // The status of the task assessment. + // The status of the task assessment. AssessmentStatus *string // The Amazon Resource Name (ARN) of the replication task. ReplicationTaskArn *string - // The replication task identifier of the task on which the task assessment was + // The replication task identifier of the task on which the task assessment was // run. ReplicationTaskIdentifier *string // The date the task assessment was completed. ReplicationTaskLastAssessmentDate *time.Time - // The URL of the S3 object containing the task assessment results. The response - // object only contains this field if you provide - // DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the - // request. + // The URL of the S3 object containing the task assessment results. + // + // The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request. S3ObjectUrl *string noSmithyDocumentSerde } // Provides information that describes a premigration assessment run that you have -// started using the StartReplicationTaskAssessmentRun operation. Some of the -// information appears based on other operations that can return the +// started using the StartReplicationTaskAssessmentRun operation. +// +// Some of the information appears based on other operations that can return the // ReplicationTaskAssessmentRun object. type ReplicationTaskAssessmentRun struct { @@ -3565,23 +3836,34 @@ type ReplicationTaskAssessmentRun struct { // iam:PassRole action. ServiceAccessRoleArn *string - // Assessment run status. This status can have one of the following values: + // 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. + // + // - "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 @@ -3619,12 +3901,20 @@ type ReplicationTaskIndividualAssessment struct { // StartReplicationTaskAssessmentRun operation. ReplicationTaskIndividualAssessmentStartDate *time.Time - // Individual assessment status. This status can have one of the following values: + // Individual assessment status. + // + // This status can have one of the following values: + // // - "cancelled" + // // - "error" + // // - "failed" + // // - "passed" + // // - "pending" + // // - "running" Status *string @@ -3652,8 +3942,9 @@ type ReplicationTaskStats struct { 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) - // . + // resume. For more information, see [StartReplicationTaskType]. + // + // [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. @@ -3681,9 +3972,10 @@ 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) - // in the DMS documentation. + // action applies to. For information about creating an ARN, see [Constructing an Amazon Resource Name (ARN) for DMS]in the DMS + // documentation. + // + // [Constructing an Amazon Resource Name (ARN) for DMS]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Introduction.AWS.ARN.html ResourceIdentifier *string noSmithyDocumentSerde @@ -3693,47 +3985,58 @@ type ResourcePendingMaintenanceActions struct { 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 . + // 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 . AddTrailingPaddingCharacter *bool - // An optional parameter to set a folder name in the S3 bucket. If provided, + // 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. + // The name of the S3 bucket. BucketName *string // 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, - // AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL. + // information about Amazon S3 canned ACLs, see [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. + // + // [Canned ACL]: http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 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 - // .parquet file. DMS supports the use of the .parquet files in versions 3.4.7 and - // later. How these INSERTs and UPDATEs are recorded depends on the value of the + // .parquet file. + // + // DMS supports the use of the .parquet files in versions 3.4.7 and later. + // + // 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 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 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) - // 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. + // the source. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data]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. + // + // [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 CdcInsertsAndUpdates *bool // A value that enables a change data capture (CDC) load to write only INSERT @@ -3741,51 +4044,72 @@ 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 - // 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 + // 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 // 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 // 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) - // 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 - // 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. + // work together, see [Indicating Source DB Operations in Migrated S3 Data]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 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. + // + // [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 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. + // 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 - // S3. When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file - // write is triggered by whichever parameter condition is met first within an DMS - // CloudFormation template. The default value is 32 MB. + // S3. + // + // When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file write + // is triggered by whichever parameter condition is met first within an DMS + // CloudFormation template. + // + // The default value is 32 MB. 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 - // 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 + // the target endpoint. For an S3 target if you set [PreserveTransactions]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]BucketFolder and [BucketName]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. + // 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]. + // + // This setting is supported in DMS versions 3.4.2 and later. + // + // [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 + // [PreserveTransactions]: https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions + // [BucketName]: https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName + // [BucketFolder]: https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder CdcPath *string // An optional parameter to use GZIP to compress the target files. Set to GZIP to @@ -3794,16 +4118,19 @@ type S3Settings struct { // .csv and .parquet file formats. CompressionType CompressionTypeValue - // The delimiter used to separate columns in the .csv file for both source and + // The delimiter used to separate columns in the .csv file for both source and // target. The default is a comma. 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) - // 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 - // setting. This setting is supported in DMS versions 3.4.1 and later. + // capture (CDC) load are written in .csv format. If [UseCsvNoSupValue]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 setting. + // + // This setting is supported in DMS versions 3.4.1 and later. + // + // [UseCsvNoSupValue]: https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue CsvNoSupValue *string // An optional parameter that specifies how DMS treats null values. While handling @@ -3811,17 +4138,20 @@ type S3Settings struct { // when writing to the target. For example, when target columns are 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. + // 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 + // 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. DataFormat DataFormatValue @@ -3837,8 +4167,9 @@ type S3Settings struct { // 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) - // . + // about date-based folder partitioning, see [Using date-based folder partitioning]. + // + // [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. @@ -3851,9 +4182,10 @@ type S3Settings struct { // 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. - // s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence": - // "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH", - // "DatePartitionTimezone":"Asia/Seoul", "BucketName": "dms-nattarat-test"}' + // + // 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 @@ -3870,9 +4202,12 @@ type S3Settings struct { 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. EncodingType EncodingTypeValue @@ -3880,32 +4215,48 @@ type S3Settings struct { // 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 + // . + // + // 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: + // 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 EncryptionMode EncryptionModeValue // To specify a bucket owner and prevent sniping, you can use the - // ExpectedBucketOwner endpoint setting. Example: - // --s3-settings='{"ExpectedBucketOwner": "AWS_Account_ID"}' When you make a - // request to test a connection or perform a migration, S3 checks the account ID of - // the bucket owner against the specified parameter. + // ExpectedBucketOwner endpoint setting. + // + // Example: --s3-settings='{"ExpectedBucketOwner": "AWS_Account_ID"}' + // + // When you make a request to test a connection or perform a migration, S3 checks + // the account ID of the bucket owner against the specified parameter. ExpectedBucketOwner *string - // Specifies how tables are defined in the S3 source files only. + // Specifies how tables are defined in the S3 source files only. ExternalTableDefinition *string // When true, allows Glue to catalog your S3 bucket. Creating an Glue catalog lets @@ -3913,42 +4264,58 @@ type S3Settings struct { GlueCatalogGeneration *bool // When this value is set to 1, DMS ignores the first row header in a .csv file. A - // value of 1 turns on the feature; a value of 0 turns off the feature. The default - // is 0. + // value of 1 turns on the feature; a value of 0 turns off the feature. + // + // The default is 0. IgnoreHeaderRows *int32 // A value that enables a full load to write INSERT operations to the // comma-separated value (.csv) or .parquet 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. DMS supports the use of the .parquet - // files with the IncludeOpForFullLoad parameter in versions 3.4.7 and later. For - // full load, records can only be inserted. By default (the false setting), no + // rows were added to the source database. + // + // DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later. + // + // DMS supports the use of the .parquet files with the IncludeOpForFullLoad + // parameter in versions 3.4.7 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 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) - // in the Database Migration Service User Guide.. + // 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]in the Database Migration Service User Guide.. + // + // [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 IncludeOpForFullLoad *bool // A value that specifies the maximum size (in KB) of any .csv file to be created - // while migrating to an S3 target during full load. The default value is 1,048,576 - // KB (1 GB). Valid values include 1 to 1,048,576. + // while migrating to an S3 target during full load. + // + // The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576. MaxFileSize *int32 // 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 - // 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 - // true for S3 endpoint object files that are .parquet formatted only if you plan - // to query or process the data with Athena or Glue. DMS writes any TIMESTAMP - // column values written to an S3 file in .csv format with microsecond precision. + // 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 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 true for S3 endpoint object files that + // are .parquet formatted only if you plan to query or process the data with Athena + // or Glue. + // + // DMS writes any TIMESTAMP column values written to an S3 file in .csv format + // with microsecond precision. + // // Setting ParquetTimestampInMillisecond has no effect on the string format of the // timestamp column value that is inserted by setting the TimestampColumnName // parameter. @@ -3959,10 +4326,12 @@ type S3Settings struct { 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. + // load on the Amazon S3 target specified by [CdcPath]CdcPath . For more information, see [Capturing data changes (CDC) including transaction order on the S3 target]. + // + // This setting is supported in DMS versions 3.4.2 and later. + // + // [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 + // [CdcPath]: https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath PreserveTransactions *bool // For an S3 source, when this value is set to true or y , each leading double @@ -3970,66 +4339,83 @@ type S3Settings struct { // 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 - // optional parameter used to set behavior to comply with RFC 4180 for data - // migrated to Amazon S3 using .csv file format only. When this value is set to - // 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 - // . + // the string, because it signals the end of the value. + // + // For an S3 target, an optional parameter used to set behavior to comply with RFC + // 4180 for data migrated to Amazon S3 using .csv file format only. When this value + // is set to 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 . Rfc4180 *bool // The number of rows in a row group. A smaller row group size provides faster // reads. But as the number of row groups grows, the slower writes become. This // parameter defaults to 10,000 rows. This number is used for .parquet file format - // only. If you choose a value larger than the maximum, RowGroupLength is set to - // the max row group length in bytes (64 * 1024 * 1024). + // only. + // + // If you choose a value larger than the maximum, RowGroupLength is set to 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 - // 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 + // 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 // ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ServerSideEncryptionKmsKeyId *string - // The Amazon Resource Name (ARN) used by the service to access the IAM role. The + // 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. 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 - // 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 - // 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 - // 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 . + // 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 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 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 . 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 - // setting is supported in DMS versions 3.4.1 and later. + // supplemental log, DMS uses the value specified by [CsvNoSupValue]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. + // + // [CsvNoSupValue]: https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue 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 // 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. + // 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 *bool noSmithyDocumentSerde @@ -4221,14 +4607,16 @@ type SybaseSettings struct { // trusted entity and grants the required permissions to access the value in // 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 - // 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) - // in the Database Migration Service User Guide. + // 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 information on creating this SecretsManagerSecret + // and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to + // access it, see [Using secrets to access Database Migration Service resources]in the Database Migration Service User Guide. + // + // [Using secrets to access Database Migration Service resources]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager SecretsManagerAccessRoleArn *string // The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that @@ -4301,9 +4689,10 @@ type TableStatistics struct { // The name of the table. TableName *string - // The state of the tables described. Valid states: Table does not exist | Before - // load | Full load | Table completed | Table cancelled | Table error | Table is - // being reloaded + // The state of the tables described. + // + // Valid states: Table does not exist | Before load | Full load | Table completed + // | Table cancelled | Table error | Table is being reloaded TableState *string // The number of update actions performed on a table. @@ -4315,23 +4704,35 @@ type TableStatistics struct { // The number of records that have yet to be validated. ValidationPendingRecords int64 - // The validation state of the table. This parameter can have the following - // values: + // 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. ValidationState *string @@ -4363,8 +4764,11 @@ 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 type Tag struct { @@ -4399,9 +4803,10 @@ type TimestreamSettings struct { // Set this attribute to specify the default magnetic duration applied to the // Amazon Timestream tables in days. This is the number of days that records remain - // in magnetic store before being discarded. For more information, see Storage (https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html) - // in the Amazon Timestream Developer Guide (https://docs.aws.amazon.com/timestream/latest/developerguide/) - // . + // in magnetic store before being discarded. For more information, see [Storage]in the [Amazon Timestream Developer Guide]. + // + // [Storage]: https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html + // [Amazon Timestream Developer Guide]: https://docs.aws.amazon.com/timestream/latest/developerguide/ // // This member is required. MagneticDuration *int32 @@ -4423,9 +4828,10 @@ type TimestreamSettings struct { // Set this attribute to true to enable memory store writes. When this value is // false , DMS does not write records that are older in days than the value // specified in MagneticDuration , because Amazon Timestream does not allow memory - // writes by default. For more information, see Storage (https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html) - // in the Amazon Timestream Developer Guide (https://docs.aws.amazon.com/timestream/latest/developerguide/) - // . + // writes by default. For more information, see [Storage]in the [Amazon Timestream Developer Guide]. + // + // [Storage]: https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html + // [Amazon Timestream Developer Guide]: https://docs.aws.amazon.com/timestream/latest/developerguide/ EnableMagneticStoreWrites *bool noSmithyDocumentSerde diff --git a/service/databrew/api_op_BatchDeleteRecipeVersion.go b/service/databrew/api_op_BatchDeleteRecipeVersion.go index c086cd4491b..8c578e74487 100644 --- a/service/databrew/api_op_BatchDeleteRecipeVersion.go +++ b/service/databrew/api_op_BatchDeleteRecipeVersion.go @@ -11,18 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes one or more versions of a recipe at a time. The entire request will be -// rejected if: +// 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 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 diff --git a/service/databrew/api_op_CreateProfileJob.go b/service/databrew/api_op_CreateProfileJob.go index efe8cec7f14..082f1ea760a 100644 --- a/service/databrew/api_op_CreateProfileJob.go +++ b/service/databrew/api_op_CreateProfileJob.go @@ -62,7 +62,9 @@ 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. EncryptionMode types.EncryptionMode diff --git a/service/databrew/api_op_CreateRecipeJob.go b/service/databrew/api_op_CreateRecipeJob.go index 7de7c38e965..910b31e1325 100644 --- a/service/databrew/api_op_CreateRecipeJob.go +++ b/service/databrew/api_op_CreateRecipeJob.go @@ -58,7 +58,9 @@ 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. EncryptionMode types.EncryptionMode diff --git a/service/databrew/api_op_CreateSchedule.go b/service/databrew/api_op_CreateSchedule.go index d7ad43edf79..0186f784a19 100644 --- a/service/databrew/api_op_CreateSchedule.go +++ b/service/databrew/api_op_CreateSchedule.go @@ -30,8 +30,9 @@ 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]in the Glue DataBrew Developer Guide. + // + // [Cron expressions]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html // // This member is required. CronExpression *string diff --git a/service/databrew/api_op_DescribeJob.go b/service/databrew/api_op_DescribeJob.go index 27ef8df5e19..58d40da776e 100644 --- a/service/databrew/api_op_DescribeJob.go +++ b/service/databrew/api_op_DescribeJob.go @@ -67,7 +67,9 @@ 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. EncryptionMode types.EncryptionMode @@ -120,8 +122,10 @@ type DescribeJobOutput struct { 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. Type types.JobType diff --git a/service/databrew/api_op_DescribeProject.go b/service/databrew/api_op_DescribeProject.go index c7cb657dd14..06abe049d31 100644 --- a/service/databrew/api_op_DescribeProject.go +++ b/service/databrew/api_op_DescribeProject.go @@ -81,8 +81,11 @@ type DescribeProjectOutput struct { 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. SessionStatus types.SessionStatus diff --git a/service/databrew/api_op_DescribeSchedule.go b/service/databrew/api_op_DescribeSchedule.go index 319851eed1c..9a11b1c0793 100644 --- a/service/databrew/api_op_DescribeSchedule.go +++ b/service/databrew/api_op_DescribeSchedule.go @@ -51,8 +51,9 @@ 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]in the Glue DataBrew Developer Guide. + // + // [Cron expressions]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html 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_ListRecipes.go b/service/databrew/api_op_ListRecipes.go index f89d08919ff..1acea686b05 100644 --- a/service/databrew/api_op_ListRecipes.go +++ b/service/databrew/api_op_ListRecipes.go @@ -37,8 +37,9 @@ type ListRecipesInput struct { // 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 recipe versions. Valid values: LATEST_WORKING | - // LATEST_PUBLISHED + // LATEST_PUBLISHED recipe versions. + // + // Valid values: LATEST_WORKING | LATEST_PUBLISHED RecipeVersion *string noSmithyDocumentSerde diff --git a/service/databrew/api_op_UpdateProfileJob.go b/service/databrew/api_op_UpdateProfileJob.go index f3b46149b64..a4b9ff35aac 100644 --- a/service/databrew/api_op_UpdateProfileJob.go +++ b/service/databrew/api_op_UpdateProfileJob.go @@ -56,7 +56,9 @@ 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. EncryptionMode types.EncryptionMode diff --git a/service/databrew/api_op_UpdateRecipeJob.go b/service/databrew/api_op_UpdateRecipeJob.go index 618b2087421..27aea16d054 100644 --- a/service/databrew/api_op_UpdateRecipeJob.go +++ b/service/databrew/api_op_UpdateRecipeJob.go @@ -53,7 +53,9 @@ 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. EncryptionMode types.EncryptionMode diff --git a/service/databrew/api_op_UpdateSchedule.go b/service/databrew/api_op_UpdateSchedule.go index 278d53e09e8..cc82c7f6a5a 100644 --- a/service/databrew/api_op_UpdateSchedule.go +++ b/service/databrew/api_op_UpdateSchedule.go @@ -29,8 +29,9 @@ 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]in the Glue DataBrew Developer Guide. + // + // [Cron expressions]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html // // This member is required. CronExpression *string diff --git a/service/databrew/options.go b/service/databrew/options.go index ce023fb8984..d23c923295c 100644 --- a/service/databrew/options.go +++ b/service/databrew/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/databrew/types/enums.go b/service/databrew/types/enums.go index 465f5d08acc..c49725e4f8e 100644 --- a/service/databrew/types/enums.go +++ b/service/databrew/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AnalyticsMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsMode) Values() []AnalyticsMode { return []AnalyticsMode{ "ENABLE", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for CompressionFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionFormat) Values() []CompressionFormat { return []CompressionFormat{ "GZIP", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for DatabaseOutputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseOutputMode) Values() []DatabaseOutputMode { return []DatabaseOutputMode{ "NEW_TABLE", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for EncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionMode) Values() []EncryptionMode { return []EncryptionMode{ "SSE-KMS", @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for InputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputFormat) Values() []InputFormat { return []InputFormat{ "CSV", @@ -124,8 +129,9 @@ const ( ) // Values returns all known values for JobRunState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobRunState) Values() []JobRunState { return []JobRunState{ "STARTING", @@ -147,8 +153,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "PROFILE", @@ -165,8 +172,9 @@ const ( ) // Values returns all known values for LogSubscription. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogSubscription) Values() []LogSubscription { return []LogSubscription{ "ENABLE", @@ -183,8 +191,9 @@ const ( ) // 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. +// the future, and so 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{ "DESCENDING", @@ -200,8 +209,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -223,8 +233,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -248,8 +259,9 @@ const ( ) // Values returns all known values for ParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterType) Values() []ParameterType { return []ParameterType{ "Datetime", @@ -267,8 +279,9 @@ const ( ) // Values returns all known values for SampleMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SampleMode) Values() []SampleMode { return []SampleMode{ "FULL_DATASET", @@ -286,8 +299,9 @@ const ( ) // Values returns all known values for SampleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SampleType) Values() []SampleType { return []SampleType{ "FIRST_N", @@ -313,8 +327,9 @@ const ( ) // Values returns all known values for SessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionStatus) Values() []SessionStatus { return []SessionStatus{ "ASSIGNED", @@ -340,8 +355,9 @@ const ( ) // Values returns all known values for Source. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Source) Values() []Source { return []Source{ "S3", @@ -361,8 +377,9 @@ const ( ) // Values returns all known values for ThresholdType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThresholdType) Values() []ThresholdType { return []ThresholdType{ "GREATER_THAN_OR_EQUAL", @@ -381,8 +398,9 @@ const ( ) // Values returns all known values for ThresholdUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThresholdUnit) Values() []ThresholdUnit { return []ThresholdUnit{ "COUNT", @@ -398,8 +416,9 @@ const ( ) // Values returns all known values for ValidationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationMode) Values() []ValidationMode { return []ValidationMode{ "CHECK_ALL", diff --git a/service/databrew/types/types.go b/service/databrew/types/types.go index 4aab8a16f5b..11816b83c23 100644 --- a/service/databrew/types/types.go +++ b/service/databrew/types/types.go @@ -53,17 +53,20 @@ type ColumnStatisticsConfiguration struct { noSmithyDocumentSerde } -// Represents an individual condition that evaluates to true or false. Conditions -// are used with recipe actions. The action is only performed for column values -// where the condition evaluates to true. If a recipe requires more than one -// condition, then the recipe must specify multiple ConditionExpression elements. -// Each condition is applied to the rows in a dataset first, before the recipe -// action is performed. +// Represents an individual condition that evaluates to true or false. +// +// Conditions are used with recipe actions. The action is only performed for +// column values where the condition evaluates to true. +// +// If a recipe requires more than one condition, then the recipe must specify +// multiple ConditionExpression elements. Each condition is applied to the rows in +// a dataset first, before the recipe action is performed. 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) - // in the Glue DataBrew Developer Guide. + // A specific condition to apply to a recipe action. For more information, see [Recipe structure] in + // the Glue DataBrew Developer Guide. + // + // [Recipe structure]: https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure // // This member is required. Condition *string @@ -334,25 +337,45 @@ 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. // @@ -408,8 +431,9 @@ type FilesLimit struct { } // 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) -// in the Glue DataBrew Developer Guide. +// are described here: [Supported conditions for dynamic datasets]in the Glue DataBrew Developer Guide. +// +// [Supported conditions for dynamic datasets]: https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets type FilterExpression struct { // The expression which includes condition names followed by substitution @@ -493,11 +517,15 @@ 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] + // + // [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. EncryptionMode EncryptionMode @@ -545,8 +573,10 @@ type Job struct { 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. Type JobType @@ -630,14 +660,18 @@ 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. Mode SampleMode // The Size parameter is only required when the mode is CUSTOM_ROWS. The profile // job is run on the specified number of rows. The maximum value for size is - // Long.MAX_VALUE. Long.MAX_VALUE = 9223372036854775807 + // Long.MAX_VALUE. + // + // Long.MAX_VALUE = 9223372036854775807 Size *int64 noSmithyDocumentSerde @@ -843,11 +877,14 @@ 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. RecipeVersion *string @@ -864,8 +901,9 @@ 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]. +// +// [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. @@ -901,9 +939,10 @@ type RecipeStep struct { // This member is required. Action *RecipeAction - // One or more conditions that must be met for the recipe step to succeed. All of - // the conditions in the array must be met. In other words, all of the conditions - // must be combined using a logical AND operation. + // One or more conditions that must be met for the recipe step to succeed. + // + // All of the conditions in the array must be met. In other words, all of the + // conditions must be combined using a logical AND operation. ConditionExpressions []ConditionExpression noSmithyDocumentSerde @@ -939,7 +978,11 @@ type Rule struct { // 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] + // + // [Available checks]: https://docs.aws.amazon.com/databrew/latest/dg/profile.data-quality-available-checks.html // // This member is required. CheckExpression *string @@ -1080,9 +1123,10 @@ type Schedule struct { // The Amazon Resource Name (ARN) of the user who created the schedule. CreatedBy *string - // The dates and times when the job is to run. For more information, see Cron - // expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in - // the Glue DataBrew Developer Guide. + // The dates and times when the job is to run. For more information, see [Cron expressions] in the + // Glue DataBrew Developer Guide. + // + // [Cron expressions]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html CronExpression *string // A list of jobs to be run, according to the schedule. diff --git a/service/dataexchange/doc.go b/service/dataexchange/doc.go index 73dadc1e6ef..e4377538c41 100644 --- a/service/dataexchange/doc.go +++ b/service/dataexchange/doc.go @@ -5,16 +5,20 @@ // // AWS Data Exchange is a service that makes it easy for AWS customers to exchange // data in the cloud. You can use the AWS Data Exchange APIs to create, update, -// manage, and access file-based data set in the AWS Cloud. As a subscriber, you -// can view and access the data sets that you have an entitlement to through a -// subscription. You can use the APIs to download or copy your entitled data sets -// to Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS -// analytics and machine learning services. As a provider, you can create and -// manage your data sets that you would like to publish to a product. Being able to -// package and provide your data sets into products requires a few steps to -// determine eligibility. For more information, visit the AWS Data Exchange User -// Guide. A data set is a collection of data that can be changed or updated over -// time. Data sets can be updated using revisions, which represent a new version or +// manage, and access file-based data set in the AWS Cloud. +// +// As a subscriber, you can view and access the data sets that you have an +// entitlement to through a subscription. You can use the APIs to download or copy +// your entitled data sets to Amazon Simple Storage Service (Amazon S3) for use +// across a variety of AWS analytics and machine learning services. +// +// As a provider, you can create and manage your data sets that you would like to +// publish to a product. Being able to package and provide your data sets into +// products requires a few steps to determine eligibility. For more information, +// visit the AWS Data Exchange User Guide. +// +// A data set is a collection of data that can be changed or updated over time. +// Data sets can be updated using revisions, which represent a new version or // incremental change to a data set. A revision contains one or more assets. An // asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 // object, Redshift datashare, API Gateway API, AWS Lake Formation data permission, diff --git a/service/dataexchange/options.go b/service/dataexchange/options.go index e2a2012d48c..e9352594ed3 100644 --- a/service/dataexchange/options.go +++ b/service/dataexchange/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/dataexchange/types/enums.go b/service/dataexchange/types/enums.go index ba827b7ea5d..265b45ed179 100644 --- a/service/dataexchange/types/enums.go +++ b/service/dataexchange/types/enums.go @@ -14,8 +14,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -40,8 +41,9 @@ const ( ) // Values returns all known values for Code. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Code) Values() []Code { return []Code{ "ACCESS_DENIED_EXCEPTION", @@ -63,8 +65,9 @@ const ( // Values returns all known values for DatabaseLFTagPolicyPermission. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseLFTagPolicyPermission) Values() []DatabaseLFTagPolicyPermission { return []DatabaseLFTagPolicyPermission{ "DESCRIBE", @@ -80,8 +83,9 @@ const ( ) // Values returns all known values for ExceptionCause. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExceptionCause) Values() []ExceptionCause { return []ExceptionCause{ "InsufficientS3BucketPolicy", @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for JobErrorLimitName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobErrorLimitName) Values() []JobErrorLimitName { return []JobErrorLimitName{ "Assets per revision", @@ -123,8 +128,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "REVISION", @@ -142,8 +148,9 @@ const ( // Values returns all known values for LakeFormationDataPermissionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LakeFormationDataPermissionType) Values() []LakeFormationDataPermissionType { return []LakeFormationDataPermissionType{ "LFTagPolicy", @@ -159,8 +166,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -177,8 +185,9 @@ const ( ) // Values returns all known values for LFResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LFResourceType) Values() []LFResourceType { return []LFResourceType{ "TABLE", @@ -221,8 +230,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -267,8 +277,9 @@ const ( ) // Values returns all known values for NotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationType) Values() []NotificationType { return []NotificationType{ "DATA_DELAY", @@ -287,8 +298,9 @@ const ( ) // Values returns all known values for Origin. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Origin) Values() []Origin { return []Origin{ "OWNED", @@ -304,8 +316,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -324,8 +337,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -346,8 +360,9 @@ const ( ) // Values returns all known values for SchemaChangeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaChangeType) Values() []SchemaChangeType { return []SchemaChangeType{ "ADD", @@ -366,6 +381,7 @@ const ( // Values returns all known values for ServerSideEncryptionTypes. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServerSideEncryptionTypes) Values() []ServerSideEncryptionTypes { return []ServerSideEncryptionTypes{ @@ -387,8 +403,9 @@ const ( ) // 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. +// the future, and so 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{ "WAITING", @@ -410,6 +427,7 @@ const ( // Values returns all known values for TableTagPolicyLFPermission. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TableTagPolicyLFPermission) Values() []TableTagPolicyLFPermission { return []TableTagPolicyLFPermission{ @@ -434,8 +452,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "IMPORT_ASSETS_FROM_S3", diff --git a/service/dataexchange/types/types.go b/service/dataexchange/types/types.go index 65ac766c3e6..cf9af5748b4 100644 --- a/service/dataexchange/types/types.go +++ b/service/dataexchange/types/types.go @@ -185,9 +185,9 @@ type AutoExportRevisionDestinationEntry struct { Bucket *string // 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) - // . + // in the revision. For more information about key patterns, see [Key patterns when exporting revisions]. + // + // [Key patterns when exporting revisions]: https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns KeyPattern *string noSmithyDocumentSerde @@ -1248,9 +1248,9 @@ type RevisionDestinationEntry struct { RevisionId *string // 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) - // . + // in the revision. For more information about key patterns, see [Key patterns when exporting revisions]. + // + // [Key patterns when exporting revisions]: https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns KeyPattern *string noSmithyDocumentSerde @@ -1339,7 +1339,7 @@ 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 + // 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 diff --git a/service/datapipeline/api_op_ActivatePipeline.go b/service/datapipeline/api_op_ActivatePipeline.go index 7ebfe0c72a2..819c6f9f51a 100644 --- a/service/datapipeline/api_op_ActivatePipeline.go +++ b/service/datapipeline/api_op_ActivatePipeline.go @@ -13,16 +13,26 @@ 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: -// 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": -// "df-06372391ZG65EXAMPLE"} HTTP/1.1 200 x-amzn-RequestId: -// ee19d5bf-074e-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 2 Date: Mon, 12 Nov 2012 17:50:53 GMT {} +// 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: 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": "df-06372391ZG65EXAMPLE"} +// +// HTTP/1.1 200 x-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9 +// Content-Type: application/x-amz-json-1.1 Content-Length: 2 Date: Mon, 12 Nov +// 2012 17:50:53 GMT +// +// {} func (c *Client) ActivatePipeline(ctx context.Context, params *ActivatePipelineInput, optFns ...func(*Options)) (*ActivatePipelineOutput, error) { if params == nil { params = &ActivatePipelineInput{} diff --git a/service/datapipeline/api_op_CreatePipeline.go b/service/datapipeline/api_op_CreatePipeline.go index 8a1100fd6b8..91bf0f11720 100644 --- a/service/datapipeline/api_op_CreatePipeline.go +++ b/service/datapipeline/api_op_CreatePipeline.go @@ -11,15 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new, empty pipeline. Use PutPipelineDefinition to populate the -// pipeline. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: +// Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. +// +// POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: // DataPipeline.CreatePipeline Content-Length: 91 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"name": "myPipeline", "uniqueId": "123456789", -// "description": "This is my first pipeline"} HTTP/1.1 200 x-amzn-RequestId: -// b16911ce-0774-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 40 Date: Mon, 12 Nov 2012 17:50:53 GMT {"pipelineId": -// "df-06372391ZG65EXAMPLE"} +// Authorization: AuthParams +// +// {"name": "myPipeline", "uniqueId": "123456789", "description": "This is my +// first pipeline"} +// +// HTTP/1.1 200 x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9 +// Content-Type: application/x-amz-json-1.1 Content-Length: 40 Date: Mon, 12 Nov +// 2012 17:50:53 GMT +// +// {"pipelineId": "df-06372391ZG65EXAMPLE"} func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error) { if params == nil { params = &CreatePipelineInput{} @@ -64,9 +70,10 @@ type CreatePipelineInput struct { Description *string // 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) - // in the AWS Data Pipeline Developer Guide. + // access to pipelines. For more information, see [Controlling User Access to Pipelines]in the AWS Data Pipeline + // Developer Guide. + // + // [Controlling User Access to Pipelines]: http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/datapipeline/api_op_DeactivatePipeline.go b/service/datapipeline/api_op_DeactivatePipeline.go index 675fd56db64..dba5f381f9b 100644 --- a/service/datapipeline/api_op_DeactivatePipeline.go +++ b/service/datapipeline/api_op_DeactivatePipeline.go @@ -11,10 +11,11 @@ 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 -// from the last completed execution. Optionally, you can specify the date and time -// to resume the pipeline. +// DEACTIVATING state until the deactivation process completes. +// +// To resume a 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) { if params == nil { params = &DeactivatePipelineInput{} diff --git a/service/datapipeline/api_op_DeletePipeline.go b/service/datapipeline/api_op_DeletePipeline.go index 296e5d4fdbf..483eed200bc 100644 --- a/service/datapipeline/api_op_DeletePipeline.go +++ b/service/datapipeline/api_op_DeletePipeline.go @@ -12,16 +12,23 @@ import ( // Deletes a pipeline, its pipeline definition, and its run history. AWS Data // Pipeline attempts to cancel instances associated with the pipeline that are -// currently being processed by task runners. Deleting a pipeline cannot be undone. -// You cannot query or restore a deleted pipeline. To temporarily pause a pipeline -// instead of deleting it, call SetStatus with the status set to PAUSE on -// individual components. Components that are paused by SetStatus can be resumed. +// currently being processed by task runners. +// +// Deleting a pipeline cannot be undone. You cannot query or restore a deleted +// pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatuswith the +// status set to PAUSE on individual components. Components that are paused by SetStatus +// can be resumed. +// // POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: // DataPipeline.DeletePipeline Content-Length: 50 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE"} +// Authorization: AuthParams +// +// {"pipelineId": "df-06372391ZG65EXAMPLE"} +// // x-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9 Content-Type: // application/x-amz-json-1.1 Content-Length: 0 Date: Mon, 12 Nov 2012 17:50:53 GMT +// // Unexpected response: 200, OK, undefined func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error) { if params == nil { diff --git a/service/datapipeline/api_op_DescribeObjects.go b/service/datapipeline/api_op_DescribeObjects.go index 4b6f261b665..b05a31b2738 100644 --- a/service/datapipeline/api_op_DescribeObjects.go +++ b/service/datapipeline/api_op_DescribeObjects.go @@ -13,21 +13,28 @@ import ( // Gets the object definitions for a set of objects associated with the pipeline. // Object definitions are composed of a set of fields that define the properties of -// the object. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 -// X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: +// the object. +// +// POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: +// DataPipeline.DescribeObjects Content-Length: 98 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": -// ["Schedule"], "evaluateExpressions": true} x-amzn-RequestId: -// 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 -// Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 GMT {"hasMoreResults": -// false, "pipelineObjects": [ {"fields": [ {"key": "startDateTime", "stringValue": -// "2012-12-12T00:00:00"}, {"key": "parent", "refValue": "Default"}, {"key": -// "@sphere", "stringValue": "COMPONENT"}, {"key": "type", "stringValue": -// "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", -// "stringValue": "2012-12-21T18:00:00"}, {"key": "@version", "stringValue": "1"}, -// {"key": "@status", "stringValue": "PENDING"}, {"key": "@pipelineId", -// "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": "Schedule", "name": -// "Schedule"} ] } +// Authorization: AuthParams +// +// {"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": ["Schedule"], +// "evaluateExpressions": true} +// +// x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: +// application/x-amz-json-1.1 Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"hasMoreResults": false, "pipelineObjects": [ {"fields": [ {"key": +// "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", +// "refValue": "Default"}, {"key": "@sphere", "stringValue": "COMPONENT"}, {"key": +// "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, +// {"key": "endDateTime", "stringValue": "2012-12-21T18:00:00"}, {"key": +// "@version", "stringValue": "1"}, {"key": "@status", "stringValue": "PENDING"}, +// {"key": "@pipelineId", "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": +// "Schedule", "name": "Schedule"} ] } func (c *Client) DescribeObjects(ctx context.Context, params *DescribeObjectsInput, optFns ...func(*Options)) (*DescribeObjectsOutput, error) { if params == nil { params = &DescribeObjectsInput{} diff --git a/service/datapipeline/api_op_DescribePipelines.go b/service/datapipeline/api_op_DescribePipelines.go index c9dc5eb79b0..0fb6f033e2d 100644 --- a/service/datapipeline/api_op_DescribePipelines.go +++ b/service/datapipeline/api_op_DescribePipelines.go @@ -16,15 +16,23 @@ import ( // and the user account that owns the pipeline. Using account credentials, you can // 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 . +// pipelines for which you have read permissions. +// +// To retrieve the full pipeline 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 -// Authorization: AuthParams {"pipelineIds": ["df-08785951KAKJEXAMPLE"] } +// Authorization: AuthParams +// +// {"pipelineIds": ["df-08785951KAKJEXAMPLE"] } +// // x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9 Content-Type: // application/x-amz-json-1.1 Content-Length: 767 Date: Mon, 12 Nov 2012 17:50:53 -// GMT {"pipelineDescriptionList": [ {"description": "This is my first pipeline", +// GMT +// +// {"pipelineDescriptionList": [ {"description": "This is my first pipeline", // "fields": [ {"key": "@pipelineState", "stringValue": "SCHEDULED"}, {"key": // "description", "stringValue": "This is my first pipeline"}, {"key": "name", // "stringValue": "myPipeline"}, {"key": "@creationTime", "stringValue": @@ -53,7 +61,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_EvaluateExpression.go b/service/datapipeline/api_op_EvaluateExpression.go index 3faab16c665..6421ed413db 100644 --- a/service/datapipeline/api_op_EvaluateExpression.go +++ b/service/datapipeline/api_op_EvaluateExpression.go @@ -12,15 +12,22 @@ import ( // Task runners call EvaluateExpression to evaluate a string in the context of the // specified object. For example, a task runner can evaluate SQL queries stored in -// Amazon S3. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 -// X-Amz-Target: DataPipeline.DescribePipelines Content-Length: 164 Host: +// Amazon S3. +// +// POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: +// DataPipeline.DescribePipelines Content-Length: 164 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"pipelineId": "df-08785951KAKJEXAMPLE", "objectId": -// "Schedule", "expression": "Transform started at #{startDateTime} and finished at -// #{endDateTime}"} x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9 -// Content-Type: application/x-amz-json-1.1 Content-Length: 103 Date: Mon, 12 Nov -// 2012 17:50:53 GMT {"evaluatedExpression": "Transform started at -// 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"} +// Authorization: AuthParams +// +// {"pipelineId": "df-08785951KAKJEXAMPLE", "objectId": "Schedule", "expression": +// "Transform started at #{startDateTime} and finished at #{endDateTime}"} +// +// x-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9 Content-Type: +// application/x-amz-json-1.1 Content-Length: 103 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"evaluatedExpression": "Transform started at 2012-12-12T00:00:00 and finished +// at 2012-12-21T18:00:00"} func (c *Client) EvaluateExpression(ctx context.Context, params *EvaluateExpressionInput, optFns ...func(*Options)) (*EvaluateExpressionOutput, error) { if params == nil { params = &EvaluateExpressionInput{} diff --git a/service/datapipeline/api_op_GetPipelineDefinition.go b/service/datapipeline/api_op_GetPipelineDefinition.go index ce8b504d488..72f9707416f 100644 --- a/service/datapipeline/api_op_GetPipelineDefinition.go +++ b/service/datapipeline/api_op_GetPipelineDefinition.go @@ -13,21 +13,28 @@ 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: -// 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": -// "df-06372391ZG65EXAMPLE"} x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef -// Content-Type: application/x-amz-json-1.1 Content-Length: 890 Date: Mon, 12 Nov -// 2012 17:50:53 GMT {"pipelineObjects": [ {"fields": [ {"key": "workerGroup", -// "stringValue": "workerGroup"} ], "id": "Default", "name": "Default"}, {"fields": -// [ {"key": "startDateTime", "stringValue": "2012-09-25T17:00:00"}, {"key": -// "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, -// {"key": "endDateTime", "stringValue": "2012-09-25T18:00:00"} ], "id": -// "Schedule", "name": "Schedule"}, {"fields": [ {"key": "schedule", "refValue": -// "Schedule"}, {"key": "command", "stringValue": "echo hello"}, {"key": "parent", -// "refValue": "Default"}, {"key": "type", "stringValue": "ShellCommandActivity"} -// ], "id": "SayHello", "name": "SayHello"} ] } +// 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": "df-06372391ZG65EXAMPLE"} +// +// x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef Content-Type: +// application/x-amz-json-1.1 Content-Length: 890 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"pipelineObjects": [ {"fields": [ {"key": "workerGroup", "stringValue": +// "workerGroup"} ], "id": "Default", "name": "Default"}, {"fields": [ {"key": +// "startDateTime", "stringValue": "2012-09-25T17:00:00"}, {"key": "type", +// "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": +// "endDateTime", "stringValue": "2012-09-25T18:00:00"} ], "id": "Schedule", +// "name": "Schedule"}, {"fields": [ {"key": "schedule", "refValue": "Schedule"}, +// {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": +// "Default"}, {"key": "type", "stringValue": "ShellCommandActivity"} ], "id": +// "SayHello", "name": "SayHello"} ] } func (c *Client) GetPipelineDefinition(ctx context.Context, params *GetPipelineDefinitionInput, optFns ...func(*Options)) (*GetPipelineDefinitionOutput, error) { if params == nil { params = &GetPipelineDefinitionInput{} diff --git a/service/datapipeline/api_op_ListPipelines.go b/service/datapipeline/api_op_ListPipelines.go index a3afa6866df..1a462c22b6b 100644 --- a/service/datapipeline/api_op_ListPipelines.go +++ b/service/datapipeline/api_op_ListPipelines.go @@ -12,14 +12,21 @@ import ( ) // 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: +// 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: -// b3104dc5-0734-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 39 Date: Mon, 12 Nov 2012 17:50:53 GMT {"PipelineIdList": [ -// {"id": "df-08785951KAKJEXAMPLE", "name": "MyPipeline"}, {"id": -// "df-08662578ISYEXAMPLE", "name": "MySecondPipeline"} ] } +// Authorization: AuthParams +// +// {} +// +// Status: x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9 Content-Type: +// application/x-amz-json-1.1 Content-Length: 39 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"PipelineIdList": [ {"id": "df-08785951KAKJEXAMPLE", "name": "MyPipeline"}, +// {"id": "df-08662578ISYEXAMPLE", "name": "MySecondPipeline"} ] } func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error) { if params == nil { params = &ListPipelinesInput{} @@ -51,8 +58,7 @@ type ListPipelinesInput struct { type ListPipelinesOutput struct { // The pipeline identifiers. If you require additional information about the - // pipelines, you can use these identifiers to call DescribePipelines and - // GetPipelineDefinition . + // pipelines, you can use these identifiers to call DescribePipelinesand 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 b69ffbb30cc..9881dd48577 100644 --- a/service/datapipeline/api_op_PollForTask.go +++ b/service/datapipeline/api_op_PollForTask.go @@ -16,21 +16,28 @@ import ( // 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 -// 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: -// 41c713d2-0775-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 39 Date: Mon, 12 Nov 2012 17:50:53 GMT {"taskObject": -// {"attemptId": "@SayHello_2012-12-12T00:00:00_Attempt=1", "objects": -// {"@SayHello_2012-12-12T00:00:00_Attempt=1": {"fields": [ {"key": +// 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: 41c713d2-0775-11e2-af6f-6bc7a6be60d9 Content-Type: +// application/x-amz-json-1.1 Content-Length: 39 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"taskObject": {"attemptId": "@SayHello_2012-12-12T00:00:00_Attempt=1", +// "objects": {"@SayHello_2012-12-12T00:00:00_Attempt=1": {"fields": [ {"key": // "@componentParent", "refValue": "SayHello"}, {"key": "@scheduledStartTime", // "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", "refValue": // "SayHello"}, {"key": "@sphere", "stringValue": "ATTEMPT"}, {"key": @@ -80,11 +87,12 @@ 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] // 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. + // + // [Instance Metadata]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html InstanceIdentity *types.InstanceIdentity noSmithyDocumentSerde @@ -96,7 +104,7 @@ 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 // identifier for the task being assigned. The calling task runner uses taskId in - // subsequent calls to ReportTaskProgress and SetTaskStatus . + // subsequent calls to ReportTaskProgressand 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 09dcac0b9c0..6f14d7b09be 100644 --- a/service/datapipeline/api_op_PutPipelineDefinition.go +++ b/service/datapipeline/api_op_PutPipelineDefinition.go @@ -12,52 +12,70 @@ import ( ) // Adds tasks, schedules, and preconditions to the specified pipeline. You can use -// PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also -// 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. +// PutPipelineDefinition to populate a new pipeline. +// +// PutPipelineDefinition also 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. // // 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": -// "df-0937003356ZJEXAMPLE", "pipelineObjects": [ {"id": "Default", "name": -// "Default", "fields": [ {"key": "workerGroup", "stringValue": "workerGroup"} ] }, +// returned by the GetPipelineDefinitionaction. +// +// 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": "df-0937003356ZJEXAMPLE", "pipelineObjects": [ {"id": "Default", +// "name": "Default", "fields": [ {"key": "workerGroup", "stringValue": +// "workerGroup"} ] }, {"id": "Schedule", "name": "Schedule", "fields": [ {"key": +// "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "type", +// "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": +// "endDateTime", "stringValue": "2012-12-21T18:00:00"} ] }, {"id": "SayHello", +// "name": "SayHello", "fields": [ {"key": "type", "stringValue": +// "ShellCommandActivity"}, {"key": "command", "stringValue": "echo hello"}, +// {"key": "parent", "refValue": "Default"}, {"key": "schedule", "refValue": +// "Schedule"} ] } ] } +// +// HTTP/1.1 200 x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 +// Content-Type: application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov +// 2012 17:50:53 GMT +// +// {"errored": false} +// +// Example 2 This example sets an invalid pipeline configuration (the value for +// workerGroup is an empty string) and returns an error message. +// +// POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: +// DataPipeline.PutPipelineDefinition Content-Length: 903 Host: +// datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT +// Authorization: AuthParams +// +// {"pipelineId": "df-06372391ZG65EXAMPLE", "pipelineObjects": [ {"id": "Default", +// "name": "Default", "fields": [ {"key": "workerGroup", "stringValue": ""} ] }, // {"id": "Schedule", "name": "Schedule", "fields": [ {"key": "startDateTime", -// "stringValue": "2012-12-12T00:00:00"}, {"key": "type", "stringValue": +// "stringValue": "2012-09-25T17:00:00"}, {"key": "type", "stringValue": // "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", -// "stringValue": "2012-12-21T18:00:00"} ] }, {"id": "SayHello", "name": +// "stringValue": "2012-09-25T18:00:00"} ] }, {"id": "SayHello", "name": // "SayHello", "fields": [ {"key": "type", "stringValue": "ShellCommandActivity"}, // {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": -// "Default"}, {"key": "schedule", "refValue": "Schedule"} ] } ] } HTTP/1.1 200 -// x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 Content-Type: -// application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 -// GMT {"errored": false} Example 2 This example sets an invalid pipeline -// configuration (the value for workerGroup is an empty string) and returns an -// error message. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 -// X-Amz-Target: DataPipeline.PutPipelineDefinition Content-Length: 903 Host: -// datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", -// "pipelineObjects": [ {"id": "Default", "name": "Default", "fields": [ {"key": -// "workerGroup", "stringValue": ""} ] }, {"id": "Schedule", "name": "Schedule", -// "fields": [ {"key": "startDateTime", "stringValue": "2012-09-25T17:00:00"}, -// {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 -// hour"}, {"key": "endDateTime", "stringValue": "2012-09-25T18:00:00"} ] }, {"id": -// "SayHello", "name": "SayHello", "fields": [ {"key": "type", "stringValue": -// "ShellCommandActivity"}, {"key": "command", "stringValue": "echo hello"}, -// {"key": "parent", "refValue": "Default"}, {"key": "schedule", "refValue": -// "Schedule"} ] } ] } HTTP/1.1 200 x-amzn-RequestId: -// f74afc14-0754-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 GMT {"__type": -// "com.amazon.setl.webservice#InvalidRequestException", "message": "Pipeline -// definition has errors: Could not save the pipeline definition due to FATAL -// errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call +// "Default"}, {"key": "schedule", "refValue": "Schedule"} +// +// ] } ] } +// +// HTTP/1.1 200 x-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9 +// Content-Type: application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov +// 2012 17:50:53 GMT +// +// {"__type": "com.amazon.setl.webservice#InvalidRequestException", "message": +// "Pipeline definition has errors: Could not save the pipeline definition due to +// FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call // Validate to validate your pipeline"} func (c *Client) PutPipelineDefinition(ctx context.Context, params *PutPipelineDefinitionInput, optFns ...func(*Options)) (*PutPipelineDefinitionOutput, error) { if params == nil { diff --git a/service/datapipeline/api_op_QueryObjects.go b/service/datapipeline/api_op_QueryObjects.go index a2f46089d95..42b38133e4e 100644 --- a/service/datapipeline/api_op_QueryObjects.go +++ b/service/datapipeline/api_op_QueryObjects.go @@ -12,15 +12,21 @@ import ( ) // 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"] } +// 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{} diff --git a/service/datapipeline/api_op_ReportTaskProgress.go b/service/datapipeline/api_op_ReportTaskProgress.go index 91fb5a17d1a..b1bf24ff2e6 100644 --- a/service/datapipeline/api_op_ReportTaskProgress.go +++ b/service/datapipeline/api_op_ReportTaskProgress.go @@ -13,22 +13,30 @@ import ( // 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 -// 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, -// 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"taskId": +// 2 minutes, it assigns the task in a subsequent PollForTaskcall. 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 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, 12 Nov 2012 17:49:52 GMT +// Authorization: AuthParams +// +// {"taskId": // "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE", // "fields": [ {"key": "percentComplete", "stringValue": "50"} ] } +// // x-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9 Content-Type: // application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 -// GMT {"canceled": false} +// GMT +// +// {"canceled": false} func (c *Client) ReportTaskProgress(ctx context.Context, params *ReportTaskProgressInput, optFns ...func(*Options)) (*ReportTaskProgressOutput, error) { if params == nil { params = &ReportTaskProgressInput{} @@ -48,7 +56,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 @@ -64,7 +72,7 @@ type ReportTaskProgressInput struct { type ReportTaskProgressOutput struct { // If true, the calling task runner should cancel processing of the task. The task - // runner does not need to call SetTaskStatus for canceled tasks. + // runner does not need to call SetTaskStatusfor canceled tasks. // // This member is required. Canceled bool diff --git a/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go b/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go index 0c94bdac77b..c70fc76e623 100644 --- a/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go +++ b/service/datapipeline/api_op_ReportTaskRunnerHeartbeat.go @@ -14,13 +14,20 @@ import ( // they are operational. If the AWS Data Pipeline Task Runner is launched on a // resource managed by AWS Data Pipeline, the web service can use this call to // detect when the task runner application has failed and restart a new instance. +// // POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: // DataPipeline.ReportTaskRunnerHeartbeat Content-Length: 84 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"taskrunnerId": "1234567890", "workerGroup": -// "wg-12345", "hostname": "example.com"} Status: x-amzn-RequestId: -// b3104dc5-0734-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 20 Date: Mon, 12 Nov 2012 17:50:53 GMT {"terminate": false} +// Authorization: AuthParams +// +// {"taskrunnerId": "1234567890", "workerGroup": "wg-12345", "hostname": +// "example.com"} +// +// Status: x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9 Content-Type: +// application/x-amz-json-1.1 Content-Length: 20 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"terminate": false} func (c *Client) ReportTaskRunnerHeartbeat(ctx context.Context, params *ReportTaskRunnerHeartbeatInput, optFns ...func(*Options)) (*ReportTaskRunnerHeartbeatOutput, error) { if params == nil { params = &ReportTaskRunnerHeartbeatInput{} diff --git a/service/datapipeline/api_op_SetStatus.go b/service/datapipeline/api_op_SetStatus.go index adf8fd667ce..f8381f7425b 100644 --- a/service/datapipeline/api_op_SetStatus.go +++ b/service/datapipeline/api_op_SetStatus.go @@ -15,14 +15,19 @@ import ( // 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: // 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": -// ["o-08600941GHJWMBR9E2"], "status": "pause"} x-amzn-RequestId: -// e83b8ab7-076a-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 -// Content-Length: 0 Date: Mon, 12 Nov 2012 17:50:53 GMT Unexpected response: 200, -// OK, undefined +// Authorization: AuthParams +// +// {"pipelineId": "df-0634701J7KEXAMPLE", "objectIds": ["o-08600941GHJWMBR9E2"], +// "status": "pause"} +// +// x-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9 Content-Type: +// application/x-amz-json-1.1 Content-Length: 0 Date: Mon, 12 Nov 2012 17:50:53 GMT +// +// Unexpected response: 200, OK, undefined func (c *Client) SetStatus(ctx context.Context, params *SetStatusInput, optFns ...func(*Options)) (*SetStatusOutput, error) { if params == nil { params = &SetStatusInput{} diff --git a/service/datapipeline/api_op_SetTaskStatus.go b/service/datapipeline/api_op_SetTaskStatus.go index 8e16025994d..583428dcb56 100644 --- a/service/datapipeline/api_op_SetTaskStatus.go +++ b/service/datapipeline/api_op_SetTaskStatus.go @@ -15,14 +15,21 @@ import ( // 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: -// 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": +// 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": // "aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE", -// "taskStatus": "FINISHED"} x-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 -// Content-Type: application/x-amz-json-1.1 Content-Length: 0 Date: Mon, 12 Nov -// 2012 17:50:53 GMT {} +// "taskStatus": "FINISHED"} +// +// x-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 Content-Type: +// application/x-amz-json-1.1 Content-Length: 0 Date: Mon, 12 Nov 2012 17:50:53 GMT +// +// {} func (c *Client) SetTaskStatus(ctx context.Context, params *SetTaskStatusInput, optFns ...func(*Options)) (*SetTaskStatusOutput, error) { if params == nil { params = &SetTaskStatusInput{} @@ -42,7 +49,7 @@ 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 diff --git a/service/datapipeline/api_op_ValidatePipelineDefinition.go b/service/datapipeline/api_op_ValidatePipelineDefinition.go index 2486e5291e7..2d5aa046e19 100644 --- a/service/datapipeline/api_op_ValidatePipelineDefinition.go +++ b/service/datapipeline/api_op_ValidatePipelineDefinition.go @@ -12,41 +12,61 @@ import ( ) // 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, -// 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": -// "df-06372391ZG65EXAMPLE", "pipelineObjects": [ {"id": "Default", "name": -// "Default", "fields": [ {"key": "workerGroup", "stringValue": "MyworkerGroup"} ] -// }, {"id": "Schedule", "name": "Schedule", "fields": [ {"key": "startDateTime", -// "stringValue": "2012-09-25T17:00:00"}, {"key": "type", "stringValue": -// "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", -// "stringValue": "2012-09-25T18:00:00"} ] }, {"id": "SayHello", "name": -// "SayHello", "fields": [ {"key": "type", "stringValue": "ShellCommandActivity"}, -// {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": -// "Default"}, {"key": "schedule", "refValue": "Schedule"} ] } ] } +// 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, 12 Nov 2012 17:49:52 GMT +// Authorization: AuthParams +// +// {"pipelineId": "df-06372391ZG65EXAMPLE", "pipelineObjects": [ {"id": "Default", +// "name": "Default", "fields": [ {"key": "workerGroup", "stringValue": +// "MyworkerGroup"} ] }, {"id": "Schedule", "name": "Schedule", "fields": [ {"key": +// "startDateTime", "stringValue": "2012-09-25T17:00:00"}, {"key": "type", +// "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": +// "endDateTime", "stringValue": "2012-09-25T18:00:00"} ] }, {"id": "SayHello", +// "name": "SayHello", "fields": [ {"key": "type", "stringValue": +// "ShellCommandActivity"}, {"key": "command", "stringValue": "echo hello"}, +// {"key": "parent", "refValue": "Default"}, {"key": "schedule", "refValue": +// "Schedule"} +// +// ] } ] } +// // x-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef Content-Type: // application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 -// GMT {"errored": false} Example 2 This example sets an invalid pipeline -// configuration and returns the associated set of validation errors. POST / -// HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: +// GMT +// +// {"errored": false} +// +// Example 2 This example sets an invalid pipeline configuration and returns the +// associated set of validation errors. +// +// POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: // DataPipeline.ValidatePipelineDefinition Content-Length: 903 Host: // datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT -// Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", -// "pipelineObjects": [ {"id": "Default", "name": "Default", "fields": [ {"key": -// "workerGroup", "stringValue": "MyworkerGroup"} ] }, {"id": "Schedule", "name": -// "Schedule", "fields": [ {"key": "startDateTime", "stringValue": "bad-time"}, -// {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 -// hour"}, {"key": "endDateTime", "stringValue": "2012-09-25T18:00:00"} ] }, {"id": -// "SayHello", "name": "SayHello", "fields": [ {"key": "type", "stringValue": -// "ShellCommandActivity"}, {"key": "command", "stringValue": "echo hello"}, -// {"key": "parent", "refValue": "Default"}, {"key": "schedule", "refValue": -// "Schedule"} ] } ] } x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd -// Content-Type: application/x-amz-json-1.1 Content-Length: 278 Date: Mon, 12 Nov -// 2012 17:50:53 GMT {"errored": true, "validationErrors": [ {"errors": -// ["INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime -// value."], "id": "Schedule"} ] } +// Authorization: AuthParams +// +// {"pipelineId": "df-06372391ZG65EXAMPLE", "pipelineObjects": [ {"id": "Default", +// "name": "Default", "fields": [ {"key": "workerGroup", "stringValue": +// "MyworkerGroup"} ] }, {"id": "Schedule", "name": "Schedule", "fields": [ {"key": +// "startDateTime", "stringValue": "bad-time"}, {"key": "type", "stringValue": +// "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", +// "stringValue": "2012-09-25T18:00:00"} ] }, {"id": "SayHello", "name": +// "SayHello", "fields": [ {"key": "type", "stringValue": "ShellCommandActivity"}, +// {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": +// "Default"}, {"key": "schedule", "refValue": "Schedule"} +// +// ] } ] } +// +// x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd Content-Type: +// application/x-amz-json-1.1 Content-Length: 278 Date: Mon, 12 Nov 2012 17:50:53 +// GMT +// +// {"errored": true, "validationErrors": [ {"errors": ["INVALID_FIELD_VALUE: +// 'startDateTime' value must be a literal datetime value."], "id": "Schedule"} ] } func (c *Client) ValidatePipelineDefinition(ctx context.Context, params *ValidatePipelineDefinitionInput, optFns ...func(*Options)) (*ValidatePipelineDefinitionOutput, error) { if params == nil { params = &ValidatePipelineDefinitionInput{} diff --git a/service/datapipeline/doc.go b/service/datapipeline/doc.go index 040041085fb..d03211f2c8c 100644 --- a/service/datapipeline/doc.go +++ b/service/datapipeline/doc.go @@ -6,19 +6,22 @@ // AWS Data Pipeline configures and manages a data-driven workflow called a // pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that // data dependencies are met so that your application can focus on processing the -// data. AWS Data Pipeline provides a JAR implementation of a task runner called -// AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for +// data. +// +// AWS Data Pipeline provides a JAR implementation of a task runner called AWS +// Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for // common data management scenarios, such as performing database queries and // running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use // AWS Data Pipeline Task Runner as your task runner, or you can write your own -// task runner to provide custom data management. AWS Data Pipeline implements two -// main sets of functionality. Use the first set to create a pipeline and define -// data sources, schedules, dependencies, and the transforms to be performed on the -// data. Use the second set in your task runner application to receive the next -// task ready for processing. The logic for performing the task, such as querying -// the data, running data analysis, or converting the data from one format to -// another, is contained within the task runner. The task runner performs the task -// assigned to it by the web service, reporting progress to the web service as it -// does so. When the task is done, the task runner reports the final success or -// failure of the task to the web service. +// task runner to provide custom data management. +// +// AWS Data Pipeline implements two main sets of functionality. Use the first set +// to create a pipeline and define data sources, schedules, dependencies, and the +// transforms to be performed on the data. Use the second set in your task runner +// application to receive the next task ready for processing. The logic for +// performing the task, such as querying the data, running data analysis, or +// converting the data from one format to another, is contained within the task +// runner. The task runner performs the task assigned to it by the web service, +// reporting progress to the web service as it does so. When the task is done, the +// task runner reports the final success or failure of the task to the web service. package datapipeline diff --git a/service/datapipeline/options.go b/service/datapipeline/options.go index 74ee6db58a9..c290b704517 100644 --- a/service/datapipeline/options.go +++ b/service/datapipeline/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/datapipeline/types/enums.go b/service/datapipeline/types/enums.go index f3546d390ca..bf81bb802e7 100644 --- a/service/datapipeline/types/enums.go +++ b/service/datapipeline/types/enums.go @@ -14,8 +14,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for TaskStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatus) Values() []TaskStatus { return []TaskStatus{ "FINISHED", diff --git a/service/datapipeline/types/types.go b/service/datapipeline/types/types.go index 3749b797c4f..003cbbcc756 100644 --- a/service/datapipeline/types/types.go +++ b/service/datapipeline/types/types.go @@ -27,10 +27,12 @@ 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) -// 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. +// information, see [Instance Metadata]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. +// +// [Instance Metadata]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html type InstanceIdentity struct { // A description of an EC2 instance that is generated when the instance is @@ -49,12 +51,14 @@ type InstanceIdentity struct { // 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 + // 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: + // 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 @@ -65,7 +69,9 @@ type Operator struct { // - @scheduledEndTime // - @actualStartTime // - @actualEndTime + // // The comparison operators GE , LE , and BETWEEN act on the following fields: + // // - @scheduledStartTime // - @scheduledEndTime // - @actualStartTime @@ -155,8 +161,9 @@ 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) - // in the AWS Data Pipeline Developer Guide. + // pipelines. For more information, see [Controlling User Access to Pipelines]in the AWS Data Pipeline Developer Guide. + // + // [Controlling User Access to Pipelines]: http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html Tags []Tag noSmithyDocumentSerde @@ -227,20 +234,23 @@ 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) -// in the AWS Data Pipeline Developer Guide. +// For more information, see [Controlling User Access to Pipelines]in the AWS Data Pipeline Developer Guide. +// +// [Controlling User Access to Pipelines]: http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html 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) - // in the AWS Data Pipeline Developer Guide. + // The key name of a tag defined by a user. For more information, see [Controlling User Access to Pipelines] in the AWS + // Data Pipeline Developer Guide. + // + // [Controlling User Access to Pipelines]: http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html // // 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) - // in the AWS Data Pipeline Developer Guide. + // see [Controlling User Access to Pipelines]in the AWS Data Pipeline Developer Guide. + // + // [Controlling User Access to Pipelines]: http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html // // This member is required. Value *string @@ -262,8 +272,7 @@ type TaskObject struct { // The ID of the pipeline that provided the task. PipelineId *string - // An internal identifier for the task. This ID is passed to the SetTaskStatus and - // ReportTaskProgress actions. + // An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions. TaskId *string noSmithyDocumentSerde diff --git a/service/datasync/api_op_AddStorageSystem.go b/service/datasync/api_op_AddStorageSystem.go index 7ab3f27bd60..80cdf07cf06 100644 --- a/service/datasync/api_op_AddStorageSystem.go +++ b/service/datasync/api_op_AddStorageSystem.go @@ -57,9 +57,10 @@ type AddStorageSystemInput struct { ServerConfiguration *types.DiscoveryServerConfiguration // Specifies the type of on-premises storage system that you want DataSync - // Discovery to collect information about. DataSync Discovery currently supports - // NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running - // ONTAP 9.7 or later. + // Discovery to collect information about. + // + // DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and + // All Flash FAS (AFF) systems running ONTAP 9.7 or later. // // This member is required. SystemType types.DiscoverySystemType diff --git a/service/datasync/api_op_CancelTaskExecution.go b/service/datasync/api_op_CancelTaskExecution.go index e4aa22dc795..d9e746099f1 100644 --- a/service/datasync/api_op_CancelTaskExecution.go +++ b/service/datasync/api_op_CancelTaskExecution.go @@ -12,12 +12,13 @@ import ( // Stops an DataSync task execution that's in progress. The transfer of some files // are abruptly interrupted. File contents that're transferred to the destination -// might be incomplete or inconsistent with the source files. However, if you start -// a new task execution using the same task and allow it to finish, file content on -// the destination will be complete and consistent. This applies to other -// unexpected failures that interrupt a task execution. In all of these cases, -// DataSync successfully completes the transfer when you start the next task -// execution. +// might be incomplete or inconsistent with the source files. +// +// However, if you start a new task execution using the same task and allow it to +// finish, file content on the destination will be complete and consistent. This +// applies to other unexpected failures that interrupt a task execution. In all of +// these cases, DataSync successfully completes the transfer when you start the +// next task execution. func (c *Client) CancelTaskExecution(ctx context.Context, params *CancelTaskExecutionInput, optFns ...func(*Options)) (*CancelTaskExecutionOutput, error) { if params == nil { params = &CancelTaskExecutionInput{} diff --git a/service/datasync/api_op_CreateAgent.go b/service/datasync/api_op_CreateAgent.go index 1f733fd3014..a0620de38f5 100644 --- a/service/datasync/api_op_CreateAgent.go +++ b/service/datasync/api_op_CreateAgent.go @@ -13,13 +13,19 @@ import ( // Activates an DataSync agent that you've deployed in your storage environment. // The activation process associates the agent with your Amazon Web Services -// account. If you haven't deployed an agent yet, see the following topics to learn -// more: -// - Agent requirements (https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html) -// - Create an agent (https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html) +// account. +// +// If you haven't deployed an agent yet, see the following topics to learn more: +// +// [Agent requirements] +// +// [Create an agent] // // If you're transferring between Amazon Web Services storage services, you don't // need a DataSync agent. +// +// [Agent requirements]: https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html +// [Create an agent]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error) { if params == nil { params = &CreateAgentInput{} @@ -39,8 +45,9 @@ func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optF type CreateAgentInput struct { // Specifies your DataSync agent's activation key. If you don't have an activation - // key, see Activate your agent (https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) - // . + // key, see [Activate your agent]. + // + // [Activate your agent]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html // // This member is required. ActivationKey *string @@ -49,15 +56,17 @@ type CreateAgentInput struct { AgentName *string // Specifies the Amazon Resource Name (ARN) of the security group that protects - // your task's network interfaces (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) - // when using a virtual private cloud (VPC) endpoint (https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc) - // . You can only specify one ARN. + // your task's [network interfaces]when [using a virtual private cloud (VPC) endpoint]. You can only specify one ARN. + // + // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces + // [using a virtual private cloud (VPC) endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc SecurityGroupArns []string // Specifies the ARN of the subnet where you want to run your DataSync task when - // using a VPC endpoint. This is the subnet where DataSync creates and manages the - // network interfaces (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) + // using a VPC endpoint. This is the subnet where DataSync creates and manages the [network interfaces] // for your transfer. You can only specify one ARN. + // + // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces SubnetArns []string // Specifies labels that help you categorize, filter, and search for your Amazon @@ -65,8 +74,9 @@ type CreateAgentInput struct { Tags []types.TagListEntry // Specifies the ID of the VPC endpoint that you want your agent to connect to. - // For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1 . The VPC - // endpoint you use must include the DataSync service name (for example, + // For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1 . + // + // The VPC endpoint you use must include the DataSync service name (for example, // com.amazonaws.us-east-2.datasync ). VpcEndpointId *string @@ -76,9 +86,11 @@ type CreateAgentInput struct { // CreateAgentResponse type CreateAgentOutput struct { - // The ARN of the agent that you just activated. Use the ListAgents (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) - // operation to return a list of agents in your Amazon Web Services account and - // Amazon Web Services Region. + // The ARN of the agent that you just activated. Use the [ListAgents] operation to return a + // list of agents in your Amazon Web Services account and Amazon Web Services + // Region. + // + // [ListAgents]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html AgentArn *string // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_CreateLocationAzureBlob.go b/service/datasync/api_op_CreateLocationAzureBlob.go index 8da708e470d..3063eed2944 100644 --- a/service/datasync/api_op_CreateLocationAzureBlob.go +++ b/service/datasync/api_op_CreateLocationAzureBlob.go @@ -12,12 +12,15 @@ import ( ) // Creates a transfer location for a Microsoft Azure Blob Storage container. -// DataSync can use this location as a transfer source or destination. Before you -// begin, make sure you know how DataSync accesses Azure Blob Storage (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access) -// and works with access tiers (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) -// and blob types (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types) -// . You also need a DataSync agent (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent) +// DataSync can use this location as a transfer source or destination. +// +// Before you begin, make sure you know [how DataSync accesses Azure Blob Storage] and works with [access tiers] and [blob types]. You also need a [DataSync agent] // that can connect to your container. +// +// [DataSync agent]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent +// [blob types]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types +// [how DataSync accesses Azure Blob Storage]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access +// [access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers func (c *Client) CreateLocationAzureBlob(ctx context.Context, params *CreateLocationAzureBlobInput, optFns ...func(*Options)) (*CreateLocationAzureBlobOutput, error) { if params == nil { params = &CreateLocationAzureBlobInput{} @@ -36,9 +39,11 @@ func (c *Client) CreateLocationAzureBlob(ctx context.Context, params *CreateLoca type CreateLocationAzureBlobInput struct { // Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect - // with your Azure Blob Storage container. You can specify more than one agent. For - // more information, see Using multiple agents for your transfer (https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html) - // . + // with your Azure Blob Storage container. + // + // You can specify more than one agent. For more information, see [Using multiple agents for your transfer]. + // + // [Using multiple agents for your transfer]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html // // This member is required. AgentArns []string @@ -56,15 +61,17 @@ type CreateLocationAzureBlobInput struct { // Specifies the access tier that you want your objects or files transferred into. // This only applies when using the location as a transfer destination. For more - // information, see Access tiers (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) - // . + // information, see [Access tiers]. + // + // [Access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers AccessTier types.AzureAccessTier // Specifies the type of blob that you want your objects or files to be when // transferring them into Azure Blob Storage. Currently, DataSync only supports // moving data into Azure Blob Storage as block blobs. For more information on blob - // types, see the Azure Blob Storage documentation (https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs) - // . + // types, see the [Azure Blob Storage documentation]. + // + // [Azure Blob Storage documentation]: https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs BlobType types.AzureBlobType // Specifies the SAS configuration that allows DataSync to access your Azure Blob diff --git a/service/datasync/api_op_CreateLocationEfs.go b/service/datasync/api_op_CreateLocationEfs.go index f5ca41c508d..296bb03dcc0 100644 --- a/service/datasync/api_op_CreateLocationEfs.go +++ b/service/datasync/api_op_CreateLocationEfs.go @@ -12,10 +12,11 @@ import ( ) // Creates a transfer location for an Amazon EFS file system. DataSync can use -// this location as a source or destination for transferring data. Before you -// begin, make sure that you understand how DataSync accesses Amazon EFS file -// systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access) -// . +// this location as a source or destination for transferring data. +// +// Before you begin, make sure that you understand how DataSync [accesses Amazon EFS file systems]. +// +// [accesses Amazon EFS file systems]: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error) { if params == nil { params = &CreateLocationEfsInput{} @@ -54,16 +55,18 @@ type CreateLocationEfsInput struct { FileSystemAccessRoleArn *string // 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 + // 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 . 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 ). + // subdirectories. + // + // You must specify a value with forward slashes (for example, /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 df90e0a244e..979c527514e 100644 --- a/service/datasync/api_op_CreateLocationFsxLustre.go +++ b/service/datasync/api_op_CreateLocationFsxLustre.go @@ -12,10 +12,11 @@ import ( ) // Creates a transfer location for an Amazon FSx for Lustre file system. DataSync -// can use this location as a source or destination for transferring data. Before -// you begin, make sure that you understand how DataSync accesses FSx for Lustre -// file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access) -// . +// can use this location as a source or destination for transferring data. +// +// Before you begin, make sure that you understand how DataSync [accesses FSx for Lustre file systems]. +// +// [accesses FSx for Lustre file systems]: https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access func (c *Client) CreateLocationFsxLustre(ctx context.Context, params *CreateLocationFsxLustreInput, optFns ...func(*Options)) (*CreateLocationFsxLustreOutput, error) { if params == nil { params = &CreateLocationFsxLustreInput{} diff --git a/service/datasync/api_op_CreateLocationFsxOntap.go b/service/datasync/api_op_CreateLocationFsxOntap.go index 51b2d8d1b31..04bec9afb8b 100644 --- a/service/datasync/api_op_CreateLocationFsxOntap.go +++ b/service/datasync/api_op_CreateLocationFsxOntap.go @@ -13,9 +13,10 @@ import ( // Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. // DataSync can use this location as a source or destination for transferring data. -// Before you begin, make sure that you understand how DataSync accesses FSx for -// ONTAP file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access) -// . +// +// Before you begin, make sure that you understand how DataSync [accesses FSx for ONTAP file systems]. +// +// [accesses FSx for ONTAP file systems]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access func (c *Client) CreateLocationFsxOntap(ctx context.Context, params *CreateLocationFsxOntapInput, optFns ...func(*Options)) (*CreateLocationFsxOntapOutput, error) { if params == nil { params = &CreateLocationFsxOntapInput{} @@ -40,10 +41,15 @@ type CreateLocationFsxOntapInput struct { Protocol *types.FsxProtocol // 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): + // 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. // @@ -56,13 +62,16 @@ type CreateLocationFsxOntapInput struct { // This member is required. StorageVirtualMachineArn *string - // 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 - // 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. + // 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 SVM's root volume. For more information, + // see [Managing FSx for ONTAP storage virtual machines]in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Managing FSx for ONTAP storage virtual machines]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html 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 70b845e1761..9a9ed7e87b6 100644 --- a/service/datasync/api_op_CreateLocationFsxOpenZfs.go +++ b/service/datasync/api_op_CreateLocationFsxOpenZfs.go @@ -12,11 +12,14 @@ import ( ) // Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync -// can use this location as a source or destination for transferring data. Before -// you begin, make sure that you understand how DataSync accesses FSx for OpenZFS -// file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access) -// . Request parameters related to SMB aren't supported with the +// can use this location as a source or destination for transferring data. +// +// Before you begin, make sure that you understand how DataSync [accesses FSx for OpenZFS file systems]. +// +// Request parameters related to SMB aren't supported with the // CreateLocationFsxOpenZfs operation. +// +// [accesses FSx for OpenZFS file systems]: https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access func (c *Client) CreateLocationFsxOpenZfs(ctx context.Context, params *CreateLocationFsxOpenZfsInput, optFns ...func(*Options)) (*CreateLocationFsxOpenZfsOutput, error) { if params == nil { params = &CreateLocationFsxOpenZfsInput{} diff --git a/service/datasync/api_op_CreateLocationFsxWindows.go b/service/datasync/api_op_CreateLocationFsxWindows.go index 23485067066..939f6cba7b7 100644 --- a/service/datasync/api_op_CreateLocationFsxWindows.go +++ b/service/datasync/api_op_CreateLocationFsxWindows.go @@ -13,9 +13,11 @@ import ( // Creates a transfer location for an Amazon FSx for Windows File Server file // system. DataSync can use this location as a source or destination for -// transferring data. Before you begin, make sure that you understand how DataSync -// accesses FSx for Windows File Server file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access) -// . +// transferring data. +// +// Before you begin, make sure that you understand how DataSync [accesses FSx for Windows File Server file systems]. +// +// [accesses FSx for Windows File Server file systems]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access func (c *Client) CreateLocationFsxWindows(ctx context.Context, params *CreateLocationFsxWindowsInput, optFns ...func(*Options)) (*CreateLocationFsxWindowsOutput, error) { if params == nil { params = &CreateLocationFsxWindowsInput{} @@ -47,9 +49,13 @@ type CreateLocationFsxWindowsInput struct { Password *string // 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: + // 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. // @@ -57,18 +63,21 @@ type CreateLocationFsxWindowsInput struct { SecurityGroupArns []string // Specifies the user with the permissions to mount and access the files, folders, - // and file metadata in your FSx for Windows File Server file system. 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-fsx-location.html#create-fsx-windows-location-permissions) - // for FSx for Windows File Server locations. + // and file metadata in your FSx for Windows File Server file system. + // + // For information about choosing a user with the right level of access for your + // transfer, see [required permissions]for FSx for Windows File Server locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions // // This member is required. User *string // Specifies the name of the Microsoft Active Directory domain that the FSx for - // Windows File Server file system belongs to. If you have multiple Active - // Directory domains in your environment, configuring this parameter makes sure - // that DataSync connects to the right file system. + // Windows File Server file system belongs to. + // + // If you have multiple Active Directory domains in your environment, configuring + // this parameter makes sure that DataSync connects to the right file system. Domain *string // Specifies a mount path for your file system using forward slashes. This is diff --git a/service/datasync/api_op_CreateLocationHdfs.go b/service/datasync/api_op_CreateLocationHdfs.go index bd5f8b2e39b..2d973f8619b 100644 --- a/service/datasync/api_op_CreateLocationHdfs.go +++ b/service/datasync/api_op_CreateLocationHdfs.go @@ -13,9 +13,10 @@ import ( // Creates a transfer location for a Hadoop Distributed File System (HDFS). // DataSync can use this location as a source or destination for transferring data. -// Before you begin, make sure that you understand how DataSync accesses HDFS -// clusters (https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs) -// . +// +// Before you begin, make sure that you understand how DataSync [accesses HDFS clusters]. +// +// [accesses HDFS clusters]: https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs func (c *Client) CreateLocationHdfs(ctx context.Context, params *CreateLocationHdfsInput, optFns ...func(*Options)) (*CreateLocationHdfsOutput, error) { if params == nil { params = &CreateLocationHdfsInput{} @@ -59,20 +60,23 @@ type CreateLocationHdfsInput struct { // 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. + // encoding for you. Otherwise, provide the base64-encoded text. + // + // If KERBEROS is 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 - // parameter is required. + // 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. + // cluster. + // + // If KERBEROS is specified for AuthenticationType , this parameter is required. KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). @@ -90,8 +94,9 @@ type CreateLocationHdfsInput struct { // cluster. By default, data is replicated to three DataNodes. 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. + // The user name used to identify the client on the host operating system. + // + // If 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 diff --git a/service/datasync/api_op_CreateLocationNfs.go b/service/datasync/api_op_CreateLocationNfs.go index 8e039e32c28..d6b691be61c 100644 --- a/service/datasync/api_op_CreateLocationNfs.go +++ b/service/datasync/api_op_CreateLocationNfs.go @@ -13,12 +13,14 @@ import ( // Creates a transfer location for a Network File System (NFS) file server. // DataSync can use this location as a source or destination for transferring data. -// Before you begin, make sure that you understand how DataSync accesses NFS file -// servers (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs) -// . If you're copying data to or from an Snowcone device, you can also use -// CreateLocationNfs to create your transfer location. For more information, see -// Configuring transfers with Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html) -// . +// +// Before you begin, make sure that you understand how DataSync [accesses NFS file servers]. +// +// If you're copying data to or from an Snowcone device, you can also use +// CreateLocationNfs to create your transfer location. For more information, see [Configuring transfers with Snowcone]. +// +// [Configuring transfers with Snowcone]: https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html +// [accesses NFS file servers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNfsInput, optFns ...func(*Options)) (*CreateLocationNfsOutput, error) { if params == nil { params = &CreateLocationNfsInput{} @@ -38,9 +40,11 @@ func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNf type CreateLocationNfsInput struct { // Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to - // connect to your NFS file server. You can specify more than one agent. For more - // information, see Using multiple agents for transfers (https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html) - // . + // connect to your NFS file server. + // + // You can specify more than one agent. For more information, see [Using multiple agents for transfers]. + // + // [Using multiple agents for transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html // // This member is required. OnPremConfig *types.OnPremConfig @@ -52,10 +56,12 @@ type CreateLocationNfsInput struct { ServerHostname *string // Specifies the export path in your NFS file server that you want DataSync to - // mount. This path (or a subdirectory of the path) is where DataSync transfers - // data to or from. For information on configuring an export for DataSync, see - // Accessing NFS file servers (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs) - // . + // mount. + // + // This path (or a subdirectory of the path) is where DataSync transfers data to + // or from. For information on configuring an export for DataSync, see [Accessing NFS file servers]. + // + // [Accessing NFS file servers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs // // This member is required. Subdirectory *string diff --git a/service/datasync/api_op_CreateLocationObjectStorage.go b/service/datasync/api_op_CreateLocationObjectStorage.go index 88e68b28cbf..e6cb6e4ece8 100644 --- a/service/datasync/api_op_CreateLocationObjectStorage.go +++ b/service/datasync/api_op_CreateLocationObjectStorage.go @@ -12,9 +12,12 @@ import ( ) // Creates a transfer location for an object storage system. DataSync can use this -// location as a source or destination for transferring data. Before you begin, -// make sure that you understand the prerequisites (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites) -// for DataSync to work with object storage systems. +// location as a source or destination for transferring data. +// +// Before you begin, make sure that you understand the [prerequisites] for DataSync to work with +// object storage systems. +// +// [prerequisites]: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, optFns ...func(*Options)) (*CreateLocationObjectStorageOutput, error) { if params == nil { params = &CreateLocationObjectStorageInput{} @@ -62,17 +65,24 @@ type CreateLocationObjectStorageInput struct { // Specifies a certificate chain for DataSync to authenticate with your object // storage system if the system uses a private or self-signed certificate authority // (CA). You must specify a single .pem file with a full certificate chain (for - // example, file:///home/user/.ssh/object_storage_certificates.pem ). The - // certificate chain might include: + // example, file:///home/user/.ssh/object_storage_certificates.pem ). + // + // The certificate chain might include: + // // - The object storage system's certificate + // // - All intermediate certificates (if there are any) + // // - The root certificate of the signing CA + // // You can concatenate your certificates into a .pem file (which can be up to // 32768 bytes before base64 encoding). The following example cat command creates - // an object_storage_certificates.pem file that includes three certificates: cat - // object_server_certificate.pem intermediate_certificate.pem - // ca_root_certificate.pem > object_storage_certificates.pem To use this parameter, - // configure ServerProtocol to HTTPS . + // an object_storage_certificates.pem file that includes three certificates: + // + // cat object_server_certificate.pem intermediate_certificate.pem + // ca_root_certificate.pem > object_storage_certificates.pem + // + // To use this parameter, configure 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 753898393d6..cec269785cc 100644 --- a/service/datasync/api_op_CreateLocationS3.go +++ b/service/datasync/api_op_CreateLocationS3.go @@ -12,13 +12,19 @@ import ( ) // Creates a transfer location for an Amazon S3 bucket. DataSync can use this -// location as a source or destination for transferring data. Before you begin, -// make sure that you read the following topics: -// - Storage class considerations with Amazon S3 locations (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) -// - Evaluating S3 request costs when using DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) +// location as a source or destination for transferring data. // -// For more information, see Configuring transfers with Amazon S3 (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html) -// . +// Before you begin, make sure that you read the following topics: +// +// [Storage class considerations with Amazon S3 locations] +// +// [Evaluating S3 request costs when using DataSync] +// +// For more information, see [Configuring transfers with Amazon S3]. +// +// [Storage class considerations with Amazon S3 locations]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes +// [Configuring transfers with Amazon S3]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html +// [Evaluating S3 request costs when using DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests func (c *Client) CreateLocationS3(ctx context.Context, params *CreateLocationS3Input, optFns ...func(*Options)) (*CreateLocationS3Output, error) { if params == nil { params = &CreateLocationS3Input{} @@ -39,43 +45,57 @@ type CreateLocationS3Input struct { // Specifies the ARN of the S3 bucket that you want to use as a location. (When // creating your DataSync task later, you specify whether this location is a - // transfer source or destination.) If your S3 bucket is located on an Outposts - // resource, you must specify an Amazon S3 access point. 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. + // transfer source or destination.) + // + // If your S3 bucket is located on an Outposts resource, you must specify an + // Amazon S3 access point. For more information, see [Managing data access with Amazon S3 access points]in the Amazon S3 User Guide. + // + // [Managing data access with Amazon S3 access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html // // This member is required. S3BucketArn *string // Specifies the Amazon Resource Name (ARN) of the Identity and Access Management - // (IAM) role that DataSync uses to access your S3 bucket. For more information, - // see Accessing S3 buckets (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access) - // . + // (IAM) role that DataSync uses to access your S3 bucket. + // + // For more information, see [Accessing S3 buckets]. + // + // [Accessing S3 buckets]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access // // This member is required. S3Config *types.S3Config // (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the - // DataSync agent on your Outpost. For more information, see Deploy your DataSync - // agent on Outposts (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent) - // . + // DataSync agent on your Outpost. + // + // For more information, see [Deploy your DataSync agent on Outposts]. + // + // [Deploy your DataSync agent on Outposts]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent AgentArns []string // Specifies the storage class that you want your objects to use when Amazon S3 is - // a transfer destination. For buckets in Amazon Web Services Regions, the storage - // class defaults to STANDARD . For buckets on Outposts, the storage class defaults - // to OUTPOSTS . For more information, see Storage class considerations with - // Amazon S3 transfers (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) - // . + // a transfer destination. + // + // For buckets in Amazon Web Services Regions, the storage class defaults to + // STANDARD . For buckets on Outposts, the storage class defaults to OUTPOSTS . + // + // For more information, see [Storage class considerations with Amazon S3 transfers]. + // + // [Storage class considerations with Amazon S3 transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes S3StorageClass types.S3StorageClass // Specifies a prefix in the S3 bucket that DataSync reads from or writes to - // (depending on whether the bucket is a source or destination location). DataSync - // can't transfer objects with a prefix that begins with a slash ( / ) or includes - // // , /./ , or /../ patterns. For example: + // (depending on whether the bucket is a source or destination location). + // + // DataSync can't transfer objects with a prefix that begins with a slash ( / ) or + // includes // , /./ , or /../ patterns. For example: + // // - /photos + // // - photos//2006/January + // // - photos/./2006/February + // // - photos/../2006/March Subdirectory *string diff --git a/service/datasync/api_op_CreateLocationSmb.go b/service/datasync/api_op_CreateLocationSmb.go index a1e079e886d..f31f1cb1563 100644 --- a/service/datasync/api_op_CreateLocationSmb.go +++ b/service/datasync/api_op_CreateLocationSmb.go @@ -13,9 +13,10 @@ import ( // Creates a transfer location for a Server Message Block (SMB) file server. // DataSync can use this location as a source or destination for transferring data. -// Before you begin, make sure that you understand how DataSync accesses SMB file -// servers (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb) -// . +// +// Before you begin, make sure that you understand how DataSync [accesses SMB file servers]. +// +// [accesses SMB file servers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb func (c *Client) CreateLocationSmb(ctx context.Context, params *CreateLocationSmbInput, optFns ...func(*Options)) (*CreateLocationSmbOutput, error) { if params == nil { params = &CreateLocationSmbInput{} @@ -41,16 +42,19 @@ type CreateLocationSmbInput struct { AgentArns []string // 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) - // for SMB locations. + // permission to access the files and folders involved in your transfer. + // + // For more information, see [required permissions] for SMB locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions // // This member is required. Password *string // Specifies the Domain Name Service (DNS) name or IP address of the SMB file - // server that your DataSync agent will mount. You can't specify an IP version 6 - // (IPv6) address. + // server that your DataSync agent will mount. + // + // You can't specify an IP version 6 (IPv6) address. // // This member is required. ServerHostname *string @@ -58,26 +62,32 @@ 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 - // network can also mount this path. To copy all data in the 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) - // for SMB locations. + // network can also mount this path. + // + // To copy all data in the subdirectory, DataSync must be able to mount the SMB + // share and access all of its data. For more information, see [required permissions]for SMB locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions // // This member is required. Subdirectory *string // Specifies the user that can mount and access the files, folders, and file - // metadata in your SMB file server. 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) - // for SMB locations. + // metadata in your SMB file server. + // + // For information about choosing a user with the right level of access for your + // transfer, see [required permissions]for SMB locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions // // This member is required. User *string // Specifies the name of the Active Directory domain that your SMB file server - // belongs to. If you have multiple Active Directory domains in your environment, - // configuring this parameter makes sure that DataSync connects to the right file - // server. + // belongs to. + // + // If you have multiple Active Directory domains in your environment, configuring + // this parameter makes sure that DataSync connects to the right file server. Domain *string // Specifies the version of the SMB protocol that DataSync uses to access your SMB diff --git a/service/datasync/api_op_CreateTask.go b/service/datasync/api_op_CreateTask.go index fc9e2d2184e..e33566f01d7 100644 --- a/service/datasync/api_op_CreateTask.go +++ b/service/datasync/api_op_CreateTask.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Configures a task, which defines where and how DataSync transfers your data. A -// task includes a source location, destination location, and transfer options -// (such as bandwidth limits, scheduling, and more). If you're planning to transfer -// data to or from an Amazon S3 location, review how DataSync can affect your S3 -// request charges (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) -// and the DataSync pricing page (http://aws.amazon.com/datasync/pricing/) before -// you begin. +// Configures a task, which defines where and how DataSync transfers your data. +// +// A task includes a source location, destination location, and transfer options +// (such as bandwidth limits, scheduling, and more). +// +// If you're planning to transfer data to or from an Amazon S3 location, review [how DataSync can affect your S3 request charges] +// and the [DataSync pricing page]before you begin. +// +// [how DataSync can affect your S3 request charges]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests +// [DataSync pricing page]: http://aws.amazon.com/datasync/pricing/ func (c *Client) CreateTask(ctx context.Context, params *CreateTaskInput, optFns ...func(*Options)) (*CreateTaskOutput, error) { if params == nil { params = &CreateTaskInput{} @@ -52,22 +55,27 @@ type CreateTaskInput struct { // Specifies exclude filters that define the files, objects, and folders in your // source location that you don't want DataSync to transfer. For more information - // and examples, see Specifying what DataSync transfers by using filters (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // . + // and examples, see [Specifying what DataSync transfers by using filters]. + // + // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // Specifies include filters define the files, objects, and folders in your source // location that you want DataSync to transfer. For more information and examples, - // see Specifying what DataSync transfers by using filters (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // . + // see [Specifying what DataSync transfers by using filters]. + // + // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // Configures a manifest, which is a list of files or objects that you want - // DataSync to transfer. For more information and configuration examples, see - // Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) - // . When using this parameter, your caller identity (the role that you're using - // DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess (https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) - // policy includes this permission. + // DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. + // + // When using this parameter, your caller identity (the role that you're using + // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this + // permission. + // + // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Specifies the name of your task. @@ -78,20 +86,26 @@ type CreateTaskInput struct { Options *types.Options // Specifies a schedule for when you want your task to run. For more information, - // see Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) - // . + // see [Scheduling your task]. + // + // [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 your task. Tags are key-value - // pairs that help you manage, filter, and search for your DataSync resources. + // Specifies the tags that you want to apply to your task. + // + // Tags are key-value pairs that help you manage, filter, and search for your + // DataSync resources. Tags []types.TagListEntry // Specifies how you want to configure a task report, which provides detailed - // information about your DataSync transfer. For more information, see Monitoring - // your DataSync transfers with task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // . When using this parameter, your caller identity (the role that you're using - // DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess (https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) - // policy includes this permission. + // information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. + // + // When using this parameter, your caller identity (the role that you're using + // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this + // permission. + // + // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig noSmithyDocumentSerde diff --git a/service/datasync/api_op_DeleteAgent.go b/service/datasync/api_op_DeleteAgent.go index 0010e0d2b67..a983fa04719 100644 --- a/service/datasync/api_op_DeleteAgent.go +++ b/service/datasync/api_op_DeleteAgent.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes an DataSync agent resource from your Amazon Web Services account. Keep -// in mind that this operation (which can't be undone) doesn't remove the agent's -// virtual machine (VM) or Amazon EC2 instance from your storage environment. For -// next steps, you can delete the VM or instance from your storage environment or -// reuse it to activate a new agent (https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) -// . +// Removes an DataSync agent resource from your Amazon Web Services account. +// +// Keep in mind that this operation (which can't be undone) doesn't remove the +// agent's virtual machine (VM) or Amazon EC2 instance from your storage +// environment. For next steps, you can delete the VM or instance from your storage +// environment or reuse it to [activate a new agent]. +// +// [activate a new agent]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html 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_DescribeAgent.go b/service/datasync/api_op_DescribeAgent.go index b3f1403a9f0..81c21805a99 100644 --- a/service/datasync/api_op_DescribeAgent.go +++ b/service/datasync/api_op_DescribeAgent.go @@ -47,12 +47,14 @@ type DescribeAgentOutput struct { // The ARN of the agent. AgentArn *string - // The time that the agent was activated (https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) - // . + // The time that the agent was [activated]. + // + // [activated]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html CreationTime *time.Time - // The type of service endpoint (https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html) - // that your agent is connected to. + // The type of [service endpoint] that your agent is connected to. + // + // [service endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html EndpointType types.EndpointType // The last time that the agent was communicating with the DataSync service. @@ -64,16 +66,20 @@ type DescribeAgentOutput struct { // The platform-related details about the agent, such as the version number. Platform *types.Platform - // The network configuration that the agent uses when connecting to a VPC service - // endpoint (https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc) - // . + // The network configuration that the agent uses when connecting to a [VPC service endpoint]. + // + // [VPC service endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc PrivateLinkConfig *types.PrivateLinkConfig // The status of the agent. + // // - If the status is ONLINE , the agent is configured properly and ready to use. + // // - If the status is OFFLINE , the agent has been out of contact with DataSync // for five minutes or longer. This can happen for a few reasons. For more - // information, see What do I do if my agent is offline? (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) + // information, see [What do I do if my agent is offline?] + // + // [What do I do if my agent is offline?]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline Status types.AgentStatus // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeDiscoveryJob.go b/service/datasync/api_op_DescribeDiscoveryJob.go index 9d83bf256d8..214ef3e6aec 100644 --- a/service/datasync/api_op_DescribeDiscoveryJob.go +++ b/service/datasync/api_op_DescribeDiscoveryJob.go @@ -53,9 +53,9 @@ type DescribeDiscoveryJobOutput struct { // The time when the discovery job started. JobStartTime *time.Time - // Indicates the status of a discovery job. For more information, see Discovery - // job statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table) - // . + // Indicates the status of a discovery job. For more information, see [Discovery job statuses]. + // + // [Discovery job statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table Status types.DiscoveryJobStatus // The ARN of the on-premises storage system you're running the discovery job on. diff --git a/service/datasync/api_op_DescribeLocationAzureBlob.go b/service/datasync/api_op_DescribeLocationAzureBlob.go index 31984fbbf0b..e6a002aa283 100644 --- a/service/datasync/api_op_DescribeLocationAzureBlob.go +++ b/service/datasync/api_op_DescribeLocationAzureBlob.go @@ -44,8 +44,9 @@ type DescribeLocationAzureBlobOutput struct { // The access tier that you want your objects or files transferred into. This only // applies when using the location as a transfer destination. For more information, - // see Access tiers (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) - // . + // see [Access tiers]. + // + // [Access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers AccessTier types.AzureAccessTier // The ARNs of the DataSync agents that can connect with your Azure Blob Storage @@ -58,9 +59,9 @@ type DescribeLocationAzureBlobOutput struct { // The type of blob that you want your objects or files to be when transferring // them into Azure Blob Storage. Currently, DataSync only supports moving data into - // Azure Blob Storage as block blobs. For more information on blob types, see the - // Azure Blob Storage documentation (https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs) - // . + // Azure Blob Storage as block blobs. For more information on blob types, see the [Azure Blob Storage documentation]. + // + // [Azure Blob Storage documentation]: https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs BlobType types.AzureBlobType // The time that your Azure Blob Storage transfer location was created. diff --git a/service/datasync/api_op_DescribeLocationFsxOntap.go b/service/datasync/api_op_DescribeLocationFsxOntap.go index 529e5d67f3f..764dda1d66c 100644 --- a/service/datasync/api_op_DescribeLocationFsxOntap.go +++ b/service/datasync/api_op_DescribeLocationFsxOntap.go @@ -13,8 +13,10 @@ import ( ) // Provides details about how an DataSync transfer 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 . +// NetApp ONTAP file system is configured. +// +// If your location uses SMB, the 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 12ad4fee434..ea860744e97 100644 --- a/service/datasync/api_op_DescribeLocationFsxOpenZfs.go +++ b/service/datasync/api_op_DescribeLocationFsxOpenZfs.go @@ -13,8 +13,10 @@ import ( ) // Provides details about how an DataSync transfer location for an Amazon FSx for -// OpenZFS file system is configured. Response elements related to SMB aren't -// supported with the DescribeLocationFsxOpenZfs operation. +// OpenZFS file system is configured. +// +// Response elements related to SMB aren't supported with the +// DescribeLocationFsxOpenZfs operation. func (c *Client) DescribeLocationFsxOpenZfs(ctx context.Context, params *DescribeLocationFsxOpenZfsInput, optFns ...func(*Options)) (*DescribeLocationFsxOpenZfsOutput, error) { if params == nil { params = &DescribeLocationFsxOpenZfsInput{} @@ -49,7 +51,9 @@ type DescribeLocationFsxOpenZfsOutput struct { LocationArn *string // The uniform resource identifier (URI) of the FSx for OpenZFS location that was - // described. Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder + // described. + // + // Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder LocationUri *string // The type of protocol that DataSync uses to access your file system. diff --git a/service/datasync/api_op_DescribeLocationHdfs.go b/service/datasync/api_op_DescribeLocationHdfs.go index aae7270df42..e920907dc40 100644 --- a/service/datasync/api_op_DescribeLocationHdfs.go +++ b/service/datasync/api_op_DescribeLocationHdfs.go @@ -58,7 +58,7 @@ type DescribeLocationHdfsOutput struct { // . KerberosPrincipal *string - // The URI of the HDFS cluster's Key Management Server (KMS). + // The URI of the HDFS cluster's Key Management Server (KMS). KmsKeyProviderUri *string // The ARN of the HDFS location. diff --git a/service/datasync/api_op_DescribeLocationS3.go b/service/datasync/api_op_DescribeLocationS3.go index da1ce441a6f..979fe45d491 100644 --- a/service/datasync/api_op_DescribeLocationS3.go +++ b/service/datasync/api_op_DescribeLocationS3.go @@ -44,9 +44,11 @@ type DescribeLocationS3Input struct { type DescribeLocationS3Output struct { // The ARNs of the DataSync agents deployed on your Outpost when using working - // with Amazon S3 on Outposts. For more information, see Deploy your DataSync - // agent on Outposts (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent) - // . + // with Amazon S3 on Outposts. + // + // For more information, see [Deploy your DataSync agent on Outposts]. + // + // [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 location was created. @@ -59,16 +61,20 @@ type DescribeLocationS3Output struct { LocationUri *string // Specifies the Amazon Resource Name (ARN) of the Identity and Access Management - // (IAM) role that DataSync uses to access your S3 bucket. For more information, - // see Accessing S3 buckets (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access) - // . + // (IAM) role that DataSync uses to access your S3 bucket. + // + // For more information, see [Accessing S3 buckets]. + // + // [Accessing S3 buckets]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access S3Config *types.S3Config // When Amazon S3 is a destination location, this is the storage class that you - // chose for your objects. Some storage classes have behaviors that can affect your - // Amazon S3 storage costs. For more information, see Storage class considerations - // with Amazon S3 transfers (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) - // . + // chose for your objects. + // + // Some storage classes have behaviors that can affect your Amazon S3 storage + // costs. For more information, see [Storage class considerations with Amazon S3 transfers]. + // + // [Storage class considerations with Amazon S3 transfers]: 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_DescribeStorageSystem.go b/service/datasync/api_op_DescribeStorageSystem.go index 3c3b7fd76f0..b8c6a811269 100644 --- a/service/datasync/api_op_DescribeStorageSystem.go +++ b/service/datasync/api_op_DescribeStorageSystem.go @@ -66,8 +66,9 @@ type DescribeStorageSystemOutput struct { Name *string // The ARN of the secret that stores your on-premises storage system's - // credentials. DataSync Discovery stores these credentials in Secrets Manager (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage) - // . + // credentials. DataSync Discovery stores these credentials in [Secrets Manager]. + // + // [Secrets Manager]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage SecretsManagerArn *string // The server name and network port required to connect with your on-premises @@ -77,9 +78,10 @@ type DescribeStorageSystemOutput struct { // The ARN of the on-premises storage system that the discovery job looked at. StorageSystemArn *string - // The type of on-premises storage system. DataSync Discovery currently only - // supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems - // running ONTAP 9.7 or later. + // The type of on-premises storage system. + // + // DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) + // and All Flash FAS (AFF) systems running ONTAP 9.7 or later. SystemType types.DiscoverySystemType // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeStorageSystemResources.go b/service/datasync/api_op_DescribeStorageSystemResources.go index 18cdf114933..79d05ae49ed 100644 --- a/service/datasync/api_op_DescribeStorageSystemResources.go +++ b/service/datasync/api_op_DescribeStorageSystemResources.go @@ -68,10 +68,12 @@ type DescribeStorageSystemResourcesOutput struct { NextToken *string // The information collected about your storage system's resources. A response can - // also include Amazon Web Services storage service recommendations. For more - // information, see storage resource information (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html) - // collected by and recommendations (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) - // provided by DataSync Discovery. + // also include Amazon Web Services storage service recommendations. + // + // For more information, see [storage resource information] collected by and [recommendations] provided by DataSync Discovery. + // + // [storage resource information]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html + // [recommendations]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html ResourceDetails *types.ResourceDetails // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeTask.go b/service/datasync/api_op_DescribeTask.go index a1712da59e1..3451cd58f8e 100644 --- a/service/datasync/api_op_DescribeTask.go +++ b/service/datasync/api_op_DescribeTask.go @@ -45,8 +45,11 @@ type DescribeTaskInput struct { type DescribeTaskOutput struct { // The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring - // your task. For more information, see Monitoring DataSync with Amazon CloudWatch (https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html) - // . + // your task. + // + // For more information, see [Monitoring DataSync with Amazon CloudWatch]. + // + // [Monitoring DataSync with Amazon CloudWatch]: https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html CloudWatchLogGroupArn *string // The time that the task was created. @@ -58,38 +61,41 @@ type DescribeTaskOutput struct { // The ARN of your transfer's destination location. DestinationLocationArn *string - // The ARNs of the network interfaces (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) - // that DataSync created for your destination location. + // The ARNs of the [network interfaces] that DataSync created for your destination location. + // + // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces DestinationNetworkInterfaceArns []string // If there's an issue with your task, you can use the error code to help you - // troubleshoot the problem. For more information, see Troubleshooting issues with - // DataSync transfers (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html) - // . + // troubleshoot the problem. For more information, see [Troubleshooting issues with DataSync transfers]. + // + // [Troubleshooting issues with DataSync transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html ErrorCode *string // If there's an issue with your task, you can use the error details to help you - // troubleshoot the problem. For more information, see Troubleshooting issues with - // DataSync transfers (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html) - // . + // troubleshoot the problem. For more information, see [Troubleshooting issues with DataSync transfers]. + // + // [Troubleshooting issues with DataSync transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html ErrorDetail *string // The exclude filters that define the files, objects, and folders in your source // location that you don't want DataSync to transfer. For more information and - // examples, see Specifying what DataSync transfers by using filters (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // . + // examples, see [Specifying what DataSync transfers by using filters]. + // + // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // The include filters that define the files, objects, and folders in your source // location that you want DataSync to transfer. For more information and examples, - // see Specifying what DataSync transfers by using filters (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // . + // see [Specifying what DataSync transfers by using filters]. + // + // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // The configuration of the manifest that lists the files or objects that you want - // DataSync to transfer. For more information, see Specifying what DataSync - // transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) - // . + // DataSync to transfer. For more information, see [Specifying what DataSync transfers by using a manifest]. + // + // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // The name of your task. @@ -100,34 +106,36 @@ type DescribeTaskOutput struct { // other options. Options *types.Options - // The schedule for when you want your task to run. For more information, see - // Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) - // . + // The schedule for when you want your task to run. For more information, see [Scheduling your task]. + // + // [Scheduling your task]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html Schedule *types.TaskSchedule - // The details about your task schedule (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) - // . + // The details about your [task schedule]. + // + // [task schedule]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html ScheduleDetails *types.TaskScheduleDetails // The ARN of your transfer's source location. SourceLocationArn *string - // The ARNs of the network interfaces (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) - // that DataSync created for your source location. + // The ARNs of the [network interfaces] that DataSync created for your source location. + // + // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces SourceNetworkInterfaceArns []string - // The status of your task. For information about what each status means, see Task - // statuses (https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses) - // . + // The status of your task. For information about what each status means, see [Task statuses]. + // + // [Task statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses Status types.TaskStatus // The ARN of your task. TaskArn *string // The configuration of your task report, which provides detailed information - // about your DataSync transfer. For more information, see Monitoring your - // DataSync transfers with task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // . + // about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. + // + // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_DescribeTaskExecution.go b/service/datasync/api_op_DescribeTaskExecution.go index 028e688786b..07fd0452f8c 100644 --- a/service/datasync/api_op_DescribeTaskExecution.go +++ b/service/datasync/api_op_DescribeTaskExecution.go @@ -61,9 +61,10 @@ type DescribeTaskExecutionOutput struct { EstimatedBytesToTransfer int64 // The expected number of files, objects, and directories that DataSync will - // delete in your destination location. If you don't configure your task (https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) - // to delete data in the destination that isn't in the source, the value is always - // 0 . + // delete in your destination location. If you don't [configure your task]to delete data in the + // destination that isn't in the source, the value is always 0 . + // + // [configure your task]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html EstimatedFilesToDelete int64 // The expected number of files, objects, and directories that DataSync will @@ -74,14 +75,16 @@ type DescribeTaskExecutionOutput struct { 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) - // . + // more information and examples, see [Filtering data transferred by DataSync]. + // + // [Filtering data transferred by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // The number of files, objects, and directories that DataSync deleted in your - // destination location. If you don't configure your task (https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) - // to delete data in the destination that isn't in the source, the value is always - // 0 . + // destination location. If you don't [configure your task]to delete data in the destination that isn't + // in the source, the value is always 0 . + // + // [configure your task]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html FilesDeleted int64 // The number of files, objects, and directories that DataSync skipped during your @@ -91,7 +94,9 @@ type DescribeTaskExecutionOutput struct { // The actual number of files, objects, and directories that DataSync transferred // over the network. This value is updated periodically during the task execution's // TRANSFERRING phase when something is read from the source and sent over the - // network. If DataSync fails to transfer something, this value can be less than + // network. + // + // If DataSync fails to transfer something, this value can 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 exact indication of what transferred or to @@ -99,34 +104,43 @@ type DescribeTaskExecutionOutput struct { FilesTransferred int64 // The number of files, objects, and directories that DataSync verified during - // your transfer. When you configure your task to verify only the data that's - // transferred (https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html) - // , DataSync doesn't verify directories in some situations or files that fail to - // transfer. + // your transfer. + // + // When you configure your task to [verify only the data that's transferred], DataSync doesn't verify directories in some + // situations or files that fail to transfer. + // + // [verify only the data that's transferred]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html FilesVerified 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) - // . + // more information and examples, see [Filtering data transferred by DataSync]. + // + // [Filtering data transferred by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // The configuration of the manifest that lists the files or objects to transfer. - // For more information, see Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) - // . + // For more information, see [Specifying what DataSync transfers by using a manifest]. + // + // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth - // limits for your task, among other options. Each option has a default value. - // Unless you need to, you don't have to configure any option before calling - // StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) - // . You also can override your task options for each task execution. For example, + // limits for your task, among other options. + // + // Each option has a default value. Unless you need to, you don't have to + // configure any option before calling [StartTaskExecution]. + // + // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. + // + // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html Options *types.Options - // Indicates whether DataSync generated a complete task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // for your transfer. + // Indicates whether DataSync generated a complete [task report] for your transfer. + // + // [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html ReportResult *types.ReportResult // The result of the task execution. @@ -140,16 +154,18 @@ type DescribeTaskExecutionOutput struct { // The ARN of the task execution that you wanted information about. // TaskExecutionArn is hierarchical and includes TaskArn for the task that was - // executed. For example, a TaskExecution value with the ARN + // 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 . TaskExecutionArn *string // The configuration of your task report, which provides detailed information - // about for your DataSync transfer. For more information, see Creating a task - // report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // . + // about for your DataSync transfer. For more information, see [Creating a task report]. + // + // [Creating a task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // Metadata pertaining to the operation's result. diff --git a/service/datasync/api_op_GenerateRecommendations.go b/service/datasync/api_op_GenerateRecommendations.go index 9053a46070e..8afc9783ec7 100644 --- a/service/datasync/api_op_GenerateRecommendations.go +++ b/service/datasync/api_op_GenerateRecommendations.go @@ -14,10 +14,12 @@ import ( // Creates recommendations about where to migrate your data to in Amazon Web // Services. Recommendations are generated based on information that DataSync // Discovery collects about your on-premises storage system's resources. For more -// information, see Recommendations provided by DataSync Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) -// . Once generated, you can view your recommendations by using the -// DescribeStorageSystemResources (https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html) -// operation. +// information, see [Recommendations provided by DataSync Discovery]. +// +// Once generated, you can view your recommendations by using the [DescribeStorageSystemResources] operation. +// +// [DescribeStorageSystemResources]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html +// [Recommendations provided by DataSync Discovery]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html func (c *Client) GenerateRecommendations(ctx context.Context, params *GenerateRecommendationsInput, optFns ...func(*Options)) (*GenerateRecommendationsOutput, error) { if params == nil { params = &GenerateRecommendationsInput{} diff --git a/service/datasync/api_op_ListAgents.go b/service/datasync/api_op_ListAgents.go index 1540cd310dd..67f7f1d7d04 100644 --- a/service/datasync/api_op_ListAgents.go +++ b/service/datasync/api_op_ListAgents.go @@ -12,17 +12,20 @@ import ( ) // Returns a list of DataSync agents that belong to an Amazon Web Services account -// in the Amazon Web Services Region specified in the request. With pagination, you -// can reduce the number of agents returned in a response. If you get a truncated -// list of agents in a response, the response contains a marker that you can -// 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) -// . +// in the Amazon Web Services Region specified in the request. +// +// With pagination, you can reduce the number of agents returned in a response. If +// you get a truncated list of agents in a response, the response contains a marker +// that you can 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]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]. +// +// [DescribeAgent]: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html +// [CreateAgent]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error) { if params == nil { params = &ListAgentsInput{} diff --git a/service/datasync/api_op_ListLocations.go b/service/datasync/api_op_ListLocations.go index 60de1b5c63d..0ff8d421dc4 100644 --- a/service/datasync/api_op_ListLocations.go +++ b/service/datasync/api_op_ListLocations.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of source and destination locations. If you have more locations -// than are returned in a response (that is, the response returns only a truncated -// list of your agents), the response contains a token that you can specify in your -// next request to fetch the next page of locations. +// Returns a list of source and destination locations. +// +// If you have more locations than are returned in a response (that is, the +// response returns only a truncated list of your agents), the response contains a +// token that you can specify in your next request to fetch the next page of +// locations. func (c *Client) ListLocations(ctx context.Context, params *ListLocationsInput, optFns ...func(*Options)) (*ListLocationsOutput, error) { if params == nil { params = &ListLocationsInput{} diff --git a/service/datasync/api_op_StartDiscoveryJob.go b/service/datasync/api_op_StartDiscoveryJob.go index 78b34f7d599..508c1dd7f67 100644 --- a/service/datasync/api_op_StartDiscoveryJob.go +++ b/service/datasync/api_op_StartDiscoveryJob.go @@ -13,8 +13,9 @@ import ( // Runs a DataSync discovery job on your on-premises storage system. If you // haven't added the storage system to DataSync Discovery yet, do this first by -// using the AddStorageSystem (https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html) -// operation. +// using the [AddStorageSystem]operation. +// +// [AddStorageSystem]: https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html func (c *Client) StartDiscoveryJob(ctx context.Context, params *StartDiscoveryJobInput, optFns ...func(*Options)) (*StartDiscoveryJobOutput, error) { if params == nil { params = &StartDiscoveryJobInput{} @@ -39,10 +40,11 @@ type StartDiscoveryJobInput struct { // This member is required. ClientToken *string - // Specifies in minutes how long you want the discovery job to run. For more - // accurate recommendations, we recommend a duration of at least 14 days. Longer - // durations allow time to collect a sufficient number of data points and provide a - // realistic representation of storage performance and utilization. + // Specifies in minutes how long you want the discovery job to run. + // + // For more accurate recommendations, we recommend a duration of at least 14 days. + // Longer durations allow time to collect a sufficient number of data points and + // provide a realistic representation of storage performance and utilization. // // This member is required. CollectionDurationMinutes *int32 diff --git a/service/datasync/api_op_StartTaskExecution.go b/service/datasync/api_op_StartTaskExecution.go index 6db39682cb0..415dff34ae9 100644 --- a/service/datasync/api_op_StartTaskExecution.go +++ b/service/datasync/api_op_StartTaskExecution.go @@ -12,12 +12,16 @@ import ( ) // Starts an DataSync transfer 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) -// . If you're planning to transfer data to or from an Amazon S3 location, review -// how DataSync can affect your S3 request charges (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) -// and the DataSync pricing page (http://aws.amazon.com/datasync/pricing/) before -// you begin. +// execution at a time. +// +// There are several phases to a task execution. For more information, see [Task execution statuses]. +// +// If you're planning to transfer data to or from an Amazon S3 location, review [how DataSync can affect your S3 request charges] +// and the [DataSync pricing page]before you begin. +// +// [Task execution statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses +// [how DataSync can affect your S3 request charges]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests +// [DataSync pricing page]: http://aws.amazon.com/datasync/pricing/ func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error) { if params == nil { params = &StartTaskExecutionInput{} @@ -54,36 +58,50 @@ type StartTaskExecutionInput struct { Includes []types.FilterRule // Configures a manifest, which is a list of files or objects that you want - // DataSync to transfer. For more information and configuration examples, see - // Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) - // . When using this parameter, your caller identity (the role that you're using - // DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess (https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) - // policy includes this permission. To remove a manifest configuration, specify - // this parameter with an empty value. + // DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. + // + // When using this parameter, your caller identity (the role that you're using + // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this + // permission. + // + // To remove a manifest configuration, specify this parameter with an empty value. + // + // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth - // limits for your task, among other options. Each option has a default value. - // Unless you need to, you don't have to configure any option before calling - // StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) - // . You also can override your task options for each task execution. For example, + // limits for your task, among other options. + // + // Each option has a default value. Unless you need to, you don't have to + // configure any option before calling [StartTaskExecution]. + // + // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. + // + // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html OverrideOptions *types.Options // Specifies the tags that you want to apply to the Amazon Resource Name (ARN) - // representing the task execution. Tags are key-value pairs that help you manage, - // filter, and search for your DataSync resources. + // representing the task execution. + // + // Tags are key-value pairs that help you manage, filter, and search for your + // DataSync resources. Tags []types.TagListEntry // Specifies how you want to configure a task report, which provides detailed - // information about your DataSync transfer. For more information, see Monitoring - // your DataSync transfers with task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // . When using this parameter, your caller identity (the role that you're using - // DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess (https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) - // policy includes this permission. To remove a task report configuration, specify - // this parameter as empty. + // information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. + // + // When using this parameter, your caller identity (the role that you're using + // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this + // permission. + // + // To remove a task report configuration, specify this parameter as empty. + // + // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig noSmithyDocumentSerde diff --git a/service/datasync/api_op_StopDiscoveryJob.go b/service/datasync/api_op_StopDiscoveryJob.go index 8435f6b1b66..00c519db48a 100644 --- a/service/datasync/api_op_StopDiscoveryJob.go +++ b/service/datasync/api_op_StopDiscoveryJob.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a running DataSync discovery job. You can stop a discovery job anytime. A -// job that's stopped before it's scheduled to end likely will provide you some -// information about your on-premises storage system resources. To get -// recommendations for a stopped job, you must use the GenerateRecommendations (https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html) -// operation. +// Stops a running DataSync discovery job. +// +// You can stop a discovery job anytime. A job that's stopped before it's +// scheduled to end likely will provide you some information about your on-premises +// storage system resources. To get recommendations for a stopped job, you must use +// the [GenerateRecommendations]operation. +// +// [GenerateRecommendations]: https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html func (c *Client) StopDiscoveryJob(ctx context.Context, params *StopDiscoveryJobInput, optFns ...func(*Options)) (*StopDiscoveryJobOutput, error) { if params == nil { params = &StopDiscoveryJobInput{} diff --git a/service/datasync/api_op_TagResource.go b/service/datasync/api_op_TagResource.go index 7ae88b770a8..b62ae45e93a 100644 --- a/service/datasync/api_op_TagResource.go +++ b/service/datasync/api_op_TagResource.go @@ -12,8 +12,9 @@ import ( ) // Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that -// can help you manage, filter, and search for your resources. These include -// DataSync resources, such as locations, tasks, and task executions. +// can help you manage, filter, and search for your resources. +// +// These include DataSync resources, such as locations, tasks, and task executions. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/datasync/api_op_UpdateLocationAzureBlob.go b/service/datasync/api_op_UpdateLocationAzureBlob.go index 12a59c92a2a..ddf3c041b4b 100644 --- a/service/datasync/api_op_UpdateLocationAzureBlob.go +++ b/service/datasync/api_op_UpdateLocationAzureBlob.go @@ -38,14 +38,17 @@ type UpdateLocationAzureBlobInput struct { // Specifies the access tier that you want your objects or files transferred into. // This only applies when using the location as a transfer destination. For more - // information, see Access tiers (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) - // . + // information, see [Access tiers]. + // + // [Access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers AccessTier types.AzureAccessTier // Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect - // with your Azure Blob Storage container. You can specify more than one agent. For - // more information, see Using multiple agents for your transfer (https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html) - // . + // with your Azure Blob Storage container. + // + // You can specify more than one agent. For more information, see [Using multiple agents for your transfer]. + // + // [Using multiple agents for your transfer]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html AgentArns []string // Specifies the authentication method DataSync uses to access your Azure Blob @@ -55,8 +58,9 @@ type UpdateLocationAzureBlobInput struct { // Specifies the type of blob that you want your objects or files to be when // transferring them into Azure Blob Storage. Currently, DataSync only supports // moving data into Azure Blob Storage as block blobs. For more information on blob - // types, see the Azure Blob Storage documentation (https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs) - // . + // types, see the [Azure Blob Storage documentation]. + // + // [Azure Blob Storage documentation]: https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs BlobType types.AzureBlobType // Specifies the SAS configuration that allows DataSync to access your Azure Blob diff --git a/service/datasync/api_op_UpdateLocationHdfs.go b/service/datasync/api_op_UpdateLocationHdfs.go index 5eca69aad9e..730656ae710 100644 --- a/service/datasync/api_op_UpdateLocationHdfs.go +++ b/service/datasync/api_op_UpdateLocationHdfs.go @@ -56,7 +56,8 @@ type UpdateLocationHdfsInput struct { // base64-encoded text. KerberosKrb5Conf []byte - // The Kerberos principal with access to the files and folders on the HDFS cluster. + // The Kerberos principal with access to the files and folders on the HDFS + // cluster. KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). diff --git a/service/datasync/api_op_UpdateLocationNfs.go b/service/datasync/api_op_UpdateLocationNfs.go index 32041fb2d0e..75964211ff1 100644 --- a/service/datasync/api_op_UpdateLocationNfs.go +++ b/service/datasync/api_op_UpdateLocationNfs.go @@ -12,9 +12,11 @@ import ( ) // Modifies some configurations of the Network File System (NFS) transfer location -// that you're using with DataSync. For more information, see Configuring -// transfers to or from an NFS file server (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html) -// . +// that you're using with DataSync. +// +// For more information, see [Configuring transfers to or from an NFS file server]. +// +// [Configuring transfers to or from an NFS file server]: 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{} @@ -45,10 +47,12 @@ type UpdateLocationNfsInput struct { OnPremConfig *types.OnPremConfig // Specifies the export path in your NFS file server that you want DataSync to - // mount. This path (or a subdirectory of the path) is where DataSync transfers - // data to or from. For information on configuring an export for DataSync, see - // Accessing NFS file servers (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs) - // . + // mount. + // + // This path (or a subdirectory of the path) is where DataSync transfers data to + // or from. For information on configuring an export for DataSync, see [Accessing NFS file servers]. + // + // [Accessing NFS file servers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs Subdirectory *string noSmithyDocumentSerde diff --git a/service/datasync/api_op_UpdateLocationObjectStorage.go b/service/datasync/api_op_UpdateLocationObjectStorage.go index 5324f834296..16c5b6b55e7 100644 --- a/service/datasync/api_op_UpdateLocationObjectStorage.go +++ b/service/datasync/api_op_UpdateLocationObjectStorage.go @@ -50,18 +50,26 @@ type UpdateLocationObjectStorageInput struct { // Specifies a certificate chain for DataSync to authenticate with your object // storage system if the system uses a private or self-signed certificate authority // (CA). You must specify a single .pem file with a full certificate chain (for - // example, file:///home/user/.ssh/object_storage_certificates.pem ). The - // certificate chain might include: + // example, file:///home/user/.ssh/object_storage_certificates.pem ). + // + // The certificate chain might include: + // // - The object storage system's certificate + // // - All intermediate certificates (if there are any) + // // - The root certificate of the signing CA + // // You can concatenate your certificates into a .pem file (which can be up to // 32768 bytes before base64 encoding). The following example cat command creates - // an object_storage_certificates.pem file that includes three certificates: cat - // object_server_certificate.pem intermediate_certificate.pem - // ca_root_certificate.pem > object_storage_certificates.pem To use this parameter, - // configure ServerProtocol to HTTPS . Updating this parameter doesn't interfere - // with tasks that you have in progress. + // an object_storage_certificates.pem file that includes three certificates: + // + // cat object_server_certificate.pem intermediate_certificate.pem + // ca_root_certificate.pem > object_storage_certificates.pem + // + // To use this parameter, configure ServerProtocol to HTTPS . + // + // Updating this parameter doesn't interfere with tasks that you have in progress. ServerCertificate []byte // Specifies the port that your object storage server accepts inbound network diff --git a/service/datasync/api_op_UpdateLocationSmb.go b/service/datasync/api_op_UpdateLocationSmb.go index bfc36a2e5ac..06e38dd18ba 100644 --- a/service/datasync/api_op_UpdateLocationSmb.go +++ b/service/datasync/api_op_UpdateLocationSmb.go @@ -39,11 +39,14 @@ type UpdateLocationSmbInput struct { // file server. You specify an agent by using its Amazon Resource Name (ARN). AgentArns []string - // Specifies the Windows domain name that your SMB file server belongs to. If you - // have multiple domains in your environment, configuring this parameter makes sure - // that DataSync connects to the right file server. For more information, see - // required permissions (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) - // for SMB locations. + // Specifies the Windows domain name that your SMB file server belongs to. + // + // If you have multiple domains in your environment, configuring this parameter + // makes sure that DataSync connects to the right file server. + // + // For more information, see [required permissions] for SMB locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions Domain *string // Specifies the version of the Server Message Block (SMB) protocol that DataSync @@ -51,25 +54,32 @@ type UpdateLocationSmbInput struct { MountOptions *types.SmbMountOptions // 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) - // for SMB locations. + // permission to access the files and folders involved in your transfer. + // + // For more information, see [required permissions] for SMB locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions Password *string // 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 - // 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) - // for SMB locations. + // 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]for SMB + // locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions Subdirectory *string // 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) - // for SMB locations. + // 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]for SMB locations. + // + // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions User *string noSmithyDocumentSerde diff --git a/service/datasync/api_op_UpdateTask.go b/service/datasync/api_op_UpdateTask.go index a1d2af61cff..dd8555a5baf 100644 --- a/service/datasync/api_op_UpdateTask.go +++ b/service/datasync/api_op_UpdateTask.go @@ -42,24 +42,29 @@ type UpdateTaskInput struct { // Specifies exclude filters that define the files, objects, and folders in your // source location that you don't want DataSync to transfer. For more information - // and examples, see Specifying what DataSync transfers by using filters (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // . + // and examples, see [Specifying what DataSync transfers by using filters]. + // + // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // Specifies include filters define the files, objects, and folders in your source // location that you want DataSync to transfer. For more information and examples, - // see Specifying what DataSync transfers by using filters (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // . + // see [Specifying what DataSync transfers by using filters]. + // + // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // Configures a manifest, which is a list of files or objects that you want - // DataSync to transfer. For more information and configuration examples, see - // Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) - // . When using this parameter, your caller identity (the IAM role that you're - // using DataSync with) must have the iam:PassRole permission. The - // AWSDataSyncFullAccess (https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) - // policy includes this permission. To remove a manifest configuration, specify - // this parameter as empty. + // DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. + // + // When using this parameter, your caller identity (the IAM role that you're using + // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this + // permission. + // + // To remove a manifest configuration, specify this parameter as empty. + // + // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Specifies the name of your task. @@ -68,26 +73,34 @@ type UpdateTaskInput struct { // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth - // limits for your task, among other options. Each option has a default value. - // Unless you need to, you don't have to configure any option before calling - // StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) - // . You also can override your task options for each task execution. For example, + // limits for your task, among other options. + // + // Each option has a default value. Unless you need to, you don't have to + // configure any option before calling [StartTaskExecution]. + // + // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. + // + // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html Options *types.Options // Specifies a schedule for when you want your task to run. For more information, - // see Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) - // . + // see [Scheduling your task]. + // + // [Scheduling your task]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html Schedule *types.TaskSchedule // Specifies how you want to configure a task report, which provides detailed - // information about your DataSync transfer. For more information, see Monitoring - // your DataSync transfers with task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // . When using this parameter, your caller identity (the IAM role that you're - // using DataSync with) must have the iam:PassRole permission. The - // AWSDataSyncFullAccess (https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) - // policy includes this permission. To remove a task report configuration, specify - // this parameter as empty. + // information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. + // + // When using this parameter, your caller identity (the IAM role that you're using + // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this + // permission. + // + // To remove a task report configuration, specify this parameter as empty. + // + // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess + // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig noSmithyDocumentSerde diff --git a/service/datasync/api_op_UpdateTaskExecution.go b/service/datasync/api_op_UpdateTaskExecution.go index 9a484a97b76..52dcb984917 100644 --- a/service/datasync/api_op_UpdateTaskExecution.go +++ b/service/datasync/api_op_UpdateTaskExecution.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the configuration of a running DataSync task execution. Currently, the -// only Option that you can modify with UpdateTaskExecution is BytesPerSecond (https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond) -// , which throttles bandwidth for a running or queued task execution. +// Updates the configuration of a running DataSync task execution. +// +// Currently, the only Option that you can modify with UpdateTaskExecution is [BytesPerSecond], +// which throttles bandwidth for a running or queued task execution. +// +// [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{} @@ -34,12 +37,16 @@ type UpdateTaskExecutionInput struct { // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth - // limits for your task, among other options. Each option has a default value. - // Unless you need to, you don't have to configure any option before calling - // StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) - // . You also can override your task options for each task execution. For example, + // limits for your task, among other options. + // + // Each option has a default value. Unless you need to, you don't have to + // configure any option before calling [StartTaskExecution]. + // + // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. // + // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html + // // This member is required. Options *types.Options diff --git a/service/datasync/doc.go b/service/datasync/doc.go index b34cbcab8eb..398f59e7e17 100644 --- a/service/datasync/doc.go +++ b/service/datasync/doc.go @@ -3,10 +3,14 @@ // Package datasync provides the API client, operations, and parameter types for // AWS DataSync. // -// DataSync DataSync is an online data movement and discovery service that -// simplifies data migration and helps you quickly, easily, and securely transfer -// your file or object data to, from, and between 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) -// . +// # DataSync +// +// DataSync is an online data movement and discovery service that simplifies data +// migration and helps you quickly, easily, and securely transfer your file or +// object data to, from, and between Amazon Web Services storage services. +// +// This API interface reference includes documentation for using DataSync +// programmatically. For complete information, see the [DataSync User Guide]. +// +// [DataSync User Guide]: https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html package datasync diff --git a/service/datasync/options.go b/service/datasync/options.go index 454e8cedd9e..0869748507b 100644 --- a/service/datasync/options.go +++ b/service/datasync/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/datasync/types/enums.go b/service/datasync/types/enums.go index 33b7fcaa457..d037c3c121e 100644 --- a/service/datasync/types/enums.go +++ b/service/datasync/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AgentStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentStatus) Values() []AgentStatus { return []AgentStatus{ "ONLINE", @@ -29,8 +30,9 @@ const ( ) // 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. +// the future, and so 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{ "NONE", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for AzureAccessTier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AzureAccessTier) Values() []AzureAccessTier { return []AzureAccessTier{ "HOT", @@ -67,6 +70,7 @@ const ( // Values returns all known values for AzureBlobAuthenticationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AzureBlobAuthenticationType) Values() []AzureBlobAuthenticationType { return []AzureBlobAuthenticationType{ @@ -82,8 +86,9 @@ const ( ) // Values returns all known values for AzureBlobType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AzureBlobType) Values() []AzureBlobType { return []AzureBlobType{ "BLOCK", @@ -104,8 +109,9 @@ const ( ) // Values returns all known values for DiscoveryJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiscoveryJobStatus) Values() []DiscoveryJobStatus { return []DiscoveryJobStatus{ "RUNNING", @@ -126,8 +132,9 @@ const ( ) // Values returns all known values for DiscoveryResourceFilter. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiscoveryResourceFilter) Values() []DiscoveryResourceFilter { return []DiscoveryResourceFilter{ "SVM", @@ -144,8 +151,9 @@ const ( ) // Values returns all known values for DiscoveryResourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiscoveryResourceType) Values() []DiscoveryResourceType { return []DiscoveryResourceType{ "SVM", @@ -162,8 +170,9 @@ const ( ) // Values returns all known values for DiscoverySystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiscoverySystemType) Values() []DiscoverySystemType { return []DiscoverySystemType{ "NetAppONTAP", @@ -179,8 +188,9 @@ const ( ) // Values returns all known values for EfsInTransitEncryption. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EfsInTransitEncryption) Values() []EfsInTransitEncryption { return []EfsInTransitEncryption{ "NONE", @@ -198,8 +208,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -216,8 +227,9 @@ const ( ) // Values returns all known values for FilterType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterType) Values() []FilterType { return []FilterType{ "SIMPLE_PATTERN", @@ -235,8 +247,9 @@ const ( ) // Values returns all known values for Gid. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Gid) Values() []Gid { return []Gid{ "NONE", @@ -255,8 +268,9 @@ const ( ) // Values returns all known values for HdfsAuthenticationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HdfsAuthenticationType) Values() []HdfsAuthenticationType { return []HdfsAuthenticationType{ "SIMPLE", @@ -276,6 +290,7 @@ const ( // Values returns all known values for HdfsDataTransferProtection. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HdfsDataTransferProtection) Values() []HdfsDataTransferProtection { return []HdfsDataTransferProtection{ @@ -297,8 +312,9 @@ const ( ) // Values returns all known values for HdfsRpcProtection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HdfsRpcProtection) Values() []HdfsRpcProtection { return []HdfsRpcProtection{ "DISABLED", @@ -318,8 +334,9 @@ const ( ) // Values returns all known values for LocationFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocationFilterName) Values() []LocationFilterName { return []LocationFilterName{ "LocationUri", @@ -338,8 +355,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "OFF", @@ -356,8 +374,9 @@ const ( ) // Values returns all known values for ManifestAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManifestAction) Values() []ManifestAction { return []ManifestAction{ "TRANSFER", @@ -372,8 +391,9 @@ const ( ) // Values returns all known values for ManifestFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManifestFormat) Values() []ManifestFormat { return []ManifestFormat{ "CSV", @@ -389,8 +409,9 @@ const ( ) // 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. +// the future, and so 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{ "NONE", @@ -409,8 +430,9 @@ const ( ) // Values returns all known values for NfsVersion. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NfsVersion) Values() []NfsVersion { return []NfsVersion{ "AUTOMATIC", @@ -430,6 +452,7 @@ const ( // Values returns all known values for ObjectStorageServerProtocol. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ObjectStorageServerProtocol) Values() []ObjectStorageServerProtocol { return []ObjectStorageServerProtocol{ @@ -447,8 +470,9 @@ const ( ) // Values returns all known values for ObjectTags. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectTags) Values() []ObjectTags { return []ObjectTags{ "PRESERVE", @@ -465,8 +489,9 @@ const ( ) // Values returns all known values for ObjectVersionIds. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectVersionIds) Values() []ObjectVersionIds { return []ObjectVersionIds{ "INCLUDE", @@ -491,8 +516,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "Equals", @@ -517,8 +543,9 @@ const ( ) // Values returns all known values for OverwriteMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverwriteMode) Values() []OverwriteMode { return []OverwriteMode{ "ALWAYS", @@ -536,8 +563,9 @@ const ( ) // Values returns all known values for PhaseStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhaseStatus) Values() []PhaseStatus { return []PhaseStatus{ "PENDING", @@ -555,8 +583,9 @@ const ( ) // Values returns all known values for PosixPermissions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PosixPermissions) Values() []PosixPermissions { return []PosixPermissions{ "NONE", @@ -573,8 +602,9 @@ const ( ) // Values returns all known values for PreserveDeletedFiles. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreserveDeletedFiles) Values() []PreserveDeletedFiles { return []PreserveDeletedFiles{ "PRESERVE", @@ -591,8 +621,9 @@ const ( ) // Values returns all known values for PreserveDevices. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreserveDevices) Values() []PreserveDevices { return []PreserveDevices{ "NONE", @@ -611,8 +642,9 @@ const ( ) // Values returns all known values for RecommendationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationStatus) Values() []RecommendationStatus { return []RecommendationStatus{ "NONE", @@ -631,8 +663,9 @@ const ( ) // Values returns all known values for ReportLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportLevel) Values() []ReportLevel { return []ReportLevel{ "ERRORS_ONLY", @@ -649,8 +682,9 @@ const ( ) // Values returns all known values for ReportOutputType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportOutputType) Values() []ReportOutputType { return []ReportOutputType{ "SUMMARY_ONLY", @@ -673,8 +707,9 @@ const ( ) // Values returns all known values for S3StorageClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3StorageClass) Values() []S3StorageClass { return []S3StorageClass{ "STANDARD", @@ -697,8 +732,9 @@ const ( ) // Values returns all known values for ScheduleDisabledBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleDisabledBy) Values() []ScheduleDisabledBy { return []ScheduleDisabledBy{ "USER", @@ -715,8 +751,9 @@ const ( ) // Values returns all known values for ScheduleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleStatus) Values() []ScheduleStatus { return []ScheduleStatus{ "ENABLED", @@ -735,8 +772,9 @@ const ( // Values returns all known values for SmbSecurityDescriptorCopyFlags. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmbSecurityDescriptorCopyFlags) Values() []SmbSecurityDescriptorCopyFlags { return []SmbSecurityDescriptorCopyFlags{ "NONE", @@ -757,8 +795,9 @@ const ( ) // Values returns all known values for SmbVersion. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmbVersion) Values() []SmbVersion { return []SmbVersion{ "AUTOMATIC", @@ -780,8 +819,9 @@ const ( // Values returns all known values for StorageSystemConnectivityStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageSystemConnectivityStatus) Values() []StorageSystemConnectivityStatus { return []StorageSystemConnectivityStatus{ "PASS", @@ -804,8 +844,9 @@ const ( ) // Values returns all known values for TaskExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskExecutionStatus) Values() []TaskExecutionStatus { return []TaskExecutionStatus{ "QUEUED", @@ -827,8 +868,9 @@ const ( ) // Values returns all known values for TaskFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskFilterName) Values() []TaskFilterName { return []TaskFilterName{ "LocationId", @@ -845,8 +887,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -866,8 +909,9 @@ const ( ) // Values returns all known values for TaskStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatus) Values() []TaskStatus { return []TaskStatus{ "AVAILABLE", @@ -887,8 +931,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -907,8 +952,9 @@ const ( ) // Values returns all known values for Uid. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Uid) Values() []Uid { return []Uid{ "NONE", @@ -928,8 +974,9 @@ const ( ) // Values returns all known values for VerifyMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifyMode) Values() []VerifyMode { return []VerifyMode{ "POINT_IN_TIME_CONSISTENT", diff --git a/service/datasync/types/types.go b/service/datasync/types/types.go index 4f99c606f9b..117ae07b09b 100644 --- a/service/datasync/types/types.go +++ b/service/datasync/types/types.go @@ -8,8 +8,9 @@ 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) -// operation. +// the [ListAgents]operation. +// +// [ListAgents]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html type AgentListEntry struct { // The Amazon Resource Name (ARN) of a DataSync agent. @@ -22,24 +23,34 @@ type AgentListEntry struct { Platform *Platform // The status of an agent. + // // - If the status is ONLINE , the agent is configured properly and ready to use. + // // - If the status is OFFLINE , the agent has been out of contact with DataSync // for five minutes or longer. This can happen for a few reasons. For more - // information, see What do I do if my agent is offline? (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) + // information, see [What do I do if my agent is offline?] + // + // [What do I do if my agent is offline?]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline Status AgentStatus noSmithyDocumentSerde } // The shared access signature (SAS) configuration that allows DataSync to access -// your Microsoft Azure Blob Storage. For more information, see SAS tokens (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) -// for accessing your Azure Blob Storage. +// your Microsoft Azure Blob Storage. +// +// For more information, see [SAS tokens] for accessing your Azure Blob Storage. +// +// [SAS tokens]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens type AzureBlobSasConfiguration struct { // Specifies a SAS token that provides permissions to access your Azure Blob - // Storage. The token is part of the SAS URI string that comes after the storage - // resource URI and a question mark. A token looks something like this: - // sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D + // Storage. + // + // The token is part of the SAS URI string that comes after the storage resource + // URI and a question mark. A token looks something like this: + // + // sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D // // This member is required. Token *string @@ -69,10 +80,12 @@ type Capacity struct { } // The credentials that provide DataSync Discovery read access to your on-premises -// storage system's management interface. DataSync Discovery stores these -// credentials in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) -// . For more information, see Accessing your on-premises storage system (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html) -// . +// storage system's management interface. +// +// DataSync Discovery stores these credentials in [Secrets Manager]. For more information, see [Accessing your on-premises storage system]. +// +// [Accessing your on-premises storage system]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html +// [Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html type Credentials struct { // Specifies the password for your storage system's management interface. @@ -94,8 +107,9 @@ type DiscoveryJobListEntry struct { // The Amazon Resource Name (ARN) of a discovery job. DiscoveryJobArn *string - // The status of a discovery job. For more information, see Discovery job statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table) - // . + // The status of a discovery job. For more information, see [Discovery job statuses]. + // + // [Discovery job statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table Status DiscoveryJobStatus noSmithyDocumentSerde @@ -126,13 +140,20 @@ 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) - // for managing traffic during your transfer. The subnet must be located: + // Specifies the ARN of a subnet where DataSync creates the [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. // + // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces + // // This member is required. SubnetArn *string @@ -183,8 +204,9 @@ 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]. +// +// [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. @@ -193,17 +215,21 @@ type FsxProtocolSmb struct { Password *string // Specifies a user that can mount and access the files, folders, and metadata in - // your SVM. For information about choosing a user with the right level of access - // for your transfer, see Using the SMB protocol (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb) - // . + // your SVM. + // + // For information about choosing a user with the right level of access for your + // transfer, see [Using the SMB protocol]. + // + // [Using the SMB protocol]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb // // This member is required. User *string // Specifies the fully qualified domain name (FQDN) of the Microsoft Active - // Directory that your storage virtual machine (SVM) belongs to. If you have - // multiple domains in your environment, configuring this setting makes sure that - // DataSync connects to the right SVM. + // Directory that your storage virtual machine (SVM) belongs to. + // + // If you have multiple domains in your environment, configuring this setting + // makes sure that DataSync connects to the right SVM. Domain *string // Specifies the version of the Server Message Block (SMB) protocol that DataSync @@ -271,9 +297,11 @@ type Latency struct { // 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) -// . +// "Operator": "Equals" , and "Values": "S3" . +// +// For more information, see [filtering resources]. +// +// [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 @@ -298,8 +326,9 @@ 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) -// operation is called. +// array that contains a list of locations when the [ListLocations]operation is called. +// +// [ListLocations]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html type LocationListEntry struct { // The Amazon Resource Name (ARN) of the location. For Network File System (NFS) @@ -308,42 +337,52 @@ type LocationListEntry struct { 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 - // 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 - // 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 - // that you mount to and treat as the root of the location. + // contains a list of locations when the [ListLocations]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 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 that you mount to and treat as the root of + // the location. + // + // [ListLocations]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html LocationUri *string noSmithyDocumentSerde } // Configures a manifest, which is a list of files or objects that you want -// DataSync to transfer. For more information and configuration examples, see -// Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) -// . +// DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. +// +// [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html type ManifestConfig struct { // Specifies what DataSync uses the manifest for. Action ManifestAction - // Specifies the file format of your manifest. For more information, see Creating - // a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create) - // . + // Specifies the file format of your manifest. For more information, see [Creating a manifest]. + // + // [Creating a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create Format ManifestFormat - // Specifies the manifest that you want DataSync to use and where it's hosted. You - // must specify this parameter if you're configuring a new manifest on or after - // February 7, 2024. If you don't, you'll get a 400 status code and - // ValidationException error stating that you're missing the IAM role for DataSync - // to access the S3 bucket where you're hosting your manifest. For more - // information, see Providing DataSync access to your manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access) - // . + // Specifies the manifest that you want DataSync to use and where it's hosted. + // + // You must specify this parameter if you're configuring a new manifest on or + // after February 7, 2024. + // + // If you don't, you'll get a 400 status code and ValidationException error + // stating that you're missing the IAM role for DataSync to access the S3 bucket + // where you're hosting your manifest. For more information, see [Providing DataSync access to your manifest]. + // + // [Providing DataSync access to your manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access Source *SourceManifestConfig noSmithyDocumentSerde @@ -423,15 +462,17 @@ type NetAppONTAPCluster struct { NfsExportedVolumes *int64 // Indicates whether DataSync Discovery recommendations for the cluster are ready - // to view, incomplete, or can't be determined. For more information, see - // Recommendation statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table) - // . + // to view, incomplete, or can't be determined. + // + // For more information, see [Recommendation statuses]. + // + // [Recommendation statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table RecommendationStatus RecommendationStatus // The Amazon Web Services storage services that DataSync Discovery recommends for - // the cluster. For more information, see Recommendations provided by DataSync - // Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) - // . + // the cluster. For more information, see [Recommendations provided by DataSync Discovery]. + // + // [Recommendations provided by DataSync Discovery]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html Recommendations []Recommendation // The universally unique identifier (UUID) of the cluster. @@ -463,15 +504,17 @@ type NetAppONTAPSVM struct { NfsExportedVolumes *int64 // Indicates whether DataSync Discovery recommendations for the SVM are ready to - // view, incomplete, or can't be determined. For more information, see - // Recommendation statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table) - // . + // view, incomplete, or can't be determined. + // + // For more information, see [Recommendation statuses]. + // + // [Recommendation statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table RecommendationStatus RecommendationStatus // The Amazon Web Services storage services that DataSync Discovery recommends for - // the SVM. For more information, see Recommendations provided by DataSync - // Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) - // . + // the SVM. For more information, see [Recommendations provided by DataSync Discovery]. + // + // [Recommendations provided by DataSync Discovery]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html Recommendations []Recommendation // The UUID of the SVM. @@ -523,15 +566,17 @@ type NetAppONTAPVolume struct { NfsExported bool // Indicates whether DataSync Discovery recommendations for the volume are ready - // to view, incomplete, or can't be determined. For more information, see - // Recommendation statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table) - // . + // to view, incomplete, or can't be determined. + // + // For more information, see [Recommendation statuses]. + // + // [Recommendation statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table RecommendationStatus RecommendationStatus // The Amazon Web Services storage services that DataSync Discovery recommends for - // the volume. For more information, see Recommendations provided by DataSync - // Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) - // . + // the volume. For more information, see [Recommendations provided by DataSync Discovery]. + // + // [Recommendations provided by DataSync Discovery]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html Recommendations []Recommendation // The universally unique identifier (UUID) of the volume. @@ -559,16 +604,22 @@ type NetAppONTAPVolume struct { 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: + // 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. Version NfsVersion @@ -591,22 +642,32 @@ type OnPremConfig struct { // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth -// limits for your task, among other options. Each option has a default value. -// Unless you need to, you don't have to configure any option before calling -// StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) -// . You also can override your task options for each task execution. For example, +// limits for your task, among other options. +// +// Each option has a default value. Unless you need to, you don't have to +// configure any option before calling [StartTaskExecution]. +// +// You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. +// +// [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html type Options struct { // Specifies whether to preserve metadata indicating the last time a file was read - // or written to. The behavior of Atime isn't fully standard across platforms, so - // DataSync can only do this on a best-effort basis. + // or written to. + // + // The behavior of Atime isn't fully standard across platforms, so DataSync can + // only do this on a best-effort basis. + // // - BEST_EFFORT (default) - DataSync attempts to preserve the original Atime // attribute on all source files (that is, the version before the PREPARING phase // of the task execution). This option is recommended. + // // - NONE - Ignores 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 . + // + // 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 @@ -614,30 +675,41 @@ type Options struct { BytesPerSecond *int64 // Specifies the POSIX group ID (GID) of the file's owners. + // // - INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, // which is recommended. + // // - NONE - Ignores UID and GID. - // For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) - // . + // + // For more information, see [Metadata copied by DataSync]. + // + // [Metadata copied by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied 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) - // . - // - BASIC - Publishes logs with only basic information (such as transfer - // errors). + // log group. To specify the log group, see [CloudWatchLogGroupArn]. + // + // - BASIC - Publishes logs with only basic information (such as transfer errors). + // // - TRANSFER - Publishes logs for all files or objects that your DataSync task // transfers and performs data-integrity checks on. + // // - OFF - No logs are published. + // + // [CloudWatchLogGroupArn]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn 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. + // // - PRESERVE (default) - Preserves original Mtime , which is recommended. + // // - NONE - Ignores 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 . + // + // 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 you want DataSync to PRESERVE object tags (default behavior) @@ -647,121 +719,164 @@ type Options struct { // Specifies whether DataSync should modify or preserve data at the destination // location. + // // - ALWAYS (default) - DataSync modifies data in the destination location when - // source data (including metadata) has changed. If DataSync overwrites objects, - // you might incur additional charges for certain Amazon S3 storage classes (for - // example, for retrieval or early deletion). For more information, see Storage - // class considerations with Amazon S3 transfers (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) - // . + // source data (including metadata) has changed. + // + // If DataSync overwrites objects, you might incur additional charges for certain + // Amazon S3 storage classes (for example, for retrieval or early deletion). For + // more information, see [Storage class considerations with Amazon S3 transfers]. + // // - NEVER - DataSync doesn't overwrite data in the destination location even if // the source data has changed. You can use this option to protect against // overwriting changes made to files or objects in the destination. + // + // [Storage class considerations with Amazon S3 transfers]: 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) - // . - // - PRESERVE (default) - Preserves POSIX-style permissions, which is - // recommended. + // as reading, writing, or execution of the file. + // + // For more information, see [Metadata copied by DataSync]. + // + // - PRESERVE (default) - Preserves POSIX-style permissions, which is recommended. + // // - NONE - Ignores POSIX-style permissions. + // // DataSync can preserve extant permissions of a source location. + // + // [Metadata copied by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied 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) - // . + // for certain storage classes. For detailed information, see [Considerations when working with Amazon S3 storage classes in DataSync]. + // // - PRESERVE (default) - Ignores such destination files, which is recommended. + // // - REMOVE - Deletes 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. + // + // [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 PreserveDeletedFiles PreserveDeletedFiles // Specifies whether DataSync should preserve the metadata of block and character // devices in the source location and recreate the files with that device name and // 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. + // 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. + // // - NONE (default) - Ignores special devices (recommended). + // // - PRESERVE - Preserves 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) - // . + // 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]. + // // - OWNER_DACL (default) - 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. + // 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 with the right permissions, see required permissions for SMB (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) - // , FSx for Windows File Server (https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions) - // , or FSx for ONTAP (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb) - // (depending on the type of location in your transfer). + // 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 + // with the right permissions, see required permissions for [SMB], [FSx for Windows File Server], or [FSx for ONTAP](depending on + // the type of location in your transfer). + // // - 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. + // + // [FSx for Windows File Server]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions + // [how DataSync handles metadata]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html + // [SMB]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions + // [FSx for ONTAP]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb SecurityDescriptorCopyFlags SmbSecurityDescriptorCopyFlags // Specifies whether your transfer tasks should be put into a queue during certain - // scenarios when running multiple tasks (https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks) - // . This is ENABLED by default. + // scenarios when [running multiple tasks]. This is ENABLED by default. + // + // [running multiple tasks]: https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks 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 (default) - DataSync copies only data or metadata that is new or // different content from the source location to the destination location. + // // - ALL - DataSync copies everything in the source to the destination without // comparing differences between the locations. TransferMode TransferMode // Specifies the POSIX user ID (UID) of the file's owner. + // // - INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), // which is recommended. + // // - NONE - Ignores UID and GID. - // For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied) - // . + // + // For more information, see [Metadata copied by DataSync]. + // + // [Metadata copied by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied Uid Uid // Specifies how and when DataSync checks the integrity of your data during a // transfer. + // // - 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) - // . + // 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]. + // // - POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync // scans the entire source and destination to verify that both locations are fully - // synchronized. If you use a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) - // , DataSync only scans and verifies what's listed in the manifest. 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) - // . + // synchronized. + // + // If you use a [manifest], DataSync only scans and verifies what's listed in the manifest. + // + // 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]. + // // - 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 + // [manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html VerifyMode VerifyMode noSmithyDocumentSerde @@ -796,13 +911,15 @@ type Platform struct { noSmithyDocumentSerde } -// Specifies how your DataSync agent connects to Amazon Web Services using a -// virtual private cloud (VPC) service endpoint (https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc) -// . An agent that uses a VPC endpoint isn't accessible over the public internet. +// Specifies how your DataSync agent connects to Amazon Web Services using a [virtual private cloud (VPC) service endpoint]. An +// agent that uses a VPC endpoint isn't accessible over the public internet. +// +// [virtual private cloud (VPC) service endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc type PrivateLinkConfig struct { - // Specifies the VPC endpoint provided by Amazon Web Services PrivateLink (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html) - // that your agent connects to. + // Specifies the VPC endpoint provided by [Amazon Web Services PrivateLink] that your agent connects to. + // + // [Amazon Web Services PrivateLink]: https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html PrivateLinkEndpoint *string // Specifies the Amazon Resource Names (ARN) of the security group that provides @@ -838,9 +955,11 @@ type QopConfiguration struct { } // The details about an Amazon Web Services storage service that DataSync -// Discovery recommends for a resource in your on-premises storage system. For more -// information, see Recommendations provided by DataSync Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) -// . +// Discovery recommends for a resource in your on-premises storage system. +// +// For more information, see [Recommendations provided by DataSync Discovery]. +// +// [Recommendations provided by DataSync Discovery]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html type Recommendation struct { // The estimated monthly cost of the recommended Amazon Web Services storage @@ -859,8 +978,9 @@ type Recommendation struct { noSmithyDocumentSerde } -// Specifies where DataSync uploads your task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) -// . +// Specifies where DataSync uploads your [task report]. +// +// [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html type ReportDestination struct { // Specifies the Amazon S3 bucket where DataSync uploads your task report. @@ -869,14 +989,15 @@ type ReportDestination struct { noSmithyDocumentSerde } -// Specifies the Amazon S3 bucket where DataSync uploads your task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) -// . +// Specifies the Amazon S3 bucket where DataSync uploads your [task report]. +// +// [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html type ReportDestinationS3 struct { // Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync - // to upload a task report to your S3 bucket. For more information, see Allowing - // DataSync to upload a task report to an Amazon S3 bucket (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) - // . + // to upload a task report to your S3 bucket. For more information, see [Allowing DataSync to upload a task report to an Amazon S3 bucket]. + // + // [Allowing DataSync to upload a task report to an Amazon S3 bucket]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html // // This member is required. BucketAccessRoleArn *string @@ -892,31 +1013,35 @@ type ReportDestinationS3 struct { noSmithyDocumentSerde } -// Specifies the level of detail for a particular aspect of your DataSync task -// report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) -// . +// Specifies the level of detail for a particular aspect of your DataSync [task report]. +// +// [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html type ReportOverride struct { - // Specifies whether your task report includes errors only or successes and - // errors. For example, your report might mostly include only what didn't go well - // in your transfer ( ERRORS_ONLY ). At the same time, you want to verify that your - // task filter (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) - // is working correctly. In this situation, you can get a list of what files - // DataSync successfully skipped and if something transferred that you didn't to - // transfer ( SUCCESSES_AND_ERRORS ). + // Specifies whether your task report includes errors only or successes and errors. + // + // For example, your report might mostly include only what didn't go well in your + // transfer ( ERRORS_ONLY ). At the same time, you want to verify that your [task filter] is + // working correctly. In this situation, you can get a list of what files DataSync + // successfully skipped and if something transferred that you didn't to transfer ( + // SUCCESSES_AND_ERRORS ). + // + // [task filter]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html ReportLevel ReportLevel noSmithyDocumentSerde } -// The level of detail included in each aspect of your DataSync task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) -// . +// The level of detail included in each aspect of your DataSync [task report]. +// +// [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html type ReportOverrides struct { // Specifies the level of reporting for the files, objects, and directories that // DataSync attempted to delete in your destination location. This only applies if - // you configure your task (https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) - // to delete data in the destination that isn't in the source. + // you [configure your task]to delete data in the destination that isn't in the source. + // + // [configure your task]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html Deleted *ReportOverride // Specifies the level of reporting for the files, objects, and directories that @@ -934,8 +1059,9 @@ type ReportOverrides struct { noSmithyDocumentSerde } -// Indicates whether DataSync created a complete task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) -// for your transfer. +// Indicates whether DataSync created a complete [task report] for your transfer. +// +// [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html type ReportResult struct { // Indicates the code associated with the error if DataSync can't create a @@ -996,9 +1122,11 @@ type ResourceMetrics struct { } // Specifies the Amazon Resource Name (ARN) of the Identity and Access Management -// (IAM) role that DataSync uses to access your S3 bucket. For more information, -// see Accessing S3 buckets (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access) -// . +// (IAM) role that DataSync uses to access your S3 bucket. +// +// For more information, see [Accessing S3 buckets]. +// +// [Accessing S3 buckets]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access type S3Config struct { // Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket. @@ -1010,15 +1138,15 @@ type S3Config struct { } // Specifies the S3 bucket where you're hosting the manifest that you want -// DataSync to use. For more information and configuration examples, see -// Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) -// . +// DataSync to use. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. +// +// [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html type S3ManifestConfig struct { // Specifies the Identity and Access Management (IAM) role that allows DataSync to - // access your manifest. For more information, see Providing DataSync access to - // your manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access) - // . + // access your manifest. For more information, see [Providing DataSync access to your manifest]. + // + // [Providing DataSync access to your manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access // // This member is required. BucketAccessRoleArn *string @@ -1049,27 +1177,36 @@ type SmbMountOptions struct { // By default, DataSync automatically chooses an SMB protocol version based on // negotiation with your SMB file server. You also can configure DataSync to use a // 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: + // 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 the highest - // version of SMB that they mutually support between 2.1 and 3.1.1. 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. + // version of SMB that they mutually support between 2.1 and 3.1.1. + // + // 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) - // . + // + // - 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]. + // + // [creating an Amazon FSx for NetApp ONTAP location]: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html Version SmbVersion noSmithyDocumentSerde } // Specifies the manifest that you want DataSync to use and where it's hosted. For -// more information and configuration examples, see Specifying what DataSync -// transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) -// . +// more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. +// +// [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html type SourceManifestConfig struct { // Specifies the S3 bucket where you're hosting your manifest. @@ -1110,13 +1247,14 @@ type TagListEntry struct { } // Represents a single entry in a list of DataSync task executions that's returned -// with the ListTaskExecutions (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) -// operation. +// with the [ListTaskExecutions]operation. +// +// [ListTaskExecutions]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html type TaskExecutionListEntry struct { - // The status of a task execution. For more information, see Task execution - // statuses (https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses) - // . + // The status of a task execution. For more information, see [Task execution statuses]. + // + // [Task execution statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses Status TaskExecutionStatus // The Amazon Resource Name (ARN) of a task execution. @@ -1166,8 +1304,11 @@ 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 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]. +// +// [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 @@ -1192,9 +1333,11 @@ 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) -// operation is called. A task includes the source and destination file systems to -// sync and the options to use for the tasks. +// that contains a list of tasks when the [ListTasks]operation is called. A task includes the +// source and destination file systems to sync and the options to use for the +// tasks. +// +// [ListTasks]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html type TaskListEntry struct { // The name of the task. @@ -1210,26 +1353,31 @@ type TaskListEntry struct { } // Specifies how you want to configure a task report, which provides detailed -// information about for your DataSync transfer. For more information, see Task -// reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) -// . +// information about for your DataSync transfer. +// +// For more information, see [Task reports]. +// +// [Task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html type TaskReportConfig struct { // Specifies the Amazon S3 bucket where DataSync uploads your task report. For - // more information, see Task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access) - // . + // more information, see [Task reports]. + // + // [Task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access Destination *ReportDestination // Specifies whether your task report includes the new version of each object - // transferred into an S3 bucket. This only applies if you enable versioning on - // your bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html) - // . Keep in mind that setting this to INCLUDE can increase the duration of your - // task execution. + // transferred into an S3 bucket. This only applies if you [enable versioning on your bucket]. Keep in mind that + // setting this to INCLUDE can increase the duration of your task execution. + // + // [enable versioning on your bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html ObjectVersionIds ObjectVersionIds // Specifies the type of task report that you want: + // // - SUMMARY_ONLY : Provides necessary details about your task, including the // number of files, objects, and directories transferred and transfer duration. + // // - STANDARD : Provides complete details about your task, including a full list // of files, objects, and directories that were transferred, skipped, verified, and // more. @@ -1243,8 +1391,10 @@ type TaskReportConfig struct { // Specifies whether you want your task report to include only what went wrong // with your transfer or a list of what succeeded and didn't. + // // - ERRORS_ONLY : A report shows what DataSync was unable to transfer, skip, // verify, and delete. + // // - SUCCESSES_AND_ERRORS : A report shows what DataSync was able and unable to // transfer, skip, verify, and delete. ReportLevel ReportLevel @@ -1252,13 +1402,15 @@ type TaskReportConfig struct { noSmithyDocumentSerde } -// Configures your DataSync task to run on a schedule (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) -// (at a minimum interval of 1 hour). +// Configures your DataSync task to run on a [schedule] (at a minimum interval of 1 hour). +// +// [schedule]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html type TaskSchedule struct { // Specifies your task schedule by using a cron expression in UTC time. For - // information about cron expression syntax, see the Amazon EventBridge User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html) - // . + // information about cron expression syntax, see the [Amazon EventBridge User Guide]. + // + // [Amazon EventBridge User Guide]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html // // This member is required. ScheduleExpression *string @@ -1266,32 +1418,43 @@ type TaskSchedule struct { // Specifies whether to enable or disable your task schedule. Your schedule is // enabled by default, but there can be situations where you need to disable it. // For example, you might need to pause a recurring transfer to fix an issue with - // your task or perform maintenance on your storage system. DataSync might disable - // your schedule automatically if your task fails repeatedly with the same error. - // For more information, see TaskScheduleDetails (https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html) - // . + // your task or perform maintenance on your storage system. + // + // DataSync might disable your schedule automatically if your task fails + // repeatedly with the same error. For more information, see [TaskScheduleDetails]. + // + // [TaskScheduleDetails]: https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html Status ScheduleStatus noSmithyDocumentSerde } -// Provides information about your DataSync task schedule (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) -// . +// Provides information about your DataSync [task schedule]. +// +// [task schedule]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html type TaskScheduleDetails struct { // Indicates how your task schedule was disabled. - // - USER - Your schedule was manually disabled by using the UpdateTask (https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html) - // operation or DataSync console. + // + // - USER - Your schedule was manually disabled by using the [UpdateTask]operation or + // DataSync console. + // // - SERVICE - Your schedule was automatically disabled by DataSync because the // task failed repeatedly with the same error. + // + // [UpdateTask]: https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html DisabledBy ScheduleDisabledBy - // Provides a reason if the task schedule is disabled. If your schedule is - // disabled by USER , you see a Manually disabled by user. message. If your - // schedule is disabled by SERVICE , you see an error message to help you + // Provides a reason if the task schedule is disabled. + // + // If your schedule is disabled by USER , you see a Manually disabled by user. + // message. + // + // If your schedule is disabled by SERVICE , you see an error message to help you // understand why the task keeps failing. For information on resolving DataSync - // errors, see Troubleshooting issues with DataSync transfers (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html) - // . + // errors, see [Troubleshooting issues with DataSync transfers]. + // + // [Troubleshooting issues with DataSync transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html DisabledReason *string // Indicates the last time the status of your task schedule changed. For example, diff --git a/service/datazone/api_op_CreateAsset.go b/service/datazone/api_op_CreateAsset.go index f355d79e8be..cdc1d52ea2b 100644 --- a/service/datazone/api_op_CreateAsset.go +++ b/service/datazone/api_op_CreateAsset.go @@ -139,7 +139,8 @@ type CreateAssetOutput struct { // The glossary terms that are attached to the created asset. GlossaryTerms []string - // The latest data point that was imported into the time series form for the asset. + // The latest data point that was imported into the time series form for the + // asset. LatestTimeSeriesDataPointFormsOutput []types.TimeSeriesDataPointSummaryFormOutput // The details of an asset published in an Amazon DataZone catalog. diff --git a/service/datazone/api_op_CreateAssetRevision.go b/service/datazone/api_op_CreateAssetRevision.go index 33d25c2f932..cacd46ec28b 100644 --- a/service/datazone/api_op_CreateAssetRevision.go +++ b/service/datazone/api_op_CreateAssetRevision.go @@ -132,7 +132,8 @@ type CreateAssetRevisionOutput struct { // The glossary terms that were attached to the asset as part of asset revision. GlossaryTerms []string - // The latest data point that was imported into the time series form for the asset. + // The latest data point that was imported into the time series form for the + // asset. LatestTimeSeriesDataPointFormsOutput []types.TimeSeriesDataPointSummaryFormOutput // The details of an asset published in an Amazon DataZone catalog. diff --git a/service/datazone/api_op_CreateGroupProfile.go b/service/datazone/api_op_CreateGroupProfile.go index 89e05a2a8a1..70786dc3ccf 100644 --- a/service/datazone/api_op_CreateGroupProfile.go +++ b/service/datazone/api_op_CreateGroupProfile.go @@ -40,7 +40,7 @@ type CreateGroupProfileInput struct { // This member is required. GroupIdentifier *string - // A unique, case-sensitive identifier that is provided to ensure the idempotency + // A unique, case-sensitive identifier that is provided to ensure the idempotency // of the request. ClientToken *string diff --git a/service/datazone/api_op_GetAsset.go b/service/datazone/api_op_GetAsset.go index 6043c73f0e8..49b9fd1a767 100644 --- a/service/datazone/api_op_GetAsset.go +++ b/service/datazone/api_op_GetAsset.go @@ -109,7 +109,8 @@ type GetAssetOutput struct { // The business glossary terms attached to the asset. GlossaryTerms []string - // The latest data point that was imported into the time series form for the asset. + // The latest data point that was imported into the time series form for the + // asset. LatestTimeSeriesDataPointFormsOutput []types.TimeSeriesDataPointSummaryFormOutput // The listing of the asset. diff --git a/service/datazone/options.go b/service/datazone/options.go index 5d525a95222..e5f53eb7b9a 100644 --- a/service/datazone/options.go +++ b/service/datazone/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/datazone/types/enums.go b/service/datazone/types/enums.go index a70fa86d589..237c1c89c63 100644 --- a/service/datazone/types/enums.go +++ b/service/datazone/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AcceptRuleBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceptRuleBehavior) Values() []AcceptRuleBehavior { return []AcceptRuleBehavior{ "ALL", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AuthType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthType) Values() []AuthType { return []AuthType{ "IAM_IDC", @@ -47,8 +49,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "PUBLISH", @@ -66,8 +69,9 @@ const ( // Values returns all known values for ConfigurableActionTypeAuthorization. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurableActionTypeAuthorization) Values() []ConfigurableActionTypeAuthorization { return []ConfigurableActionTypeAuthorization{ "IAM", @@ -90,8 +94,9 @@ const ( ) // Values returns all known values for DataAssetActivityStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataAssetActivityStatus) Values() []DataAssetActivityStatus { return []DataAssetActivityStatus{ "FAILED", @@ -119,8 +124,9 @@ const ( ) // Values returns all known values for DataSourceErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceErrorType) Values() []DataSourceErrorType { return []DataSourceErrorType{ "ACCESS_DENIED_EXCEPTION", @@ -145,8 +151,9 @@ const ( ) // Values returns all known values for DataSourceRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceRunStatus) Values() []DataSourceRunStatus { return []DataSourceRunStatus{ "REQUESTED", @@ -166,8 +173,9 @@ const ( ) // Values returns all known values for DataSourceRunType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceRunType) Values() []DataSourceRunType { return []DataSourceRunType{ "PRIORITIZED", @@ -190,8 +198,9 @@ const ( ) // Values returns all known values for DataSourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceStatus) Values() []DataSourceStatus { return []DataSourceStatus{ "CREATING", @@ -216,8 +225,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "IN_PROGRESS", @@ -237,8 +247,9 @@ const ( ) // Values returns all known values for DeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentType) Values() []DeploymentType { return []DeploymentType{ "CREATE", @@ -260,8 +271,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "CREATING", @@ -282,8 +294,9 @@ const ( ) // Values returns all known values for EnableSetting. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnableSetting) Values() []EnableSetting { return []EnableSetting{ "ENABLED", @@ -299,8 +312,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "ASSET", @@ -327,8 +341,9 @@ const ( ) // Values returns all known values for EnvironmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentStatus) Values() []EnvironmentStatus { return []EnvironmentStatus{ "ACTIVE", @@ -356,8 +371,9 @@ const ( ) // Values returns all known values for FilterExpressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterExpressionType) Values() []FilterExpressionType { return []FilterExpressionType{ "INCLUDE", @@ -374,8 +390,9 @@ const ( ) // Values returns all known values for FormTypeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormTypeStatus) Values() []FormTypeStatus { return []FormTypeStatus{ "ENABLED", @@ -392,8 +409,9 @@ const ( ) // Values returns all known values for GlossaryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlossaryStatus) Values() []GlossaryStatus { return []GlossaryStatus{ "DISABLED", @@ -410,8 +428,9 @@ const ( ) // Values returns all known values for GlossaryTermStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlossaryTermStatus) Values() []GlossaryTermStatus { return []GlossaryTermStatus{ "ENABLED", @@ -428,8 +447,9 @@ const ( ) // Values returns all known values for GroupProfileStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupProfileStatus) Values() []GroupProfileStatus { return []GroupProfileStatus{ "ASSIGNED", @@ -446,8 +466,9 @@ const ( ) // Values returns all known values for GroupSearchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupSearchType) Values() []GroupSearchType { return []GroupSearchType{ "SSO_GROUP", @@ -465,8 +486,9 @@ const ( ) // Values returns all known values for InventorySearchScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InventorySearchScope) Values() []InventorySearchScope { return []InventorySearchScope{ "ASSET", @@ -485,8 +507,9 @@ const ( ) // Values returns all known values for ListingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListingStatus) Values() []ListingStatus { return []ListingStatus{ "CREATING", @@ -508,6 +531,7 @@ const ( // Values returns all known values for MetadataGenerationRunStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MetadataGenerationRunStatus) Values() []MetadataGenerationRunStatus { return []MetadataGenerationRunStatus{ @@ -528,6 +552,7 @@ const ( // Values returns all known values for MetadataGenerationRunType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MetadataGenerationRunType) Values() []MetadataGenerationRunType { return []MetadataGenerationRunType{ @@ -544,8 +569,9 @@ const ( // Values returns all known values for MetadataGenerationTargetType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetadataGenerationTargetType) Values() []MetadataGenerationTargetType { return []MetadataGenerationTargetType{ "ASSET", @@ -561,6 +587,7 @@ const ( // Values returns all known values for NotificationResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NotificationResourceType) Values() []NotificationResourceType { return []NotificationResourceType{ @@ -580,8 +607,9 @@ const ( ) // Values returns all known values for NotificationRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationRole) Values() []NotificationRole { return []NotificationRole{ "PROJECT_OWNER", @@ -601,8 +629,9 @@ const ( ) // Values returns all known values for NotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationType) Values() []NotificationType { return []NotificationType{ "TASK", @@ -620,8 +649,9 @@ const ( ) // Values returns all known values for ProjectStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectStatus) Values() []ProjectStatus { return []ProjectStatus{ "ACTIVE", @@ -639,8 +669,9 @@ const ( ) // Values returns all known values for RejectRuleBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RejectRuleBehavior) Values() []RejectRuleBehavior { return []RejectRuleBehavior{ "ALL", @@ -658,8 +689,9 @@ const ( // Values returns all known values for SearchOutputAdditionalAttribute. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchOutputAdditionalAttribute) Values() []SearchOutputAdditionalAttribute { return []SearchOutputAdditionalAttribute{ "FORMS", @@ -675,8 +707,9 @@ const ( ) // Values returns all known values for SortFieldProject. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortFieldProject) Values() []SortFieldProject { return []SortFieldProject{ "NAME", @@ -692,8 +725,9 @@ const ( ) // Values returns all known values for SortKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortKey) Values() []SortKey { return []SortKey{ "CREATED_AT", @@ -710,8 +744,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -734,8 +769,9 @@ const ( // Values returns all known values for SubscriptionGrantOverallStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionGrantOverallStatus) Values() []SubscriptionGrantOverallStatus { return []SubscriptionGrantOverallStatus{ "PENDING", @@ -763,8 +799,9 @@ const ( ) // Values returns all known values for SubscriptionGrantStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionGrantStatus) Values() []SubscriptionGrantStatus { return []SubscriptionGrantStatus{ "GRANT_PENDING", @@ -789,6 +826,7 @@ const ( // Values returns all known values for SubscriptionRequestStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionRequestStatus) Values() []SubscriptionRequestStatus { return []SubscriptionRequestStatus{ @@ -808,8 +846,9 @@ const ( ) // Values returns all known values for SubscriptionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionStatus) Values() []SubscriptionStatus { return []SubscriptionStatus{ "APPROVED", @@ -827,8 +866,9 @@ const ( ) // Values returns all known values for TaskStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatus) Values() []TaskStatus { return []TaskStatus{ "ACTIVE", @@ -845,8 +885,9 @@ const ( ) // Values returns all known values for TimeSeriesEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeSeriesEntityType) Values() []TimeSeriesEntityType { return []TimeSeriesEntityType{ "ASSET", @@ -925,8 +966,9 @@ const ( ) // Values returns all known values for Timezone. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Timezone) Values() []Timezone { return []Timezone{ "UTC", @@ -1005,8 +1047,9 @@ const ( ) // Values returns all known values for TypesSearchScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TypesSearchScope) Values() []TypesSearchScope { return []TypesSearchScope{ "ASSET_TYPE", @@ -1023,8 +1066,9 @@ const ( ) // Values returns all known values for UserAssignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserAssignment) Values() []UserAssignment { return []UserAssignment{ "AUTOMATIC", @@ -1041,8 +1085,9 @@ const ( ) // Values returns all known values for UserDesignation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserDesignation) Values() []UserDesignation { return []UserDesignation{ "PROJECT_OWNER", @@ -1061,8 +1106,9 @@ const ( ) // Values returns all known values for UserProfileStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserProfileStatus) Values() []UserProfileStatus { return []UserProfileStatus{ "ASSIGNED", @@ -1081,8 +1127,9 @@ const ( ) // Values returns all known values for UserProfileType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserProfileType) Values() []UserProfileType { return []UserProfileType{ "IAM", @@ -1101,8 +1148,9 @@ const ( ) // Values returns all known values for UserSearchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserSearchType) Values() []UserSearchType { return []UserSearchType{ "SSO_USER", @@ -1122,8 +1170,9 @@ const ( ) // Values returns all known values for UserType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserType) Values() []UserType { return []UserType{ "IAM_USER", diff --git a/service/datazone/types/types.go b/service/datazone/types/types.go index 374d1c85888..587018a3e7d 100644 --- a/service/datazone/types/types.go +++ b/service/datazone/types/types.go @@ -134,10 +134,12 @@ type AssetListing struct { // created. CreatedAt *time.Time - // The metadata forms attached to an asset published in an Amazon DataZone catalog. + // The metadata forms attached to an asset published in an Amazon DataZone + // catalog. Forms *string - // The glossary terms attached to an asset published in an Amazon DataZone catalog. + // The glossary terms attached to an asset published in an Amazon DataZone + // catalog. GlossaryTerms []DetailedGlossaryTerm // The latest time series data points forms included in the additional attributes diff --git a/service/dax/api_op_CreateCluster.go b/service/dax/api_op_CreateCluster.go index 84ea24c61d1..cbd02074a43 100644 --- a/service/dax/api_op_CreateCluster.go +++ b/service/dax/api_op_CreateCluster.go @@ -31,9 +31,13 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, 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. // // This member is required. @@ -56,8 +60,9 @@ 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 - // recommends that you have at least two read replicas per cluster. + // 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. ReplicationFactor int32 @@ -69,7 +74,9 @@ 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 ClusterEndpointEncryptionType types.ClusterEndpointEncryptionType @@ -77,7 +84,9 @@ type CreateClusterInput struct { Description *string // The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications - // will be sent. The Amazon SNS topic owner must be same as the DAX cluster owner. + // will be sent. + // + // The Amazon SNS topic owner must be same as the DAX cluster owner. NotificationTopicArn *string // The parameter group to be associated with the DAX cluster. @@ -87,29 +96,42 @@ 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. + // + // 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. SSESpecification *types.SSESpecification // A list of security group IDs to be assigned to each node in the DAX cluster. - // (Each of the security group ID is system-generated.) If this parameter is not - // specified, DAX assigns the default VPC security group to each node. + // (Each of the security group ID is system-generated.) + // + // If this parameter is not specified, DAX assigns the default VPC security group + // to each node. SecurityGroupIds []string - // The name of the subnet group to be used for the replication group. DAX clusters - // can only run in an Amazon VPC environment. All of the subnets that you specify - // in a subnet group must exist in the same VPC. + // The name of the subnet group to be used for the replication group. + // + // DAX clusters can only run in an Amazon VPC environment. All of the subnets that + // you specify in a subnet group must exist in the same VPC. SubnetGroupName *string // A set of tags to associate with the DAX cluster. diff --git a/service/dax/api_op_DecreaseReplicationFactor.go b/service/dax/api_op_DecreaseReplicationFactor.go index f96a3a4df54..4ffeda68332 100644 --- a/service/dax/api_op_DecreaseReplicationFactor.go +++ b/service/dax/api_op_DecreaseReplicationFactor.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes one or more nodes from a DAX cluster. You cannot use -// DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need -// to do this, use DeleteCluster instead. +// Removes one or more nodes from a DAX cluster. +// +// You cannot use DecreaseReplicationFactor to remove the last node in a DAX +// cluster. If you need to do this, use DeleteCluster instead. func (c *Client) DecreaseReplicationFactor(ctx context.Context, params *DecreaseReplicationFactorInput, optFns ...func(*Options)) (*DecreaseReplicationFactorOutput, error) { if params == nil { params = &DecreaseReplicationFactorInput{} diff --git a/service/dax/api_op_DeleteSubnetGroup.go b/service/dax/api_op_DeleteSubnetGroup.go index 29933c10bb3..5deea1cf85e 100644 --- a/service/dax/api_op_DeleteSubnetGroup.go +++ b/service/dax/api_op_DeleteSubnetGroup.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a subnet group. You cannot delete a subnet group if it is associated -// with any DAX clusters. +// Deletes a subnet group. +// +// You cannot delete a subnet group if it is associated with any DAX clusters. func (c *Client) DeleteSubnetGroup(ctx context.Context, params *DeleteSubnetGroupInput, optFns ...func(*Options)) (*DeleteSubnetGroupOutput, error) { if params == nil { params = &DeleteSubnetGroupInput{} diff --git a/service/dax/api_op_DescribeClusters.go b/service/dax/api_op_DescribeClusters.go index 1a89c1af81f..1de05fb71a9 100644 --- a/service/dax/api_op_DescribeClusters.go +++ b/service/dax/api_op_DescribeClusters.go @@ -13,15 +13,21 @@ import ( // Returns information about all provisioned DAX clusters if no cluster identifier // is specified, or about a specific DAX cluster if a cluster identifier is -// supplied. If the cluster is in the CREATING state, only cluster level -// information will be displayed until all of the nodes are successfully -// provisioned. If the cluster is in the DELETING state, only cluster level -// information will be displayed. If nodes are currently being added to the DAX -// cluster, node endpoint information and creation time for the additional nodes -// will not be displayed until they are completely provisioned. When the DAX -// cluster state is available, the cluster is ready for use. If nodes are currently -// being removed from the DAX cluster, no endpoint information for the removed -// nodes is displayed. +// supplied. +// +// If the cluster is in the CREATING state, only cluster level information will be +// displayed until all of the nodes are successfully provisioned. +// +// If the cluster is in the DELETING state, only cluster level information will be +// displayed. +// +// If nodes are currently being added to the DAX cluster, node endpoint +// information and creation time for the additional nodes will not be displayed +// until they are completely provisioned. When the DAX cluster state is available, +// the cluster is ready for use. +// +// If nodes are currently being removed from the DAX cluster, no endpoint +// information for the removed nodes is displayed. func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersInput, optFns ...func(*Options)) (*DescribeClustersOutput, error) { if params == nil { params = &DescribeClustersInput{} @@ -44,8 +50,9 @@ type DescribeClustersInput 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. + // 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 diff --git a/service/dax/api_op_DescribeDefaultParameters.go b/service/dax/api_op_DescribeDefaultParameters.go index beca7b13de1..860338af70c 100644 --- a/service/dax/api_op_DescribeDefaultParameters.go +++ b/service/dax/api_op_DescribeDefaultParameters.go @@ -31,8 +31,9 @@ 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. + // 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 diff --git a/service/dax/api_op_DescribeEvents.go b/service/dax/api_op_DescribeEvents.go index cebd4175760..dbff2860eb7 100644 --- a/service/dax/api_op_DescribeEvents.go +++ b/service/dax/api_op_DescribeEvents.go @@ -14,9 +14,10 @@ import ( // Returns events related to DAX clusters and parameter groups. You can obtain // events specific to a particular DAX cluster or parameter group by providing the -// name as a parameter. By default, only the events occurring within the last 24 -// hours are returned; however, you can retrieve up to 14 days' worth of events if -// necessary. +// name as a parameter. +// +// By default, only the events occurring within the last 24 hours are returned; +// however, you can retrieve up to 14 days' worth of events if necessary. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -43,8 +44,9 @@ type DescribeEventsInput 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. + // 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 diff --git a/service/dax/api_op_DescribeParameterGroups.go b/service/dax/api_op_DescribeParameterGroups.go index 6e887850492..33829789d77 100644 --- a/service/dax/api_op_DescribeParameterGroups.go +++ b/service/dax/api_op_DescribeParameterGroups.go @@ -32,8 +32,9 @@ 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. + // 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 diff --git a/service/dax/api_op_DescribeParameters.go b/service/dax/api_op_DescribeParameters.go index 3444e82c214..e2bd3c0dde0 100644 --- a/service/dax/api_op_DescribeParameters.go +++ b/service/dax/api_op_DescribeParameters.go @@ -36,8 +36,9 @@ type DescribeParametersInput 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. + // 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 diff --git a/service/dax/api_op_DescribeSubnetGroups.go b/service/dax/api_op_DescribeSubnetGroups.go index 1c6c64258dd..44bb6b507d8 100644 --- a/service/dax/api_op_DescribeSubnetGroups.go +++ b/service/dax/api_op_DescribeSubnetGroups.go @@ -32,8 +32,9 @@ 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. + // 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 diff --git a/service/dax/api_op_RebootNode.go b/service/dax/api_op_RebootNode.go index d3691fcabf8..a5516c9e593 100644 --- a/service/dax/api_op_RebootNode.go +++ b/service/dax/api_op_RebootNode.go @@ -12,8 +12,10 @@ import ( ) // 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. +// 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 { params = &RebootNodeInput{} diff --git a/service/dax/api_op_UpdateParameterGroup.go b/service/dax/api_op_UpdateParameterGroup.go index 273bd12a9d0..b62a363c441 100644 --- a/service/dax/api_op_UpdateParameterGroup.go +++ b/service/dax/api_op_UpdateParameterGroup.go @@ -37,10 +37,12 @@ type UpdateParameterGroupInput struct { ParameterGroupName *string // 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) - // . + // 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]. + // + // [Configuring 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/options.go b/service/dax/options.go index 4694ed39c0d..23ee277c4ae 100644 --- a/service/dax/options.go +++ b/service/dax/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/dax/types/enums.go b/service/dax/types/enums.go index 1b1dd882921..48d7e4d6b5c 100644 --- a/service/dax/types/enums.go +++ b/service/dax/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "IMMEDIATE", @@ -30,8 +31,9 @@ const ( // Values returns all known values for ClusterEndpointEncryptionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterEndpointEncryptionType) Values() []ClusterEndpointEncryptionType { return []ClusterEndpointEncryptionType{ "NONE", @@ -49,8 +51,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for ParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterType) Values() []ParameterType { return []ParameterType{ "DEFAULT", @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "CLUSTER", @@ -108,8 +113,9 @@ const ( ) // 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. +// in the future, and so 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/types.go b/service/dax/types/types.go index 05ffe84e9c8..d2d39fb73b7 100644 --- a/service/dax/types/types.go +++ b/service/dax/types/types.go @@ -23,7 +23,10 @@ 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. @@ -270,9 +273,13 @@ 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. Status SSEStatus @@ -305,7 +312,9 @@ type Subnet struct { } // Represents the output of one of the following actions: +// // - CreateSubnetGroup +// // - ModifySubnetGroup type SubnetGroup struct { @@ -325,10 +334,13 @@ type SubnetGroup struct { } // 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. +// 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/deadline/api_op_GetBudget.go b/service/deadline/api_op_GetBudget.go index 1cacb479197..a00d754d098 100644 --- a/service/deadline/api_op_GetBudget.go +++ b/service/deadline/api_op_GetBudget.go @@ -81,7 +81,9 @@ type GetBudgetOutput struct { Schedule types.BudgetSchedule // The status of the budget. + // // - ACTIVE –Get a budget being evaluated. + // // - INACTIVE –Get an inactive budget. This can include expired, canceled, or // deleted statuses. // diff --git a/service/deadline/api_op_GetFleet.go b/service/deadline/api_op_GetFleet.go index 5cb3d112399..8e56dcf417c 100644 --- a/service/deadline/api_op_GetFleet.go +++ b/service/deadline/api_op_GetFleet.go @@ -276,12 +276,13 @@ type FleetActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFleetInput, *GetFleetOutput, error) (bool, error) } diff --git a/service/deadline/api_op_GetJob.go b/service/deadline/api_op_GetJob.go index 4082a2e8f95..20aa45de3fc 100644 --- a/service/deadline/api_op_GetJob.go +++ b/service/deadline/api_op_GetJob.go @@ -282,12 +282,13 @@ type JobCreateCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetJobInput, *GetJobOutput, error) (bool, error) } diff --git a/service/deadline/api_op_GetLicenseEndpoint.go b/service/deadline/api_op_GetLicenseEndpoint.go index 9076ae7bafd..05d5afccc0c 100644 --- a/service/deadline/api_op_GetLicenseEndpoint.go +++ b/service/deadline/api_op_GetLicenseEndpoint.go @@ -228,12 +228,13 @@ type LicenseEndpointValidWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetLicenseEndpointInput, *GetLicenseEndpointOutput, error) (bool, error) } @@ -419,12 +420,13 @@ type LicenseEndpointDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetLicenseEndpointInput, *GetLicenseEndpointOutput, error) (bool, error) } diff --git a/service/deadline/api_op_GetQueue.go b/service/deadline/api_op_GetQueue.go index 38187781786..ac75e80fe18 100644 --- a/service/deadline/api_op_GetQueue.go +++ b/service/deadline/api_op_GetQueue.go @@ -79,10 +79,12 @@ type GetQueueOutput struct { QueueId *string // The status of the queue. + // // - ACTIVE –The queue is active. + // // - SCHEDULING –The queue is scheduling. - // - SCHEDULING_BLOCKED –The queue scheduling is blocked. See the provided - // reason. + // + // - SCHEDULING_BLOCKED –The queue scheduling is blocked. See the provided reason. // // This member is required. Status types.QueueStatus @@ -270,12 +272,13 @@ type QueueSchedulingBlockedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetQueueInput, *GetQueueOutput, error) (bool, error) } @@ -442,12 +445,13 @@ type QueueSchedulingWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetQueueInput, *GetQueueOutput, error) (bool, error) } diff --git a/service/deadline/api_op_GetQueueFleetAssociation.go b/service/deadline/api_op_GetQueueFleetAssociation.go index b6a7e0ac6d4..8ece1c69703 100644 --- a/service/deadline/api_op_GetQueueFleetAssociation.go +++ b/service/deadline/api_op_GetQueueFleetAssociation.go @@ -241,12 +241,13 @@ type QueueFleetAssociationStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetQueueFleetAssociationInput, *GetQueueFleetAssociationOutput, error) (bool, error) } diff --git a/service/deadline/api_op_ListQueues.go b/service/deadline/api_op_ListQueues.go index f3b3efb638c..da34b66446b 100644 --- a/service/deadline/api_op_ListQueues.go +++ b/service/deadline/api_op_ListQueues.go @@ -46,8 +46,11 @@ type ListQueuesInput struct { PrincipalId *string // The status of the queues listed. + // // - ACTIVE –The queues are active. + // // - SCHEDULING –The queues are scheduling. + // // - SCHEDULING_BLOCKED –The queue scheduling is blocked for these queues. Status types.QueueStatus diff --git a/service/deadline/api_op_SearchJobs.go b/service/deadline/api_op_SearchJobs.go index 737d173c508..e3c5a887aa4 100644 --- a/service/deadline/api_op_SearchJobs.go +++ b/service/deadline/api_op_SearchJobs.go @@ -45,8 +45,9 @@ type SearchJobsInput struct { QueueIds []string // The filter expression, AND or OR , to use when searching among a group of search - // strings in a resource. You can use two groupings per search each within - // parenthesis () . + // strings in a resource. + // + // You can use two groupings per search each within parenthesis () . FilterExpressions *types.SearchGroupedFilterExpressions // Specifies the number of items per page for the resource. diff --git a/service/deadline/api_op_SearchSteps.go b/service/deadline/api_op_SearchSteps.go index 44e453bc954..abb29dad122 100644 --- a/service/deadline/api_op_SearchSteps.go +++ b/service/deadline/api_op_SearchSteps.go @@ -45,8 +45,9 @@ type SearchStepsInput struct { QueueIds []string // The filter expression, AND or OR , to use when searching among a group of search - // strings in a resource. You can use two groupings per search each within - // parenthesis () . + // strings in a resource. + // + // You can use two groupings per search each within parenthesis () . FilterExpressions *types.SearchGroupedFilterExpressions // The job ID to use in the step search. diff --git a/service/deadline/api_op_SearchTasks.go b/service/deadline/api_op_SearchTasks.go index 1339a729113..24adc6071ff 100644 --- a/service/deadline/api_op_SearchTasks.go +++ b/service/deadline/api_op_SearchTasks.go @@ -45,8 +45,9 @@ type SearchTasksInput struct { QueueIds []string // The filter expression, AND or OR , to use when searching among a group of search - // strings in a resource. You can use two groupings per search each within - // parenthesis () . + // strings in a resource. + // + // You can use two groupings per search each within parenthesis () . FilterExpressions *types.SearchGroupedFilterExpressions // The job ID for the task search. diff --git a/service/deadline/api_op_SearchWorkers.go b/service/deadline/api_op_SearchWorkers.go index af2ec442545..9a8304ca368 100644 --- a/service/deadline/api_op_SearchWorkers.go +++ b/service/deadline/api_op_SearchWorkers.go @@ -45,8 +45,9 @@ type SearchWorkersInput struct { ItemOffset *int32 // The filter expression, AND or OR , to use when searching among a group of search - // strings in a resource. You can use two groupings per search each within - // parenthesis () . + // strings in a resource. + // + // You can use two groupings per search each within parenthesis () . FilterExpressions *types.SearchGroupedFilterExpressions // Specifies the number of items per page for the resource. diff --git a/service/deadline/api_op_UpdateBudget.go b/service/deadline/api_op_UpdateBudget.go index 60feff4b106..a4a3fe72942 100644 --- a/service/deadline/api_op_UpdateBudget.go +++ b/service/deadline/api_op_UpdateBudget.go @@ -62,7 +62,9 @@ type UpdateBudgetInput struct { Schedule types.BudgetSchedule // Updates the status of the budget. + // // - ACTIVE –The budget is being evaluated. + // // - INACTIVE –The budget is inactive. This can include Expired, Canceled, or // deleted Deleted statuses. Status types.BudgetStatus diff --git a/service/deadline/doc.go b/service/deadline/doc.go index 52c37ab7f92..5b9035b4ee9 100644 --- a/service/deadline/doc.go +++ b/service/deadline/doc.go @@ -6,6 +6,7 @@ // The Amazon Web Services Deadline Cloud API provides infrastructure and // centralized management for your projects. Use the Deadline Cloud API to onboard // users, assign projects, and attach permissions specific to their job function. +// // With Deadline Cloud, content production teams can deploy resources for their // workforce securely in the cloud, reducing the costs of added physical // infrastructure. Keep your content production operations secure, while allowing diff --git a/service/deadline/options.go b/service/deadline/options.go index 4245eaa7716..3020ec9ef77 100644 --- a/service/deadline/options.go +++ b/service/deadline/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/deadline/types/enums.go b/service/deadline/types/enums.go index bc571a475e4..9b709cb977d 100644 --- a/service/deadline/types/enums.go +++ b/service/deadline/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AcceleratorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorType) Values() []AcceleratorType { return []AcceleratorType{ "gpu", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for AutoScalingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingMode) Values() []AutoScalingMode { return []AutoScalingMode{ "NO_SCALING", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for AutoScalingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingStatus) Values() []AutoScalingStatus { return []AutoScalingStatus{ "GROWING", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for BudgetActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BudgetActionType) Values() []BudgetActionType { return []BudgetActionType{ "STOP_SCHEDULING_AND_COMPLETE_TASKS", @@ -84,8 +88,9 @@ const ( ) // Values returns all known values for BudgetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BudgetStatus) Values() []BudgetStatus { return []BudgetStatus{ "ACTIVE", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQUAL", @@ -131,8 +137,9 @@ const ( ) // Values returns all known values for CompletedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompletedStatus) Values() []CompletedStatus { return []CompletedStatus{ "SUCCEEDED", @@ -155,8 +162,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "CONFLICT_EXCEPTION", @@ -176,8 +184,9 @@ const ( ) // Values returns all known values for CpuArchitectureType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CpuArchitectureType) Values() []CpuArchitectureType { return []CpuArchitectureType{ "x86_64", @@ -195,8 +204,9 @@ const ( // Values returns all known values for CreateJobTargetTaskRunStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreateJobTargetTaskRunStatus) Values() []CreateJobTargetTaskRunStatus { return []CreateJobTargetTaskRunStatus{ "READY", @@ -215,8 +225,9 @@ const ( // Values returns all known values for CustomerManagedFleetOperatingSystemFamily. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomerManagedFleetOperatingSystemFamily) Values() []CustomerManagedFleetOperatingSystemFamily { return []CustomerManagedFleetOperatingSystemFamily{ "WINDOWS", @@ -234,8 +245,9 @@ const ( ) // Values returns all known values for DeadlinePrincipalType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeadlinePrincipalType) Values() []DeadlinePrincipalType { return []DeadlinePrincipalType{ "USER", @@ -254,6 +266,7 @@ const ( // Values returns all known values for DefaultQueueBudgetAction. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DefaultQueueBudgetAction) Values() []DefaultQueueBudgetAction { return []DefaultQueueBudgetAction{ @@ -273,8 +286,9 @@ const ( // Values returns all known values for DependencyConsumerResolutionStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DependencyConsumerResolutionStatus) Values() []DependencyConsumerResolutionStatus { return []DependencyConsumerResolutionStatus{ "RESOLVED", @@ -290,8 +304,9 @@ const ( ) // Values returns all known values for DesiredWorkerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DesiredWorkerStatus) Values() []DesiredWorkerStatus { return []DesiredWorkerStatus{ "STOPPED", @@ -307,8 +322,9 @@ const ( ) // Values returns all known values for Ec2MarketType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2MarketType) Values() []Ec2MarketType { return []Ec2MarketType{ "on-demand", @@ -325,8 +341,9 @@ const ( ) // Values returns all known values for EnvironmentTemplateType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentTemplateType) Values() []EnvironmentTemplateType { return []EnvironmentTemplateType{ "JSON", @@ -343,8 +360,9 @@ const ( ) // Values returns all known values for FileSystemLocationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemLocationType) Values() []FileSystemLocationType { return []FileSystemLocationType{ "SHARED", @@ -364,8 +382,9 @@ const ( ) // Values returns all known values for FleetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetStatus) Values() []FleetStatus { return []FleetStatus{ "ACTIVE", @@ -386,6 +405,7 @@ const ( // Values returns all known values for JobAttachmentsFileSystem. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (JobAttachmentsFileSystem) Values() []JobAttachmentsFileSystem { return []JobAttachmentsFileSystem{ @@ -407,8 +427,9 @@ const ( ) // Values returns all known values for JobEntityErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobEntityErrorCode) Values() []JobEntityErrorCode { return []JobEntityErrorCode{ "AccessDeniedException", @@ -436,8 +457,9 @@ const ( ) // Values returns all known values for JobLifecycleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobLifecycleStatus) Values() []JobLifecycleStatus { return []JobLifecycleStatus{ "CREATE_IN_PROGRESS", @@ -465,8 +487,9 @@ const ( ) // Values returns all known values for JobTargetTaskRunStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobTargetTaskRunStatus) Values() []JobTargetTaskRunStatus { return []JobTargetTaskRunStatus{ "READY", @@ -487,8 +510,9 @@ const ( ) // Values returns all known values for JobTemplateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobTemplateType) Values() []JobTemplateType { return []JobTemplateType{ "JSON", @@ -507,8 +531,9 @@ const ( ) // Values returns all known values for LicenseEndpointStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseEndpointStatus) Values() []LicenseEndpointStatus { return []LicenseEndpointStatus{ "CREATE_IN_PROGRESS", @@ -527,8 +552,9 @@ const ( ) // Values returns all known values for LogicalOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogicalOperator) Values() []LogicalOperator { return []LogicalOperator{ "AND", @@ -547,8 +573,9 @@ const ( ) // Values returns all known values for MembershipLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MembershipLevel) Values() []MembershipLevel { return []MembershipLevel{ "VIEWER", @@ -567,8 +594,9 @@ const ( ) // Values returns all known values for PathFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PathFormat) Values() []PathFormat { return []PathFormat{ "windows", @@ -587,8 +615,9 @@ const ( ) // Values returns all known values for Period. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Period) Values() []Period { return []Period{ "HOURLY", @@ -607,8 +636,9 @@ const ( ) // Values returns all known values for QueueBlockedReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueBlockedReason) Values() []QueueBlockedReason { return []QueueBlockedReason{ "NO_BUDGET_CONFIGURED", @@ -628,6 +658,7 @@ const ( // Values returns all known values for QueueFleetAssociationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (QueueFleetAssociationStatus) Values() []QueueFleetAssociationStatus { return []QueueFleetAssociationStatus{ @@ -648,8 +679,9 @@ const ( ) // Values returns all known values for QueueStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueStatus) Values() []QueueStatus { return []QueueStatus{ "IDLE", @@ -667,8 +699,9 @@ const ( ) // Values returns all known values for RunAs. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunAs) Values() []RunAs { return []RunAs{ "QUEUE_CONFIGURED_USER", @@ -686,8 +719,9 @@ const ( // Values returns all known values for ServiceManagedFleetOperatingSystemFamily. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceManagedFleetOperatingSystemFamily) Values() []ServiceManagedFleetOperatingSystemFamily { return []ServiceManagedFleetOperatingSystemFamily{ "WINDOWS", @@ -705,8 +739,9 @@ const ( // Values returns all known values for ServiceQuotaExceededExceptionReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceQuotaExceededExceptionReason) Values() []ServiceQuotaExceededExceptionReason { return []ServiceQuotaExceededExceptionReason{ "SERVICE_QUOTA_EXCEEDED_EXCEPTION", @@ -732,8 +767,9 @@ const ( ) // Values returns all known values for SessionActionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionActionStatus) Values() []SessionActionStatus { return []SessionActionStatus{ "ASSIGNED", @@ -762,8 +798,9 @@ const ( ) // Values returns all known values for SessionLifecycleStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionLifecycleStatus) Values() []SessionLifecycleStatus { return []SessionLifecycleStatus{ "STARTED", @@ -783,8 +820,9 @@ const ( // Values returns all known values for SessionLifecycleTargetStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionLifecycleTargetStatus) Values() []SessionLifecycleTargetStatus { return []SessionLifecycleTargetStatus{ "ENDED", @@ -803,8 +841,9 @@ const ( // Values returns all known values for SessionsStatisticsAggregationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionsStatisticsAggregationStatus) Values() []SessionsStatisticsAggregationStatus { return []SessionsStatisticsAggregationStatus{ "IN_PROGRESS", @@ -823,8 +862,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -843,8 +883,9 @@ const ( ) // Values returns all known values for StepLifecycleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepLifecycleStatus) Values() []StepLifecycleStatus { return []StepLifecycleStatus{ "CREATE_COMPLETE", @@ -865,8 +906,9 @@ const ( ) // Values returns all known values for StepParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepParameterType) Values() []StepParameterType { return []StepParameterType{ "INT", @@ -889,8 +931,9 @@ const ( ) // Values returns all known values for StepTargetTaskRunStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepTargetTaskRunStatus) Values() []StepTargetTaskRunStatus { return []StepTargetTaskRunStatus{ "READY", @@ -913,8 +956,9 @@ const ( // Values returns all known values for StorageProfileOperatingSystemFamily. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageProfileOperatingSystemFamily) Values() []StorageProfileOperatingSystemFamily { return []StorageProfileOperatingSystemFamily{ "WINDOWS", @@ -942,8 +986,9 @@ const ( ) // Values returns all known values for TaskRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskRunStatus) Values() []TaskRunStatus { return []TaskRunStatus{ "PENDING", @@ -974,8 +1019,9 @@ const ( ) // Values returns all known values for TaskTargetRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskTargetRunStatus) Values() []TaskTargetRunStatus { return []TaskTargetRunStatus{ "READY", @@ -997,8 +1043,9 @@ const ( ) // Values returns all known values for UpdatedWorkerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdatedWorkerStatus) Values() []UpdatedWorkerStatus { return []UpdatedWorkerStatus{ "STARTED", @@ -1016,6 +1063,7 @@ const ( // Values returns all known values for UpdateJobLifecycleStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (UpdateJobLifecycleStatus) Values() []UpdateJobLifecycleStatus { return []UpdateJobLifecycleStatus{ @@ -1034,8 +1082,9 @@ const ( // Values returns all known values for UpdateQueueFleetAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateQueueFleetAssociationStatus) Values() []UpdateQueueFleetAssociationStatus { return []UpdateQueueFleetAssociationStatus{ "ACTIVE", @@ -1058,8 +1107,9 @@ const ( ) // Values returns all known values for UsageGroupByField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageGroupByField) Values() []UsageGroupByField { return []UsageGroupByField{ "QUEUE_ID", @@ -1083,8 +1133,9 @@ const ( ) // Values returns all known values for UsageStatistic. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageStatistic) Values() []UsageStatistic { return []UsageStatistic{ "SUM", @@ -1103,8 +1154,9 @@ const ( ) // 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. +// in the future, and so 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{ "COMPUTE", @@ -1124,6 +1176,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -1149,8 +1202,9 @@ const ( ) // Values returns all known values for WorkerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkerStatus) Values() []WorkerStatus { return []WorkerStatus{ "CREATED", diff --git a/service/deadline/types/types.go b/service/deadline/types/types.go index 02e42ab59f7..81621d4e9f4 100644 --- a/service/deadline/types/types.go +++ b/service/deadline/types/types.go @@ -301,7 +301,9 @@ type BudgetSummary struct { DisplayName *string // The status of the budget. + // // - ACTIVE –The budget is being evaluated. + // // - INACTIVE –The budget is inactive. This can include Expired, Canceled, or // deleted Deleted statuses. // @@ -1346,15 +1348,25 @@ type JobSearchSummary struct { TargetTaskRunStatus JobTargetTaskRunStatus // task run status for the job. + // // - PENDING –pending and waiting for resources. + // // - READY –ready to be processed. + // // - ASSIGNED –assigned and will run next on a worker. + // // - SCHEDULED –scheduled to be run on a worker. + // // - INTERRUPTING –being interrupted. + // // - RUNNING –running on a worker. + // // - SUSPENDED –the task is suspended. + // // - CANCELED –the task has been canceled. + // // - FAILED –the task has failed. + // // - SUCCEEDED –the task has succeeded. TaskRunStatus TaskRunStatus @@ -1419,15 +1431,25 @@ type JobSummary struct { TargetTaskRunStatus JobTargetTaskRunStatus // The task run status for the job. + // // - PENDING –pending and waiting for resources. + // // - READY –ready to be processed. + // // - ASSIGNED –assigned and will run next on a worker. + // // - SCHEDULED –scheduled to be run on a worker. + // // - INTERRUPTING –being interrupted. + // // - RUNNING –running on a worker. + // // - SUSPENDED –the task is suspended. + // // - CANCELED –the task has been canceled. + // // - FAILED –the task has failed. + // // - SUCCEEDED –the task has succeeded. TaskRunStatus TaskRunStatus @@ -1744,11 +1766,15 @@ type QueueFleetAssociationSummary struct { QueueId *string // The status of task scheduling in the queue-fleet association. + // // - ACTIVE –Association is active. + // // - STOP_SCHEDULING_AND_COMPLETE_TASKS –Association has stopped scheduling new // tasks and is completing current tasks. + // // - STOP_SCHEDULING_AND_CANCEL_TASKS –Association has stopped scheduling new // tasks and is canceling current tasks. + // // - STOPPED –Association has been stopped. // // This member is required. @@ -1943,8 +1969,9 @@ type SearchFilterExpressionMemberStringFilter struct { func (*SearchFilterExpressionMemberStringFilter) isSearchFilterExpression() {} // The filter expression, AND or OR , to use when searching among a group of search -// strings in a resource. You can use two groupings per search each within -// parenthesis () . +// strings in a resource. +// +// You can use two groupings per search each within parenthesis () . type SearchGroupedFilterExpressions struct { // The filters to use for the search. @@ -2564,15 +2591,25 @@ type StepSearchSummary struct { TargetTaskRunStatus StepTargetTaskRunStatus // The task run status for the job. + // // - PENDING –pending and waiting for resources. + // // - READY –ready to be processed. + // // - ASSIGNED –assigned and will run next on a worker. + // // - SCHEDULED –scheduled to be run on a worker. + // // - INTERRUPTING –being interrupted. + // // - RUNNING –running on a worker. + // // - SUSPENDED –the task is suspended. + // // - CANCELED –the task has been canceled. + // // - FAILED –the task has failed. + // // - SUCCEEDED –the task has succeeded. TaskRunStatus TaskRunStatus @@ -2611,15 +2648,25 @@ type StepSummary struct { StepId *string // The task run status for the job. + // // - PENDING –pending and waiting for resources. + // // - READY –ready to process. + // // - ASSIGNED –assigned and will run next on a worker. + // // - SCHEDULED –scheduled to run on a worker. + // // - INTERRUPTING –being interrupted. + // // - RUNNING –running on a worker. + // // - SUSPENDED –the task is suspended. + // // - CANCELED –the task has been canceled. + // // - FAILED –the task has failed. + // // - SUCCEEDED –the task has succeeded. // // This member is required. diff --git a/service/detective/api_op_AcceptInvitation.go b/service/detective/api_op_AcceptInvitation.go index 0e52b2f02fb..0c38aedcf07 100644 --- a/service/detective/api_op_AcceptInvitation.go +++ b/service/detective/api_op_AcceptInvitation.go @@ -11,9 +11,11 @@ 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. 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 . func (c *Client) AcceptInvitation(ctx context.Context, params *AcceptInvitationInput, optFns ...func(*Options)) (*AcceptInvitationOutput, error) { if params == nil { params = &AcceptInvitationInput{} @@ -32,7 +34,9 @@ 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 c153a601c36..c8a15755843 100644 --- a/service/detective/api_op_CreateGraph.go +++ b/service/detective/api_op_CreateGraph.go @@ -12,13 +12,18 @@ import ( // Creates a new behavior graph for the calling account, and sets that account as // the administrator account. This operation is called by the account that is -// enabling Detective. The operation also enables Detective for the calling account -// in the currently selected Region. It returns the ARN of the new behavior graph. +// enabling Detective. +// +// The operation also enables Detective for the calling account in the currently +// selected Region. It returns the ARN of 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. +// 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. 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 b40a32115c9..a6073577524 100644 --- a/service/detective/api_op_CreateMembers.go +++ b/service/detective/api_op_CreateMembers.go @@ -13,23 +13,32 @@ 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: +// 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) { @@ -65,8 +74,10 @@ type CreateMembersInput struct { // 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. + // notifications. + // + // Organization accounts in the organization behavior graph do not receive email + // notifications. DisableEmailNotification bool // Customized message text to include in the invitation email message to the diff --git a/service/detective/api_op_DeleteGraph.go b/service/detective/api_op_DeleteGraph.go index 0efbcb0fafa..04c94c14208 100644 --- a/service/detective/api_op_DeleteGraph.go +++ b/service/detective/api_op_DeleteGraph.go @@ -12,8 +12,10 @@ import ( // Disables the specified behavior graph and queues it to be deleted. This // operation removes the behavior graph from each member account's list of behavior -// graphs. DeleteGraph can only be called by the administrator account for a -// behavior graph. +// graphs. +// +// DeleteGraph can only be called by the administrator account for a behavior +// graph. func (c *Client) DeleteGraph(ctx context.Context, params *DeleteGraphInput, optFns ...func(*Options)) (*DeleteGraphOutput, error) { if params == nil { params = &DeleteGraphInput{} diff --git a/service/detective/api_op_DeleteMembers.go b/service/detective/api_op_DeleteMembers.go index 43efa3cc106..6dbee6043fe 100644 --- a/service/detective/api_op_DeleteMembers.go +++ b/service/detective/api_op_DeleteMembers.go @@ -13,16 +13,20 @@ import ( // Removes the specified member accounts from the behavior graph. The removed // accounts no longer contribute data to the behavior graph. This operation can -// only be called by the administrator account for the behavior graph. For invited -// accounts, the removed accounts are deleted from the list of accounts in the -// behavior graph. To restore the account, the administrator account must send -// another invitation. For organization accounts in the organization behavior -// graph, the Detective administrator account can always enable the organization -// account again. Organization accounts that are not enabled as member accounts are -// not included in the ListMembers results for the organization behavior graph. An -// administrator account cannot use DeleteMembers to remove their own account from -// the behavior graph. To disable a behavior graph, the administrator account uses -// the DeleteGraph API method. +// only be called by the administrator account for the behavior graph. +// +// For invited accounts, the removed accounts are deleted from the list of +// accounts in the behavior graph. To restore the account, the administrator +// account must send another invitation. +// +// For organization accounts in the organization behavior graph, the Detective +// administrator account can always enable the organization account again. +// Organization accounts that are not enabled as member accounts are not included +// in the ListMembers results for the organization behavior graph. +// +// An administrator account cannot use DeleteMembers to remove their own account +// from the behavior graph. To disable a behavior graph, the administrator account +// uses the DeleteGraph API method. func (c *Client) DeleteMembers(ctx context.Context, params *DeleteMembersInput, optFns ...func(*Options)) (*DeleteMembersOutput, error) { if params == nil { params = &DeleteMembersInput{} diff --git a/service/detective/api_op_DescribeOrganizationConfiguration.go b/service/detective/api_op_DescribeOrganizationConfiguration.go index 11165426463..d56129b797f 100644 --- a/service/detective/api_op_DescribeOrganizationConfiguration.go +++ b/service/detective/api_op_DescribeOrganizationConfiguration.go @@ -12,8 +12,9 @@ import ( // 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. +// 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_DisableOrganizationAdminAccount.go b/service/detective/api_op_DisableOrganizationAdminAccount.go index 4ffdc45f5f2..8953f761bbf 100644 --- a/service/detective/api_op_DisableOrganizationAdminAccount.go +++ b/service/detective/api_op_DisableOrganizationAdminAccount.go @@ -11,13 +11,17 @@ import ( ) // Removes the Detective administrator account in the current Region. Deletes the -// organization behavior graph. Can only be called by the organization management -// account. Removing the Detective administrator account does not affect the -// delegated administrator account for Detective in Organizations. To remove the -// delegated administrator account in Organizations, use the Organizations API. -// Removing the delegated administrator account also removes the Detective -// administrator account in all Regions, except for Regions where the Detective -// administrator account is the organization management account. +// organization behavior graph. +// +// Can only be called by the organization management account. +// +// Removing the Detective administrator account does not affect the delegated +// administrator account for Detective in Organizations. +// +// To remove the delegated administrator account in Organizations, use the +// Organizations API. Removing the delegated administrator account also removes the +// Detective administrator account in all Regions, except for Regions where the +// Detective administrator account is the organization management account. func (c *Client) DisableOrganizationAdminAccount(ctx context.Context, params *DisableOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableOrganizationAdminAccountOutput, error) { if params == nil { params = &DisableOrganizationAdminAccountInput{} diff --git a/service/detective/api_op_DisassociateMembership.go b/service/detective/api_op_DisassociateMembership.go index b35987b7a22..0bd6c74bf03 100644 --- a/service/detective/api_op_DisassociateMembership.go +++ b/service/detective/api_op_DisassociateMembership.go @@ -12,6 +12,7 @@ import ( // 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 @@ -33,8 +34,9 @@ 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 . + // 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 . // // This member is required. GraphArn *string diff --git a/service/detective/api_op_EnableOrganizationAdminAccount.go b/service/detective/api_op_EnableOrganizationAdminAccount.go index be5bf11fe0f..0158582f4b5 100644 --- a/service/detective/api_op_EnableOrganizationAdminAccount.go +++ b/service/detective/api_op_EnableOrganizationAdminAccount.go @@ -11,17 +11,23 @@ import ( ) // Designates the Detective administrator account for the organization in the -// current Region. If the account does not have Detective enabled, then enables -// Detective for that account and creates a new behavior graph. Can only be called -// by the organization management account. If the organization has a delegated -// administrator account in Organizations, then the Detective administrator account -// must be either the delegated administrator account or the organization -// management account. If the organization does not have a delegated administrator -// account in Organizations, then you can choose any account in the organization. -// If you choose an account other than the organization management account, -// Detective calls Organizations to make that account the delegated administrator -// account for Detective. The organization management account cannot be the -// delegated administrator account. +// current Region. +// +// If the account does not have Detective enabled, then enables Detective for that +// account and creates a new behavior graph. +// +// Can only be called by the organization management account. +// +// If the organization has a delegated administrator account in Organizations, +// then the Detective administrator account must be either the delegated +// administrator account or the organization management account. +// +// If the organization does not have a delegated administrator account in +// Organizations, then you can choose any account in the organization. If you +// choose an account other than the organization management account, Detective +// calls Organizations to make that account the delegated administrator account for +// Detective. The organization management account cannot be the delegated +// administrator account. func (c *Client) EnableOrganizationAdminAccount(ctx context.Context, params *EnableOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableOrganizationAdminAccountOutput, error) { if params == nil { params = &EnableOrganizationAdminAccountInput{} diff --git a/service/detective/api_op_GetMembers.go b/service/detective/api_op_GetMembers.go index 2b179897a2c..dda01f6e16a 100644 --- a/service/detective/api_op_GetMembers.go +++ b/service/detective/api_op_GetMembers.go @@ -32,8 +32,10 @@ type GetMembersInput struct { // The list of Amazon Web Services account identifiers for the member account for // which to return member details. You can request details for up to 50 member - // accounts at a time. You cannot use GetMembers to retrieve information about - // member accounts that were removed from the behavior graph. + // accounts at a time. + // + // You cannot use GetMembers to retrieve information about member accounts that + // were removed from the behavior graph. // // This member is required. AccountIds []string @@ -53,8 +55,9 @@ type GetMembersOutput struct { MemberDetails []types.MemberDetail // The requested member accounts for which Detective was unable to return member - // details. For each account, provides the reason why the request could not be - // processed. + // details. + // + // For each account, provides the reason why the request could not be processed. UnprocessedAccounts []types.UnprocessedAccount // Metadata pertaining to the operation's result. diff --git a/service/detective/api_op_ListGraphs.go b/service/detective/api_op_ListGraphs.go index 690e758dd9a..ed097a528b9 100644 --- a/service/detective/api_op_ListGraphs.go +++ b/service/detective/api_op_ListGraphs.go @@ -13,9 +13,10 @@ import ( // 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. +// 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_ListIndicators.go b/service/detective/api_op_ListIndicators.go index 048660f8ff3..b9581c4971e 100644 --- a/service/detective/api_op_ListIndicators.go +++ b/service/detective/api_op_ListIndicators.go @@ -42,8 +42,9 @@ type ListIndicatorsInput struct { InvestigationId *string // For the list of indicators of compromise that are generated by Detective - // investigations, see Detective investigations (https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html) - // . + // investigations, see [Detective investigations]. + // + // [Detective investigations]: https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html IndicatorType types.IndicatorType // Lists the maximum number of indicators in a page. @@ -51,9 +52,10 @@ type ListIndicatorsInput struct { // Lists if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return a - // Validation Exception error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return a Validation Exception error. NextToken *string noSmithyDocumentSerde @@ -72,9 +74,10 @@ type ListIndicatorsOutput struct { // Lists if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return a - // Validation Exception error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return a Validation Exception error. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/detective/api_op_ListInvestigations.go b/service/detective/api_op_ListInvestigations.go index 8930d6a3953..53c8206a040 100644 --- a/service/detective/api_op_ListInvestigations.go +++ b/service/detective/api_op_ListInvestigations.go @@ -46,9 +46,10 @@ type ListInvestigationsInput struct { // Lists if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return a - // Validation Exception error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return a Validation Exception error. NextToken *string // Sorts the investigation results based on a criteria. @@ -65,8 +66,9 @@ type ListInvestigationsOutput struct { // Lists if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/detective/api_op_ListInvitations.go b/service/detective/api_op_ListInvitations.go index 39ad1115372..480147c5e46 100644 --- a/service/detective/api_op_ListInvitations.go +++ b/service/detective/api_op_ListInvitations.go @@ -13,10 +13,12 @@ import ( // Retrieves the list of open and accepted behavior graph invitations for the // member account. This operation can only be called by an invited member account. +// // Open invitations are invitations that the member account has not responded to. -// The results do not include behavior graphs for which the member account declined -// the invitation. The results also do not include behavior graphs that the member -// account resigned from or was removed from. +// +// The results do not include behavior graphs for which the member account +// declined the invitation. The results also do not include behavior graphs that +// the member account resigned from or was removed from. func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error) { if params == nil { params = &ListInvitationsInput{} diff --git a/service/detective/api_op_ListMembers.go b/service/detective/api_op_ListMembers.go index 2ab7dc06605..7c05ea41968 100644 --- a/service/detective/api_op_ListMembers.go +++ b/service/detective/api_op_ListMembers.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the list of member accounts for a behavior graph. For invited -// accounts, the results do not include member accounts that were removed from the -// behavior graph. For the organization behavior graph, the results do not include -// organization accounts that the Detective administrator account has not enabled -// as member accounts. +// Retrieves the list of member accounts for a behavior graph. +// +// For invited accounts, the results do not include member accounts that were +// removed from the behavior graph. +// +// For the organization behavior graph, the results do not include organization +// accounts that the Detective administrator account has not enabled as member +// accounts. func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error) { if params == nil { params = &ListMembersInput{} @@ -53,13 +56,16 @@ type ListMembersInput struct { type ListMembersOutput struct { - // The list of member accounts in the behavior graph. For invited accounts, the - // results include member accounts that did not pass verification and member - // accounts that have not yet accepted the invitation to the behavior graph. The - // results do not include member accounts that were removed from the behavior - // graph. For the organization behavior graph, the results do not include - // organization accounts that the Detective administrator account has not enabled - // as member accounts. + // The list of member accounts in the behavior graph. + // + // For invited accounts, the results include member accounts that did not pass + // verification and member accounts that have not yet accepted the invitation to + // the behavior graph. The results do not include member accounts that were removed + // from the behavior graph. + // + // For the organization behavior graph, the results do not include organization + // accounts that the Detective administrator account has not enabled as member + // accounts. MemberDetails []types.MemberDetail // If there are more member accounts remaining in the results, then use this diff --git a/service/detective/api_op_RejectInvitation.go b/service/detective/api_op_RejectInvitation.go index a5418f59988..5a31e131fec 100644 --- a/service/detective/api_op_RejectInvitation.go +++ b/service/detective/api_op_RejectInvitation.go @@ -12,7 +12,9 @@ import ( // Rejects an invitation to contribute the account data to a behavior graph. This // operation must be called by an invited member account that has the INVITED -// status. RejectInvitation cannot be called by an organization account in the +// status. +// +// RejectInvitation cannot be called by an organization account in the // organization behavior graph. In the organization behavior graph, organization // accounts do not receive an invitation. func (c *Client) RejectInvitation(ctx context.Context, params *RejectInvitationInput, optFns ...func(*Options)) (*RejectInvitationOutput, error) { @@ -32,8 +34,10 @@ 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 . + // 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 + // . // // This member is required. GraphArn *string diff --git a/service/detective/api_op_StartMonitoringMember.go b/service/detective/api_op_StartMonitoringMember.go index 7cb33cd8760..a2d9d71d4d0 100644 --- a/service/detective/api_op_StartMonitoringMember.go +++ b/service/detective/api_op_StartMonitoringMember.go @@ -11,9 +11,12 @@ 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 -// follows. +// 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 . func (c *Client) StartMonitoringMember(ctx context.Context, params *StartMonitoringMemberInput, optFns ...func(*Options)) (*StartMonitoringMemberOutput, error) { @@ -33,8 +36,10 @@ 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 . + // 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 . // // This member is required. AccountId *string diff --git a/service/detective/doc.go b/service/detective/doc.go index 1a1c5f310b9..024209245af 100644 --- a/service/detective/doc.go +++ b/service/detective/doc.go @@ -8,48 +8,72 @@ // Web Services) workloads. Detective automatically extracts time-based events such // as login attempts, API calls, and network traffic from CloudTrail and Amazon // Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected -// by Amazon GuardDuty. The Detective API primarily supports the creation and -// management of behavior graphs. A behavior graph contains the extracted data from -// a set of member accounts, and is created and managed by an administrator -// account. To add a member account to the behavior graph, the administrator -// account sends an invitation to the account. When the account accepts the -// invitation, it becomes a member account in the behavior graph. Detective is also -// integrated with Organizations. The organization management account designates -// the Detective administrator account for the organization. That account becomes -// the administrator account for the organization behavior graph. The Detective -// administrator account is also the delegated administrator account for Detective -// in Organizations. The Detective administrator account can enable any -// organization account as a member account in the organization behavior graph. The -// organization accounts do not receive invitations. The Detective administrator -// account can also invite other accounts to the organization behavior graph. Every -// behavior graph is specific to a Region. You can only use the API to manage -// 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: +// by Amazon GuardDuty. +// +// The Detective API primarily supports the creation and management of behavior +// graphs. A behavior graph contains the extracted data from a set of member +// accounts, and is created and managed by an administrator account. +// +// To add a member account to the behavior graph, the administrator account sends +// an invitation to the account. When the account accepts the invitation, it +// becomes a member account in the behavior graph. +// +// Detective is also integrated with Organizations. The organization management +// account designates the Detective administrator account for the organization. +// That account becomes the administrator account for the organization behavior +// graph. The Detective administrator account is also the delegated administrator +// account for Detective in Organizations. +// +// The Detective administrator account can enable any organization account as a +// member account in the organization behavior graph. The organization accounts do +// not receive invitations. The Detective administrator account can also invite +// other accounts to the organization behavior graph. +// +// Every behavior graph is specific to a Region. You can only use the API to +// manage 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 -// delegated administrator for Detective. The Detective administrator account for -// an organization can use the Detective API to do the following: +// 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. +// All API actions are logged as CloudTrail events. See [Logging Detective API Calls with CloudTrail]. +// +// 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. +// +// [Logging Detective API Calls with CloudTrail]: https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html package detective diff --git a/service/detective/options.go b/service/detective/options.go index 044d87d1e20..9915faee6a6 100644 --- a/service/detective/options.go +++ b/service/detective/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/detective/types/enums.go b/service/detective/types/enums.go index 75bfe3e4011..c69cc20ec49 100644 --- a/service/detective/types/enums.go +++ b/service/detective/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for DatasourcePackage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasourcePackage) Values() []DatasourcePackage { return []DatasourcePackage{ "DETECTIVE_CORE", @@ -33,8 +34,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasourcePackageIngestState) Values() []DatasourcePackageIngestState { return []DatasourcePackageIngestState{ "STARTED", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "IAM_ROLE", @@ -71,8 +74,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for Field. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Field) Values() []Field { return []Field{ "SEVERITY", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for IndicatorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndicatorType) Values() []IndicatorType { return []IndicatorType{ "TTP_OBSERVED", @@ -140,8 +146,9 @@ const ( ) // Values returns all known values for InvitationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvitationType) Values() []InvitationType { return []InvitationType{ "INVITATION", @@ -158,8 +165,9 @@ const ( ) // Values returns all known values for MemberDisabledReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberDisabledReason) Values() []MemberDisabledReason { return []MemberDisabledReason{ "VOLUME_TOO_HIGH", @@ -179,8 +187,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -199,8 +208,9 @@ const ( ) // Values returns all known values for Reason. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Reason) Values() []Reason { return []Reason{ "AWS_THREAT_INTELLIGENCE", @@ -219,8 +229,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "INFORMATIONAL", @@ -240,8 +251,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -258,8 +270,9 @@ const ( ) // 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. +// the future, and so 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{ "ACTIVE", @@ -277,8 +290,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "RUNNING", diff --git a/service/detective/types/errors.go b/service/detective/types/errors.go index b06250bcb3c..ce9763d0e6b 100644 --- a/service/detective/types/errors.go +++ b/service/detective/types/errors.go @@ -118,9 +118,11 @@ 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. +// // - This request cannot be completed if it would cause the number of member // accounts in the behavior graph to exceed the maximum allowed. A behavior graph // cannot have more than 1,200 member accounts. +// // - This request cannot be completed if the current volume ingested is above // the limit of 10 TB per day. Detective will not allow you to add additional // member accounts. diff --git a/service/detective/types/types.go b/service/detective/types/types.go index e65efd92b96..f5cf8135c22 100644 --- a/service/detective/types/types.go +++ b/service/detective/types/types.go @@ -180,8 +180,9 @@ type Indicator struct { // an artifact observed in or on a network, system, or environment that can (with a // high level of confidence) identify malicious activity or a security incident. // For the list of indicators of compromise that are generated by Detective -// investigations, see Detective investigations (https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html) -// . +// investigations, see [Detective investigations]. +// +// [Detective investigations]: https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html type IndicatorDetail struct { // Suspicious IP addresses that are flagged, which indicates critical or severe @@ -259,9 +260,13 @@ type MemberDetail struct { 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: + // 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. @@ -273,9 +278,12 @@ type MemberDetail struct { // The ARN of the behavior graph. 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 . + // 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 . InvitationType InvitationType // For invited accounts, the date and time that Detective sent the invitation to @@ -290,12 +298,14 @@ type MemberDetail struct { MasterId *string // The member account data volume as a percentage of the maximum allowed data - // volume. 0 indicates 0 percent, and 100 indicates 100 percent. Note that this is - // not the percentage of the behavior graph data volume. For example, the data - // volume for the behavior graph is 80 GB per day. The maximum data volume is 160 - // GB per day. If the data volume for the member account is 40 GB per day, then - // PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data - // volume. + // volume. 0 indicates 0 percent, and 100 indicates 100 percent. + // + // Note that this is not the percentage of the behavior graph data volume. + // + // For example, the data volume for the behavior graph is 80 GB per day. The + // maximum data volume is 160 GB per day. If the data volume for the member account + // is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of + // the maximum allowed data volume. // // Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage // instead. @@ -310,27 +320,34 @@ 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. + // 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 @@ -480,8 +497,9 @@ type TimestampForCollection struct { } // Details tactics, techniques, and procedures (TTPs) used in a potential security -// event. Tactics are based on MITRE ATT&CK Matrix for Enterprise (https://attack.mitre.org/matrices/enterprise/) -// . +// event. Tactics are based on [MITRE ATT&CK Matrix for Enterprise]. +// +// [MITRE ATT&CK Matrix for Enterprise]: https://attack.mitre.org/matrices/enterprise/ type TTPsObservedDetail struct { // The total number of failed API requests. diff --git a/service/devicefarm/api_op_CreateDevicePool.go b/service/devicefarm/api_op_CreateDevicePool.go index 7f86898ac46..5ec55a207b5 100644 --- a/service/devicefarm/api_op_CreateDevicePool.go +++ b/service/devicefarm/api_op_CreateDevicePool.go @@ -51,8 +51,9 @@ type CreateDevicePoolInput struct { // The number of devices that Device Farm can add to your device pool. Device Farm // adds devices that are available and meet the criteria that you assign for the // rules parameter. Depending on how many devices meet these constraints, your - // device pool might contain fewer devices than the value for this parameter. By - // specifying the maximum number of devices, you can control the costs that you + // device pool might contain fewer devices than the value for this parameter. + // + // By specifying the maximum number of devices, you can control the costs that you // incur by running tests. MaxDevices *int32 diff --git a/service/devicefarm/api_op_CreateInstanceProfile.go b/service/devicefarm/api_op_CreateInstanceProfile.go index 8ba30a7e619..7fe5f561d19 100644 --- a/service/devicefarm/api_op_CreateInstanceProfile.go +++ b/service/devicefarm/api_op_CreateInstanceProfile.go @@ -39,8 +39,9 @@ type CreateInstanceProfileInput struct { Description *string // 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 . + // cleaned up from the device after a test run. + // + // The list of packages is considered only if you set packageCleanup to true . ExcludeAppPackagesFromCleanup []string // When set to true , Device Farm removes app packages after a test run. The diff --git a/service/devicefarm/api_op_CreateRemoteAccessSession.go b/service/devicefarm/api_op_CreateRemoteAccessSession.go index 36b93b9152a..29a56c858d3 100644 --- a/service/devicefarm/api_op_CreateRemoteAccessSession.go +++ b/service/devicefarm/api_op_CreateRemoteAccessSession.go @@ -44,8 +44,11 @@ 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) - // . + // remoteDebugEnabled is set to true . + // + // Remote debugging is [no longer supported]. + // + // [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,12 +59,14 @@ 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. // // - 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 @@ -70,8 +75,11 @@ type CreateRemoteAccessSessionInput struct { 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]. + // + // [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 @@ -82,15 +90,20 @@ type CreateRemoteAccessSessionInput struct { 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 - // information on how Device Farm modifies your uploads during tests, see Do you - // modify my app? (http://aws.amazon.com/device-farm/faqs/) + // 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?] + // + // [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]. + // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html SshPublicKey *string noSmithyDocumentSerde diff --git a/service/devicefarm/api_op_CreateTestGridProject.go b/service/devicefarm/api_op_CreateTestGridProject.go index 74c7e47b1ab..9fabec0b760 100644 --- a/service/devicefarm/api_op_CreateTestGridProject.go +++ b/service/devicefarm/api_op_CreateTestGridProject.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Selenium testing project. Projects are used to track TestGridSession -// instances. +// Creates a Selenium testing project. Projects are used to track TestGridSession instances. func (c *Client) CreateTestGridProject(ctx context.Context, params *CreateTestGridProjectInput, optFns ...func(*Options)) (*CreateTestGridProjectOutput, error) { if params == nil { params = &CreateTestGridProjectInput{} diff --git a/service/devicefarm/api_op_CreateTestGridUrl.go b/service/devicefarm/api_op_CreateTestGridUrl.go index 10ec59444ab..1ad854099b8 100644 --- a/service/devicefarm/api_op_CreateTestGridUrl.go +++ b/service/devicefarm/api_op_CreateTestGridUrl.go @@ -35,8 +35,7 @@ type CreateTestGridUrlInput struct { // This member is required. ExpiresInSeconds *int32 - // ARN (from CreateTestGridProject or ListTestGridProjects ) to associate with the - // short-term URL. + // ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the short-term URL. // // This member is required. ProjectArn *string @@ -49,8 +48,7 @@ type CreateTestGridUrlOutput struct { // The number of seconds the URL from CreateTestGridUrlResult$url stays active. Expires *time.Time - // A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to - // be passed to a RemoteWebDriver . + // A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to 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 9aca80756be..bef02d3da0b 100644 --- a/service/devicefarm/api_op_CreateUpload.go +++ b/service/devicefarm/api_op_CreateUpload.go @@ -44,39 +44,74 @@ type CreateUploadInput struct { // This member is required. ProjectArn *string - // The upload's upload type. Must be one of the following values: + // 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. // diff --git a/service/devicefarm/api_op_DeleteProject.go b/service/devicefarm/api_op_DeleteProject.go index 77ed27d27ef..59bc06740c7 100644 --- a/service/devicefarm/api_op_DeleteProject.go +++ b/service/devicefarm/api_op_DeleteProject.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an AWS Device Farm project, given the project ARN. Deleting this -// resource does not stop an in-progress run. +// Deletes an AWS Device Farm project, given the project ARN. +// +// Deleting this resource does not stop an in-progress run. func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { if params == nil { params = &DeleteProjectInput{} diff --git a/service/devicefarm/api_op_DeleteRun.go b/service/devicefarm/api_op_DeleteRun.go index 3d4c7088e4d..67ee473a05b 100644 --- a/service/devicefarm/api_op_DeleteRun.go +++ b/service/devicefarm/api_op_DeleteRun.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the run, given the run ARN. Deleting this resource does not stop an -// in-progress run. +// Deletes the run, given the run ARN. +// +// Deleting this resource does not stop an in-progress run. func (c *Client) DeleteRun(ctx context.Context, params *DeleteRunInput, optFns ...func(*Options)) (*DeleteRunOutput, error) { if params == nil { params = &DeleteRunInput{} diff --git a/service/devicefarm/api_op_DeleteTestGridProject.go b/service/devicefarm/api_op_DeleteTestGridProject.go index 5858a246d94..a3bea2449f0 100644 --- a/service/devicefarm/api_op_DeleteTestGridProject.go +++ b/service/devicefarm/api_op_DeleteTestGridProject.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Selenium testing project and all content generated under it. You -// cannot undo this operation. You cannot delete a project if it has active -// sessions. +// Deletes a Selenium testing project and all content generated under it. +// +// You cannot undo this operation. +// +// You cannot delete a project if it has active sessions. func (c *Client) DeleteTestGridProject(ctx context.Context, params *DeleteTestGridProjectInput, optFns ...func(*Options)) (*DeleteTestGridProjectOutput, error) { if params == nil { params = &DeleteTestGridProjectInput{} @@ -30,8 +32,7 @@ func (c *Client) DeleteTestGridProject(ctx context.Context, params *DeleteTestGr type DeleteTestGridProjectInput struct { - // The ARN of the project to delete, from CreateTestGridProject or - // ListTestGridProjects . + // The ARN of the project to delete, from CreateTestGridProject or ListTestGridProjects. // // This member is required. ProjectArn *string diff --git a/service/devicefarm/api_op_GetDevicePoolCompatibility.go b/service/devicefarm/api_op_GetDevicePoolCompatibility.go index 58f2184c25e..83ea36258d7 100644 --- a/service/devicefarm/api_op_GetDevicePoolCompatibility.go +++ b/service/devicefarm/api_op_GetDevicePoolCompatibility.go @@ -44,26 +44,45 @@ type GetDevicePoolCompatibilityInput struct { // Information about the uploaded test to be run against the device pool. Test *types.ScheduleRunTest - // The test type for the specified device pool. Allowed values include the - // following: + // 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. TestType types.TestType diff --git a/service/devicefarm/api_op_GetOfferingStatus.go b/service/devicefarm/api_op_GetOfferingStatus.go index c382b420d03..45bfeb955dd 100644 --- a/service/devicefarm/api_op_GetOfferingStatus.go +++ b/service/devicefarm/api_op_GetOfferingStatus.go @@ -15,8 +15,7 @@ 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. 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_GetTestGridProject.go b/service/devicefarm/api_op_GetTestGridProject.go index 26bc3ac7c9c..4de85f1a8a0 100644 --- a/service/devicefarm/api_op_GetTestGridProject.go +++ b/service/devicefarm/api_op_GetTestGridProject.go @@ -29,8 +29,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 . + // The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects. // // This member is required. ProjectArn *string @@ -40,7 +39,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 a1a7af270fd..5e8215eea02 100644 --- a/service/devicefarm/api_op_GetTestGridSession.go +++ b/service/devicefarm/api_op_GetTestGridSession.go @@ -12,11 +12,11 @@ import ( ) // 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 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). func (c *Client) GetTestGridSession(ctx context.Context, params *GetTestGridSessionInput, optFns ...func(*Options)) (*GetTestGridSessionOutput, error) { if params == nil { params = &GetTestGridSessionInput{} @@ -34,11 +34,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 . + // The ARN for the project that this session belongs to. See CreateTestGridProject 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_ListArtifacts.go b/service/devicefarm/api_op_ListArtifacts.go index 2746cd222d5..2e0043b4b81 100644 --- a/service/devicefarm/api_op_ListArtifacts.go +++ b/service/devicefarm/api_op_ListArtifacts.go @@ -35,9 +35,14 @@ type ListArtifactsInput struct { // This member is required. Arn *string - // The artifacts' type. Allowed values include: + // The artifacts' type. + // + // Allowed values include: + // // - FILE + // // - LOG + // // - SCREENSHOT // // This member is required. diff --git a/service/devicefarm/api_op_ListDevicePools.go b/service/devicefarm/api_op_ListDevicePools.go index b2c35750ade..a930a21a8f5 100644 --- a/service/devicefarm/api_op_ListDevicePools.go +++ b/service/devicefarm/api_op_ListDevicePools.go @@ -39,8 +39,12 @@ type ListDevicePoolsInput struct { // can be used to return the next set of items in the list. NextToken *string - // The device pools' type. Allowed values include: + // 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. Type types.DevicePoolType diff --git a/service/devicefarm/api_op_ListDevices.go b/service/devicefarm/api_op_ListDevices.go index 68d4b046775..0ab1e42ba92 100644 --- a/service/devicefarm/api_op_ListDevices.go +++ b/service/devicefarm/api_op_ListDevices.go @@ -35,42 +35,66 @@ 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: + // 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. + // Valid values are TRUE or FALSE. Because remote debugging is [no longer supported], 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 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. + // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html Filters []types.DeviceFilter // An identifier that was returned from the previous call to this operation, which diff --git a/service/devicefarm/api_op_ListOfferingPromotions.go b/service/devicefarm/api_op_ListOfferingPromotions.go index 8f36ca7e97d..7dd18976f82 100644 --- a/service/devicefarm/api_op_ListOfferingPromotions.go +++ b/service/devicefarm/api_op_ListOfferingPromotions.go @@ -13,9 +13,8 @@ import ( // Returns a list of offering promotions. Each offering promotion record contains // the ID and description of the promotion. The API returns a NotEligible error if -// the caller is not permitted to invoke the operation. Contact -// aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) if -// you must be able to invoke this operation. +// the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.comif you must be +// able to invoke this operation. func (c *Client) ListOfferingPromotions(ctx context.Context, params *ListOfferingPromotionsInput, optFns ...func(*Options)) (*ListOfferingPromotionsOutput, error) { if params == nil { params = &ListOfferingPromotionsInput{} diff --git a/service/devicefarm/api_op_ListOfferingTransactions.go b/service/devicefarm/api_op_ListOfferingTransactions.go index b5a8b36c637..3615e0f97d5 100644 --- a/service/devicefarm/api_op_ListOfferingTransactions.go +++ b/service/devicefarm/api_op_ListOfferingTransactions.go @@ -15,8 +15,7 @@ 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. 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 d6d3e3130a5..a73a44309d7 100644 --- a/service/devicefarm/api_op_ListOfferings.go +++ b/service/devicefarm/api_op_ListOfferings.go @@ -15,8 +15,7 @@ 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. 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_ListTestGridProjects.go b/service/devicefarm/api_op_ListTestGridProjects.go index c08685a1635..cf0186f91e1 100644 --- a/service/devicefarm/api_op_ListTestGridProjects.go +++ b/service/devicefarm/api_op_ListTestGridProjects.go @@ -40,11 +40,10 @@ type ListTestGridProjectsInput struct { type ListTestGridProjectsOutput struct { - // Used for pagination. Pass into ListTestGridProjects to get more results in a - // paginated request. + // Used for pagination. Pass into ListTestGridProjects to get more results in a 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 0b20c2cc95c..e0fe1faf601 100644 --- a/service/devicefarm/api_op_ListTestGridSessionActions.go +++ b/service/devicefarm/api_op_ListTestGridSessionActions.go @@ -11,7 +11,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 6320ce68e3c..35d60239596 100644 --- a/service/devicefarm/api_op_ListTestGridSessionArtifacts.go +++ b/service/devicefarm/api_op_ListTestGridSessionArtifacts.go @@ -29,7 +29,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 @@ -48,7 +48,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 895b4dd5ec2..943479f7043 100644 --- a/service/devicefarm/api_op_ListTestGridSessions.go +++ b/service/devicefarm/api_op_ListTestGridSessions.go @@ -12,7 +12,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{} @@ -30,7 +30,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 @@ -64,7 +64,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 3ee069dc541..ddac212e31d 100644 --- a/service/devicefarm/api_op_ListUniqueProblems.go +++ b/service/devicefarm/api_op_ListUniqueProblems.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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 // 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) { @@ -54,13 +55,22 @@ type ListUniqueProblemsOutput struct { // operation to return the next set of items in the list. NextToken *string - // Information about the unique problems. Allowed values include: + // Information about the unique problems. + // + // Allowed values include: + // // - PENDING + // // - PASSED + // // - WARNED + // // - FAILED + // // - SKIPPED + // // - ERRORED + // // - STOPPED UniqueProblems map[string][]types.UniqueProblem diff --git a/service/devicefarm/api_op_ListUploads.go b/service/devicefarm/api_op_ListUploads.go index b7b2b1f9519..239933fd234 100644 --- a/service/devicefarm/api_op_ListUploads.go +++ b/service/devicefarm/api_op_ListUploads.go @@ -40,38 +40,72 @@ type ListUploadsInput struct { // can be used to return the next set of items in the list. NextToken *string - // The type of upload. Must be one of the following values: + // 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 Type types.UploadType diff --git a/service/devicefarm/api_op_PurchaseOffering.go b/service/devicefarm/api_op_PurchaseOffering.go index a1d2dadf41f..86e2ddd9430 100644 --- a/service/devicefarm/api_op_PurchaseOffering.go +++ b/service/devicefarm/api_op_PurchaseOffering.go @@ -14,8 +14,7 @@ import ( // Immediately purchases offerings for an AWS account. Offerings renew with the // 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) . +// invoke the operation. If you must be able to invoke this operation, contact 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 c67a55063f1..d5f2827e304 100644 --- a/service/devicefarm/api_op_RenewOffering.go +++ b/service/devicefarm/api_op_RenewOffering.go @@ -14,8 +14,7 @@ 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) -// . +// this operation, contact 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 5833d4f3326..e1256b2fed8 100644 --- a/service/devicefarm/api_op_ScheduleRun.go +++ b/service/devicefarm/api_op_ScheduleRun.go @@ -40,8 +40,7 @@ type ScheduleRunInput struct { // This member is required. Test *types.ScheduleRunTest - // The ARN of an application package to run tests against, created with - // CreateUpload . See ListUploads . + // The ARN of an application package to run tests against, created with CreateUpload. See ListUploads. AppArn *string // Information about the settings for the run to be scheduled. @@ -51,8 +50,9 @@ type ScheduleRunInput struct { DevicePoolArn *string // The filter criteria used to dynamically select a set of devices for a test run - // and the maximum number of devices to be included in the run. Either - // devicePoolArn or deviceSelectionConfiguration is required in a request. + // and the maximum number of devices to be included in the run. + // + // Either devicePoolArn or deviceSelectionConfiguration is required in a request. DeviceSelectionConfiguration *types.DeviceSelectionConfiguration // Specifies configuration information about a test run, such as the execution diff --git a/service/devicefarm/api_op_UpdateDevicePool.go b/service/devicefarm/api_op_UpdateDevicePool.go index d37fe1521d1..454cc91988d 100644 --- a/service/devicefarm/api_op_UpdateDevicePool.go +++ b/service/devicefarm/api_op_UpdateDevicePool.go @@ -41,8 +41,10 @@ type UpdateDevicePoolInput struct { // 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. + // 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. @@ -51,10 +53,13 @@ type UpdateDevicePoolInput struct { // The number of devices that Device Farm can add to your device pool. Device Farm // adds devices that are available and that meet the criteria that you assign for // the rules parameter. Depending on how many devices meet these constraints, your - // device pool might contain fewer devices than the value for this parameter. By - // specifying the maximum number of devices, you can control the costs that you - // incur by running tests. If you use this parameter in your request, you cannot - // use the clearMaxDevices parameter in the same request. + // device pool might contain fewer devices than the value for this parameter. + // + // By specifying the maximum number of devices, you can control the costs that you + // incur by running tests. + // + // If you use this parameter in your request, you cannot use the clearMaxDevices + // parameter in the same request. MaxDevices *int32 // A string that represents the name of the device pool to update. diff --git a/service/devicefarm/api_op_UpdateInstanceProfile.go b/service/devicefarm/api_op_UpdateInstanceProfile.go index d6cb65ce269..a909d552bcd 100644 --- a/service/devicefarm/api_op_UpdateInstanceProfile.go +++ b/service/devicefarm/api_op_UpdateInstanceProfile.go @@ -38,8 +38,9 @@ type UpdateInstanceProfileInput struct { Description *string // 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 . + // cleaned up from the device after a test run is over. + // + // The list of packages is only considered if you set packageCleanup to true . ExcludeAppPackagesFromCleanup []string // The updated name for your instance profile. diff --git a/service/devicefarm/doc.go b/service/devicefarm/doc.go index 0e4ea16d938..95b1d89cb32 100644 --- a/service/devicefarm/doc.go +++ b/service/devicefarm/doc.go @@ -4,13 +4,20 @@ // 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]. +// +// - 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]. +// +// [Device Farm Developer Guide]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/ +// [Testing Web Applications on Selenium with Device Farm]: https://docs.aws.amazon.com/devicefarm/latest/testgrid/ package devicefarm diff --git a/service/devicefarm/options.go b/service/devicefarm/options.go index 6ea0d54a1ed..6f65a064dc3 100644 --- a/service/devicefarm/options.go +++ b/service/devicefarm/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/devicefarm/types/enums.go b/service/devicefarm/types/enums.go index 6a5e95704e8..6a6102c0bdf 100644 --- a/service/devicefarm/types/enums.go +++ b/service/devicefarm/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ArtifactCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactCategory) Values() []ArtifactCategory { return []ArtifactCategory{ "SCREENSHOT", @@ -57,8 +58,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -101,8 +103,9 @@ const ( ) // Values returns all known values for BillingMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BillingMethod) Values() []BillingMethod { return []BillingMethod{ "METERED", @@ -118,8 +121,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -146,8 +150,9 @@ const ( ) // Values returns all known values for DeviceAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceAttribute) Values() []DeviceAttribute { return []DeviceAttribute{ "ARN", @@ -177,8 +182,9 @@ const ( ) // Values returns all known values for DeviceAvailability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceAvailability) Values() []DeviceAvailability { return []DeviceAvailability{ "TEMPORARY_NOT_AVAILABLE", @@ -207,8 +213,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ARN", @@ -235,8 +242,9 @@ const ( ) // Values returns all known values for DeviceFormFactor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceFormFactor) Values() []DeviceFormFactor { return []DeviceFormFactor{ "PHONE", @@ -253,8 +261,9 @@ const ( ) // Values returns all known values for DevicePlatform. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DevicePlatform) Values() []DevicePlatform { return []DevicePlatform{ "ANDROID", @@ -271,8 +280,9 @@ const ( ) // Values returns all known values for DevicePoolType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DevicePoolType) Values() []DevicePoolType { return []DevicePoolType{ "CURATED", @@ -294,8 +304,9 @@ const ( ) // Values returns all known values for ExecutionResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionResult) Values() []ExecutionResult { return []ExecutionResult{ "PENDING", @@ -317,8 +328,9 @@ const ( ) // Values returns all known values for ExecutionResultCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionResultCode) Values() []ExecutionResultCode { return []ExecutionResultCode{ "PARSING_FAILED", @@ -342,8 +354,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "PENDING", @@ -369,8 +382,9 @@ const ( ) // Values returns all known values for InstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStatus) Values() []InstanceStatus { return []InstanceStatus{ "IN_USE", @@ -390,8 +404,9 @@ const ( ) // Values returns all known values for InteractionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InteractionMode) Values() []InteractionMode { return []InteractionMode{ "INTERACTIVE", @@ -409,8 +424,9 @@ const ( ) // Values returns all known values for NetworkProfileType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkProfileType) Values() []NetworkProfileType { return []NetworkProfileType{ "CURATED", @@ -428,8 +444,9 @@ const ( ) // Values returns all known values for OfferingTransactionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferingTransactionType) Values() []OfferingTransactionType { return []OfferingTransactionType{ "PURCHASE", @@ -446,8 +463,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -463,6 +481,7 @@ const ( // 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{ @@ -485,8 +504,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -524,8 +544,9 @@ const ( ) // Values returns all known values for SampleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SampleType) Values() []SampleType { return []SampleType{ "CPU", @@ -558,8 +579,9 @@ const ( // Values returns all known values for TestGridSessionArtifactCategory. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestGridSessionArtifactCategory) Values() []TestGridSessionArtifactCategory { return []TestGridSessionArtifactCategory{ "VIDEO", @@ -578,6 +600,7 @@ const ( // Values returns all known values for TestGridSessionArtifactType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TestGridSessionArtifactType) Values() []TestGridSessionArtifactType { return []TestGridSessionArtifactType{ @@ -597,8 +620,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -635,8 +659,9 @@ const ( ) // Values returns all known values for TestType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestType) Values() []TestType { return []TestType{ "BUILTIN_FUZZ", @@ -672,8 +697,9 @@ const ( ) // Values returns all known values for UploadCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UploadCategory) Values() []UploadCategory { return []UploadCategory{ "CURATED", @@ -692,8 +718,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -742,8 +769,9 @@ const ( ) // Values returns all known values for UploadType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UploadType) Values() []UploadType { return []UploadType{ "ANDROID_APP", diff --git a/service/devicefarm/types/errors.go b/service/devicefarm/types/errors.go index 88019bc032f..66bbe0c9c8f 100644 --- a/service/devicefarm/types/errors.go +++ b/service/devicefarm/types/errors.go @@ -85,9 +85,8 @@ func (e *IdempotencyException) ErrorCode() string { } func (e *IdempotencyException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An internal exception was raised in the service. Contact -// aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) if -// you see this error. +// An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this +// error. type InternalServiceException struct { Message *string diff --git a/service/devicefarm/types/types.go b/service/devicefarm/types/types.go index 2aafd161d51..bc28c2ba399 100644 --- a/service/devicefarm/types/types.go +++ b/service/devicefarm/types/types.go @@ -26,9 +26,12 @@ type AccountSettings struct { 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. + // 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?] in the AWS + // Device Farm FAQs. + // + // [Do you modify my app?]: http://aws.amazon.com/device-farm/faqs/ SkipAppResign *bool // Information about an AWS account's usage of free trial device minutes. @@ -57,35 +60,65 @@ type Artifact struct { // The artifact's name. Name *string - // The artifact's type. Allowed values include the following: + // 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 Type ArtifactType @@ -154,7 +187,9 @@ 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 . type CustomerArtifactPaths struct { @@ -180,7 +215,7 @@ type Device struct { Arn *string // Indicates how likely a device is available for a test run. Currently available - // in the ListDevices and GetDevice API methods. + // in the ListDevicesand GetDevice API methods. Availability DeviceAvailability // The device's carrier. @@ -196,8 +231,12 @@ type Device struct { // PUBLIC. FleetType *string - // The device's form factor. Allowed values include: + // The device's form factor. + // + // Allowed values include: + // // - PHONE + // // - TABLET FormFactor DeviceFormFactor @@ -228,8 +267,12 @@ type Device struct { // The device's operating system type. Os *string - // The device's platform. Allowed values include: + // The device's platform. + // + // Allowed values include: + // // - ANDROID + // // - IOS Platform DevicePlatform @@ -239,9 +282,11 @@ type Device struct { // Specifies whether remote access has been enabled for the specified device. 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) - // . + // This flag is set to true if remote debugging is enabled for the device. + // + // Remote debugging is [no longer supported]. + // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html RemoteDebugEnabled *bool // The resolution of the device. @@ -252,34 +297,73 @@ 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 - // 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 + // 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 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 + // 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], 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 + // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html // // This member is required. Attribute DeviceFilterAttribute @@ -290,15 +374,24 @@ type DeviceFilter struct { // This member is required. Operator RuleOperator - // An array of one or more filter values used in a device filter. Operator Values + // 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. // // This member is required. @@ -361,8 +454,9 @@ type DevicePool struct { // The number of devices that Device Farm can add to your device pool. Device Farm // adds devices that are available and meet the criteria that you assign for the // rules parameter. Depending on how many devices meet these constraints, your - // device pool might contain fewer devices than the value for this parameter. By - // specifying the maximum number of devices, you can control the costs that you + // device pool might contain fewer devices than the value for this parameter. + // + // By specifying the maximum number of devices, you can control the costs that you // incur by running tests. MaxDevices *int32 @@ -372,8 +466,12 @@ type DevicePool struct { // Information about the device pool's rules. Rules []Rule - // The device pool's type. Allowed values include: + // 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. Type DevicePoolType @@ -398,52 +496,88 @@ 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: + // + // - 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. + // Valid values are TRUE or FALSE. Because remote debugging is [no longer supported], 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. + // + // - 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 + // + // - 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 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. // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html + // // This member is required. Filters []DeviceFilter @@ -456,8 +590,8 @@ type DeviceSelectionConfiguration struct { } // 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 . +// 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. @@ -489,9 +623,12 @@ type ExecutionConfiguration struct { 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. + // 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?] in the AWS + // Device Farm FAQs. + // + // [Do you modify my app?]: http://aws.amazon.com/device-farm/faqs/ SkipAppResign *bool // Set to true to enable video capture. Otherwise, set to false. The default is @@ -507,12 +644,20 @@ type IncompatibilityMessage struct { // A message about the incompatibility. Message *string - // The type of incompatibility. Allowed values include: + // 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 Type DeviceAttribute @@ -529,8 +674,9 @@ type InstanceProfile struct { Description *string // 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 . + // cleaned up from the device after a test run completes. + // + // The list of packages is considered only if you set packageCleanup to true . ExcludeAppPackagesFromCleanup []string // The name of the instance profile. @@ -574,53 +720,93 @@ type Job struct { // The job's name. Name *string - // The job's result. Allowed values include: + // The job's result. + // + // Allowed values include: + // // - PENDING + // // - PASSED + // // - WARNED + // // - FAILED + // // - SKIPPED + // // - ERRORED + // // - STOPPED Result ExecutionResult // The job's start time. Started *time.Time - // The job's status. Allowed values include: + // The job's status. + // + // Allowed values include: + // // - 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: + // 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 Type TestType @@ -635,8 +821,9 @@ type Job struct { } // Represents a latitude and longitude pair, expressed in geographic coordinate -// system degrees (for example, 47.6204, -122.3491). Elevation is currently not -// supported. +// system degrees (for example, 47.6204, -122.3491). +// +// Elevation is currently not supported. type Location struct { // The latitude. @@ -794,13 +981,22 @@ type Problem struct { // A message about the problem's result. Message *string - // The problem's result. Allowed values include: + // The problem's result. + // + // Allowed values include: + // // - PENDING + // // - PASSED + // // - WARNED + // // - FAILED + // // - SKIPPED + // // - ERRORED + // // - STOPPED Result ExecutionResult @@ -888,15 +1084,17 @@ 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]. + // + // [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) - // . + // if remote debugging is enabled for the remote access session. + // + // Remote debugging is [no longer supported]. + // + // [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. @@ -910,9 +1108,11 @@ type RemoteAccessSession struct { DeviceMinutes *DeviceMinutes // 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) - // . + // debugging is enabled for the remote access session. + // + // Remote debugging is [no longer supported]. + // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html DeviceUdid *string // The endpoint for the remote access sesssion. @@ -920,20 +1120,24 @@ 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]. + // + // [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. InteractionMode InteractionMode @@ -945,8 +1149,11 @@ 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]. + // + // [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. @@ -957,33 +1164,52 @@ 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. 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. + // 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?] in the AWS + // Device Farm FAQs. + // + // [Do you modify my app?]: http://aws.amazon.com/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. Status ExecutionStatus @@ -1013,30 +1239,69 @@ type Resolution struct { type Rule struct { // 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 + // + // 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 + // 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. + // 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], this filter is ignored. + // + // [no longer supported]: https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html Attribute DeviceAttribute // Specifies how Device Farm compares the rule's attribute to the value. For the @@ -1060,9 +1325,10 @@ type Run struct { 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 - // device slots, you must set this to unmetered to use them. Otherwise, the run is - // counted toward metered device minutes. + // 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 // The total number of completed jobs. @@ -1113,21 +1379,34 @@ type Run struct { // it doesn't parse appears in the file that this URL points to. ParsingResultUrl *string - // The run's platform. Allowed values include: + // The run's platform. + // + // Allowed values include: + // // - ANDROID + // // - IOS Platform DevicePlatform // Information about the radio states for the run. Radios *Radios - // The run's result. Allowed values include: + // The run's result. + // + // Allowed values include: + // // - PENDING + // // - PASSED + // // - WARNED + // // - FAILED + // // - SKIPPED + // // - ERRORED + // // - STOPPED Result ExecutionResult @@ -1140,23 +1419,37 @@ type Run struct { 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. + // 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?] in the AWS + // Device Farm FAQs. + // + // [Do you modify my app?]: http://aws.amazon.com/device-farm/faqs/ SkipAppResign *bool // The run's start time. Started *time.Time - // The run's status. Allowed values include: + // The run's status. + // + // Allowed values include: + // // - PENDING + // // - PENDING_CONCURRENCY + // // - PENDING_DEVICE + // // - PROCESSING + // // - SCHEDULING + // // - PREPARING + // // - RUNNING + // // - COMPLETED + // // - STOPPING Status ExecutionStatus @@ -1169,25 +1462,47 @@ type Run struct { // The total number of jobs for the run. TotalJobs *int32 - // The run's type. Must be one of the following values: + // 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. + // + // - 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 @@ -1206,27 +1521,46 @@ type Sample struct { // The sample's ARN. Arn *string - // The sample's type. Must be one of the following values: + // 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. Type SampleType @@ -1246,9 +1580,11 @@ type ScheduleRunConfiguration struct { 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 - // unmetered device slots, you must set this parameter to unmetered to make use of - // them. Otherwise, your run counts against your metered time. + // 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 // Input CustomerArtifactPaths object for the scheduled run configuration. @@ -1277,29 +1613,48 @@ type ScheduleRunConfiguration struct { } // 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 . +// 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: + // 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 // // This member is required. @@ -1309,48 +1664,82 @@ type ScheduleRunTest struct { Filter *string // The test's parameters, such as test framework parameters and fixture settings. - // Parameters are represented by name-value pairs of strings. For all tests: + // 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. + // // 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). + // // 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. + // // 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. + // // 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 + // // 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 + // // 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 Parameters map[string]string @@ -1384,53 +1773,95 @@ type Suite struct { // The suite's name. Name *string - // The suite's result. Allowed values include: + // The suite's result. + // + // Allowed values include: + // // - PENDING + // // - PASSED + // // - WARNED + // // - FAILED + // // - SKIPPED + // // - ERRORED + // // - STOPPED Result ExecutionResult // The suite's start time. Started *time.Time - // The suite's status. Allowed values include: + // The suite's status. + // + // Allowed values include: + // // - 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: + // 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. + // + // - 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 @@ -1479,53 +1910,95 @@ type Test struct { // The test's name. Name *string - // The test's result. Allowed values include: + // The test's result. + // + // Allowed values include: + // // - PENDING + // // - PASSED + // // - WARNED + // // - FAILED + // // - SKIPPED + // // - ERRORED + // // - STOPPED Result ExecutionResult // The test's start time. Started *time.Time - // The test's status. Allowed values include: + // The test's status. + // + // Allowed values include: + // // - 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: + // 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. + // + // - 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 @@ -1553,8 +2026,8 @@ type TestGridProject struct { noSmithyDocumentSerde } -// A TestGridSession is a single instance of a browser launched from the URL -// provided by a call to CreateTestGridUrl . +// A TestGridSession is a single instance of a browser launched from the URL provided by a call +// to CreateTestGridUrl. type TestGridSession struct { // The ARN of the session. @@ -1600,8 +2073,10 @@ type TestGridSessionAction struct { } // Artifacts are video and other files that are produced in the process of running -// a browser in an automated context. Video elements might be broken up into -// multiple artifacts as they grow in size during creation. +// a browser in an automated context. +// +// Video elements might be broken up into multiple artifacts as they grow in size +// during creation. type TestGridSessionArtifact struct { // The file name of the artifact. @@ -1668,7 +2143,9 @@ 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. Category UploadCategory @@ -1689,45 +2166,85 @@ type Upload struct { // The upload's file name. Name *string - // The upload's status. Must be one of the following values: + // The upload's status. + // + // Must be one of the following values: + // // - FAILED + // // - INITIALIZED + // // - PROCESSING + // // - SUCCEEDED Status UploadStatus - // The upload's type. Must be one of the following values: + // 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 Type UploadType diff --git a/service/devopsguru/api_op_AddNotificationChannel.go b/service/devopsguru/api_op_AddNotificationChannel.go index 64d29a4406c..2c15622c5ba 100644 --- a/service/devopsguru/api_op_AddNotificationChannel.go +++ b/service/devopsguru/api_op_AddNotificationChannel.go @@ -11,18 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a notification channel to DevOps Guru. A notification channel is used to +// Adds a notification channel to DevOps Guru. A notification channel is used to +// // notify you about important DevOps Guru events, such as when an insight is -// generated. If you use an Amazon SNS topic in another account, you must attach a -// policy to it that grants DevOps Guru permission to send 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 Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) -// . If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key +// generated. +// +// If you use an Amazon SNS topic in another account, you must attach a policy to +// it that grants DevOps Guru permission to send 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 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) -// . +// the CMK. For more information, see [Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics]. +// +// [Permissions for Amazon SNS topics]: https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html +// [Permissions for Amazon Web 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{} @@ -40,7 +45,7 @@ func (c *Client) AddNotificationChannel(ctx context.Context, params *AddNotifica type AddNotificationChannelInput struct { - // A NotificationChannelConfig object that specifies what type of notification + // A NotificationChannelConfig object that specifies what type of notification // channel to add. The one supported notification channel is Amazon Simple // Notification Service (Amazon SNS). // @@ -52,7 +57,7 @@ type AddNotificationChannelInput struct { type AddNotificationChannelOutput struct { - // The ID of the added notification channel. + // The ID of the added notification channel. // // This member is required. Id *string diff --git a/service/devopsguru/api_op_DescribeAccountHealth.go b/service/devopsguru/api_op_DescribeAccountHealth.go index 47af977ddb6..cf48793d0ca 100644 --- a/service/devopsguru/api_op_DescribeAccountHealth.go +++ b/service/devopsguru/api_op_DescribeAccountHealth.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the number of open reactive insights, the number of open proactive +// Returns the number of open reactive insights, the number of open proactive +// // insights, and the number of metrics analyzed in your Amazon Web Services // account. Use these numbers to gauge the health of operations in your Amazon Web // Services account. @@ -35,19 +36,19 @@ type DescribeAccountHealthInput struct { type DescribeAccountHealthOutput struct { - // An integer that specifies the number of metrics that have been analyzed in your - // Amazon Web Services account. + // An integer that specifies the number of metrics that have been analyzed in + // your Amazon Web Services account. // // This member is required. MetricsAnalyzed int32 - // An integer that specifies the number of open proactive insights in your Amazon + // An integer that specifies the number of open proactive insights in your Amazon // Web Services account. // // This member is required. OpenProactiveInsights int32 - // An integer that specifies the number of open reactive insights in your Amazon + // An integer that specifies the number of open reactive insights in your Amazon // Web Services account. // // This member is required. @@ -59,7 +60,7 @@ type DescribeAccountHealthOutput struct { // This member is required. ResourceHours *int64 - // Number of resources that DevOps Guru is monitoring in your Amazon Web Services + // Number of resources that DevOps Guru is monitoring in your Amazon Web Services // account. AnalyzedResourceCount *int64 diff --git a/service/devopsguru/api_op_DescribeAccountOverview.go b/service/devopsguru/api_op_DescribeAccountOverview.go index f51ddbcd3e5..3dad2ccfa5f 100644 --- a/service/devopsguru/api_op_DescribeAccountOverview.go +++ b/service/devopsguru/api_op_DescribeAccountOverview.go @@ -11,7 +11,8 @@ import ( "time" ) -// For the time range passed in, returns the number of open reactive insight that +// For the time range passed in, returns the number of open reactive insight that +// // were created, the number of open proactive insights that were created, and the // Mean Time to Recover (MTTR) for all closed reactive insights. func (c *Client) DescribeAccountOverview(ctx context.Context, params *DescribeAccountOverviewInput, optFns ...func(*Options)) (*DescribeAccountOverviewOutput, error) { @@ -31,14 +32,14 @@ func (c *Client) DescribeAccountOverview(ctx context.Context, params *DescribeAc type DescribeAccountOverviewInput struct { - // The start of the time range passed in. The start time granularity is at the day - // level. The floor of the start time is used. Returned information occurred after - // this day. + // The start of the time range passed in. The start time granularity is at the + // day level. The floor of the start time is used. Returned information occurred + // after this day. // // This member is required. FromTime *time.Time - // The end of the time range passed in. The start time granularity is at the day + // The end of the time range passed in. The start time granularity is at the day // level. The floor of the start time is used. Returned information occurred before // this day. If this is not specified, then the current day is used. ToTime *time.Time @@ -48,19 +49,19 @@ type DescribeAccountOverviewInput struct { type DescribeAccountOverviewOutput struct { - // The Mean Time to Recover (MTTR) for all closed insights that were created + // 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 - // An integer that specifies the number of open proactive insights in your Amazon + // An integer that specifies the number of open proactive insights in your Amazon // Web Services account that were created during the time range passed in. // // This member is required. ProactiveInsights int32 - // An integer that specifies the number of open reactive insights in your Amazon + // An integer that specifies the number of open reactive insights in your Amazon // Web Services account that were created during the time range passed in. // // This member is required. diff --git a/service/devopsguru/api_op_DescribeAnomaly.go b/service/devopsguru/api_op_DescribeAnomaly.go index c377e9f50fc..acd54d323bf 100644 --- a/service/devopsguru/api_op_DescribeAnomaly.go +++ b/service/devopsguru/api_op_DescribeAnomaly.go @@ -29,7 +29,7 @@ func (c *Client) DescribeAnomaly(ctx context.Context, params *DescribeAnomalyInp type DescribeAnomalyInput struct { - // The ID of the anomaly. + // The ID of the anomaly. // // This member is required. Id *string @@ -42,10 +42,10 @@ type DescribeAnomalyInput struct { type DescribeAnomalyOutput struct { - // A ProactiveAnomaly object that represents the requested anomaly. + // A ProactiveAnomaly object that represents the requested anomaly. ProactiveAnomaly *types.ProactiveAnomaly - // A ReactiveAnomaly object that represents the requested anomaly. + // A ReactiveAnomaly object that represents the requested anomaly. ReactiveAnomaly *types.ReactiveAnomaly // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_DescribeFeedback.go b/service/devopsguru/api_op_DescribeFeedback.go index 518a358fc2d..784a3106a32 100644 --- a/service/devopsguru/api_op_DescribeFeedback.go +++ b/service/devopsguru/api_op_DescribeFeedback.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the most recent feedback submitted in the current Amazon Web Services +// Returns the most recent feedback submitted in the current Amazon Web Services +// // account and Region. func (c *Client) DescribeFeedback(ctx context.Context, params *DescribeFeedbackInput, optFns ...func(*Options)) (*DescribeFeedbackOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) DescribeFeedback(ctx context.Context, params *DescribeFeedbackI type DescribeFeedbackInput struct { - // The ID of the insight for which the feedback was provided. + // The ID of the insight for which the feedback was provided. InsightId *string noSmithyDocumentSerde @@ -38,7 +39,7 @@ type DescribeFeedbackInput struct { type DescribeFeedbackOutput struct { - // Information about insight feedback received from a customer. + // Information about insight feedback received from a customer. InsightFeedback *types.InsightFeedback // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_DescribeInsight.go b/service/devopsguru/api_op_DescribeInsight.go index c9e9e7db31e..bc4f388674b 100644 --- a/service/devopsguru/api_op_DescribeInsight.go +++ b/service/devopsguru/api_op_DescribeInsight.go @@ -29,7 +29,7 @@ func (c *Client) DescribeInsight(ctx context.Context, params *DescribeInsightInp type DescribeInsightInput struct { - // The ID of the insight. + // The ID of the insight. // // This member is required. Id *string @@ -42,10 +42,10 @@ type DescribeInsightInput struct { type DescribeInsightOutput struct { - // A ProactiveInsight object that represents the requested insight. + // A ProactiveInsight object that represents the requested insight. ProactiveInsight *types.ProactiveInsight - // A ReactiveInsight object that represents the requested insight. + // A ReactiveInsight object that represents the requested insight. ReactiveInsight *types.ReactiveInsight // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_DescribeOrganizationOverview.go b/service/devopsguru/api_op_DescribeOrganizationOverview.go index 34d9334e08a..7544e86ffe2 100644 --- a/service/devopsguru/api_op_DescribeOrganizationOverview.go +++ b/service/devopsguru/api_op_DescribeOrganizationOverview.go @@ -30,9 +30,9 @@ func (c *Client) DescribeOrganizationOverview(ctx context.Context, params *Descr type DescribeOrganizationOverviewInput struct { - // The start of the time range passed in. The start time granularity is at the day - // level. The floor of the start time is used. Returned information occurred after - // this day. + // The start of the time range passed in. The start time granularity is at the + // day level. The floor of the start time is used. Returned information occurred + // after this day. // // This member is required. FromTime *time.Time @@ -43,7 +43,7 @@ type DescribeOrganizationOverviewInput struct { // The ID of the organizational unit. OrganizationalUnitIds []string - // The end of the time range passed in. The start time granularity is at the day + // The end of the time range passed in. The start time granularity is at the day // level. The floor of the start time is used. Returned information occurred before // this day. If this is not specified, then the current day is used. ToTime *time.Time diff --git a/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go b/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go index 237730d52b6..a0eb1c1e60e 100644 --- a/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go +++ b/service/devopsguru/api_op_DescribeOrganizationResourceCollectionHealth.go @@ -31,7 +31,7 @@ func (c *Client) DescribeOrganizationResourceCollectionHealth(ctx context.Contex type DescribeOrganizationResourceCollectionHealthInput struct { - // An Amazon Web Services resource collection type. This type specifies how + // An Amazon Web Services resource collection type. This type specifies how // analyzed Amazon Web Services resources are defined. 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 @@ -81,23 +81,30 @@ 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) - // whitepaper. Each Amazon Web Services tag has two parts. + // see the [Tagging best practices]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 - // 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 + // + // 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . + // + // [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html 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 a14218b2af8..1b8f7ed17e9 100644 --- a/service/devopsguru/api_op_DescribeResourceCollectionHealth.go +++ b/service/devopsguru/api_op_DescribeResourceCollectionHealth.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the number of open proactive insights, open reactive insights, and the +// Returns the number of open proactive insights, open reactive insights, and the +// // Mean Time to Recover (MTTR) for all closed insights in resource collections in // your account. You specify the type of Amazon Web Services resources collection. // The two types of Amazon Web Services resource collections supported are Amazon @@ -37,7 +38,7 @@ func (c *Client) DescribeResourceCollectionHealth(ctx context.Context, params *D type DescribeResourceCollectionHealthInput struct { - // An Amazon Web Services resource collection type. This type specifies how + // An Amazon Web Services resource collection type. This type specifies how // analyzed Amazon Web Services resources are defined. 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 @@ -57,7 +58,7 @@ type DescribeResourceCollectionHealthInput struct { type DescribeResourceCollectionHealthOutput struct { - // The returned CloudFormationHealthOverview object that contains an + // The returned CloudFormationHealthOverview object that contains an // InsightHealthOverview object with the requested system health information. CloudFormation []types.CloudFormationHealth @@ -70,28 +71,37 @@ type DescribeResourceCollectionHealthOutput struct { Service []types.ServiceHealth // The Amazon Web Services tags that are used by resources in the resource - // collection. 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) - // whitepaper. Each Amazon Web Services tag has two parts. + // collection. + // + // 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]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 - // 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 + // + // 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . + // + // [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html 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 a56207a0acc..cf43c4e3e34 100644 --- a/service/devopsguru/api_op_DescribeServiceIntegration.go +++ b/service/devopsguru/api_op_DescribeServiceIntegration.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the integration status of services that are integrated with DevOps +// 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. @@ -36,7 +37,7 @@ type DescribeServiceIntegrationInput struct { type DescribeServiceIntegrationOutput struct { - // Information about the integration of DevOps Guru with another Amazon Web + // Information about the integration of DevOps Guru with another Amazon Web // Services service, such as Amazon Web Services Systems Manager. ServiceIntegration *types.ServiceIntegrationConfig diff --git a/service/devopsguru/api_op_GetCostEstimation.go b/service/devopsguru/api_op_GetCostEstimation.go index 934304fd0ef..a9c20e176af 100644 --- a/service/devopsguru/api_op_GetCostEstimation.go +++ b/service/devopsguru/api_op_GetCostEstimation.go @@ -12,9 +12,10 @@ 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/) . +// Web Services resources. For more information, see [Estimate your Amazon DevOps Guru costs]and [Amazon DevOps Guru pricing]. +// +// [Amazon DevOps Guru pricing]: http://aws.amazon.com/devops-guru/pricing/ +// [Estimate your Amazon DevOps Guru costs]: https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html func (c *Client) GetCostEstimation(ctx context.Context, params *GetCostEstimationInput, optFns ...func(*Options)) (*GetCostEstimationOutput, error) { if params == nil { params = &GetCostEstimationInput{} diff --git a/service/devopsguru/api_op_GetResourceCollection.go b/service/devopsguru/api_op_GetResourceCollection.go index 11b112e253a..70f6dc62523 100644 --- a/service/devopsguru/api_op_GetResourceCollection.go +++ b/service/devopsguru/api_op_GetResourceCollection.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns lists Amazon Web Services resources that are of the specified resource +// Returns lists Amazon Web Services resources that are of the specified resource +// // collection type. 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 @@ -35,7 +36,7 @@ func (c *Client) GetResourceCollection(ctx context.Context, params *GetResourceC type GetResourceCollectionInput struct { - // The type of Amazon Web Services resource collections to return. The one valid + // The type of Amazon Web Services resource collections to return. The one valid // value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks. // // This member is required. @@ -54,7 +55,7 @@ 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 + // 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 diff --git a/service/devopsguru/api_op_ListAnomaliesForInsight.go b/service/devopsguru/api_op_ListAnomaliesForInsight.go index 82f3a5ec3e3..a3473224c50 100644 --- a/service/devopsguru/api_op_ListAnomaliesForInsight.go +++ b/service/devopsguru/api_op_ListAnomaliesForInsight.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the anomalies that belong to an insight that you specify +// 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 { @@ -30,7 +31,7 @@ func (c *Client) ListAnomaliesForInsight(ctx context.Context, params *ListAnomal type ListAnomaliesForInsightInput struct { - // The ID of the insight. The returned anomalies belong to this insight. + // The ID of the insight. The returned anomalies belong to this insight. // // This member is required. InsightId *string @@ -38,7 +39,7 @@ type ListAnomaliesForInsightInput struct { // The ID of the Amazon Web Services account. AccountId *string - // Specifies one or more service names that are used to list anomalies. + // Specifies one or more service names that are used to list anomalies. Filters *types.ListAnomaliesForInsightFilters // The maximum number of results to return with a single call. To retrieve the @@ -49,8 +50,8 @@ type ListAnomaliesForInsightInput struct { // operation. If this value is null, it retrieves the first page. NextToken *string - // A time range used to specify when the requested anomalies started. All returned - // anomalies started during this time range. + // A time range used to specify when the requested anomalies started. All + // returned anomalies started during this time range. StartTimeRange *types.StartTimeRange noSmithyDocumentSerde @@ -62,11 +63,11 @@ type ListAnomaliesForInsightOutput struct { // operation. If there are no more pages, this value is null. NextToken *string - // An array of ProactiveAnomalySummary objects that represent the requested + // An array of ProactiveAnomalySummary objects that represent the requested // anomalies ProactiveAnomalies []types.ProactiveAnomalySummary - // An array of ReactiveAnomalySummary objects that represent the requested + // An array of ReactiveAnomalySummary objects that represent the requested // anomalies ReactiveAnomalies []types.ReactiveAnomalySummary diff --git a/service/devopsguru/api_op_ListAnomalousLogGroups.go b/service/devopsguru/api_op_ListAnomalousLogGroups.go index 68b06df0835..17fc433f738 100644 --- a/service/devopsguru/api_op_ListAnomalousLogGroups.go +++ b/service/devopsguru/api_op_ListAnomalousLogGroups.go @@ -29,7 +29,7 @@ func (c *Client) ListAnomalousLogGroups(ctx context.Context, params *ListAnomalo type ListAnomalousLogGroupsInput struct { - // The ID of the insight containing the log groups. + // The ID of the insight containing the log groups. // // This member is required. InsightId *string @@ -47,12 +47,12 @@ type ListAnomalousLogGroupsInput struct { type ListAnomalousLogGroupsOutput struct { - // The list of Amazon CloudWatch log groups that are related to an insight. + // The list of Amazon CloudWatch log groups that are related to an insight. // // This member is required. AnomalousLogGroups []types.AnomalousLogGroup - // The ID of the insight containing the log groups. + // The ID of the insight containing the log groups. // // This member is required. InsightId *string diff --git a/service/devopsguru/api_op_ListEvents.go b/service/devopsguru/api_op_ListEvents.go index 6381b7af9ef..31c3b98d89f 100644 --- a/service/devopsguru/api_op_ListEvents.go +++ b/service/devopsguru/api_op_ListEvents.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the events emitted by the resources that are evaluated by +// Returns a list of the events emitted by the resources that are evaluated by +// // DevOps Guru. You can use filters to specify which events are returned. func (c *Client) ListEvents(ctx context.Context, params *ListEventsInput, optFns ...func(*Options)) (*ListEventsOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) ListEvents(ctx context.Context, params *ListEventsInput, optFns type ListEventsInput struct { - // A ListEventsFilters object used to specify which events to return. + // A ListEventsFilters object used to specify which events to return. // // This member is required. Filters *types.ListEventsFilters @@ -51,7 +52,7 @@ type ListEventsInput struct { type ListEventsOutput struct { - // A list of the requested events. + // A list of the requested events. // // This member is required. Events []types.Event diff --git a/service/devopsguru/api_op_ListInsights.go b/service/devopsguru/api_op_ListInsights.go index c0daf841fe8..7b48c18aaa1 100644 --- a/service/devopsguru/api_op_ListInsights.go +++ b/service/devopsguru/api_op_ListInsights.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 ). +// 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 ). func (c *Client) ListInsights(ctx context.Context, params *ListInsightsInput, optFns ...func(*Options)) (*ListInsightsOutput, error) { if params == nil { params = &ListInsightsInput{} @@ -31,7 +32,7 @@ func (c *Client) ListInsights(ctx context.Context, params *ListInsightsInput, op type ListInsightsInput struct { - // A filter used to filter the returned insights by their status. You can specify + // A filter used to filter the returned insights by their status. You can specify // one status filter. // // This member is required. @@ -54,10 +55,10 @@ type ListInsightsOutput struct { // operation. If there are no more pages, this value is null. NextToken *string - // The returned list of proactive insights. + // The returned list of proactive insights. ProactiveInsights []types.ProactiveInsightSummary - // The returned list of reactive insights. + // The returned list of reactive insights. ReactiveInsights []types.ReactiveInsightSummary // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_ListMonitoredResources.go b/service/devopsguru/api_op_ListMonitoredResources.go index 8be59ffaab9..af82b282d3d 100644 --- a/service/devopsguru/api_op_ListMonitoredResources.go +++ b/service/devopsguru/api_op_ListMonitoredResources.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the list of all log groups that are being monitored and tagged by +// 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 { @@ -30,7 +31,7 @@ func (c *Client) ListMonitoredResources(ctx context.Context, params *ListMonitor type ListMonitoredResourcesInput struct { - // Filters to determine which monitored resources you want to retrieve. You can + // Filters to determine which monitored resources you want to retrieve. You can // filter by resource type or resource permission status. Filters *types.ListMonitoredResourcesFilters @@ -47,7 +48,7 @@ type ListMonitoredResourcesInput struct { type ListMonitoredResourcesOutput struct { - // Information about the resource that is being monitored, including the name of + // Information about the resource that is being monitored, including the name of // the resource, the type of resource, and whether or not permission is given to // DevOps Guru to access that resource. // diff --git a/service/devopsguru/api_op_ListNotificationChannels.go b/service/devopsguru/api_op_ListNotificationChannels.go index 32a0090551f..859d89cd72a 100644 --- a/service/devopsguru/api_op_ListNotificationChannels.go +++ b/service/devopsguru/api_op_ListNotificationChannels.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of notification channels configured for DevOps Guru. Each +// Returns a list of notification channels configured for DevOps Guru. Each +// // notification channel is used to notify you when DevOps Guru generates an insight // that contains information about how to improve your operations. The one // supported notification channel is Amazon Simple Notification Service (Amazon @@ -42,7 +43,7 @@ type ListNotificationChannelsInput struct { type ListNotificationChannelsOutput struct { - // An array that contains the requested notification channels. + // An array that contains the requested notification channels. Channels []types.NotificationChannel // The pagination token to use to retrieve the next page of results for this diff --git a/service/devopsguru/api_op_ListOrganizationInsights.go b/service/devopsguru/api_op_ListOrganizationInsights.go index edfd107cc39..611ee2742d7 100644 --- a/service/devopsguru/api_op_ListOrganizationInsights.go +++ b/service/devopsguru/api_op_ListOrganizationInsights.go @@ -29,7 +29,7 @@ func (c *Client) ListOrganizationInsights(ctx context.Context, params *ListOrgan type ListOrganizationInsightsInput struct { - // A filter used by ListInsights to specify which insights to return. + // A filter used by ListInsights to specify which insights to return. // // This member is required. StatusFilter *types.ListInsightsStatusFilter diff --git a/service/devopsguru/api_op_ListRecommendations.go b/service/devopsguru/api_op_ListRecommendations.go index d1bf2e2ee10..a8e2f8189ba 100644 --- a/service/devopsguru/api_op_ListRecommendations.go +++ b/service/devopsguru/api_op_ListRecommendations.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of a specified insight's recommendations. Each recommendation +// Returns a list of a specified insight's recommendations. Each recommendation +// // includes a list of related metrics and a list of related events. func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommenda type ListRecommendationsInput struct { - // The ID of the requested insight. + // The ID of the requested insight. // // This member is required. InsightId *string @@ -54,7 +55,7 @@ type ListRecommendationsOutput struct { // operation. If there are no more pages, this value is null. NextToken *string - // An array of the requested recommendations. + // An array of the requested recommendations. Recommendations []types.Recommendation // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_PutFeedback.go b/service/devopsguru/api_op_PutFeedback.go index e3f8bd3f5ef..177bcfa87d6 100644 --- a/service/devopsguru/api_op_PutFeedback.go +++ b/service/devopsguru/api_op_PutFeedback.go @@ -29,7 +29,7 @@ func (c *Client) PutFeedback(ctx context.Context, params *PutFeedbackInput, optF type PutFeedbackInput struct { - // The feedback from customers is about the recommendations in this insight. + // The feedback from customers is about the recommendations in this insight. InsightFeedback *types.InsightFeedback noSmithyDocumentSerde diff --git a/service/devopsguru/api_op_RemoveNotificationChannel.go b/service/devopsguru/api_op_RemoveNotificationChannel.go index a8ccfb0185e..a2e49b33413 100644 --- a/service/devopsguru/api_op_RemoveNotificationChannel.go +++ b/service/devopsguru/api_op_RemoveNotificationChannel.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a notification channel from DevOps Guru. A notification channel is used -// to notify you when DevOps Guru generates an insight that contains information -// about how to improve your operations. +// Removes a notification channel from DevOps Guru. A notification channel is +// +// used to notify you when DevOps Guru generates an insight that contains +// information about how to improve your operations. func (c *Client) RemoveNotificationChannel(ctx context.Context, params *RemoveNotificationChannelInput, optFns ...func(*Options)) (*RemoveNotificationChannelOutput, error) { if params == nil { params = &RemoveNotificationChannelInput{} @@ -30,7 +31,7 @@ func (c *Client) RemoveNotificationChannel(ctx context.Context, params *RemoveNo type RemoveNotificationChannelInput struct { - // The ID of the notification channel to be removed. + // The ID of the notification channel to be removed. // // This member is required. Id *string diff --git a/service/devopsguru/api_op_SearchInsights.go b/service/devopsguru/api_op_SearchInsights.go index f81096c03db..7e3749547ef 100644 --- a/service/devopsguru/api_op_SearchInsights.go +++ b/service/devopsguru/api_op_SearchInsights.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) SearchInsights(ctx context.Context, params *SearchInsightsInput, optFns ...func(*Options)) (*SearchInsightsOutput, error) { if params == nil { params = &SearchInsightsInput{} @@ -34,18 +36,18 @@ func (c *Client) SearchInsights(ctx context.Context, params *SearchInsightsInput type SearchInsightsInput struct { - // The start of the time range passed in. Returned insights occurred after this + // The start of the time range passed in. Returned insights occurred after this // time. // // 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 - // A SearchInsightsFilters object that is used to set the severity and status + // A SearchInsightsFilters object that is used to set the severity and status // filters on your insight search. Filters *types.SearchInsightsFilters @@ -66,10 +68,10 @@ type SearchInsightsOutput struct { // operation. If there are no more pages, this value is null. NextToken *string - // The returned proactive insights. + // The returned proactive insights. ProactiveInsights []types.ProactiveInsightSummary - // The returned reactive insights. + // The returned reactive insights. ReactiveInsights []types.ReactiveInsightSummary // Metadata pertaining to the operation's result. diff --git a/service/devopsguru/api_op_SearchOrganizationInsights.go b/service/devopsguru/api_op_SearchOrganizationInsights.go index 50ef096a6a8..32ac8d36b75 100644 --- a/service/devopsguru/api_op_SearchOrganizationInsights.go +++ b/service/devopsguru/api_op_SearchOrganizationInsights.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your -// search. +// 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 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) { if params == nil { params = &SearchOrganizationInsightsInput{} @@ -39,18 +41,19 @@ type SearchOrganizationInsightsInput struct { // This member is required. AccountIds []string - // A time range used to specify when the behavior of an insight or anomaly started. + // A time range used to specify when the behavior of an insight or anomaly + // started. // // 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 - // A SearchOrganizationInsightsFilters object that is used to set the severity and - // status filters on your insight search. + // A SearchOrganizationInsightsFilters object that is used to set the severity + // and status filters on your insight search. Filters *types.SearchOrganizationInsightsFilters // The maximum number of results to return with a single call. To retrieve the diff --git a/service/devopsguru/api_op_UpdateResourceCollection.go b/service/devopsguru/api_op_UpdateResourceCollection.go index 69be467411a..1c1fc0edb75 100644 --- a/service/devopsguru/api_op_UpdateResourceCollection.go +++ b/service/devopsguru/api_op_UpdateResourceCollection.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the collection of resources that DevOps Guru analyzes. The two types of -// Amazon Web Services resource collections supported are Amazon Web Services +// Updates the collection of resources that DevOps Guru analyzes. 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 @@ -36,13 +37,13 @@ func (c *Client) UpdateResourceCollection(ctx context.Context, params *UpdateRes type UpdateResourceCollectionInput struct { - // Specifies if the resource collection in the request is added or deleted to the + // Specifies if the resource collection in the request is added or deleted to the // resource collection. // // This member is required. Action types.UpdateResourceCollectionAction - // Contains information used to update a collection of Amazon Web Services + // Contains information used to update a collection of Amazon Web Services // resources. // // This member is required. diff --git a/service/devopsguru/api_op_UpdateServiceIntegration.go b/service/devopsguru/api_op_UpdateServiceIntegration.go index 13eaed2da65..604e998a43b 100644 --- a/service/devopsguru/api_op_UpdateServiceIntegration.go +++ b/service/devopsguru/api_op_UpdateServiceIntegration.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables or disables integration with a service that can be integrated with +// Enables or disables integration with a service that can be 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. @@ -32,7 +33,7 @@ func (c *Client) UpdateServiceIntegration(ctx context.Context, params *UpdateSer type UpdateServiceIntegrationInput struct { - // An IntegratedServiceConfig object used to specify the integrated service you + // An IntegratedServiceConfig object used to specify the integrated service you // want to update, and whether you want to update it to enabled or disabled. // // This member is required. diff --git a/service/devopsguru/doc.go b/service/devopsguru/doc.go index d548f6d0d79..f0fc1e35c3c 100644 --- a/service/devopsguru/doc.go +++ b/service/devopsguru/doc.go @@ -3,19 +3,25 @@ // Package devopsguru provides the API client, operations, and parameter types for // Amazon DevOps Guru. // -// Amazon DevOps Guru is a fully managed service that helps you identify anomalous -// behavior in business critical operational applications. You specify the Amazon -// Web Services resources that you want DevOps Guru to cover, then the Amazon -// CloudWatch metrics and Amazon Web Services CloudTrail events related to those -// 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 +// Amazon DevOps Guru is a fully managed service that helps you identify +// +// anomalous behavior in business critical operational applications. You specify +// the Amazon Web Services resources that you want DevOps Guru to cover, then the +// Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to +// those 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]. +// +// 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) -// . +// help you manage and track your work addressing insights. +// +// To learn about the DevOps Guru workflow, see [How DevOps Guru works]. To learn about DevOps Guru +// concepts, see [Concepts in DevOps Guru]. +// +// [How DevOps Guru works]: https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works +// [What is Amazon DevOps Guru]: https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html +// [Concepts in DevOps Guru]: https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html package devopsguru diff --git a/service/devopsguru/options.go b/service/devopsguru/options.go index 07e231ee379..059f7cee616 100644 --- a/service/devopsguru/options.go +++ b/service/devopsguru/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/devopsguru/types/enums.go b/service/devopsguru/types/enums.go index 777e7ed37f1..e42b0ed9f1c 100644 --- a/service/devopsguru/types/enums.go +++ b/service/devopsguru/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AnomalySeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalySeverity) Values() []AnomalySeverity { return []AnomalySeverity{ "LOW", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AnomalyStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyStatus) Values() []AnomalyStatus { return []AnomalyStatus{ "ONGOING", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for AnomalyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyType) Values() []AnomalyType { return []AnomalyType{ "CAUSAL", @@ -69,8 +72,9 @@ const ( // Values returns all known values for CloudWatchMetricDataStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchMetricDataStatusCode) Values() []CloudWatchMetricDataStatusCode { return []CloudWatchMetricDataStatusCode{ "Complete", @@ -94,8 +98,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Sum", @@ -119,8 +124,9 @@ const ( // Values returns all known values for CostEstimationServiceResourceState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostEstimationServiceResourceState) Values() []CostEstimationServiceResourceState { return []CostEstimationServiceResourceState{ "ACTIVE", @@ -137,8 +143,9 @@ const ( ) // Values returns all known values for CostEstimationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostEstimationStatus) Values() []CostEstimationStatus { return []CostEstimationStatus{ "ONGOING", @@ -158,8 +165,9 @@ const ( ) // Values returns all known values for EventClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventClass) Values() []EventClass { return []EventClass{ "INFRASTRUCTURE", @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for EventDataSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventDataSource) Values() []EventDataSource { return []EventDataSource{ "AWS_CLOUD_TRAIL", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for EventSourceOptInStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourceOptInStatus) Values() []EventSourceOptInStatus { return []EventSourceOptInStatus{ "ENABLED", @@ -218,8 +228,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "VALID_COLLECTION", @@ -240,8 +251,9 @@ const ( ) // Values returns all known values for InsightSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightSeverity) Values() []InsightSeverity { return []InsightSeverity{ "LOW", @@ -259,8 +271,9 @@ const ( ) // Values returns all known values for InsightStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightStatus) Values() []InsightStatus { return []InsightStatus{ "ONGOING", @@ -277,8 +290,9 @@ const ( ) // Values returns all known values for InsightType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightType) Values() []InsightType { return []InsightType{ "REACTIVE", @@ -304,8 +318,9 @@ const ( ) // Values returns all known values for Locale. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Locale) Values() []Locale { return []Locale{ "DE_DE", @@ -337,8 +352,9 @@ const ( ) // Values returns all known values for LogAnomalyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogAnomalyType) Values() []LogAnomalyType { return []LogAnomalyType{ "KEYWORD", @@ -364,8 +380,9 @@ const ( ) // Values returns all known values for NotificationMessageType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationMessageType) Values() []NotificationMessageType { return []NotificationMessageType{ "NEW_INSIGHT", @@ -385,8 +402,9 @@ const ( ) // Values returns all known values for OptInStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptInStatus) Values() []OptInStatus { return []OptInStatus{ "ENABLED", @@ -406,8 +424,9 @@ const ( // Values returns all known values for OrganizationResourceCollectionType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationResourceCollectionType) Values() []OrganizationResourceCollectionType { return []OrganizationResourceCollectionType{ "AWS_CLOUD_FORMATION", @@ -427,8 +446,9 @@ const ( ) // Values returns all known values for ResourceCollectionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceCollectionType) Values() []ResourceCollectionType { return []ResourceCollectionType{ "AWS_CLOUD_FORMATION", @@ -446,8 +466,9 @@ const ( ) // Values returns all known values for ResourcePermission. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourcePermission) Values() []ResourcePermission { return []ResourcePermission{ "FULL_PERMISSION", @@ -489,8 +510,9 @@ const ( ) // Values returns all known values for ResourceTypeFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceTypeFilter) Values() []ResourceTypeFilter { return []ResourceTypeFilter{ "LOG_GROUPS", @@ -533,6 +555,7 @@ const ( // Values returns all known values for ServerSideEncryptionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServerSideEncryptionType) Values() []ServerSideEncryptionType { return []ServerSideEncryptionType{ @@ -573,8 +596,9 @@ const ( ) // Values returns all known values for ServiceName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceName) Values() []ServiceName { return []ServiceName{ "API_GATEWAY", @@ -615,8 +639,9 @@ const ( // Values returns all known values for UpdateResourceCollectionAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateResourceCollectionAction) Values() []UpdateResourceCollectionAction { return []UpdateResourceCollectionAction{ "ADD", @@ -638,6 +663,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/devopsguru/types/errors.go b/service/devopsguru/types/errors.go index 711ec37acf9..1713aebb95f 100644 --- a/service/devopsguru/types/errors.go +++ b/service/devopsguru/types/errors.go @@ -7,11 +7,13 @@ import ( smithy "github.com/aws/smithy-go" ) -// You don't have permissions to perform the requested operation. The user or role -// that is making the request must have at least one IAM permissions policy -// attached that grants the required permissions. For more information, see Access -// Management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the +// You don't have permissions to perform the requested operation. The user or +// +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. For more information, see [Access Management]in the // IAM User Guide. +// +// [Access Management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html type AccessDeniedException struct { Message *string @@ -179,7 +181,8 @@ func (e *ThrottlingException) ErrorCode() string { } func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Contains information about data passed in to a field during a request that is +// Contains information about data passed in to a field during a request that is +// // not valid. type ValidationException struct { Message *string diff --git a/service/devopsguru/types/types.go b/service/devopsguru/types/types.go index 32147ae44b0..8e1b920fd56 100644 --- a/service/devopsguru/types/types.go +++ b/service/devopsguru/types/types.go @@ -7,7 +7,8 @@ import ( "time" ) -// Returns the number of open reactive insights, the number of open proactive +// Returns the number of open reactive insights, the number of open proactive +// // insights, and the number of metrics analyzed in your Amazon Web Services // account. Use these numbers to gauge the health of operations in your Amazon Web // Services account. @@ -16,7 +17,7 @@ type AccountHealth struct { // The ID of the Amazon Web Services account. AccountId *string - // Information about the health of the Amazon Web Services resources in your + // Information about the health of the Amazon Web Services resources in your // account, including the number of open proactive, open reactive insights, and the // Mean Time to Recover (MTTR) of closed insights. Insight *AccountInsightHealth @@ -24,7 +25,8 @@ type AccountHealth struct { noSmithyDocumentSerde } -// Information about the number of open reactive and proactive insights that can +// Information about the number of open reactive and proactive insights that can +// // be used to gauge the health of your system. type AccountInsightHealth struct { @@ -52,41 +54,43 @@ type AmazonCodeGuruProfilerIntegration struct { noSmithyDocumentSerde } -// An Amazon CloudWatch log group that contains log anomalies and is used to +// An Amazon CloudWatch log group that contains log anomalies and is used to +// // generate an insight. type AnomalousLogGroup struct { - // The time the anomalous log events stopped. + // The time the anomalous log events stopped. ImpactEndTime *time.Time - // The time the anomalous log events began. The impact start time indicates the + // The time the anomalous log events began. The impact start time indicates the // time of the first log anomaly event that occurs. ImpactStartTime *time.Time - // The log anomalies in the log group. Each log anomaly displayed represents a + // The log anomalies in the log group. Each log anomaly displayed represents a // cluster of similar anomalous log events. LogAnomalyShowcases []LogAnomalyShowcase - // The name of the CloudWatch log group. + // The name of the CloudWatch log group. LogGroupName *string - // The number of log lines that were scanned for anomalous log events. + // The number of log lines that were scanned for anomalous log events. NumberOfLogLinesScanned int32 noSmithyDocumentSerde } -// A time range that specifies when DevOps Guru opens and then closes an anomaly. +// 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 // DevOps Guru actually observes the anomalous behavior. type AnomalyReportedTimeRange struct { - // The time when an anomaly is opened. + // The time when an anomaly is opened. // // This member is required. OpenTime *time.Time - // The time when an anomaly is closed. + // The time when an anomaly is closed. CloseTime *time.Time noSmithyDocumentSerde @@ -107,7 +111,8 @@ type AnomalyResource struct { noSmithyDocumentSerde } -// Details about the source of the anomalous operational data that triggered the +// Details about the source of the anomalous operational data that triggered the +// // anomaly. type AnomalySourceDetails struct { @@ -138,41 +143,48 @@ type AnomalySourceMetadata struct { noSmithyDocumentSerde } -// A time range that specifies when the observed unusual behavior in an anomaly +// A time range that specifies when the observed unusual behavior in an anomaly +// // 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 { - // The time when the anomalous behavior started. + // The time when the anomalous behavior started. // // This member is required. StartTime *time.Time - // The time when the anomalous behavior ended. + // The time when the anomalous behavior ended. EndTime *time.Time noSmithyDocumentSerde } -// Information about Amazon Web Services CloudFormation stacks. You can use up to +// 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]in the Amazon Web Services CloudFormation +// User Guide. +// +// [Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html type CloudFormationCollection struct { - // An array of CloudFormation stack names. + // An array of CloudFormation stack names. StackNames []string noSmithyDocumentSerde } -// Information about Amazon Web Services CloudFormation stacks. You can use up to +// 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]in the Amazon Web Services CloudFormation +// User Guide. +// +// [Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html type CloudFormationCollectionFilter struct { - // An array of CloudFormation stack names. + // An array of CloudFormation stack names. StackNames []string noSmithyDocumentSerde @@ -182,8 +194,10 @@ 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]in the Amazon Web Services +// CloudFormation User Guide. +// +// [Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html type CloudFormationCostEstimationResourceCollectionFilter struct { // An array of CloudFormation stack names. Its size is fixed at 1 item. @@ -192,21 +206,22 @@ type CloudFormationCostEstimationResourceCollectionFilter struct { noSmithyDocumentSerde } -// Information about the health of Amazon Web Services resources in your account +// Information about the health of Amazon Web Services resources in your account +// // that are specified by an Amazon Web Services CloudFormation stack. type CloudFormationHealth struct { - // Number of resources that DevOps Guru is monitoring in your account that are + // Number of resources that DevOps Guru is monitoring in your account that are // specified by an Amazon Web Services CloudFormation stack. AnalyzedResourceCount *int64 - // Information about the health of the Amazon Web Services resources in your + // Information about the health of the Amazon Web Services resources in your // account that are specified by an Amazon Web Services CloudFormation stack, // including the number of open proactive, open reactive insights, and the Mean // Time to Recover (MTTR) of closed insights. Insight *InsightHealth - // The name of the CloudFormation stack. + // The name of the CloudFormation stack. StackName *string noSmithyDocumentSerde @@ -229,46 +244,49 @@ type CloudWatchMetricsDataSummary struct { // Information about an Amazon CloudWatch metric. type CloudWatchMetricsDetail struct { - // An array of CloudWatch dimensions associated with + // An array of CloudWatch dimensions associated with Dimensions []CloudWatchMetricsDimension // This object returns anomaly metric data. MetricDataSummary *CloudWatchMetricsDataSummary - // The name of the CloudWatch metric. + // The name of the CloudWatch metric. MetricName *string - // The namespace of the CloudWatch metric. A namespace is a container for + // The namespace of the CloudWatch metric. A namespace is a container for // CloudWatch metrics. Namespace *string - // The length of time associated with the CloudWatch metric in number of seconds. + // The length of time associated with the CloudWatch metric in number of seconds. 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) - // in the Amazon CloudWatch User Guide. + // The type of statistic associated with the CloudWatch metric. For more + // information, see [Statistics]in the Amazon CloudWatch User Guide. + // + // [Statistics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic 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 } -// The dimension of an Amazon CloudWatch metric that is used when DevOps Guru +// The dimension of an Amazon CloudWatch metric that is used when DevOps Guru +// // 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) -// in the Amazon CloudWatch User Guide. +// metric. A metric can have up to 10 dimensions. For more information, see [Dimensions]in the +// Amazon CloudWatch User Guide. +// +// [Dimensions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension type CloudWatchMetricsDimension struct { - // The name of the CloudWatch dimension. + // The name of the CloudWatch dimension. Name *string - // The value of the CloudWatch dimension. + // The value of the CloudWatch dimension. Value *string noSmithyDocumentSerde @@ -276,8 +294,10 @@ 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]and [Amazon DevOps Guru pricing]. +// +// [Amazon DevOps Guru pricing]: http://aws.amazon.com/devops-guru/pricing/ +// [Estimate your Amazon DevOps Guru costs]: https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html type CostEstimationResourceCollectionFilter struct { // An object that specifies the CloudFormation stack that defines the Amazon Web @@ -285,28 +305,37 @@ type CostEstimationResourceCollectionFilter struct { 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 - // 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) - // whitepaper. Each Amazon Web Services tag has two parts. + // 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]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 - // 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 + // + // 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . + // + // [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html Tags []TagCostEstimationResourceCollectionFilter noSmithyDocumentSerde @@ -324,43 +353,45 @@ type CostEstimationTimeRange struct { noSmithyDocumentSerde } -// A range of time that specifies when anomalous behavior in an anomaly or insight -// ended. +// A range of time that specifies when anomalous behavior in an anomaly or +// +// insight ended. type EndTimeRange struct { - // The earliest end time in the time range. + // The earliest end time in the time range. FromTime *time.Time - // The latest end time in the time range. + // The latest end time in the time range. ToTime *time.Time noSmithyDocumentSerde } -// An Amazon Web Services resource event. Amazon Web Services resource events and +// An Amazon Web Services resource event. Amazon Web Services resource events and +// // metrics are analyzed by DevOps Guru to find anomalous behavior and provide // recommendations to improve your operational solutions. type Event struct { - // The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY , where DevOps Guru analysis + // 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 + // The class of the event. The class specifies what the event is related to, such // as an infrastructure change, a deployment, or a schema change. EventClass EventClass - // The Amazon Web Services source that emitted the event. + // The Amazon Web Services source that emitted the event. EventSource *string - // The ID of the event. + // The ID of the event. Id *string - // The name of the event. + // The name of the event. Name *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -368,28 +399,29 @@ type Event struct { // CloudFormation stacks. ResourceCollection *ResourceCollection - // An EventResource object that contains information about the resource that + // An EventResource object that contains information about the resource that // emitted the event. Resources []EventResource - // A Timestamp that specifies the time the event occurred. + // A Timestamp that specifies the time the event occurred. Time *time.Time noSmithyDocumentSerde } -// The Amazon Web Services resource that emitted an event. Amazon Web Services +// The Amazon Web Services resource that emitted an event. Amazon Web Services +// // resource events and metrics are analyzed by DevOps Guru to find anomalous // behavior and provide recommendations to improve your operational solutions. type EventResource struct { - // The Amazon Resource Name (ARN) of the resource that emitted an event. + // The Amazon Resource Name (ARN) of the resource that emitted an event. Arn *string - // The name of the resource that emitted an event. + // The name of the resource that emitted an event. Name *string - // The type of resource that emitted an event. + // The type of resource that emitted an event. Type *string noSmithyDocumentSerde @@ -406,18 +438,19 @@ type EventSourcesConfig struct { noSmithyDocumentSerde } -// The time range during which an Amazon Web Services event occurred. Amazon Web +// The time range during which an Amazon Web Services event occurred. Amazon Web +// // Services resource events and metrics are analyzed by DevOps Guru to find // anomalous behavior and provide recommendations to improve your operational // solutions. type EventTimeRange struct { - // The time when the event started. + // The time when the event started. // // This member is required. FromTime *time.Time - // The time when the event ended. + // The time when the event ended. // // This member is required. ToTime *time.Time @@ -428,41 +461,43 @@ type EventTimeRange struct { // Information about insight feedback received from a customer. type InsightFeedback struct { - // The feedback provided by the customer. + // The feedback provided by the customer. Feedback InsightFeedbackOption - // The insight feedback ID. + // The insight feedback ID. Id *string noSmithyDocumentSerde } -// Information about the number of open reactive and proactive insights that can +// 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. + // The Meant Time to Recover (MTTR) for the insight. MeanTimeToRecoverInMilliseconds *int64 - // The number of open proactive insights. + // The number of open proactive insights. OpenProactiveInsights int32 - // The number of open reactive insights. + // The number of open reactive insights. OpenReactiveInsights int32 noSmithyDocumentSerde } -// A time ranged that specifies when the observed behavior in an insight started +// A time ranged that specifies when the observed behavior in an insight started +// // and ended. type InsightTimeRange struct { - // The time when the behavior described in an insight started. + // The time when the behavior described in an insight started. // // This member is required. StartTime *time.Time - // The time when the behavior described in an insight ended. + // The time when the behavior described in an insight ended. EndTime *time.Time noSmithyDocumentSerde @@ -471,22 +506,31 @@ type InsightTimeRange struct { // Information about the KMS encryption used with DevOps Guru. type KMSServerSideEncryptionIntegration struct { - // Describes the specified KMS 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/". If - // you specify a predefined Amazon Web Services alias (an Amazon Web Services alias - // with no key ID), Amazon Web Services KMS associates the alias with an Amazon Web - // Services managed key and returns its KeyId and Arn in the response. 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: + // Describes the specified KMS 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/". If you specify a predefined Amazon + // Web Services alias (an Amazon Web Services alias with no key ID), Amazon Web + // Services KMS associates the alias with an Amazon Web Services managed key and + // returns its KeyId and Arn in the response. 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 + // + // Alias name: alias/ExampleAlias + // + // Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias KMSKeyId *string - // Specifies if DevOps Guru is enabled for customer managed keys. + // Specifies if DevOps Guru is enabled for customer managed keys. OptInStatus OptInStatus - // The type of KMS key used. Customer managed keys are the KMS keys that you + // The type of KMS key used. Customer managed keys are the KMS keys that you // create. Amazon Web Services owned keys are keys that are owned and managed by // DevOps Guru. Type ServerSideEncryptionType @@ -494,26 +538,36 @@ type KMSServerSideEncryptionIntegration struct { noSmithyDocumentSerde } -// Information about whether DevOps Guru is configured to encrypt server-side data -// using KMS. +// Information about whether DevOps Guru is configured to encrypt server-side +// +// data using KMS. type KMSServerSideEncryptionIntegrationConfig struct { - // Describes the specified KMS 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/". If - // you specify a predefined Amazon Web Services alias (an Amazon Web Services alias - // with no key ID), Amazon Web Services KMS associates the alias with an Amazon Web - // Services managed key and returns its KeyId and Arn in the response. 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: + // Describes the specified KMS 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/". If you specify a predefined Amazon + // Web Services alias (an Amazon Web Services alias with no key ID), Amazon Web + // Services KMS associates the alias with an Amazon Web Services managed key and + // returns its KeyId and Arn in the response. 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 + // + // Alias name: alias/ExampleAlias + // + // Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias KMSKeyId *string - // Specifies if DevOps Guru is enabled for KMS integration. + // Specifies if DevOps Guru is enabled for KMS integration. OptInStatus OptInStatus - // The type of KMS key used. Customer managed keys are the KMS keys that you + // The type of KMS key used. Customer managed keys are the KMS keys that you // create. Amazon Web Services owned keys are keys that are owned and managed by // DevOps Guru. Type ServerSideEncryptionType @@ -530,28 +584,30 @@ type ListAnomaliesForInsightFilters struct { noSmithyDocumentSerde } -// Filters you can use to specify which events are returned when ListEvents is +// Filters you can use to specify which events are returned when ListEvents is +// // 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 + // The class of the events you want to filter for, such as an infrastructure // change, a deployment, or a schema change. EventClass EventClass - // The Amazon Web Services source that emitted the events you want to filter for. + // The Amazon Web Services source that emitted the events you want to filter for. EventSource *string - // A time range during which you want the filtered events to have occurred. + // A time range during which you want the filtered events to have occurred. EventTimeRange *EventTimeRange - // An ID of an insight that is related to the events you want to filter for. + // An ID of an insight that is related to the events you want to filter for. InsightId *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -565,12 +621,13 @@ type ListEventsFilters struct { // Used to filter for insights that have any status. type ListInsightsAnyStatusFilter struct { - // A time range used to specify when the behavior of the filtered insights started. + // A time range used to specify when the behavior of the filtered insights + // started. // // This member is required. StartTimeRange *StartTimeRange - // Use to filter for either REACTIVE or PROACTIVE insights. + // Use to filter for either REACTIVE or PROACTIVE insights. // // This member is required. Type InsightType @@ -581,12 +638,12 @@ type ListInsightsAnyStatusFilter struct { // 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. + // A time range used to specify when the behavior of the filtered insights ended. // // This member is required. EndTimeRange *EndTimeRange - // Use to filter for either REACTIVE or PROACTIVE insights. + // Use to filter for either REACTIVE or PROACTIVE insights. // // This member is required. Type InsightType @@ -597,7 +654,7 @@ type ListInsightsClosedStatusFilter struct { // Used to filter for insights that have the status ONGOING . type ListInsightsOngoingStatusFilter struct { - // Use to filter for either REACTIVE or PROACTIVE insights. + // Use to filter for either REACTIVE or PROACTIVE insights. // // This member is required. Type InsightType @@ -608,31 +665,32 @@ type ListInsightsOngoingStatusFilter struct { // A filter used by ListInsights to specify which insights to return. type ListInsightsStatusFilter struct { - // A ListInsightsAnyStatusFilter that specifies insights of any status that are + // A ListInsightsAnyStatusFilter that specifies insights of any status that are // either REACTIVE or PROACTIVE . Any *ListInsightsAnyStatusFilter - // A ListInsightsClosedStatusFilter that specifies closed insights that are either - // REACTIVE or PROACTIVE . + // A ListInsightsClosedStatusFilter that specifies closed insights that are + // either REACTIVE or PROACTIVE . Closed *ListInsightsClosedStatusFilter - // A ListInsightsAnyStatusFilter that specifies ongoing insights that are either + // A ListInsightsAnyStatusFilter that specifies ongoing insights that are either // REACTIVE or PROACTIVE . Ongoing *ListInsightsOngoingStatusFilter noSmithyDocumentSerde } -// Filters to determine which monitored resources you want to retrieve. You can +// Filters to determine which monitored resources you want to retrieve. You can +// // filter by resource type or resource permission status. type ListMonitoredResourcesFilters struct { - // The permission status of a resource. + // The permission status of a resource. // // This member is required. ResourcePermission ResourcePermission - // The type of resource that you wish to retrieve, such as log groups. + // The type of resource that you wish to retrieve, such as log groups. // // This member is required. ResourceTypeFilters []ResourceTypeFilter @@ -643,27 +701,27 @@ type ListMonitoredResourcesFilters struct { // Information about an anomalous log event found within a log group. type LogAnomalyClass struct { - // The explanation for why the log event is considered an anomaly. + // The explanation for why the log event is considered an anomaly. Explanation *string - // The token where the anomaly was detected. This may refer to an exception or + // The token where the anomaly was detected. This may refer to an exception or // another location, or it may be blank for log anomalies such as format anomalies. LogAnomalyToken *string - // The type of log anomaly that has been detected. + // The type of log anomaly that has been detected. LogAnomalyType LogAnomalyType - // The ID of the log event. + // The ID of the log event. LogEventId *string - // The time of the first occurrence of the anomalous log event. + // The time of the first occurrence of the anomalous log event. LogEventTimestamp *time.Time - // The name of the Amazon CloudWatch log stream that the anomalous log event + // The name of the Amazon CloudWatch log stream that the anomalous log event // belongs to. A log stream is a sequence of log events that share the same source. LogStreamName *string - // The number of log lines where this anomalous log event occurs. + // The number of log lines where this anomalous log event occurs. NumberOfLogLinesOccurrences int32 noSmithyDocumentSerde @@ -672,14 +730,15 @@ type LogAnomalyClass struct { // A cluster of similar anomalous log events found within a log group. type LogAnomalyShowcase struct { - // A list of anomalous log events that may be related. + // A list of anomalous log events that may be related. LogAnomalyClasses []LogAnomalyClass noSmithyDocumentSerde } -// Information about the integration of DevOps Guru with CloudWatch log groups for -// log anomaly detection. +// Information about the integration of DevOps Guru with CloudWatch log groups +// +// for log anomaly detection. type LogsAnomalyDetectionIntegration struct { // Specifies if DevOps Guru is configured to perform log anomaly detection on @@ -689,8 +748,9 @@ type LogsAnomalyDetectionIntegration struct { noSmithyDocumentSerde } -// Information about the integration of DevOps Guru with CloudWatch log groups for -// log anomaly detection. You can use this to update the configuration. +// Information about the integration of DevOps Guru with CloudWatch log groups +// +// for log anomaly detection. You can use this to update the configuration. type LogsAnomalyDetectionIntegrationConfig struct { // Specifies if DevOps Guru is configured to perform log anomaly detection on @@ -700,19 +760,20 @@ type LogsAnomalyDetectionIntegrationConfig struct { noSmithyDocumentSerde } -// Information about the resource that is being monitored, including the name of +// Information about the resource that is being monitored, including the name of +// // the resource, the type of resource, and whether or not permission is given to // DevOps Guru to access that resource. type MonitoredResourceIdentifier struct { - // The time at which DevOps Guru last updated this resource. + // The time at which DevOps Guru last updated this resource. LastUpdated *time.Time - // The name of the resource being monitored. + // The name of the resource being monitored. MonitoredResourceName *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -720,62 +781,70 @@ type MonitoredResourceIdentifier struct { // CloudFormation stacks. ResourceCollection *ResourceCollection - // The permission status of a resource. + // The permission status of a resource. ResourcePermission ResourcePermission - // The type of resource being monitored. + // The type of resource being monitored. Type *string noSmithyDocumentSerde } -// Information about a notification channel. A notification channel is used to +// Information about a notification channel. A notification channel is used to +// // notify you when DevOps Guru creates an insight. The one supported notification -// channel is Amazon Simple Notification Service (Amazon SNS). If you use an Amazon -// SNS topic in another account, you must attach a policy to it that grants DevOps -// Guru permission to send 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 Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) -// . If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key +// channel is Amazon Simple Notification Service (Amazon SNS). +// +// If you use an Amazon SNS topic in another account, you must attach a policy to +// it that grants DevOps Guru permission to send 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 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) -// . +// the CMK. For more information, see [Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics]. +// +// [Permissions for Amazon SNS topics]: https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html +// [Permissions for Amazon Web 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 + // A NotificationChannelConfig object that contains information about configured // notification channels. Config *NotificationChannelConfig - // The ID of a notification channel. + // The ID of a notification channel. Id *string noSmithyDocumentSerde } -// Information about notification channels you have configured with DevOps Guru. +// Information about notification channels you have configured with DevOps Guru. +// // The one supported notification channel is Amazon Simple Notification Service // (Amazon SNS). type NotificationChannelConfig struct { - // Information about a notification channel configured in DevOps Guru to send - // notifications when insights are created. If you use an Amazon SNS topic in - // another account, you must attach a policy to it that grants DevOps Guru - // permission to send 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 - // Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) - // . If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key + // Information about a notification channel configured in DevOps Guru to send + // notifications when insights are created. + // + // If you use an Amazon SNS topic in another account, you must attach a policy to + // it that grants DevOps Guru permission to send 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 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) - // . + // the CMK. For more information, see [Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics]. + // + // [Permissions for Amazon SNS topics]: https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html + // [Permissions for Amazon Web 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 - // The filter configurations for the Amazon SNS notification topic you use with + // The filter configurations for the Amazon SNS notification topic you use with // DevOps Guru. If you do not provide filter configurations, the default // configurations are to receive notifications for all message types of High or // Medium severity. @@ -784,43 +853,47 @@ type NotificationChannelConfig struct { noSmithyDocumentSerde } -// The filter configurations for the Amazon SNS notification topic you use with +// The filter configurations for the Amazon SNS notification topic you use with +// // DevOps Guru. You can choose to specify which events or message types to receive // notifications for. You can also choose to specify which severity levels to // receive notifications for. type NotificationFilterConfig struct { - // The events that you want to receive notifications for. For example, you can + // The events that you want to receive notifications for. For example, you can // choose to receive notifications only when the severity level is upgraded or a // new insight is created. MessageTypes []NotificationMessageType - // The severity levels that you want to receive notifications for. For example, + // 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) - // . + // severity levels. For more information, see [Understanding insight severities]. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severities []InsightSeverity noSmithyDocumentSerde } -// Information about whether DevOps Guru is configured to create an OpsItem in +// Information about whether DevOps Guru is configured to create an OpsItem in +// // Amazon Web Services Systems Manager OpsCenter for each created insight. type OpsCenterIntegration struct { - // Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems + // Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems // Manager OpsItem for each created insight. OptInStatus OptInStatus noSmithyDocumentSerde } -// Information about whether DevOps Guru is configured to create an OpsItem in +// Information about whether DevOps Guru is configured to create an OpsItem in +// // Amazon Web Services Systems Manager OpsCenter for each created insight. You can // use this to update the configuration. type OpsCenterIntegrationConfig struct { - // Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems + // Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems // Manager OpsItem for each created insight. OptInStatus OptInStatus @@ -829,70 +902,101 @@ 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 -// 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 -// load based on data captured from a running DB instance. DB load is measured as -// average active sessions. Performance Insights provides the data to API consumers -// as a two-dimensional time-series dataset. The time dimension 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. +// 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 load based on data captured from a running DB instance. +// DB load is measured as average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension 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 the [Amazon Aurora User Guide]. +// // - 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) -// . +// the [Amazon RDS User Guide]. +// +// [Amazon RDS User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html +// [Amazon Aurora User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/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: + // 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.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) Group *string @@ -904,27 +1008,33 @@ 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) -// 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 -// average active sessions. Performance Insights provides the data to API consumers -// as a two-dimensional time-series dataset. The time dimension 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. +// more information, see [GetResourceMetrics]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 average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension 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 the [Amazon Aurora User Guide]. +// // - 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) -// . +// the [Amazon RDS User Guide]. +// +// [Amazon RDS User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html +// [GetResourceMetrics]: https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html +// [Amazon Aurora User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/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. Filter map[string]string @@ -936,11 +1046,16 @@ type PerformanceInsightsMetricQuery struct { GroupBy *PerformanceInsightsMetricDimensionGroup // The name of the meteric used used when querying an Performance Insights - // GetResourceMetrics API for anomaly metrics. Valid values for Metric are: + // 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 @@ -952,32 +1067,37 @@ type PerformanceInsightsMetricQuery struct { noSmithyDocumentSerde } -// Details about Performance Insights metrics. 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 average -// active sessions. Performance Insights provides the data to API consumers as a -// two-dimensional time-series dataset. The time dimension 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. +// Details about Performance Insights metrics. +// +// 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 average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension 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 the [Amazon Aurora User Guide]. +// // - 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) -// . +// the [Amazon RDS User Guide]. +// +// [Amazon RDS User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html +// [Amazon Aurora User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/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) - // . + // A single query to be processed for the metric. For more information, see [PerformanceInsightsMetricQuery]. + // + // [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]. + // + // [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; @@ -1017,8 +1137,9 @@ 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]. + // + // [PerformanceInsightsReferenceComparisonValues]: https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html ComparisonValues *PerformanceInsightsReferenceComparisonValues // The name of the reference data. @@ -1058,17 +1179,18 @@ type PerformanceInsightsStat struct { noSmithyDocumentSerde } -// The time range during which anomalous behavior in a proactive anomaly or an +// The time range during which anomalous behavior in a proactive anomaly or an +// // insight is expected to occur. type PredictionTimeRange struct { - // The time range during which a metric limit is expected to be exceeded. This + // The time range during which a metric limit is expected to be exceeded. This // applies to proactive insights only. // // This member is required. StartTime *time.Time - // The time when the behavior in a proactive insight is expected to end. + // The time when the behavior in a proactive insight is expected to end. EndTime *time.Time noSmithyDocumentSerde @@ -1077,38 +1199,38 @@ type PredictionTimeRange struct { // Information about an anomaly. This object is returned by ListAnomalies . type ProactiveAnomaly struct { - // An AnomalyReportedTimeRange object that specifies the time range between when + // An AnomalyReportedTimeRange object that specifies the time range between when // the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange // Information about a resource in which DevOps Guru detected anomalous behavior. AnomalyResources []AnomalyResource - // A time range that specifies when the observed unusual behavior in an anomaly + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange - // The ID of the insight that contains this anomaly. An insight is composed of + // The ID of the insight that contains this anomaly. An insight is composed of // related anomalies. AssociatedInsightId *string - // A description of the proactive anomaly. + // A description of the proactive anomaly. Description *string - // The ID of a proactive anomaly. + // The ID of a proactive anomaly. Id *string - // A threshold that was exceeded by behavior in analyzed resources. Exceeding this - // threshold is related to the anomalous behavior that generated this anomaly. + // A threshold that was exceeded by behavior in analyzed resources. Exceeding + // this threshold is related to the anomalous behavior that generated this anomaly. Limit *float64 - // The time range during which anomalous behavior in a proactive anomaly or an + // The time range during which anomalous behavior in a proactive anomaly or an // insight is expected to occur. PredictionTimeRange *PredictionTimeRange - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1117,22 +1239,23 @@ type ProactiveAnomaly struct { ResourceCollection *ResourceCollection // 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) - // in the Amazon DevOps Guru User Guide. + // determine that insight's severity. For more information, see [Understanding insight severities]in the Amazon + // DevOps Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity AnomalySeverity - // Details about the source of the analyzed operational data that triggered the + // Details about the source of the analyzed operational data that triggered the // anomaly. The one supported source is Amazon CloudWatch metrics. SourceDetails *AnomalySourceDetails // The metadata for the anomaly. SourceMetadata *AnomalySourceMetadata - // The status of a proactive anomaly. + // The status of a proactive anomaly. Status AnomalyStatus - // The time of the anomaly's most recent update. + // The time of the anomaly's most recent update. UpdateTime *time.Time noSmithyDocumentSerde @@ -1141,38 +1264,38 @@ type ProactiveAnomaly struct { // Details about a proactive anomaly. This object is returned by DescribeAnomaly. type ProactiveAnomalySummary struct { - // An AnomalyReportedTimeRange object that specifies the time range between when + // An AnomalyReportedTimeRange object that specifies the time range between when // the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange // Information about a resource in which DevOps Guru detected anomalous behavior. AnomalyResources []AnomalyResource - // A time range that specifies when the observed unusual behavior in an anomaly + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange - // The ID of the insight that contains this anomaly. An insight is composed of + // The ID of the insight that contains this anomaly. An insight is composed of // related anomalies. AssociatedInsightId *string - // A description of the proactive anomaly. + // A description of the proactive anomaly. Description *string // The ID of the anomaly. Id *string - // A threshold that was exceeded by behavior in analyzed resources. Exceeding this - // threshold is related to the anomalous behavior that generated this anomaly. + // A threshold that was exceeded by behavior in analyzed resources. Exceeding + // this threshold is related to the anomalous behavior that generated this anomaly. Limit *float64 - // The time range during which anomalous behavior in a proactive anomaly or an + // The time range during which anomalous behavior in a proactive anomaly or an // insight is expected to occur. PredictionTimeRange *PredictionTimeRange - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1181,12 +1304,13 @@ type ProactiveAnomalySummary struct { ResourceCollection *ResourceCollection // 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) - // in the Amazon DevOps Guru User Guide. + // determine that insight's severity. For more information, see [Understanding insight severities]in the Amazon + // DevOps Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity AnomalySeverity - // Details about the source of the analyzed operational data that triggered the + // Details about the source of the analyzed operational data that triggered the // anomaly. The one supported source is Amazon CloudWatch metrics. SourceDetails *AnomalySourceDetails @@ -1196,7 +1320,7 @@ type ProactiveAnomalySummary struct { // The status of the anomaly. Status AnomalyStatus - // The time of the anomaly's most recent update. + // The time of the anomaly's most recent update. UpdateTime *time.Time noSmithyDocumentSerde @@ -1211,19 +1335,19 @@ type ProactiveInsight struct { // The ID of the proactive insight. Id *string - // A time ranged that specifies when the observed behavior in an insight started + // A time ranged that specifies when the observed behavior in an insight started // and ended. InsightTimeRange *InsightTimeRange // The name of the proactive insight. Name *string - // The time range during which anomalous behavior in a proactive anomaly or an + // The time range during which anomalous behavior in a proactive anomaly or an // insight is expected to occur. PredictionTimeRange *PredictionTimeRange - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1231,12 +1355,13 @@ type ProactiveInsight struct { // CloudFormation stacks. 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) - // in the Amazon DevOps Guru User Guide. + // The severity of the insight. For more information, see [Understanding insight severities] in the Amazon DevOps + // Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity InsightSeverity - // The ID of the Amazon Web Services System Manager OpsItem created for this + // The ID of the Amazon Web Services System Manager OpsItem created for this // insight. You must enable the creation of OpstItems insights before they are // created for each insight. SsmOpsItemId *string @@ -1257,19 +1382,19 @@ type ProactiveInsightSummary struct { // The ID of the proactive insight. Id *string - // A time ranged that specifies when the observed behavior in an insight started + // A time ranged that specifies when the observed behavior in an insight started // and ended. InsightTimeRange *InsightTimeRange // The name of the proactive insight. Name *string - // The time range during which anomalous behavior in a proactive anomaly or an + // The time range during which anomalous behavior in a proactive anomaly or an // insight is expected to occur. PredictionTimeRange *PredictionTimeRange - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1280,9 +1405,10 @@ type ProactiveInsightSummary struct { // A collection of the names of Amazon Web Services services. 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) - // in the Amazon DevOps Guru User Guide. + // The severity of the insight. For more information, see [Understanding insight severities] in the Amazon DevOps + // Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity InsightSeverity // The status of the proactive insight. @@ -1300,7 +1426,7 @@ type ProactiveOrganizationInsightSummary struct { // The ID of the insight summary. Id *string - // A time ranged that specifies when the observed behavior in an insight started + // A time ranged that specifies when the observed behavior in an insight started // and ended. InsightTimeRange *InsightTimeRange @@ -1310,12 +1436,12 @@ type ProactiveOrganizationInsightSummary struct { // The ID of the organizational unit. OrganizationalUnitId *string - // The time range during which anomalous behavior in a proactive anomaly or an + // The time range during which anomalous behavior in a proactive anomaly or an // insight is expected to occur. PredictionTimeRange *PredictionTimeRange - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1326,12 +1452,13 @@ type ProactiveOrganizationInsightSummary struct { // A collection of the names of Amazon Web Services services. 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) - // in the Amazon DevOps Guru User Guide. + // An array of severity values used to search for insights. For more information, + // see [Understanding insight severities]in the Amazon DevOps Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity InsightSeverity - // An array of status values used to search for insights. + // An array of status values used to search for insights. Status InsightStatus noSmithyDocumentSerde @@ -1340,7 +1467,7 @@ type ProactiveOrganizationInsightSummary struct { // Details about a reactive anomaly. This object is returned by ListAnomalies . type ReactiveAnomaly struct { - // An AnomalyReportedTimeRange object that specifies the time range between when + // An AnomalyReportedTimeRange object that specifies the time range between when // the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange @@ -1348,12 +1475,12 @@ type ReactiveAnomaly struct { // DevOps Guru. AnomalyResources []AnomalyResource - // A time range that specifies when the observed unusual behavior in an anomaly + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange - // The ID of the insight that contains this anomaly. An insight is composed of + // The ID of the insight that contains this anomaly. An insight is composed of // related anomalies. AssociatedInsightId *string @@ -1370,8 +1497,8 @@ type ReactiveAnomaly struct { // The name of the reactive anomaly. Name *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1380,20 +1507,23 @@ type ReactiveAnomaly struct { ResourceCollection *ResourceCollection // 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) - // in the Amazon DevOps Guru User Guide. + // determine that insight's severity. For more information, see [Understanding insight severities]in the Amazon + // DevOps Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity AnomalySeverity - // Details about the source of the analyzed operational data that triggered the + // Details about the source of the analyzed operational data that triggered the // anomaly. The one supported source is Amazon CloudWatch metrics. SourceDetails *AnomalySourceDetails - // The status of the anomaly. + // The status of the anomaly. 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. Type AnomalyType @@ -1404,7 +1534,7 @@ type ReactiveAnomaly struct { // Details about a reactive anomaly. This object is returned by DescribeAnomaly. type ReactiveAnomalySummary struct { - // An AnomalyReportedTimeRange object that specifies the time range between when + // An AnomalyReportedTimeRange object that specifies the time range between when // the anomaly is opened and the time when it is closed. AnomalyReportedTimeRange *AnomalyReportedTimeRange @@ -1412,12 +1542,12 @@ type ReactiveAnomalySummary struct { // DevOps Guru. AnomalyResources []AnomalyResource - // A time range that specifies when the observed unusual behavior in an anomaly + // A time range that specifies when the observed unusual behavior in an anomaly // started and ended. This is different from AnomalyReportedTimeRange , which // specifies the time range when DevOps Guru opens and then closes an anomaly. AnomalyTimeRange *AnomalyTimeRange - // The ID of the insight that contains this anomaly. An insight is composed of + // The ID of the insight that contains this anomaly. An insight is composed of // related anomalies. AssociatedInsightId *string @@ -1428,14 +1558,14 @@ type ReactiveAnomalySummary struct { // A description of the reactive anomaly. Description *string - // The ID of the reactive anomaly. + // The ID of the reactive anomaly. Id *string // The name of the reactive anomaly. Name *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1444,20 +1574,23 @@ type ReactiveAnomalySummary struct { ResourceCollection *ResourceCollection // 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) - // in the Amazon DevOps Guru User Guide. + // determine that insight's severity. For more information, see [Understanding insight severities]in the Amazon + // DevOps Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity AnomalySeverity - // Details about the source of the analyzed operational data that triggered the + // Details about the source of the analyzed operational data that triggered the // anomaly. The one supported source is Amazon CloudWatch metrics. SourceDetails *AnomalySourceDetails - // The status of the reactive anomaly. + // The status of the reactive anomaly. 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. Type AnomalyType @@ -1471,18 +1604,18 @@ type ReactiveInsight struct { // Describes the reactive insight. Description *string - // The ID of a reactive insight. + // The ID of a reactive insight. Id *string - // A time ranged that specifies when the observed behavior in an insight started + // A time ranged that specifies when the observed behavior in an insight started // and ended. InsightTimeRange *InsightTimeRange - // The name of a reactive insight. + // The name of a reactive insight. Name *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1490,23 +1623,25 @@ type ReactiveInsight struct { // CloudFormation stacks. 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) - // in the Amazon DevOps Guru User Guide. + // The severity of the insight. For more information, see [Understanding insight severities] in the Amazon DevOps + // Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity InsightSeverity - // The ID of the Amazon Web Services System Manager OpsItem created for this + // The ID of the Amazon Web Services System Manager OpsItem created for this // insight. You must enable the creation of OpstItems insights before they are // created for each insight. SsmOpsItemId *string - // The status of a reactive insight. + // The status of a reactive insight. Status InsightStatus noSmithyDocumentSerde } -// Information about a reactive insight. This object is returned by +// Information about a reactive insight. This object is returned by +// // DescribeInsight. type ReactiveInsightSummary struct { @@ -1514,18 +1649,18 @@ type ReactiveInsightSummary struct { // generated this insight. AssociatedResourceArns []string - // The ID of a reactive summary. + // The ID of a reactive summary. Id *string - // A time ranged that specifies when the observed behavior in an insight started + // A time ranged that specifies when the observed behavior in an insight started // and ended. InsightTimeRange *InsightTimeRange - // The name of a reactive insight. + // The name of a reactive insight. Name *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1536,12 +1671,13 @@ type ReactiveInsightSummary struct { // A collection of the names of Amazon Web Services services. 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) - // in the Amazon DevOps Guru User Guide. + // The severity of the insight. For more information, see [Understanding insight severities] in the Amazon DevOps + // Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity InsightSeverity - // The status of a reactive insight. + // The status of a reactive insight. Status InsightStatus noSmithyDocumentSerde @@ -1557,7 +1693,7 @@ type ReactiveOrganizationInsightSummary struct { // The ID of the insight summary. Id *string - // A time ranged that specifies when the observed behavior in an insight started + // A time ranged that specifies when the observed behavior in an insight started // and ended. InsightTimeRange *InsightTimeRange @@ -1567,8 +1703,8 @@ type ReactiveOrganizationInsightSummary struct { // The ID of the organizational unit. OrganizationalUnitId *string - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1579,41 +1715,43 @@ type ReactiveOrganizationInsightSummary struct { // A collection of the names of Amazon Web Services services. 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) - // in the Amazon DevOps Guru User Guide. + // An array of severity values used to search for insights. For more information, + // see [Understanding insight severities]in the Amazon DevOps Guru User Guide. + // + // [Understanding insight severities]: https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities Severity InsightSeverity - // An array of status values used to search for insights. + // An array of status values used to search for insights. Status InsightStatus noSmithyDocumentSerde } -// Recommendation information to help you remediate detected anomalous behavior +// Recommendation information to help you remediate detected anomalous behavior +// // that generated an insight. type Recommendation struct { // The category type of the recommendation. Category *string - // A description of the problem. + // A description of the problem. Description *string - // A hyperlink to information to help you address the problem. + // A hyperlink to information to help you address the problem. Link *string - // The name of the recommendation. + // The name of the recommendation. Name *string - // The reason DevOps Guru flagged the anomalous behavior as a problem. + // The reason DevOps Guru flagged the anomalous behavior as a problem. Reason *string - // Anomalies that are related to the problem. Use these Anomalies to learn more + // Anomalies that are related to the problem. Use these Anomalies to learn more // about what's happening and to help address the issue. RelatedAnomalies []RecommendationRelatedAnomaly - // Events that are related to the problem. Use these events to learn more about + // Events that are related to the problem. Use these events to learn more about // what's happening and to help address the issue. RelatedEvents []RecommendationRelatedEvent @@ -1626,11 +1764,11 @@ type RecommendationRelatedAnomaly struct { // The ID of an anomaly that generated the insight with this recommendation. AnomalyId *string - // An array of objects that represent resources in which DevOps Guru detected + // An array of objects that represent resources in which DevOps Guru detected // anomalous behavior. Each object contains the name and type of the resource. Resources []RecommendationRelatedAnomalyResource - // Information about where the anomalous behavior related the recommendation was + // Information about where the anomalous behavior related the recommendation was // found. For example, details in Amazon CloudWatch metrics. SourceDetails []RecommendationRelatedAnomalySourceDetail @@ -1640,32 +1778,35 @@ type RecommendationRelatedAnomaly struct { // Information about a resource in which DevOps Guru detected anomalous behavior. type RecommendationRelatedAnomalyResource struct { - // The name of the resource. + // The name of the resource. Name *string - // The type of the resource. Resource types take the same form that is used by + // 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) - // in the Amazon Web Services CloudFormation User Guide. + // AWS::RDS::DBCluster . For more information, see [Amazon Web Services resource and property types reference] in the Amazon Web Services + // CloudFormation User Guide. + // + // [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html Type *string noSmithyDocumentSerde } -// Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects -// that contain the name and namespace of an Amazon CloudWatch metric. +// Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail +// +// objects that contain the name and namespace of an Amazon CloudWatch metric. type RecommendationRelatedAnomalySourceDetail struct { - // An array of CloudWatchMetricsDetail objects that contains information about the - // analyzed metrics that displayed anomalous behavior. + // An array of CloudWatchMetricsDetail objects that contains information about + // the analyzed metrics that displayed anomalous behavior. CloudWatchMetrics []RecommendationRelatedCloudWatchMetricsSourceDetail noSmithyDocumentSerde } -// Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. +// Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. +// // It is one of many analyzed metrics that are used to generate insights. type RecommendationRelatedCloudWatchMetricsSourceDetail struct { @@ -1682,10 +1823,10 @@ type RecommendationRelatedCloudWatchMetricsSourceDetail struct { // Information about an event that is related to a recommendation. type RecommendationRelatedEvent struct { - // The name of the event. This corresponds to the Name field in an Event object. + // The name of the event. This corresponds to the Name field in an Event object. Name *string - // A ResourceCollection object that contains arrays of the names of Amazon Web + // A ResourceCollection object that contains arrays of the names of Amazon Web // Services CloudFormation stacks. You can specify up to 500 Amazon Web Services // CloudFormation stacks. Resources []RecommendationRelatedEventResource @@ -1693,23 +1834,25 @@ type RecommendationRelatedEvent struct { noSmithyDocumentSerde } -// Information about an Amazon Web Services resource that emitted and event that +// 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 + // The name of the resource that emitted the event. This corresponds to the Name // field in an EventResource object. Name *string - // The type of the resource that emitted the event. This corresponds to the Type + // The type of the resource that emitted the event. This corresponds to the Type // field in an EventResource object. Type *string noSmithyDocumentSerde } -// A collection of Amazon Web Services resources supported by DevOps Guru. The two -// types of Amazon Web Services resource collections supported are Amazon Web +// A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1717,72 +1860,93 @@ type RecommendationRelatedEventResource struct { // CloudFormation stacks. type ResourceCollection struct { - // An array of the names of Amazon Web Services CloudFormation stacks. The stacks + // An array of the names of Amazon Web Services CloudFormation stacks. The stacks // define Amazon Web Services resources that DevOps Guru analyzes. You can specify // up to 500 Amazon Web Services CloudFormation stacks. CloudFormation *CloudFormationCollection // The Amazon Web Services tags that are used by resources in the resource - // collection. 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) - // whitepaper. Each Amazon Web Services tag has two parts. + // collection. + // + // 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]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 - // 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 + // + // 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . + // + // [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html Tags []TagCollection noSmithyDocumentSerde } -// Information about a filter used to specify which Amazon Web Services resources +// Information about a filter used to specify which Amazon Web Services resources +// // are analyzed for anomalous behavior by DevOps Guru. type ResourceCollectionFilter struct { - // Information about Amazon Web Services CloudFormation stacks. You can use up to + // 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]in the Amazon Web Services CloudFormation + // User Guide. + // + // [Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html CloudFormation *CloudFormationCollectionFilter // The Amazon Web Services tags used to filter the resources in the resource - // collection. 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) - // whitepaper. Each Amazon Web Services tag has two parts. + // collection. + // + // 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]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 - // 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 + // + // 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . + // + // [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html Tags []TagCollectionFilter noSmithyDocumentSerde @@ -1795,8 +1959,8 @@ type ResourceCollectionFilter struct { // the request returns only results that match all of the specified filters. type SearchInsightsFilters struct { - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1807,21 +1971,22 @@ type SearchInsightsFilters struct { // A collection of the names of Amazon Web Services services. ServiceCollection *ServiceCollection - // An array of severity values used to search for insights. + // An array of severity values used to search for insights. Severities []InsightSeverity - // An array of status values used to search for insights. + // An array of status values used to search for insights. Statuses []InsightStatus noSmithyDocumentSerde } -// Filters you can use to specify which events are returned when ListEvents is +// Filters you can use to specify which events are returned when ListEvents is +// // called. type SearchOrganizationInsightsFilters struct { - // A collection of Amazon Web Services resources supported by DevOps Guru. The two - // types of Amazon Web Services resource collections supported are Amazon Web + // A collection of Amazon Web Services resources supported by DevOps Guru. 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 @@ -1832,10 +1997,10 @@ type SearchOrganizationInsightsFilters struct { // A collection of the names of Amazon Web Services services. ServiceCollection *ServiceCollection - // An array of severity values used to search for insights. + // An array of severity values used to search for insights. Severities []InsightSeverity - // An array of status values used to search for insights. + // An array of status values used to search for insights. Statuses []InsightStatus noSmithyDocumentSerde @@ -1854,7 +2019,7 @@ type ServiceCollection struct { // Represents the health of an Amazon Web Services service. type ServiceHealth struct { - // Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web + // Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web // Services service. AnalyzedResourceCount *int64 @@ -1882,19 +2047,20 @@ type ServiceInsightHealth struct { noSmithyDocumentSerde } -// Information about the integration of DevOps Guru with another Amazon Web +// Information about the integration of DevOps Guru with another Amazon Web +// // Services service, such as Amazon Web Services Systems Manager. type ServiceIntegrationConfig struct { - // Information about whether DevOps Guru is configured to encrypt server-side data - // using KMS. + // Information about whether DevOps Guru is configured to encrypt server-side + // data using KMS. KMSServerSideEncryption *KMSServerSideEncryptionIntegration - // Information about whether DevOps Guru is configured to perform log anomaly + // Information about whether DevOps Guru is configured to perform log anomaly // detection on Amazon CloudWatch log groups. LogsAnomalyDetection *LogsAnomalyDetectionIntegration - // Information about whether DevOps Guru is configured to create an OpsItem in + // Information about whether DevOps Guru is configured to create an OpsItem in // Amazon Web Services Systems Manager OpsCenter for each created insight. OpsCenter *OpsCenterIntegration @@ -1902,9 +2068,10 @@ 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/) . +// an Amazon Web Services resource. For more information, see [Estimate your Amazon DevOps Guru costs]and [Amazon DevOps Guru pricing]. +// +// [Amazon DevOps Guru pricing]: http://aws.amazon.com/devops-guru/pricing/ +// [Estimate your Amazon DevOps Guru costs]: https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html type ServiceResourceCost struct { // The total estimated monthly cost to analyze the active resources for this @@ -1925,91 +2092,111 @@ 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]and [Amazon DevOps Guru pricing]. + // + // [Amazon DevOps Guru pricing]: http://aws.amazon.com/devops-guru/pricing/ + // [Estimate your Amazon DevOps Guru costs]: https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html 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 send 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 Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) -// . If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key +// 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 send 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 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) -// . +// the CMK. For more information, see [Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics]. +// +// [Permissions for Amazon SNS topics]: https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html +// [Permissions for Amazon Web 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. + // The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. TopicArn *string noSmithyDocumentSerde } -// A time range used to specify when the behavior of an insight or anomaly started. +// A time range used to specify when the behavior of an insight or anomaly +// +// started. type StartTimeRange struct { - // The start time of the time range. + // The start time of the time range. FromTime *time.Time - // The end time of the time range. + // The end time of the time range. ToTime *time.Time noSmithyDocumentSerde } -// A collection of Amazon Web Services tags. 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) -// whitepaper. Each Amazon Web Services tag has two parts. +// A collection of Amazon Web Services tags. +// +// 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]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 -// 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 +// 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . +// +// [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html 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 + // 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 . // // 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 - // 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. + // 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 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. // // This member is required. TagValues []string @@ -2025,25 +2212,28 @@ type TagCollectionFilter 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 + // 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 . // // 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 - // 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. + // 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 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. // // This member is required. TagValues []string @@ -2056,32 +2246,37 @@ 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]in the Amazon Web +// Services CloudFormation User Guide. +// +// [Stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html 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 + // 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 . // // 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 - // 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. + // 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 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. // // This member is required. TagValues []string @@ -2089,25 +2284,28 @@ type TagCostEstimationResourceCollectionFilter struct { noSmithyDocumentSerde } -// Information about the health of Amazon Web Services resources in your account +// Information about the health of Amazon Web Services resources in your account +// // that are specified by an Amazon Web Services tag key. type TagHealth struct { - // Number of resources that DevOps Guru is monitoring in your account that are + // Number of resources that DevOps Guru is monitoring in your account that are // specified by an Amazon Web Services tag. AnalyzedResourceCount *int64 // 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 + // 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 . AppBoundaryKey *string @@ -2117,11 +2315,13 @@ type TagHealth struct { // of closed insights. 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 - // 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. + // 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 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 noSmithyDocumentSerde @@ -2139,67 +2339,79 @@ type TimestampMetricValuePair struct { noSmithyDocumentSerde } -// Contains the names of Amazon Web Services CloudFormation stacks used to update +// 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 { - // An array of the names of the Amazon Web Services CloudFormation stacks to + // An array of the names of the Amazon Web Services CloudFormation stacks to // update. You can specify up to 500 Amazon Web Services CloudFormation stacks. StackNames []string noSmithyDocumentSerde } -// Contains information used to update a collection of Amazon Web Services +// Contains information used to update a collection of Amazon Web Services +// // resources. type UpdateResourceCollectionFilter struct { - // A collection of Amazon Web Services CloudFormation stacks. You can specify up + // 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 - // resource collection. 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) - // whitepaper. Each Amazon Web Services tag has two parts. + // resource collection. + // + // 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]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 - // 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 + // + // 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 key/value pairs in your application might be // Devops-Guru-production-application/RDS or // Devops-Guru-production-application/containers . + // + // [Tagging best practices]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html Tags []UpdateTagCollectionFilter noSmithyDocumentSerde } -// Information about updating the integration status of an Amazon Web Services +// Information about updating the integration status of an Amazon Web Services +// // service, such as Amazon Web Services Systems Manager, with DevOps Guru. type UpdateServiceIntegrationConfig struct { - // Information about whether DevOps Guru is configured to encrypt server-side data - // using KMS. + // Information about whether DevOps Guru is configured to encrypt server-side + // data using KMS. KMSServerSideEncryption *KMSServerSideEncryptionIntegrationConfig - // Information about whether DevOps Guru is configured to perform log anomaly + // Information about whether DevOps Guru is configured to perform log anomaly // detection on Amazon CloudWatch log groups. LogsAnomalyDetection *LogsAnomalyDetectionIntegrationConfig - // Information about whether DevOps Guru is configured to create an OpsItem in + // Information about whether DevOps Guru is configured to create an OpsItem in // Amazon Web Services Systems Manager OpsCenter for each created insight. You can // use this to update the configuration. OpsCenter *OpsCenterIntegrationConfig @@ -2214,25 +2426,28 @@ type UpdateTagCollectionFilter 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 + // 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 . // // 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 - // 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. + // 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 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. // // This member is required. TagValues []string @@ -2243,13 +2458,13 @@ type UpdateTagCollectionFilter struct { // The field associated with the validation exception. type ValidationExceptionField struct { - // The message associated with the validation exception with information to help + // The message associated with the validation exception with information to help // determine its cause. // // This member is required. Message *string - // The name of the field. + // The name of the field. // // This member is required. Name *string diff --git a/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go b/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go index 6703499d68f..f682815bf6d 100644 --- a/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go +++ b/service/directconnect/api_op_AcceptDirectConnectGatewayAssociationProposal.go @@ -46,9 +46,12 @@ type AcceptDirectConnectGatewayAssociationProposalInput struct { // This member is required. 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) - // in the Direct Connect User Guide. + // Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway. + // + // For information about how to set the prefixes, see [Allowed Prefixes] in the Direct Connect User + // Guide. + // + // [Allowed Prefixes]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes OverrideAllowedPrefixesToDirectConnectGateway []types.RouteFilterPrefix noSmithyDocumentSerde diff --git a/service/directconnect/api_op_AllocateConnectionOnInterconnect.go b/service/directconnect/api_op_AllocateConnectionOnInterconnect.go index e856f7d6779..c36e3059537 100644 --- a/service/directconnect/api_op_AllocateConnectionOnInterconnect.go +++ b/service/directconnect/api_op_AllocateConnectionOnInterconnect.go @@ -12,10 +12,14 @@ 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,24 +96,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -140,9 +154,10 @@ type AllocateConnectionOnInterconnectOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . 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 ea181603c4c..315dfb98cc7 100644 --- a/service/directconnect/api_op_AllocateHostedConnection.go +++ b/service/directconnect/api_op_AllocateHostedConnection.go @@ -13,12 +13,15 @@ import ( ) // Creates a hosted connection on the specified interconnect or a link aggregation -// group (LAG) of interconnects. Allocates a VLAN number and a specified amount of -// capacity (bandwidth) for use by a hosted connection on the specified -// interconnect or LAG of interconnects. Amazon Web Services polices the hosted -// connection for the specified capacity and the Direct Connect Partner must also -// police the hosted connection for the specified capacity. Intended for use by -// Direct Connect Partners only. +// group (LAG) of interconnects. +// +// Allocates a VLAN number and a specified amount of capacity (bandwidth) for use +// by a hosted connection on the specified interconnect or LAG of interconnects. +// Amazon Web Services polices the hosted connection for the specified capacity and +// the Direct Connect Partner must also police the hosted connection for the +// specified capacity. +// +// Intended for use by Direct Connect Partners only. func (c *Client) AllocateHostedConnection(ctx context.Context, params *AllocateHostedConnectionInput, optFns ...func(*Options)) (*AllocateHostedConnectionOutput, error) { if params == nil { params = &AllocateHostedConnectionInput{} @@ -95,24 +98,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -143,9 +156,10 @@ type AllocateHostedConnectionOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . 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 e31b46b823f..cc14caff46c 100644 --- a/service/directconnect/api_op_AllocatePrivateVirtualInterface.go +++ b/service/directconnect/api_op_AllocatePrivateVirtualInterface.go @@ -12,9 +12,11 @@ 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 -// interface is in the Confirming state and is not available to handle traffic. +// Services account. +// +// Virtual interfaces created using this action must be confirmed 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 { params = &AllocatePrivateVirtualInterfaceInput{} @@ -64,7 +66,9 @@ type AllocatePrivateVirtualInterfaceOutput struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -132,24 +136,33 @@ type AllocatePrivateVirtualInterfaceOutput struct { 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. + // + // - 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 diff --git a/service/directconnect/api_op_AllocatePublicVirtualInterface.go b/service/directconnect/api_op_AllocatePublicVirtualInterface.go index 9e832711f5d..dccd8671a22 100644 --- a/service/directconnect/api_op_AllocatePublicVirtualInterface.go +++ b/service/directconnect/api_op_AllocatePublicVirtualInterface.go @@ -12,14 +12,18 @@ import ( ) // Provisions a public virtual interface to be owned by the specified Amazon Web -// 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, -// 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 -// pool of IPv6 addresses; you cannot specify custom IPv6 addresses. +// 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, 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 pool +// of IPv6 addresses; you cannot specify custom IPv6 addresses. func (c *Client) AllocatePublicVirtualInterface(ctx context.Context, params *AllocatePublicVirtualInterfaceInput, optFns ...func(*Options)) (*AllocatePublicVirtualInterfaceOutput, error) { if params == nil { params = &AllocatePublicVirtualInterfaceInput{} @@ -69,7 +73,9 @@ type AllocatePublicVirtualInterfaceOutput struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -137,24 +143,33 @@ type AllocatePublicVirtualInterfaceOutput struct { 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. + // + // - 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 diff --git a/service/directconnect/api_op_AllocateTransitVirtualInterface.go b/service/directconnect/api_op_AllocateTransitVirtualInterface.go index f8d66c58c7a..6a27af098ad 100644 --- a/service/directconnect/api_op_AllocateTransitVirtualInterface.go +++ b/service/directconnect/api_op_AllocateTransitVirtualInterface.go @@ -13,12 +13,14 @@ import ( // Provisions a transit virtual interface to be owned by the specified Amazon Web // Services account. Use this type of interface to connect a transit gateway to -// your Direct Connect gateway. The owner of a connection provisions a transit -// virtual interface to be owned by the specified Amazon Web Services account. +// 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 -// transit virtual interface is in the requested state and is not available to -// handle traffic. +// 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) { if params == nil { params = &AllocateTransitVirtualInterfaceInput{} diff --git a/service/directconnect/api_op_AssociateConnectionWithLag.go b/service/directconnect/api_op_AssociateConnectionWithLag.go index 9189fd25ca1..0f527abdc57 100644 --- a/service/directconnect/api_op_AssociateConnectionWithLag.go +++ b/service/directconnect/api_op_AssociateConnectionWithLag.go @@ -19,13 +19,16 @@ import ( // match the bandwidth for the LAG. You can re-associate a connection that's // currently associated with a different LAG; however, if removing the connection // would cause the original LAG to fall below its setting for minimum number of -// operational connections, the request fails. Any virtual interfaces that are -// directly associated with the connection are automatically re-associated with the -// LAG. If the connection was originally associated with a different LAG, the -// virtual interfaces remain associated with the original LAG. For interconnects, -// any hosted connections are automatically re-associated with the LAG. If the -// interconnect was originally associated with a different LAG, the hosted -// connections remain associated with the original LAG. +// operational connections, the request fails. +// +// Any virtual interfaces that are directly associated with the connection are +// automatically re-associated with the LAG. If the connection was originally +// associated with a different LAG, the virtual interfaces remain associated with +// the original LAG. +// +// For interconnects, any hosted connections are automatically re-associated with +// the LAG. If the interconnect was originally associated with a different LAG, the +// hosted connections remain associated with the original LAG. func (c *Client) AssociateConnectionWithLag(ctx context.Context, params *AssociateConnectionWithLagInput, optFns ...func(*Options)) (*AssociateConnectionWithLagOutput, error) { if params == nil { params = &AssociateConnectionWithLagInput{} @@ -81,24 +84,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -129,9 +142,10 @@ type AssociateConnectionWithLagOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . 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 22aed31a3da..7edc516bac0 100644 --- a/service/directconnect/api_op_AssociateHostedConnection.go +++ b/service/directconnect/api_op_AssociateHostedConnection.go @@ -16,8 +16,9 @@ import ( // aggregation group (LAG) or interconnect. If the target interconnect or LAG has // an existing hosted connection with a conflicting VLAN number or IP address, the // operation fails. This action temporarily interrupts the hosted connection's -// connectivity to Amazon Web Services as it is being migrated. Intended for use by -// Direct Connect Partners only. +// connectivity to Amazon Web Services as it is being migrated. +// +// Intended for use by Direct Connect Partners only. func (c *Client) AssociateHostedConnection(ctx context.Context, params *AssociateHostedConnectionInput, optFns ...func(*Options)) (*AssociateHostedConnectionOutput, error) { if params == nil { params = &AssociateHostedConnectionInput{} @@ -73,24 +74,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -121,9 +132,10 @@ type AssociateHostedConnectionOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . 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 b9a75ed4e22..fef8219a468 100644 --- a/service/directconnect/api_op_AssociateMacSecKey.go +++ b/service/directconnect/api_op_AssociateMacSecKey.go @@ -12,11 +12,15 @@ 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. -// 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) -// in the Direct Connect User Guide. +// 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. +// +// For information about MAC Security (MACsec) key considerations, see [MACsec pre-shared CKN/CAK key considerations] in the +// Direct Connect User Guide. +// +// [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 func (c *Client) AssociateMacSecKey(ctx context.Context, params *AssociateMacSecKeyInput, optFns ...func(*Options)) (*AssociateMacSecKeyOutput, error) { if params == nil { params = &AssociateMacSecKeyInput{} @@ -35,28 +39,40 @@ func (c *Client) AssociateMacSecKey(ctx context.Context, params *AssociateMacSec type AssociateMacSecKeyInput struct { // The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG - // (dxlag-xxxx). You can use DescribeConnections or DescribeLags to retrieve - // connection ID. + // (dxlag-xxxx). + // + // You can use DescribeConnections or DescribeLags to retrieve connection ID. // // This member is required. ConnectionId *string - // The MAC Security (MACsec) CAK to associate with the dedicated connection. You - // can create the CKN/CAK pair using an industry standard tool. The valid values - // are 64 hexadecimal characters (0-9, A-E). If you use this request parameter, you - // must use the ckn request parameter and not use the secretARN request parameter. + // The MAC Security (MACsec) CAK to associate with the dedicated connection. + // + // You can create the CKN/CAK pair using an industry standard tool. + // + // The valid values are 64 hexadecimal characters (0-9, A-E). + // + // If you use this request parameter, you must use the ckn request parameter and + // not use the secretARN request parameter. Cak *string - // The MAC Security (MACsec) CKN to associate with the dedicated connection. You - // can create the CKN/CAK pair using an industry standard tool. The valid values - // are 64 hexadecimal characters (0-9, A-E). If you use this request parameter, you - // must use the cak request parameter and not use the secretARN request parameter. + // The MAC Security (MACsec) CKN to associate with the dedicated connection. + // + // You can create the CKN/CAK pair using an industry standard tool. + // + // The valid values are 64 hexadecimal characters (0-9, A-E). + // + // If you use this request parameter, you must use the cak request parameter and + // not use the secretARN request parameter. Ckn *string // The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to - // associate with the dedicated connection. You can use DescribeConnections or - // DescribeLags to retrieve the MAC Security (MACsec) secret key. If you use this - // request parameter, you do not use the ckn and cak request parameters. + // associate with the dedicated connection. + // + // You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key. + // + // If you use this request parameter, you do not use the ckn and cak request + // parameters. SecretARN *string noSmithyDocumentSerde diff --git a/service/directconnect/api_op_AssociateVirtualInterface.go b/service/directconnect/api_op_AssociateVirtualInterface.go index bd87857ec23..3c36c1399be 100644 --- a/service/directconnect/api_op_AssociateVirtualInterface.go +++ b/service/directconnect/api_op_AssociateVirtualInterface.go @@ -15,13 +15,16 @@ import ( // connection. Connectivity to Amazon Web Services is temporarily interrupted as // the virtual interface is being migrated. If the target connection or LAG has an // 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 -// 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 -// connection or LAG for the association. +// 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 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 connection or LAG for the association. func (c *Client) AssociateVirtualInterface(ctx context.Context, params *AssociateVirtualInterfaceInput, optFns ...func(*Options)) (*AssociateVirtualInterfaceOutput, error) { if params == nil { params = &AssociateVirtualInterfaceInput{} @@ -65,7 +68,9 @@ type AssociateVirtualInterfaceOutput struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -133,24 +138,33 @@ type AssociateVirtualInterfaceOutput struct { 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. + // + // - 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 diff --git a/service/directconnect/api_op_ConfirmConnection.go b/service/directconnect/api_op_ConfirmConnection.go index e7b518c714c..6cec3426844 100644 --- a/service/directconnect/api_op_ConfirmConnection.go +++ b/service/directconnect/api_op_ConfirmConnection.go @@ -12,6 +12,7 @@ import ( ) // Confirms the creation of the specified hosted connection on an interconnect. +// // Upon creation, the hosted connection is initially in the Ordering state, and // remains in this state until the owner confirms creation of the hosted // connection. @@ -43,19 +44,28 @@ 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. ConnectionState types.ConnectionState diff --git a/service/directconnect/api_op_ConfirmCustomerAgreement.go b/service/directconnect/api_op_ConfirmCustomerAgreement.go index ff1387a517d..4128bf571a1 100644 --- a/service/directconnect/api_op_ConfirmCustomerAgreement.go +++ b/service/directconnect/api_op_ConfirmCustomerAgreement.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The confirmation of the terms of agreement when creating the connection/link +// The confirmation of the terms of agreement when creating the connection/link +// // aggregation group (LAG). func (c *Client) ConfirmCustomerAgreement(ctx context.Context, params *ConfirmCustomerAgreementInput, optFns ...func(*Options)) (*ConfirmCustomerAgreementOutput, error) { if params == nil { @@ -37,8 +38,8 @@ type ConfirmCustomerAgreementInput struct { type ConfirmCustomerAgreementOutput struct { - // The status of the customer agreement when the connection was created. This will - // be either signed or unsigned . + // The status of the customer agreement when the connection was created. This + // will 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 5848571976d..638ea7f45f2 100644 --- a/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmPrivateVirtualInterface.go @@ -12,9 +12,11 @@ import ( ) // Accepts ownership of a private virtual interface created by another Amazon Web -// Services account. After the virtual interface owner makes this call, the virtual -// interface is created and attached to the specified virtual private gateway or -// Direct Connect gateway, and is made available to handle traffic. +// Services account. +// +// After the virtual interface owner makes this call, the virtual interface is +// created and attached to the specified virtual private gateway or Direct Connect +// gateway, and is made available to handle traffic. func (c *Client) ConfirmPrivateVirtualInterface(ctx context.Context, params *ConfirmPrivateVirtualInterfaceInput, optFns ...func(*Options)) (*ConfirmPrivateVirtualInterfaceOutput, error) { if params == nil { params = &ConfirmPrivateVirtualInterfaceInput{} @@ -49,24 +51,33 @@ 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. + // + // - 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 diff --git a/service/directconnect/api_op_ConfirmPublicVirtualInterface.go b/service/directconnect/api_op_ConfirmPublicVirtualInterface.go index c2816b5ce3b..e5703dc69ef 100644 --- a/service/directconnect/api_op_ConfirmPublicVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmPublicVirtualInterface.go @@ -12,8 +12,10 @@ import ( ) // Accepts ownership of a public virtual interface created by another Amazon Web -// Services account. After the virtual interface owner makes this call, the -// specified virtual interface is created and made available to handle traffic. +// Services account. +// +// After the virtual interface owner makes this call, the specified virtual +// interface is created and made available to handle traffic. func (c *Client) ConfirmPublicVirtualInterface(ctx context.Context, params *ConfirmPublicVirtualInterfaceInput, optFns ...func(*Options)) (*ConfirmPublicVirtualInterfaceOutput, error) { if params == nil { params = &ConfirmPublicVirtualInterfaceInput{} @@ -42,24 +44,33 @@ 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. + // + // - 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 diff --git a/service/directconnect/api_op_ConfirmTransitVirtualInterface.go b/service/directconnect/api_op_ConfirmTransitVirtualInterface.go index 7b2ab15a14b..2575cdff87b 100644 --- a/service/directconnect/api_op_ConfirmTransitVirtualInterface.go +++ b/service/directconnect/api_op_ConfirmTransitVirtualInterface.go @@ -12,9 +12,10 @@ import ( ) // Accepts ownership of a transit virtual interface created by another Amazon Web -// Services account. After the owner of the transit virtual interface makes this -// call, the specified transit virtual interface is created and made available to -// handle traffic. +// Services account. +// +// After the owner of the transit virtual interface makes this call, the specified +// transit virtual interface is created and made available to handle traffic. func (c *Client) ConfirmTransitVirtualInterface(ctx context.Context, params *ConfirmTransitVirtualInterfaceInput, optFns ...func(*Options)) (*ConfirmTransitVirtualInterfaceOutput, error) { if params == nil { params = &ConfirmTransitVirtualInterfaceInput{} @@ -48,24 +49,33 @@ 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. + // + // - 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 diff --git a/service/directconnect/api_op_CreateBGPPeer.go b/service/directconnect/api_op_CreateBGPPeer.go index e3beae35da7..45e735c4a45 100644 --- a/service/directconnect/api_op_CreateBGPPeer.go +++ b/service/directconnect/api_op_CreateBGPPeer.go @@ -11,22 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a BGP peer on the specified virtual interface. You must create a BGP -// peer for the corresponding address family (IPv4/IPv6) in order to access Amazon -// Web Services resources that also use that address family. If logical redundancy -// is not supported by the connection, interconnect, or LAG, the BGP peer cannot be -// in the same address family as an existing BGP peer on the virtual interface. +// Creates a BGP peer on the specified virtual interface. +// +// You must create a BGP peer for the corresponding address family (IPv4/IPv6) in +// order to access Amazon Web Services resources that also use that address family. +// +// If logical redundancy is not supported by the connection, interconnect, or LAG, +// the BGP peer cannot be in the same address family as an existing BGP peer on the +// virtual interface. +// // When creating a IPv6 BGP peer, omit the Amazon address and customer address. // IPv6 addresses are automatically assigned from the Amazon pool of IPv6 -// addresses; you cannot specify custom IPv6 addresses. If you let Amazon Web -// Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from -// 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 -// public virtual interface, the Autonomous System Number (ASN) must be private or -// already on the allow list for the virtual interface. +// addresses; you cannot specify custom IPv6 addresses. +// +// If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be +// allocated from 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]. +// +// For a public virtual interface, the Autonomous System Number (ASN) must be +// private or already on the allow list for the virtual interface. +// +// [Address Allocation for Private Internets]: https://datatracker.ietf.org/doc/html/rfc1918 func (c *Client) CreateBGPPeer(ctx context.Context, params *CreateBGPPeerInput, optFns ...func(*Options)) (*CreateBGPPeerOutput, error) { if params == nil { params = &CreateBGPPeerInput{} diff --git a/service/directconnect/api_op_CreateConnection.go b/service/directconnect/api_op_CreateConnection.go index 98b2d607755..1ca5bf047de 100644 --- a/service/directconnect/api_op_CreateConnection.go +++ b/service/directconnect/api_op_CreateConnection.go @@ -13,14 +13,19 @@ import ( ) // Creates a connection between a customer network and a specific Direct Connect -// 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. +// 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. func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionInput, optFns ...func(*Options)) (*CreateConnectionOutput, error) { if params == nil { params = &CreateConnectionInput{} @@ -59,10 +64,13 @@ type CreateConnectionInput struct { // The name of the service provider associated with the requested connection. ProviderName *string - // 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) - // in the Direct Connect User Guide. + // 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]in the Direct + // Connect User Guide. + // + // [MACsec prerequisties]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites RequestMACSec *bool // The tags to associate with the lag. @@ -96,24 +104,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -144,9 +162,10 @@ type CreateConnectionOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . 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 0aa90e2de6b..26613c6c073 100644 --- a/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_CreateDirectConnectGatewayAssociation.go @@ -36,10 +36,14 @@ type CreateDirectConnectGatewayAssociationInput struct { // This member is required. DirectConnectGatewayId *string - // 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) - // in the Direct Connect User Guide. + // 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] in the Direct Connect User + // Guide. + // + // [Allowed Prefixes]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes AddAllowedPrefixesToDirectConnectGateway []types.RouteFilterPrefix // The ID of the virtual private gateway or transit gateway. diff --git a/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go b/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go index 94183d7bc48..655b4b11d0f 100644 --- a/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go +++ b/service/directconnect/api_op_CreateDirectConnectGatewayAssociationProposal.go @@ -12,9 +12,10 @@ import ( ) // 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. +// 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 a80343bf7a0..d4f0b400b64 100644 --- a/service/directconnect/api_op_CreateInterconnect.go +++ b/service/directconnect/api_op_CreateInterconnect.go @@ -13,22 +13,27 @@ import ( ) // Creates an interconnect between an Direct Connect Partner's network and a -// specific Direct Connect location. An interconnect is a connection that is -// capable of hosting other connections. The Direct Connect Partner can use an -// interconnect to provide Direct Connect hosted connections to customers through -// their own network services. Like a standard connection, an interconnect links -// the partner's network to an Direct Connect location over a standard Ethernet -// fiber-optic cable. One end is connected to the partner's router, the other to an -// Direct Connect router. You can automatically add the new interconnect to a link -// aggregation group (LAG) by specifying a LAG ID in the request. This ensures that -// the new interconnect 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 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 +// specific Direct Connect location. +// +// An interconnect is a connection that is capable of hosting other connections. +// The Direct Connect Partner can use an interconnect to provide Direct Connect +// hosted connections to customers through their own network services. Like a +// standard connection, an interconnect links the partner's network to an Direct +// Connect location over a standard Ethernet fiber-optic cable. One end is +// connected to the partner's router, the other to an Direct Connect router. +// +// You can automatically add the new interconnect to a link aggregation group +// (LAG) by specifying a LAG ID in the request. This ensures that the new +// interconnect 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 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 // 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. +// the VLAN assigned to them by the Direct Connect Partner. +// +// Intended for use by Direct Connect Partners only. func (c *Client) CreateInterconnect(ctx context.Context, params *CreateInterconnectInput, optFns ...func(*Options)) (*CreateInterconnectOutput, error) { if params == nil { params = &CreateInterconnectInput{} @@ -102,14 +107,21 @@ 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. InterconnectState types.InterconnectState diff --git a/service/directconnect/api_op_CreateLag.go b/service/directconnect/api_op_CreateLag.go index a8ef28d4951..1bb6ab60bbf 100644 --- a/service/directconnect/api_op_CreateLag.go +++ b/service/directconnect/api_op_CreateLag.go @@ -15,21 +15,27 @@ import ( // physical dedicated connections between the customer network and a specific // Direct Connect location. A LAG is a logical interface that uses the Link // Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling -// you to treat them as a single interface. All connections in a LAG must use the -// same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct -// Connect endpoint. You can have up to 10 dedicated connections per LAG. -// Regardless of this limit, if you request more connections for the LAG than -// Direct Connect can allocate on a single endpoint, no LAG is created. You can -// specify an existing physical dedicated connection or interconnect to include in -// the LAG (which counts towards the total number of connections). Doing so -// interrupts the current physical dedicated connection, and re-establishes them as -// a member of the LAG. The LAG will be created on the same Direct Connect endpoint -// to which the dedicated connection terminates. Any virtual interfaces associated -// with the dedicated connection are automatically disassociated and re-associated -// with the LAG. The connection ID does not change. If the Amazon Web Services -// account used to create a LAG is a registered Direct Connect Partner, the LAG is -// automatically enabled to host sub-connections. For a LAG owned by a partner, any -// associated virtual interfaces cannot be directly configured. +// you to treat them as a single interface. +// +// All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) +// and must terminate at the same Direct Connect endpoint. +// +// You can have up to 10 dedicated connections per LAG. Regardless of this limit, +// if you request more connections for the LAG than Direct Connect can allocate on +// a single endpoint, no LAG is created. +// +// You can specify an existing physical dedicated connection or interconnect to +// include in the LAG (which counts towards the total number of connections). Doing +// so interrupts the current physical dedicated connection, and re-establishes them +// as a member of the LAG. The LAG will be created on the same Direct Connect +// endpoint to which the dedicated connection terminates. Any virtual interfaces +// associated with the dedicated connection are automatically disassociated and +// re-associated with the LAG. The connection ID does not change. +// +// If the Amazon Web Services account used to create a LAG is a registered Direct +// Connect Partner, the LAG is automatically enabled to host sub-connections. For a +// LAG owned by a partner, any associated virtual interfaces cannot be directly +// configured. func (c *Client) CreateLag(ctx context.Context, params *CreateLagInput, optFns ...func(*Options)) (*CreateLagOutput, error) { if params == nil { params = &CreateLagInput{} @@ -79,10 +85,13 @@ type CreateLagInput struct { // The name of the service provider associated with the LAG. ProviderName *string - // 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) - // in the Direct Connect User Guide. + // 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]in the Direct + // Connect User Guide. + // + // [MACsec prerequisties]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites RequestMACSec *bool // The tags to associate with the LAG. @@ -116,8 +125,9 @@ 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,13 +144,20 @@ 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. LagState types.LagState diff --git a/service/directconnect/api_op_CreatePrivateVirtualInterface.go b/service/directconnect/api_op_CreatePrivateVirtualInterface.go index 6bc4746999a..6e3b5f5ccc1 100644 --- a/service/directconnect/api_op_CreatePrivateVirtualInterface.go +++ b/service/directconnect/api_op_CreatePrivateVirtualInterface.go @@ -17,13 +17,14 @@ import ( // Connecting the private virtual interface to a Direct Connect gateway enables the // possibility for connecting to multiple VPCs, including VPCs in different Amazon // Web Services Regions. Connecting the private virtual interface to a VGW only -// provides access to a single VPC within the same Region. Setting the MTU of a -// virtual interface to 9001 (jumbo frames) can cause an 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 check whether your virtual -// interface supports jumbo frames, call DescribeVirtualInterfaces . +// provides access to a single VPC within the same Region. +// +// Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an +// 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 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{} @@ -67,7 +68,9 @@ type CreatePrivateVirtualInterfaceOutput struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -135,24 +138,33 @@ type CreatePrivateVirtualInterfaceOutput struct { 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. + // + // - 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 diff --git a/service/directconnect/api_op_CreatePublicVirtualInterface.go b/service/directconnect/api_op_CreatePublicVirtualInterface.go index 459547c6478..488908c3ac6 100644 --- a/service/directconnect/api_op_CreatePublicVirtualInterface.go +++ b/service/directconnect/api_op_CreatePublicVirtualInterface.go @@ -13,9 +13,10 @@ 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. +// 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. func (c *Client) CreatePublicVirtualInterface(ctx context.Context, params *CreatePublicVirtualInterfaceInput, optFns ...func(*Options)) (*CreatePublicVirtualInterfaceOutput, error) { if params == nil { @@ -60,7 +61,9 @@ type CreatePublicVirtualInterfaceOutput struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -128,24 +131,33 @@ type CreatePublicVirtualInterfaceOutput struct { 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. + // + // - 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 diff --git a/service/directconnect/api_op_CreateTransitVirtualInterface.go b/service/directconnect/api_op_CreateTransitVirtualInterface.go index e42c1023f0e..8d71bd97674 100644 --- a/service/directconnect/api_op_CreateTransitVirtualInterface.go +++ b/service/directconnect/api_op_CreateTransitVirtualInterface.go @@ -14,19 +14,21 @@ import ( // Creates a transit virtual interface. A transit virtual interface should be used // to access one or more transit gateways associated with Direct Connect gateways. // A transit virtual interface enables the connection of multiple VPCs attached to -// a transit gateway to a Direct Connect gateway. If you associate your transit -// gateway with one or more Direct Connect gateways, the Autonomous System Number -// (ASN) used by the transit gateway and the Direct Connect gateway must be -// different. For example, if you use the default ASN 64512 for both your the -// transit gateway and Direct Connect gateway, the association request fails. A -// jumbo MTU value must be either 1500 or 8500. No other values will be accepted. -// Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an -// 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 -// check whether your virtual interface supports jumbo frames, call -// DescribeVirtualInterfaces . +// a transit gateway to a Direct Connect gateway. +// +// If you associate your transit gateway with one or more Direct Connect gateways, +// the Autonomous System Number (ASN) used by the transit gateway and the Direct +// Connect gateway must be different. For example, if you use the default ASN 64512 +// for both your the transit gateway and Direct Connect gateway, the association +// request fails. +// +// A jumbo MTU value must be either 1500 or 8500. No other values will be +// accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can +// cause an 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 check whether +// your virtual interface supports jumbo frames, call 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_DeleteBGPPeer.go b/service/directconnect/api_op_DeleteBGPPeer.go index 97951258b80..e5d87b68670 100644 --- a/service/directconnect/api_op_DeleteBGPPeer.go +++ b/service/directconnect/api_op_DeleteBGPPeer.go @@ -12,8 +12,9 @@ import ( ) // Deletes the specified BGP peer on the specified virtual interface with the -// specified customer address and ASN. You cannot delete the last BGP peer from a -// virtual interface. +// specified customer address and ASN. +// +// You cannot delete the last BGP peer from a virtual interface. func (c *Client) DeleteBGPPeer(ctx context.Context, params *DeleteBGPPeerInput, optFns ...func(*Options)) (*DeleteBGPPeerOutput, error) { if params == nil { params = &DeleteBGPPeerInput{} diff --git a/service/directconnect/api_op_DeleteConnection.go b/service/directconnect/api_op_DeleteConnection.go index d63e4065a78..1e4bdcaf837 100644 --- a/service/directconnect/api_op_DeleteConnection.go +++ b/service/directconnect/api_op_DeleteConnection.go @@ -12,10 +12,11 @@ import ( "time" ) -// Deletes the specified connection. Deleting a connection only stops the Direct -// Connect port hour and data transfer charges. If you are partnering with any -// third parties to connect with the Direct Connect location, you must cancel your -// service with them separately. +// Deletes the specified connection. +// +// Deleting a connection only stops the Direct Connect port hour and data transfer +// charges. If you are partnering with any third parties to connect with the Direct +// Connect location, you must cancel your service with them separately. func (c *Client) DeleteConnection(ctx context.Context, params *DeleteConnectionInput, optFns ...func(*Options)) (*DeleteConnectionOutput, error) { if params == nil { params = &DeleteConnectionInput{} @@ -66,24 +67,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -114,9 +125,10 @@ type DeleteConnectionOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . 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 a69ac6aca1c..259873f1b1b 100644 --- a/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_DeleteDirectConnectGatewayAssociation.go @@ -12,10 +12,12 @@ import ( ) // 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. +// 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 { params = &DeleteDirectConnectGatewayAssociationInput{} diff --git a/service/directconnect/api_op_DeleteInterconnect.go b/service/directconnect/api_op_DeleteInterconnect.go index bc2e83661de..ef33b5510e5 100644 --- a/service/directconnect/api_op_DeleteInterconnect.go +++ b/service/directconnect/api_op_DeleteInterconnect.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified interconnect. Intended for use by Direct Connect Partners -// only. +// Deletes the specified interconnect. +// +// Intended for use by Direct Connect Partners only. func (c *Client) DeleteInterconnect(ctx context.Context, params *DeleteInterconnectInput, optFns ...func(*Options)) (*DeleteInterconnectOutput, error) { if params == nil { params = &DeleteInterconnectInput{} @@ -41,14 +42,21 @@ 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. InterconnectState types.InterconnectState diff --git a/service/directconnect/api_op_DeleteLag.go b/service/directconnect/api_op_DeleteLag.go index e7d677aa0c0..b0cb97ccf2e 100644 --- a/service/directconnect/api_op_DeleteLag.go +++ b/service/directconnect/api_op_DeleteLag.go @@ -63,8 +63,9 @@ 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,13 +82,20 @@ 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. LagState types.LagState diff --git a/service/directconnect/api_op_DeleteVirtualInterface.go b/service/directconnect/api_op_DeleteVirtualInterface.go index 22f5c84617f..6725a272699 100644 --- a/service/directconnect/api_op_DeleteVirtualInterface.go +++ b/service/directconnect/api_op_DeleteVirtualInterface.go @@ -40,24 +40,33 @@ 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. + // + // - 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 diff --git a/service/directconnect/api_op_DescribeConnectionLoa.go b/service/directconnect/api_op_DescribeConnectionLoa.go index 7655703b090..ce36fe1561f 100644 --- a/service/directconnect/api_op_DescribeConnectionLoa.go +++ b/service/directconnect/api_op_DescribeConnectionLoa.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for a connection. The -// 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. +// Deprecated. Use DescribeLoa instead. +// +// Gets the LOA-CFA for a connection. +// +// The 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]in the Direct Connect User Guide. // // Deprecated: This operation has been deprecated. +// +// [Requesting Cross Connects at Direct Connect Locations]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html func (c *Client) DescribeConnectionLoa(ctx context.Context, params *DescribeConnectionLoaInput, optFns ...func(*Options)) (*DescribeConnectionLoaOutput, error) { if params == nil { params = &DescribeConnectionLoaInput{} diff --git a/service/directconnect/api_op_DescribeConnectionsOnInterconnect.go b/service/directconnect/api_op_DescribeConnectionsOnInterconnect.go index a869dfc566d..ea251e12e80 100644 --- a/service/directconnect/api_op_DescribeConnectionsOnInterconnect.go +++ b/service/directconnect/api_op_DescribeConnectionsOnInterconnect.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deprecated. Use DescribeHostedConnections instead. Lists the connections that -// have been provisioned on the specified interconnect. Intended for use by Direct -// Connect Partners only. +// Deprecated. Use DescribeHostedConnections instead. +// +// Lists the connections that have been provisioned on the specified interconnect. +// +// Intended for use by Direct Connect Partners only. // // Deprecated: This operation has been deprecated. func (c *Client) DescribeConnectionsOnInterconnect(ctx context.Context, params *DescribeConnectionsOnInterconnectInput, optFns ...func(*Options)) (*DescribeConnectionsOnInterconnectOutput, error) { diff --git a/service/directconnect/api_op_DescribeCustomerMetadata.go b/service/directconnect/api_op_DescribeCustomerMetadata.go index 927c37a4a54..c5f0e7a7e35 100644 --- a/service/directconnect/api_op_DescribeCustomerMetadata.go +++ b/service/directconnect/api_op_DescribeCustomerMetadata.go @@ -39,10 +39,13 @@ type DescribeCustomerMetadataOutput struct { // 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 diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go index 89ca0f4a87f..dc81072f2b4 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociationProposals.go @@ -37,8 +37,9 @@ type DescribeDirectConnectGatewayAssociationProposalsInput struct { DirectConnectGatewayId *string // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 // The token for the next page of results. diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go index e40bd3fee54..4b0bd7d4c74 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAssociations.go @@ -13,15 +13,32 @@ 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{} @@ -49,8 +66,9 @@ type DescribeDirectConnectGatewayAssociationsInput struct { DirectConnectGatewayId *string // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 // The token provided in the previous call to retrieve the next page. diff --git a/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go b/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go index f1ec4ea4818..814a74adde7 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go +++ b/service/directconnect/api_op_DescribeDirectConnectGatewayAttachments.go @@ -39,8 +39,9 @@ type DescribeDirectConnectGatewayAttachmentsInput struct { DirectConnectGatewayId *string // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 // The token provided in the previous call to retrieve the next page. diff --git a/service/directconnect/api_op_DescribeDirectConnectGateways.go b/service/directconnect/api_op_DescribeDirectConnectGateways.go index 1474af6d563..b6aa6f3367e 100644 --- a/service/directconnect/api_op_DescribeDirectConnectGateways.go +++ b/service/directconnect/api_op_DescribeDirectConnectGateways.go @@ -34,8 +34,9 @@ type DescribeDirectConnectGatewaysInput struct { DirectConnectGatewayId *string // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 // The token provided in the previous call to retrieve the next page. diff --git a/service/directconnect/api_op_DescribeHostedConnections.go b/service/directconnect/api_op_DescribeHostedConnections.go index 8c0d9a9916c..50f989c645b 100644 --- a/service/directconnect/api_op_DescribeHostedConnections.go +++ b/service/directconnect/api_op_DescribeHostedConnections.go @@ -12,8 +12,9 @@ import ( ) // Lists the hosted connections that have been provisioned on the specified -// interconnect or link aggregation group (LAG). Intended for use by Direct Connect -// Partners only. +// interconnect or link aggregation group (LAG). +// +// Intended for use by Direct Connect Partners only. func (c *Client) DescribeHostedConnections(ctx context.Context, params *DescribeHostedConnectionsInput, optFns ...func(*Options)) (*DescribeHostedConnectionsOutput, error) { if params == nil { params = &DescribeHostedConnectionsInput{} diff --git a/service/directconnect/api_op_DescribeInterconnectLoa.go b/service/directconnect/api_op_DescribeInterconnectLoa.go index 3d2d78da826..38c8ab083c7 100644 --- a/service/directconnect/api_op_DescribeInterconnectLoa.go +++ b/service/directconnect/api_op_DescribeInterconnectLoa.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deprecated. Use DescribeLoa instead. Gets the LOA-CFA for the specified -// 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. +// Deprecated. Use DescribeLoa instead. +// +// Gets the LOA-CFA for the specified 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]in the Direct +// Connect User Guide. // // Deprecated: This operation has been deprecated. +// +// [Requesting Cross Connects at Direct Connect Locations]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html func (c *Client) DescribeInterconnectLoa(ctx context.Context, params *DescribeInterconnectLoaInput, optFns ...func(*Options)) (*DescribeInterconnectLoaOutput, error) { if params == nil { params = &DescribeInterconnectLoaInput{} diff --git a/service/directconnect/api_op_DescribeLoa.go b/service/directconnect/api_op_DescribeLoa.go index 458f5ab52a3..4d7b31c0beb 100644 --- a/service/directconnect/api_op_DescribeLoa.go +++ b/service/directconnect/api_op_DescribeLoa.go @@ -12,11 +12,14 @@ import ( ) // Gets the LOA-CFA for a connection, interconnect, or link aggregation group -// (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. +// (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]in the Direct +// Connect User Guide. +// +// [Requesting Cross Connects at Direct Connect Locations]: https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html func (c *Client) DescribeLoa(ctx context.Context, params *DescribeLoaInput, optFns ...func(*Options)) (*DescribeLoaOutput, error) { if params == nil { params = &DescribeLoaInput{} diff --git a/service/directconnect/api_op_DescribeLocations.go b/service/directconnect/api_op_DescribeLocations.go index d6a3a26c051..e5a1a373ddb 100644 --- a/service/directconnect/api_op_DescribeLocations.go +++ b/service/directconnect/api_op_DescribeLocations.go @@ -12,8 +12,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 . +// These are the locations that can be selected when calling CreateConnectionor 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_DescribeVirtualGateways.go b/service/directconnect/api_op_DescribeVirtualGateways.go index 59acaac7d50..f50150796b1 100644 --- a/service/directconnect/api_op_DescribeVirtualGateways.go +++ b/service/directconnect/api_op_DescribeVirtualGateways.go @@ -12,8 +12,9 @@ import ( ) // 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. +// +// 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 { params = &DescribeVirtualGatewaysInput{} diff --git a/service/directconnect/api_op_DescribeVirtualInterfaces.go b/service/directconnect/api_op_DescribeVirtualInterfaces.go index 32c36545d8f..53a714a2ae7 100644 --- a/service/directconnect/api_op_DescribeVirtualInterfaces.go +++ b/service/directconnect/api_op_DescribeVirtualInterfaces.go @@ -15,9 +15,10 @@ import ( // interfaces deleted fewer than 15 minutes before you make the request are also // returned. If you specify a connection ID, only the virtual interfaces associated // with the connection are returned. If you specify a virtual interface ID, then -// only a single virtual interface is returned. A virtual interface (VLAN) -// transmits the traffic between the Direct Connect location and the customer -// network. +// only a single virtual interface is returned. +// +// A virtual interface (VLAN) transmits the traffic between the Direct Connect +// location and the customer network. func (c *Client) DescribeVirtualInterfaces(ctx context.Context, params *DescribeVirtualInterfacesInput, optFns ...func(*Options)) (*DescribeVirtualInterfacesOutput, error) { if params == nil { params = &DescribeVirtualInterfacesInput{} diff --git a/service/directconnect/api_op_DisassociateConnectionFromLag.go b/service/directconnect/api_op_DisassociateConnectionFromLag.go index e17bfd85ffd..a17531ec948 100644 --- a/service/directconnect/api_op_DisassociateConnectionFromLag.go +++ b/service/directconnect/api_op_DisassociateConnectionFromLag.go @@ -14,14 +14,15 @@ 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 -// 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 -// operational connections, the request fails, except when it's the last member of -// the LAG. If all connections are disassociated, the LAG continues to exist as an -// empty LAG with no physical connections. +// not deleted; to delete the connection, use the DeleteConnectionrequest). 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 operational connections, the request fails, except when +// it's the last member of the LAG. If all connections are disassociated, the LAG +// continues to exist as an empty LAG with no physical connections. func (c *Client) DisassociateConnectionFromLag(ctx context.Context, params *DisassociateConnectionFromLagInput, optFns ...func(*Options)) (*DisassociateConnectionFromLagOutput, error) { if params == nil { params = &DisassociateConnectionFromLagInput{} @@ -77,24 +78,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -125,9 +136,10 @@ type DisassociateConnectionFromLagOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_DisassociateMacSecKey.go b/service/directconnect/api_op_DisassociateMacSecKey.go index 077844d5e0a..de3bcc8ea66 100644 --- a/service/directconnect/api_op_DisassociateMacSecKey.go +++ b/service/directconnect/api_op_DisassociateMacSecKey.go @@ -31,15 +31,16 @@ func (c *Client) DisassociateMacSecKey(ctx context.Context, params *Disassociate type DisassociateMacSecKeyInput struct { // The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG - // (dxlag-xxxx). You can use DescribeConnections or DescribeLags to retrieve - // connection ID. + // (dxlag-xxxx). + // + // You can use DescribeConnections or DescribeLags to retrieve connection ID. // // This member is required. ConnectionId *string - // The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key. You can - // use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret - // key. + // The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key. + // + // You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key. // // This member is required. SecretARN *string diff --git a/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go b/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go index 7d683d0d30b..975dace010a 100644 --- a/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go +++ b/service/directconnect/api_op_ListVirtualInterfaceTestHistory.go @@ -34,8 +34,9 @@ type ListVirtualInterfaceTestHistoryInput struct { BgpPeers []string // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 // The token for the next page of results. diff --git a/service/directconnect/api_op_StartBgpFailoverTest.go b/service/directconnect/api_op_StartBgpFailoverTest.go index 0efab1efce2..dfadb200bdb 100644 --- a/service/directconnect/api_op_StartBgpFailoverTest.go +++ b/service/directconnect/api_op_StartBgpFailoverTest.go @@ -13,12 +13,16 @@ import ( // Starts the virtual interface failover test that verifies your configuration // 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) -// 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) -// . +// 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] to view the virtual interface test history. +// +// If you need to stop the test before the test interval completes, use [StopBgpFailoverTest]. +// +// [ListVirtualInterfaceTestHistory]: https://docs.aws.amazon.com/directconnect/latest/APIReference/API_ListVirtualInterfaceTestHistory.html +// [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{} @@ -44,8 +48,11 @@ type StartBgpFailoverTestInput struct { // The BGP peers to place in the DOWN state. BgpPeers []string - // The time in minutes that the virtual interface failover test will last. Maximum - // value: 4,320 minutes (72 hours). Default: 180 minutes (3 hours). + // The time in minutes that the virtual interface failover test will last. + // + // Maximum value: 4,320 minutes (72 hours). + // + // Default: 180 minutes (3 hours). TestDurationInMinutes *int32 noSmithyDocumentSerde diff --git a/service/directconnect/api_op_TagResource.go b/service/directconnect/api_op_TagResource.go index e1ebf75404f..e2be57515c5 100644 --- a/service/directconnect/api_op_TagResource.go +++ b/service/directconnect/api_op_TagResource.go @@ -12,9 +12,10 @@ import ( ) // Adds the specified tags to the specified Direct Connect resource. Each resource -// can have a maximum of 50 tags. Each tag consists of a key and an optional value. -// If a tag with the same key is already associated with the resource, this action -// updates its value. +// can have a maximum of 50 tags. +// +// Each tag consists of a key and an optional value. If a tag with the same key is +// already associated with the resource, this action updates its value. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/directconnect/api_op_UpdateConnection.go b/service/directconnect/api_op_UpdateConnection.go index 69bf34827ab..0f0fac7a213 100644 --- a/service/directconnect/api_op_UpdateConnection.go +++ b/service/directconnect/api_op_UpdateConnection.go @@ -12,9 +12,12 @@ import ( "time" ) -// Updates the Direct Connect dedicated connection configuration. You can update -// the following parameters for a connection: +// 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. func (c *Client) UpdateConnection(ctx context.Context, params *UpdateConnectionInput, optFns ...func(*Options)) (*UpdateConnectionOutput, error) { if params == nil { @@ -33,8 +36,9 @@ func (c *Client) UpdateConnection(ctx context.Context, params *UpdateConnectionI type UpdateConnectionInput struct { - // The ID of the dedicated connection. You can use DescribeConnections to retrieve - // the connection ID. + // The ID of the dedicated connection. + // + // You can use DescribeConnections to retrieve the connection ID. // // This member is required. ConnectionId *string @@ -42,8 +46,9 @@ type UpdateConnectionInput struct { // The name of the connection. ConnectionName *string - // The connection MAC Security (MACsec) encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The connection MAC Security (MACsec) encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string noSmithyDocumentSerde @@ -74,24 +79,34 @@ 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. ConnectionState types.ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -122,9 +137,10 @@ type UpdateConnectionOutput struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . PortEncryptionStatus *string // The name of the service provider associated with the connection. diff --git a/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go b/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go index 2a7754b1085..32bc9435b9f 100644 --- a/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go +++ b/service/directconnect/api_op_UpdateDirectConnectGatewayAssociation.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified attributes of the Direct Connect gateway association. Add -// or remove prefixes from the association. +// Updates the specified attributes of the Direct Connect gateway association. +// +// Add or remove prefixes from the association. func (c *Client) UpdateDirectConnectGatewayAssociation(ctx context.Context, params *UpdateDirectConnectGatewayAssociationInput, optFns ...func(*Options)) (*UpdateDirectConnectGatewayAssociationOutput, error) { if params == nil { params = &UpdateDirectConnectGatewayAssociationInput{} diff --git a/service/directconnect/api_op_UpdateLag.go b/service/directconnect/api_op_UpdateLag.go index 39769038f10..731e30b3344 100644 --- a/service/directconnect/api_op_UpdateLag.go +++ b/service/directconnect/api_op_UpdateLag.go @@ -11,14 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the attributes of the specified link aggregation group (LAG). You can -// update the following LAG attributes: +// 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 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 @@ -45,8 +53,10 @@ type UpdateLagInput struct { // This member is required. LagId *string - // The LAG MAC Security (MACsec) encryption mode. Amazon Web Services applies the - // value to all connections which are part of the LAG. + // The LAG MAC Security (MACsec) encryption mode. + // + // Amazon Web Services applies the value to all connections which are part of the + // LAG. EncryptionMode *string // The name of the LAG. @@ -84,8 +94,9 @@ 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 @@ -102,13 +113,20 @@ 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. LagState types.LagState diff --git a/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go b/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go index a05765ea01c..064737d3f25 100644 --- a/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go +++ b/service/directconnect/api_op_UpdateVirtualInterfaceAttributes.go @@ -12,13 +12,13 @@ import ( ) // Updates the specified attributes of the specified virtual private interface. +// // Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an // 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 -// check whether your virtual interface supports jumbo frames, call -// DescribeVirtualInterfaces . +// whether your connection supports jumbo frames, call DescribeConnections. To check whether your +// virtual interface supports jumbo frames, call DescribeVirtualInterfaces. func (c *Client) UpdateVirtualInterfaceAttributes(ctx context.Context, params *UpdateVirtualInterfaceAttributesInput, optFns ...func(*Options)) (*UpdateVirtualInterfaceAttributesOutput, error) { if params == nil { params = &UpdateVirtualInterfaceAttributesInput{} @@ -67,7 +67,9 @@ type UpdateVirtualInterfaceAttributesOutput struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -135,24 +137,33 @@ type UpdateVirtualInterfaceAttributesOutput struct { 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. + // + // - 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 diff --git a/service/directconnect/options.go b/service/directconnect/options.go index fc3615a5bbf..12a07c9b89a 100644 --- a/service/directconnect/options.go +++ b/service/directconnect/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/directconnect/types/enums.go b/service/directconnect/types/enums.go index b26845c4d5b..3938a73de1f 100644 --- a/service/directconnect/types/enums.go +++ b/service/directconnect/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AddressFamily. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddressFamily) Values() []AddressFamily { return []AddressFamily{ "ipv4", @@ -32,8 +33,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -54,8 +56,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -80,8 +83,9 @@ const ( ) // Values returns all known values for ConnectionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionState) Values() []ConnectionState { return []ConnectionState{ "ordering", @@ -107,8 +111,9 @@ const ( // Values returns all known values for // DirectConnectGatewayAssociationProposalState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectConnectGatewayAssociationProposalState) Values() []DirectConnectGatewayAssociationProposalState { return []DirectConnectGatewayAssociationProposalState{ "requested", @@ -130,8 +135,9 @@ const ( // Values returns all known values for DirectConnectGatewayAssociationState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectConnectGatewayAssociationState) Values() []DirectConnectGatewayAssociationState { return []DirectConnectGatewayAssociationState{ "associating", @@ -154,8 +160,9 @@ const ( // Values returns all known values for DirectConnectGatewayAttachmentState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectConnectGatewayAttachmentState) Values() []DirectConnectGatewayAttachmentState { return []DirectConnectGatewayAttachmentState{ "attaching", @@ -175,8 +182,9 @@ const ( // Values returns all known values for DirectConnectGatewayAttachmentType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectConnectGatewayAttachmentType) Values() []DirectConnectGatewayAttachmentType { return []DirectConnectGatewayAttachmentType{ "TransitVirtualInterface", @@ -196,6 +204,7 @@ const ( // Values returns all known values for DirectConnectGatewayState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DirectConnectGatewayState) Values() []DirectConnectGatewayState { return []DirectConnectGatewayState{ @@ -215,8 +224,9 @@ const ( ) // Values returns all known values for GatewayType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayType) Values() []GatewayType { return []GatewayType{ "virtualPrivateGateway", @@ -234,8 +244,9 @@ const ( ) // Values returns all known values for HasLogicalRedundancy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HasLogicalRedundancy) Values() []HasLogicalRedundancy { return []HasLogicalRedundancy{ "unknown", @@ -258,8 +269,9 @@ const ( ) // Values returns all known values for InterconnectState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InterconnectState) Values() []InterconnectState { return []InterconnectState{ "requested", @@ -286,8 +298,9 @@ const ( ) // Values returns all known values for LagState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LagState) Values() []LagState { return []LagState{ "requested", @@ -308,8 +321,9 @@ const ( ) // Values returns all known values for LoaContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoaContentType) Values() []LoaContentType { return []LoaContentType{ "application/pdf", @@ -326,8 +340,9 @@ const ( ) // Values returns all known values for NniPartnerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NniPartnerType) Values() []NniPartnerType { return []NniPartnerType{ "v1", @@ -352,8 +367,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "confirming", diff --git a/service/directconnect/types/types.go b/service/directconnect/types/types.go index cd93ce4322f..fb62586d98b 100644 --- a/service/directconnect/types/types.go +++ b/service/directconnect/types/types.go @@ -54,20 +54,27 @@ 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. 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. // // - down : The BGP peer is down. + // // - unknown : The BGP peer status is not available. BgpStatus BGPStatus @@ -102,24 +109,34 @@ 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. ConnectionState ConnectionState - // The MAC Security (MACsec) connection encryption mode. The valid values are - // no_encrypt , should_encrypt , and must_encrypt . + // The MAC Security (MACsec) connection encryption mode. + // + // The valid values are no_encrypt , should_encrypt , and must_encrypt . EncryptionMode *string // Indicates whether the connection supports a secondary BGP peer in the same @@ -150,9 +167,10 @@ type Connection struct { // The name of the Direct Connect service provider associated with the connection. 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 . + // 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 . PortEncryptionStatus *string // The name of the service provider associated with the connection. @@ -196,9 +214,13 @@ type DirectConnectGateway struct { DirectConnectGatewayName *string // The state of the Direct Connect gateway. The following are the possible values: - // - pending : The initial state after calling CreateDirectConnectGateway . + // + // - pending : The initial state after calling CreateDirectConnectGateway. + // // - available : The Direct Connect gateway is ready for use. - // - deleting : The initial state after calling DeleteDirectConnectGateway . + // + // - deleting : The initial state after calling DeleteDirectConnectGateway. + // // - deleted : The Direct Connect gateway is deleted and cannot pass traffic. DirectConnectGatewayState DirectConnectGatewayState @@ -225,15 +247,18 @@ type DirectConnectGatewayAssociation struct { AssociationId *string // The state of the association. The following are the possible values: - // - associating : The initial state after calling - // CreateDirectConnectGatewayAssociation . + // + // - 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 . + // + // - 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. @@ -283,10 +308,13 @@ 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. ProposalState DirectConnectGatewayAssociationProposalState @@ -302,11 +330,15 @@ 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 . + // + // - 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. @@ -362,14 +394,21 @@ 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. InterconnectState InterconnectState @@ -422,8 +461,9 @@ 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 @@ -440,13 +480,20 @@ 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. LagState LagState @@ -534,13 +581,19 @@ type MacSecKey struct { // displayed in UTC format. StartOn *string - // The state of the MAC Security (MACsec) secret key. The possible values are: + // 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. State *string @@ -575,7 +628,9 @@ type NewBGPPeer struct { type NewPrivateVirtualInterface struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. // // This member is required. Asn int32 @@ -628,7 +683,9 @@ type NewPrivateVirtualInterface struct { type NewPrivateVirtualInterfaceAllocation struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. // // This member is required. Asn int32 @@ -672,7 +729,9 @@ type NewPrivateVirtualInterfaceAllocation struct { type NewPublicVirtualInterface struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. // // This member is required. Asn int32 @@ -716,7 +775,9 @@ type NewPublicVirtualInterface struct { type NewPublicVirtualInterfaceAllocation struct { // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. // // This member is required. Asn int32 @@ -766,7 +827,9 @@ type NewTransitVirtualInterface struct { AmazonAddress *string // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -810,7 +873,9 @@ type NewTransitVirtualInterfaceAllocation struct { AmazonAddress *string // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -906,11 +971,14 @@ type VirtualGateway struct { // The ID of the virtual private gateway. VirtualGatewayId *string - // The state of the virtual private gateway. The following are the possible - // values: + // 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. VirtualGatewayState *string @@ -931,7 +999,9 @@ type VirtualInterface struct { AmazonSideAsn *int64 // The autonomous system (AS) number for Border Gateway Protocol (BGP) - // configuration. The valid values are 1-2147483647. + // configuration. + // + // The valid values are 1-2147483647. Asn int32 // The authentication key for BGP configuration. This string has a minimum length @@ -999,24 +1069,33 @@ type VirtualInterface struct { 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. + // + // - 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 diff --git a/service/directoryservice/api_op_AddIpRoutes.go b/service/directoryservice/api_op_AddIpRoutes.go index b565693c4bb..540f755f73b 100644 --- a/service/directoryservice/api_op_AddIpRoutes.go +++ b/service/directoryservice/api_op_AddIpRoutes.go @@ -16,11 +16,12 @@ import ( // from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address // block. You can also use AddIpRoutes to facilitate routing traffic that uses // public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC. +// // 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) -// . +// required to run the AddIpRoutes operation, see [Directory Service API Permissions: Actions, Resources, and Conditions Reference]. +// +// [Directory Service API 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{} @@ -51,26 +52,48 @@ 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: + // 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 + // // 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. UpdateSecurityGroupForDirectoryControllers bool diff --git a/service/directoryservice/api_op_ConnectDirectory.go b/service/directoryservice/api_op_ConnectDirectory.go index a55312c95f9..78922bb1fa3 100644 --- a/service/directoryservice/api_op_ConnectDirectory.go +++ b/service/directoryservice/api_op_ConnectDirectory.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an AD Connector to connect to a self-managed directory. Before you call -// 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) -// . +// Creates an AD Connector to connect to a self-managed directory. +// +// Before you call 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]. +// +// [Directory Service API 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{} @@ -35,8 +36,7 @@ func (c *Client) ConnectDirectory(ctx context.Context, params *ConnectDirectoryI // Contains the inputs for the ConnectDirectory operation. type ConnectDirectoryInput struct { - // A DirectoryConnectSettings object that contains additional information for the - // operation. + // A DirectoryConnectSettings object that contains additional information for the operation. // // This member is required. ConnectSettings *types.DirectoryConnectSettings diff --git a/service/directoryservice/api_op_CreateAlias.go b/service/directoryservice/api_op_CreateAlias.go index 5ff60cdfc2e..3bfc8e07982 100644 --- a/service/directoryservice/api_op_CreateAlias.go +++ b/service/directoryservice/api_op_CreateAlias.go @@ -12,8 +12,10 @@ 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 -// reused, so this operation should only be used when absolutely necessary. +// 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 { params = &CreateAliasInput{} @@ -32,9 +34,11 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF // Contains the inputs for the CreateAlias operation. type CreateAliasInput struct { - // The requested alias. The alias must be unique amongst all aliases in Amazon Web - // Services. This operation throws an EntityAlreadyExistsException error if the - // alias already exists. + // The requested alias. + // + // The alias must be unique amongst all aliases in Amazon Web Services. This + // operation throws an EntityAlreadyExistsException error if the alias already + // exists. // // This member is required. Alias *string diff --git a/service/directoryservice/api_op_CreateComputer.go b/service/directoryservice/api_op_CreateComputer.go index 976320dc161..861951d1e32 100644 --- a/service/directoryservice/api_op_CreateComputer.go +++ b/service/directoryservice/api_op_CreateComputer.go @@ -46,8 +46,8 @@ type CreateComputerInput struct { // This member is required. Password *string - // An array of Attribute objects that contain any LDAP attributes to apply to the - // computer account. + // An array of Attribute objects that contain any LDAP attributes to apply to the computer + // account. ComputerAttributes []types.Attribute // The fully-qualified distinguished name of the organizational unit to place the diff --git a/service/directoryservice/api_op_CreateDirectory.go b/service/directoryservice/api_op_CreateDirectory.go index a4d7e22a5df..edc69792a39 100644 --- a/service/directoryservice/api_op_CreateDirectory.go +++ b/service/directoryservice/api_op_CreateDirectory.go @@ -11,13 +11,15 @@ 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 -// 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) -// . +// Creates a Simple AD directory. For more information, see [Simple Active Directory] 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]. +// +// [Simple Active Directory]: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html +// [Directory Service API Permissions: Actions, 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{} @@ -43,22 +45,33 @@ 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: + // this password. + // + // If you need to change the password for the administrator account, you can use + // the ResetUserPasswordAPI 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. + // see [Password must meet complexity requirements]on the Microsoft website. + // + // [Password must meet complexity requirements]: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements // // This member is required. Password *string @@ -77,8 +90,7 @@ type CreateDirectoryInput struct { // The tags to be assigned to the Simple AD directory. Tags []types.Tag - // A DirectoryVpcSettings object that contains additional information for the - // operation. + // A DirectoryVpcSettings object that contains additional information for the operation. VpcSettings *types.DirectoryVpcSettings noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_CreateMicrosoftAD.go b/service/directoryservice/api_op_CreateMicrosoftAD.go index c0917fc87e3..f0a5477ff31 100644 --- a/service/directoryservice/api_op_CreateMicrosoftAD.go +++ b/service/directoryservice/api_op_CreateMicrosoftAD.go @@ -12,13 +12,14 @@ 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) -// 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) -// . +// information, see [Managed Microsoft AD]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]. +// +// [Managed Microsoft AD]: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html +// [Directory Service API Permissions: Actions, 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{} @@ -44,9 +45,10 @@ type CreateMicrosoftADInput struct { // This member is required. Name *string - // 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. + // The password for the default administrative user named Admin . + // + // If you need to change the password for the administrator account, you can use + // the ResetUserPasswordAPI call. // // This member is required. Password *string diff --git a/service/directoryservice/api_op_CreateSnapshot.go b/service/directoryservice/api_op_CreateSnapshot.go index 758a899c829..e246430acd1 100644 --- a/service/directoryservice/api_op_CreateSnapshot.go +++ b/service/directoryservice/api_op_CreateSnapshot.go @@ -11,7 +11,9 @@ import ( ) // Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web -// Services cloud. You cannot take snapshots of AD Connector directories. +// Services cloud. +// +// You cannot take snapshots of AD Connector directories. func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} diff --git a/service/directoryservice/api_op_CreateTrust.go b/service/directoryservice/api_op_CreateTrust.go index e1cd9708750..6ac9a6acddd 100644 --- a/service/directoryservice/api_op_CreateTrust.go +++ b/service/directoryservice/api_op_CreateTrust.go @@ -15,10 +15,11 @@ import ( // relationships. For example, you can establish a trust between your Managed // Microsoft AD directory, and your existing self-managed Microsoft Active // Directory. This would allow you to provide users and groups access to resources -// in either domain, with a single set of credentials. This action initiates the -// creation of the Amazon Web Services side of a trust relationship between an -// Managed Microsoft AD directory and an external domain. You can create either a -// forest trust or an external trust. +// in either domain, with a single set of credentials. +// +// This action initiates the creation of the Amazon Web Services side of a trust +// relationship between an Managed Microsoft AD directory and an external domain. +// You can create either a forest trust or an external trust. func (c *Client) CreateTrust(ctx context.Context, params *CreateTrustInput, optFns ...func(*Options)) (*CreateTrustOutput, error) { if params == nil { params = &CreateTrustInput{} @@ -38,9 +39,10 @@ func (c *Client) CreateTrust(ctx context.Context, params *CreateTrustInput, optF // relationships. For example, you can establish a trust between your Managed // Microsoft AD directory, and your existing self-managed Microsoft Active // Directory. This would allow you to provide users and groups access to resources -// in either domain, with a single set of credentials. This action initiates the -// creation of the Amazon Web Services side of a trust relationship between an -// Managed Microsoft AD directory and an external domain. +// in either domain, with a single set of credentials. +// +// This action initiates the creation of the Amazon Web Services side of a trust +// relationship between an Managed Microsoft AD directory and an external domain. type CreateTrustInput struct { // The Directory ID of the Managed Microsoft AD directory for which to establish diff --git a/service/directoryservice/api_op_DeleteDirectory.go b/service/directoryservice/api_op_DeleteDirectory.go index 8c2ce14593d..eabbed55c0e 100644 --- a/service/directoryservice/api_op_DeleteDirectory.go +++ b/service/directoryservice/api_op_DeleteDirectory.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [Directory Service API Permissions: Actions, 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 ecd869752df..338ea7449db 100644 --- a/service/directoryservice/api_op_DescribeClientAuthenticationSettings.go +++ b/service/directoryservice/api_op_DescribeClientAuthenticationSettings.go @@ -42,8 +42,7 @@ type DescribeClientAuthenticationSettingsInput struct { Limit *int32 // The DescribeClientAuthenticationSettingsResult.NextToken value from a previous - // call to DescribeClientAuthenticationSettings . Pass null if this is the first - // call. + // call to DescribeClientAuthenticationSettings. Pass null if this is the first call. NextToken *string // The type of client authentication for which to retrieve information. If no type diff --git a/service/directoryservice/api_op_DescribeConditionalForwarders.go b/service/directoryservice/api_op_DescribeConditionalForwarders.go index 786c6cb18e7..9360243905c 100644 --- a/service/directoryservice/api_op_DescribeConditionalForwarders.go +++ b/service/directoryservice/api_op_DescribeConditionalForwarders.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Obtains information about the conditional forwarders for this account. If no -// input parameters are provided for RemoteDomainNames, this request describes all -// conditional forwarders for the specified directory ID. +// Obtains information about the conditional forwarders for this account. +// +// If no input parameters are provided for RemoteDomainNames, this request +// describes all conditional forwarders for the specified directory ID. func (c *Client) DescribeConditionalForwarders(ctx context.Context, params *DescribeConditionalForwardersInput, optFns ...func(*Options)) (*DescribeConditionalForwardersOutput, error) { if params == nil { params = &DescribeConditionalForwardersInput{} diff --git a/service/directoryservice/api_op_DescribeDirectories.go b/service/directoryservice/api_op_DescribeDirectories.go index b86b2b861d9..a19d67764be 100644 --- a/service/directoryservice/api_op_DescribeDirectories.go +++ b/service/directoryservice/api_op_DescribeDirectories.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Obtains information about the directories that belong to this account. You can -// retrieve information about specific directories by passing the directory -// identifiers in the DirectoryIds parameter. Otherwise, all directories that -// belong to the current account are returned. This operation supports pagination -// with the use of the NextToken request and response parameters. If more results -// are available, the DescribeDirectoriesResult.NextToken member contains a token -// that you pass in the next call to DescribeDirectories to retrieve the next set -// of items. You can also specify a maximum number of return results with the Limit +// Obtains information about the directories that belong to this account. +// +// You can retrieve information about specific directories by passing the +// directory identifiers in the DirectoryIds parameter. Otherwise, all directories +// that belong to the current account are returned. +// +// This operation supports pagination with the use of the NextToken request and +// response parameters. If more results are available, the +// DescribeDirectoriesResult.NextToken member contains a token that you pass in the +// next call to DescribeDirectoriesto retrieve the next set of items. +// +// You can also specify a maximum number of return results with the Limit // parameter. func (c *Client) DescribeDirectories(ctx context.Context, params *DescribeDirectoriesInput, optFns ...func(*Options)) (*DescribeDirectoriesOutput, error) { if params == nil { @@ -40,15 +44,17 @@ 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 - // returned. An empty list results in an InvalidParameterException being thrown. + // 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. Limit *int32 - // The DescribeDirectoriesResult.NextToken value from a previous call to - // DescribeDirectories . Pass null if this is the first call. + // The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass + // null if this is the first call. NextToken *string noSmithyDocumentSerde @@ -57,16 +63,16 @@ type DescribeDirectoriesInput struct { // Contains the results of the DescribeDirectories operation. type DescribeDirectoriesOutput struct { - // The list of DirectoryDescription 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. + // The list of DirectoryDescription 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. DirectoryDescriptions []types.DirectoryDescription // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to DescribeDirectories to retrieve the next set - // of items. + // parameter in a subsequent call to DescribeDirectoriesto retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DescribeDomainControllers.go b/service/directoryservice/api_op_DescribeDomainControllers.go index 835aff4e6d1..de40e4b640b 100644 --- a/service/directoryservice/api_op_DescribeDomainControllers.go +++ b/service/directoryservice/api_op_DescribeDomainControllers.go @@ -42,8 +42,8 @@ type DescribeDomainControllersInput struct { // The maximum number of items to return. Limit *int32 - // The DescribeDomainControllers.NextToken value from a previous call to - // DescribeDomainControllers . Pass null if this is the first call. + // The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass + // null if this is the first call. NextToken *string noSmithyDocumentSerde @@ -55,8 +55,7 @@ type DescribeDomainControllersOutput struct { DomainControllers []types.DomainController // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to DescribeDomainControllers retrieve the next - // set of items. + // parameter in a subsequent call to DescribeDomainControllersretrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DescribeEventTopics.go b/service/directoryservice/api_op_DescribeEventTopics.go index 5216941822a..f38d37b8e11 100644 --- a/service/directoryservice/api_op_DescribeEventTopics.go +++ b/service/directoryservice/api_op_DescribeEventTopics.go @@ -12,9 +12,10 @@ import ( ) // Obtains information about which Amazon SNS topics receive status messages from -// the specified directory. If no input parameters are provided, such as -// DirectoryId or TopicName, this request describes all of the associations in the -// account. +// the specified directory. +// +// If no input parameters are provided, such as DirectoryId or TopicName, this +// request describes all of the associations in the account. func (c *Client) DescribeEventTopics(ctx context.Context, params *DescribeEventTopicsInput, optFns ...func(*Options)) (*DescribeEventTopicsOutput, error) { if params == nil { params = &DescribeEventTopicsInput{} @@ -38,8 +39,9 @@ type DescribeEventTopicsInput struct { DirectoryId *string // A list of Amazon SNS topic names for which to obtain the information. If this - // member is null, all associations for the specified Directory ID are returned. An - // empty list results in an InvalidParameterException being thrown. + // member is null, all associations for the specified Directory ID are returned. + // + // An empty list results in an InvalidParameterException being thrown. TopicNames []string noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_DescribeRegions.go b/service/directoryservice/api_op_DescribeRegions.go index d1c7381cb12..d912f6d5818 100644 --- a/service/directoryservice/api_op_DescribeRegions.go +++ b/service/directoryservice/api_op_DescribeRegions.go @@ -35,8 +35,8 @@ type DescribeRegionsInput struct { // This member is required. DirectoryId *string - // The DescribeRegionsResult.NextToken value from a previous call to - // DescribeRegions . Pass null if this is the first call. + // The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null + // if this is the first call. NextToken *string // The name of the Region. For example, us-east-1 . @@ -48,8 +48,7 @@ type DescribeRegionsInput struct { type DescribeRegionsOutput struct { // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to DescribeRegions to retrieve the next set of - // items. + // parameter in a subsequent call to DescribeRegionsto retrieve the next set of items. NextToken *string // List of Region information related to the directory for each replicated Region. diff --git a/service/directoryservice/api_op_DescribeSettings.go b/service/directoryservice/api_op_DescribeSettings.go index 9e6e430fe7c..f62bd219e0d 100644 --- a/service/directoryservice/api_op_DescribeSettings.go +++ b/service/directoryservice/api_op_DescribeSettings.go @@ -35,8 +35,8 @@ type DescribeSettingsInput struct { // This member is required. DirectoryId *string - // The DescribeSettingsResult.NextToken value from a previous call to - // DescribeSettings . Pass null if this is the first call. + // The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null + // if this is the first call. NextToken *string // The status of the directory settings for which to retrieve information. @@ -55,10 +55,12 @@ type DescribeSettingsOutput struct { // retrieve the next set of items. 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. + // 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. 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 eff2f10a47d..dd1b76fb18d 100644 --- a/service/directoryservice/api_op_DescribeSharedDirectories.go +++ b/service/directoryservice/api_op_DescribeSharedDirectories.go @@ -37,8 +37,8 @@ type DescribeSharedDirectoriesInput struct { // The number of shared directories to return in the response object. Limit *int32 - // The DescribeSharedDirectoriesResult.NextToken value from a previous call to - // DescribeSharedDirectories . Pass null if this is the first call. + // The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. + // Pass null if this is the first call. NextToken *string // A list of identifiers of all shared directories in your account. @@ -50,8 +50,8 @@ type DescribeSharedDirectoriesInput struct { type DescribeSharedDirectoriesOutput struct { // If not null, token that indicates that more results are available. Pass this - // value for the NextToken parameter in a subsequent call to - // DescribeSharedDirectories to retrieve the next set of items. + // value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next + // set of items. NextToken *string // A list of all shared directories in your account. diff --git a/service/directoryservice/api_op_DescribeSnapshots.go b/service/directoryservice/api_op_DescribeSnapshots.go index 90f3d1c8c6f..6f3c6e23ac7 100644 --- a/service/directoryservice/api_op_DescribeSnapshots.go +++ b/service/directoryservice/api_op_DescribeSnapshots.go @@ -12,11 +12,14 @@ import ( ) // Obtains information about the directory snapshots that belong to this account. +// // This operation supports pagination with the use of the NextToken request and // response parameters. If more results are available, the // DescribeSnapshots.NextToken member contains a token that you pass in the next -// call to DescribeSnapshots to retrieve the next set of items. You can also -// specify a maximum number of return results with the Limit parameter. +// call to DescribeSnapshotsto retrieve the next set of items. +// +// You can also specify a maximum number of return results with the Limit +// parameter. func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) { if params == nil { params = &DescribeSnapshotsInput{} @@ -41,8 +44,8 @@ type DescribeSnapshotsInput struct { // The maximum number of objects to return. Limit *int32 - // The DescribeSnapshotsResult.NextToken value from a previous call to - // DescribeSnapshots . Pass null if this is the first call. + // The DescribeSnapshotsResult.NextToken value from a previous call to 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,13 +60,15 @@ type DescribeSnapshotsInput struct { type DescribeSnapshotsOutput struct { // If not null, more results are available. Pass this value in the NextToken - // member of a subsequent call to DescribeSnapshots . + // member of a subsequent call to DescribeSnapshots. NextToken *string - // The list of Snapshot 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. + // The list of Snapshot 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. Snapshots []types.Snapshot // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DescribeTrusts.go b/service/directoryservice/api_op_DescribeTrusts.go index 4757a059965..4c725c96f99 100644 --- a/service/directoryservice/api_op_DescribeTrusts.go +++ b/service/directoryservice/api_op_DescribeTrusts.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Obtains information about the trust relationships for this account. If no input -// parameters are provided, such as DirectoryId or TrustIds, this request describes -// all the trust relationships belonging to the account. +// Obtains information about the trust relationships for this account. +// +// If no input parameters are provided, such as DirectoryId or TrustIds, this +// request describes all the trust relationships belonging to the account. func (c *Client) DescribeTrusts(ctx context.Context, params *DescribeTrustsInput, optFns ...func(*Options)) (*DescribeTrustsOutput, error) { if params == nil { params = &DescribeTrustsInput{} @@ -41,14 +42,15 @@ 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 // information. If this member is null, all trust relationships that belong to the - // current account are returned. An empty list results in an - // InvalidParameterException being thrown. + // current account are returned. + // + // An empty list results in an InvalidParameterException being thrown. TrustIds []string noSmithyDocumentSerde @@ -58,14 +60,15 @@ type DescribeTrustsInput struct { type DescribeTrustsOutput struct { // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to DescribeTrusts to retrieve the next set of - // items. + // parameter in a subsequent call to DescribeTruststo retrieve the next set of items. NextToken *string - // The list of Trust 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. + // The list of Trust 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. Trusts []types.Trust // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DescribeUpdateDirectory.go b/service/directoryservice/api_op_DescribeUpdateDirectory.go index 082c12b9a5b..09f4c4d7a5f 100644 --- a/service/directoryservice/api_op_DescribeUpdateDirectory.go +++ b/service/directoryservice/api_op_DescribeUpdateDirectory.go @@ -29,21 +29,21 @@ func (c *Client) DescribeUpdateDirectory(ctx context.Context, params *DescribeUp type DescribeUpdateDirectoryInput struct { - // The unique identifier of the directory. + // The unique identifier of the directory. // // This member is required. DirectoryId *string - // The type of updates you want to describe for the directory. + // The type of updates you want to describe for the directory. // // 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. + // The name of the Region. RegionName *string noSmithyDocumentSerde @@ -51,11 +51,11 @@ type DescribeUpdateDirectoryInput struct { type DescribeUpdateDirectoryOutput struct { - // If not null, more results are available. Pass this value for the NextToken + // If not null, more results are available. Pass this value for the NextToken // parameter. NextToken *string - // The list of update activities on a directory for the requested update type. + // The list of update activities on a directory for the requested update type. UpdateActivities []types.UpdateInfoEntry // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_DisableSso.go b/service/directoryservice/api_op_DisableSso.go index 1b62eb0f675..20f2903cb5a 100644 --- a/service/directoryservice/api_op_DisableSso.go +++ b/service/directoryservice/api_op_DisableSso.go @@ -41,11 +41,13 @@ type DisableSsoInput struct { // The username of an alternate account to use to disable single-sign on. This is // only used for AD Connector directories. This account must have privileges to - // remove a service principal name. If the AD Connector service account does not - // have privileges to remove a service principal name, you can specify an alternate - // account with the UserName and Password parameters. These credentials are only - // used to disable single sign-on and are not stored by the service. The AD - // Connector service account is not changed. + // remove a service principal name. + // + // If the AD Connector service account does not have privileges to remove a + // service principal name, you can specify an alternate account with the UserName + // and Password parameters. These credentials are only used to disable single + // sign-on and are not stored by the service. The AD Connector service account is + // not changed. UserName *string noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_EnableSso.go b/service/directoryservice/api_op_EnableSso.go index 53227fe0f6c..2a889955c33 100644 --- a/service/directoryservice/api_op_EnableSso.go +++ b/service/directoryservice/api_op_EnableSso.go @@ -43,11 +43,13 @@ type EnableSsoInput struct { // The username of an alternate account to use to enable single-sign on. This is // only used for AD Connector directories. This account must have privileges to add - // a service principal name. If the AD Connector service account does not have - // privileges to add a service principal name, you can specify an alternate account - // with the UserName and Password parameters. These credentials are only used to - // enable single sign-on and are not stored by the service. The AD Connector - // service account is not changed. + // a service principal name. + // + // If the AD Connector service account does not have privileges to add a service + // principal name, you can specify an alternate account with the UserName and + // Password parameters. These credentials are only used to enable single sign-on + // and are not stored by the service. The AD Connector service account is not + // changed. UserName *string noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_GetDirectoryLimits.go b/service/directoryservice/api_op_GetDirectoryLimits.go index 713a71f386f..30a44aad345 100644 --- a/service/directoryservice/api_op_GetDirectoryLimits.go +++ b/service/directoryservice/api_op_GetDirectoryLimits.go @@ -35,8 +35,7 @@ type GetDirectoryLimitsInput struct { // Contains the results of the GetDirectoryLimits operation. type GetDirectoryLimitsOutput struct { - // A DirectoryLimits object that contains the directory limits for the current - // Region. + // A DirectoryLimits object that contains the directory limits for the current Region. DirectoryLimits *types.DirectoryLimits // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_GetSnapshotLimits.go b/service/directoryservice/api_op_GetSnapshotLimits.go index 41415da015f..b88fc2567b7 100644 --- a/service/directoryservice/api_op_GetSnapshotLimits.go +++ b/service/directoryservice/api_op_GetSnapshotLimits.go @@ -41,8 +41,7 @@ type GetSnapshotLimitsInput struct { // Contains the results of the GetSnapshotLimits operation. type GetSnapshotLimitsOutput struct { - // A SnapshotLimits object that contains the manual snapshot limits for the - // specified directory. + // A SnapshotLimits object that contains the manual snapshot limits for the specified directory. SnapshotLimits *types.SnapshotLimits // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_ListIpRoutes.go b/service/directoryservice/api_op_ListIpRoutes.go index a368c767f46..d310ca1ad40 100644 --- a/service/directoryservice/api_op_ListIpRoutes.go +++ b/service/directoryservice/api_op_ListIpRoutes.go @@ -39,8 +39,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 @@ -48,12 +48,11 @@ type ListIpRoutesInput struct { type ListIpRoutesOutput struct { - // A list of IpRoute s. + // A list of IpRoutes. IpRoutesInfo []types.IpRouteInfo // If not null, more results are available. Pass this value for the NextToken - // parameter in a subsequent call to ListIpRoutes to retrieve the next set of - // items. + // parameter in a subsequent call to ListIpRoutesto retrieve the next set of items. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/directoryservice/api_op_ListLogSubscriptions.go b/service/directoryservice/api_op_ListLogSubscriptions.go index e036a52c4c2..1a979a5ccee 100644 --- a/service/directoryservice/api_op_ListLogSubscriptions.go +++ b/service/directoryservice/api_op_ListLogSubscriptions.go @@ -47,8 +47,7 @@ type ListLogSubscriptionsInput struct { type ListLogSubscriptionsOutput struct { - // A list of active LogSubscription objects for calling the Amazon Web Services - // account. + // A list of active LogSubscription objects for calling the Amazon Web Services account. LogSubscriptions []types.LogSubscription // The token for the next set of items to return. diff --git a/service/directoryservice/api_op_ResetUserPassword.go b/service/directoryservice/api_op_ResetUserPassword.go index 1b01a3bcdc7..f62d21e2f83 100644 --- a/service/directoryservice/api_op_ResetUserPassword.go +++ b/service/directoryservice/api_op_ResetUserPassword.go @@ -11,17 +11,23 @@ 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: +// 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. +// Managed Microsoft AD directory, see [What Gets Created]in the Directory Service Administration +// Guide. +// +// [What Gets Created]: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html 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 022425d845f..72526a5fdc9 100644 --- a/service/directoryservice/api_op_RestoreFromSnapshot.go +++ b/service/directoryservice/api_op_RestoreFromSnapshot.go @@ -10,13 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Restores a directory using an existing directory snapshot. When you restore a -// directory from a snapshot, any changes made to the directory after the snapshot -// 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 -// complete. +// Restores a directory using an existing directory snapshot. +// +// When you restore a directory from a snapshot, any changes made to the directory +// after the snapshot 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 DescribeDirectoriesoperation with the +// directory identifier. When the 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 { params = &RestoreFromSnapshotInput{} diff --git a/service/directoryservice/api_op_ShareDirectory.go b/service/directoryservice/api_op_ShareDirectory.go index de04adea920..1c814117a64 100644 --- a/service/directoryservice/api_op_ShareDirectory.go +++ b/service/directoryservice/api_op_ShareDirectory.go @@ -14,18 +14,22 @@ import ( // 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 -// share your Managed Microsoft AD directory, Directory Service creates a shared -// directory in the directory consumer account. This shared directory contains the -// metadata to provide access to the directory within the directory owner account. -// The shared directory is visible in all VPCs in the directory consumer account. +// account and from any Amazon VPC within an Amazon Web Services Region. +// +// When you share your Managed Microsoft AD directory, Directory Service creates a +// shared directory in the directory consumer account. This shared directory +// contains the metadata to provide access to the directory within the directory +// owner account. 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 // directory with any other Amazon Web Services account either inside or outside of -// the organization ( HANDSHAKE ). The ShareNotes parameter is only used when -// HANDSHAKE is called, which sends a directory sharing request to the directory -// consumer. +// 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) { if params == nil { params = &ShareDirectoryInput{} diff --git a/service/directoryservice/api_op_UpdateDirectorySetup.go b/service/directoryservice/api_op_UpdateDirectorySetup.go index bca7e1a8d6d..f33d484d9af 100644 --- a/service/directoryservice/api_op_UpdateDirectorySetup.go +++ b/service/directoryservice/api_op_UpdateDirectorySetup.go @@ -29,21 +29,22 @@ func (c *Client) UpdateDirectorySetup(ctx context.Context, params *UpdateDirecto type UpdateDirectorySetupInput struct { - // The identifier of the directory on which you want to perform the update. + // The identifier of the directory on which you want to perform the update. // // This member is required. DirectoryId *string - // The type of update that needs to be performed on the directory. For example, OS. + // The type of update that needs to be performed on the directory. For example, + // OS. // // This member is required. UpdateType types.UpdateType - // The boolean that specifies if a snapshot for the directory needs to be taken + // The boolean that specifies if a snapshot for the directory needs to be taken // before updating the directory. CreateSnapshotBeforeUpdate *bool - // The settings for the OS update that needs to be performed on the directory. + // The settings for the OS update that needs to be performed on the directory. OSUpdateSettings *types.OSUpdateSettings noSmithyDocumentSerde diff --git a/service/directoryservice/api_op_VerifyTrust.go b/service/directoryservice/api_op_VerifyTrust.go index 1d93314dea7..f2c1d993a48 100644 --- a/service/directoryservice/api_op_VerifyTrust.go +++ b/service/directoryservice/api_op_VerifyTrust.go @@ -11,8 +11,10 @@ import ( ) // Directory Service for Microsoft Active Directory allows you to configure and -// verify trust relationships. This action verifies a trust relationship between -// your Managed Microsoft AD directory and an external domain. +// verify trust relationships. +// +// This action verifies a trust relationship between your Managed Microsoft AD +// directory and an external domain. func (c *Client) VerifyTrust(ctx context.Context, params *VerifyTrustInput, optFns ...func(*Options)) (*VerifyTrustOutput, error) { if params == nil { params = &VerifyTrustInput{} diff --git a/service/directoryservice/doc.go b/service/directoryservice/doc.go index 40f8a92625a..5d6a00c5f16 100644 --- a/service/directoryservice/doc.go +++ b/service/directoryservice/doc.go @@ -3,17 +3,23 @@ // Package directoryservice provides the API client, operations, and parameter // types for AWS Directory Service. // -// Directory Service Directory Service is a web service that makes it easy for you -// to setup and run directories in the Amazon Web Services cloud, or connect your -// 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, +// # Directory Service +// +// Directory Service is a web service that makes it easy for you to setup and run +// directories in the Amazon Web Services cloud, or connect your 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]and the [Directory Service Administration Guide]. +// +// 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]. +// +// [Directory Service Administration Guide]: http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [Directory Service]: https://aws.amazon.com/directoryservice/ package directoryservice diff --git a/service/directoryservice/options.go b/service/directoryservice/options.go index 24f9d04a966..00d0795e82e 100644 --- a/service/directoryservice/options.go +++ b/service/directoryservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/directoryservice/types/enums.go b/service/directoryservice/types/enums.go index e18b00084c9..9d268b24768 100644 --- a/service/directoryservice/types/enums.go +++ b/service/directoryservice/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for CertificateState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateState) Values() []CertificateState { return []CertificateState{ "Registering", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for CertificateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateType) Values() []CertificateType { return []CertificateType{ "ClientCertAuth", @@ -56,6 +58,7 @@ const ( // Values returns all known values for ClientAuthenticationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ClientAuthenticationStatus) Values() []ClientAuthenticationStatus { return []ClientAuthenticationStatus{ @@ -74,6 +77,7 @@ const ( // 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{ @@ -95,8 +99,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryConfigurationStatus) Values() []DirectoryConfigurationStatus { return []DirectoryConfigurationStatus{ "Requested", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for DirectoryEdition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryEdition) Values() []DirectoryEdition { return []DirectoryEdition{ "Enterprise", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for DirectorySize. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectorySize) Values() []DirectorySize { return []DirectorySize{ "Small", @@ -161,8 +168,9 @@ const ( ) // Values returns all known values for DirectoryStage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryStage) Values() []DirectoryStage { return []DirectoryStage{ "Requested", @@ -190,8 +198,9 @@ const ( ) // Values returns all known values for DirectoryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryType) Values() []DirectoryType { return []DirectoryType{ "SimpleAD", @@ -215,8 +224,9 @@ const ( ) // Values returns all known values for DomainControllerStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainControllerStatus) Values() []DomainControllerStatus { return []DomainControllerStatus{ "Creating", @@ -242,8 +252,9 @@ const ( ) // Values returns all known values for IpRouteStatusMsg. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpRouteStatusMsg) Values() []IpRouteStatusMsg { return []IpRouteStatusMsg{ "Adding", @@ -266,8 +277,9 @@ const ( ) // Values returns all known values for LDAPSStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LDAPSStatus) Values() []LDAPSStatus { return []LDAPSStatus{ "Enabling", @@ -285,8 +297,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -302,8 +315,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -323,8 +337,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RadiusAuthenticationProtocol) Values() []RadiusAuthenticationProtocol { return []RadiusAuthenticationProtocol{ "PAP", @@ -344,8 +359,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -363,8 +379,9 @@ const ( ) // Values returns all known values for RegionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegionType) Values() []RegionType { return []RegionType{ "Primary", @@ -380,8 +397,9 @@ const ( ) // Values returns all known values for ReplicationScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationScope) Values() []ReplicationScope { return []ReplicationScope{ "Domain", @@ -404,8 +422,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Initializing", @@ -429,8 +448,9 @@ const ( ) // Values returns all known values for SelectiveAuth. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SelectiveAuth) Values() []SelectiveAuth { return []SelectiveAuth{ "Enabled", @@ -447,8 +467,9 @@ const ( ) // Values returns all known values for ShareMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareMethod) Values() []ShareMethod { return []ShareMethod{ "ORGANIZATIONS", @@ -472,8 +493,9 @@ const ( ) // Values returns all known values for ShareStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatus) Values() []ShareStatus { return []ShareStatus{ "Shared", @@ -498,8 +520,9 @@ const ( ) // Values returns all known values for SnapshotStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotStatus) Values() []SnapshotStatus { return []SnapshotStatus{ "Creating", @@ -517,8 +540,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -534,8 +558,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "ACCOUNT", @@ -553,8 +578,9 @@ const ( ) // Values returns all known values for TopicStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TopicStatus) Values() []TopicStatus { return []TopicStatus{ "Registered", @@ -574,8 +600,9 @@ const ( ) // Values returns all known values for TrustDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustDirection) Values() []TrustDirection { return []TrustDirection{ "One-Way: Outgoing", @@ -602,8 +629,9 @@ const ( ) // Values returns all known values for TrustState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustState) Values() []TrustState { return []TrustState{ "Creating", @@ -629,8 +657,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -648,8 +677,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -666,8 +696,9 @@ const ( ) // Values returns all known values for UpdateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateType) Values() []UpdateType { return []UpdateType{ "OS", diff --git a/service/directoryservice/types/errors.go b/service/directoryservice/types/errors.go index 1fbad15309c..ebb262eee48 100644 --- a/service/directoryservice/types/errors.go +++ b/service/directoryservice/types/errors.go @@ -321,8 +321,7 @@ func (e *DirectoryInDesiredStateException) ErrorCode() string { func (e *DirectoryInDesiredStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The maximum number of directories in the region has been reached. You can use -// the GetDirectoryLimits operation to determine your directory limits in the -// region. +// the GetDirectoryLimitsoperation to determine your directory limits in the region. type DirectoryLimitExceededException struct { Message *string @@ -922,8 +921,7 @@ func (e *ShareLimitExceededException) ErrorCode() string { func (e *ShareLimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The maximum number of manual snapshots for the directory has been reached. You -// can use the GetSnapshotLimits operation to determine the snapshot limits for a -// directory. +// can use the GetSnapshotLimitsoperation to determine the snapshot limits for a directory. type SnapshotLimitExceededException struct { Message *string diff --git a/service/directoryservice/types/types.go b/service/directoryservice/types/types.go index 15075047b4b..d2a1ff58d42 100644 --- a/service/directoryservice/types/types.go +++ b/service/directoryservice/types/types.go @@ -107,8 +107,8 @@ type ClientCertAuthSettings struct { // Contains information about a computer account in a directory. type Computer struct { - // An array of Attribute objects containing the LDAP attributes that belong to the - // computer account. + // An array of Attribute objects containing the LDAP attributes that belong to the computer + // account. ComputerAttributes []Attribute // The identifier of the computer. @@ -142,8 +142,8 @@ type ConditionalForwarder struct { noSmithyDocumentSerde } -// Contains information for the ConnectDirectory operation when an AD Connector -// directory is being created. +// Contains information for the ConnectDirectory operation when an AD Connector directory is being +// created. type DirectoryConnectSettings struct { // A list of one or more IP addresses of DNS servers or domain controllers in your @@ -154,8 +154,11 @@ 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 // // This member is required. @@ -210,9 +213,8 @@ type DirectoryDescription struct { // the alias is the directory identifier, such as d-XXXXXXXXXX . Alias *string - // A DirectoryConnectSettingsDescription object that contains additional - // information about an AD Connector directory. This member is only present if the - // directory is an AD Connector directory. + // A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. + // This member is only present if the directory is an AD Connector directory. ConnectSettings *DirectoryConnectSettingsDescription // The description for the directory. @@ -247,8 +249,8 @@ type DirectoryDescription struct { // Describes the Managed Microsoft AD directory in the directory owner account. OwnerDirectoryDescription *OwnerDirectoryDescription - // A RadiusSettings object that contains information about the RADIUS server - // configured for this directory. + // A RadiusSettings object that contains information about the RADIUS server configured for this + // directory. RadiusSettings *RadiusSettings // The status of the RADIUS MFA server connection. @@ -278,7 +280,7 @@ type DirectoryDescription struct { Size DirectorySize // Indicates if single sign-on is enabled for the directory. For more information, - // see EnableSso and DisableSso . + // see EnableSsoand DisableSso. SsoEnabled bool // The current stage of the directory. @@ -293,9 +295,9 @@ type DirectoryDescription struct { // The directory size. Type DirectoryType - // A DirectoryVpcSettingsDescription object that contains additional information - // about a directory. This member is only present if the directory is a Simple AD - // or Managed Microsoft AD directory. + // A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member + // is only present if the directory is a Simple AD or Managed Microsoft AD + // directory. VpcSettings *DirectoryVpcSettingsDescription noSmithyDocumentSerde @@ -450,10 +452,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. @@ -503,7 +505,7 @@ type LogSubscription struct { // OS version that the directory needs to be updated to. type OSUpdateSettings struct { - // OS version that the directory needs to be updated to. + // OS version that the directory needs to be updated to. OSVersion OSVersion noSmithyDocumentSerde @@ -649,7 +651,9 @@ type SchemaExtensionInfo struct { // Contains information about the configurable settings for a directory. type Setting struct { - // The name of the directory setting. For example: TLS_1_0 + // The name of the directory setting. For example: + // + // TLS_1_0 // // This member is required. Name *string @@ -685,7 +689,9 @@ type SettingEntry struct { // The date and time when the directory setting was last updated. LastUpdatedDateTime *time.Time - // The name of the directory setting. For example: TLS_1_0 + // The name of the directory setting. For example: + // + // TLS_1_0 Name *string // Details about the status of the request to update the directory setting. If the @@ -891,29 +897,29 @@ type UnshareTarget struct { // An entry of update information related to a requested update type. type UpdateInfoEntry struct { - // This specifies if the update was initiated by the customer or by the service + // This specifies if the update was initiated by the customer or by the service // team. InitiatedBy *string - // The last updated date and time of a particular directory setting. + // The last updated date and time of a particular directory setting. LastUpdatedDateTime *time.Time - // The new value of the target setting. + // The new value of the target setting. NewValue *UpdateValue - // The old value of the target setting. + // The old value of the target setting. PreviousValue *UpdateValue - // The name of the Region. + // The name of the Region. Region *string - // The start time of the UpdateDirectorySetup for the particular type. + // The start time of the UpdateDirectorySetup for the particular type. StartTime *time.Time - // The status of the update performed on the directory. + // The status of the update performed on the directory. Status UpdateStatus - // The reason for the current status of the update type activity. + // The reason for the current status of the update type activity. StatusReason *string noSmithyDocumentSerde @@ -922,7 +928,7 @@ type UpdateInfoEntry struct { // The value for a given type of UpdateSettings . type UpdateValue struct { - // The OS update related settings. + // The OS update related settings. OSUpdateSettings *OSUpdateSettings noSmithyDocumentSerde diff --git a/service/dlm/api_op_CreateLifecyclePolicy.go b/service/dlm/api_op_CreateLifecyclePolicy.go index 79583a46c74..e41c5828c40 100644 --- a/service/dlm/api_op_CreateLifecyclePolicy.go +++ b/service/dlm/api_op_CreateLifecyclePolicy.go @@ -13,15 +13,23 @@ import ( // Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data // Lifecycle Manager supports the following policy types: +// // - Custom EBS snapshot policy +// // - Custom EBS-backed AMI policy +// // - Cross-account copy event policy +// // - Default policy for EBS snapshots +// // - Default policy for EBS-backed AMIs // -// For more information, see Default policies vs custom policies (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/policy-differences.html) -// . If you create a default policy, you can specify the request parameters either +// For more information, see [Default policies vs custom policies]. +// +// If you create a default policy, you can specify the request parameters either // in the request body, or in the PolicyDetails request structure, but not both. +// +// [Default policies vs custom policies]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/policy-differences.html func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, optFns ...func(*Options)) (*CreateLifecyclePolicyOutput, error) { if params == nil { params = &CreateLifecyclePolicyInput{} @@ -56,62 +64,79 @@ type CreateLifecyclePolicyInput struct { // This member is required. State types.SettablePolicyStateValues - // [Default policies only] Indicates whether the policy should copy tags from the + // [Default policies only] Indicates whether the policy should copy tags from the // source resource to the snapshot or AMI. If you do not specify a value, the - // default is false . Default: false + // default is false . + // + // Default: false CopyTags *bool - // [Default policies only] Specifies how often the policy should run and create + // [Default policies only] Specifies how often the policy should run and create // snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do - // not specify a value, the default is 1. Default: 1 + // not specify a value, the default is 1. + // + // Default: 1 CreateInterval *int32 - // [Default policies only] Specifies destination Regions for snapshot or AMI + // [Default policies only] Specifies destination Regions for snapshot or AMI // copies. You can specify up to 3 destination Regions. If you do not want to // create cross-Region copies, omit this parameter. CrossRegionCopyTargets []types.CrossRegionCopyTarget - // [Default policies only] Specify the type of default policy to create. + // [Default policies only] Specify the type of default policy to create. + // // - To create a default policy for EBS snapshots, that creates snapshots of all // volumes in the Region that do not have recent backups, specify VOLUME . + // // - To create a default policy for EBS-backed AMIs, that creates EBS-backed // AMIs from all instances in the Region that do not have recent backups, specify // INSTANCE . DefaultPolicy types.DefaultPolicyTypeValues - // [Default policies only] Specifies exclusion parameters for volumes or instances - // for which you do not want to create snapshots or AMIs. The policy will not - // create snapshots or AMIs for target resources that match any of the specified - // exclusion parameters. + // [Default policies only] Specifies exclusion parameters for volumes or + // instances for which you do not want to create snapshots or AMIs. The policy will + // not create snapshots or AMIs for target resources that match any of the + // specified exclusion parameters. Exclusions *types.Exclusions - // [Default policies only] Defines the snapshot or AMI retention behavior for the + // [Default policies only] Defines the snapshot or AMI retention behavior for the // policy if the source volume or instance is deleted, or if the policy enters the - // error, disabled, or deleted state. By default (ExtendDeletion=false): + // error, disabled, or deleted state. + // + // By default (ExtendDeletion=false): + // // - If a source resource is deleted, Amazon Data Lifecycle Manager will // continue to delete previously created snapshots or AMIs, up to but not including // the last one, based on the specified retention period. If you want Amazon Data // Lifecycle Manager to delete all snapshots or AMIs, including the last one, // specify true . + // // - If a policy enters the error, disabled, or deleted state, Amazon Data // Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data // Lifecycle Manager to continue deleting snapshots or AMIs, including the last // one, if the policy enters one of these states, specify true . + // // If you enable extended deletion (ExtendDeletion=true), you override both - // default behaviors simultaneously. If you do not specify a value, the default is - // false . Default: false + // default behaviors simultaneously. + // + // If you do not specify a value, the default is false . + // + // Default: false ExtendDeletion *bool - // The configuration details of the lifecycle policy. If you create a default - // policy, you can specify the request parameters either in the request body, or in - // the PolicyDetails request structure, but not both. + // The configuration details of the lifecycle policy. + // + // If you create a default policy, you can specify the request parameters either + // in the request body, or in the PolicyDetails request structure, but not both. PolicyDetails *types.PolicyDetails - // [Default policies only] Specifies how long the policy should retain snapshots + // [Default policies only] Specifies how long the policy should retain snapshots // or AMIs before deleting them. The retention period can range from 2 to 14 days, // but it must be greater than the creation frequency to ensure that the policy // retains at least 1 snapshot or AMI at any given time. If you do not specify a - // value, the default is 7. Default: 7 + // value, the default is 7. + // + // Default: 7 RetainInterval *int32 // The tags to apply to the lifecycle policy during creation. diff --git a/service/dlm/api_op_DeleteLifecyclePolicy.go b/service/dlm/api_op_DeleteLifecyclePolicy.go index 6d339fb3203..f757890d65f 100644 --- a/service/dlm/api_op_DeleteLifecyclePolicy.go +++ b/service/dlm/api_op_DeleteLifecyclePolicy.go @@ -11,9 +11,11 @@ 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) -// . +// the policy specified. +// +// For more information about deleting a policy, see [Delete lifecycle policies]. +// +// [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 2a9c197fa15..7eb32af4d81 100644 --- a/service/dlm/api_op_GetLifecyclePolicies.go +++ b/service/dlm/api_op_GetLifecyclePolicies.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets summary information about all or the specified data lifecycle policies. To -// get complete information about a policy, use GetLifecyclePolicy (https://docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html) -// . +// Gets summary information about all or the specified data lifecycle policies. +// +// To get complete information about a policy, use [GetLifecyclePolicy]. +// +// [GetLifecyclePolicy]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html func (c *Client) GetLifecyclePolicies(ctx context.Context, params *GetLifecyclePoliciesInput, optFns ...func(*Options)) (*GetLifecyclePoliciesOutput, error) { if params == nil { params = &GetLifecyclePoliciesInput{} @@ -31,10 +33,13 @@ func (c *Client) GetLifecyclePolicies(ctx context.Context, params *GetLifecycleP type GetLifecyclePoliciesInput struct { - // [Default policies only] Specifies the type of default policy to get. Specify + // [Default policies only] Specifies the type of default policy to get. Specify // one of the following: + // // - VOLUME - To get only the default policy for EBS snapshots + // // - INSTANCE - To get only the default policy for EBS-backed AMIs + // // - ALL - To get all default policies DefaultPolicyType types.DefaultPoliciesTypeValues @@ -47,12 +52,17 @@ 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 912a0fbdeab..9b2739541eb 100644 --- a/service/dlm/api_op_UpdateLifecyclePolicy.go +++ b/service/dlm/api_op_UpdateLifecyclePolicy.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates the specified lifecycle policy. +// +// For more information about updating a policy, see [Modify lifecycle policies]. +// +// [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{} @@ -36,15 +38,15 @@ type UpdateLifecyclePolicyInput struct { // This member is required. PolicyId *string - // [Default policies only] Indicates whether the policy should copy tags from the + // [Default policies only] Indicates whether the policy should copy tags from the // source resource to the snapshot or AMI. CopyTags *bool - // [Default policies only] Specifies how often the policy should run and create + // [Default policies only] Specifies how often the policy should run and create // snapshots or AMIs. The creation frequency can range from 1 to 7 days. CreateInterval *int32 - // [Default policies only] Specifies destination Regions for snapshot or AMI + // [Default policies only] Specifies destination Regions for snapshot or AMI // copies. You can specify up to 3 destination Regions. If you do not want to // create cross-Region copies, omit this parameter. CrossRegionCopyTargets []types.CrossRegionCopyTarget @@ -52,37 +54,44 @@ type UpdateLifecyclePolicyInput struct { // A description of the lifecycle policy. Description *string - // [Default policies only] Specifies exclusion parameters for volumes or instances - // for which you do not want to create snapshots or AMIs. The policy will not - // create snapshots or AMIs for target resources that match any of the specified - // exclusion parameters. + // [Default policies only] Specifies exclusion parameters for volumes or + // instances for which you do not want to create snapshots or AMIs. The policy will + // not create snapshots or AMIs for target resources that match any of the + // specified exclusion parameters. Exclusions *types.Exclusions // The Amazon Resource Name (ARN) of the IAM role used to run the operations // specified by the lifecycle policy. ExecutionRoleArn *string - // [Default policies only] Defines the snapshot or AMI retention behavior for the + // [Default policies only] Defines the snapshot or AMI retention behavior for the // policy if the source volume or instance is deleted, or if the policy enters the - // error, disabled, or deleted state. By default (ExtendDeletion=false): + // error, disabled, or deleted state. + // + // By default (ExtendDeletion=false): + // // - If a source resource is deleted, Amazon Data Lifecycle Manager will // continue to delete previously created snapshots or AMIs, up to but not including // the last one, based on the specified retention period. If you want Amazon Data // Lifecycle Manager to delete all snapshots or AMIs, including the last one, // specify true . + // // - If a policy enters the error, disabled, or deleted state, Amazon Data // Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data // Lifecycle Manager to continue deleting snapshots or AMIs, including the last // one, if the policy enters one of these states, specify true . + // // If you enable extended deletion (ExtendDeletion=true), you override both - // default behaviors simultaneously. Default: false + // default behaviors simultaneously. + // + // Default: false ExtendDeletion *bool // The configuration of the lifecycle policy. You cannot update the policy type or // the resource type. PolicyDetails *types.PolicyDetails - // [Default policies only] Specifies how long the policy should retain snapshots + // [Default policies only] Specifies how long the policy should retain snapshots // or AMIs before deleting them. The retention period can range from 2 to 14 days, // but it must be greater than the creation frequency to ensure that the policy // retains at least 1 snapshot or AMI at any given time. diff --git a/service/dlm/doc.go b/service/dlm/doc.go index e5e9ed1f217..4f817a74e9a 100644 --- a/service/dlm/doc.go +++ b/service/dlm/doc.go @@ -3,11 +3,15 @@ // 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 -// policies, which are used to automate operations on the specified resources. +// # 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. +// information about using Amazon Data Lifecycle Manager with Amazon EBS, see [Amazon Data Lifecycle Manager]in +// the Amazon EC2 User Guide. +// +// [Amazon Data Lifecycle Manager]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html package dlm diff --git a/service/dlm/options.go b/service/dlm/options.go index 2d56b3befc2..d99b7e87f1e 100644 --- a/service/dlm/options.go +++ b/service/dlm/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/dlm/types/enums.go b/service/dlm/types/enums.go index 0c8e907d65c..3ee1d5b129c 100644 --- a/service/dlm/types/enums.go +++ b/service/dlm/types/enums.go @@ -13,6 +13,7 @@ const ( // Values returns all known values for DefaultPoliciesTypeValues. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DefaultPoliciesTypeValues) Values() []DefaultPoliciesTypeValues { return []DefaultPoliciesTypeValues{ @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for DefaultPolicyTypeValues. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultPolicyTypeValues) Values() []DefaultPolicyTypeValues { return []DefaultPolicyTypeValues{ "VOLUME", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for EventSourceValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourceValues) Values() []EventSourceValues { return []EventSourceValues{ "MANAGED_CWE", @@ -64,8 +67,9 @@ const ( ) // Values returns all known values for EventTypeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventTypeValues) Values() []EventTypeValues { return []EventTypeValues{ "shareSnapshot", @@ -81,8 +85,9 @@ const ( // Values returns all known values for ExecutionHandlerServiceValues. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionHandlerServiceValues) Values() []ExecutionHandlerServiceValues { return []ExecutionHandlerServiceValues{ "AWS_SYSTEMS_MANAGER", @@ -100,6 +105,7 @@ const ( // Values returns all known values for GettablePolicyStateValues. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GettablePolicyStateValues) Values() []GettablePolicyStateValues { return []GettablePolicyStateValues{ @@ -117,8 +123,9 @@ const ( ) // Values returns all known values for IntervalUnitValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntervalUnitValues) Values() []IntervalUnitValues { return []IntervalUnitValues{ "HOURS", @@ -134,8 +141,9 @@ const ( ) // Values returns all known values for LocationValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocationValues) Values() []LocationValues { return []LocationValues{ "CLOUD", @@ -152,8 +160,9 @@ const ( ) // Values returns all known values for PolicyLanguageValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyLanguageValues) Values() []PolicyLanguageValues { return []PolicyLanguageValues{ "SIMPLIFIED", @@ -171,8 +180,9 @@ const ( ) // Values returns all known values for PolicyTypeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyTypeValues) Values() []PolicyTypeValues { return []PolicyTypeValues{ "EBS_SNAPSHOT_MANAGEMENT", @@ -190,8 +200,9 @@ const ( ) // Values returns all known values for ResourceLocationValues. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceLocationValues) Values() []ResourceLocationValues { return []ResourceLocationValues{ "CLOUD", @@ -208,8 +219,9 @@ const ( ) // Values returns all known values for ResourceTypeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceTypeValues) Values() []ResourceTypeValues { return []ResourceTypeValues{ "VOLUME", @@ -229,6 +241,7 @@ const ( // Values returns all known values for RetentionIntervalUnitValues. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RetentionIntervalUnitValues) Values() []RetentionIntervalUnitValues { return []RetentionIntervalUnitValues{ @@ -249,6 +262,7 @@ const ( // Values returns all known values for SettablePolicyStateValues. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SettablePolicyStateValues) Values() []SettablePolicyStateValues { return []SettablePolicyStateValues{ @@ -266,8 +280,9 @@ const ( ) // Values returns all known values for StageValues. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StageValues) Values() []StageValues { return []StageValues{ "PRE", diff --git a/service/dlm/types/types.go b/service/dlm/types/types.go index 56ca257accd..06bfcb5ba02 100644 --- a/service/dlm/types/types.go +++ b/service/dlm/types/types.go @@ -23,13 +23,15 @@ type Action struct { noSmithyDocumentSerde } -// [Custom snapshot policies only] Specifies information about the archive storage -// tier retention period. +// [Custom snapshot policies only] Specifies information about the archive +// +// storage tier 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) - // . + // more information, see [Archive Amazon EBS snapshots]. + // + // [Archive Amazon EBS snapshots]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html // // This member is required. RetentionArchiveTier *RetentionArchiveTier @@ -37,7 +39,8 @@ type ArchiveRetainRule struct { noSmithyDocumentSerde } -// [Custom snapshot policies only] Specifies a snapshot archiving rule for a +// [Custom snapshot policies only] Specifies a snapshot archiving rule for a +// // schedule. type ArchiveRule struct { @@ -49,18 +52,23 @@ type ArchiveRule struct { noSmithyDocumentSerde } -// [Custom snapshot and AMI policies only] Specifies when the policy should create -// snapshots or AMIs. +// [Custom 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 (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) -// for the schedule, then you must specify a creation frequency of at least 28 -// days. +// +// - If you need to specify an [ArchiveRule]for the schedule, then you must specify a +// creation frequency of at least 28 days. +// +// [ArchiveRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html 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) - // in the Amazon CloudWatch User Guide. + // hour and 1 year. For more information, see [Cron expressions]in the Amazon CloudWatch User Guide. + // + // [Cron expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions CronExpression *string // The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, @@ -70,38 +78,46 @@ type CreateRule struct { // The interval unit. IntervalUnit IntervalUnitValues - // [Custom 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. + // [Custom 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 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 the source resource, or in the Region of that Outpost. Location LocationValues - // [Custom snapshot policies that target instances only] Specifies pre and/or post - // scripts for a snapshot lifecycle policy that targets instances. This is useful - // for creating application-consistent snapshots, or for performing specific + // [Custom snapshot policies that target instances only] Specifies pre and/or + // post scripts for a snapshot lifecycle policy that targets instances. This is + // useful for creating application-consistent snapshots, or for performing specific // administrative tasks before or after Amazon Data Lifecycle Manager initiates - // snapshot creation. For more information, see Automating application-consistent - // snapshots with pre and post scripts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html) - // . + // snapshot creation. + // + // For more information, see [Automating application-consistent snapshots with pre and post scripts]. + // + // [Automating application-consistent snapshots with pre and post scripts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html Scripts []Script - // The time, in UTC, to start the operation. The supported format is hh:mm. The - // operation occurs within a one-hour window following the specified time. If you - // do not specify a time, Amazon Data Lifecycle Manager selects a time within the - // next 24 hours. + // The time, in UTC, to start the operation. The supported format is hh:mm. + // + // The operation occurs within a one-hour window following the specified time. If + // you do not specify a time, Amazon Data Lifecycle Manager selects a time within + // the next 24 hours. Times []string 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 (https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html) -// . +// [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]. +// +// [CrossRegionCopyRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html type CrossRegionCopyAction struct { // The encryption settings for the copied snapshot. @@ -122,7 +138,8 @@ type CrossRegionCopyAction struct { noSmithyDocumentSerde } -// [Custom AMI policies only] Specifies an AMI deprecation rule for cross-Region +// [Custom AMI policies only] Specifies an AMI deprecation rule for cross-Region +// // AMI copies created by an AMI policy. type CrossRegionCopyDeprecateRule struct { @@ -156,10 +173,13 @@ type CrossRegionCopyRetainRule struct { noSmithyDocumentSerde } -// [Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for -// a snapshot and AMI policies. To specify a cross-Region copy action for -// event-based polices, use CrossRegionCopyAction (https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html) -// . +// [Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for +// +// a snapshot and AMI policies. +// +// To specify a cross-Region copy action for event-based polices, use [CrossRegionCopyAction]. +// +// [CrossRegionCopyAction]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html type CrossRegionCopyRule struct { // To encrypt a copy of an unencrypted snapshot if encryption by default is not @@ -178,8 +198,8 @@ type CrossRegionCopyRule struct { // to the cross-Region copy. CopyTags *bool - // [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies - // created by the rule. + // [Custom 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 @@ -187,13 +207,16 @@ type CrossRegionCopyRule struct { RetainRule *CrossRegionCopyRetainRule // Use this parameter for snapshot policies only. For AMI policies, use - // TargetRegion instead. [Custom snapshot policies only] The target Region or the - // Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. + // TargetRegion instead. + // + // [Custom snapshot policies only] The target Region or the Amazon Resource Name + // (ARN) of the target Outpost for the snapshot copies. Target *string // Use this parameter for AMI policies only. For snapshot policies, use Target // instead. For snapshot policies created before the Target parameter was // introduced, this parameter indicates the target Region for snapshot copies. + // // [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) // of the target Outpost for the snapshot copies. TargetRegion *string @@ -201,7 +224,8 @@ type CrossRegionCopyRule struct { noSmithyDocumentSerde } -// [Default policies only] Specifies a destination Region for cross-Region copy +// [Default policies only] Specifies a destination Region for cross-Region copy +// // actions. type CrossRegionCopyTarget struct { @@ -211,9 +235,12 @@ type CrossRegionCopyTarget struct { noSmithyDocumentSerde } -// [Custom 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. +// [Custom 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 { // If the schedule has a count-based retention rule, this parameter specifies the @@ -233,7 +260,8 @@ type DeprecateRule struct { noSmithyDocumentSerde } -// [Event-based policies only] Specifies the encryption settings for cross-Region +// [Event-based policies only] Specifies the encryption settings for cross-Region +// // snapshot copies created by event-based policies. type EncryptionConfiguration struct { @@ -252,13 +280,15 @@ type EncryptionConfiguration struct { noSmithyDocumentSerde } -// [Event-based policies only] Specifies an event that activates an event-based +// [Event-based policies only] Specifies an event that activates an event-based +// // 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.*$ // configures the policy to run only if snapshots created by policy // policy-1234567890abcdef0 are shared with your account. @@ -281,7 +311,8 @@ type EventParameters struct { noSmithyDocumentSerde } -// [Event-based policies only] Specifies an event that activates an event-based +// [Event-based policies only] Specifies an event that activates an event-based +// // policy. type EventSource struct { @@ -297,30 +328,32 @@ type EventSource struct { noSmithyDocumentSerde } -// [Default policies only] Specifies exclusion parameters for volumes or instances -// for which you do not want to create snapshots or AMIs. The policy will not -// create snapshots or AMIs for target resources that match any of the specified -// exclusion parameters. +// [Default policies only] Specifies exclusion parameters for volumes or +// +// instances for which you do not want to create snapshots or AMIs. The policy will +// not create snapshots or AMIs for target resources that match any of the +// specified exclusion parameters. type Exclusions struct { - // [Default policies for EBS snapshots only] Indicates whether to exclude volumes + // [Default policies for EBS snapshots only] Indicates whether to exclude volumes // that are attached to instances as the boot volume. If you exclude boot volumes, // only volumes attached as data (non-boot) volumes will be backed up by the // policy. To exclude boot volumes, specify true . ExcludeBootVolumes *bool - // [Default policies for EBS-backed AMIs only] Specifies whether to exclude + // [Default policies for EBS-backed AMIs only] Specifies whether to exclude // volumes that have specific tags. ExcludeTags []Tag - // [Default policies for EBS snapshots only] Specifies the volume types to + // [Default policies for EBS snapshots only] Specifies the volume types to // exclude. Volumes of the specified types will not be targeted by the policy. ExcludeVolumeTypes []string noSmithyDocumentSerde } -// [Custom snapshot policies only] Specifies a rule for enabling fast snapshot +// [Custom 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 { @@ -343,7 +376,8 @@ type FastRestoreRule struct { noSmithyDocumentSerde } -// [Custom policies only] Detailed information about a snapshot, AMI, or +// [Custom policies only] Detailed information about a snapshot, AMI, or +// // event-based lifecycle policy. type LifecyclePolicy struct { @@ -353,8 +387,10 @@ type LifecyclePolicy struct { // The local date and time when the lifecycle policy was last modified. DateModified *time.Time - // [Default policies only] The type of default policy. Values include: + // [Default policies only] The type of default policy. Values include: + // // - VOLUME - Default policy for EBS snapshots + // // - INSTANCE - Default policy for EBS-backed AMIs DefaultPolicy *bool @@ -389,8 +425,10 @@ type LifecyclePolicy struct { // Summary information about a lifecycle policy. type LifecyclePolicySummary struct { - // [Default policies only] The type of default policy. Values include: + // [Default policies only] The type of default policy. Values include: + // // - VOLUME - Default policy for EBS snapshots + // // - INSTANCE - Default policy for EBS-backed AMIs DefaultPolicy *bool @@ -416,32 +454,36 @@ type LifecyclePolicySummary struct { noSmithyDocumentSerde } -// [Custom snapshot and AMI policies only] Specifies optional parameters for +// [Custom snapshot and AMI policies only] Specifies optional parameters for +// // snapshot and AMI policies. The set of valid parameters depends on the -// combination of policy type and target resource type. If you choose to exclude -// boot volumes and you specify tags that consequently exclude all of the -// additional data volumes 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) -// . +// combination of policy type and target resource type. +// +// If you choose to exclude boot volumes and you specify tags that consequently +// exclude all of the additional data volumes 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]. +// +// [Monitor your policies using Amazon CloudWatch]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html type Parameters struct { - // [Custom snapshot policies that target instances only] Indicates whether to + // [Custom 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 excluded from the multi-volume snapshot sets created by the policy. ExcludeBootVolume *bool - // [Custom snapshot policies that target instances only] The tags used to identify - // data (non-root) volumes to exclude from multi-volume snapshot sets. If you - // create a snapshot lifecycle policy that targets instances and you specify tags - // for this parameter, then data volumes with the specified tags that are attached - // to targeted instances will be excluded from the multi-volume snapshot sets - // created by the policy. + // [Custom snapshot policies that target instances only] The tags used to + // identify data (non-root) volumes to exclude from multi-volume snapshot sets. + // + // If you create a snapshot lifecycle policy that targets instances and you + // specify tags for this parameter, then data volumes with the specified tags that + // are attached to targeted instances will be excluded from the multi-volume + // snapshot sets created by the policy. ExcludeDataVolumeTags []Tag - // [Custom AMI policies only] Indicates whether targeted instances are rebooted + // [Custom AMI policies only] Indicates whether targeted instances are rebooted // when the lifecycle policy runs. true indicates that targeted instances are not // rebooted when the policy runs. false indicates that target instances are // rebooted when the policy runs. The default is true (instances are not rebooted). @@ -453,141 +495,177 @@ type Parameters struct { // Specifies the configuration of a lifecycle policy. type PolicyDetails struct { - // [Event-based policies only] The actions to be performed when the event-based + // [Event-based policies only] The actions to be performed when the event-based // policy is activated. You can specify only one action per policy. Actions []Action - // [Default policies only] Indicates whether the policy should copy tags from the + // [Default policies only] Indicates whether the policy should copy tags from the // source resource to the snapshot or AMI. If you do not specify a value, the - // default is false . Default: false + // default is false . + // + // Default: false CopyTags *bool - // [Default policies only] Specifies how often the policy should run and create + // [Default policies only] Specifies how often the policy should run and create // snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do - // not specify a value, the default is 1. Default: 1 + // not specify a value, the default is 1. + // + // Default: 1 CreateInterval *int32 - // [Default policies only] Specifies destination Regions for snapshot or AMI + // [Default policies only] Specifies destination Regions for snapshot or AMI // copies. You can specify up to 3 destination Regions. If you do not want to // create cross-Region copies, omit this parameter. CrossRegionCopyTargets []CrossRegionCopyTarget - // [Event-based policies only] The event that activates the event-based policy. + // [Event-based policies only] The event that activates the event-based policy. EventSource *EventSource - // [Default policies only] Specifies exclusion parameters for volumes or instances - // for which you do not want to create snapshots or AMIs. The policy will not - // create snapshots or AMIs for target resources that match any of the specified - // exclusion parameters. + // [Default policies only] Specifies exclusion parameters for volumes or + // instances for which you do not want to create snapshots or AMIs. The policy will + // not create snapshots or AMIs for target resources that match any of the + // specified exclusion parameters. Exclusions *Exclusions - // [Default policies only] Defines the snapshot or AMI retention behavior for the + // [Default policies only] Defines the snapshot or AMI retention behavior for the // policy if the source volume or instance is deleted, or if the policy enters the - // error, disabled, or deleted state. By default (ExtendDeletion=false): + // error, disabled, or deleted state. + // + // By default (ExtendDeletion=false): + // // - If a source resource is deleted, Amazon Data Lifecycle Manager will // continue to delete previously created snapshots or AMIs, up to but not including // the last one, based on the specified retention period. If you want Amazon Data // Lifecycle Manager to delete all snapshots or AMIs, including the last one, // specify true . + // // - If a policy enters the error, disabled, or deleted state, Amazon Data // Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data // Lifecycle Manager to continue deleting snapshots or AMIs, including the last // one, if the policy enters one of these states, specify true . + // // If you enable extended deletion (ExtendDeletion=true), you override both - // default behaviors simultaneously. If you do not specify a value, the default is - // false . Default: false + // default behaviors simultaneously. + // + // If you do not specify a value, the default is false . + // + // Default: false ExtendDeletion *bool - // [Custom snapshot and AMI policies only] A set of optional parameters for - // snapshot and AMI lifecycle policies. If you are modifying a policy that was - // created or previously modified using the Amazon Data Lifecycle Manager console, - // then you must include this parameter and specify either the default values or - // the new values that you require. You can't omit this parameter or set its values - // to null. + // [Custom snapshot and AMI policies only] A set of optional parameters for + // snapshot and AMI lifecycle policies. + // + // If you are modifying a policy that was created or previously modified using the + // Amazon Data Lifecycle Manager console, then you must include this parameter and + // specify either the default values or the new values that you require. You can't + // omit this parameter or set its values to null. Parameters *Parameters // The type of policy to create. Specify one of the following: + // // - SIMPLIFIED To create a default policy. + // // - STANDARD To create a custom policy. PolicyLanguage PolicyLanguageValues - // [Custom policies only] The valid target resource types and actions a policy can - // manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that + // [Custom policies only] The valid target resource types and actions a policy + // can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that // manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to // 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 . + // actions when a defined event occurs in your Amazon Web Services account. + // + // The default is EBS_SNAPSHOT_MANAGEMENT . PolicyType PolicyTypeValues - // [Custom snapshot and AMI policies only] The location of the resources to + // [Custom 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. + // 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 - // [Default policies only] Specify the type of default policy to create. + // [Default policies only] Specify the type of default policy to create. + // // - To create a default policy for EBS snapshots, that creates snapshots of all // volumes in the Region that do not have recent backups, specify VOLUME . + // // - To create a default policy for EBS-backed AMIs, that creates EBS-backed // AMIs from all instances in the Region that do not have recent backups, specify // INSTANCE . ResourceType ResourceTypeValues - // [Custom snapshot policies only] The target resource type for snapshot and AMI + // [Custom 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 - // [Default policies only] Specifies how long the policy should retain snapshots + // [Default policies only] Specifies how long the policy should retain snapshots // or AMIs before deleting them. The retention period can range from 2 to 14 days, // but it must be greater than the creation frequency to ensure that the policy // retains at least 1 snapshot or AMI at any given time. If you do not specify a - // value, the default is 7. Default: 7 + // value, the default is 7. + // + // Default: 7 RetainInterval *int32 - // [Custom snapshot and AMI policies only] The schedules of policy-defined actions - // for snapshot and AMI lifecycle policies. A policy can have up to four + // [Custom snapshot and AMI policies only] The schedules of policy-defined + // actions for snapshot and AMI lifecycle policies. A policy can have up to four // schedules—one mandatory schedule and up to three optional schedules. Schedules []Schedule - // [Custom snapshot and AMI policies only] The single tag that identifies targeted - // resources for this policy. + // [Custom snapshot and AMI policies only] The single tag that identifies + // targeted resources for this policy. TargetTags []Tag noSmithyDocumentSerde } -// [Custom 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 (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) -// , 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 (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) -// for the schedule, then you can specify a retention count of 0 to archive -// snapshots immediately after creation. If you specify a FastRestoreRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html) -// , ShareRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html) -// , or a CrossRegionCopyRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html) -// , 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 (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) -// for the schedule, then you can specify a retention interval of 0 days to -// archive snapshots immediately after creation. If you specify a FastRestoreRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html) -// , ShareRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html) -// , or a CrossRegionCopyRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html) -// , then you must specify a retention interval of 1 day or more. +// [Custom 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 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. +// +// [ArchiveRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html +// +// [CrossRegionCopyRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html +// [FastRestoreRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html +// [ShareRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html 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 // fourth snapshot is created, the oldest retained snapshot is deleted, or it is - // moved to the archive tier if you have specified an ArchiveRule (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) - // . + // moved to the archive tier if you have specified an [ArchiveRule]. + // + // [ArchiveRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html Count *int32 // The amount of time to retain each snapshot. The maximum is 100 years. This is @@ -597,21 +675,28 @@ type RetainRule struct { // 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 (https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html) - // . + // you have specified an [ArchiveRule]. + // + // [ArchiveRule]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html IntervalUnit RetentionIntervalUnitValues noSmithyDocumentSerde } -// [Custom snapshot policies only] Describes the retention rule for archived +// [Custom snapshot policies only] Describes the retention rule for archived +// // snapshots. Once the archive retention threshold is met, the snapshots are -// permanently deleted from the archive tier. The archive retention rule must -// retain snapshots 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) -// . +// permanently deleted from the archive tier. +// +// The archive retention rule must retain snapshots 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]. +// +// [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 @@ -633,18 +718,20 @@ type RetentionArchiveTier struct { noSmithyDocumentSerde } -// [Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or +// [Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or +// // AMI lifecycle policy. type Schedule struct { - // [Custom snapshot policies that target volumes only] The snapshot archiving rule - // for the schedule. When you specify an archiving rule, snapshots are + // [Custom 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) - // . + // archive tier for the archive retention period that you specify. + // + // For more information about using snapshot archiving, see [Considerations for snapshot lifecycle policies]. + // + // [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 @@ -654,16 +741,17 @@ type Schedule struct { // 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 + // 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 - // [Custom AMI policies only] The AMI deprecation rule for the schedule. + // [Custom AMI policies only] The AMI deprecation rule for the schedule. DeprecateRule *DeprecateRule - // [Custom snapshot policies only] The rule for enabling fast snapshot restore. + // [Custom snapshot policies only] The rule for enabling fast snapshot restore. FastRestoreRule *FastRestoreRule // The name of the schedule. @@ -672,7 +760,7 @@ type Schedule struct { // The retention rule for snapshots or AMIs created by the policy. RetainRule *RetainRule - // [Custom snapshot policies only] The rule for sharing snapshots with other + // [Custom snapshot policies only] The rule for sharing snapshots with other // Amazon Web Services accounts. ShareRules []ShareRule @@ -680,29 +768,33 @@ type Schedule struct { // addition to the Amazon Web Services-added lifecycle tags. TagsToAdd []Tag - // [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 - // for EBS Snapshot Management – Instance policies. + // [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 for EBS Snapshot Management – Instance policies. VariableTags []Tag noSmithyDocumentSerde } -// [Custom snapshot policies that target instances only] Information about pre +// [Custom snapshot policies that target instances only] Information about pre +// // and/or post scripts for a snapshot lifecycle policy that targets instances. For -// more information, see Automating application-consistent snapshots with pre and -// post scripts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html) -// . +// more information, see [Automating application-consistent snapshots with pre and post scripts]. +// +// [Automating application-consistent snapshots with pre and post scripts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html type Script struct { // The SSM document that includes the pre and/or post scripts to run. + // // - If you are automating VSS backups, specify AWS_VSS_BACKUP . In this case, // Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot // SSM document. + // // - If you are automating application-consistent snapshots for SAP HANA // workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA . + // // - If you are using a custom SSM document that you own, specify either the // name or ARN of the SSM document. If you are using a custom SSM document that is // shared with you, specify the ARN of the SSM document. @@ -712,61 +804,84 @@ type Script struct { // Indicates whether Amazon Data Lifecycle Manager should default to // crash-consistent snapshots if the pre script fails. + // // - To default to crash consistent snapshot if the pre script fails, specify // true . + // // - To skip the instance for snapshot creation if the pre script fails, specify // false . + // // This parameter is supported only if you run a pre script. If you run a post - // script only, omit this parameter. Default: true + // script only, omit this parameter. + // + // Default: true ExecuteOperationOnScriptFailure *bool // Indicates the service used to execute the pre and/or post scripts. + // // - If you are using custom SSM documents or automating application-consistent // snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER . + // // - If you are automating VSS Backups, omit this parameter. + // // Default: AWS_SYSTEMS_MANAGER ExecutionHandlerService ExecutionHandlerServiceValues // Specifies a timeout period, in seconds, after which Amazon Data Lifecycle // Manager fails the script run attempt if it has not completed. If a script does // not complete within its timeout period, Amazon Data Lifecycle Manager fails the - // attempt. The timeout period applies to the pre and post scripts individually. If - // you are automating VSS Backups, omit this parameter. Default: 10 + // attempt. The timeout period applies to the pre and post scripts individually. + // + // If you are automating VSS Backups, omit this parameter. + // + // Default: 10 ExecutionTimeout *int32 // Specifies the number of times Amazon Data Lifecycle Manager should retry // scripts that fail. + // // - If the pre script fails, Amazon Data Lifecycle Manager retries the entire // snapshot creation process, including running the pre and post scripts. + // // - If the post script fails, Amazon Data Lifecycle Manager retries the post // script only; in this case, the pre script will have completed and the snapshot // might have been created. + // // If you do not want Amazon Data Lifecycle Manager to retry failed scripts, - // specify 0 . Default: 0 + // specify 0 . + // + // Default: 0 MaximumRetryCount *int32 // Indicate which scripts Amazon Data Lifecycle Manager should run on target // instances. Pre scripts run before Amazon Data Lifecycle Manager initiates // snapshot creation. Post scripts run after Amazon Data Lifecycle Manager // initiates snapshot creation. + // // - To run a pre script only, specify PRE . In this case, Amazon Data Lifecycle // Manager calls the SSM document with the pre-script parameter before initiating // snapshot creation. + // // - To run a post script only, specify POST . In this case, Amazon Data // Lifecycle Manager calls the SSM document with the post-script parameter after // initiating snapshot creation. + // // - To run both pre and post scripts, specify both PRE and POST . In this case, // Amazon Data Lifecycle Manager calls the SSM document with the pre-script // parameter before initiating snapshot creation, and then it calls the SSM // document again with the post-script parameter after initiating snapshot // creation. - // If you are automating VSS Backups, omit this parameter. Default: PRE and POST + // + // If you are automating VSS Backups, omit this parameter. + // + // Default: PRE and POST Stages []StageValues noSmithyDocumentSerde } -// [Custom snapshot policies only] Specifies a rule for sharing snapshots across +// [Custom snapshot policies only] Specifies a rule for sharing snapshots across +// // Amazon Web Services accounts. type ShareRule struct { diff --git a/service/docdb/api_op_AddSourceIdentifierToSubscription.go b/service/docdb/api_op_AddSourceIdentifierToSubscription.go index 371301bdcc9..bf9307420a1 100644 --- a/service/docdb/api_op_AddSourceIdentifierToSubscription.go +++ b/service/docdb/api_op_AddSourceIdentifierToSubscription.go @@ -27,15 +27,19 @@ 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. // // This member is required. diff --git a/service/docdb/api_op_AddTagsToResource.go b/service/docdb/api_op_AddTagsToResource.go index 43247b7c0d6..dff59b30a7a 100644 --- a/service/docdb/api_op_AddTagsToResource.go +++ b/service/docdb/api_op_AddTagsToResource.go @@ -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 3d512f2a2ed..eff10c2ca47 100644 --- a/service/docdb/api_op_ApplyPendingMaintenanceAction.go +++ b/service/docdb/api_op_ApplyPendingMaintenanceAction.go @@ -28,20 +28,26 @@ 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 + // The pending maintenance action to apply to this resource. + // + // Valid values: 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: + // 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. // // This member is required. @@ -58,7 +64,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 d346d705226..041b6d1a60d 100644 --- a/service/docdb/api_op_CopyDBClusterParameterGroup.go +++ b/service/docdb/api_op_CopyDBClusterParameterGroup.go @@ -27,15 +27,20 @@ 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: + // 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 . @@ -48,11 +53,18 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. TargetDBClusterParameterGroupDescription *string - // The identifier for the copied cluster parameter group. Constraints: + // 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. + // // 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 9c6c6358212..ffbc6bd7e4f 100644 --- a/service/docdb/api_op_CopyDBClusterSnapshot.go +++ b/service/docdb/api_op_CopyDBClusterSnapshot.go @@ -13,11 +13,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual -// cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource -// Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster -// snapshot, whether encrypted or not, in the same Amazon Web Services Region. To -// cancel the copy operation after it is in progress, delete the target cluster +// Copies a snapshot of a cluster. +// +// To copy a cluster snapshot from a shared manual cluster snapshot, +// SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the +// shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether +// encrypted or not, in the same Amazon Web Services Region. +// +// To cancel the copy operation after it is in progress, delete the target cluster // snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster // snapshot is in the copying status. func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error) { @@ -35,26 +38,38 @@ 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: + // 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. + // // Example: my-cluster-snapshot1 // // This member is required. SourceDBClusterSnapshotIdentifier *string // The identifier of the new cluster snapshot to create from the source cluster - // snapshot. This parameter is not case sensitive. Constraints: + // 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. + // // Example: my-cluster-snapshot2 // // This member is required. @@ -66,34 +81,46 @@ type CopyDBClusterSnapshotInput struct { // 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 - // 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, + // 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 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 // 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 - // Services Region. If you copy an unencrypted cluster snapshot and specify a value - // for the KmsKeyId parameter, an error is returned. + // Services Region. + // + // If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId + // parameter, an error is returned. KmsKeyId *string // 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 + // 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: + // 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 @@ -101,6 +128,7 @@ type CopyDBClusterSnapshotInput struct { // 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 diff --git a/service/docdb/api_op_CreateDBCluster.go b/service/docdb/api_op_CreateDBCluster.go index 8eb1fb80787..7bc4df15943 100644 --- a/service/docdb/api_op_CreateDBCluster.go +++ b/service/docdb/api_op_CreateDBCluster.go @@ -29,20 +29,27 @@ 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. + // // Example: my-cluster // // This member is required. DBClusterIdentifier *string - // The name of the database engine to be used for this cluster. Valid values: docdb + // The name of the database engine to be used for this cluster. + // + // Valid values: docdb // // This member is required. Engine *string @@ -52,15 +59,24 @@ type CreateDBClusterInput struct { AvailabilityZones []string // The number of days for which automated backups are retained. You must specify a - // minimum value of 1. Default: 1 Constraints: + // minimum value of 1. + // + // Default: 1 + // + // Constraints: + // // - 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 + // A subnet group to associate with this cluster. + // + // Constraints: Must match the name of an existing DBSubnetGroup . Must not be + // default. + // + // Example: mySubnetgroup DBSubnetGroupName *string // Specifies whether this cluster can be deleted. If DeletionProtection is @@ -70,10 +86,11 @@ type CreateDBClusterInput struct { 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) + // Logs. You can enable audit logs or profiler logs. For more information, see [Auditing Amazon DocumentDB Events]and [Profiling Amazon DocumentDB Operations] // . + // + // [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 EnableCloudwatchLogsExports []string // The version number of the database engine to use. The --engine-version will @@ -85,14 +102,18 @@ type CreateDBClusterInput struct { // The cluster identifier of the new global cluster. GlobalClusterIdentifier *string - // The KMS key identifier for an encrypted 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 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 : + // The KMS key identifier for an encrypted 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 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. @@ -100,12 +121,19 @@ type CreateDBClusterInput struct { // The password for the master database user. 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. + // "at" symbol (@). + // + // Constraints: Must contain from 8 to 100 characters. MasterUserPassword *string - // The name of the master user for the cluster. Constraints: + // 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. MasterUsername *string @@ -116,20 +144,33 @@ type CreateDBClusterInput struct { PreSignedUrl *string // 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: + // 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 - // 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. + // 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 // The AWS region the resource is in. The presigned URL will be created with this @@ -139,12 +180,18 @@ type CreateDBClusterInput struct { // Specifies whether the cluster is encrypted. StorageEncrypted *bool - // The storage type to associate with the DB cluster. For information on storage - // types for Amazon DocumentDB clusters, see Cluster storage configurations in the - // Amazon DocumentDB Developer Guide. Valid values for storage type - standard | - // iopt1 Default value is standard When you create a DocumentDB DB cluster with - // the storage type set to iopt1 , the storage type is returned in the response. - // The storage type isn't returned when you set it to standard . + // The storage type to associate with the DB cluster. + // + // For information on storage types for Amazon DocumentDB clusters, see Cluster + // storage configurations in the Amazon DocumentDB Developer Guide. + // + // Valid values for storage type - standard | iopt1 + // + // Default value is standard + // + // When you create a DocumentDB DB cluster with the storage type set to iopt1 , the + // storage type is returned in the response. The storage type isn't returned when + // you set it to standard . StorageType *string // The tags to be assigned to the cluster. diff --git a/service/docdb/api_op_CreateDBClusterParameterGroup.go b/service/docdb/api_op_CreateDBClusterParameterGroup.go index 2fbb08185b7..b304909125a 100644 --- a/service/docdb/api_op_CreateDBClusterParameterGroup.go +++ b/service/docdb/api_op_CreateDBClusterParameterGroup.go @@ -11,19 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new cluster parameter group. Parameters in a cluster parameter group -// apply to all of the instances in a cluster. A cluster parameter group is -// initially created with the default parameters for the database engine used by -// 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 -// 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) -// . +// Creates a new cluster parameter group. +// +// Parameters in a cluster parameter group apply to all of the instances in a +// cluster. +// +// A cluster parameter group is initially created with the default parameters for +// the database engine used by 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]or [copy an existing parameter group], 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]. +// +// [create a new parameter group]: https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html +// [Modifying Amazon DocumentDB Cluster Parameter Groups]: https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html +// [copy an existing parameter group]: https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error) { if params == nil { params = &CreateDBClusterParameterGroupInput{} @@ -39,11 +43,15 @@ 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: + // 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. // // This member is required. diff --git a/service/docdb/api_op_CreateDBClusterSnapshot.go b/service/docdb/api_op_CreateDBClusterSnapshot.go index 0bc5c1aa744..02f379a094b 100644 --- a/service/docdb/api_op_CreateDBClusterSnapshot.go +++ b/service/docdb/api_op_CreateDBClusterSnapshot.go @@ -27,22 +27,32 @@ 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: + // case sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DBCluster . + // // Example: my-cluster // // This member is required. DBClusterIdentifier *string // The identifier of the cluster snapshot. This parameter is stored as a lowercase - // string. Constraints: + // 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-cluster-snapshot1 // // This member is required. diff --git a/service/docdb/api_op_CreateDBInstance.go b/service/docdb/api_op_CreateDBInstance.go index 52663ff47e1..d4fa3c7b8ef 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. @@ -41,33 +41,47 @@ type CreateDBInstanceInput struct { 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. + // // Example: mydbinstance // // This member is required. DBInstanceIdentifier *string - // The name of the database engine to be used for this instance. Valid value: docdb + // The name of the database engine to be used for this instance. + // + // Valid value: docdb // // This member is required. Engine *string // This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not - // perform minor version upgrades regardless of the value set. Default: false + // perform minor version upgrades regardless of the value set. + // + // Default: false AutoMinorVersionUpgrade *bool - // The Amazon EC2 Availability Zone that the instance is created in. Default: A - // random, system-chosen Availability Zone in the endpoint's Amazon Web Services - // Region. Example: us-east-1d + // The Amazon EC2 Availability Zone that the instance is created in. + // + // Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web + // Services Region. + // + // Example: us-east-1d AvailabilityZone *string // The CA certificate identifier to use for the DB instance's server certificate. - // For more information, see Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) - // and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) - // in the Amazon DocumentDB Developer Guide. + // + // For more information, see [Updating Your Amazon DocumentDB TLS Certificates] and [Encrypting Data in Transit] in the Amazon DocumentDB Developer Guide. + // + // [Updating Your Amazon DocumentDB TLS Certificates]: https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html + // [Encrypting Data in Transit]: https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html CACertificateIdentifier *string // A value that indicates whether to copy tags from the DB instance to snapshots @@ -75,28 +89,42 @@ type CreateDBInstanceInput struct { 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]. + // + // [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 - // 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 + // The KMS key identifier for encryption of Performance Insights data. + // + // The 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 // DocumentDB 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 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. + // 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 // promoted to the primary instance after a failure of the existing primary - // instance. Default: 1 Valid values: 0-15 + // instance. + // + // Default: 1 + // + // Valid values: 0-15 PromotionTier *int32 // The tags to be assigned to the instance. You can assign up to 10 tags to an diff --git a/service/docdb/api_op_CreateDBSubnetGroup.go b/service/docdb/api_op_CreateDBSubnetGroup.go index 1758db4c224..cabbdbbf02e 100644 --- a/service/docdb/api_op_CreateDBSubnetGroup.go +++ b/service/docdb/api_op_CreateDBSubnetGroup.go @@ -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. @@ -37,8 +37,11 @@ type CreateDBSubnetGroupInput struct { DBSubnetGroupDescription *string // The name for the 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. Example: mySubnetgroup + // underscores, spaces, or hyphens. Must not be default. + // + // Example: mySubnetgroup // // This member is required. DBSubnetGroupName *string diff --git a/service/docdb/api_op_CreateEventSubscription.go b/service/docdb/api_op_CreateEventSubscription.go index 9d3602f1f8a..ba97a7a52ff 100644 --- a/service/docdb/api_op_CreateEventSubscription.go +++ b/service/docdb/api_op_CreateEventSubscription.go @@ -15,13 +15,16 @@ import ( // requires a topic Amazon Resource Name (ARN) created by using the Amazon // 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 , -// SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, -// Backup . If you specify both the SourceType and SourceIds (such as SourceType = +// 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 , 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 // 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 @@ -43,7 +46,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. @@ -52,37 +55,46 @@ type CreateEventSubscriptionInput struct { // This member is required. SnsTopicArn *string - // The name of the subscription. Constraints: The name must be fewer than 255 - // characters. + // The name of the subscription. + // + // Constraints: The name must be fewer than 255 characters. // // This member is required. SubscriptionName *string - // A Boolean value; set to true to activate the subscription, set to false to + // A Boolean value; set to true to activate the subscription, set to false to // create the subscription but not active it. Enabled *bool - // A list of event categories for a SourceType that you want to subscribe to. + // A list of event categories for a SourceType that you want to subscribe to. 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: + // 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. 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 , - // db-cluster-snapshot + // 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 // The tags to be assigned to the event subscription. diff --git a/service/docdb/api_op_CreateGlobalCluster.go b/service/docdb/api_op_CreateGlobalCluster.go index c75fca3f1a8..e0b8e0921ec 100644 --- a/service/docdb/api_op_CreateGlobalCluster.go +++ b/service/docdb/api_op_CreateGlobalCluster.go @@ -16,10 +16,13 @@ import ( // with read-write capability, and up-to give read-only secondary clusters. Global // clusters uses storage-based fast replication across regions with latencies less // than one second, using dedicated infrastructure with no impact to your -// workload’s performance. You can create a global cluster that is initially empty, -// and then add a primary and a secondary to it. Or you can specify an existing -// cluster during the create operation, and this cluster becomes the primary of the -// global cluster. This action only applies to Amazon DocumentDB clusters. +// workload’s performance. +// +// You can create a global cluster that is initially empty, and then add a primary +// and a secondary to it. Or you can specify an existing cluster during the create +// operation, and this cluster becomes the primary of the global cluster. +// +// This action only applies to Amazon DocumentDB clusters. func (c *Client) CreateGlobalCluster(ctx context.Context, params *CreateGlobalClusterInput, optFns ...func(*Options)) (*CreateGlobalClusterOutput, error) { if params == nil { params = &CreateGlobalClusterInput{} @@ -35,7 +38,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 36d8bf3f932..d953f4deb59 100644 --- a/service/docdb/api_op_DeleteDBCluster.go +++ b/service/docdb/api_op_DeleteDBCluster.go @@ -29,29 +29,42 @@ 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: + // sensitive. + // + // Constraints: + // // - 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 - // the SkipFinalShapshot parameter to true results in an error. Constraints: + // The cluster snapshot identifier of the new cluster snapshot 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 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 + // 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 - // parameter. Default: false + // specified, a cluster snapshot is created before the DB cluster is deleted. + // + // If SkipFinalSnapshot is false , you must specify a FinalDBSnapshotIdentifier + // parameter. + // + // Default: false SkipFinalSnapshot *bool noSmithyDocumentSerde diff --git a/service/docdb/api_op_DeleteDBClusterParameterGroup.go b/service/docdb/api_op_DeleteDBClusterParameterGroup.go index 3ea64456238..d417d60ae7f 100644 --- a/service/docdb/api_op_DeleteDBClusterParameterGroup.go +++ b/service/docdb/api_op_DeleteDBClusterParameterGroup.go @@ -27,12 +27,17 @@ 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: + // 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. // // This member is required. diff --git a/service/docdb/api_op_DeleteDBClusterSnapshot.go b/service/docdb/api_op_DeleteDBClusterSnapshot.go index b119733a9d4..1736aaff21e 100644 --- a/service/docdb/api_op_DeleteDBClusterSnapshot.go +++ b/service/docdb/api_op_DeleteDBClusterSnapshot.go @@ -12,8 +12,9 @@ import ( ) // Deletes a cluster snapshot. If the snapshot is being copied, the copy operation -// is terminated. The cluster snapshot must be in the available state to be -// deleted. +// is terminated. +// +// The cluster snapshot must be in the available state to be deleted. func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBClusterSnapshotInput, optFns ...func(*Options)) (*DeleteDBClusterSnapshotOutput, error) { if params == nil { params = &DeleteDBClusterSnapshotInput{} @@ -29,11 +30,13 @@ 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 - // of an existing cluster snapshot in the available state. + // The identifier of the cluster snapshot to delete. + // + // Constraints: Must be the name of an existing cluster snapshot in the available + // state. // // This member is required. DBClusterSnapshotIdentifier *string diff --git a/service/docdb/api_op_DeleteDBInstance.go b/service/docdb/api_op_DeleteDBInstance.go index e58c789d319..9babc6cf342 100644 --- a/service/docdb/api_op_DeleteDBInstance.go +++ b/service/docdb/api_op_DeleteDBInstance.go @@ -27,11 +27,14 @@ 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: + // case sensitive. + // + // Constraints: + // // - Must match the name of an existing instance. // // This member is required. diff --git a/service/docdb/api_op_DeleteDBSubnetGroup.go b/service/docdb/api_op_DeleteDBSubnetGroup.go index a0abecb859c..bfefb7e5e3f 100644 --- a/service/docdb/api_op_DeleteDBSubnetGroup.go +++ b/service/docdb/api_op_DeleteDBSubnetGroup.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a subnet group. The specified database subnet group must not be -// associated with any DB instances. +// Deletes a subnet group. +// +// The specified database subnet group must not be associated with any DB +// instances. func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnetGroupInput, optFns ...func(*Options)) (*DeleteDBSubnetGroupOutput, error) { if params == nil { params = &DeleteDBSubnetGroupInput{} @@ -27,12 +29,18 @@ 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 . - // Must not be default. Example: mySubnetgroup + // 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 . Must not be default. + // + // Example: mySubnetgroup // // This member is required. DBSubnetGroupName *string diff --git a/service/docdb/api_op_DeleteEventSubscription.go b/service/docdb/api_op_DeleteEventSubscription.go index d5ee2dec044..7845a193f7f 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 cfded5a1378..5731ac1119e 100644 --- a/service/docdb/api_op_DeleteGlobalCluster.go +++ b/service/docdb/api_op_DeleteGlobalCluster.go @@ -12,8 +12,9 @@ import ( ) // Deletes a global cluster. The primary and secondary clusters must already be -// detached or deleted before attempting to delete a global cluster. This action -// only applies to Amazon DocumentDB clusters. +// detached or deleted before attempting to delete a global cluster. +// +// This action only applies to Amazon DocumentDB clusters. func (c *Client) DeleteGlobalCluster(ctx context.Context, params *DeleteGlobalClusterInput, optFns ...func(*Options)) (*DeleteGlobalClusterOutput, error) { if params == nil { params = &DeleteGlobalClusterInput{} @@ -29,7 +30,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 ebcaf7a4a46..85c9f940e32 100644 --- a/service/docdb/api_op_DescribeCertificates.go +++ b/service/docdb/api_op_DescribeCertificates.go @@ -33,7 +33,10 @@ type DescribeCertificatesInput struct { // The user-supplied certificate identifier. If this parameter is specified, // 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 + // not case sensitive. + // + // Constraints + // // - Must match an existing CertificateIdentifier . CertificateIdentifier *string @@ -48,8 +51,13 @@ type DescribeCertificatesInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: + // + // Default: 100 + // + // Constraints: + // // - Minimum: 20 + // // - Maximum: 100 MaxRecords *int32 @@ -166,8 +174,13 @@ type DescribeCertificatesPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: + // + // Default: 100 + // + // Constraints: + // // - Minimum: 20 + // // - Maximum: 100 Limit int32 diff --git a/service/docdb/api_op_DescribeDBClusterParameterGroups.go b/service/docdb/api_op_DescribeDBClusterParameterGroups.go index 6dccb5d9cf8..c89770227bb 100644 --- a/service/docdb/api_op_DescribeDBClusterParameterGroups.go +++ b/service/docdb/api_op_DescribeDBClusterParameterGroups.go @@ -29,11 +29,13 @@ 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 . DBClusterParameterGroupName *string @@ -45,16 +47,19 @@ type DescribeDBClusterParameterGroupsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde } -// Represents the output of DBClusterParameterGroups . +// Represents the output of DBClusterParameterGroups. type DescribeDBClusterParameterGroupsOutput struct { // A list of cluster parameter groups. @@ -161,9 +166,12 @@ var _ DescribeDBClusterParameterGroupsAPIClient = (*Client)(nil) // DescribeDBClusterParameterGroupsPaginatorOptions is the paginator options for // DescribeDBClusterParameterGroups type DescribeDBClusterParameterGroupsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeDBClusterParameters.go b/service/docdb/api_op_DescribeDBClusterParameters.go index b60a2307c3e..6506625ce33 100644 --- a/service/docdb/api_op_DescribeDBClusterParameters.go +++ b/service/docdb/api_op_DescribeDBClusterParameters.go @@ -27,11 +27,13 @@ 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 . // // This member is required. @@ -45,20 +47,23 @@ type DescribeDBClusterParametersInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // A value that indicates to return only parameters for a specific source. + // A value that indicates to return only parameters for a specific source. // 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 @@ -165,9 +170,12 @@ var _ DescribeDBClusterParametersAPIClient = (*Client)(nil) // DescribeDBClusterParametersPaginatorOptions is the paginator options for // DescribeDBClusterParameters type DescribeDBClusterParametersPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go b/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go index 627386fec31..85b1df7e31e 100644 --- a/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go +++ b/service/docdb/api_op_DescribeDBClusterSnapshotAttributes.go @@ -12,12 +12,14 @@ import ( ) // Returns a list of cluster snapshot attribute names and values for a manual DB -// 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. +// 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. func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotAttributesOutput, error) { if params == nil { params = &DescribeDBClusterSnapshotAttributesInput{} @@ -33,7 +35,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 03fcebe92f2..2dcb0c03ff1 100644 --- a/service/docdb/api_op_DescribeDBClusterSnapshots.go +++ b/service/docdb/api_op_DescribeDBClusterSnapshots.go @@ -28,19 +28,26 @@ 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: + // parameter is not case sensitive. + // + // Constraints: + // // - 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: + // 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 @@ -63,35 +70,45 @@ type DescribeDBClusterSnapshotsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // 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 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 . + // 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. @@ -198,9 +215,12 @@ var _ DescribeDBClusterSnapshotsAPIClient = (*Client)(nil) // DescribeDBClusterSnapshotsPaginatorOptions is the paginator options for // DescribeDBClusterSnapshots type DescribeDBClusterSnapshotsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeDBClusters.go b/service/docdb/api_op_DescribeDBClusters.go index 2a72e0cd5a6..c01edc51fab 100644 --- a/service/docdb/api_op_DescribeDBClusters.go +++ b/service/docdb/api_op_DescribeDBClusters.go @@ -32,16 +32,22 @@ 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: + // case sensitive. + // + // Constraints: + // // - If provided, must match an existing DBClusterIdentifier . DBClusterIdentifier *string - // A filter that specifies one or more clusters to describe. Supported filters: + // 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. @@ -52,16 +58,19 @@ type DescribeDBClustersInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde } -// Represents the output of DescribeDBClusters . +// Represents the output of DescribeDBClusters. type DescribeDBClustersOutput struct { // A list of clusters. @@ -168,9 +177,12 @@ var _ DescribeDBClustersAPIClient = (*Client)(nil) // DescribeDBClustersPaginatorOptions is the paginator options for // DescribeDBClusters type DescribeDBClustersPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeDBEngineVersions.go b/service/docdb/api_op_DescribeDBEngineVersions.go index f5770c87a0a..098a33680dd 100644 --- a/service/docdb/api_op_DescribeDBEngineVersions.go +++ b/service/docdb/api_op_DescribeDBEngineVersions.go @@ -27,11 +27,13 @@ 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 . DBParameterGroupFamily *string @@ -42,7 +44,9 @@ type DescribeDBEngineVersionsInput struct { // The database engine to return. Engine *string - // The database engine version to return. Example: 3.6.0 + // The database engine version to return. + // + // Example: 3.6.0 EngineVersion *string // This parameter is not currently supported. @@ -63,16 +67,19 @@ type DescribeDBEngineVersionsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde } -// Represents the output of DescribeDBEngineVersions . +// Represents the output of DescribeDBEngineVersions. type DescribeDBEngineVersionsOutput struct { // Detailed information about one or more engine versions. @@ -179,9 +186,12 @@ var _ DescribeDBEngineVersionsAPIClient = (*Client)(nil) // DescribeDBEngineVersionsPaginatorOptions is the paginator options for // DescribeDBEngineVersions type DescribeDBEngineVersionsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeDBInstances.go b/service/docdb/api_op_DescribeDBInstances.go index 1a78e34dfff..e9d5fafcc02 100644 --- a/service/docdb/api_op_DescribeDBInstances.go +++ b/service/docdb/api_op_DescribeDBInstances.go @@ -34,19 +34,26 @@ 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: + // case sensitive. + // + // Constraints: + // // - If provided, must match the identifier of an existing DBInstance . DBInstanceIdentifier *string - // A filter that specifies one or more instances to describe. Supported filters: + // 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. @@ -57,16 +64,19 @@ type DescribeDBInstancesInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde } -// Represents the output of DescribeDBInstances . +// Represents the output of DescribeDBInstances. type DescribeDBInstancesOutput struct { // Detailed information about one or more instances. @@ -173,9 +183,12 @@ var _ DescribeDBInstancesAPIClient = (*Client)(nil) // DescribeDBInstancesPaginatorOptions is the paginator options for // DescribeDBInstances type DescribeDBInstancesPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 @@ -290,12 +303,13 @@ type DBInstanceAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) } @@ -597,12 +611,13 @@ type DBInstanceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) } diff --git a/service/docdb/api_op_DescribeDBSubnetGroups.go b/service/docdb/api_op_DescribeDBSubnetGroups.go index 378e678a024..a07fa3c3040 100644 --- a/service/docdb/api_op_DescribeDBSubnetGroups.go +++ b/service/docdb/api_op_DescribeDBSubnetGroups.go @@ -29,7 +29,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. @@ -43,16 +43,19 @@ type DescribeDBSubnetGroupsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde } -// Represents the output of DescribeDBSubnetGroups . +// Represents the output of DescribeDBSubnetGroups. type DescribeDBSubnetGroupsOutput struct { // Detailed information about one or more subnet groups. @@ -159,9 +162,12 @@ var _ DescribeDBSubnetGroupsAPIClient = (*Client)(nil) // DescribeDBSubnetGroupsPaginatorOptions is the paginator options for // DescribeDBSubnetGroups type DescribeDBSubnetGroupsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go b/service/docdb/api_op_DescribeEngineDefaultClusterParameters.go index e709550c29b..9a23e818dc8 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 @@ -45,9 +45,12 @@ type DescribeEngineDefaultClusterParametersInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 diff --git a/service/docdb/api_op_DescribeEventCategories.go b/service/docdb/api_op_DescribeEventCategories.go index 1fa89165e2b..b9dff1ed4e4 100644 --- a/service/docdb/api_op_DescribeEventCategories.go +++ b/service/docdb/api_op_DescribeEventCategories.go @@ -28,20 +28,21 @@ 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 565a6938ac9..3be5f0fe2bc 100644 --- a/service/docdb/api_op_DescribeEventSubscriptions.go +++ b/service/docdb/api_op_DescribeEventSubscriptions.go @@ -13,8 +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. +// 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{} @@ -30,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. @@ -41,9 +42,12 @@ type DescribeEventSubscriptionsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -54,7 +58,7 @@ type DescribeEventSubscriptionsInput struct { noSmithyDocumentSerde } -// Represents the output of DescribeEventSubscriptions . +// Represents the output of DescribeEventSubscriptions. type DescribeEventSubscriptionsOutput struct { // A list of event subscriptions. @@ -161,9 +165,12 @@ var _ DescribeEventSubscriptionsAPIClient = (*Client)(nil) // DescribeEventSubscriptionsPaginatorOptions is the paginator options for // DescribeEventSubscriptions type DescribeEventSubscriptionsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeEvents.go b/service/docdb/api_op_DescribeEvents.go index be200f51184..d38e98dc072 100644 --- a/service/docdb/api_op_DescribeEvents.go +++ b/service/docdb/api_op_DescribeEvents.go @@ -32,14 +32,18 @@ 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 + // 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 @@ -54,21 +58,32 @@ type DescribeEventsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The identifier of the event source for which events are returned. If not - // specified, then all sources are included in the response. Constraints: + // 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. SourceIdentifier *string @@ -76,14 +91,16 @@ type DescribeEventsInput struct { // 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. @@ -189,9 +206,12 @@ var _ DescribeEventsAPIClient = (*Client)(nil) // DescribeEventsPaginatorOptions is the paginator options for DescribeEvents type DescribeEventsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribeGlobalClusters.go b/service/docdb/api_op_DescribeGlobalClusters.go index 0526204ffa5..452c2db9c2e 100644 --- a/service/docdb/api_op_DescribeGlobalClusters.go +++ b/service/docdb/api_op_DescribeGlobalClusters.go @@ -12,7 +12,9 @@ import ( ) // Returns information about Amazon DocumentDB global clusters. This API supports -// pagination. This action only applies to Amazon DocumentDB clusters. +// pagination. +// +// This action only applies to Amazon DocumentDB clusters. func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlobalClustersInput, optFns ...func(*Options)) (*DescribeGlobalClustersOutput, error) { if params == nil { params = &DescribeGlobalClustersInput{} @@ -30,10 +32,11 @@ func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlo type DescribeGlobalClustersInput struct { - // A filter that specifies one or more global DB clusters to describe. Supported - // filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource - // Names (ARNs). The results list will only include information about the clusters - // identified by these ARNs. + // A filter that specifies one or more global DB clusters to describe. + // + // Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon + // Resource Names (ARNs). The results list will only include information about the + // clusters identified by these ARNs. Filters []types.Filter // The user-supplied cluster identifier. If this parameter is specified, diff --git a/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go b/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go index 63b2250591c..bed7745b7a3 100644 --- a/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/docdb/api_op_DescribeOrderableDBInstanceOptions.go @@ -27,7 +27,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. @@ -55,9 +55,12 @@ type DescribeOrderableDBInstanceOptionsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -68,7 +71,7 @@ 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 @@ -175,9 +178,12 @@ var _ DescribeOrderableDBInstanceOptionsAPIClient = (*Client)(nil) // DescribeOrderableDBInstanceOptionsPaginatorOptions is the paginator options for // DescribeOrderableDBInstanceOptions type DescribeOrderableDBInstanceOptionsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_DescribePendingMaintenanceActions.go b/service/docdb/api_op_DescribePendingMaintenanceActions.go index 7fd36f47c66..4dbe0bd270b 100644 --- a/service/docdb/api_op_DescribePendingMaintenanceActions.go +++ b/service/docdb/api_op_DescribePendingMaintenanceActions.go @@ -28,14 +28,18 @@ 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: + // 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. @@ -46,9 +50,12 @@ type DescribePendingMaintenanceActionsInput struct { // 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 (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -58,7 +65,7 @@ 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 @@ -165,9 +172,12 @@ var _ DescribePendingMaintenanceActionsAPIClient = (*Client)(nil) // DescribePendingMaintenanceActionsPaginatorOptions is the paginator options for // DescribePendingMaintenanceActions type DescribePendingMaintenanceActionsPaginatorOptions struct { - // The maximum number of records to include in the response. If more records exist - // than the specified MaxRecords value, a pagination token (marker) is included in - // the response so that the remaining results can be retrieved. Default: 100 + // The maximum number of records to include in the response. If more records + // exist than the specified MaxRecords value, a pagination token (marker) is + // included in the response so that the remaining results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/docdb/api_op_FailoverDBCluster.go b/service/docdb/api_op_FailoverDBCluster.go index f79a7405011..6bddc2af803 100644 --- a/service/docdb/api_op_FailoverDBCluster.go +++ b/service/docdb/api_op_FailoverDBCluster.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Forces a failover for a cluster. A failover for a cluster promotes one of the -// Amazon DocumentDB replicas (read-only instances) in the cluster to be the -// primary instance (the cluster writer). If the primary instance fails, Amazon -// DocumentDB automatically fails over to an Amazon DocumentDB replica, if one -// exists. You can force a failover when you want to simulate a failure of a -// primary instance for testing. +// Forces a failover for a cluster. +// +// A failover for a cluster promotes one of the Amazon DocumentDB replicas +// (read-only instances) in the cluster to be the primary instance (the cluster +// writer). +// +// If the primary instance fails, Amazon DocumentDB automatically fails over to an +// Amazon DocumentDB replica, if one exists. You can force a failover when you want +// to simulate a failure of a primary instance for testing. func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBClusterInput, optFns ...func(*Options)) (*FailoverDBClusterOutput, error) { if params == nil { params = &FailoverDBClusterInput{} @@ -32,17 +35,21 @@ 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: + // sensitive. + // + // Constraints: + // // - 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 . + // 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 . TargetDBInstanceIdentifier *string noSmithyDocumentSerde diff --git a/service/docdb/api_op_ListTagsForResource.go b/service/docdb/api_op_ListTagsForResource.go index 3a8c4b128ed..2f696e8bde7 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 81c795c2b99..7b9ffe8eefc 100644 --- a/service/docdb/api_op_ModifyDBCluster.go +++ b/service/docdb/api_op_ModifyDBCluster.go @@ -29,35 +29,47 @@ 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: + // is not case sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DBCluster . // // This member is required. DBClusterIdentifier *string - // A value that indicates whether major version upgrades are allowed. Constraints: - // You must allow major version upgrades when specifying a value for the - // EngineVersion parameter that is a different major version than the DB cluster's - // current version. + // A value that indicates whether major version upgrades are allowed. + // + // Constraints: You must allow major version upgrades when specifying a value for + // the EngineVersion parameter that is a different major version than the DB + // cluster's current version. AllowMajorVersionUpgrade *bool // 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. + // // 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, - // regardless of the value of the ApplyImmediately parameter. Default: false + // 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: + // minimum value of 1. + // + // Default: 1 + // + // Constraints: + // // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 @@ -78,50 +90,81 @@ type ModifyDBClusterInput struct { // 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 Amazon DocumentDB use the following command: aws - // docdb describe-db-engine-versions --engine docdb --query - // "DBEngineVersions[].EngineVersion" + // next maintenance window unless ApplyImmediately is enabled. + // + // To list all of the available engine versions for Amazon DocumentDB use the + // following command: + // + // aws docdb describe-db-engine-versions --engine docdb --query + // "DBEngineVersions[].EngineVersion" EngineVersion *string // The password for the master database user. 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. + // "at" symbol (@). + // + // Constraints: Must contain from 8 to 100 characters. MasterUserPassword *string // The new cluster identifier for the cluster when renaming a cluster. This value - // is stored as a lowercase string. Constraints: + // 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 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: + // 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 - // 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. + // 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 - // The storage type to associate with the DB cluster. For information on storage - // types for Amazon DocumentDB clusters, see Cluster storage configurations in the - // Amazon DocumentDB Developer Guide. Valid values for storage type - standard | - // iopt1 Default value is standard + // The storage type to associate with the DB cluster. + // + // For information on storage types for Amazon DocumentDB clusters, see Cluster + // storage configurations in the Amazon DocumentDB Developer Guide. + // + // Valid values for storage type - standard | iopt1 + // + // Default value is standard StorageType *string // A list of virtual private cloud (VPC) security groups that the cluster will diff --git a/service/docdb/api_op_ModifyDBClusterParameterGroup.go b/service/docdb/api_op_ModifyDBClusterParameterGroup.go index 1e3c832b243..fbb2e893243 100644 --- a/service/docdb/api_op_ModifyDBClusterParameterGroup.go +++ b/service/docdb/api_op_ModifyDBClusterParameterGroup.go @@ -11,18 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a cluster parameter group. To modify more than one +// 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. +// // 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 -// minutes before creating your first cluster that uses that cluster parameter -// group as the default parameter group. This allows Amazon DocumentDB to fully -// complete the create action before the parameter group is used as the default for -// a new cluster. This step is especially important for parameters that are -// critical when creating the default database for a cluster, such as the character -// set for the default database defined by the character_set_database parameter. +// 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 minutes +// before creating your first cluster that uses that cluster parameter group as the +// default parameter group. This allows Amazon DocumentDB to fully complete the +// create action before the parameter group is used as the default for a new +// cluster. This step is especially important for parameters that are critical when +// creating the default database for a cluster, such as the character set for the +// default database defined by the character_set_database parameter. func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *ModifyDBClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyDBClusterParameterGroupOutput, error) { if params == nil { params = &ModifyDBClusterParameterGroupInput{} @@ -38,7 +43,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. @@ -57,10 +62,16 @@ type ModifyDBClusterParameterGroupInput struct { // Contains the name of a cluster parameter group. type ModifyDBClusterParameterGroupOutput struct { - // The name of a cluster parameter group. Constraints: + // 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. DBClusterParameterGroupName *string diff --git a/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go b/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go index fac4907e952..9bc3107be4b 100644 --- a/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/docdb/api_op_ModifyDBClusterSnapshotAttribute.go @@ -12,17 +12,19 @@ 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 -// 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 -// 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 -// 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. +// manual cluster snapshot. +// +// To share a manual cluster 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 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 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. func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *ModifyDBClusterSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBClusterSnapshotAttributeOutput, error) { if params == nil { params = &ModifyDBClusterSnapshotAttributeInput{} @@ -38,12 +40,13 @@ 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 . + // 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 . // // This member is required. AttributeName *string @@ -54,22 +57,26 @@ 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 - // 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 - // manual cluster snapshots that contain private information that you don't want to - // be available to all Amazon Web Services accounts. + // 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 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 9bc37ac01c0..92356a5b0e0 100644 --- a/service/docdb/api_op_ModifyDBInstance.go +++ b/service/docdb/api_op_ModifyDBInstance.go @@ -29,11 +29,13 @@ 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 . // // This member is required. @@ -41,9 +43,12 @@ 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. - // Some parameter changes can cause an outage and are applied on the next reboot. + // PreferredMaintenanceWindow setting for the instance. + // + // If this parameter is set to 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 @@ -55,13 +60,19 @@ type ModifyDBInstanceInput struct { CACertificateIdentifier *string // Specifies 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, see - // Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) - // and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) - // in the Amazon DocumentDB Developer Guide. + // 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, see [Updating Your Amazon DocumentDB TLS Certificates] and [Encrypting Data in Transit] in the Amazon + // DocumentDB Developer Guide. + // + // [Updating Your Amazon DocumentDB TLS Certificates]: https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html + // [Encrypting Data in Transit]: https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html CertificateRotationRestart *bool // A value that indicates whether to copy all tags from the DB instance to @@ -69,31 +80,43 @@ type ModifyDBInstanceInput struct { CopyTagsToSnapshot *bool // 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. + // 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. 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]. + // + // [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 + // 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. + // // Example: mydbinstance NewDBInstanceIdentifier *string - // The KMS key identifier for encryption of Performance Insights data. The 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 + // The KMS key identifier for encryption of Performance Insights data. + // + // The 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 // DocumentDB 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. @@ -106,14 +129,24 @@ type ModifyDBInstanceInput struct { // maintenance window is changed to include the current time, changing this // parameter causes a reboot of the instance. If you are 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 that pending changes are applied. 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. + // of the window to ensure that pending changes are applied. + // + // 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. PreferredMaintenanceWindow *string // A value that specifies the order in which an Amazon DocumentDB replica is // promoted to the primary instance after a failure of the existing primary - // instance. Default: 1 Valid values: 0-15 + // instance. + // + // Default: 1 + // + // Valid values: 0-15 PromotionTier *int32 noSmithyDocumentSerde diff --git a/service/docdb/api_op_ModifyDBSubnetGroup.go b/service/docdb/api_op_ModifyDBSubnetGroup.go index 1efdbecdde6..21ee003fc78 100644 --- a/service/docdb/api_op_ModifyDBSubnetGroup.go +++ b/service/docdb/api_op_ModifyDBSubnetGroup.go @@ -28,12 +28,16 @@ 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 + // can't modify the default subnet group. + // + // Constraints: Must match the name of an 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 ea98a7b4488..825453f4374 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. @@ -35,10 +35,10 @@ type ModifyEventSubscriptionInput struct { // This member is required. SubscriptionName *string - // A Boolean value; set to true to activate the subscription. + // A Boolean value; set to true to activate the subscription. Enabled *bool - // A list of event categories for a SourceType that you want to subscribe to. + // A list of event categories for a SourceType that you want to subscribe to. EventCategories []string // The Amazon Resource Name (ARN) of the SNS topic created for event notification. @@ -47,8 +47,9 @@ type ModifyEventSubscriptionInput struct { // 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 + // 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 81e4934c453..408de6d517e 100644 --- a/service/docdb/api_op_ModifyGlobalCluster.go +++ b/service/docdb/api_op_ModifyGlobalCluster.go @@ -14,7 +14,9 @@ import ( // Modify a setting for an Amazon DocumentDB global cluster. You can change one or // more configuration parameters (for example: deletion protection), or the global // cluster identifier by specifying these parameters and the new values in the -// request. This action only applies to Amazon DocumentDB clusters. +// request. +// +// This action only applies to Amazon DocumentDB clusters. func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalClusterInput, optFns ...func(*Options)) (*ModifyGlobalClusterOutput, error) { if params == nil { params = &ModifyGlobalClusterInput{} @@ -30,11 +32,14 @@ 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: + // case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing global cluster. // // This member is required. @@ -46,8 +51,13 @@ 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 82b78f745ef..2be46bf13bd 100644 --- a/service/docdb/api_op_RebootDBInstance.go +++ b/service/docdb/api_op_RebootDBInstance.go @@ -14,9 +14,11 @@ import ( // You might need to reboot your instance, usually for maintenance reasons. For // example, if you make certain changes, or if you change the cluster parameter // group that is associated with the instance, you must reboot the instance for the -// changes to take effect. Rebooting an instance restarts the database engine -// service. Rebooting an instance results in a momentary outage, during which the -// instance status is set to rebooting. +// changes to take effect. +// +// Rebooting an instance restarts the database engine service. Rebooting an +// instance results in a momentary outage, during which the instance status is set +// to rebooting. func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceInput, optFns ...func(*Options)) (*RebootDBInstanceOutput, error) { if params == nil { params = &RebootDBInstanceInput{} @@ -32,18 +34,22 @@ 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 . // // This member is required. DBInstanceIdentifier *string - // 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. + // 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 noSmithyDocumentSerde diff --git a/service/docdb/api_op_RemoveFromGlobalCluster.go b/service/docdb/api_op_RemoveFromGlobalCluster.go index 9dddf3a6aa3..ab6424962c9 100644 --- a/service/docdb/api_op_RemoveFromGlobalCluster.go +++ b/service/docdb/api_op_RemoveFromGlobalCluster.go @@ -13,8 +13,9 @@ import ( // Detaches an Amazon DocumentDB secondary cluster from a global cluster. The // cluster becomes a standalone cluster with read-write capability instead of being -// read-only and receiving data from a primary in a different region. This action -// only applies to Amazon DocumentDB clusters. +// read-only and receiving data from a primary in a different region. +// +// This action only applies to Amazon DocumentDB clusters. func (c *Client) RemoveFromGlobalCluster(ctx context.Context, params *RemoveFromGlobalClusterInput, optFns ...func(*Options)) (*RemoveFromGlobalClusterOutput, error) { if params == nil { params = &RemoveFromGlobalClusterInput{} @@ -30,7 +31,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 91f0fc048e1..e4e588cc90a 100644 --- a/service/docdb/api_op_RemoveSourceIdentifierFromSubscription.go +++ b/service/docdb/api_op_RemoveSourceIdentifierFromSubscription.go @@ -28,11 +28,11 @@ 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 - // identifier for an instance, or the name of a security group. + // The source identifier to be removed from the subscription, such as the + // instance identifier for an instance, or the name of a security group. // // This member is required. SourceIdentifier *string diff --git a/service/docdb/api_op_RemoveTagsFromResource.go b/service/docdb/api_op_RemoveTagsFromResource.go index f678f7c2dae..7f4727ce6ff 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 77290902673..fb5e724b940 100644 --- a/service/docdb/api_op_ResetDBClusterParameterGroup.go +++ b/service/docdb/api_op_ResetDBClusterParameterGroup.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a cluster parameter group to the default value. To +// 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 -// 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 -// reboot. +// 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 reboot. func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *ResetDBClusterParameterGroupInput, optFns ...func(*Options)) (*ResetDBClusterParameterGroupOutput, error) { if params == nil { params = &ResetDBClusterParameterGroupInput{} @@ -33,7 +35,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. @@ -58,10 +60,16 @@ type ResetDBClusterParameterGroupInput struct { // Contains the name of a cluster parameter group. type ResetDBClusterParameterGroupOutput struct { - // The name of a cluster parameter group. Constraints: + // 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. DBClusterParameterGroupName *string diff --git a/service/docdb/api_op_RestoreDBClusterFromSnapshot.go b/service/docdb/api_op_RestoreDBClusterFromSnapshot.go index 53e4dd4bc9c..824227cf8b4 100644 --- a/service/docdb/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/docdb/api_op_RestoreDBClusterFromSnapshot.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is -// specified, the target cluster is created from the source DB snapshot with a -// default configuration and default security group. If a cluster snapshot is -// specified, the target cluster is created from the source cluster restore point -// with the same configuration as the original source DB cluster, except that the -// new cluster is created with the default security group. +// Creates a new cluster from a snapshot or cluster snapshot. +// +// If a snapshot is specified, the target cluster is created from the source DB +// snapshot with a default configuration and default security group. +// +// If a cluster snapshot is specified, the target cluster is created from the +// source cluster restore point with the same configuration as the original source +// DB cluster, except that the new cluster is created with the default security +// group. func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error) { if params == nil { params = &RestoreDBClusterFromSnapshotInput{} @@ -32,28 +35,41 @@ 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: + // 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. + // // Example: my-snapshot-id // // This member is required. DBClusterIdentifier *string - // The database engine to use for the new cluster. Default: The same as source. + // The database engine to use for the new cluster. + // + // Default: The same as source. + // // Constraint: Must be compatible with the engine of the source. // // 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: + // 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. @@ -64,16 +80,21 @@ type RestoreDBClusterFromSnapshotInput struct { AvailabilityZones []string // The name of the DB cluster parameter group to associate with this DB cluster. - // Type: String. Required: No. If this argument is omitted, the default DB cluster - // parameter group is used. If supplied, must match the name of an existing default - // DB cluster parameter group. The string must consist of from 1 to 255 letters, - // numbers or hyphens. Its first character must be a letter, and it cannot end with - // a hyphen or contain two consecutive hyphens. + // + // Type: String. Required: No. + // + // If this argument is omitted, the default DB cluster parameter group is used. If + // supplied, must match the name of an existing default DB cluster parameter group. + // The string must consist of from 1 to 255 letters, numbers or hyphens. Its first + // character must be a letter, and it cannot end with a hyphen or contain two + // consecutive hyphens. 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: - // mySubnetgroup + // The name of the subnet group 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 @@ -90,27 +111,39 @@ type RestoreDBClusterFromSnapshotInput struct { EngineVersion *string // The KMS key identifier to use when restoring an encrypted cluster from a DB - // snapshot or cluster snapshot. The KMS key identifier is the Amazon Resource Name - // (ARN) for the KMS encryption key. If you are restoring a cluster with the same - // Amazon Web Services account that owns the KMS encryption key used to encrypt the - // 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: + // snapshot or cluster snapshot. + // + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are restoring a cluster with the same Amazon Web Services account + // that owns the KMS encryption key used to encrypt the 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. 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. + // 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. Port *int32 - // The storage type to associate with the DB cluster. For information on storage - // types for Amazon DocumentDB clusters, see Cluster storage configurations in the - // Amazon DocumentDB Developer Guide. Valid values for storage type - standard | - // iopt1 Default value is standard + // The storage type to associate with the DB cluster. + // + // For information on storage types for Amazon DocumentDB clusters, see Cluster + // storage configurations in the Amazon DocumentDB Developer Guide. + // + // Valid values for storage type - standard | iopt1 + // + // Default value is standard StorageType *string // 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 c3e958803a3..fb246549a95 100644 --- a/service/docdb/api_op_RestoreDBClusterToPointInTime.go +++ b/service/docdb/api_op_RestoreDBClusterToPointInTime.go @@ -32,25 +32,36 @@ 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: + // 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. // // This member is required. DBClusterIdentifier *string - // The identifier of the source cluster from which to restore. Constraints: + // The identifier of the source cluster from which to restore. + // + // Constraints: + // // - 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 @@ -64,60 +75,88 @@ type RestoreDBClusterToPointInTimeInput struct { EnableCloudwatchLogsExports []string // The KMS key identifier to use when restoring an encrypted cluster from an - // encrypted cluster. The KMS key identifier is the Amazon Resource Name (ARN) for - // the KMS encryption key. If you are restoring a cluster with the same Amazon Web - // Services account that owns the KMS encryption key used to encrypt the new - // cluster, then you can use the KMS key alias instead of the ARN for the KMS - // encryption key. You can restore to a new cluster and encrypt the new cluster - // with an KMS key that is different from the KMS key used to encrypt the source - // 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: + // encrypted cluster. + // + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are restoring a cluster with the same Amazon Web Services account + // that owns the KMS encryption key used to encrypt the new cluster, then you can + // use the KMS key alias instead of the ARN for the KMS encryption key. + // + // You can restore to a new cluster and encrypt the new cluster with an KMS key + // that is different from the KMS key used to encrypt the source 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 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. + // 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. Port *int32 - // The date and time to restore the cluster to. Valid values: A time in Universal - // Coordinated Time (UTC) format. Constraints: + // 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 . + // // 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. + // 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 storage type to associate with the DB cluster. For information on storage - // types for Amazon DocumentDB clusters, see Cluster storage configurations in the - // Amazon DocumentDB Developer Guide. Valid values for storage type - standard | - // iopt1 Default value is standard + // The storage type to associate with the DB cluster. + // + // For information on storage types for Amazon DocumentDB clusters, see Cluster + // storage configurations in the Amazon DocumentDB Developer Guide. + // + // Valid values for storage type - standard | iopt1 + // + // Default value is standard StorageType *string // The tags to be assigned to the restored cluster. Tags []types.Tag // A value that is set to true to restore the cluster to the latest restorable - // backup time, and false otherwise. Default: false Constraints: Cannot be - // specified if the RestoreToTime parameter is provided. + // backup time, and false otherwise. + // + // Default: false + // + // Constraints: Cannot be specified if the RestoreToTime parameter is provided. UseLatestRestorableTime *bool // A list of VPC security groups that the new cluster belongs to. diff --git a/service/docdb/api_op_StartDBCluster.go b/service/docdb/api_op_StartDBCluster.go index 961c90da489..1110c98ea8f 100644 --- a/service/docdb/api_op_StartDBCluster.go +++ b/service/docdb/api_op_StartDBCluster.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// information, see [Stopping and Starting an Amazon DocumentDB Cluster]. +// +// [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 46cd8f87de8..120cec18d24 100644 --- a/service/docdb/api_op_StopDBCluster.go +++ b/service/docdb/api_op_StopDBCluster.go @@ -12,9 +12,9 @@ import ( ) // 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) -// . +// must be in the available state. For more information, see [Stopping and Starting an Amazon DocumentDB Cluster]. +// +// [Stopping and Starting 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/api_op_SwitchoverGlobalCluster.go b/service/docdb/api_op_SwitchoverGlobalCluster.go index a4f03e5775e..2066948a777 100644 --- a/service/docdb/api_op_SwitchoverGlobalCluster.go +++ b/service/docdb/api_op_SwitchoverGlobalCluster.go @@ -33,10 +33,15 @@ type SwitchoverGlobalClusterInput struct { // The identifier of the Amazon DocumentDB global database cluster to switch over. // The identifier is the unique key assigned by the user when the cluster is // created. In other words, it's the name of the global cluster. This parameter - // isn’t case-sensitive. Constraints: + // isn’t case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing global cluster (Amazon DocumentDB // global database). + // // - Minimum length of 1. Maximum length of 255. + // // Pattern: [A-Za-z][0-9A-Za-z-:._]* // // This member is required. @@ -45,9 +50,14 @@ type SwitchoverGlobalClusterInput struct { // The identifier of the secondary Amazon DocumentDB cluster to promote to the new // primary for the global database cluster. Use the Amazon Resource Name (ARN) for // the identifier so that Amazon DocumentDB can locate the cluster in its Amazon - // Web Services region. Constraints: + // Web Services region. + // + // Constraints: + // // - Must match the identifier of an existing secondary cluster. + // // - Minimum length of 1. Maximum length of 255. + // // Pattern: [A-Za-z][0-9A-Za-z-:._]* // // This member is required. diff --git a/service/docdb/options.go b/service/docdb/options.go index c5964e219ad..e1488e62cfd 100644 --- a/service/docdb/options.go +++ b/service/docdb/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/docdb/types/enums.go b/service/docdb/types/enums.go index 91e91f9f84c..8667f0358cd 100644 --- a/service/docdb/types/enums.go +++ b/service/docdb/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApplyMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplyMethod) Values() []ApplyMethod { return []ApplyMethod{ "immediate", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "db-instance", diff --git a/service/docdb/types/errors.go b/service/docdb/types/errors.go index 0331500f332..06429ae694e 100644 --- a/service/docdb/types/errors.go +++ b/service/docdb/types/errors.go @@ -8,8 +8,10 @@ import ( ) // The specified CIDR IP or Amazon EC2 security group isn't authorized for the -// specified security group. Amazon DocumentDB also might not be authorized to -// perform necessary actions on your behalf using IAM. +// specified security group. +// +// Amazon DocumentDB also might not be authorized to perform necessary actions on +// your behalf using IAM. type AuthorizationNotFoundFault struct { Message *string diff --git a/service/docdb/types/types.go b/service/docdb/types/types.go index 2bbe68c46b5..a98ff67af8e 100644 --- a/service/docdb/types/types.go +++ b/service/docdb/types/types.go @@ -19,34 +19,43 @@ type AvailabilityZone struct { // A certificate authority (CA) certificate for an Amazon Web Services account. type Certificate struct { - // The Amazon Resource Name (ARN) for the certificate. Example: - // arn:aws:rds:us-east-1::cert:rds-ca-2019 + // The Amazon Resource Name (ARN) for the certificate. + // + // Example: arn:aws:rds:us-east-1::cert:rds-ca-2019 CertificateArn *string - // The unique key that identifies a certificate. Example: rds-ca-2019 + // The unique key that identifies a certificate. + // + // Example: rds-ca-2019 CertificateIdentifier *string - // The type of the certificate. Example: CA + // The type of the certificate. + // + // Example: CA CertificateType *string // The thumbprint of the certificate. Thumbprint *string - // The starting date-time from which the certificate is valid. Example: - // 2019-07-31T17:57:09Z + // The starting date-time from which the certificate is valid. + // + // Example: 2019-07-31T17:57:09Z ValidFrom *time.Time - // The date-time after which the certificate is no longer valid. Example: - // 2024-07-31T17:57:09Z + // The date-time after which the certificate is no longer valid. + // + // Example: 2024-07-31T17:57:09Z ValidTill *time.Time noSmithyDocumentSerde } -// Returns the details of the DB instance’s server certificate. For more -// information, see Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) -// and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) -// in the Amazon DocumentDB Developer Guide. +// Returns the details of the DB instance’s server certificate. +// +// For more information, see [Updating Your Amazon DocumentDB TLS Certificates] and [Encrypting Data in Transit] in the Amazon DocumentDB Developer Guide. +// +// [Updating Your Amazon DocumentDB TLS Certificates]: https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html +// [Encrypting Data in Transit]: https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html type CertificateDetails struct { // The CA identifier of the CA certificate used for the DB instance's server @@ -60,10 +69,11 @@ type CertificateDetails struct { } // The configuration setting for the log types to be enabled for export to Amazon -// CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and -// DisableLogTypes arrays determine which logs are exported (or not exported) to -// CloudWatch Logs. The values within these arrays depend on the engine that is -// being used. +// CloudWatch Logs for a specific instance or cluster. +// +// The EnableLogTypes and DisableLogTypes arrays determine which logs are exported +// (or not exported) to CloudWatch Logs. The values within these arrays depend on +// the engine that is being used. type CloudwatchLogsExportConfiguration struct { // The list of log types to disable. @@ -182,11 +192,12 @@ type DBCluster struct { // a cluster. As clients request new connections to the reader endpoint, Amazon // DocumentDB distributes the connection requests among the Amazon DocumentDB // replicas in the cluster. This functionality can help balance your read workload - // across multiple Amazon DocumentDB replicas in your cluster. If a failover - // occurs, and the Amazon DocumentDB replica that you are connected to is promoted - // to be the primary instance, your connection is dropped. To continue sending your - // read workload to other Amazon DocumentDB replicas in the cluster, you can then - // reconnect to the reader endpoint. + // across multiple Amazon DocumentDB replicas in your cluster. + // + // If a failover occurs, and the Amazon DocumentDB replica that you are connected + // to is promoted to be the primary instance, your connection is dropped. To + // continue sending your read workload to other Amazon DocumentDB replicas in the + // cluster, you can then reconnect to the reader endpoint. ReaderEndpoint *string // Contains the identifier of the source cluster if this cluster is a secondary @@ -199,10 +210,16 @@ type DBCluster struct { // Specifies whether the cluster is encrypted. StorageEncrypted *bool - // Storage type associated with your cluster Storage type associated with your - // cluster For information on storage types for Amazon DocumentDB clusters, see - // Cluster storage configurations in the Amazon DocumentDB Developer Guide. Valid - // values for storage type - standard | iopt1 Default value is standard + // Storage type associated with your cluster + // + // Storage type associated with your cluster + // + // For information on storage types for Amazon DocumentDB clusters, see Cluster + // storage configurations in the Amazon DocumentDB Developer Guide. + // + // Valid values for storage type - standard | iopt1 + // + // Default value is standard StorageType *string // Provides a list of virtual private cloud (VPC) security groups that the cluster @@ -263,9 +280,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. @@ -331,10 +351,14 @@ type DBClusterSnapshot struct { // Specifies whether the cluster snapshot is encrypted. StorageEncrypted *bool - // Storage type associated with your cluster snapshot For information on storage - // types for Amazon DocumentDB clusters, see Cluster storage configurations in the - // Amazon DocumentDB Developer Guide. Valid values for storage type - standard | - // iopt1 Default value is standard + // Storage type associated with your cluster snapshot + // + // For information on storage types for Amazon DocumentDB clusters, see Cluster + // storage configurations in the Amazon DocumentDB Developer Guide. + // + // Valid values for storage type - standard | iopt1 + // + // Default value is standard StorageType *string // Provides the virtual private cloud (VPC) ID that is associated with the cluster @@ -344,21 +368,25 @@ type DBClusterSnapshot struct { noSmithyDocumentSerde } -// Contains the name and values of a manual cluster snapshot attribute. Manual -// cluster snapshot attributes are used to authorize other Amazon Web Services -// accounts to restore a manual cluster snapshot. +// Contains the name and values of a manual cluster snapshot attribute. +// +// Manual cluster snapshot attributes are used to authorize other Amazon Web +// Services accounts to restore a manual cluster snapshot. type DBClusterSnapshotAttribute struct { - // The name of the manual cluster snapshot attribute. The attribute named restore - // refers to the list of Amazon Web Services accounts that have permission to copy - // or restore the manual cluster snapshot. + // The name of the manual cluster snapshot attribute. + // + // The attribute named restore refers to the list of Amazon Web Services accounts + // that have permission to copy 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 - // 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. + // 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 noSmithyDocumentSerde @@ -399,10 +427,12 @@ type DBEngineVersion struct { // CloudWatch Logs. ExportableLogTypes []string - // A list of the supported CA certificate identifiers. For more information, see - // Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) - // and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) - // in the Amazon DocumentDB Developer Guide. + // A list of the supported CA certificate identifiers. + // + // For more information, see [Updating Your Amazon DocumentDB TLS Certificates] and [Encrypting Data in Transit] in the Amazon DocumentDB Developer Guide. + // + // [Updating Your Amazon DocumentDB TLS Certificates]: https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html + // [Encrypting Data in Transit]: https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html SupportedCACertificateIdentifiers []string // Indicates whether the engine version supports rotating the server certificate @@ -484,7 +514,8 @@ 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 @@ -504,7 +535,7 @@ type DBInstance struct { // for the KMS encryption key. PerformanceInsightsKMSKeyId *string - // Specifies the daily time range during which automated backups are created if + // Specifies the daily time range during which automated backups are created if // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string @@ -681,11 +712,15 @@ 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 - // topic-not-exist status indicates that the topic was deleted after the - // subscription was created. + // + // 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 // The time at which the Amazon DocumentDB event notification subscription was @@ -697,7 +732,9 @@ type EventSubscription struct { // A named set of filter values, used to return a more specific list of results. // You can use a filter to match a set of resources by specific criteria, such as -// IDs. Wildcards are not supported in filters. +// IDs. +// +// Wildcards are not supported in filters. type Filter struct { // The name of the filter. Filter names are case sensitive. @@ -760,7 +797,7 @@ 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 + // 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 @@ -817,7 +854,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 @@ -883,11 +920,12 @@ type PendingMaintenanceAction struct { noSmithyDocumentSerde } -// One or more modified settings for an instance. These modified settings have +// 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 + // Contains the new AllocatedStorage size for then instance that will be applied // or is currently being applied. AllocatedStorage *int32 @@ -898,11 +936,11 @@ type PendingModifiedValues struct { // DB instance. CACertificateIdentifier *string - // Contains the new DBInstanceClass for the instance that will be applied or is + // Contains the new DBInstanceClass for the instance that will be applied or is // currently being applied. DBInstanceClass *string - // Contains the new DBInstanceIdentifier for the instance that will be applied or + // Contains the new DBInstanceIdentifier for the instance that will be applied or // is currently being applied. DBInstanceIdentifier *string @@ -916,8 +954,9 @@ 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 @@ -940,7 +979,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 diff --git a/service/docdbelastic/api_op_CopyClusterSnapshot.go b/service/docdbelastic/api_op_CopyClusterSnapshot.go index 99793565b69..1c15da59d89 100644 --- a/service/docdbelastic/api_op_CopyClusterSnapshot.go +++ b/service/docdbelastic/api_op_CopyClusterSnapshot.go @@ -35,10 +35,16 @@ type CopyClusterSnapshotInput struct { SnapshotArn *string // The identifier of the new elastic cluster snapshot to create from the source - // cluster snapshot. This parameter is not case sensitive. Constraints: + // 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. + // // Example: elastic-cluster-snapshot-5 // // This member is required. @@ -51,19 +57,23 @@ type CopyClusterSnapshotInput struct { // The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. // The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web // Services KMS key identifier, or the Amazon Web Services KMS key alias for the - // Amazon Web Services KMS encryption key. If you copy an encrypted elastic cluster - // snapshot from your Amazon Web Services account, you can specify a value for - // KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. - // If you don't specify a value for KmsKeyId , then the copy of the elastic cluster - // snapshot is encrypted with the same AWS KMS key as the source elastic cluster - // snapshot. To copy an encrypted elastic cluster snapshot to another Amazon Web - // Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you - // want to use to encrypt the copy of the elastic cluster snapshot in the - // destination region. Amazon Web Services 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 - // Services region. If you copy an unencrypted elastic cluster snapshot and specify - // a value for the KmsKeyId parameter, an error is returned. + // Amazon Web Services KMS encryption key. + // + // If you copy an encrypted elastic cluster snapshot from your Amazon Web Services + // account, you can specify a value for KmsKeyId to encrypt the copy with a new + // Amazon Web ServicesS KMS encryption key. If you don't specify a value for + // KmsKeyId , then the copy of the elastic cluster snapshot is encrypted with the + // same AWS KMS key as the source elastic cluster snapshot. + // + // To copy an encrypted elastic cluster snapshot to another Amazon Web Services + // region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use + // to encrypt the copy of the elastic cluster snapshot in the destination region. + // Amazon Web Services 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 Services region. + // + // If you copy an unencrypted elastic cluster snapshot and specify a value for the + // KmsKeyId parameter, an error is returned. KmsKeyId *string // The tags to be assigned to the elastic cluster snapshot. diff --git a/service/docdbelastic/api_op_CreateCluster.go b/service/docdbelastic/api_op_CreateCluster.go index 1611fbe0a7e..216a11d7751 100644 --- a/service/docdbelastic/api_op_CreateCluster.go +++ b/service/docdbelastic/api_op_CreateCluster.go @@ -30,17 +30,26 @@ func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, type CreateClusterInput struct { - // The name of the Amazon DocumentDB elastic clusters administrator. Constraints: + // The name of the Amazon DocumentDB elastic clusters administrator. + // + // Constraints: + // // - 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 Amazon DocumentDB elastic clusters administrator. The - // password can contain any printable ASCII characters. Constraints: + // password 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 // (@). // @@ -54,10 +63,16 @@ type CreateClusterInput struct { AuthType types.Auth // The name of the new elastic cluster. This parameter is stored as a lowercase - // string. Constraints: + // 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-cluster // // This member is required. @@ -80,13 +95,16 @@ type CreateClusterInput struct { // The client token for the elastic cluster. ClientToken *string - // The KMS key identifier to use to encrypt the new elastic 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, Amazon DocumentDB uses - // the default encryption key that KMS creates for your account. Your account has a - // different default encryption key for each Amazon Region. + // The KMS key identifier to use to encrypt the new elastic 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, Amazon DocumentDB uses the default + // encryption key that KMS creates for your account. Your account has a different + // default encryption key for each Amazon Region. KmsKeyId *string // The daily time range during which automated backups are created if automated @@ -94,10 +112,16 @@ type CreateClusterInput struct { PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: 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. + // Coordinated Time (UTC). + // + // Format: ddd:hh24:mi-ddd:hh24:mi + // + // Default: 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 // The number of replica instances applying to all shards in the elastic cluster. diff --git a/service/docdbelastic/api_op_ListClusterSnapshots.go b/service/docdbelastic/api_op_ListClusterSnapshots.go index f223d4b7ec3..3c8ae3e5291 100644 --- a/service/docdbelastic/api_op_ListClusterSnapshots.go +++ b/service/docdbelastic/api_op_ListClusterSnapshots.go @@ -38,14 +38,17 @@ type ListClusterSnapshotsInput struct { // A pagination token provided by a previous request. If this parameter is // specified, the response includes only records beyond this token, up to the value - // specified by max-results . If there is no more data in the responce, the - // nextToken will not be returned. + // specified by max-results . + // + // If there is no more data in the responce, the nextToken will not be returned. NextToken *string // 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. SnapshotType *string @@ -57,8 +60,9 @@ type ListClusterSnapshotsOutput struct { // A pagination token provided by a previous request. If this parameter is // specified, the response includes only records beyond this token, up to the value - // specified by max-results . If there is no more data in the responce, the - // nextToken will not be returned. + // specified by max-results . + // + // If there is no more data in the responce, the nextToken will not be returned. NextToken *string // A list of snapshots for a specified elastic cluster. diff --git a/service/docdbelastic/api_op_ListClusters.go b/service/docdbelastic/api_op_ListClusters.go index 3786eec5c79..c33669212ae 100644 --- a/service/docdbelastic/api_op_ListClusters.go +++ b/service/docdbelastic/api_op_ListClusters.go @@ -35,8 +35,9 @@ type ListClustersInput struct { // A pagination token provided by a previous request. If this parameter is // specified, the response includes only records beyond this token, up to the value - // specified by max-results . If there is no more data in the responce, the - // nextToken will not be returned. + // specified by max-results . + // + // If there is no more data in the responce, the nextToken will not be returned. NextToken *string noSmithyDocumentSerde @@ -49,8 +50,9 @@ type ListClustersOutput struct { // A pagination token provided by a previous request. If this parameter is // specified, the response includes only records beyond this token, up to the value - // specified by max-results . If there is no more data in the responce, the - // nextToken will not be returned. + // specified by max-results . + // + // If there is no more data in the responce, the nextToken will not be returned. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go b/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go index e89f1d180fa..48798eaa14d 100644 --- a/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go +++ b/service/docdbelastic/api_op_RestoreClusterFromSnapshot.go @@ -40,13 +40,16 @@ type RestoreClusterFromSnapshotInput struct { SnapshotArn *string // The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic - // clusters 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, Amazon DocumentDB uses the default encryption key that KMS creates for - // your account. Your account has a different default encryption key for each - // Amazon Region. + // clusters 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, Amazon DocumentDB uses the default + // encryption key that KMS creates for your account. Your account has a different + // default encryption key for each Amazon Region. KmsKeyId *string // The capacity of each shard in the new restored elastic cluster. diff --git a/service/docdbelastic/api_op_UpdateCluster.go b/service/docdbelastic/api_op_UpdateCluster.go index 4f211515db6..52b0f95a9a7 100644 --- a/service/docdbelastic/api_op_UpdateCluster.go +++ b/service/docdbelastic/api_op_UpdateCluster.go @@ -37,7 +37,9 @@ type UpdateClusterInput struct { // The password associated with the elastic 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. + // ("), or the "at" symbol (@). + // + // Constraints: Must contain from 8 to 100 characters. AdminUserPassword *string // The authentication type used to determine where to fetch the password used for @@ -55,10 +57,16 @@ type UpdateClusterInput struct { PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: 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. + // Coordinated Time (UTC). + // + // Format: ddd:hh24:mi-ddd:hh24:mi + // + // Default: 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 // The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. diff --git a/service/docdbelastic/doc.go b/service/docdbelastic/doc.go index 18b90a70b50..65d98ae3ed0 100644 --- a/service/docdbelastic/doc.go +++ b/service/docdbelastic/doc.go @@ -3,17 +3,22 @@ // Package docdbelastic provides the API client, operations, and parameter types // for Amazon DocumentDB Elastic Clusters. // -// Amazon DocumentDB elastic clusters Amazon DocumentDB elastic-clusters support -// workloads with millions of reads/writes per second and petabytes of storage -// capacity. Amazon DocumentDB elastic clusters also simplify how developers -// interact with Amazon DocumentDB elastic-clusters by eliminating the need to -// choose, manage or upgrade instances. Amazon DocumentDB elastic-clusters were -// created to: +// # Amazon DocumentDB elastic clusters +// +// Amazon DocumentDB elastic-clusters support workloads with millions of +// reads/writes per second and petabytes of storage capacity. Amazon DocumentDB +// elastic clusters also simplify how developers interact with Amazon DocumentDB +// elastic-clusters by eliminating the need to choose, manage or upgrade instances. +// +// Amazon DocumentDB elastic-clusters were created to: +// // - provide a solution for customers looking for a database that provides // virtually limitless scale with rich query capabilities and MongoDB API // compatibility. +// // - give customers higher connection limits, and to reduce downtime from // patching. +// // - continue investing in a cloud-native, elastic, and class leading // architecture for JSON workloads. package docdbelastic diff --git a/service/docdbelastic/options.go b/service/docdbelastic/options.go index c02ac3d11f2..64809c2c6b1 100644 --- a/service/docdbelastic/options.go +++ b/service/docdbelastic/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/docdbelastic/types/enums.go b/service/docdbelastic/types/enums.go index 9e802ff52ca..4f840616c80 100644 --- a/service/docdbelastic/types/enums.go +++ b/service/docdbelastic/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for Auth. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Auth) Values() []Auth { return []Auth{ "PLAIN_TEXT", @@ -29,8 +30,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "MANUAL", @@ -64,8 +66,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "CREATING", @@ -102,6 +105,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/docdbelastic/types/types.go b/service/docdbelastic/types/types.go index 1b87be99d01..6c7f01e081f 100644 --- a/service/docdbelastic/types/types.go +++ b/service/docdbelastic/types/types.go @@ -46,7 +46,9 @@ type Cluster struct { KmsKeyId *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi + // Coordinated Time (UTC). + // + // Format: ddd:hh24:mi-ddd:hh24:mi // // This member is required. PreferredMaintenanceWindow *string @@ -179,8 +181,10 @@ type ClusterSnapshot 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. SnapshotType SnapshotType diff --git a/service/drs/options.go b/service/drs/options.go index cdf5589f34d..12f64dfebab 100644 --- a/service/drs/options.go +++ b/service/drs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/drs/types/enums.go b/service/drs/types/enums.go index 366c36a7fb2..91c34050817 100644 --- a/service/drs/types/enums.go +++ b/service/drs/types/enums.go @@ -24,6 +24,7 @@ const ( // Values returns all known values for DataReplicationErrorString. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationErrorString) Values() []DataReplicationErrorString { return []DataReplicationErrorString{ @@ -63,8 +64,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationInitiationStepName) Values() []DataReplicationInitiationStepName { return []DataReplicationInitiationStepName{ "WAIT", @@ -94,8 +96,9 @@ const ( // Values returns all known values for DataReplicationInitiationStepStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationInitiationStepStatus) Values() []DataReplicationInitiationStepStatus { return []DataReplicationInitiationStepStatus{ "NOT_STARTED", @@ -123,8 +126,9 @@ const ( ) // Values returns all known values for DataReplicationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationState) Values() []DataReplicationState { return []DataReplicationState{ "STOPPED", @@ -154,8 +158,9 @@ const ( ) // Values returns all known values for EC2InstanceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EC2InstanceState) Values() []EC2InstanceState { return []EC2InstanceState{ "PENDING", @@ -178,8 +183,9 @@ const ( ) // Values returns all known values for ExtensionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExtensionStatus) Values() []ExtensionStatus { return []ExtensionStatus{ "EXTENDED", @@ -197,8 +203,9 @@ const ( ) // Values returns all known values for FailbackLaunchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailbackLaunchType) Values() []FailbackLaunchType { return []FailbackLaunchType{ "RECOVERY", @@ -235,6 +242,7 @@ const ( // 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{ @@ -276,8 +284,9 @@ const ( ) // Values returns all known values for FailbackState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailbackState) Values() []FailbackState { return []FailbackState{ "FAILBACK_NOT_STARTED", @@ -306,8 +315,9 @@ const ( ) // Values returns all known values for InitiatedBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InitiatedBy) Values() []InitiatedBy { return []InitiatedBy{ "START_RECOVERY", @@ -356,8 +366,9 @@ const ( ) // Values returns all known values for JobLogEvent. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobLogEvent) Values() []JobLogEvent { return []JobLogEvent{ "JOB_START", @@ -400,8 +411,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -420,8 +432,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "LAUNCH", @@ -441,8 +454,9 @@ const ( ) // Values returns all known values for LastLaunchResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastLaunchResult) Values() []LastLaunchResult { return []LastLaunchResult{ "NOT_STARTED", @@ -461,8 +475,9 @@ const ( ) // Values returns all known values for LastLaunchType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastLaunchType) Values() []LastLaunchType { return []LastLaunchType{ "RECOVERY", @@ -482,8 +497,9 @@ const ( ) // Values returns all known values for LaunchActionCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchActionCategory) Values() []LaunchActionCategory { return []LaunchActionCategory{ "MONITORING", @@ -504,6 +520,7 @@ const ( // Values returns all known values for LaunchActionParameterType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LaunchActionParameterType) Values() []LaunchActionParameterType { return []LaunchActionParameterType{ @@ -522,8 +539,9 @@ const ( ) // Values returns all known values for LaunchActionRunStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchActionRunStatus) Values() []LaunchActionRunStatus { return []LaunchActionRunStatus{ "IN_PROGRESS", @@ -541,8 +559,9 @@ const ( ) // Values returns all known values for LaunchActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchActionType) Values() []LaunchActionType { return []LaunchActionType{ "SSM_AUTOMATION", @@ -559,8 +578,9 @@ const ( ) // Values returns all known values for LaunchDisposition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchDisposition) Values() []LaunchDisposition { return []LaunchDisposition{ "STOPPED", @@ -580,8 +600,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -601,8 +622,9 @@ const ( ) // Values returns all known values for OriginEnvironment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginEnvironment) Values() []OriginEnvironment { return []OriginEnvironment{ "ON_PREMISES", @@ -620,8 +642,9 @@ const ( ) // Values returns all known values for PITPolicyRuleUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PITPolicyRuleUnits) Values() []PITPolicyRuleUnits { return []PITPolicyRuleUnits{ "MINUTE", @@ -639,8 +662,9 @@ const ( ) // Values returns all known values for ProductCodeMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductCodeMode) Values() []ProductCodeMode { return []ProductCodeMode{ "ENABLED", @@ -674,8 +698,9 @@ const ( // Values returns all known values for // RecoveryInstanceDataReplicationInitiationStepName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoveryInstanceDataReplicationInitiationStepName) Values() []RecoveryInstanceDataReplicationInitiationStepName { return []RecoveryInstanceDataReplicationInitiationStepName{ "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", @@ -712,8 +737,9 @@ const ( // Values returns all known values for // RecoveryInstanceDataReplicationInitiationStepStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoveryInstanceDataReplicationInitiationStepStatus) Values() []RecoveryInstanceDataReplicationInitiationStepStatus { return []RecoveryInstanceDataReplicationInitiationStepStatus{ "NOT_STARTED", @@ -744,8 +770,9 @@ const ( // Values returns all known values for RecoveryInstanceDataReplicationState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoveryInstanceDataReplicationState) Values() []RecoveryInstanceDataReplicationState { return []RecoveryInstanceDataReplicationState{ "STOPPED", @@ -777,8 +804,9 @@ const ( ) // Values returns all known values for RecoveryResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoveryResult) Values() []RecoveryResult { return []RecoveryResult{ "NOT_STARTED", @@ -800,8 +828,9 @@ const ( ) // Values returns all known values for RecoverySnapshotsOrder. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecoverySnapshotsOrder) Values() []RecoverySnapshotsOrder { return []RecoverySnapshotsOrder{ "ASC", @@ -819,8 +848,9 @@ const ( // Values returns all known values for ReplicationConfigurationDataPlaneRouting. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationDataPlaneRouting) Values() []ReplicationConfigurationDataPlaneRouting { return []ReplicationConfigurationDataPlaneRouting{ "PRIVATE_IP", @@ -840,8 +870,9 @@ const ( // Values returns all known values for // ReplicationConfigurationDefaultLargeStagingDiskType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationDefaultLargeStagingDiskType) Values() []ReplicationConfigurationDefaultLargeStagingDiskType { return []ReplicationConfigurationDefaultLargeStagingDiskType{ "GP2", @@ -862,8 +893,9 @@ const ( // Values returns all known values for ReplicationConfigurationEbsEncryption. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationEbsEncryption) Values() []ReplicationConfigurationEbsEncryption { return []ReplicationConfigurationEbsEncryption{ "DEFAULT", @@ -887,8 +919,9 @@ const ( // Values returns all known values for // ReplicationConfigurationReplicatedDiskStagingDiskType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationReplicatedDiskStagingDiskType) Values() []ReplicationConfigurationReplicatedDiskStagingDiskType { return []ReplicationConfigurationReplicatedDiskStagingDiskType{ "AUTO", @@ -910,8 +943,9 @@ const ( ) // Values returns all known values for ReplicationDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationDirection) Values() []ReplicationDirection { return []ReplicationDirection{ "FAILOVER", @@ -930,8 +964,9 @@ const ( ) // Values returns all known values for ReplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStatus) Values() []ReplicationStatus { return []ReplicationStatus{ "STOPPED", @@ -952,8 +987,9 @@ const ( // Values returns all known values for TargetInstanceTypeRightSizingMethod. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetInstanceTypeRightSizingMethod) Values() []TargetInstanceTypeRightSizingMethod { return []TargetInstanceTypeRightSizingMethod{ "NONE", @@ -974,6 +1010,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -996,8 +1033,9 @@ const ( ) // Values returns all known values for VolumeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeStatus) Values() []VolumeStatus { return []VolumeStatus{ "REGULAR", diff --git a/service/dynamodb/api_op_BatchExecuteStatement.go b/service/dynamodb/api_op_BatchExecuteStatement.go index d33688b2630..f7dbfd95f37 100644 --- a/service/dynamodb/api_op_BatchExecuteStatement.go +++ b/service/dynamodb/api_op_BatchExecuteStatement.go @@ -14,12 +14,16 @@ import ( // This operation allows you to perform batch reads or writes on data stored in // DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must // specify an equality condition on all key attributes. This enforces that each -// SELECT statement in a batch returns at most a single item. The entire batch must -// 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 +// SELECT statement in a batch returns at most a single item. +// +// The entire batch must 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) -// field of the BatchStatementResponse for each statement. +// found under the [Error]field of the BatchStatementResponse for each statement. +// +// [Error]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) { if params == nil { params = &BatchExecuteStatementInput{} @@ -44,13 +48,18 @@ 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). + // 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 diff --git a/service/dynamodb/api_op_BatchGetItem.go b/service/dynamodb/api_op_BatchGetItem.go index bd39f8d3447..106d99150ea 100644 --- a/service/dynamodb/api_op_BatchGetItem.go +++ b/service/dynamodb/api_op_BatchGetItem.go @@ -13,43 +13,57 @@ import ( ) // The BatchGetItem operation returns the attributes of one or more items from one -// or more tables. You identify requested items by primary key. A single operation -// can retrieve up to 16 MB of data, which can contain as many as 100 items. -// BatchGetItem returns a partial result if the response size limit is exceeded, -// the table's provisioned throughput is exceeded, more than 1MB per partition is -// requested, 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 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 successfully processed, then BatchGetItem completes -// successfully, while returning the keys of the unread items in UnprocessedKeys . +// or more tables. You identify requested items by primary key. +// +// A single operation can retrieve up to 16 MB of data, which can contain as many +// as 100 items. BatchGetItem returns a partial result if the response size limit +// is exceeded, the table's provisioned throughput is exceeded, more than 1MB per +// partition is requested, 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 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 +// successfully processed, then BatchGetItem completes successfully, while +// 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) -// 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 -// tables. In order to minimize response latency, BatchGetItem may retrieve items -// in parallel. When designing your application, keep in mind that DynamoDB does -// not return items in any particular order. To help parse the response by item, -// include the primary key values for the items in your request in the -// 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) -// in the Amazon DynamoDB Developer Guide. +// individual requests in the batch are much more likely to succeed. +// +// For more information, see [Batch Operations and Error Handling] 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 tables. +// +// In order to minimize response latency, BatchGetItem may retrieve items in +// parallel. +// +// When designing your application, keep in mind that DynamoDB does not return +// items in any particular order. To help parse the response by item, include the +// primary key values for the items in your request in the 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]in the Amazon DynamoDB Developer Guide. +// +// [Batch Operations and Error Handling]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations +// [Working with Tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations func (c *Client) BatchGetItem(ctx context.Context, params *BatchGetItemInput, optFns ...func(*Options)) (*BatchGetItemOutput, error) { if params == nil { params = &BatchGetItemInput{} @@ -70,59 +84,87 @@ type BatchGetItemInput struct { // A map of one or more table names or table ARNs and, for each table, a map that // describes one or more items to retrieve from that table. Each table name or ARN - // can be used only once per BatchGetItem request. Each element in the map of - // items to retrieve consists of the following: + // 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. + // 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]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]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. + // 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]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. + // instead. For more information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Accessing Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html + // [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html // // 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). + // 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 @@ -132,9 +174,12 @@ type BatchGetItemInput struct { // Represents the output of a BatchGetItem operation. type BatchGetItemOutput struct { - // The read capacity units consumed by the entire BatchGetItem operation. Each - // element consists of: + // 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. ConsumedCapacity []types.ConsumedCapacity @@ -146,16 +191,21 @@ type BatchGetItemOutput struct { // 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. - // For more information, see RequestItems in the Request Parameters section. Each - // element consists of: + // 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. UnprocessedKeys map[string]types.KeysAndAttributes diff --git a/service/dynamodb/api_op_BatchWriteItem.go b/service/dynamodb/api_op_BatchWriteItem.go index cae206a0a91..086141482ec 100644 --- a/service/dynamodb/api_op_BatchWriteItem.go +++ b/service/dynamodb/api_op_BatchWriteItem.go @@ -17,57 +17,78 @@ import ( // 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 +// JSON format for the API call. For more details on this distinction, see [Naming Rules and Data Types]. +// +// 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 -// resend the requests. Typically, you would call BatchWriteItem in a loop. Each +// 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 resend +// the requests. Typically, you would call BatchWriteItem in a loop. Each // iteration would check for unprocessed items and submit a new BatchWriteItem -// 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 -// 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 -// 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 -// put and delete operations in parallel, giving you the power of the thread pool -// approach without having to introduce complexity into your application. Parallel -// processing reduces latency, but each specified put and delete request consumes -// the same number of write capacity units whether it is processed in parallel or -// 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: +// 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 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] 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 put and delete operations in parallel, +// giving you the power of the thread pool approach without having to introduce +// complexity into your application. +// +// Parallel processing reduces latency, but each specified put and delete request +// consumes the same number of write capacity units whether it is processed in +// parallel or 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. +// +// [Batch Operations and Error Handling]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations +// [Naming Rules and Data Types]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html func (c *Client) BatchWriteItem(ctx context.Context, params *BatchWriteItemInput, optFns ...func(*Options)) (*BatchWriteItemOutput, error) { if params == nil { params = &BatchWriteItemInput{} @@ -89,36 +110,47 @@ type BatchWriteItemInput struct { // A map of one or more table names or table ARNs 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. + // 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). + // 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 @@ -134,46 +166,62 @@ 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: + // 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: + // 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. + // 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 // 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 or table ARN and, for that + // information, see RequestItems in the Request Parameters section. + // + // Each UnprocessedItems entry consists of a table name or table ARN 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. + // 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 diff --git a/service/dynamodb/api_op_CreateBackup.go b/service/dynamodb/api_op_CreateBackup.go index 19161558e0d..1a92e7238d5 100644 --- a/service/dynamodb/api_op_CreateBackup.go +++ b/service/dynamodb/api_op_CreateBackup.go @@ -12,23 +12,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a backup for an existing table. Each time you create an on-demand -// backup, the entire table data is backed up. There is no limit to the number of -// on-demand backups that can be taken. When you create an on-demand backup, a time -// marker of the request is cataloged, and the backup is created asynchronously, by -// applying all changes until the time of the request to the last full table -// snapshot. Backup requests are processed instantaneously and become available for -// restore within minutes. You can call CreateBackup at a maximum rate of 50 times -// per second. All backups in DynamoDB work without consuming any provisioned -// throughput on the table. If you submit a backup request on 2018-12-14 at -// 14:25:00, the backup is guaranteed to contain all data committed to the table up -// to 14:24:00, and data committed after 14:26:00 will not be. The backup might -// contain data modifications made between 14:24:00 and 14:26:00. On-demand backup -// does not support causal consistency. Along with data, the following are also -// included on the backups: +// Creates a backup for an existing table. +// +// Each time you create an on-demand backup, the entire table data is backed up. +// There is no limit to the number of on-demand backups that can be taken. +// +// When you create an on-demand backup, a time marker of the request is cataloged, +// and the backup is created asynchronously, by applying all changes until the time +// of the request to the last full table snapshot. Backup requests are processed +// instantaneously and become available for restore within minutes. +// +// You can call CreateBackup at a maximum rate of 50 times per second. +// +// All backups in DynamoDB work without consuming any provisioned throughput on +// the table. +// +// If you submit a backup request on 2018-12-14 at 14:25:00, the backup is +// guaranteed to contain all data committed to the table up to 14:24:00, and data +// committed after 14:26:00 will not be. The backup might contain data +// modifications made between 14:24:00 and 14:26:00. On-demand backup does not +// support causal consistency. +// +// Along with data, the following are also included on the backups: +// // - 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 { diff --git a/service/dynamodb/api_op_CreateGlobalTable.go b/service/dynamodb/api_op_CreateGlobalTable.go index 693a39d1eae..2e46ef1f6b6 100644 --- a/service/dynamodb/api_op_CreateGlobalTable.go +++ b/service/dynamodb/api_op_CreateGlobalTable.go @@ -14,41 +14,56 @@ 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) -// when creating new global tables, as it provides greater flexibility, higher +// name in the provided Regions. +// +// This operation only applies to [Version 2017.11.29 (Legacy)] of global tables. We recommend using [Version 2019.11.21 (Current)] 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]. To update existing global tables +// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables]. +// +// 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. // // 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. +// 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. +// +// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Version 2017.11.29 (Legacy)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html 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 19f9a7aa962..621676042fd 100644 --- a/service/dynamodb/api_op_CreateTable.go +++ b/service/dynamodb/api_op_CreateTable.go @@ -15,15 +15,19 @@ import ( // The CreateTable operation adds a new table to your account. In an Amazon Web // 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 -// 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. +// 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 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. func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) { if params == nil { params = &CreateTableInput{} @@ -49,25 +53,38 @@ 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) - // in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is - // composed of: + // array. For more information, see [Data Model]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 + // // 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 - // 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. + // 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 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 - // 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) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Data Model]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html + // [Working with Tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key // // This member is required. KeySchema []types.KeySchemaElement @@ -80,12 +97,15 @@ 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) - // . + // PROVISIONED sets the billing mode to [Provisioned Mode]. + // // - 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) - // . + // workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode]. + // + // [On-Demand Mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand + // [Provisioned Mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual BillingMode types.BillingMode // Indicates whether deletion protection is to be enabled (true) or disabled @@ -94,23 +114,32 @@ 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. GlobalSecondaryIndexes []types.GlobalSecondaryIndex @@ -118,21 +147,30 @@ type CreateTableInput struct { // One or more local secondary indexes (the maximum is 5) to be created on the // table. Each index is scoped to a given partition key value. There is a 10 GB // 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: + // 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 @@ -146,39 +184,52 @@ type CreateTableInput struct { OnDemandThroughput *types.OnDemandThroughput // 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 - // minimum and maximum provisioned throughput values, see Service, Account, and - // Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) - // in the Amazon DynamoDB Developer Guide. + // 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 minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the + // Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html ProvisionedThroughput *types.ProvisionedThroughput // An Amazon Web Services resource-based policy document in JSON format that will - // be attached to the table. When you attach a resource-based policy while creating - // a table, the policy application is strongly consistent. The maximum size - // supported for a resource-based policy document is 20 KB. DynamoDB counts - // whitespaces when calculating the size of a policy against this limit. For a full - // list of all considerations that apply for resource-based policies, see - // Resource-based policy considerations (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html) - // . + // be attached to the table. + // + // When you attach a resource-based policy while creating a table, the policy + // application is strongly consistent. + // + // The maximum size supported for a resource-based policy document is 20 KB. + // DynamoDB counts whitespaces when calculating the size of a policy against this + // limit. For a full list of all considerations that apply for resource-based + // policies, see [Resource-based policy considerations]. + // + // [Resource-based policy considerations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html ResourcePolicy *string // Represents the settings used to enable server-side encryption. 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. StreamSpecification *types.StreamSpecification @@ -187,9 +238,9 @@ type CreateTableInput struct { // 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) - // . + // A list of key-value pairs to label the table. For more information, see [Tagging for DynamoDB]. + // + // [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_DeleteBackup.go b/service/dynamodb/api_op_DeleteBackup.go index 0d847ed08ad..26f5dbedfe2 100644 --- a/service/dynamodb/api_op_DeleteBackup.go +++ b/service/dynamodb/api_op_DeleteBackup.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing backup of a table. You can call DeleteBackup at a maximum -// rate of 10 times per second. +// Deletes an existing backup of a table. +// +// You can call DeleteBackup at a maximum rate of 10 times per second. func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, optFns ...func(*Options)) (*DeleteBackupOutput, error) { if params == nil { params = &DeleteBackupInput{} diff --git a/service/dynamodb/api_op_DeleteItem.go b/service/dynamodb/api_op_DeleteItem.go index eab33851345..b111cb620ca 100644 --- a/service/dynamodb/api_op_DeleteItem.go +++ b/service/dynamodb/api_op_DeleteItem.go @@ -14,13 +14,18 @@ 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. +// 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. +// 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,10 +45,12 @@ func (c *Client) DeleteItem(ctx context.Context, params *DeleteItemInput, optFns 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 - // 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. + // 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. // // This member is required. Key map[string]types.AttributeValue @@ -55,70 +62,111 @@ type DeleteItemInput struct { TableName *string // A condition that must be satisfied in order for a conditional DeleteItem to - // succeed. An expression can contain any of the following: + // 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. + // 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. + // + // For more information about condition expressions, see [Condition Expressions] in the Amazon DynamoDB + // Developer Guide. + // + // [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [ConditionalOperator]in the Amazon DynamoDB Developer Guide. + // + // [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Expected]in the Amazon DynamoDB Developer Guide. + // + // [Expected]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":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) - // in the Amazon DynamoDB Developer Guide. + // One or more values that can be substituted in an expression. + // + // Use the : (colon) character in an expression to dereference an attribute value. + // For example, suppose that you wanted to check whether the value of the + // ProductStatus attribute was one of the following: + // + // Available | Backordered | Discontinued + // + // You would first need to specify ExpressionAttributeValues as follows: + // + // { ":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] in the Amazon + // DynamoDB Developer Guide. + // + // [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html 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). + // 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 @@ -130,20 +178,26 @@ type DeleteItemInput struct { // 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 . + // 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 // An optional parameter that returns the item attributes for a DeleteItem - // operation that failed a condition check. 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. + // operation that failed a condition check. + // + // 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. ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure noSmithyDocumentSerde @@ -161,24 +215,30 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Provisioned Throughput]in the Amazon DynamoDB Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html ConsumedCapacity *types.ConsumedCapacity // Information about item collections, if any, that were affected by the DeleteItem // operation. ItemCollectionMetrics is only returned if the // 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. + // 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_DeleteResourcePolicy.go b/service/dynamodb/api_op_DeleteResourcePolicy.go index 05247546fc6..64436f59797 100644 --- a/service/dynamodb/api_op_DeleteResourcePolicy.go +++ b/service/dynamodb/api_op_DeleteResourcePolicy.go @@ -12,13 +12,17 @@ import ( ) // Deletes the resource-based policy attached to the resource, which can be a -// table or stream. DeleteResourcePolicy is an idempotent operation; running it -// multiple times on the same resource doesn't result in an error response, unless -// you specify an ExpectedRevisionId , which will then return a -// PolicyNotFoundException . To make sure that you don't inadvertently lock -// yourself out of your own resources, the root principal in your Amazon Web -// Services account can perform DeleteResourcePolicy requests, even if your -// resource-based policy explicitly denies the root principal's access. +// table or stream. +// +// DeleteResourcePolicy is an idempotent operation; running it multiple times on +// the same resource doesn't result in an error response, unless you specify an +// ExpectedRevisionId , which will then return a PolicyNotFoundException . +// +// To make sure that you don't inadvertently lock yourself out of your own +// resources, the root principal in your Amazon Web Services account can perform +// DeleteResourcePolicy requests, even if your resource-based policy explicitly +// denies the root principal's access. +// // DeleteResourcePolicy is an asynchronous operation. If you issue a // GetResourcePolicy request immediately after running the DeleteResourcePolicy // request, DynamoDB might still return the deleted policy. This is because the @@ -62,8 +66,10 @@ type DeleteResourcePolicyInput struct { type DeleteResourcePolicyOutput struct { // A unique string that represents the revision ID of the policy. If you're - // comparing revision IDs, make sure to always use string comparison logic. This - // value will be empty if you make a request against a resource without a policy. + // comparing revision IDs, make sure to always use string comparison logic. + // + // This value will be empty if you make a request against a resource without a + // policy. RevisionId *string // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_DeleteTable.go b/service/dynamodb/api_op_DeleteTable.go index 00d36f83d3c..4fdcac822fe 100644 --- a/service/dynamodb/api_op_DeleteTable.go +++ b/service/dynamodb/api_op_DeleteTable.go @@ -18,15 +18,23 @@ import ( // 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. +// state, no error is returned. +// +// This operation only applies to [Version 2019.11.21 (Current)] 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. +// +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html 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_DescribeBackup.go b/service/dynamodb/api_op_DescribeBackup.go index 845ccd7b476..82b098a3783 100644 --- a/service/dynamodb/api_op_DescribeBackup.go +++ b/service/dynamodb/api_op_DescribeBackup.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an existing backup of a table. You can call DescribeBackup at a -// maximum rate of 10 times per second. +// Describes an existing backup of a table. +// +// You can call DescribeBackup at a maximum rate of 10 times per second. func (c *Client) DescribeBackup(ctx context.Context, params *DescribeBackupInput, optFns ...func(*Options)) (*DescribeBackupOutput, error) { if params == nil { params = &DescribeBackupInput{} diff --git a/service/dynamodb/api_op_DescribeContinuousBackups.go b/service/dynamodb/api_op_DescribeContinuousBackups.go index 2f60a65d3d9..fc3980f41cc 100644 --- a/service/dynamodb/api_op_DescribeContinuousBackups.go +++ b/service/dynamodb/api_op_DescribeContinuousBackups.go @@ -15,12 +15,16 @@ 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. +// 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{} @@ -39,8 +43,10 @@ func (c *Client) DescribeContinuousBackups(ctx context.Context, params *Describe type DescribeContinuousBackupsInput struct { // Name of the table for which the customer wants to check the continuous backups - // and point in time recovery settings. You can also provide the Amazon Resource - // Name (ARN) of the table in this parameter. + // and point in time recovery settings. + // + // You can also provide the Amazon Resource Name (ARN) of the table in this + // parameter. // // This member is required. TableName *string diff --git a/service/dynamodb/api_op_DescribeContributorInsights.go b/service/dynamodb/api_op_DescribeContributorInsights.go index c983b639659..dd6babdac7f 100644 --- a/service/dynamodb/api_op_DescribeContributorInsights.go +++ b/service/dynamodb/api_op_DescribeContributorInsights.go @@ -51,15 +51,20 @@ 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: + // 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 diff --git a/service/dynamodb/api_op_DescribeEndpoints.go b/service/dynamodb/api_op_DescribeEndpoints.go index b542bfcc65d..fec3a66345c 100644 --- a/service/dynamodb/api_op_DescribeEndpoints.go +++ b/service/dynamodb/api_op_DescribeEndpoints.go @@ -12,8 +12,9 @@ import ( ) // Returns the regional endpoint information. 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) -// . +// permissions, please see [Internetwork traffic privacy]. +// +// [Internetwork traffic 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 541772f651b..b1edcd0b060 100644 --- a/service/dynamodb/api_op_DescribeGlobalTable.go +++ b/service/dynamodb/api_op_DescribeGlobalTable.go @@ -12,15 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// when creating new global tables, as it provides greater flexibility, higher +// Returns information about the specified global table. +// +// This operation only applies to [Version 2017.11.29 (Legacy)] of global tables. We recommend using [Version 2019.11.21 (Current)] 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]. To update existing global tables +// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables]. +// +// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Version 2017.11.29 (Legacy)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.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 031d4381235..51923dd13d7 100644 --- a/service/dynamodb/api_op_DescribeGlobalTableSettings.go +++ b/service/dynamodb/api_op_DescribeGlobalTableSettings.go @@ -12,15 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// when creating new global tables, as it provides greater flexibility, higher +// Describes Region-specific settings for a global table. +// +// This operation only applies to [Version 2017.11.29 (Legacy)] of global tables. We recommend using [Version 2019.11.21 (Current)] 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]. To update existing global tables +// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables]. +// +// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Version 2017.11.29 (Legacy)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.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 2b3961581a1..d61fd09d2b8 100644 --- a/service/dynamodb/api_op_DescribeImport.go +++ b/service/dynamodb/api_op_DescribeImport.go @@ -29,7 +29,7 @@ func (c *Client) DescribeImport(ctx context.Context, params *DescribeImportInput type DescribeImportInput struct { - // The Amazon Resource Name (ARN) associated with the table you're importing to. + // The Amazon Resource Name (ARN) associated with the table you're importing to. // // This member is required. ImportArn *string @@ -39,7 +39,7 @@ type DescribeImportInput struct { type DescribeImportOutput struct { - // Represents the properties of the table created for the import, and parameters + // 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. // diff --git a/service/dynamodb/api_op_DescribeLimits.go b/service/dynamodb/api_op_DescribeLimits.go index cd60d4f8de7..cfd9fbf7322 100644 --- a/service/dynamodb/api_op_DescribeLimits.go +++ b/service/dynamodb/api_op_DescribeLimits.go @@ -13,42 +13,64 @@ import ( // Returns the current provisioned-capacity quotas for your Amazon Web Services // account in a Region, both for the Region as a whole and for any one DynamoDB -// table that you create there. When you establish an Amazon Web Services account, -// 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) -// 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: +// table that you create there. +// +// When you establish an Amazon Web Services account, 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]page in the Amazon DynamoDB Developer Guide. +// +// Although you can increase these quotas by filing a case at [Amazon Web Services Support Center], 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. // // 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 +// 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. +// 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. +// +// [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html +// [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/home#/ func (c *Client) DescribeLimits(ctx context.Context, params *DescribeLimitsInput, optFns ...func(*Options)) (*DescribeLimitsOutput, error) { if params == nil { params = &DescribeLimitsInput{} diff --git a/service/dynamodb/api_op_DescribeTable.go b/service/dynamodb/api_op_DescribeTable.go index 29861d9b443..089fa9af227 100644 --- a/service/dynamodb/api_op_DescribeTable.go +++ b/service/dynamodb/api_op_DescribeTable.go @@ -18,13 +18,17 @@ 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) -// of global tables. If you issue a DescribeTable request immediately after a -// 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. +// when it was created, the primary key schema, and any indexes on the table. +// +// This operation only applies to [Version 2019.11.21 (Current)] of global tables. +// +// If you issue a DescribeTable request immediately after a 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. +// +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html func (c *Client) DescribeTable(ctx context.Context, params *DescribeTableInput, optFns ...func(*Options)) (*DescribeTableOutput, error) { if params == nil { params = &DescribeTableInput{} @@ -234,12 +238,13 @@ type TableExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTableInput, *DescribeTableOutput, error) (bool, error) } @@ -412,12 +417,13 @@ type TableNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTableInput, *DescribeTableOutput, error) (bool, error) } diff --git a/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go b/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go index 0008f9d1e83..77aa2993d4e 100644 --- a/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go +++ b/service/dynamodb/api_op_DescribeTableReplicaAutoScaling.go @@ -12,8 +12,10 @@ 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) -// of global tables. +// +// This operation only applies to [Version 2019.11.21 (Current)] of global tables. +// +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html func (c *Client) DescribeTableReplicaAutoScaling(ctx context.Context, params *DescribeTableReplicaAutoScalingInput, optFns ...func(*Options)) (*DescribeTableReplicaAutoScalingOutput, error) { if params == nil { params = &DescribeTableReplicaAutoScalingInput{} diff --git a/service/dynamodb/api_op_ExecuteStatement.go b/service/dynamodb/api_op_ExecuteStatement.go index df979dfe5cf..30445956817 100644 --- a/service/dynamodb/api_op_ExecuteStatement.go +++ b/service/dynamodb/api_op_ExecuteStatement.go @@ -12,12 +12,15 @@ 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 -// 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 -// clause does not match any data, the read will return an empty result set. A -// single SELECT statement response can return up to the maximum number of items +// 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 clause does not match any +// data, the read will return an empty result set. +// +// A single SELECT statement response can return up to the maximum number of items // (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 @@ -67,20 +70,27 @@ 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). + // 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 // An optional parameter that returns the item attributes for an ExecuteStatement - // operation that failed a condition check. 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. + // operation that failed a condition check. + // + // 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. ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure noSmithyDocumentSerde @@ -91,8 +101,10 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // request asked for it. For more information, see [Provisioned Throughput]in the Amazon DynamoDB + // Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html ConsumedCapacity *types.ConsumedCapacity // If a read operation was used, this property will contain the result of the read diff --git a/service/dynamodb/api_op_ExecuteTransaction.go b/service/dynamodb/api_op_ExecuteTransaction.go index 44b71fbcb97..7c44e2b5af7 100644 --- a/service/dynamodb/api_op_ExecuteTransaction.go +++ b/service/dynamodb/api_op_ExecuteTransaction.go @@ -12,12 +12,14 @@ import ( ) // This operation allows you to perform transactional reads or writes on data -// stored in DynamoDB, using PartiQL. The entire transaction must consist of either -// 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) -// API. +// stored in DynamoDB, using PartiQL. +// +// The entire transaction must consist of either 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] API. +// +// [TransactWriteItems]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems func (c *Client) ExecuteTransaction(ctx context.Context, params *ExecuteTransactionInput, optFns ...func(*Options)) (*ExecuteTransactionOutput, error) { if params == nil { params = &ExecuteTransactionInput{} @@ -45,10 +47,10 @@ type ExecuteTransactionInput struct { ClientRequestToken *string // 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) - // . + // consumption that is returned in the response. For more information, see [TransactGetItems]and [TransactWriteItems]. + // + // [TransactWriteItems]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html + // [TransactGetItems]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html ReturnConsumedCapacity types.ReturnConsumedCapacity noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_ExportTableToPointInTime.go b/service/dynamodb/api_op_ExportTableToPointInTime.go index 297f6de3674..97b57a51a31 100644 --- a/service/dynamodb/api_op_ExportTableToPointInTime.go +++ b/service/dynamodb/api_op_ExportTableToPointInTime.go @@ -44,12 +44,15 @@ type ExportTableToPointInTimeInput struct { // Providing a ClientToken makes the call to ExportTableToPointInTimeInput // idempotent, meaning that multiple identical calls have the same effect as one - // single call. A client token is valid for 8 hours after the first request that - // uses it is completed. After 8 hours, any request with the same client token is - // treated as a new request. Do not resubmit the same request with the same client - // token for more than 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 + // single call. + // + // A client token is valid for 8 hours after the first request that uses it is + // completed. After 8 hours, any request with the same client token is treated as a + // new request. Do not resubmit the same request with the same client token for + // more than 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 . ClientToken *string @@ -72,8 +75,10 @@ type ExportTableToPointInTimeInput struct { IncrementalExportSpecification *types.IncrementalExportSpecification // The ID of the Amazon Web Services account that owns the bucket the export will - // be stored in. S3BucketOwner is a required parameter when exporting to a S3 - // bucket in another account. + // be stored in. + // + // S3BucketOwner is a required parameter when exporting to a S3 bucket in another + // account. S3BucketOwner *string // The Amazon S3 bucket prefix to use as the file name and path of the exported @@ -82,7 +87,9 @@ 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 S3SseAlgorithm types.S3SseAlgorithm diff --git a/service/dynamodb/api_op_GetItem.go b/service/dynamodb/api_op_GetItem.go index 6d5ef8eca93..bc59518f1fb 100644 --- a/service/dynamodb/api_op_GetItem.go +++ b/service/dynamodb/api_op_GetItem.go @@ -14,11 +14,12 @@ import ( // The GetItem operation returns a set of attributes for the item with the given // 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. +// 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. func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...func(*Options)) (*GetItemOutput, error) { if params == nil { params = &GetItemInput{} @@ -38,10 +39,12 @@ func (c *Client) GetItem(ctx context.Context, params *GetItemInput, optFns ...fu 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 - // 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. + // 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. // // This member is required. Key map[string]types.AttributeValue @@ -53,8 +56,9 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide. + // + // [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html AttributesToGet []string // Determines the read consistency model: If set to true , then the operation uses @@ -64,46 +68,67 @@ type GetItemInput struct { // 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string // 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 Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html 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). + // 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 @@ -117,8 +142,9 @@ type GetItemOutput 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Provisioned Throughput]in the Amazon DynamoDB Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads ConsumedCapacity *types.ConsumedCapacity // A map of attribute names to AttributeValue objects, as specified by diff --git a/service/dynamodb/api_op_GetResourcePolicy.go b/service/dynamodb/api_op_GetResourcePolicy.go index 02ce13977ee..f578473d46f 100644 --- a/service/dynamodb/api_op_GetResourcePolicy.go +++ b/service/dynamodb/api_op_GetResourcePolicy.go @@ -12,28 +12,35 @@ import ( ) // Returns the resource-based policy document attached to the resource, which can -// be a table or stream, in JSON format. GetResourcePolicy follows an eventually -// consistent (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) -// model. The following list describes the outcomes when you issue the -// GetResourcePolicy request immediately after issuing another request: +// be a table or stream, in JSON format. +// +// GetResourcePolicy follows an [eventually consistent] model. The following list describes the outcomes +// when you issue the GetResourcePolicy request immediately after issuing another +// request: +// // - If you issue a GetResourcePolicy request immediately after a // PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException . +// // - If you issue a GetResourcePolicy request immediately after a // DeleteResourcePolicy request, DynamoDB might return the policy that was // present before the deletion request. +// // - If you issue a GetResourcePolicy request immediately after a CreateTable // request, which includes a resource-based policy, DynamoDB might return a // ResourceNotFoundException or a PolicyNotFoundException . // // Because GetResourcePolicy uses an eventually consistent query, the metadata for // your policy or table might not be available at that moment. Wait for a few -// seconds, and then retry the GetResourcePolicy request. After a GetResourcePolicy -// request returns a policy created using the PutResourcePolicy request, the -// policy will be applied in the authorization of requests to the resource. Because -// this process is eventually consistent, it will take some time to apply the -// policy to all requests to a resource. Policies that you attach while creating a -// table using the CreateTable request will always be applied to all requests for -// that table. +// seconds, and then retry the GetResourcePolicy request. +// +// After a GetResourcePolicy request returns a policy created using the +// PutResourcePolicy request, the policy will be applied in the authorization of +// requests to the resource. Because this process is eventually consistent, it will +// take some time to apply the policy to all requests to a resource. Policies that +// you attach while creating a table using the CreateTable request will always be +// applied to all requests for that table. +// +// [eventually consistent]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) { if params == nil { params = &GetResourcePolicyInput{} diff --git a/service/dynamodb/api_op_ImportTable.go b/service/dynamodb/api_op_ImportTable.go index fd134a68b46..fb8386675e6 100644 --- a/service/dynamodb/api_op_ImportTable.go +++ b/service/dynamodb/api_op_ImportTable.go @@ -29,13 +29,13 @@ 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 , + // The format of the source data. Valid values for ImportFormat are CSV , // DYNAMODB_JSON or ION . // // This member is required. InputFormat types.InputFormat - // The S3 bucket that provides the source for the import. + // The S3 bucket that provides the source for the import. // // This member is required. S3BucketSource *types.S3BucketSource @@ -46,19 +46,22 @@ type ImportTableInput struct { TableCreationParameters *types.TableCreationParameters // Providing a ClientToken makes the call to ImportTableInput idempotent, meaning - // that multiple identical calls have the same effect as one single call. A client - // token is valid for 8 hours after the first request that uses it is completed. - // After 8 hours, any request with the same client token is treated as a new - // request. Do not resubmit the same request with the same client token for more - // than 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 IdempotentParameterMismatch exception. + // that multiple identical calls have the same effect as one single call. + // + // A client token is valid for 8 hours after the first request that uses it is + // completed. After 8 hours, any request with the same client token is treated as a + // new request. Do not resubmit the same request with the same client token for + // more than 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 + // IdempotentParameterMismatch exception. ClientToken *string - // Type of compression to be used on the input coming from the imported table. + // Type of compression to be used on the input coming from the imported table. InputCompressionType types.InputCompressionType - // Additional properties that specify how the input is formatted, + // Additional properties that specify how the input is formatted, InputFormatOptions *types.InputFormatOptions noSmithyDocumentSerde @@ -66,7 +69,7 @@ type ImportTableInput struct { type ImportTableOutput struct { - // Represents the properties of the table created for the import, and parameters + // 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. // diff --git a/service/dynamodb/api_op_ListBackups.go b/service/dynamodb/api_op_ListBackups.go index 50a5ca3f9d9..531fa62487c 100644 --- a/service/dynamodb/api_op_ListBackups.go +++ b/service/dynamodb/api_op_ListBackups.go @@ -17,12 +17,17 @@ import ( // and weren't made with Amazon Web Services Backup. To list these 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 -// time at which the original backup was requested. You can call ListBackups a -// maximum of five times per second. If you want to retrieve the complete list of -// backups made with Amazon Web Services Backup, use the Amazon Web Services -// Backup list API. (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html) +// 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 time at which the original backup was requested. +// +// You can call ListBackups a maximum of five times per second. +// +// If you want to retrieve the complete list of backups made with Amazon Web +// Services Backup, use the [Amazon Web Services Backup list API.] +// +// [Amazon Web Services Backup list API.]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html func (c *Client) ListBackups(ctx context.Context, params *ListBackupsInput, optFns ...func(*Options)) (*ListBackupsOutput, error) { if params == nil { params = &ListBackupsInput{} @@ -40,11 +45,15 @@ func (c *Client) ListBackups(ctx context.Context, params *ListBackupsInput, optF type ListBackupsInput struct { - // The backups from the table specified by BackupType are listed. Where BackupType - // can be: + // 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). BackupType types.BackupTypeFilter @@ -78,14 +87,17 @@ type ListBackupsOutput struct { // List of BackupSummary objects. BackupSummaries []types.BackupSummary - // The ARN of the backup last evaluated when the current page of results was + // 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_ListGlobalTables.go b/service/dynamodb/api_op_ListGlobalTables.go index 75fb71ef6f7..083679e634c 100644 --- a/service/dynamodb/api_op_ListGlobalTables.go +++ b/service/dynamodb/api_op_ListGlobalTables.go @@ -12,15 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// when creating new global tables, as it provides greater flexibility, higher +// Lists all global tables that have a replica in the specified Region. +// +// This operation only applies to [Version 2017.11.29 (Legacy)] of global tables. We recommend using [Version 2019.11.21 (Current)] 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]. To update existing global tables +// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables]. +// +// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Version 2017.11.29 (Legacy)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html func (c *Client) ListGlobalTables(ctx context.Context, params *ListGlobalTablesInput, optFns ...func(*Options)) (*ListGlobalTablesOutput, error) { if params == nil { params = &ListGlobalTablesInput{} @@ -42,10 +45,12 @@ type ListGlobalTablesInput struct { ExclusiveStartGlobalTableName *string // The maximum number of table names to return, if the parameter is not specified - // DynamoDB defaults to 100. If the number of global tables DynamoDB finds reaches - // this limit, it stops the operation and returns the table names collected up to - // that point, with a table name in the LastEvaluatedGlobalTableName to apply in a - // subsequent operation to the ExclusiveStartGlobalTableName parameter. + // DynamoDB defaults to 100. + // + // If the number of global tables DynamoDB finds reaches this limit, it stops the + // operation and returns the table names collected up to that point, with a table + // name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to + // the ExclusiveStartGlobalTableName parameter. Limit *int32 // Lists the global tables in a specific Region. diff --git a/service/dynamodb/api_op_ListImports.go b/service/dynamodb/api_op_ListImports.go index 7d4e34fd649..fe30fd4a4a7 100644 --- a/service/dynamodb/api_op_ListImports.go +++ b/service/dynamodb/api_op_ListImports.go @@ -29,15 +29,15 @@ 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 + // 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 // next page of results. NextToken *string - // The number of ImportSummary objects returned in a single page. + // The number of ImportSummary objects returned in a single page. PageSize *int32 - // The Amazon Resource Name (ARN) associated with the table that was imported to. + // The Amazon Resource Name (ARN) associated with the table that was imported to. TableArn *string noSmithyDocumentSerde @@ -45,10 +45,10 @@ type ListImportsInput struct { type ListImportsOutput struct { - // A list of ImportSummary objects. + // A list of ImportSummary objects. ImportSummaryList []types.ImportSummary - // If this value is returned, there are additional results to be displayed. To + // If this value is returned, there are additional results to be displayed. To // retrieve them, call ListImports again, with NextToken set to this value. NextToken *string @@ -149,7 +149,7 @@ var _ ListImportsAPIClient = (*Client)(nil) // ListImportsPaginatorOptions is the paginator options for ListImports type ListImportsPaginatorOptions struct { - // The number of ImportSummary objects returned in a single page. + // The number of ImportSummary objects returned in a single page. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/dynamodb/api_op_ListTables.go b/service/dynamodb/api_op_ListTables.go index f59311d6006..ffed1105dca 100644 --- a/service/dynamodb/api_op_ListTables.go +++ b/service/dynamodb/api_op_ListTables.go @@ -49,16 +49,18 @@ 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 - // LastEvaluatedTableName value in the response, this means that there are no more - // table names to be retrieved. + // 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 // The names of the tables associated with the current account at the current - // endpoint. The maximum size of this array is 100. If LastEvaluatedTableName also - // appears in the output, you can use this value as the ExclusiveStartTableName - // parameter in a subsequent ListTables request and obtain the next page of - // results. + // endpoint. The maximum size of this array is 100. + // + // If LastEvaluatedTableName also appears in the output, you can use this value as + // the ExclusiveStartTableName parameter in a subsequent ListTables request and + // obtain the next page of results. TableNames []string // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_ListTagsOfResource.go b/service/dynamodb/api_op_ListTagsOfResource.go index 8f604bb024d..700093d158e 100644 --- a/service/dynamodb/api_op_ListTagsOfResource.go +++ b/service/dynamodb/api_op_ListTagsOfResource.go @@ -13,9 +13,12 @@ import ( ) // 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. +// up to 10 times per second, per account. +// +// For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the Amazon DynamoDB +// Developer Guide. +// +// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html func (c *Client) ListTagsOfResource(ctx context.Context, params *ListTagsOfResourceInput, optFns ...func(*Options)) (*ListTagsOfResourceOutput, error) { if params == nil { params = &ListTagsOfResourceInput{} diff --git a/service/dynamodb/api_op_PutItem.go b/service/dynamodb/api_op_PutItem.go index 39336006bd7..a186e341be9 100644 --- a/service/dynamodb/api_op_PutItem.go +++ b/service/dynamodb/api_op_PutItem.go @@ -18,18 +18,28 @@ import ( // 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 -// with a ValidationException exception. To prevent a new item from replacing an -// existing item, use a conditional expression that contains the -// attribute_not_exists function with the name 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) -// in the Amazon DynamoDB Developer Guide. +// 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 with a ValidationException +// exception. +// +// To prevent a new item from replacing an existing item, use a conditional +// expression that contains the attribute_not_exists function with the name 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] in the Amazon DynamoDB Developer +// Guide. +// +// [Working with Items]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html func (c *Client) PutItem(ctx context.Context, params *PutItemInput, optFns ...func(*Options)) (*PutItemOutput, error) { if params == nil { params = &PutItemInput{} @@ -50,18 +60,27 @@ type PutItemInput struct { // A map of attribute name/value pairs, one for each attribute. Only the primary // key attributes are required; you can optionally provide other attribute - // name-value pairs for the item. You must provide all of the attributes for the - // primary key. 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 both - // values for both the partition key and the sort key. 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. + // name-value pairs for the item. + // + // You must provide all of the attributes for the primary key. 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 both values for both the partition key + // and the sort key. + // + // 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. + // // 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) - // in the Amazon DynamoDB Developer Guide. Each element in the Item map is an - // AttributeValue object. + // as a key attribute for a table or index. + // + // For more information about primary keys, see [Primary Key] in the Amazon DynamoDB Developer + // Guide. + // + // Each element in the Item map is an AttributeValue object. + // + // [Primary Key]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey // // This member is required. Item map[string]types.AttributeValue @@ -73,70 +92,111 @@ type PutItemInput struct { TableName *string // A condition that must be satisfied in order for a conditional PutItem operation - // to succeed. An expression can contain any of the following: + // 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. + // 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. + // + // For more information on condition expressions, see [Condition Expressions] in the Amazon DynamoDB + // Developer Guide. + // + // [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [ConditionalOperator]in the Amazon DynamoDB Developer Guide. + // + // [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Expected]in the Amazon DynamoDB Developer Guide. + // + // [Expected]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":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) - // in the Amazon DynamoDB Developer Guide. + // One or more values that can be substituted in an expression. + // + // Use the : (colon) character in an expression to dereference an attribute value. + // For example, suppose that you wanted to check whether the value of the + // ProductStatus attribute was one of the following: + // + // Available | Backordered | Discontinued + // + // You would first need to specify ExpressionAttributeValues as follows: + // + // { ":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] in the Amazon + // DynamoDB Developer Guide. + // + // [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html 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). + // 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 @@ -148,21 +208,29 @@ type PutItemInput struct { // 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 . + // + // 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 // An optional parameter that returns the item attributes for a PutItem operation - // that failed a condition check. 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. + // that failed a condition check. + // + // 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. ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure noSmithyDocumentSerde @@ -180,24 +248,30 @@ type PutItemOutput 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Provisioned Throughput]in the Amazon DynamoDB Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html ConsumedCapacity *types.ConsumedCapacity // Information about item collections, if any, that were affected by the PutItem // operation. ItemCollectionMetrics is only returned if the // 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. + // 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_PutResourcePolicy.go b/service/dynamodb/api_op_PutResourcePolicy.go index 5d3e3b13933..8a847f51f28 100644 --- a/service/dynamodb/api_op_PutResourcePolicy.go +++ b/service/dynamodb/api_op_PutResourcePolicy.go @@ -13,17 +13,21 @@ import ( // Attaches a resource-based policy document to the resource, which can be a table // or stream. When you attach a resource-based policy using this API, the policy -// application is eventually consistent (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) -// . PutResourcePolicy is an idempotent operation; running it multiple times on -// the same resource using the same policy document will return the same revision -// ID. If you specify an ExpectedRevisionId that doesn't match the current -// policy's RevisionId , the PolicyNotFoundException will be returned. +// application is [eventually consistent]. +// +// PutResourcePolicy is an idempotent operation; running it multiple times on the +// same resource using the same policy document will return the same revision ID. +// If you specify an ExpectedRevisionId that doesn't match the current policy's +// RevisionId , the PolicyNotFoundException will be returned. +// // PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy // request immediately after a PutResourcePolicy request, DynamoDB might return // your previous policy, if there was one, or return the PolicyNotFoundException . // This is because GetResourcePolicy uses an eventually consistent query, and the // metadata for your policy or table might not be available at that moment. Wait // for a few seconds, and then try the GetResourcePolicy request again. +// +// [eventually consistent]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} @@ -42,27 +46,32 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { // An Amazon Web Services resource-based policy document in JSON format. + // // - The maximum size supported for a resource-based policy document is 20 KB. // DynamoDB counts whitespaces when calculating the size of a policy against this // limit. + // // - Within a resource-based policy, if the action for a DynamoDB service-linked // role (SLR) to replicate data for a global table is denied, adding or deleting a // replica will fail with an error. + // // For a full list of all considerations that apply while attaching a - // resource-based policy, see Resource-based policy considerations (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html) - // . + // resource-based policy, see [Resource-based policy considerations]. + // + // [Resource-based policy considerations]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html // // This member is required. Policy *string // The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy - // will be attached. The resources you can specify include tables and streams. You - // can control index permissions using the base table's policy. To specify the same - // permission level for your table and its indexes, you can provide both the table - // and index Amazon Resource Name (ARN)s in the Resource field of a given Statement - // in your policy document. Alternatively, to specify different permissions for - // your table, indexes, or both, you can define multiple Statement fields in your - // policy document. + // will be attached. The resources you can specify include tables and streams. + // + // You can control index permissions using the base table's policy. To specify the + // same permission level for your table and its indexes, you can provide both the + // table and index Amazon Resource Name (ARN)s in the Resource field of a given + // Statement in your policy document. Alternatively, to specify different + // permissions for your table, indexes, or both, you can define multiple Statement + // fields in your policy document. // // This member is required. ResourceArn *string @@ -73,11 +82,14 @@ type PutResourcePolicyInput struct { // A string value that you can use to conditionally update your policy. You can // provide the revision ID of your existing policy to make mutating requests - // against that policy. When you provide an expected revision ID, if the revision - // ID of the existing policy on the resource doesn't match or if there's no policy - // attached to the resource, your request will be rejected with a - // PolicyNotFoundException . To conditionally attach a policy when no policy exists - // for the resource, specify NO_POLICY for the revision ID. + // against that policy. + // + // When you provide an expected revision ID, if the revision ID of the existing + // policy on the resource doesn't match or if there's no policy attached to the + // resource, your request will be rejected with a PolicyNotFoundException . + // + // To conditionally attach a policy when no policy exists for the resource, + // specify NO_POLICY for the revision ID. ExpectedRevisionId *string noSmithyDocumentSerde diff --git a/service/dynamodb/api_op_Query.go b/service/dynamodb/api_op_Query.go index 83805f8d8f1..a2b02897920 100644 --- a/service/dynamodb/api_op_Query.go +++ b/service/dynamodb/api_op_Query.go @@ -15,40 +15,53 @@ import ( // You must provide the name of the partition key attribute and a single value for // that attribute. Query returns all items with that partition key value. // Optionally, you can provide a sort key attribute and use a comparison operator -// to refine the search results. Use the KeyConditionExpression parameter to -// 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) -// 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. +// to refine the search results. +// +// Use the KeyConditionExpression parameter to 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]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. +// +// [Paginating the Results]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) { if params == nil { params = &QueryInput{} @@ -74,72 +87,106 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide. + // + // [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html 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) - // in the Amazon DynamoDB Developer Guide. + // see [ConditionalOperator]in the Amazon DynamoDB Developer Guide. + // + // [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html ConditionalOperator types.ConditionalOperator // 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 + // 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 . 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":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) - // in the Amazon DynamoDB Developer Guide. + // One or more values that can be substituted in an expression. + // + // Use the : (colon) character in an expression to dereference an attribute value. + // For example, suppose that you wanted to check whether the value of the + // ProductStatus attribute was one of the following: + // + // Available | Backordered | Discontinued + // + // You would first need to specify ExpressionAttributeValues as follows: + // + // { ":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] in the Amazon + // DynamoDB Developer Guide. + // + // [Specifying Conditions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html ExpressionAttributeValues map[string]types.AttributeValue // A string that contains conditions that DynamoDB applies after the Query // operation, but before the data is returned to you. Items that do not satisfy the - // FilterExpression criteria are not returned. A FilterExpression does not allow - // 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/Query.FilterExpression.html) - // in the Amazon DynamoDB Developer Guide. + // FilterExpression criteria are not returned. + // + // A FilterExpression does not allow 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] in the Amazon DynamoDB Developer Guide. + // + // [Filter Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html FilterExpression *string // The name of an index to query. This index can be any local secondary index or @@ -148,16 +195,26 @@ type QueryInput struct { IndexName *string // The condition that specifies the key values for items to be retrieved by the - // Query action. The condition must perform an equality test on a single partition - // key value. The condition can optionally perform one of several comparison tests - // on a single sort key value. This allows Query to retrieve one item with a given + // Query action. + // + // The condition must perform an equality test on a single partition key value. + // + // The condition can optionally perform one of several comparison tests on a + // single sort key value. This allows Query to retrieve one item with a given // partition key value and sort key value, or several items that have the same - // 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: - // partitionKeyName + // 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: + // + // partitionKeyName + // // = // // :partitionkeyval @@ -167,45 +224,64 @@ type QueryInput struct { // sortKeyName // // = - // :sortkeyval Valid comparisons for the sort key condition are as follows: + // + // :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 . + // // - 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: + // :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) - // 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) - // in the Amazon DynamoDB Developer Guide. + // + // For a list of reserved words, see [Reserved Words] in the Amazon DynamoDB Developer Guide. + // + // For more information on ExpressionAttributeNames and ExpressionAttributeValues , + // see [Using Placeholders for Attribute Names and Values]in the Amazon DynamoDB Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Using Placeholders for Attribute Names and Values]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [KeyConditions]in the Amazon DynamoDB Developer Guide. + // + // [KeyConditions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html KeyConditions map[string]types.Condition // The maximum number of items to evaluate (not necessarily the number of matching @@ -216,82 +292,104 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // For more information, see [Query and Scan]in the Amazon DynamoDB Developer Guide. + // + // [Query and Scan]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Limit *int32 // 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 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) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Accessing Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html 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) - // in the Amazon DynamoDB Developer Guide. + // see [QueryFilter]in the Amazon DynamoDB Developer Guide. + // + // [QueryFilter]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html 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). + // 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. + // 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. + // 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. + // 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 @@ -303,15 +401,19 @@ type QueryOutput struct { // The capacity units consumed by the Query operation. The data returned includes // the total provisioned throughput consumed, along with statistics for the table // and any indexes involved in the operation. ConsumedCapacity is only returned if - // the ReturnConsumedCapacity parameter was specified. For more information, see - // Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) + // the ReturnConsumedCapacity parameter was specified. For more information, see [Provisioned Throughput] // in the Amazon DynamoDB Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html ConsumedCapacity *types.ConsumedCapacity - // The number of items in the response. If you used a QueryFilter 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 and ScannedCount are the + // The number of items in the response. + // + // If you used a QueryFilter 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 and ScannedCount are the // same. Count int32 @@ -321,18 +423,24 @@ type QueryOutput struct { // The primary key of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this - // value in the new request. If LastEvaluatedKey is empty, then the "last page" of - // results has been processed and there is no more data to be retrieved. If - // LastEvaluatedKey is not empty, it does not necessarily mean that there is more - // data in the result set. The only way to know when you have reached the end of - // the result set is when LastEvaluatedKey is empty. + // value in the new request. + // + // If LastEvaluatedKey is empty, then the "last page" of results has been + // processed and there is no more data to be retrieved. + // + // If LastEvaluatedKey is not empty, it does not necessarily mean that there is + // more data in the result set. The only way to know when you have reached the end + // of the result set is when LastEvaluatedKey is empty. LastEvaluatedKey map[string]types.AttributeValue // 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) - // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the - // request, then ScannedCount is the same as Count . + // operation. For more information, see [Count and ScannedCount]in the Amazon DynamoDB Developer Guide. + // + // If you did not use a filter in the request, then ScannedCount is the same as + // Count . + // + // [Count and ScannedCount]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count ScannedCount int32 // Metadata pertaining to the operation's result. @@ -489,8 +597,9 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // For more information, see [Query and Scan]in the Amazon DynamoDB Developer Guide. + // + // [Query and Scan]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Limit int32 } diff --git a/service/dynamodb/api_op_RestoreTableFromBackup.go b/service/dynamodb/api_op_RestoreTableFromBackup.go index 28825e2c18a..7799828ceaf 100644 --- a/service/dynamodb/api_op_RestoreTableFromBackup.go +++ b/service/dynamodb/api_op_RestoreTableFromBackup.go @@ -13,14 +13,22 @@ import ( ) // Creates a new table from an existing backup. Any number of users can execute up -// to 50 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: +// to 50 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 func (c *Client) RestoreTableFromBackup(ctx context.Context, params *RestoreTableFromBackupInput, optFns ...func(*Options)) (*RestoreTableFromBackupOutput, error) { if params == nil { diff --git a/service/dynamodb/api_op_RestoreTableToPointInTime.go b/service/dynamodb/api_op_RestoreTableToPointInTime.go index 2a9ff40db56..33d4b8318ae 100644 --- a/service/dynamodb/api_op_RestoreTableToPointInTime.go +++ b/service/dynamodb/api_op_RestoreTableToPointInTime.go @@ -17,23 +17,40 @@ import ( // 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 50 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: +// +// 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. +// +// - 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 func (c *Client) RestoreTableToPointInTime(ctx context.Context, params *RestoreTableToPointInTimeInput, optFns ...func(*Options)) (*RestoreTableToPointInTimeOutput, error) { if params == nil { diff --git a/service/dynamodb/api_op_Scan.go b/service/dynamodb/api_op_Scan.go index 4a5387288e1..6da34c76096 100644 --- a/service/dynamodb/api_op_Scan.go +++ b/service/dynamodb/api_op_Scan.go @@ -14,37 +14,48 @@ import ( // The Scan operation returns one or more items and item attributes by accessing // every item in a table or a secondary index. To have DynamoDB return fewer items, -// you can provide a FilterExpression operation. If the total size of scanned -// items exceeds the maximum dataset size limit of 1 MB, the scan completes and -// results are returned to the user. The LastEvaluatedKey value is also returned -// and the requestor can use the LastEvaluatedKey to continue the scan in a -// subsequent operation. Each scan response also includes number of items that were -// scanned (ScannedCount) as part of the request. If using a FilterExpression , a -// scan result can result in no items meeting the criteria and the Count will -// result in zero. If you did not use a FilterExpression in the scan request, then -// Count is the same as ScannedCount . Count and ScannedCount only return the -// count of items specific to a single scan request and, unless the table is less -// than 1MB, do not represent the total number of items in the table. A single Scan -// operation first reads up to the maximum number of items set (if using the Limit -// parameter) or a maximum of 1 MB of data and then applies any filtering to the -// results if a FilterExpression is provided. If LastEvaluatedKey is present in -// the response, pagination is required to complete the full table scan. 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) -// in the Amazon DynamoDB Developer Guide. By default, a Scan uses eventually -// consistent reads when accessing the items in a table. Therefore, the results -// from an eventually consistent Scan may not include the latest item changes at -// the time the scan iterates through each item in the table. If you require a -// strongly consistent read of each item as the scan iterates through the items in -// the table, you can set the ConsistentRead parameter to true. Strong consistency -// only relates to the consistency of the read at the item level. DynamoDB does not -// provide snapshot isolation for a scan operation when the ConsistentRead -// parameter is set to true. Thus, a DynamoDB scan operation does not guarantee -// that all reads in a scan see a consistent snapshot of the table when the scan -// operation was requested. +// you can provide a FilterExpression operation. +// +// If the total size of scanned items exceeds the maximum dataset size limit of 1 +// MB, the scan completes and results are returned to the user. The +// LastEvaluatedKey value is also returned and the requestor can use the +// LastEvaluatedKey to continue the scan in a subsequent operation. Each scan +// response also includes number of items that were scanned (ScannedCount) as part +// of the request. If using a FilterExpression , a scan result can result in no +// items meeting the criteria and the Count will result in zero. If you did not +// use a FilterExpression in the scan request, then Count is the same as +// ScannedCount . +// +// Count and ScannedCount only return the count of items specific to a single scan +// request and, unless the table is less than 1MB, do not represent the total +// number of items in the table. +// +// A single Scan operation first reads up to the maximum number of items set (if +// using the Limit parameter) or a maximum of 1 MB of data and then applies any +// filtering to the results if a FilterExpression is provided. If LastEvaluatedKey +// is present in the response, pagination is required to complete the full table +// scan. For more information, see [Paginating the Results]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]in the Amazon DynamoDB Developer Guide. +// +// By default, a Scan uses eventually consistent reads when accessing the items in +// a table. Therefore, the results from an eventually consistent Scan may not +// include the latest item changes at the time the scan iterates through each item +// in the table. If you require a strongly consistent read of each item as the scan +// iterates through the items in the table, you can set the ConsistentRead +// parameter to true. Strong consistency only relates to the consistency of the +// read at the item level. +// +// DynamoDB does not provide snapshot isolation for a scan operation when the +// ConsistentRead parameter is set to true. Thus, a DynamoDB scan operation does +// not guarantee that all reads in a scan see a consistent snapshot of the table +// when the scan operation was requested. +// +// [Paginating the Results]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination +// [Parallel Scan]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan func (c *Client) Scan(ctx context.Context, params *ScanInput, optFns ...func(*Options)) (*ScanOutput, error) { if params == nil { params = &ScanInput{} @@ -64,83 +75,123 @@ 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. You can also provide the - // Amazon Resource Name (ARN) of the table in this parameter. + // , the name of the table to which that index belongs. + // + // You can also provide the Amazon Resource Name (ARN) of the table in this + // parameter. // // 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [AttributesToGet]in the Amazon DynamoDB Developer Guide. + // + // [AttributesToGet]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html 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) - // in the Amazon DynamoDB Developer Guide. + // see [ConditionalOperator]in the Amazon DynamoDB Developer Guide. + // + // [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html 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 . + // + // 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information on expression attribute names, see [Specifying Item Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":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) - // in the Amazon DynamoDB Developer Guide. + // One or more values that can be substituted in an expression. + // + // Use the : (colon) character in an expression to dereference an attribute value. + // For example, suppose that you wanted to check whether the value of the + // ProductStatus attribute was one of the following: + // + // Available | Backordered | Discontinued + // + // You would first need to specify ExpressionAttributeValues as follows: + // + // { ":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] in the Amazon + // DynamoDB Developer Guide. + // + // [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html ExpressionAttributeValues map[string]types.AttributeValue // A string that contains conditions that DynamoDB applies after the Scan // 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/Scan.html#Scan.FilterExpression) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Filter Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression FilterExpression *string // The name of a secondary index to scan. This index can be any local secondary @@ -156,92 +207,120 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // For more information, see [Working with Queries]in the Amazon DynamoDB Developer Guide. + // + // [Working with Queries]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Limit *int32 // A string that identifies one or more attributes to retrieve from the specified // table or index. These attributes can include scalars, sets, or elements of a - // JSON document. The attributes in the expression must be separated by commas. If - // no attribute names are specified, then all attributes will be returned. If any - // of the requested attributes are not found, they will not appear in the result. - // For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html 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). + // 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) - // in the Amazon DynamoDB Developer Guide. + // see [ScanFilter]in the Amazon DynamoDB Developer Guide. + // + // [ScanFilter]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html ScanFilter map[string]types.Condition // For a parallel Scan request, Segment identifies an individual segment to be - // 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 . + // 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 . 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. + // 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. + // 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 // segments into which the Scan operation will be divided. The value of // TotalSegments corresponds to the number of application workers that will perform // the parallel scan. For example, if you want to use four application threads to - // 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 . + // 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 . TotalSegments *int32 noSmithyDocumentSerde @@ -253,15 +332,20 @@ type ScanOutput struct { // The capacity units consumed by the Scan 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 ReturnConsumedCapacity parameter was specified. For more information, see [Provisioned Throughput] // in the Amazon DynamoDB Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads 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 . + // 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 . Count int32 // An array of item attributes that match the scan criteria. Each element in this @@ -270,18 +354,24 @@ type ScanOutput struct { // The primary key of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this - // value in the new request. If LastEvaluatedKey is empty, then the "last page" of - // results has been processed and there is no more data to be retrieved. If - // LastEvaluatedKey is not empty, it does not necessarily mean that there is more - // data in the result set. The only way to know when you have reached the end of - // the result set is when LastEvaluatedKey is empty. + // value in the new request. + // + // If LastEvaluatedKey is empty, then the "last page" of results has been + // processed and there is no more data to be retrieved. + // + // If LastEvaluatedKey is not empty, it does not necessarily mean that there is + // more data in the result set. The only way to know when you have reached the end + // of the result set is when LastEvaluatedKey is empty. LastEvaluatedKey map[string]types.AttributeValue // 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) - // in the Amazon DynamoDB Developer Guide. If you did not use a filter in the - // request, then ScannedCount is the same as Count . + // operation. For more information, see [Count and ScannedCount]in the Amazon DynamoDB Developer Guide. + // + // If you did not use a filter in the request, then ScannedCount is the same as + // Count . + // + // [Count and ScannedCount]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count ScannedCount int32 // Metadata pertaining to the operation's result. @@ -438,8 +528,9 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // For more information, see [Working with Queries]in the Amazon DynamoDB Developer Guide. + // + // [Working with Queries]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html Limit int32 } diff --git a/service/dynamodb/api_op_TagResource.go b/service/dynamodb/api_op_TagResource.go index 9c953eba4ff..188c84954fd 100644 --- a/service/dynamodb/api_op_TagResource.go +++ b/service/dynamodb/api_op_TagResource.go @@ -15,9 +15,12 @@ import ( // Associate a set of tags with an Amazon DynamoDB resource. You can then activate // these user-defined tags so that they appear on the Billing and Cost Management // console for cost allocation tracking. You can call TagResource up to five times -// per second, per account. For an overview on tagging DynamoDB resources, see -// Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) -// in the Amazon DynamoDB Developer Guide. +// per second, per account. +// +// For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the Amazon DynamoDB +// Developer Guide. +// +// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/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/dynamodb/api_op_TransactGetItems.go b/service/dynamodb/api_op_TransactGetItems.go index 311145a5ee1..6cdddbfc1c1 100644 --- a/service/dynamodb/api_op_TransactGetItems.go +++ b/service/dynamodb/api_op_TransactGetItems.go @@ -18,12 +18,18 @@ import ( // 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: +// 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. func (c *Client) TransactGetItems(ctx context.Context, params *TransactGetItemsInput, optFns ...func(*Options)) (*TransactGetItemsOutput, error) { if params == nil { @@ -67,10 +73,11 @@ type TransactGetItemsOutput struct { // 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 - // empty Map. + // 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 empty Map. Responses []types.ItemResponse // Metadata pertaining to the operation's result. diff --git a/service/dynamodb/api_op_TransactWriteItems.go b/service/dynamodb/api_op_TransactWriteItems.go index 0582d6f080e..37c6a871742 100644 --- a/service/dynamodb/api_op_TransactWriteItems.go +++ b/service/dynamodb/api_op_TransactWriteItems.go @@ -16,25 +16,30 @@ import ( // 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: +// 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 @@ -43,14 +48,20 @@ import ( // // 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 { @@ -79,30 +90,39 @@ type TransactWriteItemsInput struct { // Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, // meaning that multiple identical calls have the same effect as one single call. + // // Although multiple identical calls using the same client request token produce // the same result on the server (no side effects), the responses to the calls // might not be the same. If the ReturnConsumedCapacity parameter is set, then the // initial TransactWriteItems call returns the amount of write capacity units // consumed in making the changes. Subsequent TransactWriteItems calls with the // same client token return the number of read capacity units consumed in reading - // the item. A client request token is valid for 10 minutes after the first request - // that uses it is completed. After 10 minutes, any request with the same client - // token is treated as a new request. Do not resubmit the same request with the - // same client token for more than 10 minutes, or the result might not be - // idempotent. If you submit a request with the same client token but a change in - // other parameters within the 10-minute idempotency window, DynamoDB returns an + // the item. + // + // A client request token is valid for 10 minutes after the first request that + // uses it is completed. After 10 minutes, any request with the same client token + // is treated as a new request. Do not resubmit the same request with the same + // client token for more than 10 minutes, or the result might not be idempotent. + // + // If you submit a request with the same client token but a change in other + // parameters within the 10-minute idempotency window, DynamoDB returns an // IdempotentParameterMismatch exception. ClientRequestToken *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). + // 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 diff --git a/service/dynamodb/api_op_UntagResource.go b/service/dynamodb/api_op_UntagResource.go index 03d7cc90656..ff90cf16d1e 100644 --- a/service/dynamodb/api_op_UntagResource.go +++ b/service/dynamodb/api_op_UntagResource.go @@ -12,9 +12,12 @@ 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) -// in the Amazon DynamoDB Developer Guide. +// UntagResource up to five times per second, per account. +// +// For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB] in the Amazon DynamoDB +// Developer Guide. +// +// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/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/dynamodb/api_op_UpdateContinuousBackups.go b/service/dynamodb/api_op_UpdateContinuousBackups.go index 8ced17d6b31..f59bee4eef6 100644 --- a/service/dynamodb/api_op_UpdateContinuousBackups.go +++ b/service/dynamodb/api_op_UpdateContinuousBackups.go @@ -16,11 +16,14 @@ import ( // specified table. A successful UpdateContinuousBackups call returns the current // 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 -// before the current time. You can restore your table to any point in time during -// the last 35 days. +// 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 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) { if params == nil { params = &UpdateContinuousBackupsInput{} diff --git a/service/dynamodb/api_op_UpdateGlobalTable.go b/service/dynamodb/api_op_UpdateGlobalTable.go index 767af7c3f3a..15041b03996 100644 --- a/service/dynamodb/api_op_UpdateGlobalTable.go +++ b/service/dynamodb/api_op_UpdateGlobalTable.go @@ -16,25 +16,39 @@ 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) -// when creating new global tables, as it provides greater flexibility, higher +// capacity units. +// +// This operation only applies to [Version 2017.11.29 (Legacy)] of global tables. We recommend using [Version 2019.11.21 (Current)] 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 UpdateTable (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.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: +// determine which version you are using, see [Determining the version]. To update existing global tables +// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables]. +// +// This operation only applies to [Version 2017.11.29] of global tables. If you are using global +// tables [Version 2019.11.21]you can use [UpdateTable] 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. +// +// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html +// [UpdateTable]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Version 2017.11.29 (Legacy)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Version 2017.11.29]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Version 2019.11.21]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html 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 2b8b9c1ba59..06ba2374855 100644 --- a/service/dynamodb/api_op_UpdateGlobalTableSettings.go +++ b/service/dynamodb/api_op_UpdateGlobalTableSettings.go @@ -12,15 +12,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// when creating new global tables, as it provides greater flexibility, higher +// Updates settings for a global table. +// +// This operation only applies to [Version 2017.11.29 (Legacy)] of global tables. We recommend using [Version 2019.11.21 (Current)] 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]. To update existing global tables +// from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Updating global tables]. +// +// [Updating global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html +// [Version 2017.11.29 (Legacy)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html +// [Determining the version]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html func (c *Client) UpdateGlobalTableSettings(ctx context.Context, params *UpdateGlobalTableSettingsInput, optFns ...func(*Options)) (*UpdateGlobalTableSettingsOutput, error) { if params == nil { params = &UpdateGlobalTableSettingsInput{} @@ -45,12 +48,15 @@ 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) - // . + // PROVISIONED sets the billing mode to [Provisioned Mode]. + // // - 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) - // . + // workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode]. + // + // [On-Demand Mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand + // [Provisioned Mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual GlobalTableBillingMode types.BillingMode // Represents the settings of a global secondary index for a global table that diff --git a/service/dynamodb/api_op_UpdateItem.go b/service/dynamodb/api_op_UpdateItem.go index 12b11218b34..4c6119bc8cf 100644 --- a/service/dynamodb/api_op_UpdateItem.go +++ b/service/dynamodb/api_op_UpdateItem.go @@ -16,9 +16,10 @@ import ( // not already exist. You can put, delete, or add attribute values. You can also // perform a conditional update on an existing item (insert a new attribute // name-value pair if it doesn't exist, or replace an existing name-value pair if -// it has certain expected attribute values). You can also return the item's -// attribute values in the same UpdateItem operation using the ReturnValues -// parameter. +// it has certain expected attribute values). +// +// You can also return the item's attribute values in the same UpdateItem +// operation using the ReturnValues parameter. func (c *Client) UpdateItem(ctx context.Context, params *UpdateItemInput, optFns ...func(*Options)) (*UpdateItemOutput, error) { if params == nil { params = &UpdateItemInput{} @@ -38,10 +39,12 @@ func (c *Client) UpdateItem(ctx context.Context, params *UpdateItemInput, optFns 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. + // 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,75 +56,116 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // see [AttributeUpdates]in the Amazon DynamoDB Developer Guide. + // + // [AttributeUpdates]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html 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: + // 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. + // 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. + // + // For more information about condition expressions, see [Specifying Conditions] in the Amazon DynamoDB + // Developer Guide. + // + // [Specifying Conditions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [ConditionalOperator]in the Amazon DynamoDB Developer Guide. + // + // [ConditionalOperator]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Expected]in the Amazon DynamoDB Developer Guide. + // + // [Expected]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information about expression attribute names, see [Specifying Item Attributes] in the Amazon + // DynamoDB Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Specifying Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string - // One or more values that can be substituted in an expression. Use the : (colon) - // character in an expression to dereference an attribute value. For example, - // suppose that you wanted to check whether the value of the ProductStatus - // attribute was one of the following: Available | Backordered | Discontinued You - // would first need to specify ExpressionAttributeValues as follows: { - // ":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) - // in the Amazon DynamoDB Developer Guide. + // One or more values that can be substituted in an expression. + // + // Use the : (colon) character in an expression to dereference an attribute value. + // For example, suppose that you wanted to check whether the value of the + // ProductStatus attribute was one of the following: + // + // Available | Backordered | Discontinued + // + // You would first need to specify ExpressionAttributeValues as follows: + // + // { ":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] in the Amazon + // DynamoDB Developer Guide. + // + // [Condition Expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html 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). + // 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 @@ -133,78 +177,110 @@ type UpdateItemInput struct { // 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. + // No read capacity units are consumed. + // + // The values returned are strongly consistent. ReturnValues types.ReturnValue // An optional parameter that returns the item attributes for an UpdateItem - // operation that failed a condition check. 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. + // operation that failed a condition check. + // + // 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. ReturnValuesOnConditionCheckFailure types.ReturnValuesOnConditionCheckFailure // 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 . + // 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 + :val SET supports the following functions: + // 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. + // 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 . + // 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. + // 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. + // a=:value1, b=:value2 DELETE :value3, :value4, :value5 + // + // For more information on update expressions, see [Modifying Items and Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Modifying Items and Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html UpdateExpression *string noSmithyDocumentSerde @@ -214,33 +290,41 @@ type UpdateItemInput struct { type UpdateItemOutput struct { // A map of attribute values as they appear before or after the UpdateItem - // operation, as determined by the ReturnValues parameter. The Attributes map is - // only present if the update was successful and ReturnValues was specified as - // something other than NONE in the request. Each element represents one attribute. + // operation, as determined by the ReturnValues parameter. + // + // The Attributes map is only present if the update was successful and ReturnValues + // was specified as something other than NONE in the request. Each element + // represents one attribute. Attributes map[string]types.AttributeValue // The capacity units consumed by the UpdateItem 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. + // information, see [Provisioned Throughput]in the Amazon DynamoDB Developer Guide. + // + // [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html#ItemSizeCalculations.Reads ConsumedCapacity *types.ConsumedCapacity // Information about item collections, if any, that were affected by the UpdateItem // operation. ItemCollectionMetrics is only returned if the // 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. + // 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 fe97db50f94..fa8e770c59f 100644 --- a/service/dynamodb/api_op_UpdateTable.go +++ b/service/dynamodb/api_op_UpdateTable.go @@ -13,11 +13,16 @@ 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: +// DynamoDB Streams settings for a given table. +// +// This operation only applies to [Version 2019.11.21 (Current)] 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. // @@ -25,6 +30,8 @@ import ( // status changes from ACTIVE to UPDATING . While it's UPDATING , you can't issue // another UpdateTable request. When the table returns to the ACTIVE state, the // UpdateTable operation is complete. +// +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html func (c *Client) UpdateTable(ctx context.Context, params *UpdateTableInput, optFns ...func(*Options)) (*UpdateTableOutput, error) { if params == nil { params = &UpdateTableInput{} @@ -59,12 +66,15 @@ 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) - // . + // PROVISIONED sets the billing mode to [Provisioned Mode]. + // // - 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) - // . + // workloads. PAY_PER_REQUEST sets the billing mode to [On-Demand Mode]. + // + // [On-Demand Mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand + // [Provisioned Mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual BillingMode types.BillingMode // Indicates whether deletion protection is to be enabled (true) or disabled @@ -73,13 +83,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) - // in the Amazon DynamoDB Developer Guide. + // operation. + // + // For more information, see [Managing Global Secondary Indexes] in the Amazon DynamoDB Developer Guide. + // + // [Managing Global Secondary Indexes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html GlobalSecondaryIndexUpdates []types.GlobalSecondaryIndexUpdate // Updates the maximum number of read and write units for the specified table in @@ -91,16 +108,20 @@ type UpdateTableInput struct { 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) - // of global tables. + // + // This property only applies to [Version 2019.11.21 (Current)] of global tables. + // + // [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html ReplicaUpdates []types.ReplicationGroupUpdate // The new server-side encryption settings for the specified table. SSESpecification *types.SSESpecification - // Represents the DynamoDB Streams configuration for the table. You receive a - // ValidationException if you try to enable a stream on a table that already has a - // stream, or if you try to disable a stream on a table that doesn't have a stream. + // Represents the DynamoDB Streams configuration for the table. + // + // You receive a ValidationException if you try to enable a stream on a table that + // already has a stream, or if you try to disable a stream on a table that doesn't + // have a stream. StreamSpecification *types.StreamSpecification // The table class of the table to be updated. Valid values are STANDARD and diff --git a/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go b/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go index ff84b122e75..505b558eb5d 100644 --- a/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go +++ b/service/dynamodb/api_op_UpdateTableReplicaAutoScaling.go @@ -11,9 +11,11 @@ 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) -// of global tables. +// Updates auto scaling settings on your global tables at once. +// +// This operation only applies to [Version 2019.11.21 (Current)] of global tables. +// +// [Version 2019.11.21 (Current)]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html func (c *Client) UpdateTableReplicaAutoScaling(ctx context.Context, params *UpdateTableReplicaAutoScalingInput, optFns ...func(*Options)) (*UpdateTableReplicaAutoScalingOutput, error) { if params == nil { params = &UpdateTableReplicaAutoScalingInput{} diff --git a/service/dynamodb/api_op_UpdateTimeToLive.go b/service/dynamodb/api_op_UpdateTimeToLive.go index e6f79845416..dac4591a42b 100644 --- a/service/dynamodb/api_op_UpdateTimeToLive.go +++ b/service/dynamodb/api_op_UpdateTimeToLive.go @@ -16,20 +16,31 @@ import ( // specified table. A successful UpdateTimeToLive call returns the current // TimeToLiveSpecification . It can take up to one hour for the change to fully // process. Any additional UpdateTimeToLive calls for the same table during this -// one hour duration result in a ValidationException . 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 -// within two days of expiration. The exact duration within which an item gets -// deleted after expiration is specific to the nature of the workload. Items that -// have expired and not been deleted will still show up in reads, queries, and -// scans. As items are deleted, they are removed from any local secondary index and +// 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 within two days of expiration. The +// exact duration within which an item gets deleted after expiration is specific to +// the nature of the workload. Items that have expired and not been deleted will +// still show up in reads, queries, and scans. +// +// As items are deleted, they are removed from any local secondary index and // global secondary index immediately in the same eventually consistent way as 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] in the Amazon DynamoDB Developer Guide. +// +// [Time To Live]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html func (c *Client) UpdateTimeToLive(ctx context.Context, params *UpdateTimeToLiveInput, optFns ...func(*Options)) (*UpdateTimeToLiveOutput, error) { if params == nil { params = &UpdateTimeToLiveInput{} diff --git a/service/dynamodb/doc.go b/service/dynamodb/doc.go index 45ddcae39bd..53f36085a57 100644 --- a/service/dynamodb/doc.go +++ b/service/dynamodb/doc.go @@ -3,19 +3,24 @@ // Package dynamodb provides the API client, operations, and parameter types for // Amazon DynamoDB. // -// Amazon DynamoDB Amazon DynamoDB is a fully managed NoSQL database service that -// provides fast and predictable performance with seamless scalability. DynamoDB -// lets you offload the administrative burdens of operating and scaling a -// distributed database, so that you don't have to worry about hardware -// provisioning, setup and configuration, replication, software patching, or -// cluster scaling. With DynamoDB, you can create database tables that can store -// and retrieve any amount of data, and serve any level of request traffic. You can -// scale up or scale down your tables' throughput capacity without downtime or -// performance degradation, and use the Amazon Web Services Management Console to -// monitor resource utilization and performance metrics. DynamoDB automatically -// spreads the data and traffic for your tables over a sufficient number of servers -// to handle your throughput and storage requirements, while maintaining consistent -// and fast performance. All of your data is stored on solid state disks (SSDs) and -// automatically replicated across multiple Availability Zones in an Amazon Web -// Services Region, providing built-in high availability and data durability. +// # Amazon DynamoDB +// +// Amazon DynamoDB is a fully managed NoSQL database service that provides fast +// and predictable performance with seamless scalability. DynamoDB lets you offload +// the administrative burdens of operating and scaling a distributed database, so +// that you don't have to worry about hardware provisioning, setup and +// configuration, replication, software patching, or cluster scaling. +// +// With DynamoDB, you can create database tables that can store and retrieve any +// amount of data, and serve any level of request traffic. You can scale up or +// scale down your tables' throughput capacity without downtime or performance +// degradation, and use the Amazon Web Services Management Console to monitor +// resource utilization and performance metrics. +// +// DynamoDB automatically spreads the data and traffic for your tables over a +// sufficient number of servers to handle your throughput and storage requirements, +// while maintaining consistent and fast performance. All of your data is stored on +// solid state disks (SSDs) and automatically replicated across multiple +// Availability Zones in an Amazon Web Services Region, providing built-in high +// availability and data durability. package dynamodb diff --git a/service/dynamodb/options.go b/service/dynamodb/options.go index bf88e3b7635..199f2cf6a5e 100644 --- a/service/dynamodb/options.go +++ b/service/dynamodb/options.go @@ -61,8 +61,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -85,17 +87,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -112,8 +117,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -158,6 +164,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/dynamodb/types/enums.go b/service/dynamodb/types/enums.go index ec617f936bd..73e4795bc0f 100644 --- a/service/dynamodb/types/enums.go +++ b/service/dynamodb/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for ApproximateCreationDateTimePrecision. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApproximateCreationDateTimePrecision) Values() []ApproximateCreationDateTimePrecision { return []ApproximateCreationDateTimePrecision{ "MILLISECOND", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AttributeAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeAction) Values() []AttributeAction { return []AttributeAction{ "ADD", @@ -51,8 +53,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for BackupType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupType) Values() []BackupType { return []BackupType{ "USER", @@ -92,8 +96,9 @@ const ( ) // Values returns all known values for BackupTypeFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupTypeFilter) Values() []BackupTypeFilter { return []BackupTypeFilter{ "USER", @@ -122,6 +127,7 @@ const ( // Values returns all known values for BatchStatementErrorCodeEnum. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BatchStatementErrorCodeEnum) Values() []BatchStatementErrorCodeEnum { return []BatchStatementErrorCodeEnum{ @@ -148,8 +154,9 @@ const ( ) // Values returns all known values for BillingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BillingMode) Values() []BillingMode { return []BillingMode{ "PROVISIONED", @@ -177,8 +184,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQ", @@ -206,8 +214,9 @@ const ( ) // Values returns all known values for ConditionalOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConditionalOperator) Values() []ConditionalOperator { return []ConditionalOperator{ "AND", @@ -224,8 +233,9 @@ const ( ) // Values returns all known values for ContinuousBackupsStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContinuousBackupsStatus) Values() []ContinuousBackupsStatus { return []ContinuousBackupsStatus{ "ENABLED", @@ -243,6 +253,7 @@ const ( // Values returns all known values for ContributorInsightsAction. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContributorInsightsAction) Values() []ContributorInsightsAction { return []ContributorInsightsAction{ @@ -264,6 +275,7 @@ const ( // Values returns all known values for ContributorInsightsStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContributorInsightsStatus) Values() []ContributorInsightsStatus { return []ContributorInsightsStatus{ @@ -288,8 +300,9 @@ const ( ) // Values returns all known values for DestinationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationStatus) Values() []DestinationStatus { return []DestinationStatus{ "ENABLING", @@ -310,8 +323,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -329,8 +343,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -348,8 +363,9 @@ const ( ) // Values returns all known values for ExportType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportType) Values() []ExportType { return []ExportType{ "FULL_EXPORT", @@ -366,8 +382,9 @@ const ( ) // Values returns all known values for ExportViewType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportViewType) Values() []ExportViewType { return []ExportViewType{ "NEW_IMAGE", @@ -386,8 +403,9 @@ const ( ) // Values returns all known values for GlobalTableStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalTableStatus) Values() []GlobalTableStatus { return []GlobalTableStatus{ "CREATING", @@ -409,8 +427,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -432,8 +451,9 @@ const ( ) // Values returns all known values for IndexStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndexStatus) Values() []IndexStatus { return []IndexStatus{ "CREATING", @@ -453,8 +473,9 @@ const ( ) // Values returns all known values for InputCompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputCompressionType) Values() []InputCompressionType { return []InputCompressionType{ "GZIP", @@ -473,8 +494,9 @@ const ( ) // Values returns all known values for InputFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputFormat) Values() []InputFormat { return []InputFormat{ "DYNAMODB_JSON", @@ -492,8 +514,9 @@ const ( ) // Values returns all known values for KeyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyType) Values() []KeyType { return []KeyType{ "HASH", @@ -511,6 +534,7 @@ const ( // Values returns all known values for PointInTimeRecoveryStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PointInTimeRecoveryStatus) Values() []PointInTimeRecoveryStatus { return []PointInTimeRecoveryStatus{ @@ -529,8 +553,9 @@ const ( ) // Values returns all known values for ProjectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectionType) Values() []ProjectionType { return []ProjectionType{ "ALL", @@ -553,8 +578,9 @@ const ( ) // Values returns all known values for ReplicaStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicaStatus) Values() []ReplicaStatus { return []ReplicaStatus{ "CREATING", @@ -577,8 +603,9 @@ const ( ) // Values returns all known values for ReturnConsumedCapacity. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReturnConsumedCapacity) Values() []ReturnConsumedCapacity { return []ReturnConsumedCapacity{ "INDEXES", @@ -597,6 +624,7 @@ const ( // Values returns all known values for ReturnItemCollectionMetrics. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReturnItemCollectionMetrics) Values() []ReturnItemCollectionMetrics { return []ReturnItemCollectionMetrics{ @@ -617,8 +645,9 @@ const ( ) // Values returns all known values for ReturnValue. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReturnValue) Values() []ReturnValue { return []ReturnValue{ "NONE", @@ -639,8 +668,9 @@ const ( // Values returns all known values for ReturnValuesOnConditionCheckFailure. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReturnValuesOnConditionCheckFailure) Values() []ReturnValuesOnConditionCheckFailure { return []ReturnValuesOnConditionCheckFailure{ "ALL_OLD", @@ -657,8 +687,9 @@ const ( ) // Values returns all known values for S3SseAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3SseAlgorithm) Values() []S3SseAlgorithm { return []S3SseAlgorithm{ "AES256", @@ -676,8 +707,9 @@ const ( ) // Values returns all known values for ScalarAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalarAttributeType) Values() []ScalarAttributeType { return []ScalarAttributeType{ "S", @@ -697,8 +729,9 @@ const ( ) // Values returns all known values for Select. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Select) Values() []Select { return []Select{ "ALL_ATTRIBUTES", @@ -720,8 +753,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -741,8 +775,9 @@ const ( ) // Values returns all known values for SSEType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SSEType) Values() []SSEType { return []SSEType{ "AES256", @@ -761,8 +796,9 @@ const ( ) // Values returns all known values for StreamViewType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamViewType) Values() []StreamViewType { return []StreamViewType{ "NEW_IMAGE", @@ -781,8 +817,9 @@ const ( ) // Values returns all known values for TableClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableClass) Values() []TableClass { return []TableClass{ "STANDARD", @@ -804,8 +841,9 @@ const ( ) // Values returns all known values for TableStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableStatus) Values() []TableStatus { return []TableStatus{ "CREATING", @@ -829,8 +867,9 @@ const ( ) // Values returns all known values for TimeToLiveStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeToLiveStatus) Values() []TimeToLiveStatus { return []TimeToLiveStatus{ "ENABLING", diff --git a/service/dynamodb/types/errors.go b/service/dynamodb/types/errors.go index d11b3b8b687..97bf7dbd502 100644 --- a/service/dynamodb/types/errors.go +++ b/service/dynamodb/types/errors.go @@ -116,7 +116,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 +// 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 @@ -276,7 +277,8 @@ func (e *IdempotentParameterMismatchException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There was a conflict when importing from the specified S3 source. This can +// 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 { @@ -490,17 +492,26 @@ 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 +// 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. GetRecords was called with a value of more than 1000 for the -// limit request parameter. More than 2 processes are reading from the same streams -// shard at the same time. Exceeding this limit may result in request throttling. +// 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. +// +// GetRecords was called with a value of more than 1000 for the limit request +// parameter. +// +// More than 2 processes are reading from the same streams shard at the same time. +// Exceeding this limit may result in request throttling. type LimitExceededException struct { Message *string @@ -554,9 +565,10 @@ func (e *PointInTimeRecoveryUnavailableException) ErrorFault() smithy.ErrorFault return smithy.FaultClient } -// The operation tried to access a nonexistent resource-based policy. If you -// specified an ExpectedRevisionId , it's possible that a policy is present for the -// resource but its revision ID didn't match the expected value. +// The operation tried to access a nonexistent resource-based policy. +// +// If you specified an ExpectedRevisionId , it's possible that a policy is present +// for the resource but its revision ID didn't match the expected value. type PolicyNotFoundException struct { Message *string @@ -586,8 +598,9 @@ func (e *PolicyNotFoundException) ErrorFault() smithy.ErrorFault { return smithy // 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) -// in the Amazon DynamoDB Developer Guide. +// to [Error Retries and Exponential Backoff]in the Amazon DynamoDB Developer Guide. +// +// [Error Retries and Exponential Backoff]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff type ProvisionedThroughputExceededException struct { Message *string @@ -668,8 +681,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. +// contact [Amazon Web Services Support]to request a quota increase. +// +// [Amazon Web Services Support]: https://aws.amazon.com/support type RequestLimitExceeded struct { Message *string @@ -830,92 +844,150 @@ func (e *TableNotFoundException) ErrorCode() string { } func (e *TableNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The entire transaction request was canceled. DynamoDB cancels a -// TransactWriteItems request under the following circumstances: +// 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. +// // - There is an ongoing TransactWriteItems operation that conflicts with a // concurrent TransactWriteItems request. In this case the TransactWriteItems // operation fails with a TransactionCanceledException . // // 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: +// 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. +// 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 @@ -970,31 +1042,48 @@ 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 -// retries will trigger completion of the ongoing TransactWriteItems request. +// +// # 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 -// timeline: +// Assuming [default retry policy], 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) +// +// [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 type TransactionInProgressException struct { Message *string diff --git a/service/dynamodb/types/types.go b/service/dynamodb/types/types.go index 9fc2ed1a2b0..fa7b9ee507e 100644 --- a/service/dynamodb/types/types.go +++ b/service/dynamodb/types/types.go @@ -20,6 +20,7 @@ type ArchivalSummary struct { 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. @@ -37,8 +38,11 @@ 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 // // This member is required. @@ -47,10 +51,12 @@ type AttributeDefinition struct { noSmithyDocumentSerde } -// 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) -// in the Amazon DynamoDB Developer Guide. +// 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] in the Amazon DynamoDB Developer Guide. // // The following types satisfy this interface: // @@ -64,12 +70,15 @@ type AttributeDefinition struct { // AttributeValueMemberNULL // AttributeValueMemberS // AttributeValueMemberSS +// +// [Data Types]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes type AttributeValue interface { isAttributeValue() } -// An attribute of type Binary. For example: "B": -// "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" +// An attribute of type Binary. For example: +// +// "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" type AttributeValueMemberB struct { Value []byte @@ -78,7 +87,9 @@ type AttributeValueMemberB struct { func (*AttributeValueMemberB) isAttributeValue() {} -// An attribute of type Boolean. For example: "BOOL": true +// An attribute of type Boolean. For example: +// +// "BOOL": true type AttributeValueMemberBOOL struct { Value bool @@ -87,8 +98,9 @@ type AttributeValueMemberBOOL struct { func (*AttributeValueMemberBOOL) isAttributeValue() {} -// An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=", -// "U25vd3k="] +// An attribute of type Binary Set. For example: +// +// "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="] type AttributeValueMemberBS struct { Value [][]byte @@ -97,8 +109,9 @@ type AttributeValueMemberBS struct { func (*AttributeValueMemberBS) isAttributeValue() {} -// An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": -// "Coffee"}, {"N": "3.14159"}] +// An attribute of type List. For example: +// +// "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}] type AttributeValueMemberL struct { Value []AttributeValue @@ -107,8 +120,9 @@ type AttributeValueMemberL struct { func (*AttributeValueMemberL) isAttributeValue() {} -// An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": -// "35"}} +// An attribute of type Map. For example: +// +// "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}} type AttributeValueMemberM struct { Value map[string]AttributeValue @@ -117,10 +131,13 @@ type AttributeValueMemberM struct { func (*AttributeValueMemberM) isAttributeValue() {} -// An attribute of type Number. For example: "N": "123.45" Numbers are sent across -// the network to DynamoDB as strings, to maximize compatibility across languages -// and libraries. However, DynamoDB treats them as number type attributes for -// mathematical operations. +// An attribute of type Number. For example: +// +// "N": "123.45" +// +// Numbers are sent across the network to DynamoDB as strings, to maximize +// compatibility across languages and libraries. However, DynamoDB treats them as +// number type attributes for mathematical operations. type AttributeValueMemberN struct { Value string @@ -129,8 +146,11 @@ type AttributeValueMemberN struct { func (*AttributeValueMemberN) isAttributeValue() {} -// An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", -// "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize +// An attribute of type Number Set. For example: +// +// "NS": ["42.2", "-19", "7.5", "3.14"] +// +// Numbers are sent across the network to DynamoDB as strings, to maximize // compatibility across languages and libraries. However, DynamoDB treats them as // number type attributes for mathematical operations. type AttributeValueMemberNS struct { @@ -141,7 +161,9 @@ type AttributeValueMemberNS struct { func (*AttributeValueMemberNS) isAttributeValue() {} -// An attribute of type Null. For example: "NULL": true +// An attribute of type Null. For example: +// +// "NULL": true type AttributeValueMemberNULL struct { Value bool @@ -150,7 +172,9 @@ type AttributeValueMemberNULL struct { func (*AttributeValueMemberNULL) isAttributeValue() {} -// An attribute of type String. For example: "S": "Hello" +// An attribute of type String. For example: +// +// "S": "Hello" type AttributeValueMemberS struct { Value string @@ -159,8 +183,9 @@ type AttributeValueMemberS struct { func (*AttributeValueMemberS) isAttributeValue() {} -// An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" -// ,"Zebra"] +// An attribute of type String Set. For example: +// +// "SS": ["Giraffe", "Hippo" ,"Zebra"] type AttributeValueMemberSS struct { Value []string @@ -170,64 +195,89 @@ type AttributeValueMemberSS struct { func (*AttributeValueMemberSS) isAttributeValue() {} // For the UpdateItem operation, represents the attributes to be modified, the -// action to perform on each, and the new value for each. You cannot use UpdateItem -// to update any primary key attributes. Instead, you will need to delete the item, -// and then use PutItem to create a new item with new attributes. Attribute values -// cannot be null; string and binary type attributes must have lengths greater than -// zero; and set type attributes must not be empty. Requests with empty values will -// be rejected with a ValidationException exception. +// action to perform on each, and the new value for each. +// +// You cannot use UpdateItem to update any primary key attributes. Instead, you +// will need to delete the item, and then use PutItem to create a new item with +// new attributes. +// +// Attribute values cannot be null; string and binary type attributes must have +// lengths greater than zero; and set type attributes must not be empty. Requests +// with empty values will 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: + // 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. + // 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 . + // 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. + // 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. 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) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Data Types]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes Value AttributeValue noSmithyDocumentSerde @@ -417,11 +467,14 @@ 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. // // This member is required. @@ -461,11 +514,14 @@ 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. BackupType BackupType @@ -484,14 +540,14 @@ type BackupSummary struct { // An error associated with a statement in a PartiQL batch that was run. type BatchStatementError struct { - // The error code associated with the failed PartiQL batch statement. + // The error code associated with the failed PartiQL batch statement. Code BatchStatementErrorCodeEnum // The item which caused the condition check to fail. This will be set if // ReturnValuesOnConditionCheckFailure is specified as ALL_OLD . Item map[string]AttributeValue - // The error message associated with the PartiQL batch response. + // The error message associated with the PartiQL batch response. Message *string noSmithyDocumentSerde @@ -500,22 +556,23 @@ type BatchStatementError struct { // A PartiQL batch statement request. type BatchStatementRequest struct { - // A valid PartiQL statement. + // A valid PartiQL statement. // // This member is required. Statement *string - // The read consistency of the PartiQL batch request. + // The read consistency of the PartiQL batch request. ConsistentRead *bool - // The parameters associated with a PartiQL statement in the batch request. + // The parameters associated with a PartiQL statement in the batch request. Parameters []AttributeValue // An optional parameter that returns the item attributes for a PartiQL batch - // request operation that failed a condition check. 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. + // request operation that failed a condition check. + // + // 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. ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure noSmithyDocumentSerde @@ -524,13 +581,13 @@ type BatchStatementRequest struct { // A PartiQL batch statement response.. type BatchStatementResponse struct { - // The error associated with a failed PartiQL batch statement. + // The error associated with a failed PartiQL batch statement. Error *BatchStatementError - // A DynamoDB item associated with a BatchStatementResponse + // A DynamoDB item associated with a BatchStatementResponse Item map[string]AttributeValue - // The table name associated with a failed PartiQL batch statement. + // The table name associated with a failed PartiQL batch statement. TableName *string noSmithyDocumentSerde @@ -538,15 +595,20 @@ 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]. +// +// You may need to switch to on-demand mode at least once in order to return a // BillingModeSummary response. +// +// [Read/write capacity mode]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html 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. BillingMode BillingMode @@ -594,119 +656,168 @@ 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 | -// 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. +// 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. + // 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, + // + // 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 + // + // - 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"]} . + // + // - 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. + // 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. + // 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. + // 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. + // 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] in the + // Amazon DynamoDB Developer Guide. + // + // [Legacy Conditional Parameters]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html // // This member is required. ComparisonOperator ComparisonOperator // 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 + // 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]. + // + // For Binary, DynamoDB treats each byte of the binary data as unsigned when it // compares binary values. + // + // [http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters AttributeValueList []AttributeValue noSmithyDocumentSerde @@ -717,8 +828,9 @@ type Condition struct { 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) - // in the Amazon DynamoDB Developer Guide. + // succeed. For more information, see [Condition expressions]in the Amazon DynamoDB Developer Guide. + // + // [Condition expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html // // This member is required. ConditionExpression *string @@ -736,13 +848,15 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Expression attribute names]in the Amazon DynamoDB Developer Guide. + // + // [Expression attribute names]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Condition expressions]in the Amazon DynamoDB Developer Guide. + // + // [Condition expressions]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html ExpressionAttributeValues map[string]AttributeValue // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the @@ -756,8 +870,10 @@ 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) -// in the Amazon DynamoDB Developer Guide. +// request asked for it. For more information, see [Provisioned Throughput]in the Amazon DynamoDB +// Developer Guide. +// +// [Provisioned Throughput]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html type ConsumedCapacity struct { // The total number of capacity units consumed by the operation. @@ -844,9 +960,12 @@ type CreateGlobalSecondaryIndexAction struct { OnDemandThroughput *OnDemandThroughput // 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) - // in the Amazon DynamoDB Developer Guide. + // secondary index. + // + // For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the + // Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html ProvisionedThroughput *ProvisionedThroughput noSmithyDocumentSerde @@ -899,10 +1018,10 @@ type CreateReplicationGroupMemberAction struct { // Processing options for the CSV file being imported. type CsvOptions struct { - // The delimiter used for separating items in the CSV file being imported. + // The delimiter used for separating items in the CSV file being imported. Delimiter *string - // List of the headers used to specify a common header for all source CSV files + // List of the headers used to specify a common header for all source CSV files // being imported. If this field is specified then the first line of each CSV file // is treated as data instead of the header. If this field is not specified the the // first line of each CSV file is treated as the header. @@ -1019,10 +1138,12 @@ type Endpoint struct { // 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 @@ -1036,132 +1157,184 @@ type Endpoint struct { 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) - // in the Amazon DynamoDB Developer Guide. + // 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]. + // + // 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] in the Amazon DynamoDB + // Developer Guide. + // + // [http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters + // [JSON Data Format]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html AttributeValueList []AttributeValue // 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. + // 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, + // + // 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 + // + // - 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"]} . + // + // - 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. + // 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. + // 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. + // 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"]} + // 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: + // 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 , - // because it is implied. DynamoDB returns a ValidationException if: + // 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 *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) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Data Types]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes Value AttributeValue noSmithyDocumentSerde @@ -1226,7 +1399,9 @@ 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 S3SseAlgorithm S3SseAlgorithm @@ -1315,14 +1490,19 @@ 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 - // 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. + // 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. // // This member is required. KeySchema []KeySchemaElement @@ -1340,9 +1520,12 @@ type GlobalSecondaryIndex struct { OnDemandThroughput *OnDemandThroughput // 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) - // in the Amazon DynamoDB Developer Guide. + // secondary index. + // + // For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the + // Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html ProvisionedThroughput *ProvisionedThroughput noSmithyDocumentSerde @@ -1370,12 +1553,15 @@ type GlobalSecondaryIndexDescription struct { // 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. + // 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. @@ -1390,9 +1576,13 @@ 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. IndexStatus IndexStatus @@ -1403,14 +1593,19 @@ 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 - // 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. + // 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 // The maximum number of read and write units for the specified global secondary @@ -1424,9 +1619,12 @@ type GlobalSecondaryIndexDescription struct { 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) - // in the Amazon DynamoDB Developer Guide. + // secondary index. + // + // For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the + // Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html ProvisionedThroughput *ProvisionedThroughputDescription noSmithyDocumentSerde @@ -1441,14 +1639,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 - // 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. + // 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 // Sets the maximum number of read and write units for the specified on-demand @@ -1469,18 +1672,26 @@ 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. type GlobalSecondaryIndexUpdate struct { // The parameters required for creating a global secondary index on an existing // table: + // // - IndexName + // // - KeySchema + // // - AttributeDefinitions + // // - Projection + // // - ProvisionedThroughput Create *CreateGlobalSecondaryIndexAction @@ -1519,9 +1730,13 @@ 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. GlobalTableStatus GlobalTableStatus @@ -1555,32 +1770,32 @@ type GlobalTableGlobalSecondaryIndexSettingsUpdate struct { // Summary information about the source file for the import. type ImportSummary struct { - // The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with + // The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with // this import task. CloudWatchLogGroupArn *string - // The time at which this import task ended. (Does this include the successful + // The time at which this import task ended. (Does this include the successful // complete creation of the table it was imported to?) EndTime *time.Time - // The Amazon Resource Number (ARN) corresponding to the import request. + // The Amazon Resource Number (ARN) corresponding to the import request. ImportArn *string - // The status of the import operation. + // 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 - // the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if - // the bucket is owned by the requester). + // The path and S3 bucket of the source file that is being imported. This + // includes the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner + // (optional if the bucket is owned by the requester). S3BucketSource *S3BucketSource - // The time at which this import task began. + // The time at which this import task began. StartTime *time.Time - // The Amazon Resource Number (ARN) of the table being imported into. + // The Amazon Resource Number (ARN) of the table being imported into. TableArn *string noSmithyDocumentSerde @@ -1589,70 +1804,70 @@ 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 + // 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 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 + // The time at which the creation of the table associated with this import task // completed. EndTime *time.Time - // The number of errors occurred on importing the source file into the target + // The number of errors occurred on importing the source file into the target // table. ErrorCount int64 - // The error code corresponding to the failure that the import job ran into during - // execution. + // The error code corresponding to the failure that the import job ran into + // during execution. FailureCode *string - // The error message corresponding to the failure that the import job ran into + // The error message corresponding to the failure that the import job ran into // during execution. FailureMessage *string - // The Amazon Resource Number (ARN) corresponding to the import request. + // The Amazon Resource Number (ARN) corresponding to the import request. ImportArn *string - // The status of the import. + // The status of the import. ImportStatus ImportStatus - // The number of items successfully imported into the new table. + // The number of items successfully imported into the new table. ImportedItemCount int64 - // The compression options for the data that has been imported into the target + // The compression options for the data that has been imported into the target // table. The values are NONE, GZIP, or ZSTD. InputCompressionType InputCompressionType - // The format of the source data going into the target table. + // The format of the source data going into the target table. InputFormat InputFormat - // The format options for the data that was imported into the target table. There + // The format options for the data that was imported into the target table. There // is one value, CsvOption. InputFormatOptions *InputFormatOptions - // The total number of items processed from the source file. + // The total number of items processed from the source file. ProcessedItemCount int64 - // The total size of data processed from the source file, in Bytes. + // The total size of data processed from the source file, in Bytes. ProcessedSizeBytes *int64 - // Values for the S3 bucket the source file is imported from. Includes bucket name - // (required), key prefix (optional) and bucket account owner ID (optional). + // Values for the S3 bucket the source file is imported from. Includes bucket + // name (required), key prefix (optional) and bucket account owner ID (optional). S3BucketSource *S3BucketSource - // The time when this import task started. + // The time when this import task started. StartTime *time.Time - // The Amazon Resource Number (ARN) of the table being imported into. + // The Amazon Resource Number (ARN) of the table being imported into. TableArn *string - // The parameters for the new table that is being imported into. + // The parameters for the new table that is being imported into. TableCreationParameters *TableCreationParameters - // The table id corresponding to the table created by import table process. + // The table id corresponding to the table created by import table process. TableId *string noSmithyDocumentSerde @@ -1680,11 +1895,12 @@ type IncrementalExportSpecification struct { noSmithyDocumentSerde } -// The format options for the data that was imported into the target table. There +// The format options for the data that was imported into the target table. There +// // is one value, CsvOption. type InputFormatOptions struct { - // The options for imported source files in CSV format. The values are Delimiter + // The options for imported source files in CSV format. The values are Delimiter // and HeaderList. Csv *CsvOptions @@ -1706,8 +1922,10 @@ type ItemCollectionMetrics struct { // 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. + // limit. + // + // The estimate is subject to change over time; therefore, do not rely on the + // precision or accuracy of the estimate. SizeEstimateRangeGB []float64 noSmithyDocumentSerde @@ -1723,10 +1941,11 @@ type ItemResponse struct { } // Represents a set of primary keys and, for each key, the attributes to retrieve -// from 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. For a composite primary key, you must provide both the partition -// key and the sort key. +// from 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. For a +// composite primary key, you must provide both the partition key and the sort key. type KeysAndAttributes struct { // The primary key attribute values that define the items and the attributes @@ -1736,8 +1955,9 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // information, see [Legacy Conditional Parameters]in the Amazon DynamoDB Developer Guide. + // + // [Legacy Conditional Parameters]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html AttributesToGet []string // The consistency of a read operation. If set to true , then a strongly consistent @@ -1746,35 +1966,52 @@ type KeysAndAttributes struct { // 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 - // 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 : + // directly in an expression. (For the complete list of reserved words, see [Reserved Words]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) - // in the Amazon DynamoDB Developer Guide. + // are placeholders for the actual value at runtime. + // + // For more information on expression attribute names, see [Accessing Item Attributes] in the Amazon DynamoDB + // Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html + // [Accessing Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ExpressionAttributeNames map[string]string // 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 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) - // in the Amazon DynamoDB Developer Guide. + // 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] in the Amazon DynamoDB Developer Guide. + // + // [Accessing Item Attributes]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html ProjectionExpression *string noSmithyDocumentSerde @@ -1782,12 +2019,15 @@ type KeysAndAttributes struct { // Represents a single element of a key schema. A key schema specifies the // attributes that make up the primary key of a table, or the key attributes of an -// index. A KeySchemaElement represents exactly one attribute of the primary key. -// 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 +// index. +// +// A KeySchemaElement represents exactly one attribute of the primary key. 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 // attribute cannot be nested within a List or a Map. type KeySchemaElement struct { @@ -1797,14 +2037,19 @@ 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 - // 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. + // 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. // // This member is required. KeyType KeyType @@ -1842,14 +2087,19 @@ type LocalSecondaryIndex struct { // 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 - // 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. + // 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. // // This member is required. KeySchema []KeySchemaElement @@ -1885,14 +2135,19 @@ type LocalSecondaryIndexDescription struct { // 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 - // 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. + // 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 @@ -1912,14 +2167,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 - // 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. + // 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 @@ -1935,16 +2195,20 @@ type LocalSecondaryIndexInfo struct { // MaxWriteRequestUnits , or both. type OnDemandThroughput struct { - // Maximum number of read request units for the specified table. To specify a - // maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits - // as greater than or equal to 1. To remove the maximum OnDemandThroughput that is - // currently set on your table, set the value of MaxReadRequestUnits to -1. + // Maximum number of read request units for the specified table. + // + // To specify a maximum OnDemandThroughput on your table, set the value of + // MaxReadRequestUnits as greater than or equal to 1. To remove the maximum + // OnDemandThroughput that is currently set on your table, set the value of + // MaxReadRequestUnits to -1. MaxReadRequestUnits *int64 - // Maximum number of write request units for the specified table. To specify a - // maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits - // as greater than or equal to 1. To remove the maximum OnDemandThroughput that is - // currently set on your table, set the value of MaxWriteRequestUnits to -1. + // Maximum number of write request units for the specified table. + // + // To specify a maximum OnDemandThroughput on your table, set the value of + // MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum + // OnDemandThroughput that is currently set on your table, set the value of + // MaxWriteRequestUnits to -1. MaxWriteRequestUnits *int64 noSmithyDocumentSerde @@ -1964,19 +2228,20 @@ type OnDemandThroughputOverride struct { // Represents a PartiQL statement that uses parameters. type ParameterizedStatement struct { - // A PartiQL statement that uses parameters. + // A PartiQL statement that uses parameters. // // This member is required. Statement *string - // The parameter values. + // The parameter values. Parameters []AttributeValue // An optional parameter that returns the item attributes for a PartiQL - // ParameterizedStatement operation that failed a condition check. 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. + // ParameterizedStatement operation that failed a condition check. + // + // 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. ReturnValuesOnConditionCheckFailure ReturnValuesOnConditionCheckFailure noSmithyDocumentSerde @@ -1993,7 +2258,9 @@ 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. PointInTimeRecoveryStatus PointInTimeRecoveryStatus @@ -2018,6 +2285,7 @@ type PointInTimeRecoverySpecification struct { type Projection struct { // Represents the non-key attribute names which will be projected into the index. + // // For local secondary indexes, the total count of NonKeyAttributes summed across // all of the local secondary indexes, must not exceed 100. If you project the same // attribute into two different indexes, this counts as two distinct attributes @@ -2025,10 +2293,14 @@ 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. + // // When using the DynamoDB console, ALL is selected by default. ProjectionType ProjectionType @@ -2036,26 +2308,32 @@ 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) -// in the Amazon DynamoDB Developer Guide. +// The settings can be modified using the UpdateTable operation. +// +// For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the +// Amazon DynamoDB Developer Guide. +// +// [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html 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/ProvisionedThroughput.html) - // in the Amazon DynamoDB Developer Guide. If read/write capacity mode is - // PAY_PER_REQUEST the value is set to 0. + // DynamoDB returns a ThrottlingException . For more information, see [Specifying Read and Write Requirements] in the + // Amazon DynamoDB Developer Guide. + // + // If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. + // + // [Specifying Read and Write Requirements]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html // // This member is required. 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/ProvisionedThroughput.html) - // in the Amazon DynamoDB Developer Guide. If read/write capacity mode is - // PAY_PER_REQUEST the value is set to 0. + // ThrottlingException . For more information, see [Specifying Read and Write Requirements] in the Amazon DynamoDB + // Developer Guide. + // + // If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. + // + // [Specifying Read and Write Requirements]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html // // This member is required. WriteCapacityUnits *int64 @@ -2074,9 +2352,10 @@ type ProvisionedThroughputDescription struct { LastIncreaseDateTime *time.Time // 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) - // in the Amazon DynamoDB Developer Guide. + // calendar day. For current maximums on provisioned throughput decreases, see [Service, Account, and Table Quotas]in + // the Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html NumberOfDecreasesToday *int64 // The maximum number of strongly consistent reads consumed per second before @@ -2180,9 +2459,13 @@ 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. ReplicaStatus ReplicaStatus @@ -2233,19 +2516,28 @@ 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, + // 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. @@ -2287,10 +2579,14 @@ 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. IndexStatus IndexStatus @@ -2344,10 +2640,14 @@ type ReplicaGlobalSecondaryIndexSettingsDescription struct { // This member is required. IndexName *string - // The current status of the global secondary index: + // 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. IndexStatus IndexStatus @@ -2409,24 +2709,30 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // DynamoDB returns a ThrottlingException . For more information, see [Specifying Read and Write Requirements] in the + // Amazon DynamoDB Developer Guide. + // + // [Specifying Read and Write Requirements]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput ReplicaProvisionedReadCapacityUnits *int64 // Auto scaling settings for a global table replica's write capacity units. 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) - // in the Amazon DynamoDB Developer Guide. + // ThrottlingException . For more information, see [Specifying Read and Write Requirements] in the Amazon DynamoDB + // Developer Guide. + // + // [Specifying Read and Write Requirements]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput 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. ReplicaStatus ReplicaStatus @@ -2452,9 +2758,10 @@ type ReplicaSettingsUpdate struct { 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) - // in the Amazon DynamoDB Developer Guide. + // DynamoDB returns a ThrottlingException . For more information, see [Specifying Read and Write Requirements] in the + // Amazon DynamoDB Developer Guide. + // + // [Specifying Read and Write Requirements]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput ReplicaProvisionedReadCapacityUnits *int64 // Replica-specific table class. If not specified, uses the source table's table @@ -2465,10 +2772,13 @@ 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. @@ -2491,8 +2801,11 @@ 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. type ReplicaUpdate struct { @@ -2530,16 +2843,16 @@ type RestoreSummary struct { // The S3 bucket that is being imported from. type S3BucketSource struct { - // The S3 bucket that is being imported from. + // The S3 bucket that is being imported from. // // This member is required. S3Bucket *string - // The account number of the S3 bucket that is being imported from. If the bucket + // The account number of the S3 bucket that is being imported from. If the bucket // is owned by the requester this is optional. S3BucketOwner *string - // The key prefix shared by all S3 Objects that are being imported. + // The key prefix shared by all S3 Objects that are being imported. S3KeyPrefix *string noSmithyDocumentSerde @@ -2575,8 +2888,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. BillingMode BillingMode @@ -2639,13 +2954,16 @@ 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). 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. Status SSEStatus @@ -2669,6 +2987,7 @@ type SSESpecification struct { 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). SSEType SSEType @@ -2685,15 +3004,19 @@ type StreamSpecification struct { // This member is required. StreamEnabled *bool - // When an item in the table is modified, StreamViewType determines what + // 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. StreamViewType StreamViewType @@ -2711,9 +3034,13 @@ 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. TableStatus TableStatus @@ -2736,27 +3063,27 @@ type TableClassSummary struct { // The parameters for the table created as part of the import operation. type TableCreationParameters struct { - // The attributes of the table created as part of the import operation. + // The attributes of the table created as part of the import operation. // // This member is required. AttributeDefinitions []AttributeDefinition - // The primary key and option sort key of the table created as part of the import + // The primary key and option sort key of the table created as part of the import // operation. // // This member is required. KeySchema []KeySchemaElement - // The name of the table created as part of the import operation. + // The name of the table created as part of the import operation. // // This member is required. TableName *string - // The billing mode for provisioning the table created as part of the import + // The billing mode for provisioning the table created as part of the import // operation. BillingMode BillingMode - // The Global Secondary Indexes (GSI) of the table to be created as part of the + // The Global Secondary Indexes (GSI) of the table to be created as part of the // import operation. GlobalSecondaryIndexes []GlobalSecondaryIndex @@ -2766,10 +3093,12 @@ type TableCreationParameters struct { OnDemandThroughput *OnDemandThroughput // 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) - // in the Amazon DynamoDB Developer Guide. + // The settings can be modified using the UpdateTable operation. + // + // For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the + // Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html ProvisionedThroughput *ProvisionedThroughput // Represents the settings used to enable server-side encryption. @@ -2785,17 +3114,21 @@ type TableDescription struct { ArchivalSummary *ArchivalSummary // 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: + // 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. 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] format. + // + // [UNIX epoch time]: http://www.epochconverter.com/ CreationDateTime *time.Time // Indicates whether deletion protection is enabled (true) or disabled (false) on @@ -2804,53 +3137,75 @@ 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.) + // 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) - // in use, if the table is replicated across Amazon Web Services Regions. + // Represents the version of [global tables] in use, if the table is replicated across Amazon Web + // Services Regions. + // + // [global tables]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html GlobalTableVersion *string // The number of items in the specified table. DynamoDB updates this value @@ -2859,30 +3214,45 @@ 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) - // in the Amazon DynamoDB Developer Guide. + // + // - 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] in the Amazon DynamoDB Developer + // Guide. + // + // [Primary Key]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey KeySchema []KeySchemaElement // The Amazon Resource Name (ARN) that uniquely identifies the latest stream for // 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 - // from another table might have the same timestamp. However, the combination of - // the following three elements is guaranteed to be unique: + // 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 LatestStreamLabel *string @@ -2892,29 +3262,39 @@ type TableDescription struct { // 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 @@ -2958,17 +3338,24 @@ 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. TableStatus TableStatus @@ -2977,13 +3364,18 @@ 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) -// in the Amazon DynamoDB Developer Guide. +// 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] in the Amazon DynamoDB +// Developer Guide. +// +// [Tagging for DynamoDB]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html type Tag struct { // The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only @@ -3004,10 +3396,10 @@ type Tag struct { // The description of the Time to Live (TTL) status on the specified table. type TimeToLiveDescription struct { - // The name of the TTL attribute for items in the table. + // The name of the TTL attribute for items in the table. AttributeName *string - // The TTL status for the table. + // The TTL status for the table. TimeToLiveStatus TimeToLiveStatus noSmithyDocumentSerde @@ -3116,9 +3508,12 @@ type UpdateGlobalSecondaryIndexAction struct { OnDemandThroughput *OnDemandThroughput // 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) - // in the Amazon DynamoDB Developer Guide. + // secondary index. + // + // For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas] in the + // Amazon DynamoDB Developer Guide. + // + // [Service, Account, and Table Quotas]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html ProvisionedThroughput *ProvisionedThroughput noSmithyDocumentSerde diff --git a/service/dynamodbstreams/api_op_DescribeStream.go b/service/dynamodbstreams/api_op_DescribeStream.go index db07d2412e3..b0d7259ec2e 100644 --- a/service/dynamodbstreams/api_op_DescribeStream.go +++ b/service/dynamodbstreams/api_op_DescribeStream.go @@ -13,12 +13,15 @@ import ( // Returns information about a stream, including the current status of the stream, // its Amazon Resource Name (ARN), the composition of its shards, and its -// 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 -// stream records). If both StartingSequenceNumber and EndingSequenceNumber are -// present, then that shard is closed and can no longer receive more data. +// 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 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) { if params == nil { params = &DescribeStreamInput{} diff --git a/service/dynamodbstreams/api_op_GetRecords.go b/service/dynamodbstreams/api_op_GetRecords.go index 4e5a11103f2..0b55415f797 100644 --- a/service/dynamodbstreams/api_op_GetRecords.go +++ b/service/dynamodbstreams/api_op_GetRecords.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the stream records from a given shard. Specify a shard iterator using -// the ShardIterator parameter. The shard iterator specifies the position in the -// shard from which you want to start reading stream records sequentially. If there -// are no stream records available in the portion of the shard that the iterator -// points to, GetRecords returns an empty list. Note that it might take multiple -// calls to get to a portion of the shard that contains stream records. GetRecords -// can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes -// first. +// Retrieves the stream records from a given shard. +// +// Specify a shard iterator using the ShardIterator parameter. The shard iterator +// specifies the position in the shard from which you want to start reading stream +// records sequentially. If there are no stream records available in the portion of +// the shard that the iterator points to, GetRecords returns an empty list. Note +// that it might take multiple calls to get to a portion of the shard that contains +// stream records. +// +// GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, +// whichever comes first. func (c *Client) GetRecords(ctx context.Context, params *GetRecordsInput, optFns ...func(*Options)) (*GetRecordsOutput, error) { if params == nil { params = &GetRecordsInput{} diff --git a/service/dynamodbstreams/api_op_GetShardIterator.go b/service/dynamodbstreams/api_op_GetShardIterator.go index f39d19bc43c..c20f8bd5acc 100644 --- a/service/dynamodbstreams/api_op_GetShardIterator.go +++ b/service/dynamodbstreams/api_op_GetShardIterator.go @@ -13,8 +13,9 @@ 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,14 +41,18 @@ 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. // diff --git a/service/dynamodbstreams/api_op_ListStreams.go b/service/dynamodbstreams/api_op_ListStreams.go index 817d777413d..03bd64b15dd 100644 --- a/service/dynamodbstreams/api_op_ListStreams.go +++ b/service/dynamodbstreams/api_op_ListStreams.go @@ -13,8 +13,9 @@ 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{} @@ -53,8 +54,11 @@ type ListStreamsOutput struct { // The stream ARN of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this - // value in the new request. If LastEvaluatedStreamArn is empty, then the "last - // page" of results has been processed and there is no more data to be retrieved. + // value in the new request. + // + // If LastEvaluatedStreamArn is empty, then the "last page" of results has been + // processed and there is no more data to be retrieved. + // // If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there // is more data in the result set. The only way to know when you have reached the // end of the result set is when LastEvaluatedStreamArn is empty. diff --git a/service/dynamodbstreams/doc.go b/service/dynamodbstreams/doc.go index 6c1902cb960..1e9d09b4c00 100644 --- a/service/dynamodbstreams/doc.go +++ b/service/dynamodbstreams/doc.go @@ -3,8 +3,11 @@ // 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) -// in the Amazon DynamoDB Developer Guide. +// # 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]in the Amazon DynamoDB Developer Guide. +// +// [Capturing Table Activity with DynamoDB Streams]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html package dynamodbstreams diff --git a/service/dynamodbstreams/options.go b/service/dynamodbstreams/options.go index 6304b262f06..6a8561cc0ad 100644 --- a/service/dynamodbstreams/options.go +++ b/service/dynamodbstreams/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/dynamodbstreams/types/enums.go b/service/dynamodbstreams/types/enums.go index 9bf4e095381..4564c0fd2a5 100644 --- a/service/dynamodbstreams/types/enums.go +++ b/service/dynamodbstreams/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for KeyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyType) Values() []KeyType { return []KeyType{ "HASH", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "INSERT", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for ShardIteratorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShardIteratorType) Values() []ShardIteratorType { return []ShardIteratorType{ "TRIM_HORIZON", @@ -73,8 +76,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for StreamViewType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamViewType) Values() []StreamViewType { return []StreamViewType{ "NEW_IMAGE", diff --git a/service/dynamodbstreams/types/errors.go b/service/dynamodbstreams/types/errors.go index 09329a9c57a..b1acc7d516d 100644 --- a/service/dynamodbstreams/types/errors.go +++ b/service/dynamodbstreams/types/errors.go @@ -62,17 +62,26 @@ func (e *InternalServerError) ErrorCode() string { func (e *InternalServerError) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // 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 +// 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. GetRecords was called with a value of more than 1000 for the -// limit request parameter. More than 2 processes are reading from the same streams -// shard at the same time. Exceeding this limit may result in request throttling. +// 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. +// +// GetRecords was called with a value of more than 1000 for the limit request +// parameter. +// +// More than 2 processes are reading from the same streams shard at the same time. +// Exceeding this limit may result in request throttling. type LimitExceededException struct { Message *string @@ -125,12 +134,15 @@ func (e *ResourceNotFoundException) ErrorCode() string { } func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation attempted to read past the oldest stream record in a shard. In -// DynamoDB Streams, there is a 24 hour limit on data retention. Stream records +// The operation attempted to read past the oldest stream record in a 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. // 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. diff --git a/service/dynamodbstreams/types/types.go b/service/dynamodbstreams/types/types.go index 0e2d3522338..bfd4ad48d0f 100644 --- a/service/dynamodbstreams/types/types.go +++ b/service/dynamodbstreams/types/types.go @@ -7,10 +7,12 @@ import ( "time" ) -// 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) -// in the Amazon DynamoDB Developer Guide. +// 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] in the Amazon DynamoDB Developer Guide. // // The following types satisfy this interface: // @@ -24,12 +26,15 @@ import ( // AttributeValueMemberNULL // AttributeValueMemberS // AttributeValueMemberSS +// +// [Data Types]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes type AttributeValue interface { isAttributeValue() } -// An attribute of type Binary. For example: "B": -// "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" +// An attribute of type Binary. For example: +// +// "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" type AttributeValueMemberB struct { Value []byte @@ -38,7 +43,9 @@ type AttributeValueMemberB struct { func (*AttributeValueMemberB) isAttributeValue() {} -// An attribute of type Boolean. For example: "BOOL": true +// An attribute of type Boolean. For example: +// +// "BOOL": true type AttributeValueMemberBOOL struct { Value bool @@ -47,8 +54,9 @@ type AttributeValueMemberBOOL struct { func (*AttributeValueMemberBOOL) isAttributeValue() {} -// An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=", -// "U25vd3k="] +// An attribute of type Binary Set. For example: +// +// "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="] type AttributeValueMemberBS struct { Value [][]byte @@ -57,8 +65,9 @@ type AttributeValueMemberBS struct { func (*AttributeValueMemberBS) isAttributeValue() {} -// An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": -// "Coffee"}, {"N": "3.14159"}] +// An attribute of type List. For example: +// +// "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}] type AttributeValueMemberL struct { Value []AttributeValue @@ -67,8 +76,9 @@ type AttributeValueMemberL struct { func (*AttributeValueMemberL) isAttributeValue() {} -// An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": -// "35"}} +// An attribute of type Map. For example: +// +// "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}} type AttributeValueMemberM struct { Value map[string]AttributeValue @@ -77,10 +87,13 @@ type AttributeValueMemberM struct { func (*AttributeValueMemberM) isAttributeValue() {} -// An attribute of type Number. For example: "N": "123.45" Numbers are sent across -// the network to DynamoDB as strings, to maximize compatibility across languages -// and libraries. However, DynamoDB treats them as number type attributes for -// mathematical operations. +// An attribute of type Number. For example: +// +// "N": "123.45" +// +// Numbers are sent across the network to DynamoDB as strings, to maximize +// compatibility across languages and libraries. However, DynamoDB treats them as +// number type attributes for mathematical operations. type AttributeValueMemberN struct { Value string @@ -89,8 +102,11 @@ type AttributeValueMemberN struct { func (*AttributeValueMemberN) isAttributeValue() {} -// An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", -// "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize +// An attribute of type Number Set. For example: +// +// "NS": ["42.2", "-19", "7.5", "3.14"] +// +// Numbers are sent across the network to DynamoDB as strings, to maximize // compatibility across languages and libraries. However, DynamoDB treats them as // number type attributes for mathematical operations. type AttributeValueMemberNS struct { @@ -101,7 +117,9 @@ type AttributeValueMemberNS struct { func (*AttributeValueMemberNS) isAttributeValue() {} -// An attribute of type Null. For example: "NULL": true +// An attribute of type Null. For example: +// +// "NULL": true type AttributeValueMemberNULL struct { Value bool @@ -110,7 +128,9 @@ type AttributeValueMemberNULL struct { func (*AttributeValueMemberNULL) isAttributeValue() {} -// An attribute of type String. For example: "S": "Hello" +// An attribute of type String. For example: +// +// "S": "Hello" type AttributeValueMemberS struct { Value string @@ -119,8 +139,9 @@ type AttributeValueMemberS struct { func (*AttributeValueMemberS) isAttributeValue() {} -// An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" -// ,"Zebra"] +// An attribute of type String Set. For example: +// +// "SS": ["Giraffe", "Hippo" ,"Zebra"] type AttributeValueMemberSS struct { Value []string @@ -144,12 +165,15 @@ type Identity struct { // Represents a single element of a key schema. A key schema specifies the // attributes that make up the primary key of a table, or the key attributes of an -// index. A KeySchemaElement represents exactly one attribute of the primary key. -// 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 +// index. +// +// A KeySchemaElement represents exactly one attribute of the primary key. 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 // attribute cannot be nested within a List or a Map. type KeySchemaElement struct { @@ -159,14 +183,19 @@ 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 - // 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. + // 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. // // This member is required. KeyType KeyType @@ -189,8 +218,11 @@ 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 EventName OperationType @@ -199,16 +231,23 @@ type Record struct { 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. + // 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. 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 @@ -250,12 +289,17 @@ 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 - // from another table might have the same timestamp. However, the combination of - // the following three elements is guaranteed to be unique: + // 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 Amazon Web Services customer ID. + // // - the table name + // // - the StreamLabel StreamLabel *string @@ -276,11 +320,14 @@ type StreamDescription struct { // The shard ID of the item where the operation stopped, inclusive of the previous // result set. Use this value to start a new operation, excluding this value in the - // new request. If LastEvaluatedShardId is empty, then the "last page" of results - // has been processed and there is currently no more data to be retrieved. If - // LastEvaluatedShardId is not empty, it does not necessarily mean that there is - // more data in the result set. The only way to know when you have reached the end - // of the result set is when LastEvaluatedShardId is empty. + // new request. + // + // If LastEvaluatedShardId is empty, then the "last page" of results has been + // processed and there is currently no more data to be retrieved. + // + // If LastEvaluatedShardId is not empty, it does not necessarily mean that there + // is more data in the result set. The only way to know when you have reached the + // end of the result set is when LastEvaluatedShardId is empty. LastEvaluatedShardId *string // The shards that comprise the stream. @@ -289,29 +336,42 @@ 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 - // from another table might have the same timestamp. However, the combination of - // the following three elements is guaranteed to be unique: + // 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 Amazon Web Services 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. 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. StreamViewType StreamViewType @@ -326,9 +386,10 @@ type StreamDescription struct { // DynamoDB table. type StreamRecord struct { - // The approximate date and time when the stream record was created, in UNIX epoch - // time (http://www.epochconverter.com/) format and rounded down to the closest - // second. + // The approximate date and time when the stream record was created, in [UNIX epoch time] format + // and rounded down to the closest second. + // + // [UNIX epoch time]: http://www.epochconverter.com/ ApproximateCreationDateTime *time.Time // The primary key attribute(s) for the DynamoDB item that was modified. @@ -348,9 +409,13 @@ 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. StreamViewType StreamViewType diff --git a/service/ebs/api_op_CompleteSnapshot.go b/service/ebs/api_op_CompleteSnapshot.go index 911aff22335..770c28c2ec1 100644 --- a/service/ebs/api_op_CompleteSnapshot.go +++ b/service/ebs/api_op_CompleteSnapshot.go @@ -13,11 +13,13 @@ 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. You -// should always retry requests that receive server ( 5xx ) error responses, and -// ThrottlingException and RequestThrottledException client error responses. For -// more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// in the Amazon Elastic Compute Cloud User Guide. +// You cannot write new blocks to a snapshot after it has been completed. +// +// You should always retry requests that receive server ( 5xx ) error responses, +// and ThrottlingException and RequestThrottledException client error responses. +// For more information see [Error retries]in the Amazon Elastic Compute Cloud User Guide. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html func (c *Client) CompleteSnapshot(ctx context.Context, params *CompleteSnapshotInput, optFns ...func(*Options)) (*CompleteSnapshotOutput, error) { if params == nil { params = &CompleteSnapshotInput{} @@ -46,7 +48,9 @@ type CompleteSnapshotInput struct { SnapshotId *string // An aggregated Base-64 SHA256 checksum based on the checksums of each written - // block. To generate the aggregated checksum using the linear aggregation method, + // block. + // + // To generate the aggregated checksum using the linear aggregation method, // arrange the checksums for each written block in ascending order of their block // index, concatenate them to form a single string, and then generate the checksum // on the entire string using the SHA256 algorithm. diff --git a/service/ebs/api_op_GetSnapshotBlock.go b/service/ebs/api_op_GetSnapshotBlock.go index f19919215bd..dd2038838a4 100644 --- a/service/ebs/api_op_GetSnapshotBlock.go +++ b/service/ebs/api_op_GetSnapshotBlock.go @@ -12,11 +12,13 @@ import ( "io" ) -// Returns the data in a block in an Amazon Elastic Block Store snapshot. You -// should always retry requests that receive server ( 5xx ) error responses, and -// ThrottlingException and RequestThrottledException client error responses. For -// more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// in the Amazon Elastic Compute Cloud User Guide. +// Returns the data in a block in an Amazon Elastic Block Store snapshot. +// +// You should always retry requests that receive server ( 5xx ) error responses, +// and ThrottlingException and RequestThrottledException client error responses. +// For more information see [Error retries]in the Amazon Elastic Compute Cloud User Guide. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html func (c *Client) GetSnapshotBlock(ctx context.Context, params *GetSnapshotBlockInput, optFns ...func(*Options)) (*GetSnapshotBlockOutput, error) { if params == nil { params = &GetSnapshotBlockInput{} @@ -49,11 +51,13 @@ type GetSnapshotBlockInput struct { // This member is required. BlockToken *string - // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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]in the + // Amazon Elastic Compute Cloud User Guide. + // + // [Using encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html // // This member is required. SnapshotId *string diff --git a/service/ebs/api_op_ListChangedBlocks.go b/service/ebs/api_op_ListChangedBlocks.go index ffe9d59b0bb..ac2f2a9f24c 100644 --- a/service/ebs/api_op_ListChangedBlocks.go +++ b/service/ebs/api_op_ListChangedBlocks.go @@ -13,11 +13,13 @@ import ( ) // Returns information about the blocks that are different between two Amazon -// Elastic Block Store snapshots of the same volume/snapshot lineage. You should -// always retry requests that receive server ( 5xx ) error responses, and -// ThrottlingException and RequestThrottledException client error responses. For -// more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// in the Amazon Elastic Compute Cloud User Guide. +// Elastic Block Store snapshots of the same volume/snapshot lineage. +// +// You should always retry requests that receive server ( 5xx ) error responses, +// and ThrottlingException and RequestThrottledException client error responses. +// For more information see [Error retries]in the Amazon Elastic Compute Cloud User Guide. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html func (c *Client) ListChangedBlocks(ctx context.Context, params *ListChangedBlocksInput, optFns ...func(*Options)) (*ListChangedBlocksOutput, error) { if params == nil { params = &ListChangedBlocksInput{} @@ -35,32 +37,41 @@ func (c *Client) ListChangedBlocks(ctx context.Context, params *ListChangedBlock type ListChangedBlocksInput struct { - // The ID of the second snapshot to use for the comparison. The SecondSnapshotId - // parameter must be specified with a FirstSnapshotID parameter; otherwise, an - // error occurs. + // The ID of the second snapshot to use for the comparison. + // + // The SecondSnapshotId parameter must be specified with a FirstSnapshotID + // parameter; otherwise, an error occurs. // // This member is required. SecondSnapshotId *string - // The ID of the first snapshot to use for the comparison. The FirstSnapshotID - // parameter must be specified with a SecondSnapshotId parameter; otherwise, an - // error occurs. + // The ID of the first snapshot to use for the comparison. + // + // The FirstSnapshotID parameter must be specified with a SecondSnapshotId + // parameter; otherwise, an error occurs. FirstSnapshotId *string - // The maximum number of blocks to be returned by the request. Even if additional - // blocks can be retrieved from the snapshot, the request can return less blocks - // than MaxResults or an empty array of blocks. To retrieve the next set of blocks - // from the snapshot, make another request with the returned NextToken value. The - // value of NextToken is null when there are no more blocks to return. + // The maximum number of blocks to be returned by the request. + // + // Even if additional blocks can be retrieved from the snapshot, the request can + // return less blocks than MaxResults or an empty array of blocks. + // + // To retrieve the next set of blocks from the snapshot, make another request with + // the returned NextToken value. The value of NextToken is null when there are no + // more blocks to return. MaxResults *int32 - // The token to request the next page of results. If you specify NextToken, then - // StartingBlockIndex is ignored. + // The token to request the next page of results. + // + // If you specify NextToken, then 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 @@ -179,11 +190,14 @@ var _ ListChangedBlocksAPIClient = (*Client)(nil) // ListChangedBlocksPaginatorOptions is the paginator options for ListChangedBlocks type ListChangedBlocksPaginatorOptions struct { - // The maximum number of blocks to be returned by the request. Even if additional - // blocks can be retrieved from the snapshot, the request can return less blocks - // than MaxResults or an empty array of blocks. To retrieve the next set of blocks - // from the snapshot, make another request with the returned NextToken value. The - // value of NextToken is null when there are no more blocks to return. + // The maximum number of blocks to be returned by the request. + // + // Even if additional blocks can be retrieved from the snapshot, the request can + // return less blocks than MaxResults or an empty array of blocks. + // + // To retrieve the next set of blocks from the snapshot, make another request with + // the returned NextToken value. The value of NextToken is null when there are no + // more blocks to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ebs/api_op_ListSnapshotBlocks.go b/service/ebs/api_op_ListSnapshotBlocks.go index 2eb37629734..c4d32c1abd6 100644 --- a/service/ebs/api_op_ListSnapshotBlocks.go +++ b/service/ebs/api_op_ListSnapshotBlocks.go @@ -13,10 +13,12 @@ import ( ) // Returns information about the blocks in an Amazon Elastic Block Store snapshot. +// // You should always retry requests that receive server ( 5xx ) error responses, // and ThrottlingException and RequestThrottledException client error responses. -// For more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// in the Amazon Elastic Compute Cloud User Guide. +// For more information see [Error retries]in the Amazon Elastic Compute Cloud User Guide. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html func (c *Client) ListSnapshotBlocks(ctx context.Context, params *ListSnapshotBlocksInput, optFns ...func(*Options)) (*ListSnapshotBlocksOutput, error) { if params == nil { params = &ListSnapshotBlocksInput{} @@ -39,20 +41,25 @@ type ListSnapshotBlocksInput struct { // This member is required. SnapshotId *string - // The maximum number of blocks to be returned by the request. Even if additional - // blocks can be retrieved from the snapshot, the request can return less blocks - // than MaxResults or an empty array of blocks. To retrieve the next set of blocks - // from the snapshot, make another request with the returned NextToken value. The - // value of NextToken is null when there are no more blocks to return. + // The maximum number of blocks to be returned by the request. + // + // Even if additional blocks can be retrieved from the snapshot, the request can + // return less blocks than MaxResults or an empty array of blocks. + // + // To retrieve the next set of blocks from the snapshot, make another request with + // the returned NextToken value. The value of NextToken is null when there are no + // more blocks to return. MaxResults *int32 - // The token to request the next page of results. If you specify NextToken, then - // StartingBlockIndex is ignored. + // The token to request the next page of results. + // + // If you specify NextToken, then StartingBlockIndex is ignored. NextToken *string // The block index from which the list should start. The list in the response will - // start from this block index or the next valid block index in the snapshot. If - // you specify NextToken, then StartingBlockIndex is ignored. + // start from this block index or the next valid block index in the snapshot. + // + // If you specify NextToken, then StartingBlockIndex is ignored. StartingBlockIndex *int32 noSmithyDocumentSerde @@ -172,11 +179,14 @@ var _ ListSnapshotBlocksAPIClient = (*Client)(nil) // ListSnapshotBlocksPaginatorOptions is the paginator options for // ListSnapshotBlocks type ListSnapshotBlocksPaginatorOptions struct { - // The maximum number of blocks to be returned by the request. Even if additional - // blocks can be retrieved from the snapshot, the request can return less blocks - // than MaxResults or an empty array of blocks. To retrieve the next set of blocks - // from the snapshot, make another request with the returned NextToken value. The - // value of NextToken is null when there are no more blocks to return. + // The maximum number of blocks to be returned by the request. + // + // Even if additional blocks can be retrieved from the snapshot, the request can + // return less blocks than MaxResults or an empty array of blocks. + // + // To retrieve the next set of blocks from the snapshot, make another request with + // the returned NextToken value. The value of NextToken is null when there are no + // more blocks to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ebs/api_op_PutSnapshotBlock.go b/service/ebs/api_op_PutSnapshotBlock.go index 2386b85df19..93740399677 100644 --- a/service/ebs/api_op_PutSnapshotBlock.go +++ b/service/ebs/api_op_PutSnapshotBlock.go @@ -14,11 +14,14 @@ import ( // Writes a block of data to a snapshot. If the specified block contains data, the // existing data is overwritten. The target snapshot must be in the pending state. -// Data written to a snapshot must be aligned with 512-KiB sectors. You should -// always retry requests that receive server ( 5xx ) error responses, and -// ThrottlingException and RequestThrottledException client error responses. For -// more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// in the Amazon Elastic Compute Cloud User Guide. +// +// Data written to a snapshot must be aligned with 512-KiB sectors. +// +// You should always retry requests that receive server ( 5xx ) error responses, +// and ThrottlingException and RequestThrottledException client error responses. +// For more information see [Error retries]in the Amazon Elastic Compute Cloud User Guide. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html func (c *Client) PutSnapshotBlock(ctx context.Context, params *PutSnapshotBlockInput, optFns ...func(*Options)) (*PutSnapshotBlockOutput, error) { if params == nil { params = &PutSnapshotBlockInput{} @@ -36,16 +39,18 @@ func (c *Client) PutSnapshotBlock(ctx context.Context, params *PutSnapshotBlockI type PutSnapshotBlockInput struct { - // The data to write to the block. The block data is not signed as part of the - // Signature Version 4 signing process. As a result, you must generate and provide - // a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum - // header. Also, you must specify the checksum algorithm using the - // x-amz-Checksum-Algorithm header. The checksum that you provide is part of the - // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // The data to write to the block. + // + // The block data is not signed as part of the Signature Version 4 signing + // process. As a result, you must generate and provide a Base64-encoded SHA256 + // checksum for the block data using the x-amz-Checksum header. Also, you must + // specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The + // checksum that you provide is part of the 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [Using checksums with the EBS direct APIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums // // This member is required. BlockData io.Reader @@ -72,15 +77,20 @@ type PutSnapshotBlockInput struct { ChecksumAlgorithm types.ChecksumAlgorithm // The size of the data to write to the block, in bytes. Currently, the only - // supported size is 524288 bytes. Valid values: 524288 + // supported size is 524288 bytes. + // + // Valid values: 524288 // // This member is required. DataLength *int32 - // 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) - // in the Amazon Elastic Compute Cloud User Guide.. + // 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]in the + // Amazon Elastic Compute Cloud User Guide.. + // + // [Using encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html // // This member is required. SnapshotId *string diff --git a/service/ebs/api_op_StartSnapshot.go b/service/ebs/api_op_StartSnapshot.go index 5fa50e3ba24..1abb3c69354 100644 --- a/service/ebs/api_op_StartSnapshot.go +++ b/service/ebs/api_op_StartSnapshot.go @@ -13,12 +13,16 @@ 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) -// to write blocks of data to the snapshot. You should always retry requests that -// receive server ( 5xx ) error responses, and ThrottlingException and -// RequestThrottledException client error responses. For more information see -// Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// in the Amazon Elastic Compute Cloud User Guide. +// after the request completes. +// +// After creating the snapshot, use [PutSnapshotBlock] to write blocks of data to the snapshot. +// +// You should always retry requests that receive server ( 5xx ) error responses, +// and ThrottlingException and RequestThrottledException client error responses. +// For more information see [Error retries]in the Amazon Elastic Compute Cloud User Guide. +// +// [PutSnapshotBlock]: https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html func (c *Client) StartSnapshot(ctx context.Context, params *StartSnapshotInput, optFns ...func(*Options)) (*StartSnapshotOutput, error) { if params == nil { params = &StartSnapshotInput{} @@ -45,52 +49,71 @@ type StartSnapshotInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully. The // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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] in the Amazon Elastic Compute Cloud User Guide. + // + // [Idempotency for StartSnapshot API]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html ClientToken *string // A description for the snapshot. Description *string - // 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 - // 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) - // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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 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]. For more information, see [Using encryption] 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [Permissions to use Key Management Service keys]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions + // [encryption by default]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default + // [Using encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html 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) - // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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]. For more information, see [Using encryption] 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [Permissions to use Key Management Service keys]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions + // [encryption by default]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default + // [Using encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html 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 - // 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) - // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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 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]. For more information, see [Using encryption] 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [Permissions to use Key Management Service keys]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions + // [encryption by default]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default + // [Using encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html ParentSnapshotId *string // The tags to apply to the snapshot. @@ -98,8 +121,11 @@ 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. Timeout *int32 @@ -137,8 +163,9 @@ 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [Tagging your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html Tags []types.Tag // The size of the volume, in GiB. diff --git a/service/ebs/doc.go b/service/ebs/doc.go index 2d188ee7ce1..3468282bb9b 100644 --- a/service/ebs/doc.go +++ b/service/ebs/doc.go @@ -10,19 +10,23 @@ // Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to // track incremental changes on your Amazon EBS volumes through snapshots. This can // be done without having to create new volumes from snapshots, and then use Amazon -// Elastic Compute Cloud (Amazon EC2) instances to compare the differences. You can -// create incremental snapshots directly from data on-premises into volumes and the -// cloud to use for quick disaster recovery. With the ability to write and read -// snapshots, you can write your on-premises data to an snapshot during a disaster. -// Then after recovery, you can restore it back to Amazon Web Services or -// on-premises from the snapshot. You no longer need to build and maintain complex -// mechanisms to copy data to and from Amazon EBS. This API reference provides -// 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) -// 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. +// Elastic Compute Cloud (Amazon EC2) instances to compare the differences. +// +// You can create incremental snapshots directly from data on-premises into +// volumes and the cloud to use for quick disaster recovery. With the ability to +// write and read snapshots, you can write your on-premises data to an snapshot +// during a disaster. Then after recovery, you can restore it back to Amazon Web +// Services or on-premises from the snapshot. You no longer need to build and +// maintain complex mechanisms to copy data to and from Amazon EBS. +// +// This API reference provides 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]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]in the Amazon Web Services General +// Reference. +// +// [Accessing the Contents of an Amazon EBS Snapshot]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html +// [Amazon Elastic Block Store Endpoints and Quotas]: https://docs.aws.amazon.com/general/latest/gr/ebs-service.html package ebs diff --git a/service/ebs/options.go b/service/ebs/options.go index f36c486c948..bc7006bd9ea 100644 --- a/service/ebs/options.go +++ b/service/ebs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ebs/types/enums.go b/service/ebs/types/enums.go index f725e5f3658..9282f337190 100644 --- a/service/ebs/types/enums.go +++ b/service/ebs/types/enums.go @@ -12,6 +12,7 @@ const ( // Values returns all known values for AccessDeniedExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AccessDeniedExceptionReason) Values() []AccessDeniedExceptionReason { return []AccessDeniedExceptionReason{ @@ -29,6 +30,7 @@ const ( // Values returns all known values for ChecksumAggregationMethod. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ChecksumAggregationMethod) Values() []ChecksumAggregationMethod { return []ChecksumAggregationMethod{ @@ -44,8 +46,9 @@ const ( ) // Values returns all known values for ChecksumAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChecksumAlgorithm) Values() []ChecksumAlgorithm { return []ChecksumAlgorithm{ "SHA256", @@ -63,8 +66,9 @@ const ( // Values returns all known values for RequestThrottledExceptionReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestThrottledExceptionReason) Values() []RequestThrottledExceptionReason { return []RequestThrottledExceptionReason{ "ACCOUNT_THROTTLED", @@ -85,8 +89,9 @@ const ( // Values returns all known values for ResourceNotFoundExceptionReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceNotFoundExceptionReason) Values() []ResourceNotFoundExceptionReason { return []ResourceNotFoundExceptionReason{ "SNAPSHOT_NOT_FOUND", @@ -105,8 +110,9 @@ const ( // Values returns all known values for ServiceQuotaExceededExceptionReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceQuotaExceededExceptionReason) Values() []ServiceQuotaExceededExceptionReason { return []ServiceQuotaExceededExceptionReason{ "DEPENDENCY_SERVICE_QUOTA_EXCEEDED", @@ -123,8 +129,9 @@ const ( ) // Values returns all known values for SSEType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SSEType) Values() []SSEType { return []SSEType{ "sse-ebs", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "completed", @@ -176,6 +184,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/ebs/types/errors.go b/service/ebs/types/errors.go index 6888d9ad28f..9e95966e2af 100644 --- a/service/ebs/types/errors.go +++ b/service/ebs/types/errors.go @@ -36,8 +36,9 @@ 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) -// in the Amazon Elastic Compute Cloud User Guide. +// see [Optimizing performance of the EBS direct APIs]in the Amazon Elastic Compute Cloud User Guide. +// +// [Optimizing performance of the EBS direct APIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance type ConcurrentLimitExceededException struct { Message *string @@ -89,8 +90,9 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An internal error has occurred. For more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// . +// An internal error has occurred. For more information see [Error retries]. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html type InternalServerException struct { Message *string @@ -117,8 +119,9 @@ func (e *InternalServerException) ErrorCode() string { func (e *InternalServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // The number of API requests has exceeded the maximum allowed API request -// throttling limit for the snapshot. For more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html) -// . +// throttling limit for the snapshot. For more information see [Error retries]. +// +// [Error retries]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html type RequestThrottledException struct { Message *string diff --git a/service/ec2/api_op_AcceptAddressTransfer.go b/service/ec2/api_op_AcceptAddressTransfer.go index 89554466f59..af8f4872c4a 100644 --- a/service/ec2/api_op_AcceptAddressTransfer.go +++ b/service/ec2/api_op_AcceptAddressTransfer.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Virtual Private Cloud User Guide. +// Accepts an Elastic IP address transfer. For more information, see [Accept a transferred Elastic IP address] in the +// Amazon Virtual Private Cloud User Guide. +// +// [Accept a transferred Elastic IP address]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept func (c *Client) AcceptAddressTransfer(ctx context.Context, params *AcceptAddressTransferInput, optFns ...func(*Options)) (*AcceptAddressTransferOutput, error) { if params == nil { params = &AcceptAddressTransferInput{} diff --git a/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go b/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go index e39977c0056..76a9c0ce5ab 100644 --- a/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go +++ b/service/ec2/api_op_AcceptReservedInstancesExchangeQuote.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Accepts the Convertible Reserved Instance exchange quote described in the -// GetReservedInstancesExchangeQuote call. +// Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. func (c *Client) AcceptReservedInstancesExchangeQuote(ctx context.Context, params *AcceptReservedInstancesExchangeQuoteInput, optFns ...func(*Options)) (*AcceptReservedInstancesExchangeQuoteOutput, error) { if params == nil { params = &AcceptReservedInstancesExchangeQuoteInput{} diff --git a/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go b/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go index dbb03c91efe..1c3095f4630 100644 --- a/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_AcceptTransitGatewayVpcAttachment.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Accepts a request to attach a VPC to a transit gateway. The VPC attachment must -// be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to -// view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment -// to reject a VPC attachment request. +// Accepts a request to attach a VPC to a transit gateway. +// +// The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your +// pending VPC attachment requests. Use RejectTransitGatewayVpcAttachmentto reject a VPC attachment request. func (c *Client) AcceptTransitGatewayVpcAttachment(ctx context.Context, params *AcceptTransitGatewayVpcAttachmentInput, optFns ...func(*Options)) (*AcceptTransitGatewayVpcAttachmentOutput, error) { if params == nil { params = &AcceptTransitGatewayVpcAttachmentInput{} diff --git a/service/ec2/api_op_AcceptVpcPeeringConnection.go b/service/ec2/api_op_AcceptVpcPeeringConnection.go index 6f9cb58d9c1..6dd021a5211 100644 --- a/service/ec2/api_op_AcceptVpcPeeringConnection.go +++ b/service/ec2/api_op_AcceptVpcPeeringConnection.go @@ -13,9 +13,10 @@ 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 -// 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. +// of the peer VPC. Use DescribeVpcPeeringConnectionsto 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) { if params == nil { params = &AcceptVpcPeeringConnectionInput{} diff --git a/service/ec2/api_op_AdvertiseByoipCidr.go b/service/ec2/api_op_AdvertiseByoipCidr.go index a292612a11f..8a12ff5fd87 100644 --- a/service/ec2/api_op_AdvertiseByoipCidr.go +++ b/service/ec2/api_op_AdvertiseByoipCidr.go @@ -12,17 +12,21 @@ import ( ) // Advertises an IPv4 or IPv6 address range that is provisioned for use with your -// Amazon Web Services resources through bring your own IP addresses (BYOIP). You -// can perform this operation at most once every 10 seconds, even if you specify -// different address ranges each time. We recommend that you stop advertising the -// BYOIP CIDR from other locations when you advertise it from Amazon Web Services. -// To minimize down time, you can configure your Amazon Web Services resources to -// use an address from a BYOIP CIDR before it is advertised, and then -// simultaneously stop advertising it from the current location and start -// 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 . +// Amazon Web Services resources through bring your own IP addresses (BYOIP). +// +// You can perform this operation at most once every 10 seconds, even if you +// specify different address ranges each time. +// +// We recommend that you stop advertising the BYOIP CIDR from other locations when +// you advertise it from Amazon Web Services. To minimize down time, you can +// configure your Amazon Web Services resources to use an address from a BYOIP CIDR +// before it is advertised, and then simultaneously stop advertising it from the +// current location and start 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. func (c *Client) AdvertiseByoipCidr(ctx context.Context, params *AdvertiseByoipCidrInput, optFns ...func(*Options)) (*AdvertiseByoipCidrOutput, error) { if params == nil { params = &AdvertiseByoipCidrInput{} @@ -55,17 +59,24 @@ type AdvertiseByoipCidrInput struct { // UnauthorizedOperation . DryRun *bool - // If you have Local Zones (https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html) - // enabled, you can choose a network border group for Local Zones when you - // provision and advertise a BYOIPv4 CIDR. Choose the network border group + // If you have [Local Zones] enabled, you can choose a network border group for Local Zones + // when you provision and advertise a BYOIPv4 CIDR. Choose the network border group // carefully as the EIP and the Amazon Web Services resource it is associated with - // must reside in the same network border group. You can provision BYOIP address - // ranges to and advertise them in the following Local Zone network border groups: + // must reside in the same network border group. + // + // You can provision BYOIP address ranges to and advertise them in the following + // Local Zone network border groups: + // // - us-east-1-dfw-2 + // // - us-west-2-lax-1 + // // - us-west-2-phx-2 + // // You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this // time. + // + // [Local Zones]: https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html NetworkBorderGroup *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_AllocateAddress.go b/service/ec2/api_op_AllocateAddress.go index 08ef056cdd1..45be9496afc 100644 --- a/service/ec2/api_op_AllocateAddress.go +++ b/service/ec2/api_op_AllocateAddress.go @@ -15,20 +15,26 @@ import ( // allocate the Elastic IP address you can associate it with an instance or network // interface. After you release an Elastic IP address, it is released to the IP // address pool and can be allocated to a different Amazon Web Services account. +// // You can allocate an Elastic IP address from an address pool owned by Amazon Web // 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. 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. To attempt to recover an Elastic IP address that you released, specify -// it in this operation. 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 -// EC2 instance). +// resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)] +// in the Amazon Elastic Compute Cloud User Guide. +// +// 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. To attempt to recover an Elastic IP address +// that you released, specify it in this operation. +// +// For more information, see [Elastic IP Addresses] 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 EC2 instance). +// +// [Bring Your Own IP Addresses (BYOIP)]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html +// [Elastic IP Addresses]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html func (c *Client) AllocateAddress(ctx context.Context, params *AllocateAddressInput, optFns ...func(*Options)) (*AllocateAddressOutput, error) { if params == nil { params = &AllocateAddressInput{} @@ -63,11 +69,14 @@ type AllocateAddressInput struct { // 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) - // to view the network border groups. + // 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] to view the network border groups. + // + // [DescribeAvailabilityZones]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html NetworkBorderGroup *string // The ID of an address pool that you own. Use this parameter to let Amazon EC2 diff --git a/service/ec2/api_op_AllocateHosts.go b/service/ec2/api_op_AllocateHosts.go index d4976b031a0..4084b4e96a8 100644 --- a/service/ec2/api_op_AllocateHosts.go +++ b/service/ec2/api_op_AllocateHosts.go @@ -41,53 +41,68 @@ type AllocateHostsInput struct { // latency between your workloads. This parameter is supported only if you specify // OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this // parameter. + // // - If you specify this parameter, you can omit Quantity. In this case, Amazon // EC2 allocates a Dedicated Host on each specified hardware asset. + // // - If you specify both AssetIds and Quantity, then the value for Quantity must // be equal to the number of asset IDs specified. AssetIds []string // 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) - // in the Amazon EC2 User Guide. Default: on + // launches that specify its unique host ID. For more information, see [Understanding auto-placement and affinity]in the + // Amazon EC2 User Guide. + // + // Default: on + // + // [Understanding auto-placement and affinity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding 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]. + // + // [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) - // in the Amazon EC2 User Guide. + // For more information, see [Host maintenance]in the Amazon EC2 User Guide. + // + // [Host maintenance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html 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) - // in the Amazon EC2 User Guide. Default: off + // Host recovery is disabled by default. For more information, see [Host recovery]in the Amazon + // EC2 User Guide. + // + // Default: off + // + // [Host recovery]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html HostRecovery types.HostRecovery // Specifies the instance family to be supported by the Dedicated Hosts. If you // specify an instance family, the Dedicated Hosts support multiple instance types - // within that instance family. If you want the Dedicated Hosts to support a - // specific instance type only, omit this parameter and specify InstanceType - // instead. You cannot specify InstanceFamily and InstanceType in the same request. + // within that instance family. + // + // If you want the Dedicated Hosts to support a specific instance type only, omit + // this parameter and specify InstanceType instead. You cannot specify + // InstanceFamily and InstanceType in the same request. InstanceFamily *string // Specifies the instance type to be supported by the Dedicated Hosts. If you // specify an instance type, the Dedicated Hosts support instances of the specified - // instance type only. If you want the Dedicated Hosts to support multiple instance - // types in a specific instance family, omit this parameter and specify - // InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in - // the same request. + // instance type only. + // + // If you want the Dedicated Hosts to support multiple instance types in a + // specific instance family, omit this parameter and specify InstanceFamily + // instead. You cannot specify InstanceType and InstanceFamily in the same request. InstanceType *string // The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to // allocate the Dedicated Host. If you specify OutpostArn, you can optionally - // specify AssetIds. If you are allocating the Dedicated Host in a Region, omit - // this parameter. + // specify AssetIds. + // + // If you are allocating the Dedicated Host in a Region, omit this parameter. OutpostArn *string // The number of Dedicated Hosts to allocate to your account with these diff --git a/service/ec2/api_op_AllocateIpamPoolCidr.go b/service/ec2/api_op_AllocateIpamPoolCidr.go index c3d7694c91f..2c9cd3aba29 100644 --- a/service/ec2/api_op_AllocateIpamPoolCidr.go +++ b/service/ec2/api_op_AllocateIpamPoolCidr.go @@ -13,12 +13,16 @@ import ( // Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool // locale. The locale is the Amazon Web Services Region where this IPAM pool is -// available for allocations. 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 -// consistency. The returned CIDR will not overlap with any other allocations from -// the same pool. +// available for allocations. +// +// 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]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. +// +// [Allocate CIDRs]: https://docs.aws.amazon.com/vpc/latest/ipam/allocate-cidrs-ipam.html func (c *Client) AllocateIpamPoolCidr(ctx context.Context, params *AllocateIpamPoolCidrInput, optFns ...func(*Options)) (*AllocateIpamPoolCidrOutput, error) { if params == nil { params = &AllocateIpamPoolCidrInput{} @@ -46,17 +50,21 @@ type AllocateIpamPoolCidrInput struct { AllowedCidrs []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. 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the allocation. @@ -74,11 +82,14 @@ type AllocateIpamPoolCidrInput struct { // 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. NetmaskLength *int32 diff --git a/service/ec2/api_op_AssignIpv6Addresses.go b/service/ec2/api_op_AssignIpv6Addresses.go index 1f4dd298205..23e88725564 100644 --- a/service/ec2/api_op_AssignIpv6Addresses.go +++ b/service/ec2/api_op_AssignIpv6Addresses.go @@ -15,13 +15,18 @@ 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) -// 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 [IP Addresses Per Network Interface Per Instance Type]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]in the Amazon Elastic Compute Cloud User +// Guide. +// +// [Assigning prefixes to Amazon EC2 network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html +// [IP Addresses Per Network Interface Per Instance Type]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI func (c *Client) AssignIpv6Addresses(ctx context.Context, params *AssignIpv6AddressesInput, optFns ...func(*Options)) (*AssignIpv6AddressesOutput, error) { if params == nil { params = &AssignIpv6AddressesInput{} diff --git a/service/ec2/api_op_AssignPrivateIpAddresses.go b/service/ec2/api_op_AssignPrivateIpAddresses.go index 4ca7798ca5a..e5fa9b9e140 100644 --- a/service/ec2/api_op_AssignPrivateIpAddresses.go +++ b/service/ec2/api_op_AssignPrivateIpAddresses.go @@ -12,24 +12,33 @@ import ( ) // Assigns one or more secondary private IP addresses to the specified network -// interface. You can specify one or more specific secondary IP addresses, or you -// 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) -// 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 -// asynchronous operation. When you move an IP address from one network interface -// to another, check network/interfaces/macs/mac/local-ipv4s in the instance -// metadata to confirm that the remapping is complete. You must specify either the -// 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. +// interface. +// +// You can specify one or more specific secondary IP addresses, or you 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]in the Amazon Elastic Compute Cloud User Guide. For more information +// about Elastic IP addresses, see [Elastic IP Addresses]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 asynchronous operation. When you move an IP +// address from one network interface to another, check +// network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that +// the remapping is complete. +// +// You must specify either the 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]in the Amazon Elastic Compute Cloud User +// Guide. +// +// [Assigning prefixes to Amazon EC2 network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html +// [Elastic IP Addresses]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html +// [Instance Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html func (c *Client) AssignPrivateIpAddresses(ctx context.Context, params *AssignPrivateIpAddressesInput, optFns ...func(*Options)) (*AssignPrivateIpAddressesOutput, error) { if params == nil { params = &AssignPrivateIpAddressesInput{} @@ -69,8 +78,10 @@ type AssignPrivateIpAddressesInput struct { // 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. + // 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 // The number of secondary IP addresses to assign to the network interface. You diff --git a/service/ec2/api_op_AssignPrivateNatGatewayAddress.go b/service/ec2/api_op_AssignPrivateNatGatewayAddress.go index 711237e033d..326cfba166d 100644 --- a/service/ec2/api_op_AssignPrivateNatGatewayAddress.go +++ b/service/ec2/api_op_AssignPrivateNatGatewayAddress.go @@ -12,8 +12,9 @@ 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) -// in the Amazon VPC User Guide. +// information, see [Work with NAT gateways]in the Amazon VPC User Guide. +// +// [Work with NAT gateways]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with func (c *Client) AssignPrivateNatGatewayAddress(ctx context.Context, params *AssignPrivateNatGatewayAddressInput, optFns ...func(*Options)) (*AssignPrivateNatGatewayAddressOutput, error) { if params == nil { params = &AssignPrivateNatGatewayAddressInput{} diff --git a/service/ec2/api_op_AssociateAddress.go b/service/ec2/api_op_AssociateAddress.go index b298b04be44..750457665e8 100644 --- a/service/ec2/api_op_AssociateAddress.go +++ b/service/ec2/api_op_AssociateAddress.go @@ -12,19 +12,26 @@ import ( // Associates an Elastic IP address, or carrier IP address (for instances that are // 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. If the -// Elastic IP address is already associated with a different instance, it is -// disassociated from that instance and associated with the specified instance. If -// you associate an Elastic IP address with an instance that has an existing +// you can use an Elastic IP address, you must allocate it to your account. +// +// If the Elastic IP address is already associated with a different instance, it +// is disassociated from that instance and associated with the specified instance. +// If you associate an Elastic IP address with an instance that has an existing // Elastic IP address, the existing address is disassociated from the instance, but -// remains allocated to your account. [Subnets in Wavelength Zones] You can -// associate an IP address from the telecommunication carrier to the instance or -// network interface. You cannot associate an Elastic IP address with an interface -// in a different network border 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/) . +// remains allocated to your account. +// +// [Subnets in Wavelength Zones] You can associate an IP address from the +// telecommunication carrier to the instance or network interface. +// +// You cannot associate an Elastic IP address with an interface in a different +// network border 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]. +// +// [Amazon EC2 Pricing]: http://aws.amazon.com/ec2/pricing/ func (c *Client) AssociateAddress(ctx context.Context, params *AssociateAddressInput, optFns ...func(*Options)) (*AssociateAddressOutput, error) { if params == nil { params = &AssociateAddressInput{} @@ -61,8 +68,10 @@ type AssociateAddressInput struct { InstanceId *string // The ID of the network interface. If the instance has more than one network - // interface, you must specify a network interface ID. You can specify either the - // instance ID or the network interface ID, but not both. + // interface, you must specify a network interface ID. + // + // You can specify either the instance ID or the network interface ID, but not + // both. NetworkInterfaceId *string // The primary or secondary private IP address to associate with the Elastic IP diff --git a/service/ec2/api_op_AssociateClientVpnTargetNetwork.go b/service/ec2/api_op_AssociateClientVpnTargetNetwork.go index 1df789763fd..566a9e77d2f 100644 --- a/service/ec2/api_op_AssociateClientVpnTargetNetwork.go +++ b/service/ec2/api_op_AssociateClientVpnTargetNetwork.go @@ -15,11 +15,12 @@ import ( // subnet in a VPC. You can associate multiple subnets from the same VPC with a // Client VPN endpoint. You can associate only one subnet in each Availability // Zone. We recommend that you associate at least two subnets to provide -// 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 -// VPC that's associated with it. +// 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 VPC that's associated with it. func (c *Client) AssociateClientVpnTargetNetwork(ctx context.Context, params *AssociateClientVpnTargetNetworkInput, optFns ...func(*Options)) (*AssociateClientVpnTargetNetworkOutput, error) { if params == nil { params = &AssociateClientVpnTargetNetworkInput{} @@ -48,8 +49,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_AssociateDhcpOptions.go b/service/ec2/api_op_AssociateDhcpOptions.go index 844e2ee9f78..6e6a53ccb92 100644 --- a/service/ec2/api_op_AssociateDhcpOptions.go +++ b/service/ec2/api_op_AssociateDhcpOptions.go @@ -11,14 +11,17 @@ import ( ) // Associates a set of DHCP options (that you've previously created) with the -// specified VPC, or associates no DHCP options with the VPC. After you associate -// the options with the VPC, any existing instances and all new instances that you -// launch in that VPC use the options. You don't need to restart or relaunch the -// 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 VPC User Guide. +// specified VPC, or associates no DHCP options with the VPC. +// +// After you associate the options with the VPC, any existing instances and all +// new instances that you launch in that VPC use the options. You don't need to +// restart or relaunch the 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] in the Amazon VPC User Guide. +// +// [DHCP options sets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html func (c *Client) AssociateDhcpOptions(ctx context.Context, params *AssociateDhcpOptionsInput, optFns ...func(*Options)) (*AssociateDhcpOptionsOutput, error) { if params == nil { params = &AssociateDhcpOptionsInput{} diff --git a/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go b/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go index 75b56325318..8a2f328aec8 100644 --- a/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go +++ b/service/ec2/api_op_AssociateEnclaveCertificateIamRole.go @@ -12,20 +12,23 @@ 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 -// 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 +// for Nitro Enclaves application inside an enclave. For more information, see [Certificate Manager for Nitro Enclaves]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 // 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) -// in the Amazon Web Services Nitro Enclaves User Guide. +// information, see [Grant the role permission to access the certificate and encryption key]in the Amazon Web Services Nitro Enclaves User Guide. +// +// [Certificate Manager for Nitro Enclaves]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html +// [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 func (c *Client) AssociateEnclaveCertificateIamRole(ctx context.Context, params *AssociateEnclaveCertificateIamRoleInput, optFns ...func(*Options)) (*AssociateEnclaveCertificateIamRoleOutput, error) { if params == nil { params = &AssociateEnclaveCertificateIamRoleInput{} diff --git a/service/ec2/api_op_AssociateInstanceEventWindow.go b/service/ec2/api_op_AssociateInstanceEventWindow.go index 86662193280..a02583141d8 100644 --- a/service/ec2/api_op_AssociateInstanceEventWindow.go +++ b/service/ec2/api_op_AssociateInstanceEventWindow.go @@ -13,8 +13,11 @@ 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] in the Amazon EC2 User Guide. +// +// [Define event windows for scheduled events]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html func (c *Client) AssociateInstanceEventWindow(ctx context.Context, params *AssociateInstanceEventWindowInput, optFns ...func(*Options)) (*AssociateInstanceEventWindowOutput, error) { if params == nil { params = &AssociateInstanceEventWindowInput{} diff --git a/service/ec2/api_op_AssociateIpamByoasn.go b/service/ec2/api_op_AssociateIpamByoasn.go index 00a97939304..24186688ce4 100644 --- a/service/ec2/api_op_AssociateIpamByoasn.go +++ b/service/ec2/api_op_AssociateIpamByoasn.go @@ -12,12 +12,15 @@ import ( ) // Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own -// in the same Amazon Web Services Region. For more information, see Tutorial: -// Bring your ASN to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) -// in the Amazon VPC IPAM guide. After the association succeeds, the ASN is -// eligible for advertisement. You can view the association with DescribeByoipCidrs (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeByoipCidrs.html) -// . You can advertise the CIDR with AdvertiseByoipCidr (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AdvertiseByoipCidr.html) -// . +// in the same Amazon Web Services Region. For more information, see [Tutorial: Bring your ASN to IPAM]in the Amazon +// VPC IPAM guide. +// +// After the association succeeds, the ASN is eligible for advertisement. You can +// view the association with [DescribeByoipCidrs]. You can advertise the CIDR with [AdvertiseByoipCidr]. +// +// [DescribeByoipCidrs]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeByoipCidrs.html +// [AdvertiseByoipCidr]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AdvertiseByoipCidr.html +// [Tutorial: Bring your ASN to IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html func (c *Client) AssociateIpamByoasn(ctx context.Context, params *AssociateIpamByoasnInput, optFns ...func(*Options)) (*AssociateIpamByoasnOutput, error) { if params == nil { params = &AssociateIpamByoasnInput{} diff --git a/service/ec2/api_op_AssociateNatGatewayAddress.go b/service/ec2/api_op_AssociateNatGatewayAddress.go index c77df6472ad..907d0523cb3 100644 --- a/service/ec2/api_op_AssociateNatGatewayAddress.go +++ b/service/ec2/api_op_AssociateNatGatewayAddress.go @@ -12,19 +12,24 @@ 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) -// in the Amazon VPC 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) -// in the Amazon VPC User Guide. When you associate an EIP or secondary EIPs with a -// public NAT gateway, the network border group of the EIPs must match the network -// border group of the Availability Zone (AZ) that the public NAT gateway is in. If -// it's not the same, the EIP will fail to associate. You can see the network -// border group for the subnet's AZ by viewing the details of the subnet. -// Similarly, you can view the network border group of an EIP by viewing the -// details of the EIP address. For more information about network border groups and -// EIPs, see Allocate an Elastic IP address (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) -// in the Amazon VPC User Guide. +// NAT gateway. For more information, see [Work with NAT gateways]in the Amazon VPC 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]in the Amazon VPC User Guide. +// +// When you associate an EIP or secondary EIPs with a public NAT gateway, the +// network border group of the EIPs must match the network border group of the +// Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, +// the EIP will fail to associate. You can see the network border group for the +// subnet's AZ by viewing the details of the subnet. Similarly, you can view the +// network border group of an EIP by viewing the details of the EIP address. For +// more information about network border groups and EIPs, see [Allocate an Elastic IP address]in the Amazon VPC +// User Guide. +// +// [Elastic IP address quotas]: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-eips +// [Work with NAT gateways]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-working-with +// [Allocate an Elastic IP address]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip func (c *Client) AssociateNatGatewayAddress(ctx context.Context, params *AssociateNatGatewayAddressInput, optFns ...func(*Options)) (*AssociateNatGatewayAddressOutput, error) { if params == nil { params = &AssociateNatGatewayAddressInput{} diff --git a/service/ec2/api_op_AssociateRouteTable.go b/service/ec2/api_op_AssociateRouteTable.go index 2700a5a2690..b72be6a04db 100644 --- a/service/ec2/api_op_AssociateRouteTable.go +++ b/service/ec2/api_op_AssociateRouteTable.go @@ -16,8 +16,11 @@ 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 VPC User Guide. +// with multiple subnets. +// +// For more information, see [Route tables] in the Amazon VPC User Guide. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) AssociateRouteTable(ctx context.Context, params *AssociateRouteTableInput, optFns ...func(*Options)) (*AssociateRouteTableOutput, error) { if params == nil { params = &AssociateRouteTableInput{} diff --git a/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go b/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go index 2ded73bf502..55f719bf309 100644 --- a/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_AssociateTransitGatewayMulticastDomain.go @@ -12,10 +12,12 @@ 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) -// to see the state of the attachment. +// specified transit gateway multicast domain. +// +// The transit gateway attachment must be in the available state before you can +// add a resource. Use [DescribeTransitGatewayAttachments]to see the state of the attachment. +// +// [DescribeTransitGatewayAttachments]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html func (c *Client) AssociateTransitGatewayMulticastDomain(ctx context.Context, params *AssociateTransitGatewayMulticastDomainInput, optFns ...func(*Options)) (*AssociateTransitGatewayMulticastDomainOutput, error) { if params == nil { params = &AssociateTransitGatewayMulticastDomainInput{} diff --git a/service/ec2/api_op_AssociateTrunkInterface.go b/service/ec2/api_op_AssociateTrunkInterface.go index 29b32e5cbdd..3652d655d9c 100644 --- a/service/ec2/api_op_AssociateTrunkInterface.go +++ b/service/ec2/api_op_AssociateTrunkInterface.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// interface for each branch network interface that you want to associate with the -// trunk network interface. +// Associates a branch network interface with a trunk network interface. +// +// Before you create the association, run the [create-network-interface] 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. +// +// [create-network-interface]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html func (c *Client) AssociateTrunkInterface(ctx context.Context, params *AssociateTrunkInterfaceInput, optFns ...func(*Options)) (*AssociateTrunkInterfaceOutput, error) { if params == nil { params = &AssociateTrunkInterfaceInput{} @@ -44,8 +46,9 @@ 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]. + // + // [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 @@ -66,8 +69,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_AssociateVpcCidrBlock.go b/service/ec2/api_op_AssociateVpcCidrBlock.go index a5b3d506e88..93815890033 100644 --- a/service/ec2/api_op_AssociateVpcCidrBlock.go +++ b/service/ec2/api_op_AssociateVpcCidrBlock.go @@ -13,12 +13,16 @@ 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) -// ). 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 IP -// addressing for your VPCs and subnets (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html) -// in the Amazon VPC User Guide. +// address pool that you provisioned through bring your own IP addresses ([BYOIP] ). +// +// 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 [IP addressing for your VPCs and subnets]in the Amazon VPC User Guide. +// +// [BYOIP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html +// [IP addressing for your VPCs and subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html func (c *Client) AssociateVpcCidrBlock(ctx context.Context, params *AssociateVpcCidrBlockInput, optFns ...func(*Options)) (*AssociateVpcCidrBlockOutput, error) { if params == nil { params = &AssociateVpcCidrBlockInput{} @@ -50,36 +54,45 @@ type AssociateVpcCidrBlockInput struct { 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. + // information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?]in the Amazon VPC + // IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html 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?]in the + // Amazon VPC IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html 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 - // parameter. + // 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. + // 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. 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?]in the Amazon VPC + // IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html 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?]in the + // Amazon VPC IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html 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 9565104b2de..10a82d2d676 100644 --- a/service/ec2/api_op_AttachClassicLinkVpc.go +++ b/service/ec2/api_op_AttachClassicLinkVpc.go @@ -10,15 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. Links an EC2-Classic instance to a -// ClassicLink-enabled VPC through one or more of the VPC 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 -// you restart it. After you've linked an instance, you cannot change the VPC -// security groups that are associated with it. To change the security groups, you -// must first unlink the instance, and then link it again. Linking your instance to -// a VPC is sometimes referred to as attaching your instance. +// This action is deprecated. +// +// Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more +// of the VPC 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 you restart it. +// +// After you've linked an instance, you cannot change the VPC security groups that +// are associated with it. To change the security groups, you must first unlink the +// instance, and then link it again. +// +// Linking your instance to a VPC is sometimes referred to as attaching your +// instance. func (c *Client) AttachClassicLinkVpc(ctx context.Context, params *AttachClassicLinkVpcInput, optFns ...func(*Options)) (*AttachClassicLinkVpcOutput, error) { if params == nil { params = &AttachClassicLinkVpcInput{} diff --git a/service/ec2/api_op_AttachInternetGateway.go b/service/ec2/api_op_AttachInternetGateway.go index e442d326c14..93aff4bbafc 100644 --- a/service/ec2/api_op_AttachInternetGateway.go +++ b/service/ec2/api_op_AttachInternetGateway.go @@ -11,9 +11,10 @@ import ( ) // Attaches an internet gateway or a virtual private gateway to a VPC, enabling -// connectivity between the internet and the VPC. For more information, see -// Internet gateways (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) -// in the Amazon VPC User Guide. +// connectivity between the internet and the VPC. For more information, see [Internet gateways]in the +// Amazon VPC User Guide. +// +// [Internet gateways]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html func (c *Client) AttachInternetGateway(ctx context.Context, params *AttachInternetGatewayInput, optFns ...func(*Options)) (*AttachInternetGatewayOutput, error) { if params == nil { params = &AttachInternetGatewayInput{} diff --git a/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go b/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go index d48cb5b17cb..e5c85a41d9a 100644 --- a/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_AttachVerifiedAccessTrustProvider.go @@ -41,8 +41,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_AttachVolume.go b/service/ec2/api_op_AttachVolume.go index 5c7b5f35336..cf52fa78687 100644 --- a/service/ec2/api_op_AttachVolume.go +++ b/service/ec2/api_op_AttachVolume.go @@ -13,22 +13,32 @@ 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS 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/ebs/latest/userguide/ebs-using-volumes.html) -// . If a volume has an Amazon Web Services Marketplace product code: +// 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]in the Amazon EBS User Guide. +// +// After you attach an EBS volume, you must make it available. For more +// information, see [Make an EBS volume available for use]. +// +// 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. // -// For more information, see Attach an Amazon EBS volume to an instance (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-attaching-volume.html) -// in the Amazon EBS User Guide. +// For more information, see [Attach an Amazon EBS volume to an instance] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html +// [Make an EBS volume available for use]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-using-volumes.html +// [Attach an Amazon EBS volume to an instance]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-attaching-volume.html func (c *Client) AttachVolume(ctx context.Context, params *AttachVolumeInput, optFns ...func(*Options)) (*AttachVolumeOutput, error) { if params == nil { params = &AttachVolumeInput{} @@ -83,17 +93,20 @@ type AttachVolumeOutput struct { // Indicates whether the EBS volume is deleted on instance termination. DeleteOnTermination *bool - // The device name. If the volume is attached to a Fargate task, this parameter - // returns null . + // The device name. + // + // If the volume is attached to a Fargate task, this parameter returns null . Device *string - // The ID of the instance. If the volume is attached to a Fargate task, this - // parameter returns null . + // The ID of the instance. + // + // If the volume is attached to a Fargate task, this parameter returns null . InstanceId *string // The service principal of Amazon Web Services service that owns the underlying - // instance to which the volume is attached. This parameter is returned only for - // volumes that are attached to Fargate tasks. + // instance to which the volume is attached. + // + // This parameter is returned only for volumes that are attached to Fargate tasks. InstanceOwningService *string // The attachment state of the volume. diff --git a/service/ec2/api_op_AttachVpnGateway.go b/service/ec2/api_op_AttachVpnGateway.go index ed7f0cc465a..3cd57bf6ee1 100644 --- a/service/ec2/api_op_AttachVpnGateway.go +++ b/service/ec2/api_op_AttachVpnGateway.go @@ -12,9 +12,12 @@ import ( ) // Attaches a virtual private gateway to a VPC. You can attach one virtual private -// gateway to one VPC at a time. 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 to one VPC at a time. +// +// For more information, see [Amazon Web Services Site-to-Site VPN] 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 func (c *Client) AttachVpnGateway(ctx context.Context, params *AttachVpnGatewayInput, optFns ...func(*Options)) (*AttachVpnGatewayOutput, error) { if params == nil { params = &AttachVpnGatewayInput{} diff --git a/service/ec2/api_op_AuthorizeClientVpnIngress.go b/service/ec2/api_op_AuthorizeClientVpnIngress.go index cb8c9033f56..0335c29d893 100644 --- a/service/ec2/api_op_AuthorizeClientVpnIngress.go +++ b/service/ec2/api_op_AuthorizeClientVpnIngress.go @@ -54,8 +54,9 @@ 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]. + // + // [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. diff --git a/service/ec2/api_op_AuthorizeSecurityGroupEgress.go b/service/ec2/api_op_AuthorizeSecurityGroupEgress.go index edde26a4f9c..1fbea89aad4 100644 --- a/service/ec2/api_op_AuthorizeSecurityGroupEgress.go +++ b/service/ec2/api_op_AuthorizeSecurityGroupEgress.go @@ -11,22 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified outbound (egress) rules to a security group. An outbound -// rule permits instances to send traffic to the specified IPv4 or IPv6 address -// ranges, the IP address ranges specified by a prefix list, or the instances that -// are associated with a source security group. For more information, see Security -// group rules (https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) -// . You must specify exactly one of the following destinations: an IPv4 or IPv6 +// Adds the specified outbound (egress) rules to a security group. +// +// An outbound rule permits instances to send traffic to the specified IPv4 or +// IPv6 address ranges, the IP address ranges specified by a prefix list, or the +// instances that are associated with a source security group. For more +// information, see [Security group rules]. +// +// You must specify exactly one of the following destinations: an IPv4 or IPv6 // address range, a prefix list, or a security group. You must specify a protocol // for each rule (for example, TCP). If the protocol is TCP or UDP, you must also // specify a port or port range. If the protocol is ICMP or ICMPv6, you must also -// specify the ICMP type and code. Rule changes are propagated to instances -// associated with the security group as quickly as possible. However, a small -// delay might occur. For examples of rules that you can add to security groups for -// specific access scenarios, see Security group rules for different use cases (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) -// in the Amazon EC2 User Guide. For information about security group quotas, see -// Amazon VPC quotas (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) -// in the Amazon VPC User Guide. +// specify the ICMP type and code. +// +// Rule changes are propagated to instances associated with the security group as +// quickly as possible. However, a small delay might occur. +// +// For examples of rules that you can add to security groups for specific access +// scenarios, see [Security group rules for different use cases]in the Amazon EC2 User Guide. +// +// For information about security group quotas, see [Amazon VPC quotas] in the Amazon VPC User Guide. +// +// [Amazon VPC quotas]: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html +// [Security group rules]: https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html +// [Security group rules for different use cases]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html func (c *Client) AuthorizeSecurityGroupEgress(ctx context.Context, params *AuthorizeSecurityGroupEgressInput, optFns ...func(*Options)) (*AuthorizeSecurityGroupEgressOutput, error) { if params == nil { params = &AuthorizeSecurityGroupEgressInput{} diff --git a/service/ec2/api_op_AuthorizeSecurityGroupIngress.go b/service/ec2/api_op_AuthorizeSecurityGroupIngress.go index d4dc15609d3..2adb4a28fad 100644 --- a/service/ec2/api_op_AuthorizeSecurityGroupIngress.go +++ b/service/ec2/api_op_AuthorizeSecurityGroupIngress.go @@ -11,22 +11,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified inbound (ingress) rules to a security group. An inbound rule -// permits instances to receive traffic from the specified IPv4 or IPv6 address -// range, the IP address ranges that are specified by a prefix list, or the -// instances that are associated with a destination security group. For more -// information, see Security group rules (https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html) -// . You must specify exactly one of the following sources: an IPv4 or IPv6 address +// Adds the specified inbound (ingress) rules to a security group. +// +// An inbound rule permits instances to receive traffic from the specified IPv4 or +// IPv6 address range, the IP address ranges that are specified by a prefix list, +// or the instances that are associated with a destination security group. For more +// information, see [Security group rules]. +// +// You must specify exactly one of the following sources: an IPv4 or IPv6 address // range, a prefix list, or a security group. You must specify a protocol for each // rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a // port or port range. If the protocol is ICMP or ICMPv6, you must also specify the -// ICMP/ICMPv6 type and code. Rule changes are propagated to instances associated -// with the security group as quickly as possible. However, a small delay might -// occur. For examples of rules that you can add to security groups for specific -// access scenarios, see Security group rules for different use cases (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) -// in the Amazon EC2 User Guide. For more information about security group quotas, -// see Amazon VPC quotas (https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) -// in the Amazon VPC User Guide. +// ICMP/ICMPv6 type and code. +// +// Rule changes are propagated to instances associated with the security group as +// quickly as possible. However, a small delay might occur. +// +// For examples of rules that you can add to security groups for specific access +// scenarios, see [Security group rules for different use cases]in the Amazon EC2 User Guide. +// +// For more information about security group quotas, see [Amazon VPC quotas] in the Amazon VPC User +// Guide. +// +// [Amazon VPC quotas]: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html +// [Security group rules]: https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html +// [Security group rules for different use cases]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html func (c *Client) AuthorizeSecurityGroupIngress(ctx context.Context, params *AuthorizeSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeSecurityGroupIngressOutput, error) { if params == nil { params = &AuthorizeSecurityGroupIngressInput{} @@ -44,9 +53,12 @@ func (c *Client) AuthorizeSecurityGroupIngress(ctx context.Context, params *Auth type AuthorizeSecurityGroupIngressInput struct { - // The IPv4 address range, in CIDR format. To specify an IPv6 address range, use - // IP permissions instead. To specify multiple rules and descriptions for the - // rules, use IP permissions instead. + // The IPv4 address range, in CIDR format. + // + // To specify an IPv6 address range, use IP permissions instead. + // + // To specify multiple rules and descriptions for the rules, use IP permissions + // instead. CidrIp *string // Checks whether you have the required permissions for the action, without @@ -56,8 +68,10 @@ type AuthorizeSecurityGroupIngressInput struct { DryRun *bool // If the protocol is TCP or UDP, this is the start of the port range. If the - // protocol is ICMP, this is the ICMP type or -1 (all ICMP types). To specify - // multiple rules and descriptions for the rules, use IP permissions instead. + // protocol is ICMP, this is the ICMP type or -1 (all ICMP types). + // + // To specify multiple rules and descriptions for the rules, use IP permissions + // instead. FromPort *int32 // The ID of the security group. @@ -72,23 +86,31 @@ type AuthorizeSecurityGroupIngressInput struct { // The permissions for the security group rules. 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 all protocols, use -1 . To specify icmpv6 , use IP permissions - // instead. If you specify a protocol other than one of the supported values, - // traffic is allowed on all ports, regardless of any ports that you specify. To - // specify multiple rules and descriptions for the rules, use IP permissions + // The IP protocol name ( tcp , udp , icmp ) or number (see [Protocol Numbers]). To specify all + // protocols, use -1 . + // + // To specify icmpv6 , use IP permissions instead. + // + // If you specify a protocol other than one of the supported values, traffic is + // allowed on all ports, regardless of any ports that you specify. + // + // To specify multiple rules and descriptions for the rules, use IP permissions // instead. + // + // [Protocol Numbers]: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IpProtocol *string - // [Default VPC] The name of the source security group. The rule grants full ICMP, - // UDP, and TCP access. To create a rule with a specific protocol and port range, - // specify a set of IP permissions instead. + // [Default VPC] The name of the source security group. + // + // The rule grants full ICMP, UDP, and TCP access. To create a rule with a + // specific protocol and port range, specify a set of IP permissions instead. SourceSecurityGroupName *string // The Amazon Web Services account ID for the source security group, if the source - // security group is in a different account. The rule grants full ICMP, UDP, and - // TCP access. To create a rule with a specific protocol and port range, use IP - // permissions instead. + // security group is in a different account. + // + // The rule grants full ICMP, UDP, and TCP access. To create a rule with a + // specific protocol and port range, use IP permissions instead. SourceSecurityGroupOwnerId *string // The tags applied to the security group rule. @@ -96,8 +118,9 @@ type AuthorizeSecurityGroupIngressInput struct { // If the protocol is TCP or UDP, this is the end of the port range. If the // protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start - // port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). To - // specify multiple rules and descriptions for the rules, use IP permissions + // port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). + // + // To specify multiple rules and descriptions for the rules, use IP permissions // instead. ToPort *int32 diff --git a/service/ec2/api_op_BundleInstance.go b/service/ec2/api_op_BundleInstance.go index 59606f0ff2b..58e6e7901cc 100644 --- a/service/ec2/api_op_BundleInstance.go +++ b/service/ec2/api_op_BundleInstance.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Bundles an Amazon instance store-backed Windows instance. During bundling, only -// the root device volume (C:\) is bundled. Data on other instance store volumes is -// not preserved. This action is not applicable for Linux/Unix instances or Windows -// instances that are backed by Amazon EBS. +// Bundles an Amazon instance store-backed Windows instance. +// +// During bundling, only the root device volume (C:\) is bundled. Data on other +// instance store volumes is not preserved. +// +// This action is not applicable for Linux/Unix instances or Windows instances +// that are backed by Amazon EBS. func (c *Client) BundleInstance(ctx context.Context, params *BundleInstanceInput, optFns ...func(*Options)) (*BundleInstanceOutput, error) { if params == nil { params = &BundleInstanceInput{} @@ -33,7 +36,9 @@ func (c *Client) BundleInstance(ctx context.Context, params *BundleInstanceInput // Contains the parameters for BundleInstance. type BundleInstanceInput struct { - // The ID of the instance to bundle. Default: None + // The ID of the instance to bundle. + // + // Default: None // // This member is required. InstanceId *string diff --git a/service/ec2/api_op_CancelCapacityReservation.go b/service/ec2/api_op_CancelCapacityReservation.go index c85607f1959..493c847978b 100644 --- a/service/ec2/api_op_CancelCapacityReservation.go +++ b/service/ec2/api_op_CancelCapacityReservation.go @@ -11,12 +11,13 @@ import ( ) // Cancels the specified Capacity Reservation, releases the reserved capacity, and -// 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 -// capacity, or run in any open Capacity Reservation that has matching attributes -// and sufficient capacity. +// 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 capacity, or run in any open Capacity +// Reservation that has matching attributes and sufficient capacity. func (c *Client) CancelCapacityReservation(ctx context.Context, params *CancelCapacityReservationInput, optFns ...func(*Options)) (*CancelCapacityReservationOutput, error) { if params == nil { params = &CancelCapacityReservationInput{} diff --git a/service/ec2/api_op_CancelCapacityReservationFleets.go b/service/ec2/api_op_CancelCapacityReservationFleets.go index 1963037715f..0c6f74b0bf3 100644 --- a/service/ec2/api_op_CancelCapacityReservationFleets.go +++ b/service/ec2/api_op_CancelCapacityReservationFleets.go @@ -13,10 +13,13 @@ 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. func (c *Client) CancelCapacityReservationFleets(ctx context.Context, params *CancelCapacityReservationFleetsInput, optFns ...func(*Options)) (*CancelCapacityReservationFleetsOutput, error) { if params == nil { diff --git a/service/ec2/api_op_CancelConversionTask.go b/service/ec2/api_op_CancelConversionTask.go index 71364517719..8c166bc3a99 100644 --- a/service/ec2/api_op_CancelConversionTask.go +++ b/service/ec2/api_op_CancelConversionTask.go @@ -14,9 +14,11 @@ import ( // volume. The action removes all artifacts of the conversion, including a // 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) -// . +// an exception. +// +// For more information, see [Importing a Virtual Machine Using the Amazon EC2 CLI]. +// +// [Importing a Virtual Machine Using the 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{} diff --git a/service/ec2/api_op_CancelImageLaunchPermission.go b/service/ec2/api_op_CancelImageLaunchPermission.go index 488de3d4cd5..ce237ed2227 100644 --- a/service/ec2/api_op_CancelImageLaunchPermission.go +++ b/service/ec2/api_op_CancelImageLaunchPermission.go @@ -11,9 +11,9 @@ 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) -// in the Amazon EC2 User Guide. +// specified AMI. For more information, see [Cancel having an AMI shared with your Amazon Web Services account]in the Amazon EC2 User Guide. +// +// [Cancel having an AMI shared with your Amazon Web Services account]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html func (c *Client) CancelImageLaunchPermission(ctx context.Context, params *CancelImageLaunchPermissionInput, optFns ...func(*Options)) (*CancelImageLaunchPermissionOutput, error) { if params == nil { params = &CancelImageLaunchPermissionInput{} diff --git a/service/ec2/api_op_CancelReservedInstancesListing.go b/service/ec2/api_op_CancelReservedInstancesListing.go index 5e58bdeb736..d3e2dd5f4b1 100644 --- a/service/ec2/api_op_CancelReservedInstancesListing.go +++ b/service/ec2/api_op_CancelReservedInstancesListing.go @@ -12,8 +12,11 @@ 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] in the Amazon EC2 User Guide. +// +// [Reserved Instance Marketplace]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html 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 a1a97a96651..8468465b540 100644 --- a/service/ec2/api_op_CancelSpotFleetRequests.go +++ b/service/ec2/api_op_CancelSpotFleetRequests.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet -// request, the Spot Fleet launches no new instances. You must also specify whether -// a canceled Spot Fleet request should terminate its instances. If you choose to -// terminate the instances, the Spot Fleet request enters the cancelled_terminating -// state. Otherwise, the Spot Fleet request enters the cancelled_running state and -// the instances continue to run until they are interrupted or you terminate them -// manually. Restrictions +// Cancels the specified Spot Fleet requests. +// +// After you cancel a Spot Fleet request, the Spot Fleet launches no new instances. +// +// You must also specify whether a canceled Spot Fleet request should terminate +// its instances. If you choose to terminate the instances, the Spot Fleet request +// enters the cancelled_terminating state. Otherwise, the Spot Fleet request +// enters the cancelled_running state and the instances continue to run until they +// are interrupted or you terminate them manually. +// +// Restrictions +// // - You can delete up to 100 fleets in a single request. If you exceed the // specified number, no fleets are deleted. func (c *Client) CancelSpotFleetRequests(ctx context.Context, params *CancelSpotFleetRequestsInput, optFns ...func(*Options)) (*CancelSpotFleetRequestsOutput, error) { @@ -38,16 +43,18 @@ func (c *Client) CancelSpotFleetRequests(ctx context.Context, params *CancelSpot // Contains the parameters for CancelSpotFleetRequests. type CancelSpotFleetRequestsInput struct { - // The IDs of the Spot Fleet requests. Constraint: You can specify up to 100 IDs - // in a single request. + // The IDs of the Spot Fleet requests. + // + // Constraint: You can specify up to 100 IDs in a single request. // // This member is required. SpotFleetRequestIds []string // 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 . + // 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 . // // This member is required. TerminateInstances *bool diff --git a/service/ec2/api_op_CancelSpotInstanceRequests.go b/service/ec2/api_op_CancelSpotInstanceRequests.go index 2b438e9893e..d55015eee1a 100644 --- a/service/ec2/api_op_CancelSpotInstanceRequests.go +++ b/service/ec2/api_op_CancelSpotInstanceRequests.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels one or more Spot Instance requests. Canceling a Spot Instance request -// does not terminate running Spot Instances associated with the request. +// Cancels one or more Spot Instance requests. +// +// Canceling a Spot Instance request does not terminate running Spot Instances +// associated with the request. func (c *Client) CancelSpotInstanceRequests(ctx context.Context, params *CancelSpotInstanceRequestsInput, optFns ...func(*Options)) (*CancelSpotInstanceRequestsOutput, error) { if params == nil { params = &CancelSpotInstanceRequestsInput{} diff --git a/service/ec2/api_op_CopyFpgaImage.go b/service/ec2/api_op_CopyFpgaImage.go index b73cf522095..5c46a24c66a 100644 --- a/service/ec2/api_op_CopyFpgaImage.go +++ b/service/ec2/api_op_CopyFpgaImage.go @@ -39,8 +39,9 @@ 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]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string // The description for the new AFI. diff --git a/service/ec2/api_op_CopyImage.go b/service/ec2/api_op_CopyImage.go index aaa34ee1084..4316cf43794 100644 --- a/service/ec2/api_op_CopyImage.go +++ b/service/ec2/api_op_CopyImage.go @@ -14,22 +14,28 @@ import ( // 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 +// to another partition, see [CreateStoreImageTask]. +// +// 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 // during the copy operation. You cannot create an unencrypted copy of an encrypted -// backing snapshot. To copy an AMI from a Region to an Outpost, specify the source -// Region using the SourceRegion parameter, and specify the ARN of the destination -// 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/ebs/latest/userguide/snapshots-outposts.html#ami) -// in the Amazon EBS 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. +// backing snapshot. +// +// To copy an AMI from a Region to an Outpost, specify the source Region using the +// SourceRegion parameter, and specify the ARN of the destination 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]in the Amazon EBS User Guide. +// +// For more information about the prerequisites and limits when copying an AMI, +// see [Copy an AMI]in the Amazon EC2 User Guide. +// +// [CreateStoreImageTask]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html +// [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami +// [Copy an AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html func (c *Client) CopyImage(ctx context.Context, params *CopyImageInput, optFns ...func(*Options)) (*CopyImageOutput, error) { if params == nil { params = &CopyImageInput{} @@ -64,15 +70,20 @@ 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html 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 + // // Default: Your user-defined AMI tags are not copied. CopyImageTags *bool @@ -83,9 +94,11 @@ 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/ebs/latest/userguide/snapshots-outposts.html#copy-amis) - // in the Amazon EBS User Guide. + // the same Outpost. + // + // For more information, see [Copy AMIs from an Amazon Web Services Region to an Outpost] in the Amazon EBS User Guide. + // + // [Copy AMIs from an Amazon Web Services Region to an Outpost]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-amis DestinationOutpostArn *string // Checks whether you have the required permissions for the action, without @@ -98,35 +111,51 @@ type CopyImageInput struct { // 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/ebs/latest/userguide/ebs-encryption.html) - // in the Amazon EBS User Guide. + // KMS key using KmsKeyId . For more information, see [Amazon EBS encryption] in the Amazon EBS User + // Guide. + // + // [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html 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: + // 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. + // eventually fails. + // + // The specified KMS key must exist in the destination Region. + // // Amazon EBS does not support asymmetric KMS keys. KmsKeyId *string // The tags to apply to the new AMI and new snapshots. You can tag the AMI, the // snapshots, or both. + // // - To tag the new AMI, the value for ResourceType must be image . + // // - To tag the new snapshots, the value for ResourceType must be snapshot . The // same tag is applied to all the new snapshots. - // 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) - // . + // + // If you specify other values for ResourceType , the request fails. + // + // To tag an AMI or snapshot after it has been created, see [CreateTags]. + // + // [CreateTags]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html TagSpecifications []types.TagSpecification noSmithyDocumentSerde diff --git a/service/ec2/api_op_CopySnapshot.go b/service/ec2/api_op_CopySnapshot.go index 174626c76f5..c3517229e9d 100644 --- a/service/ec2/api_op_CopySnapshot.go +++ b/service/ec2/api_op_CopySnapshot.go @@ -16,22 +16,30 @@ import ( // 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 -// for the snapshot copy operation. By default, encrypted snapshot copies use the -// default Key Management Service (KMS) KMS key; however, you can specify a -// different KMS key. To copy an encrypted snapshot that has been shared from -// another account, you must have permissions for the KMS key used to encrypt the -// 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/ebs/latest/userguide/snapshots-outposts.html#ami) -// in the Amazon EBS 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/ebs/latest/userguide/ebs-copy-snapshot.html) -// in the Amazon EBS User Guide. +// 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 for the snapshot copy operation. By default, encrypted snapshot +// copies use the default Key Management Service (KMS) KMS key; however, you can +// specify a different KMS key. To copy an encrypted snapshot that has been shared +// from another account, you must have permissions for the KMS key used to encrypt +// the 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]in the Amazon EBS 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] in the Amazon EBS User Guide. +// +// [Copy an Amazon EBS snapshot]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-copy-snapshot.html +// [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error) { if params == nil { params = &CopySnapshotInput{} @@ -66,9 +74,11 @@ 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/ebs/latest/userguide/snapshots-outposts.html#copy-snapshots) - // in the Amazon EBS User Guide. + // Outpost to another, or within the same Outpost. + // + // For more information, see [Copy snapshots from an Amazon Web Services Region to an Outpost] in the Amazon EBS User Guide. + // + // [Copy snapshots from an Amazon Web Services Region to an Outpost]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-snapshots DestinationOutpostArn *string // Checks whether you have the required permissions for the action, without @@ -81,20 +91,27 @@ type CopySnapshotInput struct { // 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/ebs/latest/userguide/ebs-encryption.html) - // in the Amazon EBS User Guide. + // For more information, see [Amazon EBS encryption]in the Amazon EBS User Guide. + // + // [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html 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 - // specify the KMS key using any of the following: + // 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. @@ -102,16 +119,19 @@ type CopySnapshotInput struct { // 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 + // snapshots. For more information, see [Query requests]. + // + // 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) - // 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. + // for this parameter uses the same logic that is described in [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]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. + // + // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html + // [Query requests]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html PresignedUrl *string // The tags to apply to the new snapshot. diff --git a/service/ec2/api_op_CreateCapacityReservation.go b/service/ec2/api_op_CreateCapacityReservation.go index c3bef2a380e..228c35c7263 100644 --- a/service/ec2/api_op_CreateCapacityReservation.go +++ b/service/ec2/api_op_CreateCapacityReservation.go @@ -12,25 +12,30 @@ import ( "time" ) -// Creates a new Capacity Reservation with the specified attributes. Capacity -// Reservations enable you to reserve capacity for your Amazon EC2 instances in a -// specific Availability Zone for any duration. This gives you the flexibility to -// 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) -// 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 -// try again at a later time, try in a different Availability Zone, or request a -// smaller capacity reservation. If your application is flexible across instance -// types and sizes, try to create a Capacity Reservation with different instance -// attributes. Your request could also fail if the requested quantity exceeds your -// 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) -// in the Amazon EC2 User Guide. +// Creates a new Capacity Reservation with the specified attributes. +// +// Capacity Reservations enable you to reserve capacity for your Amazon EC2 +// instances in a specific Availability Zone for any duration. This gives you the +// flexibility to 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]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 try again at a later time, try in a +// different Availability Zone, or request a smaller capacity reservation. If your +// application is flexible across instance types and sizes, try to create a +// Capacity Reservation with different instance attributes. +// +// Your request could also fail if the requested quantity exceeds your 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]in the Amazon EC2 User Guide. +// +// [Amazon EC2 Service Quotas]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html +// [Capacity Reservations]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html func (c *Client) CreateCapacityReservation(ctx context.Context, params *CreateCapacityReservationInput, optFns ...func(*Options)) (*CreateCapacityReservationOutput, error) { if params == nil { params = &CreateCapacityReservationInput{} @@ -48,7 +53,9 @@ func (c *Client) CreateCapacityReservation(ctx context.Context, params *CreateCa type CreateCapacityReservationInput struct { - // The number of instances for which to reserve capacity. Valid range: 1 - 1000 + // The number of instances for which to reserve capacity. + // + // Valid range: 1 - 1000 // // This member is required. InstanceCount *int32 @@ -58,9 +65,10 @@ type CreateCapacityReservationInput struct { // This member is required. 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. + // The instance type for which to reserve capacity. For more information, see [Instance types] in + // the Amazon EC2 User Guide. + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html // // This member is required. InstanceType *string @@ -72,8 +80,9 @@ 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]. + // + // [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 @@ -92,36 +101,44 @@ type CreateCapacityReservationInput struct { // 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. 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 - // 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 + // 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 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 . EndDateType types.EndDateType - // Deprecated. + // Deprecated. EphemeralStorage *bool // 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. + // // Default: open InstanceMatchCriteria types.InstanceMatchCriteria @@ -130,9 +147,10 @@ type CreateCapacityReservationInput struct { 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. + // create the Capacity Reservation. For more information, see [Capacity Reservations for cluster placement groups]in the Amazon EC2 + // User Guide. + // + // [Capacity Reservations for cluster placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html PlacementGroupArn *string // The tags to apply to the Capacity Reservation during launch. @@ -140,8 +158,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. Tenancy types.CapacityReservationTenancy diff --git a/service/ec2/api_op_CreateCapacityReservationFleet.go b/service/ec2/api_op_CreateCapacityReservationFleet.go index 05da75a4e29..612bc5db745 100644 --- a/service/ec2/api_op_CreateCapacityReservationFleet.go +++ b/service/ec2/api_op_CreateCapacityReservationFleet.go @@ -12,9 +12,10 @@ import ( "time" ) -// 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) -// in the Amazon EC2 User Guide. +// Creates a Capacity Reservation Fleet. For more information, see [Create a Capacity Reservation Fleet] in the Amazon +// EC2 User Guide. +// +// [Create a Capacity Reservation Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet func (c *Client) CreateCapacityReservationFleet(ctx context.Context, params *CreateCapacityReservationFleetInput, optFns ...func(*Options)) (*CreateCapacityReservationFleetOutput, error) { if params == nil { params = &CreateCapacityReservationFleetInput{} @@ -41,21 +42,26 @@ 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) - // in the Amazon EC2 User Guide. + // your workload. For more information, see [Total target capacity]in the Amazon EC2 User Guide. + // + // [Total target capacity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity // // This member is required. TotalTargetCapacity *int32 // 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) - // in the Amazon EC2 User Guide. Valid values: prioritized + // strategy is supported. For more information, see [Allocation strategy]in the Amazon EC2 User Guide. + // + // Valid values: prioritized + // + // [Allocation strategy]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy 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]. + // + // [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 @@ -66,19 +72,22 @@ type CreateCapacityReservationFleetInput struct { // 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 . + // 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 . EndDate *time.Time // Indicates the type of instance launches that the Capacity Reservation Fleet // accepts. All Capacity Reservations in the Fleet inherit this instance matching - // criteria. Currently, Capacity Reservation Fleets support open instance matching - // criteria only. This means that instances that have matching attributes (instance - // type, platform, and Availability Zone) run in the Capacity Reservations - // automatically. Instances do not need to explicitly target a Capacity Reservation - // Fleet to use its reserved capacity. + // criteria. + // + // Currently, Capacity Reservation Fleets support open instance matching criteria + // only. This means that instances that have matching attributes (instance type, + // platform, and Availability Zone) run in the Capacity Reservations automatically. + // Instances do not need to explicitly target a Capacity Reservation Fleet to use + // its reserved capacity. InstanceMatchCriteria types.FleetInstanceMatchCriteria // The tags to assign to the Capacity Reservation Fleet. The tags are @@ -88,8 +97,10 @@ type CreateCapacityReservationFleetInput struct { // 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. Tenancy types.FleetCapacityReservationTenancy diff --git a/service/ec2/api_op_CreateCarrierGateway.go b/service/ec2/api_op_CreateCarrierGateway.go index 9cbfde83c2b..9697186a500 100644 --- a/service/ec2/api_op_CreateCarrierGateway.go +++ b/service/ec2/api_op_CreateCarrierGateway.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services Wavelength Developer Guide. +// Creates a carrier gateway. For more information about carrier gateways, see [Carrier gateways] in +// the Amazon Web Services Wavelength Developer Guide. +// +// [Carrier gateways]: https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway func (c *Client) CreateCarrierGateway(ctx context.Context, params *CreateCarrierGatewayInput, optFns ...func(*Options)) (*CreateCarrierGatewayOutput, error) { if params == nil { params = &CreateCarrierGatewayInput{} @@ -37,8 +38,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_CreateClientVpnEndpoint.go b/service/ec2/api_op_CreateClientVpnEndpoint.go index 87ff490be25..bcf12174eb6 100644 --- a/service/ec2/api_op_CreateClientVpnEndpoint.go +++ b/service/ec2/api_op_CreateClientVpnEndpoint.go @@ -46,19 +46,25 @@ type CreateClientVpnEndpointInput struct { // This member is required. ClientCidrBlock *string - // 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: + // 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 // // 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/) . + // The ARN of the server certificate. For more information, see the [Certificate Manager User Guide]. + // + // [Certificate Manager User Guide]: https://docs.aws.amazon.com/acm/latest/userguide/ // // This member is required. ServerCertificateArn *string @@ -71,8 +77,9 @@ type CreateClientVpnEndpointInput struct { 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]. + // + // [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. @@ -94,23 +101,33 @@ type CreateClientVpnEndpointInput struct { SecurityGroupIds []string // Specify whether to enable the self-service portal for the Client VPN endpoint. + // // Default Value: enabled SelfServicePortal types.SelfServicePortal - // The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 + // The maximum VPN session duration time in hours. + // + // Valid values: 8 | 10 | 12 | 24 + // // Default value: 24 SessionTimeoutHours *int32 - // 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) - // in the Client VPN Administrator Guide. + // 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] in the Client VPN + // Administrator Guide. + // + // [Split-tunnel Client VPN endpoint]: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html SplitTunnel *bool // The tags to apply to the Client VPN endpoint during creation. TagSpecifications []types.TagSpecification - // The transport protocol to be used by the VPN session. Default value: udp + // The transport protocol to be used by the VPN session. + // + // Default value: udp TransportProtocol types.TransportProtocol // The ID of the VPC to associate with the Client VPN endpoint. If no security @@ -119,7 +136,10 @@ type CreateClientVpnEndpointInput struct { VpcId *string // The port number to assign to the Client VPN endpoint for TCP and UDP traffic. - // Valid Values: 443 | 1194 Default Value: 443 + // + // Valid Values: 443 | 1194 + // + // Default Value: 443 VpnPort *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateClientVpnRoute.go b/service/ec2/api_op_CreateClientVpnRoute.go index d93112f8d98..35846707cb9 100644 --- a/service/ec2/api_op_CreateClientVpnRoute.go +++ b/service/ec2/api_op_CreateClientVpnRoute.go @@ -37,12 +37,15 @@ type CreateClientVpnRouteInput struct { // This member is required. ClientVpnEndpointId *string - // The IPv4 address range, in CIDR notation, of the route destination. For - // example: + // 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 // // This member is required. @@ -50,14 +53,16 @@ type CreateClientVpnRouteInput struct { // 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 . // // 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A brief description of the route. diff --git a/service/ec2/api_op_CreateCoipCidr.go b/service/ec2/api_op_CreateCoipCidr.go index 24d38e46e5a..6739188372a 100644 --- a/service/ec2/api_op_CreateCoipCidr.go +++ b/service/ec2/api_op_CreateCoipCidr.go @@ -29,12 +29,12 @@ func (c *Client) CreateCoipCidr(ctx context.Context, params *CreateCoipCidrInput type CreateCoipCidrInput struct { - // A customer-owned IP address range to create. + // A customer-owned IP address range to create. // // This member is required. Cidr *string - // The ID of the address pool. + // The ID of the address pool. // // This member is required. CoipPoolId *string @@ -50,7 +50,7 @@ type CreateCoipCidrInput struct { type CreateCoipCidrOutput struct { - // Information about a range of customer-owned IP addresses. + // Information about a range of customer-owned IP addresses. CoipCidr *types.CoipCidr // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_CreateCoipPool.go b/service/ec2/api_op_CreateCoipPool.go index 7e3bc08c921..caa0b4841cf 100644 --- a/service/ec2/api_op_CreateCoipPool.go +++ b/service/ec2/api_op_CreateCoipPool.go @@ -29,7 +29,7 @@ func (c *Client) CreateCoipPool(ctx context.Context, params *CreateCoipPoolInput type CreateCoipPoolInput struct { - // The ID of the local gateway route table. + // The ID of the local gateway route table. // // This member is required. LocalGatewayRouteTableId *string @@ -40,7 +40,7 @@ type CreateCoipPoolInput struct { // UnauthorizedOperation . DryRun *bool - // The tags to assign to the CoIP address pool. + // The tags to assign to the CoIP address pool. TagSpecifications []types.TagSpecification noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateCustomerGateway.go b/service/ec2/api_op_CreateCustomerGateway.go index 6b76ad11580..395e41ad530 100644 --- a/service/ec2/api_op_CreateCustomerGateway.go +++ b/service/ec2/api_op_CreateCustomerGateway.go @@ -15,16 +15,20 @@ import ( // The customer gateway device is the appliance at your end of the VPN connection. // You must provide the IP address of the customer gateway device’s external // interface. The IP address must be static and can be behind a device performing -// network address translation (NAT). For devices that use Border Gateway Protocol -// (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. +// network address translation (NAT). +// +// For devices that use Border Gateway Protocol (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]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. +// +// [Customer gateway options for your Site-to-Site VPN connection]: https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html func (c *Client) CreateCustomerGateway(ctx context.Context, params *CreateCustomerGatewayInput, optFns ...func(*Options)) (*CreateCustomerGatewayOutput, error) { if params == nil { params = &CreateCustomerGatewayInput{} @@ -48,14 +52,17 @@ type CreateCustomerGatewayInput struct { // This member is required. Type types.GatewayType - // For devices that support BGP, the customer gateway's BGP ASN. Default: 65000 + // For devices that support BGP, the customer gateway's BGP ASN. + // + // Default: 65000 BgpAsn *int32 // The Amazon Resource Name (ARN) for the customer gateway certificate. CertificateArn *string - // A name for the customer gateway device. Length Constraints: Up to 255 - // characters. + // A name for the customer gateway device. + // + // Length Constraints: Up to 255 characters. DeviceName *string // Checks whether you have the required permissions for the action, without @@ -64,11 +71,11 @@ type CreateCustomerGatewayInput struct { // UnauthorizedOperation . DryRun *bool - // IPv4 address for the customer gateway device's outside interface. The address + // IPv4 address for the customer gateway device's outside interface. The address // must be static. IpAddress *string - // This member has been deprecated. The Internet-routable IP address for the + // This member has been deprecated. The Internet-routable IP address for the // customer gateway's outside interface. The address must be static. PublicIp *string diff --git a/service/ec2/api_op_CreateDefaultSubnet.go b/service/ec2/api_op_CreateDefaultSubnet.go index 4294b69de37..3cb3d021e4e 100644 --- a/service/ec2/api_op_CreateDefaultSubnet.go +++ b/service/ec2/api_op_CreateDefaultSubnet.go @@ -13,8 +13,9 @@ 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 Create a default subnet (https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet) -// in the Amazon VPC User Guide. +// Availability Zone. For more information, see [Create a default subnet]in the Amazon VPC User Guide. +// +// [Create a default subnet]: https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#create-default-subnet func (c *Client) CreateDefaultSubnet(ctx context.Context, params *CreateDefaultSubnetInput, optFns ...func(*Options)) (*CreateDefaultSubnetOutput, error) { if params == nil { params = &CreateDefaultSubnetInput{} diff --git a/service/ec2/api_op_CreateDefaultVpc.go b/service/ec2/api_op_CreateDefaultVpc.go index ec5bca3eced..a96d689dfaf 100644 --- a/service/ec2/api_op_CreateDefaultVpc.go +++ b/service/ec2/api_op_CreateDefaultVpc.go @@ -13,10 +13,13 @@ 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 VPCs (https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html) -// in the Amazon VPC 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. +// VPC, see [Default VPCs]in the Amazon VPC 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. +// +// [Default VPCs]: https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html func (c *Client) CreateDefaultVpc(ctx context.Context, params *CreateDefaultVpcInput, optFns ...func(*Options)) (*CreateDefaultVpcOutput, error) { if params == nil { params = &CreateDefaultVpcInput{} diff --git a/service/ec2/api_op_CreateDhcpOptions.go b/service/ec2/api_op_CreateDhcpOptions.go index c97195f3d3a..c7538847c4b 100644 --- a/service/ec2/api_op_CreateDhcpOptions.go +++ b/service/ec2/api_op_CreateDhcpOptions.go @@ -14,36 +14,48 @@ import ( // Creates a custom set of DHCP options. After you create a DHCP option set, you // associate it with a VPC. After you associate a DHCP option set with a VPC, all // existing and newly launched instances in the VPC use this set of DHCP options. +// // The following are the individual DHCP options you can specify. For more -// information, see DHCP options sets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) -// in the Amazon VPC User Guide. +// information, see [DHCP options sets]in the Amazon VPC User Guide. +// // - domain-name - If you're using AmazonProvidedDNS in us-east-1 , specify // ec2.internal . If you're using AmazonProvidedDNS in any other Region, specify // region.compute.internal . Otherwise, specify a custom domain name. This value -// is used to complete unqualified DNS hostnames. 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 option set is associated with a VPC that has -// instances running operating systems that treat the value as a single domain, -// specify only one domain name. -// - domain-name-servers - The IP addresses of up to four DNS servers, or -// AmazonProvidedDNS. To specify multiple domain name servers in a single -// parameter, separate the IP addresses using commas. To have your instances -// receive custom DNS hostnames as specified in domain-name , you must specify a -// custom DNS server. -// - ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) -// servers (four IPv4 addresses and four IPv6 addresses). -// - 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 supported. For more information -// about NetBIOS node types, see RFC 2132 (http://www.ietf.org/rfc/rfc2132.txt) . -// - ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or -// years) for how frequently a running instance with an IPv6 assigned to it goes -// through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 -// seconds (approximately 68 years). If no value is entered, the default lease time -// is 140 seconds. If you use long-term addressing for EC2 instances, you can -// increase the lease time and avoid frequent lease renewal requests. Lease renewal -// typically occurs when half of the lease time has elapsed. +// is used to complete unqualified DNS hostnames. +// +// 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 option set is +// associated with a VPC that has instances running operating systems that treat +// the value as a single domain, specify only one domain name. +// +// - domain-name-servers - The IP addresses of up to four DNS servers, or +// AmazonProvidedDNS. To specify multiple domain name servers in a single +// parameter, separate the IP addresses using commas. To have your instances +// receive custom DNS hostnames as specified in domain-name , you must specify a +// custom DNS server. +// +// - ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) +// servers (four IPv4 addresses and four IPv6 addresses). +// +// - 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 supported. For more information +// about NetBIOS node types, see [RFC 2132]. +// +// - ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or +// years) for how frequently a running instance with an IPv6 assigned to it goes +// through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 +// seconds (approximately 68 years). If no value is entered, the default lease time +// is 140 seconds. If you use long-term addressing for EC2 instances, you can +// increase the lease time and avoid frequent lease renewal requests. Lease renewal +// typically occurs when half of the lease time has elapsed. +// +// [DHCP options sets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html +// +// [RFC 2132]: http://www.ietf.org/rfc/rfc2132.txt func (c *Client) CreateDhcpOptions(ctx context.Context, params *CreateDhcpOptionsInput, optFns ...func(*Options)) (*CreateDhcpOptionsOutput, error) { if params == nil { params = &CreateDhcpOptionsInput{} diff --git a/service/ec2/api_op_CreateEgressOnlyInternetGateway.go b/service/ec2/api_op_CreateEgressOnlyInternetGateway.go index d8c1795f405..47d49df62a6 100644 --- a/service/ec2/api_op_CreateEgressOnlyInternetGateway.go +++ b/service/ec2/api_op_CreateEgressOnlyInternetGateway.go @@ -38,8 +38,9 @@ type CreateEgressOnlyInternetGatewayInput struct { VpcId *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]. + // + // [Ensuring 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 diff --git a/service/ec2/api_op_CreateFleet.go b/service/ec2/api_op_CreateFleet.go index f54ee8fc1f7..014b6c889d4 100644 --- a/service/ec2/api_op_CreateFleet.go +++ b/service/ec2/api_op_CreateFleet.go @@ -14,10 +14,14 @@ import ( // Creates an EC2 Fleet that contains the configuration information for On-Demand // Instances and Spot Instances. Instances are launched immediately if there is -// available capacity. A single EC2 Fleet can include 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. +// available capacity. +// +// A single EC2 Fleet can include multiple launch specifications that vary by +// instance type, AMI, Availability Zone, or subnet. +// +// For more information, see [EC2 Fleet] in the Amazon EC2 User Guide. +// +// [EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error) { if params == nil { params = &CreateFleetInput{} @@ -46,8 +50,9 @@ 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]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // Reserved. @@ -61,6 +66,7 @@ type CreateFleetInput struct { // 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 . ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy @@ -68,22 +74,27 @@ type CreateFleetInput struct { 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) - // in the Amazon EC2 User Guide. + // only for fleets of type maintain . For more information, see [EC2 Fleet health checks] in the Amazon EC2 + // User Guide. + // + // [EC2 Fleet health checks]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks ReplaceUnhealthyInstances *bool // Describes the configuration of Spot Instances in an EC2 Fleet. SpotOptions *types.SpotOptionsRequest // The key-value pair for tagging the EC2 Fleet request on creation. For more - // information, see Tag 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 [Tag your 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]. + // + // [launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template + // [Tag your resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources TagSpecifications []types.TagSpecification // Indicates whether running instances should be terminated when the EC2 Fleet @@ -91,18 +102,23 @@ type CreateFleetInput struct { 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) - // in the Amazon EC2 User Guide. + // + // For more information, see [EC2 Fleet request types] in the Amazon EC2 User Guide. + // + // [EC2 Fleet request types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html Type types.FleetType // The start date and time of the request, in UTC format (for example, diff --git a/service/ec2/api_op_CreateFlowLogs.go b/service/ec2/api_op_CreateFlowLogs.go index 43afd54bc45..a6bbc83600a 100644 --- a/service/ec2/api_op_CreateFlowLogs.go +++ b/service/ec2/api_op_CreateFlowLogs.go @@ -12,17 +12,22 @@ import ( ) // Creates one or more flow logs to capture information about IP traffic for a -// 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) -// 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. +// 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]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] in the Amazon Virtual Private Cloud User Guide. +// +// [Flow log records]: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records +// [VPC Flow Logs]: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html func (c *Client) CreateFlowLogs(ctx context.Context, params *CreateFlowLogsInput, optFns ...func(*Options)) (*CreateFlowLogsOutput, error) { if params == nil { params = &CreateFlowLogsInput{} @@ -41,8 +46,10 @@ 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 , - // specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway - // resource types. Maximum of 1000 for the other resource types. + // specify the IDs of the VPCs. + // + // Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 + // for the other resource types. // // This member is required. ResourceIds []string @@ -53,8 +60,9 @@ 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]. + // + // [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 @@ -62,9 +70,11 @@ type CreateFlowLogsInput struct { DeliverCrossAccountRole *string // The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log - // destination. This parameter is required if the destination type is - // cloud-watch-logs , or if the destination type is kinesis-data-firehose and the - // delivery stream and the resources to monitor are in different accounts. + // destination. + // + // This parameter is required if the destination type is cloud-watch-logs , or if + // the destination type is kinesis-data-firehose and the delivery stream and the + // resources to monitor are in different accounts. DeliverLogsPermissionArn *string // The destination options. @@ -78,43 +88,60 @@ type CreateFlowLogsInput struct { // 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. + // + // 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 + // + // arn:aws:firehose:region:account_id:deliverystream:my_stream LogDestination *string - // The type of destination for the flow log data. Default: cloud-watch-logs + // The type of destination for the flow log data. + // + // Default: cloud-watch-logs LogDestinationType types.LogDestinationType // The fields to include in the flow log record. List the fields in the order in // 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) - // in the Amazon Web Services Transit Gateway Guide. Specify the fields using the - // ${field-id} format, separated by spaces. + // least one field. For more information about the available fields, see [Flow log records]in the + // Amazon VPC User Guide or [Transit Gateway Flow Log records]in the Amazon Web Services Transit Gateway Guide. + // + // Specify the fields using the ${field-id} format, separated by spaces. + // + // [Flow log records]: https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records + // [Transit Gateway Flow Log records]: https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records LogFormat *string // 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 . + // publishes your flow logs. + // + // This parameter is valid only if the destination type 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 - // that you specify. Default: 600 + // gateway resource types. + // + // When a network interface is attached to a [Nitro-based instance], the aggregation interval is always + // 60 seconds or less, regardless of the value that you specify. + // + // Default: 600 + // + // [Nitro-based instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances MaxAggregationInterval *int32 // The tags to apply to the flow logs. diff --git a/service/ec2/api_op_CreateFpgaImage.go b/service/ec2/api_op_CreateFpgaImage.go index 6294a961932..b5b5ce5b720 100644 --- a/service/ec2/api_op_CreateFpgaImage.go +++ b/service/ec2/api_op_CreateFpgaImage.go @@ -12,11 +12,15 @@ import ( ) // Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). +// // The create operation is asynchronous. To verify that the AFI is ready for use, -// 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/) . +// 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]. +// +// [Amazon Web Services FPGA Hardware 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 +45,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string // A description for the AFI. diff --git a/service/ec2/api_op_CreateImage.go b/service/ec2/api_op_CreateImage.go index 2d57f48809e..838801fccfa 100644 --- a/service/ec2/api_op_CreateImage.go +++ b/service/ec2/api_op_CreateImage.go @@ -12,13 +12,16 @@ import ( ) // Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is -// either running or stopped. If you customized your instance with instance store -// volumes or Amazon EBS volumes in 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) -// in the Amazon Elastic Compute Cloud User Guide. +// either running or stopped. +// +// If you customized your instance with instance store volumes or Amazon EBS +// volumes in 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] in the Amazon Elastic Compute Cloud User Guide. +// +// [Create an Amazon EBS-backed Linux AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optFns ...func(*Options)) (*CreateImageOutput, error) { if params == nil { params = &CreateImageInput{} @@ -41,22 +44,28 @@ type CreateImageInput struct { // This member is required. InstanceId *string - // A name for the new image. Constraints: 3-128 alphanumeric characters, - // parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), - // dashes (-), single quotes ('), at-signs (@), or underscores(_) + // A name for the new image. + // + // Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets + // ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), + // at-signs (@), or underscores(_) // // This member is required. Name *string - // The block device mappings. When using the CreateImage action: + // The block device mappings. + // + // When using the CreateImage action: + // // - You can't change the volume size using the VolumeSize parameter. If you // want a different volume size, you must first change the volume size of the // source instance. + // // - You can't modify the encryption status of existing volumes or snapshots. To // create an AMI with volumes or snapshots that have a different encryption status // (for example, where the source volume and snapshots are unencrypted, and you - // want to create an AMI with encrypted volumes or snapshots), use the CopyImage - // action. + // want to create an AMI with encrypted volumes or snapshots), use the CopyImageaction. + // // - The only option that can be changed for existing mappings or snapshots is // DeleteOnTermination . BlockDeviceMappings []types.BlockDeviceMapping @@ -72,27 +81,35 @@ type CreateImageInput struct { // Indicates whether or not the instance should be automatically rebooted before // creating the image. Specify one of the following values: + // // - true - The instance is not rebooted before creating the image. This creates // crash-consistent snapshots that include only the data that has been written to // the volumes at the time the snapshots are created. Buffered data and data in // memory that has not yet been written to the volumes is not included in the // snapshots. + // // - false - The instance is rebooted before creating the image. This ensures // that all buffered data and data in memory is written to the volumes before the // snapshots are created. + // // Default: false 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) - // . + // + // If you specify other values for ResourceType , the request fails. + // + // To tag an AMI or snapshot after it has been created, see [CreateTags]. + // + // [CreateTags]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html TagSpecifications []types.TagSpecification noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateInstanceConnectEndpoint.go b/service/ec2/api_op_CreateInstanceConnectEndpoint.go index 091b7e56f14..3d003def864 100644 --- a/service/ec2/api_op_CreateInstanceConnectEndpoint.go +++ b/service/ec2/api_op_CreateInstanceConnectEndpoint.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an EC2 Instance Connect Endpoint. An EC2 Instance Connect Endpoint -// allows you to connect to an instance, without requiring the instance to have a -// public IPv4 address. For more information, see Connect to your instances -// without requiring a public IPv4 address using EC2 Instance Connect Endpoint (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html) +// Creates an EC2 Instance Connect Endpoint. +// +// An EC2 Instance Connect Endpoint allows you to connect to an instance, without +// requiring the instance to have a public IPv4 address. For more information, see [Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint] // in the Amazon EC2 User Guide. +// +// [Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html func (c *Client) CreateInstanceConnectEndpoint(ctx context.Context, params *CreateInstanceConnectEndpointInput, optFns ...func(*Options)) (*CreateInstanceConnectEndpointOutput, error) { if params == nil { params = &CreateInstanceConnectEndpointInput{} @@ -50,9 +52,12 @@ type CreateInstanceConnectEndpointInput struct { // Indicates whether your client's IP address is preserved as the source. The // value is true or false . + // // - If true , your client's IP address is used when you connect to a resource. + // // - If false , the elastic network interface IP address is used when you connect // to a resource. + // // Default: true PreserveClientIp *bool diff --git a/service/ec2/api_op_CreateInstanceEventWindow.go b/service/ec2/api_op_CreateInstanceEventWindow.go index 32c3693b700..55a13138afc 100644 --- a/service/ec2/api_op_CreateInstanceEventWindow.go +++ b/service/ec2/api_op_CreateInstanceEventWindow.go @@ -12,20 +12,29 @@ import ( ) // Creates an event window in which scheduled events for the associated Amazon EC2 -// instances can run. You can define either a set of time ranges or a cron -// expression when creating the event window, but not both. All event window times -// are in UTC. You can create up to 200 event windows per Amazon Web Services -// Region. When you create the event window, targets (instance IDs, Dedicated Host -// IDs, or tags) are not yet associated with it. To ensure that the event window -// can be used, you must associate one or more targets with it by using the -// AssociateInstanceEventWindow API. Event windows are applicable only for -// scheduled events that stop, reboot, or terminate instances. Event windows are -// not applicable for: +// instances can run. +// +// You can define either a set of time ranges or a cron expression when creating +// the event window, but not both. All event window times are in UTC. +// +// You can create up to 200 event windows per Amazon Web Services Region. +// +// When you create the event window, targets (instance IDs, Dedicated Host IDs, or +// tags) are not yet associated with it. To ensure that the event window can be +// used, you must associate one or more targets with it by using the AssociateInstanceEventWindowAPI. +// +// 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. // -// 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] in the Amazon EC2 User Guide. +// +// [Define event windows for scheduled events]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html func (c *Client) CreateInstanceEventWindow(ctx context.Context, params *CreateInstanceEventWindowInput, optFns ...func(*Options)) (*CreateInstanceEventWindowOutput, error) { if params == nil { params = &CreateInstanceEventWindowInput{} @@ -44,18 +53,28 @@ 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 - // you specify a cron expression, you can't specify a time range. Constraints: + // 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. + // + // For more information about cron expressions, see [cron] on the Wikipedia website. + // + // [cron]: https://en.wikipedia.org/wiki/Cron CronExpression *string // Checks whether you have the required permissions for the action, without diff --git a/service/ec2/api_op_CreateInstanceExportTask.go b/service/ec2/api_op_CreateInstanceExportTask.go index 936c31fa7a8..bd2e8f4b59b 100644 --- a/service/ec2/api_op_CreateInstanceExportTask.go +++ b/service/ec2/api_op_CreateInstanceExportTask.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports a running or stopped instance to an Amazon S3 bucket. For information -// about the prerequisites for your Amazon S3 bucket, 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. +// Exports a running or stopped instance to an Amazon S3 bucket. +// +// For information about the prerequisites for your Amazon S3 bucket, 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]in the VM Import/Export User Guide. +// +// [Exporting an instance as a VM Using VM Import/Export]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html 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 4d93c43b8f8..6dfcd97c499 100644 --- a/service/ec2/api_op_CreateInternetGateway.go +++ b/service/ec2/api_op_CreateInternetGateway.go @@ -12,9 +12,11 @@ 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 -// information, see Internet gateways (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) -// in the Amazon VPC User Guide. +// gateway, you attach it to a VPC using AttachInternetGateway. +// +// For more information, see [Internet gateways] in the Amazon VPC User Guide. +// +// [Internet gateways]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html func (c *Client) CreateInternetGateway(ctx context.Context, params *CreateInternetGatewayInput, optFns ...func(*Options)) (*CreateInternetGatewayOutput, error) { if params == nil { params = &CreateInternetGatewayInput{} diff --git a/service/ec2/api_op_CreateIpam.go b/service/ec2/api_op_CreateIpam.go index 4cdf8449dbb..3267397e50d 100644 --- a/service/ec2/api_op_CreateIpam.go +++ b/service/ec2/api_op_CreateIpam.go @@ -14,9 +14,11 @@ import ( // Create an IPAM. Amazon VPC IP Address Manager (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 Create an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) -// in the Amazon VPC IPAM User Guide. +// Regions and accounts throughout your Amazon Web Services Organization. +// +// For more information, see [Create an IPAM] in the Amazon VPC IPAM User Guide. +// +// [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html func (c *Client) CreateIpam(ctx context.Context, params *CreateIpamInput, optFns ...func(*Options)) (*CreateIpamOutput, error) { if params == nil { params = &CreateIpamInput{} @@ -35,8 +37,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the IPAM. @@ -51,9 +54,12 @@ type CreateIpamInput struct { // The operating Regions for the IPAM. Operating Regions are Amazon Web Services // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only // discovers and monitors resources in the Amazon Web Services Regions you select - // as operating Regions. For more information about operating Regions, see Create - // an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the - // Amazon VPC IPAM User Guide. + // as operating Regions. + // + // For more information about operating Regions, see [Create an IPAM] in the Amazon VPC IPAM User + // Guide. + // + // [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html OperatingRegions []types.AddIpamOperatingRegion // The key/value combination of a tag assigned to the resource. Use the tag key in @@ -64,7 +70,9 @@ type CreateIpamInput struct { // IPAM is offered in a Free Tier and an Advanced Tier. For more information about // the features available in each tier and the costs associated with the tiers, see - // Amazon VPC pricing > IPAM tab (http://aws.amazon.com/vpc/pricing/) . + // [Amazon VPC pricing > IPAM tab]. + // + // [Amazon VPC pricing > IPAM tab]: http://aws.amazon.com/vpc/pricing/ Tier types.IpamTier noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateIpamPool.go b/service/ec2/api_op_CreateIpamPool.go index cdb8144d5cf..556508e4e56 100644 --- a/service/ec2/api_op_CreateIpamPool.go +++ b/service/ec2/api_op_CreateIpamPool.go @@ -15,9 +15,11 @@ import ( // pool is a collection of contiguous IP addresses CIDRs. Pools enable you to // 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. +// production applications, you can create a pool for each. +// +// For more information, see [Create a top-level pool] in the Amazon VPC IPAM User Guide. +// +// [Create a top-level pool]: https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html func (c *Client) CreateIpamPool(ctx context.Context, params *CreateIpamPoolInput, optFns ...func(*Options)) (*CreateIpamPoolOutput, error) { if params == nil { params = &CreateIpamPoolInput{} @@ -78,7 +80,9 @@ type CreateIpamPoolInput struct { // 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. + // 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. @@ -86,8 +90,9 @@ type CreateIpamPoolInput struct { 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the IPAM pool. @@ -105,18 +110,20 @@ type CreateIpamPoolInput struct { // allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale // with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot // modify it. If you do not choose a locale, resources in Regions others than the - // IPAM's home region cannot use CIDRs from this pool. Possible values: Any Amazon - // Web Services Region, such as us-east-1. + // IPAM's home region cannot use CIDRs from this pool. + // + // Possible values: Any Amazon Web Services Region, such as us-east-1. 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. + // information, see [Create IPv6 pools]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] + // in the Amazon VPC IPAM User Guide. + // + // [Create IPv6 pools]: https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html + // [Quotas for your IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html PublicIpSource types.IpamPoolPublicIpSource // Determines if the pool is publicly advertisable. This option is not available diff --git a/service/ec2/api_op_CreateIpamScope.go b/service/ec2/api_op_CreateIpamScope.go index b50c229b7d5..5154c27cf70 100644 --- a/service/ec2/api_op_CreateIpamScope.go +++ b/service/ec2/api_op_CreateIpamScope.go @@ -16,8 +16,11 @@ 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] in the Amazon VPC IPAM User Guide. +// +// [Add a scope]: https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html func (c *Client) CreateIpamScope(ctx context.Context, params *CreateIpamScopeInput, optFns ...func(*Options)) (*CreateIpamScopeOutput, error) { if params == nil { params = &CreateIpamScopeInput{} @@ -41,8 +44,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the scope you're creating. diff --git a/service/ec2/api_op_CreateKeyPair.go b/service/ec2/api_op_CreateKeyPair.go index 70156303117..40bd81ce077 100644 --- a/service/ec2/api_op_CreateKeyPair.go +++ b/service/ec2/api_op_CreateKeyPair.go @@ -16,12 +16,17 @@ import ( // private key for you to save to a file. The private key is returned as an // unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted // private key for use with PuTTY. If a key with the specified name already exists, -// 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. +// 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] in the Amazon Elastic Compute Cloud User Guide. +// +// [Amazon EC2 key pairs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, optFns ...func(*Options)) (*CreateKeyPairOutput, error) { if params == nil { params = &CreateKeyPairInput{} @@ -39,7 +44,9 @@ func (c *Client) CreateKeyPair(ctx context.Context, params *CreateKeyPairInput, type CreateKeyPairInput struct { - // A unique name for the key pair. Constraints: Up to 255 ASCII characters + // A unique name for the key pair. + // + // Constraints: Up to 255 ASCII characters // // This member is required. KeyName *string @@ -50,11 +57,15 @@ type CreateKeyPairInput struct { // UnauthorizedOperation . DryRun *bool - // The format of the key pair. Default: pem + // The format of the key pair. + // + // Default: pem KeyFormat types.KeyFormat // The type of key pair. Note that ED25519 keys are not supported for Windows - // instances. Default: rsa + // instances. + // + // Default: rsa KeyType types.KeyType // The tags to apply to the new key pair. @@ -68,6 +79,7 @@ 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. KeyFingerprint *string diff --git a/service/ec2/api_op_CreateLaunchTemplate.go b/service/ec2/api_op_CreateLaunchTemplate.go index 5f4dd44a29f..8cfe7bebc5b 100644 --- a/service/ec2/api_op_CreateLaunchTemplate.go +++ b/service/ec2/api_op_CreateLaunchTemplate.go @@ -11,15 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the Amazon Elastic Compute Cloud User Guide. To clone an existing launch -// template as the basis for a new launch template, 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) -// in the Amazon Elastic Compute Cloud User Guide. +// 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 launch template instead of +// providing the launch parameters in the request. For more information, see [Launch an instance from a launch template]in +// the Amazon Elastic Compute Cloud User Guide. +// +// To clone an existing launch template as the basis for a new launch template, +// 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]in the Amazon Elastic Compute Cloud User +// Guide. +// +// [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 +// [Launch an instance from a launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html func (c *Client) CreateLaunchTemplate(ctx context.Context, params *CreateLaunchTemplateInput, optFns ...func(*Options)) (*CreateLaunchTemplateOutput, error) { if params == nil { params = &CreateLaunchTemplateInput{} @@ -48,8 +53,11 @@ 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]. + // + // Constraint: Maximum 128 ASCII characters. + // + // [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 @@ -59,10 +67,12 @@ type CreateLaunchTemplateInput struct { 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) - // structure. + // 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] structure. + // + // [launch template data]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html TagSpecifications []types.TagSpecification // A description for the first version of the launch template. diff --git a/service/ec2/api_op_CreateLaunchTemplateVersion.go b/service/ec2/api_op_CreateLaunchTemplateVersion.go index b8ad592735f..0c0ece96de8 100644 --- a/service/ec2/api_op_CreateLaunchTemplateVersion.go +++ b/service/ec2/api_op_CreateLaunchTemplateVersion.go @@ -14,13 +14,18 @@ import ( // Creates a new version of a launch template. You must specify an existing launch // template, either by name or ID. You can determine whether the new version // inherits parameters from a source version, and add or overwrite parameters as -// needed. Launch template versions are numbered in the order in which they are -// created. You can't specify, change, or replace the numbering of launch template -// versions. Launch templates are 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 the changes that 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) -// in the Amazon Elastic Compute Cloud User Guide. +// needed. +// +// Launch template versions are numbered in the order in which they are created. +// You can't specify, change, or replace the numbering of launch template versions. +// +// Launch templates are 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 the changes that you require. +// +// For more information, see [Modify a launch template (manage launch template versions)] in the Amazon Elastic Compute Cloud User Guide. +// +// [Modify a launch template (manage launch template versions)]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#manage-launch-template-versions func (c *Client) CreateLaunchTemplateVersion(ctx context.Context, params *CreateLaunchTemplateVersionInput, optFns ...func(*Options)) (*CreateLaunchTemplateVersionOutput, error) { if params == nil { params = &CreateLaunchTemplateVersionInput{} @@ -44,8 +49,11 @@ 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]. + // + // Constraint: Maximum 128 ASCII characters. + // + // [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 @@ -54,28 +62,38 @@ type CreateLaunchTemplateVersionInput struct { // UnauthorizedOperation . DryRun *bool - // The ID of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The ID of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateId *string - // The name of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The name of the launch template. + // + // You must specify either the launch template ID or the launch template name, 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) - // in the Amazon Elastic Compute Cloud User Guide. Default: false + // ID is displayed in the response for imageID . For more information, see [Use a Systems Manager parameter instead of an AMI ID] in the + // Amazon Elastic Compute Cloud User Guide. + // + // Default: false + // + // [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 ResolveAlias *bool // The version of the launch template on which to base the new version. Snapshots // applied to the block device mapping are ignored when creating a new version - // unless they are explicitly included. If you specify this parameter, the new - // version inherits the launch parameters from the source version. If you specify - // additional launch parameters for the new version, they overwrite any - // corresponding launch parameters inherited from the source version. If you omit - // this parameter, the new version contains only the launch parameters that you - // specify for the new version. + // unless they are explicitly included. + // + // If you specify this parameter, the new version inherits the launch parameters + // from the source version. If you specify additional launch parameters for the new + // version, they overwrite any corresponding launch parameters inherited from the + // source version. + // + // If you omit this parameter, the new version contains only the launch parameters + // that you specify for the new version. 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 926e5e241c9..0265a7d70a4 100644 --- a/service/ec2/api_op_CreateLocalGatewayRoute.go +++ b/service/ec2/api_op_CreateLocalGatewayRoute.go @@ -13,7 +13,9 @@ import ( // Creates a static route for the specified local gateway route table. You must // specify one of the following targets: +// // - LocalGatewayVirtualInterfaceGroupId +// // - NetworkInterfaceId func (c *Client) CreateLocalGatewayRoute(ctx context.Context, params *CreateLocalGatewayRouteInput, optFns ...func(*Options)) (*CreateLocalGatewayRouteOutput, error) { if params == nil { @@ -41,7 +43,7 @@ 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 diff --git a/service/ec2/api_op_CreateLocalGatewayRouteTable.go b/service/ec2/api_op_CreateLocalGatewayRouteTable.go index 7e78809717b..366151c79ae 100644 --- a/service/ec2/api_op_CreateLocalGatewayRouteTable.go +++ b/service/ec2/api_op_CreateLocalGatewayRouteTable.go @@ -29,7 +29,7 @@ func (c *Client) CreateLocalGatewayRouteTable(ctx context.Context, params *Creat type CreateLocalGatewayRouteTableInput struct { - // The ID of the local gateway. + // The ID of the local gateway. // // This member is required. LocalGatewayId *string @@ -40,10 +40,10 @@ type CreateLocalGatewayRouteTableInput struct { // UnauthorizedOperation . DryRun *bool - // The mode of the local gateway route table. + // The mode of the local gateway route table. Mode types.LocalGatewayRouteTableMode - // The tags assigned to the local gateway route table. + // The tags assigned to the local gateway route table. TagSpecifications []types.TagSpecification noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go b/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go index c529d69cd9a..757d38a8b4c 100644 --- a/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go +++ b/service/ec2/api_op_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go @@ -29,12 +29,12 @@ func (c *Client) CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation(ct type CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationInput struct { - // The ID of the local gateway route table. + // The ID of the local gateway route table. // // This member is required. LocalGatewayRouteTableId *string - // The ID of the local gateway route table virtual interface group association. + // The ID of the local gateway route table virtual interface group association. // // This member is required. LocalGatewayVirtualInterfaceGroupId *string @@ -45,7 +45,7 @@ type CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationInput struct { // UnauthorizedOperation . DryRun *bool - // The tags assigned to the local gateway route table virtual interface group + // The tags assigned to the local gateway route table virtual interface group // association. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateManagedPrefixList.go b/service/ec2/api_op_CreateManagedPrefixList.go index 9ddae065aec..edc00c7ba33 100644 --- a/service/ec2/api_op_CreateManagedPrefixList.go +++ b/service/ec2/api_op_CreateManagedPrefixList.go @@ -30,7 +30,9 @@ func (c *Client) CreateManagedPrefixList(ctx context.Context, params *CreateMana type CreateManagedPrefixListInput struct { - // The IP address type. Valid Values: IPv4 | IPv6 + // The IP address type. + // + // Valid Values: IPv4 | IPv6 // // This member is required. AddressFamily *string @@ -40,15 +42,20 @@ type CreateManagedPrefixListInput struct { // This member is required. MaxEntries *int32 - // A name for the prefix list. Constraints: Up to 255 characters in length. The - // name cannot start with com.amazonaws . + // A name for the prefix list. + // + // Constraints: Up to 255 characters in length. The 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]. + // + // Constraints: Up to 255 UTF-8 characters in length. + // + // [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 diff --git a/service/ec2/api_op_CreateNatGateway.go b/service/ec2/api_op_CreateNatGateway.go index 0fcb55cb3b8..279249a48e8 100644 --- a/service/ec2/api_op_CreateNatGateway.go +++ b/service/ec2/api_op_CreateNatGateway.go @@ -14,23 +14,31 @@ import ( // Creates a NAT gateway in the specified subnet. This action creates a network // interface in the specified subnet with a private IP address from the IP address // range of the subnet. You can create either a public NAT gateway or a private NAT -// gateway. With a public NAT gateway, internet-bound traffic from a private subnet -// can be routed to the NAT gateway, so that instances in a private subnet can -// connect to the internet. With a private NAT gateway, private communication is -// routed across VPCs and on-premises networks through a transit gateway or virtual -// private gateway. Common use cases include running large workloads behind a small -// pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and -// communicating between overlapping networks. For more information, see NAT -// gateways (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) -// in the Amazon VPC User Guide. When you create a public NAT gateway and assign it -// an EIP or secondary EIPs, the network border group of the EIPs must match the -// network border group of the Availability Zone (AZ) that the public NAT gateway -// is in. If it's not the same, the NAT gateway will fail to launch. You can see -// the network border group for the subnet's AZ by viewing the details of the -// subnet. Similarly, you can view the network border group of an EIP by viewing -// the details of the EIP address. For more information about network border groups -// and EIPs, see Allocate an Elastic IP address (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) -// in the Amazon VPC User Guide. +// gateway. +// +// With a public NAT gateway, internet-bound traffic from a private subnet can be +// routed to the NAT gateway, so that instances in a private subnet can connect to +// the internet. +// +// With a private NAT gateway, private communication is routed across VPCs and +// on-premises networks through a transit gateway or virtual private gateway. +// Common use cases include running large workloads behind a small pool of +// allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating +// between overlapping networks. +// +// For more information, see [NAT gateways] in the Amazon VPC User Guide. +// +// When you create a public NAT gateway and assign it an EIP or secondary EIPs, +// the network border group of the EIPs must match the network border group of the +// Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, +// the NAT gateway will fail to launch. You can see the network border group for +// the subnet's AZ by viewing the details of the subnet. Similarly, you can view +// the network border group of an EIP by viewing the details of the EIP address. +// For more information about network border groups and EIPs, see [Allocate an Elastic IP address]in the Amazon +// VPC User Guide. +// +// [NAT gateways]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html +// [Allocate an Elastic IP address]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip func (c *Client) CreateNatGateway(ctx context.Context, params *CreateNatGatewayInput, optFns ...func(*Options)) (*CreateNatGatewayOutput, error) { if params == nil { params = &CreateNatGatewayInput{} @@ -60,8 +68,11 @@ type CreateNatGatewayInput struct { AllocationId *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) - // . Constraint: Maximum 64 ASCII characters. + // the request. For more information, see [Ensuring idempotency]. + // + // Constraint: Maximum 64 ASCII characters. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // Indicates whether the NAT gateway supports public or private connectivity. The @@ -78,19 +89,23 @@ type CreateNatGatewayInput struct { // address, a private IPv4 address will be automatically assigned. PrivateIpAddress *string - // Secondary EIP allocation IDs. For more information, see Create a NAT gateway (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) - // in the Amazon VPC User Guide. + // Secondary EIP allocation IDs. For more information, see [Create a NAT gateway] in the Amazon VPC User + // Guide. + // + // [Create a NAT gateway]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating 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) - // in the Amazon VPC User Guide. + // addresses, see [Create a NAT gateway]in the Amazon VPC User Guide. + // + // [Create a NAT gateway]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating 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) - // in the Amazon VPC User Guide. + // addresses, see [Create a NAT gateway]in the Amazon VPC User Guide. + // + // [Create a NAT gateway]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating SecondaryPrivateIpAddresses []string // The tags to assign to the NAT gateway. diff --git a/service/ec2/api_op_CreateNetworkAcl.go b/service/ec2/api_op_CreateNetworkAcl.go index 5cad2b52aa7..290d06a6635 100644 --- a/service/ec2/api_op_CreateNetworkAcl.go +++ b/service/ec2/api_op_CreateNetworkAcl.go @@ -12,9 +12,11 @@ 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-network-acls.html) -// in the Amazon VPC User Guide. +// security (in addition to security groups) for the instances in your VPC. +// +// For more information, see [Network ACLs] in the Amazon VPC User Guide. +// +// [Network ACLs]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html func (c *Client) CreateNetworkAcl(ctx context.Context, params *CreateNetworkAclInput, optFns ...func(*Options)) (*CreateNetworkAclOutput, error) { if params == nil { params = &CreateNetworkAclInput{} @@ -38,8 +40,9 @@ type CreateNetworkAclInput struct { VpcId *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]. + // + // [Ensuring 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 diff --git a/service/ec2/api_op_CreateNetworkAclEntry.go b/service/ec2/api_op_CreateNetworkAclEntry.go index 920d41f62de..4480c68699f 100644 --- a/service/ec2/api_op_CreateNetworkAclEntry.go +++ b/service/ec2/api_op_CreateNetworkAclEntry.go @@ -16,14 +16,19 @@ import ( // egress rules. When determining whether a packet should be allowed in or out of a // subnet associated with the ACL, we process the entries in the ACL according to // the rule numbers, in ascending order. Each network ACL has a set of ingress -// rules and a separate set of egress rules. We recommend that you leave room -// between the rule numbers (for example, 100, 110, 120, ...), and not number them -// one right after the other (for example, 101, 102, 103, ...). This makes it -// easier to add a rule between existing ones without having to renumber the rules. +// rules and a separate set of egress rules. +// +// We recommend that you leave room between the rule numbers (for example, 100, +// 110, 120, ...), and not number them one right after the other (for example, 101, +// 102, 103, ...). This makes it 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-network-acls.html) -// in the Amazon VPC User Guide. +// create an entry and delete the old one. +// +// For more information about network ACLs, see [Network ACLs] in the Amazon VPC User Guide. +// +// [Network ACLs]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html func (c *Client) CreateNetworkAclEntry(ctx context.Context, params *CreateNetworkAclEntryInput, optFns ...func(*Options)) (*CreateNetworkAclEntryOutput, error) { if params == nil { params = &CreateNetworkAclEntryInput{} @@ -69,8 +74,10 @@ type CreateNetworkAclEntryInput struct { RuleAction types.RuleAction // The rule number for the entry (for example, 100). ACL entries are processed in - // ascending order by rule number. Constraints: Positive integer from 1 to 32766. - // The range 32767 to 65535 is reserved for internal use. + // ascending order by rule number. + // + // Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is + // reserved for internal use. // // This member is required. RuleNumber *int32 diff --git a/service/ec2/api_op_CreateNetworkInsightsAccessScope.go b/service/ec2/api_op_CreateNetworkInsightsAccessScope.go index 41289ca6283..0744bfa39c6 100644 --- a/service/ec2/api_op_CreateNetworkInsightsAccessScope.go +++ b/service/ec2/api_op_CreateNetworkInsightsAccessScope.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Network Access Scope. Amazon Web Services Network Access Analyzer -// 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/) +// Creates a Network Access Scope. +// +// Amazon Web Services Network Access Analyzer 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] // . +// +// [Amazon Web Services Network Access 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{} @@ -35,8 +37,9 @@ 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]. + // + // [How to ensure 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_CreateNetworkInsightsPath.go b/service/ec2/api_op_CreateNetworkInsightsPath.go index 5d3ebe74500..8242a12df67 100644 --- a/service/ec2/api_op_CreateNetworkInsightsPath.go +++ b/service/ec2/api_op_CreateNetworkInsightsPath.go @@ -11,10 +11,13 @@ 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]. +// +// [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{} @@ -33,8 +36,9 @@ 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]. + // + // [How to ensure 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_CreateNetworkInterface.go b/service/ec2/api_op_CreateNetworkInterface.go index ecbdf37a2b6..c9777408675 100644 --- a/service/ec2/api_op_CreateNetworkInterface.go +++ b/service/ec2/api_op_CreateNetworkInterface.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// 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]in the Amazon Virtual Private Cloud +// User Guide. +// +// For more information about network interfaces, see [Elastic network interfaces] in the Amazon Elastic +// Compute Cloud User Guide. +// +// [Elastic network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html +// [IP Addresses Per ENI Per Instance Type]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI func (c *Client) CreateNetworkInterface(ctx context.Context, params *CreateNetworkInterfaceInput, optFns ...func(*Options)) (*CreateNetworkInterfaceOutput, error) { if params == nil { params = &CreateNetworkInterfaceInput{} @@ -40,8 +45,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A connection tracking specification for the network interface. @@ -74,44 +80,56 @@ type CreateNetworkInterfaceInput struct { // The IDs of one or more security groups. Groups []string - // The type of network interface. The default is interface . The only supported - // values are interface , efa , and trunk . + // The type of network interface. The default is interface . + // + // The only supported values are interface , efa , and trunk . InterfaceType types.NetworkInterfaceCreationType // The number of IPv4 prefixes that Amazon Web Services automatically assigns to - // the network interface. You can't specify a count of IPv4 prefixes if you've - // specified one of the following: specific IPv4 prefixes, specific private IPv4 - // addresses, or a count of private IPv4 addresses. + // the network interface. + // + // You can't specify a count of IPv4 prefixes if you've specified one of the + // following: specific IPv4 prefixes, specific private IPv4 addresses, or a count + // of private IPv4 addresses. Ipv4PrefixCount *int32 - // The IPv4 prefixes assigned to the network interface. You can't specify IPv4 - // prefixes if you've specified one of the following: a count of IPv4 prefixes, - // specific private IPv4 addresses, or a count of private IPv4 addresses. + // The IPv4 prefixes assigned to the network interface. + // + // You can't specify IPv4 prefixes if you've specified one of the following: a + // count of IPv4 prefixes, specific private IPv4 addresses, or a count of private + // IPv4 addresses. Ipv4Prefixes []types.Ipv4PrefixSpecificationRequest // 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 - // 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. + // 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. Ipv6AddressCount *int32 - // The IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't - // specify IPv6 addresses using this parameter if you've specified one of the - // following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 - // prefixes. + // The IPv6 addresses from the IPv6 CIDR block range of your subnet. + // + // You can't specify IPv6 addresses using this parameter if you've specified one + // of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count + // of IPv6 prefixes. Ipv6Addresses []types.InstanceIpv6Address // The number of IPv6 prefixes that Amazon Web Services automatically assigns to - // the network interface. You can't specify a count of IPv6 prefixes if you've - // specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, - // or a count of IPv6 addresses. + // the network interface. + // + // You can't specify a count of IPv6 prefixes if you've specified one of the + // following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 + // addresses. Ipv6PrefixCount *int32 - // The IPv6 prefixes assigned to the network interface. You can't specify IPv6 - // prefixes if you've specified one of the following: a count of IPv6 prefixes, - // specific IPv6 addresses, or a count of IPv6 addresses. + // The IPv6 prefixes assigned to the network interface. + // + // You can't specify IPv6 prefixes if you've specified one of the following: a + // count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. Ipv6Prefixes []types.Ipv6PrefixSpecificationRequest // The primary private IPv4 address of the network interface. If you don't specify @@ -121,18 +139,22 @@ type CreateNetworkInterfaceInput struct { // designated as primary). PrivateIpAddress *string - // The private IPv4 addresses. You can't specify private IPv4 addresses if you've - // specified one of the following: a count of private IPv4 addresses, specific IPv4 - // prefixes, or a count of IPv4 prefixes. + // The private IPv4 addresses. + // + // You can't specify private IPv4 addresses if you've specified one of the + // following: a count of private IPv4 addresses, specific IPv4 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. + // 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 e7e8e1cbb60..4c992e04da3 100644 --- a/service/ec2/api_op_CreateNetworkInterfacePermission.go +++ b/service/ec2/api_op_CreateNetworkInterfacePermission.go @@ -12,9 +12,10 @@ import ( ) // Grants an Amazon Web Services-authorized account permission to attach the -// specified network interface to an instance in their account. You can grant -// permission to a single Amazon Web Services account only, and only one account at -// a time. +// specified network interface to an instance in their account. +// +// You can grant permission to a single Amazon Web Services account only, and only +// one account at a time. func (c *Client) CreateNetworkInterfacePermission(ctx context.Context, params *CreateNetworkInterfacePermissionInput, optFns ...func(*Options)) (*CreateNetworkInterfacePermissionOutput, error) { if params == nil { params = &CreateNetworkInterfacePermissionInput{} diff --git a/service/ec2/api_op_CreatePlacementGroup.go b/service/ec2/api_op_CreatePlacementGroup.go index 09bd1f695c3..4c6249e51cc 100644 --- a/service/ec2/api_op_CreatePlacementGroup.go +++ b/service/ec2/api_op_CreatePlacementGroup.go @@ -12,14 +12,18 @@ import ( ) // Creates a placement group in which to launch instances. The strategy of the -// placement group determines how the instances are organized within the group. A -// cluster placement group is a logical grouping of instances within a single +// placement group determines how the instances are organized within the group. +// +// A cluster placement group is a logical grouping of instances within a single // Availability Zone that benefit from low network latency, high network // 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] in the Amazon EC2 User Guide. +// +// [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html func (c *Client) CreatePlacementGroup(ctx context.Context, params *CreatePlacementGroupInput, optFns ...func(*Options)) (*CreatePlacementGroupOutput, error) { if params == nil { params = &CreatePlacementGroupInput{} @@ -44,14 +48,18 @@ type CreatePlacementGroupInput struct { 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 + // for the Region. + // + // Constraints: Up to 255 ASCII characters GroupName *string // 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. SpreadLevel types.SpreadLevel diff --git a/service/ec2/api_op_CreatePublicIpv4Pool.go b/service/ec2/api_op_CreatePublicIpv4Pool.go index 5ba26ed1ccd..7cbc9cc6905 100644 --- a/service/ec2/api_op_CreatePublicIpv4Pool.go +++ b/service/ec2/api_op_CreatePublicIpv4Pool.go @@ -14,9 +14,9 @@ import ( // 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) -// . +// however, use IPAM pools only. To monitor the status of pool creation, use [DescribePublicIpv4Pools]. +// +// [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{} diff --git a/service/ec2/api_op_CreateReplaceRootVolumeTask.go b/service/ec2/api_op_CreateReplaceRootVolumeTask.go index 9811a4e305b..aa7239e03ef 100644 --- a/service/ec2/api_op_CreateReplaceRootVolumeTask.go +++ b/service/ec2/api_op_CreateReplaceRootVolumeTask.go @@ -14,9 +14,11 @@ import ( // Replaces the EBS-backed root volume for a running instance with a new volume // 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. +// from an AMI that has the same key characteristics as that of the instance. +// +// For more information, see [Replace a root volume] in the Amazon Elastic Compute Cloud User Guide. +// +// [Replace a root volume]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html func (c *Client) CreateReplaceRootVolumeTask(ctx context.Context, params *CreateReplaceRootVolumeTaskInput, optFns ...func(*Options)) (*CreateReplaceRootVolumeTaskOutput, error) { if params == nil { params = &CreateReplaceRootVolumeTaskInput{} @@ -41,9 +43,9 @@ 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) - // . + // used for the request to ensure idempotency. For more information, see [Ensuring idempotency]. + // + // [Ensuring 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 @@ -61,16 +63,19 @@ type CreateReplaceRootVolumeTaskInput struct { // 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. + // 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. ImageId *string // The ID of the snapshot from which to restore the replacement root volume. The // specified snapshot must be a snapshot that you previously created from the - // original root volume. If you want to restore the replacement root volume to the - // initial launch state, or if you want to restore the replacement root volume from - // an AMI, omit this parameter. + // original root volume. + // + // If you want to restore the replacement root volume to the initial launch state, + // or if you want to restore the replacement root volume from an AMI, omit this + // parameter. SnapshotId *string // The tags to apply to the root volume replacement task. diff --git a/service/ec2/api_op_CreateReservedInstancesListing.go b/service/ec2/api_op_CreateReservedInstancesListing.go index 7b0747ce695..e0942649436 100644 --- a/service/ec2/api_op_CreateReservedInstancesListing.go +++ b/service/ec2/api_op_CreateReservedInstancesListing.go @@ -14,21 +14,27 @@ import ( // Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the // Reserved Instance Marketplace. You can submit one Standard Reserved Instance // listing at a time. To get a list of your Standard Reserved Instances, you can -// use the DescribeReservedInstances operation. Only Standard Reserved Instances -// can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances -// cannot be sold. The Reserved Instance Marketplace matches sellers who want to -// resell Standard Reserved Instance capacity that they no longer need with buyers -// who want to purchase additional capacity. Reserved Instances bought and sold -// through the Reserved Instance Marketplace work like any other Reserved -// Instances. To sell your Standard Reserved Instances, you must first register as -// a seller in the Reserved Instance Marketplace. After completing the registration -// process, you can create a Reserved Instance Marketplace listing of some or all -// of your Standard Reserved Instances, and specify the upfront price to receive -// 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. +// use the DescribeReservedInstancesoperation. +// +// Only Standard Reserved Instances can be sold in the Reserved Instance +// Marketplace. Convertible Reserved Instances cannot be sold. +// +// The Reserved Instance Marketplace matches sellers who want to resell Standard +// Reserved Instance capacity that they no longer need with buyers who want to +// purchase additional capacity. Reserved Instances bought and sold through the +// Reserved Instance Marketplace work like any other Reserved Instances. +// +// To sell your Standard Reserved Instances, you must first register as a seller +// in the Reserved Instance Marketplace. After completing the registration process, +// you can create a Reserved Instance Marketplace listing of some or all of your +// Standard Reserved Instances, and specify the upfront price to receive 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] in the Amazon EC2 User Guide. +// +// [Reserved Instance Marketplace]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html func (c *Client) CreateReservedInstancesListing(ctx context.Context, params *CreateReservedInstancesListingInput, optFns ...func(*Options)) (*CreateReservedInstancesListingOutput, error) { if params == nil { params = &CreateReservedInstancesListingInput{} @@ -48,9 +54,9 @@ func (c *Client) CreateReservedInstancesListing(ctx context.Context, params *Cre 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) - // . + // listings. This helps avoid duplicate listings. For more information, see [Ensuring Idempotency]. + // + // [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 4bea73f6de7..31c59fa64dd 100644 --- a/service/ec2/api_op_CreateRestoreImageTask.go +++ b/service/ec2/api_op_CreateRestoreImageTask.go @@ -12,12 +12,16 @@ 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]. +// +// To use this API, you must have the required permissions. For more information, +// see [Permissions for storing and restoring AMIs using Amazon S3]in the Amazon EC2 User Guide. +// +// For more information, see [Store and restore an AMI using Amazon S3] in the Amazon EC2 User Guide. +// +// [CreateStoreImageTask]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html +// [Store and restore an AMI using Amazon S3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html +// [Permissions for storing and restoring AMIs using Amazon S3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions func (c *Client) CreateRestoreImageTask(ctx context.Context, params *CreateRestoreImageTaskInput, optFns ...func(*Options)) (*CreateRestoreImageTaskOutput, error) { if params == nil { params = &CreateRestoreImageTaskInput{} @@ -58,7 +62,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. TagSpecifications []types.TagSpecification diff --git a/service/ec2/api_op_CreateRoute.go b/service/ec2/api_op_CreateRoute.go index fbfce5b3c9a..86d4b16a685 100644 --- a/service/ec2/api_op_CreateRoute.go +++ b/service/ec2/api_op_CreateRoute.go @@ -10,20 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a route in a route table within 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. 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 -// routes: +// Creates a route in a route table within 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. +// +// 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 routes: +// // - 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 VPC User Guide. +// specific, so we use that route to determine where to target the traffic. +// +// For more information about route tables, see [Route tables] in the Amazon VPC User Guide. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error) { if params == nil { params = &CreateRouteInput{} @@ -46,8 +52,10 @@ type CreateRouteInput struct { // This member is required. RouteTableId *string - // The ID of the carrier gateway. You can only use this option when the VPC - // contains a subnet which is associated with a Wavelength Zone. + // The ID of the carrier gateway. + // + // You can only use this option when the VPC contains a subnet which is associated + // with a Wavelength Zone. CarrierGatewayId *string // The Amazon Resource Name (ARN) of the core network. diff --git a/service/ec2/api_op_CreateRouteTable.go b/service/ec2/api_op_CreateRouteTable.go index 112caf86d88..5c52d0361b8 100644 --- a/service/ec2/api_op_CreateRouteTable.go +++ b/service/ec2/api_op_CreateRouteTable.go @@ -12,9 +12,11 @@ import ( ) // 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 VPC User Guide. +// you can add routes and associate the table with a subnet. +// +// For more information, see [Route tables] in the Amazon VPC User Guide. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) CreateRouteTable(ctx context.Context, params *CreateRouteTableInput, optFns ...func(*Options)) (*CreateRouteTableOutput, error) { if params == nil { params = &CreateRouteTableInput{} @@ -38,8 +40,9 @@ type CreateRouteTableInput struct { VpcId *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]. + // + // [Ensuring 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 diff --git a/service/ec2/api_op_CreateSecurityGroup.go b/service/ec2/api_op_CreateSecurityGroup.go index 3ae9ad01534..351849e768b 100644 --- a/service/ec2/api_op_CreateSecurityGroup.go +++ b/service/ec2/api_op_CreateSecurityGroup.go @@ -11,22 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Virtual Private Cloud User Guide. When you create a security -// group, you specify a friendly name of your choice. You can't have two security -// groups for the same VPC with the same name. You have a default security group -// for use in your VPC. If you don't specify a security group when you launch an -// 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) -// . +// 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]in the Amazon Elastic +// Compute Cloud User Guide and [Security groups for your VPC]in the Amazon Virtual Private Cloud User Guide. +// +// When you create a security group, you specify a friendly name of your choice. +// You can't have two security groups for the same VPC with the same name. +// +// You have a default security group for use in your VPC. If you don't specify a +// security group when you launch an 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]. +// +// [Amazon VPC Limits]: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html +// [Amazon EC2 security groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html +// [Security groups for your VPC]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html func (c *Client) CreateSecurityGroup(ctx context.Context, params *CreateSecurityGroupInput, optFns ...func(*Options)) (*CreateSecurityGroupOutput, error) { if params == nil { params = &CreateSecurityGroupInput{} @@ -44,15 +49,20 @@ func (c *Client) CreateSecurityGroup(ctx context.Context, params *CreateSecurity type CreateSecurityGroupInput struct { - // A description for the security group. Constraints: Up to 255 characters in - // length Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + // A description for the security group. + // + // Constraints: Up to 255 characters in length + // + // Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* // // This member is required. Description *string - // The name of the security group. Constraints: Up to 255 characters in length. - // Cannot start with sg- . Valid characters: a-z, A-Z, 0-9, spaces, and - // ._-:/()#,@[]+=&;{}!$* + // The name of the security group. + // + // Constraints: Up to 255 characters in length. Cannot start with sg- . + // + // Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* // // This member is required. GroupName *string diff --git a/service/ec2/api_op_CreateSnapshot.go b/service/ec2/api_op_CreateSnapshot.go index 1f0c1f4e414..f5d77d476a8 100644 --- a/service/ec2/api_op_CreateSnapshot.go +++ b/service/ec2/api_op_CreateSnapshot.go @@ -14,32 +14,43 @@ import ( // Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use // snapshots for backups, to make copies of EBS volumes, and to save data before -// shutting down an instance. You can create snapshots of volumes in a Region and -// volumes on an Outpost. If you create a snapshot of a volume in a Region, the -// snapshot must be stored in the same Region as the volume. If you create a -// snapshot of a volume on an Outpost, the snapshot can be stored on the same -// Outpost as the volume, or in the Region for that Outpost. When a snapshot is -// created, any Amazon Web Services Marketplace product codes that are associated -// with the source volume are propagated to the snapshot. You can take a snapshot -// of an attached volume that is in use. However, snapshots only capture data that -// has been written to your Amazon EBS volume at the time the snapshot command is -// issued; this might exclude any data that has been cached by any applications or -// the operating system. If you can pause any file systems on the volume long -// enough to take a snapshot, your snapshot should be complete. However, if you -// 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 -// 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/ebs/latest/userguide/what-is-ebs.html) -// and Amazon EBS encryption (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS User Guide. +// shutting down an instance. +// +// You can create snapshots of volumes in a Region and volumes on an Outpost. If +// you create a snapshot of a volume in a Region, the snapshot must be stored in +// the same Region as the volume. If you create a snapshot of a volume on an +// Outpost, the snapshot can be stored on the same Outpost as the volume, or in the +// Region for that Outpost. +// +// When a snapshot is created, any Amazon Web Services Marketplace product codes +// that are associated with the source volume are propagated to the snapshot. +// +// You can take a snapshot of an attached volume that is in use. However, +// snapshots only capture data that has been written to your Amazon EBS volume at +// the time the snapshot command is issued; this might exclude any data that has +// been cached by any applications or the operating system. If you can pause any +// file systems on the volume long enough to take a snapshot, your snapshot should +// be complete. However, if you 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 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] in the +// Amazon Elastic Compute Cloud User Guide. +// +// For more information, see [Amazon Elastic Block Store] and [Amazon EBS encryption] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html +// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html +// [Amazon Elastic Block Store]: https://docs.aws.amazon.com/ebs/latest/userguide/what-is-ebs.html func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} @@ -73,16 +84,21 @@ type CreateSnapshotInput struct { // 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/ebs/latest/userguide/snapshots-outposts.html#create-snapshot) - // in the Amazon EBS User Guide. + // + // For more information, see [Create local snapshots from volumes on an Outpost] in the Amazon EBS User Guide. + // + // [Create local snapshots from volumes on an Outpost]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot OutpostArn *string // The tags to apply to the snapshot during creation. @@ -99,7 +115,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. @@ -113,8 +129,9 @@ 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/ebs/latest/userguide/snapshots-outposts.html) - // in the Amazon EBS User Guide. + // see [Amazon EBS local snapshots on Outposts]in the Amazon EBS User Guide. + // + // [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html OutpostArn *string // The Amazon Web Services owner alias, from an Amazon-maintained list ( amazon ). @@ -148,8 +165,7 @@ type CreateSnapshotOutput struct { // Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy // 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 . + // you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots. StateMessage *string // The storage tier in which the snapshot is stored. standard indicates that the @@ -162,8 +178,7 @@ type CreateSnapshotOutput struct { Tags []types.Tag // The ID of the volume that was used to create the snapshot. Snapshots created by - // the CopySnapshot action have an arbitrary volume ID that should not be used for - // any purpose. + // the CopySnapshotaction have an arbitrary volume ID that should not be used for any purpose. VolumeId *string // The size of the volume, in GiB. diff --git a/service/ec2/api_op_CreateSnapshots.go b/service/ec2/api_op_CreateSnapshots.go index 2423effc513..bb0596e41f5 100644 --- a/service/ec2/api_op_CreateSnapshots.go +++ b/service/ec2/api_op_CreateSnapshots.go @@ -13,14 +13,17 @@ import ( // Creates crash-consistent snapshots of multiple EBS volumes and stores the data // in S3. Volumes are chosen by specifying an instance. Any attached volumes will -// produce one snapshot each that is crash-consistent across the instance. You can -// include all of the volumes currently attached to the instance, or you can -// exclude the root volume or specific data (non-root) volumes from the -// multi-volume snapshot set. You can create multi-volume snapshots of instances in -// a Region and instances on an Outpost. If you create snapshots from an instance -// in a Region, the snapshots must be stored in the same Region as the instance. If -// you create snapshots from an instance on an Outpost, the snapshots can be stored -// on the same Outpost as the instance, or in the Region for that Outpost. +// produce one snapshot each that is crash-consistent across the instance. +// +// You can include all of the volumes currently attached to the instance, or you +// can exclude the root volume or specific data (non-root) volumes from the +// multi-volume snapshot set. +// +// You can create multi-volume snapshots of instances in a Region and instances on +// an Outpost. If you create snapshots from an instance in a Region, the snapshots +// must be stored in the same Region as the instance. If you create snapshots from +// an instance on an Outpost, the snapshots can be stored on the same Outpost as +// the instance, or in the Region for that Outpost. func (c *Client) CreateSnapshots(ctx context.Context, params *CreateSnapshotsInput, optFns ...func(*Options)) (*CreateSnapshotsOutput, error) { if params == nil { params = &CreateSnapshotsInput{} @@ -46,7 +49,7 @@ type CreateSnapshotsInput struct { // Copies the tags from the specified volume to corresponding snapshot. CopyTagsFromSource types.CopyTagsFromSource - // A description propagated to every snapshot specified by the instance. + // A description propagated to every snapshot specified by the instance. Description *string // Checks whether you have the required permissions for the action, without @@ -57,17 +60,21 @@ type CreateSnapshotsInput struct { // 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/ebs/latest/userguide/snapshots-outposts.html#create-multivol-snapshot) - // in the Amazon EBS User Guide. + // + // For more information, see [Create multi-volume local snapshots from instances on an Outpost] in the Amazon EBS User Guide. + // + // [Create multi-volume local snapshots from instances on an Outpost]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-multivol-snapshot OutpostArn *string // Tags to apply to every snapshot specified by the instance. diff --git a/service/ec2/api_op_CreateSpotDatafeedSubscription.go b/service/ec2/api_op_CreateSpotDatafeedSubscription.go index d0e993f0f84..fd5993b88e3 100644 --- a/service/ec2/api_op_CreateSpotDatafeedSubscription.go +++ b/service/ec2/api_op_CreateSpotDatafeedSubscription.go @@ -13,8 +13,9 @@ import ( // 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. +// more information, see [Spot Instance data feed]in the Amazon EC2 User Guide for Linux Instances. +// +// [Spot Instance data feed]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html func (c *Client) CreateSpotDatafeedSubscription(ctx context.Context, params *CreateSpotDatafeedSubscriptionInput, optFns ...func(*Options)) (*CreateSpotDatafeedSubscriptionOutput, error) { if params == nil { params = &CreateSpotDatafeedSubscriptionInput{} @@ -34,8 +35,9 @@ 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) - // in the Amazon S3 Developer Guide. + // For more information about bucket names, see [Rules for bucket naming]in the Amazon S3 Developer Guide. + // + // [Rules for bucket naming]: https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules // // This member is required. Bucket *string diff --git a/service/ec2/api_op_CreateStoreImageTask.go b/service/ec2/api_op_CreateStoreImageTask.go index 3694a6382bc..3b9f484353f 100644 --- a/service/ec2/api_op_CreateStoreImageTask.go +++ b/service/ec2/api_op_CreateStoreImageTask.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Amazon EC2 User Guide. +// +// For more information, see [Store and restore an AMI using Amazon S3] in the Amazon EC2 User Guide. +// +// [Store and restore an AMI using Amazon S3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html +// [Permissions for storing and restoring AMIs using Amazon S3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions func (c *Client) CreateStoreImageTask(ctx context.Context, params *CreateStoreImageTaskInput, optFns ...func(*Options)) (*CreateStoreImageTaskOutput, error) { if params == nil { params = &CreateStoreImageTaskInput{} @@ -52,7 +55,8 @@ type CreateStoreImageTaskInput struct { // UnauthorizedOperation . DryRun *bool - // The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. + // The tags to apply to the AMI object that will be stored in the Amazon S3 + // bucket. S3ObjectTags []types.S3ObjectTag noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateSubnet.go b/service/ec2/api_op_CreateSubnet.go index 0b02049ee9b..5e52cfe3a4f 100644 --- a/service/ec2/api_op_CreateSubnet.go +++ b/service/ec2/api_op_CreateSubnet.go @@ -15,19 +15,29 @@ import ( // CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only // subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 // CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 -// CIDR block. A subnet CIDR block must not overlap the CIDR block of an existing -// subnet in the VPC. After you create a subnet, you can't change its CIDR block. +// CIDR block. +// +// A subnet CIDR block must not overlap the CIDR block of an existing subnet in +// the VPC. After you create a subnet, you can't change its CIDR block. +// // The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) // and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the // first four and the last IPv4 address in each subnet's CIDR block. They're not -// available for your use. If you've associated an IPv6 CIDR block with your VPC, -// you can associate an IPv6 CIDR block with a subnet when you create it. If you -// add more than one subnet to a VPC, they're set up in a star topology with a -// logical router in the 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 VPC User Guide. +// available for your use. +// +// If you've associated an IPv6 CIDR block with your VPC, you can associate an +// IPv6 CIDR block with a subnet when you create it. +// +// If you add more than one subnet to a VPC, they're set up in a star topology +// with a logical router in the 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] in the Amazon VPC User Guide. +// +// [Subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html func (c *Client) CreateSubnet(ctx context.Context, params *CreateSubnetInput, optFns ...func(*Options)) (*CreateSubnetOutput, error) { if params == nil { params = &CreateSubnetInput{} @@ -50,14 +60,20 @@ 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 Local Zones locations (http://aws.amazon.com/about-aws/global-infrastructure/localzones/locations/) - // . To create a subnet in an Outpost, set this value to the Availability Zone for + // 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 [Local Zones locations]. + // + // To create a subnet in an Outpost, set this value to the Availability Zone for // the Outpost and specify the Outpost ARN. + // + // [Local Zones locations]: http://aws.amazon.com/about-aws/global-infrastructure/localzones/locations/ AvailabilityZone *string // The AZ ID or the Local Zone ID of the subnet. @@ -65,8 +81,9 @@ type CreateSubnetInput struct { // 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 - // parameter is not supported for an IPv6 only subnet. + // 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 diff --git a/service/ec2/api_op_CreateSubnetCidrReservation.go b/service/ec2/api_op_CreateSubnetCidrReservation.go index 7696812e591..62b7477ba4d 100644 --- a/service/ec2/api_op_CreateSubnetCidrReservation.go +++ b/service/ec2/api_op_CreateSubnetCidrReservation.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a subnet CIDR reservation. For more information, see Subnet CIDR -// reservations (https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) -// in the Amazon Virtual Private Cloud User Guide and Assign prefixes to network -// interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) -// in the Amazon Elastic Compute Cloud User Guide. +// Creates a subnet CIDR reservation. For more information, see [Subnet CIDR reservations] in the Amazon +// Virtual Private Cloud User Guide and [Assign prefixes to network interfaces]in the Amazon Elastic Compute Cloud User +// Guide. +// +// [Subnet CIDR reservations]: https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html +// [Assign prefixes to network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html func (c *Client) CreateSubnetCidrReservation(ctx context.Context, params *CreateSubnetCidrReservationInput, optFns ...func(*Options)) (*CreateSubnetCidrReservationOutput, error) { if params == nil { params = &CreateSubnetCidrReservationInput{} @@ -40,8 +41,10 @@ type CreateSubnetCidrReservationInput struct { // The type of reservation. The reservation type determines how the reserved IP // addresses are assigned to resources. + // // - prefix - Amazon Web Services assigns the reserved IP addresses to network // interfaces. + // // - explicit - You assign the reserved IP addresses to network interfaces. // // This member is required. diff --git a/service/ec2/api_op_CreateTags.go b/service/ec2/api_op_CreateTags.go index 2d6541e6291..c1228b2653e 100644 --- a/service/ec2/api_op_CreateTags.go +++ b/service/ec2/api_op_CreateTags.go @@ -15,11 +15,15 @@ import ( // 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. +// resource. +// +// For more information about tags, see [Tag your Amazon EC2 resources] 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]in the Amazon Elastic Compute Cloud User +// Guide. +// +// [Supported resource-level permissions for Amazon EC2 API actions]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html +// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error) { if params == nil { params = &CreateTagsInput{} @@ -37,8 +41,10 @@ func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns type CreateTagsInput struct { - // The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource - // IDs. We recommend breaking up this request into smaller batches. + // The IDs of the resources, separated by spaces. + // + // Constraints: Up to 1000 resource IDs. We recommend breaking up this request + // into smaller batches. // // This member is required. Resources []string diff --git a/service/ec2/api_op_CreateTrafficMirrorFilter.go b/service/ec2/api_op_CreateTrafficMirrorFilter.go index a48e078d923..46317c25a12 100644 --- a/service/ec2/api_op_CreateTrafficMirrorFilter.go +++ b/service/ec2/api_op_CreateTrafficMirrorFilter.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// to mirror supported network services. +// 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] to add Traffic +// Mirror rules to the filter. The rules you add define what traffic gets mirrored. +// You can also use [ModifyTrafficMirrorFilterNetworkServices]to mirror supported network services. +// +// [CreateTrafficMirrorFilterRule]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm +// [ModifyTrafficMirrorFilterNetworkServices]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html func (c *Client) CreateTrafficMirrorFilter(ctx context.Context, params *CreateTrafficMirrorFilterInput, optFns ...func(*Options)) (*CreateTrafficMirrorFilterOutput, error) { if params == nil { params = &CreateTrafficMirrorFilterInput{} @@ -35,8 +39,9 @@ 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]. + // + // [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. @@ -57,8 +62,9 @@ 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]. + // + // [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 2e338061c2e..a07fa8b3758 100644 --- a/service/ec2/api_op_CreateTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_CreateTrafficMirrorFilterRule.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Traffic Mirror filter rule. A Traffic Mirror rule defines the Traffic -// Mirror source traffic to mirror. You need the Traffic Mirror filter ID when you -// create the rule. +// Creates a Traffic Mirror filter rule. +// +// A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror. +// +// You need the Traffic Mirror filter ID when you create the rule. func (c *Client) CreateTrafficMirrorFilterRule(ctx context.Context, params *CreateTrafficMirrorFilterRuleInput, optFns ...func(*Options)) (*CreateTrafficMirrorFilterRuleOutput, error) { if params == nil { params = &CreateTrafficMirrorFilterRuleInput{} @@ -64,8 +66,9 @@ 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]. + // + // [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. @@ -80,9 +83,12 @@ type CreateTrafficMirrorFilterRuleInput struct { // 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. + // The protocol, for example UDP, to assign to the Traffic Mirror rule. + // + // For information about the protocol value, see [Protocol Numbers] on the Internet Assigned Numbers + // Authority (IANA) website. + // + // [Protocol Numbers]: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml Protocol *int32 // The source port range. @@ -94,8 +100,9 @@ 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]. + // + // [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 63803ec2257..952471569ae 100644 --- a/service/ec2/api_op_CreateTrafficMirrorSession.go +++ b/service/ec2/api_op_CreateTrafficMirrorSession.go @@ -11,14 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Traffic Mirror session. A Traffic Mirror session actively copies -// packets from a Traffic Mirror source to a Traffic Mirror target. Create a -// filter, and then assign it to the session to define a subset of the traffic to -// 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) -// to create filter rules that specify the traffic to mirror. +// Creates a Traffic Mirror session. +// +// A Traffic Mirror session actively copies packets from a Traffic Mirror source +// to a Traffic Mirror target. Create a filter, and then assign it to the session +// to define a subset of the traffic to 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] to create filter rules that specify +// the traffic to mirror. +// +// [CreateTrafficMirrorFilter]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.htm func (c *Client) CreateTrafficMirrorSession(ctx context.Context, params *CreateTrafficMirrorSessionInput, optFns ...func(*Options)) (*CreateTrafficMirrorSessionOutput, error) { if params == nil { params = &CreateTrafficMirrorSessionInput{} @@ -43,7 +49,9 @@ type CreateTrafficMirrorSessionInput struct { // The session number determines the order in which sessions are evaluated when an // interface is used by multiple sessions. The first session with a matching filter - // is the one that mirrors the packets. Valid values are 1-32766. + // is the one that mirrors the packets. + // + // Valid values are 1-32766. // // This member is required. SessionNumber *int32 @@ -59,8 +67,9 @@ 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]. + // + // [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. @@ -76,20 +85,24 @@ type CreateTrafficMirrorSessionInput struct { // header. Do not specify this parameter when you want to mirror the entire packet. // To mirror a subset of the packet, set this to the length (in bytes) that you // want to mirror. For example, if you set this value to 100, then the first 100 - // bytes that meet the filter criteria are copied to the target. If you do not want - // to mirror the entire packet, use the PacketLength parameter to specify the - // number of bytes in each packet to mirror. For sessions with Network Load - // Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to - // 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will - // result in an error response. + // bytes that meet the filter criteria are copied to the target. + // + // If you do not want to mirror the entire packet, use the PacketLength parameter + // to specify the number of bytes in each packet to mirror. + // + // For sessions with Network Load Balancer (NLB) Traffic Mirror targets the + // default PacketLength will be set to 8500. Valid values are 1-8500. Setting a + // PacketLength greater than 8500 will result in an error response. PacketLength *int32 // The tags to assign to a Traffic Mirror session. 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]. If you do not specify a VirtualNetworkId , an account-wide + // unique id is chosen at random. + // + // [RFC 7348]: https://tools.ietf.org/html/rfc7348 VirtualNetworkId *int32 noSmithyDocumentSerde @@ -98,8 +111,9 @@ 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]. + // + // [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 2df3740af39..c1b5166e1c1 100644 --- a/service/ec2/api_op_CreateTrafficMirrorTarget.go +++ b/service/ec2/api_op_CreateTrafficMirrorTarget.go @@ -11,14 +11,19 @@ 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 -// 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) -// . +// 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]. +// +// [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{} @@ -37,8 +42,9 @@ 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]. + // + // [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. @@ -69,8 +75,9 @@ 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]. + // + // [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 ee5add3cbaa..247416e9208 100644 --- a/service/ec2/api_op_CreateTransitGateway.go +++ b/service/ec2/api_op_CreateTransitGateway.go @@ -11,22 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// 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 +// 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 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 default transit gateway route +// table and use it as the default association route table and the default +// propagation route table. You can use CreateTransitGatewayRouteTableto create additional transit gateway route // tables. If you disable automatic route propagation, we do not create a default -// transit gateway route table. You can use -// EnableTransitGatewayRouteTablePropagation to propagate routes from a resource +// transit gateway route table. You can use EnableTransitGatewayRouteTablePropagationto propagate routes from a resource // attachment to a transit gateway route table. If you disable automatic -// associations, you can use AssociateTransitGatewayRouteTable to associate a -// resource attachment with a transit gateway route table. +// associations, you can use AssociateTransitGatewayRouteTableto associate a resource attachment with a transit +// gateway route table. func (c *Client) CreateTransitGateway(ctx context.Context, params *CreateTransitGatewayInput, optFns ...func(*Options)) (*CreateTransitGatewayOutput, error) { if params == nil { params = &CreateTransitGatewayInput{} diff --git a/service/ec2/api_op_CreateTransitGatewayConnect.go b/service/ec2/api_op_CreateTransitGatewayConnect.go index b5f03bb2fa1..f077da79092 100644 --- a/service/ec2/api_op_CreateTransitGatewayConnect.go +++ b/service/ec2/api_op_CreateTransitGatewayConnect.go @@ -13,9 +13,10 @@ import ( // Creates a Connect attachment from a specified transit gateway attachment. A // Connect attachment is a GRE-based tunnel attachment that you can use to -// establish a connection between a transit gateway and an appliance. A Connect -// attachment uses an existing VPC or Amazon Web Services Direct Connect attachment -// as the underlying transport mechanism. +// establish a connection between a transit gateway and an appliance. +// +// A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect +// attachment as the underlying transport mechanism. func (c *Client) CreateTransitGatewayConnect(ctx context.Context, params *CreateTransitGatewayConnectInput, optFns ...func(*Options)) (*CreateTransitGatewayConnectOutput, error) { if params == nil { params = &CreateTransitGatewayConnectInput{} diff --git a/service/ec2/api_op_CreateTransitGatewayConnectPeer.go b/service/ec2/api_op_CreateTransitGatewayConnectPeer.go index ecdcc570c4c..687aafa804d 100644 --- a/service/ec2/api_op_CreateTransitGatewayConnectPeer.go +++ b/service/ec2/api_op_CreateTransitGatewayConnectPeer.go @@ -12,10 +12,14 @@ 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) -// in the Transit Gateways Guide. +// 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] in the Transit Gateways Guide. +// +// [Connect peers]: https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer func (c *Client) CreateTransitGatewayConnectPeer(ctx context.Context, params *CreateTransitGatewayConnectPeerInput, optFns ...func(*Options)) (*CreateTransitGatewayConnectPeerOutput, error) { if params == nil { params = &CreateTransitGatewayConnectPeerInput{} diff --git a/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go b/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go index 03e285c587c..d53e9e10d5a 100644 --- a/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go +++ b/service/ec2/api_op_CreateTransitGatewayMulticastDomain.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// to see the state of transit gateway. +// 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]to see the state of transit gateway. +// +// [DescribeTransitGateways]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html func (c *Client) CreateTransitGatewayMulticastDomain(ctx context.Context, params *CreateTransitGatewayMulticastDomainInput, optFns ...func(*Options)) (*CreateTransitGatewayMulticastDomainOutput, error) { if params == nil { params = &CreateTransitGatewayMulticastDomainInput{} diff --git a/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go b/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go index c8565a9b4db..35099ef0ff0 100644 --- a/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go +++ b/service/ec2/api_op_CreateTransitGatewayPeeringAttachment.go @@ -13,9 +13,10 @@ import ( // Requests a transit gateway peering attachment between the specified transit // gateway (requester) and a peer transit gateway (accepter). The peer transit -// gateway can be in your account or a different Amazon Web Services account. After -// you create the peering attachment, the owner of the accepter transit gateway -// must accept the attachment request. +// gateway can be in your account or a different Amazon Web Services account. +// +// After you create the peering attachment, the owner of the accepter transit +// gateway must accept the attachment request. func (c *Client) CreateTransitGatewayPeeringAttachment(ctx context.Context, params *CreateTransitGatewayPeeringAttachmentInput, optFns ...func(*Options)) (*CreateTransitGatewayPeeringAttachmentOutput, error) { if params == nil { params = &CreateTransitGatewayPeeringAttachmentInput{} diff --git a/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go b/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go index a5bc045d0ce..45f670e189c 100644 --- a/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_CreateTransitGatewayVpcAttachment.go @@ -11,11 +11,14 @@ 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 -// 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 . +// 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. func (c *Client) CreateTransitGatewayVpcAttachment(ctx context.Context, params *CreateTransitGatewayVpcAttachmentInput, optFns ...func(*Options)) (*CreateTransitGatewayVpcAttachmentOutput, error) { if params == nil { params = &CreateTransitGatewayVpcAttachmentInput{} diff --git a/service/ec2/api_op_CreateVerifiedAccessEndpoint.go b/service/ec2/api_op_CreateVerifiedAccessEndpoint.go index 9f20f5751b1..3e927a76627 100644 --- a/service/ec2/api_op_CreateVerifiedAccessEndpoint.go +++ b/service/ec2/api_op_CreateVerifiedAccessEndpoint.go @@ -64,8 +64,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access endpoint. diff --git a/service/ec2/api_op_CreateVerifiedAccessGroup.go b/service/ec2/api_op_CreateVerifiedAccessGroup.go index b9ed06238f9..5fc32132d8c 100644 --- a/service/ec2/api_op_CreateVerifiedAccessGroup.go +++ b/service/ec2/api_op_CreateVerifiedAccessGroup.go @@ -40,8 +40,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access group. diff --git a/service/ec2/api_op_CreateVerifiedAccessInstance.go b/service/ec2/api_op_CreateVerifiedAccessInstance.go index 679af5b0eaa..4abefe4cf32 100644 --- a/service/ec2/api_op_CreateVerifiedAccessInstance.go +++ b/service/ec2/api_op_CreateVerifiedAccessInstance.go @@ -32,8 +32,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access instance. diff --git a/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go b/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go index 5424e51a970..f36dae540ac 100644 --- a/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_CreateVerifiedAccessTrustProvider.go @@ -43,8 +43,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access trust provider. diff --git a/service/ec2/api_op_CreateVolume.go b/service/ec2/api_op_CreateVolume.go index ca8bb2a63ad..06f5dbe4b55 100644 --- a/service/ec2/api_op_CreateVolume.go +++ b/service/ec2/api_op_CreateVolume.go @@ -13,17 +13,25 @@ import ( ) // Creates an EBS volume that can be attached to an instance in the same -// Availability Zone. You can create a new empty volume or restore a volume from an -// EBS snapshot. Any Amazon Web Services Marketplace product codes from the -// 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS 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/ebs/latest/userguide/ebs-creating-volume.html) +// Availability Zone. +// +// You can create a new empty volume or restore a volume from an EBS snapshot. Any +// Amazon Web Services Marketplace product codes from the 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] // in the Amazon EBS User Guide. +// +// You can tag your volumes during creation. For more information, see [Tag your Amazon EC2 resources] in the +// Amazon Elastic Compute Cloud User Guide. +// +// For more information, see [Create an Amazon EBS volume] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html +// [Create an Amazon EBS volume]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-creating-volume.html +// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html func (c *Client) CreateVolume(ctx context.Context, params *CreateVolumeInput, optFns ...func(*Options)) (*CreateVolumeOutput, error) { if params == nil { params = &CreateVolumeInput{} @@ -48,8 +56,9 @@ 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]. + // + // [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 @@ -61,50 +70,66 @@ type CreateVolumeInput struct { // 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/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) - // in the Amazon EBS 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/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) - // . + // enabled. For more information, see [Encryption by default]in the Amazon EBS User Guide. + // + // Encrypted Amazon EBS volumes must be attached to instances that support Amazon + // EBS encryption. For more information, see [Supported instance types]. + // + // [Supported instance types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances + // [Encryption by default]: https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default 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: + // 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 - 256,000 IOPS - // For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the - // Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) - // . On other instances, you can achieve 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 + // + // For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances, + // you can achieve 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. + // + // [instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances 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 - // specify the KMS key using any of the following: + // 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. 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) - // 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/ebs/latest/userguide/ebs-volumes-multi.html) - // in the Amazon EBS User Guide. + // Multi-Attach, you can attach the volume to up to 16 [Instances built on the Nitro System]in the same Availability + // Zone. This parameter is supported with io1 and io2 volumes only. For more + // information, see [Amazon EBS Multi-Attach]in the Amazon EBS User Guide. + // + // [Instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances + // [Amazon EBS Multi-Attach]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html MultiAttachEnabled *bool // The Amazon Resource Name (ARN) of the Outpost. @@ -112,12 +137,18 @@ type CreateVolumeInput struct { // The size of the volume, in GiBs. You must specify either a snapshot ID or a // 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: + // 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 GiB + // // - io1 : 4 - 16,384 GiB + // // - io2 : 4 - 65,536 GiB + // // - st1 and sc1 : 125 - 16,384 GiB + // // - standard : 1 - 1024 GiB Size *int32 @@ -128,20 +159,33 @@ type CreateVolumeInput struct { // The tags to apply to the volume during creation. TagSpecifications []types.TagSpecification - // The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This - // parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. - // Maximum value of 1000. + // The throughput to provision for a volume, with a maximum of 1,000 MiB/s. + // + // This parameter is valid only for gp3 volumes. + // + // Valid Range: Minimum value of 125. Maximum value of 1000. 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/ebs/latest/userguide/ebs-volume-types.html) - // in the Amazon EBS User Guide. Default: gp2 + // boot volumes. + // + // For more information, see [Amazon EBS volume types] in the Amazon EBS User Guide. + // + // Default: gp2 + // + // [Amazon EBS volume types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html VolumeType types.VolumeType noSmithyDocumentSerde @@ -150,8 +194,9 @@ type CreateVolumeInput struct { // Describes a volume. type CreateVolumeOutput struct { - // This parameter is not returned by CreateVolume. Information about the volume - // attachments. + // This parameter is not returned by CreateVolume. + // + // Information about the volume attachments. Attachments []types.VolumeAttachment // The Availability Zone for the volume. @@ -163,8 +208,9 @@ type CreateVolumeOutput struct { // Indicates whether the volume is encrypted. Encrypted *bool - // This parameter is not returned by CreateVolume. Indicates whether the volume - // was created using fast snapshot restore. + // This parameter is not returned by CreateVolume. + // + // 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 @@ -189,7 +235,9 @@ type CreateVolumeOutput struct { // The snapshot from which the volume was created, if applicable. SnapshotId *string - // This parameter is not returned by CreateVolume. Reserved for future use. + // This parameter is not returned by CreateVolume. + // + // Reserved for future use. SseType types.SSEType // The volume state. diff --git a/service/ec2/api_op_CreateVpc.go b/service/ec2/api_op_CreateVpc.go index dd27cd3c581..149858d762d 100644 --- a/service/ec2/api_op_CreateVpc.go +++ b/service/ec2/api_op_CreateVpc.go @@ -11,19 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a VPC with the specified CIDR blocks. For more information, see IP -// addressing for your VPCs and subnets (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html) -// in the Amazon VPC 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 +// Creates a VPC with the specified CIDR blocks. For more information, see [IP addressing for your VPCs and subnets] in the +// Amazon VPC 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] ). +// +// 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 VPC 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 EC2 User Guide. +// (AmazonProvidedDNS). For more information, see [DHCP option sets]in the Amazon VPC 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]in the Amazon EC2 User Guide. +// +// [BYOIP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html +// [Dedicated Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html +// [DHCP option sets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html +// [IP addressing for your VPCs and subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html func (c *Client) CreateVpc(ctx context.Context, params *CreateVpcInput, optFns ...func(*Options)) (*CreateVpcOutput, error) { if params == nil { params = &CreateVpcInput{} @@ -61,44 +68,54 @@ type CreateVpcInput struct { // 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 // 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 - // only. Default: default + // 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 only. + // + // Default: default 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?]in the Amazon VPC IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html Ipv4IpamPoolId *string // The netmask length of the IPv4 CIDR you want to allocate to this VPC 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) + // Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?] // in the Amazon VPC IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html Ipv4NetmaskLength *int32 // The 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. + // 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 address to this location. You must set - // AmazonProvidedIpv6CidrBlock to true to use this parameter. + // parameter to limit the address to this location. + // + // You must set AmazonProvidedIpv6CidrBlock to true to use this parameter. Ipv6CidrBlockNetworkBorderGroup *string // The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 // 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?]in the Amazon + // VPC IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html Ipv6IpamPoolId *string // The netmask length of the IPv6 CIDR you want to allocate to this VPC 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) + // Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?] // in the Amazon VPC IPAM User Guide. + // + // [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html Ipv6NetmaskLength *int32 // The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. diff --git a/service/ec2/api_op_CreateVpcEndpoint.go b/service/ec2/api_op_CreateVpcEndpoint.go index cd7e6693061..08b74493009 100644 --- a/service/ec2/api_op_CreateVpcEndpoint.go +++ b/service/ec2/api_op_CreateVpcEndpoint.go @@ -14,9 +14,9 @@ import ( // Creates a VPC endpoint. A VPC endpoint provides a private connection between // the specified VPC and the specified endpoint service. You can use an endpoint // service 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 User Guide (https://docs.aws.amazon.com/vpc/latest/privatelink/) -// . +// Partner, or another Amazon Web Services account. For more information, see the [Amazon Web Services PrivateLink User Guide]. +// +// [Amazon Web Services PrivateLink User 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,9 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The DNS options for the endpoint. @@ -73,9 +74,11 @@ type CreateVpcEndpointInput struct { // 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. + // 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 PrivateDnsEnabled *bool @@ -98,7 +101,9 @@ type CreateVpcEndpointInput struct { // The tags to associate with the endpoint. TagSpecifications []types.TagSpecification - // The type of endpoint. Default: Gateway + // The type of endpoint. + // + // Default: Gateway VpcEndpointType types.VpcEndpointType noSmithyDocumentSerde diff --git a/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go b/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go index b51a736cbf3..2b982712785 100644 --- a/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go +++ b/service/ec2/api_op_CreateVpcEndpointConnectionNotification.go @@ -13,10 +13,12 @@ import ( // Creates a connection notification for a specified VPC endpoint or VPC endpoint // service. A connection notification notifies you of specific endpoint events. You -// must create an SNS topic to receive notifications. For more information, see -// Create a Topic (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) in -// the Amazon Simple Notification Service Developer Guide. You can create a -// connection notification for interface endpoints only. +// must create an SNS topic to receive notifications. For more information, see [Create a Topic]in +// the Amazon Simple Notification Service Developer Guide. +// +// You can create a connection notification for interface endpoints only. +// +// [Create a Topic]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html func (c *Client) CreateVpcEndpointConnectionNotification(ctx context.Context, params *CreateVpcEndpointConnectionNotificationInput, optFns ...func(*Options)) (*CreateVpcEndpointConnectionNotificationOutput, error) { if params == nil { params = &CreateVpcEndpointConnectionNotificationInput{} @@ -46,8 +48,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go b/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go index 0db5837b7c4..c08679411b9 100644 --- a/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go +++ b/service/ec2/api_op_CreateVpcEndpointServiceConfiguration.go @@ -12,17 +12,24 @@ 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 +// 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]. Service consumers connect to your service using an interface endpoint. +// +// - A [Gateway Load Balancer]. 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/) -// . +// domain name. +// +// For more information, see the [Amazon Web Services PrivateLink Guide]. +// +// [Gateway Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/ +// [Network Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/ +// [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{} @@ -45,8 +52,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_CreateVpcPeeringConnection.go b/service/ec2/api_op_CreateVpcPeeringConnection.go index bc14ea00060..6277cbf3ab4 100644 --- a/service/ec2/api_op_CreateVpcPeeringConnection.go +++ b/service/ec2/api_op_CreateVpcPeeringConnection.go @@ -15,13 +15,19 @@ import ( // 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 . +// overlapping CIDR blocks. +// +// Limitations and rules apply to a VPC peering connection. For more information, +// see the [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 . +// +// [limitations]: https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations func (c *Client) CreateVpcPeeringConnection(ctx context.Context, params *CreateVpcPeeringConnectionInput, optFns ...func(*Options)) (*CreateVpcPeeringConnectionOutput, error) { if params == nil { params = &CreateVpcPeeringConnectionInput{} @@ -50,13 +56,15 @@ type CreateVpcPeeringConnectionInput struct { // UnauthorizedOperation . DryRun *bool - // The Amazon Web Services account ID of the owner of the accepter VPC. Default: - // Your Amazon Web Services account ID + // 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. + // 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 5286399c5a3..6438a89963f 100644 --- a/service/ec2/api_op_CreateVpnConnection.go +++ b/service/ec2/api_op_CreateVpnConnection.go @@ -12,17 +12,26 @@ 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 -// 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 -// cryptographic information for configuring your customer gateway device. If you -// decide to shut down your VPN connection for any reason and later create a new -// 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. +// 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 cryptographic information for configuring your +// customer gateway device. +// +// If you decide to shut down your VPN connection for any reason and later create +// a new 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] 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 func (c *Client) CreateVpnConnection(ctx context.Context, params *CreateVpnConnectionInput, optFns ...func(*Options)) (*CreateVpnConnectionOutput, error) { if params == nil { params = &CreateVpnConnectionInput{} diff --git a/service/ec2/api_op_CreateVpnConnectionRoute.go b/service/ec2/api_op_CreateVpnConnectionRoute.go index 9f93fc700a5..7e33080c2c5 100644 --- a/service/ec2/api_op_CreateVpnConnectionRoute.go +++ b/service/ec2/api_op_CreateVpnConnectionRoute.go @@ -13,8 +13,12 @@ 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] 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 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 54ee239282f..5d81583611c 100644 --- a/service/ec2/api_op_CreateVpnGateway.go +++ b/service/ec2/api_op_CreateVpnGateway.go @@ -13,9 +13,12 @@ import ( // Creates a virtual private gateway. A virtual private gateway is the endpoint on // the VPC side of your VPN connection. You can create a virtual private gateway -// before creating the VPC itself. 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. +// before creating the VPC itself. +// +// For more information, see [Amazon Web Services Site-to-Site VPN] 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 func (c *Client) CreateVpnGateway(ctx context.Context, params *CreateVpnGatewayInput, optFns ...func(*Options)) (*CreateVpnGatewayOutput, error) { if params == nil { params = &CreateVpnGatewayInput{} @@ -41,8 +44,9 @@ type CreateVpnGatewayInput struct { // A private Autonomous System Number (ASN) for the Amazon side of a BGP session. // If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're - // using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range. Default: - // 64512 + // using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range. + // + // Default: 64512 AmazonSideAsn *int64 // The Availability Zone for the virtual private gateway. diff --git a/service/ec2/api_op_DeleteCarrierGateway.go b/service/ec2/api_op_DeleteCarrierGateway.go index bc0cb92b9f4..2384f37e3f1 100644 --- a/service/ec2/api_op_DeleteCarrierGateway.go +++ b/service/ec2/api_op_DeleteCarrierGateway.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} diff --git a/service/ec2/api_op_DeleteCoipCidr.go b/service/ec2/api_op_DeleteCoipCidr.go index cb4378c04d7..84b1b53752e 100644 --- a/service/ec2/api_op_DeleteCoipCidr.go +++ b/service/ec2/api_op_DeleteCoipCidr.go @@ -29,12 +29,12 @@ func (c *Client) DeleteCoipCidr(ctx context.Context, params *DeleteCoipCidrInput type DeleteCoipCidrInput struct { - // A customer-owned IP address range that you want to delete. + // A customer-owned IP address range that you want to delete. // // This member is required. Cidr *string - // The ID of the customer-owned address pool. + // The ID of the customer-owned address pool. // // This member is required. CoipPoolId *string @@ -50,7 +50,7 @@ type DeleteCoipCidrInput struct { type DeleteCoipCidrOutput struct { - // Information about a range of customer-owned IP addresses. + // Information about a range of customer-owned IP addresses. CoipCidr *types.CoipCidr // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_DeleteFleets.go b/service/ec2/api_op_DeleteFleets.go index b42b5f6ee56..cf49c2cf4f0 100644 --- a/service/ec2/api_op_DeleteFleets.go +++ b/service/ec2/api_op_DeleteFleets.go @@ -11,25 +11,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified EC2 Fleets. After you delete an EC2 Fleet, it launches no -// new instances. You must also specify whether a deleted EC2 Fleet should -// terminate its instances. If you choose to terminate the instances, the EC2 Fleet -// enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the -// deleted_running state, and the instances continue to run until they are -// interrupted or you terminate them manually. For instant fleets, EC2 Fleet must -// terminate the instances when the fleet is deleted. Up to 1000 instances can be -// terminated in a single request to delete instant fleets. A deleted instant -// fleet with running instances is not supported. Restrictions +// Deletes the specified EC2 Fleets. +// +// After you delete an EC2 Fleet, it launches no new instances. +// +// You must also specify whether a deleted EC2 Fleet should terminate its +// instances. If you choose to terminate the instances, the EC2 Fleet enters the +// deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running +// state, and the instances continue to run until they are interrupted or you +// terminate them manually. +// +// For instant fleets, EC2 Fleet must terminate the instances when the fleet is +// deleted. Up to 1000 instances can be terminated in a single request to delete +// instant fleets. A deleted instant fleet with running instances is not supported. +// +// Restrictions +// // - You can delete up to 25 fleets of type instant in a single request. +// // - You can delete up to 100 fleets of type maintain or request in a single // request. +// // - You can delete up to 125 fleets in a single request, provided you do not // exceed the quota for each fleet type, as specified above. +// // - If you exceed the specified number of fleets to delete, no fleets are // deleted. // -// 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. +// For more information, see [Delete an EC2 Fleet] in the Amazon EC2 User Guide. +// +// [Delete an EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet func (c *Client) DeleteFleets(ctx context.Context, params *DeleteFleetsInput, optFns ...func(*Options)) (*DeleteFleetsOutput, error) { if params == nil { params = &DeleteFleetsInput{} @@ -47,18 +58,22 @@ func (c *Client) DeleteFleets(ctx context.Context, params *DeleteFleetsInput, op type DeleteFleetsInput struct { - // The IDs of the EC2 Fleets. Constraints: In a single request, you can specify up - // to 25 instant fleet IDs and up to 100 maintain or request fleet IDs. + // The IDs of the EC2 Fleets. + // + // Constraints: In a single request, you can specify up to 25 instant fleet IDs + // and up to 100 maintain or request fleet IDs. // // This member is required. FleetIds []string // 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 - // instances is not supported. + // 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 instances is not supported. // // This member is required. TerminateInstances *bool diff --git a/service/ec2/api_op_DeleteFlowLogs.go b/service/ec2/api_op_DeleteFlowLogs.go index c18f837d69e..a4be80d625a 100644 --- a/service/ec2/api_op_DeleteFlowLogs.go +++ b/service/ec2/api_op_DeleteFlowLogs.go @@ -29,7 +29,9 @@ func (c *Client) DeleteFlowLogs(ctx context.Context, params *DeleteFlowLogsInput type DeleteFlowLogsInput struct { - // One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. + // One or more flow log IDs. + // + // Constraint: Maximum of 1000 flow log IDs. // // This member is required. FlowLogIds []string diff --git a/service/ec2/api_op_DeleteInstanceEventWindow.go b/service/ec2/api_op_DeleteInstanceEventWindow.go index 3a3ac1109a7..177d4dfa125 100644 --- a/service/ec2/api_op_DeleteInstanceEventWindow.go +++ b/service/ec2/api_op_DeleteInstanceEventWindow.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Deletes the specified event window. +// +// For more information, see [Define event windows for scheduled events] in the Amazon EC2 User Guide. +// +// [Define event windows for scheduled events]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html func (c *Client) DeleteInstanceEventWindow(ctx context.Context, params *DeleteInstanceEventWindowInput, optFns ...func(*Options)) (*DeleteInstanceEventWindowOutput, error) { if params == nil { params = &DeleteInstanceEventWindowInput{} diff --git a/service/ec2/api_op_DeleteIpam.go b/service/ec2/api_op_DeleteIpam.go index de4e000f2f3..b8aef8363ee 100644 --- a/service/ec2/api_op_DeleteIpam.go +++ b/service/ec2/api_op_DeleteIpam.go @@ -12,9 +12,11 @@ import ( ) // Delete an IPAM. Deleting an IPAM removes all monitored data associated with the -// IPAM including the historical data for CIDRs. For more information, see Delete -// an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html) in the -// Amazon VPC IPAM User Guide. +// IPAM including the historical data for CIDRs. +// +// For more information, see [Delete an IPAM] in the Amazon VPC IPAM User Guide. +// +// [Delete an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html func (c *Client) DeleteIpam(ctx context.Context, params *DeleteIpamInput, optFns ...func(*Options)) (*DeleteIpamOutput, error) { if params == nil { params = &DeleteIpamInput{} @@ -41,13 +43,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. + // 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 diff --git a/service/ec2/api_op_DeleteIpamPool.go b/service/ec2/api_op_DeleteIpamPool.go index e645e9f604b..ed514ed6bc9 100644 --- a/service/ec2/api_op_DeleteIpamPool.go +++ b/service/ec2/api_op_DeleteIpamPool.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]. To deprovision pool CIDRs, see [DeprovisionIpamPoolCidr] +// . +// +// For more information, see [Delete a pool] in the Amazon VPC IPAM User Guide. +// +// [ReleaseIpamPoolAllocation]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html +// [Delete a pool]: https://docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html +// [DeprovisionIpamPoolCidr]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html func (c *Client) DeleteIpamPool(ctx context.Context, params *DeleteIpamPoolInput, optFns ...func(*Options)) (*DeleteIpamPoolOutput, error) { if params == nil { params = &DeleteIpamPoolInput{} @@ -40,10 +45,11 @@ type DeleteIpamPoolInput struct { IpamPoolId *string // Enables you to quickly delete an IPAM pool and all resources within that pool, - // including provisioned CIDRs, allocations, and other pools. You can only use this - // option to delete pools in the private scope or pools in the public scope with a - // source resource. A source resource is a resource used to provision CIDRs to a - // resource planning pool. + // including provisioned CIDRs, allocations, and other pools. + // + // You can only use this option to delete pools in the private scope or pools in + // the public scope with a source resource. A source resource is a resource used to + // provision CIDRs to a resource planning pool. Cascade *bool // A check for whether you have the required permissions for the action without diff --git a/service/ec2/api_op_DeleteIpamScope.go b/service/ec2/api_op_DeleteIpamScope.go index f05e4bcff87..b8b31903902 100644 --- a/service/ec2/api_op_DeleteIpamScope.go +++ b/service/ec2/api_op_DeleteIpamScope.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Delete the scope for an IPAM. You cannot delete the default scopes. +// +// For more information, see [Delete a scope] in the Amazon VPC IPAM User Guide. +// +// [Delete a scope]: https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html func (c *Client) DeleteIpamScope(ctx context.Context, params *DeleteIpamScopeInput, optFns ...func(*Options)) (*DeleteIpamScopeOutput, error) { if params == nil { params = &DeleteIpamScopeInput{} diff --git a/service/ec2/api_op_DeleteLaunchTemplate.go b/service/ec2/api_op_DeleteLaunchTemplate.go index 4895821faaa..aceedf034a5 100644 --- a/service/ec2/api_op_DeleteLaunchTemplate.go +++ b/service/ec2/api_op_DeleteLaunchTemplate.go @@ -36,12 +36,16 @@ type DeleteLaunchTemplateInput struct { // UnauthorizedOperation . DryRun *bool - // The ID of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The ID of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateId *string - // The name of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The name of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateName *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLaunchTemplateVersions.go b/service/ec2/api_op_DeleteLaunchTemplateVersions.go index b6d42b27a33..62e3efeb0bd 100644 --- a/service/ec2/api_op_DeleteLaunchTemplateVersions.go +++ b/service/ec2/api_op_DeleteLaunchTemplateVersions.go @@ -11,15 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes one or more versions of a launch template. You can't 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 . You can -// delete up to 200 launch template versions in a single request. To delete more -// than 200 versions in a single request, use DeleteLaunchTemplate , which deletes -// the launch template and all of its versions. For more information, see Delete a -// launch template version (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-launch-template-versions.html#delete-launch-template-version) -// in the EC2 User Guide. +// Deletes one or more versions of a launch template. +// +// You can't 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. +// +// You can delete up to 200 launch template versions in a single request. To +// delete more than 200 versions in a single request, use DeleteLaunchTemplate, which deletes the +// launch template and all of its versions. +// +// For more information, see [Delete a launch template version] in the EC2 User Guide. +// +// [Delete a launch template version]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-launch-template-versions.html#delete-launch-template-version func (c *Client) DeleteLaunchTemplateVersions(ctx context.Context, params *DeleteLaunchTemplateVersionsInput, optFns ...func(*Options)) (*DeleteLaunchTemplateVersionsOutput, error) { if params == nil { params = &DeleteLaunchTemplateVersionsInput{} @@ -49,12 +54,16 @@ type DeleteLaunchTemplateVersionsInput struct { // UnauthorizedOperation . DryRun *bool - // The ID of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The ID of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateId *string - // The name of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The name of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateName *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteLocalGatewayRoute.go b/service/ec2/api_op_DeleteLocalGatewayRoute.go index 0593dcea8d5..a67847fc19b 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRoute.go +++ b/service/ec2/api_op_DeleteLocalGatewayRoute.go @@ -37,7 +37,7 @@ 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 diff --git a/service/ec2/api_op_DeleteLocalGatewayRouteTable.go b/service/ec2/api_op_DeleteLocalGatewayRouteTable.go index d17e253b033..ece2bcdd1ad 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRouteTable.go +++ b/service/ec2/api_op_DeleteLocalGatewayRouteTable.go @@ -29,7 +29,7 @@ func (c *Client) DeleteLocalGatewayRouteTable(ctx context.Context, params *Delet type DeleteLocalGatewayRouteTableInput struct { - // The ID of the local gateway route table. + // The ID of the local gateway route table. // // This member is required. LocalGatewayRouteTableId *string diff --git a/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go b/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go index 1b1833bb493..bcd2700bec5 100644 --- a/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go +++ b/service/ec2/api_op_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.go @@ -29,7 +29,7 @@ func (c *Client) DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation(ct type DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationInput struct { - // The ID of the local gateway route table virtual interface group association. + // The ID of the local gateway route table virtual interface group association. // // This member is required. LocalGatewayRouteTableVirtualInterfaceGroupAssociationId *string diff --git a/service/ec2/api_op_DeletePlacementGroup.go b/service/ec2/api_op_DeletePlacementGroup.go index 145a431d0f5..ba34b11df38 100644 --- a/service/ec2/api_op_DeletePlacementGroup.go +++ b/service/ec2/api_op_DeletePlacementGroup.go @@ -12,8 +12,9 @@ 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]in the Amazon EC2 User Guide. +// +// [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html func (c *Client) DeletePlacementGroup(ctx context.Context, params *DeletePlacementGroupInput, optFns ...func(*Options)) (*DeletePlacementGroupOutput, error) { if params == nil { params = &DeletePlacementGroupInput{} diff --git a/service/ec2/api_op_DeleteSecurityGroup.go b/service/ec2/api_op_DeleteSecurityGroup.go index 68c894ce611..b016646d136 100644 --- a/service/ec2/api_op_DeleteSecurityGroup.go +++ b/service/ec2/api_op_DeleteSecurityGroup.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a security group. If you attempt to delete a security group that is -// associated with an instance or network interface or is referenced by another -// security group, the operation fails with DependencyViolation . +// Deletes a security group. +// +// If you attempt to delete a security group that is associated with an instance +// or network interface or is referenced by another security group, the operation +// fails with DependencyViolation . func (c *Client) DeleteSecurityGroup(ctx context.Context, params *DeleteSecurityGroupInput, optFns ...func(*Options)) (*DeleteSecurityGroupOutput, error) { if params == nil { params = &DeleteSecurityGroupInput{} diff --git a/service/ec2/api_op_DeleteSnapshot.go b/service/ec2/api_op_DeleteSnapshot.go index 762ca73c752..eb4eb02e7bc 100644 --- a/service/ec2/api_op_DeleteSnapshot.go +++ b/service/ec2/api_op_DeleteSnapshot.go @@ -10,16 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified snapshot. When you make periodic snapshots of a volume, -// 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 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/ebs/latest/userguide/ebs-deleting-snapshot.html) -// in the Amazon EBS User Guide. +// Deletes the specified snapshot. +// +// When you make periodic snapshots of a volume, 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 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] in the Amazon EBS User Guide. +// +// [Delete an Amazon EBS snapshot]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-deleting-snapshot.html func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error) { if params == nil { params = &DeleteSnapshotInput{} diff --git a/service/ec2/api_op_DeleteTags.go b/service/ec2/api_op_DeleteTags.go index d795d5ae5b3..1bacdda772b 100644 --- a/service/ec2/api_op_DeleteTags.go +++ b/service/ec2/api_op_DeleteTags.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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] in the +// Amazon Elastic Compute Cloud User Guide. +// +// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error) { if params == nil { params = &DeleteTagsInput{} @@ -32,8 +34,10 @@ func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns type DeleteTagsInput struct { - // The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource - // IDs. We recommend breaking up this request into smaller batches. + // The IDs of the resources, separated by spaces. + // + // Constraints: Up to 1000 resource IDs. We recommend breaking up this request + // into smaller batches. // // This member is required. Resources []string @@ -48,9 +52,12 @@ type DeleteTagsInput struct { // specific tags. If you specify a tag key without a tag value, we delete any tag // with this key regardless of its value. If you specify a tag key with an empty // string as the tag value, we delete the tag only if its value is an empty string. + // // If you omit this parameter, we delete all user-defined tags for the specified // resources. We do not delete Amazon Web Services-generated tags (tags that have - // the aws: prefix). Constraints: Up to 1000 tags. + // the aws: prefix). + // + // Constraints: Up to 1000 tags. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ec2/api_op_DeleteTrafficMirrorFilter.go b/service/ec2/api_op_DeleteTrafficMirrorFilter.go index 83ab16a6dc1..b7b9d83cbc4 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorFilter.go +++ b/service/ec2/api_op_DeleteTrafficMirrorFilter.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror -// filter that is in use by a Traffic Mirror session. +// Deletes the specified Traffic Mirror filter. +// +// You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror +// session. func (c *Client) DeleteTrafficMirrorFilter(ctx context.Context, params *DeleteTrafficMirrorFilterInput, optFns ...func(*Options)) (*DeleteTrafficMirrorFilterOutput, error) { if params == nil { params = &DeleteTrafficMirrorFilterInput{} diff --git a/service/ec2/api_op_DeleteTrafficMirrorTarget.go b/service/ec2/api_op_DeleteTrafficMirrorTarget.go index dce118e2f7b..421a9762f66 100644 --- a/service/ec2/api_op_DeleteTrafficMirrorTarget.go +++ b/service/ec2/api_op_DeleteTrafficMirrorTarget.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Traffic Mirror target. You cannot delete a Traffic Mirror -// target that is in use by a Traffic Mirror session. +// Deletes the specified Traffic Mirror target. +// +// You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror +// session. func (c *Client) DeleteTrafficMirrorTarget(ctx context.Context, params *DeleteTrafficMirrorTargetInput, optFns ...func(*Options)) (*DeleteTrafficMirrorTargetOutput, error) { if params == nil { params = &DeleteTrafficMirrorTargetInput{} diff --git a/service/ec2/api_op_DeleteTransitGatewayRouteTable.go b/service/ec2/api_op_DeleteTransitGatewayRouteTable.go index 7e78a0ea868..a515a3e2484 100644 --- a/service/ec2/api_op_DeleteTransitGatewayRouteTable.go +++ b/service/ec2/api_op_DeleteTransitGatewayRouteTable.go @@ -12,9 +12,9 @@ import ( ) // Deletes the specified transit gateway route table. If there are any route -// tables associated with the transit gateway route table, you must first run -// DisassociateRouteTable before you can delete the transit gateway route table. -// This removes any route tables associated with the transit gateway route table. +// tables associated with the transit gateway route table, you must first run DisassociateRouteTable +// before you can delete the transit gateway route table. This removes any route +// tables associated with the transit gateway route table. func (c *Client) DeleteTransitGatewayRouteTable(ctx context.Context, params *DeleteTransitGatewayRouteTableInput, optFns ...func(*Options)) (*DeleteTransitGatewayRouteTableOutput, error) { if params == nil { params = &DeleteTransitGatewayRouteTableInput{} diff --git a/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go b/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go index d6eb507e8bd..23acdfe137b 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go +++ b/service/ec2/api_op_DeleteVerifiedAccessEndpoint.go @@ -35,8 +35,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_DeleteVerifiedAccessGroup.go b/service/ec2/api_op_DeleteVerifiedAccessGroup.go index c3b00f166f5..c8eb15b9b83 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessGroup.go +++ b/service/ec2/api_op_DeleteVerifiedAccessGroup.go @@ -35,8 +35,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_DeleteVerifiedAccessInstance.go b/service/ec2/api_op_DeleteVerifiedAccessInstance.go index 7c47f264b78..3b16702eb7d 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessInstance.go +++ b/service/ec2/api_op_DeleteVerifiedAccessInstance.go @@ -35,8 +35,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go b/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go index 108f6cb0ead..78b4914e7a9 100644 --- a/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_DeleteVerifiedAccessTrustProvider.go @@ -35,8 +35,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_DeleteVolume.go b/service/ec2/api_op_DeleteVolume.go index 5b70189e356..0b420914650 100644 --- a/service/ec2/api_op_DeleteVolume.go +++ b/service/ec2/api_op_DeleteVolume.go @@ -11,9 +11,13 @@ import ( ) // 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/ebs/latest/userguide/ebs-deleting-volume.html) -// in the Amazon EBS User Guide. +// (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] in the Amazon EBS User Guide. +// +// [Delete an Amazon EBS volume]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-deleting-volume.html func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error) { if params == nil { params = &DeleteVolumeInput{} diff --git a/service/ec2/api_op_DeleteVpcEndpoints.go b/service/ec2/api_op_DeleteVpcEndpoints.go index e7e0aaad486..86dc977c7ee 100644 --- a/service/ec2/api_op_DeleteVpcEndpoints.go +++ b/service/ec2/api_op_DeleteVpcEndpoints.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified VPC endpoints. When you delete a gateway endpoint, we -// delete the endpoint routes in the route tables for the endpoint. When you delete -// a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. You -// can only delete Gateway Load Balancer endpoints when the routes that are -// associated with the endpoint are deleted. When you delete an interface endpoint, -// we delete its endpoint network interfaces. +// Deletes the specified VPC endpoints. +// +// When you delete a gateway endpoint, we delete the endpoint routes in the route +// tables for the endpoint. +// +// When you delete a Gateway Load Balancer endpoint, we delete its endpoint +// network interfaces. You can only delete Gateway Load Balancer endpoints when the +// routes that are associated with the endpoint are deleted. +// +// When you delete an interface endpoint, we delete its endpoint network +// interfaces. func (c *Client) DeleteVpcEndpoints(ctx context.Context, params *DeleteVpcEndpointsInput, optFns ...func(*Options)) (*DeleteVpcEndpointsOutput, error) { if params == nil { params = &DeleteVpcEndpointsInput{} diff --git a/service/ec2/api_op_DeleteVpnConnection.go b/service/ec2/api_op_DeleteVpnConnection.go index 99be5e80bf0..6fd3d2c2ce6 100644 --- a/service/ec2/api_op_DeleteVpnConnection.go +++ b/service/ec2/api_op_DeleteVpnConnection.go @@ -10,14 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified VPN connection. If you're deleting the VPC and its -// associated components, we recommend that you detach the virtual private gateway -// from the VPC and delete the VPC before deleting the VPN connection. If you -// believe that the tunnel credentials for your VPN connection have been -// compromised, you can delete the VPN connection and create a new one that has new -// keys, without needing to delete the VPC or virtual private gateway. If you -// create a new VPN connection, you must reconfigure the customer gateway device -// using the new configuration information returned with the new VPN connection ID. +// Deletes the specified VPN connection. +// +// If you're deleting the VPC and its associated components, we recommend that you +// detach the virtual private gateway from the VPC and delete the VPC before +// deleting the VPN connection. If you believe that the tunnel credentials for your +// VPN connection have been compromised, you can delete the VPN connection and +// create a new one that has new keys, without needing to delete the VPC or virtual +// private gateway. If you create a new VPN connection, you must reconfigure the +// customer gateway device using the new configuration information returned with +// the new VPN connection ID. +// // For certificate-based authentication, delete all Certificate Manager (ACM) // private certificates used for the Amazon Web Services-side tunnel endpoints for // the VPN connection before deleting the VPN connection. diff --git a/service/ec2/api_op_DeprovisionByoipCidr.go b/service/ec2/api_op_DeprovisionByoipCidr.go index 8ce263c93a6..f1f615938ee 100644 --- a/service/ec2/api_op_DeprovisionByoipCidr.go +++ b/service/ec2/api_op_DeprovisionByoipCidr.go @@ -13,9 +13,10 @@ import ( // Releases the specified address range that you provisioned for 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 using WithdrawByoipCidr and you must not have any -// IP addresses allocated from its address range. +// deletes the corresponding address pool. +// +// Before you can release an address range, you must stop advertising it using WithdrawByoipCidr +// and you must not have any IP addresses allocated from its address range. func (c *Client) DeprovisionByoipCidr(ctx context.Context, params *DeprovisionByoipCidrInput, optFns ...func(*Options)) (*DeprovisionByoipCidrOutput, error) { if params == nil { params = &DeprovisionByoipCidrInput{} diff --git a/service/ec2/api_op_DeprovisionIpamByoasn.go b/service/ec2/api_op_DeprovisionIpamByoasn.go index 3a0bd81a1ab..4ed4e8764c6 100644 --- a/service/ec2/api_op_DeprovisionIpamByoasn.go +++ b/service/ec2/api_op_DeprovisionIpamByoasn.go @@ -13,9 +13,11 @@ import ( // Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services // account. This action can only be called after any BYOIP CIDR associations are -// removed from your Amazon Web Services account with DisassociateIpamByoasn (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIpamByoasn.html) -// . For more information, see Tutorial: Bring your ASN to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) +// removed from your Amazon Web Services account with [DisassociateIpamByoasn]. For more information, see [Tutorial: Bring your ASN to IPAM] // in the Amazon VPC IPAM guide. +// +// [DisassociateIpamByoasn]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIpamByoasn.html +// [Tutorial: Bring your ASN to IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html func (c *Client) DeprovisionIpamByoasn(ctx context.Context, params *DeprovisionIpamByoasnInput, optFns ...func(*Options)) (*DeprovisionIpamByoasnOutput, error) { if params == nil { params = &DeprovisionIpamByoasnInput{} diff --git a/service/ec2/api_op_DeprovisionIpamPoolCidr.go b/service/ec2/api_op_DeprovisionIpamPoolCidr.go index ea2fb797803..1289862f4c9 100644 --- a/service/ec2/api_op_DeprovisionIpamPoolCidr.go +++ b/service/ec2/api_op_DeprovisionIpamPoolCidr.go @@ -13,8 +13,9 @@ import ( // 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. +// pool. For more information, see [Deprovision pool CIDRs]in the Amazon VPC IPAM User Guide. +// +// [Deprovision pool CIDRs]: https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html func (c *Client) DeprovisionIpamPoolCidr(ctx context.Context, params *DeprovisionIpamPoolCidrInput, optFns ...func(*Options)) (*DeprovisionIpamPoolCidrOutput, error) { if params == nil { params = &DeprovisionIpamPoolCidrInput{} diff --git a/service/ec2/api_op_DeregisterImage.go b/service/ec2/api_op_DeregisterImage.go index fceb77ca740..be53865fc1e 100644 --- a/service/ec2/api_op_DeregisterImage.go +++ b/service/ec2/api_op_DeregisterImage.go @@ -11,16 +11,22 @@ 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 -// 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 -// root volume of the instance during the AMI creation process. When you deregister -// an instance store-backed AMI, it doesn't affect the files that you uploaded to -// Amazon S3 when you created the AMI. +// 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]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 root volume of the instance during the AMI creation +// process. When you deregister an instance store-backed AMI, it doesn't affect the +// files that you uploaded to Amazon S3 when you created the AMI. +// +// [Recycle Bin]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html func (c *Client) DeregisterImage(ctx context.Context, params *DeregisterImageInput, optFns ...func(*Options)) (*DeregisterImageOutput, error) { if params == nil { params = &DeregisterImageInput{} diff --git a/service/ec2/api_op_DescribeAccountAttributes.go b/service/ec2/api_op_DescribeAccountAttributes.go index 9d84499e8b8..9814794a906 100644 --- a/service/ec2/api_op_DescribeAccountAttributes.go +++ b/service/ec2/api_op_DescribeAccountAttributes.go @@ -13,22 +13,29 @@ import ( // Describes attributes of your Amazon Web Services account. The following are the // supported account attributes: +// // - 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. +// more information, see [On-Demand Instance Limits]in the Amazon Elastic Compute Cloud User Guide. +// // - max-elastic-ips : The maximum number of Elastic IP addresses that you can // allocate. +// // - supported-platforms : This attribute is deprecated. +// // - vpc-max-elastic-ips : The maximum number of Elastic IP addresses that you // can allocate. +// // - vpc-max-security-groups-per-interface : The maximum number of security // groups that you can assign to a network interface. // // The order of the elements in the response, including those within nested // structures, might vary. Applications should not assume the elements appear in a // particular order. +// +// [On-Demand Instance Limits]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-on-demand-instances.html#ec2-on-demand-instances-limits func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { params = &DescribeAccountAttributesInput{} diff --git a/service/ec2/api_op_DescribeAddressTransfers.go b/service/ec2/api_op_DescribeAddressTransfers.go index 0e3c60a383e..bd8819fcbb2 100644 --- a/service/ec2/api_op_DescribeAddressTransfers.go +++ b/service/ec2/api_op_DescribeAddressTransfers.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Virtual Private Cloud User Guide. When you transfer an Elastic IP -// address, there is a two-step handshake between the source and transfer Amazon -// Web Services accounts. When the source account starts the transfer, the transfer -// account has seven days to accept the Elastic IP address transfer. During those -// seven days, the source account can view the pending transfer by using this -// action. After seven days, the transfer expires and ownership of the Elastic IP -// address returns to the source account. Accepted transfers are visible to the -// source account for three days after the transfers have been accepted. +// Describes an Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses] in the +// Amazon Virtual Private Cloud User Guide. +// +// When you transfer an Elastic IP address, there is a two-step handshake between +// the source and transfer Amazon Web Services accounts. When the source account +// starts the transfer, the transfer account has seven days to accept the Elastic +// IP address transfer. During those seven days, the source account can view the +// pending transfer by using this action. After seven days, the transfer expires +// and ownership of the Elastic IP address returns to the source account. Accepted +// transfers are visible to the source account for three days after the transfers +// have been accepted. +// +// [Transfer Elastic IP addresses]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro func (c *Client) DescribeAddressTransfers(ctx context.Context, params *DescribeAddressTransfersInput, optFns ...func(*Options)) (*DescribeAddressTransfersOutput, error) { if params == nil { params = &DescribeAddressTransfersInput{} diff --git a/service/ec2/api_op_DescribeAddresses.go b/service/ec2/api_op_DescribeAddresses.go index bc97a237e44..ea538a1af2d 100644 --- a/service/ec2/api_op_DescribeAddresses.go +++ b/service/ec2/api_op_DescribeAddresses.go @@ -40,28 +40,38 @@ type DescribeAddressesInput struct { DryRun *bool // One or more filters. Filter names and values are case-sensitive. + // // - allocation-id - The allocation ID for the address. + // // - association-id - The association ID for the address. + // // - 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 - 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. + // + // - network-interface-owner-id - The Amazon Web Services account ID of the owner. + // // - private-ip-address - 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 - // addresses. + // One or more Elastic IP addresses. + // + // Default: Describes all your Elastic IP addresses. PublicIps []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeAddressesAttribute.go b/service/ec2/api_op_DescribeAddressesAttribute.go index 408217b07fe..33d8490834f 100644 --- a/service/ec2/api_op_DescribeAddressesAttribute.go +++ b/service/ec2/api_op_DescribeAddressesAttribute.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/ec2/api_op_DescribeAggregateIdFormat.go b/service/ec2/api_op_DescribeAggregateIdFormat.go index 69459b2a4a1..632a51a0a45 100644 --- a/service/ec2/api_op_DescribeAggregateIdFormat.go +++ b/service/ec2/api_op_DescribeAggregateIdFormat.go @@ -13,8 +13,11 @@ import ( // Describes the longer ID format settings for all resource types in a specific // Region. This request is useful for performing a quick audit to determine whether -// a specific Region is fully opted in for longer IDs (17-character IDs). This -// request only returns information about resource types that support longer IDs. +// a specific Region is fully opted in for longer IDs (17-character IDs). +// +// This request only returns information about resource types that support longer +// IDs. +// // 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 | diff --git a/service/ec2/api_op_DescribeAvailabilityZones.go b/service/ec2/api_op_DescribeAvailabilityZones.go index a6296cab372..17094969e5a 100644 --- a/service/ec2/api_op_DescribeAvailabilityZones.go +++ b/service/ec2/api_op_DescribeAvailabilityZones.go @@ -13,12 +13,16 @@ import ( // Describes the Availability Zones, Local Zones, and Wavelength Zones that are // 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) -// in the Amazon Elastic Compute Cloud User Guide. The order of the elements in the -// response, including those within nested structures, might vary. Applications -// should not assume the elements appear in a particular order. +// 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]in the Amazon Elastic Compute Cloud User Guide. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Regions and zones]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html func (c *Client) DescribeAvailabilityZones(ctx context.Context, params *DescribeAvailabilityZonesInput, optFns ...func(*Options)) (*DescribeAvailabilityZonesOutput, error) { if params == nil { params = &DescribeAvailabilityZonesInput{} @@ -37,8 +41,10 @@ func (c *Client) DescribeAvailabilityZones(ctx context.Context, params *Describe type DescribeAvailabilityZonesInput struct { // Include all Availability Zones, Local Zones, and Wavelength Zones regardless of - // your opt-in status. If you do not use this parameter, the results include only - // the zones for the Regions where you have chosen the option to opt in. + // your opt-in status. + // + // If you do not use this parameter, the results include only the zones for the + // Regions where you have chosen the option to opt in. AllAvailabilityZones *bool // Checks whether you have the required permissions for the action, without @@ -48,26 +54,36 @@ type DescribeAvailabilityZonesInput struct { 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 ). + // // - message - The Zone message. + // // - opt-in-status - The opt-in status ( opted-in | not-opted-in | // opt-in-not-required ). + // // - parent-zone-id - The ID of the zone that handles some of the Local Zone and // Wavelength Zone control plane operations, such as API calls. + // // - parent-zone-name - 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 diff --git a/service/ec2/api_op_DescribeBundleTasks.go b/service/ec2/api_op_DescribeBundleTasks.go index 32b3f2f8679..ca619443a3f 100644 --- a/service/ec2/api_op_DescribeBundleTasks.go +++ b/service/ec2/api_op_DescribeBundleTasks.go @@ -15,13 +15,16 @@ import ( "time" ) -// Describes the specified bundle tasks or all of your bundle tasks. Completed -// bundle tasks are listed for only a limited time. If your bundle task is no -// longer in the list, you can still register an AMI from it. Just use +// Describes the specified bundle tasks or all of your bundle tasks. +// +// Completed bundle tasks are listed for only a limited time. If your bundle task +// is no longer in the list, you can still register an AMI from it. Just use // RegisterImage with the Amazon S3 bucket name and image manifest name you -// provided to the bundle task. The order of the elements in the response, -// including those within nested structures, might vary. Applications should not -// assume the elements appear in a particular order. +// provided to the bundle task. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. func (c *Client) DescribeBundleTasks(ctx context.Context, params *DescribeBundleTasksInput, optFns ...func(*Options)) (*DescribeBundleTasksOutput, error) { if params == nil { params = &DescribeBundleTasksInput{} @@ -39,7 +42,9 @@ func (c *Client) DescribeBundleTasks(ctx context.Context, params *DescribeBundle type DescribeBundleTasksInput struct { - // The bundle task IDs. Default: Describes all your bundle tasks. + // The bundle task IDs. + // + // Default: Describes all your bundle tasks. BundleIds []string // Checks whether you have the required permissions for the action, without @@ -49,17 +54,27 @@ type DescribeBundleTasksInput struct { 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. Filters []types.Filter @@ -193,12 +208,13 @@ type BundleTaskCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBundleTasksInput, *DescribeBundleTasksOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeByoipCidrs.go b/service/ec2/api_op_DescribeByoipCidrs.go index cae95fb390b..4afc4741b24 100644 --- a/service/ec2/api_op_DescribeByoipCidrs.go +++ b/service/ec2/api_op_DescribeByoipCidrs.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// . +// 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 DescribePublicIpv4Poolsor DescribeIpv6Pools. func (c *Client) DescribeByoipCidrs(ctx context.Context, params *DescribeByoipCidrsInput, optFns ...func(*Options)) (*DescribeByoipCidrsOutput, error) { if params == nil { params = &DescribeByoipCidrsInput{} diff --git a/service/ec2/api_op_DescribeCapacityBlockOfferings.go b/service/ec2/api_op_DescribeCapacityBlockOfferings.go index 6589f0814dd..d7c5244f5d1 100644 --- a/service/ec2/api_op_DescribeCapacityBlockOfferings.go +++ b/service/ec2/api_op_DescribeCapacityBlockOfferings.go @@ -58,8 +58,9 @@ type DescribeCapacityBlockOfferingsInput 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The token to use to retrieve the next page of results. @@ -178,8 +179,9 @@ var _ DescribeCapacityBlockOfferingsAPIClient = (*Client)(nil) type DescribeCapacityBlockOfferingsPaginatorOptions 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]. + // + // [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_DescribeCapacityReservationFleets.go b/service/ec2/api_op_DescribeCapacityReservationFleets.go index 7f2bd48aeb1..6d9d854c5dd 100644 --- a/service/ec2/api_op_DescribeCapacityReservationFleets.go +++ b/service/ec2/api_op_DescribeCapacityReservationFleets.go @@ -39,19 +39,24 @@ type DescribeCapacityReservationFleetsInput struct { 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. 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The token to use to retrieve the next page of results. @@ -164,8 +169,9 @@ var _ DescribeCapacityReservationFleetsAPIClient = (*Client)(nil) type DescribeCapacityReservationFleetsPaginatorOptions 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]. + // + // [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_DescribeCapacityReservations.go b/service/ec2/api_op_DescribeCapacityReservations.go index 89fe57a9fa6..e4fdb9e07ae 100644 --- a/service/ec2/api_op_DescribeCapacityReservations.go +++ b/service/ec2/api_op_DescribeCapacityReservations.go @@ -41,65 +41,88 @@ type DescribeCapacityReservationsInput struct { 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. + // + // - 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 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The token to use to retrieve the next page of results. @@ -212,8 +235,9 @@ var _ DescribeCapacityReservationsAPIClient = (*Client)(nil) type DescribeCapacityReservationsPaginatorOptions 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]. + // + // [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_DescribeCarrierGateways.go b/service/ec2/api_op_DescribeCarrierGateways.go index 9de246d7bec..c7428ba25bf 100644 --- a/service/ec2/api_op_DescribeCarrierGateways.go +++ b/service/ec2/api_op_DescribeCarrierGateways.go @@ -39,17 +39,23 @@ type DescribeCarrierGatewaysInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeClassicLinkInstances.go b/service/ec2/api_op_DescribeClassicLinkInstances.go index b809d2aafa0..73c0036ad34 100644 --- a/service/ec2/api_op_DescribeClassicLinkInstances.go +++ b/service/ec2/api_op_DescribeClassicLinkInstances.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. Describes one or more of your linked EC2-Classic -// instances. This request only returns information about EC2-Classic instances -// linked to a VPC through ClassicLink. You cannot use this request to return -// information about other instances. +// This action is deprecated. +// +// Describes one or more of your linked EC2-Classic instances. This request only +// returns information about EC2-Classic instances linked to a VPC through +// ClassicLink. You cannot use this request to return information about other +// instances. func (c *Client) DescribeClassicLinkInstances(ctx context.Context, params *DescribeClassicLinkInstancesInput, optFns ...func(*Options)) (*DescribeClassicLinkInstancesOutput, error) { if params == nil { params = &DescribeClassicLinkInstancesInput{} @@ -39,15 +41,20 @@ type DescribeClassicLinkInstancesInput struct { DryRun *bool // The 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. Filters []types.Filter @@ -56,8 +63,11 @@ 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]. + // + // Constraint: If the value is greater than 1000, we return only 1000 items. + // + // [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 @@ -171,8 +181,11 @@ 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]. + // + // Constraint: If the value is greater than 1000, we return only 1000 items. + // + // [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_DescribeClientVpnAuthorizationRules.go b/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go index 4c564309f52..33264b0a56f 100644 --- a/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go +++ b/service/ec2/api_op_DescribeClientVpnAuthorizationRules.go @@ -41,9 +41,12 @@ type DescribeClientVpnAuthorizationRulesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeClientVpnConnections.go b/service/ec2/api_op_DescribeClientVpnConnections.go index 0a154ea82ca..3bc2abdef26 100644 --- a/service/ec2/api_op_DescribeClientVpnConnections.go +++ b/service/ec2/api_op_DescribeClientVpnConnections.go @@ -42,7 +42,9 @@ type DescribeClientVpnConnectionsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeClientVpnEndpoints.go b/service/ec2/api_op_DescribeClientVpnEndpoints.go index 0b1f866b488..94949f221b4 100644 --- a/service/ec2/api_op_DescribeClientVpnEndpoints.go +++ b/service/ec2/api_op_DescribeClientVpnEndpoints.go @@ -39,7 +39,9 @@ type DescribeClientVpnEndpointsInput struct { 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 ). Filters []types.Filter diff --git a/service/ec2/api_op_DescribeClientVpnRoutes.go b/service/ec2/api_op_DescribeClientVpnRoutes.go index e59c634813e..7c72c88e335 100644 --- a/service/ec2/api_op_DescribeClientVpnRoutes.go +++ b/service/ec2/api_op_DescribeClientVpnRoutes.go @@ -41,9 +41,12 @@ type DescribeClientVpnRoutesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeClientVpnTargetNetworks.go b/service/ec2/api_op_DescribeClientVpnTargetNetworks.go index 384bf7d1a52..e5110b0924f 100644 --- a/service/ec2/api_op_DescribeClientVpnTargetNetworks.go +++ b/service/ec2/api_op_DescribeClientVpnTargetNetworks.go @@ -44,8 +44,11 @@ type DescribeClientVpnTargetNetworksInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeCoipPools.go b/service/ec2/api_op_DescribeCoipPools.go index 04fcdd5280e..4357859893e 100644 --- a/service/ec2/api_op_DescribeCoipPools.go +++ b/service/ec2/api_op_DescribeCoipPools.go @@ -37,8 +37,10 @@ type DescribeCoipPoolsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeConversionTasks.go b/service/ec2/api_op_DescribeConversionTasks.go index 171d091cbf0..6c754eec336 100644 --- a/service/ec2/api_op_DescribeConversionTasks.go +++ b/service/ec2/api_op_DescribeConversionTasks.go @@ -16,10 +16,12 @@ 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]. +// +// For information about the import manifest referenced by this API action, see [VM Import Manifest]. +// +// [VM Import Manifest]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html +// [VM Import/Export User Guide]: https://docs.aws.amazon.com/vm-import/latest/userguide/ func (c *Client) DescribeConversionTasks(ctx context.Context, params *DescribeConversionTasksInput, optFns ...func(*Options)) (*DescribeConversionTasksOutput, error) { if params == nil { params = &DescribeConversionTasksInput{} @@ -178,12 +180,13 @@ type ConversionTaskCancelledWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeConversionTasksInput, *DescribeConversionTasksOutput, error) (bool, error) } @@ -367,12 +370,13 @@ type ConversionTaskCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeConversionTasksInput, *DescribeConversionTasksOutput, error) (bool, error) } @@ -604,12 +608,13 @@ type ConversionTaskDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeConversionTasksInput, *DescribeConversionTasksOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeCustomerGateways.go b/service/ec2/api_op_DescribeCustomerGateways.go index d42d1a8c20a..47cacf9d194 100644 --- a/service/ec2/api_op_DescribeCustomerGateways.go +++ b/service/ec2/api_op_DescribeCustomerGateways.go @@ -15,9 +15,12 @@ import ( "time" ) -// 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. +// Describes one or more of your VPN customer gateways. +// +// For more information, see [Amazon Web Services Site-to-Site VPN] 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 func (c *Client) DescribeCustomerGateways(ctx context.Context, params *DescribeCustomerGatewaysInput, optFns ...func(*Options)) (*DescribeCustomerGatewaysOutput, error) { if params == nil { params = &DescribeCustomerGatewaysInput{} @@ -36,7 +39,9 @@ func (c *Client) DescribeCustomerGateways(ctx context.Context, params *DescribeC // Contains the parameters for DescribeCustomerGateways. type DescribeCustomerGatewaysInput struct { - // One or more customer gateway IDs. Default: Describes all your customer gateways. + // One or more customer gateway IDs. + // + // Default: Describes all your customer gateways. CustomerGatewayIds []string // Checks whether you have the required permissions for the action, without @@ -46,19 +51,26 @@ type DescribeCustomerGatewaysInput struct { 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. Filters []types.Filter @@ -196,12 +208,13 @@ type CustomerGatewayAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCustomerGatewaysInput, *DescribeCustomerGatewaysOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeDhcpOptions.go b/service/ec2/api_op_DescribeDhcpOptions.go index a655843ab8f..23dcd868579 100644 --- a/service/ec2/api_op_DescribeDhcpOptions.go +++ b/service/ec2/api_op_DescribeDhcpOptions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 VPC User Guide. +// Describes one or more of your DHCP options sets. +// +// For more information, see [DHCP options sets] in the Amazon VPC User Guide. +// +// [DHCP options sets]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html func (c *Client) DescribeDhcpOptions(ctx context.Context, params *DescribeDhcpOptionsInput, optFns ...func(*Options)) (*DescribeDhcpOptionsOutput, error) { if params == nil { params = &DescribeDhcpOptionsInput{} @@ -31,8 +33,9 @@ func (c *Client) DescribeDhcpOptions(ctx context.Context, params *DescribeDhcpOp type DescribeDhcpOptionsInput struct { - // The IDs of one or more DHCP options sets. Default: Describes all your DHCP - // options sets. + // The IDs of one or more DHCP options sets. + // + // Default: Describes all your DHCP options sets. DhcpOptionsIds []string // Checks whether you have the required permissions for the action, without @@ -42,23 +45,30 @@ type DescribeDhcpOptionsInput struct { DryRun *bool // The 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. 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]. + // + // [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 +182,9 @@ 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]. + // + // [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 2219a13bcf5..a471dd8dc02 100644 --- a/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go +++ b/service/ec2/api_op_DescribeEgressOnlyInternetGateways.go @@ -39,18 +39,21 @@ type DescribeEgressOnlyInternetGatewaysInput struct { EgressOnlyInternetGatewayIds []string // The 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. 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]. + // + // [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 +167,9 @@ 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]. + // + // [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 758495fceee..fee3c87ee2b 100644 --- a/service/ec2/api_op_DescribeElasticGpus.go +++ b/service/ec2/api_op_DescribeElasticGpus.go @@ -13,10 +13,12 @@ import ( // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, -// G4dn, or G5 instances. 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) -// . +// G4dn, or G5 instances. +// +// Describes the Elastic Graphics accelerator associated with your instances. For +// more information about Elastic Graphics, see [Amazon Elastic Graphics]. +// +// [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{} @@ -44,14 +46,19 @@ type DescribeElasticGpusInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeExportTasks.go b/service/ec2/api_op_DescribeExportTasks.go index d33938bd757..2db101a5679 100644 --- a/service/ec2/api_op_DescribeExportTasks.go +++ b/service/ec2/api_op_DescribeExportTasks.go @@ -172,12 +172,13 @@ type ExportTaskCancelledWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeExportTasksInput, *DescribeExportTasksOutput, error) (bool, error) } @@ -361,12 +362,13 @@ type ExportTaskCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeExportTasksInput, *DescribeExportTasksOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeFastLaunchImages.go b/service/ec2/api_op_DescribeFastLaunchImages.go index 1a8bb0cab1c..c02661d3cb2 100644 --- a/service/ec2/api_op_DescribeFastLaunchImages.go +++ b/service/ec2/api_op_DescribeFastLaunchImages.go @@ -36,8 +36,11 @@ type DescribeFastLaunchImagesInput struct { DryRun *bool // Use the following filters to streamline results. + // // - resource-type - The resource type for pre-provisioning. + // // - owner-id - The owner ID for the pre-provisioning resource. + // // - state - The current state of fast launching for the Windows AMI. Filters []types.Filter @@ -46,8 +49,9 @@ 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]. + // + // [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 @@ -162,8 +166,9 @@ 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]. + // + // [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 d06fe37c171..afb33492f04 100644 --- a/service/ec2/api_op_DescribeFastSnapshotRestores.go +++ b/service/ec2/api_op_DescribeFastSnapshotRestores.go @@ -36,18 +36,23 @@ type DescribeFastSnapshotRestoresInput struct { 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 ). 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]. + // + // [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 @@ -161,8 +166,9 @@ 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]. + // + // [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 a07b3ae2641..8843682089b 100644 --- a/service/ec2/api_op_DescribeFleetHistory.go +++ b/service/ec2/api_op_DescribeFleetHistory.go @@ -12,12 +12,15 @@ import ( "time" ) -// Describes the events for the specified EC2 Fleet during the specified time. EC2 -// 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. +// Describes the events for the specified EC2 Fleet during the specified time. +// +// EC2 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] in the Amazon EC2 User Guide. +// +// [Monitor fleet events using Amazon EventBridge]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html func (c *Client) DescribeFleetHistory(ctx context.Context, params *DescribeFleetHistoryInput, optFns ...func(*Options)) (*DescribeFleetHistoryOutput, error) { if params == nil { params = &DescribeFleetHistoryInput{} @@ -57,8 +60,9 @@ 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]. + // + // [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 @@ -77,8 +81,9 @@ type DescribeFleetHistoryOutput struct { HistoryRecords []types.HistoryRecordEntry // The last date and time for the events, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken - // indicates that there are more items, this value is not present. + // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. + // + // If nextToken indicates that there are more items, this value is not present. LastEvaluatedTime *time.Time // The token to include in another request to get the next page of items. This diff --git a/service/ec2/api_op_DescribeFleetInstances.go b/service/ec2/api_op_DescribeFleetInstances.go index 4ccfebdaed5..39873d6d6c3 100644 --- a/service/ec2/api_op_DescribeFleetInstances.go +++ b/service/ec2/api_op_DescribeFleetInstances.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the running instances for the specified EC2 Fleet. Currently, -// DescribeFleetInstances does not support fleets of type instant . Instead, use -// DescribeFleets , specifying the instant fleet ID in the request. For more -// information, see Describe your EC2 Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) -// in the Amazon EC2 User Guide. +// Describes the running instances for the specified EC2 Fleet. +// +// Currently, DescribeFleetInstances does not support fleets of type instant . +// Instead, use DescribeFleets , specifying the instant fleet ID in the request. +// +// For more information, see [Describe your EC2 Fleet] in the Amazon EC2 User Guide. +// +// [Describe your EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet func (c *Client) DescribeFleetInstances(ctx context.Context, params *DescribeFleetInstancesInput, optFns ...func(*Options)) (*DescribeFleetInstancesOutput, error) { if params == nil { params = &DescribeFleetInstancesInput{} @@ -45,13 +48,15 @@ type DescribeFleetInstancesInput struct { DryRun *bool // The filters. + // // - 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]. + // + // [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 288f24022e9..aabd20d839c 100644 --- a/service/ec2/api_op_DescribeFleets.go +++ b/service/ec2/api_op_DescribeFleets.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified EC2 Fleet or all of your EC2 Fleets. If a fleet is of -// type instant , you must specify the fleet ID in the request, otherwise the fleet -// does not appear in the response. For more information, see Describe your EC2 -// Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) -// in the Amazon EC2 User Guide. +// Describes the specified EC2 Fleet or all of your EC2 Fleets. +// +// If a fleet is of type instant , you must specify the fleet ID in the request, +// otherwise the fleet does not appear in the response. +// +// For more information, see [Describe your EC2 Fleet] in the Amazon EC2 User Guide. +// +// [Describe your EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet func (c *Client) DescribeFleets(ctx context.Context, params *DescribeFleetsInput, optFns ...func(*Options)) (*DescribeFleetsOutput, error) { if params == nil { params = &DescribeFleetsInput{} @@ -40,26 +43,34 @@ type DescribeFleetsInput struct { 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 ). Filters []types.Filter - // 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. + // 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]. + // + // [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 +183,9 @@ 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]. + // + // [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 ce4df626644..e085d0e747c 100644 --- a/service/ec2/api_op_DescribeFlowLogs.go +++ b/service/ec2/api_op_DescribeFlowLogs.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes one or more flow logs. To view the published flow log records, you -// must view the log destination. For example, the CloudWatch Logs log group, the -// Amazon S3 bucket, or the Kinesis Data Firehose delivery stream. +// Describes one or more flow logs. +// +// To view the published flow log records, you must view the log destination. For +// example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis +// Data Firehose delivery stream. func (c *Client) DescribeFlowLogs(ctx context.Context, params *DescribeFlowLogsInput, optFns ...func(*Options)) (*DescribeFlowLogsOutput, error) { if params == nil { params = &DescribeFlowLogsInput{} @@ -38,28 +40,39 @@ type DescribeFlowLogsInput struct { 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. Filter []types.Filter - // One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. + // One or more flow log IDs. + // + // Constraint: Maximum of 1000 flow log IDs. FlowLogIds []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]. + // + // [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 @@ -172,8 +185,9 @@ 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]. + // + // [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_DescribeFpgaImages.go b/service/ec2/api_op_DescribeFpgaImages.go index a3b2af1fadf..c2cc31b21bc 100644 --- a/service/ec2/api_op_DescribeFpgaImages.go +++ b/service/ec2/api_op_DescribeFpgaImages.go @@ -38,21 +38,32 @@ type DescribeFpgaImagesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeHostReservationOfferings.go b/service/ec2/api_op_DescribeHostReservationOfferings.go index 32bd98cc725..705f120a047 100644 --- a/service/ec2/api_op_DescribeHostReservationOfferings.go +++ b/service/ec2/api_op_DescribeHostReservationOfferings.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the Dedicated Host reservations that are available to purchase. The -// results describe all of the Dedicated Host reservation offerings, including +// Describes the Dedicated Host reservations that are available to purchase. +// +// The results describe all of the Dedicated Host reservation offerings, including // offerings that might not match the instance family and Region of your Dedicated // 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) -// in the Amazon EC2 User Guide. +// associated. For more information about supported instance types, see [Dedicated Hosts]in the +// Amazon EC2 User Guide. +// +// [Dedicated Hosts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html func (c *Client) DescribeHostReservationOfferings(ctx context.Context, params *DescribeHostReservationOfferingsInput, optFns ...func(*Options)) (*DescribeHostReservationOfferingsOutput, error) { if params == nil { params = &DescribeHostReservationOfferingsInput{} @@ -37,7 +39,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 ). Filter []types.Filter diff --git a/service/ec2/api_op_DescribeHostReservations.go b/service/ec2/api_op_DescribeHostReservations.go index f690dce75ec..59fa61010bf 100644 --- a/service/ec2/api_op_DescribeHostReservations.go +++ b/service/ec2/api_op_DescribeHostReservations.go @@ -30,15 +30,20 @@ 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. Filter []types.Filter diff --git a/service/ec2/api_op_DescribeHosts.go b/service/ec2/api_op_DescribeHosts.go index 680ea44f893..29c5400cddf 100644 --- a/service/ec2/api_op_DescribeHosts.go +++ b/service/ec2/api_op_DescribeHosts.go @@ -11,10 +11,11 @@ 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{} @@ -33,16 +34,22 @@ 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 - // ). + // 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 @@ -53,8 +60,10 @@ type DescribeHostsInput 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 returned // nextToken value. This value can be between 5 and 500. If maxResults is given a - // larger value than 500, you receive an error. You cannot specify this parameter - // and the host IDs parameter in the same request. + // larger value than 500, you receive an error. + // + // You cannot specify this parameter and the host IDs parameter in the same + // request. MaxResults *int32 // The token to use to retrieve the next page of results. @@ -166,8 +175,10 @@ type DescribeHostsPaginatorOptions 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 returned // nextToken value. This value can be between 5 and 500. If maxResults is given a - // larger value than 500, you receive an error. You cannot specify this parameter - // and the host IDs parameter in the same request. + // larger value than 500, you receive an error. + // + // You cannot specify this parameter and the host IDs parameter in the same + // request. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go b/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go index d3ebd62c30c..37931b35822 100644 --- a/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go +++ b/service/ec2/api_op_DescribeIamInstanceProfileAssociations.go @@ -33,15 +33,18 @@ type DescribeIamInstanceProfileAssociationsInput struct { AssociationIds []string // The filters. + // // - 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]. + // + // [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 +158,9 @@ 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]. + // + // [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 c0a50539268..719c0666501 100644 --- a/service/ec2/api_op_DescribeIdFormat.go +++ b/service/ec2/api_op_DescribeIdFormat.go @@ -14,21 +14,23 @@ import ( // Describes the ID format settings for your resources on a per-Region basis, for // 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 | -// 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 -// 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 -// these settings and provided that they have permission to use the relevant -// Describe command for the resource type. +// 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 | 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 default, an IAM user defaults to +// the same settings as the root user, unless they explicitly override the settings +// by running the ModifyIdFormatcommand. Resources created with longer IDs are visible to all +// IAM users, regardless of these settings and provided that they have permission +// to use the relevant Describe command for the resource type. func (c *Client) DescribeIdFormat(ctx context.Context, params *DescribeIdFormatInput, optFns ...func(*Options)) (*DescribeIdFormatOutput, error) { if params == nil { params = &DescribeIdFormatInput{} diff --git a/service/ec2/api_op_DescribeIdentityIdFormat.go b/service/ec2/api_op_DescribeIdentityIdFormat.go index 054f3f8c2a4..61e75451f28 100644 --- a/service/ec2/api_op_DescribeIdentityIdFormat.go +++ b/service/ec2/api_op_DescribeIdentityIdFormat.go @@ -15,17 +15,22 @@ 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 | -// 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. +// other resource types. For more information, see [Resource IDs]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. +// +// [Resource IDs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html 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 cb563e3c94e..b4e0598281e 100644 --- a/service/ec2/api_op_DescribeImageAttribute.go +++ b/service/ec2/api_op_DescribeImageAttribute.go @@ -12,9 +12,11 @@ import ( ) // Describes the specified attribute of the specified AMI. You can specify only -// one attribute at a time. The order of the elements in the response, including -// those within nested structures, might vary. Applications should not assume the -// elements appear in a particular order. +// one attribute at a time. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. func (c *Client) DescribeImageAttribute(ctx context.Context, params *DescribeImageAttributeInput, optFns ...func(*Options)) (*DescribeImageAttributeOutput, error) { if params == nil { params = &DescribeImageAttributeInput{} @@ -33,9 +35,11 @@ func (c *Client) DescribeImageAttribute(ctx context.Context, params *DescribeIma // Contains the parameters for DescribeImageAttribute. type DescribeImageAttributeInput struct { - // The AMI attribute. Note: The blockDeviceMapping attribute is deprecated. Using - // this attribute returns the Client.AuthFailure error. To get information about - // the block device mappings for an AMI, use the DescribeImages action. + // The AMI attribute. + // + // Note: The blockDeviceMapping attribute is deprecated. Using this attribute + // returns the Client.AuthFailure error. To get information about the block device + // mappings for an AMI, use the DescribeImagesaction. // // This member is required. Attribute types.ImageAttributeName @@ -76,17 +80,21 @@ type DescribeImageAttributeOutput struct { // 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. + // information, see [Configure the AMI]in the Amazon EC2 User Guide. + // + // [Configure the AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration 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. + // The date and time, in [ISO 8601 date-time format], 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. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 LastLaunchedTime *types.AttributeValue // The launch permissions. @@ -106,11 +114,12 @@ type DescribeImageAttributeOutput struct { 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) - // 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. + // UEFI data, use the [GetInstanceUefiData]command. You can inspect and modify the UEFI data by using + // the [python-uefivars tool]on GitHub. For more information, see [UEFI Secure Boot] in the Amazon EC2 User Guide. + // + // [UEFI Secure Boot]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html + // [GetInstanceUefiData]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData + // [python-uefivars tool]: https://github.com/awslabs/python-uefivars 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 db76960b135..e80d466d8f7 100644 --- a/service/ec2/api_op_DescribeImages.go +++ b/service/ec2/api_op_DescribeImages.go @@ -19,17 +19,23 @@ import ( ) // 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 -// indicating that the AMI ID cannot be found. We strongly recommend using only -// paginated requests. Unpaginated requests are susceptible to throttling and -// timeouts. The order of the elements in the response, including those within -// nested structures, might vary. Applications should not assume the elements -// appear in a particular order. +// 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 indicating that the AMI ID cannot be found. +// +// We strongly recommend using only paginated requests. Unpaginated requests are +// susceptible to throttling and timeouts. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error) { if params == nil { params = &DescribeImagesInput{} @@ -54,95 +60,138 @@ type DescribeImagesInput struct { 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). + // 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. ExecutableUsers []string // The filters. + // // - architecture - The image architecture ( i386 | x86_64 | arm64 | x86_64_mac | // arm64_mac ). + // // - 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 // ). + // // - source-instance-id - The ID of the instance that the AMI was created from if // the AMI was created using CreateImage. This filter is applicable only if the AMI - // was created using CreateImage (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html) - // . + // was created using [CreateImage]. + // // - 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 ). + // + // [CreateImage]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html Filters []types.Filter - // The image IDs. Default: Describes all images available to you. + // The image IDs. + // + // Default: Describes all images available to you. ImageIds []string - // Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are - // included in the response. If you are the AMI owner, all deprecated AMIs appear - // in the response regardless of what you specify for this parameter. + // Specifies whether to include deprecated AMIs. + // + // Default: No deprecated AMIs are included in the response. + // + // If you are the AMI owner, all deprecated AMIs appear in the response regardless + // of what you specify for this parameter. IncludeDeprecated *bool - // Specifies whether to include disabled AMIs. Default: No disabled AMIs are - // included in the response. + // Specifies whether to include disabled AMIs. + // + // Default: No disabled AMIs are included in the response. IncludeDisabled *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]. + // + // [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 @@ -261,8 +310,9 @@ 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]. + // + // [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 @@ -374,12 +424,13 @@ type ImageAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImagesInput, *DescribeImagesOutput, error) (bool, error) } @@ -585,12 +636,13 @@ type ImageExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImagesInput, *DescribeImagesOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeImportSnapshotTasks.go b/service/ec2/api_op_DescribeImportSnapshotTasks.go index d974ad061ba..207ecc1f42b 100644 --- a/service/ec2/api_op_DescribeImportSnapshotTasks.go +++ b/service/ec2/api_op_DescribeImportSnapshotTasks.go @@ -273,12 +273,13 @@ type SnapshotImportedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImportSnapshotTasksInput, *DescribeImportSnapshotTasksOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeInstanceAttribute.go b/service/ec2/api_op_DescribeInstanceAttribute.go index cfae82ecbec..bc466387f48 100644 --- a/service/ec2/api_op_DescribeInstanceAttribute.go +++ b/service/ec2/api_op_DescribeInstanceAttribute.go @@ -33,8 +33,9 @@ func (c *Client) DescribeInstanceAttribute(ctx context.Context, params *Describe type DescribeInstanceAttributeInput struct { - // The instance attribute. Note: The enaSupport attribute is not supported at this - // time. + // The instance attribute. + // + // Note: The enaSupport attribute is not supported at this time. // // This member is required. Attribute types.InstanceAttributeName diff --git a/service/ec2/api_op_DescribeInstanceConnectEndpoints.go b/service/ec2/api_op_DescribeInstanceConnectEndpoints.go index 619a0a8cba8..6c3a6a53950 100644 --- a/service/ec2/api_op_DescribeInstanceConnectEndpoints.go +++ b/service/ec2/api_op_DescribeInstanceConnectEndpoints.go @@ -37,18 +37,24 @@ type DescribeInstanceConnectEndpointsInput struct { DryRun *bool // One or more filters. + // // - instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint. + // // - state - The state of the EC2 Instance Connect Endpoint ( create-in-progress // | create-complete | create-failed | delete-in-progress | delete-complete | // delete-failed ). + // // - subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint // was created. + // // - 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-value - The value of a tag assigned to the resource. Use this filter to // find all resources that have a tag with a specific value, regardless of tag key. // @@ -61,8 +67,9 @@ type DescribeInstanceConnectEndpointsInput 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]. + // + // [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 @@ -176,8 +183,9 @@ var _ DescribeInstanceConnectEndpointsAPIClient = (*Client)(nil) type DescribeInstanceConnectEndpointsPaginatorOptions 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]. + // + // [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_DescribeInstanceCreditSpecifications.go b/service/ec2/api_op_DescribeInstanceCreditSpecifications.go index 6cd3bf0d194..fcf8c5dfbe7 100644 --- a/service/ec2/api_op_DescribeInstanceCreditSpecifications.go +++ b/service/ec2/api_op_DescribeInstanceCreditSpecifications.go @@ -12,22 +12,30 @@ import ( ) // 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. +// 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. +// 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] in the Amazon EC2 User Guide. +// +// [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html func (c *Client) DescribeInstanceCreditSpecifications(ctx context.Context, params *DescribeInstanceCreditSpecificationsInput, optFns ...func(*Options)) (*DescribeInstanceCreditSpecificationsOutput, error) { if params == nil { params = &DescribeInstanceCreditSpecificationsInput{} @@ -52,18 +60,25 @@ type DescribeInstanceCreditSpecificationsInput struct { DryRun *bool // The filters. + // // - instance-id - The ID of the instance. Filters []types.Filter - // The instance IDs. Default: Describes all your instances. Constraints: Maximum - // 1000 explicitly specified instance IDs. + // The instance IDs. + // + // Default: Describes all your instances. + // + // Constraints: Maximum 1000 explicitly specified instance IDs. InstanceIds []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) - // . You cannot specify this parameter and the instance IDs parameter in the same + // information, see [Pagination]. + // + // You cannot specify this parameter and the instance IDs parameter in the same // call. + // + // [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 @@ -177,9 +192,12 @@ 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]. + // + // You cannot specify this parameter and the instance IDs parameter in the same // call. + // + // [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_DescribeInstanceEventWindows.go b/service/ec2/api_op_DescribeInstanceEventWindows.go index 933d9b1e7da..4ec60d014a3 100644 --- a/service/ec2/api_op_DescribeInstanceEventWindows.go +++ b/service/ec2/api_op_DescribeInstanceEventWindows.go @@ -11,15 +11,18 @@ 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 -// 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. +// 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] in the Amazon EC2 User Guide. +// +// [Define event windows for scheduled events]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html func (c *Client) DescribeInstanceEventWindows(ctx context.Context, params *DescribeInstanceEventWindowsInput, optFns ...func(*Options)) (*DescribeInstanceEventWindowsOutput, error) { if params == nil { params = &DescribeInstanceEventWindowsInput{} @@ -45,24 +48,32 @@ type DescribeInstanceEventWindowsInput struct { 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 - 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. diff --git a/service/ec2/api_op_DescribeInstanceStatus.go b/service/ec2/api_op_DescribeInstanceStatus.go index db50b3127a2..8e029bc7b84 100644 --- a/service/ec2/api_op_DescribeInstanceStatus.go +++ b/service/ec2/api_op_DescribeInstanceStatus.go @@ -19,25 +19,30 @@ import ( // Describes the status of the specified instances or all of your instances. By // default, only running instances are described, unless you specifically indicate -// to return the status of all instances. Instance status includes the following -// components: +// 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. +// to identify hardware and software issues. For more information, see [Status checks for your instances]and [Troubleshoot instances with failed status checks]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. +// system maintenance. For more information, see [Scheduled events for your instances]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. +// them through their termination. For more information, see [Instance lifecycle]in the Amazon EC2 +// User Guide. // // The order of the elements in the response, including those within nested // structures, might vary. Applications should not assume the elements appear in a // particular order. +// +// [Troubleshoot instances with failed status checks]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html +// [Instance lifecycle]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html +// [Status checks for your instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html +// [Scheduled events for your instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html func (c *Client) DescribeInstanceStatus(ctx context.Context, params *DescribeInstanceStatusInput, optFns ...func(*Options)) (*DescribeInstanceStatusOutput, error) { if params == nil { params = &DescribeInstanceStatusInput{} @@ -62,48 +67,69 @@ type DescribeInstanceStatusInput struct { 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 ). Filters []types.Filter // When true , includes the health status for all instances. When false , includes - // the health status for running instances only. Default: false + // the health status for running instances only. + // + // Default: false IncludeAllInstances *bool - // The instance IDs. Default: Describes all your instances. Constraints: Maximum - // 100 explicitly specified instance IDs. + // The instance IDs. + // + // Default: Describes all your instances. + // + // Constraints: Maximum 100 explicitly specified instance IDs. InstanceIds []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) - // . You cannot specify this parameter and the instance IDs parameter in the same + // information, see [Pagination]. + // + // You cannot specify this parameter and the instance IDs parameter in the same // request. + // + // [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 @@ -217,9 +243,12 @@ 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]. + // + // You cannot specify this parameter and the instance IDs parameter in the same // request. + // + // [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 @@ -331,12 +360,13 @@ type InstanceStatusOkWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstanceStatusInput, *DescribeInstanceStatusOutput, error) (bool, error) } @@ -530,12 +560,13 @@ type SystemStatusOkWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstanceStatusInput, *DescribeInstanceStatusOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeInstanceTopology.go b/service/ec2/api_op_DescribeInstanceTopology.go index ae0c91bce55..aeaf0404cc2 100644 --- a/service/ec2/api_op_DescribeInstanceTopology.go +++ b/service/ec2/api_op_DescribeInstanceTopology.go @@ -15,19 +15,28 @@ import ( // your EC2 instances within an Availability Zone or Local Zone. You can use this // information to determine the relative proximity of your EC2 instances within the // Amazon Web Services network to support your tightly coupled workloads. +// // Limitations +// // - Supported zones +// // - Availability Zone +// // - Local Zone +// // - Supported instance types +// // - hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | // hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | // hpc7g.16xlarge +// // - p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge +// // - trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge // -// For more information, see Amazon EC2 instance topology (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html) -// in the Amazon EC2 User Guide. +// For more information, see [Amazon EC2 instance topology] in the Amazon EC2 User Guide. +// +// [Amazon EC2 instance topology]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html func (c *Client) DescribeInstanceTopology(ctx context.Context, params *DescribeInstanceTopologyInput, optFns ...func(*Options)) (*DescribeInstanceTopologyOutput, error) { if params == nil { params = &DescribeInstanceTopologyInput{} @@ -52,29 +61,41 @@ type DescribeInstanceTopologyInput struct { DryRun *bool // The filters. + // // - availability-zone - The name of the Availability Zone (for example, // us-west-2a ) or Local Zone (for example, us-west-2-lax-1b ) that the instance // is in. + // // - instance-type - The instance type (for example, p4d.24xlarge ) or instance // family (for example, p4d* ). You can use the * wildcard to match zero or more // characters, or the ? wildcard to match zero or one character. + // // - zone-id - The ID of the Availability Zone (for example, usw2-az2 ) or Local // Zone (for example, usw2-lax1-az1 ) that the instance is in. Filters []types.Filter - // The name of the placement group that each instance is in. Constraints: Maximum - // 100 explicitly specified placement group names. + // The name of the placement group that each instance is in. + // + // Constraints: Maximum 100 explicitly specified placement group names. GroupNames []string - // The instance IDs. Default: Describes all your instances. Constraints: Maximum - // 100 explicitly specified instance IDs. + // The instance IDs. + // + // Default: Describes all your instances. + // + // Constraints: Maximum 100 explicitly specified instance IDs. InstanceIds []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) - // . You can't specify this parameter and the instance IDs parameter in the same - // request. Default: 20 + // information, see [Pagination]. + // + // You can't specify this parameter and the instance IDs parameter in the same + // request. + // + // Default: 20 + // + // [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 @@ -188,9 +209,14 @@ var _ DescribeInstanceTopologyAPIClient = (*Client)(nil) type DescribeInstanceTopologyPaginatorOptions 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 can't specify this parameter and the instance IDs parameter in the same - // request. Default: 20 + // information, see [Pagination]. + // + // You can't specify this parameter and the instance IDs parameter in the same + // request. + // + // Default: 20 + // + // [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_DescribeInstanceTypeOfferings.go b/service/ec2/api_op_DescribeInstanceTypeOfferings.go index 1ffccf3993d..5853940e75b 100644 --- a/service/ec2/api_op_DescribeInstanceTypeOfferings.go +++ b/service/ec2/api_op_DescribeInstanceTypeOfferings.go @@ -38,29 +38,35 @@ type DescribeInstanceTypeOfferingsInput struct { DryRun *bool // One or more filters. Filter names and values are case-sensitive. - // - instance-type - The instance type. For a list of possible values, see - // Instance (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html) - // . - // - location - The location. For a list of possible identifiers, see Regions - // and Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) - // . + // + // - instance-type - The instance type. For a list of possible values, see [Instance]. + // + // - location - The location. For a list of possible identifiers, see [Regions and Zones]. + // + // [Instance]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html + // [Regions and Zones]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html Filters []types.Filter // The location type. + // // - availability-zone - The Availability Zone. When you specify a location // filter, it must be an Availability Zone for the current Region. + // // - availability-zone-id - The AZ ID. When you specify a location filter, it // must be an AZ ID for the current Region. + // // - outpost - The Outpost ARN. When you specify a location filter, it must be an // Outpost ARN for the current Region. + // // - region - The current Region. If you specify a location filter, it must match // the current Region. LocationType types.LocationType // 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]. + // + // [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 @@ -174,8 +180,9 @@ 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]. + // + // [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 2256c03d160..934ba32ad0a 100644 --- a/service/ec2/api_op_DescribeInstanceTypes.go +++ b/service/ec2/api_op_DescribeInstanceTypes.go @@ -37,95 +37,145 @@ type DescribeInstanceTypesInput struct { DryRun *bool // One or more filters. Filter names and values are case-sensitive. + // // - auto-recovery-supported - Indicates whether Amazon CloudWatch action based // recovery is supported ( true | false ). + // // - bare-metal - Indicates whether it is a bare metal instance type ( true | // false ). + // // - burstable-performance-supported - Indicates whether the instance type is a // burstable performance T 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"). + // // - nitro-enclaves-support - Indicates whether Nitro Enclaves is supported ( // supported | unsupported ). + // // - nitro-tpm-support - Indicates whether NitroTPM is supported ( supported | // unsupported ). + // // - nitro-tpm-info.supported-versions - The supported NitroTPM version ( 2.0 ). + // // - processor-info.supported-architecture - The CPU architecture ( arm64 | i386 // | x86_64 ). + // // - processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz. + // // - processor-info.supported-features - The supported CPU features ( amd-sev-snp // ). + // // - 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 @@ -135,8 +185,9 @@ type DescribeInstanceTypesInput 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]. + // + // [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 @@ -250,8 +301,9 @@ 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]. + // + // [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 60634b9c7fe..136a210859e 100644 --- a/service/ec2/api_op_DescribeInstances.go +++ b/service/ec2/api_op_DescribeInstances.go @@ -18,24 +18,33 @@ 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 -// 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 -// the output. Recently terminated instances might appear in the returned results. -// This interval is usually less than one hour. If you describe instances in the -// rare case where an Availability Zone is experiencing a service disruption and -// you specify instance IDs that are in the affected zone, or do not specify any -// instance IDs at all, the call fails. If you describe instances and specify only -// instance IDs that are in an unaffected zone, the call works normally. We -// strongly recommend using only paginated requests. Unpaginated requests are -// susceptible to throttling and timeouts. The order of the elements in the -// response, including those within nested structures, might vary. Applications -// should not assume the elements appear in a particular order. +// 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 the output. +// +// Recently terminated instances might appear in the returned results. This +// interval is usually less than one hour. +// +// If you describe instances in the rare case where an Availability Zone is +// experiencing a service disruption and you specify instance IDs that are in the +// affected zone, or do not specify any instance IDs at all, the call fails. If you +// describe instances and specify only instance IDs that are in an unaffected zone, +// the call works normally. +// +// We strongly recommend using only paginated requests. Unpaginated requests are +// susceptible to throttling and timeouts. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstancesInput, optFns ...func(*Options)) (*DescribeInstancesOutput, error) { if params == nil { params = &DescribeInstancesInput{} @@ -60,191 +69,295 @@ type DescribeInstancesInput struct { 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, 2022-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. + // // - boot-mode - The boot mode that was specified by the AMI ( legacy-bios | uefi // | uefi-preferred ). + // // - capacity-reservation-id - The ID of the Capacity Reservation into which the // instance was launched. + // // - capacity-reservation-specification.capacity-reservation-preference - The // instance's Capacity Reservation preference ( open | none ). + // // - // capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id // - The ID of the targeted Capacity Reservation. + // // - // capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn // - The ARN of the targeted Capacity Reservation group. + // // - client-token - The idempotency token you provided when you launched the // instance. + // // - current-instance-boot-mode - The boot mode that is used to launch the // instance at launch or start ( legacy-bios | uefi ). + // // - dns-name - The public DNS name of the instance. + // // - ebs-optimized - A Boolean that indicates whether the instance is optimized // for Amazon EBS I/O. + // // - ena-support - A Boolean that indicates whether the instance is enabled for // enhanced networking with ENA. + // // - enclave-options.enabled - A Boolean that indicates whether the instance is // enabled for Amazon Web Services Nitro Enclaves. + // // - 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. + // // - iam-instance-profile.id - The instance profile associated with the instance. // Specified as an ID. + // // - iam-instance-profile.name - The instance profile associated with the // instance. Specified as an name. + // // - 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, a Scheduled // Instance, or a Capacity Block ( spot | scheduled | capacity-block ). + // // - 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. + // // - ipv6-address - The IPv6 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. + // // - maintenance-options.auto-recovery - The current automatic recovery behavior // of the instance ( disabled | default ). + // // - metadata-options.http-endpoint - The status of access to the HTTP metadata // endpoint on your instance ( enabled | disabled ) + // // - metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is // enabled ( disabled | enabled ). + // // - metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is // enabled ( disabled | enabled ). + // // - metadata-options.http-put-response-hop-limit - The HTTP metadata request put // response hop limit (integer, possible values 1 to 64 ) + // // - metadata-options.http-tokens - The metadata request authorization state ( // optional | required ) + // // - metadata-options.instance-metadata-tags - The status of access to instance // tags from the instance metadata ( enabled | disabled ) + // // - metadata-options.state - The state of the metadata option changes ( pending // | applied ). + // // - monitoring-state - Indicates whether detailed monitoring is enabled ( // disabled | enabled ). + // // - network-interface.addresses.association.allocation-id - The allocation ID. + // // - network-interface.addresses.association.association-id - The association ID. + // // - network-interface.addresses.association.carrier-ip - The carrier IP address. + // // - network-interface.addresses.association.customer-owned-ip - The // customer-owned IP address. + // // - network-interface.addresses.association.ip-owner-id - The owner ID of the // private IPv4 address associated with the network interface. + // // - network-interface.addresses.association.public-dns-name - The public DNS // name. + // // - network-interface.addresses.association.public-ip - The ID of the // association of an Elastic IP address (IPv4) with a network interface. + // // - network-interface.addresses.primary - Specifies whether the IPv4 address of // the network interface is the primary private IPv4 address. + // // - network-interface.addresses.private-dns-name - The private DNS name. + // // - network-interface.addresses.private-ip-address - The private IPv4 address // 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.association.carrier-ip - The customer-owned IP address. + // // - network-interface.association.customer-owned-ip - The customer-owned IP // address. + // // - network-interface.association.ip-owner-id - The owner of the Elastic IP // address (IPv4) associated with the network interface. + // // - network-interface.association.public-dns-name - The public DNS name. + // // - network-interface.association.public-ip - The address of the Elastic IP // address (IPv4) bound to the network interface. + // // - network-interface.attachment.attach-time - The time that the network // interface was attached to an instance. + // // - network-interface.attachment.attachment-id - The ID of the interface // attachment. + // // - network-interface.attachment.delete-on-termination - Specifies whether the // attachment is deleted when an instance is terminated. + // // - network-interface.attachment.device-index - The device index to which the // network interface is attached. + // // - 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.network-card-index - The index of the network // card. + // // - network-interface.attachment.status - The status of the attachment ( // attaching | attached | detaching | detached ). + // // - network-interface.availability-zone - The Availability Zone for the network // interface. + // // - network-interface.deny-all-igw-traffic - A Boolean that indicates whether a // network interface with an IPv6 address is unreachable from the public internet. + // // - 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.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are // assigned to the network interface. + // // - network-interface.ipv6-address - The IPv6 address associated with the // network interface. + // // - network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated // with the network interface. + // // - network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates // whether this is the primary IPv6 address. + // // - network-interface.ipv6-native - A Boolean that indicates whether this is an // IPv6 only network interface. + // // - network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to // 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.outpost-arn - The ARN of the Outpost. + // // - 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.private-ip-address - The private IPv4 address. + // // - network-interface.public-dns-name - The public DNS name. + // // - 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.subnet-id - The ID of the subnet for the network interface. + // // - network-interface.tag-key - The key of a tag assigned to the network // interface. + // // - network-interface.tag-value - The value of a tag assigned to 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 . + // // - platform-details - The platform ( Linux/UNIX | Red Hat BYOL Linux | Red Hat // Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise // Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL @@ -254,26 +367,37 @@ type DescribeInstancesInput struct { // Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with // SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL // Server Web ). + // // - private-dns-name - The private IPv4 DNS name of the instance. + // // - private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that // indicates whether to respond to DNS queries for instance hostnames with DNS A // records. + // // - private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean // that indicates whether to respond to DNS queries for instance hostnames with DNS // AAAA records. + // // - private-dns-name-options.hostname-type - The type of hostname ( ip-name | // resource-name ). + // // - 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 @@ -281,27 +405,39 @@ type DescribeInstancesInput struct { // 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 ). + // // - tpm-support - Indicates if the instance is configured for NitroTPM support ( // v2.0 ). + // // - usage-operation - The usage operation value for the instance ( RunInstances // | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | // RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 @@ -309,21 +445,29 @@ type DescribeInstancesInput struct { // RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 // | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | // RunInstances:0202 ). + // // - usage-operation-update-time - The time that the usage operation was last // updated, for example, 2022-09-15T17:15:20.000Z . + // // - 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. + // The instance IDs. + // + // Default: Describes all your instances. InstanceIds []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) - // . You cannot specify this parameter and the instance IDs parameter in the same + // information, see [Pagination]. + // + // You cannot specify this parameter and the instance IDs parameter in the same // request. + // + // [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 @@ -436,9 +580,12 @@ 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]. + // + // You cannot specify this parameter and the instance IDs parameter in the same // request. + // + // [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 @@ -550,12 +697,13 @@ type InstanceExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } @@ -738,12 +886,13 @@ type InstanceRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } @@ -1009,12 +1158,13 @@ type InstanceStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } @@ -1244,12 +1394,13 @@ type InstanceTerminatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeInternetGateways.go b/service/ec2/api_op_DescribeInternetGateways.go index 7812f4d44bd..1531c29bb13 100644 --- a/service/ec2/api_op_DescribeInternetGateways.go +++ b/service/ec2/api_op_DescribeInternetGateways.go @@ -43,27 +43,36 @@ type DescribeInternetGatewaysInput struct { DryRun *bool // The 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. Filters []types.Filter - // The IDs of the internet gateways. Default: Describes all your internet gateways. + // The IDs of the internet gateways. + // + // Default: Describes all your internet gateways. InternetGatewayIds []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]. + // + // [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 @@ -177,8 +186,9 @@ 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]. + // + // [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,12 +303,13 @@ type InternetGatewayExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInternetGatewaysInput, *DescribeInternetGatewaysOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeIpamByoasn.go b/service/ec2/api_op_DescribeIpamByoasn.go index 9833a3dce2b..018ff8a953f 100644 --- a/service/ec2/api_op_DescribeIpamByoasn.go +++ b/service/ec2/api_op_DescribeIpamByoasn.go @@ -12,9 +12,10 @@ import ( ) // Describes your Autonomous System Numbers (ASNs), their provisioning statuses, -// and the BYOIP CIDRs with which they are associated. For more information, see -// Tutorial: Bring your ASN to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) +// and the BYOIP CIDRs with which they are associated. For more information, see [Tutorial: Bring your ASN to IPAM] // in the Amazon VPC IPAM guide. +// +// [Tutorial: Bring your ASN to IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html func (c *Client) DescribeIpamByoasn(ctx context.Context, params *DescribeIpamByoasnInput, optFns ...func(*Options)) (*DescribeIpamByoasnOutput, error) { if params == nil { params = &DescribeIpamByoasnInput{} diff --git a/service/ec2/api_op_DescribeIpamPools.go b/service/ec2/api_op_DescribeIpamPools.go index c40a8605080..95541d0d8c9 100644 --- a/service/ec2/api_op_DescribeIpamPools.go +++ b/service/ec2/api_op_DescribeIpamPools.go @@ -35,9 +35,9 @@ type DescribeIpamPoolsInput struct { // 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) - // . + // One or more filters for the request. For more information about filtering, see [Filtering CLI output]. + // + // [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_DescribeIpamScopes.go b/service/ec2/api_op_DescribeIpamScopes.go index b7c5219bfe6..253d5a74a69 100644 --- a/service/ec2/api_op_DescribeIpamScopes.go +++ b/service/ec2/api_op_DescribeIpamScopes.go @@ -35,9 +35,9 @@ type DescribeIpamScopesInput struct { // 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) - // . + // One or more filters for the request. For more information about filtering, see [Filtering CLI output]. + // + // [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 cf864c25c15..be2aa5fd797 100644 --- a/service/ec2/api_op_DescribeIpams.go +++ b/service/ec2/api_op_DescribeIpams.go @@ -11,8 +11,11 @@ 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?] in the Amazon VPC IPAM User Guide. +// +// [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html func (c *Client) DescribeIpams(ctx context.Context, params *DescribeIpamsInput, optFns ...func(*Options)) (*DescribeIpamsOutput, error) { if params == nil { params = &DescribeIpamsInput{} @@ -36,9 +39,9 @@ type DescribeIpamsInput struct { // 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) - // . + // One or more filters for the request. For more information about filtering, see [Filtering CLI output]. + // + // [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 3945bfa13e9..b1e01330fed 100644 --- a/service/ec2/api_op_DescribeIpv6Pools.go +++ b/service/ec2/api_op_DescribeIpv6Pools.go @@ -36,10 +36,12 @@ type DescribeIpv6PoolsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeKeyPairs.go b/service/ec2/api_op_DescribeKeyPairs.go index 89f668b9f18..683443dec10 100644 --- a/service/ec2/api_op_DescribeKeyPairs.go +++ b/service/ec2/api_op_DescribeKeyPairs.go @@ -18,9 +18,12 @@ 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] in the Amazon Elastic Compute Cloud +// User Guide. +// +// [Amazon EC2 key pairs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html func (c *Client) DescribeKeyPairs(ctx context.Context, params *DescribeKeyPairsInput, optFns ...func(*Options)) (*DescribeKeyPairsOutput, error) { if params == nil { params = &DescribeKeyPairsInput{} @@ -45,21 +48,30 @@ type DescribeKeyPairsInput struct { 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. 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. + // The key pair names. + // + // Default: Describes all of your key pairs. KeyNames []string // The IDs of the key pairs. @@ -195,12 +207,13 @@ type KeyPairExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeKeyPairsInput, *DescribeKeyPairsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeLaunchTemplateVersions.go b/service/ec2/api_op_DescribeLaunchTemplateVersions.go index 5595bd7457d..c31d60bdb38 100644 --- a/service/ec2/api_op_DescribeLaunchTemplateVersions.go +++ b/service/ec2/api_op_DescribeLaunchTemplateVersions.go @@ -39,38 +39,58 @@ type DescribeLaunchTemplateVersionsInput struct { 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. 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 launch template ID or the launch - // template name, but not both. To describe all the latest or default launch - // template versions in your account, you must omit this parameter. + // The ID of the launch template. + // + // To describe one or more versions of a specified launch template, you must + // specify either the launch template ID or the launch template name, 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 launch template name or - // the launch template ID, 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 launch template name or the launch template ID, 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 @@ -88,21 +108,30 @@ type DescribeLaunchTemplateVersionsInput struct { 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) - // in the Amazon Elastic Compute Cloud User Guide. Default: false + // 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] in the Amazon Elastic Compute Cloud User Guide. + // + // Default: false + // + // [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 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 - // 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. + // templates in your account. + // + // To describe one or more versions of a specified 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. Versions []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeLaunchTemplates.go b/service/ec2/api_op_DescribeLaunchTemplates.go index fa78c90b060..721731ef7b9 100644 --- a/service/ec2/api_op_DescribeLaunchTemplates.go +++ b/service/ec2/api_op_DescribeLaunchTemplates.go @@ -36,12 +36,16 @@ type DescribeLaunchTemplatesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go b/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go index 084a974858c..788090ec3b4 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.go @@ -37,16 +37,23 @@ type DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsInput struct 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go b/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go index c7c183f290a..4dc98ddc98e 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTableVpcAssociations.go @@ -37,14 +37,21 @@ type DescribeLocalGatewayRouteTableVpcAssociationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLocalGatewayRouteTables.go b/service/ec2/api_op_DescribeLocalGatewayRouteTables.go index e6157314963..82caacb905f 100644 --- a/service/ec2/api_op_DescribeLocalGatewayRouteTables.go +++ b/service/ec2/api_op_DescribeLocalGatewayRouteTables.go @@ -37,13 +37,19 @@ type DescribeLocalGatewayRouteTablesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go index daadcb497c9..6b1ff979298 100644 --- a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go +++ b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaceGroups.go @@ -36,10 +36,14 @@ type DescribeLocalGatewayVirtualInterfaceGroupsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go index 0db453a844b..eb4d9d8dba6 100644 --- a/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go +++ b/service/ec2/api_op_DescribeLocalGatewayVirtualInterfaces.go @@ -36,15 +36,23 @@ type DescribeLocalGatewayVirtualInterfacesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLocalGateways.go b/service/ec2/api_op_DescribeLocalGateways.go index ada2cf05934..baaefb64f71 100644 --- a/service/ec2/api_op_DescribeLocalGateways.go +++ b/service/ec2/api_op_DescribeLocalGateways.go @@ -37,10 +37,14 @@ type DescribeLocalGatewaysInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeLockedSnapshots.go b/service/ec2/api_op_DescribeLockedSnapshots.go index 0afb78cea8e..caafb3aa5cc 100644 --- a/service/ec2/api_op_DescribeLockedSnapshots.go +++ b/service/ec2/api_op_DescribeLockedSnapshots.go @@ -36,14 +36,16 @@ type DescribeLockedSnapshotsInput struct { DryRun *bool // The filters. + // // - lock-state - The state of the snapshot lock ( compliance-cooloff | // governance | compliance | expired ). 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]. + // + // [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_DescribeMacHosts.go b/service/ec2/api_op_DescribeMacHosts.go index 5c7166b6c92..2805220ff17 100644 --- a/service/ec2/api_op_DescribeMacHosts.go +++ b/service/ec2/api_op_DescribeMacHosts.go @@ -31,12 +31,14 @@ func (c *Client) DescribeMacHosts(ctx context.Context, params *DescribeMacHostsI type DescribeMacHostsInput struct { // The filters. + // // - availability-zone - The Availability Zone of the EC2 Mac Dedicated Host. + // // - instance-type - The instance type size that the EC2 Mac Dedicated Host is // configured to support. Filters []types.Filter - // The IDs of the EC2 Mac Dedicated Hosts. + // The IDs of the EC2 Mac Dedicated Hosts. HostIds []string // The maximum number of results to return for the request in a single page. The @@ -53,7 +55,7 @@ type DescribeMacHostsInput struct { type DescribeMacHostsOutput struct { - // Information about the EC2 Mac Dedicated Hosts. + // Information about the EC2 Mac Dedicated Hosts. MacHosts []types.MacHost // The token to use to retrieve the next page of results. diff --git a/service/ec2/api_op_DescribeManagedPrefixLists.go b/service/ec2/api_op_DescribeManagedPrefixLists.go index cf127131b2b..1ec89a11924 100644 --- a/service/ec2/api_op_DescribeManagedPrefixLists.go +++ b/service/ec2/api_op_DescribeManagedPrefixLists.go @@ -12,8 +12,9 @@ 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{} @@ -38,8 +39,11 @@ type DescribeManagedPrefixListsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeMovingAddresses.go b/service/ec2/api_op_DescribeMovingAddresses.go index fa37b607a3f..510c2555ca7 100644 --- a/service/ec2/api_op_DescribeMovingAddresses.go +++ b/service/ec2/api_op_DescribeMovingAddresses.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. Describes your Elastic IP addresses that are being -// moved from or being restored to the EC2-Classic platform. This request does not -// return information about any other Elastic IP addresses in your account. +// This action is deprecated. +// +// Describes your Elastic IP addresses that are being moved from or being restored +// to the EC2-Classic platform. This request does not return information about any +// other Elastic IP addresses in your account. func (c *Client) DescribeMovingAddresses(ctx context.Context, params *DescribeMovingAddressesInput, optFns ...func(*Options)) (*DescribeMovingAddressesOutput, error) { if params == nil { params = &DescribeMovingAddressesInput{} @@ -38,6 +40,7 @@ type DescribeMovingAddressesInput struct { DryRun *bool // One or more filters. + // // - moving-status - The status of the Elastic IP address ( MovingToVpc | // RestoringToClassic ). Filters []types.Filter @@ -46,6 +49,7 @@ type DescribeMovingAddressesInput struct { // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. This value can be between 5 and 1000; if // MaxResults is given a value outside of this range, an error is returned. + // // Default: If no value is provided, the default is 1000. MaxResults *int32 @@ -164,6 +168,7 @@ type DescribeMovingAddressesPaginatorOptions struct { // remaining results of the initial request can be seen by sending another request // with the returned NextToken value. This value can be between 5 and 1000; if // MaxResults is given a value outside of this range, an error is returned. + // // Default: If no value is provided, the default is 1000. Limit int32 diff --git a/service/ec2/api_op_DescribeNatGateways.go b/service/ec2/api_op_DescribeNatGateways.go index 43db24ed618..04fcb5bf326 100644 --- a/service/ec2/api_op_DescribeNatGateways.go +++ b/service/ec2/api_op_DescribeNatGateways.go @@ -42,23 +42,30 @@ type DescribeNatGatewaysInput struct { DryRun *bool // The 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. 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The IDs of the NAT gateways. @@ -175,8 +182,9 @@ 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]. + // + // [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 @@ -290,12 +298,13 @@ type NatGatewayAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNatGatewaysInput, *DescribeNatGatewaysOutput, error) (bool, error) } @@ -561,12 +570,13 @@ type NatGatewayDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNatGatewaysInput, *DescribeNatGatewaysOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeNetworkAcls.go b/service/ec2/api_op_DescribeNetworkAcls.go index af8b7ccb180..e8dd2f2d5b1 100644 --- a/service/ec2/api_op_DescribeNetworkAcls.go +++ b/service/ec2/api_op_DescribeNetworkAcls.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes one or more of your network ACLs. For more information, see Network -// ACLs (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in -// the Amazon VPC User Guide. +// Describes one or more of your network ACLs. +// +// For more information, see [Network ACLs] in the Amazon VPC User Guide. +// +// [Network ACLs]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html func (c *Client) DescribeNetworkAcls(ctx context.Context, params *DescribeNetworkAclsInput, optFns ...func(*Options)) (*DescribeNetworkAclsOutput, error) { if params == nil { params = &DescribeNetworkAclsInput{} @@ -38,43 +40,65 @@ type DescribeNetworkAclsInput struct { DryRun *bool // The 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. 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 - // The IDs of the network ACLs. Default: Describes all your network ACLs. + // The IDs of the network ACLs. + // + // Default: Describes all your network ACLs. NetworkAclIds []string // The token returned from a previous paginated request. Pagination continues from @@ -188,8 +212,9 @@ 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]. + // + // [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_DescribeNetworkInsightsAnalyses.go b/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go index ccb3ad5b566..01821f73900 100644 --- a/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go +++ b/service/ec2/api_op_DescribeNetworkInsightsAnalyses.go @@ -43,8 +43,10 @@ type DescribeNetworkInsightsAnalysesInput struct { 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). Filters []types.Filter diff --git a/service/ec2/api_op_DescribeNetworkInsightsPaths.go b/service/ec2/api_op_DescribeNetworkInsightsPaths.go index ed66b81a98a..ff2d63f8b0d 100644 --- a/service/ec2/api_op_DescribeNetworkInsightsPaths.go +++ b/service/ec2/api_op_DescribeNetworkInsightsPaths.go @@ -36,22 +36,33 @@ type DescribeNetworkInsightsPathsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeNetworkInterfacePermissions.go b/service/ec2/api_op_DescribeNetworkInterfacePermissions.go index 71b04f0e927..3f686486858 100644 --- a/service/ec2/api_op_DescribeNetworkInterfacePermissions.go +++ b/service/ec2/api_op_DescribeNetworkInterfacePermissions.go @@ -31,13 +31,18 @@ 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 ). Filters []types.Filter @@ -45,8 +50,9 @@ type DescribeNetworkInterfacePermissionsInput 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The network interface permission IDs. @@ -165,8 +171,9 @@ 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]. + // + // [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 3d580a49a44..df254cef409 100644 --- a/service/ec2/api_op_DescribeNetworkInterfaces.go +++ b/service/ec2/api_op_DescribeNetworkInterfaces.go @@ -17,12 +17,15 @@ import ( "time" ) -// Describes one or more of your network interfaces. If you have a large number of -// network interfaces, the operation fails unless you use pagination or one of the -// following filters: group-id , mac-address , private-dns-name , -// private-ip-address , private-dns-name , subnet-id , or vpc-id . We strongly -// recommend using only paginated requests. Unpaginated requests are susceptible to -// throttling and timeouts. +// Describes one or more of your network interfaces. +// +// If you have a large number of network interfaces, the operation fails unless +// you use pagination or one of the following filters: group-id , mac-address , +// private-dns-name , private-ip-address , private-dns-name , subnet-id , or vpc-id +// . +// +// We strongly recommend using only paginated requests. Unpaginated requests are +// susceptible to throttling and timeouts. func (c *Client) DescribeNetworkInterfaces(ctx context.Context, params *DescribeNetworkInterfacesInput, optFns ...func(*Options)) (*DescribeNetworkInterfacesOutput, error) { if params == nil { params = &DescribeNetworkInterfacesInput{} @@ -48,85 +51,121 @@ type DescribeNetworkInterfacesInput struct { DryRun *bool // One or more filters. + // // - association.allocation-id - The allocation ID returned when you allocated // the Elastic IP address (IPv4) for your network interface. + // // - association.association-id - The association ID returned when the network // interface was associated with an IPv4 address. + // // - addresses.association.owner-id - The owner ID of the addresses 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.primary - Whether the private IPv4 address is the primary IP // address associated with the network interface. + // // - addresses.private-ip-address - The private IPv4 addresses associated with // the 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.attach-time - The time that the network interface was attached to // an instance. + // // - attachment.attachment-id - The ID of the interface attachment. + // // - 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. + // // - 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 | ec2_instance_connect_endpoint | // efa | efs | 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. + // + // - owner-id - The Amazon Web Services account ID of the network interface owner. + // // - private-dns-name - The private DNS name of the network interface (IPv4). + // // - private-ip-address - The private IPv4 address or addresses of the network // interface. + // // - 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]. + // + // [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. + // The network interface IDs. + // + // Default: Describes all your network interfaces. NetworkInterfaceIds []string // The token returned from a previous paginated request. Pagination continues from @@ -241,8 +280,9 @@ 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]. + // + // [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 @@ -357,12 +397,13 @@ type NetworkInterfaceAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNetworkInterfacesInput, *DescribeNetworkInterfacesOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribePlacementGroups.go b/service/ec2/api_op_DescribePlacementGroups.go index 3dd29c31270..42de38605b3 100644 --- a/service/ec2/api_op_DescribePlacementGroups.go +++ b/service/ec2/api_op_DescribePlacementGroups.go @@ -12,8 +12,9 @@ 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]in the Amazon EC2 User Guide. +// +// [Placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html func (c *Client) DescribePlacementGroups(ctx context.Context, params *DescribePlacementGroupsInput, optFns ...func(*Options)) (*DescribePlacementGroupsOutput, error) { if params == nil { params = &DescribePlacementGroupsInput{} @@ -38,17 +39,24 @@ type DescribePlacementGroupsInput struct { 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. Filters []types.Filter @@ -56,8 +64,9 @@ type DescribePlacementGroupsInput struct { // 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 c919d3eaf72..6dfe8480c75 100644 --- a/service/ec2/api_op_DescribePrefixLists.go +++ b/service/ec2/api_op_DescribePrefixLists.go @@ -13,8 +13,9 @@ import ( // Describes available Amazon Web Services services in a prefix list format, which // includes the prefix list name and prefix list ID of the service and the IP -// address range for the service. We recommend that you use -// DescribeManagedPrefixLists instead. +// address range for the service. +// +// We recommend that you use DescribeManagedPrefixLists instead. func (c *Client) DescribePrefixLists(ctx context.Context, params *DescribePrefixListsInput, optFns ...func(*Options)) (*DescribePrefixListsOutput, error) { if params == nil { params = &DescribePrefixListsInput{} @@ -39,7 +40,9 @@ type DescribePrefixListsInput struct { DryRun *bool // One or more filters. + // // - prefix-list-id : The ID of a prefix list. + // // - prefix-list-name : The name of a prefix list. Filters []types.Filter diff --git a/service/ec2/api_op_DescribePrincipalIdFormat.go b/service/ec2/api_op_DescribePrincipalIdFormat.go index 57d37f4d581..2c7a0bc14ee 100644 --- a/service/ec2/api_op_DescribePrincipalIdFormat.go +++ b/service/ec2/api_op_DescribePrincipalIdFormat.go @@ -13,14 +13,17 @@ import ( // Describes the ID format settings for the root user and all IAM roles and IAM // users that have explicitly specified a longer ID (17-character ID) preference. +// // By default, all IAM roles and IAM users default to the same ID settings as the // root user, unless they explicitly override the settings. This request is useful // for identifying those IAM users and IAM roles that have overridden the default -// 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 | +// 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 | // 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 . diff --git a/service/ec2/api_op_DescribePublicIpv4Pools.go b/service/ec2/api_op_DescribePublicIpv4Pools.go index aaebc9e8503..8dd35f2d9d0 100644 --- a/service/ec2/api_op_DescribePublicIpv4Pools.go +++ b/service/ec2/api_op_DescribePublicIpv4Pools.go @@ -30,10 +30,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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeRegions.go b/service/ec2/api_op_DescribeRegions.go index 6b31afb864d..b1475cf62c5 100644 --- a/service/ec2/api_op_DescribeRegions.go +++ b/service/ec2/api_op_DescribeRegions.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. The order of the elements in the -// response, including those within nested structures, might vary. Applications -// should not assume the elements appear in a particular order. +// 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]. +// +// For information about enabling and disabling Regions for your account, see [Managing Amazon Web Services Regions] in +// the Amazon Web Services General Reference. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Managing Amazon Web Services Regions]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html +// [Amazon Elastic Compute Cloud endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/ec2-service.html func (c *Client) DescribeRegions(ctx context.Context, params *DescribeRegionsInput, optFns ...func(*Options)) (*DescribeRegionsOutput, error) { if params == nil { params = &DescribeRegionsInput{} @@ -47,10 +52,13 @@ type DescribeRegionsInput struct { 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 ). Filters []types.Filter diff --git a/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go b/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go index a3d31fee5ae..267b4a0d0b7 100644 --- a/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go +++ b/service/ec2/api_op_DescribeReplaceRootVolumeTasks.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Describes a root volume replacement task. For more information, see [Replace a root volume] in the +// Amazon Elastic Compute Cloud User Guide. +// +// [Replace a root volume]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html func (c *Client) DescribeReplaceRootVolumeTasks(ctx context.Context, params *DescribeReplaceRootVolumeTasksInput, optFns ...func(*Options)) (*DescribeReplaceRootVolumeTasksOutput, error) { if params == nil { params = &DescribeReplaceRootVolumeTasksInput{} @@ -38,14 +39,16 @@ type DescribeReplaceRootVolumeTasksInput struct { DryRun *bool // Filter to use: + // // - 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]. + // + // [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 @@ -162,8 +165,9 @@ 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]. + // + // [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 25f6c001f1d..6be9e39f07d 100644 --- a/service/ec2/api_op_DescribeReservedInstances.go +++ b/service/ec2/api_op_DescribeReservedInstances.go @@ -11,11 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon EC2 User Guide. The order of the elements in the response, -// including those within nested structures, might vary. Applications should not -// assume the elements appear in a particular order. +// Describes one or more of the Reserved Instances that you purchased. +// +// For more information about Reserved Instances, see [Reserved Instances] in the Amazon EC2 User +// Guide. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Reserved Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html func (c *Client) DescribeReservedInstances(ctx context.Context, params *DescribeReservedInstancesInput, optFns ...func(*Options)) (*DescribeReservedInstancesOutput, error) { if params == nil { params = &DescribeReservedInstancesInput{} @@ -41,32 +46,45 @@ type DescribeReservedInstancesInput struct { 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 ( // Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | // Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | // Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard // | Windows with SQL Server Web | Windows with SQL Server Enterprise ). + // // - 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 @@ -79,8 +97,10 @@ type DescribeReservedInstancesInput struct { // Instance offering type. OfferingType types.OfferingTypeValues - // One or more Reserved Instance IDs. Default: Describes all your Reserved - // Instances, or only those otherwise specified. + // One or more Reserved Instance IDs. + // + // Default: Describes all your Reserved Instances, or only those otherwise + // specified. ReservedInstancesIds []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DescribeReservedInstancesListings.go b/service/ec2/api_op_DescribeReservedInstancesListings.go index f796c675d0d..99e2e669130 100644 --- a/service/ec2/api_op_DescribeReservedInstancesListings.go +++ b/service/ec2/api_op_DescribeReservedInstancesListings.go @@ -12,22 +12,31 @@ import ( ) // Describes your account's Reserved Instance listings in the Reserved Instance -// Marketplace. The Reserved Instance Marketplace matches sellers who want to -// resell Reserved Instance capacity that they no longer need with buyers who want -// to purchase additional capacity. Reserved Instances bought and sold through the -// Reserved Instance Marketplace work like any other Reserved Instances. As a -// seller, you choose to list some or all of your Reserved Instances, and you +// Marketplace. +// +// The Reserved Instance Marketplace matches sellers who want to resell Reserved +// Instance capacity that they no longer need with buyers who want to purchase +// additional capacity. Reserved Instances bought and sold through the Reserved +// Instance Marketplace work like any other Reserved Instances. +// +// As a seller, you choose to list some or all of your Reserved Instances, and you // specify the upfront price to receive for them. Your Reserved Instances are then -// listed in the Reserved Instance Marketplace and are available for purchase. As a -// buyer, you specify the configuration of the Reserved Instance to purchase, and -// the Marketplace matches what you're searching for with what's available. The +// listed in the Reserved Instance Marketplace and are available for purchase. +// +// As a buyer, you specify the configuration of the Reserved Instance to purchase, +// and the Marketplace matches what you're searching for with what's available. The // 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. The order of the elements in the response, -// including those within nested structures, might vary. Applications should not -// assume the elements appear in a particular order. +// purchase. +// +// For more information, see [Reserved Instance Marketplace] in the Amazon EC2 User Guide. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Reserved Instance Marketplace]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html func (c *Client) DescribeReservedInstancesListings(ctx context.Context, params *DescribeReservedInstancesListingsInput, optFns ...func(*Options)) (*DescribeReservedInstancesListingsOutput, error) { if params == nil { params = &DescribeReservedInstancesListingsInput{} @@ -47,10 +56,14 @@ 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeReservedInstancesModifications.go b/service/ec2/api_op_DescribeReservedInstancesModifications.go index e42d91bdfa3..a0e69151e52 100644 --- a/service/ec2/api_op_DescribeReservedInstancesModifications.go +++ b/service/ec2/api_op_DescribeReservedInstancesModifications.go @@ -14,11 +14,15 @@ import ( // Describes the modifications made to your Reserved Instances. If no parameter is // 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. The order of the elements in the response, -// including those within nested structures, might vary. Applications should not -// assume the elements appear in a particular order. +// specific modification is returned. +// +// For more information, see [Modifying Reserved Instances] in the Amazon EC2 User Guide. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Modifying Reserved Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html func (c *Client) DescribeReservedInstancesModifications(ctx context.Context, params *DescribeReservedInstancesModificationsInput, optFns ...func(*Options)) (*DescribeReservedInstancesModificationsOutput, error) { if params == nil { params = &DescribeReservedInstancesModificationsInput{} @@ -38,23 +42,35 @@ 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. + // // - 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 diff --git a/service/ec2/api_op_DescribeReservedInstancesOfferings.go b/service/ec2/api_op_DescribeReservedInstancesOfferings.go index db6bbf24650..4a7a751bf9c 100644 --- a/service/ec2/api_op_DescribeReservedInstancesOfferings.go +++ b/service/ec2/api_op_DescribeReservedInstancesOfferings.go @@ -15,13 +15,19 @@ import ( // Reserved Instances, you purchase the right to launch instances for a period of // time. During that time period, you do not receive insufficient capacity errors, // and you pay a lower usage rate than the rate charged for On-Demand instances for -// 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. The order of the elements in the response, -// including those within nested structures, might vary. Applications should not -// assume the elements appear in a particular order. +// 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] in the Amazon EC2 User Guide. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Reserved Instance Marketplace]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html func (c *Client) DescribeReservedInstancesOfferings(ctx context.Context, params *DescribeReservedInstancesOfferingsInput, optFns ...func(*Options)) (*DescribeReservedInstancesOfferingsOutput, error) { if params == nil { params = &DescribeReservedInstancesOfferingsInput{} @@ -50,24 +56,33 @@ type DescribeReservedInstancesOfferingsInput struct { 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 ( // Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | // Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | // Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard // | Windows with SQL Server Web | Windows with SQL Server Enterprise ). + // // - 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 @@ -77,30 +92,39 @@ type DescribeReservedInstancesOfferingsInput struct { // The tenancy of the instances covered by the reservation. A Reserved Instance // with a tenancy of dedicated is applied to instances that run in a VPC on - // single-tenant hardware (i.e., Dedicated Instances). Important: The host value - // cannot be used with this parameter. Use the default or dedicated values only. + // single-tenant hardware (i.e., Dedicated Instances). + // + // Important: The host value cannot be used with this parameter. Use the default + // or dedicated values only. + // // 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. + // more information, see [Instance types]in the Amazon EC2 User Guide. + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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 MaxInstanceCount *int32 // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request - // with the returned NextToken value. The maximum is 100. Default: 100 + // with the returned NextToken value. The maximum is 100. + // + // Default: 100 MaxResults *int32 // The minimum duration (in seconds) to filter when searching for offerings. + // // Default: 2592000 (1 month) MinDuration *int64 @@ -230,7 +254,9 @@ var _ DescribeReservedInstancesOfferingsAPIClient = (*Client)(nil) type DescribeReservedInstancesOfferingsPaginatorOptions struct { // The maximum number of results to return for the request in a single page. The // remaining results of the initial request can be seen by sending another request - // with the returned NextToken value. The maximum is 100. Default: 100 + // with the returned NextToken value. The maximum is 100. + // + // Default: 100 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ec2/api_op_DescribeRouteTables.go b/service/ec2/api_op_DescribeRouteTables.go index 2978405282b..13770ae746f 100644 --- a/service/ec2/api_op_DescribeRouteTables.go +++ b/service/ec2/api_op_DescribeRouteTables.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes one or more of your route tables. Each subnet in your VPC must be -// 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 VPC User Guide. +// Describes one or more of your route tables. +// +// Each subnet in your VPC must be 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] in the Amazon VPC User Guide. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) DescribeRouteTables(ctx context.Context, params *DescribeRouteTablesInput, optFns ...func(*Options)) (*DescribeRouteTablesOutput, error) { if params == nil { params = &DescribeRouteTablesInput{} @@ -41,61 +45,85 @@ type DescribeRouteTablesInput struct { DryRun *bool // The filters. + // // - association.gateway-id - The ID of the gateway involved in the association. + // // - 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]. + // + // [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 // the end of the items returned by the previous request. NextToken *string - // The IDs of the route tables. Default: Describes all your route tables. + // The IDs of the route tables. + // + // Default: Describes all your route tables. RouteTableIds []string noSmithyDocumentSerde @@ -206,8 +234,9 @@ 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]. + // + // [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 bed8d95be4a..71f3ba7c4a4 100644 --- a/service/ec2/api_op_DescribeScheduledInstanceAvailability.go +++ b/service/ec2/api_op_DescribeScheduledInstanceAvailability.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Finds available schedules that meet the specified criteria. You can search for -// an available schedule no more than 3 months in advance. You must meet the -// 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. +// Finds available schedules that meet the specified criteria. +// +// You can search for an available schedule no more than 3 months in advance. You +// must meet the 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. func (c *Client) DescribeScheduledInstanceAvailability(ctx context.Context, params *DescribeScheduledInstanceAvailabilityInput, optFns ...func(*Options)) (*DescribeScheduledInstanceAvailabilityOutput, error) { if params == nil { params = &DescribeScheduledInstanceAvailabilityInput{} @@ -53,8 +55,11 @@ type DescribeScheduledInstanceAvailabilityInput struct { DryRun *bool // The filters. + // // - availability-zone - The Availability Zone (for example, us-west-2a ). + // // - instance-type - The instance type (for example, c4.large ). + // // - platform - The platform ( Linux/UNIX or Windows ). Filters []types.Filter diff --git a/service/ec2/api_op_DescribeScheduledInstances.go b/service/ec2/api_op_DescribeScheduledInstances.go index 5f6a9bc4b8e..f56940d48ad 100644 --- a/service/ec2/api_op_DescribeScheduledInstances.go +++ b/service/ec2/api_op_DescribeScheduledInstances.go @@ -37,8 +37,11 @@ type DescribeScheduledInstancesInput struct { DryRun *bool // The filters. + // // - availability-zone - The Availability Zone (for example, us-west-2a ). + // // - instance-type - The instance type (for example, c4.large ). + // // - platform - The platform ( Linux/UNIX or Windows ). Filters []types.Filter diff --git a/service/ec2/api_op_DescribeSecurityGroupRules.go b/service/ec2/api_op_DescribeSecurityGroupRules.go index 7183ab4227c..c75cb654cf1 100644 --- a/service/ec2/api_op_DescribeSecurityGroupRules.go +++ b/service/ec2/api_op_DescribeSecurityGroupRules.go @@ -36,8 +36,11 @@ type DescribeSecurityGroupRulesInput struct { 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 , @@ -47,8 +50,9 @@ type DescribeSecurityGroupRulesInput 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]. + // + // [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 @@ -166,8 +170,9 @@ 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]. + // + // [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 7e32a368f2b..b87a77ed340 100644 --- a/service/ec2/api_op_DescribeSecurityGroups.go +++ b/service/ec2/api_op_DescribeSecurityGroups.go @@ -45,69 +45,98 @@ type DescribeSecurityGroupsInput struct { // 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. Filters []types.Filter // The IDs of the security groups. Required for security groups in a nondefault - // VPC. Default: Describes all of your security groups. + // VPC. + // + // Default: Describes all of your security groups. GroupIds []string // [Default VPC] The names of the security groups. You can specify either the - // security group name or the security group ID. Default: Describes all of your - // security groups. + // security group name or the security group ID. + // + // Default: Describes all of your security groups. GroupNames []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. 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]. + // + // [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 @@ -222,8 +251,9 @@ 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]. + // + // [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,12 +367,13 @@ type SecurityGroupExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeSecurityGroupsInput, *DescribeSecurityGroupsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeSnapshotAttribute.go b/service/ec2/api_op_DescribeSnapshotAttribute.go index dbea93ccbb9..07c91227b92 100644 --- a/service/ec2/api_op_DescribeSnapshotAttribute.go +++ b/service/ec2/api_op_DescribeSnapshotAttribute.go @@ -12,9 +12,11 @@ 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/ebs/latest/userguide/ebs-snapshots.html) -// in the Amazon EBS User Guide. +// only one attribute at a time. +// +// For more information about EBS snapshots, see [Amazon EBS snapshots] in the Amazon EBS User Guide. +// +// [Amazon EBS snapshots]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshots.html func (c *Client) DescribeSnapshotAttribute(ctx context.Context, params *DescribeSnapshotAttributeInput, optFns ...func(*Options)) (*DescribeSnapshotAttributeOutput, error) { if params == nil { params = &DescribeSnapshotAttributeInput{} diff --git a/service/ec2/api_op_DescribeSnapshotTierStatus.go b/service/ec2/api_op_DescribeSnapshotTierStatus.go index a9380f94bb4..4bf101f3a36 100644 --- a/service/ec2/api_op_DescribeSnapshotTierStatus.go +++ b/service/ec2/api_op_DescribeSnapshotTierStatus.go @@ -36,8 +36,11 @@ type DescribeSnapshotTierStatusInput struct { 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 | @@ -47,8 +50,9 @@ type DescribeSnapshotTierStatusInput 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]. + // + // [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 @@ -162,8 +166,9 @@ 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]. + // + // [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 9f5570de7d2..e9ff5de8a79 100644 --- a/service/ec2/api_op_DescribeSnapshots.go +++ b/service/ec2/api_op_DescribeSnapshots.go @@ -16,40 +16,57 @@ import ( ) // Describes the specified EBS snapshots available to you or all of the EBS -// 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: +// 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: +// // - 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/ebs/latest/userguide/ebs-snapshots.html) -// in the Amazon EBS User Guide. We strongly recommend using only paginated -// requests. Unpaginated requests are susceptible to throttling and timeouts. +// 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]. +// +// To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores. +// +// For more information about EBS snapshots, see [Amazon EBS snapshots] in the Amazon EBS User Guide. +// +// We strongly recommend using only paginated requests. Unpaginated requests are +// susceptible to throttling and timeouts. +// +// [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination +// [Amazon EBS snapshots]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshots.html func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) { if params == nil { params = &DescribeSnapshotsInput{} @@ -74,26 +91,39 @@ type DescribeSnapshotsInput struct { 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. Filters []types.Filter @@ -101,8 +131,9 @@ type DescribeSnapshotsInput 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]. + // + // [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 @@ -117,8 +148,9 @@ type DescribeSnapshotsInput struct { // snapshot. RestorableByUserIds []string - // The snapshot IDs. Default: Describes the snapshots for which you have create - // volume permissions. + // The snapshot IDs. + // + // Default: Describes the snapshots for which you have create volume permissions. SnapshotIds []string noSmithyDocumentSerde @@ -229,8 +261,9 @@ 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]. + // + // [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 @@ -342,12 +375,13 @@ type SnapshotCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeSnapshotsInput, *DescribeSnapshotsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeSpotDatafeedSubscription.go b/service/ec2/api_op_DescribeSpotDatafeedSubscription.go index a4599c99ce7..6ffc7d4110d 100644 --- a/service/ec2/api_op_DescribeSpotDatafeedSubscription.go +++ b/service/ec2/api_op_DescribeSpotDatafeedSubscription.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Describes the data feed for Spot Instances. For more information, see [Spot Instance data feed] in the +// Amazon EC2 User Guide for Linux Instances. +// +// [Spot Instance data feed]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html func (c *Client) DescribeSpotDatafeedSubscription(ctx context.Context, params *DescribeSpotDatafeedSubscriptionInput, optFns ...func(*Options)) (*DescribeSpotDatafeedSubscriptionOutput, error) { if params == nil { params = &DescribeSpotDatafeedSubscriptionInput{} diff --git a/service/ec2/api_op_DescribeSpotFleetInstances.go b/service/ec2/api_op_DescribeSpotFleetInstances.go index ba3a2315944..414821a77d6 100644 --- a/service/ec2/api_op_DescribeSpotFleetInstances.go +++ b/service/ec2/api_op_DescribeSpotFleetInstances.go @@ -43,8 +43,9 @@ type DescribeSpotFleetInstancesInput 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]. + // + // [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 e58c39168b7..cf371cc6f75 100644 --- a/service/ec2/api_op_DescribeSpotFleetRequestHistory.go +++ b/service/ec2/api_op_DescribeSpotFleetRequestHistory.go @@ -13,11 +13,15 @@ import ( ) // Describes the events for the specified Spot Fleet request during the specified -// 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. +// 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] in the Amazon EC2 User Guide. +// +// [Monitor fleet events using Amazon EventBridge]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html func (c *Client) DescribeSpotFleetRequestHistory(ctx context.Context, params *DescribeSpotFleetRequestHistoryInput, optFns ...func(*Options)) (*DescribeSpotFleetRequestHistoryOutput, error) { if params == nil { params = &DescribeSpotFleetRequestHistoryInput{} @@ -58,8 +62,9 @@ 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]. + // + // [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 @@ -76,8 +81,9 @@ type DescribeSpotFleetRequestHistoryOutput struct { HistoryRecords []types.HistoryRecord // The last date and time for the events, in UTC format (for example, - // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. If nextToken - // indicates that there are more items, this value is not present. + // YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved. + // + // If nextToken indicates that there are more items, this value is not present. LastEvaluatedTime *time.Time // 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 5e4ca9d8bad..27e51b8e537 100644 --- a/service/ec2/api_op_DescribeSpotFleetRequests.go +++ b/service/ec2/api_op_DescribeSpotFleetRequests.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours -// after they are canceled and their instances are terminated. +// Describes your Spot Fleet requests. +// +// Spot Fleet requests are deleted 48 hours after they are canceled and their +// instances are terminated. func (c *Client) DescribeSpotFleetRequests(ctx context.Context, params *DescribeSpotFleetRequestsInput, optFns ...func(*Options)) (*DescribeSpotFleetRequestsOutput, error) { if params == nil { params = &DescribeSpotFleetRequestsInput{} @@ -39,8 +41,9 @@ type DescribeSpotFleetRequestsInput 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]. + // + // [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 @@ -158,8 +161,9 @@ 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]. + // + // [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 618f451b9e0..06daa8bfebf 100644 --- a/service/ec2/api_op_DescribeSpotInstanceRequests.go +++ b/service/ec2/api_op_DescribeSpotInstanceRequests.go @@ -17,19 +17,25 @@ import ( "time" ) -// 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 -// 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 -// recommend that you set MaxResults to a value between 5 and 1000 to limit the +// 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 appears in the response and contains the identifier of the instance. +// Alternatively, you can use [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 -// after they are canceled and their instances are terminated. +// to retrieve the remaining items. +// +// Spot Instance requests are deleted four hours after they are canceled and their +// instances are terminated. +// +// [DescribeInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances func (c *Client) DescribeSpotInstanceRequests(ctx context.Context, params *DescribeSpotInstanceRequestsInput, optFns ...func(*Options)) (*DescribeSpotInstanceRequestsOutput, error) { if params == nil { params = &DescribeSpotInstanceRequestsInput{} @@ -55,76 +61,116 @@ type DescribeSpotInstanceRequestsInput struct { DryRun *bool // The 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-size - The size of the EBS volume, in GiB. + // // - launch.block-device-mapping.volume-type - The type of EBS volume: gp2 or gp3 // 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. + // Amazon EC2 Spot Instance requests. For more information, see [Spot request status]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. + // + // [Spot request status]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html 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]. + // + // [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 +288,9 @@ 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]. + // + // [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 @@ -359,12 +406,13 @@ type SpotInstanceRequestFulfilledWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeSpotInstanceRequestsInput, *DescribeSpotInstanceRequestsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeSpotPriceHistory.go b/service/ec2/api_op_DescribeSpotPriceHistory.go index 2b5e7ba8060..b79b3d0f05b 100644 --- a/service/ec2/api_op_DescribeSpotPriceHistory.go +++ b/service/ec2/api_op_DescribeSpotPriceHistory.go @@ -12,12 +12,14 @@ import ( "time" ) -// 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) -// 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 -// is the effective price as of the start time. +// Describes the Spot price history. For more information, see [Spot Instance pricing history] 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 is the effective price as of the start time. +// +// [Spot Instance pricing history]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html func (c *Client) DescribeSpotPriceHistory(ctx context.Context, params *DescribeSpotPriceHistoryInput, optFns ...func(*Options)) (*DescribeSpotPriceHistoryOutput, error) { if params == nil { params = &DescribeSpotPriceHistoryInput{} @@ -50,15 +52,20 @@ type DescribeSpotPriceHistoryInput struct { EndTime *time.Time // The 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, ddd MMM dd HH:mm:ss UTC YYYY). You can use wildcards ( * and ? ). // Greater than or less than comparison is not supported. @@ -69,8 +76,9 @@ 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]. + // + // [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 +200,9 @@ 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]. + // + // [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 c70d8ad455d..11e60ccbd9f 100644 --- a/service/ec2/api_op_DescribeStaleSecurityGroups.go +++ b/service/ec2/api_op_DescribeStaleSecurityGroups.go @@ -45,8 +45,9 @@ type DescribeStaleSecurityGroupsInput 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]. + // + // [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 @@ -163,8 +164,9 @@ 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]. + // + // [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 d4f1d283e75..5944f144d20 100644 --- a/service/ec2/api_op_DescribeStoreImageTasks.go +++ b/service/ec2/api_op_DescribeStoreImageTasks.go @@ -17,15 +17,22 @@ 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. +// 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]in the Amazon EC2 User Guide. +// +// For more information, see [Store and restore an AMI using Amazon S3] in the Amazon EC2 User Guide. +// +// [Store and restore an AMI using Amazon S3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html +// [Permissions for storing and restoring AMIs using Amazon S3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions func (c *Client) DescribeStoreImageTasks(ctx context.Context, params *DescribeStoreImageTasksInput, optFns ...func(*Options)) (*DescribeStoreImageTasksOutput, error) { if params == nil { params = &DescribeStoreImageTasksInput{} @@ -50,10 +57,13 @@ type DescribeStoreImageTasksInput struct { 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. + // // When you specify the ImageIds parameter, any filters that you specify are // ignored. To use the filters, you must remove the ImageIds parameter. Filters []types.Filter @@ -64,8 +74,11 @@ 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]. + // + // You cannot specify this parameter and the ImageIds parameter in the same call. + // + // [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 @@ -179,8 +192,11 @@ 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]. + // + // You cannot specify this parameter and the ImageIds parameter in the same call. + // + // [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 @@ -295,12 +311,13 @@ type StoreImageTaskCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStoreImageTasksInput, *DescribeStoreImageTasksOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeSubnets.go b/service/ec2/api_op_DescribeSubnets.go index 7dd8c2649d4..7be47ecfae2 100644 --- a/service/ec2/api_op_DescribeSubnets.go +++ b/service/ec2/api_op_DescribeSubnets.go @@ -15,8 +15,11 @@ import ( "time" ) -// Describes one or more of your subnets. For more information, see Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) -// in the Amazon VPC User Guide. +// Describes one or more of your subnets. +// +// For more information, see [Subnets] in the Amazon VPC User Guide. +// +// [Subnets]: https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html func (c *Client) DescribeSubnets(ctx context.Context, params *DescribeSubnetsInput, optFns ...func(*Options)) (*DescribeSubnetsOutput, error) { if params == nil { params = &DescribeSubnetsInput{} @@ -41,75 +44,102 @@ type DescribeSubnetsInput struct { DryRun *bool // The 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 - // ). + // + // - 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. + // 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]. + // + // [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 // the end of the items returned by the previous request. NextToken *string - // The IDs of the subnets. Default: Describes all your subnets. + // The IDs of the subnets. + // + // Default: Describes all your subnets. SubnetIds []string noSmithyDocumentSerde @@ -218,8 +248,9 @@ 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]. + // + // [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 @@ -331,12 +362,13 @@ type SubnetAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeSubnetsInput, *DescribeSubnetsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeTags.go b/service/ec2/api_op_DescribeTags.go index 9a4c61ea81f..680efb45719 100644 --- a/service/ec2/api_op_DescribeTags.go +++ b/service/ec2/api_op_DescribeTags.go @@ -11,13 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. We strongly recommend using only -// paginated requests. Unpaginated requests are susceptible to throttling and -// timeouts. The order of the elements in the response, including those within -// nested structures, might vary. Applications should not assume the elements -// appear in a particular order. +// Describes the specified tags for your EC2 resources. +// +// For more information about tags, see [Tag your Amazon EC2 resources] in the Amazon Elastic Compute Cloud User +// Guide. +// +// We strongly recommend using only paginated requests. Unpaginated requests are +// susceptible to throttling and timeouts. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error) { if params == nil { params = &DescribeTagsInput{} @@ -42,21 +48,27 @@ type DescribeTagsInput struct { DryRun *bool // The filters. + // // - key - The tag key. + // // - resource-id - The ID of the resource. - // - resource-type - The resource type. For a list of possible values, see - // TagSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TagSpecification.html) - // . + // + // - resource-type - The resource type. For a list of possible values, see [TagSpecification]. + // // - 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. + // + // [TagSpecification]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TagSpecification.html 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]. + // + // [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 @@ -168,8 +180,9 @@ 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]. + // + // [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 b01f361eca0..7dd2a5bc712 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorFilters.go +++ b/service/ec2/api_op_DescribeTrafficMirrorFilters.go @@ -36,7 +36,9 @@ type DescribeTrafficMirrorFiltersInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTrafficMirrorSessions.go b/service/ec2/api_op_DescribeTrafficMirrorSessions.go index 9b9b6bb6412..7e1605515d0 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorSessions.go +++ b/service/ec2/api_op_DescribeTrafficMirrorSessions.go @@ -37,15 +37,24 @@ type DescribeTrafficMirrorSessionsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTrafficMirrorTargets.go b/service/ec2/api_op_DescribeTrafficMirrorTargets.go index 85a105d2721..df42fc3e2ff 100644 --- a/service/ec2/api_op_DescribeTrafficMirrorTargets.go +++ b/service/ec2/api_op_DescribeTrafficMirrorTargets.go @@ -36,12 +36,17 @@ type DescribeTrafficMirrorTargetsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayAttachments.go b/service/ec2/api_op_DescribeTransitGatewayAttachments.go index 7e390d8890a..a66bae9bceb 100644 --- a/service/ec2/api_op_DescribeTransitGatewayAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayAttachments.go @@ -38,20 +38,29 @@ type DescribeTransitGatewayAttachmentsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go b/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go index 8db87e7f169..dc46fcac3d1 100644 --- a/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go +++ b/service/ec2/api_op_DescribeTransitGatewayConnectPeers.go @@ -36,9 +36,12 @@ type DescribeTransitGatewayConnectPeersInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayConnects.go b/service/ec2/api_op_DescribeTransitGatewayConnects.go index 70f4884a547..546ecfafdff 100644 --- a/service/ec2/api_op_DescribeTransitGatewayConnects.go +++ b/service/ec2/api_op_DescribeTransitGatewayConnects.go @@ -36,12 +36,17 @@ type DescribeTransitGatewayConnectsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go b/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go index 2b36f14e722..f7a6a127923 100644 --- a/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go +++ b/service/ec2/api_op_DescribeTransitGatewayMulticastDomains.go @@ -36,9 +36,12 @@ type DescribeTransitGatewayMulticastDomainsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go b/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go index 2aae4b3e7e7..e93b908259b 100644 --- a/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayPeeringAttachments.go @@ -36,19 +36,26 @@ type DescribeTransitGatewayPeeringAttachmentsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayRouteTables.go b/service/ec2/api_op_DescribeTransitGatewayRouteTables.go index dda2d849206..92a0ec19fc1 100644 --- a/service/ec2/api_op_DescribeTransitGatewayRouteTables.go +++ b/service/ec2/api_op_DescribeTransitGatewayRouteTables.go @@ -37,13 +37,18 @@ type DescribeTransitGatewayRouteTablesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go b/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go index f2b05ebde5f..0d270fadab2 100644 --- a/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go +++ b/service/ec2/api_op_DescribeTransitGatewayVpcAttachments.go @@ -37,11 +37,15 @@ type DescribeTransitGatewayVpcAttachmentsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeTransitGateways.go b/service/ec2/api_op_DescribeTransitGateways.go index eb811b7000b..903751ac9bd 100644 --- a/service/ec2/api_op_DescribeTransitGateways.go +++ b/service/ec2/api_op_DescribeTransitGateways.go @@ -37,29 +37,41 @@ type DescribeTransitGatewaysInput struct { 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. + // // - tag-key - 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 diff --git a/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go b/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go index c9591eadf18..d993de6274c 100644 --- a/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go +++ b/service/ec2/api_op_DescribeTrunkInterfaceAssociations.go @@ -39,7 +39,9 @@ type DescribeTrunkInterfaceAssociationsInput struct { 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 . Filters []types.Filter diff --git a/service/ec2/api_op_DescribeVolumeAttribute.go b/service/ec2/api_op_DescribeVolumeAttribute.go index 34667cca944..34ee2292fc5 100644 --- a/service/ec2/api_op_DescribeVolumeAttribute.go +++ b/service/ec2/api_op_DescribeVolumeAttribute.go @@ -12,9 +12,11 @@ import ( ) // Describes the specified attribute of the specified volume. You can specify only -// one attribute at a time. For more information about EBS volumes, see Amazon EBS -// volumes (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html) in -// the Amazon EBS User Guide. +// one attribute at a time. +// +// For more information about EBS volumes, see [Amazon EBS volumes] in the Amazon EBS User Guide. +// +// [Amazon EBS volumes]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html func (c *Client) DescribeVolumeAttribute(ctx context.Context, params *DescribeVolumeAttributeInput, optFns ...func(*Options)) (*DescribeVolumeAttributeOutput, error) { if params == nil { params = &DescribeVolumeAttributeInput{} diff --git a/service/ec2/api_op_DescribeVolumeStatus.go b/service/ec2/api_op_DescribeVolumeStatus.go index baf13132904..5f3cb3d2bca 100644 --- a/service/ec2/api_op_DescribeVolumeStatus.go +++ b/service/ec2/api_op_DescribeVolumeStatus.go @@ -18,29 +18,39 @@ import ( // 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/ebs/latest/userguide/monitoring-volume-status.html) -// in the Amazon EBS 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 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 +// 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]in the Amazon EBS 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 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 by calling -// the EnableVolumeIO action and then check the volume for data consistency. +// the EnableVolumeIOaction 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 in the error -// state (for example, when a volume is incapable of accepting I/O.) The order of -// the elements in the response, including those within nested structures, might -// vary. Applications should not assume the elements appear in a particular order. +// state (for example, when a volume is incapable of accepting I/O.) +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Monitor the status of your volumes]: https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-status.html func (c *Client) DescribeVolumeStatus(ctx context.Context, params *DescribeVolumeStatusInput, optFns ...func(*Options)) (*DescribeVolumeStatusOutput, error) { if params == nil { params = &DescribeVolumeStatusInput{} @@ -65,23 +75,34 @@ type DescribeVolumeStatusInput struct { DryRun *bool // The filters. - // - action.code - The action code for the event (for example, enable-volume-io - // ). + // + // - 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 @@ -91,15 +112,18 @@ 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]. + // + // [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 // the end of the items returned by the previous request. NextToken *string - // The IDs of the volumes. Default: Describes all your volumes. + // The IDs of the volumes. + // + // Default: Describes all your volumes. VolumeIds []string noSmithyDocumentSerde @@ -212,8 +236,9 @@ 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]. + // + // [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 a6537375d25..e2a8b2e8fac 100644 --- a/service/ec2/api_op_DescribeVolumes.go +++ b/service/ec2/api_op_DescribeVolumes.go @@ -17,15 +17,22 @@ import ( "time" ) -// 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/ebs/latest/userguide/ebs-volumes.html) -// in the Amazon EBS User Guide. We strongly recommend using only paginated -// requests. Unpaginated requests are susceptible to throttling and timeouts. The -// order of the elements in the response, including those within nested structures, -// might vary. Applications should not assume the elements appear in a particular -// order. +// 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]. +// +// For more information about EBS volumes, see [Amazon EBS volumes] in the Amazon EBS User Guide. +// +// We strongly recommend using only paginated requests. Unpaginated requests are +// susceptible to throttling and timeouts. +// +// The order of the elements in the response, including those within nested +// structures, might vary. Applications should not assume the elements appear in a +// particular order. +// +// [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination +// [Amazon EBS volumes]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInput, optFns ...func(*Options)) (*DescribeVolumesOutput, error) { if params == nil { params = &DescribeVolumesInput{} @@ -50,32 +57,49 @@ type DescribeVolumesInput struct { 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 ) Filters []types.Filter @@ -84,8 +108,9 @@ type DescribeVolumesInput 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]. + // + // [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 @@ -203,8 +228,9 @@ 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]. + // + // [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 @@ -316,12 +342,13 @@ type VolumeAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVolumesInput, *DescribeVolumesOutput, error) (bool, error) } @@ -527,12 +554,13 @@ type VolumeDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVolumesInput, *DescribeVolumesOutput, error) (bool, error) } @@ -726,12 +754,13 @@ type VolumeInUseWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVolumesInput, *DescribeVolumesOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeVolumesModifications.go b/service/ec2/api_op_DescribeVolumesModifications.go index 496b5d7373c..3bd1a013e59 100644 --- a/service/ec2/api_op_DescribeVolumesModifications.go +++ b/service/ec2/api_op_DescribeVolumesModifications.go @@ -12,13 +12,18 @@ import ( ) // Describes the most recent volume modification request for the specified EBS -// volumes. If a volume has never been modified, some information in the output -// 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/ebs/latest/userguide/monitoring-volume-modifications.html) -// in the Amazon EBS User Guide. +// volumes. +// +// If a volume has never been modified, some information in the output 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]. For more +// information, see [Monitor the progress of volume modifications]in the Amazon EBS User Guide. +// +// [Monitor the progress of volume modifications]: https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html +// [Amazon CloudWatch Events User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ func (c *Client) DescribeVolumesModifications(ctx context.Context, params *DescribeVolumesModificationsInput, optFns ...func(*Options)) (*DescribeVolumesModificationsOutput, error) { if params == nil { params = &DescribeVolumesModificationsInput{} @@ -43,27 +48,39 @@ type DescribeVolumesModificationsInput struct { 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. 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]. + // + // [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 @@ -179,8 +196,9 @@ 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]. + // + // [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_DescribeVpcClassicLink.go b/service/ec2/api_op_DescribeVpcClassicLink.go index 2c35f6a1382..e427e62a468 100644 --- a/service/ec2/api_op_DescribeVpcClassicLink.go +++ b/service/ec2/api_op_DescribeVpcClassicLink.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. Describes the ClassicLink status of the specified -// VPCs. +// This action is deprecated. +// +// Describes the ClassicLink status of the specified VPCs. func (c *Client) DescribeVpcClassicLink(ctx context.Context, params *DescribeVpcClassicLinkInput, optFns ...func(*Options)) (*DescribeVpcClassicLinkOutput, error) { if params == nil { params = &DescribeVpcClassicLinkInput{} @@ -37,12 +38,15 @@ type DescribeVpcClassicLinkInput struct { DryRun *bool // The 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go b/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go index 8456b32c649..cab170cefb1 100644 --- a/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_DescribeVpcClassicLinkDnsSupport.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. 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. +// This action is deprecated. +// +// 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. func (c *Client) DescribeVpcClassicLinkDnsSupport(ctx context.Context, params *DescribeVpcClassicLinkDnsSupportInput, optFns ...func(*Options)) (*DescribeVpcClassicLinkDnsSupportOutput, error) { if params == nil { params = &DescribeVpcClassicLinkDnsSupportInput{} @@ -35,8 +37,9 @@ 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]. + // + // [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 +156,9 @@ 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]. + // + // [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 f84fd2288fc..bc42cbbe741 100644 --- a/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go +++ b/service/ec2/api_op_DescribeVpcEndpointConnectionNotifications.go @@ -40,12 +40,18 @@ type DescribeVpcEndpointConnectionNotificationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeVpcEndpointConnections.go b/service/ec2/api_op_DescribeVpcEndpointConnections.go index 8c6ca777405..7dd0d79e060 100644 --- a/service/ec2/api_op_DescribeVpcEndpointConnections.go +++ b/service/ec2/api_op_DescribeVpcEndpointConnections.go @@ -37,12 +37,17 @@ type DescribeVpcEndpointConnectionsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go b/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go index de00f1544b3..98953844104 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go +++ b/service/ec2/api_op_DescribeVpcEndpointServiceConfigurations.go @@ -37,15 +37,21 @@ type DescribeVpcEndpointServiceConfigurationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go b/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go index 25f4413e258..582a14d4362 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go +++ b/service/ec2/api_op_DescribeVpcEndpointServicePermissions.go @@ -42,7 +42,9 @@ type DescribeVpcEndpointServicePermissionsInput struct { DryRun *bool // The filters. + // // - principal - The ARN of the principal. + // // - principal-type - The principal type ( All | Service | OrganizationUnit | // Account | User | Role ). Filters []types.Filter diff --git a/service/ec2/api_op_DescribeVpcEndpointServices.go b/service/ec2/api_op_DescribeVpcEndpointServices.go index dec4d3f9ae6..06f2b548316 100644 --- a/service/ec2/api_op_DescribeVpcEndpointServices.go +++ b/service/ec2/api_op_DescribeVpcEndpointServices.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes available services to which you can create a VPC endpoint. When the -// service provider and the consumer have different accounts in multiple +// Describes available services to which you can create a VPC endpoint. +// +// When the service provider and the consumer have different accounts in multiple // 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 @@ -42,22 +43,29 @@ type DescribeVpcEndpointServicesInput struct { 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. Filters []types.Filter // The maximum number of items to return for this request. The request returns a // token that you can specify in a subsequent call to get the next set of results. + // // Constraint: If the value is greater than 1,000, we return only 1,000 items. MaxResults *int32 diff --git a/service/ec2/api_op_DescribeVpcEndpoints.go b/service/ec2/api_op_DescribeVpcEndpoints.go index 882cf929571..348e251f230 100644 --- a/service/ec2/api_op_DescribeVpcEndpoints.go +++ b/service/ec2/api_op_DescribeVpcEndpoints.go @@ -36,24 +36,33 @@ type DescribeVpcEndpointsInput struct { 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 ). Filters []types.Filter // The maximum number of items to return for this request. The request returns a // token that you can specify in a subsequent call to get the next set of results. + // // Constraint: If the value is greater than 1,000, we return only 1,000 items. MaxResults *int32 @@ -171,6 +180,7 @@ var _ DescribeVpcEndpointsAPIClient = (*Client)(nil) type DescribeVpcEndpointsPaginatorOptions struct { // The maximum number of items to return for this request. The request returns a // token that you can specify in a subsequent call to get the next set of results. + // // Constraint: If the value is greater than 1,000, we return only 1,000 items. Limit int32 diff --git a/service/ec2/api_op_DescribeVpcPeeringConnections.go b/service/ec2/api_op_DescribeVpcPeeringConnections.go index 2429346b2ba..dc45eeb49ba 100644 --- a/service/ec2/api_op_DescribeVpcPeeringConnections.go +++ b/service/ec2/api_op_DescribeVpcPeeringConnections.go @@ -42,41 +42,55 @@ type DescribeVpcPeeringConnectionsInput struct { DryRun *bool // The 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. 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]. + // + // [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 // the end of the items returned by the previous request. NextToken *string - // The IDs of the VPC peering connections. Default: Describes all your VPC peering - // connections. + // The IDs of the VPC peering connections. + // + // Default: Describes all your VPC peering connections. VpcPeeringConnectionIds []string noSmithyDocumentSerde @@ -186,8 +200,9 @@ 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]. + // + // [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 @@ -303,12 +318,13 @@ type VpcPeeringConnectionDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVpcPeeringConnectionsInput, *DescribeVpcPeeringConnectionsOutput, error) (bool, error) } @@ -506,12 +522,13 @@ type VpcPeeringConnectionExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVpcPeeringConnectionsInput, *DescribeVpcPeeringConnectionsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeVpcs.go b/service/ec2/api_op_DescribeVpcs.go index ab2dc5ce441..7e5a925488a 100644 --- a/service/ec2/api_op_DescribeVpcs.go +++ b/service/ec2/api_op_DescribeVpcs.go @@ -42,47 +42,65 @@ type DescribeVpcsInput struct { DryRun *bool // The 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. 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]. + // + // [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 // the end of the items returned by the previous request. NextToken *string - // The IDs of the VPCs. Default: Describes all your VPCs. + // The IDs of the VPCs. + // + // Default: Describes all your VPCs. VpcIds []string noSmithyDocumentSerde @@ -190,8 +208,9 @@ 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]. + // + // [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 @@ -303,12 +322,13 @@ type VpcAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVpcsInput, *DescribeVpcsOutput, error) (bool, error) } @@ -489,12 +509,13 @@ type VpcExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVpcsInput, *DescribeVpcsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeVpnConnections.go b/service/ec2/api_op_DescribeVpnConnections.go index 0104ae6d54b..b62d3aab944 100644 --- a/service/ec2/api_op_DescribeVpnConnections.go +++ b/service/ec2/api_op_DescribeVpnConnections.go @@ -15,9 +15,12 @@ import ( "time" ) -// 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. +// Describes one or more of your VPN connections. +// +// For more information, see [Amazon Web Services Site-to-Site VPN] 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 func (c *Client) DescribeVpnConnections(ctx context.Context, params *DescribeVpnConnectionsInput, optFns ...func(*Options)) (*DescribeVpnConnectionsOutput, error) { if params == nil { params = &DescribeVpnConnectionsInput{} @@ -43,35 +46,48 @@ type DescribeVpnConnectionsInput struct { 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). // // - 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. + // One or more VPN connection IDs. + // + // Default: Describes your VPN connections. VpnConnectionIds []string noSmithyDocumentSerde @@ -207,12 +223,13 @@ type VpnConnectionAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVpnConnectionsInput, *DescribeVpnConnectionsOutput, error) (bool, error) } @@ -444,12 +461,13 @@ type VpnConnectionDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVpnConnectionsInput, *DescribeVpnConnectionsOutput, error) (bool, error) } diff --git a/service/ec2/api_op_DescribeVpnGateways.go b/service/ec2/api_op_DescribeVpnGateways.go index 43c38469d76..a107abd9065 100644 --- a/service/ec2/api_op_DescribeVpnGateways.go +++ b/service/ec2/api_op_DescribeVpnGateways.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Describes one or more of your virtual private gateways. +// +// For more information, see [Amazon Web Services Site-to-Site VPN] 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 func (c *Client) DescribeVpnGateways(ctx context.Context, params *DescribeVpnGatewaysInput, optFns ...func(*Options)) (*DescribeVpnGatewaysOutput, error) { if params == nil { params = &DescribeVpnGatewaysInput{} @@ -39,28 +42,38 @@ type DescribeVpnGatewaysInput struct { 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. Filters []types.Filter - // One or more virtual private gateway IDs. Default: Describes all your virtual - // private gateways. + // One or more virtual private gateway IDs. + // + // Default: Describes all your virtual private gateways. VpnGatewayIds []string noSmithyDocumentSerde diff --git a/service/ec2/api_op_DetachClassicLinkVpc.go b/service/ec2/api_op_DetachClassicLinkVpc.go index 716d3a56b9d..3322219dfb5 100644 --- a/service/ec2/api_op_DetachClassicLinkVpc.go +++ b/service/ec2/api_op_DetachClassicLinkVpc.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. 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. +// This action is deprecated. +// +// 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{} diff --git a/service/ec2/api_op_DetachNetworkInterface.go b/service/ec2/api_op_DetachNetworkInterface.go index 57b4077667c..9e561808bed 100644 --- a/service/ec2/api_op_DetachNetworkInterface.go +++ b/service/ec2/api_op_DetachNetworkInterface.go @@ -41,15 +41,20 @@ type DetachNetworkInterfaceInput struct { 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. + // + // - If you force the detachment of a network interface, the [instance metadata]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. + // + // [instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html Force *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go b/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go index 6d478ffb041..145658f1d5f 100644 --- a/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_DetachVerifiedAccessTrustProvider.go @@ -41,8 +41,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_DetachVolume.go b/service/ec2/api_op_DetachVolume.go index ea1641885da..c4c6abe8969 100644 --- a/service/ec2/api_op_DetachVolume.go +++ b/service/ec2/api_op_DetachVolume.go @@ -18,14 +18,19 @@ import ( // detaching. If this happens, detachment can be delayed indefinitely until you // unmount the volume, force detachment, reboot the instance, or all three. If an // EBS volume is the root device of an instance, it can't be detached while the -// 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. You can't -// detach or force detach volumes that are attached to Amazon ECS or Fargate tasks. -// Attempting to do this results in the UnsupportedOperationException exception -// with the Unable to detach volume attached to ECS tasks error message. For more -// information, see Detach an Amazon EBS volume (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-detaching-volume.html) -// in the Amazon EBS User Guide. +// 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. +// +// You can't detach or force detach volumes that are attached to Amazon ECS or +// Fargate tasks. Attempting to do this results in the +// UnsupportedOperationException exception with the Unable to detach volume +// attached to ECS tasks error message. +// +// For more information, see [Detach an Amazon EBS volume] in the Amazon EBS User Guide. +// +// [Detach an Amazon EBS volume]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-detaching-volume.html func (c *Client) DetachVolume(ctx context.Context, params *DetachVolumeInput, optFns ...func(*Options)) (*DetachVolumeOutput, error) { if params == nil { params = &DetachVolumeInput{} @@ -85,17 +90,20 @@ type DetachVolumeOutput struct { // Indicates whether the EBS volume is deleted on instance termination. DeleteOnTermination *bool - // The device name. If the volume is attached to a Fargate task, this parameter - // returns null . + // The device name. + // + // If the volume is attached to a Fargate task, this parameter returns null . Device *string - // The ID of the instance. If the volume is attached to a Fargate task, this - // parameter returns null . + // The ID of the instance. + // + // If the volume is attached to a Fargate task, this parameter returns null . InstanceId *string // The service principal of Amazon Web Services service that owns the underlying - // instance to which the volume is attached. This parameter is returned only for - // volumes that are attached to Fargate tasks. + // instance to which the volume is attached. + // + // This parameter is returned only for volumes that are attached to Fargate tasks. InstanceOwningService *string // The attachment state of the volume. diff --git a/service/ec2/api_op_DetachVpnGateway.go b/service/ec2/api_op_DetachVpnGateway.go index 89bf4d532b2..a12de2882b9 100644 --- a/service/ec2/api_op_DetachVpnGateway.go +++ b/service/ec2/api_op_DetachVpnGateway.go @@ -14,9 +14,10 @@ import ( // 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 -// before you can delete the VPC or attach a different VPC to the virtual private -// gateway. +// described). +// +// You must wait for the attachment's state to switch to detached before you can +// delete the VPC or attach a different VPC to the virtual private gateway. func (c *Client) DetachVpnGateway(ctx context.Context, params *DetachVpnGatewayInput, optFns ...func(*Options)) (*DetachVpnGatewayOutput, error) { if params == nil { params = &DetachVpnGatewayInput{} diff --git a/service/ec2/api_op_DisableAddressTransfer.go b/service/ec2/api_op_DisableAddressTransfer.go index d2cff2ab78f..eefa0ac515a 100644 --- a/service/ec2/api_op_DisableAddressTransfer.go +++ b/service/ec2/api_op_DisableAddressTransfer.go @@ -11,9 +11,10 @@ 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) -// in the Amazon Virtual Private Cloud User Guide. +// Disables Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses] in the Amazon +// Virtual Private Cloud User Guide. +// +// [Transfer Elastic IP addresses]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro func (c *Client) DisableAddressTransfer(ctx context.Context, params *DisableAddressTransferInput, optFns ...func(*Options)) (*DisableAddressTransferOutput, error) { if params == nil { params = &DisableAddressTransferInput{} diff --git a/service/ec2/api_op_DisableEbsEncryptionByDefault.go b/service/ec2/api_op_DisableEbsEncryptionByDefault.go index 6cae8c6c2fe..eb5a2058c39 100644 --- a/service/ec2/api_op_DisableEbsEncryptionByDefault.go +++ b/service/ec2/api_op_DisableEbsEncryptionByDefault.go @@ -11,11 +11,16 @@ import ( ) // 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS User Guide. +// 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] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html func (c *Client) DisableEbsEncryptionByDefault(ctx context.Context, params *DisableEbsEncryptionByDefaultInput, optFns ...func(*Options)) (*DisableEbsEncryptionByDefaultOutput, error) { if params == nil { params = &DisableEbsEncryptionByDefaultInput{} diff --git a/service/ec2/api_op_DisableFastLaunch.go b/service/ec2/api_op_DisableFastLaunch.go index c609e0022f3..4e83e7dfaf9 100644 --- a/service/ec2/api_op_DisableFastLaunch.go +++ b/service/ec2/api_op_DisableFastLaunch.go @@ -15,9 +15,10 @@ import ( // Discontinue Windows fast launch for a Windows AMI, and clean up existing // pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses // the standard launch process for each new instance. Amazon EC2 must remove all -// pre-provisioned snapshots before you can enable Windows fast launch again. You -// can only change these settings for Windows AMIs that you own or that have been -// shared with you. +// pre-provisioned snapshots before you can enable Windows fast launch again. +// +// You can only change these settings for Windows AMIs that you own or that have +// been shared with you. func (c *Client) DisableFastLaunch(ctx context.Context, params *DisableFastLaunchInput, optFns ...func(*Options)) (*DisableFastLaunchOutput, error) { if params == nil { params = &DisableFastLaunchInput{} diff --git a/service/ec2/api_op_DisableImage.go b/service/ec2/api_op_DisableImage.go index a5d65c5f97b..c0a0bea9fd0 100644 --- a/service/ec2/api_op_DisableImage.go +++ b/service/ec2/api_op_DisableImage.go @@ -11,15 +11,23 @@ import ( ) // Sets the AMI state to disabled and removes all launch permissions from the AMI. -// A disabled AMI can't be used for instance launches. A disabled AMI can't be -// shared. If an AMI was public or previously shared, it is made private. If an AMI -// was shared with an Amazon Web Services account, organization, or Organizational -// Unit, they lose access to the disabled AMI. A disabled AMI does not appear in -// DescribeImages (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) -// API calls by default. Only the AMI owner can disable an AMI. You can re-enable a -// disabled AMI using EnableImage (http://amazonaws.com/AWSEC2/latest/APIReference/API_EnableImage.html) -// . For more information, see Disable an AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html) -// in the Amazon EC2 User Guide. +// A disabled AMI can't be used for instance launches. +// +// A disabled AMI can't be shared. If an AMI was public or previously shared, it +// is made private. If an AMI was shared with an Amazon Web Services account, +// organization, or Organizational Unit, they lose access to the disabled AMI. +// +// A disabled AMI does not appear in [DescribeImages] API calls by default. +// +// Only the AMI owner can disable an AMI. +// +// You can re-enable a disabled AMI using [EnableImage]. +// +// For more information, see [Disable an AMI] in the Amazon EC2 User Guide. +// +// [DescribeImages]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html +// [Disable an AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html +// [EnableImage]: http://amazonaws.com/AWSEC2/latest/APIReference/API_EnableImage.html func (c *Client) DisableImage(ctx context.Context, params *DisableImageInput, optFns ...func(*Options)) (*DisableImageOutput, error) { if params == nil { params = &DisableImageInput{} diff --git a/service/ec2/api_op_DisableImageBlockPublicAccess.go b/service/ec2/api_op_DisableImageBlockPublicAccess.go index 1cb265ddd92..cf0ad9f5f9d 100644 --- a/service/ec2/api_op_DisableImageBlockPublicAccess.go +++ b/service/ec2/api_op_DisableImageBlockPublicAccess.go @@ -14,13 +14,16 @@ import ( // Disables block public access for AMIs at the account level in the specified // Amazon Web Services Region. This removes the block public access restriction // from your account. With the restriction removed, you can publicly share your -// AMIs in the specified Amazon Web Services Region. The API can take up to 10 -// minutes to configure this setting. During this time, if you run -// GetImageBlockPublicAccessState (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html) -// , the response will be block-new-sharing . When the API has completed the -// configuration, the response will be unblocked . For more information, see Block -// public access to your AMIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis) -// in the Amazon EC2 User Guide. +// AMIs in the specified Amazon Web Services Region. +// +// The API can take up to 10 minutes to configure this setting. During this time, +// if you run [GetImageBlockPublicAccessState], the response will be block-new-sharing . When the API has completed +// the configuration, the response will be unblocked . +// +// For more information, see [Block public access to your AMIs] in the Amazon EC2 User Guide. +// +// [Block public access to your AMIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis +// [GetImageBlockPublicAccessState]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html func (c *Client) DisableImageBlockPublicAccess(ctx context.Context, params *DisableImageBlockPublicAccessInput, optFns ...func(*Options)) (*DisableImageBlockPublicAccessOutput, error) { if params == nil { params = &DisableImageBlockPublicAccessInput{} diff --git a/service/ec2/api_op_DisableImageDeprecation.go b/service/ec2/api_op_DisableImageDeprecation.go index dddd47e8762..566c536c61c 100644 --- a/service/ec2/api_op_DisableImageDeprecation.go +++ b/service/ec2/api_op_DisableImageDeprecation.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Cancels the deprecation of the specified AMI. +// +// For more information, see [Deprecate an AMI] in the Amazon EC2 User Guide. +// +// [Deprecate an AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html func (c *Client) DisableImageDeprecation(ctx context.Context, params *DisableImageDeprecationInput, optFns ...func(*Options)) (*DisableImageDeprecationOutput, error) { if params == nil { params = &DisableImageDeprecationInput{} diff --git a/service/ec2/api_op_DisableImageDeregistrationProtection.go b/service/ec2/api_op_DisableImageDeregistrationProtection.go index d1e04a58534..db1b21c960c 100644 --- a/service/ec2/api_op_DisableImageDeregistrationProtection.go +++ b/service/ec2/api_op_DisableImageDeregistrationProtection.go @@ -11,11 +11,15 @@ import ( ) // Disables deregistration protection for an AMI. When deregistration protection -// is disabled, the AMI can be deregistered. If you chose to include a 24-hour -// cooldown period when you enabled deregistration protection for the AMI, then, -// when you disable deregistration protection, you won’t immediately be able to -// deregister the AMI. For more information, see Protect an AMI from deregistration (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html#ami-deregistration-protection) -// in the Amazon EC2 User Guide. +// is disabled, the AMI can be deregistered. +// +// If you chose to include a 24-hour cooldown period when you enabled +// deregistration protection for the AMI, then, when you disable deregistration +// protection, you won’t immediately be able to deregister the AMI. +// +// For more information, see [Protect an AMI from deregistration] in the Amazon EC2 User Guide. +// +// [Protect an AMI from deregistration]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html#ami-deregistration-protection func (c *Client) DisableImageDeregistrationProtection(ctx context.Context, params *DisableImageDeregistrationProtectionInput, optFns ...func(*Options)) (*DisableImageDeregistrationProtectionOutput, error) { if params == nil { params = &DisableImageDeregistrationProtectionInput{} diff --git a/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go b/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go index 942220d1d3d..11468266121 100644 --- a/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go +++ b/service/ec2/api_op_DisableIpamOrganizationAdminAccount.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Disable the IPAM account. For more information, see [Enable integration with Organizations] in the Amazon VPC IPAM +// User Guide. +// +// [Enable integration with Organizations]: https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html func (c *Client) DisableIpamOrganizationAdminAccount(ctx context.Context, params *DisableIpamOrganizationAdminAccountInput, optFns ...func(*Options)) (*DisableIpamOrganizationAdminAccountOutput, error) { if params == nil { params = &DisableIpamOrganizationAdminAccountInput{} diff --git a/service/ec2/api_op_DisableSerialConsoleAccess.go b/service/ec2/api_op_DisableSerialConsoleAccess.go index 2d43c7587d7..ad196b4103b 100644 --- a/service/ec2/api_op_DisableSerialConsoleAccess.go +++ b/service/ec2/api_op_DisableSerialConsoleAccess.go @@ -12,8 +12,9 @@ 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) -// in the Amazon EC2 User Guide. +// information, see [Manage account access to the EC2 serial console]in the Amazon EC2 User Guide. +// +// [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 func (c *Client) DisableSerialConsoleAccess(ctx context.Context, params *DisableSerialConsoleAccessInput, optFns ...func(*Options)) (*DisableSerialConsoleAccessOutput, error) { if params == nil { params = &DisableSerialConsoleAccessInput{} diff --git a/service/ec2/api_op_DisableSnapshotBlockPublicAccess.go b/service/ec2/api_op_DisableSnapshotBlockPublicAccess.go index e1bf50fe014..b115fbd1d16 100644 --- a/service/ec2/api_op_DisableSnapshotBlockPublicAccess.go +++ b/service/ec2/api_op_DisableSnapshotBlockPublicAccess.go @@ -13,12 +13,15 @@ import ( // Disables the block public access for snapshots setting at the account level for // the specified Amazon Web Services Region. After you disable block public access -// for snapshots in a Region, users can publicly share snapshots in that Region. If -// block public access is enabled in block-all-sharing mode, and you disable block -// public access, all snapshots that were previously publicly shared are no longer -// treated as private and they become publicly accessible again. For more -// information, see Block public access for snapshots (https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) -// in the Amazon EBS User Guide . +// for snapshots in a Region, users can publicly share snapshots in that Region. +// +// If block public access is enabled in block-all-sharing mode, and you disable +// block public access, all snapshots that were previously publicly shared are no +// longer treated as private and they become publicly accessible again. +// +// For more information, see [Block public access for snapshots] in the Amazon EBS User Guide . +// +// [Block public access for snapshots]: https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html func (c *Client) DisableSnapshotBlockPublicAccess(ctx context.Context, params *DisableSnapshotBlockPublicAccessInput, optFns ...func(*Options)) (*DisableSnapshotBlockPublicAccessOutput, error) { if params == nil { params = &DisableSnapshotBlockPublicAccessInput{} diff --git a/service/ec2/api_op_DisableVpcClassicLink.go b/service/ec2/api_op_DisableVpcClassicLink.go index fd4c35da28d..07cb4750877 100644 --- a/service/ec2/api_op_DisableVpcClassicLink.go +++ b/service/ec2/api_op_DisableVpcClassicLink.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. Disables ClassicLink for a VPC. You cannot disable -// ClassicLink for a VPC that has EC2-Classic instances linked to it. +// This action is deprecated. +// +// Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that +// has EC2-Classic instances linked to it. func (c *Client) DisableVpcClassicLink(ctx context.Context, params *DisableVpcClassicLinkInput, optFns ...func(*Options)) (*DisableVpcClassicLinkOutput, error) { if params == nil { params = &DisableVpcClassicLinkInput{} diff --git a/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go b/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go index ef3552024c9..15018603522 100644 --- a/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_DisableVpcClassicLinkDnsSupport.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. 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. You -// must specify a VPC ID in the request. +// This action is deprecated. +// +// 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. +// +// You must specify a VPC ID in the request. func (c *Client) DisableVpcClassicLinkDnsSupport(ctx context.Context, params *DisableVpcClassicLinkDnsSupportInput, optFns ...func(*Options)) (*DisableVpcClassicLinkDnsSupportOutput, error) { if params == nil { params = &DisableVpcClassicLinkDnsSupportInput{} diff --git a/service/ec2/api_op_DisassociateAddress.go b/service/ec2/api_op_DisassociateAddress.go index 9adebab20e9..60e49c7c7ff 100644 --- a/service/ec2/api_op_DisassociateAddress.go +++ b/service/ec2/api_op_DisassociateAddress.go @@ -11,8 +11,10 @@ import ( ) // Disassociates an Elastic IP address from the instance or network interface it's -// associated with. This is an idempotent operation. If you perform the operation -// more than once, Amazon EC2 doesn't return an error. +// associated with. +// +// 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{} diff --git a/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go b/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go index c13ab711dd1..b9f1dbc0f55 100644 --- a/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go +++ b/service/ec2/api_op_DisassociateClientVpnTargetNetwork.go @@ -13,9 +13,13 @@ 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 func (c *Client) DisassociateClientVpnTargetNetwork(ctx context.Context, params *DisassociateClientVpnTargetNetworkInput, optFns ...func(*Options)) (*DisassociateClientVpnTargetNetworkOutput, error) { if params == nil { diff --git a/service/ec2/api_op_DisassociateIamInstanceProfile.go b/service/ec2/api_op_DisassociateIamInstanceProfile.go index 28074782440..f767d65b6ac 100644 --- a/service/ec2/api_op_DisassociateIamInstanceProfile.go +++ b/service/ec2/api_op_DisassociateIamInstanceProfile.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates an IAM instance profile from a running or stopped instance. Use -// DescribeIamInstanceProfileAssociations to get the association ID. +// Disassociates an IAM instance profile from a running or stopped instance. +// +// Use DescribeIamInstanceProfileAssociations to get the association ID. func (c *Client) DisassociateIamInstanceProfile(ctx context.Context, params *DisassociateIamInstanceProfileInput, optFns ...func(*Options)) (*DisassociateIamInstanceProfileOutput, error) { if params == nil { params = &DisassociateIamInstanceProfileInput{} diff --git a/service/ec2/api_op_DisassociateInstanceEventWindow.go b/service/ec2/api_op_DisassociateInstanceEventWindow.go index 822479a4a8f..a4a89fdff20 100644 --- a/service/ec2/api_op_DisassociateInstanceEventWindow.go +++ b/service/ec2/api_op_DisassociateInstanceEventWindow.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Disassociates one or more targets from an event window. +// +// For more information, see [Define event windows for scheduled events] in the Amazon EC2 User Guide. +// +// [Define event windows for scheduled events]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html func (c *Client) DisassociateInstanceEventWindow(ctx context.Context, params *DisassociateInstanceEventWindowInput, optFns ...func(*Options)) (*DisassociateInstanceEventWindowOutput, error) { if params == nil { params = &DisassociateInstanceEventWindowInput{} diff --git a/service/ec2/api_op_DisassociateIpamByoasn.go b/service/ec2/api_op_DisassociateIpamByoasn.go index bc474fef9b8..d0b76346855 100644 --- a/service/ec2/api_op_DisassociateIpamByoasn.go +++ b/service/ec2/api_op_DisassociateIpamByoasn.go @@ -13,9 +13,10 @@ import ( // Remove the association between your Autonomous System Number (ASN) and your // BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR -// or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN -// to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in -// the Amazon VPC IPAM guide. +// or if you want to swap ASNs. For more information, see [Tutorial: Bring your ASN to IPAM]in the Amazon VPC IPAM +// guide. +// +// [Tutorial: Bring your ASN to IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html func (c *Client) DisassociateIpamByoasn(ctx context.Context, params *DisassociateIpamByoasnInput, optFns ...func(*Options)) (*DisassociateIpamByoasnOutput, error) { if params == nil { params = &DisassociateIpamByoasnInput{} diff --git a/service/ec2/api_op_DisassociateNatGatewayAddress.go b/service/ec2/api_op_DisassociateNatGatewayAddress.go index 841b9c4a771..5fe97b50186 100644 --- a/service/ec2/api_op_DisassociateNatGatewayAddress.go +++ b/service/ec2/api_op_DisassociateNatGatewayAddress.go @@ -12,16 +12,20 @@ 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) -// in the Amazon VPC 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 gateway. An EIP is released only at -// the end of MaxDrainDurationSeconds. It stays associated and supports the -// existing connections but does not support any new connections (new connections -// are distributed across the remaining associated EIPs). As the existing -// connections drain out, the EIPs (and the corresponding private IP addresses -// mapped to them) are released. +// You cannot disassociate your primary EIP. For more information, see [Edit secondary IP address associations]in the +// Amazon VPC 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 gateway. +// +// An EIP is released only at the end of MaxDrainDurationSeconds. It stays +// associated and supports the existing connections but does not support any new +// connections (new connections are distributed across the remaining associated +// EIPs). As the existing connections drain out, the EIPs (and the corresponding +// private IP addresses mapped to them) are released. +// +// [Edit secondary IP address associations]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary func (c *Client) DisassociateNatGatewayAddress(ctx context.Context, params *DisassociateNatGatewayAddressInput, optFns ...func(*Options)) (*DisassociateNatGatewayAddressOutput, error) { if params == nil { params = &DisassociateNatGatewayAddressInput{} diff --git a/service/ec2/api_op_DisassociateRouteTable.go b/service/ec2/api_op_DisassociateRouteTable.go index 70bca6c3806..29e5d0966b3 100644 --- a/service/ec2/api_op_DisassociateRouteTable.go +++ b/service/ec2/api_op_DisassociateRouteTable.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 VPC User Guide. +// 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]in the Amazon VPC User Guide. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) DisassociateRouteTable(ctx context.Context, params *DisassociateRouteTableInput, optFns ...func(*Options)) (*DisassociateRouteTableOutput, error) { if params == nil { params = &DisassociateRouteTableInput{} diff --git a/service/ec2/api_op_DisassociateTrunkInterface.go b/service/ec2/api_op_DisassociateTrunkInterface.go index 0d00eaea18c..439496c9c99 100644 --- a/service/ec2/api_op_DisassociateTrunkInterface.go +++ b/service/ec2/api_op_DisassociateTrunkInterface.go @@ -35,8 +35,9 @@ 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]. + // + // [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 @@ -51,8 +52,9 @@ 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]. + // + // [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 cf5eff00232..8c2e4b4ef8b 100644 --- a/service/ec2/api_op_DisassociateVpcCidrBlock.go +++ b/service/ec2/api_op_DisassociateVpcCidrBlock.go @@ -12,10 +12,12 @@ 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 0a7ea99bd2c..79288f057df 100644 --- a/service/ec2/api_op_EnableAddressTransfer.go +++ b/service/ec2/api_op_EnableAddressTransfer.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Virtual Private Cloud User Guide. +// Enables Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses] in the Amazon +// Virtual Private Cloud User Guide. +// +// [Transfer Elastic IP addresses]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro func (c *Client) EnableAddressTransfer(ctx context.Context, params *EnableAddressTransferInput, optFns ...func(*Options)) (*EnableAddressTransferOutput, error) { if params == nil { params = &EnableAddressTransferInput{} diff --git a/service/ec2/api_op_EnableEbsEncryptionByDefault.go b/service/ec2/api_op_EnableEbsEncryptionByDefault.go index 6b530347d44..44c31010256 100644 --- a/service/ec2/api_op_EnableEbsEncryptionByDefault.go +++ b/service/ec2/api_op_EnableEbsEncryptionByDefault.go @@ -10,17 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS 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/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) -// . +// 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]in the Amazon +// EBS 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]. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html +// [Supported instance types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances func (c *Client) EnableEbsEncryptionByDefault(ctx context.Context, params *EnableEbsEncryptionByDefaultInput, optFns ...func(*Options)) (*EnableEbsEncryptionByDefaultOutput, error) { if params == nil { params = &EnableEbsEncryptionByDefaultInput{} diff --git a/service/ec2/api_op_EnableFastLaunch.go b/service/ec2/api_op_EnableFastLaunch.go index 42e7472b15b..61b659d6aff 100644 --- a/service/ec2/api_op_EnableFastLaunch.go +++ b/service/ec2/api_op_EnableFastLaunch.go @@ -18,8 +18,10 @@ import ( // Sysprep steps, rebooting as required. Then it creates a set of reserved // snapshots that are used for subsequent launches. The reserved snapshots are // automatically replenished as they are used, depending on your settings for -// launch frequency. You can only change these settings for Windows AMIs that you -// own or that have been shared with you. +// launch frequency. +// +// You can only change these settings for Windows AMIs that you own or that have +// been shared with you. func (c *Client) EnableFastLaunch(ctx context.Context, params *EnableFastLaunchInput, optFns ...func(*Options)) (*EnableFastLaunchOutput, error) { if params == nil { params = &EnableFastLaunchInput{} diff --git a/service/ec2/api_op_EnableFastSnapshotRestores.go b/service/ec2/api_op_EnableFastSnapshotRestores.go index 30ea25e172b..6424eb13081 100644 --- a/service/ec2/api_op_EnableFastSnapshotRestores.go +++ b/service/ec2/api_op_EnableFastSnapshotRestores.go @@ -12,12 +12,15 @@ 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/ebs/latest/userguide/ebs-fast-snapshot-restore.html) -// in the Amazon EBS User Guide. +// 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] in the Amazon EBS User Guide. +// +// [Amazon EBS fast snapshot restore]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-fast-snapshot-restore.html func (c *Client) EnableFastSnapshotRestores(ctx context.Context, params *EnableFastSnapshotRestoresInput, optFns ...func(*Options)) (*EnableFastSnapshotRestoresOutput, error) { if params == nil { params = &EnableFastSnapshotRestoresInput{} diff --git a/service/ec2/api_op_EnableImage.go b/service/ec2/api_op_EnableImage.go index 6c04d73e550..8c15cd3799b 100644 --- a/service/ec2/api_op_EnableImage.go +++ b/service/ec2/api_op_EnableImage.go @@ -14,9 +14,13 @@ import ( // used for instance launches, appears in describe operations, and can be shared. // Amazon Web Services accounts, organizations, and Organizational Units that lost // access to the AMI when it was disabled do not regain access automatically. Once -// the AMI is available, it can be shared with them again. Only the AMI owner can -// re-enable a disabled AMI. For more information, see Disable an AMI (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html) -// in the Amazon EC2 User Guide. +// the AMI is available, it can be shared with them again. +// +// Only the AMI owner can re-enable a disabled AMI. +// +// For more information, see [Disable an AMI] in the Amazon EC2 User Guide. +// +// [Disable an AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html func (c *Client) EnableImage(ctx context.Context, params *EnableImageInput, optFns ...func(*Options)) (*EnableImageOutput, error) { if params == nil { params = &EnableImageInput{} diff --git a/service/ec2/api_op_EnableImageBlockPublicAccess.go b/service/ec2/api_op_EnableImageBlockPublicAccess.go index 459d5c2dbd1..c02611f21d5 100644 --- a/service/ec2/api_op_EnableImageBlockPublicAccess.go +++ b/service/ec2/api_op_EnableImageBlockPublicAccess.go @@ -14,12 +14,15 @@ import ( // Enables block public access for AMIs at the account level in the specified // Amazon Web Services Region. This prevents the public sharing of your AMIs. // However, if you already have public AMIs, they will remain publicly available. +// // The API can take up to 10 minutes to configure this setting. During this time, -// if you run GetImageBlockPublicAccessState (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html) -// , the response will be unblocked . When the API has completed the configuration, -// the response will be block-new-sharing . For more information, see Block public -// access to your AMIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis) -// in the Amazon EC2 User Guide. +// if you run [GetImageBlockPublicAccessState], the response will be unblocked . When the API has completed the +// configuration, the response will be block-new-sharing . +// +// For more information, see [Block public access to your AMIs] in the Amazon EC2 User Guide. +// +// [Block public access to your AMIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis +// [GetImageBlockPublicAccessState]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html func (c *Client) EnableImageBlockPublicAccess(ctx context.Context, params *EnableImageBlockPublicAccessInput, optFns ...func(*Options)) (*EnableImageBlockPublicAccessOutput, error) { if params == nil { params = &EnableImageBlockPublicAccessInput{} diff --git a/service/ec2/api_op_EnableImageDeprecation.go b/service/ec2/api_op_EnableImageDeprecation.go index c4153530421..7386c6cb477 100644 --- a/service/ec2/api_op_EnableImageDeprecation.go +++ b/service/ec2/api_op_EnableImageDeprecation.go @@ -11,9 +11,11 @@ import ( "time" ) -// 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. +// Enables deprecation of the specified AMI at the specified date and time. +// +// For more information, see [Deprecate an AMI] in the Amazon EC2 User Guide. +// +// [Deprecate an AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html func (c *Client) EnableImageDeprecation(ctx context.Context, params *EnableImageDeprecationInput, optFns ...func(*Options)) (*EnableImageDeprecationOutput, error) { if params == nil { params = &EnableImageDeprecationInput{} @@ -33,9 +35,11 @@ type EnableImageDeprecationInput struct { // The date and time to deprecate the AMI, in UTC, in the following format: // YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the - // seconds to the nearest minute. You can’t specify a date in the past. The upper - // limit for DeprecateAt is 10 years from now, except for public AMIs, where the - // upper limit is 2 years from the creation date. + // seconds to the nearest minute. + // + // You can’t specify a date in the past. The upper limit for DeprecateAt is 10 + // years from now, except for public AMIs, where the upper limit is 2 years from + // the creation date. // // This member is required. DeprecateAt *time.Time diff --git a/service/ec2/api_op_EnableImageDeregistrationProtection.go b/service/ec2/api_op_EnableImageDeregistrationProtection.go index 45db0c94f32..e1d25157c98 100644 --- a/service/ec2/api_op_EnableImageDeregistrationProtection.go +++ b/service/ec2/api_op_EnableImageDeregistrationProtection.go @@ -11,11 +11,14 @@ import ( ) // Enables deregistration protection for an AMI. When deregistration protection is -// enabled, the AMI can't be deregistered. To allow the AMI to be deregistered, you -// must first disable deregistration protection using -// DisableImageDeregistrationProtection . For more information, see Protect an AMI -// from deregistration (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html#ami-deregistration-protection) -// in the Amazon EC2 User Guide. +// enabled, the AMI can't be deregistered. +// +// To allow the AMI to be deregistered, you must first disable deregistration +// protection using DisableImageDeregistrationProtection. +// +// For more information, see [Protect an AMI from deregistration] in the Amazon EC2 User Guide. +// +// [Protect an AMI from deregistration]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html#ami-deregistration-protection func (c *Client) EnableImageDeregistrationProtection(ctx context.Context, params *EnableImageDeregistrationProtectionInput, optFns ...func(*Options)) (*EnableImageDeregistrationProtectionOutput, error) { if params == nil { params = &EnableImageDeregistrationProtectionInput{} diff --git a/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go b/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go index 34933eaaef3..d59fe1e92e1 100644 --- a/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go +++ b/service/ec2/api_op_EnableIpamOrganizationAdminAccount.go @@ -12,8 +12,9 @@ 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]in the Amazon VPC IPAM User Guide. +// +// [Enable integration with Organizations]: https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html func (c *Client) EnableIpamOrganizationAdminAccount(ctx context.Context, params *EnableIpamOrganizationAdminAccountInput, optFns ...func(*Options)) (*EnableIpamOrganizationAdminAccountOutput, error) { if params == nil { params = &EnableIpamOrganizationAdminAccountInput{} diff --git a/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go b/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go index def513a3fa1..0d10d9db96b 100644 --- a/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go +++ b/service/ec2/api_op_EnableReachabilityAnalyzerOrganizationSharing.go @@ -12,9 +12,11 @@ import ( // Establishes a trust relationship between Reachability Analyzer and // Organizations. This operation must be performed by the management account for -// the organization. After you establish a trust relationship, a user in the -// management account or a delegated administrator account can run a cross-account -// analysis using resources from the member accounts. +// the organization. +// +// After you establish a trust relationship, a user in the management account or a +// delegated administrator account can run a cross-account analysis using resources +// from the member accounts. func (c *Client) EnableReachabilityAnalyzerOrganizationSharing(ctx context.Context, params *EnableReachabilityAnalyzerOrganizationSharingInput, optFns ...func(*Options)) (*EnableReachabilityAnalyzerOrganizationSharingOutput, error) { if params == nil { params = &EnableReachabilityAnalyzerOrganizationSharingInput{} diff --git a/service/ec2/api_op_EnableSerialConsoleAccess.go b/service/ec2/api_op_EnableSerialConsoleAccess.go index 008fe6ee835..5195149835e 100644 --- a/service/ec2/api_op_EnableSerialConsoleAccess.go +++ b/service/ec2/api_op_EnableSerialConsoleAccess.go @@ -12,8 +12,9 @@ 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) -// in the Amazon EC2 User Guide. +// information, see [Manage account access to the EC2 serial console]in the Amazon EC2 User Guide. +// +// [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 func (c *Client) EnableSerialConsoleAccess(ctx context.Context, params *EnableSerialConsoleAccessInput, optFns ...func(*Options)) (*EnableSerialConsoleAccessOutput, error) { if params == nil { params = &EnableSerialConsoleAccessInput{} diff --git a/service/ec2/api_op_EnableSnapshotBlockPublicAccess.go b/service/ec2/api_op_EnableSnapshotBlockPublicAccess.go index a36d2b0b586..6b0e37556eb 100644 --- a/service/ec2/api_op_EnableSnapshotBlockPublicAccess.go +++ b/service/ec2/api_op_EnableSnapshotBlockPublicAccess.go @@ -16,12 +16,15 @@ import ( // block public access for snapshots in a Region, users can no longer request // public sharing for snapshots in that Region. Snapshots that are already publicly // shared are either treated as private or they remain publicly shared, depending -// on the State that you specify. If block public access is enabled in -// block-all-sharing mode, and you change the mode to block-new-sharing , all -// snapshots that were previously publicly shared are no longer treated as private -// and they become publicly accessible again. For more information, see Block -// public access for snapshots (https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) -// in the Amazon EBS User Guide. +// on the State that you specify. +// +// If block public access is enabled in block-all-sharing mode, and you change the +// mode to block-new-sharing , all snapshots that were previously publicly shared +// are no longer treated as private and they become publicly accessible again. +// +// For more information, see [Block public access for snapshots] in the Amazon EBS User Guide. +// +// [Block public access for snapshots]: https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html func (c *Client) EnableSnapshotBlockPublicAccess(ctx context.Context, params *EnableSnapshotBlockPublicAccessInput, optFns ...func(*Options)) (*EnableSnapshotBlockPublicAccessOutput, error) { if params == nil { params = &EnableSnapshotBlockPublicAccessInput{} @@ -41,19 +44,23 @@ type EnableSnapshotBlockPublicAccessInput struct { // The mode in which to enable block public access for snapshots for the Region. // Specify one of the following values: + // // - block-all-sharing - Prevents all public sharing of snapshots in the Region. // Users in the account will no longer be able to request new public sharing. // Additionally, snapshots that are already publicly shared are treated as private - // and they are no longer publicly available. If you enable block public access for - // snapshots in block-all-sharing mode, it does not change the permissions for - // snapshots that are already publicly shared. Instead, it prevents these snapshots - // from be publicly visible and publicly accessible. Therefore, the attributes for - // these snapshots still indicate that they are publicly shared, even though they - // are not publicly available. + // and they are no longer publicly available. + // + // If you enable block public access for snapshots in block-all-sharing mode, it + // does not change the permissions for snapshots that are already publicly shared. + // Instead, it prevents these snapshots from be publicly visible and publicly + // accessible. Therefore, the attributes for these snapshots still indicate that + // they are publicly shared, even though they are not publicly available. + // // - block-new-sharing - Prevents only new public sharing of snapshots in the // Region. Users in the account will no longer be able to request new public // sharing. However, snapshots that are already publicly shared, remain publicly // available. + // // unblocked is not a valid value for EnableSnapshotBlockPublicAccess. // // This member is required. diff --git a/service/ec2/api_op_EnableVpcClassicLink.go b/service/ec2/api_op_EnableVpcClassicLink.go index 1695c6151d8..f6ea21f600c 100644 --- a/service/ec2/api_op_EnableVpcClassicLink.go +++ b/service/ec2/api_op_EnableVpcClassicLink.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. 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. +// This action is deprecated. +// +// 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. func (c *Client) EnableVpcClassicLink(ctx context.Context, params *EnableVpcClassicLinkInput, optFns ...func(*Options)) (*EnableVpcClassicLinkOutput, error) { if params == nil { params = &EnableVpcClassicLinkInput{} diff --git a/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go b/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go index 73b33346b4b..db2af204175 100644 --- a/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go +++ b/service/ec2/api_op_EnableVpcClassicLinkDnsSupport.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. 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. You -// must specify a VPC ID in the request. +// This action is deprecated. +// +// 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. +// +// 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 { params = &EnableVpcClassicLinkDnsSupportInput{} diff --git a/service/ec2/api_op_ExportImage.go b/service/ec2/api_op_ExportImage.go index 4c34e99014f..73d581a6962 100644 --- a/service/ec2/api_op_ExportImage.go +++ b/service/ec2/api_op_ExportImage.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Exports an Amazon Machine Image (AMI) to a VM file. For more information, see [Exporting a VM directly from an Amazon Machine Image (AMI)] // 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 func (c *Client) ExportImage(ctx context.Context, params *ExportImageInput, optFns ...func(*Options)) (*ExportImageOutput, error) { if params == nil { params = &ExportImageInput{} diff --git a/service/ec2/api_op_ExportTransitGatewayRoutes.go b/service/ec2/api_op_ExportTransitGatewayRoutes.go index e2ef1a39295..7378ed55459 100644 --- a/service/ec2/api_op_ExportTransitGatewayRoutes.go +++ b/service/ec2/api_op_ExportTransitGatewayRoutes.go @@ -13,9 +13,12 @@ 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) -// in Transit Gateways. +// CIDR range. +// +// The routes are saved to the specified bucket in a JSON file. For more +// information, see [Export Route Tables to Amazon S3]in Transit Gateways. +// +// [Export Route Tables to Amazon S3]: https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables func (c *Client) ExportTransitGatewayRoutes(ctx context.Context, params *ExportTransitGatewayRoutesInput, optFns ...func(*Options)) (*ExportTransitGatewayRoutesOutput, error) { if params == nil { params = &ExportTransitGatewayRoutesInput{} @@ -50,20 +53,29 @@ type ExportTransitGatewayRoutesInput struct { 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 ). Filters []types.Filter diff --git a/service/ec2/api_op_GetCapacityReservationUsage.go b/service/ec2/api_op_GetCapacityReservationUsage.go index 654d6fd3116..524d1951de4 100644 --- a/service/ec2/api_op_GetCapacityReservationUsage.go +++ b/service/ec2/api_op_GetCapacityReservationUsage.go @@ -46,8 +46,9 @@ type GetCapacityReservationUsageInput 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The token to use to retrieve the next page of results. @@ -77,15 +78,20 @@ 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. diff --git a/service/ec2/api_op_GetCoipPoolUsage.go b/service/ec2/api_op_GetCoipPoolUsage.go index 51b53bd2718..e6807a710d3 100644 --- a/service/ec2/api_op_GetCoipPoolUsage.go +++ b/service/ec2/api_op_GetCoipPoolUsage.go @@ -41,11 +41,15 @@ type GetCoipPoolUsageInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_GetConsoleOutput.go b/service/ec2/api_op_GetConsoleOutput.go index de6425907f0..3e317c66280 100644 --- a/service/ec2/api_op_GetConsoleOutput.go +++ b/service/ec2/api_op_GetConsoleOutput.go @@ -14,15 +14,20 @@ import ( // Gets the console output for the specified instance. For Linux instances, the // instance console output displays the exact console output that would normally be // displayed on a physical monitor attached to a computer. For Windows instances, -// the instance console output includes the last three system event log errors. By -// default, the console output returns buffered information that was posted shortly -// after an instance transition state (start, stop, reboot, or terminate). This -// information is available for at least one hour after the most recent post. Only -// 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) -// in the Amazon EC2 User Guide. +// the instance console output includes the last three system event log errors. +// +// By default, the console output returns buffered information that was posted +// shortly after an instance transition state (start, stop, reboot, or terminate). +// This information is available for at least one hour after the most recent post. +// Only 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] in the Amazon EC2 User Guide. +// +// [Instance console output]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output func (c *Client) GetConsoleOutput(ctx context.Context, params *GetConsoleOutputInput, optFns ...func(*Options)) (*GetConsoleOutputOutput, error) { if params == nil { params = &GetConsoleOutputInput{} @@ -51,8 +56,9 @@ type GetConsoleOutputInput struct { // UnauthorizedOperation . DryRun *bool - // When enabled, retrieves the latest console output for the instance. Default: - // disabled ( false ) + // When enabled, retrieves the latest console output for the instance. + // + // Default: disabled ( false ) Latest *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_GetConsoleScreenshot.go b/service/ec2/api_op_GetConsoleScreenshot.go index 93f1d763162..30c23e6eab4 100644 --- a/service/ec2/api_op_GetConsoleScreenshot.go +++ b/service/ec2/api_op_GetConsoleScreenshot.go @@ -11,9 +11,13 @@ import ( ) // Retrieve a JPG-format screenshot of a running instance to help with -// troubleshooting. The returned content is Base64-encoded. For more information, -// see Instance console output (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output) -// in the Amazon EC2 User Guide. +// troubleshooting. +// +// The returned content is Base64-encoded. +// +// For more information, see [Instance console output] in the Amazon EC2 User Guide. +// +// [Instance console output]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output func (c *Client) GetConsoleScreenshot(ctx context.Context, params *GetConsoleScreenshotInput, optFns ...func(*Options)) (*GetConsoleScreenshotOutput, error) { if params == nil { params = &GetConsoleScreenshotInput{} diff --git a/service/ec2/api_op_GetDefaultCreditSpecification.go b/service/ec2/api_op_GetDefaultCreditSpecification.go index 382a5f96249..165f95410d6 100644 --- a/service/ec2/api_op_GetDefaultCreditSpecification.go +++ b/service/ec2/api_op_GetDefaultCreditSpecification.go @@ -12,8 +12,11 @@ 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) -// in the Amazon EC2 User Guide. +// instance family. +// +// For more information, see [Burstable performance instances] in the Amazon EC2 User Guide. +// +// [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html func (c *Client) GetDefaultCreditSpecification(ctx context.Context, params *GetDefaultCreditSpecificationInput, optFns ...func(*Options)) (*GetDefaultCreditSpecificationOutput, error) { if params == nil { params = &GetDefaultCreditSpecificationInput{} diff --git a/service/ec2/api_op_GetEbsDefaultKmsKeyId.go b/service/ec2/api_op_GetEbsDefaultKmsKeyId.go index 2b3b4a99118..17c4a338b95 100644 --- a/service/ec2/api_op_GetEbsDefaultKmsKeyId.go +++ b/service/ec2/api_op_GetEbsDefaultKmsKeyId.go @@ -11,10 +11,12 @@ 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS User Guide. +// this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId +// or ResetEbsDefaultKmsKeyId. +// +// For more information, see [Amazon EBS encryption] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html func (c *Client) GetEbsDefaultKmsKeyId(ctx context.Context, params *GetEbsDefaultKmsKeyIdInput, optFns ...func(*Options)) (*GetEbsDefaultKmsKeyIdOutput, error) { if params == nil { params = &GetEbsDefaultKmsKeyIdInput{} diff --git a/service/ec2/api_op_GetEbsEncryptionByDefault.go b/service/ec2/api_op_GetEbsEncryptionByDefault.go index 8b1b7ace7da..82f33b4c2ae 100644 --- a/service/ec2/api_op_GetEbsEncryptionByDefault.go +++ b/service/ec2/api_op_GetEbsEncryptionByDefault.go @@ -12,8 +12,11 @@ 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS User Guide. +// current Region. +// +// For more information, see [Amazon EBS encryption] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html func (c *Client) GetEbsEncryptionByDefault(ctx context.Context, params *GetEbsEncryptionByDefaultInput, optFns ...func(*Options)) (*GetEbsEncryptionByDefaultOutput, error) { if params == nil { params = &GetEbsEncryptionByDefaultInput{} diff --git a/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go b/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go index 529d508fa63..565e64056e0 100644 --- a/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go +++ b/service/ec2/api_op_GetFlowLogsIntegrationTemplate.go @@ -15,10 +15,14 @@ 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 // diff --git a/service/ec2/api_op_GetGroupsForCapacityReservation.go b/service/ec2/api_op_GetGroupsForCapacityReservation.go index 7edddb18363..66754cdd20c 100644 --- a/service/ec2/api_op_GetGroupsForCapacityReservation.go +++ b/service/ec2/api_op_GetGroupsForCapacityReservation.go @@ -44,8 +44,9 @@ type GetGroupsForCapacityReservationInput 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]. + // + // [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination MaxResults *int32 // The token to use to retrieve the next page of results. @@ -162,8 +163,9 @@ var _ GetGroupsForCapacityReservationAPIClient = (*Client)(nil) type GetGroupsForCapacityReservationPaginatorOptions 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]. + // + // [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_GetHostReservationPurchasePreview.go b/service/ec2/api_op_GetHostReservationPurchasePreview.go index db3db154cf2..38eb7c32e8d 100644 --- a/service/ec2/api_op_GetHostReservationPurchasePreview.go +++ b/service/ec2/api_op_GetHostReservationPurchasePreview.go @@ -13,8 +13,10 @@ import ( // Preview a reservation purchase with configurations that match those of your // Dedicated Host. You must have active Dedicated Hosts in your account before you -// purchase a reservation. This is a preview of the PurchaseHostReservation action -// and does not result in the offering being purchased. +// purchase a reservation. +// +// This is a preview of the PurchaseHostReservation action and does not result in the offering being +// purchased. func (c *Client) GetHostReservationPurchasePreview(ctx context.Context, params *GetHostReservationPurchasePreviewInput, optFns ...func(*Options)) (*GetHostReservationPurchasePreviewOutput, error) { if params == nil { params = &GetHostReservationPurchasePreviewInput{} diff --git a/service/ec2/api_op_GetImageBlockPublicAccessState.go b/service/ec2/api_op_GetImageBlockPublicAccessState.go index 2bfe6f6c3ad..35a5e4a7c16 100644 --- a/service/ec2/api_op_GetImageBlockPublicAccessState.go +++ b/service/ec2/api_op_GetImageBlockPublicAccessState.go @@ -11,9 +11,11 @@ import ( ) // Gets the current state of block public access for AMIs at the account level in -// the specified Amazon Web Services Region. For more information, see Block -// public access to your AMIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis) -// in the Amazon EC2 User Guide. +// the specified Amazon Web Services Region. +// +// For more information, see [Block public access to your AMIs] in the Amazon EC2 User Guide. +// +// [Block public access to your AMIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis func (c *Client) GetImageBlockPublicAccessState(ctx context.Context, params *GetImageBlockPublicAccessStateInput, optFns ...func(*Options)) (*GetImageBlockPublicAccessStateOutput, error) { if params == nil { params = &GetImageBlockPublicAccessStateInput{} @@ -43,9 +45,13 @@ type GetImageBlockPublicAccessStateInput struct { type GetImageBlockPublicAccessStateOutput struct { // The current state of block public access for AMIs at the account level in the - // specified Amazon Web Services Region. Possible values: + // specified Amazon Web Services Region. + // + // Possible values: + // // - block-new-sharing - Any attempt to publicly share your AMIs in the specified // Region is blocked. + // // - unblocked - Your AMIs in the specified Region can be publicly shared. ImageBlockPublicAccessState *string diff --git a/service/ec2/api_op_GetInstanceMetadataDefaults.go b/service/ec2/api_op_GetInstanceMetadataDefaults.go index 39709a1a082..db0fecb4991 100644 --- a/service/ec2/api_op_GetInstanceMetadataDefaults.go +++ b/service/ec2/api_op_GetInstanceMetadataDefaults.go @@ -12,9 +12,11 @@ import ( ) // Gets the default instance metadata service (IMDS) settings that are set at the -// account level in the specified Amazon Web Services
 Region. For more -// information, see Order of precedence for instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) -// in the Amazon EC2 User Guide. +// account level in the specified Amazon Web Services
 Region. +// +// For more information, see [Order of precedence for instance metadata options] in the Amazon EC2 User Guide. +// +// [Order of precedence for instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence func (c *Client) GetInstanceMetadataDefaults(ctx context.Context, params *GetInstanceMetadataDefaultsInput, optFns ...func(*Options)) (*GetInstanceMetadataDefaultsOutput, error) { if params == nil { params = &GetInstanceMetadataDefaultsInput{} diff --git a/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go b/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go index 45c0620c6dc..33b4e5e4994 100644 --- a/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go +++ b/service/ec2/api_op_GetInstanceTypesFromInstanceRequirements.go @@ -13,17 +13,20 @@ import ( // 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) -// 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) -// in the Amazon EC2 Auto Scaling User Guide. +// 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], [Attribute-based instance type selection for EC2 Fleet], [Attribute-based instance type selection for Spot Fleet], and [Spot placement score] in the Amazon EC2 User Guide, and [Creating an Auto Scaling group using attribute-based instance type selection] in the +// Amazon EC2 Auto Scaling User Guide. +// +// [Attribute-based instance type selection for EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html +// [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 +// [Spot placement score]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.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 +// [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 func (c *Client) GetInstanceTypesFromInstanceRequirements(ctx context.Context, params *GetInstanceTypesFromInstanceRequirementsInput, optFns ...func(*Options)) (*GetInstanceTypesFromInstanceRequirementsOutput, error) { if params == nil { params = &GetInstanceTypesFromInstanceRequirementsInput{} @@ -64,8 +67,9 @@ type GetInstanceTypesFromInstanceRequirementsInput 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]. + // + // [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 @@ -182,8 +186,9 @@ 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]. + // + // [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 cd173e278a4..05ec767c8c1 100644 --- a/service/ec2/api_op_GetInstanceUefiData.go +++ b/service/ec2/api_op_GetInstanceUefiData.go @@ -12,15 +12,19 @@ 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 -// 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. +// be properly encoded. +// +// When you use [register-image] 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]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] in the Amazon EC2 User Guide. +// +// [UEFI Secure Boot]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html +// [python-uefivars tool]: https://github.com/awslabs/python-uefivars +// [register-image]: https://docs.aws.amazon.com/cli/latest/reference/ec2/register-image.html func (c *Client) GetInstanceUefiData(ctx context.Context, params *GetInstanceUefiDataInput, optFns ...func(*Options)) (*GetInstanceUefiDataOutput, error) { if params == nil { params = &GetInstanceUefiDataInput{} diff --git a/service/ec2/api_op_GetIpamAddressHistory.go b/service/ec2/api_op_GetIpamAddressHistory.go index 344b96bc683..bfba2f2cf47 100644 --- a/service/ec2/api_op_GetIpamAddressHistory.go +++ b/service/ec2/api_op_GetIpamAddressHistory.go @@ -13,8 +13,9 @@ 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]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 func (c *Client) GetIpamAddressHistory(ctx context.Context, params *GetIpamAddressHistoryInput, optFns ...func(*Options)) (*GetIpamAddressHistoryOutput, error) { if params == nil { params = &GetIpamAddressHistoryInput{} diff --git a/service/ec2/api_op_GetIpamPoolAllocations.go b/service/ec2/api_op_GetIpamPoolAllocations.go index 28ad65dbebb..60b31ca9154 100644 --- a/service/ec2/api_op_GetIpamPoolAllocations.go +++ b/service/ec2/api_op_GetIpamPoolAllocations.go @@ -13,11 +13,14 @@ import ( // Get a list of all the CIDR allocations in an IPAM pool. The Region you use // should be the IPAM pool locale. The locale is the Amazon Web Services Region -// where this IPAM pool is available for allocations. 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) +// where this IPAM pool is available for allocations. +// +// If you use this action after [AllocateIpamPoolCidr] or [ReleaseIpamPoolAllocation], note that all EC2 API actions follow an [eventual consistency] // model. +// +// [ReleaseIpamPoolAllocation]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html +// [AllocateIpamPoolCidr]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AllocateIpamPoolCidr.html +// [eventual consistency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/query-api-troubleshooting.html#eventual-consistency func (c *Client) GetIpamPoolAllocations(ctx context.Context, params *GetIpamPoolAllocationsInput, optFns ...func(*Options)) (*GetIpamPoolAllocationsOutput, error) { if params == nil { params = &GetIpamPoolAllocationsInput{} @@ -46,9 +49,9 @@ type GetIpamPoolAllocationsInput struct { // 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) - // . + // One or more filters for the request. For more information about filtering, see [Filtering CLI output]. + // + // [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 f5bbfc13c65..04cb380f823 100644 --- a/service/ec2/api_op_GetIpamPoolCidrs.go +++ b/service/ec2/api_op_GetIpamPoolCidrs.go @@ -40,9 +40,9 @@ type GetIpamPoolCidrsInput struct { // 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) - // . + // One or more filters for the request. For more information about filtering, see [Filtering CLI output]. + // + // [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 7cc86187891..f4f1f43e742 100644 --- a/service/ec2/api_op_GetIpamResourceCidrs.go +++ b/service/ec2/api_op_GetIpamResourceCidrs.go @@ -44,9 +44,9 @@ type GetIpamResourceCidrsInput struct { // 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) - // . + // One or more filters for the request. For more information about filtering, see [Filtering CLI output]. + // + // [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 2525bfa6641..adfac541a1e 100644 --- a/service/ec2/api_op_GetLaunchTemplateData.go +++ b/service/ec2/api_op_GetLaunchTemplateData.go @@ -12,10 +12,12 @@ 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 , and +// 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 , and // DescribeInstanceAttribute . Or, you can allow describe* depending on your // instance requirements. func (c *Client) GetLaunchTemplateData(ctx context.Context, params *GetLaunchTemplateDataInput, optFns ...func(*Options)) (*GetLaunchTemplateDataOutput, error) { diff --git a/service/ec2/api_op_GetPasswordData.go b/service/ec2/api_op_GetPasswordData.go index f00f104a5e2..0e28f589ec1 100644 --- a/service/ec2/api_op_GetPasswordData.go +++ b/service/ec2/api_op_GetPasswordData.go @@ -16,18 +16,25 @@ 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. +// time an instance is launched. For more information, see [EC2Config]and [EC2Launch] 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 +// 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. +// +// [EC2Launch]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2launch.html +// [EC2Config]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/UsingConfig_WinAMI.html func (c *Client) GetPasswordData(ctx context.Context, params *GetPasswordDataInput, optFns ...func(*Options)) (*GetPasswordDataOutput, error) { if params == nil { params = &GetPasswordDataInput{} @@ -198,12 +205,13 @@ type PasswordDataAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetPasswordDataInput, *GetPasswordDataOutput, error) (bool, error) } diff --git a/service/ec2/api_op_GetReservedInstancesExchangeQuote.go b/service/ec2/api_op_GetReservedInstancesExchangeQuote.go index 7815c7e1367..ee7d3ba58e4 100644 --- a/service/ec2/api_op_GetReservedInstancesExchangeQuote.go +++ b/service/ec2/api_op_GetReservedInstancesExchangeQuote.go @@ -14,8 +14,8 @@ import ( // Returns a quote and exchange information for exchanging one or more specified // Convertible Reserved Instances for a new Convertible Reserved Instance. If the -// exchange cannot be performed, the reason is returned in the response. Use -// AcceptReservedInstancesExchangeQuote to perform the exchange. +// exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuoteto +// perform the exchange. func (c *Client) GetReservedInstancesExchangeQuote(ctx context.Context, params *GetReservedInstancesExchangeQuoteInput, optFns ...func(*Options)) (*GetReservedInstancesExchangeQuoteOutput, error) { if params == nil { params = &GetReservedInstancesExchangeQuoteInput{} diff --git a/service/ec2/api_op_GetSecurityGroupsForVpc.go b/service/ec2/api_op_GetSecurityGroupsForVpc.go index cdb1912b558..ef54dd908dd 100644 --- a/service/ec2/api_op_GetSecurityGroupsForVpc.go +++ b/service/ec2/api_op_GetSecurityGroupsForVpc.go @@ -43,17 +43,23 @@ type GetSecurityGroupsForVpcInput struct { // The filters. If using multiple filters, the results include security groups // which match all filters. + // // - group-id : The security group ID. + // // - description : The security group's description. + // // - group-name : The security group name. + // // - owner-id : The security group owner ID. + // // - primary-vpc-id : The VPC ID in which the security group 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]. + // + // [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 @@ -170,8 +176,9 @@ var _ GetSecurityGroupsForVpcAPIClient = (*Client)(nil) type GetSecurityGroupsForVpcPaginatorOptions 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]. + // + // [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_GetSerialConsoleAccessStatus.go b/service/ec2/api_op_GetSerialConsoleAccessStatus.go index 0ee6bb2d6d3..d5e11fef260 100644 --- a/service/ec2/api_op_GetSerialConsoleAccessStatus.go +++ b/service/ec2/api_op_GetSerialConsoleAccessStatus.go @@ -12,9 +12,9 @@ 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) -// in the Amazon EC2 User Guide. +// account. For more information, see [Manage account access to the EC2 serial console]in the Amazon EC2 User Guide. +// +// [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 func (c *Client) GetSerialConsoleAccessStatus(ctx context.Context, params *GetSerialConsoleAccessStatusInput, optFns ...func(*Options)) (*GetSerialConsoleAccessStatusOutput, error) { if params == nil { params = &GetSerialConsoleAccessStatusInput{} diff --git a/service/ec2/api_op_GetSnapshotBlockPublicAccessState.go b/service/ec2/api_op_GetSnapshotBlockPublicAccessState.go index 6645d1b97c6..5ae947eb01e 100644 --- a/service/ec2/api_op_GetSnapshotBlockPublicAccessState.go +++ b/service/ec2/api_op_GetSnapshotBlockPublicAccessState.go @@ -12,8 +12,11 @@ import ( ) // Gets the current state of block public access for snapshots setting for the -// account and Region. For more information, see Block public access for snapshots (https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) -// in the Amazon EBS User Guide. +// account and Region. +// +// For more information, see [Block public access for snapshots] in the Amazon EBS User Guide. +// +// [Block public access for snapshots]: https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html func (c *Client) GetSnapshotBlockPublicAccessState(ctx context.Context, params *GetSnapshotBlockPublicAccessStateInput, optFns ...func(*Options)) (*GetSnapshotBlockPublicAccessStateOutput, error) { if params == nil { params = &GetSnapshotBlockPublicAccessStateInput{} @@ -42,14 +45,16 @@ type GetSnapshotBlockPublicAccessStateInput struct { type GetSnapshotBlockPublicAccessStateOutput struct { - // The current state of block public access for snapshots. Possible values - // include: + // The current state of block public access for snapshots. Possible values include: + // // - block-all-sharing - All public sharing of snapshots is blocked. Users in the // account can't request new public sharing. Additionally, snapshots that were // already publicly shared are treated as private and are not publicly available. + // // - block-new-sharing - Only new public sharing of snapshots is blocked. Users // in the account can't request new public sharing. However, snapshots that were // already publicly shared, remain publicly available. + // // - unblocked - Public sharing is not blocked. Users can publicly share // snapshots. State types.SnapshotBlockPublicAccessState diff --git a/service/ec2/api_op_GetSpotPlacementScores.go b/service/ec2/api_op_GetSpotPlacementScores.go index 593e8ffccf5..2000cdeb09c 100644 --- a/service/ec2/api_op_GetSpotPlacementScores.go +++ b/service/ec2/api_op_GetSpotPlacementScores.go @@ -12,12 +12,16 @@ import ( ) // Calculates the Spot placement score for a Region or Availability Zone based on -// 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) -// in the Amazon EC2 User Guide. +// 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] in the Amazon EC2 User Guide. +// +// [Spot placement score]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html func (c *Client) GetSpotPlacementScores(ctx context.Context, params *GetSpotPlacementScoresInput, optFns ...func(*Options)) (*GetSpotPlacementScoresOutput, error) { if params == nil { params = &GetSpotPlacementScoresInput{} @@ -47,21 +51,26 @@ type GetSpotPlacementScoresInput struct { 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 . + // Amazon EC2 will identify instance types with those attributes. + // + // If you specify 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 . + // 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]. + // + // [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 @@ -73,9 +82,10 @@ type GetSpotPlacementScoresInput struct { RegionNames []string // Specify true so that the response returns a list of scored Availability Zones. - // Otherwise, the response returns a list of scored Regions. A list of scored - // Availability Zones is useful if you want to launch all of your Spot capacity - // into a single Availability Zone. + // Otherwise, the response returns a list of scored Regions. + // + // A list of scored Availability Zones is useful if you want to launch all of your + // Spot capacity into a single Availability Zone. SingleAvailabilityZone *bool // The unit for the target capacity. @@ -95,14 +105,19 @@ type GetSpotPlacementScoresOutput struct { // 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 + // 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 // for Availability Zones, a high score assumes that your fleet request will be // configured to use a single Availability Zone and the capacity-optimized - // allocation strategy. Different
 Regions or Availability Zones might return the - // same score. The Spot placement score serves as a recommendation only. No score - // guarantees that your Spot request will be fully or partially fulfilled. + // allocation strategy. + // + // Different
 Regions or Availability Zones might return the same score. + // + // The Spot placement score serves as a recommendation only. No score guarantees + // that your Spot request will be fully or partially fulfilled. SpotPlacementScores []types.SpotPlacementScore // Metadata pertaining to the operation's result. @@ -203,8 +218,9 @@ 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]. + // + // [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 0da21852cb3..a4d7663425d 100644 --- a/service/ec2/api_op_GetSubnetCidrReservations.go +++ b/service/ec2/api_op_GetSubnetCidrReservations.go @@ -41,12 +41,16 @@ type GetSubnetCidrReservationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go b/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go index 14a9ce41981..21e8c460b66 100644 --- a/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go +++ b/service/ec2/api_op_GetTransitGatewayAttachmentPropagations.go @@ -42,6 +42,7 @@ type GetTransitGatewayAttachmentPropagationsInput struct { DryRun *bool // One or more filters. The possible values are: + // // - transit-gateway-route-table-id - The ID of the transit gateway route table. Filters []types.Filter diff --git a/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go b/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go index 51fe65582cf..a790a53beb2 100644 --- a/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayMulticastDomainAssociations.go @@ -42,11 +42,16 @@ type GetTransitGatewayMulticastDomainAssociationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go b/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go index 2c47b03e7be..3891de62d43 100644 --- a/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go +++ b/service/ec2/api_op_GetTransitGatewayPrefixListReferences.go @@ -42,14 +42,21 @@ type GetTransitGatewayPrefixListReferencesInput struct { 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 ). Filters []types.Filter diff --git a/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go b/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go index 6c0b515876f..9d497f08bb2 100644 --- a/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go +++ b/service/ec2/api_op_GetTransitGatewayRouteTableAssociations.go @@ -42,9 +42,12 @@ type GetTransitGatewayRouteTableAssociationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go b/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go index aa32f9a597c..09fe4e86ef7 100644 --- a/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go +++ b/service/ec2/api_op_GetTransitGatewayRouteTablePropagations.go @@ -42,9 +42,12 @@ type GetTransitGatewayRouteTablePropagationsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_GetVpnConnectionDeviceTypes.go b/service/ec2/api_op_GetVpnConnectionDeviceTypes.go index 03af5dc3b88..c31a75a3592 100644 --- a/service/ec2/api_op_GetVpnConnectionDeviceTypes.go +++ b/service/ec2/api_op_GetVpnConnectionDeviceTypes.go @@ -13,9 +13,10 @@ 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. +// list of device types with sample configuration files available under [Your customer gateway device]in the +// Amazon Web Services Site-to-Site VPN User Guide. +// +// [Your customer gateway device]: https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html func (c *Client) GetVpnConnectionDeviceTypes(ctx context.Context, params *GetVpnConnectionDeviceTypesInput, optFns ...func(*Options)) (*GetVpnConnectionDeviceTypesOutput, error) { if params == nil { params = &GetVpnConnectionDeviceTypesInput{} diff --git a/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go b/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go index 7b73b687f56..b30e9d83815 100644 --- a/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go +++ b/service/ec2/api_op_ImportClientVpnClientCertificateRevocationList.go @@ -12,8 +12,10 @@ import ( // Uploads a client certificate revocation list to the specified Client VPN // endpoint. Uploading a client certificate revocation list overwrites the existing -// client certificate revocation list. Uploading a client certificate revocation -// list resets existing client connections. +// client certificate revocation list. +// +// Uploading a client certificate revocation list resets existing client +// connections. func (c *Client) ImportClientVpnClientCertificateRevocationList(ctx context.Context, params *ImportClientVpnClientCertificateRevocationListInput, optFns ...func(*Options)) (*ImportClientVpnClientCertificateRevocationListOutput, error) { if params == nil { params = &ImportClientVpnClientCertificateRevocationListInput{} @@ -31,9 +33,10 @@ 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) - // in the Client VPN Administrator Guide. + // The client certificate revocation list file. For more information, see [Generate a Client Certificate Revocation List] in the + // Client VPN Administrator Guide. + // + // [Generate a Client Certificate Revocation List]: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate // // This member is required. CertificateRevocationList *string diff --git a/service/ec2/api_op_ImportImage.go b/service/ec2/api_op_ImportImage.go index 8719b1da289..3317ff7e1de 100644 --- a/service/ec2/api_op_ImportImage.go +++ b/service/ec2/api_op_ImportImage.go @@ -12,16 +12,22 @@ 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 -// 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) -// in the VM Import/Export User Guide. +// use the Import virtual machine images to Amazon Web Services template in the [Migration Hub Orchestrator console]. +// For more information, see the [Migration Hub Orchestrator User Guide]. +// +// 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] in the VM Import/Export User Guide. +// +// [Migration Hub Orchestrator console]: https://console.aws.amazon.com/migrationhub/orchestrator +// [Importing a VM as an image using VM Import/Export]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html +// [Migration Hub Orchestrator User Guide]: https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html func (c *Client) ImportImage(ctx context.Context, params *ImportImageInput, optFns ...func(*Options)) (*ImportImageOutput, error) { if params == nil { params = &ImportImageInput{} @@ -39,12 +45,17 @@ func (c *Client) ImportImage(ctx context.Context, params *ImportImageInput, optF type ImportImageInput struct { - // The architecture of the virtual machine. Valid values: i386 | x86_64 + // The architecture of the virtual machine. + // + // Valid values: i386 | x86_64 Architecture *string - // The boot mode of the virtual machine. The uefi-preferred boot mode isn't - // supported for importing images. For more information, see Boot modes (https://docs.aws.amazon.com/vm-import/latest/userguide/prerequisites.html#vmimport-boot-modes) - // in the VM Import/Export User Guide. + // The boot mode of the virtual machine. + // + // The uefi-preferred boot mode isn't supported for importing images. For more + // information, see [Boot modes]in the VM Import/Export User Guide. + // + // [Boot modes]: https://docs.aws.amazon.com/vm-import/latest/userguide/prerequisites.html#vmimport-boot-modes BootMode types.BootModeValues // The client-specific data. @@ -67,53 +78,70 @@ type ImportImageInput struct { // 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. + // KMS key using KmsKeyId . For more information, see [Amazon EBS Encryption] in the Amazon Elastic + // Compute Cloud User Guide. + // + // [Amazon EBS Encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html Encrypted *bool - // The target hypervisor platform. Valid values: xen + // The target hypervisor platform. + // + // Valid values: xen Hypervisor *string // An identifier for the symmetric KMS key to use when creating the encrypted AMI. // This parameter is only required if you want to use a non-default KMS 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: + // 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 + // // - 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. + // 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. LicenseSpecifications []types.ImportImageLicenseConfigurationRequest // The license type to be used for the Amazon Machine Image (AMI) after importing. + // // Specify AWS to replace the source-system license with an Amazon Web Services // 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 - // 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) + // 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] // in the VM Import/Export User Guide. + // + // [Prerequisites]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image LicenseType *string // The operating system of the virtual machine. If you import a VM that is // compatible with Unified Extensible Firmware Interface (UEFI) using an EBS - // snapshot, you must specify a value for the platform. Valid values: Windows | - // Linux + // snapshot, you must specify a value for the platform. + // + // Valid values: Windows | Linux Platform *string // The name of the role to use when not using the default role, 'vmimport'. @@ -122,8 +150,10 @@ 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) - // in the VM Import/Export User Guide. + // The usage operation value. For more information, see [Licensing options] in the VM Import/Export + // User Guide. + // + // [Licensing options]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites UsageOperation *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ImportInstance.go b/service/ec2/api_op_ImportInstance.go index 42c269f0964..5521a8af512 100644 --- a/service/ec2/api_op_ImportInstance.go +++ b/service/ec2/api_op_ImportInstance.go @@ -11,17 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// We recommend that you use the ImportImage (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html) -// API. 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) -// in the VM Import/Export User Guide. Creates an import instance task using -// metadata from the specified disk image. 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) -// in the Amazon EC2 CLI Reference PDF file. This API action supports only -// single-volume VMs. To import multi-volume VMs, use ImportImage instead. 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) -// . +// We recommend that you use the [ImportImage]ImportImage API. For more information, see [Importing a VM as an image using VM Import/Export] in +// the VM Import/Export User Guide. +// +// Creates an import instance task using metadata from the specified disk image. +// +// 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]in the +// Amazon EC2 CLI Reference PDF file. +// +// This API action supports only single-volume VMs. To import multi-volume VMs, +// use ImportImageinstead. +// +// For information about the import manifest referenced by this API action, see [VM Import Manifest]. +// +// [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 to Amazon EC2]: https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#UsingVirtualMachinesinAmazonEC2 +// [ImportImage]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html +// [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{} diff --git a/service/ec2/api_op_ImportKeyPair.go b/service/ec2/api_op_ImportKeyPair.go index eed26737c34..a8c2af0bef2 100644 --- a/service/ec2/api_op_ImportKeyPair.go +++ b/service/ec2/api_op_ImportKeyPair.go @@ -12,13 +12,16 @@ 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 -// 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. +// 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] in the Amazon Elastic Compute Cloud +// User Guide. +// +// [Amazon EC2 key pairs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html func (c *Client) ImportKeyPair(ctx context.Context, params *ImportKeyPairInput, optFns ...func(*Options)) (*ImportKeyPairOutput, error) { if params == nil { params = &ImportKeyPairInput{} @@ -63,9 +66,11 @@ 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) - // . + // digest, which is the default for OpenSSH, starting with [OpenSSH 6.8]. + // + // [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 6a1d9d1e049..9fea34e8312 100644 --- a/service/ec2/api_op_ImportSnapshot.go +++ b/service/ec2/api_op_ImportSnapshot.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the VM Import/Export User Guide. +// Imports a disk into an EBS snapshot. +// +// For more information, see [Importing a disk as a snapshot using VM Import/Export] in the VM Import/Export User Guide. +// +// [Importing a disk as a snapshot using VM Import/Export]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html func (c *Client) ImportSnapshot(ctx context.Context, params *ImportSnapshotInput, optFns ...func(*Options)) (*ImportSnapshotOutput, error) { if params == nil { params = &ImportSnapshotInput{} @@ -51,30 +53,41 @@ type ImportSnapshotInput struct { // 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] in the Amazon Elastic + // Compute Cloud User Guide. + // + // [Amazon EBS Encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html Encrypted *bool // An identifier for the symmetric KMS key to use when creating the encrypted // snapshot. This parameter is only required if you want to use a non-default KMS // 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: + // 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 + // // - 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. + // 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 6c65a6961fb..8b3e8d27b03 100644 --- a/service/ec2/api_op_ImportVolume.go +++ b/service/ec2/api_op_ImportVolume.go @@ -12,14 +12,18 @@ import ( ) // 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) -// . +// +// This API action supports only single-volume VMs. To import multi-volume VMs, +// use ImportImageinstead. 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]in the +// Amazon EC2 CLI Reference PDF file. +// +// For information about the import manifest referenced by this API action, see [VM Import Manifest]. +// +// [Importing Disks to Amazon EBS]: https://awsdocs.s3.amazonaws.com/EC2/ec2-clt.pdf#importing-your-volumes-into-amazon-ebs +// [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{} diff --git a/service/ec2/api_op_ListImagesInRecycleBin.go b/service/ec2/api_op_ListImagesInRecycleBin.go index 57023a18b60..3907a1378be 100644 --- a/service/ec2/api_op_ListImagesInRecycleBin.go +++ b/service/ec2/api_op_ListImagesInRecycleBin.go @@ -12,8 +12,9 @@ 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]in the Amazon EC2 User Guide. +// +// [Recycle Bin]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html func (c *Client) ListImagesInRecycleBin(ctx context.Context, params *ListImagesInRecycleBinInput, optFns ...func(*Options)) (*ListImagesInRecycleBinOutput, error) { if params == nil { params = &ListImagesInRecycleBinInput{} @@ -43,8 +44,9 @@ 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]. + // + // [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 @@ -158,8 +160,9 @@ 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]. + // + // [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 9bea0bc7826..5203209434e 100644 --- a/service/ec2/api_op_ListSnapshotsInRecycleBin.go +++ b/service/ec2/api_op_ListSnapshotsInRecycleBin.go @@ -37,8 +37,9 @@ type ListSnapshotsInRecycleBinInput 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]. + // + // [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 +157,9 @@ 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]. + // + // [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_LockSnapshot.go b/service/ec2/api_op_LockSnapshot.go index 10e0ec6dd84..fb9baabac4d 100644 --- a/service/ec2/api_op_LockSnapshot.go +++ b/service/ec2/api_op_LockSnapshot.go @@ -14,14 +14,19 @@ import ( // Locks an Amazon EBS snapshot in either governance or compliance mode to protect // it against accidental or malicious deletions for a specific duration. A locked -// snapshot can't be deleted. You can also use this action to modify the lock -// settings for a snapshot that is already locked. The allowed modifications depend -// on the lock mode and lock state: +// snapshot can't be deleted. +// +// You can also use this action to modify the lock settings for a snapshot that is +// already locked. The allowed modifications depend on the lock mode and lock +// state: +// // - If the snapshot is locked in governance mode, you can modify the lock mode // and the lock duration or lock expiration date. +// // - If the snapshot is locked in compliance mode and it is in the cooling-off // period, you can modify the lock mode and the lock duration or lock expiration // date. +// // - If the snapshot is locked in compliance mode and the cooling-off period has // lapsed, you can only increase the lock duration or extend the lock expiration // date. @@ -43,19 +48,27 @@ func (c *Client) LockSnapshot(ctx context.Context, params *LockSnapshotInput, op type LockSnapshotInput struct { // The mode in which to lock the snapshot. Specify one of the following: + // // - governance - Locks the snapshot in governance mode. Snapshots locked in // governance mode can't be deleted until one of the following conditions are met: + // // - The lock duration expires. - // - The snapshot is unlocked by a user with the appropriate permissions. Users - // with the appropriate IAM permissions can unlock the snapshot, increase or - // decrease the lock duration, and change the lock mode to compliance at any - // time. If you lock a snapshot in governance mode, omit CoolOffPeriod. + // + // - The snapshot is unlocked by a user with the appropriate permissions. + // + // Users with the appropriate IAM permissions can unlock the snapshot, increase or + // decrease the lock duration, and change the lock mode to compliance at any time. + // + // If you lock a snapshot in governance mode, omit CoolOffPeriod. + // // - compliance - Locks the snapshot in compliance mode. Snapshots locked in // compliance mode can't be unlocked by any user. They can be deleted only after // the lock duration expires. Users can't decrease the lock duration or change the // lock mode to governance . However, users with appropriate IAM permissions can - // increase the lock duration at any time. If you lock a snapshot in compliance - // mode, you can optionally specify CoolOffPeriod. + // increase the lock duration at any time. + // + // If you lock a snapshot in compliance mode, you can optionally specify + // CoolOffPeriod. // // This member is required. LockMode types.LockMode @@ -69,14 +82,19 @@ type LockSnapshotInput struct { // lock settings after locking the snapshot in compliance mode, in hours. After the // cooling-off period expires, you can't unlock or delete the snapshot, decrease // the lock duration, or change the lock mode. You can increase the lock duration - // after the cooling-off period expires. The cooling-off period is optional when - // locking a snapshot in compliance mode. If you are locking the snapshot in - // governance mode, omit this parameter. To lock the snapshot in compliance mode - // immediately without a cooling-off period, omit this parameter. If you are - // extending the lock duration for a snapshot that is locked in compliance mode - // after the cooling-off period has expired, omit this parameter. If you specify a - // cooling-period in a such a request, the request fails. Allowed values: Min 1, - // max 72. + // after the cooling-off period expires. + // + // The cooling-off period is optional when locking a snapshot in compliance mode. + // If you are locking the snapshot in governance mode, omit this parameter. + // + // To lock the snapshot in compliance mode immediately without a cooling-off + // period, omit this parameter. + // + // If you are extending the lock duration for a snapshot that is locked in + // compliance mode after the cooling-off period has expired, omit this parameter. + // If you specify a cooling-period in a such a request, the request fails. + // + // Allowed values: Min 1, max 72. CoolOffPeriod *int32 // Checks whether you have the required permissions for the action, without @@ -86,13 +104,17 @@ type LockSnapshotInput struct { DryRun *bool // The date and time at which the snapshot lock is to automatically expire, in the - // UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You must specify either this - // parameter or LockDuration, but not both. + // UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). + // + // You must specify either this parameter or LockDuration, but not both. ExpirationDate *time.Time // The period of time for which to lock the snapshot, in days. The snapshot lock - // will automatically expire after this period lapses. You must specify either this - // parameter or ExpirationDate, but not both. Allowed values: Min: 1, max 36500 + // will automatically expire after this period lapses. + // + // You must specify either this parameter or ExpirationDate, but not both. + // + // Allowed values: Min: 1, max 36500 LockDuration *int32 noSmithyDocumentSerde @@ -123,16 +145,20 @@ type LockSnapshotOutput struct { LockExpiresOn *time.Time // The state of the snapshot lock. Valid states include: + // // - compliance-cooloff - The snapshot has been locked in compliance mode but it // is still within the cooling-off period. The snapshot can't be deleted, but it // can be unlocked and the lock settings can be modified by users with appropriate // permissions. + // // - governance - The snapshot is locked in governance mode. The snapshot can't // be deleted, but it can be unlocked and the lock settings can be modified by // users with appropriate permissions. + // // - compliance - The snapshot is locked in compliance mode and the cooling-off // period has expired. The snapshot can't be unlocked or deleted. The lock duration // can only be increased by users with appropriate permissions. + // // - expired - The snapshot was locked in compliance or governance mode but the // lock duration has expired. The snapshot is not locked and can be deleted. LockState types.LockState diff --git a/service/ec2/api_op_ModifyAddressAttribute.go b/service/ec2/api_op_ModifyAddressAttribute.go index 61a501a6580..e4b80d46bbb 100644 --- a/service/ec2/api_op_ModifyAddressAttribute.go +++ b/service/ec2/api_op_ModifyAddressAttribute.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// see [Using reverse DNS for email applications]. +// +// [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{} diff --git a/service/ec2/api_op_ModifyAvailabilityZoneGroup.go b/service/ec2/api_op_ModifyAvailabilityZoneGroup.go index 229ac46f4ed..5fcb6b080fc 100644 --- a/service/ec2/api_op_ModifyAvailabilityZoneGroup.go +++ b/service/ec2/api_op_ModifyAvailabilityZoneGroup.go @@ -12,8 +12,11 @@ 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] to view the value for GroupName . +// +// [DescribeAvailabilityZones]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html func (c *Client) ModifyAvailabilityZoneGroup(ctx context.Context, params *ModifyAvailabilityZoneGroupInput, optFns ...func(*Options)) (*ModifyAvailabilityZoneGroupOutput, error) { if params == nil { params = &ModifyAvailabilityZoneGroupInput{} @@ -38,9 +41,10 @@ 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) - // to opt out of a Local Zone or Wavelength Zone group. + // group. The only valid value is opted-in . You must contact [Amazon Web Services Support] to opt out of a + // Local Zone or Wavelength Zone group. + // + // [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 // // This member is required. OptInStatus types.ModifyAvailabilityZoneOptInStatus diff --git a/service/ec2/api_op_ModifyCapacityReservation.go b/service/ec2/api_op_ModifyCapacityReservation.go index 5043a903e15..c6093be25df 100644 --- a/service/ec2/api_op_ModifyCapacityReservation.go +++ b/service/ec2/api_op_ModifyCapacityReservation.go @@ -55,17 +55,22 @@ type ModifyCapacityReservationInput struct { // 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. 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. You must provide an EndDate value if EndDateType is - // limited . Omit EndDate if EndDateType is unlimited . + // when it reaches its end date and time. + // + // 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. + // + // You must provide an EndDate value if EndDateType is 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 . EndDateType types.EndDateType diff --git a/service/ec2/api_op_ModifyCapacityReservationFleet.go b/service/ec2/api_op_ModifyCapacityReservationFleet.go index 3daa6057a71..1bd3e6d0693 100644 --- a/service/ec2/api_op_ModifyCapacityReservationFleet.go +++ b/service/ec2/api_op_ModifyCapacityReservationFleet.go @@ -11,12 +11,13 @@ 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{} @@ -47,26 +48,30 @@ type ModifyCapacityReservationFleetInput struct { // 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 - // RemoveEndDate in the same request. + // 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 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 - // CancelCapacityReservationFleet action. You can't specify RemoveEndDate and - // EndDate in the same request. + // CancelCapacityReservationFleet action. + // + // You can't specify RemoveEndDate and EndDate in the same request. RemoveEndDate *bool // The total number of capacity units to be reserved by the Capacity Reservation // 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) - // in the Amazon EC2 User Guide. + // your workload. For more information, see [Total target capacity]in the Amazon EC2 User Guide. + // + // [Total target capacity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity TotalTargetCapacity *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyClientVpnEndpoint.go b/service/ec2/api_op_ModifyClientVpnEndpoint.go index edf30729891..960ff347552 100644 --- a/service/ec2/api_op_ModifyClientVpnEndpoint.go +++ b/service/ec2/api_op_ModifyClientVpnEndpoint.go @@ -42,12 +42,17 @@ type ModifyClientVpnEndpointInput struct { // 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: + // 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 ConnectionLogOptions *types.ConnectionLogOptions @@ -74,20 +79,29 @@ type ModifyClientVpnEndpointInput struct { // provisioned in Certificate Manager (ACM). ServerCertificateArn *string - // The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 + // The maximum VPN session duration time in hours. + // + // Valid values: 8 | 10 | 12 | 24 + // // Default value: 24 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) - // in the Client VPN Administrator Guide. + // Indicates whether the VPN is split-tunnel. + // + // For information about split-tunnel VPN endpoints, see [Split-tunnel Client VPN endpoint] in the Client VPN + // Administrator Guide. + // + // [Split-tunnel Client VPN endpoint]: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html SplitTunnel *bool // The ID of the VPC to associate with the Client VPN endpoint. VpcId *string // The port number to assign to the Client VPN endpoint for TCP and UDP traffic. - // Valid Values: 443 | 1194 Default Value: 443 + // + // Valid Values: 443 | 1194 + // + // Default Value: 443 VpnPort *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyDefaultCreditSpecification.go b/service/ec2/api_op_ModifyDefaultCreditSpecification.go index e3cb2148b09..04cc24536a3 100644 --- a/service/ec2/api_op_ModifyDefaultCreditSpecification.go +++ b/service/ec2/api_op_ModifyDefaultCreditSpecification.go @@ -15,14 +15,18 @@ import ( // instances. The default credit option is set at the account level per Amazon Web // Services Region, and is specified per instance family. All new burstable // performance instances in the account launch using the default credit option. -// ModifyDefaultCreditSpecification is an asynchronous operation, which works at an -// Amazon Web Services Region level and modifies the credit option for each +// +// ModifyDefaultCreditSpecification is an asynchronous operation, which works at +// an Amazon Web Services Region level and modifies the credit option for each // Availability Zone. All zones in a Region are updated within five minutes. But if // 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) -// in the Amazon EC2 User Guide. +// updates. +// +// For more information, see [Burstable performance instances] in the Amazon EC2 User Guide. +// +// [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html func (c *Client) ModifyDefaultCreditSpecification(ctx context.Context, params *ModifyDefaultCreditSpecificationInput, optFns ...func(*Options)) (*ModifyDefaultCreditSpecificationOutput, error) { if params == nil { params = &ModifyDefaultCreditSpecificationInput{} @@ -40,8 +44,9 @@ 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 diff --git a/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go b/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go index ffed8a21f4d..c9ab7e3795c 100644 --- a/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go +++ b/service/ec2/api_op_ModifyEbsDefaultKmsKeyId.go @@ -11,16 +11,21 @@ import ( ) // Changes the default KMS key for EBS encryption by default for your account in -// this Region. Amazon Web Services creates a unique Amazon Web Services managed -// 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS User Guide. +// this Region. +// +// Amazon Web Services creates a unique Amazon Web Services managed 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] in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html func (c *Client) ModifyEbsDefaultKmsKeyId(ctx context.Context, params *ModifyEbsDefaultKmsKeyIdInput, optFns ...func(*Options)) (*ModifyEbsDefaultKmsKeyIdOutput, error) { if params == nil { params = &ModifyEbsDefaultKmsKeyIdInput{} @@ -40,17 +45,25 @@ 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 - // specify the KMS key using any of the following: + // 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. + // complete, but eventually fails. + // + // Amazon EBS does not support asymmetric KMS keys. // // This member is required. KmsKeyId *string diff --git a/service/ec2/api_op_ModifyFleet.go b/service/ec2/api_op_ModifyFleet.go index bf31dbf9aaf..d8d3d586822 100644 --- a/service/ec2/api_op_ModifyFleet.go +++ b/service/ec2/api_op_ModifyFleet.go @@ -11,29 +11,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// state. To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet +// 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 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 -// terminates the instances with the highest price per unit. If the allocation -// 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 -// 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 -// Fleet for now, but will use it again later, you can set the target capacity to -// 0. +// 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 Spot Instance pools that have the least +// available Spot Instance capacity. If the 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 Fleet for now, but will use it again later, +// you can set the target capacity to 0. func (c *Client) ModifyFleet(ctx context.Context, params *ModifyFleetInput, optFns ...func(*Options)) (*ModifyFleetOutput, error) { if params == nil { params = &ModifyFleetInput{} @@ -67,6 +74,7 @@ type ModifyFleetInput struct { // 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 . ExcessCapacityTerminationPolicy types.FleetExcessCapacityTerminationPolicy diff --git a/service/ec2/api_op_ModifyHosts.go b/service/ec2/api_op_ModifyHosts.go index 7a4d73a16cb..d04bff7699a 100644 --- a/service/ec2/api_op_ModifyHosts.go +++ b/service/ec2/api_op_ModifyHosts.go @@ -17,9 +17,11 @@ import ( // that has auto-placement enabled. When auto-placement is disabled, you need to // provide a host ID to have the instance launch onto a specific host. If no host // ID is provided, the instance is launched onto a suitable host with -// auto-placement enabled. You can also use this API action to modify a Dedicated -// Host to support either multiple instance types in an instance family, or to -// support a specific instance type only. +// auto-placement enabled. +// +// You can also use this API action to modify a Dedicated Host to support either +// multiple instance types in an instance family, or to support a specific instance +// type only. func (c *Client) ModifyHosts(ctx context.Context, params *ModifyHostsInput, optFns ...func(*Options)) (*ModifyHostsOutput, error) { if params == nil { params = &ModifyHostsInput{} @@ -46,28 +48,32 @@ 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) - // in the Amazon EC2 User Guide. + // For more information, see [Host maintenance]in the Amazon EC2 User Guide. + // + // [Host maintenance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html 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) - // in the Amazon EC2 User Guide. + // For more information, see [Host recovery]in the Amazon EC2 User Guide. + // + // [Host recovery]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html HostRecovery types.HostRecovery // Specifies the instance family to be supported by the Dedicated Host. Specify // this parameter to modify a Dedicated Host to support multiple instance types - // within its current instance family. If you want to modify a Dedicated Host to - // support a specific instance type only, omit this parameter and specify - // InstanceType instead. You cannot specify InstanceFamily and InstanceType in the - // same request. + // within its current instance family. + // + // If you want to modify a Dedicated Host to support a specific instance type + // only, omit this parameter and specify InstanceType instead. You cannot specify + // InstanceFamily and InstanceType in the same request. InstanceFamily *string // Specifies the instance type to be supported by the Dedicated Host. Specify this // parameter to modify a Dedicated Host to support only a specific instance type. - // If you want to modify a Dedicated Host to support multiple instance types in its - // current instance family, omit this parameter and specify InstanceFamily instead. - // You cannot specify InstanceType and InstanceFamily in the same request. + // + // If you want to modify a Dedicated Host to support multiple instance types in + // its current instance family, omit this parameter and specify InstanceFamily + // instead. You cannot specify InstanceType and InstanceFamily in the same request. InstanceType *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyIdFormat.go b/service/ec2/api_op_ModifyIdFormat.go index 2b36ac4a52e..6ddd51bd9d7 100644 --- a/service/ec2/api_op_ModifyIdFormat.go +++ b/service/ec2/api_op_ModifyIdFormat.go @@ -12,24 +12,30 @@ import ( // 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 | -// 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 | +// 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 | 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 | // 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 -// 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. +// | 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] +// 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. +// +// [Resource IDs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html func (c *Client) ModifyIdFormat(ctx context.Context, params *ModifyIdFormatInput, optFns ...func(*Options)) (*ModifyIdFormatOutput, error) { if params == nil { params = &ModifyIdFormatInput{} @@ -53,9 +59,10 @@ type ModifyIdFormatInput struct { // | 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 - // all-current option to include all resource types that are currently within their - // opt-in period for longer IDs. + // | 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. // // This member is required. Resource *string diff --git a/service/ec2/api_op_ModifyIdentityIdFormat.go b/service/ec2/api_op_ModifyIdentityIdFormat.go index 2d8620ba113..748e529b757 100644 --- a/service/ec2/api_op_ModifyIdentityIdFormat.go +++ b/service/ec2/api_op_ModifyIdentityIdFormat.go @@ -13,21 +13,28 @@ import ( // Modifies the ID format of a resource for a specified IAM user, IAM role, or the // root user for an account; or all IAM users, IAM roles, and the root user for an // account. 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 | 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 | +// 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 | 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 | // 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] 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. +// +// [Resource IDs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html func (c *Client) ModifyIdentityIdFormat(ctx context.Context, params *ModifyIdentityIdFormatInput, optFns ...func(*Options)) (*ModifyIdentityIdFormatOutput, error) { if params == nil { params = &ModifyIdentityIdFormatInput{} @@ -58,9 +65,10 @@ type ModifyIdentityIdFormatInput struct { // | 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 - // all-current option to include all resource types that are currently within their - // opt-in period for longer IDs. + // | 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. // // This member is required. Resource *string diff --git a/service/ec2/api_op_ModifyImageAttribute.go b/service/ec2/api_op_ModifyImageAttribute.go index 1552bd03f1b..00c832f2057 100644 --- a/service/ec2/api_op_ModifyImageAttribute.go +++ b/service/ec2/api_op_ModifyImageAttribute.go @@ -12,12 +12,16 @@ 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 -// 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. +// 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 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. func (c *Client) ModifyImageAttribute(ctx context.Context, params *ModifyImageAttributeInput, optFns ...func(*Options)) (*ModifyImageAttributeOutput, error) { if params == nil { params = &ModifyImageAttributeInput{} @@ -41,8 +45,9 @@ type ModifyImageAttributeInput struct { // This member is required. ImageId *string - // The name of the attribute to modify. Valid values: description | imdsSupport | - // launchPermission + // The name of the attribute to modify. + // + // Valid values: description | imdsSupport | launchPermission Attribute *string // A new description for the AMI. @@ -58,10 +63,13 @@ type ModifyImageAttributeInput struct { // 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. 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 - // way to “reset” your AMI is to create a new AMI from the underlying snapshot. + // information, see [Configure the AMI]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 way to “reset” your AMI is + // to create a new AMI from the underlying snapshot. + // + // [Configure the AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration ImdsSupport *types.AttributeValue // A new launch permission for the AMI. diff --git a/service/ec2/api_op_ModifyInstanceAttribute.go b/service/ec2/api_op_ModifyInstanceAttribute.go index e780a2ef494..f20d8042bd4 100644 --- a/service/ec2/api_op_ModifyInstanceAttribute.go +++ b/service/ec2/api_op_ModifyInstanceAttribute.go @@ -12,14 +12,18 @@ import ( ) // 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 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. +// 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 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 ModifyNetworkInterfaceAttributeaction. +// +// To modify some attributes, the instance must be stopped. For more information, +// see [Modify a stopped instance]in the Amazon EC2 User Guide. +// +// [Modify a stopped instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html func (c *Client) ModifyInstanceAttribute(ctx context.Context, params *ModifyInstanceAttributeInput, optFns ...func(*Options)) (*ModifyInstanceAttributeOutput, error) { if params == nil { params = &ModifyInstanceAttributeInput{} @@ -42,26 +46,31 @@ type ModifyInstanceAttributeInput struct { // This member is required. InstanceId *string - // The name of the attribute to modify. You can modify the following attributes - // only: disableApiTermination | instanceType | kernel | ramdisk | - // instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | - // sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | - // nvmeSupport | disableApiStop | enclaveOptions + // The name of the attribute to modify. + // + // You can modify the following attributes only: disableApiTermination | + // instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | + // blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | + // sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions Attribute types.InstanceAttributeName // 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 // instance is terminated. You can't modify the DeleteOnTermination attribute for - // volumes that are attached to Fargate tasks. 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) - // in the Amazon EC2 User Guide. + // volumes that are attached to Fargate tasks. + // + // 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]in the Amazon EC2 + // User Guide. + // + // [Update the block device mapping when launching an instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM 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]. + // + // [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 @@ -82,9 +91,10 @@ 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 // Replaces the security groups of the instance with the specified security @@ -96,20 +106,23 @@ type ModifyInstanceAttributeInput struct { // from the instance (using the operating system command for system shutdown). 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 . + // Changes the instance type to the specified value. For more information, see [Instance types] 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 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]. + // + // [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]. + // + // [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 @@ -121,10 +134,13 @@ type ModifyInstanceAttributeInput struct { SourceDestCheck *types.AttributeBooleanValue // Set to simple to enable enhanced networking with the Intel 82599 Virtual - // Function interface for the instance. There is no way to disable enhanced - // networking with the Intel 82599 Virtual Function interface at this time. This - // option is supported only for HVM instances. Specifying this option with a PV - // instance can make it unreachable. + // Function interface for the instance. + // + // There is no way to disable enhanced networking with the Intel 82599 Virtual + // Function interface at this time. + // + // This option is supported only for HVM instances. Specifying this option with a + // PV instance can make it unreachable. SriovNetSupport *types.AttributeValue // Changes the instance's user data to the specified value. If you are using an diff --git a/service/ec2/api_op_ModifyInstanceCreditSpecification.go b/service/ec2/api_op_ModifyInstanceCreditSpecification.go index 2d27d673ef6..977a823c083 100644 --- a/service/ec2/api_op_ModifyInstanceCreditSpecification.go +++ b/service/ec2/api_op_ModifyInstanceCreditSpecification.go @@ -12,9 +12,11 @@ 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) -// in the Amazon EC2 User Guide. +// performance instance. The credit options are standard and unlimited . +// +// For more information, see [Burstable performance instances] in the Amazon EC2 User Guide. +// +// [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html func (c *Client) ModifyInstanceCreditSpecification(ctx context.Context, params *ModifyInstanceCreditSpecificationInput, optFns ...func(*Options)) (*ModifyInstanceCreditSpecificationOutput, error) { if params == nil { params = &ModifyInstanceCreditSpecificationInput{} @@ -38,8 +40,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_ModifyInstanceEventWindow.go b/service/ec2/api_op_ModifyInstanceEventWindow.go index 67f1017227e..eee982d7c9b 100644 --- a/service/ec2/api_op_ModifyInstanceEventWindow.go +++ b/service/ec2/api_op_ModifyInstanceEventWindow.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified event window. You can define either a set of time ranges -// or a cron expression when modifying the event window, but not both. To modify -// the targets associated with the event window, use the -// 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. +// Modifies the specified event window. +// +// You can define either a set of time ranges or a cron expression when modifying +// the event window, but not both. +// +// To modify the targets associated with the event window, use the 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] in the Amazon EC2 User Guide. +// +// [Define event windows for scheduled events]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html func (c *Client) ModifyInstanceEventWindow(ctx context.Context, params *ModifyInstanceEventWindowInput, optFns ...func(*Options)) (*ModifyInstanceEventWindowOutput, error) { if params == nil { params = &ModifyInstanceEventWindowInput{} @@ -42,18 +47,27 @@ type ModifyInstanceEventWindowInput struct { InstanceEventWindowId *string // 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. + // + // For more information about cron expressions, see [cron] on the Wikipedia website. + // + // [cron]: https://en.wikipedia.org/wiki/Cron CronExpression *string // Checks whether you have the required permissions for the action, without diff --git a/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go b/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go index d17dd5a4c19..851e5ad88be 100644 --- a/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go +++ b/service/ec2/api_op_ModifyInstanceMaintenanceOptions.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} diff --git a/service/ec2/api_op_ModifyInstanceMetadataDefaults.go b/service/ec2/api_op_ModifyInstanceMetadataDefaults.go index c8915f8cf45..5ec0f8c0cc5 100644 --- a/service/ec2/api_op_ModifyInstanceMetadataDefaults.go +++ b/service/ec2/api_op_ModifyInstanceMetadataDefaults.go @@ -12,12 +12,14 @@ import ( ) // Modifies the default instance metadata service (IMDS) settings at the account -// level in the specified Amazon Web Services
 Region. To remove a parameter's -// account-level default setting, specify no-preference . If an account-level -// setting is cleared with no-preference , then the instance launch considers the -// other instance metadata settings. For more information, see Order of precedence -// for instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) -// in the Amazon EC2 User Guide. +// level in the specified Amazon Web Services
 Region. +// +// To remove a parameter's account-level default setting, specify no-preference . +// If an account-level setting is cleared with no-preference , then the instance +// launch considers the other instance metadata settings. For more information, see +// [Order of precedence for instance metadata options]in the Amazon EC2 User Guide. +// +// [Order of precedence for instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence func (c *Client) ModifyInstanceMetadataDefaults(ctx context.Context, params *ModifyInstanceMetadataDefaultsInput, optFns ...func(*Options)) (*ModifyInstanceMetadataDefaultsOutput, error) { if params == nil { params = &ModifyInstanceMetadataDefaultsInput{} @@ -46,20 +48,24 @@ type ModifyInstanceMetadataDefaultsInput struct { HttpEndpoint types.DefaultInstanceMetadataEndpointState // The maximum number of hops that the metadata token can travel. To indicate no - // preference, specify -1 . Possible values: Integers from 1 to 64 , and -1 to - // indicate no preference + // preference, specify -1 . + // + // Possible values: Integers from 1 to 64 , and -1 to indicate no preference HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional – IMDSv2 is optional, which means that you can use either IMDSv2 or // IMDSv1. + // // - required – IMDSv2 is required, which means that IMDSv1 is disabled, and you // must use IMDSv2. HttpTokens types.MetadataDefaultHttpTokensState // Enables or disables access to an instance's 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) - // in the Amazon EC2 User Guide. + // For more information, see [Work with instance tags using the instance metadata]in the Amazon EC2 User Guide. + // + // [Work with instance tags using the instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags types.DefaultInstanceMetadataTagsState noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstanceMetadataOptions.go b/service/ec2/api_op_ModifyInstanceMetadataOptions.go index aed20dec863..967af0891f7 100644 --- a/service/ec2/api_op_ModifyInstanceMetadataOptions.go +++ b/service/ec2/api_op_ModifyInstanceMetadataOptions.go @@ -17,8 +17,9 @@ 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) -// in the Amazon EC2 User Guide. +// information, see [Instance metadata and user data]in the Amazon EC2 User Guide. +// +// [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html func (c *Client) ModifyInstanceMetadataOptions(ctx context.Context, params *ModifyInstanceMetadataOptionsInput, optFns ...func(*Options)) (*ModifyInstanceMetadataOptionsOutput, error) { if params == nil { params = &ModifyInstanceMetadataOptionsInput{} @@ -48,8 +49,9 @@ type ModifyInstanceMetadataOptionsInput struct { 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. + // parameter is not specified, the existing state is maintained. + // + // If you specify a value of disabled , you cannot access your instance metadata. HttpEndpoint types.InstanceMetadataEndpointState // Enables or disables the IPv6 endpoint for the instance metadata service. @@ -58,36 +60,45 @@ type ModifyInstanceMetadataOptionsInput struct { // The desired HTTP PUT response hop limit for instance metadata requests. The // larger the number, the further instance metadata requests can travel. If no - // parameter is specified, the existing state is maintained. Possible values: - // Integers from 1 to 64 + // parameter is specified, the existing state is maintained. + // + // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional - IMDSv2 is optional. You can choose whether to send a session // token in your instance metadata retrieval requests. If you retrieve IAM role // credentials without a session token, you receive the IMDSv1 role credentials. If // you retrieve IAM role credentials using a valid session token, you receive the // IMDSv2 role credentials. + // // - required - IMDSv2 is required. You must send a session token in your // instance metadata retrieval requests. With this option, retrieving the IAM role // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not // available. + // // Default: + // // - If the value of ImdsSupport for the Amazon Machine Image (AMI) for your // instance is v2.0 and the account level default is set to no-preference , the // default is required . + // // - If the value of ImdsSupport for the Amazon Machine Image (AMI) for your // instance is v2.0 , but the account level default is set to V1 or V2 , the // default is optional . + // // The default value can also be affected by other combinations of parameters. For - // more information, see Order of precedence for instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) - // in the Amazon EC2 User Guide. + // more information, see [Order of precedence for instance metadata options]in the Amazon EC2 User Guide. + // + // [Order of precedence for instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence 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) - // . + // more information, see [Work with instance tags using the instance metadata]. + // + // [Work with instance tags using the instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags types.InstanceMetadataTagsState noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyInstancePlacement.go b/service/ec2/api_op_ModifyInstancePlacement.go index 57c76e2298d..28175ea0c43 100644 --- a/service/ec2/api_op_ModifyInstancePlacement.go +++ b/service/ec2/api_op_ModifyInstancePlacement.go @@ -13,20 +13,27 @@ 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 started, it is -// automatically associated with the host on which it lands. If the instance is -// restarted or rebooted, this relationship persists. +// +// - Modify the affinity between an instance and a [Dedicated Host]. When affinity is set to host +// and the instance is not associated with a specific Dedicated Host, the next time +// the instance is started, 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) -// . +// +// - Move an instance to or from a [placement group]. // // 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. +// same request. +// +// To modify the host ID, tenancy, placement group, or partition for an instance, +// the instance must be in the stopped state. +// +// [Dedicated Host]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html +// [placement group]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html func (c *Client) ModifyInstancePlacement(ctx context.Context, params *ModifyInstancePlacementInput, optFns ...func(*Options)) (*ModifyInstancePlacementOutput, error) { if params == nil { params = &ModifyInstancePlacementInput{} @@ -49,8 +56,10 @@ type ModifyInstancePlacementInput struct { // This member is required. InstanceId *string - // The affinity setting for the instance. For more information, see Host affinity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity) - // in the Amazon EC2 User Guide. + // The affinity setting for the instance. For more information, see [Host affinity] in the Amazon + // EC2 User Guide. + // + // [Host affinity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity Affinity types.Affinity // The Group Id of a placement group. You must specify the Placement Group Group @@ -60,8 +69,9 @@ type ModifyInstancePlacementInput struct { // 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 // 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. @@ -75,10 +85,12 @@ type ModifyInstancePlacementInput struct { // placement group strategy is set to partition . PartitionNumber *int32 - // The tenancy for the instance. For T3 instances, you must launch the instance on - // a Dedicated Host to use a tenancy of host . You can't change the tenancy from - // host to dedicated or default . Attempting to make one of these unsupported - // tenancy changes results in an InvalidRequest error code. + // The tenancy for the instance. + // + // For T3 instances, you must launch the instance on a Dedicated Host to use a + // tenancy of host . You can't change the tenancy from host to dedicated or default + // . Attempting to make one of these unsupported tenancy changes results in an + // InvalidRequest error code. Tenancy types.HostTenancy noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyIpam.go b/service/ec2/api_op_ModifyIpam.go index 3be528c4722..264de49facf 100644 --- a/service/ec2/api_op_ModifyIpam.go +++ b/service/ec2/api_op_ModifyIpam.go @@ -37,9 +37,12 @@ type ModifyIpamInput struct { // Choose the operating Regions for the IPAM. Operating Regions are Amazon Web // Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only // discovers and monitors resources in the Amazon Web Services Regions you select - // as operating Regions. For more information about operating Regions, see Create - // an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the - // Amazon VPC IPAM User Guide. + // as operating Regions. + // + // For more information about operating Regions, see [Create an IPAM] in the Amazon VPC IPAM User + // Guide. + // + // [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html AddOperatingRegions []types.AddIpamOperatingRegion // The description of the IPAM you want to modify. @@ -56,7 +59,9 @@ type ModifyIpamInput struct { // IPAM is offered in a Free Tier and an Advanced Tier. For more information about // the features available in each tier and the costs associated with the tiers, see - // Amazon VPC pricing > IPAM tab (http://aws.amazon.com/vpc/pricing/) . + // [Amazon VPC pricing > IPAM tab]. + // + // [Amazon VPC pricing > IPAM tab]: http://aws.amazon.com/vpc/pricing/ Tier types.IpamTier noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyIpamPool.go b/service/ec2/api_op_ModifyIpamPool.go index 5894e9848e0..c76a06570e7 100644 --- a/service/ec2/api_op_ModifyIpamPool.go +++ b/service/ec2/api_op_ModifyIpamPool.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modify the configurations of an IPAM pool. For more information, see Modify a -// pool (https://docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html) in the -// Amazon VPC IPAM User Guide. +// Modify the configurations of an IPAM pool. +// +// For more information, see [Modify a pool] in the Amazon VPC IPAM User Guide. +// +// [Modify a pool]: https://docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html func (c *Client) ModifyIpamPool(ctx context.Context, params *ModifyIpamPoolInput, optFns ...func(*Options)) (*ModifyIpamPoolOutput, error) { if params == nil { params = &ModifyIpamPoolInput{} @@ -37,8 +39,9 @@ type ModifyIpamPoolInput struct { 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. + // rules, see [Create a top-level pool]in the Amazon VPC IPAM User Guide. + // + // [Create a top-level pool]: https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html AddAllocationResourceTags []types.RequestIpamResourceTag // The default netmask length for allocations added to this pool. If, for example, @@ -66,7 +69,9 @@ type ModifyIpamPoolInput struct { // 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. + // 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. diff --git a/service/ec2/api_op_ModifyIpamResourceCidr.go b/service/ec2/api_op_ModifyIpamResourceCidr.go index 33ba04752c3..63198e90c78 100644 --- a/service/ec2/api_op_ModifyIpamResourceCidr.go +++ b/service/ec2/api_op_ModifyIpamResourceCidr.go @@ -15,9 +15,12 @@ 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) -// in the Amazon VPC IPAM User Guide. +// allocation in. +// +// For more information, see [Move resource CIDRs between scopes] and [Change the monitoring state of resource CIDRs] in the Amazon VPC IPAM User Guide. +// +// [Change the monitoring state of resource CIDRs]: https://docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html +// [Move resource CIDRs between scopes]: https://docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html func (c *Client) ModifyIpamResourceCidr(ctx context.Context, params *ModifyIpamResourceCidrInput, optFns ...func(*Options)) (*ModifyIpamResourceCidrOutput, error) { if params == nil { params = &ModifyIpamResourceCidrInput{} diff --git a/service/ec2/api_op_ModifyLaunchTemplate.go b/service/ec2/api_op_ModifyLaunchTemplate.go index 67b0d9cf617..338383bce13 100644 --- a/service/ec2/api_op_ModifyLaunchTemplate.go +++ b/service/ec2/api_op_ModifyLaunchTemplate.go @@ -32,8 +32,11 @@ 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]. + // + // Constraint: Maximum 128 ASCII characters. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The version number of the launch template to set as the default version. @@ -45,12 +48,16 @@ type ModifyLaunchTemplateInput struct { // UnauthorizedOperation . DryRun *bool - // The ID of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The ID of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateId *string - // The name of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The name of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateName *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyLocalGatewayRoute.go b/service/ec2/api_op_ModifyLocalGatewayRoute.go index 0f1b5e1f8c3..567d832b11d 100644 --- a/service/ec2/api_op_ModifyLocalGatewayRoute.go +++ b/service/ec2/api_op_ModifyLocalGatewayRoute.go @@ -38,7 +38,7 @@ 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 @@ -49,7 +49,7 @@ type ModifyLocalGatewayRouteInput struct { // UnauthorizedOperation . DryRun *bool - // The ID of the virtual interface group. + // The ID of the virtual interface group. LocalGatewayVirtualInterfaceGroupId *string // The ID of the network interface. diff --git a/service/ec2/api_op_ModifyManagedPrefixList.go b/service/ec2/api_op_ModifyManagedPrefixList.go index 42ed22ed470..9a185b84dab 100644 --- a/service/ec2/api_op_ModifyManagedPrefixList.go +++ b/service/ec2/api_op_ModifyManagedPrefixList.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified managed prefix list. Adding or removing entries in a -// prefix list creates a new version of the prefix list. Changing the name of the -// prefix list does not affect the version. If you specify a current version number -// that does not match the true current version number, the request fails. +// Modifies the specified managed prefix list. +// +// Adding or removing entries in a prefix list creates a new version of the prefix +// list. Changing the name of the prefix list does not affect the version. +// +// If you specify a current version number that does not match the true current +// version number, the request fails. func (c *Client) ModifyManagedPrefixList(ctx context.Context, params *ModifyManagedPrefixListInput, optFns ...func(*Options)) (*ModifyManagedPrefixListOutput, error) { if params == nil { params = &ModifyManagedPrefixListInput{} @@ -51,6 +54,7 @@ type ModifyManagedPrefixListInput struct { // 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. diff --git a/service/ec2/api_op_ModifyReservedInstances.go b/service/ec2/api_op_ModifyReservedInstances.go index 807e162125e..35e7f9928ae 100644 --- a/service/ec2/api_op_ModifyReservedInstances.go +++ b/service/ec2/api_op_ModifyReservedInstances.go @@ -14,8 +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. +// type. +// +// For more information, see [Modifying Reserved Instances] in the Amazon EC2 User Guide. +// +// [Modifying Reserved Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html func (c *Client) ModifyReservedInstances(ctx context.Context, params *ModifyReservedInstancesInput, optFns ...func(*Options)) (*ModifyReservedInstancesOutput, error) { if params == nil { params = &ModifyReservedInstancesInput{} @@ -45,8 +48,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifySnapshotAttribute.go b/service/ec2/api_op_ModifySnapshotAttribute.go index 935410c000c..32cb1d50b67 100644 --- a/service/ec2/api_op_ModifySnapshotAttribute.go +++ b/service/ec2/api_op_ModifySnapshotAttribute.go @@ -16,11 +16,16 @@ import ( // create volume permissions, but you cannot do both in a single operation. If you // need to both add and remove account IDs for a snapshot, you must use multiple // operations. You can make up to 500 modifications to a snapshot in a single -// 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/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html) -// in the Amazon EBS User Guide. +// 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] in the Amazon +// EBS User Guide. +// +// [Share a snapshot]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html func (c *Client) ModifySnapshotAttribute(ctx context.Context, params *ModifySnapshotAttributeInput, optFns ...func(*Options)) (*ModifySnapshotAttributeOutput, error) { if params == nil { params = &ModifySnapshotAttributeInput{} diff --git a/service/ec2/api_op_ModifySnapshotTier.go b/service/ec2/api_op_ModifySnapshotTier.go index eb554e24715..ec835f58beb 100644 --- a/service/ec2/api_op_ModifySnapshotTier.go +++ b/service/ec2/api_op_ModifySnapshotTier.go @@ -15,8 +15,10 @@ import ( // 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/ebs/latest/userguide/snapshot-archive.html) -// in the Amazon EBS User Guide. +// tier to the archive tier. For more information, see [Archive Amazon EBS snapshots]in the Amazon EBS User +// Guide. +// +// [Archive Amazon EBS snapshots]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html func (c *Client) ModifySnapshotTier(ctx context.Context, params *ModifySnapshotTierInput, optFns ...func(*Options)) (*ModifySnapshotTierOutput, error) { if params == nil { params = &ModifySnapshotTierInput{} diff --git a/service/ec2/api_op_ModifySpotFleetRequest.go b/service/ec2/api_op_ModifySpotFleetRequest.go index c9a12e27c00..b890a1a04d4 100644 --- a/service/ec2/api_op_ModifySpotFleetRequest.go +++ b/service/ec2/api_op_ModifySpotFleetRequest.go @@ -11,29 +11,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 +// 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 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. +// 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,6 +69,7 @@ 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 . ExcessCapacityTerminationPolicy types.ExcessCapacityTerminationPolicy diff --git a/service/ec2/api_op_ModifySubnetAttribute.go b/service/ec2/api_op_ModifySubnetAttribute.go index e1ea5e8285b..b35c098efbd 100644 --- a/service/ec2/api_op_ModifySubnetAttribute.go +++ b/service/ec2/api_op_ModifySubnetAttribute.go @@ -11,16 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies a subnet attribute. You can only modify one attribute at a time. Use -// this action to modify subnets on Amazon Web Services Outposts. +// 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 . // // 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) +// +// [Outpost servers] +// +// [Outpost racks] +// +// [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{} @@ -46,16 +54,19 @@ type ModifySubnetAttributeInput struct { // 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. + // 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 . + // The customer-owned IPv4 address pool associated with the subnet. + // + // You must set this value when you specify true for MapCustomerOwnedIpOnLaunch . CustomerOwnedIpv4Pool *string - // Specify true to indicate that local network interfaces at the current position + // Specify true to indicate that local network interfaces at the current position // should be disabled. DisableLniAtDeviceIndex *types.AttributeBooleanValue @@ -63,7 +74,7 @@ type ModifySubnetAttributeInput struct { // subnet should return synthetic IPv6 addresses for IPv4-only destinations. EnableDns64 *types.AttributeBooleanValue - // Indicates the device position for local network interfaces in this subnet. For + // 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). A local network interface cannot be the primary // network interface (eth0). @@ -78,17 +89,20 @@ type ModifySubnetAttributeInput struct { EnableResourceNameDnsARecordOnLaunch *types.AttributeBooleanValue // 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 + // 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 . MapCustomerOwnedIpOnLaunch *types.AttributeBooleanValue // Specify true to indicate that network interfaces attached to instances created - // in the specified subnet should be assigned a public IPv4 address. Amazon Web - // Services charges for all public IPv4 addresses, including public IPv4 addresses - // associated with running instances and Elastic IP addresses. For more - // information, see the Public IPv4 Address tab on the Amazon VPC pricing page (http://aws.amazon.com/vpc/pricing/) - // . + // in the specified subnet should be assigned a public IPv4 address. + // + // Amazon Web Services charges for all public IPv4 addresses, including public + // IPv4 addresses associated with running instances and Elastic IP addresses. For + // more information, see the Public IPv4 Address tab on the [Amazon VPC pricing page]. + // + // [Amazon VPC pricing page]: http://aws.amazon.com/vpc/pricing/ MapPublicIpOnLaunch *types.AttributeBooleanValue // The type of hostname to assign to instances in the subnet at launch. For diff --git a/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go b/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go index bac869743d2..c4eb26994e7 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go +++ b/service/ec2/api_op_ModifyTrafficMirrorFilterNetworkServices.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows or restricts mirroring network services. By default, Amazon DNS network -// services are not eligible for Traffic Mirror. Use AddNetworkServices to add -// network services to a Traffic Mirror filter. When a network service is added to -// the Traffic Mirror filter, all traffic related to that network service will be -// mirrored. When you no longer want to mirror network services, use -// RemoveNetworkServices to remove the network services from the Traffic Mirror -// filter. +// Allows or restricts mirroring network services. +// +// By default, Amazon DNS network services are not eligible for Traffic Mirror. +// Use AddNetworkServices to add network services to a Traffic Mirror filter. When +// a network service is added to the Traffic Mirror filter, all traffic related to +// that network service will be mirrored. When you no longer want to mirror network +// services, use RemoveNetworkServices to remove the network services from the +// Traffic Mirror filter. func (c *Client) ModifyTrafficMirrorFilterNetworkServices(ctx context.Context, params *ModifyTrafficMirrorFilterNetworkServicesInput, optFns ...func(*Options)) (*ModifyTrafficMirrorFilterNetworkServicesOutput, error) { if params == nil { params = &ModifyTrafficMirrorFilterNetworkServicesInput{} diff --git a/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go b/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go index 729dcd52efb..6eca07731d0 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go +++ b/service/ec2/api_op_ModifyTrafficMirrorFilterRule.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the specified Traffic Mirror rule. DestinationCidrBlock and -// SourceCidrBlock must both be an IPv4 range or an IPv6 range. +// Modifies the specified Traffic Mirror rule. +// +// DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 +// range. func (c *Client) ModifyTrafficMirrorFilterRule(ctx context.Context, params *ModifyTrafficMirrorFilterRuleInput, optFns ...func(*Options)) (*ModifyTrafficMirrorFilterRuleOutput, error) { if params == nil { params = &ModifyTrafficMirrorFilterRuleInput{} @@ -54,6 +56,7 @@ type ModifyTrafficMirrorFilterRuleInput struct { 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. RemoveFields []types.TrafficMirrorFilterRuleField diff --git a/service/ec2/api_op_ModifyTrafficMirrorSession.go b/service/ec2/api_op_ModifyTrafficMirrorSession.go index 83d76b16548..99437ad33c6 100644 --- a/service/ec2/api_op_ModifyTrafficMirrorSession.go +++ b/service/ec2/api_op_ModifyTrafficMirrorSession.go @@ -47,20 +47,24 @@ type ModifyTrafficMirrorSessionInput struct { // header. To mirror a subset, set this to the length (in bytes) to mirror. For // example, if you set this value to 100, then the first 100 bytes that meet the // filter criteria are copied to the target. Do not specify this parameter when you - // want to mirror the entire packet. For sessions with Network Load Balancer (NLB) - // traffic mirror targets, the default PacketLength will be set to 8500. Valid - // values are 1-8500. Setting a PacketLength greater than 8500 will result in an - // error response. + // want to mirror the entire packet. + // + // For sessions with Network Load Balancer (NLB) traffic mirror targets, the + // default PacketLength will be set to 8500. Valid values are 1-8500. Setting a + // PacketLength greater than 8500 will result in an error response. 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 - // default. + // 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 // The session number determines the order in which sessions are evaluated when an // interface is used by multiple sessions. The first session with a matching filter - // is the one that mirrors the packets. Valid values are 1-32766. + // is the one that mirrors the packets. + // + // Valid values are 1-32766. SessionNumber *int32 // The ID of the Traffic Mirror filter. diff --git a/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go b/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go index 61d9c145faf..c78dc63aa62 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go +++ b/service/ec2/api_op_ModifyVerifiedAccessEndpoint.go @@ -36,8 +36,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access endpoint. diff --git a/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go b/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go index 6b19f15e101..dafb8d42dd3 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go +++ b/service/ec2/api_op_ModifyVerifiedAccessEndpointPolicy.go @@ -35,8 +35,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_ModifyVerifiedAccessGroup.go b/service/ec2/api_op_ModifyVerifiedAccessGroup.go index 082ca25e9de..6b5720da668 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessGroup.go +++ b/service/ec2/api_op_ModifyVerifiedAccessGroup.go @@ -35,8 +35,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access group. diff --git a/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go b/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go index 967e70ed476..9b91d0ad67a 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go +++ b/service/ec2/api_op_ModifyVerifiedAccessGroupPolicy.go @@ -35,8 +35,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_ModifyVerifiedAccessInstance.go b/service/ec2/api_op_ModifyVerifiedAccessInstance.go index 887ab4c3516..b03f6d8fcee 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessInstance.go +++ b/service/ec2/api_op_ModifyVerifiedAccessInstance.go @@ -36,8 +36,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access instance. diff --git a/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go b/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go index 19cfb750faa..54c65bca35e 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go +++ b/service/ec2/api_op_ModifyVerifiedAccessInstanceLoggingConfiguration.go @@ -41,8 +41,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go b/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go index 1a219de89eb..89062c19193 100644 --- a/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go +++ b/service/ec2/api_op_ModifyVerifiedAccessTrustProvider.go @@ -36,8 +36,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // A description for the Verified Access trust provider. diff --git a/service/ec2/api_op_ModifyVolume.go b/service/ec2/api_op_ModifyVolume.go index 20c5d4972b9..16dad4a4dc6 100644 --- a/service/ec2/api_op_ModifyVolume.go +++ b/service/ec2/api_op_ModifyVolume.go @@ -15,21 +15,28 @@ 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/ebs/latest/userguide/ebs-modify-volume.html) -// in the Amazon EBS User Guide. 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 the file system (https://docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html) -// . 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/ebs/latest/userguide/monitoring-volume-modifications.html) -// . With previous-generation instance types, resizing an EBS volume might require +// information about modifying EBS volumes, see [Amazon EBS Elastic Volumes]in the Amazon EBS User Guide. +// +// 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 the file system]. +// +// 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]. 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]. +// +// 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 // volume. This is sometimes referred to as a cooldown period. +// +// [Monitor the progress of volume modifications]: https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html +// [Amazon EBS Elastic Volumes]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modify-volume.html +// [Extend the file system]: https://docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html +// [Amazon CloudWatch Events User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ func (c *Client) ModifyVolume(ctx context.Context, params *ModifyVolumeInput, optFns ...func(*Options)) (*ModifyVolumeOutput, error) { if params == nil { params = &ModifyVolumeInput{} @@ -59,44 +66,67 @@ type ModifyVolumeInput struct { DryRun *bool // 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: + // 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 - 256,000 IOPS - // For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the - // Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) - // . On other instances, you can achieve performance up to 32,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. + // + // For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances, + // you can achieve performance up to 32,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. + // + // [instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances 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) - // 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/ebs/latest/userguide/ebs-volumes-multi.html) - // in the Amazon EBS User Guide. + // Multi-Attach, you can attach the volume to up to 16 [Nitro-based instances]in the same Availability + // Zone. This parameter is supported with io1 and io2 volumes only. For more + // information, see [Amazon EBS Multi-Attach]in the Amazon EBS User Guide. + // + // [Amazon EBS Multi-Attach]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html + // [Nitro-based instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances 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: + // 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 GiB + // // - io1 : 4 - 16,384 GiB + // // - io2 : 4 - 65,536 GiB + // // - st1 and sc1 : 125 - 16,384 GiB + // // - standard : 1 - 1024 GiB + // // 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 - // 125. Valid Range: Minimum value of 125. Maximum value of 1000. + // 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 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/ebs/latest/userguide/ebs-volume-types.html) - // in the Amazon EBS User Guide. Default: The existing type is retained. + // The target EBS volume type of the volume. For more information, see [Amazon EBS volume types] in the + // Amazon EBS User Guide. + // + // Default: The existing type is retained. + // + // [Amazon EBS volume types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html VolumeType types.VolumeType noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVolumeAttribute.go b/service/ec2/api_op_ModifyVolumeAttribute.go index a9a398c1cf9..3986b575441 100644 --- a/service/ec2/api_op_ModifyVolumeAttribute.go +++ b/service/ec2/api_op_ModifyVolumeAttribute.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies a volume attribute. By default, all I/O operations for the volume are -// suspended when the data on the volume is determined to be potentially -// inconsistent, to prevent undetectable, latent data corruption. The I/O access to -// the volume can be resumed by first enabling I/O access and then checking the -// data consistency on your volume. You can change the default behavior to resume -// I/O operations. We recommend that you change this only for boot volumes or for -// volumes that are stateless or disposable. +// Modifies a volume attribute. +// +// By default, all I/O operations for the volume are suspended when the data on +// the volume is determined to be potentially inconsistent, to prevent +// undetectable, latent data corruption. The I/O access to the volume can be +// resumed by first enabling I/O access and then checking the data consistency on +// your volume. +// +// You can change the default behavior to resume I/O operations. We recommend that +// you change this only for boot volumes or for volumes that are stateless or +// disposable. func (c *Client) ModifyVolumeAttribute(ctx context.Context, params *ModifyVolumeAttributeInput, optFns ...func(*Options)) (*ModifyVolumeAttributeOutput, error) { if params == nil { params = &ModifyVolumeAttributeInput{} diff --git a/service/ec2/api_op_ModifyVpcAttribute.go b/service/ec2/api_op_ModifyVpcAttribute.go index 37d2fb30dda..122cdf5ace3 100644 --- a/service/ec2/api_op_ModifyVpcAttribute.go +++ b/service/ec2/api_op_ModifyVpcAttribute.go @@ -35,8 +35,9 @@ type ModifyVpcAttributeInput struct { VpcId *string // Indicates whether the instances launched in the VPC get DNS hostnames. If - // enabled, instances in the VPC get DNS hostnames; otherwise, they do not. You - // cannot modify the DNS resolution and DNS hostnames attributes in the same + // enabled, instances in the VPC get DNS hostnames; otherwise, they do not. + // + // You cannot modify the DNS resolution and DNS hostnames attributes in the same // request. Use separate requests for each attribute. You can only enable DNS // hostnames if you've enabled DNS support. EnableDnsHostnames *types.AttributeBooleanValue @@ -45,9 +46,10 @@ type ModifyVpcAttributeInput struct { // queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or // the reserved IP address at the base of the VPC network range "plus two" succeed. // If disabled, the Amazon provided DNS service in the VPC that resolves public DNS - // hostnames to IP addresses is not enabled. You cannot modify the DNS resolution - // and DNS hostnames attributes in the same request. Use separate requests for each - // attribute. + // hostnames to IP addresses is not enabled. + // + // You cannot modify the DNS resolution and DNS hostnames attributes in the same + // request. Use separate requests for each attribute. EnableDnsSupport *types.AttributeBooleanValue // Indicates whether Network Address Usage metrics are enabled for your VPC. diff --git a/service/ec2/api_op_ModifyVpcEndpoint.go b/service/ec2/api_op_ModifyVpcEndpoint.go index 4007f5ae9a6..bd834b12619 100644 --- a/service/ec2/api_op_ModifyVpcEndpoint.go +++ b/service/ec2/api_op_ModifyVpcEndpoint.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} diff --git a/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go b/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go index 8872fa0bc1d..bfdb8eac6e5 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go +++ b/service/ec2/api_op_ModifyVpcEndpointServiceConfiguration.go @@ -13,8 +13,10 @@ import ( // Modifies the attributes of your VPC endpoint service configuration. You can // change the Network Load Balancers or Gateway Load Balancers for your service, // and you can specify whether acceptance is required for requests to connect to -// your endpoint service through an interface VPC endpoint. If you set or modify -// the private DNS name, you must prove that you own the private DNS domain name. +// your endpoint service through an interface VPC endpoint. +// +// If you set or modify the private DNS name, you must prove that you own the +// private DNS domain name. func (c *Client) ModifyVpcEndpointServiceConfiguration(ctx context.Context, params *ModifyVpcEndpointServiceConfigurationInput, optFns ...func(*Options)) (*ModifyVpcEndpointServiceConfigurationOutput, error) { if params == nil { params = &ModifyVpcEndpointServiceConfigurationInput{} diff --git a/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go b/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go index 964a06747cb..b70e8d6a4fe 100644 --- a/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go +++ b/service/ec2/api_op_ModifyVpcEndpointServicePermissions.go @@ -13,10 +13,12 @@ import ( // Modifies the permissions for your VPC endpoint service. You can add or remove // permissions for service consumers (Amazon Web Services accounts, users, and IAM -// roles) to connect to your endpoint service. If you grant permissions to all -// principals, the service is public. Any users who know the name of a public -// service can send a request to attach an endpoint. If the service does not -// require manual approval, attachments are automatically approved. +// roles) to connect to your endpoint service. +// +// If you grant permissions to all principals, the service is public. Any users +// who know the name of a public service can send a request to attach an endpoint. +// If the service does not require manual approval, attachments are automatically +// approved. func (c *Client) ModifyVpcEndpointServicePermissions(ctx context.Context, params *ModifyVpcEndpointServicePermissionsInput, optFns ...func(*Options)) (*ModifyVpcEndpointServicePermissionsOutput, error) { if params == nil { params = &ModifyVpcEndpointServicePermissionsInput{} diff --git a/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go b/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go index 360f33fcad4..345762066dd 100644 --- a/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go +++ b/service/ec2/api_op_ModifyVpcPeeringConnectionOptions.go @@ -12,18 +12,19 @@ import ( ) // Modifies the VPC peering connection options on one side of a VPC peering -// connection. 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. +// connection. +// +// 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 DescribeVpcPeeringConnectionscommand. func (c *Client) ModifyVpcPeeringConnectionOptions(ctx context.Context, params *ModifyVpcPeeringConnectionOptionsInput, optFns ...func(*Options)) (*ModifyVpcPeeringConnectionOptionsOutput, error) { if params == nil { params = &ModifyVpcPeeringConnectionOptionsInput{} diff --git a/service/ec2/api_op_ModifyVpcTenancy.go b/service/ec2/api_op_ModifyVpcTenancy.go index 73b23040064..01a029e753a 100644 --- a/service/ec2/api_op_ModifyVpcTenancy.go +++ b/service/ec2/api_op_ModifyVpcTenancy.go @@ -13,12 +13,15 @@ import ( // 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 EC2 User Guide. +// 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] in the Amazon EC2 User Guide. +// +// [Dedicated Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html func (c *Client) ModifyVpcTenancy(ctx context.Context, params *ModifyVpcTenancyInput, optFns ...func(*Options)) (*ModifyVpcTenancyOutput, error) { if params == nil { params = &ModifyVpcTenancyInput{} diff --git a/service/ec2/api_op_ModifyVpnConnection.go b/service/ec2/api_op_ModifyVpnConnection.go index c61e6dc555a..da28d8f4282 100644 --- a/service/ec2/api_op_ModifyVpnConnection.go +++ b/service/ec2/api_op_ModifyVpnConnection.go @@ -14,30 +14,45 @@ 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 // // 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. +// gateway. Use CreateVpnGatewayto 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 -// CreateTransitGatewayRoute to add the routes. If you deleted VPN static routes, -// you must add the static routes to the transit gateway route table. After you -// perform this operation, the VPN endpoint's IP addresses on the Amazon Web -// Services side and the tunnel options remain intact. Your Amazon Web Services +// table. Use CreateRouteand DeleteRoute to make the changes described in [Update VPC route tables] 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 CreateTransitGatewayRouteto add the routes. +// +// If you deleted VPN static routes, you must add the static routes to the transit +// gateway route table. +// +// After you perform this operation, the VPN endpoint's IP addresses on the Amazon +// Web Services side and the tunnel options remain intact. Your Amazon Web Services // Site-to-Site VPN connection will be temporarily unavailable for a brief period // while we provision the new endpoints. +// +// [Update VPC route tables]: https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing func (c *Client) ModifyVpnConnection(ctx context.Context, params *ModifyVpnConnectionInput, optFns ...func(*Options)) (*ModifyVpnConnectionOutput, error) { if params == nil { params = &ModifyVpnConnectionInput{} diff --git a/service/ec2/api_op_ModifyVpnConnectionOptions.go b/service/ec2/api_op_ModifyVpnConnectionOptions.go index d9fe9445c54..e44706065f4 100644 --- a/service/ec2/api_op_ModifyVpnConnectionOptions.go +++ b/service/ec2/api_op_ModifyVpnConnectionOptions.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the connection options for your Site-to-Site VPN connection. When you -// modify the VPN connection options, the VPN endpoint IP addresses on the Amazon -// Web Services side do not change, and the tunnel options do not change. Your VPN -// connection will be temporarily unavailable for a brief period while the VPN -// connection is updated. +// Modifies the connection options for your Site-to-Site VPN connection. +// +// When you modify the VPN connection options, the VPN endpoint IP addresses on +// the Amazon Web Services side do not change, and the tunnel options do not +// change. Your VPN connection will be temporarily unavailable for a brief period +// while the VPN connection is updated. func (c *Client) ModifyVpnConnectionOptions(ctx context.Context, params *ModifyVpnConnectionOptionsInput, optFns ...func(*Options)) (*ModifyVpnConnectionOptionsOutput, error) { if params == nil { params = &ModifyVpnConnectionOptionsInput{} @@ -45,19 +46,23 @@ type ModifyVpnConnectionOptionsInput struct { DryRun *bool // The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. + // // Default: 0.0.0.0/0 LocalIpv4NetworkCidr *string // The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. + // // Default: ::/0 LocalIpv6NetworkCidr *string - // The IPv4 CIDR on the Amazon Web Services side of the VPN connection. Default: - // 0.0.0.0/0 + // The IPv4 CIDR on the Amazon Web Services side of the VPN connection. + // + // Default: 0.0.0.0/0 RemoteIpv4NetworkCidr *string - // The IPv6 CIDR on the Amazon Web Services side of the VPN connection. Default: - // ::/0 + // The IPv6 CIDR on the Amazon Web Services side of the VPN connection. + // + // Default: ::/0 RemoteIpv6NetworkCidr *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_ModifyVpnTunnelOptions.go b/service/ec2/api_op_ModifyVpnTunnelOptions.go index 16b65d3baf3..084b6e6ffa4 100644 --- a/service/ec2/api_op_ModifyVpnTunnelOptions.go +++ b/service/ec2/api_op_ModifyVpnTunnelOptions.go @@ -14,8 +14,9 @@ import ( // 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. +// [Site-to-Site VPN tunnel options for your Site-to-Site VPN connection]in the Amazon Web Services Site-to-Site VPN User Guide. +// +// [Site-to-Site VPN tunnel options for your Site-to-Site VPN connection]: https://docs.aws.amazon.com/vpn/latest/s2svpn/VPNTunnels.html func (c *Client) ModifyVpnTunnelOptions(ctx context.Context, params *ModifyVpnTunnelOptionsInput, optFns ...func(*Options)) (*ModifyVpnTunnelOptionsOutput, error) { if params == nil { params = &ModifyVpnTunnelOptionsInput{} @@ -55,8 +56,9 @@ type ModifyVpnTunnelOptionsInput struct { DryRun *bool // Choose whether or not to trigger immediate tunnel replacement. This is only - // applicable when turning on or off EnableTunnelLifecycleControl . Valid values: - // True | False + // applicable when turning on or off EnableTunnelLifecycleControl . + // + // Valid values: True | False SkipTunnelReplacement *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_MonitorInstances.go b/service/ec2/api_op_MonitorInstances.go index 3f439ca0716..71a8da5da08 100644 --- a/service/ec2/api_op_MonitorInstances.go +++ b/service/ec2/api_op_MonitorInstances.go @@ -12,10 +12,12 @@ 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]in the Amazon EC2 User Guide. +// +// To disable detailed monitoring, see [UnmonitorInstances]. +// +// [Monitor your instances using CloudWatch]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html +// [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{} diff --git a/service/ec2/api_op_MoveAddressToVpc.go b/service/ec2/api_op_MoveAddressToVpc.go index 5318547f171..c2b2a4260f0 100644 --- a/service/ec2/api_op_MoveAddressToVpc.go +++ b/service/ec2/api_op_MoveAddressToVpc.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. Moves an Elastic IP address from the EC2-Classic -// platform to the EC2-VPC platform. The Elastic IP address must be allocated to -// your account for more than 24 hours, and it must not be associated with an -// instance. After the Elastic IP address is moved, it is no longer available for -// use in the EC2-Classic platform, unless you move it back using the -// RestoreAddressToClassic request. You cannot move an Elastic IP address that was -// originally allocated for use in the EC2-VPC platform to the EC2-Classic -// platform. +// This action is deprecated. +// +// Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC +// platform. The Elastic IP address must be allocated to your account for more than +// 24 hours, and it must not be associated with an instance. After the Elastic IP +// address is moved, it is no longer available for use in the EC2-Classic platform, +// unless you move it back using the RestoreAddressToClassicrequest. You cannot move an Elastic IP +// address that was originally allocated for use in the EC2-VPC platform to the +// EC2-Classic platform. func (c *Client) MoveAddressToVpc(ctx context.Context, params *MoveAddressToVpcInput, optFns ...func(*Options)) (*MoveAddressToVpcOutput, error) { if params == nil { params = &MoveAddressToVpcInput{} diff --git a/service/ec2/api_op_MoveByoipCidrToIpam.go b/service/ec2/api_op_MoveByoipCidrToIpam.go index dd89eb6b726..baab5fce866 100644 --- a/service/ec2/api_op_MoveByoipCidrToIpam.go +++ b/service/ec2/api_op_MoveByoipCidrToIpam.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a -// 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) -// . +// Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. +// +// If you already have a 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]. +// +// [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{} diff --git a/service/ec2/api_op_ProvisionByoipCidr.go b/service/ec2/api_op_ProvisionByoipCidr.go index 4ece7c9b118..231844a415a 100644 --- a/service/ec2/api_op_ProvisionByoipCidr.go +++ b/service/ec2/api_op_ProvisionByoipCidr.go @@ -14,18 +14,22 @@ 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 -// 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 -// AllocateAddress with either the specific address from the address pool or the ID -// of the address pool. +// 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)]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. +// +// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html func (c *Client) ProvisionByoipCidr(ctx context.Context, params *ProvisionByoipCidrInput, optFns ...func(*Options)) (*ProvisionByoipCidrOutput, error) { if params == nil { params = &ProvisionByoipCidrInput{} @@ -68,24 +72,33 @@ type ProvisionByoipCidrInput struct { // Reserved. MultiRegion *bool - // If you have Local Zones (https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html) - // enabled, you can choose a network border group for Local Zones when you - // provision and advertise a BYOIPv4 CIDR. Choose the network border group + // If you have [Local Zones] enabled, you can choose a network border group for Local Zones + // when you provision and advertise a BYOIPv4 CIDR. Choose the network border group // carefully as the EIP and the Amazon Web Services resource it is associated with - // must reside in the same network border group. You can provision BYOIP address - // ranges to and advertise them in the following Local Zone network border groups: + // must reside in the same network border group. + // + // You can provision BYOIP address ranges to and advertise them in the following + // Local Zone network border groups: + // // - us-east-1-dfw-2 + // // - us-west-2-lax-1 + // // - us-west-2-phx-2 + // // You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this // time. + // + // [Local Zones]: https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html NetworkBorderGroup *string // The tags to apply to the address pool. PoolTagSpecifications []types.TagSpecification // (IPv6 only) Indicate whether the address range will be publicly advertised to - // the internet. Default: true + // the internet. + // + // Default: true PubliclyAdvertisable *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_ProvisionIpamByoasn.go b/service/ec2/api_op_ProvisionIpamByoasn.go index 5b8fab58976..1fb9d6f635c 100644 --- a/service/ec2/api_op_ProvisionIpamByoasn.go +++ b/service/ec2/api_op_ProvisionIpamByoasn.go @@ -13,9 +13,10 @@ import ( // Provisions your Autonomous System Number (ASN) for use in your Amazon Web // Services account. This action requires authorization context for Amazon to bring -// the ASN to an Amazon Web Services account. For more information, see Tutorial: -// Bring your ASN to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) -// in the Amazon VPC IPAM guide. +// the ASN to an Amazon Web Services account. For more information, see [Tutorial: Bring your ASN to IPAM]in the +// Amazon VPC IPAM guide. +// +// [Tutorial: Bring your ASN to IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html func (c *Client) ProvisionIpamByoasn(ctx context.Context, params *ProvisionIpamByoasnInput, optFns ...func(*Options)) (*ProvisionIpamByoasnOutput, error) { if params == nil { params = &ProvisionIpamByoasnInput{} diff --git a/service/ec2/api_op_ProvisionIpamPoolCidr.go b/service/ec2/api_op_ProvisionIpamPoolCidr.go index 6cf91959160..be03e7f824d 100644 --- a/service/ec2/api_op_ProvisionIpamPoolCidr.go +++ b/service/ec2/api_op_ProvisionIpamPoolCidr.go @@ -13,8 +13,11 @@ import ( // 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. +// within it. +// +// For more information, see [Provision CIDRs to pools] in the Amazon VPC IPAM User Guide. +// +// [Provision CIDRs to pools]: https://docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html func (c *Client) ProvisionIpamPoolCidr(ctx context.Context, params *ProvisionIpamPoolCidrInput, optFns ...func(*Options)) (*ProvisionIpamPoolCidrOutput, error) { if params == nil { params = &ProvisionIpamPoolCidrInput{} @@ -47,8 +50,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go b/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go index cff8c57fe65..b42016e8598 100644 --- a/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go +++ b/service/ec2/api_op_ProvisionPublicIpv4PoolCidr.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provision a CIDR to a public IPv4 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. +// Provision a CIDR to a public IPv4 pool. +// +// For more information about IPAM, see [What is IPAM?] in the Amazon VPC IPAM User Guide. +// +// [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html func (c *Client) ProvisionPublicIpv4PoolCidr(ctx context.Context, params *ProvisionPublicIpv4PoolCidrInput, optFns ...func(*Options)) (*ProvisionPublicIpv4PoolCidrOutput, error) { if params == nil { params = &ProvisionPublicIpv4PoolCidrInput{} diff --git a/service/ec2/api_op_PurchaseHostReservation.go b/service/ec2/api_op_PurchaseHostReservation.go index 16627a9c899..f10a9247d75 100644 --- a/service/ec2/api_op_PurchaseHostReservation.go +++ b/service/ec2/api_op_PurchaseHostReservation.go @@ -43,8 +43,9 @@ 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]. + // + // [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 @@ -68,8 +69,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_PurchaseReservedInstancesOffering.go b/service/ec2/api_op_PurchaseReservedInstancesOffering.go index c24f7a58a5e..a29a06c9124 100644 --- a/service/ec2/api_op_PurchaseReservedInstancesOffering.go +++ b/service/ec2/api_op_PurchaseReservedInstancesOffering.go @@ -14,14 +14,18 @@ import ( // Purchases a Reserved Instance for use with your account. With Reserved // Instances, you pay a lower hourly rate compared to On-Demand instance pricing. -// 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, -// 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. +// +// 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, specify a purchase time. If you +// do not specify a purchase time, the default is the current time. +// +// For more information, see [Reserved Instances] and [Reserved Instance Marketplace] in the Amazon EC2 User Guide. +// +// [Reserved Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html +// [Reserved Instance Marketplace]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html func (c *Client) PurchaseReservedInstancesOffering(ctx context.Context, params *PurchaseReservedInstancesOfferingInput, optFns ...func(*Options)) (*PurchaseReservedInstancesOfferingOutput, error) { if params == nil { params = &PurchaseReservedInstancesOfferingInput{} @@ -72,8 +76,9 @@ 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) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Crossing pricing tiers]in the Amazon Elastic Compute Cloud User Guide. + // + // [Crossing pricing tiers]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-reserved-instances-application.html#crossing-pricing-tiers ReservedInstancesId *string // Metadata pertaining to the operation's result. diff --git a/service/ec2/api_op_PurchaseScheduledInstances.go b/service/ec2/api_op_PurchaseScheduledInstances.go index b42388add6c..e3684525d2f 100644 --- a/service/ec2/api_op_PurchaseScheduledInstances.go +++ b/service/ec2/api_op_PurchaseScheduledInstances.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// You can no longer purchase Scheduled Instances. Purchases the Scheduled -// Instances with the specified schedule. Scheduled Instances enable you to -// purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you -// can purchase a Scheduled Instance, you must call -// DescribeScheduledInstanceAvailability to check for available schedules and -// obtain a purchase token. After you purchase a Scheduled Instance, you must call -// RunScheduledInstances during each scheduled time period. After you purchase a -// Scheduled Instance, you can't cancel, modify, or resell your purchase. +// You can no longer purchase Scheduled Instances. +// +// Purchases the Scheduled Instances with the specified schedule. +// +// Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the +// hour for a one-year term. Before you can purchase a Scheduled Instance, you must +// call DescribeScheduledInstanceAvailabilityto check for available schedules and obtain a purchase token. After you +// purchase a Scheduled Instance, you must call RunScheduledInstancesduring each scheduled time period. +// +// After you purchase a Scheduled Instance, you can't cancel, modify, or resell +// your purchase. func (c *Client) PurchaseScheduledInstances(ctx context.Context, params *PurchaseScheduledInstancesInput, optFns ...func(*Options)) (*PurchaseScheduledInstancesOutput, error) { if params == nil { params = &PurchaseScheduledInstancesInput{} @@ -43,8 +46,9 @@ 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]. + // + // [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 diff --git a/service/ec2/api_op_RebootInstances.go b/service/ec2/api_op_RebootInstances.go index 8adc5e6911e..77826c5c115 100644 --- a/service/ec2/api_op_RebootInstances.go +++ b/service/ec2/api_op_RebootInstances.go @@ -13,10 +13,14 @@ import ( // 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. +// 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] in the Amazon EC2 User Guide. +// +// [Troubleshoot an unreachable instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html func (c *Client) RebootInstances(ctx context.Context, params *RebootInstancesInput, optFns ...func(*Options)) (*RebootInstancesOutput, error) { if params == nil { params = &RebootInstancesInput{} diff --git a/service/ec2/api_op_RegisterImage.go b/service/ec2/api_op_RegisterImage.go index b4231b5b8b2..162d34dd7ff 100644 --- a/service/ec2/api_op_RegisterImage.go +++ b/service/ec2/api_op_RegisterImage.go @@ -13,42 +13,58 @@ import ( // Registers an AMI. When you're creating an instance-store backed AMI, // registering the AMI is the final step in the creation process. 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 -// 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 -// image, deregister the previous image and register the new image. Register a -// snapshot of a root device volume You can use RegisterImage to create an Amazon -// EBS-backed Linux AMI from a snapshot of a root device volume. You specify the -// snapshot using a block device mapping. You can't set the encryption state of the -// 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: +// information about creating AMIs, see [Create your own AMI]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 CreateImageunless 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 image, deregister the previous image and register the new +// image. +// +// # Register a snapshot of a root device volume +// +// You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a +// snapshot of a root device volume. You specify the snapshot using a block device +// mapping. You can't set the encryption state of the 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] and [Use encryption with Amazon EBS-backed AMIs] 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 . +// +// - 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. +// the platform details and billing information of an AMI, see [Understand AMI billing information]in the Amazon EC2 +// User Guide. +// +// [Understand AMI billing information]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html +// [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 +// [Use encryption with Amazon EBS-backed AMIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html +// [Create your own AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html func (c *Client) RegisterImage(ctx context.Context, params *RegisterImageInput, optFns ...func(*Options)) (*RegisterImageOutput, error) { if params == nil { params = &RegisterImageInput{} @@ -67,41 +83,56 @@ func (c *Client) RegisterImage(ctx context.Context, params *RegisterImageInput, // Contains the parameters for RegisterImage. type RegisterImageInput struct { - // A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses - // (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), - // single quotes ('), at-signs (@), or underscores(_) + // A name for your AMI. + // + // Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets + // ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), + // at-signs (@), or underscores(_) // // This member is required. Name *string - // The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386 . For - // instance store-backed AMIs, the architecture specified in the manifest file. + // 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 // The billing product codes. Your account must be authorized to specify billing - // product codes. If your account is not authorized to specify billing product - // 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. + // product codes. + // + // If your account is not authorized to specify billing product 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]and [AMI-based products] in the Amazon Web Services + // Marketplace Seller Guide. + // + // [Getting started as a seller]: https://docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html + // [AMI-based products]: https://docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html BillingProducts []string - // The block device mapping entries. If you specify an Amazon EBS volume using the - // ID of an Amazon EBS snapshot, you can't specify the encryption state of the - // 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/ebs/latest/userguide/snapshots-outposts.html#ami) - // in the Amazon EBS User Guide. + // The block device mapping entries. + // + // If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you + // can't specify the encryption state of the 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]in the Amazon EBS User Guide. + // + // [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami BlockDeviceMappings []types.BlockDeviceMapping // The boot mode of the AMI. A value of uefi-preferred indicates that the AMI - // supports both UEFI and Legacy BIOS. 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. + // supports both UEFI and Legacy BIOS. + // + // The operating system contained in the AMI must be configured to support the + // specified boot mode. + // + // For more information, see [Boot modes] in the Amazon EC2 User Guide. + // + // [Boot modes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html BootMode types.BootModeValues // A description for your AMI. @@ -114,24 +145,30 @@ type RegisterImageInput struct { 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. + // 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) - // in the Amazon S3 Service Developer Guide. + // can be accessed by Amazon EC2. For more information, see [Canned ACLs]in the Amazon S3 + // Service Developer Guide. + // + // [Canned ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl 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 - // AMI software can support IMDSv2. + // information, see [Configure the AMI]in the Amazon EC2 User Guide. + // + // If you set the value to v2.0 , make sure that your AMI software can support + // IMDSv2. + // + // [Configure the AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration ImdsSupport types.ImdsSupportValues // The ID of the kernel. @@ -145,31 +182,41 @@ type RegisterImageInput struct { // Set to simple to enable enhanced networking with the Intel 82599 Virtual // Function interface for the AMI and any instances that you launch from the AMI. - // There is no way to disable sriovNetSupport at this time. This option is - // supported only for HVM AMIs. Specifying this option with a PV AMI can make - // instances launched from the AMI unreachable. + // + // There is no way to disable sriovNetSupport at this time. + // + // This option is supported only for HVM AMIs. Specifying this option with a PV + // AMI can make instances launched from the AMI unreachable. SriovNetSupport *string - // The tags to apply to the AMI. To tag the AMI, the value for ResourceType must - // be image . If you specify another value for ResourceType , the request fails. To - // tag an AMI after it has been registered, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) - // . + // The tags to apply to the AMI. + // + // To tag the AMI, the value for ResourceType must be image . If you specify + // another value for ResourceType , the request fails. + // + // To tag an AMI after it has been registered, see [CreateTags]. + // + // [CreateTags]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html TagSpecifications []types.TagSpecification // 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]in the Amazon EC2 User Guide. + // + // [NitroTPM]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html 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) - // 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. + // UEFI data, use the [GetInstanceUefiData]command. You can inspect and modify the UEFI data by using + // the [python-uefivars tool]on GitHub. For more information, see [UEFI Secure Boot] in the Amazon EC2 User Guide. + // + // [UEFI Secure Boot]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html + // [GetInstanceUefiData]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData + // [python-uefivars tool]: https://github.com/awslabs/python-uefivars 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 0e81dfde103..4ab15871fce 100644 --- a/service/ec2/api_op_RegisterInstanceEventNotificationAttributes.go +++ b/service/ec2/api_op_RegisterInstanceEventNotificationAttributes.go @@ -12,9 +12,11 @@ import ( ) // 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) -// . +// your resources. +// +// To remove tags, use [DeregisterInstanceEventNotificationAttributes]. +// +// [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{} diff --git a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go index d3ecf84ef8e..f06b417ab8d 100644 --- a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go +++ b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupMembers.go @@ -13,11 +13,14 @@ import ( // 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) -// to verify that the members were added to the transit gateway multicast group. +// that receives multicast traffic. For information about supported instances, see [Multicast Consideration] +// in Amazon VPC Transit Gateways. +// +// After you add the members, use [SearchTransitGatewayMulticastGroups] to verify that the members were added to the +// transit gateway multicast group. +// +// [SearchTransitGatewayMulticastGroups]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html +// [Multicast Consideration]: https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits func (c *Client) RegisterTransitGatewayMulticastGroupMembers(ctx context.Context, params *RegisterTransitGatewayMulticastGroupMembersInput, optFns ...func(*Options)) (*RegisterTransitGatewayMulticastGroupMembersOutput, error) { if params == nil { params = &RegisterTransitGatewayMulticastGroupMembersInput{} diff --git a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go index 6c50fedd624..7de34bae3c3 100644 --- a/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go +++ b/service/ec2/api_op_RegisterTransitGatewayMulticastGroupSources.go @@ -12,12 +12,17 @@ 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) -// in Amazon VPC Transit Gateways. After you add the source, use -// SearchTransitGatewayMulticastGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) -// to verify that the source was added to the multicast group. +// 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]in +// Amazon VPC Transit Gateways. +// +// After you add the source, use [SearchTransitGatewayMulticastGroups] to verify that the source was added to the +// multicast group. +// +// [SearchTransitGatewayMulticastGroups]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html +// [Multicast Considerations]: https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-limits.html#multicast-limits func (c *Client) RegisterTransitGatewayMulticastGroupSources(ctx context.Context, params *RegisterTransitGatewayMulticastGroupSourcesInput, optFns ...func(*Options)) (*RegisterTransitGatewayMulticastGroupSourcesOutput, error) { if params == nil { params = &RegisterTransitGatewayMulticastGroupSourcesInput{} diff --git a/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go b/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go index 27ef2117b2c..aef003a2ba2 100644 --- a/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go +++ b/service/ec2/api_op_RejectTransitGatewayVpcAttachment.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Rejects a request to attach a VPC to a transit gateway. The VPC attachment must -// be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to -// view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment -// to accept a VPC attachment request. +// Rejects a request to attach a VPC to a transit gateway. +// +// The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your +// pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachmentto accept a VPC attachment request. func (c *Client) RejectTransitGatewayVpcAttachment(ctx context.Context, params *RejectTransitGatewayVpcAttachmentInput, optFns ...func(*Options)) (*RejectTransitGatewayVpcAttachmentOutput, error) { if params == nil { params = &RejectTransitGatewayVpcAttachmentInput{} diff --git a/service/ec2/api_op_RejectVpcPeeringConnection.go b/service/ec2/api_op_RejectVpcPeeringConnection.go index 719561af742..06108fa0878 100644 --- a/service/ec2/api_op_RejectVpcPeeringConnection.go +++ b/service/ec2/api_op_RejectVpcPeeringConnection.go @@ -11,10 +11,9 @@ import ( ) // Rejects a VPC peering connection request. The VPC peering connection must be in -// 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 . +// 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. func (c *Client) RejectVpcPeeringConnection(ctx context.Context, params *RejectVpcPeeringConnectionInput, optFns ...func(*Options)) (*RejectVpcPeeringConnectionOutput, error) { if params == nil { params = &RejectVpcPeeringConnectionInput{} diff --git a/service/ec2/api_op_ReleaseAddress.go b/service/ec2/api_op_ReleaseAddress.go index 9e488dd1211..8c77cf3b817 100644 --- a/service/ec2/api_op_ReleaseAddress.go +++ b/service/ec2/api_op_ReleaseAddress.go @@ -10,18 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Releases the specified Elastic IP address. [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 . [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 ). 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. After you release an Elastic IP address, you might be able to -// recover it. For more information, see AllocateAddress . +// Releases the specified Elastic IP address. +// +// [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. +// +// [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 ). +// +// 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. +// +// After you release an Elastic IP address, you might be able to recover it. For +// more information, see AllocateAddress. func (c *Client) ReleaseAddress(ctx context.Context, params *ReleaseAddressInput, optFns ...func(*Options)) (*ReleaseAddressOutput, error) { if params == nil { params = &ReleaseAddressInput{} @@ -49,8 +55,10 @@ type ReleaseAddressInput struct { DryRun *bool // The set of Availability Zones, Local Zones, or Wavelength Zones from which - // Amazon Web Services advertises IP addresses. If you provide an incorrect network - // border group, you receive an InvalidAddress.NotFound error. + // Amazon Web Services advertises IP addresses. + // + // If you provide an incorrect network border group, you receive an + // InvalidAddress.NotFound error. NetworkBorderGroup *string // Deprecated. diff --git a/service/ec2/api_op_ReleaseHosts.go b/service/ec2/api_op_ReleaseHosts.go index c819af5a24e..26a36f02492 100644 --- a/service/ec2/api_op_ReleaseHosts.go +++ b/service/ec2/api_op_ReleaseHosts.go @@ -15,11 +15,13 @@ import ( // On-Demand billing is stopped and the host goes into released state. The host ID // of Dedicated Hosts that have been released can no longer be specified in another // request, for example, to modify the host. You must stop or terminate all -// instances on a host before it can be released. When Dedicated Hosts are -// released, it may take some time for them to stop counting toward your limit and -// you may receive capacity errors when trying to allocate new Dedicated Hosts. -// Wait a few minutes and then try again. Released hosts still appear in a -// DescribeHosts response. +// instances on a host before it can be released. +// +// When Dedicated Hosts are released, it may take some time for them to stop +// counting toward your limit and you may receive capacity errors when trying to +// allocate new Dedicated Hosts. Wait a few minutes and then try again. +// +// Released hosts still appear in a DescribeHosts response. func (c *Client) ReleaseHosts(ctx context.Context, params *ReleaseHostsInput, optFns ...func(*Options)) (*ReleaseHostsOutput, error) { if params == nil { params = &ReleaseHostsInput{} diff --git a/service/ec2/api_op_ReleaseIpamPoolAllocation.go b/service/ec2/api_op_ReleaseIpamPoolAllocation.go index 640960a4152..9f21609c309 100644 --- a/service/ec2/api_op_ReleaseIpamPoolAllocation.go +++ b/service/ec2/api_op_ReleaseIpamPoolAllocation.go @@ -14,11 +14,14 @@ import ( // IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM // pool is available for allocations. 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-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. +// resource, set its monitored state to false using [ModifyIpamResourceCidr]. For more information, see [Release an allocation] +// in the Amazon VPC IPAM User Guide. +// +// All EC2 API actions follow an [eventual consistency] model. +// +// [Release an allocation]: https://docs.aws.amazon.com/vpc/latest/ipam/release-alloc-ipam.html +// [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 func (c *Client) ReleaseIpamPoolAllocation(ctx context.Context, params *ReleaseIpamPoolAllocationInput, optFns ...func(*Options)) (*ReleaseIpamPoolAllocationOutput, error) { if params == nil { params = &ReleaseIpamPoolAllocationInput{} diff --git a/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go b/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go index 4e1427079d1..fff1a223944 100644 --- a/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go +++ b/service/ec2/api_op_ReplaceIamInstanceProfileAssociation.go @@ -14,6 +14,7 @@ import ( // 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) { if params == nil { diff --git a/service/ec2/api_op_ReplaceNetworkAclAssociation.go b/service/ec2/api_op_ReplaceNetworkAclAssociation.go index 600051fccda..0b2016a9658 100644 --- a/service/ec2/api_op_ReplaceNetworkAclAssociation.go +++ b/service/ec2/api_op_ReplaceNetworkAclAssociation.go @@ -12,8 +12,11 @@ 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-network-acls.html) -// in the Amazon VPC User Guide. This is an idempotent operation. +// more information, see [Network ACLs]in the Amazon VPC User Guide. +// +// This is an idempotent operation. +// +// [Network ACLs]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html func (c *Client) ReplaceNetworkAclAssociation(ctx context.Context, params *ReplaceNetworkAclAssociationInput, optFns ...func(*Options)) (*ReplaceNetworkAclAssociationOutput, error) { if params == nil { params = &ReplaceNetworkAclAssociationInput{} diff --git a/service/ec2/api_op_ReplaceNetworkAclEntry.go b/service/ec2/api_op_ReplaceNetworkAclEntry.go index 08b25ee85af..627d6e89d41 100644 --- a/service/ec2/api_op_ReplaceNetworkAclEntry.go +++ b/service/ec2/api_op_ReplaceNetworkAclEntry.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Replaces an entry (rule) in a network ACL. For more information, see Network -// ACLs (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in -// the Amazon VPC User Guide. +// Replaces an entry (rule) in a network ACL. For more information, see [Network ACLs] in the +// Amazon VPC User Guide. +// +// [Network ACLs]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html func (c *Client) ReplaceNetworkAclEntry(ctx context.Context, params *ReplaceNetworkAclEntryInput, optFns ...func(*Options)) (*ReplaceNetworkAclEntryOutput, error) { if params == nil { params = &ReplaceNetworkAclEntryInput{} @@ -31,8 +32,9 @@ 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 diff --git a/service/ec2/api_op_ReplaceRoute.go b/service/ec2/api_op_ReplaceRoute.go index ba8e2294fae..4243add2233 100644 --- a/service/ec2/api_op_ReplaceRoute.go +++ b/service/ec2/api_op_ReplaceRoute.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 VPC User Guide. +// 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] in the Amazon VPC User Guide. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) ReplaceRoute(ctx context.Context, params *ReplaceRouteInput, optFns ...func(*Options)) (*ReplaceRouteOutput, error) { if params == nil { params = &ReplaceRouteInput{} diff --git a/service/ec2/api_op_ReplaceRouteTableAssociation.go b/service/ec2/api_op_ReplaceRouteTableAssociation.go index 6f3b406a829..7a0f29caf41 100644 --- a/service/ec2/api_op_ReplaceRouteTableAssociation.go +++ b/service/ec2/api_op_ReplaceRouteTableAssociation.go @@ -14,10 +14,13 @@ 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 VPC 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. +// tables, see [Route tables]in the Amazon VPC 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. +// +// [Route tables]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html func (c *Client) ReplaceRouteTableAssociation(ctx context.Context, params *ReplaceRouteTableAssociationInput, optFns ...func(*Options)) (*ReplaceRouteTableAssociationOutput, error) { if params == nil { params = &ReplaceRouteTableAssociationInput{} diff --git a/service/ec2/api_op_ReportInstanceStatus.go b/service/ec2/api_op_ReportInstanceStatus.go index eae11642ce2..4427470edd3 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 -// 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 . +// 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. func (c *Client) ReportInstanceStatus(ctx context.Context, params *ReportInstanceStatusInput, optFns ...func(*Options)) (*ReportInstanceStatusOutput, error) { if params == nil { params = &ReportInstanceStatusInput{} @@ -41,17 +41,26 @@ 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] // // This member is required. diff --git a/service/ec2/api_op_RequestSpotFleet.go b/service/ec2/api_op_RequestSpotFleet.go index c73617e1bb2..65c06a7fabd 100644 --- a/service/ec2/api_op_RequestSpotFleet.go +++ b/service/ec2/api_op_RequestSpotFleet.go @@ -11,26 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Spot Fleet request. The Spot Fleet request specifies the total target -// capacity and the On-Demand target capacity. Amazon EC2 calculates the difference -// between the total capacity and On-Demand capacity, and launches the difference -// as Spot capacity. You can submit a single request that includes multiple launch -// specifications that vary by instance type, AMI, Availability Zone, or subnet. By -// default, the Spot Fleet requests Spot Instances in the Spot Instance pool where -// the price per unit is the lowest. Each launch specification can include its own -// instance weighting that reflects the value of the instance type to your -// application workload. Alternatively, you can specify that the Spot Fleet -// distribute the target capacity across the Spot pools included in its launch -// specifications. By ensuring that the Spot Instances in your Spot Fleet are in -// different Spot pools, you can improve the availability of your fleet. You can -// 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) -// 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) +// Creates a Spot Fleet request. +// +// The Spot Fleet request specifies the total target capacity and the On-Demand +// target capacity. Amazon EC2 calculates the difference between the total capacity +// and On-Demand capacity, and launches the difference as Spot capacity. +// +// You can submit a single request that includes multiple launch specifications +// that vary by instance type, AMI, Availability Zone, or subnet. +// +// By default, the Spot Fleet requests Spot Instances in the Spot Instance pool +// where the price per unit is the lowest. Each launch specification can include +// its own instance weighting that reflects the value of the instance type to your +// application workload. +// +// Alternatively, you can specify that the Spot Fleet distribute the target +// capacity across the Spot pools included in its launch specifications. By +// ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, +// you can improve the availability of your fleet. +// +// You can 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] 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?] // in the Amazon EC2 User Guide. +// +// [Spot Fleet requests]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html +// [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 func (c *Client) RequestSpotFleet(ctx context.Context, params *RequestSpotFleetInput, optFns ...func(*Options)) (*RequestSpotFleetOutput, error) { if params == nil { params = &RequestSpotFleetInput{} diff --git a/service/ec2/api_op_RequestSpotInstances.go b/service/ec2/api_op_RequestSpotInstances.go index 12eddc42bf1..3b4e1606c32 100644 --- a/service/ec2/api_op_RequestSpotInstances.go +++ b/service/ec2/api_op_RequestSpotInstances.go @@ -12,13 +12,16 @@ import ( "time" ) -// 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) -// in the Amazon EC2 User Guide for Linux Instances. +// Creates a Spot Instance request. +// +// For more information, see [Spot Instance requests] 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?]in the Amazon EC2 User Guide for Linux Instances. +// +// [Spot Instance requests]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html +// [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 func (c *Client) RequestSpotInstances(ctx context.Context, params *RequestSpotInstancesInput, optFns ...func(*Options)) (*RequestSpotInstancesOutput, error) { if params == nil { params = &RequestSpotInstancesInput{} @@ -37,30 +40,36 @@ func (c *Client) RequestSpotInstances(ctx context.Context, params *RequestSpotIn // Contains the parameters for RequestSpotInstances. type RequestSpotInstancesInput struct { - // The user-specified name for a logical grouping of requests. When you specify an - // Availability Zone group in a Spot Instance request, all Spot Instances in the - // request are launched in the same Availability Zone. Instance proximity is - // maintained with this parameter, but the choice of Availability Zone is not. The - // group applies only to requests for Spot Instances of the same instance type. Any - // additional Spot Instance requests that are specified with the same Availability - // Zone group name are launched in that same Availability Zone, as long as at least - // one instance from the group is still active. If there is no active instance - // running in the Availability Zone group that you specify for a new Spot Instance - // request (all instances are terminated, the request is expired, or the maximum - // price you specified falls below current Spot price), then Amazon EC2 launches - // the instance in any Availability Zone where the constraint can be met. - // Consequently, the subsequent set of Spot Instances could be placed in a - // different zone from the original request, even if you specified the same - // Availability Zone group. Default: Instances are launched in any available - // Availability Zone. + // The user-specified name for a logical grouping of requests. + // + // When you specify an Availability Zone group in a Spot Instance request, all + // Spot Instances in the request are launched in the same Availability Zone. + // Instance proximity is maintained with this parameter, but the choice of + // Availability Zone is not. The group applies only to requests for Spot Instances + // of the same instance type. Any additional Spot Instance requests that are + // specified with the same Availability Zone group name are launched in that same + // Availability Zone, as long as at least one instance from the group is still + // active. + // + // If there is no active instance running in the Availability Zone group that you + // specify for a new Spot Instance request (all instances are terminated, the + // request is expired, or the maximum price you specified falls below current Spot + // price), then Amazon EC2 launches the instance in any Availability Zone where the + // constraint can be met. Consequently, the subsequent set of Spot Instances could + // be placed in a different zone from the original request, even if you specified + // the same Availability Zone group. + // + // Default: Instances are launched in any available Availability Zone. AvailabilityZoneGroup *string // Deprecated. 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) - // in the Amazon EC2 User Guide for Linux Instances. + // the request. For more information, see [How to Ensure Idempotency]in the Amazon EC2 User Guide for Linux + // Instances. + // + // [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 @@ -69,15 +78,18 @@ type RequestSpotInstancesInput struct { // UnauthorizedOperation . DryRun *bool - // The maximum number of Spot Instances to launch. Default: 1 + // The maximum number of Spot Instances to launch. + // + // Default: 1 InstanceCount *int32 // 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 - // individually + // together and terminate together. + // + // Default: Instances are launched and terminated individually LaunchGroup *string // The launch specification. @@ -86,33 +98,42 @@ type RequestSpotInstancesInput struct { // 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. + // 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 - // 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) + // request fails. To tag the Spot Instance request after it has been created, see [CreateTags] // . + // + // [CreateTags]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html TagSpecifications []types.TagSpecification - // The Spot Instance request type. Default: one-time + // The Spot Instance request type. + // + // Default: one-time Type types.SpotInstanceType // The start date of the request. If this is a one-time request, the request // becomes active at this date and time and remains active until all instances // launch, the request expires, or the request is canceled. If the request is // persistent, the request becomes active at this date and time and remains active - // until it expires or is canceled. The specified start date and time cannot be - // equal to the current date and time. You must specify a start date and time that - // occurs after the current date and time. + // until it expires or is canceled. + // + // The specified start date and time cannot be equal to the current date and time. + // You must specify a start date and time that occurs after the current date and + // time. 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 diff --git a/service/ec2/api_op_ResetAddressAttribute.go b/service/ec2/api_op_ResetAddressAttribute.go index 76bca3df56b..34ff0f5e035 100644 --- a/service/ec2/api_op_ResetAddressAttribute.go +++ b/service/ec2/api_op_ResetAddressAttribute.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Resets the attribute of the specified IP address. For requirements, see [Using reverse DNS for email applications]. +// +// [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) ResetAddressAttribute(ctx context.Context, params *ResetAddressAttributeInput, optFns ...func(*Options)) (*ResetAddressAttributeOutput, error) { if params == nil { params = &ResetAddressAttributeInput{} diff --git a/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go b/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go index 536a499f3e4..9aba967230b 100644 --- a/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go +++ b/service/ec2/api_op_ResetEbsDefaultKmsKeyId.go @@ -11,11 +11,13 @@ import ( ) // 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/ebs/latest/userguide/ebs-encryption.html) -// in the Amazon EBS User Guide. +// 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]in the Amazon EBS User Guide. +// +// [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html func (c *Client) ResetEbsDefaultKmsKeyId(ctx context.Context, params *ResetEbsDefaultKmsKeyIdInput, optFns ...func(*Options)) (*ResetEbsDefaultKmsKeyIdOutput, error) { if params == nil { params = &ResetEbsDefaultKmsKeyIdInput{} diff --git a/service/ec2/api_op_ResetInstanceAttribute.go b/service/ec2/api_op_ResetInstanceAttribute.go index 6447cd3ae98..dda3e2c4dcb 100644 --- a/service/ec2/api_op_ResetInstanceAttribute.go +++ b/service/ec2/api_op_ResetInstanceAttribute.go @@ -13,11 +13,14 @@ 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 -// 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) -// in the Amazon VPC User Guide. +// , 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] in +// the Amazon VPC User Guide. +// +// [NAT Instances]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html func (c *Client) ResetInstanceAttribute(ctx context.Context, params *ResetInstanceAttributeInput, optFns ...func(*Options)) (*ResetInstanceAttributeOutput, error) { if params == nil { params = &ResetInstanceAttributeInput{} @@ -35,8 +38,9 @@ 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 . + // The attribute to reset. + // + // You can only reset the following attributes: kernel | ramdisk | sourceDestCheck . // // This member is required. Attribute types.InstanceAttributeName diff --git a/service/ec2/api_op_ResetSnapshotAttribute.go b/service/ec2/api_op_ResetSnapshotAttribute.go index b7db200ece4..e61dcd0b01d 100644 --- a/service/ec2/api_op_ResetSnapshotAttribute.go +++ b/service/ec2/api_op_ResetSnapshotAttribute.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Resets permission settings for the specified snapshot. For more information -// about modifying snapshot permissions, see Share a snapshot (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html) -// in the Amazon EBS User Guide. +// Resets permission settings for the specified snapshot. +// +// For more information about modifying snapshot permissions, see [Share a snapshot] in the Amazon +// EBS User Guide. +// +// [Share a snapshot]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html func (c *Client) ResetSnapshotAttribute(ctx context.Context, params *ResetSnapshotAttributeInput, optFns ...func(*Options)) (*ResetSnapshotAttributeOutput, error) { if params == nil { params = &ResetSnapshotAttributeInput{} diff --git a/service/ec2/api_op_RestoreAddressToClassic.go b/service/ec2/api_op_RestoreAddressToClassic.go index e3b249fb965..ca7d1133e05 100644 --- a/service/ec2/api_op_RestoreAddressToClassic.go +++ b/service/ec2/api_op_RestoreAddressToClassic.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This action is deprecated. 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. +// This action is deprecated. +// +// 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. func (c *Client) RestoreAddressToClassic(ctx context.Context, params *RestoreAddressToClassicInput, optFns ...func(*Options)) (*RestoreAddressToClassicOutput, error) { if params == nil { params = &RestoreAddressToClassicInput{} diff --git a/service/ec2/api_op_RestoreImageFromRecycleBin.go b/service/ec2/api_op_RestoreImageFromRecycleBin.go index 1599feb8839..2c4444b15d5 100644 --- a/service/ec2/api_op_RestoreImageFromRecycleBin.go +++ b/service/ec2/api_op_RestoreImageFromRecycleBin.go @@ -10,8 +10,10 @@ 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] in the Amazon +// EC2 User Guide. +// +// [Recycle Bin]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html func (c *Client) RestoreImageFromRecycleBin(ctx context.Context, params *RestoreImageFromRecycleBinInput, optFns ...func(*Options)) (*RestoreImageFromRecycleBinOutput, error) { if params == nil { params = &RestoreImageFromRecycleBinInput{} diff --git a/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go b/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go index 48fb337dbdd..d2ccc53a3b4 100644 --- a/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go +++ b/service/ec2/api_op_RestoreSnapshotFromRecycleBin.go @@ -12,9 +12,10 @@ import ( "time" ) -// Restores a snapshot from the Recycle Bin. For more information, see Restore -// snapshots from the Recycle Bin (https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps) -// in the Amazon EBS User Guide. +// Restores a snapshot from the Recycle Bin. For more information, see [Restore snapshots from the Recycle Bin] in the +// Amazon EBS User Guide. +// +// [Restore snapshots from the Recycle Bin]: https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps func (c *Client) RestoreSnapshotFromRecycleBin(ctx context.Context, params *RestoreSnapshotFromRecycleBinInput, optFns ...func(*Options)) (*RestoreSnapshotFromRecycleBinOutput, error) { if params == nil { params = &RestoreSnapshotFromRecycleBinInput{} @@ -55,8 +56,9 @@ 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/ebs/latest/userguide/snapshots-outposts.html) - // in the Amazon EBS User Guide. + // see [Amazon EBS local snapshots on Outposts]in the Amazon EBS User Guide. + // + // [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html 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 4a0f7830ac4..51574baab86 100644 --- a/service/ec2/api_op_RestoreSnapshotTier.go +++ b/service/ec2/api_op_RestoreSnapshotTier.go @@ -13,10 +13,12 @@ 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/ebs/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/ebs/latest/userguide/working-with-snapshot-archiving.html#modify-temp-restore-period) -// in the Amazon EBS User Guide. +// temporarily restored. +// +// For more information see [Restore an archived snapshot] and [modify the restore period or restore type for a temporarily restored snapshot] in the Amazon EBS User Guide. +// +// [Restore an archived snapshot]: https://docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#restore-archived-snapshot +// [modify the restore period or restore type for a temporarily restored snapshot]: https://docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#modify-temp-restore-period func (c *Client) RestoreSnapshotTier(ctx context.Context, params *RestoreSnapshotTierInput, optFns ...func(*Options)) (*RestoreSnapshotTierOutput, error) { if params == nil { params = &RestoreSnapshotTierInput{} @@ -52,9 +54,10 @@ type RestoreSnapshotTierInput struct { // Specifies the number of days for which to temporarily restore an archived // 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 . + // 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 . TemporaryRestoreDays *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_RevokeSecurityGroupEgress.go b/service/ec2/api_op_RevokeSecurityGroupEgress.go index 90ef8696adf..cdc3d1e90b0 100644 --- a/service/ec2/api_op_RevokeSecurityGroupEgress.go +++ b/service/ec2/api_op_RevokeSecurityGroupEgress.go @@ -11,21 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified outbound (egress) rules from the specified security -// group. You can specify rules using either rule IDs or security group rule -// properties. If you use rule properties, the values that you specify (for -// example, ports) must match the existing rule's values exactly. Each rule has a -// protocol, from and to ports, and destination (CIDR range, security group, or -// prefix list). For the TCP and UDP protocols, you must also specify the -// destination port or range of ports. For the ICMP protocol, you must also specify -// the ICMP type and code. If the security group rule has a description, you do not -// need to specify the description to revoke the rule. For a default VPC, if the -// values you specify do not match the existing rule's values, no error is -// returned, and the output describes the security group rules that were not -// revoked. Amazon Web Services recommends that you describe the security group to -// verify that the rules were removed. Rule changes are propagated to instances -// within the security group as quickly as possible. However, a small delay might -// occur. +// Removes the specified outbound (egress) rules from the specified security group. +// +// You can specify rules using either rule IDs or security group rule properties. +// If you use rule properties, the values that you specify (for example, ports) +// must match the existing rule's values exactly. Each rule has a protocol, from +// and to ports, and destination (CIDR range, security group, or prefix list). For +// the TCP and UDP protocols, you must also specify the destination port or range +// of ports. For the ICMP protocol, you must also specify the ICMP type and code. +// If the security group rule has a description, you do not need to specify the +// description to revoke the rule. +// +// For a default VPC, if the values you specify do not match the existing rule's +// values, no error is returned, and the output describes the security group rules +// that were not revoked. +// +// Amazon Web Services recommends that you describe the security group to verify +// that the rules were removed. +// +// Rule changes are propagated to instances within the security group as quickly +// as possible. However, a small delay might occur. func (c *Client) RevokeSecurityGroupEgress(ctx context.Context, params *RevokeSecurityGroupEgressInput, optFns ...func(*Options)) (*RevokeSecurityGroupEgressOutput, error) { if params == nil { params = &RevokeSecurityGroupEgressInput{} @@ -91,7 +96,8 @@ 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 e4df441d1d2..a32339dcf0a 100644 --- a/service/ec2/api_op_RevokeSecurityGroupIngress.go +++ b/service/ec2/api_op_RevokeSecurityGroupIngress.go @@ -11,22 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified inbound (ingress) rules from a security group. You can -// specify rules using either rule IDs or security group rule properties. If you -// use rule properties, the values that you specify (for example, ports) must match -// the existing rule's values exactly. Each rule has a protocol, from and to ports, -// and source (CIDR range, security group, or prefix list). For the TCP and UDP -// protocols, you must also specify the destination port or range of ports. For the -// ICMP protocol, you must also specify the ICMP type and code. If the security -// group rule has a description, you do not need to specify the description to -// revoke the rule. For a default VPC, if the values you specify do not match the -// existing rule's values, no error is returned, and the output describes the -// security group rules that were not revoked. For a non-default VPC, if the values -// you specify do not match the existing rule's values, an -// InvalidPermission.NotFound client error is returned, and no rules are revoked. +// Removes the specified inbound (ingress) rules from a security group. +// +// You can specify rules using either rule IDs or security group rule properties. +// If you use rule properties, the values that you specify (for example, ports) +// must match the existing rule's values exactly. Each rule has a protocol, from +// and to ports, and source (CIDR range, security group, or prefix list). For the +// TCP and UDP protocols, you must also specify the destination port or range of +// ports. For the ICMP protocol, you must also specify the ICMP type and code. If +// the security group rule has a description, you do not need to specify the +// description to revoke the rule. +// +// For a default VPC, if the values you specify do not match the existing rule's +// values, no error is returned, and the output describes the security group rules +// that were not revoked. +// +// For a non-default VPC, if the values you specify do not match the existing +// rule's values, an InvalidPermission.NotFound client error is returned, and no +// rules are revoked. +// // Amazon Web Services recommends that you describe the security group to verify -// that the rules were removed. Rule changes are propagated to instances within the -// security group as quickly as possible. However, a small delay might occur. +// that the rules were removed. +// +// Rule changes are propagated to instances within the security group as quickly +// as possible. However, a small delay might occur. func (c *Client) RevokeSecurityGroupIngress(ctx context.Context, params *RevokeSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeSecurityGroupIngressOutput, error) { if params == nil { params = &RevokeSecurityGroupIngressInput{} @@ -70,8 +78,10 @@ type RevokeSecurityGroupIngressInput struct { // 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]). Use -1 to specify + // all. + // + // [Protocol Numbers]: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IpProtocol *string // The IDs of the security group rules. @@ -100,7 +110,8 @@ 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 626891ef976..b8c38c3793b 100644 --- a/service/ec2/api_op_RunInstances.go +++ b/service/ec2/api_op_RunInstances.go @@ -12,40 +12,53 @@ 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: +// permissions. +// +// You can specify a number of options, or leave the default options. The +// following rules apply: +// // - 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. +// // - 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) -// . +// +// - Not all instance types support IPv6 addresses. For more information, see [Instance types]. +// // - 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) -// . +// group. For more information, see [Security groups]. +// // - 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 -// 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 -// 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 +// You can create a [launch template], 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 instances and EBS volumes +// during launch, after launch, or both. For more information, see CreateTagsand [Tagging your Amazon EC2 resources]. +// +// 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) -// . +// information, see [Key pairs]. +// +// For troubleshooting, see [What to do if an instance immediately terminates], and [Troubleshooting connecting to your instance]. +// +// [Key pairs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html +// [What to do if an instance immediately terminates]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html +// [Tagging your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html +// [launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html +// [Security groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html +// [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html +// [Troubleshooting connecting to your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html func (c *Client) RunInstances(ctx context.Context, params *RunInstancesInput, optFns ...func(*Options)) (*RunInstancesOutput, error) { if params == nil { params = &RunInstancesInput{} @@ -65,22 +78,26 @@ 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 - // 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. + // 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]in the Amazon EC2 FAQ. + // + // [How many instances can I run in Amazon EC2]: http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2 // // 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. + // 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]in the Amazon EC2 General FAQ. + // + // [How many instances can I run in Amazon EC2]: http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2 // // This member is required. MinCount *int32 @@ -89,9 +106,10 @@ type RunInstancesInput struct { AdditionalInfo *string // 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) - // in the Amazon EC2 User Guide. + // volumes to attach to the instance at launch. For more information, see [Block device mappings]in the + // Amazon EC2 User Guide. + // + // [Block device mappings]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html BlockDeviceMappings []types.BlockDeviceMapping // Information about the Capacity Reservation targeting option. If you do not @@ -102,35 +120,48 @@ type RunInstancesInput 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) - // . Constraints: Maximum 64 ASCII characters + // used for the request to ensure idempotency. + // + // For more information, see [Ensuring Idempotency]. + // + // Constraints: Maximum 64 ASCII characters + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html 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) - // in the Amazon EC2 User Guide. + // The CPU options for the instance. For more information, see [Optimize CPU options] in the Amazon EC2 + // User Guide. + // + // [Optimize CPU options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html 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) - // 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. + // values are standard and unlimited . To change this attribute after launch, use [ModifyInstanceCreditSpecification] + // . For more information, see [Burstable performance instances]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. + // + // [ModifyInstanceCreditSpecification]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html + // [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html 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]. + // + // [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 // 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 - // can terminate the instance by running the shutdown command from the instance. + // after launch, use [ModifyInstanceAttribute]. Alternatively, if you set InstanceInitiatedShutdownBehavior + // to terminate , you can terminate the instance by running the shutdown command + // from the instance. + // // Default: false + // + // [ModifyInstanceAttribute]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html DisableApiTermination *bool // Checks whether you have the required permissions for the action, without @@ -143,17 +174,22 @@ type RunInstancesInput struct { // optimization provides dedicated throughput to Amazon EBS and an optimized // configuration stack to provide optimal Amazon EBS I/O performance. This // optimization isn't available with all instance types. Additional usage charges - // apply when using an EBS-optimized instance. Default: false + // apply when using an EBS-optimized instance. + // + // Default: false EbsOptimized *bool - // An elastic GPU to associate with the instance. Amazon Elastic Graphics reached - // end of life on January 8, 2024. + // An elastic GPU to associate with the instance. + // + // Amazon Elastic Graphics reached end of life on January 8, 2024. ElasticGpuSpecification []types.ElasticGpuSpecification - // An elastic inference accelerator to associate with the instance. Amazon Elastic - // Inference (EI) is no longer available to new customers. For more information, - // see Amazon Elastic Inference FAQs (http://aws.amazon.com/machine-learning/elastic-inference/faqs/) - // . + // An elastic inference accelerator to associate with the instance. + // + // Amazon Elastic Inference (EI) is no longer available to new customers. For more + // information, see [Amazon Elastic Inference FAQs]. + // + // [Amazon Elastic Inference FAQs]: http://aws.amazon.com/machine-learning/elastic-inference/faqs/ ElasticInferenceAccelerators []types.ElasticInferenceAccelerator // If you’re launching an instance into a dual-stack or IPv6-only subnet, you can @@ -172,16 +208,24 @@ type RunInstancesInput struct { EnablePrimaryIpv6 *bool // 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?]in the Amazon Web Services Nitro Enclaves + // User Guide. + // + // You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same + // instance. + // + // [What is Amazon Web Services Nitro Enclaves?]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html EnclaveOptions *types.EnclaveOptionsRequest // 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 EC2 User Guide. You can't enable hibernation and Amazon Web - // Services Nitro Enclaves on the same instance. + // valid only if the instance meets the [hibernation prerequisites]. For more information, see [Hibernate your instance] in the Amazon + // EC2 User Guide. + // + // You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same + // instance. + // + // [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html + // [hibernation prerequisites]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html HibernationOptions *types.HibernationOptionsRequest // The name or Amazon Resource Name (ARN) of an IAM instance profile. @@ -193,42 +237,55 @@ type RunInstancesInput struct { // Indicates whether an instance stops or terminates when you initiate shutdown // from the instance (using the operating system command for system shutdown). + // // Default: stop InstanceInitiatedShutdownBehavior types.ShutdownBehavior - // 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 . + // 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 . 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. + // The instance type. For more information, see [Instance types] in the Amazon EC2 User Guide. + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html InstanceType types.InstanceType // The number of IPv6 addresses to associate with the primary network interface. // Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot // specify this option and the option to assign specific IPv6 addresses in the same // request. You can specify this option if you've specified a minimum number of - // instances to launch. You cannot specify this option and the network interfaces - // option in the same request. + // instances to launch. + // + // You cannot specify this option and the network interfaces option in the same + // request. Ipv6AddressCount *int32 // The IPv6 addresses from the range of the subnet to associate with the primary // network interface. You cannot specify this option and the option to assign a // number of IPv6 addresses in the same request. You cannot specify this option if - // you've specified a minimum number of instances to launch. You cannot specify - // this option and the network interfaces option in the same request. + // you've specified a minimum number of instances to launch. + // + // You cannot specify this option and the network interfaces option in the same + // request. 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) - // in the Amazon EC2 User Guide. + // The ID of the kernel. + // + // We recommend that you use PV-GRUB instead of kernels and RAM disks. For more + // information, see [PV-GRUB]in the Amazon EC2 User Guide. + // + // [PV-GRUB]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html 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] or [ImportKeyPair]. + // + // 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. + // + // [ImportKeyPair]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html + // [CreateKeyPair]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html KeyName *string // The launch template. Any additional parameters that you specify for the new @@ -241,9 +298,9 @@ type RunInstancesInput struct { // The maintenance and recovery options for the instance. 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) - // . + // The metadata options for the instance. For more information, see [Instance metadata and user data]. + // + // [Instance 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. @@ -261,55 +318,74 @@ type RunInstancesInput struct { PrivateDnsNameOptions *types.PrivateDnsNameOptionsRequest // The primary IPv4 address. You must specify a value from the IPv4 address range - // of the subnet. Only one private IP address can be designated as primary. You - // can't specify this option if you've specified the option to designate a private - // IP address as the primary IP address in a network interface specification. You - // cannot specify this option if you're launching more than one instance in the - // request. You cannot specify this option and the network interfaces option in the - // same request. + // of the subnet. + // + // Only one private IP address can be designated as primary. You can't specify + // this option if you've specified the option to designate a private IP address as + // the primary IP address in a network interface specification. You cannot specify + // this option if you're launching more than one instance in the request. + // + // You cannot specify this option and the network interfaces option in the same + // request. PrivateIpAddress *string // The ID of the RAM disk to select. 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, 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) - // in the Amazon EC2 User Guide. + // 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]in the Amazon EC2 User Guide. + // + // [PV-GRUB]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html 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 + // The IDs of the security groups. You can create a security group using [CreateSecurityGroup]. + // + // If you specify a network interface, you must specify any security groups as // part of the network interface instead of using this parameter. + // + // [CreateSecurityGroup]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html SecurityGroupIds []string - // [Default VPC] The names of the security groups. If you specify a network - // interface, you must specify any security groups as part of the network interface - // instead of using this parameter. Default: Amazon EC2 uses the default security - // group. + // [Default VPC] The names of the security groups. + // + // If you specify a network interface, you must specify any security groups as + // part of the network interface instead of using this parameter. + // + // Default: Amazon EC2 uses the default security group. SecurityGroups []string - // The ID of the subnet to launch the instance into. If you specify a network - // interface, you must specify any subnets as part of the network interface instead - // of using this parameter. + // The ID of the subnet to launch the instance into. + // + // If you specify a network interface, you must specify any subnets as part of the + // network interface instead of using this parameter. SubnetId *string - // The tags to apply to the resources that are created during instance launch. You - // can specify tags for the following resources only: + // The tags to apply to the resources that are created during instance launch. + // + // You can specify tags for the following resources only: + // // - Instances + // // - Volumes + // // - 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 a resource after it has been created, see [CreateTags]. + // + // [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 + // see [Run commands on your Linux instance at launch]and [Run commands on your Windows instance at launch]. 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. + // + // [Run commands on your Linux instance at launch]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html + // [Run commands on your Windows instance at launch]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html UserData *string noSmithyDocumentSerde diff --git a/service/ec2/api_op_RunScheduledInstances.go b/service/ec2/api_op_RunScheduledInstances.go index e443205fed4..6f97d985648 100644 --- a/service/ec2/api_op_RunScheduledInstances.go +++ b/service/ec2/api_op_RunScheduledInstances.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the Amazon EC2 User Guide. +// 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 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]in +// the Amazon EC2 User Guide. +// +// [Scheduled Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-scheduled-instances.html func (c *Client) RunScheduledInstances(ctx context.Context, params *RunScheduledInstancesInput, optFns ...func(*Options)) (*RunScheduledInstancesOutput, error) { if params == nil { params = &RunScheduledInstancesInput{} @@ -49,8 +53,9 @@ 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]. + // + // [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 @@ -59,7 +64,9 @@ type RunScheduledInstancesInput struct { // UnauthorizedOperation . DryRun *bool - // The number of instances. Default: 1 + // The number of instances. + // + // Default: 1 InstanceCount *int32 noSmithyDocumentSerde diff --git a/service/ec2/api_op_SearchLocalGatewayRoutes.go b/service/ec2/api_op_SearchLocalGatewayRoutes.go index 5602f886c80..481f33ebe48 100644 --- a/service/ec2/api_op_SearchLocalGatewayRoutes.go +++ b/service/ec2/api_op_SearchLocalGatewayRoutes.go @@ -41,17 +41,24 @@ type SearchLocalGatewayRoutesInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go b/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go index 1fbad212b7e..4cec5501087 100644 --- a/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go +++ b/service/ec2/api_op_SearchTransitGatewayMulticastGroups.go @@ -42,17 +42,26 @@ type SearchTransitGatewayMulticastGroupsInput struct { 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. Filters []types.Filter diff --git a/service/ec2/api_op_SearchTransitGatewayRoutes.go b/service/ec2/api_op_SearchTransitGatewayRoutes.go index 89037e62bcd..b342d513adf 100644 --- a/service/ec2/api_op_SearchTransitGatewayRoutes.go +++ b/service/ec2/api_op_SearchTransitGatewayRoutes.go @@ -30,22 +30,32 @@ 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 ). // // This member is required. diff --git a/service/ec2/api_op_SendDiagnosticInterrupt.go b/service/ec2/api_op_SendDiagnosticInterrupt.go index 9f168623d40..3d528fffc69 100644 --- a/service/ec2/api_op_SendDiagnosticInterrupt.go +++ b/service/ec2/api_op_SendDiagnosticInterrupt.go @@ -13,17 +13,21 @@ import ( // Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a // kernel panic (on Linux instances), or a blue screen/stop error (on Windows // instances). For instances based on Intel and AMD processors, the interrupt is -// received as a non-maskable interrupt (NMI). In general, the operating system -// crashes and reboots when a kernel panic or stop error is triggered. The -// operating system can also be configured to perform diagnostic tasks, such as -// generating a memory dump file, loading a secondary kernel, or obtaining a call -// trace. Before sending a diagnostic interrupt to your instance, ensure that its -// 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) +// received as a non-maskable interrupt (NMI). +// +// In general, the operating system crashes and reboots when a kernel panic or +// stop error is triggered. The operating system can also be configured to perform +// diagnostic tasks, such as generating a memory dump file, loading a secondary +// kernel, or obtaining a call trace. +// +// Before sending a diagnostic interrupt to your instance, ensure that its +// 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)](Linux instances) or [Send a diagnostic interrupt (for advanced users)] // (Windows instances). +// +// [Send a diagnostic interrupt (for advanced users)]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/diagnostic-interrupt.html func (c *Client) SendDiagnosticInterrupt(ctx context.Context, params *SendDiagnosticInterruptInput, optFns ...func(*Options)) (*SendDiagnosticInterruptOutput, error) { if params == nil { params = &SendDiagnosticInterruptInput{} diff --git a/service/ec2/api_op_StartInstances.go b/service/ec2/api_op_StartInstances.go index 5facb6173bc..e47c7e3ab70 100644 --- a/service/ec2/api_op_StartInstances.go +++ b/service/ec2/api_op_StartInstances.go @@ -11,23 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an Amazon EBS-backed instance that you've previously stopped. Instances -// that use Amazon EBS volumes as their root devices can be quickly stopped and -// started. When an instance is stopped, the compute resources are released and you -// are not billed for instance usage. However, your root partition Amazon EBS -// volume remains and continues to persist your data, and you are charged for -// Amazon EBS volume usage. You can restart your instance at any time. Every time -// you start your instance, Amazon EC2 charges a one-minute minimum for instance -// usage, and thereafter charges per second for instance usage. Before stopping an -// instance, make sure it is in a state from which it can be restarted. Stopping an -// instance does not preserve data stored in RAM. Performing this operation on an -// instance that uses an instance store as its root device returns an error. If you -// attempt to start a T3 instance with host tenancy and the unlimited 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. +// Starts an Amazon EBS-backed instance that you've previously stopped. +// +// Instances that use Amazon EBS volumes as their root devices can be quickly +// stopped and started. When an instance is stopped, the compute resources are +// released and you are not billed for instance usage. However, your root partition +// Amazon EBS volume remains and continues to persist your data, and you are +// charged for Amazon EBS volume usage. You can restart your instance at any time. +// Every time you start your instance, Amazon EC2 charges a one-minute minimum for +// instance usage, and thereafter charges per second for instance usage. +// +// Before stopping an instance, make sure it is in a state from which it can be +// restarted. Stopping an instance does not preserve data stored in RAM. +// +// Performing this operation on an instance that uses an instance store as its +// root device returns an error. +// +// If you attempt to start a T3 instance with host tenancy and the unlimited 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] in the Amazon EC2 User Guide. +// +// [Stop and start your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html func (c *Client) StartInstances(ctx context.Context, params *StartInstancesInput, optFns ...func(*Options)) (*StartInstancesOutput, error) { if params == nil { params = &StartInstancesInput{} diff --git a/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go b/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go index 98b7654f029..60c1d4a5333 100644 --- a/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go +++ b/service/ec2/api_op_StartNetworkInsightsAccessScopeAnalysis.go @@ -30,8 +30,9 @@ 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]. + // + // [How to ensure 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_StartNetworkInsightsAnalysis.go b/service/ec2/api_op_StartNetworkInsightsAnalysis.go index cd41596d616..1118fba02de 100644 --- a/service/ec2/api_op_StartNetworkInsightsAnalysis.go +++ b/service/ec2/api_op_StartNetworkInsightsAnalysis.go @@ -31,8 +31,9 @@ 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]. + // + // [How to ensure 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_StartVpcEndpointServicePrivateDnsVerification.go b/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go index 6c1a575e60f..a386763ae7f 100644 --- a/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go +++ b/service/ec2/api_op_StartVpcEndpointServicePrivateDnsVerification.go @@ -11,10 +11,13 @@ import ( ) // Initiates the verification process to prove that the service provider owns the -// private DNS name domain for the endpoint service. The service provider must -// successfully perform the verification before the consumer can use the name to -// access the service. Before the service provider runs this command, they must add -// a record to the DNS server. +// private DNS name domain for the endpoint service. +// +// The service provider must successfully perform the verification before the +// consumer can use the name to access the service. +// +// Before the service provider runs this command, they must add a record to the +// DNS server. func (c *Client) StartVpcEndpointServicePrivateDnsVerification(ctx context.Context, params *StartVpcEndpointServicePrivateDnsVerificationInput, optFns ...func(*Options)) (*StartVpcEndpointServicePrivateDnsVerificationOutput, error) { if params == nil { params = &StartVpcEndpointServicePrivateDnsVerificationInput{} diff --git a/service/ec2/api_op_StopInstances.go b/service/ec2/api_op_StopInstances.go index 7ba1e89511c..72747926888 100644 --- a/service/ec2/api_op_StopInstances.go +++ b/service/ec2/api_op_StopInstances.go @@ -11,38 +11,50 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/enabling-hibernation.html) -// and it 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 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) -// 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 -// an instance does not preserve data stored in RAM, but hibernating an instance -// does preserve data stored in RAM. If an instance cannot hibernate successfully, -// a normal shutdown occurs. Stopping and hibernating an instance is different to -// rebooting or terminating it. For example, when you stop or hibernate an -// instance, the root device and any other devices attached to the instance -// 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) -// 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) -// in the Amazon EC2 User Guide. +// Stops an Amazon EBS-backed instance. For more information, see [Stop and start your instance] in the Amazon +// EC2 User Guide. +// +// You can use the Stop action to hibernate an instance if the instance is [enabled for hibernation] and it +// meets the [hibernation prerequisites]. For more information, see [Hibernate your instance] 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]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 an instance does not +// preserve data stored in RAM, but hibernating an instance does preserve data +// stored in RAM. If an instance cannot hibernate successfully, a normal shutdown +// occurs. +// +// Stopping and hibernating an instance is different to rebooting or terminating +// it. For example, when you stop or hibernate an instance, the root device and any +// other devices attached to the instance 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]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]in the Amazon EC2 User Guide. +// +// [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html +// [Troubleshoot stopping your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html +// [Stop and start your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html +// [Instance lifecycle]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html +// [enabled for hibernation]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enabling-hibernation.html +// [Hibernating interrupted Spot Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html#hibernate-spot-instances +// [hibernation prerequisites]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html func (c *Client) StopInstances(ctx context.Context, params *StopInstancesInput, optFns ...func(*Options)) (*StopInstancesOutput, error) { if params == nil { params = &StopInstancesInput{} @@ -74,13 +86,18 @@ type StopInstancesInput struct { // Forces the instances to stop. The instances do not have an opportunity to flush // file system caches or file system metadata. If you use this option, you must // perform file system check and repair procedures. This option is not recommended - // for Windows instances. Default: false + // for Windows instances. + // + // Default: false Force *bool // 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]in the Amazon EC2 User Guide. + // + // Default: false + // + // [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html Hibernate *bool noSmithyDocumentSerde diff --git a/service/ec2/api_op_TerminateInstances.go b/service/ec2/api_op_TerminateInstances.go index 10bc40314fc..a33d5055bed 100644 --- a/service/ec2/api_op_TerminateInstances.go +++ b/service/ec2/api_op_TerminateInstances.go @@ -12,45 +12,60 @@ import ( ) // Shuts down the specified instances. This operation is idempotent; if you -// terminate an instance more than once, each call succeeds. If you specify -// multiple instances and the request fails (for example, because of a single -// incorrect instance ID), none of the instances are terminated. If you terminate -// 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: +// terminate an instance more than once, each call succeeds. +// +// If you specify multiple instances and the request fails (for example, because +// of a single incorrect instance ID), none of the instances are terminated. +// +// If you terminate 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. // // 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. +// 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) -// in the Amazon EC2 User Guide. +// about the differences between stopping and terminating instances, see [Instance lifecycle]in the +// Amazon EC2 User Guide. +// +// For more information about troubleshooting, see [Troubleshooting terminating your instance] in the Amazon EC2 User Guide. +// +// [Instance lifecycle]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html +// [Troubleshooting terminating your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html func (c *Client) TerminateInstances(ctx context.Context, params *TerminateInstancesInput, optFns ...func(*Options)) (*TerminateInstancesOutput, error) { if params == nil { params = &TerminateInstancesInput{} @@ -68,8 +83,10 @@ func (c *Client) TerminateInstances(ctx context.Context, params *TerminateInstan type TerminateInstancesInput struct { - // The IDs of the instances. Constraints: Up to 1000 instance IDs. We recommend - // breaking up this request into smaller batches. + // The IDs of the instances. + // + // Constraints: Up to 1000 instance IDs. We recommend breaking up this request + // into smaller batches. // // This member is required. InstanceIds []string diff --git a/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go b/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go index 7bfaf046da3..04b76f21240 100644 --- a/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go +++ b/service/ec2/api_op_UnassignPrivateNatGatewayAddress.go @@ -12,16 +12,20 @@ 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) -// in the Amazon VPC 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 gateway. A private IP address will -// only be released at the end of MaxDrainDurationSeconds. The private IP addresses -// stay associated and support the existing connections, but do not support any new -// connections (new connections are distributed across the remaining assigned -// private IP address). After the existing connections drain out, the private IP -// addresses are released. +// cannot unassign your primary private IP. For more information, see [Edit secondary IP address associations]in the +// Amazon VPC 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 gateway. +// +// A private IP address will only be released at the end of +// MaxDrainDurationSeconds. The private IP addresses stay associated and support +// the existing connections, but do not support any new connections (new +// connections are distributed across the remaining assigned private IP address). +// After the existing connections drain out, the private IP addresses are released. +// +// [Edit secondary IP address associations]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-edit-secondary func (c *Client) UnassignPrivateNatGatewayAddress(ctx context.Context, params *UnassignPrivateNatGatewayAddressInput, optFns ...func(*Options)) (*UnassignPrivateNatGatewayAddressOutput, error) { if params == nil { params = &UnassignPrivateNatGatewayAddressInput{} diff --git a/service/ec2/api_op_UnmonitorInstances.go b/service/ec2/api_op_UnmonitorInstances.go index 3ef2b363caf..139e7173daa 100644 --- a/service/ec2/api_op_UnmonitorInstances.go +++ b/service/ec2/api_op_UnmonitorInstances.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Disables detailed monitoring for a running instance. For more information, see [Monitoring your instances and volumes] // in the Amazon EC2 User Guide. +// +// [Monitoring your instances and volumes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html func (c *Client) UnmonitorInstances(ctx context.Context, params *UnmonitorInstancesInput, optFns ...func(*Options)) (*UnmonitorInstancesOutput, error) { if params == nil { params = &UnmonitorInstancesInput{} diff --git a/service/ec2/api_op_WithdrawByoipCidr.go b/service/ec2/api_op_WithdrawByoipCidr.go index b44a8636039..704531aea5c 100644 --- a/service/ec2/api_op_WithdrawByoipCidr.go +++ b/service/ec2/api_op_WithdrawByoipCidr.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops advertising an address range that is provisioned as an address pool. You -// can perform this operation at most once every 10 seconds, even if you specify -// 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 BGP -// propagation delays. +// Stops advertising an address range that is provisioned as an address pool. +// +// You can perform this operation at most once every 10 seconds, even if you +// specify 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 BGP propagation delays. func (c *Client) WithdrawByoipCidr(ctx context.Context, params *WithdrawByoipCidrInput, optFns ...func(*Options)) (*WithdrawByoipCidrOutput, error) { if params == nil { params = &WithdrawByoipCidrInput{} diff --git a/service/ec2/doc.go b/service/ec2/doc.go index 722c84afd2c..68f9534b424 100644 --- a/service/ec2/doc.go +++ b/service/ec2/doc.go @@ -3,7 +3,10 @@ // Package ec2 provides the API client, operations, and parameter types for Amazon // Elastic Compute Cloud. // -// Amazon Elastic Compute Cloud You can access the features of Amazon Elastic -// Compute Cloud (Amazon EC2) programmatically. For more information, see the -// Amazon EC2 Developer Guide (https://docs.aws.amazon.com/ec2/latest/devguide) . +// # Amazon Elastic Compute Cloud +// +// You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) +// programmatically. For more information, see the [Amazon EC2 Developer Guide]. +// +// [Amazon EC2 Developer Guide]: https://docs.aws.amazon.com/ec2/latest/devguide package ec2 diff --git a/service/ec2/options.go b/service/ec2/options.go index 37cb69d205f..337cb9ae092 100644 --- a/service/ec2/options.go +++ b/service/ec2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ec2/types/enums.go b/service/ec2/types/enums.go index fce6e7a6866..fbc7fe3b3d7 100644 --- a/service/ec2/types/enums.go +++ b/service/ec2/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AcceleratorManufacturer. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorManufacturer) Values() []AcceleratorManufacturer { return []AcceleratorManufacturer{ "amazon-web-services", @@ -45,8 +46,9 @@ const ( ) // Values returns all known values for AcceleratorName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorName) Values() []AcceleratorName { return []AcceleratorName{ "a100", @@ -74,8 +76,9 @@ const ( ) // Values returns all known values for AcceleratorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorType) Values() []AcceleratorType { return []AcceleratorType{ "gpu", @@ -93,8 +96,9 @@ const ( ) // Values returns all known values for AccountAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountAttributeName) Values() []AccountAttributeName { return []AccountAttributeName{ "supported-platforms", @@ -113,8 +117,9 @@ const ( ) // Values returns all known values for ActivityStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActivityStatus) Values() []ActivityStatus { return []ActivityStatus{ "error", @@ -132,8 +137,9 @@ const ( ) // Values returns all known values for AddressAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddressAttributeName) Values() []AddressAttributeName { return []AddressAttributeName{ "domain-name", @@ -149,8 +155,9 @@ const ( ) // Values returns all known values for AddressFamily. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddressFamily) Values() []AddressFamily { return []AddressFamily{ "ipv4", @@ -168,8 +175,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "pending", @@ -187,8 +195,9 @@ const ( ) // Values returns all known values for Affinity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Affinity) Values() []Affinity { return []Affinity{ "default", @@ -209,8 +218,9 @@ const ( ) // Values returns all known values for AllocationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllocationState) Values() []AllocationState { return []AllocationState{ "available", @@ -234,8 +244,9 @@ const ( ) // Values returns all known values for AllocationStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllocationStrategy) Values() []AllocationStrategy { return []AllocationStrategy{ "lowestPrice", @@ -254,8 +265,9 @@ const ( ) // Values returns all known values for AllocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllocationType) Values() []AllocationType { return []AllocationType{ "used", @@ -272,6 +284,7 @@ const ( // Values returns all known values for AllowsMultipleInstanceTypes. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AllowsMultipleInstanceTypes) Values() []AllowsMultipleInstanceTypes { return []AllowsMultipleInstanceTypes{ @@ -289,8 +302,9 @@ const ( ) // Values returns all known values for AmdSevSnpSpecification. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AmdSevSnpSpecification) Values() []AmdSevSnpSpecification { return []AmdSevSnpSpecification{ "enabled", @@ -308,8 +322,9 @@ const ( ) // Values returns all known values for AnalysisStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisStatus) Values() []AnalysisStatus { return []AnalysisStatus{ "running", @@ -328,6 +343,7 @@ const ( // Values returns all known values for ApplianceModeSupportValue. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ApplianceModeSupportValue) Values() []ApplianceModeSupportValue { return []ApplianceModeSupportValue{ @@ -348,8 +364,9 @@ const ( ) // Values returns all known values for ArchitectureType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArchitectureType) Values() []ArchitectureType { return []ArchitectureType{ "i386", @@ -372,8 +389,9 @@ const ( ) // Values returns all known values for ArchitectureValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArchitectureValues) Values() []ArchitectureValues { return []ArchitectureValues{ "i386", @@ -397,8 +415,9 @@ const ( ) // Values returns all known values for AsnAssociationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AsnAssociationState) Values() []AsnAssociationState { return []AsnAssociationState{ "disassociated", @@ -423,8 +442,9 @@ const ( ) // Values returns all known values for AsnState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AsnState) Values() []AsnState { return []AsnState{ "deprovisioned", @@ -444,8 +464,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "vpc", @@ -464,8 +485,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "associating", @@ -487,8 +509,9 @@ const ( ) // Values returns all known values for AttachmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentStatus) Values() []AttachmentStatus { return []AttachmentStatus{ "attaching", @@ -508,8 +531,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoAcceptSharedAssociationsValue) Values() []AutoAcceptSharedAssociationsValue { return []AutoAcceptSharedAssociationsValue{ "enable", @@ -527,8 +551,9 @@ const ( // Values returns all known values for AutoAcceptSharedAttachmentsValue. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoAcceptSharedAttachmentsValue) Values() []AutoAcceptSharedAttachmentsValue { return []AutoAcceptSharedAttachmentsValue{ "enable", @@ -545,8 +570,9 @@ const ( ) // Values returns all known values for AutoPlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoPlacement) Values() []AutoPlacement { return []AutoPlacement{ "on", @@ -565,6 +591,7 @@ const ( // Values returns all known values for AvailabilityZoneOptInStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AvailabilityZoneOptInStatus) Values() []AvailabilityZoneOptInStatus { return []AvailabilityZoneOptInStatus{ @@ -586,8 +613,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "available", @@ -608,8 +636,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -632,8 +661,9 @@ const ( ) // Values returns all known values for BatchState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchState) Values() []BatchState { return []BatchState{ "submitted", @@ -655,8 +685,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -673,8 +704,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -692,8 +724,9 @@ const ( ) // Values returns all known values for BootModeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BootModeValues) Values() []BootModeValues { return []BootModeValues{ "legacy-bios", @@ -716,8 +749,9 @@ const ( ) // Values returns all known values for BundleTaskState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BundleTaskState) Values() []BundleTaskState { return []BundleTaskState{ "pending", @@ -740,8 +774,9 @@ const ( ) // Values returns all known values for BurstablePerformance. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurstablePerformance) Values() []BurstablePerformance { return []BurstablePerformance{ "included", @@ -765,8 +800,9 @@ const ( ) // Values returns all known values for ByoipCidrState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ByoipCidrState) Values() []ByoipCidrState { return []ByoipCidrState{ "advertised", @@ -791,8 +827,9 @@ const ( ) // Values returns all known values for CancelBatchErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CancelBatchErrorCode) Values() []CancelBatchErrorCode { return []CancelBatchErrorCode{ "fleetRequestIdDoesNotExist", @@ -815,8 +852,9 @@ const ( // Values returns all known values for CancelSpotInstanceRequestState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CancelSpotInstanceRequestState) Values() []CancelSpotInstanceRequestState { return []CancelSpotInstanceRequestState{ "active", @@ -844,8 +882,9 @@ const ( // Values returns all known values for CapacityReservationFleetState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationFleetState) Values() []CapacityReservationFleetState { return []CapacityReservationFleetState{ "submitted", @@ -886,8 +925,9 @@ const ( // Values returns all known values for CapacityReservationInstancePlatform. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationInstancePlatform) Values() []CapacityReservationInstancePlatform { return []CapacityReservationInstancePlatform{ "Linux/UNIX", @@ -921,8 +961,9 @@ const ( // Values returns all known values for CapacityReservationPreference. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationPreference) Values() []CapacityReservationPreference { return []CapacityReservationPreference{ "open", @@ -946,6 +987,7 @@ const ( // 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{ @@ -970,6 +1012,7 @@ const ( // Values returns all known values for CapacityReservationTenancy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationTenancy) Values() []CapacityReservationTenancy { return []CapacityReservationTenancy{ @@ -987,8 +1030,9 @@ const ( ) // Values returns all known values for CapacityReservationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityReservationType) Values() []CapacityReservationType { return []CapacityReservationType{ "default", @@ -1007,8 +1051,9 @@ const ( ) // Values returns all known values for CarrierGatewayState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CarrierGatewayState) Values() []CarrierGatewayState { return []CarrierGatewayState{ "pending", @@ -1028,8 +1073,9 @@ const ( // Values returns all known values for ClientCertificateRevocationListStatusCode. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientCertificateRevocationListStatusCode) Values() []ClientCertificateRevocationListStatusCode { return []ClientCertificateRevocationListStatusCode{ "pending", @@ -1048,6 +1094,7 @@ const ( // Values returns all known values for ClientVpnAuthenticationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ClientVpnAuthenticationType) Values() []ClientVpnAuthenticationType { return []ClientVpnAuthenticationType{ @@ -1069,8 +1116,9 @@ const ( // Values returns all known values for ClientVpnAuthorizationRuleStatusCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientVpnAuthorizationRuleStatusCode) Values() []ClientVpnAuthorizationRuleStatusCode { return []ClientVpnAuthorizationRuleStatusCode{ "authorizing", @@ -1092,8 +1140,9 @@ const ( // Values returns all known values for ClientVpnConnectionStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientVpnConnectionStatusCode) Values() []ClientVpnConnectionStatusCode { return []ClientVpnConnectionStatusCode{ "active", @@ -1113,8 +1162,9 @@ const ( // Values returns all known values for ClientVpnEndpointAttributeStatusCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientVpnEndpointAttributeStatusCode) Values() []ClientVpnEndpointAttributeStatusCode { return []ClientVpnEndpointAttributeStatusCode{ "applying", @@ -1134,6 +1184,7 @@ const ( // Values returns all known values for ClientVpnEndpointStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ClientVpnEndpointStatusCode) Values() []ClientVpnEndpointStatusCode { return []ClientVpnEndpointStatusCode{ @@ -1156,6 +1207,7 @@ const ( // 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{ @@ -1176,6 +1228,7 @@ const ( // Values returns all known values for ConnectionNotificationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionNotificationState) Values() []ConnectionNotificationState { return []ConnectionNotificationState{ @@ -1193,6 +1246,7 @@ const ( // Values returns all known values for ConnectionNotificationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionNotificationType) Values() []ConnectionNotificationType { return []ConnectionNotificationType{ @@ -1209,8 +1263,9 @@ const ( ) // Values returns all known values for ConnectivityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectivityType) Values() []ConnectivityType { return []ConnectivityType{ "private", @@ -1226,8 +1281,9 @@ const ( ) // Values returns all known values for ContainerFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerFormat) Values() []ContainerFormat { return []ContainerFormat{ "ova", @@ -1245,8 +1301,9 @@ const ( ) // Values returns all known values for ConversionTaskState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConversionTaskState) Values() []ConversionTaskState { return []ConversionTaskState{ "active", @@ -1264,8 +1321,9 @@ const ( ) // Values returns all known values for CopyTagsFromSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CopyTagsFromSource) Values() []CopyTagsFromSource { return []CopyTagsFromSource{ "volume", @@ -1282,8 +1340,9 @@ const ( ) // Values returns all known values for CpuManufacturer. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CpuManufacturer) Values() []CpuManufacturer { return []CpuManufacturer{ "intel", @@ -1300,8 +1359,9 @@ const ( ) // Values returns all known values for CurrencyCodeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CurrencyCodeValues) Values() []CurrencyCodeValues { return []CurrencyCodeValues{ "USD", @@ -1318,6 +1378,7 @@ const ( // Values returns all known values for DatafeedSubscriptionState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DatafeedSubscriptionState) Values() []DatafeedSubscriptionState { return []DatafeedSubscriptionState{ @@ -1337,8 +1398,9 @@ const ( // Values returns all known values for DefaultInstanceMetadataEndpointState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultInstanceMetadataEndpointState) Values() []DefaultInstanceMetadataEndpointState { return []DefaultInstanceMetadataEndpointState{ "disabled", @@ -1358,8 +1420,9 @@ const ( // Values returns all known values for DefaultInstanceMetadataTagsState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultInstanceMetadataTagsState) Values() []DefaultInstanceMetadataTagsState { return []DefaultInstanceMetadataTagsState{ "disabled", @@ -1378,8 +1441,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultRouteTableAssociationValue) Values() []DefaultRouteTableAssociationValue { return []DefaultRouteTableAssociationValue{ "enable", @@ -1397,8 +1461,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultRouteTablePropagationValue) Values() []DefaultRouteTablePropagationValue { return []DefaultRouteTablePropagationValue{ "enable", @@ -1417,6 +1482,7 @@ const ( // Values returns all known values for DefaultTargetCapacityType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DefaultTargetCapacityType) Values() []DefaultTargetCapacityType { return []DefaultTargetCapacityType{ @@ -1437,8 +1503,9 @@ const ( ) // Values returns all known values for DeleteFleetErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteFleetErrorCode) Values() []DeleteFleetErrorCode { return []DeleteFleetErrorCode{ "fleetIdDoesNotExist", @@ -1459,8 +1526,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteQueuedReservedInstancesErrorCode) Values() []DeleteQueuedReservedInstancesErrorCode { return []DeleteQueuedReservedInstancesErrorCode{ "reserved-instances-id-invalid", @@ -1478,8 +1546,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "plain-text", @@ -1497,8 +1566,9 @@ const ( ) // Values returns all known values for DeviceTrustProviderType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceTrustProviderType) Values() []DeviceTrustProviderType { return []DeviceTrustProviderType{ "jamf", @@ -1516,8 +1586,9 @@ const ( ) // Values returns all known values for DeviceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceType) Values() []DeviceType { return []DeviceType{ "ebs", @@ -1535,8 +1606,9 @@ const ( ) // Values returns all known values for DiskImageFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiskImageFormat) Values() []DiskImageFormat { return []DiskImageFormat{ "VMDK", @@ -1554,8 +1626,9 @@ const ( ) // Values returns all known values for DiskType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiskType) Values() []DiskType { return []DiskType{ "hdd", @@ -1573,8 +1646,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1594,8 +1668,9 @@ const ( ) // Values returns all known values for DnsRecordIpType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DnsRecordIpType) Values() []DnsRecordIpType { return []DnsRecordIpType{ "ipv4", @@ -1614,8 +1689,9 @@ const ( ) // Values returns all known values for DnsSupportValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DnsSupportValue) Values() []DnsSupportValue { return []DnsSupportValue{ "enable", @@ -1632,8 +1708,9 @@ const ( ) // Values returns all known values for DomainType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainType) Values() []DomainType { return []DomainType{ "vpc", @@ -1650,8 +1727,9 @@ const ( ) // Values returns all known values for DynamicRoutingValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DynamicRoutingValue) Values() []DynamicRoutingValue { return []DynamicRoutingValue{ "enable", @@ -1668,8 +1746,9 @@ const ( ) // Values returns all known values for EbsEncryptionSupport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EbsEncryptionSupport) Values() []EbsEncryptionSupport { return []EbsEncryptionSupport{ "unsupported", @@ -1687,8 +1766,9 @@ const ( ) // Values returns all known values for EbsNvmeSupport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EbsNvmeSupport) Values() []EbsNvmeSupport { return []EbsNvmeSupport{ "unsupported", @@ -1707,8 +1787,9 @@ const ( ) // Values returns all known values for EbsOptimizedSupport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EbsOptimizedSupport) Values() []EbsOptimizedSupport { return []EbsOptimizedSupport{ "unsupported", @@ -1731,8 +1812,9 @@ const ( // Values returns all known values for Ec2InstanceConnectEndpointState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2InstanceConnectEndpointState) Values() []Ec2InstanceConnectEndpointState { return []Ec2InstanceConnectEndpointState{ "create-in-progress", @@ -1753,8 +1835,9 @@ const ( ) // Values returns all known values for EkPubKeyFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EkPubKeyFormat) Values() []EkPubKeyFormat { return []EkPubKeyFormat{ "der", @@ -1771,8 +1854,9 @@ const ( ) // Values returns all known values for EkPubKeyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EkPubKeyType) Values() []EkPubKeyType { return []EkPubKeyType{ "rsa-2048", @@ -1788,8 +1872,9 @@ const ( ) // Values returns all known values for ElasticGpuState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ElasticGpuState) Values() []ElasticGpuState { return []ElasticGpuState{ "ATTACHED", @@ -1805,8 +1890,9 @@ const ( ) // Values returns all known values for ElasticGpuStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ElasticGpuStatus) Values() []ElasticGpuStatus { return []ElasticGpuStatus{ "OK", @@ -1824,8 +1910,9 @@ const ( ) // Values returns all known values for EnaSupport. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnaSupport) Values() []EnaSupport { return []EnaSupport{ "unsupported", @@ -1843,8 +1930,9 @@ const ( ) // Values returns all known values for EndDateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndDateType) Values() []EndDateType { return []EndDateType{ "unlimited", @@ -1862,8 +1950,9 @@ const ( ) // Values returns all known values for EphemeralNvmeSupport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EphemeralNvmeSupport) Values() []EphemeralNvmeSupport { return []EphemeralNvmeSupport{ "unsupported", @@ -1884,8 +1973,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1907,8 +1997,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1928,8 +2019,9 @@ const ( // Values returns all known values for ExcessCapacityTerminationPolicy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExcessCapacityTerminationPolicy) Values() []ExcessCapacityTerminationPolicy { return []ExcessCapacityTerminationPolicy{ "noTermination", @@ -1947,8 +2039,9 @@ const ( ) // Values returns all known values for ExportEnvironment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportEnvironment) Values() []ExportEnvironment { return []ExportEnvironment{ "citrix", @@ -1968,8 +2061,9 @@ const ( ) // Values returns all known values for ExportTaskState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportTaskState) Values() []ExportTaskState { return []ExportTaskState{ "active", @@ -1987,8 +2081,9 @@ const ( ) // Values returns all known values for FastLaunchResourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FastLaunchResourceType) Values() []FastLaunchResourceType { return []FastLaunchResourceType{ "snapshot", @@ -2008,8 +2103,9 @@ const ( ) // Values returns all known values for FastLaunchStateCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FastLaunchStateCode) Values() []FastLaunchStateCode { return []FastLaunchStateCode{ "enabling", @@ -2034,8 +2130,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FastSnapshotRestoreStateCode) Values() []FastSnapshotRestoreStateCode { return []FastSnapshotRestoreStateCode{ "enabling", @@ -2056,8 +2153,9 @@ const ( ) // Values returns all known values for FindingsFound. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingsFound) Values() []FindingsFound { return []FindingsFound{ "true", @@ -2077,8 +2175,9 @@ const ( ) // Values returns all known values for FleetActivityStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetActivityStatus) Values() []FleetActivityStatus { return []FleetActivityStatus{ "error", @@ -2097,8 +2196,9 @@ const ( // Values returns all known values for FleetCapacityReservationTenancy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetCapacityReservationTenancy) Values() []FleetCapacityReservationTenancy { return []FleetCapacityReservationTenancy{ "default", @@ -2114,8 +2214,9 @@ const ( // Values returns all known values for FleetCapacityReservationUsageStrategy. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetCapacityReservationUsageStrategy) Values() []FleetCapacityReservationUsageStrategy { return []FleetCapacityReservationUsageStrategy{ "use-capacity-reservations-first", @@ -2132,8 +2233,9 @@ const ( ) // Values returns all known values for FleetEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetEventType) Values() []FleetEventType { return []FleetEventType{ "instance-change", @@ -2152,8 +2254,9 @@ const ( // Values returns all known values for FleetExcessCapacityTerminationPolicy. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetExcessCapacityTerminationPolicy) Values() []FleetExcessCapacityTerminationPolicy { return []FleetExcessCapacityTerminationPolicy{ "no-termination", @@ -2170,6 +2273,7 @@ const ( // Values returns all known values for FleetInstanceMatchCriteria. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FleetInstanceMatchCriteria) Values() []FleetInstanceMatchCriteria { return []FleetInstanceMatchCriteria{ @@ -2187,8 +2291,9 @@ const ( // Values returns all known values for FleetOnDemandAllocationStrategy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetOnDemandAllocationStrategy) Values() []FleetOnDemandAllocationStrategy { return []FleetOnDemandAllocationStrategy{ "lowest-price", @@ -2206,6 +2311,7 @@ const ( // 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{ @@ -2228,8 +2334,9 @@ const ( ) // Values returns all known values for FleetStateCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetStateCode) Values() []FleetStateCode { return []FleetStateCode{ "submitted", @@ -2252,8 +2359,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2274,8 +2382,9 @@ const ( ) // Values returns all known values for FlowLogsResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlowLogsResourceType) Values() []FlowLogsResourceType { return []FlowLogsResourceType{ "VPC", @@ -2297,8 +2406,9 @@ const ( ) // Values returns all known values for FpgaImageAttributeName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FpgaImageAttributeName) Values() []FpgaImageAttributeName { return []FpgaImageAttributeName{ "description", @@ -2319,8 +2429,9 @@ const ( ) // Values returns all known values for FpgaImageStateCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FpgaImageStateCode) Values() []FpgaImageStateCode { return []FpgaImageStateCode{ "pending", @@ -2341,8 +2452,9 @@ const ( ) // Values returns all known values for GatewayAssociationState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayAssociationState) Values() []GatewayAssociationState { return []GatewayAssociationState{ "associated", @@ -2360,8 +2472,9 @@ const ( ) // Values returns all known values for GatewayType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayType) Values() []GatewayType { return []GatewayType{ "ipsec.1", @@ -2377,8 +2490,9 @@ const ( ) // Values returns all known values for HostMaintenance. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HostMaintenance) Values() []HostMaintenance { return []HostMaintenance{ "on", @@ -2395,8 +2509,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2413,8 +2528,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2431,8 +2547,9 @@ const ( ) // Values returns all known values for HostTenancy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HostTenancy) Values() []HostTenancy { return []HostTenancy{ "dedicated", @@ -2449,8 +2566,9 @@ const ( ) // Values returns all known values for HttpTokensState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpTokensState) Values() []HttpTokensState { return []HttpTokensState{ "optional", @@ -2467,8 +2585,9 @@ const ( ) // Values returns all known values for HypervisorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HypervisorType) Values() []HypervisorType { return []HypervisorType{ "ovm", @@ -2488,8 +2607,9 @@ const ( // Values returns all known values for IamInstanceProfileAssociationState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IamInstanceProfileAssociationState) Values() []IamInstanceProfileAssociationState { return []IamInstanceProfileAssociationState{ "associating", @@ -2508,8 +2628,9 @@ const ( ) // Values returns all known values for Igmpv2SupportValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Igmpv2SupportValue) Values() []Igmpv2SupportValue { return []Igmpv2SupportValue{ "enable", @@ -2537,8 +2658,9 @@ const ( ) // Values returns all known values for ImageAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageAttributeName) Values() []ImageAttributeName { return []ImageAttributeName{ "description", @@ -2566,8 +2688,9 @@ const ( // Values returns all known values for ImageBlockPublicAccessDisabledState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageBlockPublicAccessDisabledState) Values() []ImageBlockPublicAccessDisabledState { return []ImageBlockPublicAccessDisabledState{ "unblocked", @@ -2583,8 +2706,9 @@ const ( // Values returns all known values for ImageBlockPublicAccessEnabledState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageBlockPublicAccessEnabledState) Values() []ImageBlockPublicAccessEnabledState { return []ImageBlockPublicAccessEnabledState{ "block-new-sharing", @@ -2606,8 +2730,9 @@ const ( ) // Values returns all known values for ImageState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageState) Values() []ImageState { return []ImageState{ "pending", @@ -2631,8 +2756,9 @@ const ( ) // Values returns all known values for ImageTypeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageTypeValues) Values() []ImageTypeValues { return []ImageTypeValues{ "machine", @@ -2649,8 +2775,9 @@ const ( ) // Values returns all known values for ImdsSupportValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImdsSupportValues) Values() []ImdsSupportValues { return []ImdsSupportValues{ "v2.0", @@ -2680,8 +2807,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "instanceType", @@ -2713,6 +2841,7 @@ const ( // Values returns all known values for InstanceAutoRecoveryState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InstanceAutoRecoveryState) Values() []InstanceAutoRecoveryState { return []InstanceAutoRecoveryState{ @@ -2730,8 +2859,9 @@ const ( ) // Values returns all known values for InstanceBootModeValues. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceBootModeValues) Values() []InstanceBootModeValues { return []InstanceBootModeValues{ "legacy-bios", @@ -2751,6 +2881,7 @@ const ( // 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{ @@ -2770,8 +2901,9 @@ const ( ) // Values returns all known values for InstanceGeneration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceGeneration) Values() []InstanceGeneration { return []InstanceGeneration{ "current", @@ -2788,8 +2920,9 @@ const ( ) // Values returns all known values for InstanceHealthStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceHealthStatus) Values() []InstanceHealthStatus { return []InstanceHealthStatus{ "healthy", @@ -2808,8 +2941,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceInterruptionBehavior) Values() []InstanceInterruptionBehavior { return []InstanceInterruptionBehavior{ "hibernate", @@ -2827,8 +2961,9 @@ const ( ) // Values returns all known values for InstanceLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceLifecycle) Values() []InstanceLifecycle { return []InstanceLifecycle{ "spot", @@ -2846,8 +2981,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "spot", @@ -2865,8 +3001,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "open", @@ -2884,8 +3021,9 @@ const ( // Values returns all known values for InstanceMetadataEndpointState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataEndpointState) Values() []InstanceMetadataEndpointState { return []InstanceMetadataEndpointState{ "disabled", @@ -2903,8 +3041,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataOptionsState) Values() []InstanceMetadataOptionsState { return []InstanceMetadataOptionsState{ "pending", @@ -2922,8 +3061,9 @@ const ( // Values returns all known values for InstanceMetadataProtocolState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataProtocolState) Values() []InstanceMetadataProtocolState { return []InstanceMetadataProtocolState{ "disabled", @@ -2941,6 +3081,7 @@ const ( // Values returns all known values for InstanceMetadataTagsState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetadataTagsState) Values() []InstanceMetadataTagsState { return []InstanceMetadataTagsState{ @@ -2962,8 +3103,9 @@ const ( ) // Values returns all known values for InstanceStateName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStateName) Values() []InstanceStateName { return []InstanceStateName{ "pending", @@ -2985,8 +3127,9 @@ const ( // Values returns all known values for InstanceStorageEncryptionSupport. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStorageEncryptionSupport) Values() []InstanceStorageEncryptionSupport { return []InstanceStorageEncryptionSupport{ "unsupported", @@ -3797,8 +3940,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -4609,8 +4753,9 @@ const ( ) // Values returns all known values for InstanceTypeHypervisor. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceTypeHypervisor) Values() []InstanceTypeHypervisor { return []InstanceTypeHypervisor{ "nitro", @@ -4627,8 +4772,9 @@ const ( ) // Values returns all known values for InterfacePermissionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InterfacePermissionType) Values() []InterfacePermissionType { return []InterfacePermissionType{ "INSTANCE-ATTACH", @@ -4645,8 +4791,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "VLAN", @@ -4664,8 +4811,9 @@ const ( ) // Values returns all known values for IpAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressType) Values() []IpAddressType { return []IpAddressType{ "ipv4", @@ -4687,8 +4835,9 @@ const ( // Values returns all known values for IpamAddressHistoryResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamAddressHistoryResourceType) Values() []IpamAddressHistoryResourceType { return []IpamAddressHistoryResourceType{ "eip", @@ -4709,8 +4858,9 @@ const ( // Values returns all known values for IpamAssociatedResourceDiscoveryStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamAssociatedResourceDiscoveryStatus) Values() []IpamAssociatedResourceDiscoveryStatus { return []IpamAssociatedResourceDiscoveryStatus{ "active", @@ -4729,8 +4879,9 @@ const ( ) // Values returns all known values for IpamComplianceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamComplianceStatus) Values() []IpamComplianceStatus { return []IpamComplianceStatus{ "compliant", @@ -4751,6 +4902,7 @@ const ( // 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{ @@ -4770,8 +4922,9 @@ const ( ) // Values returns all known values for IpamManagementState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamManagementState) Values() []IpamManagementState { return []IpamManagementState{ "managed", @@ -4790,8 +4943,9 @@ const ( ) // Values returns all known values for IpamOverlapStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamOverlapStatus) Values() []IpamOverlapStatus { return []IpamOverlapStatus{ "overlapping", @@ -4813,8 +4967,9 @@ const ( // Values returns all known values for IpamPoolAllocationResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolAllocationResourceType) Values() []IpamPoolAllocationResourceType { return []IpamPoolAllocationResourceType{ "ipam-pool", @@ -4833,8 +4988,9 @@ const ( ) // Values returns all known values for IpamPoolAwsService. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolAwsService) Values() []IpamPoolAwsService { return []IpamPoolAwsService{ "ec2", @@ -4850,8 +5006,9 @@ const ( ) // Values returns all known values for IpamPoolCidrFailureCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolCidrFailureCode) Values() []IpamPoolCidrFailureCode { return []IpamPoolCidrFailureCode{ "cidr-not-available", @@ -4874,8 +5031,9 @@ const ( ) // Values returns all known values for IpamPoolCidrState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolCidrState) Values() []IpamPoolCidrState { return []IpamPoolCidrState{ "pending-provision", @@ -4898,8 +5056,9 @@ const ( ) // Values returns all known values for IpamPoolPublicIpSource. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolPublicIpSource) Values() []IpamPoolPublicIpSource { return []IpamPoolPublicIpSource{ "amazon", @@ -4916,6 +5075,7 @@ const ( // Values returns all known values for IpamPoolSourceResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolSourceResourceType) Values() []IpamPoolSourceResourceType { return []IpamPoolSourceResourceType{ @@ -4942,8 +5102,9 @@ const ( ) // Values returns all known values for IpamPoolState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPoolState) Values() []IpamPoolState { return []IpamPoolState{ "create-in-progress", @@ -4971,8 +5132,9 @@ const ( // Values returns all known values for IpamPublicAddressAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPublicAddressAssociationStatus) Values() []IpamPublicAddressAssociationStatus { return []IpamPublicAddressAssociationStatus{ "associated", @@ -4997,6 +5159,7 @@ const ( // Values returns all known values for IpamPublicAddressAwsService. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IpamPublicAddressAwsService) Values() []IpamPublicAddressAwsService { return []IpamPublicAddressAwsService{ @@ -5024,8 +5187,9 @@ const ( ) // Values returns all known values for IpamPublicAddressType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamPublicAddressType) Values() []IpamPublicAddressType { return []IpamPublicAddressType{ "service-managed-ip", @@ -5053,8 +5217,9 @@ const ( // Values returns all known values for IpamResourceDiscoveryAssociationState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamResourceDiscoveryAssociationState) Values() []IpamResourceDiscoveryAssociationState { return []IpamResourceDiscoveryAssociationState{ "associate-in-progress", @@ -5089,6 +5254,7 @@ const ( // Values returns all known values for IpamResourceDiscoveryState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IpamResourceDiscoveryState) Values() []IpamResourceDiscoveryState { return []IpamResourceDiscoveryState{ @@ -5120,8 +5286,9 @@ const ( ) // Values returns all known values for IpamResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamResourceType) Values() []IpamResourceType { return []IpamResourceType{ "vpc", @@ -5152,8 +5319,9 @@ const ( ) // Values returns all known values for IpamScopeState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamScopeState) Values() []IpamScopeState { return []IpamScopeState{ "create-in-progress", @@ -5180,8 +5348,9 @@ const ( ) // Values returns all known values for IpamScopeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamScopeType) Values() []IpamScopeType { return []IpamScopeType{ "public", @@ -5208,8 +5377,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -5236,8 +5406,9 @@ const ( ) // Values returns all known values for IpamTier. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpamTier) Values() []IpamTier { return []IpamTier{ "free", @@ -5254,8 +5425,9 @@ const ( ) // Values returns all known values for Ipv6SupportValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ipv6SupportValue) Values() []Ipv6SupportValue { return []Ipv6SupportValue{ "enable", @@ -5272,8 +5444,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -5290,8 +5463,9 @@ const ( ) // Values returns all known values for KeyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyType) Values() []KeyType { return []KeyType{ "rsa", @@ -5309,8 +5483,9 @@ const ( // Values returns all known values for LaunchTemplateAutoRecoveryState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchTemplateAutoRecoveryState) Values() []LaunchTemplateAutoRecoveryState { return []LaunchTemplateAutoRecoveryState{ "default", @@ -5331,8 +5506,9 @@ const ( ) // Values returns all known values for LaunchTemplateErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchTemplateErrorCode) Values() []LaunchTemplateErrorCode { return []LaunchTemplateErrorCode{ "launchTemplateIdDoesNotExist", @@ -5354,8 +5530,9 @@ const ( // Values returns all known values for LaunchTemplateHttpTokensState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchTemplateHttpTokensState) Values() []LaunchTemplateHttpTokensState { return []LaunchTemplateHttpTokensState{ "optional", @@ -5373,8 +5550,9 @@ const ( // 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. +// the future, and so 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", @@ -5392,8 +5570,9 @@ const ( // Values returns all known values for LaunchTemplateInstanceMetadataOptionsState. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchTemplateInstanceMetadataOptionsState) Values() []LaunchTemplateInstanceMetadataOptionsState { return []LaunchTemplateInstanceMetadataOptionsState{ "pending", @@ -5411,8 +5590,9 @@ const ( // Values returns all known values for LaunchTemplateInstanceMetadataProtocolIpv6. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchTemplateInstanceMetadataProtocolIpv6) Values() []LaunchTemplateInstanceMetadataProtocolIpv6 { return []LaunchTemplateInstanceMetadataProtocolIpv6{ "disabled", @@ -5430,8 +5610,9 @@ const ( // Values returns all known values for LaunchTemplateInstanceMetadataTagsState. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchTemplateInstanceMetadataTagsState) Values() []LaunchTemplateInstanceMetadataTagsState { return []LaunchTemplateInstanceMetadataTagsState{ "disabled", @@ -5450,8 +5631,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -5472,8 +5654,9 @@ const ( ) // Values returns all known values for ListingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListingStatus) Values() []ListingStatus { return []ListingStatus{ "active", @@ -5495,8 +5678,9 @@ const ( ) // Values returns all known values for LocalGatewayRouteState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocalGatewayRouteState) Values() []LocalGatewayRouteState { return []LocalGatewayRouteState{ "pending", @@ -5517,6 +5701,7 @@ const ( // Values returns all known values for LocalGatewayRouteTableMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LocalGatewayRouteTableMode) Values() []LocalGatewayRouteTableMode { return []LocalGatewayRouteTableMode{ @@ -5534,8 +5719,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "static", @@ -5553,8 +5739,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -5572,8 +5759,9 @@ const ( ) // Values returns all known values for LocalStorageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocalStorageType) Values() []LocalStorageType { return []LocalStorageType{ "hdd", @@ -5592,8 +5780,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -5612,8 +5801,9 @@ const ( ) // Values returns all known values for LockMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LockMode) Values() []LockMode { return []LockMode{ "compliance", @@ -5632,8 +5822,9 @@ const ( ) // 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. +// in the future, and so 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{ "compliance", @@ -5653,8 +5844,9 @@ const ( ) // Values returns all known values for LogDestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogDestinationType) Values() []LogDestinationType { return []LogDestinationType{ "cloud-watch-logs", @@ -5672,8 +5864,9 @@ const ( ) // Values returns all known values for MarketType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MarketType) Values() []MarketType { return []MarketType{ "spot", @@ -5690,8 +5883,9 @@ const ( ) // Values returns all known values for MembershipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MembershipType) Values() []MembershipType { return []MembershipType{ "static", @@ -5710,8 +5904,9 @@ const ( // Values returns all known values for MetadataDefaultHttpTokensState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetadataDefaultHttpTokensState) Values() []MetadataDefaultHttpTokensState { return []MetadataDefaultHttpTokensState{ "optional", @@ -5728,8 +5923,9 @@ const ( ) // Values returns all known values for MetricType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricType) Values() []MetricType { return []MetricType{ "aggregate-latency", @@ -5746,8 +5942,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModifyAvailabilityZoneOptInStatus) Values() []ModifyAvailabilityZoneOptInStatus { return []ModifyAvailabilityZoneOptInStatus{ "opted-in", @@ -5766,8 +5963,9 @@ const ( ) // Values returns all known values for MonitoringState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitoringState) Values() []MonitoringState { return []MonitoringState{ "disabled", @@ -5786,8 +5984,9 @@ const ( ) // Values returns all known values for MoveStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MoveStatus) Values() []MoveStatus { return []MoveStatus{ "movingToVpc", @@ -5804,8 +6003,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "enable", @@ -5826,8 +6026,9 @@ const ( ) // Values returns all known values for NatGatewayAddressStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NatGatewayAddressStatus) Values() []NatGatewayAddressStatus { return []NatGatewayAddressStatus{ "assigning", @@ -5851,8 +6052,9 @@ const ( ) // Values returns all known values for NatGatewayState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NatGatewayState) Values() []NatGatewayState { return []NatGatewayState{ "pending", @@ -5876,6 +6078,7 @@ const ( // Values returns all known values for NetworkInterfaceAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceAttribute) Values() []NetworkInterfaceAttribute { return []NetworkInterfaceAttribute{ @@ -5898,8 +6101,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceCreationType) Values() []NetworkInterfaceCreationType { return []NetworkInterfaceCreationType{ "efa", @@ -5920,8 +6124,9 @@ const ( // Values returns all known values for NetworkInterfacePermissionStateCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfacePermissionStateCode) Values() []NetworkInterfacePermissionStateCode { return []NetworkInterfacePermissionStateCode{ "pending", @@ -5943,8 +6148,9 @@ const ( ) // Values returns all known values for NetworkInterfaceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceStatus) Values() []NetworkInterfaceStatus { return []NetworkInterfaceStatus{ "available", @@ -5979,8 +6185,9 @@ const ( ) // Values returns all known values for NetworkInterfaceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceType) Values() []NetworkInterfaceType { return []NetworkInterfaceType{ "interface", @@ -6012,8 +6219,9 @@ const ( ) // Values returns all known values for NitroEnclavesSupport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NitroEnclavesSupport) Values() []NitroEnclavesSupport { return []NitroEnclavesSupport{ "unsupported", @@ -6030,8 +6238,9 @@ const ( ) // Values returns all known values for NitroTpmSupport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NitroTpmSupport) Values() []NitroTpmSupport { return []NitroTpmSupport{ "unsupported", @@ -6048,8 +6257,9 @@ const ( ) // Values returns all known values for OfferingClassType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferingClassType) Values() []OfferingClassType { return []OfferingClassType{ "standard", @@ -6070,8 +6280,9 @@ const ( ) // Values returns all known values for OfferingTypeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferingTypeValues) Values() []OfferingTypeValues { return []OfferingTypeValues{ "Heavy Utilization", @@ -6093,6 +6304,7 @@ const ( // Values returns all known values for OnDemandAllocationStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OnDemandAllocationStrategy) Values() []OnDemandAllocationStrategy { return []OnDemandAllocationStrategy{ @@ -6110,8 +6322,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "add", @@ -6130,8 +6343,9 @@ const ( ) // Values returns all known values for PartitionLoadFrequency. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartitionLoadFrequency) Values() []PartitionLoadFrequency { return []PartitionLoadFrequency{ "none", @@ -6149,8 +6363,9 @@ const ( ) // Values returns all known values for PayerResponsibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PayerResponsibility) Values() []PayerResponsibility { return []PayerResponsibility{ "ServiceOwner", @@ -6167,8 +6382,9 @@ const ( ) // Values returns all known values for PaymentOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PaymentOption) Values() []PaymentOption { return []PaymentOption{ "AllUpfront", @@ -6190,8 +6406,9 @@ const ( ) // Values returns all known values for PeriodType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PeriodType) Values() []PeriodType { return []PeriodType{ "five-minutes", @@ -6211,8 +6428,9 @@ const ( ) // Values returns all known values for PermissionGroup. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionGroup) Values() []PermissionGroup { return []PermissionGroup{ "all", @@ -6230,8 +6448,9 @@ const ( ) // Values returns all known values for PlacementGroupState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementGroupState) Values() []PlacementGroupState { return []PlacementGroupState{ "pending", @@ -6251,8 +6470,9 @@ const ( ) // Values returns all known values for PlacementGroupStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementGroupStrategy) Values() []PlacementGroupStrategy { return []PlacementGroupStrategy{ "cluster", @@ -6271,8 +6491,9 @@ const ( ) // Values returns all known values for PlacementStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementStrategy) Values() []PlacementStrategy { return []PlacementStrategy{ "cluster", @@ -6289,8 +6510,9 @@ const ( ) // Values returns all known values for PlatformValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlatformValues) Values() []PlatformValues { return []PlatformValues{ "Windows", @@ -6316,8 +6538,9 @@ const ( ) // Values returns all known values for PrefixListState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrefixListState) Values() []PrefixListState { return []PrefixListState{ "create-in-progress", @@ -6348,8 +6571,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "All", @@ -6370,8 +6594,9 @@ const ( ) // Values returns all known values for ProductCodeValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductCodeValues) Values() []ProductCodeValues { return []ProductCodeValues{ "devpay", @@ -6388,8 +6613,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "tcp", @@ -6405,8 +6631,9 @@ const ( ) // Values returns all known values for ProtocolValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtocolValue) Values() []ProtocolValue { return []ProtocolValue{ "gre", @@ -6422,6 +6649,7 @@ const ( // 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{ @@ -6438,8 +6666,9 @@ const ( ) // Values returns all known values for ReplacementStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplacementStrategy) Values() []ReplacementStrategy { return []ReplacementStrategy{ "launch", @@ -6461,6 +6690,7 @@ const ( // Values returns all known values for ReplaceRootVolumeTaskState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReplaceRootVolumeTaskState) Values() []ReplaceRootVolumeTaskState { return []ReplaceRootVolumeTaskState{ @@ -6490,6 +6720,7 @@ const ( // Values returns all known values for ReportInstanceReasonCodes. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReportInstanceReasonCodes) Values() []ReportInstanceReasonCodes { return []ReportInstanceReasonCodes{ @@ -6514,8 +6745,9 @@ const ( ) // Values returns all known values for ReportStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportStatusType) Values() []ReportStatusType { return []ReportStatusType{ "ok", @@ -6534,8 +6766,9 @@ const ( ) // Values returns all known values for ReservationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservationState) Values() []ReservationState { return []ReservationState{ "payment-pending", @@ -6558,8 +6791,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "payment-pending", @@ -6580,6 +6814,7 @@ const ( // Values returns all known values for ResetFpgaImageAttributeName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResetFpgaImageAttributeName) Values() []ResetFpgaImageAttributeName { return []ResetFpgaImageAttributeName{ @@ -6595,8 +6830,9 @@ const ( ) // Values returns all known values for ResetImageAttributeName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResetImageAttributeName) Values() []ResetImageAttributeName { return []ResetImageAttributeName{ "launchPermission", @@ -6696,8 +6932,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -6800,8 +7037,9 @@ const ( ) // Values returns all known values for RIProductDescription. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RIProductDescription) Values() []RIProductDescription { return []RIProductDescription{ "Linux/UNIX", @@ -6820,8 +7058,9 @@ const ( ) // Values returns all known values for RootDeviceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RootDeviceType) Values() []RootDeviceType { return []RootDeviceType{ "ebs", @@ -6839,8 +7078,9 @@ const ( ) // Values returns all known values for RouteOrigin. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteOrigin) Values() []RouteOrigin { return []RouteOrigin{ "CreateRouteTable", @@ -6858,8 +7098,9 @@ const ( ) // Values returns all known values for RouteState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteState) Values() []RouteState { return []RouteState{ "active", @@ -6880,8 +7121,9 @@ const ( // Values returns all known values for RouteTableAssociationStateCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteTableAssociationStateCode) Values() []RouteTableAssociationStateCode { return []RouteTableAssociationStateCode{ "associating", @@ -6901,8 +7143,9 @@ const ( ) // Values returns all known values for RuleAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleAction) Values() []RuleAction { return []RuleAction{ "allow", @@ -6919,8 +7162,9 @@ const ( ) // 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. +// the future, and so 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{ "Availability Zone", @@ -6938,8 +7182,9 @@ const ( // Values returns all known values for SecurityGroupReferencingSupportValue. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityGroupReferencingSupportValue) Values() []SecurityGroupReferencingSupportValue { return []SecurityGroupReferencingSupportValue{ "enable", @@ -6956,8 +7201,9 @@ const ( ) // Values returns all known values for SelfServicePortal. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SelfServicePortal) Values() []SelfServicePortal { return []SelfServicePortal{ "enabled", @@ -6974,8 +7220,9 @@ const ( ) // Values returns all known values for ServiceConnectivityType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceConnectivityType) Values() []ServiceConnectivityType { return []ServiceConnectivityType{ "ipv4", @@ -6995,8 +7242,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -7017,8 +7265,9 @@ const ( ) // Values returns all known values for ServiceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceType) Values() []ServiceType { return []ServiceType{ "Interface", @@ -7036,8 +7285,9 @@ const ( ) // Values returns all known values for ShutdownBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShutdownBehavior) Values() []ShutdownBehavior { return []ShutdownBehavior{ "stop", @@ -7054,8 +7304,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "productCodes", @@ -7074,8 +7325,9 @@ const ( // Values returns all known values for SnapshotBlockPublicAccessState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotBlockPublicAccessState) Values() []SnapshotBlockPublicAccessState { return []SnapshotBlockPublicAccessState{ "block-all-sharing", @@ -7096,8 +7348,9 @@ const ( ) // Values returns all known values for SnapshotState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotState) Values() []SnapshotState { return []SnapshotState{ "pending", @@ -7120,8 +7373,9 @@ const ( ) // Values returns all known values for SpotAllocationStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpotAllocationStrategy) Values() []SpotAllocationStrategy { return []SpotAllocationStrategy{ "lowest-price", @@ -7143,8 +7397,9 @@ const ( // Values returns all known values for SpotInstanceInterruptionBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpotInstanceInterruptionBehavior) Values() []SpotInstanceInterruptionBehavior { return []SpotInstanceInterruptionBehavior{ "hibernate", @@ -7166,8 +7421,9 @@ const ( ) // Values returns all known values for SpotInstanceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpotInstanceState) Values() []SpotInstanceState { return []SpotInstanceState{ "open", @@ -7188,8 +7444,9 @@ const ( ) // Values returns all known values for SpotInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpotInstanceType) Values() []SpotInstanceType { return []SpotInstanceType{ "one-time", @@ -7206,8 +7463,9 @@ const ( ) // Values returns all known values for SpreadLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpreadLevel) Values() []SpreadLevel { return []SpreadLevel{ "host", @@ -7225,8 +7483,9 @@ const ( ) // Values returns all known values for SSEType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SSEType) Values() []SSEType { return []SSEType{ "sse-ebs", @@ -7250,8 +7509,9 @@ const ( ) // 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. +// the future, and so 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{ "PendingAcceptance", @@ -7275,6 +7535,7 @@ const ( // Values returns all known values for StaticSourcesSupportValue. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StaticSourcesSupportValue) Values() []StaticSourcesSupportValue { return []StaticSourcesSupportValue{ @@ -7291,8 +7552,9 @@ const ( ) // Values returns all known values for StatisticType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatisticType) Values() []StatisticType { return []StatisticType{ "p50", @@ -7309,8 +7571,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "MoveInProgress", @@ -7327,8 +7590,9 @@ const ( ) // Values returns all known values for StatusName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusName) Values() []StatusName { return []StatusName{ "reachability", @@ -7346,8 +7610,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "passed", @@ -7366,8 +7631,9 @@ const ( ) // Values returns all known values for StorageTier. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageTier) Values() []StorageTier { return []StorageTier{ "archive", @@ -7389,6 +7655,7 @@ const ( // 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{ @@ -7411,6 +7678,7 @@ const ( // Values returns all known values for SubnetCidrReservationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SubnetCidrReservationType) Values() []SubnetCidrReservationType { return []SubnetCidrReservationType{ @@ -7429,8 +7697,9 @@ const ( ) // Values returns all known values for SubnetState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubnetState) Values() []SubnetState { return []SubnetState{ "pending", @@ -7451,8 +7720,9 @@ const ( ) // Values returns all known values for SummaryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SummaryStatus) Values() []SummaryStatus { return []SummaryStatus{ "ok", @@ -7472,8 +7742,9 @@ const ( // Values returns all known values for SupportedAdditionalProcessorFeature. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SupportedAdditionalProcessorFeature) Values() []SupportedAdditionalProcessorFeature { return []SupportedAdditionalProcessorFeature{ "amd-sev-snp", @@ -7490,8 +7761,9 @@ const ( ) // Values returns all known values for TargetCapacityUnitType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetCapacityUnitType) Values() []TargetCapacityUnitType { return []TargetCapacityUnitType{ "vcpu", @@ -7508,8 +7780,9 @@ const ( ) // Values returns all known values for TargetStorageTier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetStorageTier) Values() []TargetStorageTier { return []TargetStorageTier{ "archive", @@ -7525,8 +7798,9 @@ const ( ) // Values returns all known values for TelemetryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TelemetryStatus) Values() []TelemetryStatus { return []TelemetryStatus{ "UP", @@ -7544,8 +7818,9 @@ const ( ) // Values returns all known values for Tenancy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tenancy) Values() []Tenancy { return []Tenancy{ "default", @@ -7570,8 +7845,9 @@ const ( ) // Values returns all known values for TieringOperationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TieringOperationStatus) Values() []TieringOperationStatus { return []TieringOperationStatus{ "archival-in-progress", @@ -7594,8 +7870,9 @@ const ( ) // Values returns all known values for TpmSupportValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TpmSupportValues) Values() []TpmSupportValues { return []TpmSupportValues{ "v2.0", @@ -7611,8 +7888,9 @@ const ( ) // Values returns all known values for TrafficDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficDirection) Values() []TrafficDirection { return []TrafficDirection{ "ingress", @@ -7632,8 +7910,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficMirrorFilterRuleField) Values() []TrafficMirrorFilterRuleField { return []TrafficMirrorFilterRuleField{ "destination-port-range", @@ -7652,6 +7931,7 @@ const ( // Values returns all known values for TrafficMirrorNetworkService. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TrafficMirrorNetworkService) Values() []TrafficMirrorNetworkService { return []TrafficMirrorNetworkService{ @@ -7668,8 +7948,9 @@ const ( ) // Values returns all known values for TrafficMirrorRuleAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficMirrorRuleAction) Values() []TrafficMirrorRuleAction { return []TrafficMirrorRuleAction{ "accept", @@ -7688,6 +7969,7 @@ const ( // Values returns all known values for TrafficMirrorSessionField. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TrafficMirrorSessionField) Values() []TrafficMirrorSessionField { return []TrafficMirrorSessionField{ @@ -7707,8 +7989,9 @@ const ( ) // Values returns all known values for TrafficMirrorTargetType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficMirrorTargetType) Values() []TrafficMirrorTargetType { return []TrafficMirrorTargetType{ "network-interface", @@ -7727,8 +8010,9 @@ const ( ) // Values returns all known values for TrafficType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficType) Values() []TrafficType { return []TrafficType{ "ACCEPT", @@ -7749,8 +8033,9 @@ const ( // Values returns all known values for TransitGatewayAssociationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayAssociationState) Values() []TransitGatewayAssociationState { return []TransitGatewayAssociationState{ "associating", @@ -7774,8 +8059,9 @@ const ( // Values returns all known values for TransitGatewayAttachmentResourceType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayAttachmentResourceType) Values() []TransitGatewayAttachmentResourceType { return []TransitGatewayAttachmentResourceType{ "vpc", @@ -7808,8 +8094,9 @@ const ( // Values returns all known values for TransitGatewayAttachmentState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayAttachmentState) Values() []TransitGatewayAttachmentState { return []TransitGatewayAttachmentState{ "initiating", @@ -7840,8 +8127,9 @@ const ( // Values returns all known values for TransitGatewayConnectPeerState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayConnectPeerState) Values() []TransitGatewayConnectPeerState { return []TransitGatewayConnectPeerState{ "pending", @@ -7866,8 +8154,9 @@ const ( // Values returns all known values for // TransitGatewayMulitcastDomainAssociationState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayMulitcastDomainAssociationState) Values() []TransitGatewayMulitcastDomainAssociationState { return []TransitGatewayMulitcastDomainAssociationState{ "pendingAcceptance", @@ -7892,8 +8181,9 @@ const ( // Values returns all known values for TransitGatewayMulticastDomainState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayMulticastDomainState) Values() []TransitGatewayMulticastDomainState { return []TransitGatewayMulticastDomainState{ "pending", @@ -7915,8 +8205,9 @@ const ( // Values returns all known values for TransitGatewayPolicyTableState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayPolicyTableState) Values() []TransitGatewayPolicyTableState { return []TransitGatewayPolicyTableState{ "pending", @@ -7938,8 +8229,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayPrefixListReferenceState) Values() []TransitGatewayPrefixListReferenceState { return []TransitGatewayPrefixListReferenceState{ "pending", @@ -7961,8 +8253,9 @@ const ( // Values returns all known values for TransitGatewayPropagationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayPropagationState) Values() []TransitGatewayPropagationState { return []TransitGatewayPropagationState{ "enabling", @@ -7985,6 +8278,7 @@ const ( // 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{ @@ -8006,8 +8300,9 @@ const ( // Values returns all known values for // TransitGatewayRouteTableAnnouncementDirection. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayRouteTableAnnouncementDirection) Values() []TransitGatewayRouteTableAnnouncementDirection { return []TransitGatewayRouteTableAnnouncementDirection{ "outgoing", @@ -8029,8 +8324,9 @@ const ( // Values returns all known values for TransitGatewayRouteTableAnnouncementState. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayRouteTableAnnouncementState) Values() []TransitGatewayRouteTableAnnouncementState { return []TransitGatewayRouteTableAnnouncementState{ "available", @@ -8054,8 +8350,9 @@ const ( // Values returns all known values for TransitGatewayRouteTableState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayRouteTableState) Values() []TransitGatewayRouteTableState { return []TransitGatewayRouteTableState{ "pending", @@ -8074,8 +8371,9 @@ const ( ) // Values returns all known values for TransitGatewayRouteType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayRouteType) Values() []TransitGatewayRouteType { return []TransitGatewayRouteType{ "static", @@ -8095,8 +8393,9 @@ const ( ) // Values returns all known values for TransitGatewayState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayState) Values() []TransitGatewayState { return []TransitGatewayState{ "pending", @@ -8116,8 +8415,9 @@ const ( ) // Values returns all known values for TransportProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransportProtocol) Values() []TransportProtocol { return []TransportProtocol{ "tcp", @@ -8134,8 +8434,9 @@ const ( ) // Values returns all known values for TrustProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustProviderType) Values() []TrustProviderType { return []TrustProviderType{ "user", @@ -8152,8 +8453,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ipv4", @@ -8173,8 +8475,9 @@ const ( // Values returns all known values for UnlimitedSupportedInstanceFamily. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnlimitedSupportedInstanceFamily) Values() []UnlimitedSupportedInstanceFamily { return []UnlimitedSupportedInstanceFamily{ "t2", @@ -8196,8 +8499,9 @@ const ( // Values returns all known values for // UnsuccessfulInstanceCreditSpecificationErrorCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnsuccessfulInstanceCreditSpecificationErrorCode) Values() []UnsuccessfulInstanceCreditSpecificationErrorCode { return []UnsuccessfulInstanceCreditSpecificationErrorCode{ "InvalidInstanceID.Malformed", @@ -8217,8 +8521,9 @@ const ( ) // Values returns all known values for UsageClassType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageClassType) Values() []UsageClassType { return []UsageClassType{ "spot", @@ -8236,8 +8541,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "iam-identity-center", @@ -8254,8 +8560,9 @@ const ( // Values returns all known values for VerifiedAccessEndpointAttachmentType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifiedAccessEndpointAttachmentType) Values() []VerifiedAccessEndpointAttachmentType { return []VerifiedAccessEndpointAttachmentType{ "vpc", @@ -8272,8 +8579,9 @@ const ( // Values returns all known values for VerifiedAccessEndpointProtocol. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifiedAccessEndpointProtocol) Values() []VerifiedAccessEndpointProtocol { return []VerifiedAccessEndpointProtocol{ "http", @@ -8294,8 +8602,9 @@ const ( // Values returns all known values for VerifiedAccessEndpointStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifiedAccessEndpointStatusCode) Values() []VerifiedAccessEndpointStatusCode { return []VerifiedAccessEndpointStatusCode{ "pending", @@ -8316,6 +8625,7 @@ const ( // Values returns all known values for VerifiedAccessEndpointType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VerifiedAccessEndpointType) Values() []VerifiedAccessEndpointType { return []VerifiedAccessEndpointType{ @@ -8334,8 +8644,9 @@ const ( // Values returns all known values for VerifiedAccessLogDeliveryStatusCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifiedAccessLogDeliveryStatusCode) Values() []VerifiedAccessLogDeliveryStatusCode { return []VerifiedAccessLogDeliveryStatusCode{ "success", @@ -8352,8 +8663,9 @@ const ( ) // Values returns all known values for VirtualizationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualizationType) Values() []VirtualizationType { return []VirtualizationType{ "hvm", @@ -8373,8 +8685,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "attaching", @@ -8394,8 +8707,9 @@ const ( ) // Values returns all known values for VolumeAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeAttributeName) Values() []VolumeAttributeName { return []VolumeAttributeName{ "autoEnableIO", @@ -8414,8 +8728,9 @@ const ( ) // Values returns all known values for VolumeModificationState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeModificationState) Values() []VolumeModificationState { return []VolumeModificationState{ "modifying", @@ -8438,8 +8753,9 @@ const ( ) // Values returns all known values for VolumeState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeState) Values() []VolumeState { return []VolumeState{ "creating", @@ -8461,8 +8777,9 @@ const ( ) // Values returns all known values for VolumeStatusInfoStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeStatusInfoStatus) Values() []VolumeStatusInfoStatus { return []VolumeStatusInfoStatus{ "ok", @@ -8480,8 +8797,9 @@ const ( ) // Values returns all known values for VolumeStatusName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeStatusName) Values() []VolumeStatusName { return []VolumeStatusName{ "io-enabled", @@ -8503,8 +8821,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "standard", @@ -8527,8 +8846,9 @@ const ( ) // Values returns all known values for VpcAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcAttributeName) Values() []VpcAttributeName { return []VpcAttributeName{ "enableDnsSupport", @@ -8550,8 +8870,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "associating", @@ -8573,8 +8894,9 @@ const ( ) // Values returns all known values for VpcEndpointType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointType) Values() []VpcEndpointType { return []VpcEndpointType{ "Interface", @@ -8600,8 +8922,9 @@ const ( // Values returns all known values for VpcPeeringConnectionStateReasonCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcPeeringConnectionStateReasonCode) Values() []VpcPeeringConnectionStateReasonCode { return []VpcPeeringConnectionStateReasonCode{ "initiating-request", @@ -8625,8 +8948,9 @@ const ( ) // Values returns all known values for VpcState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcState) Values() []VpcState { return []VpcState{ "pending", @@ -8642,8 +8966,9 @@ const ( ) // Values returns all known values for VpcTenancy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcTenancy) Values() []VpcTenancy { return []VpcTenancy{ "default", @@ -8659,8 +8984,9 @@ const ( ) // Values returns all known values for VpnEcmpSupportValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpnEcmpSupportValue) Values() []VpnEcmpSupportValue { return []VpnEcmpSupportValue{ "enable", @@ -8676,8 +9002,9 @@ const ( ) // Values returns all known values for VpnProtocol. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpnProtocol) Values() []VpnProtocol { return []VpnProtocol{ "openvpn", @@ -8695,8 +9022,9 @@ const ( ) // Values returns all known values for VpnState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpnState) Values() []VpnState { return []VpnState{ "pending", @@ -8714,8 +9042,9 @@ const ( ) // Values returns all known values for VpnStaticRouteSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpnStaticRouteSource) Values() []VpnStaticRouteSource { return []VpnStaticRouteSource{ "Static", @@ -8736,8 +9065,9 @@ const ( ) // Values returns all known values for WeekDay. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WeekDay) Values() []WeekDay { return []WeekDay{ "sunday", diff --git a/service/ec2/types/types.go b/service/ec2/types/types.go index 99b9978ec32..b3ea2a3f00a 100644 --- a/service/ec2/types/types.go +++ b/service/ec2/types/types.go @@ -176,9 +176,12 @@ type AddedPrincipal struct { // Add an operating Region to an IPAM. Operating Regions are Amazon Web Services // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only // discovers and monitors resources in the Amazon Web Services Regions you select -// as operating Regions. For more information about operating Regions, see Create -// an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the -// Amazon VPC IPAM User Guide. +// as operating Regions. +// +// For more information about operating Regions, see [Create an IPAM] in the Amazon VPC IPAM User +// Guide. +// +// [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html type AddIpamOperatingRegion struct { // The name of the operating Region. @@ -187,9 +190,9 @@ type AddIpamOperatingRegion struct { noSmithyDocumentSerde } -// 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) -// . +// Describes an additional detail for a path analysis. For more information, see [Reachability Analyzer additional detail codes]. +// +// [Reachability Analyzer additional detail codes]: https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.html type AdditionalDetail struct { // The additional detail code. @@ -227,7 +230,9 @@ type AddPrefixListEntry struct { // This member is required. Cidr *string - // A description for the entry. Constraints: Up to 255 characters in length. + // A description for the entry. + // + // Constraints: Up to 255 characters in length. Description *string noSmithyDocumentSerde @@ -302,9 +307,10 @@ type AddressAttribute struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Virtual Private Cloud User Guide. +// Details on the Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses] in the +// Amazon Virtual Private Cloud User Guide. +// +// [Transfer Elastic IP addresses]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro type AddressTransfer struct { // The Elastic IP address transfer status. @@ -490,14 +496,19 @@ 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. Origin *string // The state. The following are the possible values: + // // - active + // // - blackhole State *string @@ -517,7 +528,9 @@ type AnalysisSecurityGroupRule struct { Cidr *string // The direction. The following are the possible values: + // // - egress + // // - ingress Direction *string @@ -556,9 +569,10 @@ type AsnAssociation struct { // Provides authorization for Amazon to bring an Autonomous System Number (ASN) to // a specific Amazon Web Services account using bring your own ASN (BYOASN). For -// details on the format of the message and signature, see Tutorial: Bring your -// ASN to IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) -// in the Amazon VPC IPAM guide. +// details on the format of the message and signature, see [Tutorial: Bring your ASN to IPAM]in the Amazon VPC IPAM +// guide. +// +// [Tutorial: Bring your ASN to IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html type AsnAuthorizationContext struct { // The authorization context's message. @@ -655,11 +669,13 @@ type AthenaIntegration struct { // 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. +// 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 AttachmentEnaSrdSpecification struct { // Indicates whether ENA Express is enabled for the network interface. @@ -734,8 +750,10 @@ type AuthorizationRule struct { // Describes Availability Zones, Local Zones, and Wavelength Zones. type AvailabilityZone struct { - // For Availability Zones, this parameter has the same value as the Region name. + // 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 Wavelength Zones, the name of the associated group, for example // us-east-1-wl1-bos-wlz-1 . GroupName *string @@ -747,8 +765,10 @@ 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 @@ -805,8 +825,9 @@ 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]in the Amazon EC2 User Guide. +// +// [Amazon EBS–optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html type BaselineEbsBandwidthMbps struct { // The maximum baseline bandwidth, in Mbps. If this parameter is not specified, @@ -821,8 +842,9 @@ 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]in the Amazon EC2 User Guide. +// +// [Amazon EBS–optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html type BaselineEbsBandwidthMbpsRequest struct { // The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this @@ -862,12 +884,14 @@ type BlockDeviceMapping struct { // 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. + // 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 @@ -903,7 +927,7 @@ type BundleTask struct { noSmithyDocumentSerde } -// Describes an error for BundleInstance . +// Describes an error for BundleInstance. type BundleTaskError struct { // The error code. @@ -946,17 +970,24 @@ type ByoipCidr struct { // The description of the address range. Description *string - // If you have Local Zones (https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html) - // enabled, you can choose a network border group for Local Zones when you - // provision and advertise a BYOIPv4 CIDR. Choose the network border group + // If you have [Local Zones] enabled, you can choose a network border group for Local Zones + // when you provision and advertise a BYOIPv4 CIDR. Choose the network border group // carefully as the EIP and the Amazon Web Services resource it is associated with - // must reside in the same network border group. You can provision BYOIP address - // ranges to and advertise them in the following Local Zone network border groups: + // must reside in the same network border group. + // + // You can provision BYOIP address ranges to and advertise them in the following + // Local Zone network border groups: + // // - us-east-1-dfw-2 + // // - us-west-2-lax-1 + // // - us-west-2-phx-2 + // // You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this // time. + // + // [Local Zones]: https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html NetworkBorderGroup *string // The state of the address pool. @@ -1127,21 +1158,25 @@ type CapacityReservation struct { // 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. + // Deprecated. EphemeralStorage *bool // 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 @@ -1163,9 +1198,10 @@ 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]in the Amazon EC2 + // User Guide. + // + // [Capacity Reservations for cluster placement groups]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html PlacementGroupArn *string // The type of Capacity Reservation. @@ -1176,15 +1212,20 @@ 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. @@ -1195,8 +1236,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. Tenancy CapacityReservationTenancy @@ -1213,8 +1256,9 @@ 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) - // in the Amazon EC2 User Guide. + // see [Allocation strategy]in the Amazon EC2 User Guide. + // + // [Allocation strategy]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy AllocationStrategy *string // The ARN of the Capacity Reservation Fleet. @@ -1231,39 +1275,50 @@ type CapacityReservationFleet struct { // Indicates the type of instance launches that the Capacity Reservation Fleet // accepts. All Capacity Reservations in the Fleet inherit this instance matching - // criteria. Currently, Capacity Reservation Fleets support open instance matching - // criteria only. This means that instances that have matching attributes (instance - // type, platform, and Availability Zone) run in the Capacity Reservations - // automatically. Instances do not need to explicitly target a Capacity Reservation - // Fleet to use its reserved capacity. + // criteria. + // + // Currently, Capacity Reservation Fleets support open instance matching criteria + // only. This means that instances that have matching attributes (instance type, + // platform, and Availability Zone) run in the Capacity Reservations automatically. + // Instances do not need to explicitly target a Capacity Reservation Fleet to use + // its reserved capacity. InstanceMatchCriteria FleetInstanceMatchCriteria // Information about the instance types for which to reserve the capacity. 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. State CapacityReservationFleetState @@ -1272,8 +1327,10 @@ type CapacityReservationFleet struct { 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. Tenancy FleetCapacityReservationTenancy @@ -1282,8 +1339,9 @@ type CapacityReservationFleet struct { 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) - // in the Amazon EC2 User Guide. + // reserves capacity. For more information, see [Total target capacity]in the Amazon EC2 User Guide. + // + // [Total target capacity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity TotalTargetCapacity *int32 noSmithyDocumentSerde @@ -1317,48 +1375,62 @@ 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) -// 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. +// 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] in the Amazon EC2 User +// Guide. For examples of using Capacity Reservations in an EC2 Fleet, see [EC2 Fleet example configurations]in the +// Amazon EC2 User Guide. +// +// [EC2 Fleet example configurations]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html +// [On-Demand Capacity Reservations]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html 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 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 - // 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 - // specify a value, the fleet fulfils the On-Demand capacity according to the - // chosen On-Demand allocation strategy. + // 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 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 specify a value, the fleet fulfils the On-Demand capacity + // according to the chosen On-Demand allocation strategy. UsageStrategy FleetCapacityReservationUsageStrategy noSmithyDocumentSerde } // 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) -// 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. +// 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] in the Amazon EC2 User +// Guide. For examples of using Capacity Reservations in an EC2 Fleet, see [EC2 Fleet example configurations]in the +// Amazon EC2 User Guide. +// +// [EC2 Fleet example configurations]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html +// [On-Demand Capacity Reservations]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html 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 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 - // 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 - // specify a value, the fleet fulfils the On-Demand capacity according to the - // chosen On-Demand allocation strategy. + // 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 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 specify a value, the fleet fulfils the On-Demand capacity + // according to the chosen On-Demand allocation strategy. UsageStrategy FleetCapacityReservationUsageStrategy noSmithyDocumentSerde @@ -1366,18 +1438,21 @@ 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 -// 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 +// 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 // CapacityReservationTarget parameter to explicitly target a specific Capacity // Reservation or a Capacity Reservation group. 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. CapacityReservationPreference CapacityReservationPreference @@ -1399,8 +1474,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. CapacityReservationPreference CapacityReservationPreference @@ -1479,8 +1556,9 @@ 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) -// in the Amazon Elastic Compute Cloud User Guide. +// For more information, see [Configuring your BYOIP address range]in the Amazon Elastic Compute Cloud User Guide. +// +// [Configuring your BYOIP address range]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#prepare-for-byoip type CidrAuthorizationContext struct { // The plain-text authorization message for the prefix and account. @@ -1505,7 +1583,9 @@ type CidrBlock struct { noSmithyDocumentSerde } -// Deprecated. Describes the ClassicLink DNS support status of a VPC. +// Deprecated. +// +// Describes the ClassicLink DNS support status of a VPC. type ClassicLinkDnsSupport struct { // Indicates whether ClassicLink DNS support is enabled for the VPC. @@ -1517,7 +1597,9 @@ type ClassicLinkDnsSupport struct { noSmithyDocumentSerde } -// Deprecated. Describes a linked EC2-Classic instance. +// Deprecated. +// +// Describes a linked EC2-Classic instance. type ClassicLinkInstance struct { // The security groups. @@ -1625,8 +1707,11 @@ type ClientLoginBannerOptions struct { BannerText *string // Enable or disable a customizable text banner that will be displayed on Amazon - // Web Services provided clients when a VPN session is established. Valid values: - // true | false Default value: false + // Web Services provided clients when a VPN session is established. + // + // Valid values: true | false + // + // Default value: false Enabled *bool noSmithyDocumentSerde @@ -1641,15 +1726,18 @@ type ClientLoginBannerResponseOptions struct { // only. Maximum of 1400 characters. BannerText *string - // Current state of text banner feature. Valid values: true | false + // Current state of text banner feature. + // + // Valid values: true | false Enabled *bool noSmithyDocumentSerde } // 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) -// in the Client VPN Administrator Guide. +// information, see [Authentication]in the Client VPN Administrator Guide. +// +// [Authentication]: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html type ClientVpnAuthentication struct { // Information about the Active Directory, if applicable. @@ -1668,8 +1756,9 @@ 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) -// in the Client VPN Administrator Guide. +// more information, see [Authentication]in the Client VPN Administrator Guide. +// +// [Authentication]: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication type ClientVpnAuthenticationRequest struct { // Information about the Active Directory to be used, if applicable. You must @@ -1821,14 +1910,19 @@ type ClientVpnEndpoint struct { // The ARN of the server certificate. ServerCertificateArn *string - // The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 + // The maximum VPN session duration time in hours. + // + // Valid values: 8 | 10 | 12 | 24 + // // Default value: 24 SessionTimeoutHours *int32 - // 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) - // in the Client VPN Administrator Guide. + // Indicates whether split-tunnel is enabled in the Client VPN endpoint. + // + // For information about split-tunnel VPN endpoints, see [Split-Tunnel Client VPN endpoint] in the Client VPN + // Administrator Guide. + // + // [Split-Tunnel Client VPN endpoint]: https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html SplitTunnel *bool // The current state of the Client VPN endpoint. @@ -1868,13 +1962,17 @@ 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. Code ClientVpnEndpointStatusCode @@ -1930,14 +2028,17 @@ 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 @@ -1946,14 +2047,17 @@ 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 - // values: True | False + // 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 @@ -1980,13 +2084,13 @@ type CoipAddressUsage struct { // Information about a customer-owned IP address range. type CoipCidr struct { - // An address range in a customer-owned IP address space. + // An address range in a customer-owned IP address space. Cidr *string - // The ID of the address pool. + // The ID of the address pool. CoipPoolId *string - // The ID of the local gateway route table. + // The ID of the local gateway route table. LocalGatewayRouteTableId *string noSmithyDocumentSerde @@ -2079,8 +2183,9 @@ type ConnectionNotification struct { // A security group connection tracking configuration that enables you to set the // idle timeout for connection tracking on an Elastic network interface. For more -// information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) -// in the Amazon Elastic Compute Cloud User Guide. +// information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. +// +// [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts type ConnectionTrackingConfiguration struct { // Timeout (in seconds) for idle TCP connections in an established state. Min: 60 @@ -2103,8 +2208,9 @@ type ConnectionTrackingConfiguration struct { // A security group connection tracking specification that enables you to set the // idle timeout for connection tracking on an Elastic network interface. For more -// information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) -// in the Amazon Elastic Compute Cloud User Guide. +// information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. +// +// [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts type ConnectionTrackingSpecification struct { // Timeout (in seconds) for idle TCP connections in an established state. Min: 60 @@ -2127,8 +2233,9 @@ type ConnectionTrackingSpecification struct { // A security group connection tracking specification request that enables you to // set the idle timeout for connection tracking on an Elastic network interface. -// For more information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) -// in the Amazon Elastic Compute Cloud User Guide. +// For more information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. +// +// [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts type ConnectionTrackingSpecificationRequest struct { // Timeout (in seconds) for idle TCP connections in an established state. Min: 60 @@ -2151,8 +2258,9 @@ type ConnectionTrackingSpecificationRequest struct { // A security group connection tracking specification response that enables you to // set the idle timeout for connection tracking on an Elastic network interface. -// For more information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) -// in the Amazon Elastic Compute Cloud User Guide. +// For more information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. +// +// [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts type ConnectionTrackingSpecificationResponse struct { // Timeout (in seconds) for idle TCP connections in an established state. Min: 60 @@ -2207,8 +2315,9 @@ type ConversionTask struct { type CpuOptions struct { // Indicates whether the instance is enabled for AMD SEV-SNP. For more - // information, see AMD SEV-SNP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) - // . + // information, see [AMD SEV-SNP]. + // + // [AMD SEV-SNP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html AmdSevSnp AmdSevSnpSpecification // The number of CPU cores for the instance. @@ -2225,8 +2334,10 @@ type CpuOptions struct { type CpuOptionsRequest struct { // Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is - // supported with M6a, R6a, and C6a instance types only. For more information, see - // AMD SEV-SNP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) . + // supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP] + // . + // + // [AMD SEV-SNP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html AmdSevSnp AmdSevSnpSpecification // The number of CPU cores for the instance. @@ -2243,13 +2354,15 @@ 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) - // . + // information about error codes, see [Error codes]. + // + // [Error codes]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.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) - // . + // more information about error messages, see [Error codes]. + // + // [Error codes]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html ErrorMessage *string // The launch templates and overrides that were used for launching the instances. @@ -2341,16 +2454,19 @@ type CreateTransitGatewayVpcAttachmentRequestOptions struct { // Enable or disable IPv6 support. The default is disable . Ipv6Support Ipv6SupportValue - // This parameter is in preview and may not be available for your account. Enables - // you to reference a security group across VPCs attached to a transit gateway. Use - // this option to simplify security group management and control of + // This parameter is in preview and may not be available for your account. + // + // Enables you to reference a security group across VPCs attached to a transit + // gateway. Use this option to simplify security group management and control of // instance-to-instance traffic across VPCs that are connected by transit gateway. // You can also use this option to migrate from VPC peering (which was the only // option that supported security group referencing) to transit gateways (which now // also support security group referencing). This option is disabled by default and - // there are no additional costs to use this feature. If you don't enable or - // disable SecurityGroupReferencingSupport in the request, the attachment will - // inherit the security group referencing support setting on the transit gateway. + // there are no additional costs to use this feature. + // + // If you don't enable or disable SecurityGroupReferencingSupport in the request, + // the attachment will inherit the security group referencing support setting on + // the transit gateway. SecurityGroupReferencingSupport SecurityGroupReferencingSupportValue noSmithyDocumentSerde @@ -2395,8 +2511,8 @@ type CreateVerifiedAccessEndpointLoadBalancerOptions struct { // trust provider using the device type. type CreateVerifiedAccessTrustProviderDeviceOptions struct { - // The URL Amazon Web Services Verified Access will use to verify the authenticity - // of the device tokens. + // The URL Amazon Web Services Verified Access will use to verify the + // authenticity of the device tokens. PublicSigningKeyUrl *string // The ID of the tenant application with the device-identity provider. @@ -2463,8 +2579,9 @@ type CreateVolumePermissionModifications struct { // Describes the credit option for CPU usage of a T instance. type CreditSpecification struct { - // The credit option for CPU usage of a T instance. Valid values: standard | - // unlimited + // The credit option for CPU usage of a T instance. + // + // Valid values: standard | unlimited CpuCredits *string noSmithyDocumentSerde @@ -2473,8 +2590,9 @@ type CreditSpecification struct { // The credit option for CPU usage of a T instance. type CreditSpecificationRequest struct { - // The credit option for CPU usage of a T instance. Valid values: standard | - // unlimited + // The credit option for CPU usage of a T instance. + // + // Valid values: standard | unlimited // // This member is required. CpuCredits *string @@ -2751,8 +2869,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 . StateTransitionReason *string @@ -2764,13 +2884,15 @@ 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]. + // + // [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]. + // + // [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. @@ -2846,8 +2968,8 @@ type DestinationOptionsResponse struct { // device-identity based trust provider. type DeviceOptions struct { - // The URL Amazon Web Services Verified Access will use to verify the authenticity - // of the device tokens. + // The URL Amazon Web Services Verified Access will use to verify the + // authenticity of the device tokens. PublicSigningKeyUrl *string // The ID of the tenant application with the device-identity provider. @@ -2978,8 +3100,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 . StateTransitionReason *string @@ -3013,10 +3137,13 @@ 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]topic in the Amazon Simple + // Storage Service Developer Guide. + // + // For information about the import manifest referenced by this API action, see [VM Import Manifest]. + // + // [Authenticating REST Requests]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + // [VM Import Manifest]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html ImportManifestUrl *string // The size of the disk image, in GiB. @@ -3041,10 +3168,13 @@ 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]topic in the Amazon Simple Storage Service + // Developer Guide. + // + // For information about the import manifest referenced by this API action, see [VM Import Manifest]. + // + // [Authenticating REST Requests]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + // [VM Import Manifest]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html // // This member is required. ImportManifestUrl *string @@ -3137,88 +3267,121 @@ 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) - // in the Amazon EC2 User Guide. + // information, see [Preserving Amazon EBS volumes on instance termination]in the Amazon EC2 User Guide. + // + // [Preserving Amazon EBS volumes on instance termination]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination DeleteOnTermination *bool // Indicates whether the encryption state of an EBS volume is changed while being // 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/ebs/latest/userguide/ebs-encryption.html#encryption-parameters) - // in the Amazon EBS 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/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_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. + // information, see [Amazon EBS encryption]in the Amazon EBS 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]. + // + // 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. + // + // [Amazon EBS encryption]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters + // [Supported instance types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_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: + // 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 - 256,000 IOPS - // For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the - // Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) - // . On other instances, you can achieve performance up to 32,000 IOPS. This - // parameter is required for io1 and io2 volumes. The default for gp3 volumes is - // 3,000 IOPS. + // + // For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances, + // you can achieve performance up to 32,000 IOPS. + // + // This parameter is required for io1 and io2 volumes. The default for gp3 volumes + // is 3,000 IOPS. + // + // [instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances 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) - // . + // under which the EBS volume is encrypted. + // + // This parameter is only supported on BlockDeviceMapping objects called by [RunInstances], [RequestSpotFleet], + // and [RequestSpotInstances]. + // + // [RequestSpotInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html + // [RequestSpotFleet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html KmsKeyId *string - // The ARN of the Outpost on which the snapshot is stored. This parameter is not - // supported when using CreateImage (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html) - // . + // The ARN of the Outpost on which the snapshot is stored. + // + // This parameter is not supported when using [CreateImage]. + // + // [CreateImage]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html OutpostArn *string // The ID of the snapshot. SnapshotId *string - // The throughput that the volume supports, in MiB/s. This parameter is valid only - // for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 1000. + // The throughput that the volume supports, in MiB/s. + // + // This parameter is valid only for gp3 volumes. + // + // Valid Range: Minimum value of 125. Maximum value of 1000. Throughput *int32 // The size of the volume, in GiBs. You must specify either a snapshot ID or a // 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 sizes for each volume type: + // can specify a volume size that is equal to or larger than the snapshot size. + // + // The following are the supported sizes for each volume type: + // // - gp2 and gp3 : 1 - 16,384 GiB + // // - io1 : 4 - 16,384 GiB + // // - io2 : 4 - 65,536 GiB + // // - st1 and sc1 : 125 - 16,384 GiB + // // - standard : 1 - 1024 GiB VolumeSize *int32 - // The volume type. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) - // in the Amazon EBS User Guide. + // The volume type. For more information, see [Amazon EBS volume types] in the Amazon EBS User Guide. + // + // [Amazon EBS volume types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html VolumeType VolumeType noSmithyDocumentSerde @@ -3231,8 +3394,9 @@ 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]in Amazon EC2 User Guide. + // + // [Amazon EBS-optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html EbsOptimizedSupport EbsOptimizedSupport // Indicates whether Amazon EBS encryption is supported. @@ -3262,8 +3426,9 @@ type EbsInstanceBlockDevice struct { // The ID of the EBS volume. VolumeId *string - // The ID of the Amazon Web Services account that owns the volume. This parameter - // is returned only for volumes that are attached to Fargate tasks. + // The ID of the Amazon Web Services account that owns the volume. + // + // This parameter is returned only for volumes that are attached to Fargate tasks. VolumeOwnerId *string noSmithyDocumentSerde @@ -3339,9 +3504,12 @@ type Ec2InstanceConnectEndpoint struct { // Indicates whether your client's IP address is preserved as the source. The // value is true or false . + // // - If true , your client's IP address is used when you connect to a resource. + // // - If false , the elastic network interface IP address is used when you connect // to a resource. + // // Default: true PreserveClientIp *bool @@ -3395,8 +3563,10 @@ type EgressOnlyInternetGateway struct { // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, -// G4dn, or G5 instances. Describes the association between an instance and an -// Elastic Graphics accelerator. +// G4dn, or G5 instances. +// +// Describes the association between an instance and an Elastic Graphics +// accelerator. type ElasticGpuAssociation struct { // The ID of the association. @@ -3417,7 +3587,9 @@ type ElasticGpuAssociation struct { // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, -// G4dn, or G5 instances. Describes the status of an Elastic Graphics accelerator. +// G4dn, or G5 instances. +// +// Describes the status of an Elastic Graphics accelerator. type ElasticGpuHealth struct { // The health status. @@ -3428,7 +3600,9 @@ type ElasticGpuHealth struct { // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, -// G4dn, or G5 instances. Describes an Elastic Graphics accelerator. +// G4dn, or G5 instances. +// +// Describes an Elastic Graphics accelerator. type ElasticGpus struct { // The Availability Zone in the which the Elastic Graphics accelerator resides. @@ -3457,13 +3631,16 @@ type ElasticGpus struct { // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, -// G4dn, or G5 instances. A specification for an Elastic Graphics accelerator. +// G4dn, or G5 instances. +// +// A specification for an Elastic Graphics accelerator. 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 - // Compute Cloud User Guide for Windows Instances. + // to specify for Type , see [Elastic Graphics Basics], specifically the Elastic Graphics accelerator + // column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances. + // + // [Elastic Graphics Basics]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html#elastic-graphics-basics // // This member is required. Type *string @@ -3471,14 +3648,18 @@ type ElasticGpuSpecification struct { noSmithyDocumentSerde } -// Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For -// workloads that require graphics acceleration, we recommend that you use Amazon -// EC2 G4ad, G4dn, or G5 instances. +// Deprecated. +// +// Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads +// that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, +// G4dn, or G5 instances. type ElasticGpuSpecificationResponse struct { - // Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For - // workloads that require graphics acceleration, we recommend that you use Amazon - // EC2 G4ad, G4dn, or G5 instances. + // Deprecated. + // + // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads + // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, + // G4dn, or G5 instances. Type *string noSmithyDocumentSerde @@ -3487,33 +3668,35 @@ 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. + // The number of elastic inference accelerators to attach to the instance. + // // Default: 1 Count *int32 noSmithyDocumentSerde } -// Describes the association between an instance and an elastic inference +// Describes the association between an instance and an elastic inference +// // accelerator. type ElasticInferenceAcceleratorAssociation struct { - // The Amazon Resource Name (ARN) of the elastic inference accelerator. + // The Amazon Resource Name (ARN) of the elastic inference accelerator. ElasticInferenceAcceleratorArn *string - // The ID of the association. + // The ID of the association. ElasticInferenceAcceleratorAssociationId *string - // The state of the elastic inference accelerator. + // The state of the elastic inference accelerator. ElasticInferenceAcceleratorAssociationState *string - // The time at which the elastic inference accelerator is associated with an + // The time at which the elastic inference accelerator is associated with an // instance. ElasticInferenceAcceleratorAssociationTime *time.Time @@ -3594,8 +3777,10 @@ 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 . StateTransitionReason *string @@ -3608,11 +3793,13 @@ type EnableFastSnapshotRestoreSuccessItem struct { // 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. +// 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. @@ -3677,8 +3864,10 @@ 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?]in the Amazon Web Services Nitro Enclaves +// User Guide. +// +// [What is Amazon Web Services Nitro Enclaves?]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html type EnclaveOptionsRequest struct { // To enable the instance for Amazon Web Services Nitro Enclaves, set this @@ -3694,58 +3883,83 @@ type EventInformation struct { // The description of the event. EventDescription *string - // The event. error events: + // 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. + // // 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. + // // 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. + // // 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. EventSubType *string @@ -3758,8 +3972,9 @@ type EventInformation struct { } // 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) -// . +// see [Reachability Analyzer explanation codes]. +// +// [Reachability Analyzer explanation codes]: https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html type Explanation struct { // The network ACL. @@ -3805,7 +4020,9 @@ type Explanation struct { DestinationVpc *AnalysisComponent // The direction. The following are the possible values: + // // - egress + // // - ingress Direction *string @@ -4023,8 +4240,9 @@ 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) - // in the VM Import/Export User Guide. + // about the ACL to your S3 bucket, see [Prerequisites]in the VM Import/Export User Guide. + // + // [Prerequisites]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites S3Bucket *string // The encryption key for your S3 bucket. @@ -4046,8 +4264,9 @@ 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) - // in the VM Import/Export User Guide. + // about the ACL to your S3 bucket, see [Prerequisites]in the VM Import/Export User Guide. + // + // [Prerequisites]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites S3Bucket *string // The image is written to a single object in the Amazon S3 bucket at the S3 key @@ -4081,9 +4300,10 @@ type FailedQueuedPurchaseDeletion struct { noSmithyDocumentSerde } -// Request to create a launch template for a Windows fast launch enabled AMI. Note -// - You can specify either the LaunchTemplateName or the LaunchTemplateId , but -// not both. +// Request to create a launch template for a Windows fast launch enabled AMI. +// +// Note - You can specify either the LaunchTemplateName or the LaunchTemplateId , +// but not both. type FastLaunchLaunchTemplateSpecificationRequest struct { // Specify the version of the launch template that the AMI should use for Windows @@ -4168,9 +4388,10 @@ 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 -// only results that match all of the specified filters. +// 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 only results that match all of the specified filters. type Filter struct { // The name of the filter. Filter names are case-sensitive. @@ -4277,8 +4498,9 @@ 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) - // in the Amazon EC2 User Guide. + // information, see [Total target capacity]in the Amazon EC2 User Guide. + // + // [Total target capacity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity FulfilledCapacity *float64 // The type of operating system for which the Capacity Reservation reserves @@ -4289,8 +4511,9 @@ 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) - // in the Amazon EC2 User Guide. + // information, see [Instance type priority]in the Amazon EC2 User Guide. + // + // [Instance type priority]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority Priority *int32 // The total number of instances for which the Capacity Reservation reserves @@ -4298,8 +4521,9 @@ 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) - // in the Amazon EC2 User Guide. + // information, see [Instance type weight]in the Amazon EC2 User Guide. + // + // [Instance type weight]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-weight Weight *float64 noSmithyDocumentSerde @@ -4316,8 +4540,11 @@ type FleetData struct { 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]. + // + // Constraints: Maximum 64 ASCII characters + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // Reserved. @@ -4331,8 +4558,9 @@ type FleetData struct { 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 . + // of the EC2 Fleet is decreased below the current size of the EC2 Fleet. + // + // Supported only for fleets of type maintain . ExcessCapacityTerminationPolicy FleetExcessCapacityTerminationPolicy // The ID of the EC2 Fleet. @@ -4360,9 +4588,10 @@ 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) - // in the Amazon EC2 User Guide. + // only for fleets of type maintain . For more information, see [EC2 Fleet health checks] in the Amazon EC2 + // User Guide. + // + // [EC2 Fleet health checks]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks ReplaceUnhealthyInstances *bool // The configuration of Spot Instances in an EC2 Fleet. @@ -4426,8 +4655,10 @@ 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 - // allowed across all launch templates. + // template. + // + // For fleets of type request and maintain , a maximum of 300 items is allowed + // across all launch templates. Overrides []FleetLaunchTemplateOverridesRequest noSmithyDocumentSerde @@ -4445,45 +4676,56 @@ type FleetLaunchTemplateOverrides struct { ImageId *string // 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 . + // Amazon EC2 will identify instance types with those attributes. + // + // If you specify InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirements - // The instance type. mac1.metal is not supported as a launch template override. + // 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. + // 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 - // 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 override - // has the lowest priority. You can set the same priority for different launch - // template overrides. + // 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 . 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. Priority *float64 // The ID of the subnet in which to launch the instances. SubnetId *string - // The number of units provided by the specified instance type. When specifying - // weights, the price used in the lowest-price and price-capacity-optimized - // allocation strategies is per unit hour (where the instance price is divided by - // the specified weight). However, if all the specified weights are above the - // requested TargetCapacity , resulting in only 1 instance being launched, the - // price used is per instance hour. + // The number of units provided by the specified instance type. + // + // When specifying weights, the price used in the lowest-price and + // price-capacity-optimized allocation strategies is per unit hour (where the + // instance price is divided by the specified weight). However, if all the + // specified weights are above the requested TargetCapacity , resulting in only 1 + // instance being launched, the price used is per instance hour. WeightedCapacity *float64 noSmithyDocumentSerde @@ -4501,34 +4743,44 @@ type FleetLaunchTemplateOverridesRequest struct { ImageId *string // 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 . + // Amazon EC2 will identify instance types with those attributes. + // + // If you specify InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirementsRequest - // The instance type. mac1.metal is not supported as a launch template override. + // 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. + // 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 - // 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. + // 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 . 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 IDs of the subnets in which to launch the instances. Separate multiple @@ -4537,12 +4789,13 @@ type FleetLaunchTemplateOverridesRequest struct { // ID. SubnetId *string - // The number of units provided by the specified instance type. When specifying - // weights, the price used in the lowest-price and price-capacity-optimized - // allocation strategies is per unit hour (where the instance price is divided by - // the specified weight). However, if all the specified weights are above the - // requested TargetCapacity , resulting in only 1 instance being launched, the - // price used is per instance hour. + // The number of units provided by the specified instance type. + // + // When specifying weights, the price used in the lowest-price and + // price-capacity-optimized allocation strategies is per unit hour (where the + // instance price is divided by the specified weight). However, if all the + // specified weights are above the requested TargetCapacity , resulting in only 1 + // instance being launched, the price used is per instance hour. WeightedCapacity *float64 noSmithyDocumentSerde @@ -4550,47 +4803,63 @@ 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) -// in the Amazon EC2 User Guide. +// template in the request, but not both. +// +// For information about launch templates, see [Launch an instance from a launch template] in the Amazon EC2 User Guide. +// +// [Launch an instance from a launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html type FleetLaunchTemplateSpecification struct { - // The ID of the launch template. You must specify the LaunchTemplateId or the - // LaunchTemplateName , but not both. + // The ID of the launch template. + // + // You must specify the LaunchTemplateId or the LaunchTemplateName , but not both. LaunchTemplateId *string - // The name of the launch template. You must specify the LaunchTemplateName or the - // LaunchTemplateId , but not both. + // The name of the launch template. + // + // You must specify the LaunchTemplateName or the 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. - Version *string - + // 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 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) -// in the Amazon EC2 User Guide. +// template in the request, but not both. +// +// For information about launch templates, see [Launch an instance from a launch template] in the Amazon EC2 User Guide. +// +// [Launch an instance from a launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html type FleetLaunchTemplateSpecificationRequest struct { - // The ID of the launch template. You must specify the LaunchTemplateId or the - // LaunchTemplateName , but not both. + // The ID of the launch template. + // + // You must specify the LaunchTemplateId or the LaunchTemplateName , but not both. LaunchTemplateId *string - // The name of the launch template. You must specify the LaunchTemplateName or the - // LaunchTemplateId , but not both. + // The name of the launch template. + // + // You must specify the LaunchTemplateName or the 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. + // 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 @@ -4601,22 +4870,27 @@ type FleetLaunchTemplateSpecificationRequest struct { type FleetSpotCapacityRebalance struct { // 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 // terminate the old instances, or you can leave them running. You are charged for - // 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 - // rebalance notification. + // 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 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 - // seconds. Maximum value of 7200 seconds. + // 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 noSmithyDocumentSerde @@ -4624,27 +4898,33 @@ 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) -// in the Amazon EC2 User Guide. +// interrupted. For more information, see [Capacity rebalancing]in the Amazon EC2 User Guide. +// +// [Capacity rebalancing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html type FleetSpotCapacityRebalanceRequest struct { // 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 // terminate the old instances, or you can leave them running. You are charged for - // 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 - // rebalance notification. + // 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 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 - // seconds. Maximum value of 7200 seconds. + // 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 noSmithyDocumentSerde @@ -4718,10 +4998,14 @@ type FlowLog struct { LogGroupName *string // 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 + // captured and aggregated into a flow log record. + // + // When a network interface is attached to a [Nitro-based instance], the aggregation interval is always + // 60 seconds (1 minute) or less, regardless of the specified value. + // + // Valid Values: 60 | 600 + // + // [Nitro-based instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances MaxAggregationInterval *int32 // The ID of the resource being monitored. @@ -4845,9 +5129,13 @@ type FpgaImageAttribute struct { 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. Code FpgaImageStateCode @@ -4922,9 +5210,11 @@ type GroupIdentifier struct { } // 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/hibernating-prerequisites.html) -// . For more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) -// in the Amazon EC2 User Guide. +// is valid only if the instance meets the [hibernation prerequisites]. For more information, see [Hibernate your instance] in the +// Amazon EC2 User Guide. +// +// [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html +// [hibernation prerequisites]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html type HibernationOptions struct { // If true , your instance is enabled for hibernation; otherwise, it is not enabled @@ -4935,19 +5225,27 @@ type HibernationOptions struct { } // 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/hibernating-prerequisites.html) -// . For more information, see Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) -// in the Amazon EC2 User Guide. +// is valid only if the instance meets the [hibernation prerequisites]. For more information, see [Hibernate your instance] in the +// Amazon EC2 User Guide. +// +// [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html +// [hibernation prerequisites]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html type HibernationOptionsRequest struct { - // Set to true to enable your instance for hibernation. For Spot Instances, if you - // set Configured to true , either omit the InstanceInterruptionBehavior parameter - // (for SpotMarketOptions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html) - // ), or set it to hibernate . When Configured is true: + // Set to true to enable your instance for hibernation. + // + // For Spot Instances, if you set Configured to true , either omit the + // InstanceInterruptionBehavior parameter (for [SpotMarketOptions]SpotMarketOptions ), or set it to + // hibernate . When Configured is true: + // // - If you omit InstanceInterruptionBehavior , it defaults to hibernate . + // // - If you set InstanceInterruptionBehavior to a value other than hibernate , // you'll get an error. + // // Default: false + // + // [SpotMarketOptions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html Configured *bool noSmithyDocumentSerde @@ -4960,10 +5258,14 @@ 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. EventType EventType @@ -5018,8 +5320,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The ID of the Dedicated Host. @@ -5284,8 +5587,10 @@ 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] in the Amazon EC2 User + // Guide. + // + // [Boot modes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html BootMode BootModeValues // The date and time the image was created. @@ -5324,18 +5629,22 @@ type Image struct { // 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. + // information, see [Configure the AMI]in the Amazon EC2 User Guide. + // + // [Configure the AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration ImdsSupport ImdsSupportValues // The kernel associated with the image, if any. Only applicable for machine // images. KernelId *string - // 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. + // The date and time, in [ISO 8601 date-time format], 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. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 LastLaunchedTime *string // The name of the AMI that was provided during image creation. @@ -5348,8 +5657,9 @@ 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]in the Amazon EC2 User Guide. + // + // [Understand AMI billing information]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html PlatformDetails *string // Any product codes associated with the AMI. @@ -5372,8 +5682,9 @@ type Image struct { RootDeviceType DeviceType // The ID of the instance that the AMI was created from if the AMI was created - // using CreateImage (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html) - // . This field only appears if the AMI was created using CreateImage. + // using [CreateImage]. This field only appears if the AMI was created using CreateImage. + // + // [CreateImage]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html SourceInstanceId *string // Specifies whether enhanced networking with the Intel 82599 Virtual Function @@ -5391,18 +5702,22 @@ type Image struct { 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. + // information, see [NitroTPM]in the Amazon EC2 User Guide. + // + // [NitroTPM]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html 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) - // 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) + // associated with the AMI. usageOperation corresponds to the [lineitem/Operation] column on your + // Amazon Web Services Cost and Usage Report and in the [Amazon Web Services Price List API]. 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]command in the Amazon EC2 API, or the [describe-images] // command in the CLI. + // + // [describe-images]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html + // [lineitem/Operation]: https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation + // [DescribeImages]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html + // [Amazon Web Services Price List API]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html UsageOperation *string // The type of virtualization of the AMI. @@ -5420,8 +5735,9 @@ type ImageDiskContainer struct { // The block device mapping for the disk. DeviceName *string - // The format of the disk image being imported. Valid values: OVA | VHD | VHDX | - // VMDK | RAW + // The format of the disk image being imported. + // + // Valid values: OVA | VHD | VHDX | VMDK | RAW Format *string // The ID of the EBS snapshot to be used for importing the snapshot. @@ -5480,7 +5796,9 @@ type ImportImageLicenseConfigurationResponse struct { // Describes an import image task. type ImportImageTask struct { - // The architecture of the virtual machine. Valid values: i386 | x86_64 | arm64 + // The architecture of the virtual machine. + // + // Valid values: i386 | x86_64 | arm64 Architecture *string // The boot mode of the virtual machine. @@ -5492,7 +5810,9 @@ type ImportImageTask struct { // Indicates whether the image is encrypted. Encrypted *bool - // The target hypervisor for the import task. Valid values: xen + // The target hypervisor for the import task. + // + // Valid values: xen Hypervisor *string // The ID of the Amazon Machine Image (AMI) of the imported virtual machine. @@ -5555,8 +5875,9 @@ 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) - // in the VM Import/Export User Guide. + // import, see [Instance Types]in the VM Import/Export User Guide. + // + // [Instance Types]: https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-instance-types InstanceType InstanceType // Indicates whether monitoring is enabled. @@ -5717,9 +6038,13 @@ type Instance struct { // 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. + // specified boot mode. + // + // For more information, see [Boot modes] in the Amazon EC2 User Guide. + // + // [Boot modes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html BootMode BootModeValues // The ID of the Capacity Reservation. @@ -5736,8 +6061,9 @@ 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]in the Amazon EC2 User Guide. + // + // [Boot modes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html CurrentInstanceBootMode InstanceBootModeValues // Indicates whether the instance is optimized for Amazon EBS I/O. This @@ -5747,9 +6073,11 @@ type Instance struct { // EBS Optimized instance. EbsOptimized *bool - // Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For - // workloads that require graphics acceleration, we recommend that you use Amazon - // EC2 G4ad, G4dn, or G5 instances. + // Deprecated. + // + // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads + // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, + // G4dn, or G5 instances. ElasticGpuAssociations []ElasticGpuAssociation // The elastic inference accelerator associated with the instance. @@ -5822,18 +6150,20 @@ type Instance struct { // empty. 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) - // in the Amazon EC2 User Guide. + // The platform details value for the instance. For more information, see [AMI billing information fields] in the + // Amazon EC2 User Guide. + // + // [AMI billing information fields]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html PlatformDetails *string // [IPv4 only] The private DNS hostname name assigned to the instance. This DNS // hostname can only be used inside the Amazon EC2 network. This name is not - // available until the instance enters the running state. The Amazon-provided DNS - // server resolves Amazon-provided private DNS hostnames if you've enabled DNS - // resolution and DNS hostnames in your VPC. If you are not using the - // Amazon-provided DNS server in your VPC, your custom domain name servers must - // resolve the hostname as appropriate. + // available until the instance enters the running state. + // + // The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames + // if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not + // using the Amazon-provided DNS server in your VPC, your custom domain name + // servers must resolve the hostname as appropriate. PrivateDnsName *string // The options for the instance hostname. @@ -5851,8 +6181,10 @@ type Instance struct { PublicDnsName *string // The public IPv4 address, or the Carrier IP address assigned to the instance, if - // applicable. A Carrier IP address only applies to an instance launched in a - // subnet associated with a Wavelength Zone. + // applicable. + // + // A Carrier IP address only applies to an instance launched in a subnet + // associated with a Wavelength Zone. PublicIpAddress *string // The RAM disk associated with this instance, if applicable. @@ -5894,13 +6226,15 @@ type Instance struct { 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. + // information, see [NitroTPM]in the Amazon EC2 User Guide. + // + // [NitroTPM]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html 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) - // in the Amazon EC2 User Guide. + // The usage operation value for the instance. For more information, see [AMI billing information fields] in the + // Amazon EC2 User Guide. + // + // [AMI billing information fields]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html UsageOperation *string // The time that the usage operation was last updated. @@ -5920,11 +6254,13 @@ type Instance struct { // 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. +// 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 InstanceAttachmentEnaSrdSpecification struct { // Indicates whether ENA Express is enabled for the network interface. @@ -6016,8 +6352,9 @@ type InstanceCount struct { // Describes the credit option for CPU usage of a burstable performance instance. type InstanceCreditSpecification struct { - // The credit option for CPU usage of the instance. Valid values: standard | - // unlimited + // The credit option for CPU usage of the instance. + // + // Valid values: standard | unlimited CpuCredits *string // The ID of the instance. @@ -6034,9 +6371,11 @@ type InstanceCreditSpecificationRequest struct { // This member is required. 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. + // 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. CpuCredits *string noSmithyDocumentSerde @@ -6213,9 +6552,9 @@ type InstanceIpv6Address struct { // Determines if an IPv6 address associated with a network interface is the // primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, // the first IPv6 GUA will be made the primary IPv6 address until the instance is - // terminated or the network interface is detached. For more information, see - // RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // . + // terminated or the network interface is detached. For more information, see [RunInstances]. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html IsPrimaryIpv6 *bool noSmithyDocumentSerde @@ -6253,8 +6592,9 @@ type InstanceMaintenanceOptions struct { 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) - // . + // default. For more information, see [Simplified automatic recovery]. + // + // [Simplified automatic recovery]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery AutoRecovery InstanceAutoRecoveryState noSmithyDocumentSerde @@ -6284,16 +6624,18 @@ type InstanceMetadataDefaultsResponse struct { HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional – IMDSv2 is optional, which means that you can use either IMDSv2 or // IMDSv1. + // // - required – IMDSv2 is required, which means that IMDSv1 is disabled, and you // must use IMDSv2. 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) - // in the Amazon EC2 User Guide. + // or disabled. For more information, see [Work with instance tags using the instance metadata]in the Amazon EC2 User Guide. + // + // [Work with instance tags using the instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags InstanceMetadataTagsState noSmithyDocumentSerde @@ -6302,40 +6644,54 @@ type InstanceMetadataDefaultsResponse 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. + // // Default: disabled HttpProtocolIpv6 InstanceMetadataProtocolState - // The maximum number of hops that the metadata token can travel. Possible values: - // Integers from 1 to 64 + // The maximum number of hops that the metadata token can travel. + // + // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional - IMDSv2 is optional, which means that you can use either IMDSv2 or // IMDSv1. + // // - required - IMDSv2 is required, which means that IMDSv1 is disabled, and you // must use IMDSv2. + // // Default: + // // - If the value of ImdsSupport for the Amazon Machine Image (AMI) for your // instance is v2.0 and the account level default is set to no-preference , the // default is required . + // // - If the value of ImdsSupport for the Amazon Machine Image (AMI) for your // instance is v2.0 , but the account level default is set to V1 or V2 , the // default is optional . + // // The default value can also be affected by other combinations of parameters. For - // more information, see Order of precedence for instance metadata options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) - // in the Amazon EC2 User Guide. + // more information, see [Order of precedence for instance metadata options]in the Amazon EC2 User Guide. + // + // [Order of precedence for instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence 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]. + // + // Default: disabled + // + // [Work with instance tags using the instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags InstanceMetadataTagsState noSmithyDocumentSerde @@ -6345,34 +6701,43 @@ 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. Default: disabled + // enabled or disabled. + // + // Default: disabled HttpProtocolIpv6 InstanceMetadataProtocolState - // The maximum number of hops that the metadata token can travel. Possible values: - // Integers from 1 to 64 + // The maximum number of hops that the metadata token can travel. + // + // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional - IMDSv2 is optional, which means that you can use either IMDSv2 or // IMDSv1. + // // - required - IMDSv2 is required, which means that IMDSv1 is disabled, and you // must use IMDSv2. 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) - // . + // or disabled. For more information, see [Work with instance tags using the instance metadata]. + // + // [Work with instance tags using the 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 - // being updated and the instance is not ready to process metadata traffic with the - // new selection. applied - The metadata options have been successfully applied on - // the instance. + // The state of the metadata option changes. + // + // pending - The metadata options are being updated and the instance is not ready + // to process metadata traffic with the new selection. + // + // applied - The metadata options have been successfully applied on the instance. State InstanceMetadataOptionsState noSmithyDocumentSerde @@ -6402,8 +6767,9 @@ type InstanceNetworkInterface struct { // A security group connection tracking configuration that enables you to set the // timeout for connection tracking on an Elastic network interface. For more - // information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. + // + // [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts ConnectionTrackingConfiguration *ConnectionTrackingSpecificationResponse // The description. @@ -6412,7 +6778,9 @@ type InstanceNetworkInterface struct { // The security groups. Groups []GroupIdentifier - // The type of network interface. Valid values: interface | efa | trunk + // The type of network interface. + // + // Valid values: interface | efa | trunk InterfaceType *string // The IPv4 delegated prefixes that are assigned to the network interface. @@ -6510,28 +6878,33 @@ type InstanceNetworkInterfaceAttachment struct { // Describes a network interface. 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) - // in the Amazon Web Services Wavelength Developer Guide. + // 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]in the Amazon Web Services Wavelength Developer Guide. + // + // [Carrier IP address]: https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip 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 . Amazon Web Services charges - // for all public IPv4 addresses, including public IPv4 addresses associated with - // running instances and Elastic IP addresses. For more information, see the Public - // IPv4 Address tab on the Amazon VPC pricing page (http://aws.amazon.com/vpc/pricing/) - // . + // into a default subnet, the default value is true . + // + // Amazon Web Services charges for all public IPv4 addresses, including public + // IPv4 addresses associated with running instances and Elastic IP addresses. For + // more information, see the Public IPv4 Address tab on the [Amazon VPC pricing page]. + // + // [Amazon VPC pricing page]: http://aws.amazon.com/vpc/pricing/ AssociatePublicIpAddress *bool // A security group connection tracking specification that enables you to set the // timeout for connection tracking on an Elastic network interface. For more - // information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. + // + // [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts ConnectionTrackingSpecification *ConnectionTrackingSpecificationRequest // If set to true , the interface is deleted when the instance is terminated. You @@ -6544,8 +6917,10 @@ type InstanceNetworkInterfaceSpecification struct { 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. + // 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 // Specifies the ENA Express settings for the network interface that's attached to @@ -6556,7 +6931,9 @@ type InstanceNetworkInterfaceSpecification struct { // creating a network interface when launching an instance. Groups []string - // The type of network interface. Valid values: interface | efa + // The type of network interface. + // + // Valid values: interface | efa InterfaceType *string // The number of IPv4 delegated prefixes to be automatically assigned to the @@ -6590,42 +6967,50 @@ 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) - // 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) - // . + // The default is network card index 0. + // + // If you are using [RequestSpotInstances] 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]. + // + // [RequestSpotInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.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 - // parameter because you can’t specify a network interface ID in a launch - // specification. + // The ID of the network interface. + // + // If you are creating a Spot Fleet, omit this parameter because you can’t specify + // a network interface ID in a launch specification. NetworkInterfaceId *string // The primary IPv6 address of the network interface. When you enable an IPv6 GUA // address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 // address until the instance is terminated or the network interface is detached. - // For more information about primary IPv6 addresses, see RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // . + // For more information about primary IPv6 addresses, see [RunInstances]. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html PrimaryIpv6 *bool // 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) - // request. + // you're launching more than one instance in a [RunInstances]request. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html 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) - // request. + // you're launching more than one instance in a [RunInstances]request. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html 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) - // request. + // instance in a [RunInstances]request. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html SecondaryPrivateIpAddressCount *int32 // The ID of the subnet associated with the network interface. Applies only if @@ -6655,153 +7040,232 @@ type InstancePrivateIpAddress struct { } // The attributes for the instance types. When you specify instance attributes, -// Amazon EC2 will identify instance types with these attributes. You must specify -// VCpuCount and MemoryMiB . All other attributes are optional. Any unspecified -// optional attribute is set to its default. When you specify multiple attributes, -// you get instance types that satisfy all of the specified attributes. If you -// specify multiple values for an attribute, you get instance 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: +// Amazon EC2 will identify instance types with these attributes. +// +// You must specify VCpuCount and MemoryMiB . All other attributes are optional. +// Any unspecified optional attribute is set to its default. +// +// When you specify multiple attributes, you get instance types that satisfy all +// of the specified attributes. If you specify multiple values for an attribute, +// you get instance 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. // // If you specify InstanceRequirements , you can't specify InstanceType . +// // Attribute-based instance type selection is only supported when using Auto // Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to -// use the launch template in the launch instance wizard (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) -// or with the RunInstances API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) -// , you can't specify InstanceRequirements . For more information, see Create a -// mixed instances group using attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) -// in the Amazon EC2 Auto Scaling User Guide, and also 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. +// use the launch template in the [launch instance wizard]or with the [RunInstances API], you can't specify +// InstanceRequirements . +// +// For more information, see [Create a mixed instances group using attribute-based instance type selection] in the Amazon EC2 Auto Scaling User Guide, and also [Attribute-based instance type selection for EC2 Fleet] +// , [Attribute-based instance type selection for Spot Fleet], and [Spot placement score] in the Amazon EC2 User Guide. +// +// [Attribute-based instance type selection for EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html +// [RunInstances API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html +// [Spot placement score]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html +// [Create a mixed instances group using attribute-based instance type selection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-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 +// [launch instance wizard]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html 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 + // Services Inferentia chips) on an instance. + // + // To exclude accelerator-enabled 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 Amazon Web Services devices, specify // amazon-web-services . + // // - For instance types with AMD devices, specify amd . + // // - For instance types with Habana devices, specify habana . + // // - For instance types with NVIDIA devices, specify nvidia . + // // - 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 A10G GPUs, specify a10g . + // // - For instance types with NVIDIA A100 GPUs, specify a100 . + // // - For instance types with NVIDIA H100 GPUs, specify h100 . + // // - 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 K80 GPUs, specify k80 . + // // - 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 NVIDIA T4 GPUs, specify t4 . + // // - For instance types with NVIDIA T4G GPUs, specify t4g . + // // - For instance types with Xilinx VU9P FPGAs, specify vu9p . + // // - For instance types with NVIDIA V100 GPUs, specify v100 . + // // Default: Any accelerator AcceleratorNames []AcceleratorName - // The minimum and maximum amount of total accelerator memory, in MiB. Default: No - // minimum or maximum limits + // The minimum and maximum amount of total accelerator memory, in MiB. + // + // Default: No minimum or maximum limits 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 . + // // 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 + // 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 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 . + // // 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]in the Amazon EC2 User Guide. + // + // Default: No minimum or maximum limits + // + // [Amazon EBS–optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html 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) - // . + // excluded, or required. For more information, see [Burstable performance instances]. + // // - 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 + // + // [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html 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 + // (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* . + // 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.* , // 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]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 + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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. + // excluded, or required. For more information, [Amazon EC2 instance store]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 + // + // [Amazon EC2 instance store]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html 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 . + // // Default: hdd and ssd LocalStorageTypes []LocalStorageType @@ -6813,11 +7277,15 @@ type InstanceRequirements struct { // current generation instance types, and failing that, from the lowest priced // previous generation instance types that match your attributes. When Amazon EC2 // selects instance types with your attributes, it will exclude instance types - // whose price exceeds your specified threshold. The parameter accepts an integer, - // which Amazon EC2 interprets as a percentage. If you set DesiredCapacityType to - // vcpu or memory-mib , the price protection threshold is based on the per vCPU or - // per memory price instead of the per instance price. Only one of - // SpotMaxPricePercentageOverLowestPrice or + // whose price exceeds your specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + // + // If you set DesiredCapacityType to vcpu or memory-mib , the price protection + // threshold is based on the per vCPU or per memory price instead of the per + // instance price. + // + // Only one of SpotMaxPricePercentageOverLowestPrice or // MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't // specify either, Amazon EC2 will automatically apply optimal price protection to // consistently select from a wide range of instance types. To indicate no price @@ -6826,19 +7294,23 @@ type InstanceRequirements struct { // specify a high value, such as 999999 . MaxSpotPriceAsPercentageOfOptimalOnDemandPrice *int32 - // The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum - // or maximum limits + // The minimum and maximum amount of memory per vCPU, in GiB. + // + // Default: No minimum or maximum limits MemoryGiBPerVCpu *MemoryGiBPerVCpu // The minimum and maximum amount of memory, in MiB. MemoryMiB *MemoryMiB // The minimum and maximum amount of network bandwidth, in gigabits per second - // (Gbps). Default: No minimum or maximum limits + // (Gbps). + // + // Default: No minimum or maximum limits NetworkBandwidthGbps *NetworkBandwidthGbps - // The minimum and maximum number of network interfaces. Default: No minimum or - // maximum limits + // The minimum and maximum number of network interfaces. + // + // Default: No minimum or maximum limits NetworkInterfaceCount *NetworkInterfaceCount // [Price protection] The price protection threshold for On-Demand Instances, as a @@ -6846,18 +7318,32 @@ type InstanceRequirements struct { // price is the price of the lowest priced current generation C, M, or R instance // type with your specified attributes. When Amazon EC2 selects instance types with // your attributes, it will exclude instance types whose price exceeds your - // specified 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 + // specified 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] and [GetInstanceTypesFromInstanceRequirements]. + // + // 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 + // per-instance price. + // + // Default: 20 + // + // [GetSpotPlacementScores]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html + // [GetInstanceTypesFromInstanceRequirements]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html 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]. + // + // Default: false + // + // [GetSpotPlacementScores]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html RequireHibernateSupport *bool // [Price protection] The price protection threshold for Spot Instances, as a @@ -6868,23 +7354,33 @@ type InstanceRequirements struct { // priced current generation instance types, and failing that, from the lowest // priced previous generation instance types that match your attributes. When // Amazon EC2 selects instance types with your attributes, it will exclude instance - // types whose Spot price exceeds your specified threshold. The parameter accepts - // an integer, which Amazon EC2 interprets as a percentage. 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. 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) - // . Only one of SpotMaxPricePercentageOverLowestPrice or + // types whose Spot price exceeds your specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + // + // 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. + // + // This parameter is not supported for [GetSpotPlacementScores] and [GetInstanceTypesFromInstanceRequirements]. + // + // Only one of SpotMaxPricePercentageOverLowestPrice or // MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't // specify either, Amazon EC2 will automatically apply optimal price protection to // consistently select from a wide range of instance types. To indicate no price // protection threshold for Spot Instances, meaning you want to consider all // instance types that match your attributes, include one of these parameters and - // specify a high value, such as 999999 . Default: 100 + // specify a high value, such as 999999 . + // + // Default: 100 + // + // [GetSpotPlacementScores]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html + // [GetInstanceTypesFromInstanceRequirements]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html SpotMaxPricePercentageOverLowestPrice *int32 - // The minimum and maximum amount of total local storage, in GB. Default: No - // minimum or maximum limits + // The minimum and maximum amount of total local storage, in GB. + // + // Default: No minimum or maximum limits TotalLocalStorageGB *TotalLocalStorageGB // The minimum and maximum number of vCPUs. @@ -6894,31 +7390,40 @@ type InstanceRequirements struct { } // The attributes for the instance types. When you specify instance attributes, -// Amazon EC2 will identify instance types with these attributes. You must specify -// VCpuCount and MemoryMiB . All other attributes are optional. Any unspecified -// optional attribute is set to its default. When you specify multiple attributes, -// you get instance types that satisfy all of the specified attributes. If you -// specify multiple values for an attribute, you get instance 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: +// Amazon EC2 will identify instance types with these attributes. +// +// You must specify VCpuCount and MemoryMiB . All other attributes are optional. +// Any unspecified optional attribute is set to its default. +// +// When you specify multiple attributes, you get instance types that satisfy all +// of the specified attributes. If you specify multiple values for an attribute, +// you get instance 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. // // If you specify InstanceRequirements , you can't specify InstanceType . +// // Attribute-based instance type selection is only supported when using Auto // Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to -// use the launch template in the launch instance wizard (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) -// , or with the RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) -// API or AWS::EC2::Instance (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) -// Amazon Web Services CloudFormation resource, you can't specify -// InstanceRequirements . 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. +// use the launch template in the [launch instance wizard], or with the [RunInstances] API or [AWS::EC2::Instance] Amazon Web Services +// CloudFormation resource, you can't specify InstanceRequirements . +// +// For more information, see [Attribute-based instance type selection for EC2 Fleet], [Attribute-based instance type selection for Spot Fleet], and [Spot placement score] in the Amazon EC2 User Guide. +// +// [Attribute-based instance type selection for EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html +// [AWS::EC2::Instance]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html +// [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html +// [Spot placement score]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.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 +// [launch instance wizard]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html type InstanceRequirementsRequest struct { // The minimum and maximum amount of memory, in MiB. @@ -6932,125 +7437,194 @@ type InstanceRequirementsRequest struct { VCpuCount *VCpuCountRangeRequest // 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 + // Services Inferentia chips) on an instance. + // + // To exclude accelerator-enabled 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 Amazon Web Services devices, specify // amazon-web-services . + // // - For instance types with AMD devices, specify amd . + // // - For instance types with Habana devices, specify habana . + // // - For instance types with NVIDIA devices, specify nvidia . + // // - 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 A10G GPUs, specify a10g . + // // - For instance types with NVIDIA A100 GPUs, specify a100 . + // // - For instance types with NVIDIA H100 GPUs, specify h100 . + // // - 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 K80 GPUs, specify k80 . + // // - 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 NVIDIA T4 GPUs, specify t4 . + // // - For instance types with NVIDIA T4G GPUs, specify t4g . + // // - For instance types with Xilinx VU9P FPGAs, specify vu9p . + // // - For instance types with NVIDIA V100 GPUs, specify v100 . + // // Default: Any accelerator AcceleratorNames []AcceleratorName - // The minimum and maximum amount of total accelerator memory, in MiB. Default: No - // minimum or maximum limits + // The minimum and maximum amount of total accelerator memory, in MiB. + // + // Default: No minimum or maximum limits 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 . + // // 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 + // 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 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 . + // // 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]in the Amazon EC2 User Guide. + // + // Default: No minimum or maximum limits + // + // [Amazon EBS–optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html 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) - // . + // excluded, or required. For more information, see [Burstable performance instances]. + // // - 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 + // + // [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html 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 + // (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* . + // 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.* , // 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]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 + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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. + // excluded, or required. For more information, [Amazon EC2 instance store]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 + // + // [Amazon EC2 instance store]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html 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 . + // // Default: hdd and ssd LocalStorageTypes []LocalStorageType @@ -7062,11 +7636,15 @@ type InstanceRequirementsRequest struct { // current generation instance types, and failing that, from the lowest priced // previous generation instance types that match your attributes. When Amazon EC2 // selects instance types with your attributes, it will exclude instance types - // whose price exceeds your specified threshold. The parameter accepts an integer, - // which Amazon EC2 interprets as a percentage. If you set DesiredCapacityType to - // vcpu or memory-mib , the price protection threshold is based on the per vCPU or - // per memory price instead of the per instance price. Only one of - // SpotMaxPricePercentageOverLowestPrice or + // whose price exceeds your specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + // + // If you set DesiredCapacityType to vcpu or memory-mib , the price protection + // threshold is based on the per vCPU or per memory price instead of the per + // instance price. + // + // Only one of SpotMaxPricePercentageOverLowestPrice or // MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't // specify either, Amazon EC2 will automatically apply optimal price protection to // consistently select from a wide range of instance types. To indicate no price @@ -7075,17 +7653,22 @@ type InstanceRequirementsRequest struct { // specify a high value, such as 999999 . MaxSpotPriceAsPercentageOfOptimalOnDemandPrice *int32 - // The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum - // or maximum limits + // The minimum and maximum amount of memory per vCPU, in GiB. + // + // Default: No minimum or maximum limits MemoryGiBPerVCpu *MemoryGiBPerVCpuRequest // The minimum and maximum amount of baseline network bandwidth, in gigabits per - // second (Gbps). For more information, see Amazon EC2 instance network bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) - // in the Amazon EC2 User Guide. Default: No minimum or maximum limits + // second (Gbps). For more information, see [Amazon EC2 instance network bandwidth]in the Amazon EC2 User Guide. + // + // Default: No minimum or maximum limits + // + // [Amazon EC2 instance network bandwidth]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html NetworkBandwidthGbps *NetworkBandwidthGbpsRequest - // The minimum and maximum number of network interfaces. Default: No minimum or - // maximum limits + // The minimum and maximum number of network interfaces. + // + // Default: No minimum or maximum limits NetworkInterfaceCount *NetworkInterfaceCountRequest // [Price protection] The price protection threshold for On-Demand Instances, as a @@ -7093,19 +7676,32 @@ type InstanceRequirementsRequest struct { // price is the price of the lowest priced current generation C, M, or R instance // type with your specified attributes. When Amazon EC2 selects instance types with // your attributes, it will exclude instance types whose price exceeds your - // specified threshold. The parameter accepts an integer, which Amazon EC2 - // interprets as a percentage. To indicate no price protection threshold, 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 + // specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + // + // To indicate no price protection threshold, specify a high value, such as 999999 . + // + // This parameter is not supported for [GetSpotPlacementScores] and [GetInstanceTypesFromInstanceRequirements]. + // + // 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 + // per-instance price. + // + // Default: 20 + // + // [GetSpotPlacementScores]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html + // [GetInstanceTypesFromInstanceRequirements]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html 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]. + // + // Default: false + // + // [GetSpotPlacementScores]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html RequireHibernateSupport *bool // [Price protection] The price protection threshold for Spot Instances, as a @@ -7116,23 +7712,33 @@ type InstanceRequirementsRequest struct { // priced current generation instance types, and failing that, from the lowest // priced previous generation instance types that match your attributes. When // Amazon EC2 selects instance types with your attributes, it will exclude instance - // types whose Spot price exceeds your specified threshold. The parameter accepts - // an integer, which Amazon EC2 interprets as a percentage. 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. 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) - // . Only one of SpotMaxPricePercentageOverLowestPrice or + // types whose Spot price exceeds your specified threshold. + // + // The parameter accepts an integer, which Amazon EC2 interprets as a percentage. + // + // 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. + // + // This parameter is not supported for [GetSpotPlacementScores] and [GetInstanceTypesFromInstanceRequirements]. + // + // Only one of SpotMaxPricePercentageOverLowestPrice or // MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't // specify either, Amazon EC2 will automatically apply optimal price protection to // consistently select from a wide range of instance types. To indicate no price // protection threshold for Spot Instances, meaning you want to consider all // instance types that match your attributes, include one of these parameters and - // specify a high value, such as 999999 . Default: 100 + // specify a high value, such as 999999 . + // + // Default: 100 + // + // [GetSpotPlacementScores]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html + // [GetInstanceTypesFromInstanceRequirements]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html SpotMaxPricePercentageOverLowestPrice *int32 - // The minimum and maximum amount of total local storage, in GB. Default: No - // minimum or maximum limits + // The minimum and maximum amount of total local storage, in GB. + // + // Default: No minimum or maximum limits TotalLocalStorageGB *TotalLocalStorageGBRequest noSmithyDocumentSerde @@ -7140,8 +7746,10 @@ 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 . +// instance types with those attributes. +// +// If you specify InstanceRequirementsWithMetadataRequest , you can't specify +// InstanceTypes . type InstanceRequirementsWithMetadataRequest struct { // The architecture type. @@ -7170,8 +7778,9 @@ type InstanceSpecification struct { // 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. + // exclude the root volume, use ExcludeBootVolume. + // + // You can specify up to 40 volume IDs per request. ExcludeDataVolumeIds []string noSmithyDocumentSerde @@ -7180,18 +7789,30 @@ type InstanceSpecification struct { // Describes the current state of an instance. type InstanceState struct { - // The state of the instance as a 16-bit unsigned integer. The high byte is all of - // the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and - // 65,535. These numerical values are used for internal purposes and should be - // 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: + // The state of the instance as a 16-bit unsigned integer. + // + // The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal + // values between 256 and 65,535. These numerical values are used for internal + // purposes and should be 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. Code *int32 @@ -7229,8 +7850,8 @@ type InstanceStatus struct { // The ID of the instance. InstanceId *string - // The intended state of the instance. DescribeInstanceStatus requires that an - // instance be in the running state. + // The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running + // state. InstanceState *InstanceState // Reports impaired functionality that stems from issues internal to the instance, @@ -7270,9 +7891,11 @@ type InstanceStatusEvent struct { // The event code. Code EventCode - // A description of the event. After a scheduled event is completed, it can still - // be described for up to a week. If the event has been completed, this description - // starts with the following text: [Completed]. + // A description of the event. + // + // After a scheduled event is completed, it can still be described for up to a + // week. If the event has been completed, this description starts with the + // following text: [Completed]. Description *string // The ID of the event. @@ -7370,8 +7993,9 @@ type InstanceTypeInfo struct { BareMetal *bool // Indicates whether the instance type is a burstable performance T instance type. - // For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) - // . + // For more information, see [Burstable performance instances]. + // + // [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html BurstablePerformanceSupported *bool // Indicates whether the instance type is current generation. @@ -7407,8 +8031,9 @@ 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] in the Amazon EC2 User Guide. + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html InstanceType InstanceType // Describes the media accelerator settings for the instance type. @@ -7438,8 +8063,10 @@ 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] in the Amazon EC2 User + // Guide. + // + // [Boot modes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html SupportedBootModes []BootModeType // The supported root device types. @@ -7469,8 +8096,9 @@ 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] in the Amazon EC2 User Guide. + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html InstanceType InstanceType // The identifier for the location. This depends on the location type. For @@ -7542,8 +8170,10 @@ 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?]in the Amazon VPC IPAM +// User Guide. +// +// [What is IPAM?]: https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html type Ipam struct { // The IPAM's default resource discovery association ID. @@ -7567,9 +8197,12 @@ type Ipam struct { // The operating Regions for an IPAM. Operating Regions are Amazon Web Services // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only // discovers and monitors resources in the Amazon Web Services Regions you select - // as operating Regions. For more information about operating Regions, see Create - // an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the - // Amazon VPC IPAM User Guide. + // as operating Regions. + // + // For more information about operating Regions, see [Create an IPAM] in the Amazon VPC IPAM User + // Guide. + // + // [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html OperatingRegions []IpamOperatingRegion // The Amazon Web Services account ID of the owner of the IPAM. @@ -7585,8 +8218,9 @@ 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]in the Amazon VPC IPAM User Guide. + // + // [Quotas in IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html ScopeCount *int32 // The state of the IPAM. @@ -7603,23 +8237,27 @@ type Ipam struct { // IPAM is offered in a Free Tier and an Advanced Tier. For more information about // the features available in each tier and the costs associated with the tiers, see - // Amazon VPC pricing > IPAM tab (http://aws.amazon.com/vpc/pricing/) . + // [Amazon VPC pricing > IPAM tab]. + // + // [Amazon VPC pricing > IPAM tab]: http://aws.amazon.com/vpc/pricing/ Tier IpamTier noSmithyDocumentSerde } -// 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) +// The historical record of a CIDR within an IPAM scope. For more information, see [View the history of IP addresses] // 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 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) - // in the Amazon VPC IPAM User Guide. + // statuses, see [Monitor CIDR usage by resource]in the Amazon VPC IPAM User Guide. + // + // [Monitor CIDR usage by resource]: https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html ResourceComplianceStatus IpamComplianceStatus // The ID of the resource. @@ -7630,8 +8268,9 @@ type IpamAddressHistoryRecord struct { // 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. + // information on overlap statuses, see [Monitor CIDR usage by resource]in the Amazon VPC IPAM User Guide. + // + // [Monitor CIDR usage by resource]: https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html ResourceOverlapStatus IpamOverlapStatus // The ID of the resource owner. @@ -7772,13 +8411,16 @@ 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). IpUsage *float64 @@ -7817,17 +8459,25 @@ 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. + // authorized. For more information, see [AuthFailure]in the Amazon Elastic Compute Cloud API + // Reference. + // + // [AuthFailure]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html Code IpamDiscoveryFailureCode // The discovery failure message. @@ -7839,9 +8489,12 @@ type IpamDiscoveryFailureReason struct { // The operating Regions for an IPAM. Operating Regions are Amazon Web Services // Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only // discovers and monitors resources in the Amazon Web Services Regions you select -// as operating Regions. For more information about operating Regions, see Create -// an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the -// Amazon VPC IPAM User Guide. +// as operating Regions. +// +// For more information about operating Regions, see [Create an IPAM] in the Amazon VPC IPAM User +// Guide. +// +// [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html type IpamOperatingRegion struct { // The name of the operating Region. @@ -7891,7 +8544,9 @@ type IpamPool struct { // 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. + // 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. @@ -7938,17 +8593,20 @@ 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]in the Amazon VPC IPAM User Guide. + // + // [Quotas in IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html 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. + // information, see [Create IPv6 pools]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]in the Amazon VPC IPAM User + // Guide. + // + // [Create IPv6 pools]: https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html + // [Quotas for your IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html PublicIpSource IpamPoolPublicIpSource // Determines if a pool is publicly advertisable. This option is not available for @@ -8119,19 +8777,23 @@ type IpamPublicAddressTags 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) - // in the Amazon VPC IPAM User Guide. + // statuses, see [Monitor CIDR usage by resource]in the Amazon VPC IPAM User Guide. + // + // [Monitor CIDR usage by resource]: https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html 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). IpUsage *float64 @@ -8146,14 +8808,16 @@ 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) - // in the Amazon VPC IPAM User Guide. + // states, see [Monitor CIDR usage by resource]in the Amazon VPC IPAM User Guide. + // + // [Monitor CIDR usage by resource]: https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html 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) - // in the Amazon VPC IPAM User Guide. + // information on overlap statuses, see [Monitor CIDR usage by resource]in the Amazon VPC IPAM User Guide. + // + // [Monitor CIDR usage by resource]: https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html OverlapStatus IpamOverlapStatus // The CIDR for an IPAM resource. @@ -8214,18 +8878,30 @@ 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. State IpamResourceDiscoveryState @@ -8270,8 +8946,10 @@ 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 @@ -8281,16 +8959,25 @@ type IpamResourceDiscoveryAssociation struct { // 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. State IpamResourceDiscoveryAssociationState @@ -8323,8 +9010,11 @@ 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] in the Amazon VPC IPAM User Guide. +// +// [How IPAM works]: https://docs.aws.amazon.com/vpc/latest/ipam/how-it-works-ipam.html type IpamScope struct { // The description of the scope. @@ -8373,14 +9063,16 @@ type IpPermission struct { // protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). 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. When authorizing security group rules, + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers]). + // + // 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. + // + // [Protocol Numbers]: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IpProtocol *string // The IPv4 address ranges. @@ -8413,8 +9105,10 @@ type IpRange struct { CidrIp *string // A description for the security group rule that references this IPv4 address - // range. Constraints: Up to 255 characters in length. Allowed characters are a-z, - // A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + // range. + // + // Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, + // 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* Description *string noSmithyDocumentSerde @@ -8423,9 +9117,10 @@ type IpRange struct { // Describes an IPv4 prefix. 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. + // The IPv4 prefix. For information, see [Assigning prefixes to Amazon EC2 network interfaces] in the Amazon Elastic Compute Cloud User + // Guide. + // + // [Assigning prefixes to Amazon EC2 network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html Ipv4Prefix *string noSmithyDocumentSerde @@ -8434,9 +9129,10 @@ type Ipv4PrefixSpecification struct { // Describes the IPv4 prefix option for a network interface. 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. + // The IPv4 prefix. For information, see [Assigning prefixes to Amazon EC2 network interfaces] in the Amazon Elastic Compute Cloud User + // Guide. + // + // [Assigning prefixes to Amazon EC2 network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html Ipv4Prefix *string noSmithyDocumentSerde @@ -8526,8 +9222,10 @@ type Ipv6Range struct { CidrIpv6 *string // A description for the security group rule that references this IPv6 address - // range. Constraints: Up to 255 characters in length. Allowed characters are a-z, - // A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* + // range. + // + // Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, + // 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* Description *string noSmithyDocumentSerde @@ -8537,24 +9235,31 @@ 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], 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], in the UTC time zone. + // + // [ISO 8601 date-time format]: https://www.iso.org/iso-8601-date-and-time-format.html 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) - // . + // digest, which is the default for OpenSSH, starting with [OpenSSH 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) - // . + // digest, which is the default for OpenSSH, starting with [OpenSSH 6.8]. + // + // [OpenSSH 6.8]: http://www.openssh.com/txt/release-6.8 KeyFingerprint *string // The name of the key pair. @@ -8599,8 +9304,9 @@ 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 @@ -8633,7 +9339,9 @@ type LaunchSpecification struct { // provides dedicated throughput to Amazon EBS and an optimized configuration stack // to provide optimal EBS I/O performance. This optimization isn't available with // all instance types. Additional usage charges apply when using an EBS Optimized - // instance. Default: false + // instance. + // + // Default: false EbsOptimized *bool // The IAM instance profile. @@ -8768,8 +9476,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. CapacityReservationPreference CapacityReservationPreference @@ -8785,8 +9495,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. CapacityReservationPreference CapacityReservationPreference @@ -8816,8 +9528,9 @@ type LaunchTemplateConfig struct { type LaunchTemplateCpuOptions struct { // Indicates whether the instance is enabled for AMD SEV-SNP. For more - // information, see AMD SEV-SNP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) - // . + // information, see [AMD SEV-SNP]. + // + // [AMD SEV-SNP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html AmdSevSnp AmdSevSnpSpecification // The number of CPU cores for the instance. @@ -8834,8 +9547,10 @@ type LaunchTemplateCpuOptions struct { type LaunchTemplateCpuOptionsRequest struct { // Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is - // supported with M6a, R6a, and C6a instance types only. For more information, see - // AMD SEV-SNP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) . + // supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP] + // . + // + // [AMD SEV-SNP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html AmdSevSnp AmdSevSnpSpecification // The number of CPU cores for the instance. @@ -8892,15 +9607,22 @@ type LaunchTemplateEbsBlockDeviceRequest struct { // 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: + // 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 - 256,000 IOPS - // For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the - // Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) - // . On other instances, you can achieve performance up to 32,000 IOPS. This - // parameter is supported for io1 , io2 , and gp3 volumes only. + // + // For io2 volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System]. On other instances, + // you can achieve performance up to 32,000 IOPS. + // + // This parameter is supported for io1 , io2 , and gp3 volumes only. + // + // [instances built on the Nitro System]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances Iops *int32 // The ARN of the symmetric Key Management Service (KMS) CMK used for encryption. @@ -8910,6 +9632,7 @@ type LaunchTemplateEbsBlockDeviceRequest struct { SnapshotId *string // The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. + // // Valid Range: Minimum value of 125. Maximum value of 1000. Throughput *int32 @@ -8917,14 +9640,19 @@ type LaunchTemplateEbsBlockDeviceRequest struct { // volume size. The following are the supported volumes sizes for each volume type: // // - gp2 and gp3 : 1 - 16,384 GiB + // // - io1 : 4 - 16,384 GiB + // // - io2 : 4 - 65,536 GiB + // // - st1 and sc1 : 125 - 16,384 GiB + // // - standard : 1 - 1024 GiB VolumeSize *int32 - // The volume type. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) - // in the Amazon EBS User Guide. + // The volume type. For more information, see [Amazon EBS volume types] in the Amazon EBS User Guide. + // + // [Amazon EBS volume types]: https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html VolumeType VolumeType noSmithyDocumentSerde @@ -8933,13 +9661,14 @@ type LaunchTemplateEbsBlockDeviceRequest struct { // Describes an elastic inference accelerator. type LaunchTemplateElasticInferenceAccelerator struct { - // The type of elastic inference accelerator. The possible values are eia1.medium, - // eia1.large, and eia1.xlarge. + // The type of elastic inference accelerator. The possible values are + // eia1.medium, eia1.large, and eia1.xlarge. // // This member is required. Type *string - // The number of elastic inference accelerators to attach to the instance. + // The number of elastic inference accelerators to attach to the instance. + // // Default: 1 Count *int32 @@ -8949,12 +9678,13 @@ type LaunchTemplateElasticInferenceAccelerator struct { // Describes an elastic inference accelerator. type LaunchTemplateElasticInferenceAcceleratorResponse struct { - // The number of elastic inference accelerators to attach to the instance. + // 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, - // eia1.large, and eia1.xlarge. + // The type of elastic inference accelerator. The possible values are + // eia1.medium, eia1.large, and eia1.xlarge. Type *string noSmithyDocumentSerde @@ -8965,11 +9695,13 @@ type LaunchTemplateElasticInferenceAcceleratorResponse struct { // 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. +// 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 LaunchTemplateEnaSrdSpecification struct { // Indicates whether ENA Express is enabled for the network interface. @@ -9009,8 +9741,10 @@ 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?]in the Amazon Web Services Nitro Enclaves +// User Guide. +// +// [What is Amazon Web Services Nitro Enclaves?]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html type LaunchTemplateEnclaveOptionsRequest struct { // To enable the instance for Amazon Web Services Nitro Enclaves, set this @@ -9031,11 +9765,13 @@ 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]. +// +// [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. + // // Default: false Configured *bool @@ -9079,8 +9815,9 @@ type LaunchTemplateInstanceMaintenanceOptions struct { 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) - // . + // default. For more information, see [Simplified automatic recovery]. + // + // [Simplified automatic recovery]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery AutoRecovery LaunchTemplateAutoRecoveryState noSmithyDocumentSerde @@ -9110,31 +9847,40 @@ type LaunchTemplateInstanceMarketOptionsRequest struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Compute Cloud User Guide. +// The metadata options for the instance. For more information, see [Instance metadata and user data] in the Amazon +// Elastic Compute Cloud User Guide. +// +// [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html 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. + // // Default: disabled HttpProtocolIpv6 LaunchTemplateInstanceMetadataProtocolIpv6 // The desired HTTP PUT response hop limit for instance metadata requests. The - // larger the number, the further instance metadata requests can travel. Default: 1 + // larger the number, the further instance metadata requests can travel. + // + // Default: 1 + // // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional - IMDSv2 is optional. You can choose whether to send a session // token in your instance metadata retrieval requests. If you retrieve IAM role // credentials without a session token, you receive the IMDSv1 role credentials. If // you retrieve IAM role credentials using a valid session token, you receive the // IMDSv2 role credentials. + // // - required - IMDSv2 is required. You must send a session token in your // instance metadata retrieval requests. With this option, retrieving the IAM role // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not @@ -9143,56 +9889,74 @@ type LaunchTemplateInstanceMetadataOptions struct { // 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]. + // + // Default: disabled + // + // [Work with instance tags using the instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags LaunchTemplateInstanceMetadataTagsState - // The state of the metadata option changes. pending - The metadata options are - // being updated and the instance is not ready to process metadata traffic with the - // new selection. applied - The metadata options have been successfully applied on - // the instance. + // The state of the metadata option changes. + // + // pending - The metadata options are being updated and the instance is not ready + // to process metadata traffic with the new selection. + // + // applied - The metadata options have been successfully applied on the instance. State LaunchTemplateInstanceMetadataOptionsState noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Compute Cloud User Guide. +// The metadata options for the instance. For more information, see [Instance metadata and user data] in the Amazon +// Elastic Compute Cloud User Guide. +// +// [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html 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. + // // Default: disabled HttpProtocolIpv6 LaunchTemplateInstanceMetadataProtocolIpv6 // The desired HTTP PUT response hop limit for instance metadata requests. The - // larger the number, the further instance metadata requests can travel. Default: 1 + // larger the number, the further instance metadata requests can travel. + // + // Default: 1 + // // Possible values: Integers from 1 to 64 HttpPutResponseHopLimit *int32 // Indicates whether IMDSv2 is required. + // // - optional - IMDSv2 is optional. You can choose whether to send a session // token in your instance metadata retrieval requests. If you retrieve IAM role // credentials without a session token, you receive the IMDSv1 role credentials. If // you retrieve IAM role credentials using a valid session token, you receive the // IMDSv2 role credentials. + // // - required - IMDSv2 is required. You must send a session token in your // instance metadata retrieval requests. With this option, retrieving the IAM role // credentials always returns IMDSv2 credentials; IMDSv1 credentials are not // available. + // // Default: If the value of ImdsSupport for the Amazon Machine Image (AMI) for // your instance is v2.0 , the default is required . 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]. + // + // Default: disabled + // + // [Work with instance tags using the instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags LaunchTemplateInstanceMetadataTagsState noSmithyDocumentSerde @@ -9202,23 +9966,30 @@ type LaunchTemplateInstanceMetadataOptionsRequest struct { 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) - // in the Wavelength Developer Guide. + // 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]in the Wavelength Developer Guide. + // + // [Carrier IP addresses]: https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip AssociateCarrierIpAddress *bool // Indicates whether to associate a public IPv4 address with eth0 for a new - // network interface. Amazon Web Services charges for all public IPv4 addresses, - // including public IPv4 addresses associated with running instances and Elastic IP - // addresses. For more information, see the Public IPv4 Address tab on the Amazon - // VPC pricing page (http://aws.amazon.com/vpc/pricing/) . + // network interface. + // + // Amazon Web Services charges for all public IPv4 addresses, including public + // IPv4 addresses associated with running instances and Elastic IP addresses. For + // more information, see the Public IPv4 Address tab on the [Amazon VPC pricing page]. + // + // [Amazon VPC pricing page]: http://aws.amazon.com/vpc/pricing/ AssociatePublicIpAddress *bool // A security group connection tracking specification that enables you to set the // timeout for connection tracking on an Elastic network interface. For more - // information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. + // + // [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts ConnectionTrackingSpecification *ConnectionTrackingSpecification // Indicates whether the network interface is deleted when the instance is @@ -9270,8 +10041,9 @@ type LaunchTemplateInstanceNetworkInterfaceSpecification struct { // The primary IPv6 address of the network interface. When you enable an IPv6 GUA // address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 // address until the instance is terminated or the network interface is detached. - // For more information about primary IPv6 addresses, see RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // . + // For more information about primary IPv6 addresses, see [RunInstances]. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html PrimaryIpv6 *bool // The primary private IPv4 address of the network interface. @@ -9292,24 +10064,29 @@ type LaunchTemplateInstanceNetworkInterfaceSpecification struct { // The parameters for a network interface. 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) - // in the Wavelength Developer Guide. + // 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]in the Wavelength Developer Guide. + // + // [Carrier IP addresses]: https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip AssociateCarrierIpAddress *bool - // Associates a public IPv4 address with eth0 for a new network interface. Amazon - // Web Services charges for all public IPv4 addresses, including public IPv4 - // addresses associated with running instances and Elastic IP addresses. For more - // information, see the Public IPv4 Address tab on the Amazon VPC pricing page (http://aws.amazon.com/vpc/pricing/) - // . + // Associates a public IPv4 address with eth0 for a new network interface. + // + // Amazon Web Services charges for all public IPv4 addresses, including public + // IPv4 addresses associated with running instances and Elastic IP addresses. For + // more information, see the Public IPv4 Address tab on the [Amazon VPC pricing page]. + // + // [Amazon VPC pricing page]: http://aws.amazon.com/vpc/pricing/ AssociatePublicIpAddress *bool // A security group connection tracking specification that enables you to set the // timeout for connection tracking on an Elastic network interface. For more - // information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. + // + // [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts ConnectionTrackingSpecification *ConnectionTrackingSpecificationRequest // Indicates whether the network interface is deleted when the instance is @@ -9333,9 +10110,14 @@ 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] 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 + // + // [Elastic Fabric Adapter]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html InterfaceType *string // The number of IPv4 prefixes to be automatically assigned to the network @@ -9375,8 +10157,9 @@ type LaunchTemplateInstanceNetworkInterfaceSpecificationRequest struct { // The primary IPv6 address of the network interface. When you enable an IPv6 GUA // address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 // address until the instance is terminated or the network interface is detached. - // For more information about primary IPv6 addresses, see RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // . + // For more information about primary IPv6 addresses, see [RunInstances]. + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html PrimaryIpv6 *bool // The primary private IPv4 address of the network interface. @@ -9421,41 +10204,49 @@ type LaunchTemplateOverrides struct { // The instance requirements. When you specify instance requirements, Amazon EC2 // 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 . + // types, in the same way as when you specify a list of instance types. + // + // If you 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 - // 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 - // template override has the lowest priority. You can set the same priority for - // different launch template overrides. + // 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 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. + // 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. SubnetId *string - // The number of units provided by the specified instance type. When specifying - // weights, the price used in the lowest-price and price-capacity-optimized - // allocation strategies is per unit hour (where the instance price is divided by - // the specified weight). However, if all the specified weights are above the - // requested TargetCapacity , resulting in only 1 instance being launched, the - // price used is per instance hour. + // The number of units provided by the specified instance type. + // + // When specifying weights, the price used in the lowest-price and + // price-capacity-optimized allocation strategies is per unit hour (where the + // instance price is divided by the specified weight). However, if all the + // specified weights are above the requested TargetCapacity , resulting in only 1 + // instance being launched, the price used is per instance hour. WeightedCapacity *float64 noSmithyDocumentSerde @@ -9595,18 +10386,25 @@ type LaunchTemplatesMonitoringRequest struct { // Describes the launch template to use. type LaunchTemplateSpecification struct { - // The ID of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The ID of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateId *string - // The name of the launch template. You must specify either the launch template ID - // or the launch template name, but not both. + // The name of the launch template. + // + // You must specify either the launch template ID or the launch template name, but + // not both. LaunchTemplateName *string - // The launch template version number, $Latest , or $Default . A value of $Latest - // uses the latest version of the launch template. A value of $Default uses the - // default version of the launch template. Default: The default version of the - // launch template. + // The launch template version number, $Latest , or $Default . + // + // A value of $Latest uses the latest version of the launch template. + // + // A value of $Default uses the default version of the launch template. + // + // Default: The default version of the launch template. Version *string noSmithyDocumentSerde @@ -9625,8 +10423,10 @@ type LaunchTemplateSpotMarketOptions struct { // 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. + // 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. @@ -9653,8 +10453,10 @@ type LaunchTemplateSpotMarketOptionsRequest struct { // 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. + // 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. @@ -9662,11 +10464,14 @@ 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. + // // Default: 7 days from the current date ValidUntil *time.Time @@ -9689,13 +10494,17 @@ type LaunchTemplateTagSpecification struct { // launch. type LaunchTemplateTagSpecificationRequest struct { - // The type of resource to tag. Valid Values lists all resource types for Amazon - // EC2 that can be tagged. When you create a launch template, you can specify tags - // for the following resource types only: instance | volume | network-interface | - // spot-instances-request . If the instance does not include the resource type that - // you specify, the instance launch fails. For example, not all instance types - // include a volume. To tag a resource after it has been created, see CreateTags (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) - // . + // The type of resource to tag. + // + // Valid Values lists all resource types for Amazon EC2 that can be tagged. When + // you create a launch template, you can specify tags for the following resource + // types only: instance | volume | network-interface | spot-instances-request . If + // the instance does not include the resource type that you specify, the instance + // launch fails. For example, not all instance types include a volume. + // + // To tag a resource after it has been created, see [CreateTags]. + // + // [CreateTags]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html ResourceType ResourceType // The tags to apply to the resource. @@ -9831,7 +10640,7 @@ type LocalGatewayRoute struct { // The CIDR block used for destination matches. DestinationCidrBlock *string - // The ID of the prefix list. + // The ID of the prefix list. DestinationPrefixListId *string // The Amazon Resource Name (ARN) of the local gateway route table. @@ -10035,9 +10844,10 @@ type LockedSnapshotsInfo struct { LockDuration *int32 // The date and time at which the lock duration started, in the UTC time zone ( - // YYYY-MM-DDThh:mm:ss.sssZ ). If you lock a snapshot that is in the pending - // state, the lock duration starts only once the snapshot enters the completed - // state. + // YYYY-MM-DDThh:mm:ss.sssZ ). + // + // If you lock a snapshot that is in the pending state, the lock duration starts + // only once the snapshot enters the completed state. LockDurationStartTime *time.Time // The date and time at which the lock will expire, in the UTC time zone ( @@ -10045,16 +10855,20 @@ type LockedSnapshotsInfo struct { LockExpiresOn *time.Time // The state of the snapshot lock. Valid states include: + // // - compliance-cooloff - The snapshot has been locked in compliance mode but it // is still within the cooling-off period. The snapshot can't be deleted, but it // can be unlocked and the lock settings can be modified by users with appropriate // permissions. + // // - governance - The snapshot is locked in governance mode. The snapshot can't // be deleted, but it can be unlocked and the lock settings can be modified by // users with appropriate permissions. + // // - compliance - The snapshot is locked in compliance mode and the cooling-off // period has expired. The snapshot can't be unlocked or deleted. The lock duration // can only be increased by users with appropriate permissions. + // // - expired - The snapshot was locked in compliance or governance mode but the // lock duration has expired. The snapshot is not locked and can be deleted. LockState LockState @@ -10071,10 +10885,10 @@ type LockedSnapshotsInfo struct { // Information about the EC2 Mac Dedicated Host. type MacHost struct { - // The EC2 Mac Dedicated Host ID. + // The EC2 Mac Dedicated Host ID. HostId *string - // The latest macOS versions that the EC2 Mac Dedicated Host can launch without + // The latest macOS versions that the EC2 Mac Dedicated Host can launch without // being upgraded. MacOSLatestSupportedVersions []string @@ -10270,9 +11084,11 @@ type ModifyTransitGatewayOptions 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 modify ASN operation is not allowed on a transit gateway with - // active BGP sessions. You must first delete all transit gateway attachments that - // have BGP configured prior to modifying the ASN on the transit gateway. + // 32-bit ASNs. + // + // The modify ASN operation is not allowed on a transit gateway with active BGP + // sessions. You must first delete all transit gateway attachments that have BGP + // configured prior to modifying the ASN on the transit gateway. AmazonSideAsn *int64 // The ID of the default association route table. @@ -10298,9 +11114,10 @@ type ModifyTransitGatewayOptions struct { // Removes CIDR blocks for the transit gateway. RemoveTransitGatewayCidrBlocks []string - // This parameter is in preview and may not be available for your account. Enables - // you to reference a security group across VPCs attached to a transit gateway. Use - // this option to simplify security group management and control of + // This parameter is in preview and may not be available for your account. + // + // Enables you to reference a security group across VPCs attached to a transit + // gateway. Use this option to simplify security group management and control of // instance-to-instance traffic across VPCs that are connected by transit gateway. // You can also use this option to migrate from VPC peering (which was the only // option that supported security group referencing) to transit gateways (which now @@ -10328,9 +11145,10 @@ type ModifyTransitGatewayVpcAttachmentRequestOptions struct { // Enable or disable IPv6 support. The default is enable . Ipv6Support Ipv6SupportValue - // This parameter is in preview and may not be available for your account. Enables - // you to reference a security group across VPCs attached to a transit gateway. Use - // this option to simplify security group management and control of + // This parameter is in preview and may not be available for your account. + // + // Enables you to reference a security group across VPCs attached to a transit + // gateway. Use this option to simplify security group management and control of // instance-to-instance traffic across VPCs that are connected by transit gateway. // You can also use this option to migrate from VPC peering (which was the only // option that supported security group referencing) to transit gateways (which now @@ -10374,8 +11192,8 @@ type ModifyVerifiedAccessEndpointLoadBalancerOptions struct { // Verified Access trust provider. type ModifyVerifiedAccessTrustProviderDeviceOptions struct { - // The URL Amazon Web Services Verified Access will use to verify the authenticity - // of the device tokens. + // The URL Amazon Web Services Verified Access will use to verify the + // authenticity of the device tokens. PublicSigningKeyUrl *string noSmithyDocumentSerde @@ -10414,106 +11232,152 @@ type ModifyVerifiedAccessTrustProviderOidcOptions struct { type ModifyVpnTunnelOptionsSpecification struct { // The action to take after DPD timeout occurs. Specify restart to restart the IKE - // initiation. Specify clear to end the IKE session. Valid Values: clear | none | - // restart Default: clear + // initiation. Specify clear to end the IKE session. + // + // Valid Values: clear | none | restart + // + // Default: clear DPDTimeoutAction *string // The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 // seconds means that the VPN endpoint will consider the peer dead 30 seconds after - // the first failed keep-alive. Constraints: A value greater than or equal to 30. + // the first failed keep-alive. + // + // Constraints: A value greater than or equal to 30. + // // Default: 40 DPDTimeoutSeconds *int32 // Turn on or off tunnel endpoint lifecycle control feature. EnableTunnelLifecycleControl *bool - // The IKE versions that are permitted for the VPN tunnel. Valid values: ikev1 | - // ikev2 + // The IKE versions that are permitted for the VPN tunnel. + // + // Valid values: ikev1 | ikev2 IKEVersions []IKEVersionsRequestListValue // Options for logging VPN tunnel activity. LogOptions *VpnTunnelLogOptionsSpecification // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 1 IKE negotiations. Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 - // | 21 | 22 | 23 | 24 + // for phase 1 IKE negotiations. + // + // Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 Phase1DHGroupNumbers []Phase1DHGroupNumbersRequestListValue // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 1 IKE negotiations. Valid values: AES128 | AES256 | AES128-GCM-16 | - // AES256-GCM-16 + // phase 1 IKE negotiations. + // + // Valid values: AES128 | AES256 | AES128-GCM-16 | 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 + // 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 - // value between 900 and 28,800. Default: 28800 + // The lifetime for phase 1 of the IKE negotiation, in seconds. + // + // Constraints: A value between 900 and 28,800. + // + // Default: 28800 Phase1LifetimeSeconds *int32 // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 2 IKE negotiations. Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 - // | 20 | 21 | 22 | 23 | 24 + // for phase 2 IKE negotiations. + // + // Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 Phase2DHGroupNumbers []Phase2DHGroupNumbersRequestListValue // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 2 IKE negotiations. Valid values: AES128 | AES256 | AES128-GCM-16 | - // AES256-GCM-16 + // phase 2 IKE negotiations. + // + // Valid values: AES128 | AES256 | AES128-GCM-16 | 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 + // 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 + // 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 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). + // 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 + // 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: 270 + // RekeyFuzzPercentage . + // + // Constraints: A value between 60 and half of Phase2LifetimeSeconds . + // + // Default: 270 RekeyMarginTimeSeconds *int32 - // The number of packets in an IKE replay window. Constraints: A value between 64 - // and 2048. Default: 1024 + // The number of packets in an IKE replay window. + // + // Constraints: A value between 64 and 2048. + // + // Default: 1024 ReplayWindowSize *int32 // The action to take when the establishing the tunnel for the VPN connection. By // default, your customer gateway device must initiate the IKE negotiation and // bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE - // negotiation. Valid Values: add | start Default: add + // negotiation. + // + // Valid Values: add | start + // + // Default: add StartupAction *string // The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks // 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: + // 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 TunnelInsideCidr *string // The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks // must be unique across all VPN connections that use the same transit gateway. + // // Constraints: A size /126 CIDR block from the local fd00::/8 range. TunnelInsideIpv6Cidr *string @@ -10530,7 +11394,9 @@ type Monitoring struct { noSmithyDocumentSerde } -// This action is deprecated. Describes the status of a moving Elastic IP address. +// This action is deprecated. +// +// Describes the status of a moving Elastic IP address. type MovingAddressStatus struct { // The status of the Elastic IP address that's being moved or restored. @@ -10562,16 +11428,22 @@ type NatGateway struct { // 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." FailureMessage *string @@ -10583,21 +11455,28 @@ type NatGateway struct { // 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], contact us through + // the [Support Center]. + // + // [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html + // [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. State NatGatewayState @@ -10722,12 +11601,15 @@ type NetworkAclEntry struct { } // The minimum and maximum amount of network bandwidth, in gigabits per second -// (Gbps). Setting the minimum bandwidth does not guarantee that your instance will +// (Gbps). +// +// Setting the minimum bandwidth does not guarantee that your instance will // 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) -// in the Amazon EC2 User Guide. +// see [Available instance bandwidth]in the Amazon EC2 User Guide. +// +// [Available instance bandwidth]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth type NetworkBandwidthGbps struct { // The maximum amount of network bandwidth, in Gbps. If this parameter is not @@ -10742,12 +11624,15 @@ type NetworkBandwidthGbps struct { } // The minimum and maximum amount of network bandwidth, in gigabits per second -// (Gbps). Setting the minimum bandwidth does not guarantee that your instance will +// (Gbps). +// +// Setting the minimum bandwidth does not guarantee that your instance will // 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) -// in the Amazon EC2 User Guide. +// see [Available instance bandwidth]in the Amazon EC2 User Guide. +// +// [Available instance bandwidth]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth type NetworkBandwidthGbpsRequest struct { // The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, @@ -10916,9 +11801,9 @@ type NetworkInsightsAnalysis struct { // Potential intermediate components. AlternatePathHints []AlternatePathHint - // The explanations. For more information, see Reachability Analyzer explanation - // codes (https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html) - // . + // The explanations. For more information, see [Reachability Analyzer explanation codes]. + // + // [Reachability Analyzer explanation 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. @@ -11027,8 +11912,9 @@ type NetworkInterface struct { // A security group connection tracking configuration that enables you to set the // timeout for connection tracking on an Elastic network interface. For more - // information, see Connection tracking timeouts (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Connection tracking timeouts]in the Amazon Elastic Compute Cloud User Guide. + // + // [Connection tracking timeouts]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts ConnectionTrackingConfiguration *ConnectionTrackingConfiguration // Indicates whether a network interface with an IPv6 address is unreachable from @@ -11119,9 +12005,10 @@ type NetworkInterfaceAssociation struct { // The association ID. AssociationId *string - // The carrier IP address associated with the network interface. This option is - // only available when the network interface is in a subnet which is associated - // with a Wavelength Zone. + // The carrier IP address associated with the network interface. + // + // This option is only available when the network interface is in a subnet which + // is associated with a Wavelength Zone. CarrierIp *string // The customer-owned IP address associated with the network interface. @@ -11224,9 +12111,9 @@ type NetworkInterfaceIpv6Address struct { // Determines if an IPv6 address associated with a network interface is the // primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, // the first IPv6 GUA will be made the primary IPv6 address until the instance is - // terminated or the network interface is detached. For more information, see - // ModifyNetworkInterfaceAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyNetworkInterfaceAttribute.html) - // . + // terminated or the network interface is detached. For more information, see [ModifyNetworkInterfaceAttribute]. + // + // [ModifyNetworkInterfaceAttribute]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyNetworkInterfaceAttribute.html IsPrimaryIpv6 *bool noSmithyDocumentSerde @@ -11393,38 +12280,54 @@ type OidcOptions struct { type OnDemandOptions struct { // The strategy that determines the order of the launch template overrides to use - // in fulfilling On-Demand capacity. lowest-price - EC2 Fleet uses price to - // determine the order, launching the lowest price first. prioritized - EC2 Fleet - // uses the priority that you assigned to each launch template override, launching - // the highest priority first. Default: lowest-price + // in fulfilling On-Demand capacity. + // + // lowest-price - EC2 Fleet uses price to determine the order, launching the + // lowest price first. + // + // prioritized - EC2 Fleet uses the priority that you assigned to each launch + // template override, launching the highest priority first. + // + // Default: lowest-price 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. + // // If your fleet includes T instances that are configured as unlimited , and if // their average CPU usage exceeds the baseline utilization, you will incur a // charge for surplus credits. The maxTotalPrice does not account for surplus // credits, and, if you use surplus credits, your final cost might be higher than - // what you specified for maxTotalPrice . For more information, see Surplus - // credits can incur charges (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) - // in the EC2 User Guide. + // what you specified for maxTotalPrice . For more information, see [Surplus credits can incur charges] in the EC2 + // User Guide. + // + // [Surplus credits can incur charges]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits 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 + // + // 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 @@ -11434,38 +12337,54 @@ type OnDemandOptions struct { type OnDemandOptionsRequest struct { // The strategy that determines the order of the launch template overrides to use - // in fulfilling On-Demand capacity. lowest-price - EC2 Fleet uses price to - // determine the order, launching the lowest price first. prioritized - EC2 Fleet - // uses the priority that you assigned to each launch template override, launching - // the highest priority first. Default: lowest-price + // in fulfilling On-Demand capacity. + // + // lowest-price - EC2 Fleet uses price to determine the order, launching the + // lowest price first. + // + // prioritized - EC2 Fleet uses the priority that you assigned to each launch + // template override, launching the highest priority first. + // + // Default: lowest-price 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. + // // If your fleet includes T instances that are configured as unlimited , and if // their average CPU usage exceeds the baseline utilization, you will incur a // charge for surplus credits. The MaxTotalPrice does not account for surplus // credits, and, if you use surplus credits, your final cost might be higher than - // what you specified for MaxTotalPrice . For more information, see Surplus - // credits can incur charges (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) - // in the EC2 User Guide. + // what you specified for MaxTotalPrice . For more information, see [Surplus credits can incur charges] in the EC2 + // User Guide. + // + // [Surplus credits can incur charges]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits 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 + // + // 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 @@ -11850,16 +12769,22 @@ type Phase2IntegrityAlgorithmsRequestListValue struct { // Describes the placement of an instance. 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) - // . + // The affinity setting for the instance on the Dedicated Host. + // + // This parameter is not supported for [CreateFleet] or [ImportInstance]. + // + // [CreateFleet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet + // [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 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]. + // + // [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 , @@ -11870,31 +12795,43 @@ type Placement struct { // 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) - // . + // The ID of the Dedicated Host on which the instance resides. + // + // This parameter is not supported for [CreateFleet] or [ImportInstance]. + // + // [CreateFleet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet + // [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) - // . + // 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]. + // + // [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) - // . + // placement group strategy is set to partition . + // + // This parameter is not supported for [CreateFleet]. + // + // [CreateFleet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet PartitionNumber *int32 // Reserved for future use. SpreadDomain *string // The tenancy of the instance. 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) - // or for T3 instances that are configured for the unlimited CPU credit option. + // single-tenant hardware. + // + // This parameter is not supported for [CreateFleet]. The host tenancy is not supported for [ImportInstance] or + // for T3 instances that are configured for the unlimited CPU credit option. + // + // [CreateFleet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet + // [ImportInstance]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html Tenancy Tenancy noSmithyDocumentSerde @@ -12013,6 +12950,7 @@ type PrefixListEntry struct { type PrefixListId struct { // A description for the security group rule that references this prefix list ID. + // // Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, // 0-9, spaces, and ._-:/()#,@[]+=;{}!$* Description *string @@ -12027,13 +12965,15 @@ type PrefixListId struct { 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 - // months 5, 4, and 3. Then schedule 2, covering the last two months of the term, - // will be active for months 2 and 1. + // 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 @@ -12107,8 +13047,10 @@ type PrivateDnsNameConfiguration struct { // 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 . + // The verification state of the VPC endpoint service. + // + // >Consumers of the endpoint service can use the private name only when the state + // is verified . State DnsNameState // The endpoint service verification type, for example TXT. @@ -12202,8 +13144,9 @@ type ProcessorInfo struct { // Indicates whether the instance type supports AMD SEV-SNP. If the request // returns amd-sev-snp , AMD SEV-SNP is supported. Otherwise, it is not supported. - // For more information, see AMD SEV-SNP (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html) - // . + // For more information, see [AMD SEV-SNP]. + // + // [AMD SEV-SNP]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html SupportedFeatures []SupportedAdditionalProcessorFeature // The speed of the processor, in GHz. @@ -12233,34 +13176,46 @@ 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], contact us through +// the [Support Center]. +// +// [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html +// [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], contact us through + // the [Support Center]. + // + // [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html + // [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], contact us through + // the [Support Center]. + // + // [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html + // [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], contact us through + // the [Support Center]. + // + // [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html + // [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], contact us through + // the [Support Center]. + // + // [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html + // [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], contact us through + // the [Support Center]. + // + // [documented limits]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html + // [Support Center]: https://console.aws.amazon.com/support/home? Status *string noSmithyDocumentSerde @@ -12444,9 +13399,12 @@ type RegisterInstanceTagAttributeRequest struct { // Remove an operating Region from an IPAM. Operating Regions are Amazon Web // Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only // discovers and monitors resources in the Amazon Web Services Regions you select -// as operating Regions. For more information about operating Regions, see Create -// an IPAM (https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the -// Amazon VPC IPAM User Guide +// as operating Regions. +// +// For more information about operating Regions, see [Create an IPAM] in the Amazon VPC IPAM User +// Guide +// +// [Create an IPAM]: https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html type RemoveIpamOperatingRegion struct { // The name of the operating Region you want to remove. @@ -12495,16 +13453,23 @@ 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. TaskState ReplaceRootVolumeTaskState @@ -12537,8 +13502,9 @@ 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. @@ -12550,24 +13516,28 @@ type RequestLaunchTemplateData struct { // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // The CPU options for the instance. For more information, see [Optimizing CPU Options] in the Amazon + // Elastic Compute Cloud User Guide. + // + // [Optimizing CPU Options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html CpuOptions *LaunchTemplateCpuOptionsRequest // The credit option for CPU usage of the instance. Valid only for T instances. 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) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Stop protection]in the Amazon Elastic Compute Cloud User Guide. + // + // [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 // 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 - // can terminate the instance by running the shutdown command from the instance. + // after launch, use [ModifyInstanceAttribute]. Alternatively, if you set InstanceInitiatedShutdownBehavior + // to terminate , you can terminate the instance by running the shutdown command + // from the instance. + // + // [ModifyInstanceAttribute]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html DisableApiTermination *bool // Indicates whether the instance is optimized for Amazon EBS I/O. This @@ -12577,55 +13547,76 @@ type RequestLaunchTemplateData struct { // apply when using an EBS-optimized instance. EbsOptimized *bool - // Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For - // workloads that require graphics acceleration, we recommend that you use Amazon - // EC2 G4ad, G4dn, or G5 instances. + // Deprecated. + // + // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads + // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, + // G4dn, or G5 instances. ElasticGpuSpecifications []ElasticGpuSpecification // An elastic inference accelerator to associate with the instance. Elastic // inference accelerators are a resource you can attach to your Amazon EC2 - // instances to accelerate your Deep Learning (DL) inference workloads. You cannot - // specify accelerators from different generations in the same request. 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 - // customers and will be able to continue using the service. + // instances to accelerate your Deep Learning (DL) inference workloads. + // + // You cannot specify accelerators from different generations in the same request. + // + // 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 customers and will be able to continue using the service. 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?]in the Amazon Web Services Nitro Enclaves + // User Guide. + // + // You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same + // instance. + // + // [What is Amazon Web Services Nitro Enclaves?]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html 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]. For more information, see [Hibernate your instance] in the Amazon + // Elastic Compute Cloud User Guide. + // + // [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html + // [hibernation prerequisites]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html HibernationOptions *LaunchTemplateHibernationOptionsRequest // The name or Amazon Resource Name (ARN) of an IAM instance profile. IamInstanceProfile *LaunchTemplateIamInstanceProfileSpecificationRequest // The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, - // which will resolve to an AMI ID on launch. Valid formats: + // 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 + // // - resolve:ssm:public-parameter + // // Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager // parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, - // you must specify the AMI ID. For more information, see Use a Systems Manager - // parameter instead of an AMI ID (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#use-an-ssm-parameter-instead-of-an-ami-id) - // in the Amazon Elastic Compute Cloud User Guide. + // you must specify the AMI ID. + // + // For more information, see [Use a Systems Manager parameter instead of an AMI ID] in the Amazon Elastic Compute Cloud User Guide. + // + // [Use a Systems Manager parameter instead of an AMI ID]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#use-an-ssm-parameter-instead-of-an-ami-id ImageId *string // Indicates whether an instance stops or terminates when you initiate shutdown // from the instance (using the operating system command for system shutdown). + // // Default: stop InstanceInitiatedShutdownBehavior ShutdownBehavior @@ -12633,46 +13624,65 @@ type RequestLaunchTemplateData struct { InstanceMarketOptions *LaunchTemplateInstanceMarketOptionsRequest // The attributes for the instance types. When you specify instance attributes, - // Amazon EC2 will identify instance types with these attributes. You must specify - // VCpuCount and MemoryMiB . All other attributes are optional. Any unspecified - // optional attribute is set to its default. When you specify multiple attributes, - // you get instance types that satisfy all of the specified attributes. If you - // specify multiple values for an attribute, you get instance 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: + // Amazon EC2 will identify instance types with these attributes. + // + // You must specify VCpuCount and MemoryMiB . All other attributes are optional. + // Any unspecified optional attribute is set to its default. + // + // When you specify multiple attributes, you get instance types that satisfy all + // of the specified attributes. If you specify multiple values for an attribute, + // you get instance 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. + // // If you specify InstanceRequirements , you can't specify InstanceType . + // // Attribute-based instance type selection is only supported when using Auto // Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to - // use the launch template in the launch instance wizard (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) - // , or with the RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) - // API or AWS::EC2::Instance (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) - // Amazon Web Services CloudFormation resource, you can't specify - // InstanceRequirements . 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. + // use the launch template in the [launch instance wizard], or with the [RunInstances] API or [AWS::EC2::Instance] Amazon Web Services + // CloudFormation resource, you can't specify InstanceRequirements . + // + // For more information, see [Attribute-based instance type selection for EC2 Fleet], [Attribute-based instance type selection for Spot Fleet], and [Spot placement score] in the Amazon EC2 User Guide. + // + // [Attribute-based instance type selection for EC2 Fleet]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html + // [AWS::EC2::Instance]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html + // [Spot placement score]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.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 + // [launch instance wizard]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html 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] in the Amazon Elastic Compute + // Cloud User Guide. + // + // If you specify InstanceType , you can't specify InstanceRequirements . + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [User provided kernels]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html 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] or [ImportKeyPair]. + // + // 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. + // + // [ImportKeyPair]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html + // [CreateKeyPair]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html KeyName *string // The license configurations. @@ -12681,9 +13691,10 @@ type RequestLaunchTemplateData struct { // The maintenance options for the instance. 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) - // in the Amazon Elastic Compute Cloud User Guide. + // The metadata options for the instance. For more information, see [Instance metadata and user data] in the Amazon + // Elastic Compute Cloud User Guide. + // + // [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html MetadataOptions *LaunchTemplateInstanceMetadataOptionsRequest // The monitoring for the instance. @@ -12699,20 +13710,25 @@ type RequestLaunchTemplateData struct { // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [User provided kernels]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html RamDiskId *string - // The IDs of the security groups. If you specify a network interface, you must - // specify any security groups as part of the network interface instead of using - // this parameter. + // The IDs of the security groups. + // + // If you specify a network interface, you must specify any security groups as + // part of the network interface instead of using this parameter. SecurityGroupIds []string // The names of the security groups. For a nondefault VPC, you must use security - // group IDs instead. If you specify a network interface, you must specify any - // security groups as part of the network interface instead of using this - // parameter. + // group IDs instead. + // + // If you specify a network interface, you must specify any security groups as + // part of the network interface instead of using this parameter. SecurityGroups []string // The tags to apply to the resources that are created during instance launch. @@ -12720,14 +13736,16 @@ type RequestLaunchTemplateData struct { 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) - // (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. + // base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands on your Linux instance at launch] + // (Linux) or [Work with instance user data](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]. For more information, see [Amazon EC2 user data in launch templates] in the Batch User Guide. + // + // [Run commands on your Linux instance at launch]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html + // [Amazon EC2 user data in launch templates]: https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html + // [MIME multi-part archive format]: https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive + // [Work with instance user data]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instancedata-add-user-data.html UserData *string noSmithyDocumentSerde @@ -12749,7 +13767,9 @@ type RequestSpotLaunchSpecification struct { // provides dedicated throughput to Amazon EBS and an optimized configuration stack // to provide optimal EBS I/O performance. This optimization isn't available with // all instance types. Additional usage charges apply when using an EBS Optimized - // instance. Default: false + // instance. + // + // Default: false EbsOptimized *bool // The IAM instance profile. @@ -12768,6 +13788,7 @@ type RequestSpotLaunchSpecification struct { KeyName *string // Indicates whether basic or detailed monitoring is enabled for the instance. + // // Default: Disabled Monitoring *RunInstancesMonitoringEnabled @@ -12852,17 +13873,19 @@ 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) - // in the Amazon EC2 User Guide. + // use. A lower value indicates a high priority. For more information, see [Instance type priority]in the + // Amazon EC2 User Guide. + // + // [Instance type priority]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority Priority *int32 // The number of capacity units provided by the specified instance type. This // 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) - // in the Amazon EC2 User Guide. + // information, see [Total target capacity]in the Amazon EC2 User Guide. + // + // [Total target capacity]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity Weight *float64 noSmithyDocumentSerde @@ -12977,8 +14000,9 @@ type ReservedInstancesConfiguration struct { // The Availability Zone for the modified Reserved Instances. AvailabilityZone *string - // The number of modified Reserved Instances. This is a required field for a - // request. + // The number of modified Reserved Instances. + // + // This is a required field for a request. InstanceCount *int32 // The instance type for the modified Reserved Instances. @@ -13007,8 +14031,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The time the listing was created. @@ -13046,8 +14071,9 @@ 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // The time when the modification request was created. @@ -13137,8 +14163,8 @@ type ReservedInstancesOffering struct { // The recurring charge tag assigned to the resource. RecurringCharges []RecurringCharge - // The ID of the Reserved Instance offering. This is the offering ID used in - // GetReservedInstancesExchangeQuote to confirm that an exchange can be made. + // The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to + // confirm that an exchange can be made. ReservedInstancesOfferingId *string // Whether the Reserved Instance is applied to instances in a Region or an @@ -13197,17 +14223,19 @@ type ResponseLaunchTemplateData struct { // Information about the Capacity Reservation targeting option. 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) - // in the Amazon Elastic Compute Cloud User Guide. + // The CPU options for the instance. For more information, see [Optimizing CPU options] in the Amazon + // Elastic Compute Cloud User Guide. + // + // [Optimizing CPU options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html CpuOptions *LaunchTemplateCpuOptions // The credit option for CPU usage of the instance. 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) - // in the Amazon Elastic Compute Cloud User Guide. + // information, see [Stop protection]in the Amazon Elastic Compute Cloud User Guide. + // + // [Stop protection]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection DisableApiStop *bool // If set to true , indicates that the instance cannot be terminated using the @@ -13217,22 +14245,26 @@ type ResponseLaunchTemplateData struct { // Indicates whether the instance is optimized for Amazon EBS I/O. EbsOptimized *bool - // Deprecated. Amazon Elastic Graphics reached end of life on January 8, 2024. For - // workloads that require graphics acceleration, we recommend that you use Amazon - // EC2 G4ad, G4dn, or G5 instances. + // Deprecated. + // + // Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads + // that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, + // G4dn, or G5 instances. ElasticGpuSpecifications []ElasticGpuSpecificationResponse // An elastic inference accelerator to associate with the instance. Elastic // inference accelerators are a resource you can attach to your Amazon EC2 - // instances to accelerate your Deep Learning (DL) inference workloads. You cannot - // specify accelerators from different generations in the same request. 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 - // customers and will be able to continue using the service. + // instances to accelerate your Deep Learning (DL) inference workloads. + // + // You cannot specify accelerators from different generations in the same request. + // + // 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 customers and will be able to continue using the service. ElasticInferenceAccelerators []LaunchTemplateElasticInferenceAcceleratorResponse // Indicates whether the instance is enabled for Amazon Web Services Nitro @@ -13240,24 +14272,31 @@ 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]in the Amazon Elastic Compute Cloud User Guide. + // + // [Hibernate your instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html HibernationOptions *LaunchTemplateHibernationOptions // The IAM instance profile. IamInstanceProfile *LaunchTemplateIamInstanceProfileSpecification // 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: + // 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) - // in the Amazon Elastic Compute Cloud User Guide. + // + // For more information, see [Use a Systems Manager parameter instead of an AMI ID] in the Amazon Elastic Compute Cloud User Guide. + // + // [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 ImageId *string // Indicates whether an instance stops or terminates when you initiate shutdown @@ -13268,8 +14307,9 @@ type ResponseLaunchTemplateData struct { InstanceMarketOptions *LaunchTemplateInstanceMarketOptions // 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 . + // Amazon EC2 will identify instance types with these attributes. + // + // If you specify InstanceRequirements , you can't specify InstanceTypes . InstanceRequirements *InstanceRequirements // The instance type. @@ -13287,9 +14327,10 @@ type ResponseLaunchTemplateData struct { // The maintenance options for your instance. 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) - // in the Amazon Elastic Compute Cloud User Guide. + // The metadata options for the instance. For more information, see [Instance metadata and user data] in the Amazon + // Elastic Compute Cloud User Guide. + // + // [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html MetadataOptions *LaunchTemplateInstanceMetadataOptions // The monitoring for the instance. @@ -13363,9 +14404,12 @@ 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. Origin RouteOrigin @@ -13496,16 +14540,22 @@ type RunInstancesMonitoringEnabled struct { } // 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. +// bucket. For more information, see [Categorizing your storage using tags]in the Amazon Simple Storage Service User +// Guide. +// +// [Categorizing your storage using tags]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html 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 :. + // 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 :. Key *string - // The value of the tag. Constraints: Tag values are case-sensitive and can be up - // to 256 Unicode characters in length. + // The value of the tag. + // + // Constraints: Tag values are case-sensitive and can be up to 256 Unicode + // characters in length. Value *string noSmithyDocumentSerde @@ -13516,9 +14566,10 @@ type S3ObjectTag struct { 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. + // your access key ID, review and follow the guidance in [Best Practices for Amazon Web Services accounts]in the Account + // ManagementReference Guide. + // + // [Best Practices for Amazon Web Services accounts]: https://docs.aws.amazon.com/accounts/latest/reference/best-practices.html AWSAccessKeyId *string // The bucket in which to store the AMI. You can specify a bucket that you already @@ -13705,10 +14756,11 @@ type ScheduledInstancesBlockDeviceMapping struct { // 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. + // 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 @@ -13731,11 +14783,15 @@ type ScheduledInstancesEbs struct { // The ID of the snapshot. SnapshotId *string - // The size of the volume, in GiB. Default: If you're creating the volume from a - // snapshot and don't specify a volume size, the default is the snapshot size. + // The size of the volume, in GiB. + // + // Default: If you're creating the volume from a snapshot and don't specify a + // volume size, the default is the snapshot size. VolumeSize *int32 - // The volume type. Default: gp2 + // The volume type. + // + // Default: gp2 VolumeType *string noSmithyDocumentSerde @@ -13762,9 +14818,11 @@ type ScheduledInstancesIpv6Address struct { noSmithyDocumentSerde } -// 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 . +// 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 . type ScheduledInstancesLaunchSpecification struct { // The ID of the Amazon Machine Image (AMI). @@ -13779,7 +14837,9 @@ type ScheduledInstancesLaunchSpecification struct { // provides dedicated throughput to Amazon EBS and an optimized configuration stack // to provide optimal EBS I/O performance. This optimization isn't available with // all instance types. Additional usage charges apply when using an EBS-optimized - // instance. Default: false + // instance. + // + // Default: false EbsOptimized *bool // The IAM instance profile. @@ -13834,11 +14894,13 @@ 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 . Amazon Web Services charges - // for all public IPv4 addresses, including public IPv4 addresses associated with - // running instances and Elastic IP addresses. For more information, see the Public - // IPv4 Address tab on the Amazon VPC pricing page (http://aws.amazon.com/vpc/pricing/) - // . + // into a default subnet, the default value is true . + // + // Amazon Web Services charges for all public IPv4 addresses, including public + // IPv4 addresses associated with running instances and Elastic IP addresses. For + // more information, see the Public IPv4 Address tab on the [Amazon VPC pricing page]. + // + // [Amazon VPC pricing page]: http://aws.amazon.com/vpc/pricing/ AssociatePublicIpAddress *bool // Indicates whether to delete the interface when the instance is terminated. @@ -13978,14 +15040,16 @@ type SecurityGroupReference struct { // The ID of the VPC with the referencing security group. ReferencingVpcId *string - // This parameter is in preview and may not be available for your account. The ID - // of the transit gateway (if applicable). + // This parameter is in preview and may not be available for your account. + // + // The ID of the transit gateway (if applicable). TransitGatewayId *string // The ID of the VPC peering connection (if applicable). For more information - // about security group referencing for peering connections, see Update your - // security groups to reference peer security groups (https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-security-groups.html) - // in the VPC Peering Guide. + // about security group referencing for peering connections, see [Update your security groups to reference peer security groups]in the VPC + // Peering Guide. + // + // [Update your security groups to reference peer security groups]: https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-security-groups.html VpcPeeringConnectionId *string noSmithyDocumentSerde @@ -14013,9 +15077,11 @@ 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]). + // + // Use -1 to specify all protocols. + // + // [Protocol Numbers]: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IpProtocol *string // Indicates whether the security group rule is an outbound rule. @@ -14042,9 +15108,10 @@ type SecurityGroupRule struct { noSmithyDocumentSerde } -// Describes the description of a security group rule. You can use this when you -// want to update the security group rule description for either an inbound or -// outbound rule. +// Describes the description of a security group rule. +// +// You can use this when you want to update the security group rule description +// for either an inbound or outbound rule. type SecurityGroupRuleDescription struct { // The description of the security group rule. @@ -14056,11 +15123,17 @@ type SecurityGroupRuleDescription struct { noSmithyDocumentSerde } -// Describes a security group rule. You must specify exactly one of the following -// parameters, based on the rule type: +// Describes a security group rule. +// +// You must specify exactly one of the following parameters, based on the rule +// type: +// // - CidrIpv4 +// // - CidrIpv6 +// // - PrefixListId +// // - ReferencedGroupId // // When you modify a rule, you cannot change the rule type. For example, if the @@ -14083,9 +15156,11 @@ type SecurityGroupRuleRequest struct { // protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). 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]). + // + // Use -1 to specify all protocols. + // + // [Protocol Numbers]: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IpProtocol *string // The ID of the prefix list. @@ -14196,8 +15271,10 @@ type ServiceDetail struct { // The private DNS name for the service. 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 . + // The verification state of the VPC endpoint service. + // + // Consumers of the endpoint service cannot use the private name when the state is + // not verified . PrivateDnsNameVerificationState DnsNameState // The private DNS names assigned to the VPC endpoint service. @@ -14272,7 +15349,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. @@ -14286,8 +15363,9 @@ 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/ebs/latest/userguide/snapshots-outposts.html) - // in the Amazon EBS User Guide. + // see [Amazon EBS local snapshots on Outposts]in the Amazon EBS User Guide. + // + // [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html OutpostArn *string // The Amazon Web Services owner alias, from an Amazon-maintained list ( amazon ). @@ -14321,8 +15399,7 @@ type Snapshot struct { // Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy // 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 . + // you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots. StateMessage *string // The storage tier in which the snapshot is stored. standard indicates that the @@ -14335,8 +15412,7 @@ type Snapshot struct { Tags []Tag // The ID of the volume that was used to create the snapshot. Snapshots created by - // the CopySnapshot action have an arbitrary volume ID that should not be used for - // any purpose. + // the CopySnapshotaction have an arbitrary volume ID that should not be used for any purpose. VolumeId *string // The size of the volume, in GiB. @@ -14387,7 +15463,9 @@ type SnapshotDiskContainer struct { // The description of the disk image being imported. Description *string - // The format of the disk image being imported. Valid values: VHD | VMDK | RAW + // The format of the disk image being imported. + // + // Valid values: VHD | VMDK | RAW Format *string // The URL to the Amazon S3-based disk image being imported. It can either be a @@ -14411,8 +15489,9 @@ 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/ebs/latest/userguide/snapshots-outposts.html) - // in the Amazon EBS User Guide. + // see [Amazon EBS local snapshots on Outposts]in the Amazon EBS User Guide. + // + // [Amazon EBS local snapshots on Outposts]: https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html OutpostArn *string // Account id used when creating this snapshot. @@ -14555,27 +15634,33 @@ 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) -// in the Amazon EC2 User Guide for Linux Instances. +// information, see [Capacity rebalancing]in the Amazon EC2 User Guide for Linux Instances. +// +// [Capacity rebalancing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html type SpotCapacityRebalance struct { // 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 // terminate the old instances, or you can leave them running. You are charged for - // 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 - // rebalance notification. + // 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 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 - // seconds. Maximum value of 7200 seconds. + // 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 noSmithyDocumentSerde @@ -14604,9 +15689,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]. +// +// [LaunchTemplateConfig]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html type SpotFleetLaunchSpecification struct { // Deprecated. @@ -14623,7 +15708,9 @@ type SpotFleetLaunchSpecification struct { // provides dedicated throughput to Amazon EBS and an optimized configuration stack // to provide optimal EBS I/O performance. This optimization isn't available with // all instance types. Additional usage charges apply when using an EBS Optimized - // instance. Default: false + // instance. + // + // Default: false EbsOptimized *bool // The IAM instance profile. @@ -14633,8 +15720,9 @@ type SpotFleetLaunchSpecification struct { ImageId *string // 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 . + // Amazon EC2 will identify instance types with those attributes. + // + // If you specify InstanceRequirements , you can't specify InstanceType . InstanceRequirements *InstanceRequirements // The instance type. @@ -14649,9 +15737,12 @@ type SpotFleetLaunchSpecification struct { // Enable or disable monitoring for the instances. Monitoring *SpotFleetMonitoring - // The network interfaces. SpotFleetLaunchSpecification does not support Elastic - // Fabric Adapter (EFA). You must use LaunchTemplateConfig (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html) - // instead. + // The network interfaces. + // + // SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). You + // must use [LaunchTemplateConfig]instead. + // + // [LaunchTemplateConfig]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html NetworkInterfaces []InstanceNetworkInterfaceSpecification // The placement information. @@ -14663,22 +15754,27 @@ type SpotFleetLaunchSpecification struct { // Resource Center and search for the kernel ID. RamdiskId *string - // The security groups. If you specify a network interface, you must specify any - // security groups as part of the network interface instead of using this - // parameter. + // The security groups. + // + // If you specify a network interface, you must specify any security groups as + // part of the network interface instead of using this parameter. 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. + // 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 // subnets, separate them using commas; for example, "subnet-1234abcdeexample1, - // subnet-0987cdef6example2". If you specify a network interface, you must specify - // any subnets as part of the network interface instead of using this parameter. + // subnet-0987cdef6example2". + // + // If you specify a network interface, you must specify any subnets as part of the + // network interface instead of using this parameter. SubnetId *string // The tags to apply during creation. @@ -14690,10 +15786,11 @@ type SpotFleetLaunchSpecification struct { // The number of units provided by the specified instance type. These are the same // units that you chose to set the target capacity in terms of instances, or a - // performance characteristic such as vCPUs, memory, or I/O. If the target capacity - // divided by this value is not a whole number, Amazon EC2 rounds the number of - // instances to the next whole number. If this value is not specified, the default - // is 1. + // performance characteristic such as vCPUs, memory, or I/O. + // + // If the target capacity divided by this value is not a whole number, Amazon EC2 + // rounds the number of instances to the next whole number. If this value is not + // specified, the default is 1. WeightedCapacity *float64 noSmithyDocumentSerde @@ -14702,7 +15799,9 @@ type SpotFleetLaunchSpecification struct { // Describes whether monitoring is enabled. type SpotFleetMonitoring struct { - // Enables monitoring for the instance. Default: false + // Enables monitoring for the instance. + // + // Default: false Enabled *bool noSmithyDocumentSerde @@ -14741,12 +15840,14 @@ 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) - // 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) - // or when the Spot Fleet request expires, if you set + // instances on your behalf. For more information, see [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]or when the Spot Fleet request expires, if you set // TerminateInstancesWithExpiration . // + // [CancelSpotFleetRequests]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests + // [Spot Fleet prerequisites]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites + // // This member is required. IamFleetRole *string @@ -14761,40 +15862,49 @@ 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) - // 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 - // from the pools that we believe have the lowest chance of interruption in the - // near term. Spot Fleet then requests Spot Instances from the lowest priced of - // these pools. capacityOptimized 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 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 - // 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 - // 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 - // capacity. If the lowest priced pool doesn't have available capacity, the Spot - // Instances come from the next lowest priced pool that has available capacity. If - // a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet - // will continue to fulfill your request by drawing from the next lowest priced - // pool. To ensure that your desired capacity is met, you might receive Spot - // Instances from several pools. Because this strategy only considers instance - // price and not capacity availability, it might lead to high interruption rates. + // For more information, see [Allocation strategies for Spot Instances]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 from the pools that we believe + // have the lowest chance of interruption in the near term. Spot Fleet then + // requests Spot Instances from the lowest priced of these pools. + // + // capacityOptimized 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 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 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 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 capacity. If the lowest priced pool doesn't have + // available capacity, the Spot Instances come from the next lowest priced pool + // that has available capacity. If a pool runs out of capacity before fulfilling + // your desired capacity, Spot Fleet will continue to fulfill your request by + // drawing from the next lowest priced pool. To ensure that your desired capacity + // is met, you might receive Spot Instances from several pools. Because this + // strategy only considers instance price and not capacity availability, it might + // lead to high interruption rates. + // // Default: lowestPrice + // + // [Allocation strategies for Spot Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html AllocationStrategy AllocationStrategy // 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]. + // + // [Ensuring Idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html ClientToken *string // Reserved. @@ -14802,7 +15912,9 @@ 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 @@ -14815,22 +15927,25 @@ type SpotFleetRequestConfigData struct { // 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 // 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 - // effort basis. If a pool runs out of Spot capacity before fulfilling your target - // capacity, Spot 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. + // 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 effort basis. If a pool runs out of Spot capacity + // before fulfilling your target capacity, Spot 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 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 . If an - // AMI specified in a launch specification is deregistered or disabled, no new - // instances can be launched from the AMI. For fleets of type maintain , the target - // capacity will not be maintained. + // On-Demand capacity in your request, you must use LaunchTemplateConfigs . + // + // If an AMI specified in a launch specification is deregistered or disabled, no + // new instances can be launched from the AMI. For fleets of type maintain , the + // target capacity will not be maintained. LaunchSpecifications []SpotFleetLaunchSpecification // The launch template and overrides. If you specify LaunchTemplateConfigs , you @@ -14840,9 +15955,11 @@ type SpotFleetRequestConfigData struct { // 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. + // 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 @@ -14864,13 +15981,16 @@ type SpotFleetRequestConfigData struct { // Spot Instances in your request, Spot Fleet will launch instances until it // reaches the maximum amount 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. If your fleet includes T instances that are configured - // as unlimited , and if their average CPU usage exceeds the baseline utilization, - // you will incur a charge for surplus credits. The onDemandMaxTotalPrice does not - // account for surplus credits, and, if you use surplus credits, your final cost - // might be higher than what you specified for onDemandMaxTotalPrice . For more - // information, see Surplus credits can incur charges (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) - // in the EC2 User Guide. + // met the target capacity. + // + // If your fleet includes T instances that are configured as unlimited , and if + // their average CPU usage exceeds the baseline utilization, you will incur a + // charge for surplus credits. The onDemandMaxTotalPrice does not account for + // surplus credits, and, if you use surplus credits, your final cost might be + // higher than what you specified for onDemandMaxTotalPrice . For more information, + // see [Surplus credits can incur charges]in the EC2 User Guide. + // + // [Surplus credits can incur charges]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits OnDemandMaxTotalPrice *string // The number of On-Demand units to request. You can choose to set the target @@ -14893,35 +16013,42 @@ type SpotFleetRequestConfigData struct { // Instances in your request, Spot Fleet will launch instances until it reaches the // maximum amount 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. If your fleet includes T instances that are configured as - // unlimited , and if their average CPU usage exceeds the baseline utilization, you - // will incur a charge for surplus credits. The spotMaxTotalPrice does not account - // for surplus credits, and, if you use surplus credits, your final cost might be - // higher than what you specified for spotMaxTotalPrice . For more information, see - // Surplus credits can incur charges (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) - // in the EC2 User Guide. + // target capacity. + // + // If your fleet includes T instances that are configured as unlimited , and if + // their average CPU usage exceeds the baseline utilization, you will incur a + // charge for surplus credits. The spotMaxTotalPrice does not account for surplus + // credits, and, if you use surplus credits, your final cost might be higher than + // what you specified for spotMaxTotalPrice . For more information, see [Surplus credits can incur charges] in the + // EC2 User Guide. + // + // [Surplus credits can incur charges]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits 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. + // 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 Tag your resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) - // . + // fails. To tag instances at launch, specify the tags in the [launch template](valid only if you + // use LaunchTemplateConfigs ) or in the [SpotFleetTagSpecification] (valid only if you use + // LaunchSpecifications ). For information about tagging after launch, see [Tag your resources]. + // + // [SpotFleetTagSpecification]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html + // [launch template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template + // [Tag your resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources TagSpecifications []TagSpecification // The unit for the target capacity. You can specify this parameter only when - // using attribute-based instance type selection. Default: units (the number of - // instances) + // using attribute-based instance type selection. + // + // Default: units (the number of instances) TargetCapacityUnitType TargetCapacityUnitType // Indicates whether running Spot Instances are terminated when the Spot Fleet @@ -14956,8 +16083,9 @@ 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) - // . + // parameter in [SpotFleetRequestConfigData]. + // + // [SpotFleetRequestConfigData]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html ResourceType ResourceType // The tags. @@ -15013,13 +16141,17 @@ type SpotInstanceRequest struct { // 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. + // 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) - // in the Amazon EC2 User Guide for Linux Instances. + // track your Spot Instance requests. For more information, see [Spot request status]in the Amazon EC2 + // User Guide for Linux Instances. + // + // [Spot request status]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html State SpotInstanceState // The status code and status message describing the Spot Instance request. @@ -15036,9 +16168,11 @@ 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 @@ -15063,8 +16197,10 @@ 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) - // in the Amazon EC2 User Guide for Linux Instances. + // The status code. For a list of status codes, see [Spot request status codes] in the Amazon EC2 User Guide + // for Linux Instances. + // + // [Spot request status codes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand Code *string // The description for the status code. @@ -15083,8 +16219,9 @@ 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) - // in the Amazon EC2 User Guide for Linux Instances. + // information, see [Capacity rebalancing]in the Amazon EC2 User Guide for Linux Instances. + // + // [Capacity rebalancing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html CapacityRebalance *SpotCapacityRebalance noSmithyDocumentSerde @@ -15096,34 +16233,45 @@ type SpotMarketOptions struct { // Deprecated. BlockDurationMinutes *int32 - // The behavior when a Spot Instance is interrupted. If Configured (for - // HibernationOptions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html) - // ) is set to true , the InstanceInterruptionBehavior parameter is automatically - // set to hibernate . If you set it to stop or terminate , you'll get an error. If - // Configured (for HibernationOptions (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html) - // ) is set to false or null , the InstanceInterruptionBehavior parameter is - // automatically set to terminate . You can also set it to stop or hibernate . For - // more information, see Interruption behavior (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/interruption-behavior.html) - // in the Amazon EC2 User Guide. + // The behavior when a Spot Instance is interrupted. + // + // If Configured (for [HibernationOptions]HibernationOptions ) is set to true , the + // InstanceInterruptionBehavior parameter is automatically set to hibernate . If + // you set it to stop or terminate , you'll get an error. + // + // If Configured (for [HibernationOptions]HibernationOptions ) is set to false or null , the + // InstanceInterruptionBehavior parameter is automatically set to terminate . You + // can also set it to stop or hibernate . + // + // For more information, see [Interruption behavior] in the Amazon EC2 User Guide. + // + // [HibernationOptions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html + // [Interruption behavior]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/interruption-behavior.html InstanceInterruptionBehavior InstanceInterruptionBehavior // The maximum hourly price that you're 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 Spot Instances will be - // interrupted more frequently than if you do not specify this parameter. + // 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. 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], persistent Spot Instance requests are + // only supported when the instance interruption behavior is either hibernate or + // stop . + // + // [RunInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances 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. ValidUntil *time.Time @@ -15136,50 +16284,63 @@ 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) - // 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 - // from the pools that we believe have the lowest chance of interruption in the - // near term. EC2 Fleet then requests Spot Instances from the lowest priced of - // these pools. capacity-optimized 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 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 - // priority for each instance type by using the Priority parameter for + // For more information, see [Allocation strategies for Spot Instances]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 from the pools that we believe + // have the lowest chance of interruption in the near term. EC2 Fleet then requests + // Spot Instances from the lowest priced of these pools. + // + // capacity-optimized 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 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 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. 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 - // 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. - // If the lowest priced pool doesn't have available capacity, the Spot Instances - // come from the next lowest priced pool that has available capacity. If a pool - // runs out of capacity before fulfilling your desired capacity, EC2 Fleet will - // continue to fulfill your request by drawing from the next lowest priced pool. To - // ensure that your desired capacity is met, you might receive Spot Instances from - // several pools. Because this strategy only considers instance price and not - // capacity availability, it might lead to high interruption rates. Default: - // lowest-price + // 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. If the lowest priced pool doesn't have + // available capacity, the Spot Instances come from the next lowest priced pool + // that has available capacity. If a pool runs out of capacity before fulfilling + // your desired capacity, EC2 Fleet will continue to fulfill your request by + // drawing from the next lowest priced pool. To ensure that your desired capacity + // is met, you might receive Spot Instances from several pools. Because this + // strategy only considers instance price and not capacity availability, it might + // lead to high interruption rates. + // + // Default: lowest-price + // + // [Allocation strategies for Spot Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html AllocationStrategy SpotAllocationStrategy - // The behavior when a Spot Instance is interrupted. Default: terminate + // The behavior when a Spot Instance is interrupted. + // + // Default: terminate 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. + // 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 @@ -15189,29 +16350,40 @@ type SpotOptions struct { // 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. If your - // fleet includes T instances that are configured as unlimited , and if their - // average CPU usage exceeds the baseline utilization, you will incur a charge for - // surplus credits. The maxTotalPrice does not account for surplus credits, and, - // if you use surplus credits, your final cost might be higher than what you - // specified for maxTotalPrice . For more information, see Surplus credits can - // incur charges (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) - // in the EC2 User Guide. + // Spot price. + // + // If you specify a maximum price, your Spot Instances will be interrupted more + // frequently than if you do not specify this parameter. + // + // If your fleet includes T instances that are configured as unlimited , and if + // their average CPU usage exceeds the baseline utilization, you will incur a + // charge for surplus credits. The maxTotalPrice does not account for surplus + // credits, and, if you use surplus credits, your final cost might be higher than + // what you specified for maxTotalPrice . For more information, see [Surplus credits can incur charges] in the EC2 + // User Guide. + // + // [Surplus credits can incur charges]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits MaxTotalPrice *string // 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: - // SingleAvailabilityZone | SingleInstanceType + // 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 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 @@ -15222,50 +16394,63 @@ 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) - // 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 - // from the pools that we believe have the lowest chance of interruption in the - // near term. EC2 Fleet then requests Spot Instances from the lowest priced of - // these pools. capacity-optimized 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 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 - // priority for each instance type by using the Priority parameter for + // For more information, see [Allocation strategies for Spot Instances]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 from the pools that we believe + // have the lowest chance of interruption in the near term. EC2 Fleet then requests + // Spot Instances from the lowest priced of these pools. + // + // capacity-optimized 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 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 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. 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 - // 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. - // If the lowest priced pool doesn't have available capacity, the Spot Instances - // come from the next lowest priced pool that has available capacity. If a pool - // runs out of capacity before fulfilling your desired capacity, EC2 Fleet will - // continue to fulfill your request by drawing from the next lowest priced pool. To - // ensure that your desired capacity is met, you might receive Spot Instances from - // several pools. Because this strategy only considers instance price and not - // capacity availability, it might lead to high interruption rates. Default: - // lowest-price + // 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. If the lowest priced pool doesn't have + // available capacity, the Spot Instances come from the next lowest priced pool + // that has available capacity. If a pool runs out of capacity before fulfilling + // your desired capacity, EC2 Fleet will continue to fulfill your request by + // drawing from the next lowest priced pool. To ensure that your desired capacity + // is met, you might receive Spot Instances from several pools. Because this + // strategy only considers instance price and not capacity availability, it might + // lead to high interruption rates. + // + // Default: lowest-price + // + // [Allocation strategies for Spot Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html AllocationStrategy SpotAllocationStrategy - // The behavior when a Spot Instance is interrupted. Default: terminate + // The behavior when a Spot Instance is interrupted. + // + // Default: terminate 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 // 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. + // 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 Spot Instances that are at an elevated risk of @@ -15275,29 +16460,40 @@ type SpotOptionsRequest struct { // 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. If your - // fleet includes T instances that are configured as unlimited , and if their - // average CPU usage exceeds the baseline utilization, you will incur a charge for - // surplus credits. The MaxTotalPrice does not account for surplus credits, and, - // if you use surplus credits, your final cost might be higher than what you - // specified for MaxTotalPrice . For more information, see Surplus credits can - // incur charges (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) - // in the EC2 User Guide. + // Spot price. + // + // If you specify a maximum price, your Spot Instances will be interrupted more + // frequently than if you do not specify this parameter. + // + // If your fleet includes T instances that are configured as unlimited , and if + // their average CPU usage exceeds the baseline utilization, you will incur a + // charge for surplus credits. The MaxTotalPrice does not account for surplus + // credits, and, if you use surplus credits, your final cost might be higher than + // what you specified for MaxTotalPrice . For more information, see [Surplus credits can incur charges] in the EC2 + // User Guide. + // + // [Surplus credits can incur charges]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits MaxTotalPrice *string // 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: - // SingleAvailabilityZone | SingleInstanceType + // 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 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 @@ -15306,8 +16502,10 @@ 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. @@ -15344,8 +16542,10 @@ type SpotPlacementScore struct { // 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. +// 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. @@ -15360,8 +16560,10 @@ type SpotPrice struct { // 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. + // 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, @@ -15378,9 +16580,9 @@ type StaleIpPermission struct { // protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). 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) - // . + // The IP protocol name ( tcp , udp , icmp , icmpv6 ) or number (see [Protocol Numbers)]. + // + // [Protocol Numbers)]: http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml IpProtocol *string // The IP ranges. Not applicable for stale security group rules. @@ -15431,28 +16633,40 @@ 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 from the // operating system of 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. @@ -15514,7 +16728,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. @@ -15540,7 +16754,7 @@ type Subnet struct { // subnet should return synthetic IPv6 addresses for IPv4-only destinations. EnableDns64 *bool - // Indicates the device position for local network interfaces in this subnet. For + // 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). EnableLniAtDeviceIndex *int32 @@ -15552,15 +16766,17 @@ 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 - // address. + // network interface created by RunInstances) receives a customer-owned IPv4 address. MapCustomerOwnedIpOnLaunch *bool // Indicates whether instances launched in this subnet receive a public IPv4 - // address. Amazon Web Services charges for all public IPv4 addresses, including - // public IPv4 addresses associated with running instances and Elastic IP - // addresses. For more information, see the Public IPv4 Address tab on the Amazon - // VPC pricing page (http://aws.amazon.com/vpc/pricing/) . + // address. + // + // Amazon Web Services charges for all public IPv4 addresses, including public + // IPv4 addresses associated with running instances and Elastic IP addresses. For + // more information, see the Public IPv4 Address tab on the [Amazon VPC pricing page]. + // + // [Amazon VPC pricing page]: http://aws.amazon.com/vpc/pricing/ MapPublicIpOnLaunch *bool // The Amazon Resource Name (ARN) of the Outpost. @@ -15646,17 +16862,21 @@ type SubnetCidrReservation struct { type SubnetConfiguration struct { // The IPv4 address to assign to the endpoint network interface in the subnet. You - // must provide an IPv4 address if the VPC endpoint supports IPv4. If you specify - // an IPv4 address when modifying a VPC endpoint, we replace the existing endpoint - // network interface with a new endpoint network interface with this IP address. - // This process temporarily disconnects the subnet and the VPC endpoint. + // must provide an IPv4 address if the VPC endpoint supports IPv4. + // + // If you specify an IPv4 address when modifying a VPC endpoint, we replace the + // existing endpoint network interface with a new endpoint network interface with + // this IP address. This process temporarily disconnects the subnet and the VPC + // endpoint. Ipv4 *string // The IPv6 address to assign to the endpoint network interface in the subnet. You - // must provide an IPv6 address if the VPC endpoint supports IPv6. If you specify - // an IPv6 address when modifying a VPC endpoint, we replace the existing endpoint - // network interface with a new endpoint network interface with this IP address. - // This process temporarily disconnects the subnet and the VPC endpoint. + // must provide an IPv6 address if the VPC endpoint supports IPv6. + // + // If you specify an IPv6 address when modifying a VPC endpoint, we replace the + // existing endpoint network interface with a new endpoint network interface with + // this IP address. This process temporarily disconnects the subnet and the VPC + // endpoint. Ipv6 *string // The ID of the subnet. @@ -15725,12 +16945,16 @@ type SuccessfulQueuedPurchaseDeletion struct { // Describes a tag. 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: . + // The key of the tag. + // + // Constraints: Tag keys are case-sensitive and accept a 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 - // maximum of 256 Unicode characters. + // The value of the tag. + // + // Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode + // characters. Value *string noSmithyDocumentSerde @@ -15756,10 +16980,12 @@ type TagDescription struct { // The tags to apply to a resource when the resource is being created. When you // specify a tag, you must specify the resource type to tag, otherwise the request -// will fail. The Valid Values lists all the resource types that can be tagged. -// However, the action you're using might not support tagging all of these resource -// types. If you try to tag a resource type that is unsupported for the action -// you're using, you'll get an error. +// will fail. +// +// The Valid Values lists all the resource types that can be tagged. However, the +// action you're using might not support tagging all of these resource types. If +// you try to tag a resource type that is unsupported for the action you're using, +// you'll get an error. type TagSpecification struct { // The type of resource to tag on creation. @@ -15774,17 +17000,18 @@ 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 +// 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) -// . +// met the target capacity. The MaxTotalPrice parameters are located in [OnDemandOptions] and [SpotOptions]. +// +// [OnDemandOptions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html +// [SpotOptions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions type TargetCapacitySpecification struct { // The default target capacity type. @@ -15811,16 +17038,19 @@ type TargetCapacitySpecification struct { // 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 -// 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 -// 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 OnDemandOptionsRequest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptionsRequest) -// and SpotOptionsRequest (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptionsRequest) -// . +// 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 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 [OnDemandOptionsRequest]and [SpotOptionsRequest]. +// +// [OnDemandOptionsRequest]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptionsRequest +// [SpotOptionsRequest]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptionsRequest type TargetCapacitySpecificationRequest struct { // The number of units to request, filled using the default target capacity type. @@ -15838,8 +17068,9 @@ type TargetCapacitySpecificationRequest struct { SpotTargetCapacity *int32 // The unit for the target capacity. You can specify this parameter only when - // using attributed-based instance type selection. Default: units (the number of - // instances) + // using attributed-based instance type selection. + // + // Default: units (the number of instances) TargetCapacityUnitType TargetCapacityUnitType noSmithyDocumentSerde @@ -16106,7 +17337,9 @@ type TrafficMirrorSession struct { // The session number determines the order in which sessions are evaluated when an // interface is used by multiple sessions. The first session with a matching filter - // is the one that mirrors the packets. Valid values are 1-32766. + // is the one that mirrors the packets. + // + // Valid values are 1-32766. SessionNumber *int32 // The tags assigned to the Traffic Mirror session. @@ -16419,7 +17652,7 @@ type TransitGatewayMulticastDomain struct { // The options for the transit gateway multicast domain. Options *TransitGatewayMulticastDomainOptions - // The ID of the Amazon Web Services account that owns the transit gateway + // The ID of the Amazon Web Services account that owns the transit gateway // multicast domain. OwnerId *string @@ -16447,7 +17680,7 @@ type TransitGatewayMulticastDomainAssociation struct { // The ID of the resource. ResourceId *string - // The ID of the Amazon Web Services account that owns the transit gateway + // The ID of the Amazon Web Services account that owns the transit gateway // multicast domain association resource. ResourceOwnerId *string @@ -16469,7 +17702,7 @@ type TransitGatewayMulticastDomainAssociations struct { // The ID of the resource. ResourceId *string - // The ID of the Amazon Web Services account that owns the resource. + // The ID of the Amazon Web Services account that owns the resource. ResourceOwnerId *string // The type of resource, for example a VPC attachment. @@ -16526,7 +17759,7 @@ type TransitGatewayMulticastGroup struct { // The ID of the resource. ResourceId *string - // The ID of the Amazon Web Services account that owns the transit gateway + // The ID of the Amazon Web Services account that owns the transit gateway // multicast domain group resource. ResourceOwnerId *string @@ -16607,9 +17840,10 @@ type TransitGatewayOptions struct { // The ID of the default propagation route table. PropagationDefaultRouteTableId *string - // This parameter is in preview and may not be available for your account. Enables - // you to reference a security group across VPCs attached to a transit gateway. Use - // this option to simplify security group management and control of + // This parameter is in preview and may not be available for your account. + // + // Enables you to reference a security group across VPCs attached to a transit + // gateway. Use this option to simplify security group management and control of // instance-to-instance traffic across VPCs that are connected by transit gateway. // You can also use this option to migrate from VPC peering (which was the only // option that supported security group referencing) to transit gateways (which now @@ -16854,9 +18088,10 @@ type TransitGatewayRequestOptions struct { // Indicates whether multicast is enabled on the transit gateway MulticastSupport MulticastSupportValue - // This parameter is in preview and may not be available for your account. Enables - // you to reference a security group across VPCs attached to a transit gateway. Use - // this option to simplify security group management and control of + // This parameter is in preview and may not be available for your account. + // + // Enables you to reference a security group across VPCs attached to a transit + // gateway. Use this option to simplify security group management and control of // instance-to-instance traffic across VPCs that are connected by transit gateway. // You can also use this option to migrate from VPC peering (which was the only // option that supported security group referencing) to transit gateways (which now @@ -17040,7 +18275,9 @@ type TransitGatewayRouteTableRoute struct { ResourceType *string // The route origin. The following are the possible values: + // // - static + // // - propagated RouteOrigin *string @@ -17096,9 +18333,10 @@ type TransitGatewayVpcAttachmentOptions struct { // Indicates whether IPv6 support is disabled. Ipv6Support Ipv6SupportValue - // This parameter is in preview and may not be available for your account. Enables - // you to reference a security group across VPCs attached to a transit gateway. Use - // this option to simplify security group management and control of + // This parameter is in preview and may not be available for your account. + // + // Enables you to reference a security group across VPCs attached to a transit + // gateway. Use this option to simplify security group management and control of // instance-to-instance traffic across VPCs that are connected by transit gateway. // You can also use this option to migrate from VPC peering (which was the only // option that supported security group referencing) to transit gateways (which now @@ -17255,8 +18493,9 @@ 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]. +// +// [Error codes]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html type UnsuccessfulItemError struct { // The error code. @@ -17307,26 +18546,30 @@ type UserData struct { type UserIdGroupPair struct { // A description for the security group rule that references this user ID group - // pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, - // A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* + // pair. + // + // Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, + // 0-9, spaces, and ._-:/()#,@[]+=;{}!$* Description *string // The ID of the security group. GroupId *string // [Default VPC] The name of the security group. For a security group in a - // nondefault VPC, use the security group ID. For a referenced security group in - // another VPC, this value is not returned if the referenced security group is - // deleted. + // nondefault VPC, use the security group ID. + // + // For a referenced security group in another VPC, this value is not returned if + // the referenced security group is deleted. GroupName *string // The status of a VPC peering connection, if applicable. PeeringStatus *string - // The ID of an Amazon Web Services account. For a referenced security group in - // another VPC, the account ID of the referenced security group is returned in the - // response. If the referenced security group is deleted, this value is not - // returned. + // The ID of an Amazon Web Services account. + // + // For a referenced security group in another VPC, the account ID of the + // referenced security group is returned in the response. If the referenced + // security group is deleted, this value is not returned. UserId *string // The ID of the VPC for the referenced security group, if applicable. @@ -17344,13 +18587,15 @@ 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]. + // + // [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]. + // + // [Error codes]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html Message *string noSmithyDocumentSerde @@ -17691,7 +18936,9 @@ type VerifiedAccessLogOptions struct { // Sends Verified Access logs to Kinesis. KinesisDataFirehose *VerifiedAccessLogKinesisDataFirehoseDestinationOptions - // The logging version. Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2 + // The logging version. + // + // Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2 LogVersion *string // Sends Verified Access logs to Amazon S3. @@ -17762,16 +19009,19 @@ type VerifiedAccessLogS3DestinationOptions struct { noSmithyDocumentSerde } -// Verified Access provides server side encryption by default to data at rest +// Verified Access provides server side encryption by default to data at rest +// // using Amazon Web Services-owned KMS keys. You also have the option of using // customer managed KMS keys, which can be specified using the options below. type VerifiedAccessSseSpecificationRequest struct { - // Enable or disable the use of customer managed KMS keys for server side - // encryption. Valid values: True | False + // Enable or disable the use of customer managed KMS keys for server side + // encryption. + // + // Valid values: True | False CustomerManagedKeyEnabled *bool - // The ARN of the KMS key. + // The ARN of the KMS key. KmsKeyArn *string noSmithyDocumentSerde @@ -17781,7 +19031,9 @@ type VerifiedAccessSseSpecificationRequest struct { type VerifiedAccessSseSpecificationResponse struct { // Indicates whether customer managed KMS keys are in use for server side - // encryption. Valid values: True | False + // encryption. + // + // Valid values: True | False CustomerManagedKeyEnabled *bool // The ARN of the KMS key. @@ -17882,8 +19134,9 @@ type VgwTelemetry struct { // Describes a volume. type Volume struct { - // This parameter is not returned by CreateVolume. Information about the volume - // attachments. + // This parameter is not returned by CreateVolume. + // + // Information about the volume attachments. Attachments []VolumeAttachment // The Availability Zone for the volume. @@ -17895,8 +19148,9 @@ type Volume struct { // Indicates whether the volume is encrypted. Encrypted *bool - // This parameter is not returned by CreateVolume. Indicates whether the volume - // was created using fast snapshot restore. + // This parameter is not returned by CreateVolume. + // + // 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 @@ -17921,7 +19175,9 @@ type Volume struct { // The snapshot from which the volume was created, if applicable. SnapshotId *string - // This parameter is not returned by CreateVolume. Reserved for future use. + // This parameter is not returned by CreateVolume. + // + // Reserved for future use. SseType SSEType // The volume state. @@ -17954,17 +19210,20 @@ type VolumeAttachment struct { // Indicates whether the EBS volume is deleted on instance termination. DeleteOnTermination *bool - // The device name. If the volume is attached to a Fargate task, this parameter - // returns null . + // The device name. + // + // If the volume is attached to a Fargate task, this parameter returns null . Device *string - // The ID of the instance. If the volume is attached to a Fargate task, this - // parameter returns null . + // The ID of the instance. + // + // If the volume is attached to a Fargate task, this parameter returns null . InstanceId *string // The service principal of Amazon Web Services service that owns the underlying - // instance to which the volume is attached. This parameter is returned only for - // volumes that are attached to Fargate tasks. + // instance to which the volume is attached. + // + // This parameter is returned only for volumes that are attached to Fargate tasks. InstanceOwningService *string // The attachment state of the volume. @@ -17987,8 +19246,9 @@ 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. @@ -18223,7 +19483,9 @@ type VpcCidrBlockState struct { noSmithyDocumentSerde } -// Deprecated. Describes whether a VPC is enabled for ClassicLink. +// Deprecated. +// +// Describes whether a VPC is enabled for ClassicLink. type VpcClassicLink struct { // Indicates whether the VPC is enabled for ClassicLink. @@ -18462,9 +19724,9 @@ type VpnConnection struct { CoreNetworkAttachmentArn *string // The configuration information for the VPN connection's customer gateway (in the - // native XML format). This element is always present in the CreateVpnConnection - // response; however, it's present in the DescribeVpnConnections response only if - // the VPN connection is in the pending or available state. + // native XML format). This element is always present in the CreateVpnConnectionresponse; however, + // it's present in the DescribeVpnConnectionsresponse only if the VPN connection is in the pending or + // available state. CustomerGatewayConfiguration *string // The ID of the customer gateway at your end of the VPN connection. @@ -18506,8 +19768,10 @@ type VpnConnection struct { // 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. +// configuration files available under [Your customer gateway device]in the Amazon Web Services Site-to-Site VPN +// User Guide. +// +// [Your customer gateway device]: https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html type VpnConnectionDeviceType struct { // Customer gateway device platform. @@ -18538,7 +19802,11 @@ type VpnConnectionOptions struct { LocalIpv6NetworkCidr *string // The type of IPv4 address assigned to the outside interface of the customer - // gateway. Valid values: PrivateIpv4 | PublicIpv4 Default: PublicIpv4 + // gateway. + // + // Valid values: PrivateIpv4 | PublicIpv4 + // + // Default: PublicIpv4 OutsideIpAddressType *string // The IPv4 CIDR on the Amazon Web Services side of the VPN connection. @@ -18566,40 +19834,54 @@ type VpnConnectionOptions struct { // Describes VPN connection options. type VpnConnectionOptionsSpecification struct { - // Indicate whether to enable acceleration for the VPN connection. Default: false + // Indicate whether to enable acceleration for the VPN connection. + // + // Default: false EnableAcceleration *bool // The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. + // // Default: 0.0.0.0/0 LocalIpv4NetworkCidr *string // The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. + // // Default: ::/0 LocalIpv6NetworkCidr *string // The type of IPv4 address assigned to the outside interface of the customer - // gateway device. Valid values: PrivateIpv4 | PublicIpv4 Default: PublicIpv4 + // gateway device. + // + // Valid values: PrivateIpv4 | PublicIpv4 + // + // Default: PublicIpv4 OutsideIpAddressType *string - // The IPv4 CIDR on the Amazon Web Services side of the VPN connection. Default: - // 0.0.0.0/0 + // The IPv4 CIDR on the Amazon Web Services side of the VPN connection. + // + // Default: 0.0.0.0/0 RemoteIpv4NetworkCidr *string - // The IPv6 CIDR on the Amazon Web Services side of the VPN connection. Default: - // ::/0 + // The IPv6 CIDR on the Amazon Web Services side of the VPN connection. + // + // Default: ::/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 + // 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 . + // The transit gateway attachment ID to use for the VPN tunnel. + // + // Required if OutsideIpAddressType is set to PrivateIpv4 . TransportTransitGatewayAttachmentId *string - // Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. Default: ipv4 + // Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. + // + // Default: ipv4 TunnelInsideIpVersion TunnelInsideIpVersion // The tunnel options for the VPN connection. @@ -18673,104 +19955,150 @@ type VpnTunnelLogOptionsSpecification struct { type VpnTunnelOptionsSpecification struct { // The action to take after DPD timeout occurs. Specify restart to restart the IKE - // initiation. Specify clear to end the IKE session. Valid Values: clear | none | - // restart Default: clear + // initiation. Specify clear to end the IKE session. + // + // Valid Values: clear | none | restart + // + // Default: clear DPDTimeoutAction *string - // The number of seconds after which a DPD timeout occurs. Constraints: A value - // greater than or equal to 30. Default: 30 + // The number of seconds after which a DPD timeout occurs. + // + // Constraints: A value greater than or equal to 30. + // + // Default: 30 DPDTimeoutSeconds *int32 // Turn on or off tunnel endpoint lifecycle control feature. EnableTunnelLifecycleControl *bool - // The IKE versions that are permitted for the VPN tunnel. Valid values: ikev1 | - // ikev2 + // The IKE versions that are permitted for the VPN tunnel. + // + // Valid values: ikev1 | ikev2 IKEVersions []IKEVersionsRequestListValue // Options for logging VPN tunnel activity. LogOptions *VpnTunnelLogOptionsSpecification // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 1 IKE negotiations. Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 - // | 21 | 22 | 23 | 24 + // for phase 1 IKE negotiations. + // + // Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 Phase1DHGroupNumbers []Phase1DHGroupNumbersRequestListValue // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 1 IKE negotiations. Valid values: AES128 | AES256 | AES128-GCM-16 | - // AES256-GCM-16 + // phase 1 IKE negotiations. + // + // Valid values: AES128 | AES256 | AES128-GCM-16 | 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 + // 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 - // value between 900 and 28,800. Default: 28800 + // The lifetime for phase 1 of the IKE negotiation, in seconds. + // + // Constraints: A value between 900 and 28,800. + // + // Default: 28800 Phase1LifetimeSeconds *int32 // One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel - // for phase 2 IKE negotiations. Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 - // | 20 | 21 | 22 | 23 | 24 + // for phase 2 IKE negotiations. + // + // Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 Phase2DHGroupNumbers []Phase2DHGroupNumbersRequestListValue // One or more encryption algorithms that are permitted for the VPN tunnel for - // phase 2 IKE negotiations. Valid values: AES128 | AES256 | AES128-GCM-16 | - // AES256-GCM-16 + // phase 2 IKE negotiations. + // + // Valid values: AES128 | AES256 | AES128-GCM-16 | 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 + // 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 + // 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 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). + // 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 + // 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: 270 + // RekeyFuzzPercentage . + // + // Constraints: A value between 60 and half of Phase2LifetimeSeconds . + // + // Default: 270 RekeyMarginTimeSeconds *int32 - // The number of packets in an IKE replay window. Constraints: A value between 64 - // and 2048. Default: 1024 + // The number of packets in an IKE replay window. + // + // Constraints: A value between 64 and 2048. + // + // Default: 1024 ReplayWindowSize *int32 // The action to take when the establishing the tunnel for the VPN connection. By // default, your customer gateway device must initiate the IKE negotiation and // bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE - // negotiation. Valid Values: add | start Default: add + // negotiation. + // + // Valid Values: add | start + // + // Default: add StartupAction *string // The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks // 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: + // 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 TunnelInsideCidr *string // The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks // must be unique across all VPN connections that use the same transit gateway. + // // Constraints: A size /126 CIDR block from the local fd00::/8 range. TunnelInsideIpv6Cidr *string diff --git a/service/ec2instanceconnect/api_op_SendSSHPublicKey.go b/service/ec2instanceconnect/api_op_SendSSHPublicKey.go index 0da1fc73409..29f8f7289bf 100644 --- a/service/ec2instanceconnect/api_op_SendSSHPublicKey.go +++ b/service/ec2instanceconnect/api_op_SendSSHPublicKey.go @@ -11,9 +11,10 @@ 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) -// in the Amazon EC2 User Guide. +// user. The key remains for 60 seconds. For more information, see [Connect to your Linux instance using EC2 Instance Connect]in the Amazon +// EC2 User Guide. +// +// [Connect to your Linux instance using EC2 Instance Connect]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html func (c *Client) SendSSHPublicKey(ctx context.Context, params *SendSSHPublicKeyInput, optFns ...func(*Options)) (*SendSSHPublicKeyOutput, error) { if params == nil { params = &SendSSHPublicKeyInput{} diff --git a/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go b/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go index 0753b21bf29..8c688d502a3 100644 --- a/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go +++ b/service/ec2instanceconnect/api_op_SendSerialConsoleSSHPublicKey.go @@ -12,8 +12,9 @@ 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]in the Amazon EC2 User Guide. +// +// [EC2 Serial Console]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html func (c *Client) SendSerialConsoleSSHPublicKey(ctx context.Context, params *SendSerialConsoleSSHPublicKeyInput, optFns ...func(*Options)) (*SendSerialConsoleSSHPublicKeyOutput, error) { if params == nil { params = &SendSerialConsoleSSHPublicKeyInput{} @@ -37,14 +38,16 @@ type SendSerialConsoleSSHPublicKeyInput struct { InstanceId *string // 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) + // private key. For information about the supported key formats and lengths, see [Requirements for key pairs] // in the Amazon EC2 User Guide. // + // [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 + // // This member is required. SSHPublicKey *string // The serial port of the EC2 instance. Currently only port 0 is supported. + // // Default: 0 SerialPort int32 diff --git a/service/ec2instanceconnect/doc.go b/service/ec2instanceconnect/doc.go index 24d597ecd9f..b840fa20baa 100644 --- a/service/ec2instanceconnect/doc.go +++ b/service/ec2instanceconnect/doc.go @@ -7,9 +7,13 @@ // descriptions, syntax, and usage examples for each of the actions for Amazon EC2 // Instance Connect. Amazon EC2 Instance Connect enables system administrators to // publish one-time use SSH public keys to EC2, providing users a simple and secure -// way to connect to their instances. To view the Amazon EC2 Instance Connect -// content in the Amazon EC2 User Guide, see Connect to your Linux instance using -// EC2 Instance Connect (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html) -// . For Amazon EC2 APIs, see the Amazon EC2 API Reference (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html) -// . +// way to connect to their instances. +// +// To view the Amazon EC2 Instance Connect content in the Amazon EC2 User Guide, +// see [Connect to your Linux instance using EC2 Instance Connect]. +// +// For Amazon EC2 APIs, see the [Amazon EC2 API Reference]. +// +// [Connect to your Linux instance using EC2 Instance Connect]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect.html +// [Amazon EC2 API Reference]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html package ec2instanceconnect diff --git a/service/ec2instanceconnect/options.go b/service/ec2instanceconnect/options.go index 2816b454b5d..f402ae4d74a 100644 --- a/service/ec2instanceconnect/options.go +++ b/service/ec2instanceconnect/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ec2instanceconnect/types/errors.go b/service/ec2instanceconnect/types/errors.go index 4a6ef8eb582..c97bb716a52 100644 --- a/service/ec2instanceconnect/types/errors.go +++ b/service/ec2instanceconnect/types/errors.go @@ -168,9 +168,10 @@ func (e *InvalidArgsException) ErrorCode() string { func (e *InvalidArgsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// in the Amazon EC2 API Reference. +// account, run the EnableSerialConsoleAccess API. For more information, see [EnableSerialConsoleAccess]in +// the Amazon EC2 API Reference. +// +// [EnableSerialConsoleAccess]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableSerialConsoleAccess.html type SerialConsoleAccessDisabledException struct { Message *string diff --git a/service/ecr/api_op_BatchCheckLayerAvailability.go b/service/ecr/api_op_BatchCheckLayerAvailability.go index a3c278bc982..6416742e4cd 100644 --- a/service/ecr/api_op_BatchCheckLayerAvailability.go +++ b/service/ecr/api_op_BatchCheckLayerAvailability.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Checks the availability of one or more image layers in a repository. 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. +// Checks the availability of one or more image layers in a repository. +// +// 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. diff --git a/service/ecr/api_op_BatchDeleteImage.go b/service/ecr/api_op_BatchDeleteImage.go index d9846d25858..f91cf77690a 100644 --- a/service/ecr/api_op_BatchDeleteImage.go +++ b/service/ecr/api_op_BatchDeleteImage.go @@ -12,10 +12,14 @@ 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 -// 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. +// 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. func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageInput, optFns ...func(*Options)) (*BatchDeleteImageOutput, error) { if params == nil { params = &BatchDeleteImageInput{} diff --git a/service/ecr/api_op_BatchGetImage.go b/service/ecr/api_op_BatchGetImage.go index 756873b39fc..5cfd40f354d 100644 --- a/service/ecr/api_op_BatchGetImage.go +++ b/service/ecr/api_op_BatchGetImage.go @@ -12,8 +12,10 @@ 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 -// called once to retrieve the image manifest. +// 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 { params = &BatchGetImageInput{} @@ -42,8 +44,9 @@ type BatchGetImageInput struct { // This member is required. RepositoryName *string - // The accepted media types for the request. Valid values: - // application/vnd.docker.distribution.manifest.v1+json | + // The accepted media types for the request. + // + // Valid values: application/vnd.docker.distribution.manifest.v1+json | // application/vnd.docker.distribution.manifest.v2+json | // application/vnd.oci.image.manifest.v1+json AcceptedMediaTypes []string diff --git a/service/ecr/api_op_CompleteLayerUpload.go b/service/ecr/api_op_CompleteLayerUpload.go index a145f4d5a67..f0b19acac2d 100644 --- a/service/ecr/api_op_CompleteLayerUpload.go +++ b/service/ecr/api_op_CompleteLayerUpload.go @@ -12,11 +12,14 @@ import ( // Informs Amazon ECR that the image layer upload has completed for a specified // registry, repository name, and upload ID. You can optionally provide a sha256 -// digest of the image layer for data validation purposes. When an image is pushed, -// the CompleteLayerUpload API is called once per each new image layer to verify -// that the upload has completed. 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. +// digest of the image layer for data validation purposes. +// +// When an image is pushed, the CompleteLayerUpload API is called once per each +// new image layer to verify that the upload has completed. +// +// 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) CompleteLayerUpload(ctx context.Context, params *CompleteLayerUploadInput, optFns ...func(*Options)) (*CompleteLayerUploadOutput, error) { if params == nil { params = &CompleteLayerUploadInput{} @@ -44,8 +47,7 @@ type CompleteLayerUploadInput struct { // This member is required. RepositoryName *string - // The upload ID from a previous InitiateLayerUpload operation to associate with - // the image layer. + // The upload ID from a previous InitiateLayerUpload operation to associate with the image layer. // // This member is required. UploadId *string diff --git a/service/ecr/api_op_CreatePullThroughCacheRule.go b/service/ecr/api_op_CreatePullThroughCacheRule.go index 8e0f2f8de6a..fe862865f78 100644 --- a/service/ecr/api_op_CreatePullThroughCacheRule.go +++ b/service/ecr/api_op_CreatePullThroughCacheRule.go @@ -14,8 +14,10 @@ import ( // Creates a pull through cache rule. A pull through cache rule provides a way to // cache images from an upstream registry source in your Amazon ECR private -// registry. For more information, see Using pull through cache rules (https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html) -// in the Amazon Elastic Container Registry User Guide. +// registry. For more information, see [Using pull through cache rules]in the Amazon Elastic Container Registry +// User Guide. +// +// [Using pull through cache rules]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html func (c *Client) CreatePullThroughCacheRule(ctx context.Context, params *CreatePullThroughCacheRuleInput, optFns ...func(*Options)) (*CreatePullThroughCacheRuleOutput, error) { if params == nil { params = &CreatePullThroughCacheRuleInput{} @@ -41,11 +43,17 @@ type CreatePullThroughCacheRuleInput struct { // The registry URL of the upstream public registry to use as the source for the // pull through cache rule. The following is the syntax to use for each supported // upstream registry. + // // - Amazon ECR Public ( ecr-public ) - public.ecr.aws + // // - Docker Hub ( docker-hub ) - registry-1.docker.io + // // - Quay ( quay ) - quay.io + // // - Kubernetes ( k8s ) - registry.k8s.io + // // - GitHub Container Registry ( github-container-registry ) - ghcr.io + // // - Microsoft Azure Container Registry ( azure-container-registry ) - // .azurecr.io // diff --git a/service/ecr/api_op_CreateRepository.go b/service/ecr/api_op_CreateRepository.go index 87088e1dd89..4bdb61811e5 100644 --- a/service/ecr/api_op_CreateRepository.go +++ b/service/ecr/api_op_CreateRepository.go @@ -11,8 +11,10 @@ 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] in the Amazon Elastic +// Container Registry User Guide. +// +// [Amazon ECR repositories]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error) { if params == nil { params = &CreateRepositoryInput{} @@ -32,9 +34,10 @@ 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 ). The - // repository name must start with a letter and can only contain lowercase letters, - // numbers, hyphens, underscores, and forward slashes. + // the repository into a category (such as project-a/nginx-web-app ). + // + // The repository name must start with a letter and can only contain lowercase + // letters, numbers, hyphens, underscores, and forward slashes. // // This member is required. RepositoryName *string diff --git a/service/ecr/api_op_DescribeImageScanFindings.go b/service/ecr/api_op_DescribeImageScanFindings.go index 1947caec398..53d64f7ac94 100644 --- a/service/ecr/api_op_DescribeImageScanFindings.go +++ b/service/ecr/api_op_DescribeImageScanFindings.go @@ -307,12 +307,13 @@ type ImageScanCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImageScanFindingsInput, *DescribeImageScanFindingsOutput, error) (bool, error) } diff --git a/service/ecr/api_op_DescribeImages.go b/service/ecr/api_op_DescribeImages.go index 70894b9e57e..8200fb0a454 100644 --- a/service/ecr/api_op_DescribeImages.go +++ b/service/ecr/api_op_DescribeImages.go @@ -11,11 +11,12 @@ 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{} diff --git a/service/ecr/api_op_DescribeRegistry.go b/service/ecr/api_op_DescribeRegistry.go index c6eeffe540a..e0affed0b7b 100644 --- a/service/ecr/api_op_DescribeRegistry.go +++ b/service/ecr/api_op_DescribeRegistry.go @@ -12,8 +12,7 @@ import ( ) // Describes the settings for a registry. The replication configuration for a -// repository can be created or updated with the PutReplicationConfiguration API -// action. +// repository can be created or updated with the PutReplicationConfigurationAPI action. func (c *Client) DescribeRegistry(ctx context.Context, params *DescribeRegistryInput, optFns ...func(*Options)) (*DescribeRegistryOutput, error) { if params == nil { params = &DescribeRegistryInput{} diff --git a/service/ecr/api_op_DescribeRepositories.go b/service/ecr/api_op_DescribeRepositories.go index e2b89ff3c2d..75c1f0e098d 100644 --- a/service/ecr/api_op_DescribeRepositories.go +++ b/service/ecr/api_op_DescribeRepositories.go @@ -45,9 +45,10 @@ 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 - // only used to retrieve the next items in a list and not for other programmatic - // purposes. + // 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 // The Amazon Web Services account ID associated with the registry that contains diff --git a/service/ecr/api_op_GetAuthorizationToken.go b/service/ecr/api_op_GetAuthorizationToken.go index 842f8768b1a..30d7a340779 100644 --- a/service/ecr/api_op_GetAuthorizationToken.go +++ b/service/ecr/api_op_GetAuthorizationToken.go @@ -14,11 +14,14 @@ import ( // Retrieves an authorization token. An authorization token represents your IAM // authentication credentials and can be used to access any Amazon ECR registry // that your IAM principal has access to. The authorization token is valid for 12 -// 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) -// in the Amazon Elastic Container Registry User Guide. +// 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]in the Amazon Elastic Container Registry User Guide. +// +// [Registry authentication]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error) { if params == nil { params = &GetAuthorizationTokenInput{} diff --git a/service/ecr/api_op_GetDownloadUrlForLayer.go b/service/ecr/api_op_GetDownloadUrlForLayer.go index 80808c74002..40e0d0c3e1a 100644 --- a/service/ecr/api_op_GetDownloadUrlForLayer.go +++ b/service/ecr/api_op_GetDownloadUrlForLayer.go @@ -12,10 +12,13 @@ import ( // 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. +// +// 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 { params = &GetDownloadUrlForLayerInput{} diff --git a/service/ecr/api_op_GetLifecyclePolicyPreview.go b/service/ecr/api_op_GetLifecyclePolicyPreview.go index c88325e08c1..de1c6eff89b 100644 --- a/service/ecr/api_op_GetLifecyclePolicyPreview.go +++ b/service/ecr/api_op_GetLifecyclePolicyPreview.go @@ -321,12 +321,13 @@ type LifecyclePolicyPreviewCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetLifecyclePolicyPreviewInput, *GetLifecyclePolicyPreviewOutput, error) (bool, error) } diff --git a/service/ecr/api_op_InitiateLayerUpload.go b/service/ecr/api_op_InitiateLayerUpload.go index 678763f4ddb..805aca7746f 100644 --- a/service/ecr/api_op_InitiateLayerUpload.go +++ b/service/ecr/api_op_InitiateLayerUpload.go @@ -10,13 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Notifies Amazon ECR that you intend to upload an image layer. When an image is -// pushed, the InitiateLayerUpload API is called once per image layer that has not -// already been uploaded. Whether or not an image layer has been uploaded is -// determined by the BatchCheckLayerAvailability API action. 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. +// Notifies Amazon ECR that you intend to upload an image layer. +// +// When an image is pushed, the InitiateLayerUpload API is called once per image +// layer that has not already been uploaded. Whether or not an image layer has been +// uploaded is determined by the BatchCheckLayerAvailability API action. +// +// 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) InitiateLayerUpload(ctx context.Context, params *InitiateLayerUploadInput, optFns ...func(*Options)) (*InitiateLayerUploadOutput, error) { if params == nil { params = &InitiateLayerUploadInput{} @@ -52,8 +54,8 @@ type InitiateLayerUploadOutput struct { // The size, in bytes, that Amazon ECR expects future layer part uploads to be. PartSize *int64 - // The upload ID for the layer upload. This parameter is passed to further - // UploadLayerPart and CompleteLayerUpload operations. + // The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload + // operations. UploadId *string // Metadata pertaining to the operation's result. diff --git a/service/ecr/api_op_ListImages.go b/service/ecr/api_op_ListImages.go index 95a1ce2ca3f..bd72a9816e9 100644 --- a/service/ecr/api_op_ListImages.go +++ b/service/ecr/api_op_ListImages.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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. +// 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 results to return only UNTAGGED images and then pipe that +// result to a BatchDeleteImageoperation to delete them. Or, you can filter your results to return +// only TAGGED images to list all of the tags in your repository. func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns ...func(*Options)) (*ListImagesOutput, error) { if params == nil { params = &ListImagesInput{} @@ -55,6 +56,7 @@ type ListImagesInput struct { // 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 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 diff --git a/service/ecr/api_op_PutImage.go b/service/ecr/api_op_PutImage.go index 3bbebb033e3..fc19a48a037 100644 --- a/service/ecr/api_op_PutImage.go +++ b/service/ecr/api_op_PutImage.go @@ -11,12 +11,15 @@ 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 e8ff335886f..b3a189ae0c1 100644 --- a/service/ecr/api_op_PutImageScanningConfiguration.go +++ b/service/ecr/api_op_PutImageScanningConfiguration.go @@ -13,8 +13,9 @@ 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 -// configuration for the specified repository. +// 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 { params = &PutImageScanningConfigurationInput{} diff --git a/service/ecr/api_op_PutImageTagMutability.go b/service/ecr/api_op_PutImageTagMutability.go index 8fde2774f6b..800bfd905e3 100644 --- a/service/ecr/api_op_PutImageTagMutability.go +++ b/service/ecr/api_op_PutImageTagMutability.go @@ -12,8 +12,9 @@ import ( ) // 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. +// more information, see [Image tag mutability]in the Amazon Elastic Container Registry User Guide. +// +// [Image tag mutability]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html func (c *Client) PutImageTagMutability(ctx context.Context, params *PutImageTagMutabilityInput, optFns ...func(*Options)) (*PutImageTagMutabilityOutput, error) { if params == nil { params = &PutImageTagMutabilityInput{} diff --git a/service/ecr/api_op_PutLifecyclePolicy.go b/service/ecr/api_op_PutLifecyclePolicy.go index 133ddac4eef..7ed91a26c10 100644 --- a/service/ecr/api_op_PutLifecyclePolicy.go +++ b/service/ecr/api_op_PutLifecyclePolicy.go @@ -11,8 +11,9 @@ 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]. +// +// [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 92ca78c10f1..7426d817486 100644 --- a/service/ecr/api_op_PutRegistryPolicy.go +++ b/service/ecr/api_op_PutRegistryPolicy.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Elastic Container Registry User Guide. +// 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]in the Amazon Elastic Container Registry User Guide. +// +// [Registry permissions]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html func (c *Client) PutRegistryPolicy(ctx context.Context, params *PutRegistryPolicyInput, optFns ...func(*Options)) (*PutRegistryPolicyOutput, error) { if params == nil { params = &PutRegistryPolicyInput{} @@ -33,8 +35,10 @@ 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) - // in the Amazon Elastic Container Registry User Guide. + // same format as IAM policy text. For more information, see [Registry permissions]in the Amazon Elastic + // Container Registry User Guide. + // + // [Registry permissions]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html // // This member is required. PolicyText *string diff --git a/service/ecr/api_op_PutRegistryScanningConfiguration.go b/service/ecr/api_op_PutRegistryScanningConfiguration.go index 74e4ac2895e..9619bd4c87d 100644 --- a/service/ecr/api_op_PutRegistryScanningConfiguration.go +++ b/service/ecr/api_op_PutRegistryScanningConfiguration.go @@ -34,15 +34,18 @@ type PutRegistryScanningConfigurationInput struct { // 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 - // 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 - // automated vulnerability scanning. You may choose between continuous scanning or - // scan on push and you may specify filters to determine which individual - // repositories, or all repositories, are scanned. + // 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 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 automated + // vulnerability scanning. You may choose between continuous scanning or scan on + // push and you may specify filters to determine which individual repositories, or + // all repositories, are scanned. ScanType types.ScanType noSmithyDocumentSerde diff --git a/service/ecr/api_op_PutReplicationConfiguration.go b/service/ecr/api_op_PutReplicationConfiguration.go index 9d5b3cc821e..e8a53dd8f7e 100644 --- a/service/ecr/api_op_PutReplicationConfiguration.go +++ b/service/ecr/api_op_PutReplicationConfiguration.go @@ -12,15 +12,16 @@ import ( ) // Creates or updates the replication configuration for a registry. The existing -// replication configuration for a repository can be retrieved with the -// 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) -// 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 . +// replication configuration for a repository can be retrieved with the DescribeRegistryAPI +// 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]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. +// +// [Using service-linked roles for Amazon ECR]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html 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 62a700b2ad0..61a0847a351 100644 --- a/service/ecr/api_op_SetRepositoryPolicy.go +++ b/service/ecr/api_op_SetRepositoryPolicy.go @@ -11,8 +11,10 @@ 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) -// in the Amazon Elastic Container Registry User Guide. +// permissions. For more information, see [Amazon ECR Repository policies]in the Amazon Elastic Container Registry +// User Guide. +// +// [Amazon ECR Repository policies]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, optFns ...func(*Options)) (*SetRepositoryPolicyOutput, error) { if params == nil { params = &SetRepositoryPolicyInput{} @@ -31,8 +33,9 @@ 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) - // in the Amazon Elastic Container Registry User Guide. + // information, see [Amazon ECR repository policies]in the Amazon Elastic Container Registry User Guide. + // + // [Amazon ECR repository policies]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html // // This member is required. PolicyText *string @@ -43,9 +46,8 @@ type SetRepositoryPolicyInput struct { 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 - // SetRepositoryPolicy operation. This is intended to prevent accidental repository - // lock outs. + // you from setting another policy in the future, you must force the SetRepositoryPolicyoperation. + // This is intended to prevent accidental repository lock outs. Force bool // The Amazon Web Services account ID associated with the registry that contains diff --git a/service/ecr/api_op_StartImageScan.go b/service/ecr/api_op_StartImageScan.go index 1a2cd6eb728..075fb0a157d 100644 --- a/service/ecr/api_op_StartImageScan.go +++ b/service/ecr/api_op_StartImageScan.go @@ -13,8 +13,10 @@ 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]in the Amazon Elastic Container +// Registry User Guide. +// +// [Image scanning]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html 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_UploadLayerPart.go b/service/ecr/api_op_UploadLayerPart.go index b5160be8d58..d3b8634cad1 100644 --- a/service/ecr/api_op_UploadLayerPart.go +++ b/service/ecr/api_op_UploadLayerPart.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads an image layer part to Amazon ECR. When an image is pushed, each new -// image layer is uploaded in parts. The maximum size of each image layer part can -// be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per -// each new image layer part. 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. +// Uploads an image layer part to Amazon ECR. +// +// When an image is pushed, each new image layer is uploaded in parts. The maximum +// size of each image layer part can be 20971520 bytes (or about 20MB). The +// UploadLayerPart API is called once per each new image layer part. +// +// 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) UploadLayerPart(ctx context.Context, params *UploadLayerPartInput, optFns ...func(*Options)) (*UploadLayerPartOutput, error) { if params == nil { params = &UploadLayerPartInput{} @@ -53,8 +56,8 @@ type UploadLayerPartInput struct { // This member is required. RepositoryName *string - // The upload ID from a previous InitiateLayerUpload operation to associate with - // the layer part upload. + // The upload ID from a previous InitiateLayerUpload operation to associate with the layer part + // upload. // // This member is required. UploadId *string diff --git a/service/ecr/api_op_ValidatePullThroughCacheRule.go b/service/ecr/api_op_ValidatePullThroughCacheRule.go index 7a97f666052..e7ec596e89f 100644 --- a/service/ecr/api_op_ValidatePullThroughCacheRule.go +++ b/service/ecr/api_op_ValidatePullThroughCacheRule.go @@ -53,8 +53,9 @@ type ValidatePullThroughCacheRuleOutput struct { EcrRepositoryPrefix *string // The reason the validation failed. For more details about possible causes and - // how to address them, see Using pull through cache rules (https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html) - // in the Amazon Elastic Container Registry User Guide. + // how to address them, see [Using pull through cache rules]in the Amazon Elastic Container Registry User Guide. + // + // [Using pull through cache rules]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html Failure *string // Whether or not the pull through cache rule was validated. If true , Amazon ECR diff --git a/service/ecr/doc.go b/service/ecr/doc.go index cd150610d4e..6ea924b0538 100644 --- a/service/ecr/doc.go +++ b/service/ecr/doc.go @@ -3,14 +3,18 @@ // 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]in the Amazon Web Services General Reference. +// +// [Amazon ECR endpoints]: https://docs.aws.amazon.com/general/latest/gr/ecr.html package ecr diff --git a/service/ecr/options.go b/service/ecr/options.go index 0de783e381c..35ea112430e 100644 --- a/service/ecr/options.go +++ b/service/ecr/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ecr/types/enums.go b/service/ecr/types/enums.go index 1ff5684677f..cbf22299402 100644 --- a/service/ecr/types/enums.go +++ b/service/ecr/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "AES256", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for FindingSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingSeverity) Values() []FindingSeverity { return []FindingSeverity{ "INFORMATIONAL", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for ImageActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageActionType) Values() []ImageActionType { return []ImageActionType{ "EXPIRE", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for ImageFailureCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageFailureCode) Values() []ImageFailureCode { return []ImageFailureCode{ "InvalidImageDigest", @@ -105,8 +109,9 @@ const ( ) // Values returns all known values for ImageTagMutability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageTagMutability) Values() []ImageTagMutability { return []ImageTagMutability{ "MUTABLE", @@ -123,8 +128,9 @@ const ( ) // Values returns all known values for LayerAvailability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LayerAvailability) Values() []LayerAvailability { return []LayerAvailability{ "AVAILABLE", @@ -141,8 +147,9 @@ const ( ) // Values returns all known values for LayerFailureCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LayerFailureCode) Values() []LayerFailureCode { return []LayerFailureCode{ "InvalidLayerDigest", @@ -162,8 +169,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyPreviewStatus) Values() []LifecyclePolicyPreviewStatus { return []LifecyclePolicyPreviewStatus{ "IN_PROGRESS", @@ -183,8 +191,9 @@ const ( ) // Values returns all known values for ReplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStatus) Values() []ReplicationStatus { return []ReplicationStatus{ "IN_PROGRESS", @@ -201,8 +210,9 @@ const ( ) // Values returns all known values for RepositoryFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositoryFilterType) Values() []RepositoryFilterType { return []RepositoryFilterType{ "PREFIX_MATCH", @@ -219,8 +229,9 @@ const ( ) // Values returns all known values for ScanFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanFrequency) Values() []ScanFrequency { return []ScanFrequency{ "SCAN_ON_PUSH", @@ -238,8 +249,9 @@ const ( // Values returns all known values for ScanningConfigurationFailureCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanningConfigurationFailureCode) Values() []ScanningConfigurationFailureCode { return []ScanningConfigurationFailureCode{ "REPOSITORY_NOT_FOUND", @@ -255,8 +267,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanningRepositoryFilterType) Values() []ScanningRepositoryFilterType { return []ScanningRepositoryFilterType{ "WILDCARD", @@ -278,8 +291,9 @@ const ( ) // Values returns all known values for ScanStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanStatus) Values() []ScanStatus { return []ScanStatus{ "IN_PROGRESS", @@ -302,8 +316,9 @@ const ( ) // Values returns all known values for ScanType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanType) Values() []ScanType { return []ScanType{ "BASIC", @@ -321,8 +336,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -344,8 +360,9 @@ const ( ) // Values returns all known values for UpstreamRegistry. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpstreamRegistry) Values() []UpstreamRegistry { return []UpstreamRegistry{ "ecr-public", diff --git a/service/ecr/types/errors.go b/service/ecr/types/errors.go index 01365bf0bf9..9ad9ce33104 100644 --- a/service/ecr/types/errors.go +++ b/service/ecr/types/errors.go @@ -472,8 +472,10 @@ func (e *LifecyclePolicyPreviewNotFoundException) ErrorFault() smithy.ErrorFault } // 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. +// for your account. For more information, see [Amazon ECR service quotas]in the Amazon Elastic Container +// Registry User Guide. +// +// [Amazon ECR service quotas]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html type LimitExceededException struct { Message *string diff --git a/service/ecr/types/types.go b/service/ecr/types/types.go index e707591dfa9..a85a62b8899 100644 --- a/service/ecr/types/types.go +++ b/service/ecr/types/types.go @@ -127,38 +127,45 @@ type CvssScoreDetails struct { // An object representing a filter on a DescribeImages operation. 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 . + // The tag status with which to filter your DescribeImages results. You can filter results based + // on whether they are TAGGED or UNTAGGED . TagStatus TagStatus noSmithyDocumentSerde } // The encryption configuration for the repository. This determines how the -// contents of your repository are encrypted at rest. By default, when no -// encryption configuration is set or the AES256 encryption type is used, Amazon -// ECR uses server-side encryption with Amazon S3-managed encryption keys which -// encrypts your data at rest using an AES-256 encryption algorithm. This does not -// 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) -// in the Amazon Elastic Container Registry User Guide. +// contents of your repository are encrypted at rest. +// +// By default, when no encryption configuration is set or the AES256 encryption +// type is used, Amazon ECR uses server-side encryption with Amazon S3-managed +// encryption keys which encrypts your data at rest using an AES-256 encryption +// algorithm. This does not 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]in +// the Amazon Elastic Container Registry User Guide. +// +// [Amazon ECR encryption at rest]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html type EncryptionConfiguration struct { - // The encryption type to use. If you use the KMS encryption type, the contents of - // the repository will be encrypted using server-side encryption with Key - // Management Service key stored in KMS. When you use KMS to encrypt your data, you - // 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) - // in the Amazon Simple Storage Service Console Developer Guide. + // The encryption type to use. + // + // If you use the KMS encryption type, the contents of the repository will be + // encrypted using server-side encryption with Key Management Service key stored in + // KMS. When you use KMS to encrypt your data, you 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)]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)]in + // the Amazon Simple Storage Service Console Developer Guide. + // + // [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html + // [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 // // This member is required. EncryptionType EncryptionType @@ -268,24 +275,29 @@ type ImageDetail struct { // The current state of the scan. ImageScanStatus *ImageScanStatus - // The size, in bytes, of the image in the repository. If the image is a manifest - // list, this will be the max size of all manifests in the list. 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 . + // The size, in bytes, of the image in the repository. + // + // If the image is a manifest list, this will be the max size of all manifests in + // the list. + // + // 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. 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. + // 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 @@ -407,8 +419,9 @@ 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 // 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) - // API. + // scanned unless a scan is manually started with the [API_StartImageScan]API. + // + // [API_StartImageScan]: https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartImageScan.html ScanOnPush bool noSmithyDocumentSerde @@ -513,8 +526,8 @@ type LifecyclePolicyRuleAction struct { // An object representing a filter on a ListImages operation. 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 . + // The tag status with which to filter your ListImages results. You can filter results based + // on whether they are TAGGED or UNTAGGED . TagStatus TagStatus noSmithyDocumentSerde @@ -815,8 +828,9 @@ type ResourceDetails struct { } // 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) -// in the Amazon Elastic Container Registry User Guide. +// filters, see [Using filters]in the Amazon Elastic Container Registry User Guide. +// +// [Using filters]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters type ScanningRepositoryFilter struct { // The filter to use when scanning. diff --git a/service/ecrpublic/api_op_BatchCheckLayerAvailability.go b/service/ecrpublic/api_op_BatchCheckLayerAvailability.go index ab4cb1e548e..85f4a5fa1a5 100644 --- a/service/ecrpublic/api_op_BatchCheckLayerAvailability.go +++ b/service/ecrpublic/api_op_BatchCheckLayerAvailability.go @@ -14,9 +14,11 @@ import ( // 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. +// 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 4ff2a07ef78..5e0895fdbb4 100644 --- a/service/ecrpublic/api_op_BatchDeleteImage.go +++ b/service/ecrpublic/api_op_BatchDeleteImage.go @@ -12,11 +12,14 @@ 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 -// 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 digest of the image in your request. +// 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 specifying the +// digest of the image in your request. func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageInput, optFns ...func(*Options)) (*BatchDeleteImageOutput, error) { if params == nil { params = &BatchDeleteImageInput{} diff --git a/service/ecrpublic/api_op_CompleteLayerUpload.go b/service/ecrpublic/api_op_CompleteLayerUpload.go index 7a95db650f0..30955ac17de 100644 --- a/service/ecrpublic/api_op_CompleteLayerUpload.go +++ b/service/ecrpublic/api_op_CompleteLayerUpload.go @@ -12,11 +12,14 @@ import ( // Informs Amazon ECR that the image layer upload is complete for a specified // public registry, repository name, and upload ID. You can optionally provide a -// sha256 digest of the image layer for data validation purposes. When an image is -// pushed, the CompleteLayerUpload API is called once for each new image layer to -// verify that the upload is complete. 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. +// sha256 digest of the image layer for data validation purposes. +// +// When an image is pushed, the CompleteLayerUpload API is called once for each +// new image layer to verify that the upload is complete. +// +// 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) CompleteLayerUpload(ctx context.Context, params *CompleteLayerUploadInput, optFns ...func(*Options)) (*CompleteLayerUploadOutput, error) { if params == nil { params = &CompleteLayerUploadInput{} @@ -45,8 +48,7 @@ type CompleteLayerUploadInput struct { // This member is required. RepositoryName *string - // The upload ID from a previous InitiateLayerUpload operation to associate with - // the image layer. + // The upload ID from a previous InitiateLayerUpload operation to associate with the image layer. // // This member is required. UploadId *string diff --git a/service/ecrpublic/api_op_CreateRepository.go b/service/ecrpublic/api_op_CreateRepository.go index 812926059a2..b85196acea3 100644 --- a/service/ecrpublic/api_op_CreateRepository.go +++ b/service/ecrpublic/api_op_CreateRepository.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Creates a repository in a public registry. For more information, see [Amazon ECR repositories] in the +// Amazon Elastic Container Registry User Guide. +// +// [Amazon ECR repositories]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error) { if params == nil { params = &CreateRepositoryInput{} diff --git a/service/ecrpublic/api_op_DeleteRepository.go b/service/ecrpublic/api_op_DeleteRepository.go index 1392b24526b..caea8b267c8 100644 --- a/service/ecrpublic/api_op_DeleteRepository.go +++ b/service/ecrpublic/api_op_DeleteRepository.go @@ -37,7 +37,7 @@ 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 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 diff --git a/service/ecrpublic/api_op_DescribeImages.go b/service/ecrpublic/api_op_DescribeImages.go index 660e640a717..71e8a810ff1 100644 --- a/service/ecrpublic/api_op_DescribeImages.go +++ b/service/ecrpublic/api_op_DescribeImages.go @@ -12,10 +12,12 @@ import ( ) // Returns metadata that's related to the images in a repository in a public -// 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 . +// 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. func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error) { if params == nil { params = &DescribeImagesInput{} diff --git a/service/ecrpublic/api_op_DescribeRegistries.go b/service/ecrpublic/api_op_DescribeRegistries.go index a4a0d06c7d8..905b506ca6c 100644 --- a/service/ecrpublic/api_op_DescribeRegistries.go +++ b/service/ecrpublic/api_op_DescribeRegistries.go @@ -43,9 +43,10 @@ type DescribeRegistriesInput struct { // 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. + // 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 diff --git a/service/ecrpublic/api_op_DescribeRepositories.go b/service/ecrpublic/api_op_DescribeRepositories.go index 4646c67603b..28d9f84d7ab 100644 --- a/service/ecrpublic/api_op_DescribeRepositories.go +++ b/service/ecrpublic/api_op_DescribeRepositories.go @@ -45,9 +45,10 @@ type DescribeRepositoriesInput struct { // 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 , - // 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. + // 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. NextToken *string // The Amazon Web Services account ID that's associated with the registry that diff --git a/service/ecrpublic/api_op_InitiateLayerUpload.go b/service/ecrpublic/api_op_InitiateLayerUpload.go index c0d7d0f637e..a52bf01d35b 100644 --- a/service/ecrpublic/api_op_InitiateLayerUpload.go +++ b/service/ecrpublic/api_op_InitiateLayerUpload.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Notifies Amazon ECR that you intend to upload an image layer. When an image is -// pushed, the InitiateLayerUpload API is called once for each image layer that -// hasn't already been uploaded. Whether an image layer uploads is determined by -// the BatchCheckLayerAvailability API action. 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. +// Notifies Amazon ECR that you intend to upload an image layer. +// +// When an image is pushed, the InitiateLayerUpload API is called once for each +// image layer that hasn't already been uploaded. Whether an image layer uploads is +// determined by the BatchCheckLayerAvailability API action. +// +// 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) InitiateLayerUpload(ctx context.Context, params *InitiateLayerUploadInput, optFns ...func(*Options)) (*InitiateLayerUploadOutput, error) { if params == nil { params = &InitiateLayerUploadInput{} @@ -51,8 +54,8 @@ type InitiateLayerUploadOutput struct { // The size, in bytes, that Amazon ECR expects future layer part uploads to be. PartSize *int64 - // The upload ID for the layer upload. This parameter is passed to further - // UploadLayerPart and CompleteLayerUpload operations. + // The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload + // operations. UploadId *string // Metadata pertaining to the operation's result. diff --git a/service/ecrpublic/api_op_PutImage.go b/service/ecrpublic/api_op_PutImage.go index 55efd6e929b..2f7cb7173c8 100644 --- a/service/ecrpublic/api_op_PutImage.go +++ b/service/ecrpublic/api_op_PutImage.go @@ -12,11 +12,15 @@ import ( ) // Creates or updates the image manifest and tags that are associated with an -// image. When an image is pushed and all new image layers have been uploaded, the +// 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 -// that are 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. +// that are 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/ecrpublic/api_op_PutRegistryCatalogData.go b/service/ecrpublic/api_op_PutRegistryCatalogData.go index f54f633f2e8..9c15692b961 100644 --- a/service/ecrpublic/api_op_PutRegistryCatalogData.go +++ b/service/ecrpublic/api_op_PutRegistryCatalogData.go @@ -30,8 +30,10 @@ func (c *Client) PutRegistryCatalogData(ctx context.Context, params *PutRegistry type PutRegistryCatalogDataInput struct { // The display name for a public registry. The display name is shown as the - // repository author in the Amazon ECR Public Gallery. The registry display name is - // only publicly visible in the Amazon ECR Public Gallery for verified accounts. + // repository author in the Amazon ECR Public Gallery. + // + // The registry display name is only publicly visible in the Amazon ECR Public + // Gallery for verified accounts. DisplayName *string noSmithyDocumentSerde diff --git a/service/ecrpublic/api_op_SetRepositoryPolicy.go b/service/ecrpublic/api_op_SetRepositoryPolicy.go index d3a93d1d514..a1c85241415 100644 --- a/service/ecrpublic/api_op_SetRepositoryPolicy.go +++ b/service/ecrpublic/api_op_SetRepositoryPolicy.go @@ -11,8 +11,10 @@ import ( ) // 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. +// access permissions. For more information, see [Amazon ECR Repository Policies]in the Amazon Elastic Container +// Registry User Guide. +// +// [Amazon ECR Repository Policies]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, optFns ...func(*Options)) (*SetRepositoryPolicyOutput, error) { if params == nil { params = &SetRepositoryPolicyInput{} @@ -31,8 +33,9 @@ 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) - // in the Amazon Elastic Container Registry User Guide. + // information, see [Amazon ECR Repository Policies]in the Amazon Elastic Container Registry User Guide. + // + // [Amazon ECR Repository Policies]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html // // This member is required. PolicyText *string @@ -43,8 +46,8 @@ type SetRepositoryPolicyInput struct { 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. + // from setting another policy in the future, you must force the SetRepositoryPolicyoperation. 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_UploadLayerPart.go b/service/ecrpublic/api_op_UploadLayerPart.go index bc5d65206fc..d3f2c3c92f1 100644 --- a/service/ecrpublic/api_op_UploadLayerPart.go +++ b/service/ecrpublic/api_op_UploadLayerPart.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads an image layer part to Amazon ECR. When an image is pushed, each new -// image layer is uploaded in parts. The maximum size of each image layer part can -// be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each -// new image layer part. 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. +// Uploads an image layer part to Amazon ECR. +// +// When an image is pushed, each new image layer is uploaded in parts. The maximum +// size of each image layer part can be 20971520 bytes (about 20MB). The +// UploadLayerPart API is called once for each new image layer part. +// +// 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) UploadLayerPart(ctx context.Context, params *UploadLayerPartInput, optFns ...func(*Options)) (*UploadLayerPartOutput, error) { if params == nil { params = &UploadLayerPartInput{} @@ -53,8 +56,8 @@ type UploadLayerPartInput struct { // This member is required. RepositoryName *string - // The upload ID from a previous InitiateLayerUpload operation to associate with - // the layer part upload. + // The upload ID from a previous InitiateLayerUpload operation to associate with the layer part + // upload. // // This member is required. UploadId *string diff --git a/service/ecrpublic/doc.go b/service/ecrpublic/doc.go index 8706038fd3f..0b5c51054c2 100644 --- a/service/ecrpublic/doc.go +++ b/service/ecrpublic/doc.go @@ -3,13 +3,15 @@ // Package ecrpublic provides the API client, operations, and parameter types for // Amazon Elastic Container Registry Public. // -// Amazon Elastic Container Registry Public Amazon Elastic Container Registry -// Public (Amazon ECR Public) is a managed container image registry service. Amazon -// ECR provides both public and private registries to host your container images. -// You can use the Docker CLI or your 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 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) -// . +// # Amazon Elastic Container Registry Public +// +// Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed +// container image registry service. Amazon ECR provides both public and private +// registries to host your container images. You can use the Docker CLI or your +// 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 public repositories with this API. For +// information about the Amazon ECR API for private repositories, see [Amazon Elastic Container Registry API Reference]. +// +// [Amazon Elastic Container Registry API Reference]: https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html package ecrpublic diff --git a/service/ecrpublic/options.go b/service/ecrpublic/options.go index 2845b43a8dd..c0ed620ac83 100644 --- a/service/ecrpublic/options.go +++ b/service/ecrpublic/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ecrpublic/types/enums.go b/service/ecrpublic/types/enums.go index d80a0524475..bc9ab658cc6 100644 --- a/service/ecrpublic/types/enums.go +++ b/service/ecrpublic/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for ImageFailureCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageFailureCode) Values() []ImageFailureCode { return []ImageFailureCode{ "InvalidImageDigest", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for LayerAvailability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LayerAvailability) Values() []LayerAvailability { return []LayerAvailability{ "AVAILABLE", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for LayerFailureCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LayerFailureCode) Values() []LayerFailureCode { return []LayerFailureCode{ "InvalidLayerDigest", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for RegistryAliasStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistryAliasStatus) Values() []RegistryAliasStatus { return []RegistryAliasStatus{ "ACTIVE", diff --git a/service/ecrpublic/types/errors.go b/service/ecrpublic/types/errors.go index 24f4d43c762..349db08f236 100644 --- a/service/ecrpublic/types/errors.go +++ b/service/ecrpublic/types/errors.go @@ -334,8 +334,10 @@ 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]in the Amazon Elastic Container +// Registry User Guide. +// +// [Amazon ECR Service Quotas]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html type LimitExceededException struct { Message *string diff --git a/service/ecrpublic/types/types.go b/service/ecrpublic/types/types.go index b24a2f4e4b7..50f55e9fd05 100644 --- a/service/ecrpublic/types/types.go +++ b/service/ecrpublic/types/types.go @@ -60,12 +60,15 @@ type ImageDetail struct { // current image was pushed to the repository at. ImagePushedAt *time.Time - // The size, in bytes, of the image in the repository. If the image is a manifest - // list, this is the max size of all manifests in the list. 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 might return a larger image size than the image - // sizes that are returned by DescribeImages . + // The size, in bytes, of the image in the repository. + // + // If the image is a manifest list, this is the max size of all manifests in the + // list. + // + // 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 might return a larger image + // size than the image sizes that are returned by DescribeImages. ImageSizeInBytes *int64 // The list of tags that's associated with this image. @@ -158,8 +161,7 @@ type LayerFailure struct { noSmithyDocumentSerde } -// An object that describes the image tag details that are returned by a -// DescribeImageTags action. +// An object that describes the image tag details that are returned by a DescribeImageTags action. type ReferencedImageDetail struct { // The artifact media type of the image. @@ -175,12 +177,15 @@ type ReferencedImageDetail struct { // current image tag was pushed to the repository at. ImagePushedAt *time.Time - // The size, in bytes, of the image in the repository. If the image is a manifest - // list, this is the max size of all manifests in the list. 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 might return a larger image size than the image - // sizes that are returned by DescribeImages . + // The size, in bytes, of the image in the repository. + // + // If the image is a manifest list, this is the max size of all manifests in the + // list. + // + // 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 might return a larger image + // size than the image sizes that are returned by DescribeImages. ImageSizeInBytes *int64 noSmithyDocumentSerde @@ -223,8 +228,10 @@ 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]in the Amazon Elastic Container +// Registry User Guide. +// +// [Registries]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html type RegistryAlias struct { // Indicates whether the registry alias is the default alias for the registry. @@ -242,8 +249,10 @@ type RegistryAlias struct { // Indicates whether the registry alias is the primary alias for the registry. If // true, the alias is the primary registry alias and is displayed in both the // repository URL and the image URI used in the docker pull commands on the Amazon - // ECR Public Gallery. A registry alias that isn't the primary registry alias can - // be used in the repository URI in a docker pull command. + // ECR Public Gallery. + // + // A registry alias that isn't the primary registry alias can be used in the + // repository URI in a docker pull command. // // This member is required. PrimaryRegistryAlias bool @@ -260,8 +269,10 @@ type RegistryAlias struct { type RegistryCatalogData struct { // The display name for a public registry. This appears on the Amazon ECR Public - // Gallery. Only accounts that have the verified account badge can have a registry - // display name. + // Gallery. + // + // Only accounts that have the verified account badge can have a registry display + // name. DisplayName *string noSmithyDocumentSerde @@ -301,9 +312,10 @@ type RepositoryCatalogData struct { // 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 . + // 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. Architectures []string // The short description of the repository. @@ -316,9 +328,10 @@ type RepositoryCatalogData struct { // Marketplace. MarketplaceCertified *bool - // 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 . + // 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. OperatingSystems []string // The longform usage details of the contents of the repository. The usage text @@ -338,13 +351,18 @@ type RepositoryCatalogDataInput struct { // The system architecture that the images in the repository are compatible with. // On the Amazon ECR Public Gallery, the following supported architectures appear - // as badges on the repository and are used as search filters. If an unsupported - // 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. + // as badges on the repository and are used as search filters. + // + // If an unsupported 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 Architectures []string @@ -353,17 +371,22 @@ type RepositoryCatalogDataInput struct { // 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 // the Amazon ECR Public Gallery, the following supported operating systems appear - // as badges on the repository and are used as search filters. If an unsupported - // 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. + // as badges on the repository and are used as search filters. + // + // If an unsupported 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 OperatingSystems []string diff --git a/service/ecs/api_op_CreateCapacityProvider.go b/service/ecs/api_op_CreateCapacityProvider.go index 19df0682c83..28ee021c8a5 100644 --- a/service/ecs/api_op_CreateCapacityProvider.go +++ b/service/ecs/api_op_CreateCapacityProvider.go @@ -13,10 +13,12 @@ import ( // Creates a new capacity provider. Capacity providers are associated with an // Amazon ECS cluster and are used in capacity provider strategies to facilitate -// cluster auto scaling. Only capacity providers that use an Auto Scaling group can -// be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT -// capacity providers. These providers are available to all accounts in the Amazon -// Web Services Regions that Fargate supports. +// cluster auto scaling. +// +// Only capacity providers that use an Auto Scaling group can be created. Amazon +// ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These +// providers are available to all accounts in the Amazon Web Services Regions that +// Fargate supports. func (c *Client) CreateCapacityProvider(ctx context.Context, params *CreateCapacityProviderInput, optFns ...func(*Options)) (*CreateCapacityProviderOutput, error) { if params == nil { params = &CreateCapacityProviderInput{} @@ -49,17 +51,26 @@ 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: + // 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 diff --git a/service/ecs/api_op_CreateCluster.go b/service/ecs/api_op_CreateCluster.go index 0382eefb6ac..73b42b2d04b 100644 --- a/service/ecs/api_op_CreateCluster.go +++ b/service/ecs/api_op_CreateCluster.go @@ -13,14 +13,16 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// role, it isn't created. For more information, see [Using service-linked roles for Amazon ECS]in the Amazon Elastic +// Container Service Developer Guide. +// +// [Using service-linked roles for Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -41,18 +43,23 @@ 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) - // 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) - // API operation is used to update the list of available capacity providers for a - // cluster after the cluster is created. + // capacity provider strategy when calling the [CreateService]or [RunTask] 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]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] API operation is used to update the list of available capacity providers + // for a cluster after the cluster is created. + // + // [CreateService]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html + // [PutCapacityProvider]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html + // [CreateCapacityProvider]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html CapacityProviders []string // The name of your cluster. If you don't specify a name for your cluster, you @@ -64,13 +71,15 @@ type CreateClusterInput struct { Configuration *types.ClusterConfiguration // 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) + // default capacity provider strategy is set for a cluster, when you call the [CreateService]or [RunTask] // 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 - // defined later with the PutClusterCapacityProviders API operation. + // 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 defined later with the PutClusterCapacityProvidersAPI operation. + // + // [CreateService]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html DefaultCapacityProviderStrategy []types.CapacityProviderStrategyItem // Use this parameter to set a default Service Connect namespace. After you set a @@ -79,34 +88,44 @@ type CreateClusterInput struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html 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 . + // overrides the containerInsights value set with PutAccountSetting or 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: + // 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 diff --git a/service/ecs/api_op_CreateService.go b/service/ecs/api_op_CreateService.go index 62ce332b56a..d02bab0ec6f 100644 --- a/service/ecs/api_op_CreateService.go +++ b/service/ecs/api_op_CreateService.go @@ -14,60 +14,70 @@ 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. On March -// 21, 2024, a change was made to resolve the task definition revision before -// authorization. When a task definition revision is not specified, authorization -// will occur using the latest revision of a task definition. In addition to -// 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) -// in the Amazon Elastic Container Service Developer Guide. You can attach Amazon -// EBS volumes to Amazon ECS tasks by configuring the volume when creating or -// updating a service. volumeConfigurations is only supported for REPLICA service -// and not DAEMON service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) -// 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. +// cluster. To update an existing service, see the UpdateServiceaction. +// +// On March 21, 2024, a change was made to resolve the task definition revision +// before authorization. When a task definition revision is not specified, +// authorization will occur using the latest revision of a task definition. +// +// In addition to 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]in the Amazon Elastic Container Service +// Developer Guide. +// +// You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume +// when creating or updating a service. volumeConfigurations is only supported for +// REPLICA service and not DAEMON service. For more infomation, see [Amazon EBS volumes]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) +// constraints to customize task placement decisions. For more information, see [Service scheduler concepts] // 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. +// policies. For more information, see [Service scheduler concepts]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 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 +// This is done with an UpdateServiceoperation. 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. @@ -75,30 +85,40 @@ import ( // 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 +// 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) -// in the Amazon Elastic Container Service Developer Guide 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 customers and will be -// able to continue using the service. +// required parameter is the service name. You control your services using the CreateTaskSet +// operation. For more information, see [Amazon ECS deployment types]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]in the +// Amazon Elastic Container Service Developer Guide +// +// 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 customers and will be able to continue using the service. +// +// [Amazon ECS task placement]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html +// [Service scheduler concepts]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html +// [Amazon ECS deployment types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html +// [Service load balancing]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html +// [Amazon EBS volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -124,11 +144,13 @@ type CreateServiceInput struct { // This member is required. ServiceName *string - // The capacity provider strategy to use for the service. If a - // capacityProviderStrategy is specified, the launchType parameter must be + // 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 - // defaultCapacityProviderStrategy for the cluster is used. A capacity provider - // strategy may contain a maximum of 6 capacity providers. + // 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 @@ -150,14 +172,20 @@ type CreateServiceInput struct { DeploymentController *types.DeploymentController // The number of instantiations of the specified task definition to place and keep - // running in your service. This is required if schedulingStrategy is REPLICA or - // isn't specified. If schedulingStrategy is DAEMON then this isn't required. + // running in your service. + // + // This is required if schedulingStrategy is REPLICA or isn't specified. If + // schedulingStrategy is DAEMON then this isn't required. 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) - // in the Amazon Elastic Container Service Developer Guide. When you use Amazon ECS - // managed tags, you need to set the propagateTags request parameter. + // service. For more information, see [Tagging your Amazon ECS resources]in the Amazon Elastic Container Service + // Developer Guide. + // + // When you use Amazon ECS managed tags, you need to set the propagateTags request + // parameter. + // + // [Tagging your Amazon ECS resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags bool // Determines whether the execute command functionality is turned on for the @@ -169,76 +197,100 @@ type CreateServiceInput struct { // unhealthy Elastic Load Balancing target health checks after a task has first // started. This is only used when your service is configured to use a load // 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 + // 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]. + // + // 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 // scheduler from marking tasks as unhealthy and stopping them before they have // time to come up. + // + // [Health check]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html 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/developerguide/fargate-capacity-providers.html) - // in the Amazon ECS Developer Guide. 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. + // The infrastructure that you run your service on. For more information, see [Amazon ECS launch types] 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]in the Amazon ECS Developer + // Guide. + // + // 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. + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html + // [Fargate capacity providers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html 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) - // 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) - // 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 - // validation tests with Lambda functions before routing production traffic to it. + // service. For more information, see [Service load balancing]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]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 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 - // Balancers, this object must contain the load balancer target group ARN, the - // container name, and the container port to access from the load balancer. The - // container name must be as it appears in a container definition. The load - // balancer name parameter must be omitted. When a task from this service is placed - // on a container instance, the container instance and port combination is - // registered as a target in the target group that's specified here. For Classic - // Load Balancers, this object must contain the load balancer name, the container - // name , and the container port to access from the load balancer. The container - // 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 - // 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 - // network mode are associated with an elastic network interface, not an Amazon EC2 - // instance. + // when updating the service. + // + // For Application Load Balancers and Network Load Balancers, this object must + // contain the load balancer target group ARN, the container name, and the + // container port to access from the load balancer. The container name must be as + // it appears in a container definition. The load balancer name parameter must be + // omitted. When a task from this service is placed on a container instance, the + // container instance and port combination is registered as a target in the target + // group that's specified here. + // + // For Classic Load Balancers, this object must contain the load balancer name, + // the container name , and the container port to access from the load balancer. + // The container 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 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 network mode are + // associated with an elastic network interface, not an Amazon EC2 instance. + // + // [Service load balancing]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html + // [Using service-linked roles for Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html LoadBalancers []types.LoadBalancer // 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Task networking]in the Amazon Elastic Container Service Developer Guide. + // + // [Task networking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html NetworkConfiguration *types.NetworkConfiguration // An array of placement constraint objects to use for tasks in your service. You @@ -252,18 +304,24 @@ type CreateServiceInput struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. + // specified, the LATEST platform version is used. For more information, see [Fargate platform versions] in + // the Amazon Elastic Container Service Developer Guide. + // + // [Fargate platform versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html 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) - // API action. You must set this to a value other than NONE when you use Cost - // Explorer. For more information, see Amazon ECS usage reports (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) - // in the Amazon Elastic Container Service Developer Guide. The default is NONE . + // creation, use the [TagResource]API action. + // + // You must set this to a value other than NONE when you use Cost Explorer. For + // more information, see [Amazon ECS usage reports]in the Amazon Elastic Container Service Developer Guide. + // + // The default is NONE . + // + // [TagResource]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html + // [Amazon ECS usage reports]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html PropagateTags types.PropagateTags // The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon @@ -271,71 +329,95 @@ type CreateServiceInput struct { // permitted if you are using a load balancer with your service and your task // definition doesn't use the awsvpc network mode. If you specify the role // parameter, you must also specify a load balancer object with the loadBalancers - // parameter. If your account has already created the Amazon ECS service-linked - // role, that role is used for your service unless you specify a role here. The - // service-linked role is required if your task definition uses the awsvpc network - // 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) - // 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) - // in the IAM User Guide. + // parameter. + // + // If your account has already created the Amazon ECS service-linked role, that + // role is used for your service unless you specify a role here. The service-linked + // role is required if your task definition uses the awsvpc network 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]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] in the IAM User + // Guide. + // + // [Friendly names and paths]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names + // [Using service-linked roles for Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html 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: + // The scheduling strategy to use for the service. For more information, see [Services]. + // + // 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. + // 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 SchedulingStrategy types.SchedulingStrategy // 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. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html 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]. + // + // Each service may be associated with one service registry. Multiple service // registries for each service isn't supported. + // + // [Service discovery]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html ServiceRegistries []types.ServiceRegistry // 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, both of which you - // define. When a service is deleted, the tags are deleted as well. The following - // basic restrictions apply to tags: + // 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 @@ -344,10 +426,14 @@ type CreateServiceInput struct { // 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. For more information about - // deployment types, see Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) - // . + // revision is used. + // + // A task definition must be specified if the service uses either the ECS or + // CODE_DEPLOY deployment controllers. + // + // For more information about deployment types, see [Amazon ECS deployment types]. + // + // [Amazon ECS deployment types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html TaskDefinition *string // The configuration for a volume specified in the task definition as a volume @@ -360,13 +446,17 @@ type CreateServiceInput struct { 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. + // 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. 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 35697f7f27d..903afa732af 100644 --- a/service/ecs/api_op_CreateTaskSet.go +++ b/service/ecs/api_op_CreateTaskSet.go @@ -12,14 +12,18 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. On March 21, 2024, a -// change was made to resolve the task definition revision before authorization. -// When a task definition revision is not specified, authorization will occur using -// the latest revision of a task definition. For information about the maximum -// number of task sets and otther quotas, see Amazon ECS service quotas (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html) +// service uses the EXTERNAL deployment controller type. For more information, see [Amazon ECS deployment types] // in the Amazon Elastic Container Service Developer Guide. +// +// On March 21, 2024, a change was made to resolve the task definition revision +// before authorization. When a task definition revision is not specified, +// authorization will occur using the latest revision of a task definition. +// +// For information about the maximum number of task sets and otther quotas, see [Amazon ECS service quotas] +// in the Amazon Elastic Container Service Developer Guide. +// +// [Amazon ECS deployment types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html +// [Amazon ECS service quotas]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html func (c *Client) CreateTaskSet(ctx context.Context, params *CreateTaskSetInput, optFns ...func(*Options)) (*CreateTaskSetOutput, error) { if params == nil { params = &CreateTaskSetInput{} @@ -55,23 +59,28 @@ type CreateTaskSetInput struct { // This member is required. TaskDefinition *string - // The capacity provider strategy to use for the task set. A capacity provider - // strategy consists of one or more capacity providers along with the base and - // weight to assign to them. A capacity provider must be associated with the - // cluster to be used in a capacity provider strategy. The - // PutClusterCapacityProviders API is used to associate a capacity provider with a - // cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. + // The capacity provider strategy to use for the task set. + // + // A capacity provider strategy consists of one or more capacity providers along + // with the base and weight to assign to them. A capacity provider must be + // associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProvidersAPI + // is used to associate a capacity provider with a cluster. Only capacity providers + // with an ACTIVE or UPDATING status can be used. + // // If a capacityProviderStrategy is specified, the launchType parameter must be // omitted. If no capacityProviderStrategy or launchType is specified, the - // defaultCapacityProviderStrategy for the cluster is used. If specifying a - // capacity provider that uses an Auto Scaling group, the capacity provider must - // already be created. New 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. The PutClusterCapacityProviders API operation is - // used to update the list of available capacity providers for a cluster after the - // cluster is created. + // defaultCapacityProviderStrategy for the cluster is used. + // + // If specifying a capacity provider that uses an Auto Scaling group, the capacity + // provider must already be created. New capacity providers can be created with the + // CreateCapacityProviderAPI 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 cluster is created. CapacityProviderStrategy []types.CapacityProviderStrategyItem // An identifier that you provide to ensure the idempotency of the request. It @@ -85,10 +94,13 @@ type CreateTaskSetInput struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. If a launchType is - // specified, the capacityProviderStrategy parameter must be omitted. + // The launch type that new tasks in the task set uses. For more information, see [Amazon ECS launch types] + // in the Amazon Elastic Container Service Developer Guide. + // + // If a launchType is specified, the capacityProviderStrategy parameter must be + // omitted. + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html LaunchType types.LaunchType // A load balancer object representing the load balancer to use with the task set. @@ -109,24 +121,33 @@ 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]. + // + // [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: + // 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 diff --git a/service/ecs/api_op_DeleteCapacityProvider.go b/service/ecs/api_op_DeleteCapacityProvider.go index 9dff6e0d57e..f8fbd79cdba 100644 --- a/service/ecs/api_op_DeleteCapacityProvider.go +++ b/service/ecs/api_op_DeleteCapacityProvider.go @@ -11,18 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified capacity provider. The FARGATE and FARGATE_SPOT capacity -// providers are reserved and can't be deleted. You can disassociate them from a -// cluster using either the PutClusterCapacityProviders API or by deleting the -// cluster. Prior to a capacity provider being deleted, the capacity provider must -// be removed from the capacity provider strategy from all services. The -// UpdateService API can be used to remove a capacity provider from a service's -// capacity provider strategy. When updating a service, the forceNewDeployment -// option can be used to ensure that any tasks using the Amazon EC2 instance -// capacity provided by the capacity provider are transitioned to use the capacity -// from the remaining capacity providers. Only capacity providers that aren't -// associated with a cluster can be deleted. To remove a capacity provider from a -// cluster, you can either use PutClusterCapacityProviders or delete the cluster. +// Deletes the specified capacity provider. +// +// The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be +// deleted. You can disassociate them from a cluster using either the PutClusterCapacityProvidersAPI or by +// deleting the cluster. +// +// Prior to a capacity provider being deleted, the capacity provider must be +// removed from the capacity provider strategy from all services. The UpdateServiceAPI can be +// used to remove a capacity provider from a service's capacity provider strategy. +// When updating a service, the forceNewDeployment option can be used to ensure +// that any tasks using the Amazon EC2 instance capacity provided by the capacity +// provider are transitioned to use the capacity from the remaining capacity +// providers. Only capacity providers that aren't associated with a cluster can be +// deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProvidersor +// delete the cluster. func (c *Client) DeleteCapacityProvider(ctx context.Context, params *DeleteCapacityProviderInput, optFns ...func(*Options)) (*DeleteCapacityProviderOutput, error) { if params == nil { params = &DeleteCapacityProviderInput{} diff --git a/service/ecs/api_op_DeleteCluster.go b/service/ecs/api_op_DeleteCluster.go index 4fe026519f9..71d57e1cc20 100644 --- a/service/ecs/api_op_DeleteCluster.go +++ b/service/ecs/api_op_DeleteCluster.go @@ -14,10 +14,11 @@ 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 -// 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 . +// 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 ListContainerInstancesand +// 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 c92d5b41b88..fcc80ba5819 100644 --- a/service/ecs/api_op_DeleteService.go +++ b/service/ecs/api_op_DeleteService.go @@ -14,18 +14,19 @@ 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 +// 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. +// no longer visible in the console or in the ListServicesAPI 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 DescribeServicesAPI operation. However, in the future, INACTIVE +// services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServicescalls +// 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{} diff --git a/service/ecs/api_op_DeleteTaskDefinitions.go b/service/ecs/api_op_DeleteTaskDefinitions.go index 5025399013a..821cc6d43e2 100644 --- a/service/ecs/api_op_DeleteTaskDefinitions.go +++ b/service/ecs/api_op_DeleteTaskDefinitions.go @@ -11,25 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Deletes one or more task definitions. +// +// You must deregister a task definition revision before you delete it. For more +// information, see [DeregisterTaskDefinition]. +// +// 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. When you delete all INACTIVE task definition -// revisions, the task definition name is not displayed in the console and not -// returned in the API. If a task definition revisions are in the -// DELETE_IN_PROGRESS state, the task definition name is displayed in the console -// and returned in the API. The task definition name is retained by Amazon ECS and -// the revision is incremented the next time you create a task definition with that -// name. +// 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. +// +// When you delete all INACTIVE task definition revisions, the task definition +// name is not displayed in the console and not returned in the API. If a task +// definition revisions are in the DELETE_IN_PROGRESS state, the task definition +// name is displayed in the console and returned in the API. The task definition +// name is retained by Amazon ECS and the revision is incremented the next time you +// create a task definition with that name. +// +// [DeregisterTaskDefinition]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html func (c *Client) DeleteTaskDefinitions(ctx context.Context, params *DeleteTaskDefinitionsInput, optFns ...func(*Options)) (*DeleteTaskDefinitionsOutput, error) { if params == nil { params = &DeleteTaskDefinitionsInput{} @@ -48,8 +56,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. + // 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 c4d29bea057..7cac16fe2f4 100644 --- a/service/ecs/api_op_DeleteTaskSet.go +++ b/service/ecs/api_op_DeleteTaskSet.go @@ -12,9 +12,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// the EXTERNAL deployment controller type. For more information, see [Amazon ECS deployment types] in the +// Amazon Elastic Container Service Developer Guide. +// +// [Amazon ECS deployment types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html func (c *Client) DeleteTaskSet(ctx context.Context, params *DeleteTaskSetInput, optFns ...func(*Options)) (*DeleteTaskSetOutput, error) { if params == nil { params = &DeleteTaskSetInput{} diff --git a/service/ecs/api_op_DeregisterContainerInstance.go b/service/ecs/api_op_DeregisterContainerInstance.go index a563e3b9196..a9f86d395ea 100644 --- a/service/ecs/api_op_DeregisterContainerInstance.go +++ b/service/ecs/api_op_DeregisterContainerInstance.go @@ -12,16 +12,21 @@ import ( ) // Deregisters an Amazon ECS container instance from the specified cluster. This -// instance is no longer available to run tasks. If you intend to use the container -// instance for some other purpose after deregistration, we recommend that you stop -// all of the tasks running on the container instance before deregistration. That -// prevents any orphaned tasks from consuming resources. Deregistering a container -// instance removes the instance from a cluster, but it doesn't terminate the EC2 -// instance. If you are finished using the instance, be sure to terminate it in the -// Amazon EC2 console to stop billing. If you terminate a running container -// instance, Amazon ECS automatically deregisters the instance from your cluster -// (stopped container instances or instances with disconnected agents aren't -// automatically deregistered when terminated). +// instance is no longer available to run tasks. +// +// If you intend to use the container instance for some other purpose after +// deregistration, we recommend that you stop all of the tasks running on the +// container instance before deregistration. That prevents any orphaned tasks from +// consuming resources. +// +// Deregistering a container instance removes the instance from a cluster, but it +// doesn't terminate the EC2 instance. If you are finished using the instance, be +// sure to terminate it in the Amazon EC2 console to stop billing. +// +// If you terminate a running container instance, Amazon ECS automatically +// deregisters the instance from your cluster (stopped container instances or +// instances with disconnected agents aren't automatically deregistered when +// terminated). func (c *Client) DeregisterContainerInstance(ctx context.Context, params *DeregisterContainerInstanceInput, optFns ...func(*Options)) (*DeregisterContainerInstanceOutput, error) { if params == nil { params = &DeregisterContainerInstanceInput{} @@ -40,8 +45,10 @@ 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) - // in the Amazon ECS Developer Guide. + // For more information about the ARN format, see [Amazon Resource Name (ARN)]in the Amazon ECS Developer + // Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids // // This member is required. ContainerInstance *string @@ -57,10 +64,12 @@ type DeregisterContainerInstanceInput struct { // 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 - // tasks that are registered with a Classic Load Balancer or an Application Load - // Balancer target group are deregistered. They begin connection draining according - // to the settings on the load balancer or target group. + // different container instance if possible. + // + // Any containers in orphaned service tasks that are registered with a Classic + // Load Balancer or an Application Load Balancer target group are deregistered. + // They begin connection draining according to the settings on the load balancer or + // target group. Force *bool noSmithyDocumentSerde diff --git a/service/ecs/api_op_DeregisterTaskDefinition.go b/service/ecs/api_op_DeregisterTaskDefinition.go index bbcade22d8e..60495fbca54 100644 --- a/service/ecs/api_op_DeregisterTaskDefinition.go +++ b/service/ecs/api_op_DeregisterTaskDefinition.go @@ -17,16 +17,22 @@ import ( // 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 // delete a task definition revision, you must first deregister the task definition -// revision. You can't use an INACTIVE task definition to run new tasks or create -// new services, and you can't update an existing service to reference an INACTIVE +// revision. +// +// You can't use an INACTIVE task definition to run new tasks or create new +// services, and you can't update an existing service to reference an INACTIVE // task definition. However, there may be up to a 10-minute window following -// deregistration where these restrictions have not yet taken effect. At this time, -// INACTIVE task definitions remain discoverable in your account indefinitely. -// 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) -// . +// deregistration where these restrictions have not yet taken effect. +// +// At this time, INACTIVE task definitions remain discoverable in your account +// indefinitely. 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]. +// +// [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{} diff --git a/service/ecs/api_op_DescribeCapacityProviders.go b/service/ecs/api_op_DescribeCapacityProviders.go index b79fe094284..84cfdbbf2c8 100644 --- a/service/ecs/api_op_DescribeCapacityProviders.go +++ b/service/ecs/api_op_DescribeCapacityProviders.go @@ -51,9 +51,10 @@ type DescribeCapacityProvidersInput struct { // The nextToken value returned from a previous paginated DescribeCapacityProviders // 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. + // 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 diff --git a/service/ecs/api_op_DescribeClusters.go b/service/ecs/api_op_DescribeClusters.go index c34367bcc89..d1eca74ff30 100644 --- a/service/ecs/api_op_DescribeClusters.go +++ b/service/ecs/api_op_DescribeClusters.go @@ -34,13 +34,20 @@ type DescribeClustersInput struct { Clusters []string // Determines whether to include additional information about the clusters in the - // response. If this field is omitted, this information isn't included. If - // ATTACHMENTS is specified, the attachments for the container instances or tasks - // within the cluster are included, for example the capacity providers. If SETTINGS - // is specified, the settings for the cluster are included. If CONFIGURATIONS is - // specified, the configuration for the cluster is included. If STATISTICS is - // specified, the task and service count is included, separated by launch type. If - // TAGS is specified, the metadata tags associated with the cluster are included. + // response. If this field is omitted, this information isn't included. + // + // If ATTACHMENTS is specified, the attachments for the container instances or + // tasks within the cluster are included, for example the capacity providers. + // + // If SETTINGS is specified, the settings for the cluster are included. + // + // If CONFIGURATIONS is specified, the configuration for the cluster is included. + // + // If STATISTICS is specified, the task and service count is included, separated + // by launch type. + // + // If TAGS is specified, the metadata tags associated with the cluster are + // included. Include []types.ClusterField noSmithyDocumentSerde diff --git a/service/ecs/api_op_DescribeServices.go b/service/ecs/api_op_DescribeServices.go index 927800c2133..683a537b214 100644 --- a/service/ecs/api_op_DescribeServices.go +++ b/service/ecs/api_op_DescribeServices.go @@ -187,12 +187,13 @@ type ServicesInactiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeServicesInput, *DescribeServicesOutput, error) (bool, error) } @@ -390,12 +391,13 @@ type ServicesStableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeServicesInput, *DescribeServicesOutput, error) (bool, error) } diff --git a/service/ecs/api_op_DescribeTaskDefinition.go b/service/ecs/api_op_DescribeTaskDefinition.go index 0cd25fcfc75..11c84673cd9 100644 --- a/service/ecs/api_op_DescribeTaskDefinition.go +++ b/service/ecs/api_op_DescribeTaskDefinition.go @@ -13,8 +13,10 @@ import ( // Describes a task definition. You can specify a family and revision to find // information about a specific task definition, or you can simply specify the -// family to find the latest ACTIVE revision in that family. You can only describe -// INACTIVE task definitions while an active task or service references them. +// family to find the latest ACTIVE revision in that family. +// +// You can only describe INACTIVE task definitions while an active task or service +// references them. func (c *Client) DescribeTaskDefinition(ctx context.Context, params *DescribeTaskDefinitionInput, optFns ...func(*Options)) (*DescribeTaskDefinitionOutput, error) { if params == nil { params = &DescribeTaskDefinitionInput{} @@ -51,17 +53,26 @@ 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: + // 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 diff --git a/service/ecs/api_op_DescribeTaskSets.go b/service/ecs/api_op_DescribeTaskSets.go index e72b354e1d3..2f506299341 100644 --- a/service/ecs/api_op_DescribeTaskSets.go +++ b/service/ecs/api_op_DescribeTaskSets.go @@ -13,8 +13,9 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// see [Amazon ECS Deployment Types]in the Amazon Elastic Container Service Developer Guide. +// +// [Amazon ECS Deployment Types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html func (c *Client) DescribeTaskSets(ctx context.Context, params *DescribeTaskSetsInput, optFns ...func(*Options)) (*DescribeTaskSetsOutput, error) { if params == nil { params = &DescribeTaskSetsInput{} diff --git a/service/ecs/api_op_DescribeTasks.go b/service/ecs/api_op_DescribeTasks.go index 140410549c6..2187fda241c 100644 --- a/service/ecs/api_op_DescribeTasks.go +++ b/service/ecs/api_op_DescribeTasks.go @@ -15,11 +15,13 @@ import ( "time" ) -// Describes a specified task or tasks. Currently, stopped tasks appear in the -// returned results for at least one hour. If you have tasks with tags, and then -// delete the cluster, the tagged tasks are returned in the response. If you create -// a new cluster with the same name as the deleted cluster, the tagged tasks are -// not included in the response. +// Describes a specified task or tasks. +// +// Currently, stopped tasks appear in the returned results for at least one hour. +// +// If you have tasks with tags, and then delete the cluster, the tagged tasks are +// returned in the response. If you create a new cluster with the same name as the +// deleted cluster, the tagged tasks are not included in the response. func (c *Client) DescribeTasks(ctx context.Context, params *DescribeTasksInput, optFns ...func(*Options)) (*DescribeTasksOutput, error) { if params == nil { params = &DescribeTasksInput{} @@ -188,12 +190,13 @@ type TasksRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTasksInput, *DescribeTasksOutput, error) (bool, error) } @@ -422,12 +425,13 @@ type TasksStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTasksInput, *DescribeTasksOutput, error) (bool, error) } diff --git a/service/ecs/api_op_DiscoverPollEndpoint.go b/service/ecs/api_op_DiscoverPollEndpoint.go index 871b365893e..fddea28e1ce 100644 --- a/service/ecs/api_op_DiscoverPollEndpoint.go +++ b/service/ecs/api_op_DiscoverPollEndpoint.go @@ -11,8 +11,9 @@ import ( ) // 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. +// 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 +36,9 @@ 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) - // in the Amazon ECS Developer Guide. + // information about the ARN format, see [Amazon Resource Name (ARN)]in the Amazon ECS Developer Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids ContainerInstance *string noSmithyDocumentSerde @@ -48,8 +50,10 @@ type DiscoverPollEndpointOutput struct { 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) - // in the Amazon Elastic Container Service Developer Guide. + // configuration. For more information, see [Service Connect]in the Amazon Elastic Container + // Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html ServiceConnectEndpoint *string // The telemetry endpoint for the Amazon ECS agent. diff --git a/service/ecs/api_op_ExecuteCommand.go b/service/ecs/api_op_ExecuteCommand.go index c0f14cddac3..1278cf7450e 100644 --- a/service/ecs/api_op_ExecuteCommand.go +++ b/service/ecs/api_op_ExecuteCommand.go @@ -11,13 +11,17 @@ 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 -// 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.html) -// in the Amazon ECS Developer Guide. +// 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] in the +// Amazon ECS Developer Guide. +// +// [Using Amazon ECS Exec for debugging]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html func (c *Client) ExecuteCommand(ctx context.Context, params *ExecuteCommandInput, optFns ...func(*Options)) (*ExecuteCommandOutput, error) { if params == nil { params = &ExecuteCommandInput{} diff --git a/service/ecs/api_op_GetTaskProtection.go b/service/ecs/api_op_GetTaskProtection.go index 799f1754f53..31ac48c5f76 100644 --- a/service/ecs/api_op_GetTaskProtection.go +++ b/service/ecs/api_op_GetTaskProtection.go @@ -47,10 +47,13 @@ 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 turned on 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 diff --git a/service/ecs/api_op_ListAccountSettings.go b/service/ecs/api_op_ListAccountSettings.go index f8164f9f8ad..7782ad9e734 100644 --- a/service/ecs/api_op_ListAccountSettings.go +++ b/service/ecs/api_op_ListAccountSettings.go @@ -51,14 +51,17 @@ 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 // field is omitted, the account settings are listed only for the authenticated - // user. Federated users assume the account setting of the root user and can't have + // user. + // + // Federated users assume the account setting of the root user and can't have // explicit account settings set for them. PrincipalArn *string diff --git a/service/ecs/api_op_ListAttributes.go b/service/ecs/api_op_ListAttributes.go index de94bf6e138..602e209c8c9 100644 --- a/service/ecs/api_op_ListAttributes.go +++ b/service/ecs/api_op_ListAttributes.go @@ -63,9 +63,10 @@ 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 - // used to retrieve the next items in a list and not for other programmatic - // purposes. + // 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 noSmithyDocumentSerde diff --git a/service/ecs/api_op_ListClusters.go b/service/ecs/api_op_ListClusters.go index 326d3459a33..27a7ae3c575 100644 --- a/service/ecs/api_op_ListClusters.go +++ b/service/ecs/api_op_ListClusters.go @@ -40,9 +40,10 @@ 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 - // used to retrieve the next items in a list and not for other programmatic - // purposes. + // 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 noSmithyDocumentSerde diff --git a/service/ecs/api_op_ListContainerInstances.go b/service/ecs/api_op_ListContainerInstances.go index 50a1d6a810b..4a987383e7b 100644 --- a/service/ecs/api_op_ListContainerInstances.go +++ b/service/ecs/api_op_ListContainerInstances.go @@ -13,9 +13,10 @@ import ( // 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) -// in the Amazon Elastic Container Service Developer Guide. +// statements inside the filter parameter. For more information, see [Cluster Query Language] in the +// Amazon Elastic Container Service Developer Guide. +// +// [Cluster Query Language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html func (c *Client) ListContainerInstances(ctx context.Context, params *ListContainerInstancesInput, optFns ...func(*Options)) (*ListContainerInstancesOutput, error) { if params == nil { params = &ListContainerInstancesInput{} @@ -39,8 +40,10 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // query language statements. For more information, see [Cluster Query Language]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Cluster Query Language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html Filter *string // The maximum number of container instance results that ListContainerInstances @@ -56,16 +59,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 - // parameter, the default is to include container instances set to all states other - // than INACTIVE . + // 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 . Status types.ContainerInstanceStatus noSmithyDocumentSerde diff --git a/service/ecs/api_op_ListServices.go b/service/ecs/api_op_ListServices.go index 77556ff6b90..2320090d4c5 100644 --- a/service/ecs/api_op_ListServices.go +++ b/service/ecs/api_op_ListServices.go @@ -50,9 +50,10 @@ 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 - // only used to retrieve the next items in a list and not for other programmatic - // purposes. + // 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 scheduling strategy to use when filtering the ListServices results. diff --git a/service/ecs/api_op_ListServicesByNamespace.go b/service/ecs/api_op_ListServicesByNamespace.go index 59fea198ad7..14af8d5a4d7 100644 --- a/service/ecs/api_op_ListServicesByNamespace.go +++ b/service/ecs/api_op_ListServicesByNamespace.go @@ -14,8 +14,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// ListServices . For more information, see [Service Connect] in the Amazon Elastic Container +// Service Developer Guide. +// +// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html func (c *Client) ListServicesByNamespace(ctx context.Context, params *ListServicesByNamespaceInput, optFns ...func(*Options)) (*ListServicesByNamespaceOutput, error) { if params == nil { params = &ListServicesByNamespaceInput{} @@ -34,13 +36,16 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html // // This member is required. Namespace *string diff --git a/service/ecs/api_op_ListTaskDefinitionFamilies.go b/service/ecs/api_op_ListTaskDefinitionFamilies.go index 9d446f7adda..bc0eaeb09e3 100644 --- a/service/ecs/api_op_ListTaskDefinitionFamilies.go +++ b/service/ecs/api_op_ListTaskDefinitionFamilies.go @@ -13,9 +13,11 @@ import ( // Returns a list of task definition families that are registered to your account. // 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. +// 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. func (c *Client) ListTaskDefinitionFamilies(ctx context.Context, params *ListTaskDefinitionFamiliesInput, optFns ...func(*Options)) (*ListTaskDefinitionFamiliesOutput, error) { if params == nil { params = &ListTaskDefinitionFamiliesInput{} @@ -51,9 +53,10 @@ type ListTaskDefinitionFamiliesInput struct { // 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 - // identifier that is only used to retrieve the next items in a list and not for - // other programmatic purposes. + // 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 diff --git a/service/ecs/api_op_ListTaskDefinitions.go b/service/ecs/api_op_ListTaskDefinitions.go index 5d73158530b..b8ee505ef15 100644 --- a/service/ecs/api_op_ListTaskDefinitions.go +++ b/service/ecs/api_op_ListTaskDefinitions.go @@ -49,9 +49,10 @@ 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, ( diff --git a/service/ecs/api_op_ListTasks.go b/service/ecs/api_op_ListTasks.go index 2f2f1ea4471..2b899f33de4 100644 --- a/service/ecs/api_op_ListTasks.go +++ b/service/ecs/api_op_ListTasks.go @@ -13,8 +13,9 @@ import ( // Returns a list of tasks. You can filter the results by cluster, task definition // family, container instance, launch type, what IAM principal started the task, or -// by the desired status of the task. Recently stopped tasks might appear in the -// returned results. +// by the desired status of the task. +// +// Recently stopped tasks might appear in the returned results. func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error) { if params == nil { params = &ListTasksInput{} @@ -47,9 +48,11 @@ type ListTasksInput struct { // 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 , - // 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 ). + // 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 ). DesiredStatus types.DesiredStatus // The name of the task definition family to use when filtering the ListTasks @@ -72,9 +75,10 @@ type ListTasksInput struct { // 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 - // purposes. + // 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 name of the service to use when filtering the ListTasks results. Specifying @@ -82,8 +86,10 @@ type ListTasksInput struct { ServiceName *string // The startedBy value to filter the task results with. Specifying a startedBy - // value limits the results to tasks that were started with that value. When you - // specify startedBy as the filter, it must be the only filter that you use. + // value limits the results to tasks that were started with that value. + // + // When you specify startedBy as the filter, it must be the only filter that you + // use. StartedBy *string noSmithyDocumentSerde diff --git a/service/ecs/api_op_PutAccountSetting.go b/service/ecs/api_op_PutAccountSetting.go index 95e759cd471..989a1c7f359 100644 --- a/service/ecs/api_op_PutAccountSetting.go +++ b/service/ecs/api_op_PutAccountSetting.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies an account setting. Account settings are set on a per-Region basis. If -// you change the root user account setting, the default settings are reset for +// Modifies an account setting. Account settings are set on a per-Region basis. +// +// If you change the root user account setting, the default settings are reset for // users and roles that do not have specified individual account settings. 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. +// information, see [Account Settings]in the Amazon Elastic Container Service Developer Guide. +// +// [Account Settings]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html func (c *Client) PutAccountSetting(ctx context.Context, params *PutAccountSettingInput, optFns ...func(*Options)) (*PutAccountSettingOutput, error) { if params == nil { params = &PutAccountSettingInput{} @@ -33,8 +35,10 @@ func (c *Client) PutAccountSetting(ctx context.Context, params *PutAccountSettin type PutAccountSettingInput struct { - // The Amazon ECS account setting name to modify. The following are the valid - // values for the account setting name. + // The Amazon ECS account setting name to modify. + // + // The following are the valid values for the account setting name. + // // - serviceLongArnFormat - When modified, 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 @@ -42,6 +46,7 @@ type PutAccountSettingInput struct { // 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. + // // - taskLongArnFormat - When modified, 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 @@ -49,6 +54,7 @@ type PutAccountSettingInput struct { // 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. + // // - containerInstanceLongArnFormat - When modified, 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 @@ -56,60 +62,70 @@ type PutAccountSettingInput struct { // 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. + // // - awsvpcTrunking - When modified, the elastic network interface (ENI) limit // for any new container instances that support the feature is changed. If // awsvpcTrunking is turned on, 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Elastic Network Interface Trunking]in the Amazon Elastic Container Service Developer Guide. + // // - containerInsights - When modified, the default setting indicating whether // Amazon Web Services CloudWatch Container Insights is turned on for your clusters // is changed. If containerInsights is turned on, any new clusters that are // created will have Container Insights turned on 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) - // in the Amazon Elastic Container Service Developer Guide. + // cluster creation. For more information, see [CloudWatch Container Insights]in the Amazon Elastic Container + // Service Developer Guide. + // // - dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your // tasks using the awsvpc network mode can have an IPv6 address assigned. For - // more information on using IPv6 with tasks launched on Amazon EC2 instances, see - // Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack) - // . For more information on using IPv6 with tasks launched on Fargate, see - // Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack) - // . + // more information on using IPv6 with tasks launched on Amazon EC2 instances, see [Using a VPC in dual-stack mode] + // . For more information on using IPv6 with tasks launched on Fargate, see [Using a VPC in dual-stack mode]. + // // - fargateFIPSMode - If you specify fargateFIPSMode , Fargate FIPS 140 // compliance is affected. + // // - fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a // security or infrastructure update is needed for an Amazon ECS task hosted on // Fargate, the tasks need to be stopped and new tasks launched to replace them. // Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a - // Fargate task. For information about the Fargate tasks maintenance, see Amazon - // Web Services Fargate task maintenance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html) - // in the Amazon ECS Developer Guide. + // Fargate task. For information about the Fargate tasks maintenance, see [Amazon Web Services Fargate task maintenance]in the + // Amazon ECS Developer Guide. + // // - tagResourceAuthorization - Amazon ECS is introducing tagging authorization // for resource creation. Users must have permissions for actions that create the // resource, such as ecsCreateCluster . If tags are specified when you create a // resource, Amazon Web Services performs additional authorization to verify if // users or roles have permissions to create tags. Therefore, you must grant // explicit permissions to use the ecs:TagResource action. For more information, - // see Grant permission to tag resources on creation (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html) - // in the Amazon ECS Developer Guide. + // see [Grant permission to tag resources on creation]in the Amazon ECS Developer Guide. + // // - guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon // ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled // by your security administrator in your Amazon ECS account. Amazon GuardDuty - // controls this account setting on your behalf. For more information, see - // Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html) - // . + // controls this account setting on your behalf. For more information, see [Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring]. + // + // [Grant permission to tag resources on creation]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html + // [Using a VPC in dual-stack mode]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack + // [Amazon Web Services Fargate task maintenance]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html + // [Elastic Network Interface Trunking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html + // [Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html + // [CloudWatch Container Insights]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html // // This member is required. Name types.SettingName // The account setting value for the specified principal ARN. Accepted values are - // enabled , disabled , on , and off . When you specify - // fargateTaskRetirementWaitPeriod for the name , the following are the valid - // values: + // enabled , disabled , on , and off . + // + // When you specify fargateTaskRetirementWaitPeriod for the name , the following + // are the valid values: + // // - 0 - Amazon Web Services sends the notification, and immediately retires the // affected tasks. + // // - 7 - Amazon Web Services sends the notification, and waits 7 calendar days to // retire the tasks. + // // - 14 - Amazon Web Services sends the notification, and waits 14 calendar days // to retire the tasks. // @@ -120,9 +136,13 @@ type PutAccountSettingInput struct { // specify the root user, it modifies 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. You must use the root user when you set the Fargate wait - // time ( fargateTaskRetirementWaitPeriod ). Federated users assume the account - // setting of the root user and can't have explicit account settings set for them. + // authenticated user. + // + // You must use the root user when you set the Fargate wait time ( + // fargateTaskRetirementWaitPeriod ). + // + // Federated users assume the account setting of the root user and can't have + // explicit account settings set for them. PrincipalArn *string noSmithyDocumentSerde diff --git a/service/ecs/api_op_PutAccountSettingDefault.go b/service/ecs/api_op_PutAccountSettingDefault.go index c8bdf6f2f47..ef03478f8ba 100644 --- a/service/ecs/api_op_PutAccountSettingDefault.go +++ b/service/ecs/api_op_PutAccountSettingDefault.go @@ -31,8 +31,10 @@ func (c *Client) PutAccountSettingDefault(ctx context.Context, params *PutAccoun type PutAccountSettingDefaultInput struct { - // The resource name for which to modify the account setting. The following are - // the valid values for the account setting name. + // The resource name for which to modify the account setting. + // + // The following are the valid values for the account setting name. + // // - serviceLongArnFormat - When modified, 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 @@ -40,6 +42,7 @@ type PutAccountSettingDefaultInput struct { // 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. + // // - taskLongArnFormat - When modified, 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 @@ -47,6 +50,7 @@ type PutAccountSettingDefaultInput struct { // 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. + // // - containerInstanceLongArnFormat - When modified, 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 @@ -54,60 +58,70 @@ type PutAccountSettingDefaultInput struct { // 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. + // // - awsvpcTrunking - When modified, the elastic network interface (ENI) limit // for any new container instances that support the feature is changed. If // awsvpcTrunking is turned on, 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Elastic Network Interface Trunking]in the Amazon Elastic Container Service Developer Guide. + // // - containerInsights - When modified, the default setting indicating whether // Amazon Web Services CloudWatch Container Insights is turned on for your clusters // is changed. If containerInsights is turned on, any new clusters that are // created will have Container Insights turned on 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) - // in the Amazon Elastic Container Service Developer Guide. + // cluster creation. For more information, see [CloudWatch Container Insights]in the Amazon Elastic Container + // Service Developer Guide. + // // - dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your // tasks using the awsvpc network mode can have an IPv6 address assigned. For - // more information on using IPv6 with tasks launched on Amazon EC2 instances, see - // Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack) - // . For more information on using IPv6 with tasks launched on Fargate, see - // Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack) - // . + // more information on using IPv6 with tasks launched on Amazon EC2 instances, see [Using a VPC in dual-stack mode] + // . For more information on using IPv6 with tasks launched on Fargate, see [Using a VPC in dual-stack mode]. + // // - fargateFIPSMode - If you specify fargateFIPSMode , Fargate FIPS 140 // compliance is affected. + // // - fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a // security or infrastructure update is needed for an Amazon ECS task hosted on // Fargate, the tasks need to be stopped and new tasks launched to replace them. // Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a - // Fargate task. For information about the Fargate tasks maintenance, see Amazon - // Web Services Fargate task maintenance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html) - // in the Amazon ECS Developer Guide. + // Fargate task. For information about the Fargate tasks maintenance, see [Amazon Web Services Fargate task maintenance]in the + // Amazon ECS Developer Guide. + // // - tagResourceAuthorization - Amazon ECS is introducing tagging authorization // for resource creation. Users must have permissions for actions that create the // resource, such as ecsCreateCluster . If tags are specified when you create a // resource, Amazon Web Services performs additional authorization to verify if // users or roles have permissions to create tags. Therefore, you must grant // explicit permissions to use the ecs:TagResource action. For more information, - // see Grant permission to tag resources on creation (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html) - // in the Amazon ECS Developer Guide. + // see [Grant permission to tag resources on creation]in the Amazon ECS Developer Guide. + // // - guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon // ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled // by your security administrator in your Amazon ECS account. Amazon GuardDuty - // controls this account setting on your behalf. For more information, see - // Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html) - // . + // controls this account setting on your behalf. For more information, see [Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring]. + // + // [Grant permission to tag resources on creation]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html + // [Using a VPC in dual-stack mode]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack + // [Amazon Web Services Fargate task maintenance]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html + // [Elastic Network Interface Trunking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html + // [Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html + // [CloudWatch Container Insights]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html // // This member is required. Name types.SettingName // The account setting value for the specified principal ARN. Accepted values are - // enabled , disabled , on , and off . When you specify - // fargateTaskRetirementWaitPeriod for the name , the following are the valid - // values: + // enabled , disabled , on , and off . + // + // When you specify fargateTaskRetirementWaitPeriod for the name , the following + // are the valid values: + // // - 0 - Amazon Web Services sends the notification, and immediately retires the // affected tasks. + // // - 7 - Amazon Web Services sends the notification, and waits 7 calendar days to // retire the tasks. + // // - 14 - Amazon Web Services sends the notification, and waits 14 calendar days // to retire the tasks. // diff --git a/service/ecs/api_op_PutAttributes.go b/service/ecs/api_op_PutAttributes.go index b9392018097..bc5f942120c 100644 --- a/service/ecs/api_op_PutAttributes.go +++ b/service/ecs/api_op_PutAttributes.go @@ -13,9 +13,10 @@ 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] // in the Amazon Elastic Container Service Developer Guide. +// +// [Attributes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes func (c *Client) PutAttributes(ctx context.Context, params *PutAttributesInput, optFns ...func(*Options)) (*PutAttributesOutput, error) { if params == nil { params = &PutAttributesInput{} diff --git a/service/ecs/api_op_PutClusterCapacityProviders.go b/service/ecs/api_op_PutClusterCapacityProviders.go index 16afd82b88c..c0b2322623c 100644 --- a/service/ecs/api_op_PutClusterCapacityProviders.go +++ b/service/ecs/api_op_PutClusterCapacityProviders.go @@ -12,18 +12,21 @@ import ( ) // Modifies the available capacity providers and the default capacity provider -// strategy for a cluster. You must specify both the available capacity providers -// and a default capacity provider strategy for the cluster. If the specified -// cluster has existing capacity providers associated with it, you must specify all -// existing capacity providers in addition to any new ones you want to add. Any -// existing capacity providers that are associated with a cluster that are omitted -// from a PutClusterCapacityProviders API call will be disassociated with the -// cluster. You can only disassociate an existing capacity provider from a cluster -// if it's not being used by any existing tasks. When creating a service or running -// 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. +// strategy for a cluster. +// +// You must specify both the available capacity providers and a default capacity +// provider strategy for the cluster. If the specified cluster has existing +// capacity providers associated with it, you must specify all existing capacity +// providers in addition to any new ones you want to add. Any existing capacity +// providers that are associated with a cluster that are omitted from a PutClusterCapacityProvidersAPI call +// will be disassociated with the cluster. You can only disassociate an existing +// capacity provider from a cluster if it's not being used by any existing tasks. +// +// When creating a service or running 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. func (c *Client) PutClusterCapacityProviders(ctx context.Context, params *PutClusterCapacityProvidersInput, optFns ...func(*Options)) (*PutClusterCapacityProvidersOutput, error) { if params == nil { params = &PutClusterCapacityProvidersInput{} @@ -41,13 +44,15 @@ func (c *Client) PutClusterCapacityProviders(ctx context.Context, params *PutClu type PutClusterCapacityProvidersInput struct { - // The name of one or more capacity providers to associate with the cluster. If - // specifying a capacity provider that uses an Auto Scaling group, the capacity + // The name of one or more capacity providers to associate with the cluster. + // + // If specifying a capacity provider that uses an Auto Scaling group, the capacity // provider must already be created. New 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. + // CreateCapacityProviderAPI 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. // // This member is required. CapacityProviders []string @@ -59,20 +64,25 @@ type PutClusterCapacityProvidersInput struct { // This member is required. Cluster *string - // The capacity provider strategy to use by default for the cluster. When creating - // a service or running a task on a cluster, if no capacity provider or launch type - // is specified then the default capacity provider strategy for the cluster is - // used. A capacity provider strategy consists of one or more capacity providers - // along with the base and weight to assign to them. A capacity provider must be - // associated with the cluster to be used in a capacity provider strategy. The - // PutClusterCapacityProviders API is used to associate a capacity provider with a - // cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. + // The capacity provider strategy to use by default for the cluster. + // + // When creating a service or running a task on a cluster, if no capacity provider + // or launch type is specified then the default capacity provider strategy for the + // cluster is used. + // + // A capacity provider strategy consists of one or more capacity providers along + // with the base and weight to assign to them. A capacity provider must be + // associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProvidersAPI + // is used to associate a capacity provider with a cluster. Only capacity providers + // with an ACTIVE or UPDATING status can be used. + // // If specifying a capacity provider that uses an Auto Scaling group, the capacity // provider must already be created. New 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. + // CreateCapacityProviderAPI 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. // // This member is required. DefaultCapacityProviderStrategy []types.CapacityProviderStrategyItem diff --git a/service/ecs/api_op_RegisterContainerInstance.go b/service/ecs/api_op_RegisterContainerInstance.go index 45e3a17e690..08396956120 100644 --- a/service/ecs/api_op_RegisterContainerInstance.go +++ b/service/ecs/api_op_RegisterContainerInstance.go @@ -12,8 +12,10 @@ import ( ) // 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. +// 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{} @@ -58,17 +60,26 @@ type RegisterContainerInstanceInput struct { // 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: + // 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 diff --git a/service/ecs/api_op_RegisterTaskDefinition.go b/service/ecs/api_op_RegisterTaskDefinition.go index 7fe1549daaa..18ee42e0505 100644 --- a/service/ecs/api_op_RegisterTaskDefinition.go +++ b/service/ecs/api_op_RegisterTaskDefinition.go @@ -14,22 +14,27 @@ import ( // Registers a new task definition from the supplied family and // 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) -// 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) -// 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 the Amazon Elastic Container Service Developer Guide. +// parameters and defaults, see [Amazon ECS Task Definitions]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]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]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 NetworkConfigurationwhen you create a service or run a task with the task +// definition. For more information, see [Task Networking]in the Amazon Elastic Container Service +// Developer Guide. +// +// [Amazon ECS Task Definitions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html +// [Task Networking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html +// [IAM Roles for Tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html +// [Network settings]: https://docs.docker.com/engine/reference/run/#/network-settings func (c *Client) RegisterTaskDefinition(ctx context.Context, params *RegisterTaskDefinitionInput, optFns ...func(*Options)) (*RegisterTaskDefinitionOutput, error) { if params == nil { params = &RegisterTaskDefinitionInput{} @@ -64,47 +69,68 @@ type RegisterTaskDefinitionInput struct { // 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 - // 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 - // 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. + // 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 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. + // + // 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. + // + // 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 Using - // data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) - // in the Amazon ECS Developer Guide. For tasks using the Fargate launch type, the - // task requires the following platforms: + // default amount, for tasks hosted on Fargate. For more information, see [Using data volumes in tasks]in the + // Amazon ECS Developer Guide. + // + // For tasks using the Fargate launch type, the task requires the following + // platforms: + // // - Linux platform version 1.4.0 or later. + // // - Windows platform version 1.0.0 or later. + // + // [Using data volumes in tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // requirements of your task. For more information, see [Amazon ECS task execution IAM role]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Amazon ECS task execution IAM role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html ExecutionRoleArn *string // The Elastic Inference accelerators to use for the containers in the task. @@ -119,88 +145,132 @@ type RegisterTaskDefinitionInput struct { // 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 + // information, see [IPC settings]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]. + // + // 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 more information, see [System Controls]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. + // + // [System Controls]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html + // [Docker security]: https://docs.docker.com/engine/security/security/ + // [IPC settings]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc 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 - // 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) + // 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. + // 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. + // 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 - // 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 - // the corresponding host port (for the host network mode) or the attached elastic - // 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 - // 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) - // 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 - // 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. + // 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 the corresponding host port (for the host network mode) or the + // attached elastic 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 allocated an elastic network + // interface, and you must specify a NetworkConfigurationvalue when you create a service or run a task + // with the task definition. For more information, see [Task Networking]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 container instance when port mappings are used. + // + // For more information, see [Network settings] in the Docker run reference. + // + // [Task Networking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html + // [Network settings]: https://docs.docker.com/engine/reference/run/#network-settings NetworkMode types.NetworkMode // The process namespace to use for the containers in the task. The valid values // are host or task . On Fargate for Linux containers, the only valid value is task // . For example, monitoring sidecars might need pidMode to access information - // about other containers running in the same task. If host is specified, 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 each container. 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, there's a heightened - // risk of undesired process namespace exposure. For more information, see Docker - // security (https://docs.docker.com/engine/security/security/) . This parameter is - // not supported for Windows containers. This parameter is only supported for tasks - // that are hosted on Fargate if the tasks are using platform version 1.4.0 or - // later (Linux). This isn't supported for Windows containers on Fargate. + // about other containers running in the same task. + // + // If host is specified, 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 each + // container. For more information, see [PID settings]in the Docker run reference. + // + // If the host PID mode is used, there's a heightened risk of undesired process + // namespace exposure. For more information, see [Docker security]. + // + // This parameter is not supported for Windows containers. + // + // This parameter is only supported for tasks that are hosted on Fargate if the + // tasks are using platform version 1.4.0 or later (Linux). This isn't supported + // for Windows containers on Fargate. + // + // [PID settings]: https://docs.docker.com/engine/reference/run/#pid-settings---pid + // [Docker security]: https://docs.docker.com/engine/security/security/ PidMode types.PidMode // An array of placement constraint objects to use for the task. You can specify a @@ -208,14 +278,16 @@ 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 - // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service Developer Guide. + // + // [Amazon ECS-optimized AMI versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html ProxyConfiguration *types.ProxyConfiguration // The task launch type that Amazon ECS validates the task definition against. A @@ -225,24 +297,34 @@ type RegisterTaskDefinitionInput struct { RequiresCompatibilities []types.Compatibility // The operating system that your tasks definitions run on. A platform family is - // specified only for tasks using the Fargate launch type. When you specify a task - // definition in a service, this value must match the runtimePlatform value of the - // service. + // specified only for tasks using the Fargate launch type. + // + // When you specify a task definition in a service, this value must match the + // runtimePlatform value of the service. RuntimePlatform *types.RuntimePlatform // 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: + // 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 @@ -251,9 +333,10 @@ type RegisterTaskDefinitionInput struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. + // permissions that are specified in this role. For more information, see [IAM Roles for Tasks]in the + // Amazon Elastic Container Service Developer Guide. + // + // [IAM Roles for Tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html TaskRoleArn *string // A list of volume definitions in JSON format that containers in your task might diff --git a/service/ecs/api_op_RunTask.go b/service/ecs/api_op_RunTask.go index 267932c8ace..25ce9d677ee 100644 --- a/service/ecs/api_op_RunTask.go +++ b/service/ecs/api_op_RunTask.go @@ -11,41 +11,55 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a new task using the specified task definition. On March 21, 2024, a -// change was made to resolve the task definition revision before authorization. -// When a task definition revision is not specified, authorization will occur using -// the latest revision of a 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) -// 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 -// 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 customers and will be able to continue -// using the service. You can attach Amazon EBS volumes to Amazon ECS tasks by -// configuring the volume when creating or updating a service. For more infomation, -// see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) -// in the Amazon Elastic Container Service Developer Guide. The Amazon ECS API -// follows an eventual consistency model. This is because of the distributed nature -// of the system supporting the API. This 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: +// Starts a new task using the specified task definition. +// +// On March 21, 2024, a change was made to resolve the task definition revision +// before authorization. When a task definition revision is not specified, +// authorization will occur using the latest revision of a 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]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 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 customers and will be able to continue using the service. +// +// You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume +// when creating or updating a service. For more infomation, see [Amazon EBS volumes]in the Amazon +// Elastic Container Service Developer Guide. +// +// The Amazon ECS API follows an eventual consistency model. This is because of +// the distributed nature of the system supporting the API. This 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. +// +// [Scheduling Tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html +// [Amazon EBS volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types func (c *Client) RunTask(ctx context.Context, params *RunTaskInput, optFns ...func(*Options)) (*RunTaskOutput, error) { if params == nil { params = &RunTaskInput{} @@ -64,35 +78,48 @@ 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. The - // full ARN value must match the value that you specified as the Resource of the - // principal's permissions policy. When you specify a task definition, you must - // either specify a specific revision, or all revisions in the ARN. To specify a - // specific revision, include the revision number in the ARN. For example, to - // specify revision 2, use - // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2 . To specify - // all revisions, use the wildcard (*) in the ARN. For example, to specify all - // revisions, use - // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:* . 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. + // to run. If a revision isn't specified, the latest ACTIVE revision is used. + // + // The full ARN value must match the value that you specified as the Resource of + // the principal's permissions policy. + // + // When you specify a task definition, you must either specify a specific + // revision, or all revisions in the ARN. + // + // To specify a specific revision, include the revision number in the ARN. For + // example, to specify revision 2, use + // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2 . + // + // To specify all revisions, use the wildcard (*) in the ARN. For example, to + // specify all revisions, use + // arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:* . + // + // For more information, see [Policy Resources for Amazon ECS] in the Amazon Elastic Container Service Developer + // Guide. + // + // [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 // // 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 + // 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 - // defaultCapacityProviderStrategy for the cluster is used. When you use cluster - // auto scaling, you must specify capacityProviderStrategy and not launchType . A - // capacity provider strategy may contain a maximum of 6 capacity providers. + // defaultCapacityProviderStrategy for the cluster is used. + // + // When you use cluster auto scaling, you must specify capacityProviderStrategy + // and not launchType . + // + // 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 64 characters are allowed. The valid // characters are characters in the range of 33-126, inclusive. For more - // information, see Ensuring idempotency (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html) - // . + // information, see [Ensuring idempotency]. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html ClientToken *string // The short name or full Amazon Resource Name (ARN) of the cluster to run your @@ -104,40 +131,54 @@ type RunTaskInput struct { 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Tagging Your Amazon ECS Resources]in the Amazon Elastic Container Service Developer Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html 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. + // 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 ). 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/developerguide/fargate-capacity-providers.html) - // in the Amazon ECS Developer Guide. 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 . + // The infrastructure to run your standalone task on. For more information, see [Amazon ECS launch types] + // 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]in the Amazon ECS Developer + // Guide. + // + // 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 . + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html + // [Fargate capacity providers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Task networking]in the Amazon Elastic Container Service Developer Guide. + // + // [Task networking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html NetworkConfiguration *types.NetworkConfiguration // A list of container overrides in JSON format that specify the name of a @@ -146,8 +187,10 @@ type RunTaskInput struct { // task definition or Docker image) with a command override. You can also override // existing environment variables (that are specified in the task definition or // Docker image) on a container or add new environment variables to it with an - // environment override. A total of 8192 characters are allowed for overrides. This - // limit includes the JSON formatting characters of the override structure. + // environment override. + // + // A total of 8192 characters are allowed for overrides. This 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 @@ -161,15 +204,18 @@ type RunTaskInput struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. + // used. For more information, see [Fargate platform versions]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Fargate platform versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html 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. + // creation, use the TagResourceAPI 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 @@ -179,26 +225,36 @@ type RunTaskInput struct { // An optional tag specified when a task is started. For example, if you // automatically trigger a task to run a batch process job, you could apply a // unique identifier for that job to your task with the startedBy parameter. You - // can then identify which tasks belong to that job by filtering the results of a - // ListTasks call with the startedBy value. Up to 128 letters (uppercase and - // lowercase), numbers, hyphens (-), and underscores (_) are allowed. If a task is - // started by an Amazon ECS service, then the startedBy parameter contains the - // deployment ID of the service that starts it. + // can then identify which tasks belong to that job by filtering the results of a ListTasks + // call with the startedBy value. Up to 128 letters (uppercase and lowercase), + // numbers, hyphens (-), and underscores (_) are allowed. + // + // If a task is started by an Amazon ECS service, then the startedBy parameter + // contains the deployment ID of the service that starts it. StartedBy *string // 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: + // 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 @@ -206,9 +262,10 @@ type RunTaskInput struct { Tags []types.Tag // The details of the volume that was configuredAtLaunch . You can configure the - // size, volumeType, IOPS, throughput, snapshot and encryption in in - // TaskManagedEBSVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html) - // . The name of the volume must match the name from the task definition. + // size, volumeType, IOPS, throughput, snapshot and encryption in in [TaskManagedEBSVolumeConfiguration]. The name of + // the volume must match the name from the task definition. + // + // [TaskManagedEBSVolumeConfiguration]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html VolumeConfigurations []types.TaskVolumeConfiguration noSmithyDocumentSerde @@ -216,10 +273,13 @@ type RunTaskInput struct { type RunTaskOutput struct { - // Any failures associated with the call. For information about how to address - // failures, see Service event messages (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html#service-event-messages-list) - // and API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) - // in the Amazon Elastic Container Service Developer Guide. + // Any failures associated with the call. + // + // For information about how to address failures, see [Service event messages] and [API failure reasons] in the Amazon Elastic + // Container Service Developer Guide. + // + // [API failure reasons]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html + // [Service event messages]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html#service-event-messages-list Failures []types.Failure // A full description of the tasks that were run. The tasks that were successfully diff --git a/service/ecs/api_op_StartTask.go b/service/ecs/api_op_StartTask.go index 116d063f30c..894f24ede51 100644 --- a/service/ecs/api_op_StartTask.go +++ b/service/ecs/api_op_StartTask.go @@ -12,22 +12,29 @@ import ( ) // Starts a new task from the specified task definition on the specified container -// instance or instances. On March 21, 2024, a change was made to resolve the task -// definition revision before authorization. When a task definition revision is not -// specified, authorization will occur using the latest revision of a task -// definition. 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 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) -// in the Amazon Elastic Container Service Developer Guide. You can attach Amazon -// EBS volumes to Amazon ECS tasks by configuring the volume when creating or -// updating a service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) +// instance or instances. +// +// On March 21, 2024, a change was made to resolve the task definition revision +// before authorization. When a task definition revision is not specified, +// authorization will occur using the latest revision of a task definition. +// +// 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 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] // in the Amazon Elastic Container Service Developer Guide. +// +// You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume +// when creating or updating a service. For more infomation, see [Amazon EBS volumes]in the Amazon +// Elastic Container Service Developer Guide. +// +// [Scheduling Tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html +// [Amazon EBS volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types func (c *Client) StartTask(ctx context.Context, params *StartTaskInput, optFns ...func(*Options)) (*StartTaskOutput, error) { if params == nil { params = &StartTaskInput{} @@ -63,8 +70,9 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Tagging Your Amazon ECS Resources]in the Amazon Elastic Container Service Developer Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags bool // Whether or not the execute command functionality is turned on for the task. If @@ -86,8 +94,10 @@ type StartTaskInput struct { // definition or Docker image) with a command override. You can also override // existing environment variables (that are specified in the task definition or // Docker image) on a container or add new environment variables to it with an - // environment override. A total of 8192 characters are allowed for overrides. This - // limit includes the JSON formatting characters of the override structure. + // environment override. + // + // A total of 8192 characters are allowed for overrides. This limit includes the + // JSON formatting characters of the override structure. Overrides *types.TaskOverride // Specifies whether to propagate the tags from the task definition or the service @@ -100,26 +110,36 @@ type StartTaskInput struct { // An optional tag specified when a task is started. For example, if you // automatically trigger a task to run a batch process job, you could apply a // unique identifier for that job to your task with the startedBy parameter. You - // can then identify which tasks belong to that job by filtering the results of a - // ListTasks call with the startedBy value. Up to 36 letters (uppercase and - // lowercase), numbers, hyphens (-), and underscores (_) are allowed. If a task is - // started by an Amazon ECS service, the startedBy parameter contains the - // deployment ID of the service that starts it. + // can then identify which tasks belong to that job by filtering the results of a ListTasks + // call with the startedBy value. Up to 36 letters (uppercase and lowercase), + // numbers, hyphens (-), and underscores (_) are allowed. + // + // If a task is started by an Amazon ECS service, the startedBy parameter contains + // the deployment ID of the service that starts it. StartedBy *string // 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: + // 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 @@ -127,9 +147,10 @@ type StartTaskInput struct { Tags []types.Tag // The details of the volume that was configuredAtLaunch . You can configure the - // size, volumeType, IOPS, throughput, snapshot and encryption in - // TaskManagedEBSVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html) - // . The name of the volume must match the name from the task definition. + // size, volumeType, IOPS, throughput, snapshot and encryption in [TaskManagedEBSVolumeConfiguration]. The name of + // the volume must match the name from the task definition. + // + // [TaskManagedEBSVolumeConfiguration]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskManagedEBSVolumeConfiguration.html VolumeConfigurations []types.TaskVolumeConfiguration noSmithyDocumentSerde diff --git a/service/ecs/api_op_StopTask.go b/service/ecs/api_op_StopTask.go index 8d979dce8dc..659fcc481da 100644 --- a/service/ecs/api_op_StopTask.go +++ b/service/ecs/api_op_StopTask.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a running task. Any tags associated with the task will be deleted. When -// StopTask is called on a task, the equivalent of docker stop is issued to the +// Stops a running task. Any tags associated with the task will be deleted. +// +// When StopTask is called on a task, the equivalent of docker stop is issued to the // 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] // in the Amazon Elastic Container Service Developer Guide. +// +// [Amazon ECS Container Agent Configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html func (c *Client) StopTask(ctx context.Context, params *StopTaskInput, optFns ...func(*Options)) (*StopTaskOutput, error) { if params == nil { params = &StopTaskInput{} @@ -49,8 +52,8 @@ type StopTaskInput struct { // An optional message specified when a task is stopped. For example, if you're // using a custom scheduler, you can use this parameter to specify the reason for - // stopping the task here, and the message appears in subsequent DescribeTasks API - // operations on this task. + // stopping the task here, and the message appears in subsequent DescribeTasksAPI operations on + // this task. Reason *string noSmithyDocumentSerde diff --git a/service/ecs/api_op_SubmitAttachmentStateChanges.go b/service/ecs/api_op_SubmitAttachmentStateChanges.go index e5761b7756e..6796dbc7f3b 100644 --- a/service/ecs/api_op_SubmitAttachmentStateChanges.go +++ b/service/ecs/api_op_SubmitAttachmentStateChanges.go @@ -12,7 +12,9 @@ import ( ) // 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. +// 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 e343aa822b0..ba8bcb565e2 100644 --- a/service/ecs/api_op_SubmitContainerStateChange.go +++ b/service/ecs/api_op_SubmitContainerStateChange.go @@ -12,7 +12,9 @@ import ( ) // 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. +// 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 dbf4fc9917b..64fbf9caef3 100644 --- a/service/ecs/api_op_SubmitTaskStateChange.go +++ b/service/ecs/api_op_SubmitTaskStateChange.go @@ -13,7 +13,9 @@ import ( ) // 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. +// 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 78f9c8d8ffa..290dbd4d0e8 100644 --- a/service/ecs/api_op_TagResource.go +++ b/service/ecs/api_op_TagResource.go @@ -39,18 +39,26 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The tags to add to the resource. A tag is an array of key-value pairs. The - // following basic restrictions apply to tags: + // 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 diff --git a/service/ecs/api_op_UpdateCluster.go b/service/ecs/api_op_UpdateCluster.go index 66ca56f1b88..f3f579821da 100644 --- a/service/ecs/api_op_UpdateCluster.go +++ b/service/ecs/api_op_UpdateCluster.go @@ -43,13 +43,16 @@ type UpdateClusterInput struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html ServiceConnectDefaults *types.ClusterServiceConnectDefaultsRequest // The cluster settings for your cluster. diff --git a/service/ecs/api_op_UpdateClusterSettings.go b/service/ecs/api_op_UpdateClusterSettings.go index 7a350a54f43..3c309051f4f 100644 --- a/service/ecs/api_op_UpdateClusterSettings.go +++ b/service/ecs/api_op_UpdateClusterSettings.go @@ -36,13 +36,13 @@ 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. + // 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. // // This member is required. Settings []types.ClusterSetting diff --git a/service/ecs/api_op_UpdateContainerAgent.go b/service/ecs/api_op_UpdateContainerAgent.go index 601fd0fe7e7..32bc5283a73 100644 --- a/service/ecs/api_op_UpdateContainerAgent.go +++ b/service/ecs/api_op_UpdateContainerAgent.go @@ -15,19 +15,24 @@ import ( // Updating the Amazon ECS container agent doesn't interrupt running tasks or // services on the container instance. The process for updating the agent differs // depending on whether your container instance was launched with the Amazon -// ECS-optimized AMI or another operating system. The UpdateContainerAgent API -// 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) -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// ECS-optimized AMI or another operating system. +// +// The UpdateContainerAgent API 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]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]in the Amazon +// Elastic Container Service Developer Guide. +// +// [Updating the Amazon ECS container agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html +// [Manually updating the Amazon ECS container agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent func (c *Client) UpdateContainerAgent(ctx context.Context, params *UpdateContainerAgentInput, optFns ...func(*Options)) (*UpdateContainerAgentOutput, error) { if params == nil { params = &UpdateContainerAgentInput{} diff --git a/service/ecs/api_op_UpdateContainerInstancesState.go b/service/ecs/api_op_UpdateContainerInstancesState.go index fa92967501a..fbbd1faf1c5 100644 --- a/service/ecs/api_op_UpdateContainerInstancesState.go +++ b/service/ecs/api_op_UpdateContainerInstancesState.go @@ -11,21 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the status of an Amazon ECS container instance. Once a container -// instance has reached an ACTIVE state, you can change the status of a container -// instance to DRAINING to manually remove an instance from a cluster, for example -// 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 -// 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 . +// Modifies the status of an Amazon ECS container instance. +// +// Once a container instance has reached an ACTIVE state, you can change the +// status of a container instance to DRAINING to manually remove an instance from +// a cluster, for example 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 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. +// // - 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 @@ -35,6 +41,7 @@ import ( // 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 @@ -44,11 +51,14 @@ import ( // 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 -// 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 -// instance to ACTIVE status and once it has reached that status the Amazon ECS -// scheduler can begin scheduling tasks on the instance again. +// 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 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) { if params == nil { params = &UpdateContainerInstancesStateInput{} diff --git a/service/ecs/api_op_UpdateService.go b/service/ecs/api_op_UpdateService.go index 8e3f0dfa3fc..e54334ec012 100644 --- a/service/ecs/api_op_UpdateService.go +++ b/service/ecs/api_op_UpdateService.go @@ -11,54 +11,66 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a service. On March 21, 2024, a change was made to -// resolve the task definition revision before authorization. When a task -// definition revision is not specified, authorization will occur using the latest -// revision of a task definition. 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. You can attach Amazon EBS volumes to Amazon ECS tasks by -// configuring the volume when starting or running a task, or when creating or -// updating a service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) -// in the Amazon Elastic Container Service Developer Guide. You can update your -// volume configurations and trigger a new deployment. volumeConfigurations is -// only supported for REPLICA service and not DAEMON service. If you leave -// volumeConfigurations null , it doesn't trigger a new deployment. For more -// infomation on volumes, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) -// in the Amazon Elastic Container Service Developer Guide. 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 -// parameter. You can attach Amazon EBS volumes to Amazon ECS tasks by configuring -// the volume when starting or running a task, or when creating or updating a -// service. For more infomation, see Amazon EBS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) -// in the Amazon Elastic Container Service Developer Guide. If you have updated the -// container 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 service scheduler uses the -// deployment configuration parameters, minimumHealthyPercent and maximumPercent , -// to determine the deployment strategy. +// Modifies the parameters of a service. +// +// On March 21, 2024, a change was made to resolve the task definition revision +// before authorization. When a task definition revision is not specified, +// authorization will occur using the latest revision of a task definition. +// +// 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. +// +// You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume +// when starting or running a task, or when creating or updating a service. For +// more infomation, see [Amazon EBS volumes]in the Amazon Elastic Container Service Developer Guide. +// You can update your volume configurations and trigger a new deployment. +// volumeConfigurations is only supported for REPLICA service and not DAEMON +// service. If you leave volumeConfigurations null , it doesn't trigger a new +// deployment. For more infomation on volumes, see [Amazon EBS volumes]in the Amazon Elastic Container +// Service Developer Guide. +// +// 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]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 parameter. +// +// You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume +// when starting or running a task, or when creating or updating a service. For +// more infomation, see [Amazon EBS volumes]in the Amazon Elastic Container Service Developer Guide. +// +// If you have updated the container 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 +// service scheduler uses the deployment configuration parameters, +// 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 @@ -66,50 +78,64 @@ import ( // 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). // -// 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. +// 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: +// // - loadBalancers , +// // - serviceRegistries // -// For more information about the role see the CreateService request parameter role (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role) +// For more information about the role see the CreateService request parameter [role]role // . +// +// [role]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role +// [Amazon EBS volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types +// [CreateDeployment]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error) { if params == nil { params = &UpdateServiceInput{} @@ -132,25 +158,30 @@ 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 - // 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 - // to use the cluster's default capacity provider strategy. A capacity provider - // strategy consists of one or more capacity providers along with the base and - // weight to assign to them. A capacity provider must be associated with the - // cluster to be used in a capacity provider strategy. The - // PutClusterCapacityProviders API is used to associate a capacity provider with a - // cluster. Only capacity providers with an ACTIVE or UPDATING status can be used. + // 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 to use the cluster's default capacity provider strategy. + // + // A capacity provider strategy consists of one or more capacity providers along + // with the base and weight to assign to them. A capacity provider must be + // associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProvidersAPI + // is used to associate a capacity provider with a cluster. Only capacity providers + // with an ACTIVE or UPDATING status can be used. + // // If specifying a capacity provider that uses an Auto Scaling group, the capacity // provider must already be created. New 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. The PutClusterCapacityProviders API operation is - // used to update the list of available capacity providers for a cluster after the - // cluster is created. + // CreateCapacityProviderAPI 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 cluster is created. CapacityProviderStrategy []types.CapacityProviderStrategyItem // The short name or full Amazon Resource Name (ARN) of the cluster that your @@ -167,16 +198,20 @@ 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) - // 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. + // service. For more information, see [Tagging Your Amazon ECS Resources]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. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags *bool - // 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. + // 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 // Determines whether to force a new deployment of the service. By default, @@ -200,24 +235,30 @@ type UpdateServiceInput struct { // A list of Elastic Load Balancing load balancer objects. It contains the load // balancer name, the container name, and the container port to access from the // load balancer. The container name is as it appears in a container definition. - // When you add, update, or remove a load balancer configuration, Amazon ECS starts - // new tasks with the updated Elastic Load Balancing configuration, and then stops - // the old tasks when the new tasks are running. For services that use rolling - // updates, you can add, update, or remove Elastic Load Balancing target groups. - // 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) - // 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) - // 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) - // in the Amazon Elastic Container Service Developer Guide. You can remove existing - // loadBalancers by passing an empty list. + // + // When you add, update, or remove a load balancer configuration, Amazon ECS + // starts new tasks with the updated Elastic Load Balancing configuration, and then + // stops the old tasks when the new tasks are running. + // + // For services that use rolling updates, you can add, update, or remove Elastic + // Load Balancing target groups. 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]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] + // 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]. Note that multiple target groups are not + // supported for external deployments. For more information see [Register multiple target groups with a service]in the Amazon + // Elastic Container Service Developer Guide. + // + // You can remove existing loadBalancers by passing an empty list. + // + // [CreateTaskSet]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html + // [Register multiple target groups with a service]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html + // [CreateDeployment]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html LoadBalancers []types.LoadBalancer // An object representing the network configuration for the service. @@ -227,49 +268,60 @@ type UpdateServiceInput struct { // no value is specified, the existing placement constraints for the service will // remain unchanged. If this value is specified, it will override any existing // placement constraints defined for the service. To remove all existing placement - // constraints, specify an empty array. You can specify a maximum of 10 constraints - // for each task. This limit includes constraints in the task definition and those - // specified at runtime. + // constraints, specify an empty array. + // + // You can specify a maximum of 10 constraints for each task. This limit includes + // constraints in the task definition and those 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 // 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 - // each service. + // specify an empty object. + // + // You can specify a maximum of five strategy rules for each service. PlacementStrategy []types.PlacementStrategy // 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) - // in the Amazon Elastic Container Service Developer Guide. + // see [Fargate Platform Versions]in the Amazon Elastic Container Service Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html 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. + // 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 - // 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. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html 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 + // more information, see [Service Discovery]. + // + // 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. + // stops the old tasks when the new tasks are running. + // + // You can remove existing serviceRegistries by passing an empty list. + // + // [Service Discovery]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html ServiceRegistries []types.ServiceRegistry // The family and revision ( family:revision ) or full ARN of the task definition @@ -280,11 +332,12 @@ type UpdateServiceInput struct { TaskDefinition *string // The details of the volume that was configuredAtLaunch . You can configure the - // size, volumeType, IOPS, throughput, snapshot and encryption in - // ServiceManagedEBSVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html) - // . The name of the volume must match the name from the task definition. If set - // to null, no new deployment is triggered. Otherwise, if this configuration - // differs from the existing one, it triggers a new deployment. + // size, volumeType, IOPS, throughput, snapshot and encryption in [ServiceManagedEBSVolumeConfiguration]. The name of + // the volume must match the name from the task definition. If set to null, no new + // deployment is triggered. Otherwise, if this configuration differs from the + // existing one, it triggers a new deployment. + // + // [ServiceManagedEBSVolumeConfiguration]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html VolumeConfigurations []types.ServiceVolumeConfiguration noSmithyDocumentSerde diff --git a/service/ecs/api_op_UpdateServicePrimaryTaskSet.go b/service/ecs/api_op_UpdateServicePrimaryTaskSet.go index 7833fb384a1..568a285b4e4 100644 --- a/service/ecs/api_op_UpdateServicePrimaryTaskSet.go +++ b/service/ecs/api_op_UpdateServicePrimaryTaskSet.go @@ -14,8 +14,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// type. For more information, see [Amazon ECS Deployment Types]in the Amazon Elastic Container Service +// Developer Guide. +// +// [Amazon ECS Deployment Types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html func (c *Client) UpdateServicePrimaryTaskSet(ctx context.Context, params *UpdateServicePrimaryTaskSetInput, optFns ...func(*Options)) (*UpdateServicePrimaryTaskSetOutput, error) { if params == nil { params = &UpdateServicePrimaryTaskSetInput{} diff --git a/service/ecs/api_op_UpdateTaskProtection.go b/service/ecs/api_op_UpdateTaskProtection.go index ebf9bf83d38..f225ac67423 100644 --- a/service/ecs/api_op_UpdateTaskProtection.go +++ b/service/ecs/api_op_UpdateTaskProtection.go @@ -12,25 +12,34 @@ 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 +// to protect your task from termination during scale-in events from [Service Autoscaling]or [deployments]. +// +// Task-protection, by default, expires after 2 hours at which point Amazon ECS // clears 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 -// 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) -// 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) -// . +// 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 protection expiration period of a task by +// invoking this operation repeatedly. +// +// To learn more about Amazon ECS task protection, see [Task scale-in protection] 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]. +// +// If you prefer to set task protection from within the container, we recommend +// using the [Task scale-in protection endpoint]. +// +// [deployments]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html +// [API failure reasons]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html +// [Task scale-in protection endpoint]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html +// [Task scale-in protection]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html +// [Service Autoscaling]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html func (c *Client) UpdateTaskProtection(ctx context.Context, params *UpdateTaskProtectionInput, optFns ...func(*Options)) (*UpdateTaskProtectionOutput, error) { if params == nil { params = &UpdateTaskProtectionInput{} @@ -69,8 +78,10 @@ type UpdateTaskProtectionInput struct { // 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 @@ -82,10 +93,13 @@ 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 turned on 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 diff --git a/service/ecs/api_op_UpdateTaskSet.go b/service/ecs/api_op_UpdateTaskSet.go index b63903a6cd4..75f665c423f 100644 --- a/service/ecs/api_op_UpdateTaskSet.go +++ b/service/ecs/api_op_UpdateTaskSet.go @@ -12,8 +12,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// controller type. For more information, see [Amazon ECS Deployment Types]in the Amazon Elastic Container +// Service Developer Guide. +// +// [Amazon ECS Deployment Types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html func (c *Client) UpdateTaskSet(ctx context.Context, params *UpdateTaskSetInput, optFns ...func(*Options)) (*UpdateTaskSetOutput, error) { if params == nil { params = &UpdateTaskSetInput{} diff --git a/service/ecs/doc.go b/service/ecs/doc.go index 0f15f7eccd8..97103d61942 100644 --- a/service/ecs/doc.go +++ b/service/ecs/doc.go @@ -3,19 +3,22 @@ // Package ecs provides the API client, operations, and parameter types for Amazon // EC2 Container Service. // -// Amazon Elastic Container Service Amazon Elastic Container Service (Amazon ECS) -// is a highly scalable, fast, container management service. It makes it easy to -// run, stop, and manage Docker containers. You can host your cluster on a -// serverless infrastructure that's managed by Amazon ECS by launching your -// services or tasks on Fargate. For more control, you can host your tasks on a -// cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) -// instances that you manage. Amazon ECS makes it easy to launch and stop -// container-based applications with simple API calls. This makes it easy to get -// the state of your cluster from a centralized service, and gives you access to -// many familiar Amazon EC2 features. You can use Amazon ECS to schedule the -// placement of containers across your cluster based on your resource needs, -// isolation policies, and availability requirements. With Amazon ECS, you don't -// need to operate your own cluster management and configuration management -// systems. You also don't need to worry about scaling your management -// infrastructure. +// # Amazon Elastic Container Service +// +// Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, +// container management service. It makes it easy to run, stop, and manage Docker +// containers. You can host your cluster on a serverless infrastructure that's +// managed by Amazon ECS by launching your services or tasks on Fargate. For more +// control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud +// (Amazon EC2) or External (on-premises) instances that you manage. +// +// Amazon ECS makes it easy to launch and stop container-based applications with +// simple API calls. This makes it easy to get the state of your cluster from a +// centralized service, and gives you access to many familiar Amazon EC2 features. +// +// You can use Amazon ECS to schedule the placement of containers across your +// cluster based on your resource needs, isolation policies, and availability +// requirements. With Amazon ECS, you don't need to operate your own cluster +// management and configuration management systems. You also don't need to worry +// about scaling your management infrastructure. package ecs diff --git a/service/ecs/options.go b/service/ecs/options.go index 9ecc7a35755..31a57c2eba2 100644 --- a/service/ecs/options.go +++ b/service/ecs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ecs/types/enums.go b/service/ecs/types/enums.go index a94b14e6523..c84dcc9c706 100644 --- a/service/ecs/types/enums.go +++ b/service/ecs/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AgentUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentUpdateStatus) Values() []AgentUpdateStatus { return []AgentUpdateStatus{ "PENDING", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for ApplicationProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationProtocol) Values() []ApplicationProtocol { return []ApplicationProtocol{ "http", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for AssignPublicIp. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignPublicIp) Values() []AssignPublicIp { return []AssignPublicIp{ "ENABLED", @@ -74,8 +77,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TAGS", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for CapacityProviderStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityProviderStatus) Values() []CapacityProviderStatus { return []CapacityProviderStatus{ "ACTIVE", @@ -114,8 +119,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityProviderUpdateStatus) Values() []CapacityProviderUpdateStatus { return []CapacityProviderUpdateStatus{ "DELETE_IN_PROGRESS", @@ -139,8 +145,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for ClusterSettingName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterSettingName) Values() []ClusterSettingName { return []ClusterSettingName{ "containerInsights", @@ -177,8 +185,9 @@ const ( ) // Values returns all known values for Compatibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Compatibility) Values() []Compatibility { return []Compatibility{ "EC2", @@ -196,8 +205,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -216,8 +226,9 @@ const ( ) // Values returns all known values for ContainerCondition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerCondition) Values() []ContainerCondition { return []ContainerCondition{ "START", @@ -236,8 +247,9 @@ const ( ) // Values returns all known values for ContainerInstanceField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerInstanceField) Values() []ContainerInstanceField { return []ContainerInstanceField{ "TAGS", @@ -257,8 +269,9 @@ const ( ) // Values returns all known values for ContainerInstanceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerInstanceStatus) Values() []ContainerInstanceStatus { return []ContainerInstanceStatus{ "ACTIVE", @@ -278,8 +291,9 @@ const ( ) // Values returns all known values for CPUArchitecture. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CPUArchitecture) Values() []CPUArchitecture { return []CPUArchitecture{ "X86_64", @@ -298,6 +312,7 @@ const ( // 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{ @@ -317,8 +332,9 @@ const ( ) // Values returns all known values for DeploymentRolloutState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentRolloutState) Values() []DeploymentRolloutState { return []DeploymentRolloutState{ "COMPLETED", @@ -337,8 +353,9 @@ const ( ) // Values returns all known values for DesiredStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DesiredStatus) Values() []DesiredStatus { return []DesiredStatus{ "RUNNING", @@ -357,8 +374,9 @@ const ( ) // Values returns all known values for DeviceCgroupPermission. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceCgroupPermission) Values() []DeviceCgroupPermission { return []DeviceCgroupPermission{ "read", @@ -375,8 +393,9 @@ const ( ) // Values returns all known values for EBSResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EBSResourceType) Values() []EBSResourceType { return []EBSResourceType{ "volume", @@ -393,6 +412,7 @@ const ( // Values returns all known values for EFSAuthorizationConfigIAM. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EFSAuthorizationConfigIAM) Values() []EFSAuthorizationConfigIAM { return []EFSAuthorizationConfigIAM{ @@ -410,8 +430,9 @@ const ( ) // Values returns all known values for EFSTransitEncryption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EFSTransitEncryption) Values() []EFSTransitEncryption { return []EFSTransitEncryption{ "ENABLED", @@ -427,8 +448,9 @@ const ( ) // Values returns all known values for EnvironmentFileType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentFileType) Values() []EnvironmentFileType { return []EnvironmentFileType{ "s3", @@ -445,8 +467,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NONE", @@ -465,6 +488,7 @@ const ( // Values returns all known values for FirelensConfigurationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FirelensConfigurationType) Values() []FirelensConfigurationType { return []FirelensConfigurationType{ @@ -483,8 +507,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -505,6 +530,7 @@ const ( // 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{ @@ -523,8 +549,9 @@ const ( ) // Values returns all known values for InstanceHealthCheckType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceHealthCheckType) Values() []InstanceHealthCheckType { return []InstanceHealthCheckType{ "CONTAINER_RUNTIME", @@ -541,8 +568,9 @@ const ( ) // Values returns all known values for IpcMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpcMode) Values() []IpcMode { return []IpcMode{ "host", @@ -561,8 +589,9 @@ const ( ) // Values returns all known values for LaunchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchType) Values() []LaunchType { return []LaunchType{ "EC2", @@ -586,8 +615,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -609,8 +639,9 @@ const ( ) // Values returns all known values for ManagedAgentName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedAgentName) Values() []ManagedAgentName { return []ManagedAgentName{ "ExecuteCommandAgent", @@ -626,8 +657,9 @@ const ( ) // Values returns all known values for ManagedDraining. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedDraining) Values() []ManagedDraining { return []ManagedDraining{ "ENABLED", @@ -644,8 +676,9 @@ const ( ) // Values returns all known values for ManagedScalingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedScalingStatus) Values() []ManagedScalingStatus { return []ManagedScalingStatus{ "ENABLED", @@ -663,8 +696,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedTerminationProtection) Values() []ManagedTerminationProtection { return []ManagedTerminationProtection{ "ENABLED", @@ -683,8 +717,9 @@ const ( ) // Values returns all known values for NetworkMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkMode) Values() []NetworkMode { return []NetworkMode{ "bridge", @@ -709,8 +744,9 @@ const ( ) // Values returns all known values for OSFamily. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OSFamily) Values() []OSFamily { return []OSFamily{ "WINDOWS_SERVER_2019_FULL", @@ -733,8 +769,9 @@ const ( ) // Values returns all known values for PidMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PidMode) Values() []PidMode { return []PidMode{ "host", @@ -751,8 +788,9 @@ const ( ) // Values returns all known values for PlacementConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementConstraintType) Values() []PlacementConstraintType { return []PlacementConstraintType{ "distinctInstance", @@ -770,8 +808,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "random", @@ -788,8 +827,9 @@ const ( ) // Values returns all known values for PlatformDeviceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlatformDeviceType) Values() []PlatformDeviceType { return []PlatformDeviceType{ "GPU", @@ -806,8 +846,9 @@ const ( ) // Values returns all known values for PropagateTags. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropagateTags) Values() []PropagateTags { return []PropagateTags{ "TASK_DEFINITION", @@ -824,8 +865,9 @@ const ( ) // Values returns all known values for ProxyConfigurationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProxyConfigurationType) Values() []ProxyConfigurationType { return []ProxyConfigurationType{ "APPMESH", @@ -841,8 +883,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -858,8 +901,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -875,8 +919,9 @@ const ( ) // Values returns all known values for SchedulingStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchedulingStrategy) Values() []SchedulingStrategy { return []SchedulingStrategy{ "REPLICA", @@ -893,8 +938,9 @@ const ( ) // 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. +// the future, and so 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{ "task", @@ -910,8 +956,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -934,8 +981,9 @@ const ( ) // Values returns all known values for SettingName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SettingName) Values() []SettingName { return []SettingName{ "serviceLongArnFormat", @@ -959,8 +1007,9 @@ const ( ) // Values returns all known values for SettingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SettingType) Values() []SettingType { return []SettingType{ "user", @@ -977,8 +1026,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -995,8 +1045,9 @@ const ( ) // Values returns all known values for StabilityStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StabilityStatus) Values() []StabilityStatus { return []StabilityStatus{ "STEADY_STATE", @@ -1012,8 +1063,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "container-instance", @@ -1031,6 +1083,7 @@ const ( // Values returns all known values for TaskDefinitionFamilyStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TaskDefinitionFamilyStatus) Values() []TaskDefinitionFamilyStatus { return []TaskDefinitionFamilyStatus{ @@ -1048,8 +1101,9 @@ const ( ) // Values returns all known values for TaskDefinitionField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskDefinitionField) Values() []TaskDefinitionField { return []TaskDefinitionField{ "TAGS", @@ -1065,8 +1119,9 @@ const ( // Values returns all known values for TaskDefinitionPlacementConstraintType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskDefinitionPlacementConstraintType) Values() []TaskDefinitionPlacementConstraintType { return []TaskDefinitionPlacementConstraintType{ "memberOf", @@ -1083,8 +1138,9 @@ const ( ) // Values returns all known values for TaskDefinitionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskDefinitionStatus) Values() []TaskDefinitionStatus { return []TaskDefinitionStatus{ "ACTIVE", @@ -1101,8 +1157,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1119,8 +1176,9 @@ const ( ) // Values returns all known values for TaskFilesystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskFilesystemType) Values() []TaskFilesystemType { return []TaskFilesystemType{ "ext3", @@ -1137,8 +1195,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1158,8 +1217,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1180,8 +1240,9 @@ const ( ) // Values returns all known values for TransportProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransportProtocol) Values() []TransportProtocol { return []TransportProtocol{ "tcp", @@ -1211,8 +1272,9 @@ const ( ) // Values returns all known values for UlimitName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UlimitName) Values() []UlimitName { return []UlimitName{ "core", diff --git a/service/ecs/types/errors.go b/service/ecs/types/errors.go index 88a82117767..fd458127f28 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 @@ -61,8 +61,9 @@ 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/) . +// Your Amazon Web Services account was blocked. For more information, contact [Amazon Web Services Support]. +// +// [Amazon Web Services Support]: http://aws.amazon.com/contact-us/ type BlockedException struct { Message *string @@ -119,7 +120,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 +150,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 UpdateServiceand DeleteService. type ClusterContainsServicesException struct { Message *string @@ -201,8 +202,8 @@ 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. +// The specified cluster wasn't found. You can view your available clusters with ListClusters. +// Amazon ECS clusters are Region specific. type ClusterNotFoundException struct { Message *string @@ -231,8 +232,11 @@ func (e *ClusterNotFoundException) ErrorFault() smithy.ErrorFault { return smith // The RunTask request could not be processed due to conflicts. The provided // clientToken is already in use with a different RunTask request. The resourceIds // are the existing task ARNs which are already associated with the clientToken . +// // To fix this issue: +// // - Run RunTask with a unique clientToken . +// // - Run RunTask with the clientToken and the original set of parameters type ConflictException struct { Message *string @@ -532,8 +536,7 @@ func (e *ServerException) ErrorCode() string { func (e *ServerException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } // 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 . +// If you have previously deleted a service, you can re-create it with CreateService. type ServiceNotActiveException struct { Message *string @@ -559,8 +562,8 @@ 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. +// The specified service wasn't found. You can view your available services with ListServices. +// Amazon ECS services are cluster specific and Region specific. type ServiceNotFoundException struct { Message *string @@ -588,14 +591,18 @@ func (e *ServiceNotFoundException) ErrorFault() smithy.ErrorFault { return smith // 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 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] in the Amazon +// Elastic Container Service Developer Guide. +// +// [Troubleshooting issues with ECS Exec]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html type TargetNotConnectedException struct { Message *string @@ -622,8 +629,8 @@ 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 -// cluster-specific and Region-specific. +// instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and +// Region-specific. type TargetNotFoundException struct { Message *string @@ -649,8 +656,8 @@ 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. +// 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. type TaskSetNotFoundException struct { Message *string diff --git a/service/ecs/types/types.go b/service/ecs/types/types.go index 64ee8718680..e3f2065df20 100644 --- a/service/ecs/types/types.go +++ b/service/ecs/types/types.go @@ -10,18 +10,23 @@ import ( // An object representing a container instance or task attachment. type Attachment struct { - // Details of the attachment. For elastic network interfaces, this includes the - // network interface ID, the MAC address, the subnet ID, and the private IPv4 - // address. For Service Connect services, this includes portName , clientAliases , - // discoveryName , and ingressPortOverride . For Elastic Block Storage, this - // includes roleArn , deleteOnTermination , volumeName , volumeId , and - // statusReason (only when the attachment fails to create or attach). + // Details of the attachment. + // + // For elastic network interfaces, this includes the network interface ID, the MAC + // address, the subnet ID, and the private IPv4 address. + // + // For Service Connect services, this includes portName , clientAliases , + // discoveryName , and ingressPortOverride . + // + // For Elastic Block Storage, this includes roleArn , deleteOnTermination , + // volumeName , volumeId , and statusReason (only when the attachment fails to + // create or attach). Details []KeyValuePair // The unique identifier for the attachment. Id *string - // The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING + // The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING // , ATTACHED , DETACHING , DETACHED , DELETED , and FAILED . Status *string @@ -50,8 +55,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// your resources. For more information, see [Attributes]in the Amazon Elastic Container +// Service Developer Guide. +// +// [Attributes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes type Attribute struct { // The name of the attribute. The name must contain between 1 and 128 characters. @@ -97,16 +104,21 @@ type AutoScalingGroupProvider struct { // The managed termination protection setting to use for the Auto Scaling group // capacity provider. This determines whether the Auto Scaling group has managed - // termination protection. The default is off. When using managed termination - // protection, managed scaling must also be used otherwise managed termination - // protection doesn't work. When managed termination protection is on, Amazon ECS - // 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 on 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. + // termination protection. The default is off. + // + // When using managed termination protection, managed scaling must also be used + // otherwise managed termination protection doesn't work. + // + // When managed termination protection is on, Amazon ECS 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 on as well. + // For more information, see [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. + // + // [Instance Protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection ManagedTerminationProtection ManagedTerminationProtection noSmithyDocumentSerde @@ -125,16 +137,21 @@ type AutoScalingGroupProviderUpdate struct { // The managed termination protection setting to use for the Auto Scaling group // capacity provider. This determines whether the Auto Scaling group has managed - // termination protection. When using managed termination protection, managed - // scaling must also be used otherwise managed termination protection doesn't work. + // termination protection. + // + // When using managed termination protection, managed scaling must also be used + // otherwise managed termination protection doesn't work. + // // When managed termination protection is on, Amazon ECS 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 on. 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. + // information, see [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. + // + // [Instance Protection]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection ManagedTerminationProtection ManagedTerminationProtection noSmithyDocumentSerde @@ -146,8 +163,9 @@ 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 - // must be from the same VPC. + // 16 subnets that can be specified per AwsVpcConfiguration . + // + // All specified subnets must be from the same VPC. // // This member is required. Subnets []string @@ -159,7 +177,9 @@ type AwsVpcConfiguration struct { // 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 @@ -184,17 +204,25 @@ 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 @@ -202,11 +230,15 @@ type CapacityProvider struct { 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. + // 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. UpdateStatus CapacityProviderUpdateStatus // The update status reason. This provides further details about the update status @@ -217,19 +249,23 @@ type CapacityProvider struct { } // 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 +// be set when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for +// a cluster with the CreateClusterAPI. +// +// 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 CreateCapacityProviderAPI 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. +// strategy. +// +// A capacity provider strategy may contain a maximum of 6 capacity providers. type CapacityProviderStrategyItem struct { // The short name of the capacity provider. @@ -246,19 +282,22 @@ type CapacityProviderStrategyItem struct { // 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. + // 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 @@ -271,7 +310,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 @@ -280,17 +319,23 @@ type Cluster struct { Attachments []Attachment // The status of the capacity providers associated with the cluster. The following - // are the states that are returned. UPDATE_IN_PROGRESS The available capacity - // providers for the cluster are updating. UPDATE_COMPLETE The capacity providers - // have successfully updated. UPDATE_FAILED The capacity provider updates failed. + // are the states that are returned. + // + // UPDATE_IN_PROGRESS The available capacity providers for the cluster are + // updating. + // + // UPDATE_COMPLETE The capacity providers have successfully updated. + // + // UPDATE_FAILED The capacity provider updates failed. AttachmentsStatus *string // 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) - // in the Amazon ECS Developer Guide. + // information about the ARN format, see [Amazon Resource Name (ARN)]in the Amazon ECS Developer Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids ClusterArn *string // A user-generated string that you use to identify your cluster. @@ -320,13 +365,16 @@ type Cluster struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html ServiceConnectDefaults *ClusterServiceConnectDefaults // The settings for the cluster. This parameter indicates whether CloudWatch @@ -335,43 +383,66 @@ 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 Statistics []KeyValuePair // The status of the cluster. The following are the possible states that are - // returned. ACTIVE The cluster is ready to accept tasks and if applicable you can - // register container instances with the cluster. PROVISIONING The cluster has - // capacity providers that are associated with it and the resources needed for the - // capacity provider are being created. DEPROVISIONING The cluster has capacity - // providers that are associated with it and the resources needed for the capacity - // provider are being deleted. FAILED The cluster has capacity providers that are - // associated with it and the resources needed for the capacity provider have - // failed to create. INACTIVE The cluster has been deleted. Clusters with an - // INACTIVE status may 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. + // returned. + // + // ACTIVE The cluster is ready to accept tasks and if applicable you can register + // container instances with the cluster. + // + // PROVISIONING The cluster has capacity providers that are associated with it and + // the resources needed for the capacity provider are being created. + // + // DEPROVISIONING The cluster has capacity providers that are associated with it + // and the resources needed for the capacity provider are being deleted. + // + // FAILED The cluster has capacity providers that are associated with it and the + // resources needed for the capacity provider have failed to create. + // + // INACTIVE The cluster has been deleted. Clusters with an INACTIVE status may + // 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. Status *string // 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: + // 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 @@ -396,13 +467,16 @@ type ClusterConfiguration struct { // 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) -// in the Amazon Elastic Container Service Developer Guide. +// 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]in the +// Amazon Elastic Container Service Developer Guide. +// +// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html type ClusterServiceConnectDefaults struct { // The namespace name or full Amazon Resource Name (ARN) of the Cloud Map @@ -419,31 +493,41 @@ type ClusterServiceConnectDefaults struct { // 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) -// in the Amazon Elastic Container Service Developer Guide. +// 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]in the +// Amazon Elastic Container Service Developer Guide. +// +// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html 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 cluster with an empty string "" for the namespace name, the + // 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 cluster 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/cloud-map/latest/dg/working-with-services.html) - // in the Cloud Map Developer Guide. + // will remain in Cloud Map and must be deleted separately. + // + // For more information about Cloud Map, see [Working with Services] in the Cloud Map Developer Guide. + // + // [Working with Services]: https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html // // This member is required. Namespace *string @@ -459,13 +543,15 @@ type ClusterSetting struct { Name ClusterSettingName // The value to set for the cluster setting. The supported values are enabled and - // disabled . If you set name to containerInsights and value to enabled , - // CloudWatch Container Insights will be on 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 you set name to containerInsights and value to enabled , CloudWatch Container + // Insights will be on 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] or [PutAccountSettingDefault]. + // + // [PutAccountSettingDefault]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html + // [PutAccountSetting]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html Value *string noSmithyDocumentSerde @@ -535,226 +621,301 @@ type Container struct { // containers that are launched as part of a task. 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. + // The command that's passed to the container. This parameter maps to Cmd in the [Create a container] + // section of the [Docker Remote API]and the COMMAND parameter to [docker run]. For more information, see [https://docs.docker.com/engine/reference/builder/#cmd]. If + // there are multiple arguments, each argument is a separated string in the array. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ + // [https://docs.docker.com/engine/reference/builder/#cmd]: https://docs.docker.com/engine/reference/builder/#cmd 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] section of the [Docker Remote API] and the --cpu-shares option to [docker run]. + // + // 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: + // 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]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]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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [CPU share constraint]: https://docs.docker.com/engine/reference/run/#cpu-share-constraint + // [Amazon EC2 Instances]: http://aws.amazon.com/ec2/instance-types/ + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Cpu int32 // A list of ARNs in SSM or Amazon S3 to a credential spec ( CredSpec ) file that // configures the container for Active Directory authentication. We recommend that // you use this parameter instead of the dockerSecurityOptions . The maximum number - // of ARNs is 1. There are two formats for each ARN. credentialspecdomainless:MyARN - // You use credentialspecdomainless:MyARN to provide a CredSpec with an additional - // section for a secret in Secrets Manager. You provide the login credentials to - // the domain in the secret. Each task that runs on any container instance can join - // different domains. You can use this format without joining the container - // instance to a domain. credentialspec:MyARN You use credentialspec:MyARN to - // provide a CredSpec for a single domain. You must join the container instance to - // the domain before you start any tasks that use this task definition. In both - // formats, replace MyARN with the ARN in SSM or Amazon S3. If you provide a - // credentialspecdomainless:MyARN , the credspec must provide a ARN in Secrets - // Manager for a secret containing the username, password, and the domain to - // connect to. For better security, the instance isn't joined to the domain for - // domainless authentication. Other applications on the instance can't use the - // domainless credentials. You can use this parameter to run tasks on the same - // instance, even it the tasks need to join different domains. For more - // information, see Using gMSAs for Windows Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) - // and Using gMSAs for Linux Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) - // . + // of ARNs is 1. + // + // There are two formats for each ARN. + // + // credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to + // provide a CredSpec with an additional section for a secret in Secrets Manager. + // You provide the login credentials to the domain in the secret. + // + // Each task that runs on any container instance can join different domains. + // + // You can use this format without joining the container instance to a domain. + // + // credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a + // single domain. + // + // You must join the container instance to the domain before you start any tasks + // that use this task definition. + // + // In both formats, replace MyARN with the ARN in SSM or Amazon S3. + // + // If you provide a credentialspecdomainless:MyARN , the credspec must provide a + // ARN in Secrets Manager for a secret containing the username, password, and the + // domain to connect to. For better security, the instance isn't joined to the + // domain for domainless authentication. Other applications on the instance can't + // use the domainless credentials. You can use this parameter to run tasks on the + // same instance, even it the tasks need to join different domains. For more + // information, see [Using gMSAs for Windows Containers]and [Using gMSAs for Linux Containers]. + // + // [Using gMSAs for Windows Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html + // [Using gMSAs for Linux Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html CredentialSpecs []string // The dependencies defined for container startup and shutdown. A container can // contain multiple dependencies on other containers in a task definition. When a // dependency is defined for container startup, for container shutdown it is - // reversed. For tasks using the EC2 launch type, the container instances require - // 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) - // 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) - // in the Amazon Elastic Container Service Developer Guide. For tasks using the - // Fargate launch type, the task or service requires the following platforms: + // reversed. + // + // For tasks using the EC2 launch type, the container instances require 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]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] 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. + // + // [Updating the Amazon ECS Container Agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html + // [Amazon ECS-optimized Linux AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html 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/) . + // parameter maps to NetworkDisabled in the [Create a container] section of the [Docker Remote API]. + // // This parameter is not supported for Windows containers. + // + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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. + // parameter maps to DnsSearch in the [Create a container] section of the [Docker Remote API] and the --dns-search option + // to [docker run]. + // + // This parameter is not supported for Windows containers. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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] section of the [Docker Remote API] and the --dns option to [docker run]. + // + // This parameter is not supported for Windows containers. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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]section of the [Docker Remote API] and the --label option to [docker run]. 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}}' + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ DockerLabels map[string]string // A list of strings to provide custom configuration for multiple security - // systems. For more information about valid values, see Docker Run Security - // Configuration (https://docs.docker.com/engine/reference/run/#security-configuration) - // . This field isn't valid for containers in tasks using the Fargate launch type. + // systems. For more information about valid values, see [Docker Run Security Configuration]. This field isn't valid + // for containers in tasks using the Fargate launch type. + // // For Linux tasks on EC2, this parameter can be used to reference custom labels - // for SELinux and AppArmor multi-level security systems. For any tasks on EC2, - // this parameter can be used to reference a credential spec file that configures 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) - // and Using gMSAs for Linux Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-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 + // for SELinux and AppArmor multi-level security systems. + // + // For any tasks on EC2, this parameter can be used to reference a credential spec + // file that configures a container for Active Directory authentication. For more + // information, see [Using gMSAs for Windows Containers]and [Using gMSAs for Linux Containers] in the Amazon Elastic Container Service Developer Guide. + // + // This parameter maps to SecurityOpt in the [Create a container] section of the [Docker Remote API] and the + // --security-opt option to [docker run]. + // + // 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" | + // options. For more information, see [Amazon ECS Container Agent Configuration]in the Amazon Elastic Container Service + // Developer Guide. + // + // For more information about valid values, see [Docker Run Security Configuration]. + // + // Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | // "credentialspec:CredentialSpecFilePath" + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Docker Run Security Configuration]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Using gMSAs for Windows Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Using gMSAs for Linux Containers]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ + // [Amazon ECS Container Agent Configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html DockerSecurityOptions []string // Early versions of the Amazon ECS container agent don't properly handle // 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) - // . + // instead. + // + // The entry point that's passed to the container. This parameter maps to + // Entrypoint in the [Create a container] section of the [Docker Remote API] and the --entrypoint option to [docker run]. For more + // information, see [https://docs.docker.com/engine/reference/builder/#entrypoint]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [https://docs.docker.com/engine/reference/builder/#entrypoint]: https://docs.docker.com/engine/reference/builder/#entrypoint + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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]section of the [Docker Remote API] and the --env option to [docker run]. + // + // We don't recommend that you use plaintext environment variables for sensitive // information, such as credential data. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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 + // This parameter maps to the --env-file option to [docker run]. + // + // 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) - // in the Amazon Elastic Container Service Developer Guide. + // ignored. For more information about the environment variable file syntax, see [Declare default environment variables in 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]in the Amazon Elastic + // Container Service Developer Guide. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Declare default environment variables in file]: https://docs.docker.com/compose/env-file/ + // [Specifying Environment Variables]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html EnvironmentFiles []EnvironmentFile // 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 // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Application Architecture]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html 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 + // the container. This parameter maps to ExtraHosts in the [Create a container] section of the [Docker Remote API] and + // the --add-host option to [docker run]. + // + // This parameter isn't supported for Windows containers or tasks that use the // awsvpc network mode. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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) - // in the Amazon Elastic Container Service Developer Guide. + // configure a log router for container logs. For more information, see [Custom Log Routing]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Custom Log Routing]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html 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] section of the [Docker Remote API] and + // the HEALTHCHECK parameter of [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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. + // The hostname to use for your container. This parameter maps to Hostname in the [Create a container] + // section of the [Docker Remote API]and the --hostname option to [docker run]. + // + // The hostname parameter is not supported if you're using the awsvpc network mode. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Hostname *string // The image used to start a container. This string is passed directly to the @@ -762,33 +923,41 @@ type ContainerDefinition struct { // 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) - // . + // signs are allowed. This parameter maps to Image in the [Create a container] section of the [Docker Remote API] and the + // IMAGE parameter of [docker run]. + // // - 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 ). + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Image *string // 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) - // . + // require stdin or a tty to be allocated. This parameter maps to OpenStdin in the [Create a container] + // section of the [Docker Remote API]and the --interactive option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Interactive *bool // The links parameter allows containers to communicate with each other without @@ -796,66 +965,86 @@ type ContainerDefinition struct { // 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 - // 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. + // linking Docker containers, go to [Legacy container links]in the Docker documentation. This parameter + // maps to Links in the [Create a container] section of the [Docker Remote API] and the --link option to [docker run]. + // + // 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. + // + // [Legacy container links]: https://docs.docker.com/network/links/ + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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 + // The log configuration specification for the container. + // + // This parameter maps to LogConfig in the [Create a container] section of the [Docker Remote API] and the --log-driver + // option to [docker run]. 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 + // different supported log drivers, see [Configure logging drivers]in the Docker documentation. + // + // Amazon ECS currently supports a subset of the logging drivers available to the + // Docker daemon (shown in the LogConfigurationdata 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. + // [Amazon ECS Container Agent Configuration]in the Amazon Elastic Container Service Developer Guide. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ + // [Amazon ECS Container Agent Configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html 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 + // the [Create a container]section of the [Docker Remote API] and the --memory option to [docker run]. + // + // 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. + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Memory *int32 // The soft limit (in MiB) of memory to reserve for the container. When system @@ -863,88 +1052,115 @@ 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 + // comes first. This parameter maps to MemoryReservation in the [Create a container] section of the [Docker Remote API] + // and the --memory-reservation option to [docker run]. + // + // 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 + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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 + // The mount points for data volumes in your container. + // + // This parameter maps to Volumes in the [Create a container] section of the [Docker Remote API] and the --volume option + // to [docker run]. + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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] section of the [Docker Remote API] and the --name option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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. + // 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] section of the [Docker Remote API] and the --publish + // option to [docker run]. 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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] section of the [Docker Remote API] and the --privileged option to [docker run]. + // + // This parameter is not supported for Windows containers or tasks run on Fargate. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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) - // . + // the [Create a container]section of the [Docker Remote API] and the --tty option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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. + // root file system. This parameter maps to ReadonlyRootfs in the [Create a container] section of the [Docker Remote API] + // and the --read-only option to [docker run]. + // + // This parameter is not supported for Windows containers. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ ReadonlyRootFilesystem *bool // The private repository authentication credentials to use. @@ -954,9 +1170,10 @@ type ContainerDefinition struct { // resource is a GPU. 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) - // in the Amazon Elastic Container Service Developer Guide. + // The secrets to pass to the container. For more information, see [Specifying Sensitive Data] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Specifying Sensitive Data]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html Secrets []Secret // Time duration (in seconds) to wait before giving up on resolving dependencies @@ -964,105 +1181,145 @@ type ContainerDefinition struct { // 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: + // 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) - // 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) - // in the Amazon Elastic Container Service Developer Guide. The valid values are - // 2-120 seconds. + // about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent]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] in the Amazon Elastic Container Service + // Developer Guide. + // + // The valid values are 2-120 seconds. + // + // [Updating the Amazon ECS Container Agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html + // [Amazon ECS-optimized Linux AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html 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: + // 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 - // 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) - // 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) - // in the Amazon Elastic Container Service Developer Guide. The valid values are - // 2-120 seconds. + // 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]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] in the Amazon Elastic Container Service + // Developer Guide. + // + // The valid values are 2-120 seconds. + // + // [Updating the Amazon ECS Container Agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html + // [Amazon ECS-optimized Linux AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html 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) - // . For example, you can configure net.ipv4.tcp_keepalive_time setting to - // maintain longer lived connections. + // maps to Sysctls in the [Create a container] section of the [Docker Remote API] and the --sysctl option to [docker run]. For + // example, you can configure net.ipv4.tcp_keepalive_time setting to maintain + // longer lived connections. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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 65535 . 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}}' + // maps to Ulimits in the [Create a container] section of the [Docker Remote API] and the --ulimit option to [docker run]. Valid + // naming values are displayed in the Ulimitdata 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 65535 . + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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. + // The user to use inside the container. This parameter maps to User in the [Create a container] + // section of the [Docker Remote API]and the --user option to [docker run]. + // + // 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. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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]section of the [Docker Remote API] and the --volumes-from option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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] section of the [Docker Remote API] and the --workdir option to [docker run]. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ WorkingDirectory *string noSmithyDocumentSerde @@ -1070,38 +1327,49 @@ type ContainerDefinition struct { // The dependencies defined for container startup and shutdown. A container can // contain multiple dependencies. When a dependency is defined for container -// startup, for container shutdown it is reversed. Your Amazon ECS container -// 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) -// 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) -// in the Amazon Elastic Container Service Developer Guide. For tasks that use the -// Fargate launch type, the task or service requires the following platforms: +// startup, for container shutdown it is reversed. +// +// Your Amazon ECS container 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]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]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. // -// For more information about how to create a container dependency, see Container -// dependency (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency) -// in the Amazon Elastic Container Service Developer Guide. +// For more information about how to create a container dependency, see [Container dependency] in the +// Amazon Elastic Container Service Developer Guide. +// +// [Updating the Amazon ECS Container Agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html +// [Amazon ECS-optimized Linux AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html +// [Container dependency]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency 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 @@ -1136,16 +1404,16 @@ type ContainerInstance struct { Attachments []Attachment // The attributes set for the container instance, either by the Amazon ECS - // container agent at instance registration or manually with the PutAttributes - // operation. + // container agent at instance registration or manually with the PutAttributesoperation. Attributes []Attribute // The capacity provider that's associated with the container instance. 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) - // in the Amazon ECS Developer Guide. + // about the ARN format, see [Amazon Resource Name (ARN)]in the Amazon ECS Developer Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids ContainerInstanceArn *string // The ID of the container instance. For Amazon EC2 instances, this value is the @@ -1185,20 +1453,23 @@ type ContainerInstance struct { RunningTasksCount int32 // 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 - // registration fails, the instance will transition to a REGISTRATION_FAILED + // 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 registration fails, the instance will transition to a REGISTRATION_FAILED // 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service Developer Guide. + // + // [Container instance draining]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html Status *string // The reason that the container instance reached its current status. @@ -1206,17 +1477,26 @@ type ContainerInstance struct { // 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: + // 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 @@ -1256,10 +1536,13 @@ type ContainerInstanceHealthStatus 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. You can use Secrets Manager or Amazon Web Services Systems Manager -// Parameter Store to store the sensitive data. For more information, see Retrieve -// secrets through environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html) -// in the Amazon ECS Developer Guide. +// be included. +// +// You can use Secrets Manager or Amazon Web Services Systems Manager Parameter +// Store to store the sensitive data. For more information, see [Retrieve secrets through environment variables]in the Amazon ECS +// Developer Guide. +// +// [Retrieve secrets through environment variables]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html type ContainerOverride struct { // The command to send to the container that overrides the default command from @@ -1346,16 +1629,19 @@ type Deployment struct { // 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. + // 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) + // The launch type the tasks in the service are using. For more information, see [Amazon ECS Launch Types] // in the Amazon Elastic Container Service Developer Guide. + // + // [Amazon ECS Launch Types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html LaunchType LaunchType // The VPC subnet and security group configuration for tasks that receive their @@ -1366,26 +1652,30 @@ type Deployment struct { PendingCount int32 // 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. . + // 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. . 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) - // in the Amazon Elastic Container Service Developer Guide. + // specified, the LATEST platform version is used. For more information, see [Fargate Platform Versions] in + // the Amazon Elastic Container Service Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html 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 turned on, the deployment - // transitions to a FAILED state. A deployment in FAILED state doesn't launch any - // new tasks. For more information, see DeploymentCircuitBreaker . + // 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 turned on, 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. @@ -1396,25 +1686,33 @@ type Deployment struct { // 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. + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html ServiceConnectConfiguration *ServiceConnectConfiguration // The list of Service Connect resources that are associated with this deployment. // Each list entry maps a discovery name to a Cloud Map service name. ServiceConnectResources []ServiceConnectServiceResource - // The status of the deployment. The following describes each state. PRIMARY The - // most recent deployment of a service. ACTIVE A service deployment that still has - // running tasks, but are in the process of being replaced with a new PRIMARY - // deployment. INACTIVE A deployment that has been completely replaced. + // The status of the deployment. The following describes each state. + // + // PRIMARY The most recent deployment of a service. + // + // ACTIVE A service deployment that still has running tasks, but are in the + // process of being replaced with a new PRIMARY deployment. + // + // INACTIVE A deployment that has been completely replaced. Status *string // The most recent task definition that was specified for the tasks in the service @@ -1425,9 +1723,10 @@ type Deployment struct { UpdatedAt *time.Time // The details of the volume that was configuredAtLaunch . You can configure - // different settings like the size, throughput, volumeType, and ecryption in - // ServiceManagedEBSVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html) - // . The name of the volume must match the name from the task definition. + // different settings like the size, throughput, volumeType, and ecryption in [ServiceManagedEBSVolumeConfiguration]. + // The name of the volume must match the name from the task definition. + // + // [ServiceManagedEBSVolumeConfiguration]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html VolumeConfigurations []ServiceVolumeConfiguration noSmithyDocumentSerde @@ -1435,12 +1734,19 @@ type Deployment struct { // One of the methods which provide a way for you to quickly identify when a // deployment has failed, and then to optionally roll back the failure to the last -// working deployment. When the alarms are generated, Amazon ECS sets the service -// 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) -// in the Amazon Elastic Container Service Developer Guide . +// working deployment. +// +// When the alarms are generated, Amazon ECS sets the service 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] in the Amazon Elastic Container Service Developer +// Guide . +// +// [Rolling update]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html type DeploymentAlarms struct { // One or more CloudWatch alarm names. Use a "," to separate the alarms. @@ -1465,15 +1771,20 @@ 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 it is turned on, 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. For more information -// about API failure reasons, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) -// in the Amazon Elastic Container Service Developer Guide. +// 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 it is turned on, 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]in the Amazon Elastic +// Container Service Developer Guide. +// +// For more information about API failure reasons, see [API failure reasons] in the Amazon Elastic +// Container Service Developer Guide. +// +// [API failure reasons]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html +// [Rolling update]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html type DeploymentCircuitBreaker struct { // Determines whether to use the deployment circuit breaker logic for the service. @@ -1499,14 +1810,17 @@ 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) - // in the Amazon Elastic Container Service Developer Guide + // 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]in the Amazon Elastic Container Service + // Developer Guide + // + // [Rolling update]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html DeploymentCircuitBreaker *DeploymentCircuitBreaker // If a service is using the rolling update ( ECS ) deployment type, the @@ -1518,14 +1832,15 @@ type DeploymentConfiguration struct { // 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 @@ -1535,40 +1850,51 @@ type DeploymentConfiguration struct { // 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: + // 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 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. + // // The default value for a replica service for minimumHealthyPercent is 100%. The // default minimumHealthyPercent value for a service using the DAEMON service // schedule is 0% for the CLI, the Amazon Web Services SDKs, and the APIs and 50% - // for the Amazon Web Services Management Console. The minimum number of healthy - // tasks during a deployment is the desiredCount multiplied by the - // minimumHealthyPercent /100, rounded up to the nearest integer value. 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 + // for the Amazon Web Services Management Console. + // + // The minimum number of healthy tasks during a deployment is the desiredCount + // multiplied by the minimumHealthyPercent /100, rounded up to the nearest integer + // value. + // + // 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 // 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 @@ -1576,21 +1902,27 @@ type DeploymentConfiguration struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// The deployment controller to use for the service. For more information, see [Amazon ECS deployment types] in +// the Amazon Elastic Container Service Developer Guide. +// +// [Amazon ECS deployment types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html 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 - // 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 + // 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 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 // third-party deployment controller for full control over the deployment process // for an Amazon ECS service. // @@ -1625,8 +1957,9 @@ type Device struct { // 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 @@ -1634,25 +1967,29 @@ 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]. This parameter maps to Driver in the [Create a volume] section of the [Docker Remote API] + // and the xxdriver option to [docker volume create]. + // + // [Create a volume]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ + // [docker volume create]: https://docs.docker.com/engine/reference/commandline/volume_create/ + // [Docker plugin discovery]: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery 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] section of the [Docker Remote API] and the xxopt option to [docker volume create]. + // + // [Create a volume]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ + // [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]section of the [Docker Remote API] and the xxlabel option to [docker volume create]. + // + // [Create a volume]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ + // [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 @@ -1692,25 +2029,29 @@ type EFSAuthorizationConfig struct { // 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 on 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. + // EFSVolumeConfiguration . For more information, see [Working with Amazon EFS access points] in the Amazon Elastic File + // System User Guide. + // + // [Working with Amazon EFS access points]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html AccessPointId *string // Determines whether to use the Amazon ECS task role defined in a task definition // when mounting the Amazon EFS file system. If it is turned on, transit encryption // must be turned on 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. + // the default value of DISABLED is used. For more information, see [Using Amazon EFS access points] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Using Amazon EFS access points]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints 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) -// in the Amazon Elastic Container Service Developer Guide. +// file system for task storage. For more information, see [Amazon EFS volumes]in the Amazon Elastic +// Container Service Developer Guide. +// +// [Amazon EFS volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html type EFSVolumeConfiguration struct { // The Amazon EFS file system ID to use. @@ -1723,25 +2064,28 @@ 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 turned on // 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. + // default value of DISABLED is used. For more information, see [Encrypting data in transit] in the Amazon + // Elastic File System User Guide. + // + // [Encrypting data in transit]: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html 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]in the Amazon Elastic File System User Guide. + // + // [EFS mount helper]: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html TransitEncryptionPort *int32 noSmithyDocumentSerde @@ -1751,22 +2095,33 @@ type EFSVolumeConfiguration struct { // 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. 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 -// Use a file to pass environment variables to a container (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) -// in the Amazon Elastic Container Service Developer Guide. Environment variable -// files are objects in Amazon S3 and all Amazon S3 security considerations apply. +// comments and are ignored. +// +// 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 [Use a file to pass environment variables to a container]in the Amazon Elastic +// Container Service Developer Guide. +// +// Environment variable files are objects in Amazon S3 and all Amazon S3 security +// considerations apply. +// // You must use the following platforms for the Fargate launch type: +// // - Linux platform version 1.4.0 or later. +// // - Windows platform version 1.0.0 or later. // // Consider the following when using the Fargate launch type: +// // - The file is handled like a native Docker env-file. +// // - There is no support for shell escape handling. +// // - The container entry point interperts the VARIABLE values. +// +// [Use a file to pass environment variables to a container]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html type EnvironmentFile struct { // The file type to use. Environment files are objects in Amazon S3. The only @@ -1786,12 +2141,17 @@ type EnvironmentFile struct { // 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 Using -// data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) -// in the Amazon ECS Developer Guide;. For tasks using the Fargate launch type, the -// task requires the following platforms: +// default amount, for tasks hosted on Fargate. For more information, see [Using data volumes in tasks]in the +// Amazon ECS Developer Guide;. +// +// For tasks using the Fargate launch type, the task requires the following +// platforms: +// // - Linux platform version 1.4.0 or later. +// // - Windows platform version 1.0.0 or later. +// +// [Using data volumes in tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html type EphemeralStorage struct { // The total amount, in GiB, of ephemeral storage to set for the task. The minimum @@ -1817,10 +2177,13 @@ 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. Logging ExecuteCommandLogging @@ -1836,12 +2199,14 @@ type ExecuteCommandLogConfiguration struct { // encryption will be off. CloudWatchEncryptionEnabled bool - // The name of the CloudWatch log group to send logs to. The CloudWatch log group - // must already be created. + // The name of the CloudWatch log group to send logs to. + // + // The CloudWatch log group must already be created. CloudWatchLogGroupName *string - // The name of the S3 bucket to send logs to. The S3 bucket must already be - // created. + // The name of the S3 bucket to send logs to. + // + // The S3 bucket must already be created. S3BucketName *string // Determines whether to use encryption on the S3 logs. If not specified, @@ -1854,8 +2219,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// A failed resource. For a list of common causes, see [API failure reasons] in the Amazon Elastic +// Container Service Developer Guide. +// +// [API failure reasons]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html type Failure struct { // The Amazon Resource Name (ARN) of the failed resource. @@ -1871,9 +2238,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// configure a log router for container logs. For more information, see [Custom log routing]in the +// Amazon Elastic Container Service Developer Guide. +// +// [Custom log routing]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html type FirelensConfiguration struct { // The log router to use. The valid values are fluentd or fluentbit . @@ -1886,20 +2254,25 @@ type FirelensConfiguration struct { // 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) - // in the Amazon Elastic Container Service Developer Guide. Tasks hosted on Fargate - // only support the file configuration file type. + // . For more information, see [Creating a task definition that uses a FireLens configuration]in the Amazon Elastic Container Service Developer + // Guide. + // + // Tasks hosted on Fargate only support the file configuration file type. + // + // [Creating a task definition that uses a FireLens configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef Options map[string]string noSmithyDocumentSerde } // 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) -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// file system. See [FSxWindowsFileServerVolumeConfiguration]in the Amazon ECS API Reference. +// +// For more information and the input format, see [Amazon FSx for Windows File Server Volumes] in the Amazon Elastic Container +// Service Developer Guide. +// +// [Amazon FSx for Windows File Server Volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html +// [FSxWindowsFileServerVolumeConfiguration]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html type FSxWindowsFileServerAuthorizationConfig struct { // The authorization credential option to use. The authorization credential @@ -1910,8 +2283,10 @@ type FSxWindowsFileServerAuthorizationConfig struct { // 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) - // Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2. + // A fully qualified domain name hosted by an [Directory Service] Managed Microsoft AD (Active + // Directory) or self-hosted AD on Amazon EC2. + // + // [Directory Service]: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html // // This member is required. Domain *string @@ -1919,10 +2294,13 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// This parameter is specified when you're using [Amazon FSx for Windows File Server] file system for task storage. +// +// For more information and the input format, see [Amazon FSx for Windows File Server volumes] in the Amazon Elastic Container +// Service Developer Guide. +// +// [Amazon FSx for Windows File Server]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html +// [Amazon FSx for Windows File Server volumes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html type FSxWindowsFileServerVolumeConfiguration struct { // The authorization configuration details for the Amazon FSx for Windows File @@ -1949,20 +2327,29 @@ type FSxWindowsFileServerVolumeConfiguration struct { // 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 -// 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. -// Health check parameters that are specified in a container definition override -// any Docker health checks that exist in the container image. You can view the -// health status of both individual containers and a task with the DescribeTasks -// API operation or when viewing the task details in the console. The health check -// is designed to make sure that your containers survive agent restarts, upgrades, -// or temporary unavailability. Amazon ECS performs health checks on containers -// with the default that launched the container instance or the task. The following -// describes the possible healthStatus values for a container: +// of [docker 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. Health check parameters that are specified in a container definition +// override any Docker health checks that exist in the container image. +// +// You can view the health status of both individual containers and a task with +// the DescribeTasks API operation or when viewing the task details in the console. +// +// The health check is designed to make sure that your containers survive agent +// restarts, upgrades, or temporary unavailability. +// +// Amazon ECS performs health checks on containers with the default that launched +// the container instance or the task. +// +// 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, there's no container // health check defined, or Amazon ECS doesn't have the health status of the // container. @@ -1970,69 +2357,98 @@ type FSxWindowsFileServerVolumeConfiguration struct { // The following describes the possible healthStatus values based on the container // health checker status of essential containers in the task with the following // priority order (high to low): +// // - UNHEALTHY -One or more essential containers have failed their health check. +// // - UNKNOWN -Any essential container running within the task is in an UNKNOWN // state and no other essential containers have an UNHEALTHY state. +// // - HEALTHY -All essential containers within the task have passed their health // checks. // // Consider the following task health example with 2 containers. +// // - If Container1 is UNHEALTHY and Container2 is UNKNOWN , the task health is // UNHEALTHY . +// // - If Container1 is UNHEALTHY and Container2 is HEALTHY , the task health is // UNHEALTHY . +// // - If Container1 is HEALTHY and Container2 is UNKNOWN , the task health is // UNKNOWN . +// // - If Container1 is HEALTHY and Container2 is HEALTHY , the task health is // HEALTHY . // // Consider the following task health example with 3 containers. +// // - If Container1 is UNHEALTHY and Container2 is UNKNOWN , and Container3 is // UNKNOWN , the task health is UNHEALTHY . +// // - If Container1 is UNHEALTHY and Container2 is UNKNOWN , and Container3 is // HEALTHY , the task health is UNHEALTHY . +// // - If Container1 is UNHEALTHY and Container2 is HEALTHY , and Container3 is // HEALTHY , the task health is UNHEALTHY . +// // - If Container1 is HEALTHY and Container2 is UNKNOWN , and Container3 is // HEALTHY , the task health is UNKNOWN . +// // - If Container1 is HEALTHY and Container2 is UNKNOWN , and Container3 is // UNKNOWN , the task health is UNKNOWN . +// // - If Container1 is HEALTHY and Container2 is HEALTHY , and Container3 is // HEALTHY , the task health is HEALTHY . // // 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: +// service scheduler will replace it. +// +// The following are notes about container health check support: +// // - When the Amazon ECS agent cannot connect to the Amazon ECS service, the // service reports the container as UNHEALTHY . +// // - The health check statuses are the "last heard from" response from the // Amazon ECS agent. There are no assumptions made about the status of the // container health checks. +// // - 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 agent. For more information, see [Updating the Amazon ECS container agent]. +// // - 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) -// . +// platform version 1.1.0 or greater. For more information, see [Fargate platform versions]. +// // - Container health checks aren't supported for tasks that are part of a // service that's configured to use a Classic Load Balancer. +// +// [docker run]: https://docs.docker.com/engine/reference/run/ +// [Updating the Amazon ECS container agent]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html +// [Fargate platform versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html 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 + // 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/) . + // For more information, see HealthCheck in the [Create a container] section of the [Docker Remote API]. + // + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ // // This member is required. Command []string @@ -2048,9 +2464,11 @@ 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 @@ -2062,7 +2480,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. @@ -2088,21 +2506,25 @@ type HostVolumeProperties struct { // 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, // the Docker daemon creates it. If the location does exist, the contents of the - // source path folder are exported. If you're using the Fargate launch type, the - // sourcePath parameter is not supported. + // source path folder are exported. + // + // If you're using the Fargate launch type, the sourcePath parameter is not + // supported. SourcePath *string noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// Details on an Elastic Inference accelerator. For more information, see [Working with Amazon Elastic Inference on Amazon ECS] in the +// Amazon Elastic Container Service Developer Guide. +// +// [Working with Amazon Elastic Inference on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html 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]. + // + // [ResourceRequirement]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html // // This member is required. DeviceName *string @@ -2117,9 +2539,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide. +// definition. For more information, see [Working with Amazon Elastic Inference on Amazon ECS]in the Amazon Elastic Container Service +// Developer Guide. +// +// [Working with Amazon Elastic Inference on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html type InferenceAcceleratorOverride struct { // The Elastic Inference accelerator device name to override for the task. This @@ -2153,35 +2576,39 @@ type InstanceHealthCheckResult struct { // The Linux capabilities to add or remove from the default Docker configuration // for a container defined in the task definition. 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) -// 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. +// default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities]in the +// Docker run reference. For more detailed information about these Linux +// capabilities, see the [capabilities(7)]Linux manual page. +// +// [Runtime privilege and Linux capabilities]: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities +// [capabilities(7)]: http://man7.org/linux/man-pages/man7/capabilities.7.html 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" + // configuration provided by Docker. This parameter maps to CapAdd in the [Create a container] section + // of the [Docker Remote API]and the --cap-add option to [docker run]. + // + // 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" + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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" | + // default configuration provided by Docker. This parameter maps to CapDrop in the [Create a container] + // section of the [Docker Remote API]and the --cap-drop option to [docker run]. + // + // 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" | @@ -2189,6 +2616,10 @@ type KernelCapabilities struct { // "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | // "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | // "SYSLOG" | "WAKE_ALARM" + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ Drop []string noSmithyDocumentSerde @@ -2208,49 +2639,65 @@ type KeyValuePair struct { 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) -// . +// The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities]. +// +// [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 - // default configuration provided by Docker. For tasks that use the Fargate launch - // type, capabilities is supported for all platform versions but the add parameter - // is only supported if using platform version 1.4.0 or later. + // default configuration provided by Docker. + // + // For tasks that use the Fargate launch type, capabilities is supported for all + // platform versions but the add parameter is only supported if using platform + // version 1.4.0 or later. 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 + // the [Create a container]section of the [Docker Remote API] and the --device option to [docker run]. + // + // If you're using tasks that use the Fargate launch type, the devices parameter // isn't supported. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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]. 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}}' + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration 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. If you're using tasks on Amazon Linux - // 2023 the swappiness parameter isn't supported. + // will be translated to the --memory-swap option to [docker run] 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. + // + // If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't + // supported. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration 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 + // the --shm-size option to [docker run]. + // + // If you are using tasks that use the Fargate launch type, the sharedMemorySize // parameter is not supported. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration SharedMemorySize *int32 // This allows you to tune a container's memory swappiness behavior. A swappiness @@ -2259,34 +2706,50 @@ type LinuxParameters struct { // 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. If you're using tasks on Amazon Linux 2023 the - // swappiness parameter isn't supported. + // the --memory-swappiness option to [docker run]. + // + // If you're using tasks that use the Fargate launch type, the swappiness + // parameter isn't supported. + // + // If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't + // supported. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration 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 + // parameter maps to the --tmpfs option to [docker run]. + // + // If you're using tasks that use the Fargate launch type, the tmpfs parameter // isn't supported. + // + // [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration 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 -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// 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]in the Amazon Elastic Container Service Developer +// Guide. +// +// [Using service-linked roles]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html type LoadBalancer struct { // The name of the container (as it appears in a container definition) to - // associate with the load balancer. You need to specify the container name when - // configuring the target group for an Amazon ECS load balancer. + // associate with the load balancer. + // + // You need to specify the container name when configuring the target group for an + // Amazon ECS load balancer. ContainerName *string // The port on the container to associate with the load balancer. This port must @@ -2297,75 +2760,110 @@ type LoadBalancer struct { ContainerPort *int32 // The name of the load balancer to associate with the Amazon ECS service or task - // set. If you are using an Application Load Balancer or a Network Load Balancer - // the load balancer name parameter should be omitted. + // set. + // + // If you are using an Application Load Balancer or a Network Load Balancer the + // load balancer name parameter should be omitted. LoadBalancerName *string // The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group - // or groups associated with a service or task set. A target group ARN is only - // specified when using an Application Load Balancer or Network Load Balancer. 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) - // 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) - // 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. + // or groups associated with a service or task set. + // + // A target group ARN is only specified when using an Application Load Balancer or + // Network Load Balancer. + // + // 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]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]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. + // + // [Registering multiple target groups with a service]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html + // [Blue/green deployment with CodeDeploy]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html 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 -// configuration for your containers. +// the [Create a container]section of the [Docker Remote API] and the --log-driver option to [docker run]docker 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]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. Additional log drivers may be available in future releases of -// the Amazon ECS container agent. 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 . -// - 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. +// the Amazon ECS container agent. +// +// 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 . +// +// - 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]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. +// +// [docker run]: https://docs.docker.com/engine/reference/commandline/run/ +// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate +// [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ +// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ +// +// [Amazon ECS container agent configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html 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) - // 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) - // 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 - // customize it to work with that driver. We encourage you to submit pull requests - // for changes that you would like to have included. However, we don't currently - // provide support for running modified copies of this software. + // 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] in the Amazon + // Elastic Container Service Developer Guide. + // + // For more information about using the awsfirelens log driver, see [Custom log routing] 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]and customize it to work with that driver. We + // encourage you to submit pull requests for changes that you would like to have + // included. However, we don't currently provide support for running modified + // copies of this software. + // + // [available on GitHub]: https://github.com/aws/amazon-ecs-agent + // [Using the awslogs log driver]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html + // [Custom log routing]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html // // This member is required. LogDriver LogDriver @@ -2377,9 +2875,10 @@ type LogConfiguration struct { // '{{.Server.APIVersion}}' 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) - // in the Amazon Elastic Container Service Developer Guide. + // The secrets to pass to the log configuration. For more information, see [Specifying sensitive data] in the + // Amazon Elastic Container Service Developer Guide. + // + // [Specifying sensitive data]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html SecretOptions []Secret noSmithyDocumentSerde @@ -2428,14 +2927,18 @@ type ManagedAgentStateChange struct { noSmithyDocumentSerde } -// The managed scaling settings for the Auto Scaling group capacity provider. When -// managed scaling is turned on, Amazon ECS manages the scale-in and scale-out -// 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) -// in the Amazon Elastic Container Service Developer Guide. If managed scaling is -// off, the user must manage the scaling of the Auto Scaling group. +// The managed scaling settings for the Auto Scaling group capacity provider. +// +// When managed scaling is turned on, Amazon ECS manages the scale-in and +// scale-out 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]in the Amazon Elastic Container Service Developer Guide. +// +// If managed scaling is off, the user must manage the scaling of the Auto Scaling +// group. +// +// [Using managed scaling]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling type ManagedScaling struct { // The period of time, in seconds, after a newly launched Amazon EC2 instance can @@ -2450,13 +2953,16 @@ type ManagedScaling struct { // 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 - // minimum scaling step size value and will ignore both the maximum scaling step - // size as well as the capacity demand. + // 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 minimum scaling step size value and will ignore both the maximum + // scaling step size as well as the capacity demand. MinimumScalingStepSize *int32 // Determines whether to use managed scaling for the capacity provider. @@ -2493,8 +2999,8 @@ type MountPoint struct { // 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 -// DescribeTasks API responses. +// and container port assignments are visible in the networkBindings section of DescribeTasks +// API responses. type NetworkBinding struct { // The IP address that the container is bound to on the container instance. @@ -2504,36 +3010,55 @@ 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 - // : + // 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 hostPortRange is // set to the same value as the containerPortRange . 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. + // config file when you have a large number of ports. + // + // For more information, see [Issue #11185]on the Github website. + // + // For information about how to turn off the docker-proxy in the Docker daemon + // config file, see [Docker daemon]in the Amazon ECS Developer Guide. + // + // You can call [DescribeTasks]DescribeTasks to view the hostPortRange which are the host ports + // that are bound to the container ports. + // + // [Docker daemon]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon + // [DescribeTasks]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html + // [Issue #11185]: https://github.com/moby/moby/issues/11185 ContainerPortRange *string // The port number on the host that's used with the network binding. @@ -2552,8 +3077,9 @@ type NetworkBinding struct { // The network configuration for a task or service. type NetworkConfiguration struct { - // The VPC subnets and security groups that are associated with a task. All - // specified subnets and security groups must be from the same VPC. + // The VPC subnets and security groups that are associated with a task. + // + // All specified subnets and security groups must be from the same VPC. AwsvpcConfiguration *AwsVpcConfiguration noSmithyDocumentSerde @@ -2576,16 +3102,20 @@ type NetworkInterface struct { } // 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. +// see [Task placement constraints]in the Amazon Elastic Container Service Developer Guide. +// +// If you're using the Fargate launch type, task placement constraints aren't +// supported. +// +// [Task placement constraints]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // the constraint type is distinctInstance . For more information, see [Cluster query language] in the + // Amazon Elastic Container Service Developer Guide. + // + // [Cluster query language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html Expression *string // The type of constraint. Use distinctInstance to ensure that each task in a @@ -2596,9 +3126,10 @@ type PlacementConstraint struct { noSmithyDocumentSerde } -// 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) +// The task placement strategy for a task or service. For more information, see [Task placement strategies] // in the Amazon Elastic Container Service Developer Guide. +// +// [Task placement strategies]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement @@ -2643,19 +3174,27 @@ type PlatformDevice struct { // 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 . Most fields of this -// parameter ( containerPort , hostPort , protocol ) 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/commandline/run/) -// . If the network mode of a task definition is set to host , host ports must -// either be undefined or match the container port in the port mapping. 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 DescribeTasks API responses. +// 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 . +// +// Most fields of this parameter ( containerPort , hostPort , protocol ) maps to +// PortBindings in the [Create a container] section of the [Docker Remote API] and the --publish option to [docker run]docker run . If +// the network mode of a task definition is set to host , host ports must either be +// undefined or match the container port in the port mapping. +// +// 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 DescribeTasks API +// responses. +// +// [docker run]: https://docs.docker.com/engine/reference/commandline/run/ +// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate +// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ type PortMapping struct { // The application protocol that's used for the port mapping. This parameter only @@ -2663,23 +3202,31 @@ type PortMapping struct { // consistent with the protocol that your application uses. If you set this // parameter, Amazon ECS adds protocol-specific connection handling to the Service // Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific - // telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for - // this parameter, then TCP is used. However, Amazon ECS doesn't add - // protocol-specific telemetry for TCP. appProtocol is immutable in a Service - // Connect service. Updating this field requires a service deletion and - // redeployment. 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. + // telemetry in the Amazon ECS console and CloudWatch. + // + // If you don't set a value for this parameter, then TCP is used. However, Amazon + // ECS doesn't add protocol-specific telemetry for TCP. + // + // appProtocol is immutable in a Service Connect service. Updating this field + // requires a service deletion and redeployment. + // + // 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]in the + // Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html 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 - // you use containers in a task with the bridge network mode and you specify a + // 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 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 // mappings that are automatically assigned in this way do not count toward the 100 @@ -2687,76 +3234,108 @@ type PortMapping 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 - // : + // 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 hostPortRange is // set to the same value as the containerPortRange . 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. + // config file when you have a large number of ports. + // + // For more information, see [Issue #11185]on the Github website. + // + // For information about how to turn off the docker-proxy in the Docker daemon + // config file, see [Docker daemon]in the Amazon ECS Developer Guide. + // + // You can call [DescribeTasks]DescribeTasks to view the hostPortRange which are the host ports + // that are bound to the container ports. + // + // [Docker daemon]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon + // [DescribeTasks]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html + // [Issue #11185]: https://github.com/moby/moby/issues/11185 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 - // hostPort is set as follows: + // 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 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 automatically 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 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 (Linux) - // or 49152 through 65535 (Windows) 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) - // 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. + // 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 (Linux) or 49152 through 65535 (Windows) 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] 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. + // + // [DescribeContainerInstances]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html HostPort *int32 // The name that's used for the port mapping. This parameter only applies to // Service Connect. This parameter is the name that you use in the // 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) - // in the Amazon Elastic Container Service Developer Guide. + // (_), and hyphens (-). The name can't start with a hyphen. + // + // For more information, see [Service Connect] in the Amazon Elastic Container Service Developer + // Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html Name *string // The protocol used for the port mapping. Valid values are tcp and udp . The @@ -2768,8 +3347,7 @@ type PortMapping struct { } // 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. +// the protection status with the UpdateTaskProtectionAPI and get the status of tasks with the GetTaskProtection API. type ProtectedTask struct { // The epoch time when protection for the task will expire. @@ -2785,13 +3363,16 @@ type ProtectedTask struct { noSmithyDocumentSerde } -// The configuration details for the App Mesh proxy. For tasks that use the EC2 -// launch type, 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 Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) +// The configuration details for the App Mesh proxy. +// +// For tasks that use the EC2 launch type, 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 Linux AMI] +// +// [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. @@ -2801,24 +3382,31 @@ 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. @@ -2834,11 +3422,12 @@ type ProxyConfiguration struct { type RepositoryCredentials struct { // The Amazon Resource Name (ARN) of the secret containing the private repository - // credentials. When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, - // if the secret exists in the same Region as the task that you're launching then - // you can use either the full ARN or the name of the secret. When you use the - // Amazon Web Services Management Console, you must specify the full ARN of the - // secret. + // credentials. + // + // When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret + // exists in the same Region as the task that you're launching then you can use + // either the full ARN or the name of the secret. When you use the Amazon Web + // Services Management Console, you must specify the full ARN of the secret. // // This member is required. CredentialsParameter *string @@ -2876,9 +3465,10 @@ 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/ecs-inference.html) -// in the Amazon Elastic Container Service Developer Guide +// information, see [Working with GPUs on Amazon ECS]or [Working with Amazon Elastic Inference on Amazon ECS] in the Amazon Elastic Container Service Developer Guide +// +// [Working with Amazon Elastic Inference on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html +// [Working with GPUs on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html type ResourceRequirement struct { // The type of resource to assign to a container. The supported values are GPU or @@ -2887,13 +3477,17 @@ type ResourceRequirement struct { // 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 - // 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) - // specified in a task definition. + // 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]specified in a task definition. + // + // [InferenceAccelerator]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html // // This member is required. Value *string @@ -2901,14 +3495,19 @@ type ResourceRequirement struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// Information about the platform for the Amazon ECS service or task. +// +// For more information about RuntimePlatform , see [RuntimePlatform] in the Amazon Elastic +// Container Service Developer Guide. +// +// [RuntimePlatform]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform 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. + // 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. CpuArchitecture CPUArchitecture // The operating system. @@ -2933,13 +3532,17 @@ 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. // -// 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. +// For more information, see [Specifying sensitive data] in the Amazon Elastic Container Service Developer +// Guide. +// +// [Specifying sensitive data]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html type Secret struct { // The name of the secret. @@ -2949,14 +3552,18 @@ 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) - // (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 - // the parameter. If the parameter exists in a different Region, then the full ARN - // must be specified. + // Parameter Store. + // + // For information about the require Identity and Access Management permissions, + // see [Required IAM permissions for Amazon ECS secrets](for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets] (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 the parameter. + // If the parameter exists in a different Region, then the full ARN must be + // specified. + // + // [Required IAM permissions for Amazon ECS secrets]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html // // This member is required. ValueFrom *string @@ -2992,13 +3599,15 @@ type Service struct { Deployments []Deployment // 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 . + // the service. This value is specified when the service is created with 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) - // in the Amazon Elastic Container Service Developer Guide. + // For more information, see [Tagging Your Amazon ECS Resources]in the Amazon Elastic Container Service Developer + // Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags bool // Determines whether the execute command functionality is turned on for the @@ -3038,16 +3647,18 @@ type Service struct { 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 - // part of this service must use the same platformFamily value as the service (for - // example, LINUX ). + // 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 ). 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) - // in the Amazon Elastic Container Service Developer Guide. + // LATEST platform version is used. For more information, see [Fargate Platform Versions] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // Determines whether to propagate the tags from the task definition or the @@ -3062,24 +3673,30 @@ type Service struct { // The number of tasks in the cluster that are in the RUNNING state. 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. + // The scheduling strategy to use for the service. For more information, see [Services]. + // + // 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. + // placement constraints. + // + // Fargate tasks don't support the DAEMON scheduling strategy. + // + // [Services]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html 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) - // in the Amazon ECS Developer Guide. + // see [Amazon Resource Name (ARN)]in the Amazon ECS Developer Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids ServiceArn *string // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, @@ -3089,8 +3706,9 @@ 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]. + // + // [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 . @@ -3098,17 +3716,26 @@ type Service struct { // 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: + // 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 @@ -3116,8 +3743,7 @@ type Service struct { 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 @@ -3130,21 +3756,28 @@ type Service struct { } // Each alias ("endpoint") is a fully-qualified name and port number that other -// tasks ("clients") can use to connect to this service. Each name and port mapping -// must be unique within the 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. +// tasks ("clients") can use to connect to this service. +// +// Each name and port mapping must be unique within the 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]in the +// Amazon Elastic Container Service Developer Guide. +// +// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html // // This member is required. Port *int32 @@ -3153,14 +3786,19 @@ type ServiceConnectClientAlias struct { // connect to this service. The name must be a valid DNS name but doesn't need to // be fully-qualified. The name can include up to 127 characters. The name can // include lowercase letters, numbers, underscores (_), hyphens (-), and periods - // (.). 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 - // 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) - // in the Amazon Elastic Container Service Developer Guide. + // (.). 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 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] in the Amazon Elastic Container + // Service Developer Guide. + // + // [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html DnsName *string noSmithyDocumentSerde @@ -3168,13 +3806,16 @@ type ServiceConnectClientAlias struct { // The Service Connect configuration of your Amazon ECS service. 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. +// 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]in the +// Amazon Elastic Container Service Developer Guide. +// +// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html type ServiceConnectConfiguration struct { // Specifies whether to use Service Connect with this service. @@ -3183,61 +3824,79 @@ type ServiceConnectConfiguration struct { 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 - // configuration for your containers. + // the [Create a container]section of the [Docker Remote API] and the --log-driver option to [docker run]docker 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]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. Additional log drivers may be available in future releases of - // the Amazon ECS container agent. 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 . + // the Amazon ECS container agent. + // + // 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 . + // // - 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. + // [Amazon ECS container agent configuration]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. + // + // [docker run]: https://docs.docker.com/engine/reference/commandline/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate + // [Configure logging drivers]: https://docs.docker.com/engine/admin/logging/overview/ + // [Amazon ECS container agent configuration]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ 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 - // doesn't affect Service Connect. For more information about Cloud Map, see - // Working with Services (https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) - // in the Cloud Map Developer Guide. + // doesn't affect Service Connect. For more information about Cloud Map, see [Working with Services]in + // the Cloud Map Developer Guide. + // + // [Working with Services]: https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html Namespace *string // The list of Service Connect service objects. These are names and aliases (also // known as endpoints) that are used by other Amazon ECS services to connect to - // this service. This field is not required for a "client" Amazon ECS service - // that's a member of a namespace only to connect to other services within the - // namespace. An example of this would be a frontend application that accepts - // incoming requests from either a load balancer that's attached to the service or - // by other means. An object selects a port from the task definition, assigns a - // name for the Cloud Map service, and a list of aliases (endpoints) and ports for - // client applications to refer to this service. + // this service. + // + // This field is not required for a "client" Amazon ECS service that's a member of + // a namespace only to connect to other services within the namespace. An example + // of this would be a frontend application that accepts incoming requests from + // either a load balancer that's attached to the service or by other means. + // + // An object selects a port from the task definition, assigns a name for the Cloud + // Map service, and a list of aliases (endpoints) and ports for client applications + // to refer to this service. Services []ServiceConnectService noSmithyDocumentSerde } -// The Service Connect service object 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. +// The Service Connect service object configuration. For more information, see [Service Connect] in +// the Amazon Elastic Container Service Developer Guide. +// +// [Service Connect]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html type ServiceConnectService struct { // The portName must match the name of one of the portMappings from all the @@ -3248,29 +3907,37 @@ type ServiceConnectService struct { // The list of client aliases for this Service Connect service. You use these to // assign names that can be used by client applications. The maximum number of - // 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 . + // 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 . 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 - // 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 - // proxy. + // 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 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 proxy. IngressPortOverride *int32 // A reference to an object that represents the configured timeouts for Service @@ -3286,11 +3953,12 @@ type ServiceConnectService struct { // The Service Connect resource. Each configuration maps a discovery name to a // Cloud Map service name. The data is stored in Cloud Map as part of the Service -// Connect configuration for each discovery name of this Amazon ECS service. A task -// can resolve the dnsName for each of the clientAliases of a service. However a -// task can't resolve the discovery names. If you want to connect to a service, -// refer to the ServiceConnectConfiguration of that service for the list of -// clientAliases that you can use. +// Connect configuration for each discovery name of this Amazon ECS service. +// +// A task can resolve the dnsName for each of the clientAliases of a service. +// However a task can't resolve the discovery names. If you want to connect to a +// service, refer to the ServiceConnectConfiguration of that service for the list +// of clientAliases that you can use. type ServiceConnectServiceResource struct { // The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the @@ -3299,13 +3967,16 @@ type ServiceConnectServiceResource struct { // outside of Amazon ECS. DiscoveryArn *string - // The discovery name of this Service Connect resource. 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 . + // The discovery name of this Service Connect resource. + // + // 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 . DiscoveryName *string noSmithyDocumentSerde @@ -3356,111 +4027,151 @@ type ServiceEvent struct { // The configuration for the Amazon EBS volume that Amazon ECS creates and manages // on your behalf. These settings are used to create each Amazon EBS volume, with -// one volume created for each task in the service. Many of these parameters map -// 1:1 with the Amazon EBS CreateVolume API request parameters. +// one volume created for each task in the service. +// +// Many of these parameters map 1:1 with the Amazon EBS CreateVolume API request +// parameters. type ServiceManagedEBSVolumeConfiguration struct { // The ARN of the IAM role to associate with this volume. This is the Amazon ECS // infrastructure IAM role that is used to manage your Amazon Web Services // infrastructure. We recommend using the Amazon ECS-managed // AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more - // information, see Amazon ECS infrastructure IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) - // in the Amazon ECS Developer Guide. + // information, see [Amazon ECS infrastructure IAM role]in the Amazon ECS Developer Guide. + // + // [Amazon ECS infrastructure IAM role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html // // This member is required. RoleArn *string // Indicates whether the volume should be encrypted. If no value is specified, // encryption is turned on by default. This parameter maps 1:1 with the Encrypted - // parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. + // parameter of the [CreateVolume API]in the Amazon EC2 API Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html Encrypted *bool // The Linux filesystem type for the volume. For volumes created from a snapshot, // you must specify the same filesystem type that the volume was using when the // snapshot was created. If there is a filesystem type mismatch, the task will fail - // to start. The available filesystem types are
 ext3 , ext4 , and xfs . If no - // value is specified, the xfs filesystem type is used by default. + // to start. + // + // The available filesystem types are
 ext3 , ext4 , and xfs . If no value is + // specified, the xfs filesystem type is used by default. FilesystemType TaskFilesystemType // 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. + // 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 - 256,000 IOPS + // // This parameter is required for io1 and io2 volume types. The default for gp3 // volumes is 3,000 IOPS . This parameter is not supported for st1 , sc1 , or - // standard volume types. This parameter maps 1:1 with the Iops parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. + // standard volume types. + // + // This parameter maps 1:1 with the Iops parameter of the [CreateVolume API] in the Amazon EC2 API + // Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html Iops *int32 // The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key // Management Service key to use for Amazon EBS encryption. When encryption is // turned on and no Amazon Web Services Key Management Service key is specified, // the default Amazon Web Services managed key for Amazon EBS volumes is used. This - // parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. Amazon Web Services authenticates the Amazon - // Web Services Key Management Service key asynchronously. Therefore, if you - // specify an ID, alias, or ARN that is invalid, the action can appear to complete, - // but eventually fails. + // parameter maps 1:1 with the KmsKeyId parameter of the [CreateVolume API] in the Amazon EC2 API + // Reference. + // + // Amazon Web Services authenticates the Amazon Web Services Key Management + // Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that + // is invalid, the action can appear to complete, but eventually fails. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html KmsKeyId *string // The size of the volume in GiB. You must specify either a volume size or a // snapshot ID. If you specify a snapshot ID, the snapshot size is used for the // volume size by default. You can optionally specify a volume size greater than or // equal to the snapshot size. This parameter maps 1:1 with the Size parameter of - // the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. The following are the supported volume size - // values for each volume type. + // the [CreateVolume API]in the Amazon EC2 API Reference. + // + // The following are the supported volume size values 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 + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html SizeInGiB *int32 // The snapshot that Amazon ECS uses to create the volume. You must specify either // a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId - // parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. + // parameter of the [CreateVolume API]in the Amazon EC2 API Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html SnapshotId *string // The tags to apply to the volume. Amazon ECS applies service-managed tags by - // default. This parameter maps 1:1 with the TagSpecifications.N parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) + // default. This parameter maps 1:1 with the TagSpecifications.N parameter of the [CreateVolume API] // in the Amazon EC2 API Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html TagSpecifications []EBSTagSpecification // The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 - // MiB/s. This parameter maps 1:1 with the Throughput parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. This parameter is only supported for the gp3 - // volume type. + // MiB/s. This parameter maps 1:1 with the Throughput parameter of the [CreateVolume API] in the + // Amazon EC2 API Reference. + // + // This parameter is only supported for the gp3 volume type. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html Throughput *int32 - // The volume type. This parameter maps 1:1 with the VolumeType parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. For more information, see Amazon EBS volume - // types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) - // in the Amazon EC2 User Guide. The following are the supported volume types. + // The volume type. This parameter maps 1:1 with the VolumeType parameter of the [CreateVolume API] + // in the Amazon EC2 API Reference. For more information, see [Amazon EBS volume types]in the Amazon EC2 + // User Guide. + // + // The following are the supported volume types. + // // - General Purpose SSD: gp2 | gp3 + // // - Provisioned IOPS SSD: io1 | io2 + // // - Throughput Optimized HDD: st1 + // // - Cold HDD: sc1 - // - Magnetic: standard The magnetic volume type is not supported on Fargate. + // + // - Magnetic: standard + // + // The magnetic volume type is not supported on Fargate. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html + // [Amazon EBS volume types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html VolumeType *string noSmithyDocumentSerde } -// The details for the service registry. Each service may be associated with one -// service registry. Multiple service registries for each service are not -// supported. When you add, update, or remove the service registries configuration, -// Amazon ECS starts a new deployment. New tasks are registered and deregistered to -// the updated service registry configuration. +// The details for the service registry. +// +// Each service may be associated with one service registry. Multiple service +// registries for each service are not supported. +// +// When you add, update, or remove the service registries configuration, Amazon +// ECS starts a new deployment. New tasks are registered and deregistered to the +// updated service registry configuration. type ServiceRegistry struct { // The container name value to be used for your service discovery service. It's @@ -3487,8 +4198,9 @@ 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]. + // + // [CreateService]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html RegistryArn *string noSmithyDocumentSerde @@ -3542,9 +4254,11 @@ type Setting struct { PrincipalArn *string // Indicates whether Amazon Web Services manages the account setting, or if the - // user manages it. aws_managed account settings are read-only, as Amazon Web - // Services manages such on the customer's behalf. Currently, the guardDutyActivate - // account setting is the only one Amazon Web Services manages. + // user manages it. + // + // aws_managed account settings are read-only, as Amazon Web Services manages such + // on the customer's behalf. Currently, the guardDutyActivate account setting is + // the only one Amazon Web Services manages. Type SettingType // Determines whether the account setting is on or off for the specified resource. @@ -3554,62 +4268,82 @@ 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) -// . For example, you can configure net.ipv4.tcp_keepalive_time setting to -// maintain longer lived connections. We don't recommend that you specify -// network-related systemControls parameters for multiple containers in a single -// task that also uses either the awsvpc or host network mode. Doing this has the -// following disadvantages: +// maps to Sysctls in the [Create a container] section of the [Docker Remote API] and the --sysctl option to [docker run]. For +// example, you can configure net.ipv4.tcp_keepalive_time setting to maintain +// longer lived connections. +// +// We don't recommend that you specify network-related systemControls parameters +// for multiple containers in a single task that also uses either the awsvpc or +// host network mode. Doing this has the following disadvantages: +// // - For tasks that use the awsvpc network mode including Fargate, 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 network namespace // systemControls aren't supported. // // If you're setting an IPC resource namespace to use for the containers in the // task, the following conditions apply to your system controls. For more -// information, see IPC mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode) -// . +// information, see [IPC mode]. +// // - For tasks that use the host IPC mode, IPC namespace systemControls aren't // supported. +// // - For tasks that use the task IPC mode, IPC namespace systemControls values // apply to all containers within a task. // -// This parameter is not supported for Windows containers. This parameter is only -// supported for tasks that are hosted on Fargate if the tasks are using platform -// version 1.4.0 or later (Linux). This isn't supported for Windows containers on -// Fargate. +// This parameter is not supported for Windows containers. +// +// This parameter is only supported for tasks that are hosted on Fargate if the +// tasks are using platform version 1.4.0 or later (Linux). This isn't supported +// for Windows containers on Fargate. +// +// [docker run]: https://docs.docker.com/engine/reference/run/#security-configuration +// [Create a container]: https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate +// [IPC mode]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode +// [Docker Remote API]: https://docs.docker.com/engine/api/v1.35/ type SystemControl struct { // The namespaced kernel parameter to set a value for. Namespace *string - // The namespaced kernel parameter to set a value for. Valid IPC namespace values: - // "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | - // "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced" , - // and Sysctls that start with "fs.mqueue.*" Valid network namespace values: - // Sysctls that start with "net.*" All of these values are supported by Fargate. + // The namespaced kernel parameter to set a value for. + // + // Valid IPC namespace values: "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" + // | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | + // "kernel.shm_rmid_forced" , and Sysctls that start with "fs.mqueue.*" + // + // Valid network namespace values: Sysctls that start with "net.*" + // + // All of these values are supported by Fargate. Value *string noSmithyDocumentSerde } // 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: +// 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 @@ -3662,34 +4396,49 @@ type Task struct { // 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. + // 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. + // + // 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. + // + // 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]. + // + // [Task Lifecycle]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html DesiredStatus *string // Determines whether execute command functionality is turned on for this task. If @@ -3709,64 +4458,82 @@ type Task struct { // 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. + // 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]. + // + // [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) - // in the Amazon Elastic Container Service Developer Guide. + // The infrastructure where your task runs on. For more information, see [Amazon ECS launch types] in the + // Amazon Elastic Container Service Developer Guide. + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html 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 - // 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) + // 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. + // 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. + // vCPU) + // + // This option requires Linux platform 1.4.0 or later. Memory *string // One or more container overrides. Overrides *TaskOverride // 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. ). + // 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. ). 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) - // in the Amazon Elastic Container Service Developer Guide. + // the LATEST platform version is used. For more information, see [Fargate Platform Versions] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // The Unix timestamp for the time when the container image pull began. @@ -3785,9 +4552,11 @@ type Task struct { StartedBy *string // The stop code indicating why a task was stopped. The stoppedReason might - // contain additional details. For more information about stop code, see Stopped - // tasks error codes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stopped-task-error-codes.html) - // in the Amazon ECS Developer Guide. + // contain additional details. + // + // For more information about stop code, see [Stopped tasks error codes] in the Amazon ECS Developer Guide. + // + // [Stopped tasks error codes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stopped-task-error-codes.html StopCode TaskStopCode // The Unix timestamp for the time when the task was stopped. More specifically, @@ -3804,17 +4573,26 @@ type Task struct { // 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: + // 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 @@ -3845,36 +4623,50 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // definition registration. For more information, see [Amazon ECS launch types]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // definition parameters and defaults, see [Amazon ECS Task Definitions]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Amazon ECS Task Definitions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html ContainerDefinitions []ContainerDefinition // The number of cpu units used by the task. If you use the EC2 launch type, this // 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. + // 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. + // + // 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. + // + // This option requires Linux platform 1.4.0 or later. Cpu *string // The Unix timestamp for the time when the task definition was deregistered. @@ -3886,17 +4678,20 @@ type TaskDefinition struct { // 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. + // requirements of your task. For more information, see [Amazon ECS task execution IAM role]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Amazon ECS task execution IAM role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html ExecutionRoleArn *string // The name of a family that this task definition is registered to. Up to 255 // characters are allowed. Letters (both uppercase and lowercase letters), numbers, - // hyphens (-), and underscores (_) are allowed. A family groups multiple versions - // of a task definition. Amazon ECS gives the first task definition that you - // registered to a family a revision number of 1. Amazon ECS gives sequential - // revision numbers to each task definition that you add. + // hyphens (-), and underscores (_) are allowed. + // + // A family groups multiple versions of a task definition. Amazon ECS gives the + // first task definition that you registered to a family a revision number of 1. + // Amazon ECS gives sequential revision numbers to each task definition that you + // add. Family *string // The Elastic Inference accelerator that's associated with the task. @@ -3911,100 +4706,146 @@ type TaskDefinition struct { // 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 + // information, see [IPC settings]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]. + // + // 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 more information, see [System Controls]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. + // + // [System Controls]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html + // [Docker security]: https://docs.docker.com/engine/security/security/ + // [IPC settings]: https://docs.docker.com/engine/reference/run/#ipc-settings---ipc 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 - // 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 + // 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]. + // + // 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) + // + // - 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. + // 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. + // vCPU) + // + // This option requires Linux platform 1.4.0 or later. + // + // [ContainerDefinition]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html 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 - // 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 - // the corresponding host port (for the host network mode) or the attached elastic - // 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 - // 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) - // 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 - // 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. + // 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 the corresponding host port (for the host network mode) or the + // attached elastic 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 allocated an elastic network + // interface, and you must specify a NetworkConfigurationvalue when you create a service or run a task + // with the task definition. For more information, see [Task Networking]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 container instance when port mappings are used. + // + // For more information, see [Network settings] in the Docker run reference. + // + // [Task Networking]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html + // [Network settings]: https://docs.docker.com/engine/reference/run/#network-settings NetworkMode NetworkMode // The process namespace to use for the containers in the task. The valid values // are host or task . On Fargate for Linux containers, the only valid value is task // . For example, monitoring sidecars might need pidMode to access information - // about other containers running in the same task. If host is specified, 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 each container. 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, there's a heightened - // risk of undesired process namespace exposure. For more information, see Docker - // security (https://docs.docker.com/engine/security/security/) . This parameter is - // not supported for Windows containers. This parameter is only supported for tasks - // that are hosted on Fargate if the tasks are using platform version 1.4.0 or - // later (Linux). This isn't supported for Windows containers on Fargate. + // about other containers running in the same task. + // + // If host is specified, 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 each + // container. For more information, see [PID settings]in the Docker run reference. + // + // If the host PID mode is used, there's a heightened risk of undesired process + // namespace exposure. For more information, see [Docker security]. + // + // This parameter is not supported for Windows containers. + // + // This parameter is only supported for tasks that are hosted on Fargate if the + // tasks are using platform version 1.4.0 or later (Linux). This isn't supported + // for Windows containers on Fargate. + // + // [PID settings]: https://docs.docker.com/engine/reference/run/#pid-settings---pid + // [Docker security]: https://docs.docker.com/engine/security/security/ PidMode PidMode - // An array of placement constraint objects to use for tasks. This parameter isn't - // supported for tasks run on Fargate. + // An array of placement constraint objects to use for tasks. + // + // This parameter isn't supported for tasks run on Fargate. PlacementConstraints []TaskDefinitionPlacementConstraint - // The configuration details for the App Mesh proxy. Your Amazon ECS 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, 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) - // in the Amazon Elastic Container Service Developer Guide. + // The configuration details for the App Mesh proxy. + // + // Your Amazon ECS 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, they contain the required versions + // of the container agent and ecs-init . For more information, see [Amazon ECS-optimized Linux AMI] in the Amazon + // Elastic Container Service Developer Guide. + // + // [Amazon ECS-optimized Linux AMI]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html ProxyConfiguration *ProxyConfiguration // The Unix timestamp for the time when the task definition was registered. @@ -4016,17 +4857,21 @@ type TaskDefinition struct { // The container instance attributes required by your task. When an Amazon EC2 // instance is registered to your cluster, the Amazon ECS container agent assigns // 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) - // in the Amazon Elastic Container Service Developer Guide. This parameter isn't - // supported for tasks run on Fargate. + // are specified as key-value pairs using the Amazon ECS console or the PutAttributesAPI. These + // attributes are used when determining task placement for tasks hosted on Amazon + // EC2 instances. For more information, see [Attributes]in the Amazon Elastic Container + // Service Developer Guide. + // + // This parameter isn't supported for tasks run on Fargate. + // + // [Attributes]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes RequiresAttributes []Attribute // The task launch types the task definition was validated against. The valid - // values are EC2 , FARGATE , and EXTERNAL . 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. + // values are EC2 , FARGATE , and EXTERNAL . For more information, see [Amazon ECS launch types] in the + // Amazon Elastic Container Service Developer Guide. + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html RequiresCompatibilities []Compatibility // The revision of the task in a particular family. The revision is a version @@ -4037,9 +4882,10 @@ type TaskDefinition struct { Revision int32 // The operating system that your task definitions are running on. A platform - // family is specified only for tasks using the Fargate launch type. When you - // specify a task in a service, this value must match the runtimePlatform value of - // the service. + // family is specified only for tasks using the Fargate launch type. + // + // When you specify a task in a service, this value must match the runtimePlatform + // value of the service. RuntimePlatform *RuntimePlatform // The status of the task definition. @@ -4050,33 +4896,41 @@ 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) - // 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) + // Services APIs on your behalf. For more information, see [Amazon ECS Task Role]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] // in the Amazon Elastic Container Service Developer Guide. + // + // [Windows IAM roles for tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html + // [Amazon ECS Task Role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html 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) - // in the Amazon Elastic Container Service Developer Guide. The host and sourcePath - // parameters aren't supported for tasks run on Fargate. + // The list of data volume definitions for the task. For more information, see [Using data volumes in tasks] in + // the Amazon Elastic Container Service Developer Guide. + // + // The host and sourcePath parameters aren't supported for tasks run on Fargate. + // + // [Using data volumes in tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html Volumes []Volume noSmithyDocumentSerde } // The 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) -// in the Amazon Elastic Container Service Developer Guide. Task placement -// constraints aren't supported for tasks run on Fargate. +// see [Task placement constraints]in the Amazon Elastic Container Service Developer Guide. +// +// Task placement constraints aren't supported for tasks run on Fargate. +// +// [Task placement constraints]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Cluster query language]in the Amazon Elastic Container Service Developer Guide. + // + // [Cluster query language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html Expression *string // The type of constraint. The MemberOf constraint restricts selection to be from @@ -4095,74 +4949,97 @@ type TaskManagedEBSVolumeConfiguration struct { // infrastructure IAM role that is used to manage your Amazon Web Services // infrastructure. We recommend using the Amazon ECS-managed // AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more - // information, see Amazon ECS infrastructure IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) - // in the Amazon ECS Developer Guide. + // information, see [Amazon ECS infrastructure IAM role]in the Amazon ECS Developer Guide. + // + // [Amazon ECS infrastructure IAM role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html // // This member is required. RoleArn *string // Indicates whether the volume should be encrypted. If no value is specified, // encryption is turned on by default. This parameter maps 1:1 with the Encrypted - // parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. + // parameter of the [CreateVolume API]in the Amazon EC2 API Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html Encrypted *bool // The Linux filesystem type for the volume. For volumes created from a snapshot, // you must specify the same filesystem type that the volume was using when the // snapshot was created. If there is a filesystem type mismatch, the task will fail - // to start. The available filesystem types are
 ext3 , ext4 , and xfs . If no - // value is specified, the xfs filesystem type is used by default. + // to start. + // + // The available filesystem types are
 ext3 , ext4 , and xfs . If no value is + // specified, the xfs filesystem type is used by default. FilesystemType TaskFilesystemType // 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. + // 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 - 256,000 IOPS + // // This parameter is required for io1 and io2 volume types. The default for gp3 // volumes is 3,000 IOPS . This parameter is not supported for st1 , sc1 , or - // standard volume types. This parameter maps 1:1 with the Iops parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. + // standard volume types. + // + // This parameter maps 1:1 with the Iops parameter of the [CreateVolume API] in the Amazon EC2 API + // Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html Iops *int32 // The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key // Management Service key to use for Amazon EBS encryption. When encryption is // turned on and no Amazon Web Services Key Management Service key is specified, // the default Amazon Web Services managed key for Amazon EBS volumes is used. This - // parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. Amazon Web Services authenticates the Amazon - // Web Services Key Management Service key asynchronously. Therefore, if you - // specify an ID, alias, or ARN that is invalid, the action can appear to complete, - // but eventually fails. + // parameter maps 1:1 with the KmsKeyId parameter of the [CreateVolume API] in the Amazon EC2 API + // Reference. + // + // Amazon Web Services authenticates the Amazon Web Services Key Management + // Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that + // is invalid, the action can appear to complete, but eventually fails. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html KmsKeyId *string // The size of the volume in GiB. You must specify either a volume size or a // snapshot ID. If you specify a snapshot ID, the snapshot size is used for the // volume size by default. You can optionally specify a volume size greater than or // equal to the snapshot size. This parameter maps 1:1 with the Size parameter of - // the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. The following are the supported volume size - // values for each volume type. + // the [CreateVolume API]in the Amazon EC2 API Reference. + // + // The following are the supported volume size values 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 + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html SizeInGiB *int32 // The snapshot that Amazon ECS uses to create the volume. You must specify either // a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId - // parameter of the CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. + // parameter of the [CreateVolume API]in the Amazon EC2 API Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html SnapshotId *string // The tags to apply to the volume. Amazon ECS applies service-managed tags by - // default. This parameter maps 1:1 with the TagSpecifications.N parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) + // default. This parameter maps 1:1 with the TagSpecifications.N parameter of the [CreateVolume API] // in the Amazon EC2 API Reference. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html TagSpecifications []EBSTagSpecification // The termination policy for the volume when the task exits. This provides a way @@ -4171,30 +5048,43 @@ type TaskManagedEBSVolumeConfiguration struct { TerminationPolicy *TaskManagedEBSVolumeTerminationPolicy // The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 - // MiB/s. This parameter maps 1:1 with the Throughput parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. This parameter is only supported for the gp3 - // volume type. + // MiB/s. This parameter maps 1:1 with the Throughput parameter of the [CreateVolume API] in the + // Amazon EC2 API Reference. + // + // This parameter is only supported for the gp3 volume type. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html Throughput *int32 - // The volume type. This parameter maps 1:1 with the VolumeType parameter of the - // CreateVolume API (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) - // in the Amazon EC2 API Reference. For more information, see Amazon EBS volume - // types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) - // in the Amazon EC2 User Guide. The following are the supported volume types. + // The volume type. This parameter maps 1:1 with the VolumeType parameter of the [CreateVolume API] + // in the Amazon EC2 API Reference. For more information, see [Amazon EBS volume types]in the Amazon EC2 + // User Guide. + // + // The following are the supported volume types. + // // - General Purpose SSD: gp2 | gp3 + // // - Provisioned IOPS SSD: io1 | io2 + // // - Throughput Optimized HDD: st1 + // // - Cold HDD: sc1 - // - Magnetic: standard The magnetic volume type is not supported on Fargate. + // + // - Magnetic: standard + // + // The magnetic volume type is not supported on Fargate. + // + // [CreateVolume API]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html + // [Amazon EBS volume types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html VolumeType *string noSmithyDocumentSerde } // The termination policy for the Amazon EBS volume when the task exits. For more -// information, see Amazon ECS volume termination policy (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types) -// . +// information, see [Amazon ECS volume termination policy]. +// +// [Amazon ECS volume termination policy]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types type TaskManagedEBSVolumeTerminationPolicy struct { // Indicates whether the volume should be deleted on when the task stops. If a @@ -4218,15 +5108,21 @@ type TaskOverride struct { // The CPU override for the task. 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: + // 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. 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) - // in the Amazon Elastic Container Service Developer Guide. + // task. For more information, see [Amazon ECS task execution IAM role]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Amazon ECS task execution IAM role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html ExecutionRoleArn *string // The Elastic Inference accelerator override for the task. @@ -4237,8 +5133,10 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // specified in this role. For more information, see [IAM Role for Tasks]in the Amazon Elastic + // Container Service Developer Guide. + // + // [IAM Role for Tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html TaskRoleArn *string noSmithyDocumentSerde @@ -4266,9 +5164,12 @@ type TaskSet struct { // The Unix timestamp for the time when the task set was created. CreatedAt *time.Time - // The external ID associated with the task set. If an CodeDeploy deployment - // created a task set, the externalId parameter contains the CodeDeploy deployment - // ID. If a task set is created for an external deployment and is associated with a + // The external ID associated with the task set. + // + // If an CodeDeploy deployment created a task set, the externalId parameter + // contains the CodeDeploy deployment ID. + // + // If a task set is created for an external deployment and is associated with a // service discovery registry, the externalId parameter contains the // ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute. ExternalId *string @@ -4276,9 +5177,10 @@ type TaskSet struct { // The ID of the task set. 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) + // The launch type the tasks in the task set are using. For more information, see [Amazon ECS launch types] // in the Amazon Elastic Container Service Developer Guide. + // + // [Amazon ECS launch types]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html LaunchType LaunchType // Details on a load balancer that are used with a task set. @@ -4294,14 +5196,16 @@ type TaskSet struct { PendingCount int32 // The operating system that your tasks in the set are running on. A platform - // family is specified only for tasks that use the Fargate launch type. All tasks - // in the set must have the same value. + // family is specified only for tasks that use the Fargate launch type. + // + // All tasks in the set must have the same value. PlatformFamily *string // 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Fargate platform versions]in the Amazon Elastic Container Service Developer Guide. + // + // [Fargate platform versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // The number of tasks in the task set that are in the RUNNING status during a @@ -4316,18 +5220,24 @@ type TaskSet struct { 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) - // . + // For more information, see [Service discovery]. + // + // [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 . StabilityStatus StabilityStatus @@ -4340,25 +5250,37 @@ type TaskSet struct { // 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: + // 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 @@ -4396,15 +5318,19 @@ type TaskVolumeConfiguration struct { noSmithyDocumentSerde } -// An object that represents the timeout configurations for Service Connect. If -// idleTimeout is set to a time that is less than perRequestTimeout , the +// An object that represents the timeout configurations for Service Connect. +// +// If idleTimeout is set to a time that is less than perRequestTimeout , the // connection will close when the idleTimeout is reached and not the // perRequestTimeout . type TimeoutConfiguration struct { // The amount of time in seconds a connection will stay active while idle. A value - // of 0 can be set to disable idleTimeout . The idleTimeout default for HTTP / HTTP2 - // / GRPC is 5 minutes. The idleTimeout default for TCP is 1 hour. + // of 0 can be set to disable idleTimeout . + // + // The idleTimeout default for HTTP / HTTP2 / GRPC is 5 minutes. + // + // The idleTimeout default for TCP is 1 hour. IdleTimeoutSeconds *int32 // The amount of time waiting for the upstream to respond with a complete response @@ -4429,25 +5355,28 @@ 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 } -// 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 65535 . You can specify the ulimit settings for a container in a task -// definition. +// 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 65535 . +// +// You can specify the ulimit settings for a container in a task definition. type Ulimit struct { // The hard limit for the ulimit type. @@ -4472,9 +5401,10 @@ type Ulimit struct { // instance. type VersionInfo struct { - // The Git commit hash for the Amazon ECS container agent build on the - // amazon-ecs-agent (https://github.com/aws/amazon-ecs-agent/commits/master) - // GitHub repository. + // The Git commit hash for the Amazon ECS container agent build on the [amazon-ecs-agent] GitHub + // repository. + // + // [amazon-ecs-agent]: https://github.com/aws/amazon-ecs-agent/commits/master AgentHash *string // The version number of the Amazon ECS container agent. @@ -4493,21 +5423,27 @@ type VersionInfo struct { // specify a name and one of either configuredAtLaunch , dockerVolumeConfiguration // , efsVolumeConfiguration , fsxWindowsFileServerVolumeConfiguration , or host . // If an empty volume configuration is specified, by default Amazon ECS uses a host -// volume. For more information, see Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) -// . +// volume. For more information, see [Using data volumes in tasks]. +// +// [Using data volumes in tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html type Volume struct { // Indicates whether the volume should be configured at launch time. This is used // to create Amazon EBS volumes for standalone tasks or tasks created as part of a // service. Each task definition revision may only have one volume configured at - // launch in the volume configuration. To configure a volume at launch time, use - // this task definition revision and specify a volumeConfigurations object when - // calling the CreateService , UpdateService , RunTask or StartTask APIs. + // launch in the volume configuration. + // + // To configure a volume at launch time, use this task definition revision and + // specify a volumeConfigurations object when calling the CreateService , + // UpdateService , RunTask or StartTask APIs. ConfiguredAtLaunch *bool - // 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. + // 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 // This parameter is specified when you use an Amazon Elastic File System file @@ -4523,21 +5459,26 @@ type Volume struct { // the host container instance and where it's stored. If the host parameter is // 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 - // 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 + // 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 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 . Host *HostVolumeProperties // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, - // underscores, and hyphens are allowed. When using a volume configured at launch, - // the name is required and must also be specified as the volume name in the - // ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating - // your service or standalone task. For all other types of volumes, this name is - // referenced in the sourceVolume parameter of the mountPoints object in the - // container definition. When a volume is using the efsVolumeConfiguration , the - // name is required. + // underscores, and hyphens are allowed. + // + // When using a volume configured at launch, the name is required and must also be + // specified as the volume name in the ServiceVolumeConfiguration or + // TaskVolumeConfiguration parameter when creating your service or standalone task. + // + // For all other types of volumes, this name is referenced in the sourceVolume + // parameter of the mountPoints object in the container definition. + // + // When a volume is using the efsVolumeConfiguration , the name is required. Name *string noSmithyDocumentSerde diff --git a/service/efs/api_op_CreateAccessPoint.go b/service/efs/api_op_CreateAccessPoint.go index 5d76085f28b..3729f5920b0 100644 --- a/service/efs/api_op_CreateAccessPoint.go +++ b/service/efs/api_op_CreateAccessPoint.go @@ -17,20 +17,24 @@ import ( // operating system user and group override any identity information provided by // 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 +// application's own directory and any subdirectories. To learn more, see [Mounting a file system using EFS access points]. +// +// 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 1,000 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. Access points can be tagged on creation. If tags are specified in the -// creation action, IAM performs additional authorization on the +// ensure that the file system does not exceed the stated access point limit. +// +// This operation requires permissions for the elasticfilesystem:CreateAccessPoint +// action. +// +// Access points can be tagged on creation. If tags are specified in the creation +// action, IAM performs additional authorization on the // elasticfilesystem:TagResource action to verify if users have permissions to // create tags. Therefore, you must grant explicit permissions to use the -// elasticfilesystem:TagResource action. For more information, see Granting -// permissions to tag resources during creation (https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html) -// . +// elasticfilesystem:TagResource action. For more information, see [Granting permissions to tag resources during creation]. +// +// [Mounting a file system using EFS access points]: https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html +// [Granting permissions to tag resources during creation]: https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error) { if params == nil { params = &CreateAccessPointInput{} @@ -69,17 +73,19 @@ type CreateAccessPointInput struct { // If the RootDirectory > Path specified does not exist, Amazon 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 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 - // fail. + // 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 fail. RootDirectory *types.RootDirectory // Creates tags associated with the access point. Each tag is a 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. + // each key must be unique. For more information, see [Tagging Amazon Web Services resources]in the Amazon Web Services + // General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/efs/api_op_CreateFileSystem.go b/service/efs/api_op_CreateFileSystem.go index 4d779a335f9..862a064871f 100644 --- a/service/efs/api_op_CreateFileSystem.go +++ b/service/efs/api_op_CreateFileSystem.go @@ -17,47 +17,67 @@ import ( // 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. // // 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 -// 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 -// generalPurpose performance mode for all file systems. File systems using the -// maxIO mode is a previous generation performance type that is designed for highly -// parallelized workloads that can tolerate higher latencies than the General -// Purpose mode. Max I/O mode is not supported for One Zone file systems or file -// systems that use Elastic throughput. Due to the higher per-operation latencies -// with Max I/O, we recommend using General Purpose performance mode for all file -// systems. 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 -// 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 -// 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. File systems can be tagged on creation. If tags are specified in the -// creation action, IAM performs additional authorization on the +// 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] 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 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 generalPurpose performance mode for all file +// systems. File systems using the maxIO mode is a previous generation performance +// type that is designed for highly parallelized workloads that can tolerate higher +// latencies than the General Purpose mode. Max I/O mode is not supported for One +// Zone file systems or file systems that use Elastic throughput. +// +// Due to the higher per-operation latencies with Max I/O, we recommend using +// General Purpose performance mode for all file systems. +// +// The performance mode can't be changed after the file system has been created. +// For more information, see [Amazon EFS performance modes]. +// +// 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 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]. +// +// This operation requires permissions for the elasticfilesystem:CreateFileSystem +// action. +// +// File systems can be tagged on creation. If tags are specified in the creation +// action, IAM performs additional authorization on the // elasticfilesystem:TagResource action to verify if users have permissions to // create tags. Therefore, you must grant explicit permissions to use the -// elasticfilesystem:TagResource action. For more information, see Granting -// permissions to tag resources during creation (https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html) -// . +// elasticfilesystem:TagResource action. For more information, see [Granting permissions to tag resources during creation]. +// +// [Creating a file system]: https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1 +// [Amazon EFS: How it Works]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html +// [Amazon EFS performance modes]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html +// [Granting permissions to tag resources during creation]: https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemInput, optFns ...func(*Options)) (*CreateFileSystemOutput, error) { if params == nil { params = &CreateFileSystemInput{} @@ -84,18 +104,26 @@ type CreateFileSystemInput struct { // Used to create a One Zone file system. 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 file - // systems, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) - // in the Amazon EFS User Guide. One Zone file systems are not available in all - // Availability Zones in Amazon Web Services Regions where Amazon EFS is available. + // systems, see [Using EFS storage classes]in the Amazon EFS User Guide. + // + // One Zone file systems are not available in all Availability Zones in Amazon Web + // Services Regions where Amazon EFS is available. + // + // [Using EFS storage classes]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html 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 One Zone file system, 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. + // more information, see [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. + // + // [Automatic backups]: https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups Backup *bool // A Boolean value that, if true, creates an encrypted file system. When creating @@ -109,17 +137,23 @@ type CreateFileSystemInput struct { // 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. + // + // 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 @@ -127,24 +161,29 @@ type CreateFileSystemInput struct { // 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 One Zone file systems. Due to the higher - // per-operation latencies with Max I/O, we recommend using General Purpose - // performance mode for all file systems. Default is generalPurpose . + // The maxIO mode is not supported on One Zone file systems. + // + // Due to the higher per-operation latencies with Max I/O, we recommend using + // General Purpose performance mode for all file systems. + // + // Default is generalPurpose . PerformanceMode types.PerformanceMode // The throughput, measured in mebibytes per second (MiBps), that you want to // provision for a file system that you're creating. Required if ThroughputMode is // set to provisioned . Valid values are 1-3414 MiBps, with the upper limit // depending on Region. 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. + // Support. For more information, see [Amazon EFS quotas that you can increase]in the Amazon EFS User Guide. + // + // [Amazon EFS quotas that you can increase]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits 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]in the Amazon Web Services General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag // Specifies the throughput mode for the file system. The mode can be bursting , @@ -152,8 +191,11 @@ type CreateFileSystemInput struct { // also set a value for ProvisionedThroughputInMibps . After you create the file // system, you can decrease your file system's Provisioned throughput 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 . + // information, see [Specifying throughput with provisioned mode]in the Amazon EFS User Guide. + // + // Default is bursting . + // + // [Specifying throughput with provisioned mode]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput ThroughputMode types.ThroughputMode noSmithyDocumentSerde @@ -184,7 +226,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 @@ -224,9 +266,10 @@ type CreateFileSystemOutput struct { AvailabilityZoneId *string // Describes the Amazon Web Services Availability Zone in which the file system is - // located, and is valid only for One Zone file systems. For more information, see - // Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // located, and is valid only for One Zone file systems. For more information, see [Using EFS storage classes] // in the Amazon EFS User Guide. + // + // [Using EFS storage classes]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html AvailabilityZoneName *string // A Boolean value that, if true, indicates that the file system is encrypted. @@ -245,17 +288,18 @@ 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 MiBps, for the file system. // 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] in the + // Amazon EFS User Guide. + // + // [Throughput modes]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes 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 12b0e3f10de..1453a844e19 100644 --- a/service/efs/api_op_CreateMountTarget.go +++ b/service/efs/api_op_CreateMountTarget.go @@ -12,25 +12,35 @@ import ( ) // Creates a mount target for a file system. You can then mount the file system on -// EC2 instances by using the mount target. You can create one mount target in each -// Availability Zone in your VPC. All EC2 instances in a VPC within a given -// Availability Zone share a single mount target for a given file system. If you -// have multiple subnets in an Availability Zone, you create a mount target in one -// of the subnets. EC2 instances do not need to be in the same subnet as the mount -// target in order to access their file system. You can create only one mount -// target for a One Zone file system. You must create that mount target in the same -// Availability Zone in which the file system is 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: +// EC2 instances by using the mount target. +// +// You can create one mount target in each Availability Zone in your VPC. All EC2 +// instances in a VPC within a given Availability Zone share a single mount target +// for a given file system. If you have multiple subnets in an Availability Zone, +// you create a mount target in one of the subnets. EC2 instances do not need to be +// in the same subnet as the mount target in order to access their file system. +// +// You can create only one mount target for a One Zone file system. You must +// create that mount target in the same Availability Zone in which the file system +// is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in +// the DescribeFileSystemsresponse 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]. +// +// 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) // @@ -39,54 +49,75 @@ import ( // 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 +// address. For more information, see [How it Works: Implementation Overview]. +// +// 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 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: +// target creation status by calling the DescribeMountTargetsoperation, 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]. 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 +// +// [Amazon EFS: How it Works]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html +// [How it Works: Implementation Overview]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation +// [Amazon EFS]: http://aws.amazon.com/efs/ func (c *Client) CreateMountTarget(ctx context.Context, params *CreateMountTargetInput, optFns ...func(*Options)) (*CreateMountTargetOutput, error) { if params == nil { params = &CreateMountTargetInput{} diff --git a/service/efs/api_op_CreateReplicationConfiguration.go b/service/efs/api_op_CreateReplicationConfiguration.go index b154873ea2e..d5ad553f46a 100644 --- a/service/efs/api_op_CreateReplicationConfiguration.go +++ b/service/efs/api_op_CreateReplicationConfiguration.go @@ -13,40 +13,44 @@ import ( ) // Creates a replication configuration that replicates an existing EFS file system -// to a new, read-only file system. For more information, see Amazon EFS -// replication (https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html) in -// the Amazon EFS User Guide. The replication configuration specifies the -// following: +// to a new, read-only file system. For more information, see [Amazon EFS replication]in the Amazon EFS +// User Guide. The replication configuration specifies the following: +// // - Source file system – The EFS file system that you want replicated. The // source file system cannot be a destination file system in an existing // replication configuration. +// // - 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 in which EFS is available. The Region must be -// enabled. For more information, see Managing Amazon Web Services Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) -// in the Amazon Web Services General Reference Reference Guide. +// enabled. For more information, see [Managing Amazon Web Services Regions]in the Amazon Web Services General +// Reference Reference Guide. +// // - 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. -// Parameters for the replication configuration include: +// +// Parameters for the replication configuration include: +// // - File system ID – The ID of the destination file system for the replication. // If no ID is provided, then EFS creates a new file system with the default // settings. For existing file systems, the file system's replication overwrite -// protection must be disabled. For more information, see Replicating to an -// existing file system (https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination) -// . +// protection must be disabled. For more information, see [Replicating to an existing file system]. +// // - Availability Zone – If you want the destination file system to use One Zone // storage, you must specify the Availability Zone to create the file system in. -// For more information, see EFS file system types (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) -// in the Amazon EFS User Guide. +// For more information, see [EFS file system types]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. +// service-managed KMS key for Amazon EFS is used. +// +// After the file system is created, you cannot change the KMS key. // -// After the file system is created, you cannot change the KMS key. For new -// destination file systems, the following properties are set by default: +// After the file system is created, you cannot change the KMS key. +// +// For new destination file systems, 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 @@ -64,8 +68,12 @@ import ( // - Automatic backups – Automatic daily backups are 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] in the Amazon EFS User Guide. +// +// [Managing Amazon Web Services Regions]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable +// [Replicating to an existing file system]: https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination +// [Amazon EFS replication]: https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html +// [EFS file system types]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html 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 2905a01c68e..8231024ac34 100644 --- a/service/efs/api_op_CreateTags.go +++ b/service/efs/api_op_CreateTags.go @@ -12,11 +12,14 @@ import ( ) // 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. +// 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 DescribeFileSystemsoperation. +// // This operation requires permission for the elasticfilesystem:CreateTags action. // // Deprecated: Use TagResource. diff --git a/service/efs/api_op_DeleteAccessPoint.go b/service/efs/api_op_DeleteAccessPoint.go index 0239e2632eb..d508dbab7fb 100644 --- a/service/efs/api_op_DeleteAccessPoint.go +++ b/service/efs/api_op_DeleteAccessPoint.go @@ -13,8 +13,10 @@ import ( // Deletes the specified access point. After deletion is complete, new clients can // no longer connect to the access points. Clients connected to the access point at // the time of deletion will continue to function until they terminate their -// connection. This operation requires permissions for the -// elasticfilesystem:DeleteAccessPoint action. +// connection. +// +// This operation requires permissions for the elasticfilesystem:DeleteAccessPoint +// action. func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error) { if params == nil { params = &DeleteAccessPointInput{} diff --git a/service/efs/api_op_DeleteFileSystem.go b/service/efs/api_op_DeleteFileSystem.go index ab21905cc28..fbd1fa659c8 100644 --- a/service/efs/api_op_DeleteFileSystem.go +++ b/service/efs/api_op_DeleteFileSystem.go @@ -12,18 +12,24 @@ import ( // 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. +// 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 DescribeMountTargetsand DeleteMountTarget. +// +// The DeleteFileSystem call returns while the file system state is still deleting +// . You can check the file system deletion status by calling the DescribeFileSystemsoperation, 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 DescribeFileSystemsreturns 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) { diff --git a/service/efs/api_op_DeleteFileSystemPolicy.go b/service/efs/api_op_DeleteFileSystemPolicy.go index 161e0c036d4..647a20851be 100644 --- a/service/efs/api_op_DeleteFileSystemPolicy.go +++ b/service/efs/api_op_DeleteFileSystemPolicy.go @@ -12,10 +12,12 @@ 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 +// information about the default file system policy, see [Using Resource-based Policies with EFS]. +// +// This operation requires permissions for the // elasticfilesystem:DeleteFileSystemPolicy action. +// +// [Using Resource-based Policies with EFS]: https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html func (c *Client) DeleteFileSystemPolicy(ctx context.Context, params *DeleteFileSystemPolicyInput, optFns ...func(*Options)) (*DeleteFileSystemPolicyOutput, error) { if params == nil { params = &DeleteFileSystemPolicyInput{} diff --git a/service/efs/api_op_DeleteMountTarget.go b/service/efs/api_op_DeleteMountTarget.go index 3e57b50351e..debf64860e4 100644 --- a/service/efs/api_op_DeleteMountTarget.go +++ b/service/efs/api_op_DeleteMountTarget.go @@ -10,23 +10,28 @@ 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 -// 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 -// interface. Uncommitted writes might be lost, but breaking a mount target using -// this operation does not corrupt the file system itself. The file system you -// 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: +// 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 interface. Uncommitted writes might be lost, +// but breaking a mount target using this operation does not corrupt the file +// system itself. The file system you 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 // // 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: +// 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 { diff --git a/service/efs/api_op_DeleteReplicationConfiguration.go b/service/efs/api_op_DeleteReplicationConfiguration.go index 5e094acebc6..8c02f008df2 100644 --- a/service/efs/api_op_DeleteReplicationConfiguration.go +++ b/service/efs/api_op_DeleteReplicationConfiguration.go @@ -13,10 +13,12 @@ import ( // Deletes a replication configuration. Deleting a replication configuration ends // the replication process. After a replication configuration is deleted, the // destination file system becomes Writeable and its replication overwrite -// protection is re-enabled. For more information, see Delete a replication -// configuration (https://docs.aws.amazon.com/efs/latest/ug/delete-replications.html) -// . This operation requires permissions for the +// protection is re-enabled. For more information, see [Delete a replication configuration]. +// +// This operation requires permissions for the // elasticfilesystem:DeleteReplicationConfiguration action. +// +// [Delete a replication configuration]: https://docs.aws.amazon.com/efs/latest/ug/delete-replications.html 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 60bf7081221..07516c433ec 100644 --- a/service/efs/api_op_DeleteTags.go +++ b/service/efs/api_op_DeleteTags.go @@ -11,14 +11,18 @@ import ( ) // DEPRECATED - DeleteTags is deprecated and not maintained. To remove tags from -// 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) -// in the Billing and Cost Management User Guide. This operation requires -// permissions for the elasticfilesystem:DeleteTags action. +// 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]in the +// Billing and Cost Management User Guide. +// +// This operation requires permissions for the elasticfilesystem:DeleteTags action. // // Deprecated: Use UntagResource. +// +// [Tag restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error) { if params == nil { params = &DeleteTagsInput{} diff --git a/service/efs/api_op_DescribeAccessPoints.go b/service/efs/api_op_DescribeAccessPoints.go index 6111e8624f2..e30e2385a16 100644 --- a/service/efs/api_op_DescribeAccessPoints.go +++ b/service/efs/api_op_DescribeAccessPoints.go @@ -14,8 +14,10 @@ import ( // Returns the description of a specific Amazon EFS access point if the // 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. +// an AccessPointId or a FileSystemId in the request, but not both. +// +// This operation requires permissions for the +// elasticfilesystem:DescribeAccessPoints action. func (c *Client) DescribeAccessPoints(ctx context.Context, params *DescribeAccessPointsInput, optFns ...func(*Options)) (*DescribeAccessPointsOutput, error) { if params == nil { params = &DescribeAccessPointsInput{} diff --git a/service/efs/api_op_DescribeFileSystemPolicy.go b/service/efs/api_op_DescribeFileSystemPolicy.go index 99d71b7d318..fdba0a52770 100644 --- a/service/efs/api_op_DescribeFileSystemPolicy.go +++ b/service/efs/api_op_DescribeFileSystemPolicy.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the FileSystemPolicy for the specified EFS file system. This operation -// requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action. +// Returns the FileSystemPolicy for the specified EFS file system. +// +// This operation requires permissions for the +// elasticfilesystem:DescribeFileSystemPolicy action. func (c *Client) DescribeFileSystemPolicy(ctx context.Context, params *DescribeFileSystemPolicyInput, optFns ...func(*Options)) (*DescribeFileSystemPolicyOutput, error) { if params == nil { params = &DescribeFileSystemPolicyInput{} diff --git a/service/efs/api_op_DescribeFileSystems.go b/service/efs/api_op_DescribeFileSystems.go index ec18545117c..2e2f3823b3a 100644 --- a/service/efs/api_op_DescribeFileSystems.go +++ b/service/efs/api_op_DescribeFileSystems.go @@ -15,19 +15,25 @@ import ( // system CreationToken or the FileSystemId is provided. Otherwise, it returns // descriptions of all file systems owned by the caller's Amazon Web Services // account in the Amazon Web Services Region of the endpoint that you're calling. +// // 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 +// 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 { diff --git a/service/efs/api_op_DescribeLifecycleConfiguration.go b/service/efs/api_op_DescribeLifecycleConfiguration.go index 1f1d38f2d03..0ba520fd2b9 100644 --- a/service/efs/api_op_DescribeLifecycleConfiguration.go +++ b/service/efs/api_op_DescribeLifecycleConfiguration.go @@ -15,6 +15,7 @@ import ( // file system. Lifecycle management uses the LifecycleConfiguration object to // identify when to move files between storage classes. For a file system without a // LifecycleConfiguration object, the call returns an empty array in the response. +// // 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 2bcabe4482e..d3af0f743b3 100644 --- a/service/efs/api_op_DescribeMountTargetSecurityGroups.go +++ b/service/efs/api_op_DescribeMountTargetSecurityGroups.go @@ -12,10 +12,13 @@ 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 -// operation requires permissions for the following actions: +// 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. func (c *Client) DescribeMountTargetSecurityGroups(ctx context.Context, params *DescribeMountTargetSecurityGroupsInput, optFns ...func(*Options)) (*DescribeMountTargetSecurityGroupsOutput, error) { diff --git a/service/efs/api_op_DescribeMountTargets.go b/service/efs/api_op_DescribeMountTargets.go index cc9653979c1..9e83336f233 100644 --- a/service/efs/api_op_DescribeMountTargets.go +++ b/service/efs/api_op_DescribeMountTargets.go @@ -13,10 +13,12 @@ import ( // Returns the descriptions of all the current mount targets, or a specific mount // 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 . +// 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 . func (c *Client) DescribeMountTargets(ctx context.Context, params *DescribeMountTargetsInput, optFns ...func(*Options)) (*DescribeMountTargetsOutput, error) { if params == nil { params = &DescribeMountTargetsInput{} diff --git a/service/efs/api_op_DescribeTags.go b/service/efs/api_op_DescribeTags.go index 0411ead479a..517e5fcab60 100644 --- a/service/efs/api_op_DescribeTags.go +++ b/service/efs/api_op_DescribeTags.go @@ -13,9 +13,11 @@ import ( // DEPRECATED - The DescribeTags action is deprecated and not maintained. To view // tags associated with EFS resources, use the ListTagsForResource API action. +// // Returns the tags associated with a file system. The order of tags returned in // the response of one DescribeTags call and the order of tags returned across the // responses of a multiple-call iteration (when using pagination) is unspecified. +// // This operation requires permissions for the elasticfilesystem:DescribeTags // action. // diff --git a/service/efs/api_op_ListTagsForResource.go b/service/efs/api_op_ListTagsForResource.go index a62207f330f..2c9fea23ac0 100644 --- a/service/efs/api_op_ListTagsForResource.go +++ b/service/efs/api_op_ListTagsForResource.go @@ -12,8 +12,10 @@ import ( ) // Lists all tags for a top-level EFS resource. You must provide the ID of the -// resource that you want to retrieve the tags for. This operation requires -// permissions for the elasticfilesystem:DescribeAccessPoints action. +// resource that you want to retrieve the tags for. +// +// This operation requires permissions for the +// elasticfilesystem:DescribeAccessPoints action. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/efs/api_op_ModifyMountTargetSecurityGroups.go b/service/efs/api_op_ModifyMountTargetSecurityGroups.go index 1472c2921cb..2a938142cb7 100644 --- a/service/efs/api_op_ModifyMountTargetSecurityGroups.go +++ b/service/efs/api_op_ModifyMountTargetSecurityGroups.go @@ -10,16 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// following actions: +// 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 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 following actions: +// // - 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) { diff --git a/service/efs/api_op_PutAccountPreferences.go b/service/efs/api_op_PutAccountPreferences.go index aee8bbf506d..28b547af789 100644 --- a/service/efs/api_op_PutAccountPreferences.go +++ b/service/efs/api_op_PutAccountPreferences.go @@ -16,11 +16,14 @@ 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]. +// +// 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. +// +// [Managing Amazon EFS resource IDs]: https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html func (c *Client) PutAccountPreferences(ctx context.Context, params *PutAccountPreferencesInput, optFns ...func(*Options)) (*PutAccountPreferencesOutput, error) { if params == nil { params = &PutAccountPreferencesInput{} @@ -40,10 +43,11 @@ 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. + // 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. // // This member is required. ResourceIdType types.ResourceIdType diff --git a/service/efs/api_op_PutFileSystemPolicy.go b/service/efs/api_op_PutFileSystemPolicy.go index c77d30601cf..446625fa6cc 100644 --- a/service/efs/api_op_PutFileSystemPolicy.go +++ b/service/efs/api_op_PutFileSystemPolicy.go @@ -16,9 +16,14 @@ 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]. +// +// EFS file system policies have a 20,000 character limit. +// +// This operation requires permissions for the +// elasticfilesystem:PutFileSystemPolicy action. +// +// [Default EFS File System Policy]: https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy func (c *Client) PutFileSystemPolicy(ctx context.Context, params *PutFileSystemPolicyInput, optFns ...func(*Options)) (*PutFileSystemPolicyOutput, error) { if params == nil { params = &PutFileSystemPolicyInput{} @@ -44,9 +49,9 @@ 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) - // . + // more about the elements that make up a file system policy, see [EFS Resource-based Policies]. + // + // [EFS 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 diff --git a/service/efs/api_op_PutLifecycleConfiguration.go b/service/efs/api_op_PutLifecycleConfiguration.go index f259ad4f9c0..0ccb571073d 100644 --- a/service/efs/api_op_PutLifecycleConfiguration.go +++ b/service/efs/api_op_PutLifecycleConfiguration.go @@ -19,36 +19,49 @@ import ( // // - TransitionToArchive – When to move files in the file system from their // current storage class (either IA or Standard storage) into the Archive storage. -// File systems cannot transition into Archive storage before transitioning into IA -// storage. Therefore, TransitionToArchive must either not be set or must be later -// than TransitionToIA. The Archive storage class is available only for file -// systems that use the Elastic Throughput mode and the General Purpose Performance -// mode. -// -// - TransitionToPrimaryStorageClass – Whether to move files in the file system -// back to primary storage (Standard storage class) after they are accessed in IA -// or Archive storage. -// -// For more information, see Managing file system storage (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 +// +// File systems cannot transition into Archive storage before transitioning into +// +// IA storage. Therefore, TransitionToArchive must either not be set or must be +// later than TransitionToIA. +// +// The Archive storage class is available only for file systems that use the +// +// Elastic Throughput mode and the General Purpose Performance mode. +// +// - TransitionToPrimaryStorageClass – Whether to move files in the file system +// back to primary storage (Standard storage class) after they are accessed in IA +// or Archive storage. +// +// For more information, see [Managing file system storage]. +// +// 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 . In the request, specify the following: +// // - The ID for the file system for which you are enabling, disabling, or // modifying Lifecycle management. +// // - A LifecyclePolicies array of LifecyclePolicy objects that define when to // move files to IA storage, to Archive storage, and back to primary 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. +// +// 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 -// LifecycleConfiguration object to an encrypted file system, you need the same Key -// Management Service permissions as when you created the encrypted file system. +// elasticfilesystem:PutLifecycleConfiguration operation. +// +// To apply a LifecycleConfiguration object to an encrypted file system, you need +// the same Key Management Service permissions as when you created the encrypted +// file system. +// +// [Managing file system storage]: https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html func (c *Client) PutLifecycleConfiguration(ctx context.Context, params *PutLifecycleConfigurationInput, optFns ...func(*Options)) (*PutLifecycleConfigurationOutput, error) { if params == nil { params = &PutLifecycleConfigurationInput{} @@ -75,18 +88,24 @@ type PutLifecycleConfigurationInput struct { // An array of LifecyclePolicy objects that define the file system's // LifecycleConfiguration object. A LifecycleConfiguration object informs EFS // Lifecycle management of the following: + // // - TransitionToIA – When to move files in the file system from primary storage // (Standard storage class) into the Infrequent Access (IA) storage. + // // - TransitionToArchive – When to move files in the file system from their // current storage class (either IA or Standard storage) into the Archive storage. - // File systems cannot transition into Archive storage before transitioning into IA - // storage. Therefore, TransitionToArchive must either not be set or must be later - // than TransitionToIA. The Archive storage class is available only for file - // systems that use the Elastic Throughput mode and the General Purpose Performance - // mode. + // + // File systems cannot transition into Archive storage before transitioning into + // IA storage. Therefore, TransitionToArchive must either not be set or must be + // later than TransitionToIA. + // + // The Archive storage class is available only for file systems that use the + // Elastic Throughput mode and the General Purpose Performance mode. + // // - TransitionToPrimaryStorageClass – Whether to move files in the file system // back to primary storage (Standard storage class) after they are accessed in IA // or Archive 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 diff --git a/service/efs/api_op_TagResource.go b/service/efs/api_op_TagResource.go index 0413cefedd7..7c8dbdd4060 100644 --- a/service/efs/api_op_TagResource.go +++ b/service/efs/api_op_TagResource.go @@ -12,8 +12,10 @@ import ( ) // Creates a tag for an EFS resource. You can create tags for EFS file systems and -// access points using this API operation. This operation requires permissions for -// the elasticfilesystem:TagResource action. +// access points using this API operation. +// +// This operation requires permissions for the elasticfilesystem: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/efs/api_op_UntagResource.go b/service/efs/api_op_UntagResource.go index c1ee17c9232..db2ec23c9df 100644 --- a/service/efs/api_op_UntagResource.go +++ b/service/efs/api_op_UntagResource.go @@ -11,8 +11,10 @@ import ( ) // 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. +// 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 36d853fe311..3ceaaa9ed19 100644 --- a/service/efs/api_op_UpdateFileSystem.go +++ b/service/efs/api_op_UpdateFileSystem.go @@ -40,9 +40,9 @@ type UpdateFileSystemInput struct { // want to provision for a file system that you're creating. Required if // ThroughputMode is set to provisioned . Valid values are 1-3414 MiBps, with the // upper limit depending on Region. 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. + // Services Support. For more information, see [Amazon EFS quotas that you can increase]in the Amazon EFS User Guide. + // + // [Amazon EFS quotas that you can increase]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits ProvisionedThroughputInMibps *float64 // (Optional) Updates the file system's throughput mode. If you're not updating @@ -79,7 +79,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 @@ -119,9 +119,10 @@ type UpdateFileSystemOutput struct { AvailabilityZoneId *string // Describes the Amazon Web Services Availability Zone in which the file system is - // located, and is valid only for One Zone file systems. For more information, see - // Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // located, and is valid only for One Zone file systems. For more information, see [Using EFS storage classes] // in the Amazon EFS User Guide. + // + // [Using EFS storage classes]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html AvailabilityZoneName *string // A Boolean value that, if true, indicates that the file system is encrypted. @@ -140,17 +141,18 @@ 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 MiBps, for the file system. // 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] in the + // Amazon EFS User Guide. + // + // [Throughput modes]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes ThroughputMode types.ThroughputMode // Metadata pertaining to the operation's result. diff --git a/service/efs/api_op_UpdateFileSystemProtection.go b/service/efs/api_op_UpdateFileSystemProtection.go index 038e8a0b2ed..d39d31baaa7 100644 --- a/service/efs/api_op_UpdateFileSystemProtection.go +++ b/service/efs/api_op_UpdateFileSystemProtection.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates protection on the file system. This operation requires permissions for -// the elasticfilesystem:UpdateFileSystemProtection action. +// Updates protection on the file system. +// +// This operation requires permissions for the +// elasticfilesystem:UpdateFileSystemProtection action. func (c *Client) UpdateFileSystemProtection(ctx context.Context, params *UpdateFileSystemProtectionInput, optFns ...func(*Options)) (*UpdateFileSystemProtectionOutput, error) { if params == nil { params = &UpdateFileSystemProtectionInput{} @@ -36,15 +38,19 @@ type UpdateFileSystemProtectionInput struct { FileSystemId *string // The status of the file system's replication overwrite protection. + // // - ENABLED – The file system cannot be used as the destination file system in a // replication configuration. The file system is writeable. Replication overwrite // protection is ENABLED by default. + // // - DISABLED – The file system can be used as the destination file system in a // replication configuration. The file system is read-only and can only be modified // by EFS replication. + // // - REPLICATING – The file system is being used as the destination file system // in a replication configuration. The file system is read-only and is only // modified only by EFS replication. + // // If the replication configuration is deleted, the file system's replication // overwrite protection is re-enabled, the file system becomes writeable. ReplicationOverwriteProtection types.ReplicationOverwriteProtection @@ -56,15 +62,19 @@ type UpdateFileSystemProtectionInput struct { type UpdateFileSystemProtectionOutput struct { // The status of the file system's replication overwrite protection. + // // - ENABLED – The file system cannot be used as the destination file system in a // replication configuration. The file system is writeable. Replication overwrite // protection is ENABLED by default. + // // - DISABLED – The file system can be used as the destination file system in a // replication configuration. The file system is read-only and can only be modified // by EFS replication. + // // - REPLICATING – The file system is being used as the destination file system // in a replication configuration. The file system is read-only and is only // modified only by EFS replication. + // // If the replication configuration is deleted, the file system's replication // overwrite protection is re-enabled, the file system becomes writeable. ReplicationOverwriteProtection types.ReplicationOverwriteProtection diff --git a/service/efs/doc.go b/service/efs/doc.go index a216593a637..418ae65f88f 100644 --- a/service/efs/doc.go +++ b/service/efs/doc.go @@ -3,12 +3,14 @@ // Package efs provides the API client, operations, and parameter types for Amazon // Elastic File System. // -// Amazon Elastic File System Amazon Elastic File System (Amazon EFS) provides -// simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in -// 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) -// . +// # Amazon Elastic File System +// +// Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage +// for use with Amazon EC2 Linux and Mac instances in 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]and the [Amazon Elastic File System User Guide]. +// +// [Amazon Elastic File System User Guide]: https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html +// [Amazon Elastic File System API Reference]: https://docs.aws.amazon.com/efs/latest/ug/api-reference.html package efs diff --git a/service/efs/options.go b/service/efs/options.go index 069a24e4a55..bedaadf164e 100644 --- a/service/efs/options.go +++ b/service/efs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/efs/types/enums.go b/service/efs/types/enums.go index 2601494bde3..03e8198b71f 100644 --- a/service/efs/types/enums.go +++ b/service/efs/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for LifeCycleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifeCycleState) Values() []LifeCycleState { return []LifeCycleState{ "creating", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for PerformanceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PerformanceMode) Values() []PerformanceMode { return []PerformanceMode{ "generalPurpose", @@ -57,8 +59,9 @@ const ( // Values returns all known values for ReplicationOverwriteProtection. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationOverwriteProtection) Values() []ReplicationOverwriteProtection { return []ReplicationOverwriteProtection{ "ENABLED", @@ -80,8 +83,9 @@ const ( ) // Values returns all known values for ReplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStatus) Values() []ReplicationStatus { return []ReplicationStatus{ "ENABLED", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for Resource. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Resource) Values() []Resource { return []Resource{ "FILE_SYSTEM", @@ -120,8 +125,9 @@ const ( ) // Values returns all known values for ResourceIdType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceIdType) Values() []ResourceIdType { return []ResourceIdType{ "LONG_ID", @@ -140,8 +146,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "ENABLED", @@ -161,8 +168,9 @@ const ( ) // Values returns all known values for ThroughputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThroughputMode) Values() []ThroughputMode { return []ThroughputMode{ "bursting", @@ -188,6 +196,7 @@ const ( // Values returns all known values for TransitionToArchiveRules. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TransitionToArchiveRules) Values() []TransitionToArchiveRules { return []TransitionToArchiveRules{ @@ -219,8 +228,9 @@ const ( ) // Values returns all known values for TransitionToIARules. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitionToIARules) Values() []TransitionToIARules { return []TransitionToIARules{ "AFTER_7_DAYS", @@ -244,8 +254,9 @@ const ( // Values returns all known values for TransitionToPrimaryStorageClassRules. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitionToPrimaryStorageClassRules) Values() []TransitionToPrimaryStorageClassRules { return []TransitionToPrimaryStorageClassRules{ "AFTER_1_ACCESS", diff --git a/service/efs/types/errors.go b/service/efs/types/errors.go index 4df6d07fd80..e2d37aa6694 100644 --- a/service/efs/types/errors.go +++ b/service/efs/types/errors.go @@ -38,9 +38,9 @@ func (e *AccessPointAlreadyExists) ErrorCode() string { func (e *AccessPointAlreadyExists) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// . +// 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 type AccessPointLimitExceeded struct { Message *string @@ -99,8 +99,9 @@ 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]. +// +// [Regional and One Zone storage redundancy]: https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html type AvailabilityZonesMismatch struct { Message *string @@ -566,10 +567,11 @@ func (e *MountTargetNotFound) ErrorFault() smithy.ErrorFault { return smithy.Fau // 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 +// or request that the account quota be raised. For more information, see [Amazon VPC Quotas]in the +// Amazon VPC User Guide (see the Network interfaces per Region entry in the // Network interfaces table). +// +// [Amazon VPC Quotas]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html type NetworkInterfaceLimitExceeded struct { Message *string @@ -798,8 +800,9 @@ 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]. +// +// [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 80781709dd5..2c60c22c255 100644 --- a/service/efs/types/types.go +++ b/service/efs/types/types.go @@ -48,14 +48,19 @@ type AccessPointDescription struct { // 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) -// . +// up. For more information, see [Automatic backups]. +// +// [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. // // This member is required. @@ -68,13 +73,15 @@ type BackupPolicy struct { // 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 -// 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 fail. If you do not provide -// CreationInfo and the specified RootDirectory does not exist, attempts to mount -// the file system using the access point will fail. +// 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, attempts to mount using the access point will fail. +// +// If you do not provide CreationInfo and the specified RootDirectory does not +// exist, attempts to mount 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 @@ -112,19 +119,22 @@ type Destination struct { Region *string // Describes the status of the destination EFS file system. + // // - The Paused state occurs as a result of opting out of the source or // destination Region after the replication configuration was created. To resume // replication for the file system, you need to again opt in to the Amazon Web - // Services Region. For more information, see Managing Amazon Web Services - // Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) - // in the Amazon Web Services General Reference Guide. + // Services Region. For more information, see [Managing Amazon Web Services Regions]in the Amazon Web Services General + // Reference Guide. + // // - The Error state occurs when either the source or the destination file system - // (or both) is in a failed state and is unrecoverable. For more information, see - // Monitoring replication status (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) + // (or both) is in a failed state and is unrecoverable. For more information, see [Monitoring replication status] // in the Amazon EFS User Guide. You must delete the replication configuration, and // then restore the most recent backup of the failed file system (either the source // or the destination) to a new file system. // + // [Managing Amazon Web Services Regions]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable + // [Monitoring replication status]: https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html + // // This member is required. Status ReplicationStatus @@ -155,12 +165,16 @@ type DestinationToCreate struct { // 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 // 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 . KmsKeyId *string @@ -197,7 +211,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,9 +251,10 @@ type FileSystemDescription struct { AvailabilityZoneId *string // Describes the Amazon Web Services Availability Zone in which the file system is - // located, and is valid only for One Zone file systems. For more information, see - // Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) + // located, and is valid only for One Zone file systems. For more information, see [Using EFS storage classes] // in the Amazon EFS User Guide. + // + // [Using EFS storage classes]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html AvailabilityZoneName *string // A Boolean value that, if true, indicates that the file system is encrypted. @@ -258,17 +273,18 @@ 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 MiBps, for the file system. // 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] in the + // Amazon EFS User Guide. + // + // [Throughput modes]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes ThroughputMode ThroughputMode noSmithyDocumentSerde @@ -278,15 +294,19 @@ type FileSystemDescription struct { type FileSystemProtectionDescription struct { // The status of the file system's replication overwrite protection. + // // - ENABLED – The file system cannot be used as the destination file system in a // replication configuration. The file system is writeable. Replication overwrite // protection is ENABLED by default. + // // - DISABLED – The file system can be used as the destination file system in a // replication configuration. The file system is read-only and can only be modified // by EFS replication. + // // - REPLICATING – The file system is being used as the destination file system // in a replication configuration. The file system is read-only and is only // modified only by EFS replication. + // // If the replication configuration is deleted, the file system's replication // overwrite protection is re-enabled, the file system becomes writeable. ReplicationOverwriteProtection ReplicationOverwriteProtection @@ -329,14 +349,16 @@ type FileSystemSize struct { } // Describes a policy used by Lifecycle management that specifies when to -// transition files into and out of storage classes. For more information, see -// Managing file system storage (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html) -// . When using the put-lifecycle-configuration CLI command or the +// transition files into and out of storage classes. For more information, see [Managing file system 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. For more information, -// see the request examples in PutLifecycleConfiguration . +// see the request examples in PutLifecycleConfiguration. +// +// [Managing file system storage]: https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html type LifecyclePolicy struct { // The number of days after files were last accessed in primary storage (the @@ -496,9 +518,10 @@ type RootDirectory struct { // 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. + // 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. CreationInfo *CreationInfo // Specifies the path on the EFS file system to expose as the root directory to diff --git a/service/eks/api_op_AssociateAccessPolicy.go b/service/eks/api_op_AssociateAccessPolicy.go index 7a2808e365e..ad7ccf5cef4 100644 --- a/service/eks/api_op_AssociateAccessPolicy.go +++ b/service/eks/api_op_AssociateAccessPolicy.go @@ -12,9 +12,9 @@ import ( ) // Associates an access policy and its scope to an access entry. For more -// information about associating access policies, see Associating and -// disassociating access policies to and from access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html) -// in the Amazon EKS User Guide. +// information about associating access policies, see [Associating and disassociating access policies to and from access entries]in the Amazon EKS User Guide. +// +// [Associating and disassociating access policies to and from access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html func (c *Client) AssociateAccessPolicy(ctx context.Context, params *AssociateAccessPolicyInput, optFns ...func(*Options)) (*AssociateAccessPolicyOutput, error) { if params == nil { params = &AssociateAccessPolicyInput{} diff --git a/service/eks/api_op_AssociateEncryptionConfig.go b/service/eks/api_op_AssociateEncryptionConfig.go index 31870d9965a..0cbfab95909 100644 --- a/service/eks/api_op_AssociateEncryptionConfig.go +++ b/service/eks/api_op_AssociateEncryptionConfig.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates an encryption configuration to an existing cluster. Use this API to -// enable encryption on existing clusters that don't already have encryption -// enabled. This allows you to implement a defense-in-depth security strategy -// without migrating applications to new Amazon EKS clusters. +// Associates an encryption configuration to an existing cluster. +// +// Use this API to enable encryption on existing clusters that don't already have +// encryption enabled. This allows you to implement a defense-in-depth security +// strategy without migrating applications to new Amazon EKS clusters. func (c *Client) AssociateEncryptionConfig(ctx context.Context, params *AssociateEncryptionConfigInput, optFns ...func(*Options)) (*AssociateEncryptionConfigOutput, error) { if params == nil { params = &AssociateEncryptionConfigInput{} diff --git a/service/eks/api_op_AssociateIdentityProviderConfig.go b/service/eks/api_op_AssociateIdentityProviderConfig.go index c2a5d7cd126..7fc48faae08 100644 --- a/service/eks/api_op_AssociateIdentityProviderConfig.go +++ b/service/eks/api_op_AssociateIdentityProviderConfig.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates an identity provider configuration to a cluster. If you want to -// authenticate identities using an identity provider, you can create an identity -// provider configuration and associate it to your cluster. After configuring -// authentication to your cluster you can create Kubernetes Role and ClusterRole -// objects, assign permissions to them, and then bind them to the identities using -// Kubernetes RoleBinding and ClusterRoleBinding objects. For more information see -// Using RBAC Authorization (https://kubernetes.io/docs/reference/access-authn-authz/rbac/) -// in the Kubernetes documentation. +// Associates an identity provider configuration to a cluster. +// +// If you want to authenticate identities using an identity provider, you can +// create an identity provider configuration and associate it to your cluster. +// After configuring authentication to your cluster you can create Kubernetes Role +// and ClusterRole objects, assign permissions to them, and then bind them to the +// identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For +// more information see [Using RBAC Authorization]in the Kubernetes documentation. +// +// [Using RBAC Authorization]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ 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_CreateAccessEntry.go b/service/eks/api_op_CreateAccessEntry.go index 1201ef38022..8e9347cb881 100644 --- a/service/eks/api_op_CreateAccessEntry.go +++ b/service/eks/api_op_CreateAccessEntry.go @@ -11,18 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an access entry. An access entry allows an IAM principal to access your -// cluster. Access entries can replace the need to maintain entries in the aws-auth -// ConfigMap for authentication. You have the following options for authorizing an -// IAM principal to access Kubernetes objects on your cluster: Kubernetes -// role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC -// authorization requires you to create and manage Kubernetes Role , ClusterRole , -// RoleBinding , and ClusterRoleBinding objects, in addition to managing access -// entries. If you use Amazon EKS authorization exclusively, you don't need to -// create and manage Kubernetes Role , ClusterRole , RoleBinding , and -// ClusterRoleBinding objects. For more information about access entries, see -// Access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) -// in the Amazon EKS User Guide. +// Creates an access entry. +// +// An access entry allows an IAM principal to access your cluster. Access entries +// can replace the need to maintain entries in the aws-auth ConfigMap for +// authentication. You have the following options for authorizing an IAM principal +// to access Kubernetes objects on your cluster: Kubernetes role-based access +// control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization requires you +// to create and manage Kubernetes Role , ClusterRole , RoleBinding , and +// ClusterRoleBinding objects, in addition to managing access entries. If you use +// Amazon EKS authorization exclusively, you don't need to create and manage +// Kubernetes Role , ClusterRole , RoleBinding , and ClusterRoleBinding objects. +// +// For more information about access entries, see [Access entries] in the Amazon EKS User Guide. +// +// [Access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html func (c *Client) CreateAccessEntry(ctx context.Context, params *CreateAccessEntryInput, optFns ...func(*Options)) (*CreateAccessEntryOutput, error) { if params == nil { params = &CreateAccessEntryInput{} @@ -47,15 +50,19 @@ type CreateAccessEntryInput struct { // The ARN of the IAM principal for the AccessEntry . You can specify one ARN for // each access entry. You can't specify the same ARN in more than one access entry. - // This value can't be changed after access entry creation. The valid principals - // differ depending on the type of the access entry in the type field. The only - // valid ARN is IAM roles for the types of access entries for nodes: . You can use - // every IAM principal type for STANDARD access entries. You can't use the STS - // session principal type with access entries because this is a temporary principal - // for each session and not a permanent identity that can be assigned permissions. - // IAM best practices (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp) - // recommend using IAM roles with temporary credentials, rather than IAM users with - // long-term credentials. + // This value can't be changed after access entry creation. + // + // The valid principals differ depending on the type of the access entry in the + // type field. The only valid ARN is IAM roles for the types of access entries for + // nodes: . You can use every IAM principal type for STANDARD access entries. You + // can't use the STS session principal type with access entries because this is a + // temporary principal for each session and not a permanent identity that can be + // assigned permissions. + // + // [IAM best practices]recommend using IAM roles with temporary credentials, rather than IAM users + // with long-term credentials. + // + // [IAM best practices]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp // // This member is required. PrincipalArn *string @@ -67,18 +74,22 @@ type CreateAccessEntryInput struct { // The value for name that you've specified for kind: Group as a subject in a // Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't confirm // that the value for name exists in any bindings on your cluster. You can specify - // one or more names. Kubernetes authorizes the principalArn of the access entry - // to access any cluster objects that you've specified in a Kubernetes Role or - // ClusterRole object that is also specified in a binding's roleRef . For more - // information about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , - // or ClusterRole objects, see Using RBAC Authorization in the Kubernetes - // documentation (https://kubernetes.io/docs/reference/access-authn-authz/rbac/) . + // one or more names. + // + // Kubernetes authorizes the principalArn of the access entry to access any + // cluster objects that you've specified in a Kubernetes Role or ClusterRole + // object that is also specified in a binding's roleRef . For more information + // about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , or + // ClusterRole objects, see [Using RBAC Authorization in the Kubernetes documentation]. + // // If you want Amazon EKS to authorize the principalArn (instead of, or in // addition to Kubernetes authorizing the principalArn ), you can associate one or // more access policies to the access entry using AssociateAccessPolicy . If you // associate any access policies, the principalARN has all permissions assigned in // the associated access policies and all permissions in any Kubernetes Role or // ClusterRole objects that the group names are bound to. + // + // [Using RBAC Authorization in the Kubernetes documentation]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ KubernetesGroups []string // Metadata that assists with categorization and organization. Each tag consists @@ -87,23 +98,27 @@ type CreateAccessEntryInput struct { Tags map[string]string // The type of the new access entry. Valid values are Standard , FARGATE_LINUX , - // EC2_LINUX , and EC2_WINDOWS . If the principalArn is for an IAM role that's - // used for self-managed Amazon EC2 nodes, specify EC2_LINUX or EC2_WINDOWS . - // Amazon EKS grants the necessary permissions to the node for you. If the - // principalArn is for any other purpose, specify STANDARD . If you don't specify a - // value, Amazon EKS sets the value to STANDARD . It's unnecessary to create access - // entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, - // because Amazon EKS creates entries in the aws-auth ConfigMap for the roles. You - // can't change this value once you've created the access entry. If you set the - // value to EC2_LINUX or EC2_WINDOWS , you can't specify values for + // EC2_LINUX , and EC2_WINDOWS . + // + // If the principalArn is for an IAM role that's used for self-managed Amazon EC2 + // nodes, specify EC2_LINUX or EC2_WINDOWS . Amazon EKS grants the necessary + // permissions to the node for you. If the principalArn is for any other purpose, + // specify STANDARD . If you don't specify a value, Amazon EKS sets the value to + // STANDARD . It's unnecessary to create access entries for IAM roles used with + // Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries + // in the aws-auth ConfigMap for the roles. You can't change this value once + // you've created the access entry. + // + // If you set the value to EC2_LINUX or EC2_WINDOWS , you can't specify values for // kubernetesGroups , or associate an AccessPolicy to the access entry. Type *string // The username to authenticate to Kubernetes with. We recommend not specifying a // username and letting Amazon EKS specify it for you. For more information about // the value Amazon EKS specifies for you, or constraints before specifying your - // own username, see Creating access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries) - // in the Amazon EKS User Guide. + // own username, see [Creating access entries]in the Amazon EKS User Guide. + // + // [Creating access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries Username *string noSmithyDocumentSerde @@ -113,8 +128,10 @@ type CreateAccessEntryOutput struct { // An access entry allows an IAM principal (user or role) to access your cluster. // Access entries can replace the need to maintain the aws-auth ConfigMap for - // authentication. For more information about access entries, see Access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) - // in the Amazon EKS User Guide. + // authentication. For more information about access entries, see [Access entries]in the Amazon + // EKS User Guide. + // + // [Access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html AccessEntry *types.AccessEntry // Metadata pertaining to the operation's result. diff --git a/service/eks/api_op_CreateAddon.go b/service/eks/api_op_CreateAddon.go index 11538081804..896d00bf108 100644 --- a/service/eks/api_op_CreateAddon.go +++ b/service/eks/api_op_CreateAddon.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Amazon EKS User Guide. +// +// [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html func (c *Client) CreateAddon(ctx context.Context, params *CreateAddonInput, optFns ...func(*Options)) (*CreateAddonOutput, error) { if params == nil { params = &CreateAddonInput{} @@ -44,8 +47,9 @@ 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]DescribeAddonVersions . + // + // [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 @@ -59,32 +63,39 @@ type CreateAddonInput struct { // 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. // // - 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 – This is similar to the NONE option. If the self-managed version // of the add-on is installed on your cluster Amazon EKS doesn't change the add-on // resource properties. Creation of the add-on might fail if conflicts are // detected. This option works differently during the update operation. For more - // information, see UpdateAddon (https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) - // . + // information, see [UpdateAddon]. + // // 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. + // + // [UpdateAddon]: https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html 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) - // in the Amazon EKS User Guide. + // permissions assigned to the node IAM role. For more information, see [Amazon EKS node IAM role]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]in the Amazon EKS + // User Guide. + // + // [Enabling IAM roles for service accounts on your cluster]: https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html + // [Amazon EKS node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html ServiceAccountRoleArn *string // Metadata that assists with categorization and organization. Each tag consists @@ -97,8 +108,9 @@ 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] in the Amazon EKS User Guide. + // + // [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html 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 e1d02fe8d18..5809c415424 100644 --- a/service/eks/api_op_CreateCluster.go +++ b/service/eks/api_op_CreateCluster.go @@ -11,36 +11,47 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon EKS control plane. The Amazon EKS control plane consists of -// control plane instances that run the Kubernetes software, such as etcd and the -// API server. The control plane runs in an account managed by Amazon Web Services, -// and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each -// Amazon EKS cluster control plane is single tenant and unique. It runs on its own -// set of Amazon EC2 instances. The cluster control plane is provisioned across -// 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 -// control plane over the Kubernetes API server endpoint and a certificate file -// that is created for your cluster. You can use the endpointPublicAccess and -// endpointPrivateAccess parameters 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 use the logging parameter 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/) . 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. +// Creates an Amazon EKS control plane. +// +// The Amazon EKS control plane consists of control plane instances that run the +// Kubernetes software, such as etcd and the API server. The control plane runs in +// an account managed by Amazon Web Services, and the Kubernetes API is exposed by +// the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is +// single tenant and unique. It runs on its own set of Amazon EC2 instances. +// +// The cluster control plane is provisioned across 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 control plane over the Kubernetes API server endpoint and a +// certificate file that is created for your cluster. +// +// You can use the endpointPublicAccess and endpointPrivateAccess parameters 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]in the Amazon EKS User Guide . +// +// You can use the logging parameter 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]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]. +// +// 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]and [Launching Amazon EKS nodes] in the Amazon EKS User Guide. +// +// [CloudWatch Pricing]: http://aws.amazon.com/cloudwatch/pricing/ +// [Amazon EKS Cluster Control Plane Logs]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html +// [Amazon EKS Cluster Endpoint Access Control]: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html +// [Managing Cluster Authentication]: https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html +// [Launching Amazon EKS nodes]: https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -65,19 +76,21 @@ 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]and [Cluster Security Group Considerations] 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. + // + // [Cluster Security Group Considerations]: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html + // [Cluster VPC Considerations]: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html // // 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 . + // on your behalf. For more information, see [Amazon EKS Service IAM Role]in the Amazon EKS User Guide . + // + // [Amazon EKS Service IAM Role]: https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html // // This member is required. RoleArn *string @@ -97,17 +110,21 @@ 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]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]. + // + // [Amazon EKS Cluster control plane logs]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html + // [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) - // in the Amazon EKS User Guide. This object isn't available for creating Amazon - // EKS clusters on the Amazon Web Services cloud. + // review [Local clusters for Amazon EKS on Amazon Web Services Outposts]in the Amazon EKS User Guide. This object isn't available for creating + // Amazon EKS clusters on the Amazon Web Services cloud. + // + // [Local clusters for Amazon EKS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html OutpostConfig *types.OutpostConfigRequest // Metadata that assists with categorization and organization. Each tag consists @@ -116,8 +133,9 @@ type CreateClusterInput struct { Tags map[string]string // The desired Kubernetes version for your cluster. If you don't specify a value - // here, the default version available in Amazon EKS is used. The default version - // might not be the latest version available. + // here, the default version available in Amazon EKS is used. + // + // The default version might not be the latest version available. Version *string noSmithyDocumentSerde diff --git a/service/eks/api_op_CreateFargateProfile.go b/service/eks/api_op_CreateFargateProfile.go index 97b68902777..edb21d258f9 100644 --- a/service/eks/api_op_CreateFargateProfile.go +++ b/service/eks/api_op_CreateFargateProfile.go @@ -12,29 +12,38 @@ import ( ) // Creates an Fargate profile for your Amazon EKS cluster. You must have at least -// one Fargate profile in a cluster to be able to run pods on Fargate. The Fargate -// profile allows an administrator to declare which pods run on Fargate and specify -// which pods run on which Fargate profile. This declaration is done through the -// profile’s selectors. Each profile can have up to five selectors that contain a -// namespace and labels. A namespace is required for every selector. The label -// field consists of multiple optional key-value pairs. Pods that match the -// selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the -// 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/reference/access-authn-authz/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. +// one Fargate profile in a cluster to be able to run pods on Fargate. +// +// The Fargate profile allows an administrator to declare which pods run on +// Fargate and specify which pods run on which Fargate profile. This declaration is +// done through the profile’s selectors. Each profile can have up to five selectors +// that contain a namespace and labels. A namespace is required for every selector. +// The label field consists of multiple optional key-value pairs. Pods that match +// the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of +// the 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](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]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] in the Amazon EKS User Guide. +// +// [Role Based Access Control]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ +// [Fargate profile]: https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html +// [Pod Execution Role]: https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html func (c *Client) CreateFargateProfile(ctx context.Context, params *CreateFargateProfileInput, optFns ...func(*Options)) (*CreateFargateProfileOutput, error) { if params == nil { params = &CreateFargateProfileInput{} @@ -65,9 +74,10 @@ type CreateFargateProfileInput struct { // The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that // matches 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. + // read access to Amazon ECR image repositories. For more information, see [Pod execution role]Pod in + // the Amazon EKS User Guide. + // + // [Pod execution role]: https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html // // This member is required. PodExecutionRoleArn *string diff --git a/service/eks/api_op_CreateNodegroup.go b/service/eks/api_op_CreateNodegroup.go index 089c4b25a50..c1004753a03 100644 --- a/service/eks/api_op_CreateNodegroup.go +++ b/service/eks/api_op_CreateNodegroup.go @@ -11,17 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a managed node group for an Amazon EKS cluster. You can only create a -// node group for your cluster that is equal to the current Kubernetes version for -// 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 +// Creates a managed node group for an Amazon EKS cluster. +// +// You can only create a node group for your cluster that is equal to the current +// Kubernetes version for 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]. +// +// 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 Amazon Web Services Regions that support Windows on Amazon EKS. +// Amazon EKS cluster. For more information, see [Managed node groups]in the Amazon EKS User Guide. +// +// Windows AMI types are only supported for commercial Amazon Web Services Regions +// that support Windows on Amazon EKS. +// +// [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +// [Managed node groups]: https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html func (c *Client) CreateNodegroup(ctx context.Context, params *CreateNodegroupInput, optFns ...func(*Options)) (*CreateNodegroupOutput, error) { if params == nil { params = &CreateNodegroupInput{} @@ -49,14 +55,14 @@ type CreateNodegroupInput struct { // Services APIs on your behalf. Nodes receive permissions for these API calls // 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) - // 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) - // in the Amazon EKS User Guide. + // nodes to use when they are launched. For more information, see [Amazon EKS node IAM role]in the Amazon + // EKS User Guide . If you specify launchTemplate , then don't specify [IamInstanceProfile] 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]in the Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html + // [IamInstanceProfile]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html + // [Amazon EKS node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html // // This member is required. NodeRole *string @@ -67,11 +73,12 @@ 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) - // 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) - // in the Amazon EKS User Guide. + // group. If you specify launchTemplate , then don't specify [SubnetId] 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]in the Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html + // [SubnetId]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html // // This member is required. Subnets []string @@ -81,8 +88,9 @@ type CreateNodegroupInput struct { // 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. + // see [Launch template support]in the Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html AmiType types.AMITypes // The capacity type for your node group. @@ -96,8 +104,9 @@ type CreateNodegroupInput struct { // 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. + // templates with Amazon EKS, see [Launch template support]in the Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html DiskSize *int32 // Specify the instance types for a node group. If you specify a GPU instance @@ -109,9 +118,10 @@ type CreateNodegroupInput struct { // 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. + // see [Managed node group capacity types]and [Launch template support] in the Amazon EKS User Guide. + // + // [Managed node group capacity types]: https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html InstanceTypes []string // The Kubernetes labels to apply to the nodes in the node group when they are @@ -126,24 +136,28 @@ type CreateNodegroupInput struct { // 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) - // 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. + // Kubernetes version is used. For information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions]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]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]in the Amazon EKS + // User Guide. + // + // [Amazon EKS optimized Amazon Linux AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html + // [Amazon EKS optimized Windows AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html 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. + // more information about using launch templates with Amazon EKS, see [Launch template support]in the + // Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html RemoteAccess *types.RemoteAccessConfig // The scaling configuration details for the Auto Scaling group that is created @@ -156,8 +170,9 @@ 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]. + // + // [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. @@ -167,9 +182,10 @@ type CreateNodegroupInput struct { // 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. + // For more information about using launch templates with Amazon EKS, see [Launch template support]in the + // Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html Version *string noSmithyDocumentSerde diff --git a/service/eks/api_op_CreatePodIdentityAssociation.go b/service/eks/api_op_CreatePodIdentityAssociation.go index 5588fd4826b..729275cdfaf 100644 --- a/service/eks/api_op_CreatePodIdentityAssociation.go +++ b/service/eks/api_op_CreatePodIdentityAssociation.go @@ -14,12 +14,16 @@ import ( // Creates an EKS Pod Identity association between a service account in an Amazon // EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give // temporary IAM credentials to pods and the credentials are rotated automatically. +// // Amazon EKS Pod Identity associations provide the ability to manage credentials // for your applications, similar to the way that Amazon EC2 instance profiles -// provide credentials to Amazon EC2 instances. If a pod uses a service account -// that has an association, Amazon EKS sets environment variables in the containers -// of the pod. The environment variables configure the Amazon Web Services SDKs, -// including the Command Line Interface, to use the EKS Pod Identity credentials. +// provide credentials to Amazon EC2 instances. +// +// If a pod uses a service account that has an association, Amazon EKS sets +// environment variables in the containers of the pod. The environment variables +// configure the Amazon Web Services SDKs, including the Command Line Interface, to +// use the EKS Pod Identity credentials. +// // Pod Identity is a simpler method than IAM roles for service accounts, as this // method doesn't use OIDC identity providers. Additionally, you can configure a // role for Pod Identity once, and reuse it across clusters. @@ -71,18 +75,26 @@ type CreatePodIdentityAssociationInput struct { // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any - // other cluster or Amazon Web Services resources. The following basic restrictions - // apply to tags: + // other cluster or Amazon Web Services resources. + // + // 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 @@ -94,9 +106,10 @@ type CreatePodIdentityAssociationInput struct { type CreatePodIdentityAssociationOutput struct { - // The full description of your new association. The description includes an ID - // for the association. Use the ID of the association in further actions to manage - // the association. + // The full description of your new association. + // + // The description includes an ID for the association. Use the ID of the + // association in further actions to manage the association. Association *types.PodIdentityAssociation // Metadata pertaining to the operation's result. diff --git a/service/eks/api_op_DeleteAccessEntry.go b/service/eks/api_op_DeleteAccessEntry.go index 7bd62433c1c..ee50b9748e3 100644 --- a/service/eks/api_op_DeleteAccessEntry.go +++ b/service/eks/api_op_DeleteAccessEntry.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an access entry. Deleting an access entry of a type other than Standard -// can cause your cluster to function improperly. If you delete an access entry in -// error, you can recreate it. +// Deletes an access entry. +// +// Deleting an access entry of a type other than Standard can cause your cluster +// to function improperly. If you delete an access entry in error, you can recreate +// it. func (c *Client) DeleteAccessEntry(ctx context.Context, params *DeleteAccessEntryInput, optFns ...func(*Options)) (*DeleteAccessEntryOutput, error) { if params == nil { params = &DeleteAccessEntryInput{} diff --git a/service/eks/api_op_DeleteAddon.go b/service/eks/api_op_DeleteAddon.go index b211d5f04b5..689e34035fc 100644 --- a/service/eks/api_op_DeleteAddon.go +++ b/service/eks/api_op_DeleteAddon.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Amazon EKS add-on. When you remove an add-on, it's deleted from the -// cluster. You can always manually start an add-on on the cluster using the -// Kubernetes API. +// Deletes an Amazon EKS add-on. +// +// When you remove an add-on, it's 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{} @@ -31,9 +32,10 @@ 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) - // . + // The name of the add-on. The name must match one of the names returned by [ListAddons] + // ListAddons . + // + // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html // // This member is required. AddonName *string @@ -53,8 +55,9 @@ 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] in the Amazon EKS User Guide. + // + // [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html 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 9aa5720e34a..1333fda49b8 100644 --- a/service/eks/api_op_DeleteCluster.go +++ b/service/eks/api_op_DeleteCluster.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Amazon EKS cluster control plane. If you have active services in -// your cluster that are associated with a load balancer, you must delete those -// services before deleting the cluster so that the load balancers are deleted -// properly. Otherwise, you can have orphaned resources in your VPC that prevent -// you from being able to delete the VPC. For more information, see Deleting a -// 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 DeleteNodgroup and DeleteFargateProfile . +// Deletes an Amazon EKS cluster control plane. +// +// If you have active services in your cluster that are associated with a load +// balancer, you must delete those services before deleting the cluster so that the +// load balancers are deleted properly. Otherwise, you can have orphaned resources +// in your VPC that prevent you from being able to delete the VPC. For more +// information, see [Deleting a cluster]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 DeleteNodgroup and +// DeleteFargateProfile . +// +// [Deleting a cluster]: https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html 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_DeleteFargateProfile.go b/service/eks/api_op_DeleteFargateProfile.go index 54c025c6040..2f1ed3744ce 100644 --- a/service/eks/api_op_DeleteFargateProfile.go +++ b/service/eks/api_op_DeleteFargateProfile.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Fargate profile. When you delete a Fargate profile, any Pod running -// on Fargate that was created with the profile is deleted. If the Pod matches -// another Fargate profile, then it is scheduled on Fargate with that profile. If -// it no longer matches any Fargate profiles, then it's not scheduled on Fargate -// and may remain in a pending state. Only one Fargate profile in a cluster can be -// in the DELETING status at a time. You must wait for a Fargate profile to finish -// deleting before you can delete any other profiles in that cluster. +// Deletes an Fargate profile. +// +// When you delete a Fargate profile, any Pod running on Fargate that was created +// with the profile is deleted. If the Pod matches another Fargate profile, then +// it is scheduled on Fargate with that profile. If it no longer matches any +// Fargate profiles, then it's not scheduled on Fargate and may remain in a pending +// state. +// +// Only one Fargate profile in a cluster can be in the DELETING status at a time. +// You must wait for a Fargate profile to finish deleting before you can delete any +// other profiles in that cluster. func (c *Client) DeleteFargateProfile(ctx context.Context, params *DeleteFargateProfileInput, optFns ...func(*Options)) (*DeleteFargateProfileOutput, error) { if params == nil { params = &DeleteFargateProfileInput{} diff --git a/service/eks/api_op_DeletePodIdentityAssociation.go b/service/eks/api_op_DeletePodIdentityAssociation.go index 1eb297d934e..cd08fcea415 100644 --- a/service/eks/api_op_DeletePodIdentityAssociation.go +++ b/service/eks/api_op_DeletePodIdentityAssociation.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a EKS Pod Identity association. The temporary Amazon Web Services -// credentials from the previous IAM role session might still be valid until the -// session expiry. If you need to immediately revoke the temporary session -// credentials, then go to the role in the IAM console. +// Deletes a EKS Pod Identity association. +// +// The temporary Amazon Web Services credentials from the previous IAM role +// session might still be valid until the session expiry. If you need to +// immediately revoke the temporary session credentials, then go to the role in the +// IAM console. func (c *Client) DeletePodIdentityAssociation(ctx context.Context, params *DeletePodIdentityAssociationInput, optFns ...func(*Options)) (*DeletePodIdentityAssociationOutput, error) { if params == nil { params = &DeletePodIdentityAssociationInput{} diff --git a/service/eks/api_op_DeregisterCluster.go b/service/eks/api_op_DeregisterCluster.go index 433ae55c993..6aa979bcf93 100644 --- a/service/eks/api_op_DeregisterCluster.go +++ b/service/eks/api_op_DeregisterCluster.go @@ -12,9 +12,11 @@ import ( ) // Deregisters a connected cluster to remove it from the Amazon EKS control plane. +// // A connected cluster is a Kubernetes cluster that you've connected to your -// control plane using the Amazon EKS Connector (https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html) -// . +// control plane using the [Amazon EKS Connector]. +// +// [Amazon EKS Connector]: https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html func (c *Client) DeregisterCluster(ctx context.Context, params *DeregisterClusterInput, optFns ...func(*Options)) (*DeregisterClusterOutput, error) { if params == nil { params = &DeregisterClusterInput{} diff --git a/service/eks/api_op_DescribeAddon.go b/service/eks/api_op_DescribeAddon.go index bc3fda7d93c..6a6a4955fd6 100644 --- a/service/eks/api_op_DescribeAddon.go +++ b/service/eks/api_op_DescribeAddon.go @@ -34,9 +34,10 @@ 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) - // . + // The name of the add-on. The name must match one of the names returned by [ListAddons] + // ListAddons . + // + // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html // // This member is required. AddonName *string @@ -51,8 +52,9 @@ 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] in the Amazon EKS User Guide. + // + // [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html Addon *types.Addon // Metadata pertaining to the operation's result. @@ -179,12 +181,13 @@ type AddonActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAddonInput, *DescribeAddonOutput, error) (bool, error) } @@ -384,12 +387,13 @@ type AddonDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAddonInput, *DescribeAddonOutput, error) (bool, error) } diff --git a/service/eks/api_op_DescribeAddonConfiguration.go b/service/eks/api_op_DescribeAddonConfiguration.go index 87e6bde59f6..5824d3d9430 100644 --- a/service/eks/api_op_DescribeAddonConfiguration.go +++ b/service/eks/api_op_DescribeAddonConfiguration.go @@ -35,8 +35,9 @@ type DescribeAddonConfigurationInput 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]DescribeAddonVersions . + // + // [DescribeAddonVersions]: https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html // // This member is required. AddonVersion *string @@ -50,8 +51,9 @@ 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]DescribeAddonVersions . + // + // [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 you provide when diff --git a/service/eks/api_op_DescribeAddonVersions.go b/service/eks/api_op_DescribeAddonVersions.go index 2b4a5efc63e..4bd3f45309c 100644 --- a/service/eks/api_op_DescribeAddonVersions.go +++ b/service/eks/api_op_DescribeAddonVersions.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) DescribeAddonVersions(ctx context.Context, params *DescribeAddonVersionsInput, optFns ...func(*Options)) (*DescribeAddonVersionsOutput, error) { if params == nil { params = &DescribeAddonVersionsInput{} @@ -31,9 +32,10 @@ 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) - // . + // The name of the add-on. The name must match one of the names returned by [ListAddons] + // ListAddons . + // + // [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. @@ -50,9 +52,10 @@ type DescribeAddonVersionsInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 // The owner of the add-on. For valid owners , don't specify a value for this @@ -79,9 +82,10 @@ type DescribeAddonVersionsOutput struct { // The nextToken value to include in a future DescribeAddonVersions request. When // the results of a DescribeAddonVersions 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. 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. + // are no more results to return. + // + // 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 9186a08077f..9bb17d07cf6 100644 --- a/service/eks/api_op_DescribeCluster.go +++ b/service/eks/api_op_DescribeCluster.go @@ -16,12 +16,16 @@ import ( "time" ) -// Describes 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 -// Creating or updating a kubeconfig file for an Amazon EKS cluster (https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) -// . The API server endpoint and certificate authority data aren't available until +// Describes 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 [Creating or updating a kubeconfig file for an Amazon EKS cluster]kubeconfig . +// +// The API server endpoint and certificate authority data aren't available until // the cluster reaches the ACTIVE state. +// +// [Creating or updating a kubeconfig file for an Amazon EKS cluster]: https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error) { if params == nil { params = &DescribeClusterInput{} @@ -177,12 +181,13 @@ type ClusterActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) } @@ -383,12 +388,13 @@ type ClusterDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) } diff --git a/service/eks/api_op_DescribeFargateProfile.go b/service/eks/api_op_DescribeFargateProfile.go index 11d453b4ce0..bc09421cd57 100644 --- a/service/eks/api_op_DescribeFargateProfile.go +++ b/service/eks/api_op_DescribeFargateProfile.go @@ -179,12 +179,13 @@ type FargateProfileActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFargateProfileInput, *DescribeFargateProfileOutput, error) (bool, error) } @@ -370,12 +371,13 @@ type FargateProfileDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFargateProfileInput, *DescribeFargateProfileOutput, error) (bool, error) } diff --git a/service/eks/api_op_DescribeNodegroup.go b/service/eks/api_op_DescribeNodegroup.go index 5c28286411c..b4fb687a7ed 100644 --- a/service/eks/api_op_DescribeNodegroup.go +++ b/service/eks/api_op_DescribeNodegroup.go @@ -177,12 +177,13 @@ type NodegroupActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNodegroupInput, *DescribeNodegroupOutput, error) (bool, error) } @@ -366,12 +367,13 @@ type NodegroupDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNodegroupInput, *DescribeNodegroupOutput, error) (bool, error) } diff --git a/service/eks/api_op_DescribePodIdentityAssociation.go b/service/eks/api_op_DescribePodIdentityAssociation.go index 02505b2093e..e81ae232a62 100644 --- a/service/eks/api_op_DescribePodIdentityAssociation.go +++ b/service/eks/api_op_DescribePodIdentityAssociation.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns descriptive information about an EKS Pod Identity association. This -// action requires the ID of the association. You can get the ID from the response -// to the CreatePodIdentityAssocation for newly created associations. Or, you can -// list the IDs for associations with ListPodIdentityAssociations and filter the -// list by namespace or service account. +// Returns descriptive information about an EKS Pod Identity association. +// +// This action requires the ID of the association. You can get the ID from the +// response to the CreatePodIdentityAssocation for newly created associations. Or, +// you can list the IDs for associations with ListPodIdentityAssociations and +// filter the list by namespace or service account. func (c *Client) DescribePodIdentityAssociation(ctx context.Context, params *DescribePodIdentityAssociationInput, optFns ...func(*Options)) (*DescribePodIdentityAssociationOutput, error) { if params == nil { params = &DescribePodIdentityAssociationInput{} diff --git a/service/eks/api_op_DescribeUpdate.go b/service/eks/api_op_DescribeUpdate.go index bb64c4ed989..c29143570ac 100644 --- a/service/eks/api_op_DescribeUpdate.go +++ b/service/eks/api_op_DescribeUpdate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an update to an Amazon EKS resource. 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. +// Describes an update to an Amazon EKS resource. +// +// 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. func (c *Client) DescribeUpdate(ctx context.Context, params *DescribeUpdateInput, optFns ...func(*Options)) (*DescribeUpdateOutput, error) { if params == nil { params = &DescribeUpdateInput{} @@ -42,9 +44,10 @@ type DescribeUpdateInput struct { // This member is required. 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. + // The name of the add-on. The name must match one of the names returned by [ListAddons] + // ListAddons . This parameter is required if the update is an add-on update. + // + // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html AddonName *string // The name of the Amazon EKS node group associated with the update. This diff --git a/service/eks/api_op_DisassociateIdentityProviderConfig.go b/service/eks/api_op_DisassociateIdentityProviderConfig.go index 1281be537e0..c033b58a982 100644 --- a/service/eks/api_op_DisassociateIdentityProviderConfig.go +++ b/service/eks/api_op_DisassociateIdentityProviderConfig.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates an identity provider configuration from a cluster. If you -// disassociate an identity provider from your cluster, users included in the -// provider can no longer access the cluster. However, you can still access the +// Disassociates an identity provider configuration from a cluster. +// +// If you disassociate an identity provider from your cluster, users included in +// the provider can no longer access the cluster. However, you can still access the // cluster with IAM principals. func (c *Client) DisassociateIdentityProviderConfig(ctx context.Context, params *DisassociateIdentityProviderConfigInput, optFns ...func(*Options)) (*DisassociateIdentityProviderConfigOutput, error) { if params == nil { diff --git a/service/eks/api_op_ListAccessEntries.go b/service/eks/api_op_ListAccessEntries.go index 910faec5b36..b1961731f0d 100644 --- a/service/eks/api_op_ListAccessEntries.go +++ b/service/eks/api_op_ListAccessEntries.go @@ -49,9 +49,10 @@ type ListAccessEntriesInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -65,9 +66,10 @@ type ListAccessEntriesOutput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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_ListAccessPolicies.go b/service/eks/api_op_ListAccessPolicies.go index a8afd697a1a..d38c2062754 100644 --- a/service/eks/api_op_ListAccessPolicies.go +++ b/service/eks/api_op_ListAccessPolicies.go @@ -40,9 +40,10 @@ type ListAccessPoliciesInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -51,16 +52,18 @@ type ListAccessPoliciesInput struct { type ListAccessPoliciesOutput struct { // The list of available access policies. You can't view the contents of an access - // policy using the API. To view the contents, see Access policy permissions (https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions) - // in the Amazon EKS User Guide. + // policy using the API. To view the contents, see [Access policy permissions]in the Amazon EKS User Guide. + // + // [Access policy permissions]: https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions AccessPolicies []types.AccessPolicy // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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_ListAddons.go b/service/eks/api_op_ListAddons.go index b9a0369073c..d35b7b08eb5 100644 --- a/service/eks/api_op_ListAddons.go +++ b/service/eks/api_op_ListAddons.go @@ -44,9 +44,10 @@ type ListAddonsInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -60,8 +61,10 @@ type ListAddonsOutput struct { // The nextToken value to include in a future ListAddons request. When the results // of a ListAddons 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. 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. + // return. + // + // 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_ListAssociatedAccessPolicies.go b/service/eks/api_op_ListAssociatedAccessPolicies.go index 5c054d27316..6f64887e7e5 100644 --- a/service/eks/api_op_ListAssociatedAccessPolicies.go +++ b/service/eks/api_op_ListAssociatedAccessPolicies.go @@ -50,9 +50,10 @@ type ListAssociatedAccessPoliciesInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -69,9 +70,10 @@ type ListAssociatedAccessPoliciesOutput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 // The ARN of the IAM principal for the AccessEntry . diff --git a/service/eks/api_op_ListClusters.go b/service/eks/api_op_ListClusters.go index 08dc8bc1aa9..03ab283d208 100644 --- a/service/eks/api_op_ListClusters.go +++ b/service/eks/api_op_ListClusters.go @@ -30,9 +30,10 @@ 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 https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html (https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html) - // connected clusters, or blank to return only Amazon EKS clusters. ' all ' must be - // in lowercase otherwise an error occurs. + // ' to return [https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html]connected clusters, or blank to return only Amazon EKS clusters. ' + // all ' must be in lowercase otherwise an error occurs. + // + // [https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html]: https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.html Include []string // The maximum number of results, returned in paginated output. You receive @@ -46,9 +47,10 @@ type ListClustersInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -63,9 +65,10 @@ type ListClustersOutput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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_ListFargateProfiles.go b/service/eks/api_op_ListFargateProfiles.go index b643ced62f7..4c7e553dee8 100644 --- a/service/eks/api_op_ListFargateProfiles.go +++ b/service/eks/api_op_ListFargateProfiles.go @@ -45,9 +45,10 @@ type ListFargateProfilesInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -61,9 +62,10 @@ type ListFargateProfilesOutput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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_ListIdentityProviderConfigs.go b/service/eks/api_op_ListIdentityProviderConfigs.go index c62006a8406..97931e123b3 100644 --- a/service/eks/api_op_ListIdentityProviderConfigs.go +++ b/service/eks/api_op_ListIdentityProviderConfigs.go @@ -45,9 +45,10 @@ type ListIdentityProviderConfigsInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -61,9 +62,10 @@ type ListIdentityProviderConfigsOutput struct { // The nextToken value to include in a future ListIdentityProviderConfigsResponse // request. When the results of a ListIdentityProviderConfigsResponse 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. 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. + // This value is null when there are no more results to return. + // + // 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_ListNodegroups.go b/service/eks/api_op_ListNodegroups.go index 85eeb3f83f4..34f4a828542 100644 --- a/service/eks/api_op_ListNodegroups.go +++ b/service/eks/api_op_ListNodegroups.go @@ -46,9 +46,10 @@ type ListNodegroupsInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 noSmithyDocumentSerde @@ -59,9 +60,10 @@ type ListNodegroupsOutput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 // A list of all of the node groups associated with the specified cluster. diff --git a/service/eks/api_op_ListPodIdentityAssociations.go b/service/eks/api_op_ListPodIdentityAssociations.go index 319282d2053..726461f1328 100644 --- a/service/eks/api_op_ListPodIdentityAssociations.go +++ b/service/eks/api_op_ListPodIdentityAssociations.go @@ -53,9 +53,10 @@ type ListPodIdentityAssociationsInput struct { // 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. 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 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 // The name of the Kubernetes service account that the associations use. @@ -67,20 +68,26 @@ type ListPodIdentityAssociationsInput struct { type ListPodIdentityAssociationsOutput struct { // The list of summarized descriptions of the associations that are in the cluster - // and match any filters that you provided. Each summary is simplified by removing - // these fields compared to the full PodIdentityAssociation : + // and match any filters that you provided. + // + // Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: + // // - The IAM role: roleArn + // // - The timestamp that the association was created at: createdAt + // // - The most recent timestamp that the association was modified at:. modifiedAt + // // - The tags on the association: tags Associations []types.PodIdentityAssociationSummary // The nextToken value to include in a future ListPodIdentityAssociations request. // When the results of a ListPodIdentityAssociations 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. 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. + // when there are no more results to return. + // + // 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_ListUpdates.go b/service/eks/api_op_ListUpdates.go index dda4842968d..5027f14947e 100644 --- a/service/eks/api_op_ListUpdates.go +++ b/service/eks/api_op_ListUpdates.go @@ -48,9 +48,10 @@ type ListUpdatesInput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 // The name of the Amazon EKS managed node group to list updates for. @@ -64,9 +65,10 @@ type ListUpdatesOutput struct { // The nextToken value returned from a previous paginated 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 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. + // value. This value is null when there are no more results to return. + // + // 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 // A list of all the updates for the specified cluster and Region. diff --git a/service/eks/api_op_RegisterCluster.go b/service/eks/api_op_RegisterCluster.go index 93d35e84803..7d5b047daf6 100644 --- a/service/eks/api_op_RegisterCluster.go +++ b/service/eks/api_op_RegisterCluster.go @@ -11,17 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Connects a Kubernetes cluster to the Amazon EKS control plane. Any Kubernetes -// 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, the connected cluster is visible to the Amazon -// EKS control plane. If the manifest isn't applied within three days, the -// connected cluster will no longer be visible and must be deregistered using +// Connects a Kubernetes cluster to the Amazon EKS control plane. +// +// Any Kubernetes 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] 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, the connected cluster is visible to +// the Amazon EKS control plane. If the manifest isn't applied within three days, +// the connected cluster will no longer be visible and must be deregistered using // DeregisterCluster . +// +// [Manifest]: https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml 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_UpdateAccessEntry.go b/service/eks/api_op_UpdateAccessEntry.go index 298dbb2226d..f8468123867 100644 --- a/service/eks/api_op_UpdateAccessEntry.go +++ b/service/eks/api_op_UpdateAccessEntry.go @@ -46,25 +46,30 @@ type UpdateAccessEntryInput struct { // The value for name that you've specified for kind: Group as a subject in a // Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn't confirm // that the value for name exists in any bindings on your cluster. You can specify - // one or more names. Kubernetes authorizes the principalArn of the access entry - // to access any cluster objects that you've specified in a Kubernetes Role or - // ClusterRole object that is also specified in a binding's roleRef . For more - // information about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , - // or ClusterRole objects, see Using RBAC Authorization in the Kubernetes - // documentation (https://kubernetes.io/docs/reference/access-authn-authz/rbac/) . + // one or more names. + // + // Kubernetes authorizes the principalArn of the access entry to access any + // cluster objects that you've specified in a Kubernetes Role or ClusterRole + // object that is also specified in a binding's roleRef . For more information + // about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , or + // ClusterRole objects, see [Using RBAC Authorization in the Kubernetes documentation]. + // // If you want Amazon EKS to authorize the principalArn (instead of, or in // addition to Kubernetes authorizing the principalArn ), you can associate one or // more access policies to the access entry using AssociateAccessPolicy . If you // associate any access policies, the principalARN has all permissions assigned in // the associated access policies and all permissions in any Kubernetes Role or // ClusterRole objects that the group names are bound to. + // + // [Using RBAC Authorization in the Kubernetes documentation]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/ KubernetesGroups []string // The username to authenticate to Kubernetes with. We recommend not specifying a // username and letting Amazon EKS specify it for you. For more information about // the value Amazon EKS specifies for you, or constraints before specifying your - // own username, see Creating access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries) - // in the Amazon EKS User Guide. + // own username, see [Creating access entries]in the Amazon EKS User Guide. + // + // [Creating access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries Username *string noSmithyDocumentSerde diff --git a/service/eks/api_op_UpdateAddon.go b/service/eks/api_op_UpdateAddon.go index 3366c23dac6..f94a12638c1 100644 --- a/service/eks/api_op_UpdateAddon.go +++ b/service/eks/api_op_UpdateAddon.go @@ -29,9 +29,10 @@ 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) - // . + // The name of the add-on. The name must match one of the names returned by [ListAddons] + // ListAddons . + // + // [ListAddons]: https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html // // This member is required. AddonName *string @@ -42,8 +43,9 @@ 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]DescribeAddonVersions . + // + // [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 @@ -58,9 +60,12 @@ type UpdateAddonInput struct { // 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. @@ -69,12 +74,15 @@ type UpdateAddonInput struct { // 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) - // in the Amazon EKS User Guide. + // permissions assigned to the node IAM role. For more information, see [Amazon EKS node IAM role]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]in the Amazon EKS + // User Guide. + // + // [Enabling IAM roles for service accounts on your cluster]: https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html + // [Amazon EKS node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html ServiceAccountRoleArn *string noSmithyDocumentSerde diff --git a/service/eks/api_op_UpdateClusterConfig.go b/service/eks/api_op_UpdateClusterConfig.go index ca8421241d0..d2b84cf4342 100644 --- a/service/eks/api_op_UpdateClusterConfig.go +++ b/service/eks/api_op_UpdateClusterConfig.go @@ -13,28 +13,37 @@ import ( // Updates an Amazon EKS cluster configuration. Your cluster continues to function // during the update. The response output includes an update ID that you can use to -// track the status of your cluster update with DescribeUpdate "/>. 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 also use this API operation to choose -// different subnets and security groups for the cluster. You must specify at least -// two subnets that are in different Availability Zones. You can't change which VPC -// the subnets are from, the subnets must be in the same VPC as the subnets that -// the cluster was created with. For more information about the VPC requirements, -// see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) -// in the Amazon EKS User Guide . 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 . +// track the status of your cluster update with DescribeUpdate "/>. +// +// 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]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]. +// +// 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]in +// the Amazon EKS User Guide . +// +// You can also use this API operation to choose different subnets and security +// groups for the cluster. You must specify at least two subnets that are in +// different Availability Zones. You can't change which VPC the subnets are from, +// the subnets must be in the same VPC as the subnets that the cluster was created +// with. For more information about the VPC requirements, see [https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html]in the Amazon EKS +// User Guide . +// +// 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 +// [CloudWatch Pricing]: http://aws.amazon.com/cloudwatch/pricing/ +// [https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html]: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html +// [Amazon EKS cluster endpoint access control]: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html func (c *Client) UpdateClusterConfig(ctx context.Context, params *UpdateClusterConfigInput, optFns ...func(*Options)) (*UpdateClusterConfigOutput, error) { if params == nil { params = &UpdateClusterConfigInput{} @@ -66,10 +75,13 @@ 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]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]. + // + // [CloudWatch Pricing]: http://aws.amazon.com/cloudwatch/pricing/ + // [Amazon EKS cluster control plane logs]: https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html 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 a62884d7fb4..d24eced9c2f 100644 --- a/service/eks/api_op_UpdateClusterVersion.go +++ b/service/eks/api_op_UpdateClusterVersion.go @@ -13,14 +13,17 @@ import ( // Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster // continues to function during the update. The response output includes an update -// ID that you can use to track the status of your cluster update with the -// 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 -// 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. +// ID that you can use to track the status of your cluster update with the DescribeUpdateAPI +// 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 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. func (c *Client) UpdateClusterVersion(ctx context.Context, params *UpdateClusterVersionInput, optFns ...func(*Options)) (*UpdateClusterVersionOutput, error) { if params == nil { params = &UpdateClusterVersionInput{} diff --git a/service/eks/api_op_UpdateNodegroupConfig.go b/service/eks/api_op_UpdateNodegroupConfig.go index 697b179685c..5ae8fd56e7a 100644 --- a/service/eks/api_op_UpdateNodegroupConfig.go +++ b/service/eks/api_op_UpdateNodegroupConfig.go @@ -13,9 +13,9 @@ import ( // Updates an Amazon EKS managed node group configuration. Your node group // continues to function during the update. The response output includes an update -// ID that you can use to track the status of your node group update with the -// DescribeUpdate API operation. Currently you can update the Kubernetes labels for -// a node group or the scaling configuration. +// ID that you can use to track the status of your node group update with the DescribeUpdateAPI +// operation. Currently you can update the Kubernetes labels for a node group or +// the scaling configuration. func (c *Client) UpdateNodegroupConfig(ctx context.Context, params *UpdateNodegroupConfigInput, optFns ...func(*Options)) (*UpdateNodegroupConfigOutput, error) { if params == nil { params = &UpdateNodegroupConfigInput{} @@ -54,8 +54,9 @@ 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]. + // + // [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 037814aa273..01a47f13253 100644 --- a/service/eks/api_op_UpdateNodegroupVersion.go +++ b/service/eks/api_op_UpdateNodegroupVersion.go @@ -12,25 +12,33 @@ import ( ) // Updates the Kubernetes version or AMI version of an Amazon EKS managed node -// group. You can update a node group using a launch template only if the node -// group was originally deployed with a launch template. If you need to update a -// custom AMI in a node group that was deployed with a launch template, then update -// your custom AMI, specify the new ID in a new version of the launch template, and -// then update the node group to the new version of the launch template. If you -// update without a launch template, then you can update to the latest available -// AMI version of a node group's current Kubernetes version by not specifying a -// 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) -// 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, every Pod on that node is drained -// first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is -// unable to do so. You can force the update if Amazon EKS is unable to drain the -// nodes as a result of a Pod disruption budget issue. +// group. +// +// You can update a node group using a launch template only if the node group was +// originally deployed with a launch template. If you need to update a custom AMI +// in a node group that was deployed with a launch template, then update your +// custom AMI, specify the new ID in a new version of the launch template, and then +// update the node group to the new version of the launch template. +// +// If you update without a launch template, then you can update to the latest +// available AMI version of a node group's current Kubernetes version by not +// specifying a 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]in the Amazon EKS User Guide. For information about Windows +// versions, see [Amazon EKS optimized Windows AMI versions]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, every Pod on that node is drained first. Amazon EKS attempts to drain +// the nodes gracefully and will fail if it is unable to do so. You can force the +// update if Amazon EKS is unable to drain the nodes as a result of a Pod +// disruption budget issue. +// +// [Amazon EKS optimized Amazon Linux AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html +// [Amazon EKS optimized Windows AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html func (c *Client) UpdateNodegroupVersion(ctx context.Context, params *UpdateNodegroupVersionInput, optFns ...func(*Options)) (*UpdateNodegroupVersionOutput, error) { if params == nil { params = &UpdateNodegroupVersionInput{} @@ -75,16 +83,19 @@ 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) - // 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. + // version is used. For information about Linux versions, see [Amazon EKS optimized Amazon Linux AMI versions]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]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]in the Amazon EKS + // User Guide. + // + // [Amazon EKS optimized Amazon Linux AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html + // [Amazon EKS optimized Windows AMI versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html ReleaseVersion *string // The Kubernetes version to update to. If no version is specified, then the @@ -93,8 +104,9 @@ type UpdateNodegroupVersionInput struct { // 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]in the Amazon EKS User Guide. + // + // [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html Version *string noSmithyDocumentSerde diff --git a/service/eks/doc.go b/service/eks/doc.go index a7b29970001..588db993c11 100644 --- a/service/eks/doc.go +++ b/service/eks/doc.go @@ -7,11 +7,13 @@ // it easy for you to run Kubernetes on Amazon Web Services without needing to // setup or maintain your own Kubernetes control plane. Kubernetes is an // open-source system for automating the deployment, scaling, and management of -// containerized applications. Amazon EKS runs up-to-date versions of the -// open-source Kubernetes software, so you can use all the existing plugins and -// tooling from the Kubernetes community. Applications running on Amazon EKS are -// fully compatible with applications running on any standard Kubernetes -// environment, whether running in on-premises data centers or public clouds. This -// means that you can easily migrate any standard Kubernetes application to Amazon -// EKS without any code modification required. +// containerized applications. +// +// Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so +// you can use all the existing plugins and tooling from the Kubernetes community. +// Applications running on Amazon EKS are fully compatible with applications +// running on any standard Kubernetes environment, whether running in on-premises +// data centers or public clouds. This means that you can easily migrate any +// standard Kubernetes application to Amazon EKS without any code modification +// required. package eks diff --git a/service/eks/options.go b/service/eks/options.go index 631a8c6e949..fc08a460b8d 100644 --- a/service/eks/options.go +++ b/service/eks/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/eks/types/enums.go b/service/eks/types/enums.go index 8f292c6e3d4..a79e4ddb4ce 100644 --- a/service/eks/types/enums.go +++ b/service/eks/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessScopeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessScopeType) Values() []AccessScopeType { return []AccessScopeType{ "cluster", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AddonIssueCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddonIssueCode) Values() []AddonIssueCode { return []AddonIssueCode{ "AccessDenied", @@ -65,8 +67,9 @@ const ( ) // Values returns all known values for AddonStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddonStatus) Values() []AddonStatus { return []AddonStatus{ "CREATING", @@ -101,8 +104,9 @@ const ( ) // Values returns all known values for AMITypes. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AMITypes) Values() []AMITypes { return []AMITypes{ "AL2_x86_64", @@ -132,8 +136,9 @@ const ( ) // Values returns all known values for AuthenticationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationMode) Values() []AuthenticationMode { return []AuthenticationMode{ "API", @@ -151,8 +156,9 @@ const ( ) // Values returns all known values for CapacityTypes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityTypes) Values() []CapacityTypes { return []CapacityTypes{ "ON_DEMAND", @@ -168,8 +174,9 @@ const ( ) // Values returns all known values for Category. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Category) Values() []Category { return []Category{ "UPGRADE_READINESS", @@ -202,8 +209,9 @@ const ( ) // Values returns all known values for ClusterIssueCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterIssueCode) Values() []ClusterIssueCode { return []ClusterIssueCode{ "AccessDenied", @@ -241,8 +249,9 @@ const ( ) // Values returns all known values for ClusterStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterStatus) Values() []ClusterStatus { return []ClusterStatus{ "CREATING", @@ -264,8 +273,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -290,8 +300,9 @@ const ( ) // Values returns all known values for ConnectorConfigProvider. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorConfigProvider) Values() []ConnectorConfigProvider { return []ConnectorConfigProvider{ "EKS_ANYWHERE", @@ -315,8 +326,9 @@ const ( // Values returns all known values for EksAnywhereSubscriptionLicenseType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EksAnywhereSubscriptionLicenseType) Values() []EksAnywhereSubscriptionLicenseType { return []EksAnywhereSubscriptionLicenseType{ "Cluster", @@ -337,8 +349,9 @@ const ( // Values returns all known values for EksAnywhereSubscriptionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EksAnywhereSubscriptionStatus) Values() []EksAnywhereSubscriptionStatus { return []EksAnywhereSubscriptionStatus{ "CREATING", @@ -359,8 +372,9 @@ const ( // Values returns all known values for EksAnywhereSubscriptionTermUnit. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EksAnywhereSubscriptionTermUnit) Values() []EksAnywhereSubscriptionTermUnit { return []EksAnywhereSubscriptionTermUnit{ "MONTHS", @@ -391,8 +405,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -427,8 +442,9 @@ const ( ) // Values returns all known values for FargateProfileStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FargateProfileStatus) Values() []FargateProfileStatus { return []FargateProfileStatus{ "CREATING", @@ -450,8 +466,9 @@ const ( ) // Values returns all known values for InsightStatusValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightStatusValue) Values() []InsightStatusValue { return []InsightStatusValue{ "PASSING", @@ -470,8 +487,9 @@ const ( ) // Values returns all known values for IpFamily. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpFamily) Values() []IpFamily { return []IpFamily{ "ipv4", @@ -491,8 +509,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "api", @@ -545,8 +564,9 @@ const ( ) // Values returns all known values for NodegroupIssueCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodegroupIssueCode) Values() []NodegroupIssueCode { return []NodegroupIssueCode{ "AutoScalingGroupNotFound", @@ -601,8 +621,9 @@ const ( ) // Values returns all known values for NodegroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodegroupStatus) Values() []NodegroupStatus { return []NodegroupStatus{ "CREATING", @@ -625,8 +646,9 @@ const ( ) // Values returns all known values for ResolveConflicts. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolveConflicts) Values() []ResolveConflicts { return []ResolveConflicts{ "OVERWRITE", @@ -645,8 +667,9 @@ const ( ) // Values returns all known values for TaintEffect. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaintEffect) Values() []TaintEffect { return []TaintEffect{ "NO_SCHEDULE", @@ -689,8 +712,9 @@ const ( ) // Values returns all known values for UpdateParamType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateParamType) Values() []UpdateParamType { return []UpdateParamType{ "Version", @@ -734,8 +758,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -762,8 +787,9 @@ const ( ) // Values returns all known values for UpdateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateType) Values() []UpdateType { return []UpdateType{ "VersionUpdate", diff --git a/service/eks/types/errors.go b/service/eks/types/errors.go index 30a564536e6..5e64c100c45 100644 --- a/service/eks/types/errors.go +++ b/service/eks/types/errors.go @@ -7,10 +7,12 @@ import ( smithy "github.com/aws/smithy-go" ) -// You don't have permissions to perform the requested operation. The IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) -// making the request must have at least one IAM permissions policy attached that -// grants the required permissions. For more information, see Access management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) -// in the IAM User Guide. +// You don't have permissions to perform the requested operation. The [IAM principal] making the +// request must have at least one IAM permissions policy attached that grants the +// required permissions. For more information, see [Access management]in the IAM User Guide. +// +// [Access management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html +// [IAM principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html type AccessDeniedException struct { Message *string @@ -64,9 +66,10 @@ 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 an IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) -// that doesn't have permissions to use the action or resource or specifying an -// identifier that is not valid. +// an action or resource on behalf of an [IAM principal]that doesn't have permissions to use the +// action or resource or specifying an identifier that is not valid. +// +// [IAM principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html type ClientException struct { Message *string diff --git a/service/eks/types/types.go b/service/eks/types/types.go index 5472a7720d9..3c1f20333ef 100644 --- a/service/eks/types/types.go +++ b/service/eks/types/types.go @@ -22,8 +22,10 @@ type AccessConfigResponse struct { // An access entry allows an IAM principal (user or role) to access your cluster. // Access entries can replace the need to maintain the aws-auth ConfigMap for -// authentication. For more information about access entries, see Access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) -// in the Amazon EKS User Guide. +// authentication. For more information about access entries, see [Access entries]in the Amazon +// EKS User Guide. +// +// [Access entries]: https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html type AccessEntry struct { // The ARN of the access entry. @@ -74,11 +76,12 @@ type AccessEntry struct { // managed by Amazon EKS, but they're not IAM policies. You can't view the // permissions in the policies using the API. The permissions for many of the // policies are similar to the Kubernetes cluster-admin , admin , edit , and view -// cluster roles. For more information about these cluster roles, see User-facing -// roles (https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) -// in the Kubernetes documentation. To view the contents of the policies, see -// Access policy permissions (https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions) -// in the Amazon EKS User Guide. +// cluster roles. For more information about these cluster roles, see [User-facing roles]in the +// Kubernetes documentation. To view the contents of the policies, see [Access policy permissions]in the +// Amazon EKS User Guide. +// +// [User-facing roles]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles +// [Access policy permissions]: https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html#access-policy-permissions type AccessPolicy struct { // The ARN of the access policy. @@ -103,8 +106,9 @@ type AccessScope struct { noSmithyDocumentSerde } -// 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] in the Amazon EKS User Guide. +// +// [Amazon EKS add-ons]: https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html type Addon struct { // The Amazon Resource Name (ARN) of the add-on. @@ -332,17 +336,20 @@ type Cluster struct { OutpostConfig *OutpostConfigResponse // The platform version of your Amazon EKS cluster. For more information about - // clusters deployed on the Amazon Web Services Cloud, see Platform versions (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) - // in the Amazon EKS User Guide . For more information about local clusters - // deployed on an Outpost, see Amazon EKS local cluster platform versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html) + // clusters deployed on the Amazon Web Services Cloud, see [Platform versions]in the Amazon EKS User + // Guide . For more information about local clusters deployed on an Outpost, see [Amazon EKS local cluster platform versions] // in the Amazon EKS User Guide . + // + // [Platform versions]: https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html + // [Amazon EKS local cluster platform versions]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html 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]and [Cluster security group considerations] in the Amazon EKS User Guide. + // + // [Cluster security group considerations]: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html + // [Cluster VPC considerations]: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html ResourcesVpcConfig *VpcConfigResponse // The Amazon Resource Name (ARN) of the IAM role that provides permissions for @@ -449,9 +456,10 @@ 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) +// Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see [Capacity considerations] // in the Amazon EKS User Guide. +// +// [Capacity considerations]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html type ControlPlanePlacementRequest struct { // The name of the placement group for the Kubernetes control plane instances. @@ -462,9 +470,10 @@ 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) +// Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see [Capacity considerations] // in the Amazon EKS User Guide. +// +// [Capacity considerations]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html type ControlPlanePlacementResponse struct { // The name of the placement group for the Kubernetes control plane instances. @@ -595,18 +604,24 @@ 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 // available IP addresses. - // - AccessDenied: You don't have permissions to perform the specified - // operation. + // + // - 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 @@ -635,9 +650,10 @@ type FargateProfile struct { FargateProfileName *string // The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod - // that matches 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) + // that matches the selectors in the Fargate profile. For more information, see [Pod execution role]Pod // in the Amazon EKS User Guide. + // + // [Pod execution role]: https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html PodExecutionRoleArn *string // The selectors to match for a Pod to use this Fargate profile. @@ -673,8 +689,9 @@ 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] identity provider information. + // + // [OpenID Connect]: https://openid.net/connect/ Oidc *OIDC noSmithyDocumentSerde @@ -841,51 +858,67 @@ type InsightSummary 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. + // subnet. See [Modifying the public IPv4 addressing attribute for your subnet]IPv4 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) + // your Amazon EKS cluster. Common causes of this failure are insufficient [node IAM role] // permissions or lack of outbound internet access for the nodes. + // + // [Modifying the public IPv4 addressing attribute for your subnet]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html#subnet-public-ip + // [node IAM role]: https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html Code NodegroupIssueCode // The error message associated with the issue. @@ -905,14 +938,16 @@ type KubernetesNetworkConfigRequest struct { // 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 // 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. + // 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]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. + // + // [Assigning IPv6 addresses to pods and services]: https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html IpFamily IpFamily // Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign @@ -921,11 +956,15 @@ type KubernetesNetworkConfigRequest struct { // 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. You can't // change this value after the cluster is created. ServiceIpv4Cidr *string @@ -963,25 +1002,34 @@ type KubernetesNetworkConfigResponse struct { } // 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) -// 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. +// template can't include [SubnetId]SubnetId , [IamInstanceProfile]IamInstanceProfile , [RequestSpotInstances]RequestSpotInstances , [HibernationOptions] +// HibernationOptions , or [TerminateInstances]TerminateInstances , or the node group deployment or +// update will fail. For more information about launch templates, see [CreateLaunchTemplate] +// CreateLaunchTemplate in the Amazon EC2 API Reference. For more information about +// using launch templates with Amazon EKS, see [Launch template support]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. +// +// [HibernationOptions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html +// [CreateLaunchTemplate]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html +// [RequestSpotInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html +// [Launch template support]: https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html +// [IamInstanceProfile]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html +// [SubnetId]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html +// [TerminateInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TerminateInstances.html 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 - // name or the launch template ID in the request, but not both. + // The name of the launch template. + // + // You must specify either the launch template name or the launch template ID in + // the request, but not both. Name *string // The version number of the launch template to use. If no version is specified, @@ -1059,9 +1107,10 @@ type Nodegroup struct { // 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 - // are applied with the Amazon EKS API are shown here. There may be other - // Kubernetes labels applied to the nodes in this group. + // The Kubernetes labels applied to the nodes in the node group. + // + // Only labels that are applied with the Amazon EKS API are shown here. There may + // be other Kubernetes labels applied to the nodes in this group. Labels map[string]string // If a launch template was used to create the node group, then this is the launch @@ -1117,9 +1166,9 @@ type Nodegroup struct { // 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) - // . + // are scheduled to your nodes. For more information, see [Node taints on managed node groups]. + // + // [Node taints on managed node groups]: https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html Taints []Taint // The node group update configuration. @@ -1160,28 +1209,36 @@ type NodegroupResources struct { // specify any or none of the properties. type NodegroupScalingConfig struct { - // The current number of nodes that the managed node group should maintain. If you - // use the Kubernetes Cluster Autoscaler (https://github.com/kubernetes/autoscaler#kubernetes-autoscaler) - // , you shouldn't change the desiredSize value directly, as this can cause the - // Cluster Autoscaler to suddenly scale up or scale down. Whenever this parameter - // changes, the number of worker nodes in the node group is updated to the - // specified size. If this parameter is given a value that is smaller than the - // current number of running worker nodes, the necessary number of worker nodes are - // terminated to match the given value. When using CloudFormation, no action occurs - // if you remove this parameter from your CFN template. This parameter can be - // different from minSize in some cases, such as when starting with extra hosts - // for testing. This parameter can also be different when you want to start with an - // estimated number of needed hosts, but let the Cluster Autoscaler reduce the - // number if there are too many. When the Cluster Autoscaler is used, the - // desiredSize parameter is altered by the Cluster Autoscaler (but can be - // out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a - // managed node group lower than minSize or higher than maxSize . + // The current number of nodes that the managed node group should maintain. + // + // If you use the Kubernetes [Cluster Autoscaler], you shouldn't change the desiredSize value + // directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale + // down. + // + // Whenever this parameter changes, the number of worker nodes in the node group + // is updated to the specified size. If this parameter is given a value that is + // smaller than the current number of running worker nodes, the necessary number of + // worker nodes are terminated to match the given value. + // + // When using CloudFormation, no action occurs if you remove this parameter from + // your CFN template. + // + // This parameter can be different from minSize in some cases, such as when + // starting with extra hosts for testing. This parameter can also be different when + // you want to start with an estimated number of needed hosts, but let the Cluster + // Autoscaler reduce the number if there are too many. When the Cluster Autoscaler + // is used, the desiredSize parameter is altered by the Cluster Autoscaler (but + // can be out-of-date for short periods of time). the Cluster Autoscaler doesn't + // scale a managed node group lower than minSize or higher than maxSize . + // + // [Cluster Autoscaler]: https://github.com/kubernetes/autoscaler#kubernetes-autoscaler DesiredSize *int32 // 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. + // information about the maximum number that you can specify, see [Amazon EKS service quotas]in the Amazon + // EKS User Guide. + // + // [Amazon EKS service quotas]: https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html MaxSize *int32 // The minimum number of nodes that the managed node group can scale in to. @@ -1206,8 +1263,10 @@ type NodegroupUpdateConfig struct { noSmithyDocumentSerde } -// An object representing the OpenID Connect (https://openid.net/connect/) (OIDC) -// identity provider information for the cluster. +// An object representing the [OpenID Connect] (OIDC) identity provider information for the +// cluster. +// +// [OpenID Connect]: https://openid.net/connect/ type OIDC struct { // The issuer URL for the OIDC identity provider. @@ -1269,8 +1328,9 @@ 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 OIDC identity provider (https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html) -// in the Amazon EKS User Guide. +// in [Authenticating users for your cluster from an OIDC identity provider]in the Amazon EKS User Guide. +// +// [Authenticating users for your cluster from an OIDC identity provider]: https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html type OidcIdentityProviderConfigRequest struct { // This is also known as audience. The ID for the client application that makes @@ -1306,9 +1366,10 @@ type OidcIdentityProviderConfigRequest struct { // 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. + // For the maximum number of claims that you can require, see [Amazon EKS service quotas]in the Amazon EKS + // User Guide. + // + // [Amazon EKS service quotas]: https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html RequiredClaims map[string]string // The JSON Web Token (JWT) claim to use as the username. The default is sub , @@ -1328,18 +1389,22 @@ 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) -// in the Amazon EKS User Guide. This API isn't available for Amazon EKS clusters -// on the Amazon Web Services cloud. +// Outpost. Before creating a cluster on an Outpost, review [Creating a local cluster on an Outpost]in the Amazon EKS User +// Guide. This API isn't available for Amazon EKS clusters on the Amazon Web +// Services cloud. +// +// [Creating a local cluster on an Outpost]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-create.html 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) - // 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. + // your cluster will have. For more information, see [Capacity considerations]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. + // + // [Capacity considerations]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html // // This member is required. ControlPlaneInstanceType *string @@ -1352,8 +1417,9 @@ type OutpostConfigRequest 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) - // in the Amazon EKS User Guide. + // For more information, see [Capacity considerations]in the Amazon EKS User Guide. + // + // [Capacity considerations]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html ControlPlanePlacement *ControlPlanePlacementRequest noSmithyDocumentSerde @@ -1378,8 +1444,9 @@ 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) - // in the Amazon EKS User Guide. + // For more information, see [Capacity considerations]in the Amazon EKS User Guide. + // + // [Capacity considerations]: https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html ControlPlanePlacement *ControlPlanePlacementResponse noSmithyDocumentSerde @@ -1421,18 +1488,26 @@ type PodIdentityAssociation struct { // Metadata that assists with categorization and organization. Each tag consists // of a key and an optional value. You define both. Tags don't propagate to any - // other cluster or Amazon Web Services resources. The following basic restrictions - // apply to tags: + // other cluster or Amazon Web Services resources. + // + // 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 @@ -1442,11 +1517,16 @@ type PodIdentityAssociation struct { noSmithyDocumentSerde } -// The summarized description of the association. Each summary is simplified by -// removing these fields compared to the full PodIdentityAssociation : +// The summarized description of the association. +// +// Each summary is simplified by removing these fields compared to the full PodIdentityAssociation: +// // - The IAM role: roleArn +// // - The timestamp that the association was created at: createdAt +// // - The most recent timestamp that the association was modified at:. modifiedAt +// // - The tags on the association: tags type PodIdentityAssociationSummary struct { @@ -1476,10 +1556,11 @@ type Provider struct { // Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be // symmetric and created in the same Amazon Web Services Region as the cluster. If - // the KMS key was created in a different account, the IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) - // 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) - // in the Key Management Service Developer Guide. + // the KMS key was created in a different account, the [IAM principal]must have access to the KMS + // key. For more information, see [Allowing users in other accounts to use a KMS key]in the Key Management Service Developer Guide. + // + // [IAM principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html + // [Allowing users in other accounts to use a KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html KeyArn *string noSmithyDocumentSerde @@ -1490,28 +1571,31 @@ type Provider struct { 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. + // nodes in the managed node group. For more information, see [Amazon EC2 key pairs and Linux instances]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]in the + // Amazon Elastic Compute Cloud User Guide for Windows Instances. + // + // [Amazon EC2 key pairs and Windows instances]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html + // [Amazon EC2 key pairs and Linux instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html 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. + // see [Security Groups for Your VPC]in the Amazon Virtual Private Cloud User Guide. + // + // [Security Groups for Your VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html SourceSecurityGroups []string noSmithyDocumentSerde } -// A property that allows a node to repel a Pod . For more information, see Node -// taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html) -// in the Amazon EKS User Guide. +// A property that allows a node to repel a Pod . For more information, see [Node taints on managed node groups] in +// the Amazon EKS User Guide. +// +// [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. @@ -1584,8 +1668,9 @@ 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) -// in the Amazon EKS User Guide. +// information, see [Node taints on managed node groups]in the Amazon EKS User Guide. +// +// [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. @@ -1606,17 +1691,19 @@ type VpcConfigRequest struct { // 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 . + // for communication with the nodes or Fargate pods. For more information, see [Amazon EKS cluster endpoint access control]in + // the Amazon EKS User Guide . + // + // [Amazon EKS cluster endpoint access control]: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html 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 . + // server. For more information, see [Amazon EKS cluster endpoint access control]in the Amazon EKS User Guide . + // + // [Amazon EKS cluster endpoint access control]: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html EndpointPublicAccess *bool // The CIDR blocks that are allowed access to your cluster's public Kubernetes API @@ -1624,17 +1711,19 @@ type VpcConfigRequest struct { // CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If // you've disabled private endpoint access, make sure that you specify the // necessary CIDR blocks for every node and Fargate Pod in the cluster. 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]in the Amazon EKS User Guide . + // + // [Amazon EKS cluster endpoint access control]: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html 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]in + // the Amazon EKS User Guide . + // + // [Amazon EKS security group considerations]: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html SecurityGroupIds []string // Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account @@ -1659,8 +1748,9 @@ 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]in the Amazon EKS User Guide . + // + // [Amazon EKS cluster endpoint access control]: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html EndpointPrivateAccess bool // Whether the public API server endpoint is enabled. diff --git a/service/eksauth/api_op_AssumeRoleForPodIdentity.go b/service/eksauth/api_op_AssumeRoleForPodIdentity.go index bc7a8d23d4c..6dfedd21098 100644 --- a/service/eksauth/api_op_AssumeRoleForPodIdentity.go +++ b/service/eksauth/api_op_AssumeRoleForPodIdentity.go @@ -12,10 +12,12 @@ import ( ) // The Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used -// by the EKS Pod Identity Agent. We recommend that applications use the Amazon Web -// Services SDKs to connect to Amazon Web Services services; if credentials from an -// EKS Pod Identity association are available in the pod, the latest versions of -// the SDKs use them automatically. +// by the EKS Pod Identity Agent. +// +// We recommend that applications use the Amazon Web Services SDKs to connect to +// Amazon Web Services services; if credentials from an EKS Pod Identity +// association are available in the pod, the latest versions of the SDKs use them +// automatically. func (c *Client) AssumeRoleForPodIdentity(ctx context.Context, params *AssumeRoleForPodIdentityInput, optFns ...func(*Options)) (*AssumeRoleForPodIdentityOutput, error) { if params == nil { params = &AssumeRoleForPodIdentityInput{} @@ -49,11 +51,13 @@ type AssumeRoleForPodIdentityInput struct { type AssumeRoleForPodIdentityOutput struct { // An object with the permanent IAM role identity and the temporary session name. - // The ARN of the IAM role that the temporary credentials authenticate to. The - // session name of the temporary session requested to STS. The value is a unique - // identifier that contains the role ID, a colon ( : ), and the role session name - // of the role that is being assumed. The role ID is generated by IAM when the role - // is created. The role session name part of the value follows this format: + // + // The ARN of the IAM role that the temporary credentials authenticate to. + // + // The session name of the temporary session requested to STS. The value is a + // unique identifier that contains the role ID, a colon ( : ), and the role session + // name of the role that is being assumed. The role ID is generated by IAM when the + // role is created. The role session name part of the value follows this format: // eks-clustername-podname-random UUID // // This member is required. diff --git a/service/eksauth/options.go b/service/eksauth/options.go index 9332828cd7b..e46b1636688 100644 --- a/service/eksauth/options.go +++ b/service/eksauth/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/eksauth/types/errors.go b/service/eksauth/types/errors.go index d068a1758b8..3a5330e66d2 100644 --- a/service/eksauth/types/errors.go +++ b/service/eksauth/types/errors.go @@ -9,9 +9,10 @@ import ( // You don't have permissions to perform the requested operation. The IAM // principal making the request must have at least one IAM permissions policy -// attached that grants the required permissions. For more information, see Access -// management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the +// attached that grants the required permissions. For more information, see [Access management]in the // IAM User Guide. +// +// [Access management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html type AccessDeniedException struct { Message *string diff --git a/service/elasticache/api_op_AddTagsToResource.go b/service/elasticache/api_op_AddTagsToResource.go index d695c26636e..ae435a6251e 100644 --- a/service/elasticache/api_op_AddTagsToResource.go +++ b/service/elasticache/api_op_AddTagsToResource.go @@ -15,14 +15,18 @@ 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]. +// +// 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. +// owners) to organize your costs across multiple services. +// +// For more information, see [Using Cost Allocation Tags in Amazon ElastiCache] in the ElastiCache User Guide. +// +// [Using Cost Allocation Tags in Amazon ElastiCache]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html +// [Resource-level permissions]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} @@ -44,9 +48,11 @@ 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 - // 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) - // . + // resources are cluster and snapshot. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Service Namespaces]. + // + // [Amazon 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 diff --git a/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go b/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go index 701176d7746..c3417dd9048 100644 --- a/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go +++ b/service/elasticache/api_op_AuthorizeCacheSecurityGroupIngress.go @@ -13,8 +13,10 @@ import ( // 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. +// 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{} @@ -57,8 +59,11 @@ type AuthorizeCacheSecurityGroupIngressInput struct { type AuthorizeCacheSecurityGroupIngressOutput struct { // Represents the output of one of the following operations: + // // - AuthorizeCacheSecurityGroupIngress + // // - CreateCacheSecurityGroup + // // - RevokeCacheSecurityGroupIngress CacheSecurityGroup *types.CacheSecurityGroup diff --git a/service/elasticache/api_op_BatchApplyUpdateAction.go b/service/elasticache/api_op_BatchApplyUpdateAction.go index d12923d64f9..65efd2d7a5b 100644 --- a/service/elasticache/api_op_BatchApplyUpdateAction.go +++ b/service/elasticache/api_op_BatchApplyUpdateAction.go @@ -12,8 +12,9 @@ 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]. +// +// [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 757891a7910..fd5903254a6 100644 --- a/service/elasticache/api_op_BatchStopUpdateAction.go +++ b/service/elasticache/api_op_BatchStopUpdateAction.go @@ -12,8 +12,9 @@ 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]. +// +// [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 1b3c7625b82..5672ec14d56 100644 --- a/service/elasticache/api_op_CopySnapshot.go +++ b/service/elasticache/api_op_CopySnapshot.go @@ -11,45 +11,76 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Makes a copy of an existing snapshot. This operation is valid for Redis only. +// Makes a copy of an existing snapshot. +// +// This operation is valid for Redis only. +// // Users or groups that have permissions to use the CopySnapshot operation can // 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. +// of ElastiCache operations, see [Exporting Snapshots]and [Authentication & Access Control]. +// +// 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]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]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]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. +// +// 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]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]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]in the +// +// ElastiCache User Guide. +// +// [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 +// [Exporting Snapshots]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html +// [Authentication & Access Control]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html +// +// [Step 1: Create an Amazon S3 Bucket]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket func (c *Client) CopySnapshot(ctx context.Context, params *CopySnapshotInput, optFns ...func(*Options)) (*CopySnapshotOutput, error) { if params == nil { params = &CopySnapshotInput{} @@ -88,13 +119,16 @@ type CopySnapshotInput struct { Tags []types.Tag // The Amazon S3 bucket to which the snapshot is exported. This parameter is used - // 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) - // 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) - // in the Amazon ElastiCache User Guide. + // 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]in the + // Amazon ElastiCache User Guide. + // + // For more information, see [Exporting a Snapshot] in the Amazon ElastiCache User Guide. + // + // [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 + // [Exporting a Snapshot]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html TargetBucket *string noSmithyDocumentSerde diff --git a/service/elasticache/api_op_CreateCacheCluster.go b/service/elasticache/api_op_CreateCacheCluster.go index 29848b50996..a51b84ace17 100644 --- a/service/elasticache/api_op_CreateCacheCluster.go +++ b/service/elasticache/api_op_CreateCacheCluster.go @@ -12,8 +12,9 @@ import ( ) // Creates a cluster. All nodes in the cluster run the same protocol-compliant -// cache engine software, either Memcached or Redis. This operation is not -// supported for Redis (cluster mode enabled) clusters. +// cache engine software, either Memcached or Redis. +// +// This operation is not supported for Redis (cluster mode enabled) clusters. func (c *Client) CreateCacheCluster(ctx context.Context, params *CreateCacheClusterInput, optFns ...func(*Options)) (*CreateCacheClusterOutput, error) { if params == nil { params = &CreateCacheClusterInput{} @@ -33,9 +34,14 @@ func (c *Client) CreateCacheCluster(ctx context.Context, params *CreateCacheClus type CreateCacheClusterInput struct { // The node group (shard) identifier. This parameter is stored as a lowercase - // string. Constraints: + // 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. // // This member is required. @@ -43,19 +49,28 @@ type CreateCacheClusterInput struct { // Specifies whether the nodes in this Memcached cluster are created in a single // Availability Zone or created across multiple Availability Zones in the cluster's - // region. This parameter is only supported for Memcached clusters. If the AZMode - // and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az - // mode. + // region. + // + // This parameter is only supported for Memcached clusters. + // + // If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache + // assumes single-az mode. AZMode types.AZMode - // Reserved parameter. The password used to access a password protected server. + // 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 - // http://redis.io/commands/AUTH. + // + // For more information, see [AUTH password] at http://redis.io/commands/AUTH. + // + // [AUTH password]: http://redis.io/commands/AUTH AuthToken *string // If you are running Redis engine version 6.0 or later, set this parameter to @@ -63,57 +78,102 @@ type CreateCacheClusterInput struct { // parameter is disabled for previous versions. AutoMinorVersionUpgrade *bool - // The compute and memory capacity of the nodes in the node group (shard). The - // following node types are supported by ElastiCache. Generally speaking, the + // The compute and memory capacity of the nodes in the node group (shard). + // + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // The name of the parameter group to associate with this cluster. If this @@ -122,36 +182,44 @@ type CreateCacheClusterInput struct { // creating a cluster. CacheParameterGroupName *string - // A list of security group names to associate with this cluster. Use this - // parameter only when you are creating a cluster outside of an Amazon Virtual - // Private Cloud (Amazon VPC). + // A list of security group names to associate with this cluster. + // + // Use this parameter only when you are creating a cluster outside of an Amazon + // Virtual 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]. + // + // [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 - // parameter are: memcached | redis + // The name of the cache engine to be used for this cluster. + // + // Valid values for this parameter are: memcached | redis Engine *string // 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 - // earlier engine version, you must delete the existing cluster or replication - // group and create it anew with the earlier engine version. + // + // Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]), 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. + // + // [Selecting a Cache Engine and Version]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement EngineVersion *string // 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 (http://aws.amazon.com/ec2/nitro/) - // . + // engine version 1.6.6 on all instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ IpDiscovery types.IpDiscovery // Specifies the destination, format and type of the logs. @@ -159,20 +227,26 @@ type CreateCacheClusterInput struct { // 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 (http://aws.amazon.com/ec2/nitro/) . + // instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ NetworkType types.NetworkType // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) - // topic to which notifications are sent. The Amazon SNS topic owner must be the - // same as the cluster owner. + // topic to which notifications are sent. + // + // The Amazon SNS topic owner must be the same as the cluster owner. NotificationTopicArn *string - // The initial number of cache nodes that the cluster has. For clusters running - // 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/) - // . + // The initial number of cache nodes that the cluster has. + // + // For clusters running 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/ NumCacheNodes *int32 // Specifies whether the nodes in the cluster are created in a single outpost or @@ -182,20 +256,31 @@ type CreateCacheClusterInput struct { // The port number on which each of the cache nodes accepts connections. Port *int32 - // 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. + // 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. PreferredAvailabilityZone *string // A list of the Availability Zones in which cache nodes are created. The order of - // the zones in the list is not important. This option is only supported on - // 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 - // Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone - // multiple times in the list. Default: System chosen Availability Zones. + // the zones in the list is not important. + // + // This option is only supported on 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 Zone, use + // PreferredAvailabilityZone instead, or repeat the Availability Zone multiple + // times in the list. + // + // Default: System chosen Availability Zones. PreferredAvailabilityZones []string // Specifies the weekly time range during which maintenance on the cluster is @@ -212,42 +297,55 @@ type CreateCacheClusterInput struct { // The ID of the replication group to which this cluster should belong. If this // parameter is specified, the cluster is added to the specified replication group // as a read replica; otherwise, the cluster is a standalone primary that is not - // part of any replication group. If the specified replication group is Multi-AZ - // 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 . + // part of any replication group. + // + // If the specified replication group is Multi-AZ 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 . ReplicationGroupId *string - // One or more VPC security groups associated with the cluster. Use this parameter - // only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon - // VPC). + // One or more VPC security groups associated with the cluster. + // + // Use this parameter only when you are creating a cluster in an Amazon Virtual + // Private Cloud (Amazon VPC). SecurityGroupIds []string // A single-element string list containing an Amazon Resource Name (ARN) that // 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: - // arn:aws:s3:::my_bucket/snapshot1.rdb + // the ARN cannot contain any commas. + // + // This parameter is only valid if the Engine 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 . + // (shard) is being created. + // + // This parameter is only valid if the Engine parameter 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 - // disabled for this cache cluster). + // 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 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. + // 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 . SnapshotWindow *string diff --git a/service/elasticache/api_op_CreateCacheParameterGroup.go b/service/elasticache/api_op_CreateCacheParameterGroup.go index 09888b545e2..c74692ae602 100644 --- a/service/elasticache/api_op_CreateCacheParameterGroup.go +++ b/service/elasticache/api_op_CreateCacheParameterGroup.go @@ -14,14 +14,21 @@ import ( // Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache // parameter group is a collection of parameters and their values that are applied // to all of the nodes in any cluster or replication group using the -// CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate -// 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. +// CacheParameterGroup. +// +// A newly created CacheParameterGroup is an exact duplicate 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] +// - in the ElastiCache API Reference. +// +// [Parameters and Parameter Groups] +// - in the ElastiCache User Guide. +// +// [ModifyCacheParameterGroup]: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html +// [Parameters and Parameter Groups]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.html func (c *Client) CreateCacheParameterGroup(ctx context.Context, params *CreateCacheParameterGroupInput, optFns ...func(*Options)) (*CreateCacheParameterGroupOutput, error) { if params == nil { params = &CreateCacheParameterGroupInput{} @@ -41,8 +48,10 @@ func (c *Client) CreateCacheParameterGroup(ctx context.Context, params *CreateCa type CreateCacheParameterGroupInput struct { // The name of the cache parameter group family that the cache parameter group can - // be used with. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | - // redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7 + // be used with. + // + // Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | + // redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7 // // This member is required. CacheParameterGroupFamily *string diff --git a/service/elasticache/api_op_CreateCacheSecurityGroup.go b/service/elasticache/api_op_CreateCacheSecurityGroup.go index a0ad2177397..392fb803cde 100644 --- a/service/elasticache/api_op_CreateCacheSecurityGroup.go +++ b/service/elasticache/api_op_CreateCacheSecurityGroup.go @@ -12,11 +12,13 @@ import ( ) // 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) -// . +// 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]. +// +// [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 +37,12 @@ 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,8 +62,11 @@ type CreateCacheSecurityGroupInput struct { type CreateCacheSecurityGroupOutput struct { // Represents the output of one of the following operations: + // // - AuthorizeCacheSecurityGroupIngress + // // - CreateCacheSecurityGroup + // // - RevokeCacheSecurityGroupIngress CacheSecurityGroup *types.CacheSecurityGroup diff --git a/service/elasticache/api_op_CreateCacheSubnetGroup.go b/service/elasticache/api_op_CreateCacheSubnetGroup.go index 2bb2f204be0..5bd765cc8f3 100644 --- a/service/elasticache/api_op_CreateCacheSubnetGroup.go +++ b/service/elasticache/api_op_CreateCacheSubnetGroup.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new cache subnet group. Use this parameter only when you are creating -// a cluster in an Amazon Virtual Private Cloud (Amazon VPC). +// Creates a new cache subnet group. +// +// Use this parameter only when you are creating a cluster in an Amazon Virtual +// Private Cloud (Amazon VPC). func (c *Client) CreateCacheSubnetGroup(ctx context.Context, params *CreateCacheSubnetGroupInput, optFns ...func(*Options)) (*CreateCacheSubnetGroupOutput, error) { if params == nil { params = &CreateCacheSubnetGroupInput{} @@ -37,7 +39,9 @@ type CreateCacheSubnetGroupInput struct { CacheSubnetGroupDescription *string // A 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. @@ -58,7 +62,9 @@ type CreateCacheSubnetGroupInput struct { type CreateCacheSubnetGroupOutput struct { // Represents the output of one of the following operations: + // // - CreateCacheSubnetGroup + // // - ModifyCacheSubnetGroup CacheSubnetGroup *types.CacheSubnetGroup diff --git a/service/elasticache/api_op_CreateGlobalReplicationGroup.go b/service/elasticache/api_op_CreateGlobalReplicationGroup.go index fa2b714e0e2..f45c44d6dad 100644 --- a/service/elasticache/api_op_CreateGlobalReplicationGroup.go +++ b/service/elasticache/api_op_CreateGlobalReplicationGroup.go @@ -15,11 +15,14 @@ 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) -// . +// see [Replication Across Regions Using Global Datastore]. +// // - 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. +// +// [Replication Across Regions Using Global Datastore]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html func (c *Client) CreateGlobalReplicationGroup(ctx context.Context, params *CreateGlobalReplicationGroupInput, optFns ...func(*Options)) (*CreateGlobalReplicationGroupOutput, error) { if params == nil { params = &CreateGlobalReplicationGroupInput{} @@ -42,10 +45,12 @@ type CreateGlobalReplicationGroupInput struct { // its own prefix. For instance, a Global datastore ID created in the US-West-1 // 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) - // . + // 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]. + // + // [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 @@ -68,6 +73,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_CreateReplicationGroup.go b/service/elasticache/api_op_CreateReplicationGroup.go index ec2f86c6dfb..b81d23ab3fb 100644 --- a/service/elasticache/api_op_CreateReplicationGroup.go +++ b/service/elasticache/api_op_CreateReplicationGroup.go @@ -12,32 +12,43 @@ import ( ) // Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) -// replication group. This API can be used to create a standalone regional -// replication group or a secondary replication group associated with a Global -// datastore. A Redis (cluster mode disabled) replication group is a collection of -// nodes, where one of the nodes is a read/write primary and the others are -// read-only replicas. Writes to the primary are asynchronously propagated to the -// replicas. A Redis cluster-mode enabled cluster is comprised of from 1 to 90 -// shards (API/CLI: node groups). Each shard has a primary node and up to 5 -// read-only replica nodes. The configuration can range from 90 shards and 0 -// replicas to 15 shards and 5 replicas, which is the maximum number or replicas -// allowed. The node or shard limit can be increased to a maximum of 500 per -// cluster if the Redis engine version is 5.0.6 or higher. For example, you can -// choose to configure a 500 node cluster that ranges between 83 shards (one -// primary and 5 replicas per shard) and 500 shards (single primary and no -// 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. +// replication group. +// +// This API can be used to create a standalone regional replication group or a +// secondary replication group associated with a Global datastore. +// +// A Redis (cluster mode disabled) replication group is a collection of nodes, +// where one of the nodes is a read/write primary and the others are read-only +// replicas. Writes to the primary are asynchronously propagated to the replicas. +// +// A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards +// (API/CLI: node groups). Each shard has a primary node and up to 5 read-only +// replica nodes. The configuration can range from 90 shards and 0 replicas to 15 +// shards and 5 replicas, which is the maximum number or replicas allowed. +// +// The node or shard limit can be increased to a maximum of 500 per cluster if the +// Redis engine version is 5.0.6 or higher. For example, you can choose to +// configure a 500 node cluster that ranges between 83 shards (one primary and 5 +// replicas per shard) and 500 shards (single primary and no 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]. For versions below 5.0.6, the limit is 250 per cluster. +// +// To request a limit increase, see [Amazon Service Limits] 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]in the ElastiCache User Guide. +// +// This operation is valid for Redis only. +// +// [Creating a Subnet Group]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html +// [Scaling ElastiCache for Redis Clusters]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html +// [Amazon Service Limits]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html func (c *Client) CreateReplicationGroup(ctx context.Context, params *CreateReplicationGroupInput, optFns ...func(*Options)) (*CreateReplicationGroupOutput, error) { if params == nil { params = &CreateReplicationGroupInput{} @@ -62,33 +73,51 @@ type CreateReplicationGroupInput struct { ReplicationGroupDescription *string // The replication group identifier. This parameter is stored as a lowercase - // string. Constraints: + // 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. // // This member is required. ReplicationGroupId *string - // 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. + // 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 + // 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. + // 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 . + // 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. + // + // For more information, see [AUTH password] at http://redis.io/commands/AUTH. + // + // [AUTH password]: http://redis.io/commands/AUTH AuthToken *string // If you are running Redis engine version 6.0 or later, set this parameter to @@ -97,70 +126,123 @@ type CreateReplicationGroupInput struct { AutoMinorVersionUpgrade *bool // Specifies whether a read-only replica is automatically promoted to read/write - // primary if the existing primary fails. AutomaticFailoverEnabled must be enabled - // for Redis (cluster mode enabled) replication groups. Default: false + // primary if the existing primary fails. + // + // AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) + // replication groups. + // + // Default: false AutomaticFailoverEnabled *bool - // The compute and memory capacity of the nodes in the node group (shard). The - // following node types are supported by ElastiCache. Generally speaking, the + // The compute and memory capacity of the nodes in the node group (shard). + // + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // The name of the parameter group to associate with this replication group. If // this argument is omitted, the default cache parameter group for the specified - // 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. + // 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 . CacheParameterGroupName *string @@ -168,11 +250,12 @@ type CreateReplicationGroupInput struct { // A list of cache security group names to associate with this replication group. CacheSecurityGroupNames []string - // 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) - // . + // 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]. + // + // [Subnets and Subnet Groups]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html CacheSubnetGroupName *string // Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must @@ -184,8 +267,9 @@ type CreateReplicationGroupInput 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]. + // + // [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 @@ -194,12 +278,14 @@ type CreateReplicationGroupInput struct { // 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 - // 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. + // DescribeCacheEngineVersions operation. + // + // Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]) 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. + // + // [Selecting a Cache Engine and Version]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement EngineVersion *string // The name of the Global datastore @@ -207,8 +293,9 @@ type CreateReplicationGroupInput struct { // 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 (http://aws.amazon.com/ec2/nitro/) - // . + // Memcached engine version 1.6.6 on all instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ IpDiscovery types.IpDiscovery // The ID of the KMS key used to encrypt the disk in the cluster. @@ -218,43 +305,54 @@ 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]. + // + // [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 // Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all - // instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/) . + // instances built on the [Nitro system]. + // + // [Nitro system]: http://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 - // (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 - // mode enabled) cluster from a S3 rdb file. You must configure each node group - // (shard) using this parameter because you must specify the slots for each node - // group. + // 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 mode enabled) cluster from a S3 rdb file. You must + // configure each node group (shard) using this parameter because you must specify + // the slots for each node group. NodeGroupConfiguration []types.NodeGroupConfiguration // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) - // topic to which notifications are sent. The Amazon SNS topic owner must be the - // same as the cluster owner. + // topic to which notifications are sent. + // + // The Amazon SNS topic owner must be the same as the cluster owner. NotificationTopicArn *string - // 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 - // 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). + // 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 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 - // disabled) either omit this parameter or set it to 1. Default: 1 + // disabled) either omit this parameter or set it to 1. + // + // Default: 1 NumNodeGroups *int32 // The port number on which each member of the replication group accepts @@ -264,31 +362,48 @@ type CreateReplicationGroupInput struct { // A list of EC2 Availability Zones in which the replication group's clusters are // created. The order of the Availability Zones in the list is the order in which // clusters are allocated. The primary cluster is created in the first AZ in the - // list. This parameter is not used if there is more than one node group (shard). - // 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. + // list. + // + // This parameter is not used if there is more than one node group (shard). 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. + // . + // + // Default: system chosen Availability Zones. PreferredCacheClusterAZs []string // Specifies the weekly time range during which maintenance on the 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: + // 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 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 @@ -297,6 +412,7 @@ type CreateReplicationGroupInput struct { ReplicasPerNodeGroup *int32 // One or more Amazon VPC security groups associated with this replication group. + // // Use this parameter only when you are creating a replication group in an Amazon // Virtual Private Cloud (Amazon VPC). SecurityGroupIds []string @@ -311,7 +427,9 @@ type CreateReplicationGroupInput struct { // commas. The new replication group will have the number of node groups (console: // shards) specified by the parameter NumNodeGroups or the number of node groups // configured by NodeGroupConfiguration regardless of the number of ARNs specified - // here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb + // here. + // + // Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb SnapshotArns []string // The name of a snapshot from which to restore data into the new replication @@ -321,13 +439,18 @@ type CreateReplicationGroupInput struct { // The number of days for which ElastiCache retains automatic 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. Default: 0 - // (i.e., automatic backups are disabled for this cluster). + // that was taken today is retained for 5 days before being deleted. + // + // Default: 0 (i.e., automatic backups are disabled for this 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. + // 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. SnapshotWindow *string // A list of tags to be added to this resource. Tags are comma-separated key,value @@ -336,26 +459,38 @@ type CreateReplicationGroupInput struct { // 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 + // 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 - // 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 , after that you can set - // TransitEncryptionMode to required . This process will not trigger the - // replacement of the replication group. + // 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 , after that you can set + // TransitEncryptionMode to required . + // + // This process will not trigger the replacement of the replication group. 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 0419b50696f..a5bc52f3c6b 100644 --- a/service/elasticache/api_op_CreateSnapshot.go +++ b/service/elasticache/api_op_CreateSnapshot.go @@ -12,7 +12,9 @@ import ( ) // Creates a copy of an entire cluster or replication group at a specific moment -// in time. This operation is valid for Redis only. +// 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 bbd0623b464..6757e31a688 100644 --- a/service/elasticache/api_op_CreateUser.go +++ b/service/elasticache/api_op_CreateUser.go @@ -12,8 +12,9 @@ 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)]. +// +// [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 8a35f908a1b..d9cf5803dc0 100644 --- a/service/elasticache/api_op_CreateUserGroup.go +++ b/service/elasticache/api_op_CreateUserGroup.go @@ -12,7 +12,9 @@ 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)] +// +// [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 5cb7ead3c2a..e6faabd6193 100644 --- a/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DecreaseNodeGroupsInGlobalReplicationGroup.go @@ -69,6 +69,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_DecreaseReplicaCount.go b/service/elasticache/api_op_DecreaseReplicaCount.go index 32212409d1b..c0706e5cd0e 100644 --- a/service/elasticache/api_op_DecreaseReplicaCount.go +++ b/service/elasticache/api_op_DecreaseReplicaCount.go @@ -47,11 +47,16 @@ type DecreaseReplicaCountInput struct { // For Redis (cluster mode disabled) replication groups, this is the number of // replica nodes in the replication group. For Redis (cluster mode enabled) // 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: + // 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) NewReplicaCount *int32 diff --git a/service/elasticache/api_op_DeleteCacheCluster.go b/service/elasticache/api_op_DeleteCacheCluster.go index 1cb2247edc5..d0a26ada243 100644 --- a/service/elasticache/api_op_DeleteCacheCluster.go +++ b/service/elasticache/api_op_DeleteCacheCluster.go @@ -14,14 +14,22 @@ import ( // Deletes a previously provisioned cluster. DeleteCacheCluster deletes all // associated cache nodes, node endpoints and the cluster itself. When you receive // 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: +// 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 func (c *Client) DeleteCacheCluster(ctx context.Context, params *DeleteCacheClusterInput, optFns ...func(*Options)) (*DeleteCacheClusterOutput, error) { if params == nil { diff --git a/service/elasticache/api_op_DeleteCacheParameterGroup.go b/service/elasticache/api_op_DeleteCacheParameterGroup.go index 2a8846eb867..f17c5d90662 100644 --- a/service/elasticache/api_op_DeleteCacheParameterGroup.go +++ b/service/elasticache/api_op_DeleteCacheParameterGroup.go @@ -31,8 +31,9 @@ func (c *Client) DeleteCacheParameterGroup(ctx context.Context, params *DeleteCa // Represents the input of a DeleteCacheParameterGroup operation. type DeleteCacheParameterGroupInput struct { - // The name of the cache parameter group to delete. The specified cache security - // group must not be associated with any clusters. + // The name of the cache parameter group to delete. + // + // The specified cache security group must not be associated with any clusters. // // This member is required. CacheParameterGroupName *string diff --git a/service/elasticache/api_op_DeleteCacheSecurityGroup.go b/service/elasticache/api_op_DeleteCacheSecurityGroup.go index 22754574d23..490f4bcb9dc 100644 --- a/service/elasticache/api_op_DeleteCacheSecurityGroup.go +++ b/service/elasticache/api_op_DeleteCacheSecurityGroup.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a cache security group. You cannot delete a cache security group if it -// is associated with any clusters. +// Deletes a cache security group. +// +// You cannot delete a cache security group if it is associated with any clusters. func (c *Client) DeleteCacheSecurityGroup(ctx context.Context, params *DeleteCacheSecurityGroupInput, optFns ...func(*Options)) (*DeleteCacheSecurityGroupOutput, error) { if params == nil { params = &DeleteCacheSecurityGroupInput{} @@ -30,8 +31,9 @@ func (c *Client) DeleteCacheSecurityGroup(ctx context.Context, params *DeleteCac // Represents the input of a DeleteCacheSecurityGroup operation. type DeleteCacheSecurityGroupInput struct { - // The name of the cache security group to delete. You cannot delete the default - // security group. + // The name of the cache security group to delete. + // + // You cannot delete the default security group. // // This member is required. CacheSecurityGroupName *string diff --git a/service/elasticache/api_op_DeleteCacheSubnetGroup.go b/service/elasticache/api_op_DeleteCacheSubnetGroup.go index 186fa2ab921..e6a6c1c3590 100644 --- a/service/elasticache/api_op_DeleteCacheSubnetGroup.go +++ b/service/elasticache/api_op_DeleteCacheSubnetGroup.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a cache subnet group. You cannot delete a default cache subnet group or -// one that is associated with any clusters. +// Deletes a cache subnet group. +// +// You cannot delete a default cache subnet group or one that is associated with +// any clusters. func (c *Client) DeleteCacheSubnetGroup(ctx context.Context, params *DeleteCacheSubnetGroupInput, optFns ...func(*Options)) (*DeleteCacheSubnetGroupOutput, error) { if params == nil { params = &DeleteCacheSubnetGroupInput{} @@ -30,8 +32,9 @@ func (c *Client) DeleteCacheSubnetGroup(ctx context.Context, params *DeleteCache // Represents the input of a DeleteCacheSubnetGroup operation. type DeleteCacheSubnetGroupInput struct { - // The name of the cache subnet group to delete. Constraints: Must contain no more - // than 255 alphanumeric characters or hyphens. + // The name of the cache subnet group to delete. + // + // Constraints: Must contain no more than 255 alphanumeric characters or hyphens. // // This member is required. CacheSubnetGroupName *string diff --git a/service/elasticache/api_op_DeleteGlobalReplicationGroup.go b/service/elasticache/api_op_DeleteGlobalReplicationGroup.go index 733477aba27..9414aefb20f 100644 --- a/service/elasticache/api_op_DeleteGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DeleteGlobalReplicationGroup.go @@ -12,8 +12,9 @@ import ( ) // Deleting a Global datastore is a two-step process: -// - First, you must DisassociateGlobalReplicationGroup to remove the secondary -// clusters in the Global datastore. +// +// - First, you must DisassociateGlobalReplicationGroupto 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 . @@ -22,9 +23,11 @@ import ( // 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. +// 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{} @@ -61,6 +64,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_DeleteReplicationGroup.go b/service/elasticache/api_op_DeleteReplicationGroup.go index 79f4f0d3887..ac4f2c3b2fa 100644 --- a/service/elasticache/api_op_DeleteReplicationGroup.go +++ b/service/elasticache/api_op_DeleteReplicationGroup.go @@ -15,10 +15,13 @@ 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 -// operation, Amazon ElastiCache immediately begins deleting the selected -// resources; you cannot cancel or revert this operation. This operation is valid -// for Redis only. +// 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. func (c *Client) DeleteReplicationGroup(ctx context.Context, params *DeleteReplicationGroupInput, optFns ...func(*Options)) (*DeleteReplicationGroupOutput, error) { if params == nil { params = &DeleteReplicationGroupInput{} diff --git a/service/elasticache/api_op_DeleteSnapshot.go b/service/elasticache/api_op_DeleteSnapshot.go index f29ed5a4553..2e9ed1f0795 100644 --- a/service/elasticache/api_op_DeleteSnapshot.go +++ b/service/elasticache/api_op_DeleteSnapshot.go @@ -13,7 +13,9 @@ import ( // Deletes an existing snapshot. When you receive a successful response from this // operation, ElastiCache immediately begins deleting the snapshot; you cannot -// cancel or revert this operation. This operation is valid for Redis only. +// cancel or revert this operation. +// +// This operation is valid for Redis only. func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error) { if params == nil { params = &DeleteSnapshotInput{} diff --git a/service/elasticache/api_op_DeleteUser.go b/service/elasticache/api_op_DeleteUser.go index efbb6c4272c..7bb7fe5d641 100644 --- a/service/elasticache/api_op_DeleteUser.go +++ b/service/elasticache/api_op_DeleteUser.go @@ -13,8 +13,9 @@ 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)]. +// +// [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 9468afd16ef..53fec5bbae8 100644 --- a/service/elasticache/api_op_DeleteUserGroup.go +++ b/service/elasticache/api_op_DeleteUserGroup.go @@ -13,8 +13,9 @@ 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)]. +// +// [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 0f2998e17f2..e15d4b83797 100644 --- a/service/elasticache/api_op_DescribeCacheClusters.go +++ b/service/elasticache/api_op_DescribeCacheClusters.go @@ -19,18 +19,26 @@ import ( // Returns information about all provisioned clusters if no cluster identifier is // specified, or about a specific cache cluster if a cluster identifier is -// supplied. By default, abbreviated information about the clusters is returned. -// You can use the optional ShowCacheNodeInfo flag to retrieve detailed information -// about the cache nodes associated with the clusters. These details include the -// DNS address and port for the cache node endpoint. If the cluster is in the -// creating state, only cluster-level information is displayed until all of the -// nodes are successfully provisioned. If the cluster is in the deleting state, -// only cluster-level information is displayed. If cache nodes are currently being -// added to the cluster, node endpoint information and creation time for the -// additional nodes are not displayed until they are completely provisioned. When -// the cluster state is available, the cluster is ready for use. If cache nodes are -// currently being removed from the cluster, no endpoint information for the -// removed nodes is displayed. +// supplied. +// +// By default, abbreviated information about the clusters is returned. You can use +// the optional ShowCacheNodeInfo flag to retrieve detailed information about the +// cache nodes associated with the clusters. These details include the DNS address +// and port for the cache node endpoint. +// +// If the cluster is in the creating state, only cluster-level information is +// displayed until all of the nodes are successfully provisioned. +// +// If the cluster is in the deleting state, only cluster-level information is +// displayed. +// +// If cache nodes are currently being added to the cluster, node endpoint +// information and creation time for the additional nodes are not displayed until +// they are completely provisioned. When the cluster state is available, the +// cluster is ready for use. +// +// If cache nodes are currently being removed from the cluster, no endpoint +// information for the removed nodes is displayed. func (c *Client) DescribeCacheClusters(ctx context.Context, params *DescribeCacheClustersInput, optFns ...func(*Options)) (*DescribeCacheClustersOutput, error) { if params == nil { params = &DescribeCacheClustersInput{} @@ -62,8 +70,11 @@ type DescribeCacheClustersInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 // An optional flag that can be included in the DescribeCacheCluster request to @@ -183,8 +194,11 @@ var _ DescribeCacheClustersAPIClient = (*Client)(nil) type DescribeCacheClustersPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -298,12 +312,13 @@ type CacheClusterAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCacheClustersInput, *DescribeCacheClustersOutput, error) (bool, error) } @@ -583,12 +598,13 @@ type CacheClusterDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCacheClustersInput, *DescribeCacheClustersOutput, error) (bool, error) } diff --git a/service/elasticache/api_op_DescribeCacheEngineVersions.go b/service/elasticache/api_op_DescribeCacheEngineVersions.go index a3aff3365e6..62e36da0676 100644 --- a/service/elasticache/api_op_DescribeCacheEngineVersions.go +++ b/service/elasticache/api_op_DescribeCacheEngineVersions.go @@ -31,11 +31,16 @@ func (c *Client) DescribeCacheEngineVersions(ctx context.Context, params *Descri 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 CacheParameterGroupFamily *string @@ -46,7 +51,9 @@ type DescribeCacheEngineVersionsInput struct { // The cache engine to return. Valid values: memcached | redis Engine *string - // The cache engine version to return. Example: 1.4.14 + // The cache engine version to return. + // + // Example: 1.4.14 EngineVersion *string // An optional marker returned from a prior request. Use this marker for @@ -57,8 +64,11 @@ type DescribeCacheEngineVersionsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -169,8 +179,11 @@ var _ DescribeCacheEngineVersionsAPIClient = (*Client)(nil) type DescribeCacheEngineVersionsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeCacheParameterGroups.go b/service/elasticache/api_op_DescribeCacheParameterGroups.go index f5bdf92d2b0..2d93d34be0c 100644 --- a/service/elasticache/api_op_DescribeCacheParameterGroups.go +++ b/service/elasticache/api_op_DescribeCacheParameterGroups.go @@ -42,8 +42,11 @@ type DescribeCacheParameterGroupsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -154,8 +157,11 @@ var _ DescribeCacheParameterGroupsAPIClient = (*Client)(nil) type DescribeCacheParameterGroupsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeCacheParameters.go b/service/elasticache/api_op_DescribeCacheParameters.go index 694edbb671f..f1356bcaae2 100644 --- a/service/elasticache/api_op_DescribeCacheParameters.go +++ b/service/elasticache/api_op_DescribeCacheParameters.go @@ -43,11 +43,16 @@ type DescribeCacheParametersInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 - // The parameter types to return. Valid values: user | system | engine-default + // The parameter types to return. + // + // Valid values: user | system | engine-default Source *string noSmithyDocumentSerde @@ -164,8 +169,11 @@ var _ DescribeCacheParametersAPIClient = (*Client)(nil) type DescribeCacheParametersPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeCacheSecurityGroups.go b/service/elasticache/api_op_DescribeCacheSecurityGroups.go index 87cd398f6cf..3cb5b45b225 100644 --- a/service/elasticache/api_op_DescribeCacheSecurityGroups.go +++ b/service/elasticache/api_op_DescribeCacheSecurityGroups.go @@ -43,8 +43,11 @@ type DescribeCacheSecurityGroupsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -155,8 +158,11 @@ var _ DescribeCacheSecurityGroupsAPIClient = (*Client)(nil) type DescribeCacheSecurityGroupsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeCacheSubnetGroups.go b/service/elasticache/api_op_DescribeCacheSubnetGroups.go index d0d6f228234..fedd4995581 100644 --- a/service/elasticache/api_op_DescribeCacheSubnetGroups.go +++ b/service/elasticache/api_op_DescribeCacheSubnetGroups.go @@ -44,8 +44,11 @@ type DescribeCacheSubnetGroupsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -156,8 +159,11 @@ var _ DescribeCacheSubnetGroupsAPIClient = (*Client)(nil) type DescribeCacheSubnetGroupsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeEngineDefaultParameters.go b/service/elasticache/api_op_DescribeEngineDefaultParameters.go index 8c6e1a3489d..e7d26be6e37 100644 --- a/service/elasticache/api_op_DescribeEngineDefaultParameters.go +++ b/service/elasticache/api_op_DescribeEngineDefaultParameters.go @@ -31,9 +31,10 @@ func (c *Client) DescribeEngineDefaultParameters(ctx context.Context, params *De // Represents the input of a DescribeEngineDefaultParameters operation. type DescribeEngineDefaultParametersInput struct { - // The name of the cache parameter group family. Valid values are: memcached1.4 | - // memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | - // redis5.0 | redis6.x | redis6.2 | redis7 + // The name of the cache parameter group family. + // + // Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | + // redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7 // // This member is required. CacheParameterGroupFamily *string @@ -46,8 +47,11 @@ type DescribeEngineDefaultParametersInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -156,8 +160,11 @@ var _ DescribeEngineDefaultParametersAPIClient = (*Client)(nil) type DescribeEngineDefaultParametersPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeEvents.go b/service/elasticache/api_op_DescribeEvents.go index a8e5f08a1bc..0cbd1979f2d 100644 --- a/service/elasticache/api_op_DescribeEvents.go +++ b/service/elasticache/api_op_DescribeEvents.go @@ -14,9 +14,10 @@ import ( // Returns events related to clusters, cache security groups, and cache parameter // groups. You can obtain events specific to a particular cluster, cache security -// group, or cache parameter group by providing the name as a parameter. By -// default, only the events occurring within the last hour are returned; however, -// you can retrieve up to 14 days' worth of events if necessary. +// group, or cache parameter group by providing the name as a parameter. +// +// By default, only the events occurring within the last hour are returned; +// however, you can retrieve up to 14 days' worth of events if necessary. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -39,7 +40,9 @@ type DescribeEventsInput struct { 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 + // 8601 format. + // + // Example: 2017-03-30T07:03:49.555Z EndTime *time.Time // An optional marker returned from a prior request. Use this marker for @@ -50,8 +53,11 @@ type DescribeEventsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 // The identifier of the event source for which events are returned. If not @@ -63,7 +69,9 @@ type DescribeEventsInput struct { 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 + // 8601 format. + // + // Example: 2017-03-30T07:03:49.555Z StartTime *time.Time noSmithyDocumentSerde @@ -173,8 +181,11 @@ var _ DescribeEventsAPIClient = (*Client)(nil) type DescribeEventsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeReplicationGroups.go b/service/elasticache/api_op_DescribeReplicationGroups.go index 2d8ca94e380..6da99abe326 100644 --- a/service/elasticache/api_op_DescribeReplicationGroups.go +++ b/service/elasticache/api_op_DescribeReplicationGroups.go @@ -18,7 +18,9 @@ import ( // Returns information about a particular replication group. If no identifier is // specified, DescribeReplicationGroups returns information about all replication -// groups. This operation is valid for Redis only. +// groups. +// +// This operation is valid for Redis only. func (c *Client) DescribeReplicationGroups(ctx context.Context, params *DescribeReplicationGroupsInput, optFns ...func(*Options)) (*DescribeReplicationGroupsOutput, error) { if params == nil { params = &DescribeReplicationGroupsInput{} @@ -45,13 +47,18 @@ type DescribeReplicationGroupsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 // The identifier for the replication group to be described. This parameter is not - // case sensitive. If you do not specify this parameter, information about all - // replication groups is returned. + // case sensitive. + // + // If you do not specify this parameter, information about all replication groups + // is returned. ReplicationGroupId *string noSmithyDocumentSerde @@ -162,8 +169,11 @@ var _ DescribeReplicationGroupsAPIClient = (*Client)(nil) type DescribeReplicationGroupsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -278,12 +288,13 @@ type ReplicationGroupAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationGroupsInput, *DescribeReplicationGroupsOutput, error) (bool, error) } @@ -492,12 +503,13 @@ type ReplicationGroupDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeReplicationGroupsInput, *DescribeReplicationGroupsOutput, error) (bool, error) } diff --git a/service/elasticache/api_op_DescribeReservedCacheNodes.go b/service/elasticache/api_op_DescribeReservedCacheNodes.go index 4105e817f70..92116d29003 100644 --- a/service/elasticache/api_op_DescribeReservedCacheNodes.go +++ b/service/elasticache/api_op_DescribeReservedCacheNodes.go @@ -32,62 +32,108 @@ func (c *Client) DescribeReservedCacheNodes(ctx context.Context, params *Describ type DescribeReservedCacheNodesInput struct { // The cache node type filter value. Use this parameter to show only those - // reservations matching the specified cache node type. 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. + // reservations matching the specified cache node type. + // + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // The duration filter value, specified in years or seconds. Use this parameter to - // show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | - // 94608000 + // show only reservations for this duration. + // + // Valid Values: 1 | 3 | 31536000 | 94608000 Duration *string // An optional marker returned from a prior request. Use this marker for @@ -98,14 +144,18 @@ type DescribeReservedCacheNodesInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 // The offering type filter value. Use this parameter to show only the available - // offerings matching the specified offering type. Valid values: "Light - // Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial - // Upfront"| "No Upfront" + // offerings matching the specified offering type. + // + // Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All + // Upfront"|"Partial Upfront"| "No Upfront" OfferingType *string // The product description filter value. Use this parameter to show only those @@ -228,8 +278,11 @@ var _ DescribeReservedCacheNodesAPIClient = (*Client)(nil) type DescribeReservedCacheNodesPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go b/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go index 9ac9d5d2476..175a01ae179 100644 --- a/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go +++ b/service/elasticache/api_op_DescribeReservedCacheNodesOfferings.go @@ -31,62 +31,108 @@ func (c *Client) DescribeReservedCacheNodesOfferings(ctx context.Context, params type DescribeReservedCacheNodesOfferingsInput struct { // The cache node type filter value. Use this parameter to show only the available - // offerings matching the specified cache node type. 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. + // offerings matching the specified cache node type. + // + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion 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 | - // 94608000 + // 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 @@ -97,14 +143,18 @@ type DescribeReservedCacheNodesOfferingsInput 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. MaxRecords *int32 // The offering type filter value. Use this parameter to show only the available - // offerings matching the specified offering type. Valid Values: "Light - // Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial - // Upfront"| "No Upfront" + // offerings matching the specified offering type. + // + // Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" + // |"All Upfront"|"Partial Upfront"| "No Upfront" OfferingType *string // The product description filter value. Use this parameter to show only the @@ -112,8 +162,9 @@ type DescribeReservedCacheNodesOfferingsInput struct { ProductDescription *string // The offering identifier filter value. Use this parameter to show only the - // available offering that matches the specified reservation identifier. Example: - // 438012d3-4052-4cc7-b2e3-8d3372e0e706 + // available offering that matches the specified reservation identifier. + // + // Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 ReservedCacheNodesOfferingId *string noSmithyDocumentSerde @@ -224,8 +275,11 @@ var _ DescribeReservedCacheNodesOfferingsAPIClient = (*Client)(nil) 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 - // that the remaining results can be retrieved. Default: 100 Constraints: minimum - // 20; maximum 100. + // that the remaining results can be retrieved. + // + // Default: 100 + // + // Constraints: minimum 20; maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DescribeSnapshots.go b/service/elasticache/api_op_DescribeSnapshots.go index 51cc500ba23..8f7037a81b3 100644 --- a/service/elasticache/api_op_DescribeSnapshots.go +++ b/service/elasticache/api_op_DescribeSnapshots.go @@ -14,7 +14,9 @@ import ( // Returns information about cluster or replication group snapshots. By default, // DescribeSnapshots lists all of your snapshots; it can optionally describe a // single snapshot, or just the snapshots associated with a particular cache -// cluster. This operation is valid for Redis only. +// cluster. +// +// This operation is valid for Redis only. func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) { if params == nil { params = &DescribeSnapshotsInput{} @@ -45,8 +47,11 @@ type DescribeSnapshotsInput 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 - // that the remaining results can be retrieved. Default: 50 Constraints: minimum - // 20; maximum 50. + // that the remaining results can be retrieved. + // + // Default: 50 + // + // Constraints: minimum 20; maximum 50. MaxRecords *int32 // A user-supplied replication group identifier. If this parameter is specified, @@ -177,8 +182,11 @@ var _ DescribeSnapshotsAPIClient = (*Client)(nil) type DescribeSnapshotsPaginatorOptions 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 - // that the remaining results can be retrieved. Default: 50 Constraints: minimum - // 20; maximum 50. + // that the remaining results can be retrieved. + // + // Default: 50 + // + // Constraints: minimum 20; maximum 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go b/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go index 8fb6c3b6312..9ec985fd7f1 100644 --- a/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go +++ b/service/elasticache/api_op_DisassociateGlobalReplicationGroup.go @@ -56,6 +56,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_FailoverGlobalReplicationGroup.go b/service/elasticache/api_op_FailoverGlobalReplicationGroup.go index 9954300e23f..9b4a0dcf4ac 100644 --- a/service/elasticache/api_op_FailoverGlobalReplicationGroup.go +++ b/service/elasticache/api_op_FailoverGlobalReplicationGroup.go @@ -54,6 +54,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go b/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go index 11b35c7ba2d..ca66b8f43a4 100644 --- a/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_IncreaseNodeGroupsInGlobalReplicationGroup.go @@ -58,6 +58,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_ListAllowedNodeTypeModifications.go b/service/elasticache/api_op_ListAllowedNodeTypeModifications.go index afe72864c27..8253dc0176a 100644 --- a/service/elasticache/api_op_ListAllowedNodeTypeModifications.go +++ b/service/elasticache/api_op_ListAllowedNodeTypeModifications.go @@ -11,10 +11,11 @@ import ( ) // Lists all available node types that you can scale your Redis cluster's or -// replication group's current node type. When you use the ModifyCacheCluster or -// ModifyReplicationGroup operations to scale your cluster or replication group, -// the value of the CacheNodeType parameter must be one of the node types returned -// by this operation. +// replication group's current node type. +// +// When you use the ModifyCacheCluster or ModifyReplicationGroup operations to +// scale your cluster or replication group, the value of the CacheNodeType +// parameter must be one of the node types returned by this operation. func (c *Client) ListAllowedNodeTypeModifications(ctx context.Context, params *ListAllowedNodeTypeModificationsInput, optFns ...func(*Options)) (*ListAllowedNodeTypeModificationsOutput, error) { if params == nil { params = &ListAllowedNodeTypeModificationsInput{} @@ -35,15 +36,19 @@ 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 . + // 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 + // . 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 . + // types you can scale up to. + // + // You must provide a value for either the CacheClusterId or the ReplicationGroupId + // . ReplicationGroupId *string noSmithyDocumentSerde @@ -60,9 +65,11 @@ type ListAllowedNodeTypeModificationsOutput struct { ScaleDownModifications []string // 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 - // value from this list for the CacheNodeType parameter. + // use to scale your cluster or replication group. + // + // When scaling up a Redis cluster or replication group using ModifyCacheCluster + // or ModifyReplicationGroup , use a value from this list for the CacheNodeType + // parameter. ScaleUpModifications []string // Metadata pertaining to the operation's result. diff --git a/service/elasticache/api_op_ListTagsForResource.go b/service/elasticache/api_op_ListTagsForResource.go index f5f6fc11c2c..c457aedf712 100644 --- a/service/elasticache/api_op_ListTagsForResource.go +++ b/service/elasticache/api_op_ListTagsForResource.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 +// 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 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]. +// +// If the cluster is not in the available state, ListTagsForResource returns an // error. +// +// [Resource-level permissions]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -39,10 +43,11 @@ 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]. + // + // [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 diff --git a/service/elasticache/api_op_ModifyCacheCluster.go b/service/elasticache/api_op_ModifyCacheCluster.go index 5c8d0914d1e..d8c4abfcce4 100644 --- a/service/elasticache/api_op_ModifyCacheCluster.go +++ b/service/elasticache/api_op_ModifyCacheCluster.go @@ -38,37 +38,59 @@ type ModifyCacheClusterInput struct { CacheClusterId *string // 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 - // 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. + // single Availability Zone or created across multiple Availability Zones. + // + // Valid 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 + // 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) . + // + // For more information, see AUTH password at [AUTH]. + // + // [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) + // + // For more information, see [Authenticating Users with Redis AUTH] + // + // [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 @@ -81,9 +103,11 @@ type ModifyCacheClusterInput struct { // 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. + // 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 // A valid cache node type that you want to scale this cluster up to. @@ -95,79 +119,118 @@ type ModifyCacheClusterInput struct { CacheParameterGroupName *string // A list of cache security group names to authorize on this cluster. This change - // is asynchronously applied as soon as possible. You can use this parameter only - // with clusters that are created outside of an Amazon Virtual Private Cloud - // (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric - // characters. Must not be "Default". + // is asynchronously applied as soon as possible. + // + // You can use this parameter only with clusters that are created outside of an + // Amazon Virtual Private Cloud (Amazon VPC). + // + // Constraints: 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 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 - // earlier engine version, you must delete the existing cluster and create it anew - // with the earlier engine version. + // + // Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]), 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. + // + // [Selecting a Cache Engine and Version]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement EngineVersion *string // 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 (http://aws.amazon.com/ec2/nitro/) - // . + // engine version 1.6.6 on all instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ IpDiscovery types.IpDiscovery // Specifies the destination, format and type of the logs. LogDeliveryConfigurations []types.LogDeliveryConfigurationRequest - // 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 - // cache nodes being added in this request. Scenarios: + // 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 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 + // 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]. + // + // 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. + // + // - 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. + // + // [Cache Node Considerations for Memcached]: https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html NewAvailabilityZones []string // The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications - // are sent. The Amazon SNS topic owner must be same as the cluster owner. + // are sent. + // + // The Amazon SNS topic owner must be same as the cluster owner. 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 @@ -175,51 +238,69 @@ type ModifyCacheClusterInput struct { // the number of cache nodes pending creation (which may be zero), more nodes are // added. If the value is less than the number of existing cache nodes, nodes are // removed. If the value is equal to the number of current cache nodes, any pending - // add or remove requests are canceled. If you are removing cache nodes, you must - // use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache - // 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 - // 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 - // operations to modify the number of cache nodes in the cluster. For example, a - // request to remove 2 nodes would override a previous pending operation to remove - // 3 nodes. Similarly, a request to add 2 nodes would override a previous pending - // operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be - // provisioned in different Availability Zones with flexible cache node placement, - // a request to add nodes does not automatically override a previous pending - // operation to add nodes. The customer can modify the previous pending operation - // to add more nodes or explicitly cancel the pending request and retry the new - // request. To cancel pending operations to modify the number of cache nodes in a - // cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the - // number of cache nodes currently in the cluster. + // add or remove requests are canceled. + // + // If you are removing cache nodes, you must use the CacheNodeIdsToRemove + // parameter to provide the IDs of the specific cache 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 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 operations to modify + // the number of cache nodes in the cluster. For example, a request to remove 2 + // nodes would override a previous pending operation to remove 3 nodes. Similarly, + // a request to add 2 nodes would override a previous pending operation to remove 3 + // nodes and vice versa. As Memcached cache nodes may now be provisioned in + // different Availability Zones with flexible cache node placement, a request to + // add nodes does not automatically override a previous pending operation to add + // nodes. The customer can modify the previous pending operation to add more nodes + // or explicitly cancel the pending request and retry the new request. To cancel + // pending operations to modify the number of cache nodes in a cluster, use the + // ModifyCacheCluster request and set NumCacheNodes equal to the number of cache + // nodes currently in the cluster. NumCacheNodes *int32 // Specifies the weekly time range during which maintenance on the 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: + // 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 PreferredMaintenanceWindow *string - // Specifies the VPC Security Groups associated with the cluster. This parameter - // can be used only with clusters that are created in an Amazon Virtual Private - // Cloud (Amazon VPC). + // Specifies the VPC Security Groups associated with the cluster. + // + // This parameter can be used only with clusters that are created in an Amazon + // Virtual Private Cloud (Amazon VPC). SecurityGroupIds []string // The number of days for which ElastiCache 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. If - // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + // snapshot that was taken today is retained for 5 days before being deleted. + // + // If the value of SnapshotRetentionLimit is set to zero (0), backups are turned + // off. SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which ElastiCache begins taking a daily diff --git a/service/elasticache/api_op_ModifyCacheParameterGroup.go b/service/elasticache/api_op_ModifyCacheParameterGroup.go index 6321638ea26..8a34236a7ce 100644 --- a/service/elasticache/api_op_ModifyCacheParameterGroup.go +++ b/service/elasticache/api_op_ModifyCacheParameterGroup.go @@ -48,7 +48,9 @@ type ModifyCacheParameterGroupInput struct { } // Represents the output of one of the following operations: +// // - ModifyCacheParameterGroup +// // - ResetCacheParameterGroup type ModifyCacheParameterGroupOutput struct { diff --git a/service/elasticache/api_op_ModifyCacheSubnetGroup.go b/service/elasticache/api_op_ModifyCacheSubnetGroup.go index 74dd189562f..ddcf7a7218e 100644 --- a/service/elasticache/api_op_ModifyCacheSubnetGroup.go +++ b/service/elasticache/api_op_ModifyCacheSubnetGroup.go @@ -30,9 +30,11 @@ 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,7 +51,9 @@ type ModifyCacheSubnetGroupInput struct { type ModifyCacheSubnetGroupOutput struct { // Represents the output of one of the following operations: + // // - CreateCacheSubnetGroup + // // - ModifyCacheSubnetGroup CacheSubnetGroup *types.CacheSubnetGroup diff --git a/service/elasticache/api_op_ModifyGlobalReplicationGroup.go b/service/elasticache/api_op_ModifyGlobalReplicationGroup.go index 5be8f238671..3522cbf33d3 100644 --- a/service/elasticache/api_op_ModifyGlobalReplicationGroup.go +++ b/service/elasticache/api_op_ModifyGlobalReplicationGroup.go @@ -69,6 +69,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_ModifyReplicationGroup.go b/service/elasticache/api_op_ModifyReplicationGroup.go index d92b877c2f8..962fd24ed1e 100644 --- a/service/elasticache/api_op_ModifyReplicationGroup.go +++ b/service/elasticache/api_op_ModifyReplicationGroup.go @@ -13,12 +13,17 @@ import ( // Modifies the settings for a replication group. This is limited to Redis 7 and // newer. -// - 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)] +// - in the ElastiCache User Guide +// +// [ModifyReplicationGroupShardConfiguration] +// - in the ElastiCache API Reference // // This operation is valid for Redis only. +// +// [Scaling for Amazon ElastiCache for Redis (cluster mode enabled)]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/scaling-redis-cluster-mode-enabled.html +// [ModifyReplicationGroupShardConfiguration]: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyReplicationGroupShardConfiguration.html func (c *Client) ModifyReplicationGroup(ctx context.Context, params *ModifyReplicationGroupInput, optFns ...func(*Options)) (*ModifyReplicationGroupOutput, error) { if params == nil { params = &ModifyReplicationGroupInput{} @@ -45,25 +50,40 @@ type ModifyReplicationGroupInput struct { // 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 + // 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) . + // + // For more information, see AUTH password at [AUTH]. + // + // [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) + // + // For more information, see [Authenticating Users with Redis AUTH] + // + // [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 @@ -72,7 +92,9 @@ type ModifyReplicationGroupInput struct { AutoMinorVersionUpgrade *bool // Determines whether a read replica is automatically promoted to read/write - // primary if the existing primary encounters a failure. Valid values: true | false + // primary if the existing primary encounters a failure. + // + // Valid values: true | false AutomaticFailoverEnabled *bool // A valid cache node type that you want to scale this replication group to. @@ -86,9 +108,12 @@ type ModifyReplicationGroupInput struct { // A list of cache security group names to authorize for the clusters in this // 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 . + // running outside of an Amazon Virtual Private Cloud (Amazon VPC). + // + // Constraints: Must contain no more than 255 alphanumeric characters. Must not be + // Default . CacheSecurityGroupNames []string // Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must @@ -99,17 +124,21 @@ type ModifyReplicationGroupInput struct { ClusterMode types.ClusterMode // 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 - // earlier engine version, you must delete the existing replication group and - // create it anew with the earlier engine version. + // replication group. + // + // Important: You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version]), 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. + // + // [Selecting a Cache Engine and Version]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement EngineVersion *string // 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 (http://aws.amazon.com/ec2/nitro/) - // . + // engine version 1.6.6 on all instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ IpDiscovery types.IpDiscovery // Specifies the destination, format and type of the logs. @@ -124,26 +153,37 @@ type ModifyReplicationGroupInput struct { NodeGroupId *string // The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications - // are sent. The Amazon SNS topic owner must be same as the replication group - // owner. + // are sent. + // + // The Amazon SNS topic owner must be same as the replication group owner. 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 | - // inactive + // Notifications are sent only if the status is active . + // + // Valid values: active | inactive NotificationTopicStatus *string // Specifies the weekly time range during which maintenance on the 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: + // 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 PreferredMaintenanceWindow *string @@ -160,21 +200,28 @@ type ModifyReplicationGroupInput struct { ReplicationGroupDescription *string // Specifies the VPC Security Groups associated with the clusters in the - // replication group. This parameter can be used only with replication group - // containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC). + // replication group. + // + // This parameter can be used only with replication group containing clusters + // running in an Amazon Virtual Private Cloud (Amazon VPC). SecurityGroupIds []string // The number of days for which ElastiCache retains automatic node group (shard) // 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. Important If the value of SnapshotRetentionLimit is set to zero (0), - // backups are turned off. + // deleted. + // + // Important If the value of SnapshotRetentionLimit is set to zero (0), backups + // are turned off. 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: - // 05:00-09:00 If you do not specify this parameter, ElastiCache automatically - // chooses an appropriate time range. + // 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 // The cluster ID that is used as the daily snapshot source for the replication @@ -188,13 +235,16 @@ type ModifyReplicationGroupInput struct { 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 - // TransitEncryptionMode to required is a two-step process that requires you to - // first set the TransitEncryptionMode to preferred , after that you can set + // 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 , after that you can set // TransitEncryptionMode to required . TransitEncryptionMode types.TransitEncryptionMode diff --git a/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go b/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go index baa4739f566..f29a551be7c 100644 --- a/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go +++ b/service/elasticache/api_op_ModifyReplicationGroupShardConfiguration.go @@ -32,7 +32,9 @@ func (c *Client) ModifyReplicationGroupShardConfiguration(ctx context.Context, p type ModifyReplicationGroupShardConfigurationInput struct { // Indicates that the shard reconfiguration process begins immediately. At - // present, the only permitted value for this parameter is true . Value: true + // present, the only permitted value for this parameter is true . + // + // Value: true // // This member is required. ApplyImmediately *bool @@ -52,6 +54,7 @@ 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 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 @@ -59,17 +62,19 @@ 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. // 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. + // + // 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). + // 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 8c6a2cd5556..b6219cf1399 100644 --- a/service/elasticache/api_op_PurchaseReservedCacheNodesOffering.go +++ b/service/elasticache/api_op_PurchaseReservedCacheNodesOffering.go @@ -12,10 +12,10 @@ 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) -// for Memcached. +// eligible for cancellation and are non-refundable. For more information, see [Managing Costs with Reserved Nodes]for +// Redis or [Managing Costs with Reserved Nodes]for Memcached. +// +// [Managing Costs with Reserved Nodes]: https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html func (c *Client) PurchaseReservedCacheNodesOffering(ctx context.Context, params *PurchaseReservedCacheNodesOfferingInput, optFns ...func(*Options)) (*PurchaseReservedCacheNodesOfferingOutput, error) { if params == nil { params = &PurchaseReservedCacheNodesOfferingInput{} @@ -34,19 +34,25 @@ func (c *Client) PurchaseReservedCacheNodesOffering(ctx context.Context, params // Represents the input of a PurchaseReservedCacheNodesOffering operation. type PurchaseReservedCacheNodesOfferingInput struct { - // The ID of the reserved cache node offering to purchase. Example: - // 438012d3-4052-4cc7-b2e3-8d3372e0e706 + // The ID of the reserved cache node offering to purchase. + // + // Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 // // This member is required. ReservedCacheNodesOfferingId *string - // The number of cache node instances to reserve. Default: 1 + // The number of cache node instances to reserve. + // + // Default: 1 CacheNodeCount *int32 - // A customer-specified identifier to track this reservation. The Reserved Cache - // Node ID is an unique customer-specified identifier to track this reservation. If - // this parameter is not specified, ElastiCache automatically generates an - // identifier for the reservation. Example: myreservationID + // A customer-specified identifier to track this reservation. + // + // The Reserved Cache Node ID is an unique customer-specified identifier to track + // this reservation. If this parameter is not specified, ElastiCache automatically + // generates an identifier for the reservation. + // + // Example: myreservationID ReservedCacheNodeId *string // A list of tags to be added to this resource. A tag is a key-value pair. A tag diff --git a/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go b/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go index 3abde4fd43c..a0cd16761ca 100644 --- a/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go +++ b/service/elasticache/api_op_RebalanceSlotsInGlobalReplicationGroup.go @@ -49,6 +49,7 @@ 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. GlobalReplicationGroup *types.GlobalReplicationGroup diff --git a/service/elasticache/api_op_RebootCacheCluster.go b/service/elasticache/api_op_RebootCacheCluster.go index 6344699fb25..0bf17acecc4 100644 --- a/service/elasticache/api_op_RebootCacheCluster.go +++ b/service/elasticache/api_op_RebootCacheCluster.go @@ -14,14 +14,21 @@ import ( // Reboots some, or all, of the cache nodes within a provisioned cluster. This // operation applies any modified cache parameter groups to the cluster. The reboot // operation takes place as soon as possible, and results in a momentary outage to -// the cluster. During the reboot, the cluster status is set to REBOOTING. The -// reboot causes the contents of the cache (for each cache node being rebooted) to -// be lost. When the reboot is complete, a cluster event is created. Rebooting a -// cluster is currently supported on Memcached and Redis (cluster mode disabled) -// clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. +// the cluster. During the reboot, the cluster status is set to REBOOTING. +// +// The reboot causes the contents of the cache (for each cache node being +// rebooted) to be lost. +// +// When the reboot is complete, a cluster event is created. +// +// Rebooting a 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) -// for an alternate process. +// cluster reboot for the changes to be applied, see [Rebooting a Cluster]for an alternate process. +// +// [Rebooting a Cluster]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes.rebooting.html func (c *Client) RebootCacheCluster(ctx context.Context, params *RebootCacheClusterInput, optFns ...func(*Options)) (*RebootCacheClusterOutput, error) { if params == nil { params = &RebootCacheClusterInput{} diff --git a/service/elasticache/api_op_RemoveTagsFromResource.go b/service/elasticache/api_op_RemoveTagsFromResource.go index d4492a9d364..5e4fefe3958 100644 --- a/service/elasticache/api_op_RemoveTagsFromResource.go +++ b/service/elasticache/api_op_RemoveTagsFromResource.go @@ -16,8 +16,9 @@ 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]. +// +// [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 +39,11 @@ 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 - // 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) - // . + // or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot . + // + // For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Service Namespaces]. + // + // [Amazon 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 diff --git a/service/elasticache/api_op_ResetCacheParameterGroup.go b/service/elasticache/api_op_ResetCacheParameterGroup.go index 0fa80c196af..88b066d951e 100644 --- a/service/elasticache/api_op_ResetCacheParameterGroup.go +++ b/service/elasticache/api_op_ResetCacheParameterGroup.go @@ -46,14 +46,18 @@ type ResetCacheParameterGroupInput struct { // 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 + // to their default values. + // + // Valid values: true | false ResetAllParameters *bool noSmithyDocumentSerde } // Represents the output of one of the following operations: +// // - ModifyCacheParameterGroup +// // - ResetCacheParameterGroup type ResetCacheParameterGroupOutput struct { diff --git a/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go b/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go index ca844feb5ac..effcd4784a2 100644 --- a/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go +++ b/service/elasticache/api_op_RevokeCacheSecurityGroupIngress.go @@ -54,8 +54,11 @@ type RevokeCacheSecurityGroupIngressInput struct { type RevokeCacheSecurityGroupIngressOutput struct { // Represents the output of one of the following operations: + // // - AuthorizeCacheSecurityGroupIngress + // // - CreateCacheSecurityGroup + // // - RevokeCacheSecurityGroupIngress CacheSecurityGroup *types.CacheSecurityGroup diff --git a/service/elasticache/api_op_TestFailover.go b/service/elasticache/api_op_TestFailover.go index 3882bdfc402..9f0778fafff 100644 --- a/service/elasticache/api_op_TestFailover.go +++ b/service/elasticache/api_op_TestFailover.go @@ -13,37 +13,56 @@ import ( // Represents the input of a TestFailover operation which test automatic failover // on a specified node group (called shard in the console) in a replication group -// (called cluster in the console). This API is designed for testing the behavior -// of your application in case of ElastiCache failover. It is not designed to be an -// 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 +// (called cluster in the console). +// +// This API is designed for testing the behavior of your application in case of +// ElastiCache failover. It is not designed to be an 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 -// -// Also see, Testing Multi-AZ (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test) -// in the ElastiCache User Guide. +// +// - Cache cluster message: Finished recovery for cache nodes +// +// For more information see: +// +// [Viewing ElastiCache Events] +// - in the ElastiCache User Guide +// +// [DescribeEvents] +// - in the ElastiCache API Reference +// +// Also see, [Testing Multi-AZ] in the ElastiCache User Guide. +// +// [DescribeEvents]: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html +// [Testing Multi-AZ]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test +// [Viewing ElastiCache Events]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html func (c *Client) TestFailover(ctx context.Context, params *TestFailoverInput, optFns ...func(*Options)) (*TestFailoverOutput, error) { if params == nil { params = &TestFailoverInput{} diff --git a/service/elasticache/api_op_TestMigration.go b/service/elasticache/api_op_TestMigration.go index 8502bb42605..f4526830e07 100644 --- a/service/elasticache/api_op_TestMigration.go +++ b/service/elasticache/api_op_TestMigration.go @@ -29,13 +29,13 @@ func (c *Client) TestMigration(ctx context.Context, params *TestMigrationInput, type TestMigrationInput struct { - // List of endpoints from which data should be migrated. List should have only one - // element. + // List of endpoints from which data should be migrated. List should have only + // one element. // // This member is required. CustomerNodeEndpointList []types.CustomerNodeEndpoint - // The ID of the replication group to which data is to be migrated. + // The ID of the replication group to which data is to be migrated. // // This member is required. ReplicationGroupId *string diff --git a/service/elasticache/doc.go b/service/elasticache/doc.go index ae72b3c85d4..95a62666bba 100644 --- a/service/elasticache/doc.go +++ b/service/elasticache/doc.go @@ -3,13 +3,17 @@ // 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, -// customers get all of the benefits of a high-performance, in-memory cache with -// less of the administrative burden involved in launching and managing a -// distributed cache. The service makes setup, scaling, and cluster failure -// handling much simpler than in a self-managed cache deployment. In addition, -// through integration with Amazon CloudWatch, customers get enhanced visibility -// into the key performance statistics associated with their cache and can receive -// alarms if a part of their cache runs hot. +// # 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, customers get all of the benefits of a high-performance, +// in-memory cache with less of the administrative burden involved in launching and +// managing a distributed cache. The service makes setup, scaling, and cluster +// failure handling much simpler than in a self-managed cache deployment. +// +// In addition, through integration with Amazon CloudWatch, customers get enhanced +// visibility into the key performance statistics associated with their cache and +// can receive alarms if a part of their cache runs hot. package elasticache diff --git a/service/elasticache/options.go b/service/elasticache/options.go index 8ff05b5d872..02db85560a0 100644 --- a/service/elasticache/options.go +++ b/service/elasticache/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elasticache/types/enums.go b/service/elasticache/types/enums.go index a5735f6e238..1ce4d607fe9 100644 --- a/service/elasticache/types/enums.go +++ b/service/elasticache/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "password", @@ -31,8 +32,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SETTING", @@ -51,6 +53,7 @@ const ( // Values returns all known values for AuthTokenUpdateStrategyType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuthTokenUpdateStrategyType) Values() []AuthTokenUpdateStrategyType { return []AuthTokenUpdateStrategyType{ @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for AutomaticFailoverStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomaticFailoverStatus) Values() []AutomaticFailoverStatus { return []AutomaticFailoverStatus{ "enabled", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for AZMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AZMode) Values() []AZMode { return []AZMode{ "single-az", @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "immediate", @@ -128,8 +134,9 @@ const ( ) // Values returns all known values for ClusterMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterMode) Values() []ClusterMode { return []ClusterMode{ "enabled", @@ -146,8 +153,9 @@ const ( ) // Values returns all known values for DataStorageUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataStorageUnit) Values() []DataStorageUnit { return []DataStorageUnit{ "GB", @@ -163,8 +171,9 @@ const ( ) // Values returns all known values for DataTieringStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataTieringStatus) Values() []DataTieringStatus { return []DataTieringStatus{ "enabled", @@ -181,8 +190,9 @@ const ( ) // Values returns all known values for DestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationType) Values() []DestinationType { return []DestinationType{ "cloudwatch-logs", @@ -200,8 +210,9 @@ const ( ) // Values returns all known values for InputAuthenticationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputAuthenticationType) Values() []InputAuthenticationType { return []InputAuthenticationType{ "password", @@ -219,8 +230,9 @@ const ( ) // Values returns all known values for IpDiscovery. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpDiscovery) Values() []IpDiscovery { return []IpDiscovery{ "ipv4", @@ -241,8 +253,9 @@ const ( // Values returns all known values for LogDeliveryConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogDeliveryConfigurationStatus) Values() []LogDeliveryConfigurationStatus { return []LogDeliveryConfigurationStatus{ "active", @@ -262,8 +275,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -280,8 +294,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "slow-log", @@ -298,8 +313,9 @@ const ( ) // Values returns all known values for MultiAZStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MultiAZStatus) Values() []MultiAZStatus { return []MultiAZStatus{ "enabled", @@ -317,8 +333,9 @@ const ( ) // Values returns all known values for NetworkType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkType) Values() []NetworkType { return []NetworkType{ "ipv4", @@ -336,8 +353,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "system", @@ -358,8 +376,9 @@ const ( ) // Values returns all known values for NodeUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeUpdateStatus) Values() []NodeUpdateStatus { return []NodeUpdateStatus{ "not-applied", @@ -380,8 +399,9 @@ const ( ) // Values returns all known values for OutpostMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutpostMode) Values() []OutpostMode { return []OutpostMode{ "single-outpost", @@ -399,8 +419,9 @@ const ( // Values returns all known values for PendingAutomaticFailoverStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PendingAutomaticFailoverStatus) Values() []PendingAutomaticFailoverStatus { return []PendingAutomaticFailoverStatus{ "enabled", @@ -419,8 +440,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "critical", @@ -440,8 +462,9 @@ const ( ) // Values returns all known values for ServiceUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceUpdateStatus) Values() []ServiceUpdateStatus { return []ServiceUpdateStatus{ "available", @@ -458,8 +481,9 @@ const ( ) // Values returns all known values for ServiceUpdateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceUpdateType) Values() []ServiceUpdateType { return []ServiceUpdateType{ "security-update", @@ -476,8 +500,9 @@ const ( ) // Values returns all known values for SlaMet. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlaMet) Values() []SlaMet { return []SlaMet{ "yes", @@ -502,8 +527,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "cache-cluster", @@ -527,8 +553,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "preferred", @@ -552,8 +579,9 @@ const ( ) // Values returns all known values for UpdateActionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateActionStatus) Values() []UpdateActionStatus { return []UpdateActionStatus{ "not-applied", diff --git a/service/elasticache/types/errors.go b/service/elasticache/types/errors.go index b406f7cf302..4eafea47a44 100644 --- a/service/elasticache/types/errors.go +++ b/service/elasticache/types/errors.go @@ -613,8 +613,9 @@ 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) -// in the ElastiCache User Guide. +// Zone. For more information, see [InsufficientCacheClusterCapacity]in the ElastiCache User Guide. +// +// [InsufficientCacheClusterCapacity]: http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ErrorMessages.html#ErrorMessages.INSUFFICIENT_CACHE_CLUSTER_CAPACITY type InsufficientCacheClusterCapacityFault struct { Message *string @@ -1702,8 +1703,10 @@ 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. // diff --git a/service/elasticache/types/types.go b/service/elasticache/types/types.go index 97b9b679e83..eca9da7de75 100644 --- a/service/elasticache/types/types.go +++ b/service/elasticache/types/types.go @@ -47,14 +47,20 @@ 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. + // // Default: false AuthTokenEnabled *bool @@ -78,57 +84,102 @@ type CacheCluster struct { // 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 + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // A list of cache nodes that are members of the cluster. @@ -150,7 +201,9 @@ type CacheCluster struct { // Represents a Memcached cluster endpoint which can be used by an application to // connect to any node in the cluster. The configuration endpoint will always have - // .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211 + // .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. @@ -161,8 +214,9 @@ type CacheCluster struct { // 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 (http://aws.amazon.com/ec2/nitro/) - // . + // engine version 1.6.6 on all instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ IpDiscovery IpDiscovery // Returns the destination, format and type of the logs. @@ -170,7 +224,9 @@ type CacheCluster struct { // 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 (http://aws.amazon.com/ec2/nitro/) . + // instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ NetworkType NetworkType // Describes a notification topic and its status. Notification topics are used for @@ -178,9 +234,10 @@ 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 @@ -193,15 +250,24 @@ type CacheCluster struct { // Specifies the weekly time range during which maintenance on the 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: + // 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 PreferredMaintenanceWindow *string @@ -221,17 +287,24 @@ type CacheCluster struct { // The number of days for which ElastiCache 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. If - // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + // snapshot that was taken today is retained for 5 days before being deleted. + // + // If the value of SnapshotRetentionLimit is set to zero (0), backups are turned + // off. SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which ElastiCache begins taking a daily - // snapshot of your cluster. Example: 05:00-09:00 + // snapshot of your cluster. + // + // Example: 05:00-09:00 SnapshotWindow *string - // 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 + // 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 TransitEncryptionEnabled *bool // A setting that allows you to migrate your clients to use in-transit encryption, @@ -251,6 +324,7 @@ type CacheEngineVersion struct { CacheEngineVersionDescription *string // The name of the cache parameter group family associated with this cache engine. + // // Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | // redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7 CacheParameterGroupFamily *string @@ -266,57 +340,114 @@ type CacheEngineVersion struct { // Represents an individual cache node within a cluster. Each cache node runs its // own instance of the cluster's protocol-compliant caching software - either -// Memcached or Redis. 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. +// Memcached or Redis. +// +// 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , -// cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge -// , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -// 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 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: +// +// - Current generation: +// +// M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , +// +// cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , +// cache.m7g.16xlarge +// +// For region availability, see [Supported Node Types] +// +// 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 +// +// 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.) C1 -// node types: cache.c1.xlarge +// 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: R7g node types: cache.r7g.large , cache.r7g.xlarge , -// cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge -// , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) -// 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 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 , +// +// - Current generation: +// +// R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , +// +// cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , +// cache.r7g.16xlarge +// +// For region availability, see [Supported Node Types] +// +// 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 +// +// 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. +// +// [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion type CacheNode struct { // The date and time when the cache node was created. @@ -363,8 +494,9 @@ type CacheNodeTypeSpecificParameter struct { // 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) - // . + // next maintenance window's reboot. For more information, see [Rebooting a Cluster]. + // + // [Rebooting a Cluster]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html ChangeType ChangeType // The valid data type for the parameter. @@ -440,8 +572,10 @@ type CacheParameterGroup struct { ARN *string // The name of the cache parameter group family that this cache parameter group is - // compatible with. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | - // redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7 + // compatible with. + // + // Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | + // redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7 CacheParameterGroupFamily *string // The name of the cache parameter group. @@ -473,8 +607,11 @@ type CacheParameterGroupStatus struct { } // Represents the output of one of the following operations: +// // - AuthorizeCacheSecurityGroupIngress +// // - CreateCacheSecurityGroup +// // - RevokeCacheSecurityGroupIngress type CacheSecurityGroup struct { @@ -512,7 +649,9 @@ type CacheSecurityGroupMembership struct { } // Represents the output of one of the following operations: +// // - CreateCacheSubnetGroup +// // - ModifyCacheSubnetGroup type CacheSubnetGroup struct { @@ -530,7 +669,9 @@ type CacheSubnetGroup struct { // 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 (http://aws.amazon.com/ec2/nitro/) . + // built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ SupportedNetworkTypes []NetworkType // The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. @@ -542,7 +683,7 @@ type CacheSubnetGroup struct { // The usage limits for storage and ElastiCache Processing Units for the cache. type CacheUsageLimits struct { - // The maximum data storage limit in the cache, expressed in Gigabytes. + // The maximum data storage limit in the cache, expressed in Gigabytes. DataStorage *DataStorage // The configuration for the number of ElastiCache Processing Units (ECPU) the @@ -568,11 +709,16 @@ 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: + // 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) // @@ -581,8 +727,9 @@ type ConfigureShard struct { // 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]. + // + // [Finding a Shard's Id]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/shard-find-id.html // // This member is required. NodeGroupId *string @@ -694,9 +841,10 @@ type EngineDefaults struct { CacheNodeTypeSpecificParameters []CacheNodeTypeSpecificParameter // 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 | redis7 + // 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 | redis7 CacheParameterGroupFamily *string // Provides an identifier to allow retrieval of paginated results. @@ -762,6 +910,7 @@ 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. type GlobalReplicationGroup struct { @@ -769,15 +918,18 @@ 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 - // 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. + // 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 *bool // A flag that enables using an AuthToken (password) when issuing Redis commands. + // // Default: false AuthTokenEnabled *bool @@ -808,9 +960,10 @@ type GlobalReplicationGroup struct { // The status of the Global datastore Status *string - // 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. + // 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. TransitEncryptionEnabled *bool noSmithyDocumentSerde @@ -874,7 +1027,9 @@ type LogDeliveryConfiguration struct { // Returns the log format, either JSON or TEXT. LogFormat LogFormat - // Refers to slow-log (https://redis.io/commands/slowlog) or engine-log. + // Refers to [slow-log] or engine-log. + // + // [slow-log]: https://redis.io/commands/slowlog LogType LogType // Returns an error message for the log delivery configuration. @@ -903,7 +1058,9 @@ type LogDeliveryConfigurationRequest struct { // Specifies either JSON or TEXT LogFormat LogFormat - // Refers to slow-log (https://redis.io/commands/slowlog) or engine-log.. + // Refers to [slow-log] or engine-log.. + // + // [slow-log]: https://redis.io/commands/slowlog LogType LogType noSmithyDocumentSerde @@ -970,8 +1127,9 @@ 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: - // "0-3999" + // range from 0 to 16,383. The string is in the format startkey-endkey . + // + // Example: "0-3999" Slots *string noSmithyDocumentSerde @@ -1102,8 +1260,9 @@ type Parameter struct { // 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) - // . + // next maintenance window's reboot. For more information, see [Rebooting a Cluster]. + // + // [Rebooting a Cluster]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html ChangeType ChangeType // The valid data type for the parameter. @@ -1157,7 +1316,9 @@ type PendingLogDeliveryConfiguration struct { // Returns the log format, either JSON or TEXT LogFormat LogFormat - // Refers to slow-log (https://redis.io/commands/slowlog) or engine-log.. + // Refers to [slow-log] or engine-log.. + // + // [slow-log]: https://redis.io/commands/slowlog LogType LogType noSmithyDocumentSerde @@ -1183,9 +1344,10 @@ type PendingModifiedValues struct { // The log delivery configurations being modified LogDeliveryConfigurations []PendingLogDeliveryConfiguration - // The new number of cache nodes for the cluster. For clusters running Redis, this - // value must be 1. For clusters running Memcached, this value must be between 1 - // and 40. + // The new number of cache nodes for 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 flag that enables in-transit encryption when set to true. @@ -1257,14 +1419,20 @@ 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 - // 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 + // 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 AtRestEncryptionEnabled *bool // A flag that enables using an AuthToken (password) when issuing Redis commands. + // // Default: false AuthTokenEnabled *bool @@ -1285,7 +1453,9 @@ type ReplicationGroup struct { // A flag indicating whether or not this replication group is cluster enabled; // i.e., whether its data can be partitioned across multiple shards (API/CLI: node - // groups). Valid values: true | false + // groups). + // + // Valid values: true | false ClusterEnabled *bool // Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must @@ -1301,8 +1471,9 @@ 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]. + // + // [Data tiering]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html DataTiering DataTieringStatus // The user supplied description of the replication group. @@ -1314,8 +1485,9 @@ type ReplicationGroup struct { // 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 (http://aws.amazon.com/ec2/nitro/) - // . + // engine version 1.6.6 on all instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ IpDiscovery IpDiscovery // The ID of the KMS key used to encrypt the disk in the cluster. @@ -1331,12 +1503,16 @@ 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] + // + // [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 // Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all - // instances built on the Nitro system (http://aws.amazon.com/ec2/nitro/) . + // instances built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ NetworkType NetworkType // A list of node groups in this replication group. For Redis (cluster mode @@ -1357,13 +1533,20 @@ type ReplicationGroup struct { // The number of days for which ElastiCache 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. If - // the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. + // snapshot that was taken today is retained for 5 days before being deleted. + // + // If the value of SnapshotRetentionLimit is set to zero (0), backups are turned + // off. 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. + // 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 . SnapshotWindow *string @@ -1375,9 +1558,12 @@ type ReplicationGroup struct { // deleting , create-failed , snapshotting . Status *string - // 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 + // 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 TransitEncryptionEnabled *bool // A setting that allows you to migrate your clients to use in-transit encryption, @@ -1436,57 +1622,102 @@ type ReservedCacheNode struct { // The number of cache nodes that have been reserved. CacheNodeCount *int32 - // The cache node type for the reserved cache nodes. 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. + // The cache node type for the reserved cache nodes. + // + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // The duration of the reservation in seconds. @@ -1504,7 +1735,9 @@ type ReservedCacheNode struct { // The recurring price charged to run this reserved cache node. RecurringCharges []RecurringCharge - // The Amazon Resource Name (ARN) of the reserved cache node. Example: + // The Amazon Resource Name (ARN) of the reserved cache node. + // + // Example: // arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582 ReservationARN *string @@ -1529,57 +1762,102 @@ type ReservedCacheNode struct { // Describes all of the attributes of a reserved cache node offering. type ReservedCacheNodesOffering struct { - // The cache node type for the reserved cache node. 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. + // The cache node type for the reserved cache node. + // + // 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // The duration of the offering. in seconds. @@ -1793,9 +2071,9 @@ type ServiceUpdate struct { 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) - // . + // compliance. For information on compliance, see [Self-Service Security Updates for Compliance]. + // + // [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 @@ -1845,56 +2123,101 @@ type Snapshot struct { CacheClusterId *string // The name of the compute and memory capacity node type for the source 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: M7g node types: cache.m7g.large , cache.m7g.xlarge , - // cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge - // , cache.m7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // 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 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 + // + // - Current generation: + // + // M7g node types: cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , + // cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , + // cache.m7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 + // + // 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 + // 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 + // supported but creation of new clusters is not supported for these types.) + // + // C1 node types: cache.c1.xlarge + // // - Memory optimized: - // - Current generation: R7g node types: cache.r7g.large , cache.r7g.xlarge , - // cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge - // , cache.r7g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) - // R6g node types (available only for Redis engine version 5.0.6 onward and for + // + // - Current generation: + // + // R7g node types: cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , + // cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , + // cache.r7g.16xlarge + // + // For region availability, see [Supported Node Types] + // + // 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 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.r6g.16xlarge + // + // 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 , + // 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. + // + // [Supported Node Types]: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion CacheNodeType *string // The cache parameter group that is associated with the source cluster. @@ -1905,8 +2228,9 @@ 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]. + // + // [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. @@ -1921,9 +2245,10 @@ type Snapshot struct { // A list of the cache nodes in the source cluster. NodeSnapshots []NodeSnapshot - // The number of cache nodes in the source 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 source cluster. + // + // For clusters running Redis, this value must be 1. For clusters running + // Memcached, this value must be between 1 and 40. NumCacheNodes *int32 // The number of node groups (shards) in this snapshot. When restoring from a @@ -1939,15 +2264,24 @@ type Snapshot struct { // Specifies the weekly time range during which maintenance on the 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: + // 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 PreferredMaintenanceWindow *string @@ -1965,11 +2299,15 @@ type Snapshot struct { SnapshotName *string // For an automatic snapshot, the number of days for which ElastiCache retains the - // snapshot before deleting it. For manual snapshots, this field reflects the - // SnapshotRetentionLimit for the source cluster when the snapshot was created. - // This field is otherwise ignored: Manual snapshots do not expire, and can only be - // deleted using the DeleteSnapshot operation. Important If the value of - // SnapshotRetentionLimit is set to zero (0), backups are turned off. + // snapshot before deleting it. + // + // For manual snapshots, this field reflects the SnapshotRetentionLimit for the + // source cluster when the snapshot was created. This field is otherwise ignored: + // Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot + // operation. + // + // Important If the value of SnapshotRetentionLimit is set to zero (0), backups + // are turned off. SnapshotRetentionLimit *int32 // Indicates whether the snapshot is from an automatic backup ( automated ) or was @@ -2011,7 +2349,9 @@ type Subnet struct { // 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 (http://aws.amazon.com/ec2/nitro/) . + // built on the [Nitro system]. + // + // [Nitro system]: http://aws.amazon.com/ec2/nitro/ SupportedNetworkTypes []NetworkType noSmithyDocumentSerde @@ -2105,8 +2445,9 @@ 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]. + // + // [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_op_ApplyEnvironmentManagedAction.go b/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go index fb6063e191f..d6c2f565b72 100644 --- a/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go +++ b/service/elasticbeanstalk/api_op_ApplyEnvironmentManagedAction.go @@ -13,7 +13,7 @@ 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 . +// 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 a544f8b82bd..fbe316eb725 100644 --- a/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go +++ b/service/elasticbeanstalk/api_op_AssociateEnvironmentOperationsRole.go @@ -13,8 +13,9 @@ 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) -// in the AWS Elastic Beanstalk Developer Guide. +// information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. +// +// [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html func (c *Client) AssociateEnvironmentOperationsRole(ctx context.Context, params *AssociateEnvironmentOperationsRoleInput, optFns ...func(*Options)) (*AssociateEnvironmentOperationsRoleOutput, error) { if params == nil { params = &AssociateEnvironmentOperationsRoleInput{} diff --git a/service/elasticbeanstalk/api_op_CheckDNSAvailability.go b/service/elasticbeanstalk/api_op_CheckDNSAvailability.go index 536d8850ba9..7c1c3aec50f 100644 --- a/service/elasticbeanstalk/api_op_CheckDNSAvailability.go +++ b/service/elasticbeanstalk/api_op_CheckDNSAvailability.go @@ -41,12 +41,13 @@ type CheckDNSAvailabilityInput struct { type CheckDNSAvailabilityOutput struct { // Indicates if the specified CNAME is 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 - // provided prefix. + // The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix. FullyQualifiedCNAME *string // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_ComposeEnvironments.go b/service/elasticbeanstalk/api_op_ComposeEnvironments.go index 249e1a0e412..0130c3320e4 100644 --- a/service/elasticbeanstalk/api_op_ComposeEnvironments.go +++ b/service/elasticbeanstalk/api_op_ComposeEnvironments.go @@ -15,8 +15,9 @@ import ( // 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) -// for details. +// bundles in an environment manifest named env.yaml . See [Compose Environments] for details. +// +// [Compose Environments]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html func (c *Client) ComposeEnvironments(ctx context.Context, params *ComposeEnvironmentsInput, optFns ...func(*Options)) (*ComposeEnvironmentsOutput, error) { if params == nil { params = &ComposeEnvironmentsInput{} @@ -40,8 +41,9 @@ 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) - // for details. + // ends with a + (plus) character. See [Environment Manifest (env.yaml)]for details. + // + // [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html GroupName *string // A list of version labels, specifying one or more application source bundles @@ -57,7 +59,7 @@ type ComposeEnvironmentsInput struct { // Result message containing a list of environment descriptions. type ComposeEnvironmentsOutput struct { - // Returns an EnvironmentDescription list. + // Returns an EnvironmentDescription list. Environments []types.EnvironmentDescription // In a paginated request, the token that you can pass in a subsequent request to diff --git a/service/elasticbeanstalk/api_op_CreateApplication.go b/service/elasticbeanstalk/api_op_CreateApplication.go index 11b628b7c67..c37fb7f3ca9 100644 --- a/service/elasticbeanstalk/api_op_CreateApplication.go +++ b/service/elasticbeanstalk/api_op_CreateApplication.go @@ -43,9 +43,10 @@ type CreateApplicationInput struct { // application from accumulating too many versions. ResourceLifecycleConfig *types.ApplicationResourceLifecycleConfig - // Specifies the tags applied to the application. Elastic Beanstalk applies these - // tags only to the application. Environments that you create in the application - // don't inherit the tags. + // Specifies the tags applied to the application. + // + // Elastic Beanstalk applies these tags only to the application. Environments that + // you create in the application don't inherit the tags. Tags []types.Tag noSmithyDocumentSerde @@ -54,7 +55,7 @@ type CreateApplicationInput struct { // Result message containing a single description of an application. type CreateApplicationOutput struct { - // The ApplicationDescription of the application. + // The ApplicationDescription of the application. Application *types.ApplicationDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_CreateApplicationVersion.go b/service/elasticbeanstalk/api_op_CreateApplicationVersion.go index 5fd1c2f879b..4e158c59157 100644 --- a/service/elasticbeanstalk/api_op_CreateApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_CreateApplicationVersion.go @@ -13,15 +13,22 @@ 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 -// 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 -// can't change that Amazon S3 location. If you change the Amazon S3 location, you -// receive an exception when you attempt to launch an environment from the -// application version. +// 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 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 can't change that Amazon S3 location. If you change the Amazon +// S3 location, you receive an exception when you attempt to launch an environment +// from the application version. func (c *Client) CreateApplicationVersion(ctx context.Context, params *CreateApplicationVersionInput, optFns ...func(*Options)) (*CreateApplicationVersionOutput, error) { if params == nil { params = &CreateApplicationVersionInput{} @@ -39,15 +46,17 @@ 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 + // The name of the application. If no application is found with this name, and // 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 - // application, AWS Elastic Beanstalk returns an InvalidParameterValue error. + // 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. VersionLabel *string @@ -65,12 +74,15 @@ type CreateApplicationVersionInput struct { // 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 - // Docker configuration. + // 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 Docker + // configuration. Process *bool // Specify a commit in an AWS CodeCommit Git repository to use as the source code @@ -78,16 +90,19 @@ type CreateApplicationVersionInput struct { 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 - // environment. Specify a source bundle in S3 or a commit in an AWS CodeCommit - // repository (with SourceBuildInformation ), but not both. If neither SourceBundle - // nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample - // application. + // 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 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 - // application version don't inherit the tags. + // 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 noSmithyDocumentSerde @@ -96,7 +111,7 @@ type CreateApplicationVersionInput struct { // Result message wrapping a single description of an application version. type CreateApplicationVersionOutput struct { - // The ApplicationVersionDescription of the application version. + // The ApplicationVersionDescription of the application version. ApplicationVersion *types.ApplicationVersionDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go b/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go index 6b2bc55150d..116bf7f6fe9 100644 --- a/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_CreateConfigurationTemplate.go @@ -16,11 +16,18 @@ import ( // specific Elastic Beanstalk application. You define application configuration // 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 +// configuration settings. +// +// Templates aren't associated with any environment. The 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{} @@ -45,8 +52,9 @@ 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 @@ -62,14 +70,18 @@ type CreateConfigurationTemplateInput struct { // 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]in the AWS Elastic Beanstalk Developer + // Guide. + // + // [Option Values]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html 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 . + // see [Custom Platforms]in the AWS Elastic Beanstalk Developer Guide. + // + // If you specify PlatformArn , then don't specify SolutionStackName . + // + // [Custom Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html PlatformArn *string // The name of an Elastic Beanstalk solution stack (platform version) that this @@ -77,21 +89,31 @@ type CreateConfigurationTemplateInput struct { // 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) - // 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) - // API to obtain a list of available solution stacks. + // information, see [Supported Platforms]in the AWS Elastic Beanstalk Developer Guide. + // + // You must specify SolutionStackName if you don't specify PlatformArn , + // EnvironmentId , or SourceConfiguration . + // + // Use the [ListAvailableSolutionStacks]ListAvailableSolutionStacks API to obtain a list of available solution + // stacks. + // + // [Supported Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html + // [ListAvailableSolutionStacks]: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html 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 - // configuration are specified, the solution stack of the source configuration - // template must match the specified solution stack name. + // 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 configuration are specified, + // the solution stack of the source configuration template must match the specified + // solution stack name. SourceConfiguration *types.SourceConfiguration // Specifies the tags applied to the configuration template. @@ -112,21 +134,25 @@ type CreateConfigurationTemplateOutput struct { // The date (in UTC time) when this configuration set was last modified. DateUpdated *time.Time - // If this configuration set is associated with an environment, the + // 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. 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. @@ -138,7 +164,8 @@ 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 e6e2d3c7ffb..450b1c08ad1 100644 --- a/service/elasticbeanstalk/api_op_CreateEnvironment.go +++ b/service/elasticbeanstalk/api_op_CreateEnvironment.go @@ -45,19 +45,23 @@ type CreateEnvironmentInput struct { // Your description for this environment. Description *string - // A unique name for the environment. Constraint: Must be from 4 to 40 characters - // in length. The name can contain only letters, numbers, and hyphens. It can't - // start or end with a hyphen. This name must be unique within a region in your - // account. If the specified name already exists in the region, Elastic Beanstalk - // returns an InvalidParameterValue error. If you don't specify the CNAMEPrefix - // parameter, the environment name becomes part of the CNAME, and therefore part of - // the visible URL for your application. + // A unique name for the environment. + // + // Constraint: Must be from 4 to 40 characters in length. The name can contain + // only letters, numbers, and hyphens. It can't start or end with a hyphen. This + // name must be unique within a region in your account. If the specified name + // already exists in the region, Elastic Beanstalk returns an InvalidParameterValue + // error. + // + // If you don't specify the CNAMEPrefix parameter, the environment name becomes + // part of the CNAME, and therefore part of the visible URL for your application. EnvironmentName *string // 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) - // for details. + // not with the environment name parameter. See [Environment Manifest (env.yaml)]for details. + // + // [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html GroupName *string // The Amazon Resource Name (ARN) of an existing IAM role to be used as the @@ -65,8 +69,9 @@ 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) - // in the AWS Elastic Beanstalk Developer Guide. + // information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. + // + // [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html OperationsRole *string // If specified, AWS Elastic Beanstalk sets the specified configuration options to @@ -80,24 +85,31 @@ 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]in the AWS Elastic Beanstalk Developer + // Guide. + // + // If you specify PlatformArn , don't specify SolutionStackName . + // + // [Custom Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html 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]in the AWS Elastic Beanstalk Platforms guide. + // + // If you specify SolutionStackName , don't specify PlatformArn or TemplateName . + // + // [Elastic Beanstalk Supported Platforms]: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html 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 @@ -106,8 +118,10 @@ type CreateEnvironmentInput struct { // that handles background-processing tasks. Tier *types.EnvironmentTier - // The name of the application version to deploy. Default: If not specified, - // Elastic Beanstalk attempts to deploy the sample application. + // The name of the application version to deploy. + // + // Default: If not specified, Elastic Beanstalk attempts to deploy the sample + // application. VersionLabel *string noSmithyDocumentSerde @@ -117,8 +131,11 @@ type CreateEnvironmentInput struct { type CreateEnvironmentOutput struct { // Indicates if there is an in-progress environment configuration update or - // application version deployment that you can cancel. true: There is an update in - // progress. false: There are no updates currently in progress. + // application version deployment that you can cancel. + // + // true: There is an update in progress. + // + // false: There are no updates currently in progress. AbortableOperationInProgress *bool // The name of the application associated with this environment. @@ -155,25 +172,32 @@ 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. + // // 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]. + // + // [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) - // in the AWS Elastic Beanstalk Developer Guide. + // information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. + // + // [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html OperationsRole *string // The ARN of the platform version. @@ -182,16 +206,21 @@ type CreateEnvironmentOutput struct { // The description of the AWS resources used by this environment. Resources *types.EnvironmentResourcesDescription - // The name of the SolutionStack deployed with this environment. + // The name of the SolutionStack deployed with this environment. 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. Status types.EnvironmentStatus diff --git a/service/elasticbeanstalk/api_op_CreatePlatformVersion.go b/service/elasticbeanstalk/api_op_CreatePlatformVersion.go index 594ce54dfc3..e29f0c8b1d1 100644 --- a/service/elasticbeanstalk/api_op_CreatePlatformVersion.go +++ b/service/elasticbeanstalk/api_op_CreatePlatformVersion.go @@ -51,9 +51,10 @@ type CreatePlatformVersionInput struct { // The configuration option settings to apply to the builder environment. OptionSettings []types.ConfigurationOptionSetting - // Specifies the tags applied to the new platform version. Elastic Beanstalk - // applies these tags only to the platform version. Environments that you create - // using the platform version don't inherit the tags. + // Specifies the tags applied to the new platform version. + // + // Elastic Beanstalk applies these tags only to the platform version. Environments + // that you create using the platform version don't inherit the tags. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_DeleteApplication.go b/service/elasticbeanstalk/api_op_DeleteApplication.go index 561176a92b4..4eef221a440 100644 --- a/service/elasticbeanstalk/api_op_DeleteApplication.go +++ b/service/elasticbeanstalk/api_op_DeleteApplication.go @@ -12,7 +12,9 @@ import ( // Deletes the specified application along with all associated versions and // configurations. The application versions will not be deleted from your Amazon S3 -// bucket. You cannot delete an application that has a running environment. +// bucket. +// +// You cannot delete an application that has a running environment. func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error) { if params == nil { params = &DeleteApplicationInput{} diff --git a/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go b/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go index 978d616ecd9..0ad4b299f94 100644 --- a/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_DeleteApplicationVersion.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified version from the specified application. You cannot delete -// an application version that is associated with a running environment. +// Deletes the specified version from the specified application. +// +// You cannot delete an application version that is associated with a running +// environment. func (c *Client) DeleteApplicationVersion(ctx context.Context, params *DeleteApplicationVersionInput, optFns ...func(*Options)) (*DeleteApplicationVersionOutput, error) { if params == nil { params = &DeleteApplicationVersionInput{} diff --git a/service/elasticbeanstalk/api_op_DeleteConfigurationTemplate.go b/service/elasticbeanstalk/api_op_DeleteConfigurationTemplate.go index a3b66ec35ea..bb5d3f45021 100644 --- a/service/elasticbeanstalk/api_op_DeleteConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_DeleteConfigurationTemplate.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified configuration template. When you launch an environment -// using a configuration template, the environment gets a copy of the template. You -// can delete or modify the environment's copy of the template without affecting -// the running environment. +// Deletes the specified configuration template. +// +// When you launch an environment using a configuration template, the environment +// gets a copy of the template. You can delete or modify the environment's copy of +// the template without affecting the running environment. func (c *Client) DeleteConfigurationTemplate(ctx context.Context, params *DeleteConfigurationTemplateInput, optFns ...func(*Options)) (*DeleteConfigurationTemplateOutput, error) { if params == nil { params = &DeleteConfigurationTemplateInput{} diff --git a/service/elasticbeanstalk/api_op_DeleteEnvironmentConfiguration.go b/service/elasticbeanstalk/api_op_DeleteEnvironmentConfiguration.go index 592f0f55d8d..7137fbcf781 100644 --- a/service/elasticbeanstalk/api_op_DeleteEnvironmentConfiguration.go +++ b/service/elasticbeanstalk/api_op_DeleteEnvironmentConfiguration.go @@ -11,12 +11,12 @@ import ( ) // Deletes the draft configuration associated with the running environment. +// // Updating a running environment with any configuration changes creates a draft -// configuration set. You can get the draft configuration using -// DescribeConfigurationSettings while the update is in progress or if the update -// fails. The DeploymentStatus for the draft configuration indicates whether the -// deployment is in process or has failed. The draft configuration remains in -// existence until it is deleted with this action. +// configuration set. You can get the draft configuration using DescribeConfigurationSettingswhile the update +// is in progress or if the update fails. The DeploymentStatus for the draft +// configuration indicates whether the deployment is in process or has failed. The +// draft configuration remains in existence until it is deleted with this action. func (c *Client) DeleteEnvironmentConfiguration(ctx context.Context, params *DeleteEnvironmentConfigurationInput, optFns ...func(*Options)) (*DeleteEnvironmentConfigurationOutput, error) { if params == nil { params = &DeleteEnvironmentConfigurationInput{} diff --git a/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go b/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go index 297b55f2cd4..7f62cbab91e 100644 --- a/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go +++ b/service/elasticbeanstalk/api_op_DescribeAccountAttributes.go @@ -12,8 +12,9 @@ import ( ) // 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. +// 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 { params = &DescribeAccountAttributesInput{} diff --git a/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go b/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go index f7d5e4878c6..edf2413fc80 100644 --- a/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go +++ b/service/elasticbeanstalk/api_op_DescribeApplicationVersions.go @@ -35,14 +35,17 @@ type DescribeApplicationVersionsInput struct { ApplicationName *string // For a paginated request. Specify a maximum number of application versions to - // include in each response. If no MaxRecords is specified, all available - // application versions are retrieved in a single response. + // include in each response. + // + // If no MaxRecords is specified, all available application versions are retrieved + // in a single response. MaxRecords *int32 // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to - // the ones specified in the initial request. If no NextToken is specified, the - // first page is retrieved. + // the ones specified in the initial request. + // + // If no NextToken is specified, the first page is retrieved. NextToken *string // Specify a version label to show a specific application version. diff --git a/service/elasticbeanstalk/api_op_DescribeApplications.go b/service/elasticbeanstalk/api_op_DescribeApplications.go index 7b933d3a268..880044e85e6 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 f6de0180231..7374772d7e7 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 20d9dce3550..4e85f8cb52e 100644 --- a/service/elasticbeanstalk/api_op_DescribeConfigurationSettings.go +++ b/service/elasticbeanstalk/api_op_DescribeConfigurationSettings.go @@ -13,12 +13,17 @@ import ( // Returns a description of the settings for the specified configuration set, that // is, either a configuration template or the configuration set associated with a -// running environment. When describing the settings for the configuration set -// associated with a running environment, it is possible to receive two sets of -// 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 +// running environment. +// +// When describing the settings for the configuration set associated with a +// running environment, it is possible to receive two sets of 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 func (c *Client) DescribeConfigurationSettings(ctx context.Context, params *DescribeConfigurationSettingsInput, optFns ...func(*Options)) (*DescribeConfigurationSettingsOutput, error) { if params == nil { params = &DescribeConfigurationSettingsInput{} @@ -43,17 +48,20 @@ 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 - // returns an InvalidParameterCombination error. If you do not specify either, AWS - // Elastic Beanstalk returns MissingRequiredParameter error. - EnvironmentName *string - - // The name of the configuration template to describe. Conditional: You must - // specify either this parameter or an EnvironmentName, but not both. If you + // 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 a + // error. If you do not specify either, AWS Elastic Beanstalk returns // MissingRequiredParameter error. + EnvironmentName *string + + // The name of the configuration template to describe. + // + // Conditional: You must specify either this parameter or an EnvironmentName, but + // not both. If you specify both, AWS Elastic Beanstalk returns an + // InvalidParameterCombination error. If you do not specify either, AWS Elastic + // Beanstalk returns a MissingRequiredParameter error. TemplateName *string noSmithyDocumentSerde @@ -63,7 +71,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 51a92112a26..994c0baf2ac 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentHealth.go @@ -37,12 +37,14 @@ type DescribeEnvironmentHealthInput struct { // . 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 - // EnvironmentName, or both. + // Specify the environment by ID. + // + // You must specify either this or an EnvironmentName, or both. EnvironmentId *string - // Specify the environment by name. You must specify either this or an - // EnvironmentName, or both. + // Specify the environment by name. + // + // You must specify either this or an EnvironmentName, or both. EnvironmentName *string noSmithyDocumentSerde @@ -58,15 +60,17 @@ type DescribeEnvironmentHealthOutput struct { // status. Causes []string - // The health color (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html) - // of the environment. + // The [health color] of the environment. + // + // [health color]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html 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] of the environment. For example, Ok . + // + // [health status]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html HealthStatus *string // Summary health information for the instances in the environment. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go index cdf4261841d..3ee2a2ad552 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentManagedActionHistory.go @@ -51,8 +51,7 @@ type DescribeEnvironmentManagedActionHistoryOutput struct { // A list of completed and failed managed actions. ManagedActionHistoryItems []types.ManagedActionHistoryItem - // A pagination token that you pass to DescribeEnvironmentManagedActionHistory to - // get the next page of results. + // A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go b/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go index ba89ad937d8..b8d123f68a7 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironmentResources.go @@ -30,14 +30,18 @@ func (c *Client) DescribeEnvironmentResources(ctx context.Context, params *Descr // Request to describe the resources in an environment. type DescribeEnvironmentResourcesInput struct { - // The ID of the environment to retrieve AWS resource usage data. 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 retrieve AWS resource usage data. + // + // 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 retrieve AWS resource usage data. Condition: You - // must specify either this or an EnvironmentId, or both. If you do not specify - // either, AWS Elastic Beanstalk returns MissingRequiredParameter error. + // The name of the environment to retrieve AWS resource usage data. + // + // 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 @@ -46,7 +50,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 6a92e5c5c08..b9e2436b2f2 100644 --- a/service/elasticbeanstalk/api_op_DescribeEnvironments.go +++ b/service/elasticbeanstalk/api_op_DescribeEnvironments.go @@ -46,24 +46,30 @@ 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 - // deleted environments. + // 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 + // 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 - // each response. If no MaxRecords is specified, all available environments are - // retrieved in a single response. + // each response. + // + // If no MaxRecords is specified, all available environments are retrieved in a + // single response. MaxRecords *int32 // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to - // the ones specified in the initial request. If no NextToken is specified, the - // first page is retrieved. + // the ones specified in the initial request. + // + // If no NextToken is specified, the first page is retrieved. NextToken *string // If specified, AWS Elastic Beanstalk restricts the returned descriptions to @@ -76,7 +82,7 @@ type DescribeEnvironmentsInput struct { // Result message containing a list of environment descriptions. type DescribeEnvironmentsOutput struct { - // Returns an EnvironmentDescription list. + // Returns an EnvironmentDescription list. Environments []types.EnvironmentDescription // In a paginated request, the token that you can pass in a subsequent request to @@ -205,12 +211,13 @@ type EnvironmentExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEnvironmentsInput, *DescribeEnvironmentsOutput, error) (bool, error) } @@ -426,12 +433,13 @@ type EnvironmentTerminatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEnvironmentsInput, *DescribeEnvironmentsOutput, error) (bool, error) } @@ -645,12 +653,13 @@ type EnvironmentUpdatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEnvironmentsInput, *DescribeEnvironmentsOutput, error) (bool, error) } diff --git a/service/elasticbeanstalk/api_op_DescribeEvents.go b/service/elasticbeanstalk/api_op_DescribeEvents.go index 8b21afb8be2..5793641df20 100644 --- a/service/elasticbeanstalk/api_op_DescribeEvents.go +++ b/service/elasticbeanstalk/api_op_DescribeEvents.go @@ -13,6 +13,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 . func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { @@ -36,7 +37,7 @@ type DescribeEventsInput struct { // include only those associated with this application. ApplicationName *string - // If specified, AWS Elastic Beanstalk restricts the returned descriptions to + // If specified, AWS Elastic Beanstalk restricts the returned descriptions to // those that occur up to, but not including, the EndTime . EndTime *time.Time @@ -86,11 +87,11 @@ 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 - // token in the next DescribeEvents call to get the next batch of events. + // If returned, this indicates that there are more results to obtain. Use this + // token in the next DescribeEventscall to get the next batch of events. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go b/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go index 72064e0386f..271dc6ae920 100644 --- a/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go +++ b/service/elasticbeanstalk/api_op_DescribeInstancesHealth.go @@ -13,8 +13,9 @@ import ( ) // 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) -// . +// Elastic Beanstalk. This operation requires [enhanced health reporting]. +// +// [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{} @@ -54,9 +55,10 @@ type DescribeInstancesHealthInput struct { // Beanstalk environment. 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. + // 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. 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 03bd4a883da..7e7b9b890a7 100644 --- a/service/elasticbeanstalk/api_op_DescribePlatformVersion.go +++ b/service/elasticbeanstalk/api_op_DescribePlatformVersion.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a platform version. Provides full details. Compare to -// 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) -// . +// Describes a platform version. Provides full details. Compare to 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]. +// +// [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 2686010681e..b98817254f1 100644 --- a/service/elasticbeanstalk/api_op_DisassociateEnvironmentOperationsRole.go +++ b/service/elasticbeanstalk/api_op_DisassociateEnvironmentOperationsRole.go @@ -13,8 +13,9 @@ 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) -// in the AWS Elastic Beanstalk Developer Guide. +// information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. +// +// [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html func (c *Client) DisassociateEnvironmentOperationsRole(ctx context.Context, params *DisassociateEnvironmentOperationsRoleInput, optFns ...func(*Options)) (*DisassociateEnvironmentOperationsRoleOutput, error) { if params == nil { params = &DisassociateEnvironmentOperationsRoleInput{} diff --git a/service/elasticbeanstalk/api_op_ListAvailableSolutionStacks.go b/service/elasticbeanstalk/api_op_ListAvailableSolutionStacks.go index 1904418110f..e399c6ca39f 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 db693086bc5..fc0b2822776 100644 --- a/service/elasticbeanstalk/api_op_ListPlatformBranches.go +++ b/service/elasticbeanstalk/api_op_ListPlatformBranches.go @@ -12,10 +12,11 @@ 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) -// . +// Provides summary information about each platform branch. +// +// For definitions of platform branch and other platform-related terms, see [AWS Elastic Beanstalk Platforms Glossary]. +// +// [AWS Elastic Beanstalk 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,21 +36,34 @@ 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 // 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. + // + // 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. @@ -57,8 +71,9 @@ type ListPlatformBranchesInput struct { // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to - // the ones specified in the initial request. If no NextToken is specified, the - // first page is retrieved. + // the ones specified in the initial request. + // + // If no NextToken is specified, the first page is retrieved. NextToken *string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_ListPlatformVersions.go b/service/elasticbeanstalk/api_op_ListPlatformVersions.go index 6acf88ad5e7..339da121774 100644 --- a/service/elasticbeanstalk/api_op_ListPlatformVersions.go +++ b/service/elasticbeanstalk/api_op_ListPlatformVersions.go @@ -12,11 +12,12 @@ 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 -// 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) -// . +// Provides summary information about each platform version. Compare to 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]. +// +// [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{} @@ -43,8 +44,9 @@ type ListPlatformVersionsInput struct { // For a paginated request. Specify a token from a previous response page to // retrieve the next response page. All other parameter values must be identical to - // the ones specified in the initial request. If no NextToken is specified, the - // first page is retrieved. + // the ones specified in the initial request. + // + // If no NextToken is specified, the first page is retrieved. NextToken *string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_ListTagsForResource.go b/service/elasticbeanstalk/api_op_ListTagsForResource.go index fbbeb748090..f6bb9d9321d 100644 --- a/service/elasticbeanstalk/api_op_ListTagsForResource.go +++ b/service/elasticbeanstalk/api_op_ListTagsForResource.go @@ -12,10 +12,12 @@ 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) -// . +// 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]. +// +// [Tagging 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 +35,9 @@ 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 7a3ed3686c3..48591f20bea 100644 --- a/service/elasticbeanstalk/api_op_RebuildEnvironment.go +++ b/service/elasticbeanstalk/api_op_RebuildEnvironment.go @@ -29,14 +29,18 @@ 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 - // or an EnvironmentId, or both. If you do not specify either, AWS Elastic - // Beanstalk returns MissingRequiredParameter error. + // The name of the environment to rebuild. + // + // 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_RequestEnvironmentInfo.go b/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go index 91458b63ae2..b1b0c0cb098 100644 --- a/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go +++ b/service/elasticbeanstalk/api_op_RequestEnvironmentInfo.go @@ -12,13 +12,20 @@ import ( ) // 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 +// 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{} @@ -43,15 +50,21 @@ type RequestEnvironmentInfoInput struct { // This member is required. InfoType types.EnvironmentInfoType - // The ID of the environment of the requested data. If no such environment is - // found, RequestEnvironmentInfo returns an InvalidParameterValue error. + // 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. EnvironmentId *string - // The name of the environment of the requested data. If no such environment is - // found, RequestEnvironmentInfo returns an InvalidParameterValue error. + // 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. diff --git a/service/elasticbeanstalk/api_op_RestartAppServer.go b/service/elasticbeanstalk/api_op_RestartAppServer.go index e1ae05582f6..38ffa68c4bb 100644 --- a/service/elasticbeanstalk/api_op_RestartAppServer.go +++ b/service/elasticbeanstalk/api_op_RestartAppServer.go @@ -29,14 +29,18 @@ 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 - // specify either this or an EnvironmentId, or both. If you do not specify either, - // AWS Elastic Beanstalk returns MissingRequiredParameter error. + // The name of the environment to restart the server for. + // + // 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_RetrieveEnvironmentInfo.go b/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go index a907fc37c60..051b655e6bd 100644 --- a/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go +++ b/service/elasticbeanstalk/api_op_RetrieveEnvironmentInfo.go @@ -12,8 +12,10 @@ import ( ) // Retrieves the compiled information from a RequestEnvironmentInfo request. -// Related Topics -// - RequestEnvironmentInfo +// +// # Related Topics +// +// RequestEnvironmentInfo func (c *Client) RetrieveEnvironmentInfo(ctx context.Context, params *RetrieveEnvironmentInfoInput, optFns ...func(*Options)) (*RetrieveEnvironmentInfoOutput, error) { if params == nil { params = &RetrieveEnvironmentInfoInput{} @@ -29,7 +31,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. @@ -37,16 +39,22 @@ type RetrieveEnvironmentInfoInput struct { // This member is required. InfoType types.EnvironmentInfoType - // The ID of the data's environment. If no such environment is found, 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. + // The ID of the data's environment. + // + // If no such environment is found, 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 data's environment. If no such environment is found, 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. + // The name of the data's environment. + // + // If no such environment is found, 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 @@ -55,7 +63,7 @@ type RetrieveEnvironmentInfoInput struct { // Result message containing a description of the requested environment info. type RetrieveEnvironmentInfoOutput struct { - // The EnvironmentInfoDescription of the environment. + // The EnvironmentInfoDescription of the environment. EnvironmentInfo []types.EnvironmentInfoDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go b/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go index f37c4b01dd6..4bec76e023c 100644 --- a/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go +++ b/service/elasticbeanstalk/api_op_SwapEnvironmentCNAMEs.go @@ -29,28 +29,32 @@ func (c *Client) SwapEnvironmentCNAMEs(ctx context.Context, params *SwapEnvironm // Swaps the CNAMEs of two environments. 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 . + // 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 *string - // The name of the destination environment. Condition: You must specify at least - // the DestinationEnvironmentID or the DestinationEnvironmentName . You may also - // specify both. You must specify the SourceEnvironmentName with the - // DestinationEnvironmentName . + // The name of the destination environment. + // + // Condition: You must specify at least the DestinationEnvironmentID or the + // DestinationEnvironmentName . You may also specify both. You must specify the + // SourceEnvironmentName with the 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 . + // 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 *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 . + // 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 . SourceEnvironmentName *string noSmithyDocumentSerde diff --git a/service/elasticbeanstalk/api_op_TerminateEnvironment.go b/service/elasticbeanstalk/api_op_TerminateEnvironment.go index c77f8074e99..ad68cdd11aa 100644 --- a/service/elasticbeanstalk/api_op_TerminateEnvironment.go +++ b/service/elasticbeanstalk/api_op_TerminateEnvironment.go @@ -31,14 +31,18 @@ func (c *Client) TerminateEnvironment(ctx context.Context, params *TerminateEnvi // Request to terminate an environment. type TerminateEnvironmentInput struct { - // The ID of the environment to terminate. 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 terminate. + // + // 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 terminate. Condition: You must specify either - // this or an EnvironmentId, or both. If you do not specify either, AWS Elastic - // Beanstalk returns MissingRequiredParameter error. + // The name of the environment to terminate. + // + // 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 // Terminates the target environment even if another environment in the same group @@ -47,12 +51,20 @@ 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 + // + // For more information, see the [AWS Elastic Beanstalk User Guide.] + // + // Default: true + // + // Valid Values: true | false + // + // [AWS Elastic Beanstalk User Guide.]: https://docs.aws.amazon.com/elasticbeanstalk/latest/ug/ TerminateResources *bool noSmithyDocumentSerde @@ -62,8 +74,11 @@ type TerminateEnvironmentInput struct { type TerminateEnvironmentOutput struct { // Indicates if there is an in-progress environment configuration update or - // application version deployment that you can cancel. true: There is an update in - // progress. false: There are no updates currently in progress. + // application version deployment that you can cancel. + // + // true: There is an update in progress. + // + // false: There are no updates currently in progress. AbortableOperationInProgress *bool // The name of the application associated with this environment. @@ -100,25 +115,32 @@ 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. + // // 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]. + // + // [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) - // in the AWS Elastic Beanstalk Developer Guide. + // information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. + // + // [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html OperationsRole *string // The ARN of the platform version. @@ -127,16 +149,21 @@ type TerminateEnvironmentOutput struct { // The description of the AWS resources used by this environment. Resources *types.EnvironmentResourcesDescription - // The name of the SolutionStack deployed with this environment. + // The name of the SolutionStack deployed with this environment. 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. Status types.EnvironmentStatus diff --git a/service/elasticbeanstalk/api_op_UpdateApplication.go b/service/elasticbeanstalk/api_op_UpdateApplication.go index 3ac0f8e00f2..56a93155f17 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplication.go +++ b/service/elasticbeanstalk/api_op_UpdateApplication.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified application to have the specified properties. If a -// property (for example, description ) is not provided, the value remains +// Updates the specified application to have the specified properties. +// +// If a 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 { @@ -38,8 +39,10 @@ type UpdateApplicationInput struct { // This member is required. ApplicationName *string - // A new description for the application. Default: If not specified, AWS Elastic - // Beanstalk does not update the description. + // A new description for the application. + // + // Default: If not specified, AWS Elastic Beanstalk does not update the + // description. Description *string noSmithyDocumentSerde @@ -48,7 +51,7 @@ type UpdateApplicationInput struct { // Result message containing a single description of an application. type UpdateApplicationOutput struct { - // The ApplicationDescription of the application. + // The ApplicationDescription of the application. Application *types.ApplicationDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go b/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go index de9f600271d..9d51e0ea60d 100644 --- a/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go +++ b/service/elasticbeanstalk/api_op_UpdateApplicationVersion.go @@ -11,8 +11,9 @@ 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 { @@ -31,14 +32,18 @@ func (c *Client) UpdateApplicationVersion(ctx context.Context, params *UpdateApp type UpdateApplicationVersionInput struct { - // The name of the application associated with this version. If no application is - // found with this name, UpdateApplication returns an InvalidParameterValue error. + // The name of the application associated with this version. + // + // If no application is found with this name, UpdateApplication returns an + // InvalidParameterValue error. // // This member is required. ApplicationName *string - // The name of the version to update. If no application version is found with this - // label, UpdateApplication returns an InvalidParameterValue error. + // The name of the version to update. + // + // If no application version is found with this label, UpdateApplication returns + // an InvalidParameterValue error. // // This member is required. VersionLabel *string @@ -52,7 +57,7 @@ type UpdateApplicationVersionInput struct { // Result message wrapping a single description of an application version. type UpdateApplicationVersionOutput struct { - // The ApplicationVersionDescription of the application version. + // The ApplicationVersionDescription of the application version. ApplicationVersion *types.ApplicationVersionDescription // Metadata pertaining to the operation's result. diff --git a/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go b/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go index f4095178322..e990bd6a149 100644 --- a/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go +++ b/service/elasticbeanstalk/api_op_UpdateConfigurationTemplate.go @@ -13,10 +13,14 @@ import ( ) // 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 +// 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 func (c *Client) UpdateConfigurationTemplate(ctx context.Context, params *UpdateConfigurationTemplateInput, optFns ...func(*Options)) (*UpdateConfigurationTemplateOutput, error) { if params == nil { params = &UpdateConfigurationTemplateInput{} @@ -36,15 +40,18 @@ func (c *Client) UpdateConfigurationTemplate(ctx context.Context, params *Update type UpdateConfigurationTemplateInput struct { // The name of the application associated with the configuration template to - // update. If no application is found with this name, UpdateConfigurationTemplate - // returns an InvalidParameterValue error. + // update. + // + // If no application is found with this name, UpdateConfigurationTemplate returns + // an InvalidParameterValue error. // // This member is required. ApplicationName *string - // The name of the configuration template to update. If no configuration template - // is found with this name, UpdateConfigurationTemplate returns an - // InvalidParameterValue error. + // The name of the configuration template to update. + // + // If no configuration template is found with this name, + // UpdateConfigurationTemplate returns an InvalidParameterValue error. // // This member is required. TemplateName *string @@ -57,6 +64,7 @@ type UpdateConfigurationTemplateInput struct { OptionSettings []types.ConfigurationOptionSetting // A list of configuration options to remove from the configuration set. + // // Constraint: You can remove only UserDefined configuration options. OptionsToRemove []types.OptionSpecification @@ -75,21 +83,25 @@ type UpdateConfigurationTemplateOutput struct { // The date (in UTC time) when this configuration set was last modified. DateUpdated *time.Time - // If this configuration set is associated with an environment, the + // 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. 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. @@ -101,7 +113,8 @@ 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 bd0d1d8605c..bdcbe45a5d3 100644 --- a/service/elasticbeanstalk/api_op_UpdateEnvironment.go +++ b/service/elasticbeanstalk/api_op_UpdateEnvironment.go @@ -14,12 +14,14 @@ import ( // Updates the environment description, deploys a new application version, updates // the configuration settings to an entirely new configuration template, or updates -// select configuration option values in the running environment. Attempting to -// update both the release and configuration is not allowed and AWS Elastic -// Beanstalk returns an InvalidParameterCombination error. When updating the -// configuration settings to a new template or individual settings, a draft -// configuration is created and DescribeConfigurationSettings for this environment -// returns two setting descriptions with different DeploymentStatus values. +// select configuration option values in the running environment. +// +// Attempting to update both the release and configuration is not allowed and AWS +// Elastic Beanstalk returns an InvalidParameterCombination error. +// +// When updating the configuration settings to a new template or individual +// settings, a draft configuration is created and DescribeConfigurationSettingsfor this environment returns two +// setting descriptions with different DeploymentStatus values. func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error) { if params == nil { params = &UpdateEnvironmentInput{} @@ -45,23 +47,29 @@ type UpdateEnvironmentInput struct { // of this environment. Description *string - // The ID of the environment to update. If no environment with this ID exists, AWS - // Elastic Beanstalk 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. + // The ID of the environment to update. + // + // If no environment with this ID exists, AWS Elastic Beanstalk 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 to update. If no environment with this name exists, - // AWS Elastic Beanstalk 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. + // AWS Elastic Beanstalk 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 // 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) - // for details. + // not with the environment name or environment ID parameters. See [Environment Manifest (env.yaml)]for details. + // + // [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html GroupName *string // If specified, AWS Elastic Beanstalk updates the configuration set associated @@ -85,9 +93,10 @@ type UpdateEnvironmentInput struct { // found, AWS Elastic Beanstalk returns an InvalidParameterValue error. TemplateName *string - // This specifies the tier to use to update the environment. Condition: At this - // time, if you change the tier version, name, or type, AWS Elastic Beanstalk - // returns InvalidParameterValue error. + // This specifies the tier to use to update the environment. + // + // Condition: At this time, if you change the tier version, name, or type, AWS + // Elastic Beanstalk returns InvalidParameterValue error. Tier *types.EnvironmentTier // If this parameter is specified, AWS Elastic Beanstalk deploys the named @@ -102,8 +111,11 @@ type UpdateEnvironmentInput struct { type UpdateEnvironmentOutput struct { // Indicates if there is an in-progress environment configuration update or - // application version deployment that you can cancel. true: There is an update in - // progress. false: There are no updates currently in progress. + // application version deployment that you can cancel. + // + // true: There is an update in progress. + // + // false: There are no updates currently in progress. AbortableOperationInProgress *bool // The name of the application associated with this environment. @@ -140,25 +152,32 @@ 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. + // // 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]. + // + // [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) - // in the AWS Elastic Beanstalk Developer Guide. + // information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. + // + // [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html OperationsRole *string // The ARN of the platform version. @@ -167,16 +186,21 @@ type UpdateEnvironmentOutput struct { // The description of the AWS resources used by this environment. Resources *types.EnvironmentResourcesDescription - // The name of the SolutionStack deployed with this environment. + // The name of the SolutionStack deployed with this environment. 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. Status types.EnvironmentStatus diff --git a/service/elasticbeanstalk/api_op_UpdateTagsForResource.go b/service/elasticbeanstalk/api_op_UpdateTagsForResource.go index e379c8ff5d9..e7b0af7be19 100644 --- a/service/elasticbeanstalk/api_op_UpdateTagsForResource.go +++ b/service/elasticbeanstalk/api_op_UpdateTagsForResource.go @@ -12,18 +12,25 @@ 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 -// 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) -// . +// 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]. +// +// 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]. +// +// [Creating a Custom User Policy]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies +// [Tagging Application Resources]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html func (c *Client) UpdateTagsForResource(ctx context.Context, params *UpdateTagsForResourceInput, optFns ...func(*Options)) (*UpdateTagsForResourceOutput, error) { if params == nil { params = &UpdateTagsForResourceInput{} @@ -41,19 +48,23 @@ func (c *Client) UpdateTagsForResource(ctx context.Context, params *UpdateTagsFo type UpdateTagsForResourceInput struct { - // The Amazon Resource Name (ARN) of the resouce to be updated. Must be the ARN of - // an Elastic Beanstalk resource. + // The Amazon Resource Name (ARN) of the resouce to be updated. + // + // Must be the ARN of an Elastic Beanstalk resource. // // 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 . + // 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 69ba85cf564..ebe1141e791 100644 --- a/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go +++ b/service/elasticbeanstalk/api_op_ValidateConfigurationSettings.go @@ -12,9 +12,10 @@ import ( ) // Takes a set of configuration settings and either a configuration template or -// environment, and determines whether those values are valid. This action returns -// a list of messages indicating any errors or warnings associated with the -// selection of option values. +// environment, and determines whether those values are valid. +// +// This action returns a list of messages indicating any errors or warnings +// associated with the selection of option values. func (c *Client) ValidateConfigurationSettings(ctx context.Context, params *ValidateConfigurationSettingsInput, optFns ...func(*Options)) (*ValidateConfigurationSettingsOutput, error) { if params == nil { params = &ValidateConfigurationSettingsInput{} @@ -44,11 +45,13 @@ type ValidateConfigurationSettingsInput struct { // This member is required. OptionSettings []types.ConfigurationOptionSetting - // The name of the environment to validate the settings against. Condition: You - // cannot specify both this and a configuration template name. + // The name of the environment to validate the settings against. + // + // Condition: You cannot specify both this and a configuration template name. EnvironmentName *string // The name of the configuration template to validate the settings against. + // // Condition: You cannot specify both this and an environment name. TemplateName *string @@ -58,7 +61,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 42990c4b240..08d1542f440 100644 --- a/service/elasticbeanstalk/doc.go +++ b/service/elasticbeanstalk/doc.go @@ -3,16 +3,23 @@ // Package elasticbeanstalk provides the API client, operations, and parameter // types for AWS Elastic Beanstalk. // -// AWS Elastic Beanstalk AWS Elastic Beanstalk makes it easy for you to create, -// deploy, and manage scalable, fault-tolerant applications running on the Amazon -// 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 -// 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/) . -// 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) -// in the Amazon Web Services Glossary. +// # AWS Elastic Beanstalk +// +// AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage +// scalable, fault-tolerant applications running on the Amazon Web Services cloud. +// +// For more information about this product, go to the [AWS Elastic Beanstalk] details page. The location +// of the latest AWS Elastic Beanstalk WSDL is [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]. +// +// # Endpoints +// +// For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go +// to [Regions and Endpoints]in the Amazon Web Services Glossary. +// +// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [AWS Elastic Beanstalk]: http://aws.amazon.com/elasticbeanstalk/ +// [https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl]: https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl package elasticbeanstalk diff --git a/service/elasticbeanstalk/options.go b/service/elasticbeanstalk/options.go index 556136385fd..0aeb3d8f9dd 100644 --- a/service/elasticbeanstalk/options.go +++ b/service/elasticbeanstalk/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elasticbeanstalk/types/enums.go b/service/elasticbeanstalk/types/enums.go index 40d104383ce..e5efa6d928b 100644 --- a/service/elasticbeanstalk/types/enums.go +++ b/service/elasticbeanstalk/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ActionHistoryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionHistoryStatus) Values() []ActionHistoryStatus { return []ActionHistoryStatus{ "Completed", @@ -33,8 +34,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "InstanceRefresh", @@ -77,6 +80,7 @@ const ( // 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{ @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for ComputeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeType) Values() []ComputeType { return []ComputeType{ "BUILD_GENERAL1_SMALL", @@ -119,8 +124,9 @@ const ( // Values returns all known values for ConfigurationDeploymentStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationDeploymentStatus) Values() []ConfigurationDeploymentStatus { return []ConfigurationDeploymentStatus{ "deployed", @@ -139,8 +145,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationOptionValueType) Values() []ConfigurationOptionValueType { return []ConfigurationOptionValueType{ "Scalar", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for EnvironmentHealth. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentHealth) Values() []EnvironmentHealth { return []EnvironmentHealth{ "Green", @@ -186,6 +194,7 @@ const ( // Values returns all known values for EnvironmentHealthAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentHealthAttribute) Values() []EnvironmentHealthAttribute { return []EnvironmentHealthAttribute{ @@ -216,8 +225,9 @@ const ( ) // Values returns all known values for EnvironmentHealthStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentHealthStatus) Values() []EnvironmentHealthStatus { return []EnvironmentHealthStatus{ "NoData", @@ -241,8 +251,9 @@ const ( ) // Values returns all known values for EnvironmentInfoType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentInfoType) Values() []EnvironmentInfoType { return []EnvironmentInfoType{ "tail", @@ -265,8 +276,9 @@ const ( ) // Values returns all known values for EnvironmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentStatus) Values() []EnvironmentStatus { return []EnvironmentStatus{ "Aborting", @@ -293,8 +305,9 @@ const ( ) // Values returns all known values for EventSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSeverity) Values() []EventSeverity { return []EventSeverity{ "TRACE", @@ -320,8 +333,9 @@ const ( ) // Values returns all known values for FailureType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureType) Values() []FailureType { return []FailureType{ "UpdateCancelled", @@ -353,6 +367,7 @@ const ( // 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{ @@ -382,8 +397,9 @@ const ( ) // Values returns all known values for PlatformStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlatformStatus) Values() []PlatformStatus { return []PlatformStatus{ "Creating", @@ -403,8 +419,9 @@ const ( ) // Values returns all known values for SourceRepository. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceRepository) Values() []SourceRepository { return []SourceRepository{ "CodeCommit", @@ -421,8 +438,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "Git", @@ -439,8 +457,9 @@ const ( ) // Values returns all known values for ValidationSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationSeverity) Values() []ValidationSeverity { return []ValidationSeverity{ "error", diff --git a/service/elasticbeanstalk/types/errors.go b/service/elasticbeanstalk/types/errors.go index 333d6095476..fa9c1f5287d 100644 --- a/service/elasticbeanstalk/types/errors.go +++ b/service/elasticbeanstalk/types/errors.go @@ -254,8 +254,11 @@ func (e *ResourceTypeNotSupportedException) ErrorFault() smithy.ErrorFault { ret // 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 @@ -499,9 +502,10 @@ func (e *TooManyPlatformsException) ErrorCode() string { func (e *TooManyPlatformsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The number of tags in the resource would exceed the number of tags that each -// resource can have. To calculate this, the operation considers both the number of -// tags the resource already has and the tags this operation would add if it -// succeeded. +// resource can have. +// +// To calculate this, the operation considers both the number of tags the resource +// already has and the tags this operation would add if it succeeded. type TooManyTagsException struct { Message *string diff --git a/service/elasticbeanstalk/types/types.go b/service/elasticbeanstalk/types/types.go index 34e8c181ada..a4dc58a9061 100644 --- a/service/elasticbeanstalk/types/types.go +++ b/service/elasticbeanstalk/types/types.go @@ -67,6 +67,7 @@ type ApplicationMetrics struct { 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 @@ -114,14 +115,19 @@ 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. Status ApplicationVersionStatus @@ -134,10 +140,11 @@ type ApplicationVersionDescription struct { // 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. +// 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 @@ -183,8 +190,11 @@ 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 ComputeType ComputeType @@ -210,11 +220,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. @@ -246,12 +259,16 @@ 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 + // + // 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. @@ -259,23 +276,27 @@ 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 - // . + // + // - Json : Values for this option are a JSON representation of a ConfigDocument . ValueType ConfigurationOptionValueType noSmithyDocumentSerde } // 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. +// current value. For a list of possible namespaces and option values, see [Option Values]in the +// AWS Elastic Beanstalk Developer Guide. +// +// [Option Values]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html type ConfigurationOptionSetting struct { // A unique namespace that identifies the option's associated AWS resource. @@ -306,21 +327,25 @@ type ConfigurationSettingsDescription struct { // The date (in UTC time) when this configuration set was last modified. DateUpdated *time.Time - // If this configuration set is associated with an environment, the + // 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. 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. @@ -332,7 +357,8 @@ 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 @@ -341,32 +367,44 @@ type ConfigurationSettingsDescription struct { // CPU utilization metrics for an instance. type CPUUtilization struct { - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the I/O Wait state over the last 10 seconds. + // Available on Linux environments only. + // + // Percentage of time that the CPU has spent in the I/O Wait state over the last + // 10 seconds. IOWait *float64 - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the IRQ state over the last 10 seconds. + // Available on Linux environments only. + // + // Percentage of time that the CPU has spent in the IRQ state over the last 10 + // seconds. IRQ *float64 // Percentage of time that the CPU has spent in the Idle state over the last 10 // seconds. Idle *float64 - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the Nice state over the last 10 seconds. + // Available on Linux environments only. + // + // Percentage of time that the CPU has spent in the Nice state over the last 10 + // seconds. Nice *float64 - // Available on Windows environments only. Percentage of time that the CPU has - // spent in the Privileged state over the last 10 seconds. + // Available on Windows environments only. + // + // Percentage of time that the CPU has spent in the Privileged state over the last + // 10 seconds. Privileged *float64 - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the SoftIRQ state over the last 10 seconds. + // Available on Linux environments only. + // + // Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 + // seconds. SoftIRQ *float64 - // Available on Linux environments only. Percentage of time that the CPU has spent - // in the System state over the last 10 seconds. + // Available on Linux environments only. + // + // Percentage of time that the CPU has spent in the System state over the last 10 + // seconds. System *float64 // Percentage of time that the CPU has spent in the User state over the last 10 @@ -395,13 +433,17 @@ type Deployment struct { // 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. Status *string @@ -415,8 +457,11 @@ type Deployment struct { type EnvironmentDescription struct { // Indicates if there is an in-progress environment configuration update or - // application version deployment that you can cancel. true: There is an update in - // progress. false: There are no updates currently in progress. + // application version deployment that you can cancel. + // + // true: There is an update in progress. + // + // false: There are no updates currently in progress. AbortableOperationInProgress *bool // The name of the application associated with this environment. @@ -453,25 +498,32 @@ 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. + // // 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]. + // + // [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) - // in the AWS Elastic Beanstalk Developer Guide. + // information, see [Operations roles]in the AWS Elastic Beanstalk Developer Guide. + // + // [Operations roles]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html OperationsRole *string // The ARN of the platform version. @@ -480,16 +532,21 @@ type EnvironmentDescription struct { // The description of the AWS resources used by this environment. Resources *EnvironmentResourcesDescription - // The name of the SolutionStack deployed with this environment. + // The name of the SolutionStack deployed with this environment. 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. Status EnvironmentStatus @@ -516,9 +573,10 @@ type EnvironmentInfoDescription struct { InfoType EnvironmentInfoType // The retrieved information. Currently contains a presigned Amazon S3 URL. The - // files are deleted after 15 minutes. Anyone in possession of this URL can access - // the files before they are deleted. Make the URL available only to trusted - // parties. + // files are deleted after 15 minutes. + // + // Anyone in possession of this URL can access the files before they are deleted. + // Make the URL available only to trusted parties. Message *string // The time stamp when this information was retrieved. @@ -529,8 +587,9 @@ 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) -// for details. +// to another environment in the same group. See [Environment Manifest (env.yaml)]for details. +// +// [Environment Manifest (env.yaml)]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html type EnvironmentLink struct { // The name of the linked environment (the dependency). @@ -545,7 +604,7 @@ type EnvironmentLink struct { // Describes the AWS resources in use by this environment. This data is live. type EnvironmentResourceDescription struct { - // The AutoScalingGroups used by this environment. + // The AutoScalingGroups used by this environment. AutoScalingGroups []AutoScalingGroup // The name of the environment. @@ -585,20 +644,29 @@ type EnvironmentResourcesDescription struct { // Describes the properties of an environment tier type EnvironmentTier struct { - // The name of this environment tier. Valid values: + // The name of this environment tier. + // + // Valid values: + // // - For Web server tier – WebServer + // // - For Worker tier – Worker Name *string - // The type of this environment tier. Valid values: + // The type of this environment tier. + // + // Valid values: + // // - 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 - // Beanstalk uses the latest compatible worker tier version. This member is - // deprecated. Any specific version that you set may become out of date. We - // recommend leaving it unspecified. + // Beanstalk uses the latest compatible worker tier version. + // + // This member is deprecated. Any specific version that you set may become out of + // date. We recommend leaving it unspecified. Version *string noSmithyDocumentSerde @@ -647,37 +715,38 @@ 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]. +// +// [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 + // Red. The health agent is reporting a high number of request failures or other // issues for an instance or environment. Degraded *int32 - // Green. An operation is in progress on an instance. + // Green. An operation is in progress on an instance. Info *int32 - // Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an + // Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an // instance. NoData *int32 - // Green. An instance is passing health checks and the health agent is not + // Green. An instance is passing health checks and the health agent is not // reporting any problems. Ok *int32 - // Grey. An operation is in progress on an instance within the command timeout. + // Grey. An operation is in progress on an instance within the command timeout. Pending *int32 - // Red. The health agent is reporting a very high number of request failures or + // Red. The health agent is reporting a very high number of request failures or // other issues for an instance or environment. Severe *int32 - // Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient + // Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient // amount of data on an instance. Unknown *int32 - // Yellow. The health agent is reporting a moderate number of request failures or + // Yellow. The health agent is reporting a moderate number of request failures or // other issues for an instance or environment. Warning *int32 @@ -790,7 +859,7 @@ type ManagedAction struct { ActionType ActionType // The status of the managed action. If the action is Scheduled , you can apply it - // immediately with ApplyEnvironmentManagedAction . + // immediately with ApplyEnvironmentManagedAction. Status ActionStatus // The start time of the maintenance window in which the managed action will @@ -906,19 +975,22 @@ type PlatformBranchSummary struct { // 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 | - // supported | deprecated | retired + // The support life cycle state of the platform branch. + // + // Possible values: beta | supported | deprecated | retired LifecycleState *string // The name of the platform to which this platform branch belongs. PlatformName *string - // The environment tiers that platform versions in this branch support. Possible - // values: WebServer/Standard | Worker/SQS/HTTP + // The environment tiers that platform versions in this branch support. + // + // Possible values: WebServer/Standard | Worker/SQS/HTTP SupportedTierList []string noSmithyDocumentSerde @@ -954,8 +1026,9 @@ type PlatformDescription struct { // The ARN of the platform version. PlatformArn *string - // The state of the platform version's branch in its lifecycle. Possible values: - // Beta | Supported | Deprecated | Retired + // The state of the platform version's branch in its lifecycle. + // + // Possible values: Beta | Supported | Deprecated | Retired PlatformBranchLifecycleState *string // The platform branch to which the platform version belongs. @@ -964,10 +1037,13 @@ type PlatformDescription struct { // The category of the platform version. PlatformCategory *string - // The state of the platform version in its lifecycle. Possible values: Recommended - // | null If a null value is returned, the platform version isn't the recommended - // one for its branch. Each platform branch has a single recommended platform - // version, typically the most recent one. + // The state of the platform version in its lifecycle. + // + // Possible values: Recommended | null + // + // If a null value is returned, the platform version isn't the recommended one for + // its branch. Each platform branch has a single recommended platform version, + // typically the most recent one. PlatformLifecycleState *string // The name of the platform version. @@ -997,26 +1073,34 @@ type PlatformDescription struct { noSmithyDocumentSerde } -// Describes criteria to restrict the results when listing platform versions. The -// filter is evaluated as follows: Type Operator Values[1] +// Describes criteria to restrict the results when listing platform versions. +// +// The 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: = | != - // | < | <= | > | >= | contains | begins_with | ends_with + // The operator to apply to the Type with each of the Values . + // + // Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with Operator *string - // The platform version attribute to which the filter values are applied. Valid - // values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | - // PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | - // ProgrammingLanguageName | OperatingSystemName + // The platform version attribute to which the filter values are applied. + // + // Valid values: PlatformName | PlatformVersion | PlatformStatus | + // PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | + // SupportedAddon | 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 - // filter values for some filter attributes. + // 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 Values []string @@ -1059,8 +1143,9 @@ type PlatformSummary struct { // The ARN of the platform version. PlatformArn *string - // The state of the platform version's branch in its lifecycle. Possible values: - // beta | supported | deprecated | retired + // The state of the platform version's branch in its lifecycle. + // + // Possible values: beta | supported | deprecated | retired PlatformBranchLifecycleState *string // The platform branch to which the platform version belongs. @@ -1069,9 +1154,12 @@ type PlatformSummary struct { // The category of platform version. PlatformCategory *string - // The state of the platform version in its lifecycle. Possible values: recommended - // | empty If an empty value is returned, the platform version is supported but - // isn't the recommended one for its branch. + // The state of the platform version in its lifecycle. + // + // Possible values: recommended | empty + // + // If an empty value is returned, the platform version is supported but isn't the + // recommended one for its branch. PlatformLifecycleState *string // The AWS account ID of the person who created the platform version. @@ -1150,15 +1238,19 @@ type S3Location struct { noSmithyDocumentSerde } -// 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 -// 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 -// attributes of SearchFilter depend on the API action. For valid values, see the -// reference page for the API action you're calling that takes a SearchFilter -// parameter. +// 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 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 attributes of SearchFilter depend on the API action. For +// valid values, see the reference page for the API action you're calling that +// takes a SearchFilter parameter. type SearchFilter struct { // The result attribute to which the filter values are applied. Valid values vary @@ -1191,16 +1283,17 @@ 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]. + // + // [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) - // . + // Returns the health status of the specified instance. For more information, see [Health Colors and Statuses]. + // + // [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. @@ -1235,9 +1328,11 @@ 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 . // @@ -1245,14 +1340,18 @@ type SourceBuildInformation struct { SourceLocation *string // Location where the repository is stored. + // // - CodeCommit + // // - S3 // // This member is required. SourceRepository SourceRepository // The type of repository. + // // - Git + // // - Zip // // This member is required. @@ -1274,8 +1373,9 @@ 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) . +// each type of status code response. For more information, see [Status Code Definitions]. +// +// [Status Code 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 @@ -1304,8 +1404,9 @@ 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]. + // + // [Operating System Metrics]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os LoadAverage []float64 noSmithyDocumentSerde @@ -1345,10 +1446,11 @@ 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. + // + // - warning : This message is providing information you should take into account. Severity ValidationSeverity noSmithyDocumentSerde diff --git a/service/elasticinference/api_op_DescribeAcceleratorOfferings.go b/service/elasticinference/api_op_DescribeAcceleratorOfferings.go index 632a6e96243..273ba580246 100644 --- a/service/elasticinference/api_op_DescribeAcceleratorOfferings.go +++ b/service/elasticinference/api_op_DescribeAcceleratorOfferings.go @@ -11,15 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the locations in which a given accelerator type or set of types is -// present in a given region. February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue -// using the service. +// Describes the locations in which a given accelerator type or set of types is +// +// present in a given region. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. func (c *Client) DescribeAcceleratorOfferings(ctx context.Context, params *DescribeAcceleratorOfferingsInput, optFns ...func(*Options)) (*DescribeAcceleratorOfferingsOutput, error) { if params == nil { params = &DescribeAcceleratorOfferingsInput{} @@ -37,7 +39,7 @@ func (c *Client) DescribeAcceleratorOfferings(ctx context.Context, params *Descr type DescribeAcceleratorOfferingsInput struct { - // The location type that you want to describe accelerator type offerings for. It + // The location type that you want to describe accelerator type offerings for. It // can assume the following values: region: will return the accelerator type // offering at the regional level. availability-zone: will return the accelerator // type offering at the availability zone level. availability-zone-id: will return @@ -47,7 +49,7 @@ type DescribeAcceleratorOfferingsInput struct { // This member is required. LocationType types.LocationType - // The list of accelerator types to describe. + // The list of accelerator types to describe. AcceleratorTypes []string noSmithyDocumentSerde @@ -55,7 +57,7 @@ type DescribeAcceleratorOfferingsInput struct { type DescribeAcceleratorOfferingsOutput struct { - // The list of accelerator type offerings for a specific location. + // The list of accelerator type offerings for a specific location. AcceleratorTypeOfferings []types.AcceleratorTypeOffering // Metadata pertaining to the operation's result. diff --git a/service/elasticinference/api_op_DescribeAcceleratorTypes.go b/service/elasticinference/api_op_DescribeAcceleratorTypes.go index 5f3592a3fba..10fc72bb767 100644 --- a/service/elasticinference/api_op_DescribeAcceleratorTypes.go +++ b/service/elasticinference/api_op_DescribeAcceleratorTypes.go @@ -11,15 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the accelerator types available in a given region, as well as their -// characteristics, such as memory and throughput. February 15, 2023: Starting -// April 15, 2023, AWS 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 customers and will be -// able to continue using the service. +// Describes the accelerator types available in a given region, as well as their +// +// characteristics, such as memory and throughput. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. func (c *Client) DescribeAcceleratorTypes(ctx context.Context, params *DescribeAcceleratorTypesInput, optFns ...func(*Options)) (*DescribeAcceleratorTypesOutput, error) { if params == nil { params = &DescribeAcceleratorTypesInput{} @@ -41,7 +43,7 @@ type DescribeAcceleratorTypesInput struct { type DescribeAcceleratorTypesOutput struct { - // The available accelerator types. + // The available accelerator types. AcceleratorTypes []types.AcceleratorType // Metadata pertaining to the operation's result. diff --git a/service/elasticinference/api_op_DescribeAccelerators.go b/service/elasticinference/api_op_DescribeAccelerators.go index 144f4ce263e..c3dc43882a8 100644 --- a/service/elasticinference/api_op_DescribeAccelerators.go +++ b/service/elasticinference/api_op_DescribeAccelerators.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes information over a provided set of accelerators belonging to an -// account. February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. +// Describes information over a provided set of accelerators belonging to an +// +// account. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. func (c *Client) DescribeAccelerators(ctx context.Context, params *DescribeAcceleratorsInput, optFns ...func(*Options)) (*DescribeAcceleratorsOutput, error) { if params == nil { params = &DescribeAcceleratorsInput{} @@ -36,22 +39,22 @@ func (c *Client) DescribeAccelerators(ctx context.Context, params *DescribeAccel type DescribeAcceleratorsInput struct { - // The IDs of the accelerators to describe. + // The IDs of the accelerators to describe. AcceleratorIds []string - // One or more filters. Filter names and values are case-sensitive. Valid filter + // One or more filters. Filter names and values are case-sensitive. Valid filter // names are: accelerator-types: can provide a list of accelerator type names to // 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 + // 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 + // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string @@ -60,10 +63,10 @@ type DescribeAcceleratorsInput struct { type DescribeAcceleratorsOutput struct { - // The details of the Elastic Inference Accelerators. + // The details of the Elastic Inference Accelerators. AcceleratorSet []types.ElasticInferenceAccelerator - // A token to specify where to start paginating. This is the NextToken from a + // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string @@ -160,7 +163,7 @@ 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 + // 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 diff --git a/service/elasticinference/api_op_ListTagsForResource.go b/service/elasticinference/api_op_ListTagsForResource.go index 2c94e165d82..379f261cef1 100644 --- a/service/elasticinference/api_op_ListTagsForResource.go +++ b/service/elasticinference/api_op_ListTagsForResource.go @@ -10,14 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns all tags of an Elastic Inference Accelerator. February 15, 2023: -// Starting April 15, 2023, AWS 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 -// customers and will be able to continue using the service. +// Returns all tags of an Elastic Inference Accelerator. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -35,7 +36,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ARN of the Elastic Inference Accelerator to list the tags for. + // The ARN of the Elastic Inference Accelerator to list the tags for. // // This member is required. ResourceArn *string @@ -45,7 +46,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags of the Elastic Inference Accelerator. + // The tags of the Elastic Inference Accelerator. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/elasticinference/api_op_TagResource.go b/service/elasticinference/api_op_TagResource.go index e21b4798d4a..cc0460cdb76 100644 --- a/service/elasticinference/api_op_TagResource.go +++ b/service/elasticinference/api_op_TagResource.go @@ -10,14 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified tags to an Elastic Inference Accelerator. February 15, 2023: -// Starting April 15, 2023, AWS 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 -// customers and will be able to continue using the service. +// Adds the specified tags to an Elastic Inference Accelerator. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -35,12 +36,12 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ARN of the Elastic Inference Accelerator to tag. + // The ARN of the Elastic Inference Accelerator to tag. // // This member is required. ResourceArn *string - // The tags to add to the Elastic Inference Accelerator. + // The tags to add to the Elastic Inference Accelerator. // // This member is required. Tags map[string]string diff --git a/service/elasticinference/api_op_UntagResource.go b/service/elasticinference/api_op_UntagResource.go index 31cb70a8812..f67b434943e 100644 --- a/service/elasticinference/api_op_UntagResource.go +++ b/service/elasticinference/api_op_UntagResource.go @@ -10,14 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified tags from an Elastic Inference Accelerator. February 15, -// 2023: Starting April 15, 2023, AWS 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 -// customers and will be able to continue using the service. +// Removes the specified tags from an Elastic Inference Accelerator. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -35,12 +36,12 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The ARN of the Elastic Inference Accelerator to untag. + // The ARN of the Elastic Inference Accelerator to untag. // // This member is required. ResourceArn *string - // The list of tags to remove from the Elastic Inference Accelerator. + // The list of tags to remove from the Elastic Inference Accelerator. // // This member is required. TagKeys []string diff --git a/service/elasticinference/doc.go b/service/elasticinference/doc.go index 4dcedb206c1..9574249f2c3 100644 --- a/service/elasticinference/doc.go +++ b/service/elasticinference/doc.go @@ -3,12 +3,13 @@ // Package elasticinference provides the API client, operations, and parameter // types for Amazon Elastic Inference. // -// Elastic Inference public APIs. February 15, 2023: Starting April 15, 2023, AWS -// 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 customers and will be able to continue -// using the service. +// Elastic Inference public APIs. +// +// February 15, 2023: Starting April 15, 2023, AWS 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 customers and will be able to continue using the service. package elasticinference diff --git a/service/elasticinference/options.go b/service/elasticinference/options.go index a85a7dd5a28..16928b89c72 100644 --- a/service/elasticinference/options.go +++ b/service/elasticinference/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elasticinference/types/enums.go b/service/elasticinference/types/enums.go index 367131fd99e..92ff3284abe 100644 --- a/service/elasticinference/types/enums.go +++ b/service/elasticinference/types/enums.go @@ -12,8 +12,9 @@ const ( ) // 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. +// expanded in the future, and so 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/elasticinference/types/types.go b/service/elasticinference/types/types.go index e3c30b43faa..767c86a5a2a 100644 --- a/service/elasticinference/types/types.go +++ b/service/elasticinference/types/types.go @@ -9,13 +9,13 @@ import ( // The details of an Elastic Inference Accelerator type. type AcceleratorType struct { - // The name of the Elastic Inference Accelerator type. + // The name of the Elastic Inference Accelerator type. AcceleratorTypeName *string - // The memory information of the Elastic Inference Accelerator type. + // The memory information of the Elastic Inference Accelerator type. MemoryInfo *MemoryInfo - // The throughput information of the Elastic Inference Accelerator type. + // The throughput information of the Elastic Inference Accelerator type. ThroughputInfo []KeyValuePair noSmithyDocumentSerde @@ -24,19 +24,19 @@ type AcceleratorType struct { // The offering for an Elastic Inference Accelerator type. type AcceleratorTypeOffering struct { - // The name of the Elastic Inference Accelerator type. + // The name of the Elastic Inference Accelerator type. AcceleratorType *string - // The location for the offering. It will return either the region, availability + // The location for the offering. It will return either the region, availability // zone or availability zone id for the offering depending on the locationType // value. Location *string - // The location type for the offering. It can assume the following values: region: - // defines that the offering is at the regional level. availability-zone: defines - // that the offering is at the availability zone level. availability-zone-id: - // defines that the offering is at the availability zone level, defined by the - // availability zone id. + // The location type for the offering. It can assume the following values: + // region: defines that the offering is at the regional level. availability-zone: + // defines that the offering is at the availability zone level. + // availability-zone-id: defines that the offering is at the availability zone + // level, defined by the availability zone id. LocationType LocationType noSmithyDocumentSerde @@ -45,19 +45,19 @@ type AcceleratorTypeOffering struct { // The details of an Elastic Inference Accelerator. type ElasticInferenceAccelerator struct { - // The health of the Elastic Inference Accelerator. + // The health of the Elastic Inference Accelerator. AcceleratorHealth *ElasticInferenceAcceleratorHealth - // The ID of the Elastic Inference Accelerator. + // The ID of the Elastic Inference Accelerator. AcceleratorId *string - // The type of the Elastic Inference Accelerator. + // The type of the Elastic Inference Accelerator. AcceleratorType *string - // The ARN of the resource that the Elastic Inference Accelerator is attached to. + // The ARN of the resource that the Elastic Inference Accelerator is attached to. AttachedResource *string - // The availability zone where the Elastic Inference Accelerator is present. + // The availability zone where the Elastic Inference Accelerator is present. AvailabilityZone *string noSmithyDocumentSerde @@ -66,7 +66,7 @@ type ElasticInferenceAccelerator struct { // The health details of an Elastic Inference Accelerator. type ElasticInferenceAcceleratorHealth struct { - // The health status of the Elastic Inference Accelerator. + // The health status of the Elastic Inference Accelerator. Status *string noSmithyDocumentSerde @@ -75,12 +75,12 @@ type ElasticInferenceAcceleratorHealth struct { // A filter expression for the Elastic Inference Accelerator list. type Filter struct { - // The filter name for the Elastic Inference Accelerator list. It can assume the + // The filter name for the Elastic Inference Accelerator list. It can assume the // following values: accelerator-type: the type of Elastic Inference Accelerator to // filter for. instance-id: an EC2 instance id to filter for. Name *string - // The values for the filter of the Elastic Inference Accelerator list. + // The values for the filter of the Elastic Inference Accelerator list. Values []string noSmithyDocumentSerde @@ -89,12 +89,12 @@ type Filter struct { // A throughput entry for an Elastic Inference Accelerator type. type KeyValuePair struct { - // The throughput value of the Elastic Inference Accelerator type. It can assume + // The throughput value of the Elastic Inference Accelerator type. It can assume // the following values: TFLOPS16bit: the throughput expressed in 16bit TeraFLOPS. // TFLOPS32bit: the throughput expressed in 32bit TeraFLOPS. Key *string - // The throughput value of the Elastic Inference Accelerator type. + // The throughput value of the Elastic Inference Accelerator type. Value int32 noSmithyDocumentSerde @@ -103,7 +103,7 @@ type KeyValuePair struct { // The memory information of an Elastic Inference Accelerator type. type MemoryInfo struct { - // The size in mebibytes of the Elastic Inference Accelerator type. + // The size in mebibytes of the Elastic Inference Accelerator type. SizeInMiB int32 noSmithyDocumentSerde diff --git a/service/elasticloadbalancing/api_op_AddTags.go b/service/elasticloadbalancing/api_op_AddTags.go index 65baaae7c97..b0f0a779e64 100644 --- a/service/elasticloadbalancing/api_op_AddTags.go +++ b/service/elasticloadbalancing/api_op_AddTags.go @@ -12,10 +12,14 @@ 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) -// in the Classic Load Balancers Guide. +// 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] in the Classic Load Balancers Guide. +// +// [Tag Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-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/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go b/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go index 6dc150617a3..68491ae1d2a 100644 --- a/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_ApplySecurityGroupsToLoadBalancer.go @@ -12,9 +12,11 @@ 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) -// in the Classic Load Balancers Guide. +// associated security groups. +// +// For more information, see [Security Groups for Load Balancers in a VPC] in the Classic Load Balancers Guide. +// +// [Security Groups for Load Balancers in a VPC]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups func (c *Client) ApplySecurityGroupsToLoadBalancer(ctx context.Context, params *ApplySecurityGroupsToLoadBalancerInput, optFns ...func(*Options)) (*ApplySecurityGroupsToLoadBalancerOutput, error) { if params == nil { params = &ApplySecurityGroupsToLoadBalancerInput{} diff --git a/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go b/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go index ffb2028f563..ebd09a95e7c 100644 --- a/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go +++ b/service/elasticloadbalancing/api_op_AttachLoadBalancerToSubnets.go @@ -11,10 +11,12 @@ import ( ) // 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. +// 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]in the Classic Load Balancers Guide. +// +// [Add or Remove Subnets for Your Load Balancer in a VPC]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html func (c *Client) AttachLoadBalancerToSubnets(ctx context.Context, params *AttachLoadBalancerToSubnetsInput, optFns ...func(*Options)) (*AttachLoadBalancerToSubnetsOutput, error) { if params == nil { params = &AttachLoadBalancerToSubnetsInput{} diff --git a/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go b/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go index 9bcfcd514ad..03fa0ca9f98 100644 --- a/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go +++ b/service/elasticloadbalancing/api_op_ConfigureHealthCheck.go @@ -12,9 +12,11 @@ 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) -// in the Classic Load Balancers Guide. +// your EC2 instances. +// +// For more information, see [Configure Health Checks for Your Load Balancer] in the Classic Load Balancers Guide. +// +// [Configure Health Checks for Your Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html func (c *Client) ConfigureHealthCheck(ctx context.Context, params *ConfigureHealthCheckInput, optFns ...func(*Options)) (*ConfigureHealthCheckOutput, error) { if params == nil { params = &ConfigureHealthCheckInput{} diff --git a/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go b/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go index c70083fb5ef..ef55a343b7b 100644 --- a/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateAppCookieStickinessPolicy.go @@ -12,16 +12,20 @@ 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 +// 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) -// in the Classic Load Balancers Guide. +// 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] in the Classic Load Balancers Guide. +// +// [Application-Controlled Session Stickiness]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application func (c *Client) CreateAppCookieStickinessPolicy(ctx context.Context, params *CreateAppCookieStickinessPolicyInput, optFns ...func(*Options)) (*CreateAppCookieStickinessPolicyOutput, error) { if params == nil { params = &CreateAppCookieStickinessPolicyInput{} diff --git a/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go b/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go index 8566a39ae4e..06649887a1e 100644 --- a/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateLBCookieStickinessPolicy.go @@ -12,17 +12,22 @@ import ( // Generates a stickiness policy with sticky session lifetimes controlled by the // lifetime of the browser (user-agent) or a specified expiration period. This -// policy can be associated only with HTTP/HTTPS listeners. When a load balancer -// implements this policy, the load balancer uses a special cookie to track the -// instance for each request. When the load balancer receives a request, it first -// checks to see if this cookie is present in the request. If so, the load balancer -// sends the request to the application server specified in the cookie. If not, the -// load balancer sends the request to a server that is chosen based on the existing -// 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) -// in the Classic Load Balancers Guide. +// policy can be associated only with HTTP/HTTPS listeners. +// +// When a load balancer implements this policy, the load balancer uses a special +// cookie to track the instance for each request. When the load balancer receives a +// request, it first checks to see if this cookie is present in the request. If so, +// the load balancer sends the request to the application server specified in the +// cookie. If not, the load balancer sends the request to a server that is chosen +// based on the existing 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] in the Classic Load Balancers Guide. +// +// [Duration-Based Session Stickiness]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration func (c *Client) CreateLBCookieStickinessPolicy(ctx context.Context, params *CreateLBCookieStickinessPolicyInput, optFns ...func(*Options)) (*CreateLBCookieStickinessPolicyOutput, error) { if params == nil { params = &CreateLBCookieStickinessPolicyInput{} diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancer.go b/service/elasticloadbalancing/api_op_CreateLoadBalancer.go index 6165319828f..c47872164d9 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancer.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the Classic Load Balancers Guide. +// 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 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]in the Classic Load Balancers Guide. +// +// [Limits for Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalancerInput, optFns ...func(*Options)) (*CreateLoadBalancerOutput, error) { if params == nil { params = &CreateLoadBalancerInput{} @@ -39,31 +42,42 @@ func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalan // Contains the parameters for CreateLoadBalancer. 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) - // in the Classic Load Balancers Guide. + // The listeners. + // + // For more information, see [Listeners for Your Classic Load Balancer] in the Classic Load Balancers Guide. + // + // [Listeners for Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html // // This member is required. Listeners []types.Listener - // The name of the load balancer. This name must be unique within your set of load - // balancers for the region, must have a maximum of 32 characters, must contain - // only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. + // The name of the load balancer. + // + // This name must be unique within your set of load balancers for the region, must + // have a maximum of 32 characters, must contain only alphanumeric characters or + // hyphens, and cannot begin or end with a hyphen. // // This member is required. LoadBalancerName *string - // 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 . + // 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. 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) - // in the Elastic Load Balancing User Guide. Specify internal to create a load - // balancer with a DNS name that resolves to private IP addresses. + // 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]in the Elastic Load Balancing + // User Guide. + // + // Specify internal to create a load balancer with a DNS name that resolves to + // private IP addresses. + // + // [Load Balancer Scheme]: https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme Scheme *string // The IDs of the security groups to assign to the load balancer. @@ -73,9 +87,12 @@ type CreateLoadBalancerInput struct { // 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) - // in the Classic Load Balancers Guide. + // A list of tags to assign to the load balancer. + // + // For more information about tagging your load balancer, see [Tag Your Classic Load Balancer] in the Classic Load + // Balancers Guide. + // + // [Tag Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go b/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go index 8704fe2b9ea..c4dcb696ee9 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancerListeners.go @@ -14,8 +14,11 @@ 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) -// in the Classic Load Balancers Guide. +// listener. +// +// For more information, see [Listeners for Your Classic Load Balancer] in the Classic Load Balancers Guide. +// +// [Listeners for Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html func (c *Client) CreateLoadBalancerListeners(ctx context.Context, params *CreateLoadBalancerListenersInput, optFns ...func(*Options)) (*CreateLoadBalancerListenersOutput, error) { if params == nil { params = &CreateLoadBalancerListenersInput{} diff --git a/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go b/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go index 66b4007069a..d469465f9b2 100644 --- a/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go +++ b/service/elasticloadbalancing/api_op_CreateLoadBalancerPolicy.go @@ -12,6 +12,7 @@ import ( ) // Creates a policy with the specified attributes for the specified load balancer. +// // Policies are settings that are saved for your load balancer and that can be // applied to the listener or the application server, depending on the policy type. func (c *Client) CreateLoadBalancerPolicy(ctx context.Context, params *CreateLoadBalancerPolicyInput, optFns ...func(*Options)) (*CreateLoadBalancerPolicyOutput, error) { @@ -43,8 +44,7 @@ type CreateLoadBalancerPolicyInput struct { // This member is required. PolicyName *string - // The name of the base policy type. To get the list of policy types, use - // DescribeLoadBalancerPolicyTypes . + // The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes. // // This member is required. PolicyTypeName *string diff --git a/service/elasticloadbalancing/api_op_DeleteLoadBalancer.go b/service/elasticloadbalancing/api_op_DeleteLoadBalancer.go index c18d09366d3..8b8684706d9 100644 --- a/service/elasticloadbalancing/api_op_DeleteLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DeleteLoadBalancer.go @@ -10,13 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified load balancer. If you are attempting to recreate a load -// balancer, you must reconfigure all settings. The DNS name associated with a -// deleted load balancer are no longer usable. The name and associated DNS record -// of the deleted load balancer no longer exist and traffic sent to any of its IP -// addresses is no longer delivered to your instances. If the load balancer does -// not exist or has already been deleted, the call to DeleteLoadBalancer still -// succeeds. +// Deletes the specified load balancer. +// +// If you are attempting to recreate a load balancer, you must reconfigure all +// settings. The DNS name associated with a deleted load balancer are no longer +// usable. The name and associated DNS record of the deleted load balancer no +// longer exist and traffic sent to any of its IP addresses is no longer delivered +// to your instances. +// +// If the load balancer does not exist or has already been deleted, the call to +// DeleteLoadBalancer still succeeds. func (c *Client) DeleteLoadBalancer(ctx context.Context, params *DeleteLoadBalancerInput, optFns ...func(*Options)) (*DeleteLoadBalancerOutput, error) { if params == nil { params = &DeleteLoadBalancerInput{} diff --git a/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go b/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go index 15ff0d5a1d2..5ad2da36920 100644 --- a/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DeregisterInstancesFromLoadBalancer.go @@ -13,10 +13,12 @@ import ( // Deregisters the specified instances from the specified load balancer. After the // 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) -// in the Classic Load Balancers Guide. +// +// 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] in the Classic Load Balancers Guide. +// +// [Register or De-Register EC2 Instances]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html func (c *Client) DeregisterInstancesFromLoadBalancer(ctx context.Context, params *DeregisterInstancesFromLoadBalancerInput, optFns ...func(*Options)) (*DeregisterInstancesFromLoadBalancerOutput, error) { if params == nil { params = &DeregisterInstancesFromLoadBalancerInput{} diff --git a/service/elasticloadbalancing/api_op_DescribeAccountLimits.go b/service/elasticloadbalancing/api_op_DescribeAccountLimits.go index 9b22fc668f1..93e09f5310a 100644 --- a/service/elasticloadbalancing/api_op_DescribeAccountLimits.go +++ b/service/elasticloadbalancing/api_op_DescribeAccountLimits.go @@ -12,8 +12,11 @@ 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) -// in the Classic Load Balancers Guide. +// account. +// +// For more information, see [Limits for Your Classic Load Balancer] in the Classic Load Balancers Guide. +// +// [Limits for Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { params = &DescribeAccountLimitsInput{} diff --git a/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go b/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go index 263c9d86822..bb4b6689c47 100644 --- a/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go +++ b/service/elasticloadbalancing/api_op_DescribeInstanceHealth.go @@ -184,12 +184,13 @@ type AnyInstanceInServiceWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstanceHealthInput, *DescribeInstanceHealthOutput, error) (bool, error) } @@ -365,12 +366,13 @@ type InstanceDeregisteredWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstanceHealthInput, *DescribeInstanceHealthOutput, error) (bool, error) } @@ -564,12 +566,13 @@ type InstanceInServiceWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstanceHealthInput, *DescribeInstanceHealthOutput, error) (bool, error) } diff --git a/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicies.go b/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicies.go index fe37a8000e8..ba8eadb79db 100644 --- a/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicies.go +++ b/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicies.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified policies. If you specify a load balancer name, the -// action returns the descriptions of all policies created for the load balancer. -// If you specify a policy name associated with your load balancer, the action -// returns the description of that policy. If you don't specify a load balancer -// name, the action returns descriptions of the specified sample policies, or -// descriptions of all sample policies. The names of the sample policies have the -// ELBSample- prefix. +// Describes the specified policies. +// +// If you specify a load balancer name, the action returns the descriptions of all +// policies created for the load balancer. If you specify a policy name associated +// with your load balancer, the action returns the description of that policy. If +// you don't specify a load balancer name, the action returns descriptions of the +// specified sample policies, or descriptions of all sample policies. The names of +// the sample policies have the ELBSample- prefix. func (c *Client) DescribeLoadBalancerPolicies(ctx context.Context, params *DescribeLoadBalancerPoliciesInput, optFns ...func(*Options)) (*DescribeLoadBalancerPoliciesOutput, error) { if params == nil { params = &DescribeLoadBalancerPoliciesInput{} diff --git a/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go b/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go index c761a60ddf1..3da4007e1c6 100644 --- a/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go +++ b/service/elasticloadbalancing/api_op_DescribeLoadBalancerPolicyTypes.go @@ -12,13 +12,15 @@ import ( ) // Describes the specified load balancer policy types or all load balancer policy -// 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. +// 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 SetLoadBalancerPoliciesOfListeneror 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_DetachLoadBalancerFromSubnets.go b/service/elasticloadbalancing/api_op_DetachLoadBalancerFromSubnets.go index 528c017bcd2..6c1dc3cec6d 100644 --- a/service/elasticloadbalancing/api_op_DetachLoadBalancerFromSubnets.go +++ b/service/elasticloadbalancing/api_op_DetachLoadBalancerFromSubnets.go @@ -11,9 +11,11 @@ import ( ) // Removes the specified subnets from the set of configured subnets for the load -// balancer. After a subnet is removed, all EC2 instances registered with the load -// balancer in the removed subnet go into the OutOfService state. Then, the load -// balancer balances the traffic among the remaining routable subnets. +// balancer. +// +// After a subnet is removed, all EC2 instances registered with the load balancer +// in the removed subnet go into the OutOfService state. Then, the load balancer +// balances the traffic among the remaining routable subnets. func (c *Client) DetachLoadBalancerFromSubnets(ctx context.Context, params *DetachLoadBalancerFromSubnetsInput, optFns ...func(*Options)) (*DetachLoadBalancerFromSubnetsOutput, error) { if params == nil { params = &DetachLoadBalancerFromSubnetsInput{} diff --git a/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go b/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go index f588792f67a..2badeea9e69 100644 --- a/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_DisableAvailabilityZonesForLoadBalancer.go @@ -11,14 +11,19 @@ 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 -// 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) -// in the Classic Load Balancers Guide. +// 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 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] in the Classic Load Balancers Guide. +// +// [Add or Remove Availability Zones]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html func (c *Client) DisableAvailabilityZonesForLoadBalancer(ctx context.Context, params *DisableAvailabilityZonesForLoadBalancerInput, optFns ...func(*Options)) (*DisableAvailabilityZonesForLoadBalancerOutput, error) { if params == nil { params = &DisableAvailabilityZonesForLoadBalancerInput{} diff --git a/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go b/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go index afcb8bf47a9..4fd593a1d23 100644 --- a/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_EnableAvailabilityZonesForLoadBalancer.go @@ -11,11 +11,15 @@ 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 -// 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) -// in the Classic Load Balancers Guide. +// specified load balancer in EC2-Classic or a default VPC. +// +// For load balancers in a 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]in the +// Classic Load Balancers Guide. +// +// [Add or Remove Availability Zones]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html func (c *Client) EnableAvailabilityZonesForLoadBalancer(ctx context.Context, params *EnableAvailabilityZonesForLoadBalancerInput, optFns ...func(*Options)) (*EnableAvailabilityZonesForLoadBalancerOutput, error) { if params == nil { params = &EnableAvailabilityZonesForLoadBalancerInput{} diff --git a/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go b/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go index d1b0d534370..860d440c323 100644 --- a/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go +++ b/service/elasticloadbalancing/api_op_ModifyLoadBalancerAttributes.go @@ -11,16 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the attributes of the specified load balancer. You can modify the load -// 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) +// Modifies the attributes of the specified load balancer. +// +// You can modify the load 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] +// +// [Connection Draining] +// +// [Access Logs] +// +// [Idle Connection Timeout] +// +// [Cross-Zone Load Balancing]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html +// [Idle Connection Timeout]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html +// [Access Logs]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html +// [Connection Draining]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.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 6fca25a3051..6a542c422a5 100644 --- a/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go +++ b/service/elasticloadbalancing/api_op_RegisterInstancesWithLoadBalancer.go @@ -11,23 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified instances to the specified load balancer. The instance must -// be a running instance in the same network as the load balancer (EC2-Classic or -// the same VPC). If you have EC2-Classic instances and a load balancer in a VPC -// with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and -// then register the linked EC2-Classic instances with the load balancer in the -// 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 -// 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) -// in the Classic Load Balancers Guide. +// Adds the specified instances to the specified load balancer. +// +// The instance must be a running instance in the same network as the load +// balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a +// load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic +// instances to that VPC and then register the linked EC2-Classic instances with +// the load balancer in the 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 DescribeLoadBalancersor 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] in the Classic Load Balancers Guide. +// +// [Register or De-Register EC2 Instances]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html func (c *Client) RegisterInstancesWithLoadBalancer(ctx context.Context, params *RegisterInstancesWithLoadBalancerInput, optFns ...func(*Options)) (*RegisterInstancesWithLoadBalancerOutput, error) { if params == nil { params = &RegisterInstancesWithLoadBalancerInput{} diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go b/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go index cbcbc746809..6b698707137 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerListenerSSLCertificate.go @@ -12,9 +12,12 @@ 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) -// in the Classic Load Balancers Guide. +// same load balancer and port. +// +// For more information about updating your SSL certificate, see [Replace the SSL Certificate for Your Load Balancer] in the Classic +// Load Balancers Guide. +// +// [Replace the SSL Certificate for Your Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html func (c *Client) SetLoadBalancerListenerSSLCertificate(ctx context.Context, params *SetLoadBalancerListenerSSLCertificateInput, optFns ...func(*Options)) (*SetLoadBalancerListenerSSLCertificateOutput, error) { if params == nil { params = &SetLoadBalancerListenerSSLCertificateInput{} diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go index c858d084540..f026dae7872 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesForBackendServer.go @@ -13,15 +13,20 @@ import ( // 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) -// 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) -// in the Classic Load Balancers Guide. +// 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] in +// the Classic Load Balancers Guide. For more information about Proxy Protocol, see +// [Configure Proxy Protocol Support]in the Classic Load Balancers Guide. +// +// [Configure Back-end Instance Authentication]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt +// [Configure Proxy Protocol Support]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html func (c *Client) SetLoadBalancerPoliciesForBackendServer(ctx context.Context, params *SetLoadBalancerPoliciesForBackendServerInput, optFns ...func(*Options)) (*SetLoadBalancerPoliciesForBackendServerOutput, error) { if params == nil { params = &SetLoadBalancerPoliciesForBackendServerInput{} diff --git a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go index ceb92c823c3..39e74100f5b 100644 --- a/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go +++ b/service/elasticloadbalancing/api_op_SetLoadBalancerPoliciesOfListener.go @@ -11,12 +11,16 @@ 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) -// in the Classic Load Balancers Guide. +// 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], [Duration-Based Session Stickiness], and [Application-Controlled Session Stickiness] in the Classic Load +// Balancers Guide. +// +// [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 +// [Application-Controlled Session Stickiness]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application func (c *Client) SetLoadBalancerPoliciesOfListener(ctx context.Context, params *SetLoadBalancerPoliciesOfListenerInput, optFns ...func(*Options)) (*SetLoadBalancerPoliciesOfListenerOutput, error) { if params == nil { params = &SetLoadBalancerPoliciesOfListenerInput{} diff --git a/service/elasticloadbalancing/doc.go b/service/elasticloadbalancing/doc.go index 9027b14ce71..426f94020dc 100644 --- a/service/elasticloadbalancing/doc.go +++ b/service/elasticloadbalancing/doc.go @@ -3,23 +3,31 @@ // Package elasticloadbalancing provides the API client, operations, and parameter // types for Elastic Load Balancing. // -// Elastic Load Balancing A load balancer can distribute incoming traffic across -// your EC2 instances. This enables you to increase the availability of your -// application. The load balancer also monitors the health of its registered -// instances and ensures that it routes traffic only to healthy instances. You -// configure your load balancer to accept incoming traffic by specifying one or -// more listeners, which are configured with a protocol and port number for -// connections from clients to the load balancer and a protocol and port number for -// connections from the load balancer to the instances. Elastic Load Balancing -// 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 +// # Elastic Load Balancing +// +// A load balancer can distribute incoming traffic across your EC2 instances. This +// enables you to increase the availability of your application. The load balancer +// also monitors the health of its registered instances and ensures that it routes +// traffic only to healthy instances. You configure your load balancer to accept +// incoming traffic by specifying one or more listeners, which are configured with +// a protocol and port number for connections from clients to the load balancer and +// a protocol and port number for connections from the load balancer to the +// instances. +// +// Elastic Load Balancing 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]. +// +// 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. +// 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. +// +// [Elastic Load Balancing User Guide]: https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/ package elasticloadbalancing diff --git a/service/elasticloadbalancing/options.go b/service/elasticloadbalancing/options.go index e727763ea75..c15e68a4c51 100644 --- a/service/elasticloadbalancing/options.go +++ b/service/elasticloadbalancing/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elasticloadbalancing/types/types.go b/service/elasticloadbalancing/types/types.go index ab27094115d..0c6472247a1 100644 --- a/service/elasticloadbalancing/types/types.go +++ b/service/elasticloadbalancing/types/types.go @@ -16,7 +16,9 @@ type AccessLog struct { Enabled bool // The interval for publishing the access logs. You can specify an interval of - // either 5 minutes or 60 minutes. Default: 60 minutes + // either 5 minutes or 60 minutes. + // + // Default: 60 minutes EmitInterval *int32 // The name of the Amazon S3 bucket where the access logs are stored. @@ -33,7 +35,10 @@ type AccessLog struct { // Information about additional load balancer attributes. type AdditionalAttribute struct { - // The name of the attribute. The following attribute is supported. + // 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 . @@ -124,23 +129,31 @@ type HealthCheck struct { 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 - // 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 - // include a ping path in the string. HTTP is specified as a - // HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". - // In this case, a HTTP GET request is issued to the instance on the given port and - // path. Any answer other than "200 OK" within the timeout period is considered - // unhealthy. The total length of the HTTP ping target must be 1024 16-bit Unicode - // characters or less. + // 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 include a ping path in the string. HTTP is specified + // as a HTTP:port;/;PathToPing; grouping, for example + // "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to + // the instance on the given port and path. Any answer other than "200 OK" within + // the timeout period is considered unhealthy. + // + // The total length of the HTTP ping target must be 1024 16-bit Unicode characters + // or less. // // This member is required. Target *string // The amount of time, in seconds, during which no response means a failed health - // check. This value must be less than the Interval value. + // check. + // + // This value must be less than the Interval value. // // This member is required. Timeout *int32 @@ -168,20 +181,32 @@ 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. Description *string @@ -189,12 +214,14 @@ type InstanceState struct { 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 + // 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 | - // Unknown + // The current state of the instance. + // + // Valid values: InService | OutOfService | Unknown State *string noSmithyDocumentSerde @@ -222,18 +249,23 @@ type Limit struct { Max *string // The name of the limit. The possible values are: + // // - classic-listeners + // // - classic-load-balancers + // // - classic-registered-instances Name *string noSmithyDocumentSerde } -// 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) -// in the Classic Load Balancers Guide. +// Information about a listener. +// +// For information about the protocols and the ports supported by Elastic Load +// Balancing, see [Listeners for Your Classic Load Balancer]in the Classic Load Balancers Guide. +// +// [Listeners for Your Classic Load Balancer]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html type Listener struct { // The port on which the instance is listening. @@ -255,13 +287,16 @@ type Listener struct { Protocol *string // The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL. + // // 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. + // 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 *string // The Amazon Resource Name (ARN) of the server certificate. @@ -286,32 +321,40 @@ type ListenerDescription struct { 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) - // in the Classic Load Balancers Guide. + // delivers the information to the Amazon S3 bucket that you specify. + // + // For more information, see [Enable Access Logs] in the Classic Load Balancers Guide. + // + // [Enable Access Logs]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html AccessLog *AccessLog // Any additional attributes. AdditionalAttributes []AdditionalAttribute // 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) - // in the Classic Load Balancers Guide. + // load balancer shifts traffic away from a deregistered or unhealthy instance. + // + // For more information, see [Configure Connection Draining] in the Classic Load Balancers Guide. + // + // [Configure Connection Draining]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html ConnectionDraining *ConnectionDraining // If enabled, the load balancer allows the connections to remain idle (no data is - // 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) - // in the Classic Load Balancers Guide. + // 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]in the Classic Load Balancers Guide. + // + // [Configure Idle Connection Timeout]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html 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) - // in the Classic Load Balancers Guide. + // instances regardless of the Availability Zones. + // + // For more information, see [Configure Cross-Zone Load Balancing] in the Classic Load Balancers Guide. + // + // [Configure Cross-Zone Load Balancing]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html CrossZoneLoadBalancing *CrossZoneLoadBalancing noSmithyDocumentSerde @@ -326,9 +369,11 @@ type LoadBalancerDescription struct { // Information about your EC2 instances. 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) - // in the Classic Load Balancers Guide. + // The DNS name of the load balancer. + // + // For more information, see [Configure a Custom Domain Name] in the Classic Load Balancers Guide. + // + // [Configure a Custom Domain Name]: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html CanonicalHostedZoneName *string // The ID of the Amazon Route 53 hosted zone for the load balancer. @@ -355,10 +400,13 @@ type LoadBalancerDescription struct { // The policies defined for the load balancer. 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 - // name that resolves to a private IP address. + // 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 name that resolves to + // a private IP address. Scheme *string // The security groups for the load balancer. Valid only for load balancers in a @@ -383,10 +431,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. @@ -428,10 +476,16 @@ type PolicyAttributeTypeDescription struct { // The type of the attribute. For example, Boolean or Integer . AttributeType *string - // The cardinality of the attribute. Valid values: + // 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 Cardinality *string diff --git a/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go b/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go index cebeffe1738..e4c4b2d2826 100644 --- a/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_AddListenerCertificates.go @@ -12,11 +12,16 @@ 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) -// in the Network Load Balancers Guide. +// 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] in the Application Load Balancers Guide or [TLS listeners] in the +// Network Load Balancers Guide. +// +// [TLS listeners]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html +// [HTTPS listeners]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html func (c *Client) AddListenerCertificates(ctx context.Context, params *AddListenerCertificatesInput, optFns ...func(*Options)) (*AddListenerCertificatesOutput, error) { if params == nil { params = &AddListenerCertificatesInput{} diff --git a/service/elasticloadbalancingv2/api_op_AddTags.go b/service/elasticloadbalancingv2/api_op_AddTags.go index fdb74ded76a..e4c63788fdd 100644 --- a/service/elasticloadbalancingv2/api_op_AddTags.go +++ b/service/elasticloadbalancingv2/api_op_AddTags.go @@ -13,9 +13,10 @@ import ( // Adds the specified tags to the specified Elastic Load Balancing resource. You // can tag your Application Load Balancers, Network Load Balancers, Gateway Load -// Balancers, target groups, trust stores, listeners, and rules. Each tag consists -// of a key and an optional value. If a resource already has a tag with the same -// key, AddTags updates its value. +// Balancers, target groups, trust stores, listeners, and rules. +// +// Each tag consists of a key and an optional value. If a resource already has a +// tag with the same key, AddTags updates its value. func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { params = &AddTagsInput{} diff --git a/service/elasticloadbalancingv2/api_op_CreateListener.go b/service/elasticloadbalancingv2/api_op_CreateListener.go index 81eb123f5f8..9077a79c4d3 100644 --- a/service/elasticloadbalancingv2/api_op_CreateListener.go +++ b/service/elasticloadbalancingv2/api_op_CreateListener.go @@ -12,14 +12,23 @@ 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) +// Balancer, or Gateway Load Balancer. +// +// For more information, see the following: +// +// [Listeners for your Application Load Balancers] +// +// [Listeners for your Network Load Balancers] +// +// [Listeners for your Gateway Load Balancers] // // 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. +// +// [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 func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput, optFns ...func(*Options)) (*CreateListenerOutput, error) { if params == nil { params = &CreateListenerInput{} @@ -49,13 +58,20 @@ type CreateListenerInput struct { // [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) - // in the Network Load Balancers Guide. + // + // For more information, see [ALPN policies] in the Network Load Balancers Guide. + // + // [ALPN policies]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies AlpnPolicy []string // [HTTPS and TLS listeners] The default certificate for the listener. You must @@ -78,9 +94,12 @@ 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) - // in the Network Load Balancers Guide. + // ciphers are supported. + // + // For more information, see [Security policies] in the Application Load Balancers Guide and [Security policies] in the + // Network Load Balancers Guide. + // + // [Security policies]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies SslPolicy *string // The tags to assign to the listener. diff --git a/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go b/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go index cd9537a754c..b57f426aad4 100644 --- a/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go +++ b/service/elasticloadbalancingv2/api_op_CreateLoadBalancer.go @@ -12,14 +12,23 @@ 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) +// Balancer. +// +// For more information, see the following: +// +// [Application Load Balancers] +// +// [Network Load Balancers] +// +// [Gateway Load Balancers] // // 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. +// +// [Gateway Load Balancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html +// [Network Load Balancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html +// [Application Load Balancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalancerInput, optFns ...func(*Options)) (*CreateLoadBalancerOutput, error) { if params == nil { params = &CreateLoadBalancerInput{} @@ -37,10 +46,11 @@ func (c *Client) CreateLoadBalancer(ctx context.Context, params *CreateLoadBalan type CreateLoadBalancerInput struct { - // The name of the load balancer. This name must be unique per region per account, - // can have a maximum of 32 characters, must contain only alphanumeric characters - // or hyphens, must not begin or end with a hyphen, and must not begin with - // "internal-". + // The name of the load balancer. + // + // This name must be unique per region per account, can have a maximum of 32 + // characters, must contain only alphanumeric characters or hyphens, must not begin + // or end with a hyphen, and must not begin with "internal-". // // This member is required. Name *string @@ -57,12 +67,16 @@ type CreateLoadBalancerInput struct { // The nodes of an Internet-facing load balancer have public IP addresses. The DNS // name of an Internet-facing load balancer is publicly resolvable to the public IP // addresses of the nodes. Therefore, Internet-facing load balancers can route - // requests from clients over the internet. The nodes of an internal load balancer - // have only private IP addresses. The DNS name of an internal load balancer is - // publicly resolvable to the private IP addresses of the nodes. Therefore, - // internal load balancers can route requests only from clients with access to the - // VPC for the load balancer. The default is an Internet-facing load balancer. You - // cannot specify a scheme for a Gateway Load Balancer. + // requests from clients over the internet. + // + // The nodes of an internal load balancer have only private IP addresses. The DNS + // name of an internal load balancer is publicly resolvable to the private IP + // addresses of the nodes. Therefore, internal load balancers can route requests + // only from clients with access to the VPC for the load balancer. + // + // The default is an Internet-facing load balancer. + // + // You cannot specify a scheme for a Gateway Load Balancer. Scheme types.LoadBalancerSchemeEnum // [Application Load Balancers and Network Load Balancers] The IDs of the security @@ -70,29 +84,44 @@ type CreateLoadBalancerInput struct { SecurityGroups []string // The IDs of the subnets. You can specify only one subnet per Availability Zone. - // You must specify either subnets or subnet mappings, but not both. [Application - // Load Balancers] You must specify subnets from at least two Availability Zones. - // You cannot specify Elastic IP addresses for your subnets. [Application Load - // Balancers on Outposts] You must specify one Outpost subnet. [Application Load - // Balancers on Local Zones] You can specify subnets from one or more Local Zones. + // You must specify either subnets or subnet mappings, but not both. + // + // [Application Load Balancers] You must specify subnets from at least two + // Availability Zones. You cannot specify Elastic IP addresses for your subnets. + // + // [Application Load Balancers on Outposts] You must specify one Outpost subnet. + // + // [Application Load Balancers on Local Zones] You can specify subnets from one or + // more Local Zones. + // // [Network Load Balancers] You can specify subnets from one or more Availability // Zones. You can specify one Elastic IP address per subnet if you need static IP // addresses for your internet-facing load balancer. For internal load balancers, // you can specify one private IP address per subnet from the IPv4 range of the // subnet. For internet-facing load balancer, you can specify one IPv6 address per - // subnet. [Gateway Load Balancers] You can specify subnets from one or more - // Availability Zones. You cannot specify Elastic IP addresses for your subnets. + // subnet. + // + // [Gateway Load Balancers] You can specify subnets from one or more Availability + // Zones. You cannot specify Elastic IP addresses for your subnets. SubnetMappings []types.SubnetMapping // The IDs of the subnets. You can specify only one subnet per Availability Zone. // You must specify either subnets or subnet mappings, but not both. To specify an - // Elastic IP address, specify subnet mappings instead of subnets. [Application - // Load Balancers] You must specify subnets from at least two Availability Zones. + // Elastic IP address, specify subnet mappings instead of subnets. + // + // [Application Load Balancers] You must specify subnets from at least two + // Availability Zones. + // // [Application Load Balancers on Outposts] You must specify one Outpost subnet. + // // [Application Load Balancers on Local Zones] You can specify subnets from one or - // more Local Zones. [Network Load Balancers] You can specify subnets from one or - // more Availability Zones. [Gateway Load Balancers] You can specify subnets from - // one or more Availability Zones. + // more Local Zones. + // + // [Network Load Balancers] You can specify subnets from one or more Availability + // Zones. + // + // [Gateway Load Balancers] You can specify subnets from one or more Availability + // Zones. Subnets []string // The tags to assign to the load balancer. diff --git a/service/elasticloadbalancingv2/api_op_CreateRule.go b/service/elasticloadbalancingv2/api_op_CreateRule.go index bf9dc94ec27..e8a7b457197 100644 --- a/service/elasticloadbalancingv2/api_op_CreateRule.go +++ b/service/elasticloadbalancingv2/api_op_CreateRule.go @@ -12,12 +12,16 @@ import ( ) // Creates a rule for the specified listener. The listener must be associated with -// an Application Load Balancer. Each rule consists of a priority, one or more -// 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) -// in the Application Load Balancers Guide. +// an Application Load Balancer. +// +// Each rule consists of a priority, one or more 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]in the Application Load Balancers +// Guide. +// +// [Listener rules]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { params = &CreateRuleInput{} diff --git a/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go b/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go index 9f5f23d22d4..851776104a5 100644 --- a/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_CreateTargetGroup.go @@ -11,14 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Creates a target group. +// +// For more information, see the following: +// +// [Target groups for your Application Load Balancers] +// +// [Target groups for your Network Load Balancers] +// +// [Target groups for your Gateway Load Balancers] // // 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. +// +// [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 func (c *Client) CreateTargetGroup(ctx context.Context, params *CreateTargetGroupInput, optFns ...func(*Options)) (*CreateTargetGroupOutput, error) { if params == nil { params = &CreateTargetGroupInput{} @@ -36,9 +45,11 @@ func (c *Client) CreateTargetGroup(ctx context.Context, params *CreateTargetGrou type CreateTargetGroupInput struct { - // The name of the target group. This name must be unique per region per account, - // can have a maximum of 32 characters, must contain only alphanumeric characters - // or hyphens, and must not begin or end with a hyphen. + // The name of the target group. + // + // This name must be unique per region per account, can have a maximum of 32 + // characters, must contain only alphanumeric characters or hyphens, and must not + // begin or end with a hyphen. // // This member is required. Name *string @@ -56,9 +67,12 @@ type CreateTargetGroupInput struct { HealthCheckIntervalSeconds *int32 // [HTTP/HTTPS health checks] The destination for health checks on the targets. - // [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC - // protocol version] The path of a custom health check method with the format - // /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. + // + // [HTTP1 or HTTP2 protocol version] The ping path. The default is /. + // + // [GRPC protocol version] The path of a custom health check method with the + // format /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 @@ -126,12 +140,16 @@ 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. TargetType types.TargetTypeEnum diff --git a/service/elasticloadbalancingv2/api_op_CreateTrustStore.go b/service/elasticloadbalancingv2/api_op_CreateTrustStore.go index d2cabc4fc03..76c7a98f3a2 100644 --- a/service/elasticloadbalancingv2/api_op_CreateTrustStore.go +++ b/service/elasticloadbalancingv2/api_op_CreateTrustStore.go @@ -39,8 +39,9 @@ type CreateTrustStoreInput struct { // This member is required. CaCertificatesBundleS3Key *string - // The name of the trust store. This name must be unique per region and cannot be - // changed after creation. + // The name of the trust store. + // + // This name must be unique per region and cannot be changed after creation. // // This member is required. Name *string diff --git a/service/elasticloadbalancingv2/api_op_DeleteListener.go b/service/elasticloadbalancingv2/api_op_DeleteListener.go index bcadce0b1e0..49524bfd27e 100644 --- a/service/elasticloadbalancingv2/api_op_DeleteListener.go +++ b/service/elasticloadbalancingv2/api_op_DeleteListener.go @@ -10,8 +10,10 @@ 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_DeleteLoadBalancer.go b/service/elasticloadbalancingv2/api_op_DeleteLoadBalancer.go index c8451240fc2..1f8c58480e7 100644 --- a/service/elasticloadbalancingv2/api_op_DeleteLoadBalancer.go +++ b/service/elasticloadbalancingv2/api_op_DeleteLoadBalancer.go @@ -11,12 +11,15 @@ import ( ) // Deletes the specified Application Load Balancer, Network Load Balancer, or -// Gateway Load Balancer. Deleting a load balancer also deletes its listeners. You -// can't delete a load balancer if deletion protection is enabled. If the load -// balancer does not exist or has already been deleted, the call succeeds. Deleting -// a load balancer does not affect its registered targets. For example, your EC2 -// instances continue to run and are still registered to their target groups. If -// you no longer need these EC2 instances, you can stop or terminate them. +// Gateway Load Balancer. Deleting a load balancer also deletes its listeners. +// +// You can't delete a load balancer if deletion protection is enabled. If the load +// balancer does not exist or has already been deleted, the call succeeds. +// +// Deleting a load balancer does not affect its registered targets. For example, +// your EC2 instances continue to run and are still registered to their target +// groups. If you no longer need these EC2 instances, you can stop or terminate +// them. func (c *Client) DeleteLoadBalancer(ctx context.Context, params *DeleteLoadBalancerInput, optFns ...func(*Options)) (*DeleteLoadBalancerOutput, error) { if params == nil { params = &DeleteLoadBalancerInput{} diff --git a/service/elasticloadbalancingv2/api_op_DeleteRule.go b/service/elasticloadbalancingv2/api_op_DeleteRule.go index 43a865e12d1..ba3d88f345b 100644 --- a/service/elasticloadbalancingv2/api_op_DeleteRule.go +++ b/service/elasticloadbalancingv2/api_op_DeleteRule.go @@ -10,7 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified rule. You can't delete the default rule. +// Deletes the specified rule. +// +// You can't delete the default rule. func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} diff --git a/service/elasticloadbalancingv2/api_op_DeleteTargetGroup.go b/service/elasticloadbalancingv2/api_op_DeleteTargetGroup.go index c0a58ff9628..b66fd5f2595 100644 --- a/service/elasticloadbalancingv2/api_op_DeleteTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_DeleteTargetGroup.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified target group. You can delete a target group if it is not -// referenced by any actions. Deleting a target group also deletes any associated -// health checks. Deleting a target group does not affect its registered targets. -// For example, any EC2 instances continue to run until you stop or terminate them. +// Deletes the specified target group. +// +// You can delete a target group if it is not referenced by any actions. Deleting +// a target group also deletes any associated health checks. Deleting a target +// group does not affect its registered targets. For example, any EC2 instances +// continue to run until you stop or terminate them. func (c *Client) DeleteTargetGroup(ctx context.Context, params *DeleteTargetGroupInput, optFns ...func(*Options)) (*DeleteTargetGroupOutput, error) { if params == nil { params = &DeleteTargetGroupInput{} diff --git a/service/elasticloadbalancingv2/api_op_DeregisterTargets.go b/service/elasticloadbalancingv2/api_op_DeregisterTargets.go index 74d85c9e0dc..d81b8ac64cd 100644 --- a/service/elasticloadbalancingv2/api_op_DeregisterTargets.go +++ b/service/elasticloadbalancingv2/api_op_DeregisterTargets.go @@ -13,18 +13,26 @@ import ( // Deregisters the specified targets from the specified target group. After the // targets are deregistered, they no longer receive traffic from the load balancer. +// // The load balancer stops sending requests to targets that are deregistering, but // uses connection draining to ensure that in-flight traffic completes on the // existing connections. This deregistration delay is configured by default but can -// be updated for each target group. For more information, see the following: -// - Deregistration delay (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#deregistration-delay) -// in the Application Load Balancers User Guide -// - Deregistration delay (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#deregistration-delay) -// in the Network Load Balancers User Guide -// - Deregistration delay (https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html#deregistration-delay) -// in the Gateway Load Balancers User Guide +// be updated for each target group. +// +// For more information, see the following: +// +// [Deregistration delay] +// - in the Application Load Balancers User Guide +// +// [Deregistration delay] +// - in the Network Load Balancers User Guide +// +// [Deregistration delay] +// - in the Gateway Load Balancers User Guide // // Note: If the specified target does not exist, the action returns successfully. +// +// [Deregistration delay]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html#deregistration-delay func (c *Client) DeregisterTargets(ctx context.Context, params *DeregisterTargetsInput, optFns ...func(*Options)) (*DeregisterTargetsOutput, error) { if params == nil { params = &DeregisterTargetsInput{} diff --git a/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go b/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go index f10d7d212fa..57763180500 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go +++ b/service/elasticloadbalancingv2/api_op_DescribeAccountLimits.go @@ -12,10 +12,19 @@ import ( ) // 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) +// Web Services account. +// +// For more information, see the following: +// +// [Quotas for your Application Load Balancers] +// +// [Quotas for your Network Load Balancers] +// +// [Quotas for your Gateway Load Balancers] +// +// [Quotas for your Gateway Load Balancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/quotas-limits.html +// [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 func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error) { if params == nil { params = &DescribeAccountLimitsInput{} diff --git a/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go b/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go index bc7a7cd4ea6..797606a2b6a 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go +++ b/service/elasticloadbalancingv2/api_op_DescribeListenerCertificates.go @@ -12,11 +12,17 @@ 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) -// in the Network Load Balancers Guide. +// 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] in the Application Load Balancers Guide or [Server certificates] in the +// Network Load Balancers Guide. +// +// [Server certificates]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#tls-listener-certificate +// [SSL certificates]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates func (c *Client) DescribeListenerCertificates(ctx context.Context, params *DescribeListenerCertificatesInput, optFns ...func(*Options)) (*DescribeListenerCertificatesOutput, error) { if params == nil { params = &DescribeListenerCertificatesInput{} diff --git a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go index f28efc82591..d8e6a9c3be5 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go +++ b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancerAttributes.go @@ -12,14 +12,20 @@ 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, or Gateway Load Balancer. +// +// For more information, see the following: +// +// [Load balancer attributes] +// - in the Application Load Balancers Guide +// +// [Load balancer attributes] +// - in the Network Load Balancers Guide +// +// [Load balancer attributes] +// - in the Gateway Load Balancers Guide +// +// [Load balancer attributes]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-load-balancers.html#load-balancer-attributes 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 e47e4ac5048..3cc11eb7c3e 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go +++ b/service/elasticloadbalancingv2/api_op_DescribeLoadBalancers.go @@ -256,12 +256,13 @@ type LoadBalancerAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeLoadBalancersInput, *DescribeLoadBalancersOutput, error) (bool, error) } @@ -479,12 +480,13 @@ type LoadBalancerExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeLoadBalancersInput, *DescribeLoadBalancersOutput, error) (bool, error) } @@ -652,12 +654,13 @@ type LoadBalancersDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeLoadBalancersInput, *DescribeLoadBalancersOutput, error) (bool, error) } diff --git a/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go b/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go index 11b2dc50b7e..6c51382e78d 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go +++ b/service/elasticloadbalancingv2/api_op_DescribeSSLPolicies.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Network Load Balancers Guide. +// Describes the specified policies or all policies used for SSL negotiation. +// +// For more information, see [Security policies] in the Application Load Balancers Guide or [Security policies] in the +// Network Load Balancers Guide. +// +// [Security policies]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies func (c *Client) DescribeSSLPolicies(ctx context.Context, params *DescribeSSLPoliciesInput, optFns ...func(*Options)) (*DescribeSSLPoliciesOutput, error) { if params == nil { params = &DescribeSSLPoliciesInput{} @@ -32,7 +34,7 @@ func (c *Client) DescribeSSLPolicies(ctx context.Context, params *DescribeSSLPol type DescribeSSLPoliciesInput struct { - // The type of load balancer. The default lists the SSL policies for all load + // The type of load balancer. The default lists the SSL policies for all load // balancers. LoadBalancerType types.LoadBalancerTypeEnum diff --git a/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go b/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go index 6e3f53bc62e..402795082fe 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetGroupAttributes.go @@ -11,14 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Describes the attributes for the specified target group. +// +// For more information, see the following: +// +// [Target group attributes] +// - in the Application Load Balancers Guide +// +// [Target group attributes] +// - in the Network Load Balancers Guide +// +// [Target group attributes] +// - in the Gateway Load Balancers Guide +// +// [Target group attributes]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/target-groups.html#target-group-attributes 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_DescribeTargetHealth.go b/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go index 3878b374699..734487d07fc 100644 --- a/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go +++ b/service/elasticloadbalancingv2/api_op_DescribeTargetHealth.go @@ -179,12 +179,13 @@ type TargetDeregisteredWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTargetHealthInput, *DescribeTargetHealthOutput, error) (bool, error) } @@ -378,12 +379,13 @@ type TargetInServiceWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTargetHealthInput, *DescribeTargetHealthOutput, error) (bool, error) } diff --git a/service/elasticloadbalancingv2/api_op_GetTrustStoreCaCertificatesBundle.go b/service/elasticloadbalancingv2/api_op_GetTrustStoreCaCertificatesBundle.go index 26d33811b46..334d921ffda 100644 --- a/service/elasticloadbalancingv2/api_op_GetTrustStoreCaCertificatesBundle.go +++ b/service/elasticloadbalancingv2/api_op_GetTrustStoreCaCertificatesBundle.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the ca certificate bundle. This action returns a pre-signed S3 URI -// which is active for ten minutes. +// Retrieves the ca certificate bundle. +// +// This action returns a pre-signed S3 URI which is active for ten minutes. func (c *Client) GetTrustStoreCaCertificatesBundle(ctx context.Context, params *GetTrustStoreCaCertificatesBundleInput, optFns ...func(*Options)) (*GetTrustStoreCaCertificatesBundleOutput, error) { if params == nil { params = &GetTrustStoreCaCertificatesBundleInput{} diff --git a/service/elasticloadbalancingv2/api_op_GetTrustStoreRevocationContent.go b/service/elasticloadbalancingv2/api_op_GetTrustStoreRevocationContent.go index f13f0e16256..830d12ce65b 100644 --- a/service/elasticloadbalancingv2/api_op_GetTrustStoreRevocationContent.go +++ b/service/elasticloadbalancingv2/api_op_GetTrustStoreRevocationContent.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified revocation file. This action returns a pre-signed S3 -// URI which is active for ten minutes. +// Retrieves the specified revocation file. +// +// This action returns a pre-signed S3 URI which is active for ten minutes. func (c *Client) GetTrustStoreRevocationContent(ctx context.Context, params *GetTrustStoreRevocationContentInput, optFns ...func(*Options)) (*GetTrustStoreRevocationContentOutput, error) { if params == nil { params = &GetTrustStoreRevocationContentInput{} diff --git a/service/elasticloadbalancingv2/api_op_ModifyListener.go b/service/elasticloadbalancingv2/api_op_ModifyListener.go index 5dabc88e67d..4b5a9e5ea54 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyListener.go +++ b/service/elasticloadbalancingv2/api_op_ModifyListener.go @@ -12,13 +12,16 @@ import ( ) // 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 -// must provide the entire list. For example, to add an action, specify a list with -// the current actions plus the new action. +// 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 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) ModifyListener(ctx context.Context, params *ModifyListenerInput, optFns ...func(*Options)) (*ModifyListenerOutput, error) { if params == nil { params = &ModifyListenerInput{} @@ -43,13 +46,20 @@ type ModifyListenerInput struct { // [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) - // in the Network Load Balancers Guide. + // + // For more information, see [ALPN policies] in the Network Load Balancers Guide. + // + // [ALPN policies]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#alpn-policies AlpnPolicy []string // [HTTPS and TLS listeners] The default certificate for the listener. You must @@ -75,9 +85,12 @@ type ModifyListenerInput 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 or Security policies (https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) - // in the Network Load Balancers Guide. + // ciphers are supported. + // + // For more information, see [Security policies] in the Application Load Balancers Guide or [Security policies] in the + // Network Load Balancers Guide. + // + // [Security policies]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies SslPolicy *string noSmithyDocumentSerde diff --git a/service/elasticloadbalancingv2/api_op_ModifyLoadBalancerAttributes.go b/service/elasticloadbalancingv2/api_op_ModifyLoadBalancerAttributes.go index 028fe548c9b..875a8cc5f2f 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyLoadBalancerAttributes.go +++ b/service/elasticloadbalancingv2/api_op_ModifyLoadBalancerAttributes.go @@ -12,9 +12,11 @@ import ( ) // Modifies the specified attributes of the specified Application Load Balancer, -// Network Load Balancer, or Gateway Load Balancer. If any of the specified -// attributes can't be modified as requested, the call fails. Any existing -// attributes that you do not modify retain their current values. +// Network Load Balancer, or Gateway Load Balancer. +// +// If any of the specified attributes can't be modified as requested, the call +// fails. Any existing attributes that you do not modify retain their current +// values. func (c *Client) ModifyLoadBalancerAttributes(ctx context.Context, params *ModifyLoadBalancerAttributesInput, optFns ...func(*Options)) (*ModifyLoadBalancerAttributesOutput, error) { if params == nil { params = &ModifyLoadBalancerAttributesInput{} diff --git a/service/elasticloadbalancingv2/api_op_ModifyRule.go b/service/elasticloadbalancingv2/api_op_ModifyRule.go index 1e47edbd622..339355bfbba 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyRule.go +++ b/service/elasticloadbalancingv2/api_op_ModifyRule.go @@ -12,10 +12,11 @@ import ( ) // 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. +// 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) { if params == nil { params = &ModifyRuleInput{} diff --git a/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go b/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go index b7f71473c72..09c81412d13 100644 --- a/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go +++ b/service/elasticloadbalancingv2/api_op_ModifyTargetGroup.go @@ -43,9 +43,12 @@ type ModifyTargetGroupInput struct { HealthCheckIntervalSeconds *int32 // [HTTP/HTTPS health checks] The destination for health checks on the targets. - // [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC - // protocol version] The path of a custom health check method with the format - // /package.service/method. The default is /Amazon Web Services.ALB/healthcheck. + // + // [HTTP1 or HTTP2 protocol version] The ping path. The default is /. + // + // [GRPC protocol version] The path of a custom health check method with the + // format /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. diff --git a/service/elasticloadbalancingv2/api_op_RegisterTargets.go b/service/elasticloadbalancingv2/api_op_RegisterTargets.go index 3fdf1eab9fd..eaaff73a80b 100644 --- a/service/elasticloadbalancingv2/api_op_RegisterTargets.go +++ b/service/elasticloadbalancingv2/api_op_RegisterTargets.go @@ -11,16 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers the specified targets with the specified target group. If the target -// is an EC2 instance, it must be in the running state when you register it. By -// default, the load balancer routes requests to registered targets using the +// Registers the specified targets with the specified target group. +// +// If the target is an EC2 instance, it must be in the running state when you +// register it. +// +// By default, the load balancer routes requests to registered targets using the // protocol and port for the target group. Alternatively, you can override the port // for a target when you register it. You can register each EC2 instance or IP -// address with the same target group multiple times using different ports. With a -// Network Load Balancer, you cannot register instances by instance ID if they have -// the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, -// HS1, M1, M2, M3, and T1. You can register instances of these types by IP -// address. +// address with the same target group multiple times using different ports. +// +// With a Network Load Balancer, you cannot register instances by instance ID if +// they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, +// G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by +// IP address. func (c *Client) RegisterTargets(ctx context.Context, params *RegisterTargetsInput, optFns ...func(*Options)) (*RegisterTargetsOutput, error) { if params == nil { params = &RegisterTargetsInput{} diff --git a/service/elasticloadbalancingv2/api_op_SetRulePriorities.go b/service/elasticloadbalancingv2/api_op_SetRulePriorities.go index 8dc57ce4d71..42ea1e4a53a 100644 --- a/service/elasticloadbalancingv2/api_op_SetRulePriorities.go +++ b/service/elasticloadbalancingv2/api_op_SetRulePriorities.go @@ -11,9 +11,10 @@ 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/api_op_SetSecurityGroups.go b/service/elasticloadbalancingv2/api_op_SetSecurityGroups.go index af45041b3c0..ad2b8a2c12a 100644 --- a/service/elasticloadbalancingv2/api_op_SetSecurityGroups.go +++ b/service/elasticloadbalancingv2/api_op_SetSecurityGroups.go @@ -13,10 +13,12 @@ import ( // Associates the specified security groups with the specified Application Load // Balancer or Network Load Balancer. The specified security groups override the -// previously associated security groups. You can't perform this operation on a -// Network Load Balancer unless you specified a security group for the load -// balancer when you created it. You can't associate a security group with a -// Gateway Load Balancer. +// previously associated security groups. +// +// You can't perform this operation on a Network Load Balancer unless you +// specified a security group for the load balancer when you created it. +// +// You can't associate a security group with a Gateway Load Balancer. func (c *Client) SetSecurityGroups(ctx context.Context, params *SetSecurityGroupsInput, optFns ...func(*Options)) (*SetSecurityGroupsOutput, error) { if params == nil { params = &SetSecurityGroupsInput{} diff --git a/service/elasticloadbalancingv2/api_op_SetSubnets.go b/service/elasticloadbalancingv2/api_op_SetSubnets.go index bdebe2c17f5..ca6ea73e607 100644 --- a/service/elasticloadbalancingv2/api_op_SetSubnets.go +++ b/service/elasticloadbalancingv2/api_op_SetSubnets.go @@ -13,9 +13,10 @@ import ( // Enables the Availability Zones for the specified public subnets for the // specified Application Load Balancer, Network Load Balancer or Gateway Load -// Balancer. The specified subnets replace the previously enabled subnets. When you -// specify subnets for a Network Load Balancer, or Gateway Load Balancer you must -// include all subnets that were enabled previously, with their existing +// Balancer. The specified subnets replace the previously enabled subnets. +// +// When you specify subnets for a Network Load Balancer, or Gateway Load Balancer +// you must include all subnets that were enabled previously, with their existing // configurations, plus any additional subnets. func (c *Client) SetSubnets(ctx context.Context, params *SetSubnetsInput, optFns ...func(*Options)) (*SetSubnetsOutput, error) { if params == nil { @@ -42,34 +43,51 @@ type SetSubnetsInput struct { // [Network Load Balancers] The type of IP addresses used by the subnets for your // load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack // (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer - // with a UDP or TCP_UDP listener. [Gateway Load Balancers] The type of IP - // addresses used by the subnets for your load balancer. The possible values are - // ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). + // with a UDP or TCP_UDP listener. + // + // [Gateway Load Balancers] The type of IP addresses used by the subnets for your + // load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack + // (for IPv4 and IPv6 addresses). IpAddressType types.IpAddressType // The IDs of the public subnets. You can specify only one subnet per Availability - // Zone. You must specify either subnets or subnet mappings. [Application Load - // Balancers] You must specify subnets from at least two Availability Zones. You - // cannot specify Elastic IP addresses for your subnets. [Application Load - // Balancers on Outposts] You must specify one Outpost subnet. [Application Load - // Balancers on Local Zones] You can specify subnets from one or more Local Zones. + // Zone. You must specify either subnets or subnet mappings. + // + // [Application Load Balancers] You must specify subnets from at least two + // Availability Zones. You cannot specify Elastic IP addresses for your subnets. + // + // [Application Load Balancers on Outposts] You must specify one Outpost subnet. + // + // [Application Load Balancers on Local Zones] You can specify subnets from one or + // more Local Zones. + // // [Network Load Balancers] You can specify subnets from one or more Availability // Zones. You can specify one Elastic IP address per subnet if you need static IP // addresses for your internet-facing load balancer. For internal load balancers, // you can specify one private IP address per subnet from the IPv4 range of the // subnet. For internet-facing load balancer, you can specify one IPv6 address per - // subnet. [Gateway Load Balancers] You can specify subnets from one or more - // Availability Zones. + // subnet. + // + // [Gateway Load Balancers] You can specify subnets from one or more Availability + // Zones. SubnetMappings []types.SubnetMapping // The IDs of the public subnets. You can specify only one subnet per Availability - // Zone. You must specify either subnets or subnet mappings. [Application Load - // Balancers] You must specify subnets from at least two Availability Zones. + // Zone. You must specify either subnets or subnet mappings. + // + // [Application Load Balancers] You must specify subnets from at least two + // Availability Zones. + // // [Application Load Balancers on Outposts] You must specify one Outpost subnet. + // // [Application Load Balancers on Local Zones] You can specify subnets from one or - // more Local Zones. [Network Load Balancers] You can specify subnets from one or - // more Availability Zones. [Gateway Load Balancers] You can specify subnets from - // one or more Availability Zones. + // more Local Zones. + // + // [Network Load Balancers] You can specify subnets from one or more Availability + // Zones. + // + // [Gateway Load Balancers] You can specify subnets from one or more Availability + // Zones. Subnets []string noSmithyDocumentSerde @@ -80,8 +98,9 @@ type SetSubnetsOutput struct { // Information about the subnets. AvailabilityZones []types.AvailabilityZone - // [Network Load Balancers] The IP address type. [Gateway Load Balancers] The IP - // address type. + // [Network Load Balancers] The IP address type. + // + // [Gateway Load Balancers] The IP address type. IpAddressType types.IpAddressType // Metadata pertaining to the operation's result. diff --git a/service/elasticloadbalancingv2/doc.go b/service/elasticloadbalancingv2/doc.go index c84a07ebc11..c58e9518e03 100644 --- a/service/elasticloadbalancingv2/doc.go +++ b/service/elasticloadbalancingv2/doc.go @@ -3,26 +3,34 @@ // Package elasticloadbalancingv2 provides the API client, operations, and // parameter types for Elastic Load Balancing. // -// Elastic Load Balancing A load balancer distributes incoming traffic across -// targets, such as your EC2 instances. This enables you to increase the -// availability of your application. The load balancer also monitors the health of -// its registered targets and ensures that it routes traffic only to healthy -// targets. You configure your load balancer to accept incoming traffic by -// specifying one or more listeners, which are configured with a protocol and port -// number for connections from clients to the load balancer. You configure a target -// group with a protocol and port number for connections from the load balancer to -// the targets, and with health check settings to be used when checking the health -// status of the targets. Elastic Load Balancing supports the following types of -// load balancers: Application Load Balancers, Network Load Balancers, Gateway Load -// Balancers, and Classic Load Balancers. This reference covers the following load -// balancer types: +// # Elastic Load Balancing +// +// A load balancer distributes incoming traffic across targets, such as your EC2 +// instances. This enables you to increase the availability of your application. +// The load balancer also monitors the health of its registered targets and ensures +// that it routes traffic only to healthy targets. You configure your load balancer +// to accept incoming traffic by specifying one or more listeners, which are +// configured with a protocol and port number for connections from clients to the +// load balancer. You configure a target group with a protocol and port number for +// connections from the load balancer to the targets, and with health check +// settings to be used when checking the health status of the targets. +// +// Elastic Load Balancing supports the following types of 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). // -// 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 +// For more information, see the [Elastic Load Balancing User Guide]. +// +// All Elastic Load Balancing operations are idempotent, which means that they // complete at most one time. If you repeat an operation, it succeeds. +// +// [Elastic Load Balancing User Guide]: https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/ package elasticloadbalancingv2 diff --git a/service/elasticloadbalancingv2/options.go b/service/elasticloadbalancingv2/options.go index 8d973890d08..edf7c888cca 100644 --- a/service/elasticloadbalancingv2/options.go +++ b/service/elasticloadbalancingv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elasticloadbalancingv2/types/enums.go b/service/elasticloadbalancingv2/types/enums.go index 6f7ae753624..598bda107ad 100644 --- a/service/elasticloadbalancingv2/types/enums.go +++ b/service/elasticloadbalancingv2/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ActionTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionTypeEnum) Values() []ActionTypeEnum { return []ActionTypeEnum{ "forward", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AnomalyResultEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyResultEnum) Values() []AnomalyResultEnum { return []AnomalyResultEnum{ "anomalous", @@ -55,8 +57,9 @@ const ( // Values returns all known values for // AuthenticateCognitoActionConditionalBehaviorEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticateCognitoActionConditionalBehaviorEnum) Values() []AuthenticateCognitoActionConditionalBehaviorEnum { return []AuthenticateCognitoActionConditionalBehaviorEnum{ "deny", @@ -76,8 +79,9 @@ const ( // Values returns all known values for // AuthenticateOidcActionConditionalBehaviorEnum. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticateOidcActionConditionalBehaviorEnum) Values() []AuthenticateOidcActionConditionalBehaviorEnum { return []AuthenticateOidcActionConditionalBehaviorEnum{ "deny", @@ -96,8 +100,9 @@ const ( // Values returns all known values for DescribeTargetHealthInputIncludeEnum. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DescribeTargetHealthInputIncludeEnum) Values() []DescribeTargetHealthInputIncludeEnum { return []DescribeTargetHealthInputIncludeEnum{ "AnomalyDetection", @@ -115,8 +120,9 @@ const ( // Values returns all known values for // EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum) Values() []EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum { return []EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum{ "on", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for IpAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressType) Values() []IpAddressType { return []IpAddressType{ "ipv4", @@ -151,8 +158,9 @@ const ( ) // Values returns all known values for LoadBalancerSchemeEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerSchemeEnum) Values() []LoadBalancerSchemeEnum { return []LoadBalancerSchemeEnum{ "internet-facing", @@ -171,8 +179,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "active", @@ -192,8 +201,9 @@ const ( ) // Values returns all known values for LoadBalancerTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTypeEnum) Values() []LoadBalancerTypeEnum { return []LoadBalancerTypeEnum{ "application", @@ -211,8 +221,9 @@ const ( ) // Values returns all known values for MitigationInEffectEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MitigationInEffectEnum) Values() []MitigationInEffectEnum { return []MitigationInEffectEnum{ "yes", @@ -234,8 +245,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -258,8 +270,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedirectActionStatusCodeEnum) Values() []RedirectActionStatusCodeEnum { return []RedirectActionStatusCodeEnum{ "HTTP_301", @@ -275,8 +288,9 @@ const ( ) // Values returns all known values for RevocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RevocationType) Values() []RevocationType { return []RevocationType{ "CRL", @@ -293,8 +307,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetGroupIpAddressTypeEnum) Values() []TargetGroupIpAddressTypeEnum { return []TargetGroupIpAddressTypeEnum{ "ipv4", @@ -321,8 +336,9 @@ const ( ) // Values returns all known values for TargetHealthReasonEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetHealthReasonEnum) Values() []TargetHealthReasonEnum { return []TargetHealthReasonEnum{ "Elb.RegistrationInProgress", @@ -354,8 +370,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "initial", @@ -379,8 +396,9 @@ const ( ) // Values returns all known values for TargetTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetTypeEnum) Values() []TargetTypeEnum { return []TargetTypeEnum{ "instance", @@ -399,8 +417,9 @@ const ( ) // Values returns all known values for TrustStoreStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustStoreStatus) Values() []TrustStoreStatus { return []TrustStoreStatus{ "ACTIVE", diff --git a/service/elasticloadbalancingv2/types/types.go b/service/elasticloadbalancingv2/types/types.go index a9f787f82dc..d980448ad93 100644 --- a/service/elasticloadbalancingv2/types/types.go +++ b/service/elasticloadbalancingv2/types/types.go @@ -7,9 +7,10 @@ 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. @@ -90,15 +91,19 @@ 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. OnUnauthenticatedRequest AuthenticateCognitoActionConditionalBehaviorEnum - // 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. + // 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 // The name of the cookie used to maintain session information. The default is @@ -156,15 +161,19 @@ 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. OnUnauthenticatedRequest AuthenticateOidcActionConditionalBehaviorEnum - // 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. + // 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 // The name of the cookie used to maintain session information. The default is @@ -256,8 +265,10 @@ type FixedResponseActionConfig struct { // This member is required. StatusCode *string - // The content type. Valid Values: text/plain | text/css | text/html | - // application/javascript | application/json + // The content type. + // + // Valid Values: text/plain | text/css | text/html | application/javascript | + // application/json ContentType *string // The message. @@ -284,30 +295,37 @@ type HostHeaderConditionConfig struct { // The host names. The maximum size of each name is 128 characters. The comparison // is case insensitive. The following wildcard characters are supported: * (matches - // 0 or more characters) and ? (matches exactly 1 character). If you specify - // multiple strings, the condition is satisfied if one of the strings matches the - // host name. + // 0 or more characters) and ? (matches exactly 1 character). + // + // If you specify multiple strings, the condition is satisfied if one of the + // strings matches the host name. Values []string noSmithyDocumentSerde } -// Information about an HTTP header condition. There is a set of standard HTTP -// header fields. You can also define custom HTTP header fields. +// Information about an HTTP header condition. +// +// There is a set of standard HTTP 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 - // condition. + // 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. + // 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. @@ -316,18 +334,22 @@ type HttpHeaderConditionConfig struct { noSmithyDocumentSerde } -// 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. +// 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]. You can also define custom HTTP methods. +// +// [HTTP Method Registry]: https://www.iana.org/assignments/http-methods/http-methods.xhtml type HttpRequestMethodConditionConfig struct { // The name of the request method. The maximum size is 40 characters. The allowed // characters are A-Z, hyphen (-), and underscore (_). The comparison is case // sensitive. Wildcards are not supported; therefore, the method name must be an - // exact match. If you specify multiple strings, the condition is satisfied if one - // of the strings matches the HTTP request method. We recommend that you route GET - // and HEAD requests in the same way, because the response to a HEAD request may be + // exact match. + // + // If you specify multiple strings, the condition is satisfied if one of the + // strings matches the HTTP request method. We recommend that you route GET and + // HEAD requests in the same way, because the response to a HEAD request may be // cached. Values []string @@ -335,33 +357,60 @@ type HttpRequestMethodConditionConfig struct { } // Information about an Elastic Load Balancing resource limit 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) +// Services account. +// +// For more information, see the following: +// +// [Quotas for your Application Load Balancers] +// +// [Quotas for your Network Load Balancers] +// +// [Quotas for your Gateway Load Balancers] +// +// [Quotas for your Gateway Load Balancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/quotas-limits.html +// [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 type Limit struct { // The maximum value of the limit. 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 Name *string @@ -440,11 +489,12 @@ type LoadBalancer struct { // The nodes of an Internet-facing load balancer have public IP addresses. The DNS // name of an Internet-facing load balancer is publicly resolvable to the public IP // addresses of the nodes. Therefore, Internet-facing load balancers can route - // requests from clients over the internet. The nodes of an internal load balancer - // have only private IP addresses. The DNS name of an internal load balancer is - // publicly resolvable to the private IP addresses of the nodes. Therefore, - // internal load balancers can route requests only from clients with access to the - // VPC for the load balancer. + // requests from clients over the internet. + // + // The nodes of an internal load balancer have only private IP addresses. The DNS + // name of an internal load balancer is publicly resolvable to the private IP + // addresses of the nodes. Therefore, internal load balancers can route requests + // only from clients with access to the VPC for the load balancer. Scheme LoadBalancerSchemeEnum // The IDs of the security groups for the load balancer. @@ -484,52 +534,70 @@ type LoadBalancerAddress struct { // Information about a load balancer attribute. type LoadBalancerAttribute struct { - // The name of the attribute. The following attributes are supported by all load - // balancers: + // 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. + // // - client_keep_alive.seconds - The client keep alive value, in seconds. The // valid range is 60-604800 seconds. The default is 3600 seconds. + // // - connection_logs.s3.enabled - Indicates whether connection logs are enabled. // The value is true or false . The default is false . + // // - connection_logs.s3.bucket - The name of the S3 bucket for the connection // logs. This attribute is required if connection 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. + // // - connection_logs.s3.prefix - The prefix for the location in the S3 bucket for // the connection logs. + // // - 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 @@ -538,30 +606,39 @@ type LoadBalancerAttribute struct { // 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 . + // // The following attributes are supported by only Network Load Balancers: + // // - dns_record.client_routing_policy - Indicates how traffic is distributed // among the load balancer Availability Zones. The possible values are // availability_zone_affinity with 100 percent zonal affinity, @@ -602,12 +679,16 @@ type Matcher struct { // 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 - // range of values (for example, "200-299"). For Gateway Load Balancers, this must - // be "200–399". Note that when using shorthand syntax, some values such as commas - // need to be escaped. + // "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 range of values (for example, "200-299"). + // + // For Gateway Load Balancers, this must be "200–399". + // + // Note that when using shorthand syntax, some values such as commas need to be + // escaped. HttpCode *string noSmithyDocumentSerde @@ -635,20 +716,22 @@ type PathPatternConditionConfig struct { // The path patterns to compare against the request URL. The maximum size of each // string is 128 characters. The comparison is case sensitive. The following // wildcard characters are supported: * (matches 0 or more characters) and ? - // (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 . + // (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. Values []string noSmithyDocumentSerde } -// Information about a query string condition. The query string component of a URI -// starts after the first '?' character and is terminated by either a '#' character -// or the end of the URI. A typical query string contains key/value pairs separated -// by '&' characters. The allowed characters are specified by RFC 3986. Any -// character can be percentage encoded. +// Information about a query string condition. +// +// The query string component of a URI starts after the first '?' character and is +// terminated by either a '#' character or the end of the URI. A typical query +// string contains key/value pairs separated by '&' characters. The allowed +// characters are specified by RFC 3986. Any character can be percentage encoded. type QueryStringConditionConfig struct { // The key/value pairs or values to find in the query string. The maximum size of @@ -656,8 +739,9 @@ type QueryStringConditionConfig struct { // wildcard characters are supported: * (matches 0 or more characters) and ? // (matches exactly 1 character). To search for a literal '*' or '?' character in a // query string, you must escape these characters in Values using a '\' character. - // If you specify multiple key/value pairs or values, the condition is satisfied if - // one of them is found in the query string. + // + // If you specify multiple key/value pairs or values, the condition is satisfied + // if one of them is found in the query string. Values []QueryStringKeyValuePair noSmithyDocumentSerde @@ -675,15 +759,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 -// path. Any components that you do not modify retain their original values. You -// can reuse URI components using the following reserved keywords: +// 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} // // For example, you can change the path to "/new/#{path}", the hostname to @@ -763,21 +855,31 @@ 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. For more information, see Quotas for -// your Application Load Balancers (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html) -// . +// 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. +// +// For more information, see [Quotas for your Application Load Balancers]. +// +// [Quotas for your Application Load Balancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html 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 Field *string @@ -805,22 +907,34 @@ type RuleCondition struct { // 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 - // characters in length, and can contain any of the following characters. + // 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) Values []string @@ -839,19 +953,22 @@ type RulePriorityPair struct { noSmithyDocumentSerde } -// Information about a source IP condition. You can use this condition to route -// based on the IP address of the source that connects to the load balancer. If a -// client is behind a proxy, this is the IP address of the proxy not the IP address -// of the client. +// Information about a source IP condition. +// +// You can use this condition to route based on the IP address of the source that +// connects to the load balancer. If a client is behind a proxy, this is the IP +// address of the proxy not the IP address of the client. type SourceIpConditionConfig struct { // The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 - // addresses. Wildcards are not supported. If you specify multiple addresses, the - // 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 . The total number of values must be less than, or - // equal to five. + // addresses. Wildcards are not supported. + // + // If you specify multiple addresses, the 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. + // + // The total number of values must be less than, or equal to five. Values []string noSmithyDocumentSerde @@ -869,7 +986,7 @@ type SslPolicy struct { // The protocols. SslProtocols []string - // The supported load balancers. + // The supported load balancers. SupportedLoadBalancerTypes []string noSmithyDocumentSerde @@ -933,18 +1050,26 @@ type TargetDescription struct { // 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 . + // 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 @@ -1035,108 +1160,141 @@ type TargetGroup struct { // Information about a target group attribute. type TargetGroupAttribute struct { - // The name of the attribute. The following attributes are supported by all load - // balancers: + // 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 , least_outstanding_requests , or weighted_random . The default is // round_robin . + // // - load_balancing.algorithm.anomaly_mitigation - Only available when // load_balancing.algorithm.type is weighted_random . Indicates whether anomaly // mitigation is enabled. The value is on or off . The default is off . + // // - 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 . For new UDP/TCP_UDP target groups the default is // true . Otherwise, 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 . + // // - target_health_state.unhealthy.connection_termination.enabled - Indicates // whether the load balancer terminates connections to unhealthy targets. The value // is true or false . The default is true . + // // - target_health_state.unhealthy.draining_interval_seconds - The amount of time // for Elastic Load Balancing to wait before changing the state of an unhealthy // target from unhealthy.draining to unhealthy . The range is 0-360000 seconds. - // The default value is 0 seconds. Note: This attribute can only be configured when + // The default value is 0 seconds. + // + // Note: This attribute can only be configured when // target_health_state.unhealthy.connection_termination.enabled 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 ( @@ -1183,38 +1341,58 @@ type TargetHealth struct { // 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. + // 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. Reason TargetHealthReasonEnum @@ -1228,8 +1406,11 @@ type TargetHealth struct { // Information about the health of a target. type TargetHealthDescription struct { - // The anomaly detection result for the target. If no anomalies were detected, the - // result is normal . If anomalies were detected, the result is anomalous . + // The anomaly detection result for the target. + // + // If no anomalies were detected, the result is normal . + // + // If anomalies were detected, the result is anomalous . AnomalyDetection *AnomalyDetection // The port to use to connect with the target. diff --git a/service/elasticsearchservice/api_op_AcceptInboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_AcceptInboundCrossClusterSearchConnection.go index d8ddad15a80..e8432fb6fd3 100644 --- a/service/elasticsearchservice/api_op_AcceptInboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_AcceptInboundCrossClusterSearchConnection.go @@ -28,8 +28,7 @@ func (c *Client) AcceptInboundCrossClusterSearchConnection(ctx context.Context, return out, nil } -// Container for the parameters to the AcceptInboundCrossClusterSearchConnection -// operation. +// Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation. type AcceptInboundCrossClusterSearchConnectionInput struct { // The id of the inbound connection that you want to accept. @@ -40,12 +39,10 @@ type AcceptInboundCrossClusterSearchConnectionInput struct { noSmithyDocumentSerde } -// The result of a AcceptInboundCrossClusterSearchConnection operation. Contains -// details of accepted inbound connection. +// The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection. type AcceptInboundCrossClusterSearchConnectionOutput struct { - // Specifies the InboundCrossClusterSearchConnection of accepted inbound - // connection. + // Specifies the InboundCrossClusterSearchConnection of accepted inbound connection. CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_AddTags.go b/service/elasticsearchservice/api_op_AddTags.go index fc625d2ab7a..02cfa62d43e 100644 --- a/service/elasticsearchservice/api_op_AddTags.go +++ b/service/elasticsearchservice/api_op_AddTags.go @@ -13,7 +13,9 @@ 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.] +// +// [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{} @@ -29,16 +31,16 @@ 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. + // Specify the ARN for which you want to add the tags. // // This member is required. ARN *string - // List of Tag that need to be added for the Elasticsearch domain. + // List of Tag that need to be added for the Elasticsearch domain. // // This member is required. TagList []types.Tag diff --git a/service/elasticsearchservice/api_op_AuthorizeVpcEndpointAccess.go b/service/elasticsearchservice/api_op_AuthorizeVpcEndpointAccess.go index cc7d2a75147..3b258a5d647 100644 --- a/service/elasticsearchservice/api_op_AuthorizeVpcEndpointAccess.go +++ b/service/elasticsearchservice/api_op_AuthorizeVpcEndpointAccess.go @@ -28,9 +28,8 @@ func (c *Client) AuthorizeVpcEndpointAccess(ctx context.Context, params *Authori return out, nil } -// Container for request parameters to the AuthorizeVpcEndpointAccess operation. -// Specifies the account to be permitted to manage VPC endpoints against the -// domain. +// Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be +// permitted to manage VPC endpoints against the domain. type AuthorizeVpcEndpointAccessInput struct { // The account ID to grant access to. @@ -46,9 +45,8 @@ type AuthorizeVpcEndpointAccessInput struct { noSmithyDocumentSerde } -// Container for response parameters to the AuthorizeVpcEndpointAccess operation. -// Contains the account ID and the type of the account being authorized to access -// the VPC endpoint. +// Container for response parameters to the AuthorizeVpcEndpointAccess operation. Contains the account ID +// and the type of the account being authorized to access the VPC endpoint. type AuthorizeVpcEndpointAccessOutput struct { // Information about the account or service that was provided access to the domain. diff --git a/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go b/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go index 85684992fb1..e04837e645c 100644 --- a/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go +++ b/service/elasticsearchservice/api_op_CancelElasticsearchServiceSoftwareUpdate.go @@ -29,9 +29,8 @@ func (c *Client) CancelElasticsearchServiceSoftwareUpdate(ctx context.Context, p return out, nil } -// Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate -// operation. Specifies the name of the Elasticsearch domain that you wish to -// cancel a service software update on. +// Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the +// Elasticsearch domain that you wish to cancel a service software update on. type CancelElasticsearchServiceSoftwareUpdateInput struct { // The name of the domain that you want to stop the latest service software update diff --git a/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go b/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go index 9fdc246dd42..ebddff4b06b 100644 --- a/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_CreateElasticsearchDomain.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Elasticsearch Service Developer Guide. +// Creates a new Elasticsearch domain. For more information, see [Creating Elasticsearch Domains] in the Amazon +// Elasticsearch Service Developer Guide. +// +// [Creating Elasticsearch Domains]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains func (c *Client) CreateElasticsearchDomain(ctx context.Context, params *CreateElasticsearchDomainInput, optFns ...func(*Options)) (*CreateElasticsearchDomainOutput, error) { if params == nil { params = &CreateElasticsearchDomainInput{} @@ -39,13 +40,14 @@ type CreateElasticsearchDomainInput struct { // This member is required. DomainName *string - // IAM access policy as a JSON-formatted string. + // IAM access policy as a JSON-formatted string. AccessPolicies *string - // Option to allow references to indices in an HTTP request body. Must be false + // 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. + // true . See [Configuration Advanced Options] for more information. + // + // [Configuration Advanced Options]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options AdvancedOptions map[string]string // Specifies advanced security options. @@ -55,15 +57,16 @@ type CreateElasticsearchDomainInput struct { AutoTuneOptions *types.AutoTuneOptionsInput // 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) - // . + // authentication. For more information, see [Amazon Cognito Authentication for Kibana]. + // + // [Amazon Cognito Authentication for 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. DomainEndpointOptions *types.DomainEndpointOptions - // Options to enable, disable and specify the type and size of EBS storage volumes. + // Options to enable, disable and specify the type and size of EBS storage + // volumes. EBSOptions *types.EBSOptions // Configuration options for an Elasticsearch domain. Specifies the instance type @@ -71,8 +74,10 @@ 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) - // in the Amazon Elasticsearch Service Developer Guide. + // or "2.3". For more information, see [Creating Elasticsearch Domains]in the Amazon Elasticsearch Service + // Developer Guide. + // + // [Creating Elasticsearch Domains]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains ElasticsearchVersion *string // Specifies the Encryption At Rest Options. @@ -93,8 +98,9 @@ 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) - // in VPC Endpoints for Amazon Elasticsearch Service Domains + // information, see [Creating a VPC]in VPC Endpoints for Amazon Elasticsearch Service Domains + // + // [Creating a VPC]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc VPCOptions *types.VPCOptions noSmithyDocumentSerde diff --git a/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go index b29a2acaa3f..72a7e3035bb 100644 --- a/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_CreateOutboundCrossClusterSearchConnection.go @@ -28,8 +28,7 @@ func (c *Client) CreateOutboundCrossClusterSearchConnection(ctx context.Context, return out, nil } -// Container for the parameters to the CreateOutboundCrossClusterSearchConnection -// operation. +// Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation. type CreateOutboundCrossClusterSearchConnectionInput struct { // Specifies the connection alias that will be used by the customer for this @@ -51,15 +50,14 @@ 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. ConnectionAlias *string - // Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created - // connection. + // Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection. ConnectionStatus *types.OutboundCrossClusterSearchConnectionStatus // Unique id for the created outbound connection, which is used for subsequent diff --git a/service/elasticsearchservice/api_op_CreateVpcEndpoint.go b/service/elasticsearchservice/api_op_CreateVpcEndpoint.go index df500b80997..522b9f2df6a 100644 --- a/service/elasticsearchservice/api_op_CreateVpcEndpoint.go +++ b/service/elasticsearchservice/api_op_CreateVpcEndpoint.go @@ -46,8 +46,8 @@ type CreateVpcEndpointInput struct { noSmithyDocumentSerde } -// Container for response parameters to the CreateVpcEndpoint operation. Contains -// the configuration and status of the VPC Endpoint being created. +// Container for response parameters to the CreateVpcEndpoint operation. Contains the configuration +// and status of the VPC Endpoint being created. type CreateVpcEndpointOutput struct { // Information about the newly created VPC endpoint. diff --git a/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go b/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go index 6edb5b8cb9a..499ff11e648 100644 --- a/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_DeleteElasticsearchDomain.go @@ -28,8 +28,8 @@ func (c *Client) DeleteElasticsearchDomain(ctx context.Context, params *DeleteEl return out, nil } -// Container for the parameters to the DeleteElasticsearchDomain operation. -// Specifies the name of the Elasticsearch domain that you want to delete. +// Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the +// Elasticsearch domain that you want to delete. type DeleteElasticsearchDomainInput struct { // The name of the Elasticsearch domain that you want to permanently delete. diff --git a/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go b/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go index fb79e798977..d3e42620bd0 100644 --- a/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go +++ b/service/elasticsearchservice/api_op_DeleteElasticsearchServiceRole.go @@ -13,8 +13,9 @@ 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) -// in VPC Endpoints for Amazon Elasticsearch Service Domains. +// role. See [Deleting Elasticsearch Service Role]in VPC Endpoints for Amazon Elasticsearch Service Domains. +// +// [Deleting Elasticsearch Service Role]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr func (c *Client) DeleteElasticsearchServiceRole(ctx context.Context, params *DeleteElasticsearchServiceRoleInput, optFns ...func(*Options)) (*DeleteElasticsearchServiceRoleOutput, error) { if params == nil { params = &DeleteElasticsearchServiceRoleInput{} diff --git a/service/elasticsearchservice/api_op_DeleteInboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_DeleteInboundCrossClusterSearchConnection.go index 421abe8a229..2fead39e3de 100644 --- a/service/elasticsearchservice/api_op_DeleteInboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_DeleteInboundCrossClusterSearchConnection.go @@ -28,8 +28,7 @@ func (c *Client) DeleteInboundCrossClusterSearchConnection(ctx context.Context, return out, nil } -// Container for the parameters to the DeleteInboundCrossClusterSearchConnection -// operation. +// Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation. type DeleteInboundCrossClusterSearchConnectionInput struct { // The id of the inbound connection that you want to permanently delete. @@ -40,8 +39,7 @@ type DeleteInboundCrossClusterSearchConnectionInput struct { noSmithyDocumentSerde } -// The result of a DeleteInboundCrossClusterSearchConnection operation. Contains -// details of deleted inbound connection. +// The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection. type DeleteInboundCrossClusterSearchConnectionOutput struct { // Specifies the InboundCrossClusterSearchConnection of deleted inbound connection. diff --git a/service/elasticsearchservice/api_op_DeleteOutboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_DeleteOutboundCrossClusterSearchConnection.go index 73e37bbb806..5c3f92f43e5 100644 --- a/service/elasticsearchservice/api_op_DeleteOutboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_DeleteOutboundCrossClusterSearchConnection.go @@ -28,8 +28,7 @@ func (c *Client) DeleteOutboundCrossClusterSearchConnection(ctx context.Context, return out, nil } -// Container for the parameters to the DeleteOutboundCrossClusterSearchConnection -// operation. +// Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation. type DeleteOutboundCrossClusterSearchConnectionInput struct { // The id of the outbound connection that you want to permanently delete. @@ -40,12 +39,10 @@ type DeleteOutboundCrossClusterSearchConnectionInput struct { noSmithyDocumentSerde } -// The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains -// details of deleted outbound connection. +// The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection. type DeleteOutboundCrossClusterSearchConnectionOutput struct { - // Specifies the OutboundCrossClusterSearchConnection of deleted outbound - // connection. + // Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection. CrossClusterSearchConnection *types.OutboundCrossClusterSearchConnection // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go b/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go index 88f743c26f2..6416a8532e1 100644 --- a/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go +++ b/service/elasticsearchservice/api_op_DeleteVpcEndpoint.go @@ -38,8 +38,8 @@ type DeleteVpcEndpointInput struct { noSmithyDocumentSerde } -// Container for response parameters to the DeleteVpcEndpoint operation. Contains -// the summarized detail of the VPC Endpoint being deleted. +// Container for response parameters to the DeleteVpcEndpoint operation. Contains the summarized +// detail of the VPC Endpoint being deleted. type DeleteVpcEndpointOutput struct { // Information about the deleted endpoint, including its current status ( DELETING diff --git a/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go b/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go index e19e57ffb7e..e9c7f2df03b 100644 --- a/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go +++ b/service/elasticsearchservice/api_op_DescribeDomainAutoTunes.go @@ -47,13 +47,15 @@ type DescribeDomainAutoTunesInput struct { noSmithyDocumentSerde } -// The result of DescribeDomainAutoTunes request. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) -// for more information. +// The result of DescribeDomainAutoTunes request. See the [Developer Guide] for more information. +// +// [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html 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) - // for more information. + // domain. See the [Developer Guide]for more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html AutoTunes []types.AutoTune // Specifies an identifier to allow retrieval of paginated results. diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go b/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go index 4ef44ed6829..2276d98ca02 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchDomainConfig.go @@ -29,7 +29,8 @@ func (c *Client) DescribeElasticsearchDomainConfig(ctx context.Context, params * return out, nil } -// Container for the parameters to the DescribeElasticsearchDomainConfig +// Container for the parameters to the DescribeElasticsearchDomainConfig +// // operation. Specifies the domain name for which you want configuration // information. type DescribeElasticsearchDomainConfigInput struct { diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go b/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go index ed71a8d4e9e..ed259e22d8a 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchDomains.go @@ -28,8 +28,8 @@ func (c *Client) DescribeElasticsearchDomains(ctx context.Context, params *Descr return out, nil } -// Container for the parameters to the DescribeElasticsearchDomains operation. By -// default, the API returns the status of all Elasticsearch domains. +// Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the +// status of all Elasticsearch domains. type DescribeElasticsearchDomainsInput struct { // The Elasticsearch domains for which you want information. diff --git a/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go b/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go index 3b7acd69cd5..7a1d225b6eb 100644 --- a/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go +++ b/service/elasticsearchservice/api_op_DescribeElasticsearchInstanceTypeLimits.go @@ -11,9 +11,10 @@ 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 DomainNameto 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{} @@ -29,35 +30,34 @@ func (c *Client) DescribeElasticsearchInstanceTypeLimits(ctx context.Context, pa return out, nil } -// Container for the parameters to DescribeElasticsearchInstanceTypeLimits -// operation. +// Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation. type DescribeElasticsearchInstanceTypeLimitsInput struct { - // Version of Elasticsearch for which Limits are needed. + // Version of Elasticsearch for which Limits are needed. // // This member is required. ElasticsearchVersion *string - // The instance type for an Elasticsearch cluster for which Elasticsearch Limits - // are needed. + // The instance type for an Elasticsearch cluster for which Elasticsearch Limits are + // needed. // // This member is required. InstanceType types.ESPartitionInstanceType - // DomainName represents the name of the Domain that we are trying to modify. This - // should be present only if we are querying for Elasticsearch Limits for existing + // DomainName represents the name of the Domain that we are trying to modify. + // This should be present only if we are querying for Elasticsearch Limitsfor existing // domain. DomainName *string noSmithyDocumentSerde } -// Container for the parameters received from -// DescribeElasticsearchInstanceTypeLimits operation. +// Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation. type DescribeElasticsearchInstanceTypeLimitsOutput struct { - // Map of Role of the Instance and Limits that are applicable. Role performed by + // 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 diff --git a/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go b/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go index ec446c2b42e..ecf4707eef5 100644 --- a/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go +++ b/service/elasticsearchservice/api_op_DescribeInboundCrossClusterSearchConnections.go @@ -27,12 +27,12 @@ func (c *Client) DescribeInboundCrossClusterSearchConnections(ctx context.Contex return out, nil } -// Container for the parameters to the DescribeInboundCrossClusterSearchConnections -// operation. +// Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation. type DescribeInboundCrossClusterSearchConnectionsInput struct { - // A list of filters used to match properties for inbound cross-cluster search - // connection. Available Filter names for this operation are: + // A list of filters used to match properties for inbound cross-cluster search + // connection. Available Filternames for this operation are: + // // - cross-cluster-search-connection-id // - source-domain-info.domain-name // - source-domain-info.owner-id @@ -44,19 +44,18 @@ type DescribeInboundCrossClusterSearchConnectionsInput struct { // defaults to 100. MaxResults int32 - // NextToken is sent in case the earlier API call results contain the NextToken. + // NextToken is sent in case the earlier API call results contain the NextToken. // It is used for pagination. NextToken *string noSmithyDocumentSerde } -// The result of a DescribeInboundCrossClusterSearchConnections request. Contains -// the list of connections matching the filter criteria. +// The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter +// criteria. type DescribeInboundCrossClusterSearchConnectionsOutput struct { - // Consists of list of InboundCrossClusterSearchConnection matching the specified - // filter criteria. + // Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria. CrossClusterSearchConnections []types.InboundCrossClusterSearchConnection // If more results are available and NextToken is present, make the next request diff --git a/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go b/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go index bcb6daa7130..659b956710b 100644 --- a/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go +++ b/service/elasticsearchservice/api_op_DescribeOutboundCrossClusterSearchConnections.go @@ -27,12 +27,12 @@ func (c *Client) DescribeOutboundCrossClusterSearchConnections(ctx context.Conte return out, nil } -// Container for the parameters to the -// DescribeOutboundCrossClusterSearchConnections operation. +// Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation. type DescribeOutboundCrossClusterSearchConnectionsInput struct { - // A list of filters used to match properties for outbound cross-cluster search - // connection. Available Filter names for this operation are: + // A list of filters used to match properties for outbound cross-cluster search + // connection. Available Filternames for this operation are: + // // - cross-cluster-search-connection-id // - destination-domain-info.domain-name // - destination-domain-info.owner-id @@ -44,19 +44,18 @@ type DescribeOutboundCrossClusterSearchConnectionsInput struct { // defaults to 100. MaxResults int32 - // NextToken is sent in case the earlier API call results contain the NextToken. + // NextToken is sent in case the earlier API call results contain the NextToken. // It is used for pagination. NextToken *string noSmithyDocumentSerde } -// The result of a DescribeOutboundCrossClusterSearchConnections request. Contains -// the list of connections matching the filter criteria. +// The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter +// criteria. type DescribeOutboundCrossClusterSearchConnectionsOutput struct { - // Consists of list of OutboundCrossClusterSearchConnection matching the specified - // filter criteria. + // Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria. CrossClusterSearchConnections []types.OutboundCrossClusterSearchConnection // If more results are available and NextToken is present, make the next request diff --git a/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go b/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go index 5dc39d5a667..0315ec4ae4a 100644 --- a/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go +++ b/service/elasticsearchservice/api_op_DescribeVpcEndpoints.go @@ -27,8 +27,8 @@ func (c *Client) DescribeVpcEndpoints(ctx context.Context, params *DescribeVpcEn return out, nil } -// Container for request parameters to the DescribeVpcEndpoints operation. -// Specifies the list of VPC endpoints to be described. +// Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC +// endpoints to be described. type DescribeVpcEndpointsInput struct { // The unique identifiers of the endpoints to get information about. @@ -39,10 +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 -// described +// 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 { // Any errors associated with the request. diff --git a/service/elasticsearchservice/api_op_GetCompatibleElasticsearchVersions.go b/service/elasticsearchservice/api_op_GetCompatibleElasticsearchVersions.go index c8aaa0af6e9..d2b5b233cfa 100644 --- a/service/elasticsearchservice/api_op_GetCompatibleElasticsearchVersions.go +++ b/service/elasticsearchservice/api_op_GetCompatibleElasticsearchVersions.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of upgrade compatible Elastisearch versions. You can optionally -// pass a DomainName to get all upgrade compatible Elasticsearch versions for that -// specific domain. +// Returns a list of upgrade compatible Elastisearch versions. You can optionally +// +// pass a DomainNameto get all upgrade compatible Elasticsearch versions for that specific +// domain. func (c *Client) GetCompatibleElasticsearchVersions(ctx context.Context, params *GetCompatibleElasticsearchVersionsInput, optFns ...func(*Options)) (*GetCompatibleElasticsearchVersionsOutput, error) { if params == nil { params = &GetCompatibleElasticsearchVersionsInput{} @@ -29,8 +30,7 @@ func (c *Client) GetCompatibleElasticsearchVersions(ctx context.Context, params return out, nil } -// Container for request parameters to GetCompatibleElasticsearchVersions -// operation. +// Container for request parameters to GetCompatibleElasticsearchVersions operation. type GetCompatibleElasticsearchVersionsInput struct { // The name of an Elasticsearch domain. Domain names are unique across the domains @@ -45,8 +45,7 @@ type GetCompatibleElasticsearchVersionsInput struct { // Container for response returned by GetCompatibleElasticsearchVersions operation. type GetCompatibleElasticsearchVersionsOutput struct { - // A map of compatible Elasticsearch versions returned as part of the - // GetCompatibleElasticsearchVersions operation. + // A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation. CompatibleElasticsearchVersions []types.CompatibleVersionsMap // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_GetUpgradeHistory.go b/service/elasticsearchservice/api_op_GetUpgradeHistory.go index a0530190111..0179910f31c 100644 --- a/service/elasticsearchservice/api_op_GetUpgradeHistory.go +++ b/service/elasticsearchservice/api_op_GetUpgradeHistory.go @@ -39,10 +39,10 @@ type GetUpgradeHistoryInput struct { // This member is required. DomainName *string - // Set this value to limit the number of results returned. + // Set this value to limit the number of results returned. MaxResults int32 - // Paginated APIs accepts NextToken input to returns next page results and + // 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 @@ -57,9 +57,8 @@ type GetUpgradeHistoryOutput struct { // page of results NextToken *string - // A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade - // Eligibility Check performed on a domain returned as part of - // GetUpgradeHistoryResponse object. + // A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check + // performed on a domain returned as part of GetUpgradeHistoryResponseobject. UpgradeHistories []types.UpgradeHistory // Metadata pertaining to the operation's result. @@ -157,7 +156,7 @@ var _ GetUpgradeHistoryAPIClient = (*Client)(nil) // GetUpgradeHistoryPaginatorOptions is the paginator options for GetUpgradeHistory type GetUpgradeHistoryPaginatorOptions struct { - // Set this value to limit the number of results returned. + // Set this value to limit the number of results returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/elasticsearchservice/api_op_GetUpgradeStatus.go b/service/elasticsearchservice/api_op_GetUpgradeStatus.go index 26da7ab7f1f..df0521b7689 100644 --- a/service/elasticsearchservice/api_op_GetUpgradeStatus.go +++ b/service/elasticsearchservice/api_op_GetUpgradeStatus.go @@ -45,9 +45,9 @@ type GetUpgradeStatusInput struct { // Container for response returned by GetUpgradeStatus operation. 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: + // 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 @@ -57,8 +57,9 @@ type GetUpgradeStatusOutput struct { // A string that describes the update briefly UpgradeName *string - // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does + // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does // through: + // // - PreUpgradeCheck // - Snapshot // - Upgrade diff --git a/service/elasticsearchservice/api_op_ListDomainNames.go b/service/elasticsearchservice/api_op_ListDomainNames.go index 5f439a9855d..2037e3d34b8 100644 --- a/service/elasticsearchservice/api_op_ListDomainNames.go +++ b/service/elasticsearchservice/api_op_ListDomainNames.go @@ -31,7 +31,7 @@ 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 + // Optional parameter to filter the output by domain engine type. Acceptable // values are 'Elasticsearch' and 'OpenSearch'. EngineType types.EngineType diff --git a/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go b/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go index a475ddc70da..61a12bfe03c 100644 --- a/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go +++ b/service/elasticsearchservice/api_op_ListElasticsearchInstanceTypes.go @@ -42,7 +42,7 @@ type ListElasticsearchInstanceTypesInput struct { // instance types when modifying existing domain. DomainName *string - // Set this value to limit the number of results returned. Value provided must be + // Set this value to limit the number of results returned. Value provided must be // greater than 30 else it wont be honored. MaxResults int32 @@ -53,12 +53,10 @@ type ListElasticsearchInstanceTypesInput struct { noSmithyDocumentSerde } -// Container for the parameters returned by ListElasticsearchInstanceTypes -// operation. +// Container for the parameters returned by ListElasticsearchInstanceTypes operation. type ListElasticsearchInstanceTypesOutput struct { - // List of instance types supported by Amazon Elasticsearch service for given - // ElasticsearchVersion + // List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion ElasticsearchInstanceTypes []types.ESPartitionInstanceType // In case if there are more results available NextToken would be present, make @@ -162,7 +160,7 @@ var _ ListElasticsearchInstanceTypesAPIClient = (*Client)(nil) // ListElasticsearchInstanceTypesPaginatorOptions is the paginator options for // ListElasticsearchInstanceTypes type ListElasticsearchInstanceTypesPaginatorOptions struct { - // Set this value to limit the number of results returned. Value provided must be + // Set this value to limit the number of results returned. Value provided must be // greater than 30 else it wont be honored. Limit int32 diff --git a/service/elasticsearchservice/api_op_ListElasticsearchVersions.go b/service/elasticsearchservice/api_op_ListElasticsearchVersions.go index d3310a109d5..8231129cb79 100644 --- a/service/elasticsearchservice/api_op_ListElasticsearchVersions.go +++ b/service/elasticsearchservice/api_op_ListElasticsearchVersions.go @@ -26,18 +26,19 @@ func (c *Client) ListElasticsearchVersions(ctx context.Context, params *ListElas return out, nil } -// Container for the parameters to the ListElasticsearchVersions operation. Use -// MaxResults to control the maximum number of results to retrieve in a single -// call. Use NextToken in response to retrieve more results. If the received -// response does not contain a NextToken, then there are no more results to -// retrieve. +// Container for the parameters to the ListElasticsearchVersions operation. +// +// Use MaxResults to control the maximum number of results to retrieve in a single call. +// +// Use NextToken in response to retrieve more results. If the received response does not +// contain a NextToken, then there are no more results to retrieve. type ListElasticsearchVersionsInput struct { - // Set this value to limit the number of results returned. Value provided must be + // Set this value to limit the number of results returned. Value provided must be // greater than 10 else it wont be honored. MaxResults int32 - // Paginated APIs accepts NextToken input to returns next page results and + // 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 @@ -45,14 +46,13 @@ type ListElasticsearchVersionsInput struct { noSmithyDocumentSerde } -// Container for the parameters for response received from -// ListElasticsearchVersions operation. +// Container for the parameters for response received from ListElasticsearchVersions operation. type ListElasticsearchVersionsOutput struct { // List of supported elastic search versions. ElasticsearchVersions []string - // Paginated APIs accepts NextToken input to returns next page results and + // 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 @@ -150,7 +150,7 @@ var _ ListElasticsearchVersionsAPIClient = (*Client)(nil) // ListElasticsearchVersionsPaginatorOptions is the paginator options for // ListElasticsearchVersions type ListElasticsearchVersionsPaginatorOptions struct { - // Set this value to limit the number of results returned. Value provided must be + // Set this value to limit the number of results returned. Value provided must be // greater than 10 else it wont be honored. Limit int32 diff --git a/service/elasticsearchservice/api_op_ListTags.go b/service/elasticsearchservice/api_op_ListTags.go index 98cd633df67..ac3ab25f291 100644 --- a/service/elasticsearchservice/api_op_ListTags.go +++ b/service/elasticsearchservice/api_op_ListTags.go @@ -32,7 +32,7 @@ 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 + // Specify the ARN for the Elasticsearch domain to which the tags are attached // that you want to view. // // This member is required. @@ -45,7 +45,7 @@ type ListTagsInput struct { // Elasticsearch domains. type ListTagsOutput struct { - // List of Tag for the requested Elasticsearch domain. + // List of Tag for the requested Elasticsearch domain. TagList []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_ListVpcEndpointAccess.go b/service/elasticsearchservice/api_op_ListVpcEndpointAccess.go index 529c61fe2b0..f56edf120de 100644 --- a/service/elasticsearchservice/api_op_ListVpcEndpointAccess.go +++ b/service/elasticsearchservice/api_op_ListVpcEndpointAccess.go @@ -43,9 +43,8 @@ type ListVpcEndpointAccessInput struct { noSmithyDocumentSerde } -// Container for response parameters to the ListVpcEndpointAccess operation. -// Returns a list of accounts id and account type authorized to manage VPC -// endpoints. +// Container for response parameters to the ListVpcEndpointAccess operation. Returns a list of accounts +// id and account type authorized to manage VPC endpoints. type ListVpcEndpointAccessOutput struct { // List of AuthorizedPrincipal describing the details of the permissions to manage diff --git a/service/elasticsearchservice/api_op_ListVpcEndpoints.go b/service/elasticsearchservice/api_op_ListVpcEndpoints.go index f94b3240ce0..aed35b229c0 100644 --- a/service/elasticsearchservice/api_op_ListVpcEndpoints.go +++ b/service/elasticsearchservice/api_op_ListVpcEndpoints.go @@ -37,8 +37,8 @@ type ListVpcEndpointsInput struct { noSmithyDocumentSerde } -// Container for response parameters to the ListVpcEndpoints operation. Returns a -// list containing summarized details of the VPC endpoints. +// Container for response parameters to the ListVpcEndpoints operation. Returns a list containing +// summarized details of the VPC endpoints. type ListVpcEndpointsOutput struct { // Provides an identifier to allow retrieval of paginated results. diff --git a/service/elasticsearchservice/api_op_ListVpcEndpointsForDomain.go b/service/elasticsearchservice/api_op_ListVpcEndpointsForDomain.go index df9ea9d3a7a..71adfbb9631 100644 --- a/service/elasticsearchservice/api_op_ListVpcEndpointsForDomain.go +++ b/service/elasticsearchservice/api_op_ListVpcEndpointsForDomain.go @@ -28,8 +28,8 @@ func (c *Client) ListVpcEndpointsForDomain(ctx context.Context, params *ListVpcE return out, nil } -// Container for request parameters to the ListVpcEndpointsForDomain operation. -// Specifies the domain whose VPC endpoints will be listed. +// Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose +// VPC endpoints will be listed. type ListVpcEndpointsForDomainInput struct { // Name of the ElasticSearch domain whose VPC endpoints are to be listed. @@ -43,8 +43,8 @@ type ListVpcEndpointsForDomainInput struct { noSmithyDocumentSerde } -// Container for response parameters to the ListVpcEndpointsForDomain operation. -// Returns a list containing summarized details of the VPC endpoints. +// Container for response parameters to the ListVpcEndpointsForDomain operation. Returns a list containing +// summarized details of the VPC endpoints. type ListVpcEndpointsForDomainOutput struct { // Information about each endpoint associated with the domain. diff --git a/service/elasticsearchservice/api_op_RejectInboundCrossClusterSearchConnection.go b/service/elasticsearchservice/api_op_RejectInboundCrossClusterSearchConnection.go index 3e1897a3758..f3bbd890597 100644 --- a/service/elasticsearchservice/api_op_RejectInboundCrossClusterSearchConnection.go +++ b/service/elasticsearchservice/api_op_RejectInboundCrossClusterSearchConnection.go @@ -28,8 +28,7 @@ func (c *Client) RejectInboundCrossClusterSearchConnection(ctx context.Context, return out, nil } -// Container for the parameters to the RejectInboundCrossClusterSearchConnection -// operation. +// Container for the parameters to the RejectInboundCrossClusterSearchConnection operation. type RejectInboundCrossClusterSearchConnectionInput struct { // The id of the inbound connection that you want to reject. @@ -40,12 +39,10 @@ type RejectInboundCrossClusterSearchConnectionInput struct { noSmithyDocumentSerde } -// The result of a RejectInboundCrossClusterSearchConnection operation. Contains -// details of rejected inbound connection. +// The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection. type RejectInboundCrossClusterSearchConnectionOutput struct { - // Specifies the InboundCrossClusterSearchConnection of rejected inbound - // connection. + // Specifies the InboundCrossClusterSearchConnection of rejected inbound connection. CrossClusterSearchConnection *types.InboundCrossClusterSearchConnection // Metadata pertaining to the operation's result. diff --git a/service/elasticsearchservice/api_op_RemoveTags.go b/service/elasticsearchservice/api_op_RemoveTags.go index e6dd3cc305e..f096d776f4b 100644 --- a/service/elasticsearchservice/api_op_RemoveTags.go +++ b/service/elasticsearchservice/api_op_RemoveTags.go @@ -26,8 +26,8 @@ func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns return out, nil } -// Container for the parameters to the RemoveTags operation. Specify the ARN for -// the Elasticsearch domain from which you want to remove the specified TagKey . +// Container for the parameters to the RemoveTags operation. Specify the ARN for 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 diff --git a/service/elasticsearchservice/api_op_RevokeVpcEndpointAccess.go b/service/elasticsearchservice/api_op_RevokeVpcEndpointAccess.go index f119a7be9bd..fb7e9b0343d 100644 --- a/service/elasticsearchservice/api_op_RevokeVpcEndpointAccess.go +++ b/service/elasticsearchservice/api_op_RevokeVpcEndpointAccess.go @@ -44,8 +44,8 @@ type RevokeVpcEndpointAccessInput struct { noSmithyDocumentSerde } -// Container for response parameters to the RevokeVpcEndpointAccess operation. The -// response body for this operation is empty. +// Container for response parameters to the RevokeVpcEndpointAccess operation. The response body for this +// operation is empty. type RevokeVpcEndpointAccessOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata diff --git a/service/elasticsearchservice/api_op_StartElasticsearchServiceSoftwareUpdate.go b/service/elasticsearchservice/api_op_StartElasticsearchServiceSoftwareUpdate.go index bc8a17ab6dc..5c829629af4 100644 --- a/service/elasticsearchservice/api_op_StartElasticsearchServiceSoftwareUpdate.go +++ b/service/elasticsearchservice/api_op_StartElasticsearchServiceSoftwareUpdate.go @@ -27,9 +27,8 @@ func (c *Client) StartElasticsearchServiceSoftwareUpdate(ctx context.Context, pa return out, nil } -// Container for the parameters to the StartElasticsearchServiceSoftwareUpdate -// operation. Specifies the name of the Elasticsearch domain that you wish to -// schedule a service software update on. +// Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the +// Elasticsearch domain that you wish to schedule a service software update on. type StartElasticsearchServiceSoftwareUpdateInput struct { // The name of the domain that you want to update to the latest service software. diff --git a/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go b/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go index 22ab555cdaa..64e8921c4f1 100644 --- a/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go +++ b/service/elasticsearchservice/api_op_UpdateElasticsearchDomainConfig.go @@ -28,8 +28,8 @@ func (c *Client) UpdateElasticsearchDomainConfig(ctx context.Context, params *Up return out, nil } -// Container for the parameters to the UpdateElasticsearchDomain operation. -// Specifies the type and number of instances in the domain cluster. +// Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number +// of instances in the domain cluster. type UpdateElasticsearchDomainConfigInput struct { // The name of the Elasticsearch domain that you are updating. @@ -42,8 +42,9 @@ 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) - // for more information. + // default, the value is true . See [Configuration Advanced Options] for more information. + // + // [Configuration Advanced Options]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options AdvancedOptions map[string]string // Specifies advanced security options. @@ -53,15 +54,15 @@ type UpdateElasticsearchDomainConfigInput struct { AutoTuneOptions *types.AutoTuneOptions // 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) - // . + // authentication. For more information, see [Amazon Cognito Authentication for Kibana]. + // + // [Amazon Cognito Authentication for 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. DomainEndpointOptions *types.DomainEndpointOptions - // This flag, when set to True, specifies whether the UpdateElasticsearchDomain + // This flag, when set to True, specifies whether the UpdateElasticsearchDomain // request should return the results of validation checks without actually applying // the change. This flag, when set to True, specifies the deployment mechanism // through which the update shall be applied on the domain. This will not actually @@ -89,8 +90,9 @@ type UpdateElasticsearchDomainConfigInput struct { 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) - // in VPC Endpoints for Amazon Elasticsearch Service Domains + // information, see [Creating a VPC]in VPC Endpoints for Amazon Elasticsearch Service Domains + // + // [Creating a VPC]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc VPCOptions *types.VPCOptions noSmithyDocumentSerde diff --git a/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go b/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go index 7464c9e9484..ca7cc038b1d 100644 --- a/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go +++ b/service/elasticsearchservice/api_op_UpgradeElasticsearchDomain.go @@ -44,7 +44,7 @@ type UpgradeElasticsearchDomainInput struct { // This member is required. TargetVersion *string - // This flag, when set to True, indicates that an Upgrade Eligibility Check needs + // This flag, when set to True, indicates that an Upgrade Eligibility Check needs // to be performed. This will not actually perform the Upgrade. PerformCheckOnly *bool @@ -63,7 +63,7 @@ type UpgradeElasticsearchDomainOutput struct { // (hyphen). DomainName *string - // This flag, when set to True, indicates that an Upgrade Eligibility Check needs + // This flag, when set to True, indicates that an Upgrade Eligibility Check needs // to be performed. This will not actually perform the Upgrade. PerformCheckOnly *bool diff --git a/service/elasticsearchservice/doc.go b/service/elasticsearchservice/doc.go index 6b65150496f..736b6e9aab2 100644 --- a/service/elasticsearchservice/doc.go +++ b/service/elasticsearchservice/doc.go @@ -3,14 +3,19 @@ // Package elasticsearchservice provides the API client, operations, and parameter // types for Amazon Elasticsearch Service. // -// 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: +// # 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]. The guide also +// contains [sample code for sending signed HTTP requests to the Elasticsearch 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 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]. +// +// [sample code for sending signed HTTP requests to the Elasticsearch APIs]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html +// [Regions and Endpoints]: http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions +// [Amazon Elasticsearch Service Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html package elasticsearchservice diff --git a/service/elasticsearchservice/options.go b/service/elasticsearchservice/options.go index c3e0bd9f3dc..4f256ed4464 100644 --- a/service/elasticsearchservice/options.go +++ b/service/elasticsearchservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elasticsearchservice/types/enums.go b/service/elasticsearchservice/types/enums.go index 6b5123f2cf9..713b9ff64e7 100644 --- a/service/elasticsearchservice/types/enums.go +++ b/service/elasticsearchservice/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AutoTuneDesiredState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoTuneDesiredState) Values() []AutoTuneDesiredState { return []AutoTuneDesiredState{ "ENABLED", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for AutoTuneState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoTuneState) Values() []AutoTuneState { return []AutoTuneState{ "ENABLED", @@ -60,8 +62,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -83,8 +86,9 @@ const ( ) // Values returns all known values for ConfigChangeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigChangeStatus) Values() []ConfigChangeStatus { return []ConfigChangeStatus{ "Pending", @@ -110,8 +114,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "PENDING_UPDATE", @@ -133,6 +138,7 @@ const ( // Values returns all known values for DescribePackagesFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DescribePackagesFilterName) Values() []DescribePackagesFilterName { return []DescribePackagesFilterName{ @@ -154,8 +160,9 @@ const ( ) // Values returns all known values for DomainPackageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainPackageStatus) Values() []DomainPackageStatus { return []DomainPackageStatus{ "ASSOCIATING", @@ -181,6 +188,7 @@ const ( // Values returns all known values for DomainProcessingStatusType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DomainProcessingStatusType) Values() []DomainProcessingStatusType { return []DomainProcessingStatusType{ @@ -203,8 +211,9 @@ const ( ) // Values returns all known values for EngineType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EngineType) Values() []EngineType { return []EngineType{ "OpenSearch", @@ -277,8 +286,9 @@ const ( ) // Values returns all known values for ESPartitionInstanceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ESPartitionInstanceType) Values() []ESPartitionInstanceType { return []ESPartitionInstanceType{ "m3.medium.elasticsearch", @@ -352,6 +362,7 @@ const ( // Values returns all known values for ESWarmPartitionInstanceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ESWarmPartitionInstanceType) Values() []ESWarmPartitionInstanceType { return []ESWarmPartitionInstanceType{ @@ -374,8 +385,9 @@ const ( // Values returns all known values for // InboundCrossClusterSearchConnectionStatusCode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InboundCrossClusterSearchConnectionStatusCode) Values() []InboundCrossClusterSearchConnectionStatusCode { return []InboundCrossClusterSearchConnectionStatusCode{ "PENDING_ACCEPTANCE", @@ -396,8 +408,9 @@ const ( ) // Values returns all known values for InitiatedBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InitiatedBy) Values() []InitiatedBy { return []InitiatedBy{ "CUSTOMER", @@ -416,8 +429,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "INDEX_SLOW_LOGS", @@ -437,8 +451,9 @@ const ( ) // Values returns all known values for OptionState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptionState) Values() []OptionState { return []OptionState{ "RequiresIndexDocuments", @@ -463,8 +478,9 @@ const ( // Values returns all known values for // OutboundCrossClusterSearchConnectionStatusCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutboundCrossClusterSearchConnectionStatusCode) Values() []OutboundCrossClusterSearchConnectionStatusCode { return []OutboundCrossClusterSearchConnectionStatusCode{ "PENDING_ACCEPTANCE", @@ -489,8 +505,9 @@ const ( ) // Values returns all known values for OverallChangeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverallChangeStatus) Values() []OverallChangeStatus { return []OverallChangeStatus{ "PENDING", @@ -515,8 +532,9 @@ const ( ) // Values returns all known values for PackageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageStatus) Values() []PackageStatus { return []PackageStatus{ "COPYING", @@ -538,8 +556,9 @@ const ( ) // Values returns all known values for PackageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageType) Values() []PackageType { return []PackageType{ "TXT-DICTIONARY", @@ -555,8 +574,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "AWS_ACCOUNT", @@ -573,8 +593,9 @@ const ( ) // Values returns all known values for PropertyValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyValueType) Values() []PropertyValueType { return []PropertyValueType{ "PLAIN_TEXT", @@ -593,8 +614,9 @@ const ( // Values returns all known values for ReservedElasticsearchInstancePaymentOption. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservedElasticsearchInstancePaymentOption) Values() []ReservedElasticsearchInstancePaymentOption { return []ReservedElasticsearchInstancePaymentOption{ "ALL_UPFRONT", @@ -612,8 +634,9 @@ const ( ) // Values returns all known values for RollbackOnDisable. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RollbackOnDisable) Values() []RollbackOnDisable { return []RollbackOnDisable{ "NO_ROLLBACK", @@ -631,6 +654,7 @@ const ( // Values returns all known values for ScheduledAutoTuneActionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledAutoTuneActionType) Values() []ScheduledAutoTuneActionType { return []ScheduledAutoTuneActionType{ @@ -650,8 +674,9 @@ const ( // Values returns all known values for ScheduledAutoTuneSeverityType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledAutoTuneSeverityType) Values() []ScheduledAutoTuneSeverityType { return []ScheduledAutoTuneSeverityType{ "LOW", @@ -668,8 +693,9 @@ const ( ) // Values returns all known values for TimeUnit. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeUnit) Values() []TimeUnit { return []TimeUnit{ "HOURS", @@ -686,8 +712,9 @@ const ( ) // Values returns all known values for TLSSecurityPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TLSSecurityPolicy) Values() []TLSSecurityPolicy { return []TLSSecurityPolicy{ "Policy-Min-TLS-1-0-2019-07", @@ -707,8 +734,9 @@ const ( ) // Values returns all known values for UpgradeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpgradeStatus) Values() []UpgradeStatus { return []UpgradeStatus{ "IN_PROGRESS", @@ -728,8 +756,9 @@ const ( ) // Values returns all known values for UpgradeStep. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpgradeStep) Values() []UpgradeStep { return []UpgradeStep{ "PRE_UPGRADE_CHECK", @@ -749,8 +778,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "standard", @@ -769,8 +799,9 @@ const ( ) // Values returns all known values for VpcEndpointErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointErrorCode) Values() []VpcEndpointErrorCode { return []VpcEndpointErrorCode{ "ENDPOINT_NOT_FOUND", @@ -792,8 +823,9 @@ const ( ) // Values returns all known values for VpcEndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointStatus) Values() []VpcEndpointStatus { return []VpcEndpointStatus{ "CREATING", diff --git a/service/elasticsearchservice/types/types.go b/service/elasticsearchservice/types/types.go index 0886bda0395..207e33f49e6 100644 --- a/service/elasticsearchservice/types/types.go +++ b/service/elasticsearchservice/types/types.go @@ -12,8 +12,9 @@ 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]for more information. + // + // [Configuring Access Policies]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies // // This member is required. Options *string @@ -27,48 +28,53 @@ type AccessPoliciesStatus struct { noSmithyDocumentSerde } -// List of limits that are specific to a given InstanceType and for each of it's -// InstanceRole . +// List of limits that are specific to a given InstanceType and for each of it's InstanceRole +// +// . type AdditionalLimit struct { - // Name of Additional Limit is specific to a given InstanceType and for each of - // it's InstanceRole etc. + // Name of Additional Limit is specific to a given InstanceType and for each of + // it's InstanceRoleetc. // // 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. + // node only to specify how much data nodes upto which given ESPartitionInstanceTypecan 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. + // Data node only to specify how much data nodes of given ESPartitionInstanceTypeupto which you don't + // need any master nodes to govern them. LimitName *string - // Value for given AdditionalLimit$LimitName . + // Value for given AdditionalLimit$LimitName . LimitValues []string noSmithyDocumentSerde } -// Status of the advanced options for the specified Elasticsearch domain. +// 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. +// true . See [Configuration 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]. +// +// [Configuration Advanced Options]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options +// [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. + // Specifies the status of advanced options for the specified Elasticsearch + // domain. // // This member is required. Options map[string]string - // Specifies the status of OptionStatus for advanced options for the specified + // Specifies the status of OptionStatus for advanced options for the specified // Elasticsearch domain. // // This member is required. @@ -125,16 +131,17 @@ type AdvancedSecurityOptionsInput struct { noSmithyDocumentSerde } -// Specifies the status of advanced security options for the specified +// Specifies the status of advanced security options for the specified +// // Elasticsearch domain. type AdvancedSecurityOptionsStatus struct { - // Specifies advanced security options for the specified Elasticsearch domain. + // Specifies advanced security options for the specified Elasticsearch domain. // // This member is required. Options *AdvancedSecurityOptions - // Status of the advanced security options for the specified Elasticsearch domain. + // Status of the advanced security options for the specified Elasticsearch domain. // // This member is required. Status *OptionStatus @@ -158,8 +165,9 @@ 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) - // for more information. + // Specifies details of the Auto-Tune action. See the [Developer Guide] for more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html AutoTuneDetails *AutoTuneDetails // Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. @@ -168,29 +176,35 @@ 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) -// for more information. +// Specifies details of the Auto-Tune action. See the [Developer Guide] for more information. +// +// [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html 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) - // for more information. + // Specifies details of the scheduled Auto-Tune action. See the [Developer Guide] for more + // information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html ScheduledAutoTuneDetails *ScheduledAutoTuneDetails noSmithyDocumentSerde } -// Specifies Auto-Tune maitenance schedule. See the Developer Guide (https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html) -// for more information. +// Specifies Auto-Tune maitenance schedule. See the [Developer Guide] for more information. +// +// [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html 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) - // for more information. + // Specifies cron expression for a recurring maintenance schedule. See the [Developer Guide] for + // more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html 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) - // for more information. + // the [Developer Guide]for more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html Duration *Duration // Specifies timestamp at which Auto-Tune maintenance schedule start. @@ -207,8 +221,9 @@ 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) - // for more information. + // Specifies list of maitenance schedules. See the [Developer Guide] for more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html MaintenanceSchedules []AutoTuneMaintenanceSchedule // Specifies the rollback state while disabling Auto-Tune for the domain. Valid @@ -225,8 +240,9 @@ 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) - // for more information. + // Specifies list of maitenance schedules. See the [Developer Guide] for more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html MaintenanceSchedules []AutoTuneMaintenanceSchedule noSmithyDocumentSerde @@ -245,14 +261,15 @@ type AutoTuneOptionsOutput struct { noSmithyDocumentSerde } -// Specifies the status of Auto-Tune options for the specified Elasticsearch +// Specifies the status of Auto-Tune options for the specified Elasticsearch +// // domain. type AutoTuneOptionsStatus struct { - // Specifies Auto-Tune options for the specified Elasticsearch domain. + // Specifies Auto-Tune options for the specified Elasticsearch domain. Options *AutoTuneOptions - // Specifies Status of the Auto-Tune options for the specified Elasticsearch + // Specifies Status of the Auto-Tune options for the specified Elasticsearch // domain. Status *AutoTuneStatus @@ -391,9 +408,9 @@ 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) -// . +// authentication. For more information, see [Amazon Cognito Authentication for Kibana]. +// +// [Amazon Cognito Authentication for 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. @@ -440,8 +457,7 @@ type ColdStorageOptions struct { noSmithyDocumentSerde } -// A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion -// s to which the domain can be upgraded. +// A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded. type CompatibleVersionsMap struct { // The current version of Elasticsearch on which a domain is. @@ -484,6 +500,7 @@ type DomainEndpointOptions struct { // of Elasticsearch domain. // // It can be one of the following values: + // // - Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version // 1.0 to TLS version 1.2 // - Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS @@ -514,10 +531,10 @@ type DomainEndpointOptionsStatus struct { type DomainInfo struct { - // Specifies the DomainName . + // Specifies the DomainName . DomainName *string - // Specifies the EngineType of the domain. + // Specifies the EngineType of the domain. EngineType EngineType noSmithyDocumentSerde @@ -576,8 +593,8 @@ type DomainPackageDetails struct { type DryRunResults struct { - // Specifies the deployment mechanism through which the update shall be applied on - // the domain. Possible responses are Blue/Green (The update will require a + // Specifies the deployment mechanism through which the update shall be applied + // on the domain. Possible responses are Blue/Green (The update will require a // 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 @@ -592,26 +609,30 @@ 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) -// for more information. +// the [Developer Guide]for more information. +// +// [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html 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) - // for more information. + // See the [Developer Guide]for more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html 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) - // for more information. + // Integer to specify the value of a maintenance schedule duration. See the [Developer Guide] for + // more information. + // + // [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html Value *int64 noSmithyDocumentSerde } // 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]. +// +// [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. @@ -623,10 +644,10 @@ type EBSOptions struct { // Specifies the Throughput for GP3 EBS volume (SSD). Throughput *int32 - // Integer to specify the size of an EBS volume. + // Integer to specify the size of an EBS volume. VolumeSize *int32 - // Specifies the volume type for EBS-based storage. + // Specifies the volume type for EBS-based storage. VolumeType VolumeType noSmithyDocumentSerde @@ -635,12 +656,12 @@ type EBSOptions struct { // Status of the EBS options for the specified Elasticsearch domain. type EBSOptionsStatus struct { - // Specifies the EBS options for the specified Elasticsearch domain. + // Specifies the EBS options for the specified Elasticsearch domain. // // This member is required. Options *EBSOptions - // Specifies the status of the EBS options for the specified Elasticsearch domain. + // Specifies the status of the EBS options for the specified Elasticsearch domain. // // This member is required. Status *OptionStatus @@ -658,9 +679,10 @@ type ElasticsearchClusterConfig struct { // Total number of dedicated master nodes, active and on standby, for the cluster. 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) + // A boolean value to indicate whether a dedicated master node is enabled. See [About Dedicated Master Nodes] // for more information. + // + // [About Dedicated Master Nodes]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes DedicatedMasterEnabled *bool // The instance type for a dedicated master node. @@ -686,9 +708,10 @@ type ElasticsearchClusterConfig struct { // enabled. 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) - // for more information. + // A boolean value to indicate whether zone awareness is enabled. See [About Zone Awareness] for more + // information. + // + // [About Zone Awareness]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness ZoneAwarenessEnabled *bool noSmithyDocumentSerde @@ -697,12 +720,12 @@ type ElasticsearchClusterConfig struct { // Specifies the configuration status for the specified Elasticsearch domain. type ElasticsearchClusterConfigStatus struct { - // Specifies the cluster configuration for the specified Elasticsearch domain. + // Specifies the cluster configuration for the specified Elasticsearch domain. // // This member is required. Options *ElasticsearchClusterConfig - // Specifies the status of the configuration for the specified Elasticsearch + // Specifies the status of the configuration for the specified Elasticsearch // domain. // // This member is required. @@ -717,8 +740,9 @@ 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) - // for more information. + // Specifies the AdvancedOptions for the domain. See [Configuring Advanced Options] for more information. + // + // [Configuring Advanced Options]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options AdvancedOptions *AdvancedOptionsStatus // Specifies AdvancedSecurityOptions for the domain. @@ -730,9 +754,9 @@ type ElasticsearchDomainConfig struct { // Specifies change details of the domain configuration change. 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) - // . + // The CognitoOptions for the specified domain. For more information, see [Amazon Cognito Authentication for Kibana]. + // + // [Amazon 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. @@ -762,9 +786,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]. + // + // [VPC Endpoints for Amazon Elasticsearch Service Domains]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html VPCOptions *VPCDerivedInfoStatus noSmithyDocumentSerde @@ -773,9 +797,10 @@ type ElasticsearchDomainConfig struct { // The current status of an Elasticsearch domain. 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) - // in Using AWS Identity and Access Management for more information. + // The Amazon resource name (ARN) of an Elasticsearch domain. See [Identifiers for IAM Entities] in Using AWS + // Identity and Access Management for more information. + // + // [Identifiers for IAM Entities]: http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html // // This member is required. ARN *string @@ -798,7 +823,7 @@ type ElasticsearchDomainStatus struct { // This member is required. ElasticsearchClusterConfig *ElasticsearchClusterConfig - // IAM access policy as a JSON-formatted string. + // IAM access policy as a JSON-formatted string. AccessPolicies *string // Specifies the status of the AdvancedOptions @@ -813,9 +838,9 @@ type ElasticsearchDomainStatus struct { // Specifies change details of the domain configuration change. 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) - // . + // The CognitoOptions for the specified domain. For more information, see [Amazon Cognito Authentication for Kibana]. + // + // [Amazon 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 @@ -834,13 +859,14 @@ type ElasticsearchDomainStatus struct { // The status of any changes that are currently in progress for the domain. DomainProcessingStatus DomainProcessingStatusType - // 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. + // The EBSOptions for the specified domain. See [Configuring EBS-based Storage] for more information. + // + // [Configuring EBS-based Storage]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs 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 @@ -877,24 +903,25 @@ 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]. + // + // [VPC Endpoints for Amazon Elasticsearch Service Domains]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html VPCOptions *VPCDerivedInfo noSmithyDocumentSerde } -// Status of the Elasticsearch version options for the specified Elasticsearch +// Status of the Elasticsearch version options for the specified Elasticsearch +// // domain. type ElasticsearchVersionStatus struct { - // Specifies the Elasticsearch version for the specified Elasticsearch domain. + // Specifies the Elasticsearch version for the specified Elasticsearch domain. // // This member is required. Options *string - // Specifies the status of the Elasticsearch version options for the specified + // Specifies the status of the Elasticsearch version options for the specified // Elasticsearch domain. // // This member is required. @@ -909,21 +936,24 @@ type EncryptionAtRestOptions struct { // Specifies the option to enable Encryption At Rest. Enabled *bool - // Specifies the KMS Key ID for Encryption At Rest options. + // Specifies the KMS Key ID for Encryption At Rest options. KmsKeyId *string noSmithyDocumentSerde } -// Status of the Encryption At Rest options for the specified Elasticsearch domain. +// Status of the Encryption At Rest options for the specified Elasticsearch +// +// domain. type EncryptionAtRestOptionsStatus struct { - // Specifies the Encryption At Rest options for the specified Elasticsearch domain. + // Specifies the Encryption At Rest options for the specified Elasticsearch + // domain. // // This member is required. Options *EncryptionAtRestOptions - // Specifies the status of the Encryption At Rest options for the specified + // Specifies the status of the Encryption At Rest options for the specified // Elasticsearch domain. // // This member is required. @@ -940,16 +970,17 @@ type ErrorDetails struct { noSmithyDocumentSerde } -// A filter used to limit results when describing inbound or outbound +// 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. + // Specifies the name of the filter. Name *string - // Contains one or more values for the filter. + // Contains one or more values for the filter. Values []string noSmithyDocumentSerde @@ -958,8 +989,7 @@ type Filter struct { // Specifies details of an inbound connection. type InboundCrossClusterSearchConnection struct { - // Specifies the InboundCrossClusterSearchConnectionStatus for the outbound - // connection. + // Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection. ConnectionStatus *InboundCrossClusterSearchConnectionStatus // Specifies the connection id for the inbound cross-cluster search connection. @@ -981,6 +1011,7 @@ 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 @@ -994,14 +1025,15 @@ type InboundCrossClusterSearchConnectionStatus struct { noSmithyDocumentSerde } -// InstanceCountLimits represents the limits on number of instances that be +// 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. + // Maximum number of Instances that can be instantiated for given InstanceType. MaximumInstanceCount int32 - // Minimum number of Instances that can be instantiated for given InstanceType. + // Minimum number of Instances that can be instantiated for given InstanceType. MinimumInstanceCount int32 noSmithyDocumentSerde @@ -1011,20 +1043,20 @@ type InstanceCountLimits struct { // available for given InstanceType. type InstanceLimits struct { - // InstanceCountLimits represents the limits on number of instances that be + // InstanceCountLimits represents the limits on number of instances that be // created in Amazon Elasticsearch for given InstanceType. InstanceCountLimits *InstanceCountLimits noSmithyDocumentSerde } -// Limits for given InstanceType and for each of it's role. +// 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 @@ -1041,6 +1073,7 @@ 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 @@ -1049,7 +1082,7 @@ type LogPublishingOption struct { // ARN of the Cloudwatch log group to which log needs to be published. CloudWatchLogsLogGroupArn *string - // Specifies whether given log publishing option is enabled or not. + // Specifies whether given log publishing option is enabled or not. Enabled *bool noSmithyDocumentSerde @@ -1100,6 +1133,7 @@ type ModifyingProperties struct { // The type of value that is currently being modified. Properties can have two // types: + // // - PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search". // - STRINGIFIED_JSON: Contain content in JSON format, such as // {"Enabled":"True"}". @@ -1169,8 +1203,7 @@ type OutboundCrossClusterSearchConnection struct { // Specifies the connection alias for the outbound cross-cluster search connection. ConnectionAlias *string - // Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound - // connection. + // Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection. ConnectionStatus *OutboundCrossClusterSearchConnectionStatus // Specifies the connection id for the outbound cross-cluster search connection. @@ -1192,6 +1225,7 @@ 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 @@ -1426,8 +1460,10 @@ 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) -// for more information. +// Specifies details of the scheduled Auto-Tune action. See the [Developer Guide] for more +// information. +// +// [Developer Guide]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html type ScheduledAutoTuneDetails struct { // Specifies Auto-Tune action description. @@ -1512,9 +1548,10 @@ type SnapshotOptionsStatus struct { // that are available for given InstanceType. type StorageType struct { - // SubType of the given storage type. List of available sub-storage options: For + // 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 @@ -1525,7 +1562,8 @@ type StorageType struct { // List of limits that are applicable for given storage type. StorageTypeLimits []StorageTypeLimit - // Type of the storage. List of available storage options: + // 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 StorageTypeName *string @@ -1536,8 +1574,9 @@ type StorageType struct { // Limits that are applicable for given storage type. type StorageTypeLimit struct { - // Name of storage limits that are applicable for given storage type. If - // StorageType is ebs, following storage options are applicable + // 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 @@ -1552,7 +1591,7 @@ type StorageTypeLimit struct { // storage type.It can be empty if it is not applicable. LimitName *string - // Values for the StorageTypeLimit$LimitName . + // Values for the StorageTypeLimit$LimitName . LimitValues []string noSmithyDocumentSerde @@ -1585,15 +1624,16 @@ type UpgradeHistory struct { // format. StartTimestamp *time.Time - // A list of UpgradeStepItem s representing information about each step performed - // as pard of a specific Upgrade or Upgrade Eligibility Check. + // A list of UpgradeStepItem s representing information about each step performed as pard of a + // specific Upgrade or Upgrade Eligibility Check. StepsList []UpgradeStepItem // A string that describes the update briefly UpgradeName *string - // The overall status of the update. The status can take one of the following + // The overall status of the update. The status can take one of the following // values: + // // - In Progress // - Succeeded // - Succeeded with Issues @@ -1613,15 +1653,17 @@ type UpgradeStepItem struct { // The Floating point value representing progress percentage of a particular step. ProgressPercent *float64 - // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does + // Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does // through: + // // - PreUpgradeCheck // - Snapshot // - Upgrade UpgradeStep UpgradeStep - // The status of a particular step during an upgrade. The status can take one of + // The status of a particular step during an upgrade. The status can take one of // the following values: + // // - In Progress // - Succeeded // - Succeeded with Issues @@ -1632,8 +1674,9 @@ type UpgradeStepItem 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]. +// +// [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 @@ -1656,12 +1699,12 @@ type VPCDerivedInfo struct { // Status of the VPC options for the specified Elasticsearch domain. type VPCDerivedInfoStatus struct { - // Specifies the VPC options for the specified Elasticsearch domain. + // Specifies the VPC options for the specified Elasticsearch domain. // // This member is required. Options *VPCDerivedInfo - // Specifies the status of the VPC options for the specified Elasticsearch domain. + // Specifies the status of the VPC options for the specified Elasticsearch domain. // // This member is required. Status *OptionStatus @@ -1730,8 +1773,9 @@ 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]. +// +// [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_op_CancelJob.go b/service/elastictranscoder/api_op_CancelJob.go index 4d8a8a8219c..aae9043ad3d 100644 --- a/service/elastictranscoder/api_op_CancelJob.go +++ b/service/elastictranscoder/api_op_CancelJob.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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 UpdatePipelineStatusto // temporarily pause the pipeline. func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { @@ -32,9 +33,10 @@ func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns . // The CancelJobRequest structure. 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 - // ListJobsByStatus API action. + // 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 ListJobsByStatus API action. // // This member is required. Id *string diff --git a/service/elastictranscoder/api_op_CreateJob.go b/service/elastictranscoder/api_op_CreateJob.go index c75752dfc41..5493195c607 100644 --- a/service/elastictranscoder/api_op_CreateJob.go +++ b/service/elastictranscoder/api_op_CreateJob.go @@ -12,10 +12,12 @@ import ( ) // When you create a job, Elastic Transcoder returns JSON data that includes the -// values that you specified plus information about the job that is created. If you -// have specified more than one output for your jobs (for example, one output for -// the Kindle Fire and another output for the Apple iPhone 4s), you currently must -// use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console). +// values that you specified plus information about the job that is created. +// +// If you have specified more than one output for your jobs (for example, one +// output for the Kindle Fire and another output for the Apple iPhone 4s), you +// currently must use the Elastic Transcoder API to list the jobs (as opposed to +// the AWS Console). func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { params = &CreateJobInput{} @@ -50,7 +52,7 @@ type CreateJobInput struct { // are being transcoded. Inputs []types.JobInput - // A section of the request body that provides information about the transcoded + // A section of the request body that provides information about the transcoded // (target) file. We strongly recommend that you use the Outputs syntax instead of // the Output syntax. Output *types.CreateJobOutput @@ -60,15 +62,16 @@ type CreateJobInput struct { // playlists. OutputKeyPrefix *string - // A section of the request body that provides information about the transcoded + // A section of the request body that provides information about the transcoded // (target) files. We recommend that you use the Outputs syntax instead of the // Output syntax. Outputs []types.CreateJobOutput // If you specify a preset in PresetId 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. The maximum number - // of master playlists in a job is 30. + // master playlists that you want Elastic Transcoder to create. + // + // The maximum number of master playlists in a job is 30. Playlists []types.CreateJobPlaylist // User-defined metadata that you want to associate with an Elastic Transcoder diff --git a/service/elastictranscoder/api_op_CreatePipeline.go b/service/elastictranscoder/api_op_CreatePipeline.go index 11059ba84b7..4aa19029635 100644 --- a/service/elastictranscoder/api_op_CreatePipeline.go +++ b/service/elastictranscoder/api_op_CreatePipeline.go @@ -37,7 +37,9 @@ type CreatePipelineInput struct { InputBucket *string // The name of the pipeline. We recommend that the name be unique within the AWS - // account, but uniqueness is not enforced. Constraints: Maximum 40 characters. + // account, but uniqueness is not enforced. + // + // Constraints: Maximum 40 characters. // // This member is required. Name *string @@ -49,76 +51,102 @@ type CreatePipelineInput struct { 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 - // 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 . + // 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 . 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. + // 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. + // 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. + // 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. @@ -126,17 +154,28 @@ type CreatePipelineInput struct { // 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: + // 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 . + // 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 @@ -146,39 +185,57 @@ type CreatePipelineInput struct { // 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. + // 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. + // 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. @@ -196,9 +253,11 @@ type CreatePipelineOutput struct { Pipeline *types.Pipeline // Elastic Transcoder returns a warning if the resources used by your pipeline are - // not in the same region as the pipeline. Using resources in the same region, such - // as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, - // reduces processing time and prevents cross-regional charges. + // not in the same region as the pipeline. + // + // Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS + // notification topics, and AWS KMS key, reduces processing time and prevents + // cross-regional charges. Warnings []types.Warning // Metadata pertaining to the operation's result. diff --git a/service/elastictranscoder/api_op_CreatePreset.go b/service/elastictranscoder/api_op_CreatePreset.go index 297b766503c..a848b992b70 100644 --- a/service/elastictranscoder/api_op_CreatePreset.go +++ b/service/elastictranscoder/api_op_CreatePreset.go @@ -12,6 +12,7 @@ import ( ) // The CreatePreset operation creates a preset with settings that you specify. +// // 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 @@ -20,10 +21,12 @@ import ( // strictly compliant with the H.264 standard, Elastic Transcoder creates the // preset and returns a warning message in the response. This helps you determine // whether your settings comply with the H.264 standard while giving you greater -// flexibility with respect to the video that Elastic Transcoder produces. Elastic -// Transcoder uses the H.264 video-compression format. For more information, see -// the International Telecommunication Union publication Recommendation ITU-T -// H.264: Advanced video coding for generic audiovisual services. +// flexibility with respect to the video that Elastic Transcoder produces. +// +// Elastic Transcoder uses the H.264 video-compression format. For more +// information, see the International Telecommunication Union publication +// Recommendation ITU-T H.264: Advanced video coding for generic audiovisual +// services. func (c *Client) CreatePreset(ctx context.Context, params *CreatePresetInput, optFns ...func(*Options)) (*CreatePresetOutput, error) { if params == nil { params = &CreatePresetInput{} diff --git a/service/elastictranscoder/api_op_DeletePipeline.go b/service/elastictranscoder/api_op_DeletePipeline.go index bd4742c3bcb..b964f5e50ac 100644 --- a/service/elastictranscoder/api_op_DeletePipeline.go +++ b/service/elastictranscoder/api_op_DeletePipeline.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DeletePipeline operation removes a pipeline. You can only delete a pipeline -// that has never been used or that is not currently in use (doesn't contain any -// active jobs). If the pipeline is currently in use, DeletePipeline returns an -// error. +// The DeletePipeline operation removes a pipeline. +// +// You can only delete a pipeline that has never been used or that is not +// currently in use (doesn't contain any active jobs). If the pipeline is currently +// in use, DeletePipeline returns an error. func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error) { if params == nil { params = &DeletePipelineInput{} diff --git a/service/elastictranscoder/api_op_DeletePreset.go b/service/elastictranscoder/api_op_DeletePreset.go index faa2dd053f6..a2f4246a762 100644 --- a/service/elastictranscoder/api_op_DeletePreset.go +++ b/service/elastictranscoder/api_op_DeletePreset.go @@ -11,6 +11,7 @@ import ( ) // The DeletePreset operation removes a preset that you've added in an AWS region. +// // You can't delete the default presets that are included with Elastic Transcoder. func (c *Client) DeletePreset(ctx context.Context, params *DeletePresetInput, optFns ...func(*Options)) (*DeletePresetOutput, error) { if params == nil { diff --git a/service/elastictranscoder/api_op_ListJobsByPipeline.go b/service/elastictranscoder/api_op_ListJobsByPipeline.go index b75b632b382..0fbbc897d06 100644 --- a/service/elastictranscoder/api_op_ListJobsByPipeline.go +++ b/service/elastictranscoder/api_op_ListJobsByPipeline.go @@ -12,9 +12,11 @@ import ( ) // The ListJobsByPipeline operation gets a list of the jobs currently in a -// pipeline. Elastic Transcoder returns all of the jobs currently in the specified -// pipeline. The response body contains one element for each job that satisfies the -// search criteria. +// pipeline. +// +// Elastic Transcoder returns all of the jobs currently in the specified pipeline. +// The response body contains one element for each job that satisfies the search +// criteria. func (c *Client) ListJobsByPipeline(ctx context.Context, params *ListJobsByPipelineInput, optFns ...func(*Options)) (*ListJobsByPipelineOutput, error) { if params == nil { params = &ListJobsByPipelineInput{} @@ -38,13 +40,13 @@ type ListJobsByPipelineInput struct { // This member is required. PipelineId *string - // To list jobs in chronological order by the date and time that they were + // 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 // . Ascending *string - // When Elastic Transcoder returns more than one page of results, use pageToken in - // subsequent GET requests to get each successive page of results. + // When Elastic Transcoder returns more than one page of results, use pageToken + // in subsequent GET requests to get each successive page of results. PageToken *string noSmithyDocumentSerde @@ -56,7 +58,7 @@ type ListJobsByPipelineOutput struct { // An array of Job objects that are in the specified pipeline. Jobs []types.Job - // A value that you use to access the second and subsequent pages of results, if + // 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 . NextPageToken *string diff --git a/service/elastictranscoder/api_op_ListJobsByStatus.go b/service/elastictranscoder/api_op_ListJobsByStatus.go index e931d04982d..05739808e22 100644 --- a/service/elastictranscoder/api_op_ListJobsByStatus.go +++ b/service/elastictranscoder/api_op_ListJobsByStatus.go @@ -39,13 +39,13 @@ type ListJobsByStatusInput struct { // This member is required. Status *string - // To list jobs in chronological order by the date and time that they were + // 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 // . Ascending *string - // When Elastic Transcoder returns more than one page of results, use pageToken in - // subsequent GET requests to get each successive page of results. + // When Elastic Transcoder returns more than one page of results, use pageToken + // in subsequent GET requests to get each successive page of results. PageToken *string noSmithyDocumentSerde @@ -57,7 +57,7 @@ type ListJobsByStatusOutput struct { // An array of Job objects that have the specified status. Jobs []types.Job - // A value that you use to access the second and subsequent pages of results, if + // 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 . NextPageToken *string diff --git a/service/elastictranscoder/api_op_ReadJob.go b/service/elastictranscoder/api_op_ReadJob.go index fa9cfbf3a1a..41cf7c22eda 100644 --- a/service/elastictranscoder/api_op_ReadJob.go +++ b/service/elastictranscoder/api_op_ReadJob.go @@ -172,12 +172,13 @@ type JobCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *ReadJobInput, *ReadJobOutput, error) (bool, error) } diff --git a/service/elastictranscoder/api_op_ReadPipeline.go b/service/elastictranscoder/api_op_ReadPipeline.go index 60dc7c6565a..6797ff1b3af 100644 --- a/service/elastictranscoder/api_op_ReadPipeline.go +++ b/service/elastictranscoder/api_op_ReadPipeline.go @@ -45,9 +45,11 @@ type ReadPipelineOutput struct { Pipeline *types.Pipeline // Elastic Transcoder returns a warning if the resources used by your pipeline are - // not in the same region as the pipeline. Using resources in the same region, such - // as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, - // reduces processing time and prevents cross-regional charges. + // not in the same region as the pipeline. + // + // Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS + // notification topics, and AWS KMS key, reduces processing time and prevents + // cross-regional charges. Warnings []types.Warning // Metadata pertaining to the operation's result. diff --git a/service/elastictranscoder/api_op_TestRole.go b/service/elastictranscoder/api_op_TestRole.go index aa332f07841..d605d9cf79b 100644 --- a/service/elastictranscoder/api_op_TestRole.go +++ b/service/elastictranscoder/api_op_TestRole.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The TestRole operation tests the IAM role used to create the pipeline. The -// TestRole action lets you determine whether the IAM role you are using has +// The TestRole operation tests the IAM role used to create the pipeline. +// +// The TestRole action lets you determine whether the IAM role you are using has // sufficient permissions to let Elastic Transcoder perform tasks associated with // the transcoding process. The action attempts to assume the specified IAM role, // checks read access to the input and output buckets, and tries to send a test diff --git a/service/elastictranscoder/api_op_UpdatePipeline.go b/service/elastictranscoder/api_op_UpdatePipeline.go index c86c529ac55..b0ec73a70ff 100644 --- a/service/elastictranscoder/api_op_UpdatePipeline.go +++ b/service/elastictranscoder/api_op_UpdatePipeline.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use the UpdatePipeline operation to update settings for a pipeline. When you -// change pipeline settings, your changes take effect immediately. Jobs that you -// have already submitted and that Elastic Transcoder has not started to process -// are affected in addition to jobs that you submit after you change settings. +// Use the UpdatePipeline operation to update settings for a pipeline. +// +// When you change pipeline settings, your changes take effect immediately. Jobs +// that you have already submitted and that Elastic Transcoder has not started to +// process are affected in addition to jobs that you submit after you change +// settings. func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput, optFns ...func(*Options)) (*UpdatePipelineOutput, error) { if params == nil { params = &UpdatePipelineInput{} @@ -39,56 +41,76 @@ 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 - // 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 . + // 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 . 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. + // 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. + // 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. @@ -99,22 +121,30 @@ type UpdatePipelineInput struct { InputBucket *string // The name of the pipeline. We recommend that the name be unique within the AWS - // account, but uniqueness is not enforced. Constraints: Maximum 40 characters + // 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. + // 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. @@ -127,39 +157,57 @@ type UpdatePipelineInput struct { // 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. + // 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. + // 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. @@ -176,9 +224,11 @@ type UpdatePipelineOutput struct { Pipeline *types.Pipeline // Elastic Transcoder returns a warning if the resources used by your pipeline are - // not in the same region as the pipeline. Using resources in the same region, such - // as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, - // reduces processing time and prevents cross-regional charges. + // not in the same region as the pipeline. + // + // Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS + // notification topics, and AWS KMS key, reduces processing time and prevents + // cross-regional charges. Warnings []types.Warning // Metadata pertaining to the operation's result. diff --git a/service/elastictranscoder/api_op_UpdatePipelineNotifications.go b/service/elastictranscoder/api_op_UpdatePipelineNotifications.go index ae6fd66f5d3..5213a47797c 100644 --- a/service/elastictranscoder/api_op_UpdatePipelineNotifications.go +++ b/service/elastictranscoder/api_op_UpdatePipelineNotifications.go @@ -12,9 +12,10 @@ import ( ) // With the UpdatePipelineNotifications operation, you can update Amazon Simple -// Notification Service (Amazon SNS) notifications for a pipeline. When you update -// notifications for a pipeline, Elastic Transcoder returns the values that you -// specified in the request. +// Notification Service (Amazon SNS) notifications for a pipeline. +// +// When you update notifications for a pipeline, Elastic Transcoder returns the +// values that you specified in the request. func (c *Client) UpdatePipelineNotifications(ctx context.Context, params *UpdatePipelineNotificationsInput, optFns ...func(*Options)) (*UpdatePipelineNotificationsOutput, error) { if params == nil { params = &UpdatePipelineNotificationsInput{} @@ -40,18 +41,24 @@ type UpdatePipelineNotificationsInput struct { 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. + // 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. diff --git a/service/elastictranscoder/api_op_UpdatePipelineStatus.go b/service/elastictranscoder/api_op_UpdatePipelineStatus.go index 818a51c3cd3..db4233511b7 100644 --- a/service/elastictranscoder/api_op_UpdatePipelineStatus.go +++ b/service/elastictranscoder/api_op_UpdatePipelineStatus.go @@ -12,11 +12,12 @@ import ( ) // 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 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 CancelJobrequest. func (c *Client) UpdatePipelineStatus(ctx context.Context, params *UpdatePipelineStatusInput, optFns ...func(*Options)) (*UpdatePipelineStatusOutput, error) { if params == nil { params = &UpdatePipelineStatusInput{} @@ -41,7 +42,9 @@ 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. // // This member is required. diff --git a/service/elastictranscoder/doc.go b/service/elastictranscoder/doc.go index 92c4773bdd9..96f3af37cee 100644 --- a/service/elastictranscoder/doc.go +++ b/service/elastictranscoder/doc.go @@ -3,5 +3,7 @@ // Package elastictranscoder provides the API client, operations, and parameter // types for Amazon Elastic Transcoder. // -// AWS Elastic Transcoder Service The AWS Elastic Transcoder Service. +// # AWS Elastic Transcoder Service +// +// The AWS Elastic Transcoder Service. package elastictranscoder diff --git a/service/elastictranscoder/options.go b/service/elastictranscoder/options.go index f079c228073..675694068d8 100644 --- a/service/elastictranscoder/options.go +++ b/service/elastictranscoder/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/elastictranscoder/types/types.go b/service/elastictranscoder/types/types.go index b9d7d04331d..a8d28e27c41 100644 --- a/service/elastictranscoder/types/types.go +++ b/service/elastictranscoder/types/types.go @@ -7,11 +7,13 @@ import ( ) // 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. +// 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 . @@ -24,9 +26,11 @@ 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 , - // include the prefix in the key. If the file isn't in the specified bucket, - // Elastic Transcoder returns an error. + // 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 , @@ -46,24 +50,30 @@ type Artwork struct { 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, @@ -77,37 +87,56 @@ type Artwork struct { 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 . + // 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 . 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 . + // Audio:Codec. + // + // The order the bits of a PCM sample are stored in. + // + // The supported 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: + // 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 + // + // 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 . + // 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 . Signed *string noSmithyDocumentSerde @@ -119,65 +148,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 - // 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 - // SingleTrack for a specific channel value and inputs are as follows: + // 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 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: + // 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: + // 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 @@ -186,20 +253,29 @@ type AudioParameters struct { // 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: + // 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 @@ -209,13 +285,20 @@ type AudioParameters struct { 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. + // 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 @@ -231,31 +314,47 @@ 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 + // + // - 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 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 @@ -276,17 +375,21 @@ type Captions struct { // 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 . + // // MergePolicy cannot be null. // // Deprecated: This member has been deprecated. @@ -316,16 +419,20 @@ 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. Language *string // For clip generation or captions that do not start at the same time as the // associated video file, the TimeOffset tells Elastic Transcoder how much of the - // video to encode before including captions. Specify the TimeOffset in the form - // [+-]SS.sss or [+-]HH:mm:SS.ss. + // video to encode before including captions. + // + // Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss. TimeOffset *string noSmithyDocumentSerde @@ -353,30 +460,45 @@ 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. + // 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 . + // 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 + // 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 - // 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. + // (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 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. @@ -394,35 +516,39 @@ type CreateJobOutput struct { // encryption settings for each file individually. Encryption *Encryption - // The name to assign to the transcoded file. Elastic Transcoder saves the file in - // the Amazon S3 bucket specified by the OutputBucket object in the pipeline that - // is specified by the pipeline ID. If a file with the specified name already + // The name to assign to the transcoded file. Elastic Transcoder saves the file + // in the Amazon S3 bucket specified by the OutputBucket object in the pipeline + // that is specified by the pipeline ID. If a file with the specified name already // exists in the output bucket, the job fails. Key *string - // The Id of the preset to use for this job. The preset determines the audio, + // The Id of the preset to use for this job. The preset determines the audio, // video, and thumbnail settings that Elastic Transcoder uses for transcoding. PresetId *string - // The number of degrees clockwise by which you want Elastic Transcoder to rotate + // 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 // transcoding contains rotation metadata. Rotate *string - // (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in - // 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 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. + // (Outputs in Fragmented MP4 or MPEG-TS format only. + // + // If you specify a preset in 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 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 encryption settings, if any, that you want Elastic Transcoder to apply to @@ -430,24 +556,31 @@ type CreateJobOutput struct { 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: + // 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. + // 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 @@ -478,35 +611,51 @@ type CreateJobPlaylist struct { // 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. + // 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 : - // OutputKeyPrefix 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 + // 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 + // 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. + // 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 @@ -555,8 +704,11 @@ 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 - // Amazon Key Management Service. + // base64-encoded: + // + // 128 , 192 , or 256 . + // + // The key must also be encrypted by using the Amazon Key Management Service. Key *string // The MD5 digest of the key that you used to encrypt your input file, or that you @@ -569,22 +721,32 @@ type Encryption struct { // 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. @@ -598,22 +760,30 @@ type Encryption struct { type HlsContentProtection struct { // If Elastic Transcoder is generating your key for you, you must leave this field - // blank. The series of random bits created by a random bit generator, unique for - // every encryption operation, that you want Elastic Transcoder to use to encrypt - // your output files. The initialization vector must be base64-encoded, and it must - // be exactly 16 bytes before being base64-encoded. + // blank. + // + // The series of random bits created by a random bit generator, unique for every + // encryption operation, that you want Elastic Transcoder to use to encrypt your + // output files. The initialization vector must be base64-encoded, and it must be + // exactly 16 bytes before being base64-encoded. InitializationVector *string // 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 . + // 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 . Key *string // If Elastic Transcoder is generating your key for you, you must leave this field - // blank. The MD5 digest of the key that you want Elastic Transcoder to use to - // encrypt your output file, and that you want Elastic Transcoder to use as a - // checksum to make sure your key was not corrupted in transit. The key MD5 must be + // blank. + // + // The MD5 digest of the key that you want Elastic Transcoder to use to encrypt + // your output file, and that you want Elastic Transcoder to use as a checksum to + // make sure your key was not corrupted in transit. The key MD5 must be // base64-encoded, and it must be exactly 16 bytes before being base64- encoded. KeyMd5 *string @@ -628,8 +798,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 + // 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 @@ -645,17 +816,21 @@ type InputCaptions struct { // 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 . + // // MergePolicy cannot be null. MergePolicy *string @@ -685,9 +860,12 @@ type Job struct { // If you specified one output for a job, information about that output. If you // specified multiple outputs for a job, the Output object lists information about // the first output. This duplicates the information that is listed for the first - // output in the Outputs object. Outputs recommended instead. A section of the - // request or response body that provides information about the transcoded (target) - // file. + // output in the Outputs object. + // + // Outputs recommended instead. + // + // A section of the request or response body that provides information about the + // transcoded (target) file. Output *JobOutput // The value, if any, that you want Elastic Transcoder to prepend to the names of @@ -699,25 +877,29 @@ type Job struct { // 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. + // 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. - // The pipeline determines several settings, including the Amazon S3 bucket from - // which Elastic Transcoder gets the files to transcode and the bucket into which - // Elastic Transcoder puts the transcoded files. + // The Id of the pipeline that you want Elastic Transcoder to use for + // transcoding. The pipeline determines several settings, including the Amazon S3 + // bucket from which Elastic Transcoder gets the files to transcode and the bucket + // into which Elastic Transcoder puts the transcoded files. PipelineId *string - // Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in - // PresetId 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. The maximum number of master playlists in a - // job is 30. + // Outputs in Fragmented MP4 or MPEG-TS format only. + // + // If you specify a preset in PresetId 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. + // + // The maximum number of master playlists in a 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. @@ -726,11 +908,16 @@ type Job struct { // 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: + // 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: _.:/=+-%@ UserMetadata map[string]string @@ -746,10 +933,14 @@ type JobAlbumArt struct { // 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. @@ -761,18 +952,24 @@ type JobAlbumArt struct { // Information about the file that you're transcoding. type JobInput struct { - // The aspect ratio of the input file. If you want Elastic Transcoder to + // 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 // 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 - // Transcoder disables automatic detection of the aspect ratio. + // 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 // 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. @@ -786,53 +983,77 @@ type JobInput struct { // 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. + // 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. + // 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 . + // 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 + // 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 - // 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. + // (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 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 // 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 - // disables automatic detection of interlacing. + // 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 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 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 @@ -845,10 +1066,12 @@ type JobInput struct { noSmithyDocumentSerde } -// Outputs recommended instead. If you specified one output for a job, information -// about that output. If you specified multiple outputs for a job, the Output -// object lists information about the first output. This duplicates the information -// that is listed for the first output in the Outputs object. +// Outputs recommended instead. +// +// If you specified one output for a job, information about that output. If you +// specified multiple outputs for a job, the Output object lists information about +// the first output. This duplicates the information that is listed for the first +// output in the Outputs object. type JobOutput struct { // The album art to be associated with the output file, if any. @@ -863,30 +1086,45 @@ type JobOutput 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. + // 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 . + // 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 + // 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 - // 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. + // (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 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. @@ -923,9 +1161,9 @@ type JobOutput struct { // outputs from the current job. In the Output syntax, this value is always 1. Id *string - // The name to assign to the transcoded file. Elastic Transcoder saves the file in - // the Amazon S3 bucket specified by the OutputBucket object in the pipeline that - // is specified by the pipeline ID. + // The name to assign to the transcoded file. Elastic Transcoder saves the file + // in the Amazon S3 bucket specified by the OutputBucket object in the pipeline + // that 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. @@ -937,41 +1175,53 @@ type JobOutput 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 - // transcoding contains rotation metadata. + // 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 - // (Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset in - // 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. + // (Outputs in Fragmented MP4 or MPEG-TS format only. + // + // If you specify a preset in 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 - // 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. + // 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 + // 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 @@ -984,24 +1234,31 @@ type JobOutput struct { 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: + // 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. + // 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 @@ -1011,13 +1268,14 @@ type JobOutput struct { // Information about the watermarks that you want Elastic Transcoder to add to the // video during transcoding. You can specify up to four watermarks for each output. // Settings for each watermark must be defined in the preset that you specify in - // Preset for the current output. Watermarks are added to the output video in the - // sequence in which you list them in the job output—the first watermark in the - // list is added to the output video first, the second watermark in the list is - // added next, and so on. As a result, if the settings in a preset cause Elastic - // Transcoder to place all watermarks in the same location, the second watermark - // that you add covers the first one, the third one covers the second, and the - // fourth one covers the third. + // Preset for the current output. + // + // Watermarks are added to the output video in the sequence in which you list them + // in the job output—the first watermark in the list is added to the output video + // first, the second watermark in the list is added next, and so on. As a result, + // if the settings in a preset cause Elastic Transcoder to place all watermarks in + // the same location, the second watermark that you add covers the first one, the + // third one covers the second, and the fourth one covers the third. Watermarks []JobWatermark // Specifies the width of the output file in pixels. @@ -1034,12 +1292,14 @@ type JobWatermark struct { // your watermarks. Encryption *Encryption - // The name of the .png or .jpg file that you want to use for the watermark. To + // 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 - // 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. + // 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. InputKey *string // The ID of the watermark settings that Elastic Transcoder uses to add watermarks @@ -1052,8 +1312,10 @@ type JobWatermark struct { } // 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. +// 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 @@ -1078,14 +1340,18 @@ type Notifications struct { // The Permission structure. type Permission struct { - // The permission that you want to give to the AWS user that is listed in Grantee. - // Valid values include: + // 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. Access []string @@ -1097,10 +1363,14 @@ 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. + // 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 @@ -1115,39 +1385,54 @@ 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 - // 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 . + // 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 . 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. @@ -1163,19 +1448,27 @@ type Pipeline struct { InputBucket *string // The name of the pipeline. We recommend that the name be unique within the AWS - // account, but uniqueness is not enforced. Constraints: Maximum 40 characters + // account, but uniqueness is not enforced. + // + // Constraints: Maximum 40 characters Name *string // 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. + // 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. Notifications *Notifications @@ -1190,37 +1483,53 @@ 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. 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. + // 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. @@ -1232,16 +1541,21 @@ type Pipeline struct { // The PipelineOutputConfig structure. type PipelineOutputConfig struct { - // The Amazon S3 bucket in which you want Elastic Transcoder to save the + // 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 @@ -1251,16 +1565,19 @@ type PipelineOutputConfig struct { // 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 + // 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 @@ -1268,7 +1585,8 @@ type PipelineOutputConfig struct { noSmithyDocumentSerde } -// Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for +// 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 @@ -1287,28 +1605,42 @@ type Playlist struct { // 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. + // 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 : - // OutputKeyPrefix 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 + // 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 + // 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. @@ -1334,9 +1666,11 @@ type Playlist struct { } // 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. +// 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 @@ -1352,15 +1686,20 @@ 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 - // KMS. + // base64-encoded: + // + // 128 , 192 , or 256 . + // + // The key must also be encrypted by using AWS KMS. Key *string // The ID for your DRM key, so that your DRM license provider knows which key to - // provide. The key ID must be provided in big endian, and Elastic Transcoder - // converts it to little endian before inserting it into the PlayReady DRM headers. - // If you are unsure whether your license server provides your key ID in big or - // little endian, check with your DRM provider. + // provide. + // + // The key ID must be provided in big endian, and Elastic Transcoder converts it + // to little endian before inserting it into the PlayReady DRM headers. If you are + // unsure whether your license server provides your key ID in big or little endian, + // check with your DRM provider. KeyId *string // The MD5 digest of the key used for DRM on your file, and that you want Elastic @@ -1427,82 +1766,104 @@ type Preset struct { // Transcoder to overlay over videos that are transcoded using this preset. You can // specify settings for up to four watermarks. Watermarks appear in the specified // size and location, and with the specified opacity for the duration of the -// transcoded video. Watermarks can be in .png or .jpg format. If you want to -// display a watermark that is not rectangular, use the .png format, which supports -// transparency. When you create a job that uses this preset, you specify the .png -// or .jpg graphics that you want Elastic Transcoder to include in the transcoded -// videos. You can specify fewer graphics in the job than you specify watermark -// settings in the preset, which allows you to use the same preset for up to four -// watermarks that have different dimensions. +// transcoded video. +// +// Watermarks can be in .png or .jpg format. If you want to display a watermark +// that is not rectangular, use the .png format, which supports transparency. +// +// When you create a job that uses this preset, you specify the .png or .jpg +// graphics that you want Elastic Transcoder to include in the transcoded videos. +// You can specify fewer graphics in the job than you specify watermark settings in +// the preset, which allows you to use the same preset for up to four 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. 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. + // 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 + // A unique identifier for the settings for one watermark. The value of Id can be // up to 40 characters long. 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 . 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 . + // 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 // in the location where it appears. Valid values are 0 (the watermark is // 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 . - // The .jpg file format doesn't support transparency. + // 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 . 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, @@ -1511,11 +1872,13 @@ type PresetWatermark struct { // 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 @@ -1525,28 +1888,40 @@ type PresetWatermark struct { // 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. VerticalAlign *string - // VerticalOffset The amount by which you want the vertical position of the - // watermark to be offset from the position specified by VerticalAlign: + // 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 - // Transcoder to include the black bars that are added by Elastic Transcoder, if - // any, in the offset calculation. + // 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 noSmithyDocumentSerde @@ -1558,13 +1933,20 @@ 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 - // 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 - // Transcoder tries to preserve the aspect ratio of the video in the output file. + // 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 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 - // whether you want Elastic Transcoder to create thumbnails when you create a job. + // 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 // The approximate number of seconds between thumbnails. Specify an integer value. @@ -1589,31 +1971,38 @@ 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 - // 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 - // even integers. The values cannot exceed the width and height that you specified - // in the Video:Resolution object. + // 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 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, @@ -1629,9 +2018,10 @@ type TimeSpan struct { // The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: // 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: // 86399.999). If you don't specify a value, Elastic Transcoder creates an output - // file from StartTime to the end of the file. If you specify a value longer than - // the duration of the input file, Elastic Transcoder transcodes the file and - // returns a warning message. + // file from StartTime to the end of the file. + // + // If you specify a value longer than the duration of the input file, Elastic + // Transcoder transcodes the file and returns a warning message. Duration *string // The place in the input file where you want a clip to start. The format can be @@ -1664,32 +2054,50 @@ 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 - // 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 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 - // and bottom) to maintain the aspect ratio of the active region of the video. + // 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 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 and bottom) to maintain the aspect + // ratio of the active region of the video. 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 // 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 - // 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) + // 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 BitRate *string @@ -1698,144 +2106,237 @@ type VideoParameters struct { // , 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: + // 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.) + // + // 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 + // + // 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 + // 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. + // 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. 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: + // 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 . + // // 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 - // 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 . + // 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 . KeyframesMaxDist *string // If you specify auto for FrameRate , Elastic Transcoder uses the frame rate of @@ -1850,7 +2351,7 @@ type VideoParameters struct { // 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 @@ -1864,56 +2365,84 @@ 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 - // 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: + // 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 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, @@ -1924,29 +2453,36 @@ type VideoParameters struct { // Transcoder to overlay over videos that are transcoded using this preset. You can // specify settings for up to four watermarks. Watermarks appear in the specified // size and location, and with the specified opacity for the duration of the - // transcoded video. Watermarks can be in .png or .jpg format. If you want to - // display a watermark that is not rectangular, use the .png format, which supports - // transparency. When you create a job that uses this preset, you specify the .png - // or .jpg graphics that you want Elastic Transcoder to include in the transcoded - // videos. You can specify fewer graphics in the job than you specify watermark - // settings in the preset, which allows you to use the same preset for up to four - // watermarks that have different dimensions. + // transcoded video. + // + // Watermarks can be in .png or .jpg format. If you want to display a watermark + // that is not rectangular, use the .png format, which supports transparency. + // + // When you create a job that uses this preset, you specify the .png or .jpg + // graphics that you want Elastic Transcoder to include in the transcoded videos. + // You can specify fewer graphics in the job than you specify watermark settings in + // the preset, which allows you to use the same preset for up to four watermarks + // that have different dimensions. Watermarks []PresetWatermark noSmithyDocumentSerde } // Elastic Transcoder returns a warning if the resources used by your pipeline are -// not in the same region as the pipeline. Using resources in the same region, such -// as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, -// reduces processing time and prevents cross-regional charges. +// not in the same region as the pipeline. +// +// Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS +// notification topics, and AWS KMS key, reduces processing time and prevents +// cross-regional charges. type Warning struct { // The code of the cross-regional warning. Code *string // The message explaining what resources are in a different region from the - // pipeline. AWS KMS keys must be in the same region as the pipeline. + // pipeline. + // + // AWS KMS keys must be in the same region as the pipeline. Message *string noSmithyDocumentSerde diff --git a/service/emr/api_op_AddInstanceFleet.go b/service/emr/api_op_AddInstanceFleet.go index 5a80007c401..e5b4483d182 100644 --- a/service/emr/api_op_AddInstanceFleet.go +++ b/service/emr/api_op_AddInstanceFleet.go @@ -11,8 +11,10 @@ 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 releases 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 releases 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 c93a56b7503..8312f060675 100644 --- a/service/emr/api_op_AddJobFlowSteps.go +++ b/service/emr/api_op_AddJobFlowSteps.go @@ -12,21 +12,28 @@ import ( ) // AddJobFlowSteps adds new steps to a running cluster. 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 SSH to -// connect to the master node and submitting queries directly to the software -// running on the master node, such as Hive and Hadoop. A step specifies the -// location of a JAR file stored either on the master node of the cluster or in -// Amazon S3. Each step is performed by the main function of the main class of the -// JAR file. The main class can be specified either in the manifest of the JAR or -// by using the MainFunction parameter of the step. Amazon EMR executes each step -// in the order listed. For a step to be considered complete, the main function -// must exit with a zero exit code and all Hadoop jobs started while the step was -// running must have completed and run successfully. You can only add steps to a -// cluster that is in one of the following states: STARTING, BOOTSTRAPPING, -// RUNNING, or WAITING. The string values passed into HadoopJarStep object cannot -// exceed a total of 10240 characters. +// 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 SSH to connect to the +// master node and submitting queries directly to the software running on the +// master node, such as Hive and Hadoop. +// +// A step specifies the location of a JAR file stored either on the master node of +// the cluster or in Amazon S3. Each step is performed by the main function of the +// main class of the JAR file. The main class can be specified either in the +// manifest of the JAR or by using the MainFunction parameter of the step. +// +// Amazon EMR executes each step in the order listed. For a step to be considered +// complete, the main function must exit with a zero exit code and all Hadoop jobs +// started while the step was running must have completed and run successfully. +// +// You can only add steps to a cluster that is in one of the following states: +// STARTING, BOOTSTRAPPING, RUNNING, or WAITING. +// +// The string values passed into HadoopJarStep object cannot exceed a total of +// 10240 characters. func (c *Client) AddJobFlowSteps(ctx context.Context, params *AddJobFlowStepsInput, optFns ...func(*Options)) (*AddJobFlowStepsOutput, error) { if params == nil { params = &AddJobFlowStepsInput{} @@ -45,13 +52,13 @@ func (c *Client) AddJobFlowSteps(ctx context.Context, params *AddJobFlowStepsInp // The input argument to the AddJobFlowSteps operation. type AddJobFlowStepsInput struct { - // A string that uniquely identifies the job flow. This identifier is returned by - // RunJobFlow and can also be obtained from ListClusters . + // A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow + // and can also be obtained from ListClusters. // // This member is required. JobFlowId *string - // A list of StepConfig to be executed by the job flow. + // A list of StepConfig to be executed by the job flow. // // This member is required. Steps []types.StepConfig @@ -59,8 +66,10 @@ 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:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN. + // arn:partition:service:region:account:resource . + // + // For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted + // runtime role ARN. ExecutionRoleArn *string noSmithyDocumentSerde diff --git a/service/emr/api_op_AddTags.go b/service/emr/api_op_AddTags.go index 664e06361c3..cd66265e50d 100644 --- a/service/emr/api_op_AddTags.go +++ b/service/emr/api_op_AddTags.go @@ -14,8 +14,9 @@ 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]. +// +// [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 4da951f16d9..4e22a0e3ff3 100644 --- a/service/emr/api_op_CancelSteps.go +++ b/service/emr/api_op_CancelSteps.go @@ -36,14 +36,14 @@ func (c *Client) CancelSteps(ctx context.Context, params *CancelStepsInput, optF // The input argument to the CancelSteps operation. type CancelStepsInput struct { - // The ClusterID for the specified steps that will be canceled. Use RunJobFlow and - // ListClusters to get ClusterIDs. + // The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get + // ClusterIDs. // // This member is required. ClusterId *string - // The list of StepIDs to cancel. Use ListSteps to get steps and their states for - // the specified cluster. + // The list of StepIDs to cancel. Use ListSteps to get steps and their states for the + // specified cluster. // // This member is required. StepIds []string @@ -58,8 +58,8 @@ type CancelStepsInput struct { // The output for the CancelSteps operation. type CancelStepsOutput struct { - // A list of CancelStepsInfo , which shows the status of specified cancel requests - // for each StepID specified. + // A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID + // specified. CancelStepsInfoList []types.CancelStepsInfo // Metadata pertaining to the operation's result. diff --git a/service/emr/api_op_CreateSecurityConfiguration.go b/service/emr/api_op_CreateSecurityConfiguration.go index 4c7405932d7..ad8db6b5d12 100644 --- a/service/emr/api_op_CreateSecurityConfiguration.go +++ b/service/emr/api_op_CreateSecurityConfiguration.go @@ -36,8 +36,9 @@ 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) - // in the Amazon EMR Management Guide. + // examples, see [Use Security Configurations to Set Up Cluster Security]in the Amazon EMR Management Guide. + // + // [Use Security Configurations to Set Up Cluster Security]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-security-configurations.html // // This member is required. SecurityConfiguration *string diff --git a/service/emr/api_op_CreateStudio.go b/service/emr/api_op_CreateStudio.go index fbac45b273f..23d3d1fcd66 100644 --- a/service/emr/api_op_CreateStudio.go +++ b/service/emr/api_op_CreateStudio.go @@ -87,10 +87,10 @@ type CreateStudioInput struct { // notebook files when backed up to Amazon S3. EncryptionKeyArn *string - // The ARN of the IAM Identity Center instance to create the Studio application. + // The ARN of the IAM Identity Center instance to create the Studio application. IdcInstanceArn *string - // Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL . + // Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL . // If the value is set to REQUIRED , users must be explicitly assigned to the // Studio application to access the Studio. IdcUserAssignment types.IdcUserAssignment @@ -112,7 +112,7 @@ type CreateStudioInput struct { // characters, and an optional value string with a maximum of 256 characters. Tags []types.Tag - // A Boolean indicating whether to enable Trusted identity propagation for the + // A Boolean indicating whether to enable Trusted identity propagation for the // Studio. The default value is false . TrustedIdentityPropagationEnabled *bool diff --git a/service/emr/api_op_CreateStudioSessionMapping.go b/service/emr/api_op_CreateStudioSessionMapping.go index 28a95cb35c8..4ca901b0c92 100644 --- a/service/emr/api_op_CreateStudioSessionMapping.go +++ b/service/emr/api_op_CreateStudioSessionMapping.go @@ -15,9 +15,9 @@ import ( // 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) -// . +// Studio when you use IAM authentication, see [Assign a user or group to your EMR Studio]. +// +// [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,9 +43,9 @@ 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 Amazon EMR Studio User Role with Session Policies (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html) - // . + // want to apply, not the ARN of your user role. For more information, see [Create an Amazon EMR Studio User Role with Session Policies]. + // + // [Create an Amazon 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 @@ -56,16 +56,20 @@ type CreateStudioSessionMappingInput struct { 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or - // IdentityId must be specified, but not both. + // Identity Center Identity Store. For more information, see [UserId]and [GroupId] in the IAM + // Identity Center Identity Store API Reference. Either IdentityName or IdentityId + // must be specified, but not both. + // + // [UserId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId + // [GroupId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or - // IdentityId must be specified, but not both. + // The name of the user or group. For more information, see [UserName] and [DisplayName] in the IAM + // Identity Center Identity Store API Reference. Either IdentityName or IdentityId + // must be specified, but not both. + // + // [UserName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName + // [DisplayName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName IdentityName *string noSmithyDocumentSerde diff --git a/service/emr/api_op_DeleteStudioSessionMapping.go b/service/emr/api_op_DeleteStudioSessionMapping.go index ac91e3d4b5f..a48a9529413 100644 --- a/service/emr/api_op_DeleteStudioSessionMapping.go +++ b/service/emr/api_op_DeleteStudioSessionMapping.go @@ -41,17 +41,20 @@ 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or - // IdentityId must be specified. + // Amazon EMR Studio. For more information, see [UserId]and [GroupId] in the IAM Identity Center + // Identity Store API Reference. Either IdentityName or IdentityId must be + // specified. + // + // [UserId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId + // [GroupId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId 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) - // in the IAM Identity Center Store API Reference. Either IdentityName or - // IdentityId must be specified. + // more information, see [UserName]and [DisplayName] in the IAM Identity Center Store API Reference. + // Either IdentityName or IdentityId must be specified. + // + // [UserName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName + // [DisplayName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName IdentityName *string noSmithyDocumentSerde diff --git a/service/emr/api_op_DescribeCluster.go b/service/emr/api_op_DescribeCluster.go index 645e0f9d6a1..6d9023d28c9 100644 --- a/service/emr/api_op_DescribeCluster.go +++ b/service/emr/api_op_DescribeCluster.go @@ -174,12 +174,13 @@ type ClusterRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) } @@ -414,12 +415,13 @@ type ClusterTerminatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) } diff --git a/service/emr/api_op_DescribeJobFlows.go b/service/emr/api_op_DescribeJobFlows.go index 24a6817b04c..7d7121ddb06 100644 --- a/service/emr/api_op_DescribeJobFlows.go +++ b/service/emr/api_op_DescribeJobFlows.go @@ -13,14 +13,20 @@ import ( ) // 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. +// 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: +// 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 // diff --git a/service/emr/api_op_DescribeReleaseLabel.go b/service/emr/api_op_DescribeReleaseLabel.go index 47a4919051c..c020ca16dc7 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]. For example, [2.0.20220218.1]. + // + // [2.0.20220218.1]: https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html + // [Amazon Linux 2 Release Notes]: https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-al2.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 50583d5d1dd..d5216342ff0 100644 --- a/service/emr/api_op_DescribeStep.go +++ b/service/emr/api_op_DescribeStep.go @@ -177,12 +177,13 @@ type StepCompleteWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStepInput, *DescribeStepOutput, error) (bool, error) } diff --git a/service/emr/api_op_GetAutoTerminationPolicy.go b/service/emr/api_op_GetAutoTerminationPolicy.go index b85c29fb0ee..75d5d39463d 100644 --- a/service/emr/api_op_GetAutoTerminationPolicy.go +++ b/service/emr/api_op_GetAutoTerminationPolicy.go @@ -40,7 +40,8 @@ type GetAutoTerminationPolicyInput struct { type GetAutoTerminationPolicyOutput struct { - // Specifies the auto-termination policy that is attached to an Amazon EMR cluster. + // Specifies the auto-termination policy that is attached to an Amazon EMR + // cluster. AutoTerminationPolicy *types.AutoTerminationPolicy // Metadata pertaining to the operation's result. diff --git a/service/emr/api_op_GetBlockPublicAccessConfiguration.go b/service/emr/api_op_GetBlockPublicAccessConfiguration.go index 6454464ff44..8366f3e597d 100644 --- a/service/emr/api_op_GetBlockPublicAccessConfiguration.go +++ b/service/emr/api_op_GetBlockPublicAccessConfiguration.go @@ -12,9 +12,10 @@ 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) -// in the Amazon EMR Management Guide. +// Services account in the current Region. For more information see [Configure Block Public Access for Amazon EMR]in the Amazon +// EMR Management Guide. +// +// [Configure Block Public Access for Amazon EMR]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html func (c *Client) GetBlockPublicAccessConfiguration(ctx context.Context, params *GetBlockPublicAccessConfigurationInput, optFns ...func(*Options)) (*GetBlockPublicAccessConfigurationOutput, error) { if params == nil { params = &GetBlockPublicAccessConfigurationInput{} @@ -44,11 +45,13 @@ type GetBlockPublicAccessConfigurationOutput struct { // specified as an exception using PermittedPublicSecurityGroupRuleRanges in the // 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 - // by default in that Region. To use this feature, you must manually enable and - // configure it. For accounts that did not create an Amazon EMR cluster in a Region - // before this date, block public access is enabled by default in that Region. + // public access configuration to remove the exception. + // + // For accounts that created clusters in a Region before November 25, 2019, block + // public access is disabled by default in that Region. To use this feature, you + // must manually enable and configure it. For accounts that did not create an + // Amazon EMR cluster in a Region before this date, block public access is enabled + // by default in that Region. // // This member is required. BlockPublicAccessConfiguration *types.BlockPublicAccessConfiguration diff --git a/service/emr/api_op_GetStudioSessionMapping.go b/service/emr/api_op_GetStudioSessionMapping.go index c1289ea3947..cafbca42985 100644 --- a/service/emr/api_op_GetStudioSessionMapping.go +++ b/service/emr/api_op_GetStudioSessionMapping.go @@ -41,16 +41,19 @@ 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or - // IdentityId must be specified. + // information, see [UserId]and [GroupId] in the IAM Identity Center Identity Store API Reference. + // Either IdentityName or IdentityId must be specified. + // + // [UserId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId + // [GroupId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or + // The name of the user or group to fetch. For more information, see [UserName] and [DisplayName] in the + // IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. + // + // [UserName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName + // [DisplayName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName IdentityName *string noSmithyDocumentSerde diff --git a/service/emr/api_op_ListInstanceFleets.go b/service/emr/api_op_ListInstanceFleets.go index 5a7ddde3d0a..316b438df90 100644 --- a/service/emr/api_op_ListInstanceFleets.go +++ b/service/emr/api_op_ListInstanceFleets.go @@ -11,9 +11,10 @@ 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 releases 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 releases 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 5a3dcbf3e0b..a88807977ff 100644 --- a/service/emr/api_op_ListNotebookExecutions.go +++ b/service/emr/api_op_ListNotebookExecutions.go @@ -48,19 +48,29 @@ 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. Status types.NotebookExecutionStatus diff --git a/service/emr/api_op_ListSupportedInstanceTypes.go b/service/emr/api_op_ListSupportedInstanceTypes.go index 90287c18bf4..3038bba73f9 100644 --- a/service/emr/api_op_ListSupportedInstanceTypes.go +++ b/service/emr/api_op_ListSupportedInstanceTypes.go @@ -30,13 +30,13 @@ func (c *Client) ListSupportedInstanceTypes(ctx context.Context, params *ListSup type ListSupportedInstanceTypesInput struct { - // The Amazon EMR release label determines the versions of open-source application - // packages (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-app-versions-6.x.html) - // that Amazon EMR has installed on the cluster. Release labels are in the format - // emr-x.x.x , where x.x.x is an Amazon EMR release number such as emr-6.10.0 . For - // more information about Amazon EMR releases and their included application - // versions and features, see the Amazon EMR Release Guide (https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-components.html) - // . + // The Amazon EMR release label determines the [versions of open-source application packages] that Amazon EMR has installed on + // the cluster. Release labels are in the format emr-x.x.x , where x.x.x is an + // Amazon EMR release number such as emr-6.10.0 . For more information about Amazon + // EMR releases and their included application versions and features, see the [Amazon EMR Release Guide]. + // + // [Amazon EMR Release Guide]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-components.html + // [versions of open-source application packages]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-app-versions-6.x.html // // This member is required. ReleaseLabel *string diff --git a/service/emr/api_op_ModifyCluster.go b/service/emr/api_op_ModifyCluster.go index 2a3ef0ede76..31be6257e70 100644 --- a/service/emr/api_op_ModifyCluster.go +++ b/service/emr/api_op_ModifyCluster.go @@ -37,7 +37,7 @@ type ModifyClusterInput struct { // 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 . + // may not behave as expected. For more information see Step$ActionOnFailure. StepConcurrencyLevel *int32 noSmithyDocumentSerde diff --git a/service/emr/api_op_ModifyInstanceFleet.go b/service/emr/api_op_ModifyInstanceFleet.go index 7cc3315385c..7b8b709d9cb 100644 --- a/service/emr/api_op_ModifyInstanceFleet.go +++ b/service/emr/api_op_ModifyInstanceFleet.go @@ -13,9 +13,10 @@ import ( // Modifies the target On-Demand and target Spot capacities for the instance fleet // with the specified InstanceFleetID within the cluster specified using ClusterID. -// The call either succeeds or fails atomically. The instance fleet configuration -// is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x -// versions. +// The call either succeeds or fails atomically. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. func (c *Client) ModifyInstanceFleet(ctx context.Context, params *ModifyInstanceFleetInput, optFns ...func(*Options)) (*ModifyInstanceFleetOutput, error) { if params == nil { params = &ModifyInstanceFleetInput{} diff --git a/service/emr/api_op_PutAutoTerminationPolicy.go b/service/emr/api_op_PutAutoTerminationPolicy.go index e905b481039..0497c9efd73 100644 --- a/service/emr/api_op_PutAutoTerminationPolicy.go +++ b/service/emr/api_op_PutAutoTerminationPolicy.go @@ -12,12 +12,15 @@ import ( ) // Auto-termination is supported in Amazon EMR releases 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 +// later. For more information, see [Using an auto-termination policy]. +// +// 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]. +// +// [Using an auto-termination policy]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-auto-termination-policy.html +// [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 e16d759375c..82a7f1e8690 100644 --- a/service/emr/api_op_PutBlockPublicAccessConfiguration.go +++ b/service/emr/api_op_PutBlockPublicAccessConfiguration.go @@ -12,9 +12,10 @@ 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) -// in the Amazon EMR Management Guide. +// Amazon Web Services account in the current Region. For more information see [Configure Block Public Access for Amazon EMR]in +// the Amazon EMR Management Guide. +// +// [Configure Block Public Access for Amazon EMR]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html func (c *Client) PutBlockPublicAccessConfiguration(ctx context.Context, params *PutBlockPublicAccessConfigurationInput, optFns ...func(*Options)) (*PutBlockPublicAccessConfigurationOutput, error) { if params == nil { params = &PutBlockPublicAccessConfigurationInput{} @@ -40,11 +41,13 @@ type PutBlockPublicAccessConfigurationInput struct { // specified as an exception using PermittedPublicSecurityGroupRuleRanges in the // 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 - // by default in that Region. To use this feature, you must manually enable and - // configure it. For accounts that did not create an Amazon EMR cluster in a Region - // before this date, block public access is enabled by default in that Region. + // BlockPublicSecurityGroupRules to remove the exception. + // + // For accounts that created clusters in a Region before November 25, 2019, block + // public access is disabled by default in that Region. To use this feature, you + // must manually enable and configure it. For accounts that did not create an + // Amazon EMR cluster in a Region before this date, block public access is enabled + // by default in that Region. // // This member is required. BlockPublicAccessConfiguration *types.BlockPublicAccessConfiguration diff --git a/service/emr/api_op_RemoveManagedScalingPolicy.go b/service/emr/api_op_RemoveManagedScalingPolicy.go index a0dd194d6d4..62aaa8f3937 100644 --- a/service/emr/api_op_RemoveManagedScalingPolicy.go +++ b/service/emr/api_op_RemoveManagedScalingPolicy.go @@ -28,7 +28,7 @@ func (c *Client) RemoveManagedScalingPolicy(ctx context.Context, params *RemoveM type RemoveManagedScalingPolicyInput struct { - // Specifies the ID of the cluster from which the managed scaling policy will be + // Specifies the ID of the cluster from which the managed scaling policy will be // removed. // // This member is required. diff --git a/service/emr/api_op_RemoveTags.go b/service/emr/api_op_RemoveTags.go index c8cf4e1a406..86c5b9834f7 100644 --- a/service/emr/api_op_RemoveTags.go +++ b/service/emr/api_op_RemoveTags.go @@ -13,8 +13,11 @@ 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]. +// +// The following example removes the stack tag with value Prod from a cluster: +// +// [Tag Clusters]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html func (c *Client) RemoveTags(ctx context.Context, params *RemoveTagsInput, optFns ...func(*Options)) (*RemoveTagsOutput, error) { if params == nil { params = &RemoveTagsInput{} diff --git a/service/emr/api_op_RunJobFlow.go b/service/emr/api_op_RunJobFlow.go index 7934e59fcbc..1d9d1b032df 100644 --- a/service/emr/api_op_RunJobFlow.go +++ b/service/emr/api_op_RunJobFlow.go @@ -14,22 +14,28 @@ import ( // 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 releases 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow -// request can contain InstanceFleets parameters or InstanceGroups parameters, but -// not both. +// 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 releases +// 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{} @@ -68,8 +74,9 @@ type RunJobFlowInput struct { // 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]. + // + // [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 @@ -80,9 +87,9 @@ type RunJobFlowInput struct { // 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) - // . + // automatically terminates. For alternative cluster termination options, see [Control cluster termination]. + // + // [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,14 +102,17 @@ type RunJobFlowInput struct { // Available only in Amazon EMR releases 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 Amazon 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 releases 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) - // . + // Amazon EMR, see [Using a Custom AMI]in the Amazon EMR Management Guide. If omitted, the cluster + // uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR releases + // 2.x and 3.x, use AmiVersion instead. + // + // For information about creating a custom AMI, see [Creating an Amazon EBS-Backed Linux AMI] in the Amazon Elastic Compute + // Cloud User Guide for Linux Instances. For information about finding an AMI ID, + // see [Finding a Linux AMI]. + // + // [Creating an Amazon EBS-Backed Linux AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html + // [Finding a Linux AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html + // [Using a Custom AMI]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-custom-ami.html CustomAmiId *string // The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used @@ -126,9 +136,10 @@ type RunJobFlowInput struct { 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. + // using a security configuration. For more information see [Use Kerberos Authentication]in the Amazon EMR + // Management Guide. + // + // [Use Kerberos Authentication]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html KerberosAttributes *types.KerberosAttributes // The KMS key used for encrypting log files. If a value is not provided, the logs @@ -140,26 +151,36 @@ type RunJobFlowInput struct { // not provided, logs are not created. LogUri *string - // The specified managed scaling policy for an Amazon EMR cluster. + // The specified managed scaling policy for an Amazon EMR cluster. ManagedScalingPolicy *types.ManagedScalingPolicy // 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 with - // the job flow that accepts a user argument list. Amazon 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: + // Applications. + // + // A list of strings that indicates third-party software to use with the job flow + // that accepts a user argument list. Amazon 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]. 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. + // + // - "ganglia" - launch the cluster with the Ganglia Monitoring System installed. + // + // [Amazon EMR Developer Guide]: https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf NewSupportedProducts []types.SupportedProductConfig // Specifies a particular Amazon Linux release for all nodes in a cluster launch @@ -174,9 +195,10 @@ type RunJobFlowInput struct { // 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 . + // versions and features, see [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 . + // + // [https://docs.aws.amazon.com/emr/latest/ReleaseGuide/]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ ReleaseLabel *string // Applies only when CustomAmiID is used. Specifies which updates from the Amazon @@ -217,11 +239,16 @@ type RunJobFlowInput struct { Steps []types.StepConfig // 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: + // Applications. + // + // A list of strings that indicates third-party software to use. For more + // information, see the [Amazon EMR Developer Guide]. Currently supported values are: + // // - "mapr-m3" - launch the job flow using MapR M3 Edition. + // // - "mapr-m5" - launch the job flow using MapR M5 Edition. + // + // [Amazon EMR Developer Guide]: https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf SupportedProducts []string // A list of tags to associate with a cluster and propagate to Amazon EC2 @@ -229,17 +256,20 @@ type RunJobFlowInput struct { 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 - // cluster can perform Amazon EMR actions on the cluster that their IAM policies - // allow. This value defaults to true for clusters created using the Amazon 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 - // the Amazon Web Services account root user can perform Amazon EMR actions for the + // 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 Amazon EMR actions on the + // cluster that their IAM policies allow. This value defaults to true for clusters + // created using the Amazon EMR API or the CLI [create-cluster]command. + // + // When set to false , only the IAM principal that created the cluster and the + // Amazon Web Services account root user can perform Amazon EMR actions for the // cluster, regardless of the IAM permissions policies attached to other IAM - // principals. For more information, see Understanding the Amazon 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 EMR Management Guide. + // principals. For more information, see [Understanding the Amazon EMR cluster VisibleToAllUsers setting]in the Amazon EMR Management Guide. + // + // [Understanding the Amazon EMR cluster VisibleToAllUsers setting]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_IAM_emr-with-IAM.html#security_set_visible_to_all_users + // [create-cluster]: https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html VisibleToAllUsers *bool noSmithyDocumentSerde diff --git a/service/emr/api_op_SetKeepJobFlowAliveWhenNoSteps.go b/service/emr/api_op_SetKeepJobFlowAliveWhenNoSteps.go index a2a2d406f23..3f2433e8e0b 100644 --- a/service/emr/api_op_SetKeepJobFlowAliveWhenNoSteps.go +++ b/service/emr/api_op_SetKeepJobFlowAliveWhenNoSteps.go @@ -15,9 +15,11 @@ import ( // If you want a transient cluster that shuts down after the last of the current // executing steps are completed, you can configure SetKeepJobFlowAliveWhenNoSteps // to false. If you want a long running cluster, configure -// SetKeepJobFlowAliveWhenNoSteps to true. For more information, see Managing -// Cluster Termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html) -// in the Amazon EMR Management Guide. +// SetKeepJobFlowAliveWhenNoSteps to true. +// +// For more information, see [Managing Cluster Termination] in the Amazon EMR Management Guide. +// +// [Managing Cluster Termination]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html func (c *Client) SetKeepJobFlowAliveWhenNoSteps(ctx context.Context, params *SetKeepJobFlowAliveWhenNoStepsInput, optFns ...func(*Options)) (*SetKeepJobFlowAliveWhenNoStepsOutput, error) { if params == nil { params = &SetKeepJobFlowAliveWhenNoStepsInput{} @@ -36,9 +38,10 @@ func (c *Client) SetKeepJobFlowAliveWhenNoSteps(ctx context.Context, params *Set type SetKeepJobFlowAliveWhenNoStepsInput struct { // A list of strings that uniquely identify the clusters to protect. This - // identifier is returned by RunJobFlow (https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html) - // and can also be obtained from DescribeJobFlows (https://docs.aws.amazon.com/emr/latest/APIReference/API_DescribeJobFlows.html) - // . + // identifier is returned by [RunJobFlow]and can also be obtained from [DescribeJobFlows]. + // + // [DescribeJobFlows]: https://docs.aws.amazon.com/emr/latest/APIReference/API_DescribeJobFlows.html + // [RunJobFlow]: https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html // // This member is required. JobFlowIds []string diff --git a/service/emr/api_op_SetTerminationProtection.go b/service/emr/api_op_SetTerminationProtection.go index 5a52288ce1f..7fa29ad44e8 100644 --- a/service/emr/api_op_SetTerminationProtection.go +++ b/service/emr/api_op_SetTerminationProtection.go @@ -15,14 +15,19 @@ import ( // event 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 Amazon 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 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, see Managing Cluster Termination (https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html) -// in the Amazon EMR Management Guide. +// 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 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, see [Managing Cluster Termination] in the Amazon EMR Management Guide. +// +// [Managing Cluster Termination]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/UsingEMR_TerminationProtection.html func (c *Client) SetTerminationProtection(ctx context.Context, params *SetTerminationProtectionInput, optFns ...func(*Options)) (*SetTerminationProtectionOutput, error) { if params == nil { params = &SetTerminationProtectionInput{} @@ -41,9 +46,8 @@ func (c *Client) SetTerminationProtection(ctx context.Context, params *SetTermin // The input argument to the TerminationProtection operation. type SetTerminationProtectionInput struct { - // A list of strings that uniquely identify the clusters to protect. This - // identifier is returned by RunJobFlow and can also be obtained from - // DescribeJobFlows . + // A list of strings that uniquely identify the clusters to protect. This + // identifier is returned by RunJobFlowand can also be obtained from DescribeJobFlows . // // This member is required. JobFlowIds []string diff --git a/service/emr/api_op_SetUnhealthyNodeReplacement.go b/service/emr/api_op_SetUnhealthyNodeReplacement.go index bcc88d52399..58889ab6940 100644 --- a/service/emr/api_op_SetUnhealthyNodeReplacement.go +++ b/service/emr/api_op_SetUnhealthyNodeReplacement.go @@ -17,11 +17,15 @@ import ( // terminates the unhealthy core nodes. To use unhealthy node replacement and // retain unhealthy core nodes, use to turn on termination protection. In such // cases, Amazon EMR adds the unhealthy nodes to a denylist, reducing job -// interruptions and failures. If unhealthy node replacement is on, Amazon EMR -// notifies YARN and other applications on the cluster to stop scheduling tasks -// with these nodes, moves the data, and then terminates the nodes. For more -// information, see graceful node replacement (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-node-replacement.html) -// in the Amazon EMR Management Guide. +// interruptions and failures. +// +// If unhealthy node replacement is on, Amazon EMR notifies YARN and other +// applications on the cluster to stop scheduling tasks with these nodes, moves the +// data, and then terminates the nodes. +// +// For more information, see [graceful node replacement] in the Amazon EMR Management Guide. +// +// [graceful node replacement]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-node-replacement.html func (c *Client) SetUnhealthyNodeReplacement(ctx context.Context, params *SetUnhealthyNodeReplacementInput, optFns ...func(*Options)) (*SetUnhealthyNodeReplacementOutput, error) { if params == nil { params = &SetUnhealthyNodeReplacementInput{} @@ -40,8 +44,8 @@ func (c *Client) SetUnhealthyNodeReplacement(ctx context.Context, params *SetUnh type SetUnhealthyNodeReplacementInput struct { // The list of strings that uniquely identify the clusters for which to turn on - // unhealthy node replacement. You can get these identifiers by running the - // RunJobFlow or the DescribeJobFlows operations. + // unhealthy node replacement. You can get these identifiers by running the RunJobFlowor the DescribeJobFlows + // operations. // // This member is required. JobFlowIds []string diff --git a/service/emr/api_op_SetVisibleToAllUsers.go b/service/emr/api_op_SetVisibleToAllUsers.go index 0417d41e488..0b6b436be61 100644 --- a/service/emr/api_op_SetVisibleToAllUsers.go +++ b/service/emr/api_op_SetVisibleToAllUsers.go @@ -12,17 +12,22 @@ 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 Amazon EMR (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-IAM.html) -// . Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true -// , IAM principals in the Amazon Web Services account can perform Amazon EMR -// cluster actions 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 Amazon 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 Amazon 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 EMR Management Guide. +// policy, see [Identity and Access Management for Amazon EMR]. +// +// Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true , IAM principals in the +// Amazon Web Services account can perform Amazon EMR cluster actions 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 Amazon 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 Amazon EMR Cluster VisibleToAllUsers Setting] in the Amazon EMR Management Guide. +// +// [Understanding the Amazon EMR Cluster VisibleToAllUsers Setting]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_IAM_emr-with-IAM.html#security_set_visible_to_all_users +// [Identity and Access Management for Amazon EMR]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-IAM.html func (c *Client) SetVisibleToAllUsers(ctx context.Context, params *SetVisibleToAllUsersInput, optFns ...func(*Options)) (*SetVisibleToAllUsersOutput, error) { if params == nil { params = &SetVisibleToAllUsersInput{} diff --git a/service/emr/api_op_TerminateJobFlows.go b/service/emr/api_op_TerminateJobFlows.go index 26b9ebc36ff..26133b6601e 100644 --- a/service/emr/api_op_TerminateJobFlows.go +++ b/service/emr/api_op_TerminateJobFlows.go @@ -14,6 +14,7 @@ import ( // shut down, any step not yet completed is canceled and the Amazon 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 diff --git a/service/emr/api_op_UpdateStudioSessionMapping.go b/service/emr/api_op_UpdateStudioSessionMapping.go index 6b21cd6aa53..7f0a29f01a3 100644 --- a/service/emr/api_op_UpdateStudioSessionMapping.go +++ b/service/emr/api_op_UpdateStudioSessionMapping.go @@ -47,16 +47,19 @@ 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or - // IdentityId must be specified. + // information, see [UserId]and [GroupId] in the IAM Identity Center Identity Store API Reference. + // Either IdentityName or IdentityId must be specified. + // + // [UserId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId + // [GroupId]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId 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) - // in the IAM Identity Center Identity Store API Reference. Either IdentityName or + // The name of the user or group to update. For more information, see [UserName] and [DisplayName] in the + // IAM Identity Center Identity Store API Reference. Either IdentityName or // IdentityId must be specified. + // + // [UserName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName + // [DisplayName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName IdentityName *string noSmithyDocumentSerde diff --git a/service/emr/options.go b/service/emr/options.go index 1eec3a958dc..664e8f1fbc5 100644 --- a/service/emr/options.go +++ b/service/emr/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/emr/types/enums.go b/service/emr/types/enums.go index 25299f8c76f..2dfe2328260 100644 --- a/service/emr/types/enums.go +++ b/service/emr/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for ActionOnFailure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionOnFailure) Values() []ActionOnFailure { return []ActionOnFailure{ "TERMINATE_JOB_FLOW", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for AdjustmentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdjustmentType) Values() []AdjustmentType { return []AdjustmentType{ "CHANGE_IN_CAPACITY", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for AuthMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthMode) Values() []AuthMode { return []AuthMode{ "SSO", @@ -75,8 +78,9 @@ const ( ) // Values returns all known values for AutoScalingPolicyState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingPolicyState) Values() []AutoScalingPolicyState { return []AutoScalingPolicyState{ "PENDING", @@ -99,8 +103,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingPolicyStateChangeReasonCode) Values() []AutoScalingPolicyStateChangeReasonCode { return []AutoScalingPolicyStateChangeReasonCode{ "USER_REQUEST", @@ -119,6 +124,7 @@ const ( // 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{ @@ -141,8 +147,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -171,8 +178,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterStateChangeReasonCode) Values() []ClusterStateChangeReasonCode { return []ClusterStateChangeReasonCode{ "INTERNAL_ERROR", @@ -197,8 +205,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GREATER_THAN_OR_EQUAL", @@ -218,8 +227,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "InstanceFleetUnits", @@ -236,8 +246,9 @@ const ( ) // Values returns all known values for ExecutionEngineType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionEngineType) Values() []ExecutionEngineType { return []ExecutionEngineType{ "EMR", @@ -253,8 +264,9 @@ const ( ) // Values returns all known values for IdcUserAssignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdcUserAssignment) Values() []IdcUserAssignment { return []IdcUserAssignment{ "REQUIRED", @@ -271,8 +283,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -289,8 +302,9 @@ const ( ) // Values returns all known values for InstanceCollectionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceCollectionType) Values() []InstanceCollectionType { return []InstanceCollectionType{ "INSTANCE_FLEET", @@ -312,8 +326,9 @@ const ( ) // Values returns all known values for InstanceFleetState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceFleetState) Values() []InstanceFleetState { return []InstanceFleetState{ "PROVISIONING", @@ -338,8 +353,9 @@ const ( // Values returns all known values for InstanceFleetStateChangeReasonCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceFleetStateChangeReasonCode) Values() []InstanceFleetStateChangeReasonCode { return []InstanceFleetStateChangeReasonCode{ "INTERNAL_ERROR", @@ -359,8 +375,9 @@ const ( ) // Values returns all known values for InstanceFleetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceFleetType) Values() []InstanceFleetType { return []InstanceFleetType{ "MASTER", @@ -387,8 +404,9 @@ const ( ) // Values returns all known values for InstanceGroupState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceGroupState) Values() []InstanceGroupState { return []InstanceGroupState{ "PROVISIONING", @@ -417,8 +435,9 @@ const ( // Values returns all known values for InstanceGroupStateChangeReasonCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceGroupStateChangeReasonCode) Values() []InstanceGroupStateChangeReasonCode { return []InstanceGroupStateChangeReasonCode{ "INTERNAL_ERROR", @@ -438,8 +457,9 @@ const ( ) // Values returns all known values for InstanceGroupType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceGroupType) Values() []InstanceGroupType { return []InstanceGroupType{ "MASTER", @@ -458,8 +478,9 @@ const ( ) // Values returns all known values for InstanceRoleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceRoleType) Values() []InstanceRoleType { return []InstanceRoleType{ "MASTER", @@ -480,8 +501,9 @@ const ( ) // Values returns all known values for InstanceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceState) Values() []InstanceState { return []InstanceState{ "AWAITING_FULFILLMENT", @@ -505,8 +527,9 @@ const ( // Values returns all known values for InstanceStateChangeReasonCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStateChangeReasonCode) Values() []InstanceStateChangeReasonCode { return []InstanceStateChangeReasonCode{ "INTERNAL_ERROR", @@ -532,8 +555,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "STARTING", @@ -556,8 +580,9 @@ const ( ) // Values returns all known values for MarketType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MarketType) Values() []MarketType { return []MarketType{ "ON_DEMAND", @@ -582,8 +607,9 @@ const ( ) // Values returns all known values for NotebookExecutionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookExecutionStatus) Values() []NotebookExecutionStatus { return []NotebookExecutionStatus{ "START_PENDING", @@ -609,8 +635,9 @@ const ( // Values returns all known values for OnDemandCapacityReservationPreference. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnDemandCapacityReservationPreference) Values() []OnDemandCapacityReservationPreference { return []OnDemandCapacityReservationPreference{ "open", @@ -627,8 +654,9 @@ const ( // Values returns all known values for OnDemandCapacityReservationUsageStrategy. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnDemandCapacityReservationUsageStrategy) Values() []OnDemandCapacityReservationUsageStrategy { return []OnDemandCapacityReservationUsageStrategy{ "use-capacity-reservations-first", @@ -644,8 +672,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnDemandProvisioningAllocationStrategy) Values() []OnDemandProvisioningAllocationStrategy { return []OnDemandProvisioningAllocationStrategy{ "lowest-price", @@ -660,8 +689,9 @@ const ( ) // Values returns all known values for OutputNotebookFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputNotebookFormat) Values() []OutputNotebookFormat { return []OutputNotebookFormat{ "HTML", @@ -679,8 +709,9 @@ const ( ) // Values returns all known values for PlacementGroupStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementGroupStrategy) Values() []PlacementGroupStrategy { return []PlacementGroupStrategy{ "SPREAD", @@ -699,8 +730,9 @@ const ( ) // Values returns all known values for ReconfigurationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReconfigurationType) Values() []ReconfigurationType { return []ReconfigurationType{ "OVERWRITE", @@ -717,8 +749,9 @@ const ( ) // Values returns all known values for RepoUpgradeOnBoot. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepoUpgradeOnBoot) Values() []RepoUpgradeOnBoot { return []RepoUpgradeOnBoot{ "SECURITY", @@ -735,8 +768,9 @@ const ( ) // Values returns all known values for ScaleDownBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScaleDownBehavior) Values() []ScaleDownBehavior { return []ScaleDownBehavior{ "TERMINATE_AT_INSTANCE_HOUR", @@ -756,8 +790,9 @@ const ( // Values returns all known values for SpotProvisioningAllocationStrategy. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpotProvisioningAllocationStrategy) Values() []SpotProvisioningAllocationStrategy { return []SpotProvisioningAllocationStrategy{ "capacity-optimized", @@ -777,8 +812,9 @@ const ( // Values returns all known values for SpotProvisioningTimeoutAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpotProvisioningTimeoutAction) Values() []SpotProvisioningTimeoutAction { return []SpotProvisioningTimeoutAction{ "SWITCH_TO_ON_DEMAND", @@ -798,8 +834,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -819,8 +856,9 @@ const ( ) // Values returns all known values for StepCancellationOption. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepCancellationOption) Values() []StepCancellationOption { return []StepCancellationOption{ "SEND_INTERRUPT", @@ -842,8 +880,9 @@ const ( ) // Values returns all known values for StepExecutionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepExecutionState) Values() []StepExecutionState { return []StepExecutionState{ "PENDING", @@ -870,8 +909,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -893,6 +933,7 @@ const ( // Values returns all known values for StepStateChangeReasonCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StepStateChangeReasonCode) Values() []StepStateChangeReasonCode { return []StepStateChangeReasonCode{ @@ -934,8 +975,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "NONE", diff --git a/service/emr/types/types.go b/service/emr/types/types.go index 82dbd1b612d..59a37ed38fd 100644 --- a/service/emr/types/types.go +++ b/service/emr/types/types.go @@ -10,12 +10,15 @@ 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]. +// +// 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 // corresponding installation script as bootstrap action argument. +// +// [Configuring Applications]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html type Application struct { // This option is for advanced users only. This is meta information about @@ -37,7 +40,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 Amazon EC2 instances in response to the value of -// a CloudWatch metric. See PutAutoScalingPolicy . +// a CloudWatch metric. See PutAutoScalingPolicy. type AutoScalingPolicy struct { // The upper and lower Amazon EC2 instance limits for an automatic scaling policy. @@ -58,7 +61,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 Amazon EC2 instances in response to the -// value of a CloudWatch metric. See PutAutoScalingPolicy . +// value of a CloudWatch metric. See PutAutoScalingPolicy. type AutoScalingPolicyDescription struct { // The upper and lower Amazon EC2 instance limits for an automatic scaling policy. @@ -105,9 +108,9 @@ type AutoScalingPolicyStatus struct { // 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) -// . +// automatically terminates. For alternative cluster termination options, see [Control cluster termination]. +// +// [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 @@ -144,9 +147,10 @@ type BlockPublicAccessConfiguration struct { // (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 Amazon EC2 instances, is in the list of - // PermittedPublicSecurityGroupRuleRanges . + // ::/0 as the source. + // + // By default, Port 22, which is used for SSH access to the cluster Amazon EC2 + // instances, is in the list of PermittedPublicSecurityGroupRuleRanges . PermittedPublicSecurityGroupRuleRanges []PortRange // A set of properties specified within a configuration classification. @@ -316,19 +320,21 @@ type Cluster struct { Id *string // The instance fleet configuration is available only in Amazon EMR releases 4.8.0 - // and later, excluding 5.0.x versions. The instance group configuration of the - // cluster. A value of INSTANCE_GROUP indicates a uniform instance group - // configuration. A value of INSTANCE_FLEET indicates an instance fleets - // configuration. + // and later, excluding 5.0.x versions. + // + // The instance group configuration of the cluster. A value of INSTANCE_GROUP + // indicates a uniform instance group configuration. A value of INSTANCE_FLEET + // indicates an instance fleets configuration. InstanceCollectionType InstanceCollectionType // 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. + // using a security configuration. For more information see [Use Kerberos Authentication]in the Amazon EMR + // Management Guide. + // + // [Use Kerberos Authentication]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html KerberosAttributes *KerberosAttributes - // The KMS key used for encrypting log files. This attribute is only available + // The KMS key used for encrypting log files. This attribute is only available // with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0. LogEncryptionKmsKeyId *string @@ -356,7 +362,7 @@ type Cluster struct { // in the response. OSReleaseLabel *string - // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. + // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. OutpostArn *string // Placement group configured for an Amazon EMR cluster. @@ -366,9 +372,10 @@ type Cluster struct { // 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 . + // versions and features, see [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 . + // + // [https://docs.aws.amazon.com/emr/latest/ReleaseGuide/]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/ ReleaseLabel *string // Applies only when CustomAmiID is used. Specifies the type of updates that the @@ -428,9 +435,13 @@ type Cluster struct { // cluster 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 // Amazon 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 Amazon 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. + // principals. + // + // The default value is true if a value is not provided when creating a cluster + // using the Amazon EMR API RunJobFlowcommand, the CLI [create-cluster] command, or the Amazon Web Services + // Management Console. + // + // [create-cluster]: https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html VisibleToAllUsers *bool noSmithyDocumentSerde @@ -489,7 +500,7 @@ type ClusterSummary struct { // the actual billing rate. NormalizedInstanceHours *int32 - // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. + // The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. OutpostArn *string // The details about the current status of the cluster. @@ -528,13 +539,14 @@ type Command struct { noSmithyDocumentSerde } -// The Amazon EC2 unit limits for a managed scaling policy. The managed scaling +// The Amazon EC2 unit limits for a managed scaling policy. The managed scaling +// // activity of a cluster can not be above or below these limits. The limit only // applies to the core and task nodes. The master node cannot be scaled after // initial configuration. type ComputeLimits struct { - // The upper boundary of Amazon EC2 units. It is measured through vCPU cores or + // The upper boundary of Amazon EC2 units. It is measured through vCPU cores or // instances for instance groups and measured through units for instance fleets. // Managed scaling activities are not allowed beyond this boundary. The limit only // applies to the core and task nodes. The master node cannot be scaled after @@ -543,7 +555,7 @@ type ComputeLimits struct { // This member is required. MaximumCapacityUnits *int32 - // The lower boundary of Amazon EC2 units. It is measured through vCPU cores or + // The lower boundary of Amazon EC2 units. It is measured through vCPU cores or // instances for instance groups and measured through units for instance fleets. // Managed scaling activities are not allowed beyond this boundary. The limit only // applies to the core and task nodes. The master node cannot be scaled after @@ -552,19 +564,19 @@ type ComputeLimits struct { // This member is required. MinimumCapacityUnits *int32 - // The unit type used for specifying a managed scaling policy. + // The unit type used for specifying a managed scaling policy. // // This member is required. UnitType ComputeLimitsUnitType - // The upper boundary of Amazon EC2 units for core node type in a cluster. It is + // The upper boundary of Amazon EC2 units for core node type in a cluster. It is // measured through vCPU cores or instances for instance groups and measured // through units for instance fleets. The core units are not allowed to scale // beyond this boundary. The parameter is used to split capacity allocation between // core and task nodes. MaximumCoreCapacityUnits *int32 - // The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU + // The upper boundary of On-Demand Amazon EC2 units. It is measured through vCPU // cores or instances for instance groups and measured through units for instance // fleets. The On-Demand units are not allowed to scale beyond this boundary. The // parameter is used to split capacity allocation between On-Demand and Spot @@ -574,14 +586,16 @@ type ComputeLimits struct { noSmithyDocumentSerde } -// Amazon EMR releases 4.x or later. An optional configuration specification to be -// used when provisioning cluster instances, which can include configurations for -// applications and software bundled with Amazon EMR. A configuration consists of a -// 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) -// . +// Amazon EMR releases 4.x or later. +// +// An optional configuration specification to be used when provisioning cluster +// instances, which can include configurations for applications and software +// bundled with Amazon EMR. A configuration consists of a 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]. +// +// [Configuring Applications]: https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html type Configuration struct { // The classification within a configuration. @@ -765,8 +779,9 @@ type ExecutionEngineConfig struct { // An optional unique ID of an Amazon EC2 security group to associate with the // master instance of the Amazon EMR cluster for this notebook execution. For more - // information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html) - // in the EMR Management Guide. + // information see [Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks]in the EMR Management Guide. + // + // [Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html MasterInstanceSecurityGroupId *string // The type of execution engine. A value of EMR specifies an Amazon EMR cluster. @@ -890,9 +905,10 @@ type Instance struct { // Describes an instance fleet, which is a group of Amazon EC2 instances that host // a particular node type (master, core, or task) in an Amazon EMR cluster. // Instance fleets can consist of a mix of instance types and On-Demand and Spot -// Instances, which are provisioned to meet a defined target capacity. The instance -// fleet configuration is available only in Amazon EMR releases 4.8.0 and later, -// excluding 5.0.x versions. +// Instances, which are provisioned to meet a defined target capacity. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. type InstanceFleet struct { // The unique identifier of the instance fleet. @@ -930,47 +946,49 @@ 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 + // 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 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$ProvisionedOnDemandCapacityto 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 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 WeightedCapacity of 5 // units, the instance is provisioned, and the target capacity is exceeded by 3 - // 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 - // 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 - // 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 - // have been provisioned for the instance fleet. If not specified or set to 0, only - // On-Demand Instances are provisioned for the instance fleet. 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. + // units. You can use InstanceFleet$ProvisionedSpotCapacityto determine the Spot capacity units that have been + // provisioned for the instance fleet. + // + // If not specified or set to 0, only On-Demand Instances are provisioned for the + // instance fleet. 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. TargetSpotCapacity *int32 noSmithyDocumentSerde } -// The configuration that defines an instance fleet. The instance fleet -// configuration is available only in Amazon EMR releases 4.8.0 and later, -// excluding 5.0.x versions. +// The configuration that defines an instance fleet. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. type InstanceFleetConfig struct { // The node type that the instance fleet hosts. Valid values are MASTER, CORE, and @@ -994,15 +1012,16 @@ 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 - // 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 + // 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 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 @@ -1011,26 +1030,29 @@ type InstanceFleetConfig 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 - // 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 - // 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. + // 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 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. TargetSpotCapacity *int32 noSmithyDocumentSerde } -// Configuration parameters for an instance fleet modification request. The -// instance fleet configuration is available only in Amazon EMR releases 4.8.0 and -// later, excluding 5.0.x versions. +// Configuration parameters for an instance fleet modification request. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. type InstanceFleetModifyConfig struct { // A unique identifier for the instance fleet. @@ -1042,28 +1064,30 @@ 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 } // The launch specification for Spot Instances in the fleet, which determines the -// defined duration, provisioning timeout behavior, and allocation strategy. The -// instance fleet configuration is available only in Amazon EMR releases 4.8.0 and -// later, excluding 5.0.x versions. On-Demand and Spot instance allocation +// defined duration, provisioning timeout behavior, and allocation strategy. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. On-Demand and Spot instance allocation // strategies are available in Amazon EMR releases 5.12.1 and later. type InstanceFleetProvisioningSpecifications struct { - // The launch specification for On-Demand Instances in the instance fleet, which - // determines the allocation strategy. The instance fleet configuration is - // available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. - // On-Demand Instances allocation strategy is available in Amazon EMR releases - // 5.12.1 and later. + // The launch specification for On-Demand Instances in the instance fleet, which + // determines the allocation strategy. + // + // The instance fleet configuration is available only in Amazon EMR releases 4.8.0 + // and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is + // available in Amazon EMR releases 5.12.1 and later. OnDemandSpecification *OnDemandProvisioningSpecification // The launch specification for Spot instances in the fleet, which determines the @@ -1087,9 +1111,10 @@ type InstanceFleetResizingSpecifications struct { noSmithyDocumentSerde } -// Provides status change reason details for the instance fleet. The instance -// fleet configuration is available only in Amazon EMR releases 4.8.0 and later, -// excluding 5.0.x versions. +// Provides status change reason details for the instance fleet. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. type InstanceFleetStateChangeReason struct { // A code corresponding to the reason the state change occurred. @@ -1101,22 +1126,31 @@ type InstanceFleetStateChangeReason struct { noSmithyDocumentSerde } -// The status of the instance fleet. The instance fleet configuration is available -// only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. +// The status of the instance fleet. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. type InstanceFleetStatus struct { // A code representing the instance fleet status. + // // - PROVISIONING —The instance fleet is provisioning Amazon EC2 resources and is // not yet ready to run jobs. + // // - BOOTSTRAPPING —Amazon EC2 instances and other resources have been // provisioned and the bootstrap actions specified for the instances are underway. + // // - RUNNING —Amazon EC2 instances and other resources are running. They are // either executing jobs or waiting to execute jobs. + // // - RESIZING —A resize operation is underway. Amazon EC2 instances are either // being added or removed. + // // - SUSPENDED —A resize operation could not complete. Existing Amazon EC2 // instances are running, but instances can't be added or removed. + // // - TERMINATING —The instance fleet is terminating Amazon EC2 instances. + // // - TERMINATED —The instance fleet is no longer active, and all Amazon EC2 // instances have been terminated. State InstanceFleetState @@ -1132,9 +1166,10 @@ type InstanceFleetStatus struct { } // Provides historical timestamps for the instance fleet, including the time of -// creation, the time it became ready to run jobs, and the time of termination. The -// instance fleet configuration is available only in Amazon EMR releases 4.8.0 and -// later, excluding 5.0.x versions. +// creation, the time it became ready to run jobs, and the time of termination. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. type InstanceFleetTimeline struct { // The time and date the instance fleet was created. @@ -1165,9 +1200,11 @@ type InstanceGroup struct { // amount in USD. BidPrice *string - // Amazon EMR releases 4.x or later. The list of configurations supplied for an - // Amazon EMR cluster instance group. You can specify a separate configuration for - // each instance group (master, core, and task). + // Amazon EMR releases 4.x or later. + // + // The list of configurations supplied for an Amazon EMR cluster instance group. + // You can specify a separate configuration for each instance group (master, core, + // and task). Configurations []Configuration // The version number of the requested configuration specification for this @@ -1245,7 +1282,7 @@ 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 Amazon EC2 instances in response to the - // value of a CloudWatch metric. See PutAutoScalingPolicy . + // value of a CloudWatch metric. See PutAutoScalingPolicy. AutoScalingPolicy *AutoScalingPolicy // If specified, indicates that the instance group uses Spot Instances. This is @@ -1254,9 +1291,11 @@ type InstanceGroupConfig struct { // amount in USD. BidPrice *string - // Amazon EMR releases 4.x or later. The list of configurations supplied for an - // Amazon EMR cluster instance group. You can specify a separate configuration for - // each instance group (master, core, and task). + // Amazon EMR releases 4.x or later. + // + // The list of configurations supplied for an Amazon EMR cluster instance group. + // You can specify a separate configuration for each instance group (master, core, + // and task). Configurations []Configuration // The custom AMI ID to use for the provisioned instance group. @@ -1476,11 +1515,14 @@ type InstanceTimeline struct { // which determines the Amazon EC2 instances Amazon EMR attempts to provision to // fulfill 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 releases 4.8.0 and later, excluding 5.0.x versions. +// fleet. For more information about how to use an allocation strategy, see [Configure Instance Fleets]. +// 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 releases 4.8.0 +// and later, excluding 5.0.x versions. +// +// [Configure Instance Fleets]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html type InstanceTypeConfig struct { // An Amazon EC2 instance type, such as m3.xlarge . @@ -1512,15 +1554,16 @@ type InstanceTypeConfig struct { 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 releases 4.8.0 // and later, excluding 5.0.x versions. type InstanceTypeSpecification struct { @@ -1553,9 +1596,9 @@ type InstanceTypeSpecification struct { 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 @@ -1640,10 +1683,13 @@ type JobFlowDetail struct { // Amazon Web Services account can perform Amazon EMR cluster actions 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 Amazon 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 Amazon 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. + // 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 Amazon EMR API RunJobFlowcommand, the CLI [create-cluster] command, or the Amazon Web Services + // Management Console. + // + // [create-cluster]: https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html VisibleToAllUsers *bool noSmithyDocumentSerde @@ -1704,8 +1750,10 @@ type JobFlowInstancesConfig struct { // Applies to clusters that use the instance fleet configuration. When multiple // Amazon 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 releases 4.8.0 and later, excluding 5.0.x versions. + // instances in the optimal subnet. + // + // The instance fleet configuration is available only in Amazon EMR releases 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 @@ -1730,8 +1778,10 @@ type JobFlowInstancesConfig struct { InstanceCount *int32 // The instance fleet configuration is available only in Amazon EMR releases 4.8.0 - // and later, excluding 5.0.x versions. Describes the Amazon EC2 instances and - // instance configurations for clusters that use the instance fleet configuration. + // and later, excluding 5.0.x versions. + // + // Describes the Amazon EC2 instances and instance configurations for clusters + // that use the instance fleet configuration. InstanceFleets []InstanceFleetConfig // Configuration for the instance groups in a cluster. @@ -1739,8 +1789,9 @@ type JobFlowInstancesConfig struct { // Specifies whether the cluster should remain available after completing all // steps. Defaults to false . 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. + // termination, see [Control Cluster Termination]in the EMR Management Guide. + // + // [Control Cluster Termination]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-termination.html KeepJobFlowAliveWhenNoSteps *bool // The Amazon EC2 instance type of the master node. @@ -1838,9 +1889,10 @@ 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. +// using a security configuration. For more information see [Use Kerberos Authentication]in the Amazon EMR +// Management Guide. +// +// [Use Kerberos Authentication]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html type KerberosAttributes struct { // The password used within the cluster for the kadmin service on the @@ -1883,7 +1935,8 @@ type KeyValue struct { noSmithyDocumentSerde } -// Managed scaling policy for an Amazon EMR cluster. The policy specifies the +// Managed scaling policy for an Amazon EMR cluster. The policy specifies the +// // limits for resources that can be added or terminated from a cluster. The policy // only applies to the core and task nodes. The master node cannot be scaled after // initial configuration. @@ -1945,9 +1998,10 @@ type NotebookExecution struct { NotebookExecutionName *string // The unique identifier of the Amazon EC2 security group associated with the - // Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 - // Security Groups for Amazon EMR Notebooks (https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html) - // in the Amazon EMR Management Guide. + // Amazon EMR Notebook instance. For more information see [Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks]in the Amazon EMR + // Management Guide. + // + // [Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html NotebookInstanceSecurityGroupId *string // Input parameters in JSON format passed to the Amazon EMR Notebook at runtime @@ -1970,19 +2024,29 @@ 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. Status NotebookExecutionStatus @@ -2021,19 +2085,29 @@ 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. Status NotebookExecutionStatus @@ -2071,8 +2145,10 @@ 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. CapacityReservationPreference OnDemandCapacityReservationPreference @@ -2081,25 +2157,30 @@ type OnDemandCapacityReservationOptions struct { 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 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. + // 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. UsageStrategy OnDemandCapacityReservationUsageStrategy noSmithyDocumentSerde } -// The launch specification for On-Demand Instances in the instance fleet, which -// determines the allocation strategy. The instance fleet configuration is -// available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. -// On-Demand Instances allocation strategy is available in Amazon EMR releases -// 5.12.1 and later. +// The launch specification for On-Demand Instances in the instance fleet, which +// +// determines the allocation strategy. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is +// available in Amazon EMR releases 5.12.1 and later. type OnDemandProvisioningSpecification struct { // Specifies the strategy to use in launching On-Demand instance fleets. @@ -2138,8 +2219,9 @@ 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]. For example, 2.0.20220218.1. + // + // [Amazon Linux 2 Release Notes]: https://docs.aws.amazon.com/AL2/latest/relnotes/relnotes-20220218.html Label *string noSmithyDocumentSerde @@ -2171,19 +2253,24 @@ type OutputNotebookS3LocationFromInput struct { // Placement group configuration for an Amazon EMR cluster. The configuration // specifies the placement strategy that can be applied to instance roles during -// cluster creation. To use this configuration, consider attaching managed policy +// cluster creation. +// +// To use this configuration, consider attaching managed policy // AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role. type PlacementGroupConfig struct { - // Role of the instance in the cluster. Starting with Amazon EMR release 5.23.0, - // the only supported instance role is MASTER . + // Role of the instance in the cluster. + // + // Starting with Amazon EMR release 5.23.0, the only supported instance role is + // MASTER . // // This member is required. InstanceRole InstanceRoleType - // Amazon EC2 Placement Group strategy associated with instance role. Starting - // with Amazon EMR release 5.23.0, the only supported placement strategy is SPREAD - // for the MASTER instance role. + // Amazon EC2 Placement Group strategy associated with instance role. + // + // Starting with Amazon EMR release 5.23.0, the only supported placement strategy + // is SPREAD for the MASTER instance role. PlacementStrategy PlacementGroupStrategy noSmithyDocumentSerde @@ -2200,8 +2287,10 @@ type PlacementType struct { // When multiple Availability Zones are specified, Amazon EMR evaluates them and // launches instances in the optimal Availability Zone. AvailabilityZones is used // for instance fleets, while AvailabilityZone (singular) is used for uniform - // instance groups. The instance fleet configuration is available only in Amazon - // EMR releases 4.8.0 and later, excluding 5.0.x versions. + // instance groups. + // + // The instance fleet configuration is available only in Amazon EMR releases 4.8.0 + // and later, excluding 5.0.x versions. AvailabilityZones []string noSmithyDocumentSerde @@ -2351,9 +2440,11 @@ 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) - // in the IAM Identity Center Identity Store API Reference. + // The name of the user or group. For more information, see [UserName] and [DisplayName] in the IAM + // Identity Center Identity Store API Reference. + // + // [UserName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName + // [DisplayName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName IdentityName *string // Specifies whether the identity mapped to the Amazon EMR Studio is a user or a @@ -2384,9 +2475,11 @@ type SessionMappingSummary struct { // 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) - // in the IAM Identity Center Identity Store API Reference. + // The name of the user or group. For more information, see [UserName] and [DisplayName] in the IAM + // Identity Center Identity Store API Reference. + // + // [UserName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName + // [DisplayName]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName IdentityName *string // Specifies whether the identity mapped to the Amazon EMR Studio is a user or a @@ -2468,13 +2561,16 @@ type SimplifiedApplication struct { // The launch specification for Spot Instances in the instance fleet, which // determines the defined duration, provisioning timeout behavior, and allocation -// strategy. The instance fleet configuration is available only in Amazon EMR -// releases 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation -// strategy is available in Amazon EMR releases 5.12.1 and later. Spot Instances -// with a defined duration (also known as Spot blocks) are no longer available to -// new customers from July 1, 2021. For customers who have previously used the -// feature, we will continue to support Spot Instances with a defined duration -// until December 31, 2022. +// strategy. +// +// The instance fleet configuration is available only in Amazon EMR releases 4.8.0 +// and later, excluding 5.0.x versions. Spot Instance allocation strategy is +// available in Amazon EMR releases 5.12.1 and later. +// +// Spot Instances with a defined duration (also known as Spot blocks) are no +// longer available to new customers from July 1, 2021. For customers who have +// previously used the feature, we will continue to support Spot Instances with a +// defined duration until December 31, 2022. type SpotProvisioningSpecification struct { // The action to take when TargetSpotCapacity has not been fulfilled when the @@ -2497,12 +2593,14 @@ type SpotProvisioningSpecification struct { // Specifies one of the following strategies to launch Spot Instance fleets: // price-capacity-optimized , capacity-optimized , lowest-price , or diversified . - // For more information on the provisioning strategies, 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 for Linux Instances. When you launch a Spot - // Instance fleet with the old console, it automatically launches with the - // capacity-optimized strategy. You can't change the allocation strategy from the - // old console. + // For more information on the provisioning strategies, see [Allocation strategies for Spot Instances]in the Amazon EC2 User + // Guide for Linux Instances. + // + // When you launch a Spot Instance fleet with the old console, it automatically + // launches with the capacity-optimized strategy. You can't change the allocation + // strategy from the old console. + // + // [Allocation strategies for Spot Instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html AllocationStrategy SpotProvisioningAllocationStrategy // The defined duration for Spot Instances (also known as Spot blocks) in minutes. @@ -2511,11 +2609,12 @@ type SpotProvisioningSpecification struct { // are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot // Instance receives its instance ID. At the end of the duration, Amazon EC2 marks // the Spot Instance for termination and provides a Spot Instance termination - // notice, which gives the instance a two-minute warning before it terminates. Spot - // Instances with a defined duration (also known as Spot blocks) are no longer - // available to new customers from July 1, 2021. For customers who have previously - // used the feature, we will continue to support Spot Instances with a defined - // duration until December 31, 2022. + // notice, which gives the instance a two-minute warning before it terminates. + // + // Spot Instances with a defined duration (also known as Spot blocks) are no + // longer available to new customers from July 1, 2021. For customers who have + // previously used the feature, we will continue to support Spot Instances with a + // defined duration until December 31, 2022. BlockDurationMinutes *int32 noSmithyDocumentSerde @@ -2545,15 +2644,18 @@ 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 + // 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. + // 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. @@ -2562,8 +2664,10 @@ 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:aws:IAM::1234567890:role/ReadOnly is a correctly formatted runtime role ARN. + // arn:partition:service:region:account:resource . + // + // For example, arn:aws:IAM::1234567890:role/ReadOnly is a correctly formatted + // runtime role ARN. ExecutionRoleArn *string // The identifier of the cluster step. @@ -2592,21 +2696,27 @@ 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. + // 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 @@ -2749,10 +2859,10 @@ type Studio struct { // Workspace security group. EngineSecurityGroupId *string - // The ARN of the IAM Identity Center instance the Studio application belongs to. + // The ARN of the IAM Identity Center instance the Studio application belongs to. IdcInstanceArn *string - // Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user + // Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user // assignment. If the value is set to REQUIRED , users must be explicitly assigned // to the Studio application to access the Studio. IdcUserAssignment IdcUserAssignment @@ -2783,7 +2893,7 @@ type Studio struct { // A list of tags associated with the Amazon EMR Studio. Tags []Tag - // Indicates whether the Studio has Trusted identity propagation enabled. The + // Indicates whether the Studio has Trusted identity propagation enabled. The // default value is false . TrustedIdentityPropagationEnabled *bool @@ -2807,7 +2917,7 @@ type Studio struct { // Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. To // fetch additional details such as subnets, IAM roles, security groups, and tags -// for the Studio, use the DescribeStudio API. +// for the Studio, use the DescribeStudioAPI. type StudioSummary struct { // Specifies whether the Studio authenticates users using IAM or IAM Identity @@ -2871,8 +2981,9 @@ type SupportedInstanceType struct { // value is 0 for Amazon EBS-only instance types. StorageGB *int32 - // The Amazon EC2 instance type (http://aws.amazon.com/ec2/instance-types/) , for - // example m5.xlarge , of the SupportedInstanceType . + // The [Amazon EC2 instance type], for example m5.xlarge , of the SupportedInstanceType . + // + // [Amazon EC2 instance type]: http://aws.amazon.com/ec2/instance-types/ Type *string // The number of vCPUs available for the SupportedInstanceType . @@ -2898,18 +3009,20 @@ type SupportedProductConfig struct { // 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) -// . +// costs. For more information, see [Tag Clusters]. +// +// [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]. + // + // [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) - // . + // A user-defined value, which is optional in a tag. For more information, see [Tag Clusters]. + // + // [Tag Clusters]: https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html Value *string noSmithyDocumentSerde diff --git a/service/emrcontainers/api_op_ListJobTemplates.go b/service/emrcontainers/api_op_ListJobTemplates.go index 0cbd9eddb70..62f8357d437 100644 --- a/service/emrcontainers/api_op_ListJobTemplates.go +++ b/service/emrcontainers/api_op_ListJobTemplates.go @@ -36,13 +36,13 @@ type ListJobTemplatesInput struct { // The date and time after which the job templates were created. CreatedAfter *time.Time - // The date and time before which the job templates were created. + // The date and time before which the job templates were created. CreatedBefore *time.Time - // The maximum number of job templates that can be listed. + // The maximum number of job templates that can be listed. MaxResults *int32 - // The token for the next set of job templates to return. + // The token for the next set of job templates to return. NextToken *string noSmithyDocumentSerde @@ -50,7 +50,7 @@ type ListJobTemplatesInput struct { type ListJobTemplatesOutput struct { - // This output displays the token for the next set of job templates. + // This output displays the token for the next set of job templates. NextToken *string // This output lists information about the specified job templates. @@ -148,7 +148,7 @@ var _ ListJobTemplatesAPIClient = (*Client)(nil) // ListJobTemplatesPaginatorOptions is the paginator options for ListJobTemplates type ListJobTemplatesPaginatorOptions struct { - // The maximum number of job templates that can be listed. + // The maximum number of job templates that can be listed. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/emrcontainers/api_op_ListManagedEndpoints.go b/service/emrcontainers/api_op_ListManagedEndpoints.go index 4834f6ea4fb..5bcde339d36 100644 --- a/service/emrcontainers/api_op_ListManagedEndpoints.go +++ b/service/emrcontainers/api_op_ListManagedEndpoints.go @@ -37,7 +37,7 @@ type ListManagedEndpointsInput struct { // This member is required. VirtualClusterId *string - // The date and time after which the endpoints are created. + // The date and time after which the endpoints are created. CreatedAfter *time.Time // The date and time before which the endpoints are created. @@ -46,7 +46,7 @@ type ListManagedEndpointsInput struct { // The maximum number of managed endpoints that can be listed. MaxResults *int32 - // The token for the next set of managed endpoints to return. + // The token for the next set of managed endpoints to return. NextToken *string // The states of the managed endpoints. @@ -63,7 +63,7 @@ type ListManagedEndpointsOutput struct { // The managed endpoints to be listed. Endpoints []types.Endpoint - // The token for the next set of endpoints to return. + // The token for the next set of endpoints to return. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/emrcontainers/doc.go b/service/emrcontainers/doc.go index f9919b8c9c8..844c971a205 100644 --- a/service/emrcontainers/doc.go +++ b/service/emrcontainers/doc.go @@ -8,17 +8,22 @@ // (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 Amazon EMR on 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: +// and tasks, see [What is Amazon EMR on EKS]. +// +// 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) +// example, "Action": [ "emr-containers:StartJobRun"] . For more information, see [Policy actions for Amazon EMR on EKS] // . +// // - 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) -// . +// emr-containers.us-east-2.amazonaws.com . For more information, see [Amazon EMR on EKSService Endpoints]. +// +// [What is Amazon EMR on EKS]: https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html +// [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 +// [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/options.go b/service/emrcontainers/options.go index 44235eaa69e..c7f020a0ec7 100644 --- a/service/emrcontainers/options.go +++ b/service/emrcontainers/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/emrcontainers/types/enums.go b/service/emrcontainers/types/enums.go index 69e296ff5a0..d99b29215ac 100644 --- a/service/emrcontainers/types/enums.go +++ b/service/emrcontainers/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for CertificateProviderType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateProviderType) Values() []CertificateProviderType { return []CertificateProviderType{ "PEM", @@ -26,8 +27,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "EKS", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for EndpointState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointState) Values() []EndpointState { return []EndpointState{ "CREATING", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for FailureReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureReason) Values() []FailureReason { return []FailureReason{ "INTERNAL_ERROR", @@ -94,8 +98,9 @@ const ( ) // Values returns all known values for JobRunState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobRunState) Values() []JobRunState { return []JobRunState{ "PENDING", @@ -117,8 +122,9 @@ const ( ) // Values returns all known values for PersistentAppUI. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PersistentAppUI) Values() []PersistentAppUI { return []PersistentAppUI{ "ENABLED", @@ -136,6 +142,7 @@ const ( // Values returns all known values for TemplateParameterDataType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TemplateParameterDataType) Values() []TemplateParameterDataType { return []TemplateParameterDataType{ @@ -155,8 +162,9 @@ const ( ) // Values returns all known values for VirtualClusterState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualClusterState) Values() []VirtualClusterState { return []VirtualClusterState{ "RUNNING", diff --git a/service/emrcontainers/types/types.go b/service/emrcontainers/types/types.go index 5b6d5b8b305..a87ebbfdf58 100644 --- a/service/emrcontainers/types/types.go +++ b/service/emrcontainers/types/types.go @@ -197,7 +197,7 @@ type Endpoint struct { // The execution role ARN of the endpoint. ExecutionRoleArn *string - // The reasons why the endpoint has failed. + // The reasons why the endpoint has failed. FailureReason FailureReason // The ID of the endpoint. @@ -218,7 +218,7 @@ type Endpoint struct { // The state of the endpoint. State EndpointState - // Additional details of the endpoint state. + // Additional details of the endpoint state. StateDetails *string // The subnet IDs of the endpoint. @@ -333,10 +333,10 @@ type JobTemplate struct { // The ARN of the job template. Arn *string - // The date and time when the job template was created. + // The date and time when the job template was created. CreatedAt *time.Time - // The user who created the job template. + // The user who created the job template. CreatedBy *string // The error message in case the decryption of job template fails. @@ -345,7 +345,7 @@ type JobTemplate struct { // The ID of the job template. Id *string - // The KMS key ARN used to encrypt the job template. + // The KMS key ARN used to encrypt the job template. KmsKeyArn *string // The name of the job template. @@ -372,12 +372,12 @@ type JobTemplateData struct { // This member is required. JobDriver *JobDriver - // The release version of Amazon EMR. + // The release version of Amazon EMR. // // This member is required. ReleaseLabel *string - // The configuration settings that are used to override defaults configuration. + // The configuration settings that are used to override defaults configuration. ConfigurationOverrides *ParametricConfigurationOverrides // The tags assigned to jobs started using the job template. @@ -424,50 +424,54 @@ type MonitoringConfiguration struct { noSmithyDocumentSerde } -// A configuration for CloudWatch monitoring. You can configure your jobs to send +// A configuration for CloudWatch monitoring. You can configure your jobs to send +// // log information to CloudWatch Logs. This data type allows job template // parameters to be specified within. type ParametricCloudWatchMonitoringConfiguration struct { - // The name of the log group for log publishing. + // The name of the log group for log publishing. LogGroupName *string - // The specified name prefix for log streams. + // The specified name prefix for log streams. LogStreamNamePrefix *string noSmithyDocumentSerde } -// A configuration specification to be used to override existing configurations. +// A configuration specification to be used to override existing configurations. +// // This data type allows job template parameters to be specified within. type ParametricConfigurationOverrides struct { - // The configurations for the application running by the job run. + // The configurations for the application running by the job run. ApplicationConfiguration []Configuration - // The configurations for monitoring. + // The configurations for monitoring. MonitoringConfiguration *ParametricMonitoringConfiguration noSmithyDocumentSerde } -// Configuration setting for monitoring. This data type allows job template +// Configuration setting for monitoring. This data type allows job template +// // parameters to be specified within. type ParametricMonitoringConfiguration struct { - // Monitoring configurations for CloudWatch. + // Monitoring configurations for CloudWatch. CloudWatchMonitoringConfiguration *ParametricCloudWatchMonitoringConfiguration - // Monitoring configurations for the persistent application UI. + // Monitoring configurations for the persistent application UI. PersistentAppUI *string - // Amazon S3 configuration for monitoring log publishing. + // Amazon S3 configuration for monitoring log publishing. S3MonitoringConfiguration *ParametricS3MonitoringConfiguration noSmithyDocumentSerde } -// Amazon S3 configuration for monitoring log publishing. You can configure your +// Amazon S3 configuration for monitoring log publishing. You can configure your +// // jobs to send log information to Amazon S3. This data type allows job template // parameters to be specified within. type ParametricS3MonitoringConfiguration struct { @@ -500,7 +504,8 @@ type RetryPolicyExecution struct { noSmithyDocumentSerde } -// Amazon S3 configuration for monitoring log publishing. You can configure your +// Amazon S3 configuration for monitoring log publishing. You can configure your +// // jobs to send log information to Amazon S3. type S3MonitoringConfiguration struct { diff --git a/service/emrserverless/api_op_CreateApplication.go b/service/emrserverless/api_op_CreateApplication.go index da0627c1f79..fbd202f22fa 100644 --- a/service/emrserverless/api_op_CreateApplication.go +++ b/service/emrserverless/api_op_CreateApplication.go @@ -77,10 +77,11 @@ type CreateApplicationInput struct { // The network configuration for customer VPC connectivity. NetworkConfiguration *types.NetworkConfiguration - // The Configuration (https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html) - // specifications to use when creating an application. Each configuration consists - // of a classification and properties. This configuration is applied to all the job - // runs submitted under the application. + // The [Configuration] specifications to use when creating an application. Each configuration + // consists of a classification and properties. This configuration is applied to + // all the job runs submitted under the application. + // + // [Configuration]: https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html RuntimeConfiguration []types.Configuration // The tags assigned to the application. diff --git a/service/emrserverless/api_op_GetDashboardForJobRun.go b/service/emrserverless/api_op_GetDashboardForJobRun.go index 4215c1d548e..27bf71f248c 100644 --- a/service/emrserverless/api_op_GetDashboardForJobRun.go +++ b/service/emrserverless/api_op_GetDashboardForJobRun.go @@ -11,12 +11,15 @@ import ( ) // Creates and returns a URL that you can use to access the application UIs for a -// job run. For jobs in a running state, the application UI is a live user -// interface such as the Spark or Tez web UI. For completed jobs, the application -// UI is a persistent application user interface such as the Spark History Server -// or persistent Tez UI. The URL is valid for one hour after you generate it. To -// access the application UI after that hour elapses, you must invoke the API again -// to generate a new URL. +// job run. +// +// For jobs in a running state, the application UI is a live user interface such +// as the Spark or Tez web UI. For completed jobs, the application UI is a +// persistent application user interface such as the Spark History Server or +// persistent Tez UI. +// +// The URL is valid for one hour after you generate it. To access the application +// UI after that hour elapses, you must invoke the API again to generate a new URL. func (c *Client) GetDashboardForJobRun(ctx context.Context, params *GetDashboardForJobRunInput, optFns ...func(*Options)) (*GetDashboardForJobRunOutput, error) { if params == nil { params = &GetDashboardForJobRunInput{} diff --git a/service/emrserverless/api_op_UpdateApplication.go b/service/emrserverless/api_op_UpdateApplication.go index e13c0c6ddd2..7495d7d23f5 100644 --- a/service/emrserverless/api_op_UpdateApplication.go +++ b/service/emrserverless/api_op_UpdateApplication.go @@ -75,10 +75,11 @@ type UpdateApplicationInput struct { // label to use a different release of Amazon EMR. ReleaseLabel *string - // The Configuration (https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html) - // specifications to use when updating an application. Each configuration consists - // of a classification and properties. This configuration is applied across all the - // job runs submitted under the application. + // The [Configuration] specifications to use when updating an application. Each configuration + // consists of a classification and properties. This configuration is applied + // across all the job runs submitted under the application. + // + // [Configuration]: https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html RuntimeConfiguration []types.Configuration // The key-value pairs that specify worker type to WorkerTypeSpecificationInput . diff --git a/service/emrserverless/doc.go b/service/emrserverless/doc.go index 7289f417677..7e135ce5588 100644 --- a/service/emrserverless/doc.go +++ b/service/emrserverless/doc.go @@ -8,14 +8,19 @@ // analytics applications using the latest open source frameworks such as Apache // Spark and Apache Hive. With Amazon 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) +// example, "Action": ["emr-serverless:StartJobRun"] . For more information, see [Policy actions for Amazon EMR Serverless] // . +// // - It is the prefix used in Amazon EMR Serverless service endpoints. For // example, emr-serverless.us-east-2.amazonaws.com . +// +// [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 package emrserverless diff --git a/service/emrserverless/options.go b/service/emrserverless/options.go index 9846f62e8c8..a98fcc14e25 100644 --- a/service/emrserverless/options.go +++ b/service/emrserverless/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/emrserverless/types/enums.go b/service/emrserverless/types/enums.go index d518bab27fc..81871079547 100644 --- a/service/emrserverless/types/enums.go +++ b/service/emrserverless/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for ApplicationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationState) Values() []ApplicationState { return []ApplicationState{ "CREATING", @@ -39,8 +40,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -63,8 +65,9 @@ const ( ) // Values returns all known values for JobRunState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobRunState) Values() []JobRunState { return []JobRunState{ "SUBMITTED", diff --git a/service/emrserverless/types/types.go b/service/emrserverless/types/types.go index 7f5fb01f97a..d5de7224854 100644 --- a/service/emrserverless/types/types.go +++ b/service/emrserverless/types/types.go @@ -76,12 +76,13 @@ type Application struct { // The network configuration for customer VPC connectivity for the application. NetworkConfiguration *NetworkConfiguration - // The Configuration (https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html) - // specifications of an application. Each configuration consists of a + // The [Configuration] specifications of an application. Each configuration consists of a // classification and properties. You use this parameter when creating or updating // an application. To see the runtimeConfiguration object of an application, run - // the GetApplication (https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html) - // API operation. + // the [GetApplication]API operation. + // + // [Configuration]: https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_Configuration.html + // [GetApplication]: https://docs.aws.amazon.com/emr-serverless/latest/APIReference/API_GetApplication.html RuntimeConfiguration []Configuration // The state details of the application. @@ -194,11 +195,14 @@ type CloudWatchLoggingConfiguration struct { // The types of logs that you want to publish to CloudWatch. If you don't specify // any log types, driver STDOUT and STDERR logs will be published to CloudWatch // Logs by default. For more information including the supported worker types for - // Hive and Spark, see Logging for EMR Serverless with CloudWatch (https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/logging.html#jobs-log-storage-cw) - // . + // Hive and Spark, see [Logging for EMR Serverless with CloudWatch]. + // // - Key Valid Values: SPARK_DRIVER , SPARK_EXECUTOR , HIVE_DRIVER , TEZ_TASK + // // - Array Members Valid Values: STDOUT , STDERR , HIVE_LOG , TEZ_AM , // SYSTEM_LOGS + // + // [Logging for EMR Serverless with CloudWatch]: https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/logging.html#jobs-log-storage-cw LogTypes map[string][]string noSmithyDocumentSerde diff --git a/service/entityresolution/api_op_AddPolicyStatement.go b/service/entityresolution/api_op_AddPolicyStatement.go index 178373a597d..b8aa93b07f1 100644 --- a/service/entityresolution/api_op_AddPolicyStatement.go +++ b/service/entityresolution/api_op_AddPolicyStatement.go @@ -30,8 +30,9 @@ func (c *Client) AddPolicyStatement(ctx context.Context, params *AddPolicyStatem type AddPolicyStatementInput struct { - // The action that the principal can use on the resource. For example, - // entityresolution:GetIdMappingJob , entityresolution:GetMatchingJob . + // The action that the principal can use on the resource. + // + // For example, entityresolution:GetIdMappingJob , entityresolution:GetMatchingJob . // // This member is required. Action []string diff --git a/service/entityresolution/api_op_BatchDeleteUniqueId.go b/service/entityresolution/api_op_BatchDeleteUniqueId.go index b79b96e5241..261a48c34c8 100644 --- a/service/entityresolution/api_op_BatchDeleteUniqueId.go +++ b/service/entityresolution/api_op_BatchDeleteUniqueId.go @@ -57,7 +57,7 @@ type BatchDeleteUniqueIdOutput struct { // This member is required. DisconnectedUniqueIds []string - // The errors from deleting multiple unique IDs. + // The errors from deleting multiple unique IDs. // // This member is required. Errors []types.DeleteUniqueIdError diff --git a/service/entityresolution/api_op_CreateIdNamespace.go b/service/entityresolution/api_op_CreateIdNamespace.go index e9394c1bc1e..9f7a39b35c3 100644 --- a/service/entityresolution/api_op_CreateIdNamespace.go +++ b/service/entityresolution/api_op_CreateIdNamespace.go @@ -37,10 +37,13 @@ type CreateIdNamespaceInput struct { // This member is required. IdNamespaceName *string - // The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE - // contains configurations for sourceId data that will be processed in an ID - // mapping workflow. The TARGET contains a configuration of targetId to which all - // sourceIds will resolve to. + // The type of ID namespace. There are two types: SOURCE and TARGET . + // + // The SOURCE contains configurations for sourceId data that will be processed in + // an ID mapping workflow. + // + // The TARGET contains a configuration of targetId to which all sourceIds will + // resolve to. // // This member is required. Type types.IdNamespaceType @@ -84,10 +87,13 @@ type CreateIdNamespaceOutput struct { // This member is required. IdNamespaceName *string - // The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE - // contains configurations for sourceId data that will be processed in an ID - // mapping workflow. The TARGET contains a configuration of targetId to which all - // sourceIds will resolve to. + // The type of ID namespace. There are two types: SOURCE and TARGET . + // + // The SOURCE contains configurations for sourceId data that will be processed in + // an ID mapping workflow. + // + // The TARGET contains a configuration of targetId to which all sourceIds will + // resolve to. // // This member is required. Type types.IdNamespaceType diff --git a/service/entityresolution/api_op_GetIdNamespace.go b/service/entityresolution/api_op_GetIdNamespace.go index 8910e0bd3ac..2124f256726 100644 --- a/service/entityresolution/api_op_GetIdNamespace.go +++ b/service/entityresolution/api_op_GetIdNamespace.go @@ -55,10 +55,13 @@ type GetIdNamespaceOutput struct { // This member is required. IdNamespaceName *string - // The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE - // contains configurations for sourceId data that will be processed in an ID - // mapping workflow. The TARGET contains a configuration of targetId to which all - // sourceIds will resolve to. + // The type of ID namespace. There are two types: SOURCE and TARGET . + // + // The SOURCE contains configurations for sourceId data that will be processed in + // an ID mapping workflow. + // + // The TARGET contains a configuration of targetId to which all sourceIds will + // resolve to. // // This member is required. Type types.IdNamespaceType diff --git a/service/entityresolution/api_op_UpdateIdNamespace.go b/service/entityresolution/api_op_UpdateIdNamespace.go index ea76bd09130..aee0c1bdf51 100644 --- a/service/entityresolution/api_op_UpdateIdNamespace.go +++ b/service/entityresolution/api_op_UpdateIdNamespace.go @@ -71,10 +71,13 @@ type UpdateIdNamespaceOutput struct { // This member is required. IdNamespaceName *string - // The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE - // contains configurations for sourceId data that will be processed in an ID - // mapping workflow. The TARGET contains a configuration of targetId to which all - // sourceIds will resolve to. + // The type of ID namespace. There are two types: SOURCE and TARGET . + // + // The SOURCE contains configurations for sourceId data that will be processed in + // an ID mapping workflow. + // + // The TARGET contains a configuration of targetId to which all sourceIds will + // resolve to. // // This member is required. Type types.IdNamespaceType diff --git a/service/entityresolution/api_op_UpdateSchemaMapping.go b/service/entityresolution/api_op_UpdateSchemaMapping.go index e70b6c1eed3..d48d2e60580 100644 --- a/service/entityresolution/api_op_UpdateSchemaMapping.go +++ b/service/entityresolution/api_op_UpdateSchemaMapping.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a schema mapping. A schema is immutable if it is being used by a -// workflow. Therefore, you can't update a schema mapping if it's associated with a -// workflow. +// Updates a schema mapping. +// +// A schema is immutable if it is being used by a workflow. Therefore, you can't +// update a schema mapping if it's associated with a workflow. func (c *Client) UpdateSchemaMapping(ctx context.Context, params *UpdateSchemaMappingInput, optFns ...func(*Options)) (*UpdateSchemaMappingOutput, error) { if params == nil { params = &UpdateSchemaMappingInput{} diff --git a/service/entityresolution/doc.go b/service/entityresolution/doc.go index 464ac903885..a71b6db33e8 100644 --- a/service/entityresolution/doc.go +++ b/service/entityresolution/doc.go @@ -3,16 +3,22 @@ // Package entityresolution provides the API client, operations, and parameter // types for AWS EntityResolution. // -// Welcome to the Entity Resolution API Reference. Entity Resolution is an Amazon -// Web Services service that provides pre-configured entity resolution capabilities -// that enable developers and analysts at advertising and marketing companies to -// build an accurate and complete view of their consumers. With Entity Resolution, -// you can match source records containing consumer identifiers, such as name, -// email address, and phone number. This is true even when these records have -// incomplete or conflicting identifiers. For example, Entity Resolution can -// effectively match a source record from a customer relationship management (CRM) -// system with a source record from a marketing system containing campaign -// information. To learn more about Entity Resolution concepts, procedures, and -// best practices, see the Entity Resolution User Guide (https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html) -// . +// Welcome to the Entity Resolution API Reference. +// +// Entity Resolution is an Amazon Web Services service that provides +// pre-configured entity resolution capabilities that enable developers and +// analysts at advertising and marketing companies to build an accurate and +// complete view of their consumers. +// +// With Entity Resolution, you can match source records containing consumer +// identifiers, such as name, email address, and phone number. This is true even +// when these records have incomplete or conflicting identifiers. For example, +// Entity Resolution can effectively match a source record from a customer +// relationship management (CRM) system with a source record from a marketing +// system containing campaign information. +// +// To learn more about Entity Resolution concepts, procedures, and best practices, +// see the [Entity Resolution User Guide]. +// +// [Entity Resolution User Guide]: https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html package entityresolution diff --git a/service/entityresolution/options.go b/service/entityresolution/options.go index 6ed3e8aa213..dbef3646802 100644 --- a/service/entityresolution/options.go +++ b/service/entityresolution/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/entityresolution/types/enums.go b/service/entityresolution/types/enums.go index 5c9ff5e2ae5..d068a6d6b2e 100644 --- a/service/entityresolution/types/enums.go +++ b/service/entityresolution/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AttributeMatchingModel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeMatchingModel) Values() []AttributeMatchingModel { return []AttributeMatchingModel{ "ONE_TO_ONE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for DeleteUniqueIdErrorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteUniqueIdErrorType) Values() []DeleteUniqueIdErrorType { return []DeleteUniqueIdErrorType{ "SERVICE_ERROR", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for DeleteUniqueIdStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteUniqueIdStatus) Values() []DeleteUniqueIdStatus { return []DeleteUniqueIdStatus{ "COMPLETED", @@ -64,8 +67,9 @@ const ( ) // Values returns all known values for IdMappingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdMappingType) Values() []IdMappingType { return []IdMappingType{ "PROVIDER", @@ -81,8 +85,9 @@ const ( ) // Values returns all known values for IdNamespaceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdNamespaceType) Values() []IdNamespaceType { return []IdNamespaceType{ "SOURCE", @@ -98,8 +103,9 @@ const ( ) // Values returns all known values for IncrementalRunType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IncrementalRunType) Values() []IncrementalRunType { return []IncrementalRunType{ "IMMEDIATE", @@ -117,8 +123,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -138,8 +145,9 @@ const ( ) // Values returns all known values for ResolutionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolutionType) Values() []ResolutionType { return []ResolutionType{ "RULE_MATCHING", @@ -175,8 +183,9 @@ const ( ) // Values returns all known values for SchemaAttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaAttributeType) Values() []SchemaAttributeType { return []SchemaAttributeType{ "NAME", @@ -211,8 +220,9 @@ const ( ) // Values returns all known values for ServiceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceType) Values() []ServiceType { return []ServiceType{ "ASSIGNMENT", @@ -229,8 +239,9 @@ const ( ) // Values returns all known values for StatementEffect. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatementEffect) Values() []StatementEffect { return []StatementEffect{ "Allow", diff --git a/service/entityresolution/types/types.go b/service/entityresolution/types/types.go index 63f9c9a4002..59c0ea9f350 100644 --- a/service/entityresolution/types/types.go +++ b/service/entityresolution/types/types.go @@ -11,7 +11,7 @@ import ( // The deleted unique ID. type DeletedUniqueId struct { - // The unique ID of the deleted item. + // The unique ID of the deleted item. // // This member is required. UniqueId *string @@ -22,7 +22,7 @@ type DeletedUniqueId struct { // The Delete Unique Id error. type DeleteUniqueIdError struct { - // The error type for the batch delete unique ID operation. + // The error type for the batch delete unique ID operation. // // This member is required. ErrorType DeleteUniqueIdErrorType @@ -108,10 +108,13 @@ type IdMappingWorkflowInputSource struct { // The name of the schema to be retrieved. SchemaName *string - // The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE - // contains configurations for sourceId data that will be processed in an ID - // mapping workflow. The TARGET contains a configuration of targetId to which all - // sourceIds will resolve to. + // The type of ID namespace. There are two types: SOURCE and TARGET . + // + // The SOURCE contains configurations for sourceId data that will be processed in + // an ID mapping workflow. + // + // The TARGET contains a configuration of targetId to which all sourceIds will + // resolve to. Type IdNamespaceType noSmithyDocumentSerde @@ -207,10 +210,13 @@ type IdNamespaceSummary struct { // This member is required. IdNamespaceName *string - // The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE - // contains configurations for sourceId data that will be processed in an ID - // mapping workflow. The TARGET contains a configuration of targetId to which all - // sourceIds will resolve to. + // The type of ID namespace. There are two types: SOURCE and TARGET . + // + // The SOURCE contains configurations for sourceId data that will be processed in + // an ID mapping workflow. + // + // The TARGET contains a configuration of targetId to which all sourceIds will + // resolve to. // // This member is required. Type IdNamespaceType @@ -668,10 +674,11 @@ type SchemaInputAttribute struct { Type SchemaAttributeType // A string that instructs Entity Resolution to combine several columns into a - // unified column with the identical attribute type. For example, when working with - // columns such as first_name , middle_name , and last_name , assigning them a - // common groupName will prompt Entity Resolution to concatenate them into a - // single value. + // unified column with the identical attribute type. + // + // For example, when working with columns such as first_name , middle_name , and + // last_name , assigning them a common groupName will prompt Entity Resolution to + // concatenate them into a single value. GroupName *string // A key that allows grouping of multiple input attributes into a unified matching diff --git a/service/eventbridge/api_op_CreateApiDestination.go b/service/eventbridge/api_op_CreateApiDestination.go index b00d8e10974..7212b5ef4d0 100644 --- a/service/eventbridge/api_op_CreateApiDestination.go +++ b/service/eventbridge/api_op_CreateApiDestination.go @@ -13,9 +13,14 @@ import ( ) // Creates an API destination, which is an HTTP invocation endpoint configured as -// a target for events. API destinations do not support private destinations, such -// as interface VPC endpoints. For more information, see API destinations (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) -// in the EventBridge User Guide. +// a target for events. +// +// API destinations do not support private destinations, such as interface VPC +// endpoints. +// +// For more information, see [API destinations] in the EventBridge User Guide. +// +// [API destinations]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html 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_CreateConnection.go b/service/eventbridge/api_op_CreateConnection.go index 19e0c3c7d39..ab33fe0c176 100644 --- a/service/eventbridge/api_op_CreateConnection.go +++ b/service/eventbridge/api_op_CreateConnection.go @@ -37,8 +37,9 @@ type CreateConnectionInput struct { // This member is required. AuthParameters *types.CreateConnectionAuthRequestParameters - // The type of authorization to use for the connection. OAUTH tokens are refreshed - // when a 401 or 407 response is returned. + // The type of authorization to use for the connection. + // + // OAUTH tokens are refreshed when a 401 or 407 response is returned. // // This member is required. AuthorizationType types.ConnectionAuthorizationType diff --git a/service/eventbridge/api_op_CreateEndpoint.go b/service/eventbridge/api_op_CreateEndpoint.go index 2757cf6b0f4..6dd52523dbf 100644 --- a/service/eventbridge/api_op_CreateEndpoint.go +++ b/service/eventbridge/api_op_CreateEndpoint.go @@ -35,8 +35,9 @@ func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput type CreateEndpointInput struct { - // Define the event buses used. The names of the event buses must be identical in - // each Region. + // Define the event buses used. + // + // The names of the event buses must be identical in each Region. // // This member is required. EventBuses []types.EndpointEventBus diff --git a/service/eventbridge/api_op_CreateEventBus.go b/service/eventbridge/api_op_CreateEventBus.go index 1a0d8cb0d95..2e8a5dbbee4 100644 --- a/service/eventbridge/api_op_CreateEventBus.go +++ b/service/eventbridge/api_op_CreateEventBus.go @@ -31,12 +31,15 @@ func (c *Client) CreateEventBus(ctx context.Context, params *CreateEventBusInput type CreateEventBusInput struct { - // The name of the new event bus. Custom event bus names can't contain the / - // character, but you can use the / character in partner event bus names. In - // addition, for partner event buses, the name must exactly match the name of the - // partner event source that this event bus is matched to. You can't use the name - // default for a custom event bus, as this name is already used for your account's - // default event bus. + // The name of the new event bus. + // + // Custom event bus names can't contain the / character, but you can use the / + // character in partner event bus names. In addition, for partner event buses, the + // name must exactly match the name of the partner event source that this event bus + // is matched to. + // + // You can't use the name default for a custom event bus, as this name is already + // used for your account's default event bus. // // This member is required. Name *string diff --git a/service/eventbridge/api_op_CreatePartnerEventSource.go b/service/eventbridge/api_op_CreatePartnerEventSource.go index c4a9f6db578..57f621c028b 100644 --- a/service/eventbridge/api_op_CreatePartnerEventSource.go +++ b/service/eventbridge/api_op_CreatePartnerEventSource.go @@ -11,25 +11,38 @@ import ( ) // Called by an SaaS partner to create a partner event source. This operation is -// not used by Amazon Web Services customers. Each partner event source can be used -// by one Amazon Web Services account to create a matching partner event bus in -// that Amazon Web Services account. A SaaS partner must create one partner event -// source for each Amazon Web Services account that wants to receive those event -// types. A partner event source creates events based on resources within the SaaS -// partner's service or application. An Amazon Web Services account that creates a -// 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 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 should uniquely identify an -// event-generating resource within the partner system. The event_name must be -// unique across all Amazon Web Services customers. This is because the event -// source is a shared resource between the partner and customer accounts, and each -// partner event source unique in the partner account. +// not used by Amazon Web Services customers. +// +// Each partner event source can be used by one Amazon Web Services account to +// create a matching partner event bus in that Amazon Web Services account. A SaaS +// partner must create one partner event source for each Amazon Web Services +// account that wants to receive those event types. +// +// A partner event source creates events based on resources within the SaaS +// partner's service or application. +// +// An Amazon Web Services account that creates a 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 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 should uniquely identify an +// event-generating resource within the partner system. +// +// The event_name must be unique across all Amazon Web Services customers. This is +// +// because the event source is a shared resource between the partner and customer +// accounts, and each partner event source unique in the partner account. // // The combination of event_namespace and event_name should help Amazon Web // Services customers decide whether to create an event bus to receive these diff --git a/service/eventbridge/api_op_DeactivateEventSource.go b/service/eventbridge/api_op_DeactivateEventSource.go index a53c1479afc..ff5c0df0667 100644 --- a/service/eventbridge/api_op_DeactivateEventSource.go +++ b/service/eventbridge/api_op_DeactivateEventSource.go @@ -11,11 +11,14 @@ import ( ) // You can use this operation to temporarily stop receiving events from the -// 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) -// . +// 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]. +// +// [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 f58059adfe1..2a67e09f450 100644 --- a/service/eventbridge/api_op_DeleteEndpoint.go +++ b/service/eventbridge/api_op_DeleteEndpoint.go @@ -11,9 +11,9 @@ import ( ) // 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. +// endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication]in the Amazon EventBridge User Guide. +// +// [Making applications Regional-fault tolerant with global endpoints and event replication]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-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/eventbridge/api_op_DeletePartnerEventSource.go b/service/eventbridge/api_op_DeletePartnerEventSource.go index fa73e32a036..103e2e95e07 100644 --- a/service/eventbridge/api_op_DeletePartnerEventSource.go +++ b/service/eventbridge/api_op_DeletePartnerEventSource.go @@ -11,9 +11,10 @@ import ( ) // This operation is used by SaaS partners to delete a partner event source. This -// operation is not used by Amazon Web Services customers. When you delete an event -// source, the status of the corresponding partner event bus in the Amazon Web -// Services customer account becomes DELETED. +// operation is not used by Amazon Web Services customers. +// +// When you delete an event source, the status of the corresponding partner event +// bus in the Amazon Web Services customer account becomes DELETED. func (c *Client) DeletePartnerEventSource(ctx context.Context, params *DeletePartnerEventSourceInput, optFns ...func(*Options)) (*DeletePartnerEventSourceOutput, error) { if params == nil { params = &DeletePartnerEventSourceInput{} diff --git a/service/eventbridge/api_op_DeleteRule.go b/service/eventbridge/api_op_DeleteRule.go index 4845cd1c281..3e7999b40e2 100644 --- a/service/eventbridge/api_op_DeleteRule.go +++ b/service/eventbridge/api_op_DeleteRule.go @@ -10,17 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// is returned. Managed rules are rules created and managed by another Amazon Web -// Services service on your behalf. These rules are created by those other Amazon -// Web Services services to support functionality in those services. You can delete +// Deletes the specified rule. +// +// Before you can delete the rule, you must remove all targets, using [RemoveTargets]. +// +// 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 is returned. +// +// Managed rules are rules created and managed by another Amazon Web Services +// service on your behalf. These rules are created by those other Amazon Web +// Services services to support functionality in those services. You can delete // these rules using the Force option, but you should do so only if you are sure // the other service is not still using that rule. +// +// [RemoveTargets]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} diff --git a/service/eventbridge/api_op_DescribeEndpoint.go b/service/eventbridge/api_op_DescribeEndpoint.go index a0c3026e35b..32cf13f673d 100644 --- a/service/eventbridge/api_op_DescribeEndpoint.go +++ b/service/eventbridge/api_op_DescribeEndpoint.go @@ -13,9 +13,9 @@ 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) -// in the Amazon EventBridge User Guide. +// about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication]in the Amazon EventBridge User Guide. +// +// [Making applications Regional-fault tolerant with global endpoints and event replication]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-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/eventbridge/api_op_DescribeEventBus.go b/service/eventbridge/api_op_DescribeEventBus.go index 69687c549b0..09130939183 100644 --- a/service/eventbridge/api_op_DescribeEventBus.go +++ b/service/eventbridge/api_op_DescribeEventBus.go @@ -13,11 +13,15 @@ import ( // Displays details about an event bus in your account. This can include the // external Amazon Web Services accounts that are permitted to write events to your // 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) -// . +// 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]. +// +// For more information about partner event buses, see [CreateEventBus]. +// +// [PutPermission]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html +// [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{} diff --git a/service/eventbridge/api_op_DescribePartnerEventSource.go b/service/eventbridge/api_op_DescribePartnerEventSource.go index aef9fc6a4b5..5caec6c7ceb 100644 --- a/service/eventbridge/api_op_DescribePartnerEventSource.go +++ b/service/eventbridge/api_op_DescribePartnerEventSource.go @@ -12,8 +12,10 @@ 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) -// to see details about a partner event source that is shared with them. +// operation. Instead, Amazon Web Services customers can use [DescribeEventSource]to see details about +// a partner event source that is shared with them. +// +// [DescribeEventSource]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html func (c *Client) DescribePartnerEventSource(ctx context.Context, params *DescribePartnerEventSourceInput, optFns ...func(*Options)) (*DescribePartnerEventSourceOutput, error) { if params == nil { params = &DescribePartnerEventSourceInput{} diff --git a/service/eventbridge/api_op_DescribeRule.go b/service/eventbridge/api_op_DescribeRule.go index b147825c524..21cbaccc659 100644 --- a/service/eventbridge/api_op_DescribeRule.go +++ b/service/eventbridge/api_op_DescribeRule.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Describes the specified rule. +// +// DescribeRule does not list the targets of a rule. To see the targets associated +// with a rule, use [ListTargetsByRule]. +// +// [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{} @@ -61,8 +64,10 @@ 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) - // in the Amazon EventBridge User Guide. + // The event pattern. For more information, see [Events and Event Patterns] in the Amazon EventBridge User + // Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html EventPattern *string // If this is a managed rule, created by an Amazon Web Services service on your diff --git a/service/eventbridge/api_op_DisableRule.go b/service/eventbridge/api_op_DisableRule.go index d9c2471d372..b9fcaf823eb 100644 --- a/service/eventbridge/api_op_DisableRule.go +++ b/service/eventbridge/api_op_DisableRule.go @@ -11,9 +11,10 @@ import ( ) // Disables the specified rule. A disabled rule won't match any events, and won't -// self-trigger if it has a schedule expression. When you disable a rule, incoming -// events might continue to match to the disabled rule. Allow a short period of -// time for changes to take effect. +// self-trigger if it has a schedule expression. +// +// When you disable a rule, incoming events might continue to match to the +// disabled rule. Allow a short period of time for changes to take effect. func (c *Client) DisableRule(ctx context.Context, params *DisableRuleInput, optFns ...func(*Options)) (*DisableRuleOutput, error) { if params == nil { params = &DisableRuleInput{} diff --git a/service/eventbridge/api_op_EnableRule.go b/service/eventbridge/api_op_EnableRule.go index a5433f527a7..19ecb307444 100644 --- a/service/eventbridge/api_op_EnableRule.go +++ b/service/eventbridge/api_op_EnableRule.go @@ -11,6 +11,7 @@ import ( ) // Enables the specified rule. If the rule does not exist, the operation fails. +// // When you enable a rule, incoming events might not immediately start matching to // a newly enabled rule. Allow a short period of time for changes to take effect. func (c *Client) EnableRule(ctx context.Context, params *EnableRuleInput, optFns ...func(*Options)) (*EnableRuleOutput, error) { diff --git a/service/eventbridge/api_op_ListEndpoints.go b/service/eventbridge/api_op_ListEndpoints.go index 92779275e70..30cf62e447f 100644 --- a/service/eventbridge/api_op_ListEndpoints.go +++ b/service/eventbridge/api_op_ListEndpoints.go @@ -12,9 +12,9 @@ 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) -// in the Amazon EventBridge User Guide. +// about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication]in the Amazon EventBridge User Guide. +// +// [Making applications Regional-fault tolerant with global endpoints and event replication]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error) { if params == nil { params = &ListEndpointsInput{} diff --git a/service/eventbridge/api_op_ListEventSources.go b/service/eventbridge/api_op_ListEventSources.go index 8341a0d30bd..227d18d65fb 100644 --- a/service/eventbridge/api_op_ListEventSources.go +++ b/service/eventbridge/api_op_ListEventSources.go @@ -13,8 +13,9 @@ import ( // 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) -// . +// sources, see [CreateEventBus]. +// +// [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_ListRuleNamesByTarget.go b/service/eventbridge/api_op_ListRuleNamesByTarget.go index a43c76407ee..535e216aef2 100644 --- a/service/eventbridge/api_op_ListRuleNamesByTarget.go +++ b/service/eventbridge/api_op_ListRuleNamesByTarget.go @@ -11,8 +11,9 @@ import ( ) // Lists the rules for the specified target. You can see which of the rules in -// Amazon EventBridge can invoke a specific target in your account. The maximum -// number of results per page for requests is 100. +// Amazon EventBridge can invoke a specific target in your account. +// +// The maximum number of results per page for requests is 100. func (c *Client) ListRuleNamesByTarget(ctx context.Context, params *ListRuleNamesByTargetInput, optFns ...func(*Options)) (*ListRuleNamesByTargetOutput, error) { if params == nil { params = &ListRuleNamesByTargetInput{} diff --git a/service/eventbridge/api_op_ListRules.go b/service/eventbridge/api_op_ListRules.go index 09665811457..853c79cd4a1 100644 --- a/service/eventbridge/api_op_ListRules.go +++ b/service/eventbridge/api_op_ListRules.go @@ -12,10 +12,14 @@ 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. The maximum number of results -// per page for requests is 100. 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) -// . +// can provide a prefix to match to the rule names. +// +// The maximum number of results per page for requests is 100. +// +// ListRules does not list the targets of a rule. To see the targets associated +// with a rule, use [ListTargetsByRule]. +// +// [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{} diff --git a/service/eventbridge/api_op_ListTargetsByRule.go b/service/eventbridge/api_op_ListTargetsByRule.go index 931e62cb503..8607e6f1da6 100644 --- a/service/eventbridge/api_op_ListTargetsByRule.go +++ b/service/eventbridge/api_op_ListTargetsByRule.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the targets assigned to the specified rule. The maximum number of results -// per page for requests is 100. +// Lists the targets assigned to the specified rule. +// +// The maximum number of results per page for requests is 100. func (c *Client) ListTargetsByRule(ctx context.Context, params *ListTargetsByRuleInput, optFns ...func(*Options)) (*ListTargetsByRuleOutput, error) { if params == nil { params = &ListTargetsByRuleInput{} diff --git a/service/eventbridge/api_op_PutEvents.go b/service/eventbridge/api_op_PutEvents.go index 10d45142c99..8a0aa5bc3e6 100644 --- a/service/eventbridge/api_op_PutEvents.go +++ b/service/eventbridge/api_op_PutEvents.go @@ -13,14 +13,19 @@ import ( ) // Sends custom events to Amazon EventBridge so that they can be matched to rules. -// The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated -// including the event and any necessary characters and keys of the JSON -// representation of the event. To learn more, see Calculating PutEvents event -// entry size (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html) -// in the Amazon EventBridge User Guide PutEvents accepts the data in JSON format. -// For the JSON number (integer) data type, the constraints are: a minimum value of -// -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807. +// +// The maximum size for a PutEvents event entry is 256 KB. Entry size is +// calculated including the event and any necessary characters and keys of the JSON +// representation of the event. To learn more, see [Calculating PutEvents event entry size]in the Amazon EventBridge User +// Guide +// +// PutEvents accepts the data in JSON format. For the JSON number (integer) data +// type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a +// maximum value of 9,223,372,036,854,775,807. +// // PutEvents will only process nested JSON up to 1100 levels deep. +// +// [Calculating PutEvents event entry size]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html func (c *Client) PutEvents(ctx context.Context, params *PutEventsInput, optFns ...func(*Options)) (*PutEventsOutput, error) { if params == nil { params = &PutEventsInput{} @@ -47,7 +52,9 @@ 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 @@ -62,9 +69,10 @@ type PutEventsOutput struct { // The successfully and unsuccessfully ingested events results. If the ingestion // was successful, the entry has the event ID in it. Otherwise, you can use the - // error code and error message to identify the problem with the entry. For each - // record, the index of the response element is the same as the index in the - // request array. + // error code and error message to identify the problem with the entry. + // + // For each record, the index of the response element is the same as the index in + // the request array. Entries []types.PutEventsResultEntry // The number of failed entries. diff --git a/service/eventbridge/api_op_PutPartnerEvents.go b/service/eventbridge/api_op_PutPartnerEvents.go index 29520cf3e72..ba168de0a99 100644 --- a/service/eventbridge/api_op_PutPartnerEvents.go +++ b/service/eventbridge/api_op_PutPartnerEvents.go @@ -12,10 +12,12 @@ import ( ) // 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. For information on -// calculating event batch size, see Calculating EventBridge PutEvents event entry -// size (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html) -// in the EventBridge User Guide. +// bus. Amazon Web Services customers do not use this operation. +// +// For information on calculating event batch size, see [Calculating EventBridge PutEvents event entry size] in the EventBridge User +// Guide. +// +// [Calculating EventBridge PutEvents event entry size]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html func (c *Client) PutPartnerEvents(ctx context.Context, params *PutPartnerEventsInput, optFns ...func(*Options)) (*PutPartnerEventsOutput, error) { if params == nil { params = &PutPartnerEventsInput{} @@ -46,8 +48,10 @@ type PutPartnerEventsOutput struct { // The results for each event entry the partner submitted in this request. If the // event was successfully submitted, the entry has the event ID in it. Otherwise, // you can use the error code and error message to identify the problem with the - // entry. For each record, the index of the response element is the same as the - // index in the request array. + // entry. + // + // For each record, the index of the response element is the same as the index in + // the request array. Entries []types.PutPartnerEventsResultEntry // The number of events from this operation that could not be written to the diff --git a/service/eventbridge/api_op_PutPermission.go b/service/eventbridge/api_op_PutPermission.go index 29d91440dfc..21439035349 100644 --- a/service/eventbridge/api_op_PutPermission.go +++ b/service/eventbridge/api_op_PutPermission.go @@ -14,20 +14,26 @@ import ( // Running PutPermission permits the specified Amazon Web Services account or // Amazon Web Services organization to put events to the specified event bus. // Amazon EventBridge (CloudWatch Events) rules in your account are triggered by -// these events arriving to an event bus in your account. For another account to -// send events to your account, that external account must have an EventBridge rule -// with your account's event bus as a target. To enable multiple Amazon Web -// 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 -// 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) -// in the Amazon EventBridge User Guide. The permission policy on the event bus -// cannot exceed 10 KB in size. +// these events arriving to an event bus in your account. +// +// For another account to send events to your account, that external account must +// have an EventBridge rule with your account's event bus as a target. +// +// To enable multiple Amazon Web 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 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] +// in the Amazon EventBridge User Guide. +// +// The permission policy on the event bus cannot exceed 10 KB in size. +// +// [Sending and Receiving Events Between Amazon Web Services Accounts]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error) { if params == nil { params = &PutPermissionInput{} @@ -50,12 +56,16 @@ 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) - // 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. + // organization. For more information about Amazon Web Services Organizations, see [What Is Amazon Web Services Organizations] + // 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. + // + // [What Is Amazon Web Services Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html Condition *types.Condition // The name of the event bus associated with the rule. If you omit this, the @@ -69,17 +79,22 @@ type PutPermissionInput struct { // 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 - // 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. + // events to your default event bus. + // + // If you specify "*" without specifying 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. Principal *string // 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]. + // + // Each StatementId must be unique. + // + // [RemovePermission]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html StatementId *string noSmithyDocumentSerde diff --git a/service/eventbridge/api_op_PutRule.go b/service/eventbridge/api_op_PutRule.go index 2565c57b665..ca9f516ab7a 100644 --- a/service/eventbridge/api_op_PutRule.go +++ b/service/eventbridge/api_op_PutRule.go @@ -12,48 +12,64 @@ import ( ) // 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 +// on value of the state. You can disable a rule using [DisableRule]. +// +// 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 +// created. For more information, see [CreateEventBus]. +// +// 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 +// 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 +// 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]and [UntagResource]. +// +// 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. +// // In EventBridge, it is possible to create rules that lead to infinite loops, // where a rule is fired repeatedly. For example, a rule might detect that ACLs // have changed on an S3 bucket, and trigger software to change them to the desired // state. If the rule is not written carefully, the subsequent change to the ACLs -// fires the rule again, creating an infinite loop. To prevent this, write the -// rules so that the triggered actions do not re-fire the same rule. For example, -// your rule could fire only if ACLs are found to be in a bad state, instead of -// 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) -// . +// fires the rule again, creating an infinite loop. +// +// To prevent this, write the rules so that the triggered actions do not re-fire +// the same rule. For example, your rule could fire only if ACLs are found to be in +// a bad state, instead of 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]. +// +// [CreateEventBus]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html +// [TagResource]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html +// [UntagResource]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html +// [DisableRule]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html +// [Managing Your Costs with 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{} @@ -83,15 +99,18 @@ 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) - // in the Amazon EventBridge User Guide. + // The event pattern. For more information, see [Amazon EventBridge event patterns] in the Amazon EventBridge User + // Guide. + // + // [Amazon EventBridge event patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html EventPattern *string - // The Amazon Resource Name (ARN) of the IAM role associated with the rule. If - // you're setting an event bus in another account as the target and that account - // granted permission to your account through an organization instead of directly - // by the account ID, you must specify a RoleArn with proper permissions in the - // Target structure, instead of here in this parameter. + // The Amazon Resource Name (ARN) of the IAM role associated with the rule. + // + // If you're setting an event bus in another account as the target and that + // account granted permission to your account through an organization instead of + // directly by the account ID, you must specify a RoleArn with proper permissions + // in the Target structure, instead of here in this parameter. RoleArn *string // The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 diff --git a/service/eventbridge/api_op_PutTargets.go b/service/eventbridge/api_op_PutTargets.go index dded981391a..9b5a5e2a174 100644 --- a/service/eventbridge/api_op_PutTargets.go +++ b/service/eventbridge/api_op_PutTargets.go @@ -12,74 +12,104 @@ import ( ) // 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. The maximum number of entries per request is -// 10. Each rule can have up to five (5) targets associated with it at one time. -// For a list of services you can configure as targets for events, see EventBridge -// targets (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) -// in the Amazon EventBridge User Guide. Creating rules with built-in targets is -// supported only in the Amazon Web Services Management Console. The built-in -// targets are: +// they are already associated with the rule. +// +// Targets are the resources that are invoked when a rule is triggered. +// +// The maximum number of entries per request is 10. +// +// Each rule can have up to five (5) targets associated with it at one time. +// +// For a list of services you can configure as targets for events, see [EventBridge targets] in the +// Amazon EventBridge User Guide. +// +// Creating rules with built-in targets is supported only in the Amazon Web +// Services Management Console. The built-in targets are: +// // - Amazon EBS CreateSnapshot API call +// // - Amazon EC2 RebootInstances API call +// // - Amazon EC2 StopInstances API call +// // - Amazon 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 +// 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 -// 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 -// 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 -// 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) -// in the Amazon EventBridge User Guide. If you have an IAM role on a cross-account -// event bus target, a PutTargets call without a role on the same target (same Id -// and Arn ) will not remove the role. 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 +// For more information, see [Authentication and Access Control] 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 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 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]. +// +// 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] in the Amazon +// EventBridge User Guide. +// +// If you have an IAM role on a cross-account event bus target, a PutTargets call +// without a role on the same target (same Id and Arn ) will not remove the role. +// +// For more information about enabling cross-account events, see [PutPermission]. +// +// 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. +// 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. +// +// [Authentication and Access Control]: https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html +// [Amazon EventBridge Pricing]: http://aws.amazon.com/eventbridge/pricing/ +// [Sending and Receiving Events Between Amazon Web Services Accounts]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html +// [PutPermission]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html +// [EventBridge targets]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html func (c *Client) PutTargets(ctx context.Context, params *PutTargetsInput, optFns ...func(*Options)) (*PutTargetsOutput, error) { if params == nil { params = &PutTargetsInput{} diff --git a/service/eventbridge/api_op_RemovePermission.go b/service/eventbridge/api_op_RemovePermission.go index e4c379e9411..7f2c723b540 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]. +// +// [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 a751f7c491c..b591e0451e5 100644 --- a/service/eventbridge/api_op_RemoveTargets.go +++ b/service/eventbridge/api_op_RemoveTargets.go @@ -12,15 +12,21 @@ import ( ) // Removes the specified targets from the specified rule. When the rule is -// triggered, those targets are no longer be invoked. A successful execution of -// RemoveTargets doesn't guarantee all targets are removed from the rule, it means -// that the target(s) listed in the request are removed. When you remove a target, -// when the associated rule triggers, removed targets might continue to be 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. The maximum number of -// entries per request is 10. +// triggered, those targets are no longer be invoked. +// +// A successful execution of RemoveTargets doesn't guarantee all targets are +// removed from the rule, it means that the target(s) listed in the request are +// removed. +// +// When you remove a target, when the associated rule triggers, removed targets +// might continue to be 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. +// +// The maximum number of entries per request is 10. func (c *Client) RemoveTargets(ctx context.Context, params *RemoveTargetsInput, optFns ...func(*Options)) (*RemoveTargetsOutput, error) { if params == nil { params = &RemoveTargetsInput{} diff --git a/service/eventbridge/api_op_TagResource.go b/service/eventbridge/api_op_TagResource.go index c986b22de81..045352300ed 100644 --- a/service/eventbridge/api_op_TagResource.go +++ b/service/eventbridge/api_op_TagResource.go @@ -15,13 +15,18 @@ import ( // resource. 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. In EventBridge, rules and event -// buses can be tagged. 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 specify a new -// tag key, this tag is appended to the list of tags associated with the resource. -// 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. +// buses can be tagged. +// +// 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 specify a new tag key, this tag is appended to the list of tags associated +// with the resource. 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/eventbridge/api_op_TestEventPattern.go b/service/eventbridge/api_op_TestEventPattern.go index 355ce7e4eee..fc669b5b5a0 100644 --- a/service/eventbridge/api_op_TestEventPattern.go +++ b/service/eventbridge/api_op_TestEventPattern.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tests whether the specified event pattern matches the provided event. 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 +// Tests whether the specified event pattern matches the provided event. +// +// 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. func (c *Client) TestEventPattern(ctx context.Context, params *TestEventPatternInput, optFns ...func(*Options)) (*TestEventPatternOutput, error) { @@ -33,21 +34,31 @@ 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: + // follow the format specified in [Amazon Web Services Events], and the following fields are mandatory: + // // - id + // // - account + // // - source + // // - time + // // - region + // // - resources + // // - detail-type // + // [Amazon Web Services Events]: https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html + // // 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) - // in the Amazon EventBridge User Guide. + // The event pattern. For more information, see [Events and Event Patterns] in the Amazon EventBridge User + // Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html // // This member is required. EventPattern *string diff --git a/service/eventbridge/api_op_UpdateEndpoint.go b/service/eventbridge/api_op_UpdateEndpoint.go index efded9f6d30..100aeaa4204 100644 --- a/service/eventbridge/api_op_UpdateEndpoint.go +++ b/service/eventbridge/api_op_UpdateEndpoint.go @@ -11,10 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Update an existing endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication] // in the Amazon EventBridge User Guide. +// +// [Making applications Regional-fault tolerant with global endpoints and event replication]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-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/eventbridge/doc.go b/service/eventbridge/doc.go index ad6f02dd9f8..7b239f3e303 100644 --- a/service/eventbridge/doc.go +++ b/service/eventbridge/doc.go @@ -9,14 +9,17 @@ // 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. // -// 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]. +// +// [Amazon EventBridge User Guide]: https://docs.aws.amazon.com/eventbridge/latest/userguide package eventbridge diff --git a/service/eventbridge/options.go b/service/eventbridge/options.go index 8784fd46d99..2e117ad292a 100644 --- a/service/eventbridge/options.go +++ b/service/eventbridge/options.go @@ -52,8 +52,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -72,17 +74,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -102,8 +107,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -151,6 +157,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/eventbridge/types/enums.go b/service/eventbridge/types/enums.go index c523583a1bb..eff29168488 100644 --- a/service/eventbridge/types/enums.go +++ b/service/eventbridge/types/enums.go @@ -17,6 +17,7 @@ const ( // 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{ @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for ApiDestinationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiDestinationState) Values() []ApiDestinationState { return []ApiDestinationState{ "ACTIVE", @@ -61,8 +63,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -83,8 +86,9 @@ const ( ) // Values returns all known values for AssignPublicIp. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignPublicIp) Values() []AssignPublicIp { return []AssignPublicIp{ "ENABLED", @@ -103,6 +107,7 @@ const ( // Values returns all known values for ConnectionAuthorizationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionAuthorizationType) Values() []ConnectionAuthorizationType { return []ConnectionAuthorizationType{ @@ -123,6 +128,7 @@ const ( // Values returns all known values for ConnectionOAuthHttpMethod. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionOAuthHttpMethod) Values() []ConnectionOAuthHttpMethod { return []ConnectionOAuthHttpMethod{ @@ -146,8 +152,9 @@ const ( ) // Values returns all known values for ConnectionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionState) Values() []ConnectionState { return []ConnectionState{ "CREATING", @@ -174,8 +181,9 @@ const ( ) // Values returns all known values for EndpointState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointState) Values() []EndpointState { return []EndpointState{ "ACTIVE", @@ -198,8 +206,9 @@ const ( ) // Values returns all known values for EventSourceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourceState) Values() []EventSourceState { return []EventSourceState{ "PENDING", @@ -218,8 +227,9 @@ const ( ) // Values returns all known values for LaunchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchType) Values() []LaunchType { return []LaunchType{ "EC2", @@ -237,8 +247,9 @@ const ( ) // Values returns all known values for PlacementConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementConstraintType) Values() []PlacementConstraintType { return []PlacementConstraintType{ "distinctInstance", @@ -256,8 +267,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "random", @@ -274,8 +286,9 @@ const ( ) // Values returns all known values for PropagateTags. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropagateTags) Values() []PropagateTags { return []PropagateTags{ "TASK_DEFINITION", @@ -295,8 +308,9 @@ const ( ) // Values returns all known values for ReplayState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplayState) Values() []ReplayState { return []ReplayState{ "STARTING", @@ -317,8 +331,9 @@ const ( ) // Values returns all known values for ReplicationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationState) Values() []ReplicationState { return []ReplicationState{ "ENABLED", @@ -336,8 +351,9 @@ const ( ) // 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. +// in the future, and so 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/types.go b/service/eventbridge/types/types.go index 3f0f6608c51..a8dfac38b0c 100644 --- a/service/eventbridge/types/types.go +++ b/service/eventbridge/types/types.go @@ -45,8 +45,11 @@ type ApiDestination struct { type AppSyncParameters struct { // The GraphQL operation; that is, the query, mutation, or subscription to be - // parsed and executed by the GraphQL service. For more information, see Operations (https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations) - // in the AppSync User Guide. + // parsed and executed by the GraphQL service. + // + // For more information, see [Operations] in the AppSync User Guide. + // + // [Operations]: https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations GraphQLOperation *string noSmithyDocumentSerde @@ -162,9 +165,10 @@ type BatchRetryStrategy struct { noSmithyDocumentSerde } -// The details of a capacity provider strategy. To learn more, see -// CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) -// in the Amazon ECS API Reference. +// The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem] in the Amazon +// ECS API Reference. +// +// [CapacityProviderStrategyItem]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html type CapacityProviderStrategyItem struct { // The short name of the capacity provider. @@ -191,8 +195,10 @@ type CapacityProviderStrategyItem struct { // 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"}' +// 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 @@ -219,8 +225,9 @@ type Condition struct { // Contains information about a connection. type Connection struct { - // The authorization type specified for the connection. OAUTH tokens are refreshed - // when a 401 or 407 response is returned. + // The authorization type specified for the connection. + // + // OAUTH tokens are refreshed when a 401 or 407 response is returned. AuthorizationType ConnectionAuthorizationType // The ARN of the connection. @@ -494,20 +501,23 @@ type DeadLetterConfig struct { // The custom parameters to be used when the target is an Amazon ECS task. type EcsParameters struct { - // The ARN of the task definition to use if the event target is an Amazon ECS task. + // The ARN of the task definition to use if the event target is an Amazon ECS + // task. // // This member is required. TaskDefinitionArn *string - // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be + // 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 // 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Tagging Your Amazon ECS Resources]in the Amazon Elastic Container Service Developer Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags bool // Whether or not to enable the execute command functionality for the containers @@ -521,14 +531,17 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // with Amazon ECS is supported. For more information, see [Fargate on Amazon ECS]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Fargate on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html LaunchType LaunchType // Use this structure if the Amazon ECS task uses the awsvpc network mode. This // structure specifies the VPC subnets and security groups associated with the // task, and whether a public IP address is to be used. This structure is required // if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. + // // If you specify NetworkConfiguration when the target ECS task does not use the // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration @@ -543,10 +556,13 @@ type EcsParameters struct { 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // Specifies whether to propagate the tags from the task definition to the task. @@ -560,8 +576,9 @@ 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) - // in the Amazon ECS API Reference. + // define. To learn more, see [RunTask]in the Amazon ECS API Reference. + // + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags Tags []Tag // The number of tasks to create based on TaskDefinition . The default is 1. @@ -571,10 +588,10 @@ type EcsParameters struct { } // 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) -// in the Amazon EventBridge User Guide. +// regional-fault tolerant. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication]in +// the Amazon EventBridge User Guide. +// +// [Making applications Regional-fault tolerant with global endpoints and event replication]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html type Endpoint struct { // The ARN of the endpoint. @@ -733,27 +750,46 @@ 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: + // 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": + // . + // + // "InputTransformer": + // // { // // "InputPathsMap": {"instance": "$.detail.instance","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"}, // // "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": @@ -768,10 +804,13 @@ type InputTransformer struct { // Map of JSON paths to be extracted from the event. You can then insert these in // the template in InputTemplate to produce the output you want to be sent to the - // target. InputPathsMap is an array key-value pairs, where each value is a valid - // JSON path. You can have as many as 100 key-value pairs. You must use JSON dot - // notation, not bracket notation. The keys cannot start with "Amazon Web - // Services." + // target. + // + // InputPathsMap is an array key-value pairs, where each value is a valid JSON + // path. You can have as many as 100 key-value pairs. You must use JSON dot + // notation, not bracket notation. + // + // The keys cannot start with "Amazon Web Services." InputPathsMap map[string]string noSmithyDocumentSerde @@ -784,8 +823,9 @@ type InputTransformer struct { 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) - // in the Amazon Kinesis Streams Developer Guide. + // more information, see [Amazon Kinesis Streams Key Concepts]in the Amazon Kinesis Streams Developer Guide. + // + // [Amazon Kinesis Streams Key Concepts]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key // // This member is required. PartitionKeyPath *string @@ -841,15 +881,17 @@ type PartnerEventSourceAccount struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// An object representing a constraint on task placement. To learn more, see [Task Placement Constraints] in +// the Amazon Elastic Container Service Developer Guide. +// +// [Task Placement Constraints]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // more, see [Cluster Query Language]in the Amazon Elastic Container Service Developer Guide. + // + // [Cluster Query Language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html Expression *string // The type of constraint. Use distinctInstance to ensure that each task in a @@ -860,9 +902,10 @@ type PlacementConstraint struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Service Developer Guide. +// The task placement strategy for a task or service. To learn more, see [Task Placement Strategies] in the +// Amazon Elastic Container Service Service Developer Guide. +// +// [Task Placement Strategies]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement @@ -901,80 +944,126 @@ type Primary struct { type PutEventsRequestEntry struct { // A valid JSON object. There is no other schema imposed. The JSON object may - // contain fields and nested sub-objects. Detail , DetailType , and Source are - // required for EventBridge to successfully send an event to an event bus. If you - // include event entries in a request that do not include each of those properties, - // EventBridge fails that entry. If you submit a request in which none of the - // entries have each of these properties, EventBridge fails the entire request. + // contain fields and nested sub-objects. + // + // Detail , DetailType , and Source are required for EventBridge to successfully + // send an event to an event bus. If you include event entries in a request that do + // not include each of those properties, EventBridge fails that entry. If you + // submit a request in which none of the entries have each of these properties, + // EventBridge fails the entire request. Detail *string // Free-form string, with a maximum of 128 characters, used to decide what fields - // to expect in the event detail. Detail , DetailType , and Source are required - // for EventBridge to successfully send an event to an event bus. If you include - // event entries in a request that do not include each of those properties, - // EventBridge fails that entry. If you submit a request in which none of the - // entries have each of these properties, EventBridge fails the entire request. + // to expect in the event detail. + // + // Detail , DetailType , and Source are required for EventBridge to successfully + // send an event to an event bus. If you include event entries in a request that do + // not include each of those properties, EventBridge fails that entry. If you + // submit a request in which none of the entries have each of these properties, + // EventBridge fails the entire request. DetailType *string // The name or ARN of the event bus to receive the event. Only the rules that are // associated with this event bus are used to match the event. If you omit this, - // the default event bus is used. If you're using a global endpoint with a custom - // bus, you can enter either the name or Amazon Resource Name (ARN) of the event - // bus in either the primary or secondary Region here. EventBridge then determines - // the corresponding event bus in the other Region based on the endpoint referenced - // by the EndpointId . Specifying the event bus ARN is preferred. + // the default event bus is used. + // + // If you're using a global endpoint with a custom bus, you can enter either the + // name or Amazon Resource Name (ARN) of the event bus in either the primary or + // secondary Region here. EventBridge then determines the corresponding event bus + // in the other Region based on the endpoint referenced by the EndpointId . + // Specifying the event bus ARN is preferred. EventBusName *string // Amazon Web Services resources, identified by Amazon Resource Name (ARN), which // the event primarily concerns. Any number, including zero, may be present. Resources []string - // The source of the event. Detail , DetailType , and Source are required for - // EventBridge to successfully send an event to an event bus. If you include event - // entries in a request that do not include each of those properties, EventBridge - // fails that entry. If you submit a request in which none of the entries have each - // of these properties, EventBridge fails the entire request. + // The source of the event. + // + // Detail , DetailType , and Source are required for EventBridge to successfully + // send an event to an event bus. If you include event entries in a request that do + // not include each of those properties, EventBridge fails that entry. If you + // submit a request in which none of the entries have each of these properties, + // EventBridge fails the entire request. 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) - // call is used. + // The time stamp of the event, per [RFC3339]. If no time stamp is provided, the time stamp + // of the [PutEvents]call is used. + // + // [PutEvents]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html + // [RFC3339]: https://www.rfc-editor.org/rfc/rfc3339.txt 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) - // in the X-Ray Developer Guide. + // the trace-id associated with the event. + // + // To learn more about X-Ray trace headers, see [Tracing header] in the X-Ray Developer Guide. + // + // [Tracing header]: https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader TraceHeader *string noSmithyDocumentSerde } -// Represents the results of an event submitted to an event bus. If the submission -// was successful, the entry has the event ID in it. Otherwise, you can use the -// error code and error message to identify the problem with the entry. For -// information about the errors that are common to all actions, see Common Errors (https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html) -// . +// Represents the results of an event submitted to an event bus. +// +// If the submission was successful, the entry has the event ID in it. Otherwise, +// you can use the error code and error message to identify the problem with the +// entry. +// +// For information about the errors that are common to all actions, see [Common Errors]. +// +// [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. Retryable errors - // include: - // - InternalFailure (https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html) - // The request processing has failed because of an unknown error, exception or + // The error code that indicates why the event submission failed. + // + // Retryable errors include: + // + // [InternalFailure] + // + // - The request processing has failed because of an unknown error, exception or // failure. - // - ThrottlingException (https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html) - // The request was denied due to request throttling. + // + // [ThrottlingException] + // + // - The request was denied due to request throttling. + // // Non-retryable errors include: - // - AccessDeniedException (https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html) - // You do not have sufficient access to perform this action. - // - InvalidAccountIdException The account ID provided is not valid. - // - InvalidArgument A specified parameter is not valid. - // - MalformedDetail The JSON provided is not valid. - // - RedactionFailure Redacting the CloudTrail event failed. - // - NotAuthorizedForSourceException You do not have permissions to publish - // events with this source onto this event bus. - // - NotAuthorizedForDetailTypeException You do not have permissions to publish - // events with this detail type onto this event bus. + // + // [AccessDeniedException] + // + // - You do not have sufficient access to perform this action. + // + // - InvalidAccountIdException + // + // The account ID provided is not valid. + // + // - InvalidArgument + // + // A specified parameter is not valid. + // + // - MalformedDetail + // + // The JSON provided is not valid. + // + // - RedactionFailure + // + // Redacting the CloudTrail event failed. + // + // - NotAuthorizedForSourceException + // + // You do not have permissions to publish events with this source onto this event + // bus. + // + // - NotAuthorizedForDetailTypeException + // + // You do not have permissions to publish events with this detail type onto this + // event bus. + // + // [AccessDeniedException]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html + // [InternalFailure]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html + // [ThrottlingException]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html ErrorCode *string // The error message that explains why the event submission failed. @@ -990,31 +1079,36 @@ type PutEventsResultEntry struct { type PutPartnerEventsRequestEntry struct { // A valid JSON string. There is no other schema imposed. The JSON string may - // contain fields and nested sub-objects. Detail , DetailType , and Source are - // required for EventBridge to successfully send an event to an event bus. If you - // include event entries in a request that do not include each of those properties, - // EventBridge fails that entry. If you submit a request in which none of the - // entries have each of these properties, EventBridge fails the entire request. + // contain fields and nested sub-objects. + // + // Detail , DetailType , and Source are required for EventBridge to successfully + // send an event to an event bus. If you include event entries in a request that do + // not include each of those properties, EventBridge fails that entry. If you + // submit a request in which none of the entries have each of these properties, + // EventBridge fails the entire request. Detail *string // A free-form string, with a maximum of 128 characters, used to decide what - // fields to expect in the event detail. Detail , DetailType , and Source are - // required for EventBridge to successfully send an event to an event bus. If you - // include event entries in a request that do not include each of those properties, - // EventBridge fails that entry. If you submit a request in which none of the - // entries have each of these properties, EventBridge fails the entire request. + // fields to expect in the event detail. + // + // Detail , DetailType , and Source are required for EventBridge to successfully + // send an event to an event bus. If you include event entries in a request that do + // not include each of those properties, EventBridge fails that entry. If you + // submit a request in which none of the entries have each of these properties, + // EventBridge fails the entire request. DetailType *string // Amazon Web Services resources, identified by Amazon Resource Name (ARN), which // the event primarily concerns. Any number, including zero, may be present. Resources []string - // The event source that is generating the entry. Detail , DetailType , and Source - // are required for EventBridge to successfully send an event to an event bus. If - // you include event entries in a request that do not include each of those - // properties, EventBridge fails that entry. If you submit a request in which none - // of the entries have each of these properties, EventBridge fails the entire - // request. + // The event source that is generating the entry. + // + // Detail , DetailType , and Source are required for EventBridge to successfully + // send an event to an event bus. If you include event entries in a request that do + // not include each of those properties, EventBridge fails that entry. If you + // submit a request in which none of the entries have each of these properties, + // EventBridge fails the entire request. Source *string // The date and time of the event. @@ -1127,8 +1221,9 @@ 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]. + // + // [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. @@ -1212,9 +1307,10 @@ type Rule struct { // 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) - // in the Amazon EventBridge User Guide. + // The event pattern of the rule. For more information, see [Events and Event Patterns] in the Amazon + // EventBridge User Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html EventPattern *string // If the rule was created on behalf of your account by an Amazon Web Services @@ -1226,16 +1322,17 @@ type Rule struct { Name *string // The Amazon Resource Name (ARN) of the role that is used for target invocation. - // If you're setting an event bus in another account as the target and that account - // granted permission to your account through an organization instead of directly - // by the account ID, you must specify a RoleArn with proper permissions in the - // Target structure, instead of here in this parameter. + // + // If you're setting an event bus in another account as the target and that + // account granted permission to your account through an organization instead of + // directly by the account ID, you must specify a RoleArn with proper permissions + // in the 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) - // . + // minutes)". For more information, see [Creating an Amazon EventBridge rule that runs on a schedule]. + // + // [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. @@ -1345,14 +1442,16 @@ type Tag struct { } // 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 +// complete list of services and resources that can be set as a target, see [PutTargets]. +// +// 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) -// in the Amazon EventBridge User Guide. +// permissions in the Target structure. For more information, see [Sending and Receiving Events Between Amazon Web Services Accounts] in the Amazon +// EventBridge User Guide. +// +// [Sending and Receiving Events Between Amazon Web Services Accounts]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html +// [PutTargets]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html type Target struct { // The Amazon Resource Name (ARN) of the target. @@ -1371,8 +1470,9 @@ type Target struct { AppSyncParameters *AppSyncParameters // 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. + // name, and other parameters. For more information, see [Jobs]in the Batch User Guide. + // + // [Jobs]: https://docs.aws.amazon.com/batch/latest/userguide/jobs.html BatchParameters *BatchParameters // The DeadLetterConfig that defines the target queue to send dead-letter queue @@ -1380,30 +1480,34 @@ type Target struct { DeadLetterConfig *DeadLetterConfig // 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) + // target is an Amazon ECS task. For more information about Amazon ECS tasks, see [Task Definitions] // in the Amazon EC2 Container Service Developer Guide. + // + // [Task Definitions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html 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 - // 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 - // have these values configured. In case of any conflicting keys, values from the - // Connection take precedence. + // 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 have these values + // configured. In case of any conflicting keys, values from the Connection take + // precedence. HttpParameters *HttpParameters // 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) - // . + // itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format]. + // + // [The JavaScript Object 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]. + // + // [JSONPath]: http://goessner.net/articles/JsonPath/ InputPath *string // Settings to enable you to provide custom input to a target based on certain @@ -1417,9 +1521,11 @@ type Target struct { KinesisParameters *KinesisParameters // Contains the Amazon Redshift Data API parameters to use when the target is a - // Amazon Redshift cluster. If you specify a Amazon Redshift Cluster as a Target, - // you can use this to specify parameters to invoke the Amazon Redshift Data API - // ExecuteStatement based on EventBridge events. + // Amazon Redshift cluster. + // + // If you specify a Amazon Redshift Cluster as a Target, you can use this to + // specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based + // on EventBridge events. RedshiftDataParameters *RedshiftDataParameters // The RetryPolicy object that contains the retry policy configuration to use for @@ -1435,13 +1541,16 @@ type Target struct { RunCommandParameters *RunCommandParameters // Contains the SageMaker Model Building Pipeline parameters to start execution of - // a SageMaker Model Building Pipeline. If you specify a SageMaker Model Building - // Pipeline as a target, you can use this to specify parameters to start a pipeline - // execution based on EventBridge events. + // a SageMaker Model Building Pipeline. + // + // If you specify a SageMaker Model Building Pipeline as a target, you can use + // this to specify parameters to start a pipeline execution based on EventBridge + // events. SageMakerPipelineParameters *SageMakerPipelineParameters - // Contains the message group ID to use when the target is a FIFO queue. If you - // specify an SQS FIFO queue as a target, the queue must have content-based + // Contains the message group ID to use when the target is a FIFO queue. + // + // If you specify an SQS FIFO queue as a target, the queue must have content-based // deduplication enabled. SqsParameters *SqsParameters diff --git a/service/evidently/api_op_BatchEvaluateFeature.go b/service/evidently/api_op_BatchEvaluateFeature.go index 6a383e9b433..a9438487040 100644 --- a/service/evidently/api_op_BatchEvaluateFeature.go +++ b/service/evidently/api_op_BatchEvaluateFeature.go @@ -13,20 +13,27 @@ 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 -// 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 -// 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 there is an ongoing -// experiment for this feature, the user might be assigned to a variation in the -// experiment. The chance of this depends on the percentage of users that are -// allocated to that experiment. If the user is enrolled in the experiment, the +// 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 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 experiment. If the user is not assigned to a launch or -// experiment, they are served the default variation. +// variations used for the launch. +// +// If the user is not assigned to a launch, and there is an ongoing experiment for +// this feature, the user might be assigned to a variation in the experiment. The +// chance of this depends on the percentage of users that are allocated to that +// experiment. If the user is enrolled in the experiment, the variation they are +// served depends on the allocation of the various feature variations used for the +// experiment. +// +// If the user is not assigned to a launch or experiment, they are served the +// default variation. func (c *Client) BatchEvaluateFeature(ctx context.Context, params *BatchEvaluateFeatureInput, optFns ...func(*Options)) (*BatchEvaluateFeatureOutput, error) { if params == nil { params = &BatchEvaluateFeatureInput{} diff --git a/service/evidently/api_op_CreateExperiment.go b/service/evidently/api_op_CreateExperiment.go index ccc666881fb..b3fe535ed29 100644 --- a/service/evidently/api_op_CreateExperiment.go +++ b/service/evidently/api_op_CreateExperiment.go @@ -12,16 +12,20 @@ import ( ) // Creates an Evidently experiment. Before you create an experiment, you must -// create the feature to use for the experiment. An experiment helps you make -// feature design decisions based on evidence and data. An experiment can test as -// many as five variations at once. Evidently collects experiment data and analyzes -// it by statistical methods, and provides clear recommendations about which -// variations perform better. You can optionally specify a segment to have the -// 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) -// . +// create the feature to use for the experiment. +// +// An experiment helps you make feature design decisions based on evidence and +// data. An experiment can test as many as five variations at once. Evidently +// collects experiment data and analyzes it by statistical methods, and provides +// clear recommendations about which variations perform better. +// +// You can optionally specify a segment to have the 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]. +// +// [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{} @@ -80,8 +84,10 @@ type CreateExperimentInput struct { // The portion of the available audience that you want to allocate to this // experiment, in thousandths of a percent. The available audience is the total // audience minus the audience that you have allocated to overrides or current - // launches of this feature. This is represented in thousandths of a percent. For - // example, specify 10,000 to allocate 10% of the available audience. + // launches of this feature. + // + // This is represented in thousandths of a percent. For example, specify 10,000 to + // allocate 10% of the available audience. SamplingRate *int64 // Specifies an audience segment to use in the experiment. When a segment is used @@ -89,14 +95,20 @@ type CreateExperimentInput struct { // the experiment. Segment *string - // Assigns one or more tags (key-value pairs) to the experiment. 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 experiment. For more information, see - // Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) - // . + // Assigns one or more tags (key-value pairs) to the experiment. + // + // 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 experiment. + // + // For more information, see [Tagging Amazon Web Services resources]. + // + // [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 c7656d7a73b..acdc63f92dd 100644 --- a/service/evidently/api_op_CreateFeature.go +++ b/service/evidently/api_op_CreateFeature.go @@ -14,10 +14,12 @@ 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]. +// +// Don't use this operation to update an existing feature. Instead, use [UpdateFeature]. +// +// [UpdateFeature]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html +// [CreateProject]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html func (c *Client) CreateFeature(ctx context.Context, params *CreateFeatureInput, optFns ...func(*Options)) (*CreateFeatureOutput, error) { if params == nil { params = &CreateFeatureInput{} @@ -53,9 +55,12 @@ type CreateFeatureInput struct { // 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. + // 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. @@ -64,9 +69,10 @@ type CreateFeatureInput struct { // Specify users that should always be served a specific variation of a feature. // Each user is specified by a key-value pair . For each key, specify a user by // entering their user ID, account ID, or some other identifier. For the value, - // specify the name of the variation that they are to be served. This parameter is - // limited to 2500 overrides or a total of 40KB. The 40KB limit includes an - // overhead of 6 bytes per override. + // specify the name of the variation that they are to be served. + // + // This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit + // includes an overhead of 6 bytes per override. EntityOverrides map[string]string // Specify ALL_RULES to activate the traffic allocation specified by any ongoing @@ -74,14 +80,20 @@ type CreateFeatureInput struct { // variation to all users instead. EvaluationStrategy types.FeatureEvaluationStrategy - // Assigns one or more tags (key-value pairs) to the feature. 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 a feature. For more information, see Tagging - // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) - // . + // Assigns one or more tags (key-value pairs) to the feature. + // + // 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 a feature. + // + // For more information, see [Tagging Amazon Web Services resources]. + // + // [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_CreateLaunch.go b/service/evidently/api_op_CreateLaunch.go index 75770ee4190..d744489a7ae 100644 --- a/service/evidently/api_op_CreateLaunch.go +++ b/service/evidently/api_op_CreateLaunch.go @@ -12,14 +12,17 @@ import ( ) // 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) -// . +// 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]. +// +// [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{} @@ -71,14 +74,20 @@ type CreateLaunchInput struct { // feature variations during each step of the launch. ScheduledSplitsConfig *types.ScheduledSplitsLaunchConfig - // Assigns one or more tags (key-value pairs) to the launch. 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 a launch. For more information, see Tagging - // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) - // . + // Assigns one or more tags (key-value pairs) to the launch. + // + // 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 a launch. + // + // For more information, see [Tagging Amazon Web Services resources]. + // + // [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_CreateProject.go b/service/evidently/api_op_CreateProject.go index 9fee399cbdc..56f775c33da 100644 --- a/service/evidently/api_op_CreateProject.go +++ b/service/evidently/api_op_CreateProject.go @@ -13,8 +13,11 @@ 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]. +// +// [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,14 +42,18 @@ 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) - // 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) + // to user sessions locally instead of by calling the [EvaluateFeature]operation. This mitigates + // the latency and availability risks that come with an API call. For more + // information, see [Client-side evaluation - powered by AppConfig.] + // // 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 + // 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 // evidently:ExportProjectAsConfiguration permission. + // + // [Client-side evaluation - powered by AppConfig.]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html + // [EvaluateFeature]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html AppConfigResource *types.ProjectAppConfigResourceConfig // A structure that contains information about where Evidently is to store @@ -58,14 +65,20 @@ type CreateProjectInput struct { // An optional description of the project. Description *string - // Assigns one or more tags (key-value pairs) to the project. 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 a project. For more information, see Tagging - // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) - // . + // Assigns one or more tags (key-value pairs) to the project. + // + // 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 a project. + // + // For more information, see [Tagging Amazon Web Services resources]. + // + // [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_CreateSegment.go b/service/evidently/api_op_CreateSegment.go index 5a7ca4d614f..d7df2a5cb11 100644 --- a/service/evidently/api_op_CreateSegment.go +++ b/service/evidently/api_op_CreateSegment.go @@ -14,14 +14,21 @@ import ( // Use this operation to define a segment of your audience. A segment is a portion // of your audience that share one or more characteristics. Examples could be // Chrome browser users, users in Europe, or Firefox browser users in Europe who -// also fit other criteria that your application collects, such as age. Using a -// 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) -// operation, when Evidently assigns a feature variation to a user. +// also fit other criteria that your application collects, such as age. +// +// Using a 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]. +// +// The pattern that you define for a segment is matched against the value of +// evaluationContext , which is passed into Evidently in the [EvaluateFeature] operation, when +// Evidently assigns a feature variation to a user. +// +// [Segment rule pattern syntax]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html +// [EvaluateFeature]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html func (c *Client) CreateSegment(ctx context.Context, params *CreateSegmentInput, optFns ...func(*Options)) (*CreateSegmentOutput, error) { if params == nil { params = &CreateSegmentInput{} @@ -45,8 +52,9 @@ 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]. + // + // [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 // @@ -56,14 +64,20 @@ type CreateSegmentInput struct { // An optional description for this segment. Description *string - // Assigns one or more tags (key-value pairs) to the segment. 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 a segment. For more information, see Tagging - // Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) - // . + // Assigns one or more tags (key-value pairs) to the segment. + // + // 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 a segment. + // + // For more information, see [Tagging Amazon Web Services resources]. + // + // [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_DeleteExperiment.go b/service/evidently/api_op_DeleteExperiment.go index 066f55ab7a1..3de62c60083 100644 --- a/service/evidently/api_op_DeleteExperiment.go +++ b/service/evidently/api_op_DeleteExperiment.go @@ -11,8 +11,11 @@ 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]. +// +// [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 4f1175888ca..6d26731f571 100644 --- a/service/evidently/api_op_DeleteLaunch.go +++ b/service/evidently/api_op_DeleteLaunch.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Deletes an Evidently launch. The feature used for the launch is not deleted. +// +// To stop a launch without deleting it, use [StopLaunch]. +// +// [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 4a140d9f4b1..dab51e49168 100644 --- a/service/evidently/api_op_DeleteProject.go +++ b/service/evidently/api_op_DeleteProject.go @@ -11,9 +11,9 @@ 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) -// . +// all the features that the project contains. To delete a feature, use [DeleteFeature]. +// +// [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 06581c89c6d..934382e1131 100644 --- a/service/evidently/api_op_EvaluateFeature.go +++ b/service/evidently/api_op_EvaluateFeature.go @@ -13,27 +13,40 @@ import ( // This operation assigns a feature variation to one given 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 evaluated are the -// override rules. If the user's entityID matches an override rule, the user is -// served the variation specified by that rule. If there is a current launch with -// 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 +// 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. +// +// If there is a current launch with 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]and [Use segments to focus your audience]. +// +// 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 -// there is an ongoing experiment for this feature, the user might be assigned to a -// variation in the experiment. The chance of this depends on the percentage of -// users that are allocated to that experiment. If the experiment uses a segment, -// then only user sessions with evaluationContext values that match the segment -// rule are used in the experiment. If the user is enrolled in the experiment, the -// variation they are served depends on the allocation of the various feature -// variations used for the experiment. If the user is not assigned to a launch or -// experiment, they are served the default variation. +// variations used for the launch. +// +// If the user is not assigned to a launch, and there is an ongoing experiment for +// this feature, the user might be assigned to a variation in the experiment. The +// chance of this depends on the percentage of users that are allocated to that +// experiment. +// +// If the experiment uses a segment, then only user sessions with evaluationContext +// values that match the segment rule are used in the experiment. +// +// If the user is enrolled in the experiment, the variation they are served +// depends on the allocation of the various feature variations used for the +// experiment. +// +// If the user is not assigned to a launch or experiment, they are served the +// default variation. +// +// [Use segments to focus your audience]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html +// [CreateSegment]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html func (c *Client) EvaluateFeature(ctx context.Context, params *EvaluateFeatureInput, optFns ...func(*Options)) (*EvaluateFeatureOutput, error) { if params == nil { params = &EvaluateFeatureInput{} @@ -70,9 +83,12 @@ 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]. + // + // If you include this parameter, the value must be a JSON object. A JSON array is + // not supported. + // + // [Use segments to focus your audience]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html // // This value conforms to the media type: application/json EvaluationContext *string diff --git a/service/evidently/api_op_GetExperiment.go b/service/evidently/api_op_GetExperiment.go index 6d9ec7e4ae6..ebf717a87a8 100644 --- a/service/evidently/api_op_GetExperiment.go +++ b/service/evidently/api_op_GetExperiment.go @@ -12,8 +12,9 @@ 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]. +// +// [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 ce5e9537dd2..4ab353a18b2 100644 --- a/service/evidently/api_op_GetExperimentResults.go +++ b/service/evidently/api_op_GetExperimentResults.go @@ -18,9 +18,11 @@ import ( // statistical power, Evidently performs an additional offline p-value analysis at // the end of the experiment. Offline p-value analysis can detect statistical // significance in some cases where the anytime p-values used during the experiment -// do not find statistical significance. Experiment results are available up to 63 -// days after the start of the experiment. They are not available after that -// because of CloudWatch data retention policies. +// do not find statistical significance. +// +// Experiment results are available up to 63 days after the start of the +// experiment. They are not available after that because of CloudWatch data +// retention policies. func (c *Client) GetExperimentResults(ctx context.Context, params *GetExperimentResultsInput, optFns ...func(*Options)) (*GetExperimentResultsOutput, error) { if params == nil { params = &GetExperimentResultsInput{} @@ -75,17 +77,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 diff --git a/service/evidently/api_op_GetFeature.go b/service/evidently/api_op_GetFeature.go index 23292db16cd..27c7545e11f 100644 --- a/service/evidently/api_op_GetFeature.go +++ b/service/evidently/api_op_GetFeature.go @@ -12,8 +12,9 @@ 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]. +// +// [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 349b44a2ab5..3768dbf6913 100644 --- a/service/evidently/api_op_GetLaunch.go +++ b/service/evidently/api_op_GetLaunch.go @@ -12,8 +12,9 @@ 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]. +// +// [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 3225737ded6..5d0d20509ee 100644 --- a/service/evidently/api_op_GetProject.go +++ b/service/evidently/api_op_GetProject.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// To retrieve a list of projects in your account, use [ListProjects]. +// +// [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_StartExperiment.go b/service/evidently/api_op_StartExperiment.go index 9df395eb8a8..10768e3a1eb 100644 --- a/service/evidently/api_op_StartExperiment.go +++ b/service/evidently/api_op_StartExperiment.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} diff --git a/service/evidently/api_op_StartLaunch.go b/service/evidently/api_op_StartLaunch.go index 94dc796d9cc..3eaf0349e59 100644 --- a/service/evidently/api_op_StartLaunch.go +++ b/service/evidently/api_op_StartLaunch.go @@ -11,8 +11,9 @@ 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]. +// +// [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 5e5cc6854f1..a9e5d11ff64 100644 --- a/service/evidently/api_op_TagResource.go +++ b/service/evidently/api_op_TagResource.go @@ -12,17 +12,25 @@ import ( // 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 -// specify a new tag key for the resource, this tag is appended to the list of tags -// 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) -// . +// 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 specify a new tag key for the resource, this tag is appended to the list of +// tags 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]. +// +// [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 7ac82af2bf2..0d1eb751648 100644 --- a/service/evidently/api_op_TestSegmentPattern.go +++ b/service/evidently/api_op_TestSegmentPattern.go @@ -11,8 +11,9 @@ 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]. +// +// [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 61cf28c8987..0fec2998c97 100644 --- a/service/evidently/api_op_UpdateExperiment.go +++ b/service/evidently/api_op_UpdateExperiment.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates an Evidently experiment. +// +// Don't use this operation to update an experiment's tag. Instead, use [TagResource]. +// +// [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{} @@ -69,8 +71,10 @@ type UpdateExperimentInput struct { // The portion of the available audience that you want to allocate to this // experiment, in thousandths of a percent. The available audience is the total // audience minus the audience that you have allocated to overrides or current - // launches of this feature. This is represented in thousandths of a percent. For - // example, specify 20,000 to allocate 20% of the available audience. + // launches of this feature. + // + // This is represented in thousandths of a percent. For example, specify 20,000 to + // allocate 20% of the available audience. SamplingRate *int64 // Adds an audience segment to an experiment. When a segment is used in an diff --git a/service/evidently/api_op_UpdateFeature.go b/service/evidently/api_op_UpdateFeature.go index 5c9e7ee4b6a..efc4fd7de30 100644 --- a/service/evidently/api_op_UpdateFeature.go +++ b/service/evidently/api_op_UpdateFeature.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates an existing feature. +// +// You can't use this operation to update the tags of an existing feature. +// Instead, use [TagResource]. +// +// [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{} @@ -59,9 +62,10 @@ type UpdateFeatureInput struct { // Specified users that should always be served a specific variation of a feature. // Each user is specified by a key-value pair . For each key, specify a user by // entering their user ID, account ID, or some other identifier. For the value, - // specify the name of the variation that they are to be served. This parameter is - // limited to 2500 overrides or a total of 40KB. The 40KB limit includes an - // overhead of 6 bytes per override. + // specify the name of the variation that they are to be served. + // + // This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit + // includes an overhead of 6 bytes per override. EntityOverrides map[string]string // Specify ALL_RULES to activate the traffic allocation specified by any ongoing @@ -70,9 +74,10 @@ type UpdateFeatureInput struct { EvaluationStrategy types.FeatureEvaluationStrategy // Removes a variation from the feature. If the variation you specify doesn't - // exist, then this makes no change and does not report an error. This operation - // fails if you try to remove a variation that is part of an ongoing launch or - // experiment. + // exist, then this makes no change and does not report an error. + // + // This operation fails if you try to remove a variation that is part of an + // ongoing launch or experiment. RemoveVariations []string noSmithyDocumentSerde diff --git a/service/evidently/api_op_UpdateLaunch.go b/service/evidently/api_op_UpdateLaunch.go index b5f1d9769d3..b1ff0415448 100644 --- a/service/evidently/api_op_UpdateLaunch.go +++ b/service/evidently/api_op_UpdateLaunch.go @@ -11,9 +11,12 @@ 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] // . +// +// [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{} diff --git a/service/evidently/api_op_UpdateProject.go b/service/evidently/api_op_UpdateProject.go index ed63d1e9c41..cda68f48216 100644 --- a/service/evidently/api_op_UpdateProject.go +++ b/service/evidently/api_op_UpdateProject.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates the description of an existing project. +// +// To create a new project, use [CreateProject]. +// +// Don't use this operation to update the data storage options of a project. +// Instead, use [UpdateProjectDataDelivery]. +// +// Don't use this operation to update the tags of a project. Instead, use [TagResource]. +// +// [TagResource]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html +// [CreateProject]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html +// [UpdateProjectDataDelivery]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProjectDataDelivery.html func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error) { if params == nil { params = &UpdateProjectInput{} @@ -42,10 +47,13 @@ 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) - // 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. + // to user sessions locally instead of by calling the [EvaluateFeature]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. + // + // [EvaluateFeature]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html AppConfigResource *types.ProjectAppConfigResourceConfig // An optional description of the project. diff --git a/service/evidently/api_op_UpdateProjectDataDelivery.go b/service/evidently/api_op_UpdateProjectDataDelivery.go index 04e73300c1e..ba091e0981f 100644 --- a/service/evidently/api_op_UpdateProjectDataDelivery.go +++ b/service/evidently/api_op_UpdateProjectDataDelivery.go @@ -14,8 +14,9 @@ import ( // Updates the data storage options for this project. If you store evaluation // events, you an keep them and analyze them on your own. If you choose not to // store evaluation events, Evidently deletes them after using them to produce -// metrics and other experiment results that you can view. You can't specify both -// cloudWatchLogs and s3Destination in the same operation. +// metrics and other experiment results that you can view. +// +// You can't specify both cloudWatchLogs and s3Destination in the same operation. func (c *Client) UpdateProjectDataDelivery(ctx context.Context, params *UpdateProjectDataDeliveryInput, optFns ...func(*Options)) (*UpdateProjectDataDeliveryOutput, error) { if params == nil { params = &UpdateProjectDataDeliveryInput{} diff --git a/service/evidently/doc.go b/service/evidently/doc.go index 75772314da5..1e2adc033b2 100644 --- a/service/evidently/doc.go +++ b/service/evidently/doc.go @@ -7,10 +7,11 @@ // 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 your users. This helps you reduce risk and identify -// unintended consequences before you fully launch the feature. You can also -// conduct A/B experiments to make feature design decisions based on evidence and -// data. An experiment can test as many as five variations at once. Evidently -// collects experiment data and analyzes it using statistical methods. It also -// provides clear recommendations about which variations perform better. You can -// test both user-facing features and backend features. +// unintended consequences before you fully launch the feature. +// +// You can also conduct A/B experiments to make feature design decisions based on +// evidence and data. An experiment can test as many as five variations at once. +// Evidently collects experiment data and analyzes it using statistical methods. It +// also provides clear recommendations about which variations perform better. You +// can test both user-facing features and backend features. package evidently diff --git a/service/evidently/options.go b/service/evidently/options.go index d48d85e5264..4113303dd6d 100644 --- a/service/evidently/options.go +++ b/service/evidently/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/evidently/types/enums.go b/service/evidently/types/enums.go index b377910c4f9..8f792effc41 100644 --- a/service/evidently/types/enums.go +++ b/service/evidently/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ChangeDirectionEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeDirectionEnum) Values() []ChangeDirectionEnum { return []ChangeDirectionEnum{ "INCREASE", @@ -29,8 +30,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for ExperimentBaseStat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentBaseStat) Values() []ExperimentBaseStat { return []ExperimentBaseStat{ "Mean", @@ -62,8 +65,9 @@ const ( ) // Values returns all known values for ExperimentReportName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentReportName) Values() []ExperimentReportName { return []ExperimentReportName{ "BayesianInference", @@ -82,6 +86,7 @@ const ( // Values returns all known values for ExperimentResultRequestType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentResultRequestType) Values() []ExperimentResultRequestType { return []ExperimentResultRequestType{ @@ -105,8 +110,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentResultResponseType) Values() []ExperimentResultResponseType { return []ExperimentResultResponseType{ "Mean", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for ExperimentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentStatus) Values() []ExperimentStatus { return []ExperimentStatus{ "CREATED", @@ -151,6 +158,7 @@ const ( // Values returns all known values for ExperimentStopDesiredState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentStopDesiredState) Values() []ExperimentStopDesiredState { return []ExperimentStopDesiredState{ @@ -167,8 +175,9 @@ const ( ) // Values returns all known values for ExperimentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentType) Values() []ExperimentType { return []ExperimentType{ "aws.evidently.onlineab", @@ -185,6 +194,7 @@ const ( // Values returns all known values for FeatureEvaluationStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FeatureEvaluationStrategy) Values() []FeatureEvaluationStrategy { return []FeatureEvaluationStrategy{ @@ -202,8 +212,9 @@ const ( ) // Values returns all known values for FeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureStatus) Values() []FeatureStatus { return []FeatureStatus{ "AVAILABLE", @@ -223,8 +234,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -244,8 +256,9 @@ const ( ) // Values returns all known values for LaunchStopDesiredState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchStopDesiredState) Values() []LaunchStopDesiredState { return []LaunchStopDesiredState{ "COMPLETED", @@ -261,8 +274,9 @@ const ( ) // Values returns all known values for LaunchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchType) Values() []LaunchType { return []LaunchType{ "aws.evidently.splits", @@ -278,8 +292,9 @@ const ( ) // Values returns all known values for ProjectStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectStatus) Values() []ProjectStatus { return []ProjectStatus{ "AVAILABLE", @@ -297,8 +312,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SegmentReferenceResourceType) Values() []SegmentReferenceResourceType { return []SegmentReferenceResourceType{ "EXPERIMENT", @@ -318,6 +334,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -339,8 +356,9 @@ const ( ) // Values returns all known values for VariationValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VariationValueType) Values() []VariationValueType { return []VariationValueType{ "STRING", diff --git a/service/evidently/types/types.go b/service/evidently/types/types.go index a83b6b50754..1cb54551f38 100644 --- a/service/evidently/types/types.go +++ b/service/evidently/types/types.go @@ -196,8 +196,10 @@ type Experiment struct { // In thousandths of a percent, the amount of the available audience that is // allocated to this experiment. The available audience is the total audience minus // the audience that you have allocated to overrides or current launches of this - // feature. This is represented in thousandths of a percent, so a value of 10,000 - // is 10% of the available audience. + // feature. + // + // This is represented in thousandths of a percent, so a value of 10,000 is 10% of + // the available audience. SamplingRate int64 // A structure that contains the time and date that Evidently completed the @@ -318,7 +320,9 @@ 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] + // + // [Variation types]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-variationtypes.html // // This member is required. ValueType VariationValueType @@ -331,9 +335,12 @@ 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 - // in the variations structure is used as the default variation. + // 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 // The description of the feature. @@ -342,9 +349,12 @@ type Feature struct { // A set of key-value pairs that specify users who should always be served a // 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) - // operation. + // 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]operation. + // + // [EvaluateFeature]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html EntityOverrides map[string]string // An array of structures that define the evaluation rules for the feature. @@ -547,10 +557,11 @@ type MetricDefinition struct { // value to be recorded. EntityIdKey *string - // 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) - // . + // The EventBridge event pattern that defines how the metric is recorded. + // + // For more information about EventBridge event patterns, see [Amazon EventBridge event patterns]. + // + // [Amazon EventBridge event patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html // // This value conforms to the media type: application/json EventPattern *string @@ -587,10 +598,11 @@ type MetricDefinitionConfig struct { // This member is required. ValueKey *string - // 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) - // . + // The EventBridge event pattern that defines how the metric is recorded. + // + // For more information about EventBridge event patterns, see [Amazon EventBridge event patterns]. + // + // [Amazon EventBridge event patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html // // This value conforms to the media type: application/json EventPattern *string @@ -611,8 +623,10 @@ type MetricGoal struct { MetricDefinition *MetricDefinition // INCREASE means that a variation with a higher number for this metric is - // performing better. DECREASE means that a variation with a lower number for this - // metric is performing better. + // performing better. + // + // DECREASE means that a variation with a lower number for this metric is + // performing better. DesiredChange ChangeDirectionEnum noSmithyDocumentSerde @@ -628,8 +642,10 @@ type MetricGoalConfig struct { MetricDefinition *MetricDefinitionConfig // INCREASE means that a variation with a higher number for this metric is - // performing better. DECREASE means that a variation with a lower number for this - // metric is performing better. + // performing better. + // + // DECREASE means that a variation with a lower number for this metric is + // performing better. DesiredChange ChangeDirectionEnum noSmithyDocumentSerde @@ -788,11 +804,13 @@ 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) -// 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 -// run client-side evaluation. +// sessions locally instead of by calling the [EvaluateFeature]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 run client-side evaluation. +// +// [EvaluateFeature]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html type ProjectAppConfigResourceConfig struct { // The ID of the AppConfig application to use for client-side evaluation. @@ -977,21 +995,26 @@ type ScheduledSplit struct { // The traffic allocation percentages among the feature variations during one step // of a launch. This is a set of key-value pairs. The keys are variation names. The // values represent the percentage of traffic to allocate to that variation during - // this step. The values is expressed in thousandths of a percent, so assigning a - // weight of 50000 assigns 50% of traffic to that variation. If the sum of the - // weights for all the variations in a segment override does not add up to 100,000, - // then the remaining traffic that matches this segment is not assigned by this - // segment override, and instead moves on to the next segment override or the - // default traffic split. + // this step. + // + // The values is expressed in thousandths of a percent, so assigning a weight of + // 50000 assigns 50% of traffic to that variation. + // + // If the sum of the weights for all the variations in a segment override does not + // add up to 100,000, then the remaining traffic that matches this segment is not + // assigned by this segment override, and instead moves on to the next segment + // override or the default traffic split. GroupWeights map[string]int64 // Use this parameter to specify different traffic splits for one or more audience // segments. A segment is a portion of your audience that share one or more // characteristics. Examples could be Chrome browser users, users in Europe, or // Firefox browser users in Europe who also fit other criteria that your - // application collects, such as age. This parameter is an array of up to six - // segment override objects. Each of these objects specifies a segment that you - // have already created, and defines the traffic split for that segment. + // application collects, such as age. + // + // This parameter is an array of up to six segment override objects. Each of these + // objects specifies a segment that you have already created, and defines the + // traffic split for that segment. SegmentOverrides []SegmentOverride noSmithyDocumentSerde @@ -1004,12 +1027,15 @@ type ScheduledSplitConfig struct { // The traffic allocation percentages among the feature variations during one step // of a launch. This is a set of key-value pairs. The keys are variation names. The // values represent the percentage of traffic to allocate to that variation during - // this step. The values is expressed in thousandths of a percent, so assigning a - // weight of 50000 assigns 50% of traffic to that variation. If the sum of the - // weights for all the variations in a segment override does not add up to 100,000, - // then the remaining traffic that matches this segment is not assigned by this - // segment override, and instead moves on to the next segment override or the - // default traffic split. + // this step. + // + // The values is expressed in thousandths of a percent, so assigning a weight of + // 50000 assigns 50% of traffic to that variation. + // + // If the sum of the weights for all the variations in a segment override does not + // add up to 100,000, then the remaining traffic that matches this segment is not + // assigned by this segment override, and instead moves on to the next segment + // override or the default traffic split. // // This member is required. GroupWeights map[string]int64 @@ -1023,9 +1049,11 @@ type ScheduledSplitConfig struct { // segments. A segment is a portion of your audience that share one or more // characteristics. Examples could be Chrome browser users, users in Europe, or // Firefox browser users in Europe who also fit other criteria that your - // application collects, such as age. This parameter is an array of up to six - // segment override objects. Each of these objects specifies a segment that you - // have already created, and defines the traffic split for that segment. + // application collects, such as age. + // + // This parameter is an array of up to six segment override objects. Each of these + // objects specifies a segment that you have already created, and defines the + // traffic split for that segment. SegmentOverrides []SegmentOverride noSmithyDocumentSerde @@ -1086,8 +1114,9 @@ type Segment struct { // 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) - // . + // see [Segment rule pattern syntax]. + // + // [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 // diff --git a/service/finspace/api_op_CreateEnvironment.go b/service/finspace/api_op_CreateEnvironment.go index 0a14e64e395..1ddc29677eb 100644 --- a/service/finspace/api_op_CreateEnvironment.go +++ b/service/finspace/api_op_CreateEnvironment.go @@ -38,8 +38,10 @@ 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. DataBundles []string @@ -48,8 +50,10 @@ type CreateEnvironmentInput 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. FederationMode types.FederationMode diff --git a/service/finspace/api_op_CreateKxChangeset.go b/service/finspace/api_op_CreateKxChangeset.go index fdae74f0868..6e946825c92 100644 --- a/service/finspace/api_op_CreateKxChangeset.go +++ b/service/finspace/api_op_CreateKxChangeset.go @@ -12,7 +12,8 @@ import ( "time" ) -// Creates a changeset for a kdb database. A changeset allows you to add and +// Creates a changeset for a kdb database. A changeset allows you to add and +// // delete existing files by using an ordered list of change requests. func (c *Client) CreateKxChangeset(ctx context.Context, params *CreateKxChangesetInput, optFns ...func(*Options)) (*CreateKxChangesetOutput, error) { if params == nil { @@ -34,28 +35,45 @@ type CreateKxChangesetInput struct { // A list of change request objects that are run in order. A change request object // consists of changeType , s3Path , and dbPath . A changeType can have the // following values: + // // - PUT – Adds or updates files in a database. + // // - DELETE – Deletes files in a database. + // // All the change requests require a mandatory dbPath attribute that defines the // path within the database directory. All database paths must start with a leading // / and end with a trailing /. The s3Path attribute defines the s3 source file // path and is required for a PUT change type. The s3path must end with a trailing - // / if it is a directory and must end without a trailing / if it is a file. Here - // are few examples of how you can use the change request object: - // - This request adds a single sym file at database root location. { - // "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"} + // / if it is a directory and must end without a trailing / if it is a file. + // + // Here are few examples of how you can use the change request object: + // + // - This request adds a single sym file at database root location. + // + // { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"} + // // - This request adds files in the given s3Path under the 2020.01.02 partition - // of the database. { "changeType": "PUT", - // "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"} + // of the database. + // + // { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", + // "dbPath":"/2020.01.02/"} + // // - This request adds files in the given s3Path under the taq table partition of - // the database. [ { "changeType": "PUT", - // "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}] - // - This request deletes the 2020.01.02 partition of the database. [{ - // "changeType": "DELETE", "dbPath": "/2020.01.02/"} ] + // the database. + // + // [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", + // "dbPath":"/2020.01.02/taq/"}] + // + // - This request deletes the 2020.01.02 partition of the database. + // + // [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ] + // // - The DELETE request allows you to delete the existing files under the // 2020.01.02 partition of the database, and the PUT request adds a new taq table - // under it. [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": - // "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}] + // under it. + // + // [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", + // "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}] // // This member is required. ChangeRequests []types.ChangeRequest @@ -107,9 +125,13 @@ type CreateKxChangesetOutput struct { LastModifiedTimestamp *time.Time // Status of the changeset creation process. + // // - Pending – Changeset creation is pending. + // // - Processing – Changeset creation is running. + // // - Failed – Changeset creation has failed. + // // - Complete – Changeset creation has succeeded. Status types.ChangesetStatus diff --git a/service/finspace/api_op_CreateKxCluster.go b/service/finspace/api_op_CreateKxCluster.go index fddd4ef28f8..712dd5f2207 100644 --- a/service/finspace/api_op_CreateKxCluster.go +++ b/service/finspace/api_op_CreateKxCluster.go @@ -32,7 +32,9 @@ type CreateKxClusterInput struct { // The number of availability zones you want to assign per cluster. This can be // one of the following + // // - SINGLE – Assigns one availability zone per cluster. + // // - MULTI – Assigns all the availability zones per cluster. // // This member is required. @@ -45,24 +47,29 @@ type CreateKxClusterInput struct { // Specifies the type of KDB database that is being created. The following types // are available: + // // - HDB – A Historical Database. The data is only accessible with read-only // permissions from one of the FinSpace managed kdb databases mounted to the // cluster. + // // - RDB – A Realtime Database. This type of database captures all the data from // a ticker plant and stores it in memory until the end of day, after which it // writes all of its data to a disk and reloads the HDB. This cluster type requires // local storage for temporary storage of data during the savedown process. If you // specify this field in your request, you must provide the // savedownStorageConfiguration parameter. + // // - GATEWAY – A gateway cluster allows you to access data across processes in // kdb systems. It allows you to create your own routing logic using the // initialization scripts and custom code. This type of cluster does not require a // writable local storage. + // // - GP – A general purpose cluster allows you to quickly iterate on code during // development by granting greater access to system commands and enabling a fast // reload of custom code. This cluster type can optionally mount databases // including cache and savedown storage. For this cluster type, the node count is // fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode. + // // - Tickerplant – A tickerplant cluster allows you to subscribe to feed // handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, // and real-time subscribers (RTS). Tickerplants can persist messages to log, which @@ -143,7 +150,7 @@ type CreateKxClusterInput struct { // cluster. Tags map[string]string - // A configuration to store Tickerplant logs. It consists of a list of volumes + // A configuration to store Tickerplant logs. It consists of a list of volumes // that will be mounted to your cluster. For the cluster type Tickerplant , the // location of the TP volume on the cluster will be available by using the global // variable .aws.tp_log_path . @@ -158,12 +165,14 @@ type CreateKxClusterOutput struct { // your cluster. AutoScalingConfiguration *types.AutoScalingConfiguration - // The availability zone identifiers for the requested regions. + // The availability zone identifiers for the requested regions. AvailabilityZoneId *string // The number of availability zones you want to assign per cluster. This can be // one of the following + // // - SINGLE – Assigns one availability zone per cluster. + // // - MULTI – Assigns all the availability zones per cluster. AzMode types.KxAzMode @@ -183,24 +192,29 @@ type CreateKxClusterOutput struct { // Specifies the type of KDB database that is being created. The following types // are available: + // // - HDB – A Historical Database. The data is only accessible with read-only // permissions from one of the FinSpace managed kdb databases mounted to the // cluster. + // // - RDB – A Realtime Database. This type of database captures all the data from // a ticker plant and stores it in memory until the end of day, after which it // writes all of its data to a disk and reloads the HDB. This cluster type requires // local storage for temporary storage of data during the savedown process. If you // specify this field in your request, you must provide the // savedownStorageConfiguration parameter. + // // - GATEWAY – A gateway cluster allows you to access data across processes in // kdb systems. It allows you to create your own routing logic using the // initialization scripts and custom code. This type of cluster does not require a // writable local storage. + // // - GP – A general purpose cluster allows you to quickly iterate on code during // development by granting greater access to system commands and enabling a fast // reload of custom code. This cluster type can optionally mount databases // including cache and savedown storage. For this cluster type, the node count is // fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode. + // // - Tickerplant – A tickerplant cluster allows you to subscribe to feed // handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, // and real-time subscribers (RTS). Tickerplants can persist messages to log, which @@ -228,7 +242,7 @@ type CreateKxClusterOutput struct { // A unique identifier for the kdb environment. EnvironmentId *string - // An IAM role that defines a set of permissions associated with a cluster. These + // An IAM role that defines a set of permissions associated with a cluster. These // permissions are assumed when a cluster attempts to access another cluster. ExecutionRole *string @@ -255,26 +269,34 @@ type CreateKxClusterOutput struct { ScalingGroupConfiguration *types.KxScalingGroupConfiguration // The status of cluster creation. + // // - PENDING – The cluster is pending creation. + // // - CREATING – The cluster creation process is in progress. + // // - CREATE_FAILED – The cluster creation process has failed. + // // - RUNNING – The cluster creation process is running. + // // - UPDATING – The cluster is in the process of being updated. + // // - DELETING – The cluster is in the process of being deleted. + // // - DELETED – The cluster has been deleted. + // // - DELETE_FAILED – The cluster failed to delete. Status types.KxClusterStatus // The error message when a failed state occurs. StatusReason *string - // A configuration to store the Tickerplant logs. It consists of a list of volumes - // that will be mounted to your cluster. For the cluster type Tickerplant , the - // location of the TP volume on the cluster will be available by using the global - // variable .aws.tp_log_path . + // A configuration to store the Tickerplant logs. It consists of a list of + // volumes that will be mounted to your cluster. For the cluster type Tickerplant , + // the location of the TP volume on the cluster will be available by using the + // global variable .aws.tp_log_path . TickerplantLogConfiguration *types.TickerplantLogConfiguration - // A list of volumes mounted on the cluster. + // A list of volumes mounted on the cluster. Volumes []types.Volume // Configuration details about the network where the Privatelink endpoint of the diff --git a/service/finspace/api_op_CreateKxDataview.go b/service/finspace/api_op_CreateKxDataview.go index f84dbb26835..b016e03058a 100644 --- a/service/finspace/api_op_CreateKxDataview.go +++ b/service/finspace/api_op_CreateKxDataview.go @@ -12,7 +12,8 @@ import ( "time" ) -// Creates a snapshot of kdb database with tiered storage capabilities and a +// Creates a snapshot of kdb database with tiered storage capabilities and a +// // pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only // available for clusters running on a scaling group. They are not supported on // dedicated clusters. @@ -44,7 +45,7 @@ type CreateKxDataviewInput struct { // This member is required. ClientToken *string - // The name of the database where you want to create a dataview. + // The name of the database where you want to create a dataview. // // This member is required. DatabaseName *string @@ -65,38 +66,42 @@ type CreateKxDataviewInput struct { // default value is false. AutoUpdate bool - // The identifier of the availability zones. + // The identifier of the availability zones. AvailabilityZoneId *string - // A unique identifier of the changeset that you want to use to ingest data. + // A unique identifier of the changeset that you want to use to ingest data. ChangesetId *string // A description of the dataview. Description *string - // The option to specify whether you want to make the dataview writable to perform - // database maintenance. The following are some considerations related to writable - // dataviews. + // The option to specify whether you want to make the dataview writable to + // perform database maintenance. The following are some considerations related to + // writable dataviews. + // // - You cannot create partial writable dataviews. When you create writeable // dataviews you must provide the entire database path. + // // - You cannot perform updates on a writeable dataview. Hence, autoUpdate must // be set as False if readWrite is True for a dataview. + // // - You must also use a unique volume for creating a writeable dataview. So, if // you choose a volume that is already in use by another dataview, the dataview // creation fails. + // // - Once you create a dataview as writeable, you cannot change it to read-only. // So, you cannot update the readWrite parameter later. ReadWrite bool - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. SegmentConfigurations []types.KxDataviewSegmentConfiguration - // A list of key-value pairs to label the dataview. You can add up to 50 tags to a - // dataview. + // A list of key-value pairs to label the dataview. You can add up to 50 tags to + // a dataview. Tags map[string]string noSmithyDocumentSerde @@ -109,7 +114,7 @@ type CreateKxDataviewOutput struct { // default value is false. AutoUpdate bool - // The identifier of the availability zones. + // The identifier of the availability zones. AvailabilityZoneId *string // The number of availability zones you want to assign per volume. Currently, @@ -119,7 +124,7 @@ type CreateKxDataviewOutput struct { // A unique identifier for the changeset. ChangesetId *string - // The timestamp at which the dataview was created in FinSpace. The value is + // The timestamp at which the dataview was created in FinSpace. 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. CreatedTimestamp *time.Time @@ -137,7 +142,7 @@ type CreateKxDataviewOutput struct { // dataview. EnvironmentId *string - // The last time that the dataview was updated in FinSpace. The value is + // The last time that the dataview was updated in FinSpace. 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. LastModifiedTimestamp *time.Time @@ -145,16 +150,19 @@ type CreateKxDataviewOutput struct { // Returns True if the dataview is created as writeable and False otherwise. ReadWrite bool - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. SegmentConfigurations []types.KxDataviewSegmentConfiguration - // The status of dataview creation. + // The status of dataview creation. + // // - CREATING – The dataview creation is in progress. + // // - UPDATING – The dataview is in the process of being updated. + // // - ACTIVE – The dataview is active. Status types.KxDataviewStatus diff --git a/service/finspace/api_op_CreateKxScalingGroup.go b/service/finspace/api_op_CreateKxScalingGroup.go index 20dc7d926c0..b9f7d5af6c4 100644 --- a/service/finspace/api_op_CreateKxScalingGroup.go +++ b/service/finspace/api_op_CreateKxScalingGroup.go @@ -46,18 +46,26 @@ type CreateKxScalingGroupInput struct { // This member is required. EnvironmentId *string - // The memory and CPU capabilities of the scaling group host on which FinSpace - // Managed kdb clusters will be placed. You can add one of the following values: + // The memory and CPU capabilities of the scaling group host on which FinSpace + // Managed kdb clusters will be placed. + // + // You can add one of the following values: + // // - kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 // vCPUs. + // // - kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 // vCPUs. + // // - kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 // vCPUs. + // // - kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and // 128 vCPUs. + // // - kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and // 64 vCPUs. + // // - kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and // 96 vCPUs. // @@ -69,8 +77,8 @@ type CreateKxScalingGroupInput struct { // This member is required. ScalingGroupName *string - // A list of key-value pairs to label the scaling group. You can add up to 50 tags - // to a scaling group. + // A list of key-value pairs to label the scaling group. You can add up to 50 + // tags to a scaling group. Tags map[string]string noSmithyDocumentSerde @@ -81,19 +89,20 @@ type CreateKxScalingGroupOutput struct { // The identifier of the availability zones. AvailabilityZoneId *string - // The timestamp at which the scaling group was created in FinSpace. The value is + // The timestamp at which the scaling group was created in FinSpace. 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. CreatedTimestamp *time.Time - // A unique identifier for the kdb environment, where you create the scaling group. + // A unique identifier for the kdb environment, where you create the scaling + // group. EnvironmentId *string - // The memory and CPU capabilities of the scaling group host on which FinSpace + // The memory and CPU capabilities of the scaling group host on which FinSpace // Managed kdb clusters will be placed. HostType *string - // The last time that the scaling group was updated in FinSpace. The value is + // The last time that the scaling group was updated in FinSpace. 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. LastModifiedTimestamp *time.Time @@ -102,13 +111,21 @@ type CreateKxScalingGroupOutput struct { ScalingGroupName *string // The status of scaling group. + // // - CREATING – The scaling group creation is in progress. + // // - CREATE_FAILED – The scaling group creation has failed. + // // - ACTIVE – The scaling group is active. + // // - UPDATING – The scaling group is in the process of being updated. + // // - UPDATE_FAILED – The update action failed. + // // - DELETING – The scaling group is in the process of being deleted. + // // - DELETE_FAILED – The system failed to delete the scaling group. + // // - DELETED – The scaling group is successfully deleted. Status types.KxScalingGroupStatus diff --git a/service/finspace/api_op_CreateKxUser.go b/service/finspace/api_op_CreateKxUser.go index 3d72ec8f366..95c7ed87899 100644 --- a/service/finspace/api_op_CreateKxUser.go +++ b/service/finspace/api_op_CreateKxUser.go @@ -61,9 +61,10 @@ type CreateKxUserOutput struct { // The IAM role ARN that will be associated with the user. IamRole *string - // 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/reference_identifiers.html) - // in the IAM User Guide. + // The Amazon Resource Name (ARN) that identifies the user. For more information + // about ARNs and how to use ARNs in policies, see [IAM Identifiers]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html UserArn *string // A unique identifier for the user. diff --git a/service/finspace/api_op_CreateKxVolume.go b/service/finspace/api_op_CreateKxVolume.go index 843486bd163..042447df3ae 100644 --- a/service/finspace/api_op_CreateKxVolume.go +++ b/service/finspace/api_op_CreateKxVolume.go @@ -12,7 +12,9 @@ import ( "time" ) -// Creates a new volume with a specific amount of throughput and storage capacity. +// Creates a new volume with a specific amount of throughput and storage +// +// capacity. func (c *Client) CreateKxVolume(ctx context.Context, params *CreateKxVolumeInput, optFns ...func(*Options)) (*CreateKxVolumeOutput, error) { if params == nil { params = &CreateKxVolumeInput{} @@ -52,7 +54,7 @@ type CreateKxVolumeInput struct { // This member is required. VolumeName *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. When you select NAS_1 volume type, you must also provide nas1Configuration // . // @@ -62,14 +64,14 @@ type CreateKxVolumeInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string - // A description of the volume. + // A description of the volume. Description *string - // Specifies the configuration for the Network attached storage (NAS_1) file + // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. This parameter is required when you choose volumeType as NAS_1. Nas1Configuration *types.KxNAS1Configuration - // A list of key-value pairs to label the volume. You can add up to 50 tags to a + // A list of key-value pairs to label the volume. You can add up to 50 tags to a // volume. Tags map[string]string @@ -90,39 +92,48 @@ type CreateKxVolumeOutput struct { // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreatedTimestamp *time.Time - // A description of the volume. + // A description of the volume. Description *string // A unique identifier for the kdb environment, whose clusters can attach to the // volume. EnvironmentId *string - // Specifies the configuration for the Network attached storage (NAS_1) file + // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. Nas1Configuration *types.KxNAS1Configuration // The status of volume creation. + // // - CREATING – The volume creation is in progress. + // // - CREATE_FAILED – The volume creation has failed. + // // - ACTIVE – The volume is active. + // // - UPDATING – The volume is in the process of being updated. + // // - UPDATE_FAILED – The update action failed. + // // - UPDATED – The volume is successfully updated. + // // - DELETING – The volume is in the process of being deleted. + // // - DELETE_FAILED – The system failed to delete the volume. + // // - DELETED – The volume is successfully deleted. Status types.KxVolumeStatus // The error message when a failed state occurs. StatusReason *string - // The ARN identifier of the volume. + // The ARN identifier of the volume. VolumeArn *string // A unique identifier for the volume. VolumeName *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType types.KxVolumeType diff --git a/service/finspace/api_op_DeleteKxDataview.go b/service/finspace/api_op_DeleteKxDataview.go index c4d29deeb16..4dc7d27c70a 100644 --- a/service/finspace/api_op_DeleteKxDataview.go +++ b/service/finspace/api_op_DeleteKxDataview.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified dataview. Before deleting a dataview, make sure that it +// Deletes the specified dataview. Before deleting a dataview, make sure that it +// // is not in use by any cluster. func (c *Client) DeleteKxDataview(ctx context.Context, params *DeleteKxDataviewInput, optFns ...func(*Options)) (*DeleteKxDataviewOutput, error) { if params == nil { diff --git a/service/finspace/api_op_DeleteKxScalingGroup.go b/service/finspace/api_op_DeleteKxScalingGroup.go index 842700056c5..e9db3e332b9 100644 --- a/service/finspace/api_op_DeleteKxScalingGroup.go +++ b/service/finspace/api_op_DeleteKxScalingGroup.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified scaling group. This action is irreversible. You cannot +// Deletes the specified scaling group. This action is irreversible. You cannot +// // delete a scaling group until all the clusters running on it have been deleted. func (c *Client) DeleteKxScalingGroup(ctx context.Context, params *DeleteKxScalingGroupInput, optFns ...func(*Options)) (*DeleteKxScalingGroupOutput, error) { if params == nil { diff --git a/service/finspace/api_op_DeleteKxVolume.go b/service/finspace/api_op_DeleteKxVolume.go index 19f34cad70f..e178de1e87d 100644 --- a/service/finspace/api_op_DeleteKxVolume.go +++ b/service/finspace/api_op_DeleteKxVolume.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a volume. You can only delete a volume if it's not attached to a +// Deletes a volume. You can only delete a volume if it's not attached to a +// // cluster or a dataview. When a volume is deleted, any data on the volume is lost. // This action is irreversible. func (c *Client) DeleteKxVolume(ctx context.Context, params *DeleteKxVolumeInput, optFns ...func(*Options)) (*DeleteKxVolumeOutput, error) { @@ -36,7 +37,7 @@ type DeleteKxVolumeInput struct { // This member is required. EnvironmentId *string - // The name of the volume that you want to delete. + // The name of the volume that you want to delete. // // This member is required. VolumeName *string diff --git a/service/finspace/api_op_GetKxChangeset.go b/service/finspace/api_op_GetKxChangeset.go index 1121b0e0548..c0d14072ff6 100644 --- a/service/finspace/api_op_GetKxChangeset.go +++ b/service/finspace/api_op_GetKxChangeset.go @@ -82,9 +82,13 @@ type GetKxChangesetOutput struct { LastModifiedTimestamp *time.Time // Status of the changeset creation process. + // // - Pending – Changeset creation is pending. + // // - Processing – Changeset creation is running. + // // - Failed – Changeset creation has failed. + // // - Complete – Changeset creation has succeeded. Status types.ChangesetStatus diff --git a/service/finspace/api_op_GetKxCluster.go b/service/finspace/api_op_GetKxCluster.go index 3c9d09c2db6..4b249a719e9 100644 --- a/service/finspace/api_op_GetKxCluster.go +++ b/service/finspace/api_op_GetKxCluster.go @@ -49,12 +49,14 @@ type GetKxClusterOutput struct { // your cluster. AutoScalingConfiguration *types.AutoScalingConfiguration - // The availability zone identifiers for the requested regions. + // The availability zone identifiers for the requested regions. AvailabilityZoneId *string // The number of availability zones you want to assign per cluster. This can be // one of the following + // // - SINGLE – Assigns one availability zone per cluster. + // // - MULTI – Assigns all the availability zones per cluster. AzMode types.KxAzMode @@ -74,24 +76,29 @@ type GetKxClusterOutput struct { // Specifies the type of KDB database that is being created. The following types // are available: + // // - HDB – A Historical Database. The data is only accessible with read-only // permissions from one of the FinSpace managed kdb databases mounted to the // cluster. + // // - RDB – A Realtime Database. This type of database captures all the data from // a ticker plant and stores it in memory until the end of day, after which it // writes all of its data to a disk and reloads the HDB. This cluster type requires // local storage for temporary storage of data during the savedown process. If you // specify this field in your request, you must provide the // savedownStorageConfiguration parameter. + // // - GATEWAY – A gateway cluster allows you to access data across processes in // kdb systems. It allows you to create your own routing logic using the // initialization scripts and custom code. This type of cluster does not require a // writable local storage. + // // - GP – A general purpose cluster allows you to quickly iterate on code during // development by granting greater access to system commands and enabling a fast // reload of custom code. This cluster type can optionally mount databases // including cache and savedown storage. For this cluster type, the node count is // fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode. + // // - Tickerplant – A tickerplant cluster allows you to subscribe to feed // handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, // and real-time subscribers (RTS). Tickerplants can persist messages to log, which @@ -113,10 +120,10 @@ type GetKxClusterOutput struct { // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreatedTimestamp *time.Time - // A list of databases mounted on the cluster. + // A list of databases mounted on the cluster. Databases []types.KxDatabaseConfiguration - // An IAM role that defines a set of permissions associated with a cluster. These + // An IAM role that defines a set of permissions associated with a cluster. These // permissions are assumed when a cluster attempts to access another cluster. ExecutionRole *string @@ -143,26 +150,34 @@ type GetKxClusterOutput struct { ScalingGroupConfiguration *types.KxScalingGroupConfiguration // The status of cluster creation. + // // - PENDING – The cluster is pending creation. + // // - CREATING – The cluster creation process is in progress. + // // - CREATE_FAILED – The cluster creation process has failed. + // // - RUNNING – The cluster creation process is running. + // // - UPDATING – The cluster is in the process of being updated. + // // - DELETING – The cluster is in the process of being deleted. + // // - DELETED – The cluster has been deleted. + // // - DELETE_FAILED – The cluster failed to delete. Status types.KxClusterStatus // The error message when a failed state occurs. StatusReason *string - // A configuration to store the Tickerplant logs. It consists of a list of volumes - // that will be mounted to your cluster. For the cluster type Tickerplant , the - // location of the TP volume on the cluster will be available by using the global - // variable .aws.tp_log_path . + // A configuration to store the Tickerplant logs. It consists of a list of + // volumes that will be mounted to your cluster. For the cluster type Tickerplant , + // the location of the TP volume on the cluster will be available by using the + // global variable .aws.tp_log_path . TickerplantLogConfiguration *types.TickerplantLogConfiguration - // A list of volumes attached to the cluster. + // A list of volumes attached to the cluster. Volumes []types.Volume // Configuration details about the network where the Privatelink endpoint of the diff --git a/service/finspace/api_op_GetKxConnectionString.go b/service/finspace/api_op_GetKxConnectionString.go index e2bcedd8e81..a9eb1b81072 100644 --- a/service/finspace/api_op_GetKxConnectionString.go +++ b/service/finspace/api_op_GetKxConnectionString.go @@ -39,9 +39,10 @@ type GetKxConnectionStringInput struct { // This member is required. EnvironmentId *string - // 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/reference_identifiers.html) - // in the IAM User Guide. + // The Amazon Resource Name (ARN) that identifies the user. For more information + // about ARNs and how to use ARNs in policies, see [IAM Identifiers]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. UserArn *string diff --git a/service/finspace/api_op_GetKxDataview.go b/service/finspace/api_op_GetKxDataview.go index f1553d98373..11235fb6345 100644 --- a/service/finspace/api_op_GetKxDataview.go +++ b/service/finspace/api_op_GetKxDataview.go @@ -30,7 +30,7 @@ func (c *Client) GetKxDataview(ctx context.Context, params *GetKxDataviewInput, type GetKxDataviewInput struct { - // The name of the database where you created the dataview. + // The name of the database where you created the dataview. // // This member is required. DatabaseName *string @@ -51,7 +51,7 @@ type GetKxDataviewInput struct { type GetKxDataviewOutput struct { - // The current active changeset versions of the database on the given dataview. + // The current active changeset versions of the database on the given dataview. ActiveVersions []types.KxDataviewActiveVersion // The option to specify whether you want to apply all the future additions and @@ -59,14 +59,14 @@ type GetKxDataviewOutput struct { // default value is false. AutoUpdate bool - // The identifier of the availability zones. + // The identifier of the availability zones. AvailabilityZoneId *string // The number of availability zones you want to assign per volume. Currently, // FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. AzMode types.KxAzMode - // A unique identifier of the changeset that you want to use to ingest data. + // A unique identifier of the changeset that you want to use to ingest data. ChangesetId *string // The timestamp at which the dataview was created in FinSpace. The value is @@ -74,7 +74,7 @@ type GetKxDataviewOutput struct { // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreatedTimestamp *time.Time - // The name of the database where you created the dataview. + // The name of the database where you created the dataview. DatabaseName *string // A unique identifier for the dataview. @@ -87,7 +87,7 @@ type GetKxDataviewOutput struct { // the dataview details. EnvironmentId *string - // The last time that the dataview was updated in FinSpace. The value is + // The last time that the dataview was updated in FinSpace. 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. LastModifiedTimestamp *time.Time @@ -95,20 +95,23 @@ type GetKxDataviewOutput struct { // Returns True if the dataview is created as writeable and False otherwise. ReadWrite bool - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. SegmentConfigurations []types.KxDataviewSegmentConfiguration - // The status of dataview creation. + // The status of dataview creation. + // // - CREATING – The dataview creation is in progress. + // // - UPDATING – The dataview is in the process of being updated. + // // - ACTIVE – The dataview is active. Status types.KxDataviewStatus - // The error message when a failed state occurs. + // The error message when a failed state occurs. StatusReason *string // Metadata pertaining to the operation's result. diff --git a/service/finspace/api_op_GetKxScalingGroup.go b/service/finspace/api_op_GetKxScalingGroup.go index ecfbd833ed9..79adcc64d20 100644 --- a/service/finspace/api_op_GetKxScalingGroup.go +++ b/service/finspace/api_op_GetKxScalingGroup.go @@ -48,54 +48,70 @@ type GetKxScalingGroupOutput struct { // The identifier of the availability zones. AvailabilityZoneId *string - // The list of Managed kdb clusters that are currently active in the given scaling - // group. + // The list of Managed kdb clusters that are currently active in the given + // scaling group. Clusters []string - // The timestamp at which the scaling group was created in FinSpace. The value is + // The timestamp at which the scaling group was created in FinSpace. 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. CreatedTimestamp *time.Time - // The memory and CPU capabilities of the scaling group host on which FinSpace - // Managed kdb clusters will be placed. It can have one of the following values: + // The memory and CPU capabilities of the scaling group host on which FinSpace + // Managed kdb clusters will be placed. + // + // It can have one of the following values: + // // - kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 // vCPUs. + // // - kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 // vCPUs. + // // - kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 // vCPUs. + // // - kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and // 128 vCPUs. + // // - kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and // 64 vCPUs. + // // - kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and // 96 vCPUs. HostType *string - // The last time that the scaling group was updated in FinSpace. The value is + // The last time that the scaling group was updated in FinSpace. 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. LastModifiedTimestamp *time.Time - // The ARN identifier for the scaling group. + // The ARN identifier for the scaling group. ScalingGroupArn *string // A unique identifier for the kdb scaling group. ScalingGroupName *string // The status of scaling group. + // // - CREATING – The scaling group creation is in progress. + // // - CREATE_FAILED – The scaling group creation has failed. + // // - ACTIVE – The scaling group is active. + // // - UPDATING – The scaling group is in the process of being updated. + // // - UPDATE_FAILED – The update action failed. + // // - DELETING – The scaling group is in the process of being deleted. + // // - DELETE_FAILED – The system failed to delete the scaling group. + // // - DELETED – The scaling group is successfully deleted. Status types.KxScalingGroupStatus - // The error message when a failed state occurs. + // The error message when a failed state occurs. StatusReason *string // Metadata pertaining to the operation's result. diff --git a/service/finspace/api_op_GetKxUser.go b/service/finspace/api_op_GetKxUser.go index ac3c2dad1b2..f86e84a3892 100644 --- a/service/finspace/api_op_GetKxUser.go +++ b/service/finspace/api_op_GetKxUser.go @@ -49,9 +49,10 @@ type GetKxUserOutput struct { // The IAM role ARN that is associated with the user. IamRole *string - // 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/reference_identifiers.html) - // in the IAM User Guide. + // The Amazon Resource Name (ARN) that identifies the user. For more information + // about ARNs and how to use ARNs in policies, see [IAM Identifiers]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html UserArn *string // A unique identifier for the user. diff --git a/service/finspace/api_op_GetKxVolume.go b/service/finspace/api_op_GetKxVolume.go index 547e1b252c2..77daa8ecf7a 100644 --- a/service/finspace/api_op_GetKxVolume.go +++ b/service/finspace/api_op_GetKxVolume.go @@ -46,7 +46,7 @@ type GetKxVolumeInput struct { type GetKxVolumeOutput struct { - // A list of cluster identifiers that a volume is attached to. + // A list of cluster identifiers that a volume is attached to. AttachedClusters []types.KxAttachedCluster // The identifier of the availability zones. @@ -56,12 +56,12 @@ type GetKxVolumeOutput struct { // FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. AzMode types.KxAzMode - // The timestamp at which the volume was created in FinSpace. The value is + // The timestamp at which the volume was created in FinSpace. 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. CreatedTimestamp *time.Time - // A description of the volume. + // A description of the volume. Description *string // A unique identifier for the kdb environment, whose clusters can attach to the @@ -73,32 +73,41 @@ type GetKxVolumeOutput struct { // 2021 12:00:00 PM UTC is specified as 1635768000000. LastModifiedTimestamp *time.Time - // Specifies the configuration for the Network attached storage (NAS_1) file + // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. Nas1Configuration *types.KxNAS1Configuration // The status of volume creation. + // // - CREATING – The volume creation is in progress. + // // - CREATE_FAILED – The volume creation has failed. + // // - ACTIVE – The volume is active. + // // - UPDATING – The volume is in the process of being updated. + // // - UPDATE_FAILED – The update action failed. + // // - UPDATED – The volume is successfully updated. + // // - DELETING – The volume is in the process of being deleted. + // // - DELETE_FAILED – The system failed to delete the volume. + // // - DELETED – The volume is successfully deleted. Status types.KxVolumeStatus // The error message when a failed state occurs. StatusReason *string - // The ARN identifier of the volume. + // The ARN identifier of the volume. VolumeArn *string - // A unique identifier for the volume. + // A unique identifier for the volume. VolumeName *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType types.KxVolumeType diff --git a/service/finspace/api_op_ListKxClusters.go b/service/finspace/api_op_ListKxClusters.go index a093dc6550d..00a64f849b2 100644 --- a/service/finspace/api_op_ListKxClusters.go +++ b/service/finspace/api_op_ListKxClusters.go @@ -36,24 +36,29 @@ type ListKxClustersInput struct { // Specifies the type of KDB database that is being created. The following types // are available: + // // - HDB – A Historical Database. The data is only accessible with read-only // permissions from one of the FinSpace managed kdb databases mounted to the // cluster. + // // - RDB – A Realtime Database. This type of database captures all the data from // a ticker plant and stores it in memory until the end of day, after which it // writes all of its data to a disk and reloads the HDB. This cluster type requires // local storage for temporary storage of data during the savedown process. If you // specify this field in your request, you must provide the // savedownStorageConfiguration parameter. + // // - GATEWAY – A gateway cluster allows you to access data across processes in // kdb systems. It allows you to create your own routing logic using the // initialization scripts and custom code. This type of cluster does not require a // writable local storage. + // // - GP – A general purpose cluster allows you to quickly iterate on code during // development by granting greater access to system commands and enabling a fast // reload of custom code. This cluster type can optionally mount databases // including cache and savedown storage. For this cluster type, the node count is // fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode. + // // - Tickerplant – A tickerplant cluster allows you to subscribe to feed // handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, // and real-time subscribers (RTS). Tickerplants can persist messages to log, which diff --git a/service/finspace/api_op_ListKxDataviews.go b/service/finspace/api_op_ListKxDataviews.go index b5530996f9f..faabe673dff 100644 --- a/service/finspace/api_op_ListKxDataviews.go +++ b/service/finspace/api_op_ListKxDataviews.go @@ -29,7 +29,7 @@ func (c *Client) ListKxDataviews(ctx context.Context, params *ListKxDataviewsInp type ListKxDataviewsInput struct { - // The name of the database where the dataviews were created. + // The name of the database where the dataviews were created. // // This member is required. DatabaseName *string @@ -43,7 +43,7 @@ type ListKxDataviewsInput struct { // The maximum number of results to return in this request. MaxResults int32 - // A token that indicates where a results page should begin. + // A token that indicates where a results page should begin. NextToken *string noSmithyDocumentSerde @@ -51,10 +51,10 @@ type ListKxDataviewsInput struct { type ListKxDataviewsOutput struct { - // The list of kdb dataviews that are currently active for the given database. + // The list of kdb dataviews that are currently active for the given database. KxDataviews []types.KxDataviewListEntry - // A token that indicates where a results page should begin. + // A token that indicates where a results page should begin. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/finspace/api_op_ListKxScalingGroups.go b/service/finspace/api_op_ListKxScalingGroups.go index 708cc1b9320..e22455ca685 100644 --- a/service/finspace/api_op_ListKxScalingGroups.go +++ b/service/finspace/api_op_ListKxScalingGroups.go @@ -38,7 +38,7 @@ type ListKxScalingGroupsInput struct { // The maximum number of results to return in this request. MaxResults int32 - // A token that indicates where a results page should begin. + // A token that indicates where a results page should begin. NextToken *string noSmithyDocumentSerde @@ -46,10 +46,10 @@ type ListKxScalingGroupsInput struct { type ListKxScalingGroupsOutput struct { - // A token that indicates where a results page should begin. + // A token that indicates where a results page should begin. NextToken *string - // A list of scaling groups available in a kdb environment. + // A list of scaling groups available in a kdb environment. ScalingGroups []types.KxScalingGroup // Metadata pertaining to the operation's result. diff --git a/service/finspace/api_op_ListKxVolumes.go b/service/finspace/api_op_ListKxVolumes.go index 22c480367d7..7ddf89f9976 100644 --- a/service/finspace/api_op_ListKxVolumes.go +++ b/service/finspace/api_op_ListKxVolumes.go @@ -41,7 +41,7 @@ type ListKxVolumesInput struct { // A token that indicates where a results page should begin. NextToken *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType types.KxVolumeType @@ -50,7 +50,7 @@ type ListKxVolumesInput struct { type ListKxVolumesOutput struct { - // A summary of volumes. + // A summary of volumes. KxVolumeSummaries []types.KxVolume // A token that indicates where a results page should begin. diff --git a/service/finspace/api_op_UpdateEnvironment.go b/service/finspace/api_op_UpdateEnvironment.go index 494a64bcfad..ed7e016286f 100644 --- a/service/finspace/api_op_UpdateEnvironment.go +++ b/service/finspace/api_op_UpdateEnvironment.go @@ -40,8 +40,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. FederationMode types.FederationMode diff --git a/service/finspace/api_op_UpdateKxClusterCodeConfiguration.go b/service/finspace/api_op_UpdateKxClusterCodeConfiguration.go index 975dbaff5e8..14cad5dc03b 100644 --- a/service/finspace/api_op_UpdateKxClusterCodeConfiguration.go +++ b/service/finspace/api_op_UpdateKxClusterCodeConfiguration.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to update code configuration on a running cluster. By using this API -// you can update the code, the initialization script path, and the command line -// arguments for a specific cluster. The configuration that you want to update will -// override any existing configurations on the cluster. +// Allows you to update code configuration on a running cluster. By using this +// +// API you can update the code, the initialization script path, and the command +// line arguments for a specific cluster. The configuration that you want to update +// will override any existing configurations on the cluster. func (c *Client) UpdateKxClusterCodeConfiguration(ctx context.Context, params *UpdateKxClusterCodeConfigurationInput, optFns ...func(*Options)) (*UpdateKxClusterCodeConfigurationOutput, error) { if params == nil { params = &UpdateKxClusterCodeConfigurationInput{} @@ -42,7 +43,7 @@ type UpdateKxClusterCodeConfigurationInput struct { // This member is required. Code *types.CodeConfiguration - // A unique identifier of the kdb environment. + // A unique identifier of the kdb environment. // // This member is required. EnvironmentId *string @@ -50,18 +51,20 @@ type UpdateKxClusterCodeConfigurationInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string - // Specifies the key-value pairs to make them available inside the cluster. You - // cannot update this parameter for a NO_RESTART deployment. + // Specifies the key-value pairs to make them available inside the cluster. + // + // You cannot update this parameter for a NO_RESTART deployment. CommandLineArguments []types.KxCommandLineArgument - // The configuration that allows you to choose how you want to update the code on + // The configuration that allows you to choose how you want to update the code on // a cluster. DeploymentConfiguration *types.KxClusterCodeDeploymentConfiguration // Specifies a Q program that will be run at launch of a cluster. It is a relative // path within .zip file that contains the custom code, which will be loaded on the - // cluster. It must include the file name itself. For example, somedir/init.q . You - // cannot update this parameter for a NO_RESTART deployment. + // cluster. It must include the file name itself. For example, somedir/init.q . + // + // You cannot update this parameter for a NO_RESTART deployment. InitializationScript *string noSmithyDocumentSerde diff --git a/service/finspace/api_op_UpdateKxClusterDatabases.go b/service/finspace/api_op_UpdateKxClusterDatabases.go index 7490f3871ae..d69973e3a68 100644 --- a/service/finspace/api_op_UpdateKxClusterDatabases.go +++ b/service/finspace/api_op_UpdateKxClusterDatabases.go @@ -13,9 +13,10 @@ import ( // Updates the databases mounted on a kdb cluster, which includes the changesetId // and all the dbPaths to be cached. This API does not allow you to change a -// database name or add a database if you created a cluster without one. Using this -// API you can point a cluster to a different changeset and modify a list of -// partitions being cached. +// database name or add a database if you created a cluster without one. +// +// Using this API you can point a cluster to a different changeset and modify a +// list of partitions being cached. func (c *Client) UpdateKxClusterDatabases(ctx context.Context, params *UpdateKxClusterDatabasesInput, optFns ...func(*Options)) (*UpdateKxClusterDatabasesOutput, error) { if params == nil { params = &UpdateKxClusterDatabasesInput{} @@ -38,7 +39,7 @@ type UpdateKxClusterDatabasesInput struct { // This member is required. ClusterName *string - // The structure of databases mounted on the cluster. + // The structure of databases mounted on the cluster. // // This member is required. Databases []types.KxDatabaseConfiguration @@ -51,7 +52,7 @@ type UpdateKxClusterDatabasesInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string - // The configuration that allows you to choose how you want to update the + // The configuration that allows you to choose how you want to update the // databases on a cluster. DeploymentConfiguration *types.KxDeploymentConfiguration diff --git a/service/finspace/api_op_UpdateKxDataview.go b/service/finspace/api_op_UpdateKxDataview.go index 28ceca95833..33e41bbfb30 100644 --- a/service/finspace/api_op_UpdateKxDataview.go +++ b/service/finspace/api_op_UpdateKxDataview.go @@ -12,7 +12,8 @@ import ( "time" ) -// Updates the specified dataview. The dataviews get automatically updated when +// Updates the specified dataview. The dataviews get automatically updated when +// // any new changesets are ingested. Each update of the dataview creates a new // version, including changeset details and cache configurations func (c *Client) UpdateKxDataview(ctx context.Context, params *UpdateKxDataviewInput, optFns ...func(*Options)) (*UpdateKxDataviewOutput, error) { @@ -37,7 +38,7 @@ type UpdateKxDataviewInput struct { // This member is required. ClientToken *string - // The name of the database. + // The name of the database. // // This member is required. DatabaseName *string @@ -56,10 +57,10 @@ type UpdateKxDataviewInput struct { // A unique identifier for the changeset. ChangesetId *string - // The description for a dataview. + // The description for a dataview. Description *string - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store @@ -71,7 +72,7 @@ type UpdateKxDataviewInput struct { type UpdateKxDataviewOutput struct { - // The current active changeset versions of the database on the given dataview. + // The current active changeset versions of the database on the given dataview. ActiveVersions []types.KxDataviewActiveVersion // The option to specify whether you want to apply all the future additions and @@ -79,7 +80,7 @@ type UpdateKxDataviewOutput struct { // default value is false. AutoUpdate bool - // The identifier of the availability zones. + // The identifier of the availability zones. AvailabilityZoneId *string // The number of availability zones you want to assign per volume. Currently, @@ -89,15 +90,15 @@ type UpdateKxDataviewOutput struct { // A unique identifier for the changeset. ChangesetId *string - // The timestamp at which the dataview was created in FinSpace. The value is + // The timestamp at which the dataview was created in FinSpace. 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. CreatedTimestamp *time.Time - // The name of the database. + // The name of the database. DatabaseName *string - // The name of the database under which the dataview was created. + // The name of the database under which the dataview was created. DataviewName *string // A description of the dataview. @@ -107,7 +108,7 @@ type UpdateKxDataviewOutput struct { // dataview. EnvironmentId *string - // The last time that the dataview was updated in FinSpace. The value is + // The last time that the dataview was updated in FinSpace. 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. LastModifiedTimestamp *time.Time @@ -115,16 +116,19 @@ type UpdateKxDataviewOutput struct { // Returns True if the dataview is created as writeable and False otherwise. ReadWrite bool - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. SegmentConfigurations []types.KxDataviewSegmentConfiguration - // The status of dataview creation. + // The status of dataview creation. + // // - CREATING – The dataview creation is in progress. + // // - UPDATING – The dataview is in the process of being updated. + // // - ACTIVE – The dataview is active. Status types.KxDataviewStatus diff --git a/service/finspace/api_op_UpdateKxEnvironmentNetwork.go b/service/finspace/api_op_UpdateKxEnvironmentNetwork.go index 90d24031a79..9daad8d6e9e 100644 --- a/service/finspace/api_op_UpdateKxEnvironmentNetwork.go +++ b/service/finspace/api_op_UpdateKxEnvironmentNetwork.go @@ -15,9 +15,11 @@ import ( // Updates environment network to connect to your internal network by using a // transit gateway. This API supports request to create a transit gateway // attachment from FinSpace VPC to your transit gateway ID and create a custom -// Route-53 outbound resolvers. Once you send a request to update a network, you -// cannot change it again. Network update might require termination of any clusters -// that are running in the existing network. +// Route-53 outbound resolvers. +// +// Once you send a request to update a network, you cannot change it again. +// Network update might require termination of any clusters that are running in the +// existing network. func (c *Client) UpdateKxEnvironmentNetwork(ctx context.Context, params *UpdateKxEnvironmentNetworkInput, optFns ...func(*Options)) (*UpdateKxEnvironmentNetworkOutput, error) { if params == nil { params = &UpdateKxEnvironmentNetworkInput{} diff --git a/service/finspace/api_op_UpdateKxUser.go b/service/finspace/api_op_UpdateKxUser.go index a0e11085afe..36fc7b3f7d1 100644 --- a/service/finspace/api_op_UpdateKxUser.go +++ b/service/finspace/api_op_UpdateKxUser.go @@ -58,9 +58,10 @@ type UpdateKxUserOutput struct { // The IAM role ARN that is associated with the user. IamRole *string - // 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/reference_identifiers.html) - // in the IAM User Guide. + // The Amazon Resource Name (ARN) that identifies the user. For more information + // about ARNs and how to use ARNs in policies, see [IAM Identifiers]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html UserArn *string // A unique identifier for the user. diff --git a/service/finspace/api_op_UpdateKxVolume.go b/service/finspace/api_op_UpdateKxVolume.go index bca5bc8a898..d81eccf3c86 100644 --- a/service/finspace/api_op_UpdateKxVolume.go +++ b/service/finspace/api_op_UpdateKxVolume.go @@ -12,7 +12,8 @@ import ( "time" ) -// Updates the throughput or capacity of a volume. During the update process, the +// Updates the throughput or capacity of a volume. During the update process, the +// // filesystem might be unavailable for a few minutes. You can retry any operations // after the update is complete. func (c *Client) UpdateKxVolume(ctx context.Context, params *UpdateKxVolumeInput, optFns ...func(*Options)) (*UpdateKxVolumeOutput, error) { @@ -38,7 +39,7 @@ type UpdateKxVolumeInput struct { // This member is required. EnvironmentId *string - // A unique identifier for the volume. + // A unique identifier for the volume. // // This member is required. VolumeName *string @@ -46,10 +47,10 @@ type UpdateKxVolumeInput struct { // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string - // A description of the volume. + // A description of the volume. Description *string - // Specifies the configuration for the Network attached storage (NAS_1) file + // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. Nas1Configuration *types.KxNAS1Configuration @@ -58,7 +59,7 @@ type UpdateKxVolumeInput struct { type UpdateKxVolumeOutput struct { - // Specifies the clusters that a volume is attached to. + // Specifies the clusters that a volume is attached to. AttachedClusters []types.KxAttachedCluster // The identifier of the availability zones. @@ -68,15 +69,16 @@ type UpdateKxVolumeOutput struct { // FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. AzMode types.KxAzMode - // The timestamp at which the volume was created in FinSpace. The value is + // The timestamp at which the volume was created in FinSpace. 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. CreatedTimestamp *time.Time - // The description for the volume. + // The description for the volume. Description *string - // A unique identifier for the kdb environment where you want to update the volume. + // A unique identifier for the kdb environment where you want to update the + // volume. EnvironmentId *string // The last time that the volume was updated in FinSpace. The value is determined @@ -84,32 +86,41 @@ type UpdateKxVolumeOutput struct { // 2021 12:00:00 PM UTC is specified as 1635768000000. LastModifiedTimestamp *time.Time - // Specifies the configuration for the Network attached storage (NAS_1) file + // Specifies the configuration for the Network attached storage (NAS_1) file // system volume. Nas1Configuration *types.KxNAS1Configuration // The status of the volume. + // // - CREATING – The volume creation is in progress. + // // - CREATE_FAILED – The volume creation has failed. + // // - ACTIVE – The volume is active. + // // - UPDATING – The volume is in the process of being updated. + // // - UPDATE_FAILED – The update action failed. + // // - UPDATED – The volume is successfully updated. + // // - DELETING – The volume is in the process of being deleted. + // // - DELETE_FAILED – The system failed to delete the volume. + // // - DELETED – The volume is successfully deleted. Status types.KxVolumeStatus // The error message when a failed state occurs. StatusReason *string - // The ARN identifier of the volume. + // The ARN identifier of the volume. VolumeArn *string // A unique identifier for the volume that you want to update. VolumeName *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType types.KxVolumeType diff --git a/service/finspace/options.go b/service/finspace/options.go index d05e3f637db..5873a90d724 100644 --- a/service/finspace/options.go +++ b/service/finspace/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/finspace/types/enums.go b/service/finspace/types/enums.go index de3d7ff1d5d..01245062d56 100644 --- a/service/finspace/types/enums.go +++ b/service/finspace/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for AutoScalingMetric. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingMetric) Values() []AutoScalingMetric { return []AutoScalingMetric{ "CPU_UTILIZATION_PERCENTAGE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ChangesetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangesetStatus) Values() []ChangesetStatus { return []ChangesetStatus{ "PENDING", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "PUT", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for DnsStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DnsStatus) Values() []DnsStatus { return []DnsStatus{ "NONE", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for EnvironmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentStatus) Values() []EnvironmentStatus { return []EnvironmentStatus{ "CREATE_REQUESTED", @@ -137,8 +142,9 @@ const ( ) // Values returns all known values for ErrorDetails. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ErrorDetails) Values() []ErrorDetails { return []ErrorDetails{ "The inputs to this request are invalid.", @@ -161,8 +167,9 @@ const ( ) // Values returns all known values for FederationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FederationMode) Values() []FederationMode { return []FederationMode{ "FEDERATED", @@ -178,8 +185,9 @@ const ( ) // Values returns all known values for IPAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IPAddressType) Values() []IPAddressType { return []IPAddressType{ "IP_V4", @@ -195,8 +203,9 @@ const ( ) // Values returns all known values for KxAzMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxAzMode) Values() []KxAzMode { return []KxAzMode{ "SINGLE", @@ -215,8 +224,9 @@ const ( // Values returns all known values for KxClusterCodeDeploymentStrategy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxClusterCodeDeploymentStrategy) Values() []KxClusterCodeDeploymentStrategy { return []KxClusterCodeDeploymentStrategy{ "NO_RESTART", @@ -240,8 +250,9 @@ const ( ) // Values returns all known values for KxClusterStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxClusterStatus) Values() []KxClusterStatus { return []KxClusterStatus{ "PENDING", @@ -267,8 +278,9 @@ const ( ) // Values returns all known values for KxClusterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxClusterType) Values() []KxClusterType { return []KxClusterType{ "HDB", @@ -291,8 +303,9 @@ const ( ) // Values returns all known values for KxDataviewStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxDataviewStatus) Values() []KxDataviewStatus { return []KxDataviewStatus{ "CREATING", @@ -312,8 +325,9 @@ const ( ) // Values returns all known values for KxDeploymentStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxDeploymentStrategy) Values() []KxDeploymentStrategy { return []KxDeploymentStrategy{ "NO_RESTART", @@ -331,8 +345,9 @@ const ( ) // Values returns all known values for KxNAS1Type. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxNAS1Type) Values() []KxNAS1Type { return []KxNAS1Type{ "SSD_1000", @@ -350,8 +365,9 @@ const ( ) // Values returns all known values for KxNodeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxNodeStatus) Values() []KxNodeStatus { return []KxNodeStatus{ "RUNNING", @@ -367,8 +383,9 @@ const ( ) // Values returns all known values for KxSavedownStorageType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxSavedownStorageType) Values() []KxSavedownStorageType { return []KxSavedownStorageType{ "SDS01", @@ -388,8 +405,9 @@ const ( ) // Values returns all known values for KxScalingGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxScalingGroupStatus) Values() []KxScalingGroupStatus { return []KxScalingGroupStatus{ "CREATING", @@ -417,8 +435,9 @@ const ( ) // Values returns all known values for KxVolumeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxVolumeStatus) Values() []KxVolumeStatus { return []KxVolumeStatus{ "CREATING", @@ -441,8 +460,9 @@ const ( ) // Values returns all known values for KxVolumeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KxVolumeType) Values() []KxVolumeType { return []KxVolumeType{ "NAS_1", @@ -458,8 +478,9 @@ const ( ) // Values returns all known values for RuleAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleAction) Values() []RuleAction { return []RuleAction{ "allow", @@ -479,8 +500,9 @@ const ( ) // Values returns all known values for TgwStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TgwStatus) Values() []TgwStatus { return []TgwStatus{ "NONE", @@ -499,8 +521,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "NAS_1", diff --git a/service/finspace/types/errors.go b/service/finspace/types/errors.go index 40fdb284c39..aa67a8b850b 100644 --- a/service/finspace/types/errors.go +++ b/service/finspace/types/errors.go @@ -192,7 +192,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 +// You have 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 { diff --git a/service/finspace/types/types.go b/service/finspace/types/types.go index b6f0e6a1bdb..0f78e11042d 100644 --- a/service/finspace/types/types.go +++ b/service/finspace/types/types.go @@ -11,7 +11,7 @@ import ( // your cluster. type AutoScalingConfiguration struct { - // The metric your cluster will track in order to scale in and out. For example, + // The metric your cluster will track in order to scale in and out. For example, // CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a // cluster. AutoScalingMetric AutoScalingMetric @@ -51,20 +51,27 @@ type CapacityConfiguration struct { // The type that determines the hardware of the host computer used for your // cluster instance. Each node type offers different memory and storage // capabilities. Choose a node type based on the requirements of the application or - // software that you plan to run on your instance. You can only specify one of the - // following values: - // - kx.s.large – The node type with a configuration of 12 GiB memory and 2 - // vCPUs. + // software that you plan to run on your instance. + // + // You can only specify one of the following values: + // + // - kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs. + // // - kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 // vCPUs. + // // - kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 // vCPUs. + // // - kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 // vCPUs. + // // - kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 // vCPUs. + // // - kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 // vCPUs. + // // - kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 // vCPUs. NodeType *string @@ -76,7 +83,9 @@ type CapacityConfiguration struct { type ChangeRequest struct { // Defines the type of change request. A changeType can have the following values: + // // - PUT – Adds or updates files in a database. + // // - DELETE – Deletes files in a database. // // This member is required. @@ -216,7 +225,7 @@ type FederationParameters struct { // Defines the ICMP protocol that consists of the ICMP type and code. type IcmpTypeCode struct { - // The ICMP code. A value of -1 means all codes for the specified ICMP type. + // The ICMP code. A value of -1 means all codes for the specified ICMP type. // // This member is required. Code int32 @@ -236,13 +245,21 @@ type KxAttachedCluster struct { ClusterName *string // The status of the attached cluster. + // // - PENDING – The cluster is pending creation. + // // - CREATING – The cluster creation process is in progress. + // // - CREATE_FAILED – The cluster creation process has failed. + // // - RUNNING – The cluster creation process is running. + // // - UPDATING – The cluster is in the process of being updated. + // // - DELETING – The cluster is in the process of being deleted. + // // - DELETED – The cluster has been deleted. + // // - DELETE_FAILED – The cluster failed to delete. ClusterStatus KxClusterStatus @@ -262,9 +279,13 @@ type KxCacheStorageConfiguration struct { Size *int32 // The type of cache storage. The valid values are: + // // - CACHE_1000 – This type provides at least 1000 MB/s disk access throughput. + // // - CACHE_250 – This type provides at least 250 MB/s disk access throughput. + // // - CACHE_12 – This type provides at least 12 MB/s disk access throughput. + // // For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or // increments of 2400 GB. For cache type CACHE_12 you can select the cache size in // increments of 6000 GB. @@ -296,10 +317,14 @@ type KxChangesetListEntry struct { // 12:00:00 PM UTC is specified as 1635768000000. LastModifiedTimestamp *time.Time - // Status of the changeset. + // Status of the changeset. + // // - Pending – Changeset creation is pending. + // // - Processing – Changeset creation is running. + // // - Failed – Changeset creation has failed. + // // - Complete – Changeset creation has succeeded. Status ChangesetStatus @@ -309,12 +334,14 @@ type KxChangesetListEntry struct { // The details of a kdb cluster. type KxCluster struct { - // The availability zone identifiers for the requested regions. + // The availability zone identifiers for the requested regions. AvailabilityZoneId *string // The number of availability zones assigned per cluster. This can be one of the // following: + // // - SINGLE – Assigns one availability zone per cluster. + // // - MULTI – Assigns all the availability zones per cluster. AzMode KxAzMode @@ -326,24 +353,29 @@ type KxCluster struct { // Specifies the type of KDB database that is being created. The following types // are available: + // // - HDB – A Historical Database. The data is only accessible with read-only // permissions from one of the FinSpace managed kdb databases mounted to the // cluster. + // // - RDB – A Realtime Database. This type of database captures all the data from // a ticker plant and stores it in memory until the end of day, after which it // writes all of its data to a disk and reloads the HDB. This cluster type requires // local storage for temporary storage of data during the savedown process. If you // specify this field in your request, you must provide the // savedownStorageConfiguration parameter. + // // - GATEWAY – A gateway cluster allows you to access data across processes in // kdb systems. It allows you to create your own routing logic using the // initialization scripts and custom code. This type of cluster does not require a // writable local storage. + // // - GP – A general purpose cluster allows you to quickly iterate on code during // development by granting greater access to system commands and enabling a fast // reload of custom code. This cluster type can optionally mount databases // including cache and savedown storage. For this cluster type, the node count is // fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode. + // // - Tickerplant – A tickerplant cluster allows you to subscribe to feed // handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, // and real-time subscribers (RTS). Tickerplants can persist messages to log, which @@ -356,7 +388,7 @@ type KxCluster struct { // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreatedTimestamp *time.Time - // An IAM role that defines a set of permissions associated with a cluster. These + // An IAM role that defines a set of permissions associated with a cluster. These // permissions are assumed when a cluster attempts to access another cluster. ExecutionRole *string @@ -374,38 +406,51 @@ type KxCluster struct { ReleaseLabel *string // The status of a cluster. + // // - PENDING – The cluster is pending creation. + // // - CREATING –The cluster creation process is in progress. + // // - CREATE_FAILED– The cluster creation process has failed. + // // - RUNNING – The cluster creation process is running. + // // - UPDATING – The cluster is in the process of being updated. + // // - DELETING – The cluster is in the process of being deleted. + // // - DELETED – The cluster has been deleted. + // // - DELETE_FAILED – The cluster failed to delete. Status KxClusterStatus // The error message when a failed state occurs. StatusReason *string - // A list of volumes attached to the cluster. + // A list of volumes attached to the cluster. Volumes []Volume noSmithyDocumentSerde } -// The configuration that allows you to choose how you want to update code on a +// The configuration that allows you to choose how you want to update code on a +// // cluster. Depending on the option you choose, you can reduce the time it takes to // update the cluster. type KxClusterCodeDeploymentConfiguration struct { - // The type of deployment that you want on a cluster. + // The type of deployment that you want on a cluster. + // // - ROLLING – This options updates the cluster by stopping the exiting q // process and starting a new q process with updated configuration. + // // - NO_RESTART – This option updates the cluster without stopping the running q // process. It is only available for GP type cluster. This option is quicker as - // it reduces the turn around time to update configuration on a cluster. With this - // deployment mode, you cannot update the initializationScript and + // it reduces the turn around time to update configuration on a cluster. + // + // With this deployment mode, you cannot update the initializationScript and // commandLineArguments parameters. + // // - FORCE – This option updates the cluster by immediately stopping all the // running processes before starting up new ones with the updated configuration. // @@ -433,6 +478,7 @@ type KxDatabaseCacheConfiguration struct { // The type of disk cache. This parameter is used to map the database path to // cache storage. The valid values are: + // // - CACHE_1000 – This type provides at least 1000 MB/s disk access throughput. // // This member is required. @@ -444,7 +490,7 @@ type KxDatabaseCacheConfiguration struct { // This member is required. DbPaths []string - // The name of the dataview to be used for caching historical data on disk. + // The name of the dataview to be used for caching historical data on disk. DataviewName *string noSmithyDocumentSerde @@ -466,10 +512,10 @@ type KxDatabaseConfiguration struct { // A unique identifier of the changeset that is associated with the cluster. ChangesetId *string - // The configuration of the dataview to be used with specified cluster. + // The configuration of the dataview to be used with specified cluster. DataviewConfiguration *KxDataviewConfiguration - // The name of the dataview to be used for caching historical data on disk. + // The name of the dataview to be used for caching historical data on disk. DataviewName *string noSmithyDocumentSerde @@ -497,25 +543,25 @@ type KxDatabaseListEntry struct { // The active version of the dataview that is currently in use by this cluster. type KxDataviewActiveVersion struct { - // The list of clusters that are currently using this dataview. + // The list of clusters that are currently using this dataview. AttachedClusters []string // A unique identifier for the changeset. ChangesetId *string - // The timestamp at which the dataview version was active. 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. + // The timestamp at which the dataview version was active. 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. CreatedTimestamp *time.Time - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. SegmentConfigurations []KxDataviewSegmentConfiguration - // A unique identifier of the active version. + // A unique identifier of the active version. VersionId *string noSmithyDocumentSerde @@ -527,13 +573,13 @@ type KxDataviewConfiguration struct { // A unique identifier for the changeset. ChangesetId *string - // The unique identifier of the dataview. + // The unique identifier of the dataview. DataviewName *string - // The version of the dataview corresponding to a given changeset. + // The version of the dataview corresponding to a given changeset. DataviewVersionId *string - // The db path and volume configuration for the segmented database. + // The db path and volume configuration for the segmented database. SegmentConfigurations []KxDataviewSegmentConfiguration noSmithyDocumentSerde @@ -542,15 +588,15 @@ type KxDataviewConfiguration struct { // A collection of kdb dataview entries. type KxDataviewListEntry struct { - // The active changeset versions for the given dataview entry. + // The active changeset versions for the given dataview entry. ActiveVersions []KxDataviewActiveVersion - // The option to specify whether you want to apply all the future additions and + // The option to specify whether you want to apply all the future additions and // corrections automatically to the dataview when you ingest new changesets. The // default value is false. AutoUpdate bool - // The identifier of the availability zones. + // The identifier of the availability zones. AvailabilityZoneId *string // The number of availability zones you want to assign per volume. Currently, @@ -560,18 +606,18 @@ type KxDataviewListEntry struct { // A unique identifier for the changeset. ChangesetId *string - // The timestamp at which the dataview list entry was created in FinSpace. The + // The timestamp at which the dataview list entry was created in FinSpace. 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. CreatedTimestamp *time.Time - // A unique identifier of the database. + // A unique identifier of the database. DatabaseName *string - // A unique identifier of the dataview. + // A unique identifier of the dataview. DataviewName *string - // A description for the dataview list entry. + // A description for the dataview list entry. Description *string // A unique identifier for the kdb environment. @@ -582,39 +628,40 @@ type KxDataviewListEntry struct { // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. LastModifiedTimestamp *time.Time - // Returns True if the dataview is created as writeable and False otherwise. + // Returns True if the dataview is created as writeable and False otherwise. ReadWrite bool - // The configuration that contains the database path of the data that you want to + // The configuration that contains the database path of the data that you want to // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. SegmentConfigurations []KxDataviewSegmentConfiguration - // The status of a given dataview entry. + // The status of a given dataview entry. Status KxDataviewStatus - // The error message when a failed state occurs. + // The error message when a failed state occurs. StatusReason *string noSmithyDocumentSerde } -// The configuration that contains the database path of the data that you want to +// The configuration that contains the database path of the data that you want to +// // place on each selected volume. Each segment must have a unique database path for // each volume. If you do not explicitly specify any database path for a volume, // they are accessible from the cluster through the default S3/object store // segment. type KxDataviewSegmentConfiguration struct { - // The database path of the data that you want to place on each selected volume + // The database path of the data that you want to place on each selected volume // for the segment. Each segment must have a unique database path for each volume. // // This member is required. DbPaths []string - // The name of the volume where you want to add data. + // The name of the volume where you want to add data. // // This member is required. VolumeName *string @@ -628,18 +675,22 @@ type KxDataviewSegmentConfiguration struct { noSmithyDocumentSerde } -// The configuration that allows you to choose how you want to update the +// The configuration that allows you to choose how you want to update the +// // databases on a cluster. Depending on the option you choose, you can reduce the // time it takes to update the cluster. type KxDeploymentConfiguration struct { - // The type of deployment that you want on a cluster. + // The type of deployment that you want on a cluster. + // // - ROLLING – This options updates the cluster by stopping the exiting q // process and starting a new q process with updated configuration. + // // - NO_RESTART – This option updates the cluster without stopping the running q // process. It is only available for HDB type cluster. This option is quicker as - // it reduces the turn around time to update configuration on a cluster. With this - // deployment mode, you cannot update the initializationScript and + // it reduces the turn around time to update configuration on a cluster. + // + // With this deployment mode, you cannot update the initializationScript and // commandLineArguments parameters. // // This member is required. @@ -696,15 +747,24 @@ type KxEnvironment struct { Name *string // The status of the environment creation. + // // - CREATE_REQUESTED – Environment creation has been requested. + // // - CREATING – Environment is in the process of being created. + // // - FAILED_CREATION – Environment creation has failed. + // // - CREATED – Environment is successfully created and is currently active. + // // - DELETE REQUESTED – Environment deletion has been requested. + // // - DELETING – Environment is in the process of being deleted. + // // - RETRY_DELETION – Initial environment deletion failed, system is // reattempting delete. + // // - DELETED – Environment has been deleted. + // // - FAILED_DELETION – Environment deletion has failed. Status EnvironmentStatus @@ -723,16 +783,17 @@ type KxEnvironment struct { noSmithyDocumentSerde } -// The structure containing the size and type of the network attached storage +// The structure containing the size and type of the network attached storage +// // (NAS_1) file system volume. type KxNAS1Configuration struct { - // The size of the network attached storage. For storage type SSD_1000 and SSD_250 + // The size of the network attached storage. For storage type SSD_1000 and SSD_250 // you can select the minimum size as 1200 GB or increments of 2400 GB. For storage // type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB. Size *int32 - // The type of the network attached storage. + // The type of the network attached storage. Type KxNAS1Type noSmithyDocumentSerde @@ -753,8 +814,10 @@ type KxNode struct { // A unique identifier for the node. NodeId *string - // Specifies the status of the cluster nodes. + // Specifies the status of the cluster nodes. + // // - RUNNING – The node is actively serving. + // // - PROVISIONING – The node is being prepared. Status KxNodeStatus @@ -771,10 +834,11 @@ type KxSavedownStorageConfiguration struct { // The type of writeable storage space for temporarily storing your savedown data. // The valid values are: + // // - SDS01 – This type represents 3000 IOPS and io2 ebs volume type. Type KxSavedownStorageType - // The name of the kdb volume that you want to use as writeable save-down storage + // The name of the kdb volume that you want to use as writeable save-down storage // for clusters. VolumeName *string @@ -787,31 +851,39 @@ type KxScalingGroup struct { // The identifier of the availability zones. AvailabilityZoneId *string - // The list of clusters currently active in a given scaling group. + // The list of clusters currently active in a given scaling group. Clusters []string - // The timestamp at which the scaling group was created in FinSpace. The value is + // The timestamp at which the scaling group was created in FinSpace. 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. CreatedTimestamp *time.Time - // The memory and CPU capabilities of the scaling group host on which FinSpace - // Managed kdb clusters will be placed. You can add one of the following values: + // The memory and CPU capabilities of the scaling group host on which FinSpace + // Managed kdb clusters will be placed. + // + // You can add one of the following values: + // // - kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 // vCPUs. + // // - kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 // vCPUs. + // // - kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 // vCPUs. + // // - kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and // 128 vCPUs. + // // - kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and // 64 vCPUs. + // // - kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and // 96 vCPUs. HostType *string - // The last time that the scaling group was updated in FinSpace. The value is + // The last time that the scaling group was updated in FinSpace. 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. LastModifiedTimestamp *time.Time @@ -819,10 +891,10 @@ type KxScalingGroup struct { // A unique identifier for the kdb scaling group. ScalingGroupName *string - // The status of scaling groups. + // The status of scaling groups. Status KxScalingGroupStatus - // The error message when a failed state occurs. + // The error message when a failed state occurs. StatusReason *string noSmithyDocumentSerde @@ -831,13 +903,13 @@ type KxScalingGroup struct { // The structure that stores the capacity configuration details of a scaling group. type KxScalingGroupConfiguration struct { - // A reservation of the minimum amount of memory that should be available on the + // A reservation of the minimum amount of memory that should be available on the // scaling group for a kdb cluster to be successfully placed in a scaling group. // // This member is required. MemoryReservation *int32 - // The number of kdb cluster nodes. + // The number of kdb cluster nodes. // // This member is required. NodeCount *int32 @@ -847,11 +919,11 @@ type KxScalingGroupConfiguration struct { // This member is required. ScalingGroupName *string - // The number of vCPUs that you want to reserve for each node of this kdb cluster + // The number of vCPUs that you want to reserve for each node of this kdb cluster // on the scaling group host. Cpu *float64 - // An optional hard limit on the amount of memory a kdb cluster can use. + // An optional hard limit on the amount of memory a kdb cluster can use. MemoryLimit *int32 noSmithyDocumentSerde @@ -869,9 +941,10 @@ type KxUser struct { // The timestamp at which the kdb user was updated. UpdateTimestamp *time.Time - // 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/reference_identifiers.html) - // in the IAM User Guide. + // The Amazon Resource Name (ARN) that identifies the user. For more information + // about ARNs and how to use ARNs in policies, see [IAM Identifiers]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html UserArn *string // A unique identifier for the user. @@ -890,12 +963,12 @@ type KxVolume struct { // FinSpace only supports SINGLE for volumes. This places dataview in a single AZ. AzMode KxAzMode - // The timestamp at which the volume was created in FinSpace. The value is + // The timestamp at which the volume was created in FinSpace. 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. CreatedTimestamp *time.Time - // A description of the volume. + // A description of the volume. Description *string // The last time that the volume was updated in FinSpace. The value is determined @@ -904,14 +977,23 @@ type KxVolume struct { LastModifiedTimestamp *time.Time // The status of volume. + // // - CREATING – The volume creation is in progress. + // // - CREATE_FAILED – The volume creation has failed. + // // - ACTIVE – The volume is active. + // // - UPDATING – The volume is in the process of being updated. + // // - UPDATE_FAILED – The update action failed. + // // - UPDATED – The volume is successfully updated. + // // - DELETING – The volume is in the process of being deleted. + // // - DELETE_FAILED – The system failed to delete the volume. + // // - DELETED – The volume is successfully deleted. Status KxVolumeStatus @@ -921,48 +1003,49 @@ type KxVolume struct { // A unique identifier for the volume. VolumeName *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType KxVolumeType noSmithyDocumentSerde } -// The network access control list (ACL) is an optional layer of security for your -// VPC that acts as a firewall for controlling traffic in and out of one or more -// subnets. The entry is a set of numbered ingress and egress rules that determine -// whether a packet should be allowed in or out of a subnet associated with the -// ACL. We process the entries in the ACL according to the rule numbers, in -// ascending order. +// The network access control list (ACL) is an optional layer of security for +// +// your VPC that acts as a firewall for controlling traffic in and out of one or +// more subnets. The entry is a set of numbered ingress and egress rules that +// determine whether a packet should be allowed in or out of a subnet associated +// with the ACL. We process the entries in the ACL according to the rule numbers, +// in ascending order. type NetworkACLEntry struct { - // The IPv4 network range to allow or deny, in CIDR notation. For example, + // 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 . // // This member is required. CidrBlock *string - // The protocol number. A value of -1 means all the protocols. + // The protocol number. A value of -1 means all the protocols. // // This member is required. Protocol *string - // Indicates whether to allow or deny the traffic that matches the rule. + // Indicates whether to allow or deny the traffic that matches the rule. // // This member is required. RuleAction RuleAction - // The rule number for the entry. For example 100. All the network ACL entries are - // processed in ascending order by rule number. + // The rule number for the entry. For example 100. All the network ACL entries + // are processed in ascending order by rule number. // // This member is required. RuleNumber *int32 - // Defines the ICMP protocol that consists of the ICMP type and code. + // Defines the ICMP protocol that consists of the ICMP type and code. IcmpTypeCode *IcmpTypeCode - // The range of ports the rule applies to. + // The range of ports the rule applies to. PortRange *PortRange noSmithyDocumentSerde @@ -971,12 +1054,12 @@ type NetworkACLEntry struct { // The range of ports the rule applies to. type PortRange struct { - // The first port in the range. + // The first port in the range. // // This member is required. From int32 - // The last port in the range. + // The last port in the range. // // This member is required. To int32 @@ -1005,13 +1088,14 @@ type SuperuserParameters struct { noSmithyDocumentSerde } -// A configuration to store the Tickerplant logs. It consists of a list of volumes -// that will be mounted to your cluster. For the cluster type Tickerplant , the -// location of the TP volume on the cluster will be available by using the global -// variable .aws.tp_log_path . +// A configuration to store the Tickerplant logs. It consists of a list of +// +// volumes that will be mounted to your cluster. For the cluster type Tickerplant , +// the location of the TP volume on the cluster will be available by using the +// global variable .aws.tp_log_path . type TickerplantLogConfiguration struct { - // The name of the volumes for tickerplant logs. + // The name of the volumes for tickerplant logs. TickerplantLogVolumes []string noSmithyDocumentSerde @@ -1035,7 +1119,7 @@ type TransitGatewayConfiguration struct { // This member is required. TransitGatewayID *string - // The rules that define how you manage the outbound traffic from kdb network to + // The rules that define how you manage the outbound traffic from kdb network to // your internal network. AttachmentNetworkAclConfiguration []NetworkACLEntry @@ -1048,7 +1132,7 @@ type Volume struct { // A unique identifier for the volume. VolumeName *string - // The type of file system volume. Currently, FinSpace only supports NAS_1 volume + // The type of file system volume. Currently, FinSpace only supports NAS_1 volume // type. VolumeType VolumeType @@ -1061,6 +1145,7 @@ type VpcConfiguration struct { // The IP address type for cluster network configuration parameters. The following // type is available: + // // - IP_V4 – IP address version 4 IpAddressType IPAddressType diff --git a/service/finspacedata/api_op_CreateChangeset.go b/service/finspacedata/api_op_CreateChangeset.go index 7eaba66c17a..3786d1ab77f 100644 --- a/service/finspacedata/api_op_CreateChangeset.go +++ b/service/finspacedata/api_op_CreateChangeset.go @@ -33,10 +33,13 @@ 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. // @@ -51,33 +54,52 @@ type CreateChangesetInput struct { // 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: + // 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. + // + // 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] in the FinSpace User + // Guide. + // + // [Supported Data Types and File Formats]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html // // 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": - // "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 - // 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. + // 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 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]section. + // + // [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 // // This member is required. SourceParams map[string]string diff --git a/service/finspacedata/api_op_CreateDataset.go b/service/finspacedata/api_op_CreateDataset.go index 2037bb508f4..a6a4f5b3213 100644 --- a/service/finspacedata/api_op_CreateDataset.go +++ b/service/finspacedata/api_op_CreateDataset.go @@ -38,7 +38,9 @@ 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. // // This member is required. diff --git a/service/finspacedata/api_op_CreatePermissionGroup.go b/service/finspacedata/api_op_CreatePermissionGroup.go index db6002e64ed..7feb0d4f121 100644 --- a/service/finspacedata/api_op_CreatePermissionGroup.go +++ b/service/finspacedata/api_op_CreatePermissionGroup.go @@ -33,20 +33,29 @@ func (c *Client) CreatePermissionGroup(ctx context.Context, params *CreatePermis type CreatePermissionGroupInput struct { // The option to indicate FinSpace application permissions that are granted to a - // specific group. 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. + // specific group. + // + // 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. // // This member is required. diff --git a/service/finspacedata/api_op_CreateUser.go b/service/finspacedata/api_op_CreateUser.go index 1b72a571e53..2cadd104a41 100644 --- a/service/finspacedata/api_op_CreateUser.go +++ b/service/finspacedata/api_op_CreateUser.go @@ -40,8 +40,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. // @@ -51,7 +53,9 @@ 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. ApiAccess types.ApiAccess diff --git a/service/finspacedata/api_op_EnableUser.go b/service/finspacedata/api_op_EnableUser.go index dc1a8687f32..5396d7fffbb 100644 --- a/service/finspacedata/api_op_EnableUser.go +++ b/service/finspacedata/api_op_EnableUser.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows the specified user to access the FinSpace web application and API. +// Allows the specified user to access the FinSpace web application and API. // // Deprecated: This method will be discontinued. func (c *Client) EnableUser(ctx context.Context, params *EnableUserInput, optFns ...func(*Options)) (*EnableUserOutput, error) { diff --git a/service/finspacedata/api_op_GetChangeset.go b/service/finspacedata/api_op_GetChangeset.go index e4c81cc41ba..9a89627b4ef 100644 --- a/service/finspacedata/api_op_GetChangeset.go +++ b/service/finspacedata/api_op_GetChangeset.go @@ -59,10 +59,13 @@ 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. ChangeType types.ChangeType diff --git a/service/finspacedata/api_op_GetDataView.go b/service/finspacedata/api_op_GetDataView.go index e7b2eee438e..a84309f847a 100644 --- a/service/finspacedata/api_op_GetDataView.go +++ b/service/finspacedata/api_op_GetDataView.go @@ -90,15 +90,22 @@ 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. + // + // - 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 1ed621d58a5..8f92ca68b36 100644 --- a/service/finspacedata/api_op_GetDataset.go +++ b/service/finspacedata/api_op_GetDataset.go @@ -64,7 +64,9 @@ 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. Kind types.DatasetKind @@ -77,9 +79,13 @@ 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. Status types.DatasetStatus diff --git a/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go b/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go index f23861ab0cc..2fc83929dbe 100644 --- a/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go +++ b/service/finspacedata/api_op_GetExternalDataViewAccessDetails.go @@ -13,7 +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. // diff --git a/service/finspacedata/api_op_GetProgrammaticAccessCredentials.go b/service/finspacedata/api_op_GetProgrammaticAccessCredentials.go index 03a59fde60c..2102ccb7ead 100644 --- a/service/finspacedata/api_op_GetProgrammaticAccessCredentials.go +++ b/service/finspacedata/api_op_GetProgrammaticAccessCredentials.go @@ -12,11 +12,11 @@ import ( ) // Request programmatic credentials to use with FinSpace SDK. For more -// information, see Step 2. Access credentials programmatically using IAM access -// key id and secret access key (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials) -// . +// information, see [Step 2. Access credentials programmatically using IAM access key id and secret access key]. // // Deprecated: This method will be discontinued. +// +// [Step 2. Access credentials programmatically using IAM access key id and secret access key]: https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials func (c *Client) GetProgrammaticAccessCredentials(ctx context.Context, params *GetProgrammaticAccessCredentialsInput, optFns ...func(*Options)) (*GetProgrammaticAccessCredentialsOutput, error) { if params == nil { params = &GetProgrammaticAccessCredentialsInput{} diff --git a/service/finspacedata/api_op_GetUser.go b/service/finspacedata/api_op_GetUser.go index c4bccc6ed8c..8f33e1a6fb9 100644 --- a/service/finspacedata/api_op_GetUser.go +++ b/service/finspacedata/api_op_GetUser.go @@ -44,7 +44,9 @@ 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. ApiAccess types.ApiAccess @@ -83,12 +85,16 @@ type GetUserOutput struct { LastName *string // The current status of the user. + // // - CREATING – The creation is in progress. + // // - ENABLED – The user is created and is currently active. + // // - DISABLED – The user 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. // diff --git a/service/finspacedata/api_op_GetWorkingLocation.go b/service/finspacedata/api_op_GetWorkingLocation.go index b92d5906c8d..593ca318070 100644 --- a/service/finspacedata/api_op_GetWorkingLocation.go +++ b/service/finspacedata/api_op_GetWorkingLocation.go @@ -33,8 +33,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. LocationType types.LocationType diff --git a/service/finspacedata/api_op_UpdateChangeset.go b/service/finspacedata/api_op_UpdateChangeset.go index bd463ab2abf..731b9d5023e 100644 --- a/service/finspacedata/api_op_UpdateChangeset.go +++ b/service/finspacedata/api_op_UpdateChangeset.go @@ -44,33 +44,52 @@ type UpdateChangesetInput struct { // 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: + // 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. + // + // 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] in the FinSpace User + // Guide. + // + // [Supported Data Types and File Formats]: https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html // // 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": - // "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 - // 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. + // 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 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]section. + // + // [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 // // 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 882508e8ab3..a14a9b2b0f4 100644 --- a/service/finspacedata/api_op_UpdateDataset.go +++ b/service/finspacedata/api_op_UpdateDataset.go @@ -43,7 +43,9 @@ 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. // // This member is required. diff --git a/service/finspacedata/api_op_UpdatePermissionGroup.go b/service/finspacedata/api_op_UpdatePermissionGroup.go index 37215864cb3..9ed6b89cab6 100644 --- a/service/finspacedata/api_op_UpdatePermissionGroup.go +++ b/service/finspacedata/api_op_UpdatePermissionGroup.go @@ -38,20 +38,29 @@ type UpdatePermissionGroupInput struct { PermissionGroupId *string // 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. + // 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. ApplicationPermissions []types.ApplicationPermission diff --git a/service/finspacedata/api_op_UpdateUser.go b/service/finspacedata/api_op_UpdateUser.go index f6ef5493a0e..28ba8c7c5f8 100644 --- a/service/finspacedata/api_op_UpdateUser.go +++ b/service/finspacedata/api_op_UpdateUser.go @@ -40,7 +40,9 @@ 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. ApiAccess types.ApiAccess @@ -59,8 +61,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. Type types.UserType diff --git a/service/finspacedata/doc.go b/service/finspacedata/doc.go index 4c1b4e268b4..8999b515168 100644 --- a/service/finspacedata/doc.go +++ b/service/finspacedata/doc.go @@ -3,5 +3,5 @@ // Package finspacedata provides the API client, operations, and parameter types // for FinSpace Public API. // -// The FinSpace APIs let you take actions inside the FinSpace. +// The FinSpace APIs let you take actions inside the FinSpace. package finspacedata diff --git a/service/finspacedata/options.go b/service/finspacedata/options.go index ce1e20d6833..2ebec36f9a9 100644 --- a/service/finspacedata/options.go +++ b/service/finspacedata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/finspacedata/types/enums.go b/service/finspacedata/types/enums.go index ff0d3e8021a..a02a16fcafa 100644 --- a/service/finspacedata/types/enums.go +++ b/service/finspacedata/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -34,8 +35,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CreateDataset", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "REPLACE", @@ -87,8 +90,9 @@ const ( ) // Values returns all known values for ColumnDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnDataType) Values() []ColumnDataType { return []ColumnDataType{ "STRING", @@ -115,8 +119,9 @@ const ( ) // Values returns all known values for DatasetKind. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetKind) Values() []DatasetKind { return []DatasetKind{ "TABULAR", @@ -135,8 +140,9 @@ const ( ) // Values returns all known values for DatasetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatus) Values() []DatasetStatus { return []DatasetStatus{ "PENDING", @@ -161,8 +167,9 @@ const ( ) // Values returns all known values for DataViewStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataViewStatus) Values() []DataViewStatus { return []DataViewStatus{ "RUNNING", @@ -191,8 +198,9 @@ const ( ) // Values returns all known values for ErrorCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ErrorCategory) Values() []ErrorCategory { return []ErrorCategory{ "VALIDATION", @@ -215,8 +223,9 @@ const ( ) // Values returns all known values for ExportFileFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportFileFormat) Values() []ExportFileFormat { return []ExportFileFormat{ "PARQUET", @@ -236,8 +245,9 @@ const ( ) // Values returns all known values for IngestionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionStatus) Values() []IngestionStatus { return []IngestionStatus{ "PENDING", @@ -257,8 +267,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -277,8 +288,9 @@ const ( // Values returns all known values for PermissionGroupMembershipStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionGroupMembershipStatus) Values() []PermissionGroupMembershipStatus { return []PermissionGroupMembershipStatus{ "ADDITION_IN_PROGRESS", @@ -297,8 +309,9 @@ const ( ) // Values returns all known values for UserStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserStatus) Values() []UserStatus { return []UserStatus{ "CREATING", @@ -316,8 +329,9 @@ const ( ) // Values returns all known values for UserType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserType) Values() []UserType { return []UserType{ "SUPER_USER", diff --git a/service/finspacedata/types/types.go b/service/finspacedata/types/types.go index 6f43de3ca49..62e6ace4fc4 100644 --- a/service/finspacedata/types/types.go +++ b/service/finspacedata/types/types.go @@ -9,16 +9,16 @@ import ( // The credentials required to access the external Dataview from the S3 location. type AwsCredentials struct { - // The unique identifier for the security credentials. + // The unique identifier for the security credentials. AccessKeyId *string - // The Epoch time when the current credentials expire. + // The Epoch time when the current credentials expire. Expiration int64 - // The secret access key that can be used to sign requests. + // The secret access key that can be used to sign requests. SecretAccessKey *string - // The token that users must pass to use the credentials. + // The token that users must pass to use the credentials. SessionToken *string noSmithyDocumentSerde @@ -28,15 +28,23 @@ 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. ErrorCategory ErrorCategory @@ -60,10 +68,13 @@ 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. ChangeType ChangeType @@ -93,10 +104,15 @@ 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. Status IngestionStatus @@ -119,11 +135,30 @@ 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 @@ -168,7 +203,9 @@ 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. Kind DatasetKind @@ -205,19 +242,26 @@ type DatasetOwnerInfo struct { type DataViewDestinationTypeParams struct { // Destination type for a Dataview. + // // - 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. S3DestinationExportFileFormat ExportFileFormat - // Format Options for S3 Destination type. Here is an example of how you could - // specify the s3DestinationExportFileFormatOptions + // Format Options for S3 Destination type. + // + // Here is an example of how you could specify the + // s3DestinationExportFileFormatOptions + // // { "header": "true", "delimiter": ",", "compression": "gzip" } S3DestinationExportFileFormatOptions map[string]string @@ -228,15 +272,23 @@ 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. ErrorCategory ErrorCategory @@ -289,15 +341,22 @@ 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. + // + // - FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed. Status DataViewStatus noSmithyDocumentSerde @@ -307,20 +366,29 @@ type DataViewSummary struct { 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 - // access to any functionality in their FinSpace environment's application. It - // should only be granted to trusted users. + // 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. ApplicationPermissions []ApplicationPermission @@ -328,7 +396,7 @@ type PermissionGroup struct { // determined as epoch time in milliseconds. CreateTime int64 - // A brief description for the permission group. + // A brief description for the permission group. Description *string // Describes the last time the permission group was updated. The value is @@ -336,9 +404,12 @@ type PermissionGroup struct { LastModifiedTime int64 // Indicates the status of the user within a permission group. + // // - ADDITION_IN_PROGRESS – The user is currently being added to the permission // group. + // // - ADDITION_SUCCESS – The user is successfully added to the permission group. + // // - REMOVAL_IN_PROGRESS – The user is currently being removed from the // permission group. MembershipStatus PermissionGroupMembershipStatus @@ -346,7 +417,7 @@ type PermissionGroup struct { // The name of the permission group. Name *string - // The unique identifier for the permission group. + // The unique identifier for the permission group. PermissionGroupId *string noSmithyDocumentSerde @@ -356,9 +427,12 @@ type PermissionGroup struct { type PermissionGroupByUser struct { // Indicates the status of the user within a permission group. + // // - ADDITION_IN_PROGRESS – The user is currently being added to the permission // group. + // // - ADDITION_SUCCESS – The user is successfully added to the permission group. + // // - REMOVAL_IN_PROGRESS – The user is currently being removed from the // permission group. MembershipStatus PermissionGroupMembershipStatus @@ -372,11 +446,13 @@ type PermissionGroupByUser struct { noSmithyDocumentSerde } -// Permission group parameters for Dataset permissions. Here is an example of how -// you could specify the PermissionGroupParams : { "permissionGroupId": -// "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ {"permission": -// "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": -// "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] } +// Permission group parameters for Dataset permissions. +// +// Here is an example of how you could specify the PermissionGroupParams : +// +// { "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ +// {"permission": "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, +// {"permission": "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] } type PermissionGroupParams struct { // List of resource permissions. @@ -391,18 +467,26 @@ type PermissionGroupParams struct { // Resource permission for a dataset. When you create a dataset, all the other // members of the same user group inherit access to the dataset. You can only // 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: +// Datasets. +// +// The following is a list of valid dataset permissions that you can apply: +// // - 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) -// in the FinSpace User Guide. +// For more information on the dataset permissions, see [Supported Dataset Permissions] in the FinSpace User +// Guide. +// +// [Supported Dataset Permissions]: https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions type ResourcePermission struct { // Permission for a resource. @@ -414,12 +498,12 @@ type ResourcePermission struct { // The location of an external Dataview in an S3 bucket. type S3Location struct { - // The name of the S3 bucket. + // The name of the S3 bucket. // // This member is required. Bucket *string - // The path of the folder, within the S3 bucket that contains the Dataset. + // The path of the folder, within the S3 bucket that contains the Dataset. // // This member is required. Key *string @@ -454,7 +538,9 @@ 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. ApiAccess ApiAccess @@ -478,7 +564,7 @@ type User struct { // epoch time in milliseconds. LastDisabledTime int64 - // Describes the last time the user was activated. The value is determined as + // Describes the last time the user was activated. The value is determined as // epoch time in milliseconds. LastEnabledTime int64 @@ -490,18 +576,23 @@ type User struct { // time in milliseconds. LastModifiedTime int64 - // The last name of the user. + // The last name of the user. LastName *string // The current status of the user. + // // - CREATING – The user creation is in progress. + // // - ENABLED – The user is created and is currently active. + // // - DISABLED – The user is currently inactive. Status UserStatus - // Indicates the type of user. + // 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. Type UserType @@ -516,7 +607,9 @@ 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. ApiAccess ApiAccess @@ -534,22 +627,30 @@ type UserByPermissionGroup struct { LastName *string // Indicates the status of the user within a permission group. + // // - ADDITION_IN_PROGRESS – The user is currently being added to the permission // group. + // // - ADDITION_SUCCESS – The user 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. + // // - CREATING – The user creation is in progress. + // // - ENABLED – The user is created and is currently active. + // // - DISABLED – The user is currently inactive. Status UserStatus - // Indicates the type of user. + // 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. Type UserType diff --git a/service/firehose/api_op_CreateDeliveryStream.go b/service/firehose/api_op_CreateDeliveryStream.go index c4a81d2b2a0..265f82c6d39 100644 --- a/service/firehose/api_op_CreateDeliveryStream.go +++ b/service/firehose/api_op_CreateDeliveryStream.go @@ -11,53 +11,65 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a 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 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 +// Creates a 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 DeleteDeliveryStreamoperation to delete it. +// +// A Firehose delivery stream can be configured to receive records directly from +// providers using PutRecordor 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, such as Amazon Simple Storage Service -// (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch -// Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or -// supported by third-party service providers, including Datadog, Dynatrace, -// LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of -// the following destination configuration parameters: +// 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 StartDeliveryStreamEncryptionto turn on SSE for an +// existing delivery stream that doesn't have SSE enabled. +// +// A delivery stream is configured with a single destination, such as Amazon +// Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, +// Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP +// endpoints owned by or supported by third-party service providers, including +// Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. 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, 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: +// 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, 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. 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 Firehose, and that the permissions for the account are // restricted for Amazon Redshift INSERT permissions. @@ -65,8 +77,9 @@ import ( // Firehose assumes the IAM role that is configured as part of the destination. // The role should allow the 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 Firehose Access to an Amazon S3 Destination (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) -// in the Amazon Firehose Developer Guide. +// information, see [Grant Firehose Access to an Amazon S3 Destination]in the Amazon Firehose Developer Guide. +// +// [Grant Firehose Access to an Amazon S3 Destination]: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 func (c *Client) CreateDeliveryStream(ctx context.Context, params *CreateDeliveryStreamInput, optFns ...func(*Options)) (*CreateDeliveryStreamOutput, error) { if params == nil { params = &CreateDeliveryStreamInput{} @@ -105,7 +118,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. DeliveryStreamType types.DeliveryStreamType @@ -120,9 +135,9 @@ type CreateDeliveryStreamInput struct { // destination. You can specify only one destination. HttpEndpointDestinationConfiguration *types.HttpEndpointDestinationConfiguration - // When a Kinesis data stream is used as the source for the delivery stream, a - // KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon - // Resource Name (ARN) and the role ARN for the source stream. + // When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration + // containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN + // for the source stream. KinesisStreamSourceConfiguration *types.KinesisStreamSourceConfiguration // The configuration for the Amazon MSK cluster to be used as the source for a @@ -147,18 +162,28 @@ 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) - // in the Amazon Web Services Billing and Cost Management User Guide. You can - // specify up to 50 tags when creating a delivery stream. If you specify tags in - // the CreateDeliveryStream action, Amazon Data Firehose performs an additional - // authorization on the firehose:TagDeliveryStream action to verify if users have - // permissions to create tags. If you do not provide this permission, requests to - // create new Firehose delivery streams with IAM resource tags will fail with an - // AccessDeniedException such as following. AccessDeniedException User: - // arn:aws:sts::x:assumed-role/x/x is not authorized to perform: + // information about tags, see [Using Cost Allocation Tags]in the Amazon Web Services Billing and Cost + // Management User Guide. + // + // You can specify up to 50 tags when creating a delivery stream. + // + // If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose + // performs an additional authorization on the firehose:TagDeliveryStream action + // to verify if users have permissions to create tags. If you do not provide this + // permission, requests to create new Firehose delivery streams with IAM resource + // tags will fail with an AccessDeniedException such as following. + // + // AccessDeniedException + // + // User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: // firehose:TagDeliveryStream on resource: // arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an - // identity-based policy. For an example IAM policy, see Tag example. (https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples) + // identity-based policy. + // + // For an example IAM policy, see [Tag example.] + // + // [Tag example.]: https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/firehose/api_op_DeleteDeliveryStream.go b/service/firehose/api_op_DeleteDeliveryStream.go index b45bab75775..01eefe3937a 100644 --- a/service/firehose/api_op_DeleteDeliveryStream.go +++ b/service/firehose/api_op_DeleteDeliveryStream.go @@ -10,20 +10,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a delivery stream and its data. 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. To check the state of a delivery stream, use DescribeDeliveryStream . +// Deletes a delivery stream and its data. +// +// 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. To check the state of a delivery +// stream, use DescribeDeliveryStream. +// // DeleteDeliveryStream is an asynchronous API. When an API request to // DeleteDeliveryStream succeeds, the delivery stream is marked for deletion, and // it goes into 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 respect to delivering the data. Therefore, as a best practice, // first stop any applications that are sending records before you delete a -// delivery stream. Removal of a delivery stream that is in the DELETING state is -// a low priority operation for the service. A stream may remain in the DELETING -// state for several minutes. Therefore, as a best practice, applications should -// not wait for streams in the DELETING state to be removed. +// delivery stream. +// +// Removal of a delivery stream that is in the DELETING state is a low priority +// operation for the service. A stream may remain in the DELETING state for +// several minutes. Therefore, as a best practice, applications should not wait for +// streams in the DELETING state to be removed. func (c *Client) DeleteDeliveryStream(ctx context.Context, params *DeleteDeliveryStreamInput, optFns ...func(*Options)) (*DeleteDeliveryStreamOutput, error) { if params == nil { params = &DeleteDeliveryStreamInput{} @@ -49,10 +54,13 @@ type DeleteDeliveryStreamInput struct { // Set this to true if you want to delete the delivery stream even if Firehose is // unable to retire the grant for the CMK. 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) - // operation to revoke the grant you gave to Firehose. If a failure to retire the - // grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying - // the delete operation. The default value is false. + // invalid state. If you force deletion, you can then use the [RevokeGrant]operation to revoke + // the grant you gave to Firehose. If a failure to retire the grant happens due to + // an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation. + // + // The default value is false. + // + // [RevokeGrant]: https://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html AllowForceDelete *bool noSmithyDocumentSerde diff --git a/service/firehose/api_op_DescribeDeliveryStream.go b/service/firehose/api_op_DescribeDeliveryStream.go index 9c33aef9be5..98ea74f9fad 100644 --- a/service/firehose/api_op_DescribeDeliveryStream.go +++ b/service/firehose/api_op_DescribeDeliveryStream.go @@ -13,12 +13,12 @@ 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 -// you can't invoke CreateDeliveryStream again on it. However, you can invoke the -// 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. +// 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 you can't invoke CreateDeliveryStreamagain on it. However, you can invoke the DeleteDeliveryStream +// operation to delete it. If the status is DELETING_FAILED , you can force +// deletion by invoking DeleteDeliveryStreamagain but with DeleteDeliveryStreamInput$AllowForceDelete set to true. func (c *Client) DescribeDeliveryStream(ctx context.Context, params *DescribeDeliveryStreamInput, optFns ...func(*Options)) (*DescribeDeliveryStreamOutput, error) { if params == nil { params = &DescribeDeliveryStreamInput{} diff --git a/service/firehose/api_op_ListDeliveryStreams.go b/service/firehose/api_op_ListDeliveryStreams.go index 25b475d107f..6919e864c58 100644 --- a/service/firehose/api_op_ListDeliveryStreams.go +++ b/service/firehose/api_op_ListDeliveryStreams.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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, +// 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, // 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,9 +38,12 @@ 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. DeliveryStreamType types.DeliveryStreamType diff --git a/service/firehose/api_op_PutRecord.go b/service/firehose/api_op_PutRecord.go index c7250371d42..4468658db22 100644 --- a/service/firehose/api_op_PutRecord.go +++ b/service/firehose/api_op_PutRecord.go @@ -12,40 +12,52 @@ import ( ) // Writes a single data record into an Amazon Firehose delivery stream. To write -// multiple data records into a delivery stream, use 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 each delivery stream. For more -// information about limits and how to request an increase, see Amazon Firehose -// Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html) . Firehose -// accumulates and publishes a particular metric for a customer account in one -// minute intervals. It is possible that the bursts of incoming bytes/records -// ingested to a delivery stream last only for a few seconds. Due to this, the -// actual spikes in the traffic might not be fully visible in the customer's 1 -// minute CloudWatch metrics. 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. 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 , the API is automatically reinvoked (retried) 3 -// times. If the exception persists, it is possible that the throughput limits have -// been exceeded for the delivery stream. Re-invoking the Put API operations (for -// example, PutRecord and PutRecordBatch) can result in data duplicates. For larger -// data assets, allow for a longer time out before retrying Put API operations. +// multiple data records into a delivery stream, use 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 PutRecordand 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 Firehose Limits]. +// +// Firehose accumulates and publishes a particular metric for a customer account +// in one minute intervals. It is possible that the bursts of incoming +// bytes/records ingested to a delivery stream last only for a few seconds. Due to +// this, the actual spikes in the traffic might not be fully visible in the +// customer's 1 minute CloudWatch metrics. +// +// 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. +// +// 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 , the API is +// automatically reinvoked (retried) 3 times. If the exception persists, it is +// possible that the throughput limits have been exceeded for the delivery stream. +// +// Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) +// can result in data duplicates. For larger data assets, allow for a longer time +// out before retrying Put API operations. +// // Data records sent to 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. +// 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. +// +// [Amazon Firehose Limits]: https://docs.aws.amazon.com/firehose/latest/dev/limits.html 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 0e643940192..e27128dc099 100644 --- a/service/firehose/api_op_PutRecordBatch.go +++ b/service/firehose/api_op_PutRecordBatch.go @@ -13,56 +13,74 @@ 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 -// using these operations are referred to as producers. Firehose accumulates and -// publishes a particular metric for a customer account in one minute intervals. It -// is possible that the bursts of incoming bytes/records ingested to a delivery -// stream last only for a few seconds. Due to this, the actual spikes in the -// traffic might not be fully visible in the customer's 1 minute CloudWatch -// metrics. For information about service quota, see Amazon 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. 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 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. 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 +// write single data records into a delivery stream, use PutRecord. Applications using +// these operations are referred to as producers. +// +// Firehose accumulates and publishes a particular metric for a customer account +// in one minute intervals. It is possible that the bursts of incoming +// bytes/records ingested to a delivery stream last only for a few seconds. Due to +// this, the actual spikes in the traffic might not be fully visible in the +// customer's 1 minute CloudWatch metrics. +// +// For information about service quota, see [Amazon Firehose Quota]. +// +// 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. +// +// 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 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. 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 , the API is automatically -// reinvoked (retried) 3 times. If the exception persists, it is possible that the -// throughput limits have been exceeded for the delivery stream. Re-invoking the -// Put API operations (for example, PutRecord and PutRecordBatch) can result in -// data duplicates. For larger data assets, allow for a longer time out before -// retrying Put API operations. Data records sent to 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. +// 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 , the API is automatically reinvoked +// (retried) 3 times. If the exception persists, it is possible that the throughput +// limits have been exceeded for the delivery stream. +// +// Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) +// can result in data duplicates. For larger data assets, allow for a longer time +// out before retrying Put API operations. +// +// Data records sent to 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. +// +// [Amazon Firehose Quota]: https://docs.aws.amazon.com/firehose/latest/dev/limits.html func (c *Client) PutRecordBatch(ctx context.Context, params *PutRecordBatchInput, optFns ...func(*Options)) (*PutRecordBatchOutput, error) { if params == nil { params = &PutRecordBatchInput{} @@ -96,8 +114,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 PutRecordBatchcall 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 4dd94c8a045..db7a424ee98 100644 --- a/service/firehose/api_op_StartDeliveryStreamEncryption.go +++ b/service/firehose/api_op_StartDeliveryStreamEncryption.go @@ -11,40 +11,50 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables server-side encryption (SSE) for the delivery stream. This operation is -// asynchronous. It returns immediately. When you invoke it, 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 -// 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 , -// respectively. To check the encryption status of a delivery stream, use -// 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 , Firehose schedules the grant it had on -// the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK , -// Firehose creates a grant that enables it to use the new CMK to encrypt and -// decrypt data and to manage the grant. For the KMS grant creation to be -// successful, Firehose APIs StartDeliveryStreamEncryption and CreateDeliveryStream -// should not be called with session credentials that are more than 6 hours old. If -// a delivery stream already has encryption enabled and then you invoke this +// Enables server-side encryption (SSE) for the delivery stream. +// +// This operation is asynchronous. It returns immediately. When you invoke it, +// 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 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$Encryptedand PutRecordBatchOutput$Encrypted, respectively. +// +// To check the encryption status of a delivery stream, use 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 , Firehose schedules the grant it had on the old CMK for +// retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK , Firehose creates a +// grant that enables it to use the new CMK to encrypt and decrypt data and to +// manage the grant. +// +// For the KMS grant creation to be successful, Firehose APIs +// StartDeliveryStreamEncryption and CreateDeliveryStream should not be called +// with session credentials that are more than 6 hours old. +// +// 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 -// 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 -// with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly -// deny the permission for Firehose to invoke KMS encrypt and decrypt operations. +// 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 with a valid CMK. The CMK must be enabled and the +// key policy mustn't explicitly deny the permission for 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. +// 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. 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 70778a1950e..2c7d883689e 100644 --- a/service/firehose/api_op_StopDeliveryStreamEncryption.go +++ b/service/firehose/api_op_StopDeliveryStreamEncryption.go @@ -10,22 +10,26 @@ 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, 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 , 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 -// reach the limit if you call StartDeliveryStreamEncryption 13 times and +// Disables server-side encryption (SSE) for the delivery stream. +// +// This operation is asynchronous. It returns immediately. When you invoke it, +// 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$Encryptedand 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 , 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 reach the limit if you call StartDeliveryStreamEncryption 13 times and // StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour // period. func (c *Client) StopDeliveryStreamEncryption(ctx context.Context, params *StopDeliveryStreamEncryptionInput, optFns ...func(*Options)) (*StopDeliveryStreamEncryptionOutput, error) { diff --git a/service/firehose/api_op_TagDeliveryStream.go b/service/firehose/api_op_TagDeliveryStream.go index 41fb5ddc151..8850e5f0074 100644 --- a/service/firehose/api_op_TagDeliveryStream.go +++ b/service/firehose/api_op_TagDeliveryStream.go @@ -16,11 +16,14 @@ 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) -// 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. +// distinguish the delivery stream. For more information about tags, see [Using Cost Allocation Tags]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. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) TagDeliveryStream(ctx context.Context, params *TagDeliveryStreamInput, optFns ...func(*Options)) (*TagDeliveryStreamOutput, error) { if params == nil { params = &TagDeliveryStreamInput{} diff --git a/service/firehose/api_op_UntagDeliveryStream.go b/service/firehose/api_op_UntagDeliveryStream.go index 1719f936448..e84c60047e8 100644 --- a/service/firehose/api_op_UntagDeliveryStream.go +++ b/service/firehose/api_op_UntagDeliveryStream.go @@ -11,9 +11,11 @@ import ( ) // Removes tags from the specified delivery stream. Removed tags are deleted, and -// you can't recover them after this operation successfully completes. If you -// specify a tag that doesn't exist, the operation ignores it. This operation has a -// limit of five transactions per second per account. +// you can't recover them after this operation successfully completes. +// +// If you specify a tag that doesn't exist, the operation ignores it. +// +// This operation has a limit of five transactions per second per account. func (c *Client) UntagDeliveryStream(ctx context.Context, params *UntagDeliveryStreamInput, optFns ...func(*Options)) (*UntagDeliveryStreamOutput, error) { if params == nil { params = &UntagDeliveryStreamInput{} diff --git a/service/firehose/api_op_UpdateDestination.go b/service/firehose/api_op_UpdateDestination.go index fd830d8d4d9..8435d4bacf2 100644 --- a/service/firehose/api_op_UpdateDestination.go +++ b/service/firehose/api_op_UpdateDestination.go @@ -11,31 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified destination of the specified delivery stream. Use this -// operation to change the destination type (for example, to replace the Amazon S3 -// destination with Amazon Redshift) or change the parameters associated with a -// destination (for example, to change the bucket name of the Amazon S3 +// Updates the specified destination of the specified delivery stream. +// +// Use this operation to change the destination type (for example, to replace the +// Amazon S3 destination with Amazon Redshift) or change the parameters associated +// with a destination (for example, to change the bucket name of the Amazon S3 // destination). The update might not occur immediately. The target delivery stream // remains active while the configurations are updated, so data writes to the // delivery stream can continue during this process. The updated configurations are -// usually effective within a few minutes. Switching between Amazon OpenSearch -// Service and other services is not supported. For an Amazon OpenSearch Service -// destination, you can only update to another Amazon OpenSearch Service -// destination. If the destination type is the same, Firehose merges the -// configuration parameters specified with the destination configuration that -// already exists on the delivery stream. If any of the parameters are not -// specified in the call, the existing values are retained. For example, in the -// Amazon S3 destination, if EncryptionConfiguration is not specified, then the -// existing EncryptionConfiguration is maintained on the destination. If the -// destination type is not the same, for example, changing the destination from -// Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this -// case, all parameters must be specified. Firehose uses -// CurrentDeliveryStreamVersionId to avoid race conditions and 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 -// CurrentDeliveryStreamVersionId in the next call. +// usually effective within a few minutes. +// +// Switching between Amazon OpenSearch Service and other services is not +// supported. For an Amazon OpenSearch Service destination, you can only update to +// another Amazon OpenSearch Service destination. +// +// If the destination type is the same, Firehose merges the configuration +// parameters specified with the destination configuration that already exists on +// the delivery stream. If any of the parameters are not specified in the call, the +// existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfigurationis +// not specified, then the existing EncryptionConfiguration is maintained on the +// destination. +// +// If the destination type is not the same, for example, changing the destination +// from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In +// this case, all parameters must be specified. +// +// Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and +// 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 CurrentDeliveryStreamVersionId +// in the next call. func (c *Client) UpdateDestination(ctx context.Context, params *UpdateDestinationInput, optFns ...func(*Options)) (*UpdateDestinationOutput, error) { if params == nil { params = &UpdateDestinationInput{} @@ -53,12 +59,11 @@ func (c *Client) UpdateDestination(ctx context.Context, params *UpdateDestinatio type UpdateDestinationInput struct { - // 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. + // 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. // // This member is required. CurrentDeliveryStreamVersionId *string diff --git a/service/firehose/doc.go b/service/firehose/doc.go index 62b573296e7..2378ef134db 100644 --- a/service/firehose/doc.go +++ b/service/firehose/doc.go @@ -3,9 +3,12 @@ // Package firehose provides the API client, operations, and parameter types for // Amazon Kinesis Firehose. // -// Amazon Data Firehose Amazon Data Firehose was previously known as Amazon -// Kinesis Data Firehose. Amazon Data Firehose is a fully managed service that -// delivers real-time streaming data to destinations such as Amazon Simple Storage -// Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and -// various other supportd destinations. +// # Amazon Data Firehose +// +// Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose. +// +// Amazon Data Firehose is a fully managed service that delivers real-time +// streaming data to destinations such as Amazon Simple Storage Service (Amazon +// S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other +// supportd destinations. package firehose diff --git a/service/firehose/options.go b/service/firehose/options.go index 3cd93b7b433..2057ed01b3f 100644 --- a/service/firehose/options.go +++ b/service/firehose/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/firehose/types/enums.go b/service/firehose/types/enums.go index 216c58589c3..284c80a9864 100644 --- a/service/firehose/types/enums.go +++ b/service/firehose/types/enums.go @@ -12,8 +12,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AmazonOpenSearchServerlessS3BackupMode) Values() []AmazonOpenSearchServerlessS3BackupMode { return []AmazonOpenSearchServerlessS3BackupMode{ "FailedDocumentsOnly", @@ -34,8 +35,9 @@ const ( // Values returns all known values for AmazonopensearchserviceIndexRotationPeriod. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AmazonopensearchserviceIndexRotationPeriod) Values() []AmazonopensearchserviceIndexRotationPeriod { return []AmazonopensearchserviceIndexRotationPeriod{ "NoRotation", @@ -56,8 +58,9 @@ const ( // Values returns all known values for AmazonopensearchserviceS3BackupMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AmazonopensearchserviceS3BackupMode) Values() []AmazonopensearchserviceS3BackupMode { return []AmazonopensearchserviceS3BackupMode{ "FailedDocumentsOnly", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for CompressionFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionFormat) Values() []CompressionFormat { return []CompressionFormat{ "UNCOMPRESSED", @@ -98,8 +102,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "PUBLIC", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for ContentEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentEncoding) Values() []ContentEncoding { return []ContentEncoding{ "NONE", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for DefaultDocumentIdFormat. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultDocumentIdFormat) Values() []DefaultDocumentIdFormat { return []DefaultDocumentIdFormat{ "FIREHOSE_DEFAULT", @@ -157,8 +164,9 @@ const ( // Values returns all known values for DeliveryStreamEncryptionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStreamEncryptionStatus) Values() []DeliveryStreamEncryptionStatus { return []DeliveryStreamEncryptionStatus{ "ENABLED", @@ -193,6 +201,7 @@ const ( // Values returns all known values for DeliveryStreamFailureType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStreamFailureType) Values() []DeliveryStreamFailureType { return []DeliveryStreamFailureType{ @@ -226,8 +235,9 @@ const ( ) // Values returns all known values for DeliveryStreamStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStreamStatus) Values() []DeliveryStreamStatus { return []DeliveryStreamStatus{ "CREATING", @@ -248,8 +258,9 @@ const ( ) // Values returns all known values for DeliveryStreamType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStreamType) Values() []DeliveryStreamType { return []DeliveryStreamType{ "DirectPut", @@ -271,8 +282,9 @@ const ( // Values returns all known values for ElasticsearchIndexRotationPeriod. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ElasticsearchIndexRotationPeriod) Values() []ElasticsearchIndexRotationPeriod { return []ElasticsearchIndexRotationPeriod{ "NoRotation", @@ -293,6 +305,7 @@ const ( // Values returns all known values for ElasticsearchS3BackupMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ElasticsearchS3BackupMode) Values() []ElasticsearchS3BackupMode { return []ElasticsearchS3BackupMode{ @@ -310,8 +323,9 @@ const ( ) // Values returns all known values for HECEndpointType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HECEndpointType) Values() []HECEndpointType { return []HECEndpointType{ "Raw", @@ -329,6 +343,7 @@ const ( // 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{ @@ -346,8 +361,9 @@ const ( ) // Values returns all known values for KeyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyType) Values() []KeyType { return []KeyType{ "AWS_OWNED_CMK", @@ -363,8 +379,9 @@ const ( ) // Values returns all known values for NoEncryptionConfig. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NoEncryptionConfig) Values() []NoEncryptionConfig { return []NoEncryptionConfig{ "NoEncryption", @@ -381,8 +398,9 @@ const ( ) // Values returns all known values for OrcCompression. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrcCompression) Values() []OrcCompression { return []OrcCompression{ "NONE", @@ -400,8 +418,9 @@ const ( ) // Values returns all known values for OrcFormatVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrcFormatVersion) Values() []OrcFormatVersion { return []OrcFormatVersion{ "V0_11", @@ -419,8 +438,9 @@ const ( ) // Values returns all known values for ParquetCompression. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParquetCompression) Values() []ParquetCompression { return []ParquetCompression{ "UNCOMPRESSED", @@ -438,8 +458,9 @@ const ( ) // Values returns all known values for ParquetWriterVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParquetWriterVersion) Values() []ParquetWriterVersion { return []ParquetWriterVersion{ "V1", @@ -465,8 +486,9 @@ const ( ) // Values returns all known values for ProcessorParameterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessorParameterName) Values() []ProcessorParameterName { return []ProcessorParameterName{ "LambdaArn", @@ -496,8 +518,9 @@ const ( ) // Values returns all known values for ProcessorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessorType) Values() []ProcessorType { return []ProcessorType{ "RecordDeAggregation", @@ -518,8 +541,9 @@ const ( ) // Values returns all known values for RedshiftS3BackupMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedshiftS3BackupMode) Values() []RedshiftS3BackupMode { return []RedshiftS3BackupMode{ "Disabled", @@ -536,8 +560,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -556,6 +581,7 @@ const ( // Values returns all known values for SnowflakeDataLoadingOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SnowflakeDataLoadingOption) Values() []SnowflakeDataLoadingOption { return []SnowflakeDataLoadingOption{ @@ -574,8 +600,9 @@ const ( ) // Values returns all known values for SnowflakeS3BackupMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnowflakeS3BackupMode) Values() []SnowflakeS3BackupMode { return []SnowflakeS3BackupMode{ "FailedDataOnly", @@ -592,8 +619,9 @@ const ( ) // Values returns all known values for SplunkS3BackupMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SplunkS3BackupMode) Values() []SplunkS3BackupMode { return []SplunkS3BackupMode{ "FailedEventsOnly", diff --git a/service/firehose/types/errors.go b/service/firehose/types/errors.go index 229731ee86e..8d7c549405b 100644 --- a/service/firehose/types/errors.go +++ b/service/firehose/types/errors.go @@ -200,9 +200,10 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // 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 Firehose Limits (https://docs.aws.amazon.com/firehose/latest/dev/limits.html) +// exceeded. For more information about limits and how to request an increase, see [Amazon Firehose Limits] // . +// +// [Amazon 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 8f581547075..e8f64dff693 100644 --- a/service/firehose/types/types.go +++ b/service/firehose/types/types.go @@ -16,10 +16,11 @@ type AmazonOpenSearchServerlessBufferingHints struct { IntervalInSeconds *int32 // Buffer incoming data to the specified size, in MBs, before delivering it to the - // destination. The default value is 5. 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 MB/sec, the - // value should be 10 MB or higher. + // destination. The default value is 5. + // + // 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 MB/sec, the value should be 10 MB or higher. SizeInMBs *int32 noSmithyDocumentSerde @@ -178,10 +179,11 @@ type AmazonopensearchserviceBufferingHints struct { IntervalInSeconds *int32 // Buffer incoming data to the specified size, in MBs, before delivering it to the - // destination. The default value is 5. 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 MB/sec, the - // value should be 10 MB or higher. + // destination. The default value is 5. + // + // 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 MB/sec, the value should be 10 MB or higher. SizeInMBs *int32 noSmithyDocumentSerde @@ -358,11 +360,12 @@ type AmazonopensearchserviceDestinationUpdate struct { // The Amazon OpenSearch Service 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, Firehose returns an error during runtime. If you - // upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, - // 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. + // that already has another type, Firehose returns an error during runtime. + // + // If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery + // stream, 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. TypeName *string noSmithyDocumentSerde @@ -414,10 +417,11 @@ type BufferingHints struct { // 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. + // 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. SizeInMBs *int32 noSmithyDocumentSerde @@ -449,18 +453,27 @@ type CopyCommand struct { DataTableName *string // 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 - // possible examples that would apply to 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 the default - // delimiter). delimiter '|' escape - the delimiter should be escaped. fixedwidth - // 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - 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) - // . + // information, see the "Optional Parameters" section of [Amazon Redshift COPY command]. Some possible examples + // that would apply to 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 the default delimiter). + // + // delimiter '|' escape - the delimiter should be escaped. + // + // fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - + // 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]. + // + // [Amazon Redshift COPY command]: https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.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. @@ -474,8 +487,9 @@ type CopyCommand struct { // 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 Firehose Record Format Conversion (https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html) -// . +// information, see [Firehose Record Format Conversion]. +// +// [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 @@ -502,8 +516,9 @@ type DataFormatConversionConfiguration struct { 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) - // . + // see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 @@ -515,14 +530,16 @@ type DeliveryStreamDescription struct { // 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 - // CreateDeliveryStream again on it. However, you can invoke the - // DeleteDeliveryStream operation to delete it. + // CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to + // delete it. // // This member is required. 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. // @@ -554,15 +571,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 - // SourceDescription object describing the source Kinesis data stream. + // If the DeliveryStreamType parameter is KinesisStreamAsSource , a SourceDescription object + // describing the source Kinesis data stream. Source *SourceDescription noSmithyDocumentSerde @@ -570,13 +586,12 @@ type DeliveryStreamDescription struct { // Contains information about the server-side encryption (SSE) status for the // delivery stream, the type customer master key (CMK) in use, if any, and the ARN -// of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the -// DescribeDeliveryStream operation. +// of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream +// operation. 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 @@ -586,15 +601,15 @@ type DeliveryStreamEncryptionConfiguration struct { // 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) - // . + // about CMKs, see [Customer Master Keys (CMKs)]. + // + // [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 - // attempt to enable or disable SSE, respectively. + // full description of the different values of this status, see StartDeliveryStreamEncryptionand 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 noSmithyDocumentSerde @@ -606,22 +621,26 @@ 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 - // KeyType set to CUSTOMER_MANAGED_CMK, 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 Firehose service to use the customer managed - // CMK to perform encryption and decryption. Firehose manages that grant. When you - // invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream - // that is encrypted with a customer managed CMK, 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, Firehose throws a LimitExceededException . To encrypt your delivery - // stream, use symmetric CMKs. 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) - // in the Amazon Web Services Key Management Service developer guide. + // CMKs, see [Customer Master Keys (CMKs)]. When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, + // Firehose invokes the Amazon KMS operation [CreateGrant]to create a grant that allows the + // Firehose service to use the customer managed CMK to perform encryption and + // decryption. Firehose manages that grant. + // + // When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with + // a customer managed CMK, 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 CreateDeliveryStreamor StartDeliveryStreamEncryption operation exceeds this limit, Firehose throws a + // LimitExceededException . + // + // To encrypt your delivery stream, use symmetric CMKs. Firehose doesn't support + // asymmetric CMKs. For information about symmetric and asymmetric CMKs, see [About Symmetric and Asymmetric CMKs]in + // the Amazon Web Services Key Management Service developer guide. + // + // [About Symmetric and Asymmetric CMKs]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html + // [CreateGrant]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html + // [Customer Master Keys (CMKs)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys // // This member is required. KeyType KeyType @@ -635,9 +654,11 @@ type DeliveryStreamEncryptionConfigurationInput struct { } // The deserializer you want Firehose to use for converting the input data from -// JSON. Firehose then serializes the data to its final format using the Serializer -// . 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) . +// JSON. Firehose then serializes the data to its final format using the Serializer. +// Firehose supports two types of deserializers: the [Apache Hive JSON SerDe]and the [OpenX JSON SerDe]. +// +// [Apache Hive JSON SerDe]: https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON +// [OpenX JSON SerDe]: https://github.com/rcongiu/Hive-JSON-Serde type Deserializer struct { // The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, @@ -702,14 +723,16 @@ type DocumentIdOptions struct { // When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique // document ID for each record based on a unique internal identifier. The generated // document ID is stable across multiple delivery attempts, which helps prevent the - // same record from being indexed multiple times with different document IDs. When - // the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs - // in the requests it sends to the Amazon OpenSearch Service. This causes the - // Amazon OpenSearch Service domain to generate document IDs. In case of multiple - // delivery attempts, this may cause the same record to be indexed more than once - // with different document IDs. This option enables write-heavy operations, such as - // the ingestion of logs and observability data, to consume less resources in the - // Amazon OpenSearch Service domain, resulting in improved performance. + // same record from being indexed multiple times with different document IDs. + // + // When the NO_DOCUMENT_ID option is chosen, Firehose does not include any + // document IDs in the requests it sends to the Amazon OpenSearch Service. This + // causes the Amazon OpenSearch Service domain to generate document IDs. In case of + // multiple delivery attempts, this may cause the same record to be indexed more + // than once with different document IDs. This option enables write-heavy + // operations, such as the ingestion of logs and observability data, to consume + // less resources in the Amazon OpenSearch Service domain, resulting in improved + // performance. // // This member is required. DefaultDocumentIdFormat DefaultDocumentIdFormat @@ -742,10 +765,11 @@ type ElasticsearchBufferingHints struct { IntervalInSeconds *int32 // Buffer incoming data to the specified size, in MBs, before delivering it to the - // destination. The default value is 5. 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 MB/sec, the - // value should be 10 MB or higher. + // destination. The default value is 5. + // + // 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 MB/sec, the value should be 10 MB or higher. SizeInMBs *int32 noSmithyDocumentSerde @@ -761,9 +785,10 @@ type ElasticsearchDestinationConfiguration struct { // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for // calling the Amazon ES Configuration API and for indexing documents. For more - // information, see Grant 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) - // . + // information, see [Grant Firehose Access to an Amazon S3 Destination]and [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [Grant Firehose Access to an Amazon S3 Destination]: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 + // [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 @@ -790,15 +815,18 @@ type ElasticsearchDestinationConfiguration struct { // The ARN of the Amazon ES domain. The IAM role must have permissions for // 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 . + // role specified in RoleARN. For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // Specify either ClusterEndpoint or DomainARN . + // + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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]. The 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 IndexRotationPeriod ElasticsearchIndexRotationPeriod // The data processing configuration. @@ -814,15 +842,18 @@ type ElasticsearchDestinationConfiguration struct { // appended to the key prefix. When set to AllDocuments , 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 - // you create the delivery stream. + // see [Amazon S3 Backup for the Amazon ES Destination]. Default value is FailedDocumentsOnly . + // + // You can't change this backup mode after you create the delivery stream. + // + // [Amazon S3 Backup for the Amazon ES Destination]: https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup 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, Firehose returns an error during run time. For Elasticsearch - // 7.x, don't specify a TypeName . + // has another type, Firehose returns an error during run time. + // + // For Elasticsearch 7.x, don't specify a TypeName . TypeName *string // The details of the VPC of the Amazon destination. @@ -848,9 +879,11 @@ type ElasticsearchDestinationDescription struct { // Firehose generated document ID and OpenSearch Service generated document ID. DocumentIdOptions *DocumentIdOptions - // 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) - // . 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]. + // + // Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES. + // + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html DomainARN *string // The Elasticsearch index name. @@ -866,9 +899,9 @@ type ElasticsearchDestinationDescription struct { RetryOptions *ElasticsearchRetryOptions // 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 backup mode. @@ -909,18 +942,21 @@ type ElasticsearchDestinationUpdate struct { // 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 . + // IAM role specified in RoleARN . For more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // Specify either ClusterEndpoint or DomainARN . + // + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html DomainARN *string // The Elasticsearch index name. IndexName *string // 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 . + // IndexName to facilitate the expiration of old data. For more information, see [Index Rotation for the Amazon ES Destination]. + // 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 IndexRotationPeriod ElasticsearchIndexRotationPeriod // The data processing configuration. @@ -932,9 +968,10 @@ type ElasticsearchDestinationUpdate struct { // The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for // calling the Amazon ES Configuration API and for indexing documents. For more - // information, see Grant 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) - // . + // information, see [Grant Firehose Access to an Amazon S3 Destination]and [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [Grant Firehose Access to an Amazon S3 Destination]: https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3 + // [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. @@ -942,11 +979,12 @@ type ElasticsearchDestinationUpdate struct { // 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, Firehose returns an error during runtime. If you upgrade - // Elasticsearch from 6.x to 7.x and don’t update your delivery stream, 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 . + // has another type, Firehose returns an error during runtime. + // + // If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery + // stream, 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 . TypeName *string noSmithyDocumentSerde @@ -981,17 +1019,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]. + // + // [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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 @@ -1023,17 +1061,18 @@ type ExtendedS3DestinationConfiguration struct { // A prefix that 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) . + // information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html ErrorOutputPrefix *string // Specify a file extension. It will override the default file extension FileExtension *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) - // . + // Amazon S3 files. You can also specify a custom prefix, as described in [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html Prefix *string // The data processing configuration. @@ -1053,9 +1092,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]. + // + // [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 @@ -1077,9 +1116,9 @@ type ExtendedS3DestinationDescription struct { EncryptionConfiguration *EncryptionConfiguration // 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 @@ -1101,17 +1140,18 @@ type ExtendedS3DestinationDescription struct { // A prefix that 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) . + // information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html ErrorOutputPrefix *string // Specify a file extension. It will override the default file extension FileExtension *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) - // . + // Amazon S3 files. You can also specify a custom prefix, as described in [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html Prefix *string // The data processing configuration. @@ -1129,9 +1169,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]. + // + // [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. @@ -1161,26 +1201,27 @@ type ExtendedS3DestinationUpdate struct { // A prefix that 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) . + // information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html ErrorOutputPrefix *string // Specify a file extension. It will override the default file extension FileExtension *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) - // . + // Amazon S3 files. You can also specify a custom prefix, as described in [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html Prefix *string // The data processing configuration. ProcessingConfiguration *ProcessingConfiguration // 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 // You can update a delivery stream to enable Amazon S3 backup if it is disabled. @@ -1194,8 +1235,7 @@ 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. @@ -1221,10 +1261,11 @@ type HiveJsonSerDe struct { // Indicates how you want 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 - // milliseconds. If you don't specify a format, Firehose uses + // information, see [Class DateTimeFormat]. You can also use the special value millis to parse + // timestamps in epoch milliseconds. If you don't specify a format, Firehose uses // java.sql.Timestamp::valueOf by default. + // + // [Class DateTimeFormat]: https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html TimestampFormats []string noSmithyDocumentSerde @@ -1242,10 +1283,11 @@ type HttpEndpointBufferingHints struct { IntervalInSeconds *int32 // Buffer incoming data to the specified size, in MBs, before delivering it to the - // destination. The default value is 5. 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 MB/sec, the - // value should be 10 MB or higher. + // destination. The default value is 5. + // + // 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 MB/sec, the value should be 10 MB or higher. SizeInMBs *int32 noSmithyDocumentSerde @@ -1272,10 +1314,12 @@ type HttpEndpointCommonAttribute struct { // delivers data. 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) - // . + // 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]. + // + // [Appendix - HTTP Endpoint Delivery Request and Response Specifications]: https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html // // This member is required. Url *string @@ -1445,9 +1489,10 @@ type HttpEndpointRequestConfiguration struct { CommonAttributes []HttpEndpointCommonAttribute // 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. + // sending the request to the destination. For more information, see [Content-Encoding]in MDN Web + // Docs, the official Mozilla documentation. + // + // [Content-Encoding]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding ContentEncoding ContentEncoding noSmithyDocumentSerde @@ -1483,17 +1528,17 @@ type InputFormatConfiguration struct { // as the source for a delivery stream. 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) - // . + // The ARN of the source Kinesis data stream. For more information, see [Amazon Kinesis Data Streams ARN Format]. + // + // [Amazon 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) - // . + // more information, see [Amazon Web Services Identity and Access Management (IAM) ARN Format]. + // + // [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 // // This member is required. RoleARN *string @@ -1510,14 +1555,15 @@ 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]. + // + // [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) - // . + // information, see [Amazon Web Services Identity and Access Management (IAM) ARN Format]. + // + // [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 RoleARN *string noSmithyDocumentSerde @@ -1528,9 +1574,9 @@ 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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. AWSKMSKeyARN *string @@ -1601,14 +1647,18 @@ type OpenXJsonSerDe struct { // you want 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 . + // 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]. +// +// [Apache ORC]: https://orc.apache.org/docs/ type OrcSerDe struct { // The Hadoop Distributed File System (HDFS) block size. This is useful if you @@ -1646,13 +1696,16 @@ type OrcSerDe struct { // A number between 0 and 1 that defines the tolerance for block padding as a // decimal fraction of stripe size. The default value is 0.05, which means 5 - // percent of stripe size. For the default values of 64 MiB ORC stripes and 256 MiB - // HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum - // of 3.2 MiB for padding within the 256 MiB block. In such a case, if the - // 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. Firehose ignores - // this parameter when OrcSerDe$EnablePadding is false . + // percent of stripe size. + // + // For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the + // default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for + // padding within the 256 MiB block. In such a case, if the 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. + // + // 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 @@ -1679,8 +1732,9 @@ 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]. +// +// [Apache Parquet]: https://parquet.apache.org/documentation/latest/ type ParquetSerDe struct { // The Hadoop Distributed File System (HDFS) block size. This is useful if you @@ -1726,10 +1780,12 @@ type ProcessingConfiguration struct { noSmithyDocumentSerde } -// Describes a data processor. If you want to add a new line delimiter between -// records in objects that are delivered to Amazon S3, choose -// AppendDelimiterToRecord as a processor type. You don’t have to put a processor -// parameter when you select AppendDelimiterToRecord . +// Describes a data processor. +// +// If you want to add a new line delimiter between records in objects that are +// delivered to Amazon S3, choose AppendDelimiterToRecord as a processor type. You +// don’t have to put a processor parameter when you select AppendDelimiterToRecord +// . type Processor struct { // The type of processor. @@ -1763,10 +1819,10 @@ type ProcessorParameter struct { noSmithyDocumentSerde } -// Contains the result for an individual record from a PutRecordBatch request. If -// the record is successfully added to your delivery stream, it receives a record -// ID. If the record fails to be added to your delivery stream, the result includes -// an error code and an error message. +// Contains the result for an individual record from a PutRecordBatch request. If the record is +// successfully added to your delivery stream, it receives a record ID. If the +// record fails to be added to your delivery stream, the result includes an error +// code and an error message. type PutRecordBatchResponseEntry struct { // The error code for an individual record result. @@ -1812,19 +1868,20 @@ type RedshiftDestinationConfiguration struct { Password *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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 // 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. + // 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. // // This member is required. S3Configuration *S3DestinationConfiguration @@ -1869,9 +1926,9 @@ type RedshiftDestinationDescription struct { CopyCommand *CopyCommand // 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 @@ -1928,9 +1985,9 @@ type RedshiftDestinationUpdate struct { RetryOptions *RedshiftRetryOptions // 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 // You can update a delivery stream to enable Amazon S3 backup if it is disabled. @@ -1940,10 +1997,11 @@ type RedshiftDestinationUpdate struct { // The Amazon S3 destination for backup. S3BackupUpdate *S3DestinationUpdate - // The Amazon S3 destination. The compression formats SNAPPY or ZIP cannot be - // specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY - // operation that reads from the S3 bucket doesn't support these compression - // formats. + // The Amazon S3 destination. + // + // The compression formats SNAPPY or ZIP cannot be specified in + // RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation + // that reads from the S3 bucket doesn't support these compression formats. S3Update *S3DestinationUpdate // The name of the user. @@ -1966,7 +2024,8 @@ type RedshiftRetryOptions struct { noSmithyDocumentSerde } -// The retry behavior in case Firehose is unable to deliver data to an Amazon S3 +// The retry behavior in case Firehose is unable to deliver data to an Amazon S3 +// // prefix. type RetryOptions struct { @@ -1980,17 +2039,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]. + // + // [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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 @@ -2003,6 +2062,7 @@ type S3DestinationConfiguration struct { CloudWatchLoggingOptions *CloudWatchLoggingOptions // 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. @@ -2014,14 +2074,15 @@ type S3DestinationConfiguration struct { // A prefix that 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) . + // information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects]. + // + // [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) - // . + // Amazon S3 files. You can also specify a custom prefix, as described in [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html Prefix *string noSmithyDocumentSerde @@ -2030,9 +2091,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]. + // + // [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 @@ -2055,9 +2116,9 @@ type S3DestinationDescription struct { EncryptionConfiguration *EncryptionConfiguration // 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 @@ -2067,14 +2128,15 @@ type S3DestinationDescription struct { // A prefix that 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) . + // information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects]. + // + // [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) - // . + // Amazon S3 files. You can also specify a custom prefix, as described in [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom Prefixes for Amazon S3 Objects]: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html Prefix *string noSmithyDocumentSerde @@ -2083,9 +2145,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]. + // + // [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 @@ -2096,6 +2158,7 @@ type S3DestinationUpdate struct { CloudWatchLoggingOptions *CloudWatchLoggingOptions // 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. @@ -2107,20 +2170,21 @@ type S3DestinationUpdate struct { // A prefix that 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) . + // information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects]. + // + // [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) - // . + // Amazon S3 files. You can also specify a custom prefix, as described in [Custom Prefixes for Amazon S3 Objects]. + // + // [Custom 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) - // . + // information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 noSmithyDocumentSerde @@ -2135,9 +2199,11 @@ 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 @@ -2146,15 +2212,19 @@ type SchemaConfiguration struct { // The role that Firehose can use to access Amazon Web Services Glue. This role // must be in the same account you use for 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. + // 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. + // 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. TableName *string // Specifies the table version for the output data schema. If you don't specify @@ -2167,18 +2237,22 @@ type SchemaConfiguration struct { // The serializer that you want Firehose to use to convert data to the target // format before writing it to Amazon S3. 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) -// . +// serializers: the [ORC SerDe]and the [Parquet SerDe]. +// +// [Parquet SerDe]: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html +// [ORC SerDe]: https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.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]. + // + // [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]. + // + // [Apache Parquet]: https://parquet.apache.org/documentation/latest/ ParquetSerDe *ParquetSerDe noSmithyDocumentSerde @@ -2187,9 +2261,10 @@ type Serializer struct { // Configure Snowflake destination type SnowflakeDestinationConfiguration struct { - // URL for accessing your Snowflake account. This URL must include your account - // identifier (https://docs.snowflake.com/en/user-guide/admin-account-identifier) . - // Note that the protocol (https://) and port number are optional. + // URL for accessing your Snowflake account. This URL must include your [account identifier]. Note + // that the protocol (https://) and port number are optional. + // + // [account identifier]: https://docs.snowflake.com/en/user-guide/admin-account-identifier // // This member is required. AccountUrl *string @@ -2199,9 +2274,9 @@ type SnowflakeDestinationConfiguration struct { // This member is required. Database *string - // The private key used to encrypt your Snowflake client. For information, see - // Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation) - // . + // The private key used to encrypt your Snowflake client. For information, see [Using Key Pair Authentication & Key Rotation]. + // + // [Using Key Pair Authentication & Key Rotation]: https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation // // This member is required. PrivateKey *string @@ -2245,8 +2320,9 @@ type SnowflakeDestinationConfiguration struct { DataLoadingOption SnowflakeDataLoadingOption // Passphrase to decrypt the private key when the key is encrypted. For - // information, see Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation) - // . + // information, see [Using Key Pair Authentication & Key Rotation]. + // + // [Using Key Pair Authentication & Key Rotation]: https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation KeyPassphrase *string // The name of the record metadata column @@ -2267,8 +2343,9 @@ type SnowflakeDestinationConfiguration struct { SnowflakeRoleConfiguration *SnowflakeRoleConfiguration // The VPCE ID for Firehose to privately connect with Snowflake. The ID format is - // com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon - // PrivateLink & Snowflake (https://docs.snowflake.com/en/user-guide/admin-security-privatelink) + // com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake] + // + // [Amazon PrivateLink & Snowflake]: https://docs.snowflake.com/en/user-guide/admin-security-privatelink SnowflakeVpcConfiguration *SnowflakeVpcConfiguration noSmithyDocumentSerde @@ -2277,9 +2354,10 @@ type SnowflakeDestinationConfiguration struct { // Optional Snowflake destination description type SnowflakeDestinationDescription struct { - // URL for accessing your Snowflake account. This URL must include your account - // identifier (https://docs.snowflake.com/en/user-guide/admin-account-identifier) . - // Note that the protocol (https://) and port number are optional. + // URL for accessing your Snowflake account. This URL must include your [account identifier]. Note + // that the protocol (https://) and port number are optional. + // + // [account identifier]: https://docs.snowflake.com/en/user-guide/admin-account-identifier AccountUrl *string // Describes the Amazon CloudWatch logging options for your delivery stream. @@ -2324,8 +2402,9 @@ type SnowflakeDestinationDescription struct { SnowflakeRoleConfiguration *SnowflakeRoleConfiguration // The VPCE ID for Firehose to privately connect with Snowflake. The ID format is - // com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon - // PrivateLink & Snowflake (https://docs.snowflake.com/en/user-guide/admin-security-privatelink) + // com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake] + // + // [Amazon PrivateLink & Snowflake]: https://docs.snowflake.com/en/user-guide/admin-security-privatelink SnowflakeVpcConfiguration *SnowflakeVpcConfiguration // All data in Snowflake is stored in database tables, logically structured as @@ -2341,9 +2420,10 @@ type SnowflakeDestinationDescription struct { // Update to configuration settings type SnowflakeDestinationUpdate struct { - // URL for accessing your Snowflake account. This URL must include your account - // identifier (https://docs.snowflake.com/en/user-guide/admin-account-identifier) . - // Note that the protocol (https://) and port number are optional. + // URL for accessing your Snowflake account. This URL must include your [account identifier]. Note + // that the protocol (https://) and port number are optional. + // + // [account identifier]: https://docs.snowflake.com/en/user-guide/admin-account-identifier AccountUrl *string // Describes the Amazon CloudWatch logging options for your delivery stream. @@ -2352,7 +2432,7 @@ type SnowflakeDestinationUpdate struct { // The name of the content metadata column ContentColumnName *string - // JSON keys mapped to table column names or choose to split the JSON payload + // JSON keys mapped to table column names or choose to split the JSON payload // where content is mapped to a record content column and source metadata is mapped // to a record metadata column. DataLoadingOption SnowflakeDataLoadingOption @@ -2361,36 +2441,42 @@ type SnowflakeDestinationUpdate struct { Database *string // Passphrase to decrypt the private key when the key is encrypted. For - // information, see Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation) - // . + // information, see [Using Key Pair Authentication & Key Rotation]. + // + // [Using Key Pair Authentication & Key Rotation]: https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation KeyPassphrase *string // The name of the record metadata column MetaDataColumnName *string - // The private key used to encrypt your Snowflake client. For information, see - // Using Key Pair Authentication & Key Rotation (https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation) - // . + // The private key used to encrypt your Snowflake client. For information, see [Using Key Pair Authentication & Key Rotation]. + // + // [Using Key Pair Authentication & Key Rotation]: https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation PrivateKey *string // Describes a data processing configuration. ProcessingConfiguration *ProcessingConfiguration // Specify how long Firehose retries sending data to the New Relic HTTP endpoint. + // // After sending data, Firehose first waits for an acknowledgment from the HTTP // endpoint. If an error occurs or the acknowledgment doesn’t arrive within the // acknowledgment timeout period, Firehose starts the retry duration counter. It // keeps retrying until the retry duration expires. After that, Firehose considers - // it a data delivery failure and backs up the data to your Amazon S3 bucket. Every - // time that Firehose sends data to the HTTP endpoint (either the initial attempt - // or a retry), it restarts the acknowledgement timeout counter and waits for an - // acknowledgement from the HTTP endpoint. Even if the retry duration expires, - // Firehose still waits for the acknowledgment until it receives it or the - // acknowledgement timeout period is reached. If the acknowledgment times out, - // Firehose determines whether there's time left in the retry counter. If there is - // time left, it retries again and repeats the logic until it receives an - // acknowledgment or determines that the retry time has expired. If you don't want - // Firehose to retry sending data, set this value to 0. + // it a data delivery failure and backs up the data to your Amazon S3 bucket. + // + // Every time that Firehose sends data to the HTTP endpoint (either the initial + // attempt or a retry), it restarts the acknowledgement timeout counter and waits + // for an acknowledgement from the HTTP endpoint. + // + // Even if the retry duration expires, Firehose still waits for the acknowledgment + // until it receives it or the acknowledgement timeout period is reached. If the + // acknowledgment times out, Firehose determines whether there's time left in the + // retry counter. If there is time left, it retries again and repeats the logic + // until it receives an acknowledgment or determines that the retry time has + // expired. + // + // If you don't want Firehose to retry sending data, set this value to 0. RetryOptions *SnowflakeRetryOptions // The Amazon Resource Name (ARN) of the Snowflake role @@ -2421,20 +2507,25 @@ type SnowflakeDestinationUpdate struct { } // Specify how long Firehose retries sending data to the New Relic HTTP endpoint. +// // After sending data, Firehose first waits for an acknowledgment from the HTTP // endpoint. If an error occurs or the acknowledgment doesn’t arrive within the // acknowledgment timeout period, Firehose starts the retry duration counter. It // keeps retrying until the retry duration expires. After that, Firehose considers -// it a data delivery failure and backs up the data to your Amazon S3 bucket. Every -// time that Firehose sends data to the HTTP endpoint (either the initial attempt -// or a retry), it restarts the acknowledgement timeout counter and waits for an -// acknowledgement from the HTTP endpoint. Even if the retry duration expires, -// Firehose still waits for the acknowledgment until it receives it or the -// acknowledgement timeout period is reached. If the acknowledgment times out, -// Firehose determines whether there's time left in the retry counter. If there is -// time left, it retries again and repeats the logic until it receives an -// acknowledgment or determines that the retry time has expired. If you don't want -// Firehose to retry sending data, set this value to 0. +// it a data delivery failure and backs up the data to your Amazon S3 bucket. +// +// Every time that Firehose sends data to the HTTP endpoint (either the initial +// attempt or a retry), it restarts the acknowledgement timeout counter and waits +// for an acknowledgement from the HTTP endpoint. +// +// Even if the retry duration expires, Firehose still waits for the acknowledgment +// until it receives it or the acknowledgement timeout period is reached. If the +// acknowledgment times out, Firehose determines whether there's time left in the +// retry counter. If there is time left, it retries again and repeats the logic +// until it receives an acknowledgment or determines that the retry time has +// expired. +// +// If you don't want Firehose to retry sending data, set this value to 0. type SnowflakeRetryOptions struct { // the time period where Firehose will retry sending data to the chosen HTTP @@ -2461,8 +2552,9 @@ type SnowflakeRoleConfiguration struct { type SnowflakeVpcConfiguration struct { // The VPCE ID for Firehose to privately connect with Snowflake. The ID format is - // com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon - // PrivateLink & Snowflake (https://docs.snowflake.com/en/user-guide/admin-security-privatelink) + // com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see [Amazon PrivateLink & Snowflake] + // + // [Amazon PrivateLink & Snowflake]: https://docs.snowflake.com/en/user-guide/admin-security-privatelink // // This member is required. PrivateLinkVpceId *string @@ -2546,9 +2638,10 @@ type SplunkDestinationConfiguration struct { // FailedEventsOnly , Firehose writes any data that could not be indexed to the // configured Amazon S3 destination. When set to AllEvents , 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 . + // 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 @@ -2634,9 +2727,10 @@ type SplunkDestinationUpdate struct { // FailedDocumentsOnly , Firehose writes any data that could not be indexed to the // configured Amazon S3 destination. When set to AllEvents , 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 . + // 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. @@ -2685,14 +2779,23 @@ type VpcConfiguration struct { // role or you can specify a new role. In either case, make sure that the role // trusts the 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 + // // When you specify subnets for delivering data to the destination in a private // VPC, make sure you have enough number of free IP addresses in chosen subnets. If // there is no available free IP address in a specified subnet, Firehose cannot @@ -2710,8 +2813,9 @@ 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) - // in the Amazon VPC documentation. + // information about security group rules, see [Security group rules]in the Amazon VPC documentation. + // + // [Security group rules]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules // // This member is required. SecurityGroupIds []string @@ -2721,14 +2825,16 @@ type VpcConfiguration struct { // outbound rules allow traffic to flow from the subnets whose IDs are specified // here to the subnets that have the destination Amazon ES endpoints. 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 Firehose creates in the - // subnets specified here scales up and down automatically based on throughput. To - // enable 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 - // 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. + // delete or modify these ENIs. + // + // The number of ENIs that Firehose creates in the subnets specified here scales + // up and down automatically based on throughput. To enable 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 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]in the Amazon VPC Quotas topic. + // + // [Network Interfaces]: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis // // This member is required. SubnetIds []string @@ -2743,14 +2849,23 @@ type VpcConfigurationDescription struct { // the destination VPC. You can use your existing Firehose delivery role or you can // specify a new role. In either case, make sure that the role trusts the 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, Firehose // can't scale out by creating more ENIs when necessary. You might therefore see a // degradation in performance. @@ -2766,8 +2881,9 @@ type VpcConfigurationDescription struct { // 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) - // in the Amazon VPC documentation. + // security group rules, see [Security group rules]in the Amazon VPC documentation. + // + // [Security group rules]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules // // This member is required. SecurityGroupIds []string @@ -2777,14 +2893,16 @@ type VpcConfigurationDescription struct { // outbound rules allow traffic to flow from the subnets whose IDs are specified // here to the subnets that have the destination Amazon ES endpoints. 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 Firehose creates in the - // subnets specified here scales up and down automatically based on throughput. To - // enable 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 - // 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. + // delete or modify these ENIs. + // + // The number of ENIs that Firehose creates in the subnets specified here scales + // up and down automatically based on throughput. To enable 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 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]in the Amazon VPC Quotas topic. + // + // [Network Interfaces]: https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis // // This member is required. SubnetIds []string diff --git a/service/fis/api_op_CreateExperimentTemplate.go b/service/fis/api_op_CreateExperimentTemplate.go index 02b339e8aa0..5fadb6b48b0 100644 --- a/service/fis/api_op_CreateExperimentTemplate.go +++ b/service/fis/api_op_CreateExperimentTemplate.go @@ -11,20 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an experiment template. An experiment template includes the following -// components: +// 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. // -// For more information, see experiment templates (https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) -// in the Fault Injection Service User Guide. +// For more information, see [experiment templates] in the Fault Injection Service User Guide. +// +// [experiment templates]: https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html func (c *Client) CreateExperimentTemplate(ctx context.Context, params *CreateExperimentTemplateInput, optFns ...func(*Options)) (*CreateExperimentTemplateOutput, error) { if params == nil { params = &CreateExperimentTemplateInput{} diff --git a/service/fis/api_op_CreateTargetAccountConfiguration.go b/service/fis/api_op_CreateTargetAccountConfiguration.go index 15cf20ab28d..cac21587ced 100644 --- a/service/fis/api_op_CreateTargetAccountConfiguration.go +++ b/service/fis/api_op_CreateTargetAccountConfiguration.go @@ -13,8 +13,10 @@ import ( // Creates a target account configuration for the experiment template. A target // account configuration is required when accountTargeting of experimentOptions is -// set to multi-account . For more information, see experiment options (https://docs.aws.amazon.com/fis/latest/userguide/experiment-options.html) -// in the Fault Injection Service User Guide. +// set to multi-account . For more information, see [experiment options] in the Fault Injection +// Service User Guide. +// +// [experiment options]: https://docs.aws.amazon.com/fis/latest/userguide/experiment-options.html func (c *Client) CreateTargetAccountConfiguration(ctx context.Context, params *CreateTargetAccountConfigurationInput, optFns ...func(*Options)) (*CreateTargetAccountConfigurationOutput, error) { if params == nil { params = &CreateTargetAccountConfigurationInput{} diff --git a/service/fis/doc.go b/service/fis/doc.go index be67c84f3e4..a0b507f56d4 100644 --- a/service/fis/doc.go +++ b/service/fis/doc.go @@ -5,6 +5,7 @@ // // Fault Injection Service 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 Service User Guide (https://docs.aws.amazon.com/fis/latest/userguide/) -// . +// information, see the [Fault Injection Service User Guide]. +// +// [Fault Injection Service User Guide]: https://docs.aws.amazon.com/fis/latest/userguide/ package fis diff --git a/service/fis/options.go b/service/fis/options.go index 0e200e39066..3e0ef0cc998 100644 --- a/service/fis/options.go +++ b/service/fis/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/fis/types/enums.go b/service/fis/types/enums.go index a055e145bbd..6279040d44b 100644 --- a/service/fis/types/enums.go +++ b/service/fis/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccountTargeting. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountTargeting) Values() []AccountTargeting { return []AccountTargeting{ "single-account", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ActionsMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionsMode) Values() []ActionsMode { return []ActionsMode{ "skip-all", @@ -48,6 +50,7 @@ const ( // Values returns all known values for EmptyTargetResolutionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EmptyTargetResolutionMode) Values() []EmptyTargetResolutionMode { return []EmptyTargetResolutionMode{ @@ -72,8 +75,9 @@ const ( ) // Values returns all known values for ExperimentActionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentActionStatus) Values() []ExperimentActionStatus { return []ExperimentActionStatus{ "pending", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for ExperimentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperimentStatus) Values() []ExperimentStatus { return []ExperimentStatus{ "pending", diff --git a/service/fis/types/types.go b/service/fis/types/types.go index 261d816ff24..29ceae6bffb 100644 --- a/service/fis/types/types.go +++ b/service/fis/types/types.go @@ -7,8 +7,10 @@ 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 Service User Guide. +// Describes an action. For more information, see [FIS actions] in the Fault Injection Service +// User Guide. +// +// [FIS actions]: https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html type Action struct { // The Amazon Resource Name (ARN) of the action. @@ -74,9 +76,11 @@ type ActionTarget struct { noSmithyDocumentSerde } -// Specifies an action for an experiment template. For more information, see -// Actions (https://docs.aws.amazon.com/fis/latest/userguide/actions.html) in the -// Fault Injection Service User Guide. +// Specifies an action for an experiment template. +// +// For more information, see [Actions] in the Fault Injection Service User Guide. +// +// [Actions]: https://docs.aws.amazon.com/fis/latest/userguide/actions.html type CreateExperimentTemplateActionInput struct { // The ID of the action. The format of the action ID is: @@ -149,8 +153,11 @@ 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 Service User Guide. +// and tags. +// +// For more information, see [Targets] in the Fault Injection Service User Guide. +// +// [Targets]: https://docs.aws.amazon.com/fis/latest/userguide/targets.html type CreateExperimentTemplateTargetInput struct { // The resource type. The resource type must be supported for the specified action. @@ -161,10 +168,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. @@ -664,9 +674,11 @@ 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) -// in the Fault Injection Service User Guide. +// Specifies a filter used for the target resource input in an experiment template. +// +// For more information, see [Resource filters] in the Fault Injection Service User Guide. +// +// [Resource filters]: https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters type ExperimentTemplateTargetInputFilter struct { // The attribute path for the filter. diff --git a/service/fms/api_op_AssociateAdminAccount.go b/service/fms/api_op_AssociateAdminAccount.go index 27d04407e66..827ef91ba68 100644 --- a/service/fms/api_op_AssociateAdminAccount.go +++ b/service/fms/api_op_AssociateAdminAccount.go @@ -14,10 +14,12 @@ import ( // default administrator account can manage third-party firewalls and has full // administrative scope that allows administration of all policy types, accounts, // organizational units, and Regions. This account must be a member account of the -// organization in Organizations whose resources you want to protect. For -// information about working with Firewall Manager administrator accounts, see -// Managing Firewall Manager administrators (https://docs.aws.amazon.com/organizations/latest/userguide/fms-administrators.html) +// organization in Organizations whose resources you want to protect. +// +// For information about working with Firewall Manager administrator accounts, see [Managing Firewall Manager administrators] // in the Firewall Manager Developer Guide. +// +// [Managing Firewall Manager administrators]: https://docs.aws.amazon.com/organizations/latest/userguide/fms-administrators.html func (c *Client) AssociateAdminAccount(ctx context.Context, params *AssociateAdminAccountInput, optFns ...func(*Options)) (*AssociateAdminAccountOutput, error) { if params == nil { params = &AssociateAdminAccountInput{} @@ -38,9 +40,9 @@ type AssociateAdminAccountInput struct { // The Amazon Web Services account ID to associate with Firewall Manager as the // Firewall Manager default administrator account. This account must be a member // account of the organization in Organizations whose resources you want to - // protect. 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) - // . + // protect. For more information about Organizations, see [Managing the Amazon Web Services Accounts in Your Organization]. + // + // [Managing the Amazon Web 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 4af73b65234..58435c411cb 100644 --- a/service/fms/api_op_AssociateThirdPartyFirewall.go +++ b/service/fms/api_op_AssociateThirdPartyFirewall.go @@ -44,14 +44,19 @@ 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. ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus diff --git a/service/fms/api_op_DeletePolicy.go b/service/fms/api_op_DeletePolicy.go index 265ab180acd..d0731aaa701 100644 --- a/service/fms/api_op_DeletePolicy.go +++ b/service/fms/api_op_DeletePolicy.go @@ -34,26 +34,35 @@ type DeletePolicyInput struct { // This member is required. PolicyId *string - // If True , the request performs cleanup according to the policy type. For WAF and - // Shield Advanced policies, the cleanup does the following: + // 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 + // // For security group common policies, even if set to False , Firewall Manager // deletes all security groups created by Firewall Manager that aren't associated - // with any other 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. + // with any other 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_DeleteResourceSet.go b/service/fms/api_op_DeleteResourceSet.go index ca0d6ac0e50..5cb350c7844 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_DisassociateAdminAccount.go b/service/fms/api_op_DisassociateAdminAccount.go index e9b8666c2cd..694b91e8bc7 100644 --- a/service/fms/api_op_DisassociateAdminAccount.go +++ b/service/fms/api_op_DisassociateAdminAccount.go @@ -11,12 +11,13 @@ import ( ) // Disassociates an Firewall Manager administrator account. To set a different -// account as an Firewall Manager administrator, submit a PutAdminAccount request. -// To set an account as a default administrator account, you must submit an -// AssociateAdminAccount request. Disassociation of the default administrator -// account follows the first in, last out principle. If you are the default -// administrator, all Firewall Manager administrators within the organization must -// first disassociate their accounts before you can disassociate your account. +// account as an Firewall Manager administrator, submit a PutAdminAccountrequest. To set an +// account as a default administrator account, you must submit an AssociateAdminAccountrequest. +// +// Disassociation of the default administrator account follows the first in, last +// out principle. If you are the default administrator, all Firewall Manager +// administrators within the organization must first disassociate their accounts +// before you can disassociate your account. func (c *Client) DisassociateAdminAccount(ctx context.Context, params *DisassociateAdminAccountInput, optFns ...func(*Options)) (*DisassociateAdminAccountOutput, error) { if params == nil { params = &DisassociateAdminAccountInput{} diff --git a/service/fms/api_op_GetAdminScope.go b/service/fms/api_op_GetAdminScope.go index 60128bd6fb2..d5a59a4954e 100644 --- a/service/fms/api_op_GetAdminScope.go +++ b/service/fms/api_op_GetAdminScope.go @@ -46,13 +46,17 @@ type GetAdminScopeOutput struct { // The current status of the request to onboard a member account as an Firewall // Manager administrator. + // // - ONBOARDING - The account is onboarding to Firewall Manager as an // administrator. + // // - ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall // Manager as an administrator, and can perform actions on the resources defined in - // their AdminScope . + // their AdminScope. + // // - OFFBOARDING - The account is being removed as an Firewall Manager // administrator. + // // - OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager // administrator. Status types.OrganizationStatus diff --git a/service/fms/api_op_GetComplianceDetail.go b/service/fms/api_op_GetComplianceDetail.go index e92f65c035a..fc2c9597b41 100644 --- a/service/fms/api_op_GetComplianceDetail.go +++ b/service/fms/api_op_GetComplianceDetail.go @@ -13,8 +13,10 @@ import ( // Returns detailed compliance information about the specified member account. // Details include resources that are in and out of compliance with the specified -// policy. The reasons for resources being considered compliant depend on the -// Firewall Manager policy type. +// policy. +// +// The reasons for resources being considered compliant depend on the Firewall +// Manager policy type. func (c *Client) GetComplianceDetail(ctx context.Context, params *GetComplianceDetailInput, optFns ...func(*Options)) (*GetComplianceDetailOutput, error) { if params == nil { params = &GetComplianceDetailInput{} diff --git a/service/fms/api_op_GetProtectionStatus.go b/service/fms/api_op_GetProtectionStatus.go index 8f9a16bd8ff..92b02ac9762 100644 --- a/service/fms/api_op_GetProtectionStatus.go +++ b/service/fms/api_op_GetProtectionStatus.go @@ -76,22 +76,29 @@ 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. 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. + // 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 diff --git a/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go b/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go index 28388ccf8bf..6759615fd32 100644 --- a/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go +++ b/service/fms/api_op_GetThirdPartyFirewallAssociationStatus.go @@ -42,11 +42,14 @@ 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. @@ -54,14 +57,19 @@ type GetThirdPartyFirewallAssociationStatusOutput struct { // 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. ThirdPartyFirewallStatus types.ThirdPartyFirewallAssociationStatus diff --git a/service/fms/api_op_GetViolationDetails.go b/service/fms/api_op_GetViolationDetails.go index 2537fccf272..de778c0533e 100644 --- a/service/fms/api_op_GetViolationDetails.go +++ b/service/fms/api_op_GetViolationDetails.go @@ -37,11 +37,17 @@ type GetViolationDetailsInput struct { // The ID of the Firewall Manager policy that you want the details for. You can // get violation details for the following policy types: + // // - DNS Firewall + // // - Imported Network Firewall + // // - Network Firewall + // // - Security group content audit + // // - Network ACL + // // - Third-party firewall // // This member is required. @@ -52,12 +58,13 @@ type GetViolationDetailsInput struct { // This member is required. 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 + // The resource type. This is in the format shown in the [Amazon Web Services Resource Types Reference]. Supported resource + // types are: AWS::EC2::Instance , AWS::EC2::NetworkInterface , + // AWS::EC2::SecurityGroup , AWS::NetworkFirewall::FirewallPolicy , and // AWS::EC2::Subnet . // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html + // // This member is required. ResourceType *string diff --git a/service/fms/api_op_ListAdminAccountsForOrganization.go b/service/fms/api_op_ListAdminAccountsForOrganization.go index 7b1041a4dbd..9180fc2c21d 100644 --- a/service/fms/api_op_ListAdminAccountsForOrganization.go +++ b/service/fms/api_op_ListAdminAccountsForOrganization.go @@ -12,9 +12,9 @@ import ( ) // Returns a AdminAccounts object that lists the Firewall Manager administrators -// within the organization that are onboarded to Firewall Manager by -// AssociateAdminAccount . This operation can be called only from the -// organization's management account. +// within the organization that are onboarded to Firewall Manager by AssociateAdminAccount. +// +// This operation can be called only from the organization's management account. func (c *Client) ListAdminAccountsForOrganization(ctx context.Context, params *ListAdminAccountsForOrganizationInput, optFns ...func(*Options)) (*ListAdminAccountsForOrganizationOutput, error) { if params == nil { params = &ListAdminAccountsForOrganizationInput{} @@ -51,7 +51,7 @@ type ListAdminAccountsForOrganizationInput struct { type ListAdminAccountsForOrganizationOutput struct { // A list of Firewall Manager administrator accounts within the organization that - // were onboarded as administrators by AssociateAdminAccount or PutAdminAccount . + // were onboarded as administrators by AssociateAdminAccountor PutAdminAccount. AdminAccounts []types.AdminAccountSummary // When you request a list of objects with a MaxResults setting, if the number of diff --git a/service/fms/api_op_ListAdminsManagingAccount.go b/service/fms/api_op_ListAdminsManagingAccount.go index d5e775cefd4..355cf2560d1 100644 --- a/service/fms/api_op_ListAdminsManagingAccount.go +++ b/service/fms/api_op_ListAdminsManagingAccount.go @@ -13,7 +13,7 @@ import ( // Lists the accounts that are managing the specified Organizations member // account. This is useful for any member account so that they can view the // accounts who are managing their account. This operation only returns the -// managing administrators that have the requested account within their AdminScope . +// managing administrators that have the requested account within their AdminScope. func (c *Client) ListAdminsManagingAccount(ctx context.Context, params *ListAdminsManagingAccountInput, optFns ...func(*Options)) (*ListAdminsManagingAccountOutput, error) { if params == nil { params = &ListAdminsManagingAccountInput{} @@ -49,7 +49,7 @@ type ListAdminsManagingAccountInput struct { type ListAdminsManagingAccountOutput struct { - // The list of accounts who manage member accounts within their AdminScope . + // The list of accounts who manage member accounts within their AdminScope. AdminAccounts []string // When you request a list of objects with a MaxResults setting, if the number of diff --git a/service/fms/api_op_ListAppsLists.go b/service/fms/api_op_ListAppsLists.go index 8ee3432043a..c1a0ac56f01 100644 --- a/service/fms/api_op_ListAppsLists.go +++ b/service/fms/api_op_ListAppsLists.go @@ -32,8 +32,9 @@ 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 - // available objects. + // next batch of objects. + // + // If you don't specify this, Firewall Manager returns all available objects. // // This member is required. MaxResults *int32 @@ -159,8 +160,9 @@ 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 - // available objects. + // next batch of objects. + // + // If you don't specify this, Firewall Manager returns all available objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fms/api_op_ListMemberAccounts.go b/service/fms/api_op_ListMemberAccounts.go index 92c482a467d..87ed4399a37 100644 --- a/service/fms/api_op_ListMemberAccounts.go +++ b/service/fms/api_op_ListMemberAccounts.go @@ -11,8 +11,10 @@ import ( ) // Returns a MemberAccounts object that lists the member accounts in the -// administrator's Amazon Web Services organization. Either an Firewall Manager -// administrator or the organization's management account can make this request. +// administrator's Amazon Web Services organization. +// +// Either an Firewall Manager administrator or the organization's management +// account can make this request. func (c *Client) ListMemberAccounts(ctx context.Context, params *ListMemberAccountsInput, optFns ...func(*Options)) (*ListMemberAccountsOutput, error) { if params == nil { params = &ListMemberAccountsInput{} diff --git a/service/fms/api_op_ListProtocolsLists.go b/service/fms/api_op_ListProtocolsLists.go index 015cebe5f03..ace0e20c5ce 100644 --- a/service/fms/api_op_ListProtocolsLists.go +++ b/service/fms/api_op_ListProtocolsLists.go @@ -32,8 +32,9 @@ 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 - // available objects. + // next batch of objects. + // + // If you don't specify this, Firewall Manager returns all available objects. // // This member is required. MaxResults *int32 @@ -161,8 +162,9 @@ 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 - // available objects. + // next batch of objects. + // + // If you don't specify this, Firewall Manager returns all available objects. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go b/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go index 7e2ab27b8dd..d2fbc04b1e4 100644 --- a/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go +++ b/service/fms/api_op_ListThirdPartyFirewallFirewallPolicies.go @@ -48,10 +48,11 @@ type ListThirdPartyFirewallFirewallPoliciesInput struct { // 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 - // previous response didn't include a NextToken element, there are no more - // third-party firewall policies to get. + // ListThirdPartyFirewallFirewallPoliciesRequest 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 third-party firewall policies to get. NextToken *string noSmithyDocumentSerde diff --git a/service/fms/api_op_PutAdminAccount.go b/service/fms/api_op_PutAdminAccount.go index e19b61b0866..27d02218117 100644 --- a/service/fms/api_op_PutAdminAccount.go +++ b/service/fms/api_op_PutAdminAccount.go @@ -12,16 +12,16 @@ import ( ) // Creates or updates an Firewall Manager administrator account. The account must -// be a member of the organization that was onboarded to Firewall Manager by -// AssociateAdminAccount . Only the organization's management account can create an -// Firewall Manager administrator account. When you create an Firewall Manager -// administrator account, the service checks to see if the account is already a -// delegated administrator within Organizations. If the account isn't a delegated +// be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. +// Only the organization's management account can create an Firewall Manager +// administrator account. When you create an Firewall Manager administrator +// account, the service checks to see if the account is already a delegated +// administrator within Organizations. If the account isn't a delegated // administrator, Firewall Manager calls Organizations to delegate the account // within Organizations. For more information about administrator accounts within -// Organizations, see Managing the Amazon Web Services Accounts in Your -// Organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html) -// . +// Organizations, see [Managing the Amazon Web Services Accounts in Your Organization]. +// +// [Managing the Amazon Web Services Accounts in Your Organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html func (c *Client) PutAdminAccount(ctx context.Context, params *PutAdminAccountInput, optFns ...func(*Options)) (*PutAdminAccountOutput, error) { if params == nil { params = &PutAdminAccountInput{} @@ -41,10 +41,9 @@ type PutAdminAccountInput struct { // The Amazon Web Services account ID to add as an Firewall Manager administrator // account. The account must be a member of the organization that was onboarded to - // Firewall Manager by AssociateAdminAccount . 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) - // . + // Firewall Manager by AssociateAdminAccount. For more information about Organizations, see [Managing the Amazon Web Services Accounts in Your Organization]. + // + // [Managing the Amazon Web 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_PutNotificationChannel.go b/service/fms/api_op_PutNotificationChannel.go index a0b73ca2f65..dd52ac94800 100644 --- a/service/fms/api_op_PutNotificationChannel.go +++ b/service/fms/api_op_PutNotificationChannel.go @@ -11,14 +11,17 @@ import ( ) // Designates the IAM role and Amazon Simple Notification Service (SNS) topic that -// Firewall Manager uses to record SNS logs. To perform this action outside of the -// console, you must first configure the SNS topic's access policy to allow the -// SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other -// than the AWSServiceRoleForFMS service-linked role, this role must have a trust -// relationship configured to allow the Firewall Manager service principal -// fms.amazonaws.com to assume this role. For information about configuring an SNS -// access policy, see Service roles for Firewall Manager (https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service) -// in the Firewall Manager Developer Guide. +// Firewall Manager uses to record SNS logs. +// +// To perform this action outside of the console, you must first configure the SNS +// topic's access policy to allow the SnsRoleName to publish SNS logs. If the +// SnsRoleName provided is a role other than the AWSServiceRoleForFMS +// service-linked role, this role must have a trust relationship configured to +// allow the Firewall Manager service principal fms.amazonaws.com to assume this +// role. For information about configuring an SNS access policy, see [Service roles for Firewall Manager]in the +// Firewall Manager Developer Guide. +// +// [Service roles for Firewall Manager]: https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service func (c *Client) PutNotificationChannel(ctx context.Context, params *PutNotificationChannelInput, optFns ...func(*Options)) (*PutNotificationChannelOutput, error) { if params == nil { params = &PutNotificationChannelInput{} diff --git a/service/fms/api_op_PutPolicy.go b/service/fms/api_op_PutPolicy.go index a7ee153ffbf..eac1aabdb4c 100644 --- a/service/fms/api_op_PutPolicy.go +++ b/service/fms/api_op_PutPolicy.go @@ -11,40 +11,54 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Firewall Manager policy. A Firewall Manager policy is specific to -// the individual policy type. If you want to enforce multiple policy types across -// accounts, you can create multiple policies. You can create more than one policy -// for each type. If you add a new account to an organization that you created with +// Creates an Firewall Manager policy. +// +// A Firewall Manager policy is specific to the individual policy type. If you +// want to enforce multiple policy types across accounts, you can create multiple +// policies. You can create more than one policy for each type. +// +// If you add a new account to an organization that you created with // Organizations, Firewall Manager automatically applies the policy to the -// resources in that account that are within scope of the policy. Firewall Manager -// provides the following types of policies: +// resources in that account that are within scope of the policy. +// +// Firewall Manager provides the following types of policies: +// // - WAF policy - This policy applies WAF web ACL protections to specified // accounts and resources. +// // - Shield Advanced policy - This policy applies Shield Advanced protection to // specified accounts and resources. +// // - Security Groups policy - This type of policy gives you control over // security groups that are in use throughout your organization in Organizations // and lets you enforce a baseline set of rules across your organization. +// // - Network ACL policy - This type of policy gives you control over the network // ACLs that are in use throughout your organization in Organizations and lets you // enforce a baseline set of first and last network ACL rules across your // organization. +// // - Network Firewall policy - This policy applies Network Firewall protection // to your organization's VPCs. +// // - DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS // Firewall protections to your organization's VPCs. +// // - Third-party firewall policy - This policy applies third-party firewall // protections. Third-party firewalls are available by subscription through the -// Amazon Web Services Marketplace console at Amazon Web Services Marketplace (https://aws.amazon.com/marketplace) -// . +// Amazon Web Services Marketplace console at [Amazon Web Services Marketplace]. +// // - Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto // Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto // Networks Cloud NGFW rulestacks to your organization's VPCs. +// // - Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall // (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks // Zero-Day threats and secures cloud infrastructures with industry-leading // advanced threat prevention, smart web application firewalls (WAF), and API // protection. +// +// [Amazon Web Services Marketplace]: https://aws.amazon.com/marketplace 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 02521dc502f..b968df05c20 100644 --- a/service/fms/api_op_PutResourceSet.go +++ b/service/fms/api_op_PutResourceSet.go @@ -11,9 +11,10 @@ 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 7a32e08ce13..f658abaeddc 100644 --- a/service/fms/doc.go +++ b/service/fms/doc.go @@ -5,9 +5,11 @@ // // 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 Service roles for Firewall Manager (https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service) -// . +// and errors. For detailed information about Firewall Manager features, see the [Firewall Manager Developer Guide]. +// +// Some API actions require explicit resource permissions. For information, see +// the developer guide topic [Service roles for Firewall Manager]. +// +// [Firewall Manager Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html +// [Service roles for Firewall Manager]: https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service package fms diff --git a/service/fms/options.go b/service/fms/options.go index 2105e2eabb0..3dc3b1e199d 100644 --- a/service/fms/options.go +++ b/service/fms/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/fms/types/enums.go b/service/fms/types/enums.go index 6066bb1ff2e..acb5645311e 100644 --- a/service/fms/types/enums.go +++ b/service/fms/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AccountRoleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountRoleStatus) Values() []AccountRoleStatus { return []AccountRoleStatus{ "READY", @@ -36,6 +37,7 @@ const ( // Values returns all known values for CustomerPolicyScopeIdType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CustomerPolicyScopeIdType) Values() []CustomerPolicyScopeIdType { return []CustomerPolicyScopeIdType{ @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for CustomerPolicyStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomerPolicyStatus) Values() []CustomerPolicyStatus { return []CustomerPolicyStatus{ "ACTIVE", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for DependentServiceName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DependentServiceName) Values() []DependentServiceName { return []DependentServiceName{ "AWSCONFIG", @@ -94,8 +98,9 @@ const ( ) // Values returns all known values for DestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationType) Values() []DestinationType { return []DestinationType{ "IPV4", @@ -114,8 +119,9 @@ const ( ) // Values returns all known values for EntryType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntryType) Values() []EntryType { return []EntryType{ "FMS_MANAGED_FIRST_ENTRY", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for EntryViolationReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntryViolationReason) Values() []EntryViolationReason { return []EntryViolationReason{ "MISSING_EXPECTED_ENTRY", @@ -157,8 +164,9 @@ const ( ) // Values returns all known values for FailedItemReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailedItemReason) Values() []FailedItemReason { return []FailedItemReason{ "NOT_VALID_ARN", @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for FirewallDeploymentModel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallDeploymentModel) Values() []FirewallDeploymentModel { return []FirewallDeploymentModel{ "CENTRALIZED", @@ -199,8 +208,9 @@ const ( // Values returns all known values for MarketplaceSubscriptionOnboardingStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MarketplaceSubscriptionOnboardingStatus) Values() []MarketplaceSubscriptionOnboardingStatus { return []MarketplaceSubscriptionOnboardingStatus{ "NO_SUBSCRIPTION", @@ -218,8 +228,9 @@ const ( ) // Values returns all known values for NetworkAclRuleAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkAclRuleAction) Values() []NetworkAclRuleAction { return []NetworkAclRuleAction{ "allow", @@ -236,8 +247,9 @@ const ( // Values returns all known values for NetworkFirewallOverrideAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkFirewallOverrideAction) Values() []NetworkFirewallOverrideAction { return []NetworkFirewallOverrideAction{ "DROP_TO_ALERT", @@ -255,8 +267,9 @@ const ( ) // Values returns all known values for OrganizationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationStatus) Values() []OrganizationStatus { return []OrganizationStatus{ "ONBOARDING", @@ -276,6 +289,7 @@ const ( // Values returns all known values for PolicyComplianceStatusType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PolicyComplianceStatusType) Values() []PolicyComplianceStatusType { return []PolicyComplianceStatusType{ @@ -293,8 +307,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "REMOVE", @@ -311,8 +326,9 @@ const ( ) // Values returns all known values for ResourceSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSetStatus) Values() []ResourceSetStatus { return []ResourceSetStatus{ "ACTIVE", @@ -329,8 +345,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -356,8 +373,9 @@ const ( ) // Values returns all known values for SecurityServiceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityServiceType) Values() []SecurityServiceType { return []SecurityServiceType{ "WAF", @@ -385,8 +403,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DROP", @@ -413,8 +432,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "GATEWAY", @@ -439,8 +459,9 @@ const ( ) // Values returns all known values for ThirdPartyFirewall. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThirdPartyFirewall) Values() []ThirdPartyFirewall { return []ThirdPartyFirewall{ "PALO_ALTO_NETWORKS_CLOUD_NGFW", @@ -461,8 +482,9 @@ const ( // Values returns all known values for ThirdPartyFirewallAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThirdPartyFirewallAssociationStatus) Values() []ThirdPartyFirewallAssociationStatus { return []ThirdPartyFirewallAssociationStatus{ "ONBOARDING", @@ -509,8 +531,9 @@ const ( ) // Values returns all known values for ViolationReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViolationReason) Values() []ViolationReason { return []ViolationReason{ "WEB_ACL_MISSING_RULE_GROUP", diff --git a/service/fms/types/errors.go b/service/fms/types/errors.go index 2a77253df26..64c0e6596ef 100644 --- a/service/fms/types/errors.go +++ b/service/fms/types/errors.go @@ -119,8 +119,9 @@ 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]in the WAF Developer Guide. +// +// [Firewall Manager Limits]: https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html type LimitExceededException struct { Message *string diff --git a/service/fms/types/types.go b/service/fms/types/types.go index 7db4a522bc1..7b4b0a79480 100644 --- a/service/fms/types/types.go +++ b/service/fms/types/types.go @@ -63,19 +63,24 @@ type AdminAccountSummary struct { // default administrator can manage third-party firewalls and has full // administrative scope. There is only one default administrator account per // organization. For information about Firewall Manager default administrator - // accounts, see Managing Firewall Manager administrators (https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html) - // in the Firewall Manager Developer Guide. + // accounts, see [Managing Firewall Manager administrators]in the Firewall Manager Developer Guide. + // + // [Managing Firewall Manager administrators]: https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html DefaultAdmin bool // The current status of the request to onboard a member account as an Firewall // Manager administrator. + // // - ONBOARDING - The account is onboarding to Firewall Manager as an // administrator. + // // - ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall // Manager as an administrator, and can perform actions on the resources defined in - // their AdminScope . + // their AdminScope. + // // - OFFBOARDING - The account is being removed as an Firewall Manager // administrator. + // // - OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager // administrator. Status OrganizationStatus @@ -84,9 +89,10 @@ type AdminAccountSummary struct { } // Defines the resources that the Firewall Manager administrator can manage. For -// more information about administrative scope, see Managing Firewall Manager -// administrators (https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html) -// in the Firewall Manager Developer Guide. +// more information about administrative scope, see [Managing Firewall Manager administrators]in the Firewall Manager +// Developer Guide. +// +// [Managing Firewall Manager administrators]: https://docs.aws.amazon.com/waf/latest/developerguide/fms-administrators.html type AdminScope struct { // Defines the accounts that the specified Firewall Manager administrator can @@ -95,8 +101,9 @@ type AdminScope struct { // Defines the Organizations organizational units that the specified Firewall // Manager administrator can apply policies to. For more information about OUs in - // Organizations, see Managing organizational units (OUs) (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) - // in the Organizations User Guide. + // Organizations, see [Managing organizational units (OUs)]in the Organizations User Guide. + // + // [Managing organizational units (OUs)]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html OrganizationalUnitScope *OrganizationalUnitScope // Defines the Firewall Manager policy types that the specified Firewall Manager @@ -124,8 +131,9 @@ type App struct { 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) - // . + // information on possible numbers, see [Protocol Numbers]. + // + // [Protocol Numbers]: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml // // This member is required. Protocol *string @@ -238,10 +246,11 @@ type ComplianceViolator struct { // The resource ID. 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 . + // The resource type. This is in the format shown in the [Amazon Web Services Resource Types Reference]. For example: + // AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::CloudFront::Distribution , or + // AWS::NetworkFirewall::FirewallPolicy . + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html ResourceType *string // The reason that the resource is not protected by the policy. @@ -554,16 +563,20 @@ type EC2ReplaceRouteTableAssociationAction struct { // Describes a single rule in a network ACL. type EntryDescription struct { - // Describes a rule in a network ACL. Each network ACL has a set of numbered - // ingress rules and a separate set of numbered egress rules. When determining - // whether a packet should be allowed in or out of a subnet associated with the - // network ACL, Amazon Web Services processes the entries in the network ACL - // according to the rule numbers, in ascending order. When you manage an individual - // network ACL, you explicitly specify the rule numbers. When you specify the - // network ACL rules in a Firewall Manager policy, you provide the rules to run - // first, in the order that you want them to run, and the rules to run last, in the - // order that you want them to run. Firewall Manager assigns the rule numbers for - // you when you save the network ACL policy specification. + // Describes a rule in a network ACL. + // + // Each network ACL has a set of numbered ingress rules and a separate set of + // numbered egress rules. When determining whether a packet should be allowed in or + // out of a subnet associated with the network ACL, Amazon Web Services processes + // the entries in the network ACL according to the rule numbers, in ascending + // order. + // + // When you manage an individual network ACL, you explicitly specify the rule + // numbers. When you specify the network ACL rules in a Firewall Manager policy, + // you provide the rules to run first, in the order that you want them to run, and + // the rules to run last, in the order that you want them to run. Firewall Manager + // assigns the rule numbers for you when you save the network ACL policy + // specification. EntryDetail *NetworkAclEntry // The rule number for the entry. ACL entries are processed in ascending order by @@ -718,9 +731,10 @@ type FMSPolicyUpdateFirewallCreationConfigAction struct { // Describes the remedial action. 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) - // in order to remedy scope violations. + // A FirewallCreationConfig that you can copy into your current policy's [SecurityServiceData] in order + // to remedy scope violations. + // + // [SecurityServiceData]: https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_SecurityServicePolicyData.html FirewallCreationConfig *string noSmithyDocumentSerde @@ -749,9 +763,12 @@ type InvalidNetworkAclEntriesViolation struct { // Defines a Firewall Manager network ACL policy. This is used in the PolicyOption // of a SecurityServicePolicyData for a Policy , when the SecurityServicePolicyData -// type is set to NETWORK_ACL_COMMON . For information about network ACLs, see -// Control traffic to subnets using network ACLs (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) -// in the Amazon Virtual Private Cloud User Guide. +// type is set to NETWORK_ACL_COMMON . +// +// For information about network ACLs, see [Control traffic to subnets using network ACLs] in the Amazon Virtual Private Cloud +// User Guide. +// +// [Control traffic to subnets using network ACLs]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html type NetworkAclCommonPolicy struct { // The definition of the first and last rules for the network ACL policy. @@ -762,16 +779,20 @@ type NetworkAclCommonPolicy struct { noSmithyDocumentSerde } -// Describes a rule in a network ACL. Each network ACL has a set of numbered -// ingress rules and a separate set of numbered egress rules. When determining -// whether a packet should be allowed in or out of a subnet associated with the -// network ACL, Amazon Web Services processes the entries in the network ACL -// according to the rule numbers, in ascending order. When you manage an individual -// network ACL, you explicitly specify the rule numbers. When you specify the -// network ACL rules in a Firewall Manager policy, you provide the rules to run -// first, in the order that you want them to run, and the rules to run last, in the -// order that you want them to run. Firewall Manager assigns the rule numbers for -// you when you save the network ACL policy specification. +// Describes a rule in a network ACL. +// +// Each network ACL has a set of numbered ingress rules and a separate set of +// numbered egress rules. When determining whether a packet should be allowed in or +// out of a subnet associated with the network ACL, Amazon Web Services processes +// the entries in the network ACL according to the rule numbers, in ascending +// order. +// +// When you manage an individual network ACL, you explicitly specify the rule +// numbers. When you specify the network ACL rules in a Firewall Manager policy, +// you provide the rules to run first, in the order that you want them to run, and +// the rules to run last, in the order that you want them to run. Firewall Manager +// assigns the rule numbers for you when you save the network ACL policy +// specification. type NetworkAclEntry struct { // Indicates whether the rule is an egress, or outbound, rule (applied to traffic @@ -812,38 +833,48 @@ type NetworkAclEntrySet struct { // Applies only when remediation is enabled for the policy as a whole. Firewall // Manager uses this setting when it finds policy violations that involve conflicts - // between the custom entries and the policy entries. If forced remediation is - // disabled, Firewall Manager marks the network ACL as noncompliant and does not - // try to remediate. For more information about the remediation behavior, see - // Network access control list (ACL) policies (https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html) - // in the Firewall Manager Developer Guide. + // between the custom entries and the policy entries. + // + // If forced remediation is disabled, Firewall Manager marks the network ACL as + // noncompliant and does not try to remediate. For more information about the + // remediation behavior, see [Network access control list (ACL) policies]in the Firewall Manager Developer Guide. + // + // [Network access control list (ACL) policies]: https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html // // This member is required. ForceRemediateForFirstEntries *bool // Applies only when remediation is enabled for the policy as a whole. Firewall // Manager uses this setting when it finds policy violations that involve conflicts - // between the custom entries and the policy entries. If forced remediation is - // disabled, Firewall Manager marks the network ACL as noncompliant and does not - // try to remediate. For more information about the remediation behavior, see - // Network access control list (ACL) policies (https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html) - // in the Firewall Manager Developer Guide. + // between the custom entries and the policy entries. + // + // If forced remediation is disabled, Firewall Manager marks the network ACL as + // noncompliant and does not try to remediate. For more information about the + // remediation behavior, see [Network access control list (ACL) policies]in the Firewall Manager Developer Guide. + // + // [Network access control list (ACL) policies]: https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html // // This member is required. ForceRemediateForLastEntries *bool // The rules that you want to run first in the Firewall Manager managed network - // ACLs. Provide these in the order in which you want them to run. Firewall Manager - // will assign the specific rule numbers for you, in the network ACLs that it - // creates. You must specify at least one first entry or one last entry in any - // network ACL policy. + // ACLs. + // + // Provide these in the order in which you want them to run. Firewall Manager will + // assign the specific rule numbers for you, in the network ACLs that it creates. + // + // You must specify at least one first entry or one last entry in any network ACL + // policy. FirstEntries []NetworkAclEntry // The rules that you want to run last in the Firewall Manager managed network - // ACLs. Provide these in the order in which you want them to run. Firewall Manager - // will assign the specific rule numbers for you, in the network ACLs that it - // creates. You must specify at least one first entry or one last entry in any - // network ACL policy. + // ACLs. + // + // Provide these in the order in which you want them to run. Firewall Manager will + // assign the specific rule numbers for you, in the network ACLs that it creates. + // + // You must specify at least one first entry or one last entry in any network ACL + // policy. LastEntries []NetworkAclEntry noSmithyDocumentSerde @@ -1077,14 +1108,16 @@ 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) -// in the Network Firewall Developer Guide. +// information about Network Firewall deployment models, see [Network Firewall example architectures with routing]in the Network +// Firewall Developer Guide. +// +// [Network Firewall example architectures with routing]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/architectures.html 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]to NULL . + // + // [PolicyOption]: https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html FirewallDeploymentModel FirewallDeploymentModel noSmithyDocumentSerde @@ -1095,10 +1128,16 @@ 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: + // rule order. + // + // Valid values of the stateful default action: + // // - aws:drop_strict + // // - aws:drop_established + // // - aws:alert_strict + // // - aws:alert_established StatefulDefaultActions []string @@ -1122,15 +1161,15 @@ type NetworkFirewallPolicyDescription struct { // rule groups. StatelessFragmentDefaultActions []string - // The stateless rule groups that are used in the Network Firewall firewall policy. + // The stateless rule groups that are used in the Network Firewall firewall + // policy. StatelessRuleGroups []StatelessRuleGroup noSmithyDocumentSerde } // Violation detail for Network Firewall for a firewall policy that has a -// different NetworkFirewallPolicyDescription than is required by the Firewall -// Manager policy. +// different NetworkFirewallPolicyDescriptionthan is required by the Firewall Manager policy. type NetworkFirewallPolicyModifiedViolation struct { // The policy that's currently in use in the individual account. @@ -1199,8 +1238,9 @@ type NetworkFirewallUnexpectedGatewayRoutesViolation struct { // Defines the Organizations organizational units (OUs) that the specified // Firewall Manager administrator can apply policies to. For more information about -// OUs in Organizations, see Managing organizational units (OUs) (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html) -// in the Organizations User Guide. +// OUs in Organizations, see [Managing organizational units (OUs)]in the Organizations User Guide. +// +// [Managing organizational units (OUs)]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html type OrganizationalUnitScope struct { // A boolean value that indicates if the administrator can apply policies to all @@ -1270,24 +1310,33 @@ 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 . The - // following are valid resource types for each Firewall Manager policy type: + // format shown in the [Amazon Web Services Resource Types Reference]. To apply this policy to multiple resource types, specify + // a resource type of ResourceTypeList and then specify the resource types in a + // ResourceTypeList . + // + // The following are valid resource types for each Firewall Manager policy type: + // // - Amazon Web Services WAF Classic - AWS::ApiGateway::Stage , - // AWS::CloudFront::Distribution , and AWS::ElasticLoadBalancingV2::LoadBalancer - // . + // AWS::CloudFront::Distribution , and AWS::ElasticLoadBalancingV2::LoadBalancer . + // // - WAF - AWS::ApiGateway::Stage , AWS::ElasticLoadBalancingV2::LoadBalancer , // and AWS::CloudFront::Distribution . + // // - Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer , // AWS::ElasticLoadBalancing::LoadBalancer , AWS::EC2::EIP , and // AWS::CloudFront::Distribution . + // // - Network ACL - AWS::EC2::Subnet . + // // - Security group usage audit - AWS::EC2::SecurityGroup . + // // - Security group content audit - AWS::EC2::SecurityGroup , // AWS::EC2::NetworkInterface , and AWS::EC2::Instance . + // // - DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC . // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html + // // This member is required. ResourceType *string @@ -1301,25 +1350,33 @@ type Policy struct { // Manager is managing for accounts when those accounts leave policy scope. For // example, Firewall Manager will disassociate a Firewall Manager managed web ACL // from a protected customer resource when the customer resource leaves policy - // scope. By default, Firewall Manager doesn't remove protections or delete - // Firewall Manager managed resources. This option is not available for Shield - // Advanced or WAF Classic policies. + // scope. + // + // By default, Firewall Manager doesn't remove protections or delete Firewall + // Manager managed resources. + // + // This option is not available for Shield Advanced or WAF Classic policies. DeleteUnusedFMManagedResources bool // Specifies the Amazon Web Services account IDs and Organizations organizational // 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 - // combination: + // 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 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”]} . @@ -1328,17 +1385,22 @@ type Policy struct { // 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 - // combination: + // 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 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”]} . @@ -1351,7 +1413,9 @@ type Policy struct { PolicyId *string // Indicates whether the policy is in or out of an admin's policy or Region scope. + // // - ACTIVE - The administrator can manage and delete the policy. + // // - OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't // edit or delete the policy. Existing policy protections stay in place. Any new // resources that come into scope of the policy won't be protected. @@ -1464,9 +1528,12 @@ type PolicySummary struct { // Manager is managing for accounts when those accounts leave policy scope. For // example, Firewall Manager will disassociate a Firewall Manager managed web ACL // from a protected customer resource when the customer resource leaves policy - // scope. By default, Firewall Manager doesn't remove protections or delete - // Firewall Manager managed resources. This option is not available for Shield - // Advanced or WAF Classic policies. + // scope. + // + // By default, Firewall Manager doesn't remove protections or delete Firewall + // Manager managed resources. + // + // This option is not available for Shield Advanced or WAF Classic policies. DeleteUnusedFMManagedResources bool // The Amazon Resource Name (ARN) of the specified policy. @@ -1479,7 +1546,9 @@ type PolicySummary struct { PolicyName *string // Indicates whether the policy is in or out of an admin's policy or Region scope. + // // - ACTIVE - The administrator can manage and delete the policy. + // // - OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't // edit or delete the policy. Existing policy protections stay in place. Any new // resources that come into scope of the policy won't be protected. @@ -1489,8 +1558,9 @@ 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) - // . + // format shown in the [Amazon Web Services Resource Types Reference]. + // + // [Amazon Web Services Resource Types Reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html ResourceType *string // The service that the policy is using to protect the resources. This specifies @@ -1733,7 +1803,9 @@ type ResourceSet struct { LastUpdateTime *time.Time // Indicates whether the resource set is in or out of an admin's Region scope. + // // - ACTIVE - The administrator can manage and delete the resource set. + // // - OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they // can't edit or delete the resource set. Existing protections stay in place. Any // new resource that come into scope of the resource set won't be protected. @@ -1743,16 +1815,18 @@ type ResourceSet struct { // returns a token to your requests that access the resource set. The token marks // the state of the resource set resource at the time of the request. Update tokens // are not allowed when creating a resource set. After creation, each subsequent - // update call to the resource set requires the update token. To make an - // unconditional change to the resource set, omit the token in your update request. - // Without the token, Firewall Manager performs your updates regardless of whether - // the resource set has changed since you last retrieved it. To make a conditional - // 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 - // the operation again using the new token. + // update call to the resource set requires the update token. + // + // To make an unconditional change to the resource set, omit the token in your + // update request. Without the token, Firewall Manager performs your updates + // regardless of whether the resource set has changed since you last retrieved it. + // + // To make a conditional 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 the operation again using the new token. UpdateToken *string noSmithyDocumentSerde @@ -1777,7 +1851,9 @@ type ResourceSetSummary struct { Name *string // Indicates whether the resource set is in or out of an admin's Region scope. + // // - ACTIVE - The administrator can manage and delete the resource set. + // // - OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they // can't edit or delete the resource set. Existing protections stay in place. Any // new resource that come into scope of the resource set won't be protected. @@ -1792,9 +1868,9 @@ type ResourceSetSummary struct { // for example, by purpose, owner, or environment. Each tag consists of a key and // 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) -// . +// tags to be included or excluded. For more information, see [Working with Tag Editor]. +// +// [Working with Tag Editor]: https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html type ResourceTag struct { // The resource tag key. @@ -2025,112 +2101,158 @@ 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 + // + // Valid values for preProcessRuleGroups are between 1 and 99. Valid values for // postProcessRuleGroups are between 9901 and 10000. + // // - Example: IMPORT_NETWORK_FIREWALL + // // "{\"type\":\"IMPORT_NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\/rg1\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:drop\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\/ThreatSignaturesEmergingEventsStrictOrder\",\"priority\":8}],\"networkFirewallStatefulEngineOptions\":{\"ruleOrder\":\"STRICT_ORDER\"},\"networkFirewallStatefulDefaultActions\":[\"aws:drop_strict\"]}}" + // // "{\"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 + // + // 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 . + // + // To use the centralized deployment model, you must set [PolicyOption]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 + // + // 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 . + // model, you must set [PolicyOption]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 . + // + // To use the distributed deployment model, you must set [PolicyOption]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 + // + // 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 . + // availabilityZoneId parameter, not both parameters. + // + // To use the distributed deployment model, you must set [PolicyOption]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 . + // + // To use the distributed deployment model, you must set [PolicyOption]to NULL . + // // - 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 + // + // 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 distribute system tags added by Amazon Web Services services into - // the replica security groups. System tags begin with the aws: prefix. + // when the security groups created by this policy become non-compliant. + // + // Firewall Manager won't distribute 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 , + // + // 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}" + // // - Example: SHIELD_ADVANCED with web ACL management - // "{\"type\":\"SHIELD_ADVANCED\",\"optimizeUnassociatedWebACL\":true}" If you - // set optimizeUnassociatedWebACL to true , Firewall Manager creates web ACLs in - // accounts within the policy scope if the web ACLs will be used by at least one - // resource. Firewall Manager creates web ACLs in the accounts within policy scope - // only if the web ACLs will be used by at least one resource. If at any time an - // account comes into policy scope, Firewall Manager automatically creates a web - // ACL in the account if at least one resource will use the web ACL. Upon - // enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in - // your account. The cleanup process can take several hours. If a resource leaves - // policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't - // disassociate the resource from the web ACL. If you want Firewall Manager to - // clean up the web ACL, you must first manually disassociate the resources from + // + // "{\"type\":\"SHIELD_ADVANCED\",\"optimizeUnassociatedWebACL\":true}" + // + // If you set optimizeUnassociatedWebACL to true , Firewall Manager creates web + // ACLs in accounts within the policy scope if the web ACLs will be used by at + // least one resource. Firewall Manager creates web ACLs in the accounts within + // policy scope only if the web ACLs will be used by at least one resource. If at + // any time an account comes into policy scope, Firewall Manager automatically + // creates a web ACL in the account if at least one resource will use the web ACL. + // + // Upon enablement, Firewall Manager performs a one-time cleanup of unused web + // ACLs in your account. The cleanup process can take several hours. If a resource + // leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager + // doesn't disassociate the resource from the web ACL. If you want Firewall Manager + // to clean up the web ACL, you must first manually disassociate the resources from // the web ACL, and then enable the manage unused web ACLs option in your policy. - // If you set optimizeUnassociatedWebACL to false , and Firewall Manager + // + // If you set optimizeUnassociatedWebACL to false , and Firewall Manager // automatically creates an empty web ACL in each account that's within policy // scope. + // // - Specification for SHIELD_ADVANCED for Amazon CloudFront distributions - // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": + // + // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": // {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", // \"automaticResponseAction\":\"BLOCK|COUNT\"}, // \"overrideCustomerWebaclClassic\":true|false, - // \"optimizeUnassociatedWebACL\":true|false}" For example: - // "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": + // \"optimizeUnassociatedWebACL\":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: THIRD_PARTY_FIREWALL Replace THIRD_PARTY_FIREWALL_NAME with the - // name of the third-party firewall. "{ "type":"THIRD_PARTY_FIREWALL", + // \"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: THIRD_PARTY_FIREWALL + // + // Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall. + // + // "{ "type":"THIRD_PARTY_FIREWALL", // "thirdPartyFirewall":"THIRD_PARTY_FIREWALL_NAME", "thirdPartyFirewallConfig":{ // "thirdPartyFirewallPolicyList":["global-1"] }, "firewallDeploymentModel":{ // "distributedFirewallDeploymentModel":{ @@ -2138,63 +2260,75 @@ type SecurityServicePolicyData struct { // "endpointLocation":{ "availabilityZoneConfigList":[ { // "availabilityZoneName":"${AvailabilityZone}" } ] } }, "allowedIPV4CidrList":[ ] // } } } }" + // // - Example: WAFV2 - Account takeover prevention, Bot Control managed rule // groups, optimize unassociated web ACL, and rule action override + // // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesATPRuleSet\",\"managedRuleGroupConfigs\":[{\"awsmanagedRulesATPRuleSet\":{\"loginPath\":\"/loginpath\",\"requestInspection\":{\"payloadType\":\"FORM_ENCODED|JSON\",\"usernameField\":{\"identifier\":\"/form/username\"},\"passwordField\":{\"identifier\":\"/form/password\"}}}}]},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true},{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesBotControlRuleSet\",\"managedRuleGroupConfigs\":[{\"awsmanagedRulesBotControlRuleSet\":{\"inspectionLevel\":\"TARGETED|COMMON\"}}]},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true,\"ruleActionOverrides\":[{\"name\":\"Rule1\",\"actionToUse\":{\"allow|block|count|captcha|challenge\":{}}},{\"name\":\"Rule2\",\"actionToUse\":{\"allow|block|count|captcha|challenge\":{}}}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"optimizeUnassociatedWebACL\":true}" + // // - Bot Control - For information about AWSManagedRulesBotControlRuleSet managed - // rule groups, see AWSManagedRulesBotControlRuleSet (https://docs.aws.amazon.com/waf/latest/APIReference/API_AWSManagedRulesBotControlRuleSet.html) - // in the WAF API Reference. + // rule groups, see [AWSManagedRulesBotControlRuleSet]in the WAF API Reference. + // // - Fraud Control account takeover prevention (ATP) - For information about the - // properties available for AWSManagedRulesATPRuleSet managed rule groups, see - // AWSManagedRulesATPRuleSet (https://docs.aws.amazon.com/waf/latest/APIReference/API_AWSManagedRulesATPRuleSet.html) + // properties available for AWSManagedRulesATPRuleSet managed rule groups, see [AWSManagedRulesATPRuleSet] // in the WAF API Reference. + // // - Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to // true , Firewall Manager creates web ACLs in accounts within the policy scope // if the web ACLs will be used by at least one resource. Firewall Manager creates // web ACLs in the accounts within policy scope only if the web ACLs will be used // by at least one resource. If at any time an account comes into policy scope, // Firewall Manager automatically creates a web ACL in the account if at least one - // resource will use the web ACL. Upon enablement, Firewall Manager performs a - // one-time cleanup of unused web ACLs in your account. The cleanup process can - // take several hours. If a resource leaves policy scope after Firewall Manager - // creates a web ACL, Firewall Manager disassociates the resource from the web ACL, - // but won't clean up the unused web ACL. Firewall Manager only cleans up unused - // web ACLs when you first enable management of unused web ACLs in a policy. If you - // set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused - // web ACLs, and Firewall Manager automatically creates an empty web ACL in each - // account that's within policy scope. + // resource will use the web ACL. + // + // Upon enablement, Firewall Manager performs a one-time cleanup of unused web + // ACLs in your account. The cleanup process can take several hours. If a resource + // leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager + // disassociates the resource from the web ACL, but won't clean up the unused web + // ACL. Firewall Manager only cleans up unused web ACLs when you first enable + // management of unused web ACLs in a policy. + // + // If you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage + // unused web ACLs, and Firewall Manager automatically creates an empty web ACL in + // each account that's within policy scope. + // // - Rule action overrides - Firewall Manager supports rule action overrides // only for managed rule groups. To configure a RuleActionOverrides add the Name // of the rule to override, and ActionToUse , which is the new action to use for - // the rule. For information about using rule action override, see - // RuleActionOverride (https://docs.aws.amazon.com/waf/latest/APIReference/API_RuleActionOverride.html) - // in the WAF API Reference. + // the rule. For information about using rule action override, see [RuleActionOverride]in the WAF + // API Reference. + // // - Example: WAFV2 - CAPTCHA and Challenge configs + // // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"captchaConfig\":{\"immunityTimeProperty\":{\"immunityTime\":500}},\"challengeConfig\":{\"immunityTimeProperty\":{\"immunityTime\":800}},\"tokenDomains\":[\"google.com\",\"amazon.com\"],\"associationConfig\":{\"requestBody\":{\"CLOUDFRONT\":{\"defaultSizeInspectionLimit\":\"KB_16\"}}}}" + // // - CAPTCHA and Challenge configs - If you update the policy's values for // associationConfig , captchaConfig , challengeConfig , or tokenDomains , // Firewall Manager will overwrite your local web ACLs to contain the new value(s). // However, if you don't update the policy's associationConfig , captchaConfig , // challengeConfig , or tokenDomains values, the values in your local web ACLs - // will remain unchanged. For information about association configs, see - // AssociationConfig (https://docs.aws.amazon.com/waf/latest/APIReference/API_AssociationConfig.html) - // . For information about CAPTCHA and Challenge configs, see CaptchaConfig (https://docs.aws.amazon.com/waf/latest/APIReference/API_CaptchaConfig.html) - // and ChallengeConfig (https://docs.aws.amazon.com/waf/latest/APIReference/API_ChallengeConfig.html) - // in the WAF API Reference. + // will remain unchanged. For information about association configs, see [AssociationConfig]. For + // information about CAPTCHA and Challenge configs, see [CaptchaConfig]and [ChallengeConfig]in the WAF API + // Reference. + // // - defaultSizeInspectionLimit - Specifies the maximum size of the web request // body component that an associated Amazon CloudFront distribution should send to - // WAF for inspection. For more information, see DefaultSizeInspectionLimit (https://docs.aws.amazon.com/waf/latest/APIReference/API_RequestBodyAssociatedResourceTypeConfig.html#WAF-Type-RequestBodyAssociatedResourceTypeConfig-DefaultSizeInspectionLimit) - // in the WAF API Reference. + // WAF for inspection. For more information, see [DefaultSizeInspectionLimit]in the WAF API Reference. + // // - 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 + // + // 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: WAFV2 - Logging configurations - // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null, + // + // "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null, // \"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\": // {\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\", // \"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"} @@ -2209,15 +2343,30 @@ type SecurityServicePolicyData struct { // \"conditions\":[{\"actionCondition\":\"CAPTCHA\"},{\"actionCondition\": // \"CHALLENGE\"}, // {\"actionCondition\":\"EXCLUDED_AS_COUNT\"}]}]}},\"sampledRequestsEnabledForDefaultActions\":true}" - // Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the + // + // Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the // logDestinationConfigs in your loggingConfiguration . For information about WAF - // logging configurations, see LoggingConfiguration (https://docs.aws.amazon.com/waf/latest/APIReference/API_LoggingConfiguration.html) - // in the WAF API Reference In the loggingConfiguration , you can specify one - // logDestinationConfigs . Optionally provide as many as 20 redactedFields . The - // RedactedFieldType must be one of URI , QUERY_STRING , HEADER , or METHOD . - // - Example: WAF Classic "{\"type\": \"WAF\", \"ruleGroups\": + // logging configurations, see [LoggingConfiguration]in the WAF API Reference + // + // In the loggingConfiguration , you can specify one logDestinationConfigs . + // Optionally provide as many as 20 redactedFields . The RedactedFieldType must + // be one of URI , QUERY_STRING , HEADER , or METHOD . + // + // - Example: WAF Classic + // + // "{\"type\": \"WAF\", \"ruleGroups\": // [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : // {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}" + // + // [AssociationConfig]: https://docs.aws.amazon.com/waf/latest/APIReference/API_AssociationConfig.html + // [PolicyOption]: https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html + // [LoggingConfiguration]: https://docs.aws.amazon.com/waf/latest/APIReference/API_LoggingConfiguration.html + // [AWSManagedRulesATPRuleSet]: https://docs.aws.amazon.com/waf/latest/APIReference/API_AWSManagedRulesATPRuleSet.html + // [ChallengeConfig]: https://docs.aws.amazon.com/waf/latest/APIReference/API_ChallengeConfig.html + // [AWSManagedRulesBotControlRuleSet]: https://docs.aws.amazon.com/waf/latest/APIReference/API_AWSManagedRulesBotControlRuleSet.html + // [CaptchaConfig]: https://docs.aws.amazon.com/waf/latest/APIReference/API_CaptchaConfig.html + // [RuleActionOverride]: https://docs.aws.amazon.com/waf/latest/APIReference/API_RuleActionOverride.html + // [DefaultSizeInspectionLimit]: https://docs.aws.amazon.com/waf/latest/APIReference/API_RequestBodyAssociatedResourceTypeConfig.html#WAF-Type-RequestBodyAssociatedResourceTypeConfig-DefaultSizeInspectionLimit ManagedServiceData *string // Contains the settings to configure a network ACL policy, a Network Firewall @@ -2234,13 +2383,18 @@ type StatefulEngineOptions struct { // Indicates how to manage the order of stateful rule evaluation for the policy. // 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) - // in the Network Firewall Developer Guide. Default: DEFAULT_ACTION_ORDER + // [Evaluation order for stateful rules]in the Network Firewall Developer Guide. + // + // Default: DEFAULT_ACTION_ORDER + // + // [Evaluation order for stateful rules]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html RuleOrder RuleOrder // Indicates how Network Firewall should handle traffic when a network connection // breaks midstream. + // // - DROP - Fail closed and drop all subsequent traffic going to the firewall. + // // - CONTINUE - Continue to apply rules to subsequent traffic without context // from traffic before the break. This impacts the behavior of rules that depend on // context. For example, with a stateful rule that drops HTTP traffic, Network @@ -2248,23 +2402,29 @@ type StatefulEngineOptions struct { // from session initialization, which defines the application layer protocol as // HTTP. However, a TCP-layer rule using a flow:stateless rule would still match, // and so would the aws:drop_strict default action. + // // - REJECT - Fail closed and drop all subsequent traffic going to the firewall. // With this option, Network Firewall also sends a TCP reject packet back to the // client so the client can immediately establish a new session. With the new // session, Network Firewall will have context and will apply rules appropriately. - // For applications that are reliant on long-lived TCP connections that trigger + // + // For applications that are reliant on long-lived TCP connections that trigger // Gateway Load Balancer idle timeouts, this is the recommended setting. + // // - FMS_IGNORE - Firewall Manager doesn't monitor or modify the Network Firewall // stream exception policy settings. - // For more information, see Stream exception policy in your firewall policy (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stream-exception-policy.html) - // in the Network Firewall Developer Guide. Default: FMS_IGNORE + // + // For more information, see [Stream exception policy in your firewall policy] in the Network Firewall Developer Guide. + // + // Default: FMS_IGNORE + // + // [Stream exception policy in your firewall policy]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/stream-exception-policy.html StreamExceptionPolicy StreamExceptionPolicy 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 @@ -2274,12 +2434,15 @@ type StatefulRuleGroup struct { // An integer setting that indicates the order in which to run the stateful rule // groups in a single Network Firewall firewall policy. 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. For - // information about 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. + // 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. For information about + // + // 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 // The resource ID of the rule group. @@ -2291,8 +2454,7 @@ type StatefulRuleGroup struct { noSmithyDocumentSerde } -// Network Firewall stateless rule group, used in a -// NetworkFirewallPolicyDescription . +// Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription. type StatelessRuleGroup struct { // The priority of the rule group. Network Firewall evaluates the stateless rule diff --git a/service/forecast/api_op_CreateAutoPredictor.go b/service/forecast/api_op_CreateAutoPredictor.go index 977be45c1f9..96048b79bcf 100644 --- a/service/forecast/api_op_CreateAutoPredictor.go +++ b/service/forecast/api_op_CreateAutoPredictor.go @@ -11,22 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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 CreateAutoPredictorto 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. // -// 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: +// 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 @@ -58,46 +70,62 @@ type CreateAutoPredictorInput struct { // An Key Management Service (KMS) key and an Identity and Access Management (IAM) // role that Amazon Forecast can assume to access the key. You can specify this - // optional object in the CreateDataset and CreatePredictor requests. + // optional object in the CreateDatasetand CreatePredictor requests. EncryptionConfig *types.EncryptionConfig // Create an Explainability resource for the predictor. ExplainPredictor *bool // An array of dimension (field) names that specify how to group the generated - // forecast. For example, if you are generating forecasts for item sales across all - // your stores, and your dataset contains a store_id field, you would specify - // store_id as a dimension to group sales forecasts for each store. + // forecast. + // + // For example, if you are generating forecasts for item sales across all your + // stores, and your dataset contains a store_id field, you would specify store_id + // as a dimension to group sales forecasts for each store. ForecastDimensions []string - // The frequency of predictions in a forecast. Valid intervals are an integer - // followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). - // For example, "1D" indicates every day and "15min" indicates every 15 minutes. - // You cannot 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: + // The frequency of predictions in a forecast. + // + // Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D + // (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and + // "15min" indicates every 15 minutes. You cannot 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 + // // 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. + // 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 - // called the prediction length. The maximum forecast horizon is the lesser of 500 - // time-steps or 1/4 of the TARGET_TIME_SERIES dataset length. If you are - // retraining an existing AutoPredictor, then the maximum forecast horizon is the - // lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length. If you - // are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you - // cannot update the forecast horizon parameter. You can meet this requirement by - // providing longer time-series in the dataset. + // called the prediction length. + // + // The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the + // TARGET_TIME_SERIES dataset length. If you are retraining an existing + // AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps + // or 1/3 of the TARGET_TIME_SERIES dataset length. + // + // If you are upgrading to an AutoPredictor or retraining an existing + // AutoPredictor, you cannot update the forecast horizon parameter. You can meet + // this requirement by providing longer time-series in the dataset. ForecastHorizon *int32 // The forecast types used to train a predictor. You can specify up to five @@ -106,10 +134,12 @@ type CreateAutoPredictorInput struct { 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) - // . + // 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]. + // + // [Predictor Monitoring]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html MonitorConfig *types.MonitorConfig // The accuracy metric used to optimize the predictor. @@ -117,22 +147,32 @@ type CreateAutoPredictorInput struct { // 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 - // for PredictorName must be a unique predictor name. + // specify a value for this parameter. + // + // When upgrading or retraining a predictor, 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: + // 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 @@ -144,10 +184,10 @@ type CreateAutoPredictorInput struct { // 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]. If you don't provide a time boundary, Forecast uses a set of [Default Time Boundaries]. + // + // [Specifying a Time Boundary]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary + // [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 725ffe2e7f1..251c4f35a3b 100644 --- a/service/forecast/api_op_CreateDataset.go +++ b/service/forecast/api_op_CreateDataset.go @@ -14,25 +14,33 @@ 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. +// +// - 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) -// operation. For example Forecast datasets, see the Amazon Forecast Sample GitHub -// 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) -// operation to get the status. +// more information, see [Importing datasets]. +// +// To get a list of all your datasets, use the [ListDatasets] operation. +// +// For example Forecast datasets, see the [Amazon Forecast Sample GitHub repository]. +// +// The Status of a dataset must be ACTIVE before you can import training data. Use +// the [DescribeDataset]operation to get the status. +// +// [Amazon Forecast Sample GitHub repository]: https://github.com/aws-samples/amazon-forecast-samples +// [DescribeDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html +// [ListDatasets]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html +// [Importing datasets]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} @@ -61,14 +69,17 @@ type CreateDatasetInput struct { 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) - // 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) - // . + // group, this value and the value specified for the Domain parameter of the [CreateDatasetGroup] + // 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]. + // + // [CreateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html + // [Importing datasets]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html // // This member is required. Domain types.Domain @@ -76,26 +87,35 @@ type CreateDatasetInput struct { // 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) - // . + // about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types]. + // + // [Dataset Domains and Dataset Types]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html // // This member is required. Schema *types.Schema // The frequency of data collection. This parameter is required for - // RELATED_TIME_SERIES datasets. Valid intervals are an integer followed by Y - // (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, - // "1D" indicates every day and "15min" indicates every 15 minutes. You cannot - // 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: + // RELATED_TIME_SERIES datasets. + // + // Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D + // (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and + // "15min" indicates every 15 minutes. You cannot 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 + // // Thus, if you want every other week forecasts, specify "2W". Or, if you want // quarterly forecasts, you specify "3M". DataFrequency *string @@ -106,17 +126,26 @@ type CreateDatasetInput struct { // 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: + // 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 diff --git a/service/forecast/api_op_CreateDatasetGroup.go b/service/forecast/api_op_CreateDatasetGroup.go index ba00fe6f36e..1ad4c4bb40a 100644 --- a/service/forecast/api_op_CreateDatasetGroup.go +++ b/service/forecast/api_op_CreateDatasetGroup.go @@ -13,15 +13,20 @@ 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) -// 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) -// 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) -// operation. +// using the [UpdateDatasetGroup]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]. +// +// To get a list of all your datasets groups, use the [ListDatasetGroups] 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]operation. +// +// [ListDatasetGroups]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html +// [UpdateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html +// [Dataset groups]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html func (c *Client) CreateDatasetGroup(ctx context.Context, params *CreateDatasetGroupInput, optFns ...func(*Options)) (*CreateDatasetGroupOutput, error) { if params == nil { params = &CreateDatasetGroupInput{} @@ -46,13 +51,16 @@ 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) - // 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) - // . + // the [CreateDataset]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]. + // + // [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html + // [Dataset groups]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html // // This member is required. Domain types.Domain @@ -63,17 +71,26 @@ type CreateDatasetGroupInput struct { // 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: + // 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 diff --git a/service/forecast/api_op_CreateDatasetImportJob.go b/service/forecast/api_op_CreateDatasetImportJob.go index 1ce8bccd832..68f979f9412 100644 --- a/service/forecast/api_op_CreateDatasetImportJob.go +++ b/service/forecast/api_op_CreateDatasetImportJob.go @@ -14,22 +14,31 @@ 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 -// 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 -// aggregated, your most recent dataset import is the one that is used when -// training a predictor or generating a forecast. Make sure that your most recent -// 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) -// operation. +// the data to. +// +// You must specify a [DataSource] 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]. +// +// 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 aggregated, your most recent dataset import is +// the one that is used when training a predictor or generating a forecast. Make +// sure that your most recent 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]operation. +// +// [ListDatasetImportJobs]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html +// [Set up permissions]: https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html +// [DataSource]: https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html func (c *Client) CreateDatasetImportJob(ctx context.Context, params *CreateDatasetImportJobInput, optFns ...func(*Options)) (*CreateDatasetImportJobOutput, error) { if params == nil { params = &CreateDatasetImportJobInput{} @@ -49,12 +58,14 @@ type CreateDatasetImportJobInput struct { // The location of the training data to import and an Identity and Access // Management (IAM) role that Amazon Forecast can assume to access the data. The - // training data must be stored in an Amazon S3 bucket. If encryption is used, - // 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) - // operation. + // training data must be stored in an Amazon S3 bucket. + // + // If encryption is used, 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]operation. + // + // [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html // // This member is required. DataSource *types.DataSource @@ -77,8 +88,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). GeolocationFormat *string @@ -90,17 +103,26 @@ 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: + // 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 @@ -111,16 +133,26 @@ type CreateDatasetImportJobInput struct { // 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] for a complete list of valid time zone names. + // + // [Joda-Time API]: http://joda-time.sourceforge.net/timezones.html 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 + // + // - "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 diff --git a/service/forecast/api_op_CreateExplainability.go b/service/forecast/api_op_CreateExplainability.go index 2176171b448..3561d2ff933 100644 --- a/service/forecast/api_op_CreateExplainability.go +++ b/service/forecast/api_op_CreateExplainability.go @@ -12,48 +12,77 @@ 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 -// decrease forecast values. To enable Forecast Explainability, your predictor must -// include at least one of the following: related time series, item metadata, or -// additional datasets like Holidays and the Weather Index. CreateExplainability -// accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact -// scores for all time series and time points in your datasets, provide a Predictor -// 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. +// decrease forecast values. +// +// To enable Forecast Explainability, your predictor must include at least one of +// the following: related time series, item metadata, or additional datasets like +// Holidays and the Weather Index. +// +// CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive +// aggregated Impact scores for all time series and time points in your datasets, +// provide a Predictor 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. +// // 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: +// # 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 { @@ -99,29 +128,41 @@ type CreateExplainabilityInput struct { EnableVisualization *bool // 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) + // Explainability. + // + // Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: + // 2015-01-01T20:00:00) EndDateTime *string // Defines the fields of a dataset. Schema *types.Schema // 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) + // Explainability. + // + // Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: + // 2015-01-01T20:00:00) StartDateTime *string // 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: + // 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 diff --git a/service/forecast/api_op_CreateExplainabilityExport.go b/service/forecast/api_op_CreateExplainabilityExport.go index 0ce4f709d60..3a4fe2f7d73 100644 --- a/service/forecast/api_op_CreateExplainabilityExport.go +++ b/service/forecast/api_op_CreateExplainabilityExport.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports an Explainability resource created by the CreateExplainability -// operation. Exported files are exported to an Amazon Simple Storage Service -// (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 -// can access the export in your Amazon S3 bucket. To get the status, use the -// DescribeExplainabilityExport operation. +// Exports an Explainability resource created by the CreateExplainability operation. Exported files +// are exported to an Amazon Simple Storage Service (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 can access the export in +// your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExportoperation. func (c *Client) CreateExplainabilityExport(ctx context.Context, params *CreateExplainabilityExportInput, optFns ...func(*Options)) (*CreateExplainabilityExportOutput, error) { if params == nil { params = &CreateExplainabilityExportInput{} @@ -58,15 +59,23 @@ 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: + // 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 diff --git a/service/forecast/api_op_CreateForecast.go b/service/forecast/api_op_CreateForecast.go index 2718f63b5fe..1f7a157be2a 100644 --- a/service/forecast/api_op_CreateForecast.go +++ b/service/forecast/api_op_CreateForecast.go @@ -15,20 +15,28 @@ import ( // 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. +// use the CreateForecastExportJoboperation. +// +// The range of the forecast is determined by the ForecastHorizon value, which you +// specify in the CreatePredictorrequest. 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 DescribeForecastoperation 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{} @@ -60,24 +68,35 @@ type CreateForecastInput struct { // 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 // 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"] . + // 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"] . 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: + // 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 @@ -87,10 +106,14 @@ type CreateForecastInput struct { 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: + // TimeSeriesIdentifiers object. + // + // The TimeSeriesIdentifiers object needs the following information: + // // - DataSource + // // - Format + // // - Schema TimeSeriesSelector *types.TimeSeriesSelector diff --git a/service/forecast/api_op_CreateForecastExportJob.go b/service/forecast/api_op_CreateForecastExportJob.go index 702c35f159f..3d43f5e3f9a 100644 --- a/service/forecast/api_op_CreateForecastExportJob.go +++ b/service/forecast/api_op_CreateForecastExportJob.go @@ -11,17 +11,24 @@ 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 -// 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 -// 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 -// operation. +// 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 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 DescribeForecastExportJoboperation. func (c *Client) CreateForecastExportJob(ctx context.Context, params *CreateForecastExportJobInput, optFns ...func(*Options)) (*CreateForecastExportJobOutput, error) { if params == nil { params = &CreateForecastExportJobInput{} @@ -41,9 +48,10 @@ type CreateForecastExportJobInput struct { // The location where you want to save the forecast and an Identity and Access // Management (IAM) role that Amazon Forecast can assume to access the location. - // The forecast must be exported to an Amazon S3 bucket. If encryption is used, - // Destination must include an Key Management Service (KMS) key. The IAM role must - // allow Amazon Forecast permission to access the key. + // The forecast must be exported to an Amazon S3 bucket. + // + // If encryption is used, Destination must include an Key Management Service (KMS) + // key. The IAM role must allow Amazon Forecast permission to access the key. // // This member is required. Destination *types.DataDestination @@ -63,17 +71,26 @@ 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: + // 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 diff --git a/service/forecast/api_op_CreateMonitor.go b/service/forecast/api_op_CreateMonitor.go index 26392a82716..4296dc0c20c 100644 --- a/service/forecast/api_op_CreateMonitor.go +++ b/service/forecast/api_op_CreateMonitor.go @@ -13,8 +13,9 @@ 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]. +// +// [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 +43,9 @@ 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) - // to apply to the monitor resource. + // A list of [tags] to apply to the monitor resource. + // + // [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_CreatePredictor.go b/service/forecast/api_op_CreatePredictor.go index d943abe1a94..34ad9c6e6c8 100644 --- a/service/forecast/api_op_CreatePredictor.go +++ b/service/forecast/api_op_CreatePredictor.go @@ -11,40 +11,60 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation creates a legacy predictor that does not include all the +// 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 . -// 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 -// algorithm-specific hyperparameters. Amazon Forecast uses the algorithm to train -// a predictor using the latest version of the datasets in the specified dataset -// group. You can then generate a forecast using the CreateForecast operation. To -// 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 -// verifies that the DataFrequency specified when the dataset was created matches -// the ForecastFrequency . TARGET_TIME_SERIES datasets don't have this restriction. +// 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 algorithm-specific hyperparameters. +// +// Amazon Forecast uses the algorithm to train a predictor using the latest +// version of the datasets in the specified dataset group. You can then generate a +// forecast using the CreateForecastoperation. +// +// To 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 verifies that the +// DataFrequency specified when the dataset was created matches 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 -// 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: +// 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: +// // - 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. +// status, use the DescribePredictoroperation. func (c *Client) CreatePredictor(ctx context.Context, params *CreatePredictorInput, optFns ...func(*Options)) (*CreatePredictorOutput, error) { if params == nil { params = &CreatePredictorInput{} @@ -68,11 +88,14 @@ type CreatePredictorInput struct { FeaturizationConfig *types.FeaturizationConfig // 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. + // 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. // // This member is required. ForecastHorizon *int32 @@ -89,21 +112,32 @@ 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: + // 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 + // 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. + // 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 @@ -119,14 +153,16 @@ 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"] . 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 - // HPOConfig object, you must set PerformHPO to true. + // more information, see aws-forecast-choosing-recipes. + // + // If you included the HPOConfig object, you must set PerformHPO to true. HPOConfig *types.HyperParameterTuningJobConfig // The accuracy metric used to optimize the predictor. @@ -134,40 +170,58 @@ 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 - // 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 - // false. + // 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 false. PerformAutoML *bool // 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 - // 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 - // specifies a metric to optimize, which hyperparameters participate in tuning, and - // 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: + // 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 HyperParameterTuningJobConfigobject. The tuning job specifies a metric to optimize, which + // hyperparameters participate in tuning, and 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 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: + // 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 @@ -178,7 +232,7 @@ type CreatePredictorInput struct { // 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 . + // 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 90de1a5174a..c45a14c0108 100644 --- a/service/forecast/api_op_CreatePredictorBacktestExportJob.go +++ b/service/forecast/api_op_CreatePredictorBacktestExportJob.go @@ -11,16 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 DescribePredictorBacktestExportJoboperation. func (c *Client) CreatePredictorBacktestExportJob(ctx context.Context, params *CreatePredictorBacktestExportJobInput, optFns ...func(*Options)) (*CreatePredictorBacktestExportJobOutput, error) { if params == nil { params = &CreatePredictorBacktestExportJobInput{} @@ -60,15 +66,23 @@ 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: + // 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 diff --git a/service/forecast/api_op_CreateWhatIfAnalysis.go b/service/forecast/api_op_CreateWhatIfAnalysis.go index b2a297451fe..14f10bbf4b4 100644 --- a/service/forecast/api_op_CreateWhatIfAnalysis.go +++ b/service/forecast/api_op_CreateWhatIfAnalysis.go @@ -15,21 +15,26 @@ import ( // change to a time series and compare the forecasts generated by these changes // against the baseline, unchanged time series. It is important to remember that // the purpose of a what-if analysis is to understand how a forecast can change -// given different modifications to the baseline time series. For example, imagine -// you are a clothing retailer who is considering an end of season sale to clear -// space for new styles. After creating a baseline forecast, you can use a what-if -// analysis to investigate how different sales tactics might affect your goals. You -// could create a scenario where everything is given a 25% markdown, and another -// where everything is given a fixed dollar markdown. You could create a scenario -// where the sale lasts for one week and another where the sale lasts for one -// month. With a what-if analysis, you can compare many different scenarios against -// each other. Note that a what-if analysis is meant to display what the -// forecasting model has learned and how it will behave in the scenarios that you -// are evaluating. Do not blindly use the results of the what-if analysis to make -// business decisions. For instance, forecasts might not be accurate for novel -// scenarios where there is no reference available to determine whether a forecast -// is good. The TimeSeriesSelector object defines the items that you want in the -// what-if analysis. +// given different modifications to the baseline time series. +// +// For example, imagine you are a clothing retailer who is considering an end of +// season sale to clear space for new styles. After creating a baseline forecast, +// you can use a what-if analysis to investigate how different sales tactics might +// affect your goals. +// +// You could create a scenario where everything is given a 25% markdown, and +// another where everything is given a fixed dollar markdown. You could create a +// scenario where the sale lasts for one week and another where the sale lasts for +// one month. With a what-if analysis, you can compare many different scenarios +// against each other. +// +// Note that a what-if analysis is meant to display what the forecasting model has +// learned and how it will behave in the scenarios that you are evaluating. Do not +// blindly use the results of the what-if analysis to make business decisions. For +// instance, forecasts might not be accurate for novel scenarios where there is no +// reference available to determine whether a forecast is good. +// +// The TimeSeriesSelector object defines the items that you want in the what-if analysis. func (c *Client) CreateWhatIfAnalysis(ctx context.Context, params *CreateWhatIfAnalysisInput, optFns ...func(*Options)) (*CreateWhatIfAnalysisOutput, error) { if params == nil { params = &CreateWhatIfAnalysisInput{} @@ -57,16 +62,21 @@ 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) - // to apply to the what if forecast. + // A list of [tags] to apply to the what if forecast. + // + // [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html Tags []types.Tag // Defines the set of time series that are used in the what-if analysis with a // TimeSeriesIdentifiers object. What-if analyses are performed only for the time - // series in this object. The TimeSeriesIdentifiers object needs the following - // information: + // series in this object. + // + // The TimeSeriesIdentifiers object needs the following information: + // // - DataSource + // // - Format + // // - Schema TimeSeriesSelector *types.TimeSeriesSelector diff --git a/service/forecast/api_op_CreateWhatIfForecast.go b/service/forecast/api_op_CreateWhatIfForecast.go index 1f35076bdcd..aa6217c3cfd 100644 --- a/service/forecast/api_op_CreateWhatIfForecast.go +++ b/service/forecast/api_op_CreateWhatIfForecast.go @@ -42,21 +42,27 @@ 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) - // to apply to the what if forecast. + // A list of [tags] to apply to the what if forecast. + // + // [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html Tags []types.Tag // The replacement time series dataset, which contains the rows that you want to // change in the related time series dataset. A replacement time series does not // need to contain all rows that are in the baseline related time series. Include // only the rows (measure-dimension combinations) that you want to include in the - // what-if forecast. This dataset is merged with the original time series to create - // a transformed dataset that is used for the what-if analysis. This dataset should - // contain the items to modify (such as item_id or workforce_type), any relevant - // dimensions, the timestamp column, and at least one of the related time series - // columns. This file should not contain duplicate timestamps for the same time - // series. Timestamps and item_ids not included in this dataset are not included in - // the what-if analysis. + // what-if forecast. + // + // This dataset is merged with the original time series to create a transformed + // dataset that is used for the what-if analysis. + // + // This dataset should contain the items to modify (such as item_id or + // workforce_type), any relevant dimensions, the timestamp column, and at least one + // of the related time series columns. This file should not contain duplicate + // timestamps for the same time series. + // + // Timestamps and item_ids not included in this dataset are not included in the + // what-if analysis. TimeSeriesReplacementsDataSource *types.TimeSeriesReplacementsDataSource // The transformations that are applied to the baseline time series. Each diff --git a/service/forecast/api_op_CreateWhatIfForecastExport.go b/service/forecast/api_op_CreateWhatIfForecastExport.go index 121f476ff19..5b5457d6e3d 100644 --- a/service/forecast/api_op_CreateWhatIfForecastExport.go +++ b/service/forecast/api_op_CreateWhatIfForecastExport.go @@ -11,17 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports a forecast created by the CreateWhatIfForecast operation to your Amazon -// Simple Storage Service (Amazon S3) bucket. The forecast file name will match the -// 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. +// Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage +// Service (Amazon S3) bucket. The forecast file name will match the 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 DescribeWhatIfForecastExportoperation. func (c *Client) CreateWhatIfForecastExport(ctx context.Context, params *CreateWhatIfForecastExportInput, optFns ...func(*Options)) (*CreateWhatIfForecastExportOutput, error) { if params == nil { params = &CreateWhatIfForecastExportInput{} @@ -41,9 +48,10 @@ type CreateWhatIfForecastExportInput struct { // The location where you want to save the forecast and an Identity and Access // Management (IAM) role that Amazon Forecast can assume to access the location. - // The forecast must be exported to an Amazon S3 bucket. If encryption is used, - // Destination must include an Key Management Service (KMS) key. The IAM role must - // allow Amazon Forecast permission to access the key. + // The forecast must be exported to an Amazon S3 bucket. + // + // If encryption is used, Destination must include an Key Management Service (KMS) + // key. The IAM role must allow Amazon Forecast permission to access the key. // // This member is required. Destination *types.DataDestination @@ -61,8 +69,9 @@ 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) - // to apply to the what if forecast. + // A list of [tags] to apply to the what if forecast. + // + // [tags]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/forecast/api_op_DeleteDataset.go b/service/forecast/api_op_DeleteDataset.go index 01ad24928f9..98fe3c8db02 100644 --- a/service/forecast/api_op_DeleteDataset.go +++ b/service/forecast/api_op_DeleteDataset.go @@ -10,13 +10,17 @@ 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) -// 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) -// 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) -// operation, omitting the deleted dataset's ARN. +// Deletes an Amazon Forecast dataset that was created using the [CreateDataset] operation. You +// can only delete datasets that have a status of ACTIVE or CREATE_FAILED . To get +// the status use the [DescribeDataset]operation. +// +// Forecast does not automatically update any dataset groups that contain the +// deleted dataset. In order to update the dataset group, use the [UpdateDatasetGroup]operation, +// omitting the deleted dataset's ARN. +// +// [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html +// [UpdateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html +// [DescribeDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { params = &DeleteDatasetInput{} diff --git a/service/forecast/api_op_DeleteDatasetGroup.go b/service/forecast/api_op_DeleteDatasetGroup.go index 2e4d4acd06e..091c89fe306 100644 --- a/service/forecast/api_op_DeleteDatasetGroup.go +++ b/service/forecast/api_op_DeleteDatasetGroup.go @@ -10,12 +10,14 @@ 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) -// operation. This operation deletes only the dataset group, not the datasets in -// the group. +// Deletes a dataset group created using the [CreateDatasetGroup] 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]operation. +// +// This operation deletes only the dataset group, not the datasets in the group. +// +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html +// [CreateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html func (c *Client) DeleteDatasetGroup(ctx context.Context, params *DeleteDatasetGroupInput, optFns ...func(*Options)) (*DeleteDatasetGroupOutput, error) { if params == nil { params = &DeleteDatasetGroupInput{} diff --git a/service/forecast/api_op_DeleteDatasetImportJob.go b/service/forecast/api_op_DeleteDatasetImportJob.go index 684deeda0fb..de5230914cf 100644 --- a/service/forecast/api_op_DeleteDatasetImportJob.go +++ b/service/forecast/api_op_DeleteDatasetImportJob.go @@ -10,10 +10,12 @@ 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) -// 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) -// operation. +// Deletes a dataset import job created using the [CreateDatasetImportJob] operation. You can delete only +// dataset import jobs that have a status of ACTIVE or CREATE_FAILED . To get the +// status, use the [DescribeDatasetImportJob]operation. +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html +// [DescribeDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html func (c *Client) DeleteDatasetImportJob(ctx context.Context, params *DeleteDatasetImportJobInput, optFns ...func(*Options)) (*DeleteDatasetImportJobOutput, error) { if params == nil { params = &DeleteDatasetImportJobInput{} diff --git a/service/forecast/api_op_DeleteExplainability.go b/service/forecast/api_op_DeleteExplainability.go index 6262ded40b9..c8298a6e8f8 100644 --- a/service/forecast/api_op_DeleteExplainability.go +++ b/service/forecast/api_op_DeleteExplainability.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an Explainability resource. You can delete only predictor that have a -// status of ACTIVE or CREATE_FAILED . To get the status, use the -// DescribeExplainability operation. +// Deletes an Explainability resource. +// +// You can delete only predictor that have a status of ACTIVE or CREATE_FAILED . To +// get the status, use the DescribeExplainabilityoperation. func (c *Client) DeleteExplainability(ctx context.Context, params *DeleteExplainabilityInput, optFns ...func(*Options)) (*DeleteExplainabilityOutput, error) { if params == nil { params = &DeleteExplainabilityInput{} diff --git a/service/forecast/api_op_DeleteForecast.go b/service/forecast/api_op_DeleteForecast.go index 1e03743e163..f057d085297 100644 --- a/service/forecast/api_op_DeleteForecast.go +++ b/service/forecast/api_op_DeleteForecast.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// forecast. +// 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 forecast. func (c *Client) DeleteForecast(ctx context.Context, params *DeleteForecastInput, optFns ...func(*Options)) (*DeleteForecastOutput, error) { if params == nil { params = &DeleteForecastInput{} diff --git a/service/forecast/api_op_DeleteForecastExportJob.go b/service/forecast/api_op_DeleteForecastExportJob.go index 729da06eefe..79619c406f0 100644 --- a/service/forecast/api_op_DeleteForecastExportJob.go +++ b/service/forecast/api_op_DeleteForecastExportJob.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 DescribeForecastExportJoboperation. 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_DeletePredictor.go b/service/forecast/api_op_DeletePredictor.go index 84a45995512..6a2e4653f85 100644 --- a/service/forecast/api_op_DeletePredictor.go +++ b/service/forecast/api_op_DeletePredictor.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 DescribePredictoroperation. 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 80c7a70f6c5..6791ece819e 100644 --- a/service/forecast/api_op_DeleteResourceTree.go +++ b/service/forecast/api_op_DeleteResourceTree.go @@ -11,15 +11,22 @@ import ( ) // Deletes an entire resource tree. This operation will delete the parent resource -// and its child resources. Child resources are resources that were created from -// another resource. For example, when a forecast is generated from a predictor, -// the forecast is the child resource and the predictor is the parent resource. +// and its child resources. +// +// Child resources are resources that were created from another resource. For +// example, when a forecast is generated from a predictor, 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 // // DeleteResourceTree will only delete Amazon Forecast resources, and will not diff --git a/service/forecast/api_op_DeleteWhatIfAnalysis.go b/service/forecast/api_op_DeleteWhatIfAnalysis.go index 2018f141cea..6dd49ff0832 100644 --- a/service/forecast/api_op_DeleteWhatIfAnalysis.go +++ b/service/forecast/api_op_DeleteWhatIfAnalysis.go @@ -10,9 +10,10 @@ 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. +// 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 DescribeWhatIfAnalysisoperation. +// // 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) { diff --git a/service/forecast/api_op_DeleteWhatIfForecast.go b/service/forecast/api_op_DeleteWhatIfForecast.go index 4e4e9f3ed10..c3b27cdda3c 100644 --- a/service/forecast/api_op_DeleteWhatIfForecast.go +++ b/service/forecast/api_op_DeleteWhatIfForecast.go @@ -10,9 +10,10 @@ 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. +// 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 DescribeWhatIfForecastoperation. +// // 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) { diff --git a/service/forecast/api_op_DeleteWhatIfForecastExport.go b/service/forecast/api_op_DeleteWhatIfForecastExport.go index f8e6dd52cad..4b8942a43fd 100644 --- a/service/forecast/api_op_DeleteWhatIfForecastExport.go +++ b/service/forecast/api_op_DeleteWhatIfForecastExport.go @@ -10,10 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 DescribeWhatIfForecastExportoperation. 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 b045a1459e4..6d32ba880ab 100644 --- a/service/forecast/api_op_DescribeAutoPredictor.go +++ b/service/forecast/api_op_DescribeAutoPredictor.go @@ -52,7 +52,7 @@ type DescribeAutoPredictorOutput struct { // An Key Management Service (KMS) key and an Identity and Access Management (IAM) // role that Amazon Forecast can assume to access the key. You can specify this - // optional object in the CreateDataset and CreatePredictor requests. + // optional object in the CreateDatasetand CreatePredictor requests. EncryptionConfig *types.EncryptionConfig // The estimated time remaining in minutes for the predictor training job to @@ -66,10 +66,12 @@ type DescribeAutoPredictorOutput struct { // your time series. ForecastDimensions []string - // The frequency of predictions in a forecast. Valid intervals are Y (Year), M - // (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), - // 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" - // indicates every year and "5min" indicates every five minutes. + // The frequency of predictions in a forecast. + // + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 + // minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 + // minute). For example, "Y" indicates every year and "5min" indicates every five + // minutes. ForecastFrequency *string // The number of time-steps that the model predicts. The forecast horizon is also @@ -82,10 +84,15 @@ 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. LastModificationTime *time.Time @@ -109,9 +116,13 @@ 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 Status *string diff --git a/service/forecast/api_op_DescribeDataset.go b/service/forecast/api_op_DescribeDataset.go index 1fd2075c8bf..2ccbc5f3891 100644 --- a/service/forecast/api_op_DescribeDataset.go +++ b/service/forecast/api_op_DescribeDataset.go @@ -12,12 +12,18 @@ import ( "time" ) -// 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: +// Describes an Amazon Forecast dataset created using the [CreateDataset] operation. +// +// In addition to listing the parameters specified in the CreateDataset request, +// this operation includes the following dataset properties: +// // - CreationTime +// // - LastModificationTime +// // - Status +// +// [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} @@ -48,10 +54,12 @@ type DescribeDatasetOutput struct { // When the dataset was created. CreationTime *time.Time - // The frequency of data collection. Valid intervals are Y (Year), M (Month), W - // (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 - // minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates - // every month and "30min" indicates every 30 minutes. + // The frequency of data collection. + // + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 + // minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 + // minute). For example, "M" indicates every month and "30min" indicates every 30 + // minutes. DataFrequency *string // The Amazon Resource Name (ARN) of the dataset. @@ -72,9 +80,10 @@ type DescribeDatasetOutput struct { // 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. + // current time of the DescribeDataset call. After a [CreateDatasetImportJob] operation has finished, + // LastModificationTime is when the import job completed or failed. + // + // [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html LastModificationTime *time.Time // An array of SchemaAttribute objects that specify the dataset fields. Each @@ -82,16 +91,23 @@ 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) - // 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 - // import training data. + // the [CreateDatasetImportJob]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 import training data. + // + // [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html Status *string // Metadata pertaining to the operation's result. diff --git a/service/forecast/api_op_DescribeDatasetGroup.go b/service/forecast/api_op_DescribeDatasetGroup.go index 8a23eec2eca..0ade6574948 100644 --- a/service/forecast/api_op_DescribeDatasetGroup.go +++ b/service/forecast/api_op_DescribeDatasetGroup.go @@ -12,13 +12,20 @@ import ( "time" ) -// 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: +// Describes a dataset group created using the [CreateDatasetGroup] 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 +// +// [CreateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html func (c *Client) DescribeDatasetGroup(ctx context.Context, params *DescribeDatasetGroupInput, optFns ...func(*Options)) (*DescribeDatasetGroupOutput, error) { if params == nil { params = &DescribeDatasetGroupInput{} @@ -62,20 +69,29 @@ type DescribeDatasetGroupOutput struct { // The domain associated with the dataset group. 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) + // When the dataset group was created or last updated from a call to the [UpdateDatasetGroup] // 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 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. + // + // The UPDATE states apply when you call the [UpdateDatasetGroup] operation. + // + // The Status of the dataset group must be ACTIVE before you can use the dataset + // group to create a predictor. + // + // [UpdateDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html 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 6a80092ff3b..ec5b5270099 100644 --- a/service/forecast/api_op_DescribeDatasetImportJob.go +++ b/service/forecast/api_op_DescribeDatasetImportJob.go @@ -12,16 +12,24 @@ import ( "time" ) -// 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: +// Describes a dataset import job created using the [CreateDatasetImportJob] 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. +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html func (c *Client) DescribeDatasetImportJob(ctx context.Context, params *DescribeDatasetImportJobInput, optFns ...func(*Options)) (*DescribeDatasetImportJobOutput, error) { if params == nil { params = &DescribeDatasetImportJobInput{} @@ -56,8 +64,9 @@ type DescribeDatasetImportJobOutput struct { DataSize *float64 // The location of the training data to import and an Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the data. If - // encryption is used, DataSource includes an Key Management Service (KMS) key. + // Management (IAM) role that Amazon Forecast can assume to access the data. + // + // If encryption is used, DataSource includes an Key Management Service (KMS) key. DataSource *types.DataSource // The Amazon Resource Name (ARN) of the dataset that the training data was @@ -88,10 +97,15 @@ 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. LastModificationTime *time.Time @@ -99,9 +113,13 @@ type DescribeDatasetImportJobOutput struct { 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 Status *string @@ -111,9 +129,15 @@ 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 71acac31778..95cf05a6365 100644 --- a/service/forecast/api_op_DescribeExplainability.go +++ b/service/forecast/api_op_DescribeExplainability.go @@ -12,8 +12,7 @@ import ( "time" ) -// Describes an Explainability resource created using the CreateExplainability -// operation. +// Describes an Explainability resource created using the CreateExplainability operation. func (c *Client) DescribeExplainability(ctx context.Context, params *DescribeExplainabilityInput, optFns ...func(*Options)) (*DescribeExplainabilityOutput, error) { if params == nil { params = &DescribeExplainabilityInput{} @@ -56,8 +55,7 @@ type DescribeExplainabilityOutput struct { // Explainability. EndDateTime *string - // The estimated time remaining in minutes for the CreateExplainability job to - // complete. + // The estimated time remaining in minutes for the CreateExplainability job to complete. EstimatedTimeRemainingInMinutes *int64 // The Amazon Resource Name (ARN) of the Explainability. @@ -72,10 +70,15 @@ 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. LastModificationTime *time.Time @@ -94,9 +97,13 @@ type DescribeExplainabilityOutput struct { 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 Status *string diff --git a/service/forecast/api_op_DescribeExplainabilityExport.go b/service/forecast/api_op_DescribeExplainabilityExport.go index 6c8ba0ec9a9..9b6b84df6c0 100644 --- a/service/forecast/api_op_DescribeExplainabilityExport.go +++ b/service/forecast/api_op_DescribeExplainabilityExport.go @@ -12,8 +12,7 @@ import ( "time" ) -// Describes an Explainability export created using the CreateExplainabilityExport -// operation. +// Describes an Explainability export created using the CreateExplainabilityExport operation. func (c *Client) DescribeExplainabilityExport(ctx context.Context, params *DescribeExplainabilityExportInput, optFns ...func(*Options)) (*DescribeExplainabilityExportOutput, error) { if params == nil { params = &DescribeExplainabilityExportInput{} @@ -63,10 +62,15 @@ 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. LastModificationTime *time.Time @@ -74,9 +78,13 @@ type DescribeExplainabilityExportOutput 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 Status *string diff --git a/service/forecast/api_op_DescribeForecast.go b/service/forecast/api_op_DescribeForecast.go index 040dd17c57d..9232ddaa9a6 100644 --- a/service/forecast/api_op_DescribeForecast.go +++ b/service/forecast/api_op_DescribeForecast.go @@ -12,13 +12,19 @@ import ( "time" ) -// 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: +// 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. func (c *Client) DescribeForecast(ctx context.Context, params *DescribeForecastInput, optFns ...func(*Options)) (*DescribeForecastOutput, error) { if params == nil { @@ -67,10 +73,15 @@ 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. LastModificationTime *time.Time @@ -81,10 +92,15 @@ 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. Status *string diff --git a/service/forecast/api_op_DescribeForecastExportJob.go b/service/forecast/api_op_DescribeForecastExportJob.go index 3961cd62765..c02793503ae 100644 --- a/service/forecast/api_op_DescribeForecastExportJob.go +++ b/service/forecast/api_op_DescribeForecastExportJob.go @@ -12,12 +12,17 @@ import ( "time" ) -// Describes a forecast export job created using the CreateForecastExportJob -// operation. In addition to listing the properties provided by the user in the +// 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. func (c *Client) DescribeForecastExportJob(ctx context.Context, params *DescribeForecastExportJobInput, optFns ...func(*Options)) (*DescribeForecastExportJobOutput, error) { if params == nil { @@ -67,10 +72,15 @@ 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. LastModificationTime *time.Time @@ -78,10 +88,15 @@ type DescribeForecastExportJobOutput struct { 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. Status *string diff --git a/service/forecast/api_op_DescribeMonitor.go b/service/forecast/api_op_DescribeMonitor.go index 6608be9e9a4..49059fd1a3a 100644 --- a/service/forecast/api_op_DescribeMonitor.go +++ b/service/forecast/api_op_DescribeMonitor.go @@ -13,13 +13,20 @@ import ( ) // Describes a monitor resource. In addition to listing the properties provided in -// the CreateMonitor request, this operation lists the following properties: +// the CreateMonitorrequest, this operation lists the following properties: +// // - Baseline +// // - CreationTime +// // - LastEvaluationTime +// // - LastEvaluationState +// // - LastModificationTime +// // - Message +// // - Status func (c *Client) DescribeMonitor(ctx context.Context, params *DescribeMonitorInput, optFns ...func(*Options)) (*DescribeMonitorOutput, error) { if params == nil { diff --git a/service/forecast/api_op_DescribePredictor.go b/service/forecast/api_op_DescribePredictor.go index b69b0707c8e..181c697c15c 100644 --- a/service/forecast/api_op_DescribePredictor.go +++ b/service/forecast/api_op_DescribePredictor.go @@ -12,17 +12,26 @@ 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: +// 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 { @@ -57,11 +66,14 @@ 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 + // 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. + // 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. @@ -103,15 +115,20 @@ 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. LastModificationTime *time.Time @@ -139,18 +156,22 @@ type DescribePredictorOutput struct { 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. 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 . + // for the chosen hyperparameters are returned. For more information, see 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 8d6014f0aa0..9e239b60189 100644 --- a/service/forecast/api_op_DescribePredictorBacktestExportJob.go +++ b/service/forecast/api_op_DescribePredictorBacktestExportJob.go @@ -12,13 +12,18 @@ import ( "time" ) -// 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: +// 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) func (c *Client) DescribePredictorBacktestExportJob(ctx context.Context, params *DescribePredictorBacktestExportJobInput, optFns ...func(*Options)) (*DescribePredictorBacktestExportJobOutput, error) { if params == nil { @@ -60,10 +65,15 @@ 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. LastModificationTime *time.Time @@ -80,9 +90,13 @@ 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 Status *string diff --git a/service/forecast/api_op_DescribeWhatIfAnalysis.go b/service/forecast/api_op_DescribeWhatIfAnalysis.go index 097913b68d2..2ebd71e7df8 100644 --- a/service/forecast/api_op_DescribeWhatIfAnalysis.go +++ b/service/forecast/api_op_DescribeWhatIfAnalysis.go @@ -12,12 +12,17 @@ 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: +// 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 { @@ -58,10 +63,15 @@ 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. LastModificationTime *time.Time @@ -69,19 +79,28 @@ type DescribeWhatIfAnalysisOutput struct { 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. 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: + // TimeSeriesIdentifiers object. + // + // The TimeSeriesIdentifiers object needs the following information: + // // - DataSource + // // - Format + // // - Schema TimeSeriesSelector *types.TimeSeriesSelector diff --git a/service/forecast/api_op_DescribeWhatIfForecast.go b/service/forecast/api_op_DescribeWhatIfForecast.go index cd3d86b43f5..3600ec4a363 100644 --- a/service/forecast/api_op_DescribeWhatIfForecast.go +++ b/service/forecast/api_op_DescribeWhatIfForecast.go @@ -12,12 +12,17 @@ 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: +// 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 { @@ -54,17 +59,21 @@ type DescribeWhatIfForecastOutput struct { 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"] . + // up to five quantiles per what-if forecast in the CreateWhatIfForecastoperation. 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. LastModificationTime *time.Time @@ -72,10 +81,15 @@ type DescribeWhatIfForecastOutput struct { 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. Status *string diff --git a/service/forecast/api_op_DescribeWhatIfForecastExport.go b/service/forecast/api_op_DescribeWhatIfForecastExport.go index 8458c7959e8..7d3bf35c5ee 100644 --- a/service/forecast/api_op_DescribeWhatIfForecastExport.go +++ b/service/forecast/api_op_DescribeWhatIfForecastExport.go @@ -12,13 +12,17 @@ import ( "time" ) -// Describes the what-if forecast export created using the -// CreateWhatIfForecastExport operation. In addition to listing the properties -// provided in the CreateWhatIfForecastExport request, this operation lists the -// following properties: +// Describes the what-if forecast export created using the 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 func (c *Client) DescribeWhatIfForecastExport(ctx context.Context, params *DescribeWhatIfForecastExportInput, optFns ...func(*Options)) (*DescribeWhatIfForecastExportOutput, error) { if params == nil { @@ -65,10 +69,15 @@ 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. LastModificationTime *time.Time @@ -76,10 +85,15 @@ type DescribeWhatIfForecastExportOutput struct { 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. Status *string diff --git a/service/forecast/api_op_GetAccuracyMetrics.go b/service/forecast/api_op_GetAccuracyMetrics.go index cb8565770ac..1ceec39020a 100644 --- a/service/forecast/api_op_GetAccuracyMetrics.go +++ b/service/forecast/api_op_GetAccuracyMetrics.go @@ -11,21 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]. +// +// 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. +// the EvaluationParametersobject, 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 DescribePredictoroperation. +// +// [Predictor Metrics]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html func (c *Client) GetAccuracyMetrics(ctx context.Context, params *GetAccuracyMetricsInput, optFns ...func(*Options)) (*GetAccuracyMetricsOutput, error) { if params == nil { params = &GetAccuracyMetricsInput{} @@ -53,14 +56,17 @@ type GetAccuracyMetricsInput struct { type GetAccuracyMetricsOutput struct { - // The LatencyOptimized AutoML override strategy is only available in private + // 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. + // 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 0ee2ae016cd..707ccdce7b8 100644 --- a/service/forecast/api_op_ListDatasetGroups.go +++ b/service/forecast/api_op_ListDatasetGroups.go @@ -11,12 +11,13 @@ 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) -// 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) -// operation. +// Returns a list of dataset groups created using the [CreateDatasetGroup] 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]operation. +// +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html +// [CreateDatasetGroup]: https://docs.aws.amazon.com/forecast/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/forecast/api_op_ListDatasetImportJobs.go b/service/forecast/api_op_ListDatasetImportJobs.go index 6c0878a23d8..3e3d8e15150 100644 --- a/service/forecast/api_op_ListDatasetImportJobs.go +++ b/service/forecast/api_op_ListDatasetImportJobs.go @@ -11,12 +11,15 @@ 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) -// 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. +// Returns a list of dataset import jobs created using the [CreateDatasetImportJob] 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]operation. You can filter the list by providing an array +// of [Filter]objects. +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html +// [DescribeDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html +// [Filter]: https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetImportJobsInput, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error) { if params == nil { params = &ListDatasetImportJobsInput{} @@ -37,17 +40,23 @@ 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 // 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 + // 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" } ] + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListDatasets.go b/service/forecast/api_op_ListDatasets.go index 860b457a1cf..c06f5627caf 100644 --- a/service/forecast/api_op_ListDatasets.go +++ b/service/forecast/api_op_ListDatasets.go @@ -11,11 +11,13 @@ 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) -// 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) +// Returns a list of datasets created using the [CreateDataset] 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] // operation. +// +// [CreateDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html +// [DescribeDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error) { if params == nil { params = &ListDatasetsInput{} diff --git a/service/forecast/api_op_ListExplainabilities.go b/service/forecast/api_op_ListExplainabilities.go index a63f116c732..73d5d56a1f4 100644 --- a/service/forecast/api_op_ListExplainabilities.go +++ b/service/forecast/api_op_ListExplainabilities.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of Explainability resources created using the -// CreateExplainability operation. This operation returns a summary for each -// Explainability. You can filter the list using an array of Filter objects. To -// retrieve the complete set of properties for a particular Explainability -// resource, use the ARN with the DescribeExplainability operation. +// Returns a list of Explainability resources created using the CreateExplainability operation. This +// operation returns a summary for each Explainability. You can filter the list +// using an array of Filterobjects. +// +// To retrieve the complete set of properties for a particular Explainability +// resource, use the ARN with the DescribeExplainabilityoperation. func (c *Client) ListExplainabilities(ctx context.Context, params *ListExplainabilitiesInput, optFns ...func(*Options)) (*ListExplainabilitiesOutput, error) { if params == nil { params = &ListExplainabilitiesInput{} @@ -36,10 +37,15 @@ 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 + // 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 diff --git a/service/forecast/api_op_ListExplainabilityExports.go b/service/forecast/api_op_ListExplainabilityExports.go index 9b1fd058795..878c4f2a983 100644 --- a/service/forecast/api_op_ListExplainabilityExports.go +++ b/service/forecast/api_op_ListExplainabilityExports.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 Filterobjects. +// +// To retrieve the complete set of properties for a particular Explainability +// export, use the ARN with the DescribeExplainabilityoperation. func (c *Client) ListExplainabilityExports(ctx context.Context, params *ListExplainabilityExportsInput, optFns ...func(*Options)) (*ListExplainabilityExportsOutput, error) { if params == nil { params = &ListExplainabilityExportsInput{} @@ -36,10 +37,15 @@ 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 + // 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 diff --git a/service/forecast/api_op_ListForecastExportJobs.go b/service/forecast/api_op_ListForecastExportJobs.go index d52f2c7bb4b..176b7f98af6 100644 --- a/service/forecast/api_op_ListForecastExportJobs.go +++ b/service/forecast/api_op_ListForecastExportJobs.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 DescribeForecastExportJoboperation. You can filter the list using an +// array of Filterobjects. func (c *Client) ListForecastExportJobs(ctx context.Context, params *ListForecastExportJobsInput, optFns ...func(*Options)) (*ListForecastExportJobsOutput, error) { if params == nil { params = &ListForecastExportJobsInput{} @@ -36,18 +36,24 @@ 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 // 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 + // 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": - // "arn:aws:forecast:us-west-2::forecast/electricityforecast" } ] + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": + // "arn:aws:forecast:us-west-2::forecast/electricityforecast" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListForecasts.go b/service/forecast/api_op_ListForecasts.go index d7dcd46c4b7..1c0a56db104 100644 --- a/service/forecast/api_op_ListForecasts.go +++ b/service/forecast/api_op_ListForecasts.go @@ -11,11 +11,10 @@ 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 -// 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. +// 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 DescribeForecastoperation. You can filter the list using an array of Filter objects. func (c *Client) ListForecasts(ctx context.Context, params *ListForecastsInput, optFns ...func(*Options)) (*ListForecastsOutput, error) { if params == nil { params = &ListForecastsInput{} @@ -36,17 +35,23 @@ 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 // 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 + // 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" } ] + // specify: + // + // "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListMonitorEvaluations.go b/service/forecast/api_op_ListMonitorEvaluations.go index d1711b2b6b4..90a5a302b9e 100644 --- a/service/forecast/api_op_ListMonitorEvaluations.go +++ b/service/forecast/api_op_ListMonitorEvaluations.go @@ -12,10 +12,12 @@ 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) -// . +// 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]. +// +// [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{} @@ -41,14 +43,21 @@ type ListMonitorEvaluationsInput 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 + // 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": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" + // } ] Filters []types.Filter // The maximum number of monitoring results to return. @@ -70,11 +79,12 @@ type ListMonitorEvaluationsOutput struct { NextToken *string // 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) - // . + // during different windows of time. + // + // For information about monitoring see [Viewing Monitoring Results]. For more information about retrieving + // monitoring results see [Viewing Monitoring Results]. + // + // [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 c6bafc57dc2..6f44a325882 100644 --- a/service/forecast/api_op_ListMonitors.go +++ b/service/forecast/api_op_ListMonitors.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of monitors created with the CreateMonitor operation and -// CreateAutoPredictor operation. For each monitor resource, this operation returns -// of a summary of its properties, including its Amazon Resource Name (ARN). You -// can retrieve a complete set of properties of a monitor resource by specify the -// monitor's ARN in the DescribeMonitor operation. +// Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each +// monitor resource, this operation returns of a summary of its properties, +// including its Amazon Resource Name (ARN). You can retrieve a complete set of +// properties of a monitor resource by specify the monitor's ARN in the DescribeMonitoroperation. func (c *Client) ListMonitors(ctx context.Context, params *ListMonitorsInput, optFns ...func(*Options)) (*ListMonitorsOutput, error) { if params == nil { params = &ListMonitorsInput{} @@ -36,13 +35,20 @@ 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 + // 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": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The maximum number of monitors to include in the response. diff --git a/service/forecast/api_op_ListPredictorBacktestExportJobs.go b/service/forecast/api_op_ListPredictorBacktestExportJobs.go index 0eba6352e45..27af2667600 100644 --- a/service/forecast/api_op_ListPredictorBacktestExportJobs.go +++ b/service/forecast/api_op_ListPredictorBacktestExportJobs.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of predictor backtest export jobs created using the -// CreatePredictorBacktestExportJob operation. This operation returns a summary for -// each backtest export job. You can filter the list using an array of Filter -// objects. To retrieve the complete set of properties for a particular backtest -// export job, use the ARN with the DescribePredictorBacktestExportJob operation. +// Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. +// This operation returns a summary for each backtest export job. You can filter +// the list using an array of Filterobjects. +// +// To retrieve the complete set of properties for a particular backtest export +// job, use the ARN with the DescribePredictorBacktestExportJoboperation. func (c *Client) ListPredictorBacktestExportJobs(ctx context.Context, params *ListPredictorBacktestExportJobsInput, optFns ...func(*Options)) (*ListPredictorBacktestExportJobsOutput, error) { if params == nil { params = &ListPredictorBacktestExportJobsInput{} @@ -36,13 +37,17 @@ 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 + // 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 diff --git a/service/forecast/api_op_ListPredictors.go b/service/forecast/api_op_ListPredictors.go index b216d21a44d..e47bf5b5429 100644 --- a/service/forecast/api_op_ListPredictors.go +++ b/service/forecast/api_op_ListPredictors.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of predictors created using the CreateAutoPredictor or -// CreatePredictor operations. For each predictor, 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 DescribeAutoPredictor -// and DescribePredictor operations. You can filter the list using an array of -// Filter objects. +// Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each +// predictor, 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 DescribeAutoPredictor and DescribePredictor +// operations. You can filter the list using an array of Filterobjects. func (c *Client) ListPredictors(ctx context.Context, params *ListPredictorsInput, optFns ...func(*Options)) (*ListPredictorsOutput, error) { if params == nil { params = &ListPredictorsInput{} @@ -37,16 +37,22 @@ 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 // 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 + // 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" } ] + // + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListWhatIfAnalyses.go b/service/forecast/api_op_ListWhatIfAnalyses.go index 113bb4f7211..3a183d7bf81 100644 --- a/service/forecast/api_op_ListWhatIfAnalyses.go +++ b/service/forecast/api_op_ListWhatIfAnalyses.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of what-if analyses created using the CreateWhatIfAnalysis -// operation. For each what-if analysis, 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 what-if analysis ARN with the -// DescribeWhatIfAnalysis operation. +// Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each +// what-if analysis, 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 what-if analysis ARN with the DescribeWhatIfAnalysisoperation. func (c *Client) ListWhatIfAnalyses(ctx context.Context, params *ListWhatIfAnalysesInput, optFns ...func(*Options)) (*ListWhatIfAnalysesOutput, error) { if params == nil { params = &ListWhatIfAnalysesInput{} @@ -36,18 +35,24 @@ 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 // 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 + // 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": - // "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" } ] + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": + // "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListWhatIfForecastExports.go b/service/forecast/api_op_ListWhatIfForecastExports.go index d6b89e1150d..7799b0dec29 100644 --- a/service/forecast/api_op_ListWhatIfForecastExports.go +++ b/service/forecast/api_op_ListWhatIfForecastExports.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of what-if forecast exports created using the -// CreateWhatIfForecastExport operation. For each what-if forecast export, 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 what-if -// forecast export ARN with the DescribeWhatIfForecastExport operation. +// Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For +// each what-if forecast export, 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 what-if forecast export ARN with the DescribeWhatIfForecastExport +// operation. func (c *Client) ListWhatIfForecastExports(ctx context.Context, params *ListWhatIfForecastExportsInput, optFns ...func(*Options)) (*ListWhatIfForecastExportsOutput, error) { if params == nil { params = &ListWhatIfForecastExportsInput{} @@ -37,17 +37,23 @@ type ListWhatIfForecastExportsInput struct { // 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": - // "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" } ] + // electricityWIFExport, specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": + // "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_ListWhatIfForecasts.go b/service/forecast/api_op_ListWhatIfForecasts.go index 39ffddb608e..40e9a374c20 100644 --- a/service/forecast/api_op_ListWhatIfForecasts.go +++ b/service/forecast/api_op_ListWhatIfForecasts.go @@ -11,11 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of what-if forecasts created using the CreateWhatIfForecast -// operation. For each what-if forecast, 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 what-if forecast ARN with the -// DescribeWhatIfForecast operation. +// Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each +// what-if forecast, 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 what-if forecast ARN with the DescribeWhatIfForecastoperation. func (c *Client) ListWhatIfForecasts(ctx context.Context, params *ListWhatIfForecastsInput, optFns ...func(*Options)) (*ListWhatIfForecastsOutput, error) { if params == nil { params = &ListWhatIfForecastsInput{} @@ -37,17 +36,23 @@ type ListWhatIfForecastsInput struct { // 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": - // "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" } ] + // electricityWhatIfForecast, specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": + // "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" } ] Filters []types.Filter // The number of items to return in the response. diff --git a/service/forecast/api_op_StopResource.go b/service/forecast/api_op_StopResource.go index 4fb97ea0775..0f0a3c79858 100644 --- a/service/forecast/api_op_StopResource.go +++ b/service/forecast/api_op_StopResource.go @@ -10,16 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// operation can be applied to the following resources (and their corresponding -// child resources): +// 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 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 func (c *Client) StopResource(ctx context.Context, params *StopResourceInput, optFns ...func(*Options)) (*StopResourceOutput, error) { if params == nil { diff --git a/service/forecast/api_op_TagResource.go b/service/forecast/api_op_TagResource.go index 5ce512ee29f..218eb7a36a9 100644 --- a/service/forecast/api_op_TagResource.go +++ b/service/forecast/api_op_TagResource.go @@ -38,18 +38,26 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The tags to add to the resource. A tag is an array of key-value pairs. The - // following basic restrictions apply to tags: + // 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 diff --git a/service/forecast/api_op_UpdateDatasetGroup.go b/service/forecast/api_op_UpdateDatasetGroup.go index bfe54ce7504..c0608062a50 100644 --- a/service/forecast/api_op_UpdateDatasetGroup.go +++ b/service/forecast/api_op_UpdateDatasetGroup.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// operation to get the status. +// 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]operation to get the status. +// +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html func (c *Client) UpdateDatasetGroup(ctx context.Context, params *UpdateDatasetGroupInput, optFns ...func(*Options)) (*UpdateDatasetGroupOutput, error) { if params == nil { params = &UpdateDatasetGroupInput{} diff --git a/service/forecast/options.go b/service/forecast/options.go index 0cbc85cecd7..9bee2745c5b 100644 --- a/service/forecast/options.go +++ b/service/forecast/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/forecast/types/enums.go b/service/forecast/types/enums.go index 2e9053b3ff0..3b1381bcfeb 100644 --- a/service/forecast/types/enums.go +++ b/service/forecast/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeType) Values() []AttributeType { return []AttributeType{ "string", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AutoMLOverrideStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLOverrideStrategy) Values() []AutoMLOverrideStrategy { return []AutoMLOverrideStrategy{ "LatencyOptimized", @@ -55,8 +57,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for DatasetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetType) Values() []DatasetType { return []DatasetType{ "TARGET_TIME_SERIES", @@ -100,8 +104,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -128,8 +133,9 @@ const ( ) // Values returns all known values for Domain. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Domain) Values() []Domain { return []Domain{ "RETAIL", @@ -151,8 +157,9 @@ const ( ) // Values returns all known values for EvaluationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationType) Values() []EvaluationType { return []EvaluationType{ "SUMMARY", @@ -168,8 +175,9 @@ const ( ) // Values returns all known values for FeaturizationMethodName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeaturizationMethodName) Values() []FeaturizationMethodName { return []FeaturizationMethodName{ "filling", @@ -185,8 +193,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "IS", @@ -203,8 +212,9 @@ const ( ) // Values returns all known values for ImportMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportMode) Values() []ImportMode { return []ImportMode{ "FULL", @@ -231,8 +241,9 @@ const ( ) // 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. +// the future, and so 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{ "JANUARY", @@ -261,8 +272,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -284,8 +296,9 @@ const ( ) // Values returns all known values for OptimizationMetric. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptimizationMetric) Values() []OptimizationMetric { return []OptimizationMetric{ "WAPE", @@ -307,8 +320,9 @@ const ( ) // Values returns all known values for ScalingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingType) Values() []ScalingType { return []ScalingType{ "Auto", @@ -327,8 +341,9 @@ const ( ) // 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. +// the future, and so 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{ "Active", @@ -345,8 +360,9 @@ const ( ) // Values returns all known values for TimePointGranularity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimePointGranularity) Values() []TimePointGranularity { return []TimePointGranularity{ "ALL", @@ -363,8 +379,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ALL", diff --git a/service/forecast/types/types.go b/service/forecast/types/types.go index 7da48eeec89..1449a842f99 100644 --- a/service/forecast/types/types.go +++ b/service/forecast/types/types.go @@ -11,9 +11,8 @@ import ( // 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 -// this operation with the TimeSeriesCondition operation within the -// CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a -// subset of attribute items that are modified. +// this operation with the TimeSeriesConditionoperation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of +// attribute items that are modified. type Action struct { // The related time series that you are modifying. This value is case insensitive. @@ -22,9 +21,13 @@ 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 . // // This member is required. @@ -38,18 +41,26 @@ type Action struct { noSmithyDocumentSerde } -// Describes an additional dataset. This object is part of the DataConfig object. -// Forecast supports the Weather Index and Holidays additional datasets. Weather -// Index The Amazon Forecast Weather Index is a built-in dataset that incorporates +// Describes an additional dataset. This object is part of the DataConfig object. Forecast +// supports the Weather Index and Holidays additional datasets. +// +// # Weather Index +// +// The Amazon Forecast Weather Index is a built-in dataset 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 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) -// . +// to 14 days of projected weather data. For more information, see [Amazon Forecast Weather Index]. +// +// # 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]library. For more +// information, see [Holidays Featurization]. +// +// [Amazon Forecast Weather Index]: https://docs.aws.amazon.com/forecast/latest/dg/weather.html +// [Jollyday]: http://jollyday.sourceforge.net/data.html +// [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" . @@ -57,89 +68,165 @@ type AdditionalDataset struct { // 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 - // the following two-letter country codes: + // Weather Index + // + // To enable the Weather Index, do not specify a value for 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 Configuration map[string][]string noSmithyDocumentSerde } -// Provides information about the method used to transform attributes. The +// Provides information about the method used to transform attributes. // -// following is an example using the RETAIL domain: { -// "AttributeName": "demand", +// The following is an example using the RETAIL domain: // -// "Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": -// "zero"} +// { // -// } +// "AttributeName": "demand", +// +// "Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": +// "zero"} +// +// } type AttributeConfig struct { // The name of the attribute as specified in the schema. Amazon Forecast supports @@ -151,18 +238,29 @@ type AttributeConfig struct { // 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. + // 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 @@ -178,9 +276,11 @@ 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] for the predictor you are monitoring. Use these metrics as a + // baseline for comparison purposes as you use your predictor and the metrics + // change. + // + // [accuracy metrics]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html PredictorBaseline *PredictorBaseline noSmithyDocumentSerde @@ -200,7 +300,7 @@ type BaselineMetric struct { } // Specifies a categorical hyperparameter and it's range of tunable values. This -// object is part of the ParameterRanges object. +// object is part of the ParameterRangesobject. type CategoricalParameterRange struct { // The name of the categorical hyperparameter to tune. @@ -217,7 +317,7 @@ type CategoricalParameterRange struct { } // Specifies a continuous hyperparameter and it's range of tunable values. This -// object is part of the ParameterRanges object. +// object is part of the ParameterRangesobject. type ContinuousParameterRange struct { // The maximum tunable value of the hyperparameter. @@ -236,17 +336,29 @@ type ContinuousParameterRange struct { Name *string // The scale that hyperparameter tuning uses to search the hyperparameter range. - // Valid values: Auto Amazon Forecast 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 logarithmic scale. + // Valid values: + // + // Auto Amazon Forecast 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 logarithmic scale. + // // Logarithmic scaling works only for ranges that have values greater than 0. + // // ReverseLogarithmic hyperparameter tuning searches the values in the - // 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: + // 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]. One of the + // following values: + // + // [Hyperparameter Scaling]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type ScalingType ScalingType noSmithyDocumentSerde @@ -283,9 +395,12 @@ 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] operation. To +// get the complete set of properties, call the [DescribeDatasetGroup]operation, and provide the +// DatasetGroupArn . +// +// [ListDatasetGroups]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html type DatasetGroupSummary struct { // When the dataset group was created. @@ -297,20 +412,22 @@ type DatasetGroupSummary struct { // The name of the dataset group. 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) + // When the dataset group was created or last updated from a call to the [UpdateDatasetGroup] // 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 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) -// 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 . +// Provides a summary of the dataset import job properties used in the [ListDatasetImportJobs] operation. +// To get the complete set of properties, call the [DescribeDatasetImportJob]operation, and provide the +// DatasetImportJobArn . +// +// [ListDatasetImportJobs]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html +// [DescribeDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html type DatasetImportJobSummary struct { // When the dataset import job was created. @@ -318,8 +435,9 @@ type DatasetImportJobSummary struct { // The location of the training data to import and an Identity and Access // Management (IAM) role that Amazon Forecast can assume to access the data. The - // training data must be stored in an Amazon S3 bucket. If encryption is used, - // DataSource includes an Key Management Service (KMS) key. + // training data must be stored in an Amazon S3 bucket. + // + // If encryption is used, DataSource includes an Key Management Service (KMS) key. DataSource *DataSource // The Amazon Resource Name (ARN) of the dataset import job. @@ -333,10 +451,15 @@ 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. LastModificationTime *time.Time @@ -344,18 +467,24 @@ type DatasetImportJobSummary struct { 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 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] operation. To get the +// complete set of properties, call the [DescribeDataset]operation, and provide the DatasetArn . +// +// [DescribeDataset]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html +// [ListDatasets]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html type DatasetSummary struct { // When the dataset was created. @@ -375,9 +504,10 @@ type DatasetSummary struct { // 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. + // current time of the ListDatasets call. After a [CreateDatasetImportJob] operation has finished, + // LastModificationTime is when the import job completed or failed. + // + // [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html LastModificationTime *time.Time noSmithyDocumentSerde @@ -399,7 +529,7 @@ type DataSource struct { // An Key Management Service (KMS) key and an Identity and Access Management (IAM) // role that Amazon Forecast can assume to access the key. You can specify this -// optional object in the CreateDataset and CreatePredictor requests. +// optional object in the CreateDatasetand CreatePredictor requests. type EncryptionConfig struct { // The Amazon Resource Name (ARN) of the KMS key. @@ -408,8 +538,9 @@ type EncryptionConfig struct { KMSKeyArn *string // The ARN of the IAM role that Amazon Forecast can assume to access the KMS key. - // Passing a role across Amazon Web Services accounts is not allowed. If you pass a - // role that isn't in your account, you get an InvalidInputException error. + // + // Passing a role across Amazon Web Services accounts is not allowed. If you pass + // a role that isn't in your account, you get an InvalidInputException error. // // This member is required. RoleArn *string @@ -417,11 +548,12 @@ 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 Metricsobject. type ErrorMetric struct { - // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. + // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. ForecastType *string // The Mean Absolute Percentage Error (MAPE) @@ -430,10 +562,10 @@ type ErrorMetric struct { // The Mean Absolute Scaled Error (MASE) MASE *float64 - // The root-mean-square error (RMSE). + // The root-mean-square error (RMSE). RMSE *float64 - // The weighted absolute percentage error (WAPE). + // The weighted absolute percentage error (WAPE). WAPE *float64 noSmithyDocumentSerde @@ -441,8 +573,7 @@ type ErrorMetric struct { // Parameters that define how to split a dataset into training data and testing // data, and the number of iterations to perform. These parameters are specified in -// the predefined algorithms but you can override them in the CreatePredictor -// request. +// the predefined algorithms but you can override them in the CreatePredictorrequest. type EvaluationParameters struct { // The point from the end of the dataset where you want to split the data for @@ -450,8 +581,10 @@ type EvaluationParameters struct { // 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 @@ -461,42 +594,48 @@ type EvaluationParameters struct { noSmithyDocumentSerde } -// The results of evaluating an algorithm. Returned as part of the -// GetAccuracyMetrics response. +// The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response. type EvaluationResult struct { // The Amazon Resource Name (ARN) of the algorithm that was evaluated. AlgorithmArn *string // The array of test windows used for evaluating the algorithm. The - // NumberOfBacktestWindows from the EvaluationParameters object determines the - // number of windows in the array. + // NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in + // the array. TestWindows []WindowSummary noSmithyDocumentSerde } // 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 -// can set TimePointGranularity and TimeSeriesGranularity to either “ALL” or -// “Specific”. +// 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 - // EndDateTime parameters within the CreateExplainability operation. + // horizon, use SPECIFIC . + // + // Specify time points with the StartDateTime and EndDateTime parameters within + // the CreateExplainabilityoperation. // // 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. + // . + // + // Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket + // and set the location within the DataDestinationdata type. // // This member is required. TimeSeriesGranularity TimeSeriesGranularity @@ -504,10 +643,9 @@ type ExplainabilityConfig struct { noSmithyDocumentSerde } -// 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 . +// Provides a summary of the Explainability export properties used in the ListExplainabilityExports +// operation. To get a complete set of properties, call the DescribeExplainabilityExportoperation, and provide +// the ExplainabilityExportArn . type ExplainabilityExportSummary struct { // When the Explainability was created. @@ -526,10 +664,15 @@ 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. LastModificationTime *time.Time @@ -538,9 +681,13 @@ 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 Status *string @@ -554,18 +701,22 @@ 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 Status *string noSmithyDocumentSerde } -// 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 . +// Provides a summary of the Explainability properties used in the ListExplainabilities operation. To +// get a complete set of properties, call the DescribeExplainabilityoperation, and provide the listed +// ExplainabilityArn . type ExplainabilitySummary struct { // When the Explainability was created. @@ -583,10 +734,15 @@ 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. LastModificationTime *time.Time @@ -599,38 +755,47 @@ 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 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 +// 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 FeaturizationConfigobject. +// +// For example: // -// part of the FeaturizationConfig object. For example: { -// "AttributeName": "demand", +// { // -// FeaturizationPipeline [ { +// "AttributeName": "demand", // -// "FeaturizationMethodName": "filling", +// FeaturizationPipeline [ { // -// "FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"} +// "FeaturizationMethodName": "filling", // -// } ] +// "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 . + // more information, see howitworks-missing-values. // // This member is required. AttributeName *string @@ -642,38 +807,53 @@ type Featurization struct { noSmithyDocumentSerde } -// This object belongs to the CreatePredictor operation. If you created your -// 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 -// define featurization using the FeaturizationConfig object. You specify an array -// of transformations, one for each field that you want to featurize. You then -// include the FeaturizationConfig object in your CreatePredictor request. Amazon -// Forecast applies the featurization to the TARGET_TIME_SERIES and -// RELATED_TIME_SERIES datasets before model training. You can create multiple -// featurization configurations. For example, you might call the CreatePredictor -// operation twice by specifying different featurization configurations. +// This object belongs to the CreatePredictor operation. If you created your 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 define featurization using the FeaturizationConfig object. You specify an +// array of transformations, one for each field that you want to featurize. You +// then include the FeaturizationConfig object in your CreatePredictor request. +// Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and +// RELATED_TIME_SERIES datasets before model training. +// +// You can create multiple featurization configurations. For example, you might +// call the CreatePredictor operation twice by specifying different featurization +// configurations. type FeaturizationConfig struct { - // The frequency of predictions in a forecast. Valid intervals are an integer - // followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). - // For example, "1D" indicates every day and "15min" indicates every 15 minutes. - // You cannot 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: + // The frequency of predictions in a forecast. + // + // Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D + // (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and + // "15min" indicates every 15 minutes. You cannot 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 + // // 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. + // 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 @@ -683,29 +863,35 @@ type FeaturizationConfig struct { Featurizations []Featurization // An array of dimension (field) names that specify how to group the generated - // forecast. For example, suppose that you are generating a forecast for item sales - // across all of your stores, and your dataset contains a store_id field. If you - // 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. + // forecast. + // + // For example, suppose that you are generating a forecast for item sales across + // all of your stores, and your dataset contains a store_id field. If you 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. ForecastDimensions []string noSmithyDocumentSerde } // Provides information about the method that featurizes (transforms) a dataset -// field. The method is part of the FeaturizationPipeline of the Featurization -// object. The following is an example of how you specify a FeaturizationMethod +// field. The method is part of the FeaturizationPipeline of the Featurization object. // -// object. { -// "FeaturizationMethodName": "filling", +// The following is an example of how you specify a FeaturizationMethod object. // -// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", -// "backfill": "zero"} +// { // -// } +// "FeaturizationMethodName": "filling", +// +// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", +// "backfill": "zero"} +// +// } type FeaturizationMethod struct { // The name of the method. The "filling" method is the only supported method. @@ -715,18 +901,29 @@ type FeaturizationMethod struct { // 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. + // 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 @@ -761,10 +958,9 @@ type Filter struct { noSmithyDocumentSerde } -// 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 . +// Provides a summary of the forecast export job properties used in the ListForecastExportJobs +// operation. To get the complete set of properties, call the DescribeForecastExportJoboperation, and +// provide the listed ForecastExportJobArn . type ForecastExportJobSummary struct { // When the forecast export job was created. @@ -782,10 +978,15 @@ 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. LastModificationTime *time.Time @@ -793,10 +994,15 @@ type ForecastExportJobSummary struct { 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. Status *string @@ -804,9 +1010,9 @@ type ForecastExportJobSummary struct { noSmithyDocumentSerde } -// Provides a summary of the forecast properties used in the ListForecasts -// operation. To get the complete set of properties, call the DescribeForecast -// operation, and provide the ForecastArn that is listed in the summary. +// Provides a summary of the forecast properties used in the ListForecasts operation. To get +// the complete set of properties, call the DescribeForecastoperation, and provide the ForecastArn +// that is listed in the summary. type ForecastSummary struct { // Whether the Forecast was created from an AutoPredictor. @@ -827,10 +1033,15 @@ 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. LastModificationTime *time.Time @@ -841,10 +1052,15 @@ 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. Status *string @@ -853,11 +1069,14 @@ type ForecastSummary struct { } // Configuration information for a hyperparameter tuning job. You specify this -// object in the CreatePredictor request. A hyperparameter is a parameter that -// governs the model training process. You set hyperparameters before training -// starts, unlike model parameters, which are determined during training. The -// values of the hyperparameters effect which values are chosen for the model -// parameters. In a hyperparameter tuning job, Amazon Forecast chooses the set of +// object in the CreatePredictorrequest. +// +// A hyperparameter is a parameter that governs the model training process. You +// set hyperparameters before training starts, unlike model parameters, which are +// determined during training. The values of the hyperparameters effect which +// values are chosen for the model parameters. +// +// In a hyperparameter tuning job, Amazon Forecast chooses the set of // hyperparameter values that optimize a specified metric. Forecast accomplishes // this by running many training jobs over a range of hyperparameter values. The // optimum set of values depends on the algorithm, the training data, and the @@ -870,10 +1089,11 @@ type HyperParameterTuningJobConfig struct { noSmithyDocumentSerde } -// This object belongs to the CreatePredictor operation. If you created your -// 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. +// This object belongs to the CreatePredictor operation. If you created your 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 CreatePredictorrequest. type InputDataConfig struct { // The Amazon Resource Name (ARN) of the dataset group. @@ -889,7 +1109,7 @@ type InputDataConfig struct { } // Specifies an integer hyperparameter and it's range of tunable values. This -// object is part of the ParameterRanges object. +// object is part of the ParameterRangesobject. type IntegerParameterRange struct { // The maximum tunable value of the hyperparameter. @@ -908,25 +1128,40 @@ type IntegerParameterRange struct { Name *string // The scale that hyperparameter tuning uses to search the hyperparameter range. - // Valid values: Auto Amazon Forecast 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 logarithmic scale. + // Valid values: + // + // Auto Amazon Forecast 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 logarithmic scale. + // // Logarithmic scaling works only for ranges that have values greater than 0. - // 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: + // + // 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]. One of the + // following values: + // + // [Hyperparameter Scaling]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type ScalingType ScalingType noSmithyDocumentSerde } // 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) +// can compare the value for this metric to the metric's value in the Baselineto see how +// your predictor's performance is changing. +// +// For more information about metrics generated by Forecast see [Evaluating Predictor Accuracy] +// +// [Evaluating Predictor Accuracy]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html type MetricResult struct { // The name of the metric. @@ -939,13 +1174,13 @@ type MetricResult struct { } // Provides metrics that are used to evaluate the performance of a predictor. This -// object is part of the WindowSummary object. +// object is part of the WindowSummaryobject. type Metrics struct { // The average value of all weighted quantile losses. AverageWeightedQuantileLoss *float64 - // Provides detailed error metrics for each forecast type. Metrics include + // Provides detailed error metrics for each forecast type. Metrics include // root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean // absolute scaled error (MASE), and weighted average percentage error (WAPE). ErrorMetrics []ErrorMetric @@ -999,19 +1234,24 @@ 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 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 DescribeMonitoroperation, and provide the listed +// MonitorArn . type MonitorSummary struct { // When the monitor resource was created. @@ -1019,9 +1259,13 @@ 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. LastModificationTime *time.Time @@ -1035,10 +1279,15 @@ 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 Status *string @@ -1048,7 +1297,7 @@ type MonitorSummary struct { // Specifies the categorical, continuous, and integer hyperparameters, and their // ranges of tunable values. The range of tunable values determines which values // that a hyperparameter tuning job can choose for the specified hyperparameter. -// This object is part of the HyperParameterTuningJobConfig object. +// This object is part of the HyperParameterTuningJobConfigobject. type ParameterRanges struct { // Specifies the tunable range for each categorical hyperparameter. @@ -1063,10 +1312,9 @@ type ParameterRanges struct { noSmithyDocumentSerde } -// 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 . +// Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs +// operation. To get a complete set of properties, call the DescribePredictorBacktestExportJoboperation, and provide +// the listed PredictorBacktestExportJobArn . type PredictorBacktestExportJobSummary struct { // When the predictor backtest export job was created. @@ -1079,10 +1327,15 @@ 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. LastModificationTime *time.Time @@ -1096,9 +1349,13 @@ 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 Status *string @@ -1109,9 +1366,10 @@ 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] for the predictor. Use these metrics as a baseline for comparison + // purposes as you use your predictor and the metrics change. + // + // [accuracy metrics]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html BaselineMetrics []BaselineMetric noSmithyDocumentSerde @@ -1174,8 +1432,8 @@ type PredictorMonitorEvaluation struct { Message *string // A list of metrics Forecast calculated when monitoring a predictor. You can - // compare the value for each metric in the list to the metric's value in the - // Baseline to see how your predictor's performance is changing. + // compare the value for each metric in the list to the metric's value in the Baselineto + // see how your predictor's performance is changing. MetricResults []MetricResult // The Amazon Resource Name (ARN) of the monitor resource. @@ -1204,9 +1462,9 @@ type PredictorMonitorEvaluation struct { noSmithyDocumentSerde } -// 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 . +// Provides a summary of the predictor properties that are used in the ListPredictors operation. +// To get the complete set of properties, call the DescribePredictoroperation, and provide the +// listed PredictorArn . type PredictorSummary struct { // When the model training task was created. @@ -1221,10 +1479,15 @@ 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. LastModificationTime *time.Time @@ -1242,10 +1505,15 @@ 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. Status *string @@ -1269,8 +1537,8 @@ type ReferencePredictorSummary struct { // The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, // and an Identity and Access Management (IAM) role that Amazon Forecast can assume // to access the file(s). Optionally, includes an Key Management Service (KMS) key. -// This object is part of the DataSource object that is submitted in the -// CreateDatasetImportJob request, and part of the DataDestination object. +// This object is part of the DataSourceobject that is submitted in the CreateDatasetImportJob request, and part +// of the DataDestinationobject. type S3Config struct { // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in @@ -1281,9 +1549,10 @@ type S3Config struct { // The ARN of the Identity and Access Management (IAM) role that Amazon Forecast // can assume to access the Amazon S3 bucket or files. If you provide a value for - // the KMSKeyArn key, the role must allow access to the key. Passing a role across - // Amazon Web Services accounts is not allowed. If you pass a role that isn't in - // your account, you get an InvalidInputException error. + // the KMSKeyArn key, the role must allow access to the key. + // + // Passing a role across Amazon Web Services accounts is not allowed. If you pass + // a role that isn't in your account, you get an InvalidInputException error. // // This member is required. RoleArn *string @@ -1304,24 +1573,29 @@ 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]object contains an array of +// SchemaAttribute objects. +// +// [Schema]: https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html type SchemaAttribute struct { // The name of the dataset field. AttributeName *string - // The data type of the field. For a related time series dataset, other than date, - // item_id, and forecast dimensions attributes, all attributes should be of - // numerical type (integer/float). + // The data type of the field. + // + // For a related time series dataset, other than date, item_id, and forecast + // dimensions attributes, all attributes should be of numerical type + // (integer/float). AttributeType AttributeType noSmithyDocumentSerde } // 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) -// operation. +// dataset with the [CreateDatasetImportJob]operation. +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html type Statistics struct { // For a numeric field, the average value in the field. @@ -1371,21 +1645,30 @@ type Statistics struct { noSmithyDocumentSerde } -// This object belongs to the CreatePredictor operation. If you created your -// 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) +// This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset // . +// +// Describes a supplementary feature of a dataset group. This object is part of +// the InputDataConfigobject. 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]. +// +// # 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]library. For more information, see [Holidays Featurization]. +// +// [Amazon Forecast Weather Index]: https://docs.aws.amazon.com/forecast/latest/dg/weather.html +// [Jollyday]: http://jollyday.sourceforge.net/data.html +// [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" . @@ -1393,74 +1676,145 @@ type SupplementaryFeature struct { // This member is required. Name *string - // 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: + // 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 // // This member is required. @@ -1471,17 +1825,26 @@ 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: +// 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 @@ -1513,8 +1876,11 @@ type TestWindowSummary struct { Message *string // The status of the test. Possible status values are: + // // - ACTIVE + // // - CREATE_IN_PROGRESS + // // - CREATE_FAILED Status *string @@ -1529,13 +1895,14 @@ 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]. +// +// For more information about aggregation, see [Data Aggregation for Different Forecast Frequencies]. For more information setting a +// custom time boundary, see [Specifying a Time Boundary]. +// +// [Data Aggregation for Different Forecast Frequencies]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html +// [Specifying a Time Boundary]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary +// [Default Time Boundaries]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries type TimeAlignmentBoundary struct { // The day of the month to use for time alignment during aggregation. @@ -1558,9 +1925,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 -// the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define -// how the attribute is modified. +// "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 { // The item_id, dimension name, IM name, or timestamp that you are modifying. @@ -1611,8 +1977,8 @@ type TimeSeriesReplacementsDataSource struct { // The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, // and an Identity and Access Management (IAM) role that Amazon Forecast can assume // to access the file(s). Optionally, includes an Key Management Service (KMS) key. - // This object is part of the DataSource object that is submitted in the - // CreateDatasetImportJob request, and part of the DataDestination object. + // This object is part of the DataSourceobject that is submitted in the CreateDatasetImportJob request, and part + // of the DataDestinationobject. // // This member is required. S3Config *S3Config @@ -1632,10 +1998,14 @@ 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: +// TimeSeriesIdentifiers object. +// +// The TimeSeriesIdentifiers object needs the following information: +// // - DataSource +// // - Format +// // - Schema type TimeSeriesSelector struct { @@ -1665,8 +2035,7 @@ type TimeSeriesTransformation struct { noSmithyDocumentSerde } -// The weighted loss value for a quantile. This object is part of the Metrics -// object. +// The weighted loss value for a quantile. This object is part of the Metrics object. type WeightedQuantileLoss struct { // The difference between the predicted value and the actual value over the @@ -1681,10 +2050,9 @@ type WeightedQuantileLoss struct { noSmithyDocumentSerde } -// Provides a summary of the what-if analysis properties used in the -// ListWhatIfAnalyses operation. To get the complete set of properties, call the -// DescribeWhatIfAnalysis operation, and provide the WhatIfAnalysisArn that is -// listed in the summary. +// Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. +// To get the complete set of properties, call the DescribeWhatIfAnalysisoperation, and provide the +// WhatIfAnalysisArn that is listed in the summary. type WhatIfAnalysisSummary struct { // When the what-if analysis was created. @@ -1696,10 +2064,15 @@ 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. LastModificationTime *time.Time @@ -1707,10 +2080,15 @@ type WhatIfAnalysisSummary struct { 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. Status *string @@ -1724,10 +2102,9 @@ type WhatIfAnalysisSummary struct { noSmithyDocumentSerde } -// Provides a summary of the what-if forecast export properties used in the -// ListWhatIfForecastExports operation. To get the complete set of properties, call -// the DescribeWhatIfForecastExport operation, and provide the -// WhatIfForecastExportArn that is listed in the summary. +// Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports +// operation. To get the complete set of properties, call the DescribeWhatIfForecastExportoperation, and +// provide the WhatIfForecastExportArn that is listed in the summary. type WhatIfForecastExportSummary struct { // When the what-if forecast export was created. @@ -1739,10 +2116,15 @@ 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. LastModificationTime *time.Time @@ -1750,10 +2132,15 @@ type WhatIfForecastExportSummary struct { 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. Status *string @@ -1771,10 +2158,9 @@ type WhatIfForecastExportSummary struct { noSmithyDocumentSerde } -// Provides a summary of the what-if forecast properties used in the -// ListWhatIfForecasts operation. To get the complete set of properties, call the -// DescribeWhatIfForecast operation, and provide the WhatIfForecastArn that is -// listed in the summary. +// Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts operation. +// To get the complete set of properties, call the DescribeWhatIfForecastoperation, and provide the +// WhatIfForecastArn that is listed in the summary. type WhatIfForecastSummary struct { // When the what-if forecast was created. @@ -1782,10 +2168,15 @@ 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. LastModificationTime *time.Time @@ -1793,10 +2184,15 @@ type WhatIfForecastSummary struct { 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. Status *string @@ -1815,13 +2211,16 @@ 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. +// object is part of the EvaluationResultobject. +// +// The TestWindowStart and 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. EvaluationType EvaluationType diff --git a/service/forecastquery/api_op_QueryForecast.go b/service/forecastquery/api_op_QueryForecast.go index 7a7e1723d40..2523d30e5f1 100644 --- a/service/forecastquery/api_op_QueryForecast.go +++ b/service/forecastquery/api_op_QueryForecast.go @@ -11,15 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a forecast for a single item, filtered by the supplied criteria. The -// criteria is a key-value pair. The key is either item_id (or the equivalent +// Retrieves a forecast for a single item, filtered by the supplied criteria. +// +// The criteria is a key-value pair. The key is either item_id (or the equivalent // non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of -// 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) -// operation. The forecasts generated by Amazon Forecast are in the same timezone -// as the dataset that was used to create the predictor. +// 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] operation. +// +// The forecasts generated by Amazon Forecast are in the same timezone as the +// dataset that was used to create the predictor. +// +// [CreateForecastExportJob]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html func (c *Client) QueryForecast(ctx context.Context, params *QueryForecastInput, optFns ...func(*Options)) (*QueryForecastOutput, error) { if params == nil { params = &QueryForecastInput{} @@ -39,9 +45,13 @@ 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) - // operation. + // following: + // + // {"item_id" : "client_21"} + // + // To get the full forecast, use the [CreateForecastExportJob] operation. + // + // [CreateForecastExportJob]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html // // This member is required. Filters map[string]string diff --git a/service/forecastquery/api_op_QueryWhatIfForecast.go b/service/forecastquery/api_op_QueryWhatIfForecast.go index f55a9c1f423..ad58415ac8c 100644 --- a/service/forecastquery/api_op_QueryWhatIfForecast.go +++ b/service/forecastquery/api_op_QueryWhatIfForecast.go @@ -31,9 +31,13 @@ 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) - // operation. + // following: + // + // {"item_id" : "client_21"} + // + // To get the full what-if forecast, use the [CreateForecastExportJob] operation. + // + // [CreateForecastExportJob]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html // // This member is required. Filters map[string]string @@ -61,8 +65,7 @@ type QueryWhatIfForecastInput struct { type QueryWhatIfForecastOutput struct { - // Provides information about a forecast. Returned as part of the QueryForecast - // response. + // Provides information about a forecast. Returned as part of the QueryForecast response. Forecast *types.Forecast // Metadata pertaining to the operation's result. diff --git a/service/forecastquery/options.go b/service/forecastquery/options.go index bfd8c7ed464..b58f78556b7 100644 --- a/service/forecastquery/options.go +++ b/service/forecastquery/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/forecastquery/types/types.go b/service/forecastquery/types/types.go index 56ba0ce9302..68dde48f4a5 100644 --- a/service/forecastquery/types/types.go +++ b/service/forecastquery/types/types.go @@ -18,19 +18,24 @@ type DataPoint struct { noSmithyDocumentSerde } -// Provides information about a forecast. Returned as part of the QueryForecast -// response. +// Provides information about a forecast. Returned as part of the QueryForecast response. type Forecast struct { - // The forecast. The string of the string-to-array map is one of the following - // values: + // 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) - // 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. + // parameter of the [CreateForecast]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. + // + // [CreateForecast]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html Predictions map[string][]DataPoint noSmithyDocumentSerde diff --git a/service/frauddetector/api_op_CancelBatchImportJob.go b/service/frauddetector/api_op_CancelBatchImportJob.go index 1146b233a67..a7ed8fc6c7c 100644 --- a/service/frauddetector/api_op_CancelBatchImportJob.go +++ b/service/frauddetector/api_op_CancelBatchImportJob.go @@ -28,9 +28,10 @@ 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 - // state. + // 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 state. // // This member is required. JobId *string diff --git a/service/frauddetector/api_op_CreateBatchImportJob.go b/service/frauddetector/api_op_CreateBatchImportJob.go index 16371696d73..892f0bb7431 100644 --- a/service/frauddetector/api_op_CreateBatchImportJob.go +++ b/service/frauddetector/api_op_CreateBatchImportJob.go @@ -35,10 +35,12 @@ type CreateBatchImportJobInput struct { EventTypeName *string // 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) - // in the Amazon S3 User Guide. + // permissions, see [User policy examples]in the Amazon S3 User Guide. + // + // [User policy examples]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html // // This member is required. IamRoleArn *string diff --git a/service/frauddetector/api_op_CreateBatchPredictionJob.go b/service/frauddetector/api_op_CreateBatchPredictionJob.go index ca267f86b06..f5738dd30b3 100644 --- a/service/frauddetector/api_op_CreateBatchPredictionJob.go +++ b/service/frauddetector/api_op_CreateBatchPredictionJob.go @@ -39,10 +39,13 @@ 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) - // in the Amazon S3 User Guide. + // 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]in the Amazon S3 User Guide. + // + // [User policy examples]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html // // This member is required. IamRoleArn *string diff --git a/service/frauddetector/api_op_CreateDetectorVersion.go b/service/frauddetector/api_op_CreateDetectorVersion.go index b671d4989f2..f2276af8ccd 100644 --- a/service/frauddetector/api_op_CreateDetectorVersion.go +++ b/service/frauddetector/api_op_CreateDetectorVersion.go @@ -48,13 +48,19 @@ type CreateDetectorVersionInput struct { // The model versions to include in the detector version. ModelVersions []types.ModelVersion - // 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 + // 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 // 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 . + // 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 . 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 c164cef9c9e..e5ebbb4e898 100644 --- a/service/frauddetector/api_op_CreateList.go +++ b/service/frauddetector/api_op_CreateList.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -32,25 +35,27 @@ func (c *Client) CreateList(ctx context.Context, params *CreateListInput, optFns type CreateListInput struct { - // The name of the list. + // The name of the list. // // This member is required. Name *string - // The description of the list. + // The description of the list. 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. + // The names of the elements, if providing. You can also create an empty list and + // add elements later using the [UpdateList]API. + // + // [UpdateList]: https://docs.aws.amazon.com/frauddetector/latest/api/API_Updatelist.html Elements []string - // A collection of the key and value pairs. + // 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]. + // + // [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_CreateVariable.go b/service/frauddetector/api_op_CreateVariable.go index f24d87e8e7e..74321c0bdc0 100644 --- a/service/frauddetector/api_op_CreateVariable.go +++ b/service/frauddetector/api_op_CreateVariable.go @@ -55,14 +55,17 @@ 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]. + // + // 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 | // PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | // SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | // SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT + // + // [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_DeleteDetector.go b/service/frauddetector/api_op_DeleteDetector.go index 0e824ae9411..85d376fbe3a 100644 --- a/service/frauddetector/api_op_DeleteDetector.go +++ b/service/frauddetector/api_op_DeleteDetector.go @@ -11,9 +11,10 @@ import ( ) // Deletes the detector. Before deleting a detector, you must first delete all -// detector versions and rule versions associated with the detector. When you -// delete a detector, Amazon Fraud Detector permanently deletes the detector and -// the data is no longer stored in Amazon Fraud Detector. +// detector versions and rule versions associated with the detector. +// +// When you delete a detector, Amazon Fraud Detector permanently deletes the +// detector and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteDetector(ctx context.Context, params *DeleteDetectorInput, optFns ...func(*Options)) (*DeleteDetectorOutput, error) { if params == nil { params = &DeleteDetectorInput{} diff --git a/service/frauddetector/api_op_DeleteDetectorVersion.go b/service/frauddetector/api_op_DeleteDetectorVersion.go index 0e38439ddf6..9c7c4524058 100644 --- a/service/frauddetector/api_op_DeleteDetectorVersion.go +++ b/service/frauddetector/api_op_DeleteDetectorVersion.go @@ -11,9 +11,10 @@ import ( ) // Deletes the detector version. You cannot delete detector versions that are in -// ACTIVE status. When you delete a detector version, Amazon Fraud Detector -// permanently deletes the detector and the data is no longer stored in Amazon -// Fraud Detector. +// ACTIVE status. +// +// When you delete a detector version, Amazon Fraud Detector permanently deletes +// the detector and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteDetectorVersion(ctx context.Context, params *DeleteDetectorVersionInput, optFns ...func(*Options)) (*DeleteDetectorVersionOutput, error) { if params == nil { params = &DeleteDetectorVersionInput{} diff --git a/service/frauddetector/api_op_DeleteEntityType.go b/service/frauddetector/api_op_DeleteEntityType.go index 9e3aa2b28ec..2bd48c3d36a 100644 --- a/service/frauddetector/api_op_DeleteEntityType.go +++ b/service/frauddetector/api_op_DeleteEntityType.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an entity type. You cannot delete an entity type that is included in an -// event type. When you delete an entity type, Amazon Fraud Detector permanently -// deletes that entity type and the data is no longer stored in Amazon Fraud -// Detector. +// Deletes an entity type. +// +// You cannot delete an entity type that is included in an event type. +// +// When you delete an entity type, Amazon Fraud Detector permanently deletes that +// entity type and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteEntityType(ctx context.Context, params *DeleteEntityTypeInput, optFns ...func(*Options)) (*DeleteEntityTypeOutput, error) { if params == nil { params = &DeleteEntityTypeInput{} diff --git a/service/frauddetector/api_op_DeleteEvent.go b/service/frauddetector/api_op_DeleteEvent.go index e1f0b839b6f..d9974b4900b 100644 --- a/service/frauddetector/api_op_DeleteEvent.go +++ b/service/frauddetector/api_op_DeleteEvent.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified event. When you delete an event, Amazon Fraud Detector -// permanently deletes that event and the event data is no longer stored in Amazon -// Fraud Detector. If deleteAuditHistory is True , event data is available through -// search for up to 30 seconds after the delete operation is completed. +// Deletes the specified event. +// +// When you delete an event, Amazon Fraud Detector permanently deletes that event +// and the event data is no longer stored in Amazon Fraud Detector. If +// deleteAuditHistory is True , event data is available through search for up to 30 +// seconds after the delete operation is completed. func (c *Client) DeleteEvent(ctx context.Context, params *DeleteEventInput, optFns ...func(*Options)) (*DeleteEventOutput, error) { if params == nil { params = &DeleteEventInput{} diff --git a/service/frauddetector/api_op_DeleteEventType.go b/service/frauddetector/api_op_DeleteEventType.go index 030c45d38a6..66943f4e4e6 100644 --- a/service/frauddetector/api_op_DeleteEventType.go +++ b/service/frauddetector/api_op_DeleteEventType.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an event type. You cannot delete an event type that is used in a -// detector or a model. When you delete an event type, Amazon Fraud Detector -// permanently deletes that event type and the data is no longer stored in Amazon -// Fraud Detector. +// Deletes an event type. +// +// You cannot delete an event type that is used in a detector or a model. +// +// When you delete an event type, Amazon Fraud Detector permanently deletes that +// event type and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteEventType(ctx context.Context, params *DeleteEventTypeInput, optFns ...func(*Options)) (*DeleteEventTypeOutput, error) { if params == nil { params = &DeleteEventTypeInput{} diff --git a/service/frauddetector/api_op_DeleteExternalModel.go b/service/frauddetector/api_op_DeleteExternalModel.go index 1b52a785cfc..1ac6fd47d83 100644 --- a/service/frauddetector/api_op_DeleteExternalModel.go +++ b/service/frauddetector/api_op_DeleteExternalModel.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon -// SageMaker model if it is not associated with a detector version. Removing a -// SageMaker model disconnects it from Amazon Fraud Detector, but the model remains -// available in SageMaker. +// Removes a SageMaker model from Amazon Fraud Detector. +// +// You can remove an Amazon SageMaker model if it is not associated with a +// detector version. Removing a SageMaker model disconnects it from Amazon Fraud +// Detector, but the model remains available in SageMaker. func (c *Client) DeleteExternalModel(ctx context.Context, params *DeleteExternalModelInput, optFns ...func(*Options)) (*DeleteExternalModelOutput, error) { if params == nil { params = &DeleteExternalModelInput{} diff --git a/service/frauddetector/api_op_DeleteLabel.go b/service/frauddetector/api_op_DeleteLabel.go index 907ae975bdf..aeb59239f42 100644 --- a/service/frauddetector/api_op_DeleteLabel.go +++ b/service/frauddetector/api_op_DeleteLabel.go @@ -10,11 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a label. You cannot delete labels that are included in an event type in -// Amazon Fraud Detector. You cannot delete a label assigned to an event ID. You -// must first delete the relevant event ID. When you delete a label, Amazon Fraud -// Detector permanently deletes that label and the data is no longer stored in -// Amazon Fraud Detector. +// Deletes a label. +// +// You cannot delete labels that are included in an event type in Amazon Fraud +// Detector. +// +// You cannot delete a label assigned to an event ID. You must first delete the +// relevant event ID. +// +// When you delete a label, Amazon Fraud Detector permanently deletes that label +// and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteLabel(ctx context.Context, params *DeleteLabelInput, optFns ...func(*Options)) (*DeleteLabelOutput, error) { if params == nil { params = &DeleteLabelInput{} diff --git a/service/frauddetector/api_op_DeleteList.go b/service/frauddetector/api_op_DeleteList.go index 31e57bc4272..7e757132ef4 100644 --- a/service/frauddetector/api_op_DeleteList.go +++ b/service/frauddetector/api_op_DeleteList.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the list, provided it is not used in a rule. When you delete a list, -// Amazon Fraud Detector permanently deletes that list and the elements in the -// list. +// Deletes the list, provided it is not used in a rule. +// +// When you delete a list, Amazon Fraud Detector permanently deletes that list and +// the elements in the list. func (c *Client) DeleteList(ctx context.Context, params *DeleteListInput, optFns ...func(*Options)) (*DeleteListOutput, error) { if params == nil { params = &DeleteListInput{} @@ -30,7 +31,7 @@ func (c *Client) DeleteList(ctx context.Context, params *DeleteListInput, optFns type DeleteListInput struct { - // The name of the list to delete. + // The name of the list to delete. // // This member is required. Name *string diff --git a/service/frauddetector/api_op_DeleteModel.go b/service/frauddetector/api_op_DeleteModel.go index 6c638e2e031..8e9afac8362 100644 --- a/service/frauddetector/api_op_DeleteModel.go +++ b/service/frauddetector/api_op_DeleteModel.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a model. You can delete models and model versions in Amazon Fraud -// Detector, provided that they are not associated with a detector version. When -// you delete a model, Amazon Fraud Detector permanently deletes that model and the -// data is no longer stored in Amazon Fraud Detector. +// Deletes a model. +// +// You can delete models and model versions in Amazon Fraud Detector, provided +// that they are not associated with a detector version. +// +// When you delete a model, Amazon Fraud Detector permanently deletes that model +// and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error) { if params == nil { params = &DeleteModelInput{} diff --git a/service/frauddetector/api_op_DeleteModelVersion.go b/service/frauddetector/api_op_DeleteModelVersion.go index f9027c4a3b5..163e76d0208 100644 --- a/service/frauddetector/api_op_DeleteModelVersion.go +++ b/service/frauddetector/api_op_DeleteModelVersion.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a model version. You can delete models and model versions in Amazon -// Fraud Detector, provided that they are not associated with a detector version. +// Deletes a model version. +// +// You can delete models and model versions in Amazon Fraud Detector, provided +// that they are not associated with a detector version. +// // When you delete a model version, Amazon Fraud Detector permanently deletes that // model version and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteModelVersion(ctx context.Context, params *DeleteModelVersionInput, optFns ...func(*Options)) (*DeleteModelVersionOutput, error) { diff --git a/service/frauddetector/api_op_DeleteOutcome.go b/service/frauddetector/api_op_DeleteOutcome.go index 53e9c13f025..9287b6a8917 100644 --- a/service/frauddetector/api_op_DeleteOutcome.go +++ b/service/frauddetector/api_op_DeleteOutcome.go @@ -10,9 +10,12 @@ 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_DeleteRule.go b/service/frauddetector/api_op_DeleteRule.go index 8891b15e0e9..265e9389571 100644 --- a/service/frauddetector/api_op_DeleteRule.go +++ b/service/frauddetector/api_op_DeleteRule.go @@ -12,9 +12,10 @@ import ( ) // Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or -// INACTIVE detector version. When you delete a rule, Amazon Fraud Detector -// permanently deletes that rule and the data is no longer stored in Amazon Fraud -// Detector. +// INACTIVE detector version. +// +// When you delete a rule, Amazon Fraud Detector permanently deletes that rule and +// the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} diff --git a/service/frauddetector/api_op_DeleteVariable.go b/service/frauddetector/api_op_DeleteVariable.go index 2cc18633aab..9de6091c078 100644 --- a/service/frauddetector/api_op_DeleteVariable.go +++ b/service/frauddetector/api_op_DeleteVariable.go @@ -10,12 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a variable. You can't delete variables that are included in an event -// type in Amazon Fraud Detector. Amazon Fraud Detector automatically deletes model -// output variables and SageMaker model output variables when you delete the model. -// You can't delete these variables manually. When you delete a variable, Amazon -// Fraud Detector permanently deletes that variable and the data is no longer -// stored in Amazon Fraud Detector. +// Deletes a variable. +// +// You can't delete variables that are included in an event type in Amazon Fraud +// Detector. +// +// Amazon Fraud Detector automatically deletes model output variables and +// SageMaker model output variables when you delete the model. You can't delete +// these variables manually. +// +// When you delete a variable, Amazon Fraud Detector permanently deletes that +// variable and the data is no longer stored in Amazon Fraud Detector. func (c *Client) DeleteVariable(ctx context.Context, params *DeleteVariableInput, optFns ...func(*Options)) (*DeleteVariableOutput, error) { if params == nil { params = &DeleteVariableInput{} diff --git a/service/frauddetector/api_op_GetDetectorVersion.go b/service/frauddetector/api_op_GetDetectorVersion.go index e76b4ef10cd..c7ca5eb2352 100644 --- a/service/frauddetector/api_op_GetDetectorVersion.go +++ b/service/frauddetector/api_op_GetDetectorVersion.go @@ -68,12 +68,15 @@ type GetDetectorVersionOutput struct { // The model versions included in the detector version. ModelVersions []types.ModelVersion - // 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. + // 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. RuleExecutionMode types.RuleExecutionMode // The rules included in the detector version. diff --git a/service/frauddetector/api_op_GetEventPrediction.go b/service/frauddetector/api_op_GetEventPrediction.go index 9a65bccc41f..2e52361ee34 100644 --- a/service/frauddetector/api_op_GetEventPrediction.go +++ b/service/frauddetector/api_op_GetEventPrediction.go @@ -60,18 +60,26 @@ type GetEventPredictionInput struct { // Names of the event type's variables you defined in Amazon Fraud Detector to // represent data elements and their corresponding values for the event you are - // sending for evaluation. You must provide at least one eventVariable To ensure - // most accurate fraud prediction and to simplify your data preparation, Amazon - // Fraud Detector will replace all missing variables or values as follows: For - // Amazon Fraud Detector trained models: If a null value is provided explicitly for - // a variable or if a variable is missing, model will replace the null value or the - // missing variable (no variable name in the eventVariables map) with calculated - // default mean/medians for numeric variables and with special values for - // categorical variables. For imported SageMaker models: If a null value is - // provided explicitly for a variable, the model and rules will use “null” as the - // value. If a variable is not provided (no variable name in the eventVariables - // map), model and rules will use the default value that is provided for the - // variable. + // sending for evaluation. + // + // You must provide at least one eventVariable + // + // To ensure most accurate fraud prediction and to simplify your data preparation, + // Amazon Fraud Detector will replace all missing variables or values as follows: + // + // For Amazon Fraud Detector trained models: + // + // If a null value is provided explicitly for a variable or if a variable is + // missing, model will replace the null value or the missing variable (no variable + // name in the eventVariables map) with calculated default mean/medians for numeric + // variables and with special values for categorical variables. + // + // For imported SageMaker models: + // + // If a null value is provided explicitly for a variable, the model and rules will + // use “null” as the value. If a variable is not provided (no variable name in the + // eventVariables map), model and rules will use the default value that is provided + // for the variable. // // This member is required. EventVariables map[string]string diff --git a/service/frauddetector/api_op_GetEventPredictionMetadata.go b/service/frauddetector/api_op_GetEventPredictionMetadata.go index 0c951c809cb..c6685059628 100644 --- a/service/frauddetector/api_op_GetEventPredictionMetadata.go +++ b/service/frauddetector/api_op_GetEventPredictionMetadata.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets details of the past fraud predictions for the specified event ID, event +// Gets details of the past fraud predictions for the specified event ID, event +// // type, detector ID, and detector version ID that was generated in the specified // time period. func (c *Client) GetEventPredictionMetadata(ctx context.Context, params *GetEventPredictionMetadataInput, optFns ...func(*Options)) (*GetEventPredictionMetadataOutput, error) { @@ -31,31 +32,33 @@ func (c *Client) GetEventPredictionMetadata(ctx context.Context, params *GetEven type GetEventPredictionMetadataInput struct { - // The detector ID. + // The detector ID. // // This member is required. DetectorId *string - // The detector version ID. + // The detector version ID. // // This member is required. DetectorVersionId *string - // The event ID. + // The event ID. // // This member is required. EventId *string - // The event type associated with the detector specified for the prediction. + // The event type associated with the detector specified for the prediction. // // 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) - // first, and using the predictionTimestamp value in the response to provide an - // accurate prediction timestamp value. + // The timestamp that defines when the prediction was generated. The timestamp + // must be specified using ISO 8601 standard in UTC. + // + // We recommend calling [ListEventPredictions] first, and using the predictionTimestamp value in the + // response to provide an accurate prediction timestamp value. + // + // [ListEventPredictions]: https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html // // This member is required. PredictionTimestamp *string @@ -65,50 +68,51 @@ type GetEventPredictionMetadataInput struct { type GetEventPredictionMetadataOutput struct { - // The detector ID. + // The detector ID. DetectorId *string - // The detector version ID. + // The detector version ID. DetectorVersionId *string - // The status of the detector version. + // The status of the detector version. DetectorVersionStatus *string - // The entity ID. + // The entity ID. EntityId *string - // The entity type. + // The entity type. EntityType *string - // External (Amazon SageMaker) models that were evaluated for generating + // External (Amazon SageMaker) models that were evaluated for generating // predictions. EvaluatedExternalModels []types.EvaluatedExternalModel - // Model versions that were evaluated for generating predictions. + // Model versions that were evaluated for generating predictions. EvaluatedModelVersions []types.EvaluatedModelVersion - // The event ID. + // The event ID. EventId *string - // The timestamp for when the prediction was generated for the associated event ID. + // The timestamp for when the prediction was generated for the associated event + // ID. EventTimestamp *string - // The event type associated with the detector specified for this prediction. + // The event type associated with the detector specified for this prediction. EventTypeName *string - // A list of event variables that influenced the prediction scores. + // A list of event variables that influenced the prediction scores. EventVariables []types.EventVariableSummary - // The outcomes of the matched rule, based on the rule execution mode. + // The outcomes of the matched rule, based on the rule execution mode. Outcomes []string // The timestamp that defines when the prediction was generated. PredictionTimestamp *string - // The execution mode of the rule used for evaluating variable values. + // 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 + // List of rules associated with the detector version that were used for // evaluating variable values. Rules []types.EvaluatedRule diff --git a/service/frauddetector/api_op_GetListElements.go b/service/frauddetector/api_op_GetListElements.go index 81dcc5bed59..66b27049a12 100644 --- a/service/frauddetector/api_op_GetListElements.go +++ b/service/frauddetector/api_op_GetListElements.go @@ -28,15 +28,15 @@ func (c *Client) GetListElements(ctx context.Context, params *GetListElementsInp type GetListElementsInput struct { - // The name of the list. + // The name of the list. // // This member is required. Name *string - // The maximum number of objects to return for the request. + // The maximum number of objects to return for the request. MaxResults *int32 - // The next token for the subsequent request. + // The next token for the subsequent request. NextToken *string noSmithyDocumentSerde @@ -44,10 +44,10 @@ type GetListElementsInput struct { type GetListElementsOutput struct { - // The list elements. + // The list elements. Elements []string - // The next page token. + // The next page token. NextToken *string // Metadata pertaining to the operation's result. @@ -145,7 +145,7 @@ var _ GetListElementsAPIClient = (*Client)(nil) // GetListElementsPaginatorOptions is the paginator options for GetListElements type GetListElementsPaginatorOptions struct { - // The maximum number of objects to return for the request. + // The maximum number of objects to return for the request. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/frauddetector/api_op_GetListsMetadata.go b/service/frauddetector/api_op_GetListsMetadata.go index 15862af408f..1b1a836c736 100644 --- a/service/frauddetector/api_op_GetListsMetadata.go +++ b/service/frauddetector/api_op_GetListsMetadata.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the metadata of either all the lists under the account or the specified +// Gets the metadata of either all the lists under the account or the specified +// // list. func (c *Client) GetListsMetadata(ctx context.Context, params *GetListsMetadataInput, optFns ...func(*Options)) (*GetListsMetadataOutput, error) { if params == nil { @@ -30,13 +31,13 @@ func (c *Client) GetListsMetadata(ctx context.Context, params *GetListsMetadataI type GetListsMetadataInput struct { - // The maximum number of objects to return for the request. + // The maximum number of objects to return for the request. MaxResults *int32 - // The name of the list. + // The name of the list. Name *string - // The next token for the subsequent request. + // The next token for the subsequent request. NextToken *string noSmithyDocumentSerde @@ -44,10 +45,10 @@ type GetListsMetadataInput struct { type GetListsMetadataOutput struct { - // The metadata of the specified list or all lists under the account. + // The metadata of the specified list or all lists under the account. Lists []types.AllowDenyList - // The next page token. + // The next page token. NextToken *string // Metadata pertaining to the operation's result. @@ -142,7 +143,7 @@ var _ GetListsMetadataAPIClient = (*Client)(nil) // GetListsMetadataPaginatorOptions is the paginator options for GetListsMetadata type GetListsMetadataPaginatorOptions struct { - // The maximum number of objects to return for the request. + // The maximum number of objects to return for the request. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/frauddetector/api_op_GetModelVersion.go b/service/frauddetector/api_op_GetModelVersion.go index db518e7c07c..1129156dc2a 100644 --- a/service/frauddetector/api_op_GetModelVersion.go +++ b/service/frauddetector/api_op_GetModelVersion.go @@ -69,15 +69,26 @@ type GetModelVersionOutput struct { // The model version number. ModelVersionNumber *string - // The model version status. Possible values are: + // 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 Status *string diff --git a/service/frauddetector/api_op_GetModels.go b/service/frauddetector/api_op_GetModels.go index 884bf1cc6e8..95a2a32f7c7 100644 --- a/service/frauddetector/api_op_GetModels.go +++ b/service/frauddetector/api_op_GetModels.go @@ -15,9 +15,11 @@ 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 , -// the value must be between 1 and 10. To get the next page results, provide the +// 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. func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns ...func(*Options)) (*GetModelsOutput, error) { diff --git a/service/frauddetector/api_op_GetRules.go b/service/frauddetector/api_op_GetRules.go index 8b160d805fa..f247935882a 100644 --- a/service/frauddetector/api_op_GetRules.go +++ b/service/frauddetector/api_op_GetRules.go @@ -14,11 +14,13 @@ import ( // Get all rules for a detector (paginated) if ruleId and ruleVersion are not // specified. Gets all rules for the detector and the ruleId if present // (paginated). Gets a specific rule if both the ruleId and the ruleVersion are -// specified. This is a paginated API. Providing null maxResults results in -// retrieving maximum of 100 records per page. If you provide maxResults the value -// must be between 50 and 100. To get the next page result, a provide a pagination -// token from GetRulesResult as part of your request. Null pagination token fetches -// the records from the beginning. +// specified. +// +// This is a paginated API. Providing null maxResults results in retrieving +// maximum of 100 records per page. If you provide maxResults the value must be +// between 50 and 100. To get the next page result, a provide a pagination token +// from GetRulesResult as part of your request. Null pagination token fetches the +// records from the beginning. func (c *Client) GetRules(ctx context.Context, params *GetRulesInput, optFns ...func(*Options)) (*GetRulesOutput, error) { if params == nil { params = &GetRulesInput{} diff --git a/service/frauddetector/api_op_ListEventPredictions.go b/service/frauddetector/api_op_ListEventPredictions.go index 4b193d57626..592dce4b111 100644 --- a/service/frauddetector/api_op_ListEventPredictions.go +++ b/service/frauddetector/api_op_ListEventPredictions.go @@ -13,13 +13,16 @@ import ( // Gets a list of past predictions. The list can be filtered by detector ID, // 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. +// 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. func (c *Client) ListEventPredictions(ctx context.Context, params *ListEventPredictionsInput, optFns ...func(*Options)) (*ListEventPredictionsOutput, error) { if params == nil { params = &ListEventPredictionsInput{} @@ -37,27 +40,27 @@ func (c *Client) ListEventPredictions(ctx context.Context, params *ListEventPred type ListEventPredictionsInput struct { - // The detector ID. + // The detector ID. DetectorId *types.FilterCondition - // The detector version ID. + // The detector version ID. DetectorVersionId *types.FilterCondition - // The event ID. + // The event ID. EventId *types.FilterCondition - // The event type associated with the detector. + // The event type associated with the detector. EventType *types.FilterCondition - // The maximum number of predictions to return for the request. + // The maximum number of predictions to return for the request. MaxResults *int32 - // Identifies the next page of results to return. Use the token to make the call + // Identifies the next page of results to return. Use the token to make the call // again to retrieve the next page. Keep all other arguments unchanged. Each // pagination token expires after 24 hours. NextToken *string - // The time period for when the predictions were generated. + // The time period for when the predictions were generated. PredictionTimeRange *types.PredictionTimeRange noSmithyDocumentSerde @@ -65,10 +68,10 @@ type ListEventPredictionsInput struct { type ListEventPredictionsOutput struct { - // The summary of the past predictions. + // The summary of the past predictions. EventPredictionSummaries []types.EventPredictionSummary - // Identifies the next page of results to return. Use the token to make the call + // Identifies the next page of results to return. Use the token to make the call // again to retrieve the next page. Keep all other arguments unchanged. Each // pagination token expires after 24 hours. NextToken *string @@ -169,7 +172,7 @@ var _ ListEventPredictionsAPIClient = (*Client)(nil) // ListEventPredictionsPaginatorOptions is the paginator options for // ListEventPredictions type ListEventPredictionsPaginatorOptions struct { - // The maximum number of predictions to return for the request. + // The maximum number of predictions to return for the request. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/frauddetector/api_op_PutKMSEncryptionKey.go b/service/frauddetector/api_op_PutKMSEncryptionKey.go index a1f92f1b32c..93ddd60e444 100644 --- a/service/frauddetector/api_op_PutKMSEncryptionKey.go +++ b/service/frauddetector/api_op_PutKMSEncryptionKey.go @@ -28,8 +28,10 @@ func (c *Client) PutKMSEncryptionKey(ctx context.Context, params *PutKMSEncrypti type PutKMSEncryptionKeyInput struct { - // The KMS encryption key ARN. The KMS key must be single-Region key. Amazon Fraud - // Detector does not support multi-Region KMS key. + // The KMS encryption key ARN. + // + // The KMS key must be single-Region key. Amazon Fraud Detector does not support + // multi-Region KMS key. // // This member is required. KmsEncryptionKeyArn *string diff --git a/service/frauddetector/api_op_UpdateDetectorVersion.go b/service/frauddetector/api_op_UpdateDetectorVersion.go index 691cb0ed3de..e1dbe167168 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersion.go +++ b/service/frauddetector/api_op_UpdateDetectorVersion.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a detector version. The detector version attributes that you can update -// include models, external model endpoints, rules, rule execution mode, and +// Updates a detector version. The detector version attributes that you can +// +// update include models, external model endpoints, rules, rule execution mode, and // description. You can only update a DRAFT detector version. func (c *Client) UpdateDetectorVersion(ctx context.Context, params *UpdateDetectorVersionInput, optFns ...func(*Options)) (*UpdateDetectorVersionOutput, error) { if params == nil { @@ -57,12 +58,16 @@ 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 , - // 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. You can define and - // edit the rule mode at the detector version level, when it is in draft status. + // 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 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 . RuleExecutionMode types.RuleExecutionMode diff --git a/service/frauddetector/api_op_UpdateDetectorVersionStatus.go b/service/frauddetector/api_op_UpdateDetectorVersionStatus.go index bcf16a4c7bb..3316fa400e4 100644 --- a/service/frauddetector/api_op_UpdateDetectorVersionStatus.go +++ b/service/frauddetector/api_op_UpdateDetectorVersionStatus.go @@ -41,7 +41,9 @@ type UpdateDetectorVersionStatusInput struct { // This member is required. DetectorVersionId *string - // The new status. The only supported values are ACTIVE and INACTIVE + // The new status. + // + // The only supported values are ACTIVE and INACTIVE // // This member is required. Status types.DetectorVersionStatus diff --git a/service/frauddetector/api_op_UpdateList.go b/service/frauddetector/api_op_UpdateList.go index 734219ab152..b35ee5fe1fa 100644 --- a/service/frauddetector/api_op_UpdateList.go +++ b/service/frauddetector/api_op_UpdateList.go @@ -29,29 +29,35 @@ func (c *Client) UpdateList(ctx context.Context, params *UpdateListInput, optFns type UpdateListInput struct { - // The name of the list to update. + // The name of the list to update. // // This member is required. Name *string - // The new description. + // The new description. Description *string - // One or more list elements to add or replace. If you are providing the elements, - // make sure to specify the updateMode to use. If you are deleting all elements - // from the list, use REPLACE for the updateMode and provide an empty list (0 - // elements). + // One or more list elements to add or replace. If you are providing the + // elements, make sure to specify the updateMode to use. + // + // If you are deleting all elements from the list, use REPLACE for the updateMode + // and provide an empty list (0 elements). Elements []string - // The update mode (type). + // 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. UpdateMode types.ListUpdateMode - // The variable type you want to assign to the list. You cannot update a variable - // type of a list that already has a variable type assigned to it. You can assign a - // variable type to a list only if the list does not already have a variable type. + // The variable type you want to assign to the list. + // + // You cannot update a variable type of a list that already has a variable type + // assigned to it. You can assign a variable type to a list only if the list does + // not already have a variable type. VariableType *string noSmithyDocumentSerde diff --git a/service/frauddetector/api_op_UpdateModelVersionStatus.go b/service/frauddetector/api_op_UpdateModelVersionStatus.go index 7039619e6b8..4061519ae4c 100644 --- a/service/frauddetector/api_op_UpdateModelVersionStatus.go +++ b/service/frauddetector/api_op_UpdateModelVersionStatus.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the status of a model version. You can perform the following status -// updates: +// 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 . func (c *Client) UpdateModelVersionStatus(ctx context.Context, params *UpdateModelVersionStatusInput, optFns ...func(*Options)) (*UpdateModelVersionStatusOutput, error) { if params == nil { diff --git a/service/frauddetector/api_op_UpdateVariable.go b/service/frauddetector/api_op_UpdateVariable.go index ecc13a744cf..e3fb6b5bb7f 100644 --- a/service/frauddetector/api_op_UpdateVariable.go +++ b/service/frauddetector/api_op_UpdateVariable.go @@ -39,8 +39,9 @@ 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]. + // + // [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 1b59a88a4ab..dbded5829a3 100644 --- a/service/frauddetector/doc.go +++ b/service/frauddetector/doc.go @@ -6,17 +6,21 @@ // 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, go to Tools to build on AWS (https://aws.amazon.com/developer/tools/) -// page, scroll down to the SDK section, and choose plus (+) sign to expand the -// section. +// see the [Amazon Fraud Detector User Guide]. +// +// 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, go to [Tools to build on AWS]page, +// scroll down to the SDK section, and choose plus (+) sign to expand the section. +// +// [Amazon Fraud Detector User Guide]: https://docs.aws.amazon.com/frauddetector/latest/ug/ +// [Tools to build on AWS]: https://aws.amazon.com/developer/tools/ package frauddetector diff --git a/service/frauddetector/options.go b/service/frauddetector/options.go index 1d2051b056b..aecc3a87236 100644 --- a/service/frauddetector/options.go +++ b/service/frauddetector/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/frauddetector/types/enums.go b/service/frauddetector/types/enums.go index d6221bc8b96..6ed5a58ed37 100644 --- a/service/frauddetector/types/enums.go +++ b/service/frauddetector/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AsyncJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AsyncJobStatus) Values() []AsyncJobStatus { return []AsyncJobStatus{ "IN_PROGRESS_INITIALIZING", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for DataSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSource) Values() []DataSource { return []DataSource{ "EVENT", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for DataType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataType) Values() []DataType { return []DataType{ "STRING", @@ -82,8 +85,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DRAFT", @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for EventIngestion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventIngestion) Values() []EventIngestion { return []EventIngestion{ "ENABLED", @@ -118,8 +123,9 @@ const ( ) // Values returns all known values for Language. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Language) Values() []Language { return []Language{ "DETECTORPL", @@ -136,8 +142,9 @@ const ( ) // Values returns all known values for ListUpdateMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListUpdateMode) Values() []ListUpdateMode { return []ListUpdateMode{ "REPLACE", @@ -155,8 +162,9 @@ const ( ) // Values returns all known values for ModelEndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelEndpointStatus) Values() []ModelEndpointStatus { return []ModelEndpointStatus{ "ASSOCIATED", @@ -173,8 +181,9 @@ const ( ) // Values returns all known values for ModelInputDataFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelInputDataFormat) Values() []ModelInputDataFormat { return []ModelInputDataFormat{ "TEXT_CSV", @@ -191,8 +200,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TEXT_CSV", @@ -208,8 +218,9 @@ const ( ) // Values returns all known values for ModelSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelSource) Values() []ModelSource { return []ModelSource{ "SAGEMAKER", @@ -226,8 +237,9 @@ const ( ) // Values returns all known values for ModelTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelTypeEnum) Values() []ModelTypeEnum { return []ModelTypeEnum{ "ONLINE_FRAUD_INSIGHTS", @@ -246,8 +258,9 @@ const ( ) // Values returns all known values for ModelVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelVersionStatus) Values() []ModelVersionStatus { return []ModelVersionStatus{ "ACTIVE", @@ -265,8 +278,9 @@ const ( ) // Values returns all known values for RuleExecutionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleExecutionMode) Values() []RuleExecutionMode { return []RuleExecutionMode{ "ALL_MATCHED", @@ -283,8 +297,9 @@ const ( ) // Values returns all known values for TrainingDataSourceEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingDataSourceEnum) Values() []TrainingDataSourceEnum { return []TrainingDataSourceEnum{ "EXTERNAL_EVENTS", @@ -304,6 +319,7 @@ const ( // 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{ diff --git a/service/frauddetector/types/types.go b/service/frauddetector/types/types.go index d9114da3b28..d1322c598ca 100644 --- a/service/frauddetector/types/types.go +++ b/service/frauddetector/types/types.go @@ -6,21 +6,22 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// The log odds metric details. Account Takeover Insights (ATI) model uses event -// variables from the login data you 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 . +// The log odds metric details. +// +// Account Takeover Insights (ATI) model uses event variables from the login data +// you 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 . type AggregatedLogOddsMetric struct { - // The relative importance of the variables in the list to the other event + // The relative importance of the variables in the list to the other event // variable. // // This member is required. AggregatedVariablesImportance *float32 - // The names of all the variables. + // The names of all the variables. // // This member is required. VariableNames []string @@ -28,7 +29,8 @@ type AggregatedLogOddsMetric struct { noSmithyDocumentSerde } -// The details of the impact of aggregated variables on the prediction score. +// The details of the impact of aggregated variables on the prediction score. +// // Account Takeover Insights (ATI) model uses the login data you provide to // continuously calculate a set of variables (aggregated variables) based on // historical events. For example, the model might calculate the number of times an @@ -36,32 +38,35 @@ type AggregatedLogOddsMetric struct { // 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 + // The names of all the event variables that were used to derive the aggregated // variables. EventVariableNames []string - // 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. + // 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. LogOddsImpact *float32 - // The relative impact of the aggregated variables in terms of magnitude on the + // The relative impact of the aggregated variables in terms of magnitude on the // prediction scores. RelativeImpact *string noSmithyDocumentSerde } -// The details of the relative importance of the aggregated variables. Account -// Takeover Insights (ATI) model uses event variables from the login data you -// provide to continuously calculate a set of variables (aggregated variables) +// The details of the relative importance of the aggregated variables. +// +// Account Takeover Insights (ATI) model uses event variables from the login data +// you 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 . type AggregatedVariablesImportanceMetrics struct { - // List of variables' metrics. + // List of variables' metrics. LogOddsMetrics []AggregatedLogOddsMetric noSmithyDocumentSerde @@ -70,24 +75,24 @@ type AggregatedVariablesImportanceMetrics struct { // The metadata of a list. type AllowDenyList struct { - // The name of the list. + // The name of the list. // // This member is required. Name *string - // The ARN of the list. + // The ARN of the list. Arn *string - // The time the list was created. + // The time the list was created. CreatedTime *string - // The description of the list. + // The description of the list. Description *string - // The time the list was last updated. + // The time the list was last updated. UpdatedTime *string - // The variable type of the list. + // The variable type of the list. VariableType *string noSmithyDocumentSerde @@ -96,25 +101,25 @@ type AllowDenyList struct { // The Account Takeover Insights (ATI) model performance metrics data points. type ATIMetricDataPoint struct { - // The anomaly discovery rate. This metric quantifies the percentage of anomalies + // The anomaly discovery rate. This metric quantifies the percentage of anomalies // that can be detected by the model at the selected score threshold. A lower score // threshold increases the percentage of anomalies captured by the model, but would // also require challenging a larger percentage of login events, leading to a // higher customer friction. Adr *float32 - // The account takeover discovery rate. This metric quantifies the percentage of + // The account takeover discovery rate. This metric quantifies the percentage of // account compromise events that can be detected by the model at the selected // score threshold. This metric is only available if 50 or more entities with // 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 + // 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 + // The model's threshold that specifies an acceptable fraud capture rate. For // example, a threshold of 500 means any model score 500 or above is labeled as // fraud. Threshold *float32 @@ -125,7 +130,7 @@ type ATIMetricDataPoint struct { // The Account Takeover Insights (ATI) model performance score. type ATIModelPerformance struct { - // The anomaly separation index (ASI) score. This metric summarizes the overall + // The anomaly separation index (ASI) score. This metric summarizes the overall // ability of the model to separate anomalous activities from the normal behavior. // Depending on the business, a large fraction of these anomalous activities can be // malicious and correspond to the account takeover attacks. A model with no @@ -140,10 +145,10 @@ type ATIModelPerformance struct { // The Account Takeover Insights (ATI) model training metric details. type ATITrainingMetricsValue struct { - // The model's performance metrics data points. + // The model's performance metrics data points. MetricDataPoints []ATIMetricDataPoint - // The model's overall performance scores. + // The model's overall performance scores. ModelPerformance *ATIModelPerformance noSmithyDocumentSerde @@ -368,20 +373,21 @@ type EntityType struct { noSmithyDocumentSerde } -// The details of the external (Amazon Sagemaker) model evaluated for generating +// The details of the external (Amazon Sagemaker) model evaluated for generating +// // predictions. type EvaluatedExternalModel struct { - // Input variables use for generating predictions. + // Input variables use for generating predictions. InputVariables map[string]string - // The endpoint of the external (Amazon Sagemaker) model. + // The endpoint of the external (Amazon Sagemaker) model. ModelEndpoint *string - // Output variables. + // Output variables. OutputVariables map[string]string - // Indicates whether event variables were used to generate predictions. + // Indicates whether event variables were used to generate predictions. UseEventVariables *bool noSmithyDocumentSerde @@ -390,16 +396,18 @@ type EvaluatedExternalModel struct { // The model version evaluated for generating prediction. type EvaluatedModelVersion struct { - // Evaluations generated for the model version. + // Evaluations generated for the model version. Evaluations []ModelVersionEvaluation - // The model ID. + // The model ID. ModelId *string - // The model type. Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS + // The model type. + // + // Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS ModelType *string - // The model version. + // The model version. ModelVersion *string noSmithyDocumentSerde @@ -408,25 +416,25 @@ type EvaluatedModelVersion struct { // The details of the rule used for evaluating variable values. type EvaluatedRule struct { - // Indicates whether the rule was evaluated. + // Indicates whether the rule was evaluated. Evaluated *bool - // The rule expression. + // The rule expression. Expression *string - // The rule expression value. + // The rule expression value. ExpressionWithValues *string - // Indicates whether the rule matched. + // Indicates whether the rule matched. Matched *bool - // The rule outcome. + // The rule outcome. Outcomes []string - // The rule ID. + // The rule ID. RuleId *string - // The rule version. + // The rule version. RuleVersion *string noSmithyDocumentSerde @@ -477,22 +485,22 @@ type EventOrchestration struct { // Information about the summary of an event prediction. type EventPredictionSummary struct { - // The detector ID. + // The detector ID. DetectorId *string - // The detector version ID. + // The detector version ID. DetectorVersionId *string - // The event ID. + // The event ID. EventId *string - // The timestamp of the event. + // The timestamp of the event. EventTimestamp *string - // The event type. + // The event type. EventTypeName *string - // The timestamp when the prediction was generated. + // The timestamp when the prediction was generated. PredictionTimestamp *string noSmithyDocumentSerde @@ -540,17 +548,18 @@ type EventType struct { noSmithyDocumentSerde } -// Information about the summary of an event variable that was evaluated for +// Information about the summary of an event variable that was evaluated for +// // generating prediction. type EventVariableSummary struct { - // The event variable name. + // The event variable name. Name *string - // The event variable source. + // The event variable source. Source *string - // The value of the event variable. + // The value of the event variable. Value *string noSmithyDocumentSerde @@ -669,7 +678,7 @@ type FileValidationMessage struct { // A conditional statement for filtering a list of past predictions. type FilterCondition struct { - // A statement containing a resource property and a value to specify filter + // A statement containing a resource property and a value to specify filter // condition. Value *string @@ -767,15 +776,20 @@ type LabelSchema struct { 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 if 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 @@ -785,9 +799,9 @@ type LabelSchema struct { // The log odds metric details. 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) - // . + // The relative importance of the variable. For more information, see [Model variable importance]. + // + // [Model variable importance]: https://docs.aws.amazon.com/frauddetector/latest/ug/model-variable-importance.html // // This member is required. VariableImportance *float32 @@ -877,7 +891,7 @@ type ModelInputConfiguration struct { // This member is required. UseEventVariables *bool - // Template for constructing the CSV input-data sent to SageMaker. At + // Template for constructing the CSV input-data sent to SageMaker. At // event-evaluation, the placeholders for variable-names in the template will be // replaced with the variable values before being sent to SageMaker. CsvInputTemplate *string @@ -885,11 +899,11 @@ type ModelInputConfiguration struct { // The event type name. EventTypeName *string - // The format of the model input configuration. The format differs depending on if - // it is passed through to SageMaker or constructed by Amazon Fraud Detector. + // The format of the model input configuration. The format differs depending on + // if it is passed through to SageMaker or constructed by Amazon Fraud Detector. Format ModelInputDataFormat - // Template for constructing the JSON input-data sent to SageMaker. At + // Template for constructing the JSON input-data sent to SageMaker. At // event-evaluation, the placeholders for variable names in the template will be // replaced with the variable values before being sent to SageMaker. JsonInputTemplate *string @@ -993,8 +1007,8 @@ type ModelVersionDetail struct { // The training results. TrainingResult *TrainingResult - // The training result details. The details include the relative importance of the - // variables. + // The training result details. The details include the relative importance of + // the variables. TrainingResultV2 *TrainingResultV2 noSmithyDocumentSerde @@ -1003,13 +1017,13 @@ type ModelVersionDetail struct { // The model version evalutions. type ModelVersionEvaluation struct { - // The evaluation score generated for the model version. + // The evaluation score generated for the model version. EvaluationScore *string - // The output variable name. + // The output variable name. OutputVariableName *string - // The prediction explanations generated for the model version. + // The prediction explanations generated for the model version. PredictionExplanations *PredictionExplanations noSmithyDocumentSerde @@ -1018,20 +1032,20 @@ type ModelVersionEvaluation struct { // The Online Fraud Insights (OFI) model performance metrics data points. type OFIMetricDataPoint struct { - // The false positive rate. This is the percentage of total legitimate events that - // are incorrectly predicted as fraud. + // The false positive rate. This is the percentage of total legitimate events + // that are incorrectly predicted as fraud. Fpr *float32 - // The percentage of fraud events correctly predicted as fraudulent as compared to - // all events predicted as fraudulent. + // The percentage of fraud events correctly predicted as fraudulent as compared + // to all events predicted as fraudulent. Precision *float32 - // The model threshold that specifies an acceptable fraud capture rate. For + // The model threshold that specifies an acceptable fraud capture rate. For // example, a threshold of 500 means any model score 500 or above is labeled as // fraud. Threshold *float32 - // The true positive rate. This is the percentage of total fraud the model + // The true positive rate. This is the percentage of total fraud the model // detects. Also known as capture rate. Tpr *float32 @@ -1041,11 +1055,11 @@ type OFIMetricDataPoint struct { // The Online Fraud Insights (OFI) model performance score. type OFIModelPerformance struct { - // The area under the curve (auc). This summarizes the total positive rate (tpr) + // The area under the curve (auc). This summarizes the total positive rate (tpr) // and false positive rate (FPR) across all possible model score thresholds. Auc *float32 - // Indicates the range of area under curve (auc) expected from the OFI model. A + // Indicates the range of area under curve (auc) expected from the OFI model. A // range greater than 0.1 indicates higher model uncertainity. UncertaintyRange *UncertaintyRange @@ -1055,10 +1069,10 @@ type OFIModelPerformance struct { // The Online Fraud Insights (OFI) model training metric details. type OFITrainingMetricsValue struct { - // The model's performance metrics data points. + // The model's performance metrics data points. MetricDataPoints []OFIMetricDataPoint - // The model's overall performance score. + // The model's overall performance score. ModelPerformance *OFIModelPerformance noSmithyDocumentSerde @@ -1085,19 +1099,21 @@ type Outcome struct { noSmithyDocumentSerde } -// The prediction explanations that provide insight into how each event variable +// The prediction explanations that provide insight into how each event variable +// // impacted the model version's fraud prediction score. type PredictionExplanations struct { - // The details of the aggregated variables impact on the prediction score. Account - // Takeover Insights (ATI) model uses event variables from the login data you - // provide to continuously calculate a set of variables (aggregated variables) + // The details of the aggregated variables impact on the prediction score. + // + // Account Takeover Insights (ATI) model uses event variables from the login data + // you 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 . AggregatedVariablesImpactExplanations []AggregatedVariablesImpactExplanation - // The details of the event variable's impact on the prediction score. + // The details of the event variable's impact on the prediction score. VariableImpactExplanations []VariableImpactExplanation noSmithyDocumentSerde @@ -1106,12 +1122,12 @@ type PredictionExplanations struct { // The time period for when the predictions were generated. type PredictionTimeRange struct { - // The end time of the time period for when the predictions were generated. + // The end time of the time period for when the predictions were generated. // // This member is required. EndTime *string - // The start time of the time period for when the predictions were generated. + // The start time of the time period for when the predictions were generated. // // This member is required. StartTime *string @@ -1204,23 +1220,25 @@ type Tag struct { noSmithyDocumentSerde } -// The performance metrics data points for Transaction Fraud Insights (TFI) model. +// The performance metrics data points for Transaction Fraud Insights (TFI) +// +// model. type TFIMetricDataPoint struct { - // The false positive rate. This is the percentage of total legitimate events that - // are incorrectly predicted as fraud. + // The false positive rate. This is the percentage of total legitimate events + // that are incorrectly predicted as fraud. Fpr *float32 - // The percentage of fraud events correctly predicted as fraudulent as compared to - // all events predicted as fraudulent. + // The percentage of fraud events correctly predicted as fraudulent as compared + // to all events predicted as fraudulent. Precision *float32 - // The model threshold that specifies an acceptable fraud capture rate. For + // The model threshold that specifies an acceptable fraud capture rate. For // example, a threshold of 500 means any model score 500 or above is labeled as // fraud. Threshold *float32 - // The true positive rate. This is the percentage of total fraud the model + // The true positive rate. This is the percentage of total fraud the model // detects. Also known as capture rate. Tpr *float32 @@ -1230,11 +1248,11 @@ type TFIMetricDataPoint struct { // The Transaction Fraud Insights (TFI) model performance score. type TFIModelPerformance struct { - // The area under the curve (auc). This summarizes the total positive rate (tpr) + // The area under the curve (auc). This summarizes the total positive rate (tpr) // and false positive rate (FPR) across all possible model score thresholds. Auc *float32 - // Indicates the range of area under curve (auc) expected from the TFI model. A + // Indicates the range of area under curve (auc) expected from the TFI model. A // range greater than 0.1 indicates higher model uncertainity. UncertaintyRange *UncertaintyRange @@ -1244,10 +1262,10 @@ type TFIModelPerformance struct { // The Transaction Fraud Insights (TFI) model training metric details. type TFITrainingMetricsValue struct { - // The model's performance metrics data points. + // The model's performance metrics data points. MetricDataPoints []TFIMetricDataPoint - // The model performance score. + // The model performance score. ModelPerformance *TFIModelPerformance noSmithyDocumentSerde @@ -1284,13 +1302,13 @@ type TrainingMetrics struct { // The training metrics details. type TrainingMetricsV2 struct { - // The Account Takeover Insights (ATI) model training metric details. + // The Account Takeover Insights (ATI) model training metric details. Ati *ATITrainingMetricsValue - // The Online Fraud Insights (OFI) model training metric details. + // The Online Fraud Insights (OFI) model training metric details. Ofi *OFITrainingMetricsValue - // The Transaction Fraud Insights (TFI) model training metric details. + // The Transaction Fraud Insights (TFI) model training metric details. Tfi *TFITrainingMetricsValue noSmithyDocumentSerde @@ -1314,18 +1332,19 @@ type TrainingResult struct { // The training result details. type TrainingResultV2 struct { - // The variable importance metrics of the aggregated variables. Account Takeover - // Insights (ATI) model uses event variables from the login data you 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 . + // The variable importance metrics of the aggregated variables. + // + // Account Takeover Insights (ATI) model uses event variables from the login data + // you 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 . AggregatedVariablesImportanceMetrics *AggregatedVariablesImportanceMetrics // The model training data validation metrics. DataValidationMetrics *DataValidationMetrics - // The training metric details. + // The training metric details. TrainingMetricsV2 *TrainingMetricsV2 // The variable importance metrics details. @@ -1334,17 +1353,18 @@ type TrainingResultV2 struct { noSmithyDocumentSerde } -// Range of area under curve (auc) expected from the model. A range greater than +// Range of area under curve (auc) expected from the model. A range greater than +// // 0.1 indicates higher model uncertainity. A range is the difference between upper // and lower bound of auc. type UncertaintyRange struct { - // The lower bound value of the area under curve (auc). + // The lower bound value of the area under curve (auc). // // This member is required. LowerBoundValue *float32 - // The upper bound value of the area under curve (auc). + // The upper bound value of the area under curve (auc). // // This member is required. UpperBoundValue *float32 @@ -1364,8 +1384,9 @@ 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]. + // + // [Variable types]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types DataType DataType // The default value of the variable. @@ -1380,14 +1401,15 @@ type Variable struct { // The name of the variable. Name *string - // The variable type of the variable. 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 | PAYMENT_TYPE | PHONE_NUMBER | - // PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | - // SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | - // SHIPPING_STATE | SHIPPING_ZIP | USERAGENT + // The variable type of the variable. + // + // 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 | + // PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | + // SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | + // SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT VariableType *string noSmithyDocumentSerde @@ -1411,14 +1433,17 @@ 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]. + // + // 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 | // PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | // SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | // SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT + // + // [Variable types]: https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types VariableType *string noSmithyDocumentSerde @@ -1427,16 +1452,18 @@ type VariableEntry struct { // The details of the event variable's impact on the prediction score. type VariableImpactExplanation struct { - // The event variable name. + // The event variable name. EventVariableName *string - // 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. + // 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. LogOddsImpact *float32 - // The event variable's relative impact in terms of magnitude on the prediction + // The event variable's relative impact in terms of magnitude on the prediction // scores. The relative impact values consist of a numerical rating (0-5, 5 being // the highest) and direction (increased/decreased) impact of the fraud risk. RelativeImpact *string diff --git a/service/freetier/doc.go b/service/freetier/doc.go index dad1472ce78..74912f06197 100644 --- a/service/freetier/doc.go +++ b/service/freetier/doc.go @@ -4,12 +4,19 @@ // AWS Free Tier. // // You can use the Amazon Web Services Free Tier API to query programmatically -// your Free Tier usage data. Free Tier tracks your monthly usage data for all free -// tier offers that are associated with your Amazon Web Services account. You can -// use the Free Tier API to filter and show only the data that you want. Service -// endpoint The Free Tier API provides the following endpoint: +// your Free Tier usage data. +// +// Free Tier tracks your monthly usage data for all free tier offers that are +// associated with your Amazon Web Services account. You can use the Free Tier API +// to filter and show only the data that you want. +// +// # Service endpoint +// +// The Free Tier API provides the following endpoint: +// // - https://freetier.us-east-1.api.aws // -// For more information, see Using the Amazon Web Services Free Tier (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-free-tier.html) -// in the Billing User Guide. +// For more information, see [Using the Amazon Web Services Free Tier] in the Billing User Guide. +// +// [Using the Amazon Web Services Free Tier]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-free-tier.html package freetier diff --git a/service/freetier/options.go b/service/freetier/options.go index 432e3f85ff0..0febdfd71ed 100644 --- a/service/freetier/options.go +++ b/service/freetier/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/freetier/types/enums.go b/service/freetier/types/enums.go index d4045bf38b6..ac9ee5f8187 100644 --- a/service/freetier/types/enums.go +++ b/service/freetier/types/enums.go @@ -16,8 +16,9 @@ const ( ) // 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. +// in the future, and so 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{ "SERVICE", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for MatchOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchOption) Values() []MatchOption { return []MatchOption{ "EQUALS", diff --git a/service/freetier/types/types.go b/service/freetier/types/types.go index 160707593f3..4b20f08be98 100644 --- a/service/freetier/types/types.go +++ b/service/freetier/types/types.go @@ -29,28 +29,44 @@ type DimensionValues struct { noSmithyDocumentSerde } -// Use Expression to filter in the GetFreeTierUsage API operation. You can use the -// following patterns: +// Use Expression to filter in the GetFreeTierUsage API operation. +// +// You can use the following patterns: +// // - Simple dimension values ( Dimensions root operator) +// // - Complex expressions with logical operators ( AND , NOT , and OR root // operators). // // For simple dimension values, you can set the dimension name, values, and match -// type for the filters that you plan to use. Example for simple dimension values -// You can filter to match exactly for REGION==us-east-1 OR REGION==us-west-1 . The -// corresponding Expression appears like the following: { "Dimensions": { "Key": -// "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } } -// As shown in the previous example, lists of dimension values are combined with OR -// when you apply the filter. For complex expressions with logical operators, you -// can have nested expressions to use the logical operators and specify advanced -// filtering. Example for complex expressions with logical operators You can filter -// by ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS -// AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer) . The corresponding -// Expression appears like the following: { "And": [ {"Or": [ {"Dimensions": { +// type for the filters that you plan to use. +// +// # Example for simple dimension values +// +// You can filter to match exactly for REGION==us-east-1 OR REGION==us-west-1 . +// +// The corresponding Expression appears like the following: { "Dimensions": { // "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": -// ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": ["AWSLambda"], -// "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { "Key": -// "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] }}} ] } +// ["EQUALS"] } } +// +// As shown in the previous example, lists of dimension values are combined with OR +// when you apply the filter. +// +// For complex expressions with logical operators, you can have nested expressions +// to use the logical operators and specify advanced filtering. +// +// # Example for complex expressions with logical operators +// +// You can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE +// CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer) . +// +// The corresponding Expression appears like the following: { "And": [ {"Or": [ +// {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], +// "MatchOptions": ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": +// ["AWSLambda"], "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { +// "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] +// }}} ] } +// // In the following Contents, you must specify exactly one of the following root // operators. type Expression struct { diff --git a/service/fsx/api_op_AssociateFileSystemAliases.go b/service/fsx/api_op_AssociateFileSystemAliases.go index 77b3baae55d..f8e97e31fff 100644 --- a/service/fsx/api_op_AssociateFileSystemAliases.go +++ b/service/fsx/api_op_AssociateFileSystemAliases.go @@ -15,13 +15,16 @@ import ( // an existing Amazon FSx for Windows File Server file system. A file system can // 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 -// 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. +// takes no action on that alias in the request. For more information, see [Working with DNS Aliases]and [Walkthrough 5: Using DNS aliases to access your file system], +// 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. +// +// [Walkthrough 5: Using DNS aliases to access your file system]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html +// [Working with DNS Aliases]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html func (c *Client) AssociateFileSystemAliases(ctx context.Context, params *AssociateFileSystemAliasesInput, optFns ...func(*Options)) (*AssociateFileSystemAliasesOutput, error) { if params == nil { params = &AssociateFileSystemAliasesInput{} @@ -43,11 +46,16 @@ 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. diff --git a/service/fsx/api_op_CancelDataRepositoryTask.go b/service/fsx/api_op_CancelDataRepositoryTask.go index 94eca691b94..839f8b3ec9a 100644 --- a/service/fsx/api_op_CancelDataRepositoryTask.go +++ b/service/fsx/api_op_CancelDataRepositoryTask.go @@ -14,9 +14,12 @@ 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 am export 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. // // For a release task, Amazon FSx will stop releasing files upon cancellation. Any @@ -50,13 +53,19 @@ 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. + // may be files the task failed to process. The DataRepositoryTaskFailureDetailsproperty 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 diff --git a/service/fsx/api_op_CopyBackup.go b/service/fsx/api_op_CopyBackup.go index 476d5f336ec..1bef8fb9a96 100644 --- a/service/fsx/api_op_CopyBackup.go +++ b/service/fsx/api_op_CopyBackup.go @@ -14,25 +14,32 @@ import ( // 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. +// 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] in the Amazon FSx for +// Windows User Guide, [Copying backups]in the Amazon FSx for Lustre User Guide, and [Copying backups] in the Amazon +// FSx for OpenZFS User Guide. +// +// [Copying backups]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups func (c *Client) CopyBackup(ctx context.Context, params *CopyBackupInput, optFns ...func(*Options)) (*CopyBackupOutput, error) { if params == nil { params = &CopyBackupInput{} @@ -61,25 +68,33 @@ 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 - // 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 - // (for example, two tags with the same key but different values), the tags created - // with the Tags parameter take precedence. + // 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 (for example, two tags with the same key but different + // values), the tags created with the Tags parameter take precedence. CopyTags *bool // 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. + // + // 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. + // is used. For more information, see [Encrypt]in the Key Management Service API Reference. + // + // [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html KmsKeyId *string // The source Amazon Web Services Region of the backup. Specifies the Amazon Web diff --git a/service/fsx/api_op_CopySnapshotAndUpdateVolume.go b/service/fsx/api_op_CopySnapshotAndUpdateVolume.go index 7d9d1196096..24f843bd2fb 100644 --- a/service/fsx/api_op_CopySnapshotAndUpdateVolume.go +++ b/service/fsx/api_op_CopySnapshotAndUpdateVolume.go @@ -12,8 +12,10 @@ import ( ) // Updates an existing volume by using a snapshot from another Amazon FSx for -// OpenZFS file system. For more information, see on-demand data replication (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/on-demand-replication.html) -// in the Amazon FSx for OpenZFS User Guide. +// OpenZFS file system. For more information, see [on-demand data replication]in the Amazon FSx for OpenZFS +// User Guide. +// +// [on-demand data replication]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/on-demand-replication.html func (c *Client) CopySnapshotAndUpdateVolume(ctx context.Context, params *CopySnapshotAndUpdateVolumeInput, optFns ...func(*Options)) (*CopySnapshotAndUpdateVolumeOutput, error) { if params == nil { params = &CopySnapshotAndUpdateVolumeInput{} @@ -34,8 +36,9 @@ type CopySnapshotAndUpdateVolumeInput 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. SourceSnapshotARN *string @@ -51,23 +54,30 @@ type CopySnapshotAndUpdateVolumeInput struct { ClientRequestToken *string // Specifies the strategy to use when copying data from a snapshot to the volume. + // // - FULL_COPY - Copies all data from the snapshot to the volume. + // // - INCREMENTAL_COPY - Copies only the snapshot data that's changed since the // previous replication. + // // CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume // operation. CopyStrategy types.OpenZFSCopyStrategy // Confirms that you want to delete data on the destination volume that wasn’t - // there during the previous snapshot replication. Your replication will fail if - // you don’t include an option for a specific type of data and that data is on your - // destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS - // and there are intermediate snapshots on the destination, you can’t copy the - // snapshot. + // there during the previous snapshot replication. + // + // Your replication will fail if you don’t include an option for a specific type + // of data and that data is on your destination. For example, if you don’t include + // DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the + // destination, you can’t copy the snapshot. + // // - DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume // that aren’t on the source volume. + // // - DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume // that aren't on the source volume. + // // - DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume // that don’t match the source snapshot that you’re copying. Options []types.UpdateOpenZFSVolumeOption diff --git a/service/fsx/api_op_CreateBackup.go b/service/fsx/api_op_CreateBackup.go index 6fa1f4e576c..cbf285afea3 100644 --- a/service/fsx/api_op_CreateBackup.go +++ b/service/fsx/api_op_CreateBackup.go @@ -15,29 +15,34 @@ import ( // Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon // FSx for OpenZFS file system. We recommend creating regular backups so that you // 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: +// 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 // // 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) -// . +// +// - For Amazon FSx for Lustre, see [Working with FSx for Lustre backups]. +// +// - For Amazon FSx for Windows, see [Working with FSx for Windows backups]. +// +// - For Amazon FSx for NetApp ONTAP, see [Working with FSx for NetApp ONTAP backups]. +// +// - For Amazon FSx for OpenZFS, see [Working with FSx for OpenZFS backups]. // // 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 @@ -45,10 +50,17 @@ import ( // 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. +// 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] operation, +// which returns the backup state along with other information. +// +// [Working with FSx for OpenZFS backups]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html +// [Working with FSx for NetApp ONTAP backups]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html +// [Working with FSx for Lustre backups]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html +// [Working with FSx for Windows backups]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html +// [DescribeBackups]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error) { if params == nil { params = &CreateBackupInput{} diff --git a/service/fsx/api_op_CreateDataRepositoryAssociation.go b/service/fsx/api_op_CreateDataRepositoryAssociation.go index 3463ae540f4..ba2a7eecca9 100644 --- a/service/fsx/api_op_CreateDataRepositoryAssociation.go +++ b/service/fsx/api_op_CreateDataRepositoryAssociation.go @@ -16,14 +16,17 @@ import ( // Amazon S3 bucket or prefix. You can have a maximum of 8 data repository // associations on a file system. Data repository associations are supported on all // FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type. +// // Each data repository association must have a unique Amazon FSx file system // directory and a unique S3 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. +// system, see [Linking your file system to an S3 bucket]. +// +// CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. +// To create a DRA on Amazon File Cache, use the CreateFileCache operation. +// +// [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) CreateDataRepositoryAssociation(ctx context.Context, params *CreateDataRepositoryAssociationInput, optFns ...func(*Options)) (*CreateDataRepositoryAssociationOutput, error) { if params == nil { params = &CreateDataRepositoryAssociationInput{} @@ -69,21 +72,24 @@ type CreateDataRepositoryAssociationInput struct { // 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. + // 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 // count and maximum amount of data per file (in MiB) stored on a single physical // disk. The maximum number of disks that a single file can be striped across is - // limited by the total number of disks that make up the file system. The default - // chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). - // Amazon S3 objects have a maximum size of 5 TB. + // limited by the total number of disks that make up the file system. + // + // The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB + // (500 GiB). Amazon S3 objects have a maximum size of 5 TB. ImportedFileChunkSize *int32 // The configuration for an Amazon S3 data repository linked to an Amazon FSx diff --git a/service/fsx/api_op_CreateDataRepositoryTask.go b/service/fsx/api_op_CreateDataRepositoryTask.go index 6e9573274f2..49b99414892 100644 --- a/service/fsx/api_op_CreateDataRepositoryTask.go +++ b/service/fsx/api_op_CreateDataRepositoryTask.go @@ -13,20 +13,25 @@ import ( // Creates an Amazon FSx for Lustre data repository task. A // CreateDataRepositoryTask operation will fail if a data repository is not linked -// to the FSx file system. You use import and export data repository tasks to -// perform bulk operations between your FSx for Lustre file system and its linked -// data repositories. An example of a data repository task is exporting any data -// and metadata changes, including POSIX metadata, to files, directories, and -// symbolic links (symlinks) from your FSx file system to a linked data repository. +// to the FSx file system. +// +// You use import and export data repository tasks to perform bulk operations +// between your FSx for Lustre file system and its linked data repositories. An +// example of a data repository task is exporting any data and metadata changes, +// including POSIX metadata, to files, directories, and symbolic links (symlinks) +// from your FSx file system to a linked data repository. +// // You use release data repository tasks to release data from your file system for // files that are exported to S3. The metadata of released files remains on the // file system so users or applications can still access released files by reading // the files again, which will restore data from Amazon S3 to the FSx for Lustre -// 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) -// . +// file system. +// +// To learn more about data repository tasks, see [Data Repository Tasks]. To learn more about linking a +// data repository to your file system, see [Linking your file system to an S3 bucket]. +// +// [Data Repository Tasks]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html +// [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{} @@ -52,20 +57,25 @@ 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]. + // + // [Working with Task Completion Reports]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html // // This member is required. Report *types.CompletionReport // Specifies the type of data repository task to create. + // // - 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. + // // - RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for // Lustre file system that have been exported to a linked S3 bucket and that meet // your specified release criteria. + // // - AUTO_RELEASE_DATA tasks automatically release files from an Amazon File // Cache resource. // @@ -86,22 +96,27 @@ type CreateDataRepositoryTaskInput struct { // paths, the default behavior is to export all files to S3 (for export tasks), // import all files from S3 (for import tasks), or release all exported files that // meet the last accessed time criteria (for release tasks). + // // - For export tasks, the list contains paths on the FSx for Lustre 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 FSx for Lustre file system. The // path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where // myPrefix is optional). + // // - For release tasks, the list contains directory or file paths on the FSx for // Lustre file system from which to release exported files. If a directory is // specified, files within the directory are released. If a file path is specified, // only that file is released. To release all exported files in the file system, - // specify a forward slash (/) as the path. A file must also meet the last accessed - // time criteria specified in for the file to be released. + // specify a forward slash (/) as the path. + // + // A file must also meet the last accessed time criteria specified in for the file + // to be released. Paths []string // The configuration that specifies the last accessed time criteria for files that diff --git a/service/fsx/api_op_CreateFileCache.go b/service/fsx/api_op_CreateFileCache.go index 9cc7b13b371..46d39f60aec 100644 --- a/service/fsx/api_op_CreateFileCache.go +++ b/service/fsx/api_op_CreateFileCache.go @@ -11,22 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Amazon File Cache resource. You can use this operation with a -// client request token in the request that Amazon File Cache uses to ensure -// 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 -// file cache with the specified client request token doesn't exist, -// CreateFileCache does the following: +// Creates a new Amazon File Cache resource. +// +// You can use this operation with a client request token in the request that +// Amazon File Cache uses to ensure 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 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. // // 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. +// CREATING . You can check the cache creation status by calling the [DescribeFileCaches] operation, +// which returns the cache state along with other information. +// +// [DescribeFileCaches]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html func (c *Client) CreateFileCache(ctx context.Context, params *CreateFileCacheInput, optFns ...func(*Options)) (*CreateFileCacheOutput, error) { if params == nil { params = &CreateFileCacheInput{} @@ -68,13 +72,14 @@ 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. + // 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. ClientRequestToken *string // A boolean flag indicating whether tags for the cache should be copied to data @@ -84,20 +89,25 @@ 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: + // 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. + // + // - 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]in the + // Key Management Service API Reference. + // + // [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html 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 892aacdcde4..97bb25ed8ca 100644 --- a/service/fsx/api_op_CreateFileSystem.go +++ b/service/fsx/api_op_CreateFileSystem.go @@ -13,9 +13,13 @@ 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 // // This operation requires a client request token in the request that Amazon FSx @@ -27,20 +31,25 @@ import ( // 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 +// 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) +// still CREATING . You can check the file-system creation status by calling the [DescribeFileSystems] // operation, which returns the file system state along with other information. +// +// [DescribeFileSystems]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemInput, optFns ...func(*Options)) (*CreateFileSystemOutput, error) { if params == nil { params = &CreateFileSystemInput{} @@ -66,25 +75,36 @@ type CreateFileSystemInput struct { FileSystemType types.FileSystemType // 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 + // (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 depends on the value of the HAPairs property. The minimum value is // calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs - // . 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: + // . + // + // 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. @@ -96,12 +116,15 @@ 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) - // 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. + // configuration, see [Availability and durability: Single-AZ and Multi-AZ file systems]in the Amazon FSx for Windows User Guide and [Availability and durability] 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. + // + // [Availability and durability: Single-AZ and Multi-AZ file systems]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html + // [Availability and durability]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html // // This member is required. SubnetIds []string @@ -113,33 +136,50 @@ type CreateFileSystemInput struct { // (Optional) For FSx for Lustre file systems, sets the Lustre version for the // file system that you're creating. Valid values are 2.10 , 2.12 , and 2.15 : + // // - 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types. + // // - 2.12 and 2.15 are supported by all Lustre deployment types. 2.12 or 2.15 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. + // 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. + // + // 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. + // is used. For more information, see [Encrypt]in the Key Management Service API Reference. + // + // [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html 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 . + // 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 + // // - ImportedFileChunkSize + // // - ImportPath LustreConfiguration *types.CreateFileSystemLustreConfiguration @@ -152,21 +192,27 @@ type CreateFileSystemInput struct { // A list of IDs specifying the security groups to apply to all network interfaces // created for file system access. This list isn't returned in later requests to - // describe the file system. You must specify a security group if you are creating - // a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with - // you. + // describe the file system. + // + // You must specify a security group if you are creating a Multi-AZ FSx for ONTAP + // file system in a VPC subnet that has been shared with you. 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) - // in the FSx for Lustre User Guide. + // + // Default value is SSD . For more information, see [Storage type options] in the FSx for Windows File + // Server User Guide and [Multiple storage options]in the FSx for Lustre User Guide. + // + // [Storage type options]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options + // [Multiple storage options]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options StorageType types.StorageType // The tags to apply to the file system that's being created. The key value of the diff --git a/service/fsx/api_op_CreateFileSystemFromBackup.go b/service/fsx/api_op_CreateFileSystemFromBackup.go index 493877ed08c..95c9b68e6a3 100644 --- a/service/fsx/api_op_CreateFileSystemFromBackup.go +++ b/service/fsx/api_op_CreateFileSystemFromBackup.go @@ -12,29 +12,38 @@ import ( ) // Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or -// Amazon FSx for OpenZFS file system from an existing Amazon FSx backup. If a file -// 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 -// client request token doesn't exist, this operation does the following: +// Amazon FSx for OpenZFS file system from an existing Amazon FSx backup. +// +// If a file 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 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. // // 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. +// 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]operation, which returns the file system state along with other +// information. +// +// [DescribeFileSystems]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html func (c *Client) CreateFileSystemFromBackup(ctx context.Context, params *CreateFileSystemFromBackupInput, optFns ...func(*Options)) (*CreateFileSystemFromBackupOutput, error) { if params == nil { params = &CreateFileSystemFromBackupInput{} @@ -62,10 +71,11 @@ type CreateFileSystemFromBackupInput struct { // For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet // IDs, one for the preferred file server and one for the standby file server. You // specify one of these subnets as the preferred subnet using the - // WindowsConfiguration > PreferredSubnetID property. Windows SINGLE_AZ_1 and - // SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file - // systems provide exactly one subnet ID. The file server is launched in that - // subnet's Availability Zone. + // WindowsConfiguration > PreferredSubnetID property. + // + // Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file + // systems, and OpenZFS file systems provide exactly one subnet ID. The file server + // is launched in that subnet's Availability Zone. // // This member is required. SubnetIds []string @@ -76,32 +86,45 @@ 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 , 2.12 , and 2.15 . 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 - // FileSystemTypeVersion setting. + // from a backup. Valid values are 2.10 , 2.12 , and 2.15 . + // + // 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 FileSystemTypeVersion setting. 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. + // + // 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. + // is used. For more information, see [Encrypt]in the Key Management Service API Reference. + // + // [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html 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 . + // 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 + // // - ImportedFileChunkSize + // // - ImportPath LustreConfiguration *types.CreateFileSystemLustreConfiguration @@ -118,23 +141,29 @@ type CreateFileSystemFromBackupInput struct { // 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 with an HTTP status code 400 Bad Request. + // 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 with an HTTP status code 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. + // + // 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 diff --git a/service/fsx/api_op_CreateSnapshot.go b/service/fsx/api_op_CreateSnapshot.go index c7bd904ada4..86eb8fa8792 100644 --- a/service/fsx/api_op_CreateSnapshot.go +++ b/service/fsx/api_op_CreateSnapshot.go @@ -13,14 +13,18 @@ import ( // 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: +// 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. // // By using the idempotent operation, you can retry a CreateSnapshot operation @@ -28,10 +32,13 @@ import ( // 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) +// 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] // operation, which returns the snapshot state along with other information. +// +// [DescribeSnapshots]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} diff --git a/service/fsx/api_op_CreateStorageVirtualMachine.go b/service/fsx/api_op_CreateStorageVirtualMachine.go index 4ca17cff480..47007a8ddd9 100644 --- a/service/fsx/api_op_CreateStorageVirtualMachine.go +++ b/service/fsx/api_op_CreateStorageVirtualMachine.go @@ -52,14 +52,17 @@ 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 Microsoft Windows administrator, the // majority of users are SMB clients, and an application accessing the data uses a // Microsoft Windows user as the service account. - // - MIXED This is an advanced setting. For more information, see Volume - // security style in the Amazon FSx for NetApp ONTAP User Guide. + // + // - MIXED This is an advanced setting. For more information, see Volume security stylein the Amazon + // FSx for NetApp ONTAP User Guide. RootVolumeSecurityStyle types.StorageVirtualMachineRootVolumeSecurityStyle // The password to use when managing the SVM using the NetApp ONTAP CLI or REST diff --git a/service/fsx/api_op_DeleteBackup.go b/service/fsx/api_op_DeleteBackup.go index 0596fbaad9d..b5495f929a2 100644 --- a/service/fsx/api_op_DeleteBackup.go +++ b/service/fsx/api_op_DeleteBackup.go @@ -12,9 +12,13 @@ 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{} diff --git a/service/fsx/api_op_DeleteFileCache.go b/service/fsx/api_op_DeleteFileCache.go index 63162f3f8a9..ea24e8439a6 100644 --- a/service/fsx/api_op_DeleteFileCache.go +++ b/service/fsx/api_op_DeleteFileCache.go @@ -12,13 +12,16 @@ 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) -// 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 -// be recovered by any means. +// 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]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 be recovered by any means. +// +// [DescribeFileCaches]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html func (c *Client) DeleteFileCache(ctx context.Context, params *DeleteFileCacheInput, optFns ...func(*Options)) (*DeleteFileCacheOutput, error) { if params == nil { params = &DeleteFileCacheInput{} diff --git a/service/fsx/api_op_DeleteFileSystem.go b/service/fsx/api_op_DeleteFileSystem.go index 01e383b6cd5..0a773bf0b8e 100644 --- a/service/fsx/api_op_DeleteFileSystem.go +++ b/service/fsx/api_op_DeleteFileSystem.go @@ -13,34 +13,44 @@ import ( // 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. To delete an Amazon FSx for Lustre file -// system, first unmount (https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html) -// it from every connected Amazon EC2 instance, then provide a FileSystemId value -// to the DeleFileSystem operation. By default, Amazon FSx will not take a final -// backup when the DeleteFileSystem operation is invoked. On file systems not -// linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final -// backup of the file system you are deleting. Backups cannot be enabled on -// S3-linked file systems. To ensure all of your data is written back to S3 before -// deleting your file system, you can either monitor for the -// AgeOfOldestQueuedMessage (https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics) -// metric to be zero (if using automatic export) or you can run an export data -// repository task (https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repo-task-dra.html) -// . If you have automatic export enabled and want to use an export data repository -// task, you have to disable automatic export before executing the export data -// repository task. 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) -// 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. +// 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. +// +// To delete an Amazon FSx for Lustre file system, first [unmount] it from every connected +// Amazon EC2 instance, then provide a FileSystemId value to the DeleFileSystem +// operation. By default, Amazon FSx will not take a final backup when the +// DeleteFileSystem operation is invoked. On file systems not linked to an Amazon +// S3 bucket, set SkipFinalBackup to false to take a final backup of the file +// system you are deleting. Backups cannot be enabled on S3-linked file systems. To +// ensure all of your data is written back to S3 before deleting your file system, +// you can either monitor for the [AgeOfOldestQueuedMessage]metric to be zero (if using automatic export) or +// you can run an [export data repository task]. If you have automatic export enabled and want to use an export +// data repository task, you have to disable automatic export before executing the +// export data repository task. +// +// The DeleteFileSystem operation returns while the file system has the DELETING +// status. 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 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. +// +// [unmount]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html +// [AgeOfOldestQueuedMessage]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics +// [DescribeFileSystems]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html +// [export data repository task]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repo-task-dra.html func (c *Client) DeleteFileSystem(ctx context.Context, params *DeleteFileSystemInput, optFns ...func(*Options)) (*DeleteFileSystemOutput, error) { if params == nil { params = &DeleteFileSystemInput{} diff --git a/service/fsx/api_op_DeleteSnapshot.go b/service/fsx/api_op_DeleteSnapshot.go index 94e7aa24d1b..1129c75363c 100644 --- a/service/fsx/api_op_DeleteSnapshot.go +++ b/service/fsx/api_op_DeleteSnapshot.go @@ -13,9 +13,10 @@ import ( // Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no // longer exists, and its data is gone. Deleting a snapshot doesn't affect -// snapshots stored in a file system backup. The DeleteSnapshot operation returns -// instantly. The snapshot appears with the lifecycle status of DELETING until the -// deletion is complete. +// snapshots stored in a file system backup. +// +// The DeleteSnapshot operation returns instantly. The snapshot appears with the +// lifecycle status of DELETING until the deletion is complete. func (c *Client) DeleteSnapshot(ctx context.Context, params *DeleteSnapshotInput, optFns ...func(*Options)) (*DeleteSnapshotOutput, error) { if params == nil { params = &DeleteSnapshotInput{} diff --git a/service/fsx/api_op_DescribeBackups.go b/service/fsx/api_op_DescribeBackups.go index 1c7df59d214..ec668935988 100644 --- a/service/fsx/api_op_DescribeBackups.go +++ b/service/fsx/api_op_DescribeBackups.go @@ -14,18 +14,24 @@ import ( // 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: +// 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. diff --git a/service/fsx/api_op_DescribeDataRepositoryAssociations.go b/service/fsx/api_op_DescribeDataRepositoryAssociations.go index 64f4cb0a00c..adc69ff69e6 100644 --- a/service/fsx/api_op_DescribeDataRepositoryAssociations.go +++ b/service/fsx/api_op_DescribeDataRepositoryAssociations.go @@ -15,20 +15,23 @@ 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 FSx for Lustre -// 2.12 and 2,15 file systems, excluding scratch_1 deployment type. 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 +// 2.12 and 2,15 file systems, excluding scratch_1 deployment type. +// +// 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 // 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 -// paginate the response by using the optional MaxResults parameter to limit the -// number of data repository associations returned in a response. If more data -// repository associations remain, a NextToken value is returned 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. +// that you're calling. +// +// When retrieving all data repository associations, you can paginate the response +// by using the optional MaxResults parameter to limit the number of data +// repository associations returned in a response. If more data repository +// associations remain, a NextToken value is returned 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. func (c *Client) DescribeDataRepositoryAssociations(ctx context.Context, params *DescribeDataRepositoryAssociationsInput, optFns ...func(*Options)) (*DescribeDataRepositoryAssociationsOutput, error) { if params == nil { params = &DescribeDataRepositoryAssociationsInput{} diff --git a/service/fsx/api_op_DescribeDataRepositoryTasks.go b/service/fsx/api_op_DescribeDataRepositoryTasks.go index 3b515727148..f1c5ade3ce1 100644 --- a/service/fsx/api_op_DescribeDataRepositoryTasks.go +++ b/service/fsx/api_op_DescribeDataRepositoryTasks.go @@ -17,11 +17,13 @@ import ( // the response to include just tasks for specific file systems or caches, or tasks // in a specific lifecycle state. Otherwise, it returns all data repository tasks // owned by your Amazon Web Services account in the Amazon Web Services Region of -// the endpoint that you're calling. When retrieving all tasks, you can paginate -// the response by using the optional MaxResults parameter to limit the number of -// tasks returned in a response. If more tasks remain, a NextToken value is -// returned 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. +// the endpoint that you're calling. +// +// When retrieving all tasks, you can paginate the response by using the optional +// MaxResults parameter to limit the number of tasks returned in a response. If +// more tasks remain, a NextToken value is returned 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. func (c *Client) DescribeDataRepositoryTasks(ctx context.Context, params *DescribeDataRepositoryTasksInput, optFns ...func(*Options)) (*DescribeDataRepositoryTasksOutput, error) { if params == nil { params = &DescribeDataRepositoryTasksInput{} diff --git a/service/fsx/api_op_DescribeFileCaches.go b/service/fsx/api_op_DescribeFileCaches.go index 55f11eeac5f..98737ff16f4 100644 --- a/service/fsx/api_op_DescribeFileCaches.go +++ b/service/fsx/api_op_DescribeFileCaches.go @@ -14,19 +14,24 @@ import ( // Returns the description of a specific Amazon File Cache resource, if a // FileCacheIds value is provided for that cache. Otherwise, it returns // descriptions of all caches owned by your Amazon Web Services account in the -// Amazon Web Services Region of the endpoint that you're calling. When retrieving -// all cache descriptions, you can optionally specify the MaxResults parameter to -// limit the number of descriptions in a response. If more cache descriptions -// remain, the operation 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 cache descriptions. DescribeFileCaches 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 . When using this operation, keep the following in -// mind: +// Amazon Web Services Region of the endpoint that you're calling. +// +// When retrieving all cache descriptions, you can optionally specify the +// MaxResults parameter to limit the number of descriptions in a response. If more +// cache descriptions remain, the operation 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 cache +// descriptions. DescribeFileCaches 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 . +// +// 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. diff --git a/service/fsx/api_op_DescribeFileSystemAliases.go b/service/fsx/api_op_DescribeFileSystemAliases.go index 02340b0a260..c94070266ee 100644 --- a/service/fsx/api_op_DescribeFileSystemAliases.go +++ b/service/fsx/api_op_DescribeFileSystemAliases.go @@ -14,7 +14,7 @@ import ( // Returns the DNS aliases that are associated with the specified Amazon FSx for // Windows File Server file system. A history of all DNS aliases that have been // associated with and disassociated from the file system is available in the list -// of AdministrativeAction provided in the DescribeFileSystems operation response. +// of AdministrativeActionprovided in the DescribeFileSystems operation response. func (c *Client) DescribeFileSystemAliases(ctx context.Context, params *DescribeFileSystemAliasesInput, optFns ...func(*Options)) (*DescribeFileSystemAliasesOutput, error) { if params == nil { params = &DescribeFileSystemAliasesInput{} diff --git a/service/fsx/api_op_DescribeFileSystems.go b/service/fsx/api_op_DescribeFileSystems.go index ae067edf34d..b7b5e38626e 100644 --- a/service/fsx/api_op_DescribeFileSystems.go +++ b/service/fsx/api_op_DescribeFileSystems.go @@ -14,19 +14,24 @@ import ( // Returns the description of specific Amazon FSx file systems, if a FileSystemIds // value is provided for that file system. Otherwise, it returns descriptions of // all file systems owned by your Amazon Web Services account in the Amazon Web -// 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 -// 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 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: +// 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 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 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. diff --git a/service/fsx/api_op_DescribeSharedVpcConfiguration.go b/service/fsx/api_op_DescribeSharedVpcConfiguration.go index 5e63b50c51f..aefd56a2117 100644 --- a/service/fsx/api_op_DescribeSharedVpcConfiguration.go +++ b/service/fsx/api_op_DescribeSharedVpcConfiguration.go @@ -12,9 +12,9 @@ import ( // Indicates whether participant accounts in your organization can create Amazon // FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a -// virtual private cloud (VPC) owner. For more information, see Creating FSx for -// ONTAP file systems in shared subnets (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets) -// . +// virtual private cloud (VPC) owner. For more information, see [Creating FSx for ONTAP file systems in shared subnets]. +// +// [Creating FSx for ONTAP file systems in shared subnets]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets func (c *Client) DescribeSharedVpcConfiguration(ctx context.Context, params *DescribeSharedVpcConfigurationInput, optFns ...func(*Options)) (*DescribeSharedVpcConfigurationOutput, error) { if params == nil { params = &DescribeSharedVpcConfigurationInput{} diff --git a/service/fsx/api_op_DescribeSnapshots.go b/service/fsx/api_op_DescribeSnapshots.go index c6fd2ebc9a0..be847ebe330 100644 --- a/service/fsx/api_op_DescribeSnapshots.go +++ b/service/fsx/api_op_DescribeSnapshots.go @@ -14,18 +14,24 @@ import ( // Returns the description of specific Amazon FSx for OpenZFS snapshots, if a // SnapshotIds value is provided. Otherwise, this operation returns all snapshots // owned by your Amazon Web Services account in the Amazon Web Services Region of -// the endpoint that you're calling. When retrieving all snapshots, you can -// optionally specify the MaxResults parameter to limit the number of snapshots 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 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 -// operation, keep the following in mind: +// the endpoint that you're calling. +// +// When retrieving all snapshots, you can optionally specify the MaxResults +// parameter to limit the number of snapshots 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 +// 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 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. diff --git a/service/fsx/api_op_DisassociateFileSystemAliases.go b/service/fsx/api_op_DisassociateFileSystemAliases.go index 87717a936d9..2b06d599ae6 100644 --- a/service/fsx/api_op_DisassociateFileSystemAliases.go +++ b/service/fsx/api_op_DisassociateFileSystemAliases.go @@ -15,11 +15,14 @@ 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 an HTTP status code 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 +// information, see [Working with DNS Aliases]. +// +// 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. +// +// [Working with DNS Aliases]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html func (c *Client) DisassociateFileSystemAliases(ctx context.Context, params *DisassociateFileSystemAliasesInput, optFns ...func(*Options)) (*DisassociateFileSystemAliasesOutput, error) { if params == nil { params = &DisassociateFileSystemAliasesInput{} diff --git a/service/fsx/api_op_ListTagsForResource.go b/service/fsx/api_op_ListTagsForResource.go index a910ff547b2..86a9574520a 100644 --- a/service/fsx/api_op_ListTagsForResource.go +++ b/service/fsx/api_op_ListTagsForResource.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists tags for Amazon FSx resources. When retrieving all tags, you can -// optionally specify the MaxResults parameter to limit the number of tags in a -// response. If more tags 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 action is -// used in an iterative process to retrieve a list of your tags. +// Lists tags for Amazon FSx resources. +// +// When retrieving all tags, you can optionally specify the MaxResults parameter +// to limit the number of tags in a response. If more tags 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 action is used in an iterative process to retrieve a list of your tags. // 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: +// 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. diff --git a/service/fsx/api_op_RestoreVolumeFromSnapshot.go b/service/fsx/api_op_RestoreVolumeFromSnapshot.go index 4dafd39a4d2..def5d6a9124 100644 --- a/service/fsx/api_op_RestoreVolumeFromSnapshot.go +++ b/service/fsx/api_op_RestoreVolumeFromSnapshot.go @@ -47,9 +47,11 @@ 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. diff --git a/service/fsx/api_op_UpdateDataRepositoryAssociation.go b/service/fsx/api_op_UpdateDataRepositoryAssociation.go index d791b13f3bc..2660f5ac2b1 100644 --- a/service/fsx/api_op_UpdateDataRepositoryAssociation.go +++ b/service/fsx/api_op_UpdateDataRepositoryAssociation.go @@ -45,9 +45,10 @@ type UpdateDataRepositoryAssociationInput struct { // For files imported from a data repository, this value determines the stripe // count and maximum amount of data per file (in MiB) stored on a single physical // disk. The maximum number of disks that a single file can be striped across is - // limited by the total number of disks that make up the file system. The default - // chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). - // Amazon S3 objects have a maximum size of 5 TB. + // limited by the total number of disks that make up the file system. + // + // The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB + // (500 GiB). Amazon S3 objects have a maximum size of 5 TB. ImportedFileChunkSize *int32 // The configuration for an Amazon S3 data repository linked to an Amazon FSx diff --git a/service/fsx/api_op_UpdateFileSystem.go b/service/fsx/api_op_UpdateFileSystem.go index bac60f058f8..59bd0b8eac0 100644 --- a/service/fsx/api_op_UpdateFileSystem.go +++ b/service/fsx/api_op_UpdateFileSystem.go @@ -12,52 +12,93 @@ 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: +// 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 +// // - StorageType +// // - ThroughputCapacity +// // - DiskIopsConfiguration +// // - WeeklyMaintenanceStartTime // // For FSx for Lustre file systems, you can update the following properties: +// // - AutoImportPolicy +// // - AutomaticBackupRetentionDays +// // - DailyAutomaticBackupStartTime +// // - DataCompressionType +// // - LogConfiguration +// // - LustreRootSquashConfiguration +// // - PerUnitStorageThroughput +// // - StorageCapacity +// // - WeeklyMaintenanceStartTime // // For FSx for ONTAP file systems, you can update the following properties: +// // - AddRouteTableIds +// // - AutomaticBackupRetentionDays +// // - DailyAutomaticBackupStartTime +// // - DiskIopsConfiguration +// // - FsxAdminPassword +// // - HAPairs +// // - RemoveRouteTableIds +// // - StorageCapacity +// // - ThroughputCapacity +// // - ThroughputCapacityPerHAPair +// // - WeeklyMaintenanceStartTime // // For FSx for OpenZFS file systems, you can update the following properties: +// // - AddRouteTableIds +// // - AutomaticBackupRetentionDays +// // - CopyTagsToBackups +// // - CopyTagsToVolumes +// // - DailyAutomaticBackupStartTime +// // - DiskIopsConfiguration +// // - RemoveRouteTableIds +// // - StorageCapacity +// // - ThroughputCapacity +// // - WeeklyMaintenanceStartTime func (c *Client) UpdateFileSystem(ctx context.Context, params *UpdateFileSystemInput, optFns ...func(*Options)) (*UpdateFileSystemOutput, error) { if params == nil { @@ -100,32 +141,42 @@ type UpdateFileSystemInput struct { // Use this parameter to increase the storage capacity of an FSx for Windows File // Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies // 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. + // 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 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) - // 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) - // in the Amazon FSxfor 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) - // in the Amazon FSx for NetApp ONTAP User Guide. + // + // For more information, see [Managing storage and throughput capacity] 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]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]in the Amazon FSxfor 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]in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Managing storage and throughput capacity]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html + // [Managing storage capacity]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html + // [Managing storage capacity and provisioned IOPS]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html StorageCapacity *int32 // Specifies the file system's storage type. diff --git a/service/fsx/api_op_UpdateSharedVpcConfiguration.go b/service/fsx/api_op_UpdateSharedVpcConfiguration.go index 42fb7a581b1..0952d54a6f1 100644 --- a/service/fsx/api_op_UpdateSharedVpcConfiguration.go +++ b/service/fsx/api_op_UpdateSharedVpcConfiguration.go @@ -12,14 +12,15 @@ import ( // Configures whether participant accounts in your organization can create Amazon // FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a -// virtual private cloud (VPC) owner. For more information, see the Amazon FSx for -// NetApp ONTAP User Guide (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html) -// . We strongly recommend that participant-created Multi-AZ file systems in the +// virtual private cloud (VPC) owner. For more information, see the [Amazon FSx for NetApp ONTAP User Guide]. +// +// We strongly recommend that participant-created Multi-AZ file systems in the // shared VPC are deleted before you disable this feature. Once the feature is // disabled, these file systems will enter a MISCONFIGURED state and behave like -// Single-AZ file systems. For more information, see Important considerations -// before disabling shared VPC support for Multi-AZ file systems (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html#disabling-maz-vpc-sharing) -// . +// Single-AZ file systems. For more information, see [Important considerations before disabling shared VPC support for Multi-AZ file systems]. +// +// [Amazon FSx for NetApp ONTAP User Guide]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html +// [Important considerations before disabling shared VPC support for Multi-AZ file systems]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html#disabling-maz-vpc-sharing func (c *Client) UpdateSharedVpcConfiguration(ctx context.Context, params *UpdateSharedVpcConfigurationInput, optFns ...func(*Options)) (*UpdateSharedVpcConfigurationOutput, error) { if params == nil { params = &UpdateSharedVpcConfigurationInput{} diff --git a/service/fsx/options.go b/service/fsx/options.go index b5ee9bcef82..27196520086 100644 --- a/service/fsx/options.go +++ b/service/fsx/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/fsx/types/enums.go b/service/fsx/types/enums.go index bd389888233..e22173ed66a 100644 --- a/service/fsx/types/enums.go +++ b/service/fsx/types/enums.go @@ -14,6 +14,7 @@ const ( // 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{ @@ -46,6 +47,7 @@ const ( // 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{ @@ -78,8 +80,9 @@ const ( ) // Values returns all known values for AliasLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AliasLifecycle) Values() []AliasLifecycle { return []AliasLifecycle{ "AVAILABLE", @@ -103,8 +106,9 @@ const ( ) // Values returns all known values for AutocommitPeriodType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutocommitPeriodType) Values() []AutocommitPeriodType { return []AutocommitPeriodType{ "MINUTES", @@ -127,8 +131,9 @@ const ( ) // Values returns all known values for AutoImportPolicyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoImportPolicyType) Values() []AutoImportPolicyType { return []AutoImportPolicyType{ "NONE", @@ -152,8 +157,9 @@ const ( ) // Values returns all known values for BackupLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupLifecycle) Values() []BackupLifecycle { return []BackupLifecycle{ "AVAILABLE", @@ -176,8 +182,9 @@ const ( ) // Values returns all known values for BackupType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupType) Values() []BackupType { return []BackupType{ "AUTOMATIC", @@ -195,8 +202,9 @@ const ( ) // Values returns all known values for DataCompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataCompressionType) Values() []DataCompressionType { return []DataCompressionType{ "NONE", @@ -217,8 +225,9 @@ const ( ) // Values returns all known values for DataRepositoryLifecycle. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataRepositoryLifecycle) Values() []DataRepositoryLifecycle { return []DataRepositoryLifecycle{ "CREATING", @@ -242,8 +251,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataRepositoryTaskFilterName) Values() []DataRepositoryTaskFilterName { return []DataRepositoryTaskFilterName{ "file-system-id", @@ -267,6 +277,7 @@ const ( // Values returns all known values for DataRepositoryTaskLifecycle. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataRepositoryTaskLifecycle) Values() []DataRepositoryTaskLifecycle { return []DataRepositoryTaskLifecycle{ @@ -290,8 +301,9 @@ const ( ) // Values returns all known values for DataRepositoryTaskType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataRepositoryTaskType) Values() []DataRepositoryTaskType { return []DataRepositoryTaskType{ "EXPORT_TO_REPOSITORY", @@ -310,8 +322,9 @@ const ( // Values returns all known values for DeleteFileSystemOpenZFSOption. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteFileSystemOpenZFSOption) Values() []DeleteFileSystemOpenZFSOption { return []DeleteFileSystemOpenZFSOption{ "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS", @@ -327,6 +340,7 @@ const ( // Values returns all known values for DeleteOpenZFSVolumeOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DeleteOpenZFSVolumeOption) Values() []DeleteOpenZFSVolumeOption { return []DeleteOpenZFSVolumeOption{ @@ -344,6 +358,7 @@ const ( // Values returns all known values for DiskIopsConfigurationMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DiskIopsConfigurationMode) Values() []DiskIopsConfigurationMode { return []DiskIopsConfigurationMode{ @@ -361,8 +376,9 @@ const ( ) // Values returns all known values for DriveCacheType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DriveCacheType) Values() []DriveCacheType { return []DriveCacheType{ "NONE", @@ -380,8 +396,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -402,8 +419,9 @@ const ( ) // Values returns all known values for FileCacheLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileCacheLifecycle) Values() []FileCacheLifecycle { return []FileCacheLifecycle{ "AVAILABLE", @@ -423,8 +441,9 @@ const ( // Values returns all known values for FileCacheLustreDeploymentType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileCacheLustreDeploymentType) Values() []FileCacheLustreDeploymentType { return []FileCacheLustreDeploymentType{ "CACHE_1", @@ -439,8 +458,9 @@ const ( ) // Values returns all known values for FileCacheType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileCacheType) Values() []FileCacheType { return []FileCacheType{ "LUSTRE", @@ -461,8 +481,9 @@ const ( ) // Values returns all known values for FileSystemLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemLifecycle) Values() []FileSystemLifecycle { return []FileSystemLifecycle{ "AVAILABLE", @@ -485,8 +506,9 @@ const ( // Values returns all known values for FileSystemMaintenanceOperation. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemMaintenanceOperation) Values() []FileSystemMaintenanceOperation { return []FileSystemMaintenanceOperation{ "PATCHING", @@ -505,8 +527,9 @@ const ( ) // Values returns all known values for FileSystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemType) Values() []FileSystemType { return []FileSystemType{ "WINDOWS", @@ -530,8 +553,9 @@ const ( ) // Values returns all known values for FilterName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterName) Values() []FilterName { return []FilterName{ "file-system-id", @@ -554,8 +578,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NONE", @@ -573,8 +598,9 @@ const ( ) // Values returns all known values for InputOntapVolumeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputOntapVolumeType) Values() []InputOntapVolumeType { return []InputOntapVolumeType{ "RW", @@ -594,6 +620,7 @@ const ( // Values returns all known values for LustreAccessAuditLogLevel. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LustreAccessAuditLogLevel) Values() []LustreAccessAuditLogLevel { return []LustreAccessAuditLogLevel{ @@ -615,8 +642,9 @@ const ( ) // Values returns all known values for LustreDeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LustreDeploymentType) Values() []LustreDeploymentType { return []LustreDeploymentType{ "SCRATCH_1", @@ -634,8 +662,9 @@ const ( ) // Values returns all known values for NfsVersion. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NfsVersion) Values() []NfsVersion { return []NfsVersion{ "NFS3", @@ -652,8 +681,9 @@ const ( ) // Values returns all known values for OntapDeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OntapDeploymentType) Values() []OntapDeploymentType { return []OntapDeploymentType{ "MULTI_AZ_1", @@ -672,8 +702,9 @@ const ( ) // Values returns all known values for OntapVolumeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OntapVolumeType) Values() []OntapVolumeType { return []OntapVolumeType{ "RW", @@ -692,8 +723,9 @@ const ( ) // Values returns all known values for OpenZFSCopyStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpenZFSCopyStrategy) Values() []OpenZFSCopyStrategy { return []OpenZFSCopyStrategy{ "CLONE", @@ -713,6 +745,7 @@ const ( // Values returns all known values for OpenZFSDataCompressionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OpenZFSDataCompressionType) Values() []OpenZFSDataCompressionType { return []OpenZFSDataCompressionType{ @@ -732,8 +765,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SINGLE_AZ_1", @@ -751,8 +785,9 @@ const ( ) // Values returns all known values for OpenZFSQuotaType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpenZFSQuotaType) Values() []OpenZFSQuotaType { return []OpenZFSQuotaType{ "USER", @@ -770,8 +805,9 @@ const ( ) // Values returns all known values for PrivilegedDelete. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrivilegedDelete) Values() []PrivilegedDelete { return []PrivilegedDelete{ "DISABLED", @@ -788,8 +824,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -804,8 +841,9 @@ const ( ) // Values returns all known values for ReportScope. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportScope) Values() []ReportScope { return []ReportScope{ "FAILED_FILES_ONLY", @@ -821,8 +859,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -840,6 +879,7 @@ const ( // Values returns all known values for RestoreOpenZFSVolumeOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RestoreOpenZFSVolumeOption) Values() []RestoreOpenZFSVolumeOption { return []RestoreOpenZFSVolumeOption{ @@ -863,8 +903,9 @@ const ( ) // Values returns all known values for RetentionPeriodType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetentionPeriodType) Values() []RetentionPeriodType { return []RetentionPeriodType{ "SECONDS", @@ -888,8 +929,9 @@ const ( ) // Values returns all known values for SecurityStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityStyle) Values() []SecurityStyle { return []SecurityStyle{ "UNIX", @@ -915,8 +957,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -941,8 +984,9 @@ const ( ) // Values returns all known values for SnaplockType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnaplockType) Values() []SnaplockType { return []SnaplockType{ "COMPLIANCE", @@ -959,8 +1003,9 @@ const ( ) // Values returns all known values for SnapshotFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotFilterName) Values() []SnapshotFilterName { return []SnapshotFilterName{ "file-system-id", @@ -979,8 +1024,9 @@ const ( ) // Values returns all known values for SnapshotLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotLifecycle) Values() []SnapshotLifecycle { return []SnapshotLifecycle{ "PENDING", @@ -1002,8 +1048,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "FAILED", @@ -1023,8 +1070,9 @@ const ( ) // Values returns all known values for StorageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageType) Values() []StorageType { return []StorageType{ "SSD", @@ -1041,8 +1089,9 @@ const ( // Values returns all known values for StorageVirtualMachineFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageVirtualMachineFilterName) Values() []StorageVirtualMachineFilterName { return []StorageVirtualMachineFilterName{ "file-system-id", @@ -1063,8 +1112,9 @@ const ( // Values returns all known values for StorageVirtualMachineLifecycle. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageVirtualMachineLifecycle) Values() []StorageVirtualMachineLifecycle { return []StorageVirtualMachineLifecycle{ "CREATED", @@ -1087,8 +1137,9 @@ const ( // Values returns all known values for // StorageVirtualMachineRootVolumeSecurityStyle. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageVirtualMachineRootVolumeSecurityStyle) Values() []StorageVirtualMachineRootVolumeSecurityStyle { return []StorageVirtualMachineRootVolumeSecurityStyle{ "UNIX", @@ -1109,8 +1160,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageVirtualMachineSubtype) Values() []StorageVirtualMachineSubtype { return []StorageVirtualMachineSubtype{ "DEFAULT", @@ -1131,8 +1183,9 @@ const ( ) // Values returns all known values for TieringPolicyName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TieringPolicyName) Values() []TieringPolicyName { return []TieringPolicyName{ "SNAPSHOT_ONLY", @@ -1150,8 +1203,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "DAYS", @@ -1169,6 +1223,7 @@ const ( // Values returns all known values for UpdateOpenZFSVolumeOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (UpdateOpenZFSVolumeOption) Values() []UpdateOpenZFSVolumeOption { return []UpdateOpenZFSVolumeOption{ @@ -1187,8 +1242,9 @@ const ( ) // Values returns all known values for VolumeFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeFilterName) Values() []VolumeFilterName { return []VolumeFilterName{ "file-system-id", @@ -1210,8 +1266,9 @@ const ( ) // Values returns all known values for VolumeLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeLifecycle) Values() []VolumeLifecycle { return []VolumeLifecycle{ "CREATING", @@ -1233,8 +1290,9 @@ const ( ) // Values returns all known values for VolumeStyle. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeStyle) Values() []VolumeStyle { return []VolumeStyle{ "FLEXVOL", @@ -1251,8 +1309,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "ONTAP", @@ -1272,6 +1331,7 @@ const ( // Values returns all known values for WindowsAccessAuditLogLevel. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WindowsAccessAuditLogLevel) Values() []WindowsAccessAuditLogLevel { return []WindowsAccessAuditLogLevel{ @@ -1292,8 +1352,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MULTI_AZ_1", diff --git a/service/fsx/types/types.go b/service/fsx/types/types.go index 686db0c0575..782c274994d 100644 --- a/service/fsx/types/types.go +++ b/service/fsx/types/types.go @@ -21,8 +21,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string noSmithyDocumentSerde @@ -33,72 +34,92 @@ 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 ). + // // - THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a // file system's throughput capacity has been completed successfully, a - // THROUGHPUT_OPTIMIZATION task starts. You can track the storage-optimization - // progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has - // been completed successfully, the parent FILE_SYSTEM_UPDATE action status - // changes to COMPLETED . For more information, see Managing throughput capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html) - // in the Amazon FSx for Windows File Server User Guide. + // THROUGHPUT_OPTIMIZATION task starts. + // + // You can track the storage-optimization progress using the ProgressPercent + // property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the + // parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more + // information, see [Managing throughput capacity]in the Amazon FSx for Windows File Server User Guide. + // // - 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 - // 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. + // 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]in the Amazon FSx for Windows File Server User Guide, [Managing storage capacity]in the + // Amazon FSx for Lustre User Guide, and [Managing storage capacity and provisioned IOPS]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) + // Domain Name System (DNS) alias with the file system. For more information, see [AssociateFileSystemAliases] // . + // // - 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) - // . + // DNS alias from the file system. For more information, see [DisassociateFileSystemAliases]. + // // - IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file // system's throughput capacity has been completed successfully, a - // IOPS_OPTIMIZATION task starts. You can track the storage-optimization progress - // using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed - // successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED - // . For more information, see Managing provisioned SSD IOPS (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html) - // in the Amazon FSx for Windows File Server User Guide. + // IOPS_OPTIMIZATION task starts. + // + // You can track the storage-optimization progress using the ProgressPercent + // property. When IOPS_OPTIMIZATION has been completed successfully, the parent + // FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, + // see [Managing provisioned SSD IOPS]in the Amazon FSx for Windows File Server User Guide. + // // - STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a // file system's throughput capacity has been completed successfully, a - // STORAGE_TYPE_OPTIMIZATION task starts. You can track the storage-optimization - // progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION - // has been completed successfully, the parent FILE_SYSTEM_UPDATE action status - // changes to COMPLETED . + // STORAGE_TYPE_OPTIMIZATION task starts. + // + // You can track the storage-optimization progress using the ProgressPercent + // property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the + // parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . + // // - VOLUME_UPDATE - A volume update to an 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. + // // - VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot // on a different FSx for OpenZFS file system. You can initiate this from the // Amazon FSx console, API ( CreateVolume ), or CLI ( create-volume ) when using // the using the FULL_COPY strategy. + // // - VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a // different FSx for OpenZFS file system. You can initiate this from the Amazon FSx // console, API ( CopySnapshotAndUpdateVolume ), or CLI ( // copy-snapshot-and-update-volume ). + // + // [Managing storage capacity]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html + // [AssociateFileSystemAliases]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html + // [DisassociateFileSystemAliases]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html + // [Managing provisioned SSD IOPS]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html + // [Managing throughput capacity]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html + // [Managing storage capacity and provisioned IOPS]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html AdministrativeActionType AdministrativeActionType // Provides information about a failed administrative action. @@ -116,11 +137,15 @@ type AdministrativeAction struct { RequestTime *time.Time // The status of the administrative action, as follows: - // - FAILED - Amazon FSx failed to process the administrative action - // successfully. + // + // - 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. @@ -160,11 +185,16 @@ type AggregateConfiguration struct { // pools which make up your primary storage tier. Each high-availability (HA) pair // has one aggregate. The names of the aggregates map to the names of the // aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a - // single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for - // the following conditions: + // single entry. + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the + // following conditions: + // // - The strings in the value of Aggregates are not are not formatted as aggrX , // where X is a number between 1 and 6. + // // - The value of Aggregates contains aggregates that are not present. + // // - One or more of the aggregates supplied are too close to the volume limit to // support adding more volumes. Aggregates []string @@ -178,31 +208,41 @@ type AggregateConfiguration 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 name that Amazon FSx assigns to the file system. For more information, see [DNS aliases] // in the FSx for Windows File Server User Guide. +// +// [DNS aliases]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html 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. 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 - // (-). + // + // - 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. @@ -213,9 +253,11 @@ type Alias struct { // Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which // determines how long the files must remain unmodified before they're -// automatically transitioned to the write once, read many (WORM) state. For more -// information, see Autocommit (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-autocommit) -// . +// automatically transitioned to the write once, read many (WORM) state. +// +// For more information, see [Autocommit]. +// +// [Autocommit]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-autocommit type AutocommitPeriod struct { // Defines the type of time for the autocommit period of a file in an FSx for @@ -227,10 +269,15 @@ type AutocommitPeriod struct { // Defines the amount of time for the autocommit period of a file in an FSx for // ONTAP SnapLock volume. The following ranges are valid: + // // - Minutes : 5 - 65,535 + // // - Hours : 1 - 65,535 + // // - Days : 1 - 3,650 + // // - Months : 1 - 120 + // // - Years : 1 - 10 Value *int32 @@ -241,18 +288,23 @@ type AutocommitPeriod struct { // AutoExportPolicy defines the types of updated objects on the file system that // will be automatically exported to the data repository. As you create, modify, or // delete files, Amazon FSx for Lustre automatically exports the defined changes -// asynchronously once your application finishes modifying the file. The -// AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a -// data repository association. +// asynchronously once your application finishes modifying the file. +// +// The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems +// with a data repository association. 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 . Events []EventType @@ -262,19 +314,23 @@ 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 -// association. +// 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 . Events []EventType @@ -303,14 +359,21 @@ 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. // // This member is required. @@ -444,46 +507,65 @@ type CreateFileCacheLustreConfiguration struct { // This member is required. PerUnitStorageThroughput *int32 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde } -// 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 . +// 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 +// // - ImportedFileChunkSize +// // - 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: + // (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 + // + // For more information, see [Automatically import updates from your S3 bucket]. + // + // This parameter is not supported for file systems with a data repository // association. + // + // [Automatically import updates from your S3 bucket]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3 AutoImportPolicy AutoImportPolicyType // The number of days to retain automatic backups. Setting this property to 0 @@ -499,9 +581,13 @@ 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] in the Amazon FSx for Lustre User Guide. + // + // [Working with backups]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html CopyTagsToBackups *bool // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the @@ -511,40 +597,54 @@ type CreateFileSystemLustreConfiguration struct { // 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. + // + // For more information, see [Lustre data compression] in the Amazon FSx for Lustre User Guide. + // + // [Lustre data compression]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html 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 - // 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 - // longer-term storage and for latency-sensitive workloads that require the highest - // levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher - // 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. + // 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 longer-term storage and for latency-sensitive workloads + // that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD + // storage, and offers higher 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] 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 ) + // FSx for Lustre file systems, see [Encrypting data in transit]in the Amazon FSx for Lustre User Guide. + // + // (Default = SCRATCH_1 ) + // + // [File system deployment options for FSx for Lustre]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types + // [Encrypting data in transit]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html 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 . DriveCacheType DriveCacheType @@ -554,14 +654,17 @@ type CreateFileSystemLustreConfiguration struct { // 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 - // 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 - // 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 + // 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 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 @@ -571,6 +674,7 @@ type CreateFileSystemLustreConfiguration struct { // 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 @@ -578,10 +682,13 @@ type CreateFileSystemLustreConfiguration struct { // (Optional) For files imported from a data repository, this value determines the // stripe count and maximum amount of data per file (in MiB) stored on a single // physical disk. The maximum number of disks that a single file can be striped - // across is limited by the total number of disks that make up the file system. The - // default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 - // GiB). Amazon S3 objects have a maximum size of 5 TB. This parameter is not - // supported for file systems with a data repository association. + // across is limited by the total number of disks that make up the file system. + // + // The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB + // (500 GiB). Amazon S3 objects have a maximum size of 5 TB. + // + // This parameter is not supported for file systems with a data repository + // association. ImportedFileChunkSize *int32 // The Lustre logging configuration used when creating an Amazon FSx for Lustre @@ -595,9 +702,14 @@ type CreateFileSystemLustreConfiguration struct { // multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput // (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: + // 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. PerUnitStorageThroughput *int32 @@ -620,15 +732,19 @@ 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. // // - SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. + // // - SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) // pairs 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) - // . + // refer to [Choosing a file system deployment type]. + // + // [Choosing a file system deployment type]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html // // This member is required. DeploymentType OntapDeploymentType @@ -663,12 +779,17 @@ type CreateFileSystemOntapConfiguration struct { // file system. Scale-up file systems are powered by 1 HA pair. The default value // is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The // value of this property affects the values of StorageCapacity , Iops , and - // ThroughputCapacity . For more information, see High-availability (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html) - // in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code - // 400 (Bad Request) for the following conditions: + // ThroughputCapacity . For more information, see [High-availability (HA) pairs] in the FSx for ONTAP user guide. + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the + // following conditions: + // // - The value of HAPairs is less than 1 or greater than 12. + // // - The value of HAPairs is greater than 1 and the value of DeploymentType is // SINGLE_AZ_1 or MULTI_AZ_1 . + // + // [High-availability (HA) pairs]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html HAPairs *int32 // Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in @@ -679,46 +800,68 @@ type CreateFileSystemOntapConfiguration struct { // rules for routing traffic to the correct file server. You should specify all // virtual private cloud (VPC) route tables associated with the subnets in which // your clients are located. By default, Amazon FSx selects your VPC's default - // route table. Amazon FSx manages these route tables for Multi-AZ file systems - // using tag-based authentication. These route tables are tagged with Key: - // AmazonFSx; Value: ManagedByAmazonFSx . When creating FSx for ONTAP Multi-AZ file - // systems using CloudFormation we recommend that you add the Key: AmazonFSx; - // Value: ManagedByAmazonFSx tag manually. + // route table. + // + // Amazon FSx manages these route tables for Multi-AZ file systems using tag-based + // authentication. These route tables are tagged with Key: AmazonFSx; Value: + // ManagedByAmazonFSx . When creating FSx for ONTAP Multi-AZ file systems using + // CloudFormation we recommend that you add the Key: AmazonFSx; Value: + // ManagedByAmazonFSx tag manually. RouteTableIds []string // Sets the throughput capacity for the file system that you're creating in - // megabytes per second (MBps). For more information, see Managing throughput - // capacity (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html) - // in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code - // 400 (Bad Request) for the following conditions: + // megabytes per second (MBps). For more information, see [Managing throughput capacity]in the FSx for ONTAP + // User Guide. + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the + // following conditions: + // // - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the // same value. + // // - The value of ThroughputCapacity when divided by the value of HAPairs is // outside of the valid range for ThroughputCapacity . + // + // [Managing throughput capacity]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html ThroughputCapacity *int32 // Use to choose the throughput capacity per HA pair, rather than the total - // throughput for the file system. You can define either the - // ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file - // system, but not both. This field and ThroughputCapacity are the same for - // scale-up file systems powered by one HA pair. + // throughput for the file system. + // + // You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity + // when creating a file system, but not both. + // + // This field and ThroughputCapacity are the same for scale-up file systems + // powered by one HA pair. + // // - For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, // 1024, 2048, or 4096 MBps. + // // - For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps. + // // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the // following conditions: + // // - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the // same value for file systems with one HA pair. + // // - The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / // ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12). + // // - The value of ThroughputCapacityPerHAPair is not a valid value. ThroughputCapacityPerHAPair *int32 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -731,21 +874,26 @@ 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: + // // - MULTI_AZ_1 - Creates file systems with high availability that are configured // for Multi-AZ redundancy to tolerate temporary unavailability in Availability // Zones (AZs). Multi_AZ_1 is available only in the US East (N. Virginia), US // East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), // and Europe (Ireland) Amazon Web Services Regions. + // // - SINGLE_AZ_1 - 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. + // // - 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), Asia Pacific (Singapore), // Asia Pacific (Tokyo), 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. + // + // For more information, see [Deployment type availability] and [File system performance] in the Amazon FSx for OpenZFS User Guide. + // + // [Deployment type availability]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions + // [File system performance]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance // // This member is required. DeploymentType OpenZFSDeploymentType @@ -753,10 +901,13 @@ type CreateFileSystemOpenZFSConfiguration struct { // Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in // megabytes per second (MBps). Valid values depend on the DeploymentType you // choose, as follows: + // // - For MULTI_AZ_1 and SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, // 3840, 5120, 7680, or 10240 MBps. + // // - For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or // 4096 MBps. + // // You pay for additional throughput capacity that you provision. // // This member is required. @@ -819,11 +970,17 @@ type CreateFileSystemOpenZFSConfiguration struct { // route table. RouteTableIds []string - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -851,19 +1008,28 @@ 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 - // using a DNS alias. An alias name has to meet the following requirements: + // in the request payload. + // + // For more information, see [Working with DNS Aliases] and [Walkthrough 5: Using DNS aliases to access your file system], 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 - // (-). + // + // - 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. + // + // [Walkthrough 5: Using DNS aliases to access your file system]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html + // [Working with DNS Aliases]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html Aliases []string // The configuration that Amazon FSx for Windows File Server uses to audit and log @@ -890,18 +1056,22 @@ 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) - // . + // + // For more information, see [Availability and Durability: Single-AZ and Multi-AZ File Systems]. + // + // [Availability and Durability: Single-AZ and Multi-AZ File Systems]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html DeploymentType WindowsDeploymentType // The SSD IOPS (input/output operations per second) configuration for an Amazon @@ -921,10 +1091,10 @@ type CreateFileSystemWindowsConfiguration struct { // The configuration that Amazon FSx uses to join a FSx for Windows File Server // file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed // (including on-premises) Microsoft Active Directory (AD) directory. For more - // information, see Using Amazon FSx for Windows with your self-managed Microsoft - // Active Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) - // or Managing FSx for ONTAP SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) - // . + // information, see [Using Amazon FSx for Windows with your self-managed Microsoft Active Directory]or [Managing FSx for ONTAP SVMs]. + // + // [Using Amazon FSx for Windows with your self-managed Microsoft Active Directory]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html + // [Managing FSx for ONTAP 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 @@ -962,30 +1132,38 @@ type CreateOntapVolumeConfiguration struct { 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. + // + // For more information, see [Volume types] in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Volume types]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types 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 // 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/volume-security-style) - // in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following - // values: + // control data access. For more information, see [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 This is an advanced setting. For more information, see the topic What - // the security styles and their effects are (https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html) - // in the NetApp Documentation Center. - // For more information, see Volume security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html) - // in the FSx for ONTAP User Guide. + // + // - MIXED This is an advanced setting. For more information, see the topic [What the security styles and their effects are]in + // the NetApp Documentation Center. + // + // For more information, see [Volume security style] in the FSx for ONTAP User Guide. + // + // [What the security styles and their effects are]: https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html + // [Volume security style]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html SecurityStyle SecurityStyle // Specifies the configured size of the volume, in bytes. @@ -1002,21 +1180,29 @@ type CreateOntapVolumeConfiguration 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) - // in the Amazon FSx for NetApp ONTAP User Guide. + // ONTAP CLI or REST API. + // + // For more information, see [Snapshot policies] in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Snapshot policies]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies SnapshotPolicy *string // Set to true to enable deduplication, compression, and compaction storage // efficiency features on the volume, or set to false to disable them. + // // StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType // set to RW ). StorageEfficiencyEnabled *bool @@ -1024,7 +1210,10 @@ type CreateOntapVolumeConfiguration struct { // Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx // 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: + // your access patterns. + // + // Valid tiering policies are the following: + // // - SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool // storage tier. // @@ -1040,8 +1229,9 @@ type CreateOntapVolumeConfiguration struct { // Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of // volumes that you can use for different purposes, FlexVol and FlexGroup volumes. - // For more information, see Volume styles (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-styles.html) - // in the Amazon FSx for NetApp ONTAP User Guide. + // For more information, see [Volume styles]in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Volume styles]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-styles.html VolumeStyle VolumeStyle noSmithyDocumentSerde @@ -1053,17 +1243,21 @@ type CreateOpenZFSOriginSnapshotConfiguration struct { // Specifies 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. Specify - // this option to create the volume from a snapshot on another FSx for OpenZFS file - // system. + // + // - FULL_COPY - Copies all data from the snapshot to the new volume. + // + // Specify this option to create the volume from a snapshot on another FSx for + // OpenZFS file system. + // // The INCREMENTAL_COPY option is only for updating an existing volume by using a - // snapshot from another FSx for OpenZFS file system. For more information, see - // CopySnapshotAndUpdateVolume (https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html) - // . + // snapshot from another FSx for OpenZFS file system. For more information, see [CopySnapshotAndUpdateVolume]. + // + // [CopySnapshotAndUpdateVolume]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html // // This member is required. CopyStrategy OpenZFSCopyStrategy @@ -1071,8 +1265,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. SnapshotARN *string @@ -1100,16 +1295,22 @@ type CreateOpenZFSVolumeConfiguration 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. 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. + // Amazon FSx for OpenZFS file system, see [Tips for maximizing performance]File system and volume settings in the + // Amazon FSx for OpenZFS User Guide. + // + // [Tips for maximizing performance]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs DataCompressionType OpenZFSDataCompressionType // The configuration object for mounting a Network File System (NFS) file system. @@ -1128,8 +1329,10 @@ 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) - // in the Amazon FSx for OpenZFS User Guide. + // guidance on when to set a custom record size, see [ZFS Record size]in the Amazon FSx for OpenZFS + // User Guide. + // + // [ZFS Record size]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance RecordSizeKiB *int32 // Sets the maximum storage size in gibibytes (GiB) for the volume. You can @@ -1137,9 +1340,11 @@ type CreateOpenZFSVolumeConfiguration struct { // 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) - // in the Amazon FSx for OpenZFS User Guide. + // not specify a storage capacity quota, set this to -1 . + // + // For more information, see [Volume properties] in the Amazon FSx for OpenZFS User Guide. + // + // [Volume properties]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties StorageCapacityQuotaGiB *int32 // Specifies the amount of storage in gibibytes (GiB) to reserve from the parent @@ -1147,8 +1352,9 @@ type CreateOpenZFSVolumeConfiguration struct { // 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) - // in the Amazon FSx for OpenZFS User Guide. + // information, see [Volume properties]in the Amazon FSx for OpenZFS User Guide. + // + // [Volume properties]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties StorageCapacityReservationGiB *int32 // Configures how much storage users and groups can use on the volume. @@ -1163,18 +1369,20 @@ type CreateSnaplockConfiguration struct { // Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is // set, it can't be changed. You can choose one of the following retention modes: + // // - COMPLIANCE : Files transitioned to write once, read many (WORM) on a // Compliance volume can't be deleted until their retention periods expire. This // retention mode is used to address government or industry-specific mandates or to - // protect against ransomware attacks. For more information, see SnapLock - // Compliance (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html) - // . + // protect against ransomware attacks. For more information, see [SnapLock Compliance]. + // // - ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be // deleted by authorized users before their retention periods expire using // privileged delete. This retention mode is used to advance an organization's data // integrity and internal compliance or to test retention settings before using - // SnapLock Compliance. For more information, see SnapLock Enterprise (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html) - // . + // SnapLock Compliance. For more information, see [SnapLock Enterprise]. + // + // [SnapLock Enterprise]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html + // [SnapLock Compliance]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html // // This member is required. SnaplockType SnaplockType @@ -1182,9 +1390,11 @@ type CreateSnaplockConfiguration struct { // Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. // The default value is false . If you set AuditLogVolume to true , the SnapLock // volume is created as an audit log volume. The minimum retention period for an - // audit log volume is six months. For more information, see SnapLock audit log - // volumes (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume) - // . + // audit log volume is six months. + // + // For more information, see [SnapLock audit log volumes]. + // + // [SnapLock audit log volumes]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume AuditLogVolume *bool // The configuration object for setting the autocommit period of files in an FSx @@ -1196,8 +1406,11 @@ type CreateSnaplockConfiguration struct { // administrators to delete WORM files even if they have active retention periods. // PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently // disabled on a SnapLock volume, you can't re-enable it. The default value is - // DISABLED . For more information, see Privileged delete (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete) - // . + // DISABLED . + // + // For more information, see [Privileged delete]. + // + // [Privileged delete]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete PrivilegedDelete PrivilegedDelete // Specifies the retention period of an FSx for ONTAP SnapLock volume. @@ -1205,9 +1418,11 @@ type CreateSnaplockConfiguration struct { // Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. // Volume-append mode allows you to create WORM-appendable files and write data to - // them incrementally. The default value is false . For more information, see - // Volume-append mode (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append) - // . + // them incrementally. The default value is false . + // + // For more information, see [Volume-append mode]. + // + // [Volume-append mode]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append VolumeAppendModeEnabled *bool noSmithyDocumentSerde @@ -1227,10 +1442,10 @@ type CreateSvmActiveDirectoryConfiguration struct { // The configuration that Amazon FSx uses to join a FSx for Windows File Server // file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed // (including on-premises) Microsoft Active Directory (AD) directory. For more - // information, see Using Amazon FSx for Windows with your self-managed Microsoft - // Active Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) - // or Managing FSx for ONTAP SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) - // . + // information, see [Using Amazon FSx for Windows with your self-managed Microsoft Active Directory]or [Managing FSx for ONTAP SVMs]. + // + // [Using Amazon FSx for Windows with your self-managed Microsoft Active Directory]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html + // [Managing FSx for ONTAP SVMs]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration noSmithyDocumentSerde @@ -1240,8 +1455,11 @@ 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 // // Data repository associations are supported on Amazon File Cache resources and @@ -1254,28 +1472,34 @@ 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 - // for data repositories linked to an Amazon File Cache resource. + // 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. CreationTime *time.Time - // The path to the data repository that will be linked to the cache or file - // system. + // 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/ . DataRepositoryPath *string @@ -1301,12 +1525,16 @@ type DataRepositoryAssociation struct { // 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 - // 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 - // root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you - // specify root (/) as the cache path, you can create only one DRA on the cache. + // 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 root (/) on an NFS DRA when + // DataRepositorySubdirectories is specified. If you specify root (/) as the cache + // path, you can create only one DRA on the cache. + // // The cache path cannot be set to root (/) for an S3 DRA. FileCachePath *string @@ -1319,34 +1547,44 @@ type DataRepositoryAssociation struct { // 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. + // /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 // count and maximum amount of data per file (in MiB) stored on a single physical // disk. The maximum number of disks that a single file can be striped across is - // limited by the total number of disks that make up the file system or cache. The - // default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 - // GiB). Amazon S3 objects have a maximum size of 5 TB. + // limited by the total number of disks that make up the file system or cache. + // + // The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB + // (500 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. Lifecycle DataRepositoryLifecycle @@ -1358,8 +1596,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // The configuration for an Amazon S3 data repository linked to an Amazon FSx for @@ -1373,25 +1612,30 @@ type DataRepositoryAssociation struct { } // 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 . +// 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 // 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 @@ -1416,25 +1660,31 @@ type DataRepositoryConfiguration struct { // For files imported from a data repository, this value determines the stripe // count and maximum amount of data per file (in MiB) stored on a single physical // disk. The maximum number of disks that a single file can be striped across is - // limited by the total number of disks that make up the file system. The default - // chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). - // Amazon S3 objects have a maximum size of 5 TB. + // limited by the total number of disks that make up the file system. + // + // The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB + // (500 GiB). Amazon S3 objects have a maximum size of 5 TB. 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) - // . + // information, see [Troubleshooting a Misconfigured linked S3 bucket]. + // // - 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. + // + // - FAILED - The data repository is in a terminal state that cannot be recovered. + // + // [Troubleshooting a Misconfigured linked S3 bucket]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository Lifecycle DataRepositoryLifecycle noSmithyDocumentSerde @@ -1451,16 +1701,20 @@ type DataRepositoryFailureDetails struct { } // A description of the data repository task. +// // - You use import and export data repository tasks to perform bulk transfer // operations between an Amazon FSx for Lustre file system and a linked data // repository. +// // - You use release data repository tasks to release files that have been // exported to a linked S3 bucket from your Amazon FSx for Lustre file system. +// // - An Amazon File Cache resource uses a task to automatically release files // from the cache. // -// 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 data repository tasks, see [Data Repository Tasks]. +// +// [Data Repository Tasks]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html type DataRepositoryTask struct { // The time that the resource was created, in seconds (since @@ -1470,14 +1724,21 @@ type DataRepositoryTask struct { 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. + // files the task failed to process. The DataRepositoryTaskFailureDetailsproperty 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 @@ -1493,13 +1754,17 @@ 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. + // // - RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for // Lustre file system that have been exported to a linked S3 bucket and that meet // your specified release criteria. + // // - AUTO_RELEASE_DATA tasks automatically release files from an Amazon File // Cache resource. // @@ -1526,8 +1791,10 @@ type DataRepositoryTask struct { // 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. + // data to export to the linked data repository. + // + // (Default) If Paths is not specified, Amazon FSx uses the file system root + // directory. Paths []string // The configuration that specifies the last accessed time criteria for files that @@ -1544,8 +1811,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // The time the system began processing the task. @@ -1580,8 +1848,10 @@ 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. @@ -1634,6 +1904,7 @@ 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. SkipFinalBackup *bool @@ -1726,8 +1997,11 @@ type DeleteVolumeOntapConfiguration struct { // SnapLock Enterprise volume with unexpired write once, read many (WORM) files. // The IAM permission fsx:BypassSnaplockEnterpriseRetention is also required to // delete SnapLock Enterprise volumes with unexpired WORM files. The default value - // is false . For more information, see Deleting a SnapLock volume (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html) - // . + // is false . + // + // For more information, see [Deleting a SnapLock volume]. + // + // [Deleting a SnapLock volume]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html BypassSnaplockEnterpriseRetention *bool // A list of Tag values, with a maximum of 50 elements. @@ -1771,12 +2045,15 @@ type DeleteVolumeOpenZFSConfiguration struct { // was provisioned, or the mode (by the customer or by Amazon FSx). type DiskIopsConfiguration struct { - // The total number of SSD IOPS provisioned for the file system. The minimum and - // maximum values for this property depend on the value of HAPairs and - // StorageCapacity . The minimum value is calculated as StorageCapacity * 3 * + // The total number of SSD IOPS provisioned for the file system. + // + // The minimum and maximum values for this property depend on the value of HAPairs + // and StorageCapacity . The minimum value is calculated as StorageCapacity * 3 * // HAPairs (3 IOPS per GB of StorageCapacity ). The maximum value is calculated as - // 200,000 * HAPairs . Amazon FSx responds with an HTTP status code 400 (Bad - // Request) if the value of Iops is outside of the minimum or maximum values. + // 200,000 * HAPairs . + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of + // Iops is outside of the minimum or maximum values. Iops *int64 // Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of @@ -1801,9 +2078,11 @@ type DurationSinceLastAccess struct { // was last accessed in the file system. Only exported files with a MAX(atime, // ctime, mtime) timestamp that is more than this amount of time in the past // (relative to the task create time) will be released. The default of Value is 0 . - // This is a required parameter. If an exported file meets the last accessed time - // criteria, its file or directory path must also be specified in the Paths - // parameter of the operation in order for the file to be released. + // This is a required parameter. + // + // If an exported file meets the last accessed time criteria, its file or + // directory path must also be specified in the Paths parameter of the operation + // in order for the file to be released. Value *int64 noSmithyDocumentSerde @@ -1838,17 +2117,24 @@ type FileCache struct { // 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]in the + // Key Management Service API Reference. + // + // [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html 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. Lifecycle FileCacheLifecycle @@ -1866,8 +2152,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // The storage capacity of the cache in gibibytes (GiB). @@ -1877,9 +2164,10 @@ type FileCache struct { // only one subnet ID in a call to the CreateFileCache operation. 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. + // The ID of your virtual private cloud (VPC). For more information, see [VPC and subnets] in the + // Amazon VPC User Guide. + // + // [VPC and subnets]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html VpcId *string noSmithyDocumentSerde @@ -1918,17 +2206,24 @@ type FileCacheCreating struct { // 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]in the + // Key Management Service API Reference. + // + // [Encrypt]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html 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. Lifecycle FileCacheLifecycle @@ -1946,8 +2241,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // The storage capacity of the cache in gibibytes (GiB). @@ -1960,9 +2256,10 @@ type FileCacheCreating struct { // A list of Tag values, with a maximum of 50 elements. 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. + // The ID of your virtual private cloud (VPC). For more information, see [VPC and subnets] in the + // Amazon VPC User Guide. + // + // [VPC and subnets]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html VpcId *string noSmithyDocumentSerde @@ -1971,22 +2268,27 @@ type FileCacheCreating struct { // The configuration for a data repository association (DRA) to be created during // the Amazon File Cache resource creation. The DRA links the cache to either an // Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that -// supports the NFSv3 protocol. The DRA does not support automatic import or -// automatic export. +// supports the NFSv3 protocol. +// +// The DRA does not support automatic import or automatic export. 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/ // . // @@ -1998,13 +2300,17 @@ type FileCacheDataRepositoryAssociation struct { // 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 - // 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 + // 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 // DataRepositorySubdirectories is specified. If you specify root (/) as the cache - // path, you can create only one DRA on the cache. The cache path cannot be set to - // root (/) for an S3 DRA. + // path, you can create only one DRA on the cache. + // + // The cache path cannot be set to root (/) for an S3 DRA. // // This member is required. FileCachePath *string @@ -2057,11 +2363,17 @@ type FileCacheLustreConfiguration struct { // (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 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2132,27 +2444,39 @@ type FileSystem struct { // 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. + // + // 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. Lifecycle FileSystemLifecycle @@ -2162,10 +2486,13 @@ 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]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. + // + // [Elastic Network Interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html NetworkInterfaceIds []string // The configuration for this Amazon FSx for NetApp ONTAP file system. @@ -2182,9 +2509,10 @@ type FileSystem struct { // The Amazon Resource Name (ARN) of the file system resource. ResourceARN *string - // The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds - // with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is - // outside of the minimum or maximum values. + // The storage capacity of the file system in gibibytes (GiB). + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of + // StorageCapacity is outside of the minimum or maximum values. StorageCapacity *int32 // The type of storage the file system is using. If set to SSD , the file system @@ -2196,16 +2524,18 @@ type FileSystem struct { // the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there // are two subnet IDs, one for the preferred file server and one for the standby // file server. The preferred file server subnet identified in the - // PreferredSubnetID property. All other file systems have only one subnet ID. For - // 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 property. All other file systems have only one subnet ID. + // + // For 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 . SubnetIds []string - // The tags to associate with the file system. For more information, see Tagging - // your Amazon FSx resources (https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html) - // in the Amazon FSx for Lustre User Guide. + // The tags to associate with the file system. For more information, see [Tagging your Amazon FSx resources] in the + // Amazon FSx for Lustre User Guide. + // + // [Tagging your Amazon FSx resources]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html Tags []Tag // The ID of the primary virtual private cloud (VPC) for the file system. @@ -2303,29 +2633,40 @@ type LustreFileSystemConfiguration struct { // 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) - // . + // + // For more information, see [Lustre data compression]. + // + // [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 - // repository association, see . + // 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 // The deployment type of the FSx for Lustre file system. Scratch deployment type - // is designed for temporary storage and shorter-term processing of data. SCRATCH_1 - // 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 - // longer-term storage and workloads and encryption of data in transit. - // PERSISTENT_2 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 . + // is designed for temporary storage and shorter-term processing of data. + // + // SCRATCH_1 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 longer-term + // storage and workloads and encryption of data in transit. PERSISTENT_2 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]. + // + // The default is SCRATCH_1 . + // + // [FSx for Lustre deployment options]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html DeploymentType LustreDeploymentType // The type of drive cache used by PERSISTENT_1 file systems that are provisioned @@ -2333,6 +2674,7 @@ type LustreFileSystemConfiguration struct { // When set to READ the file system has an SSD storage cache that is sized to 20% // of the file system's storage capacity. This improves the performance for // frequently accessed files by caching up to 20% of the total storage capacity. + // // This parameter is required when StorageType is set to HDD. DriveCacheType DriveCacheType @@ -2340,19 +2682,25 @@ type LustreFileSystemConfiguration struct { // for your file system to Amazon CloudWatch Logs. 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. + // 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. 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 // 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: + // 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. PerUnitStorageThroughput *int32 @@ -2375,10 +2723,15 @@ 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. // @@ -2397,32 +2750,44 @@ type LustreLogConfiguration struct { // The Lustre logging configuration used when creating or updating an Amazon FSx // for Lustre file system. An Amazon File Cache is created with Lustre logging // enabled by default, with a setting of WARN_ERROR for the logging events. which -// can't be changed. Lustre logging writes the enabled logging events for your file -// system or cache to Amazon CloudWatch Logs. +// can't be changed. +// +// Lustre logging writes the enabled logging events for your file system or cache +// to Amazon CloudWatch Logs. 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. // // This member is required. Level LustreAccessAuditLogLevel - // 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 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 . Destination *string @@ -2433,19 +2798,24 @@ type LustreLogCreateConfiguration struct { // 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]. +// +// 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. +// +// [Lustre root squash]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html 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 ). NoSquashNids []string @@ -2453,10 +2823,13 @@ type LustreRootSquashConfiguration struct { // 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. RootSquash *string @@ -2502,15 +2875,19 @@ type OntapFileSystemConfiguration struct { // 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. // // - SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. + // // - SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) // pairs 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) - // . + // refer to [Choosing Multi-AZ or Single-AZ file system deployment]. + // + // [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 @@ -2537,18 +2914,24 @@ type OntapFileSystemConfiguration struct { // Specifies how many high-availability (HA) file server pairs the file system // will have. The default value is 1. The value of this property affects the values - // of StorageCapacity , Iops , and ThroughputCapacity . For more information, see - // High-availability (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html) - // in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code - // 400 (Bad Request) for the following conditions: + // of StorageCapacity , Iops , and ThroughputCapacity . For more information, see [High-availability (HA) pairs] + // in the FSx for ONTAP user guide. + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the + // following conditions: + // // - The value of HAPairs is less than 1 or greater than 12. + // // - The value of HAPairs is greater than 1 and the value of DeploymentType is // SINGLE_AZ_1 or MULTI_AZ_1 . + // + // [High-availability (HA) pairs]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html HAPairs *int32 // 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. + // private cloud (VPC). For more information, see [VPC and subnets]in the Amazon VPC User Guide. + // + // [VPC and subnets]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html PreferredSubnetId *string // (Multi-AZ only) The VPC route tables in which your file system's endpoints are @@ -2561,26 +2944,42 @@ type OntapFileSystemConfiguration struct { // Use to choose the throughput capacity per HA pair. When the value of HAPairs is // equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput - // for the file system. This field and ThroughputCapacity cannot be defined in the - // same API call, but one is required. This field and ThroughputCapacity are the - // same for file systems with one HA pair. + // for the file system. + // + // This field and ThroughputCapacity cannot be defined in the same API call, but + // one is required. + // + // This field and ThroughputCapacity are the same for file systems with one HA + // pair. + // // - For SINGLE_AZ_1 and MULTI_AZ_1 , valid values are 128, 256, 512, 1024, 2048, // or 4096 MBps. + // // - For SINGLE_AZ_2 , valid values are 3072 or 6144 MBps. + // // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the // following conditions: + // // - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the // same value. + // // - The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / // ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12). + // // - The value of ThroughputCapacityPerHAPair is not a valid value. ThroughputCapacityPerHAPair *int32 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2604,10 +3003,12 @@ 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. + // + // - ORIGIN specifies that the volume is the origin volume for a FlexCache volume. + // // - CACHE specifies that the volume is a FlexCache volume. FlexCacheEndpointType FlexCacheEndpointType @@ -2620,10 +3021,13 @@ type OntapVolumeConfiguration struct { 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. @@ -2643,17 +3047,24 @@ 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) - // in the Amazon FSx for NetApp ONTAP User Guide. + // ONTAP CLI or REST API. + // + // For more information, see [Snapshot policies] in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Snapshot policies]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies SnapshotPolicy *string // The volume's storage efficiency setting. @@ -2665,9 +3076,11 @@ type OntapVolumeConfiguration struct { // 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 - // which volumes to delete before you can delete the SVM. + // 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 which + // volumes to delete before you can delete the SVM. StorageVirtualMachineRoot *bool // The volume's TieringPolicy setting. @@ -2677,8 +3090,9 @@ type OntapVolumeConfiguration struct { UUID *string // Use to specify the style of an ONTAP volume. For more information about - // FlexVols and FlexGroups, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html) - // in Amazon FSx for NetApp ONTAP User Guide. + // FlexVols and FlexGroups, see [Volume types]in Amazon FSx for NetApp ONTAP User Guide. + // + // [Volume types]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html VolumeStyle VolumeStyle noSmithyDocumentSerde @@ -2697,15 +3111,19 @@ type OpenZFSClientConfiguration struct { 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: + // you can use with Network File System (NFS), see the [exports(5) - Linux man page]. 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. // + // [exports(5) - Linux man page]: https://linux.die.net/man/5/exports + // // This member is required. Options []string @@ -2726,10 +3144,13 @@ type OpenZFSCreateRootVolumeConfiguration 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. @@ -2748,8 +3169,9 @@ 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) - // in the Amazon FSx for OpenZFS User Guide. + // [Tips for maximizing performance]in the Amazon FSx for OpenZFS User Guide. + // + // [Tips for maximizing performance]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs RecordSizeKiB *int32 // An object specifying how much storage users or groups can use on the volume. @@ -2826,11 +3248,17 @@ type OpenZFSFileSystemConfiguration struct { // (MBps). ThroughputCapacity *int32 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -2854,30 +3282,36 @@ 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. + // // The INCREMENTAL_COPY option is only for updating an existing volume by using a - // snapshot from another FSx for OpenZFS file system. For more information, see - // CopySnapshotAndUpdateVolume (https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html) - // . + // snapshot from another FSx for OpenZFS file system. For more information, see [CopySnapshotAndUpdateVolume]. + // + // [CopySnapshotAndUpdateVolume]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html SnapshotARN *string noSmithyDocumentSerde } // Used to configure quotas that define how much storage a user or group can use -// on an FSx for OpenZFS volume. For more information, see Volume properties (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) -// in the FSx for OpenZFS User Guide. +// on an FSx for OpenZFS volume. For more information, see [Volume properties]in the FSx for OpenZFS +// User Guide. +// +// [Volume properties]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties type OpenZFSUserOrGroupQuota struct { // The ID of the user or group that the quota applies to. @@ -2903,17 +3337,21 @@ type OpenZFSVolumeConfiguration struct { // Specifies 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. Specify - // this option to create the volume from a snapshot on another FSx for OpenZFS file - // system. + // + // - FULL_COPY - Copies all data from the snapshot to the new volume. + // + // Specify this option to create the volume from a snapshot on another FSx for + // OpenZFS file system. + // // The INCREMENTAL_COPY option is only for updating an existing volume by using a - // snapshot from another FSx for OpenZFS file system. For more information, see - // CopySnapshotAndUpdateVolume (https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html) - // . + // snapshot from another FSx for OpenZFS file system. For more information, see [CopySnapshotAndUpdateVolume]. + // + // [CopySnapshotAndUpdateVolume]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html CopyStrategy OpenZFSCopyStrategy // A Boolean value indicating whether tags for the volume should be copied to @@ -2926,10 +3364,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. @@ -2978,8 +3419,9 @@ type OpenZFSVolumeConfiguration 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html SourceSnapshotARN *string // The maximum amount of storage in gibibtyes (GiB) that the volume can use from @@ -3006,15 +3448,17 @@ type OpenZFSVolumeConfiguration struct { // system. Only files that were last accessed before this point-in-time can be // released. For example, if you specify a last accessed time criteria of 9 days, // only files that were last accessed 9.00001 or more days ago can be released. -// Only file data that has been exported to S3 can be released. Files that have not -// yet been exported to S3, such as new or changed files that have not been +// +// Only file data that has been exported to S3 can be released. Files that have +// not yet been exported to S3, such as new or changed files that have not been // exported, are not eligible for release. When files are released, their metadata // stays on the file system, so they can still be accessed later. Users and // applications can access a released file by reading the file again, which -// restores data from Amazon S3 to the FSx for Lustre file system. If a file meets -// the last accessed time criteria, its file or directory path must also be -// specified with the Paths parameter of the operation in order for the file to be -// released. +// restores data from Amazon S3 to the FSx for Lustre file system. +// +// If a file meets the last accessed time criteria, its file or directory path +// must also be specified with the Paths parameter of the operation in order for +// the file to be released. type ReleaseConfiguration struct { // Defines the point-in-time since an exported file was last accessed, in order @@ -3027,9 +3471,11 @@ type ReleaseConfiguration struct { // Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is // set, it can't be changed. Files can't be deleted or modified during the -// retention period. For more information, see Working with the retention period -// in SnapLock (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html) -// . +// retention period. +// +// For more information, see [Working with the retention period in SnapLock]. +// +// [Working with the retention period in SnapLock]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html type RetentionPeriod struct { // Defines the type of time for the retention period of an FSx for ONTAP SnapLock @@ -3043,11 +3489,17 @@ type RetentionPeriod struct { // Defines the amount of time for the retention period of an FSx for ONTAP // SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED . For all // other options, the following ranges are valid: + // // - Seconds : 0 - 65,535 + // // - Minutes : 0 - 65,535 + // // - Hours : 0 - 24 + // // - Days : 0 - 365 + // // - Months : 0 - 12 + // // - Years : 0 - 100 Value *int32 @@ -3060,9 +3512,11 @@ type RetentionPeriod struct { // repository are automatically imported to the file system and an AutoExportPolicy // that defines which file events on the file system are automatically exported to // the data repository. File events are when files or directories are added, -// changed, or deleted on the file system or the data repository. Data repository -// associations on Amazon File Cache don't use S3DataRepositoryConfiguration -// because they don't support automatic import or automatic export. +// changed, or deleted on the file system or the data repository. +// +// Data repository associations on Amazon File Cache don't use +// S3DataRepositoryConfiguration because they don't support automatic import or +// automatic export. type S3DataRepositoryConfiguration struct { // Specifies the type of updated objects (new, changed, deleted) that will be @@ -3107,10 +3561,10 @@ type SelfManagedActiveDirectoryAttributes struct { // The configuration that Amazon FSx uses to join a FSx for Windows File Server // file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed // (including on-premises) Microsoft Active Directory (AD) directory. For more -// information, see Using Amazon FSx for Windows with your self-managed Microsoft -// Active Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) -// or Managing FSx for ONTAP SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) -// . +// information, see [Using Amazon FSx for Windows with your self-managed Microsoft Active Directory]or [Managing FSx for ONTAP SVMs]. +// +// [Using Amazon FSx for Windows with your self-managed Microsoft Active Directory]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html +// [Managing FSx for ONTAP 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 @@ -3151,10 +3605,13 @@ type SelfManagedActiveDirectoryConfiguration struct { // (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 - // 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. + // To learn more, see [RFC 2253]. 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. + // + // [RFC 2253]: https://tools.ietf.org/html/rfc2253 OrganizationalUnitDistinguishedName *string noSmithyDocumentSerde @@ -3187,6 +3644,7 @@ type SelfManagedActiveDirectoryConfigurationUpdates struct { // Specifies the updated user name for the service account on your self-managed AD // domain. Amazon FSx uses this account to join to your self-managed AD domain. + // // This account must have the permissions required to join computers to the domain // in the organizational unit provided in OrganizationalUnitDistinguishedName . UserName *string @@ -3200,9 +3658,11 @@ type SnaplockConfiguration struct { // Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. // The default value is false . If you set AuditLogVolume to true , the SnapLock // volume is created as an audit log volume. The minimum retention period for an - // audit log volume is six months. For more information, see SnapLock audit log - // volumes (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume) - // . + // audit log volume is six months. + // + // For more information, see [SnapLock audit log volumes]. + // + // [SnapLock audit log volumes]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume AuditLogVolume *bool // The configuration object for setting the autocommit period of files in an FSx @@ -3214,9 +3674,11 @@ type SnaplockConfiguration struct { // administrators to delete write once, read many (WORM) files even if they have // active retention periods. PERMANENTLY_DISABLED is a terminal state. If // privileged delete is permanently disabled on a SnapLock volume, you can't - // re-enable it. The default value is DISABLED . For more information, see - // Privileged delete (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete) - // . + // re-enable it. The default value is DISABLED . + // + // For more information, see [Privileged delete]. + // + // [Privileged delete]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete PrivilegedDelete PrivilegedDelete // Specifies the retention period of an FSx for ONTAP SnapLock volume. @@ -3224,25 +3686,29 @@ type SnaplockConfiguration struct { // Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is // set, it can't be changed. You can choose one of the following retention modes: + // // - COMPLIANCE : Files transitioned to write once, read many (WORM) on a // Compliance volume can't be deleted until their retention periods expire. This // retention mode is used to address government or industry-specific mandates or to - // protect against ransomware attacks. For more information, see SnapLock - // Compliance (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html) - // . + // protect against ransomware attacks. For more information, see [SnapLock Compliance]. + // // - ENTERPRISE : Files transitioned to WORM on an Enterprise volume can be // deleted by authorized users before their retention periods expire using // privileged delete. This retention mode is used to advance an organization's data // integrity and internal compliance or to test retention settings before using - // SnapLock Compliance. For more information, see SnapLock Enterprise (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html) - // . + // SnapLock Compliance. For more information, see [SnapLock Enterprise]. + // + // [SnapLock Enterprise]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html + // [SnapLock Compliance]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html SnaplockType SnaplockType // Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. // Volume-append mode allows you to create WORM-appendable files and write data to - // them incrementally. The default value is false . For more information, see - // Volume-append mode (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append) - // . + // them incrementally. The default value is false . + // + // For more information, see [Volume-append mode]. + // + // [Volume-append mode]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append VolumeAppendModeEnabled *bool noSmithyDocumentSerde @@ -3250,8 +3716,9 @@ type SnaplockConfiguration struct { // The configuration to set the retention period of an FSx for ONTAP SnapLock // volume. The retention period includes default, maximum, and minimum settings. -// For more information, see Working with the retention period in SnapLock (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html) -// . +// For more information, see [Working with the retention period in SnapLock]. +// +// [Working with the retention period in SnapLock]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html type SnaplockRetentionPeriod struct { // The retention period assigned to a write once, read many (WORM) file by default @@ -3290,9 +3757,13 @@ type Snapshot struct { 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. Lifecycle SnapshotLifecycle @@ -3305,8 +3776,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // The ID of the snapshot. @@ -3356,11 +3828,17 @@ type StorageVirtualMachine struct { 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. Lifecycle StorageVirtualMachineLifecycle @@ -3373,8 +3851,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // The security style of the root volume of the SVM. @@ -3486,7 +3965,9 @@ type Tag struct { // Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx // 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: +// your access patterns. +// +// Valid tiering policies are the following: // // - SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool // storage tier. @@ -3509,11 +3990,15 @@ type TieringPolicy struct { // 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. Name TieringPolicyName @@ -3524,11 +4009,17 @@ 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 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3538,24 +4029,29 @@ type UpdateFileCacheLustreConfiguration struct { // UpdateFileSystem operation. type UpdateFileSystemLustreConfiguration struct { - // (Optional) When you create your file system, your existing S3 objects appear as - // file and directory listings. Use this property to choose how Amazon FSx keeps + // (Optional) When you create your file system, your existing S3 objects appear + // as 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. AutoImportPolicy AutoImportPolicyType @@ -3572,11 +4068,17 @@ type UpdateFileSystemLustreConfiguration struct { // 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) - // . + // compression configuration. + // + // For more information, see [Lustre data compression]. + // + // [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 @@ -3588,12 +4090,16 @@ type UpdateFileSystemLustreConfiguration struct { // measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or // decrease your file system's throughput. Valid values depend on the deployment // type of the file system, as follows: + // // - For PERSISTENT_1 SSD-based deployment types, valid values are 50, 100, and // 200 MB/s/TiB. + // // - For PERSISTENT_2 SSD-based deployment types, valid values are 125, 250, 500, // and 1000 MB/s/TiB. - // For more information, see Managing throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-throughput-capacity.html) - // . + // + // For more information, see [Managing throughput capacity]. + // + // [Managing throughput capacity]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-throughput-capacity.html PerUnitStorageThroughput *int32 // The Lustre root squash configuration used when updating an Amazon FSx for @@ -3631,15 +4137,16 @@ type UpdateFileSystemOntapConfiguration struct { // capacity, but you can provision additional IOPS per GB of storage. The // 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. - // For more information, see Updating SSD storage capacity and IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/increase-primary-storage.html) - // . + // For more information, see [Updating SSD storage capacity and IOPS]. + // + // [Updating SSD storage capacity and IOPS]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/increase-primary-storage.html DiskIopsConfiguration *DiskIopsConfiguration // Update the password for the fsxadmin user by entering a new password. You use // the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your - // file system resources. For more information, see Managing resources using - // NetApp Applicaton (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html) - // . + // file system resources. For more information, see [Managing resources using NetApp Applicaton]. + // + // [Managing resources using NetApp Applicaton]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html FsxAdminPassword *string // (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route @@ -3649,37 +4156,58 @@ type UpdateFileSystemOntapConfiguration struct { RemoveRouteTableIds []string // Enter a new value to change the amount of throughput capacity for the file - // system in megabytes per second (MBps). For more information, see Managing - // throughput capacity (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html) - // in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code - // 400 (Bad Request) for the following conditions: + // system in megabytes per second (MBps). For more information, see [Managing throughput capacity]in the FSx for + // ONTAP User Guide. + // + // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the + // following conditions: + // // - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the // same value. + // // - The value of ThroughputCapacity when divided by the value of HAPairs is // outside of the valid range for ThroughputCapacity . + // + // [Managing throughput capacity]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html ThroughputCapacity *int32 // Use to choose the throughput capacity per HA pair, rather than the total - // throughput for the file system. This field and ThroughputCapacity cannot be - // defined in the same API call, but one is required. This field and - // ThroughputCapacity are the same for file systems with one HA pair. + // throughput for the file system. + // + // This field and ThroughputCapacity cannot be defined in the same API call, but + // one is required. + // + // This field and ThroughputCapacity are the same for file systems with one HA + // pair. + // // - For SINGLE_AZ_1 and MULTI_AZ_1 , valid values are 128, 256, 512, 1024, 2048, // or 4096 MBps. + // // - For SINGLE_AZ_2 , valid values are 3072 or 6144 MBps. + // // Amazon FSx responds with an HTTP status code 400 (Bad Request) for the // following conditions: + // // - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the // same value for file systems with one HA pair. + // // - The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / // ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12). + // // - The value of ThroughputCapacityPerHAPair is not a valid value. ThroughputCapacityPerHAPair *int32 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3736,17 +4264,25 @@ 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 MULTI_AZ_1 and 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. ThroughputCapacity *int32 - // 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. + // 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]. + // + // 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. + // + // [the ISO-8601 spec as described on Wikipedia]: https://en.wikipedia.org/wiki/ISO_week_date WeeklyMaintenanceStartTime *string noSmithyDocumentSerde @@ -3764,9 +4300,9 @@ type UpdateFileSystemWindowsConfiguration 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 30 . For more information, see Working with Automatic - // Daily Backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups) - // . + // days. The default is 30 . For more information, see [Working with Automatic Daily Backups]. + // + // [Working with Automatic Daily 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, @@ -3790,8 +4326,9 @@ type UpdateFileSystemWindowsConfiguration struct { // 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) - // . + // information, see [Managing Throughput Capacity]. + // + // [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 @@ -3834,17 +4371,24 @@ 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) - // in the Amazon FSx for NetApp ONTAP User Guide. + // ONTAP CLI or REST API. + // + // For more information, see [Snapshot policies] in the Amazon FSx for NetApp ONTAP User Guide. + // + // [Snapshot policies]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies SnapshotPolicy *string // Default is false . Set to true to enable the deduplication, compression, and @@ -3863,10 +4407,13 @@ 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. @@ -3883,8 +4430,9 @@ type UpdateOpenZFSVolumeConfiguration 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 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. + // see [Tips for maximizing performance]in the Amazon FSx for OpenZFS User Guide. + // + // [Tips for maximizing performance]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs RecordSizeKiB *int32 // The maximum amount of storage in gibibytes (GiB) that the volume can use from @@ -3910,9 +4458,11 @@ type UpdateSnaplockConfiguration struct { // Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. // The default value is false . If you set AuditLogVolume to true , the SnapLock // volume is created as an audit log volume. The minimum retention period for an - // audit log volume is six months. For more information, see SnapLock audit log - // volumes (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume) - // . + // audit log volume is six months. + // + // For more information, see [SnapLock audit log volumes]. + // + // [SnapLock audit log volumes]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume AuditLogVolume *bool // The configuration object for setting the autocommit period of files in an FSx @@ -3924,9 +4474,11 @@ type UpdateSnaplockConfiguration struct { // administrators to delete write once, read many (WORM) files even if they have // active retention periods. PERMANENTLY_DISABLED is a terminal state. If // privileged delete is permanently disabled on a SnapLock volume, you can't - // re-enable it. The default value is DISABLED . For more information, see - // Privileged delete (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete) - // . + // re-enable it. The default value is DISABLED . + // + // For more information, see [Privileged delete]. + // + // [Privileged delete]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete PrivilegedDelete PrivilegedDelete // Specifies the retention period of an FSx for ONTAP SnapLock volume. @@ -3934,9 +4486,11 @@ type UpdateSnaplockConfiguration struct { // Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. // Volume-append mode allows you to create WORM-appendable files and write data to - // them incrementally. The default value is false . For more information, see - // Volume-append mode (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append) - // . + // them incrementally. The default value is false . + // + // For more information, see [Volume-append mode]. + // + // [Volume-append mode]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append VolumeAppendModeEnabled *bool noSmithyDocumentSerde @@ -3975,12 +4529,19 @@ type Volume struct { 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. Lifecycle VolumeLifecycle @@ -3999,8 +4560,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceARN *string // A list of Tag values, with a maximum of 50 elements. @@ -4032,26 +4594,35 @@ 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]. +// +// [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. // // 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. // // This member is required. @@ -4059,12 +4630,15 @@ type WindowsAuditLogConfiguration struct { // The Amazon Resource Name (ARN) for 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. The name of the Amazon CloudWatch Logs log - // group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data - // Firehose delivery stream must begin with the aws-fsx prefix. The destination - // ARN (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. + // Data Firehose delivery stream ARN. + // + // The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx + // prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin + // with the aws-fsx prefix. + // + // The destination ARN (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. AuditLogDestination *string noSmithyDocumentSerde @@ -4075,40 +4649,54 @@ type WindowsAuditLogConfiguration struct { 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. // // 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. // // 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 Firehose 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 @@ -4130,8 +4718,9 @@ 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]. + // + // [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 @@ -4156,16 +4745,21 @@ 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) - // . + // + // For more information, see [Single-AZ and Multi-AZ File Systems]. + // + // [Single-AZ and Multi-AZ File Systems]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html DeploymentType WindowsDeploymentType // The SSD IOPS (input/output operations per second) configuration for an Amazon @@ -4179,31 +4773,38 @@ type WindowsFileSystemConfiguration struct { MaintenanceOperationsInProgress []FileSystemMaintenanceOperation // For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, - // file server. Use this IP address when mounting the file system on Linux SMB - // clients or Windows SMB clients that are not joined to a Microsoft Active - // Directory. Applicable for all Windows file system deployment types. This IP - // 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) - // . + // file server. + // + // Use this IP address when mounting the file system on Linux SMB clients or + // Windows SMB clients that are not joined to a Microsoft Active Directory. + // Applicable for all Windows file system deployment types. This IP 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]. + // + // [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 - // 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) - // . + // 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 more information, see [Availability and durability: Single-AZ and Multi-AZ file systems]. + // + // [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 PreferredSubnetId *string // For MULTI_AZ_1 deployment types, use this endpoint when performing - // administrative tasks on the file system using Amazon FSx Remote PowerShell. For - // SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file - // system. This endpoint is temporarily unavailable when the file system is - // undergoing maintenance. + // administrative tasks on the file system using Amazon FSx Remote PowerShell. + // + // For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the + // file system. + // + // This endpoint is temporarily unavailable when the file system is undergoing + // maintenance. RemoteAdministrationEndpoint *string // The configuration of the self-managed Microsoft Active Directory (AD) directory diff --git a/service/gamelift/api_op_AcceptMatch.go b/service/gamelift/api_op_AcceptMatch.go index 9e0ec5aa26c..2a6d5a2a9bc 100644 --- a/service/gamelift/api_op_AcceptMatch.go +++ b/service/gamelift/api_op_AcceptMatch.go @@ -14,25 +14,37 @@ import ( // Registers a player's acceptance or rejection of a proposed FlexMatch match. A // matchmaking configuration may require player acceptance; if so, then matches // 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 -// players in each ticket. Calls to this action are only valid for tickets that are -// in this status; calls for tickets not in this status result in an error. To -// register acceptance, specify the ticket ID, one or more players, and an +// 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 players in each ticket. Calls to this +// action are only valid for tickets that are in this status; calls for tickets not +// in this status result in an error. +// +// To register acceptance, specify the ticket ID, one or more players, and an // acceptance response. When all players have accepted, Amazon GameLift advances // the matchmaking tickets to status PLACING , and attempts to create a new game -// session for the match. If any player rejects the match, or if acceptances are -// not received before a specified timeout, the proposed match is dropped. Each -// matchmaking ticket in the failed match is handled as follows: +// session for the match. +// +// If any player rejects the match, or if acceptances are not received before a +// specified timeout, the proposed match is dropped. Each matchmaking ticket in the +// failed match is handled as follows: +// // - If the ticket has one or more players who rejected the match or failed to // respond, the ticket status is set CANCELLED and processing is terminated. +// // - If all players in the ticket accepted the match, the ticket status is // returned to SEARCHING to find a new match. // -// 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) +// # Learn more +// +// [Add FlexMatch to a game client] +// +// [FlexMatch events](reference) +// +// [FlexMatch events]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html +// [Add FlexMatch to a game client]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html func (c *Client) AcceptMatch(ctx context.Context, params *AcceptMatchInput, optFns ...func(*Options)) (*AcceptMatchOutput, error) { if params == nil { params = &AcceptMatchInput{} diff --git a/service/gamelift/api_op_ClaimGameServer.go b/service/gamelift/api_op_ClaimGameServer.go index 5933615bf62..2294a4f1635 100644 --- a/service/gamelift/api_op_ClaimGameServer.go +++ b/service/gamelift/api_op_ClaimGameServer.go @@ -11,33 +11,47 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Locates an available game server and temporarily reserves it to -// host gameplay and players. This operation is called from a game client or client -// service (such as a matchmaker) to request hosting resources for a new game -// session. In response, Amazon GameLift FleetIQ locates an available game server, -// places it in CLAIMED status for 60 seconds, and returns connection information -// that players can use to connect to the game server. To claim a game server, -// identify a game server group. You can also specify a game server ID, although -// this approach bypasses Amazon GameLift FleetIQ placement optimization. -// Optionally, include game data to pass to the game server at the start of a game -// session, such as a game map or player information. Add filter options to further -// restrict how a game server is chosen, such as only allowing game servers on -// ACTIVE instances to be claimed. 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 -// 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: +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Locates an available game server and temporarily reserves it to host gameplay +// and players. This operation is called from a game client or client service (such +// as a matchmaker) to request hosting resources for a new game session. In +// response, Amazon GameLift FleetIQ locates an available game server, places it in +// CLAIMED status for 60 seconds, and returns connection information that players +// can use to connect to the game server. +// +// To claim a game server, identify a game server group. You can also specify a +// game server ID, although this approach bypasses Amazon GameLift FleetIQ +// placement optimization. Optionally, include game data to pass to the game server +// at the start of a game session, such as a game map or player information. Add +// filter options to further restrict how a game server is chosen, such as only +// allowing game servers on ACTIVE instances to be claimed. +// +// 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 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 is running on an instance in DRAINING status and the // provided filter option does not allow placing on DRAINING instances. // -// Learn more Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// # Learn more +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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{} diff --git a/service/gamelift/api_op_CreateAlias.go b/service/gamelift/api_op_CreateAlias.go index 98b1240e1e9..f31645f69cd 100644 --- a/service/gamelift/api_op_CreateAlias.go +++ b/service/gamelift/api_op_CreateAlias.go @@ -14,16 +14,25 @@ import ( // Creates an alias for a fleet. In most situations, you can use an alias ID in // place of a fleet ID. An alias provides a level of abstraction for a fleet that // is useful when redirecting player traffic from one fleet to another, such as -// when updating your game build. Amazon GameLift supports two types of routing -// strategies for aliases: simple and terminal. A simple alias points to an active -// fleet. A terminal alias is used to display messaging or link to a URL instead of -// routing players to an active fleet. For example, you might use a terminal alias -// when a game version is no longer supported and you want to direct players to an -// upgrade site. To create a fleet alias, specify an alias name, routing strategy, -// 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) +// when updating your game build. +// +// Amazon GameLift supports two types of routing strategies for aliases: simple +// and terminal. A simple alias points to an active fleet. A terminal alias is used +// to display messaging or link to a URL instead of routing players to an active +// fleet. For example, you might use a terminal alias when a game version is no +// longer supported and you want to direct players to an upgrade site. +// +// To create a fleet alias, specify an alias name, routing strategy, 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] +// +// [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{} @@ -59,8 +68,9 @@ type CreateAliasInput struct { // 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. + // information, see [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateBuild.go b/service/gamelift/api_op_CreateBuild.go index d20eb3f5d2d..2470082dbd9 100644 --- a/service/gamelift/api_op_CreateBuild.go +++ b/service/gamelift/api_op_CreateBuild.go @@ -12,31 +12,46 @@ 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 Amazon 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 -// file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a -// new build resource. You can use the CreateBuild operation in the following -// scenarios: +// Combine game server binaries into a zip file for use with Amazon GameLift. +// +// When setting up a new game build for Amazon GameLift, we recommend using the +// CLI command [upload-build]. This helper command combines two tasks: (1) it uploads your build +// files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it +// creates a new build resource. +// +// You can use the CreateBuild operation in the following scenarios: +// // - 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. +// // - Upload your build files to a Amazon 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 Amazon -// GameLift Amazon S3 location, you can't update them. +// specified Amazon S3 location. For more information, see [Uploading Objects]in the Amazon S3 +// Developer Guide. After you upload build files to the Amazon 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) +// you can create fleets with it. +// +// # Learn more +// +// [Uploading Your Game] +// +// [Create a Build with Files in Amazon S3] +// +// [All APIs by task] +// +// [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 +// [Uploading Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html +// [Uploading Your Game]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html +// [upload-build]: https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html +// [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{} @@ -62,17 +77,19 @@ type CreateBuildInput struct { // determines the type of fleet resources that you use for this build. If your game // build contains multiple executables, they all must run on the same operating // system. You must specify a valid operating system in this request. There is no - // default value. You can't change a build's operating system later. If you have - // active fleets using the Windows Server 2012 operating system, you can continue - // to create new builds using this OS until October 10, 2023, when Microsoft ends - // its support. All others must use Windows Server 2016 when creating new - // Windows-based builds. + // default value. You can't change a build's operating system later. + // + // If you have active fleets using the Windows Server 2012 operating system, you + // can continue to create new builds using this OS until October 10, 2023, when + // Microsoft ends its support. All others must use Windows Server 2016 when + // creating new Windows-based builds. OperatingSystem types.OperatingSystem // A server SDK version you used when integrating your game server build with - // Amazon GameLift. For more information see Integrate games with custom game - // servers (https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html) - // . By default Amazon GameLift sets this value to 4.0.2 . + // Amazon GameLift. For more information see [Integrate games with custom game servers]. By default Amazon GameLift sets + // this value to 4.0.2 . + // + // [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 @@ -80,21 +97,24 @@ type CreateBuildInput struct { // that you own. The storage location must specify an Amazon S3 bucket name and // key. The location must also specify a role ARN that you set up to allow Amazon // GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must - // be in the same Region. If a StorageLocation is specified, the size of your file - // can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk - // of 0. + // be in the same Region. + // + // If a StorageLocation is specified, the size of your file can be found in your + // Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk 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) - // 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. + // information, see [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference. Once the + // resource is created, you can use [TagResource], [UntagResource], and [ListTagsForResource] 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. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html + // [TagResource]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html + // [ListTagsForResource]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html Tags []types.Tag // Version information associated with a build or script. Version strings don't @@ -115,8 +135,9 @@ 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]. + // + // [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_CreateContainerGroupDefinition.go b/service/gamelift/api_op_CreateContainerGroupDefinition.go index 074bc9707cf..bc0d2b91f7c 100644 --- a/service/gamelift/api_op_CreateContainerGroupDefinition.go +++ b/service/gamelift/api_op_CreateContainerGroupDefinition.go @@ -11,19 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift containers feature, which is -// currently in public preview. Creates a ContainerGroupDefinition resource that -// describes a set of containers for hosting your game server with Amazon GameLift -// managed EC2 hosting. An Amazon GameLift container group is similar to a -// container "task" and "pod". Each container group can have one or more -// containers. Use container group definitions when you create a container fleet. -// Container group definitions determine how Amazon GameLift deploys your -// containers to each instance in a container fleet. You can create two types of -// container groups, based on scheduling strategy: +// This operation is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Creates a ContainerGroupDefinition resource that describes a set of containers +// for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon +// GameLift container group is similar to a container "task" and "pod". Each +// container group can have one or more containers. +// +// Use container group definitions when you create a container fleet. Container +// group definitions determine how Amazon GameLift deploys your containers to each +// instance in a container fleet. +// +// You can create two types of container groups, based on scheduling strategy: +// // - A replica container group manages the containers that run your game server // application and supporting software. Replica container groups might be // replicated multiple times on each fleet instance, depending on instance // resources. +// // - A daemon container group manages containers that run other software, such // as background services, logging, or test processes. You might use a daemon // container group for processes that need to run only once per fleet instance, or @@ -33,16 +40,28 @@ import ( // container definitions, and maximum total CPU and memory requirements for the // container group. Specify an operating system and scheduling strategy or use the // default values. When using the Amazon Web Services CLI tool, you can pass in -// your container definitions as a JSON file. This operation requires Identity and -// Access Management (IAM) permissions to access container images in Amazon ECR -// repositories. See IAM permissions for Amazon GameLift (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html) -// for help setting the appropriate permissions. If successful, this operation -// creates a new ContainerGroupDefinition resource with an ARN value assigned. You -// can't change the properties of a container group definition. Instead, create a -// new one. Learn more -// - Create a container group definition (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html) -// - Container fleet design guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html) -// - Create a container definition as a JSON file (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-definitions.html#containers-definitions-create) +// your container definitions as a JSON file. +// +// This operation requires Identity and Access Management (IAM) permissions to +// access container images in Amazon ECR repositories. See [IAM permissions for Amazon GameLift]for help setting the +// appropriate permissions. +// +// If successful, this operation creates a new ContainerGroupDefinition resource +// with an ARN value assigned. You can't change the properties of a container group +// definition. Instead, create a new one. +// +// # Learn more +// +// [Create a container group definition] +// +// [Container fleet design guide] +// +// [Create a container definition as a JSON file] +// +// [Create a container definition as a JSON file]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-definitions.html#containers-definitions-create +// [Create a container group definition]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html +// [IAM permissions for Amazon GameLift]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html +// [Container fleet design guide]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html func (c *Client) CreateContainerGroupDefinition(ctx context.Context, params *CreateContainerGroupDefinitionInput, optFns ...func(*Options)) (*CreateContainerGroupDefinitionOutput, error) { if params == nil { params = &CreateContainerGroupDefinitionInput{} @@ -62,8 +81,9 @@ type CreateContainerGroupDefinitionInput struct { // Definitions for all containers in this group. Each container definition // identifies the container image and specifies configuration settings for the - // container. See the Container fleet design guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html) - // for container guidelines. + // container. See the [Container fleet design guide]for container guidelines. + // + // [Container fleet design guide]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet.html // // This member is required. ContainerDefinitions []types.ContainerDefinitionInput @@ -108,8 +128,9 @@ type CreateContainerGroupDefinitionInput struct { // A list of labels to assign to the container group definition 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]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateFleet.go b/service/gamelift/api_op_CreateFleet.go index c6851da016d..34da4e69989 100644 --- a/service/gamelift/api_op_CreateFleet.go +++ b/service/gamelift/api_op_CreateFleet.go @@ -11,65 +11,111 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Creates a fleet of compute -// resources to host your game servers. Use this operation to set up the following -// types of fleets based on compute type: Managed EC2 fleet An EC2 fleet is a set -// of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build -// is deployed to each fleet instance. Amazon GameLift manages the fleet's -// instances and controls the lifecycle of game server processes, which host game -// sessions for players. EC2 fleets can have instances in multiple locations. Each -// instance in the fleet is designated a Compute . To create an EC2 fleet, provide -// these required parameters: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Creates a fleet of compute resources to host your game servers. Use this +// operation to set up the following types of fleets based on compute type: +// +// # Managed EC2 fleet +// +// An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. +// Your game server build is deployed to each fleet instance. Amazon GameLift +// manages the fleet's instances and controls the lifecycle of game server +// processes, which host game sessions for players. EC2 fleets can have instances +// in multiple locations. Each instance in the fleet is designated a Compute . +// +// To create an EC2 fleet, provide these required parameters: +// // - Either BuildId or ScriptId +// // - ComputeType set to EC2 (the default value) +// // - EC2InboundPermissions +// // - EC2InstanceType +// // - FleetType +// // - Name +// // - RuntimeConfiguration with at least one ServerProcesses configuration // // If successful, this operation creates a new fleet resource and places it in NEW -// status while Amazon GameLift initiates the fleet creation workflow (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow) -// . To debug your fleet, fetch logs, view performance metrics or other actions on -// the fleet, create a development fleet with port 22/3389 open. As a best -// practice, we recommend opening ports for remote access only when you need them -// and closing them when you're finished. When the fleet status is ACTIVE, you can -// adjust capacity settings and turn autoscaling on/off for each location. Managed -// container fleet A container fleet is a set of Amazon Elastic Compute Cloud -// (Amazon EC2) instances. Your container architecture is deployed to each fleet -// instance based on the fleet configuration. Amazon GameLift manages the -// containers on each fleet instance and controls the lifecycle of game server -// processes, which host game sessions for players. Container fleets can have -// instances in multiple locations. Each container on an instance that runs game -// server processes is registered as a Compute . To create a container fleet, -// provide these required parameters: +// status while Amazon GameLift initiates the [fleet creation workflow]. To debug your fleet, fetch logs, +// view performance metrics or other actions on the fleet, create a development +// fleet with port 22/3389 open. As a best practice, we recommend opening ports for +// remote access only when you need them and closing them when you're finished. +// +// When the fleet status is ACTIVE, you can adjust capacity settings and turn +// autoscaling on/off for each location. +// +// # Managed container fleet +// +// A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) +// instances. Your container architecture is deployed to each fleet instance based +// on the fleet configuration. Amazon GameLift manages the containers on each fleet +// instance and controls the lifecycle of game server processes, which host game +// sessions for players. Container fleets can have instances in multiple locations. +// Each container on an instance that runs game server processes is registered as a +// Compute . +// +// To create a container fleet, provide these required parameters: +// // - ComputeType set to CONTAINER +// // - ContainerGroupsConfiguration +// // - EC2InboundPermissions +// // - EC2InstanceType +// // - FleetType set to ON_DEMAND +// // - Name +// // - RuntimeConfiguration with at least one ServerProcesses configuration // // If successful, this operation creates a new fleet resource and places it in NEW -// status while Amazon GameLift initiates the fleet creation workflow (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow) -// . When the fleet status is ACTIVE, you can adjust capacity settings and turn -// autoscaling on/off for each location. Anywhere fleet An Anywhere fleet -// represents compute resources that are not owned or managed by Amazon GameLift. -// You might create an Anywhere fleet with your local machine for testing, or use -// one to host game servers with on-premises hardware or other game hosting -// solutions. To create an Anywhere fleet, provide these required parameters: +// status while Amazon GameLift initiates the [fleet creation workflow]. +// +// When the fleet status is ACTIVE, you can adjust capacity settings and turn +// autoscaling on/off for each location. +// +// # Anywhere fleet +// +// An Anywhere fleet represents compute resources that are not owned or managed by +// Amazon GameLift. You might create an Anywhere fleet with your local machine for +// testing, or use one to host game servers with on-premises hardware or other game +// hosting solutions. +// +// To create an Anywhere fleet, provide these required parameters: +// // - ComputeType set to ANYWHERE +// // - Locations specifying a custom location +// // - Name // // If successful, this operation creates a new fleet resource and places it in -// ACTIVE status. You can register computes with a fleet in ACTIVE status. Learn -// more Setting up fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) -// Setting up a container fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-build-fleet.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) +// ACTIVE status. You can register computes with a fleet in ACTIVE status. +// +// # Learn more +// +// [Setting up fleets] +// +// [Setting up a container fleet] +// +// [Debug fleet creation issues] +// +// [Multi-location fleets] +// +// [fleet creation workflow]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow +// [Setting up a container fleet]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-build-fleet.html +// [Multi-location 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 +// [Setting up 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{} @@ -106,22 +152,30 @@ type CreateFleetInput struct { // GameLift uses the certificates to encrypt traffic between game clients and the // game servers running on Amazon 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 you replace fleets before 13 - // months, consider using fleet aliases for a smooth 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. + // 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 you replace fleets before 13 months, + // consider using fleet aliases for a smooth 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]in the + // Certificate Manager User Guide. + // + // [Supported Regions]: https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html CertificateConfiguration *types.CertificateConfiguration // The type of compute resource used to host your game servers. + // // - EC2 – The game server build is deployed to Amazon EC2 instances for cloud // hosting. This is the default setting. + // // - CONTAINER – Container images with your game server build and supporting // software are deployed to Amazon EC2 instances for cloud hosting. With this // compute type, you must specify the ContainerGroupsConfiguration parameter. + // // - ANYWHERE – Game servers or container images with your game server and // supporting software are deployed to compute resources that are provided and // managed by you. With this compute type, you can also set the @@ -129,10 +183,10 @@ type CreateFleetInput struct { ComputeType types.ComputeType // The container groups to deploy to instances in the container fleet and other - // fleet-level configuration settings. Use the CreateContainerGroupDefinition - // action to create container groups. A container fleet must have exactly one - // replica container group, and can optionally have one daemon container group. You - // can't change this property after you create the fleet. + // fleet-level configuration settings. Use the CreateContainerGroupDefinitionaction to create container groups. + // A container fleet must have exactly one replica container group, and can + // optionally have one daemon container group. You can't change this property after + // you create the fleet. ContainerGroupsConfiguration *types.ContainerGroupsConfiguration // A description for the fleet. @@ -141,10 +195,11 @@ type CreateFleetInput struct { // The IP address ranges and port settings that allow inbound traffic to access // game server processes and other processes on this fleet. Set this parameter for // EC2 and container fleets. You can leave this parameter empty when creating the - // fleet, but you must call UpdateFleetPortSettings to set it before players can - // connect to game sessions. As a best practice, we recommend opening ports for - // remote access only when you need them and closing them when you're finished. For - // Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. + // fleet, but you must call UpdateFleetPortSettingsto set it before players can connect to game sessions. + // As a best practice, we recommend opening ports for remote access only when you + // need them and closing them when you're finished. For Realtime Servers fleets, + // Amazon GameLift automatically sets TCP and UDP ranges. + // // To manage inbound access for a container fleet, set this parameter to the same // port numbers that you set for the fleet's connection port range. During the life // of the fleet, update this parameter to control which connection ports are open @@ -154,14 +209,16 @@ type CreateFleetInput struct { // The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and // container fleets. 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. + // capacity. See [Amazon Elastic Compute Cloud Instance Types]for detailed descriptions of Amazon EC2 instance types. + // + // [Amazon Elastic Compute Cloud Instance Types]: http://aws.amazon.com/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 fleet property can't be changed after the fleet is created. + // default, this property is set to ON_DEMAND . Learn more about when to use [On-Demand versus Spot Instances]. + // This fleet property can't be changed after the fleet is created. + // + // [On-Demand versus Spot Instances]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot FleetType types.FleetType // A unique identifier for an IAM role with access permissions to other Amazon Web @@ -169,9 +226,9 @@ type CreateFleetInput struct { // fleet--including install scripts, server processes, and other processes--can use // these permissions to interact with Amazon Web Services resources that you own or // have access to. For more information about using the role with your game server - // builds, see Communicate with other Amazon Web Services resources from your - // fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) - // . This fleet property can't be changed after the fleet is created. + // builds, see [Communicate with other Amazon Web Services resources from your fleets]. This fleet property can't be changed after the fleet is created. + // + // [Communicate with other Amazon Web Services resources from your fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html InstanceRoleArn *string // Prompts Amazon GameLift to generate a shared credentials file for the IAM role @@ -179,9 +236,9 @@ type CreateFleetInput struct { // each fleet instance and refreshed as needed. Use shared credentials for // applications that are deployed along with the game server executable, if the // game server is integrated with server SDK version 5.x. For more information - // about using shared credentials, see Communicate with other Amazon Web Services - // resources from your fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) - // . + // about using shared credentials, see [Communicate with other Amazon Web Services resources from your fleets]. + // + // [Communicate with other Amazon Web Services resources from your fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html InstanceRoleCredentialsProvider types.InstanceRoleCredentialsProvider // A set of remote locations to deploy additional instances to and manage as part @@ -190,15 +247,17 @@ type CreateFleetInput struct { // 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 or Local Zone code. To // create a fleet with instances in the home Region only, don't set this parameter. + // // When using this parameter, Amazon GameLift requires you to include your home // location in the request. Locations []types.LocationConfiguration - // This parameter is no longer used. To specify where Amazon GameLift should store - // log files once a server process shuts down, use the Amazon 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) - // in the Amazon GameLift Developer Guide. + // This parameter is no longer used. To specify where Amazon GameLift should + // store log files once a server process shuts down, use the Amazon GameLift server + // API ProcessReady() and specify one or more directory paths in logParameters . + // For more information, see [Initialize the server process]in the Amazon GameLift Developer Guide. + // + // [Initialize the server process]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize LogPaths []string // The name of an Amazon Web Services CloudWatch metric group to add this fleet @@ -209,9 +268,11 @@ type CreateFleetInput struct { // 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 . + // 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 @@ -223,10 +284,11 @@ type CreateFleetInput struct { // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift 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 Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) - // . + // VPC ID, use the [VPC Dashboard]in the Amazon Web Services Management Console. Learn more about + // VPC peering in [VPC Peering with Amazon GameLift Fleets]. + // + // [VPC Dashboard]: https://console.aws.amazon.com/vpc/ + // [VPC Peering with Amazon 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 @@ -238,9 +300,10 @@ type CreateFleetInput struct { // fleets, set this parameter only if the fleet is running the Amazon GameLift // Agent. The runtime configuration defines one or more server process // configurations. Each server process identifies a game executable or Realtime - // script file and the number of processes to run concurrently. This parameter - // replaces the parameters ServerLaunchPath and ServerLaunchParameters , which are - // still supported for backward compatibility. + // script file and the number of processes to run concurrently. + // + // This parameter replaces the parameters ServerLaunchPath and + // ServerLaunchParameters , which are still supported for backward compatibility. RuntimeConfiguration *types.RuntimeConfiguration // The unique identifier for a Realtime configuration script to be deployed to a @@ -249,12 +312,12 @@ type CreateFleetInput struct { // property can't be changed after the fleet is created. ScriptId *string - // This parameter is no longer used. Specify server launch parameters using the + // This parameter is no longer used. Specify server launch parameters using the // RuntimeConfiguration parameter. Requests that use this parameter instead // continue to be valid. ServerLaunchParameters *string - // This parameter is no longer used. Specify a server launch path using the + // This parameter is no longer used. Specify a server launch path using the // RuntimeConfiguration parameter. Requests that use this parameter instead // continue to be valid. ServerLaunchPath *string @@ -262,8 +325,9 @@ type CreateFleetInput struct { // 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. + // information, see [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateFleetLocations.go b/service/gamelift/api_op_CreateFleetLocations.go index 4f93225f1b2..bb0aa7e6692 100644 --- a/service/gamelift/api_op_CreateFleetLocations.go +++ b/service/gamelift/api_op_CreateFleetLocations.go @@ -11,20 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Adds remote locations to an EC2 -// or container fleet and begins populating the new locations with instances. The -// new instances conform to the fleet's instance type, auto-scaling, and other -// configuration settings. You can't add remote locations to a fleet that resides -// in an Amazon Web Services Region that doesn't support multiple locations. Fleets -// created prior to March 2021 can't support multiple locations. 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 . Amazon 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) +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Adds remote locations to an EC2 or container fleet and begins populating the +// new locations with instances. The new instances conform to the fleet's instance +// type, auto-scaling, and other configuration settings. +// +// You can't add remote locations to a fleet that resides in an Amazon Web +// Services Region that doesn't support multiple locations. Fleets created prior to +// March 2021 can't support multiple locations. +// +// 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 . Amazon 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]. +// +// # Learn more +// +// [Setting up fleets] +// +// [Multi-location fleets] +// +// [DescribeFleetEvents]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html +// [Multi-location fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html +// [Setting up 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{} @@ -61,10 +76,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that was updated with new locations. diff --git a/service/gamelift/api_op_CreateGameServerGroup.go b/service/gamelift/api_op_CreateGameServerGroup.go index c91569a2c4d..e2e0c75311a 100644 --- a/service/gamelift/api_op_CreateGameServerGroup.go +++ b/service/gamelift/api_op_CreateGameServerGroup.go @@ -11,38 +11,49 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Creates a Amazon GameLift FleetIQ game server group for managing -// game hosting on a collection of Amazon Elastic Compute Cloud instances for game -// hosting. This operation creates the game server group, creates an Auto Scaling -// group in your Amazon Web Services account, and establishes a link between the -// two groups. You can view the status of your game server groups in the Amazon -// 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: +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Creates a Amazon GameLift FleetIQ game server group for managing game hosting +// on a collection of Amazon Elastic Compute Cloud instances for game hosting. This +// operation creates the game server group, creates an Auto Scaling group in your +// Amazon Web Services account, and establishes a link between the two groups. You +// can view the status of your game server groups in the Amazon 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. +// more information, see [Launching an Instance from a Launch Template]in the Amazon Elastic Compute Cloud User Guide. +// // - An IAM role that extends limited access to your Amazon Web Services account // to allow Amazon 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 Amazon GameLift FleetIQ Developer Guide. +// group. For more information, see [Create IAM roles for cross-service interaction]in the Amazon 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 Amazon 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. +// +// 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 Amazon GameLift FleetIQ as part of its balancing -// activities to optimize for availability and cost. Learn more Amazon GameLift -// FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// activities to optimize for availability and cost. +// +// # Learn more +// +// [Amazon GameLift FleetIQ Guide] +// +// [Create IAM roles for cross-service interaction]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html +// [Amazon GameLift FleetIQ Guide]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html +// [Launching an Instance from a Launch Template]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html func (c *Client) CreateGameServerGroup(ctx context.Context, params *CreateGameServerGroupInput, optFns ...func(*Options)) (*CreateGameServerGroupOutput, error) { if params == nil { params = &CreateGameServerGroupInput{} @@ -71,12 +82,13 @@ 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 Amazon 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 + // see [EC2 Instance Types]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. + // capacity weighting, see [Instance Weighting for Amazon EC2 Auto Scaling]in the Amazon EC2 Auto Scaling User Guide. + // + // [Instance Weighting for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html + // [EC2 Instance Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html // // This member is required. InstanceDefinitions []types.InstanceDefinition @@ -84,14 +96,17 @@ type CreateGameServerGroupInput struct { // The Amazon EC2 launch template that contains configuration settings and game // 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) - // 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 - // in your launch template, you must explicitly set the property - // AssociatePublicIpAddress to "true". If no network interface is specified in the - // launch template, Amazon GameLift FleetIQ uses your account's default VPC. + // creating a launch template, see [Creating a Launch Template for an Auto Scaling Group]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 in your launch template, you must explicitly + // set the property AssociatePublicIpAddress to "true". If no network interface is + // specified in the launch template, Amazon GameLift FleetIQ uses your account's + // default VPC. + // + // [Creating a Launch Template for an Auto Scaling Group]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html // // This member is required. LaunchTemplate *types.LaunchTemplateSpecification @@ -115,9 +130,10 @@ 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] ) for an IAM role that allows Amazon GameLift to + // access your Amazon EC2 Auto Scaling groups. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html // // This member is required. RoleArn *string @@ -133,16 +149,19 @@ type CreateGameServerGroupInput struct { // Indicates how Amazon 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. @@ -161,8 +180,9 @@ 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]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag // A list of virtual private cloud (VPC) subnets to use with instances in the game diff --git a/service/gamelift/api_op_CreateGameSession.go b/service/gamelift/api_op_CreateGameSession.go index 7197bad8039..b05f6210bc5 100644 --- a/service/gamelift/api_op_CreateGameSession.go +++ b/service/gamelift/api_op_CreateGameSession.go @@ -14,17 +14,22 @@ import ( // Creates a multiplayer game session for players in a specific fleet location. // 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 Amazon GameLift game session placement feature with -// StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) -// , which uses the FleetIQ algorithm 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 target fleet must be -// in ACTIVE status. You can use this operation in the following ways: +// consider using the Amazon GameLift game session placement feature with [StartGameSessionPlacement], which +// uses the FleetIQ algorithm 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 target fleet must +// be in ACTIVE status. +// +// You can use this operation 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 an Anywhere fleet, specify the // fleet's custom location. // @@ -33,13 +38,24 @@ import ( // status. When the game session status is ACTIVE , it is updated with connection // information and you can create player sessions 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. Amazon GameLift -// retains logs for active for 14 days. To access the logs, call -// 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) +// access by using [UpdateGameSession]to change the game session's player session creation policy. +// +// Amazon GameLift retains logs for active for 14 days. To access the logs, call [GetGameSessionLogUrl] +// to download the log files. +// +// Available in Amazon GameLift Local. +// +// # Learn more +// +// [Start a game session] +// +// [All APIs by task] +// +// [Start a game session]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession +// [GetGameSessionLogUrl]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html +// [StartGameSessionPlacement]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html +// [UpdateGameSession]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html +// [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{} @@ -68,15 +84,18 @@ type CreateGameSessionInput struct { // reference either a fleet ID or alias ID, but not both. AliasId *string - // A unique identifier for a player or entity creating the game session. If you - // add a resource creation limit policy to a fleet, the CreateGameSession + // A unique identifier for a player or entity creating the game session. + // + // If you add a resource creation limit policy to a fleet, the CreateGameSession // operation requires a CreatorId . Amazon GameLift limits the number of game // session creation requests with the same CreatorId in a specified time period. + // // If you your fleet doesn't have a resource creation limit policy and you provide // a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests - // to one request per CreatorId per second. To not limit CreateGameSession - // requests with the same CreatorId , don't provide a CreatorId in your - // CreateGameSession request. + // to one request per CreatorId per second. + // + // To not limit CreateGameSession requests with the same CreatorId , don't provide + // a CreatorId in your CreateGameSession request. CreatorId *string // A unique identifier for the fleet to create a game session in. You can use @@ -85,20 +104,23 @@ type CreateGameSessionInput struct { FleetId *string // A set of key-value pairs that can store custom data in a game session. For - // example: {"Key": "difficulty", "Value": "novice"} . For an example, see Create - // a game session with custom properties (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create) - // . + // example: {"Key": "difficulty", "Value": "novice"} . For an example, see [Create a game session with custom properties]. + // + // [Create a game session with custom properties]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create 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]). + // + // [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 - // uniquely identifies a request for a new game session. Maximum token length is 48 - // characters. If provided, this string is included in the new game session's ID. + // This parameter is deprecated. Use IdempotencyToken instead. + // + // Custom string that uniquely identifies a request for a new game session. + // Maximum token length is 48 characters. If provided, this string is included in + // the new game session's ID. GameSessionId *string // Custom string that uniquely identifies the new game session request. This is diff --git a/service/gamelift/api_op_CreateGameSessionQueue.go b/service/gamelift/api_op_CreateGameSessionQueue.go index 57032e6d267..4c4ef22baf8 100644 --- a/service/gamelift/api_op_CreateGameSessionQueue.go +++ b/service/gamelift/api_op_CreateGameSessionQueue.go @@ -14,34 +14,52 @@ import ( // 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 -// (Amazon 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 includes multi-location fleets, the queue is able to place game -// sessions in all of a fleet's remote locations. You can opt to filter out -// individual locations if needed. The queue configuration also determines how -// FleetIQ selects the best available placement for a new game session. Before -// searching for an available game server, FleetIQ first prioritizes the queue's -// destinations and locations, with the best placement locations on top. You can -// set up the queue to use the FleetIQ default prioritization or provide an -// alternate set of priorities. To create a new queue, provide a name, timeout -// value, and a list of destinations. Optionally, specify a sort configuration -// and/or a filter, and define a set of latency cap policies. You can also include -// the ARN for an Amazon Simple Notification Service (SNS) topic to receive -// notifications of game session 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) +// new game session. +// +// A game session queue is configured with a set of destinations (Amazon 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 +// includes multi-location fleets, the queue is able to place game sessions in all +// of a fleet's remote locations. You can opt to filter out individual locations if +// needed. +// +// The queue configuration also determines how FleetIQ selects the best available +// placement for a new game session. Before searching for an available game server, +// FleetIQ first prioritizes the queue's destinations and locations, with the best +// placement locations on top. You can set up the queue to use the FleetIQ default +// prioritization or provide an alternate set of priorities. +// +// To create a new queue, provide a name, timeout value, and a list of +// destinations. Optionally, specify a sort configuration and/or a filter, and +// define a set of latency cap policies. You can also include the ARN for an Amazon +// Simple Notification Service (SNS) topic to receive notifications of game session +// 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]or [StartMatchmaking], +// reference a queue's name or ARN. +// +// # Learn more +// +// [Design a game session queue] +// +// [Create a game session queue] +// +// # Related actions +// +// [CreateGameSessionQueue]| [DescribeGameSessionQueues] | [UpdateGameSessionQueue] | [DeleteGameSessionQueue] | [All APIs by task] +// +// [StartMatchmaking]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html +// [DescribeGameSessionQueues]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html +// [StartGameSessionPlacement]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html +// [Create a game session queue]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html +// [CreateGameSessionQueue]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html +// [UpdateGameSessionQueue]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html +// [Design a game session queue]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.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{} @@ -81,8 +99,9 @@ type CreateGameSessionQueueInput struct { 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) - // . + // notifications. See [Setting up notifications for game session placement]. + // + // [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 @@ -102,8 +121,9 @@ 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]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html 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 db42b0192de..9d58bd070ab 100644 --- a/service/gamelift/api_op_CreateLocation.go +++ b/service/gamelift/api_op_CreateLocation.go @@ -37,8 +37,9 @@ 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]in the Amazon Web Services General Rareference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateMatchmakingConfiguration.go b/service/gamelift/api_op_CreateMatchmakingConfiguration.go index d3bd17a937a..ce7deef36a9 100644 --- a/service/gamelift/api_op_CreateMatchmakingConfiguration.go +++ b/service/gamelift/api_op_CreateMatchmakingConfiguration.go @@ -18,17 +18,28 @@ import ( // 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 Amazon 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 -// Amazon 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) +// consistent with that configuration. +// +// To create a matchmaking configuration, you must provide the following: +// configuration name and FlexMatch mode (with or without Amazon 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 Amazon 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] +// +// [Set up FlexMatch event notification] +// +// [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{} @@ -89,12 +100,14 @@ type CreateMatchmakingConfigurationInput struct { // matchmaking configuration. Specify MANUAL when your game manages backfill // requests manually or does not use the match backfill feature. Specify AUTOMATIC // to have Amazon 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 . + // one or more open slots. Learn more about manual and automatic backfill in [Backfill Existing Games with FlexMatch]. + // Automatic backfill is not available when FlexMatchMode is set to STANDALONE . + // + // [Backfill Existing Games with FlexMatch]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html BackfillMode types.BackfillMode - // Information to be added to all events related to this matchmaking configuration. + // Information to be added to all events related to this matchmaking + // configuration. CustomEventData *string // A human-readable description of the matchmaking configuration. @@ -102,11 +115,14 @@ type CreateMatchmakingConfigurationInput struct { // Indicates whether this matchmaking configuration is being used with Amazon // 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. + // including players and team assignments, in a [MatchmakingSucceeded]event. + // // - WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift // queue to start a game session for the match. + // + // [MatchmakingSucceeded]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded FlexMatchMode types.FlexMatchMode // A set of key-value pairs that can store custom data in a game session. For @@ -117,31 +133,35 @@ type CreateMatchmakingConfigurationInput struct { // 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]). 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 . + // + // [Start a Game Session]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession GameSessionData *string - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to a Amazon 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 Amazon GameLift-hosted game sessions for matches - // that are created with this matchmaking configuration. If FlexMatchMode is set - // to STANDALONE , do not set this parameter. + // The Amazon Resource Name ([ARN] ) that is assigned to a Amazon 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 Amazon GameLift-hosted game sessions for + // matches that are created with this matchmaking configuration. If FlexMatchMode + // is set to STANDALONE , do not set this parameter. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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) - // for more information. + // An SNS topic ARN that is set up to receive matchmaking notifications. See [Setting up notifications for matchmaking] for + // more information. + // + // [Setting up notifications for matchmaking]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html 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]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreateMatchmakingRuleSet.go b/service/gamelift/api_op_CreateMatchmakingRuleSet.go index e312283f4ba..3c865cf60e4 100644 --- a/service/gamelift/api_op_CreateMatchmakingRuleSet.go +++ b/service/gamelift/api_op_CreateMatchmakingRuleSet.go @@ -14,15 +14,27 @@ import ( // Creates a new rule set for FlexMatch matchmaking. A rule set describes the type // of match to create, such as the number and size of teams. It also sets the // parameters for acceptable player matches, such as minimum skill level or -// character type. To create a matchmaking rule set, provide unique rule set name -// 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) -// 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) +// character type. +// +// To create a matchmaking rule set, provide unique rule set name 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]before creating a new rule set. +// +// # Learn more +// +// [Build a rule set] +// +// [Design a matchmaker] +// +// [Matchmaking with FlexMatch] +// +// [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 +// [ValidateMatchmakingRuleSet]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html func (c *Client) CreateMatchmakingRuleSet(ctx context.Context, params *CreateMatchmakingRuleSetInput, optFns ...func(*Options)) (*CreateMatchmakingRuleSetOutput, error) { if params == nil { params = &CreateMatchmakingRuleSetInput{} @@ -56,8 +68,9 @@ 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]in the Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/gamelift/api_op_CreatePlayerSession.go b/service/gamelift/api_op_CreatePlayerSession.go index 54dc09c6408..165b9031266 100644 --- a/service/gamelift/api_op_CreatePlayerSession.go +++ b/service/gamelift/api_op_CreatePlayerSession.go @@ -14,15 +14,25 @@ import ( // 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 -// connection request to the game session, and the game server can use it to -// validate the player reservation with the Amazon 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) +// players to a game session with [CreatePlayerSessions]. +// +// 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 connection request to the game +// session, and the game server can use it to validate the player reservation with +// the Amazon 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] +// +// [CreatePlayerSessions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html +// [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 380f6934aec..56eec34ebca 100644 --- a/service/gamelift/api_op_CreatePlayerSessions.go +++ b/service/gamelift/api_op_CreatePlayerSessions.go @@ -14,16 +14,25 @@ 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) +// to a game session, use [CreatePlayerSession] +// // 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 -// objects are returned with player session IDs. Each player references their -// 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 Amazon -// 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) +// 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 objects are returned with player session IDs. Each player +// references their 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 Amazon 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] +// +// [CreatePlayerSession]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html +// [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 0f6ed701b19..87d69c36324 100644 --- a/service/gamelift/api_op_CreateScript.go +++ b/service/gamelift/api_op_CreateScript.go @@ -15,10 +15,14 @@ import ( // are JavaScript that provide configuration settings and optional custom game // logic for your game. The script is deployed when you create a Realtime Servers // fleet to host your game sessions. Script logic is executed during an active game -// 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: +// 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 @@ -29,9 +33,20 @@ import ( // 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) +// +// # Learn more +// +// [Amazon GameLift Realtime Servers] +// +// [Set Up a Role for Amazon GameLift Access] +// +// # Related actions +// +// [All APIs by task] +// +// [Set Up a Role for Amazon GameLift Access]: https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html +// [Amazon GameLift Realtime Servers]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html +// [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{} @@ -50,8 +65,9 @@ func (c *Client) CreateScript(ctx context.Context, params *CreateScriptInput, op type CreateScriptInput struct { // A descriptive label that is associated with a script. Script names don't need - // to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) - // to change this value later. + // to be unique. You can use [UpdateScript]to change this value later. + // + // [UpdateScript]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html Name *string // The location of the Amazon S3 bucket where a zipped file containing your @@ -67,22 +83,26 @@ 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) - // 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. + // information, see [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference. Once the + // resource is created, you can use [TagResource], [UntagResource], and [ListTagsForResource] 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. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html + // [TagResource]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html + // [ListTagsForResource]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html Tags []types.Tag // Version information associated with a build or script. Version strings don't - // need to be unique. You can use UpdateScript (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html) - // to change this value later. + // need to be unique. You can use [UpdateScript]to change this value later. + // + // [UpdateScript]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html Version *string // A data object containing your Realtime scripts and dependencies as a zip file. // The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. + // // 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 diff --git a/service/gamelift/api_op_CreateVpcPeeringAuthorization.go b/service/gamelift/api_op_CreateVpcPeeringAuthorization.go index 641d7050576..a07fc72913a 100644 --- a/service/gamelift/api_op_CreateVpcPeeringAuthorization.go +++ b/service/gamelift/api_op_CreateVpcPeeringAuthorization.go @@ -15,26 +15,37 @@ import ( // 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) -// 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 +// received authorization, use [CreateVpcPeeringConnection]to establish the peering connection. For more +// information, see [VPC Peering with Amazon GameLift Fleets]. +// +// 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 +// GameLift fleets. You cannot peer with VPCs that are in different Regions. +// +// To request authorization to create a connection, call this operation from the // Amazon Web Services account with the VPC that you want to peer to your Amazon // GameLift fleet. For example, to enable your game servers to retrieve data from a // DynamoDB table, use the account that manages that DynamoDB resource. Identify // the following values: (1) The ID of the VPC that you want to peer with, and (2) // the ID of the Amazon Web Services account that you use to manage Amazon -// GameLift. If successful, VPC peering is authorized for the specified VPC. To -// request authorization to delete a connection, call this operation from the +// GameLift. If successful, VPC peering is authorized for the specified VPC. +// +// To request authorization to delete a connection, call this operation from the // Amazon Web Services account with the VPC that is peered with your Amazon // GameLift fleet. Identify the following values: (1) VPC ID that you want to // 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) +// 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] +// +// [CreateVpcPeeringConnection]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html +// [VPC Peering with Amazon GameLift Fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html +// [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{} @@ -61,10 +72,11 @@ type CreateVpcPeeringAuthorizationInput struct { // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift 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 Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) - // . + // VPC ID, use the [VPC Dashboard]in the Amazon Web Services Management Console. Learn more about + // VPC peering in [VPC Peering with Amazon GameLift Fleets]. + // + // [VPC Dashboard]: https://console.aws.amazon.com/vpc/ + // [VPC Peering with Amazon 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 80b842a7e18..58f32610430 100644 --- a/service/gamelift/api_op_CreateVpcPeeringConnection.go +++ b/service/gamelift/api_op_CreateVpcPeeringConnection.go @@ -16,23 +16,32 @@ import ( // 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) -// 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 -// acceptance, updating routing tables, etc. To establish the connection, call this -// operation from the Amazon Web Services account that is used to manage the Amazon -// GameLift fleets. Identify the following values: (1) The ID of the fleet you want -// to be enable a VPC peering connection for; (2) The Amazon Web Services account -// 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) +// different Regions. For more information, see [VPC Peering with Amazon GameLift Fleets]. +// +// Before calling this operation to establish the peering connection, you first +// need to use [CreateVpcPeeringAuthorization]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 +// acceptance, updating routing tables, etc. +// +// To establish the connection, call this operation from the Amazon Web Services +// account that is used to manage the Amazon GameLift fleets. Identify the +// following values: (1) The ID of the fleet you want to be enable a VPC peering +// connection for; (2) The Amazon Web Services account 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], or by monitoring fleet +// events for success or failure using [DescribeFleetEvents]. +// +// # Related actions +// +// [All APIs by task] +// +// [DescribeFleetEvents]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html +// [CreateVpcPeeringAuthorization]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html +// [VPC Peering with Amazon GameLift Fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html +// [DescribeVpcPeeringConnections]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html +// [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{} @@ -65,10 +74,11 @@ type CreateVpcPeeringConnectionInput struct { // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift 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 Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) - // . + // VPC ID, use the [VPC Dashboard]in the Amazon Web Services Management Console. Learn more about + // VPC peering in [VPC Peering with Amazon GameLift Fleets]. + // + // [VPC Dashboard]: https://console.aws.amazon.com/vpc/ + // [VPC Peering with Amazon 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 26ddbc58f86..f67e5284b40 100644 --- a/service/gamelift/api_op_DeleteAlias.go +++ b/service/gamelift/api_op_DeleteAlias.go @@ -12,8 +12,13 @@ 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] +// +// [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{} diff --git a/service/gamelift/api_op_DeleteBuild.go b/service/gamelift/api_op_DeleteBuild.go index 82367a60154..945767eaf8e 100644 --- a/service/gamelift/api_op_DeleteBuild.go +++ b/service/gamelift/api_op_DeleteBuild.go @@ -13,9 +13,18 @@ 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] +// +// [All APIs by task] +// +// [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_DeleteContainerGroupDefinition.go b/service/gamelift/api_op_DeleteContainerGroupDefinition.go index f3a77e459e6..b28b2a526d6 100644 --- a/service/gamelift/api_op_DeleteContainerGroupDefinition.go +++ b/service/gamelift/api_op_DeleteContainerGroupDefinition.go @@ -10,12 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift containers feature, which is -// currently in public preview. Deletes a container group definition resource. You -// can delete a container group definition if there are no fleets using the -// definition. To delete a container group definition, identify the resource to -// delete. Learn more -// - Manage a container group definition (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html) +// This operation is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Deletes a container group definition resource. You can delete a container group +// definition if there are no fleets using the definition. +// +// To delete a container group definition, identify the resource to delete. +// +// # Learn more +// +// [Manage a container group definition] +// +// [Manage a container group definition]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html func (c *Client) DeleteContainerGroupDefinition(ctx context.Context, params *DeleteContainerGroupDefinitionInput, optFns ...func(*Options)) (*DeleteContainerGroupDefinitionOutput, error) { if params == nil { params = &DeleteContainerGroupDefinitionInput{} diff --git a/service/gamelift/api_op_DeleteFleet.go b/service/gamelift/api_op_DeleteFleet.go index 38a697cac3f..a6ff3dbe7ea 100644 --- a/service/gamelift/api_op_DeleteFleet.go +++ b/service/gamelift/api_op_DeleteFleet.go @@ -11,14 +11,22 @@ import ( ) // Deletes all resources and information related to a fleet and shuts down any -// currently running fleet instances, including those in remote locations. 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 don't 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 -// TERMINATED and the fleet event FLEET_DELETED is emitted. Learn more Setting up -// Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// currently running fleet instances, including those in remote locations. +// +// 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]. You don't 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 TERMINATED and the fleet event FLEET_DELETED is emitted. +// +// # Learn more +// +// [Setting up Amazon GameLift Fleets] +// +// [CreateVpcPeeringAuthorization]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DeleteFleetLocations.go b/service/gamelift/api_op_DeleteFleetLocations.go index 52ae1a90c5f..59bcba36d52 100644 --- a/service/gamelift/api_op_DeleteFleetLocations.go +++ b/service/gamelift/api_op_DeleteFleetLocations.go @@ -13,11 +13,20 @@ import ( // Removes locations from a multi-location fleet. When deleting a location, all // 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 -// instances in each location being deleted. When completed, the location status -// changes to TERMINATED . Learn more Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// 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 instances in each location +// being deleted. When completed, the location status changes to TERMINATED . +// +// # Learn more +// +// [Setting up Amazon GameLift fleets] +// +// [Setting up Amazon 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{} @@ -52,10 +61,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that location attributes are being deleted diff --git a/service/gamelift/api_op_DeleteGameServerGroup.go b/service/gamelift/api_op_DeleteGameServerGroup.go index 6639833f6f0..6d43786ce3b 100644 --- a/service/gamelift/api_op_DeleteGameServerGroup.go +++ b/service/gamelift/api_op_DeleteGameServerGroup.go @@ -11,25 +11,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Terminates a game server group and permanently deletes the game -// server 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: +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Terminates a game server group and permanently deletes the game server 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 // // 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, Amazon GameLift FleetIQ can begin deleting -// resources. If any of the delete operations fail, the game server group is placed -// in ERROR status. Amazon GameLift FleetIQ emits delete events to Amazon -// CloudWatch. Learn more Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// 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, Amazon GameLift +// FleetIQ can begin deleting resources. If any of the delete operations fail, the +// game server group is placed in ERROR status. +// +// Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch. +// +// # Learn more +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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{} @@ -53,11 +67,14 @@ 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. DeleteOption types.GameServerGroupDeleteOption diff --git a/service/gamelift/api_op_DeleteGameSessionQueue.go b/service/gamelift/api_op_DeleteGameSessionQueue.go index 39eb9340746..04d1c0d7362 100644 --- a/service/gamelift/api_op_DeleteGameSessionQueue.go +++ b/service/gamelift/api_op_DeleteGameSessionQueue.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a game session queue. Once a queue is successfully deleted, unfulfilled -// StartGameSessionPlacement (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) +// Deletes a game session queue. Once a queue is successfully deleted, unfulfilled [StartGameSessionPlacement] // requests that reference the queue will fail. To delete a queue, specify the // queue name. +// +// [StartGameSessionPlacement]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html func (c *Client) DeleteGameSessionQueue(ctx context.Context, params *DeleteGameSessionQueueInput, optFns ...func(*Options)) (*DeleteGameSessionQueueOutput, error) { if params == nil { params = &DeleteGameSessionQueueInput{} diff --git a/service/gamelift/api_op_DeleteLocation.go b/service/gamelift/api_op_DeleteLocation.go index 9584e0f7bf9..a5c60b251a3 100644 --- a/service/gamelift/api_op_DeleteLocation.go +++ b/service/gamelift/api_op_DeleteLocation.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// 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] // . +// +// [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 24163469b6b..8a7f9809a26 100644 --- a/service/gamelift/api_op_DeleteMatchmakingRuleSet.go +++ b/service/gamelift/api_op_DeleteMatchmakingRuleSet.go @@ -12,8 +12,13 @@ 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) +// matchmaking configuration. +// +// # Learn more +// +// [Build a rule set] +// +// [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 4ad0e0e30c9..2d080596765 100644 --- a/service/gamelift/api_op_DeleteScalingPolicy.go +++ b/service/gamelift/api_op_DeleteScalingPolicy.go @@ -12,9 +12,12 @@ import ( // Deletes a fleet scaling policy. Once deleted, the policy is no longer in force // and Amazon 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. +// specify both the scaling policy name and the fleet ID it is associated with. +// +// To temporarily suspend scaling policies, use [StopFleetActions]. This operation suspends all +// policies for the fleet. +// +// [StopFleetActions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html func (c *Client) DeleteScalingPolicy(ctx context.Context, params *DeleteScalingPolicyInput, optFns ...func(*Options)) (*DeleteScalingPolicyOutput, error) { if params == nil { params = &DeleteScalingPolicyInput{} diff --git a/service/gamelift/api_op_DeleteScript.go b/service/gamelift/api_op_DeleteScript.go index d9f63e420ed..6b645119bb4 100644 --- a/service/gamelift/api_op_DeleteScript.go +++ b/service/gamelift/api_op_DeleteScript.go @@ -12,12 +12,24 @@ import ( // 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) +// 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] +// +// # Related actions +// +// [All APIs by task] +// +// [Amazon GameLift Realtime Servers]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html +// [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 610b790dba0..637d51c0418 100644 --- a/service/gamelift/api_op_DeleteVpcPeeringAuthorization.go +++ b/service/gamelift/api_op_DeleteVpcPeeringAuthorization.go @@ -11,8 +11,14 @@ 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]. +// +// # Related actions +// +// [All APIs by task] +// +// [DeleteVpcPeeringConnection]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html +// [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{} @@ -39,10 +45,11 @@ type DeleteVpcPeeringAuthorizationInput struct { // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift 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 Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) - // . + // VPC ID, use the [VPC Dashboard]in the Amazon Web Services Management Console. Learn more about + // VPC peering in [VPC Peering with Amazon GameLift Fleets]. + // + // [VPC Dashboard]: https://console.aws.amazon.com/vpc/ + // [VPC Peering with Amazon 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 f85326825aa..972a8dd2962 100644 --- a/service/gamelift/api_op_DeleteVpcPeeringConnection.go +++ b/service/gamelift/api_op_DeleteVpcPeeringConnection.go @@ -12,10 +12,17 @@ import ( // Removes a VPC peering connection. To delete the connection, you must have a // valid authorization for the VPC peering connection that you want to delete.. +// // 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] +// +// [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_DeregisterCompute.go b/service/gamelift/api_op_DeregisterCompute.go index 243bc70e0bd..d90e63cf478 100644 --- a/service/gamelift/api_op_DeregisterCompute.go +++ b/service/gamelift/api_op_DeregisterCompute.go @@ -10,15 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Removes a compute resource from -// an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can -// no longer host game sessions through Amazon GameLift. For an Anywhere fleet or a -// container fleet that's running the Amazon GameLift Agent, the Agent handles all -// compute registry tasks for you. For an Anywhere fleet that doesn't use the -// Agent, call this operation to deregister fleet computes. To deregister a -// compute, call this operation from the compute that's being deregistered and -// specify the compute name and the fleet ID. +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Removes a compute resource from an Amazon GameLift Anywhere fleet or container +// fleet. Deregistered computes can no longer host game sessions through Amazon +// GameLift. +// +// For an Anywhere fleet or a container fleet that's running the Amazon GameLift +// Agent, the Agent handles all compute registry tasks for you. For an Anywhere +// fleet that doesn't use the Agent, call this operation to deregister fleet +// computes. +// +// To deregister a compute, call this operation from the compute that's being +// deregistered and specify the compute name and the fleet ID. func (c *Client) DeregisterCompute(ctx context.Context, params *DeregisterComputeInput, optFns ...func(*Options)) (*DeregisterComputeOutput, error) { if params == nil { params = &DeregisterComputeInput{} diff --git a/service/gamelift/api_op_DeregisterGameServer.go b/service/gamelift/api_op_DeregisterGameServer.go index c6c1a4474a3..13599b8c79c 100644 --- a/service/gamelift/api_op_DeregisterGameServer.go +++ b/service/gamelift/api_op_DeregisterGameServer.go @@ -10,13 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Removes the game server from a game server group. As a result of -// this operation, the deregistered game server can no longer be claimed and will -// not be 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 -// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Removes the game server from a game server group. As a result of this +// operation, the deregistered game server can no longer be claimed and will not be +// 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon GameLift 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 fb166e8c071..b14e29f04e9 100644 --- a/service/gamelift/api_op_DescribeAlias.go +++ b/service/gamelift/api_op_DescribeAlias.go @@ -12,9 +12,16 @@ import ( ) // 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) +// 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] +// +// [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{} diff --git a/service/gamelift/api_op_DescribeBuild.go b/service/gamelift/api_op_DescribeBuild.go index 9b2a02083ea..a730703a9f0 100644 --- a/service/gamelift/api_op_DescribeBuild.go +++ b/service/gamelift/api_op_DescribeBuild.go @@ -13,8 +13,16 @@ 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] +// +// [All APIs by task] +// +// [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{} diff --git a/service/gamelift/api_op_DescribeCompute.go b/service/gamelift/api_op_DescribeCompute.go index 823d535f21f..1f98074118d 100644 --- a/service/gamelift/api_op_DescribeCompute.go +++ b/service/gamelift/api_op_DescribeCompute.go @@ -11,16 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Retrieves properties for a -// compute resource in an Amazon GameLift fleet. To get a list of all computes in a -// fleet, call ListCompute . To request information on a specific compute, provide -// the fleet ID and compute name. If successful, this operation returns details for -// the requested compute resource. Depending on the fleet's compute type, the -// result includes the following information: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Retrieves properties for a compute resource in an Amazon GameLift fleet. To get +// a list of all computes in a fleet, call ListCompute. +// +// To request information on a specific compute, provide the fleet ID and compute +// name. +// +// If successful, this operation returns details for the requested compute +// resource. Depending on the fleet's compute type, the result includes the +// following information: +// // - For EC2 fleets, this operation returns information about the EC2 instance. +// // - For ANYWHERE fleets, this operation returns information about the registered // compute. +// // - For CONTAINER fleets, this operation returns information about the container // that's registered as a compute, and the instance it's running on. The compute // name is the container name. diff --git a/service/gamelift/api_op_DescribeContainerGroupDefinition.go b/service/gamelift/api_op_DescribeContainerGroupDefinition.go index 59a85b9b564..ed778f00706 100644 --- a/service/gamelift/api_op_DescribeContainerGroupDefinition.go +++ b/service/gamelift/api_op_DescribeContainerGroupDefinition.go @@ -11,13 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift containers feature, which is -// currently in public preview. Retrieves the properties of a container group -// definition, including all container definitions in the group. To retrieve a -// container group definition, provide a resource identifier. If successful, this -// operation returns the complete properties of the container group definition. -// Learn more -// - Manage a container group definition (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html) +// This operation is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Retrieves the properties of a container group definition, including all +// container definitions in the group. +// +// To retrieve a container group definition, provide a resource identifier. If +// successful, this operation returns the complete properties of the container +// group definition. +// +// # Learn more +// +// [Manage a container group definition] +// +// [Manage a container group definition]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html func (c *Client) DescribeContainerGroupDefinition(ctx context.Context, params *DescribeContainerGroupDefinitionInput, optFns ...func(*Options)) (*DescribeContainerGroupDefinitionOutput, error) { if params == nil { params = &DescribeContainerGroupDefinitionInput{} diff --git a/service/gamelift/api_op_DescribeEC2InstanceLimits.go b/service/gamelift/api_op_DescribeEC2InstanceLimits.go index 63e776ec26c..05177bda30b 100644 --- a/service/gamelift/api_op_DescribeEC2InstanceLimits.go +++ b/service/gamelift/api_op_DescribeEC2InstanceLimits.go @@ -14,41 +14,53 @@ import ( // 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 Amazon GameLift fleets. You can request a limit increase -// for your account by using the Service limits page in the Amazon 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 +// Learn more at [Amazon 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 Amazon GameLift fleets. You +// can request a limit increase for your account by using the Service limits page +// in the Amazon 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 . // // 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 Amazon GameLift -// fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// data for each requested instance type. +// +// # Learn more +// +// [Setting up Amazon GameLift fleets] +// +// [Amazon EC2 Instance Types]: http://aws.amazon.com/ec2/instance-types/ +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DescribeFleetAttributes.go b/service/gamelift/api_op_DescribeFleetAttributes.go index 23115dcc3c0..64778fbc8d7 100644 --- a/service/gamelift/api_op_DescribeFleetAttributes.go +++ b/service/gamelift/api_op_DescribeFleetAttributes.go @@ -11,22 +11,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Retrieves core fleet-wide -// properties for fleets in an Amazon Web Services Region. Properties include the -// computing hardware and deployment configuration for instances in the fleet. You -// can use this operation in the following ways: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Retrieves core fleet-wide properties for fleets in an Amazon Web Services +// Region. Properties include the computing hardware and deployment configuration +// for instances in the fleet. +// +// You can use this operation in the following ways: +// // - To get attributes for 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 -// Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// 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 Amazon GameLift fleets] +// +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DescribeFleetCapacity.go b/service/gamelift/api_op_DescribeFleetCapacity.go index d6cba129343..f022107a357 100644 --- a/service/gamelift/api_op_DescribeFleetCapacity.go +++ b/service/gamelift/api_op_DescribeFleetCapacity.go @@ -11,26 +11,44 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Retrieves the resource capacity -// settings for one or more fleets. For a container fleet, this operation also -// returns counts for replica container groups. With multi-location fleets, this -// operation retrieves data for the fleet's home Region only. To retrieve capacity -// for remote locations, see DescribeFleetLocationCapacity . This operation can be -// used in the following ways: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Retrieves the resource capacity settings for one or more fleets. For a +// container fleet, this operation also returns counts for replica container +// groups. +// +// With multi-location fleets, this operation retrieves data for the fleet's home +// Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity. +// +// 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. // // 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. Capacity values 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 Amazon 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) +// 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. Capacity values 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 Amazon GameLift fleets] +// +// [GameLift metrics for fleets] +// +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DescribeFleetEvents.go b/service/gamelift/api_op_DescribeFleetEvents.go index d45b8747fbf..edc094bab34 100644 --- a/service/gamelift/api_op_DescribeFleetEvents.go +++ b/service/gamelift/api_op_DescribeFleetEvents.go @@ -15,10 +15,19 @@ import ( // Retrieves entries from a fleet's event log. Fleet events are initiated by // changes in status, such as during fleet creation and termination, changes in // capacity, etc. If a fleet has multiple locations, events are also initiated by -// 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 Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// 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 Amazon GameLift fleets] +// +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DescribeFleetLocationAttributes.go b/service/gamelift/api_op_DescribeFleetLocationAttributes.go index cae361efcdf..ba85558570d 100644 --- a/service/gamelift/api_op_DescribeFleetLocationAttributes.go +++ b/service/gamelift/api_op_DescribeFleetLocationAttributes.go @@ -12,19 +12,29 @@ import ( ) // 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: +// 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. // // 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 Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// 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 Amazon GameLift fleets] +// +// [Setting up Amazon 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{} @@ -66,16 +76,17 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that location attributes were requested for. FleetId *string - // Location-specific information on the requested fleet's remote locations. + // Location-specific information on the requested fleet's remote locations. LocationAttributes []types.LocationAttributes // A token that indicates where to resume retrieving results on the next call to diff --git a/service/gamelift/api_op_DescribeFleetLocationCapacity.go b/service/gamelift/api_op_DescribeFleetLocationCapacity.go index 964ab7575ac..4a5cf71d4de 100644 --- a/service/gamelift/api_op_DescribeFleetLocationCapacity.go +++ b/service/gamelift/api_op_DescribeFleetLocationCapacity.go @@ -14,13 +14,25 @@ import ( // 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. For a container fleet, this -// operation also returns counts for replica container groups. 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 Amazon 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) +// operation also returns counts for replica container groups. +// +// 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 Amazon GameLift fleets] +// +// [GameLift metrics for fleets] +// +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DescribeFleetLocationUtilization.go b/service/gamelift/api_op_DescribeFleetLocationUtilization.go index 87cbe32ede9..e6b9385c387 100644 --- a/service/gamelift/api_op_DescribeFleetLocationUtilization.go +++ b/service/gamelift/api_op_DescribeFleetLocationUtilization.go @@ -15,10 +15,21 @@ 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 Amazon 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 Amazon GameLift fleets] +// +// [GameLift metrics for fleets] +// +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_DescribeFleetPortSettings.go b/service/gamelift/api_op_DescribeFleetPortSettings.go index 9102987d8fb..2038cc48c20 100644 --- a/service/gamelift/api_op_DescribeFleetPortSettings.go +++ b/service/gamelift/api_op_DescribeFleetPortSettings.go @@ -16,17 +16,26 @@ import ( // server processes in the fleet. Game server processes that are running in the // fleet must use a port that falls within this range. To connect to game server // processes on a container fleet, the port settings should include one or more of -// the fleet's connection ports. Use this operation in the following ways: +// the fleet's connection ports. +// +// Use this operation in the following ways: +// // - To retrieve the port settings 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 specifying a location, this operation returns a pending status. -// If the requested fleet has been deleted, the result set is empty. Learn more -// Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// If the requested fleet has been deleted, the result set is empty. +// +// # Learn more +// +// [Setting up Amazon GameLift fleets] +// +// [Setting up Amazon 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{} @@ -59,10 +68,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that was requested. diff --git a/service/gamelift/api_op_DescribeFleetUtilization.go b/service/gamelift/api_op_DescribeFleetUtilization.go index 0ac0aaf5a2c..19a9e52365b 100644 --- a/service/gamelift/api_op_DescribeFleetUtilization.go +++ b/service/gamelift/api_op_DescribeFleetUtilization.go @@ -14,22 +14,37 @@ 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) -// to get utilization statistics for a fleet's remote locations. This operation can -// be used in the following ways: +// fleet's home Region only. See [DescribeFleetLocationUtilization]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. // // 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 -// Amazon 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) +// results as a set of sequential pages. +// +// If successful, a [FleetUtilization] 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 Amazon GameLift Fleets] +// +// [GameLift Metrics for Fleets] +// +// [FleetUtilization]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html +// [Setting up Amazon GameLift Fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html +// [DescribeFleetLocationUtilization]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.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{} diff --git a/service/gamelift/api_op_DescribeGameServer.go b/service/gamelift/api_op_DescribeGameServer.go index ffa51df9b6f..b8f2d1fbcda 100644 --- a/service/gamelift/api_op_DescribeGameServer.go +++ b/service/gamelift/api_op_DescribeGameServer.go @@ -11,12 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Retrieves information for a registered game server. Information -// includes 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 Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Retrieves information for a registered game server. Information includes 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon GameLift 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 be60e2235cb..b91d6ca4e0c 100644 --- a/service/gamelift/api_op_DescribeGameServerGroup.go +++ b/service/gamelift/api_op_DescribeGameServerGroup.go @@ -11,14 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Retrieves information on a game server group. This operation -// returns only properties related to Amazon GameLift FleetIQ. To view or update -// properties for the corresponding Auto Scaling group, such as launch template, -// auto scaling 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 -// Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Retrieves information on a game server group. This operation returns only +// properties related to Amazon GameLift FleetIQ. To view or update properties for +// the corresponding Auto Scaling group, such as launch template, auto scaling +// 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon GameLift 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 8646a76de19..bb19e325c16 100644 --- a/service/gamelift/api_op_DescribeGameServerInstances.go +++ b/service/gamelift/api_op_DescribeGameServerInstances.go @@ -11,19 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Retrieves status information about the Amazon EC2 instances -// associated with a Amazon GameLift FleetIQ game server group. Use this operation -// to detect when instances are active or not available to host new game servers. +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Retrieves status information about the Amazon EC2 instances associated with a +// Amazon GameLift FleetIQ game server group. Use this operation to detect when +// instances are active or not available to host new game servers. +// // To request status for all instances in the game server group, provide a game // server group ID only. To request status for specific instances, provide the game // server group ID and one or more instance IDs. Use the pagination parameters to // retrieve results in sequential segments. If successful, a collection of -// GameServerInstance objects is returned. This operation is not designed to be -// 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 Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// GameServerInstance objects is returned. +// +// This operation is not designed to be 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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{} diff --git a/service/gamelift/api_op_DescribeGameSessionDetails.go b/service/gamelift/api_op_DescribeGameSessionDetails.go index cf8e44ce59a..ce2d5119b05 100644 --- a/service/gamelift/api_op_DescribeGameSessionDetails.go +++ b/service/gamelift/api_op_DescribeGameSessionDetails.go @@ -14,23 +14,37 @@ import ( // Retrieves additional game session properties, including the game session // 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: +// 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. // // 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) +// that matches the request. +// +// # Learn more +// +// [Find a game session] +// +// [All APIs by task] +// +// [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{} diff --git a/service/gamelift/api_op_DescribeGameSessionPlacement.go b/service/gamelift/api_op_DescribeGameSessionPlacement.go index 9d4553f0955..79b61956a32 100644 --- a/service/gamelift/api_op_DescribeGameSessionPlacement.go +++ b/service/gamelift/api_op_DescribeGameSessionPlacement.go @@ -12,13 +12,16 @@ import ( ) // Retrieves information, including current status, about a game session placement -// request. To get game session placement details, specify the placement ID. 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 with DescribeGameSessionPlacement should only be used for games in -// development with low game session usage. +// request. +// +// To get game session placement details, specify the placement ID. +// +// 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 with DescribeGameSessionPlacement should only be used for +// games in development with low game session usage. func (c *Client) DescribeGameSessionPlacement(ctx context.Context, params *DescribeGameSessionPlacementInput, optFns ...func(*Options)) (*DescribeGameSessionPlacementOutput, error) { if params == nil { params = &DescribeGameSessionPlacementInput{} diff --git a/service/gamelift/api_op_DescribeGameSessionQueues.go b/service/gamelift/api_op_DescribeGameSessionQueues.go index 2bd1ab8a9a2..1948562893d 100644 --- a/service/gamelift/api_op_DescribeGameSessionQueues.go +++ b/service/gamelift/api_op_DescribeGameSessionQueues.go @@ -14,7 +14,13 @@ 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] +// +// [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{} diff --git a/service/gamelift/api_op_DescribeGameSessions.go b/service/gamelift/api_op_DescribeGameSessions.go index aa0b50c14ec..6c79683003a 100644 --- a/service/gamelift/api_op_DescribeGameSessions.go +++ b/service/gamelift/api_op_DescribeGameSessions.go @@ -12,30 +12,46 @@ 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: +// 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. // // 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) +// 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] +// +// [All APIs by task] +// +// [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{} diff --git a/service/gamelift/api_op_DescribeInstances.go b/service/gamelift/api_op_DescribeInstances.go index 96b7e2369d2..0faeaa0e6c1 100644 --- a/service/gamelift/api_op_DescribeInstances.go +++ b/service/gamelift/api_op_DescribeInstances.go @@ -14,23 +14,39 @@ import ( // Retrieves information about the EC2 instances in an Amazon GameLift managed // fleet, including instance ID, connection data, and status. You can use this // operation with a multi-location fleet to get location-specific instance -// information. As an alternative, use the operations ListCompute and -// DescribeCompute to retrieve information for compute resources, including EC2 and -// Anywhere fleets. You can call this operation in the following ways: +// information. As an alternative, use the operations ListComputeand DescribeCompute to retrieve information +// for compute resources, including EC2 and Anywhere fleets. +// +// You can call this operation in the following ways: +// // - To get information on all instances in a fleet's home Region, specify the // fleet ID. +// // - To get information on all instances in a fleet's remote location, specify // the fleet ID and location name. +// // - To get information on a specific instance in a fleet, specify the fleet ID // and instance ID. // // Use the pagination parameters to retrieve results as a set of sequential pages. +// // If successful, this operation returns Instance objects for each requested // instance, listed in no particular order. If you call this operation for an -// Anywhere fleet, you receive an InvalidRequestException. Learn more Remotely -// connect to 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) +// Anywhere fleet, you receive an InvalidRequestException. +// +// # Learn more +// +// [Remotely connect to fleet instances] +// +// [Debug fleet issues] +// +// # Related actions +// +// [All APIs by task] +// +// [Remotely connect to 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 +// [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{} diff --git a/service/gamelift/api_op_DescribeMatchmaking.go b/service/gamelift/api_op_DescribeMatchmaking.go index acacc796727..ecdf4926cf2 100644 --- a/service/gamelift/api_op_DescribeMatchmaking.go +++ b/service/gamelift/api_op_DescribeMatchmaking.go @@ -13,15 +13,26 @@ import ( // 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) +// 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] +// +// [Set Up FlexMatch event notification] +// +// [Set Up FlexMatch event notification]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html +// [Add FlexMatch to a game client]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.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 998d3a577ba..62914d21e85 100644 --- a/service/gamelift/api_op_DescribeMatchmakingConfigurations.go +++ b/service/gamelift/api_op_DescribeMatchmakingConfigurations.go @@ -11,14 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the details of FlexMatch matchmaking configurations. This operation -// offers the following options: (1) retrieve all matchmaking configurations, (2) -// retrieve configurations for a specified list, or (3) retrieve all configurations -// that use a specified rule set name. When requesting multiple items, use the -// 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) +// Retrieves the details of FlexMatch matchmaking configurations. +// +// This operation offers the following options: (1) retrieve all matchmaking +// configurations, (2) retrieve configurations for a specified list, or (3) +// retrieve all configurations that use a specified rule set name. When requesting +// multiple items, use the 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] +// +// [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{} diff --git a/service/gamelift/api_op_DescribeMatchmakingRuleSets.go b/service/gamelift/api_op_DescribeMatchmakingRuleSets.go index dd1b5e68827..1ce63649210 100644 --- a/service/gamelift/api_op_DescribeMatchmakingRuleSets.go +++ b/service/gamelift/api_op_DescribeMatchmakingRuleSets.go @@ -15,8 +15,13 @@ import ( // existing rule sets for the Region, or provide a list of one or more rule set // 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) +// each requested name. +// +// # Learn more +// +// [Build a rule set] +// +// [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{} diff --git a/service/gamelift/api_op_DescribePlayerSessions.go b/service/gamelift/api_op_DescribePlayerSessions.go index e3431eb5be4..f977ed69617 100644 --- a/service/gamelift/api_op_DescribePlayerSessions.go +++ b/service/gamelift/api_op_DescribePlayerSessions.go @@ -11,11 +11,15 @@ 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. // @@ -23,8 +27,16 @@ import ( // ID, or player ID. You can filter this request by player session status. If you // provide a specific PlayerSessionId or PlayerId , Amazon GameLift ignores the // filter criteria. 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) +// sequential pages. +// +// If successful, a PlayerSession object is returned for each session that matches +// the request. +// +// # Related actions +// +// [All APIs by task] +// +// [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{} @@ -64,13 +76,18 @@ type DescribePlayerSessionsInput struct { // Player session status to filter results on. Note that when a PlayerSessionId or // PlayerId is provided in a DescribePlayerSessions request, then the - // PlayerSessionStatusFilter has no effect on the response. Possible player session - // statuses include the following: + // 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). PlayerSessionStatusFilter *string diff --git a/service/gamelift/api_op_DescribeRuntimeConfiguration.go b/service/gamelift/api_op_DescribeRuntimeConfiguration.go index 4d2a6b8f39b..7ea7deaefac 100644 --- a/service/gamelift/api_op_DescribeRuntimeConfiguration.go +++ b/service/gamelift/api_op_DescribeRuntimeConfiguration.go @@ -16,12 +16,21 @@ import ( // managed EC2 fleets, the runtime configuration describes server processes that // run on each fleet instance. For container fleets, the runtime configuration // describes server processes that run in each replica container group. You can -// update a fleet's runtime configuration at any time using -// UpdateRuntimeConfiguration . To get the current runtime configuration 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 Amazon 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) +// update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration. +// +// To get the current runtime configuration 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 Amazon GameLift fleets] +// +// [Running multiple processes on a fleet] +// +// [Setting up Amazon 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 f3362a53265..a225599e2de 100644 --- a/service/gamelift/api_op_DescribeScalingPolicies.go +++ b/service/gamelift/api_op_DescribeScalingPolicies.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves all scaling policies applied to a fleet. To get a fleet's scaling -// policies, specify the fleet ID. You can filter this request by policy status, -// such as to retrieve only active scaling policies. Use the pagination parameters -// to retrieve results as a set of sequential pages. If successful, set of -// ScalingPolicy objects is returned for the fleet. A fleet may have all of its -// scaling policies suspended. This operation does not affect the status of the -// scaling policies, which remains ACTIVE. +// Retrieves all scaling policies applied to a fleet. +// +// To get a fleet's scaling policies, specify the fleet ID. You can filter this +// request by policy status, such as to retrieve only active scaling policies. Use +// the pagination parameters to retrieve results as a set of sequential pages. If +// successful, set of ScalingPolicy objects is returned for the fleet. +// +// A fleet may have all of its scaling policies suspended. This operation does not +// affect the status of the scaling policies, which remains ACTIVE. func (c *Client) DescribeScalingPolicies(ctx context.Context, params *DescribeScalingPoliciesInput, optFns ...func(*Options)) (*DescribeScalingPoliciesOutput, error) { if params == nil { params = &DescribeScalingPoliciesInput{} @@ -45,7 +47,7 @@ type DescribeScalingPoliciesInput struct { // get results as a set of sequential pages. Limit *int32 - // The fleet location. If you don't specify this value, the response contains the + // The fleet location. If you don't specify this value, the response contains the // scaling policies of every location in the fleet. Location *string @@ -56,14 +58,19 @@ type DescribeScalingPoliciesInput struct { // 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. + // + // - 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. + // + // - 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 diff --git a/service/gamelift/api_op_DescribeScript.go b/service/gamelift/api_op_DescribeScript.go index a4e8db627c3..b3df56640a9 100644 --- a/service/gamelift/api_op_DescribeScript.go +++ b/service/gamelift/api_op_DescribeScript.go @@ -11,10 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// 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] +// +// # Related actions +// +// [All APIs by task] +// +// [Amazon GameLift Realtime Servers]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html +// [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 b227eb581d7..fdcc2cf055f 100644 --- a/service/gamelift/api_op_DescribeVpcPeeringAuthorizations.go +++ b/service/gamelift/api_op_DescribeVpcPeeringAuthorizations.go @@ -14,7 +14,13 @@ 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] +// +// [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 9028fb00c84..e427ac9fa61 100644 --- a/service/gamelift/api_op_DescribeVpcPeeringConnections.go +++ b/service/gamelift/api_op_DescribeVpcPeeringConnections.go @@ -12,13 +12,20 @@ import ( ) // Retrieves information on VPC peering connections. Use this operation to get -// peering information for all fleets or for one specific fleet ID. To retrieve -// connection information, call this operation from the Amazon Web Services account -// that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave -// 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) +// peering information for all fleets or for one specific fleet ID. +// +// To retrieve connection information, call this operation from the Amazon Web +// Services account that is used to manage the Amazon GameLift fleets. Specify a +// fleet ID or leave 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] +// +// [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 44410adb584..d3befc52574 100644 --- a/service/gamelift/api_op_GetComputeAccess.go +++ b/service/gamelift/api_op_GetComputeAccess.go @@ -11,23 +11,43 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Requests authorization to -// remotely connect to a hosting resource in a Amazon GameLift managed fleet. This -// operation is not used with Amazon GameLift Anywhere fleets To request access, -// specify the compute name and the fleet ID. If successful, this operation returns -// a set of temporary Amazon Web Services credentials, including a two-part access -// key and a session token. EC2 fleets With an EC2 fleet (where compute type is EC2 -// ), use these credentials with Amazon EC2 Systems Manager (SSM) to start a -// session with the compute. For more details, see Starting a session (CLI) (https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli) -// in the Amazon EC2 Systems Manager User Guide. Container fleets With a container -// fleet (where compute type is CONTAINER ), use these credentials and the target -// value with SSM to connect to the fleet instance where the container is running. -// After you're connected to the instance, use Docker commands to interact with the -// container. Learn more -// - Remotely connect to 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 connect to a container fleet (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-remote-access.html) +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Requests authorization to remotely connect to a hosting resource in a Amazon +// GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere +// fleets +// +// To request access, specify the compute name and the fleet ID. If successful, +// this operation returns a set of temporary Amazon Web Services credentials, +// including a two-part access key and a session token. +// +// # EC2 fleets +// +// With an EC2 fleet (where compute type is EC2 ), use these credentials with +// Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more +// details, see [Starting a session (CLI)]in the Amazon EC2 Systems Manager User Guide. +// +// # Container fleets +// +// With a container fleet (where compute type is CONTAINER ), use these credentials +// and the target value with SSM to connect to the fleet instance where the +// container is running. After you're connected to the instance, use Docker +// commands to interact with the container. +// +// # Learn more +// +// [Remotely connect to fleet instances] +// +// [Debug fleet issues] +// +// [Remotely connect to a container fleet] +// +// [Remotely connect to fleet instances]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html +// [Remotely connect to a container fleet]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-remote-access.html +// [Debug fleet issues]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html +// [Starting a session (CLI)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli func (c *Client) GetComputeAccess(ctx context.Context, params *GetComputeAccessInput, optFns ...func(*Options)) (*GetComputeAccessOutput, error) { if params == nil { params = &GetComputeAccessInput{} @@ -65,10 +85,11 @@ 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 an Amazon 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] ) that is assigned to an Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ComputeArn *string // The identifier of the compute resource to be accessed. This value might be @@ -79,10 +100,11 @@ type GetComputeAccessOutput struct { // the compute resource with Amazon EC2 Systems Manager (SSM). 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // The ID of the fleet that holds the compute resource to be accessed. diff --git a/service/gamelift/api_op_GetComputeAuthToken.go b/service/gamelift/api_op_GetComputeAuthToken.go index 6da8eba2dc5..0052416933d 100644 --- a/service/gamelift/api_op_GetComputeAuthToken.go +++ b/service/gamelift/api_op_GetComputeAuthToken.go @@ -16,22 +16,32 @@ import ( // running on the compute use this token to communicate with the Amazon GameLift // service, such as when calling the Amazon GameLift server SDK action InitSDK() . // Authentication tokens are valid for a limited time span, so you need to request -// a fresh token before the current token expires. Use this operation based on the -// fleet compute type: +// a fresh token before the current token expires. +// +// Use this operation based on the fleet compute type: +// // - For EC2 fleets, auth token retrieval and refresh is handled automatically. // All game servers that are running on all fleet instances have access to a valid // auth token. +// // - For ANYWHERE and CONTAINER fleets, if you're using the Amazon GameLift // Agent, auth token retrieval and refresh is handled automatically for any // container or Anywhere compute where the Agent is running. If you're not using // the Agent, create a mechanism to retrieve and refresh auth tokens for computes // that are running game server processes. // -// 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) -// - Server SDK reference guides (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) -// (for version 5.x) +// # Learn more +// +// [Create an Anywhere fleet] +// +// [Test your integration] +// +// [Server SDK reference guides] +// - (for version 5.x) +// +// [Test your integration]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html +// [Server SDK reference guides]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html +// [Create an Anywhere fleet]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html func (c *Client) GetComputeAuthToken(ctx context.Context, params *GetComputeAuthTokenInput, optFns ...func(*Options)) (*GetComputeAuthTokenOutput, error) { if params == nil { params = &GetComputeAuthTokenInput{} @@ -72,10 +82,11 @@ type GetComputeAuthTokenOutput struct { // A valid temporary authentication token. AuthToken *string - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to an Amazon 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] ) that is assigned to an Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ComputeArn *string // The name of the compute resource that the authentication token is issued to. @@ -84,10 +95,11 @@ type GetComputeAuthTokenOutput struct { // The amount of time until the authentication token is no longer valid. 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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 1a182d1fb1a..920597ddd54 100644 --- a/service/gamelift/api_op_GetGameSessionLogUrl.go +++ b/service/gamelift/api_op_GetGameSessionLogUrl.go @@ -13,10 +13,15 @@ import ( // Retrieves the location of stored game session logs for a specified game session // on Amazon GameLift managed fleets. When a game session is terminated, Amazon // 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) +// days. Use this URL to download the logs. +// +// See the [Amazon Web Services Service Limits] page for maximum log file sizes. Log files that exceed this limit are +// not saved. +// +// [All APIs by task] +// +// [Amazon Web Services Service Limits]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift +// [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{} diff --git a/service/gamelift/api_op_GetInstanceAccess.go b/service/gamelift/api_op_GetInstanceAccess.go index 3a2168f3ba2..d0555fef2e3 100644 --- a/service/gamelift/api_op_GetInstanceAccess.go +++ b/service/gamelift/api_op_GetInstanceAccess.go @@ -14,22 +14,38 @@ import ( // Requests authorization to remotely connect to an instance in an Amazon GameLift // managed fleet. Use this operation to connect to instances with game servers that // use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game -// servers that use server SDK 5.x or later, call GetComputeAccess . To request -// access to an instance, specify IDs for the instance and the fleet it belongs to. -// You can retrieve instance IDs for a fleet by calling DescribeInstances (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html) -// with the fleet ID. If successful, this operation returns an IP address and -// credentials. The returned credentials match the operating system of the -// instance, as follows: +// servers that use server SDK 5.x or later, call GetComputeAccess. +// +// To request access to an instance, specify IDs for the instance and the fleet it +// belongs to. You can retrieve instance IDs for a fleet by calling [DescribeInstances]with the fleet +// ID. +// +// If successful, this operation returns an IP address and credentials. The +// returned credentials match the operating system of the instance, as follows: +// // - For a Windows instance: returns a user name and secret (password) for use // with a Windows Remote Desktop client. +// // - For a Linux instance: returns a user name and secret (RSA private key) for // use with an SSH client. You must save the secret to a .pem file. If you're -// using the CLI, see the example Get credentials for a Linux instance (https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess.html#API_GetInstanceAccess_Examples) -// for tips on automatically saving the secret to a .pem file. +// using the CLI, see the example [Get credentials for a Linux instance]for tips on automatically saving the secret to +// a .pem file. +// +// # Learn more // -// Learn more Remotely connect to 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) +// [Remotely connect to fleet instances] +// +// [Debug fleet issues] +// +// # Related actions +// +// [All APIs by task] +// +// [Remotely connect to fleet instances]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html +// [DescribeInstances]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html +// [Get credentials for a Linux instance]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess.html#API_GetInstanceAccess_Examples +// [Debug fleet issues]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html +// [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{} @@ -50,8 +66,10 @@ type GetInstanceAccessInput struct { // A unique identifier for the fleet that contains the instance you want to // access. You can request access to instances in EC2 fleets with the following // statuses: ACTIVATING , ACTIVE , or ERROR . Use either a fleet ID or an ARN - // value. You can access fleets in ERROR status for a short period of time before - // Amazon GameLift deletes them. + // value. + // + // You can access fleets in ERROR status for a short period of time before Amazon + // GameLift deletes them. // // This member is required. FleetId *string diff --git a/service/gamelift/api_op_ListAliases.go b/service/gamelift/api_op_ListAliases.go index 7fe520d5488..00bccf21d76 100644 --- a/service/gamelift/api_op_ListAliases.go +++ b/service/gamelift/api_op_ListAliases.go @@ -13,8 +13,15 @@ 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) +// parameters to retrieve results in sequential pages. +// +// Returned aliases are not listed in any particular order. +// +// # Related actions +// +// [All APIs by task] +// +// [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{} @@ -47,13 +54,18 @@ type ListAliasesInput struct { // 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: + // 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. + // TerminalRoutingStrategyException with the [RoutingStrategy]message embedded. + // + // [RoutingStrategy]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html RoutingStrategyType types.RoutingStrategyType noSmithyDocumentSerde diff --git a/service/gamelift/api_op_ListBuilds.go b/service/gamelift/api_op_ListBuilds.go index 8cb6187fcc5..2b607ae0729 100644 --- a/service/gamelift/api_op_ListBuilds.go +++ b/service/gamelift/api_op_ListBuilds.go @@ -14,9 +14,18 @@ import ( // 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) +// results in a set of sequential pages. +// +// Build resources are not listed in any particular order. +// +// # Learn more +// +// [Upload a Custom Server Build] +// +// [All APIs by task] +// +// [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{} @@ -44,12 +53,17 @@ type ListBuildsInput struct { NextToken *string // Build status to filter results by. To retrieve all builds, leave this parameter - // empty. Possible build statuses include the following: + // 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. Status types.BuildStatus diff --git a/service/gamelift/api_op_ListCompute.go b/service/gamelift/api_op_ListCompute.go index 7a12d68f5ba..3ad832cd612 100644 --- a/service/gamelift/api_op_ListCompute.go +++ b/service/gamelift/api_op_ListCompute.go @@ -11,19 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Retrieves information on the -// compute resources in an Amazon GameLift fleet. To request a list of computes, -// specify the fleet ID. Use the pagination parameters to retrieve results in a set -// of sequential pages. You can filter the result set by location. If successful, -// this operation returns information on all computes in the requested fleet. -// Depending on the fleet's compute type, the result includes the following -// information: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Retrieves information on the compute resources in an Amazon GameLift fleet. +// +// To request a list of computes, specify the fleet ID. Use the pagination +// parameters to retrieve results in a set of sequential pages. +// +// You can filter the result set by location. +// +// If successful, this operation returns information on all computes in the +// requested fleet. Depending on the fleet's compute type, the result includes the +// following information: +// // - For EC2 fleets, this operation returns information about the EC2 instance. // Compute names are instance IDs. +// // - For ANYWHERE fleets, this operation returns the compute names and details // provided when the compute was registered with RegisterCompute . The // GameLiftServiceSdkEndpoint or GameLiftAgentEndpoint is included. +// // - For CONTAINER fleets, this operation returns information about containers // that are registered as computes, and the instances they're running on. Compute // names are container names. diff --git a/service/gamelift/api_op_ListContainerGroupDefinitions.go b/service/gamelift/api_op_ListContainerGroupDefinitions.go index 90e2803e391..59b677a7a81 100644 --- a/service/gamelift/api_op_ListContainerGroupDefinitions.go +++ b/service/gamelift/api_op_ListContainerGroupDefinitions.go @@ -11,14 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift containers feature, which is -// currently in public preview. Retrieves all container group definitions for the -// Amazon Web Services account and Amazon Web Services Region that are currently in -// use. You can filter the result set by the container groups' scheduling strategy. -// Use the pagination parameters to retrieve results in a set of sequential pages. +// This operation is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Retrieves all container group definitions for the Amazon Web Services account +// and Amazon Web Services Region that are currently in use. You can filter the +// result set by the container groups' scheduling strategy. Use the pagination +// parameters to retrieve results in a set of sequential pages. +// // This operation returns the list of container group definitions in no particular -// order. Learn more -// - Manage a container group definition (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html) +// order. +// +// # Learn more +// +// [Manage a container group definition] +// +// [Manage a container group definition]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html func (c *Client) ListContainerGroupDefinitions(ctx context.Context, params *ListContainerGroupDefinitionsInput, optFns ...func(*Options)) (*ListContainerGroupDefinitionsOutput, error) { if params == nil { params = &ListContainerGroupDefinitionsInput{} @@ -46,8 +55,10 @@ type ListContainerGroupDefinitionsInput struct { NextToken *string // The type of container group definitions to retrieve. + // // - DAEMON -- Daemon container groups run background processes and are deployed // once per fleet instance. + // // - REPLICA -- Replica container groups run your game server application and // supporting software. Replica groups might be deployed multiple times per fleet // instance. diff --git a/service/gamelift/api_op_ListFleets.go b/service/gamelift/api_op_ListFleets.go index c789385a2f1..1c416548483 100644 --- a/service/gamelift/api_op_ListFleets.go +++ b/service/gamelift/api_op_ListFleets.go @@ -10,25 +10,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Retrieves a collection of fleet -// resources in an Amazon Web Services Region. 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. You can use operation in the following ways: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Retrieves a collection of fleet resources in an Amazon Web Services Region. 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. +// +// You can use operation 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 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 with a specific container group definition, // provide the ContainerGroupDefinition ID. // // Use the pagination parameters to retrieve results as a set of sequential pages. -// If successful, this operation returns a list of fleet IDs that match the request -// parameters. A NextToken value is also returned if there are more result pages to -// retrieve. Fleet IDs are returned in no particular order. +// +// If successful, this operation returns a list of fleet IDs that match the +// request parameters. A NextToken value is also returned if there are more result +// pages to retrieve. +// +// Fleet IDs are returned in no particular order. func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error) { if params == nil { params = &ListFleetsInput{} diff --git a/service/gamelift/api_op_ListGameServers.go b/service/gamelift/api_op_ListGameServers.go index 9e0dc7d783c..254a391e395 100644 --- a/service/gamelift/api_op_ListGameServers.go +++ b/service/gamelift/api_op_ListGameServers.go @@ -11,11 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server 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 Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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{} diff --git a/service/gamelift/api_op_ListScripts.go b/service/gamelift/api_op_ListScripts.go index 57eeb98e720..a9e478803c5 100644 --- a/service/gamelift/api_op_ListScripts.go +++ b/service/gamelift/api_op_ListScripts.go @@ -12,8 +12,18 @@ 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] +// +// # Related actions +// +// [All APIs by task] +// +// [Amazon GameLift Realtime Servers]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html +// [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{} diff --git a/service/gamelift/api_op_ListTagsForResource.go b/service/gamelift/api_op_ListTagsForResource.go index 4af329375d6..77ff8f58535 100644 --- a/service/gamelift/api_op_ListTagsForResource.go +++ b/service/gamelift/api_op_ListTagsForResource.go @@ -14,11 +14,23 @@ import ( // Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to // organize Amazon Web Services resources for a range of purposes. This operation // handles the permissions necessary to manage tags for Amazon GameLift resources -// that support tagging. 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) +// that support tagging. +// +// To list tags for a resource, specify the unique ARN value for the resource. +// +// # Learn more +// +// [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference +// +// [Amazon Web Services Tagging Strategies] +// +// # Related actions +// +// [All APIs by task] +// +// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Amazon Web Services Tagging Strategies]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/ +// [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{} @@ -36,11 +48,12 @@ 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 uniquely identifies the Amazon GameLift resource that you want to - // retrieve tags for. Amazon GameLift includes resource ARNs in the data object for - // the resource. You can retrieve the ARN by calling a List or Describe operation - // for the resource type. + // The Amazon Resource Name ([ARN] ) that uniquely identifies the Amazon GameLift + // resource that you want to retrieve tags for. Amazon GameLift includes resource + // ARNs in the data object for the resource. You can retrieve the ARN by calling a + // List or Describe operation for the resource type. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html // // This member is required. ResourceARN *string diff --git a/service/gamelift/api_op_PutScalingPolicy.go b/service/gamelift/api_op_PutScalingPolicy.go index c01fc388127..ca6db3915dc 100644 --- a/service/gamelift/api_op_PutScalingPolicy.go +++ b/service/gamelift/api_op_PutScalingPolicy.go @@ -18,49 +18,69 @@ import ( // There are two types of scaling policies: target-based and rule-based. Use a // target-based policy to quickly and efficiently manage fleet scaling; this option // is the most commonly used. Use rule-based policies when you need to exert -// fine-grained control over auto-scaling. Fleets can have multiple scaling -// policies of each type in force at the same time; you can have one target-based -// 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: -// 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 -// handle at current capacity. With a target-based policy, you set your ideal -// buffer size and leave it to Amazon GameLift to take whatever action is needed to -// maintain that target. For example, you might choose to maintain a 10% buffer for -// a fleet that has the capacity to host 100 simultaneous game sessions. This -// policy tells Amazon GameLift to take action whenever the fleet's available -// capacity falls below or rises above 10 game sessions. Amazon GameLift will start -// new instances or stop unused instances in order to return to the 10% buffer. To -// create or update a target-based policy, specify a fleet ID and name, and set the -// policy type to "TargetBased". Specify the metric to track +// fine-grained control over auto-scaling. +// +// Fleets can have multiple scaling policies of each type in force at the same +// time; you can have one target-based 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]. +// +// # 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 handle at current +// capacity. With a target-based policy, you set your ideal buffer size and leave +// it to Amazon GameLift to take whatever action is needed to maintain that target. +// +// For example, you might choose to maintain a 10% buffer for a fleet that has the +// capacity to host 100 simultaneous game sessions. This policy tells Amazon +// GameLift to take action whenever the fleet's available capacity falls below or +// rises above 10 game sessions. Amazon GameLift will start new instances or stop +// unused instances in order to return to the 10% buffer. +// +// To create or update a target-based policy, specify a fleet ID and name, and set +// the policy type to "TargetBased". Specify the metric to track // (PercentAvailableGameSessions) and reference a TargetConfiguration object with // your desired buffer value. Exclude all other parameters. On a successful // request, the policy name is returned. The scaling policy is automatically in // force as soon as it's successfully created. If the fleet's auto-scaling actions // are temporarily suspended, the new policy will be in force once the fleet -// actions are restarted. Rule-based policy A rule-based policy tracks specified -// fleet metric, sets a threshold value, and specifies the type of action to -// initiate when triggered. With a rule-based policy, you can select from several -// available fleet metrics. Each policy specifies whether to scale up or scale down -// (and by how much), so you need one policy for each type of action. For example, -// 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 -// 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 -// they're successfully created. If the fleet's auto-scaling actions are -// temporarily suspended, the new policy will be in force once the fleet actions -// are restarted. +// actions are restarted. +// +// # Rule-based policy +// +// A rule-based policy tracks specified fleet metric, sets a threshold value, and +// specifies the type of action to initiate when triggered. With a rule-based +// policy, you can select from several available fleet metrics. Each policy +// specifies whether to scale up or scale down (and by how much), so you need one +// policy for each type of action. +// +// For example, 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 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 they're +// successfully created. If the fleet's auto-scaling actions are temporarily +// suspended, the new policy will be in force once the fleet actions are restarted. +// +// [Set Up Fleet Automatic Scaling]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html func (c *Client) PutScalingPolicy(ctx context.Context, params *PutScalingPolicyInput, optFns ...func(*Options)) (*PutScalingPolicyOutput, error) { if params == nil { params = &PutScalingPolicyInput{} @@ -86,32 +106,43 @@ type PutScalingPolicyInput struct { FleetId *string // 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) - // . + // adjustment. For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift with Amazon CloudWatch]. + // // - 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. // + // [Monitor Amazon GameLift with Amazon CloudWatch]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html + // // This member is required. MetricName types.MetricName @@ -141,10 +172,13 @@ 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 diff --git a/service/gamelift/api_op_RegisterCompute.go b/service/gamelift/api_op_RegisterCompute.go index 039156d905a..bf97430ca13 100644 --- a/service/gamelift/api_op_RegisterCompute.go +++ b/service/gamelift/api_op_RegisterCompute.go @@ -11,27 +11,45 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Registers a compute resource in -// an Amazon GameLift fleet. Register computes with an Amazon GameLift Anywhere -// fleet or a container fleet. For an Anywhere fleet or a container fleet that's -// running the Amazon GameLift Agent, the Agent handles all compute registry tasks -// for you. For an Anywhere fleet that doesn't use the Agent, call this operation -// to register fleet computes. To register a compute, give the compute a name (must -// be unique within the fleet) and specify the compute resource's DNS name or IP -// address. Provide a fleet ID and a fleet location to associate with the compute -// being registered. You can optionally include the path to a TLS certificate on -// the compute resource. If successful, this operation returns compute details, -// including an Amazon GameLift SDK endpoint or Agent endpoint. Game server -// processes running on the compute can use this endpoint to communicate with the -// Amazon GameLift service. Each server process includes the SDK endpoint in its -// call to the Amazon GameLift server SDK action InitSDK() . To view compute -// details, call DescribeCompute (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute.html) -// with the compute name. 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) -// - Server SDK reference guides (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) -// (for version 5.x) +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Registers a compute resource in an Amazon GameLift fleet. Register computes +// with an Amazon GameLift Anywhere fleet or a container fleet. +// +// For an Anywhere fleet or a container fleet that's running the Amazon GameLift +// Agent, the Agent handles all compute registry tasks for you. For an Anywhere +// fleet that doesn't use the Agent, call this operation to register fleet +// computes. +// +// To register a compute, give the compute a name (must be unique within the +// fleet) and specify the compute resource's DNS name or IP address. Provide a +// fleet ID and a fleet location to associate with the compute being registered. +// You can optionally include the path to a TLS certificate on the compute +// resource. +// +// If successful, this operation returns compute details, including an Amazon +// GameLift SDK endpoint or Agent endpoint. Game server processes running on the +// compute can use this endpoint to communicate with the Amazon GameLift service. +// Each server process includes the SDK endpoint in its call to the Amazon GameLift +// server SDK action InitSDK() . +// +// To view compute details, call [DescribeCompute] with the compute name. +// +// # Learn more +// +// [Create an Anywhere fleet] +// +// [Test your integration] +// +// [Server SDK reference guides] +// - (for version 5.x) +// +// [Test your integration]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html +// [Server SDK reference guides]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html +// [DescribeCompute]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute.html +// [Create an Anywhere fleet]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html func (c *Client) RegisterCompute(ctx context.Context, params *RegisterComputeInput, optFns ...func(*Options)) (*RegisterComputeOutput, error) { if params == nil { params = &RegisterComputeInput{} diff --git a/service/gamelift/api_op_RegisterGameServer.go b/service/gamelift/api_op_RegisterGameServer.go index b27d25802ae..52cd1fa7388 100644 --- a/service/gamelift/api_op_RegisterGameServer.go +++ b/service/gamelift/api_op_RegisterGameServer.go @@ -11,19 +11,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Creates a new game server resource and notifies Amazon GameLift -// FleetIQ that the game server is ready to host gameplay and players. This -// operation is called by a game server process that is running on an instance in a -// game server group. Registering game servers enables Amazon GameLift FleetIQ to -// track available game servers and enables game clients and services to claim a -// game server for a new 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 Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Creates a new game server resource and notifies Amazon GameLift FleetIQ that +// the game server is ready to host gameplay and players. This operation is called +// by a game server process that is running on an instance in a game server group. +// Registering game servers enables Amazon GameLift FleetIQ to track available game +// servers and enables game clients and services to claim a game server for a new +// 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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{} diff --git a/service/gamelift/api_op_RequestUploadCredentials.go b/service/gamelift/api_op_RequestUploadCredentials.go index 8696e310d11..c90b398d06b 100644 --- a/service/gamelift/api_op_RequestUploadCredentials.go +++ b/service/gamelift/api_op_RequestUploadCredentials.go @@ -13,12 +13,21 @@ 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 CreateBuild (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 [CreateBuild]. +// +// 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] +// +// [All APIs by task] +// +// [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 +// [CreateBuild]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html +// [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{} diff --git a/service/gamelift/api_op_ResolveAlias.go b/service/gamelift/api_op_ResolveAlias.go index c6aaf1bedf6..d306757326c 100644 --- a/service/gamelift/api_op_ResolveAlias.go +++ b/service/gamelift/api_op_ResolveAlias.go @@ -11,9 +11,17 @@ import ( ) // Attempts to retrieve a fleet ID that is associated with an alias. Specify a -// unique alias identifier. If the alias has a SIMPLE routing strategy, Amazon -// GameLift returns a fleet ID. If the alias has a TERMINAL routing strategy, the -// result is a TerminalRoutingStrategyException . Related actions All APIs by task (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) +// unique alias identifier. +// +// If the alias has a SIMPLE routing strategy, Amazon GameLift returns a fleet ID. +// If the alias has a TERMINAL routing strategy, the result is a +// TerminalRoutingStrategyException . +// +// # Related actions +// +// [All APIs by task] +// +// [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{} @@ -42,8 +50,10 @@ 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] ) associated with the GameLift fleet resource that + // this alias points to. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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 342e03a3b05..946e3e6ba01 100644 --- a/service/gamelift/api_op_ResumeGameServerGroup.go +++ b/service/gamelift/api_op_ResumeGameServerGroup.go @@ -11,17 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Reinstates activity on a game server group after it has been -// suspended. A game server group might be suspended by the SuspendGameServerGroup -// operation, or it might be suspended involuntarily due to a configuration -// problem. In the second case, you can manually resume activity on the group once -// the configuration problem has been resolved. Refer to the game server group -// status 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 Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Reinstates activity on a game server group after it has been suspended. A game +// server group might be suspended by the SuspendGameServerGroupoperation, or it might be suspended +// involuntarily due to a configuration problem. In the second case, you can +// manually resume activity on the group once the configuration problem has been +// resolved. Refer to the game server group status 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 +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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 bcccbc5ca93..34bcff6a99e 100644 --- a/service/gamelift/api_op_SearchGameSessions.go +++ b/service/gamelift/api_op_SearchGameSessions.go @@ -12,49 +12,64 @@ import ( ) // 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 continually -// track game session status because that practice can cause you to exceed your API -// limit and generate errors. Instead, configure an Amazon Simple Notification -// Service (Amazon SNS) topic to receive notifications from a matchmaker or a game -// session placement queue. 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: +// sorts them into a specified order. +// +// This operation is not designed to continually track game session status because +// that practice can cause you to exceed your API limit and generate errors. +// Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to +// receive notifications from a matchmaker or a game session placement queue. +// +// 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. // // 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) -// . To set search and sort criteria, create a filter expression using the -// following game session attributes. For game session search examples, see the -// Examples section of this topic. +// To retrieve information on game sessions in other statuses, use [DescribeGameSessions]. +// +// To set search and sort criteria, create a filter expression using the following +// game session attributes. For game session search examples, see the Examples +// section of this topic. +// // - 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 -- A set of key-value pairs that can store custom // data in a game session. For example: {"Key": "difficulty", "Value": "novice"} -// . The filter expression must specify the GameProperty -- a Key and a string -// Value to search for the game sessions. For example, to search for the above -// key-value pair, specify the following search filter: -// gameSessionProperties.difficulty = "novice" . All game property values are -// searched as strings. For examples of searching game sessions, see the ones -// below, and also see Search game sessions by game property (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search) -// . +// . The filter expression must specify the GameProperty-- a Key and a string Value to search +// for the game sessions. +// +// For example, to search for the above key-value pair, specify the following +// +// search filter: gameSessionProperties.difficulty = "novice" . All game property +// values are searched as strings. +// +// For examples of searching game sessions, see the ones below, and also see [Search game sessions by game property]. +// // - 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 @@ -63,7 +78,13 @@ import ( // 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] +// +// [Search game sessions by game property]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search +// [DescribeGameSessions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html +// [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{} @@ -88,27 +109,41 @@ type SearchGameSessionsInput struct { // 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: + // 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: + // 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" . @@ -137,10 +172,13 @@ type SearchGameSessionsInput struct { // 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. diff --git a/service/gamelift/api_op_StartFleetActions.go b/service/gamelift/api_op_StartFleetActions.go index 5ac2ffbdc8e..49b265508db 100644 --- a/service/gamelift/api_op_StartFleetActions.go +++ b/service/gamelift/api_op_StartFleetActions.go @@ -11,20 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Resumes certain types of activity on fleet instances that were suspended with [StopFleetActions]. +// 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: +// 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. // // If successful, Amazon 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 Amazon -// GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// stopped, this operation will have no effect. +// +// # Learn more +// +// [Setting up Amazon GameLift fleets] +// +// [Setting up Amazon GameLift fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html +// [StopFleetActions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html func (c *Client) StartFleetActions(ctx context.Context, params *StartFleetActionsInput, optFns ...func(*Options)) (*StartFleetActionsOutput, error) { if params == nil { params = &StartFleetActionsInput{} @@ -62,10 +71,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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 8d8d034febf..a59bcea1799 100644 --- a/service/gamelift/api_op_StartGameSessionPlacement.go +++ b/service/gamelift/api_op_StartGameSessionPlacement.go @@ -14,34 +14,46 @@ import ( // Places a request for a new game session in a queue. When processing a placement // request, Amazon GameLift searches for available resources on the queue's // destinations, scanning each until it finds resources or the placement request -// times out. A game session placement request can also request player sessions. -// When a new game session is successfully created, Amazon GameLift creates a -// player session for each player included in the request. When placing a game -// session, by default Amazon GameLift tries each fleet in the order they are -// listed in the queue configuration. Ideally, a queue's destinations are listed in -// preference order. Alternatively, when requesting a game session with players, -// you can also provide latency data for each player in relevant Regions. Latency -// data indicates the performance lag a player experiences when connected to a -// fleet in the Region. Amazon GameLift uses latency data to reorder the list of -// destinations to place the game session in a Region with minimal lag. If latency -// 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: +// times out. +// +// A game session placement request can also request player sessions. When a new +// game session is successfully created, Amazon GameLift creates a player session +// for each player included in the request. +// +// When placing a game session, by default Amazon GameLift tries each fleet in the +// order they are listed in the queue configuration. Ideally, a queue's +// destinations are listed in preference order. +// +// Alternatively, when requesting a game session with players, you can also +// provide latency data for each player in relevant Regions. Latency data indicates +// the performance lag a player experiences when connected to a fleet in the +// Region. Amazon GameLift uses latency data to reorder the list of destinations to +// place the game session in a Region with minimal lag. If latency 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) // -// 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. +// If successful, a new game session placement is created. +// +// To track the status of a placement request, call [DescribeGameSessionPlacement] 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. +// +// [DescribeGameSessionPlacement]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html func (c *Client) StartGameSessionPlacement(ctx context.Context, params *StartGameSessionPlacementInput, optFns ...func(*Options)) (*StartGameSessionPlacementOutput, error) { if params == nil { params = &StartGameSessionPlacementInput{} @@ -87,8 +99,9 @@ type StartGameSessionPlacementInput struct { // 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]). + // + // [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 diff --git a/service/gamelift/api_op_StartMatchBackfill.go b/service/gamelift/api_op_StartMatchBackfill.go index 757af75d446..f105cae160f 100644 --- a/service/gamelift/api_op_StartMatchBackfill.go +++ b/service/gamelift/api_op_StartMatchBackfill.go @@ -16,28 +16,43 @@ import ( // matches. Backfill requests use the same matchmaker that was used to make the // original match, and they provide matchmaking data for all players currently in // the game session. FlexMatch uses this information to select new players so that -// backfilled match continues to meet the original match requirements. When using -// FlexMatch with Amazon GameLift managed hosting, you can request a backfill match -// from a 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, -// 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 -// matchmaking data for all current players in the game session being backfilled. -// Optionally, specify the GameSession ARN. If successful, a match backfill ticket -// 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 Amazon GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) +// backfilled match continues to meet the original match requirements. +// +// When using FlexMatch with Amazon GameLift managed hosting, you can request a +// backfill match from a 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, 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 matchmaking data for all current players in the +// game session being backfilled. Optionally, specify the GameSession ARN. If +// successful, a match backfill ticket 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] +// +// [Matchmaking events](reference) +// +// [How Amazon GameLift FlexMatch works] +// +// [How Amazon GameLift FlexMatch works]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html +// [Matchmaking events]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html +// [Backfill existing games with FlexMatch]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html func (c *Client) StartMatchBackfill(ctx context.Context, params *StartMatchBackfillInput, optFns ...func(*Options)) (*StartMatchBackfillOutput, error) { if params == nil { params = &StartMatchBackfillInput{} @@ -65,18 +80,24 @@ type StartMatchBackfillInput struct { // Match information on all players that are currently assigned to the game // 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. + // 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 + // as a string. For more details, see [Match 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. // + // [Match Data]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data + // // This member is required. Players []types.Player diff --git a/service/gamelift/api_op_StartMatchmaking.go b/service/gamelift/api_op_StartMatchmaking.go index 6f3855edfb2..95ad45e71d8 100644 --- a/service/gamelift/api_op_StartMatchmaking.go +++ b/service/gamelift/api_op_StartMatchmaking.go @@ -18,17 +18,29 @@ import ( // information on one or more players and specifies the FlexMatch matchmaker to // use. When a request is for multiple players, FlexMatch attempts to build a match // that includes all players in the request, placing them in the same team and -// finding additional players as needed to fill the match. To start matchmaking, -// provide a unique ticket ID, 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 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 Amazon GameLift FlexMatch works (https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html) +// finding additional players as needed to fill the match. +// +// To start matchmaking, provide a unique ticket ID, 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 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] +// +// [Set Up FlexMatch event notification] +// +// [How Amazon GameLift FlexMatch works] +// +// [Set Up FlexMatch event notification]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html +// [How Amazon GameLift FlexMatch works]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html +// [Add FlexMatch to a game client]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html func (c *Client) StartMatchmaking(ctx context.Context, params *StartMatchmakingInput, optFns ...func(*Options)) (*StartMatchmakingOutput, error) { if params == nil { params = &StartMatchmakingInput{} @@ -56,8 +68,9 @@ type StartMatchmakingInput struct { // 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. + // of the team the player is assigned to. + // + // You can include up to 10 Players in a StartMatchmaking request. // // This member is required. Players []types.Player diff --git a/service/gamelift/api_op_StopFleetActions.go b/service/gamelift/api_op_StopFleetActions.go index 6106dba9008..a436dc8804e 100644 --- a/service/gamelift/api_op_StopFleetActions.go +++ b/service/gamelift/api_op_StopFleetActions.go @@ -13,20 +13,31 @@ import ( // Suspends certain types of activity in a fleet location. Currently, this // operation is used to stop auto-scaling activity. For multi-location fleets, -// fleet actions are managed separately for each location. Stopping fleet actions -// 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: +// fleet actions are managed separately for each location. +// +// Stopping fleet actions 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: +// // - 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, Amazon 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) -// . To restart fleet actions again, call StartFleetActions (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartFleetActions.html) -// . Learn more Setting up Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// response to manual changes using [UpdateFleetCapacity]. To restart fleet actions again, call [StartFleetActions]. +// +// # Learn more +// +// [Setting up Amazon GameLift Fleets] +// +// [UpdateFleetCapacity]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html +// [Setting up Amazon GameLift Fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html +// [StartFleetActions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartFleetActions.html func (c *Client) StopFleetActions(ctx context.Context, params *StopFleetActionsInput, optFns ...func(*Options)) (*StopFleetActionsOutput, error) { if params == nil { params = &StopFleetActionsInput{} @@ -64,10 +75,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet to stop actions on. diff --git a/service/gamelift/api_op_StopMatchmaking.go b/service/gamelift/api_op_StopMatchmaking.go index 41a32350e6b..12a9ddaf3d3 100644 --- a/service/gamelift/api_op_StopMatchmaking.go +++ b/service/gamelift/api_op_StopMatchmaking.go @@ -13,13 +13,22 @@ 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 -// 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) +// 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] +// +// [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 ae3c6f74773..f9507353f7f 100644 --- a/service/gamelift/api_op_SuspendGameServerGroup.go +++ b/service/gamelift/api_op_SuspendGameServerGroup.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon 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: +// This operation is used with the Amazon 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: +// // - 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 @@ -26,8 +30,13 @@ import ( // // 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 Amazon GameLift -// FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// that the activity is listed in SuspendedActions . +// +// # Learn more +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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 29914c7dc8c..39033392737 100644 --- a/service/gamelift/api_op_TagResource.go +++ b/service/gamelift/api_op_TagResource.go @@ -15,13 +15,25 @@ import ( // resources, create IAM permissions policies to manage access to groups of // resources, customize Amazon Web Services cost breakdowns, and more. This // operation handles the permissions necessary to manage tags for Amazon GameLift -// resources that support tagging. 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 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) +// resources that support tagging. +// +// 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 resource. +// +// # Learn more +// +// [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference +// +// [Amazon Web Services Tagging Strategies] +// +// # Related actions +// +// [All APIs by task] +// +// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Amazon Web Services Tagging Strategies]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/ +// [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{} @@ -39,19 +51,21 @@ 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 uniquely identifies the Amazon GameLift resource that you want to assign - // tags to. Amazon GameLift includes resource ARNs in the data object for the - // resource. You can retrieve the ARN by calling a List or Describe operation for - // the resource type. + // The Amazon Resource Name ([ARN] ) that uniquely identifies the Amazon GameLift + // resource that you want to assign tags to. Amazon GameLift includes resource ARNs + // in the data object for the resource. You can retrieve the ARN by calling a List + // or Describe operation for the resource type. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html // // This member is required. ResourceARN *string // A list of one or more tags to assign to the specified Amazon 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 tagging limits. + // limit may be lower than stated. See [Tagging Amazon Web Services Resources]for tagging limits. + // + // [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/gamelift/api_op_UntagResource.go b/service/gamelift/api_op_UntagResource.go index 448a7af9c32..37eb0774ee0 100644 --- a/service/gamelift/api_op_UntagResource.go +++ b/service/gamelift/api_op_UntagResource.go @@ -13,13 +13,25 @@ import ( // Removes a tag assigned to a Amazon GameLift resource. You can use resource tags // to organize Amazon Web Services resources for a range of purposes. This // operation handles the permissions necessary to manage tags for Amazon GameLift -// resources that support tagging. 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 remove. This operation succeeds even if the list includes tags that -// aren't assigned to 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) +// resources that support tagging. +// +// 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 remove. This operation +// succeeds even if the list includes tags that aren't assigned to the resource. +// +// # Learn more +// +// [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference +// +// [Amazon Web Services Tagging Strategies] +// +// # Related actions +// +// [All APIs by task] +// +// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Amazon Web Services Tagging Strategies]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/ +// [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{} @@ -37,11 +49,12 @@ 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 uniquely identifies the Amazon GameLift resource that you want to remove - // tags from. Amazon GameLift includes resource ARNs in the data object for the - // resource. You can retrieve the ARN by calling a List or Describe operation for - // the resource type. + // The Amazon Resource Name ([ARN] ) that uniquely identifies the Amazon GameLift + // resource that you want to remove tags from. Amazon GameLift includes resource + // ARNs in the data object for the resource. You can retrieve the ARN by calling a + // List or Describe operation for the resource type. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html // // This member is required. ResourceARN *string diff --git a/service/gamelift/api_op_UpdateAlias.go b/service/gamelift/api_op_UpdateAlias.go index 9a012c7fb76..6cc0a9bc774 100644 --- a/service/gamelift/api_op_UpdateAlias.go +++ b/service/gamelift/api_op_UpdateAlias.go @@ -14,7 +14,13 @@ import ( // Updates properties for an alias. Specify the unique identifier of the alias to // be updated and the new property values. When reassigning an alias to a new // 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) +// record is returned. +// +// # Related actions +// +// [All APIs by task] +// +// [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{} diff --git a/service/gamelift/api_op_UpdateBuild.go b/service/gamelift/api_op_UpdateBuild.go index 4214e67bcb6..7bfdec7d09f 100644 --- a/service/gamelift/api_op_UpdateBuild.go +++ b/service/gamelift/api_op_UpdateBuild.go @@ -13,9 +13,16 @@ 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) +// If successful, a build object containing the updated metadata is returned. +// +// # Learn more +// +// [Upload a Custom Server Build] +// +// [All APIs by task] +// +// [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 646e7567512..296cfdcc68b 100644 --- a/service/gamelift/api_op_UpdateFleetAttributes.go +++ b/service/gamelift/api_op_UpdateFleetAttributes.go @@ -12,10 +12,17 @@ import ( ) // Updates a fleet's mutable attributes, such as 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, Amazon GameLift -// returns the identifiers for the updated fleet. Learn more Setting up Amazon -// GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// resource creation limits. +// +// To update fleet attributes, specify the fleet ID and the property values that +// you want to change. If successful, Amazon GameLift returns the identifiers for +// the updated fleet. +// +// # Learn more +// +// [Setting up Amazon GameLift fleets] +// +// [Setting up Amazon 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{} @@ -57,12 +64,15 @@ type UpdateFleetAttributesInput struct { // The game session protection policy to apply to all new game sessions created in // this fleet. Game sessions that already exist are not affected. You can set - // protection for individual game sessions using UpdateGameSession (https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) - // . + // protection for individual game sessions using [UpdateGameSession]. + // // - 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. + // + // [UpdateGameSession]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html NewGameSessionProtectionPolicy types.ProtectionPolicy // Policy settings that limit the number of game sessions an individual player can @@ -74,10 +84,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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 f00e20e7955..5a2510ecc15 100644 --- a/service/gamelift/api_op_UpdateFleetCapacity.go +++ b/service/gamelift/api_op_UpdateFleetCapacity.go @@ -10,38 +10,53 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Updates capacity settings for a -// managed EC2 fleet or container fleet. For these fleets, you adjust capacity by -// changing the number of instances in the fleet. Fleet capacity determines the -// number of game sessions and players that the fleet can host based on its -// configuration. For fleets with multiple locations, use this operation to manage -// capacity settings in each location individually. Use this operation to set these -// fleet capacity properties: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Updates capacity settings for a managed EC2 fleet or container fleet. For these +// fleets, you adjust capacity by changing the number of instances in the fleet. +// Fleet capacity determines the number of game sessions and players that the fleet +// can host based on its configuration. For fleets with multiple locations, use +// this operation to manage capacity settings in each location individually. +// +// Use this operation to set these fleet capacity properties: +// // - Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances // allowed. If Amazon GameLift receives a request--either through manual update or // automatic scaling--it won't change the capacity to a value outside of this // range. +// // - Desired capacity: As an alternative to automatic scaling, manually set the // number of Amazon EC2 instances to be maintained. Before changing a fleet's // desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance -// type by calling DescribeEC2InstanceLimits (https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html) -// . +// type by calling [DescribeEC2InstanceLimits]. // // 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, set the Location parameter to -// the location to update. The location must be in ACTIVE status. If successful, -// Amazon GameLift updates the capacity settings and returns the identifiers for -// the updated fleet and/or location. If a requested change to desired capacity -// exceeds the instance type's limit, the LimitExceeded exception occurs. Updates -// often prompt an immediate change in fleet capacity, such as when current -// capacity is different than the new desired capacity or outside the new limits. -// In this scenario, Amazon GameLift automatically initiates steps to add or remove -// instances in the fleet location. 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) -// . Learn more Scaling fleet capacity (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html) +// locations, omit the Location parameter. The fleet must be in ACTIVE status. +// +// To update capacity for a fleet's remote location, set the Location parameter to +// the location to update. The location must be in ACTIVE status. +// +// If successful, Amazon GameLift updates the capacity settings and returns the +// identifiers for the updated fleet and/or location. If a requested change to +// desired capacity exceeds the instance type's limit, the LimitExceeded exception +// occurs. +// +// Updates often prompt an immediate change in fleet capacity, such as when +// current capacity is different than the new desired capacity or outside the new +// limits. In this scenario, Amazon GameLift automatically initiates steps to add +// or remove instances in the fleet location. You can track a fleet's current +// capacity by calling [DescribeFleetCapacity]or [DescribeFleetLocationCapacity]. +// +// # Learn more +// +// [Scaling fleet capacity] +// +// [Scaling fleet capacity]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html +// [DescribeEC2InstanceLimits]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html +// [DescribeFleetLocationCapacity]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html +// [DescribeFleetCapacity]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html func (c *Client) UpdateFleetCapacity(ctx context.Context, params *UpdateFleetCapacityInput, optFns ...func(*Options)) (*UpdateFleetCapacityOutput, error) { if params == nil { params = &UpdateFleetCapacityInput{} @@ -88,10 +103,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that was updated. diff --git a/service/gamelift/api_op_UpdateFleetPortSettings.go b/service/gamelift/api_op_UpdateFleetPortSettings.go index c8b3c57b941..13b55cc45db 100644 --- a/service/gamelift/api_op_UpdateFleetPortSettings.go +++ b/service/gamelift/api_op_UpdateFleetPortSettings.go @@ -12,17 +12,27 @@ import ( ) // Updates permissions that allow inbound traffic to connect to game sessions 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 +// 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 existing -// fleet permissions. For a container fleet, inbound permissions must specify port -// numbers that are defined in the fleet's connection port settings. 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 Amazon -// GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// fleet permissions. +// +// For a container fleet, inbound permissions must specify port numbers that are +// defined in the fleet's connection port settings. +// +// 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 Amazon GameLift fleets] +// +// [Setting up Amazon 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{} @@ -57,10 +67,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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 fd0dd625de5..2b5c06043df 100644 --- a/service/gamelift/api_op_UpdateGameServer.go +++ b/service/gamelift/api_op_UpdateGameServer.go @@ -11,27 +11,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Updates information about a registered game server to help Amazon -// GameLift FleetIQ track game server availability. This operation is called by a -// game 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: +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Updates information about a registered game server to help Amazon GameLift +// FleetIQ track game server availability. This operation is called by a game +// 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 from AVAILABLE (when the game // server is available to be claimed) to UTILIZED (when the game server is // currently hosting games). Identify the game server and game server group and // specify the new utilization status. You can't change the status from to // UTILIZED to AVAILABLE . +// // - 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 Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// timestamps are updated. +// +// # Learn more +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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{} diff --git a/service/gamelift/api_op_UpdateGameServerGroup.go b/service/gamelift/api_op_UpdateGameServerGroup.go index 07f3c8e2bcc..c1107959065 100644 --- a/service/gamelift/api_op_UpdateGameServerGroup.go +++ b/service/gamelift/api_op_UpdateGameServerGroup.go @@ -11,15 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is used with the Amazon GameLift FleetIQ solution and game -// server groups. Updates Amazon GameLift FleetIQ-specific properties for a game -// server group. Many Auto Scaling group properties are updated on the Auto Scaling -// group directly, including the launch template, Auto Scaling policies, and -// maximum/minimum/desired instance counts. To update the game server group, -// specify the game server group ID and provide the updated values. Before applying -// the updates, the new values are validated to ensure that Amazon GameLift FleetIQ -// can continue to perform instance balancing activity. If successful, a -// GameServerGroup object is returned. Learn more Amazon GameLift FleetIQ Guide (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) +// This operation is used with the Amazon GameLift FleetIQ solution and game +// +// server groups. +// +// Updates Amazon GameLift FleetIQ-specific properties for a game server group. +// Many Auto Scaling group properties are updated on the Auto Scaling group +// directly, including the launch template, Auto Scaling policies, and +// maximum/minimum/desired instance counts. +// +// To update the game server group, specify the game server group ID and provide +// the updated values. Before applying the updates, the new values are validated to +// ensure that Amazon GameLift FleetIQ can continue to perform instance balancing +// activity. If successful, a GameServerGroup object is returned. +// +// # Learn more +// +// [Amazon GameLift FleetIQ Guide] +// +// [Amazon 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,16 +55,19 @@ type UpdateGameServerGroupInput struct { // Indicates how Amazon 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. @@ -74,17 +87,20 @@ type UpdateGameServerGroupInput struct { // The instance definitions must specify at least two different instance types that // are supported by Amazon 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) - // in the Amazon EC2 Auto Scaling User Guide. + // information on instance types, see [EC2 Instance Types]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]in the Amazon EC2 Auto Scaling User + // Guide. + // + // [Instance Weighting for Amazon EC2 Auto Scaling]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html + // [EC2 Instance Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html 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] ) for an IAM role that allows Amazon GameLift to + // access your Amazon EC2 Auto Scaling groups. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html RoleArn *string noSmithyDocumentSerde @@ -92,7 +108,8 @@ type UpdateGameServerGroupInput struct { type UpdateGameServerGroupOutput struct { - // An object that describes the game server group resource with updated properties. + // An object that describes the game server group resource with updated + // properties. GameServerGroup *types.GameServerGroup // Metadata pertaining to the operation's result. diff --git a/service/gamelift/api_op_UpdateGameSession.go b/service/gamelift/api_op_UpdateGameSession.go index 4b8316b3b16..6b302c40474 100644 --- a/service/gamelift/api_op_UpdateGameSession.go +++ b/service/gamelift/api_op_UpdateGameSession.go @@ -11,9 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// 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] +// +// [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{} @@ -40,8 +47,9 @@ type UpdateGameSessionInput struct { // example: {"Key": "difficulty", "Value": "novice"} . You can use this parameter // to modify game properties in an active game session. This action adds new // properties and modifies existing properties. There is no way to delete - // properties. For an example, see Update the value of a game property (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-update) - // . + // properties. For an example, see [Update the value of a game property]. + // + // [Update the value of a game property]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-update GameProperties []types.GameProperty // The maximum number of players that can be connected simultaneously to the game @@ -56,8 +64,10 @@ type UpdateGameSessionInput struct { 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. ProtectionPolicy types.ProtectionPolicy diff --git a/service/gamelift/api_op_UpdateGameSessionQueue.go b/service/gamelift/api_op_UpdateGameSessionQueue.go index 9d6512a838e..68148d6efb7 100644 --- a/service/gamelift/api_op_UpdateGameSessionQueue.go +++ b/service/gamelift/api_op_UpdateGameSessionQueue.go @@ -14,7 +14,13 @@ 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] +// +// [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{} @@ -56,8 +62,9 @@ type UpdateGameSessionQueueInput struct { 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) - // . + // notifications. See [Setting up notifications for game session placement]. + // + // [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 4326221a3a5..e30931089cc 100644 --- a/service/gamelift/api_op_UpdateMatchmakingConfiguration.go +++ b/service/gamelift/api_op_UpdateMatchmakingConfiguration.go @@ -14,7 +14,13 @@ import ( // 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) +// new settings. +// +// # Learn more +// +// [Design a FlexMatch matchmaker] +// +// [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{} @@ -59,9 +65,10 @@ type UpdateMatchmakingConfigurationInput struct { // 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]. Automatic backfill + // is not available when FlexMatchMode is set to STANDALONE . + // + // [Backfill Existing Games with FlexMatch]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html BackfillMode types.BackfillMode // Information to add to all events related to the matchmaking configuration. @@ -72,11 +79,14 @@ type UpdateMatchmakingConfigurationInput struct { // Indicates whether this matchmaking configuration is being used with Amazon // 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. + // including players and team assignments, in a [MatchmakingSucceeded]event. + // // - WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift // queue to start a game session for the match. + // + // [MatchmakingSucceeded]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded FlexMatchMode types.FlexMatchMode // A set of key-value pairs that can store custom data in a game session. For @@ -87,24 +97,27 @@ type UpdateMatchmakingConfigurationInput struct { // 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 + // session (see [Start a Game Session]). 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 . + // + // [Start a Game Session]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession GameSessionData *string - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to a Amazon 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 Amazon GameLift-hosted game sessions for matches - // that are created with this matchmaking configuration. If FlexMatchMode is set - // to STANDALONE , do not set this parameter. + // The Amazon Resource Name ([ARN] ) that is assigned to a Amazon 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 Amazon GameLift-hosted game sessions for + // matches that are created with this matchmaking configuration. If FlexMatchMode + // is set to STANDALONE , do not set this parameter. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html 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) - // for more information. + // An SNS topic ARN that is set up to receive matchmaking notifications. See [Setting up notifications for matchmaking] for + // more information. + // + // [Setting up notifications for matchmaking]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html NotificationTarget *string // The maximum duration, in seconds, that a matchmaking ticket can remain in diff --git a/service/gamelift/api_op_UpdateRuntimeConfiguration.go b/service/gamelift/api_op_UpdateRuntimeConfiguration.go index 48fd900f706..71d8847fc78 100644 --- a/service/gamelift/api_op_UpdateRuntimeConfiguration.go +++ b/service/gamelift/api_op_UpdateRuntimeConfiguration.go @@ -17,14 +17,23 @@ import ( // on each fleet instance. For container fleets, it describes what server processes // to run in each replica container group. You can update a fleet's runtime // configuration at any time after the fleet is created; it does not need to be in -// ACTIVE status. To update runtime configuration, specify the fleet ID and provide -// a RuntimeConfiguration with an updated set of server process configurations. If -// successful, the fleet's runtime configuration settings are updated. Fleet +// ACTIVE status. +// +// To update runtime configuration, specify the fleet ID and provide a +// RuntimeConfiguration with an updated set of server process configurations. +// +// If successful, the fleet's runtime configuration settings are updated. Fleet // computes that run game server processes regularly check for and receive updated // runtime configurations. The computes immediately take action to comply with the // new configuration by launching new server processes or by not replacing existing // processes when they shut down. Updating a fleet's runtime configuration never -// affects existing server processes. Learn more Setting up Amazon GameLift fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html) +// affects existing server processes. +// +// # Learn more +// +// [Setting up Amazon GameLift fleets] +// +// [Setting up Amazon 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{} diff --git a/service/gamelift/api_op_UpdateScript.go b/service/gamelift/api_op_UpdateScript.go index 1194a1c157d..8f12a28e660 100644 --- a/service/gamelift/api_op_UpdateScript.go +++ b/service/gamelift/api_op_UpdateScript.go @@ -11,16 +11,31 @@ 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 -// 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) +// 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] +// +// # Related actions +// +// [All APIs by task] +// +// [Amazon GameLift Realtime Servers]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html +// [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{} @@ -64,6 +79,7 @@ type UpdateScriptInput struct { // A data object containing your Realtime scripts and dependencies as a zip file. // The zip file can have one or multiple files. Maximum size of a zip file is 5 MB. + // // 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 diff --git a/service/gamelift/api_op_ValidateMatchmakingRuleSet.go b/service/gamelift/api_op_ValidateMatchmakingRuleSet.go index 090594b839b..6b71b9f16bf 100644 --- a/service/gamelift/api_op_ValidateMatchmakingRuleSet.go +++ b/service/gamelift/api_op_ValidateMatchmakingRuleSet.go @@ -13,8 +13,13 @@ import ( // Validates the syntax of a matchmaking rule or rule set. This operation checks // 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) +// string. +// +// # Learn more +// +// [Build a rule set] +// +// [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 9a65d6e3eca..a2f0afd989a 100644 --- a/service/gamelift/doc.go +++ b/service/gamelift/doc.go @@ -7,35 +7,47 @@ // servers in the cloud, including tools for deploying, operating, and scaling game // servers. Built on Amazon Web Services global computing infrastructure, GameLift // helps you deliver high-performance, high-reliability, low-cost game servers -// while dynamically scaling your resource usage to meet player demand. About -// Amazon GameLift solutions Get more information on these Amazon GameLift -// solutions in the Amazon GameLift Developer Guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/) -// . +// while dynamically scaling your resource usage to meet player demand. +// +// # About Amazon GameLift solutions +// +// Get more information on these Amazon GameLift solutions in the [Amazon GameLift Developer Guide]. +// // - Amazon GameLift managed hosting -- Amazon 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 Amazon 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 Amazon // GameLift infrastructure already built in. Then use the full range of Amazon // GameLift managed hosting features, including FlexMatch, for your game. +// // - Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone // service while hosting your games using EC2 instances and Auto Scaling groups. // Amazon GameLift FleetIQ provides optimizations for game hosting, including // boosting the viability of low-cost Spot Instances gaming. For a complete // solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services. +// // - Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. // FlexMatch is a customizable matchmaking service for multiplayer games. Use // FlexMatch as integrated with Amazon 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: -// - Amazon GameLift API operations listed by tasks (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html) -// - Amazon GameLift tools and resources (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html) +// # 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: +// +// [Amazon GameLift API operations listed by tasks] +// +// [Amazon GameLift tools and resources] +// +// [Amazon GameLift API operations listed by tasks]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html +// [Amazon GameLift Developer Guide]: https://docs.aws.amazon.com/gamelift/latest/developerguide/ +// [Amazon GameLift tools and resources]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html package gamelift diff --git a/service/gamelift/options.go b/service/gamelift/options.go index e7f7d52575c..dcb86a94b49 100644 --- a/service/gamelift/options.go +++ b/service/gamelift/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/gamelift/types/enums.go b/service/gamelift/types/enums.go index 0454a016592..3707eed6776 100644 --- a/service/gamelift/types/enums.go +++ b/service/gamelift/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AcceptanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceptanceType) Values() []AcceptanceType { return []AcceptanceType{ "ACCEPT", @@ -29,8 +30,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for BalancingStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BalancingStrategy) Values() []BalancingStrategy { return []BalancingStrategy{ "SPOT_ONLY", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for BuildStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BuildStatus) Values() []BuildStatus { return []BuildStatus{ "INITIALIZED", @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for CertificateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateType) Values() []CertificateType { return []CertificateType{ "DISABLED", @@ -107,8 +112,9 @@ const ( ) // Values returns all known values for ComparisonOperatorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperatorType) Values() []ComparisonOperatorType { return []ComparisonOperatorType{ "GreaterThanOrEqualToThreshold", @@ -128,8 +134,9 @@ const ( ) // Values returns all known values for ComputeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeStatus) Values() []ComputeStatus { return []ComputeStatus{ "PENDING", @@ -148,8 +155,9 @@ const ( ) // Values returns all known values for ComputeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeType) Values() []ComputeType { return []ComputeType{ "EC2", @@ -170,8 +178,9 @@ const ( // Values returns all known values for ContainerDependencyCondition. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerDependencyCondition) Values() []ContainerDependencyCondition { return []ContainerDependencyCondition{ "START", @@ -192,8 +201,9 @@ const ( // Values returns all known values for ContainerGroupDefinitionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerGroupDefinitionStatus) Values() []ContainerGroupDefinitionStatus { return []ContainerGroupDefinitionStatus{ "READY", @@ -211,6 +221,7 @@ const ( // Values returns all known values for ContainerOperatingSystem. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContainerOperatingSystem) Values() []ContainerOperatingSystem { return []ContainerOperatingSystem{ @@ -228,6 +239,7 @@ const ( // Values returns all known values for ContainerSchedulingStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContainerSchedulingStrategy) Values() []ContainerSchedulingStrategy { return []ContainerSchedulingStrategy{ @@ -418,8 +430,9 @@ const ( ) // Values returns all known values for EC2InstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EC2InstanceType) Values() []EC2InstanceType { return []EC2InstanceType{ "t2.micro", @@ -641,8 +654,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -691,8 +705,9 @@ const ( ) // Values returns all known values for FilterInstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterInstanceStatus) Values() []FilterInstanceStatus { return []FilterInstanceStatus{ "ACTIVE", @@ -708,8 +723,9 @@ const ( ) // Values returns all known values for FleetAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetAction) Values() []FleetAction { return []FleetAction{ "AUTO_SCALING", @@ -733,8 +749,9 @@ const ( ) // Values returns all known values for FleetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetStatus) Values() []FleetStatus { return []FleetStatus{ "NEW", @@ -759,8 +776,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -777,8 +795,9 @@ const ( ) // Values returns all known values for FlexMatchMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlexMatchMode) Values() []FlexMatchMode { return []FlexMatchMode{ "STANDALONE", @@ -794,8 +813,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CLAIMED", @@ -810,8 +830,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "REPLACE_INSTANCE_TYPES", @@ -829,6 +850,7 @@ const ( // Values returns all known values for GameServerGroupDeleteOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GameServerGroupDeleteOption) Values() []GameServerGroupDeleteOption { return []GameServerGroupDeleteOption{ @@ -934,6 +956,7 @@ const ( // Values returns all known values for GameServerGroupInstanceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GameServerGroupInstanceType) Values() []GameServerGroupInstanceType { return []GameServerGroupInstanceType{ @@ -1042,8 +1065,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NEW", @@ -1064,8 +1088,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "HEALTHY", @@ -1083,6 +1108,7 @@ const ( // 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{ @@ -1102,6 +1128,7 @@ const ( // Values returns all known values for GameServerProtectionPolicy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GameServerProtectionPolicy) Values() []GameServerProtectionPolicy { return []GameServerProtectionPolicy{ @@ -1120,6 +1147,7 @@ const ( // Values returns all known values for GameServerUtilizationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GameServerUtilizationStatus) Values() []GameServerUtilizationStatus { return []GameServerUtilizationStatus{ @@ -1141,6 +1169,7 @@ const ( // Values returns all known values for GameSessionPlacementState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GameSessionPlacementState) Values() []GameSessionPlacementState { return []GameSessionPlacementState{ @@ -1164,8 +1193,9 @@ const ( ) // Values returns all known values for GameSessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GameSessionStatus) Values() []GameSessionStatus { return []GameSessionStatus{ "ACTIVE", @@ -1184,8 +1214,9 @@ const ( ) // Values returns all known values for GameSessionStatusReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GameSessionStatusReason) Values() []GameSessionStatusReason { return []GameSessionStatusReason{ "INTERRUPTED", @@ -1201,8 +1232,9 @@ const ( // Values returns all known values for InstanceRoleCredentialsProvider. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceRoleCredentialsProvider) Values() []InstanceRoleCredentialsProvider { return []InstanceRoleCredentialsProvider{ "SHARED_CREDENTIAL_FILE", @@ -1219,8 +1251,9 @@ const ( ) // Values returns all known values for InstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStatus) Values() []InstanceStatus { return []InstanceStatus{ "PENDING", @@ -1238,8 +1271,9 @@ const ( ) // Values returns all known values for IpProtocol. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpProtocol) Values() []IpProtocol { return []IpProtocol{ "TCP", @@ -1256,8 +1290,9 @@ const ( ) // Values returns all known values for LocationFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocationFilter) Values() []LocationFilter { return []LocationFilter{ "AWS", @@ -1273,8 +1308,9 @@ const ( ) // Values returns all known values for LocationUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocationUpdateStatus) Values() []LocationUpdateStatus { return []LocationUpdateStatus{ "PENDING_UPDATE", @@ -1297,8 +1333,9 @@ const ( // Values returns all known values for MatchmakingConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchmakingConfigurationStatus) Values() []MatchmakingConfigurationStatus { return []MatchmakingConfigurationStatus{ "CANCELLED", @@ -1331,8 +1368,9 @@ const ( ) // Values returns all known values for MetricName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricName) Values() []MetricName { return []MetricName{ "ActivatingGameSessions", @@ -1362,8 +1400,9 @@ const ( ) // Values returns all known values for OperatingSystem. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperatingSystem) Values() []OperatingSystem { return []OperatingSystem{ "WINDOWS_2012", @@ -1384,6 +1423,7 @@ const ( // Values returns all known values for PlayerSessionCreationPolicy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PlayerSessionCreationPolicy) Values() []PlayerSessionCreationPolicy { return []PlayerSessionCreationPolicy{ @@ -1403,8 +1443,9 @@ const ( ) // Values returns all known values for PlayerSessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlayerSessionStatus) Values() []PlayerSessionStatus { return []PlayerSessionStatus{ "RESERVED", @@ -1423,8 +1464,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "RuleBased", @@ -1443,8 +1485,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1463,8 +1506,9 @@ const ( ) // Values returns all known values for ProtectionPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectionPolicy) Values() []ProtectionPolicy { return []ProtectionPolicy{ "NoProtection", @@ -1481,8 +1525,9 @@ const ( ) // Values returns all known values for RoutingStrategyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoutingStrategyType) Values() []RoutingStrategyType { return []RoutingStrategyType{ "SIMPLE", @@ -1500,8 +1545,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ChangeInCapacity", @@ -1524,8 +1570,9 @@ const ( ) // Values returns all known values for ScalingStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingStatusType) Values() []ScalingStatusType { return []ScalingStatusType{ "ACTIVE", @@ -1547,8 +1594,9 @@ const ( ) // 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. +// in the future, and so 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/errors.go b/service/gamelift/types/errors.go index 9949c8eaac0..b5d139c63e2 100644 --- a/service/gamelift/types/errors.go +++ b/service/gamelift/types/errors.go @@ -282,10 +282,12 @@ func (e *NotFoundException) ErrorCode() string { } func (e *NotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because Amazon GameLift has not yet finished validating -// this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with -// exponential backoffs and jitter (http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) +// The operation failed because Amazon GameLift has not yet finished validating +// +// this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with [exponential backoffs and jitter] // . +// +// [exponential backoffs and jitter]: http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/ type NotReadyException struct { Message *string diff --git a/service/gamelift/types/types.go b/service/gamelift/types/types.go index c7026165b10..d8dc16d32d6 100644 --- a/service/gamelift/types/types.go +++ b/service/gamelift/types/types.go @@ -7,14 +7,21 @@ 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] +// +// [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 Amazon 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] ) that is assigned to a Amazon 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. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html AliasArn *string // A unique identifier for the alias. Alias IDs are unique within a Region. @@ -46,10 +53,11 @@ type Alias struct { type AnywhereConfiguration struct { // The cost to run your fleet per hour. Amazon 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) + // your fleet to balance usage in queues. For more information about queues, see [Setting up queues] // in the Amazon GameLift Developer Guide. // + // [Setting up queues]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html + // // This member is required. Cost *string @@ -82,15 +90,19 @@ type AttributeValue struct { // Amazon Web Services account security credentials that allow interactions with // Amazon GameLift resources. The credentials are temporary and valid for a limited -// time span. You can request fresh credentials at any time. Amazon Web Services -// security credentials consist of three parts: an access key ID, a secret access -// key, and a session token. You must use all three parts together to authenticate -// your access requests. You need Amazon Web Services credentials for the following -// tasks: +// time span. You can request fresh credentials at any time. +// +// Amazon Web Services security credentials consist of three parts: an access key +// ID, a secret access key, and a session token. You must use all three parts +// together to authenticate your access requests. +// +// You need Amazon Web Services credentials for the following tasks: +// // - To upload a game server build directly to Amazon GameLift S3 storage using -// CreateBuild . To get access for this task, call RequestUploadCredentials . +// CreateBuild . To get access for this task, call RequestUploadCredentials. +// // - To remotely connect to an active Amazon GameLift fleet instances. To get -// remote access, call GetComputeAccess . +// remote access, call GetComputeAccess. type AwsCredentials struct { // The access key ID that identifies the temporary security credentials. @@ -106,14 +118,19 @@ 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] +// +// [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 Amazon GameLift build resource and uniquely identifies it. ARNs - // are unique across all Regions. Format is + // The Amazon Resource Name ([ARN] ) assigned to a Amazon 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. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html BuildArn *string // A unique identifier for the build. @@ -124,9 +141,10 @@ type Build struct { CreationTime *time.Time // A descriptive label associated with a build. Build names don't 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]or [UpdateBuild]. + // + // [CreateBuild]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html + // [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 @@ -141,12 +159,17 @@ type Build struct { // 0. SizeOnDisk *int64 - // Current status of the build. Possible build statuses include the following: + // 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. Status BuildStatus @@ -158,17 +181,24 @@ type Build struct { noSmithyDocumentSerde } -// This data type has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. 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 Amazon GameLift Server SDK (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html) -// operation GetInstanceCertificate . +// This data type has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// 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 [Amazon GameLift Server SDK]operation +// GetInstanceCertificate . +// +// [Amazon GameLift Server SDK]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html type CertificateConfiguration struct { - // Indicates whether a TLS/SSL certificate is generated for a fleet. Valid values - // include: + // 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. // // This member is required. @@ -177,7 +207,10 @@ type CertificateConfiguration struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server +// +// groups. +// // Filters which game servers may be claimed when calling ClaimGameServer . type ClaimFilterOption struct { @@ -188,13 +221,19 @@ type ClaimFilterOption struct { noSmithyDocumentSerde } -// This data type has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. An Amazon GameLift compute -// resource for hosting your game servers. Computes in an Amazon GameLift fleet -// differs depending on the fleet's compute type property as follows: +// This data type has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// An Amazon GameLift compute resource for hosting your game servers. Computes in +// an Amazon GameLift fleet differs depending on the fleet's compute type property +// as follows: +// // - For EC2 fleets, a compute is an EC2 instance. +// // - For ANYWHERE fleets, a compute is a computing resource that you provide and // is registered to the fleet. +// // - For CONTAINER fleets, a compute is a container that's registered to the // fleet. type Compute struct { @@ -212,7 +251,7 @@ type Compute struct { // game sessions. ComputeStatus ComputeStatus - // Some attributes of a container. + // Some attributes of a container. ContainerAttributes *ContainerAttributes // A time stamp indicating when this data object was created. Format is a number @@ -229,7 +268,7 @@ type Compute struct { // A unique identifier for the fleet that the compute belongs to. FleetId *string - // The endpoint of the Amazon GameLift Agent. + // The endpoint of the Amazon GameLift Agent. GameLiftAgentEndpoint *string // The Amazon GameLift SDK endpoint connection for a registered compute resource @@ -237,7 +276,7 @@ type Compute struct { // connect to the Amazon GameLift service. GameLiftServiceSdkEndpoint *string - // The InstanceID of the Instance hosting the compute for Container and Managed + // The InstanceID of the Instance hosting the compute for Container and Managed // EC2 fleets. InstanceId *string @@ -259,11 +298,15 @@ type Compute struct { noSmithyDocumentSerde } -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. The set of port numbers to open -// on each instance in a container fleet. Connection ports are used by inbound -// traffic to connect with processes that are running in containers on the fleet. -// Part of: ContainerGroupsConfiguration , ContainerGroupsAttributes +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// The set of port numbers to open on each instance in a container fleet. +// Connection ports are used by inbound traffic to connect with processes that are +// running in containers on the fleet. +// +// Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes type ConnectionPortRange struct { // Starting value for the port range. @@ -280,12 +323,15 @@ type ConnectionPortRange struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. Describes attributes of containers that are -// deployed to a fleet with compute type CONTAINER . +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Describes attributes of containers that are deployed to a fleet with compute +// type CONTAINER . type ContainerAttributes struct { - // Describes how container ports map to connection ports on the fleet instance. + // Describes how container ports map to connection ports on the fleet instance. // Incoming traffic connects to a game via a connection port. A // ContainerPortMapping directs the traffic from a connection port to a port on the // container that hosts the game session. @@ -294,13 +340,18 @@ type ContainerAttributes struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. Describes a container in a container fleet, the -// resources available to the container, and the commands that are run when the -// container starts. Container properties can't be updated. To change a property, -// create a new container group definition. See also ContainerDefinitionInput . -// Part of: ContainerGroupDefinition Returned by: DescribeContainerGroupDefinition -// , ListContainerGroupDefinitions +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Describes a container in a container fleet, the resources available to the +// container, and the commands that are run when the container starts. Container +// properties can't be updated. To change a property, create a new container group +// definition. See also ContainerDefinitionInput. +// +// Part of: ContainerGroupDefinition +// +// Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions type ContainerDefinition struct { // The container definition identifier. Container names are unique within a @@ -316,15 +367,17 @@ type ContainerDefinition struct { ImageUri *string // A command that's passed to the container on startup. Each argument for the - // command is an additional string in the array. See the - // ContainerDefinition::command (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command) - // parameter in the Amazon Elastic Container Service API reference. + // command is an additional string in the array. See the [ContainerDefinition::command]parameter in the Amazon + // Elastic Container Service API reference. + // + // [ContainerDefinition::command]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command Command []string // The number of CPU units that are reserved for the container. Note: 1 vCPU unit // equals 1024 CPU units. If no resources are reserved, the container shares the - // total CPU limit for the container group. Related data type: - // ContainerGroupDefinition$TotalCpuLimit + // total CPU limit for the container group. + // + // Related data type: ContainerGroupDefinition$TotalCpuLimit Cpu *int32 // Indicates that the container relies on the status of other containers in the @@ -333,14 +386,16 @@ type ContainerDefinition struct { DependsOn []ContainerDependency // The entry point that's passed to the container on startup. If there are - // multiple arguments, each argument is an additional string in the array. See the - // ContainerDefinition::entryPoint (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint) + // multiple arguments, each argument is an additional string in the array. See the [ContainerDefinition::entryPoint] // parameter in the Amazon Elastic Container Service API Reference. + // + // [ContainerDefinition::entryPoint]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint EntryPoint []string // A set of environment variables that's passed to the container on startup. See - // the ContainerDefinition::environment (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment) - // parameter in the Amazon Elastic Container Service API Reference. + // the [ContainerDefinition::environment]parameter in the Amazon Elastic Container Service API Reference. + // + // [ContainerDefinition::environment]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment Environment []ContainerEnvironment // Indicates whether the container is vital to the container group. If an @@ -357,8 +412,9 @@ type ContainerDefinition struct { // The amount of memory that Amazon GameLift makes available to the container. If // memory limits aren't set for an individual container, the container shares the - // container group's total memory allocation. Related data type: - // ContainerGroupDefinition$TotalMemoryLimit + // container group's total memory allocation. + // + // Related data type: ContainerGroupDefinition$TotalMemoryLimit MemoryLimits *ContainerMemoryLimits // Defines the ports that are available to assign to processes in the container. @@ -373,22 +429,26 @@ type ContainerDefinition struct { // container fleet. The digest is a SHA 256 hash of the container image manifest. ResolvedImageDigest *string - // The directory in the container where commands are run. See the - // ContainerDefinition::workingDirectory (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory) - // parameter in the Amazon Elastic Container Service API Reference. + // The directory in the container where commands are run. See the [ContainerDefinition::workingDirectory] parameter in + // the Amazon Elastic Container Service API Reference. + // + // [ContainerDefinition::workingDirectory]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory WorkingDirectory *string noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. Describes a container's configuration, resources, -// and start instructions. Use this data type to create a container group -// definition. For the properties of a container that's been deployed to a fleet, -// see ContainerDefinition . You can't change these properties after you've created -// the container group definition. If you need a container group with different -// properties, then you must create a new one. Used with: -// CreateContainerGroupDefinition +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Describes a container's configuration, resources, and start instructions. Use +// this data type to create a container group definition. For the properties of a +// container that's been deployed to a fleet, see ContainerDefinition. You can't change these +// properties after you've created the container group definition. If you need a +// container group with different properties, then you must create a new one. +// +// Used with: CreateContainerGroupDefinition type ContainerDefinitionInput struct { // A string that uniquely identifies the container definition within a container @@ -401,66 +461,86 @@ type ContainerDefinitionInput struct { // container fleet. Images in Amazon Elastic Container Registry private // repositories are supported. The repository must be in the same Amazon Web // Services account and Amazon Web Services Region where you're creating the - // container group definition. For limits on image size, see Amazon GameLift - // endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/gamelift.html) - // . You can use any of the following image URI formats: + // container group definition. For limits on image size, see [Amazon GameLift endpoints and quotas]. You can use any of + // the following image URI formats: + // // - Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository // ID] + // // - Image ID and digest: [AWS account].dkr.ecr.[AWS // region].amazonaws.com/[repository ID]@[digest] + // // - Image ID and tag: [AWS account].dkr.ecr.[AWS // region].amazonaws.com/[repository ID]:[tag] // + // [Amazon GameLift endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/gamelift.html + // // This member is required. ImageUri *string // A command to pass to the container on startup. Add multiple arguments as - // additional strings in the array. See the ContainerDefinition command (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command) - // parameter in the Amazon Elastic Container Service API reference. + // additional strings in the array. See the [ContainerDefinition command]parameter in the Amazon Elastic + // Container Service API reference. + // + // [ContainerDefinition command]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-command Command []string // The number of CPU units to reserve for this container. The container can use // more resources when needed, if available. Note: 1 vCPU unit equals 1024 CPU // units. If you don't reserve CPU units for this container, then it shares the // total CPU limit for the container group. This property is similar to the Amazon - // ECS container definition parameter environment (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_environment) - // (Amazon Elastic Container Service Developer Guide). Related data type: - // ContainerGroupDefinition$TotalCpuLimit + // ECS container definition parameter [environment](Amazon Elastic Container Service Developer + // Guide). + // + // Related data type: ContainerGroupDefinition$TotalCpuLimit + // + // [environment]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_environment Cpu *int32 // Sets up dependencies between this container and the status of other containers // in the same container group. A container can have dependencies on multiple - // different containers. You can use dependencies to establish a startup/shutdown - // sequence across the container group. A container startup dependency is reversed - // on shutdown. For example, you might specify that SideCarContainerB has a START - // dependency on SideCarContainerA. This dependency means that SideCarContainerB - // can't start until after SideCarContainerA has started. This dependency is - // reversed on shutdown, which means that SideCarContainerB must shut down before + // different containers. + // + // You can use dependencies to establish a startup/shutdown sequence across the + // container group. A container startup dependency is reversed on shutdown. + // + // For example, you might specify that SideCarContainerB has a START dependency on + // SideCarContainerA. This dependency means that SideCarContainerB can't start + // until after SideCarContainerA has started. This dependency is reversed on + // shutdown, which means that SideCarContainerB must shut down before // SideCarContainerA can shut down. DependsOn []ContainerDependency // An entry point to pass to the container on startup. Add multiple arguments as - // additional strings in the array. See the ContainerDefinition::entryPoint (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint) - // parameter in the Amazon Elastic Container Service API Reference. + // additional strings in the array. See the [ContainerDefinition::entryPoint]parameter in the Amazon Elastic + // Container Service API Reference. + // + // [ContainerDefinition::entryPoint]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-entryPoint EntryPoint []string - // A set of environment variables to pass to the container on startup. See the - // ContainerDefinition::environment (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment) + // A set of environment variables to pass to the container on startup. See the [ContainerDefinition::environment] // parameter in the Amazon Elastic Container Service API Reference. + // + // [ContainerDefinition::environment]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment Environment []ContainerEnvironment // Specifies whether the container is vital for the container group to function // properly. If an essential container fails, it causes the entire container group - // to restart. Each container group must have an essential container. Replica - // container groups - A replica group must have exactly one essential container. - // Use the following to configure an essential replica container: + // to restart. Each container group must have an essential container. + // + // Replica container groups - A replica group must have exactly one essential + // container. Use the following to configure an essential replica container: + // // - Choose a container is running your game server and the Amazon GameLift // Agent. + // // - Include a port configuration. This container runs your game server // processes, and each process requires a container port to allow access to game // clients. + // // - Don't configure a health check. The Agent handles this task for the // essential replica container. + // // Daemon container groups - A daemon group must have at least one essential // container. Essential *bool @@ -475,7 +555,9 @@ type ContainerDefinitionInput struct { // The amount of memory to make available to the container. If you don't specify // memory limits for this container, then it shares the container group's total - // memory allocation. Related data type: ContainerGroupDefinition$TotalMemoryLimit + // memory allocation. + // + // Related data type: ContainerGroupDefinition$TotalMemoryLimit MemoryLimits *ContainerMemoryLimits // A set of ports that Amazon GameLift can assign to processes in the container. @@ -483,39 +565,53 @@ type ContainerDefinitionInput struct { // processes, must be assigned a port from this set. The set of ports must be large // enough to assign one to each process in the container that needs one. If the // container includes your game server, include enough ports to assign one port to - // each concurrent server process (as defined in a container fleet's - // RuntimeConfiguration ). For more details, see Networking for container fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-network) - // . Container ports aren't directly accessed by inbound traffic. Amazon GameLift + // each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more + // details, see [Networking for container fleets]. + // + // Container ports aren't directly accessed by inbound traffic. Amazon GameLift // maps these container ports to externally accessible connection ports, which are // assigned as needed from the container fleet's ConnectionPortRange . + // + // [Networking for container fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-network PortConfiguration *ContainerPortConfiguration - // The directory in the container where commands are run. See the - // ContainerDefinition::workingDirectory parameter (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory) - // in the Amazon Elastic Container Service API Reference. + // The directory in the container where commands are run. See the [ContainerDefinition::workingDirectory parameter] in the Amazon + // Elastic Container Service API Reference. + // + // [ContainerDefinition::workingDirectory parameter]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-workingDirectory WorkingDirectory *string noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. A container's dependency on another container in -// the same container group. The dependency impacts how the dependent container is -// able to start or shut down based the status of the other container. For example, -// ContainerA is configured with the following dependency: a START dependency on -// ContainerB. This means that ContainerA can't start until ContainerB has started. -// It also means that ContainerA must shut down before ContainerB. Part of: -// ContainerDefinition +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// A container's dependency on another container in the same container group. The +// dependency impacts how the dependent container is able to start or shut down +// based the status of the other container. +// +// For example, ContainerA is configured with the following dependency: a START +// dependency on ContainerB. This means that ContainerA can't start until +// ContainerB has started. It also means that ContainerA must shut down before +// ContainerB. +// +// Part of: ContainerDefinition type ContainerDependency struct { // The condition that the dependency container must reach before the dependent // container can start. Valid conditions include: + // // - START - The dependency container must have started. + // // - COMPLETE - The dependency container has run to completion (exits). Use this // condition with nonessential containers, such as those that run a script and then // exit. The dependency container can't be an essential container. + // // - SUCCESS - The dependency container has run to completion and exited with a // zero status. The dependency container can't be an essential container. + // // - HEALTHY - The dependency container has passed its Docker health check. Use // this condition with dependency containers that have health checks configured. // This condition is confirmed at container group startup only. @@ -531,10 +627,14 @@ type ContainerDependency struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. An environment variable to set inside a container, -// in the form of a key-value pair. Related data type: -// ContainerDefinition$Environment +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// An environment variable to set inside a container, in the form of a key-value +// pair. +// +// Related data type: ContainerDefinition$Environment type ContainerEnvironment struct { // The environment variable name. @@ -550,22 +650,28 @@ type ContainerEnvironment struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. The properties that describe a container group -// resource. Container group definition properties can't be updated. To change a -// property, create a new container group definition. Used with: -// CreateContainerGroupDefinition Returned by: DescribeContainerGroupDefinition , -// ListContainerGroupDefinitions +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// The properties that describe a container group resource. Container group +// definition properties can't be updated. To change a property, create a new +// container group definition. +// +// Used with: CreateContainerGroupDefinition +// +// Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions type ContainerGroupDefinition struct { - // The set of container definitions that are included in the container group. + // The set of container definitions that are included in the container group. ContainerDefinitions []ContainerDefinition - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It - // uniquely identifies the resource across all Amazon Web Services Regions. Format - // is arn:aws:gamelift:::containergroupdefinition/[container group definition name] - // . + // The Amazon Resource Name ([ARN] ) that is assigned to an Amazon GameLift + // ContainerGroupDefinition resource. It uniquely identifies the resource across + // all Amazon Web Services Regions. Format is + // arn:aws:gamelift:::containergroupdefinition/[container group definition name] . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ContainerGroupDefinitionArn *string // A time stamp indicating when this data object was created. Format is a number @@ -585,12 +691,15 @@ type ContainerGroupDefinition struct { SchedulingStrategy ContainerSchedulingStrategy // Current status of the container group definition resource. Values include: + // // - COPYING -- Amazon GameLift is in the process of making copies of all // container images that are defined in the group. While in this state, the // resource can't be used to create a container fleet. + // // - READY -- Amazon GameLift has copied the registry images for all containers // that are defined in the group. You can use a container group definition in this // status to create a container fleet. + // // - FAILED -- Amazon GameLift failed to create a valid container group // definition resource. For more details on the cause of the failure, see // StatusReason . A container group definition resource in failed status will be @@ -599,51 +708,69 @@ type ContainerGroupDefinition struct { // Additional information about a container group definition that's in FAILED // status. Possible reasons include: + // // - An internal issue prevented Amazon GameLift from creating the container - // group definition resource. Delete the failed resource and call - // CreateContainerGroupDefinition again. + // group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain. + // // - An access-denied message means that you don't have permissions to access - // the container image on ECR. See IAM permission examples (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html) - // for help setting up required IAM permissions for Amazon GameLift. + // the container image on ECR. See [IAM permission examples]for help setting up required IAM permissions + // for Amazon GameLift. + // // - The ImageUri value for at least one of the containers in the container group // definition was invalid or not found in the current Amazon Web Services account. + // // - At least one of the container images referenced in the container group - // definition exceeds the allowed size. For size limits, see Amazon GameLift - // endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/gamelift.html) - // . + // definition exceeds the allowed size. For size limits, see [Amazon GameLift endpoints and quotas]. + // // - At least one of the container images referenced in the container group // definition uses a different operating system than the one defined for the // container group. + // + // [IAM permission examples]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html + // [Amazon GameLift endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/gamelift.html StatusReason *string // The amount of CPU units on a fleet instance to allocate for the container // group. All containers in the group share these resources. This property is an - // integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set - // additional limits for each ContainerDefinition in the group. If individual - // containers have limits, this value must be equal to or greater than the sum of - // all container-specific CPU limits in the group. For more details on memory - // allocation, see the Container fleet design guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet) - // . + // integer value in CPU units (1 vCPU is equal to 1024 CPU units). + // + // You can set additional limits for each ContainerDefinition in the group. If individual containers + // have limits, this value must be equal to or greater than the sum of all + // container-specific CPU limits in the group. + // + // For more details on memory allocation, see the [Container fleet design guide]. + // + // [Container fleet design guide]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet TotalCpuLimit *int32 // The amount of memory (in MiB) on a fleet instance to allocate for the container - // group. All containers in the group share these resources. You can set additional - // limits for each ContainerDefinition in the group. If individual containers have - // limits, this value must meet the following requirements: + // group. All containers in the group share these resources. + // + // You can set additional limits for each ContainerDefinition in the group. If individual containers + // have limits, this value must meet the following requirements: + // // - Equal to or greater than the sum of all container-specific soft memory // limits in the group. + // // - Equal to or greater than any container-specific hard limits in the group. - // For more details on memory allocation, see the Container fleet design guide (https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet) - // . + // + // For more details on memory allocation, see the [Container fleet design guide]. + // + // [Container fleet design guide]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet TotalMemoryLimit *int32 noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. The properties of a container group that is -// deployed to a container fleet. Part of: ContainerGroupsAttributes Returned by: -// DescribeFleetAttributes +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// The properties of a container group that is deployed to a container fleet. +// +// Part of: ContainerGroupsAttributes +// +// Returned by: DescribeFleetAttributes type ContainerGroupDefinitionProperty struct { // The unique identifier for the container group definition. @@ -656,22 +783,26 @@ type ContainerGroupDefinitionProperty struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. The properties of container groups that are running -// on a container fleet. Container group properties for a fleet can't be changed. -// Returned by: DescribeFleetAttributes , CreateFleet +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// The properties of container groups that are running on a container fleet. +// Container group properties for a fleet can't be changed. +// +// Returned by: DescribeFleetAttributes, CreateFleet type ContainerGroupsAttributes struct { // A set of ports that allow inbound traffic to connect to processes running in // the fleet's container groups. Amazon GameLift maps each connection port to a // container port, which is assigned to a specific container process. A fleet's // connection port range can't be changed, but you can control access to connection - // ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings . + // ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings. ConnectionPortRange *ConnectionPortRange // A collection of properties that describe each container group in the fleet. A - // container fleet is deployed with one or more ContainerGroupDefinition - // resources, which is where these properties are set. + // container fleet is deployed with one or more ContainerGroupDefinitionresources, which is where these + // properties are set. ContainerGroupDefinitionProperties []ContainerGroupDefinitionProperty // Details about the number of replica container groups that Amazon GameLift @@ -681,25 +812,34 @@ type ContainerGroupsAttributes struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. Configuration details for a set of container -// groups, for use when creating a fleet with compute type CONTAINER . Used with: -// CreateFleet +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Configuration details for a set of container groups, for use when creating a +// fleet with compute type CONTAINER . +// +// Used with: CreateFleet type ContainerGroupsConfiguration struct { // A set of ports to allow inbound traffic, including game clients, to connect to - // processes running in the container fleet. Connection ports are dynamically - // mapped to container ports, which are assigned to individual processes running in - // a container. The connection port range must have enough ports to map to all - // container ports across a fleet instance. To calculate the minimum connection - // ports needed, use the following formula: [Total number of container ports as - // defined for containers in the replica container group] * [Desired or calculated - // number of replica container groups per instance] + [Total number of container - // ports as defined for containers in the daemon container group] As a best - // practice, double the minimum number of connection ports. Use the fleet's - // EC2InboundPermissions property to control external access to connection ports. - // Set this property to the connection port numbers that you want to open access - // to. See IpPermission for more details. + // processes running in the container fleet. + // + // Connection ports are dynamically mapped to container ports, which are assigned + // to individual processes running in a container. The connection port range must + // have enough ports to map to all container ports across a fleet instance. To + // calculate the minimum connection ports needed, use the following formula: + // + // [Total number of container ports as defined for containers in the replica + // container group] * [Desired or calculated number of replica container groups per + // instance] + [Total number of container ports as defined for containers in the + // daemon container group] + // + // As a best practice, double the minimum number of connection ports. + // + // Use the fleet's EC2InboundPermissions property to control external access to + // connection ports. Set this property to the connection port numbers that you want + // to open access to. See IpPermissionfor more details. // // This member is required. ConnectionPortRange *ConnectionPortRange @@ -720,20 +860,29 @@ type ContainerGroupsConfiguration struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. Determines how many replica container groups that -// Amazon GameLift deploys to each instance in a container fleet. Amazon GameLift -// calculates the maximum possible replica groups per instance based on the -// instance 's CPU and memory resources. When deploying a fleet, Amazon GameLift -// places replica container groups on each fleet instance based on the following: +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Determines how many replica container groups that Amazon GameLift deploys to +// each instance in a container fleet. +// +// Amazon GameLift calculates the maximum possible replica groups per instance +// based on the instance 's CPU and memory resources. When deploying a fleet, +// Amazon GameLift places replica container groups on each fleet instance based on +// the following: +// // - If no desired value is set, Amazon GameLift places the calculated maximum. +// // - If a desired number is set to a value higher than the calculated maximum, // Amazon GameLift places the calculated maximum. +// // - If a desired number is set to a value lower than the calculated maximum, // Amazon GameLift places the desired number. // -// Part of: ContainerGroupsConfiguration , ContainerGroupsAttributes Returned by: -// DescribeFleetAttributes , CreateFleet +// Part of: ContainerGroupsConfiguration, ContainerGroupsAttributes +// +// Returned by: DescribeFleetAttributes, CreateFleet type ContainerGroupsPerInstance struct { // The desired number of replica container groups to place on each fleet instance. @@ -749,15 +898,20 @@ type ContainerGroupsPerInstance struct { // Instructions on when and how to check the health of a container in a container // fleet. When health check properties are set in a container definition, they // override any Docker health checks in the container image. For more information -// on container health checks, see HealthCheck command (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command) -// in the Amazon Elastic Container Service API. The following example instructions -// tell the container to wait 100 seconds after launch before counting failed -// health checks, then initiate the health check command every 60 seconds. After -// issuing the health check command, wait 10 seconds for it to succeed. If it -// fails, retry the command 3 times before considering the container to be -// unhealthy. {"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit -// 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 } Part -// of: ContainerDefinition$HealthCheck +// on container health checks, see [HealthCheck command]in the Amazon Elastic Container Service API. +// +// The following example instructions tell the container to wait 100 seconds after +// launch before counting failed health checks, then initiate the health check +// command every 60 seconds. After issuing the health check command, wait 10 +// seconds for it to succeed. If it fails, retry the command 3 times before +// considering the container to be unhealthy. +// +// {"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], +// "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 } +// +// Part of: ContainerDefinition$HealthCheck +// +// [HealthCheck command]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html#ECS-Type-HealthCheck-command type ContainerHealthCheck struct { // A string array that specifies the command that the container runs to determine @@ -785,28 +939,35 @@ type ContainerHealthCheck struct { } // Specifies how much memory is available to a container. You can't change this -// value after you create this object. Part of: ContainerDefinition$MemoryLimits +// value after you create this object. +// +// Part of: ContainerDefinition$MemoryLimits type ContainerMemoryLimits struct { // The maximum amount of memory that the container can use. If a container // attempts to exceed this limit, the container is stopped. This property is - // similar to the Amazon ECS container definition parameter memory (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_memory) - // in the Amazon Elastic Container Service Developer Guide. + // similar to the Amazon ECS container definition parameter [memory]in the Amazon Elastic + // Container Service Developer Guide. + // + // [memory]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_memory HardLimit *int32 // The amount of memory that is reserved for a container. When the container // group's shared memory is under contention, the system attempts to maintain the // container memory usage at this soft limit. However, the container can use more // memory when needed, if available. This property is similar to the Amazon ECS - // container definition parameter memoryreservation (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-memoryReservation) - // (Amazon Elastic Container Service Developer Guide). + // container definition parameter [memoryreservation](Amazon Elastic Container Service Developer + // Guide). + // + // [memoryreservation]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-memoryReservation SoftLimit *int32 noSmithyDocumentSerde } -// Defines ranges of ports that server processes can connect to. Part of: -// ContainerDefinition$PortConfiguration +// Defines ranges of ports that server processes can connect to. +// +// Part of: ContainerDefinition$PortConfiguration type ContainerPortConfiguration struct { // Specifies one or more ranges of ports on a container. These ranges must not @@ -818,13 +979,18 @@ type ContainerPortConfiguration struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. Defines how an internal-facing container port is -// mapped to an external-facing connection port on a fleet instance of compute type -// CONTAINER . Incoming traffic, such as a game client, uses a connection port to -// connect to a process in the container fleet. Amazon GameLift directs the inbound -// traffic to the container port that is assigned to the process, such as a game -// session, running on a container. Part of: ContainerAttributes +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// Defines how an internal-facing container port is mapped to an external-facing +// connection port on a fleet instance of compute type CONTAINER . Incoming +// traffic, such as a game client, uses a connection port to connect to a process +// in the container fleet. Amazon GameLift directs the inbound traffic to the +// container port that is assigned to the process, such as a game session, running +// on a container. +// +// Part of: ContainerAttributes type ContainerPortMapping struct { // The port opened on the fleet instance. This is also called the "host port". @@ -839,9 +1005,13 @@ type ContainerPortMapping struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. A set of one or more port numbers that can be -// opened on the container. Part of: ContainerPortConfiguration +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// A set of one or more port numbers that can be opened on the container. +// +// Part of: ContainerPortConfiguration type ContainerPortRange struct { // A starting value for the range of allowed port numbers. @@ -920,9 +1090,9 @@ type EC2InstanceLimit struct { // being used by the Amazon Web Services account. CurrentInstances *int32 - // The name of an Amazon EC2 instance type. See Amazon Elastic Compute Cloud - // Instance Types (http://aws.amazon.com/ec2/instance-types/) for detailed - // descriptions. + // The name of an Amazon EC2 instance type. See [Amazon Elastic Compute Cloud Instance Types] for detailed descriptions. + // + // [Amazon Elastic Compute Cloud Instance Types]: http://aws.amazon.com/ec2/instance-types/ EC2InstanceType EC2InstanceType // The number of instances that is allowed for the specified instance type and @@ -943,40 +1113,54 @@ type Event struct { // The number of times that this event occurred. Count *int64 - // The type of event being logged. Fleet state transition events: + // 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 . Amazon GameLift has successfully downloaded the build and is now // validating the build files. + // // - FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING . // Amazon GameLift has successfully verified the build files and is now running the // installation scripts. + // // - FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING . // Amazon GameLift is trying to launch an instance and test the connectivity // between the build and the Amazon 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 @@ -985,80 +1169,109 @@ type Event struct { // 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) - // . + // [Debug Fleet Creation Issues]. + // // - 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 Amazon 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) + // Services account. For more information on VPC peering failures, see [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_RECYCLED -- A spot instance was determined to have a high risk of // interruption and is scheduled to be recycled once it has no active game // sessions. + // // 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 (5 minutes). 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 (5 minutes) 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 // within the time expected after OnProcessTerminate() was sent. 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 (30 seconds) 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. + // // 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. + // + // [Debug Fleet Creation Issues]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation + // [https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html]: https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html EventCode EventCode // A unique identifier for a fleet event. @@ -1088,21 +1301,26 @@ type Event struct { // configuration allow placement with some, but not all of these locations. type FilterConfiguration struct { - // A list of locations to allow game session placement in, in the form of Amazon + // A list of locations to allow game session placement in, in the form of Amazon // Web Services Region codes such as us-west-2 . AllowedLocations []string noSmithyDocumentSerde } -// This operation has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. Describes an Amazon GameLift -// fleet of game hosting resources. Attributes differ based on the fleet's compute -// type, as follows: +// This operation has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// Describes an Amazon GameLift fleet of game hosting resources. Attributes differ +// based on the fleet's compute type, as follows: +// // - EC2 fleet attributes identify a Build resource (for fleets with customer // game server builds) or a Script resource (for Realtime Servers fleets). +// // - Container fleets have ContainerGroupsAttributes , which identify the fleet's // ContainerGroupDefinition resources. +// // - Amazon GameLift Anywhere fleets have an abbreviated set of attributes, // because most fleet configurations are set directly on the fleet's computes. // Attributes include fleet identifiers and descriptive properties, @@ -1111,17 +1329,19 @@ type FilterConfiguration struct { // Returned by: DescribeFleetAttributes type FleetAttributes struct { - // This property is used with the Amazon GameLift containers feature, which is + // This property is used with the Amazon GameLift containers feature, which is // currently in public preview. A set of attributes that describe the container // groups that are deployed on the fleet. These attributes are included for fleets // with compute type CONTAINER only. This attribute is used with fleets where // ComputeType is "Container". AnywhereConfiguration *AnywhereConfiguration - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) associated with the Amazon GameLift build resource that is deployed on - // instances in this fleet. In a GameLift build ARN, the resource ID matches the - // BuildId value. This attribute is used with fleets where ComputeType is "EC2". + // The Amazon Resource Name ([ARN] ) associated with the Amazon GameLift build resource + // that is deployed on instances in this fleet. In a GameLift build ARN, the + // resource ID matches the BuildId value. This attribute is used with fleets where + // ComputeType is "EC2". + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html BuildArn *string // A unique identifier for the build resource that is deployed on instances in @@ -1149,19 +1369,22 @@ type FleetAttributes struct { // 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 Amazon 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] ) that is assigned to a Amazon 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. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet. FleetId *string // Indicates whether the fleet uses On-Demand or Spot instances. For more - // information, see On-Demand versus Spot Instances (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot) - // . This fleet property can't be changed after the fleet is created. + // information, see [On-Demand versus Spot Instances]. This fleet property can't be changed after the fleet is + // created. + // + // [On-Demand versus Spot Instances]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot FleetType FleetType // A unique identifier for an IAM role with access permissions to other Amazon Web @@ -1169,9 +1392,10 @@ type FleetAttributes struct { // fleet--including install scripts, server processes, and other processes--can use // these permissions to interact with Amazon Web Services resources that you own or // have access to. For more information about using the role with your game server - // builds, see Communicate with other Amazon Web Services resources from your - // fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) - // . This attribute is used with fleets where ComputeType is "EC2" or "Container". + // builds, see [Communicate with other Amazon Web Services resources from your fleets]. This attribute is used with fleets where ComputeType is "EC2" or + // "Container". + // + // [Communicate with other Amazon Web Services resources from your fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html InstanceRoleArn *string // Indicates that fleet instances maintain a shared credentials file for the IAM @@ -1179,22 +1403,25 @@ type FleetAttributes struct { // deployed with the game server executable to communicate with other Amazon Web // Services resources. This property is used only when the game server is // integrated with the server SDK version 5.x. For more information about using - // shared credentials, see Communicate with other Amazon Web Services resources - // from your fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html) - // . This attribute is used with fleets where ComputeType is "EC2" or "Container". + // shared credentials, see [Communicate with other Amazon Web Services resources from your fleets]. This attribute is used with fleets where ComputeType + // is "EC2" or "Container". + // + // [Communicate with other Amazon Web Services resources from your fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html InstanceRoleCredentialsProvider InstanceRoleCredentialsProvider // The Amazon EC2 instance type that the fleet uses. Instance type determines the // computing resources of each instance in the fleet, including CPU, memory, - // storage, and networking capacity. See Amazon Elastic Compute Cloud Instance - // Types (http://aws.amazon.com/ec2/instance-types/) for detailed descriptions. - // This attribute is used with fleets where ComputeType is "EC2" or "Container". + // storage, and networking capacity. See [Amazon Elastic Compute Cloud Instance Types]for detailed descriptions. This attribute + // is used with fleets where ComputeType is "EC2" or "Container". + // + // [Amazon Elastic Compute Cloud Instance Types]: http://aws.amazon.com/ec2/instance-types/ InstanceType EC2InstanceType - // This parameter is no longer used. Game session log paths are now defined using + // This parameter is no longer used. Game session log paths are now defined using // the Amazon 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) - // . + // information in the [Server API Reference]. + // + // [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 @@ -1210,8 +1437,10 @@ type FleetAttributes struct { // The type of game session protection to set on all new instances that are // started in the fleet. This attribute is used with fleets where ComputeType is // "EC2" or "Container". + // // - 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 @@ -1224,16 +1453,19 @@ type FleetAttributes struct { // A policy that puts limits on the number of game sessions that a player can // 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, Amazon GameLift checks that the player (identified by CreatorId ) has - // created fewer than game session limit in the specified time period. + // 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, Amazon 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] ) 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. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ScriptArn *string // A unique identifier for the Realtime script resource that is deployed on @@ -1241,31 +1473,40 @@ type FleetAttributes struct { // is "EC2". ScriptId *string - // This parameter is no longer used. Server launch parameters are now defined + // This parameter is no longer used. Server launch parameters are now defined // using the fleet's runtime configuration . Requests that use this parameter // 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) - // . Requests that use this parameter continue to be valid. + // This parameter is no longer used. Server launch paths are now defined using + // the fleet's [RuntimeConfiguration]. Requests that use this parameter continue to be valid. + // + // [RuntimeConfiguration]: https://docs.aws.amazon.com/gamelift/latest/apireference/RuntimeConfiguration.html 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 -- Amazon 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) - // . This includes fleet auto-scaling. This attribute is used with fleets where - // ComputeType is "EC2" or "Container". + // A list of fleet activity that has been suspended using [StopFleetActions]. This includes fleet + // auto-scaling. This attribute is used with fleets where ComputeType is "EC2" or + // "Container". + // + // [StopFleetActions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html StoppedActions []FleetAction // A time stamp indicating when this data object was terminated. Format is a @@ -1277,15 +1518,20 @@ type FleetAttributes struct { // Current resource capacity settings for managed EC2 fleets and container fleets. // For multi-location fleets, location values might refer to a fleet's remote -// location or its home Region. Returned by: 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) +// location or its home Region. +// +// Returned by: [DescribeFleetCapacity], [DescribeFleetLocationCapacity], [UpdateFleetCapacity] +// +// [UpdateFleetCapacity]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html +// [DescribeFleetLocationCapacity]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html +// [DescribeFleetCapacity]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet associated with the location. @@ -1298,15 +1544,16 @@ type FleetCapacity struct { // The Amazon EC2 instance type that is used for instances in a fleet. Instance // type determines the computing resources in use, including CPU, memory, storage, - // and networking capacity. See Amazon Elastic Compute Cloud Instance Types (http://aws.amazon.com/ec2/instance-types/) - // for detailed descriptions. + // and networking capacity. See [Amazon Elastic Compute Cloud Instance Types]for detailed descriptions. + // + // [Amazon Elastic Compute Cloud Instance Types]: http://aws.amazon.com/ec2/instance-types/ InstanceType EC2InstanceType // The fleet location for the instance count information, expressed as an Amazon // Web Services Region code, such as us-west-2 . Location *string - // This property is used with the Amazon GameLift containers feature, which is + // This property is used with the Amazon GameLift containers feature, which is // currently in public preview. The number and status of replica container groups // in a container fleet. ReplicaContainerGroupCounts *ReplicaContainerGroupCounts @@ -1330,10 +1577,11 @@ 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet associated with the location. @@ -1353,12 +1601,16 @@ type FleetUtilization struct { // This key-value pair can store custom data about a game session. For example, // you might use a GameProperty to track a game session's map, level of // difficulty, or remaining time. The difficulty level could be specified like -// this: {"Key": "difficulty", "Value":"Novice"} . You can set game properties when -// creating a game session. You can also modify game properties of an active game -// session. When searching for game sessions, you can filter on game property keys -// and values. You can't delete game properties from a game session. For examples -// of working with game properties, see Create a game session with properties (https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties) -// . +// this: {"Key": "difficulty", "Value":"Novice"} . +// +// You can set game properties when creating a game session. You can also modify +// game properties of an active game session. When searching for game sessions, you +// can filter on game property keys and values. You can't delete game properties +// from a game session. +// +// For examples of working with game properties, see [Create a game session with properties]. +// +// [Create a game session with properties]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties type GameProperty struct { // The game property identifier. @@ -1374,11 +1626,16 @@ type GameProperty struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift FleetIQ and game server groups. +// This data type is used with the Amazon 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 . +// 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 . type GameServer struct { // Indicates when an available game server has been reserved for gameplay but has @@ -1432,21 +1689,28 @@ type GameServer struct { // 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. UtilizationStatus GameServerUtilizationStatus noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server +// +// groups. +// // 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 -// group activity can be temporarily suspended and resumed by calling -// SuspendGameServerGroup and ResumeGameServerGroup , respectively. +// group. +// +// A game server group is created by a successful call to CreateGameServerGroup +// and deleted by calling DeleteGameServerGroup . Game server group activity can be +// temporarily suspended and resumed by calling SuspendGameServerGroup and +// ResumeGameServerGroup , respectively. type GameServerGroup struct { // A generated unique ID for the Amazon EC2 Auto Scaling group that is associated @@ -1456,16 +1720,19 @@ type GameServerGroup struct { // Indicates how Amazon 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. @@ -1499,25 +1766,33 @@ 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] ) for an IAM role that allows Amazon GameLift to + // access your Amazon EC2 Auto Scaling groups. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html RoleArn *string // The current status of the game server group. Possible statuses include: + // // - NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() // request. + // // - ACTIVATING - Amazon 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 - Amazon GameLift FleetIQ has received a valid // DeleteGameServerGroup() request and is processing it. Amazon 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 @@ -1533,7 +1808,10 @@ type GameServerGroup struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server +// +// groups. +// // Configuration settings for intelligent automatic scaling that uses target // tracking. These settings are used to add an Auto Scaling policy when creating // the corresponding Auto Scaling group. After the Auto Scaling group is created, @@ -1559,12 +1837,17 @@ type GameServerGroupAutoScalingPolicy struct { noSmithyDocumentSerde } -// This data type is used with the Amazon 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 . +// This data type is used with the Amazon 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 . type GameServerInstance struct { // A generated unique identifier for the game server group that includes the game @@ -1587,11 +1870,18 @@ type GameServerInstance struct { noSmithyDocumentSerde } -// 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 . Amazon -// GameLift retains a game session resource for 30 days after the game session -// ends. 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) +// 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 . +// +// Amazon GameLift retains a game session resource for 30 days after the game +// session ends. You can reuse idempotency token values after this time. Game +// session logs are retained for 14 days. +// +// [All APIs by task] +// +// [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 @@ -1608,16 +1898,21 @@ 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) - // .) + // + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See [Amazon EC2 Instance IP Addressing].) + // // When connecting to a game session that is running on a TLS-enabled fleet, you // must use the DNS name, not the IP address. + // + // [Amazon EC2 Instance IP Addressing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses 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] ) associated with the GameLift fleet that this game + // session is running on. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that the game session is running on. @@ -1629,8 +1924,9 @@ type GameSession struct { // 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]). + // + // [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 @@ -1649,10 +1945,11 @@ type GameSession struct { // Information about the matchmaking process that resulted in the game session, if // matchmaking was used. Data is in JSON syntax, formatted as a string. Information // includes the matchmaker ID as well as 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 updated whenever new players are added during a successful - // backfill (see StartMatchBackfill (https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html) - // ). + // For more details on matchmaker data, see [Match Data]. Matchmaker data is updated whenever + // new players are added during a successful backfill (see [StartMatchBackfill]). + // + // [Match Data]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data + // [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 @@ -1695,12 +1992,15 @@ 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) - // .) + // + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See [Amazon EC2 Instance IP Addressing].) + // // When connecting to a game session that is running on a TLS-enabled fleet, you // must use the DNS name, not the IP address. + // + // [Amazon EC2 Instance IP Addressing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses DnsName *string // A unique identifier for the game session. Use the game session ID. @@ -1728,8 +2028,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. ProtectionPolicy ProtectionPolicy @@ -1738,23 +2040,27 @@ type GameSessionDetail struct { } // Represents a potential game session placement, including the full details of -// the original placement request and the current status. If the game session -// placement status is PENDING , the properties for game session ID/ARN, region, IP -// address/DNS, and port aren't final. A game session is not active and ready to -// accept players until placement status reaches FULFILLED . When the placement is -// in PENDING status, Amazon GameLift may attempt to place a game session multiple -// times before succeeding. With each attempt it creates a GameSession object and -// updates this placement object with the new game session properties.. +// the original placement request and the current status. +// +// If the game session placement status is PENDING , the properties for game +// session ID/ARN, region, IP address/DNS, and port aren't final. A game session is +// not active and ready to accept players until placement status reaches FULFILLED +// . When the placement is in PENDING status, Amazon GameLift may attempt to place +// a game session multiple times before succeeding. With each attempt it creates a GameSession +// object and updates this placement object with the new game session properties.. 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) - // .) + // + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See [Amazon EC2 Instance IP Addressing].) + // // When connecting to a game session that is running on a TLS-enabled fleet, you // must use the DNS name, not the IP address. + // + // [Amazon EC2 Instance IP Addressing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses DnsName *string // Time stamp indicating when this request was completed, canceled, or timed out. @@ -1771,8 +2077,9 @@ type GameSessionPlacement struct { // 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]). + // + // [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 isn't final until @@ -1800,8 +2107,9 @@ type GameSessionPlacement struct { // 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]. + // + // [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 @@ -1832,13 +2140,18 @@ type GameSessionPlacement struct { StartTime *time.Time // Current status of the game session placement request. + // // - PENDING -- The placement request is in the queue waiting to be processed. // Game session properties are not yet final. + // // - FULFILLED -- A new game session has been successfully placed. Game session // properties are now final. + // // - 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 -- Amazon 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. @@ -1852,7 +2165,7 @@ type GameSessionPlacement struct { // matchmaking solution. type GameSessionQueue struct { - // Information that is added to all events that are related to this game session + // Information that is added to all events that are related to this game session // queue. CustomEventData *string @@ -1867,11 +2180,12 @@ type GameSessionQueue struct { // 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 Amazon GameLift game session queue resource and uniquely - // identifies it. ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::gamesessionqueue/ . In a Amazon GameLift game session queue - // ARN, the resource ID matches the Name value. + // The Amazon Resource Name ([ARN] ) that is assigned to a Amazon GameLift game session + // queue resource and uniquely identifies it. ARNs are unique across all Regions. + // Format is arn:aws:gamelift:::gamesessionqueue/ . In a Amazon GameLift game + // session queue ARN, the resource ID matches the Name value. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html GameSessionQueueArn *string // A descriptive label that is associated with game session queue. Queue names @@ -1879,8 +2193,9 @@ type GameSessionQueue struct { 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) - // . + // notifications. See [Setting up notifications for game session placement]. + // + // [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 @@ -1929,18 +2244,22 @@ type Instance 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 Elastic - // Compute Cloud Instance IP Addressing (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) - // .) + // + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See [Amazon Elastic Compute Cloud Instance IP Addressing].) + // // When connecting to a game session that is running on a TLS-enabled fleet, you // must use the DNS name, not the IP address. + // + // [Amazon Elastic Compute Cloud Instance IP Addressing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses DnsName *string - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to a Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that the instance belongs to. @@ -1960,12 +2279,15 @@ type Instance struct { 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 Amazon 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. @@ -1978,8 +2300,7 @@ type Instance struct { } // Information and credentials that you can use to remotely connect to an instance -// in an EC2 managed fleet. This data type is returned in response to a call to -// GetInstanceAccess . +// in an EC2 managed fleet. This data type is returned in response to a call to GetInstanceAccess. type InstanceAccess struct { // Security credentials that are required to access the instance. @@ -2001,9 +2322,9 @@ type InstanceAccess struct { } // A set of credentials that allow remote access to an instance in an EC2 managed -// fleet. These credentials are returned in response to a call to GetInstanceAccess -// , which requests access for instances that are running game servers with the -// Amazon GameLift server SDK version 4.x or earlier. +// fleet. These credentials are returned in response to a call to GetInstanceAccess, which requests +// access for instances that are running game servers with the Amazon GameLift +// server SDK version 4.x or earlier. type InstanceCredentials struct { // Secret string. For Windows instances, the secret is a password for use with @@ -2017,7 +2338,10 @@ type InstanceCredentials struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server +// +// groups. +// // An allowed instance type for a game server group. All game server groups must // have at least two instance types defined for it. Amazon GameLift FleetIQ // periodically evaluates each defined instance type for viability. It then updates @@ -2033,9 +2357,10 @@ type InstanceDefinition struct { // the total capacity of a game server group. Instance weights are used by Amazon // 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) - // in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is - // "1". + // instance capacity, see [Instance Weighting]in the Amazon Elastic Compute Cloud Auto Scaling User + // Guide. Default value is "1". + // + // [Instance Weighting]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html WeightedCapacity *string noSmithyDocumentSerde @@ -2045,13 +2370,17 @@ type InstanceDefinition struct { // to processes on an instance in a fleet. Processes are assigned an IP // address/port number combination, which must fall into the fleet's allowed // ranges. For container fleets, the port settings must use the same port numbers -// as the fleet's connection ports. For Realtime Servers fleets, Amazon GameLift -// automatically opens two port ranges, one for TCP messaging and one for UDP. +// as the fleet's connection ports. +// +// For Realtime Servers fleets, Amazon GameLift automatically opens two port +// ranges, one for TCP messaging and one for UDP. type IpPermission struct { - // A starting value for a range of allowed port numbers. For fleets using Linux - // builds, only ports 22 and 1026-60000 are valid. For fleets using Windows - // builds, only ports 1026-60000 are valid. + // A starting value for a range of allowed port numbers. + // + // For fleets using Linux builds, only ports 22 and 1026-60000 are valid. + // + // For fleets using Windows builds, only ports 1026-60000 are valid. // // This member is required. FromPort *int32 @@ -2069,9 +2398,11 @@ type IpPermission struct { Protocol IpProtocol // An ending value for a range of allowed port numbers. Port numbers are - // end-inclusive. This value must be equal to or greater than FromPort . For fleets - // using Linux builds, only ports 22 and 1026-60000 are valid. For fleets using - // Windows builds, only ports 1026-60000 are valid. + // end-inclusive. This value must be equal to or greater than FromPort . + // + // For fleets using Linux builds, only ports 22 and 1026-60000 are valid. + // + // For fleets using Windows builds, only ports 1026-60000 are valid. // // This member is required. ToPort *int32 @@ -2079,7 +2410,10 @@ type IpPermission struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift FleetIQ and game server groups. +// This data type is used with the Amazon GameLift FleetIQ and game server +// +// groups. +// // An Amazon Elastic Compute Cloud launch template that contains configuration // settings and game server code to be deployed to all instances in a game server // group. The launch template is specified when creating a new game server group. @@ -2117,9 +2451,12 @@ type LocationAttributes struct { noSmithyDocumentSerde } -// This data type has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. A remote location where a -// multi-location fleet can deploy game servers for game hosting. +// This data type has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// A remote location where a multi-location fleet can deploy game servers for game +// hosting. type LocationConfiguration struct { // An Amazon Web Services Region code, such as us-west-2 . @@ -2131,15 +2468,16 @@ type LocationConfiguration struct { } // Properties of a custom location for use in an Amazon GameLift Anywhere fleet. -// This data type is returned in response to a call to -// https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html (https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html) -// . +// This data type is returned in response to a call to [https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html]. +// +// [https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateLocation.html 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html LocationArn *string // The location's name. @@ -2153,16 +2491,23 @@ type LocationModel struct { // 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 -- Amazon 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 { @@ -2179,9 +2524,10 @@ type LocationState struct { // Represents a new player session that is created as a result of a successful // FlexMatch match. A successful match automatically creates new player sessions -// for every player ID in the original matchmaking request. When players connect to -// the match's game session, they must include both player ID and player session ID -// in order to claim their assigned player slot. +// for every player ID in the original matchmaking request. +// +// When players connect to the match's game session, they must include both player +// ID and player session ID in order to claim their assigned player slot. type MatchedPlayerSession struct { // A unique identifier for a player @@ -2220,15 +2566,18 @@ type MatchmakingConfiguration struct { // 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]. Automatic backfill is not available + // when FlexMatchMode is set to STANDALONE . + // + // [Backfill existing games with FlexMatch]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html BackfillMode BackfillMode - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to a Amazon GameLift matchmaking configuration resource and - // uniquely identifies it. ARNs are unique across all Regions. Format is - // arn:aws:gamelift:::matchmakingconfiguration/ . In a Amazon GameLift - // configuration ARN, the resource ID matches the Name value. + // The Amazon Resource Name ([ARN] ) that is assigned to a Amazon GameLift matchmaking + // configuration resource and uniquely identifies it. ARNs are unique across all + // Regions. Format is arn:aws:gamelift:::matchmakingconfiguration/ . In a Amazon + // GameLift configuration ARN, the resource ID matches the Name value. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ConfigurationArn *string // A time stamp indicating when this data object was created. Format is a number @@ -2243,11 +2592,14 @@ type MatchmakingConfiguration struct { // Indicates whether this matchmaking configuration is being used with Amazon // 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. + // including players and team assignments, in a [MatchmakingSucceeded]event. + // // - WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift // queue to start a game session for the match. + // + // [MatchmakingSucceeded]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded FlexMatchMode FlexMatchMode // A set of key-value pairs that can store custom data in a game session. For @@ -2258,19 +2610,21 @@ type MatchmakingConfiguration struct { // 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]). 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 . + // + // [Start a Game Session]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession GameSessionData *string - // The Amazon Resource Name ( ARN (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) - // ) that is assigned to a Amazon 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 Amazon GameLift-hosted game sessions for matches - // that are created with this matchmaking configuration. This property is not set - // when FlexMatchMode is set to STANDALONE . + // The Amazon Resource Name ([ARN] ) that is assigned to a Amazon 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 Amazon GameLift-hosted game sessions for + // matches that are created with this matchmaking configuration. This property is + // not set when FlexMatchMode is set to STANDALONE . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html GameSessionQueueArns []string // A unique identifier for the matchmaking configuration. This name is used to @@ -2285,9 +2639,10 @@ 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] ) associated with the GameLift matchmaking rule set + // resource that this configuration uses. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html RuleSetArn *string // A unique identifier for the matchmaking rule set to use with this @@ -2300,17 +2655,20 @@ type MatchmakingConfiguration struct { // Set of rule statements, used with FlexMatch, that determine how to build your // 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) -// . +// 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]. +// // - 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 @@ -2318,12 +2676,15 @@ type MatchmakingConfiguration struct { // 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. +// +// [Build a FlexMatch rule set]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html type MatchmakingRuleSet struct { // A collection of matchmaking rules, formatted as a JSON string. Comments are not @@ -2336,11 +2697,12 @@ type MatchmakingRuleSet struct { // 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 Amazon 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] ) that is assigned to a Amazon 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. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html RuleSetArn *string // A unique identifier for the matchmaking rule set @@ -2354,9 +2716,10 @@ 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] ) associated with the GameLift matchmaking + // configuration resource that is used with this ticket. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ConfigurationArn *string // Name of the matchmaking configuration that is used with this ticket. @@ -2375,8 +2738,9 @@ 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]. + // + // [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. @@ -2390,23 +2754,32 @@ type MatchmakingTicket struct { 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. Status MatchmakingConfigurationStatus @@ -2426,9 +2799,10 @@ 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) -// with the player session ID. +// player session ID. To retrieve full details on a player session, call [DescribePlayerSessions]with the +// player session ID. +// +// [DescribePlayerSessions]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribePlayerSessions.html type PlacedPlayerSession struct { // A unique identifier for a player that is associated with this player session. @@ -2448,16 +2822,20 @@ 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. + // 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 @@ -2517,7 +2895,13 @@ type PlayerLatencyPolicy struct { // 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) +// for 30 days and then removed. +// +// # Related actions +// +// [All APIs by task] +// +// [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 @@ -2526,17 +2910,21 @@ type PlayerSession 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) - // .) + // + // - Non-TLS-enabled fleets: ec2-.compute.amazonaws.com . (See [Amazon EC2 Instance IP Addressing].) + // // When connecting to a game session that is running on a TLS-enabled fleet, you // must use the DNS name, not the IP address. + // + // [Amazon EC2 Instance IP Addressing]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses 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] ) associated with the GameLift fleet that the + // player's game session is running on. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that the player's game session is running on. @@ -2564,13 +2952,18 @@ type PlayerSession struct { // process, an app needs both the IP address and port number. Port *int32 - // Current status of the player session. Possible player session statuses include - // the following: + // 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). Status PlayerSessionStatus @@ -2585,12 +2978,14 @@ 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 @@ -2608,13 +3003,17 @@ type PriorityConfiguration struct { // 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 . PriorityOrder []PriorityType @@ -2622,25 +3021,30 @@ type PriorityConfiguration struct { noSmithyDocumentSerde } -// This data type is used with the Amazon GameLift containers feature, which is -// currently in public preview. The number and status of replica container groups -// that are deployed across a fleet with compute type CONTAINER . This information, -// combined with the number of server processes being hosted per container group -// (see RuntimeConfiguration ), tells you how many game sessions the fleet is -// currently capable of hosting concurrently. Returned by: DescribeFleetCapacity , -// DescribeFleetLocationCapacity +// This data type is used with the Amazon GameLift containers feature, which is +// +// currently in public preview. +// +// The number and status of replica container groups that are deployed across a +// fleet with compute type CONTAINER . This information, combined with the number +// of server processes being hosted per container group (see RuntimeConfiguration +// ), tells you how many game sessions the fleet is currently capable of hosting +// concurrently. +// +// Returned by: DescribeFleetCapacity, DescribeFleetLocationCapacity type ReplicaContainerGroupCounts struct { - // The number of container groups that have active game sessions. + // The number of container groups that have active game sessions. ACTIVE *int32 - // The number of container groups that have no active game sessions. + // The number of container groups that have no active game sessions. IDLE *int32 - // The number of container groups that are starting up but have not yet registered. + // The number of container groups that are starting up but have not yet + // registered. PENDING *int32 - // The number of container groups that are in the process of shutting down. + // The number of container groups that are in the process of shutting down. TERMINATING *int32 noSmithyDocumentSerde @@ -2648,18 +3052,22 @@ type ReplicaContainerGroupCounts struct { // A policy that puts limits on the number of game sessions that a player can // 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, Amazon GameLift checks that the player (identified by CreatorId ) has -// created fewer than game session limit in the specified time period. +// 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, Amazon GameLift checks that the player +// (identified by CreatorId ) has created fewer than game session limit in the +// specified time period. type ResourceCreationLimitPolicy struct { // A policy that puts limits on the number of game sessions that a player can // 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, Amazon GameLift checks that the player (identified by CreatorId ) has - // created fewer than game session limit in the specified time period. + // 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, Amazon GameLift checks that the player + // (identified by CreatorId ) has created fewer than game session limit in the + // specified time period. NewGameSessionsPerCreator *int32 // The time span used in evaluating the resource creation limit policy. @@ -2668,7 +3076,13 @@ 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] +// +// [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 @@ -2678,10 +3092,13 @@ type RoutingStrategy struct { // The message text to be used with a terminal routing strategy. Message *string - // The type of routing strategy for the alias. Possible routing types include the - // following: + // 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. @@ -2690,19 +3107,25 @@ type RoutingStrategy struct { noSmithyDocumentSerde } -// This data type has been expanded to use with the Amazon GameLift containers -// feature, which is currently in public preview. A set of instructions that define -// the set of server processes to run on computes in a fleet. Server processes run -// either an executable in a custom game build or a Realtime Servers script. Amazon -// GameLift launches the processes, manages their life cycle, and replaces them as -// needed. Computes check regularly for an updated runtime configuration. On a -// container fleet, the Amazon GameLift Agent uses the runtime configuration to -// manage the lifecycle of server processes in a replica container group. An Amazon -// GameLift instance is limited to 50 processes running concurrently. To calculate -// the total number of processes defined 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) -// . +// This data type has been expanded to use with the Amazon GameLift containers +// +// feature, which is currently in public preview. +// +// A set of instructions that define the set of server processes to run on +// computes in a fleet. Server processes run either an executable in a custom game +// build or a Realtime Servers script. Amazon GameLift launches the processes, +// manages their life cycle, and replaces them as needed. Computes check regularly +// for an updated runtime configuration. +// +// On a container fleet, the Amazon GameLift Agent uses the runtime configuration +// to manage the lifecycle of server processes in a replica container group. +// +// An Amazon GameLift instance is limited to 50 processes running concurrently. To +// calculate the total number of processes defined in a runtime configuration, add +// the values of the ConcurrentExecutions parameter for each server process. Learn +// more about [Running Multiple Processes on a Fleet]. +// +// [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 @@ -2727,9 +3150,10 @@ type RuntimeConfiguration struct { // Amazon GameLift. type S3Location struct { - // An Amazon S3 bucket identifier. Thename of the S3 bucket. Amazon GameLift - // doesn't support uploading from Amazon S3 buckets with names that contain a dot - // (.). + // An Amazon S3 bucket identifier. Thename of the S3 bucket. + // + // Amazon GameLift doesn't support uploading from Amazon S3 buckets with names + // that contain a dot (.). Bucket *string // The name of the zip file that contains the build files or script files. @@ -2741,8 +3165,10 @@ 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] ) for an IAM role that allows Amazon GameLift to + // access the S3 bucket. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html RoleArn *string noSmithyDocumentSerde @@ -2759,44 +3185,56 @@ type ScalingPolicy struct { // 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 Amazon 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] ) that is assigned to a Amazon 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 . + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet that is associated with this scaling policy. FleetId *string - // The fleet location. + // The fleet location. Location *string // 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) - // . + // adjustment. For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift with Amazon CloudWatch]. + // // - 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. + // + // [Monitor Amazon GameLift with Amazon CloudWatch]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html MetricName MetricName // A descriptive label that is associated with a fleet's scaling policy. Policy @@ -2814,10 +3252,13 @@ 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. @@ -2827,14 +3268,21 @@ type ScalingPolicy struct { // 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. Status ScalingStatusType @@ -2853,7 +3301,13 @@ 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] +// +// [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 @@ -2864,10 +3318,11 @@ type Script struct { // 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 Amazon 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] ) that is assigned to a Amazon 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. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html ScriptArn *string // A unique identifier for the Realtime script @@ -2908,10 +3363,13 @@ type ServerProcess struct { // The location of a game build executable or Realtime script. 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 " + // // Amazon GameLift doesn't support the use of setup scripts that launch the game // executable. For custom game builds, this parameter must indicate the executable // that calls the server SDK operations initSDK() and ProcessReady() . @@ -2926,11 +3384,21 @@ type ServerProcess struct { noSmithyDocumentSerde } -// A label that you can assign to a Amazon 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) +// A label that you can assign to a Amazon GameLift resource. +// +// # Learn more +// +// [Tagging Amazon Web Services Resources]in the Amazon Web Services General Reference +// +// [Amazon Web Services Tagging Strategies] +// +// # Related actions +// +// [All APIs by task] +// +// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Amazon Web Services Tagging Strategies]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/ +// [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 @@ -2967,13 +3435,17 @@ type TargetConfiguration struct { noSmithyDocumentSerde } -// This data type is used with the Amazon 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) -// . These settings are used to create a target-based policy that tracks the Amazon -// 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. +// This data type is used with the Amazon GameLift FleetIQ and game server +// +// groups. +// +// Settings for a target-based scaling policy as part of a [GameServerGroupAutoScalingPolicy] . These settings are +// used to create a target-based policy that tracks the Amazon 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. +// +// [GameServerGroupAutoScalingPolicy]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerGroupAutoScalingPolicy.html type TargetTrackingConfiguration struct { // Desired value to use with a game server group target-based scaling policy. @@ -2988,7 +3460,12 @@ 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] +// +// [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 @@ -3010,10 +3487,11 @@ type VpcPeeringAuthorization struct { // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift 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 Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) - // . + // VPC ID, use the [VPC Dashboard]in the Amazon Web Services Management Console. Learn more about + // VPC peering in [VPC Peering with Amazon GameLift Fleets]. + // + // [VPC Dashboard]: https://console.aws.amazon.com/vpc/ + // [VPC Peering with Amazon GameLift Fleets]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html PeerVpcId *string noSmithyDocumentSerde @@ -3022,11 +3500,19 @@ type VpcPeeringAuthorization struct { // 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) +// been established. +// +// # Related actions +// +// [All APIs by task] +// +// [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] ) associated with the GameLift fleet resource for + // this connection. + // + // [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html FleetArn *string // A unique identifier for the fleet. This ID determines the ID of the Amazon @@ -3045,10 +3531,11 @@ type VpcPeeringConnection struct { // A unique identifier for a VPC with resources to be accessed by your Amazon // GameLift 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 Amazon GameLift Fleets (https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html) - // . + // VPC ID, use the [VPC Dashboard]in the Amazon Web Services Management Console. Learn more about + // VPC peering in [VPC Peering with Amazon GameLift Fleets]. + // + // [VPC Dashboard]: https://console.aws.amazon.com/vpc/ + // [VPC Peering with Amazon 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 @@ -3064,8 +3551,10 @@ 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]). Connection status information is also +// communicated as a fleet event. +// +// [VpcPeeringConnectionStateReason]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpcPeeringConnectionStateReason.html type VpcPeeringConnectionStatus struct { // Code indicating the status of a VPC peering connection. diff --git a/service/glacier/api_op_AbortMultipartUpload.go b/service/glacier/api_op_AbortMultipartUpload.go index 4eab3041001..89b80ed5bb2 100644 --- a/service/glacier/api_op_AbortMultipartUpload.go +++ b/service/glacier/api_op_AbortMultipartUpload.go @@ -11,21 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation aborts a multipart upload identified by the upload ID. After the -// Abort Multipart Upload request succeeds, you cannot upload any more parts to the -// 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 -// 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) -// in the Amazon Glacier Developer Guide. +// This operation aborts a multipart upload identified by the upload ID. +// +// After the Abort Multipart Upload request succeeds, you cannot upload any more +// parts to the 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 UploadMultipartPartand 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)]. +// +// For conceptual information and underlying REST API, see [Working with Archives in Amazon S3 Glacier] and [Abort Multipart Upload] in the Amazon +// Glacier Developer Guide. +// +// [Abort Multipart Upload]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Working with Archives in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipartUploadInput, optFns ...func(*Options)) (*AbortMultipartUploadOutput, error) { if params == nil { params = &AbortMultipartUploadInput{} @@ -41,10 +47,13 @@ func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipar return out, nil } -// 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) -// . +// Provides options to abort a multipart upload identified by the upload ID. +// +// For information about the underlying REST API, see [Abort Multipart Upload]. For conceptual +// information, see [Working with Archives in Amazon S3 Glacier]. +// +// [Abort Multipart Upload]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html +// [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. diff --git a/service/glacier/api_op_AbortVaultLock.go b/service/glacier/api_op_AbortVaultLock.go index a0ce2aa064a..1a5d47548b2 100644 --- a/service/glacier/api_op_AbortVaultLock.go +++ b/service/glacier/api_op_AbortVaultLock.go @@ -14,16 +14,19 @@ import ( // This operation aborts the vault locking process if the vault lock is not in the // 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 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]. For more +// information about vault lock policies, see [Amazon Glacier Access Control with Vault Lock Policies]. +// +// 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. +// +// [Amazon Glacier Vault Lock]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html +// [Amazon Glacier Access Control with Vault Lock Policies]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html func (c *Client) AbortVaultLock(ctx context.Context, params *AbortVaultLockInput, optFns ...func(*Options)) (*AbortVaultLockOutput, error) { if params == nil { params = &AbortVaultLockInput{} diff --git a/service/glacier/api_op_AddTagsToVault.go b/service/glacier/api_op_AddTagsToVault.go index 4f855659714..847770996ac 100644 --- a/service/glacier/api_op_AddTagsToVault.go +++ b/service/glacier/api_op_AddTagsToVault.go @@ -16,8 +16,9 @@ import ( // 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]. +// +// [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{} diff --git a/service/glacier/api_op_CompleteMultipartUpload.go b/service/glacier/api_op_CompleteMultipartUpload.go index f80f0193acd..f99415ca0d4 100644 --- a/service/glacier/api_op_CompleteMultipartUpload.go +++ b/service/glacier/api_op_CompleteMultipartUpload.go @@ -18,34 +18,44 @@ 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 -// 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 +// 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]. 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 -// 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 -// and return the same archive ID. This is useful in the event you experience a -// network issue that causes an aborted connection or receive a 500 server error, -// in which case you can repeat your Complete Multipart Upload request and get the -// same archive ID without creating duplicate archives. Note, however, that after -// the multipart upload completes, you cannot call the List Parts operation and the -// multipart upload will not appear in List Multipart Uploads response, even if -// 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) -// in the Amazon Glacier Developer Guide. +// otherwise, it returns an error, and the operation fails. The ListPartsoperation 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 and return the same archive ID. This is +// useful in the event you experience a network issue that causes an aborted +// connection or receive a 500 server error, in which case you can repeat your +// Complete Multipart Upload request and get the same archive ID without creating +// duplicate archives. Note, however, that after the multipart upload completes, +// you cannot call the List Parts operation and the multipart upload will not +// appear in List Multipart Uploads response, even if 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)]. +// +// For conceptual information and underlying REST API, see [Uploading Large Archives in Parts (Multipart Upload)] and [Complete Multipart Upload] in the Amazon +// Glacier Developer Guide. +// +// [Complete Multipart Upload]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html +// [Uploading Large Archives in Parts (Multipart Upload)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Computing Checksums]: https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMultipartUploadInput, optFns ...func(*Options)) (*CompleteMultipartUploadOutput, error) { if params == nil { params = &CompleteMultipartUploadInput{} @@ -100,10 +110,13 @@ type CompleteMultipartUploadInput struct { noSmithyDocumentSerde } -// 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) -// . +// Contains the Amazon S3 Glacier response to your request. +// +// For information about the underlying REST API, see [Upload Archive]. For conceptual +// information, see [Working with Archives in Amazon S3 Glacier]. +// +// [Working with Archives in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html +// [Upload Archive]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.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 16d566a8822..c7c1e1daa47 100644 --- a/service/glacier/api_op_CompleteVaultLock.go +++ b/service/glacier/api_op_CompleteVaultLock.go @@ -14,16 +14,19 @@ 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 +// 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]. +// +// 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. +// 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. +// +// [Amazon Glacier Vault Lock]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html func (c *Client) CompleteVaultLock(ctx context.Context, params *CompleteVaultLockInput, optFns ...func(*Options)) (*CompleteVaultLockOutput, error) { if params == nil { params = &CompleteVaultLockInput{} diff --git a/service/glacier/api_op_CreateVault.go b/service/glacier/api_op_CreateVault.go index f36a0691699..97b338d04f7 100644 --- a/service/glacier/api_op_CreateVault.go +++ b/service/glacier/api_op_CreateVault.go @@ -14,20 +14,28 @@ import ( // This operation creates a new vault with the specified name. The name of the // 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. +// 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). // -// 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)]. +// +// For conceptual information and underlying REST API, see [Creating a Vault in Amazon Glacier] and [Create Vault] in the Amazon +// Glacier Developer Guide. +// +// [Creating a Vault in Amazon Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Create Vault]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html func (c *Client) CreateVault(ctx context.Context, params *CreateVaultInput, optFns ...func(*Options)) (*CreateVaultOutput, error) { if params == nil { params = &CreateVaultInput{} diff --git a/service/glacier/api_op_DeleteArchive.go b/service/glacier/api_op_DeleteArchive.go index 3e79c1a4e7e..61ad929adde 100644 --- a/service/glacier/api_op_DeleteArchive.go +++ b/service/glacier/api_op_DeleteArchive.go @@ -18,20 +18,25 @@ import ( // - 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. // // 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) -// in the Amazon Glacier Developer Guide. +// 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)]. +// +// For conceptual information and underlying REST API, see [Deleting an Archive in Amazon Glacier] and [Delete Archive] in the Amazon +// Glacier Developer Guide. +// +// [Delete Archive]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Deleting an Archive in Amazon Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html func (c *Client) DeleteArchive(ctx context.Context, params *DeleteArchiveInput, optFns ...func(*Options)) (*DeleteArchiveOutput, error) { if params == nil { params = &DeleteArchiveInput{} diff --git a/service/glacier/api_op_DeleteVault.go b/service/glacier/api_op_DeleteVault.go index 63f7c869890..cc5753a854d 100644 --- a/service/glacier/api_op_DeleteVault.go +++ b/service/glacier/api_op_DeleteVault.go @@ -15,19 +15,26 @@ import ( // there are no archives in the vault as of the last inventory and there have been // 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) -// 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. +// and Amazon S3 Glacier returns an error. You can use DescribeVaultto return the number of +// archives in a vault, and you can use [Initiate a Job (POST jobs)]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)]. +// +// 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)]. +// +// For conceptual information and underlying REST API, see [Deleting a Vault in Amazon Glacier] and [Delete Vault] in the Amazon S3 +// Glacier Developer Guide. +// +// [Delete Archive (DELETE archive)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html +// [Deleting a Vault in Amazon Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html +// [Delete Vault]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html +// [Initiate a Job (POST jobs)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html func (c *Client) DeleteVault(ctx context.Context, params *DeleteVaultInput, optFns ...func(*Options)) (*DeleteVaultOutput, error) { if params == nil { params = &DeleteVaultInput{} diff --git a/service/glacier/api_op_DeleteVaultAccessPolicy.go b/service/glacier/api_op_DeleteVaultAccessPolicy.go index baf9b1e4149..81488945a63 100644 --- a/service/glacier/api_op_DeleteVaultAccessPolicy.go +++ b/service/glacier/api_op_DeleteVaultAccessPolicy.go @@ -15,10 +15,12 @@ import ( // The operation is eventually consistent; that is, it might take some time for // Amazon S3 Glacier to completely remove the access policy, and you might still // 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]. +// +// [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{} diff --git a/service/glacier/api_op_DeleteVaultNotifications.go b/service/glacier/api_op_DeleteVaultNotifications.go index 05817a602c2..fe9b8fa005e 100644 --- a/service/glacier/api_op_DeleteVaultNotifications.go +++ b/service/glacier/api_op_DeleteVaultNotifications.go @@ -14,16 +14,19 @@ import ( // This operation deletes the notification configuration set for a vault. The // operation is eventually consistent; that is, it might take some time for Amazon // S3 Glacier to completely disable the notifications and you might still receive -// some notifications for a short time after you send the delete 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 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. +// some notifications for a short time after you send the delete 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)]. +// +// For conceptual information and underlying REST API, see [Configuring Vault Notifications in Amazon S3 Glacier] and [Delete Vault Notification Configuration] in the Amazon S3 +// Glacier Developer Guide. +// +// [Configuring Vault Notifications in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Delete Vault Notification Configuration]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html func (c *Client) DeleteVaultNotifications(ctx context.Context, params *DeleteVaultNotificationsInput, optFns ...func(*Options)) (*DeleteVaultNotificationsOutput, error) { if params == nil { params = &DeleteVaultNotificationsInput{} diff --git a/service/glacier/api_op_DescribeJob.go b/service/glacier/api_op_DescribeJob.go index fbab0930ded..050c2481506 100644 --- a/service/glacier/api_op_DescribeJob.go +++ b/service/glacier/api_op_DescribeJob.go @@ -15,19 +15,25 @@ import ( // This operation returns information about a job you previously initiated, // 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. -// 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 -// Glacier completes the job. 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 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. +// (Glacier) completes the job. For more information about initiating a job, see 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 Glacier completes the job. +// +// 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)]. +// +// For more information about using this operation, see the documentation for the +// underlying REST API [Describe Job]in the Amazon Glacier Developer Guide. +// +// [Describe Job]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error) { if params == nil { params = &DescribeJobInput{} @@ -128,17 +134,24 @@ type DescribeJobOutput struct { RetrievalByteRange *string // For an archive retrieval job, this value is the checksum of the archive. - // Otherwise, this value is null. The SHA256 tree hash value for the requested - // range of an archive. If the InitiateJob request for an archive specified a - // 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: + // Otherwise, this value is null. + // + // The SHA256 tree hash value for the requested range of an archive. If the + // InitiateJob request for an archive specified a 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 // // - Archival jobs that specify a range that is equal to the whole archive, when // the job status is InProgress // // - Inventory jobs + // // - Select jobs SHA256TreeHash *string diff --git a/service/glacier/api_op_DescribeVault.go b/service/glacier/api_op_DescribeVault.go index 06adac1a3f1..af70a3887ec 100644 --- a/service/glacier/api_op_DescribeVault.go +++ b/service/glacier/api_op_DescribeVault.go @@ -22,18 +22,21 @@ 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 -// 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). +// 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]. +// +// 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. +// specific actions. For more information, see [Access Control Using AWS Identity and Access Management (IAM)]. +// +// For conceptual information and underlying REST API, see [Retrieving Vault Metadata in Amazon S3 Glacier] and [Describe Vault] in the Amazon +// Glacier Developer Guide. +// +// [Downloading a Vault Inventory in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html +// [Describe Vault]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html +// [Retrieving Vault Metadata in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html func (c *Client) DescribeVault(ctx context.Context, params *DescribeVaultInput, optFns ...func(*Options)) (*DescribeVaultOutput, error) { if params == nil { params = &DescribeVaultInput{} @@ -231,12 +234,13 @@ type VaultExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVaultInput, *DescribeVaultOutput, error) (bool, error) } @@ -396,12 +400,13 @@ type VaultNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeVaultInput, *DescribeVaultOutput, error) (bool, error) } diff --git a/service/glacier/api_op_GetDataRetrievalPolicy.go b/service/glacier/api_op_GetDataRetrievalPolicy.go index 53941d89c8e..d911620e1f7 100644 --- a/service/glacier/api_op_GetDataRetrievalPolicy.go +++ b/service/glacier/api_op_GetDataRetrievalPolicy.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} diff --git a/service/glacier/api_op_GetJobOutput.go b/service/glacier/api_op_GetJobOutput.go index aa4d3dcc486..b1a5e23a83b 100644 --- a/service/glacier/api_op_GetJobOutput.go +++ b/service/glacier/api_op_GetJobOutput.go @@ -12,39 +12,49 @@ import ( "io" ) -// 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 -// range. In the case of an archive retrieval job, depending on the byte range you -// specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the -// data. You can compute the checksum on the client and verify that the values -// match to ensure the portion you downloaded is the correct data. A job ID will -// not expire for at least 24 hours after Glacier completes the job. That a byte -// range. For both archive and inventory retrieval jobs, you should verify the -// downloaded size against the size returned in the headers from the Get Job Output -// 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 +// 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 range. In the case of an archive retrieval job, depending on +// the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for +// the portion of the data. You can compute the checksum on the client and verify +// that the values match to ensure the portion you downloaded is the correct data. +// +// A job ID will not expire for at least 24 hours after Glacier completes the job. +// That a byte range. For both archive and inventory retrieval jobs, you should +// verify the downloaded size against the size returned in the headers from the Get +// Job Output 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 // 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 -// retrieval job, depending on the byte range you specify, Glacier returns the -// checksum for the portion of the data. To ensure the portion you downloaded is -// the correct data, compute the checksum on the client, verify that the values -// match, and verify that the size is what you expected. A job ID does not expire -// for at least 24 hours after Glacier completes the job. That is, you can download -// the job output within the 24 hours period after Amazon Glacier completes the -// job. An AWS account has full permission to perform all operations (actions). +// the headers from the Get Job Output response. +// +// In the case of an archive retrieval job, depending on the byte range you +// specify, Glacier returns the checksum for the portion of the data. To ensure the +// portion you downloaded is the correct data, compute the checksum on the client, +// verify that the values match, and verify that the size is what you expected. +// +// A job ID does not expire for at least 24 hours after Glacier completes the job. +// That is, you can download the job output within the 24 hours period after Amazon +// Glacier completes the job. +// +// 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 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) +// specific actions. For more information, see [Access Control Using AWS Identity and Access Management (IAM)]. +// +// For conceptual information and the underlying REST API, see [Downloading a Vault Inventory], [Downloading an Archive], and [Get Job Output] +// +// [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 +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [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{} @@ -84,27 +94,33 @@ type GetJobOutputInput struct { // 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 - // 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: + // 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. + // the entire output. Using the DescribeJobAPI, 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 @@ -113,8 +129,9 @@ 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]. + // + // [RFC2616]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html AcceptRanges *string // The description of an archive. @@ -126,11 +143,14 @@ 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 diff --git a/service/glacier/api_op_GetVaultAccessPolicy.go b/service/glacier/api_op_GetVaultAccessPolicy.go index 541616aadf1..3b49da62554 100644 --- a/service/glacier/api_op_GetVaultAccessPolicy.go +++ b/service/glacier/api_op_GetVaultAccessPolicy.go @@ -13,12 +13,12 @@ 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) -// . +// more information on setting this subresource, see [Set Vault Access Policy (PUT access-policy)]. 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]. +// +// [Set Vault Access Policy (PUT access-policy)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html +// [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{} diff --git a/service/glacier/api_op_GetVaultLock.go b/service/glacier/api_op_GetVaultLock.go index 719c310fb07..06d8bccce8a 100644 --- a/service/glacier/api_op_GetVaultLock.go +++ b/service/glacier/api_op_GetVaultLock.go @@ -13,20 +13,25 @@ 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. // -// 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]. +// +// 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]. +// +// [Amazon Glacier Vault Lock]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html +// [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{} diff --git a/service/glacier/api_op_GetVaultNotifications.go b/service/glacier/api_op_GetVaultNotifications.go index 6bd813a1f52..2097f2108fa 100644 --- a/service/glacier/api_op_GetVaultNotifications.go +++ b/service/glacier/api_op_GetVaultNotifications.go @@ -13,20 +13,23 @@ 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). +// 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]. +// +// 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. +// specific actions. For more information, see [Access Control Using AWS Identity and Access Management (IAM)]. +// +// For conceptual information and underlying REST API, see [Configuring Vault Notifications in Amazon S3 Glacier] and [Get Vault Notification Configuration] in the Amazon +// Glacier Developer Guide. +// +// [Configuring Vault Notifications in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Get Vault Notification Configuration]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html func (c *Client) GetVaultNotifications(ctx context.Context, params *GetVaultNotificationsInput, optFns ...func(*Options)) (*GetVaultNotificationsOutput, error) { if params == nil { params = &GetVaultNotificationsInput{} diff --git a/service/glacier/api_op_InitiateJob.go b/service/glacier/api_op_InitiateJob.go index 00369052b2e..1fd57621b71 100644 --- a/service/glacier/api_op_InitiateJob.go +++ b/service/glacier/api_op_InitiateJob.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} diff --git a/service/glacier/api_op_InitiateMultipartUpload.go b/service/glacier/api_op_InitiateMultipartUpload.go index 1a1408a0a62..72f61e28ff4 100644 --- a/service/glacier/api_op_InitiateMultipartUpload.go +++ b/service/glacier/api_op_InitiateMultipartUpload.go @@ -13,30 +13,39 @@ 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 -// 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 -// resource if you cancel the multipart upload or it may be removed if there is no -// 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) -// in the Amazon Glacier Developer Guide. +// 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 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 resource if you cancel the multipart upload or it may be +// removed if there is no 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)]. +// +// For conceptual information and underlying REST API, see [Uploading Large Archives in Parts (Multipart Upload)] and [Initiate Multipart Upload] in the Amazon +// Glacier Developer Guide. +// +// [Uploading Large Archives in Parts (Multipart Upload)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Initiate Multipart Upload]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html func (c *Client) InitiateMultipartUpload(ctx context.Context, params *InitiateMultipartUploadInput, optFns ...func(*Options)) (*InitiateMultipartUploadOutput, error) { if params == nil { params = &InitiateMultipartUploadInput{} @@ -70,10 +79,11 @@ 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), - // 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). + // 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 // The size of each part except the last, in bytes. The last part can be smaller diff --git a/service/glacier/api_op_InitiateVaultLock.go b/service/glacier/api_op_InitiateVaultLock.go index 37d4df6fb87..f611e55d4b7 100644 --- a/service/glacier/api_op_InitiateVaultLock.go +++ b/service/glacier/api_op_InitiateVaultLock.go @@ -13,26 +13,36 @@ 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. // // 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 +// 20 KB in size. For more information about vault lock policies, see [Amazon Glacier Access Control with Vault Lock Policies]. +// +// 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. +// policy is removed from the vault. You call CompleteVaultLockto 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]. +// +// 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. +// +// [Amazon Glacier Vault Lock]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html +// [Amazon Glacier Access Control with Vault Lock Policies]: https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html func (c *Client) InitiateVaultLock(ctx context.Context, params *InitiateVaultLockInput, optFns ...func(*Options)) (*InitiateVaultLockOutput, error) { if params == nil { params = &InitiateVaultLockInput{} diff --git a/service/glacier/api_op_ListJobs.go b/service/glacier/api_op_ListJobs.go index c747d0871af..5bbf86bb49d 100644 --- a/service/glacier/api_op_ListJobs.go +++ b/service/glacier/api_op_ListJobs.go @@ -14,32 +14,41 @@ import ( // This operation lists jobs for a vault, including jobs that are in-progress and // jobs that have recently finished. The List Job operation returns a list of these -// jobs sorted by job initiation time. Amazon Glacier retains recently completed -// jobs for a period before deleting them; however, it eventually removes completed -// jobs. The output of completed jobs can be retrieved. Retaining completed jobs -// for a period of time after they have completed enables you to get a job output -// in the event you miss the job completion notification or your first attempt to -// download it fails. For example, suppose you start an archive retrieval job to -// download an archive. After the job completes, you start to download the archive -// 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 -// 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 -// than the limit, but the number of returned jobs never exceeds the limit. +// jobs sorted by job initiation time. +// +// Amazon Glacier retains recently completed jobs for a period before deleting +// them; however, it eventually removes completed jobs. The output of completed +// jobs can be retrieved. Retaining completed jobs for a period of time after they +// have completed enables you to get a job output in the event you miss the job +// completion notification or your first attempt to download it fails. For example, +// suppose you start an archive retrieval job to download an archive. After the job +// completes, you start to download the archive 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 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 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) -// . +// ( false ). +// +// For more information about using this operation, see the documentation for the +// underlying REST API [List Jobs]. +// +// [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{} @@ -99,7 +108,7 @@ 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 + // 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. diff --git a/service/glacier/api_op_ListMultipartUploads.go b/service/glacier/api_op_ListMultipartUploads.go index c5675adaba1..6bfd99c4e3f 100644 --- a/service/glacier/api_op_ListMultipartUploads.go +++ b/service/glacier/api_op_ListMultipartUploads.go @@ -14,28 +14,34 @@ import ( // This operation lists in-progress multipart uploads for the specified vault. An // in-progress multipart upload is a multipart upload that has been initiated by an -// InitiateMultipartUpload request, but has not yet been completed or aborted. The -// list returned in the List Multipart Upload response has no guaranteed order. The -// 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 -// 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 -// 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) -// in the Amazon Glacier Developer Guide. +// InitiateMultipartUploadrequest, but has not yet been completed or aborted. The list returned in the +// List Multipart Upload response has no guaranteed order. +// +// The 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 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 default. You must grant them explicit permission to perform +// specific actions. For more information, see [Access Control Using AWS Identity and Access Management (IAM)]. +// +// For conceptual information and the underlying REST API, see [Working with Archives in Amazon S3 Glacier] and [List Multipart Uploads] 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 +// [Working with Archives in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html +// [List Multipart Uploads]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipartUploadsInput, optFns ...func(*Options)) (*ListMultipartUploadsOutput, error) { if params == nil { params = &ListMultipartUploadsInput{} diff --git a/service/glacier/api_op_ListParts.go b/service/glacier/api_op_ListParts.go index ded2205360a..2f2b87db250 100644 --- a/service/glacier/api_op_ListParts.go +++ b/service/glacier/api_op_ListParts.go @@ -14,24 +14,29 @@ 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 -// 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 -// 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) -// in the Amazon Glacier Developer Guide. +// in-progress multipart upload before you complete the upload (see 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 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)]. +// +// For conceptual information and the underlying REST API, see [Working with Archives in Amazon S3 Glacier] and [List Parts] in the Amazon +// Glacier Developer Guide. +// +// [List Parts]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Working with Archives in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns ...func(*Options)) (*ListPartsOutput, error) { if params == nil { params = &ListPartsInput{} diff --git a/service/glacier/api_op_ListTagsForVault.go b/service/glacier/api_op_ListTagsForVault.go index 77181e0a4fa..8752f052b75 100644 --- a/service/glacier/api_op_ListTagsForVault.go +++ b/service/glacier/api_op_ListTagsForVault.go @@ -12,9 +12,9 @@ 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) -// . +// empty map if there are no tags. For more information about tags, see [Tagging Amazon S3 Glacier Resources]. +// +// [Tagging 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{} diff --git a/service/glacier/api_op_ListVaults.go b/service/glacier/api_op_ListVaults.go index 0c65743ad58..ec57297b553 100644 --- a/service/glacier/api_op_ListVaults.go +++ b/service/glacier/api_op_ListVaults.go @@ -13,22 +13,27 @@ import ( ) // This operation lists all vaults owned by the calling user's account. The list -// 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. +// 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)]. +// +// For conceptual information and underlying REST API, see [Retrieving Vault Metadata in Amazon S3 Glacier] and [List Vaults] in the Amazon +// Glacier Developer Guide. +// +// [List Vaults]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html +// [Retrieving Vault Metadata in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html func (c *Client) ListVaults(ctx context.Context, params *ListVaultsInput, optFns ...func(*Options)) (*ListVaultsOutput, error) { if params == nil { params = &ListVaultsInput{} diff --git a/service/glacier/api_op_RemoveTagsFromVault.go b/service/glacier/api_op_RemoveTagsFromVault.go index 86303cde5a2..080b9261a3a 100644 --- a/service/glacier/api_op_RemoveTagsFromVault.go +++ b/service/glacier/api_op_RemoveTagsFromVault.go @@ -12,9 +12,10 @@ 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]. This operation is idempotent. The +// operation will be successful, even if there are no tags attached to the vault. +// +// [Tagging Amazon S3 Glacier Resources]: https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html func (c *Client) RemoveTagsFromVault(ctx context.Context, params *RemoveTagsFromVaultInput, optFns ...func(*Options)) (*RemoveTagsFromVaultOutput, error) { if params == nil { params = &RemoveTagsFromVaultInput{} diff --git a/service/glacier/api_op_SetDataRetrievalPolicy.go b/service/glacier/api_op_SetDataRetrievalPolicy.go index 030301707dd..69fc99ffc45 100644 --- a/service/glacier/api_op_SetDataRetrievalPolicy.go +++ b/service/glacier/api_op_SetDataRetrievalPolicy.go @@ -15,10 +15,13 @@ import ( // This operation sets and then enacts a data retrieval policy in the region // specified in the PUT request. You can set one policy per region for an AWS // 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) -// . +// 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]. +// +// [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{} diff --git a/service/glacier/api_op_SetVaultAccessPolicy.go b/service/glacier/api_op_SetVaultAccessPolicy.go index eb9cd458783..617778078dd 100644 --- a/service/glacier/api_op_SetVaultAccessPolicy.go +++ b/service/glacier/api_op_SetVaultAccessPolicy.go @@ -17,8 +17,9 @@ 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]. +// +// [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{} diff --git a/service/glacier/api_op_SetVaultNotifications.go b/service/glacier/api_op_SetVaultNotifications.go index b5fedc0e997..688c19ae2fc 100644 --- a/service/glacier/api_op_SetVaultNotifications.go +++ b/service/glacier/api_op_SetVaultNotifications.go @@ -13,31 +13,38 @@ import ( ) // This operation configures notifications that will be sent when specific events -// happen to a vault. By default, you don't get any notifications. To configure -// vault notifications, send a PUT request to the notification-configuration -// subresource of the vault. The request should include a JSON document that -// 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: +// happen to a vault. By default, you don't get any notifications. +// +// To configure vault notifications, send a PUT request to the +// notification-configuration subresource of the vault. The request should include +// a JSON document that 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: +// // - 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 . +// 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 . +// 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) -// in the Amazon Glacier Developer Guide. +// specific actions. For more information, see [Access Control Using AWS Identity and Access Management (IAM)]. +// +// For conceptual information and underlying REST API, see [Configuring Vault Notifications in Amazon S3 Glacier] and [Set Vault Notification Configuration] in the Amazon +// Glacier Developer Guide. +// +// [Set Vault Notification Configuration]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html +// [Configuring Vault Notifications in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html func (c *Client) SetVaultNotifications(ctx context.Context, params *SetVaultNotificationsInput, optFns ...func(*Options)) (*SetVaultNotificationsOutput, error) { if params == nil { params = &SetVaultNotificationsInput{} diff --git a/service/glacier/api_op_UploadArchive.go b/service/glacier/api_op_UploadArchive.go index f54619758e1..fa40bf0e738 100644 --- a/service/glacier/api_op_UploadArchive.go +++ b/service/glacier/api_op_UploadArchive.go @@ -14,32 +14,42 @@ import ( // This operation adds an archive to a vault. This is a synchronous operation, and // for a successful upload, your data is durably persisted. Amazon S3 Glacier -// returns the archive ID in the x-amz-archive-id header of the response. You must -// use the archive ID to access your data in Amazon S3 Glacier. After you upload an -// archive, you should save the archive ID returned so that you can retrieve or -// delete the archive later. Besides saving the archive ID, you can also index it -// and give it a friendly name to allow for better searching. You can also use the -// 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 -// 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 +// returns the archive ID in the x-amz-archive-id header of the response. +// +// You must use the archive ID to access your data in Amazon S3 Glacier. After you +// upload an archive, you should save the archive ID returned so that you can +// retrieve or delete the archive later. Besides saving the archive ID, you can +// also index it and give it a friendly name to allow for better searching. You can +// also use the 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 data you are uploading. For +// information about computing a SHA256 tree hash, see [Computing Checksums]. +// +// 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 -// archive, you cannot edit the archive or its description. 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 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. +// 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 archive, you cannot edit the +// archive or its description. +// +// 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)]. +// +// For conceptual information and underlying REST API, see [Uploading an Archive in Amazon Glacier] and [Upload Archive] in the Amazon +// Glacier Developer Guide. +// +// [Uploading an Archive in Amazon Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Upload Archive]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html +// [Computing Checksums]: https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html func (c *Client) UploadArchive(ctx context.Context, params *UploadArchiveInput, optFns ...func(*Options)) (*UploadArchiveOutput, error) { if params == nil { params = &UploadArchiveInput{} @@ -84,10 +94,13 @@ type UploadArchiveInput struct { noSmithyDocumentSerde } -// 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) -// . +// Contains the Amazon S3 Glacier response to your request. +// +// For information about the underlying REST API, see [Upload Archive]. For conceptual +// information, see [Working with Archives in Amazon S3 Glacier]. +// +// [Working with Archives in Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html +// [Upload Archive]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.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 934a8bb680c..86e8777af53 100644 --- a/service/glacier/api_op_UploadMultipartPart.go +++ b/service/glacier/api_op_UploadMultipartPart.go @@ -14,39 +14,50 @@ import ( // 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: +// 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) -// . +// information about computing a SHA256 tree hash, see [Computing Checksums]. +// // - 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. +// the size specified in the corresponding InitiateMultipartUploadrequest. 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). +// 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. +// specific actions. For more information, see [Access Control Using AWS Identity and Access Management (IAM)]. +// +// For conceptual information and underlying REST API, see [Uploading Large Archives in Parts (Multipart Upload)] and [Upload Part] in the Amazon +// Glacier Developer Guide. +// +// [Uploading Large Archives in Parts (Multipart Upload)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html +// [Upload Part]: https://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html +// [Access Control Using AWS Identity and Access Management (IAM)]: https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html +// [Computing Checksums]: https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html func (c *Client) UploadMultipartPart(ctx context.Context, params *UploadMultipartPartInput, optFns ...func(*Options)) (*UploadMultipartPartOutput, error) { if params == nil { params = &UploadMultipartPartInput{} diff --git a/service/glacier/doc.go b/service/glacier/doc.go index 3bf1797d16b..9dd7e4527b5 100644 --- a/service/glacier/doc.go +++ b/service/glacier/doc.go @@ -3,27 +3,37 @@ // 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 -// 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 -// storage to AWS, so they don't have to worry about capacity planning, hardware -// provisioning, data replication, hardware failure and recovery, or time-consuming -// 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 -// 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. +// 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 storage to AWS, so they don't have to worry about capacity planning, +// hardware provisioning, data replication, hardware failure and recovery, or +// time-consuming 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)]. +// +// 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] +// - - 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] +// - - 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. +// +// [Getting Started with Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html +// [Amazon Simple Storage Service (Amazon S3)]: http://aws.amazon.com/s3/ +// [What is Amazon S3 Glacier]: https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html package glacier diff --git a/service/glacier/options.go b/service/glacier/options.go index d2555d6d115..2832adf6209 100644 --- a/service/glacier/options.go +++ b/service/glacier/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/glacier/types/enums.go b/service/glacier/types/enums.go index 10b6a75a2ca..790f1536374 100644 --- a/service/glacier/types/enums.go +++ b/service/glacier/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ActionCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionCode) Values() []ActionCode { return []ActionCode{ "ArchiveRetrieval", @@ -36,8 +37,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -59,8 +61,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "aws:kms", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for ExpressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpressionType) Values() []ExpressionType { return []ExpressionType{ "SQL", @@ -94,8 +98,9 @@ const ( ) // Values returns all known values for FileHeaderInfo. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileHeaderInfo) Values() []FileHeaderInfo { return []FileHeaderInfo{ "USE", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "FULL_CONTROL", @@ -137,8 +143,9 @@ const ( ) // Values returns all known values for QuoteFields. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuoteFields) Values() []QuoteFields { return []QuoteFields{ "ALWAYS", @@ -156,8 +163,9 @@ const ( ) // Values returns all known values for StatusCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusCode) Values() []StatusCode { return []StatusCode{ "InProgress", @@ -176,8 +184,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -196,8 +205,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "AmazonCustomerByEmail", diff --git a/service/glacier/types/types.go b/service/glacier/types/types.go index eb2088fce17..39826bc8675 100644 --- a/service/glacier/types/types.go +++ b/service/glacier/types/types.go @@ -71,14 +71,16 @@ type DataRetrievalPolicy struct { // Data retrieval policy rule. 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 - // operation will be rejected if the Strategy field is not set to BytesPerHour and - // you set this field. + // 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 operation will be rejected if the Strategy field is not set to + // BytesPerHour and you set this field. BytesPerHour *int64 - // The type of data retrieval policy to set. Valid values: - // BytesPerHour|FreeTier|None + // The type of data retrieval policy to set. + // + // Valid values: BytesPerHour|FreeTier|None Strategy *string noSmithyDocumentSerde @@ -196,17 +198,24 @@ type GlacierJobDescription struct { RetrievalByteRange *string // For an archive retrieval job, this value is the checksum of the archive. - // Otherwise, this value is null. The SHA256 tree hash value for the requested - // range of an archive. If the InitiateJob request for an archive specified a - // 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: + // Otherwise, this value is null. + // + // The SHA256 tree hash value for the requested range of an archive. If the + // InitiateJob request for an archive specified a 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 // // - Archival jobs that specify a range that is equal to the whole archive, when // the job status is InProgress // // - Inventory jobs + // // - Select jobs SHA256TreeHash *string @@ -299,8 +308,9 @@ 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]. + // + // [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 @@ -369,8 +379,10 @@ type JobParameters struct { // that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be // divisible by 1 MB or be the end of the archive specified as the archive byte // size value minus 1. If RetrievalByteRange is not megabyte aligned, this - // operation returns a 400 response. An error occurs if you specify this field for - // an inventory retrieval job request. + // operation returns a 400 response. + // + // An error occurs if you specify this field for an inventory retrieval job + // request. RetrievalByteRange *string // The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when diff --git a/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go b/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go index 65bb4f88d19..4d2013bf363 100644 --- a/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go +++ b/service/globalaccelerator/api_op_AddCustomRoutingEndpoints.go @@ -12,17 +12,22 @@ import ( ) // 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 -// available to map to the subnet ports, or the call will fail with a -// 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) -// operation. +// 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 available to map to the +// subnet ports, or the call will fail with a 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]operation. +// +// [AllowCustomRoutingTraffic]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html func (c *Client) AddCustomRoutingEndpoints(ctx context.Context, params *AddCustomRoutingEndpointsInput, optFns ...func(*Options)) (*AddCustomRoutingEndpointsOutput, error) { if params == nil { params = &AddCustomRoutingEndpointsInput{} diff --git a/service/globalaccelerator/api_op_AddEndpoints.go b/service/globalaccelerator/api_op_AddEndpoints.go index dbef0e702f2..eee4fb22a1e 100644 --- a/service/globalaccelerator/api_op_AddEndpoints.go +++ b/service/globalaccelerator/api_op_AddEndpoints.go @@ -13,19 +13,25 @@ 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) -// API). There are two advantages to using AddEndpoints to add endpoints in Global +// endpoints when you create an endpoint group (with the [CreateEndpointGroup]API) or when you update +// an endpoint group (with the [UpdateEndpointGroup]API). +// +// There are two advantages to using AddEndpoints to add endpoints in Global // Accelerator: +// // - It's faster, because Global Accelerator only has to resolve the new // endpoints that you're adding, rather than resolving new and existing endpoints. +// // - It's more convenient, because you don't need to specify the current // endpoints that are already in the endpoint group, in addition to the new // endpoints that you want to add. // // For information about endpoint types and requirements for endpoints that you -// can add to Global Accelerator, see Endpoints for standard accelerators (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html) -// in the Global Accelerator Developer Guide. +// can add to Global Accelerator, see [Endpoints for standard accelerators]in the Global Accelerator Developer Guide. +// +// [Endpoints for standard accelerators]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html +// [UpdateEndpointGroup]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html +// [CreateEndpointGroup]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html 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 2ca582b2efb..7928a551bdd 100644 --- a/service/globalaccelerator/api_op_AdvertiseByoipCidr.go +++ b/service/globalaccelerator/api_op_AdvertiseByoipCidr.go @@ -14,10 +14,14 @@ import ( // Advertises an IPv4 address range that is provisioned for use with your Amazon // 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. +// Web Services because of propagation delays. +// +// To stop advertising the BYOIP address range, use [WithdrawByoipCidr]. +// +// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. +// +// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html +// [WithdrawByoipCidr]: https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html func (c *Client) AdvertiseByoipCidr(ctx context.Context, params *AdvertiseByoipCidrInput, optFns ...func(*Options)) (*AdvertiseByoipCidrOutput, error) { if params == nil { params = &AdvertiseByoipCidrInput{} @@ -36,9 +40,11 @@ func (c *Client) AdvertiseByoipCidr(ctx context.Context, params *AdvertiseByoipC type AdvertiseByoipCidrInput struct { // The address range, in CIDR notation. This must be the exact range that you - // provisioned. You can't advertise only a portion of the provisioned 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. + // provisioned. You can't advertise only a portion of the provisioned range. + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html // // This member is required. Cidr *string diff --git a/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go b/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go index 0d979379970..42201d97ac9 100644 --- a/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go +++ b/service/globalaccelerator/api_op_AllowCustomRoutingTraffic.go @@ -15,9 +15,11 @@ import ( // can allow traffic to all destinations in the subnet endpoint, or allow traffic // to a specified list of destination IP addresses and ports in the subnet. Note // that you cannot specify IP addresses or ports outside of the range that you -// configured for the endpoint group. After you make changes, you can verify that -// the updates are complete by checking the status of your accelerator: the status -// changes from IN_PROGRESS to DEPLOYED. +// configured for the endpoint group. +// +// After you make changes, you can verify that the updates are complete by +// checking the status of your accelerator: the status changes from IN_PROGRESS to +// DEPLOYED. func (c *Client) AllowCustomRoutingTraffic(ctx context.Context, params *AllowCustomRoutingTrafficInput, optFns ...func(*Options)) (*AllowCustomRoutingTrafficOutput, error) { if params == nil { params = &AllowCustomRoutingTrafficInput{} @@ -48,18 +50,24 @@ type AllowCustomRoutingTrafficInput struct { // Indicates whether all destination IP addresses and ports for a specified VPC // subnet endpoint can receive traffic from a custom routing accelerator. The value - // is TRUE or FALSE. When set to TRUE, all destinations in the custom routing VPC - // subnet can receive traffic. Note that you cannot specify destination IP - // addresses and ports when the value is set to TRUE. When set to FALSE (or not - // specified), you must specify a list of destination IP addresses that are allowed - // to receive traffic. A list of ports is optional. If you don't specify a list of - // ports, the ports that can accept traffic is the same as the ports configured for - // the endpoint group. The default value is FALSE. + // is TRUE or FALSE. + // + // When set to TRUE, all destinations in the custom routing VPC subnet can receive + // traffic. Note that you cannot specify destination IP addresses and ports when + // the value is set to TRUE. + // + // When set to FALSE (or not specified), you must specify a list of destination IP + // addresses that are allowed to receive traffic. A list of ports is optional. If + // you don't specify a list of ports, the ports that can accept traffic is the same + // as the ports configured for 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 // subset of the IP addresses that you specified for the endpoint group. + // // DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is // not specified. DestinationAddresses []string diff --git a/service/globalaccelerator/api_op_CreateAccelerator.go b/service/globalaccelerator/api_op_CreateAccelerator.go index 47ea02aea75..9c1a16ee727 100644 --- a/service/globalaccelerator/api_op_CreateAccelerator.go +++ b/service/globalaccelerator/api_op_CreateAccelerator.go @@ -13,11 +13,12 @@ import ( // Create an accelerator. An accelerator includes one or more listeners that // process inbound connections and direct traffic to one or more endpoint groups, -// each of which includes endpoints, such as Network Load Balancers. 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 Amazon Web Services CLI commands. +// each of which includes endpoints, such as Network Load Balancers. +// +// 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 Amazon Web Services CLI commands. func (c *Client) CreateAccelerator(ctx context.Context, params *CreateAcceleratorInput, optFns ...func(*Options)) (*CreateAcceleratorOutput, error) { if params == nil { params = &CreateAcceleratorInput{} @@ -49,8 +50,10 @@ type CreateAcceleratorInput struct { Name *string // Indicates whether an accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, an accelerator cannot be - // deleted. If set to false, the accelerator can be deleted. + // default value is true. + // + // If the value is set to true, an accelerator cannot be deleted. If set to false, + // the accelerator can be deleted. Enabled *bool // The IP address type that an accelerator supports. For a standard accelerator, @@ -59,24 +62,32 @@ type CreateAcceleratorInput struct { // Optionally, if you've added your own IP address pool to Global Accelerator // (BYOIP), you can choose an IPv4 address from your own pool to use for the - // accelerator's static IPv4 address when you create an accelerator. After you - // bring an address range to Amazon Web Services, it appears in your account as an - // address pool. When you create an accelerator, you can assign one IPv4 address - // from your range to it. Global Accelerator assigns you a second static IPv4 - // address from an Amazon IP address range. If you bring two IPv4 address ranges to - // Amazon Web Services, you can assign one IPv4 address from each range to your - // accelerator. This restriction is because Global Accelerator assigns each address - // range to a different network zone, for high availability. You can specify one or - // 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. + // accelerator's static IPv4 address when you create an accelerator. + // + // After you bring an address range to Amazon Web Services, it appears in your + // account as an address pool. When you create an accelerator, you can assign one + // IPv4 address from your range to it. Global Accelerator assigns you a second + // static IPv4 address from an Amazon IP address range. If you bring two IPv4 + // address ranges to Amazon Web Services, you can assign one IPv4 address from each + // range to your accelerator. This restriction is because Global Accelerator + // assigns each address range to a different network zone, for high availability. + // + // You can specify one or 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)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html 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) - // in the Global Accelerator Developer Guide. + // Create tags for an accelerator. + // + // For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide. + // + // [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_CreateCrossAccountAttachment.go b/service/globalaccelerator/api_op_CreateCrossAccountAttachment.go index e2b7c9ba9db..e739b87cab1 100644 --- a/service/globalaccelerator/api_op_CreateCrossAccountAttachment.go +++ b/service/globalaccelerator/api_op_CreateCrossAccountAttachment.go @@ -14,20 +14,26 @@ import ( // Create a cross-account attachment in Global Accelerator. You create a // cross-account attachment to specify the principals who have permission to work // with resources in accelerators in their own account. You specify, in the same -// attachment, the resources that are shared. A principal can be an Amazon Web -// Services account number or the Amazon Resource Name (ARN) for an accelerator. -// For account numbers that are listed as principals, to work with a resource -// listed in the attachment, you must sign in to an account specified as a -// principal. Then, you can work with resources that are listed, with any of your -// accelerators. If an accelerator ARN is listed in the cross-account attachment as -// a principal, anyone with permission to make updates to the accelerator can work -// with resources that are listed in the attachment. Specify each principal and -// resource separately. To specify two CIDR address pools, list them individually -// under Resources , and so on. For a command line operation, for example, you -// might use a statement like the following: "Resources": [{"Cidr": -// "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}] For more information, see -// Working with cross-account attachments and resources in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) -// in the Global Accelerator Developer Guide. +// attachment, the resources that are shared. +// +// A principal can be an Amazon Web Services account number or the Amazon Resource +// Name (ARN) for an accelerator. For account numbers that are listed as +// principals, to work with a resource listed in the attachment, you must sign in +// to an account specified as a principal. Then, you can work with resources that +// are listed, with any of your accelerators. If an accelerator ARN is listed in +// the cross-account attachment as a principal, anyone with permission to make +// updates to the accelerator can work with resources that are listed in the +// attachment. +// +// Specify each principal and resource separately. To specify two CIDR address +// pools, list them individually under Resources , and so on. For a command line +// operation, for example, you might use a statement like the following: +// +// "Resources": [{"Cidr": "169.254.60.0/24"},{"Cidr": "169.254.59.0/24"}] +// +// For more information, see [Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Working with cross-account attachments and resources in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html func (c *Client) CreateCrossAccountAttachment(ctx context.Context, params *CreateCrossAccountAttachmentInput, optFns ...func(*Options)) (*CreateCrossAccountAttachmentOutput, error) { if params == nil { params = &CreateCrossAccountAttachmentInput{} @@ -67,9 +73,11 @@ type CreateCrossAccountAttachmentInput struct { // address (BYOIP) address pool. Resources []types.Resource - // Add tags for a cross-account attachment. 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. + // Add tags for a cross-account attachment. + // + // For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide. + // + // [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go b/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go index 598e5630918..78e382a1636 100644 --- a/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go +++ b/service/globalaccelerator/api_op_CreateCustomRoutingAccelerator.go @@ -13,15 +13,19 @@ import ( // Create a custom routing accelerator. A custom routing accelerator directs // traffic to one of possibly thousands of Amazon EC2 instance destinations running -// in a single or multiple virtual private clouds (VPC) subnet endpoints. Be aware -// 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) -// 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 -// example, specify --region us-west-2 on Amazon Web Services CLI commands. +// in a single or multiple virtual private clouds (VPC) subnet endpoints. +// +// Be aware 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] +// 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 example, +// specify --region us-west-2 on Amazon Web Services CLI commands. +// +// [AllowCustomRoutingTraffic]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html func (c *Client) CreateCustomRoutingAccelerator(ctx context.Context, params *CreateCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*CreateCustomRoutingAcceleratorOutput, error) { if params == nil { params = &CreateCustomRoutingAcceleratorInput{} @@ -53,8 +57,10 @@ type CreateCustomRoutingAcceleratorInput struct { Name *string // Indicates whether an accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, an accelerator cannot be - // deleted. If set to false, the accelerator can be deleted. + // default value is true. + // + // If the value is set to true, an accelerator cannot be deleted. If set to false, + // the accelerator can be deleted. Enabled *bool // The IP address type that an accelerator supports. For a custom routing @@ -63,24 +69,32 @@ type CreateCustomRoutingAcceleratorInput struct { // Optionally, if you've added your own IP address pool to Global Accelerator // (BYOIP), you can choose an IPv4 address from your own pool to use for the - // accelerator's static IPv4 address when you create an accelerator. After you - // bring an address range to Amazon Web Services, it appears in your account as an - // address pool. When you create an accelerator, you can assign one IPv4 address - // from your range to it. Global Accelerator assigns you a second static IPv4 - // address from an Amazon IP address range. If you bring two IPv4 address ranges to - // Amazon Web Services, you can assign one IPv4 address from each range to your - // accelerator. This restriction is because Global Accelerator assigns each address - // range to a different network zone, for high availability. You can specify one or - // 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. + // accelerator's static IPv4 address when you create an accelerator. + // + // After you bring an address range to Amazon Web Services, it appears in your + // account as an address pool. When you create an accelerator, you can assign one + // IPv4 address from your range to it. Global Accelerator assigns you a second + // static IPv4 address from an Amazon IP address range. If you bring two IPv4 + // address ranges to Amazon Web Services, you can assign one IPv4 address from each + // range to your accelerator. This restriction is because Global Accelerator + // assigns each address range to a different network zone, for high availability. + // + // You can specify one or 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)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html 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) - // in the Global Accelerator Developer Guide. + // Create tags for an accelerator. + // + // For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide. + // + // [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_CreateCustomRoutingListener.go b/service/globalaccelerator/api_op_CreateCustomRoutingListener.go index 5c0e6bf5b01..78f66478f14 100644 --- a/service/globalaccelerator/api_op_CreateCustomRoutingListener.go +++ b/service/globalaccelerator/api_op_CreateCustomRoutingListener.go @@ -43,9 +43,10 @@ type CreateCustomRoutingListenerInput struct { IdempotencyToken *string // 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) - // . + // + // Separately, you set port ranges for endpoints. For more information, see [About endpoints for custom routing accelerators]. + // + // [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_CreateEndpointGroup.go b/service/globalaccelerator/api_op_CreateEndpointGroup.go index 8c69116e01e..7d052f26453 100644 --- a/service/globalaccelerator/api_op_CreateEndpointGroup.go +++ b/service/globalaccelerator/api_op_CreateEndpointGroup.go @@ -13,10 +13,13 @@ import ( // Create an endpoint group for the specified listener. An endpoint group is a // collection of endpoints in one Amazon Web Services Region. A resource must be -// valid and active when you add it as an endpoint. For more information about -// endpoint types and requirements for endpoints that you can add to Global -// Accelerator, see Endpoints for standard accelerators (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html) -// in the Global Accelerator Developer Guide. +// valid and active when you add it as an endpoint. +// +// For more information about endpoint types and requirements for endpoints that +// you can add to Global Accelerator, see [Endpoints for standard accelerators]in the Global Accelerator Developer +// Guide. +// +// [Endpoints for standard accelerators]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html func (c *Client) CreateEndpointGroup(ctx context.Context, params *CreateEndpointGroupInput, optFns ...func(*Options)) (*CreateEndpointGroupOutput, error) { if params == nil { params = &CreateEndpointGroupInput{} @@ -76,8 +79,11 @@ 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) - // in the Global Accelerator Developer Guide. + // endpoints. + // + // For more information, see [Overriding listener ports] in the Global Accelerator Developer Guide. + // + // [Overriding listener ports]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html PortOverrides []types.PortOverride // The number of consecutive health checks required to set the state of a healthy @@ -86,10 +92,13 @@ type CreateEndpointGroupInput struct { ThresholdCount *int32 // The percentage of traffic to send to an Amazon Web Services Region. Additional - // traffic is distributed to other endpoint groups for this listener. Use this - // action to increase (dial up) or decrease (dial down) traffic to a specific - // Region. The percentage is applied to the traffic that would otherwise have been - // routed to the Region based on optimal routing. The default value is 100. + // traffic is distributed to other endpoint groups for this listener. + // + // Use this action to increase (dial up) or decrease (dial down) traffic to a + // specific Region. The percentage is applied to the traffic that would otherwise + // have been routed to the Region based on optimal routing. + // + // The default value is 100. TrafficDialPercentage *float32 noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_CreateListener.go b/service/globalaccelerator/api_op_CreateListener.go index 63584293f9c..d8af5a760b2 100644 --- a/service/globalaccelerator/api_op_CreateListener.go +++ b/service/globalaccelerator/api_op_CreateListener.go @@ -56,18 +56,22 @@ type CreateListenerInput struct { // Client affinity lets you direct all requests from a user to the same endpoint, // if you have stateful applications, regardless of the port and protocol of the // 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 . + // 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 . ClientAffinity types.ClientAffinity noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_DeleteAccelerator.go b/service/globalaccelerator/api_op_DeleteAccelerator.go index b75a660ba40..b09009fd31f 100644 --- a/service/globalaccelerator/api_op_DeleteAccelerator.go +++ b/service/globalaccelerator/api_op_DeleteAccelerator.go @@ -12,19 +12,22 @@ import ( // 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 +// 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. +// For more information, see [Identity and access management]in the Global Accelerator Developer Guide. +// +// [Identity and access management]: https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html func (c *Client) DeleteAccelerator(ctx context.Context, params *DeleteAcceleratorInput, optFns ...func(*Options)) (*DeleteAcceleratorOutput, error) { if params == nil { params = &DeleteAcceleratorInput{} diff --git a/service/globalaccelerator/api_op_DeleteCrossAccountAttachment.go b/service/globalaccelerator/api_op_DeleteCrossAccountAttachment.go index 87808598fd4..6c5941738f1 100644 --- a/service/globalaccelerator/api_op_DeleteCrossAccountAttachment.go +++ b/service/globalaccelerator/api_op_DeleteCrossAccountAttachment.go @@ -13,9 +13,11 @@ import ( // Delete a cross-account attachment. When you delete an attachment, Global // Accelerator revokes the permission to use the resources in the attachment from // all principals in the list of principals. Global Accelerator revokes the -// permission for specific resources. For more information, see Working with -// cross-account attachments and resources in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) -// in the Global Accelerator Developer Guide. +// permission for specific resources. +// +// For more information, see [Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Working with cross-account attachments and resources in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html func (c *Client) DeleteCrossAccountAttachment(ctx context.Context, params *DeleteCrossAccountAttachmentInput, optFns ...func(*Options)) (*DeleteCrossAccountAttachmentOutput, error) { if params == nil { params = &DeleteCrossAccountAttachmentInput{} diff --git a/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go b/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go index a29bff8aea9..d27fd937da7 100644 --- a/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go +++ b/service/globalaccelerator/api_op_DeleteCustomRoutingAccelerator.go @@ -13,17 +13,21 @@ import ( // Delete a custom routing 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 a custom routing accelerator, by default, Global -// Accelerator provides you with a set of two static IP addresses. 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. +// false. +// +// When you create a custom routing accelerator, by default, Global Accelerator +// provides you with a set of two static IP addresses. +// +// 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]in the Global Accelerator Developer Guide. +// +// [Identity and access management]: https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html func (c *Client) DeleteCustomRoutingAccelerator(ctx context.Context, params *DeleteCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*DeleteCustomRoutingAcceleratorOutput, error) { if params == nil { params = &DeleteCustomRoutingAcceleratorInput{} diff --git a/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go b/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go index da076d3ad30..6d0eaa5aaef 100644 --- a/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go +++ b/service/globalaccelerator/api_op_DenyCustomRoutingTraffic.go @@ -15,9 +15,11 @@ import ( // You can deny traffic to all destinations in the VPC endpoint, or deny traffic to // a specified list of destination IP addresses and ports. Note that you cannot // specify IP addresses or ports outside of the range that you configured for the -// endpoint group. After you make changes, you can verify that the updates are -// complete by checking the status of your accelerator: the status changes from -// IN_PROGRESS to DEPLOYED. +// endpoint group. +// +// After you make changes, you can verify that the updates are complete by +// checking the status of your accelerator: the status changes from IN_PROGRESS to +// DEPLOYED. func (c *Client) DenyCustomRoutingTraffic(ctx context.Context, params *DenyCustomRoutingTrafficInput, optFns ...func(*Options)) (*DenyCustomRoutingTrafficOutput, error) { if params == nil { params = &DenyCustomRoutingTrafficInput{} @@ -48,13 +50,18 @@ type DenyCustomRoutingTrafficInput struct { // Indicates whether all destination IP addresses and ports for a specified VPC // subnet endpoint cannot receive traffic from a custom routing accelerator. The - // value is TRUE or FALSE. When set to TRUE, no destinations in the custom routing - // VPC subnet can receive traffic. Note that you cannot specify destination IP - // addresses and ports when the value is set to TRUE. When set to FALSE (or not - // specified), you must specify a list of destination IP addresses that cannot - // receive traffic. A list of ports is optional. If you don't specify a list of - // ports, the ports that can accept traffic is the same as the ports configured for - // the endpoint group. The default value is FALSE. + // value is TRUE or FALSE. + // + // When set to TRUE, no destinations in the custom routing VPC subnet can receive + // traffic. Note that you cannot specify destination IP addresses and ports when + // the value is set to TRUE. + // + // When set to FALSE (or not specified), you must specify a list of destination IP + // addresses that cannot receive traffic. A list of ports is optional. If you don't + // specify a list of ports, the ports that can accept traffic is the same as the + // ports configured for the endpoint group. + // + // The default value is FALSE. DenyAllTrafficToEndpoint *bool // A list of specific Amazon EC2 instance IP addresses (destination addresses) in diff --git a/service/globalaccelerator/api_op_DeprovisionByoipCidr.go b/service/globalaccelerator/api_op_DeprovisionByoipCidr.go index b6e0ab3b393..cd2b11f2918 100644 --- a/service/globalaccelerator/api_op_DeprovisionByoipCidr.go +++ b/service/globalaccelerator/api_op_DeprovisionByoipCidr.go @@ -13,12 +13,16 @@ 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) +// deletes the corresponding address pool. +// +// Before you can release an address range, you must stop advertising it by using [WithdrawByoipCidr] // 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. +// allocated from its address range. +// +// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. +// +// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html +// [WithdrawByoipCidr]: https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html func (c *Client) DeprovisionByoipCidr(ctx context.Context, params *DeprovisionByoipCidrInput, optFns ...func(*Options)) (*DeprovisionByoipCidrOutput, error) { if params == nil { params = &DeprovisionByoipCidrInput{} @@ -37,9 +41,11 @@ 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. 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. + // you specified when you provisioned the address range. + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html // // This member is required. Cidr *string diff --git a/service/globalaccelerator/api_op_ListByoipCidrs.go b/service/globalaccelerator/api_op_ListByoipCidrs.go index b1e08127dce..ae48d80223c 100644 --- a/service/globalaccelerator/api_op_ListByoipCidrs.go +++ b/service/globalaccelerator/api_op_ListByoipCidrs.go @@ -11,8 +11,10 @@ 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], including the +// current state and a history of state changes. +// +// [ProvisionByoipCidr]: https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html 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_ListCrossAccountResourceAccounts.go b/service/globalaccelerator/api_op_ListCrossAccountResourceAccounts.go index 46f8da08d26..4d388040b98 100644 --- a/service/globalaccelerator/api_op_ListCrossAccountResourceAccounts.go +++ b/service/globalaccelerator/api_op_ListCrossAccountResourceAccounts.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the accounts that have cross-account resources. For more information, see -// Working with cross-account attachments and resources in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) -// in the Global Accelerator Developer Guide. +// List the accounts that have cross-account resources. +// +// For more information, see [Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Working with cross-account attachments and resources in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html func (c *Client) ListCrossAccountResourceAccounts(ctx context.Context, params *ListCrossAccountResourceAccountsInput, optFns ...func(*Options)) (*ListCrossAccountResourceAccountsOutput, error) { if params == nil { params = &ListCrossAccountResourceAccountsInput{} diff --git a/service/globalaccelerator/api_op_ListCustomRoutingPortMappings.go b/service/globalaccelerator/api_op_ListCustomRoutingPortMappings.go index 851f7bc551c..c332264d8d2 100644 --- a/service/globalaccelerator/api_op_ListCustomRoutingPortMappings.go +++ b/service/globalaccelerator/api_op_ListCustomRoutingPortMappings.go @@ -16,14 +16,16 @@ import ( // (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint // that you add, Global Accelerator creates a new static port mapping for the // accelerator. The port mappings don't change after Global Accelerator generates -// them, so you can retrieve and cache the full mapping on your servers. If you -// remove a subnet from your accelerator, Global Accelerator removes (reclaims) the -// port mappings. If you add a subnet to your accelerator, Global Accelerator -// creates new port mappings (the existing ones don't change). If you add or remove -// EC2 instances in your subnet, the port mappings don't change, because the -// mappings are created when you add the subnet to Global Accelerator. The mappings -// also include a flag for each destination denoting which destination IP addresses -// and ports are allowed or denied traffic. +// them, so you can retrieve and cache the full mapping on your servers. +// +// If you remove a subnet from your accelerator, Global Accelerator removes +// (reclaims) the port mappings. If you add a subnet to your accelerator, Global +// Accelerator creates new port mappings (the existing ones don't change). If you +// add or remove EC2 instances in your subnet, the port mappings don't change, +// because the mappings are created when you add the subnet to Global Accelerator. +// +// The mappings also include a flag for each destination denoting which +// destination IP addresses and ports are allowed or denied traffic. func (c *Client) ListCustomRoutingPortMappings(ctx context.Context, params *ListCustomRoutingPortMappingsInput, optFns ...func(*Options)) (*ListCustomRoutingPortMappingsOutput, error) { if params == nil { params = &ListCustomRoutingPortMappingsInput{} diff --git a/service/globalaccelerator/api_op_ListTagsForResource.go b/service/globalaccelerator/api_op_ListTagsForResource.go index 3ae12541aad..3e1666e52fd 100644 --- a/service/globalaccelerator/api_op_ListTagsForResource.go +++ b/service/globalaccelerator/api_op_ListTagsForResource.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Global Accelerator Developer Guide. +// List all tags for an accelerator. +// +// For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/globalaccelerator/api_op_ProvisionByoipCidr.go b/service/globalaccelerator/api_op_ProvisionByoipCidr.go index 1b090fe323a..d20633fb805 100644 --- a/service/globalaccelerator/api_op_ProvisionByoipCidr.go +++ b/service/globalaccelerator/api_op_ProvisionByoipCidr.go @@ -14,9 +14,12 @@ 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]. +// +// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. +// +// [AdvertiseByoipCidr]: https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html +// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html func (c *Client) ProvisionByoipCidr(ctx context.Context, params *ProvisionByoipCidrInput, optFns ...func(*Options)) (*ProvisionByoipCidrOutput, error) { if params == nil { params = &ProvisionByoipCidrInput{} @@ -37,8 +40,11 @@ type ProvisionByoipCidrInput struct { // The public IPv4 address range, in CIDR notation. The most specific IP prefix // that you can specify is /24. The address range cannot overlap with another // address range that you've brought to this Amazon Web Services Region or another - // Region. 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. + // Region. + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html // // This member is required. Cidr *string diff --git a/service/globalaccelerator/api_op_RemoveEndpoints.go b/service/globalaccelerator/api_op_RemoveEndpoints.go index ed50fc60c72..c32ce0f3a0e 100644 --- a/service/globalaccelerator/api_op_RemoveEndpoints.go +++ b/service/globalaccelerator/api_op_RemoveEndpoints.go @@ -11,18 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API operation. There are two advantages to using AddEndpoints to remove -// endpoints instead: +// 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]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. +// +// [UpdateEndpointGroup]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html 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 144af3a31de..f913830d6fd 100644 --- a/service/globalaccelerator/api_op_TagResource.go +++ b/service/globalaccelerator/api_op_TagResource.go @@ -11,9 +11,11 @@ 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) -// in the Global Accelerator Developer Guide. +// Add tags to an accelerator resource. +// +// For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/globalaccelerator/api_op_UntagResource.go b/service/globalaccelerator/api_op_UntagResource.go index 89ac9b14028..84033b040c1 100644 --- a/service/globalaccelerator/api_op_UntagResource.go +++ b/service/globalaccelerator/api_op_UntagResource.go @@ -13,8 +13,10 @@ 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) -// in the Global Accelerator Developer Guide. +// +// For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/globalaccelerator/api_op_UpdateAccelerator.go b/service/globalaccelerator/api_op_UpdateAccelerator.go index 1a242e211c0..6ceb4b5be06 100644 --- a/service/globalaccelerator/api_op_UpdateAccelerator.go +++ b/service/globalaccelerator/api_op_UpdateAccelerator.go @@ -12,10 +12,14 @@ import ( ) // Update an accelerator to make changes, such as the following: +// // - Change the name of the accelerator. +// // - Disable the accelerator so that it no longer accepts or routes traffic, or // so that you can delete it. +// // - Enable the accelerator, if it is disabled. +// // - Change the IP address type to dual-stack if it is IPv4, or change the IP // address type to IPv4 if it's dual-stack. // @@ -23,10 +27,12 @@ import ( // long as it exists, even if you disable the accelerator and it no longer accepts // or routes traffic. However, when you delete the accelerator, you lose the static // IP addresses that are assigned to it, so you can no longer route traffic by -// using them. 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 Amazon Web Services CLI commands. +// using them. +// +// 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 Amazon Web Services CLI commands. func (c *Client) UpdateAccelerator(ctx context.Context, params *UpdateAcceleratorInput, optFns ...func(*Options)) (*UpdateAcceleratorOutput, error) { if params == nil { params = &UpdateAcceleratorInput{} @@ -50,8 +56,10 @@ type UpdateAcceleratorInput struct { AcceleratorArn *string // Indicates whether an accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, the accelerator cannot be - // deleted. If set to false, the accelerator can be deleted. + // default value is true. + // + // If the value is set to true, the accelerator cannot be deleted. If set to + // false, the accelerator can be deleted. Enabled *bool // The IP address type that an accelerator supports. For a standard accelerator, diff --git a/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go b/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go index 10290403937..407c2fcb23a 100644 --- a/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go +++ b/service/globalaccelerator/api_op_UpdateAcceleratorAttributes.go @@ -35,9 +35,11 @@ type UpdateAcceleratorAttributesInput struct { AcceleratorArn *string // 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) - // in the Global Accelerator Developer Guide. + // is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. + // + // For more information, see [Flow Logs] in the Global Accelerator Developer Guide. + // + // [Flow Logs]: https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if @@ -46,9 +48,12 @@ type UpdateAcceleratorAttributesInput struct { 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 - // 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 + // 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 diff --git a/service/globalaccelerator/api_op_UpdateCrossAccountAttachment.go b/service/globalaccelerator/api_op_UpdateCrossAccountAttachment.go index abe00a9baca..f9a4991abb7 100644 --- a/service/globalaccelerator/api_op_UpdateCrossAccountAttachment.go +++ b/service/globalaccelerator/api_op_UpdateCrossAccountAttachment.go @@ -14,9 +14,10 @@ import ( // Update a cross-account attachment to add or remove principals or resources. // When you update an attachment to remove a principal (account ID or accelerator) // or a resource, Global Accelerator revokes the permission for specific resources. -// For more information, see Working with cross-account attachments and resources -// in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) -// in the Global Accelerator Developer Guide. +// +// For more information, see [Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Working with cross-account attachments and resources in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html func (c *Client) UpdateCrossAccountAttachment(ctx context.Context, params *UpdateCrossAccountAttachmentInput, optFns ...func(*Options)) (*UpdateCrossAccountAttachmentOutput, error) { if params == nil { params = &UpdateCrossAccountAttachmentInput{} @@ -42,14 +43,17 @@ type UpdateCrossAccountAttachmentInput struct { // The principals to add to the cross-account attachment. A principal is an // account or the Amazon Resource Name (ARN) of an accelerator that the attachment // gives permission to work with resources from another account. The resources are - // also listed in the attachment. To add more than one principal, separate the - // account numbers or accelerator ARNs, or both, with commas. + // also listed in the attachment. + // + // To add more than one principal, separate the account numbers or accelerator + // ARNs, or both, with commas. AddPrincipals []string // The resources to add to the cross-account attachment. A resource listed in a // cross-account attachment can be used with an accelerator by the principals that - // are listed in the attachment. To add more than one resource, separate the - // resource ARNs with commas. + // are listed in the attachment. + // + // To add more than one resource, separate the resource ARNs with commas. AddResources []types.Resource // The name of the cross-account attachment. @@ -58,14 +62,17 @@ type UpdateCrossAccountAttachmentInput struct { // The principals to remove from the cross-account attachment. A principal is an // account or the Amazon Resource Name (ARN) of an accelerator that the attachment // gives permission to work with resources from another account. The resources are - // also listed in the attachment. To remove more than one principal, separate the - // account numbers or accelerator ARNs, or both, with commas. + // also listed in the attachment. + // + // To remove more than one principal, separate the account numbers or accelerator + // ARNs, or both, with commas. RemovePrincipals []string // The resources to remove from the cross-account attachment. A resource listed in // a cross-account attachment can be used with an accelerator by the principals - // that are listed in the attachment. To remove more than one resource, separate - // the resource ARNs with commas. + // that are listed in the attachment. + // + // To remove more than one resource, separate the resource ARNs with commas. RemoveResources []types.Resource noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_UpdateCustomRoutingAccelerator.go b/service/globalaccelerator/api_op_UpdateCustomRoutingAccelerator.go index 25ab3b9cb16..ae17f16e7f2 100644 --- a/service/globalaccelerator/api_op_UpdateCustomRoutingAccelerator.go +++ b/service/globalaccelerator/api_op_UpdateCustomRoutingAccelerator.go @@ -35,8 +35,10 @@ type UpdateCustomRoutingAcceleratorInput struct { AcceleratorArn *string // Indicates whether an accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, the accelerator cannot be - // deleted. If set to false, the accelerator can be deleted. + // default value is true. + // + // If the value is set to true, the accelerator cannot be deleted. If set to + // false, the accelerator can be deleted. Enabled *bool // The IP address type that an accelerator supports. For a custom routing diff --git a/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go b/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go index e02066a650f..0d93c4cfc99 100644 --- a/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go +++ b/service/globalaccelerator/api_op_UpdateCustomRoutingAcceleratorAttributes.go @@ -36,9 +36,11 @@ type UpdateCustomRoutingAcceleratorAttributesInput struct { AcceleratorArn *string // 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) - // in the Global Accelerator Developer Guide. + // is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. + // + // For more information, see [Flow logs] in the Global Accelerator Developer Guide. + // + // [Flow logs]: https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if @@ -47,10 +49,12 @@ type UpdateCustomRoutingAcceleratorAttributesInput struct { 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: + // 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 diff --git a/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go b/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go index 49b62ea280c..78a0dd91f26 100644 --- a/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go +++ b/service/globalaccelerator/api_op_UpdateCustomRoutingListener.go @@ -36,9 +36,11 @@ 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) - // . + // endpoint, the call fails. + // + // Separately, you set port ranges for endpoints. For more information, see [About endpoints for custom routing accelerators]. + // + // [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 9dee0ca0a20..bc357e7a798 100644 --- a/service/globalaccelerator/api_op_UpdateEndpointGroup.go +++ b/service/globalaccelerator/api_op_UpdateEndpointGroup.go @@ -61,8 +61,11 @@ 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) - // in the Global Accelerator Developer Guide. + // endpoints. + // + // For more information, see [Overriding listener ports] in the Global Accelerator Developer Guide. + // + // [Overriding listener ports]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html PortOverrides []types.PortOverride // The number of consecutive health checks required to set the state of a healthy @@ -71,10 +74,13 @@ type UpdateEndpointGroupInput struct { ThresholdCount *int32 // The percentage of traffic to send to an Amazon Web Services Region. Additional - // traffic is distributed to other endpoint groups for this listener. Use this - // action to increase (dial up) or decrease (dial down) traffic to a specific - // Region. The percentage is applied to the traffic that would otherwise have been - // routed to the Region based on optimal routing. The default value is 100. + // traffic is distributed to other endpoint groups for this listener. + // + // Use this action to increase (dial up) or decrease (dial down) traffic to a + // specific Region. The percentage is applied to the traffic that would otherwise + // have been routed to the Region based on optimal routing. + // + // The default value is 100. TrafficDialPercentage *float32 noSmithyDocumentSerde diff --git a/service/globalaccelerator/api_op_UpdateListener.go b/service/globalaccelerator/api_op_UpdateListener.go index f56a1b12058..324b865a4e9 100644 --- a/service/globalaccelerator/api_op_UpdateListener.go +++ b/service/globalaccelerator/api_op_UpdateListener.go @@ -37,18 +37,22 @@ type UpdateListenerInput struct { // Client affinity lets you direct all requests from a user to the same endpoint, // if you have stateful applications, regardless of the port and protocol of the // 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 . + // 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 . 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 3f451f40441..ff0cecbfee5 100644 --- a/service/globalaccelerator/api_op_WithdrawByoipCidr.go +++ b/service/globalaccelerator/api_op_WithdrawByoipCidr.go @@ -13,11 +13,14 @@ import ( // Stops advertising an address range that is provisioned as an address pool. You // can perform this operation at most once every 10 seconds, even if you specify -// 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. +// 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)] in the Global Accelerator Developer Guide. +// +// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html func (c *Client) WithdrawByoipCidr(ctx context.Context, params *WithdrawByoipCidrInput, optFns ...func(*Options)) (*WithdrawByoipCidrOutput, error) { if params == nil { params = &WithdrawByoipCidrInput{} @@ -35,9 +38,11 @@ func (c *Client) WithdrawByoipCidr(ctx context.Context, params *WithdrawByoipCid type WithdrawByoipCidrInput struct { - // The address range, in CIDR notation. 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. + // The address range, in CIDR notation. + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html // // This member is required. Cidr *string diff --git a/service/globalaccelerator/doc.go b/service/globalaccelerator/doc.go index c9c0432ccbe..11e0107fcc2 100644 --- a/service/globalaccelerator/doc.go +++ b/service/globalaccelerator/doc.go @@ -3,17 +3,21 @@ // Package globalaccelerator provides the API client, operations, and parameter // types for AWS Global Accelerator. // -// 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. +// # 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]. +// +// 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. @@ -21,15 +25,17 @@ // 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 Amazon Web Services 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 +// specify --region us-west-2 on Amazon Web Services 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 to Global 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 @@ -38,19 +44,24 @@ // 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 +// 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 +// For more information, see [Tag-based policies]. +// +// 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) -// . +// from clients is always directed to healthy endpoints. +// +// For more information about understanding and using Global Accelerator, see the [Global Accelerator Developer Guide]. +// +// [Tag-based policies]: https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html +// [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/options.go b/service/globalaccelerator/options.go index 06c47c2a1c4..91db69dad70 100644 --- a/service/globalaccelerator/options.go +++ b/service/globalaccelerator/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/globalaccelerator/types/enums.go b/service/globalaccelerator/types/enums.go index c064716d986..693393c643a 100644 --- a/service/globalaccelerator/types/enums.go +++ b/service/globalaccelerator/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AcceleratorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceleratorStatus) Values() []AcceleratorStatus { return []AcceleratorStatus{ "DEPLOYED", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for ByoipCidrState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ByoipCidrState) Values() []ByoipCidrState { return []ByoipCidrState{ "PENDING_PROVISIONING", @@ -65,8 +67,9 @@ const ( ) // Values returns all known values for ClientAffinity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientAffinity) Values() []ClientAffinity { return []ClientAffinity{ "NONE", @@ -84,8 +87,9 @@ const ( // Values returns all known values for CustomRoutingAcceleratorStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomRoutingAcceleratorStatus) Values() []CustomRoutingAcceleratorStatus { return []CustomRoutingAcceleratorStatus{ "DEPLOYED", @@ -103,8 +107,9 @@ const ( // Values returns all known values for CustomRoutingDestinationTrafficState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomRoutingDestinationTrafficState) Values() []CustomRoutingDestinationTrafficState { return []CustomRoutingDestinationTrafficState{ "ALLOW", @@ -121,8 +126,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TCP", @@ -140,8 +146,9 @@ const ( ) // Values returns all known values for HealthCheckProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthCheckProtocol) Values() []HealthCheckProtocol { return []HealthCheckProtocol{ "TCP", @@ -160,8 +167,9 @@ const ( ) // Values returns all known values for HealthState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthState) Values() []HealthState { return []HealthState{ "INITIAL", @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for IpAddressFamily. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressFamily) Values() []IpAddressFamily { return []IpAddressFamily{ "IPv4", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for IpAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressType) Values() []IpAddressType { return []IpAddressType{ "IPV4", @@ -215,8 +225,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "TCP", diff --git a/service/globalaccelerator/types/types.go b/service/globalaccelerator/types/types.go index 22350587e4d..ce944d8fe83 100644 --- a/service/globalaccelerator/types/types.go +++ b/service/globalaccelerator/types/types.go @@ -19,32 +19,46 @@ type Accelerator struct { 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: - // a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack - // 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) - // in the Global Accelerator Developer Guide. + // 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 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] in the Global Accelerator + // Developer Guide. + // + // [Support for DNS addressing in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html 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 - // 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) - // in the Global Accelerator Developer Guide. + // 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] in the Global Accelerator Developer Guide. + // + // [Support for DNS addressing in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing DualStackDnsName *string // Indicates whether the accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, the accelerator cannot be - // deleted. If set to false, accelerator can be deleted. + // default value is true. + // + // If the value is set to true, the accelerator cannot be deleted. If set to + // false, accelerator can be deleted. Enabled *bool // A history of changes that you make to an accelerator in Global Accelerator. @@ -74,9 +88,11 @@ 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) - // in the Global Accelerator Developer Guide. + // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. + // + // For more information, see [Flow logs] in the Global Accelerator Developer Guide. + // + // [Flow logs]: https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if @@ -85,9 +101,12 @@ type AcceleratorAttributes struct { 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 + // 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 @@ -139,42 +158,56 @@ type Attachment 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. +// 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. type ByoipCidr struct { - // The address range, in CIDR notation. 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. + // The address range, in CIDR notation. + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html Cidr *string // A history of status changes for an IP address range that you bring to Global @@ -206,8 +239,10 @@ 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)] in the Global Accelerator Developer Guide. +// +// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html type CidrAuthorizationContext struct { // The plain-text authorization message for the prefix and account. @@ -226,9 +261,11 @@ type CidrAuthorizationContext struct { // An endpoint (Amazon Web Services resource) or an IP address range, in CIDR // format, that is listed in a cross-account attachment. A cross-account resource // can be added to an accelerator by specified principals, which are also listed in -// the attachment. For more information, see Working with cross-account -// attachments and resources in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html) -// in the Global Accelerator Developer Guide. +// the attachment. +// +// For more information, see [Working with cross-account attachments and resources in Global Accelerator] in the Global Accelerator Developer Guide. +// +// [Working with cross-account attachments and resources in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/cross-account-resources.html type CrossAccountResource struct { // The Amazon Resource Name (ARN) of the cross-account attachment that specifies @@ -239,9 +276,11 @@ type CrossAccountResource struct { // An IP address range, in CIDR format, that is specified as an Amazon Web // Services resource. The address must be provisioned and advertised in Global // Accelerator by following the bring your own IP address (BYOIP) process for - // Global Accelerator. 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. + // Global Accelerator. + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html Cidr *string // The endpoint ID for the endpoint that is listed in a cross-account attachment @@ -261,20 +300,28 @@ type CustomRoutingAccelerator struct { 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: - // a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack - // 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) - // in the Global Accelerator Developer Guide. + // 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 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] in the Global Accelerator + // Developer Guide. + // + // [Support for DNS addressing in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html DnsName *string // Indicates whether the accelerator is enabled. The value is true or false. The - // default value is true. If the value is set to true, the accelerator cannot be - // deleted. If set to false, accelerator can be deleted. + // default value is true. + // + // If the value is set to true, the accelerator cannot be deleted. If set to + // false, accelerator can be deleted. Enabled *bool // The IP address type that an accelerator supports. For a custom routing @@ -301,9 +348,11 @@ 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) - // in the Global Accelerator Developer Guide. + // value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified. + // + // For more information, see [Flow logs] in the Global Accelerator Developer Guide. + // + // [Flow logs]: https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html FlowLogsEnabled *bool // The name of the Amazon S3 bucket for the flow logs. Attribute is required if @@ -312,10 +361,12 @@ type CustomRoutingAcceleratorAttributes struct { 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: + // 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 @@ -426,9 +477,10 @@ type CustomRoutingListener struct { ListenerArn *string // 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) - // . + // + // Separately, you set port ranges for endpoints. For more information, see [About endpoints for custom routing accelerators]. + // + // [About endpoints for custom routing accelerators]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html PortRanges []PortRange noSmithyDocumentSerde @@ -481,23 +533,30 @@ 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 Application Load - // Balancer endpoints. 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, Amazon EC2 instances, and Network - // Load Balancers with security groups. IMPORTANT: You cannot use client IP address - // preservation with Network Load Balancers with TLS listeners. 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) - // in the Global Accelerator Developer Guide. + // Balancer endpoints. + // + // 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, Amazon EC2 + // instances, and Network Load Balancers with security groups. IMPORTANT: You + // cannot use client IP address preservation with Network Load Balancers with TLS + // listeners. + // + // For more information, see [Preserve client IP addresses in Global Accelerator] in the Global Accelerator Developer Guide. + // + // [Preserve client IP addresses in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html ClientIPPreservationEnabled *bool // An ID for the endpoint. If the endpoint is a Network Load Balancer or // Application Load Balancer, this is the Amazon Resource Name (ARN) of the // resource. If the endpoint is an Elastic IP address, this is the Elastic IP // address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A - // resource must be valid and active when you add it as an endpoint. For - // cross-account endpoints, this must be the ARN of the resource. + // resource must be valid and active when you add it as an endpoint. + // + // For cross-account endpoints, this must be the ARN of the resource. EndpointId *string // The weight associated with the endpoint. When you add weights to endpoints, you @@ -505,8 +564,10 @@ 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) - // in the Global Accelerator Developer Guide. + // is routed to the last endpoint. For more information, see [Endpoint weights]in the Global + // Accelerator Developer Guide. + // + // [Endpoint weights]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html Weight *int32 noSmithyDocumentSerde @@ -518,22 +579,29 @@ 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 Application Load - // Balancers endpoints. 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, Amazon EC2 instances, and Network - // Load Balancers with security groups. IMPORTANT: You cannot use client IP address - // preservation with Network Load Balancers with TLS listeners. 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) - // in the Global Accelerator Developer Guide. + // Balancers endpoints. + // + // 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, Amazon EC2 + // instances, and Network Load Balancers with security groups. IMPORTANT: You + // cannot use client IP address preservation with Network Load Balancers with TLS + // listeners. + // + // For more information, see [Preserve client IP addresses in Global Accelerator] in the Global Accelerator Developer Guide. + // + // [Preserve client IP addresses in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html ClientIPPreservationEnabled *bool // An ID for the endpoint. If the endpoint is a Network Load Balancer or // Application Load Balancer, this is the Amazon Resource Name (ARN) of the // resource. If the endpoint is an Elastic IP address, this is the Elastic IP - // address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. An - // Application Load Balancer can be either internal or internet-facing. + // address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. + // + // An Application Load Balancer can be either internal or internet-facing. EndpointId *string // Returns a null result. @@ -547,8 +615,10 @@ 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) - // in the Global Accelerator Developer Guide. + // is routed to the last endpoint. For more information, see [Endpoint weights]in the Global + // Accelerator Developer Guide. + // + // [Endpoint weights]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html Weight *int32 noSmithyDocumentSerde @@ -577,9 +647,11 @@ type EndpointGroup struct { 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. + // 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 @@ -598,10 +670,13 @@ type EndpointGroup struct { ThresholdCount *int32 // The percentage of traffic to send to an Amazon Web Services Region. Additional - // traffic is distributed to other endpoint groups for this listener. Use this - // action to increase (dial up) or decrease (dial down) traffic to a specific - // Region. The percentage is applied to the traffic that would otherwise have been - // routed to the Region based on optimal routing. The default value is 100. + // traffic is distributed to other endpoint groups for this listener. + // + // Use this action to increase (dial up) or decrease (dial down) traffic to a + // specific Region. The percentage is applied to the traffic that would otherwise + // have been routed to the Region based on optimal routing. + // + // The default value is 100. TrafficDialPercentage *float32 noSmithyDocumentSerde @@ -614,16 +689,19 @@ type EndpointIdentifier struct { // An ID for the endpoint. If the endpoint is a Network Load Balancer or // Application Load Balancer, this is the Amazon Resource Name (ARN) of the // resource. If the endpoint is an Elastic IP address, this is the Elastic IP - // address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. An - // Application Load Balancer can be either internal or internet-facing. + // address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. + // + // An Application Load Balancer can be either internal or internet-facing. // // 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 - // applications on the endpoint fronted by the accelerator. + // 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 noSmithyDocumentSerde @@ -653,18 +731,22 @@ type Listener struct { // Client affinity lets you direct all requests from a user to the same endpoint, // if you have stateful applications, regardless of the port and protocol of the // 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 . + // 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 . ClientAffinity ClientAffinity // The Amazon Resource Name (ARN) of the listener. @@ -713,9 +795,11 @@ type PortMapping struct { // Override specific listener ports used to route traffic to endpoints that are // 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) -// in the Global Accelerator Developer Guide. +// routes that traffic to ports 1080 and 1443, respectively, on the endpoints. +// +// For more information, see [Overriding listener ports] in the Global Accelerator Developer Guide. +// +// [Overriding listener ports]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html type PortOverride struct { // The endpoint port that you want a listener port to be mapped to. This is the @@ -749,14 +833,18 @@ type Resource struct { // An IP address range, in CIDR format, that is specified as resource. The address // must be provisioned and advertised in Global Accelerator by following the bring - // your own IP address (BYOIP) process for Global Accelerator 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. + // your own IP address (BYOIP) process for Global Accelerator + // + // For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide. + // + // [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html Cidr *string // The endpoint ID for the endpoint that is specified as a Amazon Web Services - // resource. An endpoint ID for the cross-account feature is the ARN of an Amazon - // Web Services resource, such as a Network Load Balancer, that Global Accelerator + // resource. + // + // An endpoint ID for the cross-account feature is the ARN of an Amazon Web + // Services resource, such as a Network Load Balancer, that Global Accelerator // supports as an endpoint for an accelerator. EndpointId *string diff --git a/service/glue/api_op_BatchDeleteTable.go b/service/glue/api_op_BatchDeleteTable.go index f57b590b1ce..e6603b079c4 100644 --- a/service/glue/api_op_BatchDeleteTable.go +++ b/service/glue/api_op_BatchDeleteTable.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes multiple tables at once. After completing this 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 BatchDeleteTable , use DeleteTableVersion -// or BatchDeleteTableVersion , and DeletePartition or BatchDeletePartition , to -// delete any resources that belong to the table. +// Deletes multiple tables at once. +// +// After completing this 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 +// 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 { params = &BatchDeleteTableInput{} diff --git a/service/glue/api_op_CreateConnection.go b/service/glue/api_op_CreateConnection.go index 32300dfb3ce..d3000e63be2 100644 --- a/service/glue/api_op_CreateConnection.go +++ b/service/glue/api_op_CreateConnection.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a connection definition in the Data Catalog. Connections used for -// creating federated resources require the IAM glue:PassConnection permission. +// Creates a connection definition in the Data Catalog. +// +// Connections used for creating federated resources require the IAM +// glue:PassConnection permission. func (c *Client) CreateConnection(ctx context.Context, params *CreateConnectionInput, optFns ...func(*Options)) (*CreateConnectionOutput, error) { if params == nil { params = &CreateConnectionInput{} diff --git a/service/glue/api_op_CreateCrawler.go b/service/glue/api_op_CreateCrawler.go index dfa48adedc1..8b949bcdaf7 100644 --- a/service/glue/api_op_CreateCrawler.go +++ b/service/glue/api_op_CreateCrawler.go @@ -53,9 +53,9 @@ type CreateCrawlerInput struct { Classifiers []string // 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) - // . + // specify aspects of a crawler's behavior. For more information, see [Setting crawler configuration options]. + // + // [Setting 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. @@ -78,10 +78,10 @@ type CreateCrawlerInput struct { // only folders that were added since the last crawler run. 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 * * ? *) . + // A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. For example, to run + // something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) . + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html Schedule *string // The policy for the crawler's update and deletion behavior. @@ -91,9 +91,10 @@ type CreateCrawlerInput struct { TablePrefix *string // The tags to use with this crawler request. You may use tags to limit access to - // the crawler. 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. + // the crawler. For more information about tags in Glue, see [Amazon Web Services Tags in Glue]in the developer + // guide. + // + // [Amazon Web Services Tags in Glue]: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/glue/api_op_CreateCustomEntityType.go b/service/glue/api_op_CreateCustomEntityType.go index a439a3e47b1..30beb38dbdb 100644 --- a/service/glue/api_op_CreateCustomEntityType.go +++ b/service/glue/api_op_CreateCustomEntityType.go @@ -11,9 +11,11 @@ import ( ) // Creates a custom pattern that is used to detect sensitive data across the -// columns and rows of your structured data. Each custom pattern you create -// specifies a regular expression and an optional list of context words. If no -// context words are passed only a regular expression is checked. +// columns and rows of your structured data. +// +// Each custom pattern you create specifies a regular expression and an optional +// list of context words. If no context words are passed only a regular expression +// is checked. func (c *Client) CreateCustomEntityType(ctx context.Context, params *CreateCustomEntityTypeInput, optFns ...func(*Options)) (*CreateCustomEntityTypeOutput, error) { if params == nil { params = &CreateCustomEntityTypeInput{} @@ -45,7 +47,9 @@ type CreateCustomEntityTypeInput struct { // A list of context words. If none of these context words are found within the // vicinity of the regular expression the data will not be detected as sensitive - // data. If no context words are passed only a regular expression is checked. + // data. + // + // If no context words are passed only a regular expression is checked. ContextWords []string // A list of tags applied to the custom entity type. diff --git a/service/glue/api_op_CreateDataQualityRuleset.go b/service/glue/api_op_CreateDataQualityRuleset.go index 20baff136cc..1b889d486cb 100644 --- a/service/glue/api_op_CreateDataQualityRuleset.go +++ b/service/glue/api_op_CreateDataQualityRuleset.go @@ -12,8 +12,10 @@ import ( ) // Creates a data quality ruleset with DQDL rules applied to a specified Glue -// table. You create the ruleset using the Data Quality Definition Language (DQDL). -// For more information, see the Glue developer guide. +// table. +// +// You create the ruleset using the Data Quality Definition Language (DQDL). For +// more information, see the Glue developer guide. func (c *Client) CreateDataQualityRuleset(ctx context.Context, params *CreateDataQualityRulesetInput, optFns ...func(*Options)) (*CreateDataQualityRulesetOutput, error) { if params == nil { params = &CreateDataQualityRulesetInput{} diff --git a/service/glue/api_op_CreateDevEndpoint.go b/service/glue/api_op_CreateDevEndpoint.go index 0240eca6e5b..ac83786e7c1 100644 --- a/service/glue/api_op_CreateDevEndpoint.go +++ b/service/glue/api_op_CreateDevEndpoint.go @@ -49,28 +49,40 @@ type CreateDevEndpointInput struct { // 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. + // a comma. + // + // You can only use pure Python libraries with a DevEndpoint . Libraries that rely + // on C extensions, such as the [pandas]Python data analysis library, are not yet + // supported. + // + // [pandas]: http://pandas.pydata.org/ 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. + // ETL scripts on development endpoints. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]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 version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // 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 . + // development endpoint. + // + // The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X + // . NumberOfWorkers *int32 // The public key to be used by this DevEndpoint for authentication. This @@ -80,11 +92,12 @@ type CreateDevEndpointInput struct { // 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. + // 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. PublicKeys []string // The name of the SecurityConfiguration structure to be used with this DevEndpoint @@ -98,21 +111,26 @@ type CreateDevEndpointInput struct { SubnetId *string // The tags to use with this DevEndpoint. You may use tags to limit access to the - // DevEndpoint. 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. + // DevEndpoint. For more information about tags in Glue, see [Amazon Web Services Tags in Glue]in the developer + // guide. + // + // [Amazon Web Services Tags in Glue]: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html Tags map[string]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.2X WorkerType // configuration, the Spark drivers for the development endpoint will run on 4 // vCPU, 16 GB of memory, and a 64 GB disk. @@ -123,8 +141,12 @@ type CreateDevEndpointInput struct { type CreateDevEndpointOutput struct { - // The map of arguments used to configure this DevEndpoint . Valid arguments are: + // 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. @@ -152,9 +174,12 @@ type CreateDevEndpointOutput struct { // 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. + // ETL scripts on development endpoints. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]in the developer guide. + // + // [Glue version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint. diff --git a/service/glue/api_op_CreateJob.go b/service/glue/api_op_CreateJob.go index 18c7111a80a..94be69b145d 100644 --- a/service/glue/api_op_CreateJob.go +++ b/service/glue/api_op_CreateJob.go @@ -44,11 +44,14 @@ type CreateJobInput struct { // This member is required. Role *string - // This parameter is deprecated. Use MaxCapacity instead. The number of Glue data - // 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/) . + // This parameter is deprecated. Use MaxCapacity instead. + // + // The number of Glue data 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]. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -61,19 +64,26 @@ type CreateJobInput struct { Connections *types.ConnectionsList // The default arguments for every run of 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. 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 arguments you can - // provide to this field when configuring Spark jobs, 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. For information about the arguments you can - // provide to this field when configuring Ray jobs, see Using job parameters in - // Ray jobs (https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) - // in the developer guide. + // 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]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Spark jobs, see the [Special Parameters Used by Glue]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Ray jobs, see [Using job parameters in Ray jobs]in the developer guide. + // + // [Using job parameters in Ray jobs]: https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html + // [Calling Glue APIs in Python]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html + // [Special Parameters Used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html DefaultArguments map[string]string // Description of the job being defined. @@ -81,8 +91,11 @@ type CreateJobInput struct { // Indicates whether the job is run with a standard or flexible execution class. // The standard execution-class is ideal for time-sensitive workloads that require - // fast job startup and dedicated resources. The flexible execution class is - // appropriate for time-insensitive jobs whose start and completion times may vary. + // 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. @@ -94,13 +107,18 @@ type CreateJobInput struct { // In Spark jobs, GlueVersion determines the versions of Apache Spark and Python // that Glue available in a job. The Python version indicates the version supported - // for jobs of type Spark. Ray jobs should set GlueVersion to 4.0 or greater. - // However, the versions of Ray, Python and additional libraries available in your - // Ray job are determined by the Runtime parameter of the Job command. 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. + // for jobs of type Spark. + // + // Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of + // Ray, Python and additional libraries available in your Ray job are determined by + // the Runtime parameter of the Job command. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]in the developer guide. + // + // Jobs that are created without specifying a Glue version default to Glue 0.9. + // + // [Glue version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // This field is reserved for future use. @@ -109,19 +127,26 @@ type CreateJobInput struct { // 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/) . For Glue version 2.0+ - // jobs, you cannot specify a Maximum capacity . Instead, you should specify a - // Worker type and the Number of workers . Do not set MaxCapacity 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: + // of compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // For Glue version 2.0+ jobs, you cannot specify a Maximum capacity . Instead, you + // should specify a Worker type and the Number of workers . + // + // Do not set MaxCapacity 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. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry this job if it fails. @@ -146,8 +171,9 @@ 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]in the developer guide. + // + // [Amazon Web Services Tags in Glue]: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html Tags map[string]string // The job timeout in minutes. This is the maximum time that a job run can consume @@ -158,16 +184,19 @@ type CreateJobInput struct { // The type of predefined worker that is allocated when a job runs. Accepts a // value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X // for Ray jobs. + // // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of // memory) with 84GB disk (approximately 34GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of // memory) with 128GB disk (approximately 77GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of // memory) with 256GB disk (approximately 235GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most @@ -176,16 +205,19 @@ type CreateJobInput struct { // Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West // (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), // Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). + // // - For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of // memory) with 512GB disk (approximately 487GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most // demanding transforms, aggregations, joins, and queries. This worker type is // available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon // Web Services Regions as supported for the G.4X worker type. + // // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of // memory) with 84GB disk (approximately 34GB free), 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 Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of // memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray // workers based on the autoscaler. diff --git a/service/glue/api_op_CreateMLTransform.go b/service/glue/api_op_CreateMLTransform.go index 397b6d68b18..b6d8ee50b14 100644 --- a/service/glue/api_op_CreateMLTransform.go +++ b/service/glue/api_op_CreateMLTransform.go @@ -12,15 +12,19 @@ import ( ) // 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 -// 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) -// . +// 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 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]. +// +// [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,13 +61,16 @@ 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) - // . + // in Glue. See [Attach a Policy to IAM Users That Access Glue]. + // // - 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. // + // [Attach a Policy to IAM Users That Access Glue]: https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html + // // This member is required. Role *string @@ -73,26 +80,35 @@ 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) - // in the developer guide. + // set, the Glue compatibility defaults to Glue 0.9. For more information, see [Glue Versions]in + // the developer guide. + // + // [Glue Versions]: https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions 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 . + // compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // 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. When the - // WorkerType field is set to a value other than Standard , the MaxCapacity field - // is set automatically and becomes read-only. + // MaxCapacity field is set automatically and becomes read-only. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry a task for this transform after a task run @@ -100,13 +116,16 @@ type CreateMLTransformInput struct { MaxRetries *int32 // The number of workers of a defined workerType that are allocated when this task - // runs. If WorkerType is set, then NumberOfWorkers is required (and vice versa). + // runs. + // + // If WorkerType is set, then NumberOfWorkers is required (and vice versa). NumberOfWorkers *int32 // 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]in the developer guide. + // + // [Amazon Web Services Tags in Glue]: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html Tags map[string]string // The timeout of the task run for this transform in minutes. This is the maximum @@ -121,17 +140,25 @@ 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. WorkerType types.WorkerType diff --git a/service/glue/api_op_CreateSchema.go b/service/glue/api_op_CreateSchema.go index 91a8293816b..768cf7923bc 100644 --- a/service/glue/api_op_CreateSchema.go +++ b/service/glue/api_op_CreateSchema.go @@ -12,14 +12,17 @@ import ( ) // Creates a new schema set and registers the schema definition. Returns an error -// if the schema set already exists without actually registering the version. When -// the schema set is created, a version checkpoint will be set to the first +// if the schema set already exists without actually registering the version. +// +// When the schema set is created, a version checkpoint will be set to the first // version. Compatibility mode "DISABLED" restricts any additional schema versions // 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" -// in the registry database tables, if it is not already present. +// 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" 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 { params = &CreateSchemaInput{} @@ -50,34 +53,42 @@ 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 @@ -88,9 +99,9 @@ type CreateSchemaInput struct { // will not be any automatic default value for this. Description *string - // 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 . + // 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 . RegistryId *types.RegistryId // The schema definition using the DataFormat setting for SchemaName . diff --git a/service/glue/api_op_CreateSecurityConfiguration.go b/service/glue/api_op_CreateSecurityConfiguration.go index 002540b8ec8..f6d8363a2f1 100644 --- a/service/glue/api_op_CreateSecurityConfiguration.go +++ b/service/glue/api_op_CreateSecurityConfiguration.go @@ -15,9 +15,9 @@ import ( // Creates a new security configuration. A security configuration is a set of // 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) -// . +// configurations in Glue, see [Encrypting Data Written by Crawlers, Jobs, and Development Endpoints]. +// +// [Encrypting Data Written by Crawlers, Jobs, and 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 9e9397253c4..eaedb2ee461 100644 --- a/service/glue/api_op_CreateSession.go +++ b/service/glue/api_op_CreateSession.go @@ -58,8 +58,8 @@ type CreateSessionInput struct { // supports. The GlueVersion must be greater than 2.0. GlueVersion *string - // The number of minutes when idle before session times out. Default for Spark ETL - // jobs is value of Timeout. Consult the documentation for other job types. + // The number of minutes when idle before session times out. Default for Spark + // ETL jobs is value of Timeout. Consult the documentation for other job types. IdleTimeout *int32 // The number of Glue data processing units (DPUs) that can be allocated when the @@ -79,7 +79,7 @@ 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 + // 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 @@ -87,16 +87,19 @@ type CreateSessionInput struct { // The type of predefined worker that is allocated when a job runs. Accepts a // value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for // Ray notebooks. + // // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of // memory) with 84GB disk (approximately 34GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of // memory) with 128GB disk (approximately 77GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of // memory) with 256GB disk (approximately 235GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most @@ -105,12 +108,14 @@ type CreateSessionInput struct { // Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West // (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), // Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). + // // - For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of // memory) with 512GB disk (approximately 487GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most // demanding transforms, aggregations, joins, and queries. This worker type is // available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon // Web Services Regions as supported for the G.4X worker type. + // // - For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of // memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray // workers based on the autoscaler. diff --git a/service/glue/api_op_CreateTrigger.go b/service/glue/api_op_CreateTrigger.go index efed104b3b7..2e985f85387 100644 --- a/service/glue/api_op_CreateTrigger.go +++ b/service/glue/api_op_CreateTrigger.go @@ -51,14 +51,17 @@ type CreateTriggerInput struct { // time window expired) before EventBridge event trigger fires. EventBatchingCondition *types.EventBatchingCondition - // A predicate to specify when the new trigger should fire. This field is required - // when the trigger type is CONDITIONAL . + // A predicate to specify when the new trigger should fire. + // + // This field is required 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. + // A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. 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. + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html Schedule *string // Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is @@ -66,9 +69,9 @@ type CreateTriggerInput struct { StartOnCreation bool // The tags to use with this trigger. You may use tags to limit access to the - // trigger. 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. + // trigger. For more information about tags in Glue, see [Amazon Web Services Tags in Glue]in the developer guide. + // + // [Amazon Web Services Tags in Glue]: https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html Tags map[string]string // The name of the workflow associated with the trigger. diff --git a/service/glue/api_op_DeleteColumnStatisticsForPartition.go b/service/glue/api_op_DeleteColumnStatisticsForPartition.go index 7b091e0a7fb..8e180a1ccc6 100644 --- a/service/glue/api_op_DeleteColumnStatisticsForPartition.go +++ b/service/glue/api_op_DeleteColumnStatisticsForPartition.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete the partition column statistics of a column. The Identity and Access -// Management (IAM) permission required for this operation is DeletePartition . +// Delete the partition column statistics of a column. +// +// The Identity and Access 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 ef697274fa9..b89d2b86fd3 100644 --- a/service/glue/api_op_DeleteColumnStatisticsForTable.go +++ b/service/glue/api_op_DeleteColumnStatisticsForTable.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves table statistics of columns. The Identity and Access Management (IAM) -// permission required for this operation is DeleteTable . +// Retrieves table statistics of columns. +// +// The Identity and Access Management (IAM) 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_DeleteDatabase.go b/service/glue/api_op_DeleteDatabase.go index c427e6b73a0..7812c171e07 100644 --- a/service/glue/api_op_DeleteDatabase.go +++ b/service/glue/api_op_DeleteDatabase.go @@ -10,15 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a specified database from a Data Catalog. After completing this -// operation, you no longer have access to the tables (and all table versions and -// 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. +// Removes a specified database from a Data Catalog. +// +// After completing this operation, you no longer have access to the tables (and +// all table versions and 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. 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_DeleteSchemaVersions.go b/service/glue/api_op_DeleteSchemaVersions.go index ee9f8c2e988..55b1bd3862f 100644 --- a/service/glue/api_op_DeleteSchemaVersions.go +++ b/service/glue/api_op_DeleteSchemaVersions.go @@ -15,15 +15,20 @@ import ( // supplied. If the compatibility mode forbids deleting of a version that is // necessary, such as BACKWARDS_FULL, an error is returned. Calling the // 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 +// 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 // 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. +// on the database. +// +// If the compatibility mode forbids deleting of a version that is necessary, such +// as BACKWARDS_FULL, an error is returned. func (c *Client) DeleteSchemaVersions(ctx context.Context, params *DeleteSchemaVersionsInput, optFns ...func(*Options)) (*DeleteSchemaVersionsOutput, error) { if params == nil { params = &DeleteSchemaVersionsInput{} @@ -48,7 +53,9 @@ type DeleteSchemaVersionsInput struct { 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 // // This member is required. diff --git a/service/glue/api_op_DeleteTable.go b/service/glue/api_op_DeleteTable.go index ff2288f61c7..653cd4a04fd 100644 --- a/service/glue/api_op_DeleteTable.go +++ b/service/glue/api_op_DeleteTable.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a table definition from the Data Catalog. After completing this -// 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. +// Removes a table definition from the Data Catalog. +// +// After completing this 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. 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 8172785d5ae..1293431084e 100644 --- a/service/glue/api_op_GetColumnStatisticsForPartition.go +++ b/service/glue/api_op_GetColumnStatisticsForPartition.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves partition statistics of columns. The Identity and Access Management -// (IAM) permission required for this operation is GetPartition . +// Retrieves partition statistics of columns. +// +// The Identity and Access Management (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 ceb1acb0895..ae7287bb436 100644 --- a/service/glue/api_op_GetColumnStatisticsForTable.go +++ b/service/glue/api_op_GetColumnStatisticsForTable.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves table statistics of columns. The Identity and Access Management (IAM) -// permission required for this operation is GetTable . +// Retrieves table statistics of columns. +// +// The Identity and Access Management (IAM) 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_GetDatabases.go b/service/glue/api_op_GetDatabases.go index 21f2b5210c8..88f0f22c5e0 100644 --- a/service/glue/api_op_GetDatabases.go +++ b/service/glue/api_op_GetDatabases.go @@ -41,9 +41,12 @@ type GetDatabasesInput struct { // 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. ResourceShareType types.ResourceShareType diff --git a/service/glue/api_op_GetDevEndpoint.go b/service/glue/api_op_GetDevEndpoint.go index 42b79d194dc..74e7ac024bd 100644 --- a/service/glue/api_op_GetDevEndpoint.go +++ b/service/glue/api_op_GetDevEndpoint.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a specified development endpoint. When you create a -// development endpoint in a virtual private cloud (VPC), Glue returns only a -// private IP address, and the public IP address field is not populated. When you -// create a non-VPC development endpoint, Glue returns only a public IP address. +// Retrieves information about a specified development endpoint. +// +// When you create a development endpoint in a virtual private cloud (VPC), Glue +// returns only a private IP address, and the public IP address field is not +// populated. When you create a non-VPC development endpoint, Glue returns only a +// public IP address. func (c *Client) GetDevEndpoint(ctx context.Context, params *GetDevEndpointInput, optFns ...func(*Options)) (*GetDevEndpointOutput, error) { if params == nil { params = &GetDevEndpointInput{} diff --git a/service/glue/api_op_GetDevEndpoints.go b/service/glue/api_op_GetDevEndpoints.go index 4a1ed37d3c9..0cb5ab6a284 100644 --- a/service/glue/api_op_GetDevEndpoints.go +++ b/service/glue/api_op_GetDevEndpoints.go @@ -12,6 +12,7 @@ import ( ) // Retrieves all the development endpoints in this Amazon Web Services account. +// // When you create a development endpoint in a virtual private cloud (VPC), Glue // returns only a private IP address and the public IP address field is not // populated. When you create a non-VPC development endpoint, Glue returns only a diff --git a/service/glue/api_op_GetJobBookmark.go b/service/glue/api_op_GetJobBookmark.go index d157dfb3432..9357b09f9fd 100644 --- a/service/glue/api_op_GetJobBookmark.go +++ b/service/glue/api_op_GetJobBookmark.go @@ -11,11 +11,19 @@ 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] +// +// [Job parameters used by Glue] +// +// [Job structure] +// +// [Job parameters used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html +// [Tracking processed data using job bookmarks]: https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.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_GetMLTaskRuns.go b/service/glue/api_op_GetMLTaskRuns.go index f77e7f312cc..5f1416067f8 100644 --- a/service/glue/api_op_GetMLTaskRuns.go +++ b/service/glue/api_op_GetMLTaskRuns.go @@ -15,8 +15,9 @@ import ( // 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. +// 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 64f558951b9..a6c2e38e1b9 100644 --- a/service/glue/api_op_GetMLTransform.go +++ b/service/glue/api_op_GetMLTransform.go @@ -56,9 +56,10 @@ 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) - // in the developer guide. + // set, the Glue compatibility defaults to Glue 0.9. For more information, see [Glue Versions]in + // the developer guide. + // + // [Glue Versions]: https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions GlueVersion *string // A list of Glue table definitions used by the transform. @@ -73,10 +74,12 @@ 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]. + // + // When the WorkerType field is set to a value other than Standard , the + // MaxCapacity field is set automatically and becomes read-only. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry a task for this transform after a task run @@ -121,10 +124,13 @@ type GetMLTransformOutput 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. WorkerType types.WorkerType diff --git a/service/glue/api_op_GetPartitions.go b/service/glue/api_op_GetPartitions.go index 7b9dcbe9102..7fe9662d4b9 100644 --- a/service/glue/api_op_GetPartitions.go +++ b/service/glue/api_op_GetPartitions.go @@ -50,38 +50,77 @@ type GetPartitionsInput struct { // duplicate data. ExcludeColumnSchema *bool - // An expression that filters the partitions to be returned. The expression uses - // SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser - // JSQLParser (http://jsqlparser.sourceforge.net/home.php) parses the expression. + // An expression that filters the partitions to be returned. + // + // The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL + // statement parser [JSQLParser]parses the expression. + // // Operators: The following are the operators that you can use in the Expression - // API call: = Checks whether the values of the two operands are equal; if yes, - // then the condition becomes true. Example: Assume 'variable a' holds 10 and - // 'variable b' holds 20. (a = b) is not true. < > Checks whether the values of two - // operands are equal; if the values are not equal, then the condition becomes - // true. Example: (a < > b) is true. > Checks whether the value of the left operand - // is greater than the value of the right operand; if yes, then the condition - // becomes true. Example: (a > b) is not true. < Checks whether the value of the - // left operand is less than the value of the right operand; if yes, then the - // condition becomes true. Example: (a < b) is true. >= Checks whether the value of - // the left operand is greater than or equal to the value of the right operand; if - // yes, then the condition becomes true. Example: (a >= b) is not true. <= Checks - // whether the value of the left operand is less than or equal to the value of the - // 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. + // API call: + // + // = Checks whether the values of the two operands are equal; if yes, then the + // condition becomes true. + // + // Example: Assume 'variable a' holds 10 and 'variable b' holds 20. + // + // (a = b) is not true. + // + // < > Checks whether the values of two operands are equal; if the values are not + // equal, then the condition becomes true. + // + // Example: (a < > b) is true. + // + // > Checks whether the value of the left operand is greater than the value of the + // right operand; if yes, then the condition becomes true. + // + // Example: (a > b) is not true. + // + // < Checks whether the value of the left operand is less than the value of the + // right operand; if yes, then the condition becomes true. + // + // Example: (a < b) is true. + // + // >= Checks whether the value of the left operand is greater than or equal to the + // value of the right operand; if yes, then the condition becomes true. + // + // Example: (a >= b) is not true. + // + // <= Checks whether the value of the left operand is less than or equal to the + // value of the 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 + // + // 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: + // the catalog partitions. + // + // Sample API Call: + // + // [JSQLParser]: http://jsqlparser.sourceforge.net/home.php Expression *string // The maximum number of partitions to return in a single response. diff --git a/service/glue/api_op_GetPlan.go b/service/glue/api_op_GetPlan.go index 3a3da4b5793..a385e528e5c 100644 --- a/service/glue/api_op_GetPlan.go +++ b/service/glue/api_op_GetPlan.go @@ -39,12 +39,15 @@ type GetPlanInput struct { // This member is required. Source *types.CatalogEntry - // A map to hold additional optional key-value parameters. Currently, these - // key-value pairs are supported: + // 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"}' + // 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 8422a201347..fb03ebc4eca 100644 --- a/service/glue/api_op_GetResourcePolicies.go +++ b/service/glue/api_op_GetResourcePolicies.go @@ -13,9 +13,11 @@ import ( // Retrieves the resource policies set on individual resources by Resource Access // Manager during cross-account permission grants. Also retrieves the Data Catalog -// resource policy. If you enabled metadata encryption in Data Catalog settings, -// and you do not have permission on the KMS key, the operation can't return the -// Data Catalog resource policy. +// resource policy. +// +// If you enabled metadata encryption in Data Catalog settings, and you do not +// have permission on the KMS key, the operation can't return the Data Catalog +// resource policy. func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error) { if params == nil { params = &GetResourcePoliciesInput{} diff --git a/service/glue/api_op_GetResourcePolicy.go b/service/glue/api_op_GetResourcePolicy.go index f20f76c9d7e..a64ab041c3a 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]. + // + // [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 a852c5879fb..34ed46a721f 100644 --- a/service/glue/api_op_GetSchema.go +++ b/service/glue/api_op_GetSchema.go @@ -31,8 +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. // diff --git a/service/glue/api_op_GetSchemaByDefinition.go b/service/glue/api_op_GetSchemaByDefinition.go index 4672deaac68..1d4b765b5ad 100644 --- a/service/glue/api_op_GetSchemaByDefinition.go +++ b/service/glue/api_op_GetSchemaByDefinition.go @@ -41,8 +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. // diff --git a/service/glue/api_op_GetSchemaVersion.go b/service/glue/api_op_GetSchemaVersion.go index 9d4c052f99e..b50ece6ed66 100644 --- a/service/glue/api_op_GetSchemaVersion.go +++ b/service/glue/api_op_GetSchemaVersion.go @@ -33,8 +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 *types.SchemaId diff --git a/service/glue/api_op_GetSchemaVersionsDiff.go b/service/glue/api_op_GetSchemaVersionsDiff.go index 1216325dd12..aafdcdd1679 100644 --- a/service/glue/api_op_GetSchemaVersionsDiff.go +++ b/service/glue/api_op_GetSchemaVersionsDiff.go @@ -12,9 +12,10 @@ import ( ) // Fetches the schema version difference in the specified difference type between -// two stored schema versions in the Schema Registry. This API allows you to -// compare two schema versions between two schema definitions under the same -// schema. +// two stored schema versions in the Schema Registry. +// +// This API allows you to compare two schema versions between two schema +// definitions under the same schema. func (c *Client) GetSchemaVersionsDiff(ctx context.Context, params *GetSchemaVersionsDiffInput, optFns ...func(*Options)) (*GetSchemaVersionsDiffOutput, error) { if params == nil { params = &GetSchemaVersionsDiffInput{} @@ -44,8 +45,10 @@ type GetSchemaVersionsDiffInput 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. // diff --git a/service/glue/api_op_GetUnfilteredPartitionMetadata.go b/service/glue/api_op_GetUnfilteredPartitionMetadata.go index 2ee366a21f4..643014a4c52 100644 --- a/service/glue/api_op_GetUnfilteredPartitionMetadata.go +++ b/service/glue/api_op_GetUnfilteredPartitionMetadata.go @@ -12,8 +12,10 @@ 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 . +// metadata. +// +// For IAM authorization, the public IAM action associated with this API is +// glue:GetPartition . func (c *Client) GetUnfilteredPartitionMetadata(ctx context.Context, params *GetUnfilteredPartitionMetadataInput, optFns ...func(*Options)) (*GetUnfilteredPartitionMetadataOutput, error) { if params == nil { params = &GetUnfilteredPartitionMetadataInput{} diff --git a/service/glue/api_op_GetUnfilteredPartitionsMetadata.go b/service/glue/api_op_GetUnfilteredPartitionsMetadata.go index 65bfc728c31..9370c76f2a6 100644 --- a/service/glue/api_op_GetUnfilteredPartitionsMetadata.go +++ b/service/glue/api_op_GetUnfilteredPartitionsMetadata.go @@ -12,8 +12,10 @@ 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 . +// metadata. +// +// For IAM authorization, the public IAM action associated with this API is +// glue:GetPartitions . func (c *Client) GetUnfilteredPartitionsMetadata(ctx context.Context, params *GetUnfilteredPartitionsMetadataInput, optFns ...func(*Options)) (*GetUnfilteredPartitionsMetadataOutput, error) { if params == nil { params = &GetUnfilteredPartitionsMetadataInput{} @@ -55,35 +57,71 @@ type GetUnfilteredPartitionsMetadataInput struct { // A structure containing Lake Formation audit context information. AuditContext *types.AuditContext - // An expression that filters the partitions to be returned. The expression uses - // SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser - // JSQLParser (http://jsqlparser.sourceforge.net/home.php) parses the expression. + // An expression that filters the partitions to be returned. + // + // The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL + // statement parser [JSQLParser]parses the expression. + // // Operators: The following are the operators that you can use in the Expression - // API call: = Checks whether the values of the two operands are equal; if yes, - // then the condition becomes true. Example: Assume 'variable a' holds 10 and - // 'variable b' holds 20. (a = b) is not true. < > Checks whether the values of two - // operands are equal; if the values are not equal, then the condition becomes - // true. Example: (a < > b) is true. > Checks whether the value of the left operand - // is greater than the value of the right operand; if yes, then the condition - // becomes true. Example: (a > b) is not true. < Checks whether the value of the - // left operand is less than the value of the right operand; if yes, then the - // condition becomes true. Example: (a < b) is true. >= Checks whether the value of - // the left operand is greater than or equal to the value of the right operand; if - // yes, then the condition becomes true. Example: (a >= b) is not true. <= Checks - // whether the value of the left operand is less than or equal to the value of the - // 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. + // API call: + // + // = Checks whether the values of the two operands are equal; if yes, then the + // condition becomes true. + // + // Example: Assume 'variable a' holds 10 and 'variable b' holds 20. + // + // (a = b) is not true. + // + // < > Checks whether the values of two operands are equal; if the values are not + // equal, then the condition becomes true. + // + // Example: (a < > b) is true. + // + // > Checks whether the value of the left operand is greater than the value of the + // right operand; if yes, then the condition becomes true. + // + // Example: (a > b) is not true. + // + // < Checks whether the value of the left operand is less than the value of the + // right operand; if yes, then the condition becomes true. + // + // Example: (a < b) is true. + // + // >= Checks whether the value of the left operand is greater than or equal to the + // value of the right operand; if yes, then the condition becomes true. + // + // Example: (a >= b) is not true. + // + // <= Checks whether the value of the left operand is less than or equal to the + // value of the 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. + // + // [JSQLParser]: http://jsqlparser.sourceforge.net/home.php Expression *string // The maximum number of partitions to return in a single response. diff --git a/service/glue/api_op_GetUnfilteredTableMetadata.go b/service/glue/api_op_GetUnfilteredTableMetadata.go index 6a64c8f8563..4a2daab82d4 100644 --- a/service/glue/api_op_GetUnfilteredTableMetadata.go +++ b/service/glue/api_op_GetUnfilteredTableMetadata.go @@ -12,8 +12,10 @@ import ( ) // Allows a third-party analytical engine to retrieve unfiltered table metadata -// from the Data Catalog. For IAM authorization, the public IAM action associated -// with this API is glue:GetTable . +// from the Data Catalog. +// +// For IAM authorization, the public IAM action associated with this API is +// glue:GetTable . func (c *Client) GetUnfilteredTableMetadata(ctx context.Context, params *GetUnfilteredTableMetadataInput, optFns ...func(*Options)) (*GetUnfilteredTableMetadataOutput, error) { if params == nil { params = &GetUnfilteredTableMetadataInput{} @@ -49,21 +51,27 @@ type GetUnfilteredTableMetadataInput struct { // Indicates the level of filtering a third-party analytical engine is capable of // enforcing when calling the GetUnfilteredTableMetadata API operation. Accepted // values are: + // // - COLUMN_PERMISSION - Column permissions ensure that users can access only // specific columns in the table. If there are particular columns contain sensitive // data, data lake administrators can define column filters that exclude access to // specific columns. + // // - CELL_FILTER_PERMISSION - Cell-level filtering combines column filtering // (include or exclude columns) and row filter expressions to restrict access to // individual elements in the table. + // // - NESTED_PERMISSION - Nested permissions combines cell-level filtering and // nested column filtering to restrict access to columns and/or nested columns in // specific rows based on row filter expressions. + // // - NESTED_CELL_PERMISSION - Nested cell permissions combines nested permission // with nested cell-level filtering. This allows different subsets of nested // columns to be restricted based on an array of row filter expressions. + // // Note: Each of these permission types follows a hierarchical order where each // subsequent permission type includes all permission of the previous type. + // // Important: If you provide a supported permission type that doesn't match the // user's level of permissions on the table, then Lake Formation raises an // exception. For example, if the third-party engine calling the diff --git a/service/glue/api_op_ListCrawlers.go b/service/glue/api_op_ListCrawlers.go index d851d9cec3a..91702046816 100644 --- a/service/glue/api_op_ListCrawlers.go +++ b/service/glue/api_op_ListCrawlers.go @@ -12,10 +12,11 @@ import ( // Retrieves the names of all crawler 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 filtering, only resources with the tag are retrieved. +// 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 filtering, only resources with the tag are retrieved. func (c *Client) ListCrawlers(ctx context.Context, params *ListCrawlersInput, optFns ...func(*Options)) (*ListCrawlersOutput, error) { if params == nil { params = &ListCrawlersInput{} diff --git a/service/glue/api_op_ListCrawls.go b/service/glue/api_op_ListCrawls.go index de9701283e5..893ba271c22 100644 --- a/service/glue/api_op_ListCrawls.go +++ b/service/glue/api_op_ListCrawls.go @@ -13,11 +13,16 @@ import ( // 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: +// 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) { diff --git a/service/glue/api_op_ListDevEndpoints.go b/service/glue/api_op_ListDevEndpoints.go index 8f96ea100b4..8fde2200f4f 100644 --- a/service/glue/api_op_ListDevEndpoints.go +++ b/service/glue/api_op_ListDevEndpoints.go @@ -12,10 +12,11 @@ import ( // Retrieves the names of all DevEndpoint 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 filtering, only resources with the tag are retrieved. +// 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 filtering, only resources with the tag are retrieved. func (c *Client) ListDevEndpoints(ctx context.Context, params *ListDevEndpointsInput, optFns ...func(*Options)) (*ListDevEndpointsOutput, error) { if params == nil { params = &ListDevEndpointsInput{} diff --git a/service/glue/api_op_ListJobs.go b/service/glue/api_op_ListJobs.go index e7728d5b354..d830c990c15 100644 --- a/service/glue/api_op_ListJobs.go +++ b/service/glue/api_op_ListJobs.go @@ -12,10 +12,11 @@ import ( // 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 -// filtering, only resources with the tag are retrieved. +// 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 filtering, only resources with the tag are retrieved. func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error) { if params == nil { params = &ListJobsInput{} diff --git a/service/glue/api_op_ListMLTransforms.go b/service/glue/api_op_ListMLTransforms.go index 9a33deadfaf..d246c433798 100644 --- a/service/glue/api_op_ListMLTransforms.go +++ b/service/glue/api_op_ListMLTransforms.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a sortable, filterable list of existing Glue machine learning +// Retrieves a sortable, filterable list of existing Glue machine learning +// // transforms in this Amazon Web Services account, or the resources with the // specified tag. This operation takes the optional Tags field, which you can use // as a filter of the responses so that tagged resources can be retrieved as a diff --git a/service/glue/api_op_ListSchemaVersions.go b/service/glue/api_op_ListSchemaVersions.go index bf227b4a245..7791fee01f8 100644 --- a/service/glue/api_op_ListSchemaVersions.go +++ b/service/glue/api_op_ListSchemaVersions.go @@ -34,8 +34,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. // diff --git a/service/glue/api_op_ListSchemas.go b/service/glue/api_op_ListSchemas.go index 65cfad7cec3..05dd01fdce8 100644 --- a/service/glue/api_op_ListSchemas.go +++ b/service/glue/api_op_ListSchemas.go @@ -13,8 +13,10 @@ import ( // Returns a list of schemas with minimal details. Schemas in Deleting status will // not be included in the results. Empty results will be returned if there are no -// schemas available. When the RegistryId is not provided, all the schemas across -// registries will be part of the API response. +// schemas available. +// +// When the RegistryId is not provided, all the schemas across registries will be +// part of the API response. func (c *Client) ListSchemas(ctx context.Context, params *ListSchemasInput, optFns ...func(*Options)) (*ListSchemasOutput, error) { if params == nil { params = &ListSchemasInput{} diff --git a/service/glue/api_op_ListTriggers.go b/service/glue/api_op_ListTriggers.go index 35c93fb78a7..c5679c0d29c 100644 --- a/service/glue/api_op_ListTriggers.go +++ b/service/glue/api_op_ListTriggers.go @@ -12,10 +12,11 @@ import ( // Retrieves the names of all trigger 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 filtering, only resources with the tag are retrieved. +// 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 filtering, only resources with the tag are retrieved. func (c *Client) ListTriggers(ctx context.Context, params *ListTriggersInput, optFns ...func(*Options)) (*ListTriggersOutput, error) { if params == nil { params = &ListTriggersInput{} @@ -33,7 +34,7 @@ func (c *Client) ListTriggers(ctx context.Context, params *ListTriggersInput, op type ListTriggersInput struct { - // The name of the job for which to retrieve triggers. The trigger that can start + // The name of the job for which to retrieve triggers. The trigger that can start // this job is returned. If there is no such trigger, all triggers are returned. DependentJobName *string diff --git a/service/glue/api_op_PutResourcePolicy.go b/service/glue/api_op_PutResourcePolicy.go index da654228d60..d0a9747470c 100644 --- a/service/glue/api_op_PutResourcePolicy.go +++ b/service/glue/api_op_PutResourcePolicy.go @@ -36,9 +36,12 @@ type PutResourcePolicyInput struct { // 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'. EnableHybrid types.EnableHybridValues diff --git a/service/glue/api_op_RegisterSchemaVersion.go b/service/glue/api_op_RegisterSchemaVersion.go index e643fc78f68..8eccad25222 100644 --- a/service/glue/api_op_RegisterSchemaVersion.go +++ b/service/glue/api_op_RegisterSchemaVersion.go @@ -14,13 +14,16 @@ import ( // Adds a new version to the existing schema. Returns an error if new version of // schema does not meet the compatibility requirements of the schema set. This API // will not create a new schema set and will return a 404 error if the schema set -// is not already present in the Schema Registry. If this is the first schema -// definition to be registered in the Schema Registry, this API will store the -// schema version and return immediately. Otherwise, this call has the potential to -// run longer than other operations due to compatibility modes. You can call the -// GetSchemaVersion API with the SchemaVersionId to check compatibility modes. If -// the same schema definition is already stored in Schema Registry as a version, -// the schema ID of the existing schema is returned to the caller. +// is not already present in the Schema Registry. +// +// If this is the first schema definition to be registered in the Schema Registry, +// this API will store the schema version and return immediately. Otherwise, this +// call has the potential to run longer than other operations due to compatibility +// modes. You can call the GetSchemaVersion API with the SchemaVersionId to check +// compatibility modes. +// +// If the same schema definition is already stored in Schema Registry as a +// version, the schema ID of the existing schema is returned to the caller. func (c *Client) RegisterSchemaVersion(ctx context.Context, params *RegisterSchemaVersionInput, optFns ...func(*Options)) (*RegisterSchemaVersionOutput, error) { if params == nil { params = &RegisterSchemaVersionInput{} @@ -45,8 +48,10 @@ type RegisterSchemaVersionInput 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. // diff --git a/service/glue/api_op_ResetJobBookmark.go b/service/glue/api_op_ResetJobBookmark.go index 6901fe9b575..f7af5e740e9 100644 --- a/service/glue/api_op_ResetJobBookmark.go +++ b/service/glue/api_op_ResetJobBookmark.go @@ -11,11 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Resets a bookmark entry. +// +// For more information about enabling and using job bookmarks, see: +// +// [Tracking processed data using job bookmarks] +// +// [Job parameters used by Glue] +// +// [Job structure] +// +// [Job parameters used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html +// [Tracking processed data using job bookmarks]: https://docs.aws.amazon.com/glue/latest/dg/monitor-continuations.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 5eb81ded089..5897765b54b 100644 --- a/service/glue/api_op_SearchTables.go +++ b/service/glue/api_op_SearchTables.go @@ -12,8 +12,9 @@ import ( ) // 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 +// 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 @@ -41,14 +42,16 @@ type SearchTablesInput struct { CatalogId *string // 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 - // 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 - // customer-link and xx-link-yy are returned, but xxlinkyy is not returned. + // 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 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 customer-link and xx-link-yy are + // returned, but xxlinkyy is not returned. Filters []types.PropertyPredicate // The maximum number of tables to return in a single response. @@ -59,13 +62,16 @@ type SearchTablesInput struct { // 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. ResourceShareType types.ResourceShareType - // A string used for a text search. Specifying a value in quotes filters based on - // an exact match to the value. + // A string used for a text search. + // + // Specifying a value in quotes filters based on an exact match to the value. SearchText *string // A list of criteria for sorting the results by a field name, in an ascending or diff --git a/service/glue/api_op_StartCrawler.go b/service/glue/api_op_StartCrawler.go index 2100df6ab7f..bd958443c40 100644 --- a/service/glue/api_op_StartCrawler.go +++ b/service/glue/api_op_StartCrawler.go @@ -11,8 +11,9 @@ 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]. +// +// [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_StartDataQualityRuleRecommendationRun.go b/service/glue/api_op_StartDataQualityRuleRecommendationRun.go index bd2005e5934..6983a1f91f4 100644 --- a/service/glue/api_op_StartDataQualityRuleRecommendationRun.go +++ b/service/glue/api_op_StartDataQualityRuleRecommendationRun.go @@ -14,8 +14,9 @@ import ( // Starts a recommendation run that is used to generate rules when you don't know // what rules to write. Glue Data Quality analyzes the data and comes up with // recommendations for a potential ruleset. You can then triage the ruleset and -// modify the generated ruleset to your liking. Recommendation runs are -// automatically deleted after 90 days. +// modify the generated ruleset to your liking. +// +// Recommendation runs are automatically deleted after 90 days. func (c *Client) StartDataQualityRuleRecommendationRun(ctx context.Context, params *StartDataQualityRuleRecommendationRunInput, optFns ...func(*Options)) (*StartDataQualityRuleRecommendationRunOutput, error) { if params == nil { params = &StartDataQualityRuleRecommendationRunInput{} diff --git a/service/glue/api_op_StartImportLabelsTaskRun.go b/service/glue/api_op_StartImportLabelsTaskRun.go index 4c34d90f86a..b0e9f349ec3 100644 --- a/service/glue/api_op_StartImportLabelsTaskRun.go +++ b/service/glue/api_op_StartImportLabelsTaskRun.go @@ -14,24 +14,29 @@ import ( // 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 +// 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 // 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 -// learns from and combines all labels that you upload unless you set Replace to -// true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets -// all previously uploaded labels and learns only from the exact set that you -// upload. Replacing labels can be helpful if you realize that you previously -// uploaded incorrect labels, and you believe that they are having a negative -// effect on your transform quality. You can check on the status of your task run -// by calling the GetMLTaskRun operation. +// transformation. +// +// By default, StartMLLabelingSetGenerationTaskRun continually learns from and +// combines all labels that you upload unless you set Replace to true. If you set +// Replace to true, StartImportLabelsTaskRun deletes and forgets all previously +// uploaded labels and learns only from the exact set that you upload. Replacing +// labels can be helpful if you realize that you previously uploaded incorrect +// labels, and you believe that they are having a negative effect on your transform +// quality. +// +// You can check on the status of your task run by calling the GetMLTaskRun +// operation. func (c *Client) StartImportLabelsTaskRun(ctx context.Context, params *StartImportLabelsTaskRunInput, optFns ...func(*Options)) (*StartImportLabelsTaskRunOutput, error) { if params == nil { params = &StartImportLabelsTaskRunInput{} diff --git a/service/glue/api_op_StartJobRun.go b/service/glue/api_op_StartJobRun.go index 51fbe632f86..b65e96fe32c 100644 --- a/service/glue/api_op_StartJobRun.go +++ b/service/glue/api_op_StartJobRun.go @@ -34,36 +34,49 @@ type StartJobRunInput struct { // This member is required. JobName *string - // This field is deprecated. Use MaxCapacity instead. The number of Glue data - // 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/) . + // This field is deprecated. Use MaxCapacity instead. + // + // The number of Glue data 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]. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 // The job arguments associated with this run. For this job run, they replace 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. 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 arguments you can - // provide to this field when configuring Spark jobs, 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. For information about the arguments you can - // provide to this field when configuring Ray jobs, see Using job parameters in - // Ray jobs (https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) - // in the developer guide. + // 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. + // + // 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]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Spark jobs, see the [Special Parameters Used by Glue]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Ray jobs, see [Using job parameters in Ray jobs]in the developer guide. + // + // [Using job parameters in Ray jobs]: https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html + // [Calling Glue APIs in Python]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html + // [Special Parameters Used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html Arguments map[string]string // Indicates whether the job is run with a standard or flexible execution class. // The standard execution-class is ideal for time-sensitive workloads that require - // fast job startup and dedicated resources. The flexible execution class is - // appropriate for time-insensitive jobs whose start and completion times may vary. + // 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. @@ -75,19 +88,26 @@ type StartJobRunInput struct { // 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/) . For Glue version 2.0+ - // jobs, you cannot specify a Maximum capacity . Instead, you should specify a - // Worker type and the Number of workers . Do not set MaxCapacity 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: + // of compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // For Glue version 2.0+ jobs, you cannot specify a Maximum capacity . Instead, you + // should specify a Worker type and the Number of workers . + // + // Do not set MaxCapacity 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. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // Specifies configuration properties of a job run notification. @@ -102,23 +122,28 @@ type StartJobRunInput struct { // 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. This value - // overrides the timeout value set in the parent job. Streaming jobs do not have a - // timeout. The default for non-streaming jobs is 2,880 minutes (48 hours). + // overrides the timeout value set in the parent job. + // + // Streaming jobs do not have a 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X // for Ray jobs. + // // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of // memory) with 84GB disk (approximately 34GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of // memory) with 128GB disk (approximately 77GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of // memory) with 256GB disk (approximately 235GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most @@ -127,16 +152,19 @@ type StartJobRunInput struct { // Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West // (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), // Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). + // // - For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of // memory) with 512GB disk (approximately 487GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most // demanding transforms, aggregations, joins, and queries. This worker type is // available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon // Web Services Regions as supported for the G.4X worker type. + // // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of // memory) with 84GB disk (approximately 34GB free), 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 Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of // memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray // workers based on the autoscaler. diff --git a/service/glue/api_op_StartMLEvaluationTaskRun.go b/service/glue/api_op_StartMLEvaluationTaskRun.go index b5340f804a1..7c57d8101bf 100644 --- a/service/glue/api_op_StartMLEvaluationTaskRun.go +++ b/service/glue/api_op_StartMLEvaluationTaskRun.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a task to estimate the quality of the transform. When you provide label -// 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. +// Starts a task to estimate the quality of the transform. +// +// When you provide label 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 . func (c *Client) StartMLEvaluationTaskRun(ctx context.Context, params *StartMLEvaluationTaskRunInput, optFns ...func(*Options)) (*StartMLEvaluationTaskRunOutput, error) { diff --git a/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go b/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go index 2ec34f6744f..c3bea70dab5 100644 --- a/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go +++ b/service/glue/api_op_StartMLLabelingSetGenerationTaskRun.go @@ -11,11 +11,15 @@ import ( ) // Starts the active learning workflow for your machine learning transform to -// improve the transform's quality by generating label sets and adding labels. When -// the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a -// "labeling set" or a set of questions for humans to answer. 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?” +// improve the transform's quality by generating label sets and adding labels. +// +// When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated +// a "labeling set" or a set of questions for humans to answer. +// +// 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, 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 diff --git a/service/glue/api_op_StartTrigger.go b/service/glue/api_op_StartTrigger.go index 63214441a51..ccab62630c9 100644 --- a/service/glue/api_op_StartTrigger.go +++ b/service/glue/api_op_StartTrigger.go @@ -10,8 +10,10 @@ 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] for information about how different types of +// trigger are started. +// +// [Triggering Jobs]: https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html 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_TagResource.go b/service/glue/api_op_TagResource.go index 492db0567d9..6420767bed3 100644 --- a/service/glue/api_op_TagResource.go +++ b/service/glue/api_op_TagResource.go @@ -12,8 +12,9 @@ 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]. +// +// [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 +33,9 @@ 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]. + // + // [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_UpdateColumnStatisticsForPartition.go b/service/glue/api_op_UpdateColumnStatisticsForPartition.go index 908825cac39..3d52a62ab82 100644 --- a/service/glue/api_op_UpdateColumnStatisticsForPartition.go +++ b/service/glue/api_op_UpdateColumnStatisticsForPartition.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates partition statistics of columns. The Identity and Access -// Management (IAM) permission required for this operation is UpdatePartition . +// Creates or updates partition statistics of columns. +// +// The Identity and Access 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 5a90bb97385..58f85baf429 100644 --- a/service/glue/api_op_UpdateColumnStatisticsForTable.go +++ b/service/glue/api_op_UpdateColumnStatisticsForTable.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates table statistics of columns. The Identity and Access -// Management (IAM) permission required for this operation is UpdateTable . +// Creates or updates table statistics of columns. +// +// The Identity and Access 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_UpdateCrawler.go b/service/glue/api_op_UpdateCrawler.go index f15822c8da4..172feb9c87c 100644 --- a/service/glue/api_op_UpdateCrawler.go +++ b/service/glue/api_op_UpdateCrawler.go @@ -41,9 +41,9 @@ type UpdateCrawlerInput struct { Classifiers []string // 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) - // . + // specify aspects of a crawler's behavior. For more information, see [Setting crawler configuration options]. + // + // [Setting 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. @@ -70,10 +70,10 @@ type UpdateCrawlerInput struct { // new crawler to access customer resources. 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 * * ? *) . + // A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. For example, to run + // something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) . + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html 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 ec6f7026d38..11562aef0d3 100644 --- a/service/glue/api_op_UpdateCrawlerSchedule.go +++ b/service/glue/api_op_UpdateCrawlerSchedule.go @@ -33,10 +33,10 @@ type UpdateCrawlerScheduleInput struct { // This member is required. 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 * * ? *) . + // The updated cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. For example, to + // run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) . + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html Schedule *string noSmithyDocumentSerde diff --git a/service/glue/api_op_UpdateDevEndpoint.go b/service/glue/api_op_UpdateDevEndpoint.go index 251050c2560..8226a06552f 100644 --- a/service/glue/api_op_UpdateDevEndpoint.go +++ b/service/glue/api_op_UpdateDevEndpoint.go @@ -35,8 +35,12 @@ type UpdateDevEndpointInput struct { EndpointName *string // The map of arguments to add the map of arguments used to configure the - // DevEndpoint . Valid arguments are: + // 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. diff --git a/service/glue/api_op_UpdateJobFromSourceControl.go b/service/glue/api_op_UpdateJobFromSourceControl.go index 1e0d6e8589d..e98ba0dd8fb 100644 --- a/service/glue/api_op_UpdateJobFromSourceControl.go +++ b/service/glue/api_op_UpdateJobFromSourceControl.go @@ -13,8 +13,9 @@ import ( // Synchronizes a job from the source control repository. This operation takes the // job artifacts that are located in the remote repository and updates the Glue -// internal stores with these artifacts. This API supports optional parameters -// which take in the repository information. +// internal stores with these artifacts. +// +// This API supports optional parameters which take in the repository information. func (c *Client) UpdateJobFromSourceControl(ctx context.Context, params *UpdateJobFromSourceControlInput, optFns ...func(*Options)) (*UpdateJobFromSourceControlOutput, error) { if params == nil { params = &UpdateJobFromSourceControlInput{} @@ -51,7 +52,7 @@ type UpdateJobFromSourceControlInput struct { // The name of the Glue job to be synchronized to or from the remote repository. JobName *string - // The provider for the remote repository. Possible values: GITHUB, + // The provider for the remote repository. Possible values: GITHUB, // AWS_CODE_COMMIT, GITLAB, BITBUCKET. Provider types.SourceControlProvider diff --git a/service/glue/api_op_UpdateMLTransform.go b/service/glue/api_op_UpdateMLTransform.go index 5b0eb9e4951..94afb32ee5d 100644 --- a/service/glue/api_op_UpdateMLTransform.go +++ b/service/glue/api_op_UpdateMLTransform.go @@ -12,10 +12,12 @@ import ( ) // Updates an existing machine learning transform. Call this operation to tune the -// algorithm parameters to achieve better results. After calling this operation, -// you can call the StartMLEvaluationTaskRun operation to assess how well your new -// parameters achieved your goals (such as improving the quality of your machine -// learning transform, or making it more cost-effective). +// algorithm parameters to achieve better results. +// +// After calling this operation, you can call the StartMLEvaluationTaskRun +// operation to assess how well your new parameters achieved your goals (such as +// improving the quality of your machine learning transform, or making it more +// cost-effective). func (c *Client) UpdateMLTransform(ctx context.Context, params *UpdateMLTransformInput, optFns ...func(*Options)) (*UpdateMLTransformOutput, error) { if params == nil { params = &UpdateMLTransformInput{} @@ -43,18 +45,21 @@ 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) - // in the developer guide. + // set, the Glue compatibility defaults to Glue 0.9. For more information, see [Glue Versions]in + // the developer guide. + // + // [Glue Versions]: https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions 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]. + // + // When the WorkerType field is set to a value other than Standard , the + // MaxCapacity field is set automatically and becomes read-only. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry a task for this transform after a task run @@ -83,10 +88,13 @@ 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. WorkerType types.WorkerType diff --git a/service/glue/api_op_UpdatePartition.go b/service/glue/api_op_UpdatePartition.go index e49e2e25e9c..140e2dedfad 100644 --- a/service/glue/api_op_UpdatePartition.go +++ b/service/glue/api_op_UpdatePartition.go @@ -34,9 +34,10 @@ type UpdatePartitionInput struct { // This member is required. DatabaseName *string - // The new partition object to update the partition to. The Values property can't - // be changed. If you want to change the partition key values for a partition, - // delete and recreate the partition. + // The new partition object to update the partition to. + // + // The Values property can't be changed. If you want to change the partition key + // values for a partition, delete and recreate the partition. // // This member is required. PartitionInput *types.PartitionInput diff --git a/service/glue/api_op_UpdateSchema.go b/service/glue/api_op_UpdateSchema.go index 4f6482598a1..381faab619c 100644 --- a/service/glue/api_op_UpdateSchema.go +++ b/service/glue/api_op_UpdateSchema.go @@ -12,14 +12,18 @@ import ( ) // Updates the description, compatibility setting, or version checkpoint for a -// schema set. For updating the compatibility setting, the call will not validate +// schema set. +// +// For updating the compatibility setting, the call will not validate // compatibility for the entire set of schema versions with the new compatibility // setting. If the value for Compatibility is provided, the VersionNumber (a // checkpoint) is also required. The API will validate the checkpoint version -// number for consistency. If the value for the VersionNumber (checkpoint) is -// provided, Compatibility is optional and this can be used to set/reset a -// checkpoint for the schema. This update will happen only if the schema is in the -// AVAILABLE state. +// number for consistency. +// +// If the value for the VersionNumber (checkpoint) is provided, Compatibility is +// optional and this can be used to set/reset a checkpoint for the schema. +// +// This update will happen only if the schema is in the AVAILABLE state. func (c *Client) UpdateSchema(ctx context.Context, params *UpdateSchemaInput, optFns ...func(*Options)) (*UpdateSchemaOutput, error) { if params == nil { params = &UpdateSchemaInput{} @@ -39,8 +43,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. // diff --git a/service/glue/api_op_UpdateSourceControlFromJob.go b/service/glue/api_op_UpdateSourceControlFromJob.go index f99cb248a72..5fbe834fb3a 100644 --- a/service/glue/api_op_UpdateSourceControlFromJob.go +++ b/service/glue/api_op_UpdateSourceControlFromJob.go @@ -13,8 +13,9 @@ import ( // Synchronizes a job to the source control repository. This operation takes the // job artifacts from the Glue internal stores and makes a commit to the remote -// repository that is configured on the job. This API supports optional parameters -// which take in the repository information. +// repository that is configured on the job. +// +// This API supports optional parameters which take in the repository information. func (c *Client) UpdateSourceControlFromJob(ctx context.Context, params *UpdateSourceControlFromJobInput, optFns ...func(*Options)) (*UpdateSourceControlFromJobOutput, error) { if params == nil { params = &UpdateSourceControlFromJobInput{} @@ -51,7 +52,7 @@ type UpdateSourceControlFromJobInput struct { // The name of the Glue job to be synchronized to or from the remote repository. JobName *string - // The provider for the remote repository. Possible values: GITHUB, + // The provider for the remote repository. Possible values: GITHUB, // AWS_CODE_COMMIT, GITLAB, BITBUCKET. Provider types.SourceControlProvider diff --git a/service/glue/doc.go b/service/glue/doc.go index dd1e6f10041..c6e9db318c7 100644 --- a/service/glue/doc.go +++ b/service/glue/doc.go @@ -3,5 +3,7 @@ // Package glue provides the API client, operations, and parameter types for AWS // Glue. // -// Glue Defines the public endpoint for the Glue service. +// # Glue +// +// Defines the public endpoint for the Glue service. package glue diff --git a/service/glue/options.go b/service/glue/options.go index 421fb06101a..d9111bbfc5e 100644 --- a/service/glue/options.go +++ b/service/glue/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/glue/types/enums.go b/service/glue/types/enums.go index e20750f958f..ce51c27294e 100644 --- a/service/glue/types/enums.go +++ b/service/glue/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AdditionalOptionKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalOptionKeys) Values() []AdditionalOptionKeys { return []AdditionalOptionKeys{ "performanceTuning.caching", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for AggFunction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggFunction) Values() []AggFunction { return []AggFunction{ "avg", @@ -76,8 +78,9 @@ const ( ) // Values returns all known values for BackfillErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackfillErrorCode) Values() []BackfillErrorCode { return []BackfillErrorCode{ "ENCRYPTED_PARTITION_ERROR", @@ -99,8 +102,9 @@ const ( ) // Values returns all known values for BlueprintRunState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlueprintRunState) Values() []BlueprintRunState { return []BlueprintRunState{ "RUNNING", @@ -121,8 +125,9 @@ const ( ) // Values returns all known values for BlueprintStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlueprintStatus) Values() []BlueprintStatus { return []BlueprintStatus{ "CREATING", @@ -142,8 +147,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -162,6 +168,7 @@ const ( // 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{ @@ -182,8 +189,9 @@ const ( ) // Values returns all known values for ColumnStatisticsState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnStatisticsState) Values() []ColumnStatisticsState { return []ColumnStatisticsState{ "STARTING", @@ -208,8 +216,9 @@ const ( ) // Values returns all known values for ColumnStatisticsType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnStatisticsType) Values() []ColumnStatisticsType { return []ColumnStatisticsType{ "BOOLEAN", @@ -234,8 +243,9 @@ const ( ) // Values returns all known values for Comparator. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Comparator) Values() []Comparator { return []Comparator{ "EQUALS", @@ -261,8 +271,9 @@ const ( ) // Values returns all known values for Compatibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Compatibility) Values() []Compatibility { return []Compatibility{ "NONE", @@ -285,8 +296,9 @@ const ( ) // Values returns all known values for CompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionType) Values() []CompressionType { return []CompressionType{ "gzip", @@ -343,8 +355,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "HOST", @@ -406,8 +419,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "JDBC", @@ -431,8 +445,9 @@ const ( ) // Values returns all known values for CrawlerHistoryState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CrawlerHistoryState) Values() []CrawlerHistoryState { return []CrawlerHistoryState{ "RUNNING", @@ -451,8 +466,9 @@ const ( ) // Values returns all known values for CrawlerLineageSettings. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CrawlerLineageSettings) Values() []CrawlerLineageSettings { return []CrawlerLineageSettings{ "ENABLE", @@ -470,8 +486,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -493,8 +510,9 @@ const ( ) // Values returns all known values for CrawlState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CrawlState) Values() []CrawlState { return []CrawlState{ "RUNNING", @@ -516,8 +534,9 @@ const ( ) // Values returns all known values for CsvHeaderOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CsvHeaderOption) Values() []CsvHeaderOption { return []CsvHeaderOption{ "UNKNOWN", @@ -536,8 +555,9 @@ const ( ) // Values returns all known values for CsvSerdeOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CsvSerdeOption) Values() []CsvSerdeOption { return []CsvSerdeOption{ "OpenCSVSerDe", @@ -556,8 +576,9 @@ const ( ) // Values returns all known values for DataFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataFormat) Values() []DataFormat { return []DataFormat{ "AVRO", @@ -577,6 +598,7 @@ const ( // Values returns all known values for DataQualityRuleResultStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataQualityRuleResultStatus) Values() []DataQualityRuleResultStatus { return []DataQualityRuleResultStatus{ @@ -596,8 +618,9 @@ const ( ) // Values returns all known values for DeleteBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteBehavior) Values() []DeleteBehavior { return []DeleteBehavior{ "LOG", @@ -616,6 +639,7 @@ const ( // Values returns all known values for DeltaTargetCompressionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DeltaTargetCompressionType) Values() []DeltaTargetCompressionType { return []DeltaTargetCompressionType{ @@ -634,6 +658,7 @@ const ( // 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{ @@ -651,8 +676,9 @@ const ( ) // Values returns all known values for DQTransformOutput. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DQTransformOutput) Values() []DQTransformOutput { return []DQTransformOutput{ "PrimaryInput", @@ -669,8 +695,9 @@ const ( ) // Values returns all known values for EnableHybridValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnableHybridValues) Values() []EnableHybridValues { return []EnableHybridValues{ "TRUE", @@ -687,8 +714,9 @@ const ( ) // Values returns all known values for ExecutionClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionClass) Values() []ExecutionClass { return []ExecutionClass{ "FLEX", @@ -706,8 +734,9 @@ const ( ) // Values returns all known values for ExistCondition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExistCondition) Values() []ExistCondition { return []ExistCondition{ "MUST_EXIST", @@ -729,6 +758,7 @@ const ( // Values returns all known values for FederationSourceErrorCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FederationSourceErrorCode) Values() []FederationSourceErrorCode { return []FederationSourceErrorCode{ @@ -752,8 +782,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -773,8 +804,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AND", @@ -796,8 +828,9 @@ const ( ) // Values returns all known values for FilterOperation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperation) Values() []FilterOperation { return []FilterOperation{ "EQ", @@ -823,8 +856,9 @@ const ( ) // Values returns all known values for FilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperator) Values() []FilterOperator { return []FilterOperator{ "GT", @@ -845,8 +879,9 @@ const ( ) // Values returns all known values for FilterValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterValueType) Values() []FilterValueType { return []FilterValueType{ "COLUMNEXTRACTED", @@ -871,8 +906,9 @@ const ( ) // Values returns all known values for GlueRecordType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlueRecordType) Values() []GlueRecordType { return []GlueRecordType{ "DATE", @@ -900,6 +936,7 @@ const ( // Values returns all known values for HudiTargetCompressionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HudiTargetCompressionType) Values() []HudiTargetCompressionType { return []HudiTargetCompressionType{ @@ -922,8 +959,9 @@ const ( ) // Values returns all known values for JDBCConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JDBCConnectionType) Values() []JDBCConnectionType { return []JDBCConnectionType{ "sqlserver", @@ -980,8 +1018,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1035,8 +1074,9 @@ const ( ) // Values returns all known values for JdbcMetadataEntry. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JdbcMetadataEntry) Values() []JdbcMetadataEntry { return []JdbcMetadataEntry{ "COMMENTS", @@ -1054,6 +1094,7 @@ const ( // Values returns all known values for JobBookmarksEncryptionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (JobBookmarksEncryptionMode) Values() []JobBookmarksEncryptionMode { return []JobBookmarksEncryptionMode{ @@ -1078,8 +1119,9 @@ const ( ) // Values returns all known values for JobRunState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobRunState) Values() []JobRunState { return []JobRunState{ "STARTING", @@ -1107,8 +1149,9 @@ const ( ) // Values returns all known values for JoinType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JoinType) Values() []JoinType { return []JoinType{ "equijoin", @@ -1129,8 +1172,9 @@ const ( ) // Values returns all known values for Language. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Language) Values() []Language { return []Language{ "PYTHON", @@ -1148,8 +1192,9 @@ const ( ) // Values returns all known values for LastCrawlStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastCrawlStatus) Values() []LastCrawlStatus { return []LastCrawlStatus{ "SUCCEEDED", @@ -1167,8 +1212,9 @@ const ( ) // Values returns all known values for Logical. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Logical) Values() []Logical { return []Logical{ "AND", @@ -1184,8 +1230,9 @@ const ( ) // Values returns all known values for LogicalOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogicalOperator) Values() []LogicalOperator { return []LogicalOperator{ "EQUALS", @@ -1200,8 +1247,9 @@ const ( ) // Values returns all known values for MetadataOperation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetadataOperation) Values() []MetadataOperation { return []MetadataOperation{ "CREATE", @@ -1218,8 +1266,9 @@ const ( // Values returns all known values for MLUserDataEncryptionModeString. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MLUserDataEncryptionModeString) Values() []MLUserDataEncryptionModeString { return []MLUserDataEncryptionModeString{ "DISABLED", @@ -1237,8 +1286,9 @@ const ( ) // Values returns all known values for NodeType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeType) Values() []NodeType { return []NodeType{ "CRAWLER", @@ -1261,8 +1311,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1287,8 +1338,9 @@ const ( ) // Values returns all known values for ParquetCompressionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParquetCompressionType) Values() []ParquetCompressionType { return []ParquetCompressionType{ "snappy", @@ -1310,8 +1362,9 @@ const ( ) // Values returns all known values for PartitionIndexStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartitionIndexStatus) Values() []PartitionIndexStatus { return []PartitionIndexStatus{ "CREATING", @@ -1337,8 +1390,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "ALL", @@ -1364,8 +1418,9 @@ const ( ) // Values returns all known values for PermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionType) Values() []PermissionType { return []PermissionType{ "COLUMN_PERMISSION", @@ -1386,8 +1441,9 @@ const ( ) // Values returns all known values for PiiType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PiiType) Values() []PiiType { return []PiiType{ "RowAudit", @@ -1407,8 +1463,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "USER", @@ -1428,8 +1485,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1449,8 +1507,9 @@ const ( ) // Values returns all known values for RecrawlBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecrawlBehavior) Values() []RecrawlBehavior { return []RecrawlBehavior{ "CRAWL_EVERYTHING", @@ -1468,8 +1527,9 @@ const ( ) // Values returns all known values for RegistryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistryStatus) Values() []RegistryStatus { return []RegistryStatus{ "AVAILABLE", @@ -1487,8 +1547,9 @@ const ( ) // Values returns all known values for ResourceShareType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareType) Values() []ResourceShareType { return []ResourceShareType{ "FOREIGN", @@ -1507,8 +1568,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1527,8 +1589,9 @@ const ( ) // Values returns all known values for S3EncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3EncryptionMode) Values() []S3EncryptionMode { return []S3EncryptionMode{ "DISABLED", @@ -1547,8 +1610,9 @@ const ( ) // Values returns all known values for ScheduleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleState) Values() []ScheduleState { return []ScheduleState{ "SCHEDULED", @@ -1565,8 +1629,9 @@ const ( ) // Values returns all known values for SchemaDiffType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaDiffType) Values() []SchemaDiffType { return []SchemaDiffType{ "SYNTAX_DIFF", @@ -1583,8 +1648,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1604,8 +1670,9 @@ const ( ) // Values returns all known values for SchemaVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaVersionStatus) Values() []SchemaVersionStatus { return []SchemaVersionStatus{ "AVAILABLE", @@ -1627,8 +1694,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1652,8 +1720,9 @@ const ( ) // Values returns all known values for SessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionStatus) Values() []SessionStatus { return []SessionStatus{ "PROVISIONING", @@ -1674,8 +1743,9 @@ const ( ) // Values returns all known values for Sort. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Sort) Values() []Sort { return []Sort{ "ASC", @@ -1692,8 +1762,9 @@ const ( ) // Values returns all known values for SortDirectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortDirectionType) Values() []SortDirectionType { return []SortDirectionType{ "DESCENDING", @@ -1711,6 +1782,7 @@ const ( // Values returns all known values for SourceControlAuthStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SourceControlAuthStrategy) Values() []SourceControlAuthStrategy { return []SourceControlAuthStrategy{ @@ -1730,8 +1802,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "GITHUB", @@ -1752,8 +1825,9 @@ const ( ) // Values returns all known values for StartingPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StartingPosition) Values() []StartingPosition { return []StartingPosition{ "latest", @@ -1776,8 +1850,9 @@ const ( ) // Values returns all known values for StatementState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatementState) Values() []StatementState { return []StatementState{ "WAITING", @@ -1800,8 +1875,9 @@ const ( ) // Values returns all known values for TableOptimizerEventType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableOptimizerEventType) Values() []TableOptimizerEventType { return []TableOptimizerEventType{ "starting", @@ -1819,8 +1895,9 @@ const ( ) // Values returns all known values for TableOptimizerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableOptimizerType) Values() []TableOptimizerType { return []TableOptimizerType{ "compaction", @@ -1841,8 +1918,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1865,8 +1943,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TASK_RUN_TYPE", @@ -1889,8 +1968,9 @@ const ( ) // Values returns all known values for TaskStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatusType) Values() []TaskStatusType { return []TaskStatusType{ "STARTING", @@ -1915,8 +1995,9 @@ const ( ) // Values returns all known values for TaskType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskType) Values() []TaskType { return []TaskType{ "EVALUATION", @@ -1939,8 +2020,9 @@ const ( ) // Values returns all known values for TransformSortColumnType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformSortColumnType) Values() []TransformSortColumnType { return []TransformSortColumnType{ "NAME", @@ -1961,8 +2043,9 @@ const ( ) // Values returns all known values for TransformStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformStatusType) Values() []TransformStatusType { return []TransformStatusType{ "NOT_READY", @@ -1979,8 +2062,9 @@ const ( ) // Values returns all known values for TransformType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformType) Values() []TransformType { return []TransformType{ "FIND_MATCHES", @@ -2002,8 +2086,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2028,8 +2113,9 @@ const ( ) // Values returns all known values for TriggerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerType) Values() []TriggerType { return []TriggerType{ "SCHEDULED", @@ -2048,8 +2134,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2066,8 +2153,9 @@ const ( ) // Values returns all known values for UpdateBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateBehavior) Values() []UpdateBehavior { return []UpdateBehavior{ "LOG", @@ -2084,8 +2172,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "UPDATE_IN_DATABASE", @@ -2103,8 +2192,9 @@ const ( ) // Values returns all known values for ViewDialect. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViewDialect) Values() []ViewDialect { return []ViewDialect{ "REDSHIFT", @@ -2127,8 +2217,9 @@ const ( ) // Values returns all known values for WorkerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkerType) Values() []WorkerType { return []WorkerType{ "Standard", @@ -2153,8 +2244,9 @@ const ( ) // Values returns all known values for WorkflowRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowRunStatus) Values() []WorkflowRunStatus { return []WorkflowRunStatus{ "RUNNING", diff --git a/service/glue/types/types.go b/service/glue/types/types.go index 2766b78b0b4..81e8360040d 100644 --- a/service/glue/types/types.go +++ b/service/glue/types/types.go @@ -11,13 +11,19 @@ import ( type Action struct { // The job arguments used when this trigger fires. For this job run, they replace - // 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) - // 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) - // topic in the developer guide. + // 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]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]topic in the developer guide. + // + // [Calling Glue APIs in Python]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html + // [Special Parameters Used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html Arguments map[string]string // The name of the crawler to be used with this action. @@ -72,9 +78,11 @@ type Aggregate struct { // transform. type AggregateOperation struct { - // Specifies the aggregation function to apply. Possible aggregation functions - // include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, - // stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop + // Specifies the aggregation function to apply. + // + // Possible aggregation functions include: avg countDistinct, count, first, last, + // kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, + // var_samp, var_pop // // This member is required. AggFunc AggFunction @@ -301,16 +309,23 @@ type AuditContext struct { } // A list of errors that can occur when registering partition indexes for an -// existing table. These errors give the details about why an index registration -// 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: +// existing table. +// +// These errors give the details about why an index registration 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. type BackfillError struct { @@ -524,9 +539,13 @@ 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. Status BlueprintStatus @@ -578,9 +597,13 @@ 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. State BlueprintRunState @@ -827,9 +850,10 @@ 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 -// classifiers to best categorize your data sources and specify the appropriate +// 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 // of the fields in the Classifier object. @@ -1203,9 +1227,10 @@ type ColumnError struct { } // 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. +// 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. @@ -1273,9 +1298,9 @@ type ColumnStatisticsData struct { // Date column statistics data. DateColumnStatisticsData *DateColumnStatisticsData - // Decimal column statistics data. UnscaledValues within are Base64-encoded binary - // objects storing big-endian, two's complement representations of the decimal's - // unscaled value. + // Decimal column statistics data. UnscaledValues within are Base64-encoded + // binary objects storing big-endian, two's complement representations of the + // decimal's unscaled value. DecimalColumnStatisticsData *DecimalColumnStatisticsData // Double column statistics data. @@ -1392,8 +1417,11 @@ type Condition struct { } // 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] in Wikipedia. +// +// [Confusion matrix]: https://en.wikipedia.org/wiki/Confusion_matrix type ConfusionMatrix struct { // The number of matches in the data that the transform didn't find, in the @@ -1419,105 +1447,147 @@ 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" , "AWS_MSK_IAM" , or - // "PLAIN" . These are the supported SASL Mechanisms (https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) - // . + // "PLAIN" . These are the supported [SASL Mechanisms]. + // // - KAFKA_SASL_PLAIN_USERNAME - A plaintext username used to authenticate with // the "PLAIN" mechanism. + // // - KAFKA_SASL_PLAIN_PASSWORD - A plaintext password used to authenticate with // the "PLAIN" mechanism. + // // - ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - The encrypted version of the Kafka // SASL PLAIN password (if the user has the Glue encrypt passwords setting // selected). + // // - 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_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in // Amazon Web Services Secrets Manager. + // // - 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) - // . + // see [MIT Kerberos Documentation: Keytab]. + // // - 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) - // . + // the KDC server. For more information, see [MIT Kerberos Documentation: krb5.conf]. + // // - 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) - // . + // sasl.kerberos.service.name in your [Kafka Configuration]. + // // - 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) - // . + // Glue. For more information, see [Kafka Documentation: Configuring Kafka Brokers]. + // + // [MIT Kerberos Documentation: Keytab]: https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html + // [SASL Mechanisms]: https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml + // [Kafka Documentation: Configuring Kafka Brokers]: https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig + // [Kafka Configuration]: https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name + // [MIT Kerberos Documentation: krb5.conf]: https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html ConnectionProperties map[string]string // The type of the connection. Currently, SFTP is not supported. @@ -1557,55 +1627,85 @@ 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. + // 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. + // + // - 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. + // + // - 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. + // 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. + // 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) - // . + // + // SFTP is not supported. + // + // For more information about how optional ConnectionProperties are used to + // configure features in Glue, consult [Glue connection properties]. + // + // For more information about how optional ConnectionProperties are used to + // configure features in Glue Studio, consult [Using connectors and connections]. + // + // [Glue connection properties]: https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html + // [Using connectors and connections]: https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html // // This member is required. ConnectionType ConnectionType @@ -1632,13 +1732,16 @@ type ConnectionInput struct { // The data structure used by the Data Catalog to encrypt the password as part of // CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD // field in the connection properties. You can enable catalog encryption or only -// password encryption. When a CreationConnection request arrives containing a -// password, the Data Catalog first encrypts the password using your KMS key. It -// then encrypts the whole connection object again if catalog encryption is also -// enabled. This encryption requires that you set KMS key permissions to enable or -// restrict access on the password key according to your security requirements. For -// example, you might want only administrators to have decrypt permission on the -// password key. +// password encryption. +// +// When a CreationConnection request arrives containing a password, the Data +// Catalog first encrypts the password using your KMS key. It then encrypts the +// whole connection object again if catalog encryption is also enabled. +// +// This encryption requires that you set KMS key permissions to enable or restrict +// access on the password key according to your security requirements. For example, +// you might want only administrators to have decrypt permission on the password +// key. type ConnectionPasswordEncryption struct { // When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords @@ -1648,12 +1751,14 @@ type ConnectionPasswordEncryption struct { // This member is required. ReturnConnectionPasswordEncrypted bool - // 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. + // 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. AwsKmsKeyId *string noSmithyDocumentSerde @@ -1673,21 +1778,29 @@ type ConnectorDataSource struct { // The connectionType , as provided to the underlying Glue library. This node type // supports the following connection types: + // // - opensearch + // // - azuresql + // // - azurecosmos + // // - bigquery + // // - saphana + // // - teradata + // // - vertica // // This member is required. ConnectionType *string // A map specifying connection options for the node. You can find standard - // connection options for the corresponding connection type in the Connection - // parameters (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html) - // section of the Glue documentation. + // connection options for the corresponding connection type in the [Connection parameters]section of the + // Glue documentation. + // + // [Connection parameters]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html // // This member is required. Data map[string]string @@ -1708,21 +1821,29 @@ type ConnectorDataTarget struct { // The connectionType , as provided to the underlying Glue library. This node type // supports the following connection types: + // // - opensearch + // // - azuresql + // // - azurecosmos + // // - bigquery + // // - saphana + // // - teradata + // // - vertica // // This member is required. ConnectionType *string // A map specifying connection options for the node. You can find standard - // connection options for the corresponding connection type in the Connection - // parameters (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html) - // section of the Glue documentation. + // connection options for the corresponding connection type in the [Connection parameters]section of the + // Glue documentation. + // + // [Connection parameters]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html // // This member is required. Data map[string]string @@ -1772,9 +1893,9 @@ type Crawler struct { Classifiers []string // 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) - // . + // specify aspects of a crawler's behavior. For more information, see [Setting crawler configuration options]. + // + // [Setting 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 @@ -1952,22 +2073,31 @@ 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. + // + // - 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. FilterOperator FilterOperator @@ -2045,9 +2175,9 @@ type CreateGrokClassifierRequest struct { 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) - // . + // supports a subset of JsonPath, as described in [Writing JsonPath Custom Classifiers]. + // + // [Writing JsonPath Custom Classifiers]: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json // // This member is required. JsonPath *string @@ -2182,7 +2312,9 @@ type CustomEntityType struct { // A list of context words. If none of these context words are found within the // vicinity of the regular expression the data will not be detected as sensitive - // data. If no context words are passed only a regular expression is checked. + // data. + // + // If no context words are passed only a regular expression is checked. ContextWords []string noSmithyDocumentSerde @@ -2266,8 +2398,9 @@ type DatabaseInput struct { // The location of the database (for example, an HDFS path). LocationUri *string - // These key-value pairs define parameters and properties of the database. These - // key-value pairs define parameters and properties of the database. + // These key-value pairs define parameters and properties of the database. + // + // These key-value pairs define parameters and properties of the database. Parameters map[string]string // A DatabaseIdentifier structure that describes a target database for resource @@ -2734,8 +2867,12 @@ type DeltaTarget struct { // and load (ETL) scripts. type DevEndpoint struct { - // A map of arguments used to configure the DevEndpoint . Valid arguments are: + // 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. @@ -2751,15 +2888,20 @@ type DevEndpoint struct { 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 . + // 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. + // a comma. + // + // You can only use pure Python libraries with a DevEndpoint . Libraries that rely + // on C extensions, such as the [pandas]Python data analysis library, are not currently + // supported. + // + // [pandas]: http://pandas.pydata.org/ ExtraPythonLibsS3Path *string // The reason for a current failure in this DevEndpoint . @@ -2767,13 +2909,19 @@ type DevEndpoint struct { // 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. + // ETL scripts on development endpoints. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]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 version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // The point in time at which this DevEndpoint was last modified. @@ -2786,8 +2934,10 @@ type DevEndpoint struct { 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 . + // development endpoint. + // + // The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X + // . NumberOfWorkers *int32 // A private IP address to access the DevEndpoint within a VPC if the DevEndpoint @@ -2806,11 +2956,12 @@ type DevEndpoint struct { // A list of public keys to be used by the DevEndpoints for authentication. Using // 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 operation with the public key - // content in the deletePublicKeys attribute, and the list of new keys in the - // addPublicKeys attribute. + // 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 + // operation with the public key content in the deletePublicKeys attribute, and + // the list of new keys in the addPublicKeys attribute. PublicKeys []string // The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint . @@ -2834,14 +2985,18 @@ type DevEndpoint 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.2X WorkerType // configuration, the Spark drivers for the development endpoint will run on 4 // vCPU, 16 GB of memory, and a 64 GB disk. @@ -2860,16 +3015,20 @@ type DevEndpoint struct { 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 . + // 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 - // 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. + // 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]Python data analysis library, are not currently + // supported. + // + // [pandas]: http://pandas.pydata.org/ ExtraPythonLibsS3Path *string noSmithyDocumentSerde @@ -3087,8 +3246,10 @@ type DropNullFields struct { // A structure that specifies a list of NullValueField structures that represent a // custom null value such as zero or other value being used as a null placeholder - // unique to the dataset. The DropNullFields transform removes custom null values - // only if both the value of the null placeholder and the datatype match the data. + // unique to the dataset. + // + // The DropNullFields transform removes custom null values only if both the value + // of the null placeholder and the datatype match the data. NullTextList []NullValueField noSmithyDocumentSerde @@ -3164,18 +3325,21 @@ type DynamoDBTarget struct { // Indicates whether to scan all the records, or to sample rows from the table. // 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 . + // 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 . 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 - // configured Read Capacity Unit (for tables using on-demand mode). + // 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 noSmithyDocumentSerde @@ -3496,8 +3660,11 @@ 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] in Wikipedia. + // + // [Precision and recall]: https://en.wikipedia.org/wiki/Precision_and_recall AreaUnderPRCurve *float64 // A list of ColumnImportance structures containing column importance metrics, @@ -3505,27 +3672,37 @@ 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] in Wikipedia. + // + // [Confusion matrix]: https://en.wikipedia.org/wiki/Confusion_matrix 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] in Wikipedia. + // + // [F1 score]: https://en.wikipedia.org/wiki/F1_score F1 *float64 // The precision metric indicates when often your transform is correct when it // predicts a match. Specifically, it measures how well the transform finds true - // positives from the total true positives possible. For more information, see - // Precision and recall (https://en.wikipedia.org/wiki/Precision_and_recall) in - // Wikipedia. + // positives from the total true positives possible. + // + // For more information, see [Precision and recall] in Wikipedia. + // + // [Precision and recall]: https://en.wikipedia.org/wiki/Precision_and_recall Precision *float64 // The recall metric indicates that for an actual match, how often your transform // predicts the match. Specifically, it measures how well the transform finds true - // positives from the total records in the source data. For more information, see - // Precision and recall (https://en.wikipedia.org/wiki/Precision_and_recall) in - // Wikipedia. + // positives from the total records in the source data. + // + // For more information, see [Precision and recall] in Wikipedia. + // + // [Precision and recall]: https://en.wikipedia.org/wiki/Precision_and_recall Recall *float64 noSmithyDocumentSerde @@ -3539,11 +3716,14 @@ type FindMatchesParameters struct { // cost concerns. A value of 1.0 means a bias purely for accuracy, which typically // results in a higher cost, sometimes substantially higher. A value of 0.0 means a // bias purely for cost, which results in a less accurate FindMatches transform, - // sometimes with unacceptable accuracy. Accuracy measures how well the transform - // finds true positives and true negatives. Increasing accuracy requires more - // machine resources and cost. But it also results in increased recall. Cost - // measures how many compute resources, and thus money, are consumed to run the - // transform. + // sometimes with unacceptable accuracy. + // + // Accuracy measures how well the transform finds true positives and true + // negatives. Increasing accuracy requires more machine resources and cost. But it + // also results in increased recall. + // + // Cost measures how many compute resources, and thus money, are consumed to run + // the transform. AccuracyCostTradeoff *float64 // The value to switch on or off to force the output to match the provided labels @@ -3551,6 +3731,7 @@ type FindMatchesParameters struct { // 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 // 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 @@ -3558,10 +3739,13 @@ type FindMatchesParameters struct { // and recall. A value of 0.5 means no preference; a value of 1.0 means a bias // purely for precision, and a value of 0.0 means a bias for recall. Because this // is a tradeoff, choosing values close to 1.0 means very low recall, and choosing - // values close to 0.0 results in very low precision. The precision metric - // indicates how often your model is correct when it predicts a match. The recall - // metric indicates that for an actual match, how often your model predicts the - // match. + // values close to 0.0 results in very low precision. + // + // The precision metric indicates how often your model is correct when it predicts + // a match. + // + // The recall metric indicates that for an actual match, how often your model + // predicts the match. PrecisionRecallTradeoff *float64 // The name of a column that uniquely identifies rows in the source table. Used to @@ -3656,8 +3840,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. AdditionalOptions map[string]string @@ -3741,8 +3927,9 @@ 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]. + // + // [Writing Custom Classifiers]: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html // // This member is required. GrokPattern *string @@ -3756,8 +3943,9 @@ 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]. + // + // [Writing Custom Classifiers]: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html CustomPatterns *string // The time that this classifier was last updated. @@ -3778,8 +3966,9 @@ type HudiTarget struct { ConnectionName *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]. + // + // [Catalog Tables with a Crawler]: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html Exclusions []string // The maximum depth of Amazon S3 paths that the crawler can traverse to discover @@ -3789,8 +3978,9 @@ type HudiTarget struct { // An array of Amazon S3 location strings for Hudi, each indicating the root // folder with which the metadata files for a Hudi table resides. The Hudi folder - // may be located in a child folder of the root folder. The crawler will scan all - // folders underneath a path for a Hudi folder. + // may be located in a child folder of the root folder. + // + // The crawler will scan all folders underneath a path for a Hudi folder. Paths []string noSmithyDocumentSerde @@ -3819,8 +4009,9 @@ type IcebergTarget struct { ConnectionName *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]. + // + // [Catalog Tables with a Crawler]: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html Exclusions []string // The maximum depth of Amazon S3 paths that the crawler can traverse to discover @@ -3861,8 +4052,11 @@ type JDBCConnectorOptions struct { DataTypeMapping map[string]GlueRecordType // 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 . + // + // BillingCity='Mountain View' + // + // When using a query instead of a table name, you should validate that the query + // works with the specified filterPredicate . FilterPredicate *string // The name of the job bookmark keys on which to sort. @@ -3983,13 +4177,15 @@ type JdbcTarget struct { // Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table // responses. RAWTYPES provides the native-level datatype. COMMENTS provides - // comments associated with a column or table in the database. If you do not need - // additional metadata, keep the field empty. + // comments associated with a column or table in the database. + // + // If you do not need additional metadata, keep the field empty. 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]. + // + // [Catalog Tables with a Crawler]: https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html Exclusions []string // The path of the JDBC target. @@ -4001,11 +4197,14 @@ type JdbcTarget struct { // Specifies a job definition. type Job struct { - // This field is deprecated. Use MaxCapacity instead. The number of Glue data - // 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/) . + // This field is deprecated. Use MaxCapacity instead. + // + // The number of Glue data 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]. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -4024,19 +4223,26 @@ type Job struct { CreatedOn *time.Time // The default arguments for every run of 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. 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 arguments you can - // provide to this field when configuring Spark jobs, 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. For information about the arguments you can - // provide to this field when configuring Ray jobs, see Using job parameters in - // Ray jobs (https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) - // in the developer guide. + // 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]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Spark jobs, see the [Special Parameters Used by Glue]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Ray jobs, see [Using job parameters in Ray jobs]in the developer guide. + // + // [Using job parameters in Ray jobs]: https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html + // [Calling Glue APIs in Python]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html + // [Special Parameters Used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html DefaultArguments map[string]string // A description of the job. @@ -4044,8 +4250,11 @@ type Job struct { // Indicates whether the job is run with a standard or flexible execution class. // The standard execution class is ideal for time-sensitive workloads that require - // fast job startup and dedicated resources. The flexible execution class is - // appropriate for time-insensitive jobs whose start and completion times may vary. + // 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. @@ -4057,13 +4266,18 @@ type Job struct { // In Spark jobs, GlueVersion determines the versions of Apache Spark and Python // that Glue available in a job. The Python version indicates the version supported - // for jobs of type Spark. Ray jobs should set GlueVersion to 4.0 or greater. - // However, the versions of Ray, Python and additional libraries available in your - // Ray job are determined by the Runtime parameter of the Job command. 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. + // for jobs of type Spark. + // + // Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of + // Ray, Python and additional libraries available in your Ray job are determined by + // the Runtime parameter of the Job command. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]in the developer guide. + // + // Jobs that are created without specifying a Glue version default to Glue 0.9. + // + // [Glue version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // The last point in time when this job definition was modified. @@ -4075,19 +4289,26 @@ type Job struct { // 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/) . For Glue version 2.0 or - // later jobs, you cannot specify a Maximum capacity . Instead, you should specify - // a Worker type and the Number of workers . Do not set MaxCapacity 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: + // of compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity . + // Instead, you should specify a Worker type and the Number of workers . + // + // Do not set MaxCapacity 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. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry this job after a JobRun fails. @@ -4125,16 +4346,19 @@ type Job struct { // The type of predefined worker that is allocated when a job runs. Accepts a // value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X // for Ray jobs. + // // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of // memory) with 84GB disk (approximately 34GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of // memory) with 128GB disk (approximately 77GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of // memory) with 256GB disk (approximately 235GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most @@ -4143,16 +4367,19 @@ type Job struct { // Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West // (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), // Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). + // // - For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of // memory) with 512GB disk (approximately 487GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most // demanding transforms, aggregations, joins, and queries. This worker type is // available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon // Web Services Regions as supported for the G.4X worker type. + // // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of // memory) with 84GB disk (approximately 34GB free), 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 Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of // memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray // workers based on the autoscaler. @@ -4214,9 +4441,10 @@ type JobCommand struct { // In Ray jobs, Runtime is used to specify the versions of Ray, Python and // additional libraries available in your environment. This field is not used in - // other job types. For supported runtime environment values, see Supported Ray - // runtime environments (https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html) - // in the Glue Developer Guide. + // other job types. For supported runtime environment values, see [Supported Ray runtime environments]in the Glue + // Developer Guide. + // + // [Supported Ray runtime environments]: https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html Runtime *string // Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that @@ -4238,30 +4466,40 @@ type JobNodeDetails struct { // Contains information about a job run. type JobRun struct { - // This field is deprecated. Use MaxCapacity instead. The number of Glue data - // 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/) . + // This field is deprecated. Use MaxCapacity instead. + // + // The number of Glue data 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]. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 // The job arguments associated with this run. For this job run, they replace 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. 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 arguments you can - // provide to this field when configuring Spark jobs, 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. For information about the arguments you can - // provide to this field when configuring Ray jobs, see Using job parameters in - // Ray jobs (https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) - // in the developer guide. + // 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. + // + // 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]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Spark jobs, see the [Special Parameters Used by Glue]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Ray jobs, see [Using job parameters in Ray jobs]in the developer guide. + // + // [Using job parameters in Ray jobs]: https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html + // [Calling Glue APIs in Python]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html + // [Special Parameters Used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html Arguments map[string]string // The number of the attempt to run this job. @@ -4284,8 +4522,11 @@ type JobRun struct { // Indicates whether the job is run with a standard or flexible execution class. // The standard execution-class is ideal for time-sensitive workloads that require - // fast job startup and dedicated resources. The flexible execution class is - // appropriate for time-insensitive jobs whose start and completion times may vary. + // 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. @@ -4296,13 +4537,18 @@ type JobRun struct { // In Spark jobs, GlueVersion determines the versions of Apache Spark and Python // that Glue available in a job. The Python version indicates the version supported - // for jobs of type Spark. Ray jobs should set GlueVersion to 4.0 or greater. - // However, the versions of Ray, Python and additional libraries available in your - // Ray job are determined by the Runtime parameter of the Job command. 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. + // for jobs of type Spark. + // + // Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of + // Ray, Python and additional libraries available in your Ray job are determined by + // the Runtime parameter of the Job command. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]in the developer guide. + // + // Jobs that are created without specifying a Glue version default to Glue 0.9. + // + // [Glue version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // The ID of this job run. @@ -4312,8 +4558,9 @@ 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]. + // + // [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. @@ -4330,19 +4577,26 @@ type JobRun struct { // 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/) . For Glue version 2.0+ - // jobs, you cannot specify a Maximum capacity . Instead, you should specify a - // Worker type and the Number of workers . Do not set MaxCapacity 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: + // of compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // For Glue version 2.0+ jobs, you cannot specify a Maximum capacity . Instead, you + // should specify a Worker type and the Number of workers . + // + // Do not set MaxCapacity 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. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // Specifies configuration properties of a job run notification. @@ -4367,8 +4621,10 @@ type JobRun struct { // 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. This value - // overrides the timeout value set in the parent job. Streaming jobs do not have a - // timeout. The default for non-streaming jobs is 2,880 minutes (48 hours). + // overrides the timeout value set in the parent job. + // + // Streaming jobs do not have a timeout. The default for non-streaming jobs is + // 2,880 minutes (48 hours). Timeout *int32 // The name of the trigger that started this job run. @@ -4377,16 +4633,19 @@ type JobRun struct { // The type of predefined worker that is allocated when a job runs. Accepts a // value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X // for Ray jobs. + // // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of // memory) with 84GB disk (approximately 34GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of // memory) with 128GB disk (approximately 77GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of // memory) with 256GB disk (approximately 235GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most @@ -4395,16 +4654,19 @@ type JobRun struct { // Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West // (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), // Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). + // // - For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of // memory) with 512GB disk (approximately 487GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most // demanding transforms, aggregations, joins, and queries. This worker type is // available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon // Web Services Regions as supported for the G.4X worker type. + // // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of // memory) with 84GB disk (approximately 34GB free), 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 Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of // memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray // workers based on the autoscaler. @@ -4417,11 +4679,14 @@ type JobRun struct { // job definition is completely overwritten by this information. type JobUpdate struct { - // This field is deprecated. Use MaxCapacity instead. The number of Glue data - // 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/) . + // This field is deprecated. Use MaxCapacity instead. + // + // The number of Glue data 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]. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ // // Deprecated: This property is deprecated, use MaxCapacity instead. AllocatedCapacity int32 @@ -4437,19 +4702,26 @@ type JobUpdate struct { Connections *ConnectionsList // The default arguments for every run of 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. 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 arguments you can - // provide to this field when configuring Spark jobs, 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. For information about the arguments you can - // provide to this field when configuring Ray jobs, see Using job parameters in - // Ray jobs (https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) - // in the developer guide. + // 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]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Spark jobs, see the [Special Parameters Used by Glue]topic in the developer guide. + // + // For information about the arguments you can provide to this field when + // configuring Ray jobs, see [Using job parameters in Ray jobs]in the developer guide. + // + // [Using job parameters in Ray jobs]: https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html + // [Calling Glue APIs in Python]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html + // [Special Parameters Used by Glue]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html DefaultArguments map[string]string // Description of the job being defined. @@ -4457,8 +4729,11 @@ type JobUpdate struct { // Indicates whether the job is run with a standard or flexible execution class. // The standard execution-class is ideal for time-sensitive workloads that require - // fast job startup and dedicated resources. The flexible execution class is - // appropriate for time-insensitive jobs whose start and completion times may vary. + // 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. @@ -4470,13 +4745,18 @@ type JobUpdate struct { // In Spark jobs, GlueVersion determines the versions of Apache Spark and Python // that Glue available in a job. The Python version indicates the version supported - // for jobs of type Spark. Ray jobs should set GlueVersion to 4.0 or greater. - // However, the versions of Ray, Python and additional libraries available in your - // Ray job are determined by the Runtime parameter of the Job command. 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. + // for jobs of type Spark. + // + // Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of + // Ray, Python and additional libraries available in your Ray job are determined by + // the Runtime parameter of the Job command. + // + // For more information about the available Glue versions and corresponding Spark + // and Python versions, see [Glue version]in the developer guide. + // + // Jobs that are created without specifying a Glue version default to Glue 0.9. + // + // [Glue version]: https://docs.aws.amazon.com/glue/latest/dg/add-job.html GlueVersion *string // This field is reserved for future use. @@ -4485,19 +4765,26 @@ type JobUpdate struct { // 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/) . For Glue version 2.0+ - // jobs, you cannot specify a Maximum capacity . Instead, you should specify a - // Worker type and the Number of workers . Do not set MaxCapacity 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: + // of compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // For Glue version 2.0+ jobs, you cannot specify a Maximum capacity . Instead, you + // should specify a Worker type and the Number of workers . + // + // Do not set MaxCapacity 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. + // + // [Glue pricing page]: https://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry this job if it fails. @@ -4533,16 +4820,19 @@ type JobUpdate struct { // The type of predefined worker that is allocated when a job runs. Accepts a // value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X // for Ray jobs. + // // - For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of // memory) with 84GB disk (approximately 34GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of // memory) with 128GB disk (approximately 77GB free), and provides 1 executor per // worker. We recommend this worker type for workloads such as data transforms, // joins, and queries, to offers a scalable and cost effective way to run most // jobs. + // // - For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of // memory) with 256GB disk (approximately 235GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most @@ -4551,16 +4841,19 @@ type JobUpdate struct { // Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West // (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), // Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). + // // - For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of // memory) with 512GB disk (approximately 487GB free), and provides 1 executor per // worker. We recommend this worker type for jobs whose workloads contain your most // demanding transforms, aggregations, joins, and queries. This worker type is // available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon // Web Services Regions as supported for the G.4X worker type. + // // - For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of // memory) with 84GB disk (approximately 34GB free), 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 Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of // memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray // workers based on the autoscaler. @@ -4617,9 +4910,9 @@ type JoinColumn struct { 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) - // . + // supports a subset of JsonPath, as described in [Writing JsonPath Custom Classifiers]. + // + // [Writing JsonPath Custom Classifiers]: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json // // This member is required. JsonPath *string @@ -4721,8 +5014,9 @@ type KafkaStreamingSourceOptions struct { // The timestamp of the record in the Kafka topic to start reading data from. The // possible values are a timestamp string in UTC format of the pattern // yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For - // example: "2023-04-04T08:00:00+08:00"). Only one of StartingTimestamp or - // StartingOffsets must be set. + // example: "2023-04-04T08:00:00+08:00"). + // + // Only one of StartingTimestamp or StartingOffsets must be set. StartingTimestamp *time.Time // A Java regex string that identifies the topic list to subscribe to. You must @@ -4839,9 +5133,10 @@ type KinesisStreamingSourceOptions struct { // possible values are "latest" , "trim_horizon" , "earliest" , or a timestamp // string in UTC format in the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a // UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The - // default value is "latest" . Note: Using a value that is a timestamp string in - // UTC format for "startingPosition" is supported only for Glue version 4.0 or - // later. + // default value is "latest" . + // + // Note: Using a value that is a timestamp string in UTC format for + // "startingPosition" is supported only for Glue version 4.0 or later. StartingPosition StartingPosition // The timestamp of the record in the Kinesis data stream to start reading data @@ -4936,7 +5231,9 @@ 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 CrawlerLineageSettings CrawlerLineageSettings @@ -4986,13 +5283,19 @@ 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 - // 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": - // "inner", "ToType": "Double", "Dropped": false, }] } You can specify a Mapping - // that looks like: { "FromPath": "OuterStructure", "ToKey": "OuterStructure", - // "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", - // "ToKey": "inner", "ToType": "Double", "Dropped": false, }] } + // 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": "inner", + // "ToType": "Double", "Dropped": false, }] } + // + // You can specify a Mapping that looks like: + // + // { "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", + // "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", + // "ToType": "Double", "Dropped": false, }] } Children []Mapping // If true, then the column is removed. @@ -5175,9 +5478,10 @@ 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) - // in the developer guide. + // set, the Glue compatibility defaults to Glue 0.9. For more information, see [Glue Versions]in + // the developer guide. + // + // [Glue Versions]: https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions GlueVersion *string // A list of Glue table definitions used by the transform. @@ -5195,16 +5499,23 @@ 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 . + // compute capacity and 16 GB of memory. For more information, see the [Glue pricing page]. + // + // 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. + // + // [Glue pricing page]: http://aws.amazon.com/glue/pricing/ MaxCapacity *float64 // The maximum number of times to retry after an MLTaskRun of the machine learning @@ -5216,8 +5527,9 @@ type MLTransform struct { Name *string // The number of workers of a defined workerType that are allocated when a task of - // the transform runs. If WorkerType is set, then NumberOfWorkers is required (and - // vice versa). + // the transform runs. + // + // If WorkerType is set, then NumberOfWorkers is required (and vice versa). NumberOfWorkers *int32 // A TransformParameters object. You can use parameters to tune (customize) the @@ -5229,12 +5541,15 @@ 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) - // . + // in Glue. See [Attach a Policy to IAM Users That Access Glue]. + // // - 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. + // + // [Attach a Policy to IAM Users That Access Glue]: https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html Role *string // A map of key-value pairs representing the columns and data types that this @@ -5258,17 +5573,25 @@ 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. WorkerType WorkerType @@ -5280,7 +5603,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. // @@ -5305,9 +5630,10 @@ type MongoDBTarget struct { // Indicates whether to scan all the records, or to sample rows from the table. // 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 . + // 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 . ScanAll *bool noSmithyDocumentSerde @@ -5600,11 +5926,17 @@ type PartitionIndexDescriptor struct { // This member is required. IndexName *string - // The status of the partition index. The possible statuses are: + // 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. // // This member is required. @@ -5639,10 +5971,12 @@ type PartitionInput struct { 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 - // 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. + // 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 noSmithyDocumentSerde @@ -5680,7 +6014,9 @@ type PhysicalConnectionRequirements struct { type PIIDetection struct { // Indicates the types of entities the PIIDetection transform will identify as PII - // data. PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, + // data. + // + // PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, // USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, // USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, // USA_MEDICARE_BENEFICIARY_IDENTIFIER, @@ -5884,16 +6220,21 @@ type RecipeReference 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. +// that were added since the last crawler run. For more information, see [Incremental Crawls in Glue]in the +// developer guide. +// +// [Incremental Crawls in Glue]: https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html type RecrawlPolicy struct { // Specifies whether to crawl the entire dataset again or to crawl only folders - // that were added since the last crawler run. A value of CRAWL_EVERYTHING - // specifies crawling the entire dataset again. A value of CRAWL_NEW_FOLDERS_ONLY - // specifies crawling only folders that were added since the last crawler run. A - // value of CRAWL_EVENT_MODE specifies crawling only the changes identified by + // that were added since the last crawler run. + // + // A value of CRAWL_EVERYTHING specifies crawling the entire dataset again. + // + // A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were + // added since the last crawler run. + // + // A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by // Amazon S3 events. RecrawlBehavior RecrawlBehavior @@ -6753,8 +7094,9 @@ type S3Target struct { 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]. + // + // [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. @@ -6771,10 +7113,10 @@ type S3Target struct { // A scheduling object using a cron statement to schedule an event. 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 * * ? *) . + // A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. For example, to run + // something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) . + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html ScheduleExpression *string // The state of the schedule. @@ -7363,7 +7705,11 @@ 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. + // can do: + // + // select * from SqlName + // + // and that gets data from MyDataSource. // // This member is required. SqlAliases []SqlAlias @@ -7558,9 +7904,10 @@ type StorageDescriptor struct { // The user-supplied properties in key-value form. Parameters map[string]string - // An object that references a schema stored in the Glue Schema Registry. When - // creating a table, you can pass an empty list of columns for the schema, and - // instead use a schema reference. + // An object that references a schema stored in the Glue Schema Registry. + // + // When creating a table, you can pass an empty list of columns for the schema, + // and instead use a schema reference. SchemaReference *SchemaReference // The serialization/deserialization (SerDe) information. @@ -7677,9 +8024,13 @@ type Table struct { Parameters map[string]string // 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 - // partitionKeys to an empty list. For example: "PartitionKeys": [] + // 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 partitionKeys to an empty + // list. For example: + // + // "PartitionKeys": [] PartitionKeys []Column // The retention time for this table. @@ -7691,9 +8042,12 @@ type Table struct { // The type of this table. Glue will create tables with the EXTERNAL_TABLE type. // 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 . + // + // 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 . TableType *string // A TableIdentifier structure that describes a target table for resource linking. @@ -7777,9 +8131,13 @@ type TableInput struct { Parameters map[string]string // 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 - // partitionKeys to an empty list. For example: "PartitionKeys": [] + // 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 partitionKeys to an empty + // list. For example: + // + // "PartitionKeys": [] PartitionKeys []Column // The retention time for this table. @@ -7791,9 +8149,12 @@ type TableInput struct { // The type of this table. Glue will create tables with the EXTERNAL_TABLE type. // 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 . + // + // 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 . TableType *string // A TableIdentifier structure that describes a target table for resource linking. @@ -8023,8 +8384,10 @@ type TransformConfigParameter struct { // The encryption-at-rest settings of the transform that apply to accessing user // data. Machine learning transforms can access user data encrypted in Amazon S3 -// using KMS. Additionally, imported labels and trained transforms can now be -// encrypted using a customer provided KMS key. +// using KMS. +// +// Additionally, imported labels and trained transforms can now be encrypted using +// a customer provided KMS key. type TransformEncryption struct { // An MLUserDataEncryption object containing the encryption mode and @@ -8048,9 +8411,10 @@ 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) - // in the developer guide. + // set, the Glue compatibility defaults to Glue 0.9. For more information, see [Glue Versions]in + // the developer guide. + // + // [Glue Versions]: https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions GlueVersion *string // Filter on transforms last modified after this date. @@ -8084,9 +8448,11 @@ type TransformFilterCriteria struct { // transform. 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) - // . + // The type of machine learning transform. + // + // For information about the types of machine learning transforms, see [Creating Machine Learning Transforms]. + // + // [Creating Machine Learning Transforms]: https://docs.aws.amazon.com/glue/latest/dg/add-job-machine-learning-transform.html // // This member is required. TransformType TransformType @@ -8137,10 +8503,10 @@ type Trigger struct { // The predicate of this trigger, which defines when it will fire. 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 * * ? *) . + // A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. For example, to run + // something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) . + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html Schedule *string // The current state of the trigger. @@ -8184,10 +8550,10 @@ type TriggerUpdate struct { // The predicate of this trigger, which defines when it will fire. 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 * * ? *) . + // A cron expression used to specify the schedule (see [Time-Based Schedules for Jobs and Crawlers]. For example, to run + // something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *) . + // + // [Time-Based Schedules for Jobs and Crawlers]: https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html Schedule *string noSmithyDocumentSerde @@ -8223,10 +8589,12 @@ type Union struct { // This member is required. Name *string - // Indicates the type of Union transform. Specify ALL to join all rows from data - // sources to the resulting DynamicFrame. The resulting union does not remove - // duplicate rows. Specify DISTINCT to remove duplicate rows in the resulting - // DynamicFrame. + // Indicates the type of Union transform. + // + // Specify ALL to join all rows from data sources to the resulting DynamicFrame. + // The resulting union does not remove duplicate rows. + // + // Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame. // // This member is required. UnionType UnionType @@ -8306,9 +8674,9 @@ type UpdateJsonClassifierRequest struct { Name *string // 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) - // . + // supports a subset of JsonPath, as described in [Writing JsonPath Custom Classifiers]. + // + // [Writing JsonPath Custom Classifiers]: https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json JsonPath *string noSmithyDocumentSerde @@ -8438,6 +8806,7 @@ type ViewRepresentation struct { // The expanded SQL for the view. This SQL is used by engines while processing a // query on a view. Engines may perform operations during view creation to // transform ViewOriginalText to ViewExpandedText . For example: + // // - Fully qualify identifiers: SELECT * from table1 → SELECT * from db1.table1 ViewExpandedText *string diff --git a/service/grafana/api_op_AssociateLicense.go b/service/grafana/api_op_AssociateLicense.go index eedb14a770d..72e3496f13f 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]. +// +// [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{} @@ -32,8 +32,10 @@ func (c *Client) AssociateLicense(ctx context.Context, params *AssociateLicenseI type AssociateLicenseInput struct { - // The type of license to associate with the workspace. Amazon Managed Grafana - // workspaces no longer support Grafana Enterprise free trials. + // The type of license to associate with the workspace. + // + // Amazon Managed Grafana workspaces no longer support Grafana Enterprise free + // trials. // // This member is required. LicenseType types.LicenseType @@ -44,8 +46,9 @@ type AssociateLicenseInput struct { WorkspaceId *string // A token from Grafana Labs that ties your Amazon Web Services account with a - // Grafana Labs account. For more information, see Register with Grafana Labs (https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise) - // . + // Grafana Labs account. For more information, see [Register with Grafana Labs]. + // + // [Register with Grafana Labs]: https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise GrafanaToken *string noSmithyDocumentSerde diff --git a/service/grafana/api_op_CreateWorkspace.go b/service/grafana/api_op_CreateWorkspace.go index 308875f8b0d..b9a371b0d5a 100644 --- a/service/grafana/api_op_CreateWorkspace.go +++ b/service/grafana/api_op_CreateWorkspace.go @@ -13,9 +13,11 @@ 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) -// . +// build, package, or deploy any hardware to run the Grafana server. +// +// Don't use CreateWorkspace to modify an existing workspace. Instead, use [UpdateWorkspace]. +// +// [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{} @@ -44,8 +46,9 @@ type CreateWorkspaceInput struct { // Specifies whether this workspace uses SAML 2.0, IAM Identity Center, 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) - // . + // information, see [User authentication in Amazon Managed Grafana]. + // + // [User authentication in Amazon Managed Grafana]: https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html // // This member is required. AuthenticationProviders []types.AuthenticationProviderTypes @@ -53,16 +56,21 @@ type CreateWorkspaceInput struct { // 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 - // 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. + // + // 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 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]. + // + // [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 // // This member is required. PermissionType types.PermissionType @@ -72,23 +80,27 @@ type CreateWorkspaceInput struct { 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) - // . + // information about the format and configuration options available, see [Working in your Grafana workspace]. + // + // [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 // Specifies the version of Grafana to support in the new workspace. If not - // specified, defaults to the latest version (for example, 9.4). To get a list of - // supported versions, use the ListVersions operation. + // specified, defaults to the latest version (for example, 9.4). + // + // To get a list of supported versions, use the ListVersions operation. GrafanaVersion *string - // Configuration for network access to your workspace. When this is configured, - // only listed IP addresses and VPC endpoints will be able to access your - // workspace. Standard Grafana authentication and authorization will still be - // required. If this is not configured, or is removed, then all IP addresses and - // VPC endpoints will be allowed. Standard Grafana authentication and authorization + // Configuration for network access to your workspace. + // + // When this is configured, only listed IP addresses and VPC endpoints will be + // able to access your workspace. Standard Grafana authentication and authorization + // will still be required. + // + // If this is not configured, or is removed, then all IP addresses and VPC + // endpoints will be allowed. Standard Grafana authentication and authorization // will still be required. NetworkAccessControl *types.NetworkAccessConfiguration @@ -105,15 +117,19 @@ type CreateWorkspaceInput struct { Tags map[string]string // The configuration settings for an Amazon VPC that contains data sources for - // your Grafana workspace to connect to. Connecting to a private VPC is not yet - // available in the Asia Pacific (Seoul) Region (ap-northeast-2). + // your Grafana workspace to connect to. + // + // Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) + // Region (ap-northeast-2). VpcConfiguration *types.VpcConfiguration // This parameter is for internal use only, and should not be used. WorkspaceDataSources []types.DataSourceType // A description for the workspace. This is used only to help you identify this - // workspace. Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$ + // workspace. + // + // Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$ WorkspaceDescription *string // The name for the workspace. It does not have to be unique. diff --git a/service/grafana/api_op_CreateWorkspaceApiKey.go b/service/grafana/api_op_CreateWorkspaceApiKey.go index 70e2f861e6a..1486dcca7f3 100644 --- a/service/grafana/api_op_CreateWorkspaceApiKey.go +++ b/service/grafana/api_op_CreateWorkspaceApiKey.go @@ -11,9 +11,10 @@ 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) -// for available APIs and example requests. +// authenticate requests sent to the workspace's HTTP API. See [https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html]for available APIs +// and example requests. +// +// [https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html]: https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html func (c *Client) CreateWorkspaceApiKey(ctx context.Context, params *CreateWorkspaceApiKeyInput, optFns ...func(*Options)) (*CreateWorkspaceApiKeyOutput, error) { if params == nil { params = &CreateWorkspaceApiKeyInput{} @@ -36,7 +37,9 @@ 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 diff --git a/service/grafana/api_op_DescribeWorkspaceConfiguration.go b/service/grafana/api_op_DescribeWorkspaceConfiguration.go index 5215e8ada32..18b3017152c 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]. + // + // [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_ListWorkspaces.go b/service/grafana/api_op_ListWorkspaces.go index 5fc366b751c..416641ad592 100644 --- a/service/grafana/api_op_ListWorkspaces.go +++ b/service/grafana/api_op_ListWorkspaces.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} diff --git a/service/grafana/api_op_TagResource.go b/service/grafana/api_op_TagResource.go index 833efb3267f..0a85b127047 100644 --- a/service/grafana/api_op_TagResource.go +++ b/service/grafana/api_op_TagResource.go @@ -11,9 +11,10 @@ import ( ) // The TagResource operation associates tags with an Amazon Managed Grafana -// resource. Currently, the only resource that can be tagged is workspaces. If you -// specify a new tag key for the resource, this tag is appended to the list of tags -// associated with the resource. If you specify a tag key that is already +// resource. Currently, the only resource that can be tagged is workspaces. +// +// If you specify a new tag key for the resource, this tag is appended to the list +// of tags associated with the resource. 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { diff --git a/service/grafana/api_op_UpdateWorkspace.go b/service/grafana/api_op_UpdateWorkspace.go index 18566f84fa5..5bf521ad08a 100644 --- a/service/grafana/api_op_UpdateWorkspace.go +++ b/service/grafana/api_op_UpdateWorkspace.go @@ -13,12 +13,16 @@ import ( // 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) -// . +// parameters are not changed. +// +// To modify the user authentication methods that the workspace uses, such as SAML +// or IAM Identity Center, use [UpdateWorkspaceAuthentication]. +// +// To modify which users in the workspace have the Admin and Editor Grafana roles, +// use [UpdatePermissions]. +// +// [UpdatePermissions]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html +// [UpdateWorkspaceAuthentication]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html func (c *Client) UpdateWorkspace(ctx context.Context, params *UpdateWorkspaceInput, optFns ...func(*Options)) (*UpdateWorkspaceOutput, error) { if params == nil { params = &UpdateWorkspaceInput{} @@ -48,11 +52,14 @@ type UpdateWorkspaceInput struct { // access in the workspaceOrganizationalUnits parameter. AccountAccessType types.AccountAccessType - // The configuration settings for network access to your workspace. When this is - // configured, only listed IP addresses and VPC endpoints will be able to access - // your workspace. Standard Grafana authentication and authorization will still be - // required. If this is not configured, or is removed, then all IP addresses and - // VPC endpoints will be allowed. Standard Grafana authentication and authorization + // The configuration settings for network access to your workspace. + // + // When this is configured, only listed IP addresses and VPC endpoints will be + // able to access your workspace. Standard Grafana authentication and authorization + // will still be required. + // + // If this is not configured, or is removed, then all IP addresses and VPC + // endpoints will be allowed. Standard Grafana authentication and authorization // will still be required. NetworkAccessControl *types.NetworkAccessConfiguration @@ -67,28 +74,39 @@ type UpdateWorkspaceInput struct { // 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) + // 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] + // // 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) // . + // + // 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]. + // + // [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 + // [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. + // 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 // and VPC endpoints will be allowed. Standard Grafana authentication and // authorization will still be required. RemoveNetworkAccessConfiguration *bool - // Whether to remove the VPC configuration from the workspace. Setting this to true - // and providing a vpcConfiguration to set will return an error. + // Whether to remove the VPC configuration from the workspace. + // + // Setting this to true 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 diff --git a/service/grafana/api_op_UpdateWorkspaceAuthentication.go b/service/grafana/api_op_UpdateWorkspaceAuthentication.go index 92888f07bf4..bce6cdb2882 100644 --- a/service/grafana/api_op_UpdateWorkspaceAuthentication.go +++ b/service/grafana/api_op_UpdateWorkspaceAuthentication.go @@ -14,8 +14,10 @@ import ( // Use this operation to define the identity provider (IdP) that this workspace // authenticates users from, using SAML. You can also map SAML assertion attributes // to workspace user information and define which groups in the assertion attribute -// are to have the Admin and Editor roles in the workspace. Changes to the -// authentication method for a workspace may take a few minutes to take effect. +// are to have the Admin and Editor roles in the workspace. +// +// Changes to the authentication method for a workspace may take a few minutes to +// take effect. func (c *Client) UpdateWorkspaceAuthentication(ctx context.Context, params *UpdateWorkspaceAuthenticationInput, optFns ...func(*Options)) (*UpdateWorkspaceAuthenticationOutput, error) { if params == nil { params = &UpdateWorkspaceAuthenticationInput{} @@ -35,8 +37,9 @@ type UpdateWorkspaceAuthenticationInput struct { // Specifies whether this workspace uses SAML 2.0, IAM Identity Center, 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) - // . + // information, see [User authentication in Amazon Managed Grafana]. + // + // [User authentication in Amazon 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 15e71b1bfa9..955eef0b0c4 100644 --- a/service/grafana/api_op_UpdateWorkspaceConfiguration.go +++ b/service/grafana/api_op_UpdateWorkspaceConfiguration.go @@ -29,9 +29,9 @@ func (c *Client) UpdateWorkspaceConfiguration(ctx context.Context, params *Updat 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) - // . + // format and configuration options available, see [Working in your Grafana workspace]. + // + // [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 // @@ -44,11 +44,15 @@ type UpdateWorkspaceConfigurationInput struct { WorkspaceId *string // Specifies the version of Grafana to support in the workspace. If not specified, - // keeps the current version of the workspace. Can only be used to upgrade (for - // example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4). To know - // what versions are available to upgrade to for a specific workspace, see the - // ListVersions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html) - // operation. + // keeps the current version of the workspace. + // + // Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for + // example, from 9.4 to 8.4). + // + // To know what versions are available to upgrade to for a specific workspace, see + // the [ListVersions]operation. + // + // [ListVersions]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html GrafanaVersion *string noSmithyDocumentSerde diff --git a/service/grafana/doc.go b/service/grafana/doc.go index 149ca668cb4..f96c41b19af 100644 --- a/service/grafana/doc.go +++ b/service/grafana/doc.go @@ -7,9 +7,10 @@ // that you can use to instantly query, correlate, and visualize operational // metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it // easy to deploy, operate, and scale Grafana, a widely deployed data visualization -// tool that is popular for its extensible data support. With Amazon Managed -// Grafana, you create logically isolated Grafana servers called workspaces. In a -// workspace, you can create Grafana dashboards and visualizations to analyze your -// metrics, logs, and traces without having to build, package, or deploy any -// hardware to run Grafana servers. +// tool that is popular for its extensible data support. +// +// With Amazon Managed Grafana, you create logically isolated Grafana servers +// called workspaces. In a workspace, you can create Grafana dashboards and +// visualizations to analyze your metrics, logs, and traces without having to +// build, package, or deploy any hardware to run Grafana servers. package grafana diff --git a/service/grafana/options.go b/service/grafana/options.go index 07343295723..134ee4aa58b 100644 --- a/service/grafana/options.go +++ b/service/grafana/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/grafana/types/enums.go b/service/grafana/types/enums.go index 4194b704a20..1427c151525 100644 --- a/service/grafana/types/enums.go +++ b/service/grafana/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AccountAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountAccessType) Values() []AccountAccessType { return []AccountAccessType{ "CURRENT_ACCOUNT", @@ -37,6 +38,7 @@ const ( // Values returns all known values for AuthenticationProviderTypes. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationProviderTypes) Values() []AuthenticationProviderTypes { return []AuthenticationProviderTypes{ @@ -70,8 +72,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "AMAZON_OPENSEARCH_SERVICE", @@ -97,8 +100,9 @@ const ( ) // Values returns all known values for LicenseType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseType) Values() []LicenseType { return []LicenseType{ "ENTERPRISE", @@ -116,6 +120,7 @@ const ( // Values returns all known values for NotificationDestinationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NotificationDestinationType) Values() []NotificationDestinationType { return []NotificationDestinationType{ @@ -134,8 +139,9 @@ const ( ) // Values returns all known values for PermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionType) Values() []PermissionType { return []PermissionType{ "CUSTOMER_MANAGED", @@ -156,8 +162,9 @@ const ( ) // Values returns all known values for Role. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Role) Values() []Role { return []Role{ "ADMIN", @@ -177,8 +184,9 @@ const ( ) // Values returns all known values for SamlConfigurationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SamlConfigurationStatus) Values() []SamlConfigurationStatus { return []SamlConfigurationStatus{ "CONFIGURED", @@ -197,8 +205,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -217,8 +226,9 @@ const ( ) // Values returns all known values for UserType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserType) Values() []UserType { return []UserType{ "SSO_USER", @@ -238,6 +248,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -281,8 +292,9 @@ const ( ) // Values returns all known values for WorkspaceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceStatus) Values() []WorkspaceStatus { return []WorkspaceStatus{ "ACTIVE", diff --git a/service/grafana/types/types.go b/service/grafana/types/types.go index 2200bf642d5..74ec8923a8f 100644 --- a/service/grafana/types/types.go +++ b/service/grafana/types/types.go @@ -122,26 +122,39 @@ type IdpMetadataMemberXml struct { func (*IdpMetadataMemberXml) isIdpMetadata() {} -// The configuration settings for in-bound network access to your workspace. When -// this is configured, only listed IP addresses and VPC endpoints will be able to -// access your workspace. Standard Grafana authentication and authorization are -// still required. Access is granted to a caller that is in either the IP address -// list or the VPC endpoint list - they do not need to be in both. If this is not -// configured, or is removed, then all IP addresses and VPC endpoints are allowed. -// Standard Grafana authentication and authorization are still required. While both -// prefixListIds and vpceIds are required, you can pass in an empty array of -// strings for either parameter if you do not want to allow any of that type. If -// both are passed as empty arrays, no traffic is allowed to the workspace, because -// only explicitly allowed connections are accepted. +// The configuration settings for in-bound network access to your workspace. +// +// When this is configured, only listed IP addresses and VPC endpoints will be +// able to access your workspace. Standard Grafana authentication and authorization +// are still required. +// +// Access is granted to a caller that is in either the IP address list or the VPC +// endpoint list - they do not need to be in both. +// +// If this is not configured, or is removed, then all IP addresses and VPC +// endpoints are allowed. Standard Grafana authentication and authorization are +// still required. +// +// While both prefixListIds and vpceIds are required, you can pass in an empty +// array of strings for either parameter if you do not want to allow any of that +// type. +// +// If both are passed as empty arrays, no traffic is allowed to the workspace, +// because only explicitly allowed connections are accepted. type NetworkAccessConfiguration struct { // An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP // addresses. The IP addresses specified are allowed to access your workspace. If // the list is not included in the configuration (passed an empty array) then no IP // addresses are 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. + // 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]in the Amazon Virtual Private + // Cloud User Guide. + // + // [Group CIDR blocks using managed prefix lists]: https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html // // This member is required. PrefixListIds []string @@ -150,13 +163,18 @@ type NetworkAccessConfiguration struct { // endpoints to your Amazon Managed Grafana workspace for access from within a VPC. // If a NetworkAccessConfiguration is specified then only VPC endpoints specified // here are allowed to access the workspace. If you pass in an empty array of - // strings, then no VPCs are 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 - // com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints - // are ignored. + // strings, then no VPCs are 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] 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 are ignored. + // + // [Interface VPC endpoints]: https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints // // This member is required. VpceIds []string @@ -243,8 +261,9 @@ 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) -// operation. +// an [UpdatePermissions]operation. +// +// [UpdatePermissions]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html type UpdateError struct { // Specifies which permission update caused the error. @@ -265,9 +284,10 @@ type UpdateError struct { noSmithyDocumentSerde } -// Contains the instructions for one Grafana role permission update in a -// UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) +// Contains the instructions for one Grafana role permission update in a [UpdatePermissions] // operation. +// +// [UpdatePermissions]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html type UpdateInstruction struct { // Specifies whether this update is to add or revoke role permissions. @@ -291,7 +311,9 @@ type UpdateInstruction struct { // A structure that specifies one user or group in the workspace. type User struct { - // The ID of the user or group. Pattern: + // The ID of the user or group. + // + // Pattern: // ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ // // This member is required. @@ -323,9 +345,12 @@ type ValidationExceptionField struct { } // 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. Connecting to a private VPC is not yet available -// in the Asia Pacific (Seoul) Region (ap-northeast-2). +// your Grafana workspace to connect to. +// +// Provided securityGroupIds and subnetIds must be part of the same VPC. +// +// Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) +// Region (ap-northeast-2). type VpcConfiguration struct { // The list of Amazon EC2 security group IDs attached to the Amazon VPC for your @@ -360,9 +385,10 @@ type WorkspaceDescription struct { // 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 . + // 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 . // // This member is required. DataSources []DataSourceType @@ -403,18 +429,23 @@ type WorkspaceDescription struct { Description *string // Specifies whether this workspace has already fully used its free trial for - // Grafana Enterprise. Amazon Managed Grafana workspaces no longer support Grafana - // Enterprise free trials. + // Grafana Enterprise. + // + // Amazon Managed Grafana workspaces no longer support Grafana Enterprise free + // trials. FreeTrialConsumed *bool // If this workspace is currently in the free trial period for Grafana Enterprise, - // this value specifies when that free trial ends. Amazon Managed Grafana - // workspaces no longer support Grafana Enterprise free trials. + // this value specifies when that free trial ends. + // + // Amazon Managed Grafana workspaces no longer support Grafana Enterprise free + // trials. FreeTrialExpiration *time.Time // The token that ties this workspace to a Grafana Labs account. For more - // information, see Register with Grafana Labs (https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise) - // . + // information, see [Register with Grafana Labs]. + // + // [Register with Grafana Labs]: https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise GrafanaToken *string // If this workspace has a full Grafana Enterprise license purchased through @@ -424,8 +455,10 @@ type WorkspaceDescription struct { // removed. LicenseExpiration *time.Time - // Specifies whether this workspace has a full Grafana Enterprise license. Amazon - // Managed Grafana workspaces no longer support Grafana Enterprise free trials. + // Specifies whether this workspace has a full Grafana Enterprise license. + // + // Amazon Managed Grafana workspaces no longer support Grafana Enterprise free + // trials. LicenseType LicenseType // The name of the workspace. @@ -450,17 +483,22 @@ type WorkspaceDescription struct { // 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 - // 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) + // 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] // . 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) + // customer managed workspaces, see [Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels] + // + // [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 + // [Managing permissions for data sources and notification channels]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html PermissionType PermissionType // The name of the CloudFormation stack set that is used to generate IAM roles to @@ -524,12 +562,15 @@ type WorkspaceSummary struct { Description *string // The token that ties this workspace to a Grafana Labs account. For more - // information, see Register with Grafana Labs (https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise) - // . + // information, see [Register with Grafana Labs]. + // + // [Register with Grafana Labs]: https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise GrafanaToken *string - // Specifies whether this workspace has a full Grafana Enterprise license. Amazon - // Managed Grafana workspaces no longer support Grafana Enterprise free trials. + // Specifies whether this workspace has a full Grafana Enterprise license. + // + // Amazon Managed Grafana workspaces no longer support Grafana Enterprise free + // trials. LicenseType LicenseType // The name of the workspace. diff --git a/service/greengrass/options.go b/service/greengrass/options.go index 0d05863cc73..0855ffc3628 100644 --- a/service/greengrass/options.go +++ b/service/greengrass/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/greengrass/types/enums.go b/service/greengrass/types/enums.go index f13eb8b09e6..823a5f93ec6 100644 --- a/service/greengrass/types/enums.go +++ b/service/greengrass/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for BulkDeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BulkDeploymentStatus) Values() []BulkDeploymentStatus { return []BulkDeploymentStatus{ "Initializing", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for ConfigurationSyncStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationSyncStatus) Values() []ConfigurationSyncStatus { return []ConfigurationSyncStatus{ "InSync", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for DeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentType) Values() []DeploymentType { return []DeploymentType{ "NewDeployment", @@ -77,8 +80,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -95,8 +99,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "GreengrassContainer", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for LoggerComponent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoggerComponent) Values() []LoggerComponent { return []LoggerComponent{ "GreengrassSystem", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for LoggerLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoggerLevel) Values() []LoggerLevel { return []LoggerLevel{ "DEBUG", @@ -155,8 +162,9 @@ const ( ) // Values returns all known values for LoggerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoggerType) Values() []LoggerType { return []LoggerType{ "FileSystem", @@ -173,8 +181,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "ro", @@ -191,8 +200,9 @@ const ( ) // Values returns all known values for SoftwareToUpdate. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SoftwareToUpdate) Values() []SoftwareToUpdate { return []SoftwareToUpdate{ "core", @@ -209,8 +219,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -233,8 +244,9 @@ const ( ) // Values returns all known values for UpdateAgentLogLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateAgentLogLevel) Values() []UpdateAgentLogLevel { return []UpdateAgentLogLevel{ "NONE", @@ -260,6 +272,7 @@ const ( // Values returns all known values for UpdateTargetsArchitecture. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (UpdateTargetsArchitecture) Values() []UpdateTargetsArchitecture { return []UpdateTargetsArchitecture{ @@ -282,8 +295,9 @@ const ( // 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. +// 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/greengrassv2/api_op_AssociateServiceRoleToAccount.go b/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go index 1620b2ed81a..5588c711497 100644 --- a/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go +++ b/service/greengrassv2/api_op_AssociateServiceRoleToAccount.go @@ -13,12 +13,13 @@ import ( // Associates a Greengrass service role 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. The role must include the -// 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) -// in the IoT Greengrass Version 2 Developer Guide. +// connectivity information. The role must include the [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]in the IoT Greengrass Version 2 Developer +// Guide. +// +// [AWSGreengrassResourceAccessRolePolicy]: https://console.aws.amazon.com/iam/home#/policies/arn:awsiam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy +// [Greengrass service role]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html func (c *Client) AssociateServiceRoleToAccount(ctx context.Context, params *AssociateServiceRoleToAccountInput, optFns ...func(*Options)) (*AssociateServiceRoleToAccountOutput, error) { if params == nil { params = &AssociateServiceRoleToAccountInput{} diff --git a/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go b/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go index d811bb393fe..85e9bdaaa0a 100644 --- a/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go +++ b/service/greengrassv2/api_op_BatchAssociateClientDeviceWithCoreDevice.go @@ -15,13 +15,16 @@ 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) -// 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) -// in the IoT Greengrass V2 Developer Guide. +// more information, see [Configure cloud discovery]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]in the IoT Greengrass V2 Developer Guide. +// +// [Configure cloud discovery]: https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html +// [Interact with local IoT devices]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html func (c *Client) BatchAssociateClientDeviceWithCoreDevice(ctx context.Context, params *BatchAssociateClientDeviceWithCoreDeviceInput, optFns ...func(*Options)) (*BatchAssociateClientDeviceWithCoreDeviceOutput, error) { if params == nil { params = &BatchAssociateClientDeviceWithCoreDeviceInput{} diff --git a/service/greengrassv2/api_op_CreateComponentVersion.go b/service/greengrassv2/api_op_CreateComponentVersion.go index 63558566820..ca186922066 100644 --- a/service/greengrassv2/api_op_CreateComponentVersion.go +++ b/service/greengrassv2/api_op_CreateComponentVersion.go @@ -15,30 +15,57 @@ import ( // Creates a component. Components are software that run on Greengrass core // devices. After you develop and test a component on your core device, you can use // 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: +// 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]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. +// +// - 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. +// +// [IoT Greengrass component recipe reference]: https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html func (c *Client) CreateComponentVersion(ctx context.Context, params *CreateComponentVersionInput, optFns ...func(*Options)) (*CreateComponentVersionOutput, error) { if params == nil { params = &CreateComponentVersionInput{} @@ -67,16 +94,20 @@ 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 . + // The parameters to create a component from a Lambda function. + // + // You must specify 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -105,8 +136,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 213fbd2951e..aea2d39859f 100644 --- a/service/greengrassv2/api_op_CreateDeployment.go +++ b/service/greengrassv2/api_op_CreateDeployment.go @@ -14,14 +14,19 @@ import ( // Creates a continuous deployment for a target, which is a Greengrass core device // or group of core devices. When you add a new core device to a group of core // devices that has a deployment, IoT Greengrass deploys that group's deployment to -// the new device. You can define one deployment for each target. When you create a -// new deployment for a target that has an existing deployment, you replace the -// previous deployment. IoT Greengrass applies the new deployment to the target -// 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) -// in the IoT Greengrass V2 Developer Guide. +// the new device. +// +// You can define one deployment for each target. When you create a new deployment +// for a target that has an existing deployment, you replace the previous +// deployment. IoT Greengrass applies the new deployment to the target 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] in the IoT Greengrass V2 Developer Guide. +// +// [Create deployments]: https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error) { if params == nil { params = &CreateDeploymentInput{} @@ -39,10 +44,11 @@ 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] of the target IoT thing or thing group. When creating a subdeployment, the // targetARN can only be a thing group. // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // // This member is required. TargetArn *string @@ -72,13 +78,15 @@ 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) - // within a subdeployment. + // The parent deployment's target [ARN] within a subdeployment. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -89,8 +97,9 @@ 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] of the IoT job that applies the deployment to target devices. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 dc6f1588293..d4ad50469ad 100644 --- a/service/greengrassv2/api_op_DeleteComponent.go +++ b/service/greengrassv2/api_op_DeleteComponent.go @@ -10,11 +10,12 @@ 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,8 +33,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string diff --git a/service/greengrassv2/api_op_DeleteCoreDevice.go b/service/greengrassv2/api_op_DeleteCoreDevice.go index fbbe770e3e1..9b0096cdda7 100644 --- a/service/greengrassv2/api_op_DeleteCoreDevice.go +++ b/service/greengrassv2/api_op_DeleteCoreDevice.go @@ -12,9 +12,10 @@ 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. +// IoT thing. For more information about how to delete the IoT thing, see [DeleteThing]in the +// IoT API Reference. +// +// [DeleteThing]: https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html 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 c088a1b534f..1f768fe5fcb 100644 --- a/service/greengrassv2/api_op_DeleteDeployment.go +++ b/service/greengrassv2/api_op_DeleteDeployment.go @@ -11,11 +11,14 @@ 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]. +// +// 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. +// +// [CancelDeployment]: https://docs.aws.amazon.com/iot/latest/apireference/API_CancelDeployment.html func (c *Client) DeleteDeployment(ctx context.Context, params *DeleteDeploymentInput, optFns ...func(*Options)) (*DeleteDeploymentOutput, error) { if params == nil { params = &DeleteDeploymentInput{} diff --git a/service/greengrassv2/api_op_DescribeComponent.go b/service/greengrassv2/api_op_DescribeComponent.go index fd38f7fcc09..a397f13b395 100644 --- a/service/greengrassv2/api_op_DescribeComponent.go +++ b/service/greengrassv2/api_op_DescribeComponent.go @@ -30,8 +30,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -41,8 +42,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The name of the component. @@ -68,8 +70,9 @@ 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html 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 0ee6ce61c7c..044954723c0 100644 --- a/service/greengrassv2/api_op_DisassociateServiceRoleFromAccount.go +++ b/service/greengrassv2/api_op_DisassociateServiceRoleFromAccount.go @@ -13,8 +13,10 @@ 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) -// in the IoT Greengrass Version 2 Developer Guide. +// connectivity information. For more information, see [Greengrass service role]in the IoT Greengrass +// Version 2 Developer Guide. +// +// [Greengrass service role]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html func (c *Client) DisassociateServiceRoleFromAccount(ctx context.Context, params *DisassociateServiceRoleFromAccountInput, optFns ...func(*Options)) (*DisassociateServiceRoleFromAccountOutput, error) { if params == nil { params = &DisassociateServiceRoleFromAccountInput{} diff --git a/service/greengrassv2/api_op_GetComponent.go b/service/greengrassv2/api_op_GetComponent.go index 1438a9a794c..0b7c0788254 100644 --- a/service/greengrassv2/api_op_GetComponent.go +++ b/service/greengrassv2/api_op_GetComponent.go @@ -29,8 +29,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -54,8 +55,9 @@ 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html 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 d21db505fa3..4b6931cd11d 100644 --- a/service/greengrassv2/api_op_GetComponentVersionArtifact.go +++ b/service/greengrassv2/api_op_GetComponentVersionArtifact.go @@ -30,18 +30,22 @@ 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 - // version. + // The [ARN] of the component version. Specify the ARN of a public or a Lambda + // component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // 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 . + // The name of the artifact. + // + // You can use the [GetComponent] 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 . + // + // [GetComponent]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html // // This member is required. ArtifactName *string diff --git a/service/greengrassv2/api_op_GetConnectivityInfo.go b/service/greengrassv2/api_op_GetConnectivityInfo.go index 5ebfc7269af..88b48a3ea20 100644 --- a/service/greengrassv2/api_op_GetConnectivityInfo.go +++ b/service/greengrassv2/api_op_GetConnectivityInfo.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the IoT Greengrass Version 2 Developer Guide. +// 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], +// 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]in the IoT +// Greengrass Version 2 Developer Guide. +// +// [Connect client devices to core devices]: https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html +// [IoT Greengrass discovery API]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html func (c *Client) GetConnectivityInfo(ctx context.Context, params *GetConnectivityInfoInput, optFns ...func(*Options)) (*GetConnectivityInfoOutput, error) { if params == nil { params = &GetConnectivityInfoInput{} diff --git a/service/greengrassv2/api_op_GetCoreDevice.go b/service/greengrassv2/api_op_GetCoreDevice.go index 880d54e63b2..60534791e67 100644 --- a/service/greengrassv2/api_op_GetCoreDevice.go +++ b/service/greengrassv2/api_op_GetCoreDevice.go @@ -12,21 +12,29 @@ import ( "time" ) -// Retrieves metadata for a Greengrass core device. 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: +// Retrieves metadata for a Greengrass core device. +// +// 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 +// +// - At a [regular interval that you can configure], which defaults to 24 hours +// // - For IoT Greengrass Core v2.7.0, the core device sends status updates upon // local deployment and cloud deployment +// +// [regular interval that you can configure]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss func (c *Client) GetCoreDevice(ctx context.Context, params *GetCoreDeviceInput, optFns ...func(*Options)) (*GetCoreDeviceOutput, error) { if params == nil { params = &GetCoreDeviceInput{} @@ -62,9 +70,10 @@ 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) - // in the IoT Greengrass V2 Developer Guide. + // runs on the core device. For more information, see the [Greengrass nucleus component]in the IoT Greengrass V2 + // Developer Guide. + // + // [Greengrass nucleus component]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html CoreVersion *string // The time at which the core device's status last updated, expressed in ISO 8601 @@ -75,15 +84,18 @@ 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. 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html 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 da4b9cace89..670c79664c0 100644 --- a/service/greengrassv2/api_op_GetDeployment.go +++ b/service/greengrassv2/api_op_GetDeployment.go @@ -62,8 +62,9 @@ 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] of the IoT job that applies the deployment to target devices. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html IotJobArn *string // The job configuration for the deployment configuration. The job configuration @@ -77,20 +78,23 @@ 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) - // within a subdeployment. + // The parent deployment's target [ARN] within a subdeployment. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ParentTargetArn *string // The revision number of the deployment. 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html 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] of the target IoT thing or thing group. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 d98b22aba93..200e0dc4512 100644 --- a/service/greengrassv2/api_op_GetServiceRoleForAccount.go +++ b/service/greengrassv2/api_op_GetServiceRoleForAccount.go @@ -13,8 +13,10 @@ 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) -// in the IoT Greengrass Version 2 Developer Guide. +// connectivity information. For more information, see [Greengrass service role]in the IoT Greengrass +// Version 2 Developer Guide. +// +// [Greengrass service role]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html func (c *Client) GetServiceRoleForAccount(ctx context.Context, params *GetServiceRoleForAccountInput, optFns ...func(*Options)) (*GetServiceRoleForAccountOutput, error) { if params == nil { params = &GetServiceRoleForAccountInput{} diff --git a/service/greengrassv2/api_op_ListComponentVersions.go b/service/greengrassv2/api_op_ListComponentVersions.go index 212c7f9b799..bd43eb7fc89 100644 --- a/service/greengrassv2/api_op_ListComponentVersions.go +++ b/service/greengrassv2/api_op_ListComponentVersions.go @@ -30,8 +30,9 @@ 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] of the component. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string diff --git a/service/greengrassv2/api_op_ListComponents.go b/service/greengrassv2/api_op_ListComponents.go index d52aa66bffd..13e8a580e02 100644 --- a/service/greengrassv2/api_op_ListComponents.go +++ b/service/greengrassv2/api_op_ListComponents.go @@ -36,7 +36,9 @@ type ListComponentsInput struct { // The token to be used for the next set of paginated results. NextToken *string - // The scope of the components to list. Default: PRIVATE + // The scope of the components to list. + // + // Default: PRIVATE Scope types.ComponentVisibilityScope noSmithyDocumentSerde diff --git a/service/greengrassv2/api_op_ListCoreDevices.go b/service/greengrassv2/api_op_ListCoreDevices.go index 0989f33aba3..a31c665cbcb 100644 --- a/service/greengrassv2/api_op_ListCoreDevices.go +++ b/service/greengrassv2/api_op_ListCoreDevices.go @@ -11,21 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of Greengrass core devices. 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: +// Retrieves a paginated list of Greengrass core devices. +// +// 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 +// +// - At a [regular interval that you can configure], which defaults to 24 hours +// // - For IoT Greengrass Core v2.7.0, the core device sends status updates upon // local deployment and cloud deployment +// +// [regular interval that you can configure]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss func (c *Client) ListCoreDevices(ctx context.Context, params *ListCoreDevicesInput, optFns ...func(*Options)) (*ListCoreDevicesOutput, error) { if params == nil { params = &ListCoreDevicesInput{} @@ -52,17 +60,20 @@ 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. 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 + // The [ARN] 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. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ThingGroupArn *string noSmithyDocumentSerde diff --git a/service/greengrassv2/api_op_ListDeployments.go b/service/greengrassv2/api_op_ListDeployments.go index 101f651283c..16978247681 100644 --- a/service/greengrassv2/api_op_ListDeployments.go +++ b/service/greengrassv2/api_op_ListDeployments.go @@ -30,8 +30,11 @@ 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. + // // Default: LATEST_ONLY HistoryFilter types.DeploymentHistoryFilter @@ -41,12 +44,14 @@ 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) - // within a subdeployment. + // The parent deployment's target [ARN] within a subdeployment. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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] of the target IoT thing or thing group. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html TargetArn *string noSmithyDocumentSerde diff --git a/service/greengrassv2/api_op_ListInstalledComponents.go b/service/greengrassv2/api_op_ListInstalledComponents.go index a0c94dd8256..fee8434e860 100644 --- a/service/greengrassv2/api_op_ListInstalledComponents.go +++ b/service/greengrassv2/api_op_ListInstalledComponents.go @@ -14,21 +14,29 @@ import ( // 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: +// 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 +// +// - At a [regular interval that you can configure], which defaults to 24 hours +// // - For IoT Greengrass Core v2.7.0, the core device sends status updates upon // local deployment and cloud deployment +// +// [regular interval that you can configure]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration-fss func (c *Client) ListInstalledComponents(ctx context.Context, params *ListInstalledComponentsInput, optFns ...func(*Options)) (*ListInstalledComponentsOutput, error) { if params == nil { params = &ListInstalledComponentsInput{} @@ -58,10 +66,13 @@ 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 TopologyFilter types.InstalledComponentTopologyFilter @@ -70,10 +81,13 @@ type ListInstalledComponentsInput struct { type ListInstalledComponentsOutput struct { - // A list that summarizes each component on the core device. Greengrass nucleus - // v2.7.0 or later is required to get an accurate lastStatusChangeTimestamp - // response. This response can be inaccurate in earlier Greengrass nucleus - // versions. Greengrass nucleus v2.8.0 or later is required to get an accurate + // A list that summarizes each component on the core device. + // + // Greengrass nucleus v2.7.0 or later is required to get an accurate + // lastStatusChangeTimestamp response. This response can be inaccurate in earlier + // Greengrass nucleus versions. + // + // Greengrass nucleus v2.8.0 or later is required to get an accurate // lastInstallationSource and lastReportedTimestamp response. This response can be // inaccurate or null in earlier Greengrass nucleus versions. InstalledComponents []types.InstalledComponent diff --git a/service/greengrassv2/api_op_ListTagsForResource.go b/service/greengrassv2/api_op_ListTagsForResource.go index ec3025fb653..91ea35296a0 100644 --- a/service/greengrassv2/api_op_ListTagsForResource.go +++ b/service/greengrassv2/api_op_ListTagsForResource.go @@ -28,8 +28,9 @@ 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] of the resource. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string @@ -40,8 +41,9 @@ 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html 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 b988bb2656e..fe8a2ae5135 100644 --- a/service/greengrassv2/api_op_ResolveComponentCandidates.go +++ b/service/greengrassv2/api_op_ResolveComponentCandidates.go @@ -13,18 +13,23 @@ import ( // Retrieves a list of components that meet the component, version, and platform // requirements of a deployment. Greengrass core devices call this operation when -// they receive a deployment to identify the components to install. This operation -// identifies components that meet all dependency requirements for a deployment. If -// the requirements conflict, then this operation returns an error and the -// deployment fails. For example, this occurs if component A requires version -// >2.0.0 and component B requires version <2.0.0 of a component dependency. When -// you specify the component candidates to resolve, IoT Greengrass compares each -// component's digest from the core device with the component's digest in the +// they receive a deployment to identify the components to install. +// +// This operation identifies components that meet all dependency requirements for +// a deployment. If the requirements conflict, then this operation returns an error +// and the deployment fails. For example, this occurs if component A requires +// version >2.0.0 and component B requires version <2.0.0 of a component +// dependency. +// +// When you specify the component candidates to resolve, IoT Greengrass compares +// each component's digest from the core device with the component's digest in the // Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass -// 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) . +// 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]. +// +// [IoT Greengrass endpoints and 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{} diff --git a/service/greengrassv2/api_op_TagResource.go b/service/greengrassv2/api_op_TagResource.go index 9f14ff907ce..f817ef2aa66 100644 --- a/service/greengrassv2/api_op_TagResource.go +++ b/service/greengrassv2/api_op_TagResource.go @@ -29,15 +29,17 @@ 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] of the resource to tag. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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]in the IoT Greengrass V2 Developer Guide. + // + // [Tag your resources]: https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html // // 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 cc0c7d639f8..2b6b2bb7458 100644 --- a/service/greengrassv2/api_op_UntagResource.go +++ b/service/greengrassv2/api_op_UntagResource.go @@ -28,8 +28,9 @@ 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] of the resource to untag. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/greengrassv2/api_op_UpdateConnectivityInfo.go b/service/greengrassv2/api_op_UpdateConnectivityInfo.go index 94458d78511..b035d94b909 100644 --- a/service/greengrassv2/api_op_UpdateConnectivityInfo.go +++ b/service/greengrassv2/api_op_UpdateConnectivityInfo.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// in the IoT Greengrass Version 2 Developer Guide. +// 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], +// 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]in the IoT +// Greengrass Version 2 Developer Guide. +// +// [Connect client devices to core devices]: https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html +// [IoT Greengrass discovery API]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html func (c *Client) UpdateConnectivityInfo(ctx context.Context, params *UpdateConnectivityInfoInput, optFns ...func(*Options)) (*UpdateConnectivityInfoOutput, error) { if params == nil { params = &UpdateConnectivityInfoInput{} diff --git a/service/greengrassv2/doc.go b/service/greengrassv2/doc.go index d6910f2fedb..ca26760cbeb 100644 --- a/service/greengrassv2/doc.go +++ b/service/greengrassv2/doc.go @@ -10,10 +10,14 @@ // devices can also communicate securely with Amazon Web Services IoT Core and // export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can // use Lambda functions and components to create and deploy applications to fleets -// of edge devices for local operation. IoT Greengrass Version 2 provides a new -// 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) -// in the IoT Greengrass V2 Developer Guide. +// of edge devices for local operation. +// +// IoT Greengrass Version 2 provides a new 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?] in the IoT Greengrass V2 Developer Guide. +// +// [What is IoT Greengrass?]: https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html package greengrassv2 diff --git a/service/greengrassv2/options.go b/service/greengrassv2/options.go index 92d1b73838b..72d258e466a 100644 --- a/service/greengrassv2/options.go +++ b/service/greengrassv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/greengrassv2/types/enums.go b/service/greengrassv2/types/enums.go index 0d84c444c98..5b7cb087a92 100644 --- a/service/greengrassv2/types/enums.go +++ b/service/greengrassv2/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for CloudComponentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudComponentState) Values() []CloudComponentState { return []CloudComponentState{ "REQUESTED", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for ComponentDependencyType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentDependencyType) Values() []ComponentDependencyType { return []ComponentDependencyType{ "HARD", @@ -54,6 +56,7 @@ const ( // 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{ @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for CoreDeviceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoreDeviceStatus) Values() []CoreDeviceStatus { return []CoreDeviceStatus{ "HEALTHY", @@ -90,8 +94,9 @@ const ( // Values returns all known values for DeploymentComponentUpdatePolicyAction. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentComponentUpdatePolicyAction) Values() []DeploymentComponentUpdatePolicyAction { return []DeploymentComponentUpdatePolicyAction{ "NOTIFY_COMPONENTS", @@ -109,8 +114,9 @@ const ( // Values returns all known values for DeploymentFailureHandlingPolicy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentFailureHandlingPolicy) Values() []DeploymentFailureHandlingPolicy { return []DeploymentFailureHandlingPolicy{ "ROLLBACK", @@ -127,8 +133,9 @@ const ( ) // Values returns all known values for DeploymentHistoryFilter. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentHistoryFilter) Values() []DeploymentHistoryFilter { return []DeploymentHistoryFilter{ "ALL", @@ -148,8 +155,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "ACTIVE", @@ -176,8 +184,9 @@ const ( // Values returns all known values for EffectiveDeploymentExecutionStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EffectiveDeploymentExecutionStatus) Values() []EffectiveDeploymentExecutionStatus { return []EffectiveDeploymentExecutionStatus{ "IN_PROGRESS", @@ -207,8 +216,9 @@ const ( // Values returns all known values for InstalledComponentLifecycleState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstalledComponentLifecycleState) Values() []InstalledComponentLifecycleState { return []InstalledComponentLifecycleState{ "NEW", @@ -232,8 +242,9 @@ const ( // Values returns all known values for InstalledComponentTopologyFilter. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstalledComponentTopologyFilter) Values() []InstalledComponentTopologyFilter { return []InstalledComponentTopologyFilter{ "ALL", @@ -249,8 +260,9 @@ const ( ) // Values returns all known values for IoTJobAbortAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IoTJobAbortAction) Values() []IoTJobAbortAction { return []IoTJobAbortAction{ "CANCEL", @@ -269,6 +281,7 @@ const ( // Values returns all known values for IoTJobExecutionFailureType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IoTJobExecutionFailureType) Values() []IoTJobExecutionFailureType { return []IoTJobExecutionFailureType{ @@ -288,8 +301,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PUB_SUB", @@ -307,6 +321,7 @@ const ( // Values returns all known values for LambdaFilesystemPermission. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFilesystemPermission) Values() []LambdaFilesystemPermission { return []LambdaFilesystemPermission{ @@ -325,8 +340,9 @@ const ( // Values returns all known values for LambdaInputPayloadEncodingType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaInputPayloadEncodingType) Values() []LambdaInputPayloadEncodingType { return []LambdaInputPayloadEncodingType{ "json", @@ -343,8 +359,9 @@ const ( ) // Values returns all known values for LambdaIsolationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaIsolationMode) Values() []LambdaIsolationMode { return []LambdaIsolationMode{ "GreengrassContainer", @@ -361,8 +378,9 @@ const ( ) // Values returns all known values for RecipeOutputFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecipeOutputFormat) Values() []RecipeOutputFormat { return []RecipeOutputFormat{ "JSON", @@ -382,6 +400,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -402,8 +421,9 @@ const ( ) // Values returns all known values for VendorGuidance. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VendorGuidance) Values() []VendorGuidance { return []VendorGuidance{ "ACTIVE", diff --git a/service/greengrassv2/types/types.go b/service/greengrassv2/types/types.go index 699e0f1b9cd..7347a05e034 100644 --- a/service/greengrassv2/types/types.go +++ b/service/greengrassv2/types/types.go @@ -7,9 +7,10 @@ import ( "time" ) -// 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) +// Contains a request to associate a client device with a core device. The [BatchAssociateClientDeviceWithCoreDevice] // operation consumes a list of these requests. +// +// [BatchAssociateClientDeviceWithCoreDevice]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html type AssociateClientDeviceWithCoreDeviceEntry struct { // The name of the IoT thing that represents the client device to associate. @@ -21,8 +22,9 @@ type AssociateClientDeviceWithCoreDeviceEntry struct { } // 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. +// a core device. The [BatchAssociateClientDeviceWithCoreDevice]operation returns a list of these errors. +// +// [BatchAssociateClientDeviceWithCoreDevice]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html type AssociateClientDeviceWithCoreDeviceErrorEntry struct { // The error code for the request. @@ -69,10 +71,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. @@ -89,8 +94,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The name of the component. @@ -113,18 +119,21 @@ type ComponentCandidate struct { ComponentVersion *string // 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/) - // . + // devices get the version requirements from component recipes. + // + // IoT Greengrass V2 uses semantic version constraints. For more information, see [Semantic Versioning]. + // + // [Semantic Versioning]: https://semver.org/ VersionRequirements map[string]string noSmithyDocumentSerde } // 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) -// in the IoT Greengrass V2 Developer Guide. +// on Greengrass core devices. For more information, see [Update component configurations]in the IoT Greengrass V2 +// Developer Guide. +// +// [Update component configurations]: https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html type ComponentConfigurationUpdate struct { // A serialized JSON string that contains the configuration object to merge to @@ -133,16 +142,19 @@ 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) - // in the IoT Greengrass V2 Developer Guide. + // see [Merge configuration updates]in the IoT Greengrass V2 Developer Guide. + // + // [Merge configuration updates]: https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update 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) - // in the IoT Greengrass V2 Developer Guide. + // in the object. For more information, see the [JSON pointer specification]and [Reset configuration updates] in the IoT Greengrass V2 + // Developer Guide. + // + // [JSON pointer specification]: https://tools.ietf.org/html/rfc6901 + // [Reset configuration updates]: https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update Reset []string noSmithyDocumentSerde @@ -153,14 +165,19 @@ 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. + // // 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/) . + // The component version requirement for the component dependency. + // + // IoT Greengrass V2 uses semantic version constraints. For more information, see [Semantic Versioning]. + // + // [Semantic Versioning]: https://semver.org/ VersionRequirement *string noSmithyDocumentSerde @@ -177,16 +194,18 @@ 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) - // in the IoT Greengrass V2 Developer Guide. + // For more information, see [Update component configurations]in the IoT Greengrass V2 Developer Guide. + // + // [Update component configurations]: https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html 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) - // in the IoT Greengrass V2 Developer Guide. + // the core device. For more information, see [Configure the user and group that run components]in the IoT Greengrass V2 Developer + // Guide. + // + // [Configure the user and group that run components]: https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user RunWith *ComponentRunWith noSmithyDocumentSerde @@ -195,8 +214,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The version of the component. @@ -223,11 +243,13 @@ 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) - // in the IoT Greengrass V2 Developer Guide. + // For more information, see the [Greengrass nucleus component]in the IoT Greengrass V2 Developer Guide. + // + // [Greengrass nucleus component]: https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html 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. Name *string @@ -237,37 +259,44 @@ type ComponentPlatform struct { // 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. +// information, see [Configure the user and group that run components]in the IoT Greengrass V2 Developer Guide. +// +// [Configure the user and group that run components]: https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user 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 - // 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 + // 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]. + // + // [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 // device. IoT Greengrass currently supports this feature on only Linux core - // 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) - // . + // 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]. + // + // [Configure system resource limits for 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 // must exist on each Windows core device, and its name and password must be in the - // 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) - // . + // 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]. + // + // [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 @@ -276,8 +305,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The name of the component. @@ -324,8 +354,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. Status CoreDeviceStatus @@ -351,64 +383,77 @@ 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) - // within a subdeployment. + // The parent deployment's target [ARN] within a subdeployment. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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] of the target IoT thing or thing group. When creating a subdeployment, the // targetARN can only be a thing group. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html TargetArn *string noSmithyDocumentSerde } // Contains information about a deployment's policy that defines when components -// are safe to update. Each component on a device can report whether or not it's -// ready to update. After a component and its dependencies are ready, they can -// apply the update in the deployment. You can configure whether or not the -// deployment notifies components of an update and waits for a response. You -// specify the amount of time each component has to respond to the update -// notification. +// are safe to update. +// +// Each component on a device can report whether or not it's ready to update. +// After a component and its dependencies are ready, they can apply the update in +// the deployment. You can configure whether or not the deployment notifies +// components of an update and waits for a response. You specify the amount of time +// each component has to respond to the update notification. 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. + // and updates that component. Components can use the [SubscribeToComponentUpdates]IPC operation to receive + // these notifications. Then, components can respond with the [DeferComponentUpdate]IPC operation. For + // more information, see [Create deployments]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 + // + // [DeferComponentUpdate]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate + // [SubscribeToComponentUpdates]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates + // [Create deployments]: https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html 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 + // then the deployment proceeds on the device. + // + // Default: 60 TimeoutInSeconds *int32 noSmithyDocumentSerde } // 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) -// 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) -// in the IoT Greengrass V2 Developer Guide. +// its configuration updates before it times out. Components can use the [SubscribeToValidateConfigurationUpdates]IPC +// operation to receive notifications when a deployment specifies a configuration +// update. Then, components can respond with the [SendConfigurationValidityReport]IPC operation. For more +// information, see [Create deployments]in the IoT Greengrass V2 Developer Guide. +// +// [SendConfigurationValidityReport]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport +// [SubscribeToValidateConfigurationUpdates]: https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates +// [Create deployments]: https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html type DeploymentConfigurationValidationPolicy struct { // The amount of time in seconds that a component can validate its configuration // updates. If the validation time exceeds this timeout, then the deployment - // proceeds for the device. Default: 30 + // proceeds for the device. + // + // Default: 30 TimeoutInSeconds *int32 noSmithyDocumentSerde @@ -445,15 +490,18 @@ type DeploymentPolicies struct { ConfigurationValidationPolicy *DeploymentConfigurationValidationPolicy // The failure handling policy for the configuration deployment. This policy - // defines what to do if the deployment fails. Default: ROLLBACK + // defines what to do if the deployment fails. + // + // Default: ROLLBACK FailureHandlingPolicy DeploymentFailureHandlingPolicy noSmithyDocumentSerde } -// 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) +// Contains a request to disassociate a client device from a core device. The [BatchDisassociateClientDeviceWithCoreDevice] // operation consumes a list of these requests. +// +// [BatchDisassociateClientDeviceWithCoreDevice]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html type DisassociateClientDeviceFromCoreDeviceEntry struct { // The name of the IoT thing that represents the client device to disassociate. @@ -465,8 +513,9 @@ 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) -// operation returns a list of these errors. +// from a core device. The [BatchDisassociateClientDeviceWithCoreDevice]operation returns a list of these errors. +// +// [BatchDisassociateClientDeviceWithCoreDevice]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html type DisassociateClientDeviceFromCoreDeviceErrorEntry struct { // The error code for the request. @@ -486,15 +535,23 @@ 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. // // This member is required. @@ -521,8 +578,9 @@ 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] of the target IoT thing or thing group. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. TargetArn *string @@ -530,8 +588,9 @@ 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] of the IoT job that applies the deployment to target devices. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html IotJobArn *string // The ID of the IoT job that applies the deployment to target devices. @@ -548,10 +607,11 @@ type EffectiveDeployment struct { } // Contains all error-related information for the deployment record. The status -// details will be null if the deployment is in a success state. Greengrass nucleus -// v2.8.0 or later is required to get an accurate errorStack and errorTypes -// response. This field will not be returned for earlier Greengrass nucleus -// versions. +// details will be null if the deployment is in a success state. +// +// Greengrass nucleus v2.8.0 or later is required to get an accurate errorStack +// and errorTypes response. This field will not be returned for earlier Greengrass +// nucleus versions. type EffectiveDeploymentStatusDetails struct { // Contains an ordered list of short error codes that range from the most generic @@ -583,19 +643,23 @@ 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. 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. + // 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 - // state changes. The status reflects component disruptions and deployments. If a - // component only sees a configuration update during a deployment, it might not - // undergo a state change and this status would not be updated. + // The status of how current the data is. + // + // This response is based off of component state changes. The status reflects + // component disruptions and deployments. If a component only sees a configuration + // update during a deployment, it might not undergo a state change and this status + // would not be updated. LastStatusChangeTimestamp *time.Time // The lifecycle state of the component. @@ -606,9 +670,11 @@ type InstalledComponent struct { LifecycleStateDetails *string // The status codes that indicate the reason for failure whenever the - // lifecycleState has an error or is in a broken state. Greengrass nucleus v2.8.0 - // or later is required to get an accurate lifecycleStatusCodes response. This - // response can be inaccurate in earlier Greengrass nucleus versions. + // lifecycleState has an error or is in a broken state. + // + // Greengrass nucleus v2.8.0 or later is required to get an accurate + // lifecycleStatusCodes response. This response can be inaccurate in earlier + // Greengrass nucleus versions. LifecycleStatusCodes []string noSmithyDocumentSerde @@ -627,10 +693,13 @@ type IoTJobAbortConfig struct { noSmithyDocumentSerde } -// Contains criteria that define when and how to cancel a job. The deployment -// stops if the following conditions are true: +// 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 { @@ -652,8 +721,10 @@ type IoTJobAbortCriteria struct { MinNumberOfExecutedThings *int32 // 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 ). + // 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 ). // // This member is required. ThresholdPercentage float64 @@ -687,9 +758,10 @@ type IoTJobExponentialRolloutRate struct { // This member is required. 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 ). + // 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 ). // // This member is required. IncrementFactor *float64 @@ -723,8 +795,9 @@ 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). + // is set to TIMED_OUT . + // + // The timeout interval must be between 1 minute and 7 days (10080 minutes). InProgressTimeoutInMinutes *int64 noSmithyDocumentSerde @@ -737,11 +810,14 @@ type LambdaContainerParams struct { // The list of system devices that the container can access. Devices []LambdaDeviceMount - // The memory size of the container, expressed in kilobytes. Default: 16384 (16 MB) + // 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. @@ -760,10 +836,12 @@ type LambdaDeviceMount struct { Path *string // Whether or not to add the component's system user as an owner of the device. + // // Default: false AddGroupOwner *bool // The permission to access the device: read/only ( ro ) or read/write ( rw ). + // // Default: ro Permission LambdaFilesystemPermission @@ -781,8 +859,10 @@ 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. @@ -809,7 +889,9 @@ type LambdaExecutionParameters struct { // The list of arguments to pass to the Lambda function when it runs. ExecArgs []string - // The encoding type that the Lambda function supports. Default: json + // The encoding type that the Lambda function supports. + // + // Default: json InputPayloadEncodingType LambdaInputPayloadEncodingType // The parameters for the Linux process that contains the Lambda function. @@ -829,12 +911,15 @@ type LambdaExecutionParameters struct { 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. + // // Default: true Pinned *bool @@ -852,9 +937,10 @@ 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] of the Lambda function. The ARN must include the version of the function + // to import. You can't use version aliases like $LATEST . + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. LambdaArn *string @@ -866,15 +952,18 @@ type LambdaFunctionRecipeSource struct { // Greengrass core device. ComponentLambdaParameters *LambdaExecutionParameters - // The name of the component. Defaults to the name of the Lambda function. + // The name of the component. + // + // Defaults to the name of the Lambda function. ComponentName *string // The platforms that the component version supports. 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 . + // 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 . ComponentVersion *string noSmithyDocumentSerde @@ -888,8 +977,9 @@ type LambdaLinuxProcessParams struct { // The isolation mode for the process that contains the Lambda function. The // process can run in an isolated runtime environment inside the IoT Greengrass - // container, or as a regular process outside any container. Default: - // GreengrassContainer + // container, or as a regular process outside any container. + // + // Default: GreengrassContainer IsolationMode LambdaIsolationMode noSmithyDocumentSerde @@ -911,10 +1001,12 @@ type LambdaVolumeMount struct { SourcePath *string // Whether or not to add the IoT Greengrass user group as an owner of the volume. + // // Default: false AddGroupOwner *bool // The permission to access the volume: read/only ( ro ) or read/write ( rw ). + // // Default: ro Permission LambdaFilesystemPermission @@ -925,8 +1017,9 @@ 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] of the component version. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The name of the component. @@ -946,10 +1039,13 @@ 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. @@ -959,9 +1055,9 @@ type ResolvedComponentVersion struct { } // 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]. +// +// [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_op_CreateConfig.go b/service/groundstation/api_op_CreateConfig.go index b83cd1c0ed3..67943e009cb 100644 --- a/service/groundstation/api_op_CreateConfig.go +++ b/service/groundstation/api_op_CreateConfig.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Config with the specified configData parameters. Only one type of -// configData can be specified. +// Creates a Config with the specified configData parameters. +// +// Only one type of configData can be specified. func (c *Client) CreateConfig(ctx context.Context, params *CreateConfigInput, optFns ...func(*Options)) (*CreateConfigOutput, error) { if params == nil { params = &CreateConfigInput{} diff --git a/service/groundstation/api_op_CreateDataflowEndpointGroup.go b/service/groundstation/api_op_CreateDataflowEndpointGroup.go index a0f50fd7bf3..8da5121e30c 100644 --- a/service/groundstation/api_op_CreateDataflowEndpointGroup.go +++ b/service/groundstation/api_op_CreateDataflowEndpointGroup.go @@ -12,10 +12,13 @@ import ( ) // Creates a DataflowEndpoint group containing the specified list of -// DataflowEndpoint objects. The name field in each endpoint is used in your -// mission profile DataflowEndpointConfig to specify which endpoints to use during -// a contact. When a contact uses multiple DataflowEndpointConfig objects, each -// Config must match a DataflowEndpoint in the same group. +// DataflowEndpoint objects. +// +// The name field in each endpoint is used in your mission profile +// DataflowEndpointConfig to specify which endpoints to use during a contact. +// +// When a contact uses multiple DataflowEndpointConfig objects, each Config must +// match a DataflowEndpoint in the same group. func (c *Client) CreateDataflowEndpointGroup(ctx context.Context, params *CreateDataflowEndpointGroupInput, optFns ...func(*Options)) (*CreateDataflowEndpointGroupOutput, error) { if params == nil { params = &CreateDataflowEndpointGroupInput{} diff --git a/service/groundstation/api_op_CreateEphemeris.go b/service/groundstation/api_op_CreateEphemeris.go index 5670c531c24..0c1ddd6fec9 100644 --- a/service/groundstation/api_op_CreateEphemeris.go +++ b/service/groundstation/api_op_CreateEphemeris.go @@ -41,8 +41,10 @@ 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. @@ -56,8 +58,12 @@ type CreateEphemerisInput struct { KmsKeyArn *string // Customer-provided priority score to establish the order in which overlapping - // ephemerides should be used. The default for customer-provided ephemeris priority - // is 1, and higher numbers take precedence. Priority must be 1 or greater + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater Priority *int32 // Tags assigned to an ephemeris. diff --git a/service/groundstation/api_op_CreateMissionProfile.go b/service/groundstation/api_op_CreateMissionProfile.go index 85fa165662d..79417cfc55c 100644 --- a/service/groundstation/api_op_CreateMissionProfile.go +++ b/service/groundstation/api_op_CreateMissionProfile.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a mission profile. dataflowEdges is a list of lists of strings. Each -// lower level list of strings has two elements: a from ARN and a to ARN. +// Creates a mission profile. +// +// dataflowEdges is a list of lists of strings. Each lower level list of strings +// has two elements: a from ARN and a to ARN. func (c *Client) CreateMissionProfile(ctx context.Context, params *CreateMissionProfileInput, optFns ...func(*Options)) (*CreateMissionProfileOutput, error) { if params == nil { params = &CreateMissionProfileInput{} diff --git a/service/groundstation/api_op_DescribeContact.go b/service/groundstation/api_op_DescribeContact.go index 32bdcf8be48..6b0245c349c 100644 --- a/service/groundstation/api_op_DescribeContact.go +++ b/service/groundstation/api_op_DescribeContact.go @@ -87,16 +87,18 @@ type DescribeContactOutput struct { // Tags assigned to a contact. Tags map[string]string - // Projected time in UTC your satellite will set below the receive mask (https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html) - // . This time is based on the satellite's current active ephemeris for future - // contacts and the ephemeris that was active during contact execution for - // completed contacts. + // Projected time in UTC your satellite will set below the [receive mask]. This time is based + // on the satellite's current active ephemeris for future contacts and the + // ephemeris that was active during contact execution for completed contacts. + // + // [receive mask]: https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html VisibilityEndTime *time.Time - // Projected time in UTC your satellite will rise above the receive mask (https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html) - // . This time is based on the satellite's current active ephemeris for future - // contacts and the ephemeris that was active during contact execution for - // completed contacts. + // Projected time in UTC your satellite will rise above the [receive mask]. This time is based + // on the satellite's current active ephemeris for future contacts and the + // ephemeris that was active during contact execution for completed contacts. + // + // [receive mask]: https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html VisibilityStartTime *time.Time // Metadata pertaining to the operation's result. @@ -224,12 +226,13 @@ type ContactScheduledWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeContactInput, *DescribeContactOutput, error) (bool, error) } diff --git a/service/groundstation/api_op_DescribeEphemeris.go b/service/groundstation/api_op_DescribeEphemeris.go index 9521039efd0..1b9e6b8002c 100644 --- a/service/groundstation/api_op_DescribeEphemeris.go +++ b/service/groundstation/api_op_DescribeEphemeris.go @@ -58,8 +58,12 @@ type DescribeEphemerisOutput struct { Name *string // Customer-provided priority score to establish the order in which overlapping - // ephemerides should be used. The default for customer-provided ephemeris priority - // is 1, and higher numbers take precedence. Priority must be 1 or greater + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater Priority *int32 // The AWS Ground Station satellite ID associated with ephemeris. diff --git a/service/groundstation/api_op_GetAgentConfiguration.go b/service/groundstation/api_op_GetAgentConfiguration.go index 18e922d802f..e7966b38591 100644 --- a/service/groundstation/api_op_GetAgentConfiguration.go +++ b/service/groundstation/api_op_GetAgentConfiguration.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For use by AWS Ground Station Agent and shouldn't be called directly. Gets the -// latest configuration information for a registered agent. +// For use by AWS Ground Station Agent and shouldn't be called directly. +// +// Gets the latest configuration information for a registered agent. func (c *Client) GetAgentConfiguration(ctx context.Context, params *GetAgentConfigurationInput, optFns ...func(*Options)) (*GetAgentConfigurationOutput, error) { if params == nil { params = &GetAgentConfigurationInput{} diff --git a/service/groundstation/api_op_GetConfig.go b/service/groundstation/api_op_GetConfig.go index 245382537d7..79e4983472a 100644 --- a/service/groundstation/api_op_GetConfig.go +++ b/service/groundstation/api_op_GetConfig.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns Config information. Only one Config response can be returned. +// Returns Config information. +// +// Only one Config response can be returned. func (c *Client) GetConfig(ctx context.Context, params *GetConfigInput, optFns ...func(*Options)) (*GetConfigOutput, error) { if params == nil { params = &GetConfigInput{} diff --git a/service/groundstation/api_op_ListContacts.go b/service/groundstation/api_op_ListContacts.go index eb3d130470e..55461e1acb1 100644 --- a/service/groundstation/api_op_ListContacts.go +++ b/service/groundstation/api_op_ListContacts.go @@ -12,8 +12,10 @@ import ( "time" ) -// Returns a list of contacts. If statusList contains AVAILABLE, the request must -// include groundStation , missionprofileArn , and satelliteArn . +// Returns a list of contacts. +// +// If statusList contains AVAILABLE, the request must include groundStation , +// missionprofileArn , and satelliteArn . func (c *Client) ListContacts(ctx context.Context, params *ListContactsInput, optFns ...func(*Options)) (*ListContactsOutput, error) { if params == nil { params = &ListContactsInput{} diff --git a/service/groundstation/api_op_RegisterAgent.go b/service/groundstation/api_op_RegisterAgent.go index 4b962785252..36e143f8530 100644 --- a/service/groundstation/api_op_RegisterAgent.go +++ b/service/groundstation/api_op_RegisterAgent.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For use by AWS Ground Station Agent and shouldn't be called directly. Registers -// a new agent with AWS Ground Station. +// For use by AWS Ground Station Agent and shouldn't be called directly. +// +// Registers a new agent with AWS Ground Station. func (c *Client) RegisterAgent(ctx context.Context, params *RegisterAgentInput, optFns ...func(*Options)) (*RegisterAgentOutput, error) { if params == nil { params = &RegisterAgentInput{} diff --git a/service/groundstation/api_op_UpdateAgentStatus.go b/service/groundstation/api_op_UpdateAgentStatus.go index b035fba9433..bd0e172b234 100644 --- a/service/groundstation/api_op_UpdateAgentStatus.go +++ b/service/groundstation/api_op_UpdateAgentStatus.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For use by AWS Ground Station Agent and shouldn't be called directly. Update -// the status of the agent. +// For use by AWS Ground Station Agent and shouldn't be called directly. +// +// Update the status of the agent. func (c *Client) UpdateAgentStatus(ctx context.Context, params *UpdateAgentStatusInput, optFns ...func(*Options)) (*UpdateAgentStatusOutput, error) { if params == nil { params = &UpdateAgentStatusInput{} diff --git a/service/groundstation/api_op_UpdateConfig.go b/service/groundstation/api_op_UpdateConfig.go index 9dfbe20f863..616e2950845 100644 --- a/service/groundstation/api_op_UpdateConfig.go +++ b/service/groundstation/api_op_UpdateConfig.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the Config used when scheduling contacts. Updating a Config will not -// update the execution parameters for existing future contacts scheduled with this -// Config . +// Updates the Config used when scheduling contacts. +// +// Updating a Config will not update the execution parameters for existing future +// contacts scheduled with this Config . func (c *Client) UpdateConfig(ctx context.Context, params *UpdateConfigInput, optFns ...func(*Options)) (*UpdateConfigOutput, error) { if params == nil { params = &UpdateConfigInput{} diff --git a/service/groundstation/api_op_UpdateEphemeris.go b/service/groundstation/api_op_UpdateEphemeris.go index 6b6f323aa9b..2f164711945 100644 --- a/service/groundstation/api_op_UpdateEphemeris.go +++ b/service/groundstation/api_op_UpdateEphemeris.go @@ -44,8 +44,12 @@ type UpdateEphemerisInput struct { Name *string // Customer-provided priority score to establish the order in which overlapping - // ephemerides should be used. The default for customer-provided ephemeris priority - // is 1, and higher numbers take precedence. Priority must be 1 or greater + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater Priority *int32 noSmithyDocumentSerde diff --git a/service/groundstation/api_op_UpdateMissionProfile.go b/service/groundstation/api_op_UpdateMissionProfile.go index d2c11e4096c..617304750fb 100644 --- a/service/groundstation/api_op_UpdateMissionProfile.go +++ b/service/groundstation/api_op_UpdateMissionProfile.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a mission profile. Updating a mission profile will not update the -// execution parameters for existing future contacts. +// Updates a mission profile. +// +// Updating a mission profile will not update the execution parameters for +// existing future contacts. func (c *Client) UpdateMissionProfile(ctx context.Context, params *UpdateMissionProfileInput, optFns ...func(*Options)) (*UpdateMissionProfileOutput, error) { if params == nil { params = &UpdateMissionProfileInput{} diff --git a/service/groundstation/options.go b/service/groundstation/options.go index c744e570d72..aa798117cec 100644 --- a/service/groundstation/options.go +++ b/service/groundstation/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/groundstation/types/enums.go b/service/groundstation/types/enums.go index ab81e702e53..628b48a7864 100644 --- a/service/groundstation/types/enums.go +++ b/service/groundstation/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AgentStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentStatus) Values() []AgentStatus { return []AgentStatus{ "SUCCESS", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for AngleUnits. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AngleUnits) Values() []AngleUnits { return []AngleUnits{ "DEGREE_ANGLE", @@ -51,8 +53,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for BandwidthUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BandwidthUnits) Values() []BandwidthUnits { return []BandwidthUnits{ "GHz", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for CapabilityHealth. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapabilityHealth) Values() []CapabilityHealth { return []CapabilityHealth{ "UNHEALTHY", @@ -112,8 +117,9 @@ const ( ) // Values returns all known values for CapabilityHealthReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapabilityHealthReason) Values() []CapabilityHealthReason { return []CapabilityHealthReason{ "NO_REGISTERED_AGENT", @@ -140,8 +146,9 @@ const ( ) // Values returns all known values for ConfigCapabilityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigCapabilityType) Values() []ConfigCapabilityType { return []ConfigCapabilityType{ "antenna-downlink", @@ -174,8 +181,9 @@ const ( ) // Values returns all known values for ContactStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactStatus) Values() []ContactStatus { return []ContactStatus{ "AVAILABLE", @@ -204,8 +212,9 @@ const ( ) // Values returns all known values for Criticality. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Criticality) Values() []Criticality { return []Criticality{ "PREFERRED", @@ -222,8 +231,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -242,8 +252,9 @@ const ( ) // Values returns all known values for EndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointStatus) Values() []EndpointStatus { return []EndpointStatus{ "created", @@ -271,8 +282,9 @@ const ( ) // Values returns all known values for EphemerisInvalidReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EphemerisInvalidReason) Values() []EphemerisInvalidReason { return []EphemerisInvalidReason{ "METADATA_INVALID", @@ -292,8 +304,9 @@ const ( ) // Values returns all known values for EphemerisSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EphemerisSource) Values() []EphemerisSource { return []EphemerisSource{ "CUSTOMER_PROVIDED", @@ -314,8 +327,9 @@ const ( ) // Values returns all known values for EphemerisStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EphemerisStatus) Values() []EphemerisStatus { return []EphemerisStatus{ "VALIDATING", @@ -337,8 +351,9 @@ const ( ) // Values returns all known values for FrequencyUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FrequencyUnits) Values() []FrequencyUnits { return []FrequencyUnits{ "GHz", @@ -357,8 +372,9 @@ const ( ) // 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. +// expanded in the future, and so 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 ce4b70752a9..66316d5ceb9 100644 --- a/service/groundstation/types/types.go +++ b/service/groundstation/types/types.go @@ -33,8 +33,10 @@ type AgentDetails struct { // List of CPU cores reserved for the agent. AgentCpuCores []int32 - // This field should not be used. Use agentCpuCores instead. List of CPU cores - // reserved for processes other than the agent running on the EC2 instance. + // This field should not be used. Use agentCpuCores instead. + // + // List of CPU cores reserved for processes other than the agent running on the + // EC2 instance. ReservedCpuCores []int32 noSmithyDocumentSerde @@ -251,8 +253,9 @@ type ConfigListItem struct { noSmithyDocumentSerde } -// Object containing the parameters of a Config . See the subtype definitions for -// what each type of Config contains. +// Object containing the parameters of a Config . +// +// See the subtype definitions for what each type of Config contains. // // The following types satisfy this interface: // @@ -325,9 +328,11 @@ 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 @@ -394,18 +399,20 @@ type ContactData struct { // Tags assigned to a contact. Tags map[string]string - // Projected time in UTC your satellite will set below the receive mask (https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html) - // . This time is based on the satellite's current active ephemeris for future - // contacts and the ephemeris that was active during contact execution for - // completed contacts. This field is not present for contacts with a SCHEDULING or - // SCHEDULED status. + // Projected time in UTC your satellite will set below the [receive mask]. This time is based + // on the satellite's current active ephemeris for future contacts and the + // ephemeris that was active during contact execution for completed contacts. This + // field is not present for contacts with a SCHEDULING or SCHEDULED status. + // + // [receive mask]: https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html VisibilityEndTime *time.Time - // Projected time in UTC your satellite will rise above the receive mask (https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html) - // . This time is based on the satellite's current active ephemeris for future - // contacts and the ephemeris that was active during contact execution for - // completed contacts. This field is not present for contacts with a SCHEDULING or - // SCHEDULED status. + // Projected time in UTC your satellite will rise above the [receive mask]. This time is based + // on the satellite's current active ephemeris for future contacts and the + // ephemeris that was active during contact execution for completed contacts. This + // field is not present for contacts with a SCHEDULING or SCHEDULED status. + // + // [receive mask]: https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html VisibilityStartTime *time.Time noSmithyDocumentSerde @@ -645,8 +652,12 @@ type EphemerisItem struct { Name *string // Customer-provided priority score to establish the order in which overlapping - // ephemerides should be used. The default for customer-provided ephemeris priority - // is 1, and higher numbers take precedence. Priority must be 1 or greater + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater Priority *int32 // Source S3 object used for the ephemeris. @@ -666,17 +677,21 @@ type EphemerisMetaData struct { // This member is required. Source EphemerisSource - // UUID of a customer-provided ephemeris. This field is not populated for default - // ephemerides from Space Track. + // UUID of a customer-provided ephemeris. + // + // This field is not populated for default ephemerides from Space Track. EphemerisId *string - // The epoch of a default, ephemeris from Space Track in UTC. This field is not - // populated for customer-provided ephemerides. + // The epoch of a default, ephemeris from Space Track in UTC. + // + // This field is not 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. + // identifier for the ephemeris. + // + // A name is only returned for customer-provider ephemerides that have a name + // associated. Name *string noSmithyDocumentSerde @@ -735,9 +750,12 @@ 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. // // This member is required. @@ -1005,9 +1023,12 @@ type SpectrumConfig struct { // 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. // // This member is required. @@ -1088,9 +1109,11 @@ 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 . diff --git a/service/guardduty/api_op_ArchiveFindings.go b/service/guardduty/api_op_ArchiveFindings.go index 9f6bb0d00ee..5858a0ac174 100644 --- a/service/guardduty/api_op_ArchiveFindings.go +++ b/service/guardduty/api_op_ArchiveFindings.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Archives GuardDuty findings that are specified by the list of finding IDs. Only -// the administrator account can archive findings. Member accounts don't have +// Archives GuardDuty findings that are specified by the list of finding IDs. +// +// Only the administrator account can archive findings. Member accounts don't have // permission to archive findings from their accounts. func (c *Client) ArchiveFindings(ctx context.Context, params *ArchiveFindingsInput, optFns ...func(*Options)) (*ArchiveFindingsOutput, error) { if params == nil { diff --git a/service/guardduty/api_op_CreateDetector.go b/service/guardduty/api_op_CreateDetector.go index 6b75b1d2782..e40728599f3 100644 --- a/service/guardduty/api_op_CreateDetector.go +++ b/service/guardduty/api_op_CreateDetector.go @@ -15,8 +15,10 @@ import ( // the GuardDuty service. To start using GuardDuty, you must create a detector in // each Region where you enable the service. You can have only one detector per // account per Region. All data sources are enabled in a new detector by default. +// // - When you don't specify any features , with an exception to // RUNTIME_MONITORING , all the optional features are enabled by default. +// // - When you specify some of the features , any feature that is not specified in // the API call gets enabled by default, with an exception to RUNTIME_MONITORING // . @@ -24,11 +26,14 @@ import ( // Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime // Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add only one of // these two features because Runtime Monitoring already includes the threat -// detection for Amazon EKS resources. For more information, see Runtime Monitoring (https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) -// . There might be regional differences because some data sources might not be +// detection for Amazon EKS resources. For more information, see [Runtime Monitoring]. +// +// 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]. +// +// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html +// [Runtime Monitoring]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html func (c *Client) CreateDetector(ctx context.Context, params *CreateDetectorInput, optFns ...func(*Options)) (*CreateDetectorOutput, error) { if params == nil { params = &CreateDetectorInput{} @@ -54,11 +59,13 @@ type CreateDetectorInput struct { // The idempotency token for the create request. ClientToken *string - // 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) - // . + // 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]. + // + // [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 8ed8efa1073..2f293f323c7 100644 --- a/service/guardduty/api_op_CreateFilter.go +++ b/service/guardduty/api_op_CreateFilter.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} @@ -38,92 +39,175 @@ type CreateFilterInput struct { // This member is required. DetectorId *string - // Represents the criteria to be used in the filter for querying findings. You can - // only use the following attributes to query findings: + // Represents the criteria to be used in the filter for querying findings. + // + // You can only use the following attributes to query findings: + // // - accountId + // // - id + // // - region - // - severity To filter on the basis of severity, the API and CLI use the - // following input list for the FindingCriteria (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_FindingCriteria.html) - // condition: + // + // - severity + // + // To filter on the basis of severity, the API and CLI use the following input + // list for the [FindingCriteria]condition: + // // - Low: ["1", "2", "3"] + // // - Medium: ["4", "5", "6"] - // - High: ["7", "8", "9"] For more information, see Severity levels for - // GuardDuty findings (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html#guardduty_findings-severity) - // . + // + // - High: ["7", "8", "9"] + // + // For more information, see [Severity levels for GuardDuty findings]. + // // - 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. + // + // - 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. + // // - resource.accessKeyDetails.accessKeyId + // // - resource.accessKeyDetails.principalId + // // - resource.accessKeyDetails.userName + // // - resource.accessKeyDetails.userType + // // - resource.instanceDetails.iamInstanceProfile.id + // // - resource.instanceDetails.imageId + // // - resource.instanceDetails.instanceId + // // - resource.instanceDetails.tags.key + // // - resource.instanceDetails.tags.value + // // - 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.outpostArn + // // - resource.resourceType + // // - resource.s3BucketDetails.publicAccess.effectivePermissions + // // - resource.s3BucketDetails.name + // // - resource.s3BucketDetails.tags.key + // // - resource.s3BucketDetails.tags.value + // // - resource.s3BucketDetails.type + // // - service.action.actionType + // // - service.action.awsApiCallAction.api + // // - service.action.awsApiCallAction.callerType + // // - service.action.awsApiCallAction.errorCode + // // - service.action.awsApiCallAction.remoteIpDetails.city.cityName + // // - service.action.awsApiCallAction.remoteIpDetails.country.countryName + // // - service.action.awsApiCallAction.remoteIpDetails.ipAddressV4 + // // - service.action.awsApiCallAction.remoteIpDetails.ipAddressV6 + // // - service.action.awsApiCallAction.remoteIpDetails.organization.asn + // // - service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg + // // - service.action.awsApiCallAction.serviceName + // // - service.action.dnsRequestAction.domain + // // - service.action.dnsRequestAction.domainWithSuffix + // // - service.action.networkConnectionAction.blocked + // // - service.action.networkConnectionAction.connectionDirection + // // - service.action.networkConnectionAction.localPortDetails.port + // // - service.action.networkConnectionAction.protocol + // // - service.action.networkConnectionAction.remoteIpDetails.city.cityName + // // - service.action.networkConnectionAction.remoteIpDetails.country.countryName + // // - service.action.networkConnectionAction.remoteIpDetails.ipAddressV4 + // // - service.action.networkConnectionAction.remoteIpDetails.ipAddressV6 + // // - service.action.networkConnectionAction.remoteIpDetails.organization.asn + // // - service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg + // // - service.action.networkConnectionAction.remotePortDetails.port + // // - service.action.awsApiCallAction.remoteAccountDetails.affiliated + // // - service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4 + // // - service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6 + // // - service.action.kubernetesApiCallAction.namespace + // // - service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn + // // - service.action.kubernetesApiCallAction.requestUri + // // - service.action.kubernetesApiCallAction.statusCode + // // - service.action.networkConnectionAction.localIpDetails.ipAddressV4 + // // - service.action.networkConnectionAction.localIpDetails.ipAddressV6 + // // - service.action.networkConnectionAction.protocol + // // - service.action.awsApiCallAction.serviceName + // // - service.action.awsApiCallAction.remoteAccountDetails.accountId + // // - service.additionalInfo.threatListName + // // - service.resourceRole + // // - resource.eksClusterDetails.name + // // - resource.kubernetesDetails.kubernetesWorkloadDetails.name + // // - resource.kubernetesDetails.kubernetesWorkloadDetails.namespace + // // - resource.kubernetesDetails.kubernetesUserDetails.username + // // - resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image + // // - resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix + // // - service.ebsVolumeScanDetails.scanId + // // - // service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name // @@ -134,23 +218,42 @@ type CreateFilterInput struct { // service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash // // - resource.ecsClusterDetails.name + // // - resource.ecsClusterDetails.taskDetails.containers.image + // // - resource.ecsClusterDetails.taskDetails.definitionArn + // // - resource.containerDetails.image + // // - resource.rdsDbInstanceDetails.dbInstanceIdentifier + // // - resource.rdsDbInstanceDetails.dbClusterIdentifier + // // - resource.rdsDbInstanceDetails.engine + // // - resource.rdsDbUserDetails.user + // // - resource.rdsDbInstanceDetails.tags.key + // // - resource.rdsDbInstanceDetails.tags.value + // // - service.runtimeDetails.process.executableSha256 + // // - service.runtimeDetails.process.name + // // - service.runtimeDetails.process.name + // // - resource.lambdaDetails.functionName + // // - resource.lambdaDetails.functionArn + // // - resource.lambdaDetails.tags.key + // // - resource.lambdaDetails.tags.value // + // [FindingCriteria]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_FindingCriteria.html + // [Severity levels for GuardDuty findings]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html#guardduty_findings-severity + // // This member is required. FindingCriteria *types.FindingCriteria diff --git a/service/guardduty/api_op_CreateIPSet.go b/service/guardduty/api_op_CreateIPSet.go index fb1145f9b6c..f4ea2049709 100644 --- a/service/guardduty/api_op_CreateIPSet.go +++ b/service/guardduty/api_op_CreateIPSet.go @@ -55,8 +55,9 @@ type CreateIPSetInput struct { // This member is required. Location *string - // The user-friendly name to identify the IPSet. Allowed characters are - // alphanumeric, whitespace, dash (-), and underscores (_). + // The user-friendly name to identify the IPSet. + // + // Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_). // // This member is required. Name *string diff --git a/service/guardduty/api_op_CreateMembers.go b/service/guardduty/api_op_CreateMembers.go index 356530ec1c5..a144ead259b 100644 --- a/service/guardduty/api_op_CreateMembers.go +++ b/service/guardduty/api_op_CreateMembers.go @@ -14,26 +14,34 @@ import ( // 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. As a delegated administrator, using CreateMembers will -// enable GuardDuty in the added member accounts, with the exception of the -// organization delegated administrator account. A delegated administrator must -// enable GuardDuty prior to being added as a member. When you use CreateMembers as -// an Organizations delegated administrator, GuardDuty applies your organization's -// auto-enable settings to the member accounts in this request, irrespective of the -// accounts being new or existing members. For more information about the existing -// auto-enable settings for your organization, see -// DescribeOrganizationConfiguration (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DescribeOrganizationConfiguration.html) -// . If you disassociate a member account that was added by invitation, the member +// through an organization. +// +// As a delegated administrator, using CreateMembers will enable GuardDuty in the +// added member accounts, with the exception of the organization delegated +// administrator account. A delegated administrator must enable GuardDuty prior to +// being added as a member. +// +// When you use CreateMembers as an Organizations delegated administrator, +// GuardDuty applies your organization's auto-enable settings to the member +// accounts in this request, irrespective of the accounts being new or existing +// members. For more information about the existing auto-enable settings for your +// organization, see [DescribeOrganizationConfiguration]. +// +// If you disassociate a member account that was added by invitation, the member // account details obtained from this API, including the associated email // addresses, will be retained. This is done so that the delegated administrator -// can invoke the InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) -// API without the need to invoke the CreateMembers API again. To remove the -// details associated with a member account, the delegated administrator must -// invoke the DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// API. When the member accounts added through Organizations are later -// disassociated, you (administrator) can't invite them by calling the -// InviteMembers API. You can create an association with these member accounts -// again only by calling the CreateMembers API. +// can invoke the [InviteMembers]API without the need to invoke the CreateMembers API again. To +// remove the details associated with a member account, the delegated administrator +// must invoke the [DeleteMembers]API. +// +// When the member accounts added through Organizations are later disassociated, +// you (administrator) can't invite them by calling the InviteMembers API. You can +// create an association with these member accounts again only by calling the +// CreateMembers API. +// +// [DeleteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html +// [DescribeOrganizationConfiguration]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DescribeOrganizationConfiguration.html +// [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_DeleteMembers.go b/service/guardduty/api_op_DeleteMembers.go index 8752c3e6f0c..d578951e5fe 100644 --- a/service/guardduty/api_op_DeleteMembers.go +++ b/service/guardduty/api_op_DeleteMembers.go @@ -12,9 +12,11 @@ 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 -// attempt to disable GuardDuty for a member account in your organization. +// account) specified by the account IDs. +// +// With autoEnableOrganizationMembers 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 { params = &DeleteMembersInput{} diff --git a/service/guardduty/api_op_DescribeMalwareScans.go b/service/guardduty/api_op_DescribeMalwareScans.go index 180cf3996c4..8e4c2db447e 100644 --- a/service/guardduty/api_op_DescribeMalwareScans.go +++ b/service/guardduty/api_op_DescribeMalwareScans.go @@ -13,10 +13,13 @@ import ( // Returns a list of malware scans. Each member account can view the malware scans // 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) -// . +// 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]. +// +// [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{} @@ -52,8 +55,10 @@ 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]attributeName is + // required and it must be scanStartTime . + // + // [attributeName]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName SortCriteria *types.SortCriteria noSmithyDocumentSerde diff --git a/service/guardduty/api_op_DescribeOrganizationConfiguration.go b/service/guardduty/api_op_DescribeOrganizationConfiguration.go index 99105de49a9..8a8db096ba9 100644 --- a/service/guardduty/api_op_DescribeOrganizationConfiguration.go +++ b/service/guardduty/api_op_DescribeOrganizationConfiguration.go @@ -12,10 +12,13 @@ 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) -// . +// 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]. +// +// [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{} @@ -61,7 +64,9 @@ type DescribeOrganizationConfigurationOutput struct { MemberAccountLimitReached *bool // Indicates whether GuardDuty is automatically enabled for accounts added to the - // organization. Even though this is still supported, we recommend using + // organization. + // + // Even though this is still supported, we recommend using // AutoEnableOrganizationMembers to achieve the similar results. // // Deprecated: This field is deprecated, use AutoEnableOrganizationMembers instead @@ -69,21 +74,26 @@ type DescribeOrganizationConfigurationOutput struct { // Indicates the auto-enablement configuration of GuardDuty or any of the // corresponding protection plans for the member accounts in the organization. + // // - NEW : Indicates that when a new account joins the organization, they will // have GuardDuty or any of the corresponding protection plans enabled // automatically. + // // - ALL : Indicates that all accounts in the organization have GuardDuty and any // of the corresponding protection plans 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 or any of the corresponding protection plans // will not be automatically enabled for any account in the organization. The // administrator must manage GuardDuty for each account in the organization - // individually. When you update the auto-enable setting from ALL or NEW to NONE - // , this action doesn't disable the corresponding option for your existing - // accounts. This configuration will apply to the new accounts that join the - // organization. After you update the auto-enable settings, no new account will - // have the corresponding option as enabled. + // individually. + // + // When you update the auto-enable setting from ALL or NEW to NONE , this action + // doesn't disable the corresponding option for your existing accounts. This + // configuration will apply to the new accounts that join the organization. After + // you update the auto-enable settings, no new account will have the corresponding + // option as enabled. AutoEnableOrganizationMembers types.AutoEnableMembers // Describes which data sources are enabled automatically for member accounts. diff --git a/service/guardduty/api_op_DisassociateFromAdministratorAccount.go b/service/guardduty/api_op_DisassociateFromAdministratorAccount.go index d9d662342b5..4f26602eb0e 100644 --- a/service/guardduty/api_op_DisassociateFromAdministratorAccount.go +++ b/service/guardduty/api_op_DisassociateFromAdministratorAccount.go @@ -11,16 +11,22 @@ import ( ) // Disassociates the current GuardDuty member account from its administrator -// account. When you disassociate an invited member from a GuardDuty delegated -// administrator, the member account details obtained from the CreateMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html) -// API, including the associated email addresses, are retained. This is done so -// that the delegated administrator can invoke the InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) -// API without the need to invoke the CreateMembers API again. To remove the -// details associated with a member account, the delegated administrator must -// invoke the DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// API. With autoEnableOrganizationMembers configuration for your organization set -// to ALL , you'll receive an error if you attempt to disable GuardDuty in a member // account. +// +// When you disassociate an invited member from a GuardDuty delegated +// administrator, the member account details obtained from the [CreateMembers]API, including the +// associated email addresses, are retained. This is done so that the delegated +// administrator can invoke the [InviteMembers]API without the need to invoke the CreateMembers +// API again. To remove the details associated with a member account, the delegated +// administrator must invoke the [DeleteMembers]API. +// +// With autoEnableOrganizationMembers configuration for your organization set to +// ALL , you'll receive an error if you attempt to disable GuardDuty in a member +// account. +// +// [DeleteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html +// [CreateMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html +// [InviteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html func (c *Client) DisassociateFromAdministratorAccount(ctx context.Context, params *DisassociateFromAdministratorAccountInput, optFns ...func(*Options)) (*DisassociateFromAdministratorAccountOutput, error) { if params == nil { params = &DisassociateFromAdministratorAccountInput{} diff --git a/service/guardduty/api_op_DisassociateFromMasterAccount.go b/service/guardduty/api_op_DisassociateFromMasterAccount.go index 1a4d9678ad9..9b626803bfe 100644 --- a/service/guardduty/api_op_DisassociateFromMasterAccount.go +++ b/service/guardduty/api_op_DisassociateFromMasterAccount.go @@ -11,17 +11,21 @@ import ( ) // Disassociates the current GuardDuty member account from its administrator -// account. When you disassociate an invited member from a GuardDuty delegated -// administrator, the member account details obtained from the CreateMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html) -// API, including the associated email addresses, are retained. This is done so -// that the delegated administrator can invoke the InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) -// API without the need to invoke the CreateMembers API again. To remove the -// details associated with a member account, the delegated administrator must -// invoke the DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// API. +// account. +// +// When you disassociate an invited member from a GuardDuty delegated +// administrator, the member account details obtained from the [CreateMembers]API, including the +// associated email addresses, are retained. This is done so that the delegated +// administrator can invoke the [InviteMembers]API without the need to invoke the CreateMembers +// API again. To remove the details associated with a member account, the delegated +// administrator must invoke the [DeleteMembers]API. // // Deprecated: This operation is deprecated, use // DisassociateFromAdministratorAccount instead +// +// [DeleteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html +// [CreateMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html +// [InviteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html func (c *Client) DisassociateFromMasterAccount(ctx context.Context, params *DisassociateFromMasterAccountInput, optFns ...func(*Options)) (*DisassociateFromMasterAccountOutput, error) { if params == nil { params = &DisassociateFromMasterAccountInput{} diff --git a/service/guardduty/api_op_DisassociateMembers.go b/service/guardduty/api_op_DisassociateMembers.go index 0a6605007e0..de298483f8e 100644 --- a/service/guardduty/api_op_DisassociateMembers.go +++ b/service/guardduty/api_op_DisassociateMembers.go @@ -12,27 +12,34 @@ import ( ) // Disassociates GuardDuty member accounts (from the current administrator -// account) specified by the account IDs. When you disassociate an invited member -// from a GuardDuty delegated administrator, the member account details obtained -// from the CreateMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html) -// API, including the associated email addresses, are retained. This is done so -// that the delegated administrator can invoke the InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) -// API without the need to invoke the CreateMembers API again. To remove the -// details associated with a member account, the delegated administrator must -// invoke the DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// API. With autoEnableOrganizationMembers configuration for your organization set -// to ALL , you'll receive an error if you attempt to disassociate a member account -// before removing them from your organization. If you disassociate a member -// account that was added by invitation, the member account details obtained from -// this API, including the associated email addresses, will be retained. This is -// done so that the delegated administrator can invoke the InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) -// API without the need to invoke the CreateMembers API again. To remove the -// details associated with a member account, the delegated administrator must -// invoke the DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// API. When the member accounts added through Organizations are later -// disassociated, you (administrator) can't invite them by calling the -// InviteMembers API. You can create an association with these member accounts -// again only by calling the CreateMembers API. +// account) specified by the account IDs. +// +// When you disassociate an invited member from a GuardDuty delegated +// administrator, the member account details obtained from the [CreateMembers]API, including the +// associated email addresses, are retained. This is done so that the delegated +// administrator can invoke the [InviteMembers]API without the need to invoke the CreateMembers +// API again. To remove the details associated with a member account, the delegated +// administrator must invoke the [DeleteMembers]API. +// +// With autoEnableOrganizationMembers configuration for your organization set to +// ALL , you'll receive an error if you attempt to disassociate a member account +// before removing them from your organization. +// +// If you disassociate a member account that was added by invitation, the member +// account details obtained from this API, including the associated email +// addresses, will be retained. This is done so that the delegated administrator +// can invoke the [InviteMembers]API without the need to invoke the CreateMembers API again. To +// remove the details associated with a member account, the delegated administrator +// must invoke the [DeleteMembers]API. +// +// When the member accounts added through Organizations are later disassociated, +// you (administrator) can't invite them by calling the InviteMembers API. You can +// create an association with these member accounts again only by calling the +// CreateMembers API. +// +// [DeleteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html +// [CreateMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html +// [InviteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html func (c *Client) DisassociateMembers(ctx context.Context, params *DisassociateMembersInput, optFns ...func(*Options)) (*DisassociateMembersOutput, error) { if params == nil { params = &DisassociateMembersInput{} diff --git a/service/guardduty/api_op_GetAdministratorAccount.go b/service/guardduty/api_op_GetAdministratorAccount.go index 2e5965de2e4..35d6862235b 100644 --- a/service/guardduty/api_op_GetAdministratorAccount.go +++ b/service/guardduty/api_op_GetAdministratorAccount.go @@ -12,9 +12,10 @@ import ( ) // Provides the details of the GuardDuty administrator account associated with the -// current GuardDuty member account. If the organization's management account or a -// delegated administrator runs this API, it will return success ( HTTP 200 ) but -// no content. +// current GuardDuty member account. +// +// If the organization's management account or a delegated administrator runs this +// API, it will return success ( HTTP 200 ) but no content. 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_GetDetector.go b/service/guardduty/api_op_GetDetector.go index 2ac9412c9a3..b219a01d2f1 100644 --- a/service/guardduty/api_op_GetDetector.go +++ b/service/guardduty/api_op_GetDetector.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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_GetFindingsStatistics.go b/service/guardduty/api_op_GetFindingsStatistics.go index e4c2cad8416..cc140e70380 100644 --- a/service/guardduty/api_op_GetFindingsStatistics.go +++ b/service/guardduty/api_op_GetFindingsStatistics.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists Amazon GuardDuty findings statistics for the specified detector ID. There -// might be regional differences because some flags might not be available in all -// the Regions where GuardDuty is currently supported. For more information, see -// Regions and endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) -// . +// Lists Amazon GuardDuty findings statistics for the specified detector ID. +// +// There might be regional differences because some flags might not be available +// in all the Regions where GuardDuty is currently supported. For more information, +// see [Regions and endpoints]. +// +// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html func (c *Client) GetFindingsStatistics(ctx context.Context, params *GetFindingsStatisticsInput, optFns ...func(*Options)) (*GetFindingsStatisticsOutput, error) { if params == nil { params = &GetFindingsStatisticsInput{} diff --git a/service/guardduty/api_op_GetMalwareScanSettings.go b/service/guardduty/api_op_GetMalwareScanSettings.go index 7175fc38578..fb2386d9c46 100644 --- a/service/guardduty/api_op_GetMalwareScanSettings.go +++ b/service/guardduty/api_op_GetMalwareScanSettings.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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_GetMemberDetectors.go b/service/guardduty/api_op_GetMemberDetectors.go index 551535242cd..b96b9951b9a 100644 --- a/service/guardduty/api_op_GetMemberDetectors.go +++ b/service/guardduty/api_op_GetMemberDetectors.go @@ -12,10 +12,12 @@ 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]. +// +// [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_GetOrganizationStatistics.go b/service/guardduty/api_op_GetOrganizationStatistics.go index d5038e114e0..f577dccebe9 100644 --- a/service/guardduty/api_op_GetOrganizationStatistics.go +++ b/service/guardduty/api_op_GetOrganizationStatistics.go @@ -13,8 +13,10 @@ import ( // Retrieves how many active member accounts have each feature enabled within // GuardDuty. Only a delegated GuardDuty administrator of an organization can run -// this API. When you create a new organization, it might take up to 24 hours to -// generate the statistics for the entire organization. +// this API. +// +// When you create a new organization, it might take up to 24 hours to generate +// the statistics for the entire organization. func (c *Client) GetOrganizationStatistics(ctx context.Context, params *GetOrganizationStatisticsInput, optFns ...func(*Options)) (*GetOrganizationStatisticsOutput, error) { if params == nil { params = &GetOrganizationStatisticsInput{} diff --git a/service/guardduty/api_op_GetUsageStatistics.go b/service/guardduty/api_op_GetUsageStatistics.go index 42bb595d66e..32998d28650 100644 --- a/service/guardduty/api_op_GetUsageStatistics.go +++ b/service/guardduty/api_op_GetUsageStatistics.go @@ -15,9 +15,9 @@ import ( // detector ID. For newly enabled detectors or data sources, the cost returned will // 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) -// . +// cost estimate. For more information, see [Understanding How Usage Costs are Calculated]. +// +// [Understanding How Usage Costs are 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{} diff --git a/service/guardduty/api_op_InviteMembers.go b/service/guardduty/api_op_InviteMembers.go index cd721d4bb87..318cd68c078 100644 --- a/service/guardduty/api_op_InviteMembers.go +++ b/service/guardduty/api_op_InviteMembers.go @@ -14,34 +14,40 @@ import ( // Invites Amazon Web Services accounts to become members of an organization // administered by the Amazon Web Services account that invokes this API. If you // are using Amazon Web Services Organizations to manage your GuardDuty -// environment, this step is not needed. For more information, see Managing -// accounts with organizations (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html) -// . To invite Amazon Web Services accounts, the first step is to ensure that +// environment, this step is not needed. For more information, see [Managing accounts with organizations]. +// +// To invite Amazon Web Services accounts, the first step is to ensure that // GuardDuty has been enabled in the potential member accounts. You can now invoke // this API to add accounts by invitation. The invited accounts can either accept // or decline the invitation from their GuardDuty accounts. Each invited Amazon Web // Services account can choose to accept the invitation from only one Amazon Web -// Services account. For more information, see Managing GuardDuty accounts by -// invitation (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html) -// . After the invite has been accepted and you choose to disassociate a member -// account (by using DisassociateMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DisassociateMembers.html) -// ) from your account, the details of the member account obtained by invoking -// CreateMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html) -// , including the associated email addresses, will be retained. This is done so -// that you can invoke InviteMembers without the need to invoke CreateMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html) -// again. To remove the details associated with a member account, you must also -// invoke DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// . If you disassociate a member account that was added by invitation, the member +// Services account. For more information, see [Managing GuardDuty accounts by invitation]. +// +// After the invite has been accepted and you choose to disassociate a member +// account (by using [DisassociateMembers]) from your account, the details of the member account +// obtained by invoking [CreateMembers], including the associated email addresses, will be +// retained. This is done so that you can invoke InviteMembers without the need to +// invoke [CreateMembers]again. To remove the details associated with a member account, you must +// also invoke [DeleteMembers]. +// +// If you disassociate a member account that was added by invitation, the member // account details obtained from this API, including the associated email // addresses, will be retained. This is done so that the delegated administrator -// can invoke the InviteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html) -// API without the need to invoke the CreateMembers API again. To remove the -// details associated with a member account, the delegated administrator must -// invoke the DeleteMembers (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html) -// API. When the member accounts added through Organizations are later -// disassociated, you (administrator) can't invite them by calling the -// InviteMembers API. You can create an association with these member accounts -// again only by calling the CreateMembers API. +// can invoke the [InviteMembers]API without the need to invoke the CreateMembers API again. To +// remove the details associated with a member account, the delegated administrator +// must invoke the [DeleteMembers]API. +// +// When the member accounts added through Organizations are later disassociated, +// you (administrator) can't invite them by calling the InviteMembers API. You can +// create an association with these member accounts again only by calling the +// CreateMembers API. +// +// [Managing GuardDuty accounts by invitation]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html +// [DeleteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DeleteMembers.html +// [CreateMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html +// [Managing accounts with organizations]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html +// [DisassociateMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DisassociateMembers.html +// [InviteMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html func (c *Client) InviteMembers(ctx context.Context, params *InviteMembersInput, optFns ...func(*Options)) (*InviteMembersOutput, error) { if params == nil { params = &InviteMembersInput{} diff --git a/service/guardduty/api_op_ListCoverage.go b/service/guardduty/api_op_ListCoverage.go index 851e89f12a7..038ca184ac4 100644 --- a/service/guardduty/api_op_ListCoverage.go +++ b/service/guardduty/api_op_ListCoverage.go @@ -13,8 +13,10 @@ import ( // Lists coverage details for your GuardDuty account. If you're a GuardDuty // administrator, you can retrieve all resources associated with the active member -// accounts in your organization. Make sure the accounts have Runtime Monitoring -// enabled and GuardDuty agent running on their resources. +// accounts in your organization. +// +// Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent +// running on their resources. func (c *Client) ListCoverage(ctx context.Context, params *ListCoverageInput, optFns ...func(*Options)) (*ListCoverageOutput, error) { if params == nil { params = &ListCoverageInput{} diff --git a/service/guardduty/api_op_ListFindings.go b/service/guardduty/api_op_ListFindings.go index d812b7b5766..20e7af390b4 100644 --- a/service/guardduty/api_op_ListFindings.go +++ b/service/guardduty/api_op_ListFindings.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists GuardDuty findings for the specified detector ID. There might be regional -// differences because some flags might not be available in all the Regions where -// GuardDuty is currently supported. For more information, see Regions and -// endpoints (https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html) -// . +// Lists GuardDuty findings for the specified detector ID. +// +// There might be regional differences because some flags might not be available +// in all the Regions where GuardDuty is currently supported. For more information, +// see [Regions and endpoints]. +// +// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html func (c *Client) ListFindings(ctx context.Context, params *ListFindingsInput, optFns ...func(*Options)) (*ListFindingsOutput, error) { if params == nil { params = &ListFindingsInput{} @@ -40,58 +42,111 @@ 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.dnsRequestAction.domainWithSuffix + // // - 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.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 + // + // - 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_ListMembers.go b/service/guardduty/api_op_ListMembers.go index 26d6efcb947..d7f6c96d56d 100644 --- a/service/guardduty/api_op_ListMembers.go +++ b/service/guardduty/api_op_ListMembers.go @@ -48,8 +48,9 @@ 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]Create Members . + // + // [Create Members]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html OnlyAssociated *string noSmithyDocumentSerde @@ -57,8 +58,10 @@ type ListMembersInput struct { type ListMembersOutput struct { - // A list of members. The values for email and invitedAt are available only if the - // member accounts are added by invitation. + // A list of members. + // + // The values for email and invitedAt are available only if the member accounts + // are added by invitation. Members []types.Member // The pagination parameter to be used on the next list operation to retrieve more diff --git a/service/guardduty/api_op_StartMalwareScan.go b/service/guardduty/api_op_StartMalwareScan.go index e931eddc162..f0fb6d6a181 100644 --- a/service/guardduty/api_op_StartMalwareScan.go +++ b/service/guardduty/api_op_StartMalwareScan.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates the malware scan. Invoking this API will automatically create the -// Service-linked role (https://docs.aws.amazon.com/guardduty/latest/ug/slr-permissions-malware-protection.html) -// in the corresponding account. When the malware scan starts, you can use the -// associated scan ID to track the status of the scan. For more information, see -// DescribeMalwareScans (https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DescribeMalwareScans.html) -// . +// Initiates the malware scan. Invoking this API will automatically create the [Service-linked role] in +// the corresponding account. +// +// When the malware scan starts, you can use the associated scan ID to track the +// status of the scan. For more information, see [DescribeMalwareScans]. +// +// [DescribeMalwareScans]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DescribeMalwareScans.html +// [Service-linked role]: https://docs.aws.amazon.com/guardduty/latest/ug/slr-permissions-malware-protection.html func (c *Client) StartMalwareScan(ctx context.Context, params *StartMalwareScanInput, optFns ...func(*Options)) (*StartMalwareScanOutput, error) { if params == nil { params = &StartMalwareScanInput{} diff --git a/service/guardduty/api_op_StartMonitoringMembers.go b/service/guardduty/api_op_StartMonitoringMembers.go index 63095df8ca5..c0a1a93d05a 100644 --- a/service/guardduty/api_op_StartMonitoringMembers.go +++ b/service/guardduty/api_op_StartMonitoringMembers.go @@ -13,8 +13,9 @@ 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) -// operation. +// [StopMonitoringMembers]operation. +// +// [StopMonitoringMembers]: https://docs.aws.amazon.com/guardduty/latest/APIReference/API_StopMonitoringMembers.html func (c *Client) StartMonitoringMembers(ctx context.Context, params *StartMonitoringMembersInput, optFns ...func(*Options)) (*StartMonitoringMembersOutput, error) { if params == nil { params = &StartMonitoringMembersInput{} diff --git a/service/guardduty/api_op_StopMonitoringMembers.go b/service/guardduty/api_op_StopMonitoringMembers.go index 26842ae747e..498c3ff9b38 100644 --- a/service/guardduty/api_op_StopMonitoringMembers.go +++ b/service/guardduty/api_op_StopMonitoringMembers.go @@ -12,10 +12,11 @@ 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 , -// you'll receive an error if you attempt to stop monitoring the member accounts in -// your organization. +// StartMonitoringMembers operation to restart monitoring for those accounts. +// +// With 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) { if params == nil { params = &StopMonitoringMembersInput{} diff --git a/service/guardduty/api_op_UpdateDetector.go b/service/guardduty/api_op_UpdateDetector.go index 3ba00690689..2df93955528 100644 --- a/service/guardduty/api_op_UpdateDetector.go +++ b/service/guardduty/api_op_UpdateDetector.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the GuardDuty detector specified by the detector ID. Specifying both -// EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime Monitoring ( -// RUNTIME_MONITORING ) will cause an error. You can add only one of these two -// features because Runtime Monitoring already includes the threat detection for -// Amazon EKS resources. For more information, see Runtime Monitoring (https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) -// . There might be regional differences because some data sources might not be +// Updates the GuardDuty detector specified by the detector ID. +// +// Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime +// Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add only one of +// these two features because Runtime Monitoring already includes the threat +// detection for Amazon EKS resources. For more information, see [Runtime Monitoring]. +// +// 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]. +// +// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html +// [Runtime Monitoring]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html func (c *Client) UpdateDetector(ctx context.Context, params *UpdateDetectorInput, optFns ...func(*Options)) (*UpdateDetectorOutput, error) { if params == nil { params = &UpdateDetectorInput{} @@ -42,11 +46,13 @@ type UpdateDetectorInput struct { // This member is required. DetectorId *string - // 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) - // . + // 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]. + // + // [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_UpdateMalwareScanSettings.go b/service/guardduty/api_op_UpdateMalwareScanSettings.go index 47bcc970c32..43f650e5c1a 100644 --- a/service/guardduty/api_op_UpdateMalwareScanSettings.go +++ b/service/guardduty/api_op_UpdateMalwareScanSettings.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [Regions and 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 fca0fbc1feb..76df6a925b5 100644 --- a/service/guardduty/api_op_UpdateMemberDetectors.go +++ b/service/guardduty/api_op_UpdateMemberDetectors.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Contains information on member accounts to be updated. Specifying both EKS -// Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime Monitoring ( -// RUNTIME_MONITORING ) will cause an error. You can add only one of these two -// features because Runtime Monitoring already includes the threat detection for -// Amazon EKS resources. For more information, see Runtime Monitoring (https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) -// . There might be regional differences because some data sources might not be +// Contains information on member accounts to be updated. +// +// Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime +// Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add only one of +// these two features because Runtime Monitoring already includes the threat +// detection for Amazon EKS resources. For more information, see [Runtime Monitoring]. +// +// 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]. +// +// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html +// [Runtime Monitoring]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.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 88c65aab304..cda46dc03d0 100644 --- a/service/guardduty/api_op_UpdateOrganizationConfiguration.go +++ b/service/guardduty/api_op_UpdateOrganizationConfiguration.go @@ -13,15 +13,19 @@ import ( // Configures the delegated administrator account with the provided values. You // must provide a value for either autoEnableOrganizationMembers or autoEnable , -// but not both. Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) -// and Runtime Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add -// only one of these two features because Runtime Monitoring already includes the -// threat detection for Amazon EKS resources. For more information, see Runtime -// Monitoring (https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) -// . There might be regional differences because some data sources might not be +// but not both. +// +// Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime +// Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add only one of +// these two features because Runtime Monitoring already includes the threat +// detection for Amazon EKS resources. For more information, see [Runtime Monitoring]. +// +// 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]. +// +// [Regions and endpoints]: https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html +// [Runtime Monitoring]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *UpdateOrganizationConfigurationInput, optFns ...func(*Options)) (*UpdateOrganizationConfigurationOutput, error) { if params == nil { params = &UpdateOrganizationConfigurationInput{} @@ -45,7 +49,9 @@ type UpdateOrganizationConfigurationInput struct { DetectorId *string // Represents whether or not to automatically enable member accounts in the - // organization. Even though this is still supported, we recommend using + // organization. + // + // Even though this is still supported, we recommend using // AutoEnableOrganizationMembers to achieve the similar results. You must provide a // value for either autoEnableOrganizationMembers or autoEnable . // @@ -54,22 +60,30 @@ type UpdateOrganizationConfigurationInput struct { // Indicates the auto-enablement configuration of GuardDuty for the member // accounts in the organization. You must provide a value for either - // autoEnableOrganizationMembers or autoEnable . Use one of the following - // configuration values for autoEnableOrganizationMembers : + // autoEnableOrganizationMembers or autoEnable . + // + // Use one of the following configuration values for autoEnableOrganizationMembers : + // // - NEW : Indicates that when a new account joins the organization, they will // have GuardDuty enabled automatically. + // // - ALL : Indicates that all accounts in the 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. It may take up to 24 hours to update the configuration for all the - // member accounts. + // GuardDuty. + // + // It may take up to 24 hours to update the configuration for all the member + // accounts. + // // - NONE : Indicates that GuardDuty will not be automatically enabled for any // account in the organization. The administrator must manage GuardDuty for each - // account in the organization individually. When you update the auto-enable - // setting from ALL or NEW to NONE , this action doesn't disable the - // corresponding option for your existing accounts. This configuration will apply - // to the new accounts that join the organization. After you update the auto-enable - // settings, no new account will have the corresponding option as enabled. + // account in the organization individually. + // + // When you update the auto-enable setting from ALL or NEW to NONE , this action + // doesn't disable the corresponding option for your existing accounts. This + // configuration will apply to the new accounts that join the organization. After + // you update the auto-enable settings, no new account will have the corresponding + // option as enabled. AutoEnableOrganizationMembers types.AutoEnableMembers // Describes which data sources will be updated. diff --git a/service/guardduty/doc.go b/service/guardduty/doc.go index 6394a64c887..05336bbdff8 100644 --- a/service/guardduty/doc.go +++ b/service/guardduty/doc.go @@ -15,13 +15,16 @@ // privileges, uses of exposed credentials, or communication with malicious IPs, // domains, or presence of malware on your Amazon EC2 instances and container // workloads. For example, GuardDuty can detect compromised EC2 instances and -// container workloads serving malware, or mining bitcoin. GuardDuty also monitors -// Amazon Web Services account access behavior for signs of compromise, such as -// unauthorized infrastructure deployments like EC2 instances deployed in a Region -// that has never been used, or unusual API calls like a password policy change to -// reduce password strength. GuardDuty informs you about the status of your Amazon -// Web Services environment by producing security findings that you can view in the -// GuardDuty console or through Amazon EventBridge. For more information, see the -// Amazon GuardDuty User Guide (https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html) -// . +// container workloads serving malware, or mining bitcoin. +// +// GuardDuty also monitors Amazon Web Services account access behavior for signs +// of compromise, such as unauthorized infrastructure deployments like EC2 +// instances deployed in a Region that has never been used, or unusual API calls +// like a password policy change to reduce password strength. +// +// GuardDuty informs you about the status of your Amazon Web Services environment +// by producing security findings that you can view in the GuardDuty console or +// through Amazon EventBridge. For more information, see the [Amazon GuardDuty User Guide]. +// +// [Amazon GuardDuty User Guide]: https://docs.aws.amazon.com/guardduty/latest/ug/what-is-guardduty.html package guardduty diff --git a/service/guardduty/options.go b/service/guardduty/options.go index 8c40066092d..38b72c3cfe6 100644 --- a/service/guardduty/options.go +++ b/service/guardduty/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/guardduty/types/enums.go b/service/guardduty/types/enums.go index b96c400f653..434ba2dd060 100644 --- a/service/guardduty/types/enums.go +++ b/service/guardduty/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AdminStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdminStatus) Values() []AdminStatus { return []AdminStatus{ "ENABLED", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AutoEnableMembers. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoEnableMembers) Values() []AutoEnableMembers { return []AutoEnableMembers{ "NEW", @@ -59,6 +61,7 @@ const ( // Values returns all known values for CoverageFilterCriterionKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CoverageFilterCriterionKey) Values() []CoverageFilterCriterionKey { return []CoverageFilterCriterionKey{ @@ -92,8 +95,9 @@ const ( ) // Values returns all known values for CoverageSortKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoverageSortKey) Values() []CoverageSortKey { return []CoverageSortKey{ "ACCOUNT_ID", @@ -117,8 +121,9 @@ const ( ) // Values returns all known values for CoverageStatisticsType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoverageStatisticsType) Values() []CoverageStatisticsType { return []CoverageStatisticsType{ "COUNT_BY_RESOURCE_TYPE", @@ -135,8 +140,9 @@ const ( ) // Values returns all known values for CoverageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoverageStatus) Values() []CoverageStatus { return []CoverageStatus{ "HEALTHY", @@ -158,8 +164,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -185,8 +192,9 @@ const ( ) // Values returns all known values for DataSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSource) Values() []DataSource { return []DataSource{ "FLOW_LOGS", @@ -207,8 +215,9 @@ const ( ) // Values returns all known values for DataSourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceStatus) Values() []DataSourceStatus { return []DataSourceStatus{ "ENABLED", @@ -224,8 +233,9 @@ const ( ) // Values returns all known values for DestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationType) Values() []DestinationType { return []DestinationType{ "S3", @@ -246,8 +256,9 @@ const ( ) // Values returns all known values for DetectorFeature. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetectorFeature) Values() []DetectorFeature { return []DetectorFeature{ "S3_DATA_EVENTS", @@ -277,8 +288,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "FLOW_LOGS", @@ -303,8 +315,9 @@ const ( ) // Values returns all known values for DetectorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetectorStatus) Values() []DetectorStatus { return []DetectorStatus{ "ENABLED", @@ -321,8 +334,9 @@ const ( ) // Values returns all known values for EbsSnapshotPreservation. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EbsSnapshotPreservation) Values() []EbsSnapshotPreservation { return []EbsSnapshotPreservation{ "NO_RETENTION", @@ -341,8 +355,9 @@ const ( // Values returns all known values for FeatureAdditionalConfiguration. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureAdditionalConfiguration) Values() []FeatureAdditionalConfiguration { return []FeatureAdditionalConfiguration{ "EKS_ADDON_MANAGEMENT", @@ -360,8 +375,9 @@ const ( ) // Values returns all known values for FeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureStatus) Values() []FeatureStatus { return []FeatureStatus{ "ENABLED", @@ -378,8 +394,9 @@ const ( ) // Values returns all known values for Feedback. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Feedback) Values() []Feedback { return []Feedback{ "USEFUL", @@ -396,8 +413,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -416,6 +434,7 @@ const ( // Values returns all known values for FindingPublishingFrequency. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FindingPublishingFrequency) Values() []FindingPublishingFrequency { return []FindingPublishingFrequency{ @@ -433,8 +452,9 @@ const ( ) // Values returns all known values for FindingStatisticType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingStatisticType) Values() []FindingStatisticType { return []FindingStatisticType{ "COUNT_BY_SEVERITY", @@ -459,8 +479,9 @@ const ( ) // Values returns all known values for FreeTrialFeatureResult. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FreeTrialFeatureResult) Values() []FreeTrialFeatureResult { return []FreeTrialFeatureResult{ "FLOW_LOGS", @@ -490,8 +511,9 @@ const ( ) // Values returns all known values for IpSetFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpSetFormat) Values() []IpSetFormat { return []IpSetFormat{ "TXT", @@ -517,8 +539,9 @@ const ( ) // Values returns all known values for IpSetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpSetStatus) Values() []IpSetStatus { return []IpSetStatus{ "INACTIVE", @@ -541,8 +564,9 @@ const ( ) // Values returns all known values for ManagementType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagementType) Values() []ManagementType { return []ManagementType{ "AUTO_MANAGED", @@ -560,8 +584,9 @@ const ( ) // Values returns all known values for OrderBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderBy) Values() []OrderBy { return []OrderBy{ "ASC", @@ -583,8 +608,9 @@ const ( ) // Values returns all known values for OrgFeature. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrgFeature) Values() []OrgFeature { return []OrgFeature{ "S3_DATA_EVENTS", @@ -608,8 +634,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrgFeatureAdditionalConfiguration) Values() []OrgFeatureAdditionalConfiguration { return []OrgFeatureAdditionalConfiguration{ "EKS_ADDON_MANAGEMENT", @@ -628,8 +655,9 @@ const ( ) // Values returns all known values for OrgFeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrgFeatureStatus) Values() []OrgFeatureStatus { return []OrgFeatureStatus{ "NEW", @@ -649,8 +677,9 @@ const ( ) // Values returns all known values for ProfileSubtype. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfileSubtype) Values() []ProfileSubtype { return []ProfileSubtype{ "FREQUENT", @@ -668,8 +697,9 @@ const ( ) // Values returns all known values for ProfileType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfileType) Values() []ProfileType { return []ProfileType{ "FREQUENCY", @@ -687,8 +717,9 @@ const ( ) // Values returns all known values for PublishingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PublishingStatus) Values() []PublishingStatus { return []PublishingStatus{ "PENDING_VERIFICATION", @@ -708,8 +739,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -726,8 +758,9 @@ const ( ) // Values returns all known values for ScanCriterionKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanCriterionKey) Values() []ScanCriterionKey { return []ScanCriterionKey{ "EC2_INSTANCE_TAG", @@ -743,8 +776,9 @@ const ( ) // Values returns all known values for ScanResult. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanResult) Values() []ScanResult { return []ScanResult{ "CLEAN", @@ -763,8 +797,9 @@ const ( ) // Values returns all known values for ScanStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanStatus) Values() []ScanStatus { return []ScanStatus{ "RUNNING", @@ -783,8 +818,9 @@ const ( ) // Values returns all known values for ScanType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanType) Values() []ScanType { return []ScanType{ "GUARDDUTY_INITIATED", @@ -805,8 +841,9 @@ const ( ) // Values returns all known values for ThreatIntelSetFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThreatIntelSetFormat) Values() []ThreatIntelSetFormat { return []ThreatIntelSetFormat{ "TXT", @@ -832,8 +869,9 @@ const ( ) // Values returns all known values for ThreatIntelSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThreatIntelSetStatus) Values() []ThreatIntelSetStatus { return []ThreatIntelSetStatus{ "INACTIVE", @@ -866,8 +904,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -899,8 +938,9 @@ const ( ) // Values returns all known values for UsageStatisticType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageStatisticType) Values() []UsageStatisticType { return []UsageStatisticType{ "SUM_BY_ACCOUNT", diff --git a/service/guardduty/types/types.go b/service/guardduty/types/types.go index 2776a86a893..dff6baf56b7 100644 --- a/service/guardduty/types/types.go +++ b/service/guardduty/types/types.go @@ -246,8 +246,9 @@ 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) -// for more information. +// are being applied to the S3 bucket. See [S3 Block Public Access]for more information. +// +// [S3 Block Public Access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html type BlockPublicAccess struct { // Indicates if S3 Block Public Access is set to BlockPublicAcls . @@ -454,10 +455,13 @@ type CoverageEc2InstanceDetails struct { InstanceType *string // Indicates how the GuardDuty security agent is managed for this resource. + // // - AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this // resource. + // // - MANUAL indicates that you are responsible to deploy, update, and manage the // GuardDuty security agent updates for this resource. + // // The DISABLED status doesn't apply to Amazon EC2 instances and Amazon EKS // clusters. ManagementType ManagementType @@ -496,9 +500,12 @@ type CoverageEksClusterDetails struct { CoveredNodes *int64 // Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS - // cluster. AUTO_MANAGED indicates GuardDuty deploys and manages updates for this - // resource. MANUAL indicates that you are responsible to deploy, update, and - // manage the Amazon EKS add-on GuardDuty agent for this resource. + // cluster. + // + // AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource. + // + // MANUAL indicates that you are responsible to deploy, update, and manage the + // Amazon EKS add-on GuardDuty agent for this resource. ManagementType ManagementType noSmithyDocumentSerde @@ -533,8 +540,10 @@ type CoverageFilterCriteria struct { // operation. type CoverageFilterCriterion struct { - // An enum value representing possible filter fields. Replace the enum value - // CLUSTER_NAME with EKS_CLUSTER_NAME . CLUSTER_NAME has been deprecated. + // An enum value representing possible filter fields. + // + // Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME . CLUSTER_NAME has + // been deprecated. CriterionKey CoverageFilterCriterionKey // Contains information about the condition. @@ -592,8 +601,10 @@ type CoverageResourceDetails struct { // Information about the sorting criteria used in the coverage statistics. type CoverageSortCriteria struct { - // Represents the field name used to sort the coverage details. Replace the enum - // value CLUSTER_NAME with EKS_CLUSTER_NAME . CLUSTER_NAME has been deprecated. + // Represents the field name used to sort the coverage details. + // + // Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME . CLUSTER_NAME has + // been deprecated. AttributeName CoverageSortKey // The order in which the sorted findings are to be displayed. @@ -702,8 +713,9 @@ type DataSourcesFreeTrial struct { } // 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. +// bucket. See [S3 Server-Side Encryption]for more information. +// +// [S3 Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html type DefaultServerSideEncryption struct { // The type of encryption used for objects within the S3 bucket. @@ -743,8 +755,10 @@ type Destination struct { // an S3 bucket, and the ARN of the KMS key to use to encrypt published findings. type DestinationProperties struct { - // The ARN of the resource to publish to. To specify an S3 bucket folder use the - // following format: arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/ + // The ARN of the resource to publish to. + // + // To specify an S3 bucket folder use the following format: + // arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/ DestinationArn *string // The ARN of the KMS key to use for encryption. @@ -792,12 +806,14 @@ type DetectorAdditionalConfigurationResult struct { noSmithyDocumentSerde } -// Contains information about a GuardDuty feature. Specifying both EKS Runtime -// Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime Monitoring ( RUNTIME_MONITORING -// ) will cause an error. You can add only one of these two features because -// Runtime Monitoring already includes the threat detection for Amazon EKS -// resources. For more information, see Runtime Monitoring (https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) -// . +// Contains information about a GuardDuty feature. +// +// Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime +// Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add only one of +// these two features because Runtime Monitoring already includes the threat +// detection for Amazon EKS resources. For more information, see [Runtime Monitoring]. +// +// [Runtime Monitoring]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html type DetectorFeatureConfiguration struct { // Additional configuration for a resource. @@ -812,12 +828,14 @@ type DetectorFeatureConfiguration struct { noSmithyDocumentSerde } -// Contains information about a GuardDuty feature. Specifying both EKS Runtime -// Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime Monitoring ( RUNTIME_MONITORING -// ) will cause an error. You can add only one of these two features because -// Runtime Monitoring already includes the threat detection for Amazon EKS -// resources. For more information, see Runtime Monitoring (https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html) -// . +// Contains information about a GuardDuty feature. +// +// Specifying both EKS Runtime Monitoring ( EKS_RUNTIME_MONITORING ) and Runtime +// Monitoring ( RUNTIME_MONITORING ) will cause an error. You can add only one of +// these two features because Runtime Monitoring already includes the threat +// detection for Amazon EKS resources. For more information, see [Runtime Monitoring]. +// +// [Runtime Monitoring]: https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html type DetectorFeatureConfigurationResult struct { // Additional configuration for a resource. @@ -857,7 +875,9 @@ type DnsRequestAction struct { // The second and top level domain involved in the activity that potentially // prompted GuardDuty to generate this finding. For a list of top-level and - // second-level domains, see public suffix list (https://publicsuffix.org/) . + // second-level domains, see [public suffix list]. + // + // [public suffix list]: https://publicsuffix.org/ DomainWithSuffix *string // The network connection protocol observed in the activity that prompted @@ -1036,10 +1056,13 @@ type FargateDetails struct { Issues []string // Indicates how the GuardDuty security agent is managed for this resource. + // // - AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this // resource. + // // - DISABLED indicates that the deployment of the GuardDuty security agent is // disabled for this resource. + // // The MANUAL status doesn't apply to the Amazon Web Services Fargate (Amazon ECS // only) woprkloads. ManagementType ManagementType @@ -1082,8 +1105,10 @@ type FilterCriteria struct { type FilterCriterion struct { // An enum value representing possible scan properties to match with given scan - // entries. Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME . - // CLUSTER_NAME has been deprecated. + // entries. + // + // Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME . CLUSTER_NAME has + // been deprecated. CriterionKey CriterionKey // Contains information about the condition. @@ -1947,13 +1972,18 @@ type OrganizationAdditionalConfiguration struct { // The status of the additional configuration that will be configured for the // organization. Use one of the following values to configure the feature status // for the entire organization: + // // - NEW : Indicates that when a new account joins the organization, they will // have the additional configuration enabled automatically. + // // - ALL : Indicates that all accounts in the organization have the additional // configuration enabled automatically. This includes NEW accounts that join the // organization and accounts that may have been suspended or removed from the - // organization in GuardDuty. It may take up to 24 hours to update the - // configuration for all the member accounts. + // organization in GuardDuty. + // + // It may take up to 24 hours to update the configuration for all the member + // accounts. + // // - NONE : Indicates that the additional configuration will not be automatically // enabled for any account in the organization. The administrator must manage the // additional configuration for each account individually. @@ -1973,13 +2003,18 @@ type OrganizationAdditionalConfigurationResult struct { // Describes the status of the additional configuration that is configured for the // member accounts within the organization. One of the following values is the // status for the entire organization: + // // - NEW : Indicates that when a new account joins the organization, they will // have the additional configuration enabled automatically. + // // - ALL : Indicates that all accounts in the organization have the additional // configuration enabled automatically. This includes NEW accounts that join the // organization and accounts that may have been suspended or removed from the - // organization in GuardDuty. It may take up to 24 hours to update the - // configuration for all the member accounts. + // organization in GuardDuty. + // + // It may take up to 24 hours to update the configuration for all the member + // accounts. + // // - NONE : Indicates that the additional configuration will not be automatically // enabled for any account in the organization. The administrator must manage the // additional configuration for each account individually. @@ -2075,13 +2110,18 @@ type OrganizationFeatureConfiguration struct { // Describes the status of the feature that is configured for the member accounts // within the organization. One of the following values is the status for the // entire organization: + // // - NEW : Indicates that when a new account joins the organization, they will // have the feature enabled automatically. + // // - ALL : Indicates that all accounts in the organization have the feature // enabled automatically. This includes NEW accounts that join the organization // and accounts that may have been suspended or removed from the organization in - // GuardDuty. It may take up to 24 hours to update the configuration for all the - // member accounts. + // GuardDuty. + // + // It may take up to 24 hours to update the configuration for all the member + // accounts. + // // - NONE : Indicates that the feature will not be automatically enabled for any // account in the organization. The administrator must manage the feature for each // account individually. @@ -2102,12 +2142,15 @@ type OrganizationFeatureConfigurationResult struct { // Describes the status of the feature that is configured for the member accounts // within the organization. + // // - NEW : Indicates that when a new account joins the organization, they will // have the feature enabled automatically. + // // - ALL : Indicates that all accounts in the organization have the feature // 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 the feature will not be automatically enabled for any // account in the organization. In this case, each account will be managed // individually by the administrator. @@ -2265,9 +2308,10 @@ type OrganizationScanEc2InstanceWithFindingsResult struct { } // Information about the coverage statistics of the features for the entire Amazon -// Web Services organization. When you create a new Amazon Web Services -// organization, it might take up to 24 hours to generate the statistics summary -// for this organization. +// Web Services organization. +// +// When you create a new Amazon Web Services organization, it might take up to 24 +// hours to generate the statistics summary for this organization. type OrganizationStatistics struct { // Total number of active accounts in your Amazon Web Services organization that @@ -2294,7 +2338,9 @@ type OrganizationStatistics 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.] + // + // [Finding Your Account Canonical User ID.]: https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId Id *string noSmithyDocumentSerde @@ -2729,7 +2775,7 @@ type S3BucketDetail struct { // Describes whether S3 data event logs will be enabled as a data source. type S3LogsConfiguration struct { - // The status of S3 data event logs as a data source. + // The status of S3 data event logs as a data source. // // This member is required. Enable *bool @@ -3242,8 +3288,9 @@ type UsageStatistics struct { SumByResource []UsageResourceResult // Lists the top 50 accounts by feature that have generated the most GuardDuty - // usage, in the order from most to least expensive. Currently, this doesn't - // support RDS_LOGIN_EVENTS . + // usage, in the order from most to least expensive. + // + // Currently, this doesn't support RDS_LOGIN_EVENTS . TopAccountsByFeature []UsageTopAccountsResult // Lists the top 50 resources that have generated the most GuardDuty usage, in @@ -3271,8 +3318,9 @@ type UsageTopAccountsResult struct { // The accounts that contributed to the total usage cost. Accounts []UsageTopAccountResult - // Features by which you can generate the usage statistics. RDS_LOGIN_EVENTS is - // currently not supported with topAccountsByFeature . + // Features by which you can generate the usage statistics. + // + // RDS_LOGIN_EVENTS is currently not supported with topAccountsByFeature . Feature UsageFeature noSmithyDocumentSerde diff --git a/service/health/api_op_DescribeAffectedAccountsForOrganization.go b/service/health/api_op_DescribeAffectedAccountsForOrganization.go index 6ee2b331c3b..25602846346 100644 --- a/service/health/api_op_DescribeAffectedAccountsForOrganization.go +++ b/service/health/api_op_DescribeAffectedAccountsForOrganization.go @@ -13,12 +13,17 @@ 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) -// operation from your organization's management account. This API operation uses -// pagination. Specify the nextToken parameter in the next request to return more -// results. +// of Health events, see [Event]. +// +// Before you can call this operation, you must first enable Health to work with +// Organizations. To do this, call the [EnableHealthServiceAccessForOrganization]operation from your organization's +// management account. +// +// This API operation uses pagination. Specify the nextToken parameter in the next +// request to return more results. +// +// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html +// [EnableHealthServiceAccessForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html func (c *Client) DescribeAffectedAccountsForOrganization(ctx context.Context, params *DescribeAffectedAccountsForOrganizationInput, optFns ...func(*Options)) (*DescribeAffectedAccountsForOrganizationOutput, error) { if params == nil { params = &DescribeAffectedAccountsForOrganizationInput{} @@ -38,8 +43,11 @@ type DescribeAffectedAccountsForOrganizationInput struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 // // This member is required. EventArn *string @@ -65,13 +73,16 @@ type DescribeAffectedAccountsForOrganizationOutput struct { // This parameter specifies if the Health event is a public Amazon Web 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. EventScopeCode types.EventScopeCode diff --git a/service/health/api_op_DescribeAffectedEntities.go b/service/health/api_op_DescribeAffectedEntities.go index d30189ab341..6a2bbe28bbb 100644 --- a/service/health/api_op_DescribeAffectedEntities.go +++ b/service/health/api_op_DescribeAffectedEntities.go @@ -16,13 +16,18 @@ import ( // customer resources, groups of customer resources, or any other construct, // depending on the Amazon Web 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. +// 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. +// information, see [Resource- and action-based conditions]in the Health User Guide. +// +// [Resource- and action-based conditions]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions 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 49681ed02ba..89d051ea69a 100644 --- a/service/health/api_op_DescribeAffectedEntitiesForOrganization.go +++ b/service/health/api_op_DescribeAffectedEntitiesForOrganization.go @@ -15,16 +15,22 @@ import ( // 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 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) -// operation from your organization's management account. +// Organizations. To do this, call the [EnableHealthServiceAccessForOrganization]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. +// information, see [Resource- and action-based conditions]in the Health User Guide. +// +// [Resource- and action-based conditions]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions +// [EnableHealthServiceAccessForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html func (c *Client) DescribeAffectedEntitiesForOrganization(ctx context.Context, params *DescribeAffectedEntitiesForOrganizationInput, optFns ...func(*Options)) (*DescribeAffectedEntitiesForOrganizationOutput, error) { if params == nil { params = &DescribeAffectedEntitiesForOrganizationInput{} diff --git a/service/health/api_op_DescribeEventAggregates.go b/service/health/api_op_DescribeEventAggregates.go index 83cf6d18794..71560372d61 100644 --- a/service/health/api_op_DescribeEventAggregates.go +++ b/service/health/api_op_DescribeEventAggregates.go @@ -13,8 +13,10 @@ import ( // Returns the number of events of each event type (issue, scheduled change, and // account notification). If no filter is specified, the counts of all events in -// each category are returned. This API operation uses pagination. Specify the -// nextToken parameter in the next request to return more results. +// each category are returned. +// +// This API operation uses pagination. Specify the nextToken parameter in the next +// request to return more results. func (c *Client) DescribeEventAggregates(ctx context.Context, params *DescribeEventAggregatesInput, optFns ...func(*Options)) (*DescribeEventAggregatesOutput, error) { if params == nil { params = &DescribeEventAggregatesInput{} diff --git a/service/health/api_op_DescribeEventDetails.go b/service/health/api_op_DescribeEventDetails.go index 8627c565686..5cf756369c2 100644 --- a/service/health/api_op_DescribeEventDetails.go +++ b/service/health/api_op_DescribeEventDetails.go @@ -13,15 +13,20 @@ 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) -// 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) -// in the Health User Guide. +// returned by [DescribeEvents]), 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]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]in +// the Health User Guide. +// +// [DescribeEvents]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html +// [DescribeAffectedEntities]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html +// [Resource- and action-based conditions]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions func (c *Client) DescribeEventDetails(ctx context.Context, params *DescribeEventDetailsInput, optFns ...func(*Options)) (*DescribeEventDetailsOutput, error) { if params == nil { params = &DescribeEventDetailsInput{} diff --git a/service/health/api_op_DescribeEventDetailsForOrganization.go b/service/health/api_op_DescribeEventDetailsForOrganization.go index 85ef8689435..3de4f8eba56 100644 --- a/service/health/api_op_DescribeEventDetailsForOrganization.go +++ b/service/health/api_op_DescribeEventDetailsForOrganization.go @@ -16,29 +16,36 @@ import ( // standard event data (such as the Amazon Web Services Region and service), an // 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) -// 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) -// operation from your organization's management account. When you call the -// DescribeEventDetailsForOrganization operation, specify the +// event. To return affected entities, use the [DescribeAffectedEntitiesForOrganization]operation. +// +// Before you can call this operation, you must first enable Health to work with +// Organizations. To do this, call the [EnableHealthServiceAccessForOrganization]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. // -// 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]. +// +// 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. +// information, see [Resource- and action-based conditions]in the Health User Guide. +// +// [Resource- and action-based conditions]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions +// [DescribeAffectedEntitiesForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html +// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html +// [EnableHealthServiceAccessForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html func (c *Client) DescribeEventDetailsForOrganization(ctx context.Context, params *DescribeEventDetailsForOrganizationInput, optFns ...func(*Options)) (*DescribeEventDetailsForOrganizationOutput, error) { if params == nil { params = &DescribeEventDetailsForOrganizationInput{} diff --git a/service/health/api_op_DescribeEventTypes.go b/service/health/api_op_DescribeEventTypes.go index 2e819c76941..5eb773e0a2e 100644 --- a/service/health/api_op_DescribeEventTypes.go +++ b/service/health/api_op_DescribeEventTypes.go @@ -14,10 +14,15 @@ 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 Service, and event code. The metadata for each 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. +// appears in the [EventType]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. +// +// [EventType]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html func (c *Client) DescribeEventTypes(ctx context.Context, params *DescribeEventTypesInput, optFns ...func(*Options)) (*DescribeEventTypesOutput, error) { if params == nil { params = &DescribeEventTypesInput{} @@ -43,8 +48,10 @@ type DescribeEventTypesInput struct { Locale *string // The maximum number of items to return in one batch, between 10 and 100, - // inclusive. If you don't specify the maxResults parameter, this operation - // returns a maximum of 30 items by default. + // inclusive. + // + // If you don't specify the maxResults parameter, this operation returns a maximum + // of 30 items by default. MaxResults *int32 // If the results of a search are large, only a portion of the results are @@ -166,8 +173,10 @@ var _ DescribeEventTypesAPIClient = (*Client)(nil) // DescribeEventTypes type DescribeEventTypesPaginatorOptions struct { // The maximum number of items to return in one batch, between 10 and 100, - // inclusive. If you don't specify the maxResults parameter, this operation - // returns a maximum of 30 items by default. + // inclusive. + // + // If you don't specify the maxResults parameter, this operation returns a maximum + // of 30 items by default. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/health/api_op_DescribeEvents.go b/service/health/api_op_DescribeEvents.go index b1ed08f8d12..3bcc9857406 100644 --- a/service/health/api_op_DescribeEvents.go +++ b/service/health/api_op_DescribeEvents.go @@ -11,23 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about events that meet the specified filter criteria. +// 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. +// affected resources. To retrieve that information, use the [DescribeEventDetails]and [DescribeAffectedEntities] 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) -// . +// more information, see [Event]. +// // - This API operation uses pagination. Specify the nextToken parameter in the // next request to return more results. +// +// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html +// [DescribeAffectedEntities]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html +// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html 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 4199c80775a..4e9792e4b78 100644 --- a/service/health/api_op_DescribeEventsForOrganization.go +++ b/service/health/api_op_DescribeEventsForOrganization.go @@ -17,19 +17,31 @@ import ( // 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] +// +// [DescribeEventDetailsForOrganization] +// +// [DescribeAffectedEntitiesForOrganization] // // 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) -// operation from your organization's management account. This API operation uses -// pagination. Specify the nextToken parameter in the next request to return more -// results. +// starting with the most recent event. +// +// For more information about the different types of Health events, see [Event]. +// +// Before you can call this operation, you must first enable Health to work with +// Organizations. To do this, call the [EnableHealthServiceAccessForOrganization]operation from your organization's +// management account. +// +// This API operation uses pagination. Specify the nextToken parameter in the next +// request to return more results. +// +// [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 +// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html +// [EnableHealthServiceAccessForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html func (c *Client) DescribeEventsForOrganization(ctx context.Context, params *DescribeEventsForOrganizationInput, optFns ...func(*Options)) (*DescribeEventsForOrganizationOutput, error) { if params == nil { params = &DescribeEventsForOrganizationInput{} diff --git a/service/health/api_op_DescribeHealthServiceStatusForOrganization.go b/service/health/api_op_DescribeHealthServiceStatusForOrganization.go index 73515c63676..d7d36f34127 100644 --- a/service/health/api_op_DescribeHealthServiceStatusForOrganization.go +++ b/service/health/api_op_DescribeHealthServiceStatusForOrganization.go @@ -35,8 +35,9 @@ 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 220620c42f8..936ccb90243 100644 --- a/service/health/api_op_DisableHealthServiceAccessForOrganization.go +++ b/service/health/api_op_DisableHealthServiceAccessForOrganization.go @@ -12,17 +12,22 @@ import ( // Disables Health from working with Organizations. To call this operation, you // must sign in to 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) -// 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) -// 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 +// [Aggregating Health events]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]in +// the IAM User Guide. +// +// You can also disable the organizational feature by using the Organizations [DisableAWSServiceAccess] 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 // continues to aggregate health events for your Amazon Web Services account. +// +// [DisableAWSServiceAccess]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html +// [Aggregating Health events]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html +// [Deleting a Service-Linked Role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role func (c *Client) DisableHealthServiceAccessForOrganization(ctx context.Context, params *DisableHealthServiceAccessForOrganizationInput, optFns ...func(*Options)) (*DisableHealthServiceAccessForOrganizationOutput, error) { if params == nil { params = &DisableHealthServiceAccessForOrganizationInput{} diff --git a/service/health/api_op_EnableHealthServiceAccessForOrganization.go b/service/health/api_op_EnableHealthServiceAccessForOrganization.go index 62df92b83bd..37eaeb81d06 100644 --- a/service/health/api_op_EnableHealthServiceAccessForOrganization.go +++ b/service/health/api_op_EnableHealthServiceAccessForOrganization.go @@ -12,23 +12,28 @@ import ( // Enables Health to work with Organizations. You can use the organizational view // feature to aggregate events from all Amazon Web Services accounts in your -// 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: +// 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. +// from [Amazon Web Services Support]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) -// . +// management account. For example IAM policies, see [Health identity-based policy examples]. // // 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. +// console to enable the organizational view feature. For more information, see [Aggregating Health events]in +// the Health User Guide. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [Aggregating Health events]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html +// [Health identity-based policy examples]: https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html 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 b90c325a518..88a451b8f71 100644 --- a/service/health/doc.go +++ b/service/health/doc.go @@ -3,42 +3,56 @@ // Package health provides the API client, operations, and parameter types for AWS // Health APIs and Notifications. // -// Health The Health API provides access to the Health information that appears in -// the Health Dashboard (https://health.aws.amazon.com/health/home) . You can use -// the API operations to get information about events that might affect your Amazon -// Web 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/) +// # Health +// +// The Health API provides access to the Health information that appears in the [Health Dashboard]. +// You can use the API operations to get information about events that might affect +// your Amazon Web Services and resources. +// +// You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from [Amazon Web Services Support] // 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. For API access, you -// need an access key ID and a secret access key. Use temporary credentials instead -// of long-term access keys when possible. Temporary credentials include an access -// key ID, a secret access key, and a security token that indicates when the -// credentials expire. For more information, see Best practices for managing -// Amazon Web Services access keys (https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) -// in the Amazon Web Services General Reference. 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 +// plan, you receive a SubscriptionRequiredException error. +// +// For API access, you need an access key ID and a secret access key. Use +// temporary credentials instead of long-term access keys when possible. Temporary +// credentials include an access key ID, a secret access key, and a security token +// that indicates when the credentials expire. For more information, see [Best practices for managing Amazon Web Services access keys]in the +// Amazon Web Services General Reference. +// +// 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]in the Health User Guide. +// +// For authentication of requests, Health uses the [Signature Version 4 Signing Process]. +// +// 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. +// information. For more information, see [Aggregating Health events]in the Health User Guide. +// +// When you use the Health API operations to return Health events, see the +// following recommendations: +// +// - Use the [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. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [Aggregating Health events]: https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html +// [eventScopeCode]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode +// [Health Dashboard]: https://health.aws.amazon.com/health/home +// [Accessing the Health API]: https://docs.aws.amazon.com/health/latest/ug/health-api.html +// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html +// [Best practices for managing Amazon Web Services access keys]: https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html package health diff --git a/service/health/options.go b/service/health/options.go index a820fd9d525..c90a5eb35d7 100644 --- a/service/health/options.go +++ b/service/health/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/health/types/enums.go b/service/health/types/enums.go index 31bfe79805b..386db067a5d 100644 --- a/service/health/types/enums.go +++ b/service/health/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for EntityStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityStatusCode) Values() []EntityStatusCode { return []EntityStatusCode{ "IMPAIRED", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for EventAggregateField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventAggregateField) Values() []EventAggregateField { return []EventAggregateField{ "eventTypeCategory", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for EventScopeCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventScopeCode) Values() []EventScopeCode { return []EventScopeCode{ "PUBLIC", @@ -72,8 +75,9 @@ const ( ) // Values returns all known values for EventStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventStatusCode) Values() []EventStatusCode { return []EventStatusCode{ "open", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for EventTypeCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventTypeCategory) Values() []EventTypeCategory { return []EventTypeCategory{ "issue", diff --git a/service/health/types/errors.go b/service/health/types/errors.go index a9e9bfd23ac..4bef2f8a29a 100644 --- a/service/health/types/errors.go +++ b/service/health/types/errors.go @@ -7,10 +7,11 @@ import ( smithy "github.com/aws/smithy-go" ) -// 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) -// operation. +// [EnableHealthServiceAccessForOrganization] is already in progress. Wait for the action to complete before trying again. +// To get the current status, use the [DescribeHealthServiceStatusForOrganization]operation. +// +// [DescribeHealthServiceStatusForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeHealthServiceStatusForOrganization.html +// [EnableHealthServiceAccessForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html type ConcurrentModificationException struct { Message *string diff --git a/service/health/types/types.go b/service/health/types/types.go index cd6dfd4270b..fbc3eba8fc4 100644 --- a/service/health/types/types.go +++ b/service/health/types/types.go @@ -44,8 +44,11 @@ type AffectedEntity struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string // The most recent time that the entity was updated. @@ -55,20 +58,23 @@ type AffectedEntity struct { // are IMPAIRED , UNIMPAIRED , and UNKNOWN . StatusCode EntityStatusCode - // A map of entity tags attached to the affected entity. Currently, the tags - // property isn't supported. + // A map of entity tags attached to the affected entity. + // + // Currently, the tags property isn't supported. Tags map[string]string 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] and [EntityFilter] 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 . +// +// [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html +// [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html type DateTimeRange struct { // The starting date and time of a time range. @@ -86,8 +92,11 @@ type EntityAccountFilter struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 // // This member is required. EventArn *string @@ -102,9 +111,10 @@ type EntityAccountFilter struct { noSmithyDocumentSerde } -// 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) +// The number of entities that are affected by one or more events. Returned by the [DescribeEntityAggregates] // operation. +// +// [DescribeEntityAggregates]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEntityAggregates.html type EntityAggregate struct { // The number of entities that match the criteria for the specified events. @@ -112,8 +122,11 @@ type EntityAggregate struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string // The number of affected entities aggregated by the entity status codes. @@ -122,8 +135,9 @@ 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) -// operation. +// The values to use to filter results from the [DescribeAffectedEntities] operation. +// +// [DescribeAffectedEntities]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html type EntityFilter struct { // A list of event ARNs (unique identifiers). For example: @@ -145,33 +159,41 @@ type EntityFilter struct { // 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 - // property isn't supported. + // A map of entity tags attached to the affected entity. + // + // Currently, the tags property isn't supported. Tags []map[string]string noSmithyDocumentSerde } -// Summary information about an Health event. Health events can be public or -// account-specific: +// 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) -// . +// eventScopeCode parameter. For more information, see [eventScopeCode]. +// +// [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 // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 Arn *string // The Amazon Web Services Availability Zone of the event. For example, us-east-1a. @@ -182,13 +204,16 @@ type Event struct { // This parameter specifies if the Health event is a public Amazon Web 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. EventScopeCode EventScopeCode @@ -221,15 +246,19 @@ type Event struct { 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) -// operations. +// The values used to filter results from the [DescribeEventDetailsForOrganization] and [DescribeAffectedEntitiesForOrganization] operations. +// +// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html +// [DescribeAffectedEntitiesForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html type EventAccountFilter struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 // // This member is required. EventArn *string @@ -241,8 +270,9 @@ 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) -// operation. +// The number of events of each issue type. Returned by the [DescribeEventAggregates] operation. +// +// [DescribeEventAggregates]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html type EventAggregate struct { // The issue type for the associated count. @@ -255,8 +285,9 @@ 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) -// operation. +// the [DescribeEventDetails]operation. +// +// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html type EventDescription struct { // The most recent description of the event. @@ -265,11 +296,12 @@ 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) -// object, and additional metadata about the event. Returned by the -// DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) -// operation. +// Detailed information about an event. A combination of an [Event] object, an [EventDescription] object, +// and additional metadata about the event. Returned by the [DescribeEventDetails]operation. +// +// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html +// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html +// [EventDescription]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html type EventDetails struct { // Summary information about the event. @@ -284,8 +316,9 @@ type EventDetails struct { noSmithyDocumentSerde } -// Error information returned when a DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) -// operation can't find a specified event. +// Error information returned when a [DescribeEventDetails] operation can't find a specified event. +// +// [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html type EventDetailsErrorItem struct { // A message that describes the error. @@ -296,16 +329,20 @@ type EventDetailsErrorItem struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string 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) -// operations. +// The values to use to filter results from the [DescribeEvents] and [DescribeEventAggregates] operations. +// +// [DescribeEvents]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html +// [DescribeEventAggregates]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventAggregates.html type EventFilter struct { // A list of Amazon Web Services Availability Zones. @@ -350,8 +387,9 @@ type EventFilter struct { // A list of dates and times that the event began. StartTimes []DateTimeRange - // A map of entity tags attached to the affected entity. Currently, the tags - // property isn't supported. + // A map of entity tags attached to the affected entity. + // + // Currently, the tags property isn't supported. Tags []map[string]string noSmithyDocumentSerde @@ -360,14 +398,17 @@ type EventFilter struct { // Contains the metadata about a type of event that is reported by Health. The // 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) -// 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. +// AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code. +// +// You can use the [DescribeEventTypes] 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]in the Health User +// Guide. +// +// [Monitor for Health events with Amazon CloudWatch Events]: https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html +// [DescribeEventTypes]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html type EventType struct { // A list of event type category codes. Possible values are issue , @@ -385,8 +426,9 @@ type EventType struct { noSmithyDocumentSerde } -// The values to use to filter results from the DescribeEventTypes (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html) -// operation. +// The values to use to filter results from the [DescribeEventTypes] operation. +// +// [DescribeEventTypes]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html type EventTypeFilter struct { // A list of event type category codes. Possible values are issue , @@ -403,8 +445,10 @@ type EventTypeFilter struct { noSmithyDocumentSerde } -// 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. +// Error information returned when a [DescribeAffectedEntitiesForOrganization] operation can't find or process a specific +// entity. +// +// [DescribeAffectedEntitiesForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html type OrganizationAffectedEntitiesErrorItem struct { // The 12-digit Amazon Web Services account numbers that contains the affected @@ -412,8 +456,10 @@ type OrganizationAffectedEntitiesErrorItem struct { AwsAccountId *string // A message that describes the error. Follow the error message and retry your - // request. For example, the InvalidAccountInputError error message appears if you - // call the DescribeAffectedEntitiesForOrganization operation and specify the + // request. + // + // For example, the InvalidAccountInputError error message appears if you call the + // DescribeAffectedEntitiesForOrganization operation and specify the // AccountSpecific value for the EventScopeCode parameter, but don't specify an // Amazon Web Services account. ErrorMessage *string @@ -423,8 +469,11 @@ type OrganizationAffectedEntitiesErrorItem struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string noSmithyDocumentSerde @@ -455,15 +504,18 @@ type OrganizationEntityAggregate struct { noSmithyDocumentSerde } -// Summary information about an event, returned by the -// DescribeEventsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) -// operation. +// Summary information about an event, returned by the [DescribeEventsForOrganization] operation. +// +// [DescribeEventsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html type OrganizationEvent struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 Arn *string // The date and time that the event ended. @@ -471,13 +523,16 @@ type OrganizationEvent struct { // This parameter specifies if the Health event is a public Amazon Web 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. EventScopeCode EventScopeCode @@ -510,35 +565,42 @@ type OrganizationEvent 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) -// object, and additional metadata about the event. Returned by the -// DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) -// operation. +// Detailed information about an event. A combination of an [Event] object, an [EventDescription] object, +// and additional metadata about the event. Returned by the [DescribeEventDetailsForOrganization]operation. +// +// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html +// [Event]: https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html +// [EventDescription]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventDescription.html type OrganizationEventDetails struct { // The 12-digit Amazon Web Services account numbers that contains the affected // entities. AwsAccountId *string - // Summary information about an Health event. Health events can be public or - // account-specific: + // 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) - // . + // eventScopeCode parameter. For more information, see [eventScopeCode]. + // + // [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) - // operation. + // the [DescribeEventDetails]operation. + // + // [DescribeEventDetails]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html EventDescription *EventDescription // Additional metadata about the event. @@ -547,23 +609,29 @@ type OrganizationEventDetails struct { noSmithyDocumentSerde } -// Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) -// operation can't find a specified event. +// Error information returned when a [DescribeEventDetailsForOrganization] operation can't find a specified event. +// +// [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html type OrganizationEventDetailsErrorItem struct { - // Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) - // operation can't find a specified event. + // Error information returned when a [DescribeEventDetailsForOrganization] operation can't find a specified event. + // + // [DescribeEventDetailsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html 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: + // 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. @@ -574,28 +642,34 @@ type OrganizationEventDetailsErrorItem struct { // The unique identifier for the event. The event ARN has the // arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // format. For example, an event ARN might look like the following: - // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string noSmithyDocumentSerde } -// The values to filter results from the DescribeEventsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html) -// operation. +// The values to filter results from the [DescribeEventsForOrganization] operation. +// +// [DescribeEventsForOrganization]: https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html type OrganizationEventFilter struct { // A list of 12-digit Amazon Web Services account numbers that contains the // 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] and [EntityFilter] 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 . + // + // [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html + // [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html EndTime *DateTimeRange // A list of entity ARNs (unique identifiers). @@ -617,13 +691,15 @@ 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] and [EntityFilter] 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 . + // + // [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html + // [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html LastUpdatedTime *DateTimeRange // A list of Amazon Web Services Regions. @@ -632,13 +708,15 @@ type OrganizationEventFilter struct { // The Amazon Web 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] and [EntityFilter] 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 . + // + // [EntityFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EntityFilter.html + // [EventFilter]: https://docs.aws.amazon.com/health/latest/APIReference/API_EventFilter.html StartTime *DateTimeRange noSmithyDocumentSerde diff --git a/service/healthlake/api_op_CreateFHIRDatastore.go b/service/healthlake/api_op_CreateFHIRDatastore.go index e09f74fc3f8..5337e531d98 100644 --- a/service/healthlake/api_op_CreateFHIRDatastore.go +++ b/service/healthlake/api_op_CreateFHIRDatastore.go @@ -48,11 +48,11 @@ type CreateFHIRDatastoreInput struct { // the only supported preloaded data is synthetic data generated from Synthea. PreloadDataConfig *types.PreloadDataConfig - // The server-side encryption key configuration for a customer provided encryption - // key specified for creating a data store. + // The server-side encryption key configuration for a customer provided + // encryption key specified for creating a data store. SseConfiguration *types.SseConfiguration - // Resource tags that are applied to a data store when it is created. + // Resource tags that are applied to a data store when it is created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/healthlake/api_op_DeleteFHIRDatastore.go b/service/healthlake/api_op_DeleteFHIRDatastore.go index cac9c7bcf3f..d04fd4192e0 100644 --- a/service/healthlake/api_op_DeleteFHIRDatastore.go +++ b/service/healthlake/api_op_DeleteFHIRDatastore.go @@ -29,7 +29,7 @@ func (c *Client) DeleteFHIRDatastore(ctx context.Context, params *DeleteFHIRData type DeleteFHIRDatastoreInput struct { - // The AWS-generated ID for the data store to be deleted. + // The AWS-generated ID for the data store to be deleted. // // This member is required. DatastoreId *string diff --git a/service/healthlake/api_op_ListFHIRExportJobs.go b/service/healthlake/api_op_ListFHIRExportJobs.go index 726fe65c9e8..f10cd392a8c 100644 --- a/service/healthlake/api_op_ListFHIRExportJobs.go +++ b/service/healthlake/api_op_ListFHIRExportJobs.go @@ -30,33 +30,33 @@ func (c *Client) ListFHIRExportJobs(ctx context.Context, params *ListFHIRExportJ type ListFHIRExportJobsInput struct { - // This parameter limits the response to the export job with the specified data + // This parameter limits the response to the export job with the specified data // store ID. // // This member is required. DatastoreId *string - // This parameter limits the response to the export job with the specified job + // This parameter limits the response to the export job with the specified job // name. JobName *string - // This parameter limits the response to the export jobs with the specified job + // This parameter limits the response to the export jobs with the specified job // status. JobStatus types.JobStatus - // This parameter limits the number of results returned for a ListFHIRExportJobs + // 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 + // A pagination token used to identify the next page of results to return for a // ListFHIRExportJobs query. NextToken *string - // This parameter limits the response to FHIR export jobs submitted after a user + // This parameter limits the response to FHIR export jobs submitted after a user // specified date. SubmittedAfter *time.Time - // This parameter limits the response to FHIR export jobs submitted before a user + // This parameter limits the response to FHIR export jobs submitted before a user // specified date. SubmittedBefore *time.Time @@ -65,13 +65,13 @@ type ListFHIRExportJobsInput struct { type ListFHIRExportJobsOutput struct { - // The properties of listed FHIR export jobs, including the ID, ARN, name, and the - // status of the job. + // The properties of listed FHIR export jobs, including the ID, ARN, name, and + // the status of the job. // // This member is required. ExportJobPropertiesList []types.ExportJobProperties - // A pagination token used to identify the next page of results to return for a + // A pagination token used to identify the next page of results to return for a // ListFHIRExportJobs query. NextToken *string @@ -171,7 +171,7 @@ 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 + // This parameter limits the number of results returned for a ListFHIRExportJobs // to a maximum quantity specified by the user. Limit int32 diff --git a/service/healthlake/api_op_ListFHIRImportJobs.go b/service/healthlake/api_op_ListFHIRImportJobs.go index 69d2728ea11..1f0c6c7adf5 100644 --- a/service/healthlake/api_op_ListFHIRImportJobs.go +++ b/service/healthlake/api_op_ListFHIRImportJobs.go @@ -30,33 +30,33 @@ func (c *Client) ListFHIRImportJobs(ctx context.Context, params *ListFHIRImportJ type ListFHIRImportJobsInput struct { - // This parameter limits the response to the import job with the specified data + // This parameter limits the response to the import job with the specified data // store ID. // // This member is required. DatastoreId *string - // This parameter limits the response to the import job with the specified job + // This parameter limits the response to the import job with the specified job // name. JobName *string - // This parameter limits the response to the import job with the specified job + // This parameter limits the response to the import job with the specified job // status. JobStatus types.JobStatus - // This parameter limits the number of results returned for a ListFHIRImportJobs + // 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 + // A pagination token used to identify the next page of results to return for a // ListFHIRImportJobs query. NextToken *string - // This parameter limits the response to FHIR import jobs submitted after a user + // This parameter limits the response to FHIR import jobs submitted after a user // specified date. SubmittedAfter *time.Time - // This parameter limits the response to FHIR import jobs submitted before a user + // This parameter limits the response to FHIR import jobs submitted before a user // specified date. SubmittedBefore *time.Time @@ -65,13 +65,13 @@ type ListFHIRImportJobsInput struct { type ListFHIRImportJobsOutput struct { - // The properties of a listed FHIR import jobs, including the ID, ARN, name, the + // The properties of a listed FHIR import jobs, including the ID, ARN, name, the // status of the job, and the progress report of the job. // // This member is required. ImportJobPropertiesList []types.ImportJobProperties - // A pagination token used to identify the next page of results to return for a + // A pagination token used to identify the next page of results to return for a // ListFHIRImportJobs query. NextToken *string @@ -171,7 +171,7 @@ 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 + // This parameter limits the number of results returned for a ListFHIRImportJobs // to a maximum quantity specified by the user. Limit int32 diff --git a/service/healthlake/api_op_ListTagsForResource.go b/service/healthlake/api_op_ListTagsForResource.go index 2d0dc47e471..8bfac9d7df9 100644 --- a/service/healthlake/api_op_ListTagsForResource.go +++ b/service/healthlake/api_op_ListTagsForResource.go @@ -29,7 +29,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name(ARN) of the data store for which tags are being added. + // The Amazon Resource Name(ARN) of the data store for which tags are being + // added. // // This member is required. ResourceARN *string @@ -39,7 +40,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // Returns a list of tags associated with a data store. + // Returns a list of tags associated with a data store. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/healthlake/api_op_TagResource.go b/service/healthlake/api_op_TagResource.go index 8af1d7dab4f..ab066dde8dc 100644 --- a/service/healthlake/api_op_TagResource.go +++ b/service/healthlake/api_op_TagResource.go @@ -29,13 +29,13 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store - // which tags are being added to. + // The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data + // store which tags are being added to. // // This member is required. ResourceARN *string - // The user specified key and value pair tags being added to a data store. + // The user specified key and value pair tags being added to a data store. // // This member is required. Tags []types.Tag diff --git a/service/healthlake/api_op_UntagResource.go b/service/healthlake/api_op_UntagResource.go index 7a2fb45fdd8..b89d2cc99d4 100644 --- a/service/healthlake/api_op_UntagResource.go +++ b/service/healthlake/api_op_UntagResource.go @@ -34,7 +34,7 @@ type UntagResourceInput struct { // This member is required. ResourceARN *string - // The keys for the tags to be removed from the HealthLake data store. + // The keys for the tags to be removed from the HealthLake data store. // // This member is required. TagKeys []string diff --git a/service/healthlake/options.go b/service/healthlake/options.go index 49ab3b42377..61f468792d8 100644 --- a/service/healthlake/options.go +++ b/service/healthlake/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/healthlake/types/enums.go b/service/healthlake/types/enums.go index d186f085760..4ba7f5ad9f5 100644 --- a/service/healthlake/types/enums.go +++ b/service/healthlake/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AuthorizationStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizationStrategy) Values() []AuthorizationStrategy { return []AuthorizationStrategy{ "SMART_ON_FHIR_V1", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for CmkType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmkType) Values() []CmkType { return []CmkType{ "CUSTOMER_MANAGED_KMS_KEY", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for DatastoreStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatastoreStatus) Values() []DatastoreStatus { return []DatastoreStatus{ "CREATING", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for ErrorCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ErrorCategory) Values() []ErrorCategory { return []ErrorCategory{ "RETRYABLE_ERROR", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for FHIRVersion. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FHIRVersion) Values() []FHIRVersion { return []FHIRVersion{ "R4", @@ -112,8 +117,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -136,8 +142,9 @@ const ( ) // Values returns all known values for PreloadDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreloadDataType) Values() []PreloadDataType { return []PreloadDataType{ "SYNTHEA", diff --git a/service/healthlake/types/types.go b/service/healthlake/types/types.go index e57ad0e943e..d584aca2fd6 100644 --- a/service/healthlake/types/types.go +++ b/service/healthlake/types/types.go @@ -73,8 +73,8 @@ type DatastoreProperties struct { // Synthea is supported. PreloadDataConfig *PreloadDataConfig - // The server-side encryption key configuration for a customer provided encryption - // key (CMK). + // The server-side encryption key configuration for a customer provided + // encryption key (CMK). SseConfiguration *SseConfiguration noSmithyDocumentSerde @@ -157,17 +157,25 @@ type IdentityProviderConfiguration struct { // The JSON metadata elements that you want to use in your identity provider // configuration. Required elements are listed based on the launch specification of - // the SMART application. For more information on all possible elements, see - // Metadata (https://build.fhir.org/ig/HL7/smart-app-launch/conformance.html#metadata) - // in SMART's App Launch specification. authorization_endpoint : The URL to the - // OAuth2 authorization endpoint. grant_types_supported : An array of grant types - // that are supported at the token endpoint. You must provide at least one grant - // type option. Valid options are authorization_code and client_credentials . - // token_endpoint : The URL to the OAuth2 token endpoint. capabilities : An array - // of strings of the SMART capabilities that the authorization server supports. + // the SMART application. For more information on all possible elements, see [Metadata]in + // SMART's App Launch specification. + // + // authorization_endpoint : The URL to the OAuth2 authorization endpoint. + // + // grant_types_supported : An array of grant types that are supported at the token + // endpoint. You must provide at least one grant type option. Valid options are + // authorization_code and client_credentials . + // + // token_endpoint : The URL to the OAuth2 token endpoint. + // + // capabilities : An array of strings of the SMART capabilities that the + // authorization server supports. + // // code_challenge_methods_supported : An array of strings of supported PKCE code // challenge methods. You must include the S256 method in the array of PKCE code // challenge methods. + // + // [Metadata]: https://build.fhir.org/ig/HL7/smart-app-launch/conformance.html#metadata Metadata *string noSmithyDocumentSerde @@ -226,7 +234,7 @@ type ImportJobProperties struct { noSmithyDocumentSerde } -// The input properties for an import job. +// The input properties for an import job. // // The following types satisfy this interface: // @@ -276,17 +284,19 @@ type JobProgressReport struct { noSmithyDocumentSerde } -// The customer-managed-key(CMK) used when creating a data store. If a customer +// The customer-managed-key(CMK) used when creating a data store. If a customer +// // owned key is not specified, an AWS owned key will be used for encryption. type KmsEncryptionConfig struct { - // The type of customer-managed-key(CMK) used for encryption. The two types of + // The type of customer-managed-key(CMK) used for encryption. The two types of // supported CMKs are customer owned CMKs and AWS owned CMKs. // // This member is required. CmkType CmkType - // The KMS encryption key id/alias used to encrypt the data store contents at rest. + // The KMS encryption key id/alias used to encrypt the data store contents at + // rest. KmsKeyId *string noSmithyDocumentSerde @@ -301,7 +311,9 @@ type OutputDataConfig interface { isOutputDataConfig() } -// The output data configuration that was supplied when the export job was created. +// The output data configuration that was supplied when the export job was +// +// created. type OutputDataConfigMemberS3Configuration struct { Value S3Configuration @@ -310,7 +322,8 @@ type OutputDataConfigMemberS3Configuration struct { func (*OutputDataConfigMemberS3Configuration) isOutputDataConfig() {} -// The input properties for the preloaded data store. Only data preloaded from +// The input properties for the preloaded data store. Only data preloaded from +// // Synthea is supported. type PreloadDataConfig struct { @@ -322,16 +335,17 @@ type PreloadDataConfig struct { noSmithyDocumentSerde } -// The configuration of the S3 bucket for either an import or export job. This +// The configuration of the S3 bucket for either an import or export job. This +// // includes assigning permissions for access. type S3Configuration struct { - // The KMS key ID used to access the S3 bucket. + // The KMS key ID used to access the S3 bucket. // // This member is required. KmsKeyId *string - // The S3Uri is the user specified S3 location of the FHIR data to be imported + // The S3Uri is the user specified S3 location of the FHIR data to be imported // into AWS HealthLake. // // This member is required. @@ -340,11 +354,12 @@ type S3Configuration struct { noSmithyDocumentSerde } -// The server-side encryption key configuration for a customer provided encryption -// key. +// The server-side encryption key configuration for a customer provided +// +// encryption key. type SseConfiguration struct { - // The KMS encryption configuration used to provide details for data encryption. + // The KMS encryption configuration used to provide details for data encryption. // // This member is required. KmsEncryptionConfig *KmsEncryptionConfig @@ -352,16 +367,17 @@ type SseConfiguration struct { noSmithyDocumentSerde } -// A tag is a label consisting of a user-defined key and value. The form for tags +// A tag is a label consisting of a user-defined key and value. The form for tags +// // is {"Key", "Value"} type Tag struct { - // The key portion of a tag. Tag keys are case sensitive. + // The key portion of a tag. Tag keys are case sensitive. // // This member is required. Key *string - // The value portion of a tag. Tag values are case sensitive. + // The value portion of a tag. Tag values are case sensitive. // // This member is required. Value *string diff --git a/service/honeycode/api_op_BatchCreateTableRows.go b/service/honeycode/api_op_BatchCreateTableRows.go index fa013fb3e02..08e2067e9e6 100644 --- a/service/honeycode/api_op_BatchCreateTableRows.go +++ b/service/honeycode/api_op_BatchCreateTableRows.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The BatchCreateTableRows API allows you to create one or more rows at the end +// 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, -// then that column will be left blank for the new rows. +// 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, then that column will be left blank +// for the new rows. func (c *Client) BatchCreateTableRows(ctx context.Context, params *BatchCreateTableRowsInput, optFns ...func(*Options)) (*BatchCreateTableRowsOutput, error) { if params == nil { params = &BatchCreateTableRowsInput{} @@ -36,35 +39,42 @@ 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 + // 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 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 - // The ID of the table where the new rows are being added. If a table with the - // specified ID could not be found, this API throws ResourceNotFoundException. + // The ID of the table where the new rows are being added. + // + // If a table with the specified ID could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string - // The ID of the workbook where the new rows are being added. If a workbook with - // the specified ID could not be found, this API throws ResourceNotFoundException. + // The ID of the workbook where the new rows are being added. + // + // If a workbook with the specified ID could not be found, this API throws + // ResourceNotFoundException. // // This member is required. WorkbookId *string - // The request token for performing the batch create operation. Request tokens + // 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. + // 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 @@ -82,7 +92,7 @@ type BatchCreateTableRowsOutput struct { // This member is required. WorkbookCursor int64 - // The list of batch items in the request that could not be added to the table. + // The list of batch items in the request that could not be added to the table. // Each element in this list contains one item from the request that could not be // added to the table along with the reason why that item could not be added. FailedBatchItems []types.FailedBatchItem diff --git a/service/honeycode/api_op_BatchDeleteTableRows.go b/service/honeycode/api_op_BatchDeleteTableRows.go index 171140881aa..56e24481757 100644 --- a/service/honeycode/api_op_BatchDeleteTableRows.go +++ b/service/honeycode/api_op_BatchDeleteTableRows.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The BatchDeleteTableRows API allows you to delete one or more rows from a table -// in a workbook. You need to specify the ids of the rows that you want to delete -// from the table. +// The BatchDeleteTableRows API allows you to delete one or more rows from a +// +// table in a workbook. You need to specify the ids of the rows that you want to +// delete from the table. func (c *Client) BatchDeleteTableRows(ctx context.Context, params *BatchDeleteTableRowsInput, optFns ...func(*Options)) (*BatchDeleteTableRowsOutput, error) { if params == nil { params = &BatchDeleteTableRowsInput{} @@ -31,32 +32,39 @@ func (c *Client) BatchDeleteTableRows(ctx context.Context, params *BatchDeleteTa type BatchDeleteTableRowsInput struct { - // The list of row ids to delete from the table. You need to specify at least one - // row id in this list. Note that if one of the row ids provided in the request - // does not exist in the table, then the request fails and no rows are deleted from - // the table. + // The list of row ids to delete from the table. You need to specify at least one + // row id in this list. + // + // Note that if one of the row ids provided in the request does not exist in the + // table, then the request fails and no rows are deleted from the table. // // This member is required. RowIds []string - // The ID of the table where the rows are being deleted. If a table with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the table where the rows are being deleted. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string - // The ID of the workbook where the rows are being deleted. 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 deleted. + // + // If a workbook with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. WorkbookId *string - // The request token for performing the delete action. Request tokens help to + // The request token for performing the delete action. 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 action - // again. Note that request tokens are valid only for a few minutes. You cannot use + // 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 @@ -70,7 +78,7 @@ type BatchDeleteTableRowsOutput struct { // This member is required. WorkbookCursor int64 - // The list of row ids in the request that could not be deleted from the table. + // The list of row ids in the request that could not be deleted from the table. // Each element in this list contains one row id from the request that could not be // deleted along with the reason why that item could not be deleted. FailedBatchItems []types.FailedBatchItem diff --git a/service/honeycode/api_op_BatchUpdateTableRows.go b/service/honeycode/api_op_BatchUpdateTableRows.go index 2b9e17a169a..1a95829617c 100644 --- a/service/honeycode/api_op_BatchUpdateTableRows.go +++ b/service/honeycode/api_op_BatchUpdateTableRows.go @@ -11,12 +11,14 @@ 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{} @@ -34,34 +36,42 @@ 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 + // 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. + // 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 - // The ID of the table where the rows are being updated. If a table with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the table where the rows are being updated. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string - // The ID of the workbook where the rows are being updated. 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 updated. + // + // If a workbook with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. WorkbookId *string - // The request token for performing the update action. Request tokens help to + // The request token for performing the update action. 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 action - // again. Note that request tokens are valid only for a few minutes. You cannot use + // 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 @@ -75,7 +85,7 @@ type BatchUpdateTableRowsOutput struct { // This member is required. WorkbookCursor int64 - // The list of batch items in the request that could not be updated in the table. + // The list of batch items in the request that could not be updated in the table. // Each element in this list contains one item from the request that could not be // updated in the table along with the reason why that item could not be updated. FailedBatchItems []types.FailedBatchItem diff --git a/service/honeycode/api_op_BatchUpsertTableRows.go b/service/honeycode/api_op_BatchUpsertTableRows.go index 6dc7223a019..05f14d118b9 100644 --- a/service/honeycode/api_op_BatchUpsertTableRows.go +++ b/service/honeycode/api_op_BatchUpsertTableRows.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The BatchUpsertTableRows API allows you to upsert one or more rows in a table. +// The BatchUpsertTableRows API allows you to upsert one or more rows in a table. +// // The upsert operation takes a filter expression as input and evaluates it to find // matching rows on the destination table. If matching rows are found, it will // update the cells in the matching rows to new values specified in the request. If // no matching rows are found, a new row is added at the end of the table and the -// cells in that row are set to the new values specified in the request. You can -// specify the values to set in some or all of the columns in the table for the -// matching or newly appended rows. If a column is not explicitly specified for 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 (""). +// cells in that row are set to the new values specified in the request. +// +// You can specify the values to set in some or all of the columns in the table +// for the matching or newly appended rows. If a column is not explicitly specified +// for 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) BatchUpsertTableRows(ctx context.Context, params *BatchUpsertTableRowsInput, optFns ...func(*Options)) (*BatchUpsertTableRowsOutput, error) { if params == nil { params = &BatchUpsertTableRowsInput{} @@ -38,36 +41,43 @@ func (c *Client) BatchUpsertTableRows(ctx context.Context, params *BatchUpsertTa type BatchUpsertTableRowsInput struct { - // The list of rows to upsert in the table. Each item in this list needs to have a - // batch item id to uniquely identify the element in the request, a filter + // The list of rows to upsert in the table. Each item in this list needs to have + // a batch item id to uniquely identify the element in the request, a filter // expression to find the rows to update for that element and the cell values to // set for each column in the upserted rows. You need to specify at least one item - // in this list. Note that if one of the filter formulas in the request fails to - // evaluate because of an error or one of the column ids in any of the rows does - // not exist in the table, then the request fails and no updates are made to the - // table. + // in this list. + // + // Note that if one of the filter formulas in the request fails to evaluate + // because of an error or one of the column ids in any of the rows does not exist + // in the table, then the request fails and no updates are made to the table. // // This member is required. RowsToUpsert []types.UpsertRowData - // The ID of the table where the rows are being upserted. If a table with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the table where the rows are being upserted. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // 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 - // The request token for performing the update action. Request tokens help to + // The request token for performing the update action. 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 action - // again. Note that request tokens are valid only for a few minutes. You cannot use + // 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 @@ -76,7 +86,7 @@ type BatchUpsertTableRowsInput struct { type BatchUpsertTableRowsOutput struct { - // A map with the batch item id as the key and the result of the upsert operation + // A map with the batch item id as the key and the result of the upsert operation // as the value. The result of the upsert operation specifies whether existing rows // were updated or a new row was appended, along with the list of row ids that were // affected. @@ -89,8 +99,8 @@ type BatchUpsertTableRowsOutput struct { // This member is required. WorkbookCursor int64 - // The list of batch items in the request that could not be updated or appended in - // the table. Each element in this list contains one item from the request that + // The list of batch items in the request that could not be updated or appended + // in the table. Each element in this list contains one item from the request that // could not be updated in the table along with the reason why that item could not // be updated or appended. FailedBatchItems []types.FailedBatchItem diff --git a/service/honeycode/api_op_DescribeTableDataImportJob.go b/service/honeycode/api_op_DescribeTableDataImportJob.go index 4ae1a971a0f..d1f6a2728c1 100644 --- a/service/honeycode/api_op_DescribeTableDataImportJob.go +++ b/service/honeycode/api_op_DescribeTableDataImportJob.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DescribeTableDataImportJob API allows you to retrieve the status and +// 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 { @@ -30,21 +31,26 @@ 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. JobId *string - // The ID of the table into which data was imported. If a table with the specified - // id could not be found, this API throws ResourceNotFoundException. + // The ID of the table into which data was imported. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string - // The ID of the workbook into which data was imported. If a workbook with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the workbook into which data was imported. + // + // If a workbook with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. WorkbookId *string @@ -54,22 +60,22 @@ type DescribeTableDataImportJobInput struct { type DescribeTableDataImportJobOutput struct { - // The metadata about the job that was submitted for import. + // The metadata about the job that was submitted for import. // // This member is required. JobMetadata *types.TableDataImportJobMetadata - // The current status of the import job. + // The current status of the import job. // // This member is required. JobStatus types.TableDataImportJobStatus - // A message providing more details about the current status of the import job. + // A message providing more details about the current status of the import job. // // This member is required. Message *string - // If job status is failed, error code to understand reason for the failure. + // If job status is failed, error code to understand reason for the failure. ErrorCode types.ErrorCode // Metadata pertaining to the operation's result. diff --git a/service/honeycode/api_op_GetScreenData.go b/service/honeycode/api_op_GetScreenData.go index 0c63f89a461..4ff832245ab 100644 --- a/service/honeycode/api_op_GetScreenData.go +++ b/service/honeycode/api_op_GetScreenData.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The GetScreenData API allows retrieval of data from a screen in a Honeycode +// 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) { @@ -46,18 +47,21 @@ type GetScreenDataInput struct { // This member is required. WorkbookId *string - // The number of results to be returned on a single page. Specify a number between - // 1 and 100. The maximum value is 100. This parameter is optional. If you don't - // specify this parameter, the default page size is 100. + // The number of results to be returned on a single page. Specify a number + // between 1 and 100. The maximum value is 100. + // + // This parameter is optional. If you don't 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 - // ValidationException. + // 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 + // 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 @@ -74,14 +78,14 @@ 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 + // 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 - // Provides the pagination token to load the next page if there are more results + // Provides the pagination token to load the next page if there are more results // matching the request. If a pagination token is not present in the response, it // means that all data matching the query has been loaded. NextToken *string diff --git a/service/honeycode/api_op_InvokeScreenAutomation.go b/service/honeycode/api_op_InvokeScreenAutomation.go index 7c87f8ac79d..3f4bb27cf36 100644 --- a/service/honeycode/api_op_InvokeScreenAutomation.go +++ b/service/honeycode/api_op_InvokeScreenAutomation.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The InvokeScreenAutomation API allows invoking an action defined in a screen in -// a Honeycode app. The API allows setting local variables, which can then be used -// in the automation being invoked. This allows automating the Honeycode app +// The InvokeScreenAutomation API allows invoking an action defined in a screen +// +// in a Honeycode app. The API allows setting local variables, which can then be +// used in the automation being invoked. This allows automating the Honeycode app // interactions to write, update or delete data in the workbook. func (c *Client) InvokeScreenAutomation(ctx context.Context, params *InvokeScreenAutomationInput, optFns ...func(*Options)) (*InvokeScreenAutomationOutput, error) { if params == nil { @@ -52,21 +53,22 @@ type InvokeScreenAutomationInput struct { // This member is required. WorkbookId *string - // The request token for performing the automation action. Request tokens help to + // The request token for performing the automation action. 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 return the response of the - // previous call rather than performing the action again. Note that request tokens - // are valid only for a few minutes. You cannot use request tokens to dedupe - // requests spanning hours or days. + // previous call rather than performing the action 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 - // The row ID for the automation if the automation is defined inside a block with + // The row ID for the automation if the automation is defined inside a block with // source or list. RowId *string - // Variables are specified as a map where the key is the name of the variable as + // 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. Any variables defined in a screen are required to be passed in the call. diff --git a/service/honeycode/api_op_ListTableColumns.go b/service/honeycode/api_op_ListTableColumns.go index f45f43b9b07..8a9f99ae981 100644 --- a/service/honeycode/api_op_ListTableColumns.go +++ b/service/honeycode/api_op_ListTableColumns.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListTableColumns API allows you to retrieve a list of all the columns in a +// The ListTableColumns API allows you to retrieve a list of all the columns in a +// // table in a workbook. func (c *Client) ListTableColumns(ctx context.Context, params *ListTableColumnsInput, optFns ...func(*Options)) (*ListTableColumnsOutput, error) { if params == nil { @@ -30,23 +31,28 @@ func (c *Client) ListTableColumns(ctx context.Context, params *ListTableColumnsI type ListTableColumnsInput struct { - // The ID of the table whose columns are being retrieved. If a table with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the table whose columns are being retrieved. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string // The ID of the workbook that contains the table whose columns are being - // retrieved. If a workbook with the specified id could not be found, this API - // throws ResourceNotFoundException. + // retrieved. + // + // If a workbook with the specified id could not be found, this API throws + // ResourceNotFoundException. // // 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 - // ValidationException. + // 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 noSmithyDocumentSerde @@ -54,19 +60,19 @@ type ListTableColumnsInput struct { type ListTableColumnsOutput struct { - // The list of columns in the table. + // The list of columns in the table. // // This member is required. TableColumns []types.TableColumn - // Provides the pagination token to load the next page if there are more results + // Provides the pagination token to load the next page if there are more results // matching the request. If a pagination token is not present in the response, it // means that all data matching the request has been loaded. NextToken *string - // Indicates the cursor of the workbook at which the data returned by this request - // 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 + // request is read. Workbook cursor keeps increasing with every update and the + // increments are not sequential. WorkbookCursor int64 // Metadata pertaining to the operation's result. diff --git a/service/honeycode/api_op_ListTableRows.go b/service/honeycode/api_op_ListTableRows.go index 6797497f8ae..f1406c042e1 100644 --- a/service/honeycode/api_op_ListTableRows.go +++ b/service/honeycode/api_op_ListTableRows.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListTableRows API allows you to retrieve a list of all the rows in a table +// The ListTableRows API allows you to retrieve a list of all the rows in a table +// // in a workbook. func (c *Client) ListTableRows(ctx context.Context, params *ListTableRowsInput, optFns ...func(*Options)) (*ListTableRowsOutput, error) { if params == nil { @@ -30,13 +31,16 @@ func (c *Client) ListTableRows(ctx context.Context, params *ListTableRowsInput, type ListTableRowsInput struct { - // The ID of the table whose rows are being retrieved. If a table with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the table whose rows are being retrieved. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string // The ID of the workbook that contains the table whose rows are being retrieved. + // // If a workbook with the specified id could not be found, this API throws // ResourceNotFoundException. // @@ -46,13 +50,14 @@ 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 - // ValidationException. + // 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 - // This parameter is optional. If one or more row ids are specified in this list, + // This parameter is optional. If one or more row ids are specified in this list, // then only the specified row ids are returned in the result. If no row ids are // specified here, then all the rows in the table are returned. RowIds []string @@ -62,30 +67,30 @@ type ListTableRowsInput struct { type ListTableRowsOutput struct { - // The list of columns in the table whose row data is returned in the result. + // The list of columns in the table whose row data is returned in the result. // // This member is required. ColumnIds []string - // The list of rows in the table. Note that this result is paginated, so this list - // contains a maximum of 100 rows. + // The list of rows in the table. Note that this result is paginated, so this + // list contains a maximum of 100 rows. // // This member is required. Rows []types.TableRow - // Indicates the cursor of the workbook at which the data returned by this request - // 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 + // request is read. Workbook cursor keeps increasing with every update and the + // increments are not sequential. // // This member is required. WorkbookCursor int64 - // Provides the pagination token to load the next page if there are more results + // Provides the pagination token to load the next page if there are more results // matching the request. If a pagination token is not present in the response, it // means that all data matching the request has been loaded. NextToken *string - // The list of row ids included in the request that were not found in the table. + // The list of row ids included in the request that were not found in the table. RowIdsNotFound []string // Metadata pertaining to the operation's result. diff --git a/service/honeycode/api_op_ListTables.go b/service/honeycode/api_op_ListTables.go index 67917f54af5..9cf3f2eb376 100644 --- a/service/honeycode/api_op_ListTables.go +++ b/service/honeycode/api_op_ListTables.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListTables API allows you to retrieve a list of all the tables in a +// The ListTables API allows you to retrieve a list of all the tables in a +// // workbook. func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error) { if params == nil { @@ -30,8 +31,10 @@ func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns type ListTablesInput struct { - // The ID of the workbook whose tables are being retrieved. If a workbook with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the workbook whose tables are being retrieved. + // + // If a workbook with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. WorkbookId *string @@ -39,10 +42,11 @@ 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 - // ValidationException. + // 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 noSmithyDocumentSerde @@ -50,19 +54,19 @@ type ListTablesInput struct { type ListTablesOutput struct { - // The list of tables in the workbook. + // The list of tables in the workbook. // // This member is required. Tables []types.Table - // Provides the pagination token to load the next page if there are more results + // Provides the pagination token to load the next page if there are more results // matching the request. If a pagination token is not present in the response, it // means that all data matching the request has been loaded. NextToken *string - // Indicates the cursor of the workbook at which the data returned by this request - // 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 + // request is read. Workbook cursor keeps increasing with every update and the + // increments are not sequential. WorkbookCursor int64 // Metadata pertaining to the operation's result. diff --git a/service/honeycode/api_op_QueryTableRows.go b/service/honeycode/api_op_QueryTableRows.go index 40b88b028c6..0ea8a20d08d 100644 --- a/service/honeycode/api_op_QueryTableRows.go +++ b/service/honeycode/api_op_QueryTableRows.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The QueryTableRows API allows you to use a filter formula to query for specific -// rows in a table. +// The QueryTableRows API allows you to use a filter formula to query for +// +// specific rows in a table. func (c *Client) QueryTableRows(ctx context.Context, params *QueryTableRowsInput, optFns ...func(*Options)) (*QueryTableRowsOutput, error) { if params == nil { params = &QueryTableRowsInput{} @@ -36,14 +37,18 @@ type QueryTableRowsInput struct { // This member is required. FilterFormula *types.Filter - // The ID of the table whose rows are being queried. If a table with the specified - // id could not be found, this API throws ResourceNotFoundException. + // The ID of the table whose rows are being queried. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. TableId *string - // The ID of the workbook whose table rows are being queried. If a workbook with - // the specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the workbook whose table rows are being queried. + // + // If a workbook with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. WorkbookId *string @@ -51,10 +56,11 @@ 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 - // ValidationException. + // 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 noSmithyDocumentSerde @@ -62,24 +68,24 @@ type QueryTableRowsInput struct { type QueryTableRowsOutput struct { - // The list of columns in the table whose row data is returned in the result. + // The list of columns in the table whose row data is returned in the result. // // This member is required. ColumnIds []string - // The list of rows in the table that match the query filter. + // The list of rows in the table that match the query filter. // // This member is required. Rows []types.TableRow - // Indicates the cursor of the workbook at which the data returned by this request - // 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 + // request is read. Workbook cursor keeps increasing with every update and the + // increments are not sequential. // // This member is required. WorkbookCursor int64 - // Provides the pagination token to load the next page if there are more results + // Provides the pagination token to load the next page if there are more results // matching the request. If a pagination token is not present in the response, it // means that all data matching the request has been loaded. NextToken *string diff --git a/service/honeycode/api_op_StartTableDataImportJob.go b/service/honeycode/api_op_StartTableDataImportJob.go index 33001e38601..d362222a080 100644 --- a/service/honeycode/api_op_StartTableDataImportJob.go +++ b/service/honeycode/api_op_StartTableDataImportJob.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The StartTableDataImportJob API allows you to start an import job on a table. +// The StartTableDataImportJob API allows you to start an import job on a table. +// // This API will only return the id of the job that was started. To find out the // status of the import request, you need to call the DescribeTableDataImportJob // API. @@ -32,43 +33,49 @@ func (c *Client) StartTableDataImportJob(ctx context.Context, params *StartTable type StartTableDataImportJobInput struct { - // The request token for performing the update action. Request tokens help to + // The request token for performing the update action. 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 action - // again. Note that request tokens are valid only for a few minutes. You cannot use + // again. + // + // Note that request tokens are valid only for a few minutes. You cannot use // request tokens to dedupe requests spanning hours or days. // // This member is required. ClientRequestToken *string - // The format of the data that is being imported. Currently the only option + // The format of the data that is being imported. Currently the only option // supported is "DELIMITED_TEXT". // // This member is required. DataFormat types.ImportSourceDataFormat - // The source of the data that is being imported. The size of source must be no + // The source of the data that is being imported. The size of source must be no // larger than 100 MB. Source must have no more than 100,000 cells and no more than // 1,000 rows. // // This member is required. DataSource *types.ImportDataSource - // The ID of the table where the rows are being imported. If a table with the - // specified id could not be found, this API throws ResourceNotFoundException. + // The ID of the table where the rows are being imported. + // + // If a table with the specified id could not be found, this API throws + // ResourceNotFoundException. // // This member is required. DestinationTableId *string - // The options for customizing this import request. + // The options for customizing this import request. // // 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 @@ -78,14 +85,14 @@ type StartTableDataImportJobInput struct { type StartTableDataImportJobOutput struct { - // The id that is assigned to this import job. Future requests to find out the + // The id that is assigned to this import job. Future requests to find out the // status of this import job need to send this id in the appropriate parameter in // the request. // // This member is required. JobId *string - // The status of the import job immediately after submitting the request. + // The status of the import job immediately after submitting the request. // // This member is required. JobStatus types.TableDataImportJobStatus diff --git a/service/honeycode/api_op_TagResource.go b/service/honeycode/api_op_TagResource.go index df7ff2bc91d..ddf1e08b54d 100644 --- a/service/honeycode/api_op_TagResource.go +++ b/service/honeycode/api_op_TagResource.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The TagResource API allows you to add tags to an ARN-able resource. Resource +// The TagResource API allows you to add tags to an ARN-able resource. Resource +// // includes workbook, table, screen and screen-automation. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { diff --git a/service/honeycode/api_op_UntagResource.go b/service/honeycode/api_op_UntagResource.go index 67adf76a819..84ccd5cdc08 100644 --- a/service/honeycode/api_op_UntagResource.go +++ b/service/honeycode/api_op_UntagResource.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UntagResource API allows you to removes tags from an ARN-able resource. +// The UntagResource API allows you to removes tags from an ARN-able resource. +// // Resource includes workbook, table, screen and screen-automation. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { diff --git a/service/honeycode/doc.go b/service/honeycode/doc.go index 5cd5c2b153b..322ca7443dd 100644 --- a/service/honeycode/doc.go +++ b/service/honeycode/doc.go @@ -3,7 +3,8 @@ // Package honeycode provides the API client, operations, and parameter types for // Amazon Honeycode. // -// Amazon Honeycode is a fully managed service that allows you to quickly build +// Amazon Honeycode is a fully managed service that allows you to quickly build +// // mobile and web apps for teams—without programming. Build Honeycode apps for // managing almost anything, like projects, customers, operations, approvals, // resources, and even your team. diff --git a/service/honeycode/options.go b/service/honeycode/options.go index aee88c423f5..3cc0428c01b 100644 --- a/service/honeycode/options.go +++ b/service/honeycode/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/honeycode/types/enums.go b/service/honeycode/types/enums.go index c386b05d7dc..575c9889f11 100644 --- a/service/honeycode/types/enums.go +++ b/service/honeycode/types/enums.go @@ -23,8 +23,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -63,8 +64,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "AUTO", @@ -96,6 +98,7 @@ const ( // Values returns all known values for ImportDataCharacterEncoding. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ImportDataCharacterEncoding) Values() []ImportDataCharacterEncoding { return []ImportDataCharacterEncoding{ @@ -116,8 +119,9 @@ const ( ) // Values returns all known values for ImportSourceDataFormat. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportSourceDataFormat) Values() []ImportSourceDataFormat { return []ImportSourceDataFormat{ "DELIMITED_TEXT", @@ -136,6 +140,7 @@ const ( // 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{ @@ -155,8 +160,9 @@ const ( ) // 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. +// expanded in the future, and so 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 28da2e72a3c..8320a1e9cd3 100644 --- a/service/honeycode/types/errors.go +++ b/service/honeycode/types/errors.go @@ -7,7 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// You do not have sufficient access to perform this action. Check that the +// You do not have sufficient access to perform this action. Check that the +// // workbook is owned by you and your IAM policy allows access to the resource in // the request. type AccessDeniedException struct { @@ -246,7 +247,8 @@ func (e *ThrottlingException) ErrorCode() string { } func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Request is invalid. The message in the response contains details on why the +// Request is invalid. The message in the response contains details on why the +// // request is invalid. type ValidationException struct { Message *string diff --git a/service/honeycode/types/types.go b/service/honeycode/types/types.go index 9fa3ab574a5..3d5e8e510eb 100644 --- a/service/honeycode/types/types.go +++ b/service/honeycode/types/types.go @@ -14,84 +14,101 @@ 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 + // A list of formatted values of the cell. This field is only returned when the // cell is ROWSET format (aka multi-select or multi-record picklist). Values in the // list are always represented as strings. The formattedValue field will be empty // if this field is returned. FormattedValues []string - // The formula contained in the cell. This field is empty if a cell does not have + // 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 + // The raw value of the data contained in the cell. The raw value depends on the // format of the data in the cell. However the attribute in the API return value is - // always a string containing the raw value. Cells with format DATE, DATE_TIME or - // TIME have the raw value as a floating point number where the whole number - // represents the number of days since 1/1/1900 and the fractional part represents - // the fraction of the day since midnight. For example, a cell with date 11/3/2020 - // has the raw value "44138". A cell with the time 9:00 AM has the raw value - // "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the raw value - // "44138.375". Notice that even though the raw value is a number in all three - // cases, it is still represented as a string. Cells with format NUMBER, CURRENCY, - // PERCENTAGE and ACCOUNTING have the raw value of the data as the number - // 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 + // always a string containing the raw value. + // + // Cells with format DATE, DATE_TIME or TIME have the raw value as a floating + // point number where the whole number represents the number of days since 1/1/1900 + // and the fractional part represents the fraction of the day since midnight. For + // example, a cell with date 11/3/2020 has the raw value "44138". A cell with the + // time 9:00 AM has the raw value "0.375" and a cell with date/time value of + // 11/3/2020 9:00 AM has the raw value "44138.375". Notice that even though the raw + // value is a number in all three cases, it is still represented as a string. + // + // Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the raw + // value of the data as the number 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 // "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 - // the formatted value in the list, and the rowset id of the linked rows as the raw - // value. For example, a cell containing a multi-select picklist to a table that - // contains items might have "Item A", "Item B" in the formatted value list and + // 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 the formatted value + // in the list, and the rowset id of the linked rows as the raw value. For example, + // a cell containing a multi-select picklist to a table that contains items might + // have "Item A", "Item B" in the formatted value list and // "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/ // [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]" as - // the raw value. Cells with format ATTACHMENT will have the name of the attachment - // as the formatted value and the attachment id as the raw value. For example, a - // cell containing an attachment named "image.jpeg" will have "image.jpeg" as the + // the raw value. + // + // Cells with format ATTACHMENT will have the name of the attachment as the + // formatted value and the attachment id as the raw value. For example, a cell + // containing an attachment named "image.jpeg" will have "image.jpeg" as the // formatted value and "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw - // value. Cells with format AUTO or cells without any format that are auto-detected - // as one of the formats above will contain the raw and formatted values as - // mentioned above, based on the auto-detected formats. If there is no - // auto-detected format, the raw and formatted values will be the same as the data - // in the cell. + // value. + // + // Cells with format AUTO or cells without any format that are auto-detected as + // one of the formats above will contain the raw and formatted values as mentioned + // above, based on the auto-detected formats. If there is no auto-detected format, + // the raw and formatted values will be the same as the data in the cell. RawValue *string noSmithyDocumentSerde } -// CellInput object contains the data needed to create or update cells in a table. -// CellInput object has only a facts field or a fact field, but not both. A 400 bad -// request will be thrown if both fact and facts field are present. +// CellInput object contains the data needed to create or update cells in a +// +// table. +// +// CellInput object has only a facts field or a fact field, but not both. A 400 +// bad 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 + // 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 + // A list representing the values that are entered into a ROWSET cell. Facts list // can have either only values or rowIDs, and rowIDs should from the same table. Facts []string @@ -114,11 +131,12 @@ type ColumnMetadata struct { noSmithyDocumentSerde } -// Data needed to create a single row in a table as part of the +// Data needed to create a single row in a table as part of the +// // BatchCreateTableRows request. type CreateRowData struct { - // An external identifier that represents the single row that is being created as + // An external identifier that represents the single row that is being created as // part of the BatchCreateTableRows request. This can be any string that you can // use to identify the row in the request. The BatchCreateTableRows API puts the // batch item id in the results to allow you to link data in the request to data in @@ -127,8 +145,8 @@ type CreateRowData struct { // This member is required. BatchItemId *string - // A map representing the cells to create in the new row. The key is the column id - // of the cell and the value is the CellInput object that represents the data to + // A map representing the cells to create in the new 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. @@ -143,7 +161,7 @@ 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 + // 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 @@ -154,7 +172,8 @@ type DataItem struct { noSmithyDocumentSerde } -// An object that contains the options relating to parsing delimited text as part +// An object that contains the options relating to parsing delimited text as part +// // of an import request. type DelimitedTextImportOptions struct { @@ -187,16 +206,17 @@ type DestinationOptions struct { noSmithyDocumentSerde } -// A single item in a batch that failed to perform the intended action because of +// A single item in a batch that failed to perform the intended action because of +// // an error preventing it from succeeding. type FailedBatchItem struct { - // The error message that indicates why the batch item failed. + // The error message that indicates why the batch item failed. // // This member is required. ErrorMessage *string - // The id of the batch item that failed. This is the batch item id for the + // The id of the batch item that failed. This is the batch item id for the // BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the // BatchUpdateTableRows and BatchDeleteTableRows operations. // @@ -206,11 +226,12 @@ type FailedBatchItem struct { noSmithyDocumentSerde } -// An object that represents a filter formula along with the id of the context row -// under which the filter function needs to evaluate. +// An object that represents a filter formula along with the id of the context +// +// row under which the filter function needs to evaluate. type Filter struct { - // A formula representing a filter function that returns zero or more matching + // 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 @@ -220,7 +241,7 @@ type Filter struct { // This member is required. Formula *string - // The optional contextRowId attribute can be used to specify the row id of the + // The optional contextRowId attribute can be used to specify the row id of the // context row if the filter formula contains unqualified references to table // columns and needs a context row to evaluate them successfully. ContextRowId *string @@ -240,11 +261,12 @@ type ImportDataSource struct { noSmithyDocumentSerde } -// An object that contains the configuration parameters for the data source of an +// An object that contains the configuration parameters for the data source of an +// // import request. type ImportDataSourceConfig struct { - // The URL from which source data will be downloaded for the import request. + // The URL from which source data will be downloaded for the import request. DataSourceUrl *string noSmithyDocumentSerde @@ -290,26 +312,29 @@ type ResultRow struct { noSmithyDocumentSerde } -// ResultSet contains the results of the request for a single block or list +// 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 + // List of headers for all the data cells in the block. The header identifies the // name and default format of the data cell. Data cells appear in the same order in // all rows as defined in the header. The names and formats are not repeated in the // rows. If a particular row does not have a value for a data cell, a blank value - // is used. For example, a task list that displays the task name, due date and - // assigned person might have headers [ { "name": "Task Name"}, {"name": "Due - // Date", "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row - // in the result will have the task name as the first item, due date as the second - // item and assigned person as the third item. If a particular task does not have a - // due date, that row will still have a blank value in the second element and the + // is used. + // + // For example, a task list that displays the task name, due date and assigned + // person might have headers [ { "name": "Task Name"}, {"name": "Due Date", + // "format": "DATE"}, {"name": "Assigned", "format": "CONTACT"} ]. Every row in the + // result will have the task name as the first item, due date as the second item + // and assigned person as the third item. If a particular task does not have a due + // date, that row will still have a blank value in the second element and the // assigned person will still be in the third element. // // This member is required. Headers []ColumnMetadata - // List of rows returned by the request. Each row has a row Id and a list of data + // List of rows returned by the request. Each row has a row Id and a list of data // cells in that row. The data cells will be present in the same order as they are // defined in the header. // @@ -344,7 +369,7 @@ type Table struct { // An object that contains attributes about a single column in a table type TableColumn struct { - // The column level format that is applied in the table. An empty value in this + // The column level format that is applied in the table. An empty value in this // field means that the column format is the default value 'AUTO'. Format Format @@ -400,18 +425,19 @@ type TableRow struct { noSmithyDocumentSerde } -// Data needed to create a single row in a table as part of the +// Data needed to create a single row in a table as part of the +// // BatchCreateTableRows request. type UpdateRowData struct { - // A map representing the cells to update in the given row. The key is the column + // A map representing the cells to update in the given 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 - // The id of the row that needs to be updated. + // The id of the row that needs to be updated. // // This member is required. RowId *string @@ -419,11 +445,12 @@ type UpdateRowData struct { noSmithyDocumentSerde } -// Data needed to upsert rows in a table as part of a single item in the +// Data needed to upsert rows in a table as part of a single item in the +// // BatchUpsertTableRows request. type UpsertRowData struct { - // An external identifier that represents a single item in the request that is + // An external identifier that represents a single item in the request that is // being upserted as part of the BatchUpsertTableRows request. This can be any // string that you can use to identify the item in the request. The // BatchUpsertTableRows API puts the batch item id in the results to allow you to @@ -432,21 +459,23 @@ type UpsertRowData struct { // This member is required. BatchItemId *string - // A map representing the cells to update for the matching rows or an appended + // 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 - // The filter formula to use to find existing matching rows to update. The formula - // needs to return zero or more rows. If the formula returns 0 rows, then a new row - // will be appended in the target table. If the formula returns one or more rows, - // then the returned rows will be updated. Note that the filter formula needs to - // return rows from the target table for the upsert operation to succeed. If the - // filter formula has a syntax error or it doesn't evaluate to zero or more rows in - // the target table for any one item in the input list, then the entire - // BatchUpsertTableRows request fails and no updates are made to the table. + // The filter formula to use to find existing matching rows to update. The + // formula needs to return zero or more rows. If the formula returns 0 rows, then a + // new row will be appended in the target table. If the formula returns one or more + // rows, then the returned rows will be updated. + // + // Note that the filter formula needs to return rows from the target table for the + // upsert operation to succeed. If the filter formula has a syntax error or it + // doesn't evaluate to zero or more rows in the target table for any one item in + // the input list, then the entire BatchUpsertTableRows request fails and no + // updates are made to the table. // // This member is required. Filter *Filter @@ -457,7 +486,7 @@ 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 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. @@ -465,7 +494,7 @@ type UpsertRowsResult struct { // This member is required. RowIds []string - // The result of the upsert action. + // The result of the upsert action. // // This member is required. UpsertAction UpsertAction diff --git a/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go b/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go index b38b1d456c9..6809c834ff9 100644 --- a/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go +++ b/service/iam/api_op_AddClientIDToOpenIDConnectProvider.go @@ -11,8 +11,9 @@ import ( ) // Adds a new client ID (also known as audience) to the list of client IDs already -// registered for the specified IAM OpenID Connect (OIDC) provider resource. This -// operation is idempotent; it does not fail or return an error if you add an +// registered for the specified IAM OpenID Connect (OIDC) provider resource. +// +// This operation is idempotent; it does not fail or return an error if you add an // existing client ID to the provider. func (c *Client) AddClientIDToOpenIDConnectProvider(ctx context.Context, params *AddClientIDToOpenIDConnectProviderInput, optFns ...func(*Options)) (*AddClientIDToOpenIDConnectProviderOutput, error) { if params == nil { @@ -39,7 +40,7 @@ type AddClientIDToOpenIDConnectProviderInput struct { // The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider // resource to add the client ID to. You can get a list of OIDC provider ARNs by - // using the ListOpenIDConnectProviders operation. + // using the ListOpenIDConnectProvidersoperation. // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_AddRoleToInstanceProfile.go b/service/iam/api_op_AddRoleToInstanceProfile.go index 54c27cb4b40..b4c8880ddc3 100644 --- a/service/iam/api_op_AddRoleToInstanceProfile.go +++ b/service/iam/api_op_AddRoleToInstanceProfile.go @@ -14,15 +14,20 @@ 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 IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) -// in the IAM User Guide. For more information about instance profiles, see Using -// instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) -// in the IAM User Guide. +// because of [eventual consistency]. To force the change, you must [disassociate the instance profile] and then [associate the instance profile], 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 [IAM roles] in the IAM User Guide. For more +// information about instance profiles, see [Using instance profiles]in the IAM User Guide. +// +// [disassociate the instance profile]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html +// [associate the instance profile]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html +// [Using instance profiles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html +// [eventual consistency]: https://en.wikipedia.org/wiki/Eventual_consistency +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html func (c *Client) AddRoleToInstanceProfile(ctx context.Context, params *AddRoleToInstanceProfileInput, optFns ...func(*Options)) (*AddRoleToInstanceProfileOutput, error) { if params == nil { params = &AddRoleToInstanceProfileInput{} @@ -40,18 +45,24 @@ 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // The name of the instance profile to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_AddUserToGroup.go b/service/iam/api_op_AddUserToGroup.go index 23c34433ad2..290df222b41 100644 --- a/service/iam/api_op_AddUserToGroup.go +++ b/service/iam/api_op_AddUserToGroup.go @@ -28,18 +28,24 @@ 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the group to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_AttachGroupPolicy.go b/service/iam/api_op_AttachGroupPolicy.go index 28063a7b902..84a6ba5b521 100644 --- a/service/iam/api_op_AttachGroupPolicy.go +++ b/service/iam/api_op_AttachGroupPolicy.go @@ -10,14 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 (https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutGroupPolicy.html) -// . 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. +// 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]PutGroupPolicy . +// +// As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in +// the IAM User Guide. +// +// For more information about policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// [PutGroupPolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutGroupPolicy.html +// [Validating IAM policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) AttachGroupPolicy(ctx context.Context, params *AttachGroupPolicyInput, optFns ...func(*Options)) (*AttachGroupPolicyOutput, error) { if params == nil { params = &AttachGroupPolicyInput{} @@ -35,17 +40,23 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name (friendly name, not ARN) of the group to attach the policy to. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to attach. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_AttachRolePolicy.go b/service/iam/api_op_AttachRolePolicy.go index 649f7660924..0222f260d6d 100644 --- a/service/iam/api_op_AttachRolePolicy.go +++ b/service/iam/api_op_AttachRolePolicy.go @@ -12,16 +12,24 @@ import ( // 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 (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) -// . You can update a role's trust policy using UpdateAssumerolePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html) -// . Use this operation to attach a managed policy to a role. To embed an inline -// policy in a role, use PutRolePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutRolePolicy.html) -// . 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) +// 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]CreateRole . You can +// update a role's trust policy using [UpdateAssumerolePolicy]UpdateAssumerolePolicy . +// +// Use this operation to attach a managed policy to a role. To embed an inline +// policy in a role, use [PutRolePolicy]PutRolePolicy . For more information about policies, see [Managed policies and inline policies] // in the IAM User Guide. +// +// As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in +// the IAM User Guide. +// +// [Validating IAM policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html +// [UpdateAssumerolePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html +// [PutRolePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutRolePolicy.html +// [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) AttachRolePolicy(ctx context.Context, params *AttachRolePolicyInput, optFns ...func(*Options)) (*AttachRolePolicyOutput, error) { if params == nil { params = &AttachRolePolicyInput{} @@ -39,17 +47,23 @@ 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to attach. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name (friendly name, not ARN) of the role to attach the policy to. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_AttachUserPolicy.go b/service/iam/api_op_AttachUserPolicy.go index 52f4010a62f..fffb369bb97 100644 --- a/service/iam/api_op_AttachUserPolicy.go +++ b/service/iam/api_op_AttachUserPolicy.go @@ -10,14 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 (https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutUserPolicy.html) -// . 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. +// 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]PutUserPolicy . +// +// As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in +// the IAM User Guide. +// +// For more information about policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// [Validating IAM policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html +// [PutUserPolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutUserPolicy.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) AttachUserPolicy(ctx context.Context, params *AttachUserPolicyInput, optFns ...func(*Options)) (*AttachUserPolicyOutput, error) { if params == nil { params = &AttachUserPolicyInput{} @@ -35,17 +40,23 @@ 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to attach. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name (friendly name, not ARN) of the IAM user to attach the policy to. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_ChangePassword.go b/service/iam/api_op_ChangePassword.go index 5999053d312..04d31e0556b 100644 --- a/service/iam/api_op_ChangePassword.go +++ b/service/iam/api_op_ChangePassword.go @@ -14,10 +14,13 @@ import ( // operation can be performed using the CLI, the Amazon Web Services API, or the My // Security Credentials page in the Amazon Web Services Management Console. The // 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. +// 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]in the IAM User Guide. +// +// [Managing passwords]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput, optFns ...func(*Options)) (*ChangePasswordOutput, error) { if params == nil { params = &ChangePasswordInput{} @@ -36,16 +39,19 @@ 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 + // account's password policy, if one exists. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. NewPassword *string diff --git a/service/iam/api_op_CreateAccessKey.go b/service/iam/api_op_CreateAccessKey.go index 03776db6779..a79336721b5 100644 --- a/service/iam/api_op_CreateAccessKey.go +++ b/service/iam/api_op_CreateAccessKey.go @@ -11,20 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Amazon Web Services secret access key and corresponding Amazon +// 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. +// 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 -// associated user and then create new keys. +// no associated users. +// +// For information about quotas on the number of keys you can create, see [IAM and STS quotas] 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. +// +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html func (c *Client) CreateAccessKey(ctx context.Context, params *CreateAccessKeyInput, optFns ...func(*Options)) (*CreateAccessKeyOutput, error) { if params == nil { params = &CreateAccessKeyInput{} @@ -42,10 +50,13 @@ 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 - // 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 that the new key will belong to. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateAccountAlias.go b/service/iam/api_op_CreateAccountAlias.go index 9306a0cd8e1..cd658c4d4b7 100644 --- a/service/iam/api_op_CreateAccountAlias.go +++ b/service/iam/api_op_CreateAccountAlias.go @@ -11,9 +11,10 @@ import ( ) // Creates an alias for your Amazon Web Services account. For information about -// using an Amazon Web Services account alias, see Creating, deleting, and listing -// an Amazon Web Services account alias (https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html) -// in the Amazon Web Services Sign-In User Guide. +// using an Amazon Web Services account alias, see [Creating, deleting, and listing an Amazon Web Services account alias]in the Amazon Web Services +// Sign-In User Guide. +// +// [Creating, deleting, and listing an Amazon Web Services account alias]: https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html func (c *Client) CreateAccountAlias(ctx context.Context, params *CreateAccountAliasInput, optFns ...func(*Options)) (*CreateAccountAliasOutput, error) { if params == nil { params = &CreateAccountAliasInput{} @@ -31,9 +32,13 @@ 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountAlias *string diff --git a/service/iam/api_op_CreateGroup.go b/service/iam/api_op_CreateGroup.go index 91c330e05b4..8ee8002fbaf 100644 --- a/service/iam/api_op_CreateGroup.go +++ b/service/iam/api_op_CreateGroup.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Creates a new group. +// +// For information about the number of groups you can create, see [IAM and STS quotas] in the IAM User +// Guide. +// +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -31,21 +34,28 @@ func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optF type CreateGroupInput struct { - // The name of the group to create. Do not include the path in this value. 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 name of the group to create. Do not include the path in this value. + // + // 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. 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] 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]) 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. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + // [regex pattern]: http://wikipedia.org/wiki/regex Path *string noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateInstanceProfile.go b/service/iam/api_op_CreateInstanceProfile.go index dde7912f4a5..90990faa41a 100644 --- a/service/iam/api_op_CreateInstanceProfile.go +++ b/service/iam/api_op_CreateInstanceProfile.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// Creates a new instance profile. For information about instance profiles, see [Using roles for applications on Amazon EC2] +// +// in the IAM User Guide, and [Instance profiles]in the Amazon EC2 User Guide. +// +// For information about the number of instance profiles you can create, see [IAM object quotas] in +// the IAM User Guide. +// +// [Instance profiles]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile +// [IAM object quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html +// +// [Using roles for applications on Amazon EC2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html func (c *Client) CreateInstanceProfile(ctx context.Context, params *CreateInstanceProfileInput, optFns ...func(*Options)) (*CreateInstanceProfileOutput, error) { if params == nil { params = &CreateInstanceProfileInput{} @@ -34,30 +39,40 @@ 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // The name of the instance profile to create. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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. + // The path to the instance profile. For more information about paths, see [IAM Identifiers] 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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]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 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateLoginProfile.go b/service/iam/api_op_CreateLoginProfile.go index 0e00a84da2c..8ed950f1da1 100644 --- a/service/iam/api_op_CreateLoginProfile.go +++ b/service/iam/api_op_CreateLoginProfile.go @@ -13,12 +13,16 @@ import ( // Creates a password for the specified IAM user. A password allows an IAM user to // access Amazon Web Services services through the Amazon Web Services Management -// Console. You can use the CLI, the Amazon Web Services API, or the Users page in -// 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. +// Console. +// +// You can use the CLI, the Amazon Web Services API, or the Users page in the IAM +// console to create a password for any IAM user. Use ChangePasswordto 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] in the IAM User Guide. +// +// [Managing passwords]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html func (c *Client) CreateLoginProfile(ctx context.Context, params *CreateLoginProfileInput, optFns ...func(*Options)) (*CreateLoginProfileOutput, error) { if params == nil { params = &CreateLoginProfileInput{} @@ -36,24 +40,29 @@ 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 new password for the user. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_CreateOpenIDConnectProvider.go b/service/iam/api_op_CreateOpenIDConnectProvider.go index d90f27fced8..032baccf128 100644 --- a/service/iam/api_op_CreateOpenIDConnectProvider.go +++ b/service/iam/api_op_CreateOpenIDConnectProvider.go @@ -11,35 +11,46 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an IAM entity to describe an identity provider (IdP) that supports -// 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, -// Facebook, or Amazon Cognito, you don't need to create a separate IAM identity -// 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) -// in the IAM User Guide. When you create the IAM OIDC provider, you specify the -// following: +// Creates an IAM entity to describe an identity provider (IdP) that supports [OpenID Connect (OIDC)]. +// +// 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, Facebook, or Amazon +// Cognito, you don't need to create a separate IAM identity 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]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 // // 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 root certificate -// authorities (CAs) instead of using a certificate thumbprint to verify your IdP -// server certificate. In these cases, your legacy thumbprint remains in your -// configuration, but is no longer used for validation. These OIDC IdPs include -// Auth0, GitHub, GitLab, Google, and those that use an Amazon S3 bucket to host a -// JSON Web Key Set (JWKS) endpoint. 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. +// Amazon Web Services. +// +// Amazon Web Services secures communication with some OIDC identity providers +// (IdPs) through our library of trusted root certificate authorities (CAs) instead +// of using a certificate thumbprint to verify your IdP server certificate. In +// these cases, your legacy thumbprint remains in your configuration, but is no +// longer used for validation. These OIDC IdPs include Auth0, GitHub, GitLab, +// Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) +// endpoint. +// +// 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 CreateOpenIDConnectProvideroperation to +// highly privileged users. +// +// [OpenID Connect (OIDC)]: http://openid.net/connect/ +// [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 func (c *Client) CreateOpenIDConnectProvider(ctx context.Context, params *CreateOpenIDConnectProviderInput, optFns ...func(*Options)) (*CreateOpenIDConnectProviderOutput, error) { if params == nil { params = &CreateOpenIDConnectProviderInput{} @@ -61,10 +72,12 @@ 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 - // 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. + // 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. // // This member is required. Url *string @@ -72,38 +85,50 @@ type CreateOpenIDConnectProviderInput struct { // 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 - // OIDC provider. You cannot register more than 100 client IDs with a single IAM - // OIDC provider. There is no defined format for a client ID. The + // 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 OIDC provider. You cannot + // register more than 100 client IDs with a single IAM OIDC provider. + // + // There is no defined format for a client ID. The // CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 // characters long. ClientIDList []string // 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]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 Tags []types.Tag // A list of server certificate thumbprints for the OpenID Connect (OIDC) identity // provider's server certificates. Typically this list includes only one entry. // However, IAM lets you have up to five thumbprints for an OIDC provider. This // lets you maintain multiple thumbprints if the identity provider is rotating - // certificates. This parameter is optional. If it is not included, IAM will - // retrieve and use the top intermediate certificate authority (CA) thumbprint of - // the OpenID Connect identity provider server certificate. The server certificate - // thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by - // the domain where the OpenID Connect provider makes its keys available. It is - // always a 40-character string. For example, assume that the OIDC provider is - // server.example.com and the provider stores its 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) - // in the IAM user Guide. + // certificates. + // + // This parameter is optional. If it is not included, IAM will retrieve and use + // the top intermediate certificate authority (CA) thumbprint of the OpenID Connect + // identity provider server certificate. + // + // The server certificate thumbprint is the hex-encoded SHA-1 hash value of the + // X.509 certificate used by the domain where the OpenID Connect provider makes its + // keys available. It is always a 40-character string. + // + // For example, assume that the OIDC provider is server.example.com and the + // provider stores its 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] in the + // IAM user Guide. + // + // [Obtaining the thumbprint for an OpenID Connect provider]: https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html ThumbprintList []string noSmithyDocumentSerde @@ -113,13 +138,14 @@ 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. + // list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources]in + // the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html 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 6aa86d58331..aba80f39417 100644 --- a/service/iam/api_op_CreatePolicy.go +++ b/service/iam/api_op_CreatePolicy.go @@ -11,15 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// 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) -// in the IAM User Guide. +// 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]in the IAM User Guide. +// +// As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies] in +// the IAM User Guide. +// +// For more information about managed policies in general, see [Managed policies and inline policies] in the IAM User +// Guide. +// +// [Validating IAM policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html +// [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { if params == nil { params = &CreatePolicyInput{} @@ -37,58 +43,82 @@ 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) - // 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: + // 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]. + // + // To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language] in the IAM User Guide. + // + // The [regex pattern] 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 ) // + // [Grammar of the IAM JSON policy language]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length + // // 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 - // A friendly description of the policy. Typically used to store information about - // the permissions defined in the policy. For example, "Grants access to production - // DynamoDB tables." The policy description is immutable. After a value is - // assigned, it cannot be changed. + // A friendly description of the policy. + // + // Typically used to store information about the permissions defined in the + // policy. For example, "Grants access to production DynamoDB tables." + // + // The policy description is immutable. After a value is 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. + // The path for the policy. + // + // For more information about paths, see [IAM identifiers] 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]) 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. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + // [regex pattern]: http://wikipedia.org/wiki/regex 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]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 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreatePolicyVersion.go b/service/iam/api_op_CreatePolicyVersion.go index ac9ad2eb92d..720fd1ce456 100644 --- a/service/iam/api_op_CreatePolicyVersion.go +++ b/service/iam/api_op_CreatePolicyVersion.go @@ -14,12 +14,15 @@ import ( // Creates a new version of the specified managed policy. To update a managed // policy, you create a new policy version. A managed policy can have up to five // versions. If the policy has five versions, you must delete an existing version -// using DeletePolicyVersion before you create a new version. Optionally, you can -// 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) -// in the IAM User Guide. +// using DeletePolicyVersionbefore you create a new version. +// +// Optionally, you can 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] in the IAM User Guide. +// +// [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, optFns ...func(*Options)) (*CreatePolicyVersionOutput, error) { if params == nil { params = &CreatePolicyVersionInput{} @@ -38,38 +41,55 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string // The JSON policy document that you want to use as the content for this new - // version of the 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) - // . The regex pattern (http://wikipedia.org/wiki/regex) used to validate this - // parameter is a string of characters consisting of the following: + // version of the 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]. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length + // // 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 - // 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) - // in the IAM User Guide. + // 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] in the IAM User Guide. + // + // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html SetAsDefault bool noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateRole.go b/service/iam/api_op_CreateRole.go index 3cf0102ca10..c85f3b15df9 100644 --- a/service/iam/api_op_CreateRole.go +++ b/service/iam/api_op_CreateRole.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/id_roles.html) -// in the IAM User Guide. 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. +// Creates a new role for your Amazon Web Services account. +// +// For more information about roles, see [IAM roles] in the IAM User Guide. For information +// about quotas for role names and the number of roles you can create, see [IAM and STS quotas]in the +// IAM User Guide. +// +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html func (c *Client) CreateRole(ctx context.Context, params *CreateRoleInput, optFns ...func(*Options)) (*CreateRoleOutput, error) { if params == nil { params = &CreateRoleInput{} @@ -34,29 +37,43 @@ func (c *Client) CreateRole(ctx context.Context, params *CreateRoleInput, optFns type CreateRoleInput struct { // The trust relationship policy document that grants an entity permission to - // 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: + // 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] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. AssumeRolePolicyDocument *string - // 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 - // spaces. You can also include any of the following characters: _+=,.@- + // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -67,44 +84,59 @@ type CreateRoleInput struct { // 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. + // 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]in the IAM User + // Guide. + // + // [Using IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html 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] 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html Path *string // The ARN of the managed policy that is used to set the permissions boundary for - // the role. A permissions boundary policy defines the maximum permissions that + // the role. + // + // A permissions boundary policy defines the maximum permissions that // 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) - // in the IAM User Guide. + // resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities]in the IAM + // User Guide. + // + // For more information about policy types, see [Policy types] in the IAM User Guide. + // + // [Policy types]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types + // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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. + // key name and an associated value. For more information about tagging, see [Tagging IAM resources]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 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateSAMLProvider.go b/service/iam/api_op_CreateSAMLProvider.go index e2d1720cad6..4f53c30d39f 100644 --- a/service/iam/api_op_CreateSAMLProvider.go +++ b/service/iam/api_op_CreateSAMLProvider.go @@ -12,21 +12,28 @@ import ( ) // Creates an IAM resource that describes an identity provider (IdP) that supports -// SAML 2.0. The SAML provider resource that you create with this operation can be -// used as a principal in an IAM role's trust policy. Such a policy can enable -// federated users who sign in using the SAML IdP to assume the role. You can -// create an IAM role that supports Web-based single sign-on (SSO) to the Amazon -// Web Services Management Console or one that supports API access to Amazon Web -// Services. When you create the SAML provider resource, you upload a SAML metadata -// document that you get from your IdP. That document includes the issuer's name, -// 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) -// in the IAM User Guide. +// SAML 2.0. +// +// The SAML provider resource that you create with this operation can be used as a +// principal in an IAM role's trust policy. Such a policy can enable federated +// users who sign in using the SAML IdP to assume the role. You can create an IAM +// role that supports Web-based single sign-on (SSO) to the Amazon Web Services +// Management Console or one that supports API access to Amazon Web Services. +// +// When you create the SAML provider resource, you upload a SAML metadata document +// that you get from your IdP. That document includes the issuer's name, 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]. +// +// For more information, see [Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console] and [About SAML 2.0-based federation] in the IAM User Guide. +// +// [Signature Version 4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html +// [About SAML 2.0-based federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html +// [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 func (c *Client) CreateSAMLProvider(ctx context.Context, params *CreateSAMLProviderInput, optFns ...func(*Options)) (*CreateSAMLProviderOutput, error) { if params == nil { params = &CreateSAMLProviderInput{} @@ -44,10 +51,13 @@ 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the provider to create. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. Name *string @@ -56,19 +66,23 @@ type CreateSAMLProviderInput struct { // The document includes the issuer's name, expiration information, and keys that // 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) - // in the IAM User Guide + // identity management software that is used as your organization's IdP. + // + // For more information, see [About SAML 2.0-based federation] in the IAM User Guide + // + // [About SAML 2.0-based federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html // // This member is required. SAMLMetadataDocument *string // 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]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 Tags []types.Tag noSmithyDocumentSerde @@ -81,9 +95,10 @@ type CreateSAMLProviderOutput struct { 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. + // list of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources]in + // the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html 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 99cca536316..991bf6aa843 100644 --- a/service/iam/api_op_CreateServiceLinkedRole.go +++ b/service/iam/api_op_CreateServiceLinkedRole.go @@ -17,10 +17,12 @@ 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) -// 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. +// information, see [Using service-linked roles]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. +// +// [Using service-linked roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html func (c *Client) CreateServiceLinkedRole(ctx context.Context, params *CreateServiceLinkedRoleInput, optFns ...func(*Options)) (*CreateServiceLinkedRoleOutput, error) { if params == nil { params = &CreateServiceLinkedRoleInput{} @@ -40,12 +42,14 @@ 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 - // 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) - // 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. + // 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]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. + // + // [Amazon Web Services services that work with IAM]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html // // This member is required. AWSServiceName *string @@ -54,9 +58,11 @@ type CreateServiceLinkedRoleInput struct { // 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. + // 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 0b36b81f158..e3a8ebd149c 100644 --- a/service/iam/api_op_CreateServiceSpecificCredential.go +++ b/service/iam/api_op_CreateServiceSpecificCredential.go @@ -13,14 +13,20 @@ import ( // Generates a set of credentials consisting of a user name and password that can // be used to access the service specified in the request. These credentials are -// generated by IAM, and can be used only for the specified service. You can have a -// 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 -// 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) -// in the IAM User Guide. +// generated by IAM, and can be used only for the specified service. +// +// You can have a 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 information about service-specific credentials, see [Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys] in the IAM User +// Guide. +// +// [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 func (c *Client) CreateServiceSpecificCredential(ctx context.Context, params *CreateServiceSpecificCredentialInput, optFns ...func(*Options)) (*CreateServiceSpecificCredentialOutput, error) { if params == nil { params = &CreateServiceSpecificCredentialInput{} @@ -47,10 +53,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // except that they can be used only to access the specified service. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string @@ -61,9 +70,10 @@ type CreateServiceSpecificCredentialInput struct { 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 . + // 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. 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 6b8c403339f..220ad7f8689 100644 --- a/service/iam/api_op_CreateUser.go +++ b/service/iam/api_op_CreateUser.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// 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] // in the IAM User Guide. +// +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} @@ -31,40 +34,53 @@ func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns type CreateUserInput struct { - // The name of the user 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". + // The name of the user 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 member is required. 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. + // The path for the user name. For more information about paths, see [IAM identifiers] 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]) 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. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + // [regex pattern]: http://wikipedia.org/wiki/regex Path *string // The ARN of the managed policy that is used to set the permissions boundary for - // the user. A permissions boundary policy defines the maximum permissions that + // the user. + // + // A permissions boundary policy defines the maximum permissions that // 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) - // in the IAM User Guide. + // resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities]in the IAM + // User Guide. + // + // For more information about policy types, see [Policy types] in the IAM User Guide. + // + // [Policy types]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types + // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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. + // key name and an associated value. For more information about tagging, see [Tagging IAM resources]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 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_CreateVirtualMFADevice.go b/service/iam/api_op_CreateVirtualMFADevice.go index 6d8e0d6867b..e0a0400b71a 100644 --- a/service/iam/api_op_CreateVirtualMFADevice.go +++ b/service/iam/api_op_CreateVirtualMFADevice.go @@ -12,16 +12,21 @@ 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 EnableMFADeviceto 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]in the IAM +// User Guide. +// +// For information about the maximum number of MFA devices you can create, see [IAM and STS quotas] 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. +// +// [Using a virtual MFA device]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html func (c *Client) CreateVirtualMFADevice(ctx context.Context, params *CreateVirtualMFADeviceInput, optFns ...func(*Options)) (*CreateVirtualMFADeviceOutput, error) { if params == nil { params = &CreateVirtualMFADeviceInput{} @@ -40,30 +45,40 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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. + // The path for the virtual MFA device. For more information about paths, see [IAM identifiers] 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]) 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. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + // [regex pattern]: http://wikipedia.org/wiki/regex 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]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 Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iam/api_op_DeactivateMFADevice.go b/service/iam/api_op_DeactivateMFADevice.go index be155c45d0e..46ca8172949 100644 --- a/service/iam/api_op_DeactivateMFADevice.go +++ b/service/iam/api_op_DeactivateMFADevice.go @@ -11,10 +11,12 @@ 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) +// 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] // in the IAM User Guide. +// +// [Enabling a virtual multi-factor authentication (MFA) device]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html func (c *Client) DeactivateMFADevice(ctx context.Context, params *DeactivateMFADeviceInput, optFns ...func(*Options)) (*DeactivateMFADeviceOutput, error) { if params == nil { params = &DeactivateMFADeviceInput{} @@ -33,18 +35,24 @@ func (c *Client) DeactivateMFADevice(ctx context.Context, params *DeactivateMFAD 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: =,.@:/- + // devices, the serial number is the device ARN. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: =,.@:/- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the user whose MFA device you want to deactivate. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteAccessKey.go b/service/iam/api_op_DeleteAccessKey.go index 600a6776052..00c6d59e168 100644 --- a/service/iam/api_op_DeleteAccessKey.go +++ b/service/iam/api_op_DeleteAccessKey.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the access key pair associated with the specified IAM user. 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 even -// if the Amazon Web Services account has no associated users. +// Deletes the access key pair associated with the specified IAM user. +// +// 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 even if the Amazon Web Services account has no associated +// users. func (c *Client) DeleteAccessKey(ctx context.Context, params *DeleteAccessKeyInput, optFns ...func(*Options)) (*DeleteAccessKeyOutput, error) { if params == nil { params = &DeleteAccessKeyInput{} @@ -34,17 +36,23 @@ 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]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the user whose access key pair you want to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_DeleteAccountAlias.go b/service/iam/api_op_DeleteAccountAlias.go index 0424523ca9d..ccd41fe69ac 100644 --- a/service/iam/api_op_DeleteAccountAlias.go +++ b/service/iam/api_op_DeleteAccountAlias.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Amazon Web Services account alias. For information about -// using an Amazon Web Services account alias, see Creating, deleting, and listing -// an Amazon Web Services account alias (https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html) -// in the Amazon Web Services Sign-In User Guide. +// Deletes the specified Amazon Web Services account alias. For information about +// +// using an Amazon Web Services account alias, see [Creating, deleting, and listing an Amazon Web Services account alias]in the Amazon Web Services +// Sign-In User Guide. +// +// [Creating, deleting, and listing an Amazon Web Services account alias]: https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html func (c *Client) DeleteAccountAlias(ctx context.Context, params *DeleteAccountAliasInput, optFns ...func(*Options)) (*DeleteAccountAliasOutput, error) { if params == nil { params = &DeleteAccountAliasInput{} @@ -31,10 +33,13 @@ 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 - // 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 name of the account alias to delete. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountAlias *string diff --git a/service/iam/api_op_DeleteGroup.go b/service/iam/api_op_DeleteGroup.go index c23bd792bde..28b9e25ae82 100644 --- a/service/iam/api_op_DeleteGroup.go +++ b/service/iam/api_op_DeleteGroup.go @@ -29,10 +29,13 @@ 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the IAM group to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string diff --git a/service/iam/api_op_DeleteGroupPolicy.go b/service/iam/api_op_DeleteGroupPolicy.go index cc3afbcc549..bafb54bd4a1 100644 --- a/service/iam/api_op_DeleteGroupPolicy.go +++ b/service/iam/api_op_DeleteGroupPolicy.go @@ -10,11 +10,13 @@ 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) -// in the IAM User Guide. +// 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] in +// the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DeleteGroupPolicy(ctx context.Context, params *DeleteGroupPolicyInput, optFns ...func(*Options)) (*DeleteGroupPolicyOutput, error) { if params == nil { params = &DeleteGroupPolicyInput{} @@ -33,18 +35,24 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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 - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // The name identifying the policy document to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string diff --git a/service/iam/api_op_DeleteInstanceProfile.go b/service/iam/api_op_DeleteInstanceProfile.go index 732a2a0a58c..dd4f63956aa 100644 --- a/service/iam/api_op_DeleteInstanceProfile.go +++ b/service/iam/api_op_DeleteInstanceProfile.go @@ -11,12 +11,16 @@ import ( ) // Deletes the specified instance profile. The instance profile must not have an -// 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 -// Using instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) -// in the IAM User Guide. +// 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 [Using instance profiles] in the IAM User Guide. +// +// [Using instance profiles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstanceProfileInput, optFns ...func(*Options)) (*DeleteInstanceProfileOutput, error) { if params == nil { params = &DeleteInstanceProfileInput{} @@ -34,10 +38,13 @@ 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // The name of the instance profile to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string diff --git a/service/iam/api_op_DeleteLoginProfile.go b/service/iam/api_op_DeleteLoginProfile.go index fac350f819a..5dcaff07c20 100644 --- a/service/iam/api_op_DeleteLoginProfile.go +++ b/service/iam/api_op_DeleteLoginProfile.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 . +// Deletes the password for the specified IAM user, For more information, see [Managing passwords for IAM users]. +// +// 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 ChangePasswordto 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 UpdateAccessKeyand DeleteAccessKey. +// +// [Managing passwords for IAM users]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html func (c *Client) DeleteLoginProfile(ctx context.Context, params *DeleteLoginProfileInput, optFns ...func(*Options)) (*DeleteLoginProfileOutput, error) { if params == nil { params = &DeleteLoginProfileInput{} @@ -37,10 +40,13 @@ 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 - // 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 whose password you want to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteOpenIDConnectProvider.go b/service/iam/api_op_DeleteOpenIDConnectProvider.go index 37df78331da..6220e26938a 100644 --- a/service/iam/api_op_DeleteOpenIDConnectProvider.go +++ b/service/iam/api_op_DeleteOpenIDConnectProvider.go @@ -11,11 +11,13 @@ import ( ) // Deletes an OpenID Connect identity provider (IdP) resource object in IAM. +// // Deleting an IAM OIDC provider resource does not update any roles that reference // the provider as a principal in their trust policies. Any attempt to assume a -// role that references a deleted provider fails. This operation is idempotent; it -// does not fail or return an error if you call the operation for a provider that -// does not exist. +// role that references a deleted provider fails. +// +// This operation is idempotent; it does not fail or return an error if you call +// the operation for a provider that does not exist. func (c *Client) DeleteOpenIDConnectProvider(ctx context.Context, params *DeleteOpenIDConnectProviderInput, optFns ...func(*Options)) (*DeleteOpenIDConnectProviderOutput, error) { if params == nil { params = &DeleteOpenIDConnectProviderInput{} @@ -35,7 +37,7 @@ type DeleteOpenIDConnectProviderInput struct { // The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource // object to delete. You can get a list of OpenID Connect provider resource ARNs by - // using the ListOpenIDConnectProviders operation. + // using the ListOpenIDConnectProvidersoperation. // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_DeletePolicy.go b/service/iam/api_op_DeletePolicy.go index 3f6e7439791..d040de7a711 100644 --- a/service/iam/api_op_DeletePolicy.go +++ b/service/iam/api_op_DeletePolicy.go @@ -10,23 +10,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified managed policy. Before you can delete a managed policy, -// 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: +// Deletes the specified managed policy. +// +// Before you can delete a managed policy, 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. +// 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 DeletePolicyVersionto 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) -// in the IAM User Guide. +// For information about managed policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} @@ -44,9 +49,12 @@ 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to delete. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_DeletePolicyVersion.go b/service/iam/api_op_DeletePolicyVersion.go index b470dc39beb..08adc89d49a 100644 --- a/service/iam/api_op_DeletePolicyVersion.go +++ b/service/iam/api_op_DeletePolicyVersion.go @@ -10,13 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, optFns ...func(*Options)) (*DeletePolicyVersionOutput, error) { if params == nil { params = &DeletePolicyVersionInput{} @@ -35,18 +37,26 @@ 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. + // a version. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // in the IAM User Guide. + // The policy version to delete. + // + // This parameter allows (through its [regex pattern]) 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] in the IAM User Guide. + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html // // This member is required. VersionId *string diff --git a/service/iam/api_op_DeleteRole.go b/service/iam/api_op_DeleteRole.go index 67989ef86db..fc20453f331 100644 --- a/service/iam/api_op_DeleteRole.go +++ b/service/iam/api_op_DeleteRole.go @@ -12,18 +12,23 @@ 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: -// - Inline policies ( DeleteRolePolicy ) -// - Attached managed policies ( DetachRolePolicy ) -// - Instance profile ( RemoveRoleFromInstanceProfile ) +// the role manually, or the deletion fails. For more information, see [Deleting an IAM role]. 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 ) +// 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. +// +// [Deleting an IAM role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli func (c *Client) DeleteRole(ctx context.Context, params *DeleteRoleInput, optFns ...func(*Options)) (*DeleteRoleOutput, error) { if params == nil { params = &DeleteRoleInput{} @@ -41,10 +46,13 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_DeleteRolePermissionsBoundary.go b/service/iam/api_op_DeleteRolePermissionsBoundary.go index 425bcfd3356..4701f89f929 100644 --- a/service/iam/api_op_DeleteRolePermissionsBoundary.go +++ b/service/iam/api_op_DeleteRolePermissionsBoundary.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the permissions boundary for the specified IAM role. You cannot set the -// boundary for a service-linked role. Deleting the permissions boundary for a role -// might increase its permissions. For example, it might allow anyone who assumes -// the role to perform all the actions granted in its permissions policies. +// Deletes the permissions boundary for the specified IAM role. +// +// You cannot set the boundary for a service-linked role. +// +// Deleting the permissions boundary for a role might increase its permissions. +// For example, it might allow anyone who assumes the role to perform all the +// actions granted in its permissions policies. func (c *Client) DeleteRolePermissionsBoundary(ctx context.Context, params *DeleteRolePermissionsBoundaryInput, optFns ...func(*Options)) (*DeleteRolePermissionsBoundaryOutput, error) { if params == nil { params = &DeleteRolePermissionsBoundaryInput{} diff --git a/service/iam/api_op_DeleteRolePolicy.go b/service/iam/api_op_DeleteRolePolicy.go index 41cc1bc772b..837937e9fe3 100644 --- a/service/iam/api_op_DeleteRolePolicy.go +++ b/service/iam/api_op_DeleteRolePolicy.go @@ -11,10 +11,12 @@ 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) -// in the IAM User Guide. +// +// 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] in the +// IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DeleteRolePolicy(ctx context.Context, params *DeleteRolePolicyInput, optFns ...func(*Options)) (*DeleteRolePolicyOutput, error) { if params == nil { params = &DeleteRolePolicyInput{} @@ -32,19 +34,25 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the inline policy to delete from the specified IAM role. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_DeleteSAMLProvider.go b/service/iam/api_op_DeleteSAMLProvider.go index 59cf5189eb6..23bd562bed1 100644 --- a/service/iam/api_op_DeleteSAMLProvider.go +++ b/service/iam/api_op_DeleteSAMLProvider.go @@ -10,12 +10,16 @@ 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]. +// +// [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 6b90de1fa37..78f4fbff1db 100644 --- a/service/iam/api_op_DeleteSSHPublicKey.go +++ b/service/iam/api_op_DeleteSSHPublicKey.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the CodeCommit User Guide. +// 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]in the +// CodeCommit User Guide. +// +// [Set up CodeCommit for SSH connections]: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html func (c *Client) DeleteSSHPublicKey(ctx context.Context, params *DeleteSSHPublicKeyInput, optFns ...func(*Options)) (*DeleteSSHPublicKeyOutput, error) { if params == nil { params = &DeleteSSHPublicKeyInput{} @@ -32,17 +35,23 @@ 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]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user associated with the SSH public key. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteServerCertificate.go b/service/iam/api_op_DeleteServerCertificate.go index f91110f6a2a..c18543bb44b 100644 --- a/service/iam/api_op_DeleteServerCertificate.go +++ b/service/iam/api_op_DeleteServerCertificate.go @@ -10,18 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 +// Deletes the specified server certificate. +// +// For more information about working with server certificates, see [Working with server certificates] 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 // certificate could have implications for your application. If Elastic Load // Balancing doesn't detect the deletion of bound certificates, it may continue to // 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) -// in the Elastic Load Balancing API Reference. +// more information, see [DeleteLoadBalancerListeners]in the Elastic Load Balancing API Reference. +// +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html +// [DeleteLoadBalancerListeners]: https://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html func (c *Client) DeleteServerCertificate(ctx context.Context, params *DeleteServerCertificateInput, optFns ...func(*Options)) (*DeleteServerCertificateOutput, error) { if params == nil { params = &DeleteServerCertificateInput{} @@ -39,10 +43,13 @@ 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 - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the server certificate you want to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string diff --git a/service/iam/api_op_DeleteServiceLinkedRole.go b/service/iam/api_op_DeleteServiceLinkedRole.go index d4b7c69d7a4..97b2c4a4f12 100644 --- a/service/iam/api_op_DeleteServiceLinkedRole.go +++ b/service/iam/api_op_DeleteServiceLinkedRole.go @@ -15,18 +15,21 @@ import ( // 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 -// 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) -// in the IAM User Guide. +// 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]for your +// service. +// +// For more information about service-linked roles, see [Roles terms and concepts: Amazon Web Services service-linked role] in the IAM User Guide. +// +// [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 +// [Amazon Web Services documentation]: http://docs.aws.amazon.com/ func (c *Client) DeleteServiceLinkedRole(ctx context.Context, params *DeleteServiceLinkedRoleInput, optFns ...func(*Options)) (*DeleteServiceLinkedRoleOutput, error) { if params == nil { params = &DeleteServiceLinkedRoleInput{} diff --git a/service/iam/api_op_DeleteServiceSpecificCredential.go b/service/iam/api_op_DeleteServiceSpecificCredential.go index 99aeb8e9926..0d3472a59d6 100644 --- a/service/iam/api_op_DeleteServiceSpecificCredential.go +++ b/service/iam/api_op_DeleteServiceSpecificCredential.go @@ -29,19 +29,25 @@ 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. + // value by calling ListServiceSpecificCredentials. + // + // This parameter allows (through its [regex pattern]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServiceSpecificCredentialId *string // 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // credentials are used to call the operation. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_DeleteSigningCertificate.go b/service/iam/api_op_DeleteSigningCertificate.go index 866433d1f01..b0821969c08 100644 --- a/service/iam/api_op_DeleteSigningCertificate.go +++ b/service/iam/api_op_DeleteSigningCertificate.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a signing certificate associated with the specified IAM user. 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 even -// if the Amazon Web Services account has no associated IAM users. +// Deletes a signing certificate associated with the specified IAM user. +// +// 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 even if the Amazon Web Services account has no associated +// IAM users. func (c *Client) DeleteSigningCertificate(ctx context.Context, params *DeleteSigningCertificateInput, optFns ...func(*Options)) (*DeleteSigningCertificateOutput, error) { if params == nil { params = &DeleteSigningCertificateInput{} @@ -33,17 +35,23 @@ 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. + // The ID of the signing certificate to delete. + // + // The format of this parameter, as described by its [regex] pattern, is a string of + // characters that can be upper- or lower-cased letters or digits. + // + // [regex]: http://wikipedia.org/wiki/regex // // 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 - // 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 the signing certificate belongs to. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_DeleteUser.go b/service/iam/api_op_DeleteUser.go index ec1a279b49c..aa5feedcb80 100644 --- a/service/iam/api_op_DeleteUser.go +++ b/service/iam/api_op_DeleteUser.go @@ -12,19 +12,28 @@ 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) +// attached to the user manually, or the deletion fails. For more information, see [Deleting an IAM user] // . 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 ) +// +// - 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 func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} @@ -42,10 +51,13 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteUserPermissionsBoundary.go b/service/iam/api_op_DeleteUserPermissionsBoundary.go index 6cfceb1186a..746c8ab2593 100644 --- a/service/iam/api_op_DeleteUserPermissionsBoundary.go +++ b/service/iam/api_op_DeleteUserPermissionsBoundary.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the permissions boundary for the specified IAM user. Deleting the -// permissions boundary for a user might increase its permissions by allowing the -// user to perform all the actions granted in its permissions policies. +// Deletes the permissions boundary for the specified IAM user. +// +// Deleting the permissions boundary for a user might increase its permissions by +// allowing the user to perform all the actions granted in its permissions +// policies. func (c *Client) DeleteUserPermissionsBoundary(ctx context.Context, params *DeleteUserPermissionsBoundaryInput, optFns ...func(*Options)) (*DeleteUserPermissionsBoundaryOutput, error) { if params == nil { params = &DeleteUserPermissionsBoundaryInput{} diff --git a/service/iam/api_op_DeleteUserPolicy.go b/service/iam/api_op_DeleteUserPolicy.go index 15213695b95..ccb32050d87 100644 --- a/service/iam/api_op_DeleteUserPolicy.go +++ b/service/iam/api_op_DeleteUserPolicy.go @@ -11,10 +11,12 @@ 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) -// in the IAM User Guide. +// +// 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] in the +// IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DeleteUserPolicy(ctx context.Context, params *DeleteUserPolicyInput, optFns ...func(*Options)) (*DeleteUserPolicyOutput, error) { if params == nil { params = &DeleteUserPolicyInput{} @@ -32,19 +34,25 @@ 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 - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // The name identifying the policy document to delete. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_DeleteVirtualMFADevice.go b/service/iam/api_op_DeleteVirtualMFADevice.go index 5804cb4413b..420436311cf 100644 --- a/service/iam/api_op_DeleteVirtualMFADevice.go +++ b/service/iam/api_op_DeleteVirtualMFADevice.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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. func (c *Client) DeleteVirtualMFADevice(ctx context.Context, params *DeleteVirtualMFADeviceInput, optFns ...func(*Options)) (*DeleteVirtualMFADeviceOutput, error) { if params == nil { params = &DeleteVirtualMFADeviceInput{} @@ -31,10 +32,13 @@ func (c *Client) DeleteVirtualMFADevice(ctx context.Context, params *DeleteVirtu 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 - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: =,.@:/- + // devices, the serial number is the same as the ARN. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: =,.@:/- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string diff --git a/service/iam/api_op_DetachGroupPolicy.go b/service/iam/api_op_DetachGroupPolicy.go index 01897379307..17155d6db3a 100644 --- a/service/iam/api_op_DetachGroupPolicy.go +++ b/service/iam/api_op_DetachGroupPolicy.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DetachGroupPolicy(ctx context.Context, params *DetachGroupPolicyInput, optFns ...func(*Options)) (*DetachGroupPolicyOutput, error) { if params == nil { params = &DetachGroupPolicyInput{} @@ -33,17 +34,22 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to detach. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_DetachRolePolicy.go b/service/iam/api_op_DetachRolePolicy.go index 3cf8d7fecb6..105c7bea0bd 100644 --- a/service/iam/api_op_DetachRolePolicy.go +++ b/service/iam/api_op_DetachRolePolicy.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DetachRolePolicy(ctx context.Context, params *DetachRolePolicyInput, optFns ...func(*Options)) (*DetachRolePolicyOutput, error) { if params == nil { params = &DetachRolePolicyInput{} @@ -32,18 +33,23 @@ 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to detach. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_DetachUserPolicy.go b/service/iam/api_op_DetachUserPolicy.go index d9a608a79a9..bbd40cc7542 100644 --- a/service/iam/api_op_DetachUserPolicy.go +++ b/service/iam/api_op_DetachUserPolicy.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) DetachUserPolicy(ctx context.Context, params *DetachUserPolicyInput, optFns ...func(*Options)) (*DetachUserPolicyOutput, error) { if params == nil { params = &DetachUserPolicyInput{} @@ -32,18 +33,23 @@ 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. + // The Amazon Resource Name (ARN) of the IAM policy you want to detach. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_EnableMFADevice.go b/service/iam/api_op_EnableMFADevice.go index d9911cbb82e..c50a2c4069e 100644 --- a/service/iam/api_op_EnableMFADevice.go +++ b/service/iam/api_op_EnableMFADevice.go @@ -30,43 +30,55 @@ 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 - // 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) - // . + // 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]. + // + // [resync the device]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_sync.html // // This member is required. AuthenticationCode1 *string - // A subsequent 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) - // . + // A subsequent 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]. + // + // [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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: =,.@:/- + // devices, the serial number is the device ARN. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: =,.@:/- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user for whom you want to enable the MFA device. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_GenerateCredentialReport.go b/service/iam/api_op_GenerateCredentialReport.go index 6ed0670cab3..94547d9dc58 100644 --- a/service/iam/api_op_GenerateCredentialReport.go +++ b/service/iam/api_op_GenerateCredentialReport.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Generates a credential report for the Amazon Web Services account. For more +// +// information about the credential report, see [Getting credential reports]in the IAM User Guide. +// +// [Getting credential reports]: https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html 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 7998fcadf5a..1f6d9597ad4 100644 --- a/service/iam/api_op_GenerateOrganizationsAccessReport.go +++ b/service/iam/api_op_GenerateOrganizationsAccessReport.go @@ -12,54 +12,63 @@ import ( // Generates a report for service last accessed data for Organizations. You can // generate a report for any entities (organization root, organizational unit, or -// account) or policies in your organization. To call this operation, you must be -// signed in using your Organizations management account credentials. You can use -// 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) -// 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 -// the entity. You can generate a service last accessed data report for a policy by -// specifying an entity's path and an optional Organizations policy ID. This data -// includes a list of services that are allowed by the specified SCP. For each -// service in both report types, the data includes the most recent account activity -// 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) -// 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 -// API through any of the SDKs, or any of the command line tools. An unexpected -// entry in the service last accessed data does not mean that an account has been -// 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 -// 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. +// account) or policies in your organization. +// +// To call this operation, you must be signed in using your Organizations +// management account credentials. You can use 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]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 the entity. +// +// You can generate a service last accessed data report for a policy by specifying +// an entity's path and an optional Organizations policy ID. This data includes a +// list of services that are allowed by the specified SCP. +// +// For each service in both report types, the data includes the most recent +// account activity 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]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 API through any of the +// SDKs, or any of the command line tools. An unexpected entry in the service last +// accessed data does not mean that an account has been 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]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 @@ -68,6 +77,7 @@ import ( // 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 @@ -75,6 +85,7 @@ import ( // 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 @@ -83,11 +94,13 @@ import ( // 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. @@ -99,10 +112,16 @@ import ( // 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) -// in the IAM User Guide. +// For more about the evaluation of policy types, see [Evaluating policies]in the IAM User Guide. +// +// For more information about service last accessed data, see [Reducing policy scope by viewing user activity] in the IAM User +// Guide. +// +// [Logging IAM events with CloudTrail]: https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html +// [Refining permissions using service last accessed data]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html +// [Reducing permissions using service last accessed data]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html +// [Evaluating policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics +// [Reducing policy scope by viewing user activity]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html func (c *Client) GenerateOrganizationsAccessReport(ctx context.Context, params *GenerateOrganizationsAccessReportInput, optFns ...func(*Options)) (*GenerateOrganizationsAccessReportOutput, error) { if params == nil { params = &GenerateOrganizationsAccessReportInput{} @@ -131,9 +150,10 @@ type GenerateOrganizationsAccessReportInput struct { 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. + // 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 @@ -141,8 +161,7 @@ type GenerateOrganizationsAccessReportInput struct { type GenerateOrganizationsAccessReportOutput struct { - // The job identifier that you can use in the GetOrganizationsAccessReport - // operation. + // The job identifier that you can use in the GetOrganizationsAccessReport operation. JobId *string // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_GenerateServiceLastAccessedDetails.go b/service/iam/api_op_GenerateServiceLastAccessedDetails.go index 1afe4cd2642..ae1fbd7103f 100644 --- a/service/iam/api_op_GenerateServiceLastAccessedDetails.go +++ b/service/iam/api_op_GenerateServiceLastAccessedDetails.go @@ -15,46 +15,62 @@ import ( // group, role, or policy) was last used in an attempt to access Amazon Web // 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) -// . For more information about services and actions for which action last accessed -// information is displayed, see IAM action last accessed information services and -// actions (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor-action-last-accessed.html) -// . The service last accessed data includes all attempts to access an Amazon Web +// supporting this feature within the last year. For more information, see [Regions where data is tracked]. For +// more information about services and actions for which action last accessed +// information is displayed, see [IAM action last accessed information services and actions]. +// +// 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 // entry in the service last accessed data does not mean that your account has been // 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. The GenerateServiceLastAccessedDetails operation returns -// 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. +// and whether they were successful or denied access. For more information, see [Logging IAM events with CloudTrail]in +// the IAM User Guide. +// +// The GenerateServiceLastAccessedDetails operation returns 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. // // 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) -// 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) -// in the IAM User Guide. +// parameter. +// +// For additional information about the permissions policies that allow an +// identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccessoperation. +// +// 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]in +// the IAM User Guide. +// +// For more information about service and action last accessed data, see [Reducing permissions using service last accessed data] in the +// IAM User Guide. +// +// [Logging IAM events with CloudTrail]: https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html +// [Reducing permissions using service last accessed data]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html +// [Regions where data is tracked]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period +// [Evaluating policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics +// [IAM action last accessed information services and actions]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor-action-last-accessed.html func (c *Client) GenerateServiceLastAccessedDetails(ctx context.Context, params *GenerateServiceLastAccessedDetailsInput, optFns ...func(*Options)) (*GenerateServiceLastAccessedDetailsOutput, error) { if params == nil { params = &GenerateServiceLastAccessedDetailsInput{} @@ -92,8 +108,7 @@ type GenerateServiceLastAccessedDetailsInput struct { type GenerateServiceLastAccessedDetailsOutput struct { - // The JobId that you can use in the GetServiceLastAccessedDetails or - // GetServiceLastAccessedDetailsWithEntities operations. The JobId returned by + // 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 . JobId *string diff --git a/service/iam/api_op_GetAccessKeyLastUsed.go b/service/iam/api_op_GetAccessKeyLastUsed.go index 50ac658cd23..e6cc14f2f11 100644 --- a/service/iam/api_op_GetAccessKeyLastUsed.go +++ b/service/iam/api_op_GetAccessKeyLastUsed.go @@ -32,9 +32,12 @@ 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 - // consist of any upper or lowercased letter or digit. + // The identifier of an access key. + // + // This parameter allows (through its [regex pattern]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccessKeyId *string @@ -42,9 +45,8 @@ type GetAccessKeyLastUsedInput struct { noSmithyDocumentSerde } -// Contains the response to a successful GetAccessKeyLastUsed request. It is also -// returned as a member of the AccessKeyMetaData structure returned by the -// ListAccessKeys action. +// Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member +// of the AccessKeyMetaDatastructure returned by the ListAccessKeys action. type GetAccessKeyLastUsedOutput struct { // Contains information about the last time the access key was used. diff --git a/service/iam/api_op_GetAccountAuthorizationDetails.go b/service/iam/api_op_GetAccountAuthorizationDetails.go index 565b0d9dfe1..cb117118956 100644 --- a/service/iam/api_op_GetAccountAuthorizationDetails.go +++ b/service/iam/api_op_GetAccountAuthorizationDetails.go @@ -14,14 +14,18 @@ import ( // Retrieves information about all IAM users, groups, roles, and policies in your // 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 +// (users, groups, roles, and policies) in your account. +// +// Policies returned by this operation are URL-encoded compliant with [RFC 3986]. 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. +// provide similar functionality. +// +// You can optionally filter the results using the Filter parameter. You can +// paginate the results using the MaxItems and Marker parameters. +// +// [RFC 3986]: https://tools.ietf.org/html/rfc3986 func (c *Client) GetAccountAuthorizationDetails(ctx context.Context, params *GetAccountAuthorizationDetailsInput, optFns ...func(*Options)) (*GetAccountAuthorizationDetailsOutput, error) { if params == nil { params = &GetAccountAuthorizationDetailsInput{} @@ -41,9 +45,11 @@ type GetAccountAuthorizationDetailsInput struct { // A list of entity types used to filter the results. Only the entities that match // the types you specify are included in the output. Use the value - // LocalManagedPolicy to include customer managed policies. The format for this - // parameter is a comma-separated (if more than one) list of strings. Each string - // value in the list must be one of the valid values listed below. + // LocalManagedPolicy to include customer managed policies. + // + // The format for this parameter is a comma-separated (if more than one) list of + // strings. Each string value in the list must be one of the valid values listed + // below. Filter []types.EntityType // Use this parameter only when paginating results and only after you receive a @@ -54,11 +60,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -186,11 +194,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_GetAccountPasswordPolicy.go b/service/iam/api_op_GetAccountPasswordPolicy.go index 88fca11ea8f..92f2cfa3fff 100644 --- a/service/iam/api_op_GetAccountPasswordPolicy.go +++ b/service/iam/api_op_GetAccountPasswordPolicy.go @@ -14,8 +14,9 @@ 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]. +// +// [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 0897618152b..4cc8861f520 100644 --- a/service/iam/api_op_GetAccountSummary.go +++ b/service/iam/api_op_GetAccountSummary.go @@ -11,8 +11,11 @@ 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] in the IAM User Guide. +// +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html 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 0f71d4c2764..76e2e2e137c 100644 --- a/service/iam/api_op_GetContextKeysForCustomPolicy.go +++ b/service/iam/api_op_GetContextKeysForCustomPolicy.go @@ -12,14 +12,15 @@ 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 -// 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. +// from policies associated with an IAM user, group, or role, use 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. func (c *Client) GetContextKeysForCustomPolicy(ctx context.Context, params *GetContextKeysForCustomPolicyInput, optFns ...func(*Options)) (*GetContextKeysForCustomPolicyOutput, error) { if params == nil { params = &GetContextKeysForCustomPolicyInput{} @@ -39,24 +40,29 @@ 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: + // valid JSON text of an IAM policy. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. PolicyInputList []string noSmithyDocumentSerde } -// Contains the response to a successful GetContextKeysForPrincipalPolicy or -// GetContextKeysForCustomPolicy request. +// Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request. type GetContextKeysForCustomPolicyOutput struct { // The list of context keys that are referenced in the input policies. diff --git a/service/iam/api_op_GetContextKeysForPrincipalPolicy.go b/service/iam/api_op_GetContextKeysForPrincipalPolicy.go index 2383ee56acd..b40c0caea56 100644 --- a/service/iam/api_op_GetContextKeysForPrincipalPolicy.go +++ b/service/iam/api_op_GetContextKeysForPrincipalPolicy.go @@ -13,17 +13,20 @@ import ( // Gets a list of all of the context keys referenced in all the IAM policies that // are attached to the specified IAM entity. The entity can be an IAM user, group, // or role. If you specify a user, then the request also includes all of the -// policies attached to groups that the user is a member of. You can optionally -// include a list of one or more additional policies, specified as strings. If you -// want to include only a list of policies by string, use -// GetContextKeysForCustomPolicy instead. Note: This operation discloses -// information about the permissions granted to other users. If you do not want -// users to see other user's permissions, then consider allowing them to use -// GetContextKeysForCustomPolicy instead. 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 -// in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key -// names and values you must supply when you call SimulatePrincipalPolicy . +// policies attached to groups that the user is a member of. +// +// You can optionally include a list of one or more additional policies, specified +// as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy +// instead. +// +// Note: This operation discloses information about the permissions granted to +// other users. If you do not want users to see other user's permissions, then +// consider allowing them to use GetContextKeysForCustomPolicyinstead. +// +// 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 in an IAM policy. Use GetContextKeysForPrincipalPolicyto understand +// what key 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{} @@ -47,30 +50,38 @@ type GetContextKeysForPrincipalPolicyInput struct { // groups that the user is a member of. If you pick a group or a role, then it // 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. + // 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicySourceArn *string // An optional list of additional policies for which you want the list of context - // 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: + // keys that are referenced. + // + // The [regex pattern] 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 ) + // + // [regex pattern]: http://wikipedia.org/wiki/regex PolicyInputList []string noSmithyDocumentSerde } -// Contains the response to a successful GetContextKeysForPrincipalPolicy or -// GetContextKeysForCustomPolicy request. +// Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request. type GetContextKeysForPrincipalPolicyOutput struct { // The list of context keys that are referenced in the input policies. diff --git a/service/iam/api_op_GetCredentialReport.go b/service/iam/api_op_GetCredentialReport.go index c27fffc081c..1dc3d1012e3 100644 --- a/service/iam/api_op_GetCredentialReport.go +++ b/service/iam/api_op_GetCredentialReport.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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. +// Retrieves a credential report for the Amazon Web Services account. For more +// +// information about the credential report, see [Getting credential reports]in the IAM User Guide. +// +// [Getting credential reports]: https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html func (c *Client) GetCredentialReport(ctx context.Context, params *GetCredentialReportInput, optFns ...func(*Options)) (*GetCredentialReportOutput, error) { if params == nil { params = &GetCredentialReportInput{} @@ -40,8 +42,9 @@ type GetCredentialReportOutput struct { // Contains the credential report. The report is Base64-encoded. Content []byte - // The date and time when the credential report was created, in ISO 8601 date-time - // format (http://www.iso.org/iso/iso8601) . + // The date and time when the credential report was created, in [ISO 8601 date-time format]. + // + // [ISO 8601 date-time 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 5edf08a30b2..68d9eb417fc 100644 --- a/service/iam/api_op_GetGroup.go +++ b/service/iam/api_op_GetGroup.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of IAM users that are in the specified IAM group. You can +// Returns a list of IAM users that are in the specified IAM group. You can +// // paginate the results using the MaxItems and Marker parameters. func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error) { if params == nil { @@ -30,10 +31,13 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string @@ -46,11 +50,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -177,11 +183,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_GetGroupPolicy.go b/service/iam/api_op_GetGroupPolicy.go index 9f9386196f4..0ff13842efd 100644 --- a/service/iam/api_op_GetGroupPolicy.go +++ b/service/iam/api_op_GetGroupPolicy.go @@ -11,17 +11,22 @@ import ( ) // 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. +// specified IAM group. +// +// Policies returned by this operation are URL-encoded compliant with [RFC 3986]. 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 GetPolicyto determine the +// policy's default version, then use GetPolicyVersionto retrieve the policy document. +// +// For more information about policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// [RFC 3986]: https://tools.ietf.org/html/rfc3986 +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) GetGroupPolicy(ctx context.Context, params *GetGroupPolicyInput, optFns ...func(*Options)) (*GetGroupPolicyOutput, error) { if params == nil { params = &GetGroupPolicyInput{} @@ -39,18 +44,24 @@ 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 - // 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 the policy is associated with. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string @@ -66,10 +77,11 @@ 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. - // CloudFormation always converts a YAML policy to JSON format before submitting it - // to IAM. + // 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. // // This member is required. PolicyDocument *string diff --git a/service/iam/api_op_GetInstanceProfile.go b/service/iam/api_op_GetInstanceProfile.go index d0da98ceb32..54914dc2200 100644 --- a/service/iam/api_op_GetInstanceProfile.go +++ b/service/iam/api_op_GetInstanceProfile.go @@ -15,10 +15,12 @@ import ( "time" ) -// Retrieves information about the specified instance profile, including the +// Retrieves information about the specified instance profile, including the +// // instance profile's path, GUID, ARN, and role. For more information about -// instance profiles, see Using instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) -// in the IAM User Guide. +// instance profiles, see [Using instance profiles]in the IAM User Guide. +// +// [Using instance profiles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html func (c *Client) GetInstanceProfile(ctx context.Context, params *GetInstanceProfileInput, optFns ...func(*Options)) (*GetInstanceProfileOutput, error) { if params == nil { params = &GetInstanceProfileInput{} @@ -36,10 +38,13 @@ 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the instance profile to get information about. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string @@ -182,12 +187,13 @@ type InstanceProfileExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetInstanceProfileInput, *GetInstanceProfileOutput, error) (bool, error) } diff --git a/service/iam/api_op_GetLoginProfile.go b/service/iam/api_op_GetLoginProfile.go index b9e498b3e1b..76c4adccb1f 100644 --- a/service/iam/api_op_GetLoginProfile.go +++ b/service/iam/api_op_GetLoginProfile.go @@ -14,13 +14,16 @@ 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 -// 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 -// Management Console, the CreateDate reflects the initial password creation date. -// A user with programmatic access does not have a login profile unless you create -// a password for the user to access the Amazon Web Services Management Console. +// 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 Management Console, the +// CreateDate reflects the initial password creation date. A user with programmatic +// access does not have a login profile unless you create a password for the user +// to access the Amazon Web Services Management Console. func (c *Client) GetLoginProfile(ctx context.Context, params *GetLoginProfileInput, optFns ...func(*Options)) (*GetLoginProfileOutput, error) { if params == nil { params = &GetLoginProfileInput{} @@ -38,10 +41,13 @@ 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the user whose login profile you want to retrieve. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_GetMFADevice.go b/service/iam/api_op_GetMFADevice.go index d32d80f004c..cf9df7bf47c 100644 --- a/service/iam/api_op_GetMFADevice.go +++ b/service/iam/api_op_GetMFADevice.go @@ -30,8 +30,9 @@ func (c *Client) GetMFADevice(ctx context.Context, params *GetMFADeviceInput, op type GetMFADeviceInput struct { // Serial number that uniquely identifies the MFA device. For this API, we only - // accept FIDO security key ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) - // . + // accept FIDO security key [ARNs]. + // + // [ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html // // This member is required. SerialNumber *string @@ -45,15 +46,17 @@ type GetMFADeviceInput struct { type GetMFADeviceOutput struct { // Serial number that uniquely identifies the MFA device. For this API, we only - // accept FIDO security key ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) - // . + // accept FIDO security key [ARNs]. + // + // [ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html // // This member is required. SerialNumber *string // The certifications of a specified user's MFA device. We currently provide - // FIPS-140-2, FIPS-140-3, and FIDO certification levels obtained from FIDO - // Alliance Metadata Service (MDS) (https://fidoalliance.org/metadata/) . + // FIPS-140-2, FIPS-140-3, and FIDO certification levels obtained from [FIDO Alliance Metadata Service (MDS)]. + // + // [FIDO Alliance Metadata Service (MDS)]: https://fidoalliance.org/metadata/ Certifications map[string]string // The date that a specified user's MFA device was first enabled. diff --git a/service/iam/api_op_GetOpenIDConnectProvider.go b/service/iam/api_op_GetOpenIDConnectProvider.go index 81ed6e1bdc3..fbb86dd6003 100644 --- a/service/iam/api_op_GetOpenIDConnectProvider.go +++ b/service/iam/api_op_GetOpenIDConnectProvider.go @@ -33,9 +33,12 @@ 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. + // the ListOpenIDConnectProvidersoperation. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. OpenIDConnectProviderArn *string @@ -47,8 +50,7 @@ type GetOpenIDConnectProviderInput struct { 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 . + // specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider. ClientIDList []string // The date and time when the IAM OIDC provider resource object was created in the @@ -57,17 +59,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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []types.Tag // A list of certificate thumbprints that are associated with the specified IAM - // OIDC provider resource object. For more information, see - // CreateOpenIDConnectProvider . + // OIDC provider resource object. For more information, see 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 007b348cf67..d96785070b3 100644 --- a/service/iam/api_op_GetOrganizationsAccessReport.go +++ b/service/iam/api_op_GetOrganizationsAccessReport.go @@ -13,20 +13,26 @@ 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 GenerateOrganizationsAccessReportoperation. 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 -// 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) -// 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 -// service is listed without details about the most recent attempt to access the -// service. If the operation fails, it returns the reason that it failed. By -// default, the list is sorted by service namespace. +// 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 organization root. You must have +// permissions to perform this operation. For more information, see [Refining permissions using service last accessed data]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 service is listed without +// details about the most recent attempt to access the service. If the operation +// fails, it returns the reason that it failed. +// +// By default, the list is sorted by service namespace. +// +// [Refining permissions using service last accessed data]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html func (c *Client) GetOrganizationsAccessReport(ctx context.Context, params *GetOrganizationsAccessReportInput, optFns ...func(*Options)) (*GetOrganizationsAccessReportOutput, error) { if params == nil { params = &GetOrganizationsAccessReportInput{} @@ -44,8 +50,7 @@ func (c *Client) GetOrganizationsAccessReport(ctx context.Context, params *GetOr type GetOrganizationsAccessReportInput struct { - // The identifier of the request generated by the GenerateOrganizationsAccessReport - // operation. + // The identifier of the request generated by the GenerateOrganizationsAccessReport operation. // // This member is required. JobId *string @@ -58,11 +63,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 // The key that is used to sort the results. If you choose the namespace key, the @@ -75,8 +82,9 @@ 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], when the report job was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCreationDate *time.Time @@ -90,10 +98,9 @@ type GetOrganizationsAccessReportOutput struct { // service. 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 - // operations. + // Contains information about the reason that the operation failed. + // + // This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations. ErrorDetails *types.ErrorDetails // A flag that indicates whether there are more items to return. If your results @@ -104,9 +111,12 @@ type GetOrganizationsAccessReportOutput struct { // 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], 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 . + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 JobCompletionDate *time.Time // When IsTruncated is true , this element is present and contains the value to use diff --git a/service/iam/api_op_GetPolicy.go b/service/iam/api_op_GetPolicy.go index 833b99532a3..e2c121a4ae1 100644 --- a/service/iam/api_op_GetPolicy.go +++ b/service/iam/api_op_GetPolicy.go @@ -19,14 +19,17 @@ import ( // 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. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { params = &GetPolicyInput{} @@ -45,8 +48,12 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string @@ -184,12 +191,13 @@ type PolicyExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetPolicyInput, *GetPolicyOutput, error) (bool, error) } diff --git a/service/iam/api_op_GetPolicyVersion.go b/service/iam/api_op_GetPolicyVersion.go index 9f6b7310139..12e5545ef9b 100644 --- a/service/iam/api_op_GetPolicyVersion.go +++ b/service/iam/api_op_GetPolicyVersion.go @@ -12,20 +12,27 @@ 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 -// can use a URL decoding method to convert the policy back to plain JSON text. For +// policy, including the policy document. +// +// Policies returned by this operation are URL-encoded compliant with [RFC 3986]. 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) -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// For more information about managed policy versions, see [Versioning for managed policies] in the IAM User Guide. +// +// [RFC 3986]: https://tools.ietf.org/html/rfc3986 +// [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error) { if params == nil { params = &GetPolicyVersionInput{} @@ -44,16 +51,23 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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 - // 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. + // Identifies the policy version to retrieve. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. VersionId *string diff --git a/service/iam/api_op_GetRole.go b/service/iam/api_op_GetRole.go index b8e7667c2f6..cc8b5e46107 100644 --- a/service/iam/api_op_GetRole.go +++ b/service/iam/api_op_GetRole.go @@ -18,13 +18,16 @@ import ( // 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 IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) -// in the IAM User Guide. 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. +// role. For more information about roles, see [IAM roles]in the IAM User Guide. +// +// Policies returned by this operation are URL-encoded compliant with [RFC 3986]. 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. +// +// [RFC 3986]: https://tools.ietf.org/html/rfc3986 +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html func (c *Client) GetRole(ctx context.Context, params *GetRoleInput, optFns ...func(*Options)) (*GetRoleOutput, error) { if params == nil { params = &GetRoleInput{} @@ -42,10 +45,13 @@ 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 - // 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 role to get information about. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -185,12 +191,13 @@ type RoleExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetRoleInput, *GetRoleOutput, error) (bool, error) } diff --git a/service/iam/api_op_GetRolePolicy.go b/service/iam/api_op_GetRolePolicy.go index 567b7f20795..0a99909fa1d 100644 --- a/service/iam/api_op_GetRolePolicy.go +++ b/service/iam/api_op_GetRolePolicy.go @@ -11,18 +11,25 @@ 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) -// in the IAM User Guide. For more information about roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) -// in the IAM User Guide. +// specified IAM role. +// +// Policies returned by this operation are URL-encoded compliant with [RFC 3986]. 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 GetPolicyto determine the +// policy's default version, then use GetPolicyVersionto retrieve the policy document. +// +// For more information about policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// For more information about roles, see [IAM roles] in the IAM User Guide. +// +// [RFC 3986]: https://tools.ietf.org/html/rfc3986 +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) GetRolePolicy(ctx context.Context, params *GetRolePolicyInput, optFns ...func(*Options)) (*GetRolePolicyOutput, error) { if params == nil { params = &GetRolePolicyInput{} @@ -40,18 +47,24 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // The name of the role associated with the policy. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -62,10 +75,11 @@ 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. - // CloudFormation always converts a YAML policy to JSON format before submitting it - // to IAM. + // 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. // // This member is required. PolicyDocument *string diff --git a/service/iam/api_op_GetSAMLProvider.go b/service/iam/api_op_GetSAMLProvider.go index b5432021f7b..646322eea9d 100644 --- a/service/iam/api_op_GetSAMLProvider.go +++ b/service/iam/api_op_GetSAMLProvider.go @@ -13,9 +13,11 @@ 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) -// . +// provider resource object was created or updated. +// +// This operation requires [Signature Version 4]. +// +// [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{} @@ -34,9 +36,12 @@ func (c *Client) GetSAMLProvider(ctx context.Context, params *GetSAMLProviderInp 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. + // get information about. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. SAMLProviderArn *string @@ -55,8 +60,9 @@ 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html 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 5d9134b6dca..5181b84d559 100644 --- a/service/iam/api_op_GetSSHPublicKey.go +++ b/service/iam/api_op_GetSSHPublicKey.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified SSH public key, including metadata about the key. The -// 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) -// in the CodeCommit User Guide. +// Retrieves the specified SSH public key, including metadata about the key. +// +// The 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]in the +// CodeCommit User Guide. +// +// [Set up CodeCommit for SSH connections]: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html func (c *Client) GetSSHPublicKey(ctx context.Context, params *GetSSHPublicKeyInput, optFns ...func(*Options)) (*GetSSHPublicKeyOutput, error) { if params == nil { params = &GetSSHPublicKeyInput{} @@ -41,17 +43,23 @@ type GetSSHPublicKeyInput struct { // 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]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user associated with the SSH public key. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_GetServerCertificate.go b/service/iam/api_op_GetServerCertificate.go index 94950e6735f..d8d2d1cf00c 100644 --- a/service/iam/api_op_GetServerCertificate.go +++ b/service/iam/api_op_GetServerCertificate.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// Retrieves information about the specified server certificate stored in IAM. +// +// For more information about working with server certificates, see [Working with server certificates] 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. +// +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html func (c *Client) GetServerCertificate(ctx context.Context, params *GetServerCertificateInput, optFns ...func(*Options)) (*GetServerCertificateOutput, error) { if params == nil { params = &GetServerCertificateInput{} @@ -33,10 +35,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the server certificate you want to retrieve information about. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string diff --git a/service/iam/api_op_GetServiceLastAccessedDetails.go b/service/iam/api_op_GetServiceLastAccessedDetails.go index 7bc933caf27..85fac68c1e4 100644 --- a/service/iam/api_op_GetServiceLastAccessedDetails.go +++ b/service/iam/api_op_GetServiceLastAccessedDetails.go @@ -17,35 +17,49 @@ import ( // 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) -// 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 -// the most recent attempt to access the service. If the operation fails, the -// GetServiceLastAccessedDetails operation returns the reason that it failed. The -// GetServiceLastAccessedDetails operation returns a list of services. This list -// 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: +// 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]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 the most recent attempt to +// access the service. If the operation fails, the GetServiceLastAccessedDetails +// operation returns the reason that it failed. +// +// The GetServiceLastAccessedDetails operation returns a list of services. This +// list 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 // -// 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. +// 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] in the +// IAM User Guide. +// +// [Reducing permissions using service last accessed data]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html +// [Evaluating policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics func (c *Client) GetServiceLastAccessedDetails(ctx context.Context, params *GetServiceLastAccessedDetailsInput, optFns ...func(*Options)) (*GetServiceLastAccessedDetailsOutput, error) { if params == nil { params = &GetServiceLastAccessedDetailsInput{} @@ -63,10 +77,9 @@ func (c *Client) GetServiceLastAccessedDetails(ctx context.Context, params *GetS 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 . + // 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 . // // This member is required. JobId *string @@ -79,11 +92,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -91,15 +106,19 @@ 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], 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 . + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // 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], when the report job was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCreationDate *time.Time @@ -109,7 +128,7 @@ type GetServiceLastAccessedDetailsOutput struct { // This member is required. JobStatus types.JobStatusType - // A ServiceLastAccessed object that contains details about the most recent + // A ServiceLastAccessed object that contains details about the most recent // attempt to access the service. // // This member is required. diff --git a/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go b/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go index 7f48701d228..ebc4b13293c 100644 --- a/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go +++ b/service/iam/api_op_GetServiceLastAccessedDetailsWithEntities.go @@ -17,18 +17,23 @@ import ( // 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. // // 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. +// 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{} @@ -54,13 +59,16 @@ 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) - // 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) - // in the Amazon Web Services General Reference. + // service. + // + // To learn the service namespace for a service, see [Actions, resources, and condition keys for Amazon Web Services services] 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]in the Amazon Web Services + // General Reference. + // + // [Amazon Web Services service namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces + // [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 // // This member is required. ServiceNamespace *string @@ -73,11 +81,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -92,15 +102,19 @@ type GetServiceLastAccessedDetailsWithEntitiesOutput struct { // 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], 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 . + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // 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], when the report job was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. JobCreationDate *time.Time diff --git a/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go b/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go index 2b3777c6440..19fd53c2f12 100644 --- a/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go +++ b/service/iam/api_op_GetServiceLinkedRoleDeletionStatus.go @@ -11,11 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the status of your service-linked role deletion. After you use -// DeleteServiceLinkedRole to submit a service-linked role for deletion, you can -// use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check -// the status of the deletion. If the deletion fails, this operation returns the -// reason that it failed, if that information is returned by the service. +// Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to +// submit a service-linked role for deletion, you can use the DeletionTaskId +// parameter in GetServiceLinkedRoleDeletionStatus to check the status of the +// deletion. If the deletion fails, this operation returns the reason that it +// failed, if that information is returned by the service. func (c *Client) GetServiceLinkedRoleDeletionStatus(ctx context.Context, params *GetServiceLinkedRoleDeletionStatusInput, optFns ...func(*Options)) (*GetServiceLinkedRoleDeletionStatusOutput, error) { if params == nil { params = &GetServiceLinkedRoleDeletionStatusInput{} @@ -33,8 +33,8 @@ 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/// . + // The deletion task identifier. This identifier is returned by the 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 8346bcf6ef0..32b88dacc02 100644 --- a/service/iam/api_op_GetUser.go +++ b/service/iam/api_op_GetUser.go @@ -17,9 +17,11 @@ import ( ) // Retrieves information about the specified IAM user, including the user's -// creation date, path, unique ID, and ARN. If you do not specify a user name, IAM -// determines the user name implicitly based on the Amazon Web Services access key -// ID used to sign the request to this operation. +// creation date, path, unique ID, and ARN. +// +// If you do not specify a user name, IAM determines the user name implicitly +// based on the Amazon Web Services access key ID used to sign the request to this +// operation. func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error) { if params == nil { params = &GetUserInput{} @@ -37,11 +39,14 @@ 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 - // spaces. You can also include any of the following characters: _+=,.@- + // 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]) a string of characters + // consisting of upper and lowercase alphanumeric characters with no spaces. You + // can also include any of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde @@ -50,21 +55,26 @@ type GetUserInput struct { // Contains the response to a successful GetUser request. 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) - // 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 - // 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 - // delete users who did not sign in to Amazon Web Services in the last 90 days. In - // cases like this, we recommend that you adjust your evaluation window to include - // dates after May 23, 2018. Alternatively, if your users use access keys to access - // Amazon Web Services programmatically you can refer to access key last used - // information because it is accurate for all dates. + // 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]dates shown + // in the IAM console and password last used dates in the [IAM credential report], 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 delete users who did not sign in to Amazon Web + // Services in the last 90 days. In cases like this, we recommend that you adjust + // your evaluation window to include dates after May 23, 2018. Alternatively, if + // your users use access keys to access Amazon Web Services programmatically you + // can refer to access key last used information because it is accurate for all + // dates. + // + // [IAM credential report]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html + // [last sign-in]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html // // This member is required. User *types.User @@ -190,12 +200,13 @@ type UserExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetUserInput, *GetUserOutput, error) (bool, error) } diff --git a/service/iam/api_op_GetUserPolicy.go b/service/iam/api_op_GetUserPolicy.go index 22854dda974..e67e60bd937 100644 --- a/service/iam/api_op_GetUserPolicy.go +++ b/service/iam/api_op_GetUserPolicy.go @@ -11,17 +11,22 @@ import ( ) // 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. +// specified IAM user. +// +// Policies returned by this operation are URL-encoded compliant with [RFC 3986]. 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 GetPolicyto determine the +// policy's default version. Then use GetPolicyVersionto retrieve the policy document. +// +// For more information about policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// [RFC 3986]: https://tools.ietf.org/html/rfc3986 +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) GetUserPolicy(ctx context.Context, params *GetUserPolicyInput, optFns ...func(*Options)) (*GetUserPolicyOutput, error) { if params == nil { params = &GetUserPolicyInput{} @@ -39,18 +44,24 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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 - // 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 who the policy is associated with. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string @@ -61,10 +72,11 @@ 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. - // CloudFormation always converts a YAML policy to JSON format before submitting it - // to IAM. + // 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. // // This member is required. PolicyDocument *string diff --git a/service/iam/api_op_ListAccessKeys.go b/service/iam/api_op_ListAccessKeys.go index fa236810795..a8e4cf34efe 100644 --- a/service/iam/api_op_ListAccessKeys.go +++ b/service/iam/api_op_ListAccessKeys.go @@ -12,17 +12,22 @@ import ( ) // Returns information about the access key IDs associated with the specified IAM -// user. If there is none, the operation returns an empty list. Although each user -// is limited to a small number of keys, you can still paginate the results using -// the MaxItems and Marker parameters. 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. If the Amazon Web Services account has no associated users, the root -// user returns it's own access key IDs by running this command. To ensure the -// security of your Amazon Web Services account, the secret access key is -// accessible only during key and user creation. +// user. If there is none, the operation returns an empty list. +// +// Although each user is limited to a small number of keys, you can still paginate +// the results using the MaxItems and Marker parameters. +// +// 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. If +// the Amazon Web Services account has no associated users, the root user returns +// it's own access key IDs by running this command. +// +// To ensure the security of your Amazon Web Services account, the secret access +// key is accessible only during key and user creation. func (c *Client) ListAccessKeys(ctx context.Context, params *ListAccessKeysInput, optFns ...func(*Options)) (*ListAccessKeysOutput, error) { if params == nil { params = &ListAccessKeysInput{} @@ -48,17 +53,22 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde @@ -178,11 +188,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListAccountAliases.go b/service/iam/api_op_ListAccountAliases.go index b8c2c0c231a..505904e06fb 100644 --- a/service/iam/api_op_ListAccountAliases.go +++ b/service/iam/api_op_ListAccountAliases.go @@ -12,9 +12,9 @@ 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 Creating, deleting, and listing an Amazon Web Services -// account alias (https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html) -// in the Amazon Web Services Sign-In User Guide. +// account alias, see [Creating, deleting, and listing an Amazon Web Services account alias]in the Amazon Web Services Sign-In User Guide. +// +// [Creating, deleting, and listing an Amazon Web Services account alias]: https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html func (c *Client) ListAccountAliases(ctx context.Context, params *ListAccountAliasesInput, optFns ...func(*Options)) (*ListAccountAliasesOutput, error) { if params == nil { params = &ListAccountAliasesInput{} @@ -40,11 +40,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -166,11 +168,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListAttachedGroupPolicies.go b/service/iam/api_op_ListAttachedGroupPolicies.go index 638e893df23..faeceeeb79d 100644 --- a/service/iam/api_op_ListAttachedGroupPolicies.go +++ b/service/iam/api_op_ListAttachedGroupPolicies.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// policies attached to the specified group (or none that match the specified path -// prefix), the operation returns an empty list. +// 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] 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 policies attached to the +// specified group (or none that match the specified path prefix), the operation +// returns an empty list. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListAttachedGroupPolicies(ctx context.Context, params *ListAttachedGroupPoliciesInput, optFns ...func(*Options)) (*ListAttachedGroupPoliciesOutput, error) { if params == nil { params = &ListAttachedGroupPoliciesInput{} @@ -38,10 +42,12 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string @@ -54,20 +60,25 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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. + // not included, it defaults to a slash (/), listing all policies. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -189,11 +200,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListAttachedRolePolicies.go b/service/iam/api_op_ListAttachedRolePolicies.go index e99a3990f61..4dd5da31dbb 100644 --- a/service/iam/api_op_ListAttachedRolePolicies.go +++ b/service/iam/api_op_ListAttachedRolePolicies.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// policies attached to the specified role (or none that match the specified path -// prefix), the operation returns an empty list. +// 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] 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 policies attached to the +// specified role (or none that match the specified path prefix), the operation +// returns an empty list. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListAttachedRolePolicies(ctx context.Context, params *ListAttachedRolePoliciesInput, optFns ...func(*Options)) (*ListAttachedRolePoliciesOutput, error) { if params == nil { params = &ListAttachedRolePoliciesInput{} @@ -38,10 +42,12 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -54,20 +60,25 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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. + // not included, it defaults to a slash (/), listing all policies. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -189,11 +200,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListAttachedUserPolicies.go b/service/iam/api_op_ListAttachedUserPolicies.go index 70623156233..b70c262528a 100644 --- a/service/iam/api_op_ListAttachedUserPolicies.go +++ b/service/iam/api_op_ListAttachedUserPolicies.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// policies attached to the specified group (or none that match the specified path -// prefix), the operation returns an empty list. +// 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] 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 policies attached to the +// specified group (or none that match the specified path prefix), the operation +// returns an empty list. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListAttachedUserPolicies(ctx context.Context, params *ListAttachedUserPoliciesInput, optFns ...func(*Options)) (*ListAttachedUserPoliciesOutput, error) { if params == nil { params = &ListAttachedUserPoliciesInput{} @@ -38,10 +42,12 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string @@ -54,20 +60,25 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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. + // not included, it defaults to a slash (/), listing all policies. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -189,11 +200,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListEntitiesForPolicy.go b/service/iam/api_op_ListEntitiesForPolicy.go index 2fcc45b069b..0a376869f9f 100644 --- a/service/iam/api_op_ListEntitiesForPolicy.go +++ b/service/iam/api_op_ListEntitiesForPolicy.go @@ -12,11 +12,13 @@ import ( ) // Lists all IAM users, groups, and roles that the specified managed policy is -// 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. +// 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. func (c *Client) ListEntitiesForPolicy(ctx context.Context, params *ListEntitiesForPolicyInput, optFns ...func(*Options)) (*ListEntitiesForPolicyOutput, error) { if params == nil { params = &ListEntitiesForPolicyInput{} @@ -35,17 +37,22 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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. - // 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. + // 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. 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. EntityFilter types.EntityType // Use this parameter only when paginating results and only after you receive a @@ -56,27 +63,34 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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. + // not included, it defaults to a slash (/), listing all entities. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string - // The policy usage method to use for filtering the results. 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 - // policies are returned. + // The policy usage method to use for filtering the results. + // + // 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 policies are returned. PolicyUsageFilter types.PolicyUsageType noSmithyDocumentSerde @@ -204,11 +218,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListGroupPolicies.go b/service/iam/api_op_ListGroupPolicies.go index e13340e8f98..b8e4bb93edd 100644 --- a/service/iam/api_op_ListGroupPolicies.go +++ b/service/iam/api_op_ListGroupPolicies.go @@ -11,12 +11,17 @@ 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) -// 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. +// 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]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. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListGroupPolicies(ctx context.Context, params *ListGroupPoliciesInput, optFns ...func(*Options)) (*ListGroupPoliciesOutput, error) { if params == nil { params = &ListGroupPoliciesInput{} @@ -34,10 +39,13 @@ 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // The name of the group to list policies for. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string @@ -50,11 +58,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -63,10 +73,13 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyNames []string @@ -180,11 +193,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListGroups.go b/service/iam/api_op_ListGroups.go index 069df2c0a9a..ff1ddc1ad16 100644 --- a/service/iam/api_op_ListGroups.go +++ b/service/iam/api_op_ListGroups.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the IAM groups that have the specified path prefix. You can paginate the -// results using the MaxItems and Marker parameters. +// Lists the IAM groups that have the specified path prefix. +// +// You can paginate the results using the MaxItems and Marker parameters. func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { params = &ListGroupsInput{} @@ -38,22 +39,27 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 + // 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 - // included, it defaults to a slash (/), listing all groups. 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/ . + // + // This parameter is optional. If it is not included, it defaults to a slash (/), + // listing all groups. This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -172,11 +178,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListGroupsForUser.go b/service/iam/api_op_ListGroupsForUser.go index 003c5595159..df17350c4a5 100644 --- a/service/iam/api_op_ListGroupsForUser.go +++ b/service/iam/api_op_ListGroupsForUser.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the IAM groups that the specified IAM user belongs to. You can paginate -// the results using the MaxItems and Marker parameters. +// Lists the IAM groups that the specified IAM user belongs to. +// +// You can paginate the results using the MaxItems and Marker parameters. func (c *Client) ListGroupsForUser(ctx context.Context, params *ListGroupsForUserInput, optFns ...func(*Options)) (*ListGroupsForUserOutput, error) { if params == nil { params = &ListGroupsForUserInput{} @@ -30,10 +31,13 @@ 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 - // 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 list groups for. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string @@ -46,11 +50,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -173,11 +179,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListInstanceProfileTags.go b/service/iam/api_op_ListInstanceProfileTags.go index a5a2c758e63..355e4a31107 100644 --- a/service/iam/api_op_ListInstanceProfileTags.go +++ b/service/iam/api_op_ListInstanceProfileTags.go @@ -13,8 +13,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListInstanceProfileTags(ctx context.Context, params *ListInstanceProfileTagsInput, optFns ...func(*Options)) (*ListInstanceProfileTagsOutput, error) { if params == nil { params = &ListInstanceProfileTagsInput{} @@ -32,10 +33,13 @@ 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM instance profile whose tags you want to see. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string @@ -48,11 +52,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -177,11 +183,13 @@ var _ ListInstanceProfileTagsAPIClient = (*Client)(nil) type ListInstanceProfileTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListInstanceProfiles.go b/service/iam/api_op_ListInstanceProfiles.go index beeeebea415..cdf7eb5e46b 100644 --- a/service/iam/api_op_ListInstanceProfiles.go +++ b/service/iam/api_op_ListInstanceProfiles.go @@ -13,12 +13,16 @@ 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 Using instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.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 an instance profile, see GetInstanceProfile . You can -// paginate the results using the MaxItems and Marker parameters. +// profiles, see [Using instance profiles]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 an +// instance profile, see GetInstanceProfile. +// +// You can paginate the results using the MaxItems and Marker parameters. +// +// [Using instance profiles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html func (c *Client) ListInstanceProfiles(ctx context.Context, params *ListInstanceProfilesInput, optFns ...func(*Options)) (*ListInstanceProfilesOutput, error) { if params == nil { params = &ListInstanceProfilesInput{} @@ -44,22 +48,27 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 + // 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 - // 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 - // 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. + // 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -180,11 +189,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListInstanceProfilesForRole.go b/service/iam/api_op_ListInstanceProfilesForRole.go index d79f1f89d35..2a5c89f494a 100644 --- a/service/iam/api_op_ListInstanceProfilesForRole.go +++ b/service/iam/api_op_ListInstanceProfilesForRole.go @@ -13,9 +13,11 @@ 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 Using instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) -// in the IAM User Guide. You can paginate the results using the MaxItems and -// Marker parameters. +// instance profiles, go to [Using instance profiles]in the IAM User Guide. +// +// You can paginate the results using the MaxItems and Marker parameters. +// +// [Using instance profiles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html func (c *Client) ListInstanceProfilesForRole(ctx context.Context, params *ListInstanceProfilesForRoleInput, optFns ...func(*Options)) (*ListInstanceProfilesForRoleOutput, error) { if params == nil { params = &ListInstanceProfilesForRoleInput{} @@ -33,10 +35,13 @@ 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 - // 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 list instance profiles for. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -49,11 +54,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -177,11 +184,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListMFADeviceTags.go b/service/iam/api_op_ListMFADeviceTags.go index 72b824eb397..28fbea185e5 100644 --- a/service/iam/api_op_ListMFADeviceTags.go +++ b/service/iam/api_op_ListMFADeviceTags.go @@ -13,8 +13,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListMFADeviceTags(ctx context.Context, params *ListMFADeviceTagsInput, optFns ...func(*Options)) (*ListMFADeviceTagsOutput, error) { if params == nil { params = &ListMFADeviceTagsInput{} @@ -33,10 +34,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // see. For virtual MFA devices, the serial number is the same as the ARN. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string @@ -49,11 +53,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -177,11 +183,13 @@ var _ ListMFADeviceTagsAPIClient = (*Client)(nil) type ListMFADeviceTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListMFADevices.go b/service/iam/api_op_ListMFADevices.go index 50d499562ab..152213b3ae6 100644 --- a/service/iam/api_op_ListMFADevices.go +++ b/service/iam/api_op_ListMFADevices.go @@ -15,8 +15,9 @@ import ( // then this operation lists all the MFA devices associated with the specified // user. 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 for this -// operation. You can paginate the results using the MaxItems and Marker -// parameters. +// operation. +// +// You can paginate the results using the MaxItems and Marker parameters. func (c *Client) ListMFADevices(ctx context.Context, params *ListMFADevicesInput, optFns ...func(*Options)) (*ListMFADevicesOutput, error) { if params == nil { params = &ListMFADevicesInput{} @@ -42,17 +43,22 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 - // 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 whose MFA devices you want to list. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde @@ -172,11 +178,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListOpenIDConnectProviderTags.go b/service/iam/api_op_ListOpenIDConnectProviderTags.go index fc7f9d2bc41..af61dc6ac6a 100644 --- a/service/iam/api_op_ListOpenIDConnectProviderTags.go +++ b/service/iam/api_op_ListOpenIDConnectProviderTags.go @@ -13,9 +13,12 @@ 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]. +// +// For more information about tagging, see [Tagging IAM resources] in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html +// [About web identity federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html func (c *Client) ListOpenIDConnectProviderTags(ctx context.Context, params *ListOpenIDConnectProviderTagsInput, optFns ...func(*Options)) (*ListOpenIDConnectProviderTagsOutput, error) { if params == nil { params = &ListOpenIDConnectProviderTagsInput{} @@ -34,10 +37,13 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. OpenIDConnectProviderArn *string @@ -50,11 +56,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -180,11 +188,13 @@ var _ ListOpenIDConnectProviderTagsAPIClient = (*Client)(nil) type ListOpenIDConnectProviderTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListOpenIDConnectProviders.go b/service/iam/api_op_ListOpenIDConnectProviders.go index d735e308d24..c8e405433ce 100644 --- a/service/iam/api_op_ListOpenIDConnectProviders.go +++ b/service/iam/api_op_ListOpenIDConnectProviders.go @@ -12,11 +12,12 @@ import ( ) // Lists information about the IAM OpenID Connect (OIDC) provider resource objects -// defined in the Amazon Web Services account. 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 OIDC provider, see -// GetOpenIDConnectProvider . +// defined in the Amazon Web Services account. +// +// 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 +// OIDC provider, see 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 bc1506af19e..deda94bb7c7 100644 --- a/service/iam/api_op_ListPolicies.go +++ b/service/iam/api_op_ListPolicies.go @@ -13,17 +13,23 @@ 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) -// 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 . +// 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] 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. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error) { if params == nil { params = &ListPoliciesInput{} @@ -49,40 +55,50 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string - // The policy usage method to use for filtering the results. 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 - // policies are returned. + // The policy usage method to use for filtering the results. + // + // 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 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 - // returned. + // 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 returned. Scope types.PolicyScopeType noSmithyDocumentSerde @@ -199,11 +215,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListPoliciesGrantingServiceAccess.go b/service/iam/api_op_ListPoliciesGrantingServiceAccess.go index 8ad9b16f08b..d1f3eb05719 100644 --- a/service/iam/api_op_ListPoliciesGrantingServiceAccess.go +++ b/service/iam/api_op_ListPoliciesGrantingServiceAccess.go @@ -12,31 +12,39 @@ import ( ) // Retrieves a list of policies that the IAM identity (user, group, or role) can -// use to access each specified service. This operation 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) -// in the IAM User Guide. The list of policies returned by the operation depends on -// the ARN of the identity that you provide. +// use to access each specified service. +// +// This operation 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]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. // // 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 -// GetUser or GetRole operations. +// policy types, see [Managed policies and inline policies]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 GetUseror GetRole operations. +// +// [Evaluating policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html func (c *Client) ListPoliciesGrantingServiceAccess(ctx context.Context, params *ListPoliciesGrantingServiceAccessInput, optFns ...func(*Options)) (*ListPoliciesGrantingServiceAccessOutput, error) { if params == nil { params = &ListPoliciesGrantingServiceAccessInput{} @@ -61,13 +69,16 @@ type ListPoliciesGrantingServiceAccessInput struct { Arn *string // 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) - // 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) - // in the Amazon Web Services General Reference. + // want to list. + // + // To learn the service namespace for a service, see [Actions, resources, and condition keys for Amazon Web Services services] 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]in the Amazon Web Services + // General Reference. + // + // [Amazon Web Services service namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces + // [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 // // This member is required. ServiceNamespaces []string diff --git a/service/iam/api_op_ListPolicyTags.go b/service/iam/api_op_ListPolicyTags.go index 621216fd845..0d539db1a4b 100644 --- a/service/iam/api_op_ListPolicyTags.go +++ b/service/iam/api_op_ListPolicyTags.go @@ -13,8 +13,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListPolicyTags(ctx context.Context, params *ListPolicyTagsInput, optFns ...func(*Options)) (*ListPolicyTagsOutput, error) { if params == nil { params = &ListPolicyTagsInput{} @@ -32,10 +33,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The ARN of the IAM customer managed policy whose tags you want to see. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyArn *string @@ -48,11 +52,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -176,11 +182,13 @@ var _ ListPolicyTagsAPIClient = (*Client)(nil) type ListPolicyTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListPolicyVersions.go b/service/iam/api_op_ListPolicyVersions.go index 5cdb73481b4..83dd8bc1bbd 100644 --- a/service/iam/api_op_ListPolicyVersions.go +++ b/service/iam/api_op_ListPolicyVersions.go @@ -12,9 +12,11 @@ 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) -// in the IAM User Guide. +// the version that is currently set as the policy's default version. +// +// For more information about managed policies, see [Managed policies and inline policies] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error) { if params == nil { params = &ListPolicyVersionsInput{} @@ -33,8 +35,12 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string @@ -47,11 +53,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -72,9 +80,11 @@ type ListPolicyVersionsOutput struct { // 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) - // in the IAM User Guide. + // A list of policy versions. + // + // For more information about managed policy versions, see [Versioning for managed policies] in the IAM User Guide. + // + // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html Versions []types.PolicyVersion // Metadata pertaining to the operation's result. @@ -175,11 +185,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListRolePolicies.go b/service/iam/api_op_ListRolePolicies.go index 0729bda627d..c79b9ff207d 100644 --- a/service/iam/api_op_ListRolePolicies.go +++ b/service/iam/api_op_ListRolePolicies.go @@ -11,12 +11,17 @@ 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) -// 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. +// 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]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. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListRolePolicies(ctx context.Context, params *ListRolePoliciesInput, optFns ...func(*Options)) (*ListRolePoliciesOutput, error) { if params == nil { params = &ListRolePoliciesInput{} @@ -34,10 +39,13 @@ 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 - // 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 list policies for. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -50,11 +58,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -177,11 +187,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListRoleTags.go b/service/iam/api_op_ListRoleTags.go index 3d8030908b2..c88fcafcc50 100644 --- a/service/iam/api_op_ListRoleTags.go +++ b/service/iam/api_op_ListRoleTags.go @@ -12,9 +12,10 @@ import ( ) // Lists the tags that are attached to the specified role. 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 is sorted by tag key. For more information about tagging, see [Tagging IAM resources]in the IAM +// User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListRoleTags(ctx context.Context, params *ListRoleTagsInput, optFns ...func(*Options)) (*ListRoleTagsOutput, error) { if params == nil { params = &ListRoleTagsInput{} @@ -32,11 +33,13 @@ 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) ) - // a string of characters that consist of upper and lowercase alphanumeric - // characters with no spaces. You can also include any of the following characters: - // _+=,.@- + // The name of the IAM role for which you want to see the list of tags. + // + // This parameter accepts (through its [regex pattern]) a string of characters that consist of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string @@ -49,11 +52,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -176,11 +181,13 @@ var _ ListRoleTagsAPIClient = (*Client)(nil) type ListRoleTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListRoles.go b/service/iam/api_op_ListRoles.go index 3ba0132b3e2..f000353dcea 100644 --- a/service/iam/api_op_ListRoles.go +++ b/service/iam/api_op_ListRoles.go @@ -12,16 +12,24 @@ 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 IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) -// in the IAM User Guide. IAM resource-listing operations return a subset of the -// available attributes for the resource. This operation does not return the -// following attributes, even though they are an attribute of the returned object: +// operation returns an empty list. For more information about roles, see [IAM roles]in the +// IAM User Guide. +// +// IAM resource-listing operations return a subset of the available attributes for +// the resource. This operation does not return the following attributes, even +// though they are an attribute of the returned object: +// // - PermissionsBoundary +// // - RoleLastUsed +// // - Tags // -// To view all of the information for a role, see GetRole . You can paginate the -// results using the MaxItems and Marker parameters. +// To view all of the information for a role, see GetRole. +// +// You can paginate the results using the MaxItems and Marker parameters. +// +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html func (c *Client) ListRoles(ctx context.Context, params *ListRolesInput, optFns ...func(*Options)) (*ListRolesOutput, error) { if params == nil { params = &ListRolesInput{} @@ -47,22 +55,27 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 + // 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 - // included, it defaults to a slash (/), listing all roles. 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. + // /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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -181,11 +194,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListSAMLProviderTags.go b/service/iam/api_op_ListSAMLProviderTags.go index 0e5294dc654..cc19fbb53f4 100644 --- a/service/iam/api_op_ListSAMLProviderTags.go +++ b/service/iam/api_op_ListSAMLProviderTags.go @@ -13,9 +13,12 @@ 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]. +// +// For more information about tagging, see [Tagging IAM resources] in the IAM User Guide. +// +// [About SAML 2.0-based federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListSAMLProviderTags(ctx context.Context, params *ListSAMLProviderTagsInput, optFns ...func(*Options)) (*ListSAMLProviderTagsOutput, error) { if params == nil { params = &ListSAMLProviderTagsInput{} @@ -34,10 +37,13 @@ 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: - // _+=,.@- + // whose tags you want to see. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SAMLProviderArn *string @@ -50,11 +56,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -180,11 +188,13 @@ var _ ListSAMLProviderTagsAPIClient = (*Client)(nil) type ListSAMLProviderTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListSAMLProviders.go b/service/iam/api_op_ListSAMLProviders.go index fa26e314e06..13bf1c32a60 100644 --- a/service/iam/api_op_ListSAMLProviders.go +++ b/service/iam/api_op_ListSAMLProviders.go @@ -15,8 +15,11 @@ 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]. +// +// [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 80c4cced7b9..4d6b714e6b5 100644 --- a/service/iam/api_op_ListSSHPublicKeys.go +++ b/service/iam/api_op_ListSSHPublicKeys.go @@ -12,13 +12,17 @@ import ( ) // Returns information about the SSH public keys associated with the specified IAM -// 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) -// 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. +// 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]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. +// +// [Set up CodeCommit for SSH connections]: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html func (c *Client) ListSSHPublicKeys(ctx context.Context, params *ListSSHPublicKeysInput, optFns ...func(*Options)) (*ListSSHPublicKeysOutput, error) { if params == nil { params = &ListSSHPublicKeysInput{} @@ -44,19 +48,24 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde @@ -174,11 +183,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListServerCertificateTags.go b/service/iam/api_op_ListServerCertificateTags.go index f45e0b5314d..c4a5543f6c4 100644 --- a/service/iam/api_op_ListServerCertificateTags.go +++ b/service/iam/api_op_ListServerCertificateTags.go @@ -13,12 +13,15 @@ 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) -// in the IAM User Guide. +// see [Tagging IAM resources]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]in the IAM User Guide. +// +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListServerCertificateTags(ctx context.Context, params *ListServerCertificateTagsInput, optFns ...func(*Options)) (*ListServerCertificateTagsOutput, error) { if params == nil { params = &ListServerCertificateTagsInput{} @@ -36,10 +39,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM server certificate whose tags you want to see. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string @@ -52,11 +58,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -181,11 +189,13 @@ var _ ListServerCertificateTagsAPIClient = (*Client)(nil) type ListServerCertificateTagsPaginatorOptions 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListServerCertificates.go b/service/iam/api_op_ListServerCertificates.go index f3b6f53b94e..119191db3ff 100644 --- a/service/iam/api_op_ListServerCertificates.go +++ b/service/iam/api_op_ListServerCertificates.go @@ -12,15 +12,20 @@ import ( ) // 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 . +// 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] 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. +// +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html func (c *Client) ListServerCertificates(ctx context.Context, params *ListServerCertificatesInput, optFns ...func(*Options)) (*ListServerCertificatesOutput, error) { if params == nil { params = &ListServerCertificatesInput{} @@ -46,22 +51,27 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 + // 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 - // defaults to a slash (/), listing all server certificates. 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. + // /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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -182,11 +192,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListServiceSpecificCredentials.go b/service/iam/api_op_ListServiceSpecificCredentials.go index 9cce662df61..61b7a9633b5 100644 --- a/service/iam/api_op_ListServiceSpecificCredentials.go +++ b/service/iam/api_op_ListServiceSpecificCredentials.go @@ -16,8 +16,9 @@ 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]in the CodeCommit User Guide. +// +// [Set up service-specific credentials]: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html func (c *Client) ListServiceSpecificCredentials(ctx context.Context, params *ListServiceSpecificCredentialsInput, optFns ...func(*Options)) (*ListServiceSpecificCredentialsOutput, error) { if params == nil { params = &ListServiceSpecificCredentialsInput{} @@ -42,10 +43,13 @@ type ListServiceSpecificCredentialsInput struct { // 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // credentials are used to call the operation. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_ListSigningCertificates.go b/service/iam/api_op_ListSigningCertificates.go index c9222c3b12b..59adeb92ef4 100644 --- a/service/iam/api_op_ListSigningCertificates.go +++ b/service/iam/api_op_ListSigningCertificates.go @@ -13,10 +13,12 @@ import ( // 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 +// +// 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 @@ -46,17 +48,22 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user whose signing certificates you want to examine. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde @@ -177,11 +184,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListUserPolicies.go b/service/iam/api_op_ListUserPolicies.go index 8b892c656bd..2e976666bcd 100644 --- a/service/iam/api_op_ListUserPolicies.go +++ b/service/iam/api_op_ListUserPolicies.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// 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]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. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) ListUserPolicies(ctx context.Context, params *ListUserPoliciesInput, optFns ...func(*Options)) (*ListUserPoliciesOutput, error) { if params == nil { params = &ListUserPoliciesInput{} @@ -34,10 +38,13 @@ 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 - // 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 list policies for. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string @@ -50,11 +57,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -177,11 +186,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListUserTags.go b/service/iam/api_op_ListUserTags.go index 37294cf062b..ca3a021e8ae 100644 --- a/service/iam/api_op_ListUserTags.go +++ b/service/iam/api_op_ListUserTags.go @@ -12,9 +12,10 @@ import ( ) // 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. +// of tags is sorted by tag key. For more information about tagging, see [Tagging IAM resources]in the +// IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) ListUserTags(ctx context.Context, params *ListUserTagsInput, optFns ...func(*Options)) (*ListUserTagsOutput, error) { if params == nil { params = &ListUserTagsInput{} @@ -32,10 +33,13 @@ 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 - // 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 whose tags you want to see. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string @@ -48,11 +52,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -175,11 +181,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListUsers.go b/service/iam/api_op_ListUsers.go index 488b06857ce..1662b229039 100644 --- a/service/iam/api_op_ListUsers.go +++ b/service/iam/api_op_ListUsers.go @@ -13,15 +13,19 @@ import ( // Lists the IAM users that have the specified path prefix. If no path prefix is // specified, the operation returns all users in the Amazon Web Services account. -// If there are none, the operation returns an empty list. IAM resource-listing -// operations return a subset of the available attributes for the resource. This -// operation does not return the following attributes, even though they are an -// attribute of the returned object: +// If there are none, the operation returns an empty list. +// +// IAM resource-listing operations return a subset of the available attributes for +// the resource. This operation does not return the following attributes, even +// though they are an attribute of the returned object: +// // - PermissionsBoundary +// // - Tags // -// To view all of the information for a user, see GetUser . You can paginate the -// results using the MaxItems and Marker parameters. +// 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 { params = &ListUsersInput{} @@ -47,22 +51,27 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 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 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. + // 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex PathPrefix *string noSmithyDocumentSerde @@ -181,11 +190,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_ListVirtualMFADevices.go b/service/iam/api_op_ListVirtualMFADevices.go index 9820577aefe..4709cd2bdc4 100644 --- a/service/iam/api_op_ListVirtualMFADevices.go +++ b/service/iam/api_op_ListVirtualMFADevices.go @@ -14,11 +14,14 @@ 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 -// 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 -// paginate the results using the MaxItems and Marker parameters. +// 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 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 { params = &ListVirtualMFADevicesInput{} @@ -36,7 +39,7 @@ 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 + // 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 @@ -49,11 +52,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 noSmithyDocumentSerde @@ -62,7 +67,7 @@ type ListVirtualMFADevicesInput struct { // Contains the response to a successful ListVirtualMFADevices request. type ListVirtualMFADevicesOutput struct { - // The list of virtual MFA devices in the current account that match the + // The list of virtual MFA devices in the current account that match the // AssignmentStatus value that was passed in the request. // // This member is required. @@ -175,11 +180,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_PutGroupPolicy.go b/service/iam/api_op_PutGroupPolicy.go index c5c20af97bd..30d98185a06 100644 --- a/service/iam/api_op_PutGroupPolicy.go +++ b/service/iam/api_op_PutGroupPolicy.go @@ -11,16 +11,24 @@ 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 (https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachGroupPolicy.html) -// . To create a new managed policy, use CreatePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) -// . 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. +// group. +// +// A user can also have managed policies attached to it. To attach a managed +// policy to a group, use [AttachGroupPolicy]AttachGroupPolicy . To create a new managed policy, use [CreatePolicy] +// CreatePolicy . For information about policies, see [Managed policies and inline policies] 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]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]in the IAM User Guide. +// +// [CreatePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html +// [Making query requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html +// [AttachGroupPolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachGroupPolicy.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) PutGroupPolicy(ctx context.Context, params *PutGroupPolicyInput, optFns ...func(*Options)) (*PutGroupPolicyOutput, error) { if params == nil { params = &PutGroupPolicyInput{} @@ -38,34 +46,48 @@ 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 - // 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 to associate the policy with. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@-. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string - // 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: + // 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] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the policy document. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyName *string diff --git a/service/iam/api_op_PutRolePermissionsBoundary.go b/service/iam/api_op_PutRolePermissionsBoundary.go index 6bd1fdeaeb1..f151130eb58 100644 --- a/service/iam/api_op_PutRolePermissionsBoundary.go +++ b/service/iam/api_op_PutRolePermissionsBoundary.go @@ -14,12 +14,15 @@ import ( // boundary. You can use an Amazon Web Services managed policy or a customer // managed policy to set the boundary for a role. Use the boundary to control the // maximum permissions that the role can have. Setting a permissions boundary is an -// advanced feature that can affect the permissions for the role. You cannot set -// 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) -// in the IAM User Guide. +// advanced feature that can affect the permissions for the role. +// +// You cannot set 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]in the IAM User Guide. +// +// [IAM JSON policy evaluation logic]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html func (c *Client) PutRolePermissionsBoundary(ctx context.Context, params *PutRolePermissionsBoundaryInput, optFns ...func(*Options)) (*PutRolePermissionsBoundaryOutput, error) { if params == nil { params = &PutRolePermissionsBoundaryInput{} @@ -38,14 +41,18 @@ func (c *Client) PutRolePermissionsBoundary(ctx context.Context, params *PutRole type PutRolePermissionsBoundaryInput struct { // The ARN of the managed policy that is used to set the permissions boundary for - // the role. A permissions boundary policy defines the maximum permissions that + // the role. + // + // A permissions boundary policy defines the maximum permissions that // 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) - // in the IAM User Guide. + // resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities]in the IAM + // User Guide. + // + // For more information about policy types, see [Policy types] in the IAM User Guide. + // + // [Policy types]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types + // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html // // This member is required. PermissionsBoundary *string diff --git a/service/iam/api_op_PutRolePolicy.go b/service/iam/api_op_PutRolePolicy.go index 1c39531bfec..d850dbf2390 100644 --- a/service/iam/api_op_PutRolePolicy.go +++ b/service/iam/api_op_PutRolePolicy.go @@ -11,21 +11,33 @@ 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 (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) -// . You can update a role's trust policy using UpdateAssumeRolePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html) -// . For more information about roles, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) -// in the IAM User Guide. A role can also have a managed policy attached to it. To -// attach a managed policy to a role, use AttachRolePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachRolePolicy.html) -// . To create a new managed policy, use CreatePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) -// . 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. +// 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]CreateRole . You can update a role's trust +// policy using [UpdateAssumeRolePolicy]UpdateAssumeRolePolicy . For more information about roles, see [IAM roles] in +// the IAM User Guide. +// +// A role can also have a managed policy attached to it. To attach a managed +// policy to a role, use [AttachRolePolicy]AttachRolePolicy . To create a new managed policy, use [CreatePolicy] +// CreatePolicy . For information about policies, see [Managed policies and inline policies] 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]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]in the IAM User Guide. +// +// [UpdateAssumeRolePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html +// [AttachRolePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachRolePolicy.html +// [CreatePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html +// [Making query requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html +// [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) PutRolePolicy(ctx context.Context, params *PutRolePolicyInput, optFns ...func(*Options)) (*PutRolePolicyOutput, error) { if params == nil { params = &PutRolePolicyInput{} @@ -43,34 +55,48 @@ func (c *Client) PutRolePolicy(ctx context.Context, params *PutRolePolicyInput, type PutRolePolicyInput 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: + // 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] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the policy document. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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 - // 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 associate the policy with. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_PutUserPermissionsBoundary.go b/service/iam/api_op_PutUserPermissionsBoundary.go index cc203e1220d..5986521accd 100644 --- a/service/iam/api_op_PutUserPermissionsBoundary.go +++ b/service/iam/api_op_PutUserPermissionsBoundary.go @@ -14,11 +14,13 @@ import ( // boundary. You can use an Amazon Web Services managed policy or a customer // managed policy to set the boundary for a user. Use the boundary to control the // maximum permissions that the user can have. Setting a permissions boundary is an -// 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) -// in the IAM User Guide. +// 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]in the IAM User Guide. +// +// [IAM JSON policy evaluation logic]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html func (c *Client) PutUserPermissionsBoundary(ctx context.Context, params *PutUserPermissionsBoundaryInput, optFns ...func(*Options)) (*PutUserPermissionsBoundaryOutput, error) { if params == nil { params = &PutUserPermissionsBoundaryInput{} @@ -37,14 +39,18 @@ func (c *Client) PutUserPermissionsBoundary(ctx context.Context, params *PutUser type PutUserPermissionsBoundaryInput struct { // The ARN of the managed policy that is used to set the permissions boundary for - // the user. A permissions boundary policy defines the maximum permissions that + // the user. + // + // A permissions boundary policy defines the maximum permissions that // 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) - // in the IAM User Guide. + // resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities]in the IAM + // User Guide. + // + // For more information about policy types, see [Policy types] in the IAM User Guide. + // + // [Policy types]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types + // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html // // This member is required. PermissionsBoundary *string diff --git a/service/iam/api_op_PutUserPolicy.go b/service/iam/api_op_PutUserPolicy.go index dd522e273ba..4d0f0536dc5 100644 --- a/service/iam/api_op_PutUserPolicy.go +++ b/service/iam/api_op_PutUserPolicy.go @@ -11,16 +11,24 @@ 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 (https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachUserPolicy.html) -// . To create a new managed policy, use CreatePolicy (https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html) -// . 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. +// user. +// +// An IAM user can also have a managed policy attached to it. To attach a managed +// policy to a user, use [AttachUserPolicy]AttachUserPolicy . To create a new managed policy, use [CreatePolicy] +// CreatePolicy . For information about policies, see [Managed policies and inline policies] 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]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]in the IAM User Guide. +// +// [CreatePolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreatePolicy.html +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html +// [Making query requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html +// [AttachUserPolicy]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AttachUserPolicy.html +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) PutUserPolicy(ctx context.Context, params *PutUserPolicyInput, optFns ...func(*Options)) (*PutUserPolicyOutput, error) { if params == nil { params = &PutUserPolicyInput{} @@ -38,34 +46,48 @@ func (c *Client) PutUserPolicy(ctx context.Context, params *PutUserPolicyInput, type PutUserPolicyInput 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: + // 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] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the policy document. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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 - // 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 associate the policy with. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go b/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go index 993988b91fa..d4e24cb2605 100644 --- a/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go +++ b/service/iam/api_op_RemoveClientIDFromOpenIDConnectProvider.go @@ -12,8 +12,10 @@ import ( // 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. +// 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,17 +34,18 @@ 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 // 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. + // client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProvidersoperation. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_RemoveRoleFromInstanceProfile.go b/service/iam/api_op_RemoveRoleFromInstanceProfile.go index ce71bb945cd..721a438adea 100644 --- a/service/iam/api_op_RemoveRoleFromInstanceProfile.go +++ b/service/iam/api_op_RemoveRoleFromInstanceProfile.go @@ -11,14 +11,17 @@ import ( ) // Removes the specified IAM role from the specified Amazon EC2 instance profile. +// // Make sure that you do not have any Amazon EC2 instances running with the role // you are 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 roles, see IAM -// roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the -// IAM User Guide. For more information about instance profiles, see Using -// instance profiles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) -// in the IAM User Guide. +// applications running on the instance. +// +// For more information about roles, see [IAM roles] in the IAM User Guide. For more +// information about instance profiles, see [Using instance profiles]in the IAM User Guide. +// +// [Using instance profiles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html func (c *Client) RemoveRoleFromInstanceProfile(ctx context.Context, params *RemoveRoleFromInstanceProfileInput, optFns ...func(*Options)) (*RemoveRoleFromInstanceProfileOutput, error) { if params == nil { params = &RemoveRoleFromInstanceProfileInput{} @@ -36,18 +39,24 @@ 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // The name of the instance profile to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_RemoveUserFromGroup.go b/service/iam/api_op_RemoveUserFromGroup.go index ad6cd173885..0e9c2051404 100644 --- a/service/iam/api_op_RemoveUserFromGroup.go +++ b/service/iam/api_op_RemoveUserFromGroup.go @@ -28,18 +28,24 @@ 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 - // upper and lowercase alphanumeric characters with no spaces. You can also include - // any of the following characters: _+=,.@- + // The name of the group to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_ResetServiceSpecificCredential.go b/service/iam/api_op_ResetServiceSpecificCredential.go index 006f4b40405..074e801b339 100644 --- a/service/iam/api_op_ResetServiceSpecificCredential.go +++ b/service/iam/api_op_ResetServiceSpecificCredential.go @@ -32,19 +32,25 @@ 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 - // characters that can consist of any upper or lowercased letter or digit. + // The unique identifier of the service-specific credential. + // + // This parameter allows (through its [regex pattern]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServiceSpecificCredentialId *string // 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 - // consisting of upper and lowercase alphanumeric characters with no spaces. You - // can also include any of the following characters: _+=,.@- + // credentials are used to call the operation. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde @@ -53,8 +59,10 @@ type ResetServiceSpecificCredentialInput struct { type ResetServiceSpecificCredentialOutput struct { // A structure with details about the updated service-specific credential, - // including the new password. This is the only time that you can access the - // password. You cannot recover the password later, but you can reset it again. + // including the new password. + // + // This is the only time that you can access the password. You cannot recover the + // password later, but you can reset it again. ServiceSpecificCredential *types.ServiceSpecificCredential // Metadata pertaining to the operation's result. diff --git a/service/iam/api_op_ResyncMFADevice.go b/service/iam/api_op_ResyncMFADevice.go index 030061b2236..83b4272df7f 100644 --- a/service/iam/api_op_ResyncMFADevice.go +++ b/service/iam/api_op_ResyncMFADevice.go @@ -11,9 +11,12 @@ import ( ) // 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) +// Amazon Web Services servers. +// +// For more information about creating and working with virtual MFA devices, see [Using a virtual MFA device] // in the IAM User Guide. +// +// [Using a virtual MFA device]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html func (c *Client) ResyncMFADevice(ctx context.Context, params *ResyncMFADeviceInput, optFns ...func(*Options)) (*ResyncMFADeviceOutput, error) { if params == nil { params = &ResyncMFADeviceInput{} @@ -31,30 +34,38 @@ 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 - // A subsequent authentication code emitted by the device. The format for this - // parameter is a sequence of six digits. + // A subsequent authentication code emitted by the device. + // + // The format for this parameter is a sequence of six digits. // // This member is required. 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 - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // Serial number that uniquely identifies the MFA device. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the user whose MFA device you want to resynchronize. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_SetDefaultPolicyVersion.go b/service/iam/api_op_SetDefaultPolicyVersion.go index 1a1d1ab6fdb..b507755002f 100644 --- a/service/iam/api_op_SetDefaultPolicyVersion.go +++ b/service/iam/api_op_SetDefaultPolicyVersion.go @@ -11,11 +11,14 @@ 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) -// in the IAM User Guide. +// (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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, optFns ...func(*Options)) (*SetDefaultPolicyVersionOutput, error) { if params == nil { params = &SetDefaultPolicyVersionInput{} @@ -34,15 +37,21 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // in the IAM User Guide. + // The version of the policy to set as the default (operative) version. + // + // For more information about managed policy versions, see [Versioning for managed policies] in the IAM User Guide. + // + // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html // // This member is required. VersionId *string diff --git a/service/iam/api_op_SetSecurityTokenServicePreferences.go b/service/iam/api_op_SetSecurityTokenServicePreferences.go index 50e8031412c..06659d91021 100644 --- a/service/iam/api_op_SetSecurityTokenServicePreferences.go +++ b/service/iam/api_op_SetSecurityTokenServicePreferences.go @@ -12,24 +12,27 @@ 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 -// 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) -// in the IAM User Guide. To view the current session token version, see the -// GlobalEndpointTokenVersion entry in the response of the GetAccountSummary -// operation. +// 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 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]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]in the IAM User Guide. +// +// To view the current session token version, see the GlobalEndpointTokenVersion +// entry in the response of the GetAccountSummaryoperation. +// +// [Activating and deactivating STS in an Amazon Web Services Region]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html +// [Security Token Service endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/sts.html func (c *Client) SetSecurityTokenServicePreferences(ctx context.Context, params *SetSecurityTokenServicePreferencesInput, optFns ...func(*Options)) (*SetSecurityTokenServicePreferencesOutput, error) { if params == nil { params = &SetSecurityTokenServicePreferencesInput{} @@ -51,9 +54,11 @@ type SetSecurityTokenServicePreferencesInput struct { // 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. + // affect systems where you temporarily store tokens. + // + // For information, see [Activating and deactivating STS in an Amazon Web Services Region] in the IAM User Guide. + // + // [Activating and deactivating STS in an Amazon Web Services Region]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html // // This member is required. GlobalEndpointTokenVersion types.GlobalEndpointTokenVersion diff --git a/service/iam/api_op_SimulateCustomPolicy.go b/service/iam/api_op_SimulateCustomPolicy.go index 8be759b1018..3ed27da65b6 100644 --- a/service/iam/api_op_SimulateCustomPolicy.go +++ b/service/iam/api_op_SimulateCustomPolicy.go @@ -13,25 +13,33 @@ import ( // Simulate how a set of IAM policies and optionally a resource-based policy works // with a list of API operations and Amazon Web Services resources to determine the -// policies' effective permissions. The policies are provided as strings. The -// simulation does not perform the API operations; it only checks the authorization -// to determine if the simulated policies allow or deny the operations. You can -// simulate resources that don't exist in your account. If you want to simulate -// existing policies that are attached to an IAM user, group, or role, use -// SimulatePrincipalPolicy instead. Context keys are variables that are maintained -// 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 -// 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 -// 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. +// policies' effective permissions. The policies are provided as strings. +// +// The simulation does not perform the API operations; it only checks the +// authorization to determine if the simulated policies allow or deny the +// operations. You can simulate resources that don't exist in your account. +// +// If you want to simulate existing policies that are attached to an IAM user, +// group, or role, use SimulatePrincipalPolicyinstead. +// +// Context keys are variables that are maintained 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 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 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]in the IAM User +// Guide. +// +// [Testing IAM policies with the IAM policy simulator]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html func (c *Client) SimulateCustomPolicy(ctx context.Context, params *SimulateCustomPolicyInput, optFns ...func(*Options)) (*SimulateCustomPolicyOutput, error) { if params == nil { params = &SimulateCustomPolicyInput{} @@ -61,31 +69,40 @@ type SimulateCustomPolicyInput struct { // specified as a string containing the complete, valid JSON text of an IAM policy. // 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) + // be "scope-down" policies, such as you could include in a call to [GetFederationToken]or one of the [AssumeRole] // 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: + // 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]. + // + // The [regex pattern] 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 ) // + // [AssumeRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length + // [GetFederationToken]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html + // // This member is required. PolicyInputList []string // The ARN of the IAM user that you want to use as the simulated caller of the API // operations. CallerArn is required if you include a ResourcePolicy so that the - // policy's Principal element has a value to use in evaluating the policy. 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. + // policy's Principal element has a value to use in evaluating the policy. + // + // 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 *string // A list of context keys and corresponding values for the simulation to use. @@ -101,31 +118,41 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 // The IAM permissions boundary policy to simulate. The permissions boundary sets // 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) - // 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 - // parameter is a string of characters consisting of the following: + // information about permissions boundaries, see [Permissions boundaries for IAM entities]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]. + // + // The [regex pattern] 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 ) + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length + // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html PermissionsBoundaryPolicyInputList []string // A list of ARNs of Amazon Web Services resources to include in the simulation. @@ -133,15 +160,21 @@ type SimulateCustomPolicyInput struct { // 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. + // 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)] in the Amazon Web Services General + // Reference. + // + // Simulation of resource-based policies isn't supported for IAM roles. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // Specifies the type of simulation to run. Different API operations that support @@ -151,19 +184,31 @@ type SimulateCustomPolicyInput struct { // results. If your simulation does not match one of the following scenarios, then // you can omit this parameter. The following list shows each of the supported // scenario values and the resources that you must define to run the simulation. + // // Each of the Amazon EC2 scenarios requires that you specify instance, image, and // security group resources. If your scenario includes an EBS volume, then you must // specify that volume as a resource. If the Amazon 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 Amazon - // EC2 scenario 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 scenario options, see [Supported platforms]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 + // + // [Supported platforms]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html ResourceHandlingOption *string // An ARN representing the Amazon Web Services account ID that specifies the owner @@ -174,34 +219,43 @@ type SimulateCustomPolicyInput struct { // 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 - // represent the account with the 112233445566 ID, use the following ARN: - // arn:aws:iam::112233445566-ID:root . + // 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 . ResourceOwner *string // A resource-based policy to include in the simulation provided as a string. Each // resource in the simulation is treated as if it had this policy attached. You can - // 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 - // parameter is a string of characters consisting of the following: + // 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]. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length ResourcePolicy *string noSmithyDocumentSerde } -// Contains the response to a successful SimulatePrincipalPolicy or -// SimulateCustomPolicy request. +// Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request. type SimulateCustomPolicyOutput struct { // The results of the simulation. @@ -317,11 +371,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_SimulatePrincipalPolicy.go b/service/iam/api_op_SimulatePrincipalPolicy.go index 24a765c1625..466f9070a21 100644 --- a/service/iam/api_op_SimulatePrincipalPolicy.go +++ b/service/iam/api_op_SimulatePrincipalPolicy.go @@ -16,30 +16,40 @@ import ( // effective permissions. The entity can be an IAM user, group, or role. If you // specify a user, then the simulation also includes all of the policies that are // attached to groups that the user belongs to. You can simulate resources that -// don't exist in your account. You can optionally include a list of one or more -// additional policies specified as strings to include in the simulation. If you -// want to simulate only policies specified as strings, use SimulateCustomPolicy -// instead. You can also optionally include one resource-based policy to be -// evaluated with each of the resources included in the simulation for IAM users -// only. The simulation does not perform the API operations; it only checks the +// don't exist in your account. +// +// You can optionally include a list of one or more additional policies specified +// as strings to include in the simulation. If you want to simulate only policies +// specified as strings, use SimulateCustomPolicyinstead. +// +// You can also optionally include one resource-based policy to be evaluated with +// each of the resources included in the simulation for IAM users only. +// +// The simulation does not perform the API operations; it only checks the // authorization to determine if the simulated policies allow or deny the -// operations. Note: This operation discloses information about the permissions -// granted to other users. If you do not want users to see other user's -// permissions, then consider allowing them to use SimulateCustomPolicy instead. +// operations. +// +// Note: This operation discloses information about the permissions granted to +// other users. If you do not want users to see other user's permissions, then +// consider allowing them to use SimulateCustomPolicyinstead. +// // Context keys are variables maintained by Amazon Web Services and its services // 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 -// 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. +// 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 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]in the IAM User +// Guide. +// +// [Testing IAM policies with the IAM policy simulator]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html func (c *Client) SimulatePrincipalPolicy(ctx context.Context, params *SimulatePrincipalPolicyInput, optFns ...func(*Options)) (*SimulatePrincipalPolicyOutput, error) { if params == nil { params = &SimulatePrincipalPolicyInput{} @@ -68,12 +78,17 @@ type SimulatePrincipalPolicyInput struct { // 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. + // 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]. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicySourceArn *string @@ -84,14 +99,19 @@ type SimulatePrincipalPolicyInput struct { // 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 - // 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. + // 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html CallerArn *string // A list of context keys and corresponding values for the simulation to use. @@ -107,11 +127,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. MaxItems *int32 // The IAM permissions boundary policy to simulate. The permissions boundary sets @@ -121,32 +143,48 @@ 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) - // 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 - // parameter is a string of characters consisting of the following: + // permissions boundaries, see [Permissions boundaries for IAM entities]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]. + // + // The [regex pattern] 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 ) + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length + // [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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: + // of an IAM policy. + // + // The [regex pattern] 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 ) + // + // [regex pattern]: http://wikipedia.org/wiki/regex PolicyInputList []string // A list of ARNs of Amazon Web Services resources to include in the simulation. @@ -154,13 +192,18 @@ type SimulatePrincipalPolicyInput struct { // 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. + // 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)] in the Amazon Web Services General + // Reference. + // + // Simulation of resource-based policies isn't supported for IAM roles. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // Specifies the type of simulation to run. Different API operations that support @@ -170,19 +213,31 @@ type SimulatePrincipalPolicyInput struct { // results. If your simulation does not match one of the following scenarios, then // you can omit this parameter. The following list shows each of the supported // scenario values and the resources that you must define to run the simulation. + // // Each of the Amazon EC2 scenarios requires that you specify instance, image, and // security group resources. If your scenario includes an EBS volume, then you must // specify that volume as a resource. If the Amazon 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 Amazon - // EC2 scenario 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 scenario options, see [Supported platforms]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 + // + // [Supported platforms]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html ResourceHandlingOption *string // An Amazon Web Services account ID that specifies the owner of any simulated @@ -198,26 +253,34 @@ type SimulatePrincipalPolicyInput struct { // A resource-based policy to include in the simulation provided as a string. Each // resource in the simulation is treated as if it had this policy attached. You can - // 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 - // parameter is a string of characters consisting of the following: + // 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]. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [IAM and STS character quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length ResourcePolicy *string noSmithyDocumentSerde } -// Contains the response to a successful SimulatePrincipalPolicy or -// SimulateCustomPolicy request. +// Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request. type SimulatePrincipalPolicyOutput struct { // The results of the simulation. @@ -333,11 +396,13 @@ 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 - // 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 - // include in the subsequent call that tells the service where to continue from. + // 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 include in the subsequent call that tells the service where + // to continue from. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iam/api_op_TagInstanceProfile.go b/service/iam/api_op_TagInstanceProfile.go index 0541e1e72a5..13b39da9a64 100644 --- a/service/iam/api_op_TagInstanceProfile.go +++ b/service/iam/api_op_TagInstanceProfile.go @@ -12,9 +12,10 @@ import ( ) // Adds one or more tags to an IAM instance profile. If a tag with the same key -// name already exists, then that tag is overwritten with the new value. Each tag -// consists of a key name and an associated value. By assigning tags to your -// resources, you can do the following: +// name already exists, then that tag is overwritten with the new value. +// +// Each 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 @@ -24,17 +25,18 @@ import ( // - 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. +// tags to control access, see [Control access using IAM tags]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. +// For more information about tagging, see [Tagging IAM resources]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. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagInstanceProfile(ctx context.Context, params *TagInstanceProfileInput, optFns ...func(*Options)) (*TagInstanceProfileOutput, error) { if params == nil { params = &TagInstanceProfileInput{} @@ -52,10 +54,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM instance profile to which you want to add tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string diff --git a/service/iam/api_op_TagMFADevice.go b/service/iam/api_op_TagMFADevice.go index c75b8f1b217..39d788f9686 100644 --- a/service/iam/api_op_TagMFADevice.go +++ b/service/iam/api_op_TagMFADevice.go @@ -13,8 +13,10 @@ import ( // Adds one or more tags to an IAM virtual multi-factor authentication (MFA) // device. 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: +// 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 @@ -24,17 +26,18 @@ import ( // - 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. +// tags to control access, see [Control access using IAM tags]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. +// For more information about tagging, see [Tagging IAM resources]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. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagMFADevice(ctx context.Context, params *TagMFADeviceInput, optFns ...func(*Options)) (*TagMFADeviceOutput, error) { if params == nil { params = &TagMFADeviceInput{} @@ -53,10 +56,13 @@ func (c *Client) TagMFADevice(ctx context.Context, params *TagMFADeviceInput, op 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // tags. For virtual MFA devices, the serial number is the same as the ARN. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string diff --git a/service/iam/api_op_TagOpenIDConnectProvider.go b/service/iam/api_op_TagOpenIDConnectProvider.go index 34a1b177c14..f6ffc17c564 100644 --- a/service/iam/api_op_TagOpenIDConnectProvider.go +++ b/service/iam/api_op_TagOpenIDConnectProvider.go @@ -12,10 +12,11 @@ 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 -// 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: +// For more information about these providers, see [About web identity federation]. 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 @@ -25,17 +26,19 @@ import ( // - 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. +// control access, see [Control access using IAM tags]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. +// For more information about tagging, see [Tagging IAM resources]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. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html +// [About web identity federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html func (c *Client) TagOpenIDConnectProvider(ctx context.Context, params *TagOpenIDConnectProviderInput, optFns ...func(*Options)) (*TagOpenIDConnectProviderOutput, error) { if params == nil { params = &TagOpenIDConnectProviderInput{} @@ -54,10 +57,12 @@ 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: - // _+=,.@- + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_TagPolicy.go b/service/iam/api_op_TagPolicy.go index 7d4400a8ce5..e1a28180230 100644 --- a/service/iam/api_op_TagPolicy.go +++ b/service/iam/api_op_TagPolicy.go @@ -12,8 +12,9 @@ import ( ) // Adds one or more tags to an IAM customer managed policy. 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 +// 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 @@ -24,17 +25,18 @@ import ( // - 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. +// to use tags to control access, see [Control access using IAM tags]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. +// For more information about tagging, see [Tagging IAM resources]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. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagPolicy(ctx context.Context, params *TagPolicyInput, optFns ...func(*Options)) (*TagPolicyOutput, error) { if params == nil { params = &TagPolicyInput{} @@ -52,10 +54,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The ARN of the IAM customer managed policy to which you want to add tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_TagRole.go b/service/iam/api_op_TagRole.go index ef0da72b370..a218e0ee8b5 100644 --- a/service/iam/api_op_TagRole.go +++ b/service/iam/api_op_TagRole.go @@ -13,8 +13,10 @@ 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: +// 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 @@ -25,23 +27,24 @@ import ( // 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. +// tags to control access, see [Control access using IAM tags]in the IAM User Guide. // // - 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. +// For more information about tagging, see [Tagging IAM resources]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. // -// 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] in the IAM User Guide. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html +// [Tagging IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagRole(ctx context.Context, params *TagRoleInput, optFns ...func(*Options)) (*TagRoleOutput, error) { if params == nil { params = &TagRoleInput{} @@ -59,10 +62,13 @@ 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 - // characters that consist of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM role to which you want to add tags. + // + // This parameter accepts (through its [regex pattern]) a string of characters that consist of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_TagSAMLProvider.go b/service/iam/api_op_TagSAMLProvider.go index 596d9633edf..eebd7127e4b 100644 --- a/service/iam/api_op_TagSAMLProvider.go +++ b/service/iam/api_op_TagSAMLProvider.go @@ -12,11 +12,11 @@ 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 -// 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: +// provider. For more information about these providers, see [About SAML 2.0-based federation]. 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 @@ -26,17 +26,19 @@ import ( // - 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. +// tags to control access, see [Control access using IAM tags]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. +// For more information about tagging, see [Tagging IAM resources]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. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [About SAML 2.0-based federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagSAMLProvider(ctx context.Context, params *TagSAMLProviderInput, optFns ...func(*Options)) (*TagSAMLProviderOutput, error) { if params == nil { params = &TagSAMLProviderInput{} @@ -55,10 +57,12 @@ 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: - // _+=,.@- + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SAMLProviderArn *string diff --git a/service/iam/api_op_TagServerCertificate.go b/service/iam/api_op_TagServerCertificate.go index dcccb44e4ab..902bfab343a 100644 --- a/service/iam/api_op_TagServerCertificate.go +++ b/service/iam/api_op_TagServerCertificate.go @@ -12,13 +12,15 @@ import ( ) // Adds one or more tags to an IAM server certificate. If a tag with the same key -// name already exists, then that tag is overwritten with the new value. 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. A tag consists of a key name and an associated value. By -// assigning tags to your resources, you can do the following: +// name already exists, then that tag is overwritten with the new value. +// +// 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]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 @@ -28,20 +30,22 @@ import ( // - 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. +// to control access, see [Control access using IAM tags]in the IAM User Guide. // // - 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. +// For more information about tagging, see [Tagging IAM resources]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. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagServerCertificate(ctx context.Context, params *TagServerCertificateInput, optFns ...func(*Options)) (*TagServerCertificateOutput, error) { if params == nil { params = &TagServerCertificateInput{} @@ -59,10 +63,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM server certificate to which you want to add tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string diff --git a/service/iam/api_op_TagUser.go b/service/iam/api_op_TagUser.go index f33d200b19b..387aadad8e5 100644 --- a/service/iam/api_op_TagUser.go +++ b/service/iam/api_op_TagUser.go @@ -12,9 +12,10 @@ import ( ) // Adds one or more tags to an IAM user. 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: +// 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 @@ -25,23 +26,24 @@ import ( // 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. +// how to use tags to control access, see [Control access using IAM tags]in the IAM User Guide. // // - 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. +// For more information about tagging, see [Tagging IAM resources]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. // -// 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] in the IAM User Guide. +// +// [Control access using IAM tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html +// [Tagging IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) TagUser(ctx context.Context, params *TagUserInput, optFns ...func(*Options)) (*TagUserOutput, error) { if params == nil { params = &TagUserInput{} @@ -65,10 +67,13 @@ type TagUserInput struct { // 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 - // 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 to which you want to add tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_UntagInstanceProfile.go b/service/iam/api_op_UntagInstanceProfile.go index 5413b8fe97d..9086f0e7217 100644 --- a/service/iam/api_op_UntagInstanceProfile.go +++ b/service/iam/api_op_UntagInstanceProfile.go @@ -11,8 +11,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) UntagInstanceProfile(ctx context.Context, params *UntagInstanceProfileInput, optFns ...func(*Options)) (*UntagInstanceProfileOutput, error) { if params == nil { params = &UntagInstanceProfileInput{} @@ -30,10 +31,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM instance profile from which you want to remove tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. InstanceProfileName *string diff --git a/service/iam/api_op_UntagMFADevice.go b/service/iam/api_op_UntagMFADevice.go index 4d98b397cb8..60dfec2d506 100644 --- a/service/iam/api_op_UntagMFADevice.go +++ b/service/iam/api_op_UntagMFADevice.go @@ -11,8 +11,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) UntagMFADevice(ctx context.Context, params *UntagMFADeviceInput, optFns ...func(*Options)) (*UntagMFADeviceOutput, error) { if params == nil { params = &UntagMFADeviceInput{} @@ -32,10 +33,12 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SerialNumber *string diff --git a/service/iam/api_op_UntagOpenIDConnectProvider.go b/service/iam/api_op_UntagOpenIDConnectProvider.go index ed8a0fd0876..7f6cdbd03df 100644 --- a/service/iam/api_op_UntagOpenIDConnectProvider.go +++ b/service/iam/api_op_UntagOpenIDConnectProvider.go @@ -11,10 +11,11 @@ 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. +// identity provider in IAM. For more information about OIDC providers, see [About web identity federation]. For +// more information about tagging, see [Tagging IAM resources]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html +// [About web identity federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html func (c *Client) UntagOpenIDConnectProvider(ctx context.Context, params *UntagOpenIDConnectProviderInput, optFns ...func(*Options)) (*UntagOpenIDConnectProviderOutput, error) { if params == nil { params = &UntagOpenIDConnectProviderInput{} @@ -32,10 +33,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The ARN of the OIDC provider in IAM from which you want to remove tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. OpenIDConnectProviderArn *string diff --git a/service/iam/api_op_UntagPolicy.go b/service/iam/api_op_UntagPolicy.go index 7445de4b6f9..b5e86c0e667 100644 --- a/service/iam/api_op_UntagPolicy.go +++ b/service/iam/api_op_UntagPolicy.go @@ -11,8 +11,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) UntagPolicy(ctx context.Context, params *UntagPolicyInput, optFns ...func(*Options)) (*UntagPolicyOutput, error) { if params == nil { params = &UntagPolicyInput{} @@ -31,10 +32,12 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyArn *string diff --git a/service/iam/api_op_UntagRole.go b/service/iam/api_op_UntagRole.go index 9b3c6ec7d49..8a3a025f22c 100644 --- a/service/iam/api_op_UntagRole.go +++ b/service/iam/api_op_UntagRole.go @@ -11,8 +11,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) UntagRole(ctx context.Context, params *UntagRoleInput, optFns ...func(*Options)) (*UntagRoleOutput, error) { if params == nil { params = &UntagRoleInput{} @@ -30,10 +31,13 @@ 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 - // of characters that consist of upper and lowercase alphanumeric characters with - // no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM role from which you want to remove tags. + // + // This parameter accepts (through its [regex pattern]) a string of characters that consist of + // upper and lowercase alphanumeric characters with no spaces. You can also include + // any of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_UntagSAMLProvider.go b/service/iam/api_op_UntagSAMLProvider.go index 3abe5080659..218b7868455 100644 --- a/service/iam/api_op_UntagSAMLProvider.go +++ b/service/iam/api_op_UntagSAMLProvider.go @@ -12,9 +12,10 @@ import ( // 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. +// providers, see [About web identity federation]. For more information about tagging, see [Tagging IAM resources] in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html +// [About web identity federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html func (c *Client) UntagSAMLProvider(ctx context.Context, params *UntagSAMLProviderInput, optFns ...func(*Options)) (*UntagSAMLProviderOutput, error) { if params == nil { params = &UntagSAMLProviderInput{} @@ -32,11 +33,13 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SAMLProviderArn *string diff --git a/service/iam/api_op_UntagServerCertificate.go b/service/iam/api_op_UntagServerCertificate.go index 711e7abc463..07f531b9f0f 100644 --- a/service/iam/api_op_UntagServerCertificate.go +++ b/service/iam/api_op_UntagServerCertificate.go @@ -11,12 +11,15 @@ import ( ) // 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. +// information about tagging, see [Tagging IAM resources]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]in the IAM User Guide. +// +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) UntagServerCertificate(ctx context.Context, params *UntagServerCertificateInput, optFns ...func(*Options)) (*UntagServerCertificateOutput, error) { if params == nil { params = &UntagServerCertificateInput{} @@ -34,10 +37,13 @@ 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 - // with no spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM server certificate from which you want to remove tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServerCertificateName *string diff --git a/service/iam/api_op_UntagUser.go b/service/iam/api_op_UntagUser.go index 7e01dfbe65b..12cd34a95f0 100644 --- a/service/iam/api_op_UntagUser.go +++ b/service/iam/api_op_UntagUser.go @@ -11,8 +11,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html func (c *Client) UntagUser(ctx context.Context, params *UntagUserInput, optFns ...func(*Options)) (*UntagUserOutput, error) { if params == nil { params = &UntagUserInput{} @@ -36,10 +37,13 @@ type UntagUserInput struct { // This member is required. 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user from which you want to remove tags. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_UpdateAccessKey.go b/service/iam/api_op_UpdateAccessKey.go index 310a25bdd47..56df7023dee 100644 --- a/service/iam/api_op_UpdateAccessKey.go +++ b/service/iam/api_op_UpdateAccessKey.go @@ -13,15 +13,19 @@ 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 -// 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. +// 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] in the IAM User Guide. +// +// [Managing keys and certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html func (c *Client) UpdateAccessKey(ctx context.Context, params *UpdateAccessKeyInput, optFns ...func(*Options)) (*UpdateAccessKeyOutput, error) { if params == nil { params = &UpdateAccessKeyInput{} @@ -39,24 +43,30 @@ 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. + // The access key ID of the secret access key you want to update. + // + // This parameter allows (through its [regex pattern]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccessKeyId *string - // The status you want to assign to the secret access key. Active means that the + // The status you want to assign to the secret access key. Active means that the // key can be used for programmatic calls to Amazon Web Services, while Inactive // means that the key cannot be used. // // This member is required. 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 - // 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 whose key you want to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateAccountPasswordPolicy.go b/service/iam/api_op_UpdateAccountPasswordPolicy.go index 49f14b167b7..0af23ed430f 100644 --- a/service/iam/api_op_UpdateAccountPasswordPolicy.go +++ b/service/iam/api_op_UpdateAccountPasswordPolicy.go @@ -10,15 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the password policy settings for the Amazon Web Services account. This -// operation does not support partial updates. No parameters are required, but if -// you do not specify a parameter, that parameter's value reverts to its default -// value. See the Request Parameters section for each parameter's default value. -// Also note that some parameters do not allow the default parameter to be +// Updates the password policy settings for the Amazon Web Services account. +// +// This operation does not support partial updates. No parameters are required, +// but if you do not specify a parameter, that parameter's value reverts to its +// default value. See the Request Parameters section for each parameter's default +// value. 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) -// in the IAM User Guide. +// parameter when you invoke the operation. +// +// For more information about using a password policy, see [Managing an IAM password policy] in the IAM User Guide. +// +// [Managing an IAM password policy]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html func (c *Client) UpdateAccountPasswordPolicy(ctx context.Context, params *UpdateAccountPasswordPolicyInput, optFns ...func(*Options)) (*UpdateAccountPasswordPolicyOutput, error) { if params == nil { params = &UpdateAccountPasswordPolicyInput{} @@ -36,22 +39,28 @@ func (c *Client) UpdateAccountPasswordPolicy(ctx context.Context, params *Update 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) - // 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 account do not automatically have permissions to change their own password. + // 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]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 account do not + // automatically have permissions to change their own password. + // + // [Permitting IAM users to change their own passwords]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_enable-user-change.html AllowUsersToChangePassword bool - // Prevents IAM users who are accessing the account via the Amazon Web Services + // Prevents IAM users who are accessing the account via the Amazon Web Services // 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 - // 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 + // 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 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 // iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy // action. This option does not attach a permissions policy to each user, rather // the permissions are applied at the account-level for all users by IAM. IAM users @@ -59,45 +68,58 @@ type UpdateAccountPasswordPolicyInput struct { // expired console password using the CLI or API. 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 - // result is that IAM user passwords never expire. + // 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 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 . + // 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 . 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. + // 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. 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 . - // The result is that passwords do not require at least one lowercase character. + // 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 . 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. + // 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 - // character. + // 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 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 . - // The result is that passwords do not require at least one uppercase character. + // 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 . The result is that passwords do not require at least + // one uppercase character. RequireUppercaseCharacters bool noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateAssumeRolePolicy.go b/service/iam/api_op_UpdateAssumeRolePolicy.go index b1971bd0c03..b0c70dfcafa 100644 --- a/service/iam/api_op_UpdateAssumeRolePolicy.go +++ b/service/iam/api_op_UpdateAssumeRolePolicy.go @@ -12,8 +12,9 @@ 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]. +// +// [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,26 +32,37 @@ 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. + // 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: + // to IAM. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // 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 update with the new policy. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RoleName *string diff --git a/service/iam/api_op_UpdateGroup.go b/service/iam/api_op_UpdateGroup.go index 60421a3ca41..95184519b67 100644 --- a/service/iam/api_op_UpdateGroup.go +++ b/service/iam/api_op_UpdateGroup.go @@ -10,16 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// 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) -// . +// 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]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 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]. +// +// [Access management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html +// [Renaming users and groups]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error) { if params == nil { params = &UpdateGroupInput{} @@ -38,26 +42,33 @@ 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. GroupName *string - // New name for the IAM group. Only include this if changing the group'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 IAM group. Only include this if changing the group'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". 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 - // 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. + // + // This parameter allows (through its [regex pattern]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex NewPath *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateLoginProfile.go b/service/iam/api_op_UpdateLoginProfile.go index 1ff8af348c9..4a1ce513a97 100644 --- a/service/iam/api_op_UpdateLoginProfile.go +++ b/service/iam/api_op_UpdateLoginProfile.go @@ -12,10 +12,12 @@ import ( // 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. +// password for any IAM user. Use ChangePasswordto 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] in the IAM User Guide. +// +// [Managing passwords]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html func (c *Client) UpdateLoginProfile(ctx context.Context, params *UpdateLoginProfileInput, optFns ...func(*Options)) (*UpdateLoginProfileOutput, error) { if params == nil { params = &UpdateLoginProfileInput{} @@ -33,26 +35,36 @@ 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 - // 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 whose password you want to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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: + // The new password for the specified IAM user. + // + // The [regex pattern] 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 . + // information, see UpdateAccountPasswordPolicy. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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 026e2d77459..30380dda82c 100644 --- a/service/iam/api_op_UpdateOpenIDConnectProviderThumbprint.go +++ b/service/iam/api_op_UpdateOpenIDConnectProviderThumbprint.go @@ -12,20 +12,25 @@ import ( // Replaces the existing list of server certificate thumbprints associated with an // OpenID Connect (OIDC) provider resource object with a new list of thumbprints. -// The list that you pass with this operation completely replaces the existing list -// of thumbprints. (The lists are not merged.) Typically, you need to update a -// thumbprint only when the identity provider certificate changes, which occurs -// rarely. However, if the provider's certificate does change, any attempt to -// assume an IAM role that specifies the OIDC provider as a principal fails until -// the certificate thumbprint is updated. Amazon Web Services secures communication -// with some OIDC identity providers (IdPs) through our library of trusted root -// certificate authorities (CAs) instead of using a certificate thumbprint to -// verify your IdP server certificate. In these cases, your legacy thumbprint -// remains in your configuration, but is no longer used for validation. These OIDC -// IdPs include Auth0, GitHub, GitLab, Google, and those that use an Amazon S3 -// bucket to host a JSON Web Key Set (JWKS) endpoint. 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 +// +// The list that you pass with this operation completely replaces the existing +// list of thumbprints. (The lists are not merged.) +// +// Typically, you need to update a thumbprint only when the identity provider +// certificate changes, which occurs rarely. However, if the provider's certificate +// does change, any attempt to assume an IAM role that specifies the OIDC provider +// as a principal fails until the certificate thumbprint is updated. +// +// Amazon Web Services secures communication with some OIDC identity providers +// (IdPs) through our library of trusted root certificate authorities (CAs) instead +// of using a certificate thumbprint to verify your IdP server certificate. In +// these cases, your legacy thumbprint remains in your configuration, but is no +// longer used for validation. These OIDC IdPs include Auth0, GitHub, GitLab, +// Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) +// endpoint. +// +// 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. func (c *Client) UpdateOpenIDConnectProviderThumbprint(ctx context.Context, params *UpdateOpenIDConnectProviderThumbprintInput, optFns ...func(*Options)) (*UpdateOpenIDConnectProviderThumbprintOutput, error) { if params == nil { @@ -46,15 +51,18 @@ 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. + // ARNs by using the ListOpenIDConnectProvidersoperation. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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 573be1107e6..a8f0b5e07a1 100644 --- a/service/iam/api_op_UpdateRole.go +++ b/service/iam/api_op_UpdateRole.go @@ -39,17 +39,22 @@ type UpdateRoleInput struct { // 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. IAM role credentials provided by Amazon EC2 instances - // assigned to the role are not subject to the specified maximum session duration. + // 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]in the IAM User + // Guide. + // + // IAM role credentials provided by Amazon EC2 instances assigned to the role are + // not subject to the specified maximum session duration. + // + // [Using IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html MaxSessionDuration *int32 noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateRoleDescription.go b/service/iam/api_op_UpdateRoleDescription.go index 642d1b51161..7ba8add2b96 100644 --- a/service/iam/api_op_UpdateRoleDescription.go +++ b/service/iam/api_op_UpdateRoleDescription.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use UpdateRole instead. Modifies only the description of a role. This operation -// performs the same function as the Description parameter in the UpdateRole -// operation. +// Use UpdateRole instead. +// +// Modifies only the description of a role. This operation performs the same +// function as the Description parameter in the UpdateRole operation. func (c *Client) UpdateRoleDescription(ctx context.Context, params *UpdateRoleDescriptionInput, optFns ...func(*Options)) (*UpdateRoleDescriptionOutput, error) { if params == nil { params = &UpdateRoleDescriptionInput{} diff --git a/service/iam/api_op_UpdateSAMLProvider.go b/service/iam/api_op_UpdateSAMLProvider.go index b725db84191..df6ea6b12c6 100644 --- a/service/iam/api_op_UpdateSAMLProvider.go +++ b/service/iam/api_op_UpdateSAMLProvider.go @@ -11,8 +11,10 @@ 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]. +// +// [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{} @@ -39,9 +41,12 @@ type UpdateSAMLProviderInput struct { // This member is required. 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. + // The Amazon Resource Name (ARN) of the SAML provider to update. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. SAMLProviderArn *string diff --git a/service/iam/api_op_UpdateSSHPublicKey.go b/service/iam/api_op_UpdateSSHPublicKey.go index 9383e877a49..c9942c222fe 100644 --- a/service/iam/api_op_UpdateSSHPublicKey.go +++ b/service/iam/api_op_UpdateSSHPublicKey.go @@ -14,11 +14,14 @@ import ( // Sets the status of an IAM user's SSH public key to active or inactive. SSH // public keys that are inactive cannot be used for authentication. This operation // can be used to disable a user's SSH public key as part of a key rotation work -// 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) -// in the CodeCommit User Guide. +// 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]in the +// CodeCommit User Guide. +// +// [Set up CodeCommit for SSH connections]: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html func (c *Client) UpdateSSHPublicKey(ctx context.Context, params *UpdateSSHPublicKeyInput, optFns ...func(*Options)) (*UpdateSSHPublicKeyOutput, error) { if params == nil { params = &UpdateSSHPublicKeyInput{} @@ -36,9 +39,12 @@ 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]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. SSHPublicKeyId *string @@ -50,10 +56,13 @@ type UpdateSSHPublicKeyInput struct { // This member is required. 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user associated with the SSH public key. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_UpdateServerCertificate.go b/service/iam/api_op_UpdateServerCertificate.go index 6bac42727af..7e65f7070e5 100644 --- a/service/iam/api_op_UpdateServerCertificate.go +++ b/service/iam/api_op_UpdateServerCertificate.go @@ -11,20 +11,26 @@ 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) -// 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) -// 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 -// 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) +// IAM. +// +// For more information about working with server certificates, see [Working with server certificates] 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]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 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] // in the IAM User Guide. +// +// [Renaming a server certificate]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs_manage.html#RenamingServerCerts +// [Access management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html func (c *Client) UpdateServerCertificate(ctx context.Context, params *UpdateServerCertificateInput, optFns ...func(*Options)) (*UpdateServerCertificateOutput, error) { if params == nil { params = &UpdateServerCertificateInput{} @@ -42,28 +48,38 @@ 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the server certificate that you want to update. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex NewServerCertificateName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateServiceSpecificCredential.go b/service/iam/api_op_UpdateServiceSpecificCredential.go index 420188394d0..a646363c183 100644 --- a/service/iam/api_op_UpdateServiceSpecificCredential.go +++ b/service/iam/api_op_UpdateServiceSpecificCredential.go @@ -32,9 +32,12 @@ 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 - // characters that can consist of any upper or lowercased letter or digit. + // The unique identifier of the service-specific credential. + // + // This parameter allows (through its [regex pattern]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. ServiceSpecificCredentialId *string @@ -46,10 +49,13 @@ type UpdateServiceSpecificCredentialInput struct { // 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: _+=,.@- + // credentials are used to call the operation. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateSigningCertificate.go b/service/iam/api_op_UpdateSigningCertificate.go index 1d5415d4b47..b9b3acfa437 100644 --- a/service/iam/api_op_UpdateSigningCertificate.go +++ b/service/iam/api_op_UpdateSigningCertificate.go @@ -13,12 +13,14 @@ import ( // Changes the status of the specified user signing certificate from active to // disabled, or vice versa. This operation can be used to disable an IAM user's -// signing certificate as part of a certificate rotation work flow. 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. 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. +// signing certificate as part of a certificate rotation work flow. +// +// 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. 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) UpdateSigningCertificate(ctx context.Context, params *UpdateSigningCertificateInput, optFns ...func(*Options)) (*UpdateSigningCertificateOutput, error) { if params == nil { params = &UpdateSigningCertificateInput{} @@ -36,24 +38,30 @@ 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 - // characters that can consist of any upper or lowercased letter or digit. + // The ID of the signing certificate you want to update. + // + // This parameter allows (through its [regex pattern]) a string of characters that can consist of + // any upper or lowercased letter or digit. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. CertificateId *string - // The status you want to assign to the certificate. Active means that the + // The status you want to assign to the certificate. Active means that the // certificate can be used for programmatic calls to Amazon Web Services Inactive // means that the certificate cannot be used. // // This member is required. 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user the signing certificate belongs to. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/api_op_UpdateUser.go b/service/iam/api_op_UpdateUser.go index 11aeb0e6325..ba7769b9966 100644 --- a/service/iam/api_op_UpdateUser.go +++ b/service/iam/api_op_UpdateUser.go @@ -10,16 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// . +// 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]and [Renaming an IAM group] 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]. +// +// [Renaming an IAM user]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_renaming +// [Renaming an IAM group]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html +// [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{} @@ -38,26 +41,35 @@ 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: - // _+=,.@- + // the original user name. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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]) 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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". + // 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 9e6a88b675a..c7b8586a89e 100644 --- a/service/iam/api_op_UploadSSHPublicKey.go +++ b/service/iam/api_op_UploadSSHPublicKey.go @@ -11,12 +11,14 @@ 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 -// 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) -// in the CodeCommit User Guide. +// 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]in the CodeCommit User Guide. +// +// [Set up CodeCommit for SSH connections]: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html func (c *Client) UploadSSHPublicKey(ctx context.Context, params *UploadSSHPublicKeyInput, optFns ...func(*Options)) (*UploadSSHPublicKeyOutput, error) { if params == nil { params = &UploadSSHPublicKeyInput{} @@ -36,23 +38,32 @@ type UploadSSHPublicKeyInput struct { // The SSH public key. The public key must be encoded in ssh-rsa format or PEM // format. The minimum bit-length of the public key is 2048 bits. For example, you - // 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: + // can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // spaces. You can also include any of the following characters: _+=,.@- + // The name of the IAM user to associate the SSH public key with. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. UserName *string diff --git a/service/iam/api_op_UploadServerCertificate.go b/service/iam/api_op_UploadServerCertificate.go index 65206aac76a..b39672e59b7 100644 --- a/service/iam/api_op_UploadServerCertificate.go +++ b/service/iam/api_op_UploadServerCertificate.go @@ -13,26 +13,34 @@ import ( // Uploads a server certificate entity for the Amazon Web Services account. The // server certificate entity includes a public key certificate, a private key, and -// an optional certificate chain, which should all be PEM-encoded. We recommend -// that you use Certificate Manager (https://docs.aws.amazon.com/acm/) to -// 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) -// 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. +// an optional certificate chain, which should all be PEM-encoded. +// +// We recommend that you use [Certificate Manager] to 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]. +// +// For more information about working with server certificates, see [Working with server certificates] 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] 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]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]in +// the IAM User Guide. +// +// [Certificate Manager]: https://docs.aws.amazon.com/acm/ +// [Certificate Manager User Guide]: https://docs.aws.amazon.com/acm/latest/userguide/ +// [IAM and STS quotas]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html +// [Working with server certificates]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html +// [Signing Amazon Web Services API requests]: https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html +// [Calling the API by making HTTP query requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html func (c *Client) UploadServerCertificate(ctx context.Context, params *UploadServerCertificateInput, optFns ...func(*Options)) (*UploadServerCertificateOutput, error) { if params == nil { params = &UploadServerCertificateInput{} @@ -50,73 +58,101 @@ func (c *Client) UploadServerCertificate(ctx context.Context, params *UploadServ 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: + // The contents of the public key certificate in PEM-encoded format. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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: + // The contents of the private key in PEM-encoded format. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // characters consisting of upper and lowercase alphanumeric characters with no - // spaces. You can also include any of the following characters: _+=,.@- + // name of the certificate cannot contain any spaces. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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: + // PEM-encoded public key certificates of the chain. + // + // The [regex pattern] 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 ) + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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. + // The path for the server certificate. For more information about paths, see [IAM identifiers] 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]) 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/ ). + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + // [regex pattern]: http://wikipedia.org/wiki/regex 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]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 Tags []types.Tag noSmithyDocumentSerde @@ -131,8 +167,9 @@ type UploadServerCertificateOutput struct { // 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. + // see [Tagging IAM resources]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html 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 386f063547f..6dcd696a81f 100644 --- a/service/iam/api_op_UploadSigningCertificate.go +++ b/service/iam/api_op_UploadSigningCertificate.go @@ -14,21 +14,27 @@ 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) -// 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 -// 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. +// 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] 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 information about +// setting up signatures and authorization through the API, see [Signing Amazon Web Services API requests]in the Amazon Web +// Services General Reference. For general information about using the Query API +// with IAM, see [Making query requests]in the IAM User Guide. +// +// [Managing server certificates in IAM]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html +// [Making query requests]: https://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html +// [Signing Amazon Web Services API requests]: https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html func (c *Client) UploadSigningCertificate(ctx context.Context, params *UploadSigningCertificateInput, optFns ...func(*Options)) (*UploadSigningCertificateOutput, error) { if params == nil { params = &UploadSigningCertificateInput{} @@ -46,23 +52,32 @@ 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: + // The contents of the signing certificate. + // + // The [regex pattern] 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 ) // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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 - // 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 the signing certificate is for. + // + // This parameter allows (through its [regex pattern]) a string of characters consisting of upper + // and lowercase alphanumeric characters with no spaces. You can also include any + // of the following characters: _+=,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex UserName *string noSmithyDocumentSerde diff --git a/service/iam/doc.go b/service/iam/doc.go index c849c3b7d97..68383bba09f 100644 --- a/service/iam/doc.go +++ b/service/iam/doc.go @@ -3,12 +3,14 @@ // Package iam provides the API client, operations, and parameter types for AWS // Identity and Access Management. // -// Identity and Access Management Identity and Access Management (IAM) is a web -// 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/) -// . +// # Identity and Access Management +// +// Identity and Access Management (IAM) is a web 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)]and the [Identity and Access Management User Guide]. +// +// [Identity and Access Management User Guide]: https://docs.aws.amazon.com/IAM/latest/UserGuide/ +// [Identity and Access Management (IAM)]: http://aws.amazon.com/iam/ package iam diff --git a/service/iam/options.go b/service/iam/options.go index 9dc917618cf..c56ef6fed6f 100644 --- a/service/iam/options.go +++ b/service/iam/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iam/types/enums.go b/service/iam/types/enums.go index 0100b4f3d85..cc0dc2e0088 100644 --- a/service/iam/types/enums.go +++ b/service/iam/types/enums.go @@ -12,8 +12,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessAdvisorUsageGranularityType) Values() []AccessAdvisorUsageGranularityType { return []AccessAdvisorUsageGranularityType{ "SERVICE_LEVEL", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AssignmentStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignmentStatusType) Values() []AssignmentStatusType { return []AssignmentStatusType{ "Assigned", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for ContextKeyTypeEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContextKeyTypeEnum) Values() []ContextKeyTypeEnum { return []ContextKeyTypeEnum{ "string", @@ -90,8 +93,9 @@ const ( ) // Values returns all known values for DeletionTaskStatusType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeletionTaskStatusType) Values() []DeletionTaskStatusType { return []DeletionTaskStatusType{ "SUCCEEDED", @@ -110,8 +114,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -131,8 +136,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "User", @@ -153,6 +159,7 @@ const ( // Values returns all known values for GlobalEndpointTokenVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GlobalEndpointTokenVersion) Values() []GlobalEndpointTokenVersion { return []GlobalEndpointTokenVersion{ @@ -171,8 +178,9 @@ const ( ) // Values returns all known values for JobStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobStatusType) Values() []JobStatusType { return []JobStatusType{ "IN_PROGRESS", @@ -190,8 +198,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionsBoundaryAttachmentType) Values() []PermissionsBoundaryAttachmentType { return []PermissionsBoundaryAttachmentType{ "PermissionsBoundaryPolicy", @@ -209,8 +218,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyEvaluationDecisionType) Values() []PolicyEvaluationDecisionType { return []PolicyEvaluationDecisionType{ "allowed", @@ -229,8 +239,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "USER", @@ -249,8 +260,9 @@ const ( ) // Values returns all known values for PolicyScopeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyScopeType) Values() []PolicyScopeType { return []PolicyScopeType{ "All", @@ -273,8 +285,9 @@ const ( ) // Values returns all known values for PolicySourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicySourceType) Values() []PolicySourceType { return []PolicySourceType{ "user", @@ -296,8 +309,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "INLINE", @@ -314,8 +328,9 @@ const ( ) // Values returns all known values for PolicyUsageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyUsageType) Values() []PolicyUsageType { return []PolicyUsageType{ "PermissionsPolicy", @@ -331,8 +346,9 @@ const ( ) // Values returns all known values for ReportFormatType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportFormatType) Values() []ReportFormatType { return []ReportFormatType{ "text/csv", @@ -349,8 +365,9 @@ const ( ) // Values returns all known values for ReportStateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportStateType) Values() []ReportStateType { return []ReportStateType{ "STARTED", @@ -370,8 +387,9 @@ const ( ) // Values returns all known values for SortKeyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortKeyType) Values() []SortKeyType { return []SortKeyType{ "SERVICE_NAMESPACE_ASCENDING", @@ -390,8 +408,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "Active", @@ -432,8 +451,9 @@ const ( ) // Values returns all known values for SummaryKeyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SummaryKeyType) Values() []SummaryKeyType { return []SummaryKeyType{ "Users", diff --git a/service/iam/types/errors.go b/service/iam/types/errors.go index 6435f645a68..1fc1d63b947 100644 --- a/service/iam/types/errors.go +++ b/service/iam/types/errors.go @@ -35,9 +35,10 @@ 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]in the IAM User Guide. +// +// [Getting credential reports]: https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html type CredentialReportExpiredException struct { Message *string @@ -64,7 +65,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 diff --git a/service/iam/types/types.go b/service/iam/types/types.go index 5de4fb10198..a3f8b4ec4cc 100644 --- a/service/iam/types/types.go +++ b/service/iam/types/types.go @@ -10,8 +10,9 @@ import ( // An object that contains details about when a principal in the reported // Organizations entity last attempted to access an Amazon Web Services service. A // principal can be an IAM user, an IAM role, or the Amazon Web Services account -// root user within the reported Organizations entity. This data type is a response -// element in the GetOrganizationsAccessReport operation. +// root user within the reported Organizations entity. +// +// This data type is a response element in the GetOrganizationsAccessReport operation. type AccessDetail struct { // The name of the service in which access was attempted. @@ -19,38 +20,47 @@ 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) - // 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) - // in the Amazon Web Services General Reference. + // 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] 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]in the Amazon Web Services + // General Reference. + // + // [Amazon Web Services service namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces + // [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 // // This member is required. ServiceNamespace *string // The path of the Organizations entity (root, organizational unit, or account) // 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) - // . + // 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]. + // + // [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], 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]. + // + // [tracking period]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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]. + // + // [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 @@ -60,12 +70,14 @@ type AccessDetail struct { noSmithyDocumentSerde } -// 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. +// 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. type AccessKey struct { // The ID for this access key. @@ -96,39 +108,52 @@ type AccessKey struct { } // Contains information about the last time an Amazon Web Services access key was -// used since IAM began tracking this information on April 22, 2015. This data type -// is used as a response element in the GetAccessKeyLastUsed operation. +// used since IAM began tracking this information on April 22, 2015. +// +// This data type 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 date and time, in [ISO 8601 date-time format], 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. // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 + // // 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. - // 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. + // + // For more information about Amazon Web Services Regions, see [Regions and endpoints] in the Amazon Web + // Services General Reference. + // + // [Regions and endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html // // This member is required. Region *string // 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. // // This member is required. @@ -138,8 +163,9 @@ type AccessKeyLastUsed struct { } // 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. +// secret key. +// +// This data type is used as a response element in the ListAccessKeys operation. type AccessKeyMetadata struct { // The ID for this access key. @@ -158,37 +184,46 @@ type AccessKeyMetadata struct { noSmithyDocumentSerde } -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html type AttachedPermissionsBoundary struct { - // The ARN of the policy used to set the permissions boundary for the user or role. + // The ARN of the policy used to set the permissions boundary for the user or + // role. PermissionsBoundaryArn *string - // 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 . + // 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 . PermissionsBoundaryType PermissionsBoundaryAttachmentType noSmithyDocumentSerde } -// 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 -// 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) -// in the IAM User Guide. +// 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 GetAccountAuthorizationDetails +// operations. +// +// For more information about managed policies, refer to [Managed policies and inline policies] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string // The friendly name of the attached policy. @@ -200,8 +235,9 @@ type AttachedPolicy struct { // Contains information about a condition context key. It includes the name of the // 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 . +// Condition elements of the input policies. +// +// This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy. type ContextEntry struct { // The full name of a condition context key, including the service prefix. For @@ -220,8 +256,9 @@ type ContextEntry struct { noSmithyDocumentSerde } -// The reason that the service-linked role deletion failed. This data type is used -// as a response element in the GetServiceLinkedRoleDeletionStatus operation. +// The reason that the service-linked role deletion failed. +// +// This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation. type DeletionTaskFailureReasonType struct { // A short description of the reason that the service-linked role deletion failed. @@ -240,8 +277,9 @@ type DeletionTaskFailureReasonType struct { // An object that contains details about when the IAM entities (users or roles) // were last used in an attempt to access the specified Amazon Web Services -// service. This data type is a response element in the -// GetServiceLastAccessedDetailsWithEntities operation. +// service. +// +// This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation. type EntityDetails struct { // The EntityInfo object that contains details about the entity (user or role). @@ -249,24 +287,32 @@ 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], 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]. + // + // [tracking period]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -286,18 +332,18 @@ 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) + // The path to the entity (user or role). For more information about paths, see [IAM identifiers] // in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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 -// operations. +// Contains information about the reason that the operation failed. +// +// This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations. type ErrorDetails struct { // The error code associated with the operation failure. @@ -313,8 +359,9 @@ type ErrorDetails struct { noSmithyDocumentSerde } -// Contains the results of a simulation. This data type is used by the return -// parameter of SimulateCustomPolicy and SimulatePrincipalPolicy . +// Contains the results of a simulation. +// +// This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy. type EvaluationResult struct { // The name of the API operation tested on the indicated resource. @@ -330,17 +377,23 @@ type EvaluationResult struct { // Additional details about the results of the cross-account evaluation decision. // This parameter is populated for only cross-account simulations. It contains a // brief summary of how each policy type contributes to the final evaluation - // 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 + // 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]. + // + // 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. + // + // [Evaluating policies within a single account]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics EvalDecisionDetails map[string]PolicyEvaluationDecisionType // The ARN of the resource that the indicated API operation was tested on. @@ -358,8 +411,7 @@ type EvaluationResult struct { // 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 . + // discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicyor GetContextKeysForPrincipalPolicy. MissingContextValues []string // A structure that details how Organizations and its service control policies @@ -378,29 +430,36 @@ type EvaluationResult struct { noSmithyDocumentSerde } -// Contains information about an IAM group entity. This data type is used as a -// response element in the following operations: -// - CreateGroup -// - GetGroup -// - ListGroups +// Contains information about an IAM group entity. +// +// This data type is used as a response element in the following operations: +// +// # 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. + // The Amazon Resource Name (ARN) specifying the group. For more information + // about ARNs and how to use them in policies, see [IAM identifiers]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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], when the group was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // 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. + // The stable and unique string identifying the group. For more information about + // IDs, see [IAM identifiers]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. GroupId *string @@ -410,8 +469,10 @@ 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] in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. Path *string @@ -420,26 +481,31 @@ type Group struct { } // Contains information about an IAM group, including all of the group's policies. -// This data type is used as a response element in the -// GetAccountAuthorizationDetails operation. +// +// This data type is used as a response element in the GetAccountAuthorizationDetails operation. 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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], when the group was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html GroupId *string // The friendly name that identifies the group. @@ -448,24 +514,33 @@ 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] in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html Path *string noSmithyDocumentSerde } -// Contains information about an instance profile. This data type is used as a -// response element in the following operations: -// - CreateInstanceProfile -// - GetInstanceProfile -// - ListInstanceProfiles -// - ListInstanceProfilesForRole +// Contains information about an instance profile. +// +// This data type is used as a response element in the following operations: +// +// # 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. + // The Amazon Resource Name (ARN) specifying the instance profile. For more + // information about ARNs and how to use them in policies, see [IAM identifiers]in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. Arn *string @@ -475,9 +550,10 @@ type InstanceProfile struct { // This member is required. 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. + // The stable and unique string identifying the instance profile. For more + // information about IDs, see [IAM identifiers]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. InstanceProfileId *string @@ -487,9 +563,10 @@ type InstanceProfile struct { // This member is required. 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. + // The path to the instance profile. For more information about paths, see [IAM identifiers] in + // the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. Path *string @@ -500,37 +577,41 @@ 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []Tag noSmithyDocumentSerde } // Contains details about the permissions policies that are attached to the -// specified identity (user, group, or role). This data type is used as a response -// element in the ListPoliciesGrantingServiceAccess operation. +// specified identity (user, group, or role). +// +// This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation. type ListPoliciesGrantingServiceAccessEntry struct { // The PoliciesGrantingServiceAccess object that contains details about the policy. 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) - // 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) - // in the Amazon Web Services General Reference. + // 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] 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]in the Amazon Web Services + // General Reference. + // + // [Amazon Web Services service namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces + // [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 ServiceNamespace *string noSmithyDocumentSerde } -// Contains the user name and password create date for a user. This data type is -// used as a response element in the CreateLoginProfile and GetLoginProfile -// operations. +// Contains the user name and password create date for a user. +// +// This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations. type LoginProfile struct { // The date when the password for the user was created. @@ -552,30 +633,39 @@ type LoginProfile struct { // Contains information about a managed policy, including the policy's ARN, // 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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], when the policy was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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) - // in the IAM User Guide. + // (operative) version. + // + // For more information about policy versions, see [Versioning for managed policies] in the IAM User Guide. + // + // [Versioning for managed policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html DefaultVersionId *string // A friendly description of the policy. @@ -584,19 +674,26 @@ 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] in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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) - // in the IAM User Guide. + // permissions boundary. + // + // For more information about permissions boundaries, see [Permissions boundaries for IAM identities] in the IAM User Guide. + // + // [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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. + // The stable and unique string identifying the policy. + // + // For more information about IDs, see [IAM identifiers] in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html PolicyId *string // The friendly name (not ARN) identifying the policy. @@ -605,18 +702,21 @@ 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], 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. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 UpdateDate *time.Time noSmithyDocumentSerde } -// Contains information about an MFA device. This data type is used as a response -// element in the ListMFADevices operation. +// Contains information about an MFA device. +// +// This data type is used as a response element in the ListMFADevices operation. type MFADevice struct { // The date when the MFA device was enabled for the user. @@ -642,9 +742,12 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string noSmithyDocumentSerde @@ -661,8 +764,9 @@ type OrganizationsDecisionDetail struct { noSmithyDocumentSerde } -// Contains information about the account password policy. This data type is used -// as a response element in the GetAccountPasswordPolicy operation. +// Contains information about the account password policy. +// +// This data type is used as a response element in the GetAccountPasswordPolicy operation. type PasswordPolicy struct { // Specifies whether IAM users are allowed to change their own password. Gives IAM @@ -703,7 +807,9 @@ type PasswordPolicy struct { RequireNumbers bool // Specifies whether IAM user passwords must contain at least one of the following - // symbols: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' + // symbols: + // + // ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' RequireSymbols bool // Specifies whether IAM user passwords must contain at least one uppercase @@ -730,74 +836,91 @@ type PermissionsBoundaryDecisionDetail struct { noSmithyDocumentSerde } -// Contains information about a managed policy. This data type is used as a -// 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) -// in the IAM User Guide. +// Contains information about a managed policy. +// +// This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations. +// +// For more information about managed policies, refer to [Managed policies and inline policies] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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], when the policy was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 CreateDate *time.Time // The identifier for the version of the policy that is set as the default version. DefaultVersionId *string - // A friendly description of the policy. This element is included in the response - // to the GetPolicy operation. It is not included in the response to the - // ListPolicies operation. + // A friendly description of the policy. + // + // This element is included in the response to the GetPolicy operation. It is not included + // in the response to the ListPoliciesoperation. Description *string // 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] in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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) - // in the IAM User Guide. + // the permissions boundary. + // + // For more information about permissions boundaries, see [Permissions boundaries for IAM identities] in the IAM User Guide. + // + // [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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. + // The stable and unique string identifying the policy. + // + // For more information about IDs, see [IAM identifiers] in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html 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], 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. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 UpdateDate *time.Time noSmithyDocumentSerde } -// Contains information about an IAM policy, including the policy document. This -// data type is used as a response element in the GetAccountAuthorizationDetails -// operation. +// Contains information about an IAM policy, including the policy document. +// +// This data type is used as a response element in the GetAccountAuthorizationDetails operation. type PolicyDetail struct { // The policy document. @@ -810,8 +933,9 @@ type PolicyDetail struct { } // Contains details about the permissions policies that are attached to the -// specified identity (user, group, or role). This data type is an element of the -// ListPoliciesGrantingServiceAccessEntry object. +// specified identity (user, group, or role). +// +// This data type is an element of the ListPoliciesGrantingServiceAccessEntry object. type PolicyGrantingServiceAccess struct { // The policy name. @@ -819,45 +943,56 @@ type PolicyGrantingServiceAccess struct { // This member is required. 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) - // in the IAM User Guide. + // The policy type. For more information about these policy types, see [Managed policies and inline policies] in the IAM + // User Guide. + // + // [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html // // This member is required. PolicyType PolicyType // 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) - // in the IAM User Guide. + // + // This field is null for managed policies. For more information about these + // policy types, see [Managed policies and inline policies]in the IAM User Guide. + // + // [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html 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) - // in the IAM User Guide. + // 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]in the IAM User Guide. + // + // [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string noSmithyDocumentSerde } -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html GroupId *string // The name (friendly name, not ARN) identifying the group. @@ -866,16 +1001,19 @@ type PolicyGroup struct { noSmithyDocumentSerde } -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html RoleId *string // The name (friendly name, not ARN) identifying the role. @@ -884,16 +1022,19 @@ type PolicyRole struct { noSmithyDocumentSerde } -// 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) -// in the IAM User Guide. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html UserId *string // The name (friendly name, not ARN) identifying the user. @@ -902,42 +1043,50 @@ 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 -// information about managed 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. +// 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] in the IAM User Guide. +// +// [Managed policies and inline policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html 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], when the policy version was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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. + // 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 CreatePolicyVersionor ListPolicyVersions operations. + // + // The policy document returned in this structure is URL-encoded compliant with [RFC 3986]. + // 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. + // + // [RFC 3986]: https://tools.ietf.org/html/rfc3986 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 . + // 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 . VersionId *string noSmithyDocumentSerde } // Contains the row and column of a location of a Statement element in a policy -// document. This data type is used as a member of the Statement type. +// document. +// +// This data type is used as a member of the Statement type. type Position struct { // The column in the line containing the specified position in the document. @@ -950,8 +1099,9 @@ type Position struct { } // 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. +// 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 @@ -984,8 +1134,7 @@ type ResourceSpecificResult struct { // 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 . + // keys used by a set of policies, you can call GetContextKeysForCustomPolicyor GetContextKeysForPrincipalPolicy. MissingContextValues []string // Contains information about the effect that a permissions boundary has on a @@ -999,28 +1148,33 @@ type ResourceSpecificResult struct { // 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. + // The Amazon Resource Name (ARN) specifying the role. For more information about + // ARNs and how to use them in policies, see [IAM identifiers]in the IAM User Guide guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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], when the role was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // 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] in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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. + // The stable and unique string identifying the role. For more information about + // IDs, see [IAM identifiers]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. RoleId *string @@ -1041,38 +1195,44 @@ type Role struct { // optional DurationSeconds API parameter or duration-seconds CLI parameter. MaxSessionDuration *int32 - // 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) - // in the IAM User Guide. + // 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] in the IAM User Guide. + // + // [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html PermissionsBoundary *AttachedPermissionsBoundary // Contains information about the last time that an IAM role was used. This // includes the date and time and the Region in which the role was last used. // 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) - // in the IAM user Guide. + // might have been used more than 400 days ago. For more information, see [Regions where data is tracked]in the + // IAM user Guide. + // + // [Regions where data is tracked]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []Tag noSmithyDocumentSerde } // Contains information about an IAM role, including all of the role's policies. -// This data type is used as a response element in the -// GetAccountAuthorizationDetails operation. +// +// This data type is used as a response element in the GetAccountAuthorizationDetails operation. 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The trust policy that grants permission to assume the role. @@ -1082,35 +1242,41 @@ 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], when the role was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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] in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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) - // in the IAM User Guide. + // 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] in the IAM User Guide. + // + // [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html RoleId *string // Contains information about the last time that an IAM role was used. This // includes the date and time and the Region in which the role was last used. // 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) - // in the IAM User Guide. + // might have been used more than 400 days ago. For more information, see [Regions where data is tracked]in the + // IAM User Guide. + // + // [Regions where data is tracked]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period RoleLastUsed *RoleLastUsed // The friendly name that identifies the role. @@ -1121,8 +1287,9 @@ 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []Tag noSmithyDocumentSerde @@ -1132,17 +1299,22 @@ type RoleDetail struct { // includes the date and time and the Region in which the role was last used. // 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) -// in the IAM user Guide. This data type is returned as a response element in the -// GetRole and GetAccountAuthorizationDetails operations. +// might have been used more than 400 days ago. For more information, see [Regions where data is tracked]in the +// IAM user Guide. +// +// This data type is returned as a response element in the GetRole and GetAccountAuthorizationDetails operations. +// +// [Regions where data is tracked]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period 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) - // in the IAM User Guide. + // The date and time, in [ISO 8601 date-time format] 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]in the IAM User + // Guide. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 + // [Regions where data is tracked]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period LastUsedDate *time.Time // The name of the Amazon Web Services Region in which the role was last used. @@ -1152,8 +1324,9 @@ type RoleLastUsed struct { } // 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. +// 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. @@ -1180,8 +1353,9 @@ type SAMLProviderListEntry struct { noSmithyDocumentSerde } -// Contains information about a server certificate. This data type is used as a -// response element in the GetServerCertificate operation. +// Contains information about a server certificate. +// +// This data type is used as a response element in the GetServerCertificate operation. type ServerCertificate struct { // The contents of the public key certificate. @@ -1199,35 +1373,41 @@ type ServerCertificate struct { 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. + // information about tagging, see [Tagging IAM resources]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []Tag noSmithyDocumentSerde } // Contains information about a server certificate without its certificate body, -// certificate chain, and private key. This data type is used as a response element -// in the UploadServerCertificate and ListServerCertificates operations. +// certificate chain, and private key. +// +// This data type is used as a response element in the UploadServerCertificate and ListServerCertificates operations. 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. + // The Amazon Resource Name (ARN) specifying the server certificate. For more + // information about ARNs and how to use them in policies, see [IAM identifiers]in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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. + // The path to the server certificate. For more information about paths, see [IAM identifiers] in + // the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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. + // The stable and unique string identifying the server certificate. For more + // information about IDs, see [IAM identifiers]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. ServerCertificateId *string @@ -1246,9 +1426,9 @@ type ServerCertificateMetadata struct { noSmithyDocumentSerde } -// Contains details about the most recent attempt to access the service. This data -// type is used as a response element in the GetServiceLastAccessedDetails -// operation. +// Contains details about the most recent attempt to access the service. +// +// This data type is used as a response element in the GetServiceLastAccessedDetails operation. type ServiceLastAccessed struct { // The name of the service in which access was attempted. @@ -1256,52 +1436,68 @@ 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) - // 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) - // in the Amazon Web Services General Reference. + // 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] 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]in the Amazon Web Services + // General Reference. + // + // [Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces + // [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 // // 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], 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]. + // + // [tracking period]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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) - // . + // requests. + // + // This field is null if no IAM entities attempted to access the service within + // the [tracking period]. + // + // [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) - // . + // requests. + // + // This field is null if no IAM entities attempted to access the service within + // the [tracking period]. + // + // [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) - // . + // roles) that have attempted to access the service. + // + // This field is null if no principals attempted to access the service within the [tracking period]. + // + // [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 . + // 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]. 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. + // + // [tracking period]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period TrackedActionsLastAccessed []TrackedActionLastAccessed noSmithyDocumentSerde @@ -1310,8 +1506,9 @@ 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], when the service-specific credential were created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. CreateDate *time.Time @@ -1356,8 +1553,9 @@ 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], when the service-specific credential were created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. CreateDate *time.Time @@ -1391,9 +1589,9 @@ type ServiceSpecificCredentialMetadata struct { noSmithyDocumentSerde } -// Contains information about an X.509 signing certificate. This data type is used -// as a response element in the UploadSigningCertificate and -// ListSigningCertificates operations. +// Contains information about an X.509 signing certificate. +// +// This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations. type SigningCertificate struct { // The contents of the signing certificate. @@ -1423,8 +1621,9 @@ type SigningCertificate struct { noSmithyDocumentSerde } -// Contains information about an SSH public key. This data type is used as a -// response element in the GetSSHPublicKey and UploadSSHPublicKey operations. +// Contains information about an SSH public key. +// +// This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations. type SSHPublicKey struct { // The MD5 message digest of the SSH public key. @@ -1454,16 +1653,18 @@ 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], when the SSH public key was uploaded. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 UploadDate *time.Time noSmithyDocumentSerde } // Contains information about an SSH public key, without the key's body or -// fingerprint. This data type is used as a response element in the -// ListSSHPublicKeys operation. +// fingerprint. +// +// This data type is used as a response element in the ListSSHPublicKeys operation. type SSHPublicKeyMetadata struct { // The unique identifier for the SSH public key. @@ -1478,8 +1679,9 @@ type SSHPublicKeyMetadata struct { // 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], when the SSH public key was uploaded. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // This member is required. UploadDate *time.Time @@ -1493,8 +1695,9 @@ type SSHPublicKeyMetadata struct { } // 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. +// 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. @@ -1513,8 +1716,9 @@ 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]in the IAM User Guide. +// +// [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html type Tag struct { // The key name that can be used to look up or retrieve the associated value. For @@ -1528,6 +1732,7 @@ type Tag struct { // . 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. @@ -1539,8 +1744,9 @@ type Tag struct { } // Contains details about the most recent attempt to access an action within the -// service. This data type is used as a response element in the -// GetServiceLastAccessedDetails operation. +// service. +// +// This data type is used as a response element in the GetServiceLastAccessedDetails operation. type TrackedActionLastAccessed struct { // The name of the tracked action to which access was attempted. Tracked actions @@ -1548,59 +1754,78 @@ 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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) - // . + // requests. + // + // This field is null if no IAM entities attempted to access the service within + // the [tracking period]. + // + // [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], 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]. + // + // [tracking period]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#service-last-accessed-reporting-period + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 LastAccessedTime *time.Time noSmithyDocumentSerde } -// Contains information about an IAM user entity. This data type is used as a -// response element in the following operations: -// - CreateUser -// - GetUser -// - ListUsers +// Contains information about an IAM user entity. +// +// This data type is used as a response element in the following operations: +// +// # 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]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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], when the user was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 // // 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] in the IAM User + // Guide. + // + // The ARN of the policy used to set the permissions boundary for the user. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. UserId *string @@ -1610,75 +1835,91 @@ 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 date and time, in [ISO 8601 date-time format], 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]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. + // contains the date and time the most recent password was used. + // + // This value is returned only in the GetUser and ListUsers operations. + // + // [Credential reports]: https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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) - // in the IAM User Guide. + // For more information about permissions boundaries, see [Permissions boundaries for IAM identities] in the IAM User Guide. + // + // [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []Tag noSmithyDocumentSerde } // Contains information about an IAM user, including all the user's policies and -// all the IAM groups the user is in. This data type is used as a response element -// in the GetAccountAuthorizationDetails operation. +// all the IAM groups the user is in. +// +// This data type is used as a response element in the GetAccountAuthorizationDetails operation. 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)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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], when the user was created. + // + // [ISO 8601 date-time format]: http://www.iso.org/iso/iso8601 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] in the IAM User + // Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html 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) - // in the IAM User Guide. + // 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] in the IAM User Guide. + // + // [Permissions boundaries for IAM identities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html 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]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html 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]in the IAM User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html UserId *string // The friendly name identifying the user. @@ -1698,14 +1939,16 @@ type VirtualMFADevice struct { // This member is required. SerialNumber *string - // The base32 seed defined as specified in RFC3548 (https://tools.ietf.org/html/rfc3548.txt) - // . The Base32StringSeed is base32-encoded. + // The base32 seed defined as specified in [RFC3548]. The Base32StringSeed is + // base32-encoded. + // + // [RFC3548]: https://tools.ietf.org/html/rfc3548.txt Base32StringSeed []byte // The date and time on which the virtual MFA device was enabled. EnableDate *time.Time - // A QR code PNG image that encodes + // A QR code PNG image that encodes // otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where // $virtualMFADeviceName is one of the create call arguments. AccountName is the // user name if set (otherwise, the account ID otherwise), and Base32String is the @@ -1713,8 +1956,9 @@ type VirtualMFADevice struct { 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. + // information about tagging, see [Tagging IAM resources]in the IAM User Guide. + // + // [Tagging IAM resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html Tags []Tag // The IAM user associated with this virtual MFA device. diff --git a/service/identitystore/api_op_DescribeGroup.go b/service/identitystore/api_op_DescribeGroup.go index 8b94c398378..6df661e8b66 100644 --- a/service/identitystore/api_op_DescribeGroup.go +++ b/service/identitystore/api_op_DescribeGroup.go @@ -12,9 +12,11 @@ import ( ) // Retrieves the group metadata and attributes from GroupId in an identity store. +// // If you have administrator access to a member account, you can use this API from -// the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error) { if params == nil { params = &DescribeGroupInput{} diff --git a/service/identitystore/api_op_DescribeGroupMembership.go b/service/identitystore/api_op_DescribeGroupMembership.go index 8bd67722d8a..1fccfcbc682 100644 --- a/service/identitystore/api_op_DescribeGroupMembership.go +++ b/service/identitystore/api_op_DescribeGroupMembership.go @@ -12,9 +12,12 @@ import ( ) // Retrieves membership metadata and attributes from MembershipId in an identity -// store. If you have administrator access to a member account, you can use this -// API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// store. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) DescribeGroupMembership(ctx context.Context, params *DescribeGroupMembershipInput, optFns ...func(*Options)) (*DescribeGroupMembershipOutput, error) { if params == nil { params = &DescribeGroupMembershipInput{} diff --git a/service/identitystore/api_op_DescribeUser.go b/service/identitystore/api_op_DescribeUser.go index a3d68cfb51e..3dd31ce6115 100644 --- a/service/identitystore/api_op_DescribeUser.go +++ b/service/identitystore/api_op_DescribeUser.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the user metadata and attributes from the UserId in an identity -// store. If you have administrator access to a member account, you can use this -// API from the member account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// Retrieves the user metadata and attributes from the UserId in an identity store. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error) { if params == nil { params = &DescribeUserInput{} diff --git a/service/identitystore/api_op_GetGroupId.go b/service/identitystore/api_op_GetGroupId.go index 030646384d2..8731dcb93a0 100644 --- a/service/identitystore/api_op_GetGroupId.go +++ b/service/identitystore/api_op_GetGroupId.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves GroupId in an identity store. If you have administrator access to a -// member account, you can use this API from the member account. Read about member -// accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// Retrieves GroupId in an identity store. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) GetGroupId(ctx context.Context, params *GetGroupIdInput, optFns ...func(*Options)) (*GetGroupIdOutput, error) { if params == nil { params = &GetGroupIdInput{} diff --git a/service/identitystore/api_op_GetGroupMembershipId.go b/service/identitystore/api_op_GetGroupMembershipId.go index 55ff7a45186..9f706790c49 100644 --- a/service/identitystore/api_op_GetGroupMembershipId.go +++ b/service/identitystore/api_op_GetGroupMembershipId.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the MembershipId in an identity store. If you have administrator -// access to a member account, you can use this API from the member account. Read -// about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// Retrieves the MembershipId in an identity store. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) GetGroupMembershipId(ctx context.Context, params *GetGroupMembershipIdInput, optFns ...func(*Options)) (*GetGroupMembershipIdOutput, error) { if params == nil { params = &GetGroupMembershipIdInput{} diff --git a/service/identitystore/api_op_GetUserId.go b/service/identitystore/api_op_GetUserId.go index 59728e7a86d..2beab87c41d 100644 --- a/service/identitystore/api_op_GetUserId.go +++ b/service/identitystore/api_op_GetUserId.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the UserId in an identity store. If you have administrator access to -// a member account, you can use this API from the member account. Read about -// member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// Retrieves the UserId in an identity store. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) GetUserId(ctx context.Context, params *GetUserIdInput, optFns ...func(*Options)) (*GetUserIdOutput, error) { if params == nil { params = &GetUserIdInput{} diff --git a/service/identitystore/api_op_IsMemberInGroups.go b/service/identitystore/api_op_IsMemberInGroups.go index 466b33c2c6e..dc3817c4e72 100644 --- a/service/identitystore/api_op_IsMemberInGroups.go +++ b/service/identitystore/api_op_IsMemberInGroups.go @@ -12,10 +12,12 @@ import ( ) // Checks the user's membership in all requested groups and returns if the member -// exists in all queried groups. If you have administrator access to a member -// account, you can use this API from the member account. Read about member -// accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// exists in all queried groups. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) IsMemberInGroups(ctx context.Context, params *IsMemberInGroupsInput, optFns ...func(*Options)) (*IsMemberInGroupsOutput, error) { if params == nil { params = &IsMemberInGroupsInput{} diff --git a/service/identitystore/api_op_ListGroupMemberships.go b/service/identitystore/api_op_ListGroupMemberships.go index f9f7a6ef240..9ccfd321f07 100644 --- a/service/identitystore/api_op_ListGroupMemberships.go +++ b/service/identitystore/api_op_ListGroupMemberships.go @@ -12,10 +12,12 @@ import ( ) // For the specified group in the specified identity store, returns the list of -// all GroupMembership objects and returns results in paginated form. If you have -// administrator access to a member account, you can use this API from the member -// account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// all GroupMembership objects and returns results in paginated form. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) ListGroupMemberships(ctx context.Context, params *ListGroupMembershipsInput, optFns ...func(*Options)) (*ListGroupMembershipsOutput, error) { if params == nil { params = &ListGroupMembershipsInput{} diff --git a/service/identitystore/api_op_ListGroupMembershipsForMember.go b/service/identitystore/api_op_ListGroupMembershipsForMember.go index af080e06209..1dbe123ed2f 100644 --- a/service/identitystore/api_op_ListGroupMembershipsForMember.go +++ b/service/identitystore/api_op_ListGroupMembershipsForMember.go @@ -12,10 +12,12 @@ import ( ) // For the specified member in the specified identity store, returns the list of -// all GroupMembership objects and returns results in paginated form. If you have -// administrator access to a member account, you can use this API from the member -// account. Read about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// all GroupMembership objects and returns results in paginated form. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) ListGroupMembershipsForMember(ctx context.Context, params *ListGroupMembershipsForMemberInput, optFns ...func(*Options)) (*ListGroupMembershipsForMemberOutput, error) { if params == nil { params = &ListGroupMembershipsForMemberInput{} diff --git a/service/identitystore/api_op_ListGroups.go b/service/identitystore/api_op_ListGroups.go index e4273081786..477595ff77a 100644 --- a/service/identitystore/api_op_ListGroups.go +++ b/service/identitystore/api_op_ListGroups.go @@ -13,10 +13,12 @@ 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. If you have administrator -// access to a member account, you can use this API from the member account. Read -// about member accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// deprecated. Instead, use the GetGroupId API action. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { params = &ListGroupsInput{} diff --git a/service/identitystore/api_op_ListUsers.go b/service/identitystore/api_op_ListUsers.go index e8385939ad9..38a176a325d 100644 --- a/service/identitystore/api_op_ListUsers.go +++ b/service/identitystore/api_op_ListUsers.go @@ -13,10 +13,12 @@ import ( // Lists all users in the identity store. Returns a paginated list of complete User // objects. Filtering for a User by the UserName attribute is deprecated. Instead, -// use the GetUserId API action. If you have administrator access to a member -// account, you can use this API from the member account. Read about member -// accounts (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html) -// in the Organizations User Guide. +// use the GetUserId API action. +// +// If you have administrator access to a member account, you can use this API from +// the member account. Read about [member accounts]in the Organizations User Guide. +// +// [member accounts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error) { if params == nil { params = &ListUsersInput{} diff --git a/service/identitystore/doc.go b/service/identitystore/doc.go index f566fa8bc81..a1ff9b11ee4 100644 --- a/service/identitystore/doc.go +++ b/service/identitystore/doc.go @@ -5,8 +5,12 @@ // // The Identity Store service used by IAM Identity Center 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) -// . This reference guide describes the identity store operations that you can call +// the [IAM Identity Center User Guide]. +// +// This reference guide describes the identity store operations that you can call // programmatically and includes detailed information about data types and errors. +// // IAM Identity Center uses the sso and identitystore API namespaces. +// +// [IAM Identity Center User Guide]: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html package identitystore diff --git a/service/identitystore/options.go b/service/identitystore/options.go index 4d799bfbe1d..6a02c763e57 100644 --- a/service/identitystore/options.go +++ b/service/identitystore/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/identitystore/types/enums.go b/service/identitystore/types/enums.go index 4d05b274ed5..253236228d5 100644 --- a/service/identitystore/types/enums.go +++ b/service/identitystore/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "UNIQUENESS_CONSTRAINT_VIOLATION", @@ -31,8 +32,9 @@ const ( ) // 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. +// expanded in the future, and so 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 1feac67f9c8..93a69319771 100644 --- a/service/identitystore/types/errors.go +++ b/service/identitystore/types/errors.go @@ -36,8 +36,10 @@ 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. type ConflictException struct { Message *string diff --git a/service/imagebuilder/api_op_CancelImageCreation.go b/service/imagebuilder/api_op_CancelImageCreation.go index efba5111fc0..ae25b03c74a 100644 --- a/service/imagebuilder/api_op_CancelImageCreation.go +++ b/service/imagebuilder/api_op_CancelImageCreation.go @@ -30,8 +30,9 @@ 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_CancelLifecycleExecution.go b/service/imagebuilder/api_op_CancelLifecycleExecution.go index d86dce930cc..f39ee6172d8 100644 --- a/service/imagebuilder/api_op_CancelLifecycleExecution.go +++ b/service/imagebuilder/api_op_CancelLifecycleExecution.go @@ -29,8 +29,9 @@ func (c *Client) CancelLifecycleExecution(ctx context.Context, params *CancelLif type CancelLifecycleExecutionInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_CreateComponent.go b/service/imagebuilder/api_op_CreateComponent.go index 2e5a77872d3..8c5f0261ba4 100644 --- a/service/imagebuilder/api_op_CreateComponent.go +++ b/service/imagebuilder/api_op_CreateComponent.go @@ -14,7 +14,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. func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error) { @@ -35,8 +37,9 @@ func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInp type CreateComponentInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -52,14 +55,18 @@ type CreateComponentInput struct { 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 - // 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, - // or a date, such as 2021.01.01. + // 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, or a date, such as 2021.01.01. // // This member is required. SemanticVersion *string @@ -91,8 +98,10 @@ type CreateComponentInput struct { // 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. + // to your service quota. + // + // Alternatively, you can specify the YAML document inline, using the component + // data property. You cannot specify both properties. Uri *string noSmithyDocumentSerde diff --git a/service/imagebuilder/api_op_CreateContainerRecipe.go b/service/imagebuilder/api_op_CreateContainerRecipe.go index e7e65cb0264..6776994afd9 100644 --- a/service/imagebuilder/api_op_CreateContainerRecipe.go +++ b/service/imagebuilder/api_op_CreateContainerRecipe.go @@ -31,8 +31,9 @@ func (c *Client) CreateContainerRecipe(ctx context.Context, params *CreateContai type CreateContainerRecipeInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -60,14 +61,18 @@ type CreateContainerRecipeInput struct { ParentImage *string // The semantic version of the container recipe. 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, - // or a date, such as 2021.01.01. + // 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, or a date, such as 2021.01.01. // // This member is required. SemanticVersion *string diff --git a/service/imagebuilder/api_op_CreateDistributionConfiguration.go b/service/imagebuilder/api_op_CreateDistributionConfiguration.go index 978e00810ad..8059f9eae50 100644 --- a/service/imagebuilder/api_op_CreateDistributionConfiguration.go +++ b/service/imagebuilder/api_op_CreateDistributionConfiguration.go @@ -31,8 +31,9 @@ func (c *Client) CreateDistributionConfiguration(ctx context.Context, params *Cr type CreateDistributionConfigurationInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_CreateImage.go b/service/imagebuilder/api_op_CreateImage.go index dca3d2880c0..49074192ef8 100644 --- a/service/imagebuilder/api_op_CreateImage.go +++ b/service/imagebuilder/api_op_CreateImage.go @@ -33,8 +33,9 @@ func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optF type CreateImageInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_CreateImagePipeline.go b/service/imagebuilder/api_op_CreateImagePipeline.go index 5f1e67c0e1d..7be433d90ad 100644 --- a/service/imagebuilder/api_op_CreateImagePipeline.go +++ b/service/imagebuilder/api_op_CreateImagePipeline.go @@ -31,8 +31,9 @@ func (c *Client) CreateImagePipeline(ctx context.Context, params *CreateImagePip type CreateImagePipelineInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_CreateImageRecipe.go b/service/imagebuilder/api_op_CreateImageRecipe.go index 609fee32d2c..84d74969de1 100644 --- a/service/imagebuilder/api_op_CreateImageRecipe.go +++ b/service/imagebuilder/api_op_CreateImageRecipe.go @@ -31,8 +31,9 @@ func (c *Client) CreateImageRecipe(ctx context.Context, params *CreateImageRecip type CreateImageRecipeInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -59,14 +60,18 @@ type CreateImageRecipeInput struct { ParentImage *string // The semantic version of the image recipe. 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, - // or a date, such as 2021.01.01. + // 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, or a date, such as 2021.01.01. // // This member is required. SemanticVersion *string diff --git a/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go b/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go index 89b94bc5071..ea2c3973241 100644 --- a/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_CreateInfrastructureConfiguration.go @@ -31,8 +31,9 @@ func (c *Client) CreateInfrastructureConfiguration(ctx context.Context, params * type CreateInfrastructureConfigurationInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -75,10 +76,11 @@ type CreateInfrastructureConfigurationInput struct { SecurityGroupIds []string // The Amazon Resource Name (ARN) for the SNS topic to which we send image build - // event notifications. EC2 Image Builder is unable to send notifications to SNS - // topics that are encrypted using keys from other accounts. The key that is used - // to encrypt the SNS topic must reside in the account that the Image Builder - // service runs under. + // event notifications. + // + // EC2 Image Builder is unable to send notifications to SNS topics that are + // encrypted using keys from other accounts. The key that is used to encrypt the + // SNS topic must reside in the account that the Image Builder service runs under. SnsTopicArn *string // The subnet ID in which to place the instance used to customize your Amazon EC2 diff --git a/service/imagebuilder/api_op_CreateLifecyclePolicy.go b/service/imagebuilder/api_op_CreateLifecyclePolicy.go index 1b61f0bc545..a17636c7a78 100644 --- a/service/imagebuilder/api_op_CreateLifecyclePolicy.go +++ b/service/imagebuilder/api_op_CreateLifecyclePolicy.go @@ -30,8 +30,9 @@ func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecy type CreateLifecyclePolicyInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_CreateWorkflow.go b/service/imagebuilder/api_op_CreateWorkflow.go index 64301b97715..e0da2cc758f 100644 --- a/service/imagebuilder/api_op_CreateWorkflow.go +++ b/service/imagebuilder/api_op_CreateWorkflow.go @@ -30,8 +30,9 @@ func (c *Client) CreateWorkflow(ctx context.Context, params *CreateWorkflowInput type CreateWorkflowInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -42,11 +43,15 @@ type CreateWorkflowInput struct { Name *string // The semantic version of this workflow resource. The semantic version syntax - // adheres to the following rules. 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. + // adheres to the following rules. + // + // 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, or a date, such as 2021.01.01. @@ -81,8 +86,10 @@ type CreateWorkflowInput struct { // 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. + // to your service quota. + // + // Alternatively, you can specify the YAML document inline, using the component + // data property. You cannot specify both properties. Uri *string noSmithyDocumentSerde diff --git a/service/imagebuilder/api_op_DeleteImage.go b/service/imagebuilder/api_op_DeleteImage.go index d94d9277ec0..53ef9e73f63 100644 --- a/service/imagebuilder/api_op_DeleteImage.go +++ b/service/imagebuilder/api_op_DeleteImage.go @@ -14,12 +14,17 @@ 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]in the Amazon EC2 User Guide . +// +// - To deregister an EC2 Windows AMI, see [Deregister your Windows AMI]in the Amazon EC2 Windows Guide . +// +// - To delete a container image from Amazon ECR, see [Deleting an image]in the Amazon ECR User +// Guide. +// +// [Deregister your Linux AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html +// [Deregister your Windows AMI]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/deregister-ami.html +// [Deleting an image]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html 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_ImportComponent.go b/service/imagebuilder/api_op_ImportComponent.go index 05e0f645114..fc559aba5ee 100644 --- a/service/imagebuilder/api_op_ImportComponent.go +++ b/service/imagebuilder/api_op_ImportComponent.go @@ -30,8 +30,9 @@ func (c *Client) ImportComponent(ctx context.Context, params *ImportComponentInp type ImportComponentInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -52,12 +53,15 @@ type ImportComponentInput struct { 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 - // wildcard must also be wildcards. + // 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. SemanticVersion *string diff --git a/service/imagebuilder/api_op_ImportVmImage.go b/service/imagebuilder/api_op_ImportVmImage.go index b5efcb4a596..20aa50eb36c 100644 --- a/service/imagebuilder/api_op_ImportVmImage.go +++ b/service/imagebuilder/api_op_ImportVmImage.go @@ -13,12 +13,15 @@ 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) +// snapshots of your VM’s environment, settings, and data. The Amazon EC2 API [ImportImage] // 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) +// CLI command, see [import-image] +// // 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. +// +// [ImportImage]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html +// [import-image]: https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html func (c *Client) ImportVmImage(ctx context.Context, params *ImportVmImageInput, optFns ...func(*Options)) (*ImportVmImageOutput, error) { if params == nil { params = &ImportVmImageInput{} @@ -37,8 +40,9 @@ 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -54,15 +58,18 @@ type ImportVmImageInput struct { Platform types.Platform // The semantic version to attach to the base image that was created during the - // import process. 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, or a date, such as - // 2021.01.01. + // import process. 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, or a date, such as 2021.01.01. // // This member is required. SemanticVersion *string diff --git a/service/imagebuilder/api_op_ListComponentBuildVersions.go b/service/imagebuilder/api_op_ListComponentBuildVersions.go index 96fae71adcf..4cda4fdbeee 100644 --- a/service/imagebuilder/api_op_ListComponentBuildVersions.go +++ b/service/imagebuilder/api_op_ListComponentBuildVersions.go @@ -11,13 +11,15 @@ 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 f28cff8384e..77fab6bec8b 100644 --- a/service/imagebuilder/api_op_ListComponents.go +++ b/service/imagebuilder/api_op_ListComponents.go @@ -13,12 +13,15 @@ import ( // Returns the list of components that can be filtered by name, or by using the // listed filters to streamline results. Newly created components can take up to -// two minutes to appear in the ListComponents API Results. 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. +// two minutes to appear in the ListComponents API Results. +// +// 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) ListComponents(ctx context.Context, params *ListComponentsInput, optFns ...func(*Options)) (*ListComponentsOutput, error) { if params == nil { params = &ListComponentsInput{} @@ -40,11 +43,17 @@ type ListComponentsInput struct { ByName bool // Use the following filters to streamline results: + // // - description + // // - name + // // - platform + // // - supportedOsVersion + // // - type + // // - version Filters []types.Filter @@ -66,8 +75,10 @@ type ListComponentsInput struct { type ListComponentsOutput struct { - // The list of component semantic versions. The semantic version has four nodes: - // ../. You can assign values for the first three, and can filter on all of them. + // The list of component semantic versions. + // + // The semantic version has four nodes: ../. You can assign values for the first + // three, and can filter on all of them. ComponentVersionList []types.ComponentVersion // The next token used for paginated responses. When this field isn't empty, there diff --git a/service/imagebuilder/api_op_ListContainerRecipes.go b/service/imagebuilder/api_op_ListContainerRecipes.go index 98dee3e61c6..11be7e839ed 100644 --- a/service/imagebuilder/api_op_ListContainerRecipes.go +++ b/service/imagebuilder/api_op_ListContainerRecipes.go @@ -30,9 +30,13 @@ func (c *Client) ListContainerRecipes(ctx context.Context, params *ListContainer type ListContainerRecipesInput struct { // Use the following filters to streamline results: + // // - containerType + // // - name + // // - parentImage + // // - platform Filters []types.Filter diff --git a/service/imagebuilder/api_op_ListImageBuildVersions.go b/service/imagebuilder/api_op_ListImageBuildVersions.go index 2e2dbcf6760..2605bf8e2f9 100644 --- a/service/imagebuilder/api_op_ListImageBuildVersions.go +++ b/service/imagebuilder/api_op_ListImageBuildVersions.go @@ -36,10 +36,15 @@ type ListImageBuildVersionsInput struct { ImageVersionArn *string // Use the following filters to streamline results: + // // - name + // // - osVersion + // // - platform + // // - type + // // - version Filters []types.Filter diff --git a/service/imagebuilder/api_op_ListImagePipelineImages.go b/service/imagebuilder/api_op_ListImagePipelineImages.go index fe4e3d1ae6e..f16737ace32 100644 --- a/service/imagebuilder/api_op_ListImagePipelineImages.go +++ b/service/imagebuilder/api_op_ListImagePipelineImages.go @@ -36,7 +36,9 @@ type ListImagePipelineImagesInput struct { ImagePipelineArn *string // Use the following filters to streamline results: + // // - name + // // - version Filters []types.Filter diff --git a/service/imagebuilder/api_op_ListImagePipelines.go b/service/imagebuilder/api_op_ListImagePipelines.go index 43c0350ac13..2d9558d7585 100644 --- a/service/imagebuilder/api_op_ListImagePipelines.go +++ b/service/imagebuilder/api_op_ListImagePipelines.go @@ -30,11 +30,17 @@ 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 Filters []types.Filter diff --git a/service/imagebuilder/api_op_ListImageRecipes.go b/service/imagebuilder/api_op_ListImageRecipes.go index 589a954d8ff..9b34a058a35 100644 --- a/service/imagebuilder/api_op_ListImageRecipes.go +++ b/service/imagebuilder/api_op_ListImageRecipes.go @@ -30,8 +30,11 @@ func (c *Client) ListImageRecipes(ctx context.Context, params *ListImageRecipesI type ListImageRecipesInput struct { // Use the following filters to streamline results: + // // - name + // // - parentImage + // // - platform Filters []types.Filter diff --git a/service/imagebuilder/api_op_ListImageScanFindingAggregations.go b/service/imagebuilder/api_op_ListImageScanFindingAggregations.go index 4fa6c4da935..41c18962654 100644 --- a/service/imagebuilder/api_op_ListImageScanFindingAggregations.go +++ b/service/imagebuilder/api_op_ListImageScanFindingAggregations.go @@ -15,11 +15,16 @@ import ( // the type of key that Image Builder uses to group results. For example, if you // want to get a list of findings by severity level for one of your pipelines, you // 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: +// 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 func (c *Client) ListImageScanFindingAggregations(ctx context.Context, params *ListImageScanFindingAggregationsInput, optFns ...func(*Options)) (*ListImageScanFindingAggregationsOutput, error) { if params == nil { @@ -55,11 +60,17 @@ 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 . + // // 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. AggregationType *string diff --git a/service/imagebuilder/api_op_ListImageScanFindings.go b/service/imagebuilder/api_op_ListImageScanFindings.go index 604cf29ee09..798502ec970 100644 --- a/service/imagebuilder/api_op_ListImageScanFindings.go +++ b/service/imagebuilder/api_op_ListImageScanFindings.go @@ -31,10 +31,15 @@ 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. Filters []types.ImageScanFindingsFilter diff --git a/service/imagebuilder/api_op_ListImages.go b/service/imagebuilder/api_op_ListImages.go index faffe486483..4ff79054807 100644 --- a/service/imagebuilder/api_op_ListImages.go +++ b/service/imagebuilder/api_op_ListImages.go @@ -34,10 +34,15 @@ type ListImagesInput struct { ByName bool // Use the following filters to streamline results: + // // - name + // // - osVersion + // // - platform + // // - type + // // - version Filters []types.Filter @@ -62,8 +67,11 @@ type ListImagesInput struct { type ListImagesOutput struct { - // The list of image semantic versions. The semantic version has four nodes: ../. - // You can assign values for the first three, and can filter on all of them. + // The list of image semantic versions. + // + // 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 diff --git a/service/imagebuilder/api_op_ListLifecycleExecutionResources.go b/service/imagebuilder/api_op_ListLifecycleExecutionResources.go index 4bbb8655d58..fbd2a51456a 100644 --- a/service/imagebuilder/api_op_ListLifecycleExecutionResources.go +++ b/service/imagebuilder/api_op_ListLifecycleExecutionResources.go @@ -44,11 +44,12 @@ type ListLifecycleExecutionResourcesInput struct { NextToken *string // You can leave this empty to get a list of Image Builder resources that were - // identified for lifecycle actions. To get a list of associated resources that are - // impacted for an individual resource (the parent), specify its Amazon Resource - // Name (ARN). Associated resources are produced from your image and distributed - // when you run a build, such as AMIs or container images stored in ECR - // repositories. + // identified for lifecycle actions. + // + // To get a list of associated resources that are impacted for an individual + // resource (the parent), specify its Amazon Resource Name (ARN). Associated + // resources are produced from your image and distributed when you run a build, + // such as AMIs or container images stored in ECR repositories. ParentResourceId *string noSmithyDocumentSerde diff --git a/service/imagebuilder/api_op_PutComponentPolicy.go b/service/imagebuilder/api_op_PutComponentPolicy.go index a4ceb147dde..4132254c023 100644 --- a/service/imagebuilder/api_op_PutComponentPolicy.go +++ b/service/imagebuilder/api_op_PutComponentPolicy.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in order for the resource to be visible to all principals with whom the resource -// is shared. +// Applies a policy to a component. We recommend that you call the RAM API [CreateResourceShare] to +// share resources. If you call the Image Builder API PutComponentPolicy , you must +// also call the RAM API [PromoteResourceShareCreatedFromPolicy]in order for the resource to be visible to all principals +// with whom the resource is shared. +// +// [PromoteResourceShareCreatedFromPolicy]: https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html +// [CreateResourceShare]: https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html func (c *Client) PutComponentPolicy(ctx context.Context, params *PutComponentPolicyInput, optFns ...func(*Options)) (*PutComponentPolicyOutput, error) { if params == nil { params = &PutComponentPolicyInput{} diff --git a/service/imagebuilder/api_op_PutImagePolicy.go b/service/imagebuilder/api_op_PutImagePolicy.go index 50dd6ff7909..377444b657f 100644 --- a/service/imagebuilder/api_op_PutImagePolicy.go +++ b/service/imagebuilder/api_op_PutImagePolicy.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in order for the resource to be visible to all principals with whom the resource -// is shared. +// Applies a policy to an image. We recommend that you call the RAM API [CreateResourceShare] to share +// resources. If you call the Image Builder API PutImagePolicy , you must also call +// the RAM API [PromoteResourceShareCreatedFromPolicy]in order for the resource to be visible to all principals with whom +// the resource is shared. +// +// [PromoteResourceShareCreatedFromPolicy]: https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html +// [CreateResourceShare]: https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html func (c *Client) PutImagePolicy(ctx context.Context, params *PutImagePolicyInput, optFns ...func(*Options)) (*PutImagePolicyOutput, error) { if params == nil { params = &PutImagePolicyInput{} diff --git a/service/imagebuilder/api_op_PutImageRecipePolicy.go b/service/imagebuilder/api_op_PutImageRecipePolicy.go index fb1a104b424..22553fd7c6a 100644 --- a/service/imagebuilder/api_op_PutImageRecipePolicy.go +++ b/service/imagebuilder/api_op_PutImageRecipePolicy.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in order for the resource to be visible to all principals with whom the resource -// is shared. +// Applies a policy to an image recipe. We recommend that you call the RAM API [CreateResourceShare] to +// share resources. If you call the Image Builder API PutImageRecipePolicy , you +// must also call the RAM API [PromoteResourceShareCreatedFromPolicy]in order for the resource to be visible to all +// principals with whom the resource is shared. +// +// [PromoteResourceShareCreatedFromPolicy]: https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html +// [CreateResourceShare]: https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html func (c *Client) PutImageRecipePolicy(ctx context.Context, params *PutImageRecipePolicyInput, optFns ...func(*Options)) (*PutImageRecipePolicyOutput, error) { if params == nil { params = &PutImageRecipePolicyInput{} diff --git a/service/imagebuilder/api_op_SendWorkflowStepAction.go b/service/imagebuilder/api_op_SendWorkflowStepAction.go index 8dbc1852c6c..14f9f63fe20 100644 --- a/service/imagebuilder/api_op_SendWorkflowStepAction.go +++ b/service/imagebuilder/api_op_SendWorkflowStepAction.go @@ -37,8 +37,9 @@ type SendWorkflowStepActionInput struct { Action types.WorkflowStepActionType // 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_StartImagePipelineExecution.go b/service/imagebuilder/api_op_StartImagePipelineExecution.go index 021757e39bd..1d79e7cfd7a 100644 --- a/service/imagebuilder/api_op_StartImagePipelineExecution.go +++ b/service/imagebuilder/api_op_StartImagePipelineExecution.go @@ -29,8 +29,9 @@ func (c *Client) StartImagePipelineExecution(ctx context.Context, params *StartI type StartImagePipelineExecutionInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_StartResourceStateUpdate.go b/service/imagebuilder/api_op_StartResourceStateUpdate.go index 60bad5076f6..697ea04b669 100644 --- a/service/imagebuilder/api_op_StartResourceStateUpdate.go +++ b/service/imagebuilder/api_op_StartResourceStateUpdate.go @@ -32,8 +32,9 @@ func (c *Client) StartResourceStateUpdate(ctx context.Context, params *StartReso type StartResourceStateUpdateInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_UpdateDistributionConfiguration.go b/service/imagebuilder/api_op_UpdateDistributionConfiguration.go index 15f0c961f7e..02f291ed2b4 100644 --- a/service/imagebuilder/api_op_UpdateDistributionConfiguration.go +++ b/service/imagebuilder/api_op_UpdateDistributionConfiguration.go @@ -31,8 +31,9 @@ func (c *Client) UpdateDistributionConfiguration(ctx context.Context, params *Up type UpdateDistributionConfigurationInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_UpdateImagePipeline.go b/service/imagebuilder/api_op_UpdateImagePipeline.go index 6df51762e3d..6eb816d74c6 100644 --- a/service/imagebuilder/api_op_UpdateImagePipeline.go +++ b/service/imagebuilder/api_op_UpdateImagePipeline.go @@ -13,10 +13,11 @@ import ( // Updates an image pipeline. Image pipelines enable you to automate the creation // and distribution of images. You must specify exactly one recipe for your image, -// using either a containerRecipeArn or an imageRecipeArn . UpdateImagePipeline -// does not support selective updates for the pipeline. You must specify all of the -// required properties in the update request, not just the properties that have -// changed. +// using either a containerRecipeArn or an imageRecipeArn . +// +// UpdateImagePipeline does not support selective updates for the pipeline. You +// must specify all of the required properties in the update request, not just the +// properties that have changed. func (c *Client) UpdateImagePipeline(ctx context.Context, params *UpdateImagePipelineInput, optFns ...func(*Options)) (*UpdateImagePipelineOutput, error) { if params == nil { params = &UpdateImagePipelineInput{} @@ -35,8 +36,9 @@ func (c *Client) UpdateImagePipeline(ctx context.Context, params *UpdateImagePip type UpdateImagePipelineInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go b/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go index c4f589fcc54..edd0684ee6a 100644 --- a/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go +++ b/service/imagebuilder/api_op_UpdateInfrastructureConfiguration.go @@ -31,8 +31,9 @@ func (c *Client) UpdateInfrastructureConfiguration(ctx context.Context, params * type UpdateInfrastructureConfigurationInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string @@ -55,10 +56,14 @@ 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] + // - in the Amazon EC2 User Guide for Linux instances. + // + // [Configure the instance metadata options] + // - in the Amazon EC2 Windows Guide for Windows instances. + // + // [Configure the instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html InstanceMetadataOptions *types.InstanceMetadataOptions // The instance types of the infrastructure configuration. You can specify one or @@ -81,10 +86,11 @@ type UpdateInfrastructureConfigurationInput struct { SecurityGroupIds []string // The Amazon Resource Name (ARN) for the SNS topic to which we send image build - // event notifications. EC2 Image Builder is unable to send notifications to SNS - // topics that are encrypted using keys from other accounts. The key that is used - // to encrypt the SNS topic must reside in the account that the Image Builder - // service runs under. + // event notifications. + // + // EC2 Image Builder is unable to send notifications to SNS topics that are + // encrypted using keys from other accounts. The key that is used to encrypt the + // SNS topic must reside in the account that the Image Builder service runs under. SnsTopicArn *string // The subnet ID to place the instance used to customize your Amazon EC2 AMI in. diff --git a/service/imagebuilder/api_op_UpdateLifecyclePolicy.go b/service/imagebuilder/api_op_UpdateLifecyclePolicy.go index 7fda1636b04..8fa34768389 100644 --- a/service/imagebuilder/api_op_UpdateLifecyclePolicy.go +++ b/service/imagebuilder/api_op_UpdateLifecyclePolicy.go @@ -30,8 +30,9 @@ func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecy type UpdateLifecyclePolicyInput 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) - // in the Amazon EC2 API Reference. + // request. For more information, see [Ensuring idempotency]in the Amazon EC2 API Reference. + // + // [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html // // This member is required. ClientToken *string diff --git a/service/imagebuilder/options.go b/service/imagebuilder/options.go index 8d6360bb408..9aacbcdf23d 100644 --- a/service/imagebuilder/options.go +++ b/service/imagebuilder/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/imagebuilder/types/enums.go b/service/imagebuilder/types/enums.go index 97a374d82fd..c17b96d93d0 100644 --- a/service/imagebuilder/types/enums.go +++ b/service/imagebuilder/types/enums.go @@ -12,8 +12,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ComponentFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentFormat) Values() []ComponentFormat { return []ComponentFormat{ "SHELL", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for ComponentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentStatus) Values() []ComponentStatus { return []ComponentStatus{ "DEPRECATED", @@ -63,8 +66,9 @@ const ( ) // Values returns all known values for ComponentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentType) Values() []ComponentType { return []ComponentType{ "BUILD", @@ -81,6 +85,7 @@ const ( // Values returns all known values for ContainerRepositoryService. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContainerRepositoryService) Values() []ContainerRepositoryService { return []ContainerRepositoryService{ @@ -96,8 +101,9 @@ const ( ) // Values returns all known values for ContainerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerType) Values() []ContainerType { return []ContainerType{ "DOCKER", @@ -114,8 +120,9 @@ const ( ) // Values returns all known values for DiskImageFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiskImageFormat) Values() []DiskImageFormat { return []DiskImageFormat{ "VMDK", @@ -138,8 +145,9 @@ const ( ) // Values returns all known values for EbsVolumeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EbsVolumeType) Values() []EbsVolumeType { return []EbsVolumeType{ "standard", @@ -166,8 +174,9 @@ const ( ) // Values returns all known values for ImageScanStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageScanStatus) Values() []ImageScanStatus { return []ImageScanStatus{ "PENDING", @@ -191,8 +200,9 @@ const ( ) // Values returns all known values for ImageSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSource) Values() []ImageSource { return []ImageSource{ "AMAZON_MANAGED", @@ -221,8 +231,9 @@ const ( ) // Values returns all known values for ImageStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageStatus) Values() []ImageStatus { return []ImageStatus{ "PENDING", @@ -249,8 +260,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -270,8 +282,9 @@ const ( // Values returns all known values for LifecycleExecutionResourceActionName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleExecutionResourceActionName) Values() []LifecycleExecutionResourceActionName { return []LifecycleExecutionResourceActionName{ "AVAILABLE", @@ -293,8 +306,9 @@ const ( // Values returns all known values for LifecycleExecutionResourceStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleExecutionResourceStatus) Values() []LifecycleExecutionResourceStatus { return []LifecycleExecutionResourceStatus{ "FAILED", @@ -318,6 +332,7 @@ const ( // Values returns all known values for LifecycleExecutionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleExecutionStatus) Values() []LifecycleExecutionStatus { return []LifecycleExecutionStatus{ @@ -341,8 +356,9 @@ const ( // Values returns all known values for LifecyclePolicyDetailActionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyDetailActionType) Values() []LifecyclePolicyDetailActionType { return []LifecyclePolicyDetailActionType{ "DELETE", @@ -361,8 +377,9 @@ const ( // Values returns all known values for LifecyclePolicyDetailFilterType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyDetailFilterType) Values() []LifecyclePolicyDetailFilterType { return []LifecyclePolicyDetailFilterType{ "AGE", @@ -380,6 +397,7 @@ const ( // Values returns all known values for LifecyclePolicyResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyResourceType) Values() []LifecyclePolicyResourceType { return []LifecyclePolicyResourceType{ @@ -397,8 +415,9 @@ const ( ) // Values returns all known values for LifecyclePolicyStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyStatus) Values() []LifecyclePolicyStatus { return []LifecyclePolicyStatus{ "DISABLED", @@ -417,8 +436,9 @@ const ( ) // Values returns all known values for LifecyclePolicyTimeUnit. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyTimeUnit) Values() []LifecyclePolicyTimeUnit { return []LifecyclePolicyTimeUnit{ "DAYS", @@ -437,8 +457,9 @@ const ( ) // Values returns all known values for OnWorkflowFailure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnWorkflowFailure) Values() []OnWorkflowFailure { return []OnWorkflowFailure{ "CONTINUE", @@ -457,8 +478,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -478,8 +500,9 @@ const ( // Values returns all known values for PipelineExecutionStartCondition. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineExecutionStartCondition) Values() []PipelineExecutionStartCondition { return []PipelineExecutionStartCondition{ "EXPRESSION_MATCH_ONLY", @@ -496,8 +519,9 @@ const ( ) // Values returns all known values for PipelineStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineStatus) Values() []PipelineStatus { return []PipelineStatus{ "DISABLED", @@ -514,8 +538,9 @@ const ( ) // Values returns all known values for Platform. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Platform) Values() []Platform { return []Platform{ "Windows", @@ -534,8 +559,9 @@ const ( ) // Values returns all known values for ResourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStatus) Values() []ResourceStatus { return []ResourceStatus{ "AVAILABLE", @@ -560,8 +586,9 @@ const ( ) // Values returns all known values for WorkflowExecutionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowExecutionStatus) Values() []WorkflowExecutionStatus { return []WorkflowExecutionStatus{ "PENDING", @@ -583,8 +610,9 @@ const ( ) // Values returns all known values for WorkflowStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStatus) Values() []WorkflowStatus { return []WorkflowStatus{ "DEPRECATED", @@ -600,8 +628,9 @@ const ( ) // Values returns all known values for WorkflowStepActionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStepActionType) Values() []WorkflowStepActionType { return []WorkflowStepActionType{ "RESUME", @@ -621,8 +650,9 @@ const ( // Values returns all known values for WorkflowStepExecutionRollbackStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStepExecutionRollbackStatus) Values() []WorkflowStepExecutionRollbackStatus { return []WorkflowStepExecutionRollbackStatus{ "RUNNING", @@ -646,6 +676,7 @@ const ( // Values returns all known values for WorkflowStepExecutionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStepExecutionStatus) Values() []WorkflowStepExecutionStatus { return []WorkflowStepExecutionStatus{ @@ -668,8 +699,9 @@ const ( ) // 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. +// expanded in the future, and so 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 8d8aa32f2f2..d749452c5f8 100644 --- a/service/imagebuilder/types/errors.go +++ b/service/imagebuilder/types/errors.go @@ -409,8 +409,9 @@ 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]. +// +// [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 e297d432018..15ab3cbdbff 100644 --- a/service/imagebuilder/types/types.go +++ b/service/imagebuilder/types/types.go @@ -25,26 +25,35 @@ type AccountAggregation struct { // In addition to your infrastructure configuration, these settings provide an // extra layer of control over your build instances. You can also specify commands -// to run on launch for all of your build instances. Image Builder does not -// automatically install the Systems Manager agent on Windows instances. If your -// base image includes the Systems Manager agent, then the AMI that you create will -// also include the agent. For Linux instances, if the base image does not already -// include the Systems Manager agent, Image Builder installs it. For Linux -// instances where Image Builder installs the Systems Manager agent, you can choose -// whether to keep it for the AMI that you create. +// to run on launch for all of your build instances. +// +// Image Builder does not automatically install the Systems Manager agent on +// Windows instances. If your base image includes the Systems Manager agent, then +// the AMI that you create will also include the agent. For Linux instances, if the +// base image does not already include the Systems Manager agent, Image Builder +// installs it. For Linux instances where Image Builder installs the Systems +// Manager agent, you can choose whether to keep it for the AMI that you create. 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 - // 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 + // 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 UserDataOverride *string noSmithyDocumentSerde @@ -293,13 +302,17 @@ type ComponentSummary struct { // 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: + // 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 @@ -328,14 +341,19 @@ 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. - // 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. + // 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. + // // 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, or a date, such as 2021.01.01. + // // 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 @@ -379,13 +397,17 @@ type ContainerDistributionConfiguration struct { // A container recipe. 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: + // 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. Arn *string @@ -439,14 +461,19 @@ type ContainerRecipe struct { // The destination repository for the container image. TargetRepository *TargetContainerRepository - // The semantic version of the container recipe. 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 + // The semantic version of the container recipe. + // + // 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, or a date, such as 2021.01.01. + // // 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 @@ -494,8 +521,9 @@ 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) -// in the Amazon Inspector User Guide. +// severity levels, see [Severity levels for Amazon Inspector findings]in the Amazon Inspector User Guide. +// +// [Severity levels for Amazon Inspector findings]: https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html type CvssScore struct { // The CVSS base score. @@ -663,7 +691,7 @@ type EbsInstanceBlockDeviceSpecification struct { // The snapshot that defines the device contents. SnapshotId *string - // For GP3 volumes only – The throughput in MiB/s that the volume supports. + // For GP3 volumes only – The throughput in MiB/s that the volume supports. Throughput *int32 // Use to override the device's volume size. @@ -724,8 +752,10 @@ 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. +// launching an instance when faster launching is enabled. +// +// You can specify either 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. @@ -771,22 +801,29 @@ type Filter struct { // 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: + // 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. 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. BuildType BuildType @@ -864,14 +901,19 @@ 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. - // 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. + // 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. + // // 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, or a date, such as 2021.01.01. + // // 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 @@ -1209,9 +1251,12 @@ 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. BuildType BuildType @@ -1270,8 +1315,9 @@ type ImageTestsConfiguration struct { // to enable tests to run following the image build, before image distribution. ImageTestsEnabled *bool - // The maximum time in minutes that tests are permitted to run. The timeoutMinutes - // attribute is not currently active. This value is ignored. + // The maximum time in minutes that tests are permitted to run. + // + // The timeoutMinutes attribute is not currently active. This value is ignored. TimeoutMinutes *int32 noSmithyDocumentSerde @@ -1281,21 +1327,28 @@ type ImageTestsConfiguration struct { 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. 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. BuildType BuildType @@ -1324,18 +1377,23 @@ type ImageVersion struct { Type ImageType // Details for a specific version of an Image Builder image. 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, or a date, such as 2021.01.01. 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. + // 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, or a date, such as 2021.01.01. + // + // 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. Version *string noSmithyDocumentSerde @@ -1381,10 +1439,11 @@ type InfrastructureConfiguration struct { SecurityGroupIds []string // The Amazon Resource Name (ARN) for the SNS topic to which we send image build - // event notifications. EC2 Image Builder is unable to send notifications to SNS - // topics that are encrypted using keys from other accounts. The key that is used - // to encrypt the SNS topic must reside in the account that the Image Builder - // service runs under. + // event notifications. + // + // EC2 Image Builder is unable to send notifications to SNS topics that are + // encrypted using keys from other accounts. The key that is used to encrypt the + // SNS topic must reside in the account that the Image Builder service runs under. SnsTopicArn *string // The subnet ID of the infrastructure configuration. @@ -1480,10 +1539,10 @@ 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) -// 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) -// in the Amazon EC2 Windows Guide for Windows instances. +// instance metadata options, see [Configure the instance metadata options]in the Amazon EC2 User Guide for Linux +// instances, or [Configure the instance metadata options]in the Amazon EC2 Windows Guide for Windows instances. +// +// [Configure the instance metadata options]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html type InstanceMetadataOptions struct { // Limit the number of hops that an instance metadata request can traverse to @@ -1493,12 +1552,15 @@ type InstanceMetadataOptions struct { // 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. + // // The default setting is optional. HttpTokens *string @@ -1506,22 +1568,24 @@ 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) -// 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) -// . +// modification request is sent to the [Amazon EC2 ModifyImageAttribute]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]. +// +// [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?]. + // + // [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) - // . + // your AMI with. For more information about key concepts for Organizations, see [Organizations terminology and concepts]. + // + // [Organizations terminology and concepts]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html OrganizationalUnitArns []string // The name of the group. @@ -1599,8 +1663,11 @@ type LifecycleExecutionResource struct { // Identifies the impacted resource. The resource ID depends on the type of // resource, as follows. + // // - Image Builder image resources: Amazon Resource Name (ARN) + // // - Distributed AMIs: AMI ID + // // - Container images distributed to an ECR repository: image URI or SHA Digest ResourceId *string @@ -1840,9 +1907,11 @@ type LifecyclePolicyDetailFilter struct { Type LifecyclePolicyDetailFilterType // The number of units for the time period or for the count. For example, a value - // of 6 might refer to six months or six AMIs. For count-based filters, this value - // represents the minimum number of resources to keep on hand. If you have fewer - // resources than this number, the resource is excluded from lifecycle actions. + // of 6 might refer to six months or six AMIs. + // + // For count-based filters, this value represents the minimum number of resources + // to keep on hand. If you have fewer resources than this number, the resource is + // excluded from lifecycle actions. // // This member is required. Value *int32 @@ -2059,10 +2128,13 @@ type ResourceStateUpdateIncludeResources struct { 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. // // This member is required. @@ -2109,20 +2181,24 @@ type Schedule struct { // 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 - // expression matches the current time. For semantic version syntax, see - // CreateComponent (https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) - // in the EC2 Image Builder API Reference. + // expression matches the current time. For semantic version syntax, see [CreateComponent]in the + // EC2 Image Builder API Reference. + // + // [CreateComponent]: https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html 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]. + // + // [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]. If not specified this defaults to UTC. + // + // [IANA timezone format]: https://www.joda.org/joda-time/timezones.html Timezone *string noSmithyDocumentSerde diff --git a/service/inspector/api_op_CreateAssessmentTarget.go b/service/inspector/api_op_CreateAssessmentTarget.go index 8a273aa1416..5358a46d031 100644 --- a/service/inspector/api_op_CreateAssessmentTarget.go +++ b/service/inspector/api_op_CreateAssessmentTarget.go @@ -11,15 +11,16 @@ 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 -// 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) +// 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] // 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]. +// +// [Amazon Inspector Assessment Targets]: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html +// [service-linked role]: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.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 e33788bfd00..d418ed6ac73 100644 --- a/service/inspector/api_op_CreateAssessmentTemplate.go +++ b/service/inspector/api_op_CreateAssessmentTemplate.go @@ -12,10 +12,11 @@ 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) -// 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. +// the ARN of the assessment target. If the [service-linked role]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. +// +// [service-linked role]: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html func (c *Client) CreateAssessmentTemplate(ctx context.Context, params *CreateAssessmentTemplateInput, optFns ...func(*Options)) (*CreateAssessmentTemplateOutput, error) { if params == nil { params = &CreateAssessmentTemplateInput{} @@ -60,8 +61,8 @@ type CreateAssessmentTemplateInput struct { // 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. + // is a key and value pair (an Attributeobject). Within an assessment template, each key + // must be unique. UserAttributesForFindings []types.Attribute noSmithyDocumentSerde diff --git a/service/inspector/api_op_CreateResourceGroup.go b/service/inspector/api_op_CreateResourceGroup.go index ec41dd7b17b..cd9953ac368 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{} @@ -34,6 +34,7 @@ type CreateResourceGroupInput struct { // A collection of keys and an array of possible values, // '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Value3"]}]'. + // // For example,'[{"key":"Name","values":["TestEC2Instance"]}]'. // // This member is required. diff --git a/service/inspector/api_op_GetAssessmentReport.go b/service/inspector/api_op_GetAssessmentReport.go index 3904616244d..52896e7f9c5 100644 --- a/service/inspector/api_op_GetAssessmentReport.go +++ b/service/inspector/api_op_GetAssessmentReport.go @@ -44,8 +44,9 @@ type GetAssessmentReportInput struct { // 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) - // . + // more information, see [Assessment Reports]. + // + // [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 a180465af44..dbf98feb143 100644 --- a/service/inspector/api_op_ListAssessmentRunAgents.go +++ b/service/inspector/api_op_ListAssessmentRunAgents.go @@ -36,9 +36,11 @@ type ListAssessmentRunAgentsInput struct { AssessmentRunArn *string // You can use this parameter to specify a subset of data to be included in the - // action's response. For a record to match a filter, all specified filter - // attributes must match. When multiple values are specified for a filter - // attribute, any of the values can match. + // action's response. + // + // For a record to match a filter, all specified filter attributes must match. + // When multiple values are specified for a filter attribute, any of the values can + // match. Filter *types.AgentFilter // You can use this parameter to indicate the maximum number of items that you @@ -61,7 +63,7 @@ type ListAssessmentRunAgentsOutput struct { // This member is required. AssessmentRunAgents []types.AssessmentRunAgent - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_ListAssessmentRuns.go b/service/inspector/api_op_ListAssessmentRuns.go index 3f868780557..4326b72fec2 100644 --- a/service/inspector/api_op_ListAssessmentRuns.go +++ b/service/inspector/api_op_ListAssessmentRuns.go @@ -35,9 +35,11 @@ type ListAssessmentRunsInput struct { AssessmentTemplateArns []string // You can use this parameter to specify a subset of data to be included in the - // action's response. For a record to match a filter, all specified filter - // attributes must match. When multiple values are specified for a filter - // attribute, any of the values can match. + // action's response. + // + // For a record to match a filter, all specified filter attributes must match. + // When multiple values are specified for a filter attribute, any of the values can + // match. Filter *types.AssessmentRunFilter // You can use this parameter to indicate the maximum number of items that you @@ -61,7 +63,7 @@ type ListAssessmentRunsOutput struct { // This member is required. AssessmentRunArns []string - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_ListAssessmentTargets.go b/service/inspector/api_op_ListAssessmentTargets.go index ff509a025eb..963dc9ab6f4 100644 --- a/service/inspector/api_op_ListAssessmentTargets.go +++ b/service/inspector/api_op_ListAssessmentTargets.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -32,9 +33,11 @@ func (c *Client) ListAssessmentTargets(ctx context.Context, params *ListAssessme type ListAssessmentTargetsInput struct { // You can use this parameter to specify a subset of data to be included in the - // action's response. For a record to match a filter, all specified filter - // attributes must match. When multiple values are specified for a filter - // attribute, any of the values can match. + // action's response. + // + // For a record to match a filter, all specified filter attributes must match. + // When multiple values are specified for a filter attribute, any of the values can + // match. Filter *types.AssessmentTargetFilter // You can use this parameter to indicate the maximum number of items you want in @@ -58,7 +61,7 @@ type ListAssessmentTargetsOutput struct { // This member is required. AssessmentTargetArns []string - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_ListAssessmentTemplates.go b/service/inspector/api_op_ListAssessmentTemplates.go index 37818e2c5b9..ebbbad6b639 100644 --- a/service/inspector/api_op_ListAssessmentTemplates.go +++ b/service/inspector/api_op_ListAssessmentTemplates.go @@ -35,9 +35,11 @@ type ListAssessmentTemplatesInput struct { AssessmentTargetArns []string // You can use this parameter to specify a subset of data to be included in the - // action's response. For a record to match a filter, all specified filter - // attributes must match. When multiple values are specified for a filter - // attribute, any of the values can match. + // action's response. + // + // For a record to match a filter, all specified filter attributes must match. + // When multiple values are specified for a filter attribute, any of the values can + // match. Filter *types.AssessmentTemplateFilter // You can use this parameter to indicate the maximum number of items you want in @@ -60,7 +62,7 @@ type ListAssessmentTemplatesOutput struct { // This member is required. AssessmentTemplateArns []string - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_ListEventSubscriptions.go b/service/inspector/api_op_ListEventSubscriptions.go index c29fb990b45..f47cbcc745a 100644 --- a/service/inspector/api_op_ListEventSubscriptions.go +++ b/service/inspector/api_op_ListEventSubscriptions.go @@ -12,8 +12,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 . +// by the ARN of the assessment template. For more information, see SubscribeToEventand UnsubscribeFromEvent. func (c *Client) ListEventSubscriptions(ctx context.Context, params *ListEventSubscriptionsInput, optFns ...func(*Options)) (*ListEventSubscriptionsOutput, error) { if params == nil { params = &ListEventSubscriptionsInput{} @@ -55,7 +54,7 @@ type ListEventSubscriptionsOutput struct { // This member is required. Subscriptions []types.Subscription - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_ListFindings.go b/service/inspector/api_op_ListFindings.go index 55ebd99292d..94199d6df52 100644 --- a/service/inspector/api_op_ListFindings.go +++ b/service/inspector/api_op_ListFindings.go @@ -35,9 +35,11 @@ type ListFindingsInput struct { AssessmentRunArns []string // You can use this parameter to specify a subset of data to be included in the - // action's response. For a record to match a filter, all specified filter - // attributes must match. When multiple values are specified for a filter - // attribute, any of the values can match. + // action's response. + // + // For a record to match a filter, all specified filter attributes must match. + // When multiple values are specified for a filter attribute, any of the values can + // match. Filter *types.FindingFilter // You can use this parameter to indicate the maximum number of items you want in @@ -60,7 +62,7 @@ type ListFindingsOutput struct { // This member is required. FindingArns []string - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_ListRulesPackages.go b/service/inspector/api_op_ListRulesPackages.go index d1ca909249d..1d124ea4991 100644 --- a/service/inspector/api_op_ListRulesPackages.go +++ b/service/inspector/api_op_ListRulesPackages.go @@ -48,7 +48,7 @@ type ListRulesPackagesOutput struct { // This member is required. RulesPackageArns []string - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_PreviewAgents.go b/service/inspector/api_op_PreviewAgents.go index 51f3a342bb5..9684399ae9c 100644 --- a/service/inspector/api_op_PreviewAgents.go +++ b/service/inspector/api_op_PreviewAgents.go @@ -55,7 +55,7 @@ type PreviewAgentsOutput struct { // This member is required. AgentPreviews []types.AgentPreview - // When a response is generated, if there is more data to be listed, this + // 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. diff --git a/service/inspector/api_op_UpdateAssessmentTarget.go b/service/inspector/api_op_UpdateAssessmentTarget.go index 37021967b1d..9f118efa8ed 100644 --- a/service/inspector/api_op_UpdateAssessmentTarget.go +++ b/service/inspector/api_op_UpdateAssessmentTarget.go @@ -11,8 +11,10 @@ import ( ) // Updates the assessment target that is specified by the ARN of the assessment -// target. If resourceGroupArn is not specified, all EC2 instances in the current -// AWS account and region are included in the assessment target. +// target. +// +// If resourceGroupArn is not specified, all EC2 instances in the current AWS +// account and region are included in the assessment target. func (c *Client) UpdateAssessmentTarget(ctx context.Context, params *UpdateAssessmentTargetInput, optFns ...func(*Options)) (*UpdateAssessmentTargetOutput, error) { if params == nil { params = &UpdateAssessmentTargetInput{} diff --git a/service/inspector/doc.go b/service/inspector/doc.go index 6f30b22125c..46f320e241f 100644 --- a/service/inspector/doc.go +++ b/service/inspector/doc.go @@ -3,8 +3,10 @@ // Package inspector provides the API client, operations, and parameter types for // Amazon Inspector. // -// 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) -// . +// # 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]. +// +// [Amazon Inspector User Guide]: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_introduction.html package inspector diff --git a/service/inspector/options.go b/service/inspector/options.go index 61d1610916f..195c17fe2d2 100644 --- a/service/inspector/options.go +++ b/service/inspector/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/inspector/types/enums.go b/service/inspector/types/enums.go index 3cceab70b2e..3f176f32e74 100644 --- a/service/inspector/types/enums.go +++ b/service/inspector/types/enums.go @@ -17,8 +17,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACCESS_DENIED_TO_ASSESSMENT_TARGET", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for AgentHealth. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentHealth) Values() []AgentHealth { return []AgentHealth{ "HEALTHY", @@ -65,8 +67,9 @@ const ( ) // Values returns all known values for AgentHealthCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgentHealthCode) Values() []AgentHealthCode { return []AgentHealthCode{ "IDLE", @@ -90,8 +93,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentRunNotificationSnsStatusCode) Values() []AssessmentRunNotificationSnsStatusCode { return []AssessmentRunNotificationSnsStatusCode{ "SUCCESS", @@ -121,8 +125,9 @@ const ( ) // Values returns all known values for AssessmentRunState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentRunState) Values() []AssessmentRunState { return []AssessmentRunState{ "CREATED", @@ -149,8 +154,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -170,8 +176,9 @@ const ( ) // Values returns all known values for FailedItemErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailedItemErrorCode) Values() []FailedItemErrorCode { return []FailedItemErrorCode{ "INVALID_ARN", @@ -195,8 +202,9 @@ const ( ) // Values returns all known values for InspectorEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InspectorEvent) Values() []InspectorEvent { return []InspectorEvent{ "ASSESSMENT_RUN_STARTED", @@ -217,8 +225,9 @@ const ( // Values returns all known values for InvalidCrossAccountRoleErrorCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvalidCrossAccountRoleErrorCode) Values() []InvalidCrossAccountRoleErrorCode { return []InvalidCrossAccountRoleErrorCode{ "ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP", @@ -287,8 +296,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INVALID_ASSESSMENT_TARGET_ARN", @@ -360,8 +370,9 @@ const ( ) // Values returns all known values for LimitExceededErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LimitExceededErrorCode) Values() []LimitExceededErrorCode { return []LimitExceededErrorCode{ "ASSESSMENT_TARGET_LIMIT_EXCEEDED", @@ -380,8 +391,9 @@ const ( ) // Values returns all known values for Locale. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Locale) Values() []Locale { return []Locale{ "EN_US", @@ -403,8 +415,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ASSESSMENT_TARGET_DOES_NOT_EXIST", @@ -427,8 +440,9 @@ const ( ) // Values returns all known values for PreviewStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PreviewStatus) Values() []PreviewStatus { return []PreviewStatus{ "WORK_IN_PROGRESS", @@ -445,8 +459,9 @@ const ( ) // Values returns all known values for ReportFileFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportFileFormat) Values() []ReportFileFormat { return []ReportFileFormat{ "HTML", @@ -464,8 +479,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -483,8 +499,9 @@ const ( ) // Values returns all known values for ReportType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportType) Values() []ReportType { return []ReportType{ "FINDING", @@ -501,8 +518,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -522,8 +540,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "Low", @@ -543,8 +562,9 @@ const ( ) // Values returns all known values for StopAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StopAction) Values() []StopAction { return []StopAction{ "START_EVALUATION", diff --git a/service/inspector/types/errors.go b/service/inspector/types/errors.go index 2d6166f2f9f..48cc0dbeebf 100644 --- a/service/inspector/types/errors.go +++ b/service/inspector/types/errors.go @@ -307,11 +307,11 @@ func (e *ServiceTemporarilyUnavailableException) ErrorFault() smithy.ErrorFault return smithy.FaultServer } -// Used by the GetAssessmentReport API. The request was rejected because you tried -// to generate a report for an assessment run that existed before reporting was -// supported in Amazon Inspector. You can only generate reports for assessment runs -// that took place or will take place after generating reports in Amazon Inspector -// became available. +// Used by the GetAssessmentReport API. The request was rejected because you tried to generate a +// report for an assessment run that existed before reporting was supported in +// Amazon Inspector. You can only generate reports for assessment runs that took +// place or will take place after generating reports in Amazon Inspector became +// available. type UnsupportedFeatureException struct { Message *string diff --git a/service/inspector/types/types.go b/service/inspector/types/types.go index ff9c421b74a..b31a2633873 100644 --- a/service/inspector/types/types.go +++ b/service/inspector/types/types.go @@ -27,7 +27,7 @@ type AgentAlreadyRunningAssessment struct { } // Contains information about an Amazon Inspector agent. This data type is used as -// a request parameter in the ListAssessmentRunAgents action. +// a request parameter in the ListAssessmentRunAgentsaction. type AgentFilter struct { // The detailed health state of the agent. Values can be set to IDLE, RUNNING, @@ -82,8 +82,9 @@ type AgentPreview struct { } // A snapshot of an Amazon Inspector assessment run that contains the findings of -// the assessment run . Used as the response element in the DescribeAssessmentRuns -// action. +// the assessment run . +// +// Used as the response element in the DescribeAssessmentRuns action. type AssessmentRun struct { // The ARN of the assessment run. @@ -164,7 +165,7 @@ type AssessmentRun struct { } // Contains information about an Amazon Inspector agent. This data type is used as -// a response element in the ListAssessmentRunAgents action. +// a response element in the ListAssessmentRunAgentsaction. type AssessmentRunAgent struct { // The current health state of the agent. @@ -206,36 +207,36 @@ type AssessmentRunFilter struct { // For a record to match a filter, the value that is specified for this data type // property must inclusively match any value between the specified minimum and - // maximum values of the completedAt property of the AssessmentRun data type. + // maximum values of the completedAt property of the AssessmentRundata type. CompletionTimeRange *TimestampRange // For a record to match a filter, the value that is specified for this data type // property must inclusively match any value between the specified minimum and - // maximum values of the durationInSeconds property of the AssessmentRun data type. + // maximum values of the durationInSeconds property of the AssessmentRundata type. DurationRange *DurationRange // For a record to match a filter, an explicit value or a string containing a // wildcard that is specified for this data type property must match the value of - // the assessmentRunName property of the AssessmentRun data type. + // the assessmentRunName property of the AssessmentRundata type. NamePattern *string // For a record to match a filter, the value that is specified for this data type // property must be contained in the list of values of the rulesPackages property - // of the AssessmentRun data type. + // of the AssessmentRundata type. RulesPackageArns []string // For a record to match a filter, the value that is specified for this data type // property must inclusively match any value between the specified minimum and - // maximum values of the startTime property of the AssessmentRun data type. + // maximum values of the startTime property of the AssessmentRundata type. StartTimeRange *TimestampRange // For a record to match a filter, the value that is specified for this data type - // property must match the stateChangedAt property of the AssessmentRun data type. + // property must match the stateChangedAt property of the AssessmentRundata type. StateChangeTimeRange *TimestampRange // For a record to match a filter, one of the values specified for this data type // property must be the exact match of the value of the assessmentRunState property - // of the AssessmentRun data type. + // of the AssessmentRundata type. States []AssessmentRunState noSmithyDocumentSerde @@ -288,7 +289,7 @@ type AssessmentRunStateChange struct { } // Contains information about an Amazon Inspector application. This data type is -// used as the response element in the DescribeAssessmentTargets action. +// used as the response element in the DescribeAssessmentTargetsaction. type AssessmentTarget struct { // The ARN that specifies the Amazon Inspector assessment target. @@ -323,14 +324,14 @@ type AssessmentTargetFilter struct { // For a record to match a filter, an explicit value or a string that contains a // wildcard that is specified for this data type property must match the value of - // the assessmentTargetName property of the AssessmentTarget data type. + // the assessmentTargetName property of the AssessmentTargetdata type. AssessmentTargetNamePattern *string noSmithyDocumentSerde } // Contains information about an Amazon Inspector assessment template. This data -// type is used as the response element in the DescribeAssessmentTemplates action. +// type is used as the response element in the DescribeAssessmentTemplatesaction. type AssessmentTemplate struct { // The ARN of the assessment template. @@ -389,17 +390,17 @@ type AssessmentTemplateFilter struct { // For a record to match a filter, the value specified for this data type property // must inclusively match any value between the specified minimum and maximum - // values of the durationInSeconds property of the AssessmentTemplate data type. + // values of the durationInSeconds property of the AssessmentTemplatedata type. DurationRange *DurationRange // For a record to match a filter, an explicit value or a string that contains a // wildcard that is specified for this data type property must match the value of - // the assessmentTemplateName property of the AssessmentTemplate data type. + // the assessmentTemplateName property of the AssessmentTemplatedata 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 - // property of the AssessmentTemplate data type. + // property of the AssessmentTemplatedata type. RulesPackageArns []string noSmithyDocumentSerde @@ -440,8 +441,7 @@ 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. @@ -567,7 +567,7 @@ type FailedItemDetails struct { } // Contains information about an Amazon Inspector finding. This data type is used -// as the response element in the DescribeFindings action. +// as the response element in the DescribeFindingsaction. type Finding struct { // The ARN that specifies the finding. @@ -642,17 +642,17 @@ type FindingFilter struct { // For a record to match a filter, one of the values that is specified for this // data type property must be the exact match of the value of the agentId property - // of the Finding data type. + // of the Findingdata type. AgentIds []string // For a record to match a filter, the list of values that are specified for this // data type property must be contained in the list of values of the attributes - // property of the Finding data type. + // property of the Findingdata type. Attributes []Attribute // For a record to match a filter, one of the values that is specified for this // data type property must be the exact match of the value of the autoScalingGroup - // property of the Finding data type. + // property of the Findingdata type. AutoScalingGroups []string // The time range during which the finding is generated. @@ -660,22 +660,22 @@ type FindingFilter struct { // For a record to match a filter, one of the values that is specified for this // data type property must be the exact match of the value of the ruleName property - // of the Finding data type. + // of the Findingdata type. RuleNames []string // For a record to match a filter, one of the values that is specified for this // data type property must be the exact match of the value of the rulesPackageArn - // property of the Finding data type. + // property of the Findingdata type. RulesPackageArns []string // For a record to match a filter, one of the values that is specified for this // data type property must be the exact match of the value of the severity property - // of the Finding data type. + // of the Findingdata type. Severities []Severity // For a record to match a filter, the value that is specified for this data type // property must be contained in the list of values of the userAttributes property - // of the Finding data type. + // of the Findingdata type. UserAttributes []Attribute noSmithyDocumentSerde @@ -699,8 +699,7 @@ type InspectorServiceAttributes struct { } // Contains information about the network interfaces interacting with an EC2 -// instance. This data type is used as one of the elements of the AssetAttributes -// data type. +// instance. This data type is used as one of the elements of the AssetAttributesdata type. type NetworkInterface struct { // The IP addresses associated with the network interface. @@ -739,8 +738,7 @@ type NetworkInterface struct { } // Contains information about a private IP address associated with a network -// interface. This data type is used as a response element in the DescribeFindings -// action. +// interface. This data type is used as a response element in the DescribeFindingsaction. type PrivateIp struct { // The DNS name of the private IP address. @@ -754,8 +752,7 @@ type PrivateIp struct { // 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. +// assessment target. This data type is used as the response element in the DescribeResourceGroupsaction. type ResourceGroup struct { // The ARN of the resource group. @@ -769,7 +766,7 @@ type ResourceGroup struct { CreatedAt *time.Time // The tags (key and value pairs) of the resource group. This data type property - // is used in the CreateResourceGroup action. + // is used in the CreateResourceGroupaction. // // This member is required. Tags []ResourceGroupTag @@ -792,7 +789,7 @@ type ResourceGroupTag struct { } // Contains information about an Amazon Inspector rules package. This data type is -// used as the response element in the DescribeRulesPackages action. +// used as the response element in the DescribeRulesPackagesaction. type RulesPackage struct { // The ARN of the rules package. @@ -834,8 +831,7 @@ type Scope struct { } // 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. +// interface. This data type is used as one of the elements of the NetworkInterfacedata type. type SecurityGroup struct { // The ID of the security group. @@ -847,8 +843,7 @@ type SecurityGroup struct { noSmithyDocumentSerde } -// This data type is used as a response element in the ListEventSubscriptions -// action. +// This data type is used as a response element in the ListEventSubscriptions action. type Subscription struct { // The list of existing event subscriptions. @@ -871,9 +866,8 @@ type Subscription struct { noSmithyDocumentSerde } -// A key and value pair. This data type is used as a request parameter in the -// SetTagsForResource action and a response element in the ListTagsForResource -// action. +// A key and value pair. This data type is used as a request parameter in the SetTagsForResource +// action and a response element in the ListTagsForResourceaction. type Tag struct { // A tag key. @@ -888,8 +882,7 @@ type Tag struct { } // The metadata about the Amazon Inspector application data metrics collected by -// the agent. This data type is used as the response element in the -// GetTelemetryMetadata action. +// the agent. This data type is used as the response element in the GetTelemetryMetadataaction. type TelemetryMetadata struct { // The count of messages that the agent sends to the Amazon Inspector service. diff --git a/service/inspector2/api_op_AssociateMember.go b/service/inspector2/api_op_AssociateMember.go index 5a2f490ba8f..3a9b6cbd9d7 100644 --- a/service/inspector2/api_op_AssociateMember.go +++ b/service/inspector2/api_op_AssociateMember.go @@ -13,9 +13,10 @@ import ( // Associates an Amazon Web Services account with an Amazon Inspector delegated // administrator. An HTTP 200 response indicates the association was successfully // started, but doesn’t indicate whether it was completed. You can check if the -// association completed by using ListMembers (https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListMembers.html) -// for multiple accounts or GetMembers (https://docs.aws.amazon.com/inspector/v2/APIReference/API_GetMember.html) -// for a single account. +// association completed by using [ListMembers]for multiple accounts or [GetMembers] for a single account. +// +// [ListMembers]: https://docs.aws.amazon.com/inspector/v2/APIReference/API_ListMembers.html +// [GetMembers]: https://docs.aws.amazon.com/inspector/v2/APIReference/API_GetMember.html func (c *Client) AssociateMember(ctx context.Context, params *AssociateMemberInput, optFns ...func(*Options)) (*AssociateMemberOutput, error) { if params == nil { params = &AssociateMemberInput{} diff --git a/service/inspector2/api_op_CreateCisScanConfiguration.go b/service/inspector2/api_op_CreateCisScanConfiguration.go index 2f0dc7404b0..63b60886f40 100644 --- a/service/inspector2/api_op_CreateCisScanConfiguration.go +++ b/service/inspector2/api_op_CreateCisScanConfiguration.go @@ -39,8 +39,8 @@ type CreateCisScanConfigurationInput struct { // This member is required. Schedule types.Schedule - // The security level for the CIS scan configuration. Security level refers to the - // Benchmark levels that CIS assigns to a profile. + // The security level for the CIS scan configuration. Security level refers to + // the Benchmark levels that CIS assigns to a profile. // // This member is required. SecurityLevel types.CisSecurityLevel diff --git a/service/inspector2/api_op_GetCisScanReport.go b/service/inspector2/api_op_GetCisScanReport.go index 681273ceb73..296b4299cf4 100644 --- a/service/inspector2/api_op_GetCisScanReport.go +++ b/service/inspector2/api_op_GetCisScanReport.go @@ -34,7 +34,7 @@ type GetCisScanReportInput struct { // This member is required. ScanArn *string - // The format of the report. Valid values are PDF and CSV . If no value is + // The format of the report. Valid values are PDF and CSV . If no value is // specified, the report format defaults to PDF . ReportFormat types.CisReportFormat @@ -49,7 +49,7 @@ type GetCisScanReportOutput struct { // The status. Status types.CisReportStatus - // The URL where a PDF or CSV of the CIS scan report can be downloaded. + // The URL where a PDF or CSV of the CIS scan report can be downloaded. Url *string // Metadata pertaining to the operation's result. diff --git a/service/inspector2/api_op_SendCisSessionHealth.go b/service/inspector2/api_op_SendCisSessionHealth.go index b7457eb5d28..6a910813edf 100644 --- a/service/inspector2/api_op_SendCisSessionHealth.go +++ b/service/inspector2/api_op_SendCisSessionHealth.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sends a CIS session health. This API is used by the Amazon Inspector SSM plugin -// to communicate with the Amazon Inspector service. The Amazon Inspector SSM -// plugin calls this API to start a CIS scan session for the scan ID supplied by -// the service. +// Sends a CIS session health. This API is used by the Amazon Inspector SSM +// +// plugin to communicate with the Amazon Inspector service. The Amazon Inspector +// SSM plugin calls this API to start a CIS scan session for the scan ID supplied +// by the service. func (c *Client) SendCisSessionHealth(ctx context.Context, params *SendCisSessionHealthInput, optFns ...func(*Options)) (*SendCisSessionHealthOutput, error) { if params == nil { params = &SendCisSessionHealthInput{} diff --git a/service/inspector2/api_op_SendCisSessionTelemetry.go b/service/inspector2/api_op_SendCisSessionTelemetry.go index 5fdf2d8dd39..51c9cf41f39 100644 --- a/service/inspector2/api_op_SendCisSessionTelemetry.go +++ b/service/inspector2/api_op_SendCisSessionTelemetry.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM +// Sends a CIS session telemetry. This API is used by the Amazon Inspector SSM +// // plugin to communicate with the Amazon Inspector service. The Amazon Inspector // SSM plugin calls this API to start a CIS scan session for the scan ID supplied // by the service. diff --git a/service/inspector2/api_op_StartCisSession.go b/service/inspector2/api_op_StartCisSession.go index 04ac0b6d9b9..60b6ba8735d 100644 --- a/service/inspector2/api_op_StartCisSession.go +++ b/service/inspector2/api_op_StartCisSession.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to +// Starts a CIS session. This API is used by the Amazon Inspector SSM plugin to +// // communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin // calls this API to start a CIS scan session for the scan ID supplied by the // service. diff --git a/service/inspector2/api_op_StopCisSession.go b/service/inspector2/api_op_StopCisSession.go index 912b0b36bc1..1e4bfedc251 100644 --- a/service/inspector2/api_op_StopCisSession.go +++ b/service/inspector2/api_op_StopCisSession.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to +// Stops a CIS session. This API is used by the Amazon Inspector SSM plugin to +// // communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin // calls this API to start a CIS scan session for the scan ID supplied by the // service. diff --git a/service/inspector2/api_op_UpdateCisScanConfiguration.go b/service/inspector2/api_op_UpdateCisScanConfiguration.go index d0f013f883d..1a3c6a075f6 100644 --- a/service/inspector2/api_op_UpdateCisScanConfiguration.go +++ b/service/inspector2/api_op_UpdateCisScanConfiguration.go @@ -40,8 +40,8 @@ type UpdateCisScanConfigurationInput struct { // The schedule for the CIS scan configuration. Schedule types.Schedule - // The security level for the CIS scan configuration. Security level refers to the - // Benchmark levels that CIS assigns to a profile. + // The security level for the CIS scan configuration. Security level refers to + // the Benchmark levels that CIS assigns to a profile. SecurityLevel types.CisSecurityLevel // The targets for the CIS scan configuration. diff --git a/service/inspector2/api_op_UpdateEc2DeepInspectionConfiguration.go b/service/inspector2/api_op_UpdateEc2DeepInspectionConfiguration.go index fce46fc09a6..b8d6fd970d2 100644 --- a/service/inspector2/api_op_UpdateEc2DeepInspectionConfiguration.go +++ b/service/inspector2/api_op_UpdateEc2DeepInspectionConfiguration.go @@ -33,8 +33,9 @@ type UpdateEc2DeepInspectionConfigurationInput struct { // Specify TRUE to activate Amazon Inspector deep inspection in your account, or // FALSE to deactivate. Member accounts in an organization cannot deactivate deep // inspection, instead the delegated administrator for the organization can - // deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus (https://docs.aws.amazon.com/inspector/v2/APIReference/API_BatchUpdateMemberEc2DeepInspectionStatus.html) - // . + // deactivate a member account using [BatchUpdateMemberEc2DeepInspectionStatus]. + // + // [BatchUpdateMemberEc2DeepInspectionStatus]: https://docs.aws.amazon.com/inspector/v2/APIReference/API_BatchUpdateMemberEc2DeepInspectionStatus.html ActivateDeepInspection *bool // The Amazon Inspector deep inspection custom paths you are adding for your diff --git a/service/inspector2/options.go b/service/inspector2/options.go index 7f2ffd7de25..013ca854e5f 100644 --- a/service/inspector2/options.go +++ b/service/inspector2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/inspector2/types/enums.go b/service/inspector2/types/enums.go index 62f4cb9d029..63cfcf86dcc 100644 --- a/service/inspector2/types/enums.go +++ b/service/inspector2/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AccountSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountSortBy) Values() []AccountSortBy { return []AccountSortBy{ "CRITICAL", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for AggregationFindingType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationFindingType) Values() []AggregationFindingType { return []AggregationFindingType{ "NETWORK_REACHABILITY", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for AggregationResourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationResourceType) Values() []AggregationResourceType { return []AggregationResourceType{ "AWS_EC2_INSTANCE", @@ -80,8 +83,9 @@ const ( ) // Values returns all known values for AggregationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationType) Values() []AggregationType { return []AggregationType{ "FINDING_TYPE", @@ -109,8 +113,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -129,8 +134,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -148,8 +154,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CRITICAL", @@ -168,8 +175,9 @@ const ( ) // Values returns all known values for CisFindingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisFindingStatus) Values() []CisFindingStatus { return []CisFindingStatus{ "PASSED", @@ -187,6 +195,7 @@ const ( // Values returns all known values for CisFindingStatusComparison. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CisFindingStatusComparison) Values() []CisFindingStatusComparison { return []CisFindingStatusComparison{ @@ -203,8 +212,9 @@ const ( ) // Values returns all known values for CisReportFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisReportFormat) Values() []CisReportFormat { return []CisReportFormat{ "PDF", @@ -222,8 +232,9 @@ const ( ) // Values returns all known values for CisReportStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisReportStatus) Values() []CisReportStatus { return []CisReportStatus{ "SUCCEEDED", @@ -242,8 +253,9 @@ const ( ) // Values returns all known values for CisResultStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisResultStatus) Values() []CisResultStatus { return []CisResultStatus{ "PASSED", @@ -261,6 +273,7 @@ const ( // Values returns all known values for CisResultStatusComparison. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CisResultStatusComparison) Values() []CisResultStatusComparison { return []CisResultStatusComparison{ @@ -282,8 +295,9 @@ const ( ) // Values returns all known values for CisRuleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisRuleStatus) Values() []CisRuleStatus { return []CisRuleStatus{ "FAILED", @@ -306,6 +320,7 @@ const ( // Values returns all known values for CisScanConfigurationsSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CisScanConfigurationsSortBy) Values() []CisScanConfigurationsSortBy { return []CisScanConfigurationsSortBy{ @@ -324,6 +339,7 @@ const ( // Values returns all known values for CisScanResultDetailsSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CisScanResultDetailsSortBy) Values() []CisScanResultDetailsSortBy { return []CisScanResultDetailsSortBy{ @@ -345,8 +361,9 @@ const ( // Values returns all known values for CisScanResultsAggregatedByChecksSortBy. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisScanResultsAggregatedByChecksSortBy) Values() []CisScanResultsAggregatedByChecksSortBy { return []CisScanResultsAggregatedByChecksSortBy{ "CHECK_ID", @@ -371,8 +388,9 @@ const ( // Values returns all known values for // CisScanResultsAggregatedByTargetResourceSortBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisScanResultsAggregatedByTargetResourceSortBy) Values() []CisScanResultsAggregatedByTargetResourceSortBy { return []CisScanResultsAggregatedByTargetResourceSortBy{ "RESOURCE_ID", @@ -395,8 +413,9 @@ const ( ) // Values returns all known values for CisScanStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisScanStatus) Values() []CisScanStatus { return []CisScanStatus{ "FAILED", @@ -414,8 +433,9 @@ const ( ) // Values returns all known values for CisScanStatusComparison. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisScanStatusComparison) Values() []CisScanStatusComparison { return []CisScanStatusComparison{ "EQUALS", @@ -431,8 +451,9 @@ const ( ) // Values returns all known values for CisSecurityLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisSecurityLevel) Values() []CisSecurityLevel { return []CisSecurityLevel{ "LEVEL_1", @@ -449,6 +470,7 @@ const ( // Values returns all known values for CisSecurityLevelComparison. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CisSecurityLevelComparison) Values() []CisSecurityLevelComparison { return []CisSecurityLevelComparison{ @@ -465,8 +487,9 @@ const ( ) // Values returns all known values for CisSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisSortOrder) Values() []CisSortOrder { return []CisSortOrder{ "ASC", @@ -484,8 +507,9 @@ const ( ) // Values returns all known values for CisStringComparison. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisStringComparison) Values() []CisStringComparison { return []CisStringComparison{ "EQUALS", @@ -504,8 +528,9 @@ const ( ) // Values returns all known values for CisTargetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisTargetStatus) Values() []CisTargetStatus { return []CisTargetStatus{ "TIMED_OUT", @@ -523,6 +548,7 @@ const ( // Values returns all known values for CisTargetStatusComparison. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CisTargetStatusComparison) Values() []CisTargetStatusComparison { return []CisTargetStatusComparison{ @@ -540,8 +566,9 @@ const ( ) // Values returns all known values for CisTargetStatusReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CisTargetStatusReason) Values() []CisTargetStatusReason { return []CisTargetStatusReason{ "SCAN_IN_PROGRESS", @@ -561,8 +588,9 @@ const ( ) // Values returns all known values for CodeSnippetErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodeSnippetErrorCode) Values() []CodeSnippetErrorCode { return []CodeSnippetErrorCode{ "INTERNAL_ERROR", @@ -580,8 +608,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "EQUALS", @@ -599,8 +628,9 @@ const ( ) // Values returns all known values for CoverageResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoverageResourceType) Values() []CoverageResourceType { return []CoverageResourceType{ "AWS_EC2_INSTANCE", @@ -620,6 +650,7 @@ const ( // 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{ @@ -636,8 +667,9 @@ const ( ) // Values returns all known values for Currency. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Currency) Values() []Currency { return []Currency{ "USD", @@ -658,8 +690,9 @@ const ( ) // Values returns all known values for Day. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Day) Values() []Day { return []Day{ "SUN", @@ -681,8 +714,9 @@ const ( ) // Values returns all known values for DelegatedAdminStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DelegatedAdminStatus) Values() []DelegatedAdminStatus { return []DelegatedAdminStatus{ "ENABLED", @@ -701,8 +735,9 @@ const ( ) // Values returns all known values for Ec2DeepInspectionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2DeepInspectionStatus) Values() []Ec2DeepInspectionStatus { return []Ec2DeepInspectionStatus{ "ACTIVATED", @@ -723,8 +758,9 @@ const ( ) // Values returns all known values for Ec2InstanceSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2InstanceSortBy) Values() []Ec2InstanceSortBy { return []Ec2InstanceSortBy{ "NETWORK_FINDINGS", @@ -745,8 +781,9 @@ const ( ) // Values returns all known values for Ec2Platform. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2Platform) Values() []Ec2Platform { return []Ec2Platform{ "WINDOWS", @@ -765,8 +802,9 @@ const ( ) // Values returns all known values for Ec2ScanMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2ScanMode) Values() []Ec2ScanMode { return []Ec2ScanMode{ "EC2_SSM_AGENT_BASED", @@ -783,8 +821,9 @@ const ( ) // Values returns all known values for Ec2ScanModeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ec2ScanModeStatus) Values() []Ec2ScanModeStatus { return []Ec2ScanModeStatus{ "SUCCESS", @@ -805,6 +844,7 @@ const ( // Values returns all known values for EcrPullDateRescanDuration. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EcrPullDateRescanDuration) Values() []EcrPullDateRescanDuration { return []EcrPullDateRescanDuration{ @@ -829,8 +869,9 @@ const ( ) // Values returns all known values for EcrRescanDuration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EcrRescanDuration) Values() []EcrRescanDuration { return []EcrRescanDuration{ "LIFETIME", @@ -852,8 +893,9 @@ const ( ) // Values returns all known values for EcrRescanDurationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EcrRescanDurationStatus) Values() []EcrRescanDurationStatus { return []EcrRescanDurationStatus{ "SUCCESS", @@ -872,8 +914,9 @@ const ( ) // Values returns all known values for EcrScanFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EcrScanFrequency) Values() []EcrScanFrequency { return []EcrScanFrequency{ "MANUAL", @@ -903,8 +946,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -933,8 +977,9 @@ const ( ) // Values returns all known values for ExploitAvailable. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExploitAvailable) Values() []ExploitAvailable { return []ExploitAvailable{ "YES", @@ -953,8 +998,9 @@ const ( ) // Values returns all known values for ExternalReportStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExternalReportStatus) Values() []ExternalReportStatus { return []ExternalReportStatus{ "SUCCEEDED", @@ -973,8 +1019,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -993,8 +1040,9 @@ const ( ) // Values returns all known values for FindingDetailsErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingDetailsErrorCode) Values() []FindingDetailsErrorCode { return []FindingDetailsErrorCode{ "INTERNAL_ERROR", @@ -1014,8 +1062,9 @@ const ( ) // Values returns all known values for FindingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingStatus) Values() []FindingStatus { return []FindingStatus{ "ACTIVE", @@ -1034,8 +1083,9 @@ const ( ) // Values returns all known values for FindingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingType) Values() []FindingType { return []FindingType{ "NETWORK_REACHABILITY", @@ -1054,8 +1104,9 @@ const ( ) // Values returns all known values for FindingTypeSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingTypeSortBy) Values() []FindingTypeSortBy { return []FindingTypeSortBy{ "CRITICAL", @@ -1074,8 +1125,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1093,8 +1145,9 @@ const ( ) // Values returns all known values for FreeTrialInfoErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FreeTrialInfoErrorCode) Values() []FreeTrialInfoErrorCode { return []FreeTrialInfoErrorCode{ "ACCESS_DENIED", @@ -1111,8 +1164,9 @@ const ( ) // Values returns all known values for FreeTrialStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FreeTrialStatus) Values() []FreeTrialStatus { return []FreeTrialStatus{ "ACTIVE", @@ -1131,8 +1185,9 @@ const ( ) // Values returns all known values for FreeTrialType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FreeTrialType) Values() []FreeTrialType { return []FreeTrialType{ "EC2", @@ -1154,8 +1209,9 @@ const ( ) // Values returns all known values for GroupKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupKey) Values() []GroupKey { return []GroupKey{ "SCAN_STATUS_CODE", @@ -1176,8 +1232,9 @@ const ( ) // Values returns all known values for ImageLayerSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageLayerSortBy) Values() []ImageLayerSortBy { return []ImageLayerSortBy{ "CRITICAL", @@ -1196,8 +1253,9 @@ const ( ) // Values returns all known values for LambdaFunctionSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionSortBy) Values() []LambdaFunctionSortBy { return []LambdaFunctionSortBy{ "CRITICAL", @@ -1216,8 +1274,9 @@ const ( ) // Values returns all known values for LambdaLayerSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LambdaLayerSortBy) Values() []LambdaLayerSortBy { return []LambdaLayerSortBy{ "CRITICAL", @@ -1235,8 +1294,9 @@ const ( ) // Values returns all known values for ListCisScansDetailLevel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListCisScansDetailLevel) Values() []ListCisScansDetailLevel { return []ListCisScansDetailLevel{ "ORGANIZATION", @@ -1255,8 +1315,9 @@ const ( ) // Values returns all known values for ListCisScansSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListCisScansSortBy) Values() []ListCisScansSortBy { return []ListCisScansSortBy{ "STATUS", @@ -1274,8 +1335,9 @@ const ( ) // Values returns all known values for MapComparison. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MapComparison) Values() []MapComparison { return []MapComparison{ "EQUALS", @@ -1291,8 +1353,9 @@ const ( ) // Values returns all known values for NetworkProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkProtocol) Values() []NetworkProtocol { return []NetworkProtocol{ "TCP", @@ -1311,8 +1374,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1346,8 +1410,9 @@ const ( ) // Values returns all known values for PackageManager. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageManager) Values() []PackageManager { return []PackageManager{ "BUNDLER", @@ -1380,8 +1445,9 @@ const ( ) // Values returns all known values for PackageSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageSortBy) Values() []PackageSortBy { return []PackageSortBy{ "CRITICAL", @@ -1399,8 +1465,9 @@ const ( ) // Values returns all known values for PackageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageType) Values() []PackageType { return []PackageType{ "IMAGE", @@ -1427,8 +1494,9 @@ const ( ) // Values returns all known values for RelationshipStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationshipStatus) Values() []RelationshipStatus { return []RelationshipStatus{ "CREATED", @@ -1455,8 +1523,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1477,8 +1546,9 @@ const ( ) // Values returns all known values for ReportingErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportingErrorCode) Values() []ReportingErrorCode { return []ReportingErrorCode{ "INTERNAL_ERROR", @@ -1501,8 +1571,9 @@ const ( ) // Values returns all known values for RepositorySortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositorySortBy) Values() []RepositorySortBy { return []RepositorySortBy{ "CRITICAL", @@ -1520,8 +1591,9 @@ const ( ) // Values returns all known values for ResourceMapComparison. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceMapComparison) Values() []ResourceMapComparison { return []ResourceMapComparison{ "EQUALS", @@ -1539,8 +1611,9 @@ const ( ) // Values returns all known values for ResourceScanType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceScanType) Values() []ResourceScanType { return []ResourceScanType{ "EC2", @@ -1560,6 +1633,7 @@ const ( // Values returns all known values for ResourceStringComparison. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStringComparison) Values() []ResourceStringComparison { return []ResourceStringComparison{ @@ -1579,8 +1653,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1612,8 +1687,9 @@ const ( ) // Values returns all known values for Runtime. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Runtime) Values() []Runtime { return []Runtime{ "NODEJS", @@ -1643,8 +1719,9 @@ const ( ) // Values returns all known values for SbomReportFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SbomReportFormat) Values() []SbomReportFormat { return []SbomReportFormat{ "CYCLONEDX_1_4", @@ -1661,8 +1738,9 @@ const ( ) // Values returns all known values for ScanMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanMode) Values() []ScanMode { return []ScanMode{ "EC2_SSM_AGENT_BASED", @@ -1679,8 +1757,9 @@ const ( ) // Values returns all known values for ScanStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanStatusCode) Values() []ScanStatusCode { return []ScanStatusCode{ "ACTIVE", @@ -1719,8 +1798,9 @@ const ( ) // Values returns all known values for ScanStatusReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanStatusReason) Values() []ScanStatusReason { return []ScanStatusReason{ "PENDING_INITIAL_SCAN", @@ -1760,8 +1840,9 @@ const ( ) // Values returns all known values for ScanType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanType) Values() []ScanType { return []ScanType{ "NETWORK", @@ -1780,8 +1861,9 @@ const ( ) // Values returns all known values for Service. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Service) Values() []Service { return []Service{ "EC2", @@ -1803,8 +1885,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "INFORMATIONAL", @@ -1840,8 +1923,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1873,8 +1957,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1895,8 +1980,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "ENABLING", @@ -1919,8 +2005,9 @@ const ( ) // Values returns all known values for StopCisSessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StopCisSessionStatus) Values() []StopCisSessionStatus { return []StopCisSessionStatus{ "SUCCESS", @@ -1940,8 +2027,9 @@ const ( ) // Values returns all known values for StringComparison. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StringComparison) Values() []StringComparison { return []StringComparison{ "EQUALS", @@ -1958,8 +2046,9 @@ const ( ) // Values returns all known values for TagComparison. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TagComparison) Values() []TagComparison { return []TagComparison{ "EQUALS", @@ -1976,8 +2065,9 @@ const ( ) // Values returns all known values for TitleSortBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TitleSortBy) Values() []TitleSortBy { return []TitleSortBy{ "CRITICAL", @@ -1998,8 +2088,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2021,6 +2112,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -2038,8 +2130,9 @@ const ( ) // Values returns all known values for VulnerabilitySource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VulnerabilitySource) Values() []VulnerabilitySource { return []VulnerabilitySource{ "NVD", diff --git a/service/inspector2/types/types.go b/service/inspector2/types/types.go index 510fc09f7f7..8d7167a5123 100644 --- a/service/inspector2/types/types.go +++ b/service/inspector2/types/types.go @@ -386,8 +386,9 @@ type AtigData struct { // The commercial sectors this vulnerability targets. Targets []string - // The MITRE ATT&CK (https://attack.mitre.org/) tactics, techniques, and - // procedures (TTPs) associated with vulnerability. + // The [MITRE ATT&CK] tactics, techniques, and procedures (TTPs) associated with vulnerability. + // + // [MITRE ATT&CK]: https://attack.mitre.org/ Ttps []string noSmithyDocumentSerde @@ -581,11 +582,15 @@ type AwsLambdaFunctionDetails struct { // default 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] + // + // [ISO 8601 format]: https://www.iso.org/iso-8601-date-and-time-format.html LastModifiedAt *time.Time - // The Amazon Web Services 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 Amazon Web Services Lambda function's [layers]. A Lambda function can have up to + // five layers. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []string // The type of deployment package. Set to Image for container image and set Zip @@ -727,7 +732,7 @@ type CisScan struct { // The account or organization that schedules the CIS scan. ScheduledBy *string - // The security level for the CIS scan. Security level refers to the Benchmark + // The security level for the CIS scan. Security level refers to the Benchmark // levels that CIS assigns to a profile. SecurityLevel CisSecurityLevel @@ -828,8 +833,8 @@ type CisScanResultDetailsFilterCriteria struct { // The criteria's finding status filters. FindingStatusFilters []CisFindingStatusFilter - // The criteria's security level filters. . Security level refers to the Benchmark - // levels that CIS assigns to a profile. + // The criteria's security level filters. . Security level refers to the + // Benchmark levels that CIS assigns to a profile. SecurityLevelFilters []CisSecurityLevelFilter // The criteria's title filters. @@ -911,7 +916,8 @@ type CisScanStatusFilter struct { noSmithyDocumentSerde } -// The CIS security level filter. Security level refers to the Benchmark levels +// The CIS security level filter. Security level refers to the Benchmark levels +// // that CIS assigns to a profile. type CisSecurityLevelFilter struct { @@ -1140,15 +1146,17 @@ type CodeVulnerabilityDetails struct { Cwes []string // The ID for the Amazon CodeGuru detector associated with the finding. For more - // information on detectors see Amazon CodeGuru Detector Library (https://docs.aws.amazon.com/codeguru/detector-library) - // . + // information on detectors see [Amazon CodeGuru Detector Library]. + // + // [Amazon CodeGuru Detector Library]: https://docs.aws.amazon.com/codeguru/detector-library // // This member is required. DetectorId *string // The name of the detector used to identify the code vulnerability. For more - // information on detectors see CodeGuru Detector Library (https://docs.aws.amazon.com/codeguru/detector-library) - // . + // information on detectors see [CodeGuru Detector Library]. + // + // [CodeGuru Detector Library]: https://docs.aws.amazon.com/codeguru/detector-library // // This member is required. DetectorName *string @@ -1160,9 +1168,10 @@ type CodeVulnerabilityDetails struct { // The detector tag associated with the vulnerability. Detector tags group related // vulnerabilities by common themes or tactics. For a list of available tags by - // programming language, see Java tags (https://docs.aws.amazon.com/codeguru/detector-library/java/tags/) - // , or Python tags (https://docs.aws.amazon.com/codeguru/detector-library/python/tags/) - // . + // programming language, see [Java tags], or [Python tags]. + // + // [Python tags]: https://docs.aws.amazon.com/codeguru/detector-library/python/tags/ + // [Java tags]: https://docs.aws.amazon.com/codeguru/detector-library/java/tags/ DetectorTags []string // A URL containing supporting documentation about the code vulnerability detected. @@ -1876,9 +1885,10 @@ type FilterCriteria struct { // The detector type tag associated with the vulnerability used to filter // findings. Detector tags group related vulnerabilities by common themes or - // tactics. For a list of available tags by programming language, see Java tags (https://docs.aws.amazon.com/codeguru/detector-library/java/tags/) - // , or Python tags (https://docs.aws.amazon.com/codeguru/detector-library/python/tags/) - // . + // tactics. For a list of available tags by programming language, see [Java tags], or [Python tags]. + // + // [Python tags]: https://docs.aws.amazon.com/codeguru/detector-library/python/tags/ + // [Java tags]: https://docs.aws.amazon.com/codeguru/detector-library/java/tags/ CodeVulnerabilityDetectorTags []StringFilter // The file path to the file in a Lambda function that contains a code @@ -1950,12 +1960,15 @@ type FilterCriteria struct { LambdaFunctionExecutionRoleArn []StringFilter // Filters the list of Amazon Web Services 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) + // that a user last updated the configuration, in [ISO 8601 format] + // + // [ISO 8601 format]: https://www.iso.org/iso-8601-date-and-time-format.html LambdaFunctionLastModifiedAt []DateFilter - // Filters the list of Amazon Web Services 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 Amazon Web Services Lambda functions by the function's [layers]. A + // Lambda function can have up to five layers. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html LambdaFunctionLayers []StringFilter // Filters the list of Amazon Web Services Lambda functions by the name of the @@ -2035,7 +2048,7 @@ type Finding struct { // This member is required. FirstObservedAt *time.Time - // The date and time the finding was last observed. This timestamp for this field + // The date and time the finding was last observed. This timestamp for this field // remains unchanged until a finding is updated. // // This member is required. @@ -2047,17 +2060,19 @@ type Finding struct { Remediation *Remediation // Contains information on the resources involved in a finding. The resource value - // determines the valid values for type in your request. For more information, see - // Finding types (https://docs.aws.amazon.com/inspector/latest/user/findings-types.html) + // determines the valid values for type in your request. For more information, see [Finding types] // in the Amazon Inspector user guide. // + // [Finding types]: https://docs.aws.amazon.com/inspector/latest/user/findings-types.html + // // This member is required. Resources []Resource // The severity of the finding. UNTRIAGED applies to PACKAGE_VULNERABILITY type // findings that the vendor has not assigned a severity yet. For more information, - // see Severity levels for findings (https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html) - // in the Amazon Inspector user guide. + // see [Severity levels for findings]in the Amazon Inspector user guide. + // + // [Severity levels for findings]: https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html // // This member is required. Severity Severity @@ -2068,8 +2083,9 @@ type Finding struct { Status FindingStatus // The type of the finding. The type value determines the valid values for resource - // in your request. For more information, see Finding types (https://docs.aws.amazon.com/inspector/latest/user/findings-types.html) - // in the Amazon Inspector user guide. + // in your request. For more information, see [Finding types]in the Amazon Inspector user guide. + // + // [Finding types]: https://docs.aws.amazon.com/inspector/latest/user/findings-types.html // // This member is required. Type FindingType @@ -2418,7 +2434,8 @@ type LambdaLayerAggregation struct { // layers. FunctionNames []StringFilter - // The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer. + // The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function + // layer. LayerArns []StringFilter // The resource IDs for the Amazon Web Services Lambda function layers. @@ -2465,13 +2482,15 @@ type LambdaLayerAggregationResponse struct { } // The VPC security groups and subnets that are attached to an Amazon Web Services -// Lambda function. For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) -// . +// Lambda function. For more information, see [VPC Settings]. +// +// [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 Amazon Web Services - // Lambda function. For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) - // . + // Lambda function. For more information, see [VPC Settings]. + // + // [VPC Settings]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html SecurityGroupIds []string // A list of VPC subnet IDs. @@ -3063,62 +3082,95 @@ type ResourceStringFilter struct { type ScanStatus struct { // The scan status. Possible return values and descriptions are: + // // PENDING_INITIAL_SCAN - This resource has been identified for scanning, results - // will be available soon. ACCESS_DENIED - Resource access policy restricting - // Amazon Inspector access. Please update the IAM policy. INTERNAL_ERROR - Amazon - // Inspector has encountered an internal error for this resource. Amazon Inspector - // service will automatically resolve the issue and resume the scanning. No action - // required from the user. UNMANAGED_EC2_INSTANCE - The EC2 instance is not - // managed by SSM, please use the following SSM automation to remediate the issue: - // https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html (https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html) - // . Once the instance becomes managed by SSM, Inspector will automatically begin - // scanning this instance. UNSUPPORTED_OS - Amazon Inspector does not support this - // OS, architecture, or image manifest type at this time. To see a complete list of - // supported operating systems see: - // https://docs.aws.amazon.com/inspector/latest/user/supported.html (https://docs.aws.amazon.com/inspector/latest/user/supported.html) - // . SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this - // image. RESOURCE_TERMINATED - This resource has been terminated. The findings - // and coverage associated with this resource are in the process of being cleaned - // up. SUCCESSFUL - The scan was successful. NO_RESOURCES_FOUND - Reserved for - // future use. IMAGE_SIZE_EXCEEDED - Reserved for future use. SCAN_FREQUENCY_MANUAL - // - This image will not be covered by Amazon Inspector due to the repository scan - // frequency configuration. SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be - // scanned one time and will not new findings because of the scan frequency - // configuration. EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, - // therefore, Amazon Inspector will pause scanning. The existing findings will - // continue to exist until the instance is terminated. Once the instance is - // re-started, Inspector will automatically start scanning the instance again. - // Please note that you will not be charged for this instance while it’s in a - // stopped state. PENDING_DISABLE - This resource is pending cleanup during - // disablement. The customer will not be billed while a resource is in the pending - // disable status. NO INVENTORY - Amazon Inspector couldn’t find software - // application inventory to scan for vulnerabilities. This might be caused due to - // required Amazon Inspector associations being deleted or failing to run on your - // resource. Please verify the status of InspectorInventoryCollection-do-not-delete - // association in the SSM console for the resource. Additionally, you can verify - // the instance’s inventory in the SSM Fleet Manager console. STALE_INVENTORY - - // Amazon Inspector wasn’t able to collect an updated software application - // inventory in the last 7 days. Please confirm the required Amazon Inspector - // associations still exist and you can still see an updated inventory in the SSM - // console. EXCLUDED_BY_TAG - This resource was not scanned because it has been - // excluded by a tag. UNSUPPORTED_RUNTIME - The function was not scanned because - // it has an unsupported runtime. To see a complete list of supported runtimes see: - // https://docs.aws.amazon.com/inspector/latest/user/supported.html (https://docs.aws.amazon.com/inspector/latest/user/supported.html) - // . UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media type. + // will be available soon. + // + // ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. + // Please update the IAM policy. + // + // INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this + // resource. Amazon Inspector service will automatically resolve the issue and + // resume the scanning. No action required from the user. + // + // UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the + // following SSM automation to remediate the issue: [https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html]. Once the instance becomes + // managed by SSM, Inspector will automatically begin scanning this instance. + // + // UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or + // image manifest type at this time. To see a complete list of supported operating + // systems see: [https://docs.aws.amazon.com/inspector/latest/user/supported.html]. + // + // SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this + // image. + // + // RESOURCE_TERMINATED - This resource has been terminated. The findings and + // coverage associated with this resource are in the process of being cleaned up. + // + // SUCCESSFUL - The scan was successful. + // + // NO_RESOURCES_FOUND - Reserved for future use. + // + // IMAGE_SIZE_EXCEEDED - Reserved for future use. + // + // SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due + // to the repository scan frequency configuration. + // + // SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not + // new findings because of the scan frequency configuration. + // + // EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, + // Amazon Inspector will pause scanning. The existing findings will continue to + // exist until the instance is terminated. Once the instance is re-started, + // Inspector will automatically start scanning the instance again. Please note that + // you will not be charged for this instance while it’s in a stopped state. + // + // PENDING_DISABLE - This resource is pending cleanup during disablement. The + // customer will not be billed while a resource is in the pending disable status. + // + // NO INVENTORY - Amazon Inspector couldn’t find software application inventory to + // scan for vulnerabilities. This might be caused due to required Amazon Inspector + // associations being deleted or failing to run on your resource. Please verify the + // status of InspectorInventoryCollection-do-not-delete association in the SSM + // console for the resource. Additionally, you can verify the instance’s inventory + // in the SSM Fleet Manager console. + // + // STALE_INVENTORY - Amazon Inspector wasn’t able to collect an updated software + // application inventory in the last 7 days. Please confirm the required Amazon + // Inspector associations still exist and you can still see an updated inventory in + // the SSM console. + // + // EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by + // a tag. + // + // UNSUPPORTED_RUNTIME - The function was not scanned because it has an + // unsupported runtime. To see a complete list of supported runtimes see: [https://docs.aws.amazon.com/inspector/latest/user/supported.html]. + // + // UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media type. + // // UNSUPPORTED_CONFIG_FILE - Reserved for future use. + // // DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded // the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep // inspection for this instance you can try to adjust the custom paths associated - // with the account. DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM - // agent couldn't send inventory to Amazon Inspector because the SSM quota for - // Inventory data collected per instance per day has already been reached for this - // instance. DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector - // failed to extract the package inventory because the package collection time - // exceeding the maximum threshold of 15 minutes. DEEP_INSPECTION_NO_INVENTORY The - // Amazon Inspector plugin hasn't yet been able to collect an inventory of packages - // for this instance. This is usually the result of a pending scan, however, if - // this status persists after 6 hours, use SSM to ensure that the required Amazon - // Inspector associations exist and are running for the instance. + // with the account. + // + // DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't + // send inventory to Amazon Inspector because the SSM quota for Inventory data + // collected per instance per day has already been reached for this instance. + // + // DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to + // extract the package inventory because the package collection time exceeding the + // maximum threshold of 15 minutes. + // + // DEEP_INSPECTION_NO_INVENTORY The Amazon Inspector plugin hasn't yet been able + // to collect an inventory of packages for this instance. This is usually the + // result of a pending scan, however, if this status persists after 6 hours, use + // SSM to ensure that the required Amazon Inspector associations exist and are + // running for the instance. + // + // [https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html]: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html + // [https://docs.aws.amazon.com/inspector/latest/user/supported.html]: https://docs.aws.amazon.com/inspector/latest/user/supported.html // // This member is required. Reason ScanStatusReason diff --git a/service/inspectorscan/api_op_ScanSbom.go b/service/inspectorscan/api_op_ScanSbom.go index b270265252c..32d6fb4dafe 100644 --- a/service/inspectorscan/api_op_ScanSbom.go +++ b/service/inspectorscan/api_op_ScanSbom.go @@ -14,7 +14,7 @@ import ( // Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities // discovered in that SBOM. You can generate compatible SBOMs for your resources -// using the Amazon Inspector SBOM generator . +// using the Amazon Inspector SBOM generator. func (c *Client) ScanSbom(ctx context.Context, params *ScanSbomInput, optFns ...func(*Options)) (*ScanSbomOutput, error) { if params == nil { params = &ScanSbomInput{} diff --git a/service/inspectorscan/options.go b/service/inspectorscan/options.go index bb5adfd027c..278197adbde 100644 --- a/service/inspectorscan/options.go +++ b/service/inspectorscan/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/inspectorscan/types/enums.go b/service/inspectorscan/types/enums.go index 59aa1ba8464..c1915bdb294 100644 --- a/service/inspectorscan/types/enums.go +++ b/service/inspectorscan/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for InternalServerExceptionReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InternalServerExceptionReason) Values() []InternalServerExceptionReason { return []InternalServerExceptionReason{ "FAILED_TO_GENERATE_SBOM", @@ -30,8 +31,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "CYCLONE_DX_1_5", @@ -52,6 +54,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/internetmonitor/api_op_CreateMonitor.go b/service/internetmonitor/api_op_CreateMonitor.go index b005cb754d9..7a8470ad54c 100644 --- a/service/internetmonitor/api_op_CreateMonitor.go +++ b/service/internetmonitor/api_op_CreateMonitor.go @@ -17,16 +17,19 @@ 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) -// in the Amazon CloudWatch User Guide. When you create a monitor, you choose the -// percentage of traffic that you want to monitor. You can also set a maximum limit -// for the number of city-networks where client traffic is monitored, that caps the -// total traffic that Internet Monitor monitors. A city-network maximum is the -// limit of city-networks, but you only pay for the number of city-networks that -// are actually monitored. You can update your monitor at any time to change the -// percentage of traffic to monitor or the city-networks maximum. 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. +// application. For more information, see [Using Amazon CloudWatch Internet Monitor]in the Amazon CloudWatch User Guide. +// +// When you create a monitor, you choose the percentage of traffic that you want +// to monitor. You can also set a maximum limit for the number of city-networks +// where client traffic is monitored, that caps the total traffic that Internet +// Monitor monitors. A city-network maximum is the limit of city-networks, but you +// only pay for the number of city-networks that are actually monitored. You can +// update your monitor at any time to change the percentage of traffic to monitor +// or the city-networks maximum. For more information, see [Choosing a city-network maximum value]in the Amazon +// CloudWatch User Guide. +// +// [Using Amazon CloudWatch Internet Monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html +// [Choosing a city-network maximum value]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error) { if params == nil { params = &CreateMonitorInput{} @@ -58,10 +61,14 @@ type CreateMonitorInput struct { // Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor // creates a health event when an internet issue that affects your application end // users has a health score percentage that is at or below a specific threshold, - // and, sometimes, when other criteria are met. If you don't set a health event - // threshold, the default value is 95%. For more information, see Change health - // event thresholds (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) - // in the Internet Monitor section of the CloudWatch User Guide. + // and, sometimes, when other criteria are met. + // + // If you don't set a health event threshold, the default value is 95%. + // + // For more information, see [Change health event thresholds] in the Internet Monitor section of the CloudWatch + // User Guide. + // + // [Change health event thresholds]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview HealthEventsConfig *types.HealthEventsConfig // Publish internet measurements for Internet Monitor to an Amazon S3 bucket in @@ -72,19 +79,24 @@ type CreateMonitorInput struct { // city-network is the location (city) where clients access your application // resources from and the ASN or network provider, such as an internet service // provider (ISP), that clients access the resources through. Setting this limit - // can help control 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. + // can help control billing costs. + // + // To learn more, see [Choosing a city-network maximum value] in the Amazon CloudWatch Internet Monitor section of the + // CloudWatch User Guide. + // + // [Choosing a city-network maximum value]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html MaxCityNetworksToMonitor *int32 // The resources to include in a monitor, which you provide as a set of Amazon // Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront - // distributions, or Amazon WorkSpaces directories. You can add a combination of - // VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you - // can add NLBs. You can't add NLBs or WorkSpaces directories together with any - // other resources. If you add only Amazon VPC resources, at least one VPC must - // have an Internet Gateway attached to it, to make sure that it has internet - // connectivity. + // distributions, or Amazon WorkSpaces directories. + // + // You can add a combination of VPCs and CloudFront distributions, or you can add + // WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces + // directories together with any other resources. + // + // If you add only Amazon VPC resources, at least one VPC must have an Internet + // Gateway attached to it, to make sure that it has internet connectivity. Resources []string // The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor. @@ -92,9 +104,12 @@ type CreateMonitorInput struct { // The percentage of the internet-facing traffic for your application that you // want to monitor with this monitor. If you set a city-networks maximum, that - // limit overrides the traffic percentage that you set. To learn more, see - // Choosing an application traffic percentage to monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // limit overrides the traffic percentage that you set. + // + // To learn more, see [Choosing an application traffic percentage to monitor] in the Amazon CloudWatch Internet Monitor section of the + // CloudWatch User Guide. + // + // [Choosing an application traffic percentage to monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html TrafficPercentageToMonitor *int32 noSmithyDocumentSerde diff --git a/service/internetmonitor/api_op_GetHealthEvent.go b/service/internetmonitor/api_op_GetHealthEvent.go index 2fac3b6f31e..8a3310a7dd1 100644 --- a/service/internetmonitor/api_op_GetHealthEvent.go +++ b/service/internetmonitor/api_op_GetHealthEvent.go @@ -15,10 +15,13 @@ import ( // Gets information that Amazon CloudWatch Internet Monitor has created and stored // about a health event for a specified monitor. This information includes the // impacted locations, and all the information related to the event, by location. +// // The information returned includes the impact on performance, availability, and // round-trip time, information about the network providers (ASNs), the event type, -// and so on. Information rolled up at the global traffic level is also returned, -// including the impact type and total traffic impact. +// and so on. +// +// Information rolled up at the global traffic level is also returned, including +// the impact type and total traffic impact. func (c *Client) GetHealthEvent(ctx context.Context, params *GetHealthEventInput, optFns ...func(*Options)) (*GetHealthEventOutput, error) { if params == nil { params = &GetHealthEventInput{} @@ -50,9 +53,10 @@ type GetHealthEventInput struct { // The account ID for an account that you've set up cross-account sharing for in // Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using - // Amazon CloudWatch Observability Access Manager. For more information, see - // Internet Monitor cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in + // the Amazon CloudWatch Internet Monitor User Guide. + // + // [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html LinkedAccountId *string noSmithyDocumentSerde diff --git a/service/internetmonitor/api_op_GetInternetEvent.go b/service/internetmonitor/api_op_GetInternetEvent.go index 10edd83f2b9..632cd938c0f 100644 --- a/service/internetmonitor/api_op_GetInternetEvent.go +++ b/service/internetmonitor/api_op_GetInternetEvent.go @@ -15,10 +15,11 @@ import ( // Gets information that Amazon CloudWatch Internet Monitor has generated about an // internet event. Internet Monitor displays information about recent global health // events, called internet events, on a global outages map that is available to all -// Amazon Web Services customers. The information returned here includes the -// impacted location, when the event started and (if the event is over) ended, the -// type of event ( PERFORMANCE or AVAILABILITY ), and the status ( ACTIVE or -// RESOLVED ). +// Amazon Web Services customers. +// +// The information returned here includes the impacted location, when the event +// started and (if the event is over) ended, the type of event ( PERFORMANCE or +// AVAILABILITY ), and the status ( ACTIVE or RESOLVED ). func (c *Client) GetInternetEvent(ctx context.Context, params *GetInternetEventInput, optFns ...func(*Options)) (*GetInternetEventOutput, error) { if params == nil { params = &GetInternetEventInput{} diff --git a/service/internetmonitor/api_op_GetMonitor.go b/service/internetmonitor/api_op_GetMonitor.go index a022568acd3..8580287470c 100644 --- a/service/internetmonitor/api_op_GetMonitor.go +++ b/service/internetmonitor/api_op_GetMonitor.go @@ -40,9 +40,10 @@ type GetMonitorInput struct { // The account ID for an account that you've set up cross-account sharing for in // Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using - // Amazon CloudWatch Observability Access Manager. For more information, see - // Internet Monitor cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in + // the Amazon CloudWatch Internet Monitor User Guide. + // + // [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html LinkedAccountId *string noSmithyDocumentSerde @@ -84,9 +85,12 @@ type GetMonitorOutput struct { // The list of health event threshold configurations. The threshold percentage for // a health score determines, along with other configuration information, when // Internet Monitor creates a health event when there's an internet issue that - // affects your application end users. For more information, see Change health - // event thresholds (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) - // in the Internet Monitor section of the CloudWatch User Guide. + // affects your application end users. + // + // For more information, see [Change health event thresholds] in the Internet Monitor section of the CloudWatch + // User Guide. + // + // [Change health event thresholds]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview HealthEventsConfig *types.HealthEventsConfig // Publish internet measurements for Internet Monitor to another location, such as @@ -98,8 +102,12 @@ type GetMonitorOutput struct { // city-network is the location (city) where clients access your application // resources from and the ASN or network provider, such as an internet service // provider (ISP), that clients access the resources through. This limit can help - // control 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. + // control billing costs. + // + // To learn more, see [Choosing a city-network maximum value] in the Amazon CloudWatch Internet Monitor section of the + // CloudWatch User Guide. + // + // [Choosing a city-network maximum value]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html MaxCityNetworksToMonitor *int32 // The health of the data processing for the monitor. @@ -113,9 +121,12 @@ type GetMonitorOutput struct { // The percentage of the internet-facing traffic for your application to monitor // with this monitor. If you set a city-networks maximum, that limit overrides the - // traffic percentage that you set. To learn more, see Choosing an application - // traffic percentage to monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // traffic percentage that you set. + // + // To learn more, see [Choosing an application traffic percentage to monitor] in the Amazon CloudWatch Internet Monitor section of the + // CloudWatch User Guide. + // + // [Choosing an application traffic percentage to monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html TrafficPercentageToMonitor *int32 // Metadata pertaining to the operation's result. diff --git a/service/internetmonitor/api_op_GetQueryResults.go b/service/internetmonitor/api_op_GetQueryResults.go index 77a56b78ee7..befba0a4fcd 100644 --- a/service/internetmonitor/api_op_GetQueryResults.go +++ b/service/internetmonitor/api_op_GetQueryResults.go @@ -13,10 +13,12 @@ import ( // Return the data for a query with the Amazon CloudWatch Internet Monitor query // interface. Specify the query that you want to return results for by providing a -// QueryId and a monitor name. For more information about using the query -// interface, including examples, see Using the Amazon CloudWatch Internet Monitor -// query interface (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html) +// QueryId and a monitor name. +// +// For more information about using the query interface, including examples, see [Using the Amazon CloudWatch Internet Monitor query interface] // in the Amazon CloudWatch Internet Monitor User Guide. +// +// [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html func (c *Client) GetQueryResults(ctx context.Context, params *GetQueryResultsInput, optFns ...func(*Options)) (*GetQueryResultsOutput, error) { if params == nil { params = &GetQueryResultsInput{} diff --git a/service/internetmonitor/api_op_GetQueryStatus.go b/service/internetmonitor/api_op_GetQueryStatus.go index cea5a65c52b..160270e249e 100644 --- a/service/internetmonitor/api_op_GetQueryStatus.go +++ b/service/internetmonitor/api_op_GetQueryStatus.go @@ -15,10 +15,15 @@ import ( // Monitor query interface, for a specified query ID and monitor. When you run a // query, check the status to make sure that the query has SUCCEEDED before you // review the results. +// // - QUEUED : The query is scheduled to run. +// // - RUNNING : The query is in progress but not complete. +// // - SUCCEEDED : The query completed sucessfully. +// // - FAILED : The query failed due to an error. +// // - CANCELED : The query was canceled. func (c *Client) GetQueryStatus(ctx context.Context, params *GetQueryStatusInput, optFns ...func(*Options)) (*GetQueryStatusOutput, error) { if params == nil { diff --git a/service/internetmonitor/api_op_ListHealthEvents.go b/service/internetmonitor/api_op_ListHealthEvents.go index 1d4ee1ca135..72818aee5e8 100644 --- a/service/internetmonitor/api_op_ListHealthEvents.go +++ b/service/internetmonitor/api_op_ListHealthEvents.go @@ -14,8 +14,10 @@ import ( // Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. // Returns information for health events including the event start and end times, -// and the status. Health events that have start times during the time frame that -// is requested are not included in the list of health events. +// and the status. +// +// Health events that have start times during the time frame that is requested are +// not included in the list of health events. func (c *Client) ListHealthEvents(ctx context.Context, params *ListHealthEventsInput, optFns ...func(*Options)) (*ListHealthEventsOutput, error) { if params == nil { params = &ListHealthEventsInput{} @@ -47,9 +49,10 @@ type ListHealthEventsInput struct { // The account ID for an account that you've set up cross-account sharing for in // Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using - // Amazon CloudWatch Observability Access Manager. For more information, see - // Internet Monitor cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in + // the Amazon CloudWatch Internet Monitor User Guide. + // + // [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html LinkedAccountId *string // The number of health event objects that you want to return with this call. diff --git a/service/internetmonitor/api_op_ListInternetEvents.go b/service/internetmonitor/api_op_ListInternetEvents.go index 413a766f3ef..7b74e7aea1a 100644 --- a/service/internetmonitor/api_op_ListInternetEvents.go +++ b/service/internetmonitor/api_op_ListInternetEvents.go @@ -15,13 +15,15 @@ import ( // Lists internet events that cause performance or availability issues for client // locations. Amazon CloudWatch Internet Monitor displays information about recent // global health events, called internet events, on a global outages map that is -// available to all Amazon Web Services customers. You can constrain the list of -// internet events returned by providing a start time and end time to define a -// total time frame for events you want to list. Both start time and end time -// specify the time when an event started. End time is optional. If you don't -// include it, the default end time is the current time. You can also limit the -// events returned to a specific status ( ACTIVE or RESOLVED ) or type ( PERFORMANCE -// or AVAILABILITY ). +// available to all Amazon Web Services customers. +// +// You can constrain the list of internet events returned by providing a start +// time and end time to define a total time frame for events you want to list. Both +// start time and end time specify the time when an event started. End time is +// optional. If you don't include it, the default end time is the current time. +// +// You can also limit the events returned to a specific status ( ACTIVE or RESOLVED +// ) or type ( PERFORMANCE or AVAILABILITY ). func (c *Client) ListInternetEvents(ctx context.Context, params *ListInternetEventsInput, optFns ...func(*Options)) (*ListInternetEventsOutput, error) { if params == nil { params = &ListInternetEventsInput{} diff --git a/service/internetmonitor/api_op_ListMonitors.go b/service/internetmonitor/api_op_ListMonitors.go index 3d8e634efc0..723f4af6f25 100644 --- a/service/internetmonitor/api_op_ListMonitors.go +++ b/service/internetmonitor/api_op_ListMonitors.go @@ -33,18 +33,21 @@ type ListMonitorsInput struct { // A boolean option that you can set to TRUE to include monitors for linked // accounts in a list of monitors, when you've set up cross-account sharing in // Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using - // Amazon CloudWatch Observability Access Manager. For more information, see - // Internet Monitor cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in + // the Amazon CloudWatch Internet Monitor User Guide. + // + // [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html IncludeLinkedAccounts *bool // 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 monitor and the status of the monitor itself. + // + // For information about the statuses for a monitor, see [Monitor]. + // + // [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_StartQuery.go b/service/internetmonitor/api_op_StartQuery.go index 5e9ad92f0d6..ef348af274d 100644 --- a/service/internetmonitor/api_op_StartQuery.go +++ b/service/internetmonitor/api_op_StartQuery.go @@ -16,9 +16,12 @@ import ( // CloudWatch Internet Monitor query interface. Specify a time period for the data // that you want returned by using StartTime and EndTime . You filter the query // results to return by providing parameters that you specify with FilterParameters -// . For more information about using the query interface, including examples, see -// Using the Amazon CloudWatch Internet Monitor query interface (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html) +// . +// +// For more information about using the query interface, including examples, see [Using the Amazon CloudWatch Internet Monitor query interface] // in the Amazon CloudWatch Internet Monitor User Guide. +// +// [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns ...func(*Options)) (*StartQueryOutput, error) { if params == nil { params = &StartQueryInput{} @@ -49,17 +52,22 @@ type StartQueryInput struct { // The type of query to run. The following are the three types of queries that you // can run using the Internet Monitor query interface: + // // - MEASUREMENTS : Provides availability score, performance score, total // traffic, and round-trip times, at 5 minute intervals. + // // - TOP_LOCATIONS : Provides availability score, performance score, total // traffic, and time to first byte (TTFB) information, for the top location and ASN // combinations that you're monitoring, by traffic volume. + // // - TOP_LOCATION_DETAILS : Provides TTFB for Amazon CloudFront, your current // configuration, and the best performing EC2 configuration, at 1 hour intervals. + // // For lists of the fields returned with each query type and more information - // about how each type of query is performed, see Using the Amazon CloudWatch - // Internet Monitor query interface (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // about how each type of query is performed, see [Using the Amazon CloudWatch Internet Monitor query interface]in the Amazon CloudWatch + // Internet Monitor User Guide. + // + // [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html // // This member is required. QueryType types.QueryType @@ -73,17 +81,20 @@ type StartQueryInput struct { // The FilterParameters field that you use with Amazon CloudWatch Internet Monitor // queries is a string the defines how you want a query to be filtered. The filter // parameters that you can specify depend on the query type, since each query type - // returns a different set of Internet Monitor data. For more information about - // specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor - // query interface (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // returns a different set of Internet Monitor data. + // + // For more information about specifying filter parameters, see [Using the Amazon CloudWatch Internet Monitor query interface] in the Amazon + // CloudWatch Internet Monitor User Guide. + // + // [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html FilterParameters []types.FilterParameter // The account ID for an account that you've set up cross-account sharing for in // Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using - // Amazon CloudWatch Observability Access Manager. For more information, see - // Internet Monitor cross-account observability (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html) - // in the Amazon CloudWatch Internet Monitor User Guide. + // Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in + // the Amazon CloudWatch Internet Monitor User Guide. + // + // [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html LinkedAccountId *string noSmithyDocumentSerde diff --git a/service/internetmonitor/api_op_TagResource.go b/service/internetmonitor/api_op_TagResource.go index db9e3b477a7..32683009731 100644 --- a/service/internetmonitor/api_op_TagResource.go +++ b/service/internetmonitor/api_op_TagResource.go @@ -12,8 +12,10 @@ import ( // Adds a tag to a resource. Tags are supported only for monitors in Amazon // CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet -// Monitor. A minimum of one tag is required for this call. It returns an error if -// you use the TagResource request with 0 tags. +// Monitor. +// +// A minimum of one tag is required for this call. It returns an error if you use +// the TagResource request with 0 tags. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/internetmonitor/api_op_UpdateMonitor.go b/service/internetmonitor/api_op_UpdateMonitor.go index 42bf2296921..3772abbdbd2 100644 --- a/service/internetmonitor/api_op_UpdateMonitor.go +++ b/service/internetmonitor/api_op_UpdateMonitor.go @@ -14,10 +14,13 @@ import ( // Updates a monitor. You can update a monitor to change the percentage of traffic // to monitor or the maximum number of city-networks (locations and ASNs), to add // or 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) +// 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] // in the Amazon CloudWatch User Guide. +// +// [Choosing a city-network maximum value]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html func (c *Client) UpdateMonitor(ctx context.Context, params *UpdateMonitorInput, optFns ...func(*Options)) (*UpdateMonitorOutput, error) { if params == nil { params = &UpdateMonitorInput{} @@ -48,8 +51,12 @@ type UpdateMonitorInput struct { // The list of health score thresholds. A threshold percentage for health scores, // along with other configuration information, determines when Internet Monitor // creates a health event when there's an internet issue that affects your - // application end users. For more information, see Change health event thresholds (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) - // in the Internet Monitor section of the CloudWatch User Guide. + // application end users. + // + // For more information, see [Change health event thresholds] in the Internet Monitor section of the CloudWatch + // User Guide. + // + // [Change health event thresholds]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview HealthEventsConfig *types.HealthEventsConfig // Publish internet measurements for Internet Monitor to another location, such as @@ -66,12 +73,15 @@ type UpdateMonitorInput struct { // The resources to include in a monitor, which you provide as a set of Amazon // Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront - // distributions, or Amazon WorkSpaces directories. You can add a combination of - // VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you - // can add NLBs. You can't add NLBs or WorkSpaces directories together with any - // other resources. If you add only Amazon Virtual Private Clouds resources, at - // least one VPC must have an Internet Gateway attached to it, to make sure that it - // has internet connectivity. + // distributions, or Amazon WorkSpaces directories. + // + // You can add a combination of VPCs and CloudFront distributions, or you can add + // WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces + // directories together with any other resources. + // + // If you add only Amazon Virtual Private Clouds resources, at least one VPC must + // have an Internet Gateway attached to it, to make sure that it has internet + // connectivity. ResourcesToAdd []string // The resources to remove from a monitor, which you provide as a set of Amazon @@ -85,9 +95,12 @@ type UpdateMonitorInput struct { // The percentage of the internet-facing traffic for your application that you // want to monitor with this monitor. If you set a city-networks maximum, that - // limit overrides the traffic percentage that you set. To learn more, see - // Choosing an application traffic percentage to monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // limit overrides the traffic percentage that you set. + // + // To learn more, see [Choosing an application traffic percentage to monitor] in the Amazon CloudWatch Internet Monitor section of the + // CloudWatch User Guide. + // + // [Choosing an application traffic percentage to monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html TrafficPercentageToMonitor *int32 noSmithyDocumentSerde diff --git a/service/internetmonitor/doc.go b/service/internetmonitor/doc.go index 948742ed194..ad331a0e10b 100644 --- a/service/internetmonitor/doc.go +++ b/service/internetmonitor/doc.go @@ -12,20 +12,24 @@ // traffic. This is the same data that Amazon Web Services uses to monitor internet // uptime and availability. With those measurements as a baseline, Internet Monitor // raises awareness for you when there are significant problems for your end users -// in the different geographic locations where your application runs. Internet -// Monitor publishes internet measurements to CloudWatch Logs and CloudWatch -// Metrics, to easily support using CloudWatch tools with health information for -// geographies and networks specific to your application. Internet Monitor sends -// health events to Amazon EventBridge so that you can set up notifications. If an -// issue is caused by the Amazon Web Services network, you also automatically -// receive an Amazon Web Services Health Dashboard notification with the steps that -// Amazon Web Services is taking to mitigate the problem. To use Internet Monitor, -// you create a monitor and associate your application's resources with it - VPCs, -// NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor -// can determine where your application's internet traffic is. Internet Monitor -// then provides internet measurements from Amazon Web Services that are specific -// to the locations and ASNs (typically, internet service providers or ISPs) 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) -// in the Amazon CloudWatch User Guide. +// in the different geographic locations where your application runs. +// +// Internet Monitor publishes internet measurements to CloudWatch Logs and +// CloudWatch Metrics, to easily support using CloudWatch tools with health +// information for geographies and networks specific to your application. Internet +// Monitor sends health events to Amazon EventBridge so that you can set up +// notifications. If an issue is caused by the Amazon Web Services network, you +// also automatically receive an Amazon Web Services Health Dashboard notification +// with the steps that Amazon Web Services is taking to mitigate the problem. +// +// To use Internet Monitor, you create a monitor and associate your application's +// resources with it - VPCs, NLBs, CloudFront distributions, or WorkSpaces +// directories - so Internet Monitor can determine where your application's +// internet traffic is. Internet Monitor then provides internet measurements from +// Amazon Web Services that are specific to the locations and ASNs (typically, +// internet service providers or ISPs) that communicate with your application. +// +// For more information, see [Using Amazon CloudWatch Internet Monitor] in the Amazon CloudWatch User Guide. +// +// [Using Amazon CloudWatch Internet Monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html package internetmonitor diff --git a/service/internetmonitor/options.go b/service/internetmonitor/options.go index eb145a63961..67464ee43d1 100644 --- a/service/internetmonitor/options.go +++ b/service/internetmonitor/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/internetmonitor/types/enums.go b/service/internetmonitor/types/enums.go index 51785c6ee4c..a41ccca6a64 100644 --- a/service/internetmonitor/types/enums.go +++ b/service/internetmonitor/types/enums.go @@ -13,8 +13,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AVAILABILITY", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for HealthEventStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthEventStatus) Values() []HealthEventStatus { return []HealthEventStatus{ "ACTIVE", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for InternetEventStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InternetEventStatus) Values() []InternetEventStatus { return []InternetEventStatus{ "ACTIVE", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for InternetEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InternetEventType) Values() []InternetEventType { return []InternetEventType{ "AVAILABILITY", @@ -88,8 +92,9 @@ const ( // Values returns all known values for LocalHealthEventsConfigStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocalHealthEventsConfigStatus) Values() []LocalHealthEventsConfigStatus { return []LocalHealthEventsConfigStatus{ "ENABLED", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for LogDeliveryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogDeliveryStatus) Values() []LogDeliveryStatus { return []LogDeliveryStatus{ "ENABLED", @@ -126,8 +132,9 @@ const ( ) // Values returns all known values for MonitorConfigState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitorConfigState) Values() []MonitorConfigState { return []MonitorConfigState{ "PENDING", @@ -151,6 +158,7 @@ const ( // Values returns all known values for MonitorProcessingStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MonitorProcessingStatusCode) Values() []MonitorProcessingStatusCode { return []MonitorProcessingStatusCode{ @@ -172,8 +180,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "EQUALS", @@ -193,8 +202,9 @@ const ( ) // Values returns all known values for QueryStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryStatus) Values() []QueryStatus { return []QueryStatus{ "QUEUED", @@ -215,8 +225,9 @@ const ( ) // 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. +// in the future, and so 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{ "MEASUREMENTS", @@ -234,8 +245,9 @@ const ( ) // Values returns all known values for TriangulationEventType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriangulationEventType) Values() []TriangulationEventType { return []TriangulationEventType{ "AWS", diff --git a/service/internetmonitor/types/types.go b/service/internetmonitor/types/types.go index d4c7141ccd0..b8b9fad25be 100644 --- a/service/internetmonitor/types/types.go +++ b/service/internetmonitor/types/types.go @@ -16,44 +16,53 @@ import ( // availability for your application has dropped, compared to an estimated baseline // that's already calculated. To make it easier to see those drops, we report that // information to you in the form of health scores: a performance score and an -// availability score. Availability in Internet Monitor represents the estimated -// percentage of traffic 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) -// in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User -// Guide. +// availability score. +// +// Availability in Internet Monitor represents the estimated percentage of traffic +// 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] in the Amazon CloudWatch Internet Monitor section of +// the Amazon CloudWatch User Guide. +// +// [How Internet Monitor calculates performance and availability scores]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores type AvailabilityMeasurement struct { // Experience scores, or health scores are calculated for different geographic and // network provider combinations (that is, different granularities) and also summed // 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // 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]in the Amazon CloudWatch + // Internet Monitor section of the CloudWatch User Guide. + // + // [How Amazon Web Services calculates performance and availability scores]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores 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) - // in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User - // Guide. + // globally. + // + // For information about how Internet Monitor calculates impact, see [Inside Internet Monitor] in the + // Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide. + // + // [Inside Internet Monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html PercentOfClientLocationImpacted *float64 // The impact on total traffic that a health event has, in increased latency or // reduced availability. This is the percentage of how much latency has increased // or availability has decreased during the event, compared to what is typical for // traffic from this client location to the Amazon Web Services location using this - // client network. For information about how Internet Monitor calculates impact, - // see How Internet Monitor works (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. + // client network. + // + // For information about how Internet Monitor calculates impact, see [How Internet Monitor works] in the + // Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide. + // + // [How Internet Monitor works]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html PercentOfTotalTrafficImpacted *float64 noSmithyDocumentSerde @@ -93,11 +102,12 @@ type ClientLocation struct { // This member is required. 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 subdivision location where the health event is located. The subdivision @@ -113,14 +123,20 @@ type ClientLocation struct { // query that you created and ran. The query sets up a repository of data that is a // subset of your application's Internet Monitor data. FilterParameter is a string // that defines how you want to filter the repository of data to return a set of -// results, based on your criteria. The filter parameters that you can specify -// depend on the query type that you used to create the repository, since each -// query type returns a different set of Internet Monitor data. For each filter, -// you specify a field (such as city ), an operator (such as not_equals , and a -// value or array of values (such as ["Seattle", "Redmond"] ). Separate values in -// the array with commas. For more information about specifying filter parameters, -// see Using the Amazon CloudWatch Internet Monitor query interface (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html) -// in the Amazon CloudWatch Internet Monitor User Guide. +// results, based on your criteria. +// +// The filter parameters that you can specify depend on the query type that you +// used to create the repository, since each query type returns a different set of +// Internet Monitor data. +// +// For each filter, you specify a field (such as city ), an operator (such as +// not_equals , and a value or array of values (such as ["Seattle", "Redmond"] ). +// Separate values in the array with commas. +// +// For more information about specifying filter parameters, see [Using the Amazon CloudWatch Internet Monitor query interface] in the Amazon +// CloudWatch Internet Monitor User Guide. +// +// [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html type FilterParameter struct { // A data field that you want to filter, to further scope your application's @@ -204,19 +220,28 @@ type HealthEvent struct { // A complex type with the configuration information that determines the threshold // and other conditions for when Internet Monitor creates a health event for an // overall performance or availability issue, across an application's geographies. +// // Defines the percentages, for overall performance scores and availability scores // for an application, that are the thresholds for when Amazon CloudWatch Internet // Monitor creates a health event. You can override the defaults to set a custom -// threshold for overall performance or availability scores, or both. You can also -// set thresholds for local health scores,, where Internet Monitor creates a health -// event when scores cross a threshold for one or more city-networks, in addition -// to creating an event when an overall score crosses a threshold. If you don't set -// a health event threshold, the default value is 95%. For local thresholds, you -// also set a minimum percentage of overall traffic that is impacted by an issue -// before Internet Monitor creates an event. In addition, you can disable local -// thresholds, for performance scores, availability scores, or both. For more -// information, see Change health event thresholds (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) -// in the Internet Monitor section of the CloudWatch User Guide. +// threshold for overall performance or availability scores, or both. +// +// You can also set thresholds for local health scores,, where Internet Monitor +// creates a health event when scores cross a threshold for one or more +// city-networks, in addition to creating an event when an overall score crosses a +// threshold. +// +// If you don't set a health event threshold, the default value is 95%. +// +// For local thresholds, you also set a minimum percentage of overall traffic that +// is impacted by an issue before Internet Monitor creates an event. In addition, +// you can disable local thresholds, for performance scores, availability scores, +// or both. +// +// For more information, see [Change health event thresholds] in the Internet Monitor section of the CloudWatch +// User Guide. +// +// [Change health event thresholds]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview type HealthEventsConfig struct { // The configuration that determines the threshold and other conditions for when @@ -237,9 +262,11 @@ type HealthEventsConfig struct { } // Information about a location impacted by a health event in Amazon CloudWatch -// Internet Monitor. Geographic regions are hierarchically categorized into -// country, subdivision, metro and city geographic granularities. The geographic -// region is identified based on the IP address used at the client locations. +// Internet Monitor. +// +// Geographic regions are hierarchically categorized into country, subdivision, +// metro and city geographic granularities. The geographic region is identified +// based on the IP address used at the client locations. type ImpactedLocation struct { // The name of the internet service provider (ISP) or network (ASN). @@ -286,11 +313,12 @@ 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. @@ -370,17 +398,23 @@ type InternetHealth struct { // Availability in Internet Monitor represents the estimated percentage of traffic // 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // experiencing an availability drop for that pair. + // + // For more information, see [How Internet Monitor calculates performance and availability scores] in the Amazon CloudWatch Internet Monitor section of + // the CloudWatch User Guide. + // + // [How Internet Monitor calculates performance and availability scores]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores Availability *AvailabilityMeasurement // Performance in Internet Monitor represents the estimated percentage of traffic // 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // experiencing a performance drop for that pair. + // + // For more information, see [How Internet Monitor calculates performance and availability scores] in the Amazon CloudWatch Internet Monitor section of + // the CloudWatch User Guide. + // + // [How Internet Monitor calculates performance and availability scores]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores Performance *PerformanceMeasurement noSmithyDocumentSerde @@ -403,15 +437,21 @@ type InternetMeasurementsLogDelivery struct { // A complex type with the configuration information that determines the threshold // and other conditions for when Internet Monitor creates a health event for a // local performance or availability issue, when scores cross a threshold for one -// or more city-networks. Defines the percentages, for performance scores or -// availability scores, that are the local thresholds for when Amazon CloudWatch -// Internet Monitor creates a health event. Also defines whether a local threshold -// is enabled or disabled, and the minimum percentage of overall traffic that must -// be impacted by an issue before Internet Monitor creates an event when a -// threshold is crossed for a local health score. If you don't set a local health -// event threshold, the default value is 60%. For more information, see Change -// health event thresholds (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview) -// in the Internet Monitor section of the CloudWatch User Guide. +// or more city-networks. +// +// Defines the percentages, for performance scores or availability scores, that +// are the local thresholds for when Amazon CloudWatch Internet Monitor creates a +// health event. Also defines whether a local threshold is enabled or disabled, and +// the minimum percentage of overall traffic that must be impacted by an issue +// before Internet Monitor creates an event when a threshold is crossed for a local +// health score. +// +// If you don't set a local health event threshold, the default value is 60%. +// +// For more information, see [Change health event thresholds] in the Internet Monitor section of the CloudWatch +// User Guide. +// +// [Change health event thresholds]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview type LocalHealthEventsConfig struct { // The health event threshold percentage set for a local health score. @@ -419,8 +459,9 @@ type LocalHealthEventsConfig struct { // The minimum percentage of overall traffic for an application that must be // impacted by an issue before Internet Monitor creates an event when a threshold - // is crossed for a local health score. If you don't set a minimum traffic impact - // threshold, the default value is 0.1%. + // is crossed for a local health score. + // + // If you don't set a minimum traffic impact threshold, the default value is 0.1%. MinTrafficImpact float64 // The status of whether Internet Monitor creates a health event based on a @@ -505,48 +546,63 @@ type NetworkImpairment struct { // your application has dropped, compared to an estimated baseline that's already // calculated. To make it easier to see those drops, we report that information to // you in the form of health scores: a performance score and an availability score. +// // Performance in Internet Monitor represents the estimated percentage of traffic // 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) -// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. +// experiencing a performance drop for that pair. +// +// For more information, see [How Internet Monitor calculates performance and availability scores] in the Amazon CloudWatch Internet Monitor section of +// the CloudWatch User Guide. +// +// [How Internet Monitor calculates performance and availability scores]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores type PerformanceMeasurement struct { // 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // 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]in the Amazon CloudWatch + // Internet Monitor section of the CloudWatch User Guide. + // + // [How Amazon Web Services calculates performance and availability scores]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores ExperienceScore *float64 // How much performance impact was caused by a health event at a client location. // 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // an Amazon Web Services location, using a specific client network. + // + // For more information, see [When Amazon Web Services creates and resolves health events] in the Amazon CloudWatch Internet Monitor section of + // the CloudWatch User Guide. + // + // [When Amazon Web Services creates and resolves health events]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop PercentOfClientLocationImpacted *float64 // The impact on total traffic that a health event has, in increased latency or // reduced availability. This is the percentage of how much latency has increased // or availability has decreased during the event, compared to what is typical for // traffic from this client location to the Amazon Web Services location using this - // 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // client network. + // + // For more information, see [When Amazon Web Services creates and resolves health events] in the Amazon CloudWatch Internet Monitor section of + // the CloudWatch User Guide. + // + // [When Amazon Web Services creates and resolves health events]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop 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) - // in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide. + // compared to typical round-trip time for your application for traffic. + // + // For more information, see [When Amazon Web Services creates and resolves health events] in the Amazon CloudWatch Internet Monitor section of + // the CloudWatch User Guide. + // + // [When Amazon Web Services creates and resolves health events]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop RoundTripTime *RoundTripTime noSmithyDocumentSerde diff --git a/service/iot/api_op_AcceptCertificateTransfer.go b/service/iot/api_op_AcceptCertificateTransfer.go index 74414b25c68..01716ff98d5 100644 --- a/service/iot/api_op_AcceptCertificateTransfer.go +++ b/service/iot/api_op_AcceptCertificateTransfer.go @@ -11,10 +11,14 @@ 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) -// action. +// INACTIVE. +// +// To check for pending certificate transfers, call ListCertificates to enumerate your +// certificates. +// +// Requires permission to access the [AcceptCertificateTransfer] action. +// +// [AcceptCertificateTransfer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AcceptCertificateTransfer(ctx context.Context, params *AcceptCertificateTransferInput, optFns ...func(*Options)) (*AcceptCertificateTransferOutput, error) { if params == nil { params = &AcceptCertificateTransferInput{} diff --git a/service/iot/api_op_AddThingToBillingGroup.go b/service/iot/api_op_AddThingToBillingGroup.go index f6a7591537e..c3cfd9e36d4 100644 --- a/service/iot/api_op_AddThingToBillingGroup.go +++ b/service/iot/api_op_AddThingToBillingGroup.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Adds a thing to a billing group. +// +// Requires permission to access the [AddThingToBillingGroup] action. +// +// [AddThingToBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AddThingToBillingGroup(ctx context.Context, params *AddThingToBillingGroupInput, optFns ...func(*Options)) (*AddThingToBillingGroupOutput, error) { if params == nil { params = &AddThingToBillingGroupInput{} @@ -33,8 +35,10 @@ type AddThingToBillingGroupInput struct { // The ARN of the billing group. BillingGroupArn *string - // The name of the billing group. This call is asynchronous. It might take several - // seconds for the detachment to propagate. + // The name of the billing group. + // + // This call is asynchronous. It might take several seconds for the detachment to + // propagate. BillingGroupName *string // The ARN of the thing to be added to the billing group. diff --git a/service/iot/api_op_AddThingToThingGroup.go b/service/iot/api_op_AddThingToThingGroup.go index 575d67edb31..bfb7a64bc60 100644 --- a/service/iot/api_op_AddThingToThingGroup.go +++ b/service/iot/api_op_AddThingToThingGroup.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Adds a thing to a thing group. +// +// Requires permission to access the [AddThingToThingGroup] action. +// +// [AddThingToThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AddThingToThingGroup(ctx context.Context, params *AddThingToThingGroupInput, optFns ...func(*Options)) (*AddThingToThingGroupOutput, error) { if params == nil { params = &AddThingToThingGroupInput{} diff --git a/service/iot/api_op_AssociateTargetsWithJob.go b/service/iot/api_op_AssociateTargetsWithJob.go index fc9b00351a8..f3e600eb2ac 100644 --- a/service/iot/api_op_AssociateTargetsWithJob.go +++ b/service/iot/api_op_AssociateTargetsWithJob.go @@ -11,13 +11,17 @@ 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. // -// Requires permission to access the AssociateTargetsWithJob (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Requires permission to access the [AssociateTargetsWithJob] action. +// +// [AssociateTargetsWithJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AssociateTargetsWithJob(ctx context.Context, params *AssociateTargetsWithJobInput, optFns ...func(*Options)) (*AssociateTargetsWithJobOutput, error) { if params == nil { params = &AssociateTargetsWithJobInput{} @@ -49,12 +53,18 @@ type AssociateTargetsWithJobInput struct { // targets. Comment *string - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string noSmithyDocumentSerde diff --git a/service/iot/api_op_AttachPolicy.go b/service/iot/api_op_AttachPolicy.go index 26ba8a042bc..4841ef9eaf5 100644 --- a/service/iot/api_op_AttachPolicy.go +++ b/service/iot/api_op_AttachPolicy.go @@ -11,8 +11,11 @@ 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) -// action. +// credential). +// +// Requires permission to access the [AttachPolicy] action. +// +// [AttachPolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error) { if params == nil { params = &AttachPolicyInput{} @@ -35,8 +38,10 @@ 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] to which the policy is attached. For example, a thing group or a + // certificate. + // + // [identity]: https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html // // This member is required. Target *string diff --git a/service/iot/api_op_AttachPrincipalPolicy.go b/service/iot/api_op_AttachPrincipalPolicy.go index 0540b7ae6fc..b43f7860554 100644 --- a/service/iot/api_op_AttachPrincipalPolicy.go +++ b/service/iot/api_op_AttachPrincipalPolicy.go @@ -11,12 +11,16 @@ 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) -// action. +// credential). +// +// Note: This action is deprecated and works as expected for backward +// compatibility, but we won't add enhancements. Use AttachPolicyinstead. +// +// Requires permission to access the [AttachPrincipalPolicy] action. // // Deprecated: This operation has been deprecated. +// +// [AttachPrincipalPolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AttachPrincipalPolicy(ctx context.Context, params *AttachPrincipalPolicyInput, optFns ...func(*Options)) (*AttachPrincipalPolicyOutput, error) { if params == nil { params = &AttachPrincipalPolicyInput{} diff --git a/service/iot/api_op_AttachSecurityProfile.go b/service/iot/api_op_AttachSecurityProfile.go index e81e5d2af00..0954d3bc978 100644 --- a/service/iot/api_op_AttachSecurityProfile.go +++ b/service/iot/api_op_AttachSecurityProfile.go @@ -12,8 +12,11 @@ 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) -// action. +// associated with it. +// +// Requires permission to access the [AttachSecurityProfile] action. +// +// [AttachSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AttachSecurityProfile(ctx context.Context, params *AttachSecurityProfileInput, optFns ...func(*Options)) (*AttachSecurityProfileOutput, error) { if params == nil { params = &AttachSecurityProfileInput{} diff --git a/service/iot/api_op_AttachThingPrincipal.go b/service/iot/api_op_AttachThingPrincipal.go index c67e353a144..6fada1b4922 100644 --- a/service/iot/api_op_AttachThingPrincipal.go +++ b/service/iot/api_op_AttachThingPrincipal.go @@ -11,9 +11,11 @@ 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) -// action. +// X.509 certificates, Amazon Cognito identities or federated identities. +// +// Requires permission to access the [AttachThingPrincipal] action. +// +// [AttachThingPrincipal]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) AttachThingPrincipal(ctx context.Context, params *AttachThingPrincipalInput, optFns ...func(*Options)) (*AttachThingPrincipalOutput, error) { if params == nil { params = &AttachThingPrincipalInput{} diff --git a/service/iot/api_op_CancelAuditMitigationActionsTask.go b/service/iot/api_op_CancelAuditMitigationActionsTask.go index 494e737f9f5..568d751df5d 100644 --- a/service/iot/api_op_CancelAuditMitigationActionsTask.go +++ b/service/iot/api_op_CancelAuditMitigationActionsTask.go @@ -11,9 +11,11 @@ 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) -// action. +// progress, an InvalidRequestException occurs. +// +// Requires permission to access the [CancelAuditMitigationActionsTask] action. +// +// [CancelAuditMitigationActionsTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CancelAuditMitigationActionsTask(ctx context.Context, params *CancelAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*CancelAuditMitigationActionsTaskOutput, error) { if params == nil { params = &CancelAuditMitigationActionsTaskInput{} diff --git a/service/iot/api_op_CancelAuditTask.go b/service/iot/api_op_CancelAuditTask.go index 13a0a2c53a0..f3a33ae7403 100644 --- a/service/iot/api_op_CancelAuditTask.go +++ b/service/iot/api_op_CancelAuditTask.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [CancelAuditTask] action. +// +// [CancelAuditTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CancelAuditTask(ctx context.Context, params *CancelAuditTaskInput, optFns ...func(*Options)) (*CancelAuditTaskOutput, error) { if params == nil { params = &CancelAuditTaskInput{} diff --git a/service/iot/api_op_CancelCertificateTransfer.go b/service/iot/api_op_CancelCertificateTransfer.go index 5ce20daf305..8d47a400a05 100644 --- a/service/iot/api_op_CancelCertificateTransfer.go +++ b/service/iot/api_op_CancelCertificateTransfer.go @@ -10,15 +10,19 @@ 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 -// destinations can use RejectCertificateTransfer instead.) After transfer, IoT -// returns the certificate to the source account in the INACTIVE state. After the +// 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 RejectCertificateTransferinstead.) 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) -// action. +// +// After a certificate transfer is cancelled, the status of the certificate +// changes from PENDING_TRANSFER to INACTIVE. +// +// Requires permission to access the [CancelCertificateTransfer] action. +// +// [CancelCertificateTransfer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CancelCertificateTransfer(ctx context.Context, params *CancelCertificateTransferInput, optFns ...func(*Options)) (*CancelCertificateTransferOutput, error) { if params == nil { params = &CancelCertificateTransferInput{} diff --git a/service/iot/api_op_CancelDetectMitigationActionsTask.go b/service/iot/api_op_CancelDetectMitigationActionsTask.go index 1bfe994b433..3efea7207dc 100644 --- a/service/iot/api_op_CancelDetectMitigationActionsTask.go +++ b/service/iot/api_op_CancelDetectMitigationActionsTask.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Cancels a Device Defender ML Detect mitigation action. +// +// Requires permission to access the [CancelDetectMitigationActionsTask] action. +// +// [CancelDetectMitigationActionsTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CancelDetectMitigationActionsTask(ctx context.Context, params *CancelDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*CancelDetectMitigationActionsTaskOutput, error) { if params == nil { params = &CancelDetectMitigationActionsTaskInput{} @@ -30,7 +32,7 @@ func (c *Client) CancelDetectMitigationActionsTask(ctx context.Context, params * type CancelDetectMitigationActionsTaskInput struct { - // The unique identifier of the task. + // The unique identifier of the task. // // This member is required. TaskId *string diff --git a/service/iot/api_op_CancelJob.go b/service/iot/api_op_CancelJob.go index 901928b21bf..c1a4e5fb258 100644 --- a/service/iot/api_op_CancelJob.go +++ b/service/iot/api_op_CancelJob.go @@ -10,8 +10,11 @@ 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) -// action. +// Cancels a job. +// +// Requires permission to access the [CancelJob] action. +// +// [CancelJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error) { if params == nil { params = &CancelJobInput{} @@ -39,10 +42,12 @@ 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 - // 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. + // 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. Force bool // (Optional)A reason code string that explains why the job was canceled. diff --git a/service/iot/api_op_CancelJobExecution.go b/service/iot/api_op_CancelJobExecution.go index 101052dd5d8..4ad4d2e4b40 100644 --- a/service/iot/api_op_CancelJobExecution.go +++ b/service/iot/api_op_CancelJobExecution.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Cancels the execution of a job for a given thing. +// +// Requires permission to access the [CancelJobExecution] action. +// +// [CancelJobExecution]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CancelJobExecution(ctx context.Context, params *CancelJobExecutionInput, optFns ...func(*Options)) (*CancelJobExecutionOutput, error) { if params == nil { params = &CancelJobExecutionInput{} @@ -53,10 +55,11 @@ type CancelJobExecutionInput struct { // 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 - // "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. + // 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. Force bool // A collection of name/value pairs that describe the status of the job execution. diff --git a/service/iot/api_op_ClearDefaultAuthorizer.go b/service/iot/api_op_ClearDefaultAuthorizer.go index 1d6a0b6163e..fc651b6bb19 100644 --- a/service/iot/api_op_ClearDefaultAuthorizer.go +++ b/service/iot/api_op_ClearDefaultAuthorizer.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Clears the default authorizer. +// +// Requires permission to access the [ClearDefaultAuthorizer] action. +// +// [ClearDefaultAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ClearDefaultAuthorizer(ctx context.Context, params *ClearDefaultAuthorizerInput, optFns ...func(*Options)) (*ClearDefaultAuthorizerOutput, error) { if params == nil { params = &ClearDefaultAuthorizerInput{} diff --git a/service/iot/api_op_ConfirmTopicRuleDestination.go b/service/iot/api_op_ConfirmTopicRuleDestination.go index 76edae7f79e..687ec60e0af 100644 --- a/service/iot/api_op_ConfirmTopicRuleDestination.go +++ b/service/iot/api_op_ConfirmTopicRuleDestination.go @@ -14,8 +14,11 @@ 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) -// action. +// endpoint. +// +// Requires permission to access the [ConfirmTopicRuleDestination] action. +// +// [ConfirmTopicRuleDestination]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ConfirmTopicRuleDestination(ctx context.Context, params *ConfirmTopicRuleDestinationInput, optFns ...func(*Options)) (*ConfirmTopicRuleDestinationOutput, error) { if params == nil { params = &ConfirmTopicRuleDestinationInput{} diff --git a/service/iot/api_op_CreateAuditSuppression.go b/service/iot/api_op_CreateAuditSuppression.go index b2fa57d941e..b23100c3b2d 100644 --- a/service/iot/api_op_CreateAuditSuppression.go +++ b/service/iot/api_op_CreateAuditSuppression.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Creates a Device Defender audit suppression. +// +// Requires permission to access the [CreateAuditSuppression] action. +// +// [CreateAuditSuppression]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateAuditSuppression(ctx context.Context, params *CreateAuditSuppressionInput, optFns ...func(*Options)) (*CreateAuditSuppressionOutput, error) { if params == nil { params = &CreateAuditSuppressionInput{} @@ -40,7 +42,7 @@ type CreateAuditSuppressionInput struct { // This member is required. CheckName *string - // Each audit supression must have a unique client request token. If you try to + // Each audit supression must have a unique client request token. If you try to // create a new audit suppression with the same token as one that already exists, // an exception occurs. If you omit this value, Amazon Web Services SDKs will // automatically generate a unique client request. @@ -53,13 +55,13 @@ type CreateAuditSuppressionInput struct { // This member is required. ResourceIdentifier *types.ResourceIdentifier - // The description of the audit suppression. + // The description of the audit suppression. Description *string - // The epoch timestamp in seconds at which this suppression expires. + // The epoch timestamp in seconds at which this suppression expires. ExpirationDate *time.Time - // Indicates whether a suppression should exist indefinitely or not. + // Indicates whether a suppression should exist indefinitely or not. SuppressIndefinitely *bool noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateAuthorizer.go b/service/iot/api_op_CreateAuthorizer.go index 7b449167592..4f9a6e865ba 100644 --- a/service/iot/api_op_CreateAuthorizer.go +++ b/service/iot/api_op_CreateAuthorizer.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates an authorizer. +// +// Requires permission to access the [CreateAuthorizer] action. +// +// [CreateAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerInput, optFns ...func(*Options)) (*CreateAuthorizerOutput, error) { if params == nil { params = &CreateAuthorizerInput{} @@ -43,8 +46,9 @@ type CreateAuthorizerInput struct { // 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 - // not affect authorization of clients that use MQTT connections. The default value - // is false . + // not affect authorization of clients that use MQTT connections. + // + // The default value is false . EnableCachingForHttp *bool // Specifies whether IoT validates the token signature in an authorization request. @@ -53,10 +57,14 @@ type CreateAuthorizerInput struct { // The status of the create authorizer request. Status types.AuthorizerStatus - // Metadata which can be used to manage the custom authorizer. For URI Request - // parameters use format: ...key1=value1&key2=value2... For the CLI command-line - // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json - // file use format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the custom authorizer. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: &&tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag // The name of the token key used to extract the token from the HTTP headers. diff --git a/service/iot/api_op_CreateBillingGroup.go b/service/iot/api_op_CreateBillingGroup.go index 328b0d1d411..3a1d2ebbe73 100644 --- a/service/iot/api_op_CreateBillingGroup.go +++ b/service/iot/api_op_CreateBillingGroup.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates a billing group. +// +// Requires permission to access the [CreateBillingGroup] action. +// +// [CreateBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateBillingGroup(ctx context.Context, params *CreateBillingGroupInput, optFns ...func(*Options)) (*CreateBillingGroupOutput, error) { if params == nil { params = &CreateBillingGroupInput{} diff --git a/service/iot/api_op_CreateCertificateFromCsr.go b/service/iot/api_op_CreateCertificateFromCsr.go index 797f10d530f..b0f43d853e8 100644 --- a/service/iot/api_op_CreateCertificateFromCsr.go +++ b/service/iot/api_op_CreateCertificateFromCsr.go @@ -11,33 +11,51 @@ 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) -// 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-256, NIST P-384, or NIST -// P-521 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 -// 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 -// 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 -// 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" +// +// Requires permission to access the [CreateCertificateFromCsr] 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-256, NIST P-384, or NIST P-521 curves. +// For supported certificates, consult [Certificate signing algorithms supported by IoT]. +// +// 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 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 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" +// +// [CreateCertificateFromCsr]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [Certificate signing algorithms supported by IoT]: https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html#x509-cert-algorithms 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_CreateCertificateProvider.go b/service/iot/api_op_CreateCertificateProvider.go index fc19e75b672..825ba308e64 100644 --- a/service/iot/api_op_CreateCertificateProvider.go +++ b/service/iot/api_op_CreateCertificateProvider.go @@ -14,15 +14,19 @@ import ( // Creates an Amazon Web Services IoT Core certificate provider. You can use // Amazon Web Services IoT Core certificate provider to customize how to sign a // certificate signing request (CSR) in IoT fleet provisioning. For more -// information, see Customizing certificate signing using Amazon Web Services IoT -// Core certificate provider (https://docs.aws.amazon.com/iot/latest/developerguide/provisioning-cert-provider.html) -// from Amazon Web Services IoT Core Developer Guide. Requires permission to access -// the CreateCertificateProvider (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. After you create a certificate provider, the behavior of -// CreateCertificateFromCsr API for fleet provisioning (https://docs.aws.amazon.com/iot/latest/developerguide/fleet-provision-api.html#create-cert-csr) -// will change and all API calls to CreateCertificateFromCsr will invoke the -// certificate provider to create the certificates. It can take up to a few minutes -// for this behavior to change after a certificate provider is created. +// information, see [Customizing certificate signing using Amazon Web Services IoT Core certificate provider]from Amazon Web Services IoT Core Developer Guide. +// +// Requires permission to access the [CreateCertificateProvider] action. +// +// After you create a certificate provider, the behavior of [CreateCertificateFromCsr API for fleet provisioning] +// CreateCertificateFromCsr will change and all API calls to +// CreateCertificateFromCsr will invoke the certificate provider to create the +// certificates. It can take up to a few minutes for this behavior to change after +// a certificate provider is created. +// +// [CreateCertificateProvider]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [CreateCertificateFromCsr API for fleet provisioning]: https://docs.aws.amazon.com/iot/latest/developerguide/fleet-provision-api.html#create-cert-csr +// [Customizing certificate signing using Amazon Web Services IoT Core certificate provider]: https://docs.aws.amazon.com/iot/latest/developerguide/provisioning-cert-provider.html func (c *Client) CreateCertificateProvider(ctx context.Context, params *CreateCertificateProviderInput, optFns ...func(*Options)) (*CreateCertificateProviderOutput, error) { if params == nil { params = &CreateCertificateProviderInput{} diff --git a/service/iot/api_op_CreateCustomMetric.go b/service/iot/api_op_CreateCustomMetric.go index c39ff8e1999..72095fdac2c 100644 --- a/service/iot/api_op_CreateCustomMetric.go +++ b/service/iot/api_op_CreateCustomMetric.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Use this API to define a Custom Metric published by your devices to Device +// +// Defender. +// +// Requires permission to access the [CreateCustomMetric] action. +// +// [CreateCustomMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateCustomMetric(ctx context.Context, params *CreateCustomMetricInput, optFns ...func(*Options)) (*CreateCustomMetricOutput, error) { if params == nil { params = &CreateCustomMetricInput{} @@ -39,26 +43,28 @@ type CreateCustomMetricInput struct { // 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. + // 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. // // This member is required. MetricName *string - // The type of the custom metric. The type number only takes a single metric value - // as an input, but when you submit the metrics value in the DeviceMetrics report, - // you must pass it as an array with a single value. + // The type of the custom metric. + // + // The type number only takes a single metric value as an input, but when you + // submit the metrics value in the DeviceMetrics report, you must pass it as an + // array with a single value. // // This member is required. MetricType types.CustomMetricType - // The friendly name in the console for the custom metric. This name doesn't have + // The friendly name in the console for the custom metric. This name doesn't have // to be unique. Don't use this name as the metric identifier in the device metric // report. You can update the friendly name after you define it. DisplayName *string - // Metadata that can be used to manage the custom metric. + // Metadata that can be used to manage the custom metric. Tags []types.Tag noSmithyDocumentSerde @@ -66,11 +72,11 @@ type CreateCustomMetricInput struct { type CreateCustomMetricOutput struct { - // The Amazon Resource Number (ARN) of the custom metric. For example, + // The Amazon Resource Number (ARN) of the custom metric. For example, // arn:aws-partition:iot:region:accountId:custommetric/metricName MetricArn *string - // The name of the custom metric to be used in the metric report. + // The name of the custom metric to be used in the metric report. MetricName *string // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_CreateDimension.go b/service/iot/api_op_CreateDimension.go index eb3ae5fd5f9..dbbf396664b 100644 --- a/service/iot/api_op_CreateDimension.go +++ b/service/iot/api_op_CreateDimension.go @@ -14,9 +14,11 @@ import ( // Create a dimension that you can use to limit the scope of a metric used in a // 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) -// action. +// name match the pattern specified in the dimension. +// +// Requires permission to access the [CreateDimension] action. +// +// [CreateDimension]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateDimension(ctx context.Context, params *CreateDimensionInput, optFns ...func(*Options)) (*CreateDimensionOutput, error) { if params == nil { params = &CreateDimensionInput{} diff --git a/service/iot/api_op_CreateDomainConfiguration.go b/service/iot/api_op_CreateDomainConfiguration.go index d97a9b0672e..94917267b0b 100644 --- a/service/iot/api_op_CreateDomainConfiguration.go +++ b/service/iot/api_op_CreateDomainConfiguration.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a domain configuration. +// +// Requires permission to access the [CreateDomainConfiguration] action. +// +// [CreateDomainConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateDomainConfiguration(ctx context.Context, params *CreateDomainConfigurationInput, optFns ...func(*Options)) (*CreateDomainConfigurationOutput, error) { if params == nil { params = &CreateDomainConfigurationInput{} @@ -50,14 +52,19 @@ type CreateDomainConfigurationInput struct { // The server certificate configuration. ServerCertificateConfig *types.ServerCertificateConfig - // The type of service delivered by the endpoint. Amazon Web Services IoT Core - // currently supports only the DATA service type. + // The type of service delivered by the endpoint. + // + // Amazon Web Services IoT Core currently supports only the DATA service type. ServiceType types.ServiceType - // Metadata which can be used to manage the domain configuration. For URI Request - // parameters use format: ...key1=value1&key2=value2... For the CLI command-line - // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json - // file use format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the domain configuration. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: &&tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag // An object that specifies the TLS configuration for a domain. diff --git a/service/iot/api_op_CreateDynamicThingGroup.go b/service/iot/api_op_CreateDynamicThingGroup.go index 2c2c06c1277..79c8983f0d4 100644 --- a/service/iot/api_op_CreateDynamicThingGroup.go +++ b/service/iot/api_op_CreateDynamicThingGroup.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a dynamic thing group. +// +// Requires permission to access the [CreateDynamicThingGroup] action. +// +// [CreateDynamicThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateDynamicThingGroup(ctx context.Context, params *CreateDynamicThingGroupInput, optFns ...func(*Options)) (*CreateDynamicThingGroupOutput, error) { if params == nil { params = &CreateDynamicThingGroupInput{} @@ -31,8 +33,11 @@ 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] for information about query string syntax. + // + // [Query Syntax]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html // // This member is required. QueryString *string @@ -42,13 +47,15 @@ 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 282370fda5d..b09661371b2 100644 --- a/service/iot/api_op_CreateFleetMetric.go +++ b/service/iot/api_op_CreateFleetMetric.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates a fleet metric. +// +// Requires permission to access the [CreateFleetMetric] action. +// +// [CreateFleetMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateFleetMetric(ctx context.Context, params *CreateFleetMetricInput, optFns ...func(*Options)) (*CreateFleetMetricOutput, error) { if params == nil { params = &CreateFleetMetricInput{} @@ -69,8 +72,9 @@ 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]. Default to null. + // + // [CW metric]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html Unit types.FleetMetricUnit noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateJob.go b/service/iot/api_op_CreateJob.go index c09e8296457..9d213ca618c 100644 --- a/service/iot/api_op_CreateJob.go +++ b/service/iot/api_op_CreateJob.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates a job. +// +// Requires permission to access the [CreateJob] action. +// +// [CreateJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { params = &CreateJobInput{} @@ -51,26 +54,34 @@ type CreateJobInput struct { // The package version Amazon Resource Names (ARNs) that are installed on the // device when the job successfully completes. The package version must be in // either the Published or Deprecated state when the job deploys. For more - // information, see Package version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . Note:The following Length Constraints relates to a single ARN. Up to 25 - // package version ARNs are allowed. + // information, see [Package version lifecycle]. + // + // Note:The following Length Constraints relates to a single ARN. Up to 25 package + // version ARNs are allowed. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle DestinationPackageVersions []string // 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 - // create the job document. 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. + // create the job document. + // + // 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 map[string]string // An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 - // object URL and is required if you don't specify a value for document . For - // example, --document-source - // https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0 For - // more information, see Methods for accessing a bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html) - // . + // object URL and is required if you don't specify a value for document . + // + // For example, --document-source + // https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0 + // + // For more information, see [Methods for accessing a bucket]. + // + // [Methods for accessing a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html DocumentSource *string // Allows you to create the criteria to retry a job. @@ -82,12 +93,18 @@ type CreateJobInput struct { // The ARN of the job template used to create the job. JobTemplateArn *string - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string // Configuration information for pre-signed S3 URLs. @@ -105,10 +122,11 @@ type CreateJobInput struct { // (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. + // 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 diff --git a/service/iot/api_op_CreateJobTemplate.go b/service/iot/api_op_CreateJobTemplate.go index cbbb0704843..1f9d366be88 100644 --- a/service/iot/api_op_CreateJobTemplate.go +++ b/service/iot/api_op_CreateJobTemplate.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates a job template. +// +// Requires permission to access the [CreateJobTemplate] action. +// +// [CreateJobTemplate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateJobTemplate(ctx context.Context, params *CreateJobTemplateInput, optFns ...func(*Options)) (*CreateJobTemplateOutput, error) { if params == nil { params = &CreateJobTemplateInput{} @@ -47,20 +50,26 @@ type CreateJobTemplateInput struct { // The package version Amazon Resource Names (ARNs) that are installed on the // device when the job successfully completes. The package version must be in // either the Published or Deprecated state when the job deploys. For more - // information, see Package version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . Note:The following Length Constraints relates to a single ARN. Up to 25 - // package version ARNs are allowed. + // information, see [Package version lifecycle]. + // + // Note:The following Length Constraints relates to a single ARN. Up to 25 package + // version ARNs are allowed. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle DestinationPackageVersions []string // The job document. Required if you don't specify a value for documentSource . Document *string // An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 - // object URL and is required if you don't specify a value for document . For - // example, --document-source - // https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0 For - // more information, see Methods for accessing a bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html) - // . + // object URL and is required if you don't specify a value for document . + // + // For example, --document-source + // https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0 + // + // For more information, see [Methods for accessing a bucket]. + // + // [Methods for accessing a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html DocumentSource *string // The ARN of the job to use as the basis for the job template. diff --git a/service/iot/api_op_CreateKeysAndCertificate.go b/service/iot/api_op_CreateKeysAndCertificate.go index 17bbd8c2786..bd06247688f 100644 --- a/service/iot/api_op_CreateKeysAndCertificate.go +++ b/service/iot/api_op_CreateKeysAndCertificate.go @@ -13,11 +13,15 @@ import ( // 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) -// action. +// device, for more information, see [Provisioning 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] action. +// +// [CreateKeysAndCertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [Provisioning MQTT API]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#provision-mqtt-api func (c *Client) CreateKeysAndCertificate(ctx context.Context, params *CreateKeysAndCertificateInput, optFns ...func(*Options)) (*CreateKeysAndCertificateOutput, error) { if params == nil { params = &CreateKeysAndCertificateInput{} @@ -33,9 +37,11 @@ func (c *Client) CreateKeysAndCertificate(ctx context.Context, params *CreateKey return out, nil } -// 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) -// action. +// The input for the CreateKeysAndCertificate operation. +// +// Requires permission to access the [CreateKeysAndCertificateRequest] action. +// +// [CreateKeysAndCertificateRequest]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions type CreateKeysAndCertificateInput struct { // Specifies whether the certificate is active. diff --git a/service/iot/api_op_CreateMitigationAction.go b/service/iot/api_op_CreateMitigationAction.go index 0a14fd97167..d92ac5514c4 100644 --- a/service/iot/api_op_CreateMitigationAction.go +++ b/service/iot/api_op_CreateMitigationAction.go @@ -13,10 +13,13 @@ 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) -// action. +// applied to specific check names. For more information, see [Mitigation actions]. Each mitigation +// action can apply only one type of change. +// +// Requires permission to access the [CreateMitigationAction] action. +// +// [Mitigation actions]: https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-mitigation-actions.html +// [CreateMitigationAction]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateMitigationAction(ctx context.Context, params *CreateMitigationActionInput, optFns ...func(*Options)) (*CreateMitigationActionOutput, error) { if params == nil { params = &CreateMitigationActionInput{} diff --git a/service/iot/api_op_CreateOTAUpdate.go b/service/iot/api_op_CreateOTAUpdate.go index d86ceb95330..00689842c44 100644 --- a/service/iot/api_op_CreateOTAUpdate.go +++ b/service/iot/api_op_CreateOTAUpdate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates an IoT OTA update on a target group of things or groups. +// +// Requires permission to access the [CreateOTAUpdate] action. +// +// [CreateOTAUpdate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateOTAUpdate(ctx context.Context, params *CreateOTAUpdateInput, optFns ...func(*Options)) (*CreateOTAUpdateOutput, error) { if params == nil { params = &CreateOTAUpdateInput{} diff --git a/service/iot/api_op_CreatePackage.go b/service/iot/api_op_CreatePackage.go index 2c2f83ab8f4..81062f42e00 100644 --- a/service/iot/api_op_CreatePackage.go +++ b/service/iot/api_op_CreatePackage.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an IoT software package that can be deployed to your fleet. Requires -// permission to access the CreatePackage (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// and GetIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// actions. +// Creates an IoT software package that can be deployed to your fleet. +// +// Requires permission to access the [CreatePackage] and [GetIndexingConfiguration] actions. +// +// [CreatePackage]: 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 func (c *Client) CreatePackage(ctx context.Context, params *CreatePackageInput, optFns ...func(*Options)) (*CreatePackageOutput, error) { if params == nil { params = &CreatePackageInput{} diff --git a/service/iot/api_op_CreatePackageVersion.go b/service/iot/api_op_CreatePackageVersion.go index 6623e4f4b9b..955c20c4ea8 100644 --- a/service/iot/api_op_CreatePackageVersion.go +++ b/service/iot/api_op_CreatePackageVersion.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new version for an existing IoT software package. Requires permission -// to access the CreatePackageVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// and GetIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// actions. +// Creates a new version for an existing IoT software package. +// +// Requires permission to access the [CreatePackageVersion] and [GetIndexingConfiguration] actions. +// +// [CreatePackageVersion]: 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 func (c *Client) CreatePackageVersion(ctx context.Context, params *CreatePackageVersionInput, optFns ...func(*Options)) (*CreatePackageVersionOutput, error) { if params == nil { params = &CreatePackageVersionInput{} @@ -44,8 +46,9 @@ type CreatePackageVersionInput struct { // Metadata that can be used to define a package version’s configuration. For // example, the S3 file location, configuration options that are being sent to the - // device or fleet. The combined size of all the attributes on a package version is - // limited to 3KB. + // device or fleet. + // + // The combined size of all the attributes on a package version is limited to 3KB. Attributes map[string]string // A unique case-sensitive identifier that you can provide to ensure the @@ -81,9 +84,9 @@ type CreatePackageVersionOutput struct { // The Amazon Resource Name (ARN) for the package. PackageVersionArn *string - // The status of the package version. For more information, see Package version - // lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . + // The status of the package version. For more information, see [Package version lifecycle]. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle Status types.PackageVersionStatus // The name of the new package version. diff --git a/service/iot/api_op_CreatePolicy.go b/service/iot/api_op_CreatePolicy.go index 5918bcb0c4b..8d6e2b07c53 100644 --- a/service/iot/api_op_CreatePolicy.go +++ b/service/iot/api_op_CreatePolicy.go @@ -11,11 +11,15 @@ 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) -// action. +// 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] action. +// +// [CreatePolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { if params == nil { params = &CreatePolicyInput{} @@ -45,10 +49,14 @@ type CreatePolicyInput struct { // This member is required. PolicyName *string - // Metadata which can be used to manage the policy. For URI Request parameters use - // format: ...key1=value1&key2=value2... For the CLI command-line parameter use - // format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use - // format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the policy. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: &&tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iot/api_op_CreatePolicyVersion.go b/service/iot/api_op_CreatePolicyVersion.go index 66264317368..62982043826 100644 --- a/service/iot/api_op_CreatePolicyVersion.go +++ b/service/iot/api_op_CreatePolicyVersion.go @@ -12,12 +12,16 @@ import ( // Creates a new version of the specified IoT policy. To update a policy, create a // new policy version. A managed policy can have up to five versions. If the policy -// has five versions, you must use DeletePolicyVersion to delete an existing -// 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) -// action. +// has five versions, you must use DeletePolicyVersionto delete an existing 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] action. +// +// [CreatePolicyVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreatePolicyVersion(ctx context.Context, params *CreatePolicyVersionInput, optFns ...func(*Options)) (*CreatePolicyVersionOutput, error) { if params == nil { params = &CreatePolicyVersionInput{} diff --git a/service/iot/api_op_CreateProvisioningClaim.go b/service/iot/api_op_CreateProvisioningClaim.go index e9b07a9a601..59e9aad90e6 100644 --- a/service/iot/api_op_CreateProvisioningClaim.go +++ b/service/iot/api_op_CreateProvisioningClaim.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Creates a provisioning claim. +// +// Requires permission to access the [CreateProvisioningClaim] action. +// +// [CreateProvisioningClaim]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateProvisioningClaim(ctx context.Context, params *CreateProvisioningClaimInput, optFns ...func(*Options)) (*CreateProvisioningClaimOutput, error) { if params == nil { params = &CreateProvisioningClaimInput{} diff --git a/service/iot/api_op_CreateProvisioningTemplate.go b/service/iot/api_op_CreateProvisioningTemplate.go index 26cc2402e0b..5cde1d81a46 100644 --- a/service/iot/api_op_CreateProvisioningTemplate.go +++ b/service/iot/api_op_CreateProvisioningTemplate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a provisioning template. +// +// Requires permission to access the [CreateProvisioningTemplate] action. +// +// [CreateProvisioningTemplate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateProvisioningTemplate(ctx context.Context, params *CreateProvisioningTemplateInput, optFns ...func(*Options)) (*CreateProvisioningTemplateOutput, error) { if params == nil { params = &CreateProvisioningTemplateInput{} @@ -54,22 +56,28 @@ 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] // . + // + // [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 - // parameters use format: ...key1=value1&key2=value2... For the CLI command-line - // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json - // file use format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the provisioning template. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: &&tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag // 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) - // . + // template, see: [Provisioning template]. + // + // [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 4e61cda0281..c88e21fb227 100644 --- a/service/iot/api_op_CreateProvisioningTemplateVersion.go +++ b/service/iot/api_op_CreateProvisioningTemplateVersion.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a new version of a provisioning template. +// +// Requires permission to access the [CreateProvisioningTemplateVersion] action. +// +// [CreateProvisioningTemplateVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateProvisioningTemplateVersion(ctx context.Context, params *CreateProvisioningTemplateVersionInput, optFns ...func(*Options)) (*CreateProvisioningTemplateVersionOutput, error) { if params == nil { params = &CreateProvisioningTemplateVersionInput{} diff --git a/service/iot/api_op_CreateRoleAlias.go b/service/iot/api_op_CreateRoleAlias.go index ca4abd9cc95..72a9babf1ab 100644 --- a/service/iot/api_op_CreateRoleAlias.go +++ b/service/iot/api_op_CreateRoleAlias.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates a role alias. +// +// Requires permission to access the [CreateRoleAlias] action. +// +// [CreateRoleAlias]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateRoleAlias(ctx context.Context, params *CreateRoleAliasInput, optFns ...func(*Options)) (*CreateRoleAliasOutput, error) { if params == nil { params = &CreateRoleAliasInput{} @@ -42,14 +45,20 @@ type CreateRoleAliasInput struct { RoleArn *string // How long (in seconds) the credentials will be valid. The default value is 3,600 - // seconds. This value must be less than or equal to the maximum session duration - // of the IAM role that the role alias references. + // seconds. + // + // This value must be less than or equal to the maximum session duration of the + // IAM role that the role alias references. CredentialDurationSeconds *int32 - // Metadata which can be used to manage the role alias. For URI Request parameters - // use format: ...key1=value1&key2=value2... For the CLI command-line parameter use - // format: &&tags "key1=value1&key2=value2..." For the cli-input-json file use - // format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the role alias. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: &&tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateScheduledAudit.go b/service/iot/api_op_CreateScheduledAudit.go index bc6a5f978a2..183538dfe54 100644 --- a/service/iot/api_op_CreateScheduledAudit.go +++ b/service/iot/api_op_CreateScheduledAudit.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a scheduled audit that is run at a specified time interval. +// +// Requires permission to access the [CreateScheduledAudit] action. +// +// [CreateScheduledAudit]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateScheduledAudit(ctx context.Context, params *CreateScheduledAuditInput, optFns ...func(*Options)) (*CreateScheduledAuditOutput, error) { if params == nil { params = &CreateScheduledAuditInput{} diff --git a/service/iot/api_op_CreateSecurityProfile.go b/service/iot/api_op_CreateSecurityProfile.go index 602acdfd8c9..f9d685183cd 100644 --- a/service/iot/api_op_CreateSecurityProfile.go +++ b/service/iot/api_op_CreateSecurityProfile.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a Device Defender security profile. +// +// Requires permission to access the [CreateSecurityProfile] action. +// +// [CreateSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateSecurityProfile(ctx context.Context, params *CreateSecurityProfileInput, optFns ...func(*Options)) (*CreateSecurityProfileOutput, error) { if params == nil { params = &CreateSecurityProfileInput{} @@ -36,8 +38,9 @@ type CreateSecurityProfileInput struct { // This member is required. SecurityProfileName *string - // Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead. A - // list of metrics whose data is retained (stored). By default, data is retained + // 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 // metric specified here. Can be used with custom metrics; cannot be used with // dimensions. diff --git a/service/iot/api_op_CreateStream.go b/service/iot/api_op_CreateStream.go index fe42c694345..161458c8ac1 100644 --- a/service/iot/api_op_CreateStream.go +++ b/service/iot/api_op_CreateStream.go @@ -14,8 +14,10 @@ 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) -// action. +// +// Requires permission to access the [CreateStream] action. +// +// [CreateStream]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error) { if params == nil { params = &CreateStreamInput{} diff --git a/service/iot/api_op_CreateThing.go b/service/iot/api_op_CreateThing.go index b510f91fead..214dc0c627f 100644 --- a/service/iot/api_op_CreateThing.go +++ b/service/iot/api_op_CreateThing.go @@ -14,11 +14,15 @@ import ( // Creates a thing record in the registry. If this call is made multiple times // 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) -// 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) -// action. +// ResourceAlreadyExistsException is thrown. +// +// This is a control plane operation. See [Authorization] for information about authorizing +// control plane actions. +// +// Requires permission to access the [CreateThing] action. +// +// [Authorization]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html +// [CreateThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateThing(ctx context.Context, params *CreateThingInput, optFns ...func(*Options)) (*CreateThingOutput, error) { if params == nil { params = &CreateThingInput{} @@ -37,15 +41,19 @@ func (c *Client) CreateThing(ctx context.Context, params *CreateThingInput, optF // The input for the CreateThing operation. type CreateThingInput struct { - // The name of the thing to create. You can't change a thing's name after you - // create it. To change a thing's name, you must create a new thing, give it the - // new name, and then delete the old thing. + // The name of the thing to create. + // + // You can't change a thing's name after you create it. To change a thing's name, + // you must create a new thing, give it the new name, and then delete the old + // thing. // // This member is required. ThingName *string // The attribute payload, which consists of up to three name/value pairs in a JSON - // document. For example: {\"attributes\":{\"string1\":\"string2\"}} + // document. For example: + // + // {\"attributes\":{\"string1\":\"string2\"}} AttributePayload *types.AttributePayload // The name of the billing group the thing will be added to. diff --git a/service/iot/api_op_CreateThingGroup.go b/service/iot/api_op_CreateThingGroup.go index 816d5b3de05..6037f6800f9 100644 --- a/service/iot/api_op_CreateThingGroup.go +++ b/service/iot/api_op_CreateThingGroup.go @@ -11,11 +11,18 @@ 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) -// for information about authorizing control plane actions. If the ThingGroup that -// you create has the exact same attributes as an existing ThingGroup , you will -// get a 200 success response. Requires permission to access the CreateThingGroup (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Create a thing group. +// +// This is a control plane operation. See [Authorization] for information about authorizing +// control plane actions. +// +// If the ThingGroup that you create has the exact same attributes as an existing +// ThingGroup , you will get a 200 success response. +// +// Requires permission to access the [CreateThingGroup] action. +// +// [Authorization]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html +// [CreateThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateThingGroup(ctx context.Context, params *CreateThingGroupInput, optFns ...func(*Options)) (*CreateThingGroupOutput, error) { if params == nil { params = &CreateThingGroupInput{} diff --git a/service/iot/api_op_CreateThingType.go b/service/iot/api_op_CreateThingType.go index 50a48b29d6e..beaeb87a29d 100644 --- a/service/iot/api_op_CreateThingType.go +++ b/service/iot/api_op_CreateThingType.go @@ -11,8 +11,11 @@ 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) -// action. +// Creates a new thing type. +// +// Requires permission to access the [CreateThingType] action. +// +// [CreateThingType]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateThingType(ctx context.Context, params *CreateThingTypeInput, optFns ...func(*Options)) (*CreateThingTypeOutput, error) { if params == nil { params = &CreateThingTypeInput{} diff --git a/service/iot/api_op_CreateTopicRule.go b/service/iot/api_op_CreateTopicRule.go index 2e5a29b8df4..35445f735bd 100644 --- a/service/iot/api_op_CreateTopicRule.go +++ b/service/iot/api_op_CreateTopicRule.go @@ -13,8 +13,11 @@ 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) -// action. +// rule. +// +// Requires permission to access the [CreateTopicRule] action. +// +// [CreateTopicRule]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateTopicRule(ctx context.Context, params *CreateTopicRuleInput, optFns ...func(*Options)) (*CreateTopicRuleOutput, error) { if params == nil { params = &CreateTopicRuleInput{} @@ -43,10 +46,14 @@ type CreateTopicRuleInput struct { // This member is required. TopicRulePayload *types.TopicRulePayload - // Metadata which can be used to manage the topic rule. For URI Request parameters - // use format: ...key1=value1&key2=value2... For the CLI command-line parameter use - // format: --tags "key1=value1&key2=value2..." For the cli-input-json file use - // format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the topic rule. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: --tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags *string noSmithyDocumentSerde diff --git a/service/iot/api_op_CreateTopicRuleDestination.go b/service/iot/api_op_CreateTopicRuleDestination.go index 40f47db967e..26106f0afbb 100644 --- a/service/iot/api_op_CreateTopicRuleDestination.go +++ b/service/iot/api_op_CreateTopicRuleDestination.go @@ -12,8 +12,11 @@ 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) -// action. +// use. +// +// Requires permission to access the [CreateTopicRuleDestination] action. +// +// [CreateTopicRuleDestination]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateTopicRuleDestination(ctx context.Context, params *CreateTopicRuleDestinationInput, optFns ...func(*Options)) (*CreateTopicRuleDestinationOutput, error) { if params == nil { params = &CreateTopicRuleDestinationInput{} diff --git a/service/iot/api_op_DeleteAccountAuditConfiguration.go b/service/iot/api_op_DeleteAccountAuditConfiguration.go index 72c79037cdc..a0d3a4d21b4 100644 --- a/service/iot/api_op_DeleteAccountAuditConfiguration.go +++ b/service/iot/api_op_DeleteAccountAuditConfiguration.go @@ -12,8 +12,11 @@ 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) -// action. +// disabled. +// +// Requires permission to access the [DeleteAccountAuditConfiguration] action. +// +// [DeleteAccountAuditConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteAccountAuditConfiguration(ctx context.Context, params *DeleteAccountAuditConfigurationInput, optFns ...func(*Options)) (*DeleteAccountAuditConfigurationOutput, error) { if params == nil { params = &DeleteAccountAuditConfigurationInput{} diff --git a/service/iot/api_op_DeleteAuditSuppression.go b/service/iot/api_op_DeleteAuditSuppression.go index c223dede0cf..052086ca69c 100644 --- a/service/iot/api_op_DeleteAuditSuppression.go +++ b/service/iot/api_op_DeleteAuditSuppression.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a Device Defender audit suppression. +// +// Requires permission to access the [DeleteAuditSuppression] action. +// +// [DeleteAuditSuppression]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteAuditSuppression(ctx context.Context, params *DeleteAuditSuppressionInput, optFns ...func(*Options)) (*DeleteAuditSuppressionOutput, error) { if params == nil { params = &DeleteAuditSuppressionInput{} diff --git a/service/iot/api_op_DeleteAuthorizer.go b/service/iot/api_op_DeleteAuthorizer.go index e1b14adc3ab..61921e11976 100644 --- a/service/iot/api_op_DeleteAuthorizer.go +++ b/service/iot/api_op_DeleteAuthorizer.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes an authorizer. +// +// Requires permission to access the [DeleteAuthorizer] action. +// +// [DeleteAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerInput, optFns ...func(*Options)) (*DeleteAuthorizerOutput, error) { if params == nil { params = &DeleteAuthorizerInput{} diff --git a/service/iot/api_op_DeleteBillingGroup.go b/service/iot/api_op_DeleteBillingGroup.go index 0c9ba645b5b..3e13d0cc707 100644 --- a/service/iot/api_op_DeleteBillingGroup.go +++ b/service/iot/api_op_DeleteBillingGroup.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes the billing group. +// +// Requires permission to access the [DeleteBillingGroup] action. +// +// [DeleteBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteBillingGroup(ctx context.Context, params *DeleteBillingGroupInput, optFns ...func(*Options)) (*DeleteBillingGroupOutput, error) { if params == nil { params = &DeleteBillingGroupInput{} diff --git a/service/iot/api_op_DeleteCACertificate.go b/service/iot/api_op_DeleteCACertificate.go index 4801a62b310..b9ffda446e3 100644 --- a/service/iot/api_op_DeleteCACertificate.go +++ b/service/iot/api_op_DeleteCACertificate.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a registered CA certificate. +// +// Requires permission to access the [DeleteCACertificate] action. +// +// [DeleteCACertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteCACertificate(ctx context.Context, params *DeleteCACertificateInput, optFns ...func(*Options)) (*DeleteCACertificateOutput, error) { if params == nil { params = &DeleteCACertificateInput{} diff --git a/service/iot/api_op_DeleteCertificate.go b/service/iot/api_op_DeleteCertificate.go index ef363257833..e4b03b09255 100644 --- a/service/iot/api_op_DeleteCertificate.go +++ b/service/iot/api_op_DeleteCertificate.go @@ -10,12 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified certificate. A certificate cannot be deleted if it has a -// 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) -// action. +// Deletes the specified certificate. +// +// A certificate cannot be deleted if it has a 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 UpdateCertificateaction to set the certificate to +// the INACTIVE status. +// +// Requires permission to access the [DeleteCertificate] action. +// +// [DeleteCertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error) { if params == nil { params = &DeleteCertificateInput{} diff --git a/service/iot/api_op_DeleteCertificateProvider.go b/service/iot/api_op_DeleteCertificateProvider.go index bf4b68f3efc..de07abbba7b 100644 --- a/service/iot/api_op_DeleteCertificateProvider.go +++ b/service/iot/api_op_DeleteCertificateProvider.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a certificate provider. Requires permission to access the -// DeleteCertificateProvider (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. If you delete the certificate provider resource, the behavior of +// Deletes a certificate provider. +// +// Requires permission to access the [DeleteCertificateProvider] action. +// +// If you delete the certificate provider resource, the behavior of // CreateCertificateFromCsr will resume, and IoT will create certificates signed by // IoT from a certificate signing request (CSR). +// +// [DeleteCertificateProvider]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteCertificateProvider(ctx context.Context, params *DeleteCertificateProviderInput, optFns ...func(*Options)) (*DeleteCertificateProviderOutput, error) { if params == nil { params = &DeleteCertificateProviderInput{} diff --git a/service/iot/api_op_DeleteCustomMetric.go b/service/iot/api_op_DeleteCustomMetric.go index 03cac54b715..f2bec43a51f 100644 --- a/service/iot/api_op_DeleteCustomMetric.go +++ b/service/iot/api_op_DeleteCustomMetric.go @@ -10,12 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// API with metricName set to your custom metric name. +// Deletes a Device Defender detect custom metric. +// +// Requires permission to access the [DeleteCustomMetric] 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]API with metricName set to your custom +// metric name. +// +// [DeleteCustomMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [ListSecurityProfiles]: https://docs.aws.amazon.com/iot/latest/apireference/API_ListSecurityProfiles.html func (c *Client) DeleteCustomMetric(ctx context.Context, params *DeleteCustomMetricInput, optFns ...func(*Options)) (*DeleteCustomMetricOutput, error) { if params == nil { params = &DeleteCustomMetricInput{} @@ -33,7 +38,7 @@ func (c *Client) DeleteCustomMetric(ctx context.Context, params *DeleteCustomMet type DeleteCustomMetricInput struct { - // The name of the custom metric. + // The name of the custom metric. // // This member is required. MetricName *string diff --git a/service/iot/api_op_DeleteDimension.go b/service/iot/api_op_DeleteDimension.go index cdca547088b..ff9409f091a 100644 --- a/service/iot/api_op_DeleteDimension.go +++ b/service/iot/api_op_DeleteDimension.go @@ -11,8 +11,10 @@ import ( ) // 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. +// +// Requires permission to access the [DeleteDimension] action. +// +// [DeleteDimension]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteDimension(ctx context.Context, params *DeleteDimensionInput, optFns ...func(*Options)) (*DeleteDimensionOutput, error) { if params == nil { params = &DeleteDimensionInput{} diff --git a/service/iot/api_op_DeleteDomainConfiguration.go b/service/iot/api_op_DeleteDomainConfiguration.go index ce6ea46d5e4..a9383501061 100644 --- a/service/iot/api_op_DeleteDomainConfiguration.go +++ b/service/iot/api_op_DeleteDomainConfiguration.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes the specified domain configuration. +// +// Requires permission to access the [DeleteDomainConfiguration] action. +// +// [DeleteDomainConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteDomainConfiguration(ctx context.Context, params *DeleteDomainConfigurationInput, optFns ...func(*Options)) (*DeleteDomainConfigurationOutput, error) { if params == nil { params = &DeleteDomainConfigurationInput{} diff --git a/service/iot/api_op_DeleteDynamicThingGroup.go b/service/iot/api_op_DeleteDynamicThingGroup.go index 3d989d46b8d..da585b2083b 100644 --- a/service/iot/api_op_DeleteDynamicThingGroup.go +++ b/service/iot/api_op_DeleteDynamicThingGroup.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a dynamic thing group. +// +// Requires permission to access the [DeleteDynamicThingGroup] action. +// +// [DeleteDynamicThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteDynamicThingGroup(ctx context.Context, params *DeleteDynamicThingGroupInput, optFns ...func(*Options)) (*DeleteDynamicThingGroupOutput, error) { if params == nil { params = &DeleteDynamicThingGroupInput{} diff --git a/service/iot/api_op_DeleteFleetMetric.go b/service/iot/api_op_DeleteFleetMetric.go index 5aee559b7e8..89888ea4781 100644 --- a/service/iot/api_op_DeleteFleetMetric.go +++ b/service/iot/api_op_DeleteFleetMetric.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [DeleteFleetMetric] action. +// +// [DeleteFleetMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteFleetMetric(ctx context.Context, params *DeleteFleetMetricInput, optFns ...func(*Options)) (*DeleteFleetMetricOutput, error) { if params == nil { params = &DeleteFleetMetricInput{} diff --git a/service/iot/api_op_DeleteJob.go b/service/iot/api_op_DeleteJob.go index 9e08d70d844..7ac15b00e32 100644 --- a/service/iot/api_op_DeleteJob.go +++ b/service/iot/api_op_DeleteJob.go @@ -10,14 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a job and its related job executions. Deleting a job may take time, -// depending on the number of job executions created for the job and various other -// factors. While the job is being deleted, the status of the job will be shown as -// "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) -// action. +// Deletes a job and its related job executions. +// +// Deleting a job may take time, depending on the number of job executions created +// for the job and various other factors. While the job is being deleted, the +// status of the job will be shown as "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] action. +// +// [DeleteJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns ...func(*Options)) (*DeleteJobOutput, error) { if params == nil { params = &DeleteJobInput{} @@ -35,29 +41,37 @@ func (c *Client) DeleteJob(ctx context.Context, params *DeleteJobInput, optFns . type DeleteJobInput struct { - // The ID of the job to be deleted. After a job deletion is completed, you may - // reuse this jobId when you create a new job. However, this is not recommended, - // and you must ensure that your devices are not using the jobId to refer to the - // deleted job. + // The ID of the job to be deleted. + // + // After a job deletion is completed, you may reuse this jobId when you create a + // new job. However, this is not recommended, and you must ensure that your devices + // are not using the jobId to refer to the deleted job. // // This member is required. JobId *string // (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, // you can only delete a job which is in a terminal state ("COMPLETED" or - // "CANCELED") or an exception will occur. The default is false. Deleting a job - // which is "IN_PROGRESS", will cause a device which is executing the job to be - // unable to access job information or update the job execution status. Use caution - // and ensure that each device executing a job which is deleted is able to recover - // to a valid state. + // "CANCELED") or an exception will occur. The default is false. + // + // Deleting a job which is "IN_PROGRESS", will cause a device which is executing + // the job to be unable to access job information or update the job execution + // status. Use caution and ensure that each device executing a job which is deleted + // is able to recover to a valid state. Force bool - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string noSmithyDocumentSerde diff --git a/service/iot/api_op_DeleteJobExecution.go b/service/iot/api_op_DeleteJobExecution.go index af4712c5c53..07fddc42e73 100644 --- a/service/iot/api_op_DeleteJobExecution.go +++ b/service/iot/api_op_DeleteJobExecution.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes a job execution. +// +// Requires permission to access the [DeleteJobExecution] action. +// +// [DeleteJobExecution]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteJobExecution(ctx context.Context, params *DeleteJobExecutionInput, optFns ...func(*Options)) (*DeleteJobExecutionOutput, error) { if params == nil { params = &DeleteJobExecutionInput{} @@ -30,9 +33,10 @@ func (c *Client) DeleteJobExecution(ctx context.Context, params *DeleteJobExecut type DeleteJobExecutionInput struct { // The ID of the job execution to be deleted. The executionNumber refers to the - // execution of a particular job on a particular device. Note that once a job - // execution is deleted, the executionNumber may be reused by IoT, so be sure you - // get and use the correct value here. + // execution of a particular job on a particular device. + // + // Note that once a job execution is deleted, the executionNumber may be reused by + // IoT, so be sure you get and use the correct value here. // // This member is required. ExecutionNumber *int64 @@ -50,18 +54,25 @@ type DeleteJobExecutionInput struct { // (Optional) When true, you can delete a job execution which is "IN_PROGRESS". // Otherwise, you can only delete a job execution which is in a terminal state // ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception - // will occur. The default is false. Deleting a job execution which is - // "IN_PROGRESS", will cause the device to be unable to access job information or - // update the job execution status. Use caution and ensure that the device is able - // to recover to a valid state. + // will occur. The default is false. + // + // Deleting a job execution which is "IN_PROGRESS", will cause the device to be + // unable to access job information or update the job execution status. Use caution + // and ensure that the device is able to recover to a valid state. Force bool - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string noSmithyDocumentSerde diff --git a/service/iot/api_op_DeleteMitigationAction.go b/service/iot/api_op_DeleteMitigationAction.go index 9a6eb1c9240..db8675af098 100644 --- a/service/iot/api_op_DeleteMitigationAction.go +++ b/service/iot/api_op_DeleteMitigationAction.go @@ -11,8 +11,10 @@ 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) -// action. +// +// Requires permission to access the [DeleteMitigationAction] action. +// +// [DeleteMitigationAction]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteMitigationAction(ctx context.Context, params *DeleteMitigationActionInput, optFns ...func(*Options)) (*DeleteMitigationActionOutput, error) { if params == nil { params = &DeleteMitigationActionInput{} diff --git a/service/iot/api_op_DeleteOTAUpdate.go b/service/iot/api_op_DeleteOTAUpdate.go index 41230442de4..1ea0338886d 100644 --- a/service/iot/api_op_DeleteOTAUpdate.go +++ b/service/iot/api_op_DeleteOTAUpdate.go @@ -10,8 +10,11 @@ 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) -// action. +// Delete an OTA update. +// +// Requires permission to access the [DeleteOTAUpdate] action. +// +// [DeleteOTAUpdate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteOTAUpdate(ctx context.Context, params *DeleteOTAUpdateInput, optFns ...func(*Options)) (*DeleteOTAUpdateOutput, error) { if params == nil { params = &DeleteOTAUpdateInput{} diff --git a/service/iot/api_op_DeletePackage.go b/service/iot/api_op_DeletePackage.go index 4ff8440064f..d1844d663ba 100644 --- a/service/iot/api_op_DeletePackage.go +++ b/service/iot/api_op_DeletePackage.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specific version from a software package. Note: All package versions -// must be deleted before deleting the software package. Requires permission to -// access the DeletePackageVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Deletes a specific version from a software package. +// +// Note: All package versions must be deleted before deleting the software package. +// +// Requires permission to access the [DeletePackageVersion] action. +// +// [DeletePackageVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error) { if params == nil { params = &DeletePackageInput{} diff --git a/service/iot/api_op_DeletePackageVersion.go b/service/iot/api_op_DeletePackageVersion.go index 7d98cc6a4c8..dbaee59356f 100644 --- a/service/iot/api_op_DeletePackageVersion.go +++ b/service/iot/api_op_DeletePackageVersion.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specific version from a software package. Note: If a package version -// is designated as default, you must remove the designation from the software -// package using the UpdatePackage action. +// Deletes a specific version from a software package. +// +// Note: If a package version is designated as default, you must remove the +// designation from the software package using the UpdatePackageaction. func (c *Client) DeletePackageVersion(ctx context.Context, params *DeletePackageVersionInput, optFns ...func(*Options)) (*DeletePackageVersionOutput, error) { if params == nil { params = &DeletePackageVersionInput{} diff --git a/service/iot/api_op_DeletePolicy.go b/service/iot/api_op_DeletePolicy.go index ff182f3cb88..5b08a85f8dc 100644 --- a/service/iot/api_op_DeletePolicy.go +++ b/service/iot/api_op_DeletePolicy.go @@ -10,16 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified policy. A policy cannot be deleted if it has non-default -// versions or it is attached to any certificate. To delete a policy, use the -// DeletePolicyVersion action to delete all non-default versions of the policy; use -// the DetachPolicy action to detach the policy from any certificate; and then use -// the DeletePolicy action to delete the policy. When a policy is deleted using -// 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) -// action. +// Deletes the specified policy. +// +// A policy cannot be deleted if it has non-default versions or it is attached to +// any certificate. +// +// To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the +// policy; use the DetachPolicyaction to detach the policy from any certificate; and then use +// the DeletePolicy action to delete the policy. +// +// When a policy is deleted using 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] action. +// +// [DeletePolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} diff --git a/service/iot/api_op_DeletePolicyVersion.go b/service/iot/api_op_DeletePolicyVersion.go index 813d5245aa3..2f08528afab 100644 --- a/service/iot/api_op_DeletePolicyVersion.go +++ b/service/iot/api_op_DeletePolicyVersion.go @@ -12,10 +12,12 @@ 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 -// 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) -// action. +// 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] action. +// +// [DeletePolicyVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeletePolicyVersion(ctx context.Context, params *DeletePolicyVersionInput, optFns ...func(*Options)) (*DeletePolicyVersionOutput, error) { if params == nil { params = &DeletePolicyVersionInput{} diff --git a/service/iot/api_op_DeleteProvisioningTemplate.go b/service/iot/api_op_DeleteProvisioningTemplate.go index 4bd59d51794..a7ece59ff08 100644 --- a/service/iot/api_op_DeleteProvisioningTemplate.go +++ b/service/iot/api_op_DeleteProvisioningTemplate.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a provisioning template. +// +// Requires permission to access the [DeleteProvisioningTemplate] action. +// +// [DeleteProvisioningTemplate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteProvisioningTemplate(ctx context.Context, params *DeleteProvisioningTemplateInput, optFns ...func(*Options)) (*DeleteProvisioningTemplateOutput, error) { if params == nil { params = &DeleteProvisioningTemplateInput{} diff --git a/service/iot/api_op_DeleteProvisioningTemplateVersion.go b/service/iot/api_op_DeleteProvisioningTemplateVersion.go index 19751a58b6f..c56a4b0694c 100644 --- a/service/iot/api_op_DeleteProvisioningTemplateVersion.go +++ b/service/iot/api_op_DeleteProvisioningTemplateVersion.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a provisioning template version. +// +// Requires permission to access the [DeleteProvisioningTemplateVersion] action. +// +// [DeleteProvisioningTemplateVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteProvisioningTemplateVersion(ctx context.Context, params *DeleteProvisioningTemplateVersionInput, optFns ...func(*Options)) (*DeleteProvisioningTemplateVersionOutput, error) { if params == nil { params = &DeleteProvisioningTemplateVersionInput{} diff --git a/service/iot/api_op_DeleteRegistrationCode.go b/service/iot/api_op_DeleteRegistrationCode.go index 42271bc3b72..c56c1d8bd7b 100644 --- a/service/iot/api_op_DeleteRegistrationCode.go +++ b/service/iot/api_op_DeleteRegistrationCode.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a CA certificate registration code. +// +// Requires permission to access the [DeleteRegistrationCode] action. +// +// [DeleteRegistrationCode]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteRegistrationCode(ctx context.Context, params *DeleteRegistrationCodeInput, optFns ...func(*Options)) (*DeleteRegistrationCodeOutput, error) { if params == nil { params = &DeleteRegistrationCodeInput{} diff --git a/service/iot/api_op_DeleteRoleAlias.go b/service/iot/api_op_DeleteRoleAlias.go index 0c173819020..d6bcbbccb4d 100644 --- a/service/iot/api_op_DeleteRoleAlias.go +++ b/service/iot/api_op_DeleteRoleAlias.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes a role alias +// +// Requires permission to access the [DeleteRoleAlias] action. +// +// [DeleteRoleAlias]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteRoleAlias(ctx context.Context, params *DeleteRoleAliasInput, optFns ...func(*Options)) (*DeleteRoleAliasOutput, error) { if params == nil { params = &DeleteRoleAliasInput{} diff --git a/service/iot/api_op_DeleteScheduledAudit.go b/service/iot/api_op_DeleteScheduledAudit.go index 96e6c750f99..cc54164a21f 100644 --- a/service/iot/api_op_DeleteScheduledAudit.go +++ b/service/iot/api_op_DeleteScheduledAudit.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a scheduled audit. +// +// Requires permission to access the [DeleteScheduledAudit] action. +// +// [DeleteScheduledAudit]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteScheduledAudit(ctx context.Context, params *DeleteScheduledAuditInput, optFns ...func(*Options)) (*DeleteScheduledAuditOutput, error) { if params == nil { params = &DeleteScheduledAuditInput{} diff --git a/service/iot/api_op_DeleteSecurityProfile.go b/service/iot/api_op_DeleteSecurityProfile.go index ad1044387c0..6db9aa36a8d 100644 --- a/service/iot/api_op_DeleteSecurityProfile.go +++ b/service/iot/api_op_DeleteSecurityProfile.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a Device Defender security profile. +// +// Requires permission to access the [DeleteSecurityProfile] action. +// +// [DeleteSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteSecurityProfile(ctx context.Context, params *DeleteSecurityProfileInput, optFns ...func(*Options)) (*DeleteSecurityProfileOutput, error) { if params == nil { params = &DeleteSecurityProfileInput{} diff --git a/service/iot/api_op_DeleteStream.go b/service/iot/api_op_DeleteStream.go index b8a8be753d8..14ea3799a57 100644 --- a/service/iot/api_op_DeleteStream.go +++ b/service/iot/api_op_DeleteStream.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes a stream. +// +// Requires permission to access the [DeleteStream] action. +// +// [DeleteStream]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, optFns ...func(*Options)) (*DeleteStreamOutput, error) { if params == nil { params = &DeleteStreamInput{} diff --git a/service/iot/api_op_DeleteThing.go b/service/iot/api_op_DeleteThing.go index cd50af0af1e..032c366e74e 100644 --- a/service/iot/api_op_DeleteThing.go +++ b/service/iot/api_op_DeleteThing.go @@ -11,9 +11,11 @@ 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) -// action. +// is successful or you specify a thing that doesn't exist. +// +// Requires permission to access the [DeleteThing] action. +// +// [DeleteThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteThing(ctx context.Context, params *DeleteThingInput, optFns ...func(*Options)) (*DeleteThingOutput, error) { if params == nil { params = &DeleteThingInput{} diff --git a/service/iot/api_op_DeleteThingGroup.go b/service/iot/api_op_DeleteThingGroup.go index 165174a27ad..c2982a9dce9 100644 --- a/service/iot/api_op_DeleteThingGroup.go +++ b/service/iot/api_op_DeleteThingGroup.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes a thing group. +// +// Requires permission to access the [DeleteThingGroup] action. +// +// [DeleteThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteThingGroup(ctx context.Context, params *DeleteThingGroupInput, optFns ...func(*Options)) (*DeleteThingGroupOutput, error) { if params == nil { params = &DeleteThingGroupInput{} diff --git a/service/iot/api_op_DeleteThingType.go b/service/iot/api_op_DeleteThingType.go index 2958a4087a5..3c934374e97 100644 --- a/service/iot/api_op_DeleteThingType.go +++ b/service/iot/api_op_DeleteThingType.go @@ -12,11 +12,12 @@ 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 -// 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) -// action. +// by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing +// type on any associated thing, and finally use DeleteThingTypeto delete the thing type. +// +// Requires permission to access the [DeleteThingType] action. +// +// [DeleteThingType]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteThingType(ctx context.Context, params *DeleteThingTypeInput, optFns ...func(*Options)) (*DeleteThingTypeOutput, error) { if params == nil { params = &DeleteThingTypeInput{} diff --git a/service/iot/api_op_DeleteTopicRule.go b/service/iot/api_op_DeleteTopicRule.go index c75e2916933..7fc9480415d 100644 --- a/service/iot/api_op_DeleteTopicRule.go +++ b/service/iot/api_op_DeleteTopicRule.go @@ -10,8 +10,11 @@ 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) -// action. +// Deletes the rule. +// +// Requires permission to access the [DeleteTopicRule] action. +// +// [DeleteTopicRule]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteTopicRule(ctx context.Context, params *DeleteTopicRuleInput, optFns ...func(*Options)) (*DeleteTopicRuleOutput, error) { if params == nil { params = &DeleteTopicRuleInput{} diff --git a/service/iot/api_op_DeleteTopicRuleDestination.go b/service/iot/api_op_DeleteTopicRuleDestination.go index 9a297f58506..84f706df041 100644 --- a/service/iot/api_op_DeleteTopicRuleDestination.go +++ b/service/iot/api_op_DeleteTopicRuleDestination.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a topic rule destination. +// +// Requires permission to access the [DeleteTopicRuleDestination] action. +// +// [DeleteTopicRuleDestination]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteTopicRuleDestination(ctx context.Context, params *DeleteTopicRuleDestinationInput, optFns ...func(*Options)) (*DeleteTopicRuleDestinationOutput, error) { if params == nil { params = &DeleteTopicRuleDestinationInput{} diff --git a/service/iot/api_op_DeleteV2LoggingLevel.go b/service/iot/api_op_DeleteV2LoggingLevel.go index 524bc90defd..e5ca0898763 100644 --- a/service/iot/api_op_DeleteV2LoggingLevel.go +++ b/service/iot/api_op_DeleteV2LoggingLevel.go @@ -11,8 +11,11 @@ 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) -// action. +// Deletes a logging level. +// +// Requires permission to access the [DeleteV2LoggingLevel] action. +// +// [DeleteV2LoggingLevel]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteV2LoggingLevel(ctx context.Context, params *DeleteV2LoggingLevelInput, optFns ...func(*Options)) (*DeleteV2LoggingLevelOutput, error) { if params == nil { params = &DeleteV2LoggingLevelInput{} diff --git a/service/iot/api_op_DeprecateThingType.go b/service/iot/api_op_DeprecateThingType.go index f009801ec66..fd01be7b1bf 100644 --- a/service/iot/api_op_DeprecateThingType.go +++ b/service/iot/api_op_DeprecateThingType.go @@ -11,8 +11,11 @@ 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) -// action. +// type. +// +// Requires permission to access the [DeprecateThingType] action. +// +// [DeprecateThingType]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeprecateThingType(ctx context.Context, params *DeprecateThingTypeInput, optFns ...func(*Options)) (*DeprecateThingTypeOutput, error) { if params == nil { params = &DeprecateThingTypeInput{} diff --git a/service/iot/api_op_DescribeAccountAuditConfiguration.go b/service/iot/api_op_DescribeAccountAuditConfiguration.go index a8b33fdd1c5..c01ad6b3b3c 100644 --- a/service/iot/api_op_DescribeAccountAuditConfiguration.go +++ b/service/iot/api_op_DescribeAccountAuditConfiguration.go @@ -13,9 +13,11 @@ 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) -// action. +// enabled or disabled. +// +// Requires permission to access the [DescribeAccountAuditConfiguration] action. +// +// [DescribeAccountAuditConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeAccountAuditConfiguration(ctx context.Context, params *DescribeAccountAuditConfigurationInput, optFns ...func(*Options)) (*DescribeAccountAuditConfigurationOutput, error) { if params == nil { params = &DescribeAccountAuditConfigurationInput{} @@ -46,8 +48,10 @@ 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 - // parameter is required. + // performing an audit. + // + // On the first call to UpdateAccountAuditConfiguration , this parameter is + // required. RoleArn *string // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeAuditFinding.go b/service/iot/api_op_DescribeAuditFinding.go index ed43d108657..67d956b28c6 100644 --- a/service/iot/api_op_DescribeAuditFinding.go +++ b/service/iot/api_op_DescribeAuditFinding.go @@ -13,9 +13,11 @@ import ( // 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. +// that returned the finding. +// +// Requires permission to access the [DescribeAuditFinding] action. +// +// [DescribeAuditFinding]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeAuditFinding(ctx context.Context, params *DescribeAuditFindingInput, optFns ...func(*Options)) (*DescribeAuditFindingOutput, error) { if params == nil { params = &DescribeAuditFindingInput{} diff --git a/service/iot/api_op_DescribeAuditSuppression.go b/service/iot/api_op_DescribeAuditSuppression.go index 93ae3456747..4ab883b7c76 100644 --- a/service/iot/api_op_DescribeAuditSuppression.go +++ b/service/iot/api_op_DescribeAuditSuppression.go @@ -54,16 +54,16 @@ type DescribeAuditSuppressionOutput struct { // are enabled.) CheckName *string - // The description of the audit suppression. + // The description of the audit suppression. Description *string - // The epoch timestamp in seconds at which this suppression expires. + // The epoch timestamp in seconds at which this suppression expires. ExpirationDate *time.Time // Information that identifies the noncompliant resource. ResourceIdentifier *types.ResourceIdentifier - // Indicates whether a suppression should exist indefinitely or not. + // Indicates whether a suppression should exist indefinitely or not. SuppressIndefinitely *bool // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeAuditTask.go b/service/iot/api_op_DescribeAuditTask.go index 3a0623fba89..0a2e25fce98 100644 --- a/service/iot/api_op_DescribeAuditTask.go +++ b/service/iot/api_op_DescribeAuditTask.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about a Device Defender audit. +// +// Requires permission to access the [DescribeAuditTask] action. +// +// [DescribeAuditTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeAuditTask(ctx context.Context, params *DescribeAuditTaskInput, optFns ...func(*Options)) (*DescribeAuditTaskOutput, error) { if params == nil { params = &DescribeAuditTaskInput{} diff --git a/service/iot/api_op_DescribeAuthorizer.go b/service/iot/api_op_DescribeAuthorizer.go index 319b744010a..dfa423ae63f 100644 --- a/service/iot/api_op_DescribeAuthorizer.go +++ b/service/iot/api_op_DescribeAuthorizer.go @@ -11,8 +11,11 @@ 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) -// action. +// Describes an authorizer. +// +// Requires permission to access the [DescribeAuthorizer] action. +// +// [DescribeAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeAuthorizer(ctx context.Context, params *DescribeAuthorizerInput, optFns ...func(*Options)) (*DescribeAuthorizerOutput, error) { if params == nil { params = &DescribeAuthorizerInput{} diff --git a/service/iot/api_op_DescribeBillingGroup.go b/service/iot/api_op_DescribeBillingGroup.go index 239eaafb3af..7616f03e1e5 100644 --- a/service/iot/api_op_DescribeBillingGroup.go +++ b/service/iot/api_op_DescribeBillingGroup.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Returns information about a billing group. +// +// Requires permission to access the [DescribeBillingGroup] action. +// +// [DescribeBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeBillingGroup(ctx context.Context, params *DescribeBillingGroupInput, optFns ...func(*Options)) (*DescribeBillingGroupOutput, error) { if params == nil { params = &DescribeBillingGroupInput{} diff --git a/service/iot/api_op_DescribeCACertificate.go b/service/iot/api_op_DescribeCACertificate.go index 77f4fdbdd5a..f66e7f72c6d 100644 --- a/service/iot/api_op_DescribeCACertificate.go +++ b/service/iot/api_op_DescribeCACertificate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Describes a registered CA certificate. +// +// Requires permission to access the [DescribeCACertificate] action. +// +// [DescribeCACertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeCACertificate(ctx context.Context, params *DescribeCACertificateInput, optFns ...func(*Options)) (*DescribeCACertificateOutput, error) { if params == nil { params = &DescribeCACertificateInput{} diff --git a/service/iot/api_op_DescribeCertificate.go b/service/iot/api_op_DescribeCertificate.go index eec960a3d00..e30efa1e468 100644 --- a/service/iot/api_op_DescribeCertificate.go +++ b/service/iot/api_op_DescribeCertificate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about the specified certificate. +// +// Requires permission to access the [DescribeCertificate] action. +// +// [DescribeCertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeCertificate(ctx context.Context, params *DescribeCertificateInput, optFns ...func(*Options)) (*DescribeCertificateOutput, error) { if params == nil { params = &DescribeCertificateInput{} diff --git a/service/iot/api_op_DescribeCertificateProvider.go b/service/iot/api_op_DescribeCertificateProvider.go index 76c11f80b0b..c0b24f61fa5 100644 --- a/service/iot/api_op_DescribeCertificateProvider.go +++ b/service/iot/api_op_DescribeCertificateProvider.go @@ -12,9 +12,11 @@ import ( "time" ) -// Describes a certificate provider. Requires permission to access the -// DescribeCertificateProvider (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Describes a certificate provider. +// +// Requires permission to access the [DescribeCertificateProvider] action. +// +// [DescribeCertificateProvider]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeCertificateProvider(ctx context.Context, params *DescribeCertificateProviderInput, optFns ...func(*Options)) (*DescribeCertificateProviderOutput, error) { if params == nil { params = &DescribeCertificateProviderInput{} diff --git a/service/iot/api_op_DescribeCustomMetric.go b/service/iot/api_op_DescribeCustomMetric.go index 96166f33d7f..5ae44c03f4f 100644 --- a/service/iot/api_op_DescribeCustomMetric.go +++ b/service/iot/api_op_DescribeCustomMetric.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about a Device Defender detect custom metric. +// +// Requires permission to access the [DescribeCustomMetric] action. +// +// [DescribeCustomMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeCustomMetric(ctx context.Context, params *DescribeCustomMetricInput, optFns ...func(*Options)) (*DescribeCustomMetricOutput, error) { if params == nil { params = &DescribeCustomMetricInput{} @@ -32,7 +34,7 @@ func (c *Client) DescribeCustomMetric(ctx context.Context, params *DescribeCusto type DescribeCustomMetricInput struct { - // The name of the custom metric. + // The name of the custom metric. // // This member is required. MetricName *string @@ -42,26 +44,28 @@ type DescribeCustomMetricInput struct { type DescribeCustomMetricOutput struct { - // The creation date of the custom metric in milliseconds since epoch. + // The creation date of the custom metric in milliseconds since epoch. CreationDate *time.Time - // Field represents a friendly name in the console for the custom metric; doesn't + // Field represents a friendly name in the console for the custom metric; doesn't // have to be unique. Don't use this name as the metric identifier in the device // metric report. Can be updated. DisplayName *string - // The time the custom metric was last modified in milliseconds since epoch. + // The time the custom metric was last modified in milliseconds since epoch. LastModifiedDate *time.Time - // The Amazon Resource Number (ARN) of the custom metric. + // The Amazon Resource Number (ARN) of the custom metric. MetricArn *string - // The name of the custom metric. + // The name of the custom metric. MetricName *string - // The type of the custom metric. The type number only takes a single metric value - // as an input, but while submitting the metrics value in the DeviceMetrics report, - // it must be passed as an array with a single value. + // The type of the custom metric. + // + // The type number only takes a single metric value as an input, but while + // submitting the metrics value in the DeviceMetrics report, it must be passed as + // an array with a single value. MetricType types.CustomMetricType // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeDefaultAuthorizer.go b/service/iot/api_op_DescribeDefaultAuthorizer.go index 2778a2443f1..854b068b7be 100644 --- a/service/iot/api_op_DescribeDefaultAuthorizer.go +++ b/service/iot/api_op_DescribeDefaultAuthorizer.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Describes the default authorizer. +// +// Requires permission to access the [DescribeDefaultAuthorizer] action. +// +// [DescribeDefaultAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeDefaultAuthorizer(ctx context.Context, params *DescribeDefaultAuthorizerInput, optFns ...func(*Options)) (*DescribeDefaultAuthorizerOutput, error) { if params == nil { params = &DescribeDefaultAuthorizerInput{} diff --git a/service/iot/api_op_DescribeDetectMitigationActionsTask.go b/service/iot/api_op_DescribeDetectMitigationActionsTask.go index ef77a932b2c..5f2c7fadf34 100644 --- a/service/iot/api_op_DescribeDetectMitigationActionsTask.go +++ b/service/iot/api_op_DescribeDetectMitigationActionsTask.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about a Device Defender ML Detect mitigation action. +// +// Requires permission to access the [DescribeDetectMitigationActionsTask] action. +// +// [DescribeDetectMitigationActionsTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeDetectMitigationActionsTask(ctx context.Context, params *DescribeDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*DescribeDetectMitigationActionsTaskOutput, error) { if params == nil { params = &DescribeDetectMitigationActionsTaskInput{} @@ -31,7 +33,7 @@ func (c *Client) DescribeDetectMitigationActionsTask(ctx context.Context, params type DescribeDetectMitigationActionsTaskInput struct { - // The unique identifier of the task. + // The unique identifier of the task. // // This member is required. TaskId *string @@ -41,7 +43,7 @@ type DescribeDetectMitigationActionsTaskInput struct { type DescribeDetectMitigationActionsTaskOutput struct { - // The description of a task. + // The description of a task. TaskSummary *types.DetectMitigationActionsTaskSummary // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeDimension.go b/service/iot/api_op_DescribeDimension.go index 16e080396fb..7f25360996b 100644 --- a/service/iot/api_op_DescribeDimension.go +++ b/service/iot/api_op_DescribeDimension.go @@ -13,8 +13,11 @@ 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) -// action. +// accounts. +// +// Requires permission to access the [DescribeDimension] action. +// +// [DescribeDimension]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeDimension(ctx context.Context, params *DescribeDimensionInput, optFns ...func(*Options)) (*DescribeDimensionOutput, error) { if params == nil { params = &DescribeDimensionInput{} diff --git a/service/iot/api_op_DescribeDomainConfiguration.go b/service/iot/api_op_DescribeDomainConfiguration.go index 36da4b18c4a..b213a1be3c2 100644 --- a/service/iot/api_op_DescribeDomainConfiguration.go +++ b/service/iot/api_op_DescribeDomainConfiguration.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets summary information about a domain configuration. +// +// Requires permission to access the [DescribeDomainConfiguration] action. +// +// [DescribeDomainConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeDomainConfiguration(ctx context.Context, params *DescribeDomainConfigurationInput, optFns ...func(*Options)) (*DescribeDomainConfigurationOutput, error) { if params == nil { params = &DescribeDomainConfigurationInput{} diff --git a/service/iot/api_op_DescribeEndpoint.go b/service/iot/api_op_DescribeEndpoint.go index 686fe219d88..0971888002c 100644 --- a/service/iot/api_op_DescribeEndpoint.go +++ b/service/iot/api_op_DescribeEndpoint.go @@ -11,10 +11,14 @@ import ( ) // Returns or creates a unique endpoint specific to the Amazon Web Services -// account making the call. The first time DescribeEndpoint is called, an endpoint -// is created. All subsequent calls to DescribeEndpoint return the same endpoint. -// Requires permission to access the DescribeEndpoint (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// account making the call. +// +// The first time DescribeEndpoint is called, an endpoint is created. All +// subsequent calls to DescribeEndpoint return the same endpoint. +// +// Requires permission to access the [DescribeEndpoint] action. +// +// [DescribeEndpoint]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error) { if params == nil { params = &DescribeEndpointInput{} @@ -34,6 +38,7 @@ 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-ATS - Returns an ATS signed data endpoint. @@ -41,6 +46,7 @@ type DescribeEndpointInput struct { // - 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 // authorities. ATS Signed Certificates are more secure and are trusted by most diff --git a/service/iot/api_op_DescribeEventConfigurations.go b/service/iot/api_op_DescribeEventConfigurations.go index 74ca302120a..d76f8081168 100644 --- a/service/iot/api_op_DescribeEventConfigurations.go +++ b/service/iot/api_op_DescribeEventConfigurations.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Describes event configurations. +// +// Requires permission to access the [DescribeEventConfigurations] action. +// +// [DescribeEventConfigurations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeEventConfigurations(ctx context.Context, params *DescribeEventConfigurationsInput, optFns ...func(*Options)) (*DescribeEventConfigurationsOutput, error) { if params == nil { params = &DescribeEventConfigurationsInput{} diff --git a/service/iot/api_op_DescribeFleetMetric.go b/service/iot/api_op_DescribeFleetMetric.go index afc629aecc2..9ce9cc30486 100644 --- a/service/iot/api_op_DescribeFleetMetric.go +++ b/service/iot/api_op_DescribeFleetMetric.go @@ -12,9 +12,11 @@ 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) -// action. +// Gets information about the specified fleet metric. +// +// Requires permission to access the [DescribeFleetMetric] action. +// +// [DescribeFleetMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeFleetMetric(ctx context.Context, params *DescribeFleetMetricInput, optFns ...func(*Options)) (*DescribeFleetMetricOutput, error) { if params == nil { params = &DescribeFleetMetricInput{} @@ -77,8 +79,9 @@ 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]. + // + // [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 b953565404a..bc9fcc4beb2 100644 --- a/service/iot/api_op_DescribeIndex.go +++ b/service/iot/api_op_DescribeIndex.go @@ -11,8 +11,11 @@ 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) -// action. +// Describes a search index. +// +// Requires permission to access the [DescribeIndex] action. +// +// [DescribeIndex]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeIndex(ctx context.Context, params *DescribeIndexInput, optFns ...func(*Options)) (*DescribeIndexOutput, error) { if params == nil { params = &DescribeIndexInput{} @@ -48,16 +51,22 @@ 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) - // . + // more information, see [GetIndexingConfiguration]. + // + // [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 ab2a08bcec1..72f58e70bb7 100644 --- a/service/iot/api_op_DescribeJob.go +++ b/service/iot/api_op_DescribeJob.go @@ -11,8 +11,11 @@ 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) -// action. +// Describes a job. +// +// Requires permission to access the [DescribeJob] action. +// +// [DescribeJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeJob(ctx context.Context, params *DescribeJobInput, optFns ...func(*Options)) (*DescribeJobOutput, error) { if params == nil { params = &DescribeJobInput{} diff --git a/service/iot/api_op_DescribeJobExecution.go b/service/iot/api_op_DescribeJobExecution.go index 5381919aeaa..d1779869c1c 100644 --- a/service/iot/api_op_DescribeJobExecution.go +++ b/service/iot/api_op_DescribeJobExecution.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Describes a job execution. +// +// Requires permission to access the [DescribeJobExecution] action. +// +// [DescribeJobExecution]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeJobExecution(ctx context.Context, params *DescribeJobExecutionInput, optFns ...func(*Options)) (*DescribeJobExecutionOutput, error) { if params == nil { params = &DescribeJobExecutionInput{} diff --git a/service/iot/api_op_DescribeJobTemplate.go b/service/iot/api_op_DescribeJobTemplate.go index e897e80e324..64b880aa24f 100644 --- a/service/iot/api_op_DescribeJobTemplate.go +++ b/service/iot/api_op_DescribeJobTemplate.go @@ -52,9 +52,12 @@ type DescribeJobTemplateOutput struct { // The package version Amazon Resource Names (ARNs) that are installed on the // device when the job successfully completes. The package version must be in // either the Published or Deprecated state when the job deploys. For more - // information, see Package version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . Note:The following Length Constraints relates to a single ARN. Up to 25 - // package version ARNs are allowed. + // information, see [Package version lifecycle]. + // + // Note:The following Length Constraints relates to a single ARN. Up to 25 package + // version ARNs are allowed. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle DestinationPackageVersions []string // The job document. diff --git a/service/iot/api_op_DescribeManagedJobTemplate.go b/service/iot/api_op_DescribeManagedJobTemplate.go index a6441ec6d92..487f55fc857 100644 --- a/service/iot/api_op_DescribeManagedJobTemplate.go +++ b/service/iot/api_op_DescribeManagedJobTemplate.go @@ -50,9 +50,11 @@ 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. diff --git a/service/iot/api_op_DescribeMitigationAction.go b/service/iot/api_op_DescribeMitigationAction.go index 24a54fe522e..bed173643d9 100644 --- a/service/iot/api_op_DescribeMitigationAction.go +++ b/service/iot/api_op_DescribeMitigationAction.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about a mitigation action. +// +// Requires permission to access the [DescribeMitigationAction] action. +// +// [DescribeMitigationAction]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeMitigationAction(ctx context.Context, params *DescribeMitigationActionInput, optFns ...func(*Options)) (*DescribeMitigationActionOutput, error) { if params == nil { params = &DescribeMitigationActionInput{} diff --git a/service/iot/api_op_DescribeProvisioningTemplate.go b/service/iot/api_op_DescribeProvisioningTemplate.go index d1fc90f3286..aecf6546c35 100644 --- a/service/iot/api_op_DescribeProvisioningTemplate.go +++ b/service/iot/api_op_DescribeProvisioningTemplate.go @@ -12,9 +12,11 @@ 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) -// action. +// Returns information about a provisioning template. +// +// Requires permission to access the [DescribeProvisioningTemplate] action. +// +// [DescribeProvisioningTemplate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeProvisioningTemplate(ctx context.Context, params *DescribeProvisioningTemplateInput, optFns ...func(*Options)) (*DescribeProvisioningTemplateOutput, error) { if params == nil { params = &DescribeProvisioningTemplateInput{} @@ -76,8 +78,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) - // . + // template, see: [Provisioning template]. + // + // [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 1228a0b40b3..6ab3deaf79b 100644 --- a/service/iot/api_op_DescribeProvisioningTemplateVersion.go +++ b/service/iot/api_op_DescribeProvisioningTemplateVersion.go @@ -11,9 +11,11 @@ import ( "time" ) -// 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) -// action. +// Returns information about a provisioning template version. +// +// Requires permission to access the [DescribeProvisioningTemplateVersion] action. +// +// [DescribeProvisioningTemplateVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeProvisioningTemplateVersion(ctx context.Context, params *DescribeProvisioningTemplateVersionInput, optFns ...func(*Options)) (*DescribeProvisioningTemplateVersionOutput, error) { if params == nil { params = &DescribeProvisioningTemplateVersionInput{} diff --git a/service/iot/api_op_DescribeRoleAlias.go b/service/iot/api_op_DescribeRoleAlias.go index ad43e69ac07..fe04c3bc75c 100644 --- a/service/iot/api_op_DescribeRoleAlias.go +++ b/service/iot/api_op_DescribeRoleAlias.go @@ -11,8 +11,11 @@ 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) -// action. +// Describes a role alias. +// +// Requires permission to access the [DescribeRoleAlias] action. +// +// [DescribeRoleAlias]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeRoleAlias(ctx context.Context, params *DescribeRoleAliasInput, optFns ...func(*Options)) (*DescribeRoleAliasOutput, error) { if params == nil { params = &DescribeRoleAliasInput{} diff --git a/service/iot/api_op_DescribeScheduledAudit.go b/service/iot/api_op_DescribeScheduledAudit.go index 133a5533ba1..5adad172454 100644 --- a/service/iot/api_op_DescribeScheduledAudit.go +++ b/service/iot/api_op_DescribeScheduledAudit.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about a scheduled audit. +// +// Requires permission to access the [DescribeScheduledAudit] action. +// +// [DescribeScheduledAudit]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeScheduledAudit(ctx context.Context, params *DescribeScheduledAuditInput, optFns ...func(*Options)) (*DescribeScheduledAuditOutput, error) { if params == nil { params = &DescribeScheduledAuditInput{} diff --git a/service/iot/api_op_DescribeSecurityProfile.go b/service/iot/api_op_DescribeSecurityProfile.go index 9757ed0a2d1..1ebaadf1ac0 100644 --- a/service/iot/api_op_DescribeSecurityProfile.go +++ b/service/iot/api_op_DescribeSecurityProfile.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about a Device Defender security profile. +// +// Requires permission to access the [DescribeSecurityProfile] action. +// +// [DescribeSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeSecurityProfile(ctx context.Context, params *DescribeSecurityProfileInput, optFns ...func(*Options)) (*DescribeSecurityProfileOutput, error) { if params == nil { params = &DescribeSecurityProfileInput{} @@ -42,7 +44,8 @@ type DescribeSecurityProfileInput struct { type DescribeSecurityProfileOutput struct { - // Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead. + // 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 // metric specified here. diff --git a/service/iot/api_op_DescribeStream.go b/service/iot/api_op_DescribeStream.go index 8e99bfa6d5b..30baacb80ab 100644 --- a/service/iot/api_op_DescribeStream.go +++ b/service/iot/api_op_DescribeStream.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about a stream. +// +// Requires permission to access the [DescribeStream] action. +// +// [DescribeStream]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error) { if params == nil { params = &DescribeStreamInput{} diff --git a/service/iot/api_op_DescribeThing.go b/service/iot/api_op_DescribeThing.go index 8a168b3d57f..ffdfedf3264 100644 --- a/service/iot/api_op_DescribeThing.go +++ b/service/iot/api_op_DescribeThing.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about the specified thing. +// +// Requires permission to access the [DescribeThing] action. +// +// [DescribeThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeThing(ctx context.Context, params *DescribeThingInput, optFns ...func(*Options)) (*DescribeThingOutput, error) { if params == nil { params = &DescribeThingInput{} @@ -52,9 +54,10 @@ type DescribeThingOutput struct { // 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 - // your IoT fleet without removing the flexibility of the underlying device - // certificate model or shadows. + // ID for the registry and the Device Shadow service. + // + // This lets you better organize your IoT fleet without removing the flexibility + // of the underlying device certificate model or shadows. DefaultClientId *string // The ARN of the thing to describe. @@ -69,9 +72,11 @@ type DescribeThingOutput struct { // The thing type name. ThingTypeName *string - // The current version of the thing record in the registry. To avoid unintentional - // changes to the information in the registry, you can pass the version information - // in the expectedVersion parameter of the UpdateThing and DeleteThing calls. + // The current version of the thing record in the registry. + // + // To avoid unintentional changes to the information in the registry, you can pass + // the version information in the expectedVersion parameter of the UpdateThing and + // DeleteThing calls. Version int64 // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_DescribeThingGroup.go b/service/iot/api_op_DescribeThingGroup.go index 1cd4c6e8106..05c2342885d 100644 --- a/service/iot/api_op_DescribeThingGroup.go +++ b/service/iot/api_op_DescribeThingGroup.go @@ -11,8 +11,11 @@ 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) -// action. +// Describe a thing group. +// +// Requires permission to access the [DescribeThingGroup] action. +// +// [DescribeThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeThingGroup(ctx context.Context, params *DescribeThingGroupInput, optFns ...func(*Options)) (*DescribeThingGroupOutput, error) { if params == nil { params = &DescribeThingGroupInput{} diff --git a/service/iot/api_op_DescribeThingRegistrationTask.go b/service/iot/api_op_DescribeThingRegistrationTask.go index 4869f9f1268..97b0c03566d 100644 --- a/service/iot/api_op_DescribeThingRegistrationTask.go +++ b/service/iot/api_op_DescribeThingRegistrationTask.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Describes a bulk thing provisioning task. +// +// Requires permission to access the [DescribeThingRegistrationTask] action. +// +// [DescribeThingRegistrationTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeThingRegistrationTask(ctx context.Context, params *DescribeThingRegistrationTaskInput, optFns ...func(*Options)) (*DescribeThingRegistrationTaskOutput, error) { if params == nil { params = &DescribeThingRegistrationTaskInput{} diff --git a/service/iot/api_op_DescribeThingType.go b/service/iot/api_op_DescribeThingType.go index f5b1dd04669..ac203642cb2 100644 --- a/service/iot/api_op_DescribeThingType.go +++ b/service/iot/api_op_DescribeThingType.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about the specified thing type. +// +// Requires permission to access the [DescribeThingType] action. +// +// [DescribeThingType]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeThingType(ctx context.Context, params *DescribeThingTypeInput, optFns ...func(*Options)) (*DescribeThingTypeOutput, error) { if params == nil { params = &DescribeThingTypeInput{} diff --git a/service/iot/api_op_DetachPolicy.go b/service/iot/api_op_DetachPolicy.go index 6cc8eec5ebb..cd882605e67 100644 --- a/service/iot/api_op_DetachPolicy.go +++ b/service/iot/api_op_DetachPolicy.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// 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] action. +// +// [DetachPolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error) { if params == nil { params = &DetachPolicyInput{} diff --git a/service/iot/api_op_DetachPrincipalPolicy.go b/service/iot/api_op_DetachPrincipalPolicy.go index 1896ab071f3..ae288c71308 100644 --- a/service/iot/api_op_DetachPrincipalPolicy.go +++ b/service/iot/api_op_DetachPrincipalPolicy.go @@ -10,13 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// 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 DetachPolicyinstead. +// +// Requires permission to access the [DetachPrincipalPolicy] action. // // Deprecated: This operation has been deprecated. +// +// [DetachPrincipalPolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DetachPrincipalPolicy(ctx context.Context, params *DetachPrincipalPolicyInput, optFns ...func(*Options)) (*DetachPrincipalPolicyOutput, error) { if params == nil { params = &DetachPrincipalPolicyInput{} @@ -40,7 +43,9 @@ type DetachPrincipalPolicyInput struct { // This member is required. PolicyName *string - // The principal. Valid principals are CertificateArn + // The principal. + // + // Valid principals are CertificateArn // (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn // (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id). // diff --git a/service/iot/api_op_DetachSecurityProfile.go b/service/iot/api_op_DetachSecurityProfile.go index 6bdcb658f0f..0d261b09c25 100644 --- a/service/iot/api_op_DetachSecurityProfile.go +++ b/service/iot/api_op_DetachSecurityProfile.go @@ -11,8 +11,11 @@ import ( ) // 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. +// this account. +// +// Requires permission to access the [DetachSecurityProfile] action. +// +// [DetachSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DetachSecurityProfile(ctx context.Context, params *DetachSecurityProfileInput, optFns ...func(*Options)) (*DetachSecurityProfileOutput, error) { if params == nil { params = &DetachSecurityProfileInput{} diff --git a/service/iot/api_op_DetachThingPrincipal.go b/service/iot/api_op_DetachThingPrincipal.go index 95e7ce34144..2405b6a2b49 100644 --- a/service/iot/api_op_DetachThingPrincipal.go +++ b/service/iot/api_op_DetachThingPrincipal.go @@ -12,10 +12,14 @@ import ( // Detaches the specified principal from the specified thing. A principal can be // 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) -// action. +// federated identities. +// +// This call is asynchronous. It might take several seconds for the detachment to +// propagate. +// +// Requires permission to access the [DetachThingPrincipal] action. +// +// [DetachThingPrincipal]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DetachThingPrincipal(ctx context.Context, params *DetachThingPrincipalInput, optFns ...func(*Options)) (*DetachThingPrincipalOutput, error) { if params == nil { params = &DetachThingPrincipalInput{} diff --git a/service/iot/api_op_DisableTopicRule.go b/service/iot/api_op_DisableTopicRule.go index 4494d0f3cf0..def4602acff 100644 --- a/service/iot/api_op_DisableTopicRule.go +++ b/service/iot/api_op_DisableTopicRule.go @@ -10,8 +10,11 @@ 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) -// action. +// Disables the rule. +// +// Requires permission to access the [DisableTopicRule] action. +// +// [DisableTopicRule]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DisableTopicRule(ctx context.Context, params *DisableTopicRuleInput, optFns ...func(*Options)) (*DisableTopicRuleOutput, error) { if params == nil { params = &DisableTopicRuleInput{} diff --git a/service/iot/api_op_EnableTopicRule.go b/service/iot/api_op_EnableTopicRule.go index d26afffed31..29b31b9fea4 100644 --- a/service/iot/api_op_EnableTopicRule.go +++ b/service/iot/api_op_EnableTopicRule.go @@ -10,8 +10,11 @@ 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) -// action. +// Enables the rule. +// +// Requires permission to access the [EnableTopicRule] action. +// +// [EnableTopicRule]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) EnableTopicRule(ctx context.Context, params *EnableTopicRuleInput, optFns ...func(*Options)) (*EnableTopicRuleOutput, error) { if params == nil { params = &EnableTopicRuleInput{} diff --git a/service/iot/api_op_GetBehaviorModelTrainingSummaries.go b/service/iot/api_op_GetBehaviorModelTrainingSummaries.go index adaa60d2664..9602b19b27f 100644 --- a/service/iot/api_op_GetBehaviorModelTrainingSummaries.go +++ b/service/iot/api_op_GetBehaviorModelTrainingSummaries.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Returns a Device Defender's ML Detect Security Profile training model's +// +// status. +// +// Requires permission to access the [GetBehaviorModelTrainingSummaries] action. +// +// [GetBehaviorModelTrainingSummaries]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetBehaviorModelTrainingSummaries(ctx context.Context, params *GetBehaviorModelTrainingSummariesInput, optFns ...func(*Options)) (*GetBehaviorModelTrainingSummariesOutput, error) { if params == nil { params = &GetBehaviorModelTrainingSummariesInput{} @@ -31,13 +35,13 @@ func (c *Client) GetBehaviorModelTrainingSummaries(ctx context.Context, params * type GetBehaviorModelTrainingSummariesInput struct { - // The maximum number of results to return at one time. The default is 10. + // The maximum number of results to return at one time. The default is 10. MaxResults *int32 - // The token for the next set of results. + // The token for the next set of results. NextToken *string - // The name of the security profile. + // The name of the security profile. SecurityProfileName *string noSmithyDocumentSerde @@ -45,11 +49,11 @@ type GetBehaviorModelTrainingSummariesInput struct { type GetBehaviorModelTrainingSummariesOutput struct { - // A token that can be used to retrieve the next set of results, or null if there + // A token that can be used to retrieve the next set of results, or null if there // are no additional results. NextToken *string - // A list of all ML Detect behaviors and their model status for a given Security + // A list of all ML Detect behaviors and their model status for a given Security // Profile. Summaries []types.BehaviorModelTrainingSummary @@ -146,7 +150,7 @@ var _ GetBehaviorModelTrainingSummariesAPIClient = (*Client)(nil) // GetBehaviorModelTrainingSummariesPaginatorOptions is the paginator options for // GetBehaviorModelTrainingSummaries type GetBehaviorModelTrainingSummariesPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 10. + // The maximum number of results to return at one time. The default is 10. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iot/api_op_GetBucketsAggregation.go b/service/iot/api_op_GetBucketsAggregation.go index 962a4b08989..bf97e7e12be 100644 --- a/service/iot/api_op_GetBucketsAggregation.go +++ b/service/iot/api_op_GetBucketsAggregation.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [GetBucketsAggregation] action. +// +// [GetBucketsAggregation]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetBucketsAggregation(ctx context.Context, params *GetBucketsAggregationInput, optFns ...func(*Options)) (*GetBucketsAggregationOutput, error) { if params == nil { params = &GetBucketsAggregationInput{} @@ -59,8 +61,11 @@ 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 650eb4e403a..5b7c9921105 100644 --- a/service/iot/api_op_GetCardinality.go +++ b/service/iot/api_op_GetCardinality.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Returns the approximate count of unique values that match the query. +// +// Requires permission to access the [GetCardinality] action. +// +// [GetCardinality]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetCardinality(ctx context.Context, params *GetCardinalityInput, optFns ...func(*Options)) (*GetCardinalityOutput, error) { if params == nil { params = &GetCardinalityInput{} diff --git a/service/iot/api_op_GetEffectivePolicies.go b/service/iot/api_op_GetEffectivePolicies.go index dec24b58075..61e67419000 100644 --- a/service/iot/api_op_GetEffectivePolicies.go +++ b/service/iot/api_op_GetEffectivePolicies.go @@ -12,9 +12,11 @@ import ( ) // 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. +// of the specified device when it connects to the IoT device gateway. +// +// Requires permission to access the [GetEffectivePolicies] action. +// +// [GetEffectivePolicies]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetEffectivePolicies(ctx context.Context, params *GetEffectivePoliciesInput, optFns ...func(*Options)) (*GetEffectivePoliciesOutput, error) { if params == nil { params = &GetEffectivePoliciesInput{} diff --git a/service/iot/api_op_GetIndexingConfiguration.go b/service/iot/api_op_GetIndexingConfiguration.go index b9017f272b3..19d856ec4b2 100644 --- a/service/iot/api_op_GetIndexingConfiguration.go +++ b/service/iot/api_op_GetIndexingConfiguration.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets the indexing configuration. +// +// Requires permission to access the [GetIndexingConfiguration] action. +// +// [GetIndexingConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetIndexingConfiguration(ctx context.Context, params *GetIndexingConfigurationInput, optFns ...func(*Options)) (*GetIndexingConfigurationOutput, error) { if params == nil { params = &GetIndexingConfigurationInput{} diff --git a/service/iot/api_op_GetJobDocument.go b/service/iot/api_op_GetJobDocument.go index 4f3b6876bc5..6b3cf6ba441 100644 --- a/service/iot/api_op_GetJobDocument.go +++ b/service/iot/api_op_GetJobDocument.go @@ -10,8 +10,11 @@ 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) -// action. +// Gets a job document. +// +// Requires permission to access the [GetJobDocument] action. +// +// [GetJobDocument]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetJobDocument(ctx context.Context, params *GetJobDocumentInput, optFns ...func(*Options)) (*GetJobDocumentOutput, error) { if params == nil { params = &GetJobDocumentInput{} diff --git a/service/iot/api_op_GetLoggingOptions.go b/service/iot/api_op_GetLoggingOptions.go index 0c01bf4feff..cdebed49325 100644 --- a/service/iot/api_op_GetLoggingOptions.go +++ b/service/iot/api_op_GetLoggingOptions.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets the logging options. +// +// NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. +// +// Requires permission to access the [GetLoggingOptions] action. +// +// [GetLoggingOptions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetLoggingOptions(ctx context.Context, params *GetLoggingOptionsInput, optFns ...func(*Options)) (*GetLoggingOptionsOutput, error) { if params == nil { params = &GetLoggingOptionsInput{} diff --git a/service/iot/api_op_GetOTAUpdate.go b/service/iot/api_op_GetOTAUpdate.go index 94c39217791..cf079efc853 100644 --- a/service/iot/api_op_GetOTAUpdate.go +++ b/service/iot/api_op_GetOTAUpdate.go @@ -11,8 +11,11 @@ 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) -// action. +// Gets an OTA update. +// +// Requires permission to access the [GetOTAUpdate] action. +// +// [GetOTAUpdate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetOTAUpdate(ctx context.Context, params *GetOTAUpdateInput, optFns ...func(*Options)) (*GetOTAUpdateOutput, error) { if params == nil { params = &GetOTAUpdateInput{} diff --git a/service/iot/api_op_GetPackage.go b/service/iot/api_op_GetPackage.go index 0301ebebe2d..8b940f66ed0 100644 --- a/service/iot/api_op_GetPackage.go +++ b/service/iot/api_op_GetPackage.go @@ -11,9 +11,11 @@ import ( "time" ) -// Gets information about the specified software package. Requires permission to -// access the GetPackage (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Gets information about the specified software package. +// +// Requires permission to access the [GetPackage] action. +// +// [GetPackage]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetPackage(ctx context.Context, params *GetPackageInput, optFns ...func(*Options)) (*GetPackageOutput, error) { if params == nil { params = &GetPackageInput{} diff --git a/service/iot/api_op_GetPackageConfiguration.go b/service/iot/api_op_GetPackageConfiguration.go index 60bd061c819..0674cc751f5 100644 --- a/service/iot/api_op_GetPackageConfiguration.go +++ b/service/iot/api_op_GetPackageConfiguration.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the specified software package's configuration. Requires -// permission to access the GetPackageConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Gets information about the specified software package's configuration. +// +// Requires permission to access the [GetPackageConfiguration] action. +// +// [GetPackageConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetPackageConfiguration(ctx context.Context, params *GetPackageConfigurationInput, optFns ...func(*Options)) (*GetPackageConfigurationOutput, error) { if params == nil { params = &GetPackageConfigurationInput{} diff --git a/service/iot/api_op_GetPackageVersion.go b/service/iot/api_op_GetPackageVersion.go index 7c32345d0ec..8875a631127 100644 --- a/service/iot/api_op_GetPackageVersion.go +++ b/service/iot/api_op_GetPackageVersion.go @@ -12,9 +12,11 @@ import ( "time" ) -// Gets information about the specified package version. Requires permission to -// access the GetPackageVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Gets information about the specified package version. +// +// Requires permission to access the [GetPackageVersion] action. +// +// [GetPackageVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetPackageVersion(ctx context.Context, params *GetPackageVersionInput, optFns ...func(*Options)) (*GetPackageVersionOutput, error) { if params == nil { params = &GetPackageVersionInput{} @@ -69,9 +71,9 @@ type GetPackageVersionOutput struct { // The ARN for the package version. PackageVersionArn *string - // The status associated to the package version. For more information, see Package - // version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . + // The status associated to the package version. For more information, see [Package version lifecycle]. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle Status types.PackageVersionStatus // The name of the package version. diff --git a/service/iot/api_op_GetPercentiles.go b/service/iot/api_op_GetPercentiles.go index ff4b82a4222..da5c0ba52bf 100644 --- a/service/iot/api_op_GetPercentiles.go +++ b/service/iot/api_op_GetPercentiles.go @@ -20,8 +20,11 @@ import ( // 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. +// percentile values. +// +// Requires permission to access the [GetPercentiles] action. +// +// [GetPercentiles]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetPercentiles(ctx context.Context, params *GetPercentilesInput, optFns ...func(*Options)) (*GetPercentilesOutput, error) { if params == nil { params = &GetPercentilesInput{} diff --git a/service/iot/api_op_GetPolicy.go b/service/iot/api_op_GetPolicy.go index 230a2b43573..21c45114be2 100644 --- a/service/iot/api_op_GetPolicy.go +++ b/service/iot/api_op_GetPolicy.go @@ -12,8 +12,11 @@ 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) -// action. +// default version. +// +// Requires permission to access the [GetPolicy] action. +// +// [GetPolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { params = &GetPolicyInput{} diff --git a/service/iot/api_op_GetPolicyVersion.go b/service/iot/api_op_GetPolicyVersion.go index a2fce2f8653..969442975cb 100644 --- a/service/iot/api_op_GetPolicyVersion.go +++ b/service/iot/api_op_GetPolicyVersion.go @@ -11,9 +11,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about the specified policy version. +// +// Requires permission to access the [GetPolicyVersion] action. +// +// [GetPolicyVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetPolicyVersion(ctx context.Context, params *GetPolicyVersionInput, optFns ...func(*Options)) (*GetPolicyVersionOutput, error) { if params == nil { params = &GetPolicyVersionInput{} diff --git a/service/iot/api_op_GetRegistrationCode.go b/service/iot/api_op_GetRegistrationCode.go index da8fcb868b9..57740abb1c4 100644 --- a/service/iot/api_op_GetRegistrationCode.go +++ b/service/iot/api_op_GetRegistrationCode.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a registration code used to register a CA certificate with IoT. IoT will -// create a registration code as part of this API call if the registration code -// doesn't exist or has been deleted. If you already have a registration code, this -// API call will return the same registration code. Requires permission to access -// the GetRegistrationCode (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Gets a registration code used to register a CA certificate with IoT. +// +// IoT will create a registration code as part of this API call if the +// registration code doesn't exist or has been deleted. If you already have a +// registration code, this API call will return the same registration code. +// +// Requires permission to access the [GetRegistrationCode] action. +// +// [GetRegistrationCode]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetRegistrationCode(ctx context.Context, params *GetRegistrationCodeInput, optFns ...func(*Options)) (*GetRegistrationCodeOutput, error) { if params == nil { params = &GetRegistrationCodeInput{} diff --git a/service/iot/api_op_GetStatistics.go b/service/iot/api_op_GetStatistics.go index 28930b80be4..8c0b3a5b39e 100644 --- a/service/iot/api_op_GetStatistics.go +++ b/service/iot/api_op_GetStatistics.go @@ -13,9 +13,11 @@ import ( // 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. +// field is of type String , only the count statistic is returned. +// +// Requires permission to access the [GetStatistics] action. +// +// [GetStatistics]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetStatistics(ctx context.Context, params *GetStatisticsInput, optFns ...func(*Options)) (*GetStatisticsOutput, error) { if params == nil { params = &GetStatisticsInput{} diff --git a/service/iot/api_op_GetTopicRule.go b/service/iot/api_op_GetTopicRule.go index 7b18c8c3f3f..f2d27526c1a 100644 --- a/service/iot/api_op_GetTopicRule.go +++ b/service/iot/api_op_GetTopicRule.go @@ -11,8 +11,11 @@ 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) -// action. +// Gets information about the rule. +// +// Requires permission to access the [GetTopicRule] action. +// +// [GetTopicRule]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetTopicRule(ctx context.Context, params *GetTopicRuleInput, optFns ...func(*Options)) (*GetTopicRuleOutput, error) { if params == nil { params = &GetTopicRuleInput{} diff --git a/service/iot/api_op_GetTopicRuleDestination.go b/service/iot/api_op_GetTopicRuleDestination.go index e4073c4f846..bc0575561ef 100644 --- a/service/iot/api_op_GetTopicRuleDestination.go +++ b/service/iot/api_op_GetTopicRuleDestination.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about a topic rule destination. +// +// Requires permission to access the [GetTopicRuleDestination] action. +// +// [GetTopicRuleDestination]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetTopicRuleDestination(ctx context.Context, params *GetTopicRuleDestinationInput, optFns ...func(*Options)) (*GetTopicRuleDestinationOutput, error) { if params == nil { params = &GetTopicRuleDestinationInput{} diff --git a/service/iot/api_op_GetV2LoggingOptions.go b/service/iot/api_op_GetV2LoggingOptions.go index 678f4b8fc53..496af96fd73 100644 --- a/service/iot/api_op_GetV2LoggingOptions.go +++ b/service/iot/api_op_GetV2LoggingOptions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets the fine grained logging options. +// +// Requires permission to access the [GetV2LoggingOptions] action. +// +// [GetV2LoggingOptions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetV2LoggingOptions(ctx context.Context, params *GetV2LoggingOptionsInput, optFns ...func(*Options)) (*GetV2LoggingOptionsOutput, error) { if params == nil { params = &GetV2LoggingOptionsInput{} diff --git a/service/iot/api_op_ListActiveViolations.go b/service/iot/api_op_ListActiveViolations.go index 8e88860be71..7c10cc781ea 100644 --- a/service/iot/api_op_ListActiveViolations.go +++ b/service/iot/api_op_ListActiveViolations.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [ListActiveViolations] action. +// +// [ListActiveViolations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListActiveViolations(ctx context.Context, params *ListActiveViolationsInput, optFns ...func(*Options)) (*ListActiveViolationsOutput, error) { if params == nil { params = &ListActiveViolationsInput{} @@ -31,10 +33,10 @@ func (c *Client) ListActiveViolations(ctx context.Context, params *ListActiveVio type ListActiveViolationsInput struct { - // The criteria for a behavior. + // The criteria for a behavior. BehaviorCriteriaType types.BehaviorCriteriaType - // A list of all suppressed alerts. + // A list of all suppressed alerts. ListSuppressedAlerts *bool // The maximum number of results to return at one time. diff --git a/service/iot/api_op_ListAttachedPolicies.go b/service/iot/api_op_ListAttachedPolicies.go index 5dace0f3404..87faf3f0b5b 100644 --- a/service/iot/api_op_ListAttachedPolicies.go +++ b/service/iot/api_op_ListAttachedPolicies.go @@ -11,9 +11,11 @@ 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) -// action. +// Lists the policies attached to the specified thing group. +// +// Requires permission to access the [ListAttachedPolicies] action. +// +// [ListAttachedPolicies]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAttachedPolicies(ctx context.Context, params *ListAttachedPoliciesInput, optFns ...func(*Options)) (*ListAttachedPoliciesOutput, error) { if params == nil { params = &ListAttachedPoliciesInput{} diff --git a/service/iot/api_op_ListAuditFindings.go b/service/iot/api_op_ListAuditFindings.go index c7a06ef626f..db553048ac0 100644 --- a/service/iot/api_op_ListAuditFindings.go +++ b/service/iot/api_op_ListAuditFindings.go @@ -14,8 +14,10 @@ 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) -// action. +// +// Requires permission to access the [ListAuditFindings] action. +// +// [ListAuditFindings]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAuditFindings(ctx context.Context, params *ListAuditFindingsInput, optFns ...func(*Options)) (*ListAuditFindingsOutput, error) { if params == nil { params = &ListAuditFindingsInput{} @@ -40,7 +42,7 @@ 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 + // 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 diff --git a/service/iot/api_op_ListAuditMitigationActionsExecutions.go b/service/iot/api_op_ListAuditMitigationActionsExecutions.go index 9c539c0e8ce..313ee455809 100644 --- a/service/iot/api_op_ListAuditMitigationActionsExecutions.go +++ b/service/iot/api_op_ListAuditMitigationActionsExecutions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets the status of audit mitigation action tasks that were executed. +// +// Requires permission to access the [ListAuditMitigationActionsExecutions] action. +// +// [ListAuditMitigationActionsExecutions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAuditMitigationActionsExecutions(ctx context.Context, params *ListAuditMitigationActionsExecutionsInput, optFns ...func(*Options)) (*ListAuditMitigationActionsExecutionsOutput, error) { if params == nil { params = &ListAuditMitigationActionsExecutionsInput{} diff --git a/service/iot/api_op_ListAuditMitigationActionsTasks.go b/service/iot/api_op_ListAuditMitigationActionsTasks.go index 1ad948a8515..5cedb804015 100644 --- a/service/iot/api_op_ListAuditMitigationActionsTasks.go +++ b/service/iot/api_op_ListAuditMitigationActionsTasks.go @@ -13,8 +13,10 @@ 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) -// action. +// +// Requires permission to access the [ListAuditMitigationActionsTasks] action. +// +// [ListAuditMitigationActionsTasks]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAuditMitigationActionsTasks(ctx context.Context, params *ListAuditMitigationActionsTasksInput, optFns ...func(*Options)) (*ListAuditMitigationActionsTasksOutput, error) { if params == nil { params = &ListAuditMitigationActionsTasksInput{} diff --git a/service/iot/api_op_ListAuditSuppressions.go b/service/iot/api_op_ListAuditSuppressions.go index 37833be8c57..85b970b89a5 100644 --- a/service/iot/api_op_ListAuditSuppressions.go +++ b/service/iot/api_op_ListAuditSuppressions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists your Device Defender audit listings. +// +// Requires permission to access the [ListAuditSuppressions] action. +// +// [ListAuditSuppressions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAuditSuppressions(ctx context.Context, params *ListAuditSuppressionsInput, optFns ...func(*Options)) (*ListAuditSuppressionsOutput, error) { if params == nil { params = &ListAuditSuppressionsInput{} @@ -31,7 +33,7 @@ func (c *Client) ListAuditSuppressions(ctx context.Context, params *ListAuditSup type ListAuditSuppressionsInput struct { - // Determines whether suppressions are listed in ascending order by expiration + // Determines whether suppressions are listed in ascending order by expiration // date or not. If parameter isn't provided, ascendingOrder=true . AscendingOrder bool @@ -41,10 +43,10 @@ type ListAuditSuppressionsInput struct { // are enabled.) CheckName *string - // The maximum number of results to return at one time. The default is 25. + // The maximum number of results to return at one time. The default is 25. MaxResults *int32 - // The token for the next set of results. + // The token for the next set of results. NextToken *string // Information that identifies the noncompliant resource. @@ -55,11 +57,11 @@ type ListAuditSuppressionsInput struct { type ListAuditSuppressionsOutput struct { - // A token that can be used to retrieve the next set of results, or null if there + // A token that can be used to retrieve the next set of results, or null if there // are no additional results. NextToken *string - // List of audit suppressions. + // List of audit suppressions. Suppressions []types.AuditSuppression // Metadata pertaining to the operation's result. @@ -155,7 +157,7 @@ var _ ListAuditSuppressionsAPIClient = (*Client)(nil) // ListAuditSuppressionsPaginatorOptions is the paginator options for // ListAuditSuppressions type ListAuditSuppressionsPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. + // The maximum number of results to return at one time. The default is 25. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iot/api_op_ListAuditTasks.go b/service/iot/api_op_ListAuditTasks.go index 89dfc81d133..690259547de 100644 --- a/service/iot/api_op_ListAuditTasks.go +++ b/service/iot/api_op_ListAuditTasks.go @@ -13,8 +13,11 @@ 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) -// action. +// period. +// +// Requires permission to access the [ListAuditTasks] action. +// +// [ListAuditTasks]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAuditTasks(ctx context.Context, params *ListAuditTasksInput, optFns ...func(*Options)) (*ListAuditTasksOutput, error) { if params == nil { params = &ListAuditTasksInput{} diff --git a/service/iot/api_op_ListAuthorizers.go b/service/iot/api_op_ListAuthorizers.go index e5bcc781bf8..fe048f4e3fd 100644 --- a/service/iot/api_op_ListAuthorizers.go +++ b/service/iot/api_op_ListAuthorizers.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the authorizers registered in your account. +// +// Requires permission to access the [ListAuthorizers] action. +// +// [ListAuthorizers]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListAuthorizers(ctx context.Context, params *ListAuthorizersInput, optFns ...func(*Options)) (*ListAuthorizersOutput, error) { if params == nil { params = &ListAuthorizersInput{} diff --git a/service/iot/api_op_ListBillingGroups.go b/service/iot/api_op_ListBillingGroups.go index b7bda753b6f..5e6f42e9dcc 100644 --- a/service/iot/api_op_ListBillingGroups.go +++ b/service/iot/api_op_ListBillingGroups.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the billing groups you have created. +// +// Requires permission to access the [ListBillingGroups] action. +// +// [ListBillingGroups]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListBillingGroups(ctx context.Context, params *ListBillingGroupsInput, optFns ...func(*Options)) (*ListBillingGroupsOutput, error) { if params == nil { params = &ListBillingGroupsInput{} diff --git a/service/iot/api_op_ListCACertificates.go b/service/iot/api_op_ListCACertificates.go index 5605bbf44c4..41b2f88b1e7 100644 --- a/service/iot/api_op_ListCACertificates.go +++ b/service/iot/api_op_ListCACertificates.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// 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] action. +// +// [ListCACertificates]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListCACertificates(ctx context.Context, params *ListCACertificatesInput, optFns ...func(*Options)) (*ListCACertificatesOutput, error) { if params == nil { params = &ListCACertificatesInput{} diff --git a/service/iot/api_op_ListCertificateProviders.go b/service/iot/api_op_ListCertificateProviders.go index 78242a1c5ef..1efe45e3bdf 100644 --- a/service/iot/api_op_ListCertificateProviders.go +++ b/service/iot/api_op_ListCertificateProviders.go @@ -12,8 +12,10 @@ import ( ) // Lists all your certificate providers in your Amazon Web Services account. -// Requires permission to access the ListCertificateProviders (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// +// Requires permission to access the [ListCertificateProviders] action. +// +// [ListCertificateProviders]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListCertificateProviders(ctx context.Context, params *ListCertificateProvidersInput, optFns ...func(*Options)) (*ListCertificateProvidersOutput, error) { if params == nil { params = &ListCertificateProvidersInput{} diff --git a/service/iot/api_op_ListCertificates.go b/service/iot/api_op_ListCertificates.go index bc25aff299c..360a1451519 100644 --- a/service/iot/api_op_ListCertificates.go +++ b/service/iot/api_op_ListCertificates.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// 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] action. +// +// [ListCertificates]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListCertificates(ctx context.Context, params *ListCertificatesInput, optFns ...func(*Options)) (*ListCertificatesOutput, error) { if params == nil { params = &ListCertificatesInput{} diff --git a/service/iot/api_op_ListCertificatesByCA.go b/service/iot/api_op_ListCertificatesByCA.go index 19a7c0195a2..9952d9d7ee7 100644 --- a/service/iot/api_op_ListCertificatesByCA.go +++ b/service/iot/api_op_ListCertificatesByCA.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// List the device certificates signed by the specified CA certificate. +// +// Requires permission to access the [ListCertificatesByCA] action. +// +// [ListCertificatesByCA]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListCertificatesByCA(ctx context.Context, params *ListCertificatesByCAInput, optFns ...func(*Options)) (*ListCertificatesByCAOutput, error) { if params == nil { params = &ListCertificatesByCAInput{} diff --git a/service/iot/api_op_ListCustomMetrics.go b/service/iot/api_op_ListCustomMetrics.go index e7327a86dcd..9c40faeccc6 100644 --- a/service/iot/api_op_ListCustomMetrics.go +++ b/service/iot/api_op_ListCustomMetrics.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists your Device Defender detect custom metrics. +// +// Requires permission to access the [ListCustomMetrics] action. +// +// [ListCustomMetrics]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListCustomMetrics(ctx context.Context, params *ListCustomMetricsInput, optFns ...func(*Options)) (*ListCustomMetricsOutput, error) { if params == nil { params = &ListCustomMetricsInput{} @@ -30,10 +32,10 @@ func (c *Client) ListCustomMetrics(ctx context.Context, params *ListCustomMetric type ListCustomMetricsInput struct { - // The maximum number of results to return at one time. The default is 25. + // The maximum number of results to return at one time. The default is 25. MaxResults *int32 - // The token for the next set of results. + // The token for the next set of results. NextToken *string noSmithyDocumentSerde @@ -41,10 +43,10 @@ type ListCustomMetricsInput struct { type ListCustomMetricsOutput struct { - // The name of the custom metric. + // The name of the custom metric. MetricNames []string - // A token that can be used to retrieve the next set of results, or null if there + // A token that can be used to retrieve the next set of results, or null if there // are no additional results. NextToken *string @@ -140,7 +142,7 @@ var _ ListCustomMetricsAPIClient = (*Client)(nil) // ListCustomMetricsPaginatorOptions is the paginator options for ListCustomMetrics type ListCustomMetricsPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. + // The maximum number of results to return at one time. The default is 25. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iot/api_op_ListDetectMitigationActionsExecutions.go b/service/iot/api_op_ListDetectMitigationActionsExecutions.go index 7de88b8f022..2b2ece7754b 100644 --- a/service/iot/api_op_ListDetectMitigationActionsExecutions.go +++ b/service/iot/api_op_ListDetectMitigationActionsExecutions.go @@ -12,9 +12,13 @@ import ( "time" ) -// 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) -// action. +// Lists mitigation actions executions for a Device Defender ML Detect Security +// +// Profile. +// +// Requires permission to access the [ListDetectMitigationActionsExecutions] action. +// +// [ListDetectMitigationActionsExecutions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListDetectMitigationActionsExecutions(ctx context.Context, params *ListDetectMitigationActionsExecutionsInput, optFns ...func(*Options)) (*ListDetectMitigationActionsExecutionsOutput, error) { if params == nil { params = &ListDetectMitigationActionsExecutionsInput{} @@ -32,27 +36,27 @@ func (c *Client) ListDetectMitigationActionsExecutions(ctx context.Context, para type ListDetectMitigationActionsExecutionsInput struct { - // The end of the time period for which ML Detect mitigation actions executions + // 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. + // The maximum number of results to return at one time. The default is 25. MaxResults *int32 - // The token for the next set of results. + // The token for the next set of results. NextToken *string - // A filter to limit results to those found after the specified time. You must + // A filter to limit results to those found after the specified time. You must // specify either the startTime and endTime or the taskId, but not both. StartTime *time.Time - // The unique identifier of the task. + // The unique identifier of the task. TaskId *string - // The name of the thing whose mitigation actions are listed. + // The name of the thing whose mitigation actions are listed. ThingName *string - // The unique identifier of the violation. + // The unique identifier of the violation. ViolationId *string noSmithyDocumentSerde @@ -60,10 +64,10 @@ type ListDetectMitigationActionsExecutionsInput struct { type ListDetectMitigationActionsExecutionsOutput struct { - // List of actions executions. + // List of actions executions. ActionsExecutions []types.DetectMitigationActionExecution - // A token that can be used to retrieve the next set of results, or null if there + // A token that can be used to retrieve the next set of results, or null if there // are no additional results. NextToken *string @@ -160,7 +164,7 @@ var _ ListDetectMitigationActionsExecutionsAPIClient = (*Client)(nil) // ListDetectMitigationActionsExecutionsPaginatorOptions is the paginator options // for ListDetectMitigationActionsExecutions type ListDetectMitigationActionsExecutionsPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. + // The maximum number of results to return at one time. The default is 25. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iot/api_op_ListDetectMitigationActionsTasks.go b/service/iot/api_op_ListDetectMitigationActionsTasks.go index 11ee8cfddf4..2131b905ac8 100644 --- a/service/iot/api_op_ListDetectMitigationActionsTasks.go +++ b/service/iot/api_op_ListDetectMitigationActionsTasks.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// List of Device Defender ML Detect mitigation actions tasks. +// +// Requires permission to access the [ListDetectMitigationActionsTasks] action. +// +// [ListDetectMitigationActionsTasks]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListDetectMitigationActionsTasks(ctx context.Context, params *ListDetectMitigationActionsTasksInput, optFns ...func(*Options)) (*ListDetectMitigationActionsTasksOutput, error) { if params == nil { params = &ListDetectMitigationActionsTasksInput{} @@ -32,13 +34,13 @@ func (c *Client) ListDetectMitigationActionsTasks(ctx context.Context, params *L type ListDetectMitigationActionsTasksInput struct { - // The end of the time period for which ML Detect mitigation actions tasks are + // The end of the time period for which ML Detect mitigation actions tasks are // returned. // // This member is required. EndTime *time.Time - // A filter to limit results to those found after the specified time. You must + // A filter to limit results to those found after the specified time. You must // specify either the startTime and endTime or the taskId, but not both. // // This member is required. @@ -47,7 +49,7 @@ type ListDetectMitigationActionsTasksInput struct { // The maximum number of results to return at one time. The default is 25. MaxResults *int32 - // The token for the next set of results. + // The token for the next set of results. NextToken *string noSmithyDocumentSerde @@ -55,11 +57,11 @@ type ListDetectMitigationActionsTasksInput struct { type ListDetectMitigationActionsTasksOutput struct { - // A token that can be used to retrieve the next set of results, or null if there + // A token that can be used to retrieve the next set of results, or null if there // are no additional results. NextToken *string - // The collection of ML Detect mitigation tasks that matched the filter criteria. + // The collection of ML Detect mitigation tasks that matched the filter criteria. Tasks []types.DetectMitigationActionsTaskSummary // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_ListDimensions.go b/service/iot/api_op_ListDimensions.go index cd82b8cd0c0..0b23901b82f 100644 --- a/service/iot/api_op_ListDimensions.go +++ b/service/iot/api_op_ListDimensions.go @@ -11,8 +11,11 @@ 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) -// action. +// accounts. +// +// Requires permission to access the [ListDimensions] action. +// +// [ListDimensions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListDimensions(ctx context.Context, params *ListDimensionsInput, optFns ...func(*Options)) (*ListDimensionsOutput, error) { if params == nil { params = &ListDimensionsInput{} diff --git a/service/iot/api_op_ListDomainConfigurations.go b/service/iot/api_op_ListDomainConfigurations.go index bf0222e916a..53b2fdfe123 100644 --- a/service/iot/api_op_ListDomainConfigurations.go +++ b/service/iot/api_op_ListDomainConfigurations.go @@ -12,9 +12,11 @@ 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) -// action. +// alphabetically by domain configuration name. +// +// Requires permission to access the [ListDomainConfigurations] action. +// +// [ListDomainConfigurations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListDomainConfigurations(ctx context.Context, params *ListDomainConfigurationsInput, optFns ...func(*Options)) (*ListDomainConfigurationsOutput, error) { if params == nil { params = &ListDomainConfigurationsInput{} diff --git a/service/iot/api_op_ListFleetMetrics.go b/service/iot/api_op_ListFleetMetrics.go index 75414ba302b..2bf41859c76 100644 --- a/service/iot/api_op_ListFleetMetrics.go +++ b/service/iot/api_op_ListFleetMetrics.go @@ -11,8 +11,11 @@ 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) -// action. +// Lists all your fleet metrics. +// +// Requires permission to access the [ListFleetMetrics] action. +// +// [ListFleetMetrics]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListFleetMetrics(ctx context.Context, params *ListFleetMetricsInput, optFns ...func(*Options)) (*ListFleetMetricsOutput, error) { if params == nil { params = &ListFleetMetricsInput{} diff --git a/service/iot/api_op_ListIndices.go b/service/iot/api_op_ListIndices.go index b82a66cf301..505273fa52d 100644 --- a/service/iot/api_op_ListIndices.go +++ b/service/iot/api_op_ListIndices.go @@ -10,8 +10,11 @@ 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) -// action. +// Lists the search indices. +// +// Requires permission to access the [ListIndices] action. +// +// [ListIndices]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optFns ...func(*Options)) (*ListIndicesOutput, error) { if params == nil { params = &ListIndicesInput{} diff --git a/service/iot/api_op_ListJobExecutionsForJob.go b/service/iot/api_op_ListJobExecutionsForJob.go index f049824f8dd..e8419a55252 100644 --- a/service/iot/api_op_ListJobExecutionsForJob.go +++ b/service/iot/api_op_ListJobExecutionsForJob.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the job executions for a job. +// +// Requires permission to access the [ListJobExecutionsForJob] action. +// +// [ListJobExecutionsForJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListJobExecutionsForJob(ctx context.Context, params *ListJobExecutionsForJobInput, optFns ...func(*Options)) (*ListJobExecutionsForJobOutput, error) { if params == nil { params = &ListJobExecutionsForJobInput{} diff --git a/service/iot/api_op_ListJobExecutionsForThing.go b/service/iot/api_op_ListJobExecutionsForThing.go index ac3fc124890..7c776e6a2d9 100644 --- a/service/iot/api_op_ListJobExecutionsForThing.go +++ b/service/iot/api_op_ListJobExecutionsForThing.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the job executions for the specified thing. +// +// Requires permission to access the [ListJobExecutionsForThing] action. +// +// [ListJobExecutionsForThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListJobExecutionsForThing(ctx context.Context, params *ListJobExecutionsForThingInput, optFns ...func(*Options)) (*ListJobExecutionsForThingOutput, error) { if params == nil { params = &ListJobExecutionsForThingInput{} @@ -42,12 +44,18 @@ type ListJobExecutionsForThingInput struct { // The maximum number of results to be returned per request. MaxResults *int32 - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string // The token to retrieve the next set of results. diff --git a/service/iot/api_op_ListJobTemplates.go b/service/iot/api_op_ListJobTemplates.go index 3d842717960..e468c0a1d79 100644 --- a/service/iot/api_op_ListJobTemplates.go +++ b/service/iot/api_op_ListJobTemplates.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Returns a list of job templates. +// +// Requires permission to access the [ListJobTemplates] action. +// +// [ListJobTemplates]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListJobTemplates(ctx context.Context, params *ListJobTemplatesInput, optFns ...func(*Options)) (*ListJobTemplatesOutput, error) { if params == nil { params = &ListJobTemplatesInput{} diff --git a/service/iot/api_op_ListJobs.go b/service/iot/api_op_ListJobs.go index 83c3325b772..1056f1b5a45 100644 --- a/service/iot/api_op_ListJobs.go +++ b/service/iot/api_op_ListJobs.go @@ -11,8 +11,11 @@ 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) -// action. +// Lists jobs. +// +// Requires permission to access the [ListJobs] action. +// +// [ListJobs]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error) { if params == nil { params = &ListJobsInput{} @@ -33,12 +36,18 @@ type ListJobsInput struct { // The maximum number of results to return per request. MaxResults *int32 - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string // The token to retrieve the next set of results. @@ -52,10 +61,11 @@ type ListJobsInput struct { // (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. + // 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_ListMitigationActions.go b/service/iot/api_op_ListMitigationActions.go index 273902acbbd..d414ce18ff2 100644 --- a/service/iot/api_op_ListMitigationActions.go +++ b/service/iot/api_op_ListMitigationActions.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [ListMitigationActions] action. +// +// [ListMitigationActions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListMitigationActions(ctx context.Context, params *ListMitigationActionsInput, optFns ...func(*Options)) (*ListMitigationActionsOutput, error) { if params == nil { params = &ListMitigationActionsInput{} diff --git a/service/iot/api_op_ListOTAUpdates.go b/service/iot/api_op_ListOTAUpdates.go index 56c17122e67..ca5f6ff327d 100644 --- a/service/iot/api_op_ListOTAUpdates.go +++ b/service/iot/api_op_ListOTAUpdates.go @@ -11,8 +11,11 @@ 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) -// action. +// Lists OTA updates. +// +// Requires permission to access the [ListOTAUpdates] action. +// +// [ListOTAUpdates]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListOTAUpdates(ctx context.Context, params *ListOTAUpdatesInput, optFns ...func(*Options)) (*ListOTAUpdatesOutput, error) { if params == nil { params = &ListOTAUpdatesInput{} diff --git a/service/iot/api_op_ListOutgoingCertificates.go b/service/iot/api_op_ListOutgoingCertificates.go index ce617905c93..b8a3b4c006c 100644 --- a/service/iot/api_op_ListOutgoingCertificates.go +++ b/service/iot/api_op_ListOutgoingCertificates.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists certificates that are being transferred but not yet accepted. +// +// Requires permission to access the [ListOutgoingCertificates] action. +// +// [ListOutgoingCertificates]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListOutgoingCertificates(ctx context.Context, params *ListOutgoingCertificatesInput, optFns ...func(*Options)) (*ListOutgoingCertificatesOutput, error) { if params == nil { params = &ListOutgoingCertificatesInput{} diff --git a/service/iot/api_op_ListPackageVersions.go b/service/iot/api_op_ListPackageVersions.go index 6335f139d31..942238f9fe0 100644 --- a/service/iot/api_op_ListPackageVersions.go +++ b/service/iot/api_op_ListPackageVersions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the software package versions associated to the account. Requires -// permission to access the ListPackageVersions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Lists the software package versions associated to the account. +// +// Requires permission to access the [ListPackageVersions] action. +// +// [ListPackageVersions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListPackageVersions(ctx context.Context, params *ListPackageVersionsInput, optFns ...func(*Options)) (*ListPackageVersionsOutput, error) { if params == nil { params = &ListPackageVersionsInput{} @@ -42,9 +44,9 @@ type ListPackageVersionsInput struct { // The token for the next set of results. NextToken *string - // The status of the package version. For more information, see Package version - // lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . + // The status of the package version. For more information, see [Package version lifecycle]. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle Status types.PackageVersionStatus noSmithyDocumentSerde diff --git a/service/iot/api_op_ListPackages.go b/service/iot/api_op_ListPackages.go index ff918ffad47..101b9c6cad6 100644 --- a/service/iot/api_op_ListPackages.go +++ b/service/iot/api_op_ListPackages.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the software packages associated to the account. Requires permission to -// access the ListPackages (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Lists the software packages associated to the account. +// +// Requires permission to access the [ListPackages] action. +// +// [ListPackages]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListPackages(ctx context.Context, params *ListPackagesInput, optFns ...func(*Options)) (*ListPackagesOutput, error) { if params == nil { params = &ListPackagesInput{} diff --git a/service/iot/api_op_ListPolicies.go b/service/iot/api_op_ListPolicies.go index 7331df21c59..7f56124baf5 100644 --- a/service/iot/api_op_ListPolicies.go +++ b/service/iot/api_op_ListPolicies.go @@ -11,8 +11,11 @@ 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) -// action. +// Lists your policies. +// +// Requires permission to access the [ListPolicies] action. +// +// [ListPolicies]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error) { if params == nil { params = &ListPoliciesInput{} diff --git a/service/iot/api_op_ListPolicyPrincipals.go b/service/iot/api_op_ListPolicyPrincipals.go index 8270b8bdd29..4206f4c6090 100644 --- a/service/iot/api_op_ListPolicyPrincipals.go +++ b/service/iot/api_op_ListPolicyPrincipals.go @@ -10,13 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// 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 ListTargetsForPolicyinstead. +// +// Requires permission to access the [ListPolicyPrincipals] action. // // Deprecated: This operation has been deprecated. +// +// [ListPolicyPrincipals]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListPolicyPrincipals(ctx context.Context, params *ListPolicyPrincipalsInput, optFns ...func(*Options)) (*ListPolicyPrincipalsOutput, error) { if params == nil { params = &ListPolicyPrincipalsInput{} diff --git a/service/iot/api_op_ListPolicyVersions.go b/service/iot/api_op_ListPolicyVersions.go index 4e655dee31d..7b0f6bc4150 100644 --- a/service/iot/api_op_ListPolicyVersions.go +++ b/service/iot/api_op_ListPolicyVersions.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [ListPolicyVersions] action. +// +// [ListPolicyVersions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListPolicyVersions(ctx context.Context, params *ListPolicyVersionsInput, optFns ...func(*Options)) (*ListPolicyVersionsOutput, error) { if params == nil { params = &ListPolicyVersionsInput{} diff --git a/service/iot/api_op_ListPrincipalPolicies.go b/service/iot/api_op_ListPrincipalPolicies.go index 8dfbe0a2813..64a19501107 100644 --- a/service/iot/api_op_ListPrincipalPolicies.go +++ b/service/iot/api_op_ListPrincipalPolicies.go @@ -12,13 +12,17 @@ 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 -// 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) -// action. +// identity, the ID must be in [AmazonCognito Identity format]. +// +// Note: This action is deprecated and works as expected for backward +// compatibility, but we won't add enhancements. Use ListAttachedPoliciesinstead. +// +// Requires permission to access the [ListPrincipalPolicies] action. // // Deprecated: This operation has been deprecated. +// +// [ListPrincipalPolicies]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [AmazonCognito Identity format]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax func (c *Client) ListPrincipalPolicies(ctx context.Context, params *ListPrincipalPoliciesInput, optFns ...func(*Options)) (*ListPrincipalPoliciesOutput, error) { if params == nil { params = &ListPrincipalPoliciesInput{} diff --git a/service/iot/api_op_ListPrincipalThings.go b/service/iot/api_op_ListPrincipalThings.go index 501a3d884bd..ec331ba288b 100644 --- a/service/iot/api_op_ListPrincipalThings.go +++ b/service/iot/api_op_ListPrincipalThings.go @@ -12,8 +12,11 @@ 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) -// action. +// federated identities. +// +// Requires permission to access the [ListPrincipalThings] action. +// +// [ListPrincipalThings]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListPrincipalThings(ctx context.Context, params *ListPrincipalThingsInput, optFns ...func(*Options)) (*ListPrincipalThingsOutput, error) { if params == nil { params = &ListPrincipalThingsInput{} diff --git a/service/iot/api_op_ListProvisioningTemplateVersions.go b/service/iot/api_op_ListProvisioningTemplateVersions.go index d9b23f5efd4..31518343dd9 100644 --- a/service/iot/api_op_ListProvisioningTemplateVersions.go +++ b/service/iot/api_op_ListProvisioningTemplateVersions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// A list of provisioning template versions. +// +// Requires permission to access the [ListProvisioningTemplateVersions] action. +// +// [ListProvisioningTemplateVersions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListProvisioningTemplateVersions(ctx context.Context, params *ListProvisioningTemplateVersionsInput, optFns ...func(*Options)) (*ListProvisioningTemplateVersionsOutput, error) { if params == nil { params = &ListProvisioningTemplateVersionsInput{} diff --git a/service/iot/api_op_ListProvisioningTemplates.go b/service/iot/api_op_ListProvisioningTemplates.go index ff334974339..5422f83fb19 100644 --- a/service/iot/api_op_ListProvisioningTemplates.go +++ b/service/iot/api_op_ListProvisioningTemplates.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the provisioning templates in your Amazon Web Services account. +// +// Requires permission to access the [ListProvisioningTemplates] action. +// +// [ListProvisioningTemplates]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListProvisioningTemplates(ctx context.Context, params *ListProvisioningTemplatesInput, optFns ...func(*Options)) (*ListProvisioningTemplatesOutput, error) { if params == nil { params = &ListProvisioningTemplatesInput{} diff --git a/service/iot/api_op_ListRelatedResourcesForAuditFinding.go b/service/iot/api_op_ListRelatedResourcesForAuditFinding.go index 608decb7777..d5e4648fbb1 100644 --- a/service/iot/api_op_ListRelatedResourcesForAuditFinding.go +++ b/service/iot/api_op_ListRelatedResourcesForAuditFinding.go @@ -13,22 +13,33 @@ 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 // -// 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) -// 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. +// This API is similar to DescribeAuditFinding's [RelatedResources] but provides pagination and is +// not limited to 10 resources. When calling [DescribeAuditFinding]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. +// +// [RelatedResources]: https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html +// [DescribeAuditFinding]: https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuditFinding.html func (c *Client) ListRelatedResourcesForAuditFinding(ctx context.Context, params *ListRelatedResourcesForAuditFindingInput, optFns ...func(*Options)) (*ListRelatedResourcesForAuditFindingOutput, error) { if params == nil { params = &ListRelatedResourcesForAuditFindingInput{} diff --git a/service/iot/api_op_ListRoleAliases.go b/service/iot/api_op_ListRoleAliases.go index 4446a983a3e..e0a4394f27d 100644 --- a/service/iot/api_op_ListRoleAliases.go +++ b/service/iot/api_op_ListRoleAliases.go @@ -10,9 +10,11 @@ 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) -// action. +// Lists the role aliases registered in your account. +// +// Requires permission to access the [ListRoleAliases] action. +// +// [ListRoleAliases]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListRoleAliases(ctx context.Context, params *ListRoleAliasesInput, optFns ...func(*Options)) (*ListRoleAliasesOutput, error) { if params == nil { params = &ListRoleAliasesInput{} diff --git a/service/iot/api_op_ListScheduledAudits.go b/service/iot/api_op_ListScheduledAudits.go index c429d308a49..a2590cc8b61 100644 --- a/service/iot/api_op_ListScheduledAudits.go +++ b/service/iot/api_op_ListScheduledAudits.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists all of your scheduled audits. +// +// Requires permission to access the [ListScheduledAudits] action. +// +// [ListScheduledAudits]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListScheduledAudits(ctx context.Context, params *ListScheduledAuditsInput, optFns ...func(*Options)) (*ListScheduledAuditsOutput, error) { if params == nil { params = &ListScheduledAuditsInput{} diff --git a/service/iot/api_op_ListSecurityProfiles.go b/service/iot/api_op_ListSecurityProfiles.go index 7908b2501c4..60e5ed0a8a5 100644 --- a/service/iot/api_op_ListSecurityProfiles.go +++ b/service/iot/api_op_ListSecurityProfiles.go @@ -12,9 +12,13 @@ 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) -// action. dimensionName and metricName cannot be used in the same request. +// security profiles by dimension or custom metric. +// +// Requires permission to access the [ListSecurityProfiles] action. +// +// dimensionName and metricName cannot be used in the same request. +// +// [ListSecurityProfiles]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListSecurityProfiles(ctx context.Context, params *ListSecurityProfilesInput, optFns ...func(*Options)) (*ListSecurityProfilesOutput, error) { if params == nil { params = &ListSecurityProfilesInput{} @@ -39,7 +43,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 047e4946f10..3e49c3c1057 100644 --- a/service/iot/api_op_ListSecurityProfilesForTarget.go +++ b/service/iot/api_op_ListSecurityProfilesForTarget.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [ListSecurityProfilesForTarget] action. +// +// [ListSecurityProfilesForTarget]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListSecurityProfilesForTarget(ctx context.Context, params *ListSecurityProfilesForTargetInput, optFns ...func(*Options)) (*ListSecurityProfilesForTargetOutput, error) { if params == nil { params = &ListSecurityProfilesForTargetInput{} diff --git a/service/iot/api_op_ListStreams.go b/service/iot/api_op_ListStreams.go index b959c91538c..f9f2104acc5 100644 --- a/service/iot/api_op_ListStreams.go +++ b/service/iot/api_op_ListStreams.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists all of the streams in your Amazon Web Services account. +// +// Requires permission to access the [ListStreams] action. +// +// [ListStreams]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error) { if params == nil { params = &ListStreamsInput{} diff --git a/service/iot/api_op_ListTagsForResource.go b/service/iot/api_op_ListTagsForResource.go index 978f90dc565..a1e870fb040 100644 --- a/service/iot/api_op_ListTagsForResource.go +++ b/service/iot/api_op_ListTagsForResource.go @@ -11,9 +11,11 @@ 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) -// action. +// Lists the tags (metadata) you have assigned to the resource. +// +// Requires permission to access the [ListTagsForResource] action. +// +// [ListTagsForResource]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/iot/api_op_ListTargetsForPolicy.go b/service/iot/api_op_ListTargetsForPolicy.go index 316ae27ad89..a82a8b652d2 100644 --- a/service/iot/api_op_ListTargetsForPolicy.go +++ b/service/iot/api_op_ListTargetsForPolicy.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// List targets for the specified policy. +// +// Requires permission to access the [ListTargetsForPolicy] action. +// +// [ListTargetsForPolicy]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTargetsForPolicy(ctx context.Context, params *ListTargetsForPolicyInput, optFns ...func(*Options)) (*ListTargetsForPolicyOutput, error) { if params == nil { params = &ListTargetsForPolicyInput{} diff --git a/service/iot/api_op_ListTargetsForSecurityProfile.go b/service/iot/api_op_ListTargetsForSecurityProfile.go index 79e8a68b291..116937e4da2 100644 --- a/service/iot/api_op_ListTargetsForSecurityProfile.go +++ b/service/iot/api_op_ListTargetsForSecurityProfile.go @@ -12,9 +12,11 @@ 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) -// action. +// security profile. +// +// Requires permission to access the [ListTargetsForSecurityProfile] action. +// +// [ListTargetsForSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTargetsForSecurityProfile(ctx context.Context, params *ListTargetsForSecurityProfileInput, optFns ...func(*Options)) (*ListTargetsForSecurityProfileOutput, error) { if params == nil { params = &ListTargetsForSecurityProfileInput{} diff --git a/service/iot/api_op_ListThingGroups.go b/service/iot/api_op_ListThingGroups.go index 5f68e53c537..d874bffd382 100644 --- a/service/iot/api_op_ListThingGroups.go +++ b/service/iot/api_op_ListThingGroups.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// List the thing groups in your account. +// +// Requires permission to access the [ListThingGroups] action. +// +// [ListThingGroups]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingGroups(ctx context.Context, params *ListThingGroupsInput, optFns ...func(*Options)) (*ListThingGroupsOutput, error) { if params == nil { params = &ListThingGroupsInput{} diff --git a/service/iot/api_op_ListThingGroupsForThing.go b/service/iot/api_op_ListThingGroupsForThing.go index 6d0a753b2d8..1112e969ce3 100644 --- a/service/iot/api_op_ListThingGroupsForThing.go +++ b/service/iot/api_op_ListThingGroupsForThing.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// List the thing groups to which the specified thing belongs. +// +// Requires permission to access the [ListThingGroupsForThing] action. +// +// [ListThingGroupsForThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingGroupsForThing(ctx context.Context, params *ListThingGroupsForThingInput, optFns ...func(*Options)) (*ListThingGroupsForThingOutput, error) { if params == nil { params = &ListThingGroupsForThingInput{} diff --git a/service/iot/api_op_ListThingPrincipals.go b/service/iot/api_op_ListThingPrincipals.go index ec671168de4..3e51b742196 100644 --- a/service/iot/api_op_ListThingPrincipals.go +++ b/service/iot/api_op_ListThingPrincipals.go @@ -12,8 +12,11 @@ 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) -// action. +// federated identities. +// +// Requires permission to access the [ListThingPrincipals] action. +// +// [ListThingPrincipals]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingPrincipals(ctx context.Context, params *ListThingPrincipalsInput, optFns ...func(*Options)) (*ListThingPrincipalsOutput, error) { if params == nil { params = &ListThingPrincipalsInput{} diff --git a/service/iot/api_op_ListThingRegistrationTasks.go b/service/iot/api_op_ListThingRegistrationTasks.go index ecf1e6a2f79..9c7a509d91e 100644 --- a/service/iot/api_op_ListThingRegistrationTasks.go +++ b/service/iot/api_op_ListThingRegistrationTasks.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// List bulk thing provisioning tasks. +// +// Requires permission to access the [ListThingRegistrationTasks] action. +// +// [ListThingRegistrationTasks]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingRegistrationTasks(ctx context.Context, params *ListThingRegistrationTasksInput, optFns ...func(*Options)) (*ListThingRegistrationTasksOutput, error) { if params == nil { params = &ListThingRegistrationTasksInput{} diff --git a/service/iot/api_op_ListThingTypes.go b/service/iot/api_op_ListThingTypes.go index 0b371619a3e..cc96f7d3a1c 100644 --- a/service/iot/api_op_ListThingTypes.go +++ b/service/iot/api_op_ListThingTypes.go @@ -11,8 +11,11 @@ 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) -// action. +// Lists the existing thing types. +// +// Requires permission to access the [ListThingTypes] action. +// +// [ListThingTypes]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingTypes(ctx context.Context, params *ListThingTypesInput, optFns ...func(*Options)) (*ListThingTypesOutput, error) { if params == nil { params = &ListThingTypesInput{} diff --git a/service/iot/api_op_ListThings.go b/service/iot/api_op_ListThings.go index 1d5cfcef71e..07451d10e46 100644 --- a/service/iot/api_op_ListThings.go +++ b/service/iot/api_op_ListThings.go @@ -14,12 +14,17 @@ import ( // 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) -// 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. +// attribute Color with the value Red. For more information, see [List Things]from the Amazon +// Web Services IoT Core Developer Guide. +// +// Requires permission to access the [ListThings] 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. +// +// [List Things]: https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html#list-things +// [ListThings]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThings(ctx context.Context, params *ListThingsInput, optFns ...func(*Options)) (*ListThingsOutput, error) { if params == nil { params = &ListThingsInput{} @@ -55,9 +60,10 @@ type ListThingsInput struct { 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 - // returns only the thing resources with attribute values that match the entire - // attributeValue provided. + // 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 noSmithyDocumentSerde diff --git a/service/iot/api_op_ListThingsInBillingGroup.go b/service/iot/api_op_ListThingsInBillingGroup.go index bf3126a0e20..4640b3829b9 100644 --- a/service/iot/api_op_ListThingsInBillingGroup.go +++ b/service/iot/api_op_ListThingsInBillingGroup.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the things you have added to the given billing group. +// +// Requires permission to access the [ListThingsInBillingGroup] action. +// +// [ListThingsInBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingsInBillingGroup(ctx context.Context, params *ListThingsInBillingGroupInput, optFns ...func(*Options)) (*ListThingsInBillingGroupOutput, error) { if params == nil { params = &ListThingsInBillingGroupInput{} diff --git a/service/iot/api_op_ListThingsInThingGroup.go b/service/iot/api_op_ListThingsInThingGroup.go index 5a06b74ced6..cc54f4ed6fe 100644 --- a/service/iot/api_op_ListThingsInThingGroup.go +++ b/service/iot/api_op_ListThingsInThingGroup.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the things in the specified group. +// +// Requires permission to access the [ListThingsInThingGroup] action. +// +// [ListThingsInThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListThingsInThingGroup(ctx context.Context, params *ListThingsInThingGroupInput, optFns ...func(*Options)) (*ListThingsInThingGroupOutput, error) { if params == nil { params = &ListThingsInThingGroupInput{} diff --git a/service/iot/api_op_ListTopicRuleDestinations.go b/service/iot/api_op_ListTopicRuleDestinations.go index ebbb38bf2a0..1e99a31f98a 100644 --- a/service/iot/api_op_ListTopicRuleDestinations.go +++ b/service/iot/api_op_ListTopicRuleDestinations.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [ListTopicRuleDestinations] action. +// +// [ListTopicRuleDestinations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTopicRuleDestinations(ctx context.Context, params *ListTopicRuleDestinationsInput, optFns ...func(*Options)) (*ListTopicRuleDestinationsOutput, error) { if params == nil { params = &ListTopicRuleDestinationsInput{} diff --git a/service/iot/api_op_ListTopicRules.go b/service/iot/api_op_ListTopicRules.go index 59e36b09c26..eecf763b3e4 100644 --- a/service/iot/api_op_ListTopicRules.go +++ b/service/iot/api_op_ListTopicRules.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the rules for the specific topic. +// +// Requires permission to access the [ListTopicRules] action. +// +// [ListTopicRules]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTopicRules(ctx context.Context, params *ListTopicRulesInput, optFns ...func(*Options)) (*ListTopicRulesOutput, error) { if params == nil { params = &ListTopicRulesInput{} diff --git a/service/iot/api_op_ListV2LoggingLevels.go b/service/iot/api_op_ListV2LoggingLevels.go index a3823c9c1cc..4945be96c26 100644 --- a/service/iot/api_op_ListV2LoggingLevels.go +++ b/service/iot/api_op_ListV2LoggingLevels.go @@ -11,8 +11,11 @@ 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) -// action. +// Lists logging levels. +// +// Requires permission to access the [ListV2LoggingLevels] action. +// +// [ListV2LoggingLevels]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListV2LoggingLevels(ctx context.Context, params *ListV2LoggingLevelsInput, optFns ...func(*Options)) (*ListV2LoggingLevelsOutput, error) { if params == nil { params = &ListV2LoggingLevelsInput{} diff --git a/service/iot/api_op_ListViolationEvents.go b/service/iot/api_op_ListViolationEvents.go index 9c1c01d6e8d..e7795857d27 100644 --- a/service/iot/api_op_ListViolationEvents.go +++ b/service/iot/api_op_ListViolationEvents.go @@ -14,9 +14,11 @@ 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) -// action. +// issued for a particular security profile, behavior, or thing (device). +// +// Requires permission to access the [ListViolationEvents] action. +// +// [ListViolationEvents]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListViolationEvents(ctx context.Context, params *ListViolationEventsInput, optFns ...func(*Options)) (*ListViolationEventsOutput, error) { if params == nil { params = &ListViolationEventsInput{} @@ -44,10 +46,10 @@ type ListViolationEventsInput struct { // This member is required. StartTime *time.Time - // The criteria for a behavior. + // The criteria for a behavior. BehaviorCriteriaType types.BehaviorCriteriaType - // A list of all suppressed alerts. + // A list of all suppressed alerts. ListSuppressedAlerts *bool // The maximum number of results to return at one time. diff --git a/service/iot/api_op_RegisterCACertificate.go b/service/iot/api_op_RegisterCACertificate.go index 2d10feada36..fa463bc870f 100644 --- a/service/iot/api_op_RegisterCACertificate.go +++ b/service/iot/api_op_RegisterCACertificate.go @@ -14,9 +14,11 @@ import ( // Registers a CA certificate with Amazon Web Services IoT Core. There is no limit // 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) -// action. +// field per Amazon Web Services account. +// +// Requires permission to access the [RegisterCACertificate] action. +// +// [RegisterCACertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) RegisterCACertificate(ctx context.Context, params *RegisterCACertificateInput, optFns ...func(*Options)) (*RegisterCACertificateOutput, error) { if params == nil { params = &RegisterCACertificateInput{} @@ -50,22 +52,27 @@ type RegisterCACertificateInput struct { // 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) - // . + // CA. For more information about certificate mode for device certificates, see [certificate mode]. + // + // [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. RegistrationConfig *types.RegistrationConfig - // A boolean value that specifies if the CA certificate is set to active. Valid - // values: ACTIVE | INACTIVE + // A boolean value that specifies if the CA certificate is set to active. + // + // Valid values: ACTIVE | INACTIVE SetAsActive bool - // Metadata which can be used to manage the CA certificate. For URI Request - // parameters use format: ...key1=value1&key2=value2... For the CLI command-line - // parameter use format: &&tags "key1=value1&key2=value2..." For the cli-input-json - // file use format: "tags": "key1=value1&key2=value2..." + // Metadata which can be used to manage the CA certificate. + // + // For URI Request parameters use format: ...key1=value1&key2=value2... + // + // For the CLI command-line parameter use format: &&tags + // "key1=value1&key2=value2..." + // + // For the cli-input-json file use format: "tags": "key1=value1&key2=value2..." Tags []types.Tag // The private key verification certificate. If certificateMode is SNI_ONLY , the diff --git a/service/iot/api_op_RegisterCertificate.go b/service/iot/api_op_RegisterCertificate.go index 675cc8c6ca8..e2151445737 100644 --- a/service/iot/api_op_RegisterCertificate.go +++ b/service/iot/api_op_RegisterCertificate.go @@ -11,12 +11,15 @@ 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) -// 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) -// action. +// Registers a device certificate with IoT in the same [certificate mode] 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] action. +// +// [RegisterCertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [certificate mode]: https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode func (c *Client) RegisterCertificate(ctx context.Context, params *RegisterCertificateInput, optFns ...func(*Options)) (*RegisterCertificateOutput, error) { if params == nil { params = &RegisterCertificateInput{} @@ -43,8 +46,9 @@ type RegisterCertificateInput struct { // The CA certificate used to sign the device certificate being registered. CaCertificatePem *string - // A boolean value that specifies if the certificate is set to active. Valid - // values: ACTIVE | INACTIVE + // A boolean value that specifies if the certificate is set to active. + // + // Valid values: ACTIVE | INACTIVE // // Deprecated: This member has been deprecated. SetAsActive *bool diff --git a/service/iot/api_op_RegisterCertificateWithoutCA.go b/service/iot/api_op_RegisterCertificateWithoutCA.go index 8cfed10f091..195e2306996 100644 --- a/service/iot/api_op_RegisterCertificateWithoutCA.go +++ b/service/iot/api_op_RegisterCertificateWithoutCA.go @@ -12,8 +12,9 @@ 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]. +// +// [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 e595ba821d1..dd615c084c2 100644 --- a/service/iot/api_op_RegisterThing.go +++ b/service/iot/api_op_RegisterThing.go @@ -11,12 +11,14 @@ import ( ) // 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. +// control plane APIs. These calls might exceed your account level [IoT Throttling Limits]and cause +// throttle errors. Please contact [Amazon Web Services Customer Support]to raise your throttling limits if necessary. +// +// Requires permission to access the [RegisterThing] action. +// +// [IoT Throttling Limits]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_iot +// [RegisterThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions +// [Amazon Web Services Customer Support]: https://console.aws.amazon.com/support/home func (c *Client) RegisterThing(ctx context.Context, params *RegisterThingInput, optFns ...func(*Options)) (*RegisterThingOutput, error) { if params == nil { params = &RegisterThingInput{} @@ -34,15 +36,16 @@ 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) - // for more information. + // The provisioning template. See [Provisioning Devices That Have Device Certificates] for more information. + // + // [Provisioning Devices That Have Device Certificates]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html // // 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) - // for more information. + // The parameters for provisioning a thing. See [Provisioning Templates] for more information. + // + // [Provisioning Templates]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html Parameters map[string]string noSmithyDocumentSerde diff --git a/service/iot/api_op_RejectCertificateTransfer.go b/service/iot/api_op_RejectCertificateTransfer.go index 3a59d91bb84..bf52f056bc5 100644 --- a/service/iot/api_op_RejectCertificateTransfer.go +++ b/service/iot/api_op_RejectCertificateTransfer.go @@ -11,13 +11,18 @@ 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) -// action. +// 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] action. +// +// [RejectCertificateTransfer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) RejectCertificateTransfer(ctx context.Context, params *RejectCertificateTransferInput, optFns ...func(*Options)) (*RejectCertificateTransferOutput, error) { if params == nil { params = &RejectCertificateTransferInput{} diff --git a/service/iot/api_op_RemoveThingFromBillingGroup.go b/service/iot/api_op_RemoveThingFromBillingGroup.go index 2cecde25b59..161806dbe3d 100644 --- a/service/iot/api_op_RemoveThingFromBillingGroup.go +++ b/service/iot/api_op_RemoveThingFromBillingGroup.go @@ -10,10 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. This call is asynchronous. It might take several seconds for the -// detachment to propagate. +// Removes the given thing from the billing group. +// +// Requires permission to access the [RemoveThingFromBillingGroup] action. +// +// This call is asynchronous. It might take several seconds for the detachment to +// propagate. +// +// [RemoveThingFromBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) RemoveThingFromBillingGroup(ctx context.Context, params *RemoveThingFromBillingGroupInput, optFns ...func(*Options)) (*RemoveThingFromBillingGroupOutput, error) { if params == nil { params = &RemoveThingFromBillingGroupInput{} diff --git a/service/iot/api_op_RemoveThingFromThingGroup.go b/service/iot/api_op_RemoveThingFromThingGroup.go index 97d28ab5eff..29cd8aa2a83 100644 --- a/service/iot/api_op_RemoveThingFromThingGroup.go +++ b/service/iot/api_op_RemoveThingFromThingGroup.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// 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] action. +// +// [RemoveThingFromThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) RemoveThingFromThingGroup(ctx context.Context, params *RemoveThingFromThingGroupInput, optFns ...func(*Options)) (*RemoveThingFromThingGroupOutput, error) { if params == nil { params = &RemoveThingFromThingGroupInput{} diff --git a/service/iot/api_op_ReplaceTopicRule.go b/service/iot/api_op_ReplaceTopicRule.go index 77cb17dde60..0b7485a8446 100644 --- a/service/iot/api_op_ReplaceTopicRule.go +++ b/service/iot/api_op_ReplaceTopicRule.go @@ -13,9 +13,11 @@ 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) -// action. +// rules will be able to access data processed by the rule. +// +// Requires permission to access the [ReplaceTopicRule] action. +// +// [ReplaceTopicRule]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ReplaceTopicRule(ctx context.Context, params *ReplaceTopicRuleInput, optFns ...func(*Options)) (*ReplaceTopicRuleOutput, error) { if params == nil { params = &ReplaceTopicRuleInput{} diff --git a/service/iot/api_op_SearchIndex.go b/service/iot/api_op_SearchIndex.go index 682bb2e383f..7253a89758d 100644 --- a/service/iot/api_op_SearchIndex.go +++ b/service/iot/api_op_SearchIndex.go @@ -11,8 +11,11 @@ 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) -// action. +// The query search index. +// +// Requires permission to access the [SearchIndex] action. +// +// [SearchIndex]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) SearchIndex(ctx context.Context, params *SearchIndexInput, optFns ...func(*Options)) (*SearchIndexOutput, error) { if params == nil { params = &SearchIndexInput{} @@ -31,8 +34,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) - // . + // see [Query syntax]. + // + // [Query syntax]: https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html // // This member is required. QueryString *string @@ -42,8 +46,10 @@ type SearchIndexInput struct { // The maximum number of results to return per page at one time. This maximum // number cannot exceed 100. The response might contain fewer results but will - // never contain more. You can use nextToken (https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken) - // to retrieve the next set of results until nextToken returns NULL . + // never contain more. You can use [nextToken]nextToken to retrieve the next set of results + // until nextToken returns NULL . + // + // [nextToken]: https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken MaxResults *int32 // The token used to get the next set of results, or null if there are no diff --git a/service/iot/api_op_SetDefaultAuthorizer.go b/service/iot/api_op_SetDefaultAuthorizer.go index ec2a4dfe934..b9a08107400 100644 --- a/service/iot/api_op_SetDefaultAuthorizer.go +++ b/service/iot/api_op_SetDefaultAuthorizer.go @@ -11,9 +11,11 @@ import ( ) // 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. +// made without specifying an authorizer. +// +// Requires permission to access the [SetDefaultAuthorizer] action. +// +// [SetDefaultAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) SetDefaultAuthorizer(ctx context.Context, params *SetDefaultAuthorizerInput, optFns ...func(*Options)) (*SetDefaultAuthorizerOutput, error) { if params == nil { params = &SetDefaultAuthorizerInput{} diff --git a/service/iot/api_op_SetDefaultPolicyVersion.go b/service/iot/api_op_SetDefaultPolicyVersion.go index 1d6bc3ca404..42a997d8b91 100644 --- a/service/iot/api_op_SetDefaultPolicyVersion.go +++ b/service/iot/api_op_SetDefaultPolicyVersion.go @@ -12,10 +12,11 @@ import ( // Sets the specified version of the specified policy as the policy's default // (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) -// action. +// attached. To list the principals the policy is attached to, use the ListPrincipalPoliciesaction. +// +// Requires permission to access the [SetDefaultPolicyVersion] action. +// +// [SetDefaultPolicyVersion]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) SetDefaultPolicyVersion(ctx context.Context, params *SetDefaultPolicyVersionInput, optFns ...func(*Options)) (*SetDefaultPolicyVersionOutput, error) { if params == nil { params = &SetDefaultPolicyVersionInput{} diff --git a/service/iot/api_op_SetLoggingOptions.go b/service/iot/api_op_SetLoggingOptions.go index 0c2d5a8bb4b..5e7bcac6cc9 100644 --- a/service/iot/api_op_SetLoggingOptions.go +++ b/service/iot/api_op_SetLoggingOptions.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Sets the logging options. +// +// NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. +// +// Requires permission to access the [SetLoggingOptions] action. +// +// [SetLoggingOptions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) SetLoggingOptions(ctx context.Context, params *SetLoggingOptionsInput, optFns ...func(*Options)) (*SetLoggingOptionsOutput, error) { if params == nil { params = &SetLoggingOptionsInput{} diff --git a/service/iot/api_op_SetV2LoggingLevel.go b/service/iot/api_op_SetV2LoggingLevel.go index 6f10463d0a0..21880e6e58d 100644 --- a/service/iot/api_op_SetV2LoggingLevel.go +++ b/service/iot/api_op_SetV2LoggingLevel.go @@ -11,8 +11,11 @@ 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) -// action. +// Sets the logging level. +// +// Requires permission to access the [SetV2LoggingLevel] action. +// +// [SetV2LoggingLevel]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) SetV2LoggingLevel(ctx context.Context, params *SetV2LoggingLevelInput, optFns ...func(*Options)) (*SetV2LoggingLevelOutput, error) { if params == nil { params = &SetV2LoggingLevelInput{} diff --git a/service/iot/api_op_SetV2LoggingOptions.go b/service/iot/api_op_SetV2LoggingOptions.go index 6f11072de79..90ae5749bee 100644 --- a/service/iot/api_op_SetV2LoggingOptions.go +++ b/service/iot/api_op_SetV2LoggingOptions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Sets the logging options for the V2 logging service. +// +// Requires permission to access the [SetV2LoggingOptions] action. +// +// [SetV2LoggingOptions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) SetV2LoggingOptions(ctx context.Context, params *SetV2LoggingOptionsInput, optFns ...func(*Options)) (*SetV2LoggingOptionsOutput, error) { if params == nil { params = &SetV2LoggingOptionsInput{} diff --git a/service/iot/api_op_StartAuditMitigationActionsTask.go b/service/iot/api_op_StartAuditMitigationActionsTask.go index bb547f854dd..04ef35b9843 100644 --- a/service/iot/api_op_StartAuditMitigationActionsTask.go +++ b/service/iot/api_op_StartAuditMitigationActionsTask.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [StartAuditMitigationActionsTask] action. +// +// [StartAuditMitigationActionsTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StartAuditMitigationActionsTask(ctx context.Context, params *StartAuditMitigationActionsTaskInput, optFns ...func(*Options)) (*StartAuditMitigationActionsTaskOutput, error) { if params == nil { params = &StartAuditMitigationActionsTaskInput{} diff --git a/service/iot/api_op_StartDetectMitigationActionsTask.go b/service/iot/api_op_StartDetectMitigationActionsTask.go index 3d4f45b291c..78fd1a37238 100644 --- a/service/iot/api_op_StartDetectMitigationActionsTask.go +++ b/service/iot/api_op_StartDetectMitigationActionsTask.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Starts a Device Defender ML Detect mitigation actions task. +// +// Requires permission to access the [StartDetectMitigationActionsTask] action. +// +// [StartDetectMitigationActionsTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StartDetectMitigationActionsTask(ctx context.Context, params *StartDetectMitigationActionsTaskInput, optFns ...func(*Options)) (*StartDetectMitigationActionsTaskOutput, error) { if params == nil { params = &StartDetectMitigationActionsTaskInput{} @@ -31,36 +33,36 @@ func (c *Client) StartDetectMitigationActionsTask(ctx context.Context, params *S type StartDetectMitigationActionsTaskInput struct { - // The actions to be performed when a device has unexpected behavior. + // The actions to be performed when a device has unexpected behavior. // // This member is required. Actions []string - // Each mitigation action task must have a unique client request token. If you try - // to create a new task with the same token as a task that already exists, an + // Each mitigation action task must have a unique client request token. If you + // try to create a new task with the same token as a task that already exists, 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 - // Specifies the ML Detect findings to which the mitigation actions are applied. + // Specifies the ML Detect findings to which the mitigation actions are applied. // // This member is required. Target *types.DetectMitigationActionsTaskTarget - // The unique identifier of the task. + // The unique identifier of the task. // // This member is required. TaskId *string - // Specifies to list only active violations. + // Specifies to list only active violations. IncludeOnlyActiveViolations *bool - // Specifies to include suppressed alerts. + // Specifies to include suppressed alerts. IncludeSuppressedAlerts *bool - // Specifies the time period of which violation events occurred between. + // Specifies the time period of which violation events occurred between. ViolationEventOccurrenceRange *types.ViolationEventOccurrenceRange noSmithyDocumentSerde @@ -68,7 +70,7 @@ type StartDetectMitigationActionsTaskInput struct { type StartDetectMitigationActionsTaskOutput struct { - // The unique identifier of the task. + // The unique identifier of the task. TaskId *string // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_StartOnDemandAuditTask.go b/service/iot/api_op_StartOnDemandAuditTask.go index d067feb91b6..658705307ef 100644 --- a/service/iot/api_op_StartOnDemandAuditTask.go +++ b/service/iot/api_op_StartOnDemandAuditTask.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Starts an on-demand Device Defender audit. +// +// Requires permission to access the [StartOnDemandAuditTask] action. +// +// [StartOnDemandAuditTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StartOnDemandAuditTask(ctx context.Context, params *StartOnDemandAuditTaskInput, optFns ...func(*Options)) (*StartOnDemandAuditTaskOutput, error) { if params == nil { params = &StartOnDemandAuditTaskInput{} diff --git a/service/iot/api_op_StartThingRegistrationTask.go b/service/iot/api_op_StartThingRegistrationTask.go index 0fab4269dde..a2f26d549d3 100644 --- a/service/iot/api_op_StartThingRegistrationTask.go +++ b/service/iot/api_op_StartThingRegistrationTask.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Creates a bulk thing provisioning task. +// +// Requires permission to access the [StartThingRegistrationTask] action. +// +// [StartThingRegistrationTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StartThingRegistrationTask(ctx context.Context, params *StartThingRegistrationTaskInput, optFns ...func(*Options)) (*StartThingRegistrationTaskOutput, error) { if params == nil { params = &StartThingRegistrationTaskInput{} diff --git a/service/iot/api_op_StopThingRegistrationTask.go b/service/iot/api_op_StopThingRegistrationTask.go index 37bf3f7c097..1c234b1c660 100644 --- a/service/iot/api_op_StopThingRegistrationTask.go +++ b/service/iot/api_op_StopThingRegistrationTask.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Cancels a bulk thing provisioning task. +// +// Requires permission to access the [StopThingRegistrationTask] action. +// +// [StopThingRegistrationTask]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StopThingRegistrationTask(ctx context.Context, params *StopThingRegistrationTaskInput, optFns ...func(*Options)) (*StopThingRegistrationTaskOutput, error) { if params == nil { params = &StopThingRegistrationTaskInput{} diff --git a/service/iot/api_op_TagResource.go b/service/iot/api_op_TagResource.go index d75a9b51dd1..b251ea5fc96 100644 --- a/service/iot/api_op_TagResource.go +++ b/service/iot/api_op_TagResource.go @@ -12,8 +12,11 @@ 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) -// action. +// be used to manage a resource. +// +// Requires permission to access the [TagResource] action. +// +// [TagResource]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/iot/api_op_TestAuthorization.go b/service/iot/api_op_TestAuthorization.go index 7b526eda9ee..33d716d478e 100644 --- a/service/iot/api_op_TestAuthorization.go +++ b/service/iot/api_op_TestAuthorization.go @@ -13,9 +13,11 @@ 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) -// action. +// devices that connect to the IoT device gateway. +// +// Requires permission to access the [TestAuthorization] action. +// +// [TestAuthorization]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) TestAuthorization(ctx context.Context, params *TestAuthorizationInput, optFns ...func(*Options)) (*TestAuthorizationOutput, error) { if params == nil { params = &TestAuthorizationInput{} diff --git a/service/iot/api_op_TestInvokeAuthorizer.go b/service/iot/api_op_TestInvokeAuthorizer.go index 2e46730d835..01a4666d9b8 100644 --- a/service/iot/api_op_TestInvokeAuthorizer.go +++ b/service/iot/api_op_TestInvokeAuthorizer.go @@ -13,9 +13,11 @@ import ( // 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. +// devices that connect to the IoT device gateway. +// +// Requires permission to access the [TestInvokeAuthorizer] action. +// +// [TestInvokeAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) TestInvokeAuthorizer(ctx context.Context, params *TestInvokeAuthorizerInput, optFns ...func(*Options)) (*TestInvokeAuthorizerOutput, error) { if params == nil { params = &TestInvokeAuthorizerInput{} diff --git a/service/iot/api_op_TransferCertificate.go b/service/iot/api_op_TransferCertificate.go index b421c566d53..caafbedc21f 100644 --- a/service/iot/api_op_TransferCertificate.go +++ b/service/iot/api_op_TransferCertificate.go @@ -11,13 +11,22 @@ 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) -// action. You can cancel the transfer until it is acknowledged by the recipient. +// account. +// +// Requires permission to access the [TransferCertificate] 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 -// be in the ACTIVE state. You can use the UpdateCertificate action to deactivate -// it. The certificate must not have any policies attached to it. You can use the -// DetachPolicy action to detach them. +// caller to notify the transfer target. +// +// The certificate being transferred must not be in the ACTIVE state. You can use +// the UpdateCertificateaction to deactivate it. +// +// The certificate must not have any policies attached to it. You can use the DetachPolicy +// action to detach them. +// +// [TransferCertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) TransferCertificate(ctx context.Context, params *TransferCertificateInput, optFns ...func(*Options)) (*TransferCertificateOutput, error) { if params == nil { params = &TransferCertificateInput{} diff --git a/service/iot/api_op_UntagResource.go b/service/iot/api_op_UntagResource.go index 49d76b3c39f..b37b150d5c5 100644 --- a/service/iot/api_op_UntagResource.go +++ b/service/iot/api_op_UntagResource.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Removes the given tags (metadata) from the resource. +// +// Requires permission to access the [UntagResource] action. +// +// [UntagResource]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/iot/api_op_UpdateAccountAuditConfiguration.go b/service/iot/api_op_UpdateAccountAuditConfiguration.go index 8b8af652d29..64af2bdf5c6 100644 --- a/service/iot/api_op_UpdateAccountAuditConfiguration.go +++ b/service/iot/api_op_UpdateAccountAuditConfiguration.go @@ -13,9 +13,11 @@ 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) -// action. +// enabled or disabled. +// +// Requires permission to access the [UpdateAccountAuditConfiguration] action. +// +// [UpdateAccountAuditConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateAccountAuditConfiguration(ctx context.Context, params *UpdateAccountAuditConfigurationInput, optFns ...func(*Options)) (*UpdateAccountAuditConfigurationOutput, error) { if params == nil { params = &UpdateAccountAuditConfigurationInput{} @@ -35,13 +37,17 @@ type UpdateAccountAuditConfigurationInput struct { // Specifies which audit checks are enabled and disabled for this account. Use // DescribeAccountAuditConfiguration to see the list of all checks, including those - // that are currently enabled. Some data collection might start immediately when - // certain checks are enabled. When a check is disabled, any data collected so far - // 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 - // least one enabled check. + // that are currently enabled. + // + // Some data collection might start immediately when certain checks are enabled. + // When a check is disabled, any data collected so far 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 least one enabled check. AuditCheckConfigurations map[string]types.AuditCheckConfiguration // Information about the targets to which audit notifications are sent. diff --git a/service/iot/api_op_UpdateAuditSuppression.go b/service/iot/api_op_UpdateAuditSuppression.go index ef4c2cb68da..616ac09a782 100644 --- a/service/iot/api_op_UpdateAuditSuppression.go +++ b/service/iot/api_op_UpdateAuditSuppression.go @@ -43,14 +43,14 @@ type UpdateAuditSuppressionInput struct { // This member is required. ResourceIdentifier *types.ResourceIdentifier - // The description of the audit suppression. + // The description of the audit suppression. Description *string - // The expiration date (epoch timestamp in seconds) that you want the suppression + // The expiration date (epoch timestamp in seconds) that you want the suppression // to adhere to. ExpirationDate *time.Time - // Indicates whether a suppression should exist indefinitely or not. + // Indicates whether a suppression should exist indefinitely or not. SuppressIndefinitely *bool noSmithyDocumentSerde diff --git a/service/iot/api_op_UpdateAuthorizer.go b/service/iot/api_op_UpdateAuthorizer.go index 679028bbbed..dea77afc54e 100644 --- a/service/iot/api_op_UpdateAuthorizer.go +++ b/service/iot/api_op_UpdateAuthorizer.go @@ -11,8 +11,11 @@ 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) -// action. +// Updates an authorizer. +// +// Requires permission to access the [UpdateAuthorizer] action. +// +// [UpdateAuthorizer]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error) { if params == nil { params = &UpdateAuthorizerInput{} diff --git a/service/iot/api_op_UpdateBillingGroup.go b/service/iot/api_op_UpdateBillingGroup.go index f3949df5ace..8526e72387b 100644 --- a/service/iot/api_op_UpdateBillingGroup.go +++ b/service/iot/api_op_UpdateBillingGroup.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates information about the billing group. +// +// Requires permission to access the [UpdateBillingGroup] action. +// +// [UpdateBillingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateBillingGroup(ctx context.Context, params *UpdateBillingGroupInput, optFns ...func(*Options)) (*UpdateBillingGroupOutput, error) { if params == nil { params = &UpdateBillingGroupInput{} diff --git a/service/iot/api_op_UpdateCACertificate.go b/service/iot/api_op_UpdateCACertificate.go index f065bb2d08a..323b4d193d0 100644 --- a/service/iot/api_op_UpdateCACertificate.go +++ b/service/iot/api_op_UpdateCACertificate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates a registered CA certificate. +// +// Requires permission to access the [UpdateCACertificate] action. +// +// [UpdateCACertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateCACertificate(ctx context.Context, params *UpdateCACertificateInput, optFns ...func(*Options)) (*UpdateCACertificateOutput, error) { if params == nil { params = &UpdateCACertificateInput{} @@ -41,8 +43,9 @@ type UpdateCACertificateInput struct { // "DISABLE". NewAutoRegistrationStatus types.AutoRegistrationStatus - // The updated status of the CA certificate. Note: The status value - // REGISTER_INACTIVE is deprecated and should not be used. + // The updated status of the CA certificate. + // + // Note: The status value REGISTER_INACTIVE is deprecated and should not be used. NewStatus types.CACertificateStatus // Information about the registration configuration. diff --git a/service/iot/api_op_UpdateCertificate.go b/service/iot/api_op_UpdateCertificate.go index a66c7f9b03a..5cf781900f0 100644 --- a/service/iot/api_op_UpdateCertificate.go +++ b/service/iot/api_op_UpdateCertificate.go @@ -12,12 +12,17 @@ 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) -// 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 -// devices that used that certificate to connect. Devices cannot use a certificate -// that is not in the ACTIVE state to reconnect. +// +// Requires permission to access the [UpdateCertificate] 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 devices that used that certificate to connect. +// Devices cannot use a certificate that is not in the ACTIVE state to reconnect. +// +// [UpdateCertificate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateCertificate(ctx context.Context, params *UpdateCertificateInput, optFns ...func(*Options)) (*UpdateCertificateOutput, error) { if params == nil { params = &UpdateCertificateInput{} @@ -42,11 +47,13 @@ type UpdateCertificateInput struct { // This member is required. CertificateId *string - // The new status. Note: Setting the status to PENDING_TRANSFER or - // PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER - // and PENDING_ACTIVATION are statuses used internally by IoT. They are not - // intended for developer use. Note: The status value REGISTER_INACTIVE is - // deprecated and should not be used. + // The new status. + // + // Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result + // in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are + // statuses used internally by IoT. They are not intended for developer use. + // + // Note: The status value REGISTER_INACTIVE is deprecated and should not be used. // // This member is required. NewStatus types.CertificateStatus diff --git a/service/iot/api_op_UpdateCertificateProvider.go b/service/iot/api_op_UpdateCertificateProvider.go index bfbd54894c6..477bc39cb32 100644 --- a/service/iot/api_op_UpdateCertificateProvider.go +++ b/service/iot/api_op_UpdateCertificateProvider.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a certificate provider. Requires permission to access the -// UpdateCertificateProvider (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// action. +// Updates a certificate provider. +// +// Requires permission to access the [UpdateCertificateProvider] action. +// +// [UpdateCertificateProvider]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateCertificateProvider(ctx context.Context, params *UpdateCertificateProviderInput, optFns ...func(*Options)) (*UpdateCertificateProviderOutput, error) { if params == nil { params = &UpdateCertificateProviderInput{} diff --git a/service/iot/api_op_UpdateCustomMetric.go b/service/iot/api_op_UpdateCustomMetric.go index 29acae7a515..998d3db663b 100644 --- a/service/iot/api_op_UpdateCustomMetric.go +++ b/service/iot/api_op_UpdateCustomMetric.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Updates a Device Defender detect custom metric. +// +// Requires permission to access the [UpdateCustomMetric] action. +// +// [UpdateCustomMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateCustomMetric(ctx context.Context, params *UpdateCustomMetricInput, optFns ...func(*Options)) (*UpdateCustomMetricOutput, error) { if params == nil { params = &UpdateCustomMetricInput{} @@ -32,14 +34,14 @@ func (c *Client) UpdateCustomMetric(ctx context.Context, params *UpdateCustomMet type UpdateCustomMetricInput struct { - // Field represents a friendly name in the console for the custom metric, it + // Field represents a friendly name in the console for the custom metric, it // doesn't have to be unique. Don't use this name as the metric identifier in the // device metric report. Can be updated. // // This member is required. DisplayName *string - // The name of the custom metric. Cannot be updated. + // The name of the custom metric. Cannot be updated. // // This member is required. MetricName *string @@ -49,24 +51,26 @@ type UpdateCustomMetricInput struct { type UpdateCustomMetricOutput struct { - // The creation date of the custom metric in milliseconds since epoch. + // The creation date of the custom metric in milliseconds since epoch. CreationDate *time.Time - // A friendly name in the console for the custom metric + // A friendly name in the console for the custom metric DisplayName *string - // The time the custom metric was last modified in milliseconds since epoch. + // The time the custom metric was last modified in milliseconds since epoch. LastModifiedDate *time.Time - // The Amazon Resource Number (ARN) of the custom metric. + // The Amazon Resource Number (ARN) of the custom metric. MetricArn *string - // The name of the custom metric. + // The name of the custom metric. MetricName *string - // The type of the custom metric. The type number only takes a single metric value - // as an input, but while submitting the metrics value in the DeviceMetrics report, - // it must be passed as an array with a single value. + // The type of the custom metric. + // + // The type number only takes a single metric value as an input, but while + // submitting the metrics value in the DeviceMetrics report, it must be passed as + // an array with a single value. MetricType types.CustomMetricType // Metadata pertaining to the operation's result. diff --git a/service/iot/api_op_UpdateDimension.go b/service/iot/api_op_UpdateDimension.go index fabfec7c63f..5144154fa82 100644 --- a/service/iot/api_op_UpdateDimension.go +++ b/service/iot/api_op_UpdateDimension.go @@ -13,9 +13,11 @@ 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) -// action. +// dimension after it is created (you can delete it and recreate it). +// +// Requires permission to access the [UpdateDimension] action. +// +// [UpdateDimension]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateDimension(ctx context.Context, params *UpdateDimensionInput, optFns ...func(*Options)) (*UpdateDimensionOutput, error) { if params == nil { params = &UpdateDimensionInput{} diff --git a/service/iot/api_op_UpdateDomainConfiguration.go b/service/iot/api_op_UpdateDomainConfiguration.go index 26839f0549c..62f464844b8 100644 --- a/service/iot/api_op_UpdateDomainConfiguration.go +++ b/service/iot/api_op_UpdateDomainConfiguration.go @@ -12,9 +12,11 @@ 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) -// action. +// default endpoints can't be updated. +// +// Requires permission to access the [UpdateDomainConfiguration] action. +// +// [UpdateDomainConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateDomainConfiguration(ctx context.Context, params *UpdateDomainConfigurationInput, optFns ...func(*Options)) (*UpdateDomainConfigurationOutput, error) { if params == nil { params = &UpdateDomainConfigurationInput{} diff --git a/service/iot/api_op_UpdateDynamicThingGroup.go b/service/iot/api_op_UpdateDynamicThingGroup.go index bc9f2c2e56e..6320e94343d 100644 --- a/service/iot/api_op_UpdateDynamicThingGroup.go +++ b/service/iot/api_op_UpdateDynamicThingGroup.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates a dynamic thing group. +// +// Requires permission to access the [UpdateDynamicThingGroup] action. +// +// [UpdateDynamicThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateDynamicThingGroup(ctx context.Context, params *UpdateDynamicThingGroupInput, optFns ...func(*Options)) (*UpdateDynamicThingGroupOutput, error) { if params == nil { params = &UpdateDynamicThingGroupInput{} @@ -44,16 +46,18 @@ type UpdateDynamicThingGroupInput struct { // The expected version of the dynamic thing group to update. ExpectedVersion *int64 - // The dynamic thing group index to update. Currently one index is supported: - // AWS_Things . + // The dynamic thing group index to update. + // + // Currently one index is supported: AWS_Things . IndexName *string // The dynamic thing group search query string to update. QueryString *string - // The dynamic thing group query version to update. 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 to update. + // + // Currently one query version is supported: "2017-09-30". If not specified, the + // query version defaults to this value. QueryVersion *string noSmithyDocumentSerde diff --git a/service/iot/api_op_UpdateEventConfigurations.go b/service/iot/api_op_UpdateEventConfigurations.go index 44729c9f1ea..e6b435dc42f 100644 --- a/service/iot/api_op_UpdateEventConfigurations.go +++ b/service/iot/api_op_UpdateEventConfigurations.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates the event configurations. +// +// Requires permission to access the [UpdateEventConfigurations] action. +// +// [UpdateEventConfigurations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateEventConfigurations(ctx context.Context, params *UpdateEventConfigurationsInput, optFns ...func(*Options)) (*UpdateEventConfigurationsOutput, error) { if params == nil { params = &UpdateEventConfigurationsInput{} diff --git a/service/iot/api_op_UpdateFleetMetric.go b/service/iot/api_op_UpdateFleetMetric.go index fe7c2e890c5..a158eb39969 100644 --- a/service/iot/api_op_UpdateFleetMetric.go +++ b/service/iot/api_op_UpdateFleetMetric.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates the data for a fleet metric. +// +// Requires permission to access the [UpdateFleetMetric] action. +// +// [UpdateFleetMetric]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateFleetMetric(ctx context.Context, params *UpdateFleetMetricInput, optFns ...func(*Options)) (*UpdateFleetMetricOutput, error) { if params == nil { params = &UpdateFleetMetricInput{} @@ -64,8 +66,9 @@ 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]. + // + // [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 70eb04efe71..ae26cd59eb2 100644 --- a/service/iot/api_op_UpdateIndexingConfiguration.go +++ b/service/iot/api_op_UpdateIndexingConfiguration.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates the search configuration. +// +// Requires permission to access the [UpdateIndexingConfiguration] action. +// +// [UpdateIndexingConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateIndexingConfiguration(ctx context.Context, params *UpdateIndexingConfigurationInput, optFns ...func(*Options)) (*UpdateIndexingConfigurationOutput, error) { if params == nil { params = &UpdateIndexingConfigurationInput{} diff --git a/service/iot/api_op_UpdateJob.go b/service/iot/api_op_UpdateJob.go index 9d94e0e779b..11d7a027034 100644 --- a/service/iot/api_op_UpdateJob.go +++ b/service/iot/api_op_UpdateJob.go @@ -11,9 +11,11 @@ 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) -// action. +// Updates supported fields of the specified job. +// +// Requires permission to access the [UpdateJob] action. +// +// [UpdateJob]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateJob(ctx context.Context, params *UpdateJobInput, optFns ...func(*Options)) (*UpdateJobOutput, error) { if params == nil { params = &UpdateJobInput{} @@ -48,12 +50,18 @@ type UpdateJobInput struct { // Allows you to create a staged rollout of the job. JobExecutionsRolloutConfig *types.JobExecutionsRolloutConfig - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string // Configuration information for pre-signed S3 URLs. diff --git a/service/iot/api_op_UpdateMitigationAction.go b/service/iot/api_op_UpdateMitigationAction.go index cb4669d0322..89726a3d42e 100644 --- a/service/iot/api_op_UpdateMitigationAction.go +++ b/service/iot/api_op_UpdateMitigationAction.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates the definition for the specified mitigation action. +// +// Requires permission to access the [UpdateMitigationAction] action. +// +// [UpdateMitigationAction]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateMitigationAction(ctx context.Context, params *UpdateMitigationActionInput, optFns ...func(*Options)) (*UpdateMitigationActionOutput, error) { if params == nil { params = &UpdateMitigationActionInput{} diff --git a/service/iot/api_op_UpdatePackage.go b/service/iot/api_op_UpdatePackage.go index 7c7b394a7d5..1dfe1bc4b89 100644 --- a/service/iot/api_op_UpdatePackage.go +++ b/service/iot/api_op_UpdatePackage.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the supported fields for a specific software package. Requires -// permission to access the UpdatePackage (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// and GetIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// actions. +// Updates the supported fields for a specific software package. +// +// Requires permission to access the [UpdatePackage] and [GetIndexingConfiguration] actions. +// +// [UpdatePackage]: 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 func (c *Client) UpdatePackage(ctx context.Context, params *UpdatePackageInput, optFns ...func(*Options)) (*UpdatePackageOutput, error) { if params == nil { params = &UpdatePackageInput{} @@ -41,17 +43,20 @@ type UpdatePackageInput struct { // request is required. ClientToken *string - // The name of the default package version. Note: You cannot name a defaultVersion - // and set unsetDefaultVersion equal to true at the same time. + // The name of the default package version. + // + // Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true + // at the same time. DefaultVersionName *string // The package description. Description *string // Indicates whether you want to remove the named default package version from the - // software package. Set as true to remove the default package version. Note: You - // cannot name a defaultVersion and set unsetDefaultVersion equal to true at the - // same time. + // software package. Set as true to remove the default package version. + // + // Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true + // at the same time. UnsetDefaultVersion *bool noSmithyDocumentSerde diff --git a/service/iot/api_op_UpdatePackageConfiguration.go b/service/iot/api_op_UpdatePackageConfiguration.go index f43a5eb4028..e2d44122220 100644 --- a/service/iot/api_op_UpdatePackageConfiguration.go +++ b/service/iot/api_op_UpdatePackageConfiguration.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the software package configuration. Requires permission to access the -// UpdatePackageConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// and iam:PassRole (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) -// actions. +// Updates the software package configuration. +// +// Requires permission to access the [UpdatePackageConfiguration] and [iam:PassRole] actions. +// +// [iam:PassRole]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html +// [UpdatePackageConfiguration]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdatePackageConfiguration(ctx context.Context, params *UpdatePackageConfigurationInput, optFns ...func(*Options)) (*UpdatePackageConfigurationOutput, error) { if params == nil { params = &UpdatePackageConfigurationInput{} diff --git a/service/iot/api_op_UpdatePackageVersion.go b/service/iot/api_op_UpdatePackageVersion.go index f256855dcad..9b7030ce86f 100644 --- a/service/iot/api_op_UpdatePackageVersion.go +++ b/service/iot/api_op_UpdatePackageVersion.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the supported fields for a specific package version. Requires -// permission to access the UpdatePackageVersion (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// and GetIndexingConfiguration (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) -// actions. +// Updates the supported fields for a specific package version. +// +// Requires permission to access the [UpdatePackageVersion] and [GetIndexingConfiguration] actions. +// +// [UpdatePackageVersion]: 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 func (c *Client) UpdatePackageVersion(ctx context.Context, params *UpdatePackageVersionInput, optFns ...func(*Options)) (*UpdatePackageVersionOutput, error) { if params == nil { params = &UpdatePackageVersionInput{} @@ -43,15 +45,19 @@ type UpdatePackageVersionInput struct { VersionName *string // The status that the package version should be assigned. For more information, - // see Package version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . + // see [Package version lifecycle]. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle Action types.PackageVersionAction // Metadata that can be used to define a package version’s configuration. For // example, the Amazon S3 file location, configuration options that are being sent - // to the device or fleet. Note: Attributes can be updated only when the package - // version is in a draft state. The combined size of all the attributes on a - // package version is limited to 3KB. + // to the device or fleet. + // + // Note: Attributes can be updated only when the package version is in a draft + // state. + // + // The combined size of all the attributes on a package version is limited to 3KB. Attributes map[string]string // A unique case-sensitive identifier that you can provide to ensure the diff --git a/service/iot/api_op_UpdateProvisioningTemplate.go b/service/iot/api_op_UpdateProvisioningTemplate.go index 63df6207713..084d68e532d 100644 --- a/service/iot/api_op_UpdateProvisioningTemplate.go +++ b/service/iot/api_op_UpdateProvisioningTemplate.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Updates a provisioning template. +// +// Requires permission to access the [UpdateProvisioningTemplate] action. +// +// [UpdateProvisioningTemplate]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateProvisioningTemplate(ctx context.Context, params *UpdateProvisioningTemplateInput, optFns ...func(*Options)) (*UpdateProvisioningTemplateOutput, error) { if params == nil { params = &UpdateProvisioningTemplateInput{} @@ -46,9 +48,10 @@ 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] // . + // + // [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 5c0bbb316cd..d8ab6db151b 100644 --- a/service/iot/api_op_UpdateRoleAlias.go +++ b/service/iot/api_op_UpdateRoleAlias.go @@ -10,8 +10,11 @@ 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) -// action. +// Updates a role alias. +// +// Requires permission to access the [UpdateRoleAlias] action. +// +// [UpdateRoleAlias]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateRoleAlias(ctx context.Context, params *UpdateRoleAliasInput, optFns ...func(*Options)) (*UpdateRoleAliasOutput, error) { if params == nil { params = &UpdateRoleAliasInput{} @@ -34,9 +37,10 @@ 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 5a378a14aba..1eb8e6f06cf 100644 --- a/service/iot/api_op_UpdateScheduledAudit.go +++ b/service/iot/api_op_UpdateScheduledAudit.go @@ -12,8 +12,11 @@ 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) -// action. +// the audit takes place. +// +// Requires permission to access the [UpdateScheduledAudit] action. +// +// [UpdateScheduledAudit]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateScheduledAudit(ctx context.Context, params *UpdateScheduledAuditInput, optFns ...func(*Options)) (*UpdateScheduledAuditOutput, error) { if params == nil { params = &UpdateScheduledAuditInput{} diff --git a/service/iot/api_op_UpdateSecurityProfile.go b/service/iot/api_op_UpdateSecurityProfile.go index 34c34300618..10be4512bb7 100644 --- a/service/iot/api_op_UpdateSecurityProfile.go +++ b/service/iot/api_op_UpdateSecurityProfile.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Updates a Device Defender security profile. +// +// Requires permission to access the [UpdateSecurityProfile] action. +// +// [UpdateSecurityProfile]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateSecurityProfile(ctx context.Context, params *UpdateSecurityProfileInput, optFns ...func(*Options)) (*UpdateSecurityProfileOutput, error) { if params == nil { params = &UpdateSecurityProfileInput{} @@ -37,8 +39,9 @@ type UpdateSecurityProfileInput struct { // This member is required. SecurityProfileName *string - // Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead. A - // list of metrics whose data is retained (stored). By default, data is retained + // 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 // metric specified here. Can be used with custom metrics; cannot be used with // dimensions. @@ -90,8 +93,9 @@ type UpdateSecurityProfileInput struct { type UpdateSecurityProfileOutput struct { - // Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead. A - // list of metrics whose data is retained (stored). By default, data is retained + // 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. // diff --git a/service/iot/api_op_UpdateStream.go b/service/iot/api_op_UpdateStream.go index 176b888bc29..a9db32e6480 100644 --- a/service/iot/api_op_UpdateStream.go +++ b/service/iot/api_op_UpdateStream.go @@ -12,8 +12,10 @@ 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) -// action. +// +// Requires permission to access the [UpdateStream] action. +// +// [UpdateStream]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, optFns ...func(*Options)) (*UpdateStreamOutput, error) { if params == nil { params = &UpdateStreamInput{} diff --git a/service/iot/api_op_UpdateThing.go b/service/iot/api_op_UpdateThing.go index 9fb7f807099..4a842430776 100644 --- a/service/iot/api_op_UpdateThing.go +++ b/service/iot/api_op_UpdateThing.go @@ -11,8 +11,11 @@ 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) -// action. +// Updates the data for a thing. +// +// Requires permission to access the [UpdateThing] action. +// +// [UpdateThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateThing(ctx context.Context, params *UpdateThingInput, optFns ...func(*Options)) (*UpdateThingOutput, error) { if params == nil { params = &UpdateThingInput{} @@ -31,16 +34,20 @@ func (c *Client) UpdateThing(ctx context.Context, params *UpdateThingInput, optF // The input for the UpdateThing operation. type UpdateThingInput struct { - // The name of the thing to update. You can't change a thing's name. To change a - // thing's name, you must create a new thing, give it the new name, and then delete - // the old thing. + // The name of the thing to update. + // + // You can't change a thing's name. To change a thing's name, you must create a + // new thing, give it the new name, and then delete the old thing. // // This member is required. ThingName *string // A list of thing attributes, a JSON string containing name-value pairs. For - // example: {\"attributes\":{\"name1\":\"value2\"}} This data is used to add new - // attributes or update existing attributes. + // example: + // + // {\"attributes\":{\"name1\":\"value2\"}} + // + // This data is used to add new attributes or update existing attributes. AttributePayload *types.AttributePayload // The expected version of the thing record in the registry. If the version of the diff --git a/service/iot/api_op_UpdateThingGroup.go b/service/iot/api_op_UpdateThingGroup.go index d15c1509272..54748e07460 100644 --- a/service/iot/api_op_UpdateThingGroup.go +++ b/service/iot/api_op_UpdateThingGroup.go @@ -11,8 +11,11 @@ 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) -// action. +// Update a thing group. +// +// Requires permission to access the [UpdateThingGroup] action. +// +// [UpdateThingGroup]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateThingGroup(ctx context.Context, params *UpdateThingGroupInput, optFns ...func(*Options)) (*UpdateThingGroupOutput, error) { if params == nil { params = &UpdateThingGroupInput{} diff --git a/service/iot/api_op_UpdateThingGroupsForThing.go b/service/iot/api_op_UpdateThingGroupsForThing.go index ae5a4626f97..e76faea2d31 100644 --- a/service/iot/api_op_UpdateThingGroupsForThing.go +++ b/service/iot/api_op_UpdateThingGroupsForThing.go @@ -10,9 +10,11 @@ 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) -// action. +// Updates the groups to which the thing belongs. +// +// Requires permission to access the [UpdateThingGroupsForThing] action. +// +// [UpdateThingGroupsForThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateThingGroupsForThing(ctx context.Context, params *UpdateThingGroupsForThingInput, optFns ...func(*Options)) (*UpdateThingGroupsForThingOutput, error) { if params == nil { params = &UpdateThingGroupsForThingInput{} diff --git a/service/iot/api_op_UpdateTopicRuleDestination.go b/service/iot/api_op_UpdateTopicRuleDestination.go index 01d6b9b0a90..7282c5dfeeb 100644 --- a/service/iot/api_op_UpdateTopicRuleDestination.go +++ b/service/iot/api_op_UpdateTopicRuleDestination.go @@ -12,9 +12,11 @@ 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) -// action. +// URL, or confirmation URL of the destination. +// +// Requires permission to access the [UpdateTopicRuleDestination] action. +// +// [UpdateTopicRuleDestination]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateTopicRuleDestination(ctx context.Context, params *UpdateTopicRuleDestinationInput, optFns ...func(*Options)) (*UpdateTopicRuleDestinationOutput, error) { if params == nil { params = &UpdateTopicRuleDestinationInput{} @@ -37,19 +39,24 @@ type UpdateTopicRuleDestinationInput struct { // This member is required. Arn *string - // 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 - // 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 - // this destination is not allowed. You can set status to ENABLED by calling - // 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 - // confirmation challenge to be sent to your confirmation endpoint. + // 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 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 this destination is not + // allowed. You can set status to ENABLED by calling 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 confirmation challenge to be + // sent to your confirmation endpoint. // // This member is required. Status types.TopicRuleDestinationStatus diff --git a/service/iot/api_op_ValidateSecurityProfileBehaviors.go b/service/iot/api_op_ValidateSecurityProfileBehaviors.go index c03c639bce6..c2808976123 100644 --- a/service/iot/api_op_ValidateSecurityProfileBehaviors.go +++ b/service/iot/api_op_ValidateSecurityProfileBehaviors.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Validates a Device Defender security profile behaviors specification. +// +// Requires permission to access the [ValidateSecurityProfileBehaviors] action. +// +// [ValidateSecurityProfileBehaviors]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ValidateSecurityProfileBehaviors(ctx context.Context, params *ValidateSecurityProfileBehaviorsInput, optFns ...func(*Options)) (*ValidateSecurityProfileBehaviorsOutput, error) { if params == nil { params = &ValidateSecurityProfileBehaviorsInput{} diff --git a/service/iot/doc.go b/service/iot/doc.go index caebd2104d8..b9bc4919249 100644 --- a/service/iot/doc.go +++ b/service/iot/doc.go @@ -3,19 +3,26 @@ // 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]. 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] to sign the request is: execute-api. +// +// For more information about how IoT works, see the [Developer Guide]. +// +// For information about how to use the credentials provider for IoT, see [Authorizing Direct Calls to Amazon Web Services Services]. +// +// [Amazon Web Services IoT Core Endpoints and Quotas]: https://docs.aws.amazon.com/general/latest/gr/iot-core.html +// [Developer Guide]: https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html +// [Amazon Web Services Signature Version 4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html +// [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/options.go b/service/iot/options.go index 199ca1c2b5f..40429989e89 100644 --- a/service/iot/options.go +++ b/service/iot/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iot/types/enums.go b/service/iot/types/enums.go index 6b99df94409..294542e637a 100644 --- a/service/iot/types/enums.go +++ b/service/iot/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for AbortAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AbortAction) Values() []AbortAction { return []AbortAction{ "CANCEL", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "PUBLISH", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for AggregationTypeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationTypeName) Values() []AggregationTypeName { return []AggregationTypeName{ "Statistics", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for AlertTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlertTargetType) Values() []AlertTargetType { return []AlertTargetType{ "SNS", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for AuditCheckRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditCheckRunStatus) Values() []AuditCheckRunStatus { return []AuditCheckRunStatus{ "IN_PROGRESS", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for AuditFindingSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditFindingSeverity) Values() []AuditFindingSeverity { return []AuditFindingSeverity{ "CRITICAL", @@ -135,8 +141,9 @@ const ( ) // Values returns all known values for AuditFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditFrequency) Values() []AuditFrequency { return []AuditFrequency{ "DAILY", @@ -160,8 +167,9 @@ const ( // Values returns all known values for AuditMitigationActionsExecutionStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditMitigationActionsExecutionStatus) Values() []AuditMitigationActionsExecutionStatus { return []AuditMitigationActionsExecutionStatus{ "IN_PROGRESS", @@ -185,8 +193,9 @@ const ( // Values returns all known values for AuditMitigationActionsTaskStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditMitigationActionsTaskStatus) Values() []AuditMitigationActionsTaskStatus { return []AuditMitigationActionsTaskStatus{ "IN_PROGRESS", @@ -204,8 +213,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SNS", @@ -223,8 +233,9 @@ const ( ) // Values returns all known values for AuditTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditTaskStatus) Values() []AuditTaskStatus { return []AuditTaskStatus{ "IN_PROGRESS", @@ -243,8 +254,9 @@ const ( ) // Values returns all known values for AuditTaskType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditTaskType) Values() []AuditTaskType { return []AuditTaskType{ "ON_DEMAND_AUDIT_TASK", @@ -262,8 +274,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -281,8 +294,9 @@ const ( ) // Values returns all known values for AuthorizerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizerStatus) Values() []AuthorizerStatus { return []AuthorizerStatus{ "ACTIVE", @@ -299,8 +313,9 @@ const ( ) // Values returns all known values for AutoRegistrationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoRegistrationStatus) Values() []AutoRegistrationStatus { return []AutoRegistrationStatus{ "ENABLE", @@ -317,8 +332,9 @@ const ( // Values returns all known values for AwsJobAbortCriteriaAbortAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AwsJobAbortCriteriaAbortAction) Values() []AwsJobAbortCriteriaAbortAction { return []AwsJobAbortCriteriaAbortAction{ "CANCEL", @@ -337,8 +353,9 @@ const ( // Values returns all known values for AwsJobAbortCriteriaFailureType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AwsJobAbortCriteriaFailureType) Values() []AwsJobAbortCriteriaFailureType { return []AwsJobAbortCriteriaFailureType{ "FAILED", @@ -358,8 +375,9 @@ const ( ) // Values returns all known values for BehaviorCriteriaType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BehaviorCriteriaType) Values() []BehaviorCriteriaType { return []BehaviorCriteriaType{ "STATIC", @@ -377,8 +395,9 @@ const ( ) // Values returns all known values for CACertificateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CACertificateStatus) Values() []CACertificateStatus { return []CACertificateStatus{ "ACTIVE", @@ -395,6 +414,7 @@ const ( // Values returns all known values for CACertificateUpdateAction. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CACertificateUpdateAction) Values() []CACertificateUpdateAction { return []CACertificateUpdateAction{ @@ -417,8 +437,9 @@ const ( ) // Values returns all known values for CannedAccessControlList. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CannedAccessControlList) Values() []CannedAccessControlList { return []CannedAccessControlList{ "private", @@ -441,8 +462,9 @@ const ( ) // Values returns all known values for CertificateMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateMode) Values() []CertificateMode { return []CertificateMode{ "DEFAULT", @@ -459,8 +481,9 @@ const ( // Values returns all known values for CertificateProviderOperation. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateProviderOperation) Values() []CertificateProviderOperation { return []CertificateProviderOperation{ "CreateCertificateFromCsr", @@ -480,8 +503,9 @@ const ( ) // Values returns all known values for CertificateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateStatus) Values() []CertificateStatus { return []CertificateStatus{ "ACTIVE", @@ -510,8 +534,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "less-than", @@ -537,8 +562,9 @@ const ( ) // Values returns all known values for ConfidenceLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfidenceLevel) Values() []ConfidenceLevel { return []ConfidenceLevel{ "LOW", @@ -558,8 +584,9 @@ const ( ) // Values returns all known values for CustomMetricType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomMetricType) Values() []CustomMetricType { return []CustomMetricType{ "string-list", @@ -583,8 +610,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -609,8 +637,9 @@ const ( // Values returns all known values for DetectMitigationActionExecutionStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetectMitigationActionExecutionStatus) Values() []DetectMitigationActionExecutionStatus { return []DetectMitigationActionExecutionStatus{ "IN_PROGRESS", @@ -632,8 +661,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetectMitigationActionsTaskStatus) Values() []DetectMitigationActionsTaskStatus { return []DetectMitigationActionsTaskStatus{ "IN_PROGRESS", @@ -652,8 +682,9 @@ const ( // Values returns all known values for DeviceCertificateUpdateAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceCertificateUpdateAction) Values() []DeviceCertificateUpdateAction { return []DeviceCertificateUpdateAction{ "DEACTIVATE", @@ -670,6 +701,7 @@ const ( // Values returns all known values for DeviceDefenderIndexingMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DeviceDefenderIndexingMode) Values() []DeviceDefenderIndexingMode { return []DeviceDefenderIndexingMode{ @@ -686,8 +718,9 @@ const ( ) // Values returns all known values for DimensionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionType) Values() []DimensionType { return []DimensionType{ "TOPIC_FILTER", @@ -703,8 +736,9 @@ const ( ) // Values returns all known values for DimensionValueOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionValueOperator) Values() []DimensionValueOperator { return []DimensionValueOperator{ "IN", @@ -722,6 +756,7 @@ const ( // Values returns all known values for DomainConfigurationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DomainConfigurationStatus) Values() []DomainConfigurationStatus { return []DomainConfigurationStatus{ @@ -740,8 +775,9 @@ const ( ) // Values returns all known values for DomainType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainType) Values() []DomainType { return []DomainType{ "ENDPOINT", @@ -760,8 +796,9 @@ const ( ) // Values returns all known values for DynamicGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DynamicGroupStatus) Values() []DynamicGroupStatus { return []DynamicGroupStatus{ "ACTIVE", @@ -779,8 +816,9 @@ const ( ) // Values returns all known values for DynamoKeyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DynamoKeyType) Values() []DynamoKeyType { return []DynamoKeyType{ "STRING", @@ -806,8 +844,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -834,8 +873,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -878,8 +918,9 @@ const ( ) // Values returns all known values for FleetMetricUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetMetricUnit) Values() []FleetMetricUnit { return []FleetMetricUnit{ "Seconds", @@ -922,8 +963,9 @@ const ( ) // Values returns all known values for IndexStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndexStatus) Values() []IndexStatus { return []IndexStatus{ "ACTIVE", @@ -942,8 +984,9 @@ const ( ) // Values returns all known values for JobEndBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobEndBehavior) Values() []JobEndBehavior { return []JobEndBehavior{ "STOP_ROLLOUT", @@ -963,8 +1006,9 @@ const ( ) // Values returns all known values for JobExecutionFailureType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobExecutionFailureType) Values() []JobExecutionFailureType { return []JobExecutionFailureType{ "FAILED", @@ -989,8 +1033,9 @@ const ( ) // Values returns all known values for JobExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobExecutionStatus) Values() []JobExecutionStatus { return []JobExecutionStatus{ "QUEUED", @@ -1016,8 +1061,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1040,8 +1086,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "DEBUG", @@ -1064,8 +1111,9 @@ const ( ) // Values returns all known values for LogTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogTargetType) Values() []LogTargetType { return []LogTargetType{ "DEFAULT", @@ -1085,8 +1133,9 @@ const ( ) // Values returns all known values for MessageFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageFormat) Values() []MessageFormat { return []MessageFormat{ "RAW", @@ -1107,8 +1156,9 @@ const ( ) // Values returns all known values for MitigationActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MitigationActionType) Values() []MitigationActionType { return []MitigationActionType{ "UPDATE_DEVICE_CERTIFICATE", @@ -1130,8 +1180,9 @@ const ( ) // Values returns all known values for ModelStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelStatus) Values() []ModelStatus { return []ModelStatus{ "PENDING_BUILD", @@ -1149,8 +1200,9 @@ const ( ) // Values returns all known values for NamedShadowIndexingMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamedShadowIndexingMode) Values() []NamedShadowIndexingMode { return []NamedShadowIndexingMode{ "OFF", @@ -1171,8 +1223,9 @@ const ( ) // Values returns all known values for OTAUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OTAUpdateStatus) Values() []OTAUpdateStatus { return []OTAUpdateStatus{ "CREATE_PENDING", @@ -1193,8 +1246,9 @@ const ( ) // Values returns all known values for PackageVersionAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionAction) Values() []PackageVersionAction { return []PackageVersionAction{ "PUBLISH", @@ -1212,8 +1266,9 @@ const ( ) // Values returns all known values for PackageVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionStatus) Values() []PackageVersionStatus { return []PackageVersionStatus{ "DRAFT", @@ -1230,8 +1285,9 @@ const ( ) // Values returns all known values for PolicyTemplateName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyTemplateName) Values() []PolicyTemplateName { return []PolicyTemplateName{ "BLANK_POLICY", @@ -1247,8 +1303,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "MQTT", @@ -1265,8 +1322,9 @@ const ( ) // Values returns all known values for ReportType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportType) Values() []ReportType { return []ReportType{ "ERRORS", @@ -1290,8 +1348,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1316,8 +1375,9 @@ const ( ) // Values returns all known values for RetryableFailureType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetryableFailureType) Values() []RetryableFailureType { return []RetryableFailureType{ "FAILED", @@ -1335,8 +1395,9 @@ const ( ) // Values returns all known values for ServerCertificateStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerCertificateStatus) Values() []ServerCertificateStatus { return []ServerCertificateStatus{ "INVALID", @@ -1354,8 +1415,9 @@ const ( ) // Values returns all known values for ServiceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceType) Values() []ServiceType { return []ServiceType{ "DATA", @@ -1376,8 +1438,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "InProgress", @@ -1397,8 +1460,9 @@ const ( ) // Values returns all known values for TargetFieldOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetFieldOrder) Values() []TargetFieldOrder { return []TargetFieldOrder{ "LatLon", @@ -1415,8 +1479,9 @@ const ( ) // Values returns all known values for TargetSelection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetSelection) Values() []TargetSelection { return []TargetSelection{ "CONTINUOUS", @@ -1433,8 +1498,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1452,8 +1518,9 @@ const ( // Values returns all known values for ThingConnectivityIndexingMode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThingConnectivityIndexingMode) Values() []ThingConnectivityIndexingMode { return []ThingConnectivityIndexingMode{ "OFF", @@ -1470,8 +1537,9 @@ const ( ) // Values returns all known values for ThingGroupIndexingMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThingGroupIndexingMode) Values() []ThingGroupIndexingMode { return []ThingGroupIndexingMode{ "OFF", @@ -1489,8 +1557,9 @@ const ( ) // Values returns all known values for ThingIndexingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThingIndexingMode) Values() []ThingIndexingMode { return []ThingIndexingMode{ "OFF", @@ -1512,6 +1581,7 @@ const ( // Values returns all known values for TopicRuleDestinationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TopicRuleDestinationStatus) Values() []TopicRuleDestinationStatus { return []TopicRuleDestinationStatus{ @@ -1534,8 +1604,9 @@ const ( ) // Values returns all known values for VerificationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationState) Values() []VerificationState { return []VerificationState{ "FALSE_POSITIVE", @@ -1555,8 +1626,9 @@ const ( ) // Values returns all known values for ViolationEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViolationEventType) Values() []ViolationEventType { return []ViolationEventType{ "in-alarm", diff --git a/service/iot/types/errors.go b/service/iot/types/errors.go index 7cf63bd1dae..1645209ab20 100644 --- a/service/iot/types/errors.go +++ b/service/iot/types/errors.go @@ -674,7 +674,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 +// 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 e2c3b84dd3c..b76bdc29c87 100644 --- a/service/iot/types/types.go +++ b/service/iot/types/types.go @@ -38,8 +38,10 @@ type AbortCriteria struct { 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 - // decimal (for example, 10.9 and 10.99, but not 10.999). + // 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. ThresholdPercentage *float64 @@ -67,11 +69,13 @@ type Action struct { // DynamoDB column. DynamoDBv2 *DynamoDBv2Action - // 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) - // . + // 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]. + // + // [OpenSearchAction]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html Elasticsearch *ElasticsearchAction // Write to an Amazon Kinesis Firehose stream. @@ -126,8 +130,10 @@ 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) - // topic rule action documentation. + // into an Amazon Timestream table. For more information, see the [Timestream]topic rule + // action documentation. + // + // [Timestream]: https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html Timestream *TimestreamAction noSmithyDocumentSerde @@ -157,7 +163,7 @@ type ActiveViolation struct { // The description of the verification state of the violation. VerificationStateDescription *string - // The details of a violation event. + // The details of a violation event. ViolationEventAdditionalInfo *ViolationEventAdditionalInfo // The ID of the active violation. @@ -318,14 +324,17 @@ 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 . + // + // To remove an attribute, call UpdateThing with an empty attribute value. + // + // The merge attribute is only valid when calling UpdateThing or UpdateThingGroup . Merge bool noSmithyDocumentSerde @@ -362,8 +371,8 @@ type AuditCheckDetails struct { // The number of resources that were found noncompliant during the check. NonCompliantResourcesCount *int64 - // Describes how many of the non-compliant resources created during the evaluation - // of an audit check were marked as suppressed. + // Describes how many of the non-compliant resources created during the + // evaluation of an audit check were marked as suppressed. SuppressedNonCompliantResourcesCount *int64 // The number of resources on which the check was performed. @@ -385,7 +394,7 @@ type AuditFinding struct { // The time the result (finding) was discovered. FindingTime *time.Time - // Indicates whether the audit finding was suppressed or not during reporting. + // Indicates whether the audit finding was suppressed or not during reporting. IsSuppressed *bool // The resource that was found to be noncompliant with the audit check. @@ -515,14 +524,14 @@ type AuditSuppression struct { // This member is required. ResourceIdentifier *ResourceIdentifier - // The description of the audit suppression. + // The description of the audit suppression. Description *string - // The expiration date (epoch timestamp in seconds) that you want the suppression + // The expiration date (epoch timestamp in seconds) that you want the suppression // to adhere to. ExpirationDate *time.Time - // Indicates whether a suppression should exist indefinitely or not. + // Indicates whether a suppression should exist indefinitely or not. SuppressIndefinitely *bool noSmithyDocumentSerde @@ -677,8 +686,10 @@ type AwsJobAbortCriteria struct { 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 - // decimal (for example, 10.9 and 10.99, but not 10.999). + // 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. ThresholdPercentage *float64 @@ -716,9 +727,10 @@ type AwsJobExponentialRolloutRate struct { // This member is required. IncrementFactor float64 - // The criteria to initiate the increase in rate of rollout for a job. Amazon Web - // Services IoT Core supports up to one digit after the decimal (for example, 1.5, - // but not 1.55). + // The criteria to initiate the increase in rate of rollout for a job. + // + // Amazon Web Services IoT Core supports up to one digit after the decimal (for + // example, 1.5, but not 1.55). // // This member is required. RateIncreaseCriteria *AwsJobRateIncreaseCriteria @@ -778,8 +790,10 @@ type Behavior struct { Name *string // The criteria that determine if a device is behaving normally in regard to the - // metric . In the IoT console, you can choose to be sent an alert through Amazon - // SNS when IoT Device Defender detects that a device is behaving anomalously. + // metric . + // + // In the IoT console, you can choose to be sent an alert through Amazon SNS when + // IoT Device Defender detects that a device is behaving anomalously. Criteria *BehaviorCriteria // Value indicates exporting metrics related to the behavior when it is true. @@ -794,7 +808,7 @@ type Behavior struct { // custom metrics. MetricDimension *MetricDimension - // Suppresses alerts. + // Suppresses alerts. SuppressAlerts *bool noSmithyDocumentSerde @@ -805,9 +819,13 @@ 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 ComparisonOperator ComparisonOperator @@ -830,7 +848,7 @@ type BehaviorCriteria struct { // list-based metric datatypes. DurationSeconds *int32 - // The configuration of an ML Detect + // The configuration of an ML Detect MlDetectionConfig *MachineLearningDetectionConfig // A statistical ranking (percentile)that indicates a threshold value by which a @@ -846,22 +864,22 @@ type BehaviorCriteria struct { // The summary of an ML Detect behavior model. type BehaviorModelTrainingSummary struct { - // The name of the behavior. + // The name of the behavior. BehaviorName *string - // The percentage of datapoints collected. + // The percentage of datapoints collected. DatapointsCollectionPercentage *float64 - // The date the model was last refreshed. + // The date the model was last refreshed. LastModelRefreshDate *time.Time - // The status of the behavior model. + // The status of the behavior model. ModelStatus ModelStatus - // The name of the security profile. + // The name of the security profile. SecurityProfileName *string - // The date a training model started collecting data. + // The date a training model started collecting data. TrainingDataCollectionStartDate *time.Time noSmithyDocumentSerde @@ -919,8 +937,9 @@ type CACertificate struct { // The date the CA certificate was created. CreationDate *time.Time - // The status of the CA certificate. The status value REGISTER_INACTIVE is - // deprecated and should not be used. + // The status of the CA certificate. + // + // The status value REGISTER_INACTIVE is deprecated and should not be used. Status CACertificateStatus noSmithyDocumentSerde @@ -939,10 +958,13 @@ type CACertificateDescription struct { // The CA certificate ID. CertificateId *string - // 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) - // . + // 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]. + // + // [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. @@ -982,23 +1004,27 @@ type Certificate struct { // certificate ID.) CertificateId *string - // 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 - // 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. + // 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 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. CertificateMode CertificateMode // The date and time the certificate was created. CreationDate *time.Time - // The status of the certificate. The status value REGISTER_INACTIVE is deprecated - // and should not be used. + // The status of the certificate. + // + // The status value REGISTER_INACTIVE is deprecated and should not be used. Status CertificateStatus noSmithyDocumentSerde @@ -1016,18 +1042,23 @@ type CertificateDescription struct { // The ID of the certificate. CertificateId *string - // 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 - // 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) - // . + // 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 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]. + // + // [Transport security in IoT]: https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html CertificateMode CertificateMode // The certificate data, in PEM format. @@ -1148,8 +1179,9 @@ type CloudwatchMetricAction struct { // This member is required. MetricNamespace *string - // The metric unit (https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) - // supported by CloudWatch. + // The [metric unit] supported by CloudWatch. + // + // [metric unit]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit // // This member is required. MetricUnit *string @@ -1164,8 +1196,9 @@ 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]. + // + // [Unix timestamp]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp MetricTimestamp *string noSmithyDocumentSerde @@ -1268,31 +1301,31 @@ type Destination struct { // Describes which mitigation actions should be executed. type DetectMitigationActionExecution struct { - // The friendly name that uniquely identifies the mitigation action. + // The friendly name that uniquely identifies the mitigation action. ActionName *string - // The error code of a mitigation action. + // The error code of a mitigation action. ErrorCode *string - // The date a mitigation action ended. + // The date a mitigation action ended. ExecutionEndDate *time.Time - // The date a mitigation action was started. + // The date a mitigation action was started. ExecutionStartDate *time.Time - // The message of a mitigation action. + // The message of a mitigation action. Message *string - // The status of a mitigation action. + // The status of a mitigation action. Status DetectMitigationActionExecutionStatus - // The unique identifier of the task. + // The unique identifier of the task. TaskId *string - // The name of the thing. + // The name of the thing. ThingName *string - // The unique identifier of the violation. + // The unique identifier of the violation. ViolationId *string noSmithyDocumentSerde @@ -1301,13 +1334,13 @@ type DetectMitigationActionExecution struct { // The statistics of a mitigation action task. type DetectMitigationActionsTaskStatistics struct { - // The actions that were performed. + // The actions that were performed. ActionsExecuted *int64 - // The actions that failed. + // The actions that failed. ActionsFailed *int64 - // The actions that were skipped. + // The actions that were skipped. ActionsSkipped *int64 noSmithyDocumentSerde @@ -1316,34 +1349,34 @@ type DetectMitigationActionsTaskStatistics struct { // The summary of the mitigation action tasks. type DetectMitigationActionsTaskSummary struct { - // The definition of the actions. + // The definition of the actions. ActionsDefinition []MitigationAction - // Includes only active violations. + // Includes only active violations. OnlyActiveViolationsIncluded bool - // Includes suppressed alerts. + // Includes suppressed alerts. SuppressedAlertsIncluded bool - // Specifies the ML Detect findings to which the mitigation actions are applied. + // Specifies the ML Detect findings to which the mitigation actions are applied. Target *DetectMitigationActionsTaskTarget - // The date the task ended. + // The date the task ended. TaskEndTime *time.Time - // The unique identifier of the task. + // The unique identifier of the task. TaskId *string - // The date the task started. + // The date the task started. TaskStartTime *time.Time - // The statistics of a mitigation action task. + // The statistics of a mitigation action task. TaskStatistics *DetectMitigationActionsTaskStatistics - // The status of the task. + // The status of the task. TaskStatus DetectMitigationActionsTaskStatus - // Specifies the time period of which violation events occurred between. + // Specifies the time period of which violation events occurred between. ViolationEventOccurrenceRange *ViolationEventOccurrenceRange noSmithyDocumentSerde @@ -1352,13 +1385,13 @@ type DetectMitigationActionsTaskSummary struct { // The target of a mitigation action task. type DetectMitigationActionsTaskTarget struct { - // The name of the behavior. + // The name of the behavior. BehaviorName *string - // The name of the security profile. + // The name of the security profile. SecurityProfileName *string - // The unique identifiers of the violations. + // The unique identifiers of the violations. ViolationIds []string noSmithyDocumentSerde @@ -1367,6 +1400,7 @@ type DetectMitigationActionsTaskTarget struct { // A map of key-value pairs containing the patterns that need to be replaced in a // managed template job document schema. You can use the description of each key as // a guidance to specify the inputs during runtime when creating a job. +// // 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. @@ -1400,8 +1434,11 @@ 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 type DomainConfigurationSummary struct { @@ -1417,15 +1454,24 @@ type DomainConfigurationSummary struct { noSmithyDocumentSerde } -// 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. +// 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: -// ${sql-expression}. You can specify any valid expression in a WHERE or SELECT -// clause, including JSON properties, comparisons, calculations, and functions. For -// example, the following field uses the third level of the topic: "hashKeyValue": -// "${topic(3)}" The following field uses the timestamp: "rangeKeyValue": -// "${timestamp()}" +// ${sql-expression}. +// +// You can specify any valid expression in a WHERE or SELECT clause, including +// JSON properties, comparisons, calculations, and functions. For example, the +// following field uses the third level of the topic: +// +// "hashKeyValue": "${topic(3)}" +// +// The following field uses the timestamp: +// +// "rangeKeyValue": "${timestamp()}" type DynamoDBAction struct { // The hash key name. @@ -1471,15 +1517,20 @@ type DynamoDBAction struct { noSmithyDocumentSerde } -// Describes an action to write to a DynamoDB table. This DynamoDB action writes -// each attribute in the message payload into it's own column in the DynamoDB -// table. +// Describes an action to write to a DynamoDB table. +// +// This DynamoDB action writes each attribute in the message payload into it's own +// column in the DynamoDB table. type DynamoDBv2Action struct { // Specifies the DynamoDB table to which the message data will be written. For - // example: { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { - // "tableName": "my-table" } } } Each attribute in the message payload will be - // written to a separate column in the DynamoDB database. + // example: + // + // { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { + // "tableName": "my-table" } } } + // + // Each attribute in the message payload will be written to a separate column in + // the DynamoDB database. // // This member is required. PutItem *PutItemInput @@ -1508,10 +1559,12 @@ type EffectivePolicy struct { } // 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) -// . +// action instead. For more information, see [OpenSearchAction]. +// +// [OpenSearchAction]: https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html type ElasticsearchAction struct { // The endpoint of your OpenSearch domain. @@ -1590,9 +1643,10 @@ type ExponentialRolloutRate struct { // This member is required. BaseRatePerMinute *int32 - // The exponential factor to increase the rate of rollout for a job. Amazon Web - // Services IoT Core supports up to one digit after the decimal (for example, 1.5, - // but not 1.55). + // The exponential factor to increase the rate of rollout for a job. + // + // Amazon Web Services IoT Core supports up to one digit after the decimal (for + // example, 1.5, but not 1.55). // // This member is required. IncrementFactor *float64 @@ -1642,12 +1696,14 @@ type FirehoseAction struct { // This member is required. 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) - // request. The resulting array can't have more than 500 records. + // Whether to deliver the Kinesis Data Firehose stream as a batch by using [PutRecordBatch] + // PutRecordBatch . 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]PutRecordBatch request. The resulting + // array can't have more than 500 records. + // + // [PutRecordBatch]: https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html BatchMode *bool // A character separator that will be used to separate records written to the @@ -1743,9 +1799,9 @@ type HttpActionHeader struct { // The authorization method used to send messages. 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) - // . + // Use Sig V4 authorization. For more information, see [Signature Version 4 Signing Process]. + // + // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Sigv4 *SigV4Authorization noSmithyDocumentSerde @@ -1806,30 +1862,37 @@ type ImplicitDeny struct { noSmithyDocumentSerde } -// Provides additional selections for named shadows and geolocation data. To add -// named shadows to your fleet indexing configuration, set namedShadowIndexingMode -// to be ON and specify your shadow names in namedShadowNames filter. To add -// geolocation data to your fleet indexing configuration: +// Provides additional selections for named shadows and geolocation data. +// +// To add named shadows to your fleet indexing configuration, set +// namedShadowIndexingMode to be ON and specify your shadow names in +// namedShadowNames filter. +// +// To add geolocation data to your fleet indexing configuration: +// // - If you store geolocation data in a class/unnamed shadow, set // thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data // in geoLocations filter. +// // - If you store geolocation data in a named shadow, set namedShadowIndexingMode // to be ON , add the shadow name in namedShadowNames filter, and specify your -// geolocation data in geoLocations filter. For more information, see Managing -// fleet indexing (https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html) -// . +// geolocation data in geoLocations filter. For more information, see [Managing fleet indexing]. +// +// [Managing fleet indexing]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html type IndexingFilter struct { // The list of geolocation targets that you select to index. The default maximum - // number of geolocation targets for indexing is 1 . 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) + // number of geolocation targets for indexing is 1 . To increase the limit, see [Amazon Web Services IoT Device Management Quotas] // in the Amazon Web Services General Reference. + // + // [Amazon Web Services IoT Device Management Quotas]: https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits GeoLocations []GeoLocationTarget // 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) - // in the Amazon Web Services General Reference. + // names for indexing is 10. To increase the limit, see [Amazon Web Services IoT Device Management Quotas]in the Amazon Web Services + // General Reference. + // + // [Amazon Web Services IoT Device Management Quotas]: https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits NamedShadowNames []string noSmithyDocumentSerde @@ -1838,11 +1901,14 @@ 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 - // 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) + // 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]BatchPutMessage // to the IoT Analytics channel. The resulting array can't have more than 100 // messages. + // + // [BatchPutMessage]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html BatchMode *bool // (deprecated) The ARN of the IoT Analytics channel to which message data will be @@ -1874,14 +1940,21 @@ type IotEventsAction struct { 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 - // 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. + // + // 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]BatchPutMessage . The resulting array can't have more than 10 messages. + // + // [BatchPutMessage]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html 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. + // 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. + // // 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 @@ -1944,16 +2017,19 @@ type Job struct { // The package version Amazon Resource Names (ARNs) that are installed on the // device when the job successfully completes. The package version must be in // either the Published or Deprecated state when the job deploys. For more - // information, see Package version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // .The package version must be in either the Published or Deprecated state when - // the job deploys. For more information, see Package version lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . Note:The following Length Constraints relates to a single ARN. Up to 25 - // package version ARNs are allowed. + // information, see [Package version lifecycle].The package version must be in either the Published or + // Deprecated state when the job deploys. For more information, see [Package version lifecycle]. + // + // Note:The following Length Constraints relates to a single ARN. Up to 25 package + // version ARNs are allowed. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle DestinationPackageVersions []string // A key-value map that pairs the patterns that need to be replaced in a managed // template job document schema. You can use the description of each key as a // guidance to specify the inputs during runtime when creating a job. + // // 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. @@ -1988,12 +2064,18 @@ type Job struct { // The time, in seconds since the epoch, when the job was last updated. LastUpdatedAt *time.Time - // The namespace used to indicate that a job is a customer-managed job. When you - // specify a value for this parameter, Amazon Web Services IoT Core sends jobs - // notifications to MQTT topics that contain the value in the following format. - // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The - // namespaceId feature is only supported by IoT Greengrass at this time. For more - // information, see Setting up IoT Greengrass core devices. (https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html) + // The namespace used to indicate that a job is a customer-managed job. + // + // When you specify a value for this parameter, Amazon Web Services IoT Core sends + // jobs notifications to MQTT topics that contain the value in the following + // format. + // + // $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ + // + // The namespaceId feature is only supported by IoT Greengrass at this time. For + // more information, see [Setting up IoT Greengrass core devices.] + // + // [Setting up IoT Greengrass core devices.]: https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html NamespaceId *string // Configuration for pre-signed S3 URLs. @@ -2018,10 +2100,11 @@ type Job struct { // (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. + // 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. @@ -2239,10 +2322,11 @@ type JobSummary struct { // (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. + // 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. @@ -2302,9 +2386,11 @@ type KafkaAction struct { // Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka // Action. You can use these headers to route data from IoT clients to downstream -// Kafka clusters without modifying your message payload. For more information -// about Rule's Kafka action, see Apache Kafka (https://docs.aws.amazon.com/iot/latest/developerguide/apache-kafka-rule-action.html) -// . +// Kafka clusters without modifying your message payload. +// +// For more information about Rule's Kafka action, see [Apache Kafka]. +// +// [Apache Kafka]: https://docs.aws.amazon.com/iot/latest/developerguide/apache-kafka-rule-action.html type KafkaActionHeader struct { // The key of the Kafka header. @@ -2411,8 +2497,10 @@ 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 @@ -2461,7 +2549,8 @@ 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 @@ -2586,17 +2675,17 @@ type MetricValue struct { // numeric value to be compared with the metric . Count *int64 - // The numeral value of a metric. + // The numeral value of a metric. Number *float64 - // The numeral values of a metric. + // 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 . Ports []int32 - // The string values of a metric. + // The string values of a metric. Strings []string noSmithyDocumentSerde @@ -2685,47 +2774,70 @@ 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] from +// Amazon Web Services IoT Core Developer Guide. +// +// [MQTT]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html 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) - // . + // + // For more information, see [Content Type] from the MQTT Version 5.0 specification. + // + // Supports [substitution templates]. + // + // [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html + // [Content Type]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118 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) - // 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) - // . + // identify which request the response message is for when it's received. + // + // For more information, see [Correlation Data] from the MQTT Version 5.0 specification. + // + // This binary data must be based64-encoded. + // + // Supports [substitution templates]. + // + // [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html + // [Correlation Data]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115 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] from the Amazon Web Services Reference Guide. + // + // Supports [substitution templates]. + // + // [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html + // [Amazon Web Services IoT Core message broker and protocol limits and quotas]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.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] from the MQTT Version 5.0 specification. + // + // Supports [substitution templates]. + // + // [Payload Format Indicator]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111 + // [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) - // . + // wildcard characters. + // + // For more information, see [Response Topic] from the MQTT Version 5.0 specification. + // + // Supports [substitution templates]. + // + // [Response Topic]: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114 + // [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. @@ -2937,9 +3049,9 @@ type PackageVersionSummary struct { // The name of the associated software package. PackageName *string - // The status of the package version. For more information, see Package version - // lifecycle (https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) - // . + // The status of the package version. For more information, see [Package version lifecycle]. + // + // [Package version lifecycle]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle Status PackageVersionStatus // The name of the target package version. @@ -3009,9 +3121,12 @@ type PresignedUrlConfig struct { // The ARN of an IAM role that 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) - // in the Amazon Web Services IoT Core developer guide. + // permission for IoT to download the files. + // + // For information about addressing the confused deputy problem, see [cross-service confused deputy prevention] in the + // Amazon Web Services IoT Core developer guide. + // + // [cross-service confused deputy prevention]: https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html RoleArn *string noSmithyDocumentSerde @@ -3020,14 +3135,16 @@ type PresignedUrlConfig struct { // Structure that contains payloadVersion and targetArn . type ProvisioningHook struct { - // The ARN of the target function. Note: Only Lambda functions are currently - // supported. + // The ARN of the target function. + // + // Note: Only Lambda functions are currently supported. // // This member is required. TargetArn *string - // The payload that was sent to the target function. Note: Only Lambda functions - // are currently supported. + // The payload that was sent to the target function. + // + // Note: Only Lambda functions are currently supported. PayloadVersion *string noSmithyDocumentSerde @@ -3057,8 +3174,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) - // . + // template, see: [Provisioning template]. + // + // [Provisioning template]: https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html Type TemplateType noSmithyDocumentSerde @@ -3206,8 +3324,10 @@ 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] from the + // Amazon Web Services IoT Core Developer Guide. + // + // [MQTT]: https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html Headers *MqttHeaders // The Quality of Service (QoS) level to use when republishing messages. The @@ -3305,9 +3425,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]. + // + // [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 @@ -3318,8 +3438,9 @@ 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]. + // + // [S3 canned ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl CannedAcl CannedAccessControlList noSmithyDocumentSerde @@ -3420,9 +3541,12 @@ type SchedulingConfig struct { // 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. For more information on the syntax for endTime when using an API - // command or the Command Line Interface, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // . + // the time. + // + // For more information on the syntax for endTime when using an API command or the + // Command Line Interface, see [Timestamp]. + // + // [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp EndTime *string // An optional configuration within the SchedulingConfig to setup a recurring @@ -3434,9 +3558,12 @@ type SchedulingConfig struct { // target group for a job. The startTime can be scheduled up to a year in advance // and must be scheduled a minimum of thirty minutes from the current time. The // date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for - // the time. For more information on the syntax for startTime when using an API - // command or the Command Line Interface, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // . + // the time. + // + // For more information on the syntax for startTime when using an API command or + // the Command Line Interface, see [Timestamp]. + // + // [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp StartTime *string noSmithyDocumentSerde @@ -3485,9 +3612,11 @@ type SecurityProfileTargetMapping struct { type ServerCertificateConfig struct { // A Boolean value that indicates whether Online Certificate Status Protocol - // (OCSP) server certificate check is enabled or not. For more information, see - // Configuring OCSP server-certificate stapling in domain configuration (https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-domain-ocsp-config.html) - // from Amazon Web Services IoT Core Developer Guide. + // (OCSP) server certificate check is enabled or not. + // + // For more information, see [Configuring OCSP server-certificate stapling in domain configuration] from Amazon Web Services IoT Core Developer Guide. + // + // [Configuring OCSP server-certificate stapling in domain configuration]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-domain-ocsp-config.html EnableOCSPCheck *bool noSmithyDocumentSerde @@ -3523,8 +3652,9 @@ 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]. +// +// [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. @@ -3562,9 +3692,9 @@ type SnsAction struct { // "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this // 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. + // SNS message formats, see [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 MessageFormat MessageFormat noSmithyDocumentSerde @@ -3622,8 +3752,9 @@ 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]. +// +// [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. @@ -3876,13 +4007,18 @@ type ThingDocument struct { // service. 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) - // . + // Contains Device Defender data. + // + // For more information about Device Defender, see [Device Defender]. + // + // [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.] + // + // [IoT Device Shadow service.]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html Shadow *string // Thing group names. @@ -3931,14 +4067,17 @@ type ThingGroupIndexingConfiguration struct { // A list of thing group fields to index. This list cannot contain any managed // fields. Use the GetIndexingConfiguration API to get a list of managed fields. + // // Contains custom field names and their data type. CustomFields []Field // 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) - // in the Amazon Web Services IoT Core Developer Guide. You can't modify managed - // fields by updating fleet indexing configuration. + // Indexing service. This is an optional field. For more information, see [Managed fields]in the + // Amazon Web Services IoT Core Developer Guide. + // + // You can't modify managed fields by updating fleet indexing configuration. + // + // [Managed fields]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field ManagedFields []Field noSmithyDocumentSerde @@ -3971,14 +4110,17 @@ type ThingGroupProperties struct { noSmithyDocumentSerde } -// The thing indexing configuration. For more information, see Managing Thing -// Indexing (https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html) -// . +// The thing indexing configuration. For more information, see [Managing Thing Indexing]. +// +// [Managing Thing 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. // // This member is required. @@ -3988,45 +4130,63 @@ 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) + // + // For more information about Device Defender violations, see [Device Defender Detect.] + // + // [Device Defender Detect.]: https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html DeviceDefenderIndexingMode DeviceDefenderIndexingMode - // Provides additional selections for named shadows and geolocation data. To add - // named shadows to your fleet indexing configuration, set namedShadowIndexingMode - // to be ON and specify your shadow names in namedShadowNames filter. To add - // geolocation data to your fleet indexing configuration: + // Provides additional selections for named shadows and geolocation data. + // + // To add named shadows to your fleet indexing configuration, set + // namedShadowIndexingMode to be ON and specify your shadow names in + // namedShadowNames filter. + // + // To add geolocation data to your fleet indexing configuration: + // // - If you store geolocation data in a class/unnamed shadow, set // thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data // in geoLocations filter. + // // - If you store geolocation data in a named shadow, set namedShadowIndexingMode // to be ON , add the shadow name in namedShadowNames filter, and specify your - // geolocation data in geoLocations filter. For more information, see Managing - // fleet indexing (https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html) - // . + // geolocation data in geoLocations filter. For more information, see [Managing fleet indexing]. + // + // [Managing fleet indexing]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html Filter *IndexingFilter // 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) - // in the Amazon Web Services IoT Core Developer Guide. You can't modify managed - // fields by updating fleet indexing configuration. + // Indexing service. This is an optional field. For more information, see [Managed fields]in the + // Amazon Web Services IoT Core Developer Guide. + // + // You can't modify managed fields by updating fleet indexing configuration. + // + // [Managed fields]: https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field 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) + // + // For more information about Shadows, see [IoT Device Shadow service.] + // + // [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. ThingConnectivityIndexingMode ThingConnectivityIndexingMode @@ -4102,8 +4262,10 @@ 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) -// topic rule action documentation. +// into an Amazon Timestream table. For more information, see the [Timestream]topic rule +// action documentation. +// +// [Timestream]: https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html type TimestreamAction struct { // The name of an Amazon Timestream database. @@ -4128,11 +4290,14 @@ type TimestreamAction struct { TableName *string // Specifies an application-defined value to replace the default value assigned to - // the Timestream record's timestamp in the time column. You can use this property - // to specify the value and the precision of the Timestream record's timestamp. You - // can specify a value from the message payload or a value computed by a - // substitution template. If omitted, the topic rule action assigns the timestamp, - // in milliseconds, at the time it processed the rule. + // the Timestream record's timestamp in the time column. + // + // You can use this property to specify the value and the precision of the + // Timestream record's timestamp. You can specify a value from the message payload + // or a value computed by a substitution template. + // + // If omitted, the topic rule action assigns the timestamp, in milliseconds, at + // the time it processed the rule. Timestamp *TimestreamTimestamp noSmithyDocumentSerde @@ -4142,9 +4307,11 @@ 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 @@ -4162,8 +4329,10 @@ 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 @@ -4179,9 +4348,10 @@ type TimestreamTimestamp struct { // An object that specifies the TLS configuration for a domain. type TlsConfig struct { - // The security policy for a domain configuration. For more information, see - // Security policies (https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html#tls-policy-table) - // in the Amazon Web Services IoT Core developer guide. + // The security policy for a domain configuration. For more information, see [Security policies] in + // the Amazon Web Services IoT Core developer guide. + // + // [Security policies]: https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html#tls-policy-table SecurityPolicy *string noSmithyDocumentSerde @@ -4242,19 +4412,24 @@ type TopicRuleDestination struct { // The date and time when the topic rule destination was last updated. LastUpdatedAt *time.Time - // 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 - // 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 - // this destination is not allowed. You can set status to ENABLED by calling - // 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 - // confirmation challenge to be sent to your confirmation endpoint. + // 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 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 this destination is not + // allowed. You can set status to ENABLED by calling 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 confirmation challenge to be + // sent to your confirmation endpoint. Status TopicRuleDestinationStatus // Additional details or reason why the topic rule destination is in the current @@ -4294,19 +4469,24 @@ type TopicRuleDestinationSummary struct { // The date and time when the topic rule destination was last updated. LastUpdatedAt *time.Time - // 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 - // 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 - // this destination is not allowed. You can set status to ENABLED by calling - // 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 - // confirmation challenge to be sent to your confirmation endpoint. + // 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 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 this destination is not + // allowed. You can set status to ENABLED by calling 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 confirmation challenge to be + // sent to your confirmation endpoint. Status TopicRuleDestinationStatus // The reason the topic rule destination is in the current status. @@ -4347,9 +4527,10 @@ type TopicRulePayload struct { // This member is required. 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) - // in the IoT Developer Guide. + // The SQL statement used to query the topic. For more information, see [IoT SQL Reference] in the + // IoT Developer Guide. + // + // [IoT SQL Reference]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html // // This member is required. Sql *string @@ -4417,8 +4598,9 @@ 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]. +// +// [substitution templates]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html type UserProperty struct { // A key to be specified in UserProperty . @@ -4445,9 +4627,10 @@ type ValidationError struct { // Configuration to manage IoT Job's package version reporting. If configured, // Jobs updates the thing's reserved named shadow with the package version -// information up on successful job completion. Note: For each job, the -// destinationPackageVersions attribute has to be set with the correct data for -// Jobs to report to the thing shadow. +// information up on successful job completion. +// +// Note: For each job, the destinationPackageVersions attribute has to be set with +// the correct data for Jobs to report to the thing shadow. type VersionUpdateByJobsConfig struct { // Indicates whether the Job is enabled or not. @@ -4482,7 +4665,7 @@ type ViolationEvent struct { // The description of the verification state of the violation. VerificationStateDescription *string - // The details of a violation event. + // The details of a violation event. ViolationEventAdditionalInfo *ViolationEventAdditionalInfo // The time the violation event occurred. @@ -4500,7 +4683,8 @@ 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 @@ -4509,12 +4693,12 @@ type ViolationEventAdditionalInfo struct { // Specifies the time period of which violation events occurred between. type ViolationEventOccurrenceRange struct { - // The end date and time of a time period in which violation events occurred. + // The end date and time of a time period in which violation events occurred. // // This member is required. EndTime *time.Time - // The start date and time of a time period in which violation events occurred. + // The start date and time of a time period in which violation events occurred. // // This member is required. StartTime *time.Time diff --git a/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go b/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go index 3e731071964..fa9df6dce21 100644 --- a/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go +++ b/service/iot1clickdevicesservice/api_op_FinalizeDeviceClaim.go @@ -11,6 +11,7 @@ import ( ) // Given a device ID, finalizes the 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. @@ -37,9 +38,9 @@ type FinalizeDeviceClaimInput struct { DeviceId *string // 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/) - // . + // "tags": {"key1": "value1", "key2": "value2"} }. For more information, see [AWS Tagging Strategies]. + // + // [AWS 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 abfd17c46d3..b14d21f3873 100644 --- a/service/iot1clickdevicesservice/api_op_InitiateDeviceClaim.go +++ b/service/iot1clickdevicesservice/api_op_InitiateDeviceClaim.go @@ -11,6 +11,7 @@ import ( ) // 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. diff --git a/service/iot1clickdevicesservice/api_op_ListTagsForResource.go b/service/iot1clickdevicesservice/api_op_ListTagsForResource.go index 12d05de3fdd..ec4a633d104 100644 --- a/service/iot1clickdevicesservice/api_op_ListTagsForResource.go +++ b/service/iot1clickdevicesservice/api_op_ListTagsForResource.go @@ -39,9 +39,9 @@ type ListTagsForResourceInput struct { 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/) - // . + // "tags": {"key1": "value1", "key2": "value2"} }. For more information, see [AWS Tagging Strategies]. + // + // [AWS 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 9cb63009a78..e9bfe1b5128 100644 --- a/service/iot1clickdevicesservice/api_op_TagResource.go +++ b/service/iot1clickdevicesservice/api_op_TagResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// for the maximum number of tags allowed per resource. +// Adds or updates the tags associated with the resource ARN. See [AWS IoT 1-Click Service Limits] for the maximum +// number of tags allowed per resource. +// +// [AWS IoT 1-Click Service Limits]: https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -36,9 +37,9 @@ type TagResourceInput struct { ResourceArn *string // 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/) - // . + // "tags": {"key1": "value1", "key2": "value2"} }. For more information, see [AWS Tagging Strategies]. + // + // [AWS 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/options.go b/service/iot1clickdevicesservice/options.go index 2fa8d97b754..bc7d15545c5 100644 --- a/service/iot1clickdevicesservice/options.go +++ b/service/iot1clickdevicesservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iot1clickprojects/api_op_CreateProject.go b/service/iot1clickprojects/api_op_CreateProject.go index c5eab1f9a6e..1a62f8a2541 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]. + // + // [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_DeletePlacement.go b/service/iot1clickprojects/api_op_DeletePlacement.go index 815d63ae4f2..05822f13f96 100644 --- a/service/iot1clickprojects/api_op_DeletePlacement.go +++ b/service/iot1clickprojects/api_op_DeletePlacement.go @@ -11,8 +11,9 @@ import ( ) // Deletes a placement. To delete a placement, it must not have any devices -// associated with it. When you delete a placement, all associated data becomes -// irretrievable. +// associated with it. +// +// When you delete a placement, all associated data becomes irretrievable. func (c *Client) DeletePlacement(ctx context.Context, params *DeletePlacementInput, optFns ...func(*Options)) (*DeletePlacementOutput, error) { if params == nil { params = &DeletePlacementInput{} diff --git a/service/iot1clickprojects/api_op_DeleteProject.go b/service/iot1clickprojects/api_op_DeleteProject.go index a0a11229d0f..d2f6790673c 100644 --- a/service/iot1clickprojects/api_op_DeleteProject.go +++ b/service/iot1clickprojects/api_op_DeleteProject.go @@ -11,8 +11,9 @@ import ( ) // Deletes a project. To delete a project, it must not have any placements -// associated with it. When you delete a project, all associated data becomes -// irretrievable. +// associated with it. +// +// When you delete a project, all associated data becomes irretrievable. func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { if params == nil { params = &DeleteProjectInput{} diff --git a/service/iot1clickprojects/api_op_TagResource.go b/service/iot1clickprojects/api_op_TagResource.go index e59069404a7..9186435bf25 100644 --- a/service/iot1clickprojects/api_op_TagResource.go +++ b/service/iot1clickprojects/api_op_TagResource.go @@ -11,9 +11,9 @@ 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/) -// . +// that can be used to manage a resource. For more information, see [AWS Tagging Strategies]. +// +// [AWS Tagging 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,10 @@ 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) - // for the maximum number of tags allowed per resource. + // The new or modifying tag(s) for the resource. See [AWS IoT 1-Click Service Limits] for the maximum number of + // tags allowed per resource. + // + // [AWS IoT 1-Click Service Limits]: https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits // // This member is required. Tags map[string]string diff --git a/service/iot1clickprojects/options.go b/service/iot1clickprojects/options.go index c13808d2377..7e0bc98e434 100644 --- a/service/iot1clickprojects/options.go +++ b/service/iot1clickprojects/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iot1clickprojects/types/types.go b/service/iot1clickprojects/types/types.go index 57f36166db5..b1c33ad39c0 100644 --- a/service/iot1clickprojects/types/types.go +++ b/service/iot1clickprojects/types/types.go @@ -7,8 +7,7 @@ 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 @@ -87,8 +86,7 @@ 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_op_BatchPutMessage.go b/service/iotanalytics/api_op_BatchPutMessage.go index 19d85e7204f..1715fb37430 100644 --- a/service/iotanalytics/api_op_BatchPutMessage.go +++ b/service/iotanalytics/api_op_BatchPutMessage.go @@ -35,17 +35,25 @@ type BatchPutMessageInput struct { ChannelName *string // 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: + // "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. // diff --git a/service/iotanalytics/api_op_CreateDataset.go b/service/iotanalytics/api_op_CreateDataset.go index c3f43282076..bff6f5f2e62 100644 --- a/service/iotanalytics/api_op_CreateDataset.go +++ b/service/iotanalytics/api_op_CreateDataset.go @@ -48,16 +48,18 @@ 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) - // filter. + // late. To specify lateDataRules , the dataset must use a [DeltaTimer] filter. + // + // [DeltaTimer]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html 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 // 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) - // in the IoT Analytics User Guide. + // information, see [Keeping Multiple Versions of IoT Analytics datasets]in the IoT Analytics User Guide. + // + // [Keeping Multiple Versions of IoT Analytics datasets]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions RetentionPeriod *types.RetentionPeriod // Metadata which can be used to manage the dataset. @@ -71,9 +73,9 @@ type CreateDatasetInput 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) - // in the IoT Analytics User Guide. + // parameter. For more information, see [Keeping Multiple Versions of IoT Analytics datasets]in the IoT Analytics User Guide. + // + // [Keeping Multiple Versions of IoT Analytics datasets]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions VersioningConfiguration *types.VersioningConfiguration noSmithyDocumentSerde diff --git a/service/iotanalytics/api_op_CreateDatasetContent.go b/service/iotanalytics/api_op_CreateDatasetContent.go index 3f0bb1c9d05..8008866e308 100644 --- a/service/iotanalytics/api_op_CreateDatasetContent.go +++ b/service/iotanalytics/api_op_CreateDatasetContent.go @@ -35,8 +35,9 @@ 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) - // filter. + // content, the dataset must use a [DeltaTimer]filter. + // + // [DeltaTimer]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html VersionId *string noSmithyDocumentSerde diff --git a/service/iotanalytics/api_op_CreateDatastore.go b/service/iotanalytics/api_op_CreateDatastore.go index ddb0f577b49..8f9fbf5761c 100644 --- a/service/iotanalytics/api_op_CreateDatastore.go +++ b/service/iotanalytics/api_op_CreateDatastore.go @@ -34,7 +34,7 @@ type CreateDatastoreInput struct { // This member is required. DatastoreName *string - // Contains information about the partition dimensions in a data store. + // Contains information about the partition dimensions in a data store. DatastorePartitions *types.DatastorePartitions // Where data in a data store is stored.. You can choose serviceManagedS3 storage, @@ -44,9 +44,13 @@ type CreateDatastoreInput struct { 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 - // format is JSON. You can specify only one format. You can't change the file - // format after you create the data store. + // stores support JSON and [Parquet]. + // + // 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. + // + // [Parquet]: https://parquet.apache.org/ FileFormatConfiguration *types.FileFormatConfiguration // How long, in days, message data is kept for the data store. When diff --git a/service/iotanalytics/api_op_CreatePipeline.go b/service/iotanalytics/api_op_CreatePipeline.go index 9c11c2bddda..093233a09cf 100644 --- a/service/iotanalytics/api_op_CreatePipeline.go +++ b/service/iotanalytics/api_op_CreatePipeline.go @@ -36,10 +36,13 @@ 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_DeleteDataset.go b/service/iotanalytics/api_op_DeleteDataset.go index af933157a32..09f79fea06d 100644 --- a/service/iotanalytics/api_op_DeleteDataset.go +++ b/service/iotanalytics/api_op_DeleteDataset.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified dataset. You do not have to delete the content of the -// dataset before you perform this operation. +// Deletes the specified dataset. +// +// You do not have to delete the content of the dataset before you perform this +// operation. func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error) { if params == nil { params = &DeleteDatasetInput{} diff --git a/service/iotanalytics/api_op_ListChannels.go b/service/iotanalytics/api_op_ListChannels.go index bc60e12f5e0..33665c1b5d4 100644 --- a/service/iotanalytics/api_op_ListChannels.go +++ b/service/iotanalytics/api_op_ListChannels.go @@ -29,8 +29,9 @@ func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, op type ListChannelsInput struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // The default value is 100. MaxResults *int32 // The token for the next set of results. @@ -139,8 +140,9 @@ var _ ListChannelsAPIClient = (*Client)(nil) // ListChannelsPaginatorOptions is the paginator options for ListChannels type ListChannelsPaginatorOptions struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // 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/iotanalytics/api_op_ListDatasets.go b/service/iotanalytics/api_op_ListDatasets.go index b29bfcd6453..2b0f6b09747 100644 --- a/service/iotanalytics/api_op_ListDatasets.go +++ b/service/iotanalytics/api_op_ListDatasets.go @@ -29,8 +29,9 @@ func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, op type ListDatasetsInput struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // The default value is 100. MaxResults *int32 // The token for the next set of results. @@ -139,8 +140,9 @@ var _ ListDatasetsAPIClient = (*Client)(nil) // ListDatasetsPaginatorOptions is the paginator options for ListDatasets type ListDatasetsPaginatorOptions struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // 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/iotanalytics/api_op_ListDatastores.go b/service/iotanalytics/api_op_ListDatastores.go index ef2dedd62af..78ab8dcc311 100644 --- a/service/iotanalytics/api_op_ListDatastores.go +++ b/service/iotanalytics/api_op_ListDatastores.go @@ -29,8 +29,9 @@ func (c *Client) ListDatastores(ctx context.Context, params *ListDatastoresInput type ListDatastoresInput struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // The default value is 100. MaxResults *int32 // The token for the next set of results. @@ -140,8 +141,9 @@ var _ ListDatastoresAPIClient = (*Client)(nil) // ListDatastoresPaginatorOptions is the paginator options for ListDatastores type ListDatastoresPaginatorOptions struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // 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/iotanalytics/api_op_ListPipelines.go b/service/iotanalytics/api_op_ListPipelines.go index 4c5eae2f051..cfe4f31699c 100644 --- a/service/iotanalytics/api_op_ListPipelines.go +++ b/service/iotanalytics/api_op_ListPipelines.go @@ -29,8 +29,9 @@ func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, type ListPipelinesInput struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // The default value is 100. MaxResults *int32 // The token for the next set of results. @@ -139,8 +140,9 @@ var _ ListPipelinesAPIClient = (*Client)(nil) // ListPipelinesPaginatorOptions is the paginator options for ListPipelines type ListPipelinesPaginatorOptions struct { - // The maximum number of results to return in this request. The default value is - // 100. + // The maximum number of results to return in this request. + // + // 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/iotanalytics/api_op_PutLoggingOptions.go b/service/iotanalytics/api_op_PutLoggingOptions.go index 4ae080f2324..abf448b3298 100644 --- a/service/iotanalytics/api_op_PutLoggingOptions.go +++ b/service/iotanalytics/api_op_PutLoggingOptions.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets or updates the IoT Analytics logging options. If you update the value of -// any loggingOptions field, it takes up to one minute for the change to take -// effect. Also, if you change the policy attached to the role you specified in the -// roleArn field (for example, to correct an invalid policy), it takes up to five -// minutes for that change to take effect. +// Sets or updates the IoT Analytics logging options. +// +// If you update the value of any loggingOptions field, it takes up to one minute +// for the change to take effect. Also, if you change the policy attached to the +// role you specified in the roleArn field (for example, to correct an invalid +// policy), it takes up to five minutes for that change to take effect. func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error) { if params == nil { params = &PutLoggingOptionsInput{} diff --git a/service/iotanalytics/api_op_StartPipelineReprocessing.go b/service/iotanalytics/api_op_StartPipelineReprocessing.go index 38df3515e47..954eb4e2249 100644 --- a/service/iotanalytics/api_op_StartPipelineReprocessing.go +++ b/service/iotanalytics/api_op_StartPipelineReprocessing.go @@ -35,18 +35,21 @@ type StartPipelineReprocessingInput struct { // This member is required. PipelineName *string - // 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 . + // 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 . 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 - // specify a value for the startTime parameter, you must not use the + // The start time (inclusive) of raw message data that is reprocessed. + // + // If you specify a value for the startTime parameter, you must not use the // channelMessages object. StartTime *time.Time diff --git a/service/iotanalytics/api_op_UpdateDataset.go b/service/iotanalytics/api_op_UpdateDataset.go index e68e15116f9..fa44aedfc17 100644 --- a/service/iotanalytics/api_op_UpdateDataset.go +++ b/service/iotanalytics/api_op_UpdateDataset.go @@ -44,8 +44,9 @@ 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) - // filter. + // late. To specify lateDataRules , the dataset must use a [DeltaTimer] filter. + // + // [DeltaTimer]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html LateDataRules []types.LateDataRule // How long, in days, dataset contents are kept for the dataset. @@ -58,9 +59,9 @@ type UpdateDatasetInput 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) - // in the IoT Analytics User Guide. + // parameter. For more information, see [Keeping Multiple Versions of IoT Analytics datasets]in the IoT Analytics User Guide. + // + // [Keeping Multiple Versions of IoT Analytics datasets]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions VersioningConfiguration *types.VersioningConfiguration noSmithyDocumentSerde diff --git a/service/iotanalytics/api_op_UpdateDatastore.go b/service/iotanalytics/api_op_UpdateDatastore.go index c8ca6149cb4..09fcfedabec 100644 --- a/service/iotanalytics/api_op_UpdateDatastore.go +++ b/service/iotanalytics/api_op_UpdateDatastore.go @@ -41,9 +41,13 @@ type UpdateDatastoreInput struct { 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 - // format is JSON. You can specify only one format. You can't change the file - // format after you create the data store. + // stores support JSON and [Parquet]. + // + // 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. + // + // [Parquet]: https://parquet.apache.org/ FileFormatConfiguration *types.FileFormatConfiguration // How long, in days, message data is kept for the data store. The retention diff --git a/service/iotanalytics/api_op_UpdatePipeline.go b/service/iotanalytics/api_op_UpdatePipeline.go index 86937002e57..8a0fea6c52d 100644 --- a/service/iotanalytics/api_op_UpdatePipeline.go +++ b/service/iotanalytics/api_op_UpdatePipeline.go @@ -35,10 +35,13 @@ 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/doc.go b/service/iotanalytics/doc.go index 27de38102fb..99bc278e6c7 100644 --- a/service/iotanalytics/doc.go +++ b/service/iotanalytics/doc.go @@ -7,14 +7,17 @@ // messages, and store them. You can then query the data and run sophisticated // analytics on it. IoT Analytics enables advanced data exploration through // integration with Jupyter Notebooks and data visualization through integration -// with Amazon QuickSight. Traditional analytics and business intelligence tools -// are designed to process structured data. IoT data often comes from devices that -// record noisy processes (such as temperature, motion, or sound). As a result the -// data from these devices can have significant gaps, corrupted messages, and false -// readings that must be cleaned up before analysis can occur. Also, IoT data is -// often only meaningful in the context of other data from external sources. IoT -// Analytics automates the steps required to analyze data from IoT devices. IoT -// Analytics filters, transforms, and enriches IoT data before storing it in a +// with Amazon QuickSight. +// +// Traditional analytics and business intelligence tools are designed to process +// structured data. IoT data often comes from devices that record noisy processes +// (such as temperature, motion, or sound). As a result the data from these devices +// can have significant gaps, corrupted messages, and false readings that must be +// cleaned up before analysis can occur. Also, IoT data is often only meaningful in +// the context of other data from external sources. +// +// IoT Analytics automates the steps required to analyze data from IoT devices. +// IoT Analytics filters, transforms, and enriches IoT data before storing it in a // time-series data store for analysis. You can set up the service to collect only // the data you need from your devices, apply mathematical transforms to process // the data, and enrich the data with device-specific metadata such as device type diff --git a/service/iotanalytics/options.go b/service/iotanalytics/options.go index ab3fe3f26d8..105629db144 100644 --- a/service/iotanalytics/options.go +++ b/service/iotanalytics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotanalytics/types/enums.go b/service/iotanalytics/types/enums.go index 63696ce3ff4..4c645f9181b 100644 --- a/service/iotanalytics/types/enums.go +++ b/service/iotanalytics/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ChannelStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelStatus) Values() []ChannelStatus { return []ChannelStatus{ "CREATING", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ComputeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeType) Values() []ComputeType { return []ComputeType{ "ACU_1", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for DatasetActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetActionType) Values() []DatasetActionType { return []DatasetActionType{ "QUERY", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for DatasetContentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetContentState) Values() []DatasetContentState { return []DatasetContentState{ "CREATING", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for DatasetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatus) Values() []DatasetStatus { return []DatasetStatus{ "CREATING", @@ -108,8 +113,9 @@ const ( ) // Values returns all known values for DatastoreStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatastoreStatus) Values() []DatastoreStatus { return []DatastoreStatus{ "CREATING", @@ -127,8 +133,9 @@ const ( ) // Values returns all known values for FileFormatType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileFormatType) Values() []FileFormatType { return []FileFormatType{ "JSON", @@ -144,8 +151,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -163,8 +171,9 @@ const ( ) // Values returns all known values for ReprocessingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReprocessingStatus) Values() []ReprocessingStatus { return []ReprocessingStatus{ "RUNNING", diff --git a/service/iotanalytics/types/types.go b/service/iotanalytics/types/types.go index 99f534e10bf..1f7a6b7c4d9 100644 --- a/service/iotanalytics/types/types.go +++ b/service/iotanalytics/types/types.go @@ -12,8 +12,10 @@ import ( 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 . + // new attribute. + // + // The existing attributes remain in the message, so if you want to remove the + // originals, use RemoveAttributeActivity . // // This member is required. Attributes map[string]string @@ -55,10 +57,13 @@ type Channel struct { // When the channel was created. CreationTime *time.Time - // The last time when a new message arrived in the channel. IoT Analytics updates - // this value at most once per minute for one channel. Hence, the - // lastMessageArrivalTime value is an approximation. This feature only applies to - // messages that arrived in the data store after October 23, 2020. + // The last time when a new message arrived in the channel. + // + // IoT Analytics updates this value at most once per minute for one channel. + // Hence, the lastMessageArrivalTime value is an approximation. + // + // This feature only applies to messages that arrived in the data store after + // October 23, 2020. LastMessageArrivalTime *time.Time // When the channel was last updated. @@ -104,8 +109,11 @@ type ChannelActivity struct { type ChannelMessages struct { // Specifies one or more keys that identify the Amazon Simple Storage Service - // (Amazon S3) objects that save your channel messages. You must use the full path - // for the key. Example path: channel/mychannel/__dt=2020-02-29 + // (Amazon S3) objects that save your channel messages. + // + // You must use the full path for the key. + // + // Example path: channel/mychannel/__dt=2020-02-29 // 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz S3Paths []string @@ -162,10 +170,13 @@ type ChannelSummary struct { // When the channel was created. CreationTime *time.Time - // The last time when a new message arrived in the channel. IoT Analytics updates - // this value at most once per minute for one channel. Hence, the - // lastMessageArrivalTime value is an approximation. This feature only applies to - // messages that arrived in the data store after October 23, 2020. + // The last time when a new message arrived in the channel. + // + // IoT Analytics updates this value at most once per minute for one channel. + // Hence, the lastMessageArrivalTime value is an approximation. + // + // This feature only applies to messages that arrived in the data store after + // October 23, 2020. LastMessageArrivalTime *time.Time // The last time the channel was updated. @@ -185,9 +196,10 @@ type Column struct { // This member is required. 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. + // The type of data. For more information about the supported data types, see [Common data types] in + // the Glue Developer Guide. + // + // [Common data types]: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html // // This member is required. Type *string @@ -335,8 +347,9 @@ 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) - // filter. + // late. To specify lateDataRules , the dataset must use a [DeltaTimer] filter. + // + // [DeltaTimer]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html LateDataRules []LateDataRule // The name of the dataset. @@ -355,9 +368,9 @@ 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) - // in the IoT Analytics User Guide. + // parameter. For more information, see [Keeping Multiple Versions of IoT Analytics datasets]in the IoT Analytics User Guide. + // + // [Keeping Multiple Versions of IoT Analytics datasets]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions VersioningConfiguration *VersioningConfiguration noSmithyDocumentSerde @@ -529,20 +542,27 @@ type Datastore struct { // When the data store was created. CreationTime *time.Time - // Contains information about the partition dimensions in a data store. + // Contains information about the partition dimensions in a data store. DatastorePartitions *DatastorePartitions // Contains the configuration information of file formats. IoT Analytics data - // 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. + // stores support JSON and [Parquet]. + // + // 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. + // + // [Parquet]: https://parquet.apache.org/ FileFormatConfiguration *FileFormatConfiguration - // The last time when a new message arrived in the data store. IoT Analytics - // updates this value at most once per minute for Amazon Simple Storage Service one - // data store. Hence, the lastMessageArrivalTime value is an approximation. This - // feature only applies to messages that arrived in the data store after October - // 23, 2020. + // The last time when a new message arrived in the data store. + // + // IoT Analytics updates this value at most once per minute for Amazon Simple + // Storage Service one data store. Hence, the lastMessageArrivalTime value is an + // approximation. + // + // This feature only applies to messages that arrived in the data store after + // October 23, 2020. LastMessageArrivalTime *time.Time // The last time the data store was updated. @@ -555,9 +575,13 @@ 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, @@ -585,12 +609,14 @@ type DatastoreActivity struct { noSmithyDocumentSerde } -// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. -// You can't change the choice of Amazon S3 storage after your data store is -// created. +// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you +// +// manage. You can't change the choice of Amazon S3 storage after your data store +// is created. type DatastoreIotSiteWiseMultiLayerStorage struct { - // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. + // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you + // manage. // // This member is required. CustomerManagedS3Storage *IotSiteWiseCustomerManagedDatastoreS3Storage @@ -598,7 +624,8 @@ type DatastoreIotSiteWiseMultiLayerStorage struct { noSmithyDocumentSerde } -// Contains information about the data store that you manage, which stores data +// Contains information about the data store that you manage, which stores data +// // used by IoT SiteWise. type DatastoreIotSiteWiseMultiLayerStorageSummary struct { @@ -608,14 +635,15 @@ type DatastoreIotSiteWiseMultiLayerStorageSummary struct { noSmithyDocumentSerde } -// A single dimension to partition a data store. The dimension must be an +// A single dimension to partition a data store. The dimension must be an +// // 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. + // A partition dimension defined by a timestamp attribute. TimestampPartition *TimestampPartition noSmithyDocumentSerde @@ -624,7 +652,7 @@ type DatastorePartition struct { // Contains information about the partition dimensions in a data store. type DatastorePartitions struct { - // A list of partition dimensions in a data store. + // A list of partition dimensions in a data store. Partitions []DatastorePartition noSmithyDocumentSerde @@ -664,9 +692,10 @@ type DatastoreStorageMemberCustomerManagedS3 struct { func (*DatastoreStorageMemberCustomerManagedS3) isDatastoreStorage() {} -// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. -// You can't change the choice of Amazon S3 storage after your data store is -// created. +// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you +// +// manage. You can't change the choice of Amazon S3 storage after your data store +// is created. type DatastoreStorageMemberIotSiteWiseMultiLayerStorage struct { Value DatastoreIotSiteWiseMultiLayerStorage @@ -691,7 +720,8 @@ type DatastoreStorageSummary struct { // Used to store data in an Amazon S3 bucket managed by IoT Analytics. CustomerManagedS3 *CustomerManagedDatastoreS3StorageSummary - // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. + // Used to store data used by IoT SiteWise in an Amazon S3 bucket that you + // manage. IotSiteWiseMultiLayerStorage *DatastoreIotSiteWiseMultiLayerStorageSummary // Used to store data in an Amazon S3 bucket managed by IoT Analytics. @@ -709,7 +739,7 @@ type DatastoreSummary struct { // The name of the data store. DatastoreName *string - // Contains information about the partition dimensions in a data store. + // Contains information about the partition dimensions in a data store. DatastorePartitions *DatastorePartitions // Where data in a data store is stored. @@ -718,11 +748,14 @@ type DatastoreSummary struct { // The file format of the data in the data store. FileFormatType FileFormatType - // The last time when a new message arrived in the data store. IoT Analytics - // updates this value at most once per minute for Amazon Simple Storage Service one - // data store. Hence, the lastMessageArrivalTime value is an approximation. This - // feature only applies to messages that arrived in the data store after October - // 23, 2020. + // The last time when a new message arrived in the data store. + // + // IoT Analytics updates this value at most once per minute for Amazon Simple + // Storage Service one data store. Hence, the lastMessageArrivalTime value is an + // approximation. + // + // This feature only applies to messages that arrived in the data store after + // October 23, 2020. LastMessageArrivalTime *time.Time // The last time the data store was updated. @@ -761,19 +794,25 @@ 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) -// in the IoT Analytics User Guide. +// window. +// +// [DeltaTime]DeltaTime 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)] in the IoT Analytics User Guide. +// +// [DeltaTime]: https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html +// [Creating a SQL dataset with a delta window (CLI)]: https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6 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. + // one time. + // + // For more information about how to write a timestamp expression, see [Date and Time Functions and Operators], in the + // Presto 0.172 Documentation. + // + // [Date and Time Functions and Operators]: https://prestodb.io/docs/0.172/functions/datetime.html // // This member is required. TimeoutInMinutes *int32 @@ -853,9 +892,13 @@ 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 -// format is JSON. You can specify only one format. You can't change the file -// format after you create the data store. +// stores support JSON and [Parquet]. +// +// 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. +// +// [Parquet]: https://parquet.apache.org/ type FileFormatConfiguration struct { // Contains the configuration information of the JSON format. @@ -924,17 +967,18 @@ type IotEventsDestinationConfiguration struct { noSmithyDocumentSerde } -// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. -// You can't change the choice of Amazon S3 storage after your data store is -// created. +// Used to store data used by IoT SiteWise in an Amazon S3 bucket that you +// +// manage. You can't change the choice of Amazon S3 storage after your data store +// is created. type IotSiteWiseCustomerManagedDatastoreS3Storage struct { - // The name of the Amazon S3 bucket where your data is stored. + // The name of the Amazon S3 bucket where your data is stored. // // This member is required. Bucket *string - // (Optional) The prefix used to create the keys of the data store data objects. + // (Optional) The prefix used to create the keys of the data store data objects. // Each object in an Amazon S3 bucket 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 (/). @@ -943,14 +987,15 @@ type IotSiteWiseCustomerManagedDatastoreS3Storage struct { noSmithyDocumentSerde } -// Contains information about the data store that you manage, which stores data +// Contains information about the data store that you manage, which stores data +// // used by IoT SiteWise. type IotSiteWiseCustomerManagedDatastoreS3StorageSummary struct { - // The name of the Amazon S3 bucket where your data is stored. + // The name of the Amazon S3 bucket where your data is stored. Bucket *string - // (Optional) The prefix used to create the keys of the data store data objects. + // (Optional) The prefix used to create the keys of the data store data objects. // Each object in an Amazon S3 bucket 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 (/). @@ -967,9 +1012,10 @@ type JsonConfiguration struct { // An activity that runs a Lambda function to modify the message. type LambdaActivity struct { - // The number of messages passed to the Lambda function for processing. The Lambda - // function must be able to process all of these messages within five minutes, - // which is the maximum timeout duration for Lambda functions. + // The number of messages passed to the Lambda function for processing. + // + // The Lambda function must be able to process all of these messages within five + // minutes, which is the maximum timeout duration for Lambda functions. // // This member is required. BatchSize *int32 @@ -1104,7 +1150,7 @@ type ParquetConfiguration struct { // A partition dimension defined by an attribute. type Partition struct { - // The name of the attribute that defines a partition dimension. + // The name of the attribute that defines a partition dimension. // // This member is required. AttributeName *string @@ -1278,17 +1324,23 @@ type S3DestinationConfiguration struct { Bucket *string // 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: + // 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. + // // 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 + // 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 versionId s. This means that one dataset content // overwrites the other. @@ -1313,8 +1365,9 @@ type S3DestinationConfiguration struct { 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) - // in the Amazon CloudWatch Events User Guide. + // see [Schedule Expressions for Rules]in the Amazon CloudWatch Events User Guide. + // + // [Schedule Expressions for Rules]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html Expression *string noSmithyDocumentSerde @@ -1323,8 +1376,10 @@ type Schedule struct { // Information needed to define a schema. type SchemaDefinition struct { - // Specifies one or more columns that store your data. Each schema can have up to - // 100 columns. Each column can have up to 100 nested types. + // Specifies one or more columns that store your data. + // + // Each schema can have up to 100 columns. Each column can have up to 100 nested + // types. Columns []Column noSmithyDocumentSerde @@ -1405,12 +1460,12 @@ type Tag struct { // A partition dimension defined by a timestamp attribute. type TimestampPartition struct { - // The attribute name of the partition defined by a timestamp. + // The attribute name of the partition defined by a timestamp. // // This member is required. AttributeName *string - // The timestamp format of a partition defined by a timestamp. The default format + // The timestamp format of a partition defined by a timestamp. The default format // is seconds since epoch (January 1, 1970 at midnight UTC time). TimestampFormat *string diff --git a/service/iotdataplane/api_op_DeleteThingShadow.go b/service/iotdataplane/api_op_DeleteThingShadow.go index ac7dab844be..d6bc2f96505 100644 --- a/service/iotdataplane/api_op_DeleteThingShadow.go +++ b/service/iotdataplane/api_op_DeleteThingShadow.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IoT Developer Guide. +// Deletes the shadow for the specified thing. +// +// Requires permission to access the [DeleteThingShadow] action. +// +// For more information, see [DeleteThingShadow] in the IoT Developer Guide. +// +// [DeleteThingShadow]: http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html func (c *Client) DeleteThingShadow(ctx context.Context, params *DeleteThingShadowInput, optFns ...func(*Options)) (*DeleteThingShadowOutput, error) { if params == nil { params = &DeleteThingShadowInput{} diff --git a/service/iotdataplane/api_op_GetRetainedMessage.go b/service/iotdataplane/api_op_GetRetainedMessage.go index 51ca798a95f..110cbf94d84 100644 --- a/service/iotdataplane/api_op_GetRetainedMessage.go +++ b/service/iotdataplane/api_op_GetRetainedMessage.go @@ -10,13 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 (https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html) -// . 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) . +// 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] action. +// +// For more information about messaging costs, see [Amazon Web Services IoT Core pricing - Messaging]. +// +// [GetRetainedMessage]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions +// [Amazon Web Services IoT Core pricing - Messaging]: http://aws.amazon.com/iot-core/pricing/#Messaging +// [ListRetainedMessages]: https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html func (c *Client) GetRetainedMessage(ctx context.Context, params *GetRetainedMessageInput, optFns ...func(*Options)) (*GetRetainedMessageOutput, error) { if params == nil { params = &GetRetainedMessageInput{} @@ -60,10 +66,12 @@ type GetRetainedMessageOutput struct { Topic *string // A base64-encoded JSON string that includes an array of JSON objects, or null if - // the retained message doesn't include any user properties. The following example - // userProperties parameter is a JSON string that represents two user properties. - // Note that it will be base64-encoded: [{"deviceName": "alpha"}, {"deviceCnt": - // "45"}] + // the retained message doesn't include any user properties. + // + // The following example userProperties parameter is a JSON string that represents + // two user properties. Note that it will be base64-encoded: + // + // [{"deviceName": "alpha"}, {"deviceCnt": "45"}] UserProperties []byte // Metadata pertaining to the operation's result. diff --git a/service/iotdataplane/api_op_GetThingShadow.go b/service/iotdataplane/api_op_GetThingShadow.go index 767c7dc78b1..9feb72f8eb3 100644 --- a/service/iotdataplane/api_op_GetThingShadow.go +++ b/service/iotdataplane/api_op_GetThingShadow.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IoT Developer Guide. +// Gets the shadow for the specified thing. +// +// Requires permission to access the [GetThingShadow] action. +// +// For more information, see [GetThingShadow] in the IoT Developer Guide. +// +// [GetThingShadow]: http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html func (c *Client) GetThingShadow(ctx context.Context, params *GetThingShadowInput, optFns ...func(*Options)) (*GetThingShadowOutput, error) { if params == nil { params = &GetThingShadowInput{} diff --git a/service/iotdataplane/api_op_ListNamedShadowsForThing.go b/service/iotdataplane/api_op_ListNamedShadowsForThing.go index 2bba45f4f89..68eb9054ada 100644 --- a/service/iotdataplane/api_op_ListNamedShadowsForThing.go +++ b/service/iotdataplane/api_op_ListNamedShadowsForThing.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the shadows for the specified thing. +// +// Requires permission to access the [ListNamedShadowsForThing] action. +// +// [ListNamedShadowsForThing]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListNamedShadowsForThing(ctx context.Context, params *ListNamedShadowsForThingInput, optFns ...func(*Options)) (*ListNamedShadowsForThingOutput, error) { if params == nil { params = &ListNamedShadowsForThingInput{} diff --git a/service/iotdataplane/api_op_ListRetainedMessages.go b/service/iotdataplane/api_op_ListRetainedMessages.go index ae8cd64b083..28baee87892 100644 --- a/service/iotdataplane/api_op_ListRetainedMessages.go +++ b/service/iotdataplane/api_op_ListRetainedMessages.go @@ -12,14 +12,21 @@ import ( ) // Lists summary information about the retained messages stored for the account. +// // 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/apireference/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) -// action. For more information about messaging costs, see Amazon Web Services IoT -// Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging) . +// payload, it can still incur messaging costs. +// +// To get the message payload of a retained message, call [GetRetainedMessage] with the topic name of +// the retained message. +// +// Requires permission to access the [ListRetainedMessages] action. +// +// For more information about messaging costs, see [Amazon Web Services IoT Core pricing - Messaging]. +// +// [GetRetainedMessage]: https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html +// [Amazon Web Services IoT Core pricing - Messaging]: http://aws.amazon.com/iot-core/pricing/#Messaging +// [ListRetainedMessages]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions func (c *Client) ListRetainedMessages(ctx context.Context, params *ListRetainedMessagesInput, optFns ...func(*Options)) (*ListRetainedMessagesOutput, error) { if params == nil { params = &ListRetainedMessagesInput{} diff --git a/service/iotdataplane/api_op_Publish.go b/service/iotdataplane/api_op_Publish.go index 0a0dc77f415..8e72f8004af 100644 --- a/service/iotdataplane/api_op_Publish.go +++ b/service/iotdataplane/api_op_Publish.go @@ -11,11 +11,17 @@ 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] action. +// +// For more information about MQTT messages, see [MQTT Protocol] in the IoT Developer Guide. +// +// For more information about messaging costs, see [Amazon Web Services IoT Core pricing - Messaging]. +// +// [MQTT Protocol]: http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html +// [Amazon Web Services IoT Core pricing - Messaging]: http://aws.amazon.com/iot-core/pricing/#Messaging +// [Publish]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...func(*Options)) (*PublishOutput, error) { if params == nil { params = &PublishInput{} @@ -49,12 +55,13 @@ 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) - // from the Amazon Web Services Reference Guide. + // limits of messageExpiry , see [Amazon Web Services IoT Core message broker and protocol limits and quotas] from the Amazon Web Services Reference Guide. + // + // [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 MessageExpiry int64 // The message body. MQTT accepts text, binary, and empty (null) message payloads. + // // Publishing an empty (null) payload with retain = true deletes the retained // message identified by topic from Amazon Web Services IoT Core. Payload []byte @@ -73,16 +80,24 @@ type PublishInput struct { ResponseTopic *string // A Boolean value that determines whether to set the RETAIN flag when the message - // is published. Setting the RETAIN flag causes the message to be retained and sent - // to new subscribers to the topic. Valid values: true | false Default value: false + // is published. + // + // Setting the RETAIN flag causes the message to be retained and sent to new + // subscribers to the topic. + // + // Valid values: true | false + // + // Default value: false Retain bool // 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 + // 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"}] + // + // [{"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 990f729eb84..93ecc8db889 100644 --- a/service/iotdataplane/api_op_UpdateThingShadow.go +++ b/service/iotdataplane/api_op_UpdateThingShadow.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IoT Developer Guide. +// Updates the shadow for the specified thing. +// +// Requires permission to access the [UpdateThingShadow] action. +// +// For more information, see [UpdateThingShadow] in the IoT Developer Guide. +// +// [UpdateThingShadow]: http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html func (c *Client) UpdateThingShadow(ctx context.Context, params *UpdateThingShadowInput, optFns ...func(*Options)) (*UpdateThingShadowOutput, error) { if params == nil { params = &UpdateThingShadowInput{} diff --git a/service/iotdataplane/doc.go b/service/iotdataplane/doc.go index fd43f2e6a4f..06d2dac011e 100644 --- a/service/iotdataplane/doc.go +++ b/service/iotdataplane/doc.go @@ -3,14 +3,20 @@ // Package iotdataplane provides the API client, operations, and parameter types // for AWS IoT Data Plane. // -// IoT data IoT data enables secure, bi-directional communication between +// # IoT data +// +// IoT data enables secure, bi-directional communication between // Internet-connected things (such as sensors, actuators, embedded devices, or // smart appliances) and the Amazon Web Services cloud. It implements a broker for // applications and things to publish messages over HTTP (Publish) and retrieve, // update, and delete shadows. A shadow is a persistent representation of your -// 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. +// 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] to sign requests is: iotdevicegateway. +// +// [Amazon Web ServicesSignature Version 4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html package iotdataplane diff --git a/service/iotdataplane/options.go b/service/iotdataplane/options.go index 8e802fe6d09..ee4c10131bf 100644 --- a/service/iotdataplane/options.go +++ b/service/iotdataplane/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotdataplane/types/enums.go b/service/iotdataplane/types/enums.go index 58e515fcf96..5d444ad0946 100644 --- a/service/iotdataplane/types/enums.go +++ b/service/iotdataplane/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for PayloadFormatIndicator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PayloadFormatIndicator) Values() []PayloadFormatIndicator { return []PayloadFormatIndicator{ "UNSPECIFIED_BYTES", diff --git a/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go b/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go index 99289debe2f..48ed93b1d99 100644 --- a/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_CreateSuiteDefinition.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Creates a Device Advisor test suite. +// +// Requires permission to access the [CreateSuiteDefinition] action. +// +// [CreateSuiteDefinition]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CreateSuiteDefinition(ctx context.Context, params *CreateSuiteDefinitionInput, optFns ...func(*Options)) (*CreateSuiteDefinitionOutput, error) { if params == nil { params = &CreateSuiteDefinitionInput{} diff --git a/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go b/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go index da380e4b33f..766cfd31ec8 100644 --- a/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_DeleteSuiteDefinition.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Deletes a Device Advisor test suite. +// +// Requires permission to access the [DeleteSuiteDefinition] action. +// +// [DeleteSuiteDefinition]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DeleteSuiteDefinition(ctx context.Context, params *DeleteSuiteDefinitionInput, optFns ...func(*Options)) (*DeleteSuiteDefinitionOutput, error) { if params == nil { params = &DeleteSuiteDefinitionInput{} diff --git a/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go b/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go index fb3b6bf86db..6d0710fe652 100644 --- a/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_GetSuiteDefinition.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about a Device Advisor test suite. +// +// Requires permission to access the [GetSuiteDefinition] action. +// +// [GetSuiteDefinition]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetSuiteDefinition(ctx context.Context, params *GetSuiteDefinitionInput, optFns ...func(*Options)) (*GetSuiteDefinitionOutput, error) { if params == nil { params = &GetSuiteDefinitionInput{} diff --git a/service/iotdeviceadvisor/api_op_GetSuiteRun.go b/service/iotdeviceadvisor/api_op_GetSuiteRun.go index 1080d4edcd5..fdc24874c19 100644 --- a/service/iotdeviceadvisor/api_op_GetSuiteRun.go +++ b/service/iotdeviceadvisor/api_op_GetSuiteRun.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Gets information about a Device Advisor test suite run. +// +// Requires permission to access the [GetSuiteRun] action. +// +// [GetSuiteRun]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetSuiteRun(ctx context.Context, params *GetSuiteRunInput, optFns ...func(*Options)) (*GetSuiteRunOutput, error) { if params == nil { params = &GetSuiteRunInput{} diff --git a/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go b/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go index 18ebaae96c8..5f3dc700eb5 100644 --- a/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go +++ b/service/iotdeviceadvisor/api_op_GetSuiteRunReport.go @@ -11,8 +11,11 @@ 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) -// action. +// suite run. +// +// Requires permission to access the [GetSuiteRunReport] action. +// +// [GetSuiteRunReport]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) GetSuiteRunReport(ctx context.Context, params *GetSuiteRunReportInput, optFns ...func(*Options)) (*GetSuiteRunReportOutput, error) { if params == nil { params = &GetSuiteRunReportInput{} diff --git a/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go b/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go index 38cbcf6a6de..69964818b8c 100644 --- a/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go +++ b/service/iotdeviceadvisor/api_op_ListSuiteDefinitions.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the Device Advisor test suites you have created. +// +// Requires permission to access the [ListSuiteDefinitions] action. +// +// [ListSuiteDefinitions]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListSuiteDefinitions(ctx context.Context, params *ListSuiteDefinitionsInput, optFns ...func(*Options)) (*ListSuiteDefinitionsOutput, error) { if params == nil { params = &ListSuiteDefinitionsInput{} diff --git a/service/iotdeviceadvisor/api_op_ListSuiteRuns.go b/service/iotdeviceadvisor/api_op_ListSuiteRuns.go index a468693c33c..29c6c057201 100644 --- a/service/iotdeviceadvisor/api_op_ListSuiteRuns.go +++ b/service/iotdeviceadvisor/api_op_ListSuiteRuns.go @@ -12,9 +12,11 @@ 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) -// action. +// the test suite, or the runs of a specific version of the test suite. +// +// Requires permission to access the [ListSuiteRuns] action. +// +// [ListSuiteRuns]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListSuiteRuns(ctx context.Context, params *ListSuiteRunsInput, optFns ...func(*Options)) (*ListSuiteRunsOutput, error) { if params == nil { params = &ListSuiteRunsInput{} diff --git a/service/iotdeviceadvisor/api_op_ListTagsForResource.go b/service/iotdeviceadvisor/api_op_ListTagsForResource.go index 9162df5f6d3..527328e6ecc 100644 --- a/service/iotdeviceadvisor/api_op_ListTagsForResource.go +++ b/service/iotdeviceadvisor/api_op_ListTagsForResource.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Lists the tags attached to an IoT Device Advisor resource. +// +// Requires permission to access the [ListTagsForResource] action. +// +// [ListTagsForResource]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/iotdeviceadvisor/api_op_StartSuiteRun.go b/service/iotdeviceadvisor/api_op_StartSuiteRun.go index d8a99c9f248..b4e0f635c29 100644 --- a/service/iotdeviceadvisor/api_op_StartSuiteRun.go +++ b/service/iotdeviceadvisor/api_op_StartSuiteRun.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Starts a Device Advisor test suite run. +// +// Requires permission to access the [StartSuiteRun] action. +// +// [StartSuiteRun]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StartSuiteRun(ctx context.Context, params *StartSuiteRunInput, optFns ...func(*Options)) (*StartSuiteRunOutput, error) { if params == nil { params = &StartSuiteRunInput{} diff --git a/service/iotdeviceadvisor/api_op_StopSuiteRun.go b/service/iotdeviceadvisor/api_op_StopSuiteRun.go index 6a0e47a1a2c..359b543755c 100644 --- a/service/iotdeviceadvisor/api_op_StopSuiteRun.go +++ b/service/iotdeviceadvisor/api_op_StopSuiteRun.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Stops a Device Advisor test suite run that is currently running. +// +// Requires permission to access the [StopSuiteRun] action. +// +// [StopSuiteRun]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) StopSuiteRun(ctx context.Context, params *StopSuiteRunInput, optFns ...func(*Options)) (*StopSuiteRunOutput, error) { if params == nil { params = &StopSuiteRunInput{} diff --git a/service/iotdeviceadvisor/api_op_TagResource.go b/service/iotdeviceadvisor/api_op_TagResource.go index 638c22e22a9..f31a2d3539b 100644 --- a/service/iotdeviceadvisor/api_op_TagResource.go +++ b/service/iotdeviceadvisor/api_op_TagResource.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Adds to and modifies existing tags of an IoT Device Advisor resource. +// +// Requires permission to access the [TagResource] action. +// +// [TagResource]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/iotdeviceadvisor/api_op_UntagResource.go b/service/iotdeviceadvisor/api_op_UntagResource.go index 74d30a7eb13..710cb731f53 100644 --- a/service/iotdeviceadvisor/api_op_UntagResource.go +++ b/service/iotdeviceadvisor/api_op_UntagResource.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Removes tags from an IoT Device Advisor resource. +// +// Requires permission to access the [UntagResource] action. +// +// [UntagResource]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go b/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go index 3e0d7511cce..e3de71b6deb 100644 --- a/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go +++ b/service/iotdeviceadvisor/api_op_UpdateSuiteDefinition.go @@ -12,9 +12,11 @@ import ( "time" ) -// 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) -// action. +// Updates a Device Advisor test suite. +// +// Requires permission to access the [UpdateSuiteDefinition] action. +// +// [UpdateSuiteDefinition]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) UpdateSuiteDefinition(ctx context.Context, params *UpdateSuiteDefinitionInput, optFns ...func(*Options)) (*UpdateSuiteDefinitionOutput, error) { if params == nil { params = &UpdateSuiteDefinitionInput{} diff --git a/service/iotdeviceadvisor/options.go b/service/iotdeviceadvisor/options.go index caba27c91ba..e0e131cfc25 100644 --- a/service/iotdeviceadvisor/options.go +++ b/service/iotdeviceadvisor/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotdeviceadvisor/types/enums.go b/service/iotdeviceadvisor/types/enums.go index d2f97b90d58..b485809e6c2 100644 --- a/service/iotdeviceadvisor/types/enums.go +++ b/service/iotdeviceadvisor/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AuthenticationMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationMethod) Values() []AuthenticationMethod { return []AuthenticationMethod{ "X509ClientCertificate", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "MqttV3_1_1", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "PASS", @@ -90,8 +93,9 @@ const ( ) // Values returns all known values for SuiteRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SuiteRunStatus) Values() []SuiteRunStatus { return []SuiteRunStatus{ "PASS", @@ -122,8 +126,9 @@ const ( ) // Values returns all known values for TestCaseScenarioStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestCaseScenarioStatus) Values() []TestCaseScenarioStatus { return []TestCaseScenarioStatus{ "PASS", @@ -147,8 +152,9 @@ const ( ) // Values returns all known values for TestCaseScenarioType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestCaseScenarioType) Values() []TestCaseScenarioType { return []TestCaseScenarioType{ "Advanced", diff --git a/service/iotdeviceadvisor/types/types.go b/service/iotdeviceadvisor/types/types.go index 61f6e31fd0d..048d78b42dd 100644 --- a/service/iotdeviceadvisor/types/types.go +++ b/service/iotdeviceadvisor/types/types.go @@ -51,9 +51,10 @@ type SuiteDefinitionConfiguration struct { // true, rootGroup can be an empty string. If intendedForQualification is false, // rootGroup cannot be an empty string. If rootGroup is empty, and // intendedForQualification is set to true, all the qualification tests are - // included, and the configuration is default. For a qualification suite, the - // minimum length is 0, and the maximum is 2048. For a non-qualification suite, the - // minimum length is 1, and the maximum is 2048. + // included, and the configuration is default. + // + // For a qualification suite, the minimum length is 0, and the maximum is 2048. + // For a non-qualification suite, the minimum length is 1, and the maximum is 2048. // // This member is required. RootGroup *string @@ -123,9 +124,11 @@ type SuiteRunConfiguration struct { noSmithyDocumentSerde } -// 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) -// action. +// Information about the suite run. +// +// Requires permission to access the [SuiteRunInformation] action. +// +// [SuiteRunInformation]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions type SuiteRunInformation struct { // Date (in Unix epoch time) when the suite run was created. @@ -177,15 +180,23 @@ 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. Status Status @@ -198,7 +209,7 @@ type TestCaseRun struct { // Provides the test case run ID. TestCaseRunId *string - // Provides the test scenarios for the test case run. + // Provides the test scenarios for the test case run. TestScenarios []TestCaseScenario // Provides test case run warnings. @@ -214,15 +225,23 @@ 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. Status TestCaseScenarioStatus @@ -233,7 +252,9 @@ type TestCaseScenario struct { TestCaseScenarioId *string // Provides test case scenario type. Type is one of the following: + // // - Advanced + // // - Basic TestCaseScenarioType TestCaseScenarioType diff --git a/service/iotevents/api_op_CreateAlarmModel.go b/service/iotevents/api_op_CreateAlarmModel.go index 518b84c0568..71594ada4a9 100644 --- a/service/iotevents/api_op_CreateAlarmModel.go +++ b/service/iotevents/api_op_CreateAlarmModel.go @@ -14,8 +14,9 @@ import ( // 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. +// more information, see [Create an alarm model]in the AWS IoT Events Developer Guide. +// +// [Create an alarm model]: https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html func (c *Client) CreateAlarmModel(ctx context.Context, params *CreateAlarmModelInput, optFns ...func(*Options)) (*CreateAlarmModelOutput, error) { if params == nil { params = &CreateAlarmModelInput{} @@ -45,8 +46,9 @@ 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)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. RoleArn *string @@ -63,19 +65,22 @@ type CreateAlarmModelInput struct { // Contains information about one or more notification actions. 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) + // An input attribute used as a key to create an alarm. AWS IoT Events routes [inputs] // associated with this key to the alarm. + // + // [inputs]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html Key *string // A non-negative integer that reflects the severity level of the alarm. Severity *int32 // 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) - // in the AWS IoT Events Developer Guide. You can create up to 50 tags for one - // alarm model. + // help you manage the alarm model. For more information, see [Tagging your AWS IoT Events resources]in the AWS IoT + // Events Developer Guide. + // + // You can create up to 50 tags for one alarm model. + // + // [Tagging your AWS IoT Events resources]: https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html Tags []types.Tag noSmithyDocumentSerde @@ -83,9 +88,10 @@ 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. + // The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)] in the AWS General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AlarmModelArn *string // The version of the alarm model. @@ -98,11 +104,15 @@ 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. Status types.AlarmModelVersionStatus diff --git a/service/iotevents/api_op_DescribeAlarmModel.go b/service/iotevents/api_op_DescribeAlarmModel.go index a16294e2c01..c72accb81f9 100644 --- a/service/iotevents/api_op_DescribeAlarmModel.go +++ b/service/iotevents/api_op_DescribeAlarmModel.go @@ -50,9 +50,10 @@ type DescribeAlarmModelOutput struct { // Contains information about one or more alarm actions. 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. + // The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)] in the AWS General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AlarmModelArn *string // The description of the alarm model. @@ -73,33 +74,39 @@ type DescribeAlarmModelOutput struct { // The time the alarm model was created, in the Unix epoch format. 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) + // An input attribute used as a key to create an alarm. AWS IoT Events routes [inputs] // associated with this key to the alarm. + // + // [inputs]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html Key *string // The time the alarm model was last updated, in the Unix epoch format. 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)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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. Status types.AlarmModelVersionStatus - // Contains information about the status of the alarm model. + // Contains information about the status of the alarm model. StatusMessage *string // Metadata pertaining to the operation's result. diff --git a/service/iotevents/api_op_DescribeDetectorModelAnalysis.go b/service/iotevents/api_op_DescribeDetectorModelAnalysis.go index b8628892a81..56b0a1b4967 100644 --- a/service/iotevents/api_op_DescribeDetectorModelAnalysis.go +++ b/service/iotevents/api_op_DescribeDetectorModelAnalysis.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves runtime information about a detector model analysis. After AWS IoT -// Events starts analyzing your detector model, you have up to 24 hours to retrieve -// the analysis results. +// Retrieves runtime information about a detector model analysis. +// +// After AWS IoT Events starts analyzing your detector model, you have up to 24 +// hours to retrieve the analysis results. func (c *Client) DescribeDetectorModelAnalysis(ctx context.Context, params *DescribeDetectorModelAnalysisInput, optFns ...func(*Options)) (*DescribeDetectorModelAnalysisOutput, error) { if params == nil { params = &DescribeDetectorModelAnalysisInput{} @@ -43,9 +44,12 @@ 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. Status types.AnalysisStatus diff --git a/service/iotevents/api_op_GetDetectorModelAnalysisResults.go b/service/iotevents/api_op_GetDetectorModelAnalysisResults.go index 026803b8355..8e66b49a69f 100644 --- a/service/iotevents/api_op_GetDetectorModelAnalysisResults.go +++ b/service/iotevents/api_op_GetDetectorModelAnalysisResults.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves one or more analysis results of the detector model. After AWS IoT -// Events starts analyzing your detector model, you have up to 24 hours to retrieve -// the analysis results. +// Retrieves one or more analysis results of the detector model. +// +// After AWS IoT Events starts analyzing your detector model, you have up to 24 +// hours to retrieve the analysis results. func (c *Client) GetDetectorModelAnalysisResults(ctx context.Context, params *GetDetectorModelAnalysisResultsInput, optFns ...func(*Options)) (*GetDetectorModelAnalysisResultsOutput, error) { if params == nil { params = &GetDetectorModelAnalysisResultsInput{} diff --git a/service/iotevents/api_op_ListInputRoutings.go b/service/iotevents/api_op_ListInputRoutings.go index 8b398f2c8b5..3463b5b2fd4 100644 --- a/service/iotevents/api_op_ListInputRoutings.go +++ b/service/iotevents/api_op_ListInputRoutings.go @@ -29,15 +29,15 @@ func (c *Client) ListInputRoutings(ctx context.Context, params *ListInputRouting type ListInputRoutingsInput struct { - // The identifer of the routed input. + // The identifer of the routed input. // // This member is required. InputIdentifier *types.InputIdentifier - // The maximum number of results to be returned per request. + // The maximum number of results to be returned per request. MaxResults *int32 - // The token that you can use to return the next set of results. + // The token that you can use to return the next set of results. NextToken *string noSmithyDocumentSerde @@ -45,11 +45,11 @@ type ListInputRoutingsInput struct { type ListInputRoutingsOutput struct { - // The token that you can use to return the next set of results, or null if there + // The token that you can use to return the next set of results, or null if there // are no more results. NextToken *string - // Summary information about the routed resources. + // Summary information about the routed resources. RoutedResources []types.RoutedResource // Metadata pertaining to the operation's result. diff --git a/service/iotevents/api_op_PutLoggingOptions.go b/service/iotevents/api_op_PutLoggingOptions.go index 88e1756ce79..64f6df5a078 100644 --- a/service/iotevents/api_op_PutLoggingOptions.go +++ b/service/iotevents/api_op_PutLoggingOptions.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets or updates the AWS IoT Events logging options. If you update the value of -// any loggingOptions field, it takes up to one minute for the change to take -// effect. If you change the policy attached to the role you specified in the -// roleArn field (for example, to correct an invalid policy), it takes up to five -// minutes for that change to take effect. +// Sets or updates the AWS IoT Events logging options. +// +// If you update the value of any loggingOptions field, it takes up to one minute +// for the change to take effect. If you change the policy attached to the role you +// specified in the roleArn field (for example, to correct an invalid policy), it +// takes up to five minutes for that change to take effect. func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error) { if params == nil { params = &PutLoggingOptionsInput{} diff --git a/service/iotevents/api_op_StartDetectorModelAnalysis.go b/service/iotevents/api_op_StartDetectorModelAnalysis.go index cf19215c8de..14d60200022 100644 --- a/service/iotevents/api_op_StartDetectorModelAnalysis.go +++ b/service/iotevents/api_op_StartDetectorModelAnalysis.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the AWS IoT Events Developer Guide. +// Performs an analysis of your detector model. For more information, see [Troubleshooting a detector model] in the +// AWS IoT Events Developer Guide. +// +// [Troubleshooting a detector model]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html func (c *Client) StartDetectorModelAnalysis(ctx context.Context, params *StartDetectorModelAnalysisInput, optFns ...func(*Options)) (*StartDetectorModelAnalysisOutput, error) { if params == nil { params = &StartDetectorModelAnalysisInput{} diff --git a/service/iotevents/api_op_UpdateAlarmModel.go b/service/iotevents/api_op_UpdateAlarmModel.go index 81eb853c7b4..130f5b9d505 100644 --- a/service/iotevents/api_op_UpdateAlarmModel.go +++ b/service/iotevents/api_op_UpdateAlarmModel.go @@ -42,8 +42,9 @@ 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)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. RoleArn *string @@ -68,9 +69,10 @@ 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. + // The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)] in the AWS General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AlarmModelArn *string // The version of the alarm model. @@ -83,11 +85,15 @@ 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. Status types.AlarmModelVersionStatus diff --git a/service/iotevents/options.go b/service/iotevents/options.go index 27666fc52a3..6bbfdd7431d 100644 --- a/service/iotevents/options.go +++ b/service/iotevents/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotevents/types/enums.go b/service/iotevents/types/enums.go index 8768dcca95c..1c8962ce785 100644 --- a/service/iotevents/types/enums.go +++ b/service/iotevents/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AlarmModelVersionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlarmModelVersionStatus) Values() []AlarmModelVersionStatus { return []AlarmModelVersionStatus{ "ACTIVE", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for AnalysisResultLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisResultLevel) Values() []AnalysisResultLevel { return []AnalysisResultLevel{ "INFO", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for AnalysisStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisStatus) Values() []AnalysisStatus { return []AnalysisStatus{ "RUNNING", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GREATER", @@ -105,6 +109,7 @@ const ( // Values returns all known values for DetectorModelVersionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DetectorModelVersionStatus) Values() []DetectorModelVersionStatus { return []DetectorModelVersionStatus{ @@ -127,8 +132,9 @@ const ( ) // Values returns all known values for EvaluationMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationMethod) Values() []EvaluationMethod { return []EvaluationMethod{ "BATCH", @@ -147,8 +153,9 @@ const ( ) // Values returns all known values for InputStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputStatus) Values() []InputStatus { return []InputStatus{ "CREATING", @@ -168,8 +175,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -187,8 +195,9 @@ const ( ) // Values returns all known values for PayloadType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PayloadType) Values() []PayloadType { return []PayloadType{ "STRING", diff --git a/service/iotevents/types/types.go b/service/iotevents/types/types.go index 5297324f097..d98c4f587b3 100644 --- a/service/iotevents/types/types.go +++ b/service/iotevents/types/types.go @@ -30,20 +30,24 @@ 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) - // in AWS IoT Events Developer Guide. + // model instance and the event that triggered the action. You can customize the [payload]. + // One column of the DynamoDB table receives all attribute-value pairs in the + // payload that you specify. For more information, see [Actions]in AWS IoT Events Developer + // Guide. + // + // [payload]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html + // [Actions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html 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) - // in AWS IoT Events Developer Guide. + // model instance and the event that triggered the action. You can customize the [payload]. + // A separate column of the DynamoDB table receives one attribute-value pair in the + // payload that you specify. For more information, see [Actions]in AWS IoT Events Developer + // Guide. + // + // [payload]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html + // [Actions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html DynamoDBv2 *DynamoDBv2Action // Sends information about the detector model instance and the event that @@ -90,61 +94,94 @@ 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 - // payload that you specify. You must use expressions for all parameters in - // DynamoDBAction . The expressions accept literals, operators, functions, - // references, and substitution templates. Examples + // instance and the event that triggered the action. You can customize the [payload]. 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, 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' + // 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 . + // 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] 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 . + // + // [payload]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html + // [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html 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, - // references, and substitution templates. Examples + // instance and the event that triggered the action. You can customize the [payload]. 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\": + // 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 . + // 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] in the AWS IoT Events Developer Guide. + // + // The value for the type parameter in Payload must be JSON . + // + // [payload]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html + // [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html DynamoDBv2 *DynamoDBv2Action // Sends information about the detector model instance and the event that @@ -156,27 +193,38 @@ type AlarmAction struct { 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 - // literals, operators, functions, references, and substitutions templates. + // 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 + // 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/ + // + // '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. + // identify the target asset property in AWS IoT SiteWise. + // + // For more information, see [Expressions] in the AWS IoT Events Developer Guide. + // + // [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html IotSiteWise *IotSiteWiseAction // Information required to publish the MQTT message through the AWS IoT message @@ -238,9 +286,10 @@ type AlarmModelSummary struct { // Contains a summary of an alarm model version. 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. + // The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)] in the AWS General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AlarmModelArn *string // The name of the alarm model. @@ -256,21 +305,26 @@ 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)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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. Status AlarmModelVersionStatus - // Contains information about the status of the alarm model version. + // Contains information about the status of the alarm model version. StatusMessage *string noSmithyDocumentSerde @@ -301,12 +355,15 @@ 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. Level AnalysisResultLevel @@ -320,20 +377,29 @@ type AnalysisResult struct { // 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. + // + // For more information, see [Running detector model analyses] in the AWS IoT Events Developer Guide. + // + // [Running detector model analyses]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html Type *string noSmithyDocumentSerde @@ -343,31 +409,43 @@ type AnalysisResult struct { // model that the analysis result references. type AnalysisResultLocation struct { - // A JsonPath (https://github.com/json-path/JsonPath) expression that identifies - // the error field in your detector model. + // A [JsonPath] expression that identifies the error field in your detector model. + // + // [JsonPath]: https://github.com/json-path/JsonPath Path *string noSmithyDocumentSerde } -// A structure that contains timestamp information. For more information, see -// 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, -// operators, functions, references, and substitution templates. Examples +// A structure that contains timestamp information. For more information, see [TimeInNanos] in +// the AWS IoT SiteWise API Reference. +// +// You must use expressions for all 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}' +// literals, operators, functions, references, and substitution templates. +// +// In the following example, the value for the timeInSeconds parameter uses a +// +// substitution template. // -// For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) -// in the AWS IoT Events Developer Guide. +// '${$input.TemperatureInput.sensorData.timestamp / 1000}' +// +// For more information, see [Expressions] in the AWS IoT Events Developer Guide. +// +// [TimeInNanos]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html +// [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html type AssetPropertyTimestamp struct { // The timestamp, in seconds, in the Unix epoch format. The valid range is between @@ -383,19 +461,26 @@ type AssetPropertyTimestamp struct { noSmithyDocumentSerde } -// A structure that contains value information. For more information, see -// 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, -// functions, references, and substitution templates. Examples +// A structure that contains value information. For more information, see [AssetPropertyValue] in the +// AWS IoT SiteWise API Reference. +// +// You must use expressions for all 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 more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) -// in the AWS IoT Events Developer Guide. +// For more information, see [Expressions] in the AWS IoT Events Developer Guide. +// +// [AssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html +// [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html type AssetPropertyValue struct { // The quality of the asset property value. The value must be 'GOOD' , 'BAD' , or @@ -412,26 +497,40 @@ type AssetPropertyValue struct { noSmithyDocumentSerde } -// 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) -// in the AWS IoT SiteWise API Reference. You must use expressions for all -// parameters in AssetPropertyVariant . The expressions accept literals, operators, -// functions, references, and substitution templates. Examples +// A structure that contains an asset property value. For more information, see [Variant] +// in the AWS IoT SiteWise API Reference. +// +// You must use expressions for all 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 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) -// in the AWS IoT SiteWise API Reference. +// 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] 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]in the AWS IoT SiteWise +// API Reference. +// +// [Variant]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html +// [AssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html +// [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html type AssetPropertyVariant struct { // The asset property value is a Boolean value that must be 'TRUE' or 'FALSE' . You @@ -465,7 +564,9 @@ type Attribute struct { // 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: .... + // by detectors. + // + // Syntax: .... // // This member is required. JsonPath *string @@ -537,10 +638,12 @@ type DetectorModelConfiguration struct { // The value used to identify a detector instance. When a device or system sends // input, a new detector instance with a unique key value is created. AWS IoT // Events can continue to route input to its corresponding detector instance based - // on this identifying information. This parameter uses a JSON-path expression to - // select the attribute-value pair in the message payload that is used for - // identification. To route the message to the correct detector instance, the - // device must send a message payload that contains the same attribute-value. + // on this identifying information. + // + // This parameter uses a JSON-path expression to select the attribute-value pair + // in the message payload that is used for identification. To route the message to + // the correct detector instance, the device must send a message payload that + // contains the same attribute-value. Key *string // The time the detector model was last updated. @@ -621,33 +724,50 @@ 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 -// payload that you specify. You must use expressions for all parameters in -// DynamoDBAction . The expressions accept literals, operators, functions, -// references, and substitution templates. Examples +// instance and the event that triggered the action. You can customize the [payload]. 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, 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' +// 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 . +// 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] 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 . +// +// [payload]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html +// [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html type DynamoDBAction struct { // The name of the hash key (also called the partition key). The hashKeyField @@ -669,34 +789,43 @@ type DynamoDBAction struct { // 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' . 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. 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 . + // 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 *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 . + // 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 . PayloadField *string // The name of the range key (also called the sort key). The rangeKeyField value @@ -705,8 +834,11 @@ 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' . RangeKeyType *string @@ -718,32 +850,51 @@ 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, -// references, and substitution templates. Examples +// instance and the event that triggered the action. You can customize the [payload]. 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 +// 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 // -// 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 . +// concatenation. +// +// 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date +// +// For more information, see [Expressions] in the AWS IoT Events Developer Guide. +// +// The value for the type parameter in Payload must be JSON . +// +// [payload]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html +// [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html type DynamoDBv2Action struct { // The name of the DynamoDB table. @@ -751,11 +902,12 @@ type DynamoDBv2Action struct { // This member is required. TableName *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 . + // 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 *Payload noSmithyDocumentSerde @@ -764,17 +916,21 @@ type DynamoDBv2Action struct { // Contains the configuration information of email notifications. 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) - // . + // 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]. + // + // [verify the email address that 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) - // . + // 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]. + // + // [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 @@ -797,9 +953,11 @@ type EmailContent struct { noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [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. @@ -925,10 +1083,10 @@ type InputDefinition struct { // The identifer of the input. type InputIdentifier struct { - // The identifier of the input routed to AWS IoT Events. + // The identifier of the input routed to AWS IoT Events. IotEventsInputIdentifier *IotEventsInputIdentifier - // The identifer of the input routed from AWS IoT SiteWise. + // The identifer of the input routed from AWS IoT SiteWise. IotSiteWiseInputIdentifier *IotSiteWiseInputIdentifier noSmithyDocumentSerde @@ -977,7 +1135,7 @@ type IotEventsAction struct { // The identifier of the input routed to AWS IoT Events. type IotEventsInputIdentifier struct { - // The name of the input routed to AWS IoT Events. + // The name of the input routed to AWS IoT Events. // // This member is required. InputName *string @@ -986,28 +1144,40 @@ type IotEventsInputIdentifier struct { } // 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. +// 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' +// 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. +// identify the target asset property in AWS IoT SiteWise. +// +// For more information, see [Expressions] in the AWS IoT Events Developer Guide. +// +// [Expressions]: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html type IotSiteWiseAction struct { // The ID of the asset that has the specified property. @@ -1034,12 +1204,12 @@ type IotSiteWiseAction struct { // The asset model property identifer of the input routed from AWS IoT SiteWise. type IotSiteWiseAssetModelPropertyIdentifier struct { - // The ID of the AWS IoT SiteWise asset model. + // The ID of the AWS IoT SiteWise asset model. // // This member is required. AssetModelId *string - // The ID of the AWS IoT SiteWise asset property. + // The ID of the AWS IoT SiteWise asset property. // // This member is required. PropertyId *string @@ -1050,7 +1220,7 @@ type IotSiteWiseAssetModelPropertyIdentifier struct { // The identifer of the input routed from AWS IoT SiteWise. type IotSiteWiseInputIdentifier struct { - // The identifier of the AWS IoT SiteWise asset model property. + // The identifier of the AWS IoT SiteWise asset model property. IotSiteWiseAssetModelPropertyIdentifier *IotSiteWiseAssetModelPropertyIdentifier noSmithyDocumentSerde @@ -1119,8 +1289,9 @@ 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]. + // + // [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 @@ -1135,8 +1306,9 @@ 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]. +// +// [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 @@ -1180,11 +1352,12 @@ type OnInputLifecycle struct { noSmithyDocumentSerde } -// 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 . +// 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 . type Payload struct { // The content of the payload. You can use a string expression that includes @@ -1228,12 +1401,13 @@ type ResetTimerAction struct { // Contains information about the routed resource. 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. + // The ARN of the routed resource. For more information, see [Amazon Resource Names (ARNs)] in the AWS General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string - // The name of the routed resource. + // The name of the routed resource. Name *string noSmithyDocumentSerde @@ -1308,9 +1482,11 @@ 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]. + // + // [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 @@ -1360,8 +1536,9 @@ type SqsAction struct { } // 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]. +// +// [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. diff --git a/service/ioteventsdata/api_op_BatchDeleteDetector.go b/service/ioteventsdata/api_op_BatchDeleteDetector.go index e992f1de10a..01203e5c777 100644 --- a/service/ioteventsdata/api_op_BatchDeleteDetector.go +++ b/service/ioteventsdata/api_op_BatchDeleteDetector.go @@ -13,9 +13,10 @@ import ( // 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) -// API call. +// detectors. The deleted detector will no longer appear if referenced in the [ListDetectors]API +// call. +// +// [ListDetectors]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html func (c *Client) BatchDeleteDetector(ctx context.Context, params *BatchDeleteDetectorInput, optFns ...func(*Options)) (*BatchDeleteDetectorOutput, error) { if params == nil { params = &BatchDeleteDetectorInput{} diff --git a/service/ioteventsdata/api_op_DescribeAlarm.go b/service/ioteventsdata/api_op_DescribeAlarm.go index 5aae00c24ff..85bfcb08451 100644 --- a/service/ioteventsdata/api_op_DescribeAlarm.go +++ b/service/ioteventsdata/api_op_DescribeAlarm.go @@ -35,8 +35,9 @@ 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]. + // + // [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 ab0886b069c..525ec9989fe 100644 --- a/service/ioteventsdata/doc.go +++ b/service/ioteventsdata/doc.go @@ -6,6 +6,9 @@ // 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) -// in the IoT Events Developer Guide. +// update a detector's status. +// +// For more information, see [What is IoT Events?] in the IoT Events Developer Guide. +// +// [What is IoT Events?]: https://docs.aws.amazon.com/iotevents/latest/developerguide/what-is-iotevents.html package ioteventsdata diff --git a/service/ioteventsdata/options.go b/service/ioteventsdata/options.go index a3338820dd7..a178c345c56 100644 --- a/service/ioteventsdata/options.go +++ b/service/ioteventsdata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ioteventsdata/types/enums.go b/service/ioteventsdata/types/enums.go index 5f36340cea4..0cd532347bc 100644 --- a/service/ioteventsdata/types/enums.go +++ b/service/ioteventsdata/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AlarmStateName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlarmStateName) Values() []AlarmStateName { return []AlarmStateName{ "DISABLED", @@ -41,8 +42,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GREATER", @@ -66,8 +68,9 @@ const ( ) // Values returns all known values for CustomerActionName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomerActionName) Values() []CustomerActionName { return []CustomerActionName{ "SNOOZE", @@ -90,8 +93,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -110,8 +114,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -126,8 +131,9 @@ const ( ) // Values returns all known values for TriggerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerType) Values() []TriggerType { return []TriggerType{ "SNOOZE_TIMEOUT", diff --git a/service/ioteventsdata/types/types.go b/service/ioteventsdata/types/types.go index 3b314741700..ca64b549e43 100644 --- a/service/ioteventsdata/types/types.go +++ b/service/ioteventsdata/types/types.go @@ -30,8 +30,9 @@ 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]. + // + // [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 +57,9 @@ 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]. + // + // [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. @@ -79,20 +81,25 @@ type AlarmState struct { 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. + // range. To change the alarm to the NORMAL state, you must acknowledge the alarm. StateName AlarmStateName // Contains information about alarm state changes. @@ -114,39 +121,56 @@ 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]. + // + // [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. + // 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] +// +// [BatchDisableAlarm] +// +// [BatchEnableAlarm] +// +// [BatchResetAlarm] +// +// [BatchSnoozeAlarm] +// +// [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 +// [BatchResetAlarm]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html +// [BatchEnableAlarm]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html +// [BatchSnoozeAlarm]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html type BatchAlarmActionErrorEntry struct { // The error code. @@ -171,8 +195,9 @@ 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]object of the DeleteDetectorRequest .) + // + // [detectors]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html#iotevents-iotevents-data_BatchDeleteDetector-request-detectors MessageId *string noSmithyDocumentSerde @@ -217,15 +242,22 @@ 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) - // API. + // + // For more information, see the [AlarmState] API. + // + // [AlarmState]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_AlarmState.html ActionName CustomerActionName // Contains the configuration information of a disable action. @@ -257,8 +289,9 @@ type DeleteDetectorRequest struct { // 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) - // used to identify the detector. + // The value of the [key] used to identify the detector. + // + // [key]: https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html#iotevents-CreateDetectorModel-request-key KeyValue *string noSmithyDocumentSerde @@ -390,8 +423,9 @@ 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]. + // + // [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. @@ -423,8 +457,9 @@ 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]. + // + // [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. @@ -482,8 +517,9 @@ 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]. + // + // [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. @@ -549,8 +585,9 @@ 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]. + // + // [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. diff --git a/service/iotfleethub/api_op_CreateApplication.go b/service/iotfleethub/api_op_CreateApplication.go index 7ec672e01dc..9f0d48a3f5a 100644 --- a/service/iotfleethub/api_op_CreateApplication.go +++ b/service/iotfleethub/api_op_CreateApplication.go @@ -10,13 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a Fleet Hub for IoT Device Management web application. When creating a -// Fleet Hub application, you must create an organization instance of IAM Identity -// Center if you don't already have one. The Fleet Hub application you create must -// also be in the same Amazon Web Services Region of the organization instance of -// IAM Identity Center. For more information see Enabling IAM Identity Center (https://docs.aws.amazon.com/singlesignon/latest/userguide/get-set-up-for-idc.html) -// and Organization instances of IAM Identity Center (https://docs.aws.amazon.com/singlesignon/latest/userguide/organization-instances-identity-center.html) -// . +// Creates a Fleet Hub for IoT Device Management web application. +// +// When creating a Fleet Hub application, you must create an organization instance +// of IAM Identity Center if you don't already have one. The Fleet Hub application +// you create must also be in the same Amazon Web Services Region of the +// organization instance of IAM Identity Center. For more information see [Enabling IAM Identity Center]and [Organization instances of IAM Identity Center]. +// +// [Enabling IAM Identity Center]: https://docs.aws.amazon.com/singlesignon/latest/userguide/get-set-up-for-idc.html +// [Organization instances of IAM Identity Center]: https://docs.aws.amazon.com/singlesignon/latest/userguide/organization-instances-identity-center.html func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -40,8 +42,9 @@ type CreateApplicationInput struct { ApplicationName *string // The ARN of the role that the web application assumes when it interacts with - // Amazon Web Services IoT Core. The name of the role must be in the form - // AWSIotFleetHub_random_string . + // Amazon Web Services IoT Core. + // + // The name of the role must be in the form AWSIotFleetHub_random_string . // // This member is required. RoleArn *string diff --git a/service/iotfleethub/options.go b/service/iotfleethub/options.go index 5914b462b71..20b976fb396 100644 --- a/service/iotfleethub/options.go +++ b/service/iotfleethub/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotfleethub/types/enums.go b/service/iotfleethub/types/enums.go index 5f47c627c7c..29b263af517 100644 --- a/service/iotfleethub/types/enums.go +++ b/service/iotfleethub/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ApplicationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationState) Values() []ApplicationState { return []ApplicationState{ "CREATING", diff --git a/service/iotfleetwise/api_op_AssociateVehicleFleet.go b/service/iotfleetwise/api_op_AssociateVehicleFleet.go index 07b112c1ef0..1a842f6164f 100644 --- a/service/iotfleetwise/api_op_AssociateVehicleFleet.go +++ b/service/iotfleetwise/api_op_AssociateVehicleFleet.go @@ -28,12 +28,12 @@ func (c *Client) AssociateVehicleFleet(ctx context.Context, params *AssociateVeh type AssociateVehicleFleetInput struct { - // The ID of a fleet. + // The ID of a fleet. // // This member is required. FleetId *string - // The unique ID of the vehicle to associate with the fleet. + // The unique ID of the vehicle to associate with the fleet. // // This member is required. VehicleName *string diff --git a/service/iotfleetwise/api_op_BatchCreateVehicle.go b/service/iotfleetwise/api_op_BatchCreateVehicle.go index e66f01f92c1..9f547712181 100644 --- a/service/iotfleetwise/api_op_BatchCreateVehicle.go +++ b/service/iotfleetwise/api_op_BatchCreateVehicle.go @@ -11,10 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services IoT FleetWise Developer Guide. +// 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)] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [Create multiple vehicles (AWS CLI)]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicles-cli.html func (c *Client) BatchCreateVehicle(ctx context.Context, params *BatchCreateVehicleInput, optFns ...func(*Options)) (*BatchCreateVehicleOutput, error) { if params == nil { params = &BatchCreateVehicleInput{} @@ -32,7 +37,7 @@ func (c *Client) BatchCreateVehicle(ctx context.Context, params *BatchCreateVehi type BatchCreateVehicleInput struct { - // A list of information about each vehicle to create. For more information, see + // A list of information about each vehicle to create. For more information, see // the API data type. // // This member is required. @@ -47,7 +52,7 @@ type BatchCreateVehicleOutput struct { // any errors. Errors []types.CreateVehicleError - // A list of information about a batch of created vehicles. For more information, + // A list of information about a batch of created vehicles. For more information, // see the API data type. Vehicles []types.CreateVehicleResponseItem diff --git a/service/iotfleetwise/api_op_BatchUpdateVehicle.go b/service/iotfleetwise/api_op_BatchUpdateVehicle.go index 9fd45885d51..02b3bceb6ee 100644 --- a/service/iotfleetwise/api_op_BatchUpdateVehicle.go +++ b/service/iotfleetwise/api_op_BatchUpdateVehicle.go @@ -11,10 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services IoT FleetWise Developer Guide. +// 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)] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [Update multiple vehicles (AWS CLI)]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/update-vehicles-cli.html func (c *Client) BatchUpdateVehicle(ctx context.Context, params *BatchUpdateVehicleInput, optFns ...func(*Options)) (*BatchUpdateVehicleOutput, error) { if params == nil { params = &BatchUpdateVehicleInput{} @@ -32,7 +37,7 @@ func (c *Client) BatchUpdateVehicle(ctx context.Context, params *BatchUpdateVehi type BatchUpdateVehicleInput struct { - // A list of information about the vehicles to update. For more information, see + // A list of information about the vehicles to update. For more information, see // the API data type. // // This member is required. @@ -47,8 +52,9 @@ type BatchUpdateVehicleOutput struct { // or, if there aren't any errors, an empty list. Errors []types.UpdateVehicleError - // A list of information about the batch of updated vehicles. This list contains - // only unique IDs for the vehicles that were updated. + // A list of information about the batch of updated vehicles. + // + // This list contains only unique IDs for the vehicles that were updated. Vehicles []types.UpdateVehicleResponseItem // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_CreateCampaign.go b/service/iotfleetwise/api_op_CreateCampaign.go index 708d3eb6693..b07546391d2 100644 --- a/service/iotfleetwise/api_op_CreateCampaign.go +++ b/service/iotfleetwise/api_op_CreateCampaign.go @@ -16,9 +16,12 @@ import ( // FleetWise Edge Agent software running in vehicles uses campaigns to decide how // 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) -// in the Amazon Web Services IoT FleetWise Developer Guide. +// automatically deploys them to vehicles. +// +// For more information, see [Collect and transfer data with campaigns] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [Collect and transfer data with campaigns]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error) { if params == nil { params = &CreateCampaignInput{} @@ -36,13 +39,13 @@ func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput type CreateCampaignInput struct { - // The data collection scheme associated with the campaign. You can specify a + // The data collection scheme associated with the campaign. You can specify a // scheme that collects data based on time or an event. // // This member is required. CollectionScheme types.CollectionScheme - // The name of the campaign to create. + // The name of the campaign to create. // // This member is required. Name *string @@ -53,55 +56,70 @@ type CreateCampaignInput struct { // This member is required. SignalCatalogArn *string - // The ARN of the vehicle or fleet to deploy a campaign to. + // The ARN of the vehicle or fleet to deploy a campaign to. // // This member is required. TargetArn *string - // (Optional) Whether to compress signals before transmitting data to Amazon Web + // (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 - // it's not specified, SNAPPY is used. Default: SNAPPY + // it's not specified, SNAPPY is used. + // + // Default: SNAPPY Compression types.Compression // The destination where the campaign sends data. You can choose to send data to - // be stored in Amazon S3 or Amazon Timestream. Amazon S3 optimizes the cost of - // data storage and provides additional mechanisms to use vehicle data, such as - // data lakes, centralized data storage, data processing pipelines, and analytics. - // Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. - // Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise - // servers for redundancy and high availability. You can use Amazon Timestream to - // access and analyze time series data, and Timestream to query vehicle data so - // that you can identify trends and patterns. + // be stored in Amazon S3 or Amazon Timestream. + // + // Amazon S3 optimizes the cost of data storage and provides additional mechanisms + // to use vehicle data, such as data lakes, centralized data storage, data + // processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports + // at-least-once file delivery to S3. Your vehicle data is stored on multiple + // Amazon Web Services IoT FleetWise servers for redundancy and high availability. + // + // You can use Amazon Timestream to access and analyze time series data, and + // Timestream to query vehicle data so that you can identify trends and patterns. DataDestinationConfigs []types.DataDestinationConfig - // (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 + // (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 DataExtraDimensions []string // An optional description of the campaign to help identify its purpose. Description *string - // (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web + // (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, + // (Optional) The time the campaign expires, in seconds since epoch (January 1, // 1970 at midnight UTC time). Vehicle data isn't collected after the campaign - // expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC) + // expires. + // + // Default: 253402214400 (December 31, 9999, 00:00:00 UTC) ExpiryTime *time.Time - // (Optional) How long (in milliseconds) to collect raw data after a triggering - // event initiates the collection. If it's not specified, 0 is used. Default: 0 + // (Optional) How long (in milliseconds) to collect raw data after a triggering + // event initiates the collection. If it's not specified, 0 is used. + // + // Default: 0 PostTriggerCollectionDuration *int64 // (Optional) A number indicating the priority of one campaign over another // campaign for a certain vehicle or fleet. A campaign with the lowest value is // deployed to vehicles before any other campaigns. If it's not specified, 0 is - // used. Default: 0 + // used. + // + // Default: 0 Priority *int32 // (Optional) A list of information about signals to collect. @@ -111,11 +129,15 @@ type CreateCampaignInput struct { // 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 - // specified, OFF is used. Default: OFF + // specified, OFF is used. + // + // Default: OFF SpoolingMode types.SpoolingMode // (Optional) The time, in milliseconds, to deliver a campaign after it was - // approved. If it's not specified, 0 is used. Default: 0 + // approved. If it's not specified, 0 is used. + // + // Default: 0 StartTime *time.Time // Metadata that can be used to manage the campaign. @@ -126,7 +148,7 @@ type CreateCampaignInput struct { type CreateCampaignOutput struct { - // The ARN of the created campaign. + // The ARN of the created campaign. Arn *string // The name of the created campaign. diff --git a/service/iotfleetwise/api_op_CreateDecoderManifest.go b/service/iotfleetwise/api_op_CreateDecoderManifest.go index dc7539a78c7..33af00d37bf 100644 --- a/service/iotfleetwise/api_op_CreateDecoderManifest.go +++ b/service/iotfleetwise/api_op_CreateDecoderManifest.go @@ -13,9 +13,13 @@ 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. func (c *Client) CreateDecoderManifest(ctx context.Context, params *CreateDecoderManifestInput, optFns ...func(*Options)) (*CreateDecoderManifestOutput, error) { if params == nil { @@ -34,23 +38,23 @@ func (c *Client) CreateDecoderManifest(ctx context.Context, params *CreateDecode type CreateDecoderManifestInput struct { - // The Amazon Resource Name (ARN) of the vehicle model (model manifest). + // The Amazon Resource Name (ARN) of the vehicle model (model manifest). // // This member is required. ModelManifestArn *string - // The unique name of the decoder manifest to create. + // The unique name of the decoder manifest to create. // // This member is required. Name *string - // A brief description of the decoder manifest. + // A brief description of the decoder manifest. Description *string - // A list of information about available network interfaces. + // A list of information about available network interfaces. NetworkInterfaces []types.NetworkInterface - // A list of information about signal decoders. + // A list of information about signal decoders. SignalDecoders []types.SignalDecoder // Metadata that can be used to manage the decoder manifest. @@ -61,12 +65,12 @@ type CreateDecoderManifestInput struct { type CreateDecoderManifestOutput struct { - // The ARN of the created decoder manifest. + // The ARN of the created decoder manifest. // // This member is required. Arn *string - // The name of the created decoder manifest. + // The name of the created decoder manifest. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_CreateFleet.go b/service/iotfleetwise/api_op_CreateFleet.go index 5f05b2692ef..2d64b190a2a 100644 --- a/service/iotfleetwise/api_op_CreateFleet.go +++ b/service/iotfleetwise/api_op_CreateFleet.go @@ -11,10 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [Fleets]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleets.html func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optFns ...func(*Options)) (*CreateFleetOutput, error) { if params == nil { params = &CreateFleetInput{} @@ -32,17 +37,17 @@ func (c *Client) CreateFleet(ctx context.Context, params *CreateFleetInput, optF type CreateFleetInput struct { - // The unique ID of the fleet to create. + // The unique ID of the fleet to create. // // This member is required. FleetId *string - // The Amazon Resource Name (ARN) of a signal catalog. + // The Amazon Resource Name (ARN) of a signal catalog. // // This member is required. SignalCatalogArn *string - // A brief description of the fleet to create. + // A brief description of the fleet to create. Description *string // Metadata that can be used to manage the fleet. @@ -53,12 +58,12 @@ type CreateFleetInput struct { type CreateFleetOutput struct { - // The ARN of the created fleet. + // The ARN of the created fleet. // // This member is required. Arn *string - // The ID of the created fleet. + // The ID of the created fleet. // // This member is required. Id *string diff --git a/service/iotfleetwise/api_op_CreateModelManifest.go b/service/iotfleetwise/api_op_CreateModelManifest.go index c6f6ce1ef52..1a81818517b 100644 --- a/service/iotfleetwise/api_op_CreateModelManifest.go +++ b/service/iotfleetwise/api_op_CreateModelManifest.go @@ -11,9 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services IoT FleetWise Developer Guide. +// Creates a vehicle model (model manifest) that specifies signals (attributes, +// +// branches, sensors, and actuators). +// +// For more information, see [Vehicle models] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [Vehicle models]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicle-models.html func (c *Client) CreateModelManifest(ctx context.Context, params *CreateModelManifestInput, optFns ...func(*Options)) (*CreateModelManifestOutput, error) { if params == nil { params = &CreateModelManifestInput{} @@ -31,22 +36,22 @@ func (c *Client) CreateModelManifest(ctx context.Context, params *CreateModelMan type CreateModelManifestInput struct { - // The name of the vehicle model to create. + // The name of the vehicle model to create. // // This member is required. Name *string - // A list of nodes, which are a general abstraction of signals. + // A list of nodes, which are a general abstraction of signals. // // This member is required. Nodes []string - // The Amazon Resource Name (ARN) of a signal catalog. + // The Amazon Resource Name (ARN) of a signal catalog. // // This member is required. SignalCatalogArn *string - // A brief description of the vehicle model. + // A brief description of the vehicle model. Description *string // Metadata that can be used to manage the vehicle model. @@ -57,12 +62,12 @@ type CreateModelManifestInput struct { type CreateModelManifestOutput struct { - // The ARN of the created vehicle model. + // The ARN of the created vehicle model. // // This member is required. Arn *string - // The name of the created vehicle model. + // The name of the created vehicle model. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_CreateSignalCatalog.go b/service/iotfleetwise/api_op_CreateSignalCatalog.go index 4f068e71a84..db8d8c2d482 100644 --- a/service/iotfleetwise/api_op_CreateSignalCatalog.go +++ b/service/iotfleetwise/api_op_CreateSignalCatalog.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a collection of standardized signals that can be reused to create +// Creates a collection of standardized signals that can be reused to create +// // vehicle models. func (c *Client) CreateSignalCatalog(ctx context.Context, params *CreateSignalCatalogInput, optFns ...func(*Options)) (*CreateSignalCatalogOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) CreateSignalCatalog(ctx context.Context, params *CreateSignalCa type CreateSignalCatalogInput struct { - // The name of the signal catalog to create. + // The name of the signal catalog to create. // // This member is required. Name *string @@ -38,7 +39,7 @@ type CreateSignalCatalogInput struct { // A brief description of the signal catalog. Description *string - // A list of information about nodes, which are a general abstraction of signals. + // A list of information about nodes, which are a general abstraction of signals. // For more information, see the API data type. Nodes []types.Node @@ -50,12 +51,12 @@ type CreateSignalCatalogInput struct { type CreateSignalCatalogOutput struct { - // The ARN of the created signal catalog. + // The ARN of the created signal catalog. // // This member is required. Arn *string - // The name of the created signal catalog. + // The name of the created signal catalog. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_CreateVehicle.go b/service/iotfleetwise/api_op_CreateVehicle.go index 801087188cd..8835dc7a0a5 100644 --- a/service/iotfleetwise/api_op_CreateVehicle.go +++ b/service/iotfleetwise/api_op_CreateVehicle.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a vehicle, which is an instance of a vehicle model (model manifest). +// Creates a vehicle, which is an instance of a vehicle model (model manifest). +// // Vehicles created from the same vehicle model consist of the same signals -// 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) -// in the Amazon Web Services IoT FleetWise Developer Guide. +// 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)] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [Create a vehicle (AWS CLI)]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/create-vehicle-cli.html func (c *Client) CreateVehicle(ctx context.Context, params *CreateVehicleInput, optFns ...func(*Options)) (*CreateVehicleOutput, error) { if params == nil { params = &CreateVehicleInput{} @@ -35,29 +40,32 @@ func (c *Client) CreateVehicle(ctx context.Context, params *CreateVehicleInput, type CreateVehicleInput struct { - // The ARN of a decoder manifest. + // The ARN of a decoder manifest. // // This member is required. DecoderManifestArn *string - // The Amazon Resource Name ARN of a vehicle model. + // The Amazon Resource Name ARN of a vehicle model. // // This member is required. ModelManifestArn *string - // The unique ID of the vehicle to create. + // The unique ID of the vehicle to create. // // This member is required. VehicleName *string - // An option to create a new Amazon Web Services IoT thing when creating a + // 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: - // "engineType" : "1.3 L R2" A campaign must include the keys (attribute names) in - // dataExtraDimensions for them to display in Amazon Timestream. + // "engineType" : "1.3 L R2" + // + // A campaign must include the keys (attribute names) in dataExtraDimensions for + // them to display in Amazon Timestream. Attributes map[string]string // Metadata that can be used to manage the vehicle. @@ -68,10 +76,10 @@ type CreateVehicleInput struct { type CreateVehicleOutput struct { - // The ARN of the created vehicle. + // The ARN of the created vehicle. Arn *string - // The ARN of a created or validated Amazon Web Services IoT thing. + // The ARN of a created or validated Amazon Web Services IoT thing. ThingArn *string // The unique ID of the created vehicle. diff --git a/service/iotfleetwise/api_op_DeleteCampaign.go b/service/iotfleetwise/api_op_DeleteCampaign.go index 96b4fc4acfa..9017d28440c 100644 --- a/service/iotfleetwise/api_op_DeleteCampaign.go +++ b/service/iotfleetwise/api_op_DeleteCampaign.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a data collection campaign. Deleting a campaign suspends all data +// Deletes a data collection campaign. Deleting a campaign suspends all data +// // collection and removes it from any vehicles. func (c *Client) DeleteCampaign(ctx context.Context, params *DeleteCampaignInput, optFns ...func(*Options)) (*DeleteCampaignOutput, error) { if params == nil { @@ -29,7 +30,7 @@ func (c *Client) DeleteCampaign(ctx context.Context, params *DeleteCampaignInput type DeleteCampaignInput struct { - // The name of the campaign to delete. + // The name of the campaign to delete. // // This member is required. Name *string @@ -39,8 +40,9 @@ type DeleteCampaignInput struct { type DeleteCampaignOutput struct { - // The Amazon Resource Name (ARN) of the deleted campaign. The ARN isn’t returned - // if a campaign doesn’t exist. + // The Amazon Resource Name (ARN) of the deleted campaign. + // + // The ARN isn’t returned if a campaign doesn’t exist. Arn *string // The name of the deleted campaign. diff --git a/service/iotfleetwise/api_op_DeleteDecoderManifest.go b/service/iotfleetwise/api_op_DeleteDecoderManifest.go index d327aa222b9..553b94a2777 100644 --- a/service/iotfleetwise/api_op_DeleteDecoderManifest.go +++ b/service/iotfleetwise/api_op_DeleteDecoderManifest.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a decoder manifest. You can't delete a decoder manifest if it has -// vehicles associated with it. If the decoder manifest is successfully deleted, -// Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty -// body. +// Deletes a decoder manifest. You can't delete a decoder manifest if it has +// +// vehicles associated with it. +// +// If the decoder manifest is successfully deleted, Amazon Web Services IoT +// FleetWise sends back an HTTP 200 response with an empty body. func (c *Client) DeleteDecoderManifest(ctx context.Context, params *DeleteDecoderManifestInput, optFns ...func(*Options)) (*DeleteDecoderManifestOutput, error) { if params == nil { params = &DeleteDecoderManifestInput{} @@ -31,7 +33,7 @@ func (c *Client) DeleteDecoderManifest(ctx context.Context, params *DeleteDecode type DeleteDecoderManifestInput struct { - // The name of the decoder manifest to delete. + // The name of the decoder manifest to delete. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_DeleteFleet.go b/service/iotfleetwise/api_op_DeleteFleet.go index 6311baca27f..bf40b561a77 100644 --- a/service/iotfleetwise/api_op_DeleteFleet.go +++ b/service/iotfleetwise/api_op_DeleteFleet.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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. +// 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)]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. +// +// [Delete a fleet (AWS CLI)]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/delete-fleet-cli.html func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optFns ...func(*Options)) (*DeleteFleetOutput, error) { if params == nil { params = &DeleteFleetInput{} @@ -32,7 +36,7 @@ func (c *Client) DeleteFleet(ctx context.Context, params *DeleteFleetInput, optF type DeleteFleetInput struct { - // The ID of the fleet to delete. + // The ID of the fleet to delete. // // This member is required. FleetId *string diff --git a/service/iotfleetwise/api_op_DeleteModelManifest.go b/service/iotfleetwise/api_op_DeleteModelManifest.go index fa653f8e1c1..362fd6ae661 100644 --- a/service/iotfleetwise/api_op_DeleteModelManifest.go +++ b/service/iotfleetwise/api_op_DeleteModelManifest.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a vehicle model (model manifest). If the vehicle model is successfully -// deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with -// an empty body. +// Deletes a vehicle model (model manifest). +// +// If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise +// sends back an HTTP 200 response with an empty body. func (c *Client) DeleteModelManifest(ctx context.Context, params *DeleteModelManifestInput, optFns ...func(*Options)) (*DeleteModelManifestOutput, error) { if params == nil { params = &DeleteModelManifestInput{} @@ -30,7 +31,7 @@ func (c *Client) DeleteModelManifest(ctx context.Context, params *DeleteModelMan type DeleteModelManifestInput struct { - // The name of the model manifest to delete. + // The name of the model manifest to delete. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_DeleteSignalCatalog.go b/service/iotfleetwise/api_op_DeleteSignalCatalog.go index 8d4f505f7f7..5d49beac787 100644 --- a/service/iotfleetwise/api_op_DeleteSignalCatalog.go +++ b/service/iotfleetwise/api_op_DeleteSignalCatalog.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a signal catalog. If the signal catalog is successfully deleted, Amazon -// Web Services IoT FleetWise sends back an HTTP 200 response with an empty body. +// Deletes a signal catalog. +// +// If the signal catalog is successfully deleted, Amazon Web Services IoT +// FleetWise sends back an HTTP 200 response with an empty body. func (c *Client) DeleteSignalCatalog(ctx context.Context, params *DeleteSignalCatalogInput, optFns ...func(*Options)) (*DeleteSignalCatalogOutput, error) { if params == nil { params = &DeleteSignalCatalogInput{} @@ -29,7 +31,7 @@ func (c *Client) DeleteSignalCatalog(ctx context.Context, params *DeleteSignalCa type DeleteSignalCatalogInput struct { - // The name of the signal catalog to delete. + // The name of the signal catalog to delete. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_DeleteVehicle.go b/service/iotfleetwise/api_op_DeleteVehicle.go index 73ad569800f..1ee792ed79f 100644 --- a/service/iotfleetwise/api_op_DeleteVehicle.go +++ b/service/iotfleetwise/api_op_DeleteVehicle.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a vehicle and removes it from any campaigns. If the vehicle is -// successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 -// response with an empty body. +// Deletes a vehicle and removes it from any campaigns. +// +// If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends +// back an HTTP 200 response with an empty body. func (c *Client) DeleteVehicle(ctx context.Context, params *DeleteVehicleInput, optFns ...func(*Options)) (*DeleteVehicleOutput, error) { if params == nil { params = &DeleteVehicleInput{} diff --git a/service/iotfleetwise/api_op_DisassociateVehicleFleet.go b/service/iotfleetwise/api_op_DisassociateVehicleFleet.go index 506689fa1a0..d2504bd24a5 100644 --- a/service/iotfleetwise/api_op_DisassociateVehicleFleet.go +++ b/service/iotfleetwise/api_op_DisassociateVehicleFleet.go @@ -11,9 +11,10 @@ import ( ) // 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. +// 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{} @@ -31,12 +32,12 @@ func (c *Client) DisassociateVehicleFleet(ctx context.Context, params *Disassoci type DisassociateVehicleFleetInput struct { - // The unique ID of a fleet. + // The unique ID of a fleet. // // This member is required. FleetId *string - // The unique ID of the vehicle to disassociate from the fleet. + // The unique ID of the vehicle to disassociate from the fleet. // // This member is required. VehicleName *string diff --git a/service/iotfleetwise/api_op_GetCampaign.go b/service/iotfleetwise/api_op_GetCampaign.go index d47505ef97c..d6a4b04d749 100644 --- a/service/iotfleetwise/api_op_GetCampaign.go +++ b/service/iotfleetwise/api_op_GetCampaign.go @@ -30,7 +30,7 @@ func (c *Client) GetCampaign(ctx context.Context, params *GetCampaignInput, optF type GetCampaignInput struct { - // The name of the campaign to retrieve information about. + // The name of the campaign to retrieve information about. // // This member is required. Name *string @@ -40,40 +40,43 @@ type GetCampaignInput struct { type GetCampaignOutput struct { - // The Amazon Resource Name (ARN) of the campaign. + // The Amazon Resource Name (ARN) of the campaign. Arn *string - // Information about the data collection scheme associated with the campaign. + // Information about the data collection scheme associated with the campaign. CollectionScheme types.CollectionScheme - // Whether to compress signals before transmitting data to Amazon Web Services IoT - // FleetWise. If OFF is specified, the signals aren't compressed. If it's not + // Whether to compress signals before transmitting data to Amazon Web Services + // IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not // specified, SNAPPY is used. Compression types.Compression - // The time the campaign was created in seconds since epoch (January 1, 1970 at + // The time the campaign was created in seconds since epoch (January 1, 1970 at // midnight UTC time). CreationTime *time.Time // The destination where the campaign sends data. You can choose to send data to - // be stored in Amazon S3 or Amazon Timestream. Amazon S3 optimizes the cost of - // data storage and provides additional mechanisms to use vehicle data, such as - // data lakes, centralized data storage, data processing pipelines, and analytics. + // be stored in Amazon S3 or Amazon Timestream. + // + // Amazon S3 optimizes the cost of data storage and provides additional mechanisms + // to use vehicle data, such as data lakes, centralized data storage, data + // processing pipelines, and analytics. + // // You can use Amazon Timestream to access and analyze time series data, and // Timestream to query vehicle data so that you can identify trends and patterns. DataDestinationConfigs []types.DataDestinationConfig - // A list of vehicle attributes associated with the campaign. + // A list of vehicle attributes associated with the campaign. DataExtraDimensions []string // The description of the campaign. Description *string - // Option for a vehicle to send diagnostic trouble codes to Amazon Web Services + // 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 + // The time the campaign expires, in seconds since epoch (January 1, 1970 at // midnight UTC time). Vehicle data won't be collected after the campaign expires. ExpiryTime *time.Time @@ -83,34 +86,34 @@ type GetCampaignOutput struct { // The name of the campaign. Name *string - // How long (in seconds) to collect raw data after a triggering event initiates + // 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 + // A number indicating the priority of one campaign over another campaign for a // certain vehicle or fleet. A campaign with the lowest value is deployed to // vehicles before any other campaigns. Priority *int32 - // The ARN of a signal catalog. + // The ARN of a signal catalog. SignalCatalogArn *string - // Information about a list of signals to collect data on. + // Information about a list of signals to collect data on. SignalsToCollect []types.SignalInformation - // Whether to store collected data after a vehicle lost a connection with the + // 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. SpoolingMode types.SpoolingMode - // The time, in milliseconds, to deliver a campaign after it was approved. + // 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 . Status types.CampaignStatus - // The ARN of the vehicle or the fleet targeted by the campaign. + // The ARN of the vehicle or the fleet targeted by the campaign. TargetArn *string // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_GetDecoderManifest.go b/service/iotfleetwise/api_op_GetDecoderManifest.go index 36500fdba12..2b66e264513 100644 --- a/service/iotfleetwise/api_op_GetDecoderManifest.go +++ b/service/iotfleetwise/api_op_GetDecoderManifest.go @@ -30,7 +30,7 @@ func (c *Client) GetDecoderManifest(ctx context.Context, params *GetDecoderManif type GetDecoderManifestInput struct { - // The name of the decoder manifest to retrieve information about. + // The name of the decoder manifest to retrieve information about. // // This member is required. Name *string @@ -40,40 +40,40 @@ type GetDecoderManifestInput struct { type GetDecoderManifestOutput struct { - // The Amazon Resource Name (ARN) of the decoder manifest. + // The Amazon Resource Name (ARN) of the decoder manifest. // // This member is required. Arn *string - // The time the decoder manifest was created in seconds since epoch (January 1, + // The time the decoder manifest was created in seconds since epoch (January 1, // 1970 at midnight UTC time). // // This member is required. CreationTime *time.Time - // The time the decoder manifest was last updated in seconds since epoch (January + // The time the decoder manifest was last updated in seconds since epoch (January // 1, 1970 at midnight UTC time). // // This member is required. LastModificationTime *time.Time - // The name of the decoder manifest. + // The name of the decoder manifest. // // This member is required. Name *string - // A brief description of the decoder manifest. + // A brief description of the decoder manifest. Description *string // The detailed message for the decoder manifest. When a decoder manifest is in an // INVALID status, the message contains detailed reason and help information. Message *string - // The ARN of a vehicle model (model manifest) associated with the decoder + // The ARN of a vehicle model (model manifest) associated with the decoder // manifest. ModelManifestArn *string - // The state of the decoder manifest. If the status is ACTIVE , the decoder + // 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 diff --git a/service/iotfleetwise/api_op_GetFleet.go b/service/iotfleetwise/api_op_GetFleet.go index 16391e7ce13..1e9f162d057 100644 --- a/service/iotfleetwise/api_op_GetFleet.go +++ b/service/iotfleetwise/api_op_GetFleet.go @@ -29,7 +29,7 @@ func (c *Client) GetFleet(ctx context.Context, params *GetFleetInput, optFns ... type GetFleetInput struct { - // The ID of the fleet to retrieve information about. + // The ID of the fleet to retrieve information about. // // This member is required. FleetId *string @@ -39,34 +39,34 @@ type GetFleetInput struct { type GetFleetOutput struct { - // The Amazon Resource Name (ARN) of the fleet. + // The Amazon Resource Name (ARN) of the fleet. // // This member is required. Arn *string - // The time the fleet was created in seconds since epoch (January 1, 1970 at + // The time the fleet was created in seconds since epoch (January 1, 1970 at // midnight UTC time). // // This member is required. CreationTime *time.Time - // The ID of the fleet. + // The ID of the fleet. // // This member is required. Id *string - // The time the fleet was last updated, in seconds since epoch (January 1, 1970 at - // midnight UTC time). + // The time the fleet was last updated, in seconds since epoch (January 1, 1970 + // at midnight UTC time). // // This member is required. LastModificationTime *time.Time - // The ARN of a signal catalog associated with the fleet. + // The ARN of a signal catalog associated with the fleet. // // This member is required. SignalCatalogArn *string - // A brief description of the fleet. + // A brief description of the fleet. Description *string // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_GetModelManifest.go b/service/iotfleetwise/api_op_GetModelManifest.go index 9ede25fe4de..028fe550029 100644 --- a/service/iotfleetwise/api_op_GetModelManifest.go +++ b/service/iotfleetwise/api_op_GetModelManifest.go @@ -30,7 +30,7 @@ func (c *Client) GetModelManifest(ctx context.Context, params *GetModelManifestI type GetModelManifestInput struct { - // The name of the vehicle model to retrieve information about. + // The name of the vehicle model to retrieve information about. // // This member is required. Name *string @@ -40,7 +40,7 @@ type GetModelManifestInput struct { type GetModelManifestOutput struct { - // The Amazon Resource Name (ARN) of the vehicle model. + // The Amazon Resource Name (ARN) of the vehicle model. // // This member is required. Arn *string @@ -56,18 +56,18 @@ type GetModelManifestOutput struct { // This member is required. LastModificationTime *time.Time - // The name of the vehicle model. + // The name of the vehicle model. // // This member is required. Name *string - // A brief description of the vehicle model. + // A brief description of the vehicle model. Description *string - // The ARN of the signal catalog associated with the vehicle model. + // 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 + // 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 diff --git a/service/iotfleetwise/api_op_GetRegisterAccountStatus.go b/service/iotfleetwise/api_op_GetRegisterAccountStatus.go index 42b9a8863af..720f0441567 100644 --- a/service/iotfleetwise/api_op_GetRegisterAccountStatus.go +++ b/service/iotfleetwise/api_op_GetRegisterAccountStatus.go @@ -12,12 +12,16 @@ import ( "time" ) -// Retrieves information about the status of registering your Amazon Web Services +// Retrieves information about the status of registering your Amazon Web Services +// // 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. +// 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]. +// +// This API operation doesn't require input parameters. +// +// [Setting up Amazon Web Services IoT FleetWise]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html func (c *Client) GetRegisterAccountStatus(ctx context.Context, params *GetRegisterAccountStatusInput, optFns ...func(*Options)) (*GetRegisterAccountStatusOutput, error) { if params == nil { params = &GetRegisterAccountStatusInput{} @@ -39,9 +43,11 @@ 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. // @@ -51,29 +57,30 @@ type GetRegisterAccountStatusOutput struct { // This member is required. AccountStatus types.RegistrationStatus - // The time the account was registered, in seconds since epoch (January 1, 1970 at - // midnight UTC time). + // The time the account was registered, in seconds since epoch (January 1, 1970 + // at midnight UTC time). // // This member is required. CreationTime *time.Time - // The unique ID of the Amazon Web Services account, provided at account creation. + // The unique ID of the Amazon Web Services account, provided at account + // creation. // // This member is required. CustomerAccountId *string - // Information about the registered IAM resources or errors, if any. + // Information about the registered IAM resources or errors, if any. // // This member is required. IamRegistrationResponse *types.IamRegistrationResponse - // The time this registration was last updated, in seconds since epoch (January 1, - // 1970 at midnight UTC time). + // The time this registration was last updated, in seconds since epoch (January + // 1, 1970 at midnight UTC time). // // This member is required. LastModificationTime *time.Time - // Information about the registered Amazon Timestream resources or errors, if any. + // Information about the registered Amazon Timestream resources or errors, if any. TimestreamRegistrationResponse *types.TimestreamRegistrationResponse // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_GetSignalCatalog.go b/service/iotfleetwise/api_op_GetSignalCatalog.go index 90c37192d97..a8711100c88 100644 --- a/service/iotfleetwise/api_op_GetSignalCatalog.go +++ b/service/iotfleetwise/api_op_GetSignalCatalog.go @@ -30,7 +30,7 @@ func (c *Client) GetSignalCatalog(ctx context.Context, params *GetSignalCatalogI type GetSignalCatalogInput struct { - // The name of the signal catalog to retrieve information about. + // The name of the signal catalog to retrieve information about. // // This member is required. Name *string @@ -40,13 +40,13 @@ type GetSignalCatalogInput struct { type GetSignalCatalogOutput struct { - // The Amazon Resource Name (ARN) of the signal catalog. + // The Amazon Resource Name (ARN) of the signal catalog. // // This member is required. Arn *string - // The time the signal catalog was created in seconds since epoch (January 1, 1970 - // at midnight UTC time). + // The time the signal catalog was created in seconds since epoch (January 1, + // 1970 at midnight UTC time). // // This member is required. CreationTime *time.Time @@ -56,15 +56,15 @@ type GetSignalCatalogOutput struct { // This member is required. LastModificationTime *time.Time - // The name of the signal catalog. + // The name of the signal catalog. // // This member is required. Name *string - // A brief description of the signal catalog. + // A brief description of the signal catalog. Description *string - // The total number of network nodes specified in a signal catalog. + // The total number of network nodes specified in a signal catalog. NodeCounts *types.NodeCounts // Metadata pertaining to the operation's result. diff --git a/service/iotfleetwise/api_op_GetVehicle.go b/service/iotfleetwise/api_op_GetVehicle.go index 83fab89831f..dd1fa321bd6 100644 --- a/service/iotfleetwise/api_op_GetVehicle.go +++ b/service/iotfleetwise/api_op_GetVehicle.go @@ -29,7 +29,7 @@ func (c *Client) GetVehicle(ctx context.Context, params *GetVehicleInput, optFns type GetVehicleInput struct { - // The ID of the vehicle to retrieve information about. + // The ID of the vehicle to retrieve information about. // // This member is required. VehicleName *string @@ -39,25 +39,26 @@ type GetVehicleInput struct { type GetVehicleOutput struct { - // The Amazon Resource Name (ARN) of the vehicle to retrieve information about. + // The Amazon Resource Name (ARN) of the vehicle to retrieve information about. Arn *string // Static information about a vehicle in a key-value pair. For example: + // // "engineType" : "1.3 L R2" Attributes map[string]string - // The time the vehicle was created in seconds since epoch (January 1, 1970 at + // The time the vehicle was created in seconds since epoch (January 1, 1970 at // midnight UTC time). CreationTime *time.Time - // The ARN of a decoder manifest associated with the vehicle. + // 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 + // 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. + // The ARN of a vehicle model (model manifest) associated with the vehicle. ModelManifestArn *string // The ID of the vehicle. diff --git a/service/iotfleetwise/api_op_GetVehicleStatus.go b/service/iotfleetwise/api_op_GetVehicleStatus.go index fff9750cdf7..b00a22f6ba9 100644 --- a/service/iotfleetwise/api_op_GetVehicleStatus.go +++ b/service/iotfleetwise/api_op_GetVehicleStatus.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about the status of a vehicle with any associated +// Retrieves information about the status of a vehicle with any associated +// // campaigns. func (c *Client) GetVehicleStatus(ctx context.Context, params *GetVehicleStatusInput, optFns ...func(*Options)) (*GetVehicleStatusOutput, error) { if params == nil { @@ -30,19 +31,21 @@ func (c *Client) GetVehicleStatus(ctx context.Context, params *GetVehicleStatusI type GetVehicleStatusInput struct { - // The ID of the vehicle to retrieve information about. + // The ID of the vehicle to retrieve information about. // // This member is required. VehicleName *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -50,10 +53,10 @@ type GetVehicleStatusInput struct { type GetVehicleStatusOutput struct { - // Lists information about the state of the vehicle with deployed campaigns. + // Lists information about the state of the vehicle with deployed campaigns. Campaigns []types.VehicleStatus - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string @@ -152,7 +155,7 @@ var _ GetVehicleStatusAPIClient = (*Client)(nil) // GetVehicleStatusPaginatorOptions is the paginator options for GetVehicleStatus type GetVehicleStatusPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ImportDecoderManifest.go b/service/iotfleetwise/api_op_ImportDecoderManifest.go index 606c67622ae..5b9ece81df8 100644 --- a/service/iotfleetwise/api_op_ImportDecoderManifest.go +++ b/service/iotfleetwise/api_op_ImportDecoderManifest.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a decoder manifest using your existing CAN DBC file from your local +// Creates a decoder manifest using your existing CAN DBC file from your local +// // device. func (c *Client) ImportDecoderManifest(ctx context.Context, params *ImportDecoderManifestInput, optFns ...func(*Options)) (*ImportDecoderManifestOutput, error) { if params == nil { @@ -30,12 +31,12 @@ func (c *Client) ImportDecoderManifest(ctx context.Context, params *ImportDecode type ImportDecoderManifestInput struct { - // The name of the decoder manifest to import. + // The name of the decoder manifest to import. // // This member is required. Name *string - // The file to load into an Amazon Web Services account. + // The file to load into an Amazon Web Services account. // // This member is required. NetworkFileDefinitions []types.NetworkFileDefinition @@ -45,12 +46,12 @@ type ImportDecoderManifestInput struct { type ImportDecoderManifestOutput struct { - // The Amazon Resource Name (ARN) of the decoder manifest that was imported. + // The Amazon Resource Name (ARN) of the decoder manifest that was imported. // // This member is required. Arn *string - // The name of the imported decoder manifest. + // The name of the imported decoder manifest. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_ImportSignalCatalog.go b/service/iotfleetwise/api_op_ImportSignalCatalog.go index d8c9492fd1d..345db69636f 100644 --- a/service/iotfleetwise/api_op_ImportSignalCatalog.go +++ b/service/iotfleetwise/api_op_ImportSignalCatalog.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a signal catalog using your existing VSS formatted content from your +// Creates a signal catalog using your existing VSS formatted content from your +// // local device. func (c *Client) ImportSignalCatalog(ctx context.Context, params *ImportSignalCatalogInput, optFns ...func(*Options)) (*ImportSignalCatalogOutput, error) { if params == nil { @@ -35,7 +36,7 @@ type ImportSignalCatalogInput struct { // This member is required. Name *string - // A brief description of the signal catalog. + // A brief description of the signal catalog. Description *string // Metadata that can be used to manage the signal catalog. @@ -50,12 +51,12 @@ type ImportSignalCatalogInput struct { type ImportSignalCatalogOutput struct { - // The Amazon Resource Name (ARN) of the imported signal catalog. + // The Amazon Resource Name (ARN) of the imported signal catalog. // // This member is required. Arn *string - // The name of the imported signal catalog. + // The name of the imported signal catalog. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_ListCampaigns.go b/service/iotfleetwise/api_op_ListCampaigns.go index fe790d90750..15a010e53e3 100644 --- a/service/iotfleetwise/api_op_ListCampaigns.go +++ b/service/iotfleetwise/api_op_ListCampaigns.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists information about created campaigns. This API operation uses pagination. -// Specify the nextToken parameter in the request to return more results. +// Lists information about created campaigns. +// +// This API operation uses pagination. Specify the nextToken parameter in the +// request to return more results. func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsInput, optFns ...func(*Options)) (*ListCampaignsOutput, error) { if params == nil { params = &ListCampaignsInput{} @@ -30,14 +32,16 @@ func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsInput, type ListCampaignsInput struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string // Optional parameter to filter the results by the status of each created campaign @@ -50,10 +54,10 @@ type ListCampaignsInput struct { type ListCampaignsOutput struct { - // A summary of information about each campaign. + // A summary of information about each campaign. CampaignSummaries []types.CampaignSummary - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string @@ -148,7 +152,7 @@ var _ ListCampaignsAPIClient = (*Client)(nil) // ListCampaignsPaginatorOptions is the paginator options for ListCampaigns type ListCampaignsPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go b/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go index 7725c29cf9a..f2f92e76916 100644 --- a/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go +++ b/service/iotfleetwise/api_op_ListDecoderManifestNetworkInterfaces.go @@ -11,9 +11,10 @@ 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{} @@ -31,19 +32,21 @@ func (c *Client) ListDecoderManifestNetworkInterfaces(ctx context.Context, param type ListDecoderManifestNetworkInterfacesInput struct { - // The name of the decoder manifest to list information about. + // The name of the decoder manifest to list information about. // // This member is required. Name *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -51,10 +54,10 @@ type ListDecoderManifestNetworkInterfacesInput struct { type ListDecoderManifestNetworkInterfacesOutput struct { - // A list of information about network interfaces. + // A list of information about network interfaces. NetworkInterfaces []types.NetworkInterface - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string @@ -154,7 +157,7 @@ var _ ListDecoderManifestNetworkInterfacesAPIClient = (*Client)(nil) // ListDecoderManifestNetworkInterfacesPaginatorOptions is the paginator options // for ListDecoderManifestNetworkInterfaces type ListDecoderManifestNetworkInterfacesPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListDecoderManifestSignals.go b/service/iotfleetwise/api_op_ListDecoderManifestSignals.go index 23295128fd4..22db5ea29ed 100644 --- a/service/iotfleetwise/api_op_ListDecoderManifestSignals.go +++ b/service/iotfleetwise/api_op_ListDecoderManifestSignals.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// A list of information about signal decoders specified in a decoder manifest. +// A list of information about signal decoders specified in a decoder manifest. +// // This API operation uses pagination. Specify the nextToken parameter in the // request to return more results. func (c *Client) ListDecoderManifestSignals(ctx context.Context, params *ListDecoderManifestSignalsInput, optFns ...func(*Options)) (*ListDecoderManifestSignalsOutput, error) { @@ -31,19 +32,21 @@ func (c *Client) ListDecoderManifestSignals(ctx context.Context, params *ListDec type ListDecoderManifestSignalsInput struct { - // The name of the decoder manifest to list information about. + // The name of the decoder manifest to list information about. // // This member is required. Name *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -51,11 +54,11 @@ type ListDecoderManifestSignalsInput struct { type ListDecoderManifestSignalsOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // Information about a list of signals to decode. + // Information about a list of signals to decode. SignalDecoders []types.SignalDecoder // Metadata pertaining to the operation's result. @@ -154,7 +157,7 @@ var _ ListDecoderManifestSignalsAPIClient = (*Client)(nil) // ListDecoderManifestSignalsPaginatorOptions is the paginator options for // ListDecoderManifestSignals type ListDecoderManifestSignalsPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListDecoderManifests.go b/service/iotfleetwise/api_op_ListDecoderManifests.go index 08b5d43e02b..3e3bd052fba 100644 --- a/service/iotfleetwise/api_op_ListDecoderManifests.go +++ b/service/iotfleetwise/api_op_ListDecoderManifests.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists decoder manifests. This API operation uses pagination. Specify the -// nextToken parameter in the request to return more results. +// Lists decoder manifests. +// +// This API operation uses pagination. Specify the nextToken parameter in the +// request to return more results. func (c *Client) ListDecoderManifests(ctx context.Context, params *ListDecoderManifestsInput, optFns ...func(*Options)) (*ListDecoderManifestsOutput, error) { if params == nil { params = &ListDecoderManifestsInput{} @@ -30,18 +32,20 @@ func (c *Client) ListDecoderManifests(ctx context.Context, params *ListDecoderMa type ListDecoderManifestsInput struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated + // The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated // with the decoder manifest. ModelManifestArn *string - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -49,11 +53,11 @@ type ListDecoderManifestsInput struct { type ListDecoderManifestsOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of information about each decoder manifest. + // A list of information about each decoder manifest. Summaries []types.DecoderManifestSummary // Metadata pertaining to the operation's result. @@ -149,7 +153,7 @@ var _ ListDecoderManifestsAPIClient = (*Client)(nil) // ListDecoderManifestsPaginatorOptions is the paginator options for // ListDecoderManifests type ListDecoderManifestsPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListFleets.go b/service/iotfleetwise/api_op_ListFleets.go index 3a58e357151..cba8ab48b33 100644 --- a/service/iotfleetwise/api_op_ListFleets.go +++ b/service/iotfleetwise/api_op_ListFleets.go @@ -11,7 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information for each created fleet in an Amazon Web Services account. +// Retrieves information for each created fleet in an Amazon Web Services +// +// account. +// // This API operation uses pagination. Specify the nextToken parameter in the // request to return more results. func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns ...func(*Options)) (*ListFleetsOutput, error) { @@ -31,14 +34,16 @@ func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns type ListFleetsInput struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -46,10 +51,10 @@ type ListFleetsInput struct { type ListFleetsOutput struct { - // A list of information for each fleet. + // A list of information for each fleet. FleetSummaries []types.FleetSummary - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string @@ -144,7 +149,7 @@ var _ ListFleetsAPIClient = (*Client)(nil) // ListFleetsPaginatorOptions is the paginator options for ListFleets type ListFleetsPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListFleetsForVehicle.go b/service/iotfleetwise/api_op_ListFleetsForVehicle.go index 2ae07c05b45..4834fc0a897 100644 --- a/service/iotfleetwise/api_op_ListFleetsForVehicle.go +++ b/service/iotfleetwise/api_op_ListFleetsForVehicle.go @@ -11,6 +11,7 @@ import ( ) // 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) { @@ -30,19 +31,21 @@ func (c *Client) ListFleetsForVehicle(ctx context.Context, params *ListFleetsFor type ListFleetsForVehicleInput struct { - // The ID of the vehicle to retrieve information about. + // The ID of the vehicle to retrieve information about. // // This member is required. VehicleName *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -50,10 +53,10 @@ type ListFleetsForVehicleInput struct { type ListFleetsForVehicleOutput struct { - // A list of fleet IDs that the vehicle is associated with. + // A list of fleet IDs that the vehicle is associated with. Fleets []string - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string @@ -153,7 +156,7 @@ var _ ListFleetsForVehicleAPIClient = (*Client)(nil) // ListFleetsForVehiclePaginatorOptions is the paginator options for // ListFleetsForVehicle type ListFleetsForVehiclePaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListModelManifestNodes.go b/service/iotfleetwise/api_op_ListModelManifestNodes.go index c50d7f0d60c..857e8b7e4df 100644 --- a/service/iotfleetwise/api_op_ListModelManifestNodes.go +++ b/service/iotfleetwise/api_op_ListModelManifestNodes.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists information about nodes specified in a vehicle model (model manifest). +// Lists information about nodes specified in a vehicle model (model manifest). +// // This API operation uses pagination. Specify the nextToken parameter in the // request to return more results. func (c *Client) ListModelManifestNodes(ctx context.Context, params *ListModelManifestNodesInput, optFns ...func(*Options)) (*ListModelManifestNodesOutput, error) { @@ -31,19 +32,21 @@ func (c *Client) ListModelManifestNodes(ctx context.Context, params *ListModelMa type ListModelManifestNodesInput struct { - // The name of the vehicle model to list information about. + // The name of the vehicle model to list information about. // // This member is required. Name *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -51,11 +54,11 @@ type ListModelManifestNodesInput struct { type ListModelManifestNodesOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of information about nodes. + // A list of information about nodes. Nodes []types.Node // Metadata pertaining to the operation's result. @@ -154,7 +157,7 @@ var _ ListModelManifestNodesAPIClient = (*Client)(nil) // ListModelManifestNodesPaginatorOptions is the paginator options for // ListModelManifestNodes type ListModelManifestNodesPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListModelManifests.go b/service/iotfleetwise/api_op_ListModelManifests.go index d598649749e..6146d0ade4f 100644 --- a/service/iotfleetwise/api_op_ListModelManifests.go +++ b/service/iotfleetwise/api_op_ListModelManifests.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of vehicle models (model manifests). This API operation uses -// pagination. Specify the nextToken parameter in the request to return more -// results. +// Retrieves a list of vehicle models (model manifests). +// +// This API operation uses pagination. Specify the nextToken parameter in the +// request to return more results. func (c *Client) ListModelManifests(ctx context.Context, params *ListModelManifestsInput, optFns ...func(*Options)) (*ListModelManifestsOutput, error) { if params == nil { params = &ListModelManifestsInput{} @@ -31,17 +32,19 @@ func (c *Client) ListModelManifests(ctx context.Context, params *ListModelManife type ListModelManifestsInput struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string - // The ARN of a signal catalog. If you specify a signal catalog, only the vehicle + // The ARN of a signal catalog. If you specify a signal catalog, only the vehicle // models associated with it are returned. SignalCatalogArn *string @@ -50,11 +53,11 @@ type ListModelManifestsInput struct { type ListModelManifestsOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of information about vehicle models. + // A list of information about vehicle models. Summaries []types.ModelManifestSummary // Metadata pertaining to the operation's result. @@ -150,7 +153,7 @@ var _ ListModelManifestsAPIClient = (*Client)(nil) // ListModelManifestsPaginatorOptions is the paginator options for // ListModelManifests type ListModelManifestsPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListSignalCatalogNodes.go b/service/iotfleetwise/api_op_ListSignalCatalogNodes.go index c9aa1467573..c51e5d0d451 100644 --- a/service/iotfleetwise/api_op_ListSignalCatalogNodes.go +++ b/service/iotfleetwise/api_op_ListSignalCatalogNodes.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists of information about the signals (nodes) specified in a signal catalog. +// Lists of information about the signals (nodes) specified in a signal catalog. +// // This API operation uses pagination. Specify the nextToken parameter in the // request to return more results. func (c *Client) ListSignalCatalogNodes(ctx context.Context, params *ListSignalCatalogNodesInput, optFns ...func(*Options)) (*ListSignalCatalogNodesOutput, error) { @@ -31,19 +32,21 @@ func (c *Client) ListSignalCatalogNodes(ctx context.Context, params *ListSignalC type ListSignalCatalogNodesInput struct { - // The name of the signal catalog to list information about. + // The name of the signal catalog to list information about. // // This member is required. Name *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string // The type of node in the signal catalog. @@ -54,11 +57,11 @@ type ListSignalCatalogNodesInput struct { type ListSignalCatalogNodesOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of information about nodes. + // A list of information about nodes. Nodes []types.Node // Metadata pertaining to the operation's result. @@ -157,7 +160,7 @@ var _ ListSignalCatalogNodesAPIClient = (*Client)(nil) // ListSignalCatalogNodesPaginatorOptions is the paginator options for // ListSignalCatalogNodes type ListSignalCatalogNodesPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListSignalCatalogs.go b/service/iotfleetwise/api_op_ListSignalCatalogs.go index 440bfa236e7..963f03a4fa3 100644 --- a/service/iotfleetwise/api_op_ListSignalCatalogs.go +++ b/service/iotfleetwise/api_op_ListSignalCatalogs.go @@ -11,10 +11,13 @@ 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{} @@ -32,14 +35,16 @@ func (c *Client) ListSignalCatalogs(ctx context.Context, params *ListSignalCatal type ListSignalCatalogsInput struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -47,11 +52,11 @@ type ListSignalCatalogsInput struct { type ListSignalCatalogsOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of information about each signal catalog. + // A list of information about each signal catalog. Summaries []types.SignalCatalogSummary // Metadata pertaining to the operation's result. @@ -147,7 +152,7 @@ var _ ListSignalCatalogsAPIClient = (*Client)(nil) // ListSignalCatalogsPaginatorOptions is the paginator options for // ListSignalCatalogs type ListSignalCatalogsPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListVehicles.go b/service/iotfleetwise/api_op_ListVehicles.go index a55489581ba..41429c86def 100644 --- a/service/iotfleetwise/api_op_ListVehicles.go +++ b/service/iotfleetwise/api_op_ListVehicles.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of summaries of created vehicles. This API operation uses -// pagination. Specify the nextToken parameter in the request to return more -// results. +// Retrieves a list of summaries of created vehicles. +// +// This API operation uses pagination. Specify the nextToken parameter in the +// request to return more results. func (c *Client) ListVehicles(ctx context.Context, params *ListVehiclesInput, optFns ...func(*Options)) (*ListVehiclesOutput, error) { if params == nil { params = &ListVehiclesInput{} @@ -31,19 +32,21 @@ func (c *Client) ListVehicles(ctx context.Context, params *ListVehiclesInput, op type ListVehiclesInput struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use - // this optional parameter to list only the vehicles created from a certain vehicle - // model. + // The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can + // use this optional parameter to list only the vehicles created from a certain + // vehicle model. ModelManifestArn *string - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -51,11 +54,11 @@ type ListVehiclesInput struct { type ListVehiclesOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of vehicles and information about them. + // A list of vehicles and information about them. VehicleSummaries []types.VehicleSummary // Metadata pertaining to the operation's result. @@ -149,7 +152,7 @@ var _ ListVehiclesAPIClient = (*Client)(nil) // ListVehiclesPaginatorOptions is the paginator options for ListVehicles type ListVehiclesPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_ListVehiclesInFleet.go b/service/iotfleetwise/api_op_ListVehiclesInFleet.go index 13f27a164c3..572f4691599 100644 --- a/service/iotfleetwise/api_op_ListVehiclesInFleet.go +++ b/service/iotfleetwise/api_op_ListVehiclesInFleet.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of summaries of all vehicles associated with a fleet. This API -// operation uses pagination. Specify the nextToken parameter in the request to -// return more results. +// Retrieves a list of summaries of all vehicles associated with a fleet. +// +// This API operation uses pagination. Specify the nextToken parameter in the +// request to return more results. func (c *Client) ListVehiclesInFleet(ctx context.Context, params *ListVehiclesInFleetInput, optFns ...func(*Options)) (*ListVehiclesInFleetOutput, error) { if params == nil { params = &ListVehiclesInFleetInput{} @@ -30,19 +31,21 @@ func (c *Client) ListVehiclesInFleet(ctx context.Context, params *ListVehiclesIn type ListVehiclesInFleetInput struct { - // The ID of a fleet. + // The ID of a fleet. // // This member is required. FleetId *string - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. MaxResults *int32 - // A pagination token for the next set of results. If the results of a search are - // large, only a portion of the results are returned, and a nextToken pagination - // token is returned in the response. To retrieve the next set of results, reissue - // the search request and include the returned token. When all results have been - // returned, the response does not contain a pagination token value. + // A pagination token for the next set of results. + // + // If the results of a search are large, only a portion of the results are + // returned, and a nextToken pagination token is returned in the response. To + // retrieve the next set of results, reissue the search request and include the + // returned token. When all results have been returned, the response does not + // contain a pagination token value. NextToken *string noSmithyDocumentSerde @@ -50,11 +53,11 @@ type ListVehiclesInFleetInput struct { type ListVehiclesInFleetOutput struct { - // The token to retrieve the next set of results, or null if there are no more + // The token to retrieve the next set of results, or null if there are no more // results. NextToken *string - // A list of vehicles associated with the fleet. + // A list of vehicles associated with the fleet. Vehicles []string // Metadata pertaining to the operation's result. @@ -153,7 +156,7 @@ var _ ListVehiclesInFleetAPIClient = (*Client)(nil) // ListVehiclesInFleetPaginatorOptions is the paginator options for // ListVehiclesInFleet type ListVehiclesInFleetPaginatorOptions struct { - // The maximum number of items to return, between 1 and 100, inclusive. + // The maximum number of items to return, between 1 and 100, inclusive. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotfleetwise/api_op_PutEncryptionConfiguration.go b/service/iotfleetwise/api_op_PutEncryptionConfiguration.go index 8234bb4309a..00c354e9548 100644 --- a/service/iotfleetwise/api_op_PutEncryptionConfiguration.go +++ b/service/iotfleetwise/api_op_PutEncryptionConfiguration.go @@ -14,8 +14,9 @@ import ( // Creates or updates the encryption configuration. Amazon Web Services IoT // FleetWise can encrypt your data and resources using an Amazon Web Services // managed key. Or, you can use a KMS key that you own and manage. For more -// information, see Data encryption (https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/data-encryption.html) -// in the Amazon Web Services IoT FleetWise Developer Guide. +// information, see [Data encryption]in the Amazon Web Services IoT FleetWise Developer Guide. +// +// [Data encryption]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/data-encryption.html func (c *Client) PutEncryptionConfiguration(ctx context.Context, params *PutEncryptionConfigurationInput, optFns ...func(*Options)) (*PutEncryptionConfigurationOutput, error) { if params == nil { params = &PutEncryptionConfigurationInput{} diff --git a/service/iotfleetwise/api_op_RegisterAccount.go b/service/iotfleetwise/api_op_RegisterAccount.go index b6d0d0faf4b..2da78e055ad 100644 --- a/service/iotfleetwise/api_op_RegisterAccount.go +++ b/service/iotfleetwise/api_op_RegisterAccount.go @@ -15,27 +15,35 @@ import ( // This API operation contains deprecated parameters. Register your account again // without the Timestream resources parameter so that Amazon Web Services IoT // FleetWise can remove the Timestream metadata stored. You should then pass the -// data destination into the CreateCampaign (https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CreateCampaign.html) -// API operation. You must delete any existing campaigns that include an empty data -// destination before you register your account again. For more information, see -// the DeleteCampaign (https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DeleteCampaign.html) -// API operation. If you want to delete the Timestream inline policy from the -// service-linked role, such as to mitigate an overly permissive policy, you must -// first delete any existing campaigns. Then delete the service-linked role and -// register your account again to enable CloudWatch metrics. For more information, -// see DeleteServiceLinkedRole (https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceLinkedRole.html) -// in the Identity and Access Management API Reference. 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." 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. +// data destination into the [CreateCampaign]API operation. +// +// You must delete any existing campaigns that include an empty data destination +// before you register your account again. For more information, see the [DeleteCampaign]API +// operation. +// +// If you want to delete the Timestream inline policy from the service-linked +// role, such as to mitigate an overly permissive policy, you must first delete any +// existing campaigns. Then delete the service-linked role and register your +// account again to enable CloudWatch metrics. For more information, see [DeleteServiceLinkedRole]in the +// Identity and Access Management API Reference. +// +// 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]. +// +// An Amazon Web Services account is not the same thing as a "user." An [Amazon Web Services user] is an +// identity that you create using Identity and Access Management (IAM) and takes +// the form of either an [IAM user]or an [IAM role, both with credentials]. A single Amazon Web Services account can, and +// typically does, contain many users and roles. +// +// [CreateCampaign]: https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CreateCampaign.html +// [DeleteServiceLinkedRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteServiceLinkedRole.html +// [Amazon Web Services user]: https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html#intro-identity-users +// [Setting up Amazon Web Services IoT FleetWise]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/setting-up.html +// [DeleteCampaign]: https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_DeleteCampaign.html +// [IAM user]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html +// [IAM role, both with credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html func (c *Client) RegisterAccount(ctx context.Context, params *RegisterAccountInput, optFns ...func(*Options)) (*RegisterAccountOutput, error) { if params == nil { params = &RegisterAccountInput{} @@ -70,25 +78,25 @@ type RegisterAccountInput struct { type RegisterAccountOutput struct { - // The time the account was registered, in seconds since epoch (January 1, 1970 at - // midnight UTC time). + // The time the account was registered, in seconds since epoch (January 1, 1970 + // at midnight UTC time). // // This member is required. CreationTime *time.Time - // The registered IAM resource that allows Amazon Web Services IoT FleetWise to + // The registered IAM resource that allows Amazon Web Services IoT FleetWise to // send data to Amazon Timestream. // // This member is required. IamResources *types.IamResources - // The time this registration was last updated, in seconds since epoch (January 1, - // 1970 at midnight UTC time). + // The time this registration was last updated, in seconds since epoch (January + // 1, 1970 at midnight UTC time). // // This member is required. LastModificationTime *time.Time - // The status of registering your Amazon Web Services account, IAM role, and + // The status of registering your Amazon Web Services account, IAM role, and // Timestream resources. // // This member is required. diff --git a/service/iotfleetwise/api_op_UpdateCampaign.go b/service/iotfleetwise/api_op_UpdateCampaign.go index 269db340ab3..66d33d519ef 100644 --- a/service/iotfleetwise/api_op_UpdateCampaign.go +++ b/service/iotfleetwise/api_op_UpdateCampaign.go @@ -29,23 +29,29 @@ 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: + // 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. The campaign is deleted from // vehicles and all vehicles in the suspended campaign will stop sending data. + // // - RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to // all vehicles and the vehicles will resume sending data. + // // - UPDATE - To update a campaign. // // This member is required. Action types.UpdateCampaignAction - // The name of the campaign to update. + // The name of the campaign to update. // // This member is required. Name *string - // A list of vehicle attributes to associate with a signal. Default: An empty array + // A list of vehicle attributes to associate with a signal. + // + // Default: An empty array DataExtraDimensions []string // The description of the campaign. @@ -56,20 +62,24 @@ type UpdateCampaignInput struct { type UpdateCampaignOutput struct { - // The Amazon Resource Name (ARN) of the campaign. + // The Amazon Resource Name (ARN) of the campaign. Arn *string // The name of the updated campaign. 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. Status types.CampaignStatus diff --git a/service/iotfleetwise/api_op_UpdateDecoderManifest.go b/service/iotfleetwise/api_op_UpdateDecoderManifest.go index f42f95385a1..620dab2c23a 100644 --- a/service/iotfleetwise/api_op_UpdateDecoderManifest.go +++ b/service/iotfleetwise/api_op_UpdateDecoderManifest.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) UpdateDecoderManifest(ctx context.Context, params *UpdateDecoderManifestInput, optFns ...func(*Options)) (*UpdateDecoderManifestOutput, error) { if params == nil { params = &UpdateDecoderManifestInput{} @@ -30,37 +32,37 @@ func (c *Client) UpdateDecoderManifest(ctx context.Context, params *UpdateDecode type UpdateDecoderManifestInput struct { - // The name of the decoder manifest to update. + // The name of the decoder manifest to update. // // This member is required. Name *string - // A brief description of the decoder manifest to update. + // A brief description of the decoder manifest to update. Description *string - // A list of information about the network interfaces to add to the decoder + // A list of information about the network interfaces to add to the decoder // manifest. NetworkInterfacesToAdd []types.NetworkInterface - // A list of network interfaces to remove from the decoder manifest. + // A list of network interfaces to remove from the decoder manifest. NetworkInterfacesToRemove []string - // A list of information about the network interfaces to update in the decoder + // A list of information about the network interfaces to update in the decoder // manifest. NetworkInterfacesToUpdate []types.NetworkInterface - // A list of information about decoding additional signals to add to the decoder + // A list of information about decoding additional signals to add to the decoder // manifest. SignalDecodersToAdd []types.SignalDecoder - // A list of signal decoders to remove from the decoder manifest. + // A list of signal decoders to remove from the decoder manifest. SignalDecodersToRemove []string - // A list of updated information about decoding signals to update in the decoder + // A list of updated information about decoding signals to update in the decoder // manifest. SignalDecodersToUpdate []types.SignalDecoder - // The state of the decoder manifest. If the status is ACTIVE , the decoder + // 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 @@ -70,12 +72,12 @@ type UpdateDecoderManifestInput struct { type UpdateDecoderManifestOutput struct { - // The Amazon Resource Name (ARN) of the updated decoder manifest. + // The Amazon Resource Name (ARN) of the updated decoder manifest. // // This member is required. Arn *string - // The name of the updated decoder manifest. + // The name of the updated decoder manifest. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_UpdateFleet.go b/service/iotfleetwise/api_op_UpdateFleet.go index e4b73786063..99ce7093419 100644 --- a/service/iotfleetwise/api_op_UpdateFleet.go +++ b/service/iotfleetwise/api_op_UpdateFleet.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the description of an existing fleet. If the fleet is successfully -// updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with -// an empty HTTP body. +// Updates the description of an existing fleet. +// +// If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends +// back an HTTP 200 response with an empty HTTP body. func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optFns ...func(*Options)) (*UpdateFleetOutput, error) { if params == nil { params = &UpdateFleetInput{} @@ -30,12 +31,12 @@ func (c *Client) UpdateFleet(ctx context.Context, params *UpdateFleetInput, optF type UpdateFleetInput struct { - // The ID of the fleet to update. + // The ID of the fleet to update. // // This member is required. FleetId *string - // An updated description of the fleet. + // An updated description of the fleet. Description *string noSmithyDocumentSerde diff --git a/service/iotfleetwise/api_op_UpdateModelManifest.go b/service/iotfleetwise/api_op_UpdateModelManifest.go index f2739ec0469..908d29606a4 100644 --- a/service/iotfleetwise/api_op_UpdateModelManifest.go +++ b/service/iotfleetwise/api_op_UpdateModelManifest.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a vehicle model (model manifest). If created vehicles are associated +// Updates a vehicle model (model manifest). If created vehicles are associated +// // with a vehicle model, it can't be updated. func (c *Client) UpdateModelManifest(ctx context.Context, params *UpdateModelManifestInput, optFns ...func(*Options)) (*UpdateModelManifestOutput, error) { if params == nil { @@ -30,23 +31,23 @@ func (c *Client) UpdateModelManifest(ctx context.Context, params *UpdateModelMan type UpdateModelManifestInput struct { - // The name of the vehicle model to update. + // The name of the vehicle model to update. // // This member is required. Name *string - // A brief description of the vehicle model. + // A brief description of the vehicle model. Description *string - // A list of fullyQualifiedName of nodes, which are a general abstraction of + // A list of fullyQualifiedName of nodes, which are a general abstraction of // signals, to add to the vehicle model. NodesToAdd []string - // A list of fullyQualifiedName of nodes, which are a general abstraction of + // A list of fullyQualifiedName of nodes, which are a general abstraction of // signals, to remove from the vehicle model. NodesToRemove []string - // The state of the vehicle model. If the status is ACTIVE , 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 @@ -55,12 +56,12 @@ type UpdateModelManifestInput struct { type UpdateModelManifestOutput struct { - // The Amazon Resource Name (ARN) of the updated vehicle model. + // The Amazon Resource Name (ARN) of the updated vehicle model. // // This member is required. Arn *string - // The name of the updated vehicle model. + // The name of the updated vehicle model. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_UpdateSignalCatalog.go b/service/iotfleetwise/api_op_UpdateSignalCatalog.go index df7a93378b1..becfa0df6d5 100644 --- a/service/iotfleetwise/api_op_UpdateSignalCatalog.go +++ b/service/iotfleetwise/api_op_UpdateSignalCatalog.go @@ -29,21 +29,21 @@ func (c *Client) UpdateSignalCatalog(ctx context.Context, params *UpdateSignalCa type UpdateSignalCatalogInput struct { - // The name of the signal catalog to update. + // The name of the signal catalog to update. // // This member is required. Name *string - // A brief description of the signal catalog to update. + // A brief description of the signal catalog to update. Description *string - // A list of information about nodes to add to the signal catalog. + // A list of information about nodes to add to the signal catalog. NodesToAdd []types.Node - // A list of fullyQualifiedName of nodes to remove from the signal catalog. + // A list of fullyQualifiedName of nodes to remove from the signal catalog. NodesToRemove []string - // A list of information about nodes to update in the signal catalog. + // A list of information about nodes to update in the signal catalog. NodesToUpdate []types.Node noSmithyDocumentSerde @@ -51,12 +51,12 @@ type UpdateSignalCatalogInput struct { type UpdateSignalCatalogOutput struct { - // The ARN of the updated signal catalog. + // The ARN of the updated signal catalog. // // This member is required. Arn *string - // The name of the updated signal catalog. + // The name of the updated signal catalog. // // This member is required. Name *string diff --git a/service/iotfleetwise/api_op_UpdateVehicle.go b/service/iotfleetwise/api_op_UpdateVehicle.go index d77d6e486c7..083d5eb0043 100644 --- a/service/iotfleetwise/api_op_UpdateVehicle.go +++ b/service/iotfleetwise/api_op_UpdateVehicle.go @@ -36,11 +36,13 @@ type UpdateVehicleInput struct { // The method the specified attributes will update the existing attributes on the // 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. + // attributes. Or use Merge to combine all attributes. + // + // This is required if attributes are present in the input. AttributeUpdateMode types.UpdateMode // Static information about a vehicle in a key-value pair. For example: + // // "engineType" : "1.3 L R2" Attributes map[string]string diff --git a/service/iotfleetwise/doc.go b/service/iotfleetwise/doc.go index 16b41c6be15..b5b29bfcd3a 100644 --- a/service/iotfleetwise/doc.go +++ b/service/iotfleetwise/doc.go @@ -8,6 +8,9 @@ // 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?] in the Amazon Web Services IoT FleetWise Developer +// Guide. +// +// [What is Amazon Web Services IoT FleetWise?]: https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/ package iotfleetwise diff --git a/service/iotfleetwise/options.go b/service/iotfleetwise/options.go index 3bc794cb501..53ed319cd3b 100644 --- a/service/iotfleetwise/options.go +++ b/service/iotfleetwise/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotfleetwise/types/enums.go b/service/iotfleetwise/types/enums.go index 11266739922..4caf135201b 100644 --- a/service/iotfleetwise/types/enums.go +++ b/service/iotfleetwise/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for CampaignStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CampaignStatus) Values() []CampaignStatus { return []CampaignStatus{ "CREATING", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for Compression. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Compression) Values() []Compression { return []Compression{ "OFF", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for DataFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataFormat) Values() []DataFormat { return []DataFormat{ "JSON", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for DiagnosticsMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiagnosticsMode) Values() []DiagnosticsMode { return []DiagnosticsMode{ "OFF", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for EncryptionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionStatus) Values() []EncryptionStatus { return []EncryptionStatus{ "PENDING", @@ -107,8 +112,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "KMS_BASED_ENCRYPTION", @@ -125,8 +131,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "OFF", @@ -145,8 +152,9 @@ const ( ) // Values returns all known values for ManifestStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManifestStatus) Values() []ManifestStatus { return []ManifestStatus{ "ACTIVE", @@ -171,8 +179,9 @@ const ( // Values returns all known values for NetworkInterfaceFailureReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceFailureReason) Values() []NetworkInterfaceFailureReason { return []NetworkInterfaceFailureReason{ "DUPLICATE_NETWORK_INTERFACE", @@ -195,8 +204,9 @@ const ( ) // Values returns all known values for NetworkInterfaceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceType) Values() []NetworkInterfaceType { return []NetworkInterfaceType{ "CAN_INTERFACE", @@ -214,8 +224,9 @@ const ( ) // Values returns all known values for NodeDataEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeDataEncoding) Values() []NodeDataEncoding { return []NodeDataEncoding{ "BINARY", @@ -259,8 +270,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -305,8 +317,9 @@ const ( ) // Values returns all known values for RegistrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationStatus) Values() []RegistrationStatus { return []RegistrationStatus{ "REGISTRATION_PENDING", @@ -337,8 +350,9 @@ const ( ) // Values returns all known values for ROS2PrimitiveType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ROS2PrimitiveType) Values() []ROS2PrimitiveType { return []ROS2PrimitiveType{ "BOOL", @@ -382,6 +396,7 @@ const ( // Values returns all known values for SignalDecoderFailureReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SignalDecoderFailureReason) Values() []SignalDecoderFailureReason { return []SignalDecoderFailureReason{ @@ -413,8 +428,9 @@ const ( ) // Values returns all known values for SignalDecoderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignalDecoderType) Values() []SignalDecoderType { return []SignalDecoderType{ "CAN_SIGNAL", @@ -436,8 +452,9 @@ const ( ) // Values returns all known values for SignalNodeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignalNodeType) Values() []SignalNodeType { return []SignalNodeType{ "SENSOR", @@ -458,8 +475,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -477,6 +495,7 @@ const ( // Values returns all known values for StorageCompressionFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StorageCompressionFormat) Values() []StorageCompressionFormat { return []StorageCompressionFormat{ @@ -496,6 +515,7 @@ const ( // Values returns all known values for StructuredMessageListType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StructuredMessageListType) Values() []StructuredMessageListType { return []StructuredMessageListType{ @@ -514,8 +534,9 @@ const ( ) // Values returns all known values for TriggerMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TriggerMode) Values() []TriggerMode { return []TriggerMode{ "ALWAYS", @@ -534,8 +555,9 @@ const ( ) // Values returns all known values for UpdateCampaignAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateCampaignAction) Values() []UpdateCampaignAction { return []UpdateCampaignAction{ "APPROVE", @@ -554,8 +576,9 @@ const ( ) // Values returns all known values for UpdateMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateMode) Values() []UpdateMode { return []UpdateMode{ "Overwrite", @@ -575,6 +598,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -595,6 +619,7 @@ const ( // Values returns all known values for VehicleAssociationBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VehicleAssociationBehavior) Values() []VehicleAssociationBehavior { return []VehicleAssociationBehavior{ @@ -612,6 +637,7 @@ const ( // Values returns all known values for VehicleMiddlewareProtocol. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VehicleMiddlewareProtocol) Values() []VehicleMiddlewareProtocol { return []VehicleMiddlewareProtocol{ @@ -631,8 +657,9 @@ const ( ) // 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. +// expanded in the future, and so 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/types.go b/service/iotfleetwise/types/types.go index 69017e0665b..65f00a32d3a 100644 --- a/service/iotfleetwise/types/types.go +++ b/service/iotfleetwise/types/types.go @@ -9,6 +9,7 @@ import ( // A signal that represents a vehicle device such as the engine, heater, and door // locks. Data from an actuator reports the state of a certain vehicle device. +// // Updating actuator data can change the state of a device. For example, you can // turn on or off the heater by updating its actuator data. type Actuator struct { @@ -126,8 +127,10 @@ type Branch struct { noSmithyDocumentSerde } -// Information about a campaign. You can use the API operation to return this -// information about multiple created campaigns. +// Information about a campaign. +// +// You can use the API operation to return this information about multiple created +// campaigns. type CampaignSummary struct { // The time the campaign was created. @@ -153,13 +156,17 @@ 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. Status CampaignStatus @@ -244,10 +251,12 @@ type CanSignal struct { Offset *float64 // Indicates the beginning of the CAN signal. This should always be the least - // significant bit (LSB). This value might be different from the value in a DBC - // file. For little endian signals, startBit is the same value as in the DBC file. - // For big endian signals in a DBC file, the start bit is the most significant bit - // (MSB). You will have to calculate the LSB instead and pass it as the startBit . + // significant bit (LSB). + // + // This value might be different from the value in a DBC file. For little endian + // signals, startBit is the same value as in the DBC file. For big endian signals + // in a DBC file, the start bit is the most significant bit (MSB). You will have to + // calculate the LSB instead and pass it as the startBit . // // This member is required. StartBit int32 @@ -316,8 +325,9 @@ type ConditionBasedCollectionScheme struct { ConditionLanguageVersion *int32 // The minimum duration of time between two triggering events to collect data, in - // milliseconds. If a signal changes often, you might want to collect data at a - // slower rate. + // milliseconds. + // + // If a signal changes often, you might want to collect data at a slower rate. MinimumTriggerIntervalMs *int64 // Whether to collect data for all triggering events ( ALWAYS ). Specify ( @@ -522,8 +532,9 @@ type DecoderManifestSummary struct { noSmithyDocumentSerde } -// Information about a fleet. You can use the API operation to return this -// information about multiple fleets. +// Information about a fleet. +// +// You can use the API operation to return this information about multiple fleets. type FleetSummary struct { // The Amazon Resource Name (ARN) of the fleet. @@ -557,13 +568,14 @@ type FleetSummary struct { noSmithyDocumentSerde } -// Vehicle Signal Specification (VSS) (https://www.w3.org/auto/wg/wiki/Vehicle_Signal_Specification_(VSS)/Vehicle_Data_Spec) -// is a precise language used to describe and model signals in vehicle networks. +// [Vehicle Signal Specification (VSS)] is a precise language used to describe and model signals in vehicle networks. // The JSON file collects signal specificiations in a VSS format. // // The following types satisfy this interface: // // FormattedVssMemberVssJson +// +// [Vehicle Signal Specification (VSS)]: https://www.w3.org/auto/wg/wiki/Vehicle_Signal_Specification_(VSS)/Vehicle_Data_Spec type FormattedVss interface { isFormattedVss() } @@ -600,8 +612,11 @@ 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] in the Identity and Access Management User Guide. +// +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html type IamResources struct { // The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web @@ -727,9 +742,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. +// 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. @@ -775,8 +791,9 @@ type Node interface { isNode() } -// Information about a node specified as an actuator. An actuator is a digital -// representation of a vehicle device. +// Information about a node specified as an actuator. +// +// An actuator is a digital representation of a vehicle device. type NodeMemberActuator struct { Value Actuator @@ -785,8 +802,9 @@ type NodeMemberActuator struct { func (*NodeMemberActuator) isNode() {} -// Information about a node specified as an attribute. An attribute represents -// static information about a vehicle. +// Information about a node specified as an attribute. +// +// An attribute represents static information about a vehicle. type NodeMemberAttribute struct { Value Attribute @@ -795,8 +813,9 @@ type NodeMemberAttribute struct { func (*NodeMemberAttribute) isNode() {} -// Information about a node specified as a branch. A group of signals that are -// defined in a hierarchical structure. +// Information about a node specified as a branch. +// +// A group of signals that are defined in a hierarchical structure. type NodeMemberBranch struct { Value Branch @@ -815,8 +834,9 @@ type NodeMemberProperty struct { func (*NodeMemberProperty) isNode() {} -// An input component that reports the environmental condition of a vehicle. You -// can collect data about fluid levels, temperatures, vibrations, or battery +// An input component that reports the environmental condition of a vehicle. +// +// You can collect data about fluid levels, temperatures, vibrations, or battery // voltage from sensors. type NodeMemberSensor struct { Value Sensor @@ -988,9 +1008,10 @@ type ROS2PrimitiveMessageDefinition struct { // The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends // data. Amazon S3 is an object storage service that stores data as objects within -// buckets. For more information, see 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. +// buckets. For more information, see [Creating, configuring, and working with Amazon S3 buckets]in the Amazon Simple Storage Service User +// Guide. +// +// [Creating, configuring, and working with Amazon S3 buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html type S3Config struct { // The Amazon Resource Name (ARN) of the Amazon S3 bucket. @@ -1000,21 +1021,26 @@ type S3Config struct { // Specify the format that files are saved in the Amazon S3 bucket. You can save // files in an Apache Parquet or JSON format. + // // - Parquet - Store data in a columnar storage file format. Parquet is optimal // for fast data retrieval and can reduce costs. This option is selected by // default. + // // - JSON - Store data in a standard text-based JSON file format. DataFormat DataFormat // (Optional) Enter an S3 bucket prefix. The prefix is the string of characters // after the bucket name and before the object name. You can use the prefix to - // organize data stored in Amazon S3 buckets. 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. By default, Amazon Web Services - // IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ - // (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it - // to this default prefix. For example, if you enter the prefix vehicles , the - // prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ . + // organize data stored in Amazon S3 buckets. For more information, see [Organizing objects using prefixes]in the + // Amazon Simple Storage Service User Guide. + // + // By default, Amazon Web Services IoT FleetWise sets the prefix + // processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to + // Amazon S3. You can enter a prefix to append it to this default prefix. For + // example, if you enter the prefix vehicles , the prefix will be + // vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ . + // + // [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html Prefix *string // By default, stored data is compressed as a .gzip file. Compressed files have a @@ -1024,8 +1050,9 @@ type S3Config struct { noSmithyDocumentSerde } -// An input component that reports the environmental condition of a vehicle. You -// can collect data about fluid levels, temperatures, vibrations, or battery +// An input component that reports the environmental condition of a vehicle. +// +// You can collect data about fluid levels, temperatures, vibrations, or battery // voltage from sensors. type Sensor struct { @@ -1139,8 +1166,9 @@ type SignalInformation struct { MaxSampleCount *int64 // The minimum duration of time (in milliseconds) between two triggering events to - // collect data. If a signal changes often, you might want to collect data at a - // slower rate. + // collect data. + // + // If a signal changes often, you might want to collect data at a slower rate. MinimumSamplingIntervalMs *int64 noSmithyDocumentSerde @@ -1260,9 +1288,10 @@ type TimeBasedCollectionScheme struct { // The Amazon Timestream table where the Amazon Web Services IoT FleetWise // campaign sends data. Timestream stores and organizes data to optimize query -// processing time and to reduce storage costs. For more information, see Data -// modeling (https://docs.aws.amazon.com/timestream/latest/developerguide/data-modeling.html) -// in the Amazon Timestream Developer Guide. +// processing time and to reduce storage costs. For more information, see [Data modeling]in the +// Amazon Timestream Developer Guide. +// +// [Data modeling]: https://docs.aws.amazon.com/timestream/latest/developerguide/data-modeling.html type TimestreamConfig struct { // The Amazon Resource Name (ARN) of the task execution role that grants Amazon @@ -1353,11 +1382,13 @@ type UpdateVehicleRequestItem struct { // The method the specified attributes will update the existing attributes on the // 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. + // attributes. Or use Merge to combine all attributes. + // + // This is required if attributes are present in the input. AttributeUpdateMode UpdateMode // Static information about a vehicle in a key-value pair. For example: + // // "engineType" : "1.3 L R2" Attributes map[string]string @@ -1425,11 +1456,16 @@ 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. Status VehicleState @@ -1440,8 +1476,10 @@ type VehicleStatus struct { noSmithyDocumentSerde } -// Information about a vehicle. To return this information about vehicles in your -// account, you can use the API operation. +// Information about a vehicle. +// +// To return this information about vehicles in your account, you can use the API +// operation. type VehicleSummary struct { // The Amazon Resource Name (ARN) of the vehicle. @@ -1477,6 +1515,7 @@ type VehicleSummary struct { VehicleName *string // Static information about a vehicle in a key-value pair. For example: + // // "engineType" : "1.3 L R2" Attributes map[string]string diff --git a/service/iotjobsdataplane/api_op_UpdateJobExecution.go b/service/iotjobsdataplane/api_op_UpdateJobExecution.go index 10aaaa2e7b2..052a08d93fc 100644 --- a/service/iotjobsdataplane/api_op_UpdateJobExecution.go +++ b/service/iotjobsdataplane/api_op_UpdateJobExecution.go @@ -66,7 +66,7 @@ type UpdateJobExecutionInput struct { // JobExecutionState data. The default is false. IncludeJobExecutionState *bool - // Optional. A collection of name/value pairs that describe the status of the job + // Optional. A collection of name/value pairs that describe the status of the job // execution. If not specified, the statusDetails are unchanged. StatusDetails map[string]string diff --git a/service/iotjobsdataplane/doc.go b/service/iotjobsdataplane/doc.go index 0f3c2beef82..72580c2cb34 100644 --- a/service/iotjobsdataplane/doc.go +++ b/service/iotjobsdataplane/doc.go @@ -7,13 +7,16 @@ // operations that are sent to and executed on one or more devices connected to AWS // IoT. For example, you can define a job that instructs a set of devices to // download and install application or firmware updates, reboot, rotate -// certificates, or perform remote troubleshooting operations. To create a job, you -// make a job document which is a description of the remote operations to be -// performed, and you specify a list of targets that should perform the operations. -// The targets can be individual things, thing groups or both. AWS IoT Jobs sends a -// message to inform the targets that a job is available. The target starts the -// execution of the job by downloading the job document, performing the operations -// it specifies, and reporting its progress to AWS IoT. The Jobs service provides -// commands to track the progress of a job on a specific target and for all the -// targets of the job +// certificates, or perform remote troubleshooting operations. +// +// To create a job, you make a job document which is a description of the remote +// operations to be performed, and you specify a list of targets that should +// perform the operations. The targets can be individual things, thing groups or +// both. +// +// AWS IoT Jobs sends a message to inform the targets that a job is available. The +// target starts the execution of the job by downloading the job document, +// performing the operations it specifies, and reporting its progress to AWS IoT. +// The Jobs service provides commands to track the progress of a job on a specific +// target and for all the targets of the job package iotjobsdataplane diff --git a/service/iotjobsdataplane/options.go b/service/iotjobsdataplane/options.go index 036fc7d5a3d..eea799c6fd9 100644 --- a/service/iotjobsdataplane/options.go +++ b/service/iotjobsdataplane/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotjobsdataplane/types/enums.go b/service/iotjobsdataplane/types/enums.go index 946f56ee26a..4eaba813164 100644 --- a/service/iotjobsdataplane/types/enums.go +++ b/service/iotjobsdataplane/types/enums.go @@ -17,8 +17,9 @@ const ( ) // Values returns all known values for JobExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobExecutionStatus) Values() []JobExecutionStatus { return []JobExecutionStatus{ "QUEUED", diff --git a/service/iotsecuretunneling/api_op_CloseTunnel.go b/service/iotsecuretunneling/api_op_CloseTunnel.go index 31593d63ec2..b2c5e7e02e6 100644 --- a/service/iotsecuretunneling/api_op_CloseTunnel.go +++ b/service/iotsecuretunneling/api_op_CloseTunnel.go @@ -12,9 +12,11 @@ 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) -// action. +// server so no data can be transmitted. +// +// Requires permission to access the [CloseTunnel] action. +// +// [CloseTunnel]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) CloseTunnel(ctx context.Context, params *CloseTunnelInput, optFns ...func(*Options)) (*CloseTunnelOutput, error) { if params == nil { params = &CloseTunnelInput{} diff --git a/service/iotsecuretunneling/api_op_DescribeTunnel.go b/service/iotsecuretunneling/api_op_DescribeTunnel.go index 2b469f89e97..ac3b5d2e91b 100644 --- a/service/iotsecuretunneling/api_op_DescribeTunnel.go +++ b/service/iotsecuretunneling/api_op_DescribeTunnel.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action. +// Gets information about a tunnel identified by the unique tunnel id. +// +// Requires permission to access the [DescribeTunnel] action. +// +// [DescribeTunnel]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) DescribeTunnel(ctx context.Context, params *DescribeTunnelInput, optFns ...func(*Options)) (*DescribeTunnelOutput, error) { if params == nil { params = &DescribeTunnelInput{} diff --git a/service/iotsecuretunneling/api_op_ListTunnels.go b/service/iotsecuretunneling/api_op_ListTunnels.go index d4fd13b85fa..658c8828bc6 100644 --- a/service/iotsecuretunneling/api_op_ListTunnels.go +++ b/service/iotsecuretunneling/api_op_ListTunnels.go @@ -13,8 +13,11 @@ 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) -// action. +// tunnels. +// +// Requires permission to access the [ListTunnels] action. +// +// [ListTunnels]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) ListTunnels(ctx context.Context, params *ListTunnelsInput, optFns ...func(*Options)) (*ListTunnelsOutput, error) { if params == nil { params = &ListTunnelsInput{} diff --git a/service/iotsecuretunneling/api_op_OpenTunnel.go b/service/iotsecuretunneling/api_op_OpenTunnel.go index ecafb4151db..f5fe95a5527 100644 --- a/service/iotsecuretunneling/api_op_OpenTunnel.go +++ b/service/iotsecuretunneling/api_op_OpenTunnel.go @@ -12,9 +12,11 @@ import ( ) // 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. +// to connect to the IoT Secure Tunneling proxy server. +// +// Requires permission to access the [OpenTunnel] action. +// +// [OpenTunnel]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) OpenTunnel(ctx context.Context, params *OpenTunnelInput, optFns ...func(*Options)) (*OpenTunnelOutput, error) { if params == nil { params = &OpenTunnelInput{} diff --git a/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go b/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go index 798d56ecdd2..4c7857c4c14 100644 --- a/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go +++ b/service/iotsecuretunneling/api_op_RotateTunnelAccessToken.go @@ -12,12 +12,16 @@ import ( ) // 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 -// only be used for the remaining 8 hours. +// to use when reconnecting to secure tunneling to access the same tunnel. +// +// Requires permission to access the [RotateTunnelAccessToken] 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 only be +// used for the remaining 8 hours. +// +// [RotateTunnelAccessToken]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions func (c *Client) RotateTunnelAccessToken(ctx context.Context, params *RotateTunnelAccessTokenInput, optFns ...func(*Options)) (*RotateTunnelAccessTokenOutput, error) { if params == nil { params = &RotateTunnelAccessTokenInput{} diff --git a/service/iotsecuretunneling/doc.go b/service/iotsecuretunneling/doc.go index a17cc7cc4ac..cd2ac1585cc 100644 --- a/service/iotsecuretunneling/doc.go +++ b/service/iotsecuretunneling/doc.go @@ -3,8 +3,12 @@ // Package iotsecuretunneling provides the API client, operations, and parameter // types for AWS IoT Secure Tunneling. // -// 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) -// . +// # 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]. +// +// [IoT Secure Tunneling]: https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html package iotsecuretunneling diff --git a/service/iotsecuretunneling/options.go b/service/iotsecuretunneling/options.go index 25e5ad67504..aaac4d43f5d 100644 --- a/service/iotsecuretunneling/options.go +++ b/service/iotsecuretunneling/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotsecuretunneling/types/enums.go b/service/iotsecuretunneling/types/enums.go index 02eba13c72d..fd4b5ab4cf5 100644 --- a/service/iotsecuretunneling/types/enums.go +++ b/service/iotsecuretunneling/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ClientMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientMode) Values() []ClientMode { return []ClientMode{ "SOURCE", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "CONNECTED", @@ -49,8 +51,9 @@ const ( ) // 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. +// expanded in the future, and so 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/iotsitewise/api_op_AssociateAssets.go b/service/iotsitewise/api_op_AssociateAssets.go index e35d75cee3b..19f51eba7fc 100644 --- a/service/iotsitewise/api_op_AssociateAssets.go +++ b/service/iotsitewise/api_op_AssociateAssets.go @@ -11,9 +11,10 @@ import ( ) // 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. +// defined in the parent asset's model. For more information, see [Associating assets]in the IoT +// SiteWise User Guide. +// +// [Associating assets]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html func (c *Client) AssociateAssets(ctx context.Context, params *AssociateAssetsInput, optFns ...func(*Options)) (*AssociateAssetsOutput, error) { if params == nil { params = &AssociateAssetsInput{} @@ -33,27 +34,30 @@ type AssociateAssetsInput struct { // The ID of the parent asset. This can be either the actual ID in UUID format, or // else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the child asset to be associated. This can be either the actual ID in // UUID format, or else externalId: followed by the external ID, if it has one. - // For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. ChildAssetId *string // The ID of a hierarchy in the parent asset's model. (This can be either the // actual ID in UUID format, or else externalId: followed by the external ID, if - // it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide.) 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) - // in the IoT SiteWise User Guide. + // it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.) + // Hierarchies allow different groupings of assets to be formed that all come from + // the same asset model. For more information, see [Asset hierarchies]in the IoT SiteWise User Guide. + // + // [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. HierarchyId *string diff --git a/service/iotsitewise/api_op_AssociateTimeSeriesToAssetProperty.go b/service/iotsitewise/api_op_AssociateTimeSeriesToAssetProperty.go index f84e1a64c8a..282f64c9a2e 100644 --- a/service/iotsitewise/api_op_AssociateTimeSeriesToAssetProperty.go +++ b/service/iotsitewise/api_op_AssociateTimeSeriesToAssetProperty.go @@ -35,16 +35,18 @@ type AssociateTimeSeriesToAssetPropertyInput struct { // The ID of the asset in which the asset property was created. This can be either // the actual ID in UUID format, or else externalId: followed by the external ID, - // if it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the asset property. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. PropertyId *string diff --git a/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go b/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go index 439f133bff2..aed5fe4991d 100644 --- a/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go +++ b/service/iotsitewise/api_op_BatchGetAssetPropertyAggregates.go @@ -12,8 +12,9 @@ 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) -// in the IoT SiteWise User Guide. +// more asset properties. For more information, see [Querying aggregates]in the IoT SiteWise User Guide. +// +// [Querying aggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates func (c *Client) BatchGetAssetPropertyAggregates(ctx context.Context, params *BatchGetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*BatchGetAssetPropertyAggregatesOutput, error) { if params == nil { params = &BatchGetAssetPropertyAggregatesInput{} @@ -39,7 +40,9 @@ type BatchGetAssetPropertyAggregatesInput 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 equal to 1 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 4000. MaxResults *int32 @@ -204,7 +207,9 @@ var _ BatchGetAssetPropertyAggregatesAPIClient = (*Client)(nil) 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 equal to 1 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 4000. Limit int32 diff --git a/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go b/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go index bfb48f3a9fb..d052869413b 100644 --- a/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go +++ b/service/iotsitewise/api_op_BatchGetAssetPropertyValue.go @@ -12,8 +12,9 @@ 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) -// in the IoT SiteWise User Guide. +// see [Querying current values]in the IoT SiteWise User Guide. +// +// [Querying current values]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values func (c *Client) BatchGetAssetPropertyValue(ctx context.Context, params *BatchGetAssetPropertyValueInput, optFns ...func(*Options)) (*BatchGetAssetPropertyValueOutput, error) { if params == nil { params = &BatchGetAssetPropertyValueInput{} diff --git a/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go b/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go index 75624d909ef..74a0a6d67f7 100644 --- a/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go +++ b/service/iotsitewise/api_op_BatchGetAssetPropertyValueHistory.go @@ -12,8 +12,9 @@ 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) -// in the IoT SiteWise User Guide. +// information, see [Querying historical values]in the IoT SiteWise User Guide. +// +// [Querying historical values]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values func (c *Client) BatchGetAssetPropertyValueHistory(ctx context.Context, params *BatchGetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*BatchGetAssetPropertyValueHistoryOutput, error) { if params == nil { params = &BatchGetAssetPropertyValueHistoryInput{} @@ -39,7 +40,9 @@ type BatchGetAssetPropertyValueHistoryInput 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 equal to 4 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 20000. MaxResults *int32 @@ -204,7 +207,9 @@ var _ BatchGetAssetPropertyValueHistoryAPIClient = (*Client)(nil) 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 equal to 4 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 20000. Limit int32 diff --git a/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go b/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go index 2b11855e4dd..7de291db164 100644 --- a/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go +++ b/service/iotsitewise/api_op_BatchPutAssetPropertyValue.go @@ -12,26 +12,32 @@ 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: +// timestamp-quality-value (TQV) data point. For more information, see [Ingesting data using the API]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) -// . +// alias, see [UpdateAssetProperty]. // // 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) -// in the IoT SiteWise User Guide. +// 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]in the IoT SiteWise User Guide. +// +// [Ingesting data using the API]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html +// [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 +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html func (c *Client) BatchPutAssetPropertyValue(ctx context.Context, params *BatchPutAssetPropertyValueInput, optFns ...func(*Options)) (*BatchPutAssetPropertyValueOutput, error) { if params == nil { params = &BatchPutAssetPropertyValueInput{} diff --git a/service/iotsitewise/api_op_CreateAccessPolicy.go b/service/iotsitewise/api_op_CreateAccessPolicy.go index 7df51f80158..d450146143f 100644 --- a/service/iotsitewise/api_op_CreateAccessPolicy.go +++ b/service/iotsitewise/api_op_CreateAccessPolicy.go @@ -55,8 +55,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -64,9 +65,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} + // The [ARN] of the access policy, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AccessPolicyArn *string diff --git a/service/iotsitewise/api_op_CreateAsset.go b/service/iotsitewise/api_op_CreateAsset.go index 8ab99859653..58755284c7a 100644 --- a/service/iotsitewise/api_op_CreateAsset.go +++ b/service/iotsitewise/api_op_CreateAsset.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IoT SiteWise User Guide. +// Creates an asset from an existing asset model. For more information, see [Creating assets] in +// the IoT SiteWise User Guide. +// +// [Creating assets]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optFns ...func(*Options)) (*CreateAssetOutput, error) { if params == nil { params = &CreateAssetInput{} @@ -33,8 +34,9 @@ type CreateAssetInput struct { // The ID of the asset model from which to create the asset. This can be either // the actual ID in UUID format, or else externalId: followed by the external ID, - // if it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string @@ -48,8 +50,10 @@ type CreateAssetInput struct { AssetDescription *string // An external ID to assign to the asset. The external ID must be unique within - // your Amazon Web Services account. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // your Amazon Web Services account. For more information, see [Using external IDs]in the IoT SiteWise + // User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids AssetExternalId *string // The ID to assign to the asset, if desired. IoT SiteWise automatically generates @@ -64,8 +68,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -73,9 +78,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // The [ARN] of the asset, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssetArn *string diff --git a/service/iotsitewise/api_op_CreateAssetModel.go b/service/iotsitewise/api_op_CreateAssetModel.go index 2b6665e8ce0..a5a3fdb1ee9 100644 --- a/service/iotsitewise/api_op_CreateAssetModel.go +++ b/service/iotsitewise/api_op_CreateAssetModel.go @@ -15,14 +15,18 @@ 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) -// in the IoT SiteWise User Guide. You can create two types of asset models, -// ASSET_MODEL or COMPONENT_MODEL . +// information, see [Defining asset models]in the IoT SiteWise User Guide. +// +// You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL . +// // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. +// // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. +// +// [Defining asset models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html func (c *Client) CreateAssetModel(ctx context.Context, params *CreateAssetModelInput, optFns ...func(*Options)) (*CreateAssetModelOutput, error) { if params == nil { params = &CreateAssetModelInput{} @@ -49,26 +53,33 @@ type CreateAssetModelInput struct { // (such as attributes, measurements, transforms, and metrics) and child composite // models that model parts of your industrial equipment. Each composite model has a // type that defines the properties that the composite model supports. Use - // composite models to define alarms on this asset model. When creating custom - // composite models, you need to use CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html) - // . For more information, see . + // composite models to define alarms on this asset model. + // + // When creating custom composite models, you need to use [CreateAssetModelCompositeModel]. For more information, + // see . + // + // [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html AssetModelCompositeModels []types.AssetModelCompositeModelDefinition // A description for the asset model. AssetModelDescription *string // An external ID to assign to the asset model. The external ID must be unique - // within your Amazon Web Services account. For more information, see Using - // external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // within your Amazon Web Services account. For more information, see [Using external IDs]in the IoT + // SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids AssetModelExternalId *string // 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) - // 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) + // model. For more information, see [Asset hierarchies]in the IoT SiteWise User Guide. + // + // You can specify up to 10 hierarchies per asset model. For more information, see [Quotas] // in the IoT SiteWise User Guide. + // + // [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html AssetModelHierarchies []types.AssetModelHierarchyDefinition // The ID to assign to the asset model, if desired. IoT SiteWise automatically @@ -77,16 +88,21 @@ type CreateAssetModelInput struct { // format. If you specify your own ID, it must be globally unique. AssetModelId *string - // 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) - // 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) + // The property definitions of the asset model. For more information, see [Asset properties] in the + // IoT SiteWise User Guide. + // + // You can specify up to 200 properties per asset model. For more information, see [Quotas] // in the IoT SiteWise User Guide. + // + // [Asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html AssetModelProperties []types.AssetModelPropertyDefinition // The type of asset model. + // // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. + // // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. @@ -98,8 +114,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -107,9 +124,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // The [ARN] of the asset model, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssetModelArn *string diff --git a/service/iotsitewise/api_op_CreateAssetModelCompositeModel.go b/service/iotsitewise/api_op_CreateAssetModelCompositeModel.go index 51ac2389f53..156a05d9f01 100644 --- a/service/iotsitewise/api_op_CreateAssetModelCompositeModel.go +++ b/service/iotsitewise/api_op_CreateAssetModelCompositeModel.go @@ -13,20 +13,26 @@ import ( // Creates a custom composite model from specified property and hierarchy // definitions. There are two types of custom composite models, inline and -// component-model-based . Use component-model-based custom composite models to -// define standard, reusable components. A component-model-based custom composite -// model consists of a name, a description, and the ID of the component model it -// references. A component-model-based custom composite model has no properties of -// its own; its referenced component model provides its associated properties to -// any created assets. For more information, see Custom composite models -// (Components) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html) -// in the IoT SiteWise User Guide. Use inline custom composite models to organize -// the properties of an asset model. The properties of inline custom composite -// models are local to the asset model where they are included and can't be used to -// create multiple assets. To create a component-model-based model, specify the -// composedAssetModelId of an existing asset model with assetModelType of -// COMPONENT_MODEL . To create an inline model, specify the -// assetModelCompositeModelProperties and don't include an composedAssetModelId . +// component-model-based . +// +// Use component-model-based custom composite models to define standard, reusable +// components. A component-model-based custom composite model consists of a name, a +// description, and the ID of the component model it references. A +// component-model-based custom composite model has no properties of its own; its +// referenced component model provides its associated properties to any created +// assets. For more information, see [Custom composite models (Components)]in the IoT SiteWise User Guide. +// +// Use inline custom composite models to organize the properties of an asset +// model. The properties of inline custom composite models are local to the asset +// model where they are included and can't be used to create multiple assets. +// +// To create a component-model-based model, specify the composedAssetModelId of an +// existing asset model with assetModelType of COMPONENT_MODEL . +// +// To create an inline model, specify the assetModelCompositeModelProperties and +// don't include an composedAssetModelId . +// +// [Custom composite models (Components)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html func (c *Client) CreateAssetModelCompositeModel(ctx context.Context, params *CreateAssetModelCompositeModelInput, optFns ...func(*Options)) (*CreateAssetModelCompositeModelOutput, error) { if params == nil { params = &CreateAssetModelCompositeModelInput{} @@ -63,10 +69,12 @@ type CreateAssetModelCompositeModelInput struct { // A description for the composite model. AssetModelCompositeModelDescription *string - // An external ID to assign to the composite model. If the composite model is a - // derived composite model, or one nested inside a component model, you can only - // set the external ID using UpdateAssetModelCompositeModel and specifying the - // derived ID of the model or property from the created model it's a part of. + // An external ID to assign to the composite model. + // + // If the composite model is a derived composite model, or one nested inside a + // component model, you can only set the external ID using + // UpdateAssetModelCompositeModel and specifying the derived ID of the model or + // property from the created model it's a part of. AssetModelCompositeModelExternalId *string // The ID of the composite model. IoT SiteWise automatically generates a unique ID @@ -76,9 +84,11 @@ type CreateAssetModelCompositeModelInput struct { AssetModelCompositeModelId *string // The property definitions of the composite model. For more information, see . + // // You can specify up to 200 properties per composite model. For more information, - // see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) - // in the IoT SiteWise User Guide. + // see [Quotas]in the IoT SiteWise User Guide. + // + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html AssetModelCompositeModelProperties []types.AssetModelPropertyDefinition // A unique case-sensitive identifier that you can provide to ensure the @@ -109,8 +119,9 @@ type CreateAssetModelCompositeModelOutput struct { AssetModelCompositeModelPath []types.AssetModelCompositeModelPathSegment // 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) - // in the IoT SiteWise User Guide. + // see [Asset and model states]in the IoT SiteWise User Guide. + // + // [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html // // This member is required. AssetModelStatus *types.AssetModelStatus diff --git a/service/iotsitewise/api_op_CreateBulkImportJob.go b/service/iotsitewise/api_op_CreateBulkImportJob.go index 845fdc301e8..efcb876e37a 100644 --- a/service/iotsitewise/api_op_CreateBulkImportJob.go +++ b/service/iotsitewise/api_op_CreateBulkImportJob.go @@ -12,12 +12,17 @@ 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) -// in the Amazon Simple Storage Service User Guide. Before you create a bulk import -// job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more -// information about how to configure storage settings, see PutStorageConfiguration (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html) -// . Bulk import is designed to store historical data to IoT SiteWise. It does not +// information, see [Create a bulk import job (CLI)]in the Amazon Simple Storage Service User Guide. +// +// Before you create a bulk import job, you must enable IoT SiteWise warm tier or +// IoT SiteWise cold tier. For more information about how to configure storage +// settings, see [PutStorageConfiguration]. +// +// Bulk import is designed to store historical data to IoT SiteWise. It does not // trigger computations or notifications on IoT SiteWise warm or cold tier storage. +// +// [Create a bulk import job (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html +// [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{} @@ -57,8 +62,9 @@ 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] of the IAM role that allows IoT SiteWise to read Amazon S3 data. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. JobRoleArn *string @@ -88,15 +94,21 @@ 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. diff --git a/service/iotsitewise/api_op_CreateDashboard.go b/service/iotsitewise/api_op_CreateDashboard.go index da8fe5b33f2..ab848201461 100644 --- a/service/iotsitewise/api_op_CreateDashboard.go +++ b/service/iotsitewise/api_op_CreateDashboard.go @@ -29,8 +29,9 @@ 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) - // in the IoT SiteWise User Guide. + // see [Creating dashboards (CLI)]in the IoT SiteWise User Guide. + // + // [Creating dashboards (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html // // This member is required. DashboardDefinition *string @@ -54,8 +55,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -63,9 +65,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} + // The [ARN] of the dashboard, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. DashboardArn *string diff --git a/service/iotsitewise/api_op_CreateGateway.go b/service/iotsitewise/api_op_CreateGateway.go index 396d0516847..69daa773896 100644 --- a/service/iotsitewise/api_op_CreateGateway.go +++ b/service/iotsitewise/api_op_CreateGateway.go @@ -12,9 +12,10 @@ 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) -// in the IoT SiteWise User Guide. +// data streams from local servers to IoT SiteWise. For more information, see [Ingesting data using a gateway]in +// the IoT SiteWise User Guide. +// +// [Ingesting data using a gateway]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html func (c *Client) CreateGateway(ctx context.Context, params *CreateGatewayInput, optFns ...func(*Options)) (*CreateGatewayOutput, error) { if params == nil { params = &CreateGatewayInput{} @@ -43,8 +44,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -52,9 +54,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} + // The [ARN] of the gateway, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. GatewayArn *string diff --git a/service/iotsitewise/api_op_CreatePortal.go b/service/iotsitewise/api_op_CreatePortal.go index 38f445e482d..9ab4ade01bd 100644 --- a/service/iotsitewise/api_op_CreatePortal.go +++ b/service/iotsitewise/api_op_CreatePortal.go @@ -13,10 +13,12 @@ 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) -// in the IoT SiteWise User Guide. +// 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]in the IoT SiteWise User Guide. +// +// [Adding or removing portal administrators]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins func (c *Client) CreatePortal(ctx context.Context, params *CreatePortalInput, optFns ...func(*Options)) (*CreatePortalOutput, error) { if params == nil { params = &CreatePortalInput{} @@ -44,11 +46,12 @@ 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 - // 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) - // in the IoT SiteWise User Guide. + // The [ARN] 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]in the IoT + // SiteWise User Guide. + // + // [Using service roles for IoT SiteWise Monitor]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. RoleArn *string @@ -56,8 +59,9 @@ 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) - // in the IoT SiteWise Application Guide. + // information, see [Monitoring with alarms]in the IoT SiteWise Application Guide. + // + // [Monitoring with alarms]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html Alarms *types.Alarms // A unique case-sensitive identifier that you can provide to ensure the @@ -65,23 +69,31 @@ type CreatePortalInput struct { // request is required. 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) - // . + // The email address that sends alarm notifications. + // + // If you use the [IoT Events managed Lambda function] to manage your emails, you must [verify the sender email address in Amazon SES]. + // + // [IoT Events managed Lambda function]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html + // [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 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. + // you must enable IAM Identity Center. For more information, see [Enabling IAM Identity Center]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 + // + // You can't change this value after you create a portal. + // + // Default: SSO + // + // [Enabling IAM Identity Center]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso PortalAuthMode types.AuthMode // A description for the portal. @@ -92,8 +104,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -101,9 +114,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} + // The [ARN] of the portal, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PortalArn *string diff --git a/service/iotsitewise/api_op_CreateProject.go b/service/iotsitewise/api_op_CreateProject.go index be257113614..dc72ec655e9 100644 --- a/service/iotsitewise/api_op_CreateProject.go +++ b/service/iotsitewise/api_op_CreateProject.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a project in the specified portal. Make sure that the project name and -// description don't contain confidential information. +// Creates a project in the specified portal. +// +// Make sure that the project name and description don't contain confidential +// information. func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error) { if params == nil { params = &CreateProjectInput{} @@ -48,8 +50,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string noSmithyDocumentSerde @@ -57,9 +60,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + // The [ARN] of the project, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ProjectArn *string diff --git a/service/iotsitewise/api_op_DeleteAsset.go b/service/iotsitewise/api_op_DeleteAsset.go index f290e4adbf1..e5410614d38 100644 --- a/service/iotsitewise/api_op_DeleteAsset.go +++ b/service/iotsitewise/api_op_DeleteAsset.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// . +// Deletes an asset. This action can't be undone. For more information, see [Deleting assets and models] in +// the IoT SiteWise User Guide. +// +// You can't delete an asset that's associated to another asset. For more +// information, see [DisassociateAssets]. +// +// [DisassociateAssets]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html +// [Deleting assets and models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error) { if params == nil { params = &DeleteAssetInput{} @@ -35,8 +38,9 @@ type DeleteAssetInput struct { // The ID of the asset to delete. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string diff --git a/service/iotsitewise/api_op_DeleteAssetModel.go b/service/iotsitewise/api_op_DeleteAssetModel.go index 2a544c02404..80906923973 100644 --- a/service/iotsitewise/api_op_DeleteAssetModel.go +++ b/service/iotsitewise/api_op_DeleteAssetModel.go @@ -15,8 +15,9 @@ 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) -// in the IoT SiteWise User Guide. +// more information, see [Deleting assets and models]in the IoT SiteWise User Guide. +// +// [Deleting assets and models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html func (c *Client) DeleteAssetModel(ctx context.Context, params *DeleteAssetModelInput, optFns ...func(*Options)) (*DeleteAssetModelOutput, error) { if params == nil { params = &DeleteAssetModelInput{} @@ -36,8 +37,9 @@ type DeleteAssetModelInput struct { // The ID of the asset model to delete. This can be either the actual ID in UUID // format, or else externalId: followed by the external ID, if it has one. For - // more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string diff --git a/service/iotsitewise/api_op_DeleteAssetModelCompositeModel.go b/service/iotsitewise/api_op_DeleteAssetModelCompositeModel.go index 6c45bfbd5e9..d995310606f 100644 --- a/service/iotsitewise/api_op_DeleteAssetModelCompositeModel.go +++ b/service/iotsitewise/api_op_DeleteAssetModelCompositeModel.go @@ -15,8 +15,9 @@ import ( // assets created from a composite model before you can delete the model. Also, you // can't delete a composite 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) -// in the IoT SiteWise User Guide. +// delete. For more information, see [Deleting assets and models]in the IoT SiteWise User Guide. +// +// [Deleting assets and models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html func (c *Client) DeleteAssetModelCompositeModel(ctx context.Context, params *DeleteAssetModelCompositeModelInput, optFns ...func(*Options)) (*DeleteAssetModelCompositeModelOutput, error) { if params == nil { params = &DeleteAssetModelCompositeModelInput{} @@ -55,8 +56,9 @@ type DeleteAssetModelCompositeModelInput struct { type DeleteAssetModelCompositeModelOutput struct { // 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) - // in the IoT SiteWise User Guide. + // see [Asset and model states]in the IoT SiteWise User Guide. + // + // [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html // // This member is required. AssetModelStatus *types.AssetModelStatus diff --git a/service/iotsitewise/api_op_DeleteTimeSeries.go b/service/iotsitewise/api_op_DeleteTimeSeries.go index 7af8493266c..489e87f1a21 100644 --- a/service/iotsitewise/api_op_DeleteTimeSeries.go +++ b/service/iotsitewise/api_op_DeleteTimeSeries.go @@ -12,13 +12,18 @@ import ( // Deletes a time series (data stream). If you delete a time series that's // 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: +// 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. func (c *Client) DeleteTimeSeries(ctx context.Context, params *DeleteTimeSeriesInput, optFns ...func(*Options)) (*DeleteTimeSeriesOutput, error) { if params == nil { @@ -42,8 +47,9 @@ type DeleteTimeSeriesInput struct { // The ID of the asset in which the asset property was created. This can be either // the actual ID in UUID format, or else externalId: followed by the external ID, - // if it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references AssetId *string // A unique case-sensitive identifier that you can provide to ensure the @@ -53,8 +59,9 @@ type DeleteTimeSeriesInput struct { // The ID of the asset property. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references PropertyId *string noSmithyDocumentSerde diff --git a/service/iotsitewise/api_op_DescribeAccessPolicy.go b/service/iotsitewise/api_op_DescribeAccessPolicy.go index 207936d3b96..59394880e19 100644 --- a/service/iotsitewise/api_op_DescribeAccessPolicy.go +++ b/service/iotsitewise/api_op_DescribeAccessPolicy.go @@ -41,9 +41,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} + // The [ARN] of the access policy, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AccessPolicyArn *string diff --git a/service/iotsitewise/api_op_DescribeAsset.go b/service/iotsitewise/api_op_DescribeAsset.go index 3f8ee6e5bcb..4f5fe11af9d 100644 --- a/service/iotsitewise/api_op_DescribeAsset.go +++ b/service/iotsitewise/api_op_DescribeAsset.go @@ -36,13 +36,14 @@ type DescribeAssetInput struct { // The ID of the asset. This can be either the actual ID in UUID format, or else // externalId: followed by the external ID, if it has one. For more information, - // see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string - // Whether or not to exclude asset properties from the response. + // Whether or not to exclude asset properties from the response. ExcludeProperties bool noSmithyDocumentSerde @@ -50,9 +51,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // The [ARN] of the asset, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssetArn *string @@ -88,9 +91,10 @@ type DescribeAssetOutput struct { // This member is required. AssetName *string - // The list of asset properties for the asset. This object doesn't include - // properties that you define in composite models. You can find composite model - // properties in the assetCompositeModels object. + // The list of asset properties for the asset. + // + // This object doesn't include properties that you define in composite models. You + // can find composite model properties in the assetCompositeModels object. // // This member is required. AssetProperties []types.AssetProperty @@ -266,12 +270,13 @@ type AssetActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAssetInput, *DescribeAssetOutput, error) (bool, error) } @@ -454,12 +459,13 @@ type AssetNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAssetInput, *DescribeAssetOutput, error) (bool, error) } diff --git a/service/iotsitewise/api_op_DescribeAssetCompositeModel.go b/service/iotsitewise/api_op_DescribeAssetCompositeModel.go index 65af47a6411..034b82729a2 100644 --- a/service/iotsitewise/api_op_DescribeAssetCompositeModel.go +++ b/service/iotsitewise/api_op_DescribeAssetCompositeModel.go @@ -13,9 +13,9 @@ import ( // Retrieves information about an asset composite model (also known as an asset // component). An AssetCompositeModel is an instance of an AssetModelCompositeModel -// . If you want to see information about the model this is based on, call -// DescribeAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html) -// . +// . If you want to see information about the model this is based on, call [DescribeAssetModelCompositeModel]. +// +// [DescribeAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html func (c *Client) DescribeAssetCompositeModel(ctx context.Context, params *DescribeAssetCompositeModelInput, optFns ...func(*Options)) (*DescribeAssetCompositeModelOutput, error) { if params == nil { params = &DescribeAssetCompositeModelInput{} @@ -35,16 +35,18 @@ type DescribeAssetCompositeModelInput struct { // The ID of a composite model on this asset. This can be either the actual ID in // UUID format, or else externalId: followed by the external ID, if it has one. - // For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetCompositeModelId *string // The ID of the asset. This can be either the actual ID in UUID format, or else // externalId: followed by the external ID, if it has one. For more information, - // see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string @@ -100,10 +102,12 @@ type DescribeAssetCompositeModelOutput struct { // The available actions for a composite model on this asset. ActionDefinitions []types.ActionDefinition - // An external ID to assign to the asset model. If the composite model is a - // component-based composite model, or one nested inside a component model, you can - // only set the external ID using UpdateAssetModelCompositeModel and specifying - // the derived ID of the model or property from the created model it's a part of. + // An external ID to assign to the asset model. + // + // If the composite model is a component-based composite model, or one nested + // inside a component model, you can only set the external ID using + // UpdateAssetModelCompositeModel and specifying the derived ID of the model or + // property from the created model it's a part of. AssetCompositeModelExternalId *string // Metadata pertaining to the operation's result. diff --git a/service/iotsitewise/api_op_DescribeAssetModel.go b/service/iotsitewise/api_op_DescribeAssetModel.go index 8df40619c0b..ba9eeeadd22 100644 --- a/service/iotsitewise/api_op_DescribeAssetModel.go +++ b/service/iotsitewise/api_op_DescribeAssetModel.go @@ -36,13 +36,14 @@ type DescribeAssetModelInput struct { // The ID of the asset model. This can be either the actual ID in UUID format, or // else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string - // Whether or not to exclude asset model properties from the response. + // Whether or not to exclude asset model properties from the response. ExcludeProperties bool noSmithyDocumentSerde @@ -50,9 +51,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // The [ARN] of the asset model, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssetModelArn *string @@ -89,9 +92,10 @@ type DescribeAssetModelOutput struct { // This member is required. AssetModelName *string - // The list of asset properties for the asset model. This object doesn't include - // properties that you define in composite models. You can find composite model - // properties in the assetModelCompositeModels object. + // The list of asset properties for the asset model. + // + // This object doesn't include properties that you define in composite models. You + // can find composite model properties in the assetModelCompositeModels object. // // This member is required. AssetModelProperties []types.AssetModelProperty @@ -114,8 +118,10 @@ type DescribeAssetModelOutput struct { AssetModelExternalId *string // The type of asset model. + // // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. + // // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. @@ -276,12 +282,13 @@ type AssetModelActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAssetModelInput, *DescribeAssetModelOutput, error) (bool, error) } @@ -467,12 +474,13 @@ type AssetModelNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAssetModelInput, *DescribeAssetModelOutput, error) (bool, error) } diff --git a/service/iotsitewise/api_op_DescribeAssetModelCompositeModel.go b/service/iotsitewise/api_op_DescribeAssetModelCompositeModel.go index 83a3e845f89..ee03eb6d417 100644 --- a/service/iotsitewise/api_op_DescribeAssetModelCompositeModel.go +++ b/service/iotsitewise/api_op_DescribeAssetModelCompositeModel.go @@ -12,9 +12,10 @@ import ( ) // Retrieves information about an asset model composite model (also known as an -// asset model component). For more information, see Custom composite models -// (Components) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html) -// in the IoT SiteWise User Guide. +// asset model component). For more information, see [Custom composite models (Components)]in the IoT SiteWise User +// Guide. +// +// [Custom composite models (Components)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html func (c *Client) DescribeAssetModelCompositeModel(ctx context.Context, params *DescribeAssetModelCompositeModelInput, optFns ...func(*Options)) (*DescribeAssetModelCompositeModelOutput, error) { if params == nil { params = &DescribeAssetModelCompositeModelInput{} @@ -34,16 +35,18 @@ type DescribeAssetModelCompositeModelInput struct { // The ID of a composite model on this asset model. This can be either the actual // ID in UUID format, or else externalId: followed by the external ID, if it has - // one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelCompositeModelId *string // The ID of the asset model. This can be either the actual ID in UUID format, or // else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string @@ -101,9 +104,10 @@ type DescribeAssetModelCompositeModelOutput struct { AssetModelCompositeModelExternalId *string // Metadata for the composition relationship established by using - // composedAssetModelId in CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html) - // . For instance, an array detailing the path of the composition relationship for - // this composite model. + // composedAssetModelId in [CreateAssetModelCompositeModel]CreateAssetModelCompositeModel . For instance, an array + // detailing the path of the composition relationship for this composite model. + // + // [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html CompositionDetails *types.CompositionDetails // Metadata pertaining to the operation's result. diff --git a/service/iotsitewise/api_op_DescribeAssetProperty.go b/service/iotsitewise/api_op_DescribeAssetProperty.go index 5f0a0ff725f..231fc7b3eaf 100644 --- a/service/iotsitewise/api_op_DescribeAssetProperty.go +++ b/service/iotsitewise/api_op_DescribeAssetProperty.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about an asset property. When you call this operation for -// an attribute property, this response includes the default attribute value that -// 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) -// . +// Retrieves information about an asset property. +// +// When you call this operation for an attribute property, this response includes +// the default attribute value that 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]. +// +// [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{} @@ -37,16 +41,18 @@ type DescribeAssetPropertyInput struct { // The ID of the asset. This can be either the actual ID in UUID format, or else // externalId: followed by the external ID, if it has one. For more information, - // see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the asset property. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. PropertyId *string @@ -71,14 +77,17 @@ type DescribeAssetPropertyOutput struct { // This member is required. AssetName *string - // The external ID of the asset. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset. For more information, see [Using external IDs] in the IoT SiteWise + // User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids AssetExternalId *string - // 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 . + // 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 . AssetProperty *types.Property // The composite model that declares this asset property, if this asset property diff --git a/service/iotsitewise/api_op_DescribeBulkImportJob.go b/service/iotsitewise/api_op_DescribeBulkImportJob.go index 848fe4c15ae..f5451109a23 100644 --- a/service/iotsitewise/api_op_DescribeBulkImportJob.go +++ b/service/iotsitewise/api_op_DescribeBulkImportJob.go @@ -13,8 +13,9 @@ import ( ) // 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. +// see [Describe a bulk import job (CLI)]in the Amazon Simple Storage Service User Guide. +// +// [Describe a bulk import job (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html func (c *Client) DescribeBulkImportJob(ctx context.Context, params *DescribeBulkImportJobInput, optFns ...func(*Options)) (*DescribeBulkImportJobOutput, error) { if params == nil { params = &DescribeBulkImportJobInput{} @@ -79,22 +80,29 @@ 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] of the IAM role that allows IoT SiteWise to read Amazon S3 data. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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. diff --git a/service/iotsitewise/api_op_DescribeDashboard.go b/service/iotsitewise/api_op_DescribeDashboard.go index 7484b6fb0f0..e032d6d042c 100644 --- a/service/iotsitewise/api_op_DescribeDashboard.go +++ b/service/iotsitewise/api_op_DescribeDashboard.go @@ -39,9 +39,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} + // The [ARN] of the dashboard, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. DashboardArn *string @@ -51,9 +53,10 @@ type DescribeDashboardOutput struct { // This member is required. 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) - // in the IoT SiteWise User Guide. + // The dashboard's definition JSON literal. For detailed information, see [Creating dashboards (CLI)] in the + // IoT SiteWise User Guide. + // + // [Creating dashboards (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html // // This member is required. DashboardDefinition *string diff --git a/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go b/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go index f135f180aef..12d68c7bb3b 100644 --- a/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go +++ b/service/iotsitewise/api_op_DescribeDefaultEncryptionConfiguration.go @@ -13,8 +13,9 @@ 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) -// in the IoT SiteWise User Guide. +// see [Key management]in the IoT SiteWise User Guide. +// +// [Key management]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html func (c *Client) DescribeDefaultEncryptionConfiguration(ctx context.Context, params *DescribeDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*DescribeDefaultEncryptionConfigurationOutput, error) { if params == nil { params = &DescribeDefaultEncryptionConfigurationInput{} diff --git a/service/iotsitewise/api_op_DescribeGateway.go b/service/iotsitewise/api_op_DescribeGateway.go index 532fbe7e51e..ef2886ce625 100644 --- a/service/iotsitewise/api_op_DescribeGateway.go +++ b/service/iotsitewise/api_op_DescribeGateway.go @@ -45,18 +45,20 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} + // The [ARN] of the gateway, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // . + // retrieve a capability configuration's definition, use [DescribeGatewayCapabilityConfiguration]. + // + // [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 e89dfa790cf..f2b7ee939d3 100644 --- a/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go +++ b/service/iotsitewise/api_op_DescribeGatewayCapabilityConfiguration.go @@ -16,8 +16,9 @@ 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]. +// +// [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{} @@ -54,8 +55,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Configuring data sources (CLI)]in the IoT SiteWise User Guide. + // + // [Configuring data sources (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli // // This member is required. CapabilityConfiguration *string @@ -67,8 +69,11 @@ 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. // // This member is required. diff --git a/service/iotsitewise/api_op_DescribePortal.go b/service/iotsitewise/api_op_DescribePortal.go index 30cdd5dc268..72283b7da08 100644 --- a/service/iotsitewise/api_op_DescribePortal.go +++ b/service/iotsitewise/api_op_DescribePortal.go @@ -44,9 +44,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} + // The [ARN] of the portal, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PortalArn *string @@ -112,11 +114,12 @@ 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 - // 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) - // in the IoT SiteWise User Guide. + // The [ARN] 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]in the IoT + // SiteWise User Guide. + // + // [Using service roles for IoT SiteWise Monitor]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html RoleArn *string // Metadata pertaining to the operation's result. @@ -274,12 +277,13 @@ type PortalActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribePortalInput, *DescribePortalOutput, error) (bool, error) } @@ -445,12 +449,13 @@ type PortalNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribePortalInput, *DescribePortalOutput, error) (bool, error) } diff --git a/service/iotsitewise/api_op_DescribeProject.go b/service/iotsitewise/api_op_DescribeProject.go index c1ff27d49e1..6f730384c8d 100644 --- a/service/iotsitewise/api_op_DescribeProject.go +++ b/service/iotsitewise/api_op_DescribeProject.go @@ -44,9 +44,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + // The [ARN] of the project, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ProjectArn *string diff --git a/service/iotsitewise/api_op_DescribeStorageConfiguration.go b/service/iotsitewise/api_op_DescribeStorageConfiguration.go index c5aef2ed064..97a0764a678 100644 --- a/service/iotsitewise/api_op_DescribeStorageConfiguration.go +++ b/service/iotsitewise/api_op_DescribeStorageConfiguration.go @@ -41,8 +41,10 @@ type DescribeStorageConfigurationOutput 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. // @@ -52,13 +54,18 @@ type DescribeStorageConfigurationOutput struct { // 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. + // 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. + // + // For more information, see [Data streams] in the IoT SiteWise User Guide. + // + // [Data streams]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html 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 e6f00efc587..6f6b89164dc 100644 --- a/service/iotsitewise/api_op_DescribeTimeSeries.go +++ b/service/iotsitewise/api_op_DescribeTimeSeries.go @@ -12,13 +12,18 @@ import ( "time" ) -// Retrieves information about a time series (data stream). To identify a time -// series, do one of the following: +// 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. func (c *Client) DescribeTimeSeries(ctx context.Context, params *DescribeTimeSeriesInput, optFns ...func(*Options)) (*DescribeTimeSeriesOutput, error) { if params == nil { @@ -42,14 +47,16 @@ type DescribeTimeSeriesInput struct { // The ID of the asset in which the asset property was created. This can be either // the actual ID in UUID format, or else externalId: followed by the external ID, - // if it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references AssetId *string // The ID of the asset property. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references PropertyId *string noSmithyDocumentSerde @@ -57,15 +64,19 @@ type DescribeTimeSeriesInput struct { type DescribeTimeSeriesOutput struct { - // 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. + // 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} + // The [ARN] of the time series, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. TimeSeriesArn *string @@ -92,10 +103,11 @@ type DescribeTimeSeriesOutput struct { AssetId *string // 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. + // 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. DataTypeSpec *string // The ID of the asset property, in UUID format. diff --git a/service/iotsitewise/api_op_DisassociateAssets.go b/service/iotsitewise/api_op_DisassociateAssets.go index 4a439f02098..b3993e54ef1 100644 --- a/service/iotsitewise/api_op_DisassociateAssets.go +++ b/service/iotsitewise/api_op_DisassociateAssets.go @@ -31,29 +31,32 @@ type DisassociateAssetsInput struct { // The ID of the parent asset from which to disassociate the child asset. This can // be either the actual ID in UUID format, or else externalId: followed by the - // external ID, if it has one. For more information, see Referencing objects with - // external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User + // Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the child asset to disassociate. This can be either the actual ID in // UUID format, or else externalId: followed by the external ID, if it has one. - // For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. ChildAssetId *string // The ID of a hierarchy in the parent asset's model. (This can be either the // actual ID in UUID format, or else externalId: followed by the external ID, if - // it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide.) 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) - // in the IoT SiteWise User Guide. + // it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.) + // 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]in the IoT SiteWise User Guide. + // + // [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. HierarchyId *string diff --git a/service/iotsitewise/api_op_DisassociateTimeSeriesFromAssetProperty.go b/service/iotsitewise/api_op_DisassociateTimeSeriesFromAssetProperty.go index 27834c27ce4..52b61ddacd5 100644 --- a/service/iotsitewise/api_op_DisassociateTimeSeriesFromAssetProperty.go +++ b/service/iotsitewise/api_op_DisassociateTimeSeriesFromAssetProperty.go @@ -35,16 +35,18 @@ type DisassociateTimeSeriesFromAssetPropertyInput struct { // The ID of the asset in which the asset property was created. This can be either // the actual ID in UUID format, or else externalId: followed by the external ID, - // if it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the asset property. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. PropertyId *string diff --git a/service/iotsitewise/api_op_GetAssetPropertyAggregates.go b/service/iotsitewise/api_op_GetAssetPropertyAggregates.go index aef4af70d82..0de6c581c8d 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyAggregates.go +++ b/service/iotsitewise/api_op_GetAssetPropertyAggregates.go @@ -12,15 +12,19 @@ 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) -// in the IoT SiteWise User Guide. To identify an asset property, you must specify -// one of the following: +// Gets aggregated values for an asset property. For more information, see [Querying 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) -// . +// alias, see [UpdateAssetProperty]. +// +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html +// [Querying aggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates func (c *Client) GetAssetPropertyAggregates(ctx context.Context, params *GetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*GetAssetPropertyAggregatesOutput, error) { if params == nil { params = &GetAssetPropertyAggregatesInput{} @@ -65,7 +69,9 @@ type GetAssetPropertyAggregatesInput 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 equal to 1 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 2500. MaxResults *int32 @@ -75,8 +81,9 @@ type GetAssetPropertyAggregatesInput 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. @@ -85,7 +92,9 @@ type GetAssetPropertyAggregatesInput struct { // The quality by which to filter asset data. Qualities []types.Quality - // The chronological sorting order of the requested information. Default: ASCENDING + // The chronological sorting order of the requested information. + // + // Default: ASCENDING TimeOrdering types.TimeOrdering noSmithyDocumentSerde @@ -230,7 +239,9 @@ var _ GetAssetPropertyAggregatesAPIClient = (*Client)(nil) type GetAssetPropertyAggregatesPaginatorOptions 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 equal to 1 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 2500. Limit int32 diff --git a/service/iotsitewise/api_op_GetAssetPropertyValue.go b/service/iotsitewise/api_op_GetAssetPropertyValue.go index e8852242db8..0e27d989c7b 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyValue.go +++ b/service/iotsitewise/api_op_GetAssetPropertyValue.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the IoT SiteWise User Guide. To identify an asset property, you must specify -// one of the following: +// Gets an asset property's current value. For more information, see [Querying 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) -// . +// alias, see [UpdateAssetProperty]. +// +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html +// [Querying current values]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values func (c *Client) GetAssetPropertyValue(ctx context.Context, params *GetAssetPropertyValueInput, optFns ...func(*Options)) (*GetAssetPropertyValueOutput, error) { if params == nil { params = &GetAssetPropertyValueInput{} @@ -42,8 +46,9 @@ type GetAssetPropertyValueInput 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. diff --git a/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go b/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go index 1d92b97a7af..c0860b5e946 100644 --- a/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go +++ b/service/iotsitewise/api_op_GetAssetPropertyValueHistory.go @@ -12,15 +12,19 @@ import ( "time" ) -// 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) -// in the IoT SiteWise User Guide. To identify an asset property, you must specify -// one of the following: +// Gets the history of an asset property's values. For more information, see [Querying 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) -// . +// alias, see [UpdateAssetProperty]. +// +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html +// [Querying historical values]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values func (c *Client) GetAssetPropertyValueHistory(ctx context.Context, params *GetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*GetAssetPropertyValueHistoryOutput, error) { if params == nil { params = &GetAssetPropertyValueHistoryInput{} @@ -47,7 +51,9 @@ type GetAssetPropertyValueHistoryInput 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 equal to 4 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 20000. MaxResults *int32 @@ -57,8 +63,9 @@ type GetAssetPropertyValueHistoryInput 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. @@ -71,7 +78,9 @@ type GetAssetPropertyValueHistoryInput struct { // in seconds in Unix epoch time. StartDate *time.Time - // The chronological sorting order of the requested information. Default: ASCENDING + // The chronological sorting order of the requested information. + // + // Default: ASCENDING TimeOrdering types.TimeOrdering noSmithyDocumentSerde @@ -213,7 +222,9 @@ var _ GetAssetPropertyValueHistoryAPIClient = (*Client)(nil) type GetAssetPropertyValueHistoryPaginatorOptions 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 equal to 4 MB. + // // - The number of data points in the result set is equal to the value of // maxResults . The maximum value of maxResults is 20000. Limit int32 diff --git a/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go b/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go index ee7a191ee1f..f6b4e27b6a5 100644 --- a/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go +++ b/service/iotsitewise/api_op_GetInterpolatedAssetPropertyValues.go @@ -14,14 +14,19 @@ import ( // Get interpolated values for an asset property for a specified time interval, // during a period of time. If your time series is missing data points during the // specified time interval, you can use interpolation to estimate the missing data. +// // 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: +// 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) -// . +// alias, see [UpdateAssetProperty]. +// +// [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{} @@ -63,23 +68,33 @@ 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 + // The interpolation type. + // + // Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION + // + // - LINEAR_INTERPOLATION – Estimates missing data using [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. + // 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. + // + // [linear interpolation]: https://en.wikipedia.org/wiki/Linear_interpolation // // This member is required. Type *string @@ -95,11 +110,14 @@ 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 @@ -118,8 +136,9 @@ type GetInterpolatedAssetPropertyValuesInput 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. diff --git a/service/iotsitewise/api_op_ListAccessPolicies.go b/service/iotsitewise/api_op_ListAccessPolicies.go index 11e8ce1a267..80cf41d0689 100644 --- a/service/iotsitewise/api_op_ListAccessPolicies.go +++ b/service/iotsitewise/api_op_ListAccessPolicies.go @@ -31,9 +31,10 @@ 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] in the IAM User Guide. This + // parameter is required if you specify IAM for identityType . + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html IamArn *string // The ID of the identity. This parameter is required if you specify USER or GROUP @@ -44,7 +45,9 @@ type ListAccessPoliciesInput struct { // 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 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -194,7 +197,9 @@ var _ ListAccessPoliciesAPIClient = (*Client)(nil) // ListAccessPoliciesPaginatorOptions is the paginator options for // ListAccessPolicies type ListAccessPoliciesPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListAssetModelCompositeModels.go b/service/iotsitewise/api_op_ListAssetModelCompositeModels.go index 367f8e6618f..36df70d64a3 100644 --- a/service/iotsitewise/api_op_ListAssetModelCompositeModels.go +++ b/service/iotsitewise/api_op_ListAssetModelCompositeModels.go @@ -31,13 +31,16 @@ type ListAssetModelCompositeModelsInput struct { // The ID of the asset model. This can be either the actual ID in UUID format, or // else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -183,7 +186,9 @@ var _ ListAssetModelCompositeModelsAPIClient = (*Client)(nil) // ListAssetModelCompositeModelsPaginatorOptions is the paginator options for // ListAssetModelCompositeModels type ListAssetModelCompositeModelsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListAssetModelProperties.go b/service/iotsitewise/api_op_ListAssetModelProperties.go index cdfac9ef402..ff66508cc4e 100644 --- a/service/iotsitewise/api_op_ListAssetModelProperties.go +++ b/service/iotsitewise/api_op_ListAssetModelProperties.go @@ -33,18 +33,22 @@ type ListAssetModelPropertiesInput struct { // The ID of the asset model. This can be either the actual ID in UUID format, or // else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string - // Filters the requested list of asset model properties. You can choose one of the - // following options: + // 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. + // // Default: BASE Filter types.ListAssetModelPropertiesFilter diff --git a/service/iotsitewise/api_op_ListAssetModels.go b/service/iotsitewise/api_op_ListAssetModels.go index 2d673285a0b..d39c57e525c 100644 --- a/service/iotsitewise/api_op_ListAssetModels.go +++ b/service/iotsitewise/api_op_ListAssetModels.go @@ -30,14 +30,18 @@ func (c *Client) ListAssetModels(ctx context.Context, params *ListAssetModelsInp type ListAssetModelsInput struct { // The type of asset model. + // // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. + // // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. AssetModelTypes []types.AssetModelType - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -179,7 +183,9 @@ var _ ListAssetModelsAPIClient = (*Client)(nil) // ListAssetModelsPaginatorOptions is the paginator options for ListAssetModels type ListAssetModelsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListAssetProperties.go b/service/iotsitewise/api_op_ListAssetProperties.go index c2bc7c459ba..784839beb09 100644 --- a/service/iotsitewise/api_op_ListAssetProperties.go +++ b/service/iotsitewise/api_op_ListAssetProperties.go @@ -33,17 +33,21 @@ type ListAssetPropertiesInput struct { // The ID of the asset. This can be either the actual ID in UUID format, or else // externalId: followed by the external ID, if it has one. For more information, - // see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string - // Filters the requested list of asset properties. You can choose one of the + // 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. + // // Default: BASE Filter types.ListAssetPropertiesFilter diff --git a/service/iotsitewise/api_op_ListAssetRelationships.go b/service/iotsitewise/api_op_ListAssetRelationships.go index ee4824516f7..c5543e5a45a 100644 --- a/service/iotsitewise/api_op_ListAssetRelationships.go +++ b/service/iotsitewise/api_op_ListAssetRelationships.go @@ -33,14 +33,16 @@ type ListAssetRelationshipsInput struct { // The ID of the asset. This can be either the actual ID in UUID format, or else // externalId: followed by the external ID, if it has one. For more information, - // see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // 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. diff --git a/service/iotsitewise/api_op_ListAssets.go b/service/iotsitewise/api_op_ListAssets.go index 60204bb3cb6..1527d011d59 100644 --- a/service/iotsitewise/api_op_ListAssets.go +++ b/service/iotsitewise/api_op_ListAssets.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of asset summaries. You can use this operation to do -// the following: +// 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. // // 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. +// of your assets, use [ListAssetModels]to get all of your asset model IDs. Then, use ListAssets to +// get all assets for each asset model. +// +// [ListAssetModels]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error) { if params == nil { params = &ListAssetsInput{} @@ -40,20 +44,26 @@ 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 . This can be either the actual ID in // UUID format, or else externalId: followed by the external ID, if it has one. - // For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references 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. + // // Default: ALL Filter types.ListAssetsFilter - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -194,7 +204,9 @@ var _ ListAssetsAPIClient = (*Client)(nil) // ListAssetsPaginatorOptions is the paginator options for ListAssets type ListAssetsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListAssociatedAssets.go b/service/iotsitewise/api_op_ListAssociatedAssets.go index df4077127aa..33117ea6d6c 100644 --- a/service/iotsitewise/api_op_ListAssociatedAssets.go +++ b/service/iotsitewise/api_op_ListAssociatedAssets.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a paginated list of associated assets. You can use this operation to -// do the following: +// 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. func (c *Client) ListAssociatedAssets(ctx context.Context, params *ListAssociatedAssetsInput, optFns ...func(*Options)) (*ListAssociatedAssetsOutput, error) { if params == nil { @@ -35,33 +38,42 @@ type ListAssociatedAssetsInput struct { // The ID of the asset to query. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the hierarchy by which child assets are associated to the asset. // (This can be either the actual ID in UUID format, or else externalId: followed - // by the external ID, if it has one. For more information, see Referencing - // objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide.) 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) - // 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) - // in the IoT SiteWise User Guide. + // by the external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT + // SiteWise User Guide.) To find a hierarchy ID, use the [DescribeAsset]or [DescribeAssetModel] operations. This + // parameter is required if you choose CHILD for traversalDirection . + // + // For more information, see [Asset hierarchies] in the IoT SiteWise User Guide. + // + // [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html + // [DescribeAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html + // [DescribeAsset]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references HierarchyId *string - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. 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. + // // Default: CHILD TraversalDirection types.TraversalDirection @@ -205,7 +217,9 @@ var _ ListAssociatedAssetsAPIClient = (*Client)(nil) // ListAssociatedAssetsPaginatorOptions is the paginator options for // ListAssociatedAssets type ListAssociatedAssetsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListBulkImportJobs.go b/service/iotsitewise/api_op_ListBulkImportJobs.go index b1ba356b61c..ca0b78c1d0f 100644 --- a/service/iotsitewise/api_op_ListBulkImportJobs.go +++ b/service/iotsitewise/api_op_ListBulkImportJobs.go @@ -12,8 +12,9 @@ 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) -// in the IoT SiteWise User Guide. +// see [List bulk import jobs (CLI)]in the IoT SiteWise User Guide. +// +// [List bulk import jobs (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html func (c *Client) ListBulkImportJobs(ctx context.Context, params *ListBulkImportJobsInput, optFns ...func(*Options)) (*ListBulkImportJobsOutput, error) { if params == nil { params = &ListBulkImportJobsInput{} diff --git a/service/iotsitewise/api_op_ListCompositionRelationships.go b/service/iotsitewise/api_op_ListCompositionRelationships.go index 756bf118e2d..29a790226be 100644 --- a/service/iotsitewise/api_op_ListCompositionRelationships.go +++ b/service/iotsitewise/api_op_ListCompositionRelationships.go @@ -32,13 +32,16 @@ type ListCompositionRelationshipsInput struct { // The ID of the asset model. This can be either the actual ID in UUID format, or // else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -184,7 +187,9 @@ var _ ListCompositionRelationshipsAPIClient = (*Client)(nil) // ListCompositionRelationshipsPaginatorOptions is the paginator options for // ListCompositionRelationships type ListCompositionRelationshipsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListDashboards.go b/service/iotsitewise/api_op_ListDashboards.go index c7fe0a440d7..46d18850175 100644 --- a/service/iotsitewise/api_op_ListDashboards.go +++ b/service/iotsitewise/api_op_ListDashboards.go @@ -34,7 +34,9 @@ type ListDashboardsInput struct { // This member is required. ProjectId *string - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -179,7 +181,9 @@ var _ ListDashboardsAPIClient = (*Client)(nil) // ListDashboardsPaginatorOptions is the paginator options for ListDashboards type ListDashboardsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListGateways.go b/service/iotsitewise/api_op_ListGateways.go index d88debb0d75..7beb5f7abb4 100644 --- a/service/iotsitewise/api_op_ListGateways.go +++ b/service/iotsitewise/api_op_ListGateways.go @@ -29,7 +29,9 @@ func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, op type ListGatewaysInput struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -170,7 +172,9 @@ var _ ListGatewaysAPIClient = (*Client)(nil) // ListGatewaysPaginatorOptions is the paginator options for ListGateways type ListGatewaysPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListPortals.go b/service/iotsitewise/api_op_ListPortals.go index 3463789a882..4f8624c22b0 100644 --- a/service/iotsitewise/api_op_ListPortals.go +++ b/service/iotsitewise/api_op_ListPortals.go @@ -29,7 +29,9 @@ func (c *Client) ListPortals(ctx context.Context, params *ListPortalsInput, optF type ListPortalsInput struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -168,7 +170,9 @@ var _ ListPortalsAPIClient = (*Client)(nil) // ListPortalsPaginatorOptions is the paginator options for ListPortals type ListPortalsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListProjectAssets.go b/service/iotsitewise/api_op_ListProjectAssets.go index a27130c234d..f7e6a083b67 100644 --- a/service/iotsitewise/api_op_ListProjectAssets.go +++ b/service/iotsitewise/api_op_ListProjectAssets.go @@ -34,7 +34,9 @@ type ListProjectAssetsInput struct { // This member is required. ProjectId *string - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -179,7 +181,9 @@ var _ ListProjectAssetsAPIClient = (*Client)(nil) // ListProjectAssetsPaginatorOptions is the paginator options for ListProjectAssets type ListProjectAssetsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListProjects.go b/service/iotsitewise/api_op_ListProjects.go index 2e9eac9dd2b..d7728415680 100644 --- a/service/iotsitewise/api_op_ListProjects.go +++ b/service/iotsitewise/api_op_ListProjects.go @@ -34,7 +34,9 @@ type ListProjectsInput struct { // This member is required. PortalId *string - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 MaxResults *int32 // The token to be used for the next set of paginated results. @@ -178,7 +180,9 @@ var _ ListProjectsAPIClient = (*Client)(nil) // ListProjectsPaginatorOptions is the paginator options for ListProjects type ListProjectsPaginatorOptions struct { - // The maximum number of results to return for each paginated request. Default: 50 + // The maximum number of results to return for each paginated request. + // + // Default: 50 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iotsitewise/api_op_ListTagsForResource.go b/service/iotsitewise/api_op_ListTagsForResource.go index b6cb255a4e1..3f18c2c26e3 100644 --- a/service/iotsitewise/api_op_ListTagsForResource.go +++ b/service/iotsitewise/api_op_ListTagsForResource.go @@ -28,8 +28,9 @@ 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] of the resource. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string @@ -40,8 +41,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/iotsitewise/api_op_ListTimeSeries.go b/service/iotsitewise/api_op_ListTimeSeries.go index 1ae0d16fe32..e171368d695 100644 --- a/service/iotsitewise/api_op_ListTimeSeries.go +++ b/service/iotsitewise/api_op_ListTimeSeries.go @@ -34,8 +34,9 @@ type ListTimeSeriesInput struct { // The ID of the asset in which the asset property was created. This can be either // the actual ID in UUID format, or else externalId: followed by the external ID, - // if it has one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references AssetId *string // The maximum number of results to return for each paginated request. @@ -46,7 +47,9 @@ 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. TimeSeriesType types.ListTimeSeriesType diff --git a/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go b/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go index 0e6b7a569b6..ef258e46ed2 100644 --- a/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go +++ b/service/iotsitewise/api_op_PutDefaultEncryptionConfiguration.go @@ -12,8 +12,9 @@ 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) -// in the IoT SiteWise User Guide. +// For more information, see [Key management]in the IoT SiteWise User Guide. +// +// [Key management]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html func (c *Client) PutDefaultEncryptionConfiguration(ctx context.Context, params *PutDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*PutDefaultEncryptionConfigurationOutput, error) { if params == nil { params = &PutDefaultEncryptionConfigurationInput{} diff --git a/service/iotsitewise/api_op_PutStorageConfiguration.go b/service/iotsitewise/api_op_PutStorageConfiguration.go index dad6d3303f4..da66459cbcb 100644 --- a/service/iotsitewise/api_op_PutStorageConfiguration.go +++ b/service/iotsitewise/api_op_PutStorageConfiguration.go @@ -31,8 +31,10 @@ 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. // @@ -42,13 +44,18 @@ type PutStorageConfigurationInput struct { // 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. + // 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. + // + // For more information, see [Data streams] in the IoT SiteWise User Guide. + // + // [Data streams]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html DisassociatedDataStorage types.DisassociatedDataStorageState // Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the @@ -80,8 +87,10 @@ type PutStorageConfigurationOutput 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. // @@ -91,13 +100,18 @@ type PutStorageConfigurationOutput struct { // 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. + // 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. + // + // For more information, see [Data streams] in the IoT SiteWise User Guide. + // + // [Data streams]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html 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 9689239fe41..f55e2d42aac 100644 --- a/service/iotsitewise/api_op_TagResource.go +++ b/service/iotsitewise/api_op_TagResource.go @@ -29,15 +29,17 @@ 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] of the resource to tag. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // in the IoT SiteWise User Guide. + // information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide. + // + // [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html // // This member is required. Tags map[string]string diff --git a/service/iotsitewise/api_op_UntagResource.go b/service/iotsitewise/api_op_UntagResource.go index 57cad487f99..2ae15ad674e 100644 --- a/service/iotsitewise/api_op_UntagResource.go +++ b/service/iotsitewise/api_op_UntagResource.go @@ -28,8 +28,9 @@ 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] of the resource to untag. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/iotsitewise/api_op_UpdateAsset.go b/service/iotsitewise/api_op_UpdateAsset.go index cc106dc7968..655e2c065f1 100644 --- a/service/iotsitewise/api_op_UpdateAsset.go +++ b/service/iotsitewise/api_op_UpdateAsset.go @@ -11,8 +11,10 @@ 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) -// in the IoT SiteWise User Guide. +// Updates an asset's name. For more information, see [Updating assets and models] in the IoT SiteWise User +// Guide. +// +// [Updating assets and models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error) { if params == nil { params = &UpdateAssetInput{} @@ -32,8 +34,9 @@ type UpdateAssetInput struct { // The ID of the asset to update. This can be either the actual ID in UUID format, // or else externalId: followed by the external ID, if it has one. For more - // information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string @@ -48,8 +51,9 @@ type UpdateAssetInput struct { // An external ID to assign to the asset. The asset must not already have an // external ID. The external ID must be unique within your Amazon Web Services - // account. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // account. For more information, see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids AssetExternalId *string // A unique case-sensitive identifier that you can provide to ensure the diff --git a/service/iotsitewise/api_op_UpdateAssetModel.go b/service/iotsitewise/api_op_UpdateAssetModel.go index 1e4cdc12013..f88e2b3850b 100644 --- a/service/iotsitewise/api_op_UpdateAssetModel.go +++ b/service/iotsitewise/api_op_UpdateAssetModel.go @@ -13,15 +13,21 @@ 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) -// 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. +// and hierarchy definitions. For more information, see [Updating assets and models]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]. +// +// 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. +// +// [DescribeAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html +// [Updating assets and models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html func (c *Client) UpdateAssetModel(ctx context.Context, params *UpdateAssetModelInput, optFns ...func(*Options)) (*UpdateAssetModelOutput, error) { if params == nil { params = &UpdateAssetModelInput{} @@ -41,8 +47,9 @@ type UpdateAssetModelInput struct { // The ID of the asset model to update. This can be either the actual ID in UUID // format, or else externalId: followed by the external ID, if it has one. For - // more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetModelId *string @@ -56,9 +63,12 @@ type UpdateAssetModelInput struct { // (such as attributes, measurements, transforms, and metrics) and child composite // models that model parts of your industrial equipment. Each composite model has a // type that defines the properties that the composite model supports. Use - // composite models to define alarms on this asset model. When creating custom - // composite models, you need to use CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html) - // . For more information, see . + // composite models to define alarms on this asset model. + // + // When creating custom composite models, you need to use [CreateAssetModelCompositeModel]. For more information, + // see . + // + // [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html AssetModelCompositeModels []types.AssetModelCompositeModel // A description for the asset model. @@ -66,23 +76,30 @@ type UpdateAssetModelInput struct { // An external ID to assign to the asset model. The asset model must not already // have an external ID. The external ID must be unique within your Amazon Web - // Services account. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // Services account. For more information, see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids AssetModelExternalId *string // 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) - // 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) + // this asset model. For more information, see [Asset hierarchies]in the IoT SiteWise User Guide. + // + // You can specify up to 10 hierarchies per asset model. For more information, see [Quotas] // in the IoT SiteWise User Guide. + // + // [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html 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) - // 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) + // The updated property definitions of the asset model. For more information, see [Asset properties] // in the IoT SiteWise User Guide. + // + // You can specify up to 200 properties per asset model. For more information, see [Quotas] + // in the IoT SiteWise User Guide. + // + // [Asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html AssetModelProperties []types.AssetModelProperty // A unique case-sensitive identifier that you can provide to ensure the diff --git a/service/iotsitewise/api_op_UpdateAssetModelCompositeModel.go b/service/iotsitewise/api_op_UpdateAssetModelCompositeModel.go index 9c9776b2f0e..49364636f2b 100644 --- a/service/iotsitewise/api_op_UpdateAssetModelCompositeModel.go +++ b/service/iotsitewise/api_op_UpdateAssetModelCompositeModel.go @@ -13,18 +13,24 @@ import ( // Updates a composite 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) -// in the IoT SiteWise User Guide. If you remove a property from a composite asset -// model, IoT SiteWise deletes all previous data for that property. You can’t -// change the type or data type of an existing property. To replace an existing -// composite asset model property with a new one with the same name , do the -// following: +// property and hierarchy definitions. For more information, see [Updating assets and models]in the IoT +// SiteWise User Guide. +// +// If you remove a property from a composite asset model, IoT SiteWise deletes all +// previous data for that property. You can’t change the type or data type of an +// existing property. +// +// To replace an existing composite asset model property with a new one with the +// same name , do the following: +// // - Submit an UpdateAssetModelCompositeModel request with the entire existing // property removed. +// // - Submit a second UpdateAssetModelCompositeModel request that includes the new // property. The new asset property will have the same name as the previous one // and IoT SiteWise will generate a new unique id . +// +// [Updating assets and models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html func (c *Client) UpdateAssetModelCompositeModel(ctx context.Context, params *UpdateAssetModelCompositeModelInput, optFns ...func(*Options)) (*UpdateAssetModelCompositeModelOutput, error) { if params == nil { params = &UpdateAssetModelCompositeModelInput{} @@ -66,9 +72,11 @@ type UpdateAssetModelCompositeModelInput struct { AssetModelCompositeModelExternalId *string // The property definitions of the composite model. For more information, see . + // // You can specify up to 200 properties per composite model. For more information, - // see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) - // in the IoT SiteWise User Guide. + // see [Quotas]in the IoT SiteWise User Guide. + // + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html AssetModelCompositeModelProperties []types.AssetModelProperty // A unique case-sensitive identifier that you can provide to ensure the @@ -87,8 +95,9 @@ type UpdateAssetModelCompositeModelOutput struct { AssetModelCompositeModelPath []types.AssetModelCompositeModelPathSegment // 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) - // in the IoT SiteWise User Guide. + // see [Asset and model states]in the IoT SiteWise User Guide. + // + // [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html // // This member is required. AssetModelStatus *types.AssetModelStatus diff --git a/service/iotsitewise/api_op_UpdateAssetProperty.go b/service/iotsitewise/api_op_UpdateAssetProperty.go index 9042ae544b0..716a918a071 100644 --- a/service/iotsitewise/api_op_UpdateAssetProperty.go +++ b/service/iotsitewise/api_op_UpdateAssetProperty.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an asset property's alias and notification state. This operation -// 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) -// . +// Updates an asset property's alias and notification state. +// +// This operation 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]. +// +// [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{} @@ -36,16 +38,18 @@ type UpdateAssetPropertyInput struct { // The ID of the asset to be updated. This can be either the actual ID in UUID // format, or else externalId: followed by the external ID, if it has one. For - // more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. AssetId *string // The ID of the asset property to be updated. This can be either the actual ID in // UUID format, or else externalId: followed by the external ID, if it has one. - // For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. PropertyId *string @@ -57,17 +61,21 @@ type UpdateAssetPropertyInput 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) - // in the IoT SiteWise User Guide. If you omit this parameter, the alias is removed - // from the property. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // If you omit this parameter, the alias is removed from the property. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // 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) - // in the IoT SiteWise User Guide. If you omit this parameter, the notification - // state is set to DISABLED . + // to a unique MQTT topic. For more information, see [Interacting with other services]in the IoT SiteWise User + // Guide. + // + // If you omit this parameter, the notification state is set to DISABLED . + // + // [Interacting with other services]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html PropertyNotificationState types.PropertyNotificationState // The unit of measure (such as Newtons or RPM) of the asset property. If you diff --git a/service/iotsitewise/api_op_UpdateDashboard.go b/service/iotsitewise/api_op_UpdateDashboard.go index 40cc76b73e7..ac34d0f5ac6 100644 --- a/service/iotsitewise/api_op_UpdateDashboard.go +++ b/service/iotsitewise/api_op_UpdateDashboard.go @@ -29,8 +29,9 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Creating dashboards (CLI)]in the IoT SiteWise User Guide. + // + // [Creating dashboards (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html // // This member is required. DashboardDefinition *string diff --git a/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go b/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go index fb77d1fd104..f2685a719cd 100644 --- a/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go +++ b/service/iotsitewise/api_op_UpdateGatewayCapabilityConfiguration.go @@ -16,8 +16,9 @@ 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]. +// +// [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,8 +37,9 @@ 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) - // in the IoT SiteWise User Guide. + // For more information, see [Configuring data sources (CLI)]in the IoT SiteWise User Guide. + // + // [Configuring data sources (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli // // This member is required. CapabilityConfiguration *string @@ -67,9 +69,13 @@ 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. // diff --git a/service/iotsitewise/api_op_UpdatePortal.go b/service/iotsitewise/api_op_UpdatePortal.go index 53105357854..f03ca68a37d 100644 --- a/service/iotsitewise/api_op_UpdatePortal.go +++ b/service/iotsitewise/api_op_UpdatePortal.go @@ -44,11 +44,12 @@ 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 - // 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) - // in the IoT SiteWise User Guide. + // The [ARN] 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]in the IoT + // SiteWise User Guide. + // + // [Using service roles for IoT SiteWise Monitor]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. RoleArn *string @@ -56,8 +57,9 @@ 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) - // in the IoT SiteWise Application Guide. + // information, see [Monitoring with alarms]in the IoT SiteWise Application Guide. + // + // [Monitoring with alarms]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html Alarms *types.Alarms // A unique case-sensitive identifier that you can provide to ensure the @@ -72,7 +74,9 @@ 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. PortalLogoImage *types.Image diff --git a/service/iotsitewise/doc.go b/service/iotsitewise/doc.go index 3b5268fead1..b9cb3bfef4b 100644 --- a/service/iotsitewise/doc.go +++ b/service/iotsitewise/doc.go @@ -4,9 +4,11 @@ // 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) -// 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. +// Services service that connects [Industrial Internet of Things (IIoT)]devices to the power of the Amazon Web Services +// Cloud. For more information, see the [IoT SiteWise User Guide]. For information about IoT SiteWise +// quotas, see [Quotas]in the IoT SiteWise User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html +// [IoT SiteWise User Guide]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ +// [Industrial Internet of Things (IIoT)]: https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications package iotsitewise diff --git a/service/iotsitewise/options.go b/service/iotsitewise/options.go index af7c6568caf..a8b1b1f86a9 100644 --- a/service/iotsitewise/options.go +++ b/service/iotsitewise/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotsitewise/types/enums.go b/service/iotsitewise/types/enums.go index 4c3b6693bc0..45465ad212a 100644 --- a/service/iotsitewise/types/enums.go +++ b/service/iotsitewise/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AggregateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregateType) Values() []AggregateType { return []AggregateType{ "AVERAGE", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for AssetErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetErrorCode) Values() []AssetErrorCode { return []AssetErrorCode{ "INTERNAL_FAILURE", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for AssetModelState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetModelState) Values() []AssetModelState { return []AssetModelState{ "CREATING", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for AssetModelType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetModelType) Values() []AssetModelType { return []AssetModelType{ "ASSET_MODEL", @@ -96,8 +100,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "HIERARCHY", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for AssetState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetState) Values() []AssetState { return []AssetState{ "CREATING", @@ -137,8 +143,9 @@ const ( ) // Values returns all known values for AuthMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthMode) Values() []AuthMode { return []AuthMode{ "IAM", @@ -156,6 +163,7 @@ const ( // Values returns all known values for BatchEntryCompletionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BatchEntryCompletionStatus) Values() []BatchEntryCompletionStatus { return []BatchEntryCompletionStatus{ @@ -175,8 +183,9 @@ const ( // Values returns all known values for BatchGetAssetPropertyAggregatesErrorCode. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchGetAssetPropertyAggregatesErrorCode) Values() []BatchGetAssetPropertyAggregatesErrorCode { return []BatchGetAssetPropertyAggregatesErrorCode{ "ResourceNotFoundException", @@ -196,8 +205,9 @@ const ( // Values returns all known values for BatchGetAssetPropertyValueErrorCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchGetAssetPropertyValueErrorCode) Values() []BatchGetAssetPropertyValueErrorCode { return []BatchGetAssetPropertyValueErrorCode{ "ResourceNotFoundException", @@ -217,8 +227,9 @@ const ( // Values returns all known values for BatchGetAssetPropertyValueHistoryErrorCode. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchGetAssetPropertyValueHistoryErrorCode) Values() []BatchGetAssetPropertyValueHistoryErrorCode { return []BatchGetAssetPropertyValueHistoryErrorCode{ "ResourceNotFoundException", @@ -244,8 +255,9 @@ const ( // Values returns all known values for BatchPutAssetPropertyValueErrorCode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchPutAssetPropertyValueErrorCode) Values() []BatchPutAssetPropertyValueErrorCode { return []BatchPutAssetPropertyValueErrorCode{ "ResourceNotFoundException", @@ -271,8 +283,9 @@ const ( ) // Values returns all known values for CapabilitySyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapabilitySyncStatus) Values() []CapabilitySyncStatus { return []CapabilitySyncStatus{ "IN_SYNC", @@ -297,8 +310,9 @@ const ( ) // Values returns all known values for ColumnName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnName) Values() []ColumnName { return []ColumnName{ "ALIAS", @@ -321,8 +335,9 @@ const ( ) // Values returns all known values for ComputeLocation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeLocation) Values() []ComputeLocation { return []ComputeLocation{ "EDGE", @@ -340,8 +355,9 @@ const ( ) // Values returns all known values for ConfigurationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationState) Values() []ConfigurationState { return []ConfigurationState{ "ACTIVE", @@ -359,8 +375,9 @@ const ( ) // Values returns all known values for DetailedErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetailedErrorCode) Values() []DetailedErrorCode { return []DetailedErrorCode{ "INCOMPATIBLE_COMPUTE_LOCATION", @@ -378,8 +395,9 @@ const ( // Values returns all known values for DisassociatedDataStorageState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DisassociatedDataStorageState) Values() []DisassociatedDataStorageState { return []DisassociatedDataStorageState{ "ENABLED", @@ -396,8 +414,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "SITEWISE_DEFAULT_ENCRYPTION", @@ -414,8 +433,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -432,8 +452,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -451,8 +472,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -469,8 +491,9 @@ const ( ) // Values returns all known values for ImageFileType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageFileType) Values() []ImageFileType { return []ImageFileType{ "PNG", @@ -490,8 +513,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -513,8 +537,9 @@ const ( // Values returns all known values for ListAssetModelPropertiesFilter. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListAssetModelPropertiesFilter) Values() []ListAssetModelPropertiesFilter { return []ListAssetModelPropertiesFilter{ "ALL", @@ -532,6 +557,7 @@ const ( // Values returns all known values for ListAssetPropertiesFilter. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListAssetPropertiesFilter) Values() []ListAssetPropertiesFilter { return []ListAssetPropertiesFilter{ @@ -549,8 +575,9 @@ const ( ) // Values returns all known values for ListAssetsFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListAssetsFilter) Values() []ListAssetsFilter { return []ListAssetsFilter{ "ALL", @@ -573,6 +600,7 @@ const ( // 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{ @@ -595,8 +623,9 @@ const ( ) // Values returns all known values for ListTimeSeriesType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListTimeSeriesType) Values() []ListTimeSeriesType { return []ListTimeSeriesType{ "ASSOCIATED", @@ -614,8 +643,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -634,8 +664,9 @@ const ( ) // Values returns all known values for MonitorErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitorErrorCode) Values() []MonitorErrorCode { return []MonitorErrorCode{ "INTERNAL_FAILURE", @@ -653,8 +684,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "ADMINISTRATOR", @@ -674,8 +706,9 @@ const ( ) // Values returns all known values for PortalState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PortalState) Values() []PortalState { return []PortalState{ "CREATING", @@ -698,8 +731,9 @@ const ( ) // Values returns all known values for PropertyDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyDataType) Values() []PropertyDataType { return []PropertyDataType{ "STRING", @@ -720,6 +754,7 @@ const ( // Values returns all known values for PropertyNotificationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PropertyNotificationState) Values() []PropertyNotificationState { return []PropertyNotificationState{ @@ -738,8 +773,9 @@ const ( ) // Values returns all known values for Quality. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Quality) Values() []Quality { return []Quality{ "GOOD", @@ -757,8 +793,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -778,8 +815,9 @@ const ( ) // Values returns all known values for ScalarType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalarType) Values() []ScalarType { return []ScalarType{ "BOOLEAN", @@ -799,8 +837,9 @@ const ( ) // Values returns all known values for StorageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageType) Values() []StorageType { return []StorageType{ "SITEWISE_DEFAULT_STORAGE", @@ -816,8 +855,9 @@ const ( ) // Values returns all known values for TargetResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetResourceType) Values() []TargetResourceType { return []TargetResourceType{ "ASSET", @@ -833,8 +873,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -851,8 +892,9 @@ const ( ) // Values returns all known values for TraversalDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TraversalDirection) Values() []TraversalDirection { return []TraversalDirection{ "PARENT", @@ -868,8 +910,9 @@ const ( ) // Values returns all known values for TraversalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TraversalType) Values() []TraversalType { return []TraversalType{ "PATH_TO_ROOT", @@ -885,8 +928,9 @@ const ( ) // Values returns all known values for WarmTierState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WarmTierState) Values() []WarmTierState { return []WarmTierState{ "ENABLED", diff --git a/service/iotsitewise/types/errors.go b/service/iotsitewise/types/errors.go index 04171021f1d..2d9a3d62c9d 100644 --- a/service/iotsitewise/types/errors.go +++ b/service/iotsitewise/types/errors.go @@ -118,9 +118,11 @@ 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. +// to create more than the allowed number of properties for an asset model. +// +// For more information, see [Quotas] in the IoT SiteWise User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html type LimitExceededException struct { Message *string @@ -255,8 +257,11 @@ 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] in the IoT SiteWise User Guide. +// +// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html type ThrottlingException struct { Message *string @@ -283,8 +288,9 @@ 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) -// in the Amazon Web Services General Reference. +// more information, see [Tag naming limits and requirements]in the Amazon Web Services General Reference. +// +// [Tag naming limits and requirements]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions type TooManyTagsException struct { Message *string diff --git a/service/iotsitewise/types/types.go b/service/iotsitewise/types/types.go index 6ae10ab4c79..938ee3f3a4c 100644 --- a/service/iotsitewise/types/types.go +++ b/service/iotsitewise/types/types.go @@ -136,21 +136,24 @@ 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) -// in the IoT SiteWise Application Guide. +// information, see [Monitoring with alarms]in the IoT SiteWise Application Guide. +// +// [Monitoring with alarms]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html 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 - // Services resources and services, such as IoT Events. + // The [ARN] of the IAM role that allows the alarm to perform actions and access Amazon + // Web Services resources and services, such as IoT Events. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // in the IoT Events Developer Guide. + // The [ARN] of the Lambda function that manages alarm notifications. For more + // information, see [Managing alarm notifications]in the IoT Events Developer Guide. + // + // [Managing alarm notifications]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html NotificationLambdaArn *string noSmithyDocumentSerde @@ -179,12 +182,13 @@ type AssetCompositeModel struct { // The description of the composite model. Description *string - // The external ID of the asset composite model. For more information, see Using - // external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset composite model. For more information, see [Using external IDs] in the + // IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string - // The ID of the asset composite model. + // The ID of the asset composite model. Id *string noSmithyDocumentSerde @@ -226,8 +230,10 @@ type AssetCompositeModelSummary struct { Path []AssetCompositeModelPathSegment // The type of asset model. + // // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. + // // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. @@ -235,10 +241,12 @@ type AssetCompositeModelSummary struct { // This member is required. Type *string - // An external ID to assign to the asset model. If the composite model is a - // derived composite model, or one nested inside a component model, you can only - // set the external ID using UpdateAssetModelCompositeModel and specifying the - // derived ID of the model or property from the created model it's a part of. + // An external ID to assign to the asset model. + // + // If the composite model is a derived composite model, or one nested inside a + // component model, you can only set the external ID using + // UpdateAssetModelCompositeModel and specifying the derived ID of the model or + // property from the created model it's a part of. ExternalId *string noSmithyDocumentSerde @@ -268,9 +276,10 @@ 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) - // API operation. + // The hierarchy name provided in the [CreateAssetModel] or [UpdateAssetModel] API operation. + // + // [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html // // This member is required. Name *string @@ -278,8 +287,9 @@ type AssetHierarchy struct { // The external ID of the hierarchy, if it has one. When you update an asset // hierarchy, you may assign an external ID if it doesn't already have one. You // can't change the external ID of an asset hierarchy that already has one. For - // more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // more information, see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID of the hierarchy. This ID is a hierarchyId . @@ -319,12 +329,13 @@ type AssetModelCompositeModel struct { // The description of the composite model. Description *string - // The external ID of the asset model composite model. For more information, see - // Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) + // The external ID of the asset model composite model. For more information, see [Using external IDs] // in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string - // The ID of the asset model composite model. + // The ID of the asset model composite model. Id *string // The asset property definitions for this composite model. @@ -352,9 +363,10 @@ type AssetModelCompositeModelDefinition struct { Description *string // An external ID to assign to the composite model. The external ID must be unique - // among composite models within this asset model. For more information, see Using - // external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // among composite models within this asset model. For more information, see [Using external IDs]in + // the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID to assign to the composite model, if desired. IoT SiteWise automatically @@ -395,8 +407,10 @@ type AssetModelCompositeModelSummary struct { Name *string // The type of asset model. + // // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. + // // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. @@ -408,8 +422,9 @@ type AssetModelCompositeModelSummary struct { Description *string // The external ID of a composite model on this asset model. For more information, - // see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The path that includes all the pieces that make up the composite model. @@ -425,42 +440,50 @@ type AssetModelHierarchy struct { // The ID of the asset model, in UUID format. All assets in this hierarchy must be // instances of the childAssetModelId asset model. IoT SiteWise will always return // the actual asset model ID for this value. However, when you are specifying this - // value as part of a call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) - // , you may provide either the asset model ID or else externalId: followed by the - // asset model's external ID. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) + // value as part of a call to [UpdateAssetModel], you may provide either the asset model ID or else + // externalId: followed by the asset model's external ID. For more information, see [Using external IDs] // in the IoT SiteWise User Guide. // + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids + // // 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) - // API operation. + // The name of the asset model hierarchy that you specify by using the [CreateAssetModel] or [UpdateAssetModel] API + // operation. + // + // [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html // // This member is required. Name *string - // The external ID (if any) 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) - // operation. You can assign an external ID by specifying this value as part of a - // call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) - // . However, you can't change the external ID if one is already assigned. For more - // information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID (if any) provided in the [CreateAssetModel] or [UpdateAssetModel] operation. You can assign an + // external ID by specifying this value as part of a call to [UpdateAssetModel]. However, you can't + // change the external ID if one is already assigned. For more information, see [Using external IDs]in + // the IoT SiteWise User Guide. + // + // [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID of the asset model hierarchy. This ID is a hierarchyId . - // - If you are callling UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) - // to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise - // automatically generates a unique ID for you, so this parameter is never - // required. However, if you prefer to supply your own ID instead, you can specify - // it here in UUID format. If you specify your own ID, it must be globally unique. + // + // - If you are callling [UpdateAssetModel]to create a new hierarchy: You can specify its ID here, + // if desired. IoT SiteWise automatically generates a unique ID for you, so this + // parameter is never required. However, if you prefer to supply your own ID + // instead, you can specify it here in UUID format. If you specify your own ID, it + // must be globally unique. + // // - If you are calling UpdateAssetModel to modify an existing hierarchy: This // can be either the actual ID in UUID format, or else externalId: followed by - // the external ID, if it has one. For more information, see Referencing objects - // with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // the external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise + // User Guide. + // + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references Id *string noSmithyDocumentSerde @@ -472,24 +495,27 @@ type AssetModelHierarchyDefinition struct { // The ID of an asset model for this hierarchy. This can be either the actual ID // in UUID format, or else externalId: followed by the external ID, if it has one. - // For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide. + // + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references // // This member is required. 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) - // API operation). + // The name of the asset model hierarchy definition (as specified in the [CreateAssetModel] or [UpdateAssetModel] API + // operation). + // + // [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html // // This member is required. Name *string // An external ID to assign to the asset model hierarchy. The external ID must be // unique among asset model hierarchies within this asset model. For more - // information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // information, see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID to assign to the asset model hierarchy, if desired. IoT SiteWise @@ -523,26 +549,31 @@ type AssetModelProperty struct { // properties that have the STRUCT data type. DataTypeSpec *string - // The external ID (if any) 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) - // operation. You can assign an external ID by specifying this value as part of a - // call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) - // . However, you can't change the external ID if one is already assigned. For more - // information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID (if any) provided in the [CreateAssetModel] or [UpdateAssetModel] operation. You can assign an + // external ID by specifying this value as part of a call to [UpdateAssetModel]. However, you can't + // change the external ID if one is already assigned. For more information, see [Using external IDs]in + // the IoT SiteWise User Guide. + // + // [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID of the asset model property. - // - If you are callling UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) - // to create a new property: You can specify its ID here, if desired. IoT SiteWise - // automatically generates a unique ID for you, so this parameter is never - // required. However, if you prefer to supply your own ID instead, you can specify - // it here in UUID format. If you specify your own ID, it must be globally unique. + // + // - If you are callling [UpdateAssetModel]to create a new property: You can specify its ID here, + // if desired. IoT SiteWise automatically generates a unique ID for you, so this + // parameter is never required. However, if you prefer to supply your own ID + // instead, you can specify it here in UUID format. If you specify your own ID, it + // must be globally unique. + // // - If you are calling UpdateAssetModel to modify an existing property: This // can be either the actual ID in UUID format, or else externalId: followed by - // the external ID, if it has one. For more information, see Referencing objects - // with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references) - // in the IoT SiteWise User Guide. + // the external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise + // User Guide. + // + // [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html + // [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references Id *string // The structured path to the property from the root of the asset model. @@ -558,8 +589,10 @@ type AssetModelProperty struct { // 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 - // specify dataTypeSpec to identify the type of the structure for this property. + // 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. DataType PropertyDataType @@ -576,15 +609,18 @@ type AssetModelPropertyDefinition struct { 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 - // AWS/ALARM_STATE for alarm state in alarm composite models. + // 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 // An external ID to assign to the property definition. The external ID must be // unique among property definitions within this asset model. For more information, - // see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID to assign to the asset model property, if desired. IoT SiteWise @@ -630,15 +666,17 @@ type AssetModelPropertySummary struct { // This member is required. Type *PropertyType - // The ID of the composite model that contains the asset model property. + // The ID of the composite model that contains the asset model property. AssetModelCompositeModelId *string // The data type of the structure for this property. This parameter exists on // properties that have the STRUCT data type. DataTypeSpec *string - // The external ID of the property. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the property. For more information, see [Using external IDs] in the IoT SiteWise + // User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // The ID of the property. @@ -654,8 +692,9 @@ type AssetModelPropertySummary struct { } // 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) -// in the IoT SiteWise User Guide. +// see [Asset and model states]in the IoT SiteWise User Guide. +// +// [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html type AssetModelStatus struct { // The current state of the asset model. @@ -672,9 +711,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // The [ARN] of the asset model, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -710,15 +751,19 @@ type AssetModelSummary struct { Status *AssetModelStatus // The type of asset model. + // // - ASSET_MODEL – (default) An asset model that you can use to create assets. // Can't be included as a component in another asset model. + // // - COMPONENT_MODEL – A reusable component that you can include in the // composite models of other asset models. You can't create assets directly from // this type of asset model. AssetModelType AssetModelType - // The external ID of the asset model. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset model. For more information, see [Using external IDs] in the IoT + // SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string noSmithyDocumentSerde @@ -744,22 +789,24 @@ type AssetProperty 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html Alias *string // The data type of the structure for this property. This parameter exists on // properties that have the STRUCT data type. DataTypeSpec *string - // The external ID of the asset property. For more information, see Using external - // IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset property. For more information, see [Using external IDs] in the IoT + // SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *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) - // . + // The asset property's notification topic and state. For more information, see [UpdateAssetProperty]. + // + // [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html Notification *PropertyNotification // The structured path to the property from the root of the asset. @@ -793,27 +840,31 @@ 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html Alias *string - // The ID of the composite model that contains the asset property. + // The ID of the composite model that contains the asset property. AssetCompositeModelId *string - // The external ID of the property. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the property. For more information, see [Using external IDs] in the IoT SiteWise + // User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string // 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) - // in the IoT SiteWise User Guide. + // topic. For more information, see [Interacting with other services]in the IoT SiteWise User Guide. + // + // [Interacting with other services]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html Notification *PropertyNotification // The structured path to the property from the root of the asset. Path []AssetPropertyPathSegment - // The unit of measure (such as Newtons or RPM) of the asset property. + // The unit of measure (such as Newtons or RPM) of the asset property. Unit *string noSmithyDocumentSerde @@ -843,6 +894,7 @@ 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. @@ -850,16 +902,18 @@ type AssetRelationshipSummary struct { // This member is required. RelationshipType AssetRelationshipType - // The assets that are related through an asset hierarchy. This object is present - // if the relationshipType is HIERARCHY . + // The assets that are related through an asset hierarchy. + // + // This object is present 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) -// in the IoT SiteWise User Guide. +// information, see [Asset and model states]in the IoT SiteWise User Guide. +// +// [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html type AssetStatus struct { // The current status of the asset. @@ -876,9 +930,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // The [ARN] of the asset, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -922,8 +978,10 @@ type AssetSummary struct { // A description for the asset. Description *string - // The external ID of the asset. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset. For more information, see [Using external IDs] in the IoT SiteWise + // User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string noSmithyDocumentSerde @@ -932,9 +990,11 @@ 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // The [ARN] of the asset, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -978,35 +1038,45 @@ type AssociatedAssetsSummary struct { // A description for the asset. Description *string - // The external ID of the asset. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset. For more information, see [Using external IDs] in the IoT SiteWise + // User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string noSmithyDocumentSerde } -// 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. +// Contains an asset attribute property. For more information, see [Attributes] in the IoT +// SiteWise User Guide. +// +// [Attributes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes 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) - // in the IoT SiteWise User Guide. + // attribute's value after you create an asset. For more information, see [Updating attribute values]in the + // IoT SiteWise User Guide. + // + // [Updating attribute values]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html DefaultValue *string noSmithyDocumentSerde } // 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) -// API. To identify an asset property, you must specify one of the following: +// with the [BatchGetAssetPropertyAggregates]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) -// . +// alias, see [UpdateAssetProperty]. +// +// [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html type BatchGetAssetPropertyAggregatesEntry struct { // The data aggregating function. @@ -1041,8 +1111,9 @@ type BatchGetAssetPropertyAggregatesEntry 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. @@ -1051,15 +1122,18 @@ type BatchGetAssetPropertyAggregatesEntry struct { // The quality by which to filter asset data. Qualities []Quality - // The chronological sorting order of the requested information. Default: ASCENDING + // The chronological sorting order of the requested information. + // + // Default: ASCENDING TimeOrdering TimeOrdering noSmithyDocumentSerde } // 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) -// API. +// associated with the [BatchGetAssetPropertyAggregates]API. +// +// [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html type BatchGetAssetPropertyAggregatesErrorEntry struct { // The ID of the entry. @@ -1081,8 +1155,9 @@ 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) -// API. +// that is associated with the [BatchGetAssetPropertyAggregates]API. +// +// [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html type BatchGetAssetPropertyAggregatesErrorInfo struct { // The error code. @@ -1098,14 +1173,15 @@ type BatchGetAssetPropertyAggregatesErrorInfo struct { noSmithyDocumentSerde } -// 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) +// Contains information for an entry that has been processed by the previous [BatchGetAssetPropertyAggregates] // request. +// +// [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html 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) - // API. + // The completion status of each entry that is associated with the [BatchGetAssetPropertyAggregates] API. + // + // [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html // // This member is required. CompletionStatus BatchEntryCompletionStatus @@ -1121,9 +1197,9 @@ type BatchGetAssetPropertyAggregatesSkippedEntry struct { noSmithyDocumentSerde } -// Contains success information for an entry that is associated with the -// BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) -// API. +// Contains success information for an entry that is associated with the [BatchGetAssetPropertyAggregates] API. +// +// [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html type BatchGetAssetPropertyAggregatesSuccessEntry struct { // The requested aggregated asset property values (for example, average, minimum, @@ -1141,13 +1217,18 @@ 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) -// API. To identify an asset property, you must specify one of the following: +// the [BatchGetAssetPropertyValue]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) -// . +// alias, see [UpdateAssetProperty]. +// +// [BatchGetAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html type BatchGetAssetPropertyValueEntry struct { // The ID of the entry. @@ -1160,8 +1241,9 @@ type BatchGetAssetPropertyValueEntry 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. @@ -1171,8 +1253,9 @@ 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) -// API. +// with the [BatchGetAssetPropertyValue]API. +// +// [BatchGetAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html type BatchGetAssetPropertyValueErrorEntry struct { // The ID of the entry. @@ -1210,13 +1293,18 @@ 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) -// API. To identify an asset property, you must specify one of the following: +// associated with the [BatchGetAssetPropertyValueHistory]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) -// . +// alias, see [UpdateAssetProperty]. +// +// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html +// [BatchGetAssetPropertyValueHistory]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html type BatchGetAssetPropertyValueHistoryEntry struct { // The ID of the entry. @@ -1233,8 +1321,9 @@ type BatchGetAssetPropertyValueHistoryEntry 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property, in UUID format. @@ -1247,7 +1336,9 @@ type BatchGetAssetPropertyValueHistoryEntry struct { // in seconds in Unix epoch time. StartDate *time.Time - // The chronological sorting order of the requested information. Default: ASCENDING + // The chronological sorting order of the requested information. + // + // Default: ASCENDING TimeOrdering TimeOrdering noSmithyDocumentSerde @@ -1291,14 +1382,15 @@ type BatchGetAssetPropertyValueHistoryErrorInfo struct { noSmithyDocumentSerde } -// 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) +// Contains information for an entry that has been processed by the previous [BatchGetAssetPropertyValueHistory] // request. +// +// [BatchGetAssetPropertyValueHistory]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html 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) - // API. + // The completion status of each entry that is associated with the [BatchGetAssetPropertyValueHistory] API. + // + // [BatchGetAssetPropertyValueHistory]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html // // This member is required. CompletionStatus BatchEntryCompletionStatus @@ -1314,9 +1406,9 @@ type BatchGetAssetPropertyValueHistorySkippedEntry struct { noSmithyDocumentSerde } -// Contains success information for an entry that is associated with the -// BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) -// API. +// Contains success information for an entry that is associated with the [BatchGetAssetPropertyValueHistory] API. +// +// [BatchGetAssetPropertyValueHistory]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html type BatchGetAssetPropertyValueHistorySuccessEntry struct { // The requested historical values for the specified asset property. @@ -1332,14 +1424,15 @@ type BatchGetAssetPropertyValueHistorySuccessEntry struct { noSmithyDocumentSerde } -// 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) +// Contains information for an entry that has been processed by the previous [BatchGetAssetPropertyValue] // request. +// +// [BatchGetAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html 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) - // request. + // The completion status of each entry that is associated with the [BatchGetAssetPropertyValue] request. + // + // [BatchGetAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html // // This member is required. CompletionStatus BatchEntryCompletionStatus @@ -1355,9 +1448,9 @@ type BatchGetAssetPropertyValueSkippedEntry struct { noSmithyDocumentSerde } -// Contains success information for an entry that is associated with the -// BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) -// API. +// Contains success information for an entry that is associated with the [BatchGetAssetPropertyValue] API. +// +// [BatchGetAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html type BatchGetAssetPropertyValueSuccessEntry struct { // The ID of the entry. @@ -1393,8 +1486,9 @@ 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) -// API. +// with the [BatchPutAssetPropertyValue]API. +// +// [BatchPutAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html type BatchPutAssetPropertyErrorEntry struct { // The ID of the failed entry. @@ -1450,19 +1544,21 @@ type CompositeModelProperty struct { Type *string // The external ID of the composite model that contains the property. For more - // information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // information, see [Using external IDs]in the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *string - // The ID of the composite model that contains the property. + // The ID of the composite model that contains the property. Id *string noSmithyDocumentSerde } // Metadata for the composition relationship established by using -// composedAssetModelId in CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html) -// . +// composedAssetModelId in [CreateAssetModelCompositeModel]CreateAssetModelCompositeModel . +// +// [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html type CompositionDetails struct { // An array detailing the composition relationship for this composite model. @@ -1547,17 +1643,19 @@ 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] of the Identity and Access Management role that allows IoT SiteWise to + // send data to Amazon S3. + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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] of the Amazon S3 object. For more information about how to find the ARN + // for an Amazon S3 object, see [Amazon S3 resources]in the Amazon Simple Storage Service User Guide. + // + // [Amazon S3 resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. S3ResourceArn *string @@ -1638,7 +1736,7 @@ type ErrorDetails struct { // This member is required. Message *string - // A list of detailed errors. + // A list of detailed errors. Details []DetailedError noSmithyDocumentSerde @@ -1657,8 +1755,9 @@ 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]in the Amazon Simple Storage Service User Guide. + // + // [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html // // This member is required. Prefix *string @@ -1739,8 +1838,11 @@ type GatewayCapabilitySummary 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. // // This member is required. @@ -1786,9 +1888,9 @@ type GatewaySummary struct { // 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) - // . + // retrieve a capability configuration's definition, use [DescribeGatewayCapabilityConfiguration]. + // + // [DescribeGatewayCapabilityConfiguration]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html GatewayCapabilitySummaries []GatewayCapabilitySummary // Contains a gateway's platform information. @@ -1800,16 +1902,18 @@ 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) -// in the IoT SiteWise User Guide. +// to upload data to IoT SiteWise. For more information, see [Ingesting data using a gateway]in the IoT SiteWise +// User Guide. +// +// [Ingesting data using a gateway]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html 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) - // in the IoT Greengrass API Reference. + // The [ARN] of the Greengrass group. For more information about how to find a group's + // ARN, see [ListGroups]and [GetGroup] in the IoT Greengrass API Reference. + // + // [GetGroup]: https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html + // [ListGroups]: https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. GroupArn *string @@ -1819,10 +1923,11 @@ 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) -// 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. +// component to your gateway device. Your [Greengrass device role]must use the AWSIoTSiteWiseEdgeAccess +// policy. For more information, see [Using IoT SiteWise at the edge]in the IoT SiteWise User Guide. +// +// [Using IoT SiteWise at the edge]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html +// [Greengrass device role]: https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html type GreengrassV2 struct { // The name of the IoT thing for your IoT Greengrass V2 core device. @@ -1845,12 +1950,14 @@ 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]in the IAM User Guide. +// +// [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html 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] in the IAM User Guide. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. Arn *string @@ -1861,10 +1968,13 @@ 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] 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. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. Arn *string @@ -1873,10 +1983,12 @@ type IAMUserIdentity struct { } // Contains an identity that can access an IoT SiteWise Monitor resource. +// // Currently, you can't use Amazon Web Services API operations 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) -// . +// in the URL of user and group pages in the [IAM Identity Center console]. +// +// [IAM Identity Center console]: https://console.aws.amazon.com/singlesignon type Identity struct { // An IAM Identity Center group identity. @@ -1895,7 +2007,9 @@ 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. type Image struct { @@ -1984,15 +2098,21 @@ 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. @@ -2014,8 +2134,10 @@ 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) -// in the IoT SiteWise User Guide. +// Contains an asset measurement property. For more information, see [Measurements] in the IoT +// SiteWise User Guide. +// +// [Measurements]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements type Measurement struct { // The processing configuration for the given measurement property. You can @@ -2041,19 +2163,25 @@ type MeasurementProcessingConfig struct { // Contains an asset metric property. With metrics, you can calculate aggregate // functions, such as an average, maximum, or minimum, as specified through an -// expression. A metric maps several values to a single value (such as a sum). The -// maximum number of dependent/cascading variables used in any one metric +// expression. A metric maps several values to a single value (such as a sum). +// +// The 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) -// in the IoT SiteWise User Guide. +// data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE . +// +// For more information, see [Metrics] in the IoT SiteWise User Guide. +// +// [Metrics]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics 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] in the IoT SiteWise User Guide. + // + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html // // This member is required. Expression *string @@ -2188,11 +2316,12 @@ 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 - // 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) - // in the IoT SiteWise User Guide. + // The [ARN] 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]in the IoT + // SiteWise User Guide. + // + // [Using service roles for IoT SiteWise Monitor]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html RoleArn *string noSmithyDocumentSerde @@ -2254,18 +2383,20 @@ type Property 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html Alias *string - // The external ID of the asset property. For more information, see Using external - // IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // The external ID of the asset property. For more information, see [Using external IDs] in the IoT + // SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids ExternalId *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) - // . + // The asset property's notification topic and state. For more information, see [UpdateAssetProperty]. + // + // [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html Notification *PropertyNotification // The structured path to the property from the root of the asset. @@ -2282,8 +2413,9 @@ 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) -// in the IoT SiteWise User Guide. +// topic. For more information, see [Interacting with other services]in the IoT SiteWise User Guide. +// +// [Interacting with other services]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html type PropertyNotification struct { // The current notification state. @@ -2305,8 +2437,9 @@ type PropertyNotification struct { 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]wind turbine. + // + // [IIoT]: https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications Attribute *Attribute // Specifies an asset measurement property. A measurement represents a device's @@ -2329,8 +2462,9 @@ 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) -// API operation. +// entries consumed by the [BatchPutAssetPropertyValue]API operation. +// +// [BatchPutAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html type PutAssetPropertyValueEntry struct { // The user specified ID for the entry. You can use this ID to identify which @@ -2350,8 +2484,9 @@ type PutAssetPropertyValueEntry 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) - // in the IoT SiteWise User Guide. + // information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide. + // + // [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html PropertyAlias *string // The ID of the asset property for this entry. @@ -2376,12 +2511,16 @@ type Resource struct { // kept indefinitely in the hot tier. 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 . + // The number of days that your data is kept. + // + // If you specified a value for this parameter, the unlimited parameter must be + // false . NumberOfDays *int32 - // If true, your data is kept indefinitely. If configured to true , you must not - // specify a value for the numberOfDays parameter. + // If true, your data is kept indefinitely. + // + // If configured to true , you must not specify a value for the numberOfDays + // parameter. Unlimited *bool noSmithyDocumentSerde @@ -2427,15 +2566,19 @@ 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 - // dataTypeSpec to identify the type of the structure for this time series. + // 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. - // arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} + // The [ARN] of the time series, which has the following format. + // + // arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} + // + // [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. TimeSeriesArn *string @@ -2462,10 +2605,11 @@ type TimeSeriesSummary struct { AssetId *string // 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. + // 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. DataTypeSpec *string // The ID of the asset property, in UUID format. @@ -2479,14 +2623,20 @@ 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) -// in the IoT SiteWise User Guide. +// INTEGER or DOUBLE . +// +// For more information, see [Transforms] in the IoT SiteWise User Guide. +// +// [Transforms]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms 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] in the IoT SiteWise User Guide. + // + // [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html // // This member is required. Expression *string @@ -2524,47 +2674,70 @@ 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]. For example, PT5S represents 5 +// seconds, PT5M represents 5 minutes, and PT5H represents 5 hours. +// +// [ISO 8601 format]: https://en.wikipedia.org/wiki/ISO_8601 type TumblingWindow struct { // The time interval for the tumbling window. The interval time must be between 1 - // minute and 1 week. IoT SiteWise computes the 1w interval the end of Sunday at - // midnight each week (UTC), the 1d interval at the end of each day at midnight - // (UTC), the 1h interval at the end of each hour, and so on. When IoT SiteWise - // aggregates data points for metric computations, the start of each interval is - // exclusive and the end of each interval is inclusive. IoT SiteWise places the - // computed data point at the end of the interval. + // minute and 1 week. + // + // IoT SiteWise computes the 1w interval the end of Sunday at midnight each week + // (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h + // interval at the end of each hour, and so on. + // + // When IoT SiteWise aggregates data points for metric computations, the start of + // each interval is exclusive and the end of each interval is inclusive. IoT + // SiteWise places the computed data point at the end of the interval. // // 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: + // + // - 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: + // + // - 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: + // + // - 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 @@ -2589,19 +2762,23 @@ 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. If the hierarchy has an external // ID, you can specify externalId: followed by the external ID. For more - // information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. 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 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) - // in the IoT SiteWise User Guide. + // information, see [Using external IDs]in the IoT SiteWise User Guide. + // + // 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 assets that come from the same asset + // model. For more information, see [Asset hierarchies]in the IoT SiteWise User Guide. + // + // [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids HierarchyId *string // The ID of the property to use as the variable. You can use the property name if // it's from the same asset model. If the property has an external ID, you can - // specify externalId: followed by the external ID. For more information, see - // Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids) - // in the IoT SiteWise User Guide. + // specify externalId: followed by the external ID. For more information, see [Using external IDs] in + // the IoT SiteWise User Guide. + // + // [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids PropertyId *string // The path of the property. diff --git a/service/iotthingsgraph/api_op_AssociateEntityToThing.go b/service/iotthingsgraph/api_op_AssociateEntityToThing.go index 989de31c15e..f4704607522 100644 --- a/service/iotthingsgraph/api_op_AssociateEntityToThing.go +++ b/service/iotthingsgraph/api_op_AssociateEntityToThing.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a device with a concrete thing that is in the user's registry. A -// thing can be associated with only one device at a time. If you associate a thing -// with a new device id, its previous association will be removed. +// Associates a device with a concrete thing that is in the user's registry. +// +// A thing can be associated with only one device at a time. If you associate a +// thing with a new device id, its previous association will be removed. // // Deprecated: since: 2022-08-30 func (c *Client) AssociateEntityToThing(ctx context.Context, params *AssociateEntityToThingInput, optFns ...func(*Options)) (*AssociateEntityToThingOutput, error) { @@ -32,8 +33,11 @@ func (c *Client) AssociateEntityToThing(ctx context.Context, params *AssociateEn type AssociateEntityToThingInput struct { - // The ID of the device to be associated with the thing. The ID should be in the - // following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME + // The ID of the device to be associated with the thing. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME // // This member is required. EntityId *string diff --git a/service/iotthingsgraph/api_op_CreateFlowTemplate.go b/service/iotthingsgraph/api_op_CreateFlowTemplate.go index cc5fff41e0d..ecc6fe3d542 100644 --- a/service/iotthingsgraph/api_op_CreateFlowTemplate.go +++ b/service/iotthingsgraph/api_op_CreateFlowTemplate.go @@ -40,8 +40,9 @@ type CreateFlowTemplateInput struct { // This member is required. Definition *types.DefinitionDocument - // The namespace version in which the workflow is to be created. If no value is - // specified, the latest version is used by default. + // The namespace version in which the workflow is to be created. + // + // If no value is specified, the latest version is used by default. CompatibleNamespaceVersion *int64 noSmithyDocumentSerde diff --git a/service/iotthingsgraph/api_op_CreateSystemInstance.go b/service/iotthingsgraph/api_op_CreateSystemInstance.go index 6fb9f88326c..31f25fe53cf 100644 --- a/service/iotthingsgraph/api_op_CreateSystemInstance.go +++ b/service/iotthingsgraph/api_op_CreateSystemInstance.go @@ -11,19 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// namespace, the latest version will be used by default. +// 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 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 namespace, +// the latest version will be used by default. // // Deprecated: since: 2022-08-30 func (c *Client) CreateSystemInstance(ctx context.Context, params *CreateSystemInstanceInput, optFns ...func(*Options)) (*CreateSystemInstanceOutput, error) { diff --git a/service/iotthingsgraph/api_op_CreateSystemTemplate.go b/service/iotthingsgraph/api_op_CreateSystemTemplate.go index 46dda25c1a2..86b8d9b0134 100644 --- a/service/iotthingsgraph/api_op_CreateSystemTemplate.go +++ b/service/iotthingsgraph/api_op_CreateSystemTemplate.go @@ -38,8 +38,9 @@ type CreateSystemTemplateInput struct { // This member is required. Definition *types.DefinitionDocument - // The namespace version in which the system is to be created. If no value is - // specified, the latest version is used by default. + // The namespace version in which the system is to be created. + // + // If no value is specified, the latest version is used by default. CompatibleNamespaceVersion *int64 noSmithyDocumentSerde diff --git a/service/iotthingsgraph/api_op_DeleteFlowTemplate.go b/service/iotthingsgraph/api_op_DeleteFlowTemplate.go index cea70a040da..5f0501c811b 100644 --- a/service/iotthingsgraph/api_op_DeleteFlowTemplate.go +++ b/service/iotthingsgraph/api_op_DeleteFlowTemplate.go @@ -33,8 +33,11 @@ func (c *Client) DeleteFlowTemplate(ctx context.Context, params *DeleteFlowTempl type DeleteFlowTemplateInput struct { - // The ID of the workflow to be deleted. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME + // The ID of the workflow to be deleted. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_DeleteSystemInstance.go b/service/iotthingsgraph/api_op_DeleteSystemInstance.go index 8ba87186f6a..7598ef25cfc 100644 --- a/service/iotthingsgraph/api_op_DeleteSystemInstance.go +++ b/service/iotthingsgraph/api_op_DeleteSystemInstance.go @@ -11,8 +11,10 @@ import ( ) // Deletes a system instance. Only system instances that have never been deployed, -// or that have been undeployed can be deleted. Users can create a new system -// instance that has the same ID as a deleted system instance. +// or that have been undeployed can be deleted. +// +// Users can create a new system instance that has the same ID as a deleted system +// instance. // // Deprecated: since: 2022-08-30 func (c *Client) DeleteSystemInstance(ctx context.Context, params *DeleteSystemInstanceInput, optFns ...func(*Options)) (*DeleteSystemInstanceOutput, error) { diff --git a/service/iotthingsgraph/api_op_DeleteSystemTemplate.go b/service/iotthingsgraph/api_op_DeleteSystemTemplate.go index 965509c1cba..e314312baa3 100644 --- a/service/iotthingsgraph/api_op_DeleteSystemTemplate.go +++ b/service/iotthingsgraph/api_op_DeleteSystemTemplate.go @@ -32,8 +32,11 @@ func (c *Client) DeleteSystemTemplate(ctx context.Context, params *DeleteSystemT type DeleteSystemTemplateInput struct { - // The ID of the system to be deleted. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME + // The ID of the system to be deleted. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_DeploySystemInstance.go b/service/iotthingsgraph/api_op_DeploySystemInstance.go index 850982ed849..a4f1a6340f6 100644 --- a/service/iotthingsgraph/api_op_DeploySystemInstance.go +++ b/service/iotthingsgraph/api_op_DeploySystemInstance.go @@ -11,19 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Greengrass and Cloud Deployments Deploys the system instance to the target -// 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 -// caller's behalf, the calling identity must have write permissions to the -// 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 and Cloud Deployments +// +// Deploys the system instance to the target 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 caller's behalf, the +// calling identity must have write permissions to the 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]. // // Deprecated: since: 2022-08-30 +// +// [AWS IoT Things Graph and AWS IoT Greengrass]: https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-greengrass.html func (c *Client) DeploySystemInstance(ctx context.Context, params *DeploySystemInstanceInput, optFns ...func(*Options)) (*DeploySystemInstanceOutput, error) { if params == nil { params = &DeploySystemInstanceInput{} @@ -42,8 +49,11 @@ func (c *Client) DeploySystemInstance(ctx context.Context, params *DeploySystemI type DeploySystemInstanceInput struct { // The ID of the system instance. This value is returned by the - // CreateSystemInstance action. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME + // CreateSystemInstance action. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME Id *string noSmithyDocumentSerde diff --git a/service/iotthingsgraph/api_op_DeprecateFlowTemplate.go b/service/iotthingsgraph/api_op_DeprecateFlowTemplate.go index 539f5c65662..cc0e2d6ed41 100644 --- a/service/iotthingsgraph/api_op_DeprecateFlowTemplate.go +++ b/service/iotthingsgraph/api_op_DeprecateFlowTemplate.go @@ -32,8 +32,11 @@ func (c *Client) DeprecateFlowTemplate(ctx context.Context, params *DeprecateFlo type DeprecateFlowTemplateInput struct { - // The ID of the workflow to be deleted. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME + // The ID of the workflow to be deleted. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_DeprecateSystemTemplate.go b/service/iotthingsgraph/api_op_DeprecateSystemTemplate.go index 554fd811b90..73b374cfd5e 100644 --- a/service/iotthingsgraph/api_op_DeprecateSystemTemplate.go +++ b/service/iotthingsgraph/api_op_DeprecateSystemTemplate.go @@ -30,8 +30,11 @@ func (c *Client) DeprecateSystemTemplate(ctx context.Context, params *DeprecateS type DeprecateSystemTemplateInput struct { - // The ID of the system to delete. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME + // The ID of the system to delete. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_GetEntities.go b/service/iotthingsgraph/api_op_GetEntities.go index 0a788ed17a0..52c0dad49f0 100644 --- a/service/iotthingsgraph/api_op_GetEntities.go +++ b/service/iotthingsgraph/api_op_GetEntities.go @@ -13,14 +13,23 @@ 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 // // This action doesn't return definitions for systems, flows, and deployments. @@ -43,8 +52,11 @@ func (c *Client) GetEntities(ctx context.Context, params *GetEntitiesInput, optF type GetEntitiesInput struct { - // An array of entity IDs. The IDs should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME + // An array of entity IDs. + // + // The IDs should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME // // This member is required. Ids []string diff --git a/service/iotthingsgraph/api_op_GetFlowTemplate.go b/service/iotthingsgraph/api_op_GetFlowTemplate.go index cac5112ce53..6446cade3bd 100644 --- a/service/iotthingsgraph/api_op_GetFlowTemplate.go +++ b/service/iotthingsgraph/api_op_GetFlowTemplate.go @@ -32,8 +32,11 @@ func (c *Client) GetFlowTemplate(ctx context.Context, params *GetFlowTemplateInp type GetFlowTemplateInput struct { - // The ID of the workflow. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME + // The ID of the workflow. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go b/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go index cb11b6dfc9a..aadc76b489f 100644 --- a/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go +++ b/service/iotthingsgraph/api_op_GetFlowTemplateRevisions.go @@ -34,8 +34,11 @@ func (c *Client) GetFlowTemplateRevisions(ctx context.Context, params *GetFlowTe type GetFlowTemplateRevisionsInput struct { - // The ID of the workflow. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME + // The ID of the workflow. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_GetSystemInstance.go b/service/iotthingsgraph/api_op_GetSystemInstance.go index 0303bb657d4..f49c377bd09 100644 --- a/service/iotthingsgraph/api_op_GetSystemInstance.go +++ b/service/iotthingsgraph/api_op_GetSystemInstance.go @@ -32,8 +32,11 @@ 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. - // urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME + // CreateSystemInstance . + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_GetSystemTemplate.go b/service/iotthingsgraph/api_op_GetSystemTemplate.go index 7e88e9ff67a..73d121f009e 100644 --- a/service/iotthingsgraph/api_op_GetSystemTemplate.go +++ b/service/iotthingsgraph/api_op_GetSystemTemplate.go @@ -31,9 +31,11 @@ func (c *Client) GetSystemTemplate(ctx context.Context, params *GetSystemTemplat type GetSystemTemplateInput struct { - // The ID of the system to get. This ID must be in the user's namespace. The ID - // should be in the following format. urn:tdm:REGION/ACCOUNT - // ID/default:system:SYSTEMNAME + // The ID of the system to get. This ID must be in the user's namespace. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go b/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go index 6668032b94c..e99b9f09b81 100644 --- a/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go +++ b/service/iotthingsgraph/api_op_GetSystemTemplateRevisions.go @@ -34,8 +34,11 @@ func (c *Client) GetSystemTemplateRevisions(ctx context.Context, params *GetSyst type GetSystemTemplateRevisionsInput struct { - // The ID of the system template. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME + // The ID of the system template. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME // // This member is required. Id *string diff --git a/service/iotthingsgraph/api_op_SearchEntities.go b/service/iotthingsgraph/api_op_SearchEntities.go index ff0975898d6..6b8b21f47f1 100644 --- a/service/iotthingsgraph/api_op_SearchEntities.go +++ b/service/iotthingsgraph/api_op_SearchEntities.go @@ -40,9 +40,10 @@ type SearchEntitiesInput struct { // 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 - // function as AND criteria. + // 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 function as AND criteria. Filters []types.EntityFilter // The maximum number of results to return in the response. diff --git a/service/iotthingsgraph/api_op_SearchSystemInstances.go b/service/iotthingsgraph/api_op_SearchSystemInstances.go index 09212404a9f..caafd0a9800 100644 --- a/service/iotthingsgraph/api_op_SearchSystemInstances.go +++ b/service/iotthingsgraph/api_op_SearchSystemInstances.go @@ -32,8 +32,10 @@ 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 - // the query. Multiple values passed inside the filter function as AND criteria. + // 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 // 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 5d3850501f2..f2be4bb4400 100644 --- a/service/iotthingsgraph/api_op_SearchThings.go +++ b/service/iotthingsgraph/api_op_SearchThings.go @@ -12,11 +12,15 @@ import ( ) // 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 -// searches for exact matches and doesn't perform partial text matching. +// 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 searches for exact matches and doesn't perform partial text +// matching. // // Deprecated: since: 2022-08-30 func (c *Client) SearchThings(ctx context.Context, params *SearchThingsInput, optFns ...func(*Options)) (*SearchThingsOutput, error) { @@ -36,8 +40,11 @@ func (c *Client) SearchThings(ctx context.Context, params *SearchThingsInput, op type SearchThingsInput struct { - // The ID of the entity to which the things are associated. The IDs should be in - // the following format. urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME + // The ID of the entity to which the things are associated. + // + // The IDs should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME // // This member is required. EntityId *string diff --git a/service/iotthingsgraph/api_op_UntagResource.go b/service/iotthingsgraph/api_op_UntagResource.go index ca4c8e36f50..66ae239068e 100644 --- a/service/iotthingsgraph/api_op_UntagResource.go +++ b/service/iotthingsgraph/api_op_UntagResource.go @@ -36,11 +36,13 @@ type UntagResourceInput struct { ResourceArn *string // A list of tag key names to remove from the resource. You don't specify the - // 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) - // in the AWS CLI User Guide. + // 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]in the AWS CLI User Guide. + // + // [Using JSON for Parameters]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json // // This member is required. TagKeys []string diff --git a/service/iotthingsgraph/api_op_UpdateFlowTemplate.go b/service/iotthingsgraph/api_op_UpdateFlowTemplate.go index 5ebd40b0404..3cb844af5a2 100644 --- a/service/iotthingsgraph/api_op_UpdateFlowTemplate.go +++ b/service/iotthingsgraph/api_op_UpdateFlowTemplate.go @@ -40,15 +40,20 @@ type UpdateFlowTemplateInput struct { // This member is required. Definition *types.DefinitionDocument - // The ID of the workflow to be updated. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME + // The ID of the workflow to be updated. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME // // This member is required. 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. + // 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. CompatibleNamespaceVersion *int64 noSmithyDocumentSerde diff --git a/service/iotthingsgraph/api_op_UpdateSystemTemplate.go b/service/iotthingsgraph/api_op_UpdateSystemTemplate.go index 0b45d99aed9..ef4c5662610 100644 --- a/service/iotthingsgraph/api_op_UpdateSystemTemplate.go +++ b/service/iotthingsgraph/api_op_UpdateSystemTemplate.go @@ -38,15 +38,19 @@ type UpdateSystemTemplateInput struct { // This member is required. Definition *types.DefinitionDocument - // The ID of the system to be updated. The ID should be in the following format. - // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME + // The ID of the system to be updated. + // + // The ID should be in the following format. + // + // urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME // // This member is required. Id *string // The version of the user's namespace. Defaults to the latest version of the - // user's namespace. If no value is specified, the latest version is used by - // default. + // user's namespace. + // + // If no value is specified, the latest version is used by default. CompatibleNamespaceVersion *int64 noSmithyDocumentSerde diff --git a/service/iotthingsgraph/api_op_UploadEntityDefinitions.go b/service/iotthingsgraph/api_op_UploadEntityDefinitions.go index a393904a5c8..2aeb1a1bf6a 100644 --- a/service/iotthingsgraph/api_op_UploadEntityDefinitions.go +++ b/service/iotthingsgraph/api_op_UploadEntityDefinitions.go @@ -17,17 +17,21 @@ import ( // 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 -// 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 . +// 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 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 . // // Deprecated: since: 2022-08-30 func (c *Client) UploadEntityDefinitions(ctx context.Context, params *UploadEntityDefinitionsInput, optFns ...func(*Options)) (*UploadEntityDefinitionsOutput, error) { diff --git a/service/iotthingsgraph/doc.go b/service/iotthingsgraph/doc.go index a4c84743b56..fd379d7105e 100644 --- a/service/iotthingsgraph/doc.go +++ b/service/iotthingsgraph/doc.go @@ -3,12 +3,17 @@ // Package iotthingsgraph provides the API client, operations, and parameter types // for AWS IoT Things Graph. // -// AWS IoT Things Graph AWS IoT Things Graph provides an integrated set of tools -// that enable developers to connect devices and services that use different -// standards, such as units of measure and communication protocols. AWS IoT Things -// 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) . +// # AWS IoT Things Graph +// +// AWS IoT Things Graph provides an integrated set of tools that enable developers +// to connect devices and services that use different standards, such as units of +// measure and communication protocols. AWS IoT Things 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]. +// // The AWS IoT Things Graph service is discontinued. +// +// [User Guide]: https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html package iotthingsgraph diff --git a/service/iotthingsgraph/options.go b/service/iotthingsgraph/options.go index 489330e364f..110703987c3 100644 --- a/service/iotthingsgraph/options.go +++ b/service/iotthingsgraph/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotthingsgraph/types/enums.go b/service/iotthingsgraph/types/enums.go index a3065d73876..6e2ff4dfbba 100644 --- a/service/iotthingsgraph/types/enums.go +++ b/service/iotthingsgraph/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for DefinitionLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefinitionLanguage) Values() []DefinitionLanguage { return []DefinitionLanguage{ "GRAPHQL", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for DeploymentTarget. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentTarget) Values() []DeploymentTarget { return []DeploymentTarget{ "GREENGRASS", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for EntityFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityFilterName) Values() []EntityFilterName { return []EntityFilterName{ "NAME", @@ -75,8 +78,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "DEVICE", @@ -116,8 +120,9 @@ const ( ) // Values returns all known values for FlowExecutionEventType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlowExecutionEventType) Values() []FlowExecutionEventType { return []FlowExecutionEventType{ "EXECUTION_STARTED", @@ -151,8 +156,9 @@ const ( ) // Values returns all known values for FlowExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlowExecutionStatus) Values() []FlowExecutionStatus { return []FlowExecutionStatus{ "RUNNING", @@ -170,8 +176,9 @@ const ( ) // Values returns all known values for FlowTemplateFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlowTemplateFilterName) Values() []FlowTemplateFilterName { return []FlowTemplateFilterName{ "DEVICE_MODEL_ID", @@ -188,8 +195,9 @@ const ( ) // Values returns all known values for NamespaceDeletionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceDeletionStatus) Values() []NamespaceDeletionStatus { return []NamespaceDeletionStatus{ "IN_PROGRESS", @@ -207,8 +215,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceDeletionStatusErrorCodes) Values() []NamespaceDeletionStatusErrorCodes { return []NamespaceDeletionStatusErrorCodes{ "VALIDATION_FAILED", @@ -231,8 +240,9 @@ const ( // Values returns all known values for SystemInstanceDeploymentStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SystemInstanceDeploymentStatus) Values() []SystemInstanceDeploymentStatus { return []SystemInstanceDeploymentStatus{ "NOT_DEPLOYED", @@ -257,6 +267,7 @@ const ( // 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{ @@ -275,6 +286,7 @@ const ( // 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{ @@ -292,8 +304,9 @@ const ( ) // 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. +// expanded in the future, and so 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/iottwinmaker/api_op_CreateSyncJob.go b/service/iottwinmaker/api_op_CreateSyncJob.go index 658b2622478..acb91ebd7b7 100644 --- a/service/iottwinmaker/api_op_CreateSyncJob.go +++ b/service/iottwinmaker/api_op_CreateSyncJob.go @@ -36,7 +36,9 @@ type CreateSyncJobInput struct { // This member is required. SyncRole *string - // The sync source. Currently the only supported syncSoource is SITEWISE . + // The sync source. + // + // Currently the only supported syncSoource is SITEWISE . // // This member is required. SyncSource *string diff --git a/service/iottwinmaker/api_op_DeleteSyncJob.go b/service/iottwinmaker/api_op_DeleteSyncJob.go index e574c44d7f8..1fc0002e77d 100644 --- a/service/iottwinmaker/api_op_DeleteSyncJob.go +++ b/service/iottwinmaker/api_op_DeleteSyncJob.go @@ -29,7 +29,9 @@ func (c *Client) DeleteSyncJob(ctx context.Context, params *DeleteSyncJobInput, type DeleteSyncJobInput struct { - // The sync source. Currently the only supported syncSource is SITEWISE . + // The sync source. + // + // Currently the only supported syncSource is SITEWISE . // // This member is required. SyncSource *string diff --git a/service/iottwinmaker/api_op_ExecuteQuery.go b/service/iottwinmaker/api_op_ExecuteQuery.go index e3c456c9d8a..1dd3022bcda 100644 --- a/service/iottwinmaker/api_op_ExecuteQuery.go +++ b/service/iottwinmaker/api_op_ExecuteQuery.go @@ -12,10 +12,12 @@ import ( ) // Run queries to access information from your knowledge graph of entities within -// individual workspaces. The ExecuteQuery action only works with Amazon Web -// Services Java SDK2 (https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html) -// . ExecuteQuery will not work with any Amazon Web Services Java SDK version < -// 2.x. +// individual workspaces. +// +// The ExecuteQuery action only works with [Amazon Web Services Java SDK2]. ExecuteQuery will not work with any +// Amazon Web Services Java SDK version < 2.x. +// +// [Amazon Web Services Java SDK2]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html func (c *Client) ExecuteQuery(ctx context.Context, params *ExecuteQueryInput, optFns ...func(*Options)) (*ExecuteQueryOutput, error) { if params == nil { params = &ExecuteQueryInput{} diff --git a/service/iottwinmaker/api_op_GetComponentType.go b/service/iottwinmaker/api_op_GetComponentType.go index 82641a210f7..ddf1c10af6e 100644 --- a/service/iottwinmaker/api_op_GetComponentType.go +++ b/service/iottwinmaker/api_op_GetComponentType.go @@ -102,8 +102,9 @@ type GetComponentTypeOutput struct { // Each string in the mapping must be unique to this object. PropertyDefinitions map[string]types.PropertyDefinitionResponse - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. PropertyGroups map[string]types.PropertyGroupResponse // The current status of the component type. diff --git a/service/iottwinmaker/api_op_GetPropertyValue.go b/service/iottwinmaker/api_op_GetPropertyValue.go index 3897bf23d1a..7402aaf9136 100644 --- a/service/iottwinmaker/api_op_GetPropertyValue.go +++ b/service/iottwinmaker/api_op_GetPropertyValue.go @@ -12,6 +12,7 @@ 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 . func (c *Client) GetPropertyValue(ctx context.Context, params *GetPropertyValueInput, optFns ...func(*Options)) (*GetPropertyValueOutput, error) { @@ -54,8 +55,9 @@ type GetPropertyValueInput struct { // The ID of the entity whose property values the operation returns. EntityId *string - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. MaxResults *int32 // The string that specifies the next page of results. @@ -207,8 +209,9 @@ var _ GetPropertyValueAPIClient = (*Client)(nil) // GetPropertyValuePaginatorOptions is the paginator options for GetPropertyValue type GetPropertyValuePaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/api_op_GetPropertyValueHistory.go b/service/iottwinmaker/api_op_GetPropertyValueHistory.go index 7ccd23d984c..12a6c3fc0ee 100644 --- a/service/iottwinmaker/api_op_GetPropertyValueHistory.go +++ b/service/iottwinmaker/api_op_GetPropertyValueHistory.go @@ -13,9 +13,11 @@ 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 . +// 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 . func (c *Client) GetPropertyValueHistory(ctx context.Context, params *GetPropertyValueHistoryInput, optFns ...func(*Options)) (*GetPropertyValueHistoryOutput, error) { if params == nil { params = &GetPropertyValueHistoryInput{} @@ -59,9 +61,11 @@ type GetPropertyValueHistoryInput struct { // endTime instead. 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) - // . + // The ISO8601 DateTime of the latest property value to return. + // + // For more information about the ISO8601 DateTime format, see the data type [PropertyValue]. + // + // [PropertyValue]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html EndTime *string // The ID of the entity. @@ -71,8 +75,9 @@ type GetPropertyValueHistoryInput struct { // interpolate data. Interpolation *types.InterpolationParameters - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. MaxResults *int32 // The string that specifies the next page of results. @@ -90,9 +95,11 @@ type GetPropertyValueHistoryInput struct { // startTime instead. 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) - // . + // The ISO8601 DateTime of the earliest property value to return. + // + // For more information about the ISO8601 DateTime format, see the data type [PropertyValue]. + // + // [PropertyValue]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html StartTime *string noSmithyDocumentSerde @@ -235,8 +242,9 @@ var _ GetPropertyValueHistoryAPIClient = (*Client)(nil) // GetPropertyValueHistoryPaginatorOptions is the paginator options for // GetPropertyValueHistory type GetPropertyValueHistoryPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/api_op_GetSyncJob.go b/service/iottwinmaker/api_op_GetSyncJob.go index 3a39582f99a..c4d68f5504e 100644 --- a/service/iottwinmaker/api_op_GetSyncJob.go +++ b/service/iottwinmaker/api_op_GetSyncJob.go @@ -30,7 +30,9 @@ func (c *Client) GetSyncJob(ctx context.Context, params *GetSyncJobInput, optFns type GetSyncJobInput struct { - // The sync source. Currently the only supported syncSource is SITEWISE . + // The sync source. + // + // Currently the only supported syncSource is SITEWISE . // // This member is required. SyncSource *string @@ -63,7 +65,9 @@ type GetSyncJobOutput struct { // This member is required. SyncRole *string - // The sync soucre. Currently the only supported syncSource is SITEWISE . + // The sync soucre. + // + // Currently the only supported syncSource is SITEWISE . // // This member is required. SyncSource *string diff --git a/service/iottwinmaker/api_op_ListComponentTypes.go b/service/iottwinmaker/api_op_ListComponentTypes.go index 16fcdcf1e96..c0fcf501fcb 100644 --- a/service/iottwinmaker/api_op_ListComponentTypes.go +++ b/service/iottwinmaker/api_op_ListComponentTypes.go @@ -37,8 +37,9 @@ type ListComponentTypesInput struct { // A list of objects that filter the request. Filters []types.ListComponentTypesFilter - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. MaxResults *int32 // The string that specifies the next page of results. @@ -191,8 +192,9 @@ var _ ListComponentTypesAPIClient = (*Client)(nil) // ListComponentTypesPaginatorOptions is the paginator options for // ListComponentTypes type ListComponentTypesPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/api_op_ListEntities.go b/service/iottwinmaker/api_op_ListEntities.go index 0fe942b23ec..5e646573bd5 100644 --- a/service/iottwinmaker/api_op_ListEntities.go +++ b/service/iottwinmaker/api_op_ListEntities.go @@ -34,12 +34,14 @@ type ListEntitiesInput struct { // This member is required. WorkspaceId *string - // A list of objects that filter the request. Only one object is accepted as a - // valid input. + // A list of objects that filter the request. + // + // Only one object is accepted as a valid input. Filters []types.ListEntitiesFilter - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. MaxResults *int32 // The string that specifies the next page of results. @@ -180,8 +182,9 @@ var _ ListEntitiesAPIClient = (*Client)(nil) // ListEntitiesPaginatorOptions is the paginator options for ListEntities type ListEntitiesPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/api_op_ListSyncJobs.go b/service/iottwinmaker/api_op_ListSyncJobs.go index 07dbd61b6f9..4a4dd8b2b87 100644 --- a/service/iottwinmaker/api_op_ListSyncJobs.go +++ b/service/iottwinmaker/api_op_ListSyncJobs.go @@ -34,8 +34,9 @@ type ListSyncJobsInput struct { // This member is required. WorkspaceId *string - // The maximum number of results to return at one time. The default is 50. Valid - // Range: Minimum value of 0. Maximum value of 200. + // The maximum number of results to return at one time. The default is 50. + // + // Valid Range: Minimum value of 0. Maximum value of 200. MaxResults *int32 // The string that specifies the next page of results. @@ -176,8 +177,9 @@ var _ ListSyncJobsAPIClient = (*Client)(nil) // ListSyncJobsPaginatorOptions is the paginator options for ListSyncJobs type ListSyncJobsPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 50. Valid - // Range: Minimum value of 0. Maximum value of 200. + // The maximum number of results to return at one time. The default is 50. + // + // Valid Range: Minimum value of 0. Maximum value of 200. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/api_op_ListSyncResources.go b/service/iottwinmaker/api_op_ListSyncResources.go index 1f02c59c3e6..ecdf1eeb3fb 100644 --- a/service/iottwinmaker/api_op_ListSyncResources.go +++ b/service/iottwinmaker/api_op_ListSyncResources.go @@ -29,7 +29,9 @@ func (c *Client) ListSyncResources(ctx context.Context, params *ListSyncResource type ListSyncResourcesInput struct { - // The sync source. Currently the only supported syncSource is SITEWISE . + // The sync source. + // + // Currently the only supported syncSource is SITEWISE . // // This member is required. SyncSource *string @@ -39,15 +41,20 @@ type ListSyncResourcesInput struct { // This member is required. WorkspaceId *string - // A list of objects that filter the request. The following filter combinations - // are supported: + // 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 - // Range: Minimum value of 0. Maximum value of 200. + // The maximum number of results to return at one time. The default is 50. + // + // Valid Range: Minimum value of 0. Maximum value of 200. MaxResults *int32 // The string that specifies the next page of results. @@ -189,8 +196,9 @@ var _ ListSyncResourcesAPIClient = (*Client)(nil) // ListSyncResourcesPaginatorOptions is the paginator options for ListSyncResources type ListSyncResourcesPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 50. Valid - // Range: Minimum value of 0. Maximum value of 200. + // The maximum number of results to return at one time. The default is 50. + // + // Valid Range: Minimum value of 0. Maximum value of 200. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/api_op_ListTagsForResource.go b/service/iottwinmaker/api_op_ListTagsForResource.go index 851370ac4b6..14e066a03bc 100644 --- a/service/iottwinmaker/api_op_ListTagsForResource.go +++ b/service/iottwinmaker/api_op_ListTagsForResource.go @@ -33,8 +33,9 @@ type ListTagsForResourceInput struct { // This member is required. ResourceARN *string - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. MaxResults *int32 // The string that specifies the next page of results. diff --git a/service/iottwinmaker/api_op_ListWorkspaces.go b/service/iottwinmaker/api_op_ListWorkspaces.go index f444c42d1fd..51f7bfd4d6d 100644 --- a/service/iottwinmaker/api_op_ListWorkspaces.go +++ b/service/iottwinmaker/api_op_ListWorkspaces.go @@ -29,8 +29,9 @@ func (c *Client) ListWorkspaces(ctx context.Context, params *ListWorkspacesInput type ListWorkspacesInput struct { - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. MaxResults *int32 // The string that specifies the next page of results. @@ -169,8 +170,9 @@ var _ ListWorkspacesAPIClient = (*Client)(nil) // ListWorkspacesPaginatorOptions is the paginator options for ListWorkspaces type ListWorkspacesPaginatorOptions struct { - // The maximum number of results to return at one time. The default is 25. Valid - // Range: Minimum value of 1. Maximum value of 250. + // The maximum number of results to return at one time. The default is 25. + // + // Valid Range: Minimum value of 1. Maximum value of 250. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/iottwinmaker/options.go b/service/iottwinmaker/options.go index b383a8eefbd..c1f46692112 100644 --- a/service/iottwinmaker/options.go +++ b/service/iottwinmaker/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iottwinmaker/types/enums.go b/service/iottwinmaker/types/enums.go index b0091cb5c97..c58f00ebee2 100644 --- a/service/iottwinmaker/types/enums.go +++ b/service/iottwinmaker/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ColumnType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnType) Values() []ColumnType { return []ColumnType{ "NODE", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for ComponentUpdateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentUpdateType) Values() []ComponentUpdateType { return []ComponentUpdateType{ "CREATE", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for DestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationType) Values() []DestinationType { return []DestinationType{ "s3", @@ -77,8 +80,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -100,8 +104,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for InterpolationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InterpolationType) Values() []InterpolationType { return []InterpolationType{ "LINEAR", @@ -139,6 +145,7 @@ const ( // Values returns all known values for MetadataTransferJobState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MetadataTransferJobState) Values() []MetadataTransferJobState { return []MetadataTransferJobState{ @@ -161,8 +168,9 @@ const ( ) // 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. +// the future, and so 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{ "ASCENDING", @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for OrderByTime. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderByTime) Values() []OrderByTime { return []OrderByTime{ "ASCENDING", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for ParentEntityUpdateType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParentEntityUpdateType) Values() []ParentEntityUpdateType { return []ParentEntityUpdateType{ "UPDATE", @@ -216,8 +226,9 @@ const ( ) // Values returns all known values for PricingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingMode) Values() []PricingMode { return []PricingMode{ "BASIC", @@ -237,8 +248,9 @@ const ( ) // Values returns all known values for PricingTier. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingTier) Values() []PricingTier { return []PricingTier{ "TIER_1", @@ -258,8 +270,9 @@ const ( ) // Values returns all known values for PropertyGroupUpdateType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyGroupUpdateType) Values() []PropertyGroupUpdateType { return []PropertyGroupUpdateType{ "UPDATE", @@ -278,8 +291,9 @@ const ( ) // Values returns all known values for PropertyUpdateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyUpdateType) Values() []PropertyUpdateType { return []PropertyUpdateType{ "UPDATE", @@ -296,8 +310,9 @@ const ( ) // Values returns all known values for SceneErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SceneErrorCode) Values() []SceneErrorCode { return []SceneErrorCode{ "MATTERPORT_ERROR", @@ -313,8 +328,9 @@ const ( ) // 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. +// the future, and so 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{ "ENTITY", @@ -332,8 +348,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "s3", @@ -354,8 +371,9 @@ const ( ) // 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. +// the future, and so 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{ "CREATING", @@ -378,8 +396,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -402,8 +421,9 @@ const ( ) // Values returns all known values for SyncResourceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncResourceState) Values() []SyncResourceState { return []SyncResourceState{ "INITIALIZING", @@ -423,8 +443,9 @@ const ( ) // Values returns all known values for SyncResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncResourceType) Values() []SyncResourceType { return []SyncResourceType{ "ENTITY", @@ -447,8 +468,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "RELATIONSHIP", @@ -474,8 +496,9 @@ const ( ) // 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. +// expanded in the future, and so 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 19b510de388..7ae9aef025a 100644 --- a/service/iottwinmaker/types/types.go +++ b/service/iottwinmaker/types/types.go @@ -698,8 +698,9 @@ type LambdaFunction struct { noSmithyDocumentSerde } -// An object that filters items in a list of component types. Only one object is -// accepted as a valid input. +// An object that filters items in a list of component types. +// +// Only one object is accepted as a valid input. // // The following types satisfy this interface: // @@ -1147,19 +1148,30 @@ type PropertyValue struct { // This member is required. Value *DataValue - // ISO8601 DateTime of a value for a time series property. The time for when the - // property value was recorded in ISO 8601 format: + // 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] Time *string @@ -1173,8 +1185,9 @@ 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) -// action. +// object is used and consumed by the [BatchPutPropertyValues]action. +// +// [BatchPutPropertyValues]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html type PropertyValueEntry struct { // An object that contains information about the entity that has the property. @@ -1462,7 +1475,9 @@ type TabularConditions struct { OrderBy []OrderBy // You can filter the request using various logical operators and a key-value - // format. For example: {"key": "serverType", "value": "webServer"} + // format. For example: + // + // {"key": "serverType", "value": "webServer"} PropertyFilters []PropertyFilter noSmithyDocumentSerde diff --git a/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go b/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go index 6a700546890..6f7e97cf50e 100644 --- a/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go +++ b/service/iotwireless/api_op_AssociateAwsAccountWithPartnerAccount.go @@ -40,9 +40,9 @@ type AssociateAwsAccountWithPartnerAccountInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The tags to attach to the specified resource. Tags are metadata that you can diff --git a/service/iotwireless/api_op_CreateDestination.go b/service/iotwireless/api_op_CreateDestination.go index 08f925fecc7..238103ee083 100644 --- a/service/iotwireless/api_op_CreateDestination.go +++ b/service/iotwireless/api_op_CreateDestination.go @@ -55,9 +55,9 @@ type CreateDestinationInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The description of the new resource. diff --git a/service/iotwireless/api_op_CreateDeviceProfile.go b/service/iotwireless/api_op_CreateDeviceProfile.go index f97a2c1141f..fcbc9dae22e 100644 --- a/service/iotwireless/api_op_CreateDeviceProfile.go +++ b/service/iotwireless/api_op_CreateDeviceProfile.go @@ -35,9 +35,9 @@ type CreateDeviceProfileInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The device profile information to use to create the device profile. diff --git a/service/iotwireless/api_op_CreateFuotaTask.go b/service/iotwireless/api_op_CreateFuotaTask.go index dda30808863..1bc3579da25 100644 --- a/service/iotwireless/api_op_CreateFuotaTask.go +++ b/service/iotwireless/api_op_CreateFuotaTask.go @@ -46,19 +46,21 @@ type CreateFuotaTaskInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The description of the new resource. Description *string // The interval for sending fragments in milliseconds, rounded to the nearest - // second. This interval only determines the timing for when the Cloud sends down - // the fragments to yor device. There can be a delay for when your device will - // receive these fragments. This delay depends on the device's class and the - // communication delay with the cloud. + // second. + // + // This interval only determines the timing for when the Cloud sends down the + // fragments to yor device. There can be a delay for when your device will receive + // these fragments. This delay depends on the device's class and the communication + // delay with the cloud. FragmentIntervalMS *int32 // The size of each fragment in bytes. This parameter is supported only for FUOTA diff --git a/service/iotwireless/api_op_CreateMulticastGroup.go b/service/iotwireless/api_op_CreateMulticastGroup.go index 00654c0b970..0ec91fd9bc8 100644 --- a/service/iotwireless/api_op_CreateMulticastGroup.go +++ b/service/iotwireless/api_op_CreateMulticastGroup.go @@ -40,9 +40,9 @@ type CreateMulticastGroupInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The description of the multicast group. diff --git a/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go b/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go index 1f340e6b6b0..e2765098971 100644 --- a/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go +++ b/service/iotwireless/api_op_CreateNetworkAnalyzerConfiguration.go @@ -40,9 +40,9 @@ type CreateNetworkAnalyzerConfigurationInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The description of the new resource. diff --git a/service/iotwireless/api_op_CreateServiceProfile.go b/service/iotwireless/api_op_CreateServiceProfile.go index 637407b9418..4118fceb6fb 100644 --- a/service/iotwireless/api_op_CreateServiceProfile.go +++ b/service/iotwireless/api_op_CreateServiceProfile.go @@ -35,9 +35,9 @@ type CreateServiceProfileInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The service profile information to use to create the service profile. diff --git a/service/iotwireless/api_op_CreateWirelessDevice.go b/service/iotwireless/api_op_CreateWirelessDevice.go index e4133ff20e6..13ac0284bf7 100644 --- a/service/iotwireless/api_op_CreateWirelessDevice.go +++ b/service/iotwireless/api_op_CreateWirelessDevice.go @@ -45,9 +45,9 @@ type CreateWirelessDeviceInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The description of the new resource. diff --git a/service/iotwireless/api_op_CreateWirelessGateway.go b/service/iotwireless/api_op_CreateWirelessGateway.go index 970d654ab5c..15b6953a242 100644 --- a/service/iotwireless/api_op_CreateWirelessGateway.go +++ b/service/iotwireless/api_op_CreateWirelessGateway.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provisions a wireless gateway. When provisioning a wireless gateway, you might -// run into duplication errors for the following reasons. +// Provisions a wireless gateway. +// +// When provisioning a wireless gateway, you might run into duplication errors for +// the following reasons. +// // - If you specify a GatewayEui value that already exists. +// // - If you used a ClientRequestToken with the same parameters within the last 10 // minutes. // @@ -47,9 +51,9 @@ type CreateWirelessGatewayInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The description of the new resource. diff --git a/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go b/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go index 7e57dbc2d70..2de6eca86f3 100644 --- a/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go +++ b/service/iotwireless/api_op_CreateWirelessGatewayTaskDefinition.go @@ -42,9 +42,9 @@ type CreateWirelessGatewayTaskDefinitionInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The name of the new resource. diff --git a/service/iotwireless/api_op_DeleteWirelessGateway.go b/service/iotwireless/api_op_DeleteWirelessGateway.go index c18a357b9f9..296aa98f593 100644 --- a/service/iotwireless/api_op_DeleteWirelessGateway.go +++ b/service/iotwireless/api_op_DeleteWirelessGateway.go @@ -10,9 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a wireless gateway. When deleting a wireless gateway, you might run -// into duplication errors for the following reasons. +// Deletes a wireless gateway. +// +// When deleting a wireless gateway, you might run into duplication errors for the +// following reasons. +// // - If you specify a GatewayEui value that already exists. +// // - If you used a ClientRequestToken with the same parameters within the last 10 // minutes. // diff --git a/service/iotwireless/api_op_GetFuotaTask.go b/service/iotwireless/api_op_GetFuotaTask.go index 3f516611c05..1fca41cb609 100644 --- a/service/iotwireless/api_op_GetFuotaTask.go +++ b/service/iotwireless/api_op_GetFuotaTask.go @@ -57,10 +57,12 @@ type GetFuotaTaskOutput struct { FirmwareUpdateRole *string // The interval for sending fragments in milliseconds, rounded to the nearest - // second. This interval only determines the timing for when the Cloud sends down - // the fragments to yor device. There can be a delay for when your device will - // receive these fragments. This delay depends on the device's class and the - // communication delay with the cloud. + // second. + // + // This interval only determines the timing for when the Cloud sends down the + // fragments to yor device. There can be a delay for when your device will receive + // these fragments. This delay depends on the device's class and the communication + // delay with the cloud. FragmentIntervalMS *int32 // The size of each fragment in bytes. This parameter is supported only for FUOTA diff --git a/service/iotwireless/api_op_GetPosition.go b/service/iotwireless/api_op_GetPosition.go index 54d7e14d2b3..94943f10170 100644 --- a/service/iotwireless/api_op_GetPosition.go +++ b/service/iotwireless/api_op_GetPosition.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API operation instead. +// Get the position information for a given resource. +// +// This action is no longer supported. Calls to retrieve the position information +// should use the [GetResourcePosition]API operation instead. // // Deprecated: This operation is no longer supported. +// +// [GetResourcePosition]: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html func (c *Client) GetPosition(ctx context.Context, params *GetPositionInput, optFns ...func(*Options)) (*GetPositionOutput, error) { if params == nil { params = &GetPositionInput{} diff --git a/service/iotwireless/api_op_GetPositionConfiguration.go b/service/iotwireless/api_op_GetPositionConfiguration.go index 382d079dcfd..6ec177de885 100644 --- a/service/iotwireless/api_op_GetPositionConfiguration.go +++ b/service/iotwireless/api_op_GetPositionConfiguration.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API operation instead. +// Get position configuration for a given resource. +// +// This action is no longer supported. Calls to retrieve the position +// configuration should use the [GetResourcePosition]API operation instead. // // Deprecated: This operation is no longer supported. +// +// [GetResourcePosition]: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html func (c *Client) GetPositionConfiguration(ctx context.Context, params *GetPositionConfigurationInput, optFns ...func(*Options)) (*GetPositionConfigurationOutput, error) { if params == nil { params = &GetPositionConfigurationInput{} diff --git a/service/iotwireless/api_op_GetPositionEstimate.go b/service/iotwireless/api_op_GetPositionEstimate.go index 8b61f354367..fbcfb6d7b72 100644 --- a/service/iotwireless/api_op_GetPositionEstimate.go +++ b/service/iotwireless/api_op_GetPositionEstimate.go @@ -61,12 +61,13 @@ type GetPositionEstimateInput struct { type GetPositionEstimateOutput struct { // The position information of the resource, displayed as a JSON payload. The - // payload is of type blob and uses the GeoJSON (https://geojson.org/) format, - // which a format that's used to encode geographic data structures. A sample - // payload contains the timestamp information, the WGS84 coordinates of the - // location, and the accuracy and confidence level. For more information and - // examples, see Resolve device location (console) (https://docs.aws.amazon.com/iot/latest/developerguide/location-resolve-console.html) - // . + // payload is of type blob and uses the [GeoJSON]format, which a format that's used to + // encode geographic data structures. A sample payload contains the timestamp + // information, the WGS84 coordinates of the location, and the accuracy and + // confidence level. For more information and examples, see [Resolve device location (console)]. + // + // [Resolve device location (console)]: https://docs.aws.amazon.com/iot/latest/developerguide/location-resolve-console.html + // [GeoJSON]: https://geojson.org/ GeoJsonPayload []byte // Metadata pertaining to the operation's result. diff --git a/service/iotwireless/api_op_GetResourcePosition.go b/service/iotwireless/api_op_GetResourcePosition.go index 2c294e94d59..40e4563b50b 100644 --- a/service/iotwireless/api_op_GetResourcePosition.go +++ b/service/iotwireless/api_op_GetResourcePosition.go @@ -12,8 +12,9 @@ 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)]. +// +// [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{} @@ -51,7 +52,9 @@ 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]. + // + // [GeoJSON]: https://geojson.org/ GeoJsonPayload []byte // Metadata pertaining to the operation's result. diff --git a/service/iotwireless/api_op_GetWirelessDeviceStatistics.go b/service/iotwireless/api_op_GetWirelessDeviceStatistics.go index 3302c712856..7703aef1322 100644 --- a/service/iotwireless/api_op_GetWirelessDeviceStatistics.go +++ b/service/iotwireless/api_op_GetWirelessDeviceStatistics.go @@ -39,8 +39,9 @@ type GetWirelessDeviceStatisticsInput struct { type GetWirelessDeviceStatisticsOutput struct { - // The date and time when the most recent uplink was received. This value is only - // valid for 3 months. + // The date and time when the most recent uplink was received. + // + // This value is only valid for 3 months. LastUplinkReceivedAt *string // Information about the wireless device's operations. diff --git a/service/iotwireless/api_op_GetWirelessGatewayStatistics.go b/service/iotwireless/api_op_GetWirelessGatewayStatistics.go index b74ea554636..c9066123c70 100644 --- a/service/iotwireless/api_op_GetWirelessGatewayStatistics.go +++ b/service/iotwireless/api_op_GetWirelessGatewayStatistics.go @@ -42,8 +42,9 @@ type GetWirelessGatewayStatisticsOutput struct { // The connection status of the wireless gateway. ConnectionStatus types.ConnectionStatus - // The date and time when the most recent uplink was received. This value is only - // valid for 3 months. + // The date and time when the most recent uplink was received. + // + // This value is only valid for 3 months. LastUplinkReceivedAt *string // The ID of the wireless gateway. diff --git a/service/iotwireless/api_op_GetWirelessGatewayTask.go b/service/iotwireless/api_op_GetWirelessGatewayTask.go index 63e75b1bb99..ccbc7f3dcbc 100644 --- a/service/iotwireless/api_op_GetWirelessGatewayTask.go +++ b/service/iotwireless/api_op_GetWirelessGatewayTask.go @@ -39,8 +39,9 @@ type GetWirelessGatewayTaskInput struct { type GetWirelessGatewayTaskOutput struct { - // The date and time when the most recent uplink was received. This value is only - // valid for 3 months. + // The date and time when the most recent uplink was received. + // + // This value is only valid for 3 months. LastUplinkReceivedAt *string // The status of the request. diff --git a/service/iotwireless/api_op_ListPositionConfigurations.go b/service/iotwireless/api_op_ListPositionConfigurations.go index 8e604292412..e99a481fc70 100644 --- a/service/iotwireless/api_op_ListPositionConfigurations.go +++ b/service/iotwireless/api_op_ListPositionConfigurations.go @@ -12,11 +12,13 @@ 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) -// API operation instead. +// should use the [GetResourcePosition]API operation instead. // // Deprecated: This operation is no longer supported. +// +// [GetResourcePosition]: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html func (c *Client) ListPositionConfigurations(ctx context.Context, params *ListPositionConfigurationsInput, optFns ...func(*Options)) (*ListPositionConfigurationsOutput, error) { if params == nil { params = &ListPositionConfigurationsInput{} diff --git a/service/iotwireless/api_op_PutPositionConfiguration.go b/service/iotwireless/api_op_PutPositionConfiguration.go index 784660c2838..7905484c3b6 100644 --- a/service/iotwireless/api_op_PutPositionConfiguration.go +++ b/service/iotwireless/api_op_PutPositionConfiguration.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API operation instead. +// Put position configuration for a given resource. +// +// This action is no longer supported. Calls to update the position configuration +// should use the [UpdateResourcePosition]API operation instead. // // Deprecated: This operation is no longer supported. +// +// [UpdateResourcePosition]: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html func (c *Client) PutPositionConfiguration(ctx context.Context, params *PutPositionConfigurationInput, optFns ...func(*Options)) (*PutPositionConfigurationOutput, error) { if params == nil { params = &PutPositionConfigurationInput{} diff --git a/service/iotwireless/api_op_StartSingleWirelessDeviceImportTask.go b/service/iotwireless/api_op_StartSingleWirelessDeviceImportTask.go index f1779972fc2..8beb28f87d2 100644 --- a/service/iotwireless/api_op_StartSingleWirelessDeviceImportTask.go +++ b/service/iotwireless/api_op_StartSingleWirelessDeviceImportTask.go @@ -47,9 +47,9 @@ type StartSingleWirelessDeviceImportTaskInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The name of the wireless device for which an import task is being started. diff --git a/service/iotwireless/api_op_StartWirelessDeviceImportTask.go b/service/iotwireless/api_op_StartWirelessDeviceImportTask.go index e977c726a8a..76f28caa52a 100644 --- a/service/iotwireless/api_op_StartWirelessDeviceImportTask.go +++ b/service/iotwireless/api_op_StartWirelessDeviceImportTask.go @@ -49,9 +49,9 @@ type StartWirelessDeviceImportTaskInput struct { // request will complete successfully. However, if you try to create a new resource // using the same token but different parameters, an HTTP 409 conflict occurs. If // you omit this value, AWS SDKs will automatically generate a unique client - // request. For more information about idempotency, see Ensuring idempotency in - // Amazon EC2 API requests (https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html) - // . + // request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests]. + // + // [Ensuring idempotency in Amazon EC2 API requests]: https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html ClientRequestToken *string // The tag to attach to the specified resource. Tags are metadata that you can use diff --git a/service/iotwireless/api_op_UpdateFuotaTask.go b/service/iotwireless/api_op_UpdateFuotaTask.go index 1e257cd26a5..1d3294ca4f7 100644 --- a/service/iotwireless/api_op_UpdateFuotaTask.go +++ b/service/iotwireless/api_op_UpdateFuotaTask.go @@ -45,10 +45,12 @@ type UpdateFuotaTaskInput struct { FirmwareUpdateRole *string // The interval for sending fragments in milliseconds, rounded to the nearest - // second. This interval only determines the timing for when the Cloud sends down - // the fragments to yor device. There can be a delay for when your device will - // receive these fragments. This delay depends on the device's class and the - // communication delay with the cloud. + // second. + // + // This interval only determines the timing for when the Cloud sends down the + // fragments to yor device. There can be a delay for when your device will receive + // these fragments. This delay depends on the device's class and the communication + // delay with the cloud. FragmentIntervalMS *int32 // The size of each fragment in bytes. This parameter is supported only for FUOTA diff --git a/service/iotwireless/api_op_UpdatePosition.go b/service/iotwireless/api_op_UpdatePosition.go index 3028fa6b060..7971daf00d1 100644 --- a/service/iotwireless/api_op_UpdatePosition.go +++ b/service/iotwireless/api_op_UpdatePosition.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API operation instead. +// Update the position information of a resource. +// +// This action is no longer supported. Calls to update the position information +// should use the [UpdateResourcePosition]API operation instead. // // Deprecated: This operation is no longer supported. +// +// [UpdateResourcePosition]: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html func (c *Client) UpdatePosition(ctx context.Context, params *UpdatePositionInput, optFns ...func(*Options)) (*UpdatePositionOutput, error) { if params == nil { params = &UpdatePositionInput{} diff --git a/service/iotwireless/api_op_UpdateResourcePosition.go b/service/iotwireless/api_op_UpdateResourcePosition.go index ddefad138e2..462ed6f9a75 100644 --- a/service/iotwireless/api_op_UpdateResourcePosition.go +++ b/service/iotwireless/api_op_UpdateResourcePosition.go @@ -12,8 +12,9 @@ import ( ) // 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/) . +// gateway resource. The position coordinates are based on the [World Geodetic System (WGS84)]. +// +// [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{} @@ -46,7 +47,9 @@ 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]. + // + // [GeoJSON]: https://geojson.org/ GeoJsonPayload []byte noSmithyDocumentSerde diff --git a/service/iotwireless/doc.go b/service/iotwireless/doc.go index af46ea2fcfb..a22e87e4402 100644 --- a/service/iotwireless/doc.go +++ b/service/iotwireless/doc.go @@ -7,15 +7,21 @@ // internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN // and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless // devices use the Low Power Wide Area Networking (LPWAN) communication protocol to -// communicate with AWS IoT. Using the API, you can perform create, read, update, -// and delete operations for your wireless devices, gateways, destinations, and -// profiles. After onboarding your devices, you can use the API operations to set -// log levels and monitor your devices with CloudWatch. You can also use the API -// operations to create multicast groups and schedule a multicast session for -// sending a downlink message to devices in the group. By using Firmware Updates -// Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a -// session to update the firmware of individual devices or an entire group of -// devices in a multicast group. To connect to the AWS IoT Wireless Service, use -// the Service endpoints as described in IoT Wireless Service endpoints (https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region) -// in the AWS General Reference. +// communicate with AWS IoT. +// +// Using the API, you can perform create, read, update, and delete operations for +// your wireless devices, gateways, destinations, and profiles. After onboarding +// your devices, you can use the API operations to set log levels and monitor your +// devices with CloudWatch. +// +// You can also use the API operations to create multicast groups and schedule a +// multicast session for sending a downlink message to devices in the group. By +// using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a +// FUOTA task and schedule a session to update the firmware of individual devices +// or an entire group of devices in a multicast group. +// +// To connect to the AWS IoT Wireless Service, use the Service endpoints as +// described in [IoT Wireless Service endpoints]in the AWS General Reference. +// +// [IoT Wireless Service endpoints]: https://docs.aws.amazon.com/general/latest/gr/iot-lorawan.html#iot-wireless_region package iotwireless diff --git a/service/iotwireless/options.go b/service/iotwireless/options.go index e09b0f114a6..fa751d0ded0 100644 --- a/service/iotwireless/options.go +++ b/service/iotwireless/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/iotwireless/types/enums.go b/service/iotwireless/types/enums.go index 983899790dd..daa2f74d3d1 100644 --- a/service/iotwireless/types/enums.go +++ b/service/iotwireless/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AggregationPeriod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationPeriod) Values() []AggregationPeriod { return []AggregationPeriod{ "OneHour", @@ -30,8 +31,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SemtechGeolocation", @@ -48,8 +50,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "Connected", @@ -85,8 +89,9 @@ const ( ) // Values returns all known values for DeviceProfileType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceProfileType) Values() []DeviceProfileType { return []DeviceProfileType{ "Sidewalk", @@ -105,8 +110,9 @@ const ( ) // Values returns all known values for DeviceState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceState) Values() []DeviceState { return []DeviceState{ "Provisioned", @@ -125,8 +131,9 @@ const ( ) // Values returns all known values for DimensionName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionName) Values() []DimensionName { return []DimensionName{ "DeviceId", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for DlClass. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DlClass) Values() []DlClass { return []DlClass{ "ClassB", @@ -162,8 +170,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -184,8 +193,9 @@ const ( ) // 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. +// the future, and so 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{ "discovered", @@ -205,8 +215,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventNotificationPartnerType) Values() []EventNotificationPartnerType { return []EventNotificationPartnerType{ "Sidewalk", @@ -224,8 +235,9 @@ const ( // Values returns all known values for EventNotificationResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventNotificationResourceType) Values() []EventNotificationResourceType { return []EventNotificationResourceType{ "SidewalkAccount", @@ -244,8 +256,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventNotificationTopicStatus) Values() []EventNotificationTopicStatus { return []EventNotificationTopicStatus{ "Enabled", @@ -262,8 +275,9 @@ const ( ) // Values returns all known values for ExpressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpressionType) Values() []ExpressionType { return []ExpressionType{ "RuleName", @@ -289,8 +303,9 @@ const ( ) // Values returns all known values for FuotaDeviceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FuotaDeviceStatus) Values() []FuotaDeviceStatus { return []FuotaDeviceStatus{ "Initial", @@ -319,8 +334,9 @@ const ( ) // Values returns all known values for FuotaTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FuotaTaskStatus) Values() []FuotaTaskStatus { return []FuotaTaskStatus{ "Pending", @@ -343,8 +359,9 @@ const ( ) // Values returns all known values for IdentifierType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentifierType) Values() []IdentifierType { return []IdentifierType{ "PartnerAccountId", @@ -368,8 +385,9 @@ const ( ) // Values returns all known values for ImportTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportTaskStatus) Values() []ImportTaskStatus { return []ImportTaskStatus{ "INITIALIZING", @@ -391,8 +409,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "INFO", @@ -412,8 +431,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "CUSTOM_COMMAND_ID_NOTIFY", @@ -460,8 +480,9 @@ const ( ) // Values returns all known values for MetricName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricName) Values() []MetricName { return []MetricName{ "DeviceRSSI", @@ -506,8 +527,9 @@ const ( ) // Values returns all known values for MetricQueryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricQueryStatus) Values() []MetricQueryStatus { return []MetricQueryStatus{ "Succeeded", @@ -524,8 +546,9 @@ const ( ) // Values returns all known values for MulticastFrameInfo. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MulticastFrameInfo) Values() []MulticastFrameInfo { return []MulticastFrameInfo{ "ENABLED", @@ -544,8 +567,9 @@ const ( ) // Values returns all known values for OnboardStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnboardStatus) Values() []OnboardStatus { return []OnboardStatus{ "INITIALIZED", @@ -563,8 +587,9 @@ const ( ) // Values returns all known values for PartnerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartnerType) Values() []PartnerType { return []PartnerType{ "Sidewalk", @@ -581,6 +606,7 @@ const ( // 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{ @@ -599,6 +625,7 @@ const ( // Values returns all known values for PositionConfigurationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PositionConfigurationStatus) Values() []PositionConfigurationStatus { return []PositionConfigurationStatus{ @@ -616,8 +643,9 @@ const ( ) // Values returns all known values for PositioningConfigStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositioningConfigStatus) Values() []PositioningConfigStatus { return []PositioningConfigStatus{ "Enabled", @@ -634,8 +662,9 @@ const ( ) // Values returns all known values for PositionResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionResourceType) Values() []PositionResourceType { return []PositionResourceType{ "WirelessDevice", @@ -651,8 +680,9 @@ const ( ) // Values returns all known values for PositionSolverProvider. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionSolverProvider) Values() []PositionSolverProvider { return []PositionSolverProvider{ "Semtech", @@ -667,8 +697,9 @@ const ( ) // Values returns all known values for PositionSolverType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionSolverType) Values() []PositionSolverType { return []PositionSolverType{ "GNSS", @@ -684,8 +715,9 @@ const ( ) // Values returns all known values for SigningAlg. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SigningAlg) Values() []SigningAlg { return []SigningAlg{ "Ed25519", @@ -703,8 +735,9 @@ const ( // Values returns all known values for SummaryMetricConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SummaryMetricConfigurationStatus) Values() []SummaryMetricConfigurationStatus { return []SummaryMetricConfigurationStatus{ "Enabled", @@ -732,8 +765,9 @@ const ( ) // Values returns all known values for SupportedRfRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SupportedRfRegion) Values() []SupportedRfRegion { return []SupportedRfRegion{ "EU868", @@ -764,8 +798,9 @@ const ( ) // Values returns all known values for WirelessDeviceEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessDeviceEvent) Values() []WirelessDeviceEvent { return []WirelessDeviceEvent{ "Join", @@ -785,8 +820,9 @@ const ( ) // Values returns all known values for WirelessDeviceFrameInfo. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessDeviceFrameInfo) Values() []WirelessDeviceFrameInfo { return []WirelessDeviceFrameInfo{ "ENABLED", @@ -805,8 +841,9 @@ const ( ) // Values returns all known values for WirelessDeviceIdType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessDeviceIdType) Values() []WirelessDeviceIdType { return []WirelessDeviceIdType{ "WirelessDeviceId", @@ -828,8 +865,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessDeviceSidewalkStatus) Values() []WirelessDeviceSidewalkStatus { return []WirelessDeviceSidewalkStatus{ "PROVISIONED", @@ -848,8 +886,9 @@ const ( ) // Values returns all known values for WirelessDeviceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessDeviceType) Values() []WirelessDeviceType { return []WirelessDeviceType{ "Sidewalk", @@ -866,8 +905,9 @@ const ( ) // Values returns all known values for WirelessGatewayEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessGatewayEvent) Values() []WirelessGatewayEvent { return []WirelessGatewayEvent{ "CUPS_Request", @@ -885,8 +925,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "GatewayEui", @@ -905,6 +946,7 @@ const ( // Values returns all known values for WirelessGatewayServiceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WirelessGatewayServiceType) Values() []WirelessGatewayServiceType { return []WirelessGatewayServiceType{ @@ -922,8 +964,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessGatewayTaskDefinitionType) Values() []WirelessGatewayTaskDefinitionType { return []WirelessGatewayTaskDefinitionType{ "UPDATE", @@ -944,6 +987,7 @@ const ( // Values returns all known values for WirelessGatewayTaskStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WirelessGatewayTaskStatus) Values() []WirelessGatewayTaskStatus { return []WirelessGatewayTaskStatus{ @@ -964,8 +1008,9 @@ const ( ) // Values returns all known values for WirelessGatewayType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WirelessGatewayType) Values() []WirelessGatewayType { return []WirelessGatewayType{ "LoRaWAN", diff --git a/service/iotwireless/types/types.go b/service/iotwireless/types/types.go index 7b929331995..e87bbe69745 100644 --- a/service/iotwireless/types/types.go +++ b/service/iotwireless/types/types.go @@ -333,7 +333,7 @@ type DownlinkQueueMessage struct { // LoRaWAN router info. LoRaWAN *LoRaWANSendDataToDevice - // The message ID assigned by IoT Wireless to each downlink message, which helps + // The message ID assigned by IoT Wireless to each downlink message, which helps // identify the message. MessageId *string @@ -2116,10 +2116,11 @@ 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 . +// 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 . type WirelessDeviceEventLogOption struct { // The event for a log message, if the log message is tied to a wireless device. @@ -2219,8 +2220,9 @@ type WirelessDeviceStatistics struct { // The ID of the wireless device reporting the data. Id *string - // The date and time when the most recent uplink was received. Theis value is only - // valid for 3 months. + // The date and time when the most recent uplink was received. + // + // Theis value is only valid for 3 months. LastUplinkReceivedAt *string // LoRaWAN device info. @@ -2245,8 +2247,10 @@ 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 specific wireless gateway event. +// +// For a LoRaWAN gateway, possible events 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. @@ -2298,8 +2302,9 @@ type WirelessGatewayStatistics struct { // The ID of the wireless gateway reporting the data. Id *string - // The date and time when the most recent uplink was received. This value is only - // valid for 3 months. + // The date and time when the most recent uplink was received. + // + // This value is only valid for 3 months. LastUplinkReceivedAt *string // LoRaWAN gateway info. diff --git a/service/ivs/api_op_BatchStartViewerSessionRevocation.go b/service/ivs/api_op_BatchStartViewerSessionRevocation.go index 67773c6993d..24179d2303c 100644 --- a/service/ivs/api_op_BatchStartViewerSessionRevocation.go +++ b/service/ivs/api_op_BatchStartViewerSessionRevocation.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID -// pairs simultaneously. +// Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously. func (c *Client) BatchStartViewerSessionRevocation(ctx context.Context, params *BatchStartViewerSessionRevocationInput, optFns ...func(*Options)) (*BatchStartViewerSessionRevocationOutput, error) { if params == nil { params = &BatchStartViewerSessionRevocationInput{} diff --git a/service/ivs/api_op_CreateChannel.go b/service/ivs/api_op_CreateChannel.go index d666b35fc1c..9a5bed37aaa 100644 --- a/service/ivs/api_op_CreateChannel.go +++ b/service/ivs/api_op_CreateChannel.go @@ -58,17 +58,19 @@ type CreateChannelInput struct { // enables recording. 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] 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 Tags map[string]string // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable input resolution or bitrate, the stream probably will - // disconnect immediately. Default: STANDARD . For details, see Channel Types (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) - // . + // disconnect immediately. Default: STANDARD . For details, see [Channel Types]. + // + // [Channel Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html Type types.ChannelType noSmithyDocumentSerde diff --git a/service/ivs/api_op_CreatePlaybackRestrictionPolicy.go b/service/ivs/api_op_CreatePlaybackRestrictionPolicy.go index 63c5160fa75..9128f2c9065 100644 --- a/service/ivs/api_op_CreatePlaybackRestrictionPolicy.go +++ b/service/ivs/api_op_CreatePlaybackRestrictionPolicy.go @@ -31,14 +31,16 @@ func (c *Client) CreatePlaybackRestrictionPolicy(ctx context.Context, params *Cr type CreatePlaybackRestrictionPolicyInput struct { // A list of country codes that control geoblocking restriction. Allowed values - // are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - // codes. Default: All countries (an empty array). + // are the officially assigned [ISO 3166-1 alpha-2]codes. Default: All countries (an empty array). + // + // [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 AllowedCountries []string // A list of origin sites that control CORS restriction. Allowed values are the - // same as valid values of the Origin header defined at - // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) - // . Default: All origins (an empty array). + // same as valid values of the Origin header defined at [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]. Default: All origins (an + // empty array). + // + // [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin AllowedOrigins []string // Whether channel playback is constrained by origin site. Default: false . @@ -47,11 +49,12 @@ type CreatePlaybackRestrictionPolicyInput struct { // Playback-restriction-policy name. The value does not need to be unique. Name *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] 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 Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivs/api_op_CreateRecordingConfiguration.go b/service/ivs/api_op_CreateRecordingConfiguration.go index c29cf918b99..66c605c0d1b 100644 --- a/service/ivs/api_op_CreateRecordingConfiguration.go +++ b/service/ivs/api_op_CreateRecordingConfiguration.go @@ -12,15 +12,17 @@ import ( ) // Creates a new recording configuration, used to enable recording to Amazon S3. +// // 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 -// 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 -// recording configuration and create a new one with an S3 bucket from the correct -// region. +// 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 recording configuration and create a new one with an +// S3 bucket from the correct region. func (c *Client) CreateRecordingConfiguration(ctx context.Context, params *CreateRecordingConfigurationInput, optFns ...func(*Options)) (*CreateRecordingConfigurationOutput, error) { if params == nil { params = &CreateRecordingConfigurationInput{} @@ -55,11 +57,12 @@ type CreateRecordingConfigurationInput struct { // Object that describes which renditions should be recorded for a stream. RenditionConfiguration *types.RenditionConfiguration - // 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] 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 Tags map[string]string // A complex type that allows you to enable/disable the recording of thumbnails diff --git a/service/ivs/api_op_CreateStreamKey.go b/service/ivs/api_op_CreateStreamKey.go index e3d206042de..817da7f6a05 100644 --- a/service/ivs/api_op_CreateStreamKey.go +++ b/service/ivs/api_op_CreateStreamKey.go @@ -12,10 +12,11 @@ import ( ) // Creates a stream key, used to initiate a stream, for the specified channel ARN. -// Note that CreateChannel creates a stream key. If you subsequently use -// CreateStreamKey on the same channel, it will fail because a stream key already -// exists and there is a limit of 1 stream key per channel. To reset the stream key -// on a channel, use DeleteStreamKey and then CreateStreamKey. +// +// Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the +// same channel, it will fail because a stream key already exists and there is a +// limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey +// and then CreateStreamKey. func (c *Client) CreateStreamKey(ctx context.Context, params *CreateStreamKeyInput, optFns ...func(*Options)) (*CreateStreamKeyOutput, error) { if params == nil { params = &CreateStreamKeyInput{} @@ -38,11 +39,12 @@ 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] 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 Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivs/api_op_DeleteChannel.go b/service/ivs/api_op_DeleteChannel.go index 457072bb8e5..b42aae3b1f0 100644 --- a/service/ivs/api_op_DeleteChannel.go +++ b/service/ivs/api_op_DeleteChannel.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// .) +// 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].) +// +// [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 8888dd3c300..20eace46bcd 100644 --- a/service/ivs/api_op_DeletePlaybackKeyPair.go +++ b/service/ivs/api_op_DeletePlaybackKeyPair.go @@ -11,9 +11,10 @@ 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) +// tokens generated using the key pair’s privateKey . For more information, see [Setting Up Private Channels] // in the Amazon IVS User Guide. +// +// [Setting Up Private Channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html 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_DeleteRecordingConfiguration.go b/service/ivs/api_op_DeleteRecordingConfiguration.go index ef02d230d28..1e766a1b72e 100644 --- a/service/ivs/api_op_DeleteRecordingConfiguration.go +++ b/service/ivs/api_op_DeleteRecordingConfiguration.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the recording configuration for the specified ARN. If you try to delete -// a recording configuration that is associated with a channel, you will get an -// error (409 ConflictException). To avoid this, for all channels that reference -// the recording configuration, first use UpdateChannel to set the +// Deletes the recording configuration for the specified ARN. +// +// If you try to delete a recording configuration that is associated with a +// channel, you will get an error (409 ConflictException). To avoid this, for all +// channels that reference the recording configuration, first use UpdateChannelto set the // recordingConfigurationArn field to an empty string, then use // DeleteRecordingConfiguration. func (c *Client) DeleteRecordingConfiguration(ctx context.Context, params *DeleteRecordingConfigurationInput, optFns ...func(*Options)) (*DeleteRecordingConfigurationOutput, error) { diff --git a/service/ivs/api_op_GetChannel.go b/service/ivs/api_op_GetChannel.go index 2788ee97053..1efdd47e702 100644 --- a/service/ivs/api_op_GetChannel.go +++ b/service/ivs/api_op_GetChannel.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the channel configuration for the specified channel ARN. See also -// BatchGetChannel . +// Gets the channel configuration for the specified channel ARN. See also 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 ad164d9ee49..4a7847c7526 100644 --- a/service/ivs/api_op_GetPlaybackKeyPair.go +++ b/service/ivs/api_op_GetPlaybackKeyPair.go @@ -14,8 +14,9 @@ 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 // 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]in the Amazon IVS User Guide. +// +// [Setting Up Private Channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html 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_ImportPlaybackKeyPair.go b/service/ivs/api_op_ImportPlaybackKeyPair.go index 36f76bf3160..afbc1322d0c 100644 --- a/service/ivs/api_op_ImportPlaybackKeyPair.go +++ b/service/ivs/api_op_ImportPlaybackKeyPair.go @@ -13,9 +13,10 @@ import ( // 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. +// grant viewers access to private channels. For more information, see [Setting Up Private Channels]in the +// Amazon IVS User Guide. +// +// [Setting Up Private Channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html func (c *Client) ImportPlaybackKeyPair(ctx context.Context, params *ImportPlaybackKeyPairInput, optFns ...func(*Options)) (*ImportPlaybackKeyPairOutput, error) { if params == nil { params = &ImportPlaybackKeyPairInput{} @@ -41,11 +42,12 @@ type ImportPlaybackKeyPairInput struct { // Playback-key-pair name. The value does not need to be unique. 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) + // Any tags provided with the request are added to the playback key pair tags. See [Tagging Amazon Web Services Resources] // 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 Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivs/api_op_ListPlaybackKeyPairs.go b/service/ivs/api_op_ListPlaybackKeyPairs.go index c424406d64c..e4d9fe674de 100644 --- a/service/ivs/api_op_ListPlaybackKeyPairs.go +++ b/service/ivs/api_op_ListPlaybackKeyPairs.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Gets summary information about playback key pairs. For more information, see [Setting Up Private Channels] // in the Amazon IVS User Guide. +// +// [Setting Up Private Channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html func (c *Client) ListPlaybackKeyPairs(ctx context.Context, params *ListPlaybackKeyPairsInput, optFns ...func(*Options)) (*ListPlaybackKeyPairsOutput, error) { if params == nil { params = &ListPlaybackKeyPairsInput{} diff --git a/service/ivs/api_op_PutMetadata.go b/service/ivs/api_op_PutMetadata.go index 326249c6bdf..be82c8aaa88 100644 --- a/service/ivs/api_op_PutMetadata.go +++ b/service/ivs/api_op_PutMetadata.go @@ -14,8 +14,9 @@ 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]in the Amazon IVS User Guide. +// +// [Embedding Metadata within a Video Stream]: https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html 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_StartViewerSessionRevocation.go b/service/ivs/api_op_StartViewerSessionRevocation.go index bc64d0a5f4e..0afcc675bb1 100644 --- a/service/ivs/api_op_StartViewerSessionRevocation.go +++ b/service/ivs/api_op_StartViewerSessionRevocation.go @@ -13,8 +13,9 @@ import ( // Starts the process of revoking the viewer session associated with a specified // channel ARN and viewer ID. Optionally, you can provide a version to revoke // viewer sessions less than and including that version. For instructions on -// associating a viewer ID with a viewer session, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) -// . +// associating a viewer ID with a viewer session, see [Setting Up Private Channels]. +// +// [Setting Up Private Channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html func (c *Client) StartViewerSessionRevocation(ctx context.Context, params *StartViewerSessionRevocationInput, optFns ...func(*Options)) (*StartViewerSessionRevocationOutput, error) { if params == nil { params = &StartViewerSessionRevocationInput{} diff --git a/service/ivs/api_op_StopStream.go b/service/ivs/api_op_StopStream.go index f896da82638..5d9c4732905 100644 --- a/service/ivs/api_op_StopStream.go +++ b/service/ivs/api_op_StopStream.go @@ -11,10 +11,11 @@ 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 -// session, so to stop the stream permanently, you may want to first revoke the -// streamKey attached to the channel. +// conjunction with DeleteStreamKeyto 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) { if params == nil { params = &StopStreamInput{} diff --git a/service/ivs/api_op_TagResource.go b/service/ivs/api_op_TagResource.go index 4f6f4885dc6..46370915e91 100644 --- a/service/ivs/api_op_TagResource.go +++ b/service/ivs/api_op_TagResource.go @@ -36,10 +36,11 @@ 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] 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 // // 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 522df607a48..0c06950aee5 100644 --- a/service/ivs/api_op_UntagResource.go +++ b/service/ivs/api_op_UntagResource.go @@ -35,10 +35,11 @@ type UntagResourceInput struct { 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. + // (key:value) . See [Tagging Amazon Web Services Resources] 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 // // This member is required. TagKeys []string diff --git a/service/ivs/api_op_UpdateChannel.go b/service/ivs/api_op_UpdateChannel.go index 240f006c364..ce4785aa137 100644 --- a/service/ivs/api_op_UpdateChannel.go +++ b/service/ivs/api_op_UpdateChannel.go @@ -66,8 +66,9 @@ type UpdateChannelInput struct { // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable input resolution or bitrate, the stream probably will - // disconnect immediately. Default: STANDARD . For details, see Channel Types (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) - // . + // disconnect immediately. Default: STANDARD . For details, see [Channel Types]. + // + // [Channel Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html Type types.ChannelType noSmithyDocumentSerde diff --git a/service/ivs/api_op_UpdatePlaybackRestrictionPolicy.go b/service/ivs/api_op_UpdatePlaybackRestrictionPolicy.go index cd8a09972f2..db00f2f5086 100644 --- a/service/ivs/api_op_UpdatePlaybackRestrictionPolicy.go +++ b/service/ivs/api_op_UpdatePlaybackRestrictionPolicy.go @@ -35,14 +35,16 @@ type UpdatePlaybackRestrictionPolicyInput struct { Arn *string // A list of country codes that control geoblocking restriction. Allowed values - // are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - // codes. Default: All countries (an empty array). + // are the officially assigned [ISO 3166-1 alpha-2]codes. Default: All countries (an empty array). + // + // [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 AllowedCountries []string // A list of origin sites that control CORS restriction. Allowed values are the - // same as valid values of the Origin header defined at - // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) - // . Default: All origins (an empty array). + // same as valid values of the Origin header defined at [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]. Default: All origins (an + // empty array). + // + // [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin AllowedOrigins []string // Whether channel playback is constrained by origin site. Default: false . diff --git a/service/ivs/doc.go b/service/ivs/doc.go index 2de0b4d87cf..f45c76efbf0 100644 --- a/service/ivs/doc.go +++ b/service/ivs/doc.go @@ -3,168 +3,265 @@ // Package ivs provides the API client, operations, and parameter types for Amazon // Interactive Video Service. // -// Introduction The Amazon Interactive Video Service (IVS) API is REST compatible, -// 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. +// Introduction +// +// The Amazon Interactive Video Service (IVS) API is REST compatible, 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 +// regions and Amazon IVS HTTPS service endpoints, see the [Amazon IVS page]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]. +// +// Allowed Header Values +// // - Accept: application/json +// // - Accept-Encoding: gzip, deflate +// // - Content-Type: application/json // // Key Concepts +// // - 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. +// // - Stream key — An identifier assigned by Amazon IVS when you create a // channel, which is then used to authorize streaming. 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. +// // - 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. +// // - Playback restriction policy — Restricts playback by countries and/or origin // sites. // -// For more information about your IVS live stream, also see Getting Started with -// IVS Low-Latency Streaming (https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html) -// . 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: +// For more information about your IVS live stream, also see [Getting Started with IVS Low-Latency Streaming]. +// +// # 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] 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]). +// +// 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. -// -// Playback Restriction Policy Endpoints -// - CreatePlaybackRestrictionPolicy — Creates a new playback restriction policy, -// for constraining playback by countries and/or origins. -// - DeletePlaybackRestrictionPolicy — Deletes the specified playback restriction -// policy -// - GetPlaybackRestrictionPolicy — Gets the specified playback restriction -// policy. -// - ListPlaybackRestrictionPolicies — Gets summary information about playback -// restriction policies. -// - UpdatePlaybackRestrictionPolicy — Updates a specified playback restriction -// policy. -// -// Private Channel 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 . -// - StartViewerSessionRevocation — Starts the process of revoking the viewer -// session associated with a specified channel ARN and viewer ID. Optionally, you -// can provide a version to revoke viewer sessions less than and including that -// version. -// - BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on -// multiple channel ARN and viewer ID pairs simultaneously. -// -// Recording Configuration 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 +// view [Amazon IVS private channels]. (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)]in the Amazon Web Services +// General Reference. +// +// - Managing Amazon IVS permissions — See [Identity and Access Management]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]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 GetChannelon 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. +// +// # Playback Restriction Policy Endpoints +// +// CreatePlaybackRestrictionPolicy +// - — Creates a new playback restriction policy, for constraining playback by +// countries and/or origins. +// +// DeletePlaybackRestrictionPolicy +// - — Deletes the specified playback restriction policy +// +// GetPlaybackRestrictionPolicy +// - — Gets the specified playback restriction policy. +// +// ListPlaybackRestrictionPolicies +// - — Gets summary information about playback restriction policies. +// +// UpdatePlaybackRestrictionPolicy +// - — Updates a specified playback restriction policy. +// +// # Private Channel Endpoints +// +// For more information, see [Setting Up Private Channels] 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 . +// +// StartViewerSessionRevocation +// - — Starts the process of revoking the viewer session associated with a +// specified channel ARN and viewer ID. Optionally, you can provide a version to +// revoke viewer sessions less than and including that version. +// +// BatchStartViewerSessionRevocation +// - — Performs StartViewerSessionRevocationon multiple channel ARN and viewer ID pairs simultaneously. +// +// # Recording Configuration 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. +// +// # 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 DeleteStreamKeyto 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. +// +// # Stream Key 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 GetStreamKeyon 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. +// +// # Amazon Web Services Tags Endpoints +// +// TagResource +// - — Adds or updates tags for the Amazon Web Services resource with the // specified ARN. // -// 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. -// -// Stream Key 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. -// -// 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. +// UntagResource +// - — Removes tags from the resource with the specified ARN. +// +// ListTagsForResource +// - — Gets information about Amazon Web Services tags for the specified ARN. +// +// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Amazon Resource Names]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html +// [Setting Up Private Channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html +// [Amazon IVS page]: https://docs.aws.amazon.com/general/latest/gr/ivs.html +// [Identity and Access Management]: https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html +// [Document History]: https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html +// [Amazon IVS private channels]: https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html +// [Getting Started with IVS Low-Latency Streaming]: https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html +// [Access Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html package ivs diff --git a/service/ivs/options.go b/service/ivs/options.go index 42de105a27b..6af14c8d70b 100644 --- a/service/ivs/options.go +++ b/service/ivs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ivs/types/enums.go b/service/ivs/types/enums.go index 4fbc6249ef5..c8964a478e4 100644 --- a/service/ivs/types/enums.go +++ b/service/ivs/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ChannelLatencyMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelLatencyMode) Values() []ChannelLatencyMode { return []ChannelLatencyMode{ "NORMAL", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ChannelType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelType) Values() []ChannelType { return []ChannelType{ "BASIC", @@ -53,6 +55,7 @@ const ( // Values returns all known values for RecordingConfigurationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RecordingConfigurationState) Values() []RecordingConfigurationState { return []RecordingConfigurationState{ @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for RecordingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordingMode) Values() []RecordingMode { return []RecordingMode{ "DISABLED", @@ -92,8 +96,9 @@ const ( // Values returns all known values for RenditionConfigurationRendition. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenditionConfigurationRendition) Values() []RenditionConfigurationRendition { return []RenditionConfigurationRendition{ "FULL_HD", @@ -114,8 +119,9 @@ const ( // Values returns all known values for RenditionConfigurationRenditionSelection. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenditionConfigurationRenditionSelection) Values() []RenditionConfigurationRenditionSelection { return []RenditionConfigurationRenditionSelection{ "ALL", @@ -134,8 +140,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -153,8 +160,9 @@ const ( ) // Values returns all known values for StreamState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamState) Values() []StreamState { return []StreamState{ "LIVE", @@ -174,8 +182,9 @@ const ( // Values returns all known values for ThumbnailConfigurationResolution. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThumbnailConfigurationResolution) Values() []ThumbnailConfigurationResolution { return []ThumbnailConfigurationResolution{ "FULL_HD", @@ -195,8 +204,9 @@ const ( // Values returns all known values for ThumbnailConfigurationStorage. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThumbnailConfigurationStorage) Values() []ThumbnailConfigurationStorage { return []ThumbnailConfigurationStorage{ "SEQUENTIAL", @@ -213,8 +223,9 @@ const ( ) // Values returns all known values for TranscodePreset. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscodePreset) Values() []TranscodePreset { return []TranscodePreset{ "HIGHER_BANDWIDTH_DELIVERY", diff --git a/service/ivs/types/types.go b/service/ivs/types/types.go index 31bbe104e47..1ea9e57345e 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 IngestConfigurationobject and used for monitoring +// stream health. type AudioConfiguration struct { // Number of audio channels. @@ -66,7 +66,7 @@ type BatchStartViewerSessionRevocationError struct { noSmithyDocumentSerde } -// A viewer session to revoke in the call to BatchStartViewerSessionRevocation . +// A viewer session to revoke in the call to BatchStartViewerSessionRevocation. type BatchStartViewerSessionRevocationViewerSession struct { // The ARN of the channel associated with the viewer session to revoke. @@ -135,16 +135,18 @@ type Channel struct { Srt *Srt // 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] 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 Tags map[string]string // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable input resolution or bitrate, the stream probably will - // disconnect immediately. Default: STANDARD . For details, see Channel Types (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) - // . + // disconnect immediately. Default: STANDARD . For details, see [Channel Types]. + // + // [Channel Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html Type ChannelType noSmithyDocumentSerde @@ -186,16 +188,18 @@ 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] 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 Tags map[string]string // Channel type, which determines the allowable resolution and bitrate. If you // exceed the allowable input resolution or bitrate, the stream probably will - // disconnect immediately. Default: STANDARD . For details, see Channel Types (https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html) - // . + // disconnect immediately. Default: STANDARD . For details, see [Channel Types]. + // + // [Channel Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html Type ChannelType noSmithyDocumentSerde @@ -238,10 +242,11 @@ 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] 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 Tags map[string]string noSmithyDocumentSerde @@ -257,10 +262,11 @@ 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] 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 Tags map[string]string noSmithyDocumentSerde @@ -271,16 +277,18 @@ type PlaybackKeyPairSummary struct { type PlaybackRestrictionPolicy struct { // A list of country codes that control geoblocking restriction. Allowed values - // are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - // codes. Default: All countries (an empty array). + // are the officially assigned [ISO 3166-1 alpha-2]codes. Default: All countries (an empty array). + // + // [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 // // This member is required. AllowedCountries []string // A list of origin sites that control CORS restriction. Allowed values are the - // same as valid values of the Origin header defined at - // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) - // . Default: All origins (an empty array). + // same as valid values of the Origin header defined at [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]. Default: All origins (an + // empty array). + // + // [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin // // This member is required. AllowedOrigins []string @@ -297,10 +305,11 @@ type PlaybackRestrictionPolicy 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] 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 Tags map[string]string noSmithyDocumentSerde @@ -310,16 +319,18 @@ type PlaybackRestrictionPolicy struct { type PlaybackRestrictionPolicySummary struct { // A list of country codes that control geoblocking restriction. Allowed values - // are the officially assigned ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - // codes. Default: All countries (an empty array). + // are the officially assigned [ISO 3166-1 alpha-2]codes. Default: All countries (an empty array). + // + // [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 // // This member is required. AllowedCountries []string // A list of origin sites that control CORS restriction. Allowed values are the - // same as valid values of the Origin header defined at - // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin) - // . Default: All origins (an empty array). + // same as valid values of the Origin header defined at [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]. Default: All origins (an + // empty array). + // + // [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin // // This member is required. AllowedOrigins []string @@ -336,10 +347,11 @@ type PlaybackRestrictionPolicySummary 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] 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 Tags map[string]string noSmithyDocumentSerde @@ -377,10 +389,11 @@ type RecordingConfiguration struct { RenditionConfiguration *RenditionConfiguration // 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] 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 Tags map[string]string // A complex type that allows you to enable/disable the recording of thumbnails @@ -415,10 +428,11 @@ 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] 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 Tags map[string]string noSmithyDocumentSerde @@ -436,8 +450,9 @@ type RenditionConfiguration struct { // CUSTOM ; otherwise, this field is irrelevant. The selected renditions are // recorded if they are available during the stream. If a selected rendition is // unavailable, the best available rendition is recorded. For details on the - // resolution dimensions of each rendition, see Auto-Record to Amazon S3 (https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) - // . + // resolution dimensions of each rendition, see [Auto-Record to Amazon S3]. + // + // [Auto-Record to Amazon S3]: https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html Renditions []RenditionConfigurationRendition noSmithyDocumentSerde @@ -501,9 +516,9 @@ type Stream struct { 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) -// . +// Object specifying a stream’s events. For a list of events, see [Using Amazon EventBridge with Amazon IVS]. +// +// [Using Amazon 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 @@ -538,10 +553,11 @@ 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] 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 Tags map[string]string // Stream-key value. @@ -560,10 +576,11 @@ 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] 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 Tags map[string]string noSmithyDocumentSerde @@ -595,9 +612,9 @@ type StreamSession struct { StreamId *string // 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) - // . + // most recent events and contains up to 500 events. For Amazon IVS events, see [Using Amazon EventBridge with Amazon IVS]. + // + // [Using Amazon EventBridge with Amazon IVS]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html TruncatedEvents []StreamEvent noSmithyDocumentSerde @@ -663,8 +680,9 @@ type ThumbnailConfiguration struct { // recorded at the selected resolution if the corresponding rendition is available // during the stream; otherwise, they are recorded at source resolution. For more // information about resolution values and their corresponding height and width - // dimensions, see Auto-Record to Amazon S3 (https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html) - // . Default: Null (source resolution is returned). + // dimensions, see [Auto-Record to Amazon S3]. Default: Null (source resolution is returned). + // + // [Auto-Record to Amazon S3]: https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html Resolution ThumbnailConfigurationResolution // Indicates the format in which thumbnails are recorded. SEQUENTIAL records all @@ -675,22 +693,24 @@ type ThumbnailConfiguration struct { Storage []ThumbnailConfigurationStorage // The targeted thumbnail-generation interval in seconds. This is configurable - // (and required) only if recordingMode is INTERVAL . Default: 60. Important: For - // the BASIC channel type, setting a value for targetIntervalSeconds does not - // guarantee that thumbnails are generated at the specified interval. For + // (and required) only if recordingMode is INTERVAL . Default: 60. + // + // Important: For the BASIC channel type, 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. + // targetIntervalSeconds value. See [Amazon IVS Streaming Configuration] for information on setting IDR/Keyframe to + // the recommended value in video-encoder settings. + // + // [Amazon IVS Streaming Configuration]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html 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 IngestConfigurationobject 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_op_CreateChatToken.go b/service/ivschat/api_op_CreateChatToken.go index f6ae5eacb3f..e67b8adccd5 100644 --- a/service/ivschat/api_op_CreateChatToken.go +++ b/service/ivschat/api_op_CreateChatToken.go @@ -16,13 +16,19 @@ import ( // 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. Use the capabilities field to permit an end user to -// send messages or moderate a room. The attributes field securely attaches -// structured data to the chat session; the data is included within each message -// sent by the end user and received by other participants in the room. Common use -// cases for attributes include passing end-user profile data like an icon, display -// name, colors, badges, and other display features. Encryption keys are owned by -// Amazon IVS Chat and never used directly by your application. +// included in the response. +// +// Use the capabilities field to permit an end user to send messages or moderate a +// room. +// +// The attributes field securely attaches structured data to the chat session; the +// data is included within each message sent by the end user and received by other +// participants in the room. Common use cases for attributes include passing +// end-user profile data like an icon, display name, colors, badges, and other +// display features. +// +// Encryption keys are owned by Amazon IVS Chat and never used directly by your +// application. func (c *Client) CreateChatToken(ctx context.Context, params *CreateChatTokenInput, optFns ...func(*Options)) (*CreateChatTokenOutput, error) { if params == nil { params = &CreateChatTokenInput{} diff --git a/service/ivschat/api_op_CreateLoggingConfiguration.go b/service/ivschat/api_op_CreateLoggingConfiguration.go index b268597f9e5..ac1ebd7d55e 100644 --- a/service/ivschat/api_op_CreateLoggingConfiguration.go +++ b/service/ivschat/api_op_CreateLoggingConfiguration.go @@ -42,10 +42,11 @@ 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 - // documented there. + // (key:value) . See [Tagging AWS Resources] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivschat/api_op_CreateRoom.go b/service/ivschat/api_op_CreateRoom.go index 3c614cf4d08..8d2cd61daeb 100644 --- a/service/ivschat/api_op_CreateRoom.go +++ b/service/ivschat/api_op_CreateRoom.go @@ -49,10 +49,11 @@ 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 - // there. + // (key:value) . See [Tagging AWS Resources] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivschat/api_op_DeleteMessage.go b/service/ivschat/api_op_DeleteMessage.go index 5d1a1be52f7..126425a23f6 100644 --- a/service/ivschat/api_op_DeleteMessage.go +++ b/service/ivschat/api_op_DeleteMessage.go @@ -12,9 +12,10 @@ 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] // WebSocket operation in the Amazon IVS Chat Messaging API. +// +// [DeleteMessage]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, optFns ...func(*Options)) (*DeleteMessageOutput, error) { if params == nil { params = &DeleteMessageInput{} @@ -33,8 +34,9 @@ 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) - // in the Chat Messaging API). + // (see [Message (Subscribe)]in the Chat Messaging API). + // + // [Message (Subscribe)]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html // // This member is required. Id *string diff --git a/service/ivschat/api_op_DisconnectUser.go b/service/ivschat/api_op_DisconnectUser.go index 04db2171567..eec394b75ac 100644 --- a/service/ivschat/api_op_DisconnectUser.go +++ b/service/ivschat/api_op_DisconnectUser.go @@ -11,8 +11,9 @@ 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) -// WebSocket operation in the Amazon IVS Chat Messaging API. +// replicates the [DisconnectUser]WebSocket operation in the Amazon IVS Chat Messaging API. +// +// [DisconnectUser]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html func (c *Client) DisconnectUser(ctx context.Context, params *DisconnectUserInput, optFns ...func(*Options)) (*DisconnectUserOutput, error) { if params == nil { params = &DisconnectUserInput{} diff --git a/service/ivschat/api_op_TagResource.go b/service/ivschat/api_op_TagResource.go index 687a6b9e6f0..78d0865e99e 100644 --- a/service/ivschat/api_op_TagResource.go +++ b/service/ivschat/api_op_TagResource.go @@ -34,10 +34,11 @@ 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 - // there. + // string:string (key:value) . See [Tagging AWS Resources] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html // // This member is required. Tags map[string]string diff --git a/service/ivschat/api_op_UntagResource.go b/service/ivschat/api_op_UntagResource.go index de50d1625b0..581a703dd6c 100644 --- a/service/ivschat/api_op_UntagResource.go +++ b/service/ivschat/api_op_UntagResource.go @@ -34,10 +34,11 @@ 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 - // there. + // (key:value) . See [Tagging AWS Resources] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html // // This member is required. TagKeys []string diff --git a/service/ivschat/doc.go b/service/ivschat/doc.go index 0e41d5502ee..7fbfb34ace3 100644 --- a/service/ivschat/doc.go +++ b/service/ivschat/doc.go @@ -3,111 +3,178 @@ // Package ivschat provides the API client, operations, and parameter types for // 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 -// 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: +// 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], 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]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. // // Key Concepts +// // - LoggingConfiguration — A configuration that allows customers to store and // record sent messages in a chat room. +// // - Room — The central Amazon IVS Chat resource through which clients connect // to and exchange chat messages. // -// 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 +// # 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] 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]). +// +// 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 -// underlying API calls for you. However, if your application calls the Amazon IVS -// Chat HTTP API directly, it’s your responsibility to sign the requests. You -// generate a signature using valid AWS credentials for an IAM role that has +// using the CreateChatTokenendpoint 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 underlying API calls for you. However, if your application +// calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign +// the requests. +// +// You generate a signature using valid AWS credentials for an IAM role that has // 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. +// +// - Authentication and generating signatures — See [Authenticating Requests (Amazon Web Services Signature Version 4)]in the Amazon Web Services +// General Reference. +// +// - Managing Amazon IVS permissions — See [Identity and Access Management]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]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]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]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) -// . +// managing Chat resources; see the [Amazon IVS Chat Messaging API Reference]. +// +// [DisconnectUser]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html +// [Amazon Resource Names]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html +// [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Amazon IVS page]: https://docs.aws.amazon.com/general/latest/gr/ivs.html +// [Identity and Access Management]: https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html +// [Amazon IVS Chat Messaging API]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html +// [DeleteMessage]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html +// [Access Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html +// [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/options.go b/service/ivschat/options.go index 5ac40291045..6f082f2ecb3 100644 --- a/service/ivschat/options.go +++ b/service/ivschat/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ivschat/types/enums.go b/service/ivschat/types/enums.go index e370fc92355..a1d221fdab9 100644 --- a/service/ivschat/types/enums.go +++ b/service/ivschat/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ChatTokenCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChatTokenCapability) Values() []ChatTokenCapability { return []ChatTokenCapability{ "SEND_MESSAGE", @@ -31,8 +32,9 @@ const ( // Values returns all known values for CreateLoggingConfigurationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreateLoggingConfigurationState) Values() []CreateLoggingConfigurationState { return []CreateLoggingConfigurationState{ "ACTIVE", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for FallbackResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FallbackResult) Values() []FallbackResult { return []FallbackResult{ "ALLOW", @@ -72,6 +75,7 @@ const ( // Values returns all known values for LoggingConfigurationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LoggingConfigurationState) Values() []LoggingConfigurationState { return []LoggingConfigurationState{ @@ -93,8 +97,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -110,8 +115,9 @@ const ( // Values returns all known values for UpdateLoggingConfigurationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateLoggingConfigurationState) Values() []UpdateLoggingConfigurationState { return []UpdateLoggingConfigurationState{ "ACTIVE", @@ -129,6 +135,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/ivschat/types/types.go b/service/ivschat/types/types.go index b0d586be5fe..350b1051d49 100644 --- a/service/ivschat/types/types.go +++ b/service/ivschat/types/types.go @@ -100,10 +100,11 @@ type LoggingConfigurationSummary struct { 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 - // documented there. + // (key:value) . See [Tagging AWS Resources] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string // Time of the logging configuration’s last update. This is an ISO 8601 timestamp; @@ -118,10 +119,11 @@ 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].) 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 . + // + // [Service Quotas]: https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html FallbackResult FallbackResult // Identifier of the message review handler. Currently this must be an ARN of a @@ -155,10 +157,11 @@ 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 - // there. + // (key:value) . See [Tagging AWS Resources] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string // Time of the room’s last update. This is an ISO 8601 timestamp; note that this diff --git a/service/ivsrealtime/api_op_CreateEncoderConfiguration.go b/service/ivsrealtime/api_op_CreateEncoderConfiguration.go index 535c59ac14b..5fb23b0c99d 100644 --- a/service/ivsrealtime/api_op_CreateEncoderConfiguration.go +++ b/service/ivsrealtime/api_op_CreateEncoderConfiguration.go @@ -33,10 +33,11 @@ type CreateEncoderConfigurationInput 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string // Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 diff --git a/service/ivsrealtime/api_op_CreateParticipantToken.go b/service/ivsrealtime/api_op_CreateParticipantToken.go index cc0967bb309..36400fa46d4 100644 --- a/service/ivsrealtime/api_op_CreateParticipantToken.go +++ b/service/ivsrealtime/api_op_CreateParticipantToken.go @@ -13,8 +13,10 @@ import ( // Creates an additional token for a specified stage. This can be done after stage // creation or when tokens expire. Tokens always are scoped to the stage for which -// they are created. Encryption keys are owned by Amazon IVS and never used -// directly by your application. +// they are created. +// +// Encryption keys are owned by Amazon IVS and never used directly by your +// application. func (c *Client) CreateParticipantToken(ctx context.Context, params *CreateParticipantTokenInput, optFns ...func(*Options)) (*CreateParticipantTokenOutput, error) { if params == nil { params = &CreateParticipantTokenInput{} diff --git a/service/ivsrealtime/api_op_CreateStage.go b/service/ivsrealtime/api_op_CreateStage.go index ca8c44aef1c..ae38175b3c5 100644 --- a/service/ivsrealtime/api_op_CreateStage.go +++ b/service/ivsrealtime/api_op_CreateStage.go @@ -36,10 +36,11 @@ 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivsrealtime/api_op_CreateStorageConfiguration.go b/service/ivsrealtime/api_op_CreateStorageConfiguration.go index 84f3134ef49..2591eb290ce 100644 --- a/service/ivsrealtime/api_op_CreateStorageConfiguration.go +++ b/service/ivsrealtime/api_op_CreateStorageConfiguration.go @@ -42,10 +42,11 @@ type CreateStorageConfigurationInput 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivsrealtime/api_op_DeleteStorageConfiguration.go b/service/ivsrealtime/api_op_DeleteStorageConfiguration.go index 0107ce9c0bb..3a6bec819f2 100644 --- a/service/ivsrealtime/api_op_DeleteStorageConfiguration.go +++ b/service/ivsrealtime/api_op_DeleteStorageConfiguration.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the storage configuration for the specified ARN. If you try to delete a -// storage configuration that is used by a Composition, you will get an error (409 -// ConflictException). To avoid this, for all Compositions that reference the -// storage configuration, first use StopComposition and wait for it to complete, -// then use DeleteStorageConfiguration. +// Deletes the storage configuration for the specified ARN. +// +// If you try to delete a storage configuration that is used by a Composition, you +// will get an error (409 ConflictException). To avoid this, for all Compositions +// that reference the storage configuration, first use StopCompositionand wait for it to +// complete, then use DeleteStorageConfiguration. func (c *Client) DeleteStorageConfiguration(ctx context.Context, params *DeleteStorageConfigurationInput, optFns ...func(*Options)) (*DeleteStorageConfigurationOutput, error) { if params == nil { params = &DeleteStorageConfigurationInput{} diff --git a/service/ivsrealtime/api_op_DisconnectParticipant.go b/service/ivsrealtime/api_op_DisconnectParticipant.go index aa2ccf8210c..576ba015d3e 100644 --- a/service/ivsrealtime/api_op_DisconnectParticipant.go +++ b/service/ivsrealtime/api_op_DisconnectParticipant.go @@ -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 assigned by IVS and - // returned by CreateParticipantToken . + // returned by CreateParticipantToken. // // This member is required. ParticipantId *string diff --git a/service/ivsrealtime/api_op_GetParticipant.go b/service/ivsrealtime/api_op_GetParticipant.go index 97a39052a86..19a3bc093af 100644 --- a/service/ivsrealtime/api_op_GetParticipant.go +++ b/service/ivsrealtime/api_op_GetParticipant.go @@ -29,8 +29,7 @@ func (c *Client) GetParticipant(ctx context.Context, params *GetParticipantInput type GetParticipantInput struct { - // Unique identifier for the participant. This is assigned by IVS and returned by - // CreateParticipantToken . + // Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken. // // This member is required. ParticipantId *string diff --git a/service/ivsrealtime/api_op_ListParticipantEvents.go b/service/ivsrealtime/api_op_ListParticipantEvents.go index 7cbc9f85879..1fbd136d531 100644 --- a/service/ivsrealtime/api_op_ListParticipantEvents.go +++ b/service/ivsrealtime/api_op_ListParticipantEvents.go @@ -30,8 +30,8 @@ func (c *Client) ListParticipantEvents(ctx context.Context, params *ListParticip type ListParticipantEventsInput struct { - // Unique identifier for this participant. This is assigned by IVS and returned by - // CreateParticipantToken . + // Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken + // . // // This member is required. ParticipantId *string diff --git a/service/ivsrealtime/api_op_StartComposition.go b/service/ivsrealtime/api_op_StartComposition.go index c69aba47b7e..20542cfc806 100644 --- a/service/ivsrealtime/api_op_StartComposition.go +++ b/service/ivsrealtime/api_op_StartComposition.go @@ -12,14 +12,21 @@ import ( ) // Starts a Composition from a stage based on the configuration provided in the -// request. A Composition is an ephemeral resource that exists after this endpoint -// returns successfully. Composition stops and the resource is deleted: -// - When StopComposition is called. +// request. +// +// A Composition is an ephemeral resource that exists after this endpoint returns +// successfully. Composition stops and the resource is deleted: +// +// - When StopCompositionis called. +// // - After a 1-minute timeout, when all participants are disconnected from the // stage. +// // - After a 1-minute timeout, if there are no participants in the stage when // StartComposition is called. +// // - When broadcasting to the IVS channel fails and all retries are exhausted. +// // - When broadcasting is disconnected and all attempts to reconnect are // exhausted. func (c *Client) StartComposition(ctx context.Context, params *StartCompositionInput, optFns ...func(*Options)) (*StartCompositionOutput, error) { @@ -56,10 +63,11 @@ type StartCompositionInput struct { Layout *types.LayoutConfiguration // 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/ivsrealtime/api_op_TagResource.go b/service/ivsrealtime/api_op_TagResource.go index a401a645aed..70b06984420 100644 --- a/service/ivsrealtime/api_op_TagResource.go +++ b/service/ivsrealtime/api_op_TagResource.go @@ -34,10 +34,11 @@ 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] for details, including restrictions that apply + // to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints + // beyond what is documented there. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html // // 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 840b10c9f6e..794127f5e6c 100644 --- a/service/ivsrealtime/api_op_UntagResource.go +++ b/service/ivsrealtime/api_op_UntagResource.go @@ -34,10 +34,11 @@ 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] for details, including restrictions that apply to tags and + // "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what + // is documented there. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html // // This member is required. TagKeys []string diff --git a/service/ivsrealtime/doc.go b/service/ivsrealtime/doc.go index d040717802b..ac9a8370806 100644 --- a/service/ivsrealtime/doc.go +++ b/service/ivsrealtime/doc.go @@ -3,95 +3,162 @@ // Package ivsrealtime provides the API client, operations, and parameter types // for Amazon Interactive Video Service RealTime. // -// Introduction The Amazon Interactive Video Service (IVS) real-time 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. +// Introduction +// +// The Amazon Interactive Video Service (IVS) real-time 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: +// // - A stage is a virtual space where participants can exchange video in real // time. +// // - A participant token is a token that authenticates a participant when they // join a stage. +// // - A participant object represents participants (people) in the stage and // contains information about them. When a token is created, it includes a // participant ID; when a participant uses that token to join a stage, the // participant is associated with that participant ID. There is a 1:1 mapping // between participant tokens and participants. +// // - Server-side composition: The composition process composites participants of // a stage into a single video and forwards it to a set of outputs (e.g., IVS // channels). Composition endpoints support this process. +// // - Server-side composition: A composition controls the look of the outputs, // including how participants are positioned in the video. // -// Resources The following resources contain information about your IVS live -// stream (see Getting Started with Amazon IVS Real-Time Streaming (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html) -// ): +// # Resources +// +// The following resources contain information about your IVS live stream (see [Getting Started with Amazon IVS Real-Time Streaming]): +// // - Stage — A stage is a virtual space where participants can exchange 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 real-time 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 +// # 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] 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]). +// +// The Amazon IVS real-time 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. -// - GetParticipant — Gets information about the specified participant token. -// - GetStage — Gets information for the specified stage. -// - GetStageSession — Gets information for the specified stage session. -// - ListParticipantEvents — Lists events for a specified participant that -// occurred during a specified stage session. -// - ListParticipants — Lists all participants in a specified stage session. -// - ListStages — Gets summary information about all stages in your account, in -// the AWS region where the API request is processed. -// - ListStageSessions — Gets all sessions for a specified stage. -// - UpdateStage — Updates a stage’s configuration. -// -// Composition Endpoints -// - GetComposition — Gets information about the specified Composition resource. -// - ListCompositions — Gets summary information about all Compositions in your +// +// DisconnectParticipant +// - — Disconnects a specified participant and revokes the participant +// permanently from a specified stage. +// +// GetParticipant +// - — Gets information about the specified participant token. +// +// GetStage +// - — Gets information for the specified stage. +// +// GetStageSession +// - — Gets information for the specified stage session. +// +// ListParticipantEvents +// - — Lists events for a specified participant that occurred during a specified +// stage session. +// +// ListParticipants +// - — Lists all participants in a specified stage session. +// +// ListStages +// - — Gets summary information about all stages in your account, in the AWS +// region where the API request is processed. +// +// ListStageSessions +// - — Gets all sessions for a specified stage. +// +// UpdateStage +// - — Updates a stage’s configuration. +// +// # Composition Endpoints +// +// GetComposition +// - — Gets information about the specified Composition resource. +// +// ListCompositions +// - — Gets summary information about all Compositions in your account, in the +// AWS region where the API request is processed. +// +// StartComposition +// - — Starts a Composition from a stage based on the configuration provided in +// the request. +// +// StopComposition +// - — Stops and deletes a Composition resource. Any broadcast from the +// Composition resource is stopped. +// +// # EncoderConfiguration Endpoints +// +// CreateEncoderConfiguration +// - — Creates an EncoderConfiguration object. +// +// DeleteEncoderConfiguration +// - — Deletes an EncoderConfiguration resource. Ensures that no Compositions +// are using this template; otherwise, returns an error. +// +// GetEncoderConfiguration +// - — Gets information about the specified EncoderConfiguration resource. +// +// ListEncoderConfigurations +// - — Gets summary information about all EncoderConfigurations in your account, +// in the AWS region where the API request is processed. +// +// # StorageConfiguration Endpoints +// +// CreateStorageConfiguration +// - — Creates a new storage configuration, used to enable recording to Amazon +// S3. +// +// DeleteStorageConfiguration +// - — Deletes the storage configuration for the specified ARN. +// +// GetStorageConfiguration +// - — Gets the storage configuration for the specified ARN. +// +// ListStorageConfigurations +// - — Gets summary information about all storage configurations in your // account, in the AWS region where the API request is processed. -// - StartComposition — Starts a Composition from a stage based on the -// configuration provided in the request. -// - StopComposition — Stops and deletes a Composition resource. Any broadcast -// from the Composition resource is stopped. -// -// EncoderConfiguration Endpoints -// - CreateEncoderConfiguration — Creates an EncoderConfiguration object. -// - DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. -// Ensures that no Compositions are using this template; otherwise, returns an -// error. -// - GetEncoderConfiguration — Gets information about the specified -// EncoderConfiguration resource. -// - ListEncoderConfigurations — Gets summary information about all -// EncoderConfigurations in your account, in the AWS region where the API request -// is processed. -// -// StorageConfiguration Endpoints -// - CreateStorageConfiguration — Creates a new storage configuration, used to -// enable recording to Amazon S3. -// - DeleteStorageConfiguration — Deletes the storage configuration for the -// specified ARN. -// - GetStorageConfiguration — Gets the storage configuration for the specified -// ARN. -// - ListStorageConfigurations — Gets summary information about all storage -// configurations in your account, in the AWS region where the API request is -// processed. -// -// 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. +// +// # 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. +// +// [Getting Started with Amazon IVS Real-Time Streaming]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html +// [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html +// [Access Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html package ivsrealtime diff --git a/service/ivsrealtime/options.go b/service/ivsrealtime/options.go index fe1efedca94..99976331d28 100644 --- a/service/ivsrealtime/options.go +++ b/service/ivsrealtime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ivsrealtime/types/enums.go b/service/ivsrealtime/types/enums.go index f9f786b8289..73f52277db2 100644 --- a/service/ivsrealtime/types/enums.go +++ b/service/ivsrealtime/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for CompositionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompositionState) Values() []CompositionState { return []CompositionState{ "STARTING", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for DestinationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationState) Values() []DestinationState { return []DestinationState{ "STARTING", @@ -62,8 +64,9 @@ const ( ) // Values returns all known values for EventErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventErrorCode) Values() []EventErrorCode { return []EventErrorCode{ "INSUFFICIENT_CAPABILITIES", @@ -88,8 +91,9 @@ const ( ) // Values returns all known values for EventName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventName) Values() []EventName { return []EventName{ "JOINED", @@ -113,8 +117,9 @@ const ( ) // Values returns all known values for ParticipantState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantState) Values() []ParticipantState { return []ParticipantState{ "CONNECTED", @@ -132,6 +137,7 @@ const ( // Values returns all known values for ParticipantTokenCapability. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantTokenCapability) Values() []ParticipantTokenCapability { return []ParticipantTokenCapability{ @@ -149,8 +155,9 @@ const ( ) // Values returns all known values for PipBehavior. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipBehavior) Values() []PipBehavior { return []PipBehavior{ "STATIC", @@ -169,8 +176,9 @@ const ( ) // Values returns all known values for PipPosition. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipPosition) Values() []PipPosition { return []PipPosition{ "TOP_LEFT", @@ -189,8 +197,9 @@ const ( // Values returns all known values for RecordingConfigurationFormat. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordingConfigurationFormat) Values() []RecordingConfigurationFormat { return []RecordingConfigurationFormat{ "HLS", @@ -208,8 +217,9 @@ const ( ) // Values returns all known values for VideoAspectRatio. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoAspectRatio) Values() []VideoAspectRatio { return []VideoAspectRatio{ "AUTO", @@ -229,8 +239,9 @@ const ( ) // Values returns all known values for VideoFillMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoFillMode) Values() []VideoFillMode { return []VideoFillMode{ "FILL", diff --git a/service/ivsrealtime/types/types.go b/service/ivsrealtime/types/types.go index d08f43efa5d..3b81a6672e9 100644 --- a/service/ivsrealtime/types/types.go +++ b/service/ivsrealtime/types/types.go @@ -17,8 +17,8 @@ type ChannelDestinationConfiguration struct { // This member is required. ChannelArn *string - // ARN of the EncoderConfiguration resource. The encoder configuration and stage - // resources must be in the same AWS account and region. + // ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in + // the same AWS account and region. EncoderConfigurationArn *string noSmithyDocumentSerde @@ -62,10 +62,11 @@ type Composition struct { StartTime *time.Time // 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -103,10 +104,11 @@ type CompositionSummary struct { StartTime *time.Time // 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -206,10 +208,11 @@ type EncoderConfiguration 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string // Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 @@ -231,10 +234,11 @@ type EncoderConfigurationSummary 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -247,12 +251,13 @@ type Event struct { // the specific error that occurred. If the event is not an error event, this field // is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take // an action that the participant’s token is not allowed to do. For more - // information about participant capabilities, see the capabilities field in - // CreateParticipantToken . QUOTA_EXCEEDED indicates that the number of - // participants who want to publish/subscribe to a stage exceeds the quota; for - // more information, see Service Quotas (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html) - // . PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a + // information about participant capabilities, see the capabilities field in CreateParticipantToken. + // QUOTA_EXCEEDED indicates that the number of participants who want to + // publish/subscribe to a stage exceeds the quota; for more information, see [Service Quotas]. + // PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a // publisher that doesn’t exist. + // + // [Service Quotas]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html ErrorCode EventErrorCode // ISO 8601 timestamp (returned as a string) for when the event occurred. @@ -274,13 +279,13 @@ type Event struct { } // Configuration information specific to Grid layout, for server-side composition. -// See "Layouts" in Server-Side Composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html) -// . +// See "Layouts" in [Server-Side Composition]. +// +// [Server-Side Composition]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html type GridConfiguration struct { // This attribute name identifies the featured slot. A participant with this - // attribute set to "true" (as a string value) in ParticipantTokenConfiguration is - // placed in the featured slot. + // attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. FeaturedParticipantAttribute *string // Specifies the spacing between participant tiles in pixels. Default: 2 . @@ -387,9 +392,10 @@ type ParticipantSummary struct { noSmithyDocumentSerde } -// Object specifying a participant token in a stage. Important: Treat tokens as -// opaque; i.e., do not build functionality based on token contents. The format of -// tokens could change in the future. +// Object specifying a participant token in a stage. +// +// Important: Treat tokens as opaque; i.e., do not build functionality based on +// token contents. The format of tokens could change in the future. type ParticipantToken struct { // Application-provided attributes to encode into the token and attach to a stage. @@ -448,14 +454,13 @@ type ParticipantTokenConfiguration struct { noSmithyDocumentSerde } -// Configuration information specific to Picture-in-Picture (PiP) layout, for -// server-side composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html) -// . +// Configuration information specific to Picture-in-Picture (PiP) layout, for [server-side composition]. +// +// [server-side composition]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html type PipConfiguration struct { // This attribute name identifies the featured slot. A participant with this - // attribute set to "true" (as a string value) in ParticipantTokenConfiguration is - // placed in the featured slot. + // attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. FeaturedParticipantAttribute *string // Specifies the spacing between participant tiles in pixels. Default: 0 . @@ -478,7 +483,7 @@ type PipConfiguration struct { PipOffset int32 // Identifies the PiP slot. A participant with this attribute set to "true" (as a - // string value) in ParticipantTokenConfiguration is placed in the PiP slot. + // string value) in ParticipantTokenConfigurationis placed in the PiP slot. PipParticipantAttribute *string // Determines the corner position of the PiP window. Default: BOTTOM_RIGHT . @@ -508,8 +513,8 @@ type RecordingConfiguration struct { // stored. type S3DestinationConfiguration struct { - // ARNs of the EncoderConfiguration resource. The encoder configuration and stage - // resources must be in the same AWS account and region. + // ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in + // the same AWS account and region. // // This member is required. EncoderConfigurationArns []string @@ -567,10 +572,11 @@ 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -589,7 +595,7 @@ type StageSession struct { // ID of the session within the stage. SessionId *string - // ISO 8601 timestamp (returned as a string) when this stage session began. + // ISO 8601 timestamp (returned as a string) when this stage session began. StartTime *time.Time noSmithyDocumentSerde @@ -605,7 +611,7 @@ type StageSessionSummary struct { // ID of the session within the stage. SessionId *string - // ISO 8601 timestamp (returned as a string) when this stage session began. + // ISO 8601 timestamp (returned as a string) when this stage session began. StartTime *time.Time noSmithyDocumentSerde @@ -626,10 +632,11 @@ 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -650,10 +657,11 @@ type StorageConfiguration struct { S3 *S3StorageConfiguration // 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -674,10 +682,11 @@ type StorageConfigurationSummary struct { S3 *S3StorageConfiguration // 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] 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. + // + // [Tagging AWS Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/kafka/api_op_UntagResource.go b/service/kafka/api_op_UntagResource.go index 858a4368fb2..c25b09a25ef 100644 --- a/service/kafka/api_op_UntagResource.go +++ b/service/kafka/api_op_UntagResource.go @@ -36,12 +36,16 @@ 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: _ . / = + - @. // diff --git a/service/kafka/options.go b/service/kafka/options.go index 54a2483b5ed..419609f9bcf 100644 --- a/service/kafka/options.go +++ b/service/kafka/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kafka/types/enums.go b/service/kafka/types/enums.go index b7e9161e56b..7406c3631f6 100644 --- a/service/kafka/types/enums.go +++ b/service/kafka/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for BrokerAZDistribution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BrokerAZDistribution) Values() []BrokerAZDistribution { return []BrokerAZDistribution{ "DEFAULT", @@ -28,8 +29,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -53,8 +55,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for ClusterType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterType) Values() []ClusterType { return []ClusterType{ "PROVISIONED", @@ -96,8 +100,9 @@ const ( ) // Values returns all known values for ConfigurationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationState) Values() []ConfigurationState { return []ConfigurationState{ "ACTIVE", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for CustomerActionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomerActionStatus) Values() []CustomerActionStatus { return []CustomerActionStatus{ "CRITICAL_ACTION_REQUIRED", @@ -137,8 +143,9 @@ const ( ) // Values returns all known values for EnhancedMonitoring. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnhancedMonitoring) Values() []EnhancedMonitoring { return []EnhancedMonitoring{ "DEFAULT", @@ -157,8 +164,9 @@ const ( ) // Values returns all known values for KafkaVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KafkaVersionStatus) Values() []KafkaVersionStatus { return []KafkaVersionStatus{ "ACTIVE", @@ -174,8 +182,9 @@ const ( ) // Values returns all known values for NodeType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeType) Values() []NodeType { return []NodeType{ "BROKER", @@ -192,8 +201,9 @@ const ( // Values returns all known values for ReplicationStartingPositionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStartingPositionType) Values() []ReplicationStartingPositionType { return []ReplicationStartingPositionType{ "LATEST", @@ -213,8 +223,9 @@ const ( ) // Values returns all known values for ReplicatorState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicatorState) Values() []ReplicatorState { return []ReplicatorState{ "RUNNING", @@ -234,8 +245,9 @@ const ( ) // Values returns all known values for StorageMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageMode) Values() []StorageMode { return []StorageMode{ "LOCAL", @@ -255,8 +267,9 @@ const ( ) // Values returns all known values for TargetCompressionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetCompressionType) Values() []TargetCompressionType { return []TargetCompressionType{ "NONE", @@ -276,8 +289,9 @@ const ( ) // Values returns all known values for UserIdentityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserIdentityType) Values() []UserIdentityType { return []UserIdentityType{ "AWSACCOUNT", @@ -300,8 +314,9 @@ const ( ) // Values returns all known values for VpcConnectionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcConnectionState) Values() []VpcConnectionState { return []VpcConnectionState{ "CREATING", diff --git a/service/kafka/types/types.go b/service/kafka/types/types.go index aaa22300675..640502a73fb 100644 --- a/service/kafka/types/types.go +++ b/service/kafka/types/types.go @@ -68,9 +68,10 @@ type BrokerNodeGroupInfo struct { // The distribution of broker nodes across Availability Zones. This is an optional // parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You // can also explicitly set this parameter to the value DEFAULT. No other values are - // currently allowed. Amazon MSK distributes the broker nodes evenly across the - // Availability Zones that correspond to the subnets you provide when you create - // the cluster. + // currently allowed. + // + // Amazon MSK distributes the broker nodes evenly across the Availability Zones + // that correspond to the subnets you provide when you create the cluster. BrokerAZDistribution BrokerAZDistribution // Information about the broker access configuration. @@ -258,8 +259,9 @@ 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]. + // + // [Monitoring]: https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html EnhancedMonitoring EnhancedMonitoring LoggingInfo *LoggingInfo @@ -644,16 +646,23 @@ type EncryptionInfo struct { type EncryptionInTransit struct { // Indicates the encryption setting for data in transit between clients and - // brokers. The following are the possible values. TLS means that client-broker - // communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker - // communication is enabled for both TLS-encrypted, as well as plaintext data. + // brokers. The following are the possible values. + // + // TLS means that client-broker communication is enabled with TLS only. + // + // TLS_PLAINTEXT means that client-broker communication is enabled for both + // TLS-encrypted, as well as plaintext data. + // // PLAINTEXT means that client-broker communication is enabled in plaintext only. + // // 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 - // plaintext. The default value is true. + // plaintext. + // + // The default value is true. InCluster *bool noSmithyDocumentSerde diff --git a/service/kafkaconnect/api_op_CreateConnector.go b/service/kafkaconnect/api_op_CreateConnector.go index abb52951d2e..7f269bb7fc9 100644 --- a/service/kafkaconnect/api_op_CreateConnector.go +++ b/service/kafkaconnect/api_op_CreateConnector.go @@ -68,9 +68,10 @@ type CreateConnectorInput struct { // Amazon MSK Connect does not currently support specifying multiple plugins as a // list. To use more than one plugin for your connector, you can create a single - // custom plugin using a ZIP file that bundles multiple plugins together. Specifies - // which plugin to use for the connector. You must specify a single-element list - // containing one customPlugin object. + // custom plugin using a ZIP file that bundles multiple plugins together. + // + // Specifies which plugin to use for the connector. You must specify a + // single-element list containing one customPlugin object. // // This member is required. Plugins []types.Plugin diff --git a/service/kafkaconnect/options.go b/service/kafkaconnect/options.go index fdedd8301b6..1102deed233 100644 --- a/service/kafkaconnect/options.go +++ b/service/kafkaconnect/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kafkaconnect/types/enums.go b/service/kafkaconnect/types/enums.go index 5dc8e6532c7..b3740d9276d 100644 --- a/service/kafkaconnect/types/enums.go +++ b/service/kafkaconnect/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ConnectorState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorState) Values() []ConnectorState { return []ConnectorState{ "RUNNING", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for CustomPluginContentType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomPluginContentType) Values() []CustomPluginContentType { return []CustomPluginContentType{ "JAR", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for CustomPluginState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomPluginState) Values() []CustomPluginState { return []CustomPluginState{ "CREATING", @@ -80,8 +83,9 @@ const ( // Values returns all known values for KafkaClusterClientAuthenticationType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KafkaClusterClientAuthenticationType) Values() []KafkaClusterClientAuthenticationType { return []KafkaClusterClientAuthenticationType{ "NONE", @@ -99,8 +103,9 @@ const ( // Values returns all known values for KafkaClusterEncryptionInTransitType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KafkaClusterEncryptionInTransitType) Values() []KafkaClusterEncryptionInTransitType { return []KafkaClusterEncryptionInTransitType{ "PLAINTEXT", @@ -118,6 +123,7 @@ const ( // Values returns all known values for WorkerConfigurationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WorkerConfigurationState) Values() []WorkerConfigurationState { return []WorkerConfigurationState{ diff --git a/service/kendra/api_op_AssociateEntitiesToExperience.go b/service/kendra/api_op_AssociateEntitiesToExperience.go index a490b46620a..bd2a58adcfb 100644 --- a/service/kendra/api_op_AssociateEntitiesToExperience.go +++ b/service/kendra/api_op_AssociateEntitiesToExperience.go @@ -14,8 +14,9 @@ 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]. +// +// [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 901b228c8ae..2b6ee4c514f 100644 --- a/service/kendra/api_op_AssociatePersonasToEntities.go +++ b/service/kendra/api_op_AssociatePersonasToEntities.go @@ -14,9 +14,9 @@ import ( // Defines the specific permissions of users or groups in your IAM Identity Center // 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) -// . +// creating a search application experience, see [Building a search experience with no code]. +// +// [Building a search experience with 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{} @@ -46,9 +46,9 @@ type AssociatePersonasToEntitiesInput struct { // 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) - // . + // Owner and Viewer . For more information on these personas, see [Providing access to your search page]. + // + // [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 63c18ea5b6b..ffc0560a00e 100644 --- a/service/kendra/api_op_BatchDeleteDocument.go +++ b/service/kendra/api_op_BatchDeleteDocument.go @@ -12,13 +12,16 @@ 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 your -// Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus -// API to monitor the progress of deleting your documents. Deleting documents from -// an index using BatchDeleteDocument could take up to an hour or more, depending -// on the number of documents you want to delete. +// 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 your Amazon Web Services CloudWatch log. +// You can also use the BatchGetDocumentStatus API to monitor the progress of +// deleting your documents. +// +// Deleting documents from an index using BatchDeleteDocument could take up to an +// hour or more, depending on the number of documents you want to delete. 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 7b22abe6d32..fd6fa4d7be8 100644 --- a/service/kendra/api_op_BatchGetDocumentStatus.go +++ b/service/kendra/api_op_BatchGetDocumentStatus.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Returns the indexing status for one or more documents submitted with the [BatchPutDocument] 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] // 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 +// [BatchDeleteDocument]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html func (c *Client) BatchGetDocumentStatus(ctx context.Context, params *BatchGetDocumentStatusInput, optFns ...func(*Options)) (*BatchGetDocumentStatusOutput, error) { if params == nil { params = &BatchGetDocumentStatusInput{} @@ -44,8 +47,9 @@ type BatchGetDocumentStatusInput struct { 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) - // API. + // the [CreateIndex]API. + // + // [CreateIndex]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html // // This member is required. IndexId *string diff --git a/service/kendra/api_op_BatchPutDocument.go b/service/kendra/api_op_BatchPutDocument.go index 88de5a16323..1423314467e 100644 --- a/service/kendra/api_op_BatchPutDocument.go +++ b/service/kendra/api_op_BatchPutDocument.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more documents to an index. The BatchPutDocument API enables you to -// ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use -// this API to ingest your text and unstructured text into an index, add custom -// attributes to the documents, and to attach an access control list to the -// documents added to the index. The documents are indexed asynchronously. You can -// 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. You can also use the BatchGetDocumentStatus API to monitor the -// progress of indexing your documents. 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) -// . +// Adds one or more documents to an index. +// +// The BatchPutDocument API enables you to ingest inline documents or a set of +// documents stored in an Amazon S3 bucket. Use this API to ingest your text and +// unstructured text into an index, add custom attributes to the documents, and to +// attach an access control list to the documents added to the index. +// +// The documents are indexed asynchronously. You can 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. You can also use +// the BatchGetDocumentStatus API to monitor the progress of indexing your +// documents. +// +// For an example of ingesting inline documents using Python and Java SDKs, see [Adding files directly to an index]. +// +// [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{} @@ -39,12 +44,17 @@ func (c *Client) BatchPutDocument(ctx context.Context, params *BatchPutDocumentI type BatchPutDocumentInput struct { - // One or more documents to add to the index. Documents have the following file - // size limits. + // 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) - // . + // + // For more information, see [Quotas]. + // + // [Quotas]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html // // This member is required. Documents []types.Document @@ -57,15 +67,18 @@ type BatchPutDocumentInput struct { // 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) - // . + // [Customizing document metadata during the ingestion process]. + // + // [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]. + // + // [IAM access roles for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html RoleArn *string noSmithyDocumentSerde @@ -75,11 +88,12 @@ 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 - // CloudWatch log. For more information, see Monitoring Amazon Kendra with Amazon - // CloudWatch logs (https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html) - // . + // 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]. + // + // [Monitoring Amazon Kendra with Amazon 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_ClearQuerySuggestions.go b/service/kendra/api_op_ClearQuerySuggestions.go index 732882dc7b1..f75e326d6ea 100644 --- a/service/kendra/api_op_ClearQuerySuggestions.go +++ b/service/kendra/api_op_ClearQuerySuggestions.go @@ -10,13 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Clears existing query suggestions from an index. This deletes existing -// suggestions only, not the queries in the query log. After you clear suggestions, -// Amazon Kendra learns new suggestions based on new queries added to the query log -// from the time you cleared suggestions. If you do not see any new suggestions, -// then please allow Amazon Kendra to collect enough queries to learn new -// suggestions. ClearQuerySuggestions is currently not supported in the Amazon Web -// Services GovCloud (US-West) region. +// Clears existing query suggestions from an index. +// +// This deletes existing suggestions only, not the queries in the query log. After +// you clear suggestions, Amazon Kendra learns new suggestions based on new queries +// added to the query log from the time you cleared suggestions. If you do not see +// any new suggestions, then please allow Amazon Kendra to collect enough queries +// to learn new suggestions. +// +// ClearQuerySuggestions is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. func (c *Client) ClearQuerySuggestions(ctx context.Context, params *ClearQuerySuggestionsInput, optFns ...func(*Options)) (*ClearQuerySuggestionsOutput, error) { if params == nil { params = &ClearQuerySuggestionsInput{} diff --git a/service/kendra/api_op_CreateAccessControlConfiguration.go b/service/kendra/api_op_CreateAccessControlConfiguration.go index 901f6522235..9d8417942c0 100644 --- a/service/kendra/api_op_CreateAccessControlConfiguration.go +++ b/service/kendra/api_op_CreateAccessControlConfiguration.go @@ -14,23 +14,29 @@ import ( // 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, -// your index contains top-secret company documents that only certain employees or -// users should access. One of these users leaves the company or switches to a team -// that should be blocked from accessing top-secret documents. The user still has -// access to top-secret documents because the user had access when your documents -// were previously indexed. You can create a specific access control configuration -// for the user with deny access. You can later update the access control -// 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. +// 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, your index contains +// top-secret company documents that only certain employees or users should access. +// One of these users leaves the company or switches to a team that should be +// blocked from accessing top-secret documents. The user still has access to +// top-secret documents because the user had access when your documents were +// previously indexed. You can create a specific access control configuration for +// the user with deny access. You can later update the access control 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] +// API with the AccessControlConfigurationId included in the [Document] 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. +// +// [BatchPutDocument]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html +// [Document]: https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html func (c *Client) CreateAccessControlConfiguration(ctx context.Context, params *CreateAccessControlConfigurationInput, optFns ...func(*Options)) (*CreateAccessControlConfigurationOutput, error) { if params == nil { params = &CreateAccessControlConfigurationInput{} @@ -72,8 +78,10 @@ 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] lists that define the hierarchy for which documents users should + // have access to. + // + // [principal]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html HierarchicalAccessControlList []types.HierarchicalPrincipal noSmithyDocumentSerde diff --git a/service/kendra/api_op_CreateDataSource.go b/service/kendra/api_op_CreateDataSource.go index 8da9d79dccf..2081a88eeee 100644 --- a/service/kendra/api_op_CreateDataSource.go +++ b/service/kendra/api_op_CreateDataSource.go @@ -12,15 +12,20 @@ import ( ) // Creates a data source connector that you want to use with an Amazon Kendra -// index. You specify a name, data source connector type and description for your -// data source. You also specify configuration information for the data source -// 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) -// . +// index. +// +// You specify a name, data source connector type and description for your data +// source. You also specify configuration information for the data source +// 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]. +// For an example of creating an index and data source using the Java SDK, see [Getting started with Java SDK]. +// +// [Getting started with Python SDK]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html +// [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{} @@ -58,18 +63,22 @@ type CreateDataSourceInput struct { // 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. + // 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. 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) - // . + // 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]. + // + // [Customizing document metadata during the ingestion process]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html CustomDocumentEnrichmentConfiguration *types.CustomDocumentEnrichmentConfiguration // A description for the data source connector. @@ -78,25 +87,32 @@ type CreateDataSourceInput struct { // 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) - // . + // [Adding documents in languages other than English]. + // + // [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 - // parameter is required for all other data sources. + // data source and required resources. For more information, see [IAM access roles for Amazon Kendra.]. + // + // 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. + // + // [IAM access roles for Amazon Kendra.]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html RoleArn *string // Sets the frequency for Amazon Kendra to check the documents in your data source // repository and update the index. If you don't set a schedule Amazon Kendra will // 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 - // ValidationException exception. + // 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 ValidationException exception. Schedule *string // A list of key-value pairs that identify or categorize the data source @@ -106,8 +122,9 @@ type CreateDataSourceInput struct { 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) - // . + // your data source. For more information, see [Configuring a VPC]. + // + // [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 aec27360b49..03a041899a9 100644 --- a/service/kendra/api_op_CreateExperience.go +++ b/service/kendra/api_op_CreateExperience.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} @@ -59,8 +60,9 @@ type CreateExperienceInput struct { // The Amazon Resource Name (ARN) of an IAM role with permission to access Query // API, GetQuerySuggestions API, and other required APIs. The role also must // include permission to access IAM Identity Center 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) - // . + // information. For more information, see [IAM access roles for Amazon Kendra]. + // + // [IAM 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 fb074f91b8a..a4cdc1b082f 100644 --- a/service/kendra/api_op_CreateFaq.go +++ b/service/kendra/api_op_CreateFaq.go @@ -12,10 +12,13 @@ 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) -// . +// 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]. +// +// [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{} @@ -44,8 +47,9 @@ type CreateFaqInput struct { Name *string // 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) . + // bucket that contains the FAQs. For more information, see [IAM access roles for Amazon Kendra]. + // + // [IAM access roles for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html // // This member is required. RoleArn *string @@ -65,16 +69,23 @@ type CreateFaqInput struct { // The format of the FAQ input file. You can choose between a basic CSV format, a // CSV format that includes customs attributes in a header, and a JSON format that - // includes custom attributes. The default format is CSV. 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) - // . + // includes custom attributes. + // + // The default format is CSV. + // + // 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]. + // + // [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) . + // languages, including their codes, see [Adding documents in languages other than English]. + // + // [Adding documents in languages other than 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 ff80c8b4fa1..a7fd5e09c10 100644 --- a/service/kendra/api_op_CreateFeaturedResultsSet.go +++ b/service/kendra/api_op_CreateFeaturedResultsSet.go @@ -15,9 +15,12 @@ import ( // page. Featured results are placed above all other results for certain queries. // 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/) -// . +// 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]. +// +// [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{} @@ -54,22 +57,24 @@ type CreateFeaturedResultsSetInput struct { Description *string // 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) - // . + // search results page. For more information on the list of documents, see [FeaturedResultsSet]. + // + // [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]. + // + // [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 , // 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) - // 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 . + // using the [UpdateFeaturedResultsSet]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 . + // + // [UpdateFeaturedResultsSet]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html 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 49f417e4bdf..97c5827c616 100644 --- a/service/kendra/api_op_CreateIndex.go +++ b/service/kendra/api_op_CreateIndex.go @@ -14,13 +14,17 @@ 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 -// 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 (https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html) -// . 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) -// . +// 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]. +// For an example of creating an index and data source using the Java SDK, see [Getting started with Java SDK]. +// +// [data sources]: https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html +// [Getting started with Python SDK]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.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{} @@ -44,8 +48,9 @@ type CreateIndexInput struct { Name *string // 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) . + // Amazon CloudWatch logs and metrics. For more information, see [IAM access roles for Amazon Kendra]. + // + // [IAM access roles for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html // // This member is required. RoleArn *string @@ -61,10 +66,15 @@ type CreateIndexInput struct { // The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for // 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) + // 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] // . + // + // [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 @@ -77,19 +87,23 @@ type CreateIndexInput struct { // = + - @. Tags []types.Tag - // 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 - // 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. + // 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 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 identity source. To configure - // this, see UserGroupResolutionConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html) - // . This is useful for user context filtering, where search results are filtered - // based on the user or their group access to documents. + // this, see [UserGroupResolutionConfiguration]. This is useful for user context filtering, where search results are + // filtered based on the user or their group access to documents. + // + // [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_CreateQuerySuggestionsBlockList.go b/service/kendra/api_op_CreateQuerySuggestionsBlockList.go index 28fa534c6e3..013c7c78459 100644 --- a/service/kendra/api_op_CreateQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_CreateQuerySuggestionsBlockList.go @@ -11,16 +11,24 @@ 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 -// 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#query-suggestions-blocklist) -// . +// 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]. +// +// 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]. +// +// [Quotas for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html +// [Query suggestions block list]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist func (c *Client) CreateQuerySuggestionsBlockList(ctx context.Context, params *CreateQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*CreateQuerySuggestionsBlockListOutput, error) { if params == nil { params = &CreateQuerySuggestionsBlockListInput{} @@ -44,25 +52,29 @@ type CreateQuerySuggestionsBlockListInput struct { // This member is required. IndexId *string - // A name for the block list. For example, the name 'offensive-words', which - // includes all offensive words that could appear in user queries and need to be - // blocked from suggestions. + // A name for the block list. + // + // For example, the name 'offensive-words', which includes all offensive words + // that could appear in user queries and need to be blocked from suggestions. // // This member is required. Name *string // 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) - // . + // bucket that contains the block list text file. For more information, see [IAM access roles for Amazon Kendra]. + // + // [IAM 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) - // . + // 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]. + // + // [Quotas for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html // // This member is required. SourceS3Path *types.S3Path @@ -71,9 +83,10 @@ type CreateQuerySuggestionsBlockListInput struct { // block list. ClientToken *string - // A description for the block list. For example, the description "List of all - // offensive words that can appear in user queries and need to be blocked from - // suggestions." + // A description for the block list. + // + // For example, the description "List of all offensive words that can appear in + // user queries and need to be blocked from suggestions." Description *string // A list of key-value pairs that identify or categorize the block list. Tag keys diff --git a/service/kendra/api_op_CreateThesaurus.go b/service/kendra/api_op_CreateThesaurus.go index 32ff8fdad81..2d5226ab435 100644 --- a/service/kendra/api_op_CreateThesaurus.go +++ b/service/kendra/api_op_CreateThesaurus.go @@ -12,9 +12,11 @@ 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) -// . +// Solr format. +// +// For an example of adding a thesaurus file to an index, see [Adding custom synonyms to an index]. +// +// [Adding 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{} @@ -43,9 +45,9 @@ type CreateThesaurusInput struct { Name *string // 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) - // . + // bucket that contains the thesaurus file. For more information, see [IAM access roles for Amazon Kendra]. + // + // [IAM access roles for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html // // This member is required. RoleArn *string diff --git a/service/kendra/api_op_DeleteDataSource.go b/service/kendra/api_op_DeleteDataSource.go index ebb39424a70..0bffd3f41e1 100644 --- a/service/kendra/api_op_DeleteDataSource.go +++ b/service/kendra/api_op_DeleteDataSource.go @@ -13,10 +13,13 @@ 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) -// . Deleting an entire data source or re-syncing your index after deleting -// specific documents from a data source could take up to an hour or more, -// depending on the number of documents you want to delete. +// set to DELETING . For more information, see [Deleting Data Sources]. +// +// Deleting an entire data source or re-syncing your index after deleting specific +// documents from a data source could take up to an hour or more, depending on the +// number of documents you want to delete. +// +// [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 36561e6d4f4..1113d120c7e 100644 --- a/service/kendra/api_op_DeleteExperience.go +++ b/service/kendra/api_op_DeleteExperience.go @@ -11,9 +11,9 @@ 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) -// . +// information on creating a search application experience, see [Building a search experience with no code]. +// +// [Building a search 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_DeletePrincipalMapping.go b/service/kendra/api_op_DeletePrincipalMapping.go index 62489e3d72a..b840ec65446 100644 --- a/service/kendra/api_op_DeletePrincipalMapping.go +++ b/service/kendra/api_op_DeletePrincipalMapping.go @@ -11,15 +11,20 @@ import ( ) // 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 . +// 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 . +// // 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) { @@ -49,27 +54,31 @@ type DeletePrincipalMappingInput struct { // This member is required. IndexId *string - // The identifier of the data source you want to delete a group from. A group can - // be tied to multiple data sources. You can delete a group from accessing - // documents in 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. You want to delete - // "Research" and "Engineering" groups from Salesforce, so that these groups cannot - // access customer-related documents stored in Salesforce. Only "Sales and - // Marketing" should access documents in the Salesforce data source. + // The identifier of the data source you want to delete a group from. + // + // A group can be tied to multiple data sources. You can delete a group from + // accessing documents in 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. You + // want to delete "Research" and "Engineering" groups from Salesforce, so that + // these groups cannot access customer-related documents stored in Salesforce. Only + // "Sales and Marketing" should access documents in the Salesforce data source. DataSourceId *string // The timestamp identifier you specify to ensure Amazon Kendra does not override // the latest DELETE 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 - // 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 - // the action was received by Amazon Kendra. + // 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 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 the + // action was received by Amazon Kendra. OrderingId *int64 noSmithyDocumentSerde diff --git a/service/kendra/api_op_DeleteQuerySuggestionsBlockList.go b/service/kendra/api_op_DeleteQuerySuggestionsBlockList.go index 27939ca2f3c..30d7fcbd8a5 100644 --- a/service/kendra/api_op_DeleteQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_DeleteQuerySuggestionsBlockList.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a block list used for query suggestions for an index. A deleted block -// list might not take effect right away. Amazon Kendra needs to refresh the entire -// suggestions list to add back the queries that were previously blocked. +// Deletes a block list used for query suggestions for an index. +// +// A deleted block list might not take effect right away. Amazon Kendra needs to +// refresh the entire suggestions list to add back the queries that were previously +// blocked. +// // DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web // Services GovCloud (US-West) region. func (c *Client) DeleteQuerySuggestionsBlockList(ctx context.Context, params *DeleteQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*DeleteQuerySuggestionsBlockListOutput, error) { diff --git a/service/kendra/api_op_DescribeAccessControlConfiguration.go b/service/kendra/api_op_DescribeAccessControlConfiguration.go index b10123aa03c..46687228875 100644 --- a/service/kendra/api_op_DescribeAccessControlConfiguration.go +++ b/service/kendra/api_op_DescribeAccessControlConfiguration.go @@ -65,8 +65,10 @@ 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] lists that define the hierarchy for which documents users should + // have access to. + // + // [principal]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html 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 d3122ebc399..8b8a4d96596 100644 --- a/service/kendra/api_op_DescribeDataSource.go +++ b/service/kendra/api_op_DescribeDataSource.go @@ -54,11 +54,13 @@ type DescribeDataSourceOutput struct { CreatedAt *time.Time // Configuration information for altering document metadata and content during the - // 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 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]. + // + // [Customizing 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. @@ -76,9 +78,9 @@ 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) - // . + // supported languages, including their codes, see [Adding documents in languages other than English]. + // + // [Adding documents in languages other than English]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html LanguageCode *string // The name for the data source connector. @@ -103,8 +105,9 @@ type DescribeDataSourceOutput struct { 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) - // . + // your data source. For more information, see [Configuring a VPC]. + // + // [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 4138534d658..34b2619f4dd 100644 --- a/service/kendra/api_op_DescribeExperience.go +++ b/service/kendra/api_op_DescribeExperience.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} diff --git a/service/kendra/api_op_DescribeFaq.go b/service/kendra/api_op_DescribeFaq.go index 5b6574e88d0..e5e7f1f52f3 100644 --- a/service/kendra/api_op_DescribeFaq.go +++ b/service/kendra/api_op_DescribeFaq.go @@ -66,8 +66,9 @@ 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]. + // + // [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. diff --git a/service/kendra/api_op_DescribeFeaturedResultsSet.go b/service/kendra/api_op_DescribeFeaturedResultsSet.go index 8f87b9e054e..aa72fe7b4c5 100644 --- a/service/kendra/api_op_DescribeFeaturedResultsSet.go +++ b/service/kendra/api_op_DescribeFeaturedResultsSet.go @@ -56,14 +56,16 @@ 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) - // API. + // documents with status errors using the [BatchGetDocumentStatus]API. + // + // [BatchGetDocumentStatus]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html 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]. + // + // [FeaturedResultsSet]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html FeaturedDocumentsWithMetadata []types.FeaturedDocumentWithMetadata // The identifier of the set of featured results. @@ -76,16 +78,18 @@ 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]. + // + // [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 , // 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) - // 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 . + // using the [UpdateFeaturedResultsSet]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 . + // + // [UpdateFeaturedResultsSet]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html 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 7aa06ba48bf..406fa1d6736 100644 --- a/service/kendra/api_op_DescribeIndex.go +++ b/service/kendra/api_op_DescribeIndex.go @@ -44,8 +44,9 @@ 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]. + // + // [Adjusting capacity]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html CapacityUnits *types.CapacityUnitsConfiguration // The Unix timestamp when the index was created. diff --git a/service/kendra/api_op_DescribePrincipalMapping.go b/service/kendra/api_op_DescribePrincipalMapping.go index 45d1270204b..8b338b08b78 100644 --- a/service/kendra/api_op_DescribePrincipalMapping.go +++ b/service/kendra/api_op_DescribePrincipalMapping.go @@ -16,6 +16,7 @@ import ( // or yet to be processed, when actions were last updated, when actions were // received by Amazon Kendra, the latest action that should process and apply after // other actions, and useful error messages if an action could not be processed. +// // DescribePrincipalMapping is currently not supported in the Amazon Web Services // GovCloud (US-West) region. func (c *Client) DescribePrincipalMapping(ctx context.Context, params *DescribePrincipalMappingInput, optFns ...func(*Options)) (*DescribePrincipalMappingOutput, error) { @@ -66,12 +67,17 @@ 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. GroupOrderingIdSummaries []types.GroupOrderingIdSummary diff --git a/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go b/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go index 35b6774c70e..a5149653d0c 100644 --- a/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_DescribeQuerySuggestionsBlockList.go @@ -13,7 +13,9 @@ import ( ) // Gets information about a block list used for query suggestions for an index. +// // This is used to check the current settings that are applied to a block list. +// // DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web // Services GovCloud (US-West) region. func (c *Client) DescribeQuerySuggestionsBlockList(ctx context.Context, params *DescribeQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*DescribeQuerySuggestionsBlockListOutput, error) { @@ -75,15 +77,19 @@ type DescribeQuerySuggestionsBlockListOutput struct { Name *string // The IAM (Identity and Access Management) role used by Amazon Kendra to access - // the block list text file in S3. The role needs S3 read permissions to your file - // in S3 and needs to give STS (Security Token Service) assume role permissions to - // Amazon Kendra. + // the block list text file in S3. + // + // The role needs S3 read permissions to your file in S3 and needs to give STS + // (Security Token Service) assume role permissions to Amazon Kendra. RoleArn *string - // 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) . + // 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]. + // + // [Quotas for Amazon 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 diff --git a/service/kendra/api_op_DescribeQuerySuggestionsConfig.go b/service/kendra/api_op_DescribeQuerySuggestionsConfig.go index ac12f91c716..14a62cc17e4 100644 --- a/service/kendra/api_op_DescribeQuerySuggestionsConfig.go +++ b/service/kendra/api_op_DescribeQuerySuggestionsConfig.go @@ -12,8 +12,10 @@ 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) { @@ -52,16 +54,20 @@ type DescribeQuerySuggestionsConfigOutput struct { // information to generate the query suggestions. IncludeQueriesWithoutUserInformation *bool - // The Unix timestamp when query suggestions for an index was last cleared. After - // you clear suggestions, Amazon Kendra learns new suggestions based on new queries - // added to the query log from the time you cleared suggestions. Amazon Kendra only - // considers re-occurences of a query from the time you cleared suggestions. + // The Unix timestamp when query suggestions for an index was last cleared. + // + // After you clear suggestions, Amazon Kendra learns new suggestions based on new + // queries added to the query log from the time you cleared suggestions. Amazon + // Kendra only considers re-occurences of a query from the time you cleared + // suggestions. LastClearTime *time.Time - // The Unix timestamp when query suggestions for an index was last updated. Amazon - // Kendra automatically updates suggestions every 24 hours, after you change a - // setting or after you apply a block list (https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist) - // . + // The Unix timestamp when query suggestions for an index was last updated. + // + // Amazon Kendra automatically updates suggestions every 24 hours, after you + // change a setting or after you apply a [block list]. + // + // [block list]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist LastSuggestionsBuildTime *time.Time // The minimum number of unique users who must search a query in order for the @@ -72,28 +78,33 @@ type DescribeQuerySuggestionsConfigOutput struct { // be eligible to suggest to your users. 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 - // suggestions for your users. You can change the mode using the - // UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) - // API. + // Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode. + // + // By default, Amazon Kendra enables query suggestions. LEARN_ONLY turns off query + // suggestions for your users. You can change the mode using the [UpdateQuerySuggestionsConfig]API. + // + // [UpdateQuerySuggestionsConfig]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html 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 + // . + // + // 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. If the count is much - // lower than you expected, it could be because Amazon Kendra needs more queries in - // the query history to learn from or your current query suggestions settings are - // too strict. + // 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. + // + // If the count is much lower than you expected, it could be because Amazon Kendra + // needs more queries in the query history to learn from or your current query + // suggestions settings are too strict. 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 b6f537d5e67..9e99242309a 100644 --- a/service/kendra/api_op_DescribeThesaurus.go +++ b/service/kendra/api_op_DescribeThesaurus.go @@ -76,9 +76,10 @@ type DescribeThesaurusOutput struct { // 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. + // 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 // The number of synonym rules in the thesaurus file. diff --git a/service/kendra/api_op_DisassociateEntitiesFromExperience.go b/service/kendra/api_op_DisassociateEntitiesFromExperience.go index 8555436093b..3a489658212 100644 --- a/service/kendra/api_op_DisassociateEntitiesFromExperience.go +++ b/service/kendra/api_op_DisassociateEntitiesFromExperience.go @@ -14,8 +14,9 @@ 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]. +// +// [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 01e91c71deb..65381dd5ac7 100644 --- a/service/kendra/api_op_DisassociatePersonasFromEntities.go +++ b/service/kendra/api_op_DisassociatePersonasFromEntities.go @@ -14,9 +14,9 @@ import ( // Removes the specific permissions of users or groups in your IAM Identity Center // 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) -// . +// creating a search application experience, see [Building a search experience with no code]. +// +// [Building a search experience with 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_GetQuerySuggestions.go b/service/kendra/api_op_GetQuerySuggestions.go index cb3eddc7688..9ba9349fb7f 100644 --- a/service/kendra/api_op_GetQuerySuggestions.go +++ b/service/kendra/api_op_GetQuerySuggestions.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Fetches the queries that are suggested to your users. GetQuerySuggestions is -// currently not supported in the Amazon Web Services GovCloud (US-West) region. +// Fetches the queries that are suggested to your users. +// +// GetQuerySuggestions is currently not supported in the Amazon Web Services +// GovCloud (US-West) region. func (c *Client) GetQuerySuggestions(ctx context.Context, params *GetQuerySuggestionsInput, optFns ...func(*Options)) (*GetQuerySuggestionsOutput, error) { if params == nil { params = &GetQuerySuggestionsInput{} @@ -35,11 +37,14 @@ type GetQuerySuggestionsInput struct { // This member is required. IndexId *string - // The text of a user's query to generate query suggestions. A query is suggested - // if the query prefix matches what a user starts to type as their query. Amazon - // Kendra does not show any suggestions if a user types fewer than two characters - // or more than 60 characters. A query must also have at least one search result - // and contain at least one word of more than four characters. + // The text of a user's query to generate query suggestions. + // + // A query is suggested if the query prefix matches what a user starts to type as + // their query. + // + // Amazon Kendra does not show any suggestions if a user types fewer than two + // characters or more than 60 characters. A query must also have at least one + // search result and contain at least one word of more than four characters. // // This member is required. QueryText *string @@ -53,9 +58,11 @@ type GetQuerySuggestionsInput struct { // The suggestions type to base query suggestions on. The suggestion types are // query history or document fields/attributes. You can set one type or the other. + // // If you set query history as your suggestions type, Amazon Kendra suggests - // queries relevant to your users based on popular queries in the query history. If - // you set document fields/attributes as your suggestions type, Amazon Kendra + // queries relevant to your users based on popular queries in the query history. + // + // If you set document fields/attributes as your suggestions type, Amazon Kendra // suggests queries relevant to your users based on the contents of document // fields. SuggestionTypes []types.SuggestionType diff --git a/service/kendra/api_op_GetSnapshots.go b/service/kendra/api_op_GetSnapshots.go index 9a98690489a..661dc4facf5 100644 --- a/service/kendra/api_op_GetSnapshots.go +++ b/service/kendra/api_op_GetSnapshots.go @@ -38,26 +38,33 @@ 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 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) - // . + // 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]. + // + // [Gaining insights with 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_ListExperienceEntities.go b/service/kendra/api_op_ListExperienceEntities.go index d65072535ee..76539931996 100644 --- a/service/kendra/api_op_ListExperienceEntities.go +++ b/service/kendra/api_op_ListExperienceEntities.go @@ -14,8 +14,9 @@ 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]. +// +// [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 2242fb87e41..aa2bad9bdb6 100644 --- a/service/kendra/api_op_ListExperiences.go +++ b/service/kendra/api_op_ListExperiences.go @@ -13,8 +13,9 @@ 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]. +// +// [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_ListGroupsOlderThanOrderingId.go b/service/kendra/api_op_ListGroupsOlderThanOrderingId.go index a6fc740ffc2..9d43ed8af75 100644 --- a/service/kendra/api_op_ListGroupsOlderThanOrderingId.go +++ b/service/kendra/api_op_ListGroupsOlderThanOrderingId.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of groups that are mapped to users before a given ordering or -// timestamp identifier. ListGroupsOlderThanOrderingId is currently not supported -// in the Amazon Web Services GovCloud (US-West) region. +// timestamp identifier. +// +// ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web +// Services GovCloud (US-West) region. func (c *Client) ListGroupsOlderThanOrderingId(ctx context.Context, params *ListGroupsOlderThanOrderingIdInput, optFns ...func(*Options)) (*ListGroupsOlderThanOrderingIdOutput, error) { if params == nil { params = &ListGroupsOlderThanOrderingIdInput{} @@ -47,11 +49,11 @@ type ListGroupsOlderThanOrderingIdInput struct { // before a given ordering timestamp identifier. DataSourceId *string - // The maximum number of returned groups that are mapped to users before a given + // The maximum number of returned groups that are mapped to users before a given // ordering or timestamp identifier. MaxResults *int32 - // If the previous response was incomplete (because there is more data to + // 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 groups that are mapped to // users before a given ordering or timestamp identifier. @@ -62,13 +64,13 @@ type ListGroupsOlderThanOrderingIdInput struct { type ListGroupsOlderThanOrderingIdOutput struct { - // Summary information for list of groups that are mapped to users before a given + // Summary information for list of groups that are mapped to users before a given // ordering or timestamp identifier. GroupsSummaries []types.GroupSummary - // If the response is truncated, Amazon Kendra returns this token that you can use - // in the subsequent request to retrieve the next set of groups that are mapped to - // users before a given ordering or timestamp identifier. + // If the response is truncated, Amazon Kendra returns this token that you can + // use in the subsequent request to retrieve the next set of groups that are mapped + // to users before a given ordering or timestamp identifier. NextToken *string // Metadata pertaining to the operation's result. @@ -167,7 +169,7 @@ var _ ListGroupsOlderThanOrderingIdAPIClient = (*Client)(nil) // ListGroupsOlderThanOrderingIdPaginatorOptions is the paginator options for // ListGroupsOlderThanOrderingId type ListGroupsOlderThanOrderingIdPaginatorOptions struct { - // The maximum number of returned groups that are mapped to users before a given + // The maximum number of returned groups that are mapped to users before a given // ordering or timestamp identifier. Limit int32 diff --git a/service/kendra/api_op_ListQuerySuggestionsBlockLists.go b/service/kendra/api_op_ListQuerySuggestionsBlockLists.go index 1400edb8d93..c8283d4f58c 100644 --- a/service/kendra/api_op_ListQuerySuggestionsBlockLists.go +++ b/service/kendra/api_op_ListQuerySuggestionsBlockLists.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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]. +// +// ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web // Services GovCloud (US-West) region. +// +// [Quotas for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html func (c *Client) ListQuerySuggestionsBlockLists(ctx context.Context, params *ListQuerySuggestionsBlockListsInput, optFns ...func(*Options)) (*ListQuerySuggestionsBlockListsOutput, error) { if params == nil { params = &ListQuerySuggestionsBlockListsInput{} @@ -33,8 +37,11 @@ func (c *Client) ListQuerySuggestionsBlockLists(ctx context.Context, params *Lis 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) . + // index. + // + // For information on the current quota limits for block lists, see [Quotas for Amazon Kendra]. + // + // [Quotas for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html // // This member is required. IndexId *string @@ -53,11 +60,15 @@ type ListQuerySuggestionsBlockListsInput struct { type ListQuerySuggestionsBlockListsOutput struct { - // Summary items for a block list. This includes summary items 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 items for a block list. + // + // This includes summary items 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]. + // + // [Quotas for Amazon 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_PutPrincipalMapping.go b/service/kendra/api_op_PutPrincipalMapping.go index dcc94a4670f..2ea16f967ea 100644 --- a/service/kendra/api_op_PutPrincipalMapping.go +++ b/service/kendra/api_op_PutPrincipalMapping.go @@ -12,16 +12,23 @@ import ( ) // 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 +// 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] +// . +// +// If more than five PUT actions for a group are currently processing, a // validation exception is thrown. +// +// [Filtering on user context]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html func (c *Client) PutPrincipalMapping(ctx context.Context, params *PutPrincipalMappingInput, optFns ...func(*Options)) (*PutPrincipalMappingOutput, error) { if params == nil { params = &PutPrincipalMappingInput{} @@ -44,13 +51,15 @@ type PutPrincipalMappingInput struct { // This member is required. GroupId *string - // The list that contains your users or sub groups that belong the same group. For - // example, the group "Company" includes the user "CEO" and the sub groups - // "Research", "Engineering", and "Sales and Marketing". If you have more than 1000 - // users and/or sub groups for a single group, you need 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. + // The list that contains your users or sub groups that belong the same group. + // + // For example, the group "Company" includes the user "CEO" and the sub groups + // "Research", "Engineering", and "Sales and Marketing". + // + // If you have more than 1000 users and/or sub groups for a single group, you need + // 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. // // This member is required. GroupMembers *types.GroupMembers @@ -60,9 +69,10 @@ 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 @@ -73,19 +83,24 @@ type PutPrincipalMappingInput struct { // 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. + // 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) - // . + // contains your list of users or sub groups that belong to a group. + // + // For more information, see [IAM roles for Amazon Kendra]. + // + // [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 2024617eccf..d039f6b2cb6 100644 --- a/service/kendra/api_op_Query.go +++ b/service/kendra/api_op_Query.go @@ -11,20 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches an index given an input query. If you are working with large language -// models (LLMs) or implementing retrieval augmented generation (RAG) systems, you -// can use Amazon Kendra's Retrieve (https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html) -// API, which can return longer semantically relevant passages. We recommend using -// the Retrieve API instead of filing a service limit increase to increase the -// Query API document excerpt length. You can configure boosting or relevance -// tuning at the query level to override boosting at the index level, filter based -// on document fields/attributes and faceted search, and filter based on the user -// or their group access to documents. You can also include certain fields in the -// response that might provide useful additional information. A query response -// contains three types of results. +// Searches an index given an input query. +// +// If you are working with large language models (LLMs) or implementing retrieval +// augmented generation (RAG) systems, you can use Amazon Kendra's [Retrieve]API, which can +// return longer semantically relevant passages. We recommend using the Retrieve +// API instead of filing a service limit increase to increase the Query API +// document excerpt length. +// +// You can configure boosting or relevance tuning at the query level to override +// boosting at the index level, filter based on document fields/attributes and +// faceted search, and filter based on the user or their group access to documents. +// You can also include certain fields in the response that might provide useful +// additional information. +// +// A query response contains three types of results. +// // - Relevant suggested answers. The answers can be either a text excerpt or // table excerpt. The answer can be highlighted in the excerpt. +// // - Matching FAQs or questions-answer from your FAQ file. +// // - Relevant documents. This result type includes an excerpt of the document // with the document title. The searched terms can be highlighted in the excerpt. // @@ -33,6 +40,8 @@ import ( // results. If you filter result type to only question-answers, a maximum of four // results are returned. If you filter result type to only answers, a maximum of // three results are returned. +// +// [Retrieve]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) { if params == nil { params = &QueryInput{} @@ -57,9 +66,10 @@ type QueryInput struct { // Filters search results by document fields/attributes. You can only provide one // attribute filter; however, the AndAllFilters , NotFilter , and OrAllFilters - // parameters contain a list of other filters. The AttributeFilter parameter means - // you can create a set of filtering rules that a document must satisfy to be - // included in the query results. + // parameters contain a list of other filters. + // + // The AttributeFilter parameter means you can create a set of filtering rules + // that a document must satisfy to be included in the query results. AttributeFilter *types.AttributeFilter // Provides configuration to determine how to group results by document attribute @@ -68,12 +78,15 @@ type QueryInput struct { CollapseConfiguration *types.CollapseConfiguration // Overrides relevance tuning configurations of fields/attributes set at the index - // level. If you use this API to override the relevance tuning configured at the - // index level, but there is no relevance tuning configured at the index level, - // then Amazon Kendra does not apply any relevance tuning. If there is relevance - // tuning configured for fields at the index level, and you use this API to - // override only some of these fields, then for the fields you did not override, - // the importance is set to 1. + // level. + // + // If you use this API to override the relevance tuning configured at the index + // level, but there is no relevance tuning configured at the index level, then + // Amazon Kendra does not apply any relevance tuning. + // + // If there is relevance tuning configured for fields at the index level, and you + // use this API to override only some of these fields, then for the fields you did + // not override, the importance is set to 1. DocumentRelevanceOverrideConfigurations []types.DocumentRelevanceConfiguration // An array of documents fields/attributes for faceted search. Amazon Kendra @@ -99,8 +112,9 @@ type QueryInput struct { // token words, which excludes punctuation and stop words. Truncation still applies // if you use Boolean or more advanced, complex queries. For example, Timeoff AND // October AND Category:HR is counted as 3 tokens: timeoff , october , hr . For - // more information, see Searching with advanced query syntax (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax) - // in the Amazon Kendra Developer Guide. + // more information, see [Searching with advanced query syntax]in the Amazon Kendra Developer Guide. + // + // [Searching with advanced query syntax]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax QueryText *string // An array of document fields/attributes to include in the response. You can @@ -111,18 +125,22 @@ type QueryInput struct { // Provides information that determines how the results of the query are sorted. // You can set the field that Amazon Kendra should sort the results on, and specify // whether the results should be sorted in ascending or descending order. In the - // case of ties in sorting the results, the results are sorted by relevance. If you - // don't provide sorting configuration, the results are sorted by the relevance - // that Amazon Kendra determines for the result. + // case of ties in sorting the results, the results are sorted by relevance. + // + // If you don't provide sorting configuration, the results are sorted by the + // relevance that Amazon Kendra determines for the result. SortingConfiguration *types.SortingConfiguration // Provides configuration information to determine how the results of a query are - // sorted. You can set upto 3 fields that Amazon Kendra should sort the results on, - // and specify whether the results should be sorted in ascending or descending - // order. The sort field quota can be increased. If you don't provide a sorting - // configuration, the results are sorted by the relevance that Amazon Kendra - // determines for the result. In the case of ties in sorting the results, the - // results are sorted by relevance. + // sorted. + // + // You can set upto 3 fields that Amazon Kendra should sort the results on, and + // specify whether the results should be sorted in ascending or descending order. + // The sort field quota can be increased. + // + // If you don't provide a sorting configuration, the results are sorted by the + // relevance that Amazon Kendra determines for the result. In the case of ties in + // sorting the results, the results are sorted by relevance. SortingConfigurations []types.SortingConfiguration // Enables suggested spell corrections for queries. @@ -152,8 +170,9 @@ type QueryOutput struct { FeaturedResultsItems []types.FeaturedResultsItem // The identifier for the search. You also use QueryId to identify the search when - // using the SubmitFeedback (https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html) - // API. + // using the [SubmitFeedback]API. + // + // [SubmitFeedback]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html QueryId *string // The results of the search. @@ -167,11 +186,12 @@ type QueryOutput struct { // 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) - // . + // 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]. + // + // [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_Retrieve.go b/service/kendra/api_op_Retrieve.go index c99671ac9a4..f05b004b443 100644 --- a/service/kendra/api_op_Retrieve.go +++ b/service/kendra/api_op_Retrieve.go @@ -11,30 +11,41 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves relevant passages or text excerpts given an input query. This API is -// similar to the Query (https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) -// API. However, by default, the Query API only returns excerpt passages of up to -// 100 token words. With the Retrieve API, you can retrieve longer passages of up -// to 200 token words and up to 100 semantically relevant passages. This doesn't -// include question-answer or FAQ type responses from your index. The passages are -// text excerpts that can be semantically extracted from multiple documents and -// multiple parts of the same document. If in extreme cases your documents produce -// zero passages using the Retrieve API, you can alternatively use the Query API -// and its types of responses. You can also do the following: +// Retrieves relevant passages or text excerpts given an input query. +// +// This API is similar to the [Query] API. However, by default, the Query API only +// returns excerpt passages of up to 100 token words. With the Retrieve API, you +// can retrieve longer passages of up to 200 token words and up to 100 semantically +// relevant passages. This doesn't include question-answer or FAQ type responses +// from your index. The passages are text excerpts that can be semantically +// extracted from multiple documents and multiple parts of the same document. If in +// extreme cases your documents produce zero passages using the Retrieve API, you +// can alternatively use the Query API and its types of responses. +// +// You can also do the following: +// // - Override boosting at the index level +// // - Filter based on document fields or attributes +// // - Filter based on the user or their group access to documents +// // - View the confidence score bucket for a retrieved passage result. The // confidence bucket provides a relative ranking that indicates how confident -// Amazon Kendra is that the response is relevant to the query. Confidence score -// buckets are currently available only for English. +// Amazon Kendra is that the response is relevant to the query. +// +// Confidence score buckets are currently available only for English. // // You can also include certain fields in the response that might provide useful -// additional information. The Retrieve API shares the number of query capacity -// units (https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html) -// that you set for your index. For more information on what's included in a single -// capacity unit and the default base capacity for an index, see Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html) -// . +// additional information. +// +// The Retrieve API shares the number of [query capacity units] that you set for your index. For more +// information on what's included in a single capacity unit and the default base +// capacity for an index, see [Adjusting capacity]. +// +// [Adjusting capacity]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html +// [Query]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html +// [query capacity units]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html func (c *Client) Retrieve(ctx context.Context, params *RetrieveInput, optFns ...func(*Options)) (*RetrieveOutput, error) { if params == nil { params = &RetrieveInput{} @@ -61,27 +72,32 @@ type RetrieveInput struct { // 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. For example, Timeoff AND October AND Category:HR is counted as 3 - // tokens: timeoff , october , hr . For more information, see Searching with - // advanced query syntax (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax) - // in the Amazon Kendra Developer Guide. + // tokens: timeoff , october , hr . For more information, see [Searching with advanced query syntax] in the Amazon + // Kendra Developer Guide. + // + // [Searching with advanced query syntax]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax // // This member is required. QueryText *string // Filters search results by document fields/attributes. You can only provide one // attribute filter; however, the AndAllFilters , NotFilter , and OrAllFilters - // parameters contain a list of other filters. The AttributeFilter parameter means - // you can create a set of filtering rules that a document must satisfy to be - // included in the query results. + // parameters contain a list of other filters. + // + // The AttributeFilter parameter means you can create a set of filtering rules + // that a document must satisfy to be included in the query results. AttributeFilter *types.AttributeFilter // Overrides relevance tuning configurations of fields/attributes set at the index - // level. If you use this API to override the relevance tuning configured at the - // index level, but there is no relevance tuning configured at the index level, - // then Amazon Kendra does not apply any relevance tuning. If there is relevance - // tuning configured for fields at the index level, and you use this API to - // override only some of these fields, then for the fields you did not override, - // the importance is set to 1. + // level. + // + // If you use this API to override the relevance tuning configured at the index + // level, but there is no relevance tuning configured at the index level, then + // Amazon Kendra does not apply any relevance tuning. + // + // If there is relevance tuning configured for fields at the index level, and you + // use this API to override only some of these fields, then for the fields you did + // not override, the importance is set to 1. DocumentRelevanceOverrideConfigurations []types.DocumentRelevanceConfiguration // Retrieved relevant passages are returned in pages the size of the PageSize @@ -108,8 +124,9 @@ type RetrieveInput struct { type RetrieveOutput struct { // The identifier of query used for the search. You also use QueryId to identify - // the search when using the Submitfeedback (https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html) - // API. + // the search when using the [Submitfeedback]API. + // + // [Submitfeedback]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html QueryId *string // The results of the retrieved relevant passages for the search. diff --git a/service/kendra/api_op_StartDataSourceSyncJob.go b/service/kendra/api_op_StartDataSourceSyncJob.go index e25e75bc009..4565b824f16 100644 --- a/service/kendra/api_op_StartDataSourceSyncJob.go +++ b/service/kendra/api_op_StartDataSourceSyncJob.go @@ -12,9 +12,11 @@ import ( // Starts a synchronization job for a data source connector. If a synchronization // job is already in progress, Amazon Kendra returns a ResourceInUseException -// exception. Re-syncing your data source with your index after modifying, adding, -// or deleting documents from your data source respository could take up to an hour -// or more, depending on the number of documents to sync. +// exception. +// +// Re-syncing your data source with your index after modifying, adding, or +// deleting documents from your data source respository could take up to an hour or +// more, depending on the number of documents to sync. func (c *Client) StartDataSourceSyncJob(ctx context.Context, params *StartDataSourceSyncJobInput, optFns ...func(*Options)) (*StartDataSourceSyncJobOutput, error) { if params == nil { params = &StartDataSourceSyncJobInput{} diff --git a/service/kendra/api_op_SubmitFeedback.go b/service/kendra/api_op_SubmitFeedback.go index f5996526114..0096d8f66f8 100644 --- a/service/kendra/api_op_SubmitFeedback.go +++ b/service/kendra/api_op_SubmitFeedback.go @@ -12,8 +12,10 @@ 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{} @@ -42,7 +44,8 @@ type SubmitFeedbackInput struct { // This member is required. QueryId *string - // Tells Amazon Kendra that a particular search result link was chosen by the user. + // Tells Amazon Kendra that a particular search result link was chosen by the + // user. ClickFeedbackItems []types.ClickFeedback // Provides Amazon Kendra with relevant or not relevant feedback for whether a diff --git a/service/kendra/api_op_UpdateAccessControlConfiguration.go b/service/kendra/api_op_UpdateAccessControlConfiguration.go index fc0d2467371..d73849cd72d 100644 --- a/service/kendra/api_op_UpdateAccessControlConfiguration.go +++ b/service/kendra/api_op_UpdateAccessControlConfiguration.go @@ -14,22 +14,27 @@ import ( // Updates an access control configuration 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. You can update an access control -// configuration you created without indexing all of your documents again. For -// example, your index contains top-secret company documents that only certain -// employees or users should access. You created an 'allow' access control -// configuration for one user who recently joined the 'top-secret' team, switching -// from a team with 'deny' access to top-secret documents. However, the user -// 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. +// or their group access to documents. +// +// You can update an access control configuration you created without indexing all +// of your documents again. For example, your index contains top-secret company +// documents that only certain employees or users should access. You created an +// 'allow' access control configuration for one user who recently joined the +// 'top-secret' team, switching from a team with 'deny' access to top-secret +// documents. However, the user 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] API to apply the updated access control configuration, with the +// AccessControlConfigurationId included in the [Document] 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. +// +// [BatchPutDocument]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html +// [Document]: https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html func (c *Client) UpdateAccessControlConfiguration(ctx context.Context, params *UpdateAccessControlConfigurationInput, optFns ...func(*Options)) (*UpdateAccessControlConfigurationOutput, error) { if params == nil { params = &UpdateAccessControlConfigurationInput{} @@ -66,8 +71,10 @@ 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] lists that define the hierarchy for which documents users + // should have access to. + // + // [principal]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html 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 f490bbb68df..706bab2a3cf 100644 --- a/service/kendra/api_op_UpdateDataSource.go +++ b/service/kendra/api_op_UpdateDataSource.go @@ -43,11 +43,13 @@ type UpdateDataSourceInput struct { Configuration *types.DataSourceConfiguration // Configuration information you want to update 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) - // . + // 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]. + // + // [Customizing document metadata 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. @@ -56,24 +58,27 @@ type UpdateDataSourceInput struct { // The code for a language you want to update for the data source connector. This // 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) . + // languages, including their codes, see [Adding documents in languages other than English]. + // + // [Adding documents in languages other than English]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html LanguageCode *string // A new name for the data source connector. Name *string // 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) . + // source and required resources. For more information, see [IAM roles for Amazon Kendra]. + // + // [IAM roles for Amazon 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) - // . + // your data source. For more information, see [Configuring a VPC]. + // + // [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 1f99f9596f5..4087199c2b8 100644 --- a/service/kendra/api_op_UpdateExperience.go +++ b/service/kendra/api_op_UpdateExperience.go @@ -12,9 +12,9 @@ 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) -// . +// information on creating a search application experience, see [Building a search experience with no code]. +// +// [Building a search 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{} @@ -53,8 +53,9 @@ 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) . + // your user and group information. For more information, see [IAM roles for Amazon Kendra]. + // + // [IAM 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_UpdateFeaturedResultsSet.go b/service/kendra/api_op_UpdateFeaturedResultsSet.go index 408c4783c48..a7c519af321 100644 --- a/service/kendra/api_op_UpdateFeaturedResultsSet.go +++ b/service/kendra/api_op_UpdateFeaturedResultsSet.go @@ -47,16 +47,18 @@ 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]. + // + // [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]. + // + // [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 , diff --git a/service/kendra/api_op_UpdateIndex.go b/service/kendra/api_op_UpdateIndex.go index 409f7034ca7..afb4b6f0a8d 100644 --- a/service/kendra/api_op_UpdateIndex.go +++ b/service/kendra/api_op_UpdateIndex.go @@ -36,9 +36,10 @@ type UpdateIndexInput struct { // Sets the number of additional document storage and query capacity units that // should be used by the index. You can change the capacity of the index up to 5 - // times per day, or make 5 API calls. If you are using extra storage units, you - // can't reduce the storage capacity below what is required to meet the storage - // needs for your index. + // times per day, or make 5 API calls. + // + // If you are using extra storage units, you can't reduce the storage capacity + // below what is required to meet the storage needs for your index. CapacityUnits *types.CapacityUnitsConfiguration // A new description for the index. @@ -60,9 +61,10 @@ type UpdateIndexInput struct { UserContextPolicy types.UserContextPolicy // Gets users and groups from IAM Identity Center identity source. To configure - // this, see UserGroupResolutionConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html) - // . This is useful for user context filtering, where search results are filtered - // based on the user or their group access to documents. + // this, see [UserGroupResolutionConfiguration]. This is useful for user context filtering, where search results are + // filtered based on the user or their group access to documents. + // + // [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 cd03a1b8ec6..5781b01aaec 100644 --- a/service/kendra/api_op_UpdateQuerySuggestionsBlockList.go +++ b/service/kendra/api_op_UpdateQuerySuggestionsBlockList.go @@ -11,14 +11,20 @@ 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 -// 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. +// 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. func (c *Client) UpdateQuerySuggestionsBlockList(ctx context.Context, params *UpdateQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*UpdateQuerySuggestionsBlockListOutput, error) { if params == nil { params = &UpdateQuerySuggestionsBlockListInput{} @@ -56,14 +62,16 @@ type UpdateQuerySuggestionsBlockListInput struct { // 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 - // 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 - // suggestions with the latest content in the S3 file. This means changes might not - // take effect immediately. + // 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 suggestions with the latest content in the S3 file. This means changes + // might not take effect immediately. SourceS3Path *types.S3Path noSmithyDocumentSerde diff --git a/service/kendra/api_op_UpdateQuerySuggestionsConfig.go b/service/kendra/api_op_UpdateQuerySuggestionsConfig.go index 44a57b39909..5d8d0fbfd44 100644 --- a/service/kendra/api_op_UpdateQuerySuggestionsConfig.go +++ b/service/kendra/api_op_UpdateQuerySuggestionsConfig.go @@ -11,13 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the settings of query suggestions for an index. Amazon Kendra supports -// partial updates, so you only need to provide the fields you want to update. If -// an update is currently processing, you need to wait for the update to finish -// before making another update. Updates to query suggestions settings might not -// take effect right away. The time for your updated settings to take effect -// depends on the updates made and the number of search queries in your index. You -// can still enable/disable query suggestions at any time. +// Updates the settings of query suggestions for an index. +// +// Amazon Kendra supports partial updates, so you only need to provide the fields +// you want to update. +// +// If an update is currently processing, you need to wait for the update to finish +// before making another update. +// +// Updates to query suggestions settings might not take effect right away. The +// time for your updated settings to take effect depends on the updates made and +// the number of search queries in your index. +// +// You can still enable/disable query suggestions at any time. +// // UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web // Services GovCloud (US-West) region. func (c *Client) UpdateQuerySuggestionsConfig(ctx context.Context, params *UpdateQuerySuggestionsConfigInput, optFns ...func(*Options)) (*UpdateQuerySuggestionsConfigOutput, error) { @@ -37,7 +44,7 @@ func (c *Client) UpdateQuerySuggestionsConfig(ctx context.Context, params *Updat type UpdateQuerySuggestionsConfigInput struct { - // The identifier of the index with query suggestions you want to update. + // The identifier of the index with query suggestions you want to update. // // This member is required. IndexId *string @@ -48,38 +55,54 @@ type UpdateQuerySuggestionsConfigInput struct { // 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. + // 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 - // query to be eligible to suggest to your users. Increasing this number might - // decrease the number of suggestions. However, this ensures a query is searched by - // many users and is truly popular to suggest to users. How you tune this setting - // depends on your specific needs. + // query to be eligible to suggest to your users. + // + // Increasing this number might decrease the number of suggestions. However, this + // ensures a query is searched by many users and is truly popular to suggest to + // users. + // + // How you tune this setting 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. + // 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 - // 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. + // 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. Mode types.Mode - // How recent your queries are in your query log time window. The time window is - // the number of days from current day to past days. By default, Amazon Kendra sets - // this to 180. + // How recent your queries are in your query log time window. + // + // The time window is the number of days from current day to past days. + // + // By default, Amazon Kendra sets this to 180. QueryLogLookBackWindowInDays *int32 noSmithyDocumentSerde diff --git a/service/kendra/options.go b/service/kendra/options.go index 8e9db820070..c2a41789b99 100644 --- a/service/kendra/options.go +++ b/service/kendra/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kendra/types/enums.go b/service/kendra/types/enums.go index ac685f0ac3d..78a0e85e928 100644 --- a/service/kendra/types/enums.go +++ b/service/kendra/types/enums.go @@ -11,8 +11,9 @@ const ( // Values returns all known values for AdditionalResultAttributeValueType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalResultAttributeValueType) Values() []AdditionalResultAttributeValueType { return []AdditionalResultAttributeValueType{ "TEXT_WITH_HIGHLIGHTS_VALUE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AlfrescoEntity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlfrescoEntity) Values() []AlfrescoEntity { return []AlfrescoEntity{ "wiki", @@ -49,6 +51,7 @@ const ( // Values returns all known values for AttributeSuggestionsMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AttributeSuggestionsMode) Values() []AttributeSuggestionsMode { return []AttributeSuggestionsMode{ @@ -75,8 +78,9 @@ const ( ) // Values returns all known values for ConditionOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConditionOperator) Values() []ConditionOperator { return []ConditionOperator{ "GreaterThan", @@ -112,8 +116,9 @@ const ( // Values returns all known values for ConfluenceAttachmentFieldName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfluenceAttachmentFieldName) Values() []ConfluenceAttachmentFieldName { return []ConfluenceAttachmentFieldName{ "AUTHOR", @@ -140,8 +145,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfluenceAuthenticationType) Values() []ConfluenceAuthenticationType { return []ConfluenceAuthenticationType{ "HTTP_BASIC", @@ -165,8 +171,9 @@ const ( ) // Values returns all known values for ConfluenceBlogFieldName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfluenceBlogFieldName) Values() []ConfluenceBlogFieldName { return []ConfluenceBlogFieldName{ "AUTHOR", @@ -200,8 +207,9 @@ const ( ) // Values returns all known values for ConfluencePageFieldName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfluencePageFieldName) Values() []ConfluencePageFieldName { return []ConfluencePageFieldName{ "AUTHOR", @@ -231,6 +239,7 @@ const ( // 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{ @@ -250,8 +259,9 @@ const ( ) // Values returns all known values for ConfluenceVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfluenceVersion) Values() []ConfluenceVersion { return []ConfluenceVersion{ "CLOUD", @@ -278,8 +288,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "PDF", @@ -308,8 +319,9 @@ const ( ) // Values returns all known values for DatabaseEngineType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseEngineType) Values() []DatabaseEngineType { return []DatabaseEngineType{ "RDS_AURORA_MYSQL", @@ -331,8 +343,9 @@ const ( ) // Values returns all known values for DataSourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceStatus) Values() []DataSourceStatus { return []DataSourceStatus{ "CREATING", @@ -357,8 +370,9 @@ const ( ) // Values returns all known values for DataSourceSyncJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceSyncJobStatus) Values() []DataSourceSyncJobStatus { return []DataSourceSyncJobStatus{ "FAILED", @@ -397,8 +411,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "S3", @@ -435,6 +450,7 @@ const ( // Values returns all known values for DocumentAttributeValueType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DocumentAttributeValueType) Values() []DocumentAttributeValueType { return []DocumentAttributeValueType{ @@ -458,8 +474,9 @@ const ( ) // Values returns all known values for DocumentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentStatus) Values() []DocumentStatus { return []DocumentStatus{ "NOT_FOUND", @@ -479,8 +496,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -496,8 +514,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "USER", @@ -514,8 +533,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -534,8 +554,9 @@ const ( ) // Values returns all known values for ExperienceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExperienceStatus) Values() []ExperienceStatus { return []ExperienceStatus{ "CREATING", @@ -555,8 +576,9 @@ const ( ) // Values returns all known values for FaqFileFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FaqFileFormat) Values() []FaqFileFormat { return []FaqFileFormat{ "CSV", @@ -577,8 +599,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -599,6 +622,7 @@ const ( // 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{ @@ -615,8 +639,9 @@ const ( ) // Values returns all known values for FsxFileSystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FsxFileSystemType) Values() []FsxFileSystemType { return []FsxFileSystemType{ "WINDOWS", @@ -632,8 +657,9 @@ const ( ) // Values returns all known values for HighlightType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HighlightType) Values() []HighlightType { return []HighlightType{ "STANDARD", @@ -650,8 +676,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -672,8 +699,9 @@ const ( ) // Values returns all known values for IndexStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndexStatus) Values() []IndexStatus { return []IndexStatus{ "CREATING", @@ -698,8 +726,9 @@ const ( ) // Values returns all known values for Interval. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Interval) Values() []Interval { return []Interval{ "THIS_MONTH", @@ -721,8 +750,9 @@ const ( ) // Values returns all known values for IssueSubEntity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IssueSubEntity) Values() []IssueSubEntity { return []IssueSubEntity{ "COMMENTS", @@ -740,8 +770,9 @@ const ( ) // Values returns all known values for KeyLocation. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyLocation) Values() []KeyLocation { return []KeyLocation{ "URL", @@ -762,8 +793,9 @@ const ( ) // Values returns all known values for MetricType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricType) Values() []MetricType { return []MetricType{ "QUERIES_BY_COUNT", @@ -786,6 +818,7 @@ const ( // Values returns all known values for MissingAttributeKeyStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MissingAttributeKeyStrategy) Values() []MissingAttributeKeyStrategy { return []MissingAttributeKeyStrategy{ @@ -804,8 +837,9 @@ const ( ) // Values returns all known values for Mode. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mode) Values() []Mode { return []Mode{ "ENABLED", @@ -822,8 +856,9 @@ const ( ) // 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. +// the future, and so 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{ "ASCENDING", @@ -840,8 +875,9 @@ const ( ) // Values returns all known values for Persona. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Persona) Values() []Persona { return []Persona{ "OWNER", @@ -861,8 +897,9 @@ const ( ) // Values returns all known values for PrincipalMappingStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalMappingStatus) Values() []PrincipalMappingStatus { return []PrincipalMappingStatus{ "FAILED", @@ -882,8 +919,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "USER", @@ -901,8 +939,9 @@ const ( // Values returns all known values for QueryIdentifiersEnclosingOption. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryIdentifiersEnclosingOption) Values() []QueryIdentifiersEnclosingOption { return []QueryIdentifiersEnclosingOption{ "DOUBLE_QUOTES", @@ -919,8 +958,9 @@ const ( ) // Values returns all known values for QueryResultFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryResultFormat) Values() []QueryResultFormat { return []QueryResultFormat{ "TABLE", @@ -938,8 +978,9 @@ const ( ) // Values returns all known values for QueryResultType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryResultType) Values() []QueryResultType { return []QueryResultType{ "DOCUMENT", @@ -962,8 +1003,9 @@ const ( // Values returns all known values for QuerySuggestionsBlockListStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuerySuggestionsBlockListStatus) Values() []QuerySuggestionsBlockListStatus { return []QuerySuggestionsBlockListStatus{ "ACTIVE", @@ -984,8 +1026,9 @@ const ( ) // Values returns all known values for QuerySuggestionsStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuerySuggestionsStatus) Values() []QuerySuggestionsStatus { return []QuerySuggestionsStatus{ "ACTIVE", @@ -1002,8 +1045,9 @@ const ( ) // Values returns all known values for ReadAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadAccessType) Values() []ReadAccessType { return []ReadAccessType{ "ALLOW", @@ -1020,8 +1064,9 @@ const ( ) // Values returns all known values for RelevanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelevanceType) Values() []RelevanceType { return []RelevanceType{ "RELEVANT", @@ -1039,8 +1084,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SalesforceChatterFeedIncludeFilterType) Values() []SalesforceChatterFeedIncludeFilterType { return []SalesforceChatterFeedIncludeFilterType{ "ACTIVE_USER", @@ -1059,8 +1105,9 @@ const ( // Values returns all known values for SalesforceKnowledgeArticleState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SalesforceKnowledgeArticleState) Values() []SalesforceKnowledgeArticleState { return []SalesforceKnowledgeArticleState{ "DRAFT", @@ -1094,8 +1141,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SalesforceStandardObjectName) Values() []SalesforceStandardObjectName { return []SalesforceStandardObjectName{ "ACCOUNT", @@ -1130,8 +1178,9 @@ const ( ) // Values returns all known values for ScoreConfidence. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScoreConfidence) Values() []ScoreConfidence { return []ScoreConfidence{ "VERY_HIGH", @@ -1152,8 +1201,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNowAuthenticationType) Values() []ServiceNowAuthenticationType { return []ServiceNowAuthenticationType{ "HTTP_BASIC", @@ -1171,6 +1221,7 @@ const ( // Values returns all known values for ServiceNowBuildVersionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNowBuildVersionType) Values() []ServiceNowBuildVersionType { return []ServiceNowBuildVersionType{ @@ -1189,8 +1240,9 @@ const ( // Values returns all known values for SharePointOnlineAuthenticationType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SharePointOnlineAuthenticationType) Values() []SharePointOnlineAuthenticationType { return []SharePointOnlineAuthenticationType{ "HTTP_BASIC", @@ -1209,8 +1261,9 @@ const ( ) // Values returns all known values for SharePointVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SharePointVersion) Values() []SharePointVersion { return []SharePointVersion{ "SHAREPOINT_2013", @@ -1231,8 +1284,9 @@ const ( ) // Values returns all known values for SlackEntity. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlackEntity) Values() []SlackEntity { return []SlackEntity{ "PUBLIC_CHANNEL", @@ -1251,8 +1305,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1269,8 +1324,9 @@ const ( ) // Values returns all known values for SuggestionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SuggestionType) Values() []SuggestionType { return []SuggestionType{ "QUERY", @@ -1291,8 +1347,9 @@ const ( ) // Values returns all known values for ThesaurusStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThesaurusStatus) Values() []ThesaurusStatus { return []ThesaurusStatus{ "CREATING", @@ -1313,8 +1370,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "SAAS", @@ -1331,8 +1389,9 @@ const ( ) // Values returns all known values for UserContextPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserContextPolicy) Values() []UserContextPolicy { return []UserContextPolicy{ "ATTRIBUTE_FILTER", @@ -1349,8 +1408,9 @@ const ( ) // Values returns all known values for UserGroupResolutionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserGroupResolutionMode) Values() []UserGroupResolutionMode { return []UserGroupResolutionMode{ "AWS_SSO", @@ -1366,8 +1426,9 @@ const ( ) // Values returns all known values for WarningCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WarningCode) Values() []WarningCode { return []WarningCode{ "QUERY_LANGUAGE_INVALID_SYNTAX", @@ -1384,8 +1445,9 @@ const ( ) // Values returns all known values for WebCrawlerMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebCrawlerMode) Values() []WebCrawlerMode { return []WebCrawlerMode{ "HOST_ONLY", diff --git a/service/kendra/types/errors.go b/service/kendra/types/errors.go index 5a52d1934dd..8c45956ed66 100644 --- a/service/kendra/types/errors.go +++ b/service/kendra/types/errors.go @@ -93,8 +93,9 @@ 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]for help. +// +// [Support]: http://aws.amazon.com/contact-us/ type InternalServerException struct { Message *string @@ -255,10 +256,11 @@ func (e *ResourceUnavailableException) ErrorCode() string { } func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have exceeded the set limits for your Amazon Kendra 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. +// You have exceeded the set limits for your Amazon Kendra service. Please see [Quotas] +// for more information, or contact [Support]to inquire about an increase of limits. +// +// [Support]: http://aws.amazon.com/contact-us/ +// [Quotas]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/kendra/types/types.go b/service/kendra/types/types.go index 74e3d161b68..36348821346 100644 --- a/service/kendra/types/types.go +++ b/service/kendra/types/types.go @@ -21,8 +21,9 @@ 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]. +// +// [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. @@ -77,16 +78,20 @@ type AdditionalResultAttributeValue struct { } // Provides the configuration information to connect to Alfresco as your data -// source. Support for AlfrescoConfiguration ended May 2023. We recommend -// migrating to or using the Alfresco data source template schema / -// TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) -// API. +// source. +// +// Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or +// using the Alfresco data source template schema / [TemplateConfiguration]API. +// +// [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html 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. // // This member is required. @@ -103,11 +108,12 @@ type AlfrescoConfiguration struct { SiteUrl *string // The path to the SSL certificate stored in an Amazon S3 bucket. You use this to - // 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) - // . + // 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]. + // + // [Create and sign an X509 certificate]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html // // This member is required. SslCertificateS3Path *S3Path @@ -115,9 +121,10 @@ 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]. The Alfresco data source field names must exist in your + // Alfresco custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html BlogFieldMappings []DataSourceToIndexFieldMapping // TRUE to index comments of blogs and other content. @@ -129,9 +136,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. + // fields. For more information, see [Mapping data source fields]. The Alfresco data source field names must + // exist in your Alfresco custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html DocumentLibraryFieldMappings []DataSourceToIndexFieldMapping // Specify whether to index document libraries, wikis, or blogs. You can specify @@ -153,80 +161,98 @@ type AlfrescoConfiguration struct { 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) - // . + // your Alfresco. For more information, see [Configuring a VPC]. + // + // [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]. The Alfresco data source field names must exist in your + // Alfresco custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html WikiFieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde } -// Filters the search results based on document attributes or fields. You can -// filter results using attributes for your particular documents. The attributes -// must exist in your index. For example, if your documents include the custom -// attribute "Department", you can filter documents that belong to the "HR" +// Filters the search results based on document attributes or fields. +// +// You can filter results using attributes for your particular documents. The +// attributes must exist in your index. For example, if your documents include the +// custom attribute "Department", you can filter documents that belong to the "HR" // department. You would use the EqualsTo operation to filter results or documents -// with "Department" equals to "HR". You can use AndAllFilters and AndOrFilters in -// combination with each other or with other operations such as EqualsTo . For -// example: AndAllFilters -// - EqualsTo : "Department", "HR" -// - AndOrFilters -// - ContainsAny : "Project Name", ["new hires", "new hiring"] +// with "Department" equals to "HR". +// +// You can use AndAllFilters and AndOrFilters in combination with each other or +// with other operations such as EqualsTo . For example: +// +// AndAllFilters +// +// - EqualsTo : "Department", "HR" +// +// - AndOrFilters +// +// - ContainsAny : "Project Name", ["new hires", "new hiring"] // // This example filters results or documents that belong to the HR department and // belong to projects that contain "new hires" or "new hiring" in the project name // (must use ContainAny with StringListValue ). This example is filtering with a -// depth of 2. You cannot filter more than a depth of 2, otherwise you receive a +// depth of 2. +// +// You cannot filter more than a depth of 2, otherwise you receive a // ValidationException exception with the message "AttributeFilter cannot have a // depth of more than 2." Also, 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". For -// examples of using AttributeFilter , see Using document attributes to filter -// search results (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering) -// . +// with the message "AttributeFilter cannot have a length of more than 10". +// +// For examples of using AttributeFilter , see [Using document attributes to filter search results]. +// +// [Using document attributes to filter search results]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering type AttributeFilter struct { // Performs a logical AND operation on all filters that you specify. AndAllFilters []AttributeFilter // Returns true when a document contains all of the specified document - // attributes/fields. This filter is only applicable to StringListValue (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) - // . + // attributes/fields. This filter is only applicable to [StringListValue]. + // + // [StringListValue]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html ContainsAll *DocumentAttribute // Returns true when a document contains any of the specified document - // attributes/fields. This filter is only applicable to StringListValue (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) - // . + // attributes/fields. This filter is only applicable to [StringListValue]. + // + // [StringListValue]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html ContainsAny *DocumentAttribute // Performs an equals operation on document attributes/fields and their values. EqualsTo *DocumentAttribute // Performs a greater than operation on document attributes/fields and their - // values. Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) - // Date or Long . + // values. Use with the [document attribute type]Date or Long . + // + // [document attribute type]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html GreaterThan *DocumentAttribute // Performs a greater or equals than operation on document attributes/fields and - // their values. Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) - // Date or Long . + // their values. Use with the [document attribute type]Date or Long . + // + // [document attribute type]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html GreaterThanOrEquals *DocumentAttribute // Performs a less than operation on document attributes/fields and their values. - // Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) - // Date or Long . + // Use with the [document attribute type]Date or Long . + // + // [document attribute type]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html LessThan *DocumentAttribute // Performs a less than or equals operation on document attributes/fields and - // their values. Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html) - // Date or Long . + // their values. Use with the [document attribute type]Date or Long . + // + // [document attribute type]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html LessThanOrEquals *DocumentAttribute // Performs a logical NOT operation on all filters that you specify. @@ -239,17 +265,19 @@ type AttributeFilter struct { } // Gets information on the configuration of document fields/attributes that you -// want to base query suggestions on. To change your configuration, use -// AttributeSuggestionsUpdateConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html) -// and then call UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) -// . +// want to base query suggestions on. To change your configuration, use [AttributeSuggestionsUpdateConfig]and then +// call [UpdateQuerySuggestionsConfig]. +// +// [UpdateQuerySuggestionsConfig]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html +// [AttributeSuggestionsUpdateConfig]: https://docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html type AttributeSuggestionsDescribeConfig struct { // The mode is set to either ACTIVE or INACTIVE . If the Mode for query history is - // set to ENABLED when calling UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) - // and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE , and you - // haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES , then Amazon - // Kendra uses the query history. + // set to ENABLED when calling [UpdateQuerySuggestionsConfig] and AttributeSuggestionsMode to use + // fields/attributes is set to ACTIVE , and you haven't set your SuggestionTypes + // preference to DOCUMENT_ATTRIBUTES , then Amazon Kendra uses the query history. + // + // [UpdateQuerySuggestionsConfig]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html AttributeSuggestionsMode AttributeSuggestionsMode // The list of fields/attributes that you want to set as suggestible for query @@ -284,21 +312,26 @@ type AttributeSuggestionsGetConfig struct { } // Updates the configuration information for the document fields/attributes that -// you want to base query suggestions on. To deactivate using documents fields for -// query suggestions, set the mode to INACTIVE . You must also set SuggestionTypes -// as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) -// . If you set to QUERY , then Amazon Kendra uses the query history to base -// suggestions on. If you set to DOCUMENT_ATTRIBUTES , then Amazon Kendra uses the -// contents of document fields to base suggestions on. +// you want to base query suggestions on. +// +// To deactivate using documents fields for query suggestions, set the mode to +// INACTIVE . You must also set SuggestionTypes as either QUERY or +// DOCUMENT_ATTRIBUTES and then call [GetQuerySuggestions]. If you set to QUERY , then Amazon Kendra +// uses the query history to base suggestions on. If you set to DOCUMENT_ATTRIBUTES +// , then Amazon Kendra uses the contents of document fields to base suggestions +// on. +// +// [GetQuerySuggestions]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html type AttributeSuggestionsUpdateConfig struct { // You can set the mode to ACTIVE or INACTIVE . You must also set SuggestionTypes - // as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) - // . If Mode to use query history is set to ENABLED when calling - // UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html) - // and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE , and you - // haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES , then Amazon - // Kendra uses the query history. + // as either QUERY or DOCUMENT_ATTRIBUTES and then call [GetQuerySuggestions]. If Mode to use query + // history is set to ENABLED when calling [UpdateQuerySuggestionsConfig] and AttributeSuggestionsMode to use + // fields/attributes is set to ACTIVE , and you haven't set your SuggestionTypes + // preference to DOCUMENT_ATTRIBUTES , then Amazon Kendra uses the query history. + // + // [UpdateQuerySuggestionsConfig]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html + // [GetQuerySuggestions]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html AttributeSuggestionsMode AttributeSuggestionsMode // The list of fields/attributes that you want to set as suggestible for query @@ -313,8 +346,9 @@ type AttributeSuggestionsUpdateConfig struct { type AuthenticationConfiguration struct { // The list of configuration information that's required to connect to and crawl a - // website host using basic authentication credentials. The list includes the name - // and port number of the website host. + // website host using basic authentication credentials. + // + // The list includes the name and port number of the website host. BasicAuthentication []BasicAuthenticationConfiguration noSmithyDocumentSerde @@ -324,23 +358,30 @@ type AuthenticationConfiguration struct { // 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) + // Your secret ARN, which you can create in [Secrets Manager] + // // 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. // + // [Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html + // // This member is required. Credentials *string // The name of the website host you want to connect to using authentication - // credentials. For example, the host name of https://a.example.com/page1.html is + // credentials. + // + // For example, the host name of https://a.example.com/page1.html is // "a.example.com". // // This member is required. Host *string // The port number of the website host you want to connect to using authentication - // credentials. For example, the port for https://a.example.com/page1.html is 443, - // the standard port for HTTPS. + // credentials. + // + // For example, the port for https://a.example.com/page1.html is 443, the standard + // port for HTTPS. // // This member is required. Port *int32 @@ -365,8 +406,9 @@ 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) -// API. +// from an index by the [BatchDeleteFeaturedResultsSet]API. +// +// [BatchDeleteFeaturedResultsSet]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html type BatchDeleteFeaturedResultsSetError struct { // The error code for why the set of featured results couldn't be removed from the @@ -434,17 +476,24 @@ 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) - // . + // for the secret. For more information, see [Using a Box data source]. + // + // [Using a Box data source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html // // This member is required. SecretArn *string @@ -452,8 +501,9 @@ 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]. 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 CommentFieldMappings []DataSourceToIndexFieldMapping // TRUE to index comments. @@ -475,9 +525,10 @@ 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) + // use the UpdateIndex API before you map to Box fields. For more information, see [Mapping data source fields] // . 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 FileFieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain files and folders in @@ -490,9 +541,10 @@ 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) + // use the UpdateIndex API before you map to Box fields. For more information, see [Mapping data source fields] // . 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 TaskFieldMappings []DataSourceToIndexFieldMapping // TRUE to use the Slack change log to determine which documents require updating @@ -501,15 +553,17 @@ 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]. + // + // [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]. 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 WebLinkFieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -519,16 +573,20 @@ 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) - // 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). + // The amount of extra query capacity for an index and [GetQuerySuggestions] 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). + // + // [GetQuerySuggestions]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html // // This member is required. QueryCapacityUnits *int32 @@ -579,12 +637,16 @@ type CollapseConfiguration struct { // collapsed group. ExpandConfiguration *ExpandConfiguration - // Specifies the behavior for documents without a value for the collapse - // attribute. Amazon Kendra offers three customization options: + // Specifies the behavior for documents without a value for the collapse attribute. + // + // Amazon Kendra offers three customization options: + // // - Choose to COLLAPSE all documents with null or missing values in one group. // This is the default configuration. + // // - Choose to IGNORE documents with null or missing values. Ignored documents // will not appear in query results. + // // - Choose to EXPAND each document with a null or missing value into a group of // its own. MissingAttributeKeyStrategy MissingAttributeKeyStrategy @@ -665,10 +727,13 @@ 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 - // metadata. If you specify the AttachentFieldMappings parameter, you must specify - // at least one field mapping. + // Confluence fields. For more information, see [Mapping data source fields]. 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. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html AttachmentFieldMappings []ConfluenceAttachmentToIndexFieldMapping // TRUE to index attachments of pages and blogs in Confluence. @@ -679,13 +744,15 @@ 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]. The Confuence data source field +// names must exist in your Confluence custom metadata. +// +// [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html type ConfluenceAttachmentToIndexFieldMapping struct { - // The name of the field in the data source. You must first create the index field - // using the UpdateIndex API. + // The name of the field in the data source. + // + // You must first create the index field using the UpdateIndex API. DataSourceFieldName ConfluenceAttachmentFieldName // The format for date fields in the data source. If the field specified in @@ -707,10 +774,13 @@ 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 - // metadata. If you specify the BlogFieldMappings parameter, you must specify at - // least one field mapping. + // Confluence fields. For more information, see [Mapping data source fields]. 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. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html BlogFieldMappings []ConfluenceBlogToIndexFieldMapping noSmithyDocumentSerde @@ -718,9 +788,10 @@ 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 -// metadata. +// Confluence fields. For more information, see [Mapping data source fields]. The Confluence data source field +// names must exist in your Confluence custom metadata. +// +// [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html type ConfluenceBlogToIndexFieldMapping struct { // The name of the field in the data source. @@ -744,10 +815,12 @@ type ConfluenceConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the // 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) - // . + // 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]. + // + // [Using a Confluence data source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html // // This member is required. SecretArn *string @@ -794,26 +867,31 @@ type ConfluenceConfiguration struct { PageConfiguration *ConfluencePageConfiguration // Configuration information to connect to your Confluence URL instance via a web - // proxy. You can use this option for Confluence Server. 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. Web proxy credentials are optional and you can use them - // to connect to a web proxy server that requires basic authentication of user name - // and password. To store web proxy credentials, you use a secret in Secrets - // Manager. It is recommended that you follow best security practices when - // configuring your web proxy. This includes setting up throttling, setting up - // logging and monitoring, and applying security patches on a regular basis. If you - // use your web proxy with multiple data sources, sync jobs that occur at the same - // time could strain the load on your proxy. It is recommended you prepare your - // proxy beforehand for any security and load requirements. + // proxy. You can use this option for Confluence Server. + // + // 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. + // + // Web proxy credentials are optional and you can use them to connect to a web + // proxy server that requires basic authentication of user name and password. To + // store web proxy credentials, you use a secret in Secrets Manager. + // + // It is recommended that you follow best security practices when configuring your + // web proxy. This includes setting up throttling, setting up logging and + // monitoring, and applying security patches on a regular basis. If you use your + // web proxy with multiple data sources, sync jobs that occur at the same time + // could strain the load on your proxy. It is recommended you prepare your proxy + // beforehand for any security and load requirements. ProxyConfiguration *ProxyConfiguration // 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) - // . + // your Confluence. For more information, see [Configuring a VPC]. + // + // [Configuring a VPC]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -824,10 +902,13 @@ 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 - // metadata. If you specify the PageFieldMappings parameter, you must specify at - // least one field mapping. + // Confluence fields. For more information, see [Mapping data source fields]. 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. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html PageFieldMappings []ConfluencePageToIndexFieldMapping noSmithyDocumentSerde @@ -835,9 +916,10 @@ 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 -// metadata. +// Confluence fields. For more information, see [Mapping data source fields]. The Confluence data source field +// names must exist in your Confluence custom metadata. +// +// [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html type ConfluencePageToIndexFieldMapping struct { // The name of the field in the data source. @@ -864,8 +946,9 @@ 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]. + // + // [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, @@ -882,10 +965,13 @@ type ConfluenceSpaceConfiguration struct { // 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. + // Confluence fields. For more information, see [Mapping data source fields]. 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. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html SpaceFieldMappings []ConfluenceSpaceToIndexFieldMapping noSmithyDocumentSerde @@ -893,9 +979,10 @@ type ConfluenceSpaceConfiguration struct { // 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. +// Confluence fields. For more information, see [Mapping data source fields]. The Confluence data source field +// names must exist in your Confluence custom metadata. +// +// [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html type ConfluenceSpaceToIndexFieldMapping struct { // The name of the field in the data source. @@ -933,10 +1020,11 @@ type ConnectionConfiguration struct { DatabasePort *int32 // 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. + // credentials should be a user/password pair. For more information, see [Using a Database Data Source]. For + // more information about Secrets Manager, see [What Is Secrets Manager]in the Secrets Manager user guide. + // + // [Using a Database Data Source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html + // [What Is Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html // // This member is required. SecretArn *string @@ -950,8 +1038,9 @@ 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]. +// +// [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 @@ -989,9 +1078,11 @@ 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) -// . +// content during the document ingestion process. +// +// For more information, see [Customizing document metadata during the ingestion process]. +// +// [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 @@ -1001,31 +1092,33 @@ type CustomDocumentEnrichmentConfiguration struct { // Configuration information for invoking a Lambda function in Lambda on the // 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) - // . + // document metadata and content. For more information, see [Advanced data manipulation]. + // + // [Advanced data 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) - // . + // document metadata and content. For more information, see [Advanced data manipulation]. + // + // [Advanced data 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]. + // + // [IAM roles for Amazon Kendra]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html RoleArn *string noSmithyDocumentSerde } -// Provides the configuration information to an Amazon Kendra supported database (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html) -// . +// Provides the configuration information to an [Amazon Kendra supported database]. +// +// [Amazon Kendra supported database]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html type DatabaseConfiguration struct { // Information about where the index should get the document information from the @@ -1062,10 +1155,12 @@ type DatabaseConfiguration struct { type DataSourceConfiguration struct { // Provides the configuration information to connect to Alfresco as your data - // source. Support for AlfrescoConfiguration ended May 2023. We recommend - // migrating to or using the Alfresco data source template schema / - // TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) - // API. + // source. + // + // Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or + // using the Alfresco data source template schema / [TemplateConfiguration]API. + // + // [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html // // Deprecated: Deprecated AlfrescoConfiguration in favor of TemplateConfiguration AlfrescoConfiguration *AlfrescoConfiguration @@ -1082,27 +1177,42 @@ type DataSourceConfiguration struct { DatabaseConfiguration *DatabaseConfiguration // Provides the configuration information to connect to Amazon FSx as your data - // source. Amazon Kendra now supports an upgraded Amazon FSx Windows connector. You - // must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) - // object instead of the FsxConfiguration object to configure your connector. - // Connectors configured using the older console and API architecture will continue - // to function as configured. However, you won't be able to edit or update them. If - // you want to edit or update your connector configuration, you must create a new - // connector. We recommended migrating your connector workflow to the upgraded - // version. Support for connectors configured using the older architecture is - // scheduled to end by June 2024. + // source. + // + // Amazon Kendra now supports an upgraded Amazon FSx Windows connector. + // + // You must now use the [TemplateConfiguration] object instead of the FsxConfiguration object to + // configure your connector. + // + // Connectors configured using the older console and API architecture will + // continue to function as configured. However, you won't be able to edit or update + // them. If you want to edit or update your connector configuration, you must + // create a new connector. + // + // We recommended migrating your connector workflow to the upgraded version. + // Support for connectors configured using the older architecture is scheduled to + // end by June 2024. + // + // [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html FsxConfiguration *FsxConfiguration - // Provides the configuration information to connect to GitHub as your data - // source. Amazon Kendra now supports an upgraded GitHub connector. You must now - // use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) - // object instead of the GitHubConfiguration object to configure your connector. - // Connectors configured using the older console and API architecture will continue - // to function as configured. However, you won’t be able to edit or update them. If - // you want to edit or update your connector configuration, you must create a new - // connector. We recommended migrating your connector workflow to the upgraded - // version. Support for connectors configured using the older architecture is - // scheduled to end by June 2024. + // Provides the configuration information to connect to GitHub as your data source. + // + // Amazon Kendra now supports an upgraded GitHub connector. + // + // You must now use the [TemplateConfiguration] object instead of the GitHubConfiguration object to + // configure your connector. + // + // Connectors configured using the older console and API architecture will + // continue to function as configured. However, you won’t be able to edit or update + // them. If you want to edit or update your connector configuration, you must + // create a new connector. + // + // We recommended migrating your connector workflow to the upgraded version. + // Support for connectors configured using the older architecture is scheduled to + // end by June 2024. + // + // [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html GitHubConfiguration *GitHubConfiguration // Provides the configuration information to connect to Google Drive as your data @@ -1120,15 +1230,23 @@ type DataSourceConfiguration struct { QuipConfiguration *QuipConfiguration // Provides the configuration information to connect to an Amazon S3 bucket as - // your data source. Amazon Kendra now supports an upgraded Amazon S3 connector. - // You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) - // object instead of the S3DataSourceConfiguration object to configure your - // connector. Connectors configured using the older console and API architecture - // will continue to function as configured. However, you won't be able to edit or - // update them. If you want to edit or update your connector configuration, you - // must create a new connector. We recommended migrating your connector workflow to - // the upgraded version. Support for connectors configured using the older - // architecture is scheduled to end by June 2024. + // your data source. + // + // Amazon Kendra now supports an upgraded Amazon S3 connector. + // + // You must now use the [TemplateConfiguration] object instead of the S3DataSourceConfiguration object to + // configure your connector. + // + // Connectors configured using the older console and API architecture will + // continue to function as configured. However, you won't be able to edit or update + // them. If you want to edit or update your connector configuration, you must + // create a new connector. + // + // We recommended migrating your connector workflow to the upgraded version. + // Support for connectors configured using the older architecture is scheduled to + // end by June 2024. + // + // [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html S3Configuration *S3DataSourceConfiguration // Provides the configuration information to connect to Salesforce as your data @@ -1144,15 +1262,22 @@ type DataSourceConfiguration struct { SharePointConfiguration *SharePointConfiguration // Provides the configuration information to connect to Slack as your data source. - // Amazon Kendra now supports an upgraded Slack connector. You must now use the - // TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) - // object instead of the SlackConfiguration object to configure your connector. - // Connectors configured using the older console and API architecture will continue - // to function as configured. However, you won't be able to edit or update them. If - // you want to edit or update your connector configuration, you must create a new - // connector. We recommended migrating your connector workflow to the upgraded - // version. Support for connectors configured using the older architecture is - // scheduled to end by June 2024. + // + // Amazon Kendra now supports an upgraded Slack connector. + // + // You must now use the [TemplateConfiguration] object instead of the SlackConfiguration object to + // configure your connector. + // + // Connectors configured using the older console and API architecture will + // continue to function as configured. However, you won't be able to edit or update + // them. If you want to edit or update your connector configuration, you must + // create a new connector. + // + // We recommended migrating your connector workflow to the upgraded version. + // Support for connectors configured using the older architecture is scheduled to + // end by June 2024. + // + // [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html SlackConfiguration *SlackConfiguration // Provides a template for the configuration information to connect to your data @@ -1199,9 +1324,9 @@ 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) - // . + // supported languages, including their codes, see [Adding documents in languages other than English]. + // + // [Adding documents in languages other than English]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html LanguageCode *string // The name of the data source. @@ -1294,12 +1419,14 @@ type DataSourceSyncJobMetricTarget struct { // This member is required. DataSourceId *string - // The ID of the sync job that is running on the data source. If the ID of a sync - // job is not provided and there is a sync job running, then the ID of this sync - // job is used and metrics are generated for this sync job. If the ID of a sync job - // is not provided and there is no sync job running, then no metrics are generated - // and documents are indexed/deleted at the index level without sync job metrics - // included. + // The ID of the sync job that is running on the data source. + // + // If the ID of a sync job is not provided and there is a sync job running, then + // the ID of this sync job is used and metrics are generated for this sync job. + // + // If the ID of a sync job is not provided and there is no sync job running, then + // no metrics are generated and documents are indexed/deleted at the index level + // without sync job metrics included. DataSourceSyncJobId *string noSmithyDocumentSerde @@ -1307,12 +1434,13 @@ type DataSourceSyncJobMetricTarget struct { // Maps attributes or field names of the documents synced from the data source to // Amazon Kendra index field names. You can set up field mappings for each data -// source when calling CreateDataSource (https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) -// or UpdateDataSource (https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html) -// API. To create custom fields, use the UpdateIndex API to first create an index -// field and then map to the data source field. For more information, see Mapping -// data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) -// . +// source when calling [CreateDataSource]or [UpdateDataSource] API. To create custom fields, use the UpdateIndex API +// to first create an index field and then map to the data source field. For more +// information, see [Mapping data source fields]. +// +// [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html +// [UpdateDataSource]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html +// [CreateDataSource]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html type DataSourceToIndexFieldMapping struct { // The name of the field in the data source. You must first create the index field @@ -1357,11 +1485,13 @@ 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 @@ -1377,27 +1507,34 @@ type Document struct { // 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 + // 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 - // base64 encoded. Your code might not need to encode the document file bytes if - // you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are - // calling the Amazon Kendra endpoint directly using REST, you must base64 encode - // the contents before sending. + // The contents of the document. + // + // Documents passed to the Blob parameter must be base64 encoded. Your code might + // not need to encode the document file bytes if you're using an Amazon Web + // Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra + // endpoint directly using REST, you must base64 encode the contents before + // sending. Blob []byte - // The file type of the document in the Blob field. If you want to index snippets - // or subsets of HTML documents instead of the entirety of the HTML documents, you - // must add the HTML start and closing tags ( content ) around the content. + // The file type of the document in the Blob field. + // + // If you want to index snippets or subsets of HTML documents instead of the + // entirety of the HTML documents, you must add the HTML start and closing tags ( + // content ) around the content. 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] lists that define the hierarchy for which documents users should + // have access to. + // + // [principal]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html HierarchicalAccessControlList []HierarchicalPrincipal // Information required to find a specific file in an Amazon S3 bucket. @@ -1410,8 +1547,9 @@ 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]. +// +// [Custom attributes]: https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html type DocumentAttribute struct { // The identifier for the attribute. @@ -1428,62 +1566,78 @@ 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 +// ingesting documents into Amazon Kendra. You use this with [DocumentAttributeTarget to apply the condition]. +// +// 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. +// 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 to apply the condition]: https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html type DocumentAttributeCondition struct { - // The identifier of the document attribute used for the condition. For example, - // 'Source_URI' could be an identifier for the attribute or metadata field that - // contains source URIs associated with the documents. Amazon Kendra currently does - // not support _document_body as an attribute key used for the condition. + // The identifier of the document attribute used for the condition. + // + // For example, 'Source_URI' could be an identifier for the attribute or metadata + // field that contains source URIs associated with the documents. + // + // Amazon Kendra currently does not support _document_body as an attribute key + // used for the condition. // // 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 - // The value used by the operator. For example, you can specify the value - // 'financial' for strings in the 'Source_URI' field that partially match or - // contain this value. + // The value used by the operator. + // + // For example, you can specify the value 'financial' for strings in the + // 'Source_URI' field that partially match or contain this value. ConditionOnValue *DocumentAttributeValue noSmithyDocumentSerde } // 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 -// '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 -// 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) -// . +// 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 '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 Kendra then will map your +// newly created metadata field to your index field. +// +// You can also use this with [DocumentAttributeCondition]. +// +// [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, - // 'Department' could be an identifier for the target attribute or metadata field - // that includes the department names associated with the documents. + // The identifier of the target document attribute or metadata field. + // + // For example, 'Department' could be an identifier for the target attribute or + // metadata field that includes the department names associated with the documents. TargetDocumentAttributeKey *string - // The target value you want to create for the target attribute. For example, - // 'Finance' could be the target value for the target attribute key 'Department'. + // The target value you want to create for the target attribute. + // + // For example, 'Finance' could be the target value for the target attribute key + // 'Department'. TargetDocumentAttributeValue *DocumentAttributeValue // TRUE to delete the existing target value for your specified target attribute @@ -1498,10 +1652,11 @@ type DocumentAttributeTarget struct { // document attribute. type DocumentAttributeValue struct { - // A date expressed as an ISO 8601 string. It is important for the time zone to be - // included in the ISO 8601 date-time format. For example, - // 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 - // at 12:30PM (plus 10 seconds) in Central European Time. + // A date expressed as an ISO 8601 string. + // + // It is important for the time zone to be included in the ISO 8601 date-time + // format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format + // for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. DateValue *time.Time // A long integer value. @@ -1528,14 +1683,15 @@ type DocumentAttributeValueCountPair struct { DocumentAttributeValue *DocumentAttributeValue // Contains the results of a document attribute/field that is a nested facet. A - // FacetResult contains the counts for each facet nested within a facet. For - // example, the document attribute or facet "Department" includes a value called - // "Engineering". In addition, the document attribute or facet "SubDepartment" - // includes the values "Frontend" and "Backend" for documents assigned to - // "Engineering". You can display nested facets in the search results so that - // documents can be searched not only by department but also by a sub department - // within a department. The counts for documents that belong to "Frontend" and - // "Backend" within "Engineering" are returned for a query. + // FacetResult contains the counts for each facet nested within a facet. + // + // For example, the document attribute or facet "Department" includes a value + // called "Engineering". In addition, the document attribute or facet + // "SubDepartment" includes the values "Frontend" and "Backend" for documents + // assigned to "Engineering". You can display nested facets in the search results + // so that documents can be searched not only by department but also by a sub + // department within a department. The counts for documents that belong to + // "Frontend" and "Backend" within "Engineering" are returned for a query. FacetResults []FacetResult noSmithyDocumentSerde @@ -1549,14 +1705,22 @@ type DocumentInfo struct { // This member is required. DocumentId *string - // Attributes that identify a specific version of a document to check. The only - // valid attributes are: + // 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". Attributes []DocumentAttribute @@ -1672,9 +1836,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]. + // + // [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 @@ -1699,11 +1863,12 @@ type ExpandConfiguration struct { noSmithyDocumentSerde } -// A single expanded result in a collapsed group of search results. An expanded -// result item contains information about an expanded result document within a -// collapsed group of search results. This includes the original location of the -// document, a list of attributes assigned to the document, and relevant text from -// the document that satisfies the query. +// A single expanded result in a collapsed group of search results. +// +// An expanded result item contains information about an expanded result document +// within a collapsed group of search results. This includes the original location +// of the document, a list of attributes assigned to the document, and relevant +// text from the document that satisfies the query. type ExpandedResultItem struct { // An array of document attributes assigned to a document in the search results. @@ -1764,9 +1929,9 @@ type ExperienceEndpoint struct { // Summary information for users or groups in your IAM Identity Center identity // 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) -// . +// creating a search application experience, see [Building a search experience with no code]. +// +// [Building a search experience with no code]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html type ExperienceEntitiesSummary struct { // Information about the user entity. @@ -1784,8 +1949,9 @@ 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]. +// +// [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. @@ -1808,30 +1974,42 @@ type ExperiencesSummary struct { } // Information about a document attribute or field. You can use document -// attributes as facets. For example, the document attribute or facet "Department" -// includes the values "HR", "Engineering", and "Accounting". You can display these -// values in the search results so that documents can be searched by department. +// attributes as facets. +// +// For example, the document attribute or facet "Department" includes the 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/) . +// increase this limit, contact [Support]. +// +// [Support]: http://aws.amazon.com/contact-us/ type Facet struct { // The unique key for the document attribute. DocumentAttributeKey *string - // An array of document attributes that are nested facets within a facet. For - // example, the document attribute or facet "Department" includes a value called - // "Engineering". In addition, the document attribute or facet "SubDepartment" - // includes the values "Frontend" and "Backend" for documents assigned to - // "Engineering". You can display nested facets in the search results so that - // 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/) . + // An array of document attributes that are nested facets within a facet. + // + // For example, the document attribute or facet "Department" includes a value + // called "Engineering". In addition, the document attribute or facet + // "SubDepartment" includes the values "Frontend" and "Backend" for documents + // assigned to "Engineering". You can display nested facets in the search results + // so that 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]. + // + // [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/) . + // default, contact [Support]. + // + // [Support]: http://aws.amazon.com/contact-us/ MaxResults int32 noSmithyDocumentSerde @@ -1897,9 +2075,9 @@ type FaqSummary struct { // 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) - // . + // For more information on supported languages, including their codes, see [Adding documents in languages other than English]. + // + // [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. @@ -1921,9 +2099,10 @@ type FaqSummary struct { 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 - // search for specific documents with their document IDs included in the result - // items, or you can use the console. + // the [Query]API to search for specific documents with their document IDs included in + // the result items, or you can use the console. + // + // [Query]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html Id *string noSmithyDocumentSerde @@ -1932,8 +2111,9 @@ 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) -// API. +// errors using the [BatchGetDocumentStatus]API. +// +// [BatchGetDocumentStatus]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html type FeaturedDocumentMissing struct { // The identifier of the document that doesn't exist but you have specified as a @@ -1949,9 +2129,11 @@ type FeaturedDocumentMissing struct { // 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] API + // to search for specific documents with their document IDs included in the result + // items, or you can use the console. + // + // [Query]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html Id *string // The main title of the featured document. @@ -1991,8 +2173,9 @@ 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]. + // + // [Submitting feedback]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html FeedbackToken *string // The identifier of the featured result. @@ -2018,17 +2201,22 @@ type FeaturedResultsSet struct { 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 search results page. You can use the [Query]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]. + // + // 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. + // + // [Query]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html + // [Support]: http://aws.amazon.com/contact-us/ FeaturedDocuments []FeaturedDocument // The identifier of the set of featured results. @@ -2040,21 +2228,23 @@ type FeaturedResultsSet struct { // The Unix timestamp when the set of featured results was last updated. LastUpdatedTimestamp *int64 - // The list of queries for featuring results. 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 queries for featuring results. + // + // 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. QueryTexts []string // 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) - // 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 . + // using the [UpdateFeaturedResultsSet]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 . + // + // [UpdateFeaturedResultsSet]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html Status FeaturedResultsSetStatus noSmithyDocumentSerde @@ -2080,31 +2270,42 @@ type FeaturedResultsSetSummary struct { // 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) - // 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 . + // using the [UpdateFeaturedResultsSet]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 . + // + // [UpdateFeaturedResultsSet]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html Status FeaturedResultsSetStatus noSmithyDocumentSerde } // Provides the configuration information to connect to Amazon FSx as your data -// source. Amazon Kendra now supports an upgraded Amazon FSx Windows connector. You -// must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) -// object instead of the FsxConfiguration object to configure your connector. -// Connectors configured using the older console and API architecture will continue -// to function as configured. However, you won't be able to edit or update them. If -// you want to edit or update your connector configuration, you must create a new -// connector. We recommended migrating your connector workflow to the upgraded -// version. Support for connectors configured using the older architecture is -// scheduled to end by June 2024. +// source. +// +// Amazon Kendra now supports an upgraded Amazon FSx Windows connector. +// +// You must now use the [TemplateConfiguration] object instead of the FsxConfiguration object to +// configure your connector. +// +// Connectors configured using the older console and API architecture will +// continue to function as configured. However, you won't be able to edit or update +// them. If you want to edit or update your connector configuration, you must +// create a new connector. +// +// We recommended migrating your connector workflow to the upgraded version. +// Support for connectors configured using the older architecture is scheduled to +// end by June 2024. +// +// [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html 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) - // . + // 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]. + // + // [Amazon FSx Getting started guide]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html // // This member is required. FileSystemId *string @@ -2130,9 +2331,10 @@ 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]. The Amazon FSx data source field names must exist in your + // Amazon FSx custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain files in your Amazon @@ -2146,10 +2348,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. SecretArn *string @@ -2157,24 +2361,33 @@ type FsxConfiguration struct { noSmithyDocumentSerde } -// Provides the configuration information to connect to GitHub as your data -// source. Amazon Kendra now supports an upgraded GitHub connector. You must now -// use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) -// object instead of the GitHubConfiguration object to configure your connector. -// Connectors configured using the older console and API architecture will continue -// to function as configured. However, you won’t be able to edit or update them. If -// you want to edit or update your connector configuration, you must create a new -// connector. We recommended migrating your connector workflow to the upgraded -// version. Support for connectors configured using the older architecture is -// scheduled to end by June 2024. +// Provides the configuration information to connect to GitHub as your data source. +// +// Amazon Kendra now supports an upgraded GitHub connector. +// +// You must now use the [TemplateConfiguration] object instead of the GitHubConfiguration object to +// configure your connector. +// +// Connectors configured using the older console and API architecture will +// continue to function as configured. However, you won’t be able to edit or update +// them. If you want to edit or update your connector configuration, you must +// create a new connector. +// +// We recommended migrating your connector workflow to the upgraded version. +// Support for connectors configured using the older architecture is scheduled to +// end by June 2024. +// +// [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html 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) - // . + // creating a token in GitHub, see [Using a GitHub data source]. + // + // [Using a GitHub data source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html // // This member is required. SecretArn *string @@ -2203,8 +2416,10 @@ 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]. The GitHub data source field names must exist in your GitHub + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html GitHubCommitConfigurationFieldMappings []DataSourceToIndexFieldMapping // Configuration information to include certain types of GitHub content. You can @@ -2215,50 +2430,64 @@ 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. + // more information, see [Mapping data source fields]. The GitHub data source field names must exist in your + // GitHub custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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. + // more information, see [Mapping data source fields]. The GitHub data source field names must exist in your + // GitHub custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. The GitHub data source field names must exist in your GitHub + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. The GitHub data source field names must exist in + // your GitHub custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. The GitHub data source field names must exist in + // your GitHub custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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. + // more information, see [Mapping data source fields]. The GitHub data source field names must exist in your + // GitHub custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. The GitHub data source field names must exist in your GitHub + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html GitHubRepositoryConfigurationFieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain file names in your @@ -2302,8 +2531,9 @@ 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]. + // + // [Configuring a VPC]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -2343,17 +2573,19 @@ 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]. + // + // [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) - // . + // specified MIME type are excluded. + // + // For a list of MIME types, see [Using a Google Workspace Drive data source]. + // + // [Using a Google 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 @@ -2375,9 +2607,10 @@ 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]. The Google Drive data source + // field names must exist in your Google Drive custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain items in your Google @@ -2408,11 +2641,13 @@ type GroupMembers struct { // If you have more than 1000 users and/or sub groups for a single group, you need // 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 - // optional. The value of type for a group is always GROUP and for a user it is - // always USER . + // groups that belong to a group (and/or users) must be no more than 1000. + // + // You can download this [example S3 file] 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 . + // + // [example S3 file]: https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip S3PathforGroupMembers *S3Path noSmithyDocumentSerde @@ -2457,14 +2692,16 @@ type GroupSummary struct { noSmithyDocumentSerde } -// Information to define the hierarchy for which documents users should have +// 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] 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. + // + // [principal]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html // // This member is required. PrincipalList []Principal @@ -2498,36 +2735,40 @@ 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) -// 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) -// . +// Kendra. You can configure your Lambda function using [PreExtractionHookConfiguration]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]. 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]. +// +// [Customizing document metadata during the ingestion process]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html +// [PreExtractionHookConfiguration]: https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html +// [PostExtractionHookConfiguration]: https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.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]. + // + // [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) - // . + // and after altering them. For more information, see [Data contracts for Lambda functions]. + // + // [Data contracts for Lambda functions]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda // // This member is required. S3Bucket *string - // The condition used for when a Lambda function should be invoked. For example, - // you can specify a condition that if there are empty date-time values, then - // Amazon Kendra should invoke a function that inserts the current date-time. + // The condition used for when a Lambda function should be invoked. + // + // For example, you can specify a condition that if there are empty date-time + // values, then Amazon Kendra should invoke a function that inserts the current + // date-time. InvocationCondition *DocumentAttributeCondition noSmithyDocumentSerde @@ -2585,11 +2826,12 @@ 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) -// . +// apply advanced logic, to go beyond what you can do with basic logic, see [HookConfiguration]. +// +// For more information, see [Customizing document metadata during the ingestion process]. +// +// [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 type InlineCustomDocumentEnrichmentConfiguration struct { // Configuration of the condition used for the target document attribute or @@ -2617,10 +2859,12 @@ 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) - // . + // + // - jiraCredentials—The Jira API token. For more information, see [Using a Jira data source]. + // + // [Using a Jira data source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html // // This member is required. SecretArn *string @@ -2628,15 +2872,19 @@ 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]. The Jira data source field names must exist in your Jira + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. The Jira data source field names must exist in your Jira + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html CommentFieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to exclude certain file paths, file @@ -2656,8 +2904,10 @@ type JiraConfiguration struct { // 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]. The Jira data source field names must exist in your Jira + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html IssueFieldMappings []DataSourceToIndexFieldMapping // Specify whether to crawl comments, attachments, and work logs. You can specify @@ -2675,8 +2925,10 @@ type JiraConfiguration struct { // 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]. The Jira data source field names must exist in your Jira + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html ProjectFieldMappings []DataSourceToIndexFieldMapping // Specify which statuses to crawl in your Jira data source. You can specify one @@ -2689,15 +2941,18 @@ type JiraConfiguration struct { 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) - // . + // your Jira. For more information, see [Configuring a VPC]. + // + // [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]. The Jira data source field names must exist in your Jira + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html WorkLogFieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -2802,24 +3057,27 @@ type OneDriveConfiguration struct { // OneDrive. Documents that match the patterns are excluded from the index. // Documents that don't match the patterns are included in the index. If a document // matches both an inclusion and exclusion pattern, the exclusion pattern takes - // precedence and the document isn't included in the index. The pattern is applied - // to the file name. + // precedence and the document isn't included in the index. + // + // The pattern is applied to the file name. ExclusionPatterns []string // 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]. The OneDrive data source field names must exist in your + // OneDrive custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain documents in your // OneDrive. Documents that match the patterns are included in the index. Documents // that don't match the patterns are excluded from the index. If a document matches // both an inclusion and exclusion pattern, the exclusion pattern takes precedence - // and the document isn't included in the index. The pattern is applied to the file - // name. + // and the document isn't included in the index. + // + // The pattern is applied to the file name. InclusionPatterns []string noSmithyDocumentSerde @@ -2860,11 +3118,12 @@ type OnPremiseConfiguration struct { OrganizationName *string // The path to the SSL certificate stored in an Amazon S3 bucket. You use this to - // 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) - // . + // 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]. + // + // [Create and sign an X509 certificate]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html // // This member is required. SslCertificateS3Path *S3Path @@ -2876,8 +3135,9 @@ 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]. +// +// [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. @@ -2889,9 +3149,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]. + // + // [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. @@ -2900,8 +3160,9 @@ 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]. +// +// [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. @@ -2929,33 +3190,42 @@ type Principal struct { // hosts. type ProxyConfiguration struct { - // The name of the website host you want to connect to via a web proxy server. For - // example, the host name of https://a.example.com/page1.html is "a.example.com". + // The name of the website host you want to connect to via a web proxy server. + // + // For example, the host name of https://a.example.com/page1.html is + // "a.example.com". // // This member is required. Host *string // The port number of the website host you want to connect to via a web proxy - // server. For example, the port for https://a.example.com/page1.html is 443, the - // standard port for HTTPS. + // server. + // + // For example, the port for https://a.example.com/page1.html is 443, the standard + // port for HTTPS. // // 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) + // Your secret ARN, which you can create in [Secrets Manager] + // // 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. + // + // [Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html Credentials *string noSmithyDocumentSerde } -// A single query result. A query result contains information about a document -// returned by the query. This includes the original location of the document, a -// list of attributes assigned to the document, and relevant text from the document -// that satisfies the query. +// A single query result. +// +// A query result contains information about a document returned by the query. +// This includes the original location of the document, a list of attributes +// assigned to the document, and relevant text from the document that satisfies the +// query. type QueryResultItem struct { // One or more additional fields/attributes associated with the query result. @@ -2985,8 +3255,9 @@ 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]. + // + // [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 @@ -3003,9 +3274,10 @@ type QueryResultItem struct { // Indicates the confidence level of Amazon Kendra providing a relevant result for // the query. 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 is relevant to the query. + // 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 is relevant to the query. ScoreAttributes *ScoreAttributes // An excerpt from a table within a document. @@ -3018,12 +3290,15 @@ 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]. +// +// [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. @@ -3059,9 +3334,10 @@ 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]. + // + // [Using a Quip data source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html // // This member is required. SecretArn *string @@ -3069,8 +3345,9 @@ 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]. The Quip field names must exist in your Quip custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html AttachmentFieldMappings []DataSourceToIndexFieldMapping // TRUE to index attachments. @@ -3105,20 +3382,23 @@ 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]. The Quip field names must exist in your Quip custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. The Quip field names must exist in your Quip custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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]. + // + // [Configuring a VPC]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -3135,7 +3415,9 @@ type Relevance struct { // of the boost drops off. The higher the importance, the faster the effect drops // off. If you don't specify a value, the default is 3 months. The value of the // field is a numeric string followed by the character "s", for example "86400s" - // for one day, or "604800s" for one week. Only applies to DATE fields. + // for one day, or "604800s" for one week. + // + // Only applies to DATE fields. Duration *string // Indicates that this field determines how "fresh" a document is. For example, if @@ -3147,22 +3429,29 @@ type Relevance struct { // of a boost than smaller numbers. 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 - // 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 - // tracking application, a priority 1 task is more important than a priority 5 - // task. Only applies to LONG fields. + // Determines how values should be interpreted. + // + // When the RankOrder field is 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 tracking application, a priority 1 task is more important than a + // priority 5 task. + // + // Only applies to LONG fields. RankOrder Order // A list of values that should be given a different boost when they appear in the // result list. For example, if you are boosting a field called "department", query // terms that match the department field are boosted in the result. However, you // can add entries from the department field to boost documents with those values - // higher. For example, you can add entries to the map with names of departments. - // If you add "HR",5 and "Legal",3 those departments are given special attention - // when they appear in the metadata of a document. When those terms appear they are - // given the specified importance instead of the regular importance for the boost. + // higher. + // + // For example, you can add entries to the map with names of departments. If you + // add "HR",5 and "Legal",3 those departments are given special attention when they + // appear in the metadata of a document. When those terms appear they are given the + // specified importance instead of the regular importance for the boost. ValueImportanceMap map[string]int32 noSmithyDocumentSerde @@ -3218,15 +3507,22 @@ type RetrieveResultItem struct { } // Provides the configuration information to connect to an Amazon S3 bucket. -// Amazon Kendra now supports an upgraded Amazon S3 connector. You must now use the -// TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) -// object instead of the S3DataSourceConfiguration object to configure your -// connector. Connectors configured using the older console and API architecture -// will continue to function as configured. However, you won't be able to edit or -// update them. If you want to edit or update your connector configuration, you -// must create a new connector. We recommended migrating your connector workflow to -// the upgraded version. Support for connectors configured using the older -// architecture is scheduled to end by June 2024. +// +// Amazon Kendra now supports an upgraded Amazon S3 connector. +// +// You must now use the [TemplateConfiguration] object instead of the S3DataSourceConfiguration object to +// configure your connector. +// +// Connectors configured using the older console and API architecture will +// continue to function as configured. However, you won't be able to edit or update +// them. If you want to edit or update your connector configuration, you must +// create a new connector. +// +// We recommended migrating your connector workflow to the upgraded version. +// Support for connectors configured using the older architecture is scheduled to +// end by June 2024. +// +// [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html type S3DataSourceConfiguration struct { // The name of the bucket that contains the documents. @@ -3235,8 +3531,9 @@ 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]. + // + // [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 @@ -3249,20 +3546,30 @@ type S3DataSourceConfiguration struct { // types to exclude from your index. If a document matches both an inclusion and // exclusion prefix or pattern, the exclusion prefix takes precendence and the // document is not indexed. Examples of glob patterns include: + // // - /myapp/config/*—All files inside config directory. + // // - **/*.png—All .png files in all directories. + // // - **/*.{png, ico, md}—All .png, .ico or .md files in all directories. + // // - /myapp/src/**/*.ts—All .ts files inside src directory (and all its // subdirectories). + // // - **/!(*.module).ts—All .ts files but not .module.ts + // // - *.png , *.jpg—All PNG and JPEG image files in a directory (files with the // extensions .png and .jpg). + // // - *internal*—All files in a directory that contain 'internal' in the file // name, such as 'internal', 'internal_only', 'company_internal'. + // // - **/*internal*—All internal-related files in a directory and its // subdirectories. - // For more examples, see Use of Exclude and Include Filters (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) - // in the Amazon Web Services CLI Command Reference. + // + // For more examples, see [Use of Exclude and Include Filters] in the Amazon Web Services CLI Command Reference. + // + // [Use of Exclude and Include Filters]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters ExclusionPatterns []string // A list of glob patterns (patterns that can expand a wildcard pattern into a @@ -3270,20 +3577,30 @@ type S3DataSourceConfiguration struct { // types to include in your index. If a document matches both an inclusion and // exclusion prefix or pattern, the exclusion prefix takes precendence and the // document is not indexed. Examples of glob patterns include: + // // - /myapp/config/*—All files inside config directory. + // // - **/*.png—All .png files in all directories. + // // - **/*.{png, ico, md}—All .png, .ico or .md files in all directories. + // // - /myapp/src/**/*.ts—All .ts files inside src directory (and all its // subdirectories). + // // - **/!(*.module).ts—All .ts files but not .module.ts + // // - *.png , *.jpg—All PNG and JPEG image files in a directory (files with the // extensions .png and .jpg). + // // - *internal*—All files in a directory that contain 'internal' in the file // name, such as 'internal', 'internal_only', 'company_internal'. + // // - **/*internal*—All internal-related files in a directory and its // subdirectories. - // For more examples, see Use of Exclude and Include Filters (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) - // in the Amazon Web Services CLI Command Reference. + // + // For more examples, see [Use of Exclude and Include Filters] in the Amazon Web Services CLI Command Reference. + // + // [Use of Exclude and Include Filters]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters InclusionPatterns []string // A list of S3 prefixes for the documents that should be included in the index. @@ -3360,16 +3677,22 @@ 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. // // This member is required. @@ -3390,16 +3713,18 @@ type SalesforceConfiguration struct { // Salesforce. Documents that match the patterns are excluded from the index. // Documents that don't match the patterns are included in the index. If a document // matches both an inclusion and exclusion pattern, the exclusion pattern takes - // precedence and the document isn't included in the index. The pattern is applied - // to the name of the attached file. + // precedence and the document isn't included in the index. + // + // The pattern is applied to the name of the attached file. ExcludeAttachmentFilePatterns []string // A list of regular expression patterns to include certain documents in your // Salesforce. Documents that match the patterns are included in the index. // Documents that don't match the patterns are excluded from the index. If a // document matches both an inclusion and exclusion pattern, the exclusion pattern - // takes precedence and the document isn't included in the index. The pattern is - // applied to the name of the attached file. + // takes precedence and the document isn't included in the index. + // + // The pattern is applied to the name of the attached file. IncludeAttachmentFilePatterns []string // Configuration information for the knowledge article types that Amazon Kendra @@ -3438,9 +3763,10 @@ type SalesforceCustomKnowledgeArticleTypeConfiguration struct { // 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 - // metadata. + // map to Salesforce fields. For more information, see [Mapping data source fields]. The Salesforce data + // source field names must exist in your Salesforce custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -3481,9 +3807,10 @@ 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 - // metadata. + // Salesforce fields. For more information, see [Mapping data source fields]. The Salesforce data source field + // names must exist in your Salesforce custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -3523,9 +3850,10 @@ 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 - // metadata. + // Salesforce fields. For more information, see [Mapping data source fields]. The Salesforce data source field + // names must exist in your Salesforce custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping noSmithyDocumentSerde @@ -3567,27 +3895,35 @@ type Search struct { } // Provides the configuration information for the seed or starting point 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. +// crawl. +// +// When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy] 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. +// +// [Amazon Acceptable Use Policy]: https://aws.amazon.com/aup/ type SeedUrlConfiguration struct { - // The list of seed or starting point URLs of the websites you want to crawl. The - // list can include a maximum of 100 seed URLs. + // The list of seed or starting point URLs of the websites you want to crawl. + // + // The list can include a maximum of 100 seed URLs. // // This member is required. 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 . WebCrawlerMode WebCrawlerMode @@ -3617,8 +3953,9 @@ 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]. + // + // [Using a ServiceNow data source]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html // // This member is required. SecretArn *string @@ -3633,10 +3970,12 @@ type ServiceNowConfiguration struct { // 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 - // 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) - // . + // 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]. + // + // [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 @@ -3675,16 +4014,20 @@ type ServiceNowKnowledgeArticleConfiguration struct { // 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 - // metadata. + // ServiceNow fields. For more information, see [Mapping data source fields]. The ServiceNow data source field + // names must exist in your ServiceNow custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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) - // . + // private. + // + // The query string must be one generated by the ServiceNow console. For more + // information, see [Specifying documents to index with a query]. + // + // [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 applied to include knowledge article @@ -3718,23 +4061,26 @@ type ServiceNowServiceCatalogConfiguration struct { // 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. + // precedence and the item isn't included in the index. + // + // The regex is applied to the file name of the attachment. ExcludeAttachmentFilePatterns []string // 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 - // metadata. + // fields. For more information, see [Mapping data source fields]. The ServiceNow data source field names must + // exist in your ServiceNow custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html 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. + // 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 @@ -3746,8 +4092,9 @@ 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]. + // + // [Microsoft SharePoint]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html // // This member is required. SecretArn *string @@ -3781,47 +4128,55 @@ type SharePointConfiguration struct { // SharePoint. Documents that match the patterns are excluded from the index. // Documents that don't match the patterns are included in the index. If a document // matches both an inclusion and exclusion pattern, the exclusion pattern takes - // precedence and the document isn't included in the index. The regex applies to - // the display URL of the SharePoint document. + // precedence and the document isn't included in the index. + // + // The regex applies to the display URL of the SharePoint document. ExclusionPatterns []string // 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 - // metadata. + // information, see [Mapping data source fields]. The SharePoint data source field names must exist in your + // SharePoint custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain documents in your // SharePoint. Documents that match the patterns are included in the index. // Documents that don't match the patterns are excluded from the index. If a // document matches both an inclusion and exclusion pattern, the exclusion pattern - // takes precedence and the document isn't included in the index. The regex applies - // to the display URL of the SharePoint document. + // takes precedence and the document isn't included in the index. + // + // The regex applies to the display URL of the SharePoint document. InclusionPatterns []string // Configuration information to connect to your Microsoft SharePoint site URLs via - // instance via a web proxy. You can use this option for SharePoint Server. 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. Web proxy credentials are optional and you can use them - // to connect to a web proxy server that requires basic authentication of user name - // and password. To store web proxy credentials, you use a secret in Secrets - // Manager. It is recommended that you follow best security practices when - // configuring your web proxy. This includes setting up throttling, setting up - // logging and monitoring, and applying security patches on a regular basis. If you - // use your web proxy with multiple data sources, sync jobs that occur at the same - // time could strain the load on your proxy. It is recommended you prepare your - // proxy beforehand for any security and load requirements. + // instance via a web proxy. You can use this option for SharePoint Server. + // + // 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. + // + // Web proxy credentials are optional and you can use them to connect to a web + // proxy server that requires basic authentication of user name and password. To + // store web proxy credentials, you use a secret in Secrets Manager. + // + // It is recommended that you follow best security practices when configuring your + // web proxy. This includes setting up throttling, setting up logging and + // monitoring, and applying security patches on a regular basis. If you use your + // web proxy with multiple data sources, sync jobs that occur at the same time + // could strain the load on your proxy. It is recommended you prepare your proxy + // beforehand for any security and load requirements. ProxyConfiguration *ProxyConfiguration // The path to the SSL certificate stored in an Amazon S3 bucket. You use this to - // 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) - // . + // 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]. + // + // [Create and sign an 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 @@ -3831,22 +4186,26 @@ type SharePointConfiguration struct { 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) - // . + // your Microsoft SharePoint. For more information, see [Configuring a VPC]. + // + // [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. +// Provides the configuration information for the sitemap URLs to crawl. +// +// When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy] 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. +// +// [Amazon Acceptable Use Policy]: https://aws.amazon.com/aup/ 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 @@ -3855,23 +4214,32 @@ type SiteMapsConfiguration struct { } // Provides the configuration information to connect to Slack as your data source. -// Amazon Kendra now supports an upgraded Slack connector. You must now use the -// TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) -// object instead of the SlackConfiguration object to configure your connector. -// Connectors configured using the older console and API architecture will continue -// to function as configured. However, you won’t be able to edit or update them. If -// you want to edit or update your connector configuration, you must create a new -// connector. We recommended migrating your connector workflow to the upgraded -// version. Support for connectors configured using the older architecture is -// scheduled to end by June 2024. +// +// Amazon Kendra now supports an upgraded Slack connector. +// +// You must now use the [TemplateConfiguration] object instead of the SlackConfiguration object to +// configure your connector. +// +// Connectors configured using the older console and API architecture will +// continue to function as configured. However, you won’t be able to edit or update +// them. If you want to edit or update your connector configuration, you must +// create a new connector. +// +// We recommended migrating your connector workflow to the upgraded version. +// Support for connectors configured using the older architecture is scheduled to +// end by June 2024. +// +// [TemplateConfiguration]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html 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) - // . + // creating a token in Slack, see [Authentication for a Slack data source]. + // + // [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 @@ -3889,6 +4257,7 @@ type SlackConfiguration struct { 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/.... @@ -3912,8 +4281,10 @@ 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]. The Slack data source field names must exist in your Slack + // custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain attached files in your @@ -3924,11 +4295,13 @@ type SlackConfiguration struct { InclusionPatterns []string // The number of hours for change log to look back from when you last synchronized - // your data. You can look back up to 7 days or 168 hours. Change log updates your - // index only if new content was added since you last synced your data. Updated or - // deleted content from before you last synced does not get updated in your index. - // To capture updated or deleted content before you last synced, set the - // LookBackPeriod to the number of hours you want change log to look back. + // your data. You can look back up to 7 days or 168 hours. + // + // Change log updates your index only if new content was added since you last + // synced your data. Updated or deleted content from before you last synced does + // not get updated in your index. To capture updated or deleted content before you + // last synced, set the LookBackPeriod to the number of hours you want change log + // to look back. LookBackPeriod *int32 // The list of private channel names from your Slack workspace team. You use this @@ -3947,8 +4320,9 @@ type SlackConfiguration struct { 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) - // . + // your Slack. For more information, see [Configuring a VPC]. + // + // [Configuring a VPC]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html VpcConfiguration *DataSourceVpcConfiguration noSmithyDocumentSerde @@ -3957,22 +4331,33 @@ 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 // // You can't sort attributes of the following type. +// // - 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: + // 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 // // This member is required. @@ -4018,12 +4403,14 @@ type SpellCorrectedQuery struct { } // Provides the configuration information for suggested query spell corrections. +// // Suggested spell corrections are based on words that appear in your indexed -// 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) -// . +// 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]. +// +// [Spell Checker documentation]: https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html type SpellCorrectionConfiguration struct { // TRUE to suggest spell corrections for queries. @@ -4038,12 +4425,16 @@ type SpellCorrectionConfiguration struct { type SqlConfiguration struct { // Determines whether Amazon Kendra encloses SQL identifiers for tables and column - // names in double quotes (") when making a database query. By default, Amazon - // Kendra passes SQL identifiers the way that they are entered into the data source - // configuration. It does not change the case of identifiers or enclose them in - // quotes. PostgreSQL internally converts uppercase characters to lower case - // characters in identifiers unless they are quoted. Choosing this option encloses - // identifiers in quotes so that PostgreSQL does not convert the character's case. + // names in double quotes (") when making a database query. + // + // By default, Amazon Kendra passes SQL identifiers the way that they are entered + // into the data source configuration. It does not change the case of identifiers + // or enclose them in quotes. + // + // PostgreSQL internally converts uppercase characters to lower case 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 . QueryIdentifiersEnclosingOption QueryIdentifiersEnclosingOption @@ -4057,8 +4448,10 @@ type Status struct { // The identifier of the document. DocumentId *string - // The current status of a document. If the document was submitted for deletion, - // the status is NOT_FOUND after the document is deleted. + // The current status of a document. + // + // If the document was submitted for deletion, the status is NOT_FOUND after the + // document is deleted. DocumentStatus DocumentStatus // Indicates the source of the error. @@ -4097,7 +4490,9 @@ type Suggestion struct { SourceDocuments []SourceDocument // The value for the UUID (universally unique identifier) of a single query - // suggestion. The value is the text string of a suggestion. + // suggestion. + // + // The value is the text string of a suggestion. Value *SuggestionValue noSmithyDocumentSerde @@ -4210,8 +4605,11 @@ 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]. + // + // [Data source template schemas]: https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html Template document.Interface noSmithyDocumentSerde @@ -4278,38 +4676,51 @@ type TimeRange struct { noSmithyDocumentSerde } -// Provides the configuration information of the URLs to crawl. 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. +// Provides the configuration information of the URLs to crawl. +// +// 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] 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. +// +// [Amazon Acceptable Use Policy]: https://aws.amazon.com/aup/ type Urls struct { // Configuration of the seed or starting point URLs of the websites you want to - // crawl. You can choose to crawl only the website host names, or the website host - // names with subdomains, or the website host names with subdomains and other - // domains that the web pages link to. You can list up to 100 seed URLs. + // crawl. + // + // You can choose to crawl only the website host names, or the website host names + // with subdomains, or the website host names with subdomains and other domains + // that the web pages link to. + // + // You can list up to 100 seed URLs. SeedUrlConfiguration *SeedUrlConfiguration - // Configuration of the sitemap URLs of the websites you want to crawl. Only URLs - // belonging to the same website host names are crawled. You can list up to three - // sitemap URLs. + // Configuration of the sitemap URLs of the websites you want to crawl. + // + // Only URLs belonging to the same website host names are crawled. You can list up + // to three sitemap URLs. SiteMapsConfiguration *SiteMapsConfiguration noSmithyDocumentSerde } -// Provides information about the user context for an Amazon Kendra index. User -// context filtering is a kind of personalized search with the benefit of +// Provides information about the user context for an Amazon Kendra index. +// +// User context filtering is a kind of personalized search with the benefit of // controlling access to documents. For example, not all teams that search the // company portal for information should access top-secret company documents, nor // 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: +// 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. // @@ -4338,18 +4749,21 @@ type UserContext struct { // Provides the configuration information to get users and groups from an IAM // Identity Center 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 . +// documents. You can also use the [PutPrincipalMapping]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]. 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]. +// +// 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 . +// +// [Getting started with an IAM Identity Center identity source]: https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html +// [IAM roles for IAM Identity Center]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso +// [PutPrincipalMapping]: https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html type UserGroupResolutionConfiguration struct { // The identity store provider (mode) you want to use to get users and groups. IAM @@ -4366,12 +4780,13 @@ 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]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]. + // + // [Getting started with an IAM Identity Center identity source]: https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html + // [user context filtering]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html IdentityAttributeName *string noSmithyDocumentSerde @@ -4405,25 +4820,34 @@ type Warning struct { 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. + // 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] 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. + // + // [Amazon Acceptable Use Policy]: https://aws.amazon.com/aup/ // // 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 - // 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. + // password. You use a secret in [Secrets Manager]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. + // + // [Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html AuthenticationConfiguration *AuthenticationConfiguration // The 'depth' or number of levels from the seed level to crawl. For example, the @@ -4431,30 +4855,41 @@ type WebCrawlerConfiguration struct { // are depth 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. - // This number is per web page. As a website’s web pages are crawled, any URLs the - // web pages link to are also crawled. URLs on a web page are crawled in order of - // appearance. The default maximum links per page is 100. + // This number is per web page. + // + // As a website’s web pages are crawled, any URLs the web pages link to are also + // crawled. URLs on a web page are crawled in order of 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 - // web proxy. 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. 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) - // . + // web proxy. + // + // 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. + // + // 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]. + // + // [Secrets 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 @@ -4475,23 +4910,30 @@ type WebCrawlerConfiguration struct { } // Provides the configuration information to connect to Amazon WorkDocs as your -// data source. Amazon WorkDocs connector is available in Oregon, North Virginia, -// Sydney, Singapore and Ireland regions. +// data source. +// +// Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, +// Singapore and Ireland regions. 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] 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. + // + // [Directory Service]: https://console.aws.amazon.com/directoryservicev2/ // // 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 . + // index means each comment is a document that can be searched on. + // + // The default is set to FALSE . CrawlComments bool // A list of regular expression patterns to exclude certain files in your Amazon @@ -4504,9 +4946,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. + // fields. For more information, see [Mapping data source fields]. The Amazon WorkDocs data source field names + // must exist in your Amazon WorkDocs custom metadata. + // + // [Mapping data source fields]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html FieldMappings []DataSourceToIndexFieldMapping // A list of regular expression patterns to include certain files in your Amazon diff --git a/service/kendraranking/api_op_CreateRescoreExecutionPlan.go b/service/kendraranking/api_op_CreateRescoreExecutionPlan.go index 37245b0fd21..798ba40c9de 100644 --- a/service/kendraranking/api_op_CreateRescoreExecutionPlan.go +++ b/service/kendraranking/api_op_CreateRescoreExecutionPlan.go @@ -14,10 +14,12 @@ import ( // Creates a rescore execution plan. A rescore execution plan is an Amazon Kendra // Intelligent Ranking resource used for provisioning the Rescore API. You set the // 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) -// . +// 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]. +// +// [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{} @@ -43,9 +45,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]. + // + // [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 9e5cc38787c..53fa709f37a 100644 --- a/service/kendraranking/api_op_DescribeRescoreExecutionPlan.go +++ b/service/kendraranking/api_op_DescribeRescoreExecutionPlan.go @@ -48,9 +48,9 @@ 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) - // . + // more information on the default capacity and additional capacity units, see [Adjusting capacity]. + // + // [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. diff --git a/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go b/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go index 30447410cc6..535e60a8b3e 100644 --- a/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go +++ b/service/kendraranking/api_op_UpdateRescoreExecutionPlan.go @@ -40,9 +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]. + // + // [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/options.go b/service/kendraranking/options.go index 5aab840a035..173f7872700 100644 --- a/service/kendraranking/options.go +++ b/service/kendraranking/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kendraranking/types/enums.go b/service/kendraranking/types/enums.go index 7a732d14144..daad0604e2d 100644 --- a/service/kendraranking/types/enums.go +++ b/service/kendraranking/types/enums.go @@ -15,6 +15,7 @@ const ( // Values returns all known values for RescoreExecutionPlanStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RescoreExecutionPlanStatus) Values() []RescoreExecutionPlanStatus { return []RescoreExecutionPlanStatus{ diff --git a/service/kendraranking/types/errors.go b/service/kendraranking/types/errors.go index a02f904df79..8f3f72a4b29 100644 --- a/service/kendraranking/types/errors.go +++ b/service/kendraranking/types/errors.go @@ -63,7 +63,9 @@ func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.Fault // An issue occurred with the internal server used for your Amazon Kendra // Intelligent Ranking service. Please wait a few minutes and try again, or contact -// Support (http://aws.amazon.com/contact-us/) for help. +// [Support]for help. +// +// [Support]: http://aws.amazon.com/contact-us/ type InternalServerException struct { Message *string @@ -144,9 +146,11 @@ 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]for more information, or contact [Support] to inquire about an +// increase of limits. +// +// [Support]: http://aws.amazon.com/contact-us/ +// [Quotas]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/kendraranking/types/types.go b/service/kendraranking/types/types.go index 52a116716d1..8a3aa5886fd 100644 --- a/service/kendraranking/types/types.go +++ b/service/kendraranking/types/types.go @@ -13,9 +13,10 @@ import ( // usage requirements. type CapacityUnitsConfiguration struct { - // The amount of extra capacity for your rescore execution plan. A single extra - // capacity unit for a rescore execution plan provides 0.01 rescore requests per - // second. You can add up to 1000 extra capacity units. + // The amount of extra capacity for your rescore execution plan. + // + // A single extra capacity unit for a rescore execution plan provides 0.01 rescore + // requests per second. You can add up to 1000 extra capacity units. // // This member is required. RescoreCapacityUnits *int32 diff --git a/service/keyspaces/api_op_CreateKeyspace.go b/service/keyspaces/api_op_CreateKeyspace.go index 29d34ba8b81..95dddce2215 100644 --- a/service/keyspaces/api_op_CreateKeyspace.go +++ b/service/keyspaces/api_op_CreateKeyspace.go @@ -13,10 +13,13 @@ import ( // The CreateKeyspace operation adds a new keyspace to your account. In an Amazon // 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) -// in the Amazon Keyspaces Developer Guide. +// +// 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] in the Amazon Keyspaces Developer Guide. +// +// [Creating keyspaces]: https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-keyspaces.html#keyspaces-create func (c *Client) CreateKeyspace(ctx context.Context, params *CreateKeyspaceInput, optFns ...func(*Options)) (*CreateKeyspaceOutput, error) { if params == nil { params = &CreateKeyspaceInput{} @@ -39,17 +42,21 @@ type CreateKeyspaceInput struct { // This member is required. KeyspaceName *string - // The replication specification of the keyspace includes: + // The replication specification of the keyspace includes: + // // - replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION . + // // - regionList - if the replicationStrategy is MULTI_REGION , the regionList // requires the current Region and at least one additional Amazon Web Services // Region where the keyspace is going to be replicated in. The maximum number of // supported replication Regions including the current Region is six. ReplicationSpecification *types.ReplicationSpecification - // 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) - // in the Amazon Keyspaces Developer Guide. + // 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] in the Amazon Keyspaces Developer Guide. + // + // [Adding tags and labels to Amazon Keyspaces resources]: https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/keyspaces/api_op_CreateTable.go b/service/keyspaces/api_op_CreateTable.go index 4deecda0a56..a93aafb0900 100644 --- a/service/keyspaces/api_op_CreateTable.go +++ b/service/keyspaces/api_op_CreateTable.go @@ -12,12 +12,16 @@ 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 -// 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) -// in the Amazon Keyspaces Developer Guide. +// 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 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] in the Amazon Keyspaces Developer Guide. +// +// [Creating tables]: https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) { if params == nil { params = &CreateTableInput{} @@ -40,25 +44,39 @@ type CreateTableInput struct { // This member is required. KeyspaceName *string - // The schemaDefinition consists of the following parameters. For each column to - // be created: + // 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. + // + // - type - An Amazon Keyspaces data type. For more information, see [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 + // + // 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. // + // [Data types]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types + // // This member is required. SchemaDefinition *types.SchemaDefinition @@ -69,28 +87,38 @@ type CreateTableInput struct { // The optional auto scaling settings for a table in provisioned capacity mode. // Specifies if the service can manage throughput capacity automatically on your - // behalf. Auto scaling helps you provision throughput capacity for variable - // workloads efficiently by increasing and decreasing your table's read and write - // capacity automatically in response to application traffic. For more information, - // see Managing throughput capacity automatically with Amazon Keyspaces auto - // scaling (https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html) - // in the Amazon Keyspaces Developer Guide. By default, auto scaling is disabled - // for a table. + // behalf. + // + // Auto scaling helps you provision throughput capacity for variable workloads + // efficiently by increasing and decreasing your table's read and write capacity + // automatically in response to application traffic. For more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]in + // the Amazon Keyspaces Developer Guide. + // + // By default, auto scaling is disabled for a table. + // + // [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]: https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html AutoScalingSpecification *types.AutoScalingSpecification // 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) - // in the Amazon Keyspaces Developer Guide. + // + // The default is throughput_mode:PAY_PER_REQUEST . + // + // For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. + // + // [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html CapacitySpecification *types.CapacitySpecification - // Enables client-side timestamps for the table. By default, the setting is + // 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. ClientSideTimestamps *types.ClientSideTimestamps @@ -98,58 +126,82 @@ type CreateTableInput struct { // 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) - // in the Amazon Keyspaces Developer Guide. + // The default Time to Live setting in seconds for the table. + // + // For more information, see [Setting the default TTL value for a table] in the Amazon Keyspaces Developer Guide. + // + // [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 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. + // + // The default is type:AWS_OWNED_KMS_KEY . + // + // For more information, see [Encryption at rest] in the Amazon Keyspaces Developer Guide. + // + // [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html 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) - // in the Amazon Keyspaces Developer Guide. + // + // If it's not specified, the default is status=DISABLED . + // + // For more information, see [Point-in-time recovery] in the Amazon Keyspaces Developer Guide. + // + // [Point-in-time recovery]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html PointInTimeRecovery *types.PointInTimeRecovery // The optional Amazon Web Services Region specific settings of a multi-Region // table. These settings overwrite the general settings of the table for the - // specified Region. For a multi-Region table in provisioned capacity mode, you can - // configure the table's read capacity differently for each Region's replica. The - // write capacity, however, remains synchronized between all replicas to ensure - // that there's enough capacity to replicate writes across all Regions. To define - // the read capacity for a table replica in a specific Region, you can do so by - // configuring the following parameters. + // specified Region. + // + // For a multi-Region table in provisioned capacity mode, you can configure the + // table's read capacity differently for each Region's replica. The write capacity, + // however, remains synchronized between all replicas to ensure that there's enough + // capacity to replicate writes across all Regions. To define the read capacity for + // a table replica in a specific Region, you can do so by configuring the following + // parameters. + // // - region : The Region where these settings are applied. (Required) + // // - readCapacityUnits : The provisioned read capacity units. (Optional) + // // - readCapacityAutoScaling : The read capacity auto scaling settings for the // table. (Optional) ReplicaSpecifications []types.ReplicaSpecification - // 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) - // in the Amazon Keyspaces Developer Guide. + // 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] in the Amazon Keyspaces Developer Guide. + // + // [Adding tags and labels to Amazon Keyspaces resources]: https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html 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. + // the table. + // + // For more information, see [Expiring data by using Amazon Keyspaces Time to Live (TTL)] in the Amazon Keyspaces Developer Guide. + // + // [Expiring data by using Amazon Keyspaces Time to Live (TTL)]: https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html Ttl *types.TimeToLive noSmithyDocumentSerde diff --git a/service/keyspaces/api_op_GetKeyspace.go b/service/keyspaces/api_op_GetKeyspace.go index 01465b66006..18191f67ec9 100644 --- a/service/keyspaces/api_op_GetKeyspace.go +++ b/service/keyspaces/api_op_GetKeyspace.go @@ -44,7 +44,7 @@ type GetKeyspaceOutput struct { // This member is required. KeyspaceName *string - // Returns the replication strategy of the keyspace. The options are SINGLE_REGION + // Returns the replication strategy of the keyspace. The options are SINGLE_REGION // or MULTI_REGION . // // This member is required. @@ -55,7 +55,7 @@ type GetKeyspaceOutput struct { // This member is required. ResourceArn *string - // If the replicationStrategy of the keyspace is MULTI_REGION , a list of + // If the replicationStrategy of the keyspace is MULTI_REGION , a list of // replication Regions is returned. ReplicationRegions []string diff --git a/service/keyspaces/api_op_GetTable.go b/service/keyspaces/api_op_GetTable.go index 1d3a6b748a8..80339208b11 100644 --- a/service/keyspaces/api_op_GetTable.go +++ b/service/keyspaces/api_op_GetTable.go @@ -13,9 +13,10 @@ 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 -// tables are required to complete the operation. +// status, the keyspace name, configuration settings, and metadata. +// +// To read table 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 { params = &GetTableInput{} @@ -64,11 +65,13 @@ type GetTableOutput struct { TableName *string // The read/write throughput capacity mode for a table. The options are: + // // - throughputMode:PAY_PER_REQUEST + // // - throughputMode:PROVISIONED CapacitySpecification *types.CapacitySpecificationSummary - // The client-side timestamps setting of the table. + // The client-side timestamps setting of the table. ClientSideTimestamps *types.ClientSideTimestamps // The the description of the specified table. diff --git a/service/keyspaces/api_op_GetTableAutoScalingSettings.go b/service/keyspaces/api_op_GetTableAutoScalingSettings.go index 711c262e1d3..18389b2fc32 100644 --- a/service/keyspaces/api_op_GetTableAutoScalingSettings.go +++ b/service/keyspaces/api_op_GetTableAutoScalingSettings.go @@ -13,17 +13,23 @@ import ( // Returns auto scaling related settings of the specified table in JSON format. If // the table is a multi-Region table, the Amazon Web Services Region specific auto -// scaling settings of the table are included. Amazon Keyspaces auto scaling helps -// you provision throughput capacity for variable workloads efficiently by -// increasing and decreasing your table's read and write capacity automatically in -// response to application traffic. For more information, see Managing throughput -// capacity automatically with Amazon Keyspaces auto scaling (https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html) -// in the Amazon Keyspaces Developer Guide. GetTableAutoScalingSettings can't be -// used as an action in an IAM policy. To define permissions for -// GetTableAutoScalingSettings , you must allow the following two actions in the -// IAM policy statement's Action element: +// scaling settings of the table are included. +// +// Amazon Keyspaces auto scaling helps you provision throughput capacity for +// variable workloads efficiently by increasing and decreasing your table's read +// and write capacity automatically in response to application traffic. For more +// information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]in the Amazon Keyspaces Developer Guide. +// +// GetTableAutoScalingSettings can't be used as an action in an IAM policy. +// +// To define permissions for GetTableAutoScalingSettings , you must allow the +// following two actions in the IAM policy statement's Action element: +// // - application-autoscaling:DescribeScalableTargets +// // - application-autoscaling:DescribeScalingPolicies +// +// [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]: https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html func (c *Client) GetTableAutoScalingSettings(ctx context.Context, params *GetTableAutoScalingSettingsInput, optFns ...func(*Options)) (*GetTableAutoScalingSettingsOutput, error) { if params == nil { params = &GetTableAutoScalingSettingsInput{} diff --git a/service/keyspaces/api_op_RestoreTable.go b/service/keyspaces/api_op_RestoreTable.go index a4eeacfc39b..7f7d366abba 100644 --- a/service/keyspaces/api_op_RestoreTable.go +++ b/service/keyspaces/api_op_RestoreTable.go @@ -14,30 +14,46 @@ import ( // Restores the 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) -// 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 +// restore points, see [Time window for PITR continuous backups]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, auto scaling settings, encryption settings, 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: +// 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, auto scaling settings, encryption settings, 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 units +// // - Auto scaling 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) -// in the Amazon Keyspaces Developer Guide. Note that the following settings are -// not restored, and you must configure them manually for the new table: +// For more information, see [PITR restore 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: +// // - Identity and Access Management (IAM) policies +// // - Amazon CloudWatch metrics and alarms +// +// [PITR restore settings]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_settings +// [Time window for PITR continuous backups]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window func (c *Client) RestoreTable(ctx context.Context, params *RestoreTableInput, optFns ...func(*Options)) (*RestoreTableOutput, error) { if params == nil { params = &RestoreTableInput{} @@ -80,40 +96,57 @@ type RestoreTableInput struct { // provisioned table automatically on your behalf. Amazon Keyspaces auto scaling // helps you provision throughput capacity for variable workloads efficiently by // increasing and decreasing your table's read and write capacity automatically in - // response to application traffic. For more information, see Managing throughput - // capacity automatically with Amazon Keyspaces auto scaling (https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html) - // in the Amazon Keyspaces Developer Guide. + // response to application traffic. + // + // For more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling] in the Amazon Keyspaces Developer Guide. + // + // [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]: https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html AutoScalingSpecification *types.AutoScalingSpecification // 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) - // in the Amazon Keyspaces Developer Guide. + // + // The default is throughput_mode:PAY_PER_REQUEST . + // + // For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. + // + // [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html 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. + // + // The default is type:AWS_OWNED_KMS_KEY . + // + // For more information, see [Encryption at rest] in the Amazon Keyspaces Developer Guide. + // + // [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html 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) - // in the Amazon Keyspaces Developer Guide. + // + // If it's not specified, the default is status=DISABLED . + // + // For more information, see [Point-in-time recovery] in the Amazon Keyspaces Developer Guide. + // + // [Point-in-time recovery]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html PointInTimeRecoveryOverride *types.PointInTimeRecovery // The optional Region specific settings of a multi-Regional table. @@ -122,9 +155,11 @@ type RestoreTableInput struct { // The restore timestamp in ISO 8601 format. 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) - // in the Amazon Keyspaces Developer Guide. + // 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] in the Amazon Keyspaces Developer Guide. + // + // [Adding tags and labels to Amazon Keyspaces resources]: https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html TagsOverride []types.Tag noSmithyDocumentSerde diff --git a/service/keyspaces/api_op_TagResource.go b/service/keyspaces/api_op_TagResource.go index c50f6a10e63..eff44945355 100644 --- a/service/keyspaces/api_op_TagResource.go +++ b/service/keyspaces/api_op_TagResource.go @@ -13,12 +13,14 @@ import ( // 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.html#security_iam_id-based-policy-examples-tags) -// in the Amazon Keyspaces Developer Guide. +// Console for cost allocation tracking. For more information, see [Adding tags and labels to Amazon Keyspaces resources]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]in the Amazon Keyspaces Developer Guide. +// +// [Amazon Keyspaces resource access based on tags]: https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-tags +// [Adding tags and labels to Amazon Keyspaces resources]: https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/keyspaces/api_op_UpdateTable.go b/service/keyspaces/api_op_UpdateTable.go index 554a04c6abe..e93780819fb 100644 --- a/service/keyspaces/api_op_UpdateTable.go +++ b/service/keyspaces/api_op_UpdateTable.go @@ -43,9 +43,13 @@ 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. + // + // - type - An Amazon Keyspaces data type. For more information, see [Data types]in the + // Amazon Keyspaces Developer Guide. + // + // [Data types]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types AddColumns []types.ColumnDefinition // The optional auto scaling settings to update for a table in provisioned @@ -53,64 +57,92 @@ type UpdateTableInput struct { // provisioned table automatically on your behalf. Amazon Keyspaces auto scaling // helps you provision throughput capacity for variable workloads efficiently by // increasing and decreasing your table's read and write capacity automatically in - // response to application traffic. If auto scaling is already enabled for the - // table, you can use UpdateTable to update the minimum and maximum values or the - // auto scaling policy settings independently. For more information, see Managing - // throughput capacity automatically with Amazon Keyspaces auto scaling (https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html) - // in the Amazon Keyspaces Developer Guide. + // response to application traffic. + // + // If auto scaling is already enabled for the table, you can use UpdateTable to + // update the minimum and maximum values or the auto scaling policy settings + // independently. + // + // For more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling] in the Amazon Keyspaces Developer Guide. + // + // [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]: https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html AutoScalingSpecification *types.AutoScalingSpecification - // Modifies the read/write throughput capacity mode for the table. The options - // are: + // 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) - // in the Amazon Keyspaces Developer Guide. + // + // The default is throughput_mode:PAY_PER_REQUEST . + // + // For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. + // + // [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html 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. 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) - // in the Amazon Keyspaces Developer Guide. + // The default Time to Live setting in seconds for the table. + // + // For more information, see [Setting the default TTL value for a table] in the Amazon Keyspaces Developer Guide. + // + // [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 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. + // + // The default is AWS_OWNED_KMS_KEY . + // + // For more information, see [Encryption at rest] in the Amazon Keyspaces Developer Guide. + // + // [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html 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) - // in the Amazon Keyspaces Developer Guide. + // + // If it's not specified, the default is status=DISABLED . + // + // For more information, see [Point-in-time recovery] in the Amazon Keyspaces Developer Guide. + // + // [Point-in-time recovery]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html PointInTimeRecovery *types.PointInTimeRecovery // The Region specific settings of a multi-Regional table. ReplicaSpecifications []types.ReplicaSpecification // 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. + // the table. + // + // For more information, see [Expiring data by using Amazon Keyspaces Time to Live (TTL)] in the Amazon Keyspaces Developer Guide. + // + // [Expiring data by using Amazon Keyspaces Time to Live (TTL)]: https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html Ttl *types.TimeToLive noSmithyDocumentSerde diff --git a/service/keyspaces/doc.go b/service/keyspaces/doc.go index af4873424f5..7d29aad6820 100644 --- a/service/keyspaces/doc.go +++ b/service/keyspaces/doc.go @@ -8,19 +8,26 @@ // easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services // Cloud. With just a few clicks on the Amazon Web Services Management Console or a // few lines of code, you can create keyspaces and tables in Amazon Keyspaces, -// without deploying any infrastructure or installing software. In addition to -// supporting Cassandra Query Language (CQL) requests via open-source Cassandra -// drivers, Amazon Keyspaces supports data definition language (DDL) operations to -// manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well -// 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) -// 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. +// without deploying any infrastructure or installing software. +// +// In addition to supporting Cassandra Query Language (CQL) requests via +// open-source Cassandra drivers, Amazon Keyspaces supports data definition +// language (DDL) operations to manage keyspaces and tables using the Amazon Web +// Services SDK and CLI, as well 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] in the Amazon Keyspaces Developer +// Guide. +// +// To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see [Amazon Keyspaces information 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]in +// the General Reference. +// +// [Supported Cassandra APIs, operations, and data types in Amazon Keyspaces]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html +// [Amazon Web Services APIs]: https://docs.aws.amazon.com/general/latest/gr/aws-apis.html +// [Amazon Keyspaces information in CloudTrail]: https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail package keyspaces diff --git a/service/keyspaces/options.go b/service/keyspaces/options.go index 1cf9545f6fe..5b206b7b394 100644 --- a/service/keyspaces/options.go +++ b/service/keyspaces/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/keyspaces/types/enums.go b/service/keyspaces/types/enums.go index 141053405b5..300e2d7fbd5 100644 --- a/service/keyspaces/types/enums.go +++ b/service/keyspaces/types/enums.go @@ -11,6 +11,7 @@ const ( // Values returns all known values for ClientSideTimestampsStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ClientSideTimestampsStatus) Values() []ClientSideTimestampsStatus { return []ClientSideTimestampsStatus{ @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "CUSTOMER_MANAGED_KMS_KEY", @@ -46,6 +48,7 @@ const ( // Values returns all known values for PointInTimeRecoveryStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PointInTimeRecoveryStatus) Values() []PointInTimeRecoveryStatus { return []PointInTimeRecoveryStatus{ @@ -63,8 +66,9 @@ const ( ) // Values returns all known values for Rs. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Rs) Values() []Rs { return []Rs{ "SINGLE_REGION", @@ -81,8 +85,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -104,8 +109,9 @@ const ( ) // Values returns all known values for TableStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableStatus) Values() []TableStatus { return []TableStatus{ "ACTIVE", @@ -127,8 +133,9 @@ const ( ) // Values returns all known values for ThroughputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThroughputMode) Values() []ThroughputMode { return []ThroughputMode{ "PAY_PER_REQUEST", @@ -144,8 +151,9 @@ const ( ) // Values returns all known values for TimeToLiveStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeToLiveStatus) Values() []TimeToLiveStatus { return []TimeToLiveStatus{ "ENABLED", diff --git a/service/keyspaces/types/errors.go b/service/keyspaces/types/errors.go index d57d8840ef7..eb367db734a 100644 --- a/service/keyspaces/types/errors.go +++ b/service/keyspaces/types/errors.go @@ -118,8 +118,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. +// information on service quotas, see [Quotas]in the Amazon Keyspaces Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/keyspaces/types/types.go b/service/keyspaces/types/types.go index 0fb46db062f..1c7607899b6 100644 --- a/service/keyspaces/types/types.go +++ b/service/keyspaces/types/types.go @@ -22,38 +22,49 @@ type AutoScalingPolicy struct { } // The optional auto scaling settings for a table with provisioned throughput -// capacity. To turn on auto scaling for a table in throughputMode:PROVISIONED , -// you must specify the following parameters. Configure the minimum and maximum -// capacity units. The auto scaling policy ensures that capacity never goes below -// the minimum or above the maximum range. +// capacity. +// +// To turn on auto scaling for a table in throughputMode:PROVISIONED , you must +// specify the following parameters. +// +// Configure the minimum and maximum capacity units. The auto scaling policy +// ensures that capacity never goes below the minimum or above the maximum range. +// // - minimumUnits : The minimum level of throughput the table should always be // ready to support. The value must be between 1 and the max throughput per second // quota for your account (40,000 by default). +// // - maximumUnits : The maximum level of throughput the table should always be // ready to support. The value must be between 1 and the max throughput per second // quota for your account (40,000 by default). +// // - scalingPolicy : Amazon Keyspaces supports the target tracking scaling // policy. The auto scaling target is the provisioned capacity of the table. +// // - targetTrackingScalingPolicyConfiguration : To define the target tracking // policy, you must define the target value. +// // - targetValue : The target utilization rate of the table. Amazon Keyspaces // auto scaling ensures that the ratio of consumed capacity to provisioned capacity // stays at or near this value. You define targetValue as a percentage. A double // between 20 and 90. (Required) +// // - disableScaleIn : A boolean that specifies if scale-in is disabled or enabled // for the table. This parameter is disabled by default. To turn on scale-in , // set the boolean value to FALSE . This means that capacity for a table can be // automatically scaled down on your behalf. (Optional) +// // - scaleInCooldown : A cooldown period in seconds between scaling activities // that lets the table stabilize before another scale in activity starts. If no // value is provided, the default is 0. (Optional) +// // - scaleOutCooldown : A cooldown period in seconds between scaling activities // that lets the table stabilize before another scale out activity starts. If no // value is provided, the default is 0. (Optional) // -// For more information, see Managing throughput capacity automatically with -// Amazon Keyspaces auto scaling (https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html) -// in the Amazon Keyspaces Developer Guide. +// For more information, see [Managing throughput capacity automatically with Amazon Keyspaces auto scaling] in the Amazon Keyspaces Developer Guide. +// +// [Managing throughput capacity automatically with Amazon Keyspaces auto scaling]: https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html type AutoScalingSettings struct { // This optional parameter enables auto scaling for the table if set to false . @@ -93,22 +104,31 @@ type AutoScalingSpecification struct { // Amazon Keyspaces has two read/write capacity modes for processing reads and // writes on your tables: +// // - 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) -// in the Amazon Keyspaces Developer Guide. +// read and write throughput and how table throughput capacity is managed. +// +// For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. +// +// [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html 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) - // in the Amazon Keyspaces Developer Guide. + // + // The default is throughput_mode:PAY_PER_REQUEST . + // + // For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. + // + // [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html // // This member is required. ThroughputMode ThroughputMode @@ -125,20 +145,28 @@ type CapacitySpecification struct { } // The read/write throughput capacity mode for a table. The options are: +// // - 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) -// in the Amazon Keyspaces Developer Guide. +// For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. +// +// [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html 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) - // in the Amazon Keyspaces Developer Guide. + // + // The default is throughput_mode:PAY_PER_REQUEST . + // + // For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. + // + // [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html // // This member is required. ThroughputMode ThroughputMode @@ -158,9 +186,11 @@ type CapacitySpecificationSummary struct { 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) -// in the Amazon Keyspaces Developer Guide. +// The client-side timestamp setting of the table. +// +// For more information, see [How it works: Amazon Keyspaces client-side timestamps] in the Amazon Keyspaces Developer Guide. +// +// [How it works: Amazon Keyspaces client-side timestamps]: https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html type ClientSideTimestamps struct { // Shows how to enable client-side timestamps settings for the specified table. @@ -196,8 +226,10 @@ 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) - // in the Amazon Keyspaces Developer Guide. + // The data type of the column. For a list of available data types, see [Data types] in the + // Amazon Keyspaces Developer Guide. + // + // [Data types]: https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types // // This member is required. Type *string @@ -219,29 +251,39 @@ 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). // -// 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] in the +// Amazon Keyspaces Developer Guide. +// +// For more information about KMS, see [KMS management service concepts] in the Key Management Service Developer +// Guide. +// +// [KMS management service concepts]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html +// [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html 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. + // + // The default is type:AWS_OWNED_KMS_KEY . + // + // For more information, see [Encryption at rest] in the Amazon Keyspaces Developer Guide. + // + // [Encryption at rest]: https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html // // This member is required. Type EncryptionType @@ -261,7 +303,7 @@ type KeyspaceSummary struct { // This member is required. KeyspaceName *string - // This property specifies if a keyspace is a single Region keyspace or a + // This property specifies if a keyspace is a single Region keyspace or a // multi-Region keyspace. The available values are SINGLE_REGION or MULTI_REGION . // // This member is required. @@ -273,7 +315,7 @@ type KeyspaceSummary struct { // This member is required. ResourceArn *string - // If the replicationStrategy of the keyspace is MULTI_REGION , a list of + // If the replicationStrategy of the keyspace is MULTI_REGION , a list of // replication Regions is returned. ReplicationRegions []string @@ -295,12 +337,17 @@ 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) -// in the Amazon Keyspaces Developer Guide. +// your table data. +// +// For more information, see [Point-in-time recovery] in the Amazon Keyspaces Developer Guide. +// +// [Point-in-time recovery]: https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html type PointInTimeRecovery struct { // The options are: + // // - status=ENABLED + // // - status=DISABLED // // This member is required. @@ -337,12 +384,16 @@ type ReplicaAutoScalingSpecification struct { noSmithyDocumentSerde } -// The Amazon Web Services Region specific settings of a multi-Region table. For a -// multi-Region table, you can configure the table's read capacity differently per -// Amazon Web Services Region. You can do this by configuring the following -// parameters. +// The Amazon Web Services Region specific settings of a multi-Region table. +// +// For a multi-Region table, you can configure the table's read capacity +// differently per Amazon Web Services Region. You can do this by configuring the +// following parameters. +// // - region : The Region where these settings are applied. (Required) +// // - readCapacityUnits : The provisioned read capacity units. (Optional) +// // - readCapacityAutoScaling : The read capacity auto scaling settings for the // table. (Optional) type ReplicaSpecification struct { @@ -364,20 +415,26 @@ type ReplicaSpecification struct { } // The Region-specific settings of a multi-Region table in the specified Amazon -// Web Services Region. If the multi-Region table is using provisioned capacity and -// has optional auto scaling policies configured, note that the Region specific -// summary returns both read and write capacity settings. But only Region specific -// read capacity settings can be configured for a multi-Region table. In a -// multi-Region table, your write capacity units will be synced across all Amazon -// Web Services Regions to ensure that there is enough capacity to replicate write -// events across Regions. +// Web Services Region. +// +// If the multi-Region table is using provisioned capacity and has optional auto +// scaling policies configured, note that the Region specific summary returns both +// read and write capacity settings. But only Region specific read capacity +// settings can be configured for a multi-Region table. In a multi-Region table, +// your write capacity units will be synced across all Amazon Web Services Regions +// to ensure that there is enough capacity to replicate write events across +// Regions. type ReplicaSpecificationSummary struct { // The read/write throughput capacity mode for a table. The options are: + // // - 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) - // in the Amazon Keyspaces Developer Guide. + // + // For more information, see [Read/write capacity modes] in the Amazon Keyspaces Developer Guide. + // + // [Read/write capacity modes]: https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html CapacitySpecification *CapacitySpecificationSummary // The Amazon Web Services Region. @@ -391,18 +448,20 @@ type ReplicaSpecificationSummary struct { } // The replication specification of the keyspace includes: +// // - regionList - up to six Amazon Web Services Regions where the keyspace is // replicated in. +// // - replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION . type ReplicationSpecification struct { - // The replicationStrategy of a keyspace, the required value is SINGLE_REGION or + // The replicationStrategy of a keyspace, the required value is SINGLE_REGION or // MULTI_REGION . // // This member is required. ReplicationStrategy Rs - // The regionList can contain up to six Amazon Web Services Regions where the + // The regionList can contain up to six Amazon Web Services Regions where the // keyspace is replicated in. RegionList []string @@ -468,13 +527,17 @@ 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) -// in the Amazon Keyspaces Developer Guide. +// 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] in the Amazon Keyspaces Developer Guide. +// +// [Adding tags and labels to Amazon Keyspaces resources]: https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html type Tag struct { // The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource @@ -496,38 +559,45 @@ type Tag struct { // provisioned capacity. type TargetTrackingScalingPolicyConfiguration struct { - // Specifies the target value for the target tracking auto scaling policy. Amazon - // Keyspaces auto scaling scales up capacity automatically when traffic exceeds - // this target utilization rate, and then back down when it falls below the target. - // This ensures that the ratio of consumed capacity to provisioned capacity stays - // at or near this value. You define targetValue as a percentage. A double between - // 20 and 90. + // Specifies the target value for the target tracking auto scaling policy. + // + // Amazon Keyspaces auto scaling scales up capacity automatically when traffic + // exceeds this target utilization rate, and then back down when it falls below the + // target. This ensures that the ratio of consumed capacity to provisioned capacity + // stays at or near this value. You define targetValue as a percentage. A double + // between 20 and 90. // // This member is required. TargetValue float64 - // Specifies if scale-in is enabled. When auto scaling automatically decreases - // capacity for a table, the table scales in. When scaling policies are set, they - // can't scale in the table lower than its minimum capacity. + // Specifies if scale-in is enabled. + // + // When auto scaling automatically decreases capacity for a table, the table + // scales in. When scaling policies are set, they can't scale in the table lower + // than its minimum capacity. DisableScaleIn bool - // Specifies a scale-in cool down period. A cooldown period in seconds between - // scaling activities that lets the table stabilize before another scaling activity - // starts. + // Specifies a scale-in cool down period. + // + // A cooldown period in seconds between scaling activities that lets the table + // stabilize before another scaling activity starts. ScaleInCooldown int32 - // Specifies a scale out cool down period. A cooldown period in seconds between - // scaling activities that lets the table stabilize before another scaling activity - // starts. + // Specifies a scale out cool down period. + // + // A cooldown period in seconds between scaling activities that lets the table + // stabilize before another scaling activity starts. ScaleOutCooldown int32 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) -// in the Amazon Keyspaces Developer Guide. +// a TTL default for the specified table. +// +// For more information, see [Enabling TTL on tables] in the Amazon Keyspaces Developer Guide. +// +// [Enabling TTL on tables]: https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling type TimeToLive struct { // Shows how to enable custom Time to Live (TTL) settings for the specified table. diff --git a/service/kinesis/api_op_AddTagsToStream.go b/service/kinesis/api_op_AddTagsToStream.go index 2f8dd23838f..15f3a45b8f4 100644 --- a/service/kinesis/api_op_AddTagsToStream.go +++ b/service/kinesis/api_op_AddTagsToStream.go @@ -12,12 +12,16 @@ import ( ) // 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, you must use either the -// StreamARN or the StreamName parameter, or both. It is recommended that you use -// the StreamARN input parameter when you invoke this API. 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. +// to 50 tags to a data stream. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// If tags have already been assigned to the stream, AddTagsToStream overwrites +// any existing tags that correspond to the specified tag keys. +// +// AddTagsToStreamhas a limit of five transactions per second per account. func (c *Client) AddTagsToStream(ctx context.Context, params *AddTagsToStreamInput, optFns ...func(*Options)) (*AddTagsToStreamOutput, error) { if params == nil { params = &AddTagsToStreamInput{} diff --git a/service/kinesis/api_op_CreateStream.go b/service/kinesis/api_op_CreateStream.go index 4ab7fa0787e..7a3645dcf1d 100644 --- a/service/kinesis/api_op_CreateStream.go +++ b/service/kinesis/api_op_CreateStream.go @@ -14,37 +14,47 @@ import ( // Creates a Kinesis data stream. A stream captures and transports data records // that are continuously emitted from different data sources or producers. // Scale-out within a stream is explicitly supported by means of shards, which are -// uniquely identified groups of data records in a stream. You can create your data -// stream using either on-demand or provisioned capacity mode. Data streams with an -// on-demand mode require no capacity planning and automatically scale to handle -// gigabytes of write and read throughput per minute. With the on-demand mode, -// Kinesis Data Streams automatically manages the shards in order to provide the -// necessary throughput. For the data streams with a provisioned mode, you must -// specify the number of shards for the data stream. Each shard can support reads -// up to five transactions per second, up to a maximum data read total of 2 MiB per -// second. Each shard can support writes up to 1,000 records per second, up to a -// maximum data write total of 1 MiB per second. If the amount of data input -// increases or decreases, you can add or remove shards. The stream name identifies -// the stream. The name is scoped to the Amazon Web Services account used by the -// application. It is also scoped by Amazon Web Services Region. That is, two -// 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 . -// 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: +// uniquely identified groups of data records in a stream. +// +// You can create your data stream using either on-demand or provisioned capacity +// mode. Data streams with an on-demand mode require no capacity planning and +// automatically scale to handle gigabytes of write and read throughput per minute. +// With the on-demand mode, Kinesis Data Streams automatically manages the shards +// in order to provide the necessary throughput. For the data streams with a +// provisioned mode, you must specify the number of shards for the data stream. +// Each shard can support reads up to five transactions per second, up to a maximum +// data read total of 2 MiB per second. Each shard can support writes up to 1,000 +// records per second, up to a maximum data write total of 1 MiB per second. If the +// amount of data input increases or decreases, you can add or remove shards. +// +// The stream name identifies the stream. The name is scoped to the Amazon Web +// Services account used by the application. It is also scoped by Amazon Web +// Services Region. That is, two 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 . 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: +// // - 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) -// 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. +// For the default shard limit for an Amazon Web Services account, see [Amazon Kinesis Data Streams Limits] in the +// Amazon Kinesis Data Streams Developer Guide. To increase this limit, [contact Amazon Web Services Support]. +// +// You can use DescribeStreamSummary to check the stream status, which is returned in StreamStatus . +// +// CreateStreamhas 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 +// [Amazon Kinesis Data Streams Limits]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error) { if params == nil { params = &CreateStreamInput{} @@ -78,7 +88,7 @@ type CreateStreamInput struct { // provisioned throughput. ShardCount *int32 - // Indicates the capacity mode of the data stream. Currently, in Kinesis Data + // Indicates the capacity mode of the data stream. Currently, in Kinesis Data // Streams, you can choose between an on-demand capacity mode and a provisioned // capacity mode for your data streams. StreamModeDetails *types.StreamModeDetails diff --git a/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go b/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go index 79eabcc451c..a8124434ed8 100644 --- a/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go +++ b/service/kinesis/api_op_DecreaseStreamRetentionPeriod.go @@ -13,12 +13,15 @@ import ( // Decreases the Kinesis data stream's retention period, which is the length of // time data records are accessible after they are added to the stream. The minimum -// value of a stream's retention period is 24 hours. When invoking this API, you -// must use either the StreamARN or the StreamName parameter, or both. It is -// recommended that you use the StreamARN input parameter when you invoke this -// API. This operation may result in lost data. For example, if the stream's -// retention period is 48 hours and is decreased to 24 hours, any data already in -// the stream that is older than 24 hours is inaccessible. +// value of a stream's retention period is 24 hours. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// This operation may result in lost data. For example, if the stream's retention +// period is 48 hours and is decreased to 24 hours, any data already in the stream +// that is older than 24 hours is inaccessible. func (c *Client) DecreaseStreamRetentionPeriod(ctx context.Context, params *DecreaseStreamRetentionPeriodInput, optFns ...func(*Options)) (*DecreaseStreamRetentionPeriodOutput, error) { if params == nil { params = &DecreaseStreamRetentionPeriodInput{} @@ -34,7 +37,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_DeleteResourcePolicy.go b/service/kinesis/api_op_DeleteResourcePolicy.go index 8109cdb53b6..79892b355b4 100644 --- a/service/kinesis/api_op_DeleteResourcePolicy.go +++ b/service/kinesis/api_op_DeleteResourcePolicy.go @@ -13,7 +13,9 @@ import ( // Delete a policy for the specified data stream or consumer. Request patterns can // be one of the following: +// // - Data stream pattern: arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+ +// // - Consumer pattern: // ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+ func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { diff --git a/service/kinesis/api_op_DeleteStream.go b/service/kinesis/api_op_DeleteStream.go index b672f1eb764..ffbee67cc93 100644 --- a/service/kinesis/api_op_DeleteStream.go +++ b/service/kinesis/api_op_DeleteStream.go @@ -14,18 +14,27 @@ 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, you must use -// either the StreamARN or the StreamName parameter, or both. It is recommended -// that you use the StreamARN input parameter when you invoke this API. 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 DescribeStreamSummary operation to -// check the state of the stream, which is returned in StreamStatus . DeleteStream -// has a limit of five transactions per second per account. +// exception ResourceNotFoundException . +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// 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 DescribeStreamSummary operation to check the state of the stream, which is returned +// in StreamStatus . +// +// DeleteStreamhas 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 { params = &DeleteStreamInput{} @@ -41,7 +50,7 @@ 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 diff --git a/service/kinesis/api_op_DeregisterStreamConsumer.go b/service/kinesis/api_op_DeregisterStreamConsumer.go index 6f20829f1e9..52283c63604 100644 --- a/service/kinesis/api_op_DeregisterStreamConsumer.go +++ b/service/kinesis/api_op_DeregisterStreamConsumer.go @@ -15,10 +15,11 @@ import ( // ARN of the data stream and the name you gave the consumer when you registered // it. You may also provide all three parameters, as long as they don't conflict // with each other. If you don't know the name or ARN of the consumer that you want -// to deregister, you can use the ListStreamConsumers operation to get a list of -// the descriptions of all the consumers that are currently registered with a given -// data stream. The description of a consumer contains its name and ARN. This -// operation has a limit of five transactions per second per stream. +// to deregister, you can use the ListStreamConsumersoperation to get a list of the descriptions of +// all the consumers that are currently registered with a given data stream. The +// description of a consumer contains its name and ARN. +// +// This operation has a limit of five transactions per second per stream. func (c *Client) DeregisterStreamConsumer(ctx context.Context, params *DeregisterStreamConsumerInput, optFns ...func(*Options)) (*DeregisterStreamConsumerOutput, error) { if params == nil { params = &DeregisterStreamConsumerInput{} @@ -47,9 +48,9 @@ type DeregisterStreamConsumerInput struct { ConsumerName *string // 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) - // . + // more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 StreamARN *string noSmithyDocumentSerde diff --git a/service/kinesis/api_op_DescribeLimits.go b/service/kinesis/api_op_DescribeLimits.go index 3e2d9485c68..a82b86e3fcd 100644 --- a/service/kinesis/api_op_DescribeLimits.go +++ b/service/kinesis/api_op_DescribeLimits.go @@ -10,9 +10,12 @@ 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{} @@ -34,12 +37,12 @@ type DescribeLimitsInput struct { type DescribeLimitsOutput struct { - // Indicates the number of data streams with the on-demand capacity mode. + // Indicates the number of data streams with the on-demand capacity mode. // // This member is required. OnDemandStreamCount *int32 - // The maximum number of data streams with the on-demand capacity mode. + // The maximum number of data streams with the on-demand capacity mode. // // This member is required. OnDemandStreamCountLimit *int32 diff --git a/service/kinesis/api_op_DescribeStream.go b/service/kinesis/api_op_DescribeStream.go index 7b0817028b7..cd7f58c294c 100644 --- a/service/kinesis/api_op_DescribeStream.go +++ b/service/kinesis/api_op_DescribeStream.go @@ -17,26 +17,35 @@ import ( "time" ) -// Describes the specified Kinesis data stream. This API has been revised. It's -// highly recommended that you use the DescribeStreamSummary API to get a -// summarized description of the specified Kinesis data stream and the ListShards -// API to list the shards in a specified data stream and obtain information about -// each shard. When invoking this API, you must use either the StreamARN or the -// StreamName parameter, or both. It is recommended that you use the StreamARN -// input parameter when you invoke this API. The information returned includes the -// stream name, Amazon Resource Name (ARN), creation time, enhanced metric -// configuration, and shard map. The shard map is an array of shard objects. For -// each shard object, there is the hash key and sequence number ranges that the -// shard spans, and the IDs of any earlier shards that played in a role in 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) -// 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 -// oldest shard. This operation has a limit of 10 transactions per second per -// account. +// Describes the specified Kinesis data stream. +// +// This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get +// a summarized description of the specified Kinesis data stream and the ListShardsAPI to +// list the shards in a specified data stream and obtain information about each +// shard. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// The information returned includes the stream name, Amazon Resource Name (ARN), +// creation time, enhanced metric configuration, and shard map. The shard map is an +// array of shard objects. For each shard object, there is the hash key and +// sequence number ranges that the shard spans, and the IDs of any earlier shards +// that played in a role in 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]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 oldest shard. +// +// This operation has a limit of 10 transactions per second per account. +// +// [Retrieving Shards from a Stream]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error) { if params == nil { params = &DescribeStreamInput{} @@ -55,11 +64,13 @@ func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput // 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 @@ -212,12 +223,13 @@ type StreamExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStreamInput, *DescribeStreamOutput, error) (bool, error) } @@ -383,12 +395,13 @@ type StreamNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeStreamInput, *DescribeStreamOutput, error) (bool, error) } diff --git a/service/kinesis/api_op_DescribeStreamConsumer.go b/service/kinesis/api_op_DescribeStreamConsumer.go index b5bc8d09f54..7311140eb14 100644 --- a/service/kinesis/api_op_DescribeStreamConsumer.go +++ b/service/kinesis/api_op_DescribeStreamConsumer.go @@ -16,12 +16,14 @@ import ( // consumer. Alternatively, you can provide the ARN of the data stream and the name // you gave the consumer when you registered it. You may also provide all three // parameters, as long as they don't conflict with each other. If you don't know -// the name or ARN of the consumer that you want to describe, you can use the -// ListStreamConsumers operation to get a list of the descriptions of all the -// consumers that are currently registered with a given data stream. This operation -// has a limit of 20 transactions per second per stream. When making a -// cross-account call with DescribeStreamConsumer , make sure to provide the ARN of -// the consumer. +// the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers +// operation to get a list of the descriptions of all the consumers that are +// currently registered with a given data stream. +// +// This operation has a limit of 20 transactions per second per stream. +// +// When making a cross-account call with DescribeStreamConsumer , make sure to +// provide the ARN of the consumer. func (c *Client) DescribeStreamConsumer(ctx context.Context, params *DescribeStreamConsumerInput, optFns ...func(*Options)) (*DescribeStreamConsumerOutput, error) { if params == nil { params = &DescribeStreamConsumerInput{} @@ -46,9 +48,9 @@ type DescribeStreamConsumerInput struct { ConsumerName *string // 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) - // . + // more information, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 StreamARN *string noSmithyDocumentSerde diff --git a/service/kinesis/api_op_DescribeStreamSummary.go b/service/kinesis/api_op_DescribeStreamSummary.go index 76e93fb4ce6..af55cab40df 100644 --- a/service/kinesis/api_op_DescribeStreamSummary.go +++ b/service/kinesis/api_op_DescribeStreamSummary.go @@ -13,12 +13,17 @@ import ( ) // Provides a summarized description of the specified Kinesis data stream without -// the shard list. When invoking this API, you must use either the StreamARN or -// the StreamName parameter, or both. It is recommended that you use the StreamARN -// input parameter when you invoke this API. The information returned includes the -// stream name, Amazon Resource Name (ARN), status, record retention period, -// approximate creation time, monitoring, encryption details, and open shard count. -// DescribeStreamSummary has a limit of 20 transactions per second per account. +// the shard list. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// The information returned includes the stream name, Amazon Resource Name (ARN), +// status, record retention period, approximate creation time, monitoring, +// encryption details, and open shard count. +// +// DescribeStreamSummaryhas a limit of 20 transactions per second per account. func (c *Client) DescribeStreamSummary(ctx context.Context, params *DescribeStreamSummaryInput, optFns ...func(*Options)) (*DescribeStreamSummaryOutput, error) { if params == nil { params = &DescribeStreamSummaryInput{} diff --git a/service/kinesis/api_op_DisableEnhancedMonitoring.go b/service/kinesis/api_op_DisableEnhancedMonitoring.go index 8a78d53ef5a..a2a5a3a3ffb 100644 --- a/service/kinesis/api_op_DisableEnhancedMonitoring.go +++ b/service/kinesis/api_op_DisableEnhancedMonitoring.go @@ -12,9 +12,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables enhanced monitoring. When invoking this API, you must use either the -// StreamARN or the StreamName parameter, or both. It is recommended that you use -// the StreamARN input parameter when you invoke this API. +// Disables enhanced monitoring. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. func (c *Client) DisableEnhancedMonitoring(ctx context.Context, params *DisableEnhancedMonitoringInput, optFns ...func(*Options)) (*DisableEnhancedMonitoringOutput, error) { if params == nil { params = &DisableEnhancedMonitoringInput{} @@ -30,22 +32,33 @@ 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. + // 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) - // in the Amazon Kinesis Data Streams Developer Guide. + // + // For more information, see [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch] in the Amazon Kinesis Data Streams Developer Guide. + // + // [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html // // This member is required. ShardLevelMetrics []types.MetricsName @@ -64,8 +77,7 @@ func (in *DisableEnhancedMonitoringInput) bindEndpointParams(p *EndpointParamete p.OperationType = ptr.String("control") } -// 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 diff --git a/service/kinesis/api_op_EnableEnhancedMonitoring.go b/service/kinesis/api_op_EnableEnhancedMonitoring.go index bd7c977503f..ec59bcf695a 100644 --- a/service/kinesis/api_op_EnableEnhancedMonitoring.go +++ b/service/kinesis/api_op_EnableEnhancedMonitoring.go @@ -12,8 +12,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables enhanced Kinesis data stream monitoring for shard-level metrics. When -// invoking this API, you must use either the StreamARN or the StreamName +// Enables enhanced Kinesis data stream monitoring for shard-level metrics. +// +// When invoking this API, you must use either the StreamARN or the StreamName // parameter, or both. It is recommended that you use the StreamARN input // parameter when you invoke this API. func (c *Client) EnableEnhancedMonitoring(ctx context.Context, params *EnableEnhancedMonitoringInput, optFns ...func(*Options)) (*EnableEnhancedMonitoringOutput, error) { @@ -31,22 +32,33 @@ 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. + // 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) - // in the Amazon Kinesis Data Streams Developer Guide. + // + // For more information, see [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch] in the Amazon Kinesis Data Streams Developer Guide. + // + // [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html // // This member is required. ShardLevelMetrics []types.MetricsName @@ -65,8 +77,7 @@ func (in *EnableEnhancedMonitoringInput) bindEndpointParams(p *EndpointParameter p.OperationType = ptr.String("control") } -// 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 diff --git a/service/kinesis/api_op_GetRecords.go b/service/kinesis/api_op_GetRecords.go index 7cb5599764f..567f4785c38 100644 --- a/service/kinesis/api_op_GetRecords.go +++ b/service/kinesis/api_op_GetRecords.go @@ -14,57 +14,69 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets data records from a Kinesis data stream's shard. When invoking this API, -// you must use either the StreamARN or the StreamName parameter, or both. It is -// recommended that you use the StreamARN input parameter when you invoke this -// API. 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 available in the -// portion of the shard that the iterator points to, GetRecords 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) -// 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 +// Gets data records from a Kinesis data stream's shard. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// 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 available in the portion of the +// shard that the iterator points to, GetRecordsreturns 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]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 GetShardIteratorto 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 -// 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 -// 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 -// can ensure that your calls don't exceed the maximum supported size or throughput -// by using the Limit parameter to specify the maximum number of records that -// GetRecords can return. Consider your average record size when determining this -// limit. The maximum number of records that can be returned per call is 10,000. -// The size of the data returned by GetRecords varies depending on the utilization -// of the shard. It is recommended that consumer applications retrieve records via -// the GetRecords command using the 5 TPS limit to remain caught up. Retrieving -// 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 +// returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been +// closed, the shard iterator can't return more data and GetRecordsreturns 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 can ensure that your calls don't exceed the maximum +// supported size or throughput by using the Limit parameter to specify the +// maximum number of records that GetRecordscan return. Consider your average record size +// when determining this limit. The maximum number of records that can be returned +// per call is 10,000. +// +// The size of the data returned by GetRecords varies depending on the utilization of the +// shard. It is recommended that consumer applications retrieve records via the +// GetRecords command using the 5 TPS limit to remain caught up. Retrieving records +// less frequently can lead to consumer applications falling behind. The maximum +// size of data that GetRecordscan 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 // 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 -// 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 +// 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]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. +// order. +// +// This operation has a limit of five transactions per second per shard. +// +// [Amazon Kinesis Data Streams Limits]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html +// [Monitoring]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html func (c *Client) GetRecords(ctx context.Context, params *GetRecordsInput, optFns ...func(*Options)) (*GetRecordsOutput, error) { if params == nil { params = &GetRecordsInput{} @@ -80,7 +92,7 @@ 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 @@ -91,8 +103,8 @@ type GetRecordsInput struct { 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. + // you specify a value that is greater than 10,000, GetRecordsthrows InvalidArgumentException + // . The default value is 10,000. Limit *int32 // The ARN of the stream. @@ -106,7 +118,7 @@ func (in *GetRecordsInput) bindEndpointParams(p *EndpointParameters) { p.OperationType = ptr.String("data") } -// Represents the output for GetRecords . +// Represents the output for GetRecords. type GetRecordsOutput struct { // The data records retrieved from the shard. @@ -118,8 +130,8 @@ type GetRecordsOutput struct { // response only when the end of the current shard is reached. ChildShards []types.ChildShard - // The number of milliseconds the GetRecords response is from the tip of the - // stream, indicating how far behind current time the consumer is. A value of zero + // The number of milliseconds the GetRecords response is from the tip of the stream, + // indicating how far behind current time the consumer is. A value of zero // indicates that record processing is caught up, and there are no new records to // process at this moment. MillisBehindLatest *int64 diff --git a/service/kinesis/api_op_GetResourcePolicy.go b/service/kinesis/api_op_GetResourcePolicy.go index 88192a4fa6b..ec08eaa443a 100644 --- a/service/kinesis/api_op_GetResourcePolicy.go +++ b/service/kinesis/api_op_GetResourcePolicy.go @@ -13,7 +13,9 @@ import ( // Returns a policy attached to the specified data stream or consumer. Request // patterns can be one of the following: +// // - Data stream pattern: arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+ +// // - Consumer pattern: // ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+ func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) { diff --git a/service/kinesis/api_op_GetShardIterator.go b/service/kinesis/api_op_GetShardIterator.go index d69445cd971..a96fe37a569 100644 --- a/service/kinesis/api_op_GetShardIterator.go +++ b/service/kinesis/api_op_GetShardIterator.go @@ -14,37 +14,45 @@ import ( ) // Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after -// it is returned to the requester. When invoking this API, you must use either the -// StreamARN or the StreamName parameter, or both. It is recommended that you use -// the StreamARN input parameter when you invoke this API. A shard iterator -// specifies the shard position from which to start reading data records -// sequentially. The position is specified using the sequence number of a data -// record in a shard. A sequence number is the identifier associated with every -// record ingested in the stream, and is assigned when a record is put into the -// stream. Each stream has one or more shards. You must specify the shard iterator -// type. For example, you can set the ShardIteratorType parameter to read 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 -// 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 -// GetShardIterator request is made too often, you receive a +// it is returned to the requester. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// A shard iterator specifies the shard position from which to start reading data +// records sequentially. The position is specified using the sequence number of a +// data record in a shard. A sequence number is the identifier associated with +// every record ingested in the stream, and is assigned when a record is put into +// the stream. Each stream has one or more shards. +// +// You must specify the shard iterator type. For example, you can set the +// ShardIteratorType parameter to read 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 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 GetRecordsrequest and for subsequent reads use the shard +// iterator returned by the GetRecordsrequest in NextShardIterator . A new shard iterator is +// returned by every GetRecordsrequest 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) -// 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 . -// GetShardIterator has a limit of five transactions per second per account per -// open shard. +// limits, see GetRecords, and [Streams Limits] 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 SplitShardor MergeShards. +// +// GetShardIteratorhas a limit of five transactions per second per account per open shard. +// +// [Streams Limits]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html func (c *Client) GetShardIterator(ctx context.Context, params *GetShardIteratorInput, optFns ...func(*Options)) (*GetShardIteratorOutput, error) { if params == nil { params = &GetShardIteratorInput{} @@ -69,15 +77,22 @@ type GetShardIteratorInput struct { 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: + // 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. // diff --git a/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go b/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go index 40e8bc66894..3f7148b3c8d 100644 --- a/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go +++ b/service/kinesis/api_op_IncreaseStreamRetentionPeriod.go @@ -13,16 +13,19 @@ import ( // Increases the Kinesis data stream's retention period, which is the length of // time data records are accessible after they are added to the stream. The maximum -// value of a stream's retention period is 8760 hours (365 days). When invoking -// this API, you must use either the StreamARN or the StreamName parameter, or -// both. It is recommended that you use the StreamARN input parameter when you -// invoke this API. If you choose a longer stream retention period, this operation -// increases the time period during which records that have not yet expired are -// accessible. However, it does not make previous, expired data (older than the -// stream's previous retention period) accessible after the operation has been -// called. For example, if a stream's retention period is set to 24 hours and is -// increased to 168 hours, any data that is older than 24 hours remains -// inaccessible to consumer applications. +// value of a stream's retention period is 8760 hours (365 days). +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// If you choose a longer stream retention period, this operation increases the +// time period during which records that have not yet expired are accessible. +// However, it does not make previous, expired data (older than the stream's +// previous retention period) accessible after the operation has been called. For +// example, if a stream's retention period is set to 24 hours and is increased to +// 168 hours, any data that is older than 24 hours remains inaccessible to consumer +// applications. func (c *Client) IncreaseStreamRetentionPeriod(ctx context.Context, params *IncreaseStreamRetentionPeriodInput, optFns ...func(*Options)) (*IncreaseStreamRetentionPeriodOutput, error) { if params == nil { params = &IncreaseStreamRetentionPeriodInput{} @@ -38,7 +41,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 fe0425d7a00..45e73e62971 100644 --- a/service/kinesis/api_op_ListShards.go +++ b/service/kinesis/api_op_ListShards.go @@ -14,18 +14,22 @@ import ( ) // Lists the shards in a stream and provides information about each shard. This -// operation has a limit of 1000 transactions per second per data stream. When -// invoking this API, you must use either the StreamARN or the StreamName +// operation has a limit of 1000 transactions per second per data stream. +// +// When invoking this API, you must use either the StreamARN or the StreamName // parameter, or both. It is recommended that you use the StreamARN input -// parameter when you invoke this API. 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 +// parameter when you invoke this API. +// +// This action does not list expired shards. For information about expired shards, +// see [Data Routing, Data Persistence, and Shard State after a Reshard]. +// +// 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) -// . +// information, see [Controlling Access to Amazon Kinesis Data Streams Resources Using IAM]. +// +// [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 +// [Controlling Access to Amazon Kinesis Data Streams Resources 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{} @@ -44,15 +48,18 @@ 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 - // 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 . + // 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 . ExclusiveStartShardId *string // 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. @@ -63,33 +70,42 @@ type ListShardsInput struct { // 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 // 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 - // 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 , - // you have 300 seconds to use that value. If you specify an expired token in a - // call to ListShards , you get ExpiredNextTokenException . + // 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 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 , you have 300 seconds to use that value. If + // you specify an expired token in a 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. @@ -98,12 +114,14 @@ type ListShardsInput struct { // Specify this input parameter to distinguish data streams that have the same // name. For example, if you create a data stream and then delete it, and you later // create another data stream with the same name, you can use this input parameter - // to specify which of the two streams you want to list the shards for. You cannot - // specify this parameter if you specify the NextToken parameter. + // to specify which of the two streams you want to list the shards for. + // + // You cannot specify this parameter if you specify the NextToken parameter. StreamCreationTimestamp *time.Time - // The name of the data stream whose shards you want to list. You cannot specify - // this parameter if you specify the NextToken parameter. + // The name of the data stream whose shards you want to list. + // + // You cannot specify this parameter if you specify the NextToken parameter. StreamName *string noSmithyDocumentSerde @@ -122,10 +140,12 @@ type ListShardsOutput struct { // 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 diff --git a/service/kinesis/api_op_ListStreamConsumers.go b/service/kinesis/api_op_ListStreamConsumers.go index 0cf8e26b992..66345421021 100644 --- a/service/kinesis/api_op_ListStreamConsumers.go +++ b/service/kinesis/api_op_ListStreamConsumers.go @@ -14,8 +14,9 @@ import ( ) // Lists the consumers registered to receive data from a stream using enhanced -// fan-out, and provides information about each consumer. This operation has a -// limit of 5 transactions per second per stream. +// fan-out, and provides information about each consumer. +// +// This operation has a limit of 5 transactions per second per stream. func (c *Client) ListStreamConsumers(ctx context.Context, params *ListStreamConsumersInput, optFns ...func(*Options)) (*ListStreamConsumersOutput, error) { if params == nil { params = &ListStreamConsumersInput{} @@ -34,9 +35,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]. + // + // [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 @@ -52,24 +53,30 @@ type ListStreamConsumersInput struct { // 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 + // 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 . + // 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 // name. For example, if you create a data stream and then delete it, and you later // create another data stream with the same name, you can use this input parameter - // to specify which of the two streams you want to list the consumers for. You - // can't specify this parameter if you specify the NextToken parameter. + // to specify which of the two streams you want to list the consumers for. + // + // You can't specify this parameter if you specify the NextToken parameter. StreamCreationTimestamp *time.Time noSmithyDocumentSerde @@ -91,11 +98,12 @@ type ListStreamConsumersOutput struct { // 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 . + // 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 . NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/kinesis/api_op_ListStreams.go b/service/kinesis/api_op_ListStreams.go index a596b1e478c..a1d779bc5a2 100644 --- a/service/kinesis/api_op_ListStreams.go +++ b/service/kinesis/api_op_ListStreams.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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. +// 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 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 -// until all the stream names have been collected in the list. ListStreams has a -// limit of five transactions per second per account. +// until all the stream names have been collected in the list. +// +// ListStreamshas a limit of five transactions per second per account. func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error) { if params == nil { params = &ListStreamsInput{} diff --git a/service/kinesis/api_op_ListTagsForStream.go b/service/kinesis/api_op_ListTagsForStream.go index 7e05e760bd4..f85818f3c76 100644 --- a/service/kinesis/api_op_ListTagsForStream.go +++ b/service/kinesis/api_op_ListTagsForStream.go @@ -13,9 +13,11 @@ import ( ) // 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, you -// must use either the StreamARN or the StreamName parameter, or both. It is -// recommended that you use the StreamARN input parameter when you invoke this API. +// limit of five transactions per second per account. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. func (c *Client) ListTagsForStream(ctx context.Context, params *ListTagsForStreamInput, optFns ...func(*Options)) (*ListTagsForStreamOutput, error) { if params == nil { params = &ListTagsForStreamInput{} diff --git a/service/kinesis/api_op_MergeShards.go b/service/kinesis/api_op_MergeShards.go index fc763f10d6d..25e42f307f3 100644 --- a/service/kinesis/api_op_MergeShards.go +++ b/service/kinesis/api_op_MergeShards.go @@ -20,28 +20,39 @@ import ( // range of 382...454, then you could merge these two shards into a single shard // that would have a hash key range of 276...454. After the merge, the single child // shard receives data for all hash key values covered by the two parent shards. +// // When invoking this API, you must use either the StreamARN or the StreamName // parameter, or both. It is recommended that you use the StreamARN input -// parameter when you invoke this API. MergeShards is called when there is 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) -// 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 -// 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. +// parameter when you invoke this API. +// +// MergeShards is called when there is 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]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 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. +// +// [Merge Two Shards]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html func (c *Client) MergeShards(ctx context.Context, params *MergeShardsInput, optFns ...func(*Options)) (*MergeShardsOutput, error) { if params == nil { params = &MergeShardsInput{} diff --git a/service/kinesis/api_op_PutRecord.go b/service/kinesis/api_op_PutRecord.go index 6c7bb42e5d2..a2c5af2997a 100644 --- a/service/kinesis/api_op_PutRecord.go +++ b/service/kinesis/api_op_PutRecord.go @@ -15,38 +15,51 @@ import ( // Writes a single data record into an Amazon Kinesis data stream. Call PutRecord // to send data into the stream for real-time ingestion and subsequent processing, // one record at a time. Each shard can support writes up to 1,000 records per -// second, up to a maximum data write total of 1 MiB per second. When invoking this -// API, you must use either the StreamARN or the StreamName parameter, or both. It -// is recommended that you use the StreamARN input parameter when you invoke this -// API. You must specify the name of the stream that captures, stores, and -// transports the data; a partition key; and the data blob itself. The data blob -// can be any type of data; for example, a segment from a log file, -// geographic/location data, website clickstream data, and so on. The partition key -// is used by Kinesis Data Streams to distribute data across shards. Kinesis Data -// Streams segregates the data records that belong to a stream into multiple -// shards, using the partition key associated with each data record to determine -// the shard to which a given data record belongs. Partition keys are Unicode -// strings, with a maximum length limit of 256 characters for each key. An MD5 hash -// function is used to map partition keys to 128-bit integer values and to 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) -// 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) -// 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 +// second, up to a maximum data write total of 1 MiB per second. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// You must specify the name of the stream that captures, stores, and transports +// the data; a partition key; and the data blob itself. +// +// The data blob can be any type of data; for example, a segment from a log file, +// geographic/location data, website clickstream data, and so on. +// +// The partition key is used by Kinesis Data Streams to distribute data across +// shards. Kinesis Data Streams segregates the data records that belong to a stream +// into multiple shards, using the partition key associated with each data record +// to determine the shard to which a given data record belongs. +// +// Partition keys are Unicode strings, with a maximum length limit of 256 +// characters for each key. An MD5 hash function is used to map partition keys to +// 128-bit integer values and to 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] 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]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 -// for 24 hours from the time that they are added to a stream. You can use -// IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this -// retention period. +// ProvisionedThroughputExceededException . +// +// By default, data records are accessible for 24 hours from the time that they +// are added to a stream. You can use IncreaseStreamRetentionPeriodor DecreaseStreamRetentionPeriod to modify this retention period. +// +// [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 func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns ...func(*Options)) (*PutRecordOutput, error) { if params == nil { params = &PutRecordInput{} @@ -128,7 +141,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. EncryptionType types.EncryptionType diff --git a/service/kinesis/api_op_PutRecords.go b/service/kinesis/api_op_PutRecords.go index fdd5a3c0a84..b9012c9dcf1 100644 --- a/service/kinesis/api_op_PutRecords.go +++ b/service/kinesis/api_op_PutRecords.go @@ -14,56 +14,74 @@ import ( // Writes multiple data records into a Kinesis data stream in a single call (also // referred to as a PutRecords request). Use this operation to send data into the -// stream for data ingestion and processing. When invoking this API, you must use -// either the StreamARN or the StreamName parameter, or both. It is recommended -// that you use the StreamARN input parameter when you invoke this API. Each -// PutRecords request can support up to 500 records. Each record in the request can -// be as large as 1 MiB, up to a limit of 5 MiB for the 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 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 clickstream data, and so on. +// stream for data ingestion and processing. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// Each PutRecords request can support up to 500 records. Each record in the +// request can be as large as 1 MiB, up to a limit of 5 MiB for the 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 +// 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 clickstream data, and so on. +// // The partition key is used by Kinesis Data Streams as input to a hash function // that maps the partition key and associated data to a 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) -// in the Amazon Kinesis Data Streams Developer Guide. Each record in the Records -// 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) -// in the Amazon Kinesis Data Streams Developer Guide. The PutRecords response -// 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 -// response Records array includes both successfully and unsuccessfully processed -// records. Kinesis Data Streams attempts to process all records in each PutRecords -// 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 -// 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 +// stream. For more information, see [Adding Data to a Stream]in the Amazon Kinesis Data Streams Developer +// Guide. +// +// Each record in the Records 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]in the Amazon Kinesis Data Streams +// Developer Guide. +// +// The PutRecords response 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 response Records array includes both successfully and unsuccessfully +// processed records. Kinesis Data Streams attempts to process all records in each +// PutRecords 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 PutRecordinstead 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 // 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) -// 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 -// added to a stream. You can use IncreaseStreamRetentionPeriod or -// DecreaseStreamRetentionPeriod to modify this retention period. +// about partially successful responses, see [Adding Multiple Records with 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 added to a stream. You can use IncreaseStreamRetentionPeriodor DecreaseStreamRetentionPeriod to modify this retention period. +// +// [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 +// [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 func (c *Client) PutRecords(ctx context.Context, params *PutRecordsInput, optFns ...func(*Options)) (*PutRecordsOutput, error) { if params == nil { params = &PutRecordsInput{} @@ -114,7 +132,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. EncryptionType types.EncryptionType diff --git a/service/kinesis/api_op_PutResourcePolicy.go b/service/kinesis/api_op_PutResourcePolicy.go index 9e8420cabfe..efe5e108c89 100644 --- a/service/kinesis/api_op_PutResourcePolicy.go +++ b/service/kinesis/api_op_PutResourcePolicy.go @@ -18,15 +18,18 @@ import ( // belong to the owner's account in order to use this operation. If you don't have // PutResourcePolicy permissions, Amazon Kinesis Data Streams returns a 403 Access // Denied error . If you receive a ResourceNotFoundException , check to see if you -// passed a valid stream or consumer resource. Request patterns can be one of the -// following: +// passed a valid stream or consumer resource. +// +// Request patterns can be one of the following: +// // - Data stream pattern: arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+ +// // - Consumer pattern: // ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+ // -// 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) -// . +// For more information, see [Controlling Access to Amazon Kinesis Data Streams Resources Using IAM]. +// +// [Controlling Access to Amazon Kinesis Data Streams Resources Using IAM]: https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} diff --git a/service/kinesis/api_op_RegisterStreamConsumer.go b/service/kinesis/api_op_RegisterStreamConsumer.go index ac13c752a31..65a43e2c8ff 100644 --- a/service/kinesis/api_op_RegisterStreamConsumer.go +++ b/service/kinesis/api_op_RegisterStreamConsumer.go @@ -13,17 +13,21 @@ import ( ) // Registers a consumer with a Kinesis data stream. When you use this operation, -// the consumer you register can then call SubscribeToShard to receive data from -// the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every -// shard you subscribe to. This rate is unaffected by the total number of consumers -// 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 -// 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 . +// the consumer you register can then call SubscribeToShardto receive data from the stream using +// enhanced fan-out, at a rate of up to 2 MiB per second for every shard you +// subscribe to. This rate is unaffected by the total number of consumers 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 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 . func (c *Client) RegisterStreamConsumer(ctx context.Context, params *RegisterStreamConsumerInput, optFns ...func(*Options)) (*RegisterStreamConsumerOutput, error) { if params == nil { params = &RegisterStreamConsumerInput{} @@ -48,9 +52,9 @@ type RegisterStreamConsumerInput struct { 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) - // . + // For more info, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // + // [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 diff --git a/service/kinesis/api_op_RemoveTagsFromStream.go b/service/kinesis/api_op_RemoveTagsFromStream.go index 788a1d8fee2..3dbbdb6bd65 100644 --- a/service/kinesis/api_op_RemoveTagsFromStream.go +++ b/service/kinesis/api_op_RemoveTagsFromStream.go @@ -12,12 +12,15 @@ import ( ) // Removes tags from the specified Kinesis data stream. Removed tags are deleted -// and cannot be recovered after this operation successfully completes. When -// invoking this API, you must use either the StreamARN or the StreamName +// and cannot be recovered after this operation successfully completes. +// +// When invoking this API, you must use either the StreamARN or the StreamName // parameter, or both. It is recommended that you use the StreamARN input -// parameter when you invoke this API. If you specify a tag that does not exist, it -// is ignored. RemoveTagsFromStream has a limit of five transactions per second -// per account. +// parameter when you invoke this API. +// +// If you specify a tag that does not exist, it is ignored. +// +// RemoveTagsFromStreamhas a limit of five transactions per second per account. func (c *Client) RemoveTagsFromStream(ctx context.Context, params *RemoveTagsFromStreamInput, optFns ...func(*Options)) (*RemoveTagsFromStreamOutput, error) { if params == nil { params = &RemoveTagsFromStreamInput{} diff --git a/service/kinesis/api_op_SplitShard.go b/service/kinesis/api_op_SplitShard.go index 7a45014cae7..772c40c80f6 100644 --- a/service/kinesis/api_op_SplitShard.go +++ b/service/kinesis/api_op_SplitShard.go @@ -15,40 +15,52 @@ import ( // stream's capacity to ingest and transport data. SplitShard is called when there // is a need to increase the overall capacity of a stream because of an expected // 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, you must use either the StreamARN or the StreamName parameter, or -// both. It is recommended that you use the StreamARN input parameter when you -// invoke this API. 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) -// 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 -// 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) -// 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 -// per account. +// supported for the data streams with the provisioned capacity mode. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// 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]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 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] in the +// Amazon Kinesis Data Streams Developer Guide. To increase this limit, [contact Amazon Web Services Support]. +// +// 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. +// +// [Kinesis Data Streams Limits]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html +// [contact Amazon Web Services Support]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html +// [Split a Shard]: https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html func (c *Client) SplitShard(ctx context.Context, params *SplitShardInput, optFns ...func(*Options)) (*SplitShardOutput, error) { if params == nil { params = &SplitShardInput{} diff --git a/service/kinesis/api_op_StartStreamEncryption.go b/service/kinesis/api_op_StartStreamEncryption.go index 29fe78f30e5..18e1dab62ee 100644 --- a/service/kinesis/api_op_StartStreamEncryption.go +++ b/service/kinesis/api_op_StartStreamEncryption.go @@ -13,22 +13,27 @@ import ( ) // Enables or updates server-side encryption using an Amazon Web Services KMS key -// for a specified stream. When invoking this API, you must use either the -// StreamARN or the StreamName parameter, or both. It is recommended that you use -// the StreamARN input parameter when you invoke this API. 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 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 . +// for a specified stream. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// 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 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 . func (c *Client) StartStreamEncryption(ctx context.Context, params *StartStreamEncryptionInput, optFns ...func(*Options)) (*StartStreamEncryptionOutput, error) { if params == nil { params = &StartStreamEncryptionInput{} @@ -56,11 +61,16 @@ type StartStreamEncryptionInput struct { // 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 // // This member is required. diff --git a/service/kinesis/api_op_StopStreamEncryption.go b/service/kinesis/api_op_StopStreamEncryption.go index 2bcc9e653f4..58f422a354f 100644 --- a/service/kinesis/api_op_StopStreamEncryption.go +++ b/service/kinesis/api_op_StopStreamEncryption.go @@ -12,22 +12,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables server-side encryption for a specified stream. When invoking this API, -// you must use either the StreamARN or the StreamName parameter, or both. It is -// recommended that you use the StreamARN input parameter when you invoke this -// API. 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 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 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 . +// Disables server-side encryption for a specified stream. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// 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 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 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 . func (c *Client) StopStreamEncryption(ctx context.Context, params *StopStreamEncryptionInput, optFns ...func(*Options)) (*StopStreamEncryptionOutput, error) { if params == nil { params = &StopStreamEncryptionInput{} @@ -55,11 +61,16 @@ type StopStreamEncryptionInput struct { // 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 // // This member is required. diff --git a/service/kinesis/api_op_SubscribeToShard.go b/service/kinesis/api_op_SubscribeToShard.go index bf6323cf1c4..ca72f75382a 100644 --- a/service/kinesis/api_op_SubscribeToShard.go +++ b/service/kinesis/api_op_SubscribeToShard.go @@ -17,22 +17,27 @@ import ( // 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 . +// Before you call this operation, call RegisterStreamConsumerto register the consumer with Kinesis Data +// Streams. +// +// When the SubscribeToShard call succeeds, your consumer starts receiving events +// of type SubscribeToShardEventover 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,14 +55,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 . + // For this parameter, use the value you obtained when you called 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 1a729fd43b3..1df362c1950 100644 --- a/service/kinesis/api_op_UpdateShardCount.go +++ b/service/kinesis/api_op_UpdateShardCount.go @@ -14,37 +14,53 @@ import ( // Updates the shard count of the specified stream to the specified number of // shards. This API is only supported for the data streams with the provisioned -// capacity mode. When invoking this API, you must use either the StreamARN or the -// StreamName parameter, or both. It is recommended that you use the StreamARN -// input parameter when you invoke this API. 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: +// capacity mode. +// +// When invoking this API, you must use either the StreamARN or the StreamName +// parameter, or both. It is recommended that you use the StreamARN input +// parameter when you invoke this API. +// +// 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: +// // - 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 +// // - Make over 10 TPS. TPS over 10 will trigger the LimitExceededException // -// 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) -// . +// For the default limits for an Amazon Web Services account, see [Streams Limits] 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]. +// +// [limits form]: https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis +// [Streams Limits]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html func (c *Client) UpdateShardCount(ctx context.Context, params *UpdateShardCountInput, optFns ...func(*Options)) (*UpdateShardCountOutput, error) { if params == nil { params = &UpdateShardCountInput{} @@ -69,11 +85,15 @@ 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. // diff --git a/service/kinesis/api_op_UpdateStreamMode.go b/service/kinesis/api_op_UpdateStreamMode.go index d8e84b2249c..30db32c20b8 100644 --- a/service/kinesis/api_op_UpdateStreamMode.go +++ b/service/kinesis/api_op_UpdateStreamMode.go @@ -12,7 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the capacity mode of the data stream. Currently, in Kinesis Data +// Updates the capacity mode of the data stream. Currently, in Kinesis Data +// // Streams, you can choose between an on-demand capacity mode and a provisioned // capacity mode for your data stream. func (c *Client) UpdateStreamMode(ctx context.Context, params *UpdateStreamModeInput, optFns ...func(*Options)) (*UpdateStreamModeOutput, error) { @@ -32,12 +33,12 @@ func (c *Client) UpdateStreamMode(ctx context.Context, params *UpdateStreamModeI type UpdateStreamModeInput struct { - // Specifies the ARN of the data stream whose capacity mode you want to update. + // Specifies the ARN of the data stream whose capacity mode you want to update. // // This member is required. StreamARN *string - // Specifies the capacity mode to which you want to set your data stream. + // Specifies the capacity mode to which you want to set your data stream. // Currently, in Kinesis Data Streams, you can choose between an on-demand capacity // mode and a provisioned capacity mode for your data streams. // diff --git a/service/kinesis/doc.go b/service/kinesis/doc.go index 079c71dc260..86c722d3d86 100644 --- a/service/kinesis/doc.go +++ b/service/kinesis/doc.go @@ -3,7 +3,8 @@ // 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/options.go b/service/kinesis/options.go index 155ced3b14e..5beb1c81fd3 100644 --- a/service/kinesis/options.go +++ b/service/kinesis/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesis/types/enums.go b/service/kinesis/types/enums.go index 23fd058fe70..8722c62f40e 100644 --- a/service/kinesis/types/enums.go +++ b/service/kinesis/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ConsumerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConsumerStatus) Values() []ConsumerStatus { return []ConsumerStatus{ "CREATING", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "NONE", @@ -55,8 +57,9 @@ const ( ) // Values returns all known values for MetricsName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricsName) Values() []MetricsName { return []MetricsName{ "IncomingBytes", @@ -78,8 +81,9 @@ const ( ) // Values returns all known values for ScalingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingType) Values() []ScalingType { return []ScalingType{ "UNIFORM_SCALING", @@ -99,8 +103,9 @@ const ( ) // Values returns all known values for ShardFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShardFilterType) Values() []ShardFilterType { return []ShardFilterType{ "AFTER_SHARD_ID", @@ -124,8 +129,9 @@ const ( ) // Values returns all known values for ShardIteratorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShardIteratorType) Values() []ShardIteratorType { return []ShardIteratorType{ "AT_SEQUENCE_NUMBER", @@ -145,8 +151,9 @@ const ( ) // Values returns all known values for StreamMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamMode) Values() []StreamMode { return []StreamMode{ "PROVISIONED", @@ -165,8 +172,9 @@ const ( ) // 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. +// expanded in the future, and so 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 fcd07804d42..0df415d160c 100644 --- a/service/kinesis/types/errors.go +++ b/service/kinesis/types/errors.go @@ -195,9 +195,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. +// valid for this request. For more information, see [How Key State Affects Use of a Customer Master Key]in the Amazon Web Services +// Key Management Service Developer Guide. +// +// [How Key State Affects Use of a Customer Master Key]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html type KMSInvalidStateException struct { Message *string @@ -277,8 +278,10 @@ 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) -// in the Amazon Web Services Key Management Service Developer Guide. +// throttling, see [Limits]in the Amazon Web Services Key Management Service Developer +// Guide. +// +// [Limits]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second type KMSThrottlingException struct { Message *string @@ -333,10 +336,11 @@ 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) -// 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) +// more information, see [Streams Limits]in the Amazon Kinesis Data Streams Developer Guide, and [Error Retries and Exponential Backoff in Amazon Web Services] // in the Amazon Web Services General Reference. +// +// [Error Retries and Exponential Backoff in Amazon Web Services]: https://docs.aws.amazon.com/general/latest/gr/api-retries.html +// [Streams Limits]: https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html type ProvisionedThroughputExceededException struct { Message *string diff --git a/service/kinesis/types/types.go b/service/kinesis/types/types.go index c28c716ae71..309399c8a68 100644 --- a/service/kinesis/types/types.go +++ b/service/kinesis/types/types.go @@ -31,14 +31,16 @@ 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 - // 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. + // 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. // // This member is required. ConsumerARN *string @@ -62,14 +64,16 @@ 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 - // 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. + // 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. // // This member is required. ConsumerARN *string @@ -100,19 +104,30 @@ type ConsumerDescription struct { // Represents enhanced metrics types. type EnhancedMetrics struct { - // List of shard-level metrics. The following are the valid shard-level metrics. - // The value " ALL " enhances every metric. + // 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) - // in the Amazon Kinesis Data Streams Developer Guide. + // + // For more information, see [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch] in the Amazon Kinesis Data Streams Developer Guide. + // + // [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch]: https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html ShardLevelMetrics []MetricsName noSmithyDocumentSerde @@ -218,7 +233,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. EncryptionType EncryptionType @@ -273,19 +290,26 @@ type Shard struct { 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: + // 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 @@ -311,14 +335,21 @@ 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 - // 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 - // 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 - // in the shard, so that you always read the most recent data in the shard. + // 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 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 in the shard, so that + // you always read the most recent data in the shard. // // This member is required. Type ShardIteratorType @@ -340,7 +371,7 @@ type StartingPosition struct { noSmithyDocumentSerde } -// Represents the output for DescribeStream . +// Represents the output for DescribeStream. type StreamDescription struct { // Represents the current enhanced monitoring settings of the stream. @@ -381,13 +412,17 @@ 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. // @@ -396,7 +431,9 @@ type StreamDescription struct { // 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 @@ -406,15 +443,20 @@ type StreamDescription struct { // 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 KeyId *string - // Specifies the capacity mode to which you want to set your data stream. + // Specifies the capacity mode to which you want to set your data stream. // Currently, in Kinesis Data Streams, you can choose between an on-demand capacity // mode and a provisioned capacity mode for your data streams. StreamModeDetails *StreamModeDetails @@ -457,13 +499,17 @@ 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. // @@ -474,7 +520,9 @@ type StreamDescriptionSummary struct { ConsumerCount *int32 // The encryption type used. This value is one of the following: + // // - KMS + // // - NONE EncryptionType EncryptionType @@ -483,15 +531,20 @@ type StreamDescriptionSummary struct { // 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 KeyId *string - // Specifies the capacity mode to which you want to set your data stream. + // Specifies the capacity mode to which you want to set your data stream. // Currently, in Kinesis Data Streams, you can choose between an on-demand // ycapacity mode and a provisioned capacity mode for your data streams. StreamModeDetails *StreamModeDetails @@ -499,12 +552,13 @@ type StreamDescriptionSummary struct { noSmithyDocumentSerde } -// Specifies the capacity mode to which you want to set your data stream. +// Specifies the capacity mode to which you want to set your data stream. +// // Currently, in Kinesis Data Streams, you can choose between an on-demand capacity // mode and a provisioned capacity mode for your data streams. type StreamModeDetails struct { - // Specifies the capacity mode to which you want to set your data stream. + // Specifies the capacity mode to which you want to set your data stream. // Currently, in Kinesis Data Streams, you can choose between an on-demand capacity // mode and a provisioned capacity mode for your data streams. // @@ -535,7 +589,7 @@ type StreamSummary struct { // The timestamp at which the stream was created. StreamCreationTimestamp *time.Time - // Specifies the capacity mode to which you want to set your data stream. + // Specifies the capacity mode to which you want to set your data stream. // Currently, in Kinesis Data Streams, you can choose between an on-demand capacity // mode and a provisioned capacity mode for your data streams. StreamModeDetails *StreamModeDetails @@ -543,14 +597,14 @@ type StreamSummary struct { noSmithyDocumentSerde } -// After you call SubscribeToShard , Kinesis Data Streams sends events of this type -// over an HTTP/2 connection to your consumer. +// 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 - // ContinuationSequenceNumber for checkpointing because it captures your shard - // progress even when no data is written to the shard. + // 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. // // This member is required. ContinuationSequenceNumber *string @@ -576,7 +630,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: // @@ -585,9 +639,8 @@ type SubscribeToShardEventStream interface { isSubscribeToShardEventStream() } -// 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 . +// 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. type SubscribeToShardEventStreamMemberSubscribeToShardEvent struct { Value SubscribeToShardEvent diff --git a/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go b/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go index 45723a0b085..c494b12a863 100644 --- a/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalytics/api_op_AddApplicationCloudWatchLoggingOption.go @@ -13,12 +13,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 . 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) -// . +// applications. For more information about version 2, see Amazon Kinesis Data 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]. +// +// [Working with Amazon 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 aaa27d5734e..77a5352017c 100644 --- a/service/kinesisanalytics/api_op_AddApplicationInput.go +++ b/service/kinesisanalytics/api_op_AddApplicationInput.go @@ -13,17 +13,25 @@ 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 -// 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) -// operation to find the current application version. This operation requires -// permissions to perform the kinesisanalytics:AddApplicationInput action. +// 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]. +// +// 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]. +// +// 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. +// +// This operation requires permissions to perform the +// kinesisanalytics:AddApplicationInput action. +// +// [CreateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html +// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html +// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplicationInputInput, optFns ...func(*Options)) (*AddApplicationInputOutput, error) { if params == nil { params = &AddApplicationInputInput{} @@ -47,15 +55,17 @@ type AddApplicationInputInput struct { // This member is required. 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) + // Current version of your Amazon Kinesis Analytics application. You can use the [DescribeApplication] // operation to find the current application version. // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + // // This member is required. CurrentApplicationVersionId *int64 - // The Input (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html) - // to add. + // The [Input] to add. + // + // [Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html // // This member is required. Input *types.Input diff --git a/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go b/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go index ce6ab799048..fbe2b31ec9c 100644 --- a/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalytics/api_op_AddApplicationInputProcessingConfiguration.go @@ -13,11 +13,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 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/) . +// applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. +// +// Adds an [InputProcessingConfiguration] 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]. +// +// [AWS Lambda]: https://docs.aws.amazon.com/lambda/ +// [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html func (c *Client) AddApplicationInputProcessingConfiguration(ctx context.Context, params *AddApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*AddApplicationInputProcessingConfigurationOutput, error) { if params == nil { params = &AddApplicationInputProcessingConfigurationInput{} @@ -42,23 +45,26 @@ 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) - // operation to get the current application version. If the version specified is - // not the current version, the ConcurrentModificationException is returned. + // configuration. 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. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. CurrentApplicationVersionId *int64 // 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) - // operation. + // You can get a list of the input IDs for an application using the [DescribeApplication]operation. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. InputId *string - // The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) - // to add to the application. + // The [InputProcessingConfiguration] to add to the application. + // + // [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html // // This member is required. InputProcessingConfiguration *types.InputProcessingConfiguration diff --git a/service/kinesisanalytics/api_op_AddApplicationOutput.go b/service/kinesisanalytics/api_op_AddApplicationOutput.go index 7aa3605a867..b23903c6fb4 100644 --- a/service/kinesisanalytics/api_op_AddApplicationOutput.go +++ b/service/kinesisanalytics/api_op_AddApplicationOutput.go @@ -13,25 +13,34 @@ 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 -// 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 -// delivery stream, or an AWS Lambda function), you add the relevant configuration -// to your application using this operation. You can configure one or more outputs -// for your application. Each output configuration maps an in-application stream -// 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 -// 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) -// 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 +// applications. For more information about version 2, see Amazon Kinesis Data 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 delivery stream, or an AWS Lambda +// function), you add the relevant configuration to your application using this +// operation. You can configure one or more outputs for your application. Each +// output configuration maps an in-application stream 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)]. +// +// 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. +// +// For the limits on the number of application inputs and outputs you can +// configure, see [Limits]. +// +// This operation requires permissions to perform the // kinesisanalytics:AddApplicationOutput action. +// +// [Limits]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html +// [Understanding Application Output (Destination)]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html +// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html func (c *Client) AddApplicationOutput(ctx context.Context, params *AddApplicationOutputInput, optFns ...func(*Options)) (*AddApplicationOutputOutput, error) { if params == nil { params = &AddApplicationOutputInput{} @@ -55,9 +64,11 @@ 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) - // operation to get the current application version. If the version specified is - // not the current version, the ConcurrentModificationException is returned. + // 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. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. CurrentApplicationVersionId *int64 diff --git a/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go b/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go index 7f9b89961c8..84aa9323607 100644 --- a/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go +++ b/service/kinesisanalytics/api_op_AddApplicationReferenceDataSource.go @@ -13,18 +13,25 @@ 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 -// 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 +// applications. For more information about version 2, see Amazon Kinesis Data 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 +// in-application table. +// +// For conceptual information, see [Configuring Application Input]. For the limits on data sources you can add to +// your application, see [Limits]. +// +// This operation requires permissions to perform the // kinesisanalytics:AddApplicationOutput action. +// +// [Limits]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html +// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html func (c *Client) AddApplicationReferenceDataSource(ctx context.Context, params *AddApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*AddApplicationReferenceDataSourceOutput, error) { if params == nil { params = &AddApplicationReferenceDataSourceInput{} @@ -48,9 +55,11 @@ 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) - // operation to get the current application version. If the version specified is - // not the current version, the ConcurrentModificationException is returned. + // 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. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. CurrentApplicationVersionId *int64 diff --git a/service/kinesisanalytics/api_op_CreateApplication.go b/service/kinesisanalytics/api_op_CreateApplication.go index 4840b4e3bb4..17cbc9c50ab 100644 --- a/service/kinesisanalytics/api_op_CreateApplication.go +++ b/service/kinesisanalytics/api_op_CreateApplication.go @@ -13,27 +13,36 @@ 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 +// 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]. +// +// 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 -// application code is one or more SQL statements that read input data, transform -// it, and generate output. Your application code can create one or more SQL -// artifacts like SQL streams or pumps. In the output configuration, you can -// configure the application to write data from in-application streams created in -// your applications to up to three destinations. To read data from your source -// stream or write data to destination streams, Amazon Kinesis Analytics needs your -// permissions. You grant these permissions by creating IAM roles. This operation -// requires permissions to perform the kinesisanalytics:CreateApplication action. +// in the in-application stream to a data element in the streaming source. +// +// Your application code is one or more SQL statements that read input data, +// transform it, and generate output. Your application code can create one or more +// SQL artifacts like SQL streams or pumps. +// +// In the output configuration, you can configure the application to write data +// from in-application streams created in your applications to up to three +// destinations. +// +// To read data from your source stream or write data to destination streams, +// Amazon Kinesis Analytics needs your 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]. +// +// [Getting Started]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html +// [How it Works]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -62,57 +71,73 @@ 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 + // pattern, see [Application Code]. + // + // 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. + // 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. + // + // [Application Code]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html ApplicationCode *string // Summary description of the application. ApplicationDescription *string // 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) - // . + // configuration errors. For more information, see [Working with Amazon CloudWatch Logs]. + // + // [Working with Amazon CloudWatch 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 - // application to receive input from a single streaming source. In this - // configuration, you map this streaming source to an in-application stream that is - // created. Your application code can then query the in-application stream like a - // table (you can think of it as a constantly updating table). For the streaming - // source, you provide its Amazon Resource Name (ARN) and format of data on the - // stream (for example, JSON, CSV, etc.). You also must provide an IAM role that - // Amazon Kinesis Analytics can assume to read this stream on your behalf. To - // create the in-application stream, you need to specify a schema to transform your - // data into a schematized version used in SQL. In the schema, you provide the + // Use this parameter to configure the application input. + // + // You can configure your application to receive input from a single streaming + // source. In this configuration, you map this streaming source to an + // in-application stream that is created. Your application code can then query the + // in-application stream like a table (you can think of it as a constantly updating + // table). + // + // For the streaming source, you provide its Amazon Resource Name (ARN) and format + // of data on the stream (for example, JSON, CSV, etc.). You also must provide an + // IAM role that Amazon Kinesis Analytics can assume to read this stream on your + // behalf. + // + // To create the in-application stream, you need to specify a schema to transform + // your data into a schematized version used in SQL. In the schema, you provide the // necessary mapping of the data elements in the streaming source to record columns // in the in-app stream. Inputs []types.Input // You can configure application output to write data from any of the - // in-application streams to up to three destinations. These destinations can be - // Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda - // destinations, or any combination of the three. In the configuration, you specify - // the in-application stream name, the destination stream or Lambda function Amazon - // Resource Name (ARN), and the format to use when writing data. You must also - // provide an IAM role that Amazon Kinesis Analytics can assume to write to the - // destination stream or Lambda function on your behalf. In the output - // configuration, you also provide the output stream or Lambda function ARN. For - // stream destinations, you provide the format of data in the stream (for example, - // JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can - // assume to write to the stream or Lambda function on your behalf. + // in-application streams to up to three destinations. + // + // These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose + // delivery streams, AWS Lambda destinations, or any combination of the three. + // + // In the configuration, you specify the in-application stream name, the + // destination stream or Lambda function Amazon Resource Name (ARN), and the format + // to use when writing data. You must also provide an IAM role that Amazon Kinesis + // Analytics can assume to write to the destination stream or Lambda function on + // your behalf. + // + // In the output configuration, you also provide the output stream or Lambda + // function ARN. For stream destinations, you provide the format of data in the + // stream (for example, JSON, CSV). You also must provide an IAM role that Amazon + // Kinesis Analytics can assume to write to the stream or Lambda function on your + // behalf. Outputs []types.Output // 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]. + // + // [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 52c7958fa2d..fcef7706e6d 100644 --- a/service/kinesisanalytics/api_op_DeleteApplication.go +++ b/service/kinesisanalytics/api_op_DeleteApplication.go @@ -13,11 +13,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 . 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 +// applications. For more information about version 2, see Amazon Kinesis Data 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 // kinesisanalytics:DeleteApplication action. func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error) { if params == nil { @@ -41,7 +43,7 @@ type DeleteApplicationInput struct { // This member is required. ApplicationName *string - // You can use the DescribeApplication operation to get this value. + // You can use the DescribeApplication operation to get this value. // // This member is required. CreateTimestamp *time.Time diff --git a/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go b/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go index f37cc11ac15..c83fccdbd1b 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationCloudWatchLoggingOption.go @@ -12,11 +12,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 . 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) -// . +// applications. For more information about version 2, see Amazon Kinesis Data 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]. +// +// [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 +41,9 @@ 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) - // operation. + // can get the CloudWatchLoggingOptionId by using the [DescribeApplication] operation. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. CloudWatchLoggingOptionId *string diff --git a/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go b/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go index d45b777d654..f367821a718 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationInputProcessingConfiguration.go @@ -12,9 +12,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 . Deletes an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) -// from an input. +// applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. +// +// Deletes an [InputProcessingConfiguration] from an input. +// +// [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html func (c *Client) DeleteApplicationInputProcessingConfiguration(ctx context.Context, params *DeleteApplicationInputProcessingConfigurationInput, optFns ...func(*Options)) (*DeleteApplicationInputProcessingConfigurationOutput, error) { if params == nil { params = &DeleteApplicationInputProcessingConfigurationInput{} @@ -44,8 +46,9 @@ 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) - // operation. + // the [DescribeApplication]operation. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. InputId *string diff --git a/service/kinesisanalytics/api_op_DeleteApplicationOutput.go b/service/kinesisanalytics/api_op_DeleteApplicationOutput.go index ef86eef761e..35e67fbeba9 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationOutput.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationOutput.go @@ -12,11 +12,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 . 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 +// applications. For more information about version 2, see Amazon Kinesis Data 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 // kinesisanalytics:DeleteApplicationOutput action. func (c *Client) DeleteApplicationOutput(ctx context.Context, params *DeleteApplicationOutputInput, optFns ...func(*Options)) (*DeleteApplicationOutputOutput, error) { if params == nil { @@ -40,21 +42,23 @@ type DeleteApplicationOutputInput struct { // This member is required. ApplicationName *string - // Amazon Kinesis Analytics application version. 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. + // Amazon Kinesis Analytics application version. 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. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. CurrentApplicationVersionId *int64 // 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) + // to the application, either when the application is created or later using the [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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) - // operation to get the specific OutputId . + // You can use the [DescribeApplication]operation to get the specific OutputId . + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + // [AddApplicationOutput]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html // // This member is required. OutputId *string diff --git a/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go b/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go index a2209c8f8ab..86a09658a87 100644 --- a/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go +++ b/service/kinesisanalytics/api_op_DeleteApplicationReferenceDataSource.go @@ -12,13 +12,18 @@ 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 -// 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) -// operation. This operation requires permissions to perform the +// applications. For more information about version 2, see Amazon Kinesis Data 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]operation. +// +// This operation requires permissions to perform the // kinesisanalytics.DeleteApplicationReferenceDataSource action. +// +// [AddApplicationReferenceDataSource]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html func (c *Client) DeleteApplicationReferenceDataSource(ctx context.Context, params *DeleteApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*DeleteApplicationReferenceDataSourceOutput, error) { if params == nil { params = &DeleteApplicationReferenceDataSourceInput{} @@ -41,18 +46,22 @@ 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) - // operation to get the current application version. If the version specified is - // not the current version, the ConcurrentModificationException is returned. + // Version of the application. 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. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. 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], Amazon Kinesis Analytics assigns an ID. You can use the [DescribeApplication] // operation to get the reference ID. // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + // [AddApplicationReferenceDataSource]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html + // // This member is required. ReferenceId *string diff --git a/service/kinesisanalytics/api_op_DescribeApplication.go b/service/kinesisanalytics/api_op_DescribeApplication.go index cfd59cf33ad..d8242a8ee1e 100644 --- a/service/kinesisanalytics/api_op_DescribeApplication.go +++ b/service/kinesisanalytics/api_op_DescribeApplication.go @@ -13,14 +13,19 @@ 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 -// 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) -// operation. This operation requires permissions to perform the +// applications. For more information about version 2, see Amazon Kinesis Data 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] +// 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 . +// +// [ListApplications]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html 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 5b3bc84695d..ba1128c91d7 100644 --- a/service/kinesisanalytics/api_op_DiscoverInputSchema.go +++ b/service/kinesisanalytics/api_op_DiscoverInputSchema.go @@ -13,17 +13,22 @@ 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 -// 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 -// 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 +// applications. For more information about version 2, see Amazon Kinesis Data 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]. 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. +// +// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputSchemaInput, optFns ...func(*Options)) (*DiscoverInputSchemaOutput, error) { if params == nil { params = &DiscoverInputSchemaInput{} @@ -41,8 +46,10 @@ 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) - // to use to preprocess the records before discovering the schema of the records. + // The [InputProcessingConfiguration] to use to preprocess the records before discovering the schema of the + // records. + // + // [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html InputProcessingConfiguration *types.InputProcessingConfiguration // Point at which you want Amazon Kinesis Analytics to start reading records from diff --git a/service/kinesisanalytics/api_op_ListApplications.go b/service/kinesisanalytics/api_op_ListApplications.go index 5096e888a6c..46a7323fb92 100644 --- a/service/kinesisanalytics/api_op_ListApplications.go +++ b/service/kinesisanalytics/api_op_ListApplications.go @@ -13,18 +13,24 @@ 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 -// 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, +// applications. For more information about version 2, see Amazon Kinesis Data 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 +// previous response. +// +// If you want detailed information about a specific application, use [DescribeApplication]. +// +// This operation requires permissions to perform the // kinesisanalytics:ListApplications action. +// +// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error) { if params == nil { params = &ListApplicationsInput{} diff --git a/service/kinesisanalytics/api_op_ListTagsForResource.go b/service/kinesisanalytics/api_op_ListTagsForResource.go index 82085d792af..299467d5d22 100644 --- a/service/kinesisanalytics/api_op_ListTagsForResource.go +++ b/service/kinesisanalytics/api_op_ListTagsForResource.go @@ -12,8 +12,9 @@ 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]. +// +// [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 7537ab7a299..0a790e00022 100644 --- a/service/kinesisanalytics/api_op_StartApplication.go +++ b/service/kinesisanalytics/api_op_StartApplication.go @@ -13,18 +13,25 @@ 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 -// 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) -// 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) -// operation. This operation requires permissions to perform the +// applications. For more information about version 2, see Amazon Kinesis Data 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]operation. +// +// After you start the application, you can stop the application from processing +// the input by calling the [StopApplication]operation. +// +// This operation requires permissions to perform the // kinesisanalytics:StartApplication action. +// +// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html +// [StopApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html func (c *Client) StartApplication(ctx context.Context, params *StartApplicationInput, optFns ...func(*Options)) (*StartApplicationOutput, error) { if params == nil { params = &StartApplicationInput{} diff --git a/service/kinesisanalytics/api_op_StopApplication.go b/service/kinesisanalytics/api_op_StopApplication.go index 81e290a12cb..4ec553bf72f 100644 --- a/service/kinesisanalytics/api_op_StopApplication.go +++ b/service/kinesisanalytics/api_op_StopApplication.go @@ -12,15 +12,18 @@ 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 -// 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) -// 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 -// operation requires permissions to perform the kinesisanalytics:StopApplication -// action. +// applications. For more information about version 2, see Amazon Kinesis Data 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]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 operation requires permissions to perform the +// kinesisanalytics:StopApplication action. +// +// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html func (c *Client) StopApplication(ctx context.Context, params *StopApplicationInput, optFns ...func(*Options)) (*StopApplicationOutput, error) { if params == nil { params = &StopApplicationInput{} diff --git a/service/kinesisanalytics/api_op_TagResource.go b/service/kinesisanalytics/api_op_TagResource.go index 91fb417ae9b..45b158099fa 100644 --- a/service/kinesisanalytics/api_op_TagResource.go +++ b/service/kinesisanalytics/api_op_TagResource.go @@ -13,8 +13,9 @@ 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]. +// +// [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 f09b3931a94..58927c6cc54 100644 --- a/service/kinesisanalytics/api_op_UntagResource.go +++ b/service/kinesisanalytics/api_op_UntagResource.go @@ -11,8 +11,9 @@ 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]. +// +// [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 7b1f07371e7..0526f05b046 100644 --- a/service/kinesisanalytics/api_op_UpdateApplication.go +++ b/service/kinesisanalytics/api_op_UpdateApplication.go @@ -13,11 +13,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 . 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. +// applications. For more information about version 2, see Amazon Kinesis Data 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. +// // This operation requires permission for the kinesisanalytics:UpdateApplication // action. func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error) { @@ -47,8 +50,10 @@ 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) - // operation to get this value. + // The current application version ID. You can use the [DescribeApplication] operation to get this + // value. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. CurrentApplicationVersionId *int64 diff --git a/service/kinesisanalytics/doc.go b/service/kinesisanalytics/doc.go index 41276fdef52..22dd5c6127f 100644 --- a/service/kinesisanalytics/doc.go +++ b/service/kinesisanalytics/doc.go @@ -3,10 +3,14 @@ // Package kinesisanalytics provides the API client, operations, and parameter // types for Amazon Kinesis Analytics. // -// 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 -// Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics -// Developer Guide provides additional information. +// # 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 Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis +// Analytics Developer Guide provides additional information. package kinesisanalytics diff --git a/service/kinesisanalytics/options.go b/service/kinesisanalytics/options.go index 678065e55f0..38c927d7c07 100644 --- a/service/kinesisanalytics/options.go +++ b/service/kinesisanalytics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisanalytics/types/enums.go b/service/kinesisanalytics/types/enums.go index 90e983113f3..2686ef19a60 100644 --- a/service/kinesisanalytics/types/enums.go +++ b/service/kinesisanalytics/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "DELETING", @@ -38,8 +39,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NOW", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for RecordFormatType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordFormatType) Values() []RecordFormatType { return []RecordFormatType{ "JSON", diff --git a/service/kinesisanalytics/types/errors.go b/service/kinesisanalytics/types/errors.go index 44541bdb432..f300f57ee4a 100644 --- a/service/kinesisanalytics/types/errors.go +++ b/service/kinesisanalytics/types/errors.go @@ -196,8 +196,9 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // 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. +// information, see [GetRecords]in the Amazon Kinesis Streams API Reference. +// +// [GetRecords]: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html type ResourceProvisionedThroughputExceededException struct { Message *string diff --git a/service/kinesisanalytics/types/types.go b/service/kinesisanalytics/types/types.go index b48156fe919..a6ab13fb081 100644 --- a/service/kinesisanalytics/types/types.go +++ b/service/kinesisanalytics/types/types.go @@ -9,10 +9,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 . Provides a description of the application, -// including the application Amazon Resource Name (ARN), status, latest version, -// and input and output configuration. +// applications. For more information about version 2, see Amazon Kinesis Data 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 { // ARN of the application. @@ -44,29 +44,32 @@ 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]. + // + // [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) - // . + // Describes the application input configuration. For more information, see [Configuring Application Input]. + // + // [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) - // . + // Describes the application output configuration. For more information, see [Configuring Application Output]. + // + // [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) - // . + // Describes reference data sources configured for the application. + // + // For more information, see [Configuring Application Input]. + // + // [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html ReferenceDataSourceDescriptions []ReferenceDataSourceDescription noSmithyDocumentSerde @@ -74,9 +77,10 @@ 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, -// including the application Amazon Resource Name (ARN), name, and status. +// applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. +// +// Provides application summary information, including the application Amazon +// Resource Name (ARN), name, and status. type ApplicationSummary struct { // ARN of the application. @@ -180,7 +184,9 @@ type CloudWatchLoggingOptionUpdate struct { // 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" +// delimiter: +// +// "name1", "address1" // // "name2", "address2" type CSVMappingParameters struct { @@ -200,8 +206,9 @@ 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]. +// +// [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,13 +221,16 @@ 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]. +// +// [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 // element maps to corresponding columns in the in-application stream that is being - // created. Also used to describe the format of the reference data source. + // created. + // + // Also used to describe the format of the reference data source. // // This member is required. InputSchema *SourceSchema @@ -234,29 +244,35 @@ type Input struct { // This member is required. NamePrefix *string - // 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) - // . + // 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]. + // + // [Configuring Application 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) - // 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) - // . + // 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]. + // + // [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html + // [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, // identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis - // Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput - // or KinesisFirehoseInput is required. + // Analytics to access the stream on your behalf. + // + // Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. KinesisFirehoseInput *KinesisFirehoseInput // If the streaming source is an Amazon Kinesis stream, identifies the stream's // Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics - // to access the stream on your behalf. Note: Either KinesisStreamsInput or - // KinesisFirehoseInput is required. + // to access the stream on your behalf. + // + // Note: Either KinesisStreamsInput or KinesisFirehoseInput is required. KinesisStreamsInput *KinesisStreamsInput noSmithyDocumentSerde @@ -267,8 +283,9 @@ 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) - // operation. + // Input source ID. You can get this ID by calling the [DescribeApplication] operation. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. Id *string @@ -282,9 +299,9 @@ type InputConfiguration struct { noSmithyDocumentSerde } -// 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) -// . +// Describes the application input configuration. For more information, see [Configuring Application Input]. +// +// [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. @@ -327,16 +344,20 @@ 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] 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. +// +// [AWS Lambda]: https://docs.aws.amazon.com/lambda/ type InputLambdaProcessor struct { - // The ARN of the AWS Lambda (https://docs.aws.amazon.com/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: AWS - // Lambda + // The ARN of the [AWS 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: AWS Lambda + // + // [AWS Lambda]: https://docs.aws.amazon.com/lambda/ // // This member is required. ResourceARN *string @@ -349,13 +370,16 @@ 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] 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. +// +// [AWS Lambda]: https://docs.aws.amazon.com/lambda/ 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] function that is used to preprocess the records in the stream. + // + // [AWS Lambda]: https://docs.aws.amazon.com/lambda/ ResourceARN *string // The ARN of the IAM role that is used to access the AWS Lambda function. @@ -364,15 +388,20 @@ type InputLambdaProcessorDescription struct { noSmithyDocumentSerde } -// 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. +// Represents an update to the [InputLambdaProcessor] that is used to preprocess the records in the +// stream. +// +// [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html 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] 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 + // + // [AWS Lambda]: https://docs.aws.amazon.com/lambda/ ResourceARNUpdate *string // The ARN of the new IAM role that is used to access the AWS Lambda function. @@ -382,12 +411,14 @@ 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]. +// +// [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]. + // + // [Limits]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html Count *int32 noSmithyDocumentSerde @@ -404,12 +435,15 @@ 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]. +// +// [AWS Lambda]: https://docs.aws.amazon.com/lambda/ type InputProcessingConfiguration struct { - // 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. + // The [InputLambdaProcessor] that is used to preprocess the records in the stream before being + // processed by your application code. + // + // [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html // // This member is required. InputLambdaProcessor *InputLambdaProcessor @@ -418,24 +452,27 @@ type InputProcessingConfiguration struct { } // Provides configuration information about an input processor. Currently, the -// only input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/) -// . +// only input processor available is [AWS Lambda]. +// +// [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) - // . + // Provides configuration information about the associated [InputLambdaProcessorDescription]. + // + // [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]. +// +// [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]. + // + // [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html // // This member is required. InputLambdaProcessorUpdate *InputLambdaProcessorUpdate @@ -465,11 +502,14 @@ 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. InputStartingPosition InputStartingPosition @@ -525,7 +565,8 @@ type JSONMappingParameters struct { noSmithyDocumentSerde } -// Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. +// Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. +// // You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN // that enables Amazon Kinesis Analytics to access the stream on your behalf. type KinesisFirehoseInput struct { @@ -545,8 +586,9 @@ type KinesisFirehoseInput struct { noSmithyDocumentSerde } -// Describes the Amazon Kinesis Firehose delivery stream that is configured as the -// streaming source in the application input configuration. +// Describes the Amazon Kinesis Firehose delivery stream that is configured as +// +// the streaming source in the application input configuration. type KinesisFirehoseInputDescription struct { // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream. @@ -594,7 +636,8 @@ type KinesisFirehoseOutput struct { noSmithyDocumentSerde } -// For an application output, describes the Amazon Kinesis Firehose delivery +// For an application output, describes the Amazon Kinesis Firehose delivery +// // stream configured as its destination. type KinesisFirehoseOutputDescription struct { @@ -608,9 +651,12 @@ type KinesisFirehoseOutputDescription struct { noSmithyDocumentSerde } -// 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. +// When updating an output configuration using the [UpdateApplication] operation, provides +// +// information about an Amazon Kinesis Firehose delivery stream configured as the +// destination. +// +// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html type KinesisFirehoseOutputUpdate struct { // Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to @@ -624,7 +670,8 @@ type KinesisFirehoseOutputUpdate struct { noSmithyDocumentSerde } -// Identifies an Amazon Kinesis stream as the streaming source. You provide the +// Identifies an Amazon Kinesis stream as the streaming source. You provide the +// // stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon // Kinesis Analytics to access the stream on your behalf. type KinesisStreamsInput struct { @@ -643,7 +690,8 @@ type KinesisStreamsInput struct { noSmithyDocumentSerde } -// Describes the Amazon Kinesis stream that is configured as the streaming source +// Describes the Amazon Kinesis stream that is configured as the streaming source +// // in the application input configuration. type KinesisStreamsInputDescription struct { @@ -692,7 +740,8 @@ type KinesisStreamsOutput struct { noSmithyDocumentSerde } -// For an application output, describes the Amazon Kinesis stream configured as +// For an application output, describes the Amazon Kinesis stream configured as +// // its destination. type KinesisStreamsOutputDescription struct { @@ -706,9 +755,11 @@ type KinesisStreamsOutputDescription struct { noSmithyDocumentSerde } -// 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. +// When updating an output configuration using the [UpdateApplication] operation, provides +// +// information about an Amazon Kinesis stream configured as the destination. +// +// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html type KinesisStreamsOutputUpdate struct { // Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write @@ -728,10 +779,11 @@ type KinesisStreamsOutputUpdate struct { // behalf. type LambdaOutput struct { - // 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: AWS Lambda + // 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: AWS Lambda // // This member is required. ResourceARN *string @@ -760,15 +812,17 @@ type LambdaOutputDescription struct { noSmithyDocumentSerde } -// 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. +// When updating an output configuration using the [UpdateApplication] operation, provides +// information about an AWS Lambda function configured as the destination. +// +// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html type LambdaOutputUpdate struct { - // Amazon Resource Name (ARN) of the destination 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: AWS Lambda + // Amazon Resource Name (ARN) of the destination 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: AWS Lambda ResourceARNUpdate *string // ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the @@ -796,17 +850,22 @@ type MappingParameters struct { noSmithyDocumentSerde } -// Describes application output configuration in which you identify an +// Describes application 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 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) -// . +// Kinesis Firehose delivery stream. +// +// For limits on how many destinations an application can write and other +// limitations, see [Limits]. +// +// [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]. + // + // [Configuring Application Output]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html // // This member is required. DestinationSchema *DestinationSchema @@ -867,8 +926,9 @@ 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]. + // + // [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 @@ -889,8 +949,9 @@ type OutputUpdate struct { } // Describes the mapping of each data element in the streaming source to the -// corresponding column in the in-application stream. Also used to describe the -// format of the reference data source. +// corresponding column in the in-application stream. +// +// Also used to describe the format of the reference data source. type RecordColumn struct { // Name of the column created in the in-application input stream or reference @@ -905,14 +966,16 @@ 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]is JSON . + // + // [RecordFormatType]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel Mapping *string noSmithyDocumentSerde } -// Describes the record format and relevant mapping information that should be +// Describes the record format and relevant mapping information that should be +// // applied to schematize the records on the stream. type RecordFormat struct { @@ -949,9 +1012,11 @@ type ReferenceDataSource 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 operation to - // trigger reloading of data into your application. + // on your behalf. + // + // An Amazon Kinesis Analytics application loads reference data only once. If the + // data changes, you call the UpdateApplication operation to trigger reloading of + // data into your application. S3ReferenceDataSource *S3ReferenceDataSource noSmithyDocumentSerde @@ -961,10 +1026,11 @@ type ReferenceDataSource struct { 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) + // assigns when you add the reference data source to your application using the [AddApplicationReferenceDataSource] // operation. // + // [AddApplicationReferenceDataSource]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html + // // This member is required. ReferenceId *string @@ -996,9 +1062,10 @@ type ReferenceDataSourceDescription struct { // in-application reference table that is created. 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) - // operation to get this value. + // ID of the reference data source being updated. You can use the [DescribeApplication] operation to + // get this value. + // + // [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html // // This member is required. ReferenceId *string @@ -1043,9 +1110,13 @@ 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) -// operation to trigger reloading of data into your application. +// on your behalf. +// +// An Amazon Kinesis Analytics application loads reference data only once. If the +// data changes, you call the [UpdateApplication]operation to trigger reloading of data into your +// application. +// +// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html type S3ReferenceDataSource struct { // Amazon Resource Name (ARN) of the S3 bucket. @@ -1134,8 +1205,9 @@ 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]. +// +// [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_op_AddApplicationCloudWatchLoggingOption.go b/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go index 04c7cca4254..5891d87d634 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationCloudWatchLoggingOption.go @@ -42,16 +42,15 @@ type AddApplicationCloudWatchLoggingOptionInput struct { // 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 + // 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 SQL-based Kinesis Data Analytics application. You must // provide the CurrentApplicationVersionId or the ConditionalToken .You can - // retrieve the application version ID using DescribeApplication . For better - // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId . + // retrieve the application version ID using DescribeApplication. For better concurrency support, use + // the ConditionalToken parameter instead of CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationInput.go b/service/kinesisanalyticsv2/api_op_AddApplicationInput.go index 4ce761ac793..85a93c18dc1 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationInput.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationInput.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds a streaming source to your SQL-based Kinesis Data Analytics application. +// 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 -// 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. +// 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. func (c *Client) AddApplicationInput(ctx context.Context, params *AddApplicationInputInput, optFns ...func(*Options)) (*AddApplicationInputOutput, error) { if params == nil { params = &AddApplicationInputInput{} @@ -42,8 +44,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 b13c62bf89d..f0e6c97edaf 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationInputProcessingConfiguration.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/) . +// 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]. +// +// [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{} @@ -39,16 +40,15 @@ type AddApplicationInputProcessingConfigurationInput struct { ApplicationName *string // The version of the application to which you want to add the input processing - // configuration. You can use the DescribeApplication operation to get the current - // application version. If the version specified is not the current version, the + // configuration. You can use the DescribeApplicationoperation to get the current application + // version. If the version specified is not the current version, the // ConcurrentModificationException is returned. // // This member is required. CurrentApplicationVersionId *int64 // 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 operation. + // You can get a list of the input IDs for an application using the DescribeApplicationoperation. // // This member is required. InputId *string diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go b/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go index 82af6794a2f..037c27cf034 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationOutput.go @@ -12,17 +12,22 @@ import ( ) // Adds an external destination to your SQL-based Kinesis Data Analytics -// application. If you want Kinesis Data Analytics to deliver data from an -// in-application stream within your application to an external destination (such -// as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon -// Lambda function), you add the relevant configuration to your application using -// this operation. You can configure one or more outputs for your application. Each +// application. +// +// If you want Kinesis Data Analytics to deliver data from an in-application +// stream within your application to an external destination (such as an Kinesis +// data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda +// function), you add the relevant configuration to your application using this +// operation. You can configure one or more outputs for your application. Each // output configuration maps an in-application stream 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. 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. +// the errors. +// +// 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. func (c *Client) AddApplicationOutput(ctx context.Context, params *AddApplicationOutputInput, optFns ...func(*Options)) (*AddApplicationOutputOutput, error) { if params == nil { params = &AddApplicationOutputInput{} @@ -46,8 +51,8 @@ type AddApplicationOutputInput struct { ApplicationName *string // The version of the application to which you want to add the output - // configuration. You can use the DescribeApplication operation to get the current - // application version. If the version specified is not the current version, the + // configuration. You can use the DescribeApplicationoperation to get the current application + // version. If the version specified is not the current version, the // ConcurrentModificationException is returned. // // This member is required. @@ -74,9 +79,9 @@ type AddApplicationOutputOutput struct { // when the application is updated. 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) - // . + // Describes the application output configuration. For more information, see [Configuring Application Output]. + // + // [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_AddApplicationReferenceDataSource.go b/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go index 79962c52f01..c020f1046fc 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationReferenceDataSource.go @@ -12,10 +12,12 @@ import ( ) // Adds a reference data source to an existing SQL-based Kinesis Data Analytics -// application. Kinesis Data 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 +// application. +// +// Kinesis Data 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 an Amazon S3 object maps to columns in the resulting // in-application table. func (c *Client) AddApplicationReferenceDataSource(ctx context.Context, params *AddApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*AddApplicationReferenceDataSourceOutput, error) { @@ -41,8 +43,8 @@ type AddApplicationReferenceDataSourceInput struct { ApplicationName *string // The version of the application for which you are adding the reference data - // source. You can use the DescribeApplication operation to get the current - // application version. If the version specified is not the current version, the + // source. You can use the DescribeApplicationoperation to get the current application version. If + // the version specified is not the current version, the // ConcurrentModificationException is returned. // // This member is required. diff --git a/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go b/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go index f892c93584b..cae6dcefbbb 100644 --- a/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_AddApplicationVpcConfiguration.go @@ -12,10 +12,13 @@ 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 Managed Service for Apache Flink -// applications: +// Applications can use VPCs to store and access resources securely. +// +// Note the following about VPC configurations for Managed Service for Apache +// Flink applications: +// // - VPC configurations are not supported for SQL applications. +// // - When a VPC is added to a Managed Service for Apache Flink 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. @@ -48,17 +51,16 @@ type AddApplicationVpcConfigurationInput struct { // 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 - // concurrency support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId . + // application's current ConditionalToken using DescribeApplication. For better concurrency support, + // use the ConditionalToken parameter instead of 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 - // 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 . + // can use the DescribeApplicationoperation 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 . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_CreateApplication.go b/service/kinesisanalyticsv2/api_op_CreateApplication.go index b20d1f9a2d4..16d89a206ff 100644 --- a/service/kinesisanalyticsv2/api_op_CreateApplication.go +++ b/service/kinesisanalyticsv2/api_op_CreateApplication.go @@ -12,9 +12,9 @@ import ( ) // Creates a Managed Service for Apache Flink application. For information about -// creating a Managed Service for Apache Flink application, see Creating an -// Application (https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html) -// . +// creating a Managed Service for Apache Flink application, see [Creating an Application]. +// +// [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{} @@ -66,8 +66,9 @@ 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]. + // + // [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 d0f3084d6cc..55bddf112ce 100644 --- a/service/kinesisanalyticsv2/api_op_CreateApplicationPresignedUrl.go +++ b/service/kinesisanalyticsv2/api_op_CreateApplicationPresignedUrl.go @@ -12,16 +12,20 @@ import ( ) // Creates and returns a URL that you can use to connect to an application's -// extension. The IAM role or user used to call this API defines the permissions to -// access the extension. After the presigned URL is created, no additional -// permission is required to access this URL. IAM authorization policies for this -// API are also enforced for every HTTP request that attempts to connect to the -// extension. You control the amount of time that the URL will be valid using the +// extension. +// +// The IAM role or user used to call this API defines the permissions to access +// the extension. After the presigned URL is created, no additional permission is +// required to access this URL. IAM authorization policies for this API are also +// enforced for every HTTP request that attempts to connect to the extension. +// +// You control the amount of time that the URL will be valid using the // SessionExpirationDurationInSeconds parameter. If you do not provide this -// parameter, the returned URL is valid for twelve hours. The URL that you get from -// a call to CreateApplicationPresignedUrl must be used within 3 minutes to be -// valid. If you first try to use the URL after the 3-minute limit expires, the -// service returns an HTTP 403 Forbidden error. +// parameter, the returned URL is valid for twelve hours. +// +// The URL that you get from a call to CreateApplicationPresignedUrl must be used +// within 3 minutes to be valid. If you first try to use the URL after the 3-minute +// limit expires, the service returns an HTTP 403 Forbidden error. func (c *Client) CreateApplicationPresignedUrl(ctx context.Context, params *CreateApplicationPresignedUrlInput, optFns ...func(*Options)) (*CreateApplicationPresignedUrlOutput, error) { if params == nil { params = &CreateApplicationPresignedUrlInput{} diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go index 2002fe82c34..3af0cc259a9 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationCloudWatchLoggingOption.go @@ -36,24 +36,22 @@ type DeleteApplicationCloudWatchLoggingOptionInput struct { ApplicationName *string // The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to - // delete. You can get the CloudWatchLoggingOptionId by using the - // DescribeApplication operation. + // 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 + // 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 - // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId . + // application version ID using DescribeApplication. For better concurrency support, use the + // ConditionalToken parameter instead of CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go index a85aaff0eaf..f5e1983926a 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationInputProcessingConfiguration.go @@ -33,16 +33,16 @@ type DeleteApplicationInputProcessingConfigurationInput struct { // This member is required. ApplicationName *string - // The application version. 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. + // The application version. 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. // // This member is required. CurrentApplicationVersionId *int64 // 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 operation. + // the DescribeApplicationoperation. // // This member is required. InputId *string diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go index 30f34132bbf..d851d666ff7 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationOutput.go @@ -36,19 +36,18 @@ type DeleteApplicationOutputInput struct { // This member is required. ApplicationName *string - // The application version. 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. + // The application version. 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. // // This member is required. CurrentApplicationVersionId *int64 // 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 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 . + // to the application (either when the application is created or later) using the 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 DescribeApplicationoperation to get 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 1d3369be891..55552eeae22 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationReferenceDataSource.go @@ -11,9 +11,10 @@ import ( ) // Deletes a reference data source configuration from the specified SQL-based -// Kinesis Data Analytics application's configuration. If the application is -// running, Kinesis Data Analytics immediately removes the in-application table -// that you created using the AddApplicationReferenceDataSource operation. +// Kinesis Data Analytics application's configuration. +// +// If the application is running, Kinesis Data Analytics immediately removes the +// in-application table that you created using the AddApplicationReferenceDataSourceoperation. func (c *Client) DeleteApplicationReferenceDataSource(ctx context.Context, params *DeleteApplicationReferenceDataSourceInput, optFns ...func(*Options)) (*DeleteApplicationReferenceDataSourceOutput, error) { if params == nil { params = &DeleteApplicationReferenceDataSourceInput{} @@ -36,17 +37,16 @@ type DeleteApplicationReferenceDataSourceInput struct { // This member is required. ApplicationName *string - // The current application version. 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. + // The current application version. 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. // // This member is required. CurrentApplicationVersionId *int64 // The ID of the reference data source. When you add a reference data source to - // your application using the AddApplicationReferenceDataSource , Kinesis Data - // Analytics assigns an ID. You can use the DescribeApplication operation to get - // the reference ID. + // your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use + // the DescribeApplicationoperation to get the reference ID. // // This member is required. ReferenceId *string diff --git a/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go b/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go index 1c81da24f17..654fec216e7 100644 --- a/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_DeleteApplicationVpcConfiguration.go @@ -40,16 +40,15 @@ type DeleteApplicationVpcConfigurationInput struct { // 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 + // 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 - // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId . + // application version ID using DescribeApplication. For better concurrency support, use the + // ConditionalToken parameter instead of CurrentApplicationVersionId . CurrentApplicationVersionId *int64 noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_DescribeApplication.go b/service/kinesisanalyticsv2/api_op_DescribeApplication.go index c01f86c8806..3b5263ba456 100644 --- a/service/kinesisanalyticsv2/api_op_DescribeApplication.go +++ b/service/kinesisanalyticsv2/api_op_DescribeApplication.go @@ -12,8 +12,10 @@ import ( ) // Returns information about a specific Managed Service for Apache Flink -// application. If you want to retrieve a list of all applications in your account, -// use the ListApplications operation. +// application. +// +// If you want to retrieve a list of all applications in your account, use the ListApplications +// operation. func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplicationInput, optFns ...func(*Options)) (*DescribeApplicationOutput, error) { if params == nil { params = &DescribeApplicationInput{} diff --git a/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go b/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go index f201031ee11..87224a3dba6 100644 --- a/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go +++ b/service/kinesisanalyticsv2/api_op_DescribeApplicationVersion.go @@ -12,9 +12,9 @@ import ( ) // Provides a detailed description of a specified version of the application. To -// see a list of all the versions of an application, invoke the -// ListApplicationVersions operation. This operation is supported only for Managed -// Service for Apache Flink. +// see a list of all the versions of an application, invoke the ListApplicationVersionsoperation. +// +// This operation is supported only for Managed Service for Apache Flink. func (c *Client) DescribeApplicationVersion(ctx context.Context, params *DescribeApplicationVersionInput, optFns ...func(*Options)) (*DescribeApplicationVersionOutput, error) { if params == nil { params = &DescribeApplicationVersionInput{} diff --git a/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go b/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go index 65a745378cd..c2382216c66 100644 --- a/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go +++ b/service/kinesisanalyticsv2/api_op_DiscoverInputSchema.go @@ -15,10 +15,12 @@ import ( // 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 -// operation to infer a schema and show it in the console user interface. +// 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 operation to infer a schema and show it in the +// console user interface. func (c *Client) DiscoverInputSchema(ctx context.Context, params *DiscoverInputSchemaInput, optFns ...func(*Options)) (*DiscoverInputSchemaOutput, error) { if params == nil { params = &DiscoverInputSchemaInput{} @@ -41,8 +43,8 @@ type DiscoverInputSchemaInput struct { // This member is required. ServiceExecutionRole *string - // The InputProcessingConfiguration to use to preprocess the records before - // discovering the schema of the records. + // The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the + // records. InputProcessingConfiguration *types.InputProcessingConfiguration // The point at which you want Kinesis Data Analytics to start reading records diff --git a/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go b/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go index 35194f4bdd7..2dbaaecaf24 100644 --- a/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go +++ b/service/kinesisanalyticsv2/api_op_ListApplicationVersions.go @@ -13,9 +13,12 @@ import ( // Lists all the versions for the specified application, including versions that // were rolled back. The response also includes a summary of the configuration -// associated with each version. To get the complete description of a specific -// application version, invoke the DescribeApplicationVersion operation. This -// operation is supported only for Managed Service for Apache Flink. +// associated with each version. +// +// To get the complete description of a specific application version, invoke the DescribeApplicationVersion +// operation. +// +// This operation is supported only for Managed Service for Apache Flink. func (c *Client) ListApplicationVersions(ctx context.Context, params *ListApplicationVersionsInput, optFns ...func(*Options)) (*ListApplicationVersionsOutput, error) { if params == nil { params = &ListApplicationVersionsInput{} @@ -43,8 +46,9 @@ 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]. + // + // [Using the Amazon Command Line Interface's Pagination Options]: https://docs.aws.amazon.com/cli/latest/userguide/pagination.html NextToken *string noSmithyDocumentSerde @@ -53,16 +57,18 @@ type ListApplicationVersionsInput struct { type ListApplicationVersionsOutput struct { // A list of the application versions and the associated configuration summaries. - // The list includes application versions that were rolled back. To get the - // complete description of a specific application version, invoke the - // DescribeApplicationVersion operation. + // The list includes application versions that were rolled back. + // + // To get the complete description of a specific application version, invoke the DescribeApplicationVersion + // operation. ApplicationVersionSummaries []types.ApplicationVersionSummary // 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]. + // + // [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 0523a81f44a..d4f9663cce7 100644 --- a/service/kinesisanalyticsv2/api_op_ListApplications.go +++ b/service/kinesisanalyticsv2/api_op_ListApplications.go @@ -13,8 +13,9 @@ import ( // Returns a list of Managed Service for Apache Flink 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 . +// Amazon Resource Name (ARN), and status. +// +// If you want detailed information about a specific application, use DescribeApplication. func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error) { if params == nil { params = &ListApplicationsInput{} @@ -36,9 +37,9 @@ type ListApplicationsInput struct { Limit *int32 // 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) - // . + // retrieve the next set of results. For more information about pagination, see [Using the Amazon Command Line Interface's Pagination Options]. + // + // [Using the Amazon Command Line Interface's Pagination Options]: https://docs.aws.amazon.com/cli/latest/userguide/pagination.html NextToken *string noSmithyDocumentSerde @@ -53,9 +54,9 @@ 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) - // . + // next set of items For more information about pagination, see [Using the Amazon Command Line Interface's Pagination Options]. + // + // [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_ListTagsForResource.go b/service/kinesisanalyticsv2/api_op_ListTagsForResource.go index a539dc2db19..1a818103dc5 100644 --- a/service/kinesisanalyticsv2/api_op_ListTagsForResource.go +++ b/service/kinesisanalyticsv2/api_op_ListTagsForResource.go @@ -12,8 +12,9 @@ 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]. +// +// [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 853fd077826..bd0c05c0a3e 100644 --- a/service/kinesisanalyticsv2/api_op_RollbackApplication.go +++ b/service/kinesisanalyticsv2/api_op_RollbackApplication.go @@ -12,12 +12,17 @@ import ( ) // Reverts the application to the previous running version. You can roll back an -// application if you suspect it is stuck in a transient status. You can roll back -// an application only if it is in the UPDATING or AUTOSCALING status. When you -// rollback an application, it loads state data from the last successful snapshot. -// If the application has no snapshots, Managed Service for Apache Flink rejects -// the rollback request. This action is not supported for Managed Service for -// Apache Flink for SQL applications. +// application if you suspect it is stuck in a transient status. +// +// You can roll back an application only if it is in the UPDATING or AUTOSCALING +// status. +// +// When you rollback an application, it loads state data from the last successful +// snapshot. If the application has no snapshots, Managed Service for Apache Flink +// rejects the rollback request. +// +// This action is not supported for Managed Service for Apache Flink for SQL +// applications. func (c *Client) RollbackApplication(ctx context.Context, params *RollbackApplicationInput, optFns ...func(*Options)) (*RollbackApplicationOutput, error) { if params == nil { params = &RollbackApplicationInput{} @@ -41,7 +46,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 diff --git a/service/kinesisanalyticsv2/api_op_StopApplication.go b/service/kinesisanalyticsv2/api_op_StopApplication.go index b976727ce65..681370e6349 100644 --- a/service/kinesisanalyticsv2/api_op_StopApplication.go +++ b/service/kinesisanalyticsv2/api_op_StopApplication.go @@ -11,8 +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. +// 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. +// // Managed Service for Apache Flink 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) { @@ -39,12 +41,16 @@ type StopApplicationInput struct { // Set to true to force the application to stop. If you set Force to true , Managed // Service for Apache Flink 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 Managed Service for Apache Flink 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. + // + // 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 Managed Service for Apache Flink 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. Force *bool noSmithyDocumentSerde diff --git a/service/kinesisanalyticsv2/api_op_TagResource.go b/service/kinesisanalyticsv2/api_op_TagResource.go index 77fcb0155ba..92129e495ec 100644 --- a/service/kinesisanalyticsv2/api_op_TagResource.go +++ b/service/kinesisanalyticsv2/api_op_TagResource.go @@ -14,8 +14,9 @@ import ( // Adds one or more key-value tags to a Managed Service for Apache Flink // 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) -// . +// information, see [Using Tagging]. +// +// [Using 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 3bf29ab741d..36c1f4e669a 100644 --- a/service/kinesisanalyticsv2/api_op_UntagResource.go +++ b/service/kinesisanalyticsv2/api_op_UntagResource.go @@ -11,8 +11,9 @@ import ( ) // Removes one or more tags from a Managed Service for Apache Flink application. -// For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html) -// . +// For more information, see [Using Tagging]. +// +// [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 42f349eb042..c9ceded8385 100644 --- a/service/kinesisanalyticsv2/api_op_UpdateApplication.go +++ b/service/kinesisanalyticsv2/api_op_UpdateApplication.go @@ -13,8 +13,10 @@ import ( // Updates an existing Managed Service for Apache Flink application. Using this // operation, you can update application code, input configuration, and output -// configuration. Managed Service for Apache Flink updates the ApplicationVersionId -// each time you update your application. +// configuration. +// +// Managed Service for Apache Flink updates the ApplicationVersionId each time you +// update your application. func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error) { if params == nil { params = &UpdateApplicationInput{} @@ -42,21 +44,20 @@ 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 + // 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 - // support, use the ConditionalToken parameter instead of - // CurrentApplicationVersionId . + // application version ID using DescribeApplication. For better concurrency support, use the + // ConditionalToken parameter instead of CurrentApplicationVersionId . CurrentApplicationVersionId *int64 // Describes updates to the application's starting parameters. @@ -64,8 +65,10 @@ type UpdateApplicationInput struct { // Updates the Managed Service for Apache Flink runtime environment used to run // your code. To avoid issues you must: + // // - Ensure your new jar and dependencies are compatible with the new runtime // selected. + // // - Ensure your new code's state is compatible with the snapshot from which // your application will start RuntimeEnvironmentUpdate types.RuntimeEnvironment diff --git a/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go b/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go index f74c50b43bf..257da00ae71 100644 --- a/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go +++ b/service/kinesisanalyticsv2/api_op_UpdateApplicationMaintenanceConfiguration.go @@ -12,20 +12,27 @@ import ( ) // Updates the maintenance configuration of the Managed Service for Apache Flink -// 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 Managed Service -// for Apache Flink for Apache Flink Maintenance (https://docs.aws.amazon.com/kinesisanalytics/latest/java/maintenance.html) -// . This operation is supported only for Managed Service for Apache Flink. +// 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 [Managed Service for Apache Flink for Apache Flink Maintenance]. +// +// This operation is supported only for Managed Service for Apache Flink. +// +// [Managed Service for Apache Flink for Apache Flink Maintenance]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/maintenance.html func (c *Client) UpdateApplicationMaintenanceConfiguration(ctx context.Context, params *UpdateApplicationMaintenanceConfigurationInput, optFns ...func(*Options)) (*UpdateApplicationMaintenanceConfigurationOutput, error) { if params == nil { params = &UpdateApplicationMaintenanceConfigurationInput{} diff --git a/service/kinesisanalyticsv2/doc.go b/service/kinesisanalyticsv2/doc.go index a5f9d2bbdf5..efb7002f104 100644 --- a/service/kinesisanalyticsv2/doc.go +++ b/service/kinesisanalyticsv2/doc.go @@ -4,9 +4,11 @@ // types for Amazon Kinesis Analytics. // // Amazon Managed Service for Apache Flink was previously known as Amazon Kinesis -// Data Analytics for Apache Flink. Amazon Managed Service for Apache Flink is a -// fully managed service that you can use to process and analyze streaming data -// using Java, Python, SQL, or Scala. The service enables you to quickly author and -// run Java, SQL, or Scala code against streaming sources to perform time series -// analytics, feed real-time dashboards, and create real-time metrics. +// Data Analytics for Apache Flink. +// +// Amazon Managed Service for Apache Flink is a fully managed service that you can +// use to process and analyze streaming data using Java, Python, SQL, or Scala. The +// service enables you to quickly author and run Java, SQL, or Scala code against +// streaming sources to perform time series analytics, feed real-time dashboards, +// and create real-time metrics. package kinesisanalyticsv2 diff --git a/service/kinesisanalyticsv2/options.go b/service/kinesisanalyticsv2/options.go index 5feab711b94..957a41fb79d 100644 --- a/service/kinesisanalyticsv2/options.go +++ b/service/kinesisanalyticsv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisanalyticsv2/types/enums.go b/service/kinesisanalyticsv2/types/enums.go index 83ce65739ca..cda36f7ef05 100644 --- a/service/kinesisanalyticsv2/types/enums.go +++ b/service/kinesisanalyticsv2/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApplicationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationMode) Values() []ApplicationMode { return []ApplicationMode{ "STREAMING", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ApplicationRestoreType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationRestoreType) Values() []ApplicationRestoreType { return []ApplicationRestoreType{ "SKIP_RESTORE_FROM_SNAPSHOT", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "DELETING", @@ -85,8 +88,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -103,8 +107,9 @@ const ( ) // Values returns all known values for CodeContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodeContentType) Values() []CodeContentType { return []CodeContentType{ "PLAINTEXT", @@ -121,8 +126,9 @@ const ( ) // Values returns all known values for ConfigurationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationType) Values() []ConfigurationType { return []ConfigurationType{ "DEFAULT", @@ -140,8 +146,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NOW", @@ -161,8 +168,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "INFO", @@ -183,8 +191,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -203,8 +212,9 @@ const ( ) // Values returns all known values for RecordFormatType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordFormatType) Values() []RecordFormatType { return []RecordFormatType{ "JSON", @@ -229,8 +239,9 @@ const ( ) // Values returns all known values for RuntimeEnvironment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuntimeEnvironment) Values() []RuntimeEnvironment { return []RuntimeEnvironment{ "SQL-1_0", @@ -257,8 +268,9 @@ const ( ) // Values returns all known values for SnapshotStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotStatus) Values() []SnapshotStatus { return []SnapshotStatus{ "CREATING", @@ -277,8 +289,9 @@ const ( ) // Values returns all known values for UrlType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UrlType) Values() []UrlType { return []UrlType{ "FLINK_DASHBOARD_URL", diff --git a/service/kinesisanalyticsv2/types/errors.go b/service/kinesisanalyticsv2/types/errors.go index 5ae1b46a987..53515d1c938 100644 --- a/service/kinesisanalyticsv2/types/errors.go +++ b/service/kinesisanalyticsv2/types/errors.go @@ -222,8 +222,9 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // 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. +// see [GetRecords]in the Amazon Kinesis Streams API Reference. +// +// [GetRecords]: http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html type ResourceProvisionedThroughputExceededException struct { Message *string diff --git a/service/kinesisanalyticsv2/types/types.go b/service/kinesisanalyticsv2/types/types.go index 09c2658d693..a74cffc18b5 100644 --- a/service/kinesisanalyticsv2/types/types.go +++ b/service/kinesisanalyticsv2/types/types.go @@ -198,15 +198,15 @@ type ApplicationDetail struct { // application, the mode is optional. ApplicationMode ApplicationMode - // If you reverted the application using RollbackApplication , the application - // version when RollbackApplication was called. + // If you reverted the application using RollbackApplication, the application version when + // RollbackApplication was called. ApplicationVersionRolledBackFrom *int64 // The version to which you want to roll back the application. ApplicationVersionRolledBackTo *int64 - // The previous application version before the latest application update. - // RollbackApplication reverts the application to this version. + // The previous application version before the latest application update. RollbackApplication reverts + // the application to this version. ApplicationVersionUpdatedFrom *int64 // Describes the application Amazon CloudWatch logging options. @@ -409,44 +409,55 @@ 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://nightlies.apache.org/flink/flink-docs-release-1.18/docs/dev/datastream/fault-tolerance/checkpointing/#enabling-and-configuring-checkpointing) -// in the Apache Flink Documentation (https://nightlies.apache.org/flink/flink-docs-release-1.18/) -// . +// information, see [Checkpoints for Fault Tolerance]in the [Apache Flink Documentation]. +// +// [Checkpoints for Fault Tolerance]: https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/dev/datastream/fault-tolerance/checkpointing/#enabling-and-configuring-checkpointing +// [Apache Flink Documentation]: https://nightlies.apache.org/flink/flink-docs-release-1.18/ type CheckpointConfiguration struct { // Describes whether the application uses Managed Service for Apache Flink' // 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 following values, even if they are set to other values - // using APIs or application code: + // 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 // // 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 - // using this API or in application code. + // 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 using this API or in application code. CheckpointInterval *int64 // Describes whether checkpointing is enabled for a Managed Service for Apache - // Flink 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. + // Flink 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://nightlies.apache.org/flink/flink-docs-release-1.18/docs/ops/state/large_state_tuning/#tuning-checkpointing) - // in the Apache Flink Documentation (https://nightlies.apache.org/flink/flink-docs-release-1.18/) - // . If CheckpointConfiguration.ConfigurationType is DEFAULT , the application will + // continual checkpoint operations. For more information, see [Tuning Checkpointing]in the [Apache Flink Documentation]. + // + // 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. + // + // [Tuning Checkpointing]: https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/ops/state/large_state_tuning/#tuning-checkpointing + // [Apache Flink Documentation]: https://nightlies.apache.org/flink/flink-docs-release-1.18/ MinPauseBetweenCheckpoints *int64 noSmithyDocumentSerde @@ -456,31 +467,39 @@ type CheckpointConfiguration struct { // application. 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 - // using this API or in application code. + // 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 using this API or in application code. CheckpointInterval *int64 // Describes whether checkpointing is enabled for a Managed Service for Apache - // Flink 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. + // Flink 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 - // Managed Service for Apache Flink. 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: + // Managed Service for Apache Flink. + // + // 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 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 + // 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. MinPauseBetweenCheckpoints *int64 @@ -491,33 +510,40 @@ type CheckpointConfigurationDescription struct { // Apache Flink 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 + // 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. CheckpointingEnabledUpdate *bool // Describes updates to whether the application uses the default checkpointing // behavior of Managed Service for Apache Flink. 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: + // 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 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 + // 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. MinPauseBetweenCheckpointsUpdate *int64 @@ -548,9 +574,11 @@ type CloudWatchLoggingOptionDescription struct { // The ID of the CloudWatch logging option description. CloudWatchLoggingOptionId *string - // The IAM ARN of the role to use to send application messages. Provided for - // backward compatibility. Applications created with the current API version have - // an application-level service execution role rather than a resource-level role. + // The IAM ARN of the role to use to send application messages. + // + // Provided for backward compatibility. Applications created with the current API + // version have an application-level service execution role rather than a + // resource-level role. RoleARN *string noSmithyDocumentSerde @@ -627,7 +655,9 @@ 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 { @@ -778,9 +808,10 @@ 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://nightlies.apache.org/flink/flink-docs-release-1.18/docs/dev/datastream/fault-tolerance/checkpointing/#enabling-and-configuring-checkpointing) - // in the Apache Flink Documentation (https://nightlies.apache.org/flink/flink-docs-release-1.18/) - // . + // information, see [Checkpoints for Fault Tolerance]in the [Apache Flink Documentation]. + // + // [Checkpoints for Fault Tolerance]: https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/dev/datastream/fault-tolerance/checkpointing/#enabling-and-configuring-checkpointing + // [Apache Flink Documentation]: https://nightlies.apache.org/flink/flink-docs-release-1.18/ CheckpointConfiguration *CheckpointConfiguration // Describes configuration parameters for Amazon CloudWatch logging for an @@ -802,12 +833,12 @@ type FlinkApplicationConfigurationDescription struct { // process of persisting application state for fault tolerance. CheckpointConfigurationDescription *CheckpointConfigurationDescription - // The job plan for an application. For more information about the job plan, see - // Jobs and Scheduling (https://nightlies.apache.org/flink/flink-docs-release-1.18/internals/job_scheduling.html) - // in the Apache Flink Documentation (https://nightlies.apache.org/flink/flink-docs-release-1.18/) - // . To retrieve the job plan for the application, use the - // DescribeApplicationRequest$IncludeAdditionalDetails parameter of the - // DescribeApplication operation. + // The job plan for an application. For more information about the job plan, see [Jobs and Scheduling] + // in the [Apache Flink Documentation]. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of + // the DescribeApplicationoperation. + // + // [Apache Flink Documentation]: https://nightlies.apache.org/flink/flink-docs-release-1.18/ + // [Jobs and Scheduling]: https://nightlies.apache.org/flink/flink-docs-release-1.18/internals/job_scheduling.html JobPlanDescription *string // Describes configuration parameters for Amazon CloudWatch logging for an @@ -849,11 +880,14 @@ type FlinkRunConfiguration struct { // 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://nightlies.apache.org/flink/flink-docs-release-1.18/docs/ops/state/savepoints/#allowing-non-restored-state) - // in the Apache Flink documentation (https://nightlies.apache.org/flink/flink-docs-release-1.18/) - // . 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]in the [Apache Flink documentation]. + // + // 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 . + // + // [Allowing Non-Restored State]: https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/ops/state/savepoints/#allowing-non-restored-state + // [Apache Flink documentation]: https://nightlies.apache.org/flink/flink-docs-release-1.18/ AllowNonRestoredState *bool noSmithyDocumentSerde @@ -902,7 +936,9 @@ type Input struct { // Describes the format of the data in the streaming source, and how each data // element maps to corresponding columns in the in-application stream that is being - // created. Also used to describe the format of the reference data source. + // created. + // + // Also used to describe the format of the reference data source. // // This member is required. InputSchema *SourceSchema @@ -919,10 +955,9 @@ type Input struct { // Describes the number of in-application streams to create. InputParallelism *InputParallelism - // 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 . + // 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. InputProcessingConfiguration *InputProcessingConfiguration // If the streaming source is an Amazon Kinesis Data Firehose delivery stream, @@ -984,9 +1019,12 @@ type InputDescription struct { 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) + // about Lambda ARNs, see [Example ARNs: Amazon Lambda] + // + // [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 @@ -1000,14 +1038,19 @@ type InputLambdaProcessor struct { 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) + // 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] + // + // [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 // The ARN of the IAM role that is used to access the Amazon Lambda function. + // // Provided for backward compatibility. Applications that are created with the // current API version have an application-level service execution role rather than // a resource-level role. @@ -1016,15 +1059,18 @@ type InputLambdaProcessorDescription struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, represents an update to the -// InputLambdaProcessor that is used to preprocess the records in the stream. +// For a SQL-based Kinesis Data Analytics application, represents an update to the 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 - // 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) + // 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] + // + // [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 @@ -1057,12 +1103,13 @@ 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]. +// +// [Amazon Lambda]: https://docs.aws.amazon.com/lambda/ type InputProcessingConfiguration struct { - // The InputLambdaProcessor that is used to preprocess the records in the stream - // before being processed by your application code. + // The InputLambdaProcessor that is used to preprocess the records in the stream before being + // processed by your application code. // // This member is required. InputLambdaProcessor *InputLambdaProcessor @@ -1072,21 +1119,21 @@ 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]. +// +// [Amazon Lambda]: https://docs.aws.amazon.com/lambda/ type InputProcessingConfigurationDescription struct { - // Provides configuration information about the associated - // InputLambdaProcessorDescription + // Provides configuration information about the associated InputLambdaProcessorDescription InputLambdaProcessorDescription *InputLambdaProcessorDescription noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, describes updates to an -// InputProcessingConfiguration . +// For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration. type InputProcessingConfigurationUpdate struct { - // Provides update information for an InputLambdaProcessor . + // Provides update information for an InputLambdaProcessor. // // This member is required. InputLambdaProcessorUpdate *InputLambdaProcessorUpdate @@ -1117,11 +1164,14 @@ 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. InputStartingPosition InputStartingPosition @@ -1142,7 +1192,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 @@ -1200,9 +1250,11 @@ type KinesisFirehoseInputDescription struct { ResourceARN *string // The ARN of the IAM role that Kinesis Data Analytics assumes to access the - // stream. Provided for backward compatibility. Applications that are created with - // the current API version have an application-level service execution role rather - // than a resource-level role. + // stream. + // + // Provided for backward compatibility. Applications that are created with the + // current API version have an application-level service execution role rather than + // a resource-level role. RoleARN *string noSmithyDocumentSerde @@ -1245,17 +1297,19 @@ type KinesisFirehoseOutputDescription struct { ResourceARN *string // The ARN of the IAM role that Kinesis Data Analytics can assume to access the - // stream. Provided for backward compatibility. Applications that are created with - // the current API version have an application-level service execution role rather - // than a resource-level role. + // stream. + // + // Provided for backward compatibility. Applications that are created with the + // current API version have an application-level service execution role rather than + // a resource-level role. RoleARN *string noSmithyDocumentSerde } // For a SQL-based Kinesis Data Analytics application, when updating an output -// configuration using the UpdateApplication operation, provides information about -// a Kinesis Data Firehose delivery stream that is configured as the destination. +// configuration using the UpdateApplicationoperation, provides information about a Kinesis Data +// Firehose delivery stream that is configured as the destination. type KinesisFirehoseOutputUpdate struct { // The Amazon Resource Name (ARN) of the delivery stream to write to. @@ -1266,7 +1320,8 @@ type KinesisFirehoseOutputUpdate struct { noSmithyDocumentSerde } -// Identifies a Kinesis data stream as the streaming source. You provide the +// Identifies a Kinesis data stream as the streaming source. You provide the +// // stream's Amazon Resource Name (ARN). type KinesisStreamsInput struct { @@ -1289,9 +1344,11 @@ type KinesisStreamsInputDescription struct { ResourceARN *string // The ARN of the IAM role that Kinesis Data Analytics can assume to access the - // stream. Provided for backward compatibility. Applications that are created with - // the current API version have an application-level service execution role rather - // than a resource-level role. + // stream. + // + // Provided for backward compatibility. Applications that are created with the + // current API version have an application-level service execution role rather than + // a resource-level role. RoleARN *string noSmithyDocumentSerde @@ -1333,17 +1390,19 @@ type KinesisStreamsOutputDescription struct { ResourceARN *string // The ARN of the IAM role that Kinesis Data Analytics can assume to access the - // stream. Provided for backward compatibility. Applications that are created with - // the current API version have an application-level service execution role rather - // than a resource-level role. + // stream. + // + // Provided for backward compatibility. Applications that are created with the + // current API version have an application-level service execution role rather than + // a resource-level role. RoleARN *string noSmithyDocumentSerde } // When you update a SQL-based Kinesis Data Analytics application's output -// configuration using the UpdateApplication operation, provides information about -// a Kinesis data stream that is configured as the destination. +// configuration using the UpdateApplicationoperation, provides information about a Kinesis data +// stream that is configured as the destination. type KinesisStreamsOutputUpdate struct { // The Amazon Resource Name (ARN) of the Kinesis data stream where you want to @@ -1361,9 +1420,12 @@ type KinesisStreamsOutputUpdate struct { 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] + // + // [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 @@ -1381,23 +1443,28 @@ type LambdaOutputDescription struct { ResourceARN *string // The ARN of the IAM role that Kinesis Data Analytics can assume to write to the - // destination function. Provided for backward compatibility. Applications that are - // created with the current API version have an application-level service execution - // role rather than a resource-level role. + // destination function. + // + // Provided for backward compatibility. Applications that are created with the + // current API version have an application-level service execution role rather than + // a resource-level role. RoleARN *string noSmithyDocumentSerde } // When you update an SQL-based Kinesis Data Analytics application's output -// configuration using the UpdateApplication operation, provides information about -// an Amazon Lambda function that is configured as the destination. +// configuration using the UpdateApplicationoperation, provides information about an Amazon Lambda +// function that is configured as the destination. 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) + // 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] + // + // [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 @@ -1445,8 +1512,9 @@ 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]. +// +// [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 @@ -1503,7 +1571,8 @@ type MonitoringConfigurationUpdate struct { noSmithyDocumentSerde } -// Describes a SQL-based Kinesis Data Analytics application's output +// 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. @@ -1561,7 +1630,8 @@ type OutputDescription struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, describes updates to the +// For a SQL-based Kinesis Data Analytics application, describes updates to the +// // output configuration identified by the OutputId . type OutputUpdate struct { @@ -1592,9 +1662,10 @@ type OutputUpdate struct { // Describes parameters for how a Managed Service for Apache Flink application // executes multiple tasks simultaneously. For more information about parallelism, -// see Parallel Execution (https://nightlies.apache.org/flink/flink-docs-release-1.18/dev/parallel.html) -// in the Apache Flink Documentation (https://nightlies.apache.org/flink/flink-docs-release-1.18/) -// . +// see [Parallel Execution]in the [Apache Flink Documentation]. +// +// [Parallel Execution]: https://nightlies.apache.org/flink/flink-docs-release-1.18/dev/parallel.html +// [Apache Flink Documentation]: https://nightlies.apache.org/flink/flink-docs-release-1.18/ type ParallelismConfiguration struct { // Describes whether the application uses the default parallelism for the Managed @@ -1622,8 +1693,9 @@ type ParallelismConfiguration struct { // Describes the number of parallel tasks that a Managed Service for Apache Flink // application can perform per Kinesis Processing Unit (KPU) used by the - // application. For more information about KPUs, see Amazon Managed Service for - // Apache Flink Pricing (http://aws.amazon.com/kinesis/data-analytics/pricing/) . + // application. For more information about KPUs, see [Amazon Managed Service for Apache Flink Pricing]. + // + // [Amazon Managed Service for Apache Flink Pricing]: http://aws.amazon.com/kinesis/data-analytics/pricing/ ParallelismPerKPU *int32 noSmithyDocumentSerde @@ -1721,8 +1793,9 @@ type PropertyGroup struct { // For a SQL-based Kinesis Data Analytics application, describes the mapping of // each data element in the streaming source to the corresponding column in the -// in-application stream. Also used to describe the format of the reference data -// source. +// in-application stream. +// +// Also used to describe the format of the reference data source. type RecordColumn struct { // The name of the column that is created in the in-application input stream or @@ -1744,8 +1817,9 @@ type RecordColumn struct { noSmithyDocumentSerde } -// For a SQL-based Kinesis Data Analytics application, describes the record format -// and relevant mapping information that should be applied to schematize the +// For a SQL-based Kinesis Data Analytics application, describes the record +// +// format and relevant mapping information that should be applied to schematize the // records on the stream. type RecordFormat struct { @@ -1781,10 +1855,11 @@ type ReferenceDataSource struct { // This member is required. TableName *string - // Identifies the S3 bucket and object that contains the reference data. A - // SQL-based Kinesis Data Analytics application loads reference data only once. If - // the data changes, you call the UpdateApplication operation to trigger reloading - // of data into your application. + // Identifies the S3 bucket and object that contains the reference data. + // + // A SQL-based Kinesis Data Analytics application loads reference data only once. + // If the data changes, you call the UpdateApplicationoperation to trigger reloading of data into + // your application. S3ReferenceDataSource *S3ReferenceDataSource noSmithyDocumentSerde @@ -1795,8 +1870,8 @@ type ReferenceDataSource struct { type ReferenceDataSourceDescription struct { // The ID of the reference data source. This is the ID that Kinesis Data Analytics - // assigns when you add the reference data source to your application using the - // CreateApplication or UpdateApplication operation. + // assigns when you add the reference data source to your application using the CreateApplicationor UpdateApplication + // operation. // // This member is required. ReferenceId *string @@ -1827,8 +1902,8 @@ type ReferenceDataSourceDescription struct { // object to the in-application reference table that is created. type ReferenceDataSourceUpdate struct { - // The ID of the reference data source that is being updated. You can use the - // DescribeApplication operation to get this value. + // The ID of the reference data source that is being updated. You can use the DescribeApplication + // operation to get this value. // // This member is required. ReferenceId *string @@ -2013,10 +2088,11 @@ type S3ContentLocationUpdate struct { } // For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 -// bucket and object that contains the reference data. A SQL-based Kinesis Data -// Analytics application loads reference data only once. If the data changes, you -// call the UpdateApplication operation to trigger reloading of data into your -// application. +// bucket and object that contains the reference data. +// +// A SQL-based Kinesis Data Analytics application loads reference data only once. +// If the data changes, you call the UpdateApplicationoperation to trigger reloading of data into +// your application. type S3ReferenceDataSource struct { // The Amazon Resource Name (ARN) of the S3 bucket. @@ -2044,6 +2120,7 @@ type S3ReferenceDataSourceDescription struct { // The ARN of the IAM role that Kinesis Data Analytics can assume to read the // Amazon S3 object on your behalf to populate the in-application reference table. + // // Provided for backward compatibility. Applications that are created with the // current API version have an application-level service execution role rather than // a resource-level role. @@ -2125,8 +2202,8 @@ type SqlApplicationConfiguration struct { // application. Outputs []Output - // The array of ReferenceDataSource objects describing the reference data sources - // used by the application. + // The array of ReferenceDataSource objects describing the reference data sources used by the + // application. ReferenceDataSources []ReferenceDataSource noSmithyDocumentSerde @@ -2136,16 +2213,15 @@ type SqlApplicationConfiguration struct { // Kinesis Data Analytics application. type SqlApplicationConfigurationDescription struct { - // The array of InputDescription objects describing the input streams used by the - // application. + // The array of InputDescription objects describing the input streams used by the application. InputDescriptions []InputDescription - // The array of OutputDescription objects describing the destination streams used - // by the application. + // The array of OutputDescription objects describing the destination streams used by the + // application. OutputDescriptions []OutputDescription - // The array of ReferenceDataSourceDescription objects describing the reference - // data sources used by the application. + // The array of ReferenceDataSourceDescription objects describing the reference data sources used by the + // application. ReferenceDataSourceDescriptions []ReferenceDataSourceDescription noSmithyDocumentSerde @@ -2155,16 +2231,15 @@ type SqlApplicationConfigurationDescription struct { // sources for a SQL-based Kinesis Data Analytics application. type SqlApplicationConfigurationUpdate struct { - // The array of InputUpdate objects describing the new input streams used by the - // application. + // The array of InputUpdate objects describing the new input streams used by the 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 @@ -2174,8 +2249,7 @@ type SqlApplicationConfigurationUpdate struct { // application. type SqlRunConfiguration struct { - // The input source ID. You can get this ID by calling the DescribeApplication - // operation. + // The input source ID. You can get this ID by calling the DescribeApplication operation. // // This member is required. InputId *string @@ -2193,8 +2267,9 @@ 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]. +// +// [Using Tagging]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html type Tag struct { // The key of the key-value tag. @@ -2211,14 +2286,16 @@ 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) - // IDs used by the VPC configuration. + // The array of [SecurityGroup] IDs used by the VPC configuration. + // + // [SecurityGroup]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html // // 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] IDs used by the VPC configuration. + // + // [Subnet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html // // This member is required. SubnetIds []string @@ -2229,14 +2306,16 @@ 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) - // IDs used by the VPC configuration. + // The array of [SecurityGroup] IDs used by the VPC configuration. + // + // [SecurityGroup]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html // // 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] IDs used by the VPC configuration. + // + // [Subnet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html // // This member is required. SubnetIds []string @@ -2262,12 +2341,14 @@ 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) - // IDs used by the VPC configuration. + // Describes updates to the array of [SecurityGroup] IDs used by the VPC configuration. + // + // [SecurityGroup]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html 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] IDs used by the VPC configuration. + // + // [Subnet]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html SubnetIdUpdates []string noSmithyDocumentSerde @@ -2342,8 +2423,9 @@ type ZeppelinApplicationConfigurationUpdate struct { // Describes configuration parameters for Amazon CloudWatch logging for a Managed // Service for Apache Flink Studio notebook. For more information about CloudWatch -// logging, see Monitoring (https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html) -// . +// logging, see [Monitoring]. +// +// [Monitoring]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/monitoring-overview.html type ZeppelinMonitoringConfiguration struct { // The verbosity of the CloudWatch Logs for an application. diff --git a/service/kinesisvideo/api_op_CreateSignalingChannel.go b/service/kinesisvideo/api_op_CreateSignalingChannel.go index 0d667fde567..7dd25a26437 100644 --- a/service/kinesisvideo/api_op_CreateSignalingChannel.go +++ b/service/kinesisvideo/api_op_CreateSignalingChannel.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a signaling channel. CreateSignalingChannel is an asynchronous -// operation. +// Creates a signaling channel. +// +// CreateSignalingChannel is an asynchronous operation. func (c *Client) CreateSignalingChannel(ctx context.Context, params *CreateSignalingChannelInput, optFns ...func(*Options)) (*CreateSignalingChannelOutput, error) { if params == nil { params = &CreateSignalingChannelInput{} diff --git a/service/kinesisvideo/api_op_CreateStream.go b/service/kinesisvideo/api_op_CreateStream.go index 6d7f89e9cba..560913e5506 100644 --- a/service/kinesisvideo/api_op_CreateStream.go +++ b/service/kinesisvideo/api_op_CreateStream.go @@ -10,11 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]. +// +// You must have permissions for the KinesisVideo:CreateStream action. +// +// [How it Works]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error) { if params == nil { params = &CreateStreamInput{} @@ -32,39 +40,52 @@ func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, op type CreateStreamInput struct { - // A name for the stream that you are creating. The stream name is an identifier - // for the stream, and must be unique for each account and region. + // A name for the stream that you are creating. + // + // The stream name is an identifier for the stream, and must be unique for each + // account and region. // // This member is required. StreamName *string // The number of hours that you want to retain the data in the stream. Kinesis // Video Streams retains the data in a data store that is associated with the - // stream. The default value is 0, indicating that the stream does not persist - // data. When the DataRetentionInHours value is 0, consumers can still consume the + // stream. + // + // The default value is 0, indicating that the stream does not persist data. + // + // When the DataRetentionInHours value is 0, consumers can still consume the // fragments that remain in the service host buffer, which has a retention time // limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed // from the buffer when either limit is reached. DataRetentionInHours *int32 - // The name of the device that is writing to the stream. In the current - // implementation, Kinesis Video Streams does not use this name. + // The name of the device that is writing to the stream. + // + // In the current implementation, Kinesis Video Streams does not use this name. DeviceName *string // 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 ( Amazon Web Services/kinesisvideo ) is used. For more - // information, see DescribeKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) - // . + // Streams to use to encrypt stream data. + // + // If no key ID is specified, the default, Kinesis Video-managed key ( Amazon Web + // Services/kinesisvideo ) is used. + // + // For more information, see [DescribeKey]. + // + // [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). + // when processing the stream. For more information about media types, see [Media Types]. If + // you choose to specify the MediaType , see [Naming Requirements] 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). + // + // [Naming Requirements]: https://tools.ietf.org/html/rfc6838#section-4.2 + // [Media Types]: http://www.iana.org/assignments/media-types/media-types.xhtml 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_DeleteEdgeConfiguration.go b/service/kinesisvideo/api_op_DeleteEdgeConfiguration.go index efacd6fcde6..ab23078edd7 100644 --- a/service/kinesisvideo/api_op_DeleteEdgeConfiguration.go +++ b/service/kinesisvideo/api_op_DeleteEdgeConfiguration.go @@ -11,13 +11,16 @@ import ( ) // An asynchronous API that deletes a stream’s existing edge configuration, as -// well as the corresponding media from the Edge Agent. When you invoke this API, -// the sync status is set to DELETING . A deletion process starts, in which active -// edge jobs are stopped and all media is deleted from the edge device. The time to -// delete varies, depending on the total amount of stored media. If the deletion -// process fails, the sync status changes to DELETE_FAILED . You will need to -// re-try the deletion. When the deletion process has completed successfully, the -// edge configuration is no longer accessible. +// well as the corresponding media from the Edge Agent. +// +// When you invoke this API, the sync status is set to DELETING . A deletion +// process starts, in which active edge jobs are stopped and all media is deleted +// from the edge device. The time to delete varies, depending on the total amount +// of stored media. If the deletion process fails, the sync status changes to +// DELETE_FAILED . You will need to re-try the deletion. +// +// When the deletion process has completed successfully, the edge configuration is +// no longer accessible. func (c *Client) DeleteEdgeConfiguration(ctx context.Context, params *DeleteEdgeConfigurationInput, optFns ...func(*Options)) (*DeleteEdgeConfigurationOutput, error) { if params == nil { params = &DeleteEdgeConfigurationInput{} diff --git a/service/kinesisvideo/api_op_DeleteStream.go b/service/kinesisvideo/api_op_DeleteStream.go index aa0f4a5d56f..0dca7035d10 100644 --- a/service/kinesisvideo/api_op_DeleteStream.go +++ b/service/kinesisvideo/api_op_DeleteStream.go @@ -10,14 +10,17 @@ 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,10 +43,12 @@ 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 - // CreationTime is checked before deleting the stream. + // 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 noSmithyDocumentSerde diff --git a/service/kinesisvideo/api_op_GetDataEndpoint.go b/service/kinesisvideo/api_op_GetDataEndpoint.go index f2607bec467..0d7eb799a27 100644 --- a/service/kinesisvideo/api_op_GetDataEndpoint.go +++ b/service/kinesisvideo/api_op_GetDataEndpoint.go @@ -14,9 +14,12 @@ import ( // Gets an endpoint for a specified stream for either reading or writing. Use this // endpoint in your application to read from the specified stream (using the // 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 . +// 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 . func (c *Client) GetDataEndpoint(ctx context.Context, params *GetDataEndpointInput, optFns ...func(*Options)) (*GetDataEndpointOutput, error) { if params == nil { params = &GetDataEndpointInput{} diff --git a/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go b/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go index 16b5268f9c6..f59c5470b5c 100644 --- a/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go +++ b/service/kinesisvideo/api_op_GetSignalingChannelEndpoint.go @@ -13,14 +13,16 @@ import ( // Provides an endpoint for the specified signaling channel to send and receive // messages. This API uses the SingleMasterChannelEndpointConfiguration input -// 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 . +// 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 . 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_ListEdgeAgentConfigurations.go b/service/kinesisvideo/api_op_ListEdgeAgentConfigurations.go index eaa106a2ce3..9940c07374e 100644 --- a/service/kinesisvideo/api_op_ListEdgeAgentConfigurations.go +++ b/service/kinesisvideo/api_op_ListEdgeAgentConfigurations.go @@ -12,7 +12,9 @@ import ( ) // Returns an array of edge configurations associated with the specified Edge -// Agent. In the request, you must specify the Edge Agent HubDeviceArn . +// Agent. +// +// In the request, you must specify the Edge Agent HubDeviceArn . func (c *Client) ListEdgeAgentConfigurations(ctx context.Context, params *ListEdgeAgentConfigurationsInput, optFns ...func(*Options)) (*ListEdgeAgentConfigurationsOutput, error) { if params == nil { params = &ListEdgeAgentConfigurationsInput{} diff --git a/service/kinesisvideo/api_op_ListTagsForStream.go b/service/kinesisvideo/api_op_ListTagsForStream.go index 1cc5e134824..d8ff46ec8ad 100644 --- a/service/kinesisvideo/api_op_ListTagsForStream.go +++ b/service/kinesisvideo/api_op_ListTagsForStream.go @@ -10,8 +10,9 @@ 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 5567d25db6d..ef453267d74 100644 --- a/service/kinesisvideo/api_op_StartEdgeConfigurationUpdate.go +++ b/service/kinesisvideo/api_op_StartEdgeConfigurationUpdate.go @@ -17,16 +17,19 @@ import ( // Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your // premise. The time to sync can vary and depends on the connectivity of the Hub // 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 -// 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. To move an edge -// configuration from one device to another, use DeleteEdgeConfiguration to delete -// the current edge configuration. You can then invoke StartEdgeConfigurationUpdate +// 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 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. +// +// To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the +// current edge configuration. You can then invoke StartEdgeConfigurationUpdate // with an updated Hub Device ARN. func (c *Client) StartEdgeConfigurationUpdate(ctx context.Context, params *StartEdgeConfigurationUpdateInput, optFns ...func(*Options)) (*StartEdgeConfigurationUpdateOutput, error) { if params == nil { @@ -50,7 +53,7 @@ type StartEdgeConfigurationUpdateInput struct { // This member is required. EdgeConfig *types.EdgeConfig - // The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or + // The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or // the StreamARN . StreamARN *string @@ -83,7 +86,7 @@ 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 + // 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 diff --git a/service/kinesisvideo/api_op_TagResource.go b/service/kinesisvideo/api_op_TagResource.go index e08e9d18122..7d9c6c02f42 100644 --- a/service/kinesisvideo/api_op_TagResource.go +++ b/service/kinesisvideo/api_op_TagResource.go @@ -14,9 +14,10 @@ import ( // Adds one or more tags to a signaling channel. 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) -// in the Billing and Cost Management and Cost Management User Guide. +// with the value that you specify in the request. For more information, see [Using Cost Allocation Tags]in +// the Billing and Cost Management and Cost Management User Guide. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/kinesisvideo/api_op_TagStream.go b/service/kinesisvideo/api_op_TagStream.go index 7eef07fed23..3a5d23c3212 100644 --- a/service/kinesisvideo/api_op_TagStream.go +++ b/service/kinesisvideo/api_op_TagStream.go @@ -13,12 +13,16 @@ 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) -// in the Billing and Cost Management and Cost Management User Guide. You must -// 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. +// that you specify in the request. For more information, see [Using Cost Allocation Tags]in the Billing and +// Cost Management and Cost Management User Guide. +// +// You must 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. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) TagStream(ctx context.Context, params *TagStreamInput, optFns ...func(*Options)) (*TagStreamOutput, error) { if params == nil { params = &TagStreamInput{} diff --git a/service/kinesisvideo/api_op_UntagStream.go b/service/kinesisvideo/api_op_UntagStream.go index 9b6b6e2d0de..d816dfc3e6e 100644 --- a/service/kinesisvideo/api_op_UntagStream.go +++ b/service/kinesisvideo/api_op_UntagStream.go @@ -12,7 +12,9 @@ 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 dd9350de0d8..0256c094c7a 100644 --- a/service/kinesisvideo/api_op_UpdateDataRetention.go +++ b/service/kinesisvideo/api_op_UpdateDataRetention.go @@ -14,12 +14,17 @@ 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 . This operation -// requires permission for the KinesisVideo:UpdateDataRetention action. Changing -// the data retention period affects the data in the stream as follows: +// you must specify either the StreamName or the StreamARN . +// +// 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 @@ -49,6 +54,7 @@ type UpdateDataRetentionInput struct { // The number of hours to adjust the current retention by. The value you specify // is added to or subtracted from the current value, depending on the operation . + // // The minimum value for data retention is 0 and the maximum value is 87600 (ten // years). // diff --git a/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go b/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go index 7ca8b7a1221..0d5d6383d59 100644 --- a/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go +++ b/service/kinesisvideo/api_op_UpdateMediaStorageConfiguration.go @@ -13,9 +13,11 @@ import ( // Associates a SignalingChannel to a stream to store the media. There are two // signaling modes that you can specify : +// // - If StorageStatus is enabled, the data will be stored in the StreamARN // provided. In order for WebRTC Ingestion to work, the stream must have data // retention enabled. +// // - If StorageStatus is disabled, no data will be stored, and the StreamARN // parameter will not be needed. // diff --git a/service/kinesisvideo/api_op_UpdateSignalingChannel.go b/service/kinesisvideo/api_op_UpdateSignalingChannel.go index a2f475f1dbd..69cf61de687 100644 --- a/service/kinesisvideo/api_op_UpdateSignalingChannel.go +++ b/service/kinesisvideo/api_op_UpdateSignalingChannel.go @@ -12,10 +12,11 @@ import ( ) // Updates the existing signaling channel. This is an asynchronous operation and -// takes time to complete. If the MessageTtlSeconds value is updated (either -// increased or reduced), it only applies to new messages sent via this channel -// after it's been updated. Existing messages are still expired as per the previous -// MessageTtlSeconds value. +// takes time to complete. +// +// If the MessageTtlSeconds value is updated (either increased or reduced), it +// only applies to new messages sent via this channel after it's been updated. +// Existing messages are still expired as per the previous MessageTtlSeconds value. func (c *Client) UpdateSignalingChannel(ctx context.Context, params *UpdateSignalingChannelInput, optFns ...func(*Options)) (*UpdateSignalingChannelOutput, error) { if params == nil { params = &UpdateSignalingChannelInput{} diff --git a/service/kinesisvideo/api_op_UpdateStream.go b/service/kinesisvideo/api_op_UpdateStream.go index 36995dd86a4..ca3f22e603e 100644 --- a/service/kinesisvideo/api_op_UpdateStream.go +++ b/service/kinesisvideo/api_op_UpdateStream.go @@ -10,12 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates stream metadata, such as the device name and media type. You must -// provide the stream name or the Amazon Resource Name (ARN) of the stream. To make -// sure that you have the latest version of the stream before updating 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. +// Updates stream metadata, such as the device name and media type. +// +// You must provide the stream name or the Amazon Resource Name (ARN) of the +// stream. +// +// To make sure that you have the latest version of the stream before updating 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. +// // UpdateStream is an asynchronous operation, and takes time to complete. func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, optFns ...func(*Options)) (*UpdateStreamOutput, error) { if params == nil { @@ -39,24 +43,30 @@ type UpdateStreamInput struct { // This member is required. CurrentVersion *string - // The name of the device that is writing to the stream. In the current - // implementation, Kinesis Video Streams does not use this name. + // The name of the device that is writing to the stream. + // + // In the current implementation, Kinesis Video Streams does not use this name. DeviceName *string // 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 + // types, see [Media Types]. If you choose to specify the MediaType , see [Naming Requirements]. + // + // 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 . + // + // [Naming Requirements]: https://tools.ietf.org/html/rfc6838#section-4.2 + // [Media Types]: http://www.iana.org/assignments/media-types/media-types.xhtml MediaType *string // The ARN of the stream whose metadata you want to update. StreamARN *string - // The name of the stream whose metadata you want to update. The stream name is an - // identifier for the stream, and must be unique for each account and region. + // The name of the stream whose metadata you want to update. + // + // The stream name is an identifier for the stream, and must be unique for each + // account and region. StreamName *string noSmithyDocumentSerde diff --git a/service/kinesisvideo/options.go b/service/kinesisvideo/options.go index 92065738972..6b729197869 100644 --- a/service/kinesisvideo/options.go +++ b/service/kinesisvideo/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisvideo/types/enums.go b/service/kinesisvideo/types/enums.go index 9870c4a2de9..b090455893f 100644 --- a/service/kinesisvideo/types/enums.go +++ b/service/kinesisvideo/types/enums.go @@ -17,8 +17,9 @@ const ( ) // Values returns all known values for APIName. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (APIName) Values() []APIName { return []APIName{ "PUT_MEDIA", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for ChannelProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelProtocol) Values() []ChannelProtocol { return []ChannelProtocol{ "WSS", @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for ChannelRole. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelRole) Values() []ChannelRole { return []ChannelRole{ "MASTER", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for ChannelType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelType) Values() []ChannelType { return []ChannelType{ "SINGLE_MASTER", @@ -96,8 +100,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "BEGINS_WITH", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for ConfigurationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationStatus) Values() []ConfigurationStatus { return []ConfigurationStatus{ "ENABLED", @@ -131,8 +137,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "JPEG", @@ -148,8 +155,9 @@ const ( ) // Values returns all known values for FormatConfigKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormatConfigKey) Values() []FormatConfigKey { return []FormatConfigKey{ "JPEGQuality", @@ -165,8 +173,9 @@ const ( ) // Values returns all known values for ImageSelectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSelectorType) Values() []ImageSelectorType { return []ImageSelectorType{ "SERVER_TIMESTAMP", @@ -184,8 +193,9 @@ const ( // Values returns all known values for MediaStorageConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaStorageConfigurationStatus) Values() []MediaStorageConfigurationStatus { return []MediaStorageConfigurationStatus{ "ENABLED", @@ -202,8 +212,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -221,8 +232,9 @@ const ( ) // Values returns all known values for RecorderStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecorderStatus) Values() []RecorderStatus { return []RecorderStatus{ "SUCCESS", @@ -242,8 +254,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "CREATING", @@ -262,8 +275,9 @@ const ( ) // Values returns all known values for StrategyOnFullSize. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StrategyOnFullSize) Values() []StrategyOnFullSize { return []StrategyOnFullSize{ "DELETE_OLDEST_MEDIA", @@ -285,8 +299,9 @@ const ( ) // Values returns all known values for SyncStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncStatus) Values() []SyncStatus { return []SyncStatus{ "SYNCING", @@ -309,8 +324,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateDataRetentionOperation) Values() []UpdateDataRetentionOperation { return []UpdateDataRetentionOperation{ "INCREASE_DATA_RETENTION", @@ -328,8 +344,9 @@ const ( ) // Values returns all known values for UploaderStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UploaderStatus) Values() []UploaderStatus { return []UploaderStatus{ "SUCCESS", diff --git a/service/kinesisvideo/types/errors.go b/service/kinesisvideo/types/errors.go index 824e25f0e00..7b9bf7ca80a 100644 --- a/service/kinesisvideo/types/errors.go +++ b/service/kinesisvideo/types/errors.go @@ -278,10 +278,13 @@ 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. type ResourceInUseException struct { @@ -394,8 +397,9 @@ 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) -// API. +// latest version, use the [DescribeStream]API. +// +// [DescribeStream]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html type VersionMismatchException struct { Message *string diff --git a/service/kinesisvideo/types/types.go b/service/kinesisvideo/types/types.go index 4686c2bcd0f..5ee3be9285d 100644 --- a/service/kinesisvideo/types/types.go +++ b/service/kinesisvideo/types/types.go @@ -57,9 +57,11 @@ type DeletionConfig struct { // 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 the Amazon Web Services cloud. + // 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 + // the Amazon Web Services cloud. DeleteAfterUpload *bool // The number of hours that you want to retain the data in the stream on the Edge @@ -307,8 +309,9 @@ type MediaSourceConfig struct { MediaUriSecretArn *string // The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to - // stream local media files. Preview only supports the RTSP_URI media source URI - // format . + // stream local media files. + // + // Preview only supports the RTSP_URI media source URI format . // // This member is required. MediaUriType MediaUriType @@ -318,9 +321,11 @@ type MediaSourceConfig struct { // A structure that encapsulates, or contains, the media storage configuration // properties. +// // - If StorageStatus is enabled, the data will be stored in the StreamARN // provided. In order for WebRTC Ingestion to work, the stream must have data // retention enabled. +// // - If StorageStatus is disabled, no data will be stored, and the StreamARN // parameter will not be needed. type MediaStorageConfiguration struct { @@ -388,8 +393,9 @@ type RecorderConfig struct { } // An object that describes the endpoint of the signaling channel returned by the -// GetSignalingChannelEndpoint API. The media server endpoint will correspond to -// the WEBRTC Protocol. +// GetSignalingChannelEndpoint API. +// +// The media server endpoint will correspond to the WEBRTC Protocol. type ResourceEndpointListItem struct { // The protocol of the signaling channel returned by the @@ -405,10 +411,13 @@ type ResourceEndpointListItem struct { // This API enables you to specify the duration that the camera, or local media // file, should record onto the Edge Agent. The ScheduleConfig consists of the -// ScheduleExpression and the DurationInMinutes attributes. If the ScheduleConfig -// is not provided in the RecorderConfig , then the Edge Agent will always be set -// to recording mode. If the ScheduleConfig is not provided in the UploaderConfig , -// then the Edge Agent will upload at regular intervals (every 1 hour). +// ScheduleExpression and the DurationInMinutes attributes. +// +// If the ScheduleConfig is not provided in the RecorderConfig , then the Edge +// Agent will always be set to recording mode. +// +// If the ScheduleConfig is not provided in the UploaderConfig , then the Edge +// Agent will upload at regular intervals (every 1 hour). type ScheduleConfig struct { // The total duration to record the media. If the ScheduleExpression attribute is @@ -420,9 +429,12 @@ type ScheduleConfig struct { // 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. + // to recording mode. + // + // For more information about Quartz, refer to the [Cron Trigger Tutorial] page to understand the valid + // expressions and its use. + // + // [Cron Trigger Tutorial]: http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html // // This member is required. ScheduleExpression *string diff --git a/service/kinesisvideoarchivedmedia/api_op_GetClip.go b/service/kinesisvideoarchivedmedia/api_op_GetClip.go index 24b842760fb..644141ffe8f 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetClip.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetClip.go @@ -13,35 +13,44 @@ import ( ) // Downloads an MP4 file (clip) containing the archived, on-demand media from the -// 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 , -// specifying GET_CLIP for the APIName parameter. An Amazon Kinesis video stream -// has the following requirements for providing data through MP4: +// 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 , 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) -// . +// information, see [MPEG-4 specification ISO/IEC 14496-15]. For information about adapting stream data to a given +// format, see [NAL Adaptation Flags]. +// // - 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) -// . +// data in the AAC format ([AAC specification ISO/IEC 13818-7] ) or the [MS Wave format]. // // 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 Amazon Web Services Pricing (https://aws.amazon.com/pricing/) . Charges for -// outgoing Amazon Web Services data apply. +// CloudWatch to monitor Kinesis Video Streams, see [Monitoring Kinesis Video Streams]. For pricing information, see [Amazon Kinesis Video Streams Pricing] +// and [Amazon Web Services Pricing]. Charges for outgoing Amazon Web Services data apply. +// +// [Amazon Web Services Pricing]: https://aws.amazon.com/pricing/ +// [MPEG-4 specification ISO/IEC 14496-15]: https://www.iso.org/standard/55980.html +// [Amazon Kinesis Video Streams Pricing]: https://aws.amazon.com/kinesis/video-streams/pricing/ +// [Monitoring Kinesis Video Streams]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html +// [AAC specification ISO/IEC 13818-7]: https://www.iso.org/standard/43345.html +// [NAL Adaptation Flags]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html +// [MS Wave format]: http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html func (c *Client) GetClip(ctx context.Context, params *GetClipInput, optFns ...func(*Options)) (*GetClipOutput, error) { if params == nil { params = &GetClipInput{} @@ -65,11 +74,14 @@ type GetClipInput struct { ClipFragmentSelector *types.ClipFragmentSelector // The Amazon Resource Name (ARN) of the stream for which to retrieve the media - // clip. You must specify either the StreamName or the StreamARN. + // clip. + // + // You must specify either the StreamName or the StreamARN. StreamARN *string - // The name of the stream for which to retrieve the media clip. You must specify - // either the StreamName or the StreamARN. + // The name of the stream for which to retrieve the media clip. + // + // You must specify either the StreamName or the StreamARN. StreamName *string noSmithyDocumentSerde @@ -82,8 +94,9 @@ 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) . + // the specified start timestamp. For more information, see [Kinesis Video Streams Limits]. + // + // [Kinesis Video Streams 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 c3f63dea1b7..a8ab2aa7857 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetDASHStreamingSessionURL.go @@ -13,86 +13,106 @@ 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) -// . +// information, see [MPEG-4 specification ISO/IEC 14496-15]. For information about adapting stream data to a given +// format, see [NAL Adaptation Flags]. +// // - 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) -// . +// data in the AAC format ([AAC specification ISO/IEC 13818-7] ) or the [MS Wave format]. // // 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. +// +// - Get an endpoint using [GetDataEndpoint], 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 Amazon Web Services -// 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) . +// 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 Amazon Web Services 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]for details. +// +// For restrictions that apply to MPEG-DASH sessions, see [Kinesis Video Streams Limits]. +// // 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 Amazon Web Services Pricing (https://aws.amazon.com/pricing/) . Charges for -// both HLS sessions and outgoing Amazon Web Services 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: +// about using CloudWatch to monitor Kinesis Video Streams, see [Monitoring Kinesis Video Streams]. For pricing +// information, see [Amazon Kinesis Video Streams Pricing]and [Amazon Web Services Pricing]. Charges for both HLS sessions and outgoing Amazon Web +// Services data apply. +// +// For more information about HLS, see [HTTP Live Streaming] on the [Apple Developer site]. +// +// 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 Amazon Web // Services the support team can better diagnose the problem if given the Request // Id. @@ -100,9 +120,24 @@ import ( // 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) -// . +// 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]. +// +// [Amazon Web Services Pricing]: https://aws.amazon.com/pricing/ +// [Common Errors]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html +// [Kinesis Video Streams Limits]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html +// [MPEG-4 specification ISO/IEC 14496-15]: https://www.iso.org/standard/55980.html +// [AAC specification ISO/IEC 13818-7]: https://www.iso.org/standard/43345.html +// [HTTP Live Streaming]: https://developer.apple.com/streaming/ +// [NAL Adaptation Flags]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html +// [Apple Developer site]: https://developer.apple.com +// [Pricing]: https://aws.amazon.com/kinesis/video-streams/pricing/ +// [Amazon Kinesis Video Streams Pricing]: https://aws.amazon.com/kinesis/video-streams/pricing/ +// [Monitoring Kinesis Video Streams]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html +// [GetDataEndpoint]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html +// [MS Wave format]: http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html func (c *Client) GetDASHStreamingSessionURL(ctx context.Context, params *GetDASHStreamingSessionURLInput, optFns ...func(*Options)) (*GetDASHStreamingSessionURLOutput, error) { if params == nil { params = &GetDASHStreamingSessionURLInput{} @@ -120,8 +155,9 @@ 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 + // 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 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 @@ -133,8 +169,9 @@ type GetDASHStreamingSessionURLInput struct { // 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 - // MPEG-DASH media player is necessary to leverage these this custom attribute. The - // default value is NEVER . + // MPEG-DASH media player is necessary to leverage these this custom attribute. + // + // The default value is NEVER . DisplayFragmentNumber types.DASHDisplayFragmentNumber // Per the MPEG-DASH specification, the wall-clock time of fragments in the @@ -146,48 +183,60 @@ type GetDASHStreamingSessionURLInput struct { // 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 - // timestamps will be the server start timestamps. Similarly, when - // DASHFragmentSelector is PRODUCER_TIMESTAMP , the timestamps will be the producer - // start timestamps. + // + // The default value is NEVER . When DASHFragmentSelector is SERVER_TIMESTAMP , the timestamps will be + // the server start timestamps. Similarly, when DASHFragmentSelectoris 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). + // 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). 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 . + // 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: + // 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. + // 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 @@ -198,27 +247,33 @@ type GetDASHStreamingSessionURLInput struct { // 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 . + // 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 . + // The name of the stream for which to retrieve the MPEG-DASH manifest URL. + // + // You 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 90940b7d70a..eb04e1425f3 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetHLSStreamingSessionURL.go @@ -12,114 +12,138 @@ import ( ) // 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 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: +// // - For streaming video, 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 . For audio only streaming, the codec ID // of track 1 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) -// . +// Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format ([MPEG-4 specification ISO/IEC 14496-15] ). For +// information about adapting stream data to a given format, see [NAL Adaptation Flags]. +// // - 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) -// ). +// data in the AAC format ([AAC specification ISO/IEC 13818-7] ). // // 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. +// types, see the [HLS specification]. +// +// The following procedure shows how to use HLS with Kinesis Video Streams: +// +// - Get an endpoint using [GetDataEndpoint], 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 Amazon Web Services 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. For the HLS streaming -// session, in-track codec private data (CPD) changes are supported. After the -// first media fragment is made available in a streaming session, fragments can -// contain CPD changes for each track. Therefore, the fragments in a session can -// have a different resolution, bit rate, or other information in the CPD without -// interrupting playback. However, any change made in the track number or track -// codec format can return an error when those different media fragments are -// loaded. For example, streaming will fail if the fragments in the stream change -// from having only video to having both audio and video, or if an AAC audio track -// is changed to an ALAW audio track. For each streaming session, only 500 CPD -// changes are allowed. Data retrieved with this action is billable. For -// information, see Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) -// . +// (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 Amazon Web Services 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. +// +// For the HLS streaming session, in-track codec private data (CPD) changes are +// +// supported. After the first media fragment is made available in a streaming +// session, fragments can contain CPD changes for each track. Therefore, the +// fragments in a session can have a different resolution, bit rate, or other +// information in the CPD without interrupting playback. However, any change made +// in the track number or track codec format can return an error when those +// different media fragments are loaded. For example, streaming will fail if the +// fragments in the stream change from having only video to having both audio and +// video, or if an AAC audio track is changed to an ALAW audio track. For each +// streaming session, only 500 CPD changes are allowed. +// +// Data retrieved with this action is billable. For information, see [Pricing]. +// // - 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/) -// . +// 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]. // // 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 Amazon Web Services Pricing (https://aws.amazon.com/pricing/) . Charges for -// both HLS sessions and outgoing Amazon Web Services 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: +// limits, see [Kinesis Video Streams Limits]. +// +// 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]. For pricing +// information, see [Amazon Kinesis Video Streams Pricing]and [Amazon Web Services Pricing]. Charges for both HLS sessions and outgoing Amazon Web +// Services data apply. +// +// For more information about HLS, see [HTTP Live Streaming] on the [Apple Developer site]. +// +// 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 Amazon Web // Services, the support team can better diagnose the problem if given the Request // Id. @@ -127,9 +151,25 @@ import ( // 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) -// . +// 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]. +// +// [Amazon Web Services Pricing]: https://aws.amazon.com/pricing/ +// [Common Errors]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html +// [Kinesis Video Streams Limits]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html +// [MPEG-4 specification ISO/IEC 14496-15]: https://www.iso.org/standard/55980.html +// [HLS specification]: https://tools.ietf.org/html/draft-pantos-http-live-streaming-23 +// [AAC specification ISO/IEC 13818-7]: https://www.iso.org/standard/43345.html +// [HTTP Live Streaming]: https://developer.apple.com/streaming/ +// [NAL Adaptation Flags]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html +// [Apple Developer site]: https://developer.apple.com +// [Kinesis Video Streams pricing]: https://aws.amazon.com/kinesis/video-streams/pricing/ +// [Pricing]: https://aws.amazon.com/kinesis/video-streams/pricing/ +// [Amazon Kinesis Video Streams Pricing]: https://aws.amazon.com/kinesis/video-streams/pricing/ +// [Monitoring Kinesis Video Streams]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html +// [GetDataEndpoint]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html func (c *Client) GetHLSStreamingSessionURL(ctx context.Context, params *GetHLSStreamingSessionURLInput, optFns ...func(*Options)) (*GetHLSStreamingSessionURLOutput, error) { if params == nil { params = &GetHLSStreamingSessionURLInput{} @@ -154,33 +194,41 @@ type GetHLSStreamingSessionURLInput struct { // 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 . 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: + // 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 HLSFragmentSelectoris 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 . + // + // 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 @@ -189,21 +237,26 @@ type GetHLSStreamingSessionURLInput struct { // 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 HLSFragmentSelectoris 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). + // 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). 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 + // 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 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 @@ -211,35 +264,44 @@ type GetHLSStreamingSessionURLInput struct { 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 . + // 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: + // 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. + // 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 @@ -250,27 +312,34 @@ type GetHLSStreamingSessionURLInput struct { // 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 . + // 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 . + // The name of the stream for which to retrieve the HLS master playlist URL. + // + // You 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 bb95eb0d6ad..43638f5c77a 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetImages.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetImages.go @@ -72,9 +72,11 @@ 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 25 - // images per API response. Providing a MaxResults greater than this value will - // result in a page size of 25. Any additional results will be paginated. + // The maximum number of images to be returned by the API. + // + // The default limit is 25 images per API response. Providing a MaxResults greater + // than this value will result in a page size of 25. Any additional results will be + // paginated. MaxResults *int64 // A token that specifies where to start paginating the next set of Images. This @@ -211,9 +213,11 @@ var _ GetImagesAPIClient = (*Client)(nil) // GetImagesPaginatorOptions is the paginator options for GetImages type GetImagesPaginatorOptions struct { - // The maximum number of images to be returned by the API. The default limit is 25 - // images per API response. Providing a MaxResults greater than this value will - // result in a page size of 25. Any additional results will be paginated. + // The maximum number of images to be returned by the API. + // + // The default limit is 25 images per API response. Providing a MaxResults greater + // than this value will result in a page size of 25. Any additional results will be + // paginated. Limit int64 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go b/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go index 76594086035..584e09aaa57 100644 --- a/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go +++ b/service/kinesisvideoarchivedmedia/api_op_GetMediaForFragmentList.go @@ -12,15 +12,20 @@ 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 +// 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]. +// +// For limits, see [Kinesis Video Streams Limits]. +// +// 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 Amazon Web // Services, the support team can better diagnose the problem if given the Request // Id. @@ -28,9 +33,14 @@ import ( // 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) -// . +// 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]. +// +// [--endpoint-url parameter]: https://docs.aws.amazon.com/cli/latest/reference/ +// [Common Errors]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html +// [Kinesis Video Streams Limits]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html func (c *Client) GetMediaForFragmentList(ctx context.Context, params *GetMediaForFragmentListInput, optFns ...func(*Options)) (*GetMediaForFragmentListOutput, error) { if params == nil { params = &GetMediaForFragmentListInput{} @@ -49,7 +59,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 @@ -71,19 +81,28 @@ 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 - // call also include the following additional Matroska (MKV) tags: + // specified stream. For information about the chunks, see [PutMedia]. 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. + // // 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 + // // - AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception + // + // [PutMedia]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html 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 e6ac0631265..8a639c41f7f 100644 --- a/service/kinesisvideoarchivedmedia/api_op_ListFragments.go +++ b/service/kinesisvideoarchivedmedia/api_op_ListFragments.go @@ -11,19 +11,24 @@ 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 -// 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 -// information: +// 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]. +// +// 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 Amazon Web // Services, the support team can better diagnose the problem if given the Request // Id. @@ -31,9 +36,13 @@ import ( // 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) -// . +// 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]. +// +// [--endpoint-url parameter]: https://docs.aws.amazon.com/cli/latest/reference/ +// [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{} @@ -52,17 +61,18 @@ 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. This is only required when the NextToken isn't passed in the API. + // to return. + // + // This is only required when the NextToken isn't passed in the API. 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 - // ListFragmentsOutput$NextToken is provided in the output that you can use to - // resume pagination. + // 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 - // A token to specify where to start paginating. This is the - // ListFragmentsOutput$NextToken from a previously truncated response. + // A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously + // truncated response. NextToken *string // The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment @@ -78,8 +88,8 @@ type ListFragmentsInput struct { type ListFragmentsOutput struct { - // A list of archived Fragment objects from the stream that meet the selector - // criteria. Results are in no specific order, even across pages. + // A list of archived Fragment objects from the stream that meet the selector criteria. + // Results are in no specific order, even across pages. Fragments []types.Fragment // If the returned list is truncated, the operation returns this token to use to @@ -182,9 +192,8 @@ var _ ListFragmentsAPIClient = (*Client)(nil) // ListFragmentsPaginatorOptions is the paginator options for ListFragments type ListFragmentsPaginatorOptions struct { // 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 - // ListFragmentsOutput$NextToken is provided in the output that you can use to - // resume pagination. + // 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. Limit int64 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kinesisvideoarchivedmedia/options.go b/service/kinesisvideoarchivedmedia/options.go index b277a36e668..0fcb8bcff14 100644 --- a/service/kinesisvideoarchivedmedia/options.go +++ b/service/kinesisvideoarchivedmedia/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisvideoarchivedmedia/types/enums.go b/service/kinesisvideoarchivedmedia/types/enums.go index b3e91bf106d..ecc4e2fb8ed 100644 --- a/service/kinesisvideoarchivedmedia/types/enums.go +++ b/service/kinesisvideoarchivedmedia/types/enums.go @@ -12,6 +12,7 @@ const ( // 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{ @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ContainerFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerFormat) Values() []ContainerFormat { return []ContainerFormat{ "FRAGMENTED_MP4", @@ -48,6 +50,7 @@ const ( // Values returns all known values for DASHDisplayFragmentNumber. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DASHDisplayFragmentNumber) Values() []DASHDisplayFragmentNumber { return []DASHDisplayFragmentNumber{ @@ -66,8 +69,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DASHDisplayFragmentTimestamp) Values() []DASHDisplayFragmentTimestamp { return []DASHDisplayFragmentTimestamp{ "ALWAYS", @@ -85,6 +89,7 @@ const ( // 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{ @@ -103,8 +108,9 @@ const ( ) // Values returns all known values for DASHPlaybackMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DASHPlaybackMode) Values() []DASHPlaybackMode { return []DASHPlaybackMode{ "LIVE", @@ -122,8 +128,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "JPEG", @@ -139,8 +146,9 @@ const ( ) // Values returns all known values for FormatConfigKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormatConfigKey) Values() []FormatConfigKey { return []FormatConfigKey{ "JPEGQuality", @@ -156,8 +164,9 @@ const ( ) // Values returns all known values for FragmentSelectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FragmentSelectorType) Values() []FragmentSelectorType { return []FragmentSelectorType{ "PRODUCER_TIMESTAMP", @@ -175,8 +184,9 @@ const ( ) // Values returns all known values for HLSDiscontinuityMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HLSDiscontinuityMode) Values() []HLSDiscontinuityMode { return []HLSDiscontinuityMode{ "ALWAYS", @@ -195,6 +205,7 @@ const ( // Values returns all known values for HLSDisplayFragmentTimestamp. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HLSDisplayFragmentTimestamp) Values() []HLSDisplayFragmentTimestamp { return []HLSDisplayFragmentTimestamp{ @@ -212,8 +223,9 @@ const ( ) // Values returns all known values for HLSFragmentSelectorType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HLSFragmentSelectorType) Values() []HLSFragmentSelectorType { return []HLSFragmentSelectorType{ "PRODUCER_TIMESTAMP", @@ -231,8 +243,9 @@ const ( ) // Values returns all known values for HLSPlaybackMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HLSPlaybackMode) Values() []HLSPlaybackMode { return []HLSPlaybackMode{ "LIVE", @@ -250,8 +263,9 @@ const ( ) // Values returns all known values for ImageError. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageError) Values() []ImageError { return []ImageError{ "NO_MEDIA", @@ -268,8 +282,9 @@ const ( ) // Values returns all known values for ImageSelectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSelectorType) Values() []ImageSelectorType { return []ImageSelectorType{ "PRODUCER_TIMESTAMP", diff --git a/service/kinesisvideoarchivedmedia/types/errors.go b/service/kinesisvideoarchivedmedia/types/errors.go index 5e3c37a2fee..ac8198478a7 100644 --- a/service/kinesisvideoarchivedmedia/types/errors.go +++ b/service/kinesisvideoarchivedmedia/types/errors.go @@ -8,9 +8,9 @@ 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) -// . +// limit. Try making the call later. For information about limits, see [Kinesis Video Streams Limits]. +// +// [Kinesis Video Streams Limits]: http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html type ClientLimitExceededException struct { Message *string @@ -198,11 +198,13 @@ func (e *NotAuthorizedException) ErrorCode() string { func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // GetImages will throw 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. +// 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. type ResourceNotFoundException struct { Message *string diff --git a/service/kinesisvideoarchivedmedia/types/types.go b/service/kinesisvideoarchivedmedia/types/types.go index 95083424115..6fce0fd744c 100644 --- a/service/kinesisvideoarchivedmedia/types/types.go +++ b/service/kinesisvideoarchivedmedia/types/types.go @@ -8,6 +8,7 @@ import ( ) // Describes the timestamp range and timestamp origin of a range of fragments. +// // Fragments that have duplicate producer timestamps are deduplicated. This means // that if producers are producing a stream of fragments with producer timestamps // that are approximately equal to the true clock time, the clip will contain all @@ -32,22 +33,26 @@ type ClipFragmentSelector struct { // The range of timestamps for which to return fragments. 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 - // StartTimestamp value. If FragmentSelectorType for the request is - // 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. + // 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 StartTimestamp value. If FragmentSelectorType for the request + // is 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. // // 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. + // 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 @@ -59,56 +64,70 @@ type ClipTimestampRange struct { // timestamps. 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 - // GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are included. + // 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$TimestampRangeis 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$MaxManifestFragmentResultsvalue) are included. + // // Fragments that have duplicate producer timestamps are deduplicated. This means // that if producers are producing a stream of fragments with producer timestamps // that are approximately equal to the true clock time, the MPEG-DASH manifest will // contain all of the fragments within the requested timestamp 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 - // 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 . + // 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 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 . FragmentSelectorType DASHFragmentSelectorType - // The start and end of the timestamp range for the requested media. This value - // should not be present if PlaybackType is LIVE . + // The start and end of the timestamp range for the requested media. + // + // This value 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 -// 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. +// 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 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 - // StartTimestamp value. If FragmentSelectorType for the request 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 - // 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. + // StartTimestamp value. + // + // If FragmentSelectorType for the request 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 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. EndTimestamp *time.Time - // The start of the timestamp range for the requested media. If the - // DASHTimestampRange value is specified, the StartTimestamp value is required. + // 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 , @@ -142,12 +161,17 @@ type Fragment struct { } // 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 @@ -171,53 +195,66 @@ type FragmentSelector struct { // timestamps. 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 - // 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 - // GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults 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 that are approximately equal to the true clock time, the HLS media - // playlists will contain all of the fragments within the requested timestamp - // 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 . + // 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 within the + // specified FragmentSelector$TimestampRangeis included in the media playlist. In addition, the fragments with + // producer timestamps within the TimestampRange ingested immediately following + // the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResultsvalue) are included. + // + // Fragments that have duplicate producer timestamps are deduplicated. This means + // that if producers are producing a stream of fragments with producer timestamps + // that are approximately equal to the true clock time, the HLS media playlists + // will contain all of the fragments within the requested timestamp 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 . FragmentSelectorType HLSFragmentSelectorType - // The start and end of the timestamp range for the requested media. This value - // should not be present if PlaybackType is LIVE . + // The start and end of the timestamp range for the requested media. + // + // This value 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 . +// The start and end of the timestamp range for the requested media. +// +// This value 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 - // StartTimestamp value. If FragmentSelectorType for the request 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 - // 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. + // StartTimestamp value. + // + // If FragmentSelectorType for the request 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 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. EndTimestamp *time.Time - // The start of the timestamp range for the requested media. If the - // HLSTimestampRange value is specified, the StartTimestamp value is required. + // 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 , @@ -232,6 +269,7 @@ 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 . // // - The media for the specified time does not allow an image to be extracted. diff --git a/service/kinesisvideomedia/api_op_GetMedia.go b/service/kinesisvideomedia/api_op_GetMedia.go index 6e3936cf536..f2081d77e26 100644 --- a/service/kinesisvideomedia/api_op_GetMedia.go +++ b/service/kinesisvideomedia/api_op_GetMedia.go @@ -12,36 +12,48 @@ import ( "io" ) -// Use this API to retrieve media content from a Kinesis video stream. In the +// Use this API to retrieve media content from a Kinesis video stream. In the +// // request, you identify the stream name or stream Amazon Resource Name (ARN), and // 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/) . +// 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]. +// // 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]. 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. // // 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) -// . +// 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]. +// +// [PutMedia]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html +// [--endpoint-url parameter]: https://docs.aws.amazon.com/cli/latest/reference/ +// [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{} @@ -80,33 +92,52 @@ type GetMediaOutput struct { // The content type of the requested media. ContentType *string - // The payload Kinesis Video Streams returns is a sequence of chunks from the + // The payload Kinesis Video Streams returns is a sequence of chunks from the // 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 Payload io.ReadCloser diff --git a/service/kinesisvideomedia/options.go b/service/kinesisvideomedia/options.go index f8da0363744..20fad707a4c 100644 --- a/service/kinesisvideomedia/options.go +++ b/service/kinesisvideomedia/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisvideomedia/types/enums.go b/service/kinesisvideomedia/types/enums.go index d2335d2c31c..af4cb7f33bd 100644 --- a/service/kinesisvideomedia/types/enums.go +++ b/service/kinesisvideomedia/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for StartSelectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StartSelectorType) Values() []StartSelectorType { return []StartSelectorType{ "FRAGMENT_NUMBER", diff --git a/service/kinesisvideomedia/types/errors.go b/service/kinesisvideomedia/types/errors.go index ede94082e0d..43e7e723814 100644 --- a/service/kinesisvideomedia/types/errors.go +++ b/service/kinesisvideomedia/types/errors.go @@ -87,7 +87,8 @@ func (e *InvalidArgumentException) ErrorCode() string { } func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Status Code: 400, Caller used wrong endpoint to write data to a stream. On +// Status Code: 400, Caller used wrong endpoint to write data to a stream. On +// // receiving such an exception, the user must call GetDataEndpoint with AccessMode // set to "READ" and use the endpoint Kinesis Video returns in the next GetMedia // call. diff --git a/service/kinesisvideomedia/types/types.go b/service/kinesisvideomedia/types/types.go index 49814256606..ca50088b93f 100644 --- a/service/kinesisvideomedia/types/types.go +++ b/service/kinesisvideomedia/types/types.go @@ -10,9 +10,12 @@ import ( // 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 @@ -21,14 +24,20 @@ 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 . // diff --git a/service/kinesisvideosignaling/api_op_GetIceServerConfig.go b/service/kinesisvideosignaling/api_op_GetIceServerConfig.go index 6d73c1466d9..5d6ca566775 100644 --- a/service/kinesisvideosignaling/api_op_GetIceServerConfig.go +++ b/service/kinesisvideosignaling/api_op_GetIceServerConfig.go @@ -15,15 +15,19 @@ import ( // information, including URIs, username, and password which can be used to // configure the WebRTC connection. The ICE component uses this configuration // information to setup the WebRTC connection, including authenticating with the -// Traversal Using Relays around NAT (TURN) relay server. TURN is a protocol that -// 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. +// Traversal Using Relays around NAT (TURN) relay server. +// +// TURN is a protocol that 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]. +// +// 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. +// +// [A REST API For Access To TURN Services]: https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00 func (c *Client) GetIceServerConfig(ctx context.Context, params *GetIceServerConfigInput, optFns ...func(*Options)) (*GetIceServerConfigOutput, error) { if params == nil { params = &GetIceServerConfigInput{} diff --git a/service/kinesisvideosignaling/options.go b/service/kinesisvideosignaling/options.go index adbe7cd35e6..303d56025de 100644 --- a/service/kinesisvideosignaling/options.go +++ b/service/kinesisvideosignaling/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisvideosignaling/types/enums.go b/service/kinesisvideosignaling/types/enums.go index e2228d17c5b..6e2ad125e53 100644 --- a/service/kinesisvideosignaling/types/enums.go +++ b/service/kinesisvideosignaling/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for Service. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Service) Values() []Service { return []Service{ "TURN", diff --git a/service/kinesisvideosignaling/types/types.go b/service/kinesisvideosignaling/types/types.go index 83b06041121..69dedc077cb 100644 --- a/service/kinesisvideosignaling/types/types.go +++ b/service/kinesisvideosignaling/types/types.go @@ -16,10 +16,10 @@ type IceServer struct { // valid. 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. + // An array of URIs, in the form specified in the [I-D.petithuguenin-behave-turn-uris] 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 Uris []string // A username to login to the ICE server. diff --git a/service/kinesisvideowebrtcstorage/api_op_JoinStorageSession.go b/service/kinesisvideowebrtcstorage/api_op_JoinStorageSession.go index 63914311355..39980a96a7f 100644 --- a/service/kinesisvideowebrtcstorage/api_op_JoinStorageSession.go +++ b/service/kinesisvideowebrtcstorage/api_op_JoinStorageSession.go @@ -10,21 +10,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Join the ongoing one way-video and/or multi-way audio WebRTC session as a video -// producing device for an input channel. If there’s no existing session for the -// channel, a new streaming session needs to be created, and the Amazon Resource -// Name (ARN) of the signaling channel must be provided. Currently for the -// SINGLE_MASTER type, a video producing device is able to ingest both audio and -// video media into a stream, while viewers can only ingest audio. Both a video -// producing device and viewers can join the session first, and wait for other -// participants. While participants are having peer to peer conversations through -// webRTC, the ingested media session will be stored into the Kinesis Video Stream. -// Multiple viewers are able to playback real-time media. Customers can also use -// existing Kinesis Video Streams features like HLS or DASH playback, Image -// generation, and more with ingested WebRTC media. Assume that only one video -// producing device client can be associated with a session for the channel. If -// more than one client joins the session of a specific channel as a video -// producing device, the most recent client request takes precedence. +// Join the ongoing one way-video and/or multi-way audio WebRTC session as a +// +// video producing device for an input channel. If there’s no existing session for +// the channel, a new streaming session needs to be created, and the Amazon +// Resource Name (ARN) of the signaling channel must be provided. +// +// Currently for the SINGLE_MASTER type, a video producing device is able to +// ingest both audio and video media into a stream, while viewers can only ingest +// audio. Both a video producing device and viewers can join the session first, and +// wait for other participants. +// +// While participants are having peer to peer conversations through webRTC, the +// ingested media session will be stored into the Kinesis Video Stream. Multiple +// viewers are able to playback real-time media. +// +// Customers can also use existing Kinesis Video Streams features like HLS or DASH +// playback, Image generation, and more with ingested WebRTC media. +// +// Assume that only one video producing device client can be associated with a +// session for the channel. If more than one client joins the session of a specific +// channel as a video producing device, the most recent client request takes +// precedence. func (c *Client) JoinStorageSession(ctx context.Context, params *JoinStorageSessionInput, optFns ...func(*Options)) (*JoinStorageSessionOutput, error) { if params == nil { params = &JoinStorageSessionInput{} @@ -42,7 +49,7 @@ func (c *Client) JoinStorageSession(ctx context.Context, params *JoinStorageSess type JoinStorageSessionInput struct { - // The Amazon Resource Name (ARN) of the signaling channel. + // The Amazon Resource Name (ARN) of the signaling channel. // // This member is required. ChannelArn *string diff --git a/service/kinesisvideowebrtcstorage/options.go b/service/kinesisvideowebrtcstorage/options.go index 31c132932f3..af6c88dbc04 100644 --- a/service/kinesisvideowebrtcstorage/options.go +++ b/service/kinesisvideowebrtcstorage/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kinesisvideowebrtcstorage/types/errors.go b/service/kinesisvideowebrtcstorage/types/errors.go index 91195890163..3f8c01d1cd8 100644 --- a/service/kinesisvideowebrtcstorage/types/errors.go +++ b/service/kinesisvideowebrtcstorage/types/errors.go @@ -33,7 +33,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Kinesis Video Streams has throttled the request because you have exceeded the +// Kinesis Video Streams has throttled the request because you have exceeded the +// // limit of allowed client calls. Try making the call later. type ClientLimitExceededException struct { Message *string diff --git a/service/kms/api_op_CancelKeyDeletion.go b/service/kms/api_op_CancelKeyDeletion.go index 4cabfbcbbe6..34d958bc941 100644 --- a/service/kms/api_op_CancelKeyDeletion.go +++ b/service/kms/api_op_CancelKeyDeletion.go @@ -11,19 +11,28 @@ 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 -// 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 -// 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) -// (key policy) Related operations: ScheduleKeyDeletion Eventual consistency: The -// KMS API follows an eventual consistency model. For more information, see KMS -// eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// 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] +// 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]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] (key policy) +// +// Related operations: ScheduleKeyDeletion +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:CancelKeyDeletion]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Deleting KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) CancelKeyDeletion(ctx context.Context, params *CancelKeyDeletionInput, optFns ...func(*Options)) (*CancelKeyDeletionOutput, error) { if params == nil { params = &CancelKeyDeletionInput{} @@ -41,12 +50,18 @@ func (c *Client) CancelKeyDeletion(ctx context.Context, params *CancelKeyDeletio 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string @@ -56,8 +71,9 @@ 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] ) of the KMS key whose deletion is canceled. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 92021a497b1..12faa6b1bf0 100644 --- a/service/kms/api_op_ConnectCustomKeyStore.go +++ b/service/kms/api_op_ConnectCustomKeyStore.go @@ -10,66 +10,99 @@ 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) -// 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 -// proxy that communicates with your external key manager. The custom key store -// must be connected before you can create KMS keys in the key store or use the KMS -// keys it contains. You can disconnect and reconnect a custom key store at any -// time. The connection process for a custom key store can take an extended amount -// of time to complete. This operation starts the connection process, but it does -// not wait for it to complete. When it succeeds, this operation quickly returns an +// Connects or reconnects a [custom key store] 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 proxy that communicates with your external key manager. +// +// The custom key store must be connected before you can create KMS keys in the +// key store or use the KMS keys it contains. You can disconnect and reconnect a +// custom key store at any time. +// +// The connection process for a custom key store can take an extended amount of +// time to complete. This operation starts the connection process, but it does not +// wait for it to complete. When it succeeds, this operation quickly returns an // 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) -// 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 -// 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 -// for an CloudHSM key store, KMS finds the CloudHSM cluster that is associated -// with the custom key store, creates the connection infrastructure, connects to -// 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) +// state of the custom key store, use the DescribeCustomKeyStoresoperation. +// +// This operation is part of the [custom key stores] 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 DescribeCustomKeyStoresoperation and see the ConnectionErrorCode in the response. For +// help interpreting the ConnectionErrorCode , see CustomKeyStoresListEntry. +// +// To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, +// correct the error, use the UpdateCustomKeyStoreoperation if necessary, and then use +// ConnectCustomKeyStore again. +// +// # CloudHSM key store +// +// During the connection process for an CloudHSM key store, KMS finds the CloudHSM +// cluster that is associated with the custom key store, creates the connection +// infrastructure, connects to 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] +// operation. To add HSMs to the cluster, use the [CreateHsm]operation. Also, the [kmsuser crypto user]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 -// 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) -// 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) -// (IAM policy) Related operations -// - CreateCustomKeyStore -// - DeleteCustomKeyStore -// - DescribeCustomKeyStores -// - DisconnectCustomKeyStore -// - UpdateCustomKeyStore +// account to log in. +// +// If you are having trouble connecting or disconnecting a CloudHSM key store, see [Troubleshooting an CloudHSM key store] +// 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]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] (IAM policy) +// +// # Related operations +// +// # CreateCustomKeyStore +// +// # DeleteCustomKeyStore +// +// # DescribeCustomKeyStores +// +// # DisconnectCustomKeyStore +// +// # UpdateCustomKeyStore // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [DescribeClusters]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html +// [custom key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html +// [kmsuser crypto user]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser +// [Troubleshooting an CloudHSM key store]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html +// [CreateHsm]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html +// [kms:ConnectCustomKeyStore]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Troubleshooting an external key store]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) ConnectCustomKeyStore(ctx context.Context, params *ConnectCustomKeyStoreInput, optFns ...func(*Options)) (*ConnectCustomKeyStoreOutput, error) { if params == nil { params = &ConnectCustomKeyStoreInput{} @@ -88,7 +121,7 @@ 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. + // find the ID of a custom key store, use the DescribeCustomKeyStoresoperation. // // This member is required. CustomKeyStoreId *string diff --git a/service/kms/api_op_CreateAlias.go b/service/kms/api_op_CreateAlias.go index 1ef799fb995..a533b6991d0 100644 --- a/service/kms/api_op_CreateAlias.go +++ b/service/kms/api_op_CreateAlias.go @@ -10,41 +10,62 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// 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). -// -// 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 +// 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]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], 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]in the Key Management Service Developer Guide. +// +// This operation does not return a response. To get the alias that you created, +// use the ListAliasesoperation. +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see [Key states of KMS keys]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] +// - on the alias (IAM policy). +// +// [kms:CreateAlias] +// - on the KMS key (key policy). +// +// For details, see [Controlling access to aliases] in the Key Management Service Developer Guide. +// +// Related operations: +// +// # DeleteAlias +// +// # ListAliases +// +// # UpdateAlias // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [Using aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html +// [kms:CreateAlias]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Controlling access to aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error) { if params == nil { params = &CreateAliasInput{} @@ -63,27 +84,43 @@ 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 . Do not include confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. 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) - // . + // such as alias/ExampleAlias . + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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]. + // + // [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 - // 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) - // in the Key Management Service Developer Guide . Specify the key ID or key ARN of - // the KMS key. For example: + // Associates the alias with the specified [customer managed key]. 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] 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // + // [customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk + // [Finding the Key ID and ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn // // This member is required. TargetKeyId *string diff --git a/service/kms/api_op_CreateCustomKeyStore.go b/service/kms/api_op_CreateCustomKeyStore.go index 00679206d4c..49b072e60b0 100644 --- a/service/kms/api_op_CreateCustomKeyStore.go +++ b/service/kms/api_op_CreateCustomKeyStore.go @@ -11,67 +11,90 @@ 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) -// 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) -// 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) -// 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 +// Creates a [custom key store] 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] +// backed by an [CloudHSM cluster]and [external key stores] 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] 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) -// in the Key Management Service Developer Guide. To create a custom key store, use -// the following parameters. +// required elements and verification tests, see [Assemble the prerequisites (for CloudHSM key stores)]or [Assemble the prerequisites (for external key stores)] 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. +// failures, see [Troubleshooting an CloudHSM key store]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 help with failures, see [Troubleshooting an external key store]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] 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] (IAM policy). +// +// Related operations: // -// 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) -// (IAM policy). Related operations: -// - ConnectCustomKeyStore -// - DeleteCustomKeyStore -// - DescribeCustomKeyStores -// - DisconnectCustomKeyStore -// - UpdateCustomKeyStore +// # ConnectCustomKeyStore +// +// # DeleteCustomKeyStore +// +// # DescribeCustomKeyStores +// +// # DisconnectCustomKeyStore +// +// # UpdateCustomKeyStore // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [CloudHSM key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html +// [CloudHSM cluster]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html +// [custom key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html +// [external key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html +// [Troubleshooting an CloudHSM key store]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html +// [Assemble the prerequisites (for CloudHSM key stores)]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore +// [Assemble the prerequisites (for external key stores)]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements +// [Troubleshooting a custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html +// [Troubleshooting an external key store]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html +// [kms:CreateCustomKeyStore]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) CreateCustomKeyStore(ctx context.Context, params *CreateCustomKeyStoreInput, optFns ...func(*Options)) (*CreateCustomKeyStoreOutput, error) { if params == nil { params = &CreateCustomKeyStoreInput{} @@ -91,96 +114,125 @@ type CreateCustomKeyStoreInput struct { // Specifies a friendly name for the custom key store. The name must be unique in // your Amazon Web Services account and Region. This parameter is required for all - // custom key stores. Do not include confidential or sensitive information in this - // field. This field may be displayed in plaintext in CloudTrail logs and other - // output. + // custom key stores. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. // // This member is required. 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 - // 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) - // operation. + // 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]operation. + // + // [DescribeClusters]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html 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 - // property after the key store is created. + // 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) - // 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 - // account password; it does not change the password in the CloudHSM cluster. + // required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM . + // + // Enter the password of the [kmsuser crypto user (CU) account]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 account password; it does not change the + // password in the CloudHSM cluster. + // + // [kmsuser crypto user (CU) account]: https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser 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 - // 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) - // . + // 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]. + // + // [initialized the 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 - // 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. + // 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) - // 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 - // a Amazon VPC with multiple subnets, a VPC endpoint service, a network load - // balancer, and a verified private DNS name. A public endpoint is simpler to set - // up, but it might be slower and might not fulfill your security requirements. You - // might consider testing with a public endpoint, and then establishing a VPC - // endpoint service for production tasks. Note that this choice does not determine - // the location of the external key store proxy. Even if you choose a VPC endpoint - // service, the proxy can be hosted within the VPC or outside of Amazon Web - // Services such as in your corporate data center. + // 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]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 a Amazon VPC with multiple subnets, a VPC + // endpoint service, a network load balancer, and a verified private DNS name. A + // public endpoint is simpler to set up, but it might be slower and might not + // fulfill your security requirements. You might consider testing with a public + // endpoint, and then establishing a VPC endpoint service for production tasks. + // Note that this choice does not determine the location of the external key store + // proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within + // the VPC or outside of Amazon Web Services such as in your corporate data center. + // + // [Choosing a connectivity option]: https://docs.aws.amazon.com/kms/latest/developerguide/plan-xks-keystore.html#choose-xks-connectivity XksProxyConnectivity types.XksProxyConnectivityType // 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 - // 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: + // 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 this 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 @@ -190,10 +242,14 @@ type CreateCustomKeyStoreInput struct { // 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 - // 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: + // 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. XksProxyUriPath *string @@ -201,12 +257,17 @@ type CreateCustomKeyStoreInput struct { // 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) - // for use with an external key store. Uniqueness requirements: + // and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE . + // + // The Amazon VPC endpoint service must [fulfill all 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. + // + // [fulfill all requirements]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keystore.html#xks-requirements XksProxyVpcEndpointServiceName *string noSmithyDocumentSerde diff --git a/service/kms/api_op_CreateGrant.go b/service/kms/api_op_CreateGrant.go index 691a17b45aa..86de7bf6b0e 100644 --- a/service/kms/api_op_CreateGrant.go +++ b/service/kms/api_op_CreateGrant.go @@ -11,45 +11,65 @@ 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 -// 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 . +// 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] in the +// Key Management Service Developer Guide . For examples of working with grants in +// several programming languages, see [Programming grants]. +// +// 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. +// 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]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 RetireGrantand RevokeGrantoperations. To find the +// grant ID, use the ListGrantsor ListRetirableGrantsoperations. // // 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 +// For details, see [Key states of KMS keys]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] (key policy) +// +// Related operations: +// +// # ListGrants +// +// # ListRetirableGrants +// +// # RetireGrant +// +// # RevokeGrant // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Programming grants]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [Grants in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html +// [kms:CreateGrant]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// +// [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optFns ...func(*Options)) (*CreateGrantOutput, error) { if params == nil { params = &CreateGrantInput{} @@ -67,100 +87,133 @@ func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optF type CreateGrantInput struct { - // The identity that gets the permissions specified in the grant. To specify the - // 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) - // in the Identity and Access Management User Guide . + // The identity that gets the permissions specified in the grant. + // + // To specify the 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]in the Identity and Access + // Management User Guide . + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns // // This member is required. GranteePrincipal *string // Identifies the KMS key for the grant. The grant gives principals permission to - // 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string - // A list of operations that the grant permits. This list must include only - // operations that are permitted in a grant. Also, the operation must be supported - // 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) - // in the Key Management Service Developer Guide. + // A list of operations that the grant permits. + // + // This list must include only operations that are permitted in a grant. Also, the + // operation must be supported on the KMS key. For example, you cannot create a + // grant for a symmetric encryption KMS key that allows the Signoperation, or a grant + // for an asymmetric KMS key that allows the GenerateDataKeyoperation. If you try, KMS returns a + // ValidationError exception. For details, see [Grant operations] in the Key Management Service + // Developer Guide. + // + // [Grant operations]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations // // This member is required. Operations []types.GrantOperation - // Specifies a grant constraint. Do not include confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. KMS supports the EncryptionContextEquals and - // EncryptionContextSubset grant constraints, which allow the permissions in the - // grant only when the encryption context in the request matches ( - // EncryptionContextEquals ) or includes ( EncryptionContextSubset ) the encryption - // context specified in the constraint. 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 - // permission have an equally strict or stricter encryption context constraint. You - // cannot use an encryption context grant constraint for cryptographic operations - // with asymmetric KMS keys or HMAC KMS keys. Operations with these keys don't - // support an encryption context. 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) - // 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) - // in the Key Management Service Developer Guide . + // Specifies a grant constraint. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // KMS supports the EncryptionContextEquals and EncryptionContextSubset grant + // constraints, which allow the permissions in the grant only when the encryption + // context in the request matches ( EncryptionContextEquals ) or includes ( + // EncryptionContextSubset ) the encryption context specified in the constraint. + // + // The encryption context grant constraints are supported only on [grant operations] that include an + // EncryptionContext parameter, such as cryptographic operations on symmetric + // encryption KMS keys. Grants with grant constraints can include the DescribeKeyand 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 permission have an + // equally strict or stricter encryption context constraint. + // + // You cannot use an encryption context grant constraint for cryptographic + // operations with asymmetric KMS keys or HMAC KMS keys. Operations with these keys + // don't support an encryption context. + // + // 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]in the Key Management Service + // Developer Guide. For more information about encryption context, see [Encryption context]in the Key + // Management Service Developer Guide . + // + // [grant operations]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations + // [Using grant constraints]: https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Constraints *types.GrantConstraints - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string // A friendly name for the grant. Use this value to prevent the unintended - // creation of duplicate grants when retrying this request. Do not include - // confidential or sensitive information in this field. This field may be displayed - // in plaintext in CloudTrail logs and other output. 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. + // creation of duplicate grants when retrying this request. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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) - // 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) - // in the Key Management Service Developer Guide. + // The principal that has permission to use the RetireGrant operation to retire the grant. + // + // To specify the 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]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 RevokeGrantand [Retiring and revoking grants] in + // the Key Management Service Developer Guide. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // [Retiring and revoking grants]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete RetiringPrincipal *string noSmithyDocumentSerde @@ -168,15 +221,19 @@ 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantToken *string // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_CreateKey.go b/service/kms/api_op_CreateKey.go index 85bf140354b..8067e00d7d4 100644 --- a/service/kms/api_op_CreateKey.go +++ b/service/kms/api_op_CreateKey.go @@ -11,129 +11,173 @@ 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) -// 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, -// 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 -// different types of KMS keys, use the following guidance: Symmetric encryption -// 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 -// 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, -// 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 -// after the KMS key is created. Asymmetric KMS keys contain an RSA key pair, -// Elliptic Curve (ECC) key pair, or an SM2 key pair (China Regions only). The -// private key in an asymmetric KMS key never leaves KMS unencrypted. However, you -// can use the GetPublicKey operation to download the public key so it can be used -// 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) -// 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 -// 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. 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. 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) -// in the Key Management Service Developer Guide. To import your own key material -// into a KMS key, begin by creating a 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 import token. Use the -// wrapping 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 . You can import key material into -// KMS keys of 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 -// import key material into a KMS key in a custom key store. 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) -// 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) -// 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) -// 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 -// key in an external key store, you specify an existing encryption key in the -// 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 -// 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 -// 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) -// (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) -// in the Key Management Service Developer Guide. Related operations: -// - DescribeKey -// - ListKeys -// - ScheduleKeyDeletion +// Creates a unique customer managed [KMS key] 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]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 different types of KMS keys, use the following guidance: +// +// Symmetric encryption 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 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 GenerateDataKeyand 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 after the KMS key is +// created. +// +// Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, or +// an SM2 key pair (China Regions only). The private key in an asymmetric KMS key +// never leaves KMS unencrypted. However, you can use the GetPublicKeyoperation to download +// the public key so it can be used 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]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 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. +// +// 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 ReplicateKeyoperation. To change a replica +// key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegionoperation. +// +// 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. +// +// 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]in the Key Management Service Developer Guide. +// +// To import your own key material into a KMS key, begin by creating a 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 import token. +// Use the wrapping public key to encrypt your key material. Then, use ImportKeyMaterialwith your +// import token to import the key material. For step-by-step instructions, see [Importing Key Material]in +// the Key Management Service Developer Guide . +// +// You can import key material into KMS keys of 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 import key material into a KMS key in +// a custom key store. +// +// 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 ReplicateKeyoperation. For instructions, see [Importing key material into multi-Region keys]. For more information about multi-Region +// keys, see [Multi-Region keys in KMS]in the Key Management Service Developer Guide. +// +// Custom key store A [custom key store] 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] backed by an CloudHSM cluster and [external key stores] 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 key in an external key +// store, you specify an existing encryption key in the 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 symmetric encryption key. No other key type is +// supported in a custom key store. +// +// To create a KMS key in an [CloudHSM key store], 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], 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] (IAM policy). To use the Tags parameter, [kms:TagResource] (IAM policy). +// For examples and information about related permissions, see [Allow a user to create KMS keys]in the Key +// Management Service Developer Guide. +// +// Related operations: +// +// # DescribeKey +// +// # ListKeys +// +// # ScheduleKeyDeletion // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [CloudHSM key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html +// [external key store]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html +// [external key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html +// [Asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [Multi-Region keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html +// [Managing keys]: https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html +// [KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys +// [Allow a user to create KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [kms:TagResource]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [CloudHSM key store]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html +// [kms:CreateKey]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Importing key material into multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html +// [Importing Key Material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns ...func(*Options)) (*CreateKeyOutput, error) { if params == nil { params = &CreateKeyInput{} @@ -152,31 +196,41 @@ func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns . 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) - // 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 (https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) - // request on the KMS key. + // 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] 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. + // + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key + // [PutKeyPolicy]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html 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 - // CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation. + // Creates the KMS key in the specified [custom key store]. The ConnectionState of the custom key + // store must be CONNECTED . To find the CustomKeyStoreID and ConnectionState use + // the DescribeCustomKeyStoresoperation. + // // 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 - // you create a KMS key in an CloudHSM key store, KMS generates a non-exportable - // 256-bit symmetric key in its associated CloudHSM cluster and associates it with - // the KMS key. When you create a KMS key in an external key store, you must use - // the XksKeyId parameter to specify an external key that serves as key material - // for the KMS key. + // Region. You cannot create any other type of KMS key in a custom key store. + // + // When you create a KMS key in an CloudHSM key store, KMS generates a + // non-exportable 256-bit symmetric key in its associated CloudHSM cluster and + // associates it with the KMS key. When you create a KMS key in an external key + // store, you must use the XksKeyId parameter to specify an external key that + // serves as key material for the KMS key. + // + // [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html CustomKeyStoreId *string - // Instead, use the KeySpec parameter. The KeySpec and CustomerMasterKeySpec - // parameters work the same way. Only the names differ. We recommend that you use - // KeySpec parameter in your code. However, to avoid breaking changes, KMS supports - // both parameters. + // Instead, use the KeySpec parameter. + // + // The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the + // names differ. We recommend that you use KeySpec parameter in your code. + // However, to avoid breaking changes, KMS supports both parameters. // // Deprecated: This parameter has been deprecated. Instead, use the KeySpec // parameter. @@ -184,162 +238,232 @@ 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). Do not include confidential or sensitive information in this - // field. This field may be displayed in plaintext in CloudTrail logs and other - // output. To set or change the description after the key is created, use - // UpdateKeyDescription . + // description). + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // To set or change the description after the key is created, use UpdateKeyDescription. Description *string // 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) - // 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) - // 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: + // that uses SM4 encryption. For help choosing a key spec for your KMS key, see [Choosing a KMS key type]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], [kms:MacAlgorithm] or [kms:Signing Algorithm] in the Key + // Management Service Developer Guide . + // + // [Amazon Web Services services that are integrated with KMS]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 + // + // [kms:EncryptionAlgorithm]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm + // [kms:Signing Algorithm]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm + // [kms:MacAlgorithm]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm + // [Choosing a KMS key type]: https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose + // [Amazon Web Services services that are integrated with KMS]: http://aws.amazon.com/kms/features/#AWS_Service_Integration 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 - // 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. + // Determines the [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 . + // + // [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations 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 - // operation supports multi-Region keys, an KMS feature that lets you create + // 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 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) - // 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 + // multi-Region keys, see [Multi-Region keys in KMS]in the Key Management Service Developer Guide. + // + // This value creates a primary key, not a replica. To create a replica key, use + // the ReplicateKeyoperation. + // + // You can create a symmetric or asymmetric multi-Region key, and you can create a // multi-Region key with imported key material. However, you cannot create a // multi-Region key in a custom key store. + // + // [Multi-Region keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html 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) - // 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 - // parameter to identify the external key store and the XksKeyId parameter to - // identify the associated external key. The KeySpec value must be + // creates the key material. + // + // To [create a KMS key with no key material] (for imported key material), set this value to EXTERNAL . For more + // information about importing key material into KMS, see [Importing Key Material]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] 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], 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 . + // + // [create a KMS key in an external key store]: https://docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html + // [create a KMS key in an CloudHSM key store]: https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html + // [Importing Key Material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html + // [create a KMS key with no key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html 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 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.) + // becomes unmanageable. For more information, see [Default key policy]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. + // be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible]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 . + // KMS key. For more information, see [Default key policy]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] in the + // Identity and Access Management User Guide . + // + // [IAM JSON Policy Reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default + // [Changes that I make are not always immediately visible]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency 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. + // when it is created. To tag an existing KMS key, use the TagResourceoperation. + // // Do not include confidential or sensitive information in this field. This field - // may be displayed in plaintext in CloudTrail logs and other output. 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) - // 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 - // same tag key. If you specify an existing tag key with a different tag value, KMS - // 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) - // . + // may be displayed in plaintext in CloudTrail logs and other output. + // + // Tagging or untagging a KMS key can allow or deny permission to the KMS key. For + // details, see [ABAC for KMS]in the Key Management Service Developer Guide. + // + // To use this parameter, you must have [kms:TagResource] 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 same tag key. If you specify an + // existing tag key with a different tag value, KMS 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]. + // + // [kms:TagResource]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + // [Tagging Keys]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html + // [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.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) - // 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. 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) - // in the Key Management Service Developer Guide. + // Identifies the [external key] that serves as key material for the KMS key in an [external key store]. Specify the + // ID that the [external key store 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. + // + // 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]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]in the Key Management Service + // Developer Guide. + // + // [external key store]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html + // [Double encryption]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption + // [external key]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key + // [Requirements for a KMS key in an external key store]: https://docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements + // [external key store proxy]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy XksKeyId *string noSmithyDocumentSerde diff --git a/service/kms/api_op_Decrypt.go b/service/kms/api_op_Decrypt.go index 202bce68cf8..0eec0c26e40 100644 --- a/service/kms/api_op_Decrypt.go +++ b/service/kms/api_op_Decrypt.go @@ -13,24 +13,29 @@ 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) -// 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 +// keys, see [Asymmetric KMS keys]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]or [Amazon S3 client-side encryption]. 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 @@ -39,40 +44,57 @@ import ( // 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) -// in the Key Management Service Developer Guide. Decrypt also supports Amazon Web -// Services Nitro Enclaves (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html) -// , which provide an isolated compute environment in Amazon EC2. To call Decrypt -// for a Nitro enclave, use the Amazon Web Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) -// or any Amazon Web Services SDK. Use the Recipient parameter to provide the -// attestation document for the enclave. Instead of the plaintext data, the -// response includes the plaintext data encrypted with the public key from the -// attestation document ( CiphertextForRecipient ). For information about the -// interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon -// Web Services Nitro Enclaves uses 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) -// (key policy) Related operations: -// - Encrypt -// - GenerateDataKey -// - GenerateDataKeyPair -// - ReEncrypt +// particular KMS keys or particular trusted accounts. For details, see [Best practices for IAM policies]in the Key +// Management Service Developer Guide. +// +// Decrypt also supports [Amazon Web Services Nitro Enclaves], which provide an isolated compute environment in Amazon +// EC2. To call Decrypt for a Nitro enclave, use the [Amazon Web Services Nitro Enclaves SDK] or any Amazon Web Services +// SDK. Use the Recipient parameter to provide the attestation document for the +// enclave. Instead of the plaintext data, the response includes the plaintext data +// encrypted with the public key from the attestation document ( +// CiphertextForRecipient ). For information about the interaction between KMS and +// Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]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]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] (key policy) +// +// Related operations: +// +// # Encrypt +// +// # GenerateDataKey +// +// # GenerateDataKeyPair +// +// # ReEncrypt // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Amazon Web Services Encryption SDK]: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/ +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:Decrypt]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [Amazon Web Services Nitro Enclaves]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html +// [Amazon S3 client-side encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html +// [Best practices for IAM policies]: https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices +// [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk func (c *Client) Decrypt(ctx context.Context, params *DecryptInput, optFns ...func(*Options)) (*DecryptOutput, error) { if params == nil { params = &DecryptInput{} @@ -95,74 +117,103 @@ type DecryptInput struct { // This member is required. CiphertextBlob []byte - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool // Specifies the encryption algorithm that will be used to decrypt the ciphertext. // 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 - // for symmetric encryption KMS keys. + // 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 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) - // 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 - // that represent additional authenticated data. When you use an encryption context - // to encrypt data, you must specify the same (an exact case-sensitive match) + // context is valid only for [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 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) - // in the Key Management Service Developer Guide. + // recommended. + // + // For more information, see [Encryption context] in the Key Management Service Developer Guide. + // + // [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token 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: + // 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 . + // + // 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 - // A signed attestation document (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc) - // from an Amazon Web Services Nitro enclave and the encryption algorithm to use - // with the enclave's public key. The only valid encryption algorithm is - // RSAES_OAEP_SHA_256 . This parameter only supports attestation documents for - // Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon - // Web Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) - // or any Amazon Web Services SDK. When you use this parameter, instead of - // returning the plaintext data, KMS encrypts the plaintext data with the public - // key in the attestation document, and returns the resulting ciphertext in the - // CiphertextForRecipient field in the response. This ciphertext can be decrypted - // only with the private key in the enclave. The Plaintext field in the response - // is null or empty. For information about the interaction between KMS and Amazon - // Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption + // algorithm to use with the enclave's public key. The only valid encryption + // algorithm is RSAES_OAEP_SHA_256 . + // + // This parameter only supports attestation documents for Amazon Web Services + // Nitro Enclaves. To include this parameter, use the [Amazon Web Services Nitro Enclaves SDK]or any Amazon Web Services + // SDK. + // + // When you use this parameter, instead of returning the plaintext data, KMS + // encrypts the plaintext data with the public key in the attestation document, and + // returns the resulting ciphertext in the CiphertextForRecipient field in the + // response. This ciphertext can be decrypted only with the private key in the + // enclave. The Plaintext field in the response is null or empty. + // + // For information about the interaction between KMS and Amazon Web Services Nitro + // Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [attestation document]: https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-concepts.html#term-attestdoc + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html + // [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk Recipient *types.RecipientInfo noSmithyDocumentSerde @@ -171,24 +222,29 @@ type DecryptInput struct { type DecryptOutput struct { // The plaintext data encrypted with the public key in the attestation document. + // // This field is included in the response only when the Recipient parameter in the // request includes a valid attestation document from an Amazon Web Services Nitro // enclave. For information about the interaction between KMS and Amazon Web - // Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html CiphertextForRecipient []byte // 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] ) of the KMS key that was used to decrypt the + // ciphertext. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN KeyId *string // Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services - // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. If the - // response includes the CiphertextForRecipient field, the Plaintext field is null - // or empty. + // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. + // + // If the response includes the CiphertextForRecipient field, the Plaintext field + // is null or empty. Plaintext []byte // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_DeleteAlias.go b/service/kms/api_op_DeleteAlias.go index 5f611dd9dcb..06b4062b05a 100644 --- a/service/kms/api_op_DeleteAlias.go +++ b/service/kms/api_op_DeleteAlias.go @@ -10,31 +10,48 @@ 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 -// - 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). +// Deletes the specified alias. // -// 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 +// Adding, deleting, or updating an alias can allow or deny permission to the KMS +// key. For details, see [ABAC for KMS]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 DescribeKeyoperation. 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 CreateAliasto 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] +// - on the alias (IAM policy). +// +// [kms:DeleteAlias] +// - on the KMS key (key policy). +// +// For details, see [Controlling access to aliases] in the Key Management Service Developer Guide. +// +// Related operations: +// +// # CreateAlias +// +// # ListAliases +// +// # UpdateAlias // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html +// [kms:DeleteAlias]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Controlling access to aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error) { if params == nil { params = &DeleteAliasInput{} diff --git a/service/kms/api_op_DeleteCustomKeyStore.go b/service/kms/api_op_DeleteCustomKeyStore.go index a6711c6f1c8..14ee592460f 100644 --- a/service/kms/api_op_DeleteCustomKeyStore.go +++ b/service/kms/api_op_DeleteCustomKeyStore.go @@ -10,45 +10,65 @@ 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 -// 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) -// 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) -// 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 -// deleting the custom key store, consider using the DisconnectCustomKeyStore -// operation to disconnect the custom key store from its backing key store. While -// the key store is disconnected, you cannot create or use the KMS keys in the key -// store. But, you do not need to delete KMS keys and you can reconnect a -// 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) -// (IAM policy) Related operations: -// - ConnectCustomKeyStore -// - CreateCustomKeyStore -// - DescribeCustomKeyStores -// - DisconnectCustomKeyStore -// - UpdateCustomKeyStore +// Deletes a [custom key store]. 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] 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]. 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]. 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 DisconnectCustomKeyStoreto 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]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 deleting the custom key store, consider using the DisconnectCustomKeyStore operation to +// disconnect the custom key store from its backing key store. While the key store +// is disconnected, you cannot create or use the KMS keys in the key store. But, +// you do not need to delete KMS keys and you can reconnect a 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] (IAM policy) +// +// Related operations: +// +// # ConnectCustomKeyStore +// +// # CreateCustomKeyStore +// +// # DescribeCustomKeyStores +// +// # DisconnectCustomKeyStore +// +// # UpdateCustomKeyStore // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [delete the orphaned key material]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key +// [custom key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html +// [kms:DeleteCustomKeyStore]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) DeleteCustomKeyStore(ctx context.Context, params *DeleteCustomKeyStoreInput, optFns ...func(*Options)) (*DeleteCustomKeyStoreOutput, error) { if params == nil { params = &DeleteCustomKeyStoreInput{} @@ -67,7 +87,7 @@ func (c *Client) DeleteCustomKeyStore(ctx context.Context, params *DeleteCustomK type DeleteCustomKeyStoreInput struct { // Enter the ID of the custom key store you want to delete. To find the ID of a - // custom key store, use the DescribeCustomKeyStores operation. + // custom key store, use the DescribeCustomKeyStoresoperation. // // This member is required. CustomKeyStoreId *string diff --git a/service/kms/api_op_DeleteImportedKeyMaterial.go b/service/kms/api_op_DeleteImportedKeyMaterial.go index 26ac0a15152..f6e1d71c0fd 100644 --- a/service/kms/api_op_DeleteImportedKeyMaterial.go +++ b/service/kms/api_op_DeleteImportedKeyMaterial.go @@ -13,22 +13,33 @@ import ( // Deletes key material that was previously imported. This operation makes the // specified KMS key temporarily unusable. To restore the usability of the KMS key, // reimport the same key material. 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 . 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) -// (key policy) Related operations: -// - GetParametersForImport -// - ImportKeyMaterial +// material into KMS, see [Importing Key Material]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 . +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see [Key states of KMS keys]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] (key policy) +// +// Related operations: +// +// # GetParametersForImport +// +// # ImportKeyMaterial // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:DeleteImportedKeyMaterial]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Importing Key Material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) DeleteImportedKeyMaterial(ctx context.Context, params *DeleteImportedKeyMaterialInput, optFns ...func(*Options)) (*DeleteImportedKeyMaterialOutput, error) { if params == nil { params = &DeleteImportedKeyMaterialInput{} @@ -47,12 +58,18 @@ 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: + // 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 . + // + // 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 d993c1ba44f..1dc1b384dc8 100644 --- a/service/kms/api_op_DescribeCustomKeyStores.go +++ b/service/kms/api_op_DescribeCustomKeyStores.go @@ -11,44 +11,61 @@ 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) -// 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). +// Gets information about [custom key stores] in the account and Region. +// +// This operation is part of the [custom key stores] 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 -// 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 -// available. For an CloudHSM key store, verify that the associated CloudHSM -// cluster is active and contains the minimum number of HSMs required for the -// 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 -// 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) -// (IAM policy) Related operations: -// - ConnectCustomKeyStore -// - CreateCustomKeyStore -// - DeleteCustomKeyStore -// - DisconnectCustomKeyStore -// - UpdateCustomKeyStore +// 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 DisconnectCustomKeyStoreoperation 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 available. For an CloudHSM key store, verify that the associated +// CloudHSM cluster is active and contains the minimum number of HSMs required for +// the 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]. For help repairing your +// external key store, see the [Troubleshooting external key stores]. 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] (IAM policy) +// +// Related operations: +// +// # ConnectCustomKeyStore +// +// # CreateCustomKeyStore +// +// # DeleteCustomKeyStore +// +// # DisconnectCustomKeyStore +// +// # UpdateCustomKeyStore // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [kms:DescribeCustomKeyStores]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [custom key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html +// [Troubleshooting CloudHSM key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html +// [Troubleshooting external key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) DescribeCustomKeyStores(ctx context.Context, params *DescribeCustomKeyStoresInput, optFns ...func(*Options)) (*DescribeCustomKeyStoresOutput, error) { if params == nil { params = &DescribeCustomKeyStoresInput{} @@ -67,17 +84,21 @@ func (c *Client) DescribeCustomKeyStores(ctx context.Context, params *DescribeCu type DescribeCustomKeyStoresInput struct { // Gets only information about the specified custom key store. Enter the key store - // ID. By default, this operation gets information about all custom key stores in - // the account and Region. To limit the output to a particular custom key store, + // ID. + // + // By default, this operation gets information about all custom key stores in the + // account and Region. To limit the output to a particular custom key store, // provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not // both. CustomKeyStoreId *string // Gets only information about the specified custom key store. Enter the friendly - // name of the custom key store. By default, this operation gets information about - // all custom key stores in the account and Region. To limit the output to a - // particular custom key store, provide either the CustomKeyStoreId or - // CustomKeyStoreName parameter, but not both. + // name of the custom key store. + // + // By default, this operation gets information about all custom key stores in the + // account and Region. To limit the output to a particular custom key store, + // provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not + // both. CustomKeyStoreName *string // Use this parameter to specify the maximum number of items to return. When this diff --git a/service/kms/api_op_DescribeKey.go b/service/kms/api_op_DescribeKey.go index 6070fb4343a..f01c9f627b3 100644 --- a/service/kms/api_op_DescribeKey.go +++ b/service/kms/api_op_DescribeKey.go @@ -11,51 +11,73 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Provides detailed information about a KMS key. You can run DescribeKey on a [customer managed key] or +// an [Amazon Web Services managed key]. +// +// 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 (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) -// , DescribeKey displays the primary key and all related replica keys. For KMS -// keys in CloudHSM key stores (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html) -// , 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 (https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html) -// , it includes the custom key store ID and the ID of the external key. +// 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 . +// +// - 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 . +// information, use GetKeyRotationStatus. Also, some key states prevent a KMS key from being +// automatically rotated. For details, see [How Automatic Key Rotation 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 GetKeyPolicyand 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) -// 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) -// (key policy) Related operations: -// - GetKeyPolicy -// - GetKeyRotationStatus -// - ListAliases -// - ListGrants -// - ListKeys -// - ListResourceTags -// - ListRetirableGrants +// DescribeKey to create [Amazon Web Services managed keys] 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] (key policy) +// +// Related operations: +// +// # GetKeyPolicy +// +// # GetKeyRotationStatus +// +// # ListAliases +// +// # ListGrants +// +// # ListKeys +// +// # ListResourceTags +// +// # ListRetirableGrants // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [CloudHSM key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html +// [external key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html +// [customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk +// [kms:DescribeKey]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [How Automatic Key Rotation Works]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works +// [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html +// [Amazon Web Services managed keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Amazon Web Services managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk func (c *Client) DescribeKey(ctx context.Context, params *DescribeKeyInput, optFns ...func(*Options)) (*DescribeKeyOutput, error) { if params == nil { params = &DescribeKeyInput{} @@ -73,29 +95,43 @@ 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: + // 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]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 . + // + // 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. + // + // [Amazon Web Services managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk // // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string noSmithyDocumentSerde diff --git a/service/kms/api_op_DisableKey.go b/service/kms/api_op_DisableKey.go index eeb57e55428..ad7229a7d5e 100644 --- a/service/kms/api_op_DisableKey.go +++ b/service/kms/api_op_DisableKey.go @@ -11,19 +11,28 @@ import ( ) // 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) -// (key policy) Related operations: EnableKey Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// of the KMS key for [cryptographic operations]. +// +// For more information about how key state affects the use of a KMS key, see [Key states of KMS keys] 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]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] (key policy) +// +// Related operations: EnableKey +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [kms:DisableKey]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) DisableKey(ctx context.Context, params *DisableKeyInput, optFns ...func(*Options)) (*DisableKeyOutput, error) { if params == nil { params = &DisableKeyInput{} @@ -41,12 +50,18 @@ 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: + // 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 . + // + // 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 0b4d739d033..3b6daa56c4f 100644 --- a/service/kms/api_op_DisableKeyRotation.go +++ b/service/kms/api_op_DisableKeyRotation.go @@ -10,35 +10,53 @@ 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) -// 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) -// 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 -// 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) -// (key policy) Related operations: -// - EnableKeyRotation -// - GetKeyRotationStatus -// - ListKeyRotations -// - RotateKeyOnDemand +// Disables [automatic rotation of the key material] 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], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To +// enable or disable automatic rotation of a set of related [multi-Region keys], set the property on +// the primary key. +// +// You can enable (EnableKeyRotation ) and disable automatic rotation of the key material in [customer managed KMS keys]. Key +// material rotation of [Amazon Web Services managed KMS keys]is not configurable. KMS always rotates the key material +// for every year. Rotation of [Amazon Web Services owned KMS keys]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]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] (key policy) +// +// Related operations: +// +// # EnableKeyRotation +// +// # GetKeyRotationStatus +// +// # ListKeyRotations +// +// # RotateKeyOnDemand // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html +// [Amazon Web Services managed KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk +// [automatic rotation of the key material]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html +// [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [customer managed KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk +// [Amazon Web Services owned KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk +// [kms:DisableKeyRotation]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) DisableKeyRotation(ctx context.Context, params *DisableKeyRotationInput, optFns ...func(*Options)) (*DisableKeyRotationOutput, error) { if params == nil { params = &DisableKeyRotationInput{} @@ -57,15 +75,23 @@ 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: + // automatic rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. + // + // 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 get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // + // [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html + // [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html + // [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks + // [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html // // This member is required. KeyId *string diff --git a/service/kms/api_op_DisconnectCustomKeyStore.go b/service/kms/api_op_DisconnectCustomKeyStore.go index f9b7daae145..80f6654a5b6 100644 --- a/service/kms/api_op_DisconnectCustomKeyStore.go +++ b/service/kms/api_op_DisconnectCustomKeyStore.go @@ -10,36 +10,54 @@ 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) -// 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) -// 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) -// 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 -// 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) -// (IAM policy) Related operations: -// - ConnectCustomKeyStore -// - CreateCustomKeyStore -// - DeleteCustomKeyStore -// - DescribeCustomKeyStores -// - UpdateCustomKeyStore +// Disconnects the [custom key store] 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] 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]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 DescribeCustomKeyStores +// operation. To reconnect a custom key store, use the ConnectCustomKeyStoreoperation. +// +// 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] (IAM policy) +// +// Related operations: +// +// # ConnectCustomKeyStore +// +// # CreateCustomKeyStore +// +// # DeleteCustomKeyStore +// +// # DescribeCustomKeyStores +// +// # UpdateCustomKeyStore // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [custom key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [kms:DisconnectCustomKeyStore]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) DisconnectCustomKeyStore(ctx context.Context, params *DisconnectCustomKeyStoreInput, optFns ...func(*Options)) (*DisconnectCustomKeyStoreOutput, error) { if params == nil { params = &DisconnectCustomKeyStoreInput{} @@ -58,7 +76,7 @@ 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. + // a custom key store, use the DescribeCustomKeyStoresoperation. // // This member is required. CustomKeyStoreId *string diff --git a/service/kms/api_op_EnableKey.go b/service/kms/api_op_EnableKey.go index 1395c9df67b..c01d5d97152 100644 --- a/service/kms/api_op_EnableKey.go +++ b/service/kms/api_op_EnableKey.go @@ -11,16 +11,25 @@ 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 -// 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) -// (key policy) Related operations: DisableKey Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// for [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]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] (key policy) +// +// Related operations: DisableKey +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:EnableKey]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) EnableKey(ctx context.Context, params *EnableKeyInput, optFns ...func(*Options)) (*EnableKeyOutput, error) { if params == nil { params = &EnableKeyInput{} @@ -38,12 +47,18 @@ func (c *Client) EnableKey(ctx context.Context, params *EnableKeyInput, optFns . type EnableKeyInput struct { - // Identifies the KMS key to enable. Specify the key ID or key ARN of the KMS key. + // 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 . + // + // 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 d537edc7f34..d2ada715811 100644 --- a/service/kms/api_op_EnableKeyRotation.go +++ b/service/kms/api_op_EnableKeyRotation.go @@ -10,52 +10,77 @@ 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#rotating-keys-enable-disable) -// of the specified symmetric encryption KMS key. By default, 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 use the optional -// RotationPeriodInDays parameter to specify a custom rotation period when you -// enable key rotation, or you can use RotationPeriodInDays to modify the rotation -// period of a key that you previously enabled automatic key rotation on. 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. You can use the GetKeyRotationStatus -// operation to identify any in progress rotations. You can use the -// ListKeyRotations operation to view the details of completed rotations. 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 of 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) -// is managed by the Amazon Web Services service that owns the key. 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 rotated one year -// after they are created, and approximately every year 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 -// 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) -// (key policy) Related operations: -// - DisableKeyRotation -// - GetKeyRotationStatus -// - ListKeyRotations -// - RotateKeyOnDemand You can perform on-demand ( RotateKeyOnDemand ) rotation -// of the key material in customer managed KMS keys, regardless of whether or not -// automatic key rotation is enabled. +// Enables [automatic rotation of the key material] of the specified symmetric encryption KMS key. +// +// By default, when you enable automatic rotation of a [customer managed KMS key], KMS rotates the key +// material of the KMS key one year (approximately 365 days) from the enable date +// and every year thereafter. You can use the optional RotationPeriodInDays +// parameter to specify a custom rotation period when you enable key rotation, or +// you can use RotationPeriodInDays to modify the rotation period of a key that +// you previously enabled automatic key rotation on. +// +// 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 DisableKeyRotationoperation. You can use the GetKeyRotationStatus operation to identify any +// in progress rotations. You can use the ListKeyRotationsoperation to view the details of +// completed rotations. +// +// Automatic key rotation is supported only on [symmetric encryption KMS keys]. You cannot enable automatic +// rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To enable or disable +// automatic rotation of a set of related [multi-Region keys], set the property on the primary key. +// +// You cannot enable or disable automatic rotation of [Amazon Web Services managed KMS keys]. KMS always rotates the key +// material of Amazon Web Services managed keys every year. Rotation of [Amazon Web Services owned KMS keys]is managed +// by the Amazon Web Services service that owns the key. +// +// 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 rotated one year after +// they are created, and approximately every year 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]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] (key policy) +// +// Related operations: +// +// # DisableKeyRotation +// +// # GetKeyRotationStatus +// +// # ListKeyRotations +// +// RotateKeyOnDemand +// +// - You can perform on-demand (RotateKeyOnDemand ) rotation of the key material in customer +// managed KMS keys, regardless of whether or not automatic key rotation is +// enabled. // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [kms:EnableKeyRotation]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Amazon Web Services owned KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk +// [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html +// [Amazon Web Services managed KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk +// [customer managed KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk +// [automatic rotation of the key material]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable +// [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [symmetric encryption KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) EnableKeyRotation(ctx context.Context, params *EnableKeyRotationInput, optFns ...func(*Options)) (*EnableKeyRotationOutput, error) { if params == nil { params = &EnableKeyRotationInput{} @@ -74,28 +99,40 @@ 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 - // key. For example: + // of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To enable or disable automatic + // rotation of a set of related [multi-Region keys], 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // + // [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html + // [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html + // [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + // [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate + // [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html // // This member is required. KeyId *string // Use this parameter to specify a custom period of time between each rotation - // date. If no value is specified, the default value is 365 days. The rotation - // period defines the number of days after you enable automatic key rotation that - // KMS will rotate your key material, and the number of days between each automatic - // rotation thereafter. You can use the kms:RotationPeriodInDays (https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) - // condition key to further constrain the values that principals can specify in the - // RotationPeriodInDays parameter. + // date. If no value is specified, the default value is 365 days. + // + // The rotation period defines the number of days after you enable automatic key + // rotation that KMS will rotate your key material, and the number of days between + // each automatic rotation thereafter. + // + // You can use the [kms:RotationPeriodInDays]kms:RotationPeriodInDays condition key to further constrain the + // values that principals can specify in the RotationPeriodInDays parameter. + // + // [kms:RotationPeriodInDays]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days RotationPeriodInDays *int32 noSmithyDocumentSerde diff --git a/service/kms/api_op_Encrypt.go b/service/kms/api_op_Encrypt.go index d6628feb8ec..2c2b71de556 100644 --- a/service/kms/api_op_Encrypt.go +++ b/service/kms/api_op_Encrypt.go @@ -12,57 +12,86 @@ import ( ) // 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) -// 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 -// 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 +// 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]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 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 maximum size of the data that you can encrypt -// varies with the type of KMS key and the encryption algorithm that you choose. +// 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) -// (key policy) Related operations: -// - Decrypt -// - GenerateDataKey -// - GenerateDataKeyPair +// For details, see [Key states of KMS keys]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] (key policy) +// +// Related operations: +// +// # Decrypt +// +// # GenerateDataKey +// +// # GenerateDataKeyPair // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [Encryption Context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [kms:Encrypt]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) Encrypt(ctx context.Context, params *EncryptInput, optFns ...func(*Options)) (*EncryptOutput, error) { if params == nil { params = &EncryptInput{} @@ -81,18 +110,26 @@ 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 - // 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: + // 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 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 . + // + // 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 @@ -102,40 +139,54 @@ type EncryptInput struct { // This member is required. Plaintext []byte - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool // 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 - // you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256. The SM2PKE - // algorithm is only available in China Regions. + // 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) - // with a symmetric encryption KMS key. The standard asymmetric encryption - // algorithms and HMAC algorithms that KMS uses do not support an encryption - // context. Do not include confidential or sensitive information in this field. - // This field may be displayed in plaintext in CloudTrail logs and other output. 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 context is valid only for [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. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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) - // in the Key Management Service Developer Guide. + // recommended. + // + // For more information, see [Encryption context] in the Key Management Service Developer Guide. + // + // [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string noSmithyDocumentSerde @@ -150,8 +201,10 @@ 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] ) of the KMS key that was used to encrypt the + // plaintext. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 4a46272c303..a188477010f 100644 --- a/service/kms/api_op_GenerateDataKey.go +++ b/service/kms/api_op_GenerateDataKey.go @@ -16,47 +16,52 @@ import ( // symmetric encryption KMS key that you specify. The bytes in the plaintext key // are random; they are not related to the caller or the KMS key. You can use the // plaintext key to encrypt your data outside of KMS and store the encrypted data -// 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) -// in the Key Management Service Developer Guide. GenerateDataKey also supports -// Amazon Web Services Nitro Enclaves (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html) -// , which provide an isolated compute environment in Amazon EC2. To call -// GenerateDataKey for an Amazon Web Services Nitro enclave, use the Amazon Web -// Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) -// or any Amazon Web Services SDK. Use the Recipient parameter to provide the -// attestation document for the enclave. GenerateDataKey returns a copy of the -// data key encrypted under the specified KMS key, as usual. But instead of a -// plaintext copy of the data key, the response includes a copy of the data key -// encrypted under the public key from the attestation document ( +// 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 DescribeKeyoperation. +// +// 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 GenerateDataKeyPairor 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] in the Key Management +// Service Developer Guide. +// +// GenerateDataKey also supports [Amazon Web Services Nitro Enclaves], which provide an isolated compute environment +// in Amazon EC2. To call GenerateDataKey for an Amazon Web Services Nitro +// enclave, use the [Amazon Web Services Nitro Enclaves SDK]or any Amazon Web Services SDK. Use the Recipient parameter to +// provide the attestation document for the enclave. GenerateDataKey returns a +// copy of the data key encrypted under the specified KMS key, as usual. But +// instead of a plaintext copy of the data key, the response includes a copy of the +// data key encrypted under the public key from the attestation document ( // CiphertextForRecipient ). For information about the interaction between KMS and -// Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves -// uses 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 +// Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]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]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) -// to do these tasks for you. To encrypt data outside of KMS: +// library, such as the [Amazon Web Services Encryption SDK], the [Amazon DynamoDB Encryption Client], or [Amazon S3 client-side encryption] to do these tasks for you. +// +// To encrypt data outside of KMS: // // - Use the GenerateDataKey operation to get a data key. // @@ -67,24 +72,44 @@ import ( // with the encrypted data. // // 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 Decryptoperation 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) -// (key policy) Related operations: -// - Decrypt -// - Encrypt -// - GenerateDataKeyPair -// - GenerateDataKeyPairWithoutPlaintext -// - GenerateDataKeyWithoutPlaintext +// the KeyId parameter. +// +// Required permissions: [kms:GenerateDataKey] (key policy) +// +// Related operations: +// +// # Decrypt +// +// # Encrypt +// +// # GenerateDataKeyPair +// +// # GenerateDataKeyPairWithoutPlaintext +// +// # GenerateDataKeyWithoutPlaintext // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Amazon Web Services Encryption SDK]: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/ +// [Amazon DynamoDB Encryption Client]: https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/ +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [Encryption Context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [Amazon Web Services Nitro Enclaves]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html +// [Amazon S3 client-side encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html +// [kms:GenerateDataKey]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk func (c *Client) GenerateDataKey(ctx context.Context, params *GenerateDataKeyInput, optFns ...func(*Options)) (*GenerateDataKeyOutput, error) { if params == nil { params = &GenerateDataKeyInput{} @@ -104,75 +129,102 @@ 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: + // the type and origin of your KMS key, use the DescribeKeyoperation. + // + // 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 . + // + // 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 - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // Specifies the encryption context that will be used when encrypting the data - // key. Do not include confidential or sensitive information in this field. This - // field may be displayed in plaintext in CloudTrail logs and other output. 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 + // Specifies the encryption context that will be used when encrypting the data key. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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) - // in the Key Management Service Developer Guide. + // recommended. + // + // For more information, see [Encryption context] in the Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string // Specifies the length of the data key. Use AES_128 to generate a 128-bit - // symmetric key, or AES_256 to generate a 256-bit symmetric key. You must specify - // either the KeySpec or the NumberOfBytes parameter (but not both) in every - // GenerateDataKey request. + // symmetric key, or AES_256 to generate a 256-bit symmetric key. + // + // You must specify either the KeySpec or the NumberOfBytes parameter (but not + // both) in every GenerateDataKey request. KeySpec types.DataKeySpec // Specifies 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 128-bit (16-byte) and - // 256-bit (32-byte) data keys, use the KeySpec parameter. You must specify either - // the KeySpec or the NumberOfBytes parameter (but not both) in every - // GenerateDataKey request. + // 256-bit (32-byte) data keys, use the KeySpec parameter. + // + // You must specify either the KeySpec or the NumberOfBytes parameter (but not + // both) in every GenerateDataKey request. NumberOfBytes *int32 - // A signed attestation document (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc) - // from an Amazon Web Services Nitro enclave and the encryption algorithm to use - // with the enclave's public key. The only valid encryption algorithm is - // RSAES_OAEP_SHA_256 . This parameter only supports attestation documents for - // Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon - // Web Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) - // or any Amazon Web Services SDK. When you use this parameter, instead of - // returning the plaintext data key, KMS encrypts the plaintext data key under the - // public key in the attestation document, and returns the resulting ciphertext in - // the CiphertextForRecipient field in the response. This ciphertext can be - // decrypted only with the private key in the enclave. The CiphertextBlob field in - // the response contains a copy of the data key encrypted under the KMS key - // specified by the KeyId parameter. The Plaintext field in the response is null - // or empty. For information about the interaction between KMS and Amazon Web - // Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption + // algorithm to use with the enclave's public key. The only valid encryption + // algorithm is RSAES_OAEP_SHA_256 . + // + // This parameter only supports attestation documents for Amazon Web Services + // Nitro Enclaves. To include this parameter, use the [Amazon Web Services Nitro Enclaves SDK]or any Amazon Web Services + // SDK. + // + // When you use this parameter, instead of returning the plaintext data key, KMS + // encrypts the plaintext data key under the public key in the attestation + // document, and returns the resulting ciphertext in the CiphertextForRecipient + // field in the response. This ciphertext can be decrypted only with the private + // key in the enclave. The CiphertextBlob field in the response contains a copy of + // the data key encrypted under the KMS key specified by the KeyId parameter. The + // Plaintext field in the response is null or empty. + // + // For information about the interaction between KMS and Amazon Web Services Nitro + // Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [attestation document]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html + // [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk Recipient *types.RecipientInfo noSmithyDocumentSerde @@ -186,23 +238,28 @@ type GenerateDataKeyOutput struct { // The plaintext data key encrypted with the public key from the Nitro enclave. // This ciphertext can be decrypted only by using a private key in the Nitro - // enclave. This field is included in the response only when the Recipient - // parameter in the request includes a valid attestation document from an Amazon - // Web Services Nitro enclave. For information about the interaction between KMS - // and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro - // Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // enclave. + // + // This field is included in the response only when the Recipient parameter in the + // request includes a valid attestation document from an Amazon Web Services Nitro + // enclave. For information about the interaction between KMS and Amazon Web + // Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html CiphertextForRecipient []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] ) of the KMS key that encrypted the data key. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN KeyId *string // The plaintext data key. When you use the HTTP API or the Amazon Web Services // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this // data key to encrypt your data outside of KMS. Then, remove it from memory as - // soon as possible. If the response includes the CiphertextForRecipient field, - // the Plaintext field is null or empty. + // soon as possible. + // + // If the response includes the CiphertextForRecipient field, the Plaintext field + // is null or empty. Plaintext []byte // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_GenerateDataKeyPair.go b/service/kms/api_op_GenerateDataKeyPair.go index 2156fb5f613..5076ac095b3 100644 --- a/service/kms/api_op_GenerateDataKeyPair.go +++ b/service/kms/api_op_GenerateDataKeyPair.go @@ -17,67 +17,90 @@ import ( // 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 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 GenerateDataKeyPair 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 operation to decrypt the encrypted private key. To -// generate a data key pair, you must specify a symmetric encryption KMS key to +// private key. +// +// You can use the public key that GenerateDataKeyPair 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 +// operation to decrypt the encrypted private key. +// +// To 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 -// GenerateDataKeyPairWithoutPlaintext operation. +// use the DescribeKeyoperation. +// +// 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 GenerateDataKeyPairWithoutPlaintextoperation. // 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 -// 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) . GenerateDataKeyPair also supports -// Amazon Web Services Nitro Enclaves (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html) -// , which provide an isolated compute environment in Amazon EC2. To call -// GenerateDataKeyPair for an Amazon Web Services Nitro enclave, use the Amazon -// Web Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) -// or any Amazon Web Services SDK. Use the Recipient parameter to provide the -// attestation document for the enclave. GenerateDataKeyPair returns the public -// data key and a copy of the private data key encrypted under the specified KMS -// key, as usual. But instead of a plaintext copy of the private data key ( -// PrivateKeyPlaintext ), the response includes a copy of the private data key -// encrypted under the public key from the attestation document ( -// CiphertextForRecipient ). For information about the interaction between KMS and -// Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves -// uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) -// in the Key Management Service Developer Guide.. 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) -// (key policy) Related operations: -// - Decrypt -// - Encrypt -// - GenerateDataKey -// - GenerateDataKeyPairWithoutPlaintext -// - GenerateDataKeyWithoutPlaintext +// or sign a message, use the Decryptoperation 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 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]. The private key is a DER-encoded PKCS8 +// PrivateKeyInfo, as specified in [RFC 5958]. +// +// GenerateDataKeyPair also supports [Amazon Web Services Nitro Enclaves], which provide an isolated compute +// environment in Amazon EC2. To call GenerateDataKeyPair for an Amazon Web +// Services Nitro enclave, use the [Amazon Web Services Nitro Enclaves SDK]or any Amazon Web Services SDK. Use the +// Recipient parameter to provide the attestation document for the enclave. +// GenerateDataKeyPair returns the public data key and a copy of the private data +// key encrypted under the specified KMS key, as usual. But instead of a plaintext +// copy of the private data key ( PrivateKeyPlaintext ), the response includes a +// copy of the private data key encrypted under the public key from the attestation +// document ( CiphertextForRecipient ). For information about the interaction +// between KMS and Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management +// Service Developer Guide.. +// +// 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] 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]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] (key policy) +// +// Related operations: +// +// # Decrypt +// +// # Encrypt +// +// # GenerateDataKey +// +// # GenerateDataKeyPairWithoutPlaintext +// +// # GenerateDataKeyWithoutPlaintext // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [RFC 5280]: https://tools.ietf.org/html/rfc5280 +// [Encryption Context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [Amazon Web Services Nitro Enclaves]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html +// [RFC 5958]: https://tools.ietf.org/html/rfc5958 +// [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html +// [kms:GenerateDataKeyPair]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk func (c *Client) GenerateDataKeyPair(ctx context.Context, params *GenerateDataKeyPairInput, optFns ...func(*Options)) (*GenerateDataKeyPairOutput, error) { if params == nil { params = &GenerateDataKeyPairInput{} @@ -97,73 +120,100 @@ type GenerateDataKeyPairInput struct { // Specifies the symmetric encryption KMS key that encrypts the private key in the // 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 - // a different Amazon Web Services account, you must use the key ARN or alias ARN. + // key store. To get the type and origin of your KMS key, use the DescribeKeyoperation. + // + // 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 . + // + // 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 - // Determines the type of data key pair that is generated. The KMS rule that - // restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or - // to sign and verify (but not both), and the rule that permits you to use ECC KMS - // keys only to sign and verify, are not effective on data key pairs, which are - // used outside of KMS. The SM2 key spec is only available in China Regions. + // Determines the type of data key pair that is generated. + // + // The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to + // encrypt and decrypt or to sign and verify (but not both), and the rule that + // permits you to use ECC KMS keys only to sign and verify, are not effective on + // data key pairs, which are used outside of KMS. The SM2 key spec is only + // available in China Regions. // // This member is required. KeyPairSpec types.DataKeyPairSpec - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool // Specifies the encryption context that will be used when encrypting the private - // key in the data key pair. Do not include confidential or sensitive information - // in this field. This field may be displayed in plaintext in CloudTrail logs and - // other output. 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) - // in the Key Management Service Developer Guide. + // key in the data key pair. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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] in the Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string - // A signed attestation document (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc) - // from an Amazon Web Services Nitro enclave and the encryption algorithm to use - // with the enclave's public key. The only valid encryption algorithm is - // RSAES_OAEP_SHA_256 . This parameter only supports attestation documents for - // Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon - // Web Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) - // or any Amazon Web Services SDK. When you use this parameter, instead of - // returning a plaintext copy of the private data key, KMS encrypts the plaintext - // private data key under the public key in the attestation document, and returns - // the resulting ciphertext in the CiphertextForRecipient field in the response. - // This ciphertext can be decrypted only with the private key in the enclave. The - // CiphertextBlob field in the response contains a copy of the private data key - // encrypted under the KMS key specified by the KeyId parameter. The - // PrivateKeyPlaintext field in the response is null or empty. For information - // about the interaction between KMS and Amazon Web Services Nitro Enclaves, see - // How Amazon Web Services Nitro Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption + // algorithm to use with the enclave's public key. The only valid encryption + // algorithm is RSAES_OAEP_SHA_256 . + // + // This parameter only supports attestation documents for Amazon Web Services + // Nitro Enclaves. To include this parameter, use the [Amazon Web Services Nitro Enclaves SDK]or any Amazon Web Services + // SDK. + // + // When you use this parameter, instead of returning a plaintext copy of the + // private data key, KMS encrypts the plaintext private data key under the public + // key in the attestation document, and returns the resulting ciphertext in the + // CiphertextForRecipient field in the response. This ciphertext can be decrypted + // only with the private key in the enclave. The CiphertextBlob field in the + // response contains a copy of the private data key encrypted under the KMS key + // specified by the KeyId parameter. The PrivateKeyPlaintext field in the response + // is null or empty. + // + // For information about the interaction between KMS and Amazon Web Services Nitro + // Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [attestation document]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html + // [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk Recipient *types.RecipientInfo noSmithyDocumentSerde @@ -173,16 +223,19 @@ type GenerateDataKeyPairOutput struct { // The plaintext private data key encrypted with the public key from the Nitro // enclave. This ciphertext can be decrypted only by using a private key in the - // Nitro enclave. This field is included in the response only when the Recipient - // parameter in the request includes a valid attestation document from an Amazon - // Web Services Nitro enclave. For information about the interaction between KMS - // and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro - // Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // Nitro enclave. + // + // This field is included in the response only when the Recipient parameter in the + // request includes a valid attestation document from an Amazon Web Services Nitro + // enclave. For information about the interaction between KMS and Amazon Web + // Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html CiphertextForRecipient []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 private key. + // The Amazon Resource Name ([key ARN] ) of the KMS key that encrypted the private key. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN KeyId *string // The type of data key pair that was generated. @@ -195,7 +248,9 @@ type GenerateDataKeyPairOutput struct { // The plaintext copy of the private key. When you use the HTTP API or the Amazon // Web Services CLI, the value is Base64-encoded. Otherwise, it is not - // Base64-encoded. If the response includes the CiphertextForRecipient field, the + // Base64-encoded. + // + // If the response includes the CiphertextForRecipient field, the // PrivateKeyPlaintext field is null or empty. PrivateKeyPlaintext []byte diff --git a/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go b/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go index 94393a5168b..f3bc534a0e0 100644 --- a/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go +++ b/service/kms/api_op_GenerateDataKeyPairWithoutPlaintext.go @@ -13,48 +13,68 @@ import ( // 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 -// operation to decrypt the encrypted private key. To 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. +// 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 Decryptoperation to decrypt the encrypted private key. +// +// To 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 DescribeKeyoperation. +// +// 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. +// // 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 +// SubjectPublicKeyInfo, as specified in [RFC 5280]. +// +// 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) -// (key policy) Related operations: -// - Decrypt -// - Encrypt -// - GenerateDataKey -// - GenerateDataKeyPair -// - GenerateDataKeyWithoutPlaintext +// InvalidCiphertextException . For more information, see [Encryption 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]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] (key policy) +// +// Related operations: +// +// # Decrypt +// +// # Encrypt +// +// # GenerateDataKey +// +// # GenerateDataKeyPair +// +// # GenerateDataKeyWithoutPlaintext // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [RFC 5280]: https://tools.ietf.org/html/rfc5280 +// [Encryption Context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [kms:GenerateDataKeyPairWithoutPlaintext]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) GenerateDataKeyPairWithoutPlaintext(ctx context.Context, params *GenerateDataKeyPairWithoutPlaintextInput, optFns ...func(*Options)) (*GenerateDataKeyPairWithoutPlaintextOutput, error) { if params == nil { params = &GenerateDataKeyPairWithoutPlaintextInput{} @@ -74,54 +94,75 @@ type GenerateDataKeyPairWithoutPlaintextInput struct { // Specifies the symmetric encryption KMS key that encrypts the private key in the // 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 - // a different Amazon Web Services account, you must use the key ARN or alias ARN. + // key store. To get the type and origin of your KMS key, use the DescribeKeyoperation. + // + // 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 . + // + // 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 - // Determines the type of data key pair that is generated. The KMS rule that - // restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or - // to sign and verify (but not both), and the rule that permits you to use ECC KMS - // keys only to sign and verify, are not effective on data key pairs, which are - // used outside of KMS. The SM2 key spec is only available in China Regions. + // Determines the type of data key pair that is generated. + // + // The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to + // encrypt and decrypt or to sign and verify (but not both), and the rule that + // permits you to use ECC KMS keys only to sign and verify, are not effective on + // data key pairs, which are used outside of KMS. The SM2 key spec is only + // available in China Regions. // // This member is required. KeyPairSpec types.DataKeyPairSpec - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool // Specifies the encryption context that will be used when encrypting the private - // key in the data key pair. Do not include confidential or sensitive information - // in this field. This field may be displayed in plaintext in CloudTrail logs and - // other output. 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) - // in the Key Management Service Developer Guide. + // key in the data key pair. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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] in the Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string noSmithyDocumentSerde @@ -129,8 +170,9 @@ 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] ) of the KMS key that encrypted the private key. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 0a5af3cd567..3947b622641 100644 --- a/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go +++ b/service/kms/api_op_GenerateDataKeyWithoutPlaintext.go @@ -14,52 +14,77 @@ import ( // Returns a unique symmetric data key for use outside of KMS. This operation // returns a data key that is encrypted under a symmetric encryption KMS key that // you specify. The bytes in the key are random; they are not related to the caller -// or to the KMS key. GenerateDataKeyWithoutPlaintext is identical to the -// GenerateDataKey operation except that it does not return a plaintext copy of the -// data key. This operation is useful for systems that need to encrypt data at some -// point, but not immediately. When you need to encrypt the data, you call the -// Decrypt operation on the encrypted copy of the key. It's also useful in -// distributed systems with different levels of trust. For example, you might store -// encrypted data in containers. One component of your system creates new -// containers and stores an encrypted data key with each container. Then, a -// different component puts the data into the containers. That component first -// 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 16 . -// 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) -// (key policy) Related operations: -// - Decrypt -// - Encrypt -// - GenerateDataKey -// - GenerateDataKeyPair -// - GenerateDataKeyPairWithoutPlaintext +// or to the KMS key. +// +// GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it +// does not return a plaintext copy of the data key. +// +// This operation is useful for systems that need to encrypt data at some point, +// but not immediately. When you need to encrypt the data, you call the Decryptoperation +// on the encrypted copy of the key. +// +// It's also useful in distributed systems with different levels of trust. For +// example, you might store encrypted data in containers. One component of your +// system creates new containers and stores an encrypted data key with each +// container. Then, a different component puts the data into the containers. That +// component first 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 DescribeKeyoperation. +// +// 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 16 . 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] 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]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] (key policy) +// +// Related operations: +// +// # Decrypt +// +// # Encrypt +// +// # GenerateDataKey +// +// # GenerateDataKeyPair +// +// # GenerateDataKeyPairWithoutPlaintext // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [Encryption Context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [kms:GenerateDataKeyWithoutPlaintext]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) GenerateDataKeyWithoutPlaintext(ctx context.Context, params *GenerateDataKeyWithoutPlaintextInput, optFns ...func(*Options)) (*GenerateDataKeyWithoutPlaintextOutput, error) { if params == nil { params = &GenerateDataKeyWithoutPlaintextInput{} @@ -79,44 +104,63 @@ 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: + // the type and origin of your KMS key, use the DescribeKeyoperation. + // + // 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 . + // + // 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 - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // Specifies the encryption context that will be used when encrypting the data - // key. Do not include confidential or sensitive information in this field. This - // field may be displayed in plaintext in CloudTrail logs and other output. 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 + // Specifies the encryption context that will be used when encrypting the data key. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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) - // in the Key Management Service Developer Guide. + // recommended. + // + // For more information, see [Encryption context] in the Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string // The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or @@ -138,8 +182,9 @@ 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] ) of the KMS key that encrypted the data key. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 5a2819bdb39..1abd90e2cfa 100644 --- a/service/kms/api_op_GenerateMac.go +++ b/service/kms/api_op_GenerateMac.go @@ -13,29 +13,42 @@ import ( // 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 Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// HMAC algorithms that KMS uses conform to industry standards defined in [RFC 2104]. +// +// 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]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]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] (key policy) +// +// Related operations: VerifyMac +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:GenerateMac]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [RFC 2104]: https://datatracker.ietf.org/doc/html/rfc2104 +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [HMAC keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html func (c *Client) GenerateMac(ctx context.Context, params *GenerateMacInput, optFns ...func(*Options)) (*GenerateMacOutput, error) { if params == nil { params = &GenerateMacInput{} @@ -54,39 +67,50 @@ 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]. + // + // To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in + // the response. + // + // [RFC 2104]: https://datatracker.ietf.org/doc/html/rfc2104 // // This member is required. KeyId *string - // The MAC algorithm used in the operation. The algorithm must be compatible with - // the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS - // key supports, use the DescribeKey operation and see the MacAlgorithms field in - // the DescribeKey response. + // The MAC algorithm used in the operation. + // + // The algorithm must be compatible with the HMAC KMS key that you specify. To + // find the MAC algorithms that your HMAC KMS key supports, use the DescribeKeyoperation and + // see the MacAlgorithms field in the DescribeKey response. // // This member is required. MacAlgorithm types.MacAlgorithmSpec - // The message to be hashed. Specify a message of up to 4,096 bytes. GenerateMac - // and VerifyMac do not provide special handling for message digests. If you + // The message to be hashed. Specify a message of up to 4,096 bytes. + // + // GenerateMac and VerifyMac do not provide special handling for message digests. If you // generate an HMAC for a hash digest of a message, you must verify the HMAC of the // same hash digest. // // This member is required. Message []byte - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string noSmithyDocumentSerde @@ -98,8 +122,11 @@ type GenerateMacOutput struct { KeyId *string // 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) . + // specified message, HMAC KMS key, and MAC algorithm. + // + // This is the standard, raw HMAC defined in [RFC 2104]. + // + // [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 b2a2569ee82..456c544f319 100644 --- a/service/kms/api_op_GenerateRandom.go +++ b/service/kms/api_op_GenerateRandom.go @@ -11,30 +11,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a random byte string that is cryptographically secure. You must use the -// NumberOfBytes parameter to specify the length of the random byte string. There -// is no default value for string length. By default, the random byte string is -// generated in KMS. To generate the byte string in the CloudHSM cluster associated -// with an CloudHSM key store, use the CustomKeyStoreId parameter. GenerateRandom -// also supports Amazon Web Services Nitro Enclaves (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html) -// , which provide an isolated compute environment in Amazon EC2. To call -// GenerateRandom for a Nitro enclave, use the Amazon Web Services Nitro Enclaves -// SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) -// or any Amazon Web Services SDK. Use the Recipient parameter to provide the -// attestation document for the enclave. Instead of plaintext bytes, the response -// includes the plaintext bytes encrypted under the public key from the attestation -// document ( CiphertextForRecipient ).For information about the interaction -// between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services -// Nitro Enclaves uses 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/) . +// Returns a random byte string that is cryptographically secure. +// +// You must use the NumberOfBytes parameter to specify the length of the random +// byte string. There is no default value for string length. +// +// By default, the random byte string is generated in KMS. To generate the byte +// string in the CloudHSM cluster associated with an CloudHSM key store, use the +// CustomKeyStoreId parameter. +// +// GenerateRandom also supports [Amazon Web Services Nitro Enclaves], which provide an isolated compute environment in +// Amazon EC2. To call GenerateRandom for a Nitro enclave, use the [Amazon Web Services Nitro Enclaves SDK] or any Amazon +// Web Services SDK. Use the Recipient parameter to provide the attestation +// document for the enclave. Instead of plaintext bytes, the response includes the +// plaintext bytes encrypted under the public key from the attestation document ( +// CiphertextForRecipient ).For information about the interaction between KMS and +// Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer +// Guide. +// +// For more information about entropy and random number generation, see [Key Management Service 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) -// (IAM policy) Eventual consistency: The KMS API follows an eventual consistency -// model. For more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// account-specific resources, such as KMS keys. +// +// Required permissions: [kms:GenerateRandom] (IAM policy) +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [kms:GenerateRandom]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Amazon Web Services Nitro Enclaves]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html +// [Key Management Service Cryptographic Details]: https://docs.aws.amazon.com/kms/latest/cryptographic-details/ +// [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk func (c *Client) GenerateRandom(ctx context.Context, params *GenerateRandomInput, optFns ...func(*Options)) (*GenerateRandomOutput, error) { if params == nil { params = &GenerateRandomInput{} @@ -54,28 +64,36 @@ 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 . + // the DescribeCustomKeyStoresoperation. + // + // 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. NumberOfBytes *int32 - // A signed attestation document (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc) - // from an Amazon Web Services Nitro enclave and the encryption algorithm to use - // with the enclave's public key. The only valid encryption algorithm is - // RSAES_OAEP_SHA_256 . This parameter only supports attestation documents for - // Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon - // Web Services Nitro Enclaves SDK (https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk) - // or any Amazon Web Services SDK. When you use this parameter, instead of - // returning plaintext bytes, KMS encrypts the plaintext bytes under the public key - // in the attestation document, and returns the resulting ciphertext in the - // CiphertextForRecipient field in the response. This ciphertext can be decrypted - // only with the private key in the enclave. The Plaintext field in the response - // is null or empty. For information about the interaction between KMS and Amazon - // Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // A signed [attestation document] from an Amazon Web Services Nitro enclave and the encryption + // algorithm to use with the enclave's public key. The only valid encryption + // algorithm is RSAES_OAEP_SHA_256 . + // + // This parameter only supports attestation documents for Amazon Web Services + // Nitro Enclaves. To include this parameter, use the [Amazon Web Services Nitro Enclaves SDK]or any Amazon Web Services + // SDK. + // + // When you use this parameter, instead of returning plaintext bytes, KMS encrypts + // the plaintext bytes under the public key in the attestation document, and + // returns the resulting ciphertext in the CiphertextForRecipient field in the + // response. This ciphertext can be decrypted only with the private key in the + // enclave. The Plaintext field in the response is null or empty. + // + // For information about the interaction between KMS and Amazon Web Services Nitro + // Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [attestation document]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html + // [Amazon Web Services Nitro Enclaves SDK]: https://docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk Recipient *types.RecipientInfo noSmithyDocumentSerde @@ -85,18 +103,21 @@ type GenerateRandomOutput struct { // The plaintext random bytes encrypted with the public key from the Nitro // enclave. This ciphertext can be decrypted only by using a private key in the - // Nitro enclave. This field is included in the response only when the Recipient - // parameter in the request includes a valid attestation document from an Amazon - // Web Services Nitro enclave. For information about the interaction between KMS - // and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro - // Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) - // in the Key Management Service Developer Guide. + // Nitro enclave. + // + // This field is included in the response only when the Recipient parameter in the + // request includes a valid attestation document from an Amazon Web Services Nitro + // enclave. For information about the interaction between KMS and Amazon Web + // Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS]in the Key Management Service Developer Guide. + // + // [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html CiphertextForRecipient []byte // The random byte string. When you use the HTTP API or the Amazon Web Services - // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. If the - // response includes the CiphertextForRecipient field, the Plaintext field is null - // or empty. + // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. + // + // If the response includes the CiphertextForRecipient field, the Plaintext field + // is null or empty. Plaintext []byte // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_GetKeyPolicy.go b/service/kms/api_op_GetKeyPolicy.go index 2ef4663d36f..b4c238dcb56 100644 --- a/service/kms/api_op_GetKeyPolicy.go +++ b/service/kms/api_op_GetKeyPolicy.go @@ -10,13 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// (key policy) Related operations: PutKeyPolicy (https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) +// 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] (key policy) +// +// Related operations: [PutKeyPolicy] +// // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [kms:GetKeyPolicy]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [PutKeyPolicy]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) GetKeyPolicy(ctx context.Context, params *GetKeyPolicyInput, optFns ...func(*Options)) (*GetKeyPolicyOutput, error) { if params == nil { params = &GetKeyPolicyInput{} @@ -34,19 +42,25 @@ func (c *Client) GetKeyPolicy(ctx context.Context, params *GetKeyPolicyInput, op 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: + // 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 . + // + // 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. If no policy name is specified, the // default value is default . The only valid name is default . To get the names of - // key policies, use ListKeyPolicies . + // key policies, use ListKeyPolicies. PolicyName *string noSmithyDocumentSerde diff --git a/service/kms/api_op_GetKeyRotationStatus.go b/service/kms/api_op_GetKeyRotationStatus.go index 51c332dffe1..6fb0cd556e9 100644 --- a/service/kms/api_op_GetKeyRotationStatus.go +++ b/service/kms/api_op_GetKeyRotationStatus.go @@ -12,31 +12,31 @@ import ( ) // Provides detailed information about the rotation status for a KMS key, -// including 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, the rotation period (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period) -// , and the next scheduled rotation date. 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) -// 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 . You can perform on-demand ( RotateKeyOnDemand -// ) rotation of the key material in customer managed KMS keys, regardless of -// whether or not automatic key rotation is enabled. You can use -// GetKeyRotationStatus to identify the date and time that an in progress on-demand -// rotation was initiated. You can use ListKeyRotations to view the details of -// completed rotations. 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. +// including whether [automatic rotation of the key material]is enabled for the specified KMS key, the [rotation period], and the next +// scheduled rotation date. +// +// Automatic key rotation is supported only on [symmetric encryption KMS keys]. You cannot enable automatic +// rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To enable or disable +// automatic rotation of a set of related [multi-Region keys], 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]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 . +// +// You can perform on-demand (RotateKeyOnDemand ) rotation of the key material in customer managed +// KMS keys, regardless of whether or not automatic key rotation is enabled. You +// can use GetKeyRotationStatus to identify the date and time that an in progress +// on-demand rotation was initiated. You can use ListKeyRotationsto view the details of completed +// rotations. +// +// 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]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 @@ -44,22 +44,42 @@ import ( // 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) -// (key policy) Related operations: -// - DisableKeyRotation -// - EnableKeyRotation -// - ListKeyRotations -// - RotateKeyOnDemand +// parameter. +// +// Required permissions: [kms:GetKeyRotationStatus] (key policy) +// +// Related operations: +// +// # DisableKeyRotation +// +// # EnableKeyRotation +// +// # ListKeyRotations +// +// # RotateKeyOnDemand // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html +// [rotation period]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period +// [Amazon Web Services managed KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk +// [kms:GetKeyRotationStatus]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [automatic rotation of the key material]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html +// [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [symmetric encryption KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks +// [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) GetKeyRotationStatus(ctx context.Context, params *GetKeyRotationStatusInput, optFns ...func(*Options)) (*GetKeyRotationStatusOutput, error) { if params == nil { params = &GetKeyRotationStatusInput{} @@ -77,13 +97,19 @@ func (c *Client) GetKeyRotationStatus(ctx context.Context, params *GetKeyRotatio 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string @@ -103,11 +129,14 @@ type GetKeyRotationStatusOutput struct { NextRotationDate *time.Time // Identifies the date and time that an in progress on-demand rotation was - // initiated. The KMS API follows an eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) - // model due to the distributed nature of the system. As a result, there might be a - // slight delay between initiating on-demand key rotation and the rotation's - // completion. Once the on-demand rotation is complete, use ListKeyRotations to + // initiated. + // + // The KMS API follows an [eventual consistency] model due to the distributed nature of the system. As a + // result, there might be a slight delay between initiating on-demand key rotation + // and the rotation's completion. Once the on-demand rotation is complete, use ListKeyRotationsto // view the details of the on-demand rotation. + // + // [eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html OnDemandRotationStartDate *time.Time // The number of days between each automatic rotation. The default value is 365 diff --git a/service/kms/api_op_GetParametersForImport.go b/service/kms/api_op_GetParametersForImport.go index cf3220739fd..7c356af5bb2 100644 --- a/service/kms/api_op_GetParametersForImport.go +++ b/service/kms/api_op_GetParametersForImport.go @@ -13,56 +13,77 @@ import ( ) // Returns the public key and an import token you need to import or reimport key -// material for a KMS key. By default, KMS keys are created with key material that -// KMS generates. This operation supports Importing key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) -// , an advanced feature that lets you generate and import the cryptographic key -// material for a 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. Before calling -// GetParametersForImport , use the CreateKey operation with an Origin value of -// EXTERNAL to create a KMS key with no key material. You can import key material -// for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, -// or asymmetric signing KMS key. You can also import key material into a -// multi-Region key (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) +// material for a KMS key. +// +// By default, KMS keys are created with key material that KMS generates. This +// operation supports [Importing key material], an advanced feature that lets you generate and import the +// cryptographic key material for a KMS key. For more information about importing +// key material into KMS, see [Importing key material]in the Key Management Service Developer Guide. +// +// Before calling GetParametersForImport , use the CreateKey operation with an Origin value +// of EXTERNAL to create a KMS key with no key material. You can import key +// material for a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption +// KMS key, or asymmetric signing KMS key. You can also import key material into a [multi-Region key] // of any supported type. However, you can't import key material into a KMS key in -// a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) -// . You can also use GetParametersForImport to get a public key and import token -// to reimport the original key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material) -// into a KMS key whose key material expired or was deleted. GetParametersForImport -// returns the items that you need to import your key material. +// a [custom key store]. You can also use GetParametersForImport to get a public key and import +// token to [reimport the original key material]into a KMS key whose key material expired or was deleted. +// +// GetParametersForImport returns the items that you need to import your key +// material. +// // - The public key (or "wrapping key") of an RSA key pair that KMS generates. -// You will use this public key to encrypt ("wrap") your key material while it's in -// transit to KMS. -// - A import token that ensures that KMS can decrypt your key material and -// associate it with the correct KMS key. +// +// You will use this public key to encrypt ("wrap") your key material while it's +// +// in transit to KMS. +// +// - A import token that ensures that KMS can decrypt your key material and +// associate it with the correct KMS key. // // The public key and its import token are permanently linked and must be used // together. Each public key and import token set is valid for 24 hours. The // expiration date and time appear in the ParametersValidTo field in the // GetParametersForImport response. You cannot use an expired public key or import -// token in an ImportKeyMaterial request. If your key and token expire, send -// another GetParametersForImport request. GetParametersForImport requires the -// following information: +// token in an ImportKeyMaterialrequest. If your key and token expire, send another +// GetParametersForImport request. +// +// GetParametersForImport requires the following information: +// // - The key ID of the KMS key for which you are importing the key material. +// // - The key spec of the public key ("wrapping key") that you will use to // encrypt your key material during import. +// // - The wrapping algorithm that you will use with the public key to encrypt // your key material. // // You can use the same or a different public key spec and wrapping algorithm each -// time you import or reimport the same key material. 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) -// (key policy) Related operations: -// - ImportKeyMaterial -// - DeleteImportedKeyMaterial +// time you import or reimport the same key material. +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see [Key states of KMS keys]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] (key policy) +// +// Related operations: +// +// # ImportKeyMaterial +// +// # DeleteImportedKeyMaterial // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Importing key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [kms:GetParametersForImport]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [reimport the original key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [multi-Region key]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) GetParametersForImport(ctx context.Context, params *GetParametersForImportInput, optFns ...func(*Options)) (*GetParametersForImportOutput, error) { if params == nil { params = &GetParametersForImportInput{} @@ -81,36 +102,54 @@ func (c *Client) GetParametersForImport(ctx context.Context, params *GetParamete type GetParametersForImportInput struct { // The identifier of the KMS key that will be associated with the imported key - // material. The Origin of the KMS key must be EXTERNAL . All KMS key types are - // supported, including multi-Region keys. However, you cannot import key material - // into a KMS key in a custom key store. Specify the key ID or key ARN of the KMS - // key. For example: + // material. The Origin of the KMS key must be EXTERNAL . + // + // All KMS key types are supported, including multi-Region keys. However, you + // cannot import key material into a KMS key in a custom key store. + // + // 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 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 with the RSA public key ( PublicKey ) in the response - // to protect your key material during import. For more information, see Select a - // wrapping algorithm in the Key Management Service Developer Guide. For RSA_AES - // wrapping algorithms, you encrypt your key material with an AES key that you - // generate, then encrypt your AES key with the RSA public key from KMS. For RSAES - // wrapping algorithms, you encrypt your key material directly with the RSA public - // key from KMS. The wrapping algorithms that you can use depend on the type of key - // material that you are importing. To import an RSA private key, you must use an - // RSA_AES wrapping algorithm. + // to protect your key material during import. For more information, see Select a wrapping algorithmin the + // Key Management Service Developer Guide. + // + // For RSA_AES wrapping algorithms, you encrypt your key material with an AES key + // that you generate, then encrypt your AES key with the RSA public key from KMS. + // For RSAES wrapping algorithms, you encrypt your key material directly with the + // RSA public key from KMS. + // + // The wrapping algorithms that you can use depend on the type of key material + // that you are importing. To import an RSA private key, you must use an RSA_AES + // wrapping algorithm. + // // - RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material. + // // - RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material. + // // - RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA - // key material (private key). You cannot use the RSAES_OAEP_SHA_256 wrapping - // algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key - // material. + // key material (private key). + // + // You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 + // wrapping key spec to wrap ECC_NIST_P521 key material. + // // - RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key - // material (private key). You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm - // with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material. + // material (private key). + // + // You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 + // wrapping key spec to wrap ECC_NIST_P521 key material. + // // - RSAES_PKCS1_V1_5 (Deprecated) — As of October 10, 2023, KMS does not // support the RSAES_PKCS1_V1_5 wrapping algorithm. // @@ -119,9 +158,13 @@ type GetParametersForImportInput struct { // The type of RSA public key to return in the response. You will use this // wrapping key with the specified wrapping algorithm to protect your key material - // during import. Use the longest RSA wrapping key that is practical. You cannot - // use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. - // Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key. + // during import. + // + // Use the longest RSA wrapping key that is practical. + // + // You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private + // key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public + // key. // // This member is required. WrappingKeySpec types.WrappingKeySpec @@ -134,18 +177,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 - // same KMS key specified in the GetParametersForImport request. + // The Amazon Resource Name ([key ARN] ) of the KMS key to use in a subsequent ImportKeyMaterial request. + // This is the same KMS key specified in the GetParametersForImport request. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 ImportKeyMaterialrequest 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 . + // The public key to use to encrypt the key material before importing it with 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 9c52330f83c..d0e17429ba3 100644 --- a/service/kms/api_op_GetPublicKey.go +++ b/service/kms/api_op_GetPublicKey.go @@ -15,45 +15,64 @@ import ( // asymmetric KMS key, which never leaves KMS unencrypted, callers with // 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) -// 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 -// KMS key. When you use the public key within KMS, you benefit from the +// signatures outside of KMS. For information about asymmetric KMS keys, see [Asymmetric KMS keys]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 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 +// 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] +// - : 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. +// +// [KeyUsage] +// - : Whether the key is used for encryption or signing. +// +// [EncryptionAlgorithms] +// - or [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 // 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) -// (key policy) Related operations: CreateKey Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// 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]. +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see [Key states of KMS keys]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] (key policy) +// +// Related operations: CreateKey +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [SigningAlgorithms]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:GetPublicKey]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [EncryptionAlgorithms]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms +// [Asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [KeySpec]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec +// [Offline verification with SM2 key pairs]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification +// [KeyUsage]: https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) GetPublicKey(ctx context.Context, params *GetPublicKeyInput, optFns ...func(*Options)) (*GetPublicKeyOutput, error) { if params == nil { params = &GetPublicKeyInput{} @@ -71,26 +90,37 @@ 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 - // Services account, you must use the key ARN or alias ARN. For example: + // 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 . + // + // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string noSmithyDocumentSerde @@ -98,40 +128,53 @@ type GetPublicKeyInput struct { type GetPublicKeyOutput struct { - // Instead, use the KeySpec field in the GetPublicKey response. The KeySpec and - // CustomerMasterKeySpec fields have the same value. We recommend that you use the - // KeySpec field in your code. However, to avoid breaking changes, KMS supports - // both fields. + // Instead, use the KeySpec field in the GetPublicKey response. + // + // The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend + // that you use the KeySpec field in your code. However, to avoid breaking + // changes, KMS supports both fields. // // Deprecated: This field has been deprecated. Instead, use the KeySpec field. CustomerMasterKeySpec types.CustomerMasterKeySpec - // 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 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 . 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] ) of the asymmetric KMS key from which the public key + // was downloaded. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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]. When you use the HTTP API or the Amazon Web Services + // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. + // + // [RFC 5280]: https://tools.ietf.org/html/rfc5280 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 f595a5c9e19..b8c0273ec7d 100644 --- a/service/kms/api_op_ImportKeyMaterial.go +++ b/service/kms/api_op_ImportKeyMaterial.go @@ -14,79 +14,109 @@ import ( // Imports or reimports key material into an existing KMS key that was created // without key material. ImportKeyMaterial also sets the expiration model and -// expiration date of the imported key material. By default, KMS keys are created -// with key material that KMS generates. This operation supports Importing key -// material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) -// , an advanced feature that lets you generate and import the cryptographic key -// material for a 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. 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) -// into that KMS key, but you cannot import different key material. You might -// reimport key material to replace key material that expired or key material that -// you deleted. You might also reimport key material to change the expiration model -// or expiration date of the key material. Each time you import key material into -// KMS, you can determine whether ( ExpirationModel ) and when ( ValidTo ) the key -// material expires. To change the expiration of your key material, you must import -// it again, either by calling ImportKeyMaterial or using the import features of -// the KMS console. Before calling ImportKeyMaterial : +// expiration date of the imported key material. +// +// By default, KMS keys are created with key material that KMS generates. This +// operation supports [Importing key material], an advanced feature that lets you generate and import the +// cryptographic key material for a KMS key. For more information about importing +// key material into KMS, see [Importing key material]in the Key Management Service Developer Guide. +// +// After you successfully import key material into a KMS key, you can [reimport the same key material] into that +// KMS key, but you cannot import different key material. You might reimport key +// material to replace key material that expired or key material that you deleted. +// You might also reimport key material to change the expiration model or +// expiration date of the key material. +// +// Each time you import key material into KMS, you can determine whether ( +// ExpirationModel ) and when ( ValidTo ) the key material expires. To change the +// expiration of your key material, you must import it again, either by calling +// ImportKeyMaterial or using the import features of the KMS console. +// +// Before calling ImportKeyMaterial : +// // - Create or identify a KMS key with no key material. The KMS key must have an // Origin value of EXTERNAL , which indicates that the KMS key is designed for -// imported key material. To create an new KMS key for imported key material, call -// the CreateKey operation with an Origin value of EXTERNAL . You can create a -// symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or -// asymmetric signing KMS key. You can also import key material into a -// multi-Region key of any supported type. However, you can't import key material -// into a KMS key in a custom key store . -// - Use the DescribeKey operation to verify that the KeyState of the KMS key is -// PendingImport , which indicates that the KMS key has no key material. If you -// are reimporting the same key material into an existing KMS key, you might need -// to call the DeleteImportedKeyMaterial to delete its existing key material. -// - Call the GetParametersForImport operation to get a public key and import -// token set for importing key material. -// - Use the public key in the GetParametersForImport response to encrypt your -// key material. +// imported key material. +// +// To create an new KMS key for imported key material, call the CreateKeyoperation with an +// +// Origin value of EXTERNAL . You can create a symmetric encryption KMS key, HMAC +// KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can +// also import key material into a multi-Region keyof any supported type. However, you can't +// import key material into a KMS key in a custom key store. +// +// - Use the DescribeKeyoperation to verify that the KeyState of the KMS key is +// PendingImport , which indicates that the KMS key has no key material. +// +// If you are reimporting the same key material into an existing KMS key, you +// +// might need to call the DeleteImportedKeyMaterialto delete its existing key material. +// +// - Call the GetParametersForImportoperation to get a public key and import token set for importing +// key material. +// +// - Use the public key in the GetParametersForImportresponse to encrypt your key material. // // Then, in an ImportKeyMaterial request, you submit your encrypted key material // and import token. When calling this operation, you must specify the following // values: +// // - The key ID or key ARN of the KMS key to associate with the imported key // material. Its Origin must be EXTERNAL and its KeyState must be PendingImport . -// You cannot perform this operation on a KMS key in a custom key store , or on a -// KMS key in a different Amazon Web Services account. To get the Origin and -// KeyState of a KMS key, call DescribeKey . +// You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a +// different Amazon Web Services account. To get the Origin and KeyState of a KMS +// key, call DescribeKey. +// // - The encrypted key material. -// - The import token that GetParametersForImport returned. You must use a public -// key and token from the same GetParametersForImport response. +// +// - The import token that GetParametersForImportreturned. You must use a public key and token from +// the same GetParametersForImport response. +// // - Whether the key material expires ( ExpirationModel ) and, if so, when ( -// ValidTo ). For help with this choice, see Setting an expiration time (https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration) -// in the Key Management Service Developer Guide. If you set an expiration date, -// KMS deletes the key material from the KMS key on the specified date, making the -// KMS key unusable. To use the KMS key in cryptographic operations again, you must -// reimport the same key material. However, you can delete and reimport the key -// material at any time, including before the key material expires. Each time you -// reimport, you can eliminate or reset the expiration time. +// ValidTo ). For help with this choice, see [Setting an expiration time]in the Key Management Service +// Developer Guide. +// +// If you set an expiration date, KMS deletes the key material from the KMS key on +// +// the specified date, making the KMS key unusable. To use the KMS key in +// cryptographic operations again, you must reimport the same key material. +// However, you can delete and reimport the key material at any time, including +// before the key material expires. Each time you reimport, you can eliminate or +// reset the expiration time. // // When this operation is successful, the key state of the KMS key changes from // PendingImport to Enabled , and you can use the KMS key in cryptographic -// operations. 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) -// (key policy) Related operations: -// - DeleteImportedKeyMaterial -// - GetParametersForImport +// operations. +// +// 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 +// GetParametersForImportto 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]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]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] (key policy) +// +// Related operations: +// +// # DeleteImportedKeyMaterial +// +// # GetParametersForImport // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Importing key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [How To Import Key Material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview +// [kms:ImportKeyMaterial]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [reimport the same key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material +// [Setting an expiration time]: https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ImportKeyMaterial(ctx context.Context, params *ImportKeyMaterialInput, optFns ...func(*Options)) (*ImportKeyMaterialOutput, error) { if params == nil { params = &ImportKeyMaterialInput{} @@ -105,57 +135,71 @@ func (c *Client) ImportKeyMaterial(ctx context.Context, params *ImportKeyMateria type ImportKeyMaterialInput struct { // The encrypted key material to import. The key material must be encrypted under - // the public wrapping key that GetParametersForImport returned, using the - // wrapping algorithm that you specified in the same GetParametersForImport - // request. + // the public wrapping key that GetParametersForImportreturned, using the wrapping algorithm that you + // specified in the same GetParametersForImport request. // // This member is required. EncryptedKeyMaterial []byte - // The import token that you received in the response to a previous - // GetParametersForImport request. It must be from the same response that contained - // the public key that you used to encrypt the key material. + // The import token that you received in the response to a previous GetParametersForImport request. It + // must be from the same response that contained the public key that you used to + // encrypt the key material. // // This member is required. ImportToken []byte // The identifier of the KMS key that will be associated with 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 and its KeyState must be PendingImport . The KMS key can be a symmetric - // encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric - // signing KMS key, including a multi-Region key of any supported type. You cannot - // perform this operation on 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: + // corresponding GetParametersForImportrequest. The Origin of the KMS key must be EXTERNAL and its + // KeyState must be PendingImport . + // + // The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric + // encryption KMS key, or asymmetric signing KMS key, including a multi-Region keyof any supported + // type. You cannot perform this operation on 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 . + // + // 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 - // . For help with this choice, see Setting an expiration time (https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration) - // in the Key Management Service Developer Guide. 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 - // reimport the key material. + // . For help with this choice, see [Setting an expiration time]in the Key Management Service Developer Guide. + // + // 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 reimport the key + // material. + // + // [Setting an expiration time]: https://docs.aws.amazon.com/en_us/kms/latest/developerguide/importing-keys.html#importing-keys-expiration 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. + // . 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 22797e06bb6..a9bff503f88 100644 --- a/service/kms/api_op_ListAliases.go +++ b/service/kms/api_op_ListAliases.go @@ -12,29 +12,45 @@ 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 +// 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 +// 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]. +// +// Cross-account use: No. ListAliases does not return aliases in other Amazon Web +// Services accounts. +// +// Required permissions: [kms:ListAliases] (IAM policy) +// +// For details, see [Controlling access to aliases] in the Key Management Service Developer Guide. +// +// Related operations: +// +// # CreateAlias +// +// # DeleteAlias +// +// # UpdateAlias // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [KMS aliases quota]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit +// [kms:ListAliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Controlling access to aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error) { if params == nil { params = &ListAliasesInput{} @@ -53,20 +69,29 @@ func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optF type ListAliasesInput struct { // Lists only aliases that are associated with the specified KMS key. Enter a KMS - // 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 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 . + // + // 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 // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 100, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit *int32 // Use this parameter in a subsequent request after you receive a response with @@ -185,9 +210,10 @@ var _ ListAliasesAPIClient = (*Client)(nil) type ListAliasesPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 100, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_ListGrants.go b/service/kms/api_op_ListGrants.go index 78f9cff9bf1..e56605b4f01 100644 --- a/service/kms/api_op_ListGrants.go +++ b/service/kms/api_op_ListGrants.go @@ -11,29 +11,45 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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] in the +// Key Management Service Developer Guide . For examples of working with grants in +// several programming languages, see [Programming grants]. +// +// 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: -// 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) -// (key policy) Related operations: -// - CreateGrant -// - ListRetirableGrants -// - RetireGrant -// - RevokeGrant +// GranteePrincipal field contains the [service principal], 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] (key policy) +// +// Related operations: +// +// # CreateGrant +// +// # ListRetirableGrants +// +// # RetireGrant +// +// # RevokeGrant // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Programming grants]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html +// [service principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services +// [Grants in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html +// [kms:ListGrants]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ListGrants(ctx context.Context, params *ListGrantsInput, optFns ...func(*Options)) (*ListGrantsOutput, error) { if params == nil { params = &ListGrantsInput{} @@ -52,12 +68,18 @@ func (c *Client) ListGrants(ctx context.Context, params *ListGrantsInput, optFns 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string @@ -72,9 +94,10 @@ type ListGrantsInput struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 100, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit *int32 // Use this parameter in a subsequent request after you receive a response with @@ -196,9 +219,10 @@ var _ ListGrantsAPIClient = (*Client)(nil) type ListGrantsPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 100, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_ListKeyPolicies.go b/service/kms/api_op_ListKeyPolicies.go index 782725ab2bc..4983a9f67d7 100644 --- a/service/kms/api_op_ListKeyPolicies.go +++ b/service/kms/api_op_ListKeyPolicies.go @@ -11,17 +11,26 @@ 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: -// 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) -// (key policy) Related operations: -// - GetKeyPolicy -// - PutKeyPolicy (https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) +// operation is designed to get policy names that you can use in a GetKeyPolicyoperation. +// 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] (key policy) +// +// Related operations: +// +// # GetKeyPolicy +// +// [PutKeyPolicy] // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [kms:ListKeyPolicies]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [PutKeyPolicy]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ListKeyPolicies(ctx context.Context, params *ListKeyPoliciesInput, optFns ...func(*Options)) (*ListKeyPoliciesOutput, error) { if params == nil { params = &ListKeyPoliciesInput{} @@ -39,21 +48,30 @@ func (c *Client) ListKeyPolicies(ctx context.Context, params *ListKeyPoliciesInp 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 1000, inclusive. If you do not include a value, it - // defaults to 100. Only one policy can be attached to a key. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 1000, + // inclusive. If you do not include a value, it defaults to 100. + // + // Only one policy can be attached to a key. Limit *int32 // Use this parameter in a subsequent request after you receive a response with @@ -176,9 +194,12 @@ var _ ListKeyPoliciesAPIClient = (*Client)(nil) type ListKeyPoliciesPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 1000, inclusive. If you do not include a value, it - // defaults to 100. Only one policy can be attached to a key. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 1000, + // inclusive. If you do not include a value, it defaults to 100. + // + // Only one policy can be attached to a key. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_ListKeyRotations.go b/service/kms/api_op_ListKeyRotations.go index 6c7ae5e6553..42da68b06b7 100644 --- a/service/kms/api_op_ListKeyRotations.go +++ b/service/kms/api_op_ListKeyRotations.go @@ -12,22 +12,35 @@ import ( ) // Returns information about all completed key material rotations for the -// specified KMS key. You must specify the KMS key in all requests. You can refine -// the key rotations list by limiting the number of rotations returned. For -// detailed information about automatic and on-demand key rotations, see Rotating -// KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.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:ListKeyRotations (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// (key policy) Related operations: -// - EnableKeyRotation -// - DisableKeyRotation -// - GetKeyRotationStatus -// - RotateKeyOnDemand +// specified KMS key. +// +// You must specify the KMS key in all requests. You can refine the key rotations +// list by limiting the number of rotations returned. +// +// For detailed information about automatic and on-demand key rotations, see [Rotating KMS keys] 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:ListKeyRotations] (key policy) +// +// Related operations: +// +// # EnableKeyRotation +// +// # DisableKeyRotation +// +// # GetKeyRotationStatus +// +// # RotateKeyOnDemand // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Rotating KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html +// [kms:ListKeyRotations]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ListKeyRotations(ctx context.Context, params *ListKeyRotationsInput, optFns ...func(*Options)) (*ListKeyRotationsOutput, error) { if params == nil { params = &ListKeyRotationsInput{} @@ -45,21 +58,28 @@ func (c *Client) ListKeyRotations(ctx context.Context, params *ListKeyRotationsI type ListKeyRotationsInput struct { - // Gets the key rotations for the specified KMS key. Specify the key ID or key ARN - // of the KMS key. For example: + // Gets the key rotations 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 1000, inclusive. If you do not include a value, it - // defaults to 100. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 1000, + // inclusive. If you do not include a value, it defaults to 100. Limit *int32 // Use this parameter in a subsequent request after you receive a response with @@ -182,9 +202,10 @@ var _ ListKeyRotationsAPIClient = (*Client)(nil) type ListKeyRotationsPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 1000, inclusive. If you do not include a value, it - // defaults to 100. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 1000, + // inclusive. If you do not include a value, it defaults to 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_ListKeys.go b/service/kms/api_op_ListKeys.go index ded325cbf35..1b10793bbec 100644 --- a/service/kms/api_op_ListKeys.go +++ b/service/kms/api_op_ListKeys.go @@ -12,17 +12,28 @@ 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) -// (IAM policy) Related operations: -// - CreateKey -// - DescribeKey -// - ListAliases -// - ListResourceTags +// 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] (IAM policy) +// +// Related operations: +// +// # CreateKey +// +// # DescribeKey +// +// # ListAliases +// +// # ListResourceTags // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [kms:ListKeys]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ListKeys(ctx context.Context, params *ListKeysInput, optFns ...func(*Options)) (*ListKeysOutput, error) { if params == nil { params = &ListKeysInput{} @@ -42,9 +53,10 @@ type ListKeysInput struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 1000, inclusive. If you do not include a value, it - // defaults to 100. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 1000, + // inclusive. If you do not include a value, it defaults to 100. Limit *int32 // Use this parameter in a subsequent request after you receive a response with @@ -163,9 +175,10 @@ var _ ListKeysAPIClient = (*Client)(nil) type ListKeysPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 1000, inclusive. If you do not include a value, it - // defaults to 100. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 1000, + // inclusive. If you do not include a value, it defaults to 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_ListResourceTags.go b/service/kms/api_op_ListResourceTags.go index 54ca42ca18c..7e87bdef71f 100644 --- a/service/kms/api_op_ListResourceTags.go +++ b/service/kms/api_op_ListResourceTags.go @@ -11,22 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// different Amazon Web Services account. Required permissions: -// kms:ListResourceTags (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// (key policy) Related operations: -// - CreateKey -// - ReplicateKey -// - TagResource -// - UntagResource +// Returns all tags on the specified KMS key. +// +// For general information about tags, including the format and syntax, see [Tagging Amazon Web Services resources] in +// the Amazon Web Services General Reference. For information about using tags in +// KMS, see [Tagging keys]. +// +// Cross-account use: No. You cannot perform this operation on a KMS key in a +// different Amazon Web Services account. +// +// Required permissions: [kms:ListResourceTags] (key policy) +// +// Related operations: +// +// # CreateKey +// +// # ReplicateKey +// +// # TagResource +// +// # UntagResource // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Tagging keys]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html +// [kms:ListResourceTags]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html func (c *Client) ListResourceTags(ctx context.Context, params *ListResourceTagsInput, optFns ...func(*Options)) (*ListResourceTagsOutput, error) { if params == nil { params = &ListResourceTagsInput{} @@ -44,27 +56,36 @@ func (c *Client) ListResourceTags(ctx context.Context, params *ListResourceTagsI type ListResourceTagsInput struct { - // Gets tags on the specified KMS key. Specify the key ID or key ARN of the KMS - // key. For example: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 50, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 50, + // inclusive. If you do not include a value, it defaults to 50. 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. + // 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 @@ -73,14 +94,17 @@ type ListResourceTagsInput struct { type ListResourceTagsOutput struct { // When Truncated is true, this element is present and contains the value to use - // for the Marker parameter in a subsequent request. Do not assume or infer any - // information from this value. + // for the Marker parameter in a subsequent request. + // + // Do not assume or infer any information from this value. NextMarker *string - // 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. + // 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]in the Key Management Service Developer Guide. + // + // [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html Tags []types.Tag // A flag that indicates whether there are more items in the list. When this value @@ -186,9 +210,10 @@ var _ ListResourceTagsAPIClient = (*Client)(nil) type ListResourceTagsPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 50, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 50, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_ListRetirableGrants.go b/service/kms/api_op_ListRetirableGrants.go index cc578fd9936..b0caa931cbf 100644 --- a/service/kms/api_op_ListRetirableGrants.go +++ b/service/kms/api_op_ListRetirableGrants.go @@ -12,36 +12,50 @@ import ( ) // Returns information about all grants in the Amazon Web Services account and -// Region that have the specified retiring principal. You can specify any principal -// 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 +// Region that have the specified retiring principal. +// +// You can specify any principal 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 RetireGrantoperation. +// +// For detailed information about grants, including grant terminology, see [Grants in KMS] in the +// Key Management Service Developer Guide . For examples of working with grants in +// several programming languages, see [Programming grants]. +// +// Cross-account use: You must specify a principal in your Amazon Web Services // account. This operation returns a list of grants where the retiring principal // specified in the ListRetirableGrants request is the same retiring principal on // the grant. This can include grants on KMS keys owned by other Amazon Web // Services accounts, but 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) -// (IAM policy) in your Amazon Web Services account. KMS authorizes -// ListRetirableGrants requests by evaluating the caller account's +// your own. +// +// Required permissions: [kms:ListRetirableGrants] (IAM policy) in your Amazon Web Services account. +// +// KMS authorizes ListRetirableGrants requests by evaluating the caller account's // kms:ListRetirableGrants permissions. The authorized resource in // ListRetirableGrants calls is the retiring principal specified in the request. // KMS does not evaluate the caller's permissions to verify their access to any KMS -// keys or grants that might be returned by the ListRetirableGrants call. Related -// operations: -// - CreateGrant -// - ListGrants -// - RetireGrant -// - RevokeGrant +// keys or grants that might be returned by the ListRetirableGrants call. +// +// Related operations: +// +// # CreateGrant +// +// # ListGrants +// +// # RetireGrant +// +// # RevokeGrant // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Programming grants]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html +// [kms:ListRetirableGrants]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Grants in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ListRetirableGrants(ctx context.Context, params *ListRetirableGrantsInput, optFns ...func(*Options)) (*ListRetirableGrantsOutput, error) { if params == nil { params = &ListRetirableGrantsInput{} @@ -60,21 +74,25 @@ func (c *Client) ListRetirableGrants(ctx context.Context, params *ListRetirableG 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) - // in the Identity and Access Management User Guide . + // Amazon Web Services account. + // + // To specify the retiring 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]in the Identity and Access Management User Guide . + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. RetiringPrincipal *string // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 100, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit *int32 // Use this parameter in a subsequent request after you receive a response with @@ -198,9 +216,10 @@ var _ ListRetirableGrantsAPIClient = (*Client)(nil) type ListRetirableGrantsPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, KMS does not return more than the specified number of items, - // but it might return fewer. This value is optional. If you include a value, it - // must be between 1 and 100, inclusive. If you do not include a value, it defaults - // to 50. + // but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/kms/api_op_PutKeyPolicy.go b/service/kms/api_op_PutKeyPolicy.go index 4d9da0789f9..492e0c40daa 100644 --- a/service/kms/api_op_PutKeyPolicy.go +++ b/service/kms/api_op_PutKeyPolicy.go @@ -10,19 +10,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// (key policy) Related operations: GetKeyPolicy Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// Attaches a key policy to the specified KMS key. +// +// For more information about key policies, see [Key Policies] in the Key Management Service +// Developer Guide. For help writing and formatting a JSON policy document, see the +// [IAM JSON Policy Reference]in the Identity and Access Management User Guide . For examples of adding a key +// policy in multiple programming languages, see [Setting a key 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] (key policy) +// +// Related operations: GetKeyPolicy +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [IAM JSON Policy Reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html +// [kms:PutKeyPolicy]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Setting a key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy +// [Key Policies]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) PutKeyPolicy(ctx context.Context, params *PutKeyPolicyInput, optFns ...func(*Options)) (*PutKeyPolicyOutput, error) { if params == nil { params = &PutKeyPolicyInput{} @@ -40,53 +50,75 @@ func (c *Client) PutKeyPolicy(ctx context.Context, params *PutKeyPolicyInput, op 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: + // 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 . + // + // 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 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.) + // becomes unmanageable. For more information, see [Default key policy]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. + // be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible]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) + // + // For information about key policies, see [Key policies in KMS] in the Key Management Service + // Developer Guide.For help writing and formatting a JSON policy document, see the [IAM JSON Policy Reference] // in the Identity and Access Management User Guide . // + // [Key policies in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html + // [IAM JSON Policy Reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key + // [Changes that I make are not always immediately visible]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency + // // This member is required. Policy *string // 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) - // 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 (https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) - // request on the KMS key. + // 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] 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. + // + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key + // [PutKeyPolicy]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html BypassPolicyLockoutSafetyCheck bool // The name of the key policy. If no policy name is specified, the default value diff --git a/service/kms/api_op_ReEncrypt.go b/service/kms/api_op_ReEncrypt.go index cbcd4c4934e..8eca789a2e6 100644 --- a/service/kms/api_op_ReEncrypt.go +++ b/service/kms/api_op_ReEncrypt.go @@ -13,24 +13,24 @@ import ( // 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) -// 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) -// 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 +// you [manually rotate]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]of +// a ciphertext. +// +// The ReEncrypt operation can decrypt ciphertext that was encrypted by using a +// KMS key in an KMS operation, such as Encryptor GenerateDataKey. It can also decrypt ciphertext that +// was encrypted by using the public key of an [asymmetric KMS key]outside of KMS. However, it cannot +// decrypt ciphertext produced by other libraries, such as the [Amazon Web Services Encryption SDK]or [Amazon S3 client-side encryption]. 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 @@ -41,46 +41,72 @@ import ( // 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. +// 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) +// For details, see [Key states of KMS keys]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] +// - permission on the source KMS key (key policy) +// +// [kms:ReEncryptTo] +// - 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 +// permission in your [key policy]. 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 // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Amazon Web Services Encryption SDK]: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/ +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [asymmetric KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks +// [key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html +// [Amazon S3 client-side encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html +// [kms:ReEncryptTo]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [manually rotate]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually +// [kms:ReEncryptFrom]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) ReEncrypt(ctx context.Context, params *ReEncryptInput, optFns ...func(*Options)) (*ReEncryptOutput, error) { if params == nil { params = &ReEncryptInput{} @@ -105,94 +131,135 @@ type ReEncryptInput struct { // 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: + // 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 . + // + // 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 - // encryption algorithm used for symmetric encryption KMS keys. This parameter is - // required only when the destination KMS key is an asymmetric KMS key. + // 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 - // Specifies that encryption context to use when the reencrypting the data. Do not - // include confidential or sensitive information in this field. This field may be - // displayed in plaintext in CloudTrail logs and other output. A destination - // encryption context is valid only when the destination KMS key is a symmetric - // encryption KMS key. The standard ciphertext format for asymmetric KMS keys does - // not include fields for metadata. 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) - // in the Key Management Service Developer Guide. + // Specifies that encryption context to use when the reencrypting the data. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // A destination encryption context is valid only when the destination KMS key is + // a symmetric encryption KMS key. The standard ciphertext format for asymmetric + // KMS keys does not include fields for metadata. + // + // 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] in the Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context DestinationEncryptionContext map[string]string - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token 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 - // 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 - // was encrypted under an asymmetric KMS key. + // 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 was encrypted under an + // asymmetric KMS key. SourceEncryptionAlgorithm types.EncryptionAlgorithmSpec // Specifies the encryption context to use to decrypt the ciphertext. Enter the - // same encryption context that was used to encrypt the ciphertext. 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) - // in the Key Management Service Developer Guide. + // same encryption context that was used to encrypt the ciphertext. + // + // 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] in the Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context 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 - // 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: + // 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 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 . + // + // 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 @@ -207,8 +274,9 @@ 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] ) of the KMS key that was used to reencrypt the data. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 4eb5fc4cceb..2f6e7ae15c4 100644 --- a/service/kms/api_op_ReplicateKey.go +++ b/service/kms/api_op_ReplicateKey.go @@ -15,29 +15,24 @@ import ( // a multi-Region replica key based on a multi-Region primary key in a different // Region of the same Amazon Web Services partition. You can create multiple // replicas of a primary key, but each must be in a different Region. To create a -// multi-Region primary key, use the CreateKey operation. 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) -// 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. +// multi-Region primary key, use the CreateKeyoperation. +// +// 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]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]and key material. +// They also have the same [key spec], [key usage], [key material origin], and [automatic key rotation status]. KMS automatically synchronizes these shared +// properties among related multi-Region keys. All other properties of a replica +// key can differ, including its [key policy], [tags], [aliases], and [Key states of KMS keys]. 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 @@ -45,39 +40,64 @@ import ( // 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 +// state, see [Key states of KMS keys]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 -// key with imported key material, the replica key is created with no key material. -// You must import the same key material that you imported into the primary key. -// For details, see Importing key material into multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html) -// 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: +// the same [shared 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 CreateKeyoperation in the replica key's Region. +// +// If you replicate a multi-Region primary key with imported key material, the +// replica key is created with no key material. You must import the same key +// material that you imported into the primary key. 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: +// // - 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 // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [key ID]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id +// [automatic key rotation status]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html +// [aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html +// [key usage]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage +// [Multi-Region keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html +// [key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [tags]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [key spec]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec +// [Importing key material into multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html +// [key material origin]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin +// [shared properties]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties func (c *Client) ReplicateKey(ctx context.Context, params *ReplicateKeyInput, optFns ...func(*Options)) (*ReplicateKeyOutput, error) { if params == nil { params = &ReplicateKeyInput{} @@ -96,108 +116,150 @@ func (c *Client) ReplicateKey(ctx context.Context, params *ReplicateKeyInput, op 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: + // whether a KMS key is a multi-Region primary key, use the DescribeKeyoperation 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 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 - // 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) - // in the Amazon Web Services General Reference. + // 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]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]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)]in the Amazon + // Web Services General Reference. For information about enabling and disabling + // Regions, see [Enabling a Region]and [Disabling a Region] in the Amazon Web Services General Reference. + // + // [Disabling a Region]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable + // [Enabling a Region]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable + // [KMS service endpoints]: https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region + // [HMAC keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ReplicaRegion *string // 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) - // 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 (https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) - // request on the KMS key. + // 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] 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. + // + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key + // [PutKeyPolicy]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html BypassPolicyLockoutSafetyCheck bool // A description of the KMS key. The default value is an empty string (no - // description). Do not include confidential or sensitive information in this - // field. This field may be displayed in plaintext in CloudTrail logs and other - // output. The description is not a shared property of multi-Region keys. You can - // specify the same description or a different description for each key in a set of - // related multi-Region keys. KMS does not synchronize this property. + // description). + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // The description is not a shared property of multi-Region keys. You can specify + // the same description or a different description for each key in a set of related + // multi-Region keys. KMS does not synchronize this property. 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) - // 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: + // not provide a key policy, KMS attaches the [default key policy]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.) + // becomes unmanageable. For more information, see [Default key policy]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. + // be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible]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 . + // + // For information about key policies, see [Key policies in KMS] in the Key Management Service + // Developer Guide. For help writing and formatting a JSON policy document, see the + // [IAM JSON Policy Reference]in the Identity and Access Management User Guide . + // + // [Key policies in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html + // [default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default + // [IAM JSON Policy Reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html + // [Default key policy]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key + // [Changes that I make are not always immediately visible]: https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency 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. Do not include confidential or sensitive information in this field. - // This field may be displayed in plaintext in CloudTrail logs and other output. + // key when it is created. To tag an existing KMS key, use the TagResourceoperation. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // // 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) - // 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 - // 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 same tag key. If you specify an existing tag - // key with a different tag value, KMS 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) - // . + // details, see [ABAC for KMS]in the Key Management Service Developer Guide. + // + // To use this parameter, you must have [kms:TagResource] 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 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 same tag key. If you specify an + // existing tag key with a different tag value, KMS 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]. + // + // [kms:TagResource]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + // [Tagging Keys]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html + // [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html Tags []types.Tag noSmithyDocumentSerde @@ -205,11 +267,12 @@ 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] + // ) and [Key states of KMS keys]. It also includes the ARN and Amazon Web Services Region of its primary + // key and other replica keys. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN + // [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html 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 e52867b2461..df3e02ef06b 100644 --- a/service/kms/api_op_RetireGrant.go +++ b/service/kms/api_op_RetireGrant.go @@ -11,30 +11,44 @@ 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. -// 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) -// 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 -// 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) -// in the Key Management Service Developer Guide. Related operations: -// - CreateGrant -// - ListGrants -// - ListRetirableGrants -// - RevokeGrant +// permissions. To identify the grant to retire, use a [grant token], or both the grant ID and +// a key identifier (key ID or key ARN) of the KMS key. The CreateGrantoperation 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]in the Key Management Service Developer Guide. +// +// For detailed information about grants, including grant terminology, see [Grants in KMS] in the +// Key Management Service Developer Guide . For examples of working with grants in +// several programming languages, see [Programming grants]. +// +// 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]in the Key Management Service Developer Guide. +// +// Related operations: +// +// # CreateGrant +// +// # ListGrants +// +// # ListRetirableGrants +// +// # RevokeGrant // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Programming grants]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html +// [grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token +// [Retiring and revoking grants]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete +// [Grants in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) RetireGrant(ctx context.Context, params *RetireGrantInput, optFns ...func(*Options)) (*RetireGrantOutput, error) { if params == nil { params = &RetireGrantInput{} @@ -52,26 +66,34 @@ func (c *Client) RetireGrant(ctx context.Context, params *RetireGrantInput, optF type RetireGrantInput struct { - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // Identifies the grant to retire. To get the grant ID, use CreateGrant , - // ListGrants , or ListRetirableGrants . + // 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) - // in the Key Management Service Developer Guide. + // grant even before it has achieved eventual consistency. + // + // Only the CreateGrant operation returns a grant token. For details, see [Grant token] and [Eventual consistency] in the Key + // Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency GrantToken *string - // The key ARN KMS key associated with the grant. To find the key ARN, use the - // ListKeys operation. For example: + // The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys + // operation. + // + // For example: // arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab KeyId *string diff --git a/service/kms/api_op_RevokeGrant.go b/service/kms/api_op_RevokeGrant.go index ca1a1eceb76..582f5dbe47a 100644 --- a/service/kms/api_op_RevokeGrant.go +++ b/service/kms/api_op_RevokeGrant.go @@ -11,27 +11,43 @@ 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/grant-manage.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) -// 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 +// that the grant allows. For more information, see [Retiring and revoking grants]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]in the Key +// Management Service Developer Guide . +// +// For detailed information about grants, including grant terminology, see [Grants in KMS] in the +// Key Management Service Developer Guide . For examples of working with grants in +// several programming languages, see [Programming grants]. +// +// 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) -// (key policy). Related operations: -// - CreateGrant -// - ListGrants -// - ListRetirableGrants -// - RetireGrant +// parameter. +// +// Required permissions: [kms:RevokeGrant] (key policy). +// +// Related operations: +// +// # CreateGrant +// +// # ListGrants +// +// # ListRetirableGrants +// +// # RetireGrant // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency +// [Programming grants]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html +// [kms:RevokeGrant]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [Retiring and revoking grants]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete +// [Grants in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) RevokeGrant(ctx context.Context, params *RevokeGrantInput, optFns ...func(*Options)) (*RevokeGrantOutput, error) { if params == nil { params = &RevokeGrantInput{} @@ -49,27 +65,35 @@ 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: + // ID and key ARN for a KMS key, use ListKeysor 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool noSmithyDocumentSerde diff --git a/service/kms/api_op_RotateKeyOnDemand.go b/service/kms/api_op_RotateKeyOnDemand.go index 9c11de8b796..e54b429e78a 100644 --- a/service/kms/api_op_RotateKeyOnDemand.go +++ b/service/kms/api_op_RotateKeyOnDemand.go @@ -11,46 +11,67 @@ import ( ) // Immediately initiates rotation of the key material of the specified symmetric -// encryption KMS key. You can perform on-demand rotation (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand) -// of the key material in customer managed KMS keys, regardless of whether or not -// automatic key rotation (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable) -// is enabled. On-demand rotations do not change existing automatic rotation -// schedules. For example, consider a KMS key that has automatic key rotation -// enabled with a rotation period of 730 days. If the key is scheduled to -// automatically rotate on April 14, 2024, and you perform an on-demand rotation on -// April 10, 2024, the key will automatically rotate, as scheduled, on April 14, -// 2024 and every 730 days thereafter. You can perform on-demand key rotation a -// maximum of 10 times per KMS key. You can use the KMS console to view the number -// of remaining on-demand rotations available for a KMS key. You can use -// GetKeyRotationStatus to identify any in progress on-demand rotations. You can -// use ListKeyRotations to identify the date that completed on-demand rotations -// were performed. You can monitor rotation of the key material for your KMS keys -// in CloudTrail and Amazon CloudWatch. On-demand key rotation is supported only on -// symmetric encryption KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) -// . You cannot perform on-demand 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 perform on-demand 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) -// , invoke the on-demand rotation on the primary key. You cannot initiate -// on-demand rotation of 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) -// is managed by the Amazon Web Services service that owns the 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:RotateKeyOnDemand (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) -// (key policy) Related operations: -// - EnableKeyRotation -// - DisableKeyRotation -// - GetKeyRotationStatus -// - ListKeyRotations +// encryption KMS key. +// +// You can perform [on-demand rotation] of the key material in customer managed KMS keys, regardless +// of whether or not [automatic key rotation]is enabled. On-demand rotations do not change existing +// automatic rotation schedules. For example, consider a KMS key that has automatic +// key rotation enabled with a rotation period of 730 days. If the key is scheduled +// to automatically rotate on April 14, 2024, and you perform an on-demand rotation +// on April 10, 2024, the key will automatically rotate, as scheduled, on April 14, +// 2024 and every 730 days thereafter. +// +// You can perform on-demand key rotation a maximum of 10 times per KMS key. You +// can use the KMS console to view the number of remaining on-demand rotations +// available for a KMS key. +// +// You can use GetKeyRotationStatus to identify any in progress on-demand rotations. You can use ListKeyRotations to +// identify the date that completed on-demand rotations were performed. You can +// monitor rotation of the key material for your KMS keys in CloudTrail and Amazon +// CloudWatch. +// +// On-demand key rotation is supported only on [symmetric encryption KMS keys]. You cannot perform on-demand +// rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To perform on-demand +// rotation of a set of related [multi-Region keys], invoke the on-demand rotation on the primary key. +// +// You cannot initiate on-demand rotation of [Amazon Web Services managed KMS keys]. KMS always rotates the key material +// of Amazon Web Services managed keys every year. Rotation of [Amazon Web Services owned KMS keys]is managed by the +// Amazon Web Services service that owns the 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]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:RotateKeyOnDemand] (key policy) +// +// Related operations: +// +// # EnableKeyRotation +// +// # DisableKeyRotation +// +// # GetKeyRotationStatus +// +// # ListKeyRotations // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [on-demand rotation]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand +// [Amazon Web Services owned KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk +// [automatic key rotation]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable +// [kms:RotateKeyOnDemand]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html +// [Amazon Web Services managed KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk +// [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [symmetric encryption KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html func (c *Client) RotateKeyOnDemand(ctx context.Context, params *RotateKeyOnDemandInput, optFns ...func(*Options)) (*RotateKeyOnDemandOutput, error) { if params == nil { params = &RotateKeyOnDemandInput{} @@ -69,17 +90,25 @@ func (c *Client) RotateKeyOnDemand(ctx context.Context, params *RotateKeyOnDeman type RotateKeyOnDemandInput struct { // Identifies a symmetric encryption KMS key. You cannot perform on-demand - // 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 perform on-demand 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) - // , invoke the on-demand rotation on the primary key. Specify the key ID or key - // ARN of the KMS key. For example: + // rotation of [asymmetric KMS keys], [HMAC KMS keys], KMS keys with [imported key material], or KMS keys in a [custom key store]. To perform on-demand + // rotation of a set of related [multi-Region keys], invoke the on-demand rotation 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. + // + // [imported key material]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html + // [HMAC KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html + // [asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + // [multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate + // [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html // // This member is required. KeyId *string diff --git a/service/kms/api_op_ScheduleKeyDeletion.go b/service/kms/api_op_ScheduleKeyDeletion.go index a8e3354fbc8..f2de79497f1 100644 --- a/service/kms/api_op_ScheduleKeyDeletion.go +++ b/service/kms/api_op_ScheduleKeyDeletion.go @@ -17,46 +17,62 @@ import ( // 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 (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) -// , or an asymmetric or HMAC KMS key with imported key material .) To prevent the -// use of a KMS key 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) -// 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 -// 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 +// you can use CancelKeyDeletionto 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], or an asymmetric or HMAC KMS key with imported key material.) To prevent the use of a KMS +// key 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] in the Key +// Management Service Developer Guide. +// +// When KMS [deletes a KMS key from an CloudHSM key store], 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]from the +// cluster and its backups. [Deleting a KMS key from an external key store]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] 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]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 // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [delete the orphaned key material]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [Deleting a KMS key from an external key store]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html +// [Deleting multi-Region keys]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html +// [Deleting KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html +// [multi-Region replica key]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [deletes a KMS key from an CloudHSM key store]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html func (c *Client) ScheduleKeyDeletion(ctx context.Context, params *ScheduleKeyDeletionInput, optFns ...func(*Options)) (*ScheduleKeyDeletionOutput, error) { if params == nil { params = &ScheduleKeyDeletionInput{} @@ -74,25 +90,35 @@ 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string // The waiting period, specified in number of days. After the waiting period ends, - // KMS deletes the KMS key. If the KMS key is a multi-Region primary key with - // replica keys, the waiting period begins when the last of its replica keys is - // deleted. Otherwise, the waiting period begins immediately. This value is - // optional. If you include a value, it must be between 7 and 30, inclusive. If you - // do not include a value, it defaults to 30. You can use the - // kms:ScheduleKeyDeletionPendingWindowInDays (https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-schedule-key-deletion-pending-window-in-days) - // condition key to further constrain the values that principals can specify in the - // PendingWindowInDays parameter. + // KMS deletes the KMS key. + // + // If the KMS key is a multi-Region primary key with replica keys, the waiting + // period begins when the last of its replica keys is deleted. Otherwise, the + // waiting period begins immediately. + // + // This value is optional. If you include a value, it must be between 7 and 30, + // inclusive. If you do not include a value, it defaults to 30. You can use the [kms:ScheduleKeyDeletionPendingWindowInDays] + // kms:ScheduleKeyDeletionPendingWindowInDays condition key to further constrain + // the values that principals can specify in the PendingWindowInDays parameter. + // + // [kms:ScheduleKeyDeletionPendingWindowInDays]: https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-schedule-key-deletion-pending-window-in-days PendingWindowInDays *int32 noSmithyDocumentSerde @@ -100,25 +126,31 @@ type ScheduleKeyDeletionInput struct { type ScheduleKeyDeletionOutput struct { - // The date and time after which KMS deletes the KMS key. If the KMS key is a - // multi-Region primary key with replica keys, this field does not appear. The - // deletion date for the primary key isn't known until its last replica key is - // deleted. + // The date and time after which KMS deletes the KMS key. + // + // If the KMS key is a multi-Region primary key with replica keys, this field does + // not appear. The deletion date for the primary key isn't known until its last + // replica key is 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] ) of the KMS key whose deletion is scheduled. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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. + // 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] in + // the Key Management Service Developer Guide. + // + // [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html KeyState types.KeyState - // The waiting period before the KMS key is deleted. If the KMS key is a - // multi-Region primary key with replicas, the waiting period begins when the last - // of its replica keys is deleted. Otherwise, the waiting period begins - // immediately. + // The waiting period before the KMS key is deleted. + // + // If the KMS key is a multi-Region primary key with replicas, the waiting period + // begins when the last of its replica keys is deleted. Otherwise, the waiting + // period begins immediately. PendingWindowInDays *int32 // Metadata pertaining to the operation's result. diff --git a/service/kms/api_op_Sign.go b/service/kms/api_op_Sign.go index c69fe69e42c..ebd7cf5e70e 100644 --- a/service/kms/api_op_Sign.go +++ b/service/kms/api_op_Sign.go @@ -11,48 +11,63 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a digital signature (https://en.wikipedia.org/wiki/Digital_signature) -// 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) -// 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 -// their private key to sign a message. Anyone with the public key can verify that -// 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: +// Creates a [digital signature] for a message or message digest by using the private key in an +// asymmetric signing KMS key. To verify the signature, use the Verifyoperation, or use +// the public key in the same asymmetric KMS key outside of KMS. For information +// about asymmetric KMS keys, see [Asymmetric KMS keys]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 their private key to sign a message. Anyone +// with the public key can verify that 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. +// 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) -// (key policy) Related operations: Verify Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// 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 GetPublicKeyoperation 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]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] (key policy) +// +// Related operations: Verify +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [digital signature]: https://en.wikipedia.org/wiki/Digital_signature +// [Asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [kms:Sign]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) Sign(ctx context.Context, params *SignInput, optFns ...func(*Options)) (*SignOutput, error) { if params == nil { params = &SignInput{} @@ -73,70 +88,95 @@ 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 . + // + // 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 or message digest to sign. Messages can be 0-4096 bytes. - // To sign a larger message, provide a message digest. If you provide a message - // digest, use the DIGEST value of MessageType to prevent the digest from being - // hashed again while signing. + // To sign a larger message, provide a message digest. + // + // If you provide a message digest, use the DIGEST value of MessageType to prevent + // the digest from being hashed again while signing. // // This member is required. Message []byte - // Specifies the signing algorithm to use when signing the message. Choose an - // algorithm that is compatible with the type and size of the specified asymmetric - // KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. - // We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing - // applications. + // Specifies the signing algorithm to use when signing the message. + // + // Choose an algorithm that is compatible with the type and size of the specified + // asymmetric KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are + // preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with + // existing applications. // // This member is required. SigningAlgorithm types.SigningAlgorithmSpec - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token 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 - // 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 - // 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 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. + // 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 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 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) - // . + // + // - SM2DSA uses the SM3 hashing algorithm. For details, see [Offline verification with SM2 key pairs]. + // + // [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 @@ -144,21 +184,27 @@ 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] ) of the asymmetric KMS key that was used to sign the + // message. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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) - // . + // value is defined by [PKCS #1 in RFC 8017]. + // // - 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 ANSI 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 + // [RFC 3279 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. + // + // [RFC 3279 Section 2.2.3]: https://tools.ietf.org/html/rfc3279#section-2.2.3 + // [PKCS #1 in RFC 8017]: https://tools.ietf.org/html/rfc8017 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 001db07b674..f24835fe51e 100644 --- a/service/kms/api_op_TagResource.go +++ b/service/kms/api_op_TagResource.go @@ -11,38 +11,56 @@ 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 -// 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) -// (key policy) Related operations -// - CreateKey -// - ListResourceTags -// - ReplicateKey -// - UntagResource +// Adds or edits tags on a [customer managed key]. +// +// Tagging or untagging a KMS key can allow or deny permission to the KMS key. For +// details, see [ABAC for KMS]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], but you cannot tag an [Amazon Web Services managed key], an [Amazon Web Services owned key], a [custom key store], or an [alias]. +// +// 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]. For general information about +// tags, including the format and syntax, see [Tagging Amazon Web Services resources]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]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] (key policy) +// +// # Related operations +// +// # CreateKey +// +// # ListResourceTags +// +// # ReplicateKey +// +// # UntagResource // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Amazon Web Services owned key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:TagResource]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk +// [Tagging keys]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html +// [alias]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept +// [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Amazon Web Services managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk +// [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept +// [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{} @@ -60,22 +78,31 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF 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: + // 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 . + // + // To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. // // This member is required. KeyId *string // One or more tags. Each tag consists of a tag key and a tag value. The tag value - // can be an empty (null) string. Do not include confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. You cannot have more than one tag on a KMS key - // with the same tag key. If you specify an existing tag key with a different tag - // value, KMS replaces the current tag value with the specified one. + // can be an empty (null) string. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // You cannot have more than one tag on a KMS key with the same tag key. If you + // specify an existing tag key with a different tag value, KMS replaces the current + // tag value with the specified one. // // This member is required. Tags []types.Tag diff --git a/service/kms/api_op_UntagResource.go b/service/kms/api_op_UntagResource.go index c3cae702817..157eb8d0f3f 100644 --- a/service/kms/api_op_UntagResource.go +++ b/service/kms/api_op_UntagResource.go @@ -10,32 +10,48 @@ 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 -// 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 -// 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) -// (key policy) Related operations -// - CreateKey -// - ListResourceTags -// - ReplicateKey -// - TagResource +// Deletes tags from a [customer managed key]. 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]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]. For general information about +// tags, including the format and syntax, see [Tagging Amazon Web Services resources]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]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] (key policy) +// +// # Related operations +// +// # CreateKey +// +// # ListResourceTags +// +// # ReplicateKey +// +// # TagResource // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:UntagResource]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk +// [Tagging keys]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html +// [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -53,12 +69,18 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, 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: + // 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 . + // + // 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 cb429fd7382..f885e497b3c 100644 --- a/service/kms/api_op_UpdateAlias.go +++ b/service/kms/api_op_UpdateAlias.go @@ -13,40 +13,60 @@ import ( // Associates an existing KMS alias with a different KMS key. Each alias is // 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. +// account and Region. +// +// Adding, deleting, or updating an alias can allow or deny permission to the KMS +// key. For details, see [ABAC for KMS]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 DeleteAliasto 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 DeleteAliasto 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). -// -// 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 +// not appear in the response from the DescribeKeyoperation. To get the aliases of all KMS +// keys in the account, use the ListAliasesoperation. +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see [Key states of KMS keys]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] +// - on the alias (IAM policy). +// +// [kms:UpdateAlias] +// - on the current KMS key (key policy). +// +// [kms:UpdateAlias] +// - on the new KMS key (key policy). +// +// For details, see [Controlling access to aliases] in the Key Management Service Developer Guide. +// +// Related operations: +// +// # CreateAlias +// +// # DeleteAlias +// +// # ListAliases // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [ABAC for KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html +// [kms:UpdateAlias]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [Controlling access to aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optFns ...func(*Options)) (*UpdateAliasOutput, error) { if params == nil { params = &UpdateAliasInput{} @@ -66,25 +86,37 @@ 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 - // UpdateAlias to change the alias name. Do not include confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. + // UpdateAlias to change the alias name. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. // // This member is required. AliasName *string - // 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 + // Identifies the [customer managed key] to associate with the alias. You don't have permission to + // associate an alias with an [Amazon Web Services managed key]. + // + // 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: + // 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 . + // + // 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. + // + // [customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk + // [Amazon Web Services managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk // // This member is required. TargetKeyId *string diff --git a/service/kms/api_op_UpdateCustomKeyStore.go b/service/kms/api_op_UpdateCustomKeyStore.go index 14447d9d9b8..578980488c9 100644 --- a/service/kms/api_op_UpdateCustomKeyStore.go +++ b/service/kms/api_op_UpdateCustomKeyStore.go @@ -12,67 +12,92 @@ import ( ) // Changes the properties of a custom key store. You can use this operation to -// change the properties of an CloudHSM key store or an external key store. Use the -// required CustomKeyStoreId parameter to identify the custom key store. Use the -// 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) -// 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 +// change the properties of an CloudHSM key store or an external key store. +// +// Use the required CustomKeyStoreId parameter to identify the custom key store. +// Use the remaining optional parameters to change its properties. This operation +// does not return any property values. To verify the updated property values, use +// the DescribeCustomKeyStoresoperation. +// +// This operation is part of the [custom key stores] 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 // settings connect your key store, via the external key store proxy, to the same // external key manager as the previous settings, or to a backup or snapshot of the // external key manager with the same cryptographic keys. If the updated connection // settings fail, you can fix them and retry, although an extended delay might // disrupt Amazon Web Services services. However, if KMS permanently loses its // access to cryptographic keys, ciphertext encrypted under those keys is -// unrecoverable. For external key stores: Some external key managers provide a -// simpler method for updating an external key store. For details, see your -// external key manager documentation. When updating an external key store in the -// KMS console, you can upload a JSON-based proxy configuration file with the -// desired values. You cannot upload the proxy configuration file to the -// 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 +// unrecoverable. +// +// For external key stores: +// +// Some external key managers provide a simpler method for updating an external +// key store. For details, see your external key manager documentation. +// +// When updating an external key store in the KMS console, you can upload a +// JSON-based proxy configuration file with the desired values. You cannot upload +// the proxy configuration file to the 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 , +// 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 -// 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. +// when it is in the CONNECTED or DISCONNECTED state. +// +// If your update requires a DISCONNECTED state, before using UpdateCustomKeyStore +// , use the DisconnectCustomKeyStoreoperation 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) -// (IAM policy) Related operations: -// - ConnectCustomKeyStore -// - CreateCustomKeyStore -// - DeleteCustomKeyStore -// - DescribeCustomKeyStores -// - DisconnectCustomKeyStore +// in a different Amazon Web Services account. +// +// Required permissions: [kms:UpdateCustomKeyStore] (IAM policy) +// +// Related operations: +// +// # ConnectCustomKeyStore +// +// # CreateCustomKeyStore +// +// # DeleteCustomKeyStore +// +// # DescribeCustomKeyStores +// +// # DisconnectCustomKeyStore // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [custom key stores]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html +// [kms:UpdateCustomKeyStore]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) UpdateCustomKeyStore(ctx context.Context, params *UpdateCustomKeyStoreInput, optFns ...func(*Options)) (*UpdateCustomKeyStoreOutput, error) { if params == nil { params = &UpdateCustomKeyStoreInput{} @@ -91,92 +116,119 @@ func (c *Client) UpdateCustomKeyStore(ctx context.Context, params *UpdateCustomK type UpdateCustomKeyStoreInput struct { // Identifies the custom key store that you want to update. Enter the ID of the - // custom key store. To find the ID of a custom key store, use the - // DescribeCustomKeyStores operation. + // custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStoresoperation. // // This member is required. 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 . - // 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) - // 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) - // operation. To change this value, the CloudHSM key store must be disconnected. + // + // 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]for a cluster associated with a custom key store. To view the + // cluster certificate of a cluster, use the [DescribeClusters]operation. + // + // To change this value, the CloudHSM key store must be disconnected. + // + // [fulfill the requirements]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore + // [DescribeClusters]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html 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 - // 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. + // 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. Do not include confidential or sensitive information in this field. - // This field may be displayed in plaintext in CloudTrail logs and other output. To - // change this value, an CloudHSM key store must be disconnected. An external key - // store can be connected or disconnected. + // account. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. + // + // 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 - // 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 - // update the credential in KMS. You can change this value when the external key - // store is connected or disconnected. + // 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 update the credential in + // KMS. + // + // You can change this value when the external key store is connected or + // disconnected. XksProxyAuthenticationCredential *types.XksProxyAuthenticationCredentialType // 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 // the XksProxyUriEndpoint and specify a null or empty string for the - // XksProxyVpcEndpointServiceName value. To change this value, the external key - // store must be disconnected. + // XksProxyVpcEndpointServiceName value. + // + // To change this value, the external key store must be disconnected. XksProxyConnectivity types.XksProxyConnectivityType // 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 , - // 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. + // 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 - // the Amazon Web Services account and Region. To change this value, the external - // key store must be disconnected. + // the Amazon Web Services account and Region. + // + // To change this value, the external key store must be disconnected. XksProxyUriEndpoint *string // 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 - // 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 + // 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. XksProxyUriPath *string // 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 - // disconnected. + // VPC_ENDPOINT_SERVICE . + // + // To change this value, the external key store must be disconnected. XksProxyVpcEndpointServiceName *string noSmithyDocumentSerde diff --git a/service/kms/api_op_UpdateKeyDescription.go b/service/kms/api_op_UpdateKeyDescription.go index d3636033222..59aeba93b78 100644 --- a/service/kms/api_op_UpdateKeyDescription.go +++ b/service/kms/api_op_UpdateKeyDescription.go @@ -10,19 +10,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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) -// (key policy) Related operations -// - CreateKey -// - DescribeKey +// 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]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] (key policy) +// +// # Related operations +// +// # CreateKey +// +// # DescribeKey // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [kms:UpdateKeyDescription]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) UpdateKeyDescription(ctx context.Context, params *UpdateKeyDescriptionInput, optFns ...func(*Options)) (*UpdateKeyDescriptionOutput, error) { if params == nil { params = &UpdateKeyDescriptionInput{} @@ -40,19 +50,26 @@ func (c *Client) UpdateKeyDescription(ctx context.Context, params *UpdateKeyDesc type UpdateKeyDescriptionInput struct { - // New description for the KMS key. Do not include confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. + // New description for the KMS key. + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. // // This member is required. Description *string - // Updates the description of the specified KMS key. Specify the key ID or key ARN - // of the KMS key. For example: + // 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 . + // + // 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 ee5bbc6e8f7..2182c64e622 100644 --- a/service/kms/api_op_UpdatePrimaryRegion.go +++ b/service/kms/api_op_UpdatePrimaryRegion.go @@ -10,61 +10,81 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// 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) -// 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) -// 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 -// KMS key in the specified Region. To find the replica keys, use the DescribeKey -// operation on the primary key or any replica key. To create a replica key, use -// the ReplicateKey operation. You can run this operation while using the affected -// 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: +// 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]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 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]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], [key spec], [key usage], [key material origin], +// and [automatic key rotation]. It's the only key that can be replicated. You cannot [delete the primary key] 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 KMS key in the specified Region. +// To find the replica keys, use the DescribeKeyoperation on the primary key or any replica +// key. To create a replica key, use the ReplicateKeyoperation. +// +// You can run this operation while using the affected 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] in the Key +// Management Service Developer Guide. +// +// This operation does not return any output. To verify that primary key is +// changed, use the DescribeKeyoperation. +// +// 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. // -// Related operations -// - CreateKey -// - ReplicateKey +// # Related operations +// +// # CreateKey +// +// # ReplicateKey // // Eventual consistency: The KMS API follows an eventual consistency model. For -// more information, see KMS eventual consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// more information, see [KMS eventual consistency]. +// +// [key ID]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [delete the primary key]: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html +// [key usage]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage +// [Updating the primary Region]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update +// [Multi-Region keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html +// [key spec]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec +// [key material origin]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin +// [automatic key rotation]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) UpdatePrimaryRegion(ctx context.Context, params *UpdatePrimaryRegionInput, optFns ...func(*Options)) (*UpdatePrimaryRegionOutput, error) { if params == nil { params = &UpdatePrimaryRegionInput{} @@ -83,20 +103,28 @@ func (c *Client) UpdatePrimaryRegion(ctx context.Context, params *UpdatePrimaryR 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: + // 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 . + // + // 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. + // 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 6b880e43af4..9c2ba35636c 100644 --- a/service/kms/api_op_Verify.go +++ b/service/kms/api_op_Verify.go @@ -12,40 +12,56 @@ import ( ) // Verifies a digital signature that was generated by the Sign operation. +// // 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 -// 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) -// 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 +// 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]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 GetPublicKeyoperation 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 Eventual consistency: The KMS API follows -// an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// 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]. +// +// The KMS key that you use for this operation must be in a compatible key state. +// For details, see [Key states of KMS keys]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] (key policy) +// +// Related operations: Sign +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [Asymmetric KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html +// [Offline verification with SM2 key pairs]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification +// [kms:Verify]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html func (c *Client) Verify(ctx context.Context, params *VerifyInput, optFns ...func(*Options)) (*VerifyOutput, error) { if params == nil { params = &VerifyInput{} @@ -65,26 +81,36 @@ type VerifyInput struct { // Identifies the asymmetric KMS key that will be used to verify the signature. // 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 - // Services account, you must use the key ARN or alias ARN. For example: + // 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 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 . + // + // 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 - // different from the message that was signed, the signature verification fails. A - // message and its hash digest are considered to be the same message. + // 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. // // This member is required. Message []byte @@ -100,38 +126,56 @@ type VerifyInput struct { // This member is required. SigningAlgorithm types.SigningAlgorithmSpec - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token 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 - // 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 - // 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 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. + // 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 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 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) - // . + // + // - SM2DSA uses the SM3 hashing algorithm. For details, see [Offline verification with SM2 key pairs]. + // + // [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 @@ -139,8 +183,10 @@ 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] ) of the asymmetric KMS key that was used to verify + // the signature. + // + // [key ARN]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN 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 cbffec19181..27bfa87ab1b 100644 --- a/service/kms/api_op_VerifyMac.go +++ b/service/kms/api_op_VerifyMac.go @@ -17,22 +17,33 @@ import ( // 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 Eventual consistency: The KMS API -// follows an eventual consistency model. For more information, see KMS eventual -// consistency (https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html) -// . +// 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]. +// +// This operation is part of KMS support for HMAC KMS keys. For details, see [HMAC keys in KMS] 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]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] (key policy) +// +// Related operations: GenerateMac +// +// Eventual consistency: The KMS API follows an eventual consistency model. For +// more information, see [KMS eventual consistency]. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html +// [RFC 2104]: https://datatracker.ietf.org/doc/html/rfc2104 +// [kms:VerifyMac]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html +// [KMS eventual consistency]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html +// [HMAC keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html func (c *Client) VerifyMac(ctx context.Context, params *VerifyMacInput, optFns ...func(*Options)) (*VerifyMacOutput, error) { if params == nil { params = &VerifyMacInput{} @@ -50,16 +61,17 @@ 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 - // VerifyMac operation fails. + // 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. KeyId *string - // The HMAC to verify. Enter the HMAC that was generated by the GenerateMac - // operation when you specified the same message, HMAC KMS key, and MAC algorithm - // as the values specified in this request. + // The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when + // you specified the same message, HMAC KMS key, and MAC algorithm as the values + // specified in this request. // // This member is required. Mac []byte @@ -72,23 +84,31 @@ type VerifyMacInput struct { MacAlgorithm types.MacAlgorithmSpec // The message that will be used in the verification. Enter the same message that - // was used to generate the HMAC. GenerateMac and VerifyMac do not provide special - // handling for message digests. If you generated an HMAC for a hash digest of a - // message, you must verify the HMAC for the same hash digest. + // was used to generate the HMAC. + // + // GenerateMacand VerifyMac do not provide special handling for message digests. If you + // generated an HMAC for a hash digest of a message, you must verify the HMAC for + // the same hash digest. // // This member is required. Message []byte - // Checks if your request will succeed. DryRun is an optional parameter. To learn - // more about how to use this parameter, see Testing your KMS API calls (https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html) - // in the Key Management Service Developer Guide. + // Checks if your request will succeed. DryRun is an optional parameter. + // + // To learn more about how to use this parameter, see [Testing your KMS API calls] in the Key Management + // Service Developer Guide. + // + // [Testing your KMS API calls]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-dryrun.html DryRun *bool - // 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) - // in the Key Management Service Developer Guide. + // 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] + // and [Using a grant token]in the Key Management Service Developer Guide. + // + // [Grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token + // [Using a grant token]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token GrantTokens []string noSmithyDocumentSerde @@ -104,9 +124,11 @@ type VerifyMacOutput struct { // 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 - // operation fails with a KMSInvalidMacException exception. This exception - // indicates that one or more of the inputs changed since the HMAC was computed. + // 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 // Metadata pertaining to the operation's result. diff --git a/service/kms/doc.go b/service/kms/doc.go index 266b4e11176..f989361a183 100644 --- a/service/kms/doc.go +++ b/service/kms/doc.go @@ -3,62 +3,95 @@ // 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. +// # 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]. +// +// 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. +// 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]. +// +// 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]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 -// 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 -// 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. -// -// 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 +// +// # 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]. +// +// # 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]. +// +// # Additional Resources +// +// For more information about credentials and request signing, see the following: +// +// [Amazon Web Services Security Credentials] +// - - This topic provides general information about the types of credentials +// used to access Amazon Web Services. +// +// [Temporary Security Credentials] +// - - This section of the IAM User Guide describes how to create and use +// temporary security credentials. +// +// [Signature Version 4 Signing Process] +// - - 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 +// +// [Signature Version 4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html +// [Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [Amazon Web Services Security Credentials]: https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html +// [Key Management Service Developer Guide]: https://docs.aws.amazon.com/kms/latest/developerguide/ +// [Service endpoints]: https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region +// [CloudTrail User Guide]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/ +// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html package kms diff --git a/service/kms/options.go b/service/kms/options.go index b24e2565947..11be534415f 100644 --- a/service/kms/options.go +++ b/service/kms/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/kms/types/enums.go b/service/kms/types/enums.go index 5171e13aa50..b33c20f9b75 100644 --- a/service/kms/types/enums.go +++ b/service/kms/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AlgorithmSpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmSpec) Values() []AlgorithmSpec { return []AlgorithmSpec{ "RSAES_PKCS1_V1_5", @@ -51,8 +52,9 @@ const ( ) // Values returns all known values for ConnectionErrorCodeType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionErrorCodeType) Values() []ConnectionErrorCodeType { return []ConnectionErrorCodeType{ "INVALID_CREDENTIALS", @@ -88,8 +90,9 @@ const ( ) // Values returns all known values for ConnectionStateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStateType) Values() []ConnectionStateType { return []ConnectionStateType{ "CONNECTED", @@ -120,8 +123,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RSA_2048", @@ -149,8 +153,9 @@ const ( ) // Values returns all known values for CustomKeyStoreType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomKeyStoreType) Values() []CustomKeyStoreType { return []CustomKeyStoreType{ "AWS_CLOUDHSM", @@ -173,8 +178,9 @@ const ( ) // Values returns all known values for DataKeyPairSpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataKeyPairSpec) Values() []DataKeyPairSpec { return []DataKeyPairSpec{ "RSA_2048", @@ -197,8 +203,9 @@ const ( ) // Values returns all known values for DataKeySpec. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataKeySpec) Values() []DataKeySpec { return []DataKeySpec{ "AES_256", @@ -217,8 +224,9 @@ const ( ) // Values returns all known values for EncryptionAlgorithmSpec. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionAlgorithmSpec) Values() []EncryptionAlgorithmSpec { return []EncryptionAlgorithmSpec{ "SYMMETRIC_DEFAULT", @@ -237,8 +245,9 @@ const ( ) // Values returns all known values for ExpirationModelType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpirationModelType) Values() []ExpirationModelType { return []ExpirationModelType{ "KEY_MATERIAL_EXPIRES", @@ -269,8 +278,9 @@ const ( ) // Values returns all known values for GrantOperation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GrantOperation) Values() []GrantOperation { return []GrantOperation{ "Decrypt", @@ -300,8 +310,9 @@ const ( ) // Values returns all known values for KeyEncryptionMechanism. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyEncryptionMechanism) Values() []KeyEncryptionMechanism { return []KeyEncryptionMechanism{ "RSAES_OAEP_SHA_256", @@ -317,8 +328,9 @@ const ( ) // Values returns all known values for KeyManagerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyManagerType) Values() []KeyManagerType { return []KeyManagerType{ "AWS", @@ -346,8 +358,9 @@ const ( ) // Values returns all known values for KeySpec. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeySpec) Values() []KeySpec { return []KeySpec{ "RSA_2048", @@ -381,8 +394,9 @@ const ( ) // Values returns all known values for KeyState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyState) Values() []KeyState { return []KeyState{ "Creating", @@ -406,8 +420,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -427,8 +442,9 @@ const ( ) // Values returns all known values for MacAlgorithmSpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MacAlgorithmSpec) Values() []MacAlgorithmSpec { return []MacAlgorithmSpec{ "HMAC_SHA_224", @@ -447,8 +463,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "RAW", @@ -465,8 +482,9 @@ const ( ) // Values returns all known values for MultiRegionKeyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MultiRegionKeyType) Values() []MultiRegionKeyType { return []MultiRegionKeyType{ "PRIMARY", @@ -485,8 +503,9 @@ const ( ) // Values returns all known values for OriginType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginType) Values() []OriginType { return []OriginType{ "AWS_KMS", @@ -505,8 +524,9 @@ const ( ) // Values returns all known values for RotationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RotationType) Values() []RotationType { return []RotationType{ "AUTOMATIC", @@ -531,8 +551,9 @@ const ( ) // Values returns all known values for SigningAlgorithmSpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SigningAlgorithmSpec) Values() []SigningAlgorithmSpec { return []SigningAlgorithmSpec{ "RSASSA_PSS_SHA_256", @@ -558,8 +579,9 @@ const ( ) // Values returns all known values for WrappingKeySpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WrappingKeySpec) Values() []WrappingKeySpec { return []WrappingKeySpec{ "RSA_2048", @@ -578,6 +600,7 @@ const ( // 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{ diff --git a/service/kms/types/errors.go b/service/kms/types/errors.go index 9bc846319c7..2221044e458 100644 --- a/service/kms/types/errors.go +++ b/service/kms/types/errors.go @@ -37,10 +37,13 @@ func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault { return smithy. // The request was rejected because the specified CloudHSM cluster is already // associated with an CloudHSM key store in the account, or it shares a backup // 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 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] // operation. +// +// [DescribeClusters]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html type CloudHsmClusterInUseException struct { Message *string @@ -68,30 +71,37 @@ 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) +// +// - The [security group for the cluster](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] // 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. +// requires. To add HSMs, use the CloudHSM [CreateHsm]operation. +// +// For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKeyoperations, the CloudHSM cluster must have at least two active +// +// HSMs, each in a different Availability Zone. For the ConnectCustomKeyStoreoperation, 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) -// 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 . +// associated with an CloudHSM key store, see [Assemble the Prerequisites]in the Key Management Service +// Developer Guide. For information about creating a private subnet for an CloudHSM +// cluster, see [Create a Private Subnet]in the CloudHSM User Guide. For information about cluster security +// groups, see [Configure a Default Security Group]in the CloudHSM User Guide . +// +// [Assemble the Prerequisites]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore +// [Create a Private Subnet]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html +// [Configure a Default Security Group]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html +// [DescribeSecurityGroups]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html +// [CreateHsm]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html +// [security group for the cluster]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html type CloudHsmClusterInvalidConfigurationException struct { Message *string @@ -121,8 +131,9 @@ 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]in the CloudHSM User Guide. +// +// [Getting Started]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html type CloudHsmClusterNotActiveException struct { Message *string @@ -177,13 +188,18 @@ func (e *CloudHsmClusterNotFoundException) ErrorFault() smithy.ErrorFault { retu // The request was rejected because the specified CloudHSM cluster has a different // cluster certificate than the original cluster. You cannot use the operation to -// specify an unrelated cluster for an CloudHSM key store. Specify an CloudHSM -// cluster that shares a backup history with the original cluster. This includes -// 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) +// specify an unrelated cluster for an CloudHSM key store. +// +// Specify an CloudHSM cluster that shares a backup history with the original +// cluster. This includes 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] // operation. +// +// [DescribeClusters]: https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html type CloudHsmClusterNotRelatedException struct { Message *string @@ -239,9 +255,8 @@ func (e *ConflictException) ErrorCode() string { func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was rejected because the custom key store contains KMS keys. After -// verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletion -// operation to delete the KMS keys. After they are deleted, you can delete the -// custom key store. +// verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletionoperation to delete +// the KMS keys. After they are deleted, you can delete the custom key store. type CustomKeyStoreHasCMKsException struct { Message *string @@ -268,26 +283,30 @@ 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 -// 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 . +// 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 ConnectCustomKeyStoreoperation 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 CreateKeyoperation 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 DisconnectCustomKeyStoreoperation on a custom key store with a ConnectionState of +// DISCONNECTING or DISCONNECTED . This operation is valid for all other +// ConnectionState values. +// +// - You requested the UpdateCustomKeyStoreor DeleteCustomKeyStoreoperation 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 GenerateRandomoperation 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 @@ -449,9 +468,9 @@ func (e *DryRunOperationException) ErrorCode() string { } func (e *DryRunOperationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because the specified import token is expired. Use -// GetParametersForImport to get a new import token and public key, use the new -// public key to encrypt the key material, and then try the request again. +// The request was rejected because the specified import token is expired. Use GetParametersForImport to +// get a new import token and public key, use the new public key to encrypt the key +// material, and then try the request again. type ExpiredImportTokenException struct { Message *string @@ -478,8 +497,8 @@ func (e *ExpiredImportTokenException) ErrorCode() string { func (e *ExpiredImportTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was rejected because the specified KMS key cannot decrypt the data. -// The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must -// identify the same KMS key that was used to encrypt the ciphertext. +// The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the +// same KMS key that was used to encrypt the ciphertext. type IncorrectKeyException struct { Message *string @@ -535,9 +554,12 @@ 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], you create the trust anchor certificate and save it in the +// customerCA.crt file. +// +// [initialize the CloudHSM cluster]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr type IncorrectTrustAnchorException struct { Message *string @@ -616,11 +638,12 @@ func (e *InvalidArnException) ErrorCode() string { } func (e *InvalidArnException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// From the Decrypt or ReEncrypt operation, the request was rejected because the -// specified ciphertext, or additional authenticated data incorporated into the -// ciphertext, such as the encryption context, is corrupted, missing, or otherwise -// invalid. From the ImportKeyMaterial operation, the request was rejected because -// KMS could not decrypt the encrypted (wrapped) key material. +// From the Decrypt or ReEncrypt operation, the request was rejected because the specified +// ciphertext, or additional authenticated data incorporated into the ciphertext, +// such as the encryption context, is corrupted, missing, or otherwise invalid. +// +// From the ImportKeyMaterial operation, the request was rejected because KMS could not decrypt the +// encrypted (wrapped) key material. type InvalidCiphertextException struct { Message *string @@ -726,7 +749,9 @@ 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 ). // @@ -734,9 +759,10 @@ func (e *InvalidImportTokenException) ErrorFault() smithy.ErrorFault { return sm // 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. +// 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 DescribeKeyoperation. type InvalidKeyUsageException struct { Message *string @@ -900,14 +926,22 @@ func (e *KMSInvalidSignatureException) ErrorCode() string { func (e *KMSInvalidSignatureException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// 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 DescribeKeyoperation. For more information about which key +// +// states are compatible with each KMS operation, see [Key states of KMS keys]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. +// +// [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html type KMSInvalidStateException struct { Message *string @@ -934,8 +968,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. +// see [Quotas]in the Key Management Service Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html type LimitExceededException struct { Message *string @@ -1098,6 +1133,7 @@ func (e *XksKeyAlreadyInUseException) ErrorFault() smithy.ErrorFault { return sm // The request was rejected because the external key specified by the XksKeyId // parameter did not meet the configuration requirements for an external key store. +// // The external key must be an AES-256 symmetric key that is enabled and performs // encryption and decryption. type XksKeyInvalidConfigurationException struct { @@ -1130,10 +1166,12 @@ func (e *XksKeyInvalidConfigurationException) ErrorFault() smithy.ErrorFault { // 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. +// 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 @@ -1308,8 +1346,9 @@ 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 -// 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 +// 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 // unavailable. type XksProxyUriUnreachableException struct { @@ -1370,9 +1409,10 @@ func (e *XksProxyVpcEndpointServiceInUseException) ErrorFault() smithy.ErrorFaul // The request was rejected because the Amazon VPC endpoint service configuration // does not fulfill the requirements for an external key store. To identify the -// cause, see the error message that accompanies the exception and review the -// requirements (https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements) -// for Amazon VPC endpoint service connectivity for an external key store. +// cause, see the error message that accompanies the exception and [review the requirements]for Amazon VPC +// endpoint service connectivity for an external key store. +// +// [review the requirements]: https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements type XksProxyVpcEndpointServiceInvalidConfigurationException struct { Message *string @@ -1401,10 +1441,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 DescribeCustomKeyStoresto 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 720a588eb98..a0b3f0bf8ac 100644 --- a/service/kms/types/types.go +++ b/service/kms/types/types.go @@ -40,77 +40,93 @@ type CustomKeyStoresListEntry struct { 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 - // 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) - // in Key Management Service Developer Guide. All custom key stores: + // 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] + // 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. + // // 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. + // associated private subnets, although two are preferable. For details, see [How to Fix a Connection Failure]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. + // and private subnets.) For details, see [How to Fix a Connection Failure]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. + // the key store password value for the custom key store. For help, see [How to Log Out and Reconnect]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. + // is signed by a certificate authority included in the [Trusted Certificate Authorities]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 @@ -118,50 +134,70 @@ type CustomKeyStoresListEntry struct { // 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 not require [acceptance]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. + // + // - The domain of the private DNS name must have a [verification status]of verified . + // + // - The [TLS certificate]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. + // + // [acceptance]: https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html + // [verification status]: https://docs.aws.amazon.com/vpc/latest/privatelink/verify-domains.html + // [How to Log Out and Reconnect]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2 + // [TLS certificate]: https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html + // [Trusted Certificate Authorities]: https://github.com/aws/aws-kms-xksproxy-api-spec/blob/main/TrustedCertificateAuthorities + // [How to Fix a Connection Failure]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed 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 . + // 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 + // connected or you use the DisconnectCustomKeyStoreoperation 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]in the Key Management Service + // Developer Guide. + // + // [Troubleshooting a custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html ConnectionState ConnectionStateType // The date and time when the custom key store was created. @@ -180,53 +216,66 @@ type CustomKeyStoresListEntry struct { 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 . + // CloudHSM key store. When you [initialize the cluster], you create this certificate and save it in the + // customerCA.crt file. + // + // This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM . + // + // [initialize the cluster]: https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr 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 . + // information that KMS requires. + // + // This field appears only when the 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) -// 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 -// encryption context, such as cryptographic operations with asymmetric KMS keys -// 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. +// Use this structure to allow [cryptographic operations] in the grant only when the operation request +// includes the specified [encryption 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]. 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 DescribeKeyor 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. +// // However, in a grant constraint, the key in each key-value pair is not case -// sensitive, but the value is case sensitive. To avoid confusion, do not use -// 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) -// in the Key Management Service Developer Guide . +// sensitive, but the value is case sensitive. +// +// To avoid confusion, do not use 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:]in the Key Management Service Developer Guide . +// +// [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations +// [kms:EncryptionContext:]: https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context +// [encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context +// [symmetric KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks 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) + // A list of key-value pairs that must match the encryption context in the [cryptographic operation] // 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. + // + // [cryptographic operation]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations 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) - // request. The grant allows the cryptographic operation only when the encryption - // context in the request includes the key-value pairs specified in this + // the [cryptographic operation]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. + // + // [cryptographic operation]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations EncryptionContextSubset map[string]string noSmithyDocumentSerde @@ -245,12 +294,15 @@ type GrantListEntry struct { // The unique identifier for the grant. GrantId *string - // The identity that gets the permissions in the grant. 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. + // The identity that gets the permissions in the grant. + // + // 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], which might represent several different + // grantee principals. + // + // [service principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services GranteePrincipal *string // The Amazon Web Services account under which the grant was issued. @@ -259,8 +311,8 @@ type GrantListEntry struct { // The unique identifier for the KMS key to which the grant applies. KeyId *string - // The friendly name that identifies the grant. If a name was provided in the - // CreateGrant request, that name is returned. Otherwise this value is null. + // The friendly name that identifies the grant. If a name was provided in the CreateGrant + // request, that name is returned. Otherwise this value is null. Name *string // The list of operations permitted by the grant. @@ -284,8 +336,9 @@ type KeyListEntry struct { noSmithyDocumentSerde } -// Contains metadata about a KMS key. This data type is used as a response element -// for the CreateKey , DescribeKey , and ReplicateKey operations. +// Contains metadata about a KMS key. +// +// This data type is used as a response element for the CreateKey, DescribeKey, and ReplicateKey operations. type KeyMetadata struct { // The globally unique identifier for the KMS key. @@ -297,39 +350,45 @@ type KeyMetadata struct { // 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) - // in the Example ARNs section of the Amazon Web Services General Reference. + // The Amazon Resource Name (ARN) of the KMS key. For examples, see [Key Management Service (KMS)] in the + // Example ARNs section of the Amazon Web Services General Reference. + // + // [Key Management Service (KMS)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms 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], 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. + // + // [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html 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) - // that contains the KMS key. This field is present only when the KMS key is - // created in a custom key store. + // A unique identifier for the [custom key store] that contains the KMS key. This field is present + // only when the KMS key is created in a custom key store. + // + // [custom key store]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html CustomKeyStoreId *string - // Instead, use the KeySpec field. The KeySpec and CustomerMasterKeySpec fields - // have the same value. We recommend that you use the KeySpec field in your code. - // However, to avoid breaking changes, KMS supports both fields. + // Instead, use the KeySpec field. + // + // The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend + // that you use the KeySpec field in your code. However, to avoid breaking + // changes, KMS supports both fields. // // Deprecated: This field has been deprecated. Instead, use the KeySpec field. CustomerMasterKeySpec CustomerMasterKeySpec // 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. @@ -340,8 +399,9 @@ type KeyMetadata struct { 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 . + // with other encryption algorithms within KMS. + // + // This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT . EncryptionAlgorithms []EncryptionAlgorithmSpec // Specifies whether the KMS key's key material expires. This value is present @@ -350,41 +410,53 @@ type KeyMetadata struct { // 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) - // in the Key Management Service Developer Guide. + // about the difference, see [KMS keys]in the Key Management Service Developer Guide. + // + // [KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys KeyManager KeyManagerType // Describes the type of key material in the KMS key. 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. + // 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] in + // the Key Management Service Developer Guide. + // + // [Key states of KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html KeyState KeyState - // The cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) - // for which you can use the KMS key. + // The [cryptographic operations] for which you can use the KMS key. + // + // [cryptographic operations]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations 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 . 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 - // 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) - // in the Key Management Service Developer Guide. + // regional KMS keys. + // + // For more information about multi-Region keys, see [Multi-Region keys in KMS] in the Key Management + // Service Developer Guide. + // + // [Multi-Region keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html 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 - // information about any listed KMS key, use the DescribeKey operation. - // - MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA - // key. + // 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. MultiRegionConfiguration *MultiRegionConfiguration @@ -400,20 +472,22 @@ type KeyMetadata struct { // 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 - // doesn't begin until all of its replica keys are deleted. This value displays - // that waiting period. When the last replica key in the multi-Region key is - // deleted, the KeyState of the scheduled primary key changes from - // PendingReplicaDeletion to PendingDeletion and the deletion date appears in the - // DeletionDate field. + // 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 doesn't begin until all of its replica keys are deleted. This + // value displays that waiting period. When the last replica key in the + // multi-Region key is deleted, the KeyState of the scheduled primary key changes + // from PendingReplicaDeletion to PendingDeletion and the deletion date appears in + // the DeletionDate field. PendingDeletionWindowInDays *int32 // 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 . + // with other signing algorithms within KMS. + // + // This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY . SigningAlgorithms []SigningAlgorithmSpec // The time at which the imported key material expires. When the key material @@ -423,16 +497,20 @@ type KeyMetadata struct { 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) - // in the Key Management Service Developer Guide. + // external key store. + // + // For more information, see [External key] in the Key Management Service Developer Guide. + // + // [External key]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key XksKeyConfiguration *XksKeyConfigurationType noSmithyDocumentSerde } // Describes the configuration of this multi-Region key. This field appears only -// when the KMS key is a primary or replica of a multi-Region key. For more -// information about any listed KMS key, use the DescribeKey operation. +// when the KMS key is a primary or replica of a multi-Region key. +// +// For more information about any listed KMS key, use the DescribeKey operation. type MultiRegionConfiguration struct { // Indicates whether the KMS key is a PRIMARY or REPLICA key. @@ -463,11 +541,14 @@ type MultiRegionKey struct { } // Contains information about the party that receives the response from the API -// operation. This data type is designed to support Amazon Web Services Nitro -// Enclaves, which lets you create an isolated compute environment in Amazon EC2. -// For information about the interaction between KMS and Amazon Web Services Nitro -// Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS (https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html) +// operation. +// +// This data type is designed to support Amazon Web Services Nitro Enclaves, which +// lets you create an isolated compute environment in Amazon EC2. For information +// about the interaction between KMS and Amazon Web Services Nitro Enclaves, see [How Amazon Web Services Nitro Enclaves uses KMS] // in the Key Management Service Developer Guide. +// +// [How Amazon Web Services Nitro Enclaves uses KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html type RecipientInfo struct { // The attestation document for an Amazon Web Services Nitro Enclave. This @@ -491,21 +572,25 @@ type RotationsListEntry struct { // Date and time that the key material rotation completed. Formatted as Unix time. RotationDate *time.Time - // Identifies whether the key material rotation was a scheduled automatic rotation (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable) - // or an on-demand rotation (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand) - // . + // Identifies whether the key material rotation was a scheduled [automatic rotation] or an [on-demand rotation]. + // + // [automatic rotation]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable + // [on-demand rotation]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand RotationType RotationType noSmithyDocumentSerde } // 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. Do not -// include confidential or sensitive information in this field. This field may be -// displayed in plaintext in CloudTrail logs and other output. 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) -// in the Amazon Web Services Billing and Cost Management User Guide. +// values are both required, but tag values can be empty (null) strings. +// +// Do not include confidential or sensitive information in this field. This field +// may be displayed in plaintext in CloudTrail logs and other output. +// +// For information about the rules that apply to tag keys and tag values, see [User-Defined Tag Restrictions] in +// the Amazon Web Services Billing and Cost Management User Guide. +// +// [User-Defined Tag Restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html type Tag struct { // The key of the tag. @@ -521,15 +606,20 @@ 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) -// in the Key Management Service Developer Guide. +// Information about the [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]in the Key Management Service Developer Guide. +// +// [External key]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key +// [external key]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key type XksKeyConfigurationType struct { // The ID of the external key in its external key manager. This is the ID that the @@ -541,8 +631,9 @@ type XksKeyConfigurationType struct { // KMS uses the authentication credential to sign requests that it sends to the // external key store proxy (XKS proxy) on your behalf. You establish these -// credentials on your external key store proxy and report them to KMS. The -// XksProxyAuthenticationCredential includes two required elements. +// credentials on your external key store proxy and report them to KMS. +// +// The XksProxyAuthenticationCredential includes two required elements. type XksProxyAuthenticationCredentialType struct { // A unique identifier for the raw secret access key. @@ -561,23 +652,26 @@ type XksProxyAuthenticationCredentialType struct { // Detailed information about the external key store proxy (XKS proxy). Your // 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 manager can understand. These fields appear in a DescribeCustomKeyStoresresponse only +// when the CustomKeyStoreType is 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) - // that uniquely identifies the secret access key. + // The part of the external key store [proxy authentication credential] that uniquely identifies the secret access + // key. + // + // [proxy authentication credential]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential AccessKeyId *string // Indicates whether the external key store proxy uses a public endpoint or an // Amazon VPC endpoint service to communicate with KMS. Connectivity XksProxyConnectivityType - // The URI endpoint for the external key store proxy. If the external key store - // proxy has a public endpoint, it is displayed here. If the external key store - // proxy uses an Amazon VPC endpoint service name, this field displays the private - // DNS name associated with the VPC endpoint service. + // The URI endpoint for the external key store proxy. + // + // If the external key store proxy has a public endpoint, it is displayed here. + // + // If the external key store proxy uses an Amazon VPC endpoint service name, this + // field displays the private DNS name associated with the VPC endpoint service. UriEndpoint *string // The path to the external key store proxy APIs. diff --git a/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go b/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go index 18079715f14..a543f112d1a 100644 --- a/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go +++ b/service/lakeformation/api_op_AssumeDecoratedRoleWithSAML.go @@ -17,12 +17,14 @@ import ( // operation requires SAML federation setup in the caller’s account as it can only // be called with valid SAML assertions. Lake Formation does not scope down the // 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: +// 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: func (c *Client) AssumeDecoratedRoleWithSAML(ctx context.Context, params *AssumeDecoratedRoleWithSAMLInput, optFns ...func(*Options)) (*AssumeDecoratedRoleWithSAMLOutput, error) { if params == nil { params = &AssumeDecoratedRoleWithSAMLInput{} diff --git a/service/lakeformation/api_op_CreateLakeFormationIdentityCenterConfiguration.go b/service/lakeformation/api_op_CreateLakeFormationIdentityCenterConfiguration.go index 7e196db9b41..cae4da29683 100644 --- a/service/lakeformation/api_op_CreateLakeFormationIdentityCenterConfiguration.go +++ b/service/lakeformation/api_op_CreateLakeFormationIdentityCenterConfiguration.go @@ -48,8 +48,11 @@ type CreateLakeFormationIdentityCenterConfigurationInput struct { // A list of Amazon Web Services account IDs and/or Amazon Web Services // organization/organizational unit ARNs that are allowed to access data managed by - // Lake Formation. If the ShareRecipients list includes valid values, a resource - // share is created with the principals you want to have access to the resources. + // Lake Formation. + // + // If the ShareRecipients list includes valid values, a resource share is created + // with the principals you want to have access to the resources. + // // If the ShareRecipients value is null or the list is empty, no resource share is // created. ShareRecipients []types.DataLakePrincipal diff --git a/service/lakeformation/api_op_DeleteObjectsOnCancel.go b/service/lakeformation/api_op_DeleteObjectsOnCancel.go index 6e328315ce8..9cb682bca39 100644 --- a/service/lakeformation/api_op_DeleteObjectsOnCancel.go +++ b/service/lakeformation/api_op_DeleteObjectsOnCancel.go @@ -14,11 +14,13 @@ import ( // 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) -// . +// 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]. +// +// [Rolling Back 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_DeregisterResource.go b/service/lakeformation/api_op_DeregisterResource.go index 97cbf5a8d09..0ac794b3af6 100644 --- a/service/lakeformation/api_op_DeregisterResource.go +++ b/service/lakeformation/api_op_DeregisterResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deregisters the resource as managed by the Data Catalog. When you deregister a -// path, Lake Formation removes the path from the inline policy attached to your -// service-linked role. +// Deregisters the resource as managed by the Data Catalog. +// +// When you deregister a path, Lake Formation removes the path from the inline +// policy attached to your service-linked role. func (c *Client) DeregisterResource(ctx context.Context, params *DeregisterResourceInput, optFns ...func(*Options)) (*DeregisterResourceOutput, error) { if params == nil { params = &DeregisterResourceInput{} diff --git a/service/lakeformation/api_op_DescribeLakeFormationIdentityCenterConfiguration.go b/service/lakeformation/api_op_DescribeLakeFormationIdentityCenterConfiguration.go index 01aefb68b5d..5e0fc44c8da 100644 --- a/service/lakeformation/api_op_DescribeLakeFormationIdentityCenterConfiguration.go +++ b/service/lakeformation/api_op_DescribeLakeFormationIdentityCenterConfiguration.go @@ -61,10 +61,14 @@ type DescribeLakeFormationIdentityCenterConfigurationOutput struct { // A list of Amazon Web Services account IDs or Amazon Web Services // organization/organizational unit ARNs that are allowed to access data managed by - // Lake Formation. If the ShareRecipients list includes valid values, a resource - // share is created with the principals you want to have access to the resources as - // the ShareRecipients . If the ShareRecipients value is null or the list is - // empty, no resource share is created. + // Lake Formation. + // + // If the ShareRecipients list includes valid values, a resource share is created + // with the principals you want to have access to the resources as the + // ShareRecipients . + // + // If the ShareRecipients value is null or the list is empty, no resource share is + // created. ShareRecipients []types.DataLakePrincipal // Metadata pertaining to the operation's result. diff --git a/service/lakeformation/api_op_ExtendTransaction.go b/service/lakeformation/api_op_ExtendTransaction.go index 478d958133d..25c36757803 100644 --- a/service/lakeformation/api_op_ExtendTransaction.go +++ b/service/lakeformation/api_op_ExtendTransaction.go @@ -11,8 +11,10 @@ import ( ) // Indicates to the service that the specified transaction is still active and -// should not be treated as idle and aborted. Write transactions that remain idle -// for a long period are automatically aborted unless explicitly extended. +// should not be treated as idle and aborted. +// +// Write transactions that remain idle for a long period are automatically aborted +// unless explicitly extended. func (c *Client) ExtendTransaction(ctx context.Context, params *ExtendTransactionInput, optFns ...func(*Options)) (*ExtendTransactionOutput, error) { if params == nil { params = &ExtendTransactionInput{} diff --git a/service/lakeformation/api_op_GetQueryState.go b/service/lakeformation/api_op_GetQueryState.go index c2bd998e3f2..76f39ad4700 100644 --- a/service/lakeformation/api_op_GetQueryState.go +++ b/service/lakeformation/api_op_GetQueryState.go @@ -44,10 +44,14 @@ 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. // diff --git a/service/lakeformation/api_op_GetTableObjects.go b/service/lakeformation/api_op_GetTableObjects.go index 581d897a8f1..d9ab873d244 100644 --- a/service/lakeformation/api_op_GetTableObjects.go +++ b/service/lakeformation/api_op_GetTableObjects.go @@ -52,8 +52,11 @@ 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. PartitionPredicate *string diff --git a/service/lakeformation/api_op_GrantPermissions.go b/service/lakeformation/api_op_GrantPermissions.go index 4b0c055e9f3..6754cc9fcbc 100644 --- a/service/lakeformation/api_op_GrantPermissions.go +++ b/service/lakeformation/api_op_GrantPermissions.go @@ -12,9 +12,11 @@ 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) -// . +// data organized in underlying data storage such as Amazon S3. +// +// For information about permissions, see [Security and Access Control to Metadata and Data]. +// +// [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{} @@ -43,9 +45,11 @@ type GrantPermissionsInput struct { // The principal to be granted the permissions on the resource. Supported // principals are IAM users or IAM roles, and they are defined by their principal - // type and their ARN. Note that if you define a resource with a particular ARN, - // then later delete, and recreate a resource with that same ARN, the resource - // maintains the permissions already granted. + // type and their ARN. + // + // Note that if you define a resource with a particular ARN, then later delete, + // and recreate a resource with that same ARN, the resource maintains the + // permissions already granted. // // This member is required. Principal *types.DataLakePrincipal diff --git a/service/lakeformation/api_op_ListPermissions.go b/service/lakeformation/api_op_ListPermissions.go index ac75e41262f..d3c9fe09900 100644 --- a/service/lakeformation/api_op_ListPermissions.go +++ b/service/lakeformation/api_op_ListPermissions.go @@ -13,11 +13,13 @@ import ( // Returns a list of the principal permissions on the resource, filtered by the // permissions of the caller. For example, if you are granted an ALTER permission, -// 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) -// . +// 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]. +// +// [Security and Access Control to Metadata and 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{} @@ -53,10 +55,11 @@ type ListPermissionsInput struct { // Specifies a principal to filter the permissions returned. Principal *types.DataLakePrincipal - // A resource where you will get a list of the principal permissions. This - // operation does not support getting privileges on a table with columns. Instead, - // call this operation on the table, and the operation returns the table and the - // table w columns. + // A resource where you will get a list of the principal permissions. + // + // This operation does not support getting privileges on a table with columns. + // Instead, call this operation on the table, and the operation returns the table + // and the table w columns. Resource *types.Resource // Specifies a resource type to filter the permissions returned. diff --git a/service/lakeformation/api_op_ListTransactions.go b/service/lakeformation/api_op_ListTransactions.go index 3289417cce2..a3d93264fee 100644 --- a/service/lakeformation/api_op_ListTransactions.go +++ b/service/lakeformation/api_op_ListTransactions.go @@ -13,8 +13,10 @@ import ( // Returns metadata about transactions and their status. To prevent the response // from growing indefinitely, only uncommitted transactions and those available for -// time-travel queries are returned. This operation can help you identify -// uncommitted transactions or to get information about transactions. +// time-travel queries are returned. +// +// This operation can help you identify uncommitted transactions or to get +// information about transactions. func (c *Client) ListTransactions(ctx context.Context, params *ListTransactionsInput, optFns ...func(*Options)) (*ListTransactionsOutput, error) { if params == nil { params = &ListTransactionsInput{} @@ -42,7 +44,7 @@ type ListTransactionsInput struct { // A continuation token if this is not the first call to retrieve transactions. NextToken *string - // A filter indicating the status of transactions to return. Options are ALL | + // A filter indicating the status of transactions to return. Options are ALL | // COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL . StatusFilter types.TransactionStatusFilter diff --git a/service/lakeformation/api_op_PutDataLakeSettings.go b/service/lakeformation/api_op_PutDataLakeSettings.go index 9a9a67cd7bc..8bb01914e19 100644 --- a/service/lakeformation/api_op_PutDataLakeSettings.go +++ b/service/lakeformation/api_op_PutDataLakeSettings.go @@ -13,10 +13,13 @@ 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]. +// +// 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. +// +// [Granting Lake Formation Permissions]: https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html func (c *Client) PutDataLakeSettings(ctx context.Context, params *PutDataLakeSettingsInput, optFns ...func(*Options)) (*PutDataLakeSettingsOutput, error) { if params == nil { params = &PutDataLakeSettingsInput{} diff --git a/service/lakeformation/api_op_RegisterResource.go b/service/lakeformation/api_op_RegisterResource.go index 55e24a03837..f3c2a4f2f02 100644 --- a/service/lakeformation/api_op_RegisterResource.go +++ b/service/lakeformation/api_op_RegisterResource.go @@ -10,19 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers the resource as managed by the Data Catalog. To add or update data, -// Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a -// role that you know has permission to do this, or choose the -// AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register -// the first Amazon S3 path, the service-linked role and a new inline policy are -// created on your behalf. Lake Formation adds the first path to the inline policy -// and attaches it to the service-linked role. When you register subsequent paths, -// Lake Formation adds the path to the existing policy. The following request -// 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 : -// arn:aws:iam::12345:role/my-data-access-role +// Registers the resource as managed by the Data Catalog. +// +// To add or update data, Lake Formation needs read/write access to the chosen +// Amazon S3 path. Choose a role that you know has permission to do this, or choose +// the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you +// register the first Amazon S3 path, the service-linked role and a new inline +// policy are created on your behalf. Lake Formation adds the first path to the +// inline policy and attaches it to the service-linked role. When you register +// subsequent paths, Lake Formation adds the path to the existing policy. +// +// The following request 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 : +// +// 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 { params = &RegisterResourceInput{} @@ -45,7 +50,7 @@ type RegisterResourceInput struct { // This member is required. ResourceArn *string - // Specifies whether the data access of tables pointing to the location can be + // Specifies whether the data access of tables pointing to the location can be // managed by both Lake Formation permissions as well as Amazon S3 bucket policies. HybridAccessEnabled *bool @@ -54,9 +59,11 @@ 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) - // . + // type of IAM role that is linked directly to Lake Formation. + // + // For more information, see [Using Service-Linked Roles for Lake Formation]. + // + // [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 991e9c5ea3d..dc314ecffd1 100644 --- a/service/lakeformation/api_op_RevokePermissions.go +++ b/service/lakeformation/api_op_RevokePermissions.go @@ -31,8 +31,9 @@ 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]. + // + // [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_StartQueryPlanning.go b/service/lakeformation/api_op_StartQueryPlanning.go index 9eabe2f6913..6cbf4f80bfe 100644 --- a/service/lakeformation/api_op_StartQueryPlanning.go +++ b/service/lakeformation/api_op_StartQueryPlanning.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. 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_UpdateLakeFormationIdentityCenterConfiguration.go b/service/lakeformation/api_op_UpdateLakeFormationIdentityCenterConfiguration.go index 492ae1efd1e..6a0032bd8f0 100644 --- a/service/lakeformation/api_op_UpdateLakeFormationIdentityCenterConfiguration.go +++ b/service/lakeformation/api_op_UpdateLakeFormationIdentityCenterConfiguration.go @@ -44,12 +44,16 @@ type UpdateLakeFormationIdentityCenterConfigurationInput struct { // A list of Amazon Web Services account IDs or Amazon Web Services // organization/organizational unit ARNs that are allowed to access to access data - // managed by Lake Formation. If the ShareRecipients list includes valid values, - // then the resource share is updated with the principals you want to have access - // to the resources. If the ShareRecipients value is null, both the list of share - // recipients and the resource share remain unchanged. If the ShareRecipients - // value is an empty list, then the existing share recipients list will be cleared, - // and the resource share will be deleted. + // managed by Lake Formation. + // + // If the ShareRecipients list includes valid values, then the resource share is + // updated with the principals you want to have access to the resources. + // + // If the ShareRecipients value is null, both the list of share recipients and the + // resource share remain unchanged. + // + // If the ShareRecipients value is an empty list, then the existing share + // recipients list will be cleared, and the resource share will be deleted. ShareRecipients []types.DataLakePrincipal noSmithyDocumentSerde diff --git a/service/lakeformation/api_op_UpdateResource.go b/service/lakeformation/api_op_UpdateResource.go index 3e8088d6a7a..4453698d998 100644 --- a/service/lakeformation/api_op_UpdateResource.go +++ b/service/lakeformation/api_op_UpdateResource.go @@ -39,7 +39,7 @@ type UpdateResourceInput struct { // This member is required. RoleArn *string - // Specifies whether the data access of tables pointing to the location can be + // Specifies whether the data access of tables pointing to the location can be // managed by both Lake Formation permissions as well as Amazon S3 bucket policies. HybridAccessEnabled *bool diff --git a/service/lakeformation/doc.go b/service/lakeformation/doc.go index 66b60b20b89..b7a6674ed1b 100644 --- a/service/lakeformation/doc.go +++ b/service/lakeformation/doc.go @@ -3,5 +3,7 @@ // Package lakeformation provides the API client, operations, and parameter types // for AWS Lake Formation. // -// Lake Formation Defines the public endpoint for the Lake Formation service. +// # Lake Formation +// +// Defines the public endpoint for the Lake Formation service. package lakeformation diff --git a/service/lakeformation/options.go b/service/lakeformation/options.go index 012d57d12fa..4e3c2ee68f2 100644 --- a/service/lakeformation/options.go +++ b/service/lakeformation/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lakeformation/types/enums.go b/service/lakeformation/types/enums.go index 9cf2d53c1fa..4d05ff78dc4 100644 --- a/service/lakeformation/types/enums.go +++ b/service/lakeformation/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "ENABLED", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQ", @@ -71,8 +73,9 @@ const ( ) // Values returns all known values for DataLakeResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataLakeResourceType) Values() []DataLakeResourceType { return []DataLakeResourceType{ "CATALOG", @@ -95,8 +98,9 @@ const ( ) // Values returns all known values for EnableStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnableStatus) Values() []EnableStatus { return []EnableStatus{ "ENABLED", @@ -114,8 +118,9 @@ const ( ) // Values returns all known values for FieldNameString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FieldNameString) Values() []FieldNameString { return []FieldNameString{ "RESOURCE_ARN", @@ -134,8 +139,9 @@ const ( ) // Values returns all known values for OptimizerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptimizerType) Values() []OptimizerType { return []OptimizerType{ "COMPACTION", @@ -164,8 +170,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "ALL", @@ -195,8 +202,9 @@ const ( ) // Values returns all known values for PermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionType) Values() []PermissionType { return []PermissionType{ "COLUMN_PERMISSION", @@ -218,8 +226,9 @@ const ( ) // Values returns all known values for QueryStateString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryStateString) Values() []QueryStateString { return []QueryStateString{ "PENDING", @@ -239,8 +248,9 @@ const ( ) // Values returns all known values for ResourceShareType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareType) Values() []ResourceShareType { return []ResourceShareType{ "FOREIGN", @@ -257,8 +267,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -277,8 +288,9 @@ const ( ) // Values returns all known values for TransactionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransactionStatus) Values() []TransactionStatus { return []TransactionStatus{ "ACTIVE", @@ -300,8 +312,9 @@ const ( ) // Values returns all known values for TransactionStatusFilter. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransactionStatusFilter) Values() []TransactionStatusFilter { return []TransactionStatusFilter{ "ALL", @@ -321,8 +334,9 @@ const ( ) // Values returns all known values for TransactionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransactionType) Values() []TransactionType { return []TransactionType{ "READ_AND_WRITE", diff --git a/service/lakeformation/types/types.go b/service/lakeformation/types/types.go index 8d267a486e3..9b5ebf93dad 100644 --- a/service/lakeformation/types/types.go +++ b/service/lakeformation/types/types.go @@ -27,9 +27,10 @@ type AddObjectInput struct { Uri *string // A list of partition values for the object. A value must be specified for each - // partition key associated with the table. The supported data types are integer, - // long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd - // HH:mm:ss"), string and decimal. + // partition key associated with the table. + // + // The supported data types are integer, long, date(yyyy-MM-dd), + // timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal. PartitionValues []string noSmithyDocumentSerde @@ -157,8 +158,9 @@ type DataCellsFilter struct { // Nested attributes within this list may not exceed a depth of 5. ColumnNames []string - // A wildcard with exclusions. You must specify either a ColumnNames list or the - // ColumnWildCard . + // A wildcard with exclusions. + // + // You must specify either a ColumnNames list or the ColumnWildCard . ColumnWildcard *ColumnWildcard // A PartiQL predicate. @@ -203,12 +205,16 @@ type DataLakePrincipal struct { type DataLakeSettings struct { // Whether to allow Amazon EMR clusters to access data managed by Lake Formation. + // // If true, you allow Amazon EMR clusters to access data in Amazon S3 locations - // 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 external data - // filtering (https://docs.aws.amazon.com/lake-formation/latest/dg/initial-LF-setup.html#external-data-filter) - // . + // 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 external data filtering]. + // + // [(Optional) Allow external data filtering]: https://docs.aws.amazon.com/lake-formation/latest/dg/initial-LF-setup.html#external-data-filter AllowExternalDataFiltering *bool // Whether to allow a third-party query engine to get data access credentials @@ -224,27 +230,37 @@ type DataLakeSettings struct { AuthorizedSessionTagValueList []string // Specifies whether access control on newly created database is managed by Lake - // Formation permissions or exclusively by IAM permissions. A null value indicates - // access control by Lake Formation permissions. A value that assigns ALL to - // IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is - // referred to as the setting "Use only IAM access control," and is for backward - // 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) - // . + // Formation permissions or exclusively by IAM permissions. + // + // A null value indicates access control by Lake Formation permissions. A value + // that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM + // permissions. This is referred to as the setting "Use only IAM access control," + // and is for backward 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]. + // + // [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 - // Formation permissions or exclusively by IAM permissions. A null value indicates - // access control by Lake Formation permissions. A value that assigns ALL to - // IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is - // referred to as the setting "Use only IAM access control," and is for backward - // 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) - // . + // Formation permissions or exclusively by IAM permissions. + // + // A null value indicates access control by Lake Formation permissions. A value + // that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM + // permissions. This is referred to as the setting "Use only IAM access control," + // and is for backward 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]. + // + // [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 @@ -267,14 +283,17 @@ type DataLakeSettings struct { // A list of the resource-owning account IDs that the caller's account can use to // share their user access details (user ARNs). The user ARNs can be logged in the - // resource owner's CloudTrail log. You may want to specify this property when you - // are in a high-trust boundary, such as the same team or company. + // resource owner's CloudTrail log. + // + // You may want to specify this property when you are in a high-trust boundary, + // such as the same team or company. TrustedResourceOwners []string noSmithyDocumentSerde } -// A structure for a data location object where permissions are granted or revoked. +// A structure for a data location object where permissions are granted or +// revoked. type DataLocationResource struct { // The Amazon Resource Name (ARN) that uniquely identifies the data location @@ -310,9 +329,10 @@ type DeleteObjectInput struct { } // A structure containing the additional details to be returned in the -// 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. +// 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 { // A resource share ARN for a catalog resource shared through RAM. @@ -410,9 +430,10 @@ type LFTag struct { // This member is required. TagKey *string - // A list of possible values an attribute can take. The maximum number of values - // that can be defined for a LF-Tag is 1000. A single API call supports 50 values. - // You can use multiple API calls to add more values. + // A list of possible values an attribute can take. + // + // The maximum number of values that can be defined for a LF-Tag is 1000. A single + // API call supports 50 values. You can use multiple API calls to add more values. // // This member is required. TagValues []string @@ -678,7 +699,7 @@ type Resource struct { // A structure containing information about an Lake Formation resource. type ResourceInfo struct { - // Indicates whether the data access of tables pointing to the location can be + // Indicates whether the data access of tables pointing to the location can be // managed by both Lake Formation permissions as well as Amazon S3 bucket policies. HybridAccessEnabled *bool @@ -716,10 +737,12 @@ type StorageOptimizer struct { // key-value pair: is_enabled indicates true or false for acceleration. Config map[string]string - // A message that contains information about any error (if present). When an - // acceleration result has an enabled status, the error message is empty. When an - // acceleration result has a disabled status, the message describes an error or - // simply indicates "disabled by the user". + // A message that contains information about any error (if present). + // + // When an acceleration result has an enabled status, the error message is empty. + // + // When an acceleration result has a disabled status, the message describes an + // error or simply indicates "disabled by the user". ErrorMessage *string // When an acceleration result has an enabled status, contains the details of the @@ -769,8 +792,9 @@ type TableResource struct { // The name of the table. Name *string - // A wildcard object representing every table under a database. At least one of - // TableResource$Name or TableResource$TableWildcard is required. + // A wildcard object representing every table under a database. + // + // At least one of TableResource$Name or TableResource$TableWildcard is required. TableWildcard *TableWildcard noSmithyDocumentSerde @@ -782,8 +806,10 @@ 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 . +// granting a SELECT permission. +// +// This object must take a value for at least one of ColumnsNames , ColumnsIndexes +// , or ColumnsWildcard . type TableWithColumnsResource struct { // The name of the database for the table with columns resource. Unique to the diff --git a/service/lambda/api_op_AddLayerVersionPermission.go b/service/lambda/api_op_AddLayerVersionPermission.go index 7bf4555e046..5c7446d22eb 100644 --- a/service/lambda/api_op_AddLayerVersionPermission.go +++ b/service/lambda/api_op_AddLayerVersionPermission.go @@ -10,12 +10,15 @@ 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 +// Adds permissions to the resource-based policy of a version of an [Lambda layer]. 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. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html func (c *Client) AddLayerVersionPermission(ctx context.Context, params *AddLayerVersionPermissionInput, optFns ...func(*Options)) (*AddLayerVersionPermissionOutput, error) { if params == nil { params = &AddLayerVersionPermissionInput{} diff --git a/service/lambda/api_op_AddPermission.go b/service/lambda/api_op_AddPermission.go index 9788211d456..dfeec24141e 100644 --- a/service/lambda/api_op_AddPermission.go +++ b/service/lambda/api_op_AddPermission.go @@ -16,19 +16,21 @@ import ( // the function level, or specify a qualifier to restrict access to a single // 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 +// 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 // 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) -// . +// 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]. +// +// [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{} @@ -52,10 +54,16 @@ type AddPermissionInput struct { // This member is required. Action *string - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -82,8 +90,9 @@ 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]. + // + // [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 @@ -105,8 +114,9 @@ type AddPermissionInput struct { SourceAccount *string // For Amazon Web Services, the ARN of the Amazon Web Services resource that - // invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. Note - // that Lambda configures the comparison using the StringLike operator. + // invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. + // + // Note that Lambda configures the comparison using the StringLike operator. SourceArn *string noSmithyDocumentSerde diff --git a/service/lambda/api_op_CreateAlias.go b/service/lambda/api_op_CreateAlias.go index 7bd6c33db3f..4cf98ee2170 100644 --- a/service/lambda/api_op_CreateAlias.go +++ b/service/lambda/api_op_CreateAlias.go @@ -11,12 +11,14 @@ 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 -// 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 -// invocation requests that it receives. +// Creates an [alias] 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 invocation requests that it receives. +// +// [alias]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error) { if params == nil { params = &CreateAliasInput{} @@ -34,10 +36,16 @@ func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optF type CreateAliasInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -57,15 +65,17 @@ 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) - // of the alias. + // The [routing configuration] of the alias. + // + // [routing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing 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]. +// +// [alias]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html type CreateAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. @@ -83,8 +93,9 @@ 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) - // of the alias. + // The [routing configuration] of the alias. + // + // [routing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html RoutingConfig *types.AliasRoutingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/lambda/api_op_CreateCodeSigningConfig.go b/service/lambda/api_op_CreateCodeSigningConfig.go index 78578022ef4..76faaf56028 100644 --- a/service/lambda/api_op_CreateCodeSigningConfig.go +++ b/service/lambda/api_op_CreateCodeSigningConfig.go @@ -11,9 +11,11 @@ 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) -// defines a list of allowed signing profiles and defines the code-signing -// validation policy (action to be taken if deployment validation checks fail). +// Creates a code signing configuration. A [code signing configuration] defines a list of allowed signing +// profiles and defines the code-signing validation policy (action to be taken if +// deployment validation checks fail). +// +// [code signing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html func (c *Client) CreateCodeSigningConfig(ctx context.Context, params *CreateCodeSigningConfigInput, optFns ...func(*Options)) (*CreateCodeSigningConfigOutput, error) { if params == nil { params = &CreateCodeSigningConfigInput{} diff --git a/service/lambda/api_op_CreateEventSourceMapping.go b/service/lambda/api_op_CreateEventSourceMapping.go index ae5d4f39185..d1a4499f186 100644 --- a/service/lambda/api_op_CreateEventSourceMapping.go +++ b/service/lambda/api_op_CreateEventSourceMapping.go @@ -13,40 +13,69 @@ 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) +// 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] +// +// [Amazon Kinesis] +// +// [Amazon SQS] +// +// [Amazon MQ and RabbitMQ] +// +// [Amazon MSK] +// +// [Apache Kafka] +// +// [Amazon DocumentDB] // // 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) +// +// [Amazon DynamoDB Streams] +// +// [Amazon Kinesis] +// +// [Amazon SQS] +// +// [Amazon MQ and RabbitMQ] +// +// [Amazon MSK] +// +// [Apache Kafka] +// +// [Amazon DocumentDB] +// +// [Amazon DynamoDB Streams]: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params +// [Amazon SQS]: https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params +// [Amazon MSK]: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms +// [Amazon Kinesis]: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params +// [Amazon MQ and RabbitMQ]: https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params +// [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{} @@ -64,12 +93,19 @@ func (c *Client) CreateEventSourceMapping(ctx context.Context, params *CreateEve type CreateEventSourceMappingInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -84,13 +120,20 @@ type CreateEventSourceMappingInput 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. BatchSize *int32 @@ -107,23 +150,33 @@ type CreateEventSourceMappingInput struct { DocumentDBEventSourceConfig *types.DocumentDBEventSourceConfig // When true, the event source mapping is active. When false, Lambda pauses - // polling and invocation. Default: True + // 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 or the - // ARN of the VPC connection (for cross-account event source mappings (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc) - // ). + // ARN of the VPC connection (for [cross-account event source mappings]). + // // - Amazon MQ – The ARN of the broker. + // // - Amazon DocumentDB – The ARN of the DocumentDB change stream. + // + // [cross-account event source mappings]: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc 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]. + // + // [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 @@ -132,16 +185,18 @@ type CreateEventSourceMappingInput struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified @@ -157,12 +212,13 @@ type CreateEventSourceMappingInput struct { // shard concurrently. ParallelizationFactor *int32 - // (MQ) The name of the Amazon MQ broker destination queue to consume. + // (MQ) The name of the Amazon MQ broker destination queue to consume. 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]. + // + // [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. @@ -197,7 +253,7 @@ 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 @@ -207,10 +263,13 @@ type CreateEventSourceMappingOutput struct { // 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). Default value: Varies by service. For Amazon SQS, the default - // is 10. For all other services, the default is 100. Related setting: When you set - // BatchSize to a value greater than 10, you must set - // MaximumBatchingWindowInSeconds to at least 1. + // invocation (6 MB). + // + // Default value: Varies by service. For Amazon SQS, the default is 10. For all + // other services, the default is 100. + // + // Related setting: When you set BatchSize to a value greater than 10, you must + // set MaximumBatchingWindowInSeconds to at least 1. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -229,8 +288,9 @@ 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]. + // + // [Lambda event filtering]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -249,23 +309,27 @@ type CreateEventSourceMappingOutput struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified // age. The default value is -1, which sets the maximum age to infinite. When the - // value is set to infinite, Lambda never discards old records. The minimum valid - // value for maximum record age is 60s. Although values less than 60 and greater - // than -1 fall within the parameter's absolute range, they are not allowed + // value is set to infinite, Lambda never discards old records. + // + // The minimum valid value for maximum record age is 60s. Although values less + // than 60 and greater than -1 fall within the parameter's absolute range, they are + // not allowed MaximumRecordAgeInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records after the specified number @@ -278,12 +342,13 @@ type CreateEventSourceMappingOutput struct { // concurrently from each shard. The default value is 1. ParallelizationFactor *int32 - // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. + // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. 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]. + // + // [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. diff --git a/service/lambda/api_op_CreateFunction.go b/service/lambda/api_op_CreateFunction.go index 45176080c3d..77b9755c2db 100644 --- a/service/lambda/api_op_CreateFunction.go +++ b/service/lambda/api_op_CreateFunction.go @@ -11,52 +11,64 @@ 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 -// 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 +// Creates a Lambda function. To create a function, you need a [deployment package] and an [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], 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], 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]. +// +// 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 ). +// 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 // 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 -// 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 +// configuration. When a user attempts to deploy a code package with 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 AddPermissionto 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 -// invoke your function in response to events in other Amazon Web Services, create -// 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) . +// 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 trigger in the other service. For more information, see [Invoking Lambda functions]. +// +// [Invoking Lambda functions]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-invocation.html +// [Lambda function states]: https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html +// [.zip file archive]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip +// [execution role]: https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role +// [container image]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html +// [deployment package]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html func (c *Client) CreateFunction(ctx context.Context, params *CreateFunctionInput, optFns ...func(*Options)) (*CreateFunctionOutput, error) { if params == nil { params = &CreateFunctionInput{} @@ -79,10 +91,16 @@ type CreateFunctionInput struct { // This member is required. Code *types.FunctionCode - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -106,8 +124,9 @@ type CreateFunctionInput struct { // 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) - // . + // information, see [Dead-letter queues]. + // + // [Dead-letter queues]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq DeadLetterConfig *types.DeadLetterConfig // A description of the function. @@ -117,9 +136,9 @@ type CreateFunctionInput struct { Environment *types.Environment // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage EphemeralStorage *types.EphemeralStorage // Connection settings for an Amazon EFS file system. @@ -128,36 +147,42 @@ 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]. + // + // [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-create.html#images-parms) - // that override the values in the container image Dockerfile. + // Container image [configuration values] that override the values in the container image Dockerfile. + // + // [configuration values]: https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms 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, Lambda also uses this key is to encrypt your function's snapshot. - // If you deploy your function using a container image, Lambda also uses this key - // to encrypt your function when it's deployed. Note that this is not the same key - // that's used to protect your container image in the Amazon Elastic Container - // Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses - // a default service key. + // encrypt your function's [environment variables]. When [Lambda SnapStart] is activated, Lambda also uses this key is to + // encrypt your function's snapshot. If you deploy your function using a container + // image, Lambda also uses this key to encrypt your function when it's deployed. + // Note that this is not the same key that's used to protect your container image + // in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a + // customer managed key, Lambda uses a default service key. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption 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, - // including the version. + // A list of [function layers] to add to the function's execution environment. Specify each layer + // by its ARN, including the version. + // + // [function layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []string // The function's Amazon CloudWatch Logs configuration settings. LoggingConfig *types.LoggingConfig - // 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. + // The amount of [memory available to the function] 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. + // + // [memory available to the function]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console MemorySize *int32 // The type of deployment package. Set to Image for container image and set to Zip @@ -167,36 +192,43 @@ 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [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] setting. + // + // [SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html SnapStart *types.SnapStart - // A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to - // apply to the function. + // A list of [tags] to apply to the function. + // + // [tags]: https://docs.aws.amazon.com/lambda/latest/dg/tagging.html Tags map[string]string // 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]. + // + // [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]. + // + // [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]. + // + // [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 @@ -222,18 +254,20 @@ 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]. Omitted from CloudTrail logs. + // + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Environment *types.EnvironmentResponse // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage 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]. + // + // [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). @@ -248,14 +282,18 @@ 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]. When [Lambda SnapStart] 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. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // The date and time that the function was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModified *string // The status of the last update that was performed on the function. This is first @@ -268,8 +306,9 @@ 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]. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []types.Layer // The function's Amazon CloudWatch Logs configuration settings. @@ -291,11 +330,13 @@ type CreateFunctionOutput struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy Runtime types.Runtime // The ARN of the runtime and any errors that occured. @@ -309,8 +350,9 @@ 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]. + // + // [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 diff --git a/service/lambda/api_op_CreateFunctionUrlConfig.go b/service/lambda/api_op_CreateFunctionUrlConfig.go index cc74a8197cc..95e80e23679 100644 --- a/service/lambda/api_op_CreateFunctionUrlConfig.go +++ b/service/lambda/api_op_CreateFunctionUrlConfig.go @@ -34,35 +34,45 @@ 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]. + // + // [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 or ARN of the Lambda function. Name formats + // The name or ARN 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. // // 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)] settings for your function URL. + // + // [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // . + // operation. The maximum response payload size is 20 MB, however, you can [request a quota increase]. + // + // [request a quota increase]: https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html InvokeMode types.InvokeMode // The alias name. @@ -76,14 +86,16 @@ 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]. + // + // [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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime // // This member is required. CreationTime *string @@ -98,19 +110,22 @@ 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)] settings for your function URL. + // + // [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // . + // operation. The maximum response payload size is 20 MB, however, you can [request a quota increase]. + // + // [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 b72de385483..315824c8c91 100644 --- a/service/lambda/api_op_DeleteAlias.go +++ b/service/lambda/api_op_DeleteAlias.go @@ -10,8 +10,9 @@ 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]. +// +// [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{} @@ -29,10 +30,16 @@ func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optF type DeleteAliasInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_DeleteEventSourceMapping.go b/service/lambda/api_op_DeleteEventSourceMapping.go index a5749168294..8c202c94322 100644 --- a/service/lambda/api_op_DeleteEventSourceMapping.go +++ b/service/lambda/api_op_DeleteEventSourceMapping.go @@ -12,10 +12,12 @@ 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]. 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. +// +// [event source mapping]: https://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html func (c *Client) DeleteEventSourceMapping(ctx context.Context, params *DeleteEventSourceMappingInput, optFns ...func(*Options)) (*DeleteEventSourceMappingOutput, error) { if params == nil { params = &DeleteEventSourceMappingInput{} @@ -42,7 +44,7 @@ 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 @@ -52,10 +54,13 @@ type DeleteEventSourceMappingOutput struct { // 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). Default value: Varies by service. For Amazon SQS, the default - // is 10. For all other services, the default is 100. Related setting: When you set - // BatchSize to a value greater than 10, you must set - // MaximumBatchingWindowInSeconds to at least 1. + // invocation (6 MB). + // + // Default value: Varies by service. For Amazon SQS, the default is 10. For all + // other services, the default is 100. + // + // Related setting: When you set BatchSize to a value greater than 10, you must + // set MaximumBatchingWindowInSeconds to at least 1. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -74,8 +79,9 @@ 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]. + // + // [Lambda event filtering]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -94,23 +100,27 @@ type DeleteEventSourceMappingOutput struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified // age. The default value is -1, which sets the maximum age to infinite. When the - // value is set to infinite, Lambda never discards old records. The minimum valid - // value for maximum record age is 60s. Although values less than 60 and greater - // than -1 fall within the parameter's absolute range, they are not allowed + // value is set to infinite, Lambda never discards old records. + // + // The minimum valid value for maximum record age is 60s. Although values less + // than 60 and greater than -1 fall within the parameter's absolute range, they are + // not allowed MaximumRecordAgeInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records after the specified number @@ -123,12 +133,13 @@ type DeleteEventSourceMappingOutput struct { // concurrently from each shard. The default value is 1. ParallelizationFactor *int32 - // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. + // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. 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]. + // + // [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. diff --git a/service/lambda/api_op_DeleteFunction.go b/service/lambda/api_op_DeleteFunction.go index fad3deaa338..a7cded785dc 100644 --- a/service/lambda/api_op_DeleteFunction.go +++ b/service/lambda/api_op_DeleteFunction.go @@ -12,11 +12,11 @@ import ( // Deletes a Lambda function. To delete a specific function version, use the // Qualifier parameter. Otherwise, all versions and aliases are deleted. This -// doesn't require the user to have explicit permissions for DeleteAlias . 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 -// configured it. +// doesn't require the user to have explicit permissions for DeleteAlias. +// +// 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 configured it. func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput, optFns ...func(*Options)) (*DeleteFunctionOutput, error) { if params == nil { params = &DeleteFunctionInput{} @@ -34,10 +34,16 @@ func (c *Client) DeleteFunction(ctx context.Context, params *DeleteFunctionInput type DeleteFunctionInput struct { - // The name or ARN of the Lambda function or version. Name formats + // The name or ARN 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. diff --git a/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go b/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go index f112bc82b5c..d5e8a873eff 100644 --- a/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go +++ b/service/lambda/api_op_DeleteFunctionCodeSigningConfig.go @@ -28,10 +28,16 @@ func (c *Client) DeleteFunctionCodeSigningConfig(ctx context.Context, params *De type DeleteFunctionCodeSigningConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_DeleteFunctionConcurrency.go b/service/lambda/api_op_DeleteFunctionConcurrency.go index 925cdcc9b18..a9fe3f9a85f 100644 --- a/service/lambda/api_op_DeleteFunctionConcurrency.go +++ b/service/lambda/api_op_DeleteFunctionConcurrency.go @@ -28,10 +28,16 @@ func (c *Client) DeleteFunctionConcurrency(ctx context.Context, params *DeleteFu type DeleteFunctionConcurrencyInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go b/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go index 43f65cc7534..7f75c515b5f 100644 --- a/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_DeleteFunctionEventInvokeConfig.go @@ -11,8 +11,9 @@ import ( ) // Deletes the configuration for asynchronous invocation for a function, version, -// or alias. To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig . +// or alias. +// +// To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. func (c *Client) DeleteFunctionEventInvokeConfig(ctx context.Context, params *DeleteFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*DeleteFunctionEventInvokeConfigOutput, error) { if params == nil { params = &DeleteFunctionEventInvokeConfigInput{} @@ -30,10 +31,16 @@ func (c *Client) DeleteFunctionEventInvokeConfig(ctx context.Context, params *De type DeleteFunctionEventInvokeConfigInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. diff --git a/service/lambda/api_op_DeleteFunctionUrlConfig.go b/service/lambda/api_op_DeleteFunctionUrlConfig.go index b2bb38d04d5..c933b5d13b5 100644 --- a/service/lambda/api_op_DeleteFunctionUrlConfig.go +++ b/service/lambda/api_op_DeleteFunctionUrlConfig.go @@ -29,10 +29,16 @@ func (c *Client) DeleteFunctionUrlConfig(ctx context.Context, params *DeleteFunc type DeleteFunctionUrlConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_DeleteLayerVersion.go b/service/lambda/api_op_DeleteLayerVersion.go index 2179aaf3d0d..277f67fcb1e 100644 --- a/service/lambda/api_op_DeleteLayerVersion.go +++ b/service/lambda/api_op_DeleteLayerVersion.go @@ -10,10 +10,11 @@ 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 -// breaking functions, a copy of the version remains in Lambda until no functions -// refer to it. +// Deletes a version of an [Lambda layer]. 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. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html func (c *Client) DeleteLayerVersion(ctx context.Context, params *DeleteLayerVersionInput, optFns ...func(*Options)) (*DeleteLayerVersionOutput, error) { if params == nil { params = &DeleteLayerVersionInput{} diff --git a/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go b/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go index 3c03e15c18f..3474b379334 100644 --- a/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_DeleteProvisionedConcurrencyConfig.go @@ -28,10 +28,16 @@ func (c *Client) DeleteProvisionedConcurrencyConfig(ctx context.Context, params type DeleteProvisionedConcurrencyConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_GetAccountSettings.go b/service/lambda/api_op_GetAccountSettings.go index fca60c193dc..d827d6faf65 100644 --- a/service/lambda/api_op_GetAccountSettings.go +++ b/service/lambda/api_op_GetAccountSettings.go @@ -11,8 +11,10 @@ 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] and usage in an Amazon Web Services +// Region. +// +// [limits]: https://docs.aws.amazon.com/lambda/latest/dg/limits.html 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 720f0daea3c..4695cf840a4 100644 --- a/service/lambda/api_op_GetAlias.go +++ b/service/lambda/api_op_GetAlias.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} @@ -30,10 +31,16 @@ func (c *Client) GetAlias(ctx context.Context, params *GetAliasInput, optFns ... type GetAliasInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -48,8 +55,9 @@ 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]. +// +// [alias]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html type GetAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. @@ -67,8 +75,9 @@ 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) - // of the alias. + // The [routing configuration] of the alias. + // + // [routing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html RoutingConfig *types.AliasRoutingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/lambda/api_op_GetEventSourceMapping.go b/service/lambda/api_op_GetEventSourceMapping.go index 4c9131c0801..afe71755f17 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,7 +40,7 @@ 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 @@ -50,10 +50,13 @@ type GetEventSourceMappingOutput struct { // 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). Default value: Varies by service. For Amazon SQS, the default - // is 10. For all other services, the default is 100. Related setting: When you set - // BatchSize to a value greater than 10, you must set - // MaximumBatchingWindowInSeconds to at least 1. + // invocation (6 MB). + // + // Default value: Varies by service. For Amazon SQS, the default is 10. For all + // other services, the default is 100. + // + // Related setting: When you set BatchSize to a value greater than 10, you must + // set MaximumBatchingWindowInSeconds to at least 1. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -72,8 +75,9 @@ 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]. + // + // [Lambda event filtering]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -92,23 +96,27 @@ type GetEventSourceMappingOutput struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified // age. The default value is -1, which sets the maximum age to infinite. When the - // value is set to infinite, Lambda never discards old records. The minimum valid - // value for maximum record age is 60s. Although values less than 60 and greater - // than -1 fall within the parameter's absolute range, they are not allowed + // value is set to infinite, Lambda never discards old records. + // + // The minimum valid value for maximum record age is 60s. Although values less + // than 60 and greater than -1 fall within the parameter's absolute range, they are + // not allowed MaximumRecordAgeInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records after the specified number @@ -121,12 +129,13 @@ type GetEventSourceMappingOutput struct { // concurrently from each shard. The default value is 1. ParallelizationFactor *int32 - // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. + // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. 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]. + // + // [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. diff --git a/service/lambda/api_op_GetFunction.go b/service/lambda/api_op_GetFunction.go index c85cb02711f..279627c8781 100644 --- a/service/lambda/api_op_GetFunction.go +++ b/service/lambda/api_op_GetFunction.go @@ -36,10 +36,16 @@ func (c *Client) GetFunction(ctx context.Context, params *GetFunctionInput, optF type GetFunctionInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -59,14 +65,17 @@ 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]. + // + // [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]. + // + // [tags]: https://docs.aws.amazon.com/lambda/latest/dg/tagging.html Tags map[string]string // Metadata pertaining to the operation's result. @@ -193,12 +202,13 @@ type FunctionActiveV2WaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFunctionInput, *GetFunctionOutput, error) (bool, error) } @@ -399,12 +409,13 @@ type FunctionExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFunctionInput, *GetFunctionOutput, error) (bool, error) } @@ -565,12 +576,13 @@ type FunctionUpdatedV2WaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFunctionInput, *GetFunctionOutput, error) (bool, error) } diff --git a/service/lambda/api_op_GetFunctionCodeSigningConfig.go b/service/lambda/api_op_GetFunctionCodeSigningConfig.go index 31729881375..af739bcf3b4 100644 --- a/service/lambda/api_op_GetFunctionCodeSigningConfig.go +++ b/service/lambda/api_op_GetFunctionCodeSigningConfig.go @@ -28,10 +28,16 @@ func (c *Client) GetFunctionCodeSigningConfig(ctx context.Context, params *GetFu type GetFunctionCodeSigningConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -48,10 +54,16 @@ type GetFunctionCodeSigningConfigOutput struct { // This member is required. CodeSigningConfigArn *string - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_GetFunctionConcurrency.go b/service/lambda/api_op_GetFunctionConcurrency.go index 6f761ef4d60..7ae97944426 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{} @@ -29,10 +29,16 @@ func (c *Client) GetFunctionConcurrency(ctx context.Context, params *GetFunction type GetFunctionConcurrencyInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_GetFunctionConfiguration.go b/service/lambda/api_op_GetFunctionConfiguration.go index 3aff0e1f4f0..74fbc477178 100644 --- a/service/lambda/api_op_GetFunctionConfiguration.go +++ b/service/lambda/api_op_GetFunctionConfiguration.go @@ -17,8 +17,9 @@ 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{} @@ -36,10 +37,16 @@ func (c *Client) GetFunctionConfiguration(ctx context.Context, params *GetFuncti type GetFunctionConfigurationInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -74,18 +81,20 @@ 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]. Omitted from CloudTrail logs. + // + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Environment *types.EnvironmentResponse // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage 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]. + // + // [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). @@ -100,14 +109,18 @@ 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]. When [Lambda SnapStart] 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. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // The date and time that the function was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModified *string // The status of the last update that was performed on the function. This is first @@ -120,8 +133,9 @@ 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]. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []types.Layer // The function's Amazon CloudWatch Logs configuration settings. @@ -143,11 +157,13 @@ type GetFunctionConfigurationOutput struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy Runtime types.Runtime // The ARN of the runtime and any errors that occured. @@ -161,8 +177,9 @@ 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]. + // + // [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 @@ -314,12 +331,13 @@ type FunctionActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFunctionConfigurationInput, *GetFunctionConfigurationOutput, error) (bool, error) } @@ -520,12 +538,13 @@ type FunctionUpdatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFunctionConfigurationInput, *GetFunctionConfigurationOutput, error) (bool, error) } @@ -728,12 +747,13 @@ type PublishedVersionActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetFunctionConfigurationInput, *GetFunctionConfigurationOutput, error) (bool, error) } diff --git a/service/lambda/api_op_GetFunctionEventInvokeConfig.go b/service/lambda/api_op_GetFunctionEventInvokeConfig.go index 27deb8e2f96..dec4ba444f3 100644 --- a/service/lambda/api_op_GetFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_GetFunctionEventInvokeConfig.go @@ -13,8 +13,9 @@ import ( ) // Retrieves the configuration for asynchronous invocation for a function, -// version, or alias. To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig . +// 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{} @@ -32,10 +33,16 @@ func (c *Client) GetFunctionEventInvokeConfig(ctx context.Context, params *GetFu type GetFunctionEventInvokeConfigInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -51,11 +58,16 @@ type GetFunctionEventInvokeConfigInput struct { type GetFunctionEventInvokeConfigOutput struct { - // A destination for events after they have been sent to a function for - // processing. Destinations + // 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 diff --git a/service/lambda/api_op_GetFunctionUrlConfig.go b/service/lambda/api_op_GetFunctionUrlConfig.go index d7d7546e032..d9f747a0a7f 100644 --- a/service/lambda/api_op_GetFunctionUrlConfig.go +++ b/service/lambda/api_op_GetFunctionUrlConfig.go @@ -29,10 +29,16 @@ func (c *Client) GetFunctionUrlConfig(ctx context.Context, params *GetFunctionUr type GetFunctionUrlConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -50,14 +56,16 @@ 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]. + // + // [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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime // // This member is required. CreationTime *string @@ -72,25 +80,30 @@ 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) + // When the function URL configuration was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime + // // 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)] settings for your function URL. + // + // [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // . + // operation. The maximum response payload size is 20 MB, however, you can [request a quota increase]. + // + // [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 643bac9d62f..9aa84e70e70 100644 --- a/service/lambda/api_op_GetLayerVersion.go +++ b/service/lambda/api_op_GetLayerVersion.go @@ -11,8 +11,10 @@ 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], with a link to download the layer +// archive that's valid for 10 minutes. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html func (c *Client) GetLayerVersion(ctx context.Context, params *GetLayerVersionInput, optFns ...func(*Options)) (*GetLayerVersionOutput, error) { if params == nil { params = &GetLayerVersionInput{} @@ -45,20 +47,24 @@ 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]. + // + // [instruction set architectures]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html CompatibleArchitectures []types.Architecture - // The layer's compatible runtimes. 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 layer's compatible runtimes. + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy CompatibleRuntimes []types.Runtime // 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime CreatedDate *string // The description of the version. diff --git a/service/lambda/api_op_GetLayerVersionByArn.go b/service/lambda/api_op_GetLayerVersionByArn.go index 11492139be5..f45d44097c2 100644 --- a/service/lambda/api_op_GetLayerVersionByArn.go +++ b/service/lambda/api_op_GetLayerVersionByArn.go @@ -11,8 +11,10 @@ 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], with a link to download the layer +// archive that's valid for 10 minutes. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html func (c *Client) GetLayerVersionByArn(ctx context.Context, params *GetLayerVersionByArnInput, optFns ...func(*Options)) (*GetLayerVersionByArnOutput, error) { if params == nil { params = &GetLayerVersionByArnInput{} @@ -40,20 +42,24 @@ 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]. + // + // [instruction set architectures]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html CompatibleArchitectures []types.Architecture - // The layer's compatible runtimes. 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 layer's compatible runtimes. + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy CompatibleRuntimes []types.Runtime // 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime CreatedDate *string // The description of the version. diff --git a/service/lambda/api_op_GetLayerVersionPolicy.go b/service/lambda/api_op_GetLayerVersionPolicy.go index 0d8aab223fb..368ea14fb91 100644 --- a/service/lambda/api_op_GetLayerVersionPolicy.go +++ b/service/lambda/api_op_GetLayerVersionPolicy.go @@ -10,8 +10,9 @@ 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]. For more information, see AddLayerVersionPermission. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html 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 355a8e768dc..7fd9ad48d1e 100644 --- a/service/lambda/api_op_GetPolicy.go +++ b/service/lambda/api_op_GetPolicy.go @@ -10,8 +10,9 @@ 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) -// for a function, version, or alias. +// Returns the [resource-based IAM policy] for a function, version, or alias. +// +// [resource-based IAM policy]: https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error) { if params == nil { params = &GetPolicyInput{} @@ -29,10 +30,16 @@ func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns . type GetPolicyInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. diff --git a/service/lambda/api_op_GetProvisionedConcurrencyConfig.go b/service/lambda/api_op_GetProvisionedConcurrencyConfig.go index 0a3f8cb57bf..fb7be59000f 100644 --- a/service/lambda/api_op_GetProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_GetProvisionedConcurrencyConfig.go @@ -30,10 +30,16 @@ func (c *Client) GetProvisionedConcurrencyConfig(ctx context.Context, params *Ge type GetProvisionedConcurrencyConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -58,8 +64,9 @@ 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]. + // + // [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 3795ee662b9..65d34d189cd 100644 --- a/service/lambda/api_op_GetRuntimeManagementConfig.go +++ b/service/lambda/api_op_GetRuntimeManagementConfig.go @@ -15,8 +15,9 @@ import ( // 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) -// . +// more information, see [Runtime updates]. +// +// [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{} @@ -34,10 +35,16 @@ func (c *Client) GetRuntimeManagementConfig(ctx context.Context, params *GetRunt type GetRuntimeManagementConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_Invoke.go b/service/lambda/api_op_Invoke.go index f003fc2fbdf..37af2d17517 100644 --- a/service/lambda/api_op_Invoke.go +++ b/service/lambda/api_op_Invoke.go @@ -15,38 +15,48 @@ import ( // for the response), or asynchronously. By default, Lambda invokes your function // synchronously (i.e. the InvocationType is RequestResponse ). To invoke a // function asynchronously, set InvocationType to Event . Lambda passes the -// ClientContext object to your function for synchronous invocations only. 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) . +// ClientContext object to your function for synchronous invocations only. +// +// For [synchronous invocation], 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]and [trace]. +// // 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 +// executes the function up to two more times. For more information, see [Error handling and automatic retries in Lambda]. +// +// For [asynchronous invocation], 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]. +// +// 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 -// 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) -// . +// permissions errors, [quota]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 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] action. For details on how to set +// up permissions for cross-account invocations, see [Granting function access to other accounts]. +// +// [execution log]: https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions.html +// [asynchronous invocation]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html +// [trace]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html +// [dead-letter queue]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq +// [Error handling and automatic retries in Lambda]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-retries.html +// [lambda:InvokeFunction]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html +// [quota]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html +// [synchronous invocation]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html +// [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{} @@ -64,10 +74,16 @@ func (c *Client) Invoke(ctx context.Context, params *InvokeInput, optFns ...func type InvokeInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -81,12 +97,15 @@ 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. InvocationType types.InvocationType @@ -95,9 +114,10 @@ type InvokeInput struct { // synchronously invoked functions only. 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 . + // 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 . 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 61b5851c6cc..98af3998ee6 100644 --- a/service/lambda/api_op_InvokeAsync.go +++ b/service/lambda/api_op_InvokeAsync.go @@ -11,10 +11,13 @@ import ( "io" ) -// For asynchronous function invocation, use Invoke . Invokes a function -// asynchronously. If you do use the InvokeAsync action, note that it doesn't -// support the use of X-Ray active tracing. Trace ID is not propagated to the -// function, even if X-Ray active tracing is turned on. +// For asynchronous function invocation, use Invoke. +// +// Invokes a function asynchronously. +// +// If you do use the InvokeAsync action, note that it doesn't support the use of +// X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray +// active tracing is turned on. // // Deprecated: This operation has been deprecated. func (c *Client) InvokeAsync(ctx context.Context, params *InvokeAsyncInput, optFns ...func(*Options)) (*InvokeAsyncOutput, error) { @@ -34,10 +37,16 @@ func (c *Client) InvokeAsync(ctx context.Context, params *InvokeAsyncInput, optF type InvokeAsyncInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_InvokeWithResponseStream.go b/service/lambda/api_op_InvokeWithResponseStream.go index b25877125a8..34cc6475ce1 100644 --- a/service/lambda/api_op_InvokeWithResponseStream.go +++ b/service/lambda/api_op_InvokeWithResponseStream.go @@ -13,11 +13,14 @@ import ( ) // 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) -// . 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) -// . +// For more information, see [Configuring a Lambda function to stream responses]. +// +// This operation requires permission for the [lambda:InvokeFunction] action. For details on how to set +// up permissions for cross-account invocations, see [Granting function access to other accounts]. +// +// [Configuring a Lambda function to stream responses]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html +// [lambda:InvokeFunction]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html +// [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) InvokeWithResponseStream(ctx context.Context, params *InvokeWithResponseStreamInput, optFns ...func(*Options)) (*InvokeWithResponseStreamOutput, error) { if params == nil { params = &InvokeWithResponseStreamInput{} @@ -35,10 +38,16 @@ func (c *Client) InvokeWithResponseStream(ctx context.Context, params *InvokeWit type InvokeWithResponseStreamInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -50,9 +59,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. InvocationType types.ResponseStreamingInvocationType @@ -61,9 +72,10 @@ type InvokeWithResponseStreamInput struct { // synchronously invoked functions only. 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 . + // 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 . Payload []byte // The alias name. diff --git a/service/lambda/api_op_ListAliases.go b/service/lambda/api_op_ListAliases.go index feeb3e78678..00bd794bbe9 100644 --- a/service/lambda/api_op_ListAliases.go +++ b/service/lambda/api_op_ListAliases.go @@ -11,8 +11,9 @@ 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] for a Lambda function. +// +// [aliases]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error) { if params == nil { params = &ListAliasesInput{} @@ -30,10 +31,16 @@ func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optF type ListAliasesInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_ListCodeSigningConfigs.go b/service/lambda/api_op_ListCodeSigningConfigs.go index b2e4369b75e..02b050767b3 100644 --- a/service/lambda/api_op_ListCodeSigningConfigs.go +++ b/service/lambda/api_op_ListCodeSigningConfigs.go @@ -11,9 +11,10 @@ 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]. A request returns up to 10,000 configurations per call. You +// can use the MaxItems parameter to return fewer configurations per call. +// +// [code signing configurations]: https://docs.aws.amazon.com/lambda/latest/dg/configuring-codesigning.html 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 11afd14472f..338ac677395 100644 --- a/service/lambda/api_op_ListEventSourceMappings.go +++ b/service/lambda/api_op_ListEventSourceMappings.go @@ -31,22 +31,36 @@ 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 or the - // ARN of the VPC connection (for cross-account event source mappings (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc) - // ). + // ARN of the VPC connection (for [cross-account event source mappings]). + // // - Amazon MQ – The ARN of the broker. + // // - Amazon DocumentDB – The ARN of the DocumentDB change stream. + // + // [cross-account event source mappings]: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc EventSourceArn *string - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. FunctionName *string diff --git a/service/lambda/api_op_ListFunctionEventInvokeConfigs.go b/service/lambda/api_op_ListFunctionEventInvokeConfigs.go index 7a5fdae6034..e34f03c24cd 100644 --- a/service/lambda/api_op_ListFunctionEventInvokeConfigs.go +++ b/service/lambda/api_op_ListFunctionEventInvokeConfigs.go @@ -12,8 +12,8 @@ import ( ) // Retrieves a list of configurations for asynchronous invocation for a function. -// To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig . +// +// To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. func (c *Client) ListFunctionEventInvokeConfigs(ctx context.Context, params *ListFunctionEventInvokeConfigsInput, optFns ...func(*Options)) (*ListFunctionEventInvokeConfigsOutput, error) { if params == nil { params = &ListFunctionEventInvokeConfigsInput{} @@ -31,10 +31,16 @@ func (c *Client) ListFunctionEventInvokeConfigs(ctx context.Context, params *Lis type ListFunctionEventInvokeConfigsInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_ListFunctionUrlConfigs.go b/service/lambda/api_op_ListFunctionUrlConfigs.go index 904678eaa5c..cfffc2be5b3 100644 --- a/service/lambda/api_op_ListFunctionUrlConfigs.go +++ b/service/lambda/api_op_ListFunctionUrlConfigs.go @@ -29,10 +29,16 @@ func (c *Client) ListFunctionUrlConfigs(ctx context.Context, params *ListFunctio type ListFunctionUrlConfigsInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_ListFunctions.go b/service/lambda/api_op_ListFunctions.go index 8faf302b685..8c2c0ef5075 100644 --- a/service/lambda/api_op_ListFunctions.go +++ b/service/lambda/api_op_ListFunctions.go @@ -12,13 +12,15 @@ import ( ) // Returns a list of Lambda functions, with the version-specific configuration of -// each. Lambda returns up to 50 functions per call. Set FunctionVersion to ALL to -// include all published versions of each function in addition to the unpublished -// version. The ListFunctions operation returns a subset of the -// FunctionConfiguration fields. To get the additional fields (State, -// StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, -// LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use -// GetFunction . +// each. Lambda returns up to 50 functions per call. +// +// Set FunctionVersion to ALL to include all published versions of each function +// in addition to the unpublished version. +// +// The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the +// additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, +// LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a +// function or version, use GetFunction. func (c *Client) ListFunctions(ctx context.Context, params *ListFunctionsInput, optFns ...func(*Options)) (*ListFunctionsOutput, error) { if params == nil { params = &ListFunctionsInput{} diff --git a/service/lambda/api_op_ListLayerVersions.go b/service/lambda/api_op_ListLayerVersions.go index acc8e743ffb..27a13684e60 100644 --- a/service/lambda/api_op_ListLayerVersions.go +++ b/service/lambda/api_op_ListLayerVersions.go @@ -11,11 +11,13 @@ 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]. Versions that have been deleted aren't listed. +// Specify a [runtime identifier]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. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html +// [runtime identifier]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html func (c *Client) ListLayerVersions(ctx context.Context, params *ListLayerVersionsInput, optFns ...func(*Options)) (*ListLayerVersionsOutput, error) { if params == nil { params = &ListLayerVersionsInput{} @@ -38,13 +40,16 @@ 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]. + // + // [instruction set architecture]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html CompatibleArchitecture types.Architecture - // A runtime identifier. For example, java21 . 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) - // . + // A runtime identifier. For example, java21 . + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy 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 7d5f17aba43..f7480a715fb 100644 --- a/service/lambda/api_op_ListLayers.go +++ b/service/lambda/api_op_ListLayers.go @@ -11,13 +11,14 @@ 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. +// Lists [Lambda layers] and shows information about the latest version of each. Specify a [runtime identifier] 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) -// . +// with that [instruction set architecture]. +// +// [instruction set architecture]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html +// [runtime identifier]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html +// [Lambda layers]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html func (c *Client) ListLayers(ctx context.Context, params *ListLayersInput, optFns ...func(*Options)) (*ListLayersOutput, error) { if params == nil { params = &ListLayersInput{} @@ -35,13 +36,16 @@ 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]. + // + // [instruction set architecture]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html CompatibleArchitecture types.Architecture - // A runtime identifier. For example, java21 . 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) - // . + // A runtime identifier. For example, java21 . + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy 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 78944a89dcc..7cd2d58b161 100644 --- a/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go +++ b/service/lambda/api_op_ListProvisionedConcurrencyConfigs.go @@ -29,10 +29,16 @@ func (c *Client) ListProvisionedConcurrencyConfigs(ctx context.Context, params * type ListProvisionedConcurrencyConfigsInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_ListTags.go b/service/lambda/api_op_ListTags.go index e35b46d3fb2..d98be44ba24 100644 --- a/service/lambda/api_op_ListTags.go +++ b/service/lambda/api_op_ListTags.go @@ -10,8 +10,9 @@ 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]. You can also view tags with GetFunction. +// +// [tags]: https://docs.aws.amazon.com/lambda/latest/dg/tagging.html 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 f31b0b1a445..b18824d4eae 100644 --- a/service/lambda/api_op_ListVersionsByFunction.go +++ b/service/lambda/api_op_ListVersionsByFunction.go @@ -11,9 +11,10 @@ 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], with the version-specific configuration of each. Lambda +// returns up to 50 versions per call. +// +// [versions]: https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html func (c *Client) ListVersionsByFunction(ctx context.Context, params *ListVersionsByFunctionInput, optFns ...func(*Options)) (*ListVersionsByFunctionOutput, error) { if params == nil { params = &ListVersionsByFunctionInput{} @@ -31,10 +32,16 @@ func (c *Client) ListVersionsByFunction(ctx context.Context, params *ListVersion type ListVersionsByFunctionInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_PublishLayerVersion.go b/service/lambda/api_op_PublishLayerVersion.go index 1bff9381a09..f5104f53016 100644 --- a/service/lambda/api_op_PublishLayerVersion.go +++ b/service/lambda/api_op_PublishLayerVersion.go @@ -11,10 +11,12 @@ 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] 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. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html func (c *Client) PublishLayerVersion(ctx context.Context, params *PublishLayerVersionInput, optFns ...func(*Options)) (*PublishLayerVersionOutput, error) { if params == nil { params = &PublishLayerVersionInput{} @@ -42,25 +44,32 @@ 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]. + // + // [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 . 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) - // . + // A list of compatible [function runtimes]. Used for filtering with ListLayers and ListLayerVersions. + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [function runtimes]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy 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 . + // + // - An [SPDX license identifier]. 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. + // + // [SPDX license identifier]: https://spdx.org/licenses/ LicenseInfo *string noSmithyDocumentSerde @@ -68,20 +77,24 @@ 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]. + // + // [instruction set architectures]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html CompatibleArchitectures []types.Architecture - // The layer's compatible runtimes. 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 layer's compatible runtimes. + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy CompatibleRuntimes []types.Runtime // 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime CreatedDate *string // The description of the version. diff --git a/service/lambda/api_op_PublishVersion.go b/service/lambda/api_op_PublishVersion.go index 2a13d99e1ac..decf48e88d4 100644 --- a/service/lambda/api_op_PublishVersion.go +++ b/service/lambda/api_op_PublishVersion.go @@ -11,14 +11,17 @@ 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] 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 UpdateFunctionCodeor UpdateFunctionConfiguration to update the function before +// publishing a version. +// +// Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias. +// +// [version]: https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html func (c *Client) PublishVersion(ctx context.Context, params *PublishVersionInput, optFns ...func(*Options)) (*PublishVersionOutput, error) { if params == nil { params = &PublishVersionInput{} @@ -36,10 +39,16 @@ func (c *Client) PublishVersion(ctx context.Context, params *PublishVersionInput type PublishVersionInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -49,7 +58,7 @@ type PublishVersionInput struct { // 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 . + // uploaded from the output of UpdateFunctionCode. CodeSha256 *string // A description for the version to override the description in the function @@ -84,18 +93,20 @@ 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]. Omitted from CloudTrail logs. + // + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Environment *types.EnvironmentResponse // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage 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]. + // + // [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). @@ -110,14 +121,18 @@ 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]. When [Lambda SnapStart] 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. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // The date and time that the function was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModified *string // The status of the last update that was performed on the function. This is first @@ -130,8 +145,9 @@ 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]. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []types.Layer // The function's Amazon CloudWatch Logs configuration settings. @@ -153,11 +169,13 @@ type PublishVersionOutput struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy Runtime types.Runtime // The ARN of the runtime and any errors that occured. @@ -171,8 +189,9 @@ 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]. + // + // [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 diff --git a/service/lambda/api_op_PutFunctionCodeSigningConfig.go b/service/lambda/api_op_PutFunctionCodeSigningConfig.go index d31b0150d82..51b20df4076 100644 --- a/service/lambda/api_op_PutFunctionCodeSigningConfig.go +++ b/service/lambda/api_op_PutFunctionCodeSigningConfig.go @@ -35,10 +35,16 @@ type PutFunctionCodeSigningConfigInput struct { // This member is required. CodeSigningConfigArn *string - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -55,10 +61,16 @@ type PutFunctionCodeSigningConfigOutput struct { // This member is required. CodeSigningConfigArn *string - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // diff --git a/service/lambda/api_op_PutFunctionConcurrency.go b/service/lambda/api_op_PutFunctionConcurrency.go index 27d3273bd4f..607bac95329 100644 --- a/service/lambda/api_op_PutFunctionConcurrency.go +++ b/service/lambda/api_op_PutFunctionConcurrency.go @@ -11,16 +11,20 @@ import ( ) // Sets the maximum number of simultaneous executions for a function, and reserves -// capacity for that concurrency level. Concurrency settings apply to the function -// as a whole, including all published versions and the unpublished version. -// Reserving concurrency both ensures that your function has capacity to process -// the specified number of events simultaneously, and prevents it from scaling -// beyond that level. Use GetFunction to see the current setting for a function. -// 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) -// . +// capacity for that concurrency level. +// +// Concurrency settings apply to the function as a whole, including all published +// versions and the unpublished version. Reserving concurrency both ensures that +// your function has capacity to process the specified number of events +// simultaneously, and prevents it from scaling beyond that level. Use GetFunctionto see the +// current setting for a function. +// +// 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]. +// +// [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{} @@ -38,10 +42,16 @@ func (c *Client) PutFunctionConcurrency(ctx context.Context, params *PutFunction type PutFunctionConcurrencyInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -59,8 +69,9 @@ 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]. + // + // [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 f9f421ec92d..a981017dbad 100644 --- a/service/lambda/api_op_PutFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_PutFunctionEventInvokeConfig.go @@ -12,20 +12,24 @@ 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 +// Configures options for [asynchronous invocation] 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]. 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. +// +// [asynchronous invocation]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html +// [destination]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations func (c *Client) PutFunctionEventInvokeConfig(ctx context.Context, params *PutFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*PutFunctionEventInvokeConfigOutput, error) { if params == nil { params = &PutFunctionEventInvokeConfigInput{} @@ -43,10 +47,16 @@ func (c *Client) PutFunctionEventInvokeConfig(ctx context.Context, params *PutFu type PutFunctionEventInvokeConfigInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -54,11 +64,16 @@ type PutFunctionEventInvokeConfigInput struct { // This member is required. FunctionName *string - // A destination for events after they have been sent to a function for - // processing. Destinations + // 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 @@ -76,11 +91,16 @@ type PutFunctionEventInvokeConfigInput struct { type PutFunctionEventInvokeConfigOutput struct { - // A destination for events after they have been sent to a function for - // processing. Destinations + // 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 diff --git a/service/lambda/api_op_PutProvisionedConcurrencyConfig.go b/service/lambda/api_op_PutProvisionedConcurrencyConfig.go index b94a1984a78..876e4ae01a2 100644 --- a/service/lambda/api_op_PutProvisionedConcurrencyConfig.go +++ b/service/lambda/api_op_PutProvisionedConcurrencyConfig.go @@ -29,10 +29,16 @@ func (c *Client) PutProvisionedConcurrencyConfig(ctx context.Context, params *Pu type PutProvisionedConcurrencyConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -62,8 +68,9 @@ 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]. + // + // [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 27764f429e9..2faaf3e4081 100644 --- a/service/lambda/api_op_PutRuntimeManagementConfig.go +++ b/service/lambda/api_op_PutRuntimeManagementConfig.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -31,10 +32,16 @@ func (c *Client) PutRuntimeManagementConfig(ctx context.Context, params *PutRunt type PutRuntimeManagementConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -42,22 +49,26 @@ type PutRuntimeManagementConfigInput struct { 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. + // version using a [Two-phase runtime version rollout]. 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) - // . + // see [Roll back a runtime version]. + // + // [Two-phase runtime version rollout]: https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase + // [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 @@ -67,8 +78,9 @@ type PutRuntimeManagementConfigInput struct { // returned. Qualifier *string - // The ARN of the runtime version you want the function to use. This is only - // required if you're using the Manual runtime update mode. + // The ARN of the runtime version you want the function to use. + // + // This is only required if you're using the Manual runtime update mode. RuntimeVersionArn *string noSmithyDocumentSerde diff --git a/service/lambda/api_op_RemoveLayerVersionPermission.go b/service/lambda/api_op_RemoveLayerVersionPermission.go index e2b6bb11698..c0310b0565b 100644 --- a/service/lambda/api_op_RemoveLayerVersionPermission.go +++ b/service/lambda/api_op_RemoveLayerVersionPermission.go @@ -10,8 +10,10 @@ 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]. For more +// information, see AddLayerVersionPermission. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html 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 3060c1d2d66..2ff2e9ff5ce 100644 --- a/service/lambda/api_op_RemovePermission.go +++ b/service/lambda/api_op_RemovePermission.go @@ -11,8 +11,7 @@ import ( ) // 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 . +// 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{} @@ -30,10 +29,16 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI type RemovePermissionInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. diff --git a/service/lambda/api_op_TagResource.go b/service/lambda/api_op_TagResource.go index 03361c65f6d..72261e7955c 100644 --- a/service/lambda/api_op_TagResource.go +++ b/service/lambda/api_op_TagResource.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to a -// function. +// Adds [tags] to a function. +// +// [tags]: https://docs.aws.amazon.com/lambda/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/lambda/api_op_UntagResource.go b/service/lambda/api_op_UntagResource.go index 93ba386a8e3..da35771abbd 100644 --- a/service/lambda/api_op_UntagResource.go +++ b/service/lambda/api_op_UntagResource.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) from a -// function. +// Removes [tags] from a function. +// +// [tags]: https://docs.aws.amazon.com/lambda/latest/dg/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/lambda/api_op_UpdateAlias.go b/service/lambda/api_op_UpdateAlias.go index 02f7e146f3c..5b381888581 100644 --- a/service/lambda/api_op_UpdateAlias.go +++ b/service/lambda/api_op_UpdateAlias.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} @@ -30,10 +31,16 @@ func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optF type UpdateAliasInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -55,15 +62,17 @@ 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) - // of the alias. + // The [routing configuration] of the alias. + // + // [routing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing 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]. +// +// [alias]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html type UpdateAliasOutput struct { // The Amazon Resource Name (ARN) of the alias. @@ -81,8 +90,9 @@ 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) - // of the alias. + // The [routing configuration] of the alias. + // + // [routing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html RoutingConfig *types.AliasRoutingConfiguration // Metadata pertaining to the operation's result. diff --git a/service/lambda/api_op_UpdateEventSourceMapping.go b/service/lambda/api_op_UpdateEventSourceMapping.go index 90d0ec6866b..df409efc9b9 100644 --- a/service/lambda/api_op_UpdateEventSourceMapping.go +++ b/service/lambda/api_op_UpdateEventSourceMapping.go @@ -13,41 +13,69 @@ import ( ) // Updates an event source mapping. You can change the function that Lambda -// invokes, or pause invocation and resume later from the same location. For -// details about how to configure different event sources, see the following +// 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] +// +// [Amazon Kinesis] +// +// [Amazon SQS] +// +// [Amazon MQ and RabbitMQ] +// +// [Amazon MSK] +// +// [Apache Kafka] +// +// [Amazon DocumentDB] // // 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) +// +// [Amazon DynamoDB Streams] +// +// [Amazon Kinesis] +// +// [Amazon SQS] +// +// [Amazon MQ and RabbitMQ] +// +// [Amazon MSK] +// +// [Apache Kafka] +// +// [Amazon DocumentDB] +// +// [Amazon DynamoDB Streams]: https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params +// [Amazon SQS]: https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params +// [Amazon MSK]: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms +// [Amazon Kinesis]: https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params +// [Amazon MQ and RabbitMQ]: https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params +// [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{} @@ -74,13 +102,20 @@ 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. BatchSize *int32 @@ -97,20 +132,30 @@ type UpdateEventSourceMappingInput struct { DocumentDBEventSourceConfig *types.DocumentDBEventSourceConfig // When true, the event source mapping is active. When false, Lambda pauses - // polling and invocation. Default: True + // 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]. + // + // [Lambda event filtering]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html FilterCriteria *types.FilterCriteria - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. FunctionName *string @@ -121,16 +166,18 @@ type UpdateEventSourceMappingInput struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified @@ -147,8 +194,9 @@ 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]. + // + // [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 @@ -164,7 +212,7 @@ 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 @@ -174,10 +222,13 @@ type UpdateEventSourceMappingOutput struct { // 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). Default value: Varies by service. For Amazon SQS, the default - // is 10. For all other services, the default is 100. Related setting: When you set - // BatchSize to a value greater than 10, you must set - // MaximumBatchingWindowInSeconds to at least 1. + // invocation (6 MB). + // + // Default value: Varies by service. For Amazon SQS, the default is 10. For all + // other services, the default is 100. + // + // Related setting: When you set BatchSize to a value greater than 10, you must + // set MaximumBatchingWindowInSeconds to at least 1. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -196,8 +247,9 @@ 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]. + // + // [Lambda event filtering]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html FilterCriteria *types.FilterCriteria // The ARN of the Lambda function. @@ -216,23 +268,27 @@ type UpdateEventSourceMappingOutput struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified // age. The default value is -1, which sets the maximum age to infinite. When the - // value is set to infinite, Lambda never discards old records. The minimum valid - // value for maximum record age is 60s. Although values less than 60 and greater - // than -1 fall within the parameter's absolute range, they are not allowed + // value is set to infinite, Lambda never discards old records. + // + // The minimum valid value for maximum record age is 60s. Although values less + // than 60 and greater than -1 fall within the parameter's absolute range, they are + // not allowed MaximumRecordAgeInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records after the specified number @@ -245,12 +301,13 @@ type UpdateEventSourceMappingOutput struct { // concurrently from each shard. The default value is 1. ParallelizationFactor *int32 - // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. + // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. 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]. + // + // [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. diff --git a/service/lambda/api_op_UpdateFunctionCode.go b/service/lambda/api_op_UpdateFunctionCode.go index 359c62a2b5a..a2304269bf8 100644 --- a/service/lambda/api_op_UpdateFunctionCode.go +++ b/service/lambda/api_op_UpdateFunctionCode.go @@ -13,19 +13,28 @@ 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 -// deployment package must be compatible with the target instruction set -// 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 -// the image tag to a new image, Lambda does not automatically update the function. +// see [Configuring code signing for Lambda]. +// +// If the function's package type is Image , then you must specify the code package +// in ImageUri as the URI of a [container image] 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]. 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 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 the image tag to a new image, +// Lambda does not automatically update the function. +// +// [.zip file archive]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip +// [Configuring code signing for Lambda]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html +// [container image]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html func (c *Client) UpdateFunctionCode(ctx context.Context, params *UpdateFunctionCodeInput, optFns ...func(*Options)) (*UpdateFunctionCodeOutput, error) { if params == nil { params = &UpdateFunctionCodeInput{} @@ -43,10 +52,16 @@ func (c *Client) UpdateFunctionCode(ctx context.Context, params *UpdateFunctionC type UpdateFunctionCodeInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -67,7 +82,7 @@ type UpdateFunctionCodeInput struct { ImageUri *string // Set to true to publish a new version of the function after updating the code. - // This has the same effect as calling PublishVersion separately. + // This has the same effect as calling PublishVersionseparately. Publish bool // Update the function only if the revision ID matches the ID that's specified. @@ -115,18 +130,20 @@ 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]. Omitted from CloudTrail logs. + // + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Environment *types.EnvironmentResponse // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage 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]. + // + // [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). @@ -141,14 +158,18 @@ 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]. When [Lambda SnapStart] 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. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // The date and time that the function was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModified *string // The status of the last update that was performed on the function. This is first @@ -161,8 +182,9 @@ 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]. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []types.Layer // The function's Amazon CloudWatch Logs configuration settings. @@ -184,11 +206,13 @@ type UpdateFunctionCodeOutput struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy Runtime types.Runtime // The ARN of the runtime and any errors that occured. @@ -202,8 +226,9 @@ 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]. + // + // [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 diff --git a/service/lambda/api_op_UpdateFunctionConfiguration.go b/service/lambda/api_op_UpdateFunctionConfiguration.go index 2efa1fe6949..3dbd952fde4 100644 --- a/service/lambda/api_op_UpdateFunctionConfiguration.go +++ b/service/lambda/api_op_UpdateFunctionConfiguration.go @@ -11,19 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modify the version-specific settings of a Lambda function. When you update 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. -// 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 +// Modify the version-specific settings of a Lambda function. +// +// When you update 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. 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]. +// +// 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 . +// 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. +// +// [Lambda function states]: https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html func (c *Client) UpdateFunctionConfiguration(ctx context.Context, params *UpdateFunctionConfigurationInput, optFns ...func(*Options)) (*UpdateFunctionConfigurationOutput, error) { if params == nil { params = &UpdateFunctionConfigurationInput{} @@ -41,10 +46,16 @@ func (c *Client) UpdateFunctionConfiguration(ctx context.Context, params *Update type UpdateFunctionConfigurationInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -53,8 +64,9 @@ type UpdateFunctionConfigurationInput struct { // 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) - // . + // information, see [Dead-letter queues]. + // + // [Dead-letter queues]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq DeadLetterConfig *types.DeadLetterConfig // A description of the function. @@ -64,9 +76,9 @@ type UpdateFunctionConfigurationInput struct { Environment *types.Environment // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage EphemeralStorage *types.EphemeralStorage // Connection settings for an Amazon EFS file system. @@ -75,36 +87,42 @@ 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]. + // + // [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-create.html#images-parms) - // that override the values in the container image Docker file. + // [Container image configuration values] that override the values in the container image Docker file. + // + // [Container image configuration values]: https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms 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, Lambda also uses this key is to encrypt your function's snapshot. - // If you deploy your function using a container image, Lambda also uses this key - // to encrypt your function when it's deployed. Note that this is not the same key - // that's used to protect your container image in the Amazon Elastic Container - // Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses - // a default service key. + // encrypt your function's [environment variables]. When [Lambda SnapStart] is activated, Lambda also uses this key is to + // encrypt your function's snapshot. If you deploy your function using a container + // image, Lambda also uses this key to encrypt your function when it's deployed. + // Note that this is not the same key that's used to protect your container image + // in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a + // customer managed key, Lambda uses a default service key. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption 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, - // including the version. + // A list of [function layers] to add to the function's execution environment. Specify each layer + // by its ARN, including the version. + // + // [function layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []string // The function's Amazon CloudWatch Logs configuration settings. LoggingConfig *types.LoggingConfig - // 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. + // The amount of [memory available to the function] 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. + // + // [memory available to the function]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console MemorySize *int32 // Update the function only if the revision ID matches the ID that's specified. @@ -115,32 +133,38 @@ type UpdateFunctionConfigurationInput struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [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] setting. + // + // [SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html 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]. + // + // [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]. + // + // [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]. + // + // [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 @@ -166,18 +190,20 @@ 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]. Omitted from CloudTrail logs. + // + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Environment *types.EnvironmentResponse // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage 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]. + // + // [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). @@ -192,14 +218,18 @@ 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]. When [Lambda SnapStart] 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. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // The date and time that the function was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModified *string // The status of the last update that was performed on the function. This is first @@ -212,8 +242,9 @@ 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]. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []types.Layer // The function's Amazon CloudWatch Logs configuration settings. @@ -235,11 +266,13 @@ type UpdateFunctionConfigurationOutput struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy Runtime types.Runtime // The ARN of the runtime and any errors that occured. @@ -253,8 +286,9 @@ 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]. + // + // [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 diff --git a/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go b/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go index eb90cbde57c..9b1974a4ef6 100644 --- a/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go +++ b/service/lambda/api_op_UpdateFunctionEventInvokeConfig.go @@ -13,8 +13,9 @@ import ( ) // Updates the configuration for asynchronous invocation for a function, version, -// or alias. To configure options for asynchronous invocation, use -// PutFunctionEventInvokeConfig . +// or alias. +// +// To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. func (c *Client) UpdateFunctionEventInvokeConfig(ctx context.Context, params *UpdateFunctionEventInvokeConfigInput, optFns ...func(*Options)) (*UpdateFunctionEventInvokeConfigOutput, error) { if params == nil { params = &UpdateFunctionEventInvokeConfigInput{} @@ -32,10 +33,16 @@ func (c *Client) UpdateFunctionEventInvokeConfig(ctx context.Context, params *Up type UpdateFunctionEventInvokeConfigInput struct { - // The name or ARN of the Lambda function, version, or alias. Name formats + // The name or ARN 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. @@ -43,11 +50,16 @@ type UpdateFunctionEventInvokeConfigInput struct { // This member is required. FunctionName *string - // A destination for events after they have been sent to a function for - // processing. Destinations + // 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 @@ -65,11 +77,16 @@ type UpdateFunctionEventInvokeConfigInput struct { type UpdateFunctionEventInvokeConfigOutput struct { - // A destination for events after they have been sent to a function for - // processing. Destinations + // 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 diff --git a/service/lambda/api_op_UpdateFunctionUrlConfig.go b/service/lambda/api_op_UpdateFunctionUrlConfig.go index 85048729a99..333f9b39fdb 100644 --- a/service/lambda/api_op_UpdateFunctionUrlConfig.go +++ b/service/lambda/api_op_UpdateFunctionUrlConfig.go @@ -29,10 +29,16 @@ func (c *Client) UpdateFunctionUrlConfig(ctx context.Context, params *UpdateFunc type UpdateFunctionUrlConfigInput struct { - // The name or ARN of the Lambda function. Name formats + // The name or ARN 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. // @@ -42,23 +48,27 @@ 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]. + // + // [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)] settings for your function URL. + // + // [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // . + // operation. The maximum response payload size is 20 MB, however, you can [request a quota increase]. + // + // [request a quota increase]: https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html InvokeMode types.InvokeMode // The alias name. @@ -72,14 +82,16 @@ 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]. + // + // [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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime // // This member is required. CreationTime *string @@ -94,25 +106,30 @@ 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) + // When the function URL configuration was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime + // // 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)] settings for your function URL. + // + // [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // . + // operation. The maximum response payload size is 20 MB, however, you can [request a quota increase]. + // + // [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 552a69351d0..06419b64a93 100644 --- a/service/lambda/doc.go +++ b/service/lambda/doc.go @@ -3,39 +3,53 @@ // Package lambda provides the API client, operations, and parameter types for AWS // Lambda. // -// Lambda Overview Lambda is a compute service that lets you run code without -// provisioning or managing servers. Lambda runs your code on a high-availability -// compute infrastructure and performs all of the administration of the compute -// 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 -// 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: +// # Lambda +// +// # Overview +// +// Lambda is a compute service that lets you run code without provisioning or +// managing servers. Lambda runs your code on a high-availability compute +// infrastructure and performs all of the administration of the compute 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]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]. +// +// For a list of Region-specific endpoints that Lambda supports, see [Lambda endpoints and quotas] 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]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. @@ -43,12 +57,21 @@ // 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) +// Root certificates from the first two authorities are available from [Amazon trust services], 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.] +// +// [Amazon Web Services Certificate Manager FAQs.]: http://aws.amazon.com/certificate-manager/faqs/#certificates +// [What is Lambda]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html +// [Signature Version 4 signing process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [Amazon trust services]: https://www.amazontrust.com/repository/ +// [Lambda endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/lambda-service.html/ package lambda diff --git a/service/lambda/options.go b/service/lambda/options.go index e76e46c8a01..3b68f632e4c 100644 --- a/service/lambda/options.go +++ b/service/lambda/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lambda/types/enums.go b/service/lambda/types/enums.go index 1a240f6f5a0..0a89815d1e1 100644 --- a/service/lambda/types/enums.go +++ b/service/lambda/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ApplicationLogLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationLogLevel) Values() []ApplicationLogLevel { return []ApplicationLogLevel{ "TRACE", @@ -37,8 +38,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -55,8 +57,9 @@ const ( ) // Values returns all known values for CodeSigningPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodeSigningPolicy) Values() []CodeSigningPolicy { return []CodeSigningPolicy{ "Warn", @@ -72,8 +75,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -90,8 +94,9 @@ const ( ) // Values returns all known values for EventSourcePosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventSourcePosition) Values() []EventSourcePosition { return []EventSourcePosition{ "TRIM_HORIZON", @@ -109,8 +114,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -126,8 +132,9 @@ const ( ) // Values returns all known values for FunctionResponseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FunctionResponseType) Values() []FunctionResponseType { return []FunctionResponseType{ "ReportBatchItemFailures", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for FunctionUrlAuthType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FunctionUrlAuthType) Values() []FunctionUrlAuthType { return []FunctionUrlAuthType{ "NONE", @@ -160,8 +168,9 @@ const ( ) // Values returns all known values for FunctionVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FunctionVersion) Values() []FunctionVersion { return []FunctionVersion{ "ALL", @@ -178,8 +187,9 @@ const ( ) // Values returns all known values for InvocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvocationType) Values() []InvocationType { return []InvocationType{ "Event", @@ -197,8 +207,9 @@ const ( ) // Values returns all known values for InvokeMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvokeMode) Values() []InvokeMode { return []InvokeMode{ "BUFFERED", @@ -216,8 +227,9 @@ const ( ) // Values returns all known values for LastUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastUpdateStatus) Values() []LastUpdateStatus { return []LastUpdateStatus{ "Successful", @@ -255,6 +267,7 @@ const ( // Values returns all known values for LastUpdateStatusReasonCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LastUpdateStatusReasonCode) Values() []LastUpdateStatusReasonCode { return []LastUpdateStatusReasonCode{ @@ -291,8 +304,9 @@ const ( ) // 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. +// in the future, and so 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{ "JSON", @@ -309,8 +323,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "None", @@ -327,8 +342,9 @@ const ( ) // Values returns all known values for PackageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageType) Values() []PackageType { return []PackageType{ "Zip", @@ -347,8 +363,9 @@ const ( // Values returns all known values for ProvisionedConcurrencyStatusEnum. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedConcurrencyStatusEnum) Values() []ProvisionedConcurrencyStatusEnum { return []ProvisionedConcurrencyStatusEnum{ "IN_PROGRESS", @@ -367,8 +384,9 @@ const ( // Values returns all known values for ResponseStreamingInvocationType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResponseStreamingInvocationType) Values() []ResponseStreamingInvocationType { return []ResponseStreamingInvocationType{ "RequestResponse", @@ -421,8 +439,9 @@ const ( ) // Values returns all known values for Runtime. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Runtime) Values() []Runtime { return []Runtime{ "nodejs", @@ -475,8 +494,9 @@ const ( ) // Values returns all known values for SnapStartApplyOn. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapStartApplyOn) Values() []SnapStartApplyOn { return []SnapStartApplyOn{ "PublishedVersions", @@ -494,6 +514,7 @@ const ( // Values returns all known values for SnapStartOptimizationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SnapStartOptimizationStatus) Values() []SnapStartOptimizationStatus { return []SnapStartOptimizationStatus{ @@ -517,8 +538,9 @@ const ( ) // Values returns all known values for SourceAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceAccessType) Values() []SourceAccessType { return []SourceAccessType{ "BASIC_AUTH", @@ -543,8 +565,9 @@ const ( ) // 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. +// the future, and so 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{ "Pending", @@ -585,8 +608,9 @@ const ( ) // Values returns all known values for StateReasonCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StateReasonCode) Values() []StateReasonCode { return []StateReasonCode{ "Idle", @@ -626,8 +650,9 @@ const ( ) // Values returns all known values for SystemLogLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SystemLogLevel) Values() []SystemLogLevel { return []SystemLogLevel{ "DEBUG", @@ -649,8 +674,9 @@ const ( ) // Values returns all known values for ThrottleReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThrottleReason) Values() []ThrottleReason { return []ThrottleReason{ "ConcurrentInvocationLimitExceeded", @@ -671,8 +697,9 @@ const ( ) // Values returns all known values for TracingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TracingMode) Values() []TracingMode { return []TracingMode{ "Active", @@ -690,8 +717,9 @@ const ( ) // Values returns all known values for UpdateRuntimeOn. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateRuntimeOn) Values() []UpdateRuntimeOn { return []UpdateRuntimeOn{ "Auto", diff --git a/service/lambda/types/errors.go b/service/lambda/types/errors.go index 763eabc98ce..cc8bf04b628 100644 --- a/service/lambda/types/errors.go +++ b/service/lambda/types/errors.go @@ -38,8 +38,9 @@ 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]. +// +// [Lambda quotas]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html type CodeStorageExceededException struct { Message *string @@ -301,8 +302,9 @@ 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]. +// +// [Lambda quotas]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html type ENILimitReachedException struct { Message *string @@ -644,9 +646,10 @@ 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) +// The permissions policy for the resource is too large. For more information, see [Lambda quotas] // . +// +// [Lambda quotas]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html type PolicyLengthExceededException struct { Message *string @@ -764,8 +767,9 @@ func (e *RecursiveInvocationException) ErrorCode() string { func (e *RecursiveInvocationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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]. +// +// [Lambda quotas]: https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html type RequestTooLargeException struct { Message *string @@ -936,8 +940,10 @@ 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) -// encountered an error. For more information, check the Amazon CloudWatch logs. +// The afterRestore()[runtime hook] encountered an error. For more information, check the Amazon +// CloudWatch logs. +// +// [runtime hook]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-runtime-hooks.html type SnapStartException struct { Message *string @@ -965,9 +971,10 @@ 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) +// Lambda is initializing your function. You can invoke the function when the [function state] // becomes Active . +// +// [function state]: https://docs.aws.amazon.com/lambda/latest/dg/functions-states.html type SnapStartNotReadyException struct { Message *string @@ -1054,9 +1061,9 @@ func (e *SubnetIPAddressLimitReachedException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// 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) -// . +// The request throughput limit was exceeded. For more information, see [Lambda quotas]. +// +// [Lambda 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 100a38ca549..2233dd8f9bc 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,9 @@ 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]. +// +// [alias]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html type AliasConfiguration struct { // The Amazon Resource Name (ARN) of the alias. @@ -65,15 +66,17 @@ 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) - // of the alias. + // The [routing configuration] of the alias. + // + // [routing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html RoutingConfig *AliasRoutingConfiguration noSmithyDocumentSerde } -// The traffic-shifting (https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) -// configuration of a Lambda function alias. +// The [traffic-shifting] configuration of a Lambda function alias. +// +// [traffic-shifting]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html type AliasRoutingConfiguration struct { // The second version, and the percentage of traffic that's routed to it. @@ -101,15 +104,17 @@ 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]. + // + // [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]. +// +// [Code signing configuration]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html type CodeSigningConfig struct { // List of allowed publishers. @@ -145,14 +150,18 @@ type CodeSigningConfig struct { noSmithyDocumentSerde } -// 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. +// Code signing configuration [policies] specify the validation failure action for signature +// mismatch or expiry. +// +// [policies]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies 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 - // deployment and creates a CloudWatch log. Default value: Warn + // deployment and creates a CloudWatch log. + // + // Default value: Warn UntrustedArtifactOnDeployment CodeSigningPolicy noSmithyDocumentSerde @@ -161,17 +170,19 @@ 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]. + // + // [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)] 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. +// +// [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS type Cors struct { // Whether to allow cookies or other credentials in requests to your function URL. @@ -188,8 +199,10 @@ type Cors struct { // 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 ( * ). + // 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 @@ -204,8 +217,9 @@ type Cors struct { 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] for failed asynchronous invocations. +// +// [dead-letter queue]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq type DeadLetterConfig struct { // The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. @@ -230,14 +244,14 @@ 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 + // 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. + // The name of the database to consume within the DocumentDB cluster. DatabaseName *string - // Determines what DocumentDB sends to your event stream during document update + // Determines what DocumentDB sends to your event stream during document update // operations. If set to UpdateLookup, DocumentDB sends a delta describing the // changes, along with a copy of the entire document. Otherwise, DocumentDB sends // only a partial document that contains the changes. @@ -252,9 +266,9 @@ type DocumentDBEventSourceConfig struct { // 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 variable key-value pairs. For more information, see [Using Lambda environment variables]. + // + // [Using Lambda environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Variables map[string]string noSmithyDocumentSerde @@ -287,9 +301,9 @@ type EnvironmentResponse struct { } // The size of the function's /tmp directory in MB. The default value is 512, but -// can be any whole number between 512 and 10,240 MB. For more information, see -// Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) -// . +// can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. +// +// [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage type EphemeralStorage struct { // The size of the function's /tmp directory. @@ -301,7 +315,7 @@ 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 @@ -311,10 +325,13 @@ type EventSourceMappingConfiguration struct { // 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). Default value: Varies by service. For Amazon SQS, the default - // is 10. For all other services, the default is 100. Related setting: When you set - // BatchSize to a value greater than 10, you must set - // MaximumBatchingWindowInSeconds to at least 1. + // invocation (6 MB). + // + // Default value: Varies by service. For Amazon SQS, the default is 10. For all + // other services, the default is 100. + // + // Related setting: When you set BatchSize to a value greater than 10, you must + // set MaximumBatchingWindowInSeconds to at least 1. BatchSize *int32 // (Kinesis and DynamoDB Streams only) If the function returns an error, split the @@ -333,8 +350,9 @@ 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]. + // + // [Lambda event filtering]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html FilterCriteria *FilterCriteria // The ARN of the Lambda function. @@ -353,23 +371,27 @@ type EventSourceMappingConfiguration struct { // The maximum amount of time, in seconds, that Lambda spends gathering records // before invoking the function. You can configure MaximumBatchingWindowInSeconds - // to any value from 0 seconds to 300 seconds in increments of seconds. For streams - // and Amazon SQS event sources, the default batching window is 0 seconds. For - // Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, - // the default batching window is 500 ms. Note that because you can only change - // MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back - // to the 500 ms default batching window after you have changed it. To restore the - // default batching window, you must create a new event source mapping. Related - // setting: For streams and Amazon SQS event sources, when you set BatchSize to a - // value greater than 10, you must set MaximumBatchingWindowInSeconds to at least - // 1. + // to any value from 0 seconds to 300 seconds in increments of seconds. + // + // For streams and Amazon SQS event sources, the default batching window is 0 + // seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB + // event sources, the default batching window is 500 ms. Note that because you can + // only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot + // revert back to the 500 ms default batching window after you have changed it. To + // restore the default batching window, you must create a new event source mapping. + // + // Related setting: For streams and Amazon SQS event sources, when you set + // BatchSize to a value greater than 10, you must set + // MaximumBatchingWindowInSeconds to at least 1. MaximumBatchingWindowInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records older than the specified // age. The default value is -1, which sets the maximum age to infinite. When the - // value is set to infinite, Lambda never discards old records. The minimum valid - // value for maximum record age is 60s. Although values less than 60 and greater - // than -1 fall within the parameter's absolute range, they are not allowed + // value is set to infinite, Lambda never discards old records. + // + // The minimum valid value for maximum record age is 60s. Although values less + // than 60 and greater than -1 fall within the parameter's absolute range, they are + // not allowed MaximumRecordAgeInSeconds *int32 // (Kinesis and DynamoDB Streams only) Discard records after the specified number @@ -382,12 +404,13 @@ type EventSourceMappingConfiguration struct { // concurrently from each shard. The default value is 1. ParallelizationFactor *int32 - // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. + // (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. 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]. + // + // [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. @@ -432,9 +455,9 @@ type EventSourceMappingConfiguration struct { noSmithyDocumentSerde } -// 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) -// . +// Details about the connection between a Lambda function and an [Amazon EFS file system]. +// +// [Amazon EFS file 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 @@ -451,13 +474,15 @@ type FileSystemConfig struct { noSmithyDocumentSerde } -// A structure within a FilterCriteria object that defines an event filtering +// A structure within a FilterCriteria object that defines an event filtering +// // pattern. 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) + // A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax] // . + // + // [Filter rule syntax]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax Pattern *string noSmithyDocumentSerde @@ -466,7 +491,7 @@ type Filter struct { // An object that contains the filters for an event source. type FilterCriteria struct { - // A list of filters. + // A list of filters. Filters []Filter noSmithyDocumentSerde @@ -477,8 +502,9 @@ type FilterCriteria struct { // 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] in the Amazon ECR registry. + // + // [container image]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html ImageUri *string // An Amazon S3 bucket in the same Amazon Web Services Region as your function. @@ -536,18 +562,20 @@ 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]. Omitted from CloudTrail logs. + // + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html Environment *EnvironmentResponse // The size of the function's /tmp directory in MB. The default value is 512, but - // can be any whole number between 512 and 10,240 MB. For more information, see - // Configuring ephemeral storage (console) (https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage) - // . + // can be any whole number between 512 and 10,240 MB. For more information, see [Configuring ephemeral storage (console)]. + // + // [Configuring ephemeral storage (console)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-ephemeral-storage 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]. + // + // [Amazon EFS file system]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html FileSystemConfigs []FileSystemConfig // The function's Amazon Resource Name (ARN). @@ -562,14 +590,18 @@ 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]. When [Lambda SnapStart] 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. + // + // [Lambda SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html + // [environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption KMSKeyArn *string - // The date and time that the function was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) + // The date and time that the function was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModified *string // The status of the last update that was performed on the function. This is first @@ -582,8 +614,9 @@ 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]. + // + // [layers]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html Layers []Layer // The function's Amazon CloudWatch Logs configuration settings. @@ -605,11 +638,13 @@ type FunctionConfiguration struct { // 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]. 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]. + // + // [runtime]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy Runtime Runtime // The ARN of the runtime and any errors that occured. @@ -623,8 +658,9 @@ 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]. + // + // [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 @@ -656,11 +692,16 @@ type FunctionConfiguration struct { type FunctionEventInvokeConfig struct { - // A destination for events after they have been sent to a function for - // processing. Destinations + // 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 @@ -685,14 +726,16 @@ 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]. + // + // [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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime // // This member is required. CreationTime *string @@ -707,33 +750,39 @@ 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) + // When the function URL configuration was last updated, in [ISO-8601 format] // (YYYY-MM-DDThh:mm:ss.sTZD). // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime + // // 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)] settings for your function URL. + // + // [cross-origin resource sharing (CORS)]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 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) - // . + // operation. The maximum response payload size is 20 MB, however, you can [request a quota increase]. + // + // [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]. +// +// [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. @@ -829,8 +878,9 @@ type InvokeWithResponseStreamResponseEventMemberPayloadChunk struct { func (*InvokeWithResponseStreamResponseEventMemberPayloadChunk) isInvokeWithResponseStreamResponseEvent() { } -// An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) -// . +// An [Lambda layer]. +// +// [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. @@ -848,8 +898,9 @@ 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]. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html type LayersListItem struct { // The newest version of the layer. @@ -864,9 +915,10 @@ 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]. You can specify either an +// Amazon S3 location, or upload a layer archive directly. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html type LayerVersionContentInput struct { // The Amazon S3 bucket of the layer archive. @@ -885,8 +937,9 @@ 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]. +// +// [Lambda layer]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html type LayerVersionContentOutput struct { // The SHA-256 hash of the layer archive. @@ -907,17 +960,21 @@ 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]. +// +// [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]. + // + // [instruction set architectures]: https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html CompatibleArchitectures []Architecture - // The layer's compatible runtimes. 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 layer's compatible runtimes. + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy]. + // + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy CompatibleRuntimes []Runtime // The date that the version was created, in ISO 8601 format. For example, @@ -968,16 +1025,21 @@ type LoggingConfig struct { // A destination for events that failed processing. type OnFailure struct { - // The Amazon Resource Name (ARN) of the destination resource. To retain records - // of asynchronous invocations (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) - // , you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or - // Amazon EventBridge event bus as the destination. To retain records of failed - // invocations from Kinesis and DynamoDB event sources (https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations) - // , you can configure an Amazon SNS topic or Amazon SQS queue as the destination. - // To retain records of failed invocations from self-managed Kafka (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) - // or Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination) - // , you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket - // as the destination. + // The Amazon Resource Name (ARN) of the destination resource. + // + // To retain records of [asynchronous invocations], you can configure an Amazon SNS topic, Amazon SQS queue, + // Lambda function, or Amazon EventBridge event bus as the destination. + // + // To retain records of failed invocations from [Kinesis and DynamoDB event sources], you can configure an Amazon SNS + // topic or Amazon SQS queue as the destination. + // + // To retain records of failed invocations from [self-managed Kafka] or [Amazon MSK], you can configure an Amazon + // SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination. + // + // [Amazon MSK]: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination + // [Kinesis and DynamoDB event sources]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations + // [asynchronous invocations]: https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations + // [self-managed Kafka]: https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination Destination *string noSmithyDocumentSerde @@ -1007,8 +1069,9 @@ 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]. + // + // [ISO 8601 format]: https://www.iso.org/iso-8601-date-and-time-format.html LastModified *string // The amount of provisioned concurrency requested. @@ -1077,16 +1140,18 @@ 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]. + // + // [Customizable consumer group ID]: https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id ConsumerGroupId *string noSmithyDocumentSerde } -// The function's Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) -// setting. Set ApplyOn to PublishedVersions to create a snapshot of the -// initialized execution environment when you publish a function version. +// 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. +// +// [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 @@ -1096,17 +1161,19 @@ type SnapStart struct { noSmithyDocumentSerde } -// The function's SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) -// setting. +// The function's [SnapStart] setting. +// +// [SnapStart]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html type SnapStartResponse struct { // 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)], this response element indicates whether SnapStart is + // activated for the specified function version. + // + // [qualified Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using OptimizationStatus SnapStartOptimizationStatus noSmithyDocumentSerde @@ -1118,28 +1185,37 @@ 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. @@ -1152,9 +1228,10 @@ type SourceAccessConfiguration struct { 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] tracing configuration. To sample and record incoming requests, +// set Mode to Active . +// +// [X-Ray]: https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html type TracingConfig struct { // The tracing mode. @@ -1173,8 +1250,9 @@ 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]. +// +// [Configuring a Lambda function to access resources in a VPC]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html type VpcConfig struct { // Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack diff --git a/service/launchwizard/api_op_CreateDeployment.go b/service/launchwizard/api_op_CreateDeployment.go index aa3a9817d0d..8d469686739 100644 --- a/service/launchwizard/api_op_CreateDeployment.go +++ b/service/launchwizard/api_op_CreateDeployment.go @@ -31,8 +31,10 @@ func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentI type CreateDeploymentInput struct { // The name of the deployment pattern supported by a given workload. You can use - // the ListWorkloadDeploymentPatterns (https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html) - // operation to discover supported values for this parameter. + // the [ListWorkloadDeploymentPatterns]ListWorkloadDeploymentPatterns operation to discover supported values for + // this parameter. + // + // [ListWorkloadDeploymentPatterns]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html // // This member is required. DeploymentPatternName *string @@ -43,15 +45,18 @@ type CreateDeploymentInput struct { Name *string // The settings specified for the deployment. For more information on the - // specifications required for creating a deployment, see Workload specifications (https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html) - // . + // specifications required for creating a deployment, see [Workload specifications]. + // + // [Workload specifications]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html // // This member is required. Specifications map[string]string - // The name of the workload. You can use the ListWorkloadDeploymentPatterns (https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html) + // The name of the workload. You can use the [ListWorkloadDeploymentPatterns]ListWorkloadDeploymentPatterns // operation to discover supported values for this parameter. // + // [ListWorkloadDeploymentPatterns]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_ListWorkloadDeploymentPatterns.html + // // This member is required. WorkloadName *string diff --git a/service/launchwizard/api_op_ListDeployments.go b/service/launchwizard/api_op_ListDeployments.go index ccce8aed4de..e183907430b 100644 --- a/service/launchwizard/api_op_ListDeployments.go +++ b/service/launchwizard/api_op_ListDeployments.go @@ -30,7 +30,9 @@ func (c *Client) ListDeployments(ctx context.Context, params *ListDeploymentsInp type ListDeploymentsInput struct { // Filters to scope the results. The following filters are supported: + // // - WORKLOAD_NAME + // // - DEPLOYMENT_STATUS Filters []types.DeploymentFilter diff --git a/service/launchwizard/options.go b/service/launchwizard/options.go index a41eb676711..b47528402be 100644 --- a/service/launchwizard/options.go +++ b/service/launchwizard/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/launchwizard/types/enums.go b/service/launchwizard/types/enums.go index 2ec3573ee29..22866ff66b0 100644 --- a/service/launchwizard/types/enums.go +++ b/service/launchwizard/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for DeploymentFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentFilterKey) Values() []DeploymentFilterKey { return []DeploymentFilterKey{ "WORKLOAD_NAME", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "COMPLETED", @@ -67,8 +69,9 @@ const ( ) // Values returns all known values for EventStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventStatus) Values() []EventStatus { return []EventStatus{ "CANCELED", @@ -94,8 +97,9 @@ const ( // Values returns all known values for WorkloadDeploymentPatternStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkloadDeploymentPatternStatus) Values() []WorkloadDeploymentPatternStatus { return []WorkloadDeploymentPatternStatus{ "ACTIVE", @@ -116,8 +120,9 @@ const ( ) // Values returns all known values for WorkloadStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkloadStatus) Values() []WorkloadStatus { return []WorkloadStatus{ "ACTIVE", diff --git a/service/launchwizard/types/errors.go b/service/launchwizard/types/errors.go index 07e0030d176..23ad9975145 100644 --- a/service/launchwizard/types/errors.go +++ b/service/launchwizard/types/errors.go @@ -8,8 +8,9 @@ import ( ) // An internal error has occurred. Retry your request, but if the problem -// persists, contact us with details by posting a question on re:Post (https://repost.aws/) -// . +// persists, contact us with details by posting a question on [re:Post]. +// +// [re:Post]: https://repost.aws/ type InternalServerException struct { Message *string diff --git a/service/launchwizard/types/types.go b/service/launchwizard/types/types.go index b1b45969484..8354444cc17 100644 --- a/service/launchwizard/types/types.go +++ b/service/launchwizard/types/types.go @@ -29,8 +29,9 @@ type DeploymentData struct { ResourceGroup *string // The specifications of the deployment. For more information on specifications - // for each deployment, see Workload specifications (https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html) - // . + // for each deployment, see [Workload specifications]. + // + // [Workload specifications]: https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications.html Specifications map[string]string // The status of the deployment. diff --git a/service/lexmodelbuildingservice/api_op_CreateBotVersion.go b/service/lexmodelbuildingservice/api_op_CreateBotVersion.go index 8eb02193050..86089ad1d3a 100644 --- a/service/lexmodelbuildingservice/api_op_CreateBotVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateBotVersion.go @@ -15,11 +15,14 @@ import ( // Creates a new version of the bot based on the $LATEST version. If the $LATEST // version of this resource hasn't changed since you created the last version, // Amazon Lex doesn't create a new version. It returns the last created version. +// // 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 -// operation requires permission for the lex:CreateBotVersion action. +// 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 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 { params = &CreateBotVersionInput{} @@ -56,7 +59,7 @@ type CreateBotVersionInput struct { type CreateBotVersionOutput struct { // The message that Amazon Lex uses to cancel a conversation. For more - // information, see PutBot . + // information, see PutBot. AbortStatement *types.Statement // Checksum identifying the version of the bot that was created. @@ -76,16 +79,20 @@ type CreateBotVersionOutput struct { // 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) + // 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.] + // + // [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. @@ -107,22 +114,22 @@ type CreateBotVersionOutput struct { 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. LastUpdatedDate *time.Time - // Specifies the target locale for the bot. + // Specifies the target locale for the bot. Locale types.Locale // The name of the bot. Name *string - // When you send a request to create or update a bot, Amazon Lex sets the status + // 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. diff --git a/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go b/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go index 21c58ed8d81..79a19d17f31 100644 --- a/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateIntentVersion.go @@ -15,12 +15,16 @@ 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{} @@ -80,7 +84,7 @@ type CreateIntentVersionOutput struct { // after the intent is fulfilled. FollowUpPrompt *types.FollowUpPrompt - // Describes how the intent is fulfilled. + // Describes how the intent is fulfilled. FulfillmentActivity *types.FulfillmentActivity // An array of InputContext objects that lists the contexts that must be active diff --git a/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go b/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go index 0063c64df27..23774d23c6c 100644 --- a/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go +++ b/service/lexmodelbuildingservice/api_op_CreateSlotTypeVersion.go @@ -15,12 +15,15 @@ import ( // Creates a new version of a slot type based on the $LATEST version of the // specified slot type. If the $LATEST version of this resource has not changed // since the last version that you created, Amazon Lex doesn't create a new -// version. It returns the last version that you created. You can update only the -// $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 the lex:CreateSlotTypeVersion action. +// version. It returns the last version that you created. +// +// You can update only the $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 the lex:CreateSlotTypeVersion action. func (c *Client) CreateSlotTypeVersion(ctx context.Context, params *CreateSlotTypeVersionInput, optFns ...func(*Options)) (*CreateSlotTypeVersionOutput, error) { if params == nil { params = &CreateSlotTypeVersionInput{} @@ -83,7 +86,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 7439c0d621b..a5389023be2 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBot.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBot.go @@ -11,17 +11,21 @@ import ( ) // Deletes all versions of the bot, including the $LATEST version. To delete a -// specific version of the bot, use the DeleteBotVersion operation. The DeleteBot -// operation doesn't immediately remove the bot schema. Instead, it is marked for -// deletion and removed later. Amazon Lex stores utterances indefinitely for -// 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. +// specific version of the bot, use the DeleteBotVersionoperation. The DeleteBot operation doesn't +// immediately remove the bot schema. Instead, it is marked for deletion and +// removed later. +// +// Amazon Lex stores utterances indefinitely for 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 DeleteUtterancesoperation. +// +// 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. 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_DeleteBotAlias.go b/service/lexmodelbuildingservice/api_op_DeleteBotAlias.go index 59efb38d864..5978dc76b53 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBotAlias.go @@ -10,13 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an alias for the specified bot. You can't delete an alias that is used -// in the association between a bot and a messaging channel. If an alias is used in -// a channel association, the DeleteBot operation returns a ResourceInUseException -// exception that includes a reference to the channel association that refers to -// the bot. You can remove the reference to the alias by deleting the channel -// association. If you get the same exception again, delete the referring -// association until the DeleteBotAlias operation is successful. +// Deletes an alias for the specified bot. +// +// You can't delete an alias that is used in the association between a bot and a +// messaging channel. If an alias is used in a channel association, the DeleteBot +// operation returns a ResourceInUseException exception that includes a reference +// to the channel association that refers to the bot. You can remove the reference +// to the alias by deleting the channel association. If you get the same exception +// again, delete the referring association until the DeleteBotAlias operation is +// successful. func (c *Client) DeleteBotAlias(ctx context.Context, params *DeleteBotAliasInput, optFns ...func(*Options)) (*DeleteBotAliasOutput, error) { if params == nil { params = &DeleteBotAliasInput{} diff --git a/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go b/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go index 7adcd9733ce..fd25d4d7178 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBotChannelAssociation.go @@ -11,6 +11,7 @@ import ( ) // 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) { diff --git a/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go b/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go index 4efe18a2dcf..688129ded69 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteBotVersion.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specific version of a bot. To delete all versions of a bot, use the -// DeleteBot operation. This operation requires permissions for the -// lex:DeleteBotVersion action. +// Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot +// operation. +// +// This operation requires permissions for the lex:DeleteBotVersion action. func (c *Client) DeleteBotVersion(ctx context.Context, params *DeleteBotVersionInput, optFns ...func(*Options)) (*DeleteBotVersionOutput, error) { if params == nil { params = &DeleteBotVersionInput{} diff --git a/service/lexmodelbuildingservice/api_op_DeleteIntent.go b/service/lexmodelbuildingservice/api_op_DeleteIntent.go index 56f304b67e4..30f47aaef98 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteIntent.go +++ b/service/lexmodelbuildingservice/api_op_DeleteIntent.go @@ -11,15 +11,19 @@ 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 -// 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 -// get the same exception when you attempt to delete the intent again, repeat until -// the intent has no references and the call to DeleteIntent is successful. This -// operation requires permission for the lex:DeleteIntent action. +// specific version of the intent, use the DeleteIntentVersionoperation. +// +// 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 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 get the same exception +// when you attempt to delete the intent again, repeat until the intent has no +// references and the call to DeleteIntent is successful. +// +// This operation requires permission for the lex:DeleteIntent action. func (c *Client) DeleteIntent(ctx context.Context, params *DeleteIntentInput, optFns ...func(*Options)) (*DeleteIntentOutput, error) { if params == nil { params = &DeleteIntentInput{} diff --git a/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go b/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go index f315b40afd4..bf77d6468bf 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteIntentVersion.go @@ -11,8 +11,9 @@ import ( ) // 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. +// use the DeleteIntentoperation. +// +// 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 { params = &DeleteIntentVersionInput{} diff --git a/service/lexmodelbuildingservice/api_op_DeleteSlotType.go b/service/lexmodelbuildingservice/api_op_DeleteSlotType.go index 60ff2799adb..56c432f4248 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteSlotType.go +++ b/service/lexmodelbuildingservice/api_op_DeleteSlotType.go @@ -11,16 +11,20 @@ import ( ) // Deletes all versions of the slot type, including the $LATEST version. To delete -// a specific version of the slot type, use the DeleteSlotTypeVersion operation. +// a specific version of the slot type, use the DeleteSlotTypeVersionoperation. +// // 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 -// lex:DeleteSlotType action. +// 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 { params = &DeleteSlotTypeInput{} diff --git a/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go b/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go index 70dcbbbeb0c..7da6bc4cd09 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go +++ b/service/lexmodelbuildingservice/api_op_DeleteSlotTypeVersion.go @@ -11,8 +11,9 @@ import ( ) // Deletes a specific version of a slot type. To delete all versions of a slot -// type, use the DeleteSlotType operation. This operation requires permissions for -// the lex:DeleteSlotTypeVersion action. +// type, use the DeleteSlotTypeoperation. +// +// This operation requires permissions for the lex:DeleteSlotTypeVersion action. func (c *Client) DeleteSlotTypeVersion(ctx context.Context, params *DeleteSlotTypeVersionInput, optFns ...func(*Options)) (*DeleteSlotTypeVersionOutput, error) { if params == nil { params = &DeleteSlotTypeVersionInput{} @@ -36,8 +37,7 @@ type DeleteSlotTypeVersionInput struct { 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. + // 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 8a9c0033939..bac09c689bc 100644 --- a/service/lexmodelbuildingservice/api_op_DeleteUtterances.go +++ b/service/lexmodelbuildingservice/api_op_DeleteUtterances.go @@ -10,15 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes stored utterances. Amazon Lex stores the utterances that users send to -// your bot. Utterances are stored for 15 days for use with the GetUtterancesView -// 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 stored utterances for a specific user. When you use the DeleteUtterances -// operation, utterances stored for improving your bot's ability to respond to user -// input are deleted immediately. Utterances stored for use with the -// GetUtterancesView operation are deleted after 15 days. This operation requires -// permissions for the lex:DeleteUtterances action. +// Deletes stored utterances. +// +// Amazon Lex stores the utterances that users send to your bot. Utterances are +// stored for 15 days for use with the GetUtterancesViewoperation, 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 stored utterances for a +// specific user. When you use the DeleteUtterances operation, utterances stored +// for improving your bot's ability to respond to user input are deleted +// immediately. Utterances stored for use with the GetUtterancesView operation are +// deleted after 15 days. +// +// This operation requires permissions for the lex:DeleteUtterances action. func (c *Client) DeleteUtterances(ctx context.Context, params *DeleteUtterancesInput, optFns ...func(*Options)) (*DeleteUtterancesOutput, error) { if params == nil { params = &DeleteUtterancesInput{} @@ -41,10 +45,11 @@ 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) - // operation request that contained the utterance. + // The unique identifier for the user that made the utterances. This is the user + // ID that was sent in the [PostContent]or [PostText] operation request that contained the utterance. + // + // [PostText]: http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html + // [PostContent]: http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html // // This member is required. UserId *string diff --git a/service/lexmodelbuildingservice/api_op_GetBot.go b/service/lexmodelbuildingservice/api_op_GetBot.go index 4ccd1edc182..a866ac9443d 100644 --- a/service/lexmodelbuildingservice/api_op_GetBot.go +++ b/service/lexmodelbuildingservice/api_op_GetBot.go @@ -13,8 +13,9 @@ import ( ) // Returns metadata information for a specific bot. You must provide the bot name -// and the bot version or alias. This operation requires permissions for the -// lex:GetBot action. +// and the bot version or alias. +// +// This operation requires permissions for the lex:GetBot action. func (c *Client) GetBot(ctx context.Context, params *GetBotInput, optFns ...func(*Options)) (*GetBotOutput, error) { if params == nil { params = &GetBotInput{} @@ -48,7 +49,7 @@ 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 . + // 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 @@ -69,16 +70,20 @@ type GetBotOutput struct { // 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) + // 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.] + // + // [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. @@ -99,45 +104,51 @@ type GetBotOutput struct { 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. LastUpdatedDate *time.Time - // The target locale for the bot. + // The target locale for the bot. Locale types.Locale // 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) + // AMAZON.KendraSearchIntent , or both when returning alternative intents in a [PostContent] or [PostText] // 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. + // + // [PostText]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html + // [PostContent]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html 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 - // 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 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 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 . Status types.Status // 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 18dc51b3f4e..a8a0968c80d 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_GetBotAlias.go @@ -13,8 +13,9 @@ import ( ) // Returns information about an Amazon Lex bot alias. For more information about -// aliases, see versioning-aliases . This operation requires permissions for the -// lex:GetBotAlias action. +// 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 { params = &GetBotAliasInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetBotAliases.go b/service/lexmodelbuildingservice/api_op_GetBotAliases.go index 42fca2e9e53..9c7135eaf1c 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotAliases.go +++ b/service/lexmodelbuildingservice/api_op_GetBotAliases.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of aliases for a specified Amazon Lex bot. This operation -// requires permissions for the lex:GetBotAliases action. +// Returns a list of aliases for a specified Amazon Lex bot. +// +// This operation requires permissions for the lex:GetBotAliases action. func (c *Client) GetBotAliases(ctx context.Context, params *GetBotAliasesInput, optFns ...func(*Options)) (*GetBotAliasesOutput, error) { if params == nil { params = &GetBotAliasesInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go index 5a528f0471d..537c3863283 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go +++ b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociation.go @@ -13,8 +13,9 @@ import ( ) // Returns information about the association between an Amazon Lex bot and a -// messaging platform. This operation requires permissions for the -// lex:GetBotChannelAssociation action. +// messaging platform. +// +// This operation requires permissions for the lex:GetBotChannelAssociation action. func (c *Client) GetBotChannelAssociation(ctx context.Context, params *GetBotChannelAssociationInput, optFns ...func(*Options)) (*GetBotChannelAssociationOutput, error) { if params == nil { params = &GetBotChannelAssociationInput{} @@ -79,8 +80,11 @@ type GetBotChannelAssociationOutput struct { 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. Status types.ChannelStatus diff --git a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go index 1c6dcda735f..2a6db2e1a31 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go +++ b/service/lexmodelbuildingservice/api_op_GetBotChannelAssociations.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of all of the channels associated with the specified bot. The -// GetBotChannelAssociations operation requires permissions for the +// Returns a list of all of the channels associated with the specified bot. +// +// The GetBotChannelAssociations operation requires permissions for the // lex:GetBotChannelAssociations action. func (c *Client) GetBotChannelAssociations(ctx context.Context, params *GetBotChannelAssociationsInput, optFns ...func(*Options)) (*GetBotChannelAssociationsOutput, error) { if params == nil { @@ -42,7 +43,8 @@ type GetBotChannelAssociationsInput struct { // This member is required. BotName *string - // The maximum number of associations to return in the response. The default is 50. + // 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 @@ -168,7 +170,8 @@ var _ GetBotChannelAssociationsAPIClient = (*Client)(nil) // GetBotChannelAssociationsPaginatorOptions is the paginator options for // GetBotChannelAssociations type GetBotChannelAssociationsPaginatorOptions struct { - // The maximum number of associations to return in the response. The default is 50. + // The maximum number of associations to return in the response. The default is + // 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lexmodelbuildingservice/api_op_GetBotVersions.go b/service/lexmodelbuildingservice/api_op_GetBotVersions.go index 97082ed1fff..7eb6517bd86 100644 --- a/service/lexmodelbuildingservice/api_op_GetBotVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetBotVersions.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about all of the versions of a bot. The GetBotVersions -// operation returns a BotMetadata object for each version of a bot. For example, -// if a bot has three numbered versions, the GetBotVersions operation returns four -// BotMetadata objects in the response, one for each numbered version and one for -// the $LATEST version. The GetBotVersions operation always returns at least one -// version, the $LATEST version. This operation requires permissions for the -// lex:GetBotVersions action. +// Gets information about all of the versions of a bot. +// +// The GetBotVersions operation returns a BotMetadata object for each version of a +// bot. For example, if a bot has three numbered versions, the GetBotVersions +// operation returns four BotMetadata objects in the response, one for each +// numbered version and one for the $LATEST version. +// +// The GetBotVersions operation always returns at least one version, the $LATEST +// version. +// +// This operation requires permissions for the lex:GetBotVersions action. func (c *Client) GetBotVersions(ctx context.Context, params *GetBotVersionsInput, optFns ...func(*Options)) (*GetBotVersionsOutput, error) { if params == nil { params = &GetBotVersionsInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetBots.go b/service/lexmodelbuildingservice/api_op_GetBots.go index fb899612d24..8ad8a9a2a78 100644 --- a/service/lexmodelbuildingservice/api_op_GetBots.go +++ b/service/lexmodelbuildingservice/api_op_GetBots.go @@ -12,8 +12,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. // diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go b/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go index 0b853e4ac6b..20367b522d3 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinIntent.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a built-in intent. This operation requires permission -// for the lex:GetBuiltinIntent action. +// Returns information about a built-in intent. +// +// This operation requires permission for the lex:GetBuiltinIntent action. func (c *Client) GetBuiltinIntent(ctx context.Context, params *GetBuiltinIntentInput, optFns ...func(*Options)) (*GetBuiltinIntentOutput, error) { if params == nil { params = &GetBuiltinIntentInput{} @@ -31,8 +32,9 @@ 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) - // in the Alexa Skills Kit. + // intent, see [Standard Built-in Intents]in the Alexa Skills Kit. + // + // [Standard Built-in Intents]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents // // This member is required. Signature *string diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go b/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go index f0119570388..9ba1b8f498d 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinIntents.go @@ -11,8 +11,9 @@ 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{} @@ -43,9 +44,10 @@ 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) - // in the Alexa Skills Kit. + // "xyzabc" and "abcxyz." To find the signature for an intent, see [Standard Built-in Intents]in the Alexa + // Skills Kit. + // + // [Standard Built-in Intents]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents SignatureContains *string noSmithyDocumentSerde diff --git a/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go b/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go index c096d20fa09..1d8c33a1c45 100644 --- a/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go +++ b/service/lexmodelbuildingservice/api_op_GetBuiltinSlotTypes.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Alexa Skills Kit. This operation requires permission for the -// lex:GetBuiltInSlotTypes action. +// 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] in the Alexa Skills Kit. +// +// This operation requires permission for the lex:GetBuiltInSlotTypes action. +// +// [Slot Type Reference]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference func (c *Client) GetBuiltinSlotTypes(ctx context.Context, params *GetBuiltinSlotTypesInput, optFns ...func(*Options)) (*GetBuiltinSlotTypesOutput, error) { if params == nil { params = &GetBuiltinSlotTypesInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetExport.go b/service/lexmodelbuildingservice/api_op_GetExport.go index bc9899d8116..59b10156cbb 100644 --- a/service/lexmodelbuildingservice/api_op_GetExport.go +++ b/service/lexmodelbuildingservice/api_op_GetExport.go @@ -55,8 +55,11 @@ 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. ExportStatus types.ExportStatus diff --git a/service/lexmodelbuildingservice/api_op_GetIntent.go b/service/lexmodelbuildingservice/api_op_GetIntent.go index c05943575a4..f5a4b1d6954 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntent.go +++ b/service/lexmodelbuildingservice/api_op_GetIntent.go @@ -12,9 +12,11 @@ import ( "time" ) -// Returns information about an intent. In addition to the intent name, you must -// specify the intent version. This operation requires permissions to perform the -// lex:GetIntent action. +// Returns information about an intent. In addition to the intent name, you must +// +// specify the intent version. +// +// This operation requires permissions to perform the lex:GetIntent action. func (c *Client) GetIntent(ctx context.Context, params *GetIntentInput, optFns ...func(*Options)) (*GetIntentOutput, error) { if params == nil { params = &GetIntentInput{} @@ -55,7 +57,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,14 +67,14 @@ 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 diff --git a/service/lexmodelbuildingservice/api_op_GetIntentVersions.go b/service/lexmodelbuildingservice/api_op_GetIntentVersions.go index 64c71be5030..4d1713664ac 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntentVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetIntentVersions.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about all of the versions of an intent. The GetIntentVersions -// operation returns an IntentMetadata object for each version of an intent. For -// example, if an intent has three numbered versions, the GetIntentVersions -// operation returns four IntentMetadata objects in the response, one for each -// numbered version and one for the $LATEST version. The GetIntentVersions -// operation always returns at least one version, the $LATEST version. This -// operation requires permissions for the lex:GetIntentVersions action. +// Gets information about all of the versions of an intent. +// +// The GetIntentVersions operation returns an IntentMetadata object for each +// version of an intent. For example, if an intent has three numbered versions, the +// GetIntentVersions operation returns four IntentMetadata objects in the +// response, one for each numbered version and one for the $LATEST version. +// +// The GetIntentVersions operation always returns at least one version, the +// $LATEST version. +// +// This operation requires permissions for the lex:GetIntentVersions action. func (c *Client) GetIntentVersions(ctx context.Context, params *GetIntentVersionsInput, optFns ...func(*Options)) (*GetIntentVersionsOutput, error) { if params == nil { params = &GetIntentVersionsInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetIntents.go b/service/lexmodelbuildingservice/api_op_GetIntents.go index 1fdfa694c74..33ae9bf34c3 100644 --- a/service/lexmodelbuildingservice/api_op_GetIntents.go +++ b/service/lexmodelbuildingservice/api_op_GetIntents.go @@ -12,8 +12,10 @@ 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. // @@ -54,7 +56,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 7b385012b56..b8dbbaba297 100644 --- a/service/lexmodelbuildingservice/api_op_GetMigration.go +++ b/service/lexmodelbuildingservice/api_op_GetMigration.go @@ -45,9 +45,11 @@ type GetMigrationOutput struct { // A list of alerts and warnings that indicate issues with the migration for the // Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 - // feature has a different implementation if Amazon Lex V2. For more information, - // see Migrating a bot (https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html) - // in the Amazon Lex V2 developer guide. + // feature has a different implementation if Amazon Lex V2. + // + // For more information, see [Migrating a bot] in the Amazon Lex V2 developer guide. + // + // [Migrating a bot]: https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html Alerts []types.MigrationAlert // The unique identifier of the migration. This is the same as the identifier used @@ -60,8 +62,10 @@ type GetMigrationOutput struct { 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 diff --git a/service/lexmodelbuildingservice/api_op_GetSlotType.go b/service/lexmodelbuildingservice/api_op_GetSlotType.go index 4c0e89e4161..4bc4c8ea5e0 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotType.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotType.go @@ -13,8 +13,9 @@ import ( ) // Returns information about a specific version of a slot type. In addition to -// specifying the slot type name, you must specify the slot type version. This -// operation requires permissions for the lex:GetSlotType action. +// specifying the slot type name, you must specify the slot type version. +// +// This operation requires permissions for the lex:GetSlotType action. func (c *Client) GetSlotType(ctx context.Context, params *GetSlotTypeInput, optFns ...func(*Options)) (*GetSlotTypeOutput, error) { if params == nil { params = &GetSlotTypeInput{} @@ -74,7 +75,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 58c6c962a97..39cf4a22f34 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotTypeVersions.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 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 -// operation requires permissions for the lex:GetSlotTypeVersions action. +// 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 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 operation requires permissions for the lex:GetSlotTypeVersions action. func (c *Client) GetSlotTypeVersions(ctx context.Context, params *GetSlotTypeVersionsInput, optFns ...func(*Options)) (*GetSlotTypeVersionsOutput, error) { if params == nil { params = &GetSlotTypeVersionsInput{} diff --git a/service/lexmodelbuildingservice/api_op_GetSlotTypes.go b/service/lexmodelbuildingservice/api_op_GetSlotTypes.go index 26c07009930..c1f34af4eeb 100644 --- a/service/lexmodelbuildingservice/api_op_GetSlotTypes.go +++ b/service/lexmodelbuildingservice/api_op_GetSlotTypes.go @@ -12,8 +12,10 @@ 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. // diff --git a/service/lexmodelbuildingservice/api_op_GetUtterancesView.go b/service/lexmodelbuildingservice/api_op_GetUtterancesView.go index 8640ab6374f..8895f7bcf91 100644 --- a/service/lexmodelbuildingservice/api_op_GetUtterancesView.go +++ b/service/lexmodelbuildingservice/api_op_GetUtterancesView.go @@ -13,22 +13,30 @@ import ( // 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 -// 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 -// information for up to 5 versions of your bot in each request. Amazon Lex returns -// the most frequent utterances received by the bot in the last 15 days. The -// response contains information about a maximum of 100 utterances for each -// version. If you set childDirected field to true when you created your bot, if -// you are using slot obfuscation with one or more slots, or if you opted out of -// participating in improving Amazon Lex, utterances are not available. This -// operation requires permissions for the lex:GetUtterancesView action. +// 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 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 information for up to 5 versions of your bot in each +// request. Amazon Lex returns the most frequent utterances received by the bot in +// the last 15 days. The response contains information about a maximum of 100 +// utterances for each version. +// +// If you set childDirected field to true when you created your bot, if you are +// using slot obfuscation with one or more slots, or if you opted out of +// participating in improving Amazon Lex, utterances are not available. +// +// This operation requires permissions for the lex:GetUtterancesView action. func (c *Client) GetUtterancesView(ctx context.Context, params *GetUtterancesViewInput, optFns ...func(*Options)) (*GetUtterancesViewOutput, error) { if params == nil { params = &GetUtterancesViewInput{} @@ -71,10 +79,10 @@ type GetUtterancesViewOutput struct { // The name of the bot for which utterance information was returned. BotName *string - // An array of UtteranceList objects, each containing a list of UtteranceData - // objects describing the utterances that were processed by your bot. The response - // contains a maximum of 100 UtteranceData objects for each version. Amazon Lex - // returns the most frequent utterances received by the bot in the last 15 days. + // An array of UtteranceList objects, each containing a list of UtteranceData objects describing the + // utterances that were processed by your bot. The response contains a maximum of + // 100 UtteranceData objects for each version. Amazon Lex returns the most + // frequent utterances received by the bot in the last 15 days. Utterances []types.UtteranceList // Metadata pertaining to the operation's result. diff --git a/service/lexmodelbuildingservice/api_op_PutBot.go b/service/lexmodelbuildingservice/api_op_PutBot.go index b9b835b731b..92df0968361 100644 --- a/service/lexmodelbuildingservice/api_op_PutBot.go +++ b/service/lexmodelbuildingservice/api_op_PutBot.go @@ -18,14 +18,17 @@ import ( // 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 -// 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 +// 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 // 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 . +// exception. +// +// This operation requires permissions for the lex:PutBot action. For more +// information, see security-iam. func (c *Client) PutBot(ctx context.Context, params *PutBotInput, optFns ...func(*Options)) (*PutBotOutput, error) { if params == nil { params = &PutBotInput{} @@ -57,18 +60,24 @@ type PutBotInput struct { // 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) + // 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.] + // + // [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 . + // 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 . // // This member is required. Locale types.Locale @@ -82,49 +91,66 @@ type PutBotInput struct { // 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 + // 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) - // . + // 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]. + // + // [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. + // 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. Checksum *string // When Amazon Lex doesn't understand the user's intent, it uses this message to // get clarification. To specify how many times Amazon Lex should repeat the // clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't - // understand, it sends the message in the abortStatement field. When you create a - // clarification prompt, make sure that it suggests the correct response from the - // user. for example, for a bot that orders pizza and drinks, you might create this - // 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: + // understand, it sends the message in the abortStatement field. + // + // When you create a clarification prompt, make sure that it suggests the correct + // response from the user. for example, for a bot that orders pizza and drinks, you + // might create this 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]. + // + // 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. + // + // [AMAZON.FallbackIntent]: https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html ClarificationPrompt *types.Prompt // When set to true a new numbered version of the bot is created. This is the same @@ -140,65 +166,96 @@ type PutBotInput struct { 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 + // information, see [Confidence Scores]. + // + // 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: + // + // 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. + // + // [Confidence Scores]: https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html EnableModelImprovements *bool // The maximum time in seconds that Amazon Lex retains the data gathered in a - // conversation. A user interaction session remains active for the amount of time - // specified. If no conversation occurs during this time, the session expires and - // Amazon Lex deletes any data provided before the timeout. For example, suppose - // that a user chooses the OrderPizza intent, but gets sidetracked halfway through - // placing an order. If the user doesn't complete the order within the specified - // time, Amazon Lex discards the slot information that it gathered, and the user - // must start over. If you don't include the idleSessionTTLInSeconds element in a - // PutBot operation request, Amazon Lex uses the default value. This is also true - // if the request replaces an existing bot. The default is 300 seconds (5 minutes). + // conversation. + // + // A user interaction session remains active for the amount of time specified. If + // no conversation occurs during this time, the session expires and Amazon Lex + // deletes any data provided before the timeout. + // + // For example, suppose that a user chooses the OrderPizza intent, but gets + // sidetracked halfway through placing an order. If the user doesn't complete the + // order within the specified time, Amazon Lex discards the slot information that + // it gathered, and the user must start over. + // + // If you don't include the idleSessionTTLInSeconds element in a PutBot operation + // request, Amazon Lex uses the default value. This is also true if the request + // replaces an existing bot. + // + // The default is 300 seconds (5 minutes). IdleSessionTTLInSeconds *int32 // 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) - // 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. + // , AMAZON.KendraSearchIntent , or both when returning alternative intents in a [PostContent] + // or [PostText]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: + // 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 + // + // [PostText]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html + // [PostContent]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html 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 . + // 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, @@ -208,8 +265,10 @@ type PutBotInput struct { // 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. + // locale of the bot. For more information, see [Voices in Amazon Polly]in the Amazon Polly Developer + // Guide. + // + // [Voices in Amazon Polly]: https://docs.aws.amazon.com/polly/latest/dg/voicelist.html VoiceId *string noSmithyDocumentSerde @@ -218,7 +277,7 @@ type PutBotInput struct { type PutBotOutput struct { // The message that Amazon Lex uses to cancel a conversation. For more - // information, see PutBot . + // information, see PutBot. AbortStatement *types.Statement // Checksum of the bot that you created. @@ -238,16 +297,20 @@ type PutBotOutput struct { // 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) + // 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.] + // + // [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 . + // The prompts that Amazon Lex uses when it doesn't understand the user's intent. + // For more information, see PutBot. ClarificationPrompt *types.Prompt // True if a new version of the bot was created. If the createVersion field was @@ -275,40 +338,46 @@ type PutBotOutput struct { 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. LastUpdatedDate *time.Time - // The target locale for the bot. + // The target locale for the bot. Locale types.Locale // 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) + // AMAZON.KendraSearchIntent , or both when returning alternative intents in a [PostContent] or [PostText] // 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. + // + // [PostText]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html + // [PostContent]: https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html 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 - // 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 . - // 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 - // bot. + // 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 . 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 bot. Status types.Status // A list of tags associated with the bot. @@ -318,7 +387,7 @@ type PutBotOutput struct { 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 6dd226119d0..026dc57000d 100644 --- a/service/lexmodelbuildingservice/api_op_PutBotAlias.go +++ b/service/lexmodelbuildingservice/api_op_PutBotAlias.go @@ -14,7 +14,8 @@ 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,12 +49,15 @@ 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 - // 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 - // match the $LATEST version, you get a PreconditionFailedException exception. + // 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 match the $LATEST version, you get + // a PreconditionFailedException exception. Checksum *string // Settings for conversation logs for the alias. diff --git a/service/lexmodelbuildingservice/api_op_PutIntent.go b/service/lexmodelbuildingservice/api_op_PutIntent.go index 7cd1a9af21c..642b54041bf 100644 --- a/service/lexmodelbuildingservice/api_op_PutIntent.go +++ b/service/lexmodelbuildingservice/api_op_PutIntent.go @@ -12,10 +12,14 @@ import ( "time" ) -// Creates an intent or replaces an existing intent. To define the interaction -// between the user and your bot, you use one or more intents. For a pizza ordering -// bot, for example, you would create an OrderPizza intent. To create an intent or -// replace an existing intent, you must provide the following: +// Creates an intent or replaces an existing intent. +// +// To define the interaction between the user and your bot, you use one or more +// intents. For a pizza ordering 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 . // @@ -33,10 +37,13 @@ import ( // the intent information to the client application. // // 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?" // @@ -45,9 +52,11 @@ import ( // 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. +// 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{} @@ -65,39 +74,52 @@ func (c *Client) PutIntent(ctx context.Context, params *PutIntentInput, optFns . 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) - // in the Alexa Skills Kit. + // 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] in the Alexa Skills Kit. + // + // [Standard Built-in Intents]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents // // This member is required. Name *string - // Identifies a specific revision of the $LATEST version. When you create a new - // 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 - // match the $LATEST version, you get a PreconditionFailedException exception. + // Identifies a specific revision of the $LATEST version. + // + // When you create a new 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 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 - // intent to the client application, you can't specify this element. The - // followUpPrompt and conclusionStatement are mutually exclusive. You can specify - // only one. + // 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. ConclusionStatement *types.Statement // Prompts the user to confirm the intent. This question should have a yes or no - // answer. Amazon Lex uses this prompt to ensure that the user acknowledges that - // the intent is ready for fulfillment. For example, with the OrderPizza intent, - // you might want to confirm that the order is correct before placing it. For other + // answer. + // + // Amazon Lex uses this prompt to ensure that the user acknowledges that the + // intent is ready for fulfillment. For example, with the OrderPizza intent, 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. + // need to ask the user for confirmation before providing the information. + // + // You you 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 @@ -108,37 +130,45 @@ type PutIntentInput struct { // A description of the intent. Description *string - // Specifies a Lambda function to invoke for each user input. You can invoke this - // Lambda function to personalize user interaction. For example, suppose your bot - // 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 - // phone number and set the corresponding session attribute. + // Specifies a Lambda function to invoke for each user input. You can invoke this + // Lambda function to personalize user interaction. + // + // For example, suppose your bot 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 phone number and set the corresponding session + // attribute. DialogCodeHook *types.CodeHook // Amazon Lex uses this prompt to solicit additional activity after fulfilling an // 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: + // 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. + // + // - 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 // provides all of the information for a pizza order, fulfillmentActivity defines - // how the bot places an order with a local pizza store. You might configure Amazon - // Lex to return all of the intent information to the client application, or direct - // it to invoke a Lambda function that can process the intent (for example, place - // an order with a pizzeria). + // how the bot places an order with a local pizza store. + // + // You might configure Amazon Lex to return all of the intent information to the + // client application, or direct it to invoke a Lambda function that can process + // the intent (for example, place an order with a pizzeria). FulfillmentActivity *types.FulfillmentActivity // An array of InputContext objects that lists the contexts that must be active @@ -146,9 +176,9 @@ type PutIntentInput struct { 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) - // . + // to connect to an Amazon Kendra index. For more information, see [AMAZON.KendraSearchIntent]. + // + // [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 @@ -156,24 +186,27 @@ 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) - // in the Alexa Skills Kit. + // signature for an intent, see [Standard Built-in Intents]in the Alexa Skills Kit. + // + // [Standard Built-in Intents]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents 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. + // 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. 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 . + // from the user using prompts defined in the slots. For more information, see how-it-works. Slots []types.Slot noSmithyDocumentSerde @@ -242,7 +275,7 @@ type PutIntentOutput struct { // Lex responds with this statement to acknowledge that the intent was canceled. RejectionStatement *types.Statement - // An array of sample utterances that are configured for the intent. + // An array of sample utterances that are configured for the intent. SampleUtterances []string // An array of intent slots that are configured for the intent. diff --git a/service/lexmodelbuildingservice/api_op_PutSlotType.go b/service/lexmodelbuildingservice/api_op_PutSlotType.go index 975aca5e79e..a7da8755016 100644 --- a/service/lexmodelbuildingservice/api_op_PutSlotType.go +++ b/service/lexmodelbuildingservice/api_op_PutSlotType.go @@ -12,17 +12,20 @@ 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 -// 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. +// 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. func (c *Client) PutSlotType(ctx context.Context, params *PutSlotTypeInput, optFns ...func(*Options)) (*PutSlotTypeOutput, error) { if params == nil { params = &PutSlotTypeInput{} @@ -40,22 +43,28 @@ func (c *Client) PutSlotType(ctx context.Context, params *PutSlotTypeInput, optF 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) - // in the Alexa Skills Kit. + // 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] in the Alexa Skills Kit. + // + // [Slot Type Reference]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference // // This member is required. Name *string - // Identifies a specific revision of the $LATEST version. When you create a new - // 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 - // match the $LATEST version, you get a PreconditionFailedException exception. + // Identifies a specific revision of the $LATEST version. + // + // When you create a new 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 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 @@ -69,18 +78,24 @@ type PutSlotTypeInput struct { // 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 // 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 - // a slot value, it generates a resolution list that contains up to five possible - // values for the slot. If you are using a Lambda function, this resolution list is - // passed to the function. If you are not using a Lambda function you can choose to - // return the value that the user entered or the first value in the resolution list - // as the slot value. The valueSelectionStrategy field indicates the option to use. + // 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 a slot value, it generates a resolution list that + // contains up to five possible values for the slot. If you are using a Lambda + // function, this resolution list is passed to the function. If you are not using a + // Lambda function you can choose to return the value that the user entered or the + // first value in the resolution list as the slot value. The valueSelectionStrategy + // field indicates the option to use. EnumerationValues []types.EnumerationValue // The built-in slot type used as the parent of the slot type. When you define a // parent slot type, the new slot type has all of the same configuration as the - // parent. Only AMAZON.AlphaNumeric is supported. + // parent. + // + // Only AMAZON.AlphaNumeric is supported. ParentSlotTypeSignature *string // Configuration information that extends the parent built-in slot type. The @@ -89,11 +104,14 @@ type PutSlotTypeInput 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: + // // - 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 @@ -134,7 +152,7 @@ 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 diff --git a/service/lexmodelbuildingservice/api_op_StartImport.go b/service/lexmodelbuildingservice/api_op_StartImport.go index 78b3f9f7978..5f3c04ddfd6 100644 --- a/service/lexmodelbuildingservice/api_op_StartImport.go +++ b/service/lexmodelbuildingservice/api_op_StartImport.go @@ -32,12 +32,15 @@ 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. + // 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 @@ -51,7 +54,9 @@ type StartImportInput struct { // 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. // // This member is required. diff --git a/service/lexmodelbuildingservice/api_op_StartMigration.go b/service/lexmodelbuildingservice/api_op_StartMigration.go index 80a00e4f93c..d18dc8b53ba 100644 --- a/service/lexmodelbuildingservice/api_op_StartMigration.go +++ b/service/lexmodelbuildingservice/api_op_StartMigration.go @@ -13,9 +13,11 @@ 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. +// when you want to take advantage of the new features of Amazon Lex V2. +// +// For more information, see [Migrating a bot] in the Amazon Lex developer guide. +// +// [Migrating a bot]: https://docs.aws.amazon.com/lex/latest/dg/migrate.html func (c *Client) StartMigration(ctx context.Context, params *StartMigrationInput, optFns ...func(*Options)) (*StartMigrationOutput, error) { if params == nil { params = &StartMigrationInput{} @@ -34,8 +36,10 @@ 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 @@ -57,8 +61,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. // diff --git a/service/lexmodelbuildingservice/doc.go b/service/lexmodelbuildingservice/doc.go index 98b7755e86d..8fb3b4ae387 100644 --- a/service/lexmodelbuildingservice/doc.go +++ b/service/lexmodelbuildingservice/doc.go @@ -3,7 +3,9 @@ // Package lexmodelbuildingservice provides the API client, operations, and // parameter types for Amazon Lex Model Building Service. // -// Amazon Lex Build-Time Actions Amazon Lex is an AWS service for building -// conversational voice and text interfaces. Use these actions to create, update, -// and delete conversational bots for new and existing client applications. +// # Amazon Lex Build-Time Actions +// +// Amazon Lex is an AWS service for building conversational voice and text +// interfaces. Use these actions to create, update, and delete conversational bots +// for new and existing client applications. package lexmodelbuildingservice diff --git a/service/lexmodelbuildingservice/options.go b/service/lexmodelbuildingservice/options.go index 18157169360..c4c5eb6f1e5 100644 --- a/service/lexmodelbuildingservice/options.go +++ b/service/lexmodelbuildingservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lexmodelbuildingservice/types/enums.go b/service/lexmodelbuildingservice/types/enums.go index a9387838f20..e899a650107 100644 --- a/service/lexmodelbuildingservice/types/enums.go +++ b/service/lexmodelbuildingservice/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ChannelStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelStatus) Values() []ChannelStatus { return []ChannelStatus{ "IN_PROGRESS", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for ChannelType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelType) Values() []ChannelType { return []ChannelType{ "Facebook", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "PlainText", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for Destination. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Destination) Values() []Destination { return []Destination{ "CLOUDWATCH_LOGS", @@ -92,8 +96,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for ExportType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportType) Values() []ExportType { return []ExportType{ "ALEXA_SKILLS_KIT", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for FulfillmentActivityType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FulfillmentActivityType) Values() []FulfillmentActivityType { return []FulfillmentActivityType{ "ReturnIntent", @@ -148,8 +155,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -178,8 +186,9 @@ const ( ) // Values returns all known values for Locale. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Locale) Values() []Locale { return []Locale{ "de-DE", @@ -207,8 +216,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "AUDIO", @@ -225,8 +235,9 @@ const ( ) // Values returns all known values for MergeStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MergeStrategy) Values() []MergeStrategy { return []MergeStrategy{ "OVERWRITE_LATEST", @@ -243,8 +254,9 @@ const ( ) // Values returns all known values for MigrationAlertType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationAlertType) Values() []MigrationAlertType { return []MigrationAlertType{ "ERROR", @@ -261,8 +273,9 @@ const ( ) // Values returns all known values for MigrationSortAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationSortAttribute) Values() []MigrationSortAttribute { return []MigrationSortAttribute{ "V1_BOT_NAME", @@ -280,8 +293,9 @@ const ( ) // Values returns all known values for MigrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationStatus) Values() []MigrationStatus { return []MigrationStatus{ "IN_PROGRESS", @@ -299,8 +313,9 @@ const ( ) // Values returns all known values for MigrationStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationStrategy) Values() []MigrationStrategy { return []MigrationStrategy{ "CREATE_NEW", @@ -317,8 +332,9 @@ const ( ) // Values returns all known values for ObfuscationSetting. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObfuscationSetting) Values() []ObfuscationSetting { return []ObfuscationSetting{ "NONE", @@ -335,8 +351,9 @@ const ( ) // Values returns all known values for ProcessBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessBehavior) Values() []ProcessBehavior { return []ProcessBehavior{ "SAVE", @@ -355,8 +372,9 @@ const ( ) // Values returns all known values for ReferenceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceType) Values() []ReferenceType { return []ReferenceType{ "Intent", @@ -376,8 +394,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -395,8 +414,9 @@ const ( ) // Values returns all known values for SlotConstraint. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotConstraint) Values() []SlotConstraint { return []SlotConstraint{ "Required", @@ -414,6 +434,7 @@ const ( // Values returns all known values for SlotValueSelectionStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SlotValueSelectionStrategy) Values() []SlotValueSelectionStrategy { return []SlotValueSelectionStrategy{ @@ -431,8 +452,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -452,8 +474,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "BUILDING", @@ -473,8 +496,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "Detected", diff --git a/service/lexmodelbuildingservice/types/errors.go b/service/lexmodelbuildingservice/types/errors.go index e2144a3e0c3..bfb269fc324 100644 --- a/service/lexmodelbuildingservice/types/errors.go +++ b/service/lexmodelbuildingservice/types/errors.go @@ -168,7 +168,8 @@ func (e *NotFoundException) ErrorCode() string { } func (e *NotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The checksum of the resource that you are trying to change does not match the +// The checksum of the resource that you are trying to change does not match the +// // checksum in the request. Check the resource's checksum and try again. type PreconditionFailedException struct { Message *string @@ -197,8 +198,11 @@ func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault { return sm // The resource that you are attempting to delete is referred to by another // resource. Use this information to remove references to the resource that you are -// trying to delete. The body of the exception contains a JSON object that -// describes the resource. { "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT, +// trying to delete. +// +// The body of the exception contains a JSON object that describes the resource. +// +// { "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT, // // "resourceReference": { // diff --git a/service/lexmodelbuildingservice/types/types.go b/service/lexmodelbuildingservice/types/types.go index 4d3194857fc..ab83595749f 100644 --- a/service/lexmodelbuildingservice/types/types.go +++ b/service/lexmodelbuildingservice/types/types.go @@ -50,6 +50,7 @@ type BotChannelAssociation struct { BotConfiguration map[string]string // The name of the Amazon Lex bot to which this association is being made. + // // Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio. BotName *string @@ -68,8 +69,11 @@ type BotChannelAssociation struct { 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. Status ChannelStatus @@ -110,8 +114,9 @@ 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) - // in the Alexa Skills Kit. + // intent, see [Standard Built-in Intents]in the Alexa Skills Kit. + // + // [Standard Built-in Intents]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents Signature *string // A list of identifiers for the locales that the intent supports. @@ -133,8 +138,9 @@ type BuiltinIntentSlot struct { 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) - // in the Alexa Skills Kit. + // slot type, see [Slot Type Reference]in the Alexa Skills Kit. + // + // [Slot Type Reference]: https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference Signature *string // A list of target locales for the slot. @@ -148,7 +154,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 @@ -167,9 +173,9 @@ type ConversationLogsRequest struct { // The Amazon Resource Name (ARN) of an IAM role with permission to write to your // 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) - // . + // key used for encrypting audio logs. For more information, see [Creating an IAM Role and Policy for Conversation Logs]. + // + // [Creating an IAM 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 @@ -197,11 +203,15 @@ type ConversationLogsResponse struct { } // Each slot type can have a set of values. Each enumeration value represents a -// 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 +// 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 type EnumerationValue struct { @@ -235,30 +245,34 @@ type FollowUpPrompt struct { noSmithyDocumentSerde } -// Describes how the intent is fulfilled after the user provides all of the +// Describes how the intent is fulfilled after the user provides all of the +// // information required for the intent. You can provide a Lambda function to // process the intent, or you can return the intent information to the client // application. We recommend that you use a Lambda function so that the relevant // logic lives in the Cloud and limit the client-side code primarily to // 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: +// 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. type FulfillmentActivity struct { - // How the intent should be fulfilled, either by running a Lambda function or by + // How the intent should be fulfilled, either by running a Lambda function or by // returning the slot data to the client application. // // This member is required. Type FulfillmentActivityType - // A description of the Lambda function that is run to fulfill the intent. + // A description of the Lambda function that is run to fulfill the intent. CodeHook *CodeHook noSmithyDocumentSerde @@ -317,8 +331,9 @@ 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]. +// +// [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 @@ -339,8 +354,11 @@ 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]. + // + // You can override this filter string with a new filter string at runtime. + // + // [Filtering queries]: http://docs.aws.amazon.com/kendra/latest/dg/filtering.html QueryFilterString *string noSmithyDocumentSerde @@ -435,8 +453,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. Type MigrationAlertType @@ -508,7 +528,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. @@ -525,14 +545,15 @@ 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 } // Describes the resource that refers to the resource that you are attempting to -// delete. This object is returned as part of the ResourceInUseException exception. +// delete. This object is returned as part of the ResourceInUseException +// exception. type ResourceReference struct { // The name of the resource that is using the resource that you are trying to @@ -570,21 +591,24 @@ 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]. + // + // [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. + // Directs Amazon Lex the order in which to elicit this slot value from the user. // For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex - // first elicits a value for the slot with priority 1. If multiple slots share the - // same priority, the order in which Amazon Lex elicits values is arbitrary. + // first elicits a value for the slot with priority 1. + // + // If multiple slots share the 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 + // 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 + // If you know a specific pattern with which 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. @@ -607,9 +631,12 @@ 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." // // This member is required. @@ -624,10 +651,12 @@ type SlotDefaultValueSpec struct { // The default values for a slot. You can specify more than one default. For // example, you can specify a default value to use from a matching context - // variable, a session attribute, or a fixed value. The default value chosen is - // selected based on the order that you specify them in the list. For example, if - // you specify a context variable and a fixed value in that order, Amazon Lex uses - // the context variable if it is available, else it uses the fixed value. + // variable, a session attribute, or a fixed value. + // + // The default value chosen is selected based on the order that you specify them + // in the list. For example, if you specify a context variable and a fixed value in + // that order, Amazon Lex uses the context variable if it is available, else it + // uses the fixed value. // // This member is required. DefaultValueList []SlotDefaultValue @@ -669,15 +698,23 @@ type SlotTypeMetadata struct { // Provides a regular expression used to validate the value of a slot. 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 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: + // + // 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. @@ -695,9 +732,11 @@ 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] 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. + // + // [PostText]: http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html ResponseCard *string noSmithyDocumentSerde @@ -751,8 +790,8 @@ type UtteranceList struct { // The version of the bot that processed the list. BotVersion *string - // One or more UtteranceData objects that contain information about the utterances - // that have been made to a bot. The maximum number of object is 100. + // One or more UtteranceData objects that contain information about the utterances that have + // been made to a bot. The maximum number of object is 100. Utterances []UtteranceData noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go b/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go index ce06901fd78..698c7405edd 100644 --- a/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go +++ b/service/lexmodelsv2/api_op_BatchCreateCustomVocabularyItem.go @@ -47,9 +47,9 @@ type BatchCreateCustomVocabularyItemInput struct { CustomVocabularyItemList []types.NewCustomVocabularyItem // 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) - // . + // The string must match one of the supported locales. For more information, see [Supported Languages]. + // + // [Supported Languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -70,9 +70,9 @@ type BatchCreateCustomVocabularyItemOutput struct { Errors []types.FailedCustomVocabularyItem // 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) - // . + // The string must match one of the supported locales. For more information, see [Supported Languages]. + // + // [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 cb1a69fa562..bc53f1f81aa 100644 --- a/service/lexmodelsv2/api_op_BatchDeleteCustomVocabularyItem.go +++ b/service/lexmodelsv2/api_op_BatchDeleteCustomVocabularyItem.go @@ -47,9 +47,9 @@ type BatchDeleteCustomVocabularyItemInput struct { CustomVocabularyItemList []types.CustomVocabularyEntryId // 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) - // . + // The string must match one of the supported locales. For more information, see [Supported Languages]. + // + // [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 06ceced67ae..65c997ef2f7 100644 --- a/service/lexmodelsv2/api_op_BatchUpdateCustomVocabularyItem.go +++ b/service/lexmodelsv2/api_op_BatchUpdateCustomVocabularyItem.go @@ -47,9 +47,9 @@ type BatchUpdateCustomVocabularyItemInput struct { 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) - // . + // The string must match one of the supported locales. For more information, see [Supported Languages]. + // + // [Supported Languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -70,9 +70,9 @@ type BatchUpdateCustomVocabularyItemOutput struct { Errors []types.FailedCustomVocabularyItem // 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) - // . + // The string must match one of the supported locales. For more information, see [Supported Languages]. + // + // [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 30d6bc5b198..71114290241 100644 --- a/service/lexmodelsv2/api_op_BuildBotLocale.go +++ b/service/lexmodelsv2/api_op_BuildBotLocale.go @@ -33,8 +33,9 @@ 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) - // operation. + // from the [CreateBot]operation. + // + // [CreateBot]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html // // This member is required. BotId *string @@ -46,9 +47,9 @@ 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) - // . + // and slots used in the bot must have the same locale. For more information, see [Supported languages]. + // + // [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_CreateBot.go b/service/lexmodelsv2/api_op_CreateBot.go index 551789c3e69..b2cad313831 100644 --- a/service/lexmodelsv2/api_op_CreateBot.go +++ b/service/lexmodelsv2/api_op_CreateBot.go @@ -43,10 +43,13 @@ type CreateBotInput struct { DataPrivacy *types.DataPrivacy // The time, in seconds, that Amazon Lex should keep information about a user's - // conversation with the bot. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Lex deletes any data provided before the timeout. You can specify - // between 60 (1 minute) and 86,400 (24 hours) seconds. + // conversation with the bot. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Lex deletes + // any data provided before the timeout. + // + // You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. // // This member is required. IdleSessionTTLInSeconds *int32 diff --git a/service/lexmodelsv2/api_op_CreateBotAlias.go b/service/lexmodelsv2/api_op_CreateBotAlias.go index 889a8a88bf6..c1737d9ff56 100644 --- a/service/lexmodelsv2/api_op_CreateBotAlias.go +++ b/service/lexmodelsv2/api_op_CreateBotAlias.go @@ -14,8 +14,9 @@ import ( // Creates an alias for the specified version of a bot. Use an alias to enable you // to change the version of a bot without updating applications that use the bot. -// For example, you can create an alias called "PROD" that your applications use to -// call the Amazon Lex bot. +// +// For example, you can create an alias called "PROD" that your applications use +// to call the Amazon Lex bot. func (c *Client) CreateBotAlias(ctx context.Context, params *CreateBotAliasInput, optFns ...func(*Options)) (*CreateBotAliasOutput, error) { if params == nil { params = &CreateBotAliasInput{} @@ -48,8 +49,10 @@ 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) - // operation to change the bot version associated with the alias. + // The version of the bot that this alias points to. You can use the [UpdateBotAlias] operation to + // change the bot version associated with the alias. + // + // [UpdateBotAlias]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html BotVersion *string // Specifies whether Amazon Lex logs text and audio for a conversation with the diff --git a/service/lexmodelsv2/api_op_CreateBotLocale.go b/service/lexmodelsv2/api_op_CreateBotLocale.go index 1d118bc6005..ff6a441deec 100644 --- a/service/lexmodelsv2/api_op_CreateBotLocale.go +++ b/service/lexmodelsv2/api_op_CreateBotLocale.go @@ -46,9 +46,9 @@ 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) - // . + // and slots used in the bot must have the same locale. For more information, see [Supported languages]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -56,14 +56,19 @@ type CreateBotLocaleInput struct { // 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 - // 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: + // 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 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 // // This member is required. @@ -89,13 +94,17 @@ type CreateBotLocaleOutput struct { // The specified bot identifier. BotId *string - // 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 - // 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 . + // 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 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 . BotLocaleStatus types.BotLocaleStatus // The specified bot version. diff --git a/service/lexmodelsv2/api_op_CreateExport.go b/service/lexmodelsv2/api_op_CreateExport.go index 088e70891c4..ceceb12f31e 100644 --- a/service/lexmodelsv2/api_op_CreateExport.go +++ b/service/lexmodelsv2/api_op_CreateExport.go @@ -14,10 +14,16 @@ import ( // Creates a zip archive containing the contents of a bot or a bot locale. The // archive contains a directory structure that contains JSON files that define the -// 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) +// 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] +// +// [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{} @@ -62,9 +68,10 @@ 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] // operation to get the pre-signed S3 URL link to your exported bot or bot locale. + // + // [DescribeExport]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html ExportStatus types.ExportStatus // The file format used for the bot or bot locale definition files. diff --git a/service/lexmodelsv2/api_op_CreateIntent.go b/service/lexmodelsv2/api_op_CreateIntent.go index d6f26a9281d..d023271a6f9 100644 --- a/service/lexmodelsv2/api_op_CreateIntent.go +++ b/service/lexmodelsv2/api_op_CreateIntent.go @@ -12,23 +12,33 @@ import ( "time" ) -// 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: +// 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?" func (c *Client) CreateIntent(ctx context.Context, params *CreateIntentInput, optFns ...func(*Options)) (*CreateIntentOutput, error) { @@ -66,8 +76,9 @@ 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]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -77,8 +88,9 @@ type CreateIntentInput struct { 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 - // example, suppose that your bot determines that the user's name is John. You + // 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 @@ -88,9 +100,11 @@ type CreateIntentInput struct { // Specifies that Amazon Lex invokes the alias Lambda function when the intent is // ready for fulfillment. You can invoke this function to complete the bot's - // transaction with the user. For example, in a pizza ordering bot, the Lambda - // function can look up the closest pizza restaurant to the customer's location and - // then place an order on the customer's behalf. + // transaction with the user. + // + // For example, in a pizza ordering bot, the Lambda function can look up the + // closest pizza restaurant to the customer's location and then place an order on + // the customer's behalf. FulfillmentCodeHook *types.FulfillmentCodeHookSettings // Configuration settings for the response that is sent to the user at the @@ -98,14 +112,21 @@ type CreateIntentInput struct { InitialResponseSetting *types.InitialResponseSetting // A list of contexts that must be active for this intent to be considered by - // Amazon Lex. When an intent has an input context list, Amazon Lex only considers - // using the intent in an interaction with the user when the specified contexts are - // included in the active context list for the session. If the contexts are not - // active, then Amazon Lex will not use the intent. A context can be automatically - // activated using the outputContexts property or it can be set at runtime. For - // example, if there are two intents with different input contexts that respond to - // the same utterances, only the intent with the active context will respond. An - // intent may have up to 5 input contexts. If an intent has multiple input + // Amazon Lex. + // + // When an intent has an input context list, Amazon Lex only considers using the + // intent in an interaction with the user when the specified contexts are included + // in the active context list for the session. If the contexts are not active, then + // Amazon Lex will not use the intent. + // + // A context can be automatically activated using the outputContexts property or + // it can be set at runtime. + // + // For example, if there are two intents with different input contexts that + // respond to the same utterances, only the intent with the active context will + // respond. + // + // An intent may have up to 5 input contexts. If an intent has multiple input // contexts, all of the contexts must be active to consider the intent. InputContexts []types.InputContext @@ -122,13 +143,15 @@ type CreateIntentInput struct { // called when Amazon Lex can't determine another intent to invoke. KendraConfiguration *types.KendraConfiguration - // A lists of contexts that the intent activates when it is fulfilled. You can use - // an output context to indicate the intents that Amazon Lex should consider for - // the next turn of the conversation with a customer. When you use the - // outputContextsList property, all of the contexts specified in the list are - // activated when the intent is fulfilled. You can set up to 10 output contexts. - // You can also set the number of conversation turns that the context should be - // active, or the length of time that the context should be active. + // A lists of contexts that the intent activates when it is fulfilled. + // + // You can use an output context to indicate the intents that Amazon Lex should + // consider for the next turn of the conversation with a customer. + // + // When you use the outputContextsList property, all of the contexts specified in + // the list are activated when the intent is fulfilled. You can set up to 10 output + // contexts. You can also set the number of conversation turns that the context + // should be active, or the length of time that the context should be active. OutputContexts []types.OutputContext // A unique identifier for the built-in intent to base this intent on. @@ -141,9 +164,10 @@ type CreateIntentInput struct { QnAIntentConfiguration *types.QnAIntentConfiguration // An array of strings that a user might say to signal the intent. For example, "I - // want a pizza", or "I want a {PizzaSize} pizza". In an utterance, slot names are - // enclosed in curly braces ("{", "}") to indicate where they should be displayed - // in the utterance shown to the user.. + // want a pizza", or "I want a {PizzaSize} pizza". + // + // In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate + // where they should be displayed in the utterance shown to the user.. SampleUtterances []types.SampleUtterance noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_CreateResourcePolicy.go b/service/lexmodelsv2/api_op_CreateResourcePolicy.go index 11e55f7d0d8..544134e9dcc 100644 --- a/service/lexmodelsv2/api_op_CreateResourcePolicy.go +++ b/service/lexmodelsv2/api_op_CreateResourcePolicy.go @@ -31,8 +31,11 @@ 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]. + // + // If the policy isn't valid, Amazon Lex returns a validation exception. + // + // [IAM JSON policy reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html // // This member is required. Policy *string diff --git a/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go b/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go index 956d803966b..24c994b572b 100644 --- a/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go +++ b/service/lexmodelsv2/api_op_CreateResourcePolicyStatement.go @@ -13,8 +13,9 @@ import ( // 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. +// 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{} @@ -33,9 +34,9 @@ func (c *Client) CreateResourcePolicyStatement(ctx context.Context, params *Crea 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) - // . + // apply to the resource type of the specified ARN. For more information, see [Actions, resources, and condition keys for Amazon Lex V2]. + // + // [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 +48,9 @@ type CreateResourcePolicyStatementInput struct { // An IAM principal, such as an IAM user, IAM role, or Amazon Web Services // services that is allowed or denied access to a resource. For more information, - // see Amazon Web Services JSON policy elements: Principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) - // . + // see [Amazon Web Services JSON policy elements: Principal]. + // + // [Amazon Web Services JSON policy elements: Principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html // // This member is required. Principal []types.Principal @@ -60,9 +62,9 @@ type CreateResourcePolicyStatementInput struct { ResourceArn *string // 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) - // . + // statement name must be unique within the policy. For more information, see [IAM JSON policy elements: Sid]. + // + // [IAM JSON policy elements: Sid]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html // // This member is required. StatementId *string @@ -70,14 +72,18 @@ 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]. + // + // [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 - // doesn't match the current revision ID, Amazon Lex throws an exception. If you - // don't specify a revision, Amazon Lex overwrites the contents of the policy with - // the new values. + // doesn't match the current revision ID, Amazon Lex throws an exception. + // + // If you don't specify a revision, Amazon Lex overwrites the contents of the + // policy with the new values. ExpectedRevisionId *string noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_CreateSlot.go b/service/lexmodelsv2/api_op_CreateSlot.go index a4c633c2c0f..e3b69d2354a 100644 --- a/service/lexmodelsv2/api_op_CreateSlot.go +++ b/service/lexmodelsv2/api_op_CreateSlot.go @@ -50,9 +50,9 @@ 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) - // . + // types used by the slot must have the same locale. For more information, see [Supported languages]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -74,14 +74,17 @@ 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 - // in the log output. The default is to obfuscate values in the CloudWatch logs. + // 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 diff --git a/service/lexmodelsv2/api_op_CreateSlotType.go b/service/lexmodelsv2/api_op_CreateSlotType.go index f647e99ddfd..119660760ad 100644 --- a/service/lexmodelsv2/api_op_CreateSlotType.go +++ b/service/lexmodelsv2/api_op_CreateSlotType.go @@ -12,9 +12,10 @@ import ( "time" ) -// Creates a custom slot type To create a custom slot type, specify a name for the -// slot type and a set of enumeration values, the values that a slot of this type -// can assume. +// Creates a custom slot type +// +// To create a custom slot type, specify a name for the slot type and a set of +// enumeration values, the values that a slot of this type can assume. func (c *Client) CreateSlotType(ctx context.Context, params *CreateSlotTypeInput, optFns ...func(*Options)) (*CreateSlotTypeOutput, error) { if params == nil { params = &CreateSlotTypeInput{} @@ -45,8 +46,9 @@ 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]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -68,7 +70,9 @@ type CreateSlotTypeInput struct { // The built-in slot type used as a parent of this slot type. When you define a // parent slot type, the new slot type has the configuration of the parent slot - // type. Only AMAZON.AlphaNumeric is supported. + // type. + // + // Only AMAZON.AlphaNumeric is supported. ParentSlotTypeSignature *string // A list of SlotTypeValue objects that defines the values that the slot type can @@ -78,8 +82,10 @@ 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: + // // - 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. If there is no resolution list, return null. // diff --git a/service/lexmodelsv2/api_op_CreateUploadUrl.go b/service/lexmodelsv2/api_op_CreateUploadUrl.go index 0169fddc7ae..97941d83061 100644 --- a/service/lexmodelsv2/api_op_CreateUploadUrl.go +++ b/service/lexmodelsv2/api_op_CreateUploadUrl.go @@ -33,8 +33,9 @@ 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) - // operation. + // An identifier for a unique import job. Use it when you call the [StartImport] operation. + // + // [StartImport]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html ImportId *string // A pre-signed S3 write URL. Upload the zip archive file that contains the diff --git a/service/lexmodelsv2/api_op_DeleteBot.go b/service/lexmodelsv2/api_op_DeleteBot.go index 67c1c22a335..4019131ac91 100644 --- a/service/lexmodelsv2/api_op_DeleteBot.go +++ b/service/lexmodelsv2/api_op_DeleteBot.go @@ -12,10 +12,13 @@ import ( ) // 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 +// 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) { diff --git a/service/lexmodelsv2/api_op_DeleteBotLocale.go b/service/lexmodelsv2/api_op_DeleteBotLocale.go index 4886b584bf9..830936e6d3c 100644 --- a/service/lexmodelsv2/api_op_DeleteBotLocale.go +++ b/service/lexmodelsv2/api_op_DeleteBotLocale.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes a locale from a bot. When you delete a locale, all intents, slots, and -// slot types defined for the locale are also deleted. +// Removes a locale from a bot. +// +// When you delete a locale, all intents, slots, and slot types defined for the +// locale are also deleted. func (c *Client) DeleteBotLocale(ctx context.Context, params *DeleteBotLocaleInput, optFns ...func(*Options)) (*DeleteBotLocaleOutput, error) { if params == nil { params = &DeleteBotLocaleInput{} @@ -41,8 +43,9 @@ type DeleteBotLocaleInput struct { BotVersion *string // 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) . + // match one of the supported locales. For more information, see [Supported languages]. + // + // [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_DeleteBotVersion.go b/service/lexmodelsv2/api_op_DeleteBotVersion.go index 4571f93adeb..5ca66c39dc1 100644 --- a/service/lexmodelsv2/api_op_DeleteBotVersion.go +++ b/service/lexmodelsv2/api_op_DeleteBotVersion.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Deletes a specific version of a bot. To delete all versions of a bot, use the [DeleteBot] // operation. +// +// [DeleteBot]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DeleteBot.html func (c *Client) DeleteBotVersion(ctx context.Context, params *DeleteBotVersionInput, optFns ...func(*Options)) (*DeleteBotVersionOutput, error) { if params == nil { params = &DeleteBotVersionInput{} diff --git a/service/lexmodelsv2/api_op_DeleteExport.go b/service/lexmodelsv2/api_op_DeleteExport.go index b1ff18c5a3b..47ff1aa1323 100644 --- a/service/lexmodelsv2/api_op_DeleteExport.go +++ b/service/lexmodelsv2/api_op_DeleteExport.go @@ -43,9 +43,11 @@ 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) - // operation with the export identifier will fail. + // will no longer be returned by the [ListExports]operation and calls to the [DescribeExport] operation with + // the export identifier will fail. + // + // [DescribeExport]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html + // [ListExports]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html ExportStatus types.ExportStatus // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_DeleteImport.go b/service/lexmodelsv2/api_op_DeleteImport.go index 3b4b69e960d..e2dfcd193ff 100644 --- a/service/lexmodelsv2/api_op_DeleteImport.go +++ b/service/lexmodelsv2/api_op_DeleteImport.go @@ -43,9 +43,11 @@ 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) - // operation with the import identifier will fail. + // will no longer be returned by the [ListImports]operation and calls to the [DescribeImport] operation with + // the import identifier will fail. + // + // [ListImports]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html + // [DescribeImport]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html ImportStatus types.ImportStatus // Metadata pertaining to the operation's result. diff --git a/service/lexmodelsv2/api_op_DeleteIntent.go b/service/lexmodelsv2/api_op_DeleteIntent.go index 754c5b9bb3b..6b1a9ea351d 100644 --- a/service/lexmodelsv2/api_op_DeleteIntent.go +++ b/service/lexmodelsv2/api_op_DeleteIntent.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified intent. Deleting an intent also deletes the slots -// associated with the intent. +// Removes the specified intent. +// +// Deleting an intent also deletes the slots associated with the intent. func (c *Client) DeleteIntent(ctx context.Context, params *DeleteIntentInput, optFns ...func(*Options)) (*DeleteIntentOutput, error) { if params == nil { params = &DeleteIntentInput{} @@ -45,9 +46,9 @@ type DeleteIntentInput struct { IntentId *string // 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) - // . + // string must match one of the supported locales. For more information, see [Supported languages]. + // + // [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 8b06217007f..a3dc4dc6ff8 100644 --- a/service/lexmodelsv2/api_op_DeleteResourcePolicy.go +++ b/service/lexmodelsv2/api_op_DeleteResourcePolicy.go @@ -36,8 +36,9 @@ type DeleteResourcePolicyInput struct { ResourceArn *string // The identifier of the revision to edit. If this ID doesn't match the current - // revision number, Amazon Lex returns an exception If you don't specify a revision - // ID, Amazon Lex will delete the current policy. + // revision number, Amazon Lex returns an exception + // + // If you don't specify a revision ID, Amazon Lex will delete the current policy. ExpectedRevisionId *string noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_DeleteResourcePolicyStatement.go b/service/lexmodelsv2/api_op_DeleteResourcePolicyStatement.go index f49210578ba..90dff2fc56d 100644 --- a/service/lexmodelsv2/api_op_DeleteResourcePolicyStatement.go +++ b/service/lexmodelsv2/api_op_DeleteResourcePolicyStatement.go @@ -44,8 +44,10 @@ type DeleteResourcePolicyStatementInput struct { // The identifier of the revision of the policy to delete the statement from. If // this revision ID doesn't match the current revision ID, Amazon Lex throws an - // exception. If you don't specify a revision, Amazon Lex removes the current - // contents of the statement. + // exception. + // + // If you don't specify a revision, Amazon Lex removes the current contents of the + // statement. ExpectedRevisionId *string noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_DeleteSlot.go b/service/lexmodelsv2/api_op_DeleteSlot.go index a6153aa95b6..0ef63efb547 100644 --- a/service/lexmodelsv2/api_op_DeleteSlot.go +++ b/service/lexmodelsv2/api_op_DeleteSlot.go @@ -44,9 +44,9 @@ type DeleteSlotInput struct { IntentId *string // 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) - // . + // The string must match one of the supported locales. For more information, see [Supported languages]. + // + // [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 60aac665e12..d4224458782 100644 --- a/service/lexmodelsv2/api_op_DeleteSlotType.go +++ b/service/lexmodelsv2/api_op_DeleteSlotType.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . func (c *Client) DeleteSlotType(ctx context.Context, params *DeleteSlotTypeInput, optFns ...func(*Options)) (*DeleteSlotTypeOutput, error) { if params == nil { params = &DeleteSlotTypeInput{} @@ -42,8 +44,9 @@ 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]. + // + // [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 958e1b8db18..51d451396f2 100644 --- a/service/lexmodelsv2/api_op_DeleteUtterances.go +++ b/service/lexmodelsv2/api_op_DeleteUtterances.go @@ -10,15 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// operation, utterances stored for improving your bot's ability to respond to user -// input are deleted immediately. Utterances stored for use with the -// ListAggregatedUtterances operation are deleted after 15 days. +// 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]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 operation, utterances stored for +// improving your bot's ability to respond to user input are deleted immediately. +// Utterances stored for use with the ListAggregatedUtterances operation are +// deleted after 15 days. +// +// [ListAggregatedUtterances]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html func (c *Client) DeleteUtterances(ctx context.Context, params *DeleteUtterancesInput, optFns ...func(*Options)) (*DeleteUtterancesOutput, error) { if params == nil { params = &DeleteUtterancesInput{} @@ -42,15 +46,16 @@ type DeleteUtterancesInput struct { BotId *string // 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) - // . + // The string must match one of the supported locales. For more information, see [Supported languages]. + // + // [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) - // operations. + // response from the [RecognizeText]and [RecognizeUtterance] operations. + // + // [RecognizeUtterance]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html + // [RecognizeText]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html SessionId *string noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_DescribeBot.go b/service/lexmodelsv2/api_op_DescribeBot.go index 91192506449..beec51d143f 100644 --- a/service/lexmodelsv2/api_op_DescribeBot.go +++ b/service/lexmodelsv2/api_op_DescribeBot.go @@ -207,12 +207,13 @@ type BotAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBotInput, *DescribeBotOutput, error) (bool, error) } diff --git a/service/lexmodelsv2/api_op_DescribeBotAlias.go b/service/lexmodelsv2/api_op_DescribeBotAlias.go index 132e30ec682..08081142eba 100644 --- a/service/lexmodelsv2/api_op_DescribeBotAlias.go +++ b/service/lexmodelsv2/api_op_DescribeBotAlias.go @@ -216,12 +216,13 @@ type BotAliasAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBotAliasInput, *DescribeBotAliasOutput, error) (bool, error) } diff --git a/service/lexmodelsv2/api_op_DescribeBotLocale.go b/service/lexmodelsv2/api_op_DescribeBotLocale.go index d0e54526860..bd736129937 100644 --- a/service/lexmodelsv2/api_op_DescribeBotLocale.go +++ b/service/lexmodelsv2/api_op_DescribeBotLocale.go @@ -44,8 +44,9 @@ 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]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -237,12 +238,13 @@ type BotLocaleBuiltWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBotLocaleInput, *DescribeBotLocaleOutput, error) (bool, error) } @@ -460,12 +462,13 @@ type BotLocaleCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBotLocaleInput, *DescribeBotLocaleOutput, error) (bool, error) } @@ -703,12 +706,13 @@ type BotLocaleExpressTestingAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBotLocaleInput, *DescribeBotLocaleOutput, error) (bool, error) } diff --git a/service/lexmodelsv2/api_op_DescribeBotRecommendation.go b/service/lexmodelsv2/api_op_DescribeBotRecommendation.go index c7ca33a806b..55398a0e9b2 100644 --- a/service/lexmodelsv2/api_op_DescribeBotRecommendation.go +++ b/service/lexmodelsv2/api_op_DescribeBotRecommendation.go @@ -50,8 +50,9 @@ type DescribeBotRecommendationInput struct { // 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) - // . + // information, see [Supported languages]. + // + // [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_DescribeBotVersion.go b/service/lexmodelsv2/api_op_DescribeBotVersion.go index 7216c119dc6..6bd983b11dd 100644 --- a/service/lexmodelsv2/api_op_DescribeBotVersion.go +++ b/service/lexmodelsv2/api_op_DescribeBotVersion.go @@ -219,12 +219,13 @@ type BotVersionAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBotVersionInput, *DescribeBotVersionOutput, error) (bool, error) } diff --git a/service/lexmodelsv2/api_op_DescribeExport.go b/service/lexmodelsv2/api_op_DescribeExport.go index 0c441d78c26..211d4d259b1 100644 --- a/service/lexmodelsv2/api_op_DescribeExport.go +++ b/service/lexmodelsv2/api_op_DescribeExport.go @@ -195,12 +195,13 @@ type BotExportCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeExportInput, *DescribeExportOutput, error) (bool, error) } diff --git a/service/lexmodelsv2/api_op_DescribeImport.go b/service/lexmodelsv2/api_op_DescribeImport.go index 0a4dcd990ab..6b209a5551d 100644 --- a/service/lexmodelsv2/api_op_DescribeImport.go +++ b/service/lexmodelsv2/api_op_DescribeImport.go @@ -200,12 +200,13 @@ type BotImportCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImportInput, *DescribeImportOutput, error) (bool, error) } diff --git a/service/lexmodelsv2/api_op_DescribeIntent.go b/service/lexmodelsv2/api_op_DescribeIntent.go index 81650146385..e3d3144ae1c 100644 --- a/service/lexmodelsv2/api_op_DescribeIntent.go +++ b/service/lexmodelsv2/api_op_DescribeIntent.go @@ -46,8 +46,9 @@ type DescribeIntentInput struct { IntentId *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_DescribeResourcePolicy.go b/service/lexmodelsv2/api_op_DescribeResourcePolicy.go index d919133d6d6..25af138151a 100644 --- a/service/lexmodelsv2/api_op_DescribeResourcePolicy.go +++ b/service/lexmodelsv2/api_op_DescribeResourcePolicy.go @@ -40,8 +40,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) - // . + // about the contents of a JSON policy document, see [IAM JSON policy reference]. + // + // [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 cfac3096f1e..1a36fcc2825 100644 --- a/service/lexmodelsv2/api_op_DescribeSlot.go +++ b/service/lexmodelsv2/api_op_DescribeSlot.go @@ -46,8 +46,9 @@ type DescribeSlotInput struct { IntentId *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -83,8 +84,9 @@ 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 , diff --git a/service/lexmodelsv2/api_op_DescribeSlotType.go b/service/lexmodelsv2/api_op_DescribeSlotType.go index edd1a77524a..72fbaca3a40 100644 --- a/service/lexmodelsv2/api_op_DescribeSlotType.go +++ b/service/lexmodelsv2/api_op_DescribeSlotType.go @@ -41,9 +41,9 @@ type DescribeSlotTypeInput struct { BotVersion *string // 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) - // . + // string must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_DescribeTestSetGeneration.go b/service/lexmodelsv2/api_op_DescribeTestSetGeneration.go index 883029edf04..79446790edb 100644 --- a/service/lexmodelsv2/api_op_DescribeTestSetGeneration.go +++ b/service/lexmodelsv2/api_op_DescribeTestSetGeneration.go @@ -55,7 +55,7 @@ type DescribeTestSetGenerationOutput struct { // The date and time of the last update for the test set generation. LastUpdatedDateTime *time.Time - // The roleARN of the test set used for the test set generation. + // The roleARN of the test set used for the test set generation. RoleArn *string // The Amazon S3 storage location for the test set generation. diff --git a/service/lexmodelsv2/api_op_ListAggregatedUtterances.go b/service/lexmodelsv2/api_op_ListAggregatedUtterances.go index 395ecb386b0..8e713fcb7d7 100644 --- a/service/lexmodelsv2/api_op_ListAggregatedUtterances.go +++ b/service/lexmodelsv2/api_op_ListAggregatedUtterances.go @@ -12,17 +12,26 @@ import ( "time" ) -// Provides a list of utterances that users have sent to the bot. Utterances are -// aggregated by the text of the utterance. For example, all instances where -// customers used the phrase "I want to order pizza" are aggregated into the same -// line in the response. You can see both detected utterances and missed -// utterances. A detected utterance is where the bot properly recognized the -// utterance and activated the associated intent. A missed utterance was not -// 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. +// Provides a list of utterances that users have sent to the bot. +// +// Utterances are aggregated by the text of the utterance. For example, all +// instances where customers used the phrase "I want to order pizza" are aggregated +// into the same line in the response. +// +// You can see both detected utterances and missed utterances. A detected +// utterance is where the bot properly recognized the utterance and activated the +// associated intent. A missed utterance was not 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. func (c *Client) ListAggregatedUtterances(ctx context.Context, params *ListAggregatedUtterancesInput, optFns ...func(*Options)) (*ListAggregatedUtterancesOutput, error) { if params == nil { @@ -53,8 +62,9 @@ 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]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -104,8 +114,11 @@ 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 AggregationLastRefreshedDateTime *time.Time diff --git a/service/lexmodelsv2/api_op_ListBotVersions.go b/service/lexmodelsv2/api_op_ListBotVersions.go index 1a72af408ee..8eb399f1b1e 100644 --- a/service/lexmodelsv2/api_op_ListBotVersions.go +++ b/service/lexmodelsv2/api_op_ListBotVersions.go @@ -11,11 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about all of the versions of a bot. The ListBotVersions -// operation returns a summary of each version of a bot. For example, if a bot has -// three numbered versions, the ListBotVersions operation returns for summaries, -// one for each numbered version and one for the DRAFT version. The ListBotVersions -// operation always returns at least one version, the DRAFT version. +// Gets information about all of the versions of a bot. +// +// The ListBotVersions operation returns a summary of each version of a bot. For +// example, if a bot has three numbered versions, the ListBotVersions operation +// returns for summaries, one for each numbered version and one for the DRAFT +// version. +// +// The ListBotVersions operation always returns at least one version, the DRAFT +// version. func (c *Client) ListBotVersions(ctx context.Context, params *ListBotVersionsInput, optFns ...func(*Options)) (*ListBotVersionsOutput, error) { if params == nil { params = &ListBotVersionsInput{} diff --git a/service/lexmodelsv2/api_op_ListBots.go b/service/lexmodelsv2/api_op_ListBots.go index 2a21ce3cf97..b718d21b9a1 100644 --- a/service/lexmodelsv2/api_op_ListBots.go +++ b/service/lexmodelsv2/api_op_ListBots.go @@ -40,10 +40,11 @@ type ListBotsInput struct { 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. + // 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 diff --git a/service/lexmodelsv2/api_op_ListBuiltInIntents.go b/service/lexmodelsv2/api_op_ListBuiltInIntents.go index bf203e6630b..66546775f4a 100644 --- a/service/lexmodelsv2/api_op_ListBuiltInIntents.go +++ b/service/lexmodelsv2/api_op_ListBuiltInIntents.go @@ -12,10 +12,13 @@ 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 +// 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]. +// +// [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{} @@ -34,8 +37,9 @@ func (c *Client) ListBuiltInIntents(ctx context.Context, params *ListBuiltInInte 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_ListBuiltInSlotTypes.go b/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go index bab03c02582..340f4e2c90a 100644 --- a/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go +++ b/service/lexmodelsv2/api_op_ListBuiltInSlotTypes.go @@ -30,8 +30,9 @@ func (c *Client) ListBuiltInSlotTypes(ctx context.Context, params *ListBuiltInSl 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_ListCustomVocabularyItems.go b/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go index 619eea1414b..ae3c8226c29 100644 --- a/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go +++ b/service/lexmodelsv2/api_op_ListCustomVocabularyItems.go @@ -69,9 +69,9 @@ type ListCustomVocabularyItemsOutput struct { CustomVocabularyItems []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) - // . + // The string must match one of the supported locales. For more information, see [Supported Languages]. + // + // [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 4da437befd7..5239b72340f 100644 --- a/service/lexmodelsv2/api_op_ListExports.go +++ b/service/lexmodelsv2/api_op_ListExports.go @@ -52,8 +52,9 @@ type ListExportsInput struct { MaxResults *int32 // 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 + // 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. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListImports.go b/service/lexmodelsv2/api_op_ListImports.go index 46e6c9f72d1..180b362d606 100644 --- a/service/lexmodelsv2/api_op_ListImports.go +++ b/service/lexmodelsv2/api_op_ListImports.go @@ -52,8 +52,9 @@ type ListImportsInput struct { MaxResults *int32 // 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 + // 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. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListIntentMetrics.go b/service/lexmodelsv2/api_op_ListIntentMetrics.go index 8b872842da7..1e879b0717f 100644 --- a/service/lexmodelsv2/api_op_ListIntentMetrics.go +++ b/service/lexmodelsv2/api_op_ListIntentMetrics.go @@ -14,24 +14,29 @@ import ( // Retrieves summary metrics for the intents in your bot. The following fields are // required: -// - metrics – A list of AnalyticsIntentMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentMetric.html) -// objects. In each object, use the name field to specify the metric to -// calculate, the statistic field to specify whether to calculate the Sum , -// Average , or Max number, and the order field to specify whether to sort the -// results in Ascending or Descending order. +// +// - metrics – A list of [AnalyticsIntentMetric]objects. In each object, use the name field to specify +// the metric to calculate, the statistic field to specify whether to calculate +// the Sum , Average , or Max number, and the order field to specify whether to +// sort the results in Ascending or Descending order. +// // - startDateTime and endDateTime – Define a time range for which you want to // retrieve results. // // Of the optional fields, you can organize the results in the following ways: +// // - Use the filters field to filter the results, the groupBy field to specify // categories by which to group the results, and the binBy field to specify time // intervals by which to group the results. +// // - Use the maxResults field to limit the number of results to return in a // single response and the nextToken field to return the next batch of results if // the response does not return the full set of results. // // Note that an order field exists in both binBy and metrics . You can specify only // one order in a given request. +// +// [AnalyticsIntentMetric]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentMetric.html func (c *Client) ListIntentMetrics(ctx context.Context, params *ListIntentMetricsInput, optFns ...func(*Options)) (*ListIntentMetricsOutput, error) { if params == nil { params = &ListIntentMetricsInput{} @@ -83,10 +88,13 @@ type ListIntentMetricsInput struct { // A list of objects, each of which specifies how to group the results. You can // group by the following criteria: + // // - IntentName – The name of the intent. + // // - IntentEndState – The final state of the intent. The possible end states are - // detailed in Key definitions (https://docs.aws.amazon.com/analytics-key-definitions-intents) - // in the user guide. + // detailed in [Key definitions]in the user guide. + // + // [Key definitions]: https://docs.aws.amazon.com/analytics-key-definitions-intents GroupBy []types.AnalyticsIntentGroupBySpecification // The maximum number of results to return in each page of results. If there are @@ -95,10 +103,11 @@ type ListIntentMetricsInput struct { MaxResults *int32 // If the response from the ListIntentMetrics 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 ListIntentMetrics request to - // return the next page of results. For a complete set of results, call the - // ListIntentMetrics operation until the nextToken returned in the response is + // specified in the maxResults parameter, a token is returned in the response. + // + // Use the returned token in the nextToken parameter of a ListIntentMetrics + // request to return the next page of results. For a complete set of results, call + // the ListIntentMetrics operation until the nextToken returned in the response is // null. NextToken *string @@ -111,10 +120,11 @@ type ListIntentMetricsOutput struct { BotId *string // If the response from the ListIntentMetrics 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 ListIntentMetrics request to - // return the next page of results. For a complete set of results, call the - // ListIntentMetrics operation until the nextToken returned in the response is + // specified in the maxResults parameter, a token is returned in the response. + // + // Use the returned token in the nextToken parameter of a ListIntentMetrics + // request to return the next page of results. For a complete set of results, call + // the ListIntentMetrics operation until the nextToken returned in the response is // null. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListIntentPaths.go b/service/lexmodelsv2/api_op_ListIntentPaths.go index 852cfb50eb8..f83af203f15 100644 --- a/service/lexmodelsv2/api_op_ListIntentPaths.go +++ b/service/lexmodelsv2/api_op_ListIntentPaths.go @@ -14,8 +14,10 @@ import ( // Retrieves summary statistics for a path of intents that users take over // sessions with your bot. The following fields are required: +// // - startDateTime and endDateTime – Define a time range for which you want to // retrieve results. +// // - intentPath – Define an order of intents for which you want to retrieve // metrics. Separate intents in the path with a forward slash. For example, // populate the intentPath field with /BookCar/BookHotel to see details about how @@ -52,8 +54,11 @@ type ListIntentPathsInput struct { // The intent path for which you want to retrieve metrics. Use a forward slash to // separate intents in the path. For example: + // // - /BookCar + // // - /BookCar/BookHotel + // // - /BookHotel/BookCar // // This member is required. diff --git a/service/lexmodelsv2/api_op_ListIntentStageMetrics.go b/service/lexmodelsv2/api_op_ListIntentStageMetrics.go index 3f4dc64745c..995e2681354 100644 --- a/service/lexmodelsv2/api_op_ListIntentStageMetrics.go +++ b/service/lexmodelsv2/api_op_ListIntentStageMetrics.go @@ -14,24 +14,29 @@ import ( // Retrieves summary metrics for the stages within intents in your bot. The // following fields are required: -// - metrics – A list of AnalyticsIntentStageMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageMetric.html) -// objects. In each object, use the name field to specify the metric to -// calculate, the statistic field to specify whether to calculate the Sum , -// Average , or Max number, and the order field to specify whether to sort the -// results in Ascending or Descending order. +// +// - metrics – A list of [AnalyticsIntentStageMetric]objects. In each object, use the name field to specify +// the metric to calculate, the statistic field to specify whether to calculate +// the Sum , Average , or Max number, and the order field to specify whether to +// sort the results in Ascending or Descending order. +// // - startDateTime and endDateTime – Define a time range for which you want to // retrieve results. // // Of the optional fields, you can organize the results in the following ways: +// // - Use the filters field to filter the results, the groupBy field to specify // categories by which to group the results, and the binBy field to specify time // intervals by which to group the results. +// // - Use the maxResults field to limit the number of results to return in a // single response and the nextToken field to return the next batch of results if // the response does not return the full set of results. // // Note that an order field exists in both binBy and metrics . You can only specify // one order in a given request. +// +// [AnalyticsIntentStageMetric]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageMetric.html func (c *Client) ListIntentStageMetrics(ctx context.Context, params *ListIntentStageMetricsInput, optFns ...func(*Options)) (*ListIntentStageMetricsOutput, error) { if params == nil { params = &ListIntentStageMetricsInput{} @@ -83,7 +88,9 @@ type ListIntentStageMetricsInput struct { // A list of objects, each of which specifies how to group the results. You can // group by the following criteria: + // // - IntentStageName – The name of the intent stage. + // // - SwitchedToIntent – The intent to which the conversation was switched (if // any). GroupBy []types.AnalyticsIntentStageGroupBySpecification @@ -95,6 +102,7 @@ type ListIntentStageMetricsInput struct { // If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics // request to return the next page of results. For a complete set of results, call // the ListIntentStageMetrics operation until the nextToken returned in the @@ -111,6 +119,7 @@ type ListIntentStageMetricsOutput struct { // If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics // request to return the next page of results. For a complete set of results, call // the ListIntentStageMetrics operation until the nextToken returned in the diff --git a/service/lexmodelsv2/api_op_ListIntents.go b/service/lexmodelsv2/api_op_ListIntents.go index 37da9ae8826..09467452abd 100644 --- a/service/lexmodelsv2/api_op_ListIntents.go +++ b/service/lexmodelsv2/api_op_ListIntents.go @@ -40,8 +40,9 @@ type ListIntentsInput struct { BotVersion *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -57,8 +58,9 @@ type ListIntentsInput struct { MaxResults *int32 // 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 + // 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. NextToken *string diff --git a/service/lexmodelsv2/api_op_ListRecommendedIntents.go b/service/lexmodelsv2/api_op_ListRecommendedIntents.go index 8b0fec37a0e..926daea22b6 100644 --- a/service/lexmodelsv2/api_op_ListRecommendedIntents.go +++ b/service/lexmodelsv2/api_op_ListRecommendedIntents.go @@ -75,8 +75,9 @@ type ListRecommendedIntentsOutput struct { BotVersion *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [Supported 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 diff --git a/service/lexmodelsv2/api_op_ListSessionAnalyticsData.go b/service/lexmodelsv2/api_op_ListSessionAnalyticsData.go index 756cbaf815f..deecef8957b 100644 --- a/service/lexmodelsv2/api_op_ListSessionAnalyticsData.go +++ b/service/lexmodelsv2/api_op_ListSessionAnalyticsData.go @@ -16,8 +16,10 @@ import ( // startDateTime and endDateTime fields are required. These fields define a time // range for which you want to retrieve results. Of the optional fields, you can // organize the results in the following ways: +// // - Use the filters field to filter the results and the sortBy field to specify // the values by which to sort the results. +// // - Use the maxResults field to limit the number of results to return in a // single response and the nextToken field to return the next batch of results if // the response does not return the full set of results. @@ -66,10 +68,12 @@ type ListSessionAnalyticsDataInput struct { // If the response from the ListSessionAnalyticsData 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 - // ListSessionAnalyticsData request to return the next page of results. For a - // complete set of results, call the ListSessionAnalyticsData operation until the - // nextToken returned in the response is null. + // response. + // + // Use the returned token in the nextToken parameter of a ListSessionAnalyticsData + // request to return the next page of results. For a complete set of results, call + // the ListSessionAnalyticsData operation until the nextToken returned in the + // response is null. NextToken *string // An object specifying the measure and method by which to sort the session @@ -86,10 +90,12 @@ type ListSessionAnalyticsDataOutput struct { // If the response from the ListSessionAnalyticsData 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 - // ListSessionAnalyticsData request to return the next page of results. For a - // complete set of results, call the ListSessionAnalyticsData operation until the - // nextToken returned in the response is null. + // response. + // + // Use the returned token in the nextToken parameter of a ListSessionAnalyticsData + // request to return the next page of results. For a complete set of results, call + // the ListSessionAnalyticsData operation until the nextToken returned in the + // response is null. NextToken *string // A list of objects, each of which contains information about a session with the diff --git a/service/lexmodelsv2/api_op_ListSessionMetrics.go b/service/lexmodelsv2/api_op_ListSessionMetrics.go index 5c8ca9b04bf..d96497fab0a 100644 --- a/service/lexmodelsv2/api_op_ListSessionMetrics.go +++ b/service/lexmodelsv2/api_op_ListSessionMetrics.go @@ -14,24 +14,29 @@ import ( // Retrieves summary metrics for the user sessions with your bot. The following // fields are required: -// - metrics – A list of AnalyticsSessionMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionMetric.html) -// objects. In each object, use the name field to specify the metric to -// calculate, the statistic field to specify whether to calculate the Sum , -// Average , or Max number, and the order field to specify whether to sort the -// results in Ascending or Descending order. +// +// - metrics – A list of [AnalyticsSessionMetric]objects. In each object, use the name field to specify +// the metric to calculate, the statistic field to specify whether to calculate +// the Sum , Average , or Max number, and the order field to specify whether to +// sort the results in Ascending or Descending order. +// // - startDateTime and endDateTime – Define a time range for which you want to // retrieve results. // // Of the optional fields, you can organize the results in the following ways: +// // - Use the filters field to filter the results, the groupBy field to specify // categories by which to group the results, and the binBy field to specify time // intervals by which to group the results. +// // - Use the maxResults field to limit the number of results to return in a // single response and the nextToken field to return the next batch of results if // the response does not return the full set of results. // // Note that an order field exists in both binBy and metrics . Currently, you can // specify it in either field, but not in both. +// +// [AnalyticsSessionMetric]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionMetric.html func (c *Client) ListSessionMetrics(ctx context.Context, params *ListSessionMetricsInput, optFns ...func(*Options)) (*ListSessionMetricsOutput, error) { if params == nil { params = &ListSessionMetricsInput{} @@ -83,10 +88,13 @@ type ListSessionMetricsInput struct { // A list of objects, each of which specifies how to group the results. You can // group by the following criteria: + // // - ConversationEndState – The final state of the conversation. The possible end - // states are detailed in Key definitions (https://docs.aws.amazon.com/analytics-key-definitions-conversations) - // in the user guide. + // states are detailed in [Key definitions]in the user guide. + // // - LocaleId – The unique identifier of the bot locale. + // + // [Key definitions]: https://docs.aws.amazon.com/analytics-key-definitions-conversations GroupBy []types.AnalyticsSessionGroupBySpecification // The maximum number of results to return in each page of results. If there are @@ -96,6 +104,7 @@ type ListSessionMetricsInput struct { // If the response from the ListSessionMetrics 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 ListSessionMetrics // request to return the next page of results. For a complete set of results, call // the ListSessionMetrics operation until the nextToken returned in the response is @@ -112,6 +121,7 @@ type ListSessionMetricsOutput struct { // If the response from the ListSessionMetrics 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 ListSessionMetrics // request to return the next page of results. For a complete set of results, call // the ListSessionMetrics operation until the nextToken returned in the response is diff --git a/service/lexmodelsv2/api_op_ListSlotTypes.go b/service/lexmodelsv2/api_op_ListSlotTypes.go index b17c8bc0db1..27957e7ae43 100644 --- a/service/lexmodelsv2/api_op_ListSlotTypes.go +++ b/service/lexmodelsv2/api_op_ListSlotTypes.go @@ -40,8 +40,9 @@ type ListSlotTypesInput struct { BotVersion *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_ListSlots.go b/service/lexmodelsv2/api_op_ListSlots.go index be78d0a046d..56f3d18ab08 100644 --- a/service/lexmodelsv2/api_op_ListSlots.go +++ b/service/lexmodelsv2/api_op_ListSlots.go @@ -45,8 +45,9 @@ type ListSlotsInput struct { IntentId *string // 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) . + // match one of the supported locales. For more information, see [Supported languages]. + // + // [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_ListUtteranceAnalyticsData.go b/service/lexmodelsv2/api_op_ListUtteranceAnalyticsData.go index 64727e74c87..2538f5dbf91 100644 --- a/service/lexmodelsv2/api_op_ListUtteranceAnalyticsData.go +++ b/service/lexmodelsv2/api_op_ListUtteranceAnalyticsData.go @@ -12,21 +12,27 @@ import ( "time" ) -// To use this API operation, your IAM role must have permissions to perform the -// ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) -// operation, which provides access to utterance-related analytics. See Viewing -// utterance statistics (https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html) -// for the IAM policy to apply to the IAM role. Retrieves a list of metadata for -// individual user utterances to your bot. The following fields are required: +// To use this API operation, your IAM role must have permissions to perform the [ListAggregatedUtterances] +// operation, which provides access to utterance-related analytics. See [Viewing utterance statistics]for the +// IAM policy to apply to the IAM role. +// +// Retrieves a list of metadata for individual user utterances to your bot. The +// following fields are required: +// // - startDateTime and endDateTime – Define a time range for which you want to // retrieve results. // // Of the optional fields, you can organize the results in the following ways: +// // - Use the filters field to filter the results and the sortBy field to specify // the values by which to sort the results. +// // - Use the maxResults field to limit the number of results to return in a // single response and the nextToken field to return the next batch of results if // the response does not return the full set of results. +// +// [Viewing utterance statistics]: https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html +// [ListAggregatedUtterances]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html func (c *Client) ListUtteranceAnalyticsData(ctx context.Context, params *ListUtteranceAnalyticsDataInput, optFns ...func(*Options)) (*ListUtteranceAnalyticsDataOutput, error) { if params == nil { params = &ListUtteranceAnalyticsDataInput{} @@ -72,7 +78,9 @@ type ListUtteranceAnalyticsDataInput struct { // If the response from the ListUtteranceAnalyticsData 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 + // response. + // + // Use the returned token in the nextToken parameter of a // ListUtteranceAnalyticsData request to return the next page of results. For a // complete set of results, call the ListUtteranceAnalyticsData operation until the // nextToken returned in the response is null. @@ -92,7 +100,9 @@ type ListUtteranceAnalyticsDataOutput struct { // If the response from the ListUtteranceAnalyticsData 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 + // response. + // + // Use the returned token in the nextToken parameter of a // ListUtteranceAnalyticsData request to return the next page of results. For a // complete set of results, call the ListUtteranceAnalyticsData operation until the // nextToken returned in the response is null. diff --git a/service/lexmodelsv2/api_op_ListUtteranceMetrics.go b/service/lexmodelsv2/api_op_ListUtteranceMetrics.go index a4d7a3f7dd0..e7ee68e8ff7 100644 --- a/service/lexmodelsv2/api_op_ListUtteranceMetrics.go +++ b/service/lexmodelsv2/api_op_ListUtteranceMetrics.go @@ -12,30 +12,37 @@ import ( "time" ) -// To use this API operation, your IAM role must have permissions to perform the -// ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) -// operation, which provides access to utterance-related analytics. See Viewing -// utterance statistics (https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html) -// for the IAM policy to apply to the IAM role. Retrieves summary metrics for the -// utterances in your bot. The following fields are required: -// - metrics – A list of AnalyticsUtteranceMetric (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html) -// objects. In each object, use the name field to specify the metric to -// calculate, the statistic field to specify whether to calculate the Sum , -// Average , or Max number, and the order field to specify whether to sort the -// results in Ascending or Descending order. +// To use this API operation, your IAM role must have permissions to perform the [ListAggregatedUtterances] +// operation, which provides access to utterance-related analytics. See [Viewing utterance statistics]for the +// IAM policy to apply to the IAM role. +// +// Retrieves summary metrics for the utterances in your bot. The following fields +// are required: +// +// - metrics – A list of [AnalyticsUtteranceMetric]objects. In each object, use the name field to specify +// the metric to calculate, the statistic field to specify whether to calculate +// the Sum , Average , or Max number, and the order field to specify whether to +// sort the results in Ascending or Descending order. +// // - startDateTime and endDateTime – Define a time range for which you want to // retrieve results. // // Of the optional fields, you can organize the results in the following ways: +// // - Use the filters field to filter the results, the groupBy field to specify // categories by which to group the results, and the binBy field to specify time // intervals by which to group the results. +// // - Use the maxResults field to limit the number of results to return in a // single response and the nextToken field to return the next batch of results if // the response does not return the full set of results. // // Note that an order field exists in both binBy and metrics . Currently, you can // specify it in either field, but not in both. +// +// [AnalyticsUtteranceMetric]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html +// [Viewing utterance statistics]: https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html +// [ListAggregatedUtterances]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html func (c *Client) ListUtteranceMetrics(ctx context.Context, params *ListUtteranceMetricsInput, optFns ...func(*Options)) (*ListUtteranceMetricsOutput, error) { if params == nil { params = &ListUtteranceMetricsInput{} @@ -79,6 +86,7 @@ type ListUtteranceMetricsInput struct { // A list containing attributes related to the utterance that you want the // response to return. The following attributes are possible: + // // - LastUsedIntent – The last used intent at the time of the utterance. Attributes []types.AnalyticsUtteranceAttribute @@ -92,10 +100,13 @@ type ListUtteranceMetricsInput struct { // A list of objects, each of which specifies how to group the results. You can // group by the following criteria: + // // - UtteranceText – The transcription of the utterance. + // // - UtteranceState – The state of the utterance. The possible states are - // detailed in Key definitions (https://docs.aws.amazon.com/analytics-key-definitions-utterances) - // in the user guide. + // detailed in [Key definitions]in the user guide. + // + // [Key definitions]: https://docs.aws.amazon.com/analytics-key-definitions-utterances GroupBy []types.AnalyticsUtteranceGroupBySpecification // The maximum number of results to return in each page of results. If there are @@ -105,6 +116,7 @@ type ListUtteranceMetricsInput struct { // If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics // request to return the next page of results. For a complete set of results, call // the ListUtteranceMetrics operation until the nextToken returned in the response @@ -121,6 +133,7 @@ type ListUtteranceMetricsOutput struct { // If the response from the ListUtteranceMetrics 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 ListUtteranceMetrics // request to return the next page of results. For a complete set of results, call // the ListUtteranceMetrics operation until the nextToken returned in the response diff --git a/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go b/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go index 435cc4257ba..8766f693ae8 100644 --- a/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go +++ b/service/lexmodelsv2/api_op_SearchAssociatedTranscripts.go @@ -52,8 +52,9 @@ type SearchAssociatedTranscriptsInput struct { Filters []types.AssociatedTranscriptFilter // 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) + // string must match one of the supported locales. For more information, see [Supported languages] + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -86,16 +87,17 @@ type SearchAssociatedTranscriptsOutput struct { // searching. BotId *string - // The unique identifier of the bot recommendation associated with the transcripts - // to search. + // The unique identifier of the bot recommendation associated with the + // transcripts to search. BotRecommendationId *string // The version of the bot containing the transcripts that you are searching. BotVersion *string // 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) + // string must match one of the supported locales. For more information, see [Supported languages] + // + // [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 diff --git a/service/lexmodelsv2/api_op_StartBotRecommendation.go b/service/lexmodelsv2/api_op_StartBotRecommendation.go index eb7b20963bc..7a2953db2fc 100644 --- a/service/lexmodelsv2/api_op_StartBotRecommendation.go +++ b/service/lexmodelsv2/api_op_StartBotRecommendation.go @@ -42,8 +42,9 @@ type StartBotRecommendationInput struct { BotVersion *string // 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) + // The string must match one of the supported locales. For more information, see [Supported languages] + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -70,8 +71,10 @@ type StartBotRecommendationOutput struct { // The identifier of the bot recommendation that you have created. BotRecommendationId *string - // The status of the bot recommendation. If the status is Failed, then the reasons - // for the failure are listed in the failureReasons field. + // The status of the bot recommendation. + // + // If the status is Failed, then the reasons for the failure are listed in the + // failureReasons field. BotRecommendationStatus types.BotRecommendationStatus // The version of the bot containing the bot recommendation. @@ -86,8 +89,9 @@ type StartBotRecommendationOutput struct { 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) + // The string must match one of the supported locales. For more information, see [Supported languages] + // + // [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 cf7400f8b9d..d8ece069190 100644 --- a/service/lexmodelsv2/api_op_StartImport.go +++ b/service/lexmodelsv2/api_op_StartImport.go @@ -31,10 +31,11 @@ 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) + // The unique identifier for the import. It is included in the response from the [CreateUploadUrl] // operation. // + // [CreateUploadUrl]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html + // // This member is required. ImportId *string diff --git a/service/lexmodelsv2/api_op_StartTestSetGeneration.go b/service/lexmodelsv2/api_op_StartTestSetGeneration.go index 9872ce08bd4..797bb41d6e3 100644 --- a/service/lexmodelsv2/api_op_StartTestSetGeneration.go +++ b/service/lexmodelsv2/api_op_StartTestSetGeneration.go @@ -64,13 +64,13 @@ type StartTestSetGenerationInput struct { type StartTestSetGenerationOutput struct { - // The creation date and time for the test set generation. + // The creation date and time for the test set generation. CreationDateTime *time.Time // The description used for the test set generation. Description *string - // The data source for the test set generation. + // The data source for the test set generation. GenerationDataSource *types.TestSetGenerationDataSource // The roleARN used for any operation in the test set to access resources in the @@ -83,7 +83,7 @@ type StartTestSetGenerationOutput struct { // The unique identifier of the test set generation to describe. TestSetGenerationId *string - // The status for the test set generation. + // The status for the test set generation. TestSetGenerationStatus types.TestSetGenerationStatus // The test set name used for the test set generation. diff --git a/service/lexmodelsv2/api_op_StopBotRecommendation.go b/service/lexmodelsv2/api_op_StopBotRecommendation.go index e6873658cd5..c59ccd41d87 100644 --- a/service/lexmodelsv2/api_op_StopBotRecommendation.go +++ b/service/lexmodelsv2/api_op_StopBotRecommendation.go @@ -46,8 +46,9 @@ type StopBotRecommendationInput struct { 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 string must match one of the supported locales. For more information, see [Supported languages] + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -72,8 +73,9 @@ type StopBotRecommendationOutput struct { BotVersion *string // 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) + // string must match one of the supported locales. For more information, see [Supported languages] + // + // [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 cf60b6153e4..6454c84945a 100644 --- a/service/lexmodelsv2/api_op_UpdateBot.go +++ b/service/lexmodelsv2/api_op_UpdateBot.go @@ -30,10 +30,11 @@ 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) + // The unique identifier of the bot to update. This identifier is returned by the [CreateBot] // operation. // + // [CreateBot]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html + // // This member is required. BotId *string @@ -50,10 +51,13 @@ type UpdateBotInput struct { DataPrivacy *types.DataPrivacy // The time, in seconds, that Amazon Lex should keep information about a user's - // conversation with the bot. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Lex deletes any data provided before the timeout. You can specify - // between 60 (1 minute) and 86,400 (24 hours) seconds. + // conversation with the bot. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Lex deletes + // any data provided before the timeout. + // + // You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. // // This member is required. IdleSessionTTLInSeconds *int32 diff --git a/service/lexmodelsv2/api_op_UpdateBotLocale.go b/service/lexmodelsv2/api_op_UpdateBotLocale.go index 98e86dc2a24..f54902878da 100644 --- a/service/lexmodelsv2/api_op_UpdateBotLocale.go +++ b/service/lexmodelsv2/api_op_UpdateBotLocale.go @@ -42,8 +42,9 @@ 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]. + // + // [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_UpdateBotRecommendation.go b/service/lexmodelsv2/api_op_UpdateBotRecommendation.go index ced82319d0b..45ad9ca957c 100644 --- a/service/lexmodelsv2/api_op_UpdateBotRecommendation.go +++ b/service/lexmodelsv2/api_op_UpdateBotRecommendation.go @@ -54,8 +54,9 @@ type UpdateBotRecommendationInput struct { EncryptionSetting *types.EncryptionSetting // 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) + // The string must match one of the supported locales. For more information, see [Supported languages] + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -72,8 +73,10 @@ type UpdateBotRecommendationOutput struct { // The unique identifier of the bot recommendation to be updated. BotRecommendationId *string - // The status of the bot recommendation. If the status is Failed, then the reasons - // for the failure are listed in the failureReasons field. + // The status of the bot recommendation. + // + // If the status is Failed, then the reasons for the failure are listed in the + // failureReasons field. BotRecommendationStatus types.BotRecommendationStatus // The version of the bot containing the bot recommendation that has been updated. @@ -91,8 +94,9 @@ type UpdateBotRecommendationOutput struct { LastUpdatedDateTime *time.Time // 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) + // The string must match one of the supported locales. For more information, see [Supported languages] + // + // [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 929f6e955f3..0cad3648f25 100644 --- a/service/lexmodelsv2/api_op_UpdateExport.go +++ b/service/lexmodelsv2/api_op_UpdateExport.go @@ -12,11 +12,13 @@ import ( "time" ) -// 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) -// operation. +// 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]operation. +// +// [DescribeExport]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html func (c *Client) UpdateExport(ctx context.Context, params *UpdateExportInput, optFns ...func(*Options)) (*UpdateExportOutput, error) { if params == nil { params = &UpdateExportInput{} diff --git a/service/lexmodelsv2/api_op_UpdateIntent.go b/service/lexmodelsv2/api_op_UpdateIntent.go index 888d6ced2c9..d3b811ffacc 100644 --- a/service/lexmodelsv2/api_op_UpdateIntent.go +++ b/service/lexmodelsv2/api_op_UpdateIntent.go @@ -51,8 +51,9 @@ type UpdateIntentInput struct { IntentName *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_UpdateResourcePolicy.go b/service/lexmodelsv2/api_op_UpdateResourcePolicy.go index 007f2e5f8a8..82919aa9aae 100644 --- a/service/lexmodelsv2/api_op_UpdateResourcePolicy.go +++ b/service/lexmodelsv2/api_op_UpdateResourcePolicy.go @@ -32,8 +32,11 @@ 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]. + // + // If the policy isn't valid, Amazon Lex returns a validation exception. + // + // [IAM JSON policy reference]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html // // This member is required. Policy *string @@ -45,9 +48,10 @@ type UpdateResourcePolicyInput struct { ResourceArn *string // The identifier of the revision of the policy to update. If this revision ID - // doesn't match the current revision ID, Amazon Lex throws an exception. If you - // don't specify a revision, Amazon Lex overwrites the contents of the policy with - // the new values. + // doesn't match the current revision ID, Amazon Lex throws an exception. + // + // If you don't specify a revision, Amazon Lex overwrites the contents of the + // policy with the new values. ExpectedRevisionId *string noSmithyDocumentSerde diff --git a/service/lexmodelsv2/api_op_UpdateSlot.go b/service/lexmodelsv2/api_op_UpdateSlot.go index 84c83c7998c..332fb05fcab 100644 --- a/service/lexmodelsv2/api_op_UpdateSlot.go +++ b/service/lexmodelsv2/api_op_UpdateSlot.go @@ -46,8 +46,9 @@ type UpdateSlotInput struct { IntentId *string // 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) . + // must match one of the supported locales. For more information, see [Supported languages]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -73,8 +74,9 @@ 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 diff --git a/service/lexmodelsv2/api_op_UpdateSlotType.go b/service/lexmodelsv2/api_op_UpdateSlotType.go index 08b78c9154e..103f19973c8 100644 --- a/service/lexmodelsv2/api_op_UpdateSlotType.go +++ b/service/lexmodelsv2/api_op_UpdateSlotType.go @@ -41,9 +41,9 @@ type UpdateSlotTypeInput struct { 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) - // . + // string must match one of the supported locales. For more information, see [Supported languages]. + // + // [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_UpdateTestSet.go b/service/lexmodelsv2/api_op_UpdateTestSet.go index 0ab3cc03257..c76dccdc326 100644 --- a/service/lexmodelsv2/api_op_UpdateTestSet.go +++ b/service/lexmodelsv2/api_op_UpdateTestSet.go @@ -54,7 +54,7 @@ type UpdateTestSetOutput struct { // The test set description for the updated test set. Description *string - // The date and time of the last update for the updated test set. + // The date and time of the last update for the updated test set. LastUpdatedDateTime *time.Time // Indicates whether audio or text is used for the updated test set. diff --git a/service/lexmodelsv2/options.go b/service/lexmodelsv2/options.go index a26948027ae..8a4730441ff 100644 --- a/service/lexmodelsv2/options.go +++ b/service/lexmodelsv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lexmodelsv2/types/enums.go b/service/lexmodelsv2/types/enums.go index c4b6540ff0e..6ee69fe5ecb 100644 --- a/service/lexmodelsv2/types/enums.go +++ b/service/lexmodelsv2/types/enums.go @@ -11,8 +11,9 @@ const ( // Values returns all known values for AggregatedUtterancesFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregatedUtterancesFilterName) Values() []AggregatedUtterancesFilterName { return []AggregatedUtterancesFilterName{ "Utterance", @@ -29,8 +30,9 @@ const ( // Values returns all known values for AggregatedUtterancesFilterOperator. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregatedUtterancesFilterOperator) Values() []AggregatedUtterancesFilterOperator { return []AggregatedUtterancesFilterOperator{ "CO", @@ -48,8 +50,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregatedUtterancesSortAttribute) Values() []AggregatedUtterancesSortAttribute { return []AggregatedUtterancesSortAttribute{ "HitCount", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for AnalyticsBinByName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsBinByName) Values() []AnalyticsBinByName { return []AnalyticsBinByName{ "ConversationStartTime", @@ -88,6 +92,7 @@ const ( // Values returns all known values for AnalyticsCommonFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsCommonFilterName) Values() []AnalyticsCommonFilterName { return []AnalyticsCommonFilterName{ @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for AnalyticsFilterOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsFilterOperator) Values() []AnalyticsFilterOperator { return []AnalyticsFilterOperator{ "EQ", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for AnalyticsIntentField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsIntentField) Values() []AnalyticsIntentField { return []AnalyticsIntentField{ "IntentName", @@ -156,6 +163,7 @@ const ( // Values returns all known values for AnalyticsIntentFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsIntentFilterName) Values() []AnalyticsIntentFilterName { return []AnalyticsIntentFilterName{ @@ -184,6 +192,7 @@ const ( // Values returns all known values for AnalyticsIntentMetricName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsIntentMetricName) Values() []AnalyticsIntentMetricName { return []AnalyticsIntentMetricName{ @@ -205,6 +214,7 @@ const ( // Values returns all known values for AnalyticsIntentStageField. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsIntentStageField) Values() []AnalyticsIntentStageField { return []AnalyticsIntentStageField{ @@ -230,8 +240,9 @@ const ( // Values returns all known values for AnalyticsIntentStageFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsIntentStageFilterName) Values() []AnalyticsIntentStageFilterName { return []AnalyticsIntentStageFilterName{ "BotAliasId", @@ -259,8 +270,9 @@ const ( // Values returns all known values for AnalyticsIntentStageMetricName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsIntentStageMetricName) Values() []AnalyticsIntentStageMetricName { return []AnalyticsIntentStageMetricName{ "Count", @@ -280,8 +292,9 @@ const ( ) // Values returns all known values for AnalyticsInterval. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsInterval) Values() []AnalyticsInterval { return []AnalyticsInterval{ "OneHour", @@ -300,6 +313,7 @@ const ( // Values returns all known values for AnalyticsMetricStatistic. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsMetricStatistic) Values() []AnalyticsMetricStatistic { return []AnalyticsMetricStatistic{ @@ -320,8 +334,9 @@ const ( ) // Values returns all known values for AnalyticsModality. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsModality) Values() []AnalyticsModality { return []AnalyticsModality{ "Speech", @@ -340,8 +355,9 @@ const ( ) // Values returns all known values for AnalyticsNodeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsNodeType) Values() []AnalyticsNodeType { return []AnalyticsNodeType{ "Inner", @@ -358,8 +374,9 @@ const ( ) // Values returns all known values for AnalyticsSessionField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsSessionField) Values() []AnalyticsSessionField { return []AnalyticsSessionField{ "ConversationEndState", @@ -385,6 +402,7 @@ const ( // Values returns all known values for AnalyticsSessionFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsSessionFilterName) Values() []AnalyticsSessionFilterName { return []AnalyticsSessionFilterName{ @@ -416,6 +434,7 @@ const ( // Values returns all known values for AnalyticsSessionMetricName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsSessionMetricName) Values() []AnalyticsSessionMetricName { return []AnalyticsSessionMetricName{ @@ -440,6 +459,7 @@ const ( // Values returns all known values for AnalyticsSessionSortByName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsSessionSortByName) Values() []AnalyticsSessionSortByName { return []AnalyticsSessionSortByName{ @@ -458,8 +478,9 @@ const ( ) // Values returns all known values for AnalyticsSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsSortOrder) Values() []AnalyticsSortOrder { return []AnalyticsSortOrder{ "Ascending", @@ -476,8 +497,9 @@ const ( // Values returns all known values for AnalyticsUtteranceAttributeName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsUtteranceAttributeName) Values() []AnalyticsUtteranceAttributeName { return []AnalyticsUtteranceAttributeName{ "LastUsedIntent", @@ -493,8 +515,9 @@ const ( ) // Values returns all known values for AnalyticsUtteranceField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsUtteranceField) Values() []AnalyticsUtteranceField { return []AnalyticsUtteranceField{ "UtteranceText", @@ -519,8 +542,9 @@ const ( // Values returns all known values for AnalyticsUtteranceFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsUtteranceFilterName) Values() []AnalyticsUtteranceFilterName { return []AnalyticsUtteranceFilterName{ "BotAliasId", @@ -547,8 +571,9 @@ const ( // Values returns all known values for AnalyticsUtteranceMetricName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsUtteranceMetricName) Values() []AnalyticsUtteranceMetricName { return []AnalyticsUtteranceMetricName{ "Count", @@ -567,8 +592,9 @@ const ( // Values returns all known values for AnalyticsUtteranceSortByName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsUtteranceSortByName) Values() []AnalyticsUtteranceSortByName { return []AnalyticsUtteranceSortByName{ "UtteranceTimestamp", @@ -585,8 +611,9 @@ const ( // Values returns all known values for AssociatedTranscriptFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociatedTranscriptFilterName) Values() []AssociatedTranscriptFilterName { return []AssociatedTranscriptFilterName{ "IntentId", @@ -603,6 +630,7 @@ const ( // 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{ @@ -623,6 +651,7 @@ const ( // Values returns all known values for BotAliasReplicationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BotAliasReplicationStatus) Values() []BotAliasReplicationStatus { return []BotAliasReplicationStatus{ @@ -645,8 +674,9 @@ const ( ) // Values returns all known values for BotAliasStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotAliasStatus) Values() []BotAliasStatus { return []BotAliasStatus{ "Creating", @@ -665,8 +695,9 @@ const ( ) // Values returns all known values for BotFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotFilterName) Values() []BotFilterName { return []BotFilterName{ "BotName", @@ -684,8 +715,9 @@ const ( ) // Values returns all known values for BotFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotFilterOperator) Values() []BotFilterOperator { return []BotFilterOperator{ "CO", @@ -702,8 +734,9 @@ const ( ) // Values returns all known values for BotLocaleFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotLocaleFilterName) Values() []BotLocaleFilterName { return []BotLocaleFilterName{ "BotLocaleName", @@ -719,8 +752,9 @@ const ( ) // Values returns all known values for BotLocaleFilterOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotLocaleFilterOperator) Values() []BotLocaleFilterOperator { return []BotLocaleFilterOperator{ "CO", @@ -736,8 +770,9 @@ const ( ) // Values returns all known values for BotLocaleSortAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotLocaleSortAttribute) Values() []BotLocaleSortAttribute { return []BotLocaleSortAttribute{ "BotLocaleName", @@ -760,8 +795,9 @@ const ( ) // Values returns all known values for BotLocaleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotLocaleStatus) Values() []BotLocaleStatus { return []BotLocaleStatus{ "Creating", @@ -792,8 +828,9 @@ const ( ) // Values returns all known values for BotRecommendationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotRecommendationStatus) Values() []BotRecommendationStatus { return []BotRecommendationStatus{ "Processing", @@ -819,8 +856,9 @@ const ( ) // Values returns all known values for BotReplicaStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotReplicaStatus) Values() []BotReplicaStatus { return []BotReplicaStatus{ "Enabling", @@ -838,8 +876,9 @@ const ( ) // Values returns all known values for BotSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotSortAttribute) Values() []BotSortAttribute { return []BotSortAttribute{ "BotName", @@ -861,8 +900,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -885,8 +925,9 @@ const ( ) // Values returns all known values for BotType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotType) Values() []BotType { return []BotType{ "Bot", @@ -903,8 +944,9 @@ const ( // Values returns all known values for BotVersionReplicaSortAttribute. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotVersionReplicaSortAttribute) Values() []BotVersionReplicaSortAttribute { return []BotVersionReplicaSortAttribute{ "BotVersion", @@ -923,6 +965,7 @@ const ( // Values returns all known values for BotVersionReplicationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BotVersionReplicationStatus) Values() []BotVersionReplicationStatus { return []BotVersionReplicationStatus{ @@ -941,8 +984,9 @@ const ( ) // Values returns all known values for BotVersionSortAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BotVersionSortAttribute) Values() []BotVersionSortAttribute { return []BotVersionSortAttribute{ "BotVersion", @@ -958,6 +1002,7 @@ const ( // Values returns all known values for BuiltInIntentSortAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BuiltInIntentSortAttribute) Values() []BuiltInIntentSortAttribute { return []BuiltInIntentSortAttribute{ @@ -974,8 +1019,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BuiltInSlotTypeSortAttribute) Values() []BuiltInSlotTypeSortAttribute { return []BuiltInSlotTypeSortAttribute{ "SlotTypeSignature", @@ -992,8 +1038,9 @@ const ( ) // Values returns all known values for ConversationEndState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConversationEndState) Values() []ConversationEndState { return []ConversationEndState{ "Success", @@ -1012,8 +1059,9 @@ const ( // Values returns all known values for ConversationLogsInputModeFilter. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConversationLogsInputModeFilter) Values() []ConversationLogsInputModeFilter { return []ConversationLogsInputModeFilter{ "Speech", @@ -1033,8 +1081,9 @@ const ( ) // Values returns all known values for CustomVocabularyStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomVocabularyStatus) Values() []CustomVocabularyStatus { return []CustomVocabularyStatus{ "Ready", @@ -1061,8 +1110,9 @@ const ( ) // Values returns all known values for DialogActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DialogActionType) Values() []DialogActionType { return []DialogActionType{ "ElicitIntent", @@ -1086,8 +1136,9 @@ const ( ) // Values returns all known values for Effect. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Effect) Values() []Effect { return []Effect{ "Allow", @@ -1106,8 +1157,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1125,8 +1177,9 @@ const ( ) // Values returns all known values for ExportFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportFilterName) Values() []ExportFilterName { return []ExportFilterName{ "ExportResourceType", @@ -1142,8 +1195,9 @@ const ( ) // Values returns all known values for ExportFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportFilterOperator) Values() []ExportFilterOperator { return []ExportFilterOperator{ "CO", @@ -1159,8 +1213,9 @@ const ( ) // Values returns all known values for ExportSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportSortAttribute) Values() []ExportSortAttribute { return []ExportSortAttribute{ "LastUpdatedDateTime", @@ -1178,8 +1233,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1199,6 +1255,7 @@ const ( // Values returns all known values for GenerationSortByAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GenerationSortByAttribute) Values() []GenerationSortByAttribute { return []GenerationSortByAttribute{ @@ -1217,8 +1274,9 @@ const ( ) // Values returns all known values for GenerationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GenerationStatus) Values() []GenerationStatus { return []GenerationStatus{ "Failed", @@ -1237,8 +1295,9 @@ const ( ) // Values returns all known values for ImportExportFileFormat. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportExportFileFormat) Values() []ImportExportFileFormat { return []ImportExportFileFormat{ "LexJson", @@ -1255,8 +1314,9 @@ const ( ) // Values returns all known values for ImportFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportFilterName) Values() []ImportFilterName { return []ImportFilterName{ "ImportResourceType", @@ -1272,8 +1332,9 @@ const ( ) // Values returns all known values for ImportFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportFilterOperator) Values() []ImportFilterOperator { return []ImportFilterOperator{ "CO", @@ -1292,8 +1353,9 @@ const ( ) // Values returns all known values for ImportResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportResourceType) Values() []ImportResourceType { return []ImportResourceType{ "Bot", @@ -1311,8 +1373,9 @@ const ( ) // Values returns all known values for ImportSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportSortAttribute) Values() []ImportSortAttribute { return []ImportSortAttribute{ "LastUpdatedDateTime", @@ -1330,8 +1393,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1349,8 +1413,9 @@ const ( ) // Values returns all known values for IntentFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntentFilterName) Values() []IntentFilterName { return []IntentFilterName{ "IntentName", @@ -1366,8 +1431,9 @@ const ( ) // Values returns all known values for IntentFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntentFilterOperator) Values() []IntentFilterOperator { return []IntentFilterOperator{ "CO", @@ -1384,8 +1450,9 @@ const ( ) // Values returns all known values for IntentSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntentSortAttribute) Values() []IntentSortAttribute { return []IntentSortAttribute{ "IntentName", @@ -1406,8 +1473,9 @@ const ( ) // Values returns all known values for IntentState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntentState) Values() []IntentState { return []IntentState{ "Failed", @@ -1429,8 +1497,9 @@ const ( ) // Values returns all known values for MergeStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MergeStrategy) Values() []MergeStrategy { return []MergeStrategy{ "Overwrite", @@ -1449,6 +1518,7 @@ const ( // 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{ @@ -1466,8 +1536,9 @@ const ( ) // Values returns all known values for ObfuscationSettingType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObfuscationSettingType) Values() []ObfuscationSettingType { return []ObfuscationSettingType{ "None", @@ -1488,8 +1559,9 @@ const ( ) // Values returns all known values for PromptAttempt. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PromptAttempt) Values() []PromptAttempt { return []PromptAttempt{ "Initial", @@ -1510,8 +1582,9 @@ const ( ) // Values returns all known values for SearchOrder. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchOrder) Values() []SearchOrder { return []SearchOrder{ "Ascending", @@ -1528,8 +1601,9 @@ const ( ) // Values returns all known values for SlotConstraint. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotConstraint) Values() []SlotConstraint { return []SlotConstraint{ "Required", @@ -1545,8 +1619,9 @@ const ( ) // Values returns all known values for SlotFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotFilterName) Values() []SlotFilterName { return []SlotFilterName{ "SlotName", @@ -1562,8 +1637,9 @@ const ( ) // Values returns all known values for SlotFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotFilterOperator) Values() []SlotFilterOperator { return []SlotFilterOperator{ "CO", @@ -1580,8 +1656,9 @@ const ( ) // Values returns all known values for SlotResolutionStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotResolutionStrategy) Values() []SlotResolutionStrategy { return []SlotResolutionStrategy{ "EnhancedFallback", @@ -1598,8 +1675,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1616,8 +1694,9 @@ const ( ) // Values returns all known values for SlotSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotSortAttribute) Values() []SlotSortAttribute { return []SlotSortAttribute{ "SlotName", @@ -1636,8 +1715,9 @@ const ( ) // Values returns all known values for SlotTypeCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotTypeCategory) Values() []SlotTypeCategory { return []SlotTypeCategory{ "Custom", @@ -1656,8 +1736,9 @@ const ( ) // Values returns all known values for SlotTypeFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotTypeFilterName) Values() []SlotTypeFilterName { return []SlotTypeFilterName{ "SlotTypeName", @@ -1674,8 +1755,9 @@ const ( ) // Values returns all known values for SlotTypeFilterOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SlotTypeFilterOperator) Values() []SlotTypeFilterOperator { return []SlotTypeFilterOperator{ "CO", @@ -1692,8 +1774,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SlotTypeName", @@ -1712,6 +1795,7 @@ const ( // Values returns all known values for SlotValueResolutionStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SlotValueResolutionStrategy) Values() []SlotValueResolutionStrategy { return []SlotValueResolutionStrategy{ @@ -1730,8 +1814,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1748,8 +1833,9 @@ const ( ) // Values returns all known values for TestExecutionApiMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestExecutionApiMode) Values() []TestExecutionApiMode { return []TestExecutionApiMode{ "Streaming", @@ -1766,8 +1852,9 @@ const ( ) // Values returns all known values for TestExecutionModality. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestExecutionModality) Values() []TestExecutionModality { return []TestExecutionModality{ "Text", @@ -1785,6 +1872,7 @@ const ( // Values returns all known values for TestExecutionSortAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TestExecutionSortAttribute) Values() []TestExecutionSortAttribute { return []TestExecutionSortAttribute{ @@ -1807,8 +1895,9 @@ const ( ) // Values returns all known values for TestExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestExecutionStatus) Values() []TestExecutionStatus { return []TestExecutionStatus{ "Pending", @@ -1831,8 +1920,9 @@ const ( ) // Values returns all known values for TestResultMatchStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestResultMatchStatus) Values() []TestResultMatchStatus { return []TestResultMatchStatus{ "Matched", @@ -1853,8 +1943,9 @@ const ( ) // Values returns all known values for TestResultTypeFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestResultTypeFilter) Values() []TestResultTypeFilter { return []TestResultTypeFilter{ "OverallTestResults", @@ -1876,8 +1967,9 @@ const ( // Values returns all known values for TestSetDiscrepancyReportStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestSetDiscrepancyReportStatus) Values() []TestSetDiscrepancyReportStatus { return []TestSetDiscrepancyReportStatus{ "InProgress", @@ -1897,8 +1989,9 @@ const ( ) // Values returns all known values for TestSetGenerationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestSetGenerationStatus) Values() []TestSetGenerationStatus { return []TestSetGenerationStatus{ "Generating", @@ -1917,8 +2010,9 @@ const ( ) // Values returns all known values for TestSetModality. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestSetModality) Values() []TestSetModality { return []TestSetModality{ "Text", @@ -1935,8 +2029,9 @@ const ( ) // Values returns all known values for TestSetSortAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestSetSortAttribute) Values() []TestSetSortAttribute { return []TestSetSortAttribute{ "TestSetName", @@ -1956,8 +2051,9 @@ const ( ) // Values returns all known values for TestSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestSetStatus) Values() []TestSetStatus { return []TestSetStatus{ "Importing", @@ -1978,8 +2074,9 @@ const ( ) // Values returns all known values for TimeDimension. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeDimension) Values() []TimeDimension { return []TimeDimension{ "Hours", @@ -1996,8 +2093,9 @@ const ( ) // Values returns all known values for TranscriptFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscriptFormat) Values() []TranscriptFormat { return []TranscriptFormat{ "Lex", @@ -2015,8 +2113,9 @@ const ( ) // Values returns all known values for UtteranceContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UtteranceContentType) Values() []UtteranceContentType { return []UtteranceContentType{ "PlainText", @@ -2035,8 +2134,9 @@ const ( ) // Values returns all known values for VoiceEngine. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceEngine) Values() []VoiceEngine { return []VoiceEngine{ "standard", diff --git a/service/lexmodelsv2/types/types.go b/service/lexmodelsv2/types/types.go index 60550b9467a..8d160e3f82b 100644 --- a/service/lexmodelsv2/types/types.go +++ b/service/lexmodelsv2/types/types.go @@ -195,31 +195,51 @@ type AnalyticsBinKey struct { // operator // // values . For example: +// // - IntentName CO Book – The intent name contains the string "Book." +// // - BotVersion EQ 2 – The bot version is equal to two. // // The operators that each filter supports are listed below: +// // - BotAlias – EQ . +// // - BotVersion – EQ . +// // - LocaleId – EQ . +// // - Modality – EQ . +// // - Channel – EQ . +// // - SessionId – EQ . +// // - OriginatingRequestId – EQ . +// // - IntentName – EQ , CO . +// // - IntentEndState – EQ , CO . type AnalyticsIntentFilter struct { // The category by which to filter the intents. The descriptions for each option // are as follows: + // // - BotAlias – The name of the bot alias. + // // - BotVersion – The version of the bot. + // // - LocaleId – The locale of the bot. + // // - Modality – The modality of the session with the bot (audio, DTMF, or text). + // // - Channel – The channel that the bot is integrated with. + // // - SessionId – The identifier of the session with the bot. + // // - OriginatingRequestId – The identifier of the first request in a session. + // // - IntentName – The name of the intent. + // // - IntentEndState – The final state of the intent. // // This member is required. @@ -227,19 +247,33 @@ type AnalyticsIntentFilter struct { // The operation by which to filter the category. The following operations are // possible: + // // - CO – Contains + // // - EQ – Equals + // // - GT – Greater than + // // - LT – Less than + // // The operators that each filter supports are listed below: + // // - BotAlias – EQ . + // // - BotVersion – EQ . + // // - LocaleId – EQ . + // // - Modality – EQ . + // // - Channel – EQ . + // // - SessionId – EQ . + // // - OriginatingRequestId – EQ . + // // - IntentName – EQ , CO . + // // - IntentEndState – EQ , CO . // // This member is required. @@ -287,19 +321,27 @@ type AnalyticsIntentGroupBySpecification struct { type AnalyticsIntentMetric struct { // The metric for which you want to get intent summary statistics. + // // - Count – The number of times the intent was invoked. + // // - Success – The number of times the intent succeeded. + // // - Failure – The number of times the intent failed. + // // - Switched – The number of times there was a switch to a different intent. + // // - Dropped – The number of times the user dropped the intent. // // This member is required. Name AnalyticsIntentMetricName // The summary statistic to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of intents in the category // you provide in name . + // // - Max – The highest count in the category you provide in name . // // This member is required. @@ -314,19 +356,28 @@ type AnalyticsIntentMetric struct { // An object containing the results for the intent metric you requested. type AnalyticsIntentMetricResult struct { - // The metric that you requested. See Key definitions (https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html) - // for more details about these metrics. + // The metric that you requested. See [Key definitions] for more details about these metrics. + // // - Count – The number of times the intent was invoked. + // // - Success – The number of times the intent succeeded. + // // - Failure – The number of times the intent failed. + // // - Switched – The number of times there was a switch to a different intent. + // // - Dropped – The number of times the user dropped the intent. + // + // [Key definitions]: https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html Name AnalyticsIntentMetricName // The statistic that you requested to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of intents in the category // you provide in name . + // // - Max – The highest count in the category you provide in name . Statistic AnalyticsMetricStatistic @@ -383,31 +434,51 @@ type AnalyticsIntentResult struct { // operator // // values . For example: +// // - IntentName CO Book – The intent name contains the string "Book." +// // - BotVersion EQ 2 – The bot version is equal to two. // // The operators that each filter supports are listed below: +// // - BotAlias – EQ . +// // - BotVersion – EQ . +// // - LocaleId – EQ . +// // - Modality – EQ . +// // - Channel – EQ . +// // - SessionId – EQ . +// // - OriginatingRequestId – EQ . +// // - IntentName – EQ , CO . +// // - IntentStageName – EQ , CO . type AnalyticsIntentStageFilter struct { // The category by which to filter the intent stages. The descriptions for each // option are as follows: + // // - BotAlias – The name of the bot alias. + // // - BotVersion – The version of the bot. + // // - LocaleId – The locale of the bot. + // // - Modality – The modality of the session with the bot (audio, DTMF, or text). + // // - Channel – The channel that the bot is integrated with. + // // - SessionId – The identifier of the session with the bot. + // // - OriginatingRequestId – The identifier of the first request in a session. + // // - IntentName – The name of the intent. + // // - IntentStageName – The stage in the intent. // // This member is required. @@ -415,19 +486,33 @@ type AnalyticsIntentStageFilter struct { // The operation by which to filter the category. The following operations are // possible: + // // - CO – Contains + // // - EQ – Equals + // // - GT – Greater than + // // - LT – Less than + // // The operators that each filter supports are listed below: + // // - BotAlias – EQ . + // // - BotVersion – EQ . + // // - LocaleId – EQ . + // // - Modality – EQ . + // // - Channel – EQ . + // // - SessionId – EQ . + // // - OriginatingRequestId – EQ . + // // - IntentName – EQ , CO . + // // - IntentStageName – EQ , CO . // // This member is required. @@ -476,23 +561,32 @@ type AnalyticsIntentStageGroupBySpecification struct { // sessions with the bot. type AnalyticsIntentStageMetric struct { - // The metric for which you want to get intent stage summary statistics. See Key - // definitions (https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html) - // for more details about these metrics. + // The metric for which you want to get intent stage summary statistics. See [Key definitions] for + // more details about these metrics. + // // - Count – The number of times the intent stage occurred. + // // - Success – The number of times the intent stage succeeded. + // // - Failure – The number of times the intent stage failed. + // // - Dropped – The number of times the user dropped the intent stage. + // // - Retry – The number of times the bot tried to elicit a response from the user // at this stage. // + // [Key definitions]: https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html + // // This member is required. Name AnalyticsIntentStageMetricName // The summary statistic to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of intent stages in the // category you provide in name . + // // - Max – The highest count in the category you provide in name . // // This member is required. @@ -509,18 +603,26 @@ type AnalyticsIntentStageMetric struct { type AnalyticsIntentStageMetricResult struct { // The metric that you requested. + // // - Count – The number of times the intent stage occurred. + // // - Success – The number of times the intent stage succeeded. + // // - Failure – The number of times the intent stage failed. + // // - Dropped – The number of times the user dropped the intent stage. + // // - Retry – The number of times the bot tried to elicit a response from the user // at this stage. Name AnalyticsIntentStageMetricName // The summary statistic that you requested to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of intent stages in the // category you provide in name . + // // - Max – The highest count in the category you provide in name . Statistic AnalyticsMetricStatistic @@ -556,23 +658,35 @@ type AnalyticsIntentStageResult struct { // operator // // values . For example: +// // - LocaleId EQ en – The locale is "en". +// // - BotVersion EQ 2 – The bot version is equal to two. // // The operators that each filter supports are listed below: +// // - BotAlias – EQ . +// // - BotVersion – EQ . +// // - LocaleId – EQ . +// // - Modality – EQ . +// // - Channel – EQ . type AnalyticsPathFilter struct { // The category by which to filter the intent paths. The descriptions for each // option are as follows: + // // - BotAlias – The name of the bot alias. + // // - BotVersion – The version of the bot. + // // - LocaleId – The locale of the bot. + // // - Modality – The modality of the session with the bot (audio, DTMF, or text). + // // - Channel – The channel that the bot is integrated with. // // This member is required. @@ -580,15 +694,25 @@ type AnalyticsPathFilter struct { // The operation by which to filter the category. The following operations are // possible: + // // - CO – Contains + // // - EQ – Equals + // // - GT – Greater than + // // - LT – Less than + // // The operators that each filter supports are listed below: + // // - BotAlias – EQ . + // // - BotVersion – EQ . + // // - LocaleId – EQ . + // // - Modality – EQ . + // // - Channel – EQ . // // This member is required. @@ -613,33 +737,55 @@ type AnalyticsPathFilter struct { // operator // // values . For example: +// // - LocaleId EQ en – The locale is "en". +// // - Duration GT 200 – The duration is greater than 200 seconds. // // The operators that each filter supports are listed below: +// // - BotAlias – EQ . +// // - BotVersion – EQ . +// // - LocaleId – EQ . +// // - Modality – EQ . +// // - Channel – EQ . +// // - Duration – EQ , GT , LT . +// // - conversationEndState – EQ , CO . +// // - SessionId – EQ . +// // - OriginatingRequestId – EQ . +// // - IntentPath – EQ . type AnalyticsSessionFilter struct { // The category by which to filter the sessions. The descriptions for each option // are as follows: + // // - BotAlias – The name of the bot alias. + // // - BotVersion – The version of the bot. + // // - LocaleId – The locale of the bot. + // // - Modality – The modality of the session with the bot (audio, DTMF, or text). + // // - Channel – The channel that the bot is integrated with. + // // - Duration – The duration of the session. + // // - conversationEndState – The final state of the session. + // // - SessionId – The identifier of the session with the bot. + // // - OriginatingRequestId – The identifier of the first request in a session. + // // - IntentPath – The order of intents taken in a session. // // This member is required. @@ -647,20 +793,35 @@ type AnalyticsSessionFilter struct { // The operation by which to filter the category. The following operations are // possible: + // // - CO – Contains + // // - EQ – Equals + // // - GT – Greater than + // // - LT – Less than + // // The operators that each filter supports are listed below: + // // - BotAlias – EQ . + // // - BotVersion – EQ . + // // - LocaleId – EQ . + // // - Modality – EQ . + // // - Channel – EQ . + // // - Duration – EQ , GT , LT . + // // - conversationEndState – EQ , CO . + // // - SessionId – EQ . + // // - OriginatingRequestId – EQ . + // // - IntentPath – EQ . // // This member is required. @@ -708,21 +869,31 @@ type AnalyticsSessionGroupBySpecification struct { type AnalyticsSessionMetric struct { // The metric for which you want to get session summary statistics. + // // - Count – The number of sessions. + // // - Success – The number of sessions that succeeded. + // // - Failure – The number of sessions that failed. + // // - Dropped – The number of sessions that the user dropped. + // // - Duration – The duration of sessions. + // // - TurnsPerSession – The number of turns in the sessions. + // // - Concurrency – The number of sessions occurring in the same period of time. // // This member is required. Name AnalyticsSessionMetricName // The summary statistic to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of sessions in the category // you provide in name . + // // - Max – The highest count in the category you provide in name . // // This member is required. @@ -738,19 +909,29 @@ type AnalyticsSessionMetric struct { type AnalyticsSessionMetricResult struct { // The metric that you requested. + // // - Count – The number of sessions. + // // - Success – The number of sessions that succeeded. + // // - Failure – The number of sessions that failed. + // // - Dropped – The number of sessions that the user dropped. + // // - Duration – The duration of sessions. + // // - TurnPersession – The number of turns in the sessions. + // // - Concurrency – The number of sessions occurring in the same period of time. Name AnalyticsSessionMetricName // The summary statistic that you requested to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of sessions in the category // you provide in name . + // // - Max – The highest count in the category you provide in name . Statistic AnalyticsMetricStatistic @@ -808,32 +989,51 @@ type AnalyticsUtteranceAttributeResult struct { // operator // // values . For example: +// // - LocaleId EQ Book – The locale is the string "en". -// - UtteranceText CO help – The text of the utterance contains the string -// "help". +// +// - UtteranceText CO help – The text of the utterance contains the string "help". // // The operators that each filter supports are listed below: +// // - BotAlias – EQ . +// // - BotVersion – EQ . +// // - LocaleId – EQ . +// // - Modality – EQ . +// // - Channel – EQ . +// // - SessionId – EQ . +// // - OriginatingRequestId – EQ . +// // - UtteranceState – EQ . +// // - UtteranceText – EQ , CO . type AnalyticsUtteranceFilter struct { // The category by which to filter the utterances. The descriptions for each // option are as follows: + // // - BotAlias – The name of the bot alias. + // // - BotVersion – The version of the bot. + // // - LocaleId – The locale of the bot. + // // - Modality – The modality of the session with the bot (audio, DTMF, or text). + // // - Channel – The channel that the bot is integrated with. + // // - SessionId – The identifier of the session with the bot. + // // - OriginatingRequestId – The identifier of the first request in a session. + // // - UtteranceState – The state of the utterance. + // // - UtteranceText – The text in the utterance. // // This member is required. @@ -841,19 +1041,33 @@ type AnalyticsUtteranceFilter struct { // The operation by which to filter the category. The following operations are // possible: + // // - CO – Contains + // // - EQ – Equals + // // - GT – Greater than + // // - LT – Less than + // // The operators that each filter supports are listed below: + // // - BotAlias – EQ . + // // - BotVersion – EQ . + // // - LocaleId – EQ . + // // - Modality – EQ . + // // - Channel – EQ . + // // - SessionId – EQ . + // // - OriginatingRequestId – EQ . + // // - UtteranceState – EQ . + // // - UtteranceText – EQ , CO . // // This member is required. @@ -902,18 +1116,25 @@ type AnalyticsUtteranceGroupBySpecification struct { type AnalyticsUtteranceMetric struct { // The metric for which you want to get utterance summary statistics. + // // - Count – The number of utterances. + // // - Missed – The number of utterances that Amazon Lex failed to recognize. + // // - Detected – The number of utterances that Amazon Lex managed to detect. + // // - UtteranceTimestamp – The date and time of the utterance. // // This member is required. Name AnalyticsUtteranceMetricName // The summary statistic to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of utterances in the // category you provide in name . + // // - Max – The highest count in the category you provide in name . // // This member is required. @@ -929,16 +1150,23 @@ type AnalyticsUtteranceMetric struct { type AnalyticsUtteranceMetricResult struct { // The metric that you requested. + // // - Count – The number of utterances. + // // - Missed – The number of utterances that Amazon Lex failed to recognize. + // // - Detected – The number of utterances that Amazon Lex managed to detect. + // // - UtteranceTimestamp – The date and time of the utterance. Name AnalyticsUtteranceMetricName // The summary statistic that you requested to calculate. + // // - Sum – The total count for the category you provide in name . + // // - Average – The total count divided by the number of utterances in the // category you provide in name . + // // - Max – The highest count in the category you provide in name . Statistic AnalyticsMetricStatistic @@ -977,8 +1205,9 @@ type AnalyticsUtteranceResult 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]. + // + // [Output transcript format]: https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html Transcript *string noSmithyDocumentSerde @@ -1024,8 +1253,10 @@ 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) - // operation must have permission to write to this bucket. + // specified in the roleArn parameter of the [CreateBot] operation must have permission to + // write to this bucket. + // + // [CreateBot]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html // // This member is required. S3Bucket *S3BucketLogDestination @@ -1153,13 +1384,15 @@ type BotAliasReplicaSummary struct { noSmithyDocumentSerde } -// Summary information about bot aliases returned from the ListBotAliases (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html) -// operation. +// Summary information about bot aliases returned from the [ListBotAliases] operation. +// +// [ListBotAliases]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html 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) - // operation. + // detailed information about the alias using the [DescribeBotAlias]operation. + // + // [DescribeBotAlias]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html BotAliasId *string // The name of the bot alias. @@ -1271,10 +1504,13 @@ type BotImportSpecification struct { BotTags map[string]string // The time, in seconds, that Amazon Lex should keep information about a user's - // conversation with the bot. A user interaction remains active for the amount of - // time specified. If no conversation occurs during this time, the session expires - // and Amazon Lex deletes any data provided before the timeout. You can specify - // between 60 (1 minute) and 86,400 (24 hours) seconds. + // conversation with the bot. + // + // A user interaction remains active for the amount of time specified. If no + // conversation occurs during this time, the session expires and Amazon Lex deletes + // any data provided before the timeout. + // + // You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. IdleSessionTTLInSeconds *int32 // A list of tags to add to the test alias for a bot. You can only add tags when @@ -1363,9 +1599,9 @@ 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) - // . + // and slots used in the bot must have the same locale. For more information, see [Supported languages]. + // + // [Supported languages]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html // // This member is required. LocaleId *string @@ -1373,14 +1609,19 @@ type BotLocaleImportSpecification struct { // 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 - // 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: + // 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 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 @@ -1406,8 +1647,9 @@ type BotLocaleSortBy struct { noSmithyDocumentSerde } -// Summary information about bot locales returned by the ListBotLocales (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html) -// operation. +// Summary information about bot locales returned by the [ListBotLocales] operation. +// +// [ListBotLocales]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html type BotLocaleSummary struct { // The current status of the bot locale. When the status is Built the locale is @@ -1502,8 +1744,10 @@ type BotRecommendationSummary struct { // This member is required. BotRecommendationId *string - // The status of the bot recommendation. If the status is Failed, then the reasons - // for the failure are listed in the failureReasons field. + // The status of the bot recommendation. + // + // If the status is Failed, then the reasons for the failure are listed in the + // failureReasons field. // // This member is required. BotRecommendationStatus BotRecommendationStatus @@ -1552,13 +1796,15 @@ type BotSortBy struct { noSmithyDocumentSerde } -// Summary information about a bot returned by the ListBots (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html) -// operation. +// Summary information about a bot returned by the [ListBots] operation. +// +// [ListBots]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html 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) - // operation. + // information about the bot with the [DescribeBot]operation. + // + // [DescribeBot]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html BotId *string // The name of the bot. @@ -1647,8 +1893,9 @@ 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) -// operation. +// Summary information about a bot version returned by the [ListBotVersions] operation. +// +// [ListBotVersions]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html type BotVersionSummary struct { // The name of the bot associated with the version. @@ -1700,9 +1947,9 @@ 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) -// operation. +// Provides summary information about a built-in intent for the [ListBuiltInIntents] operation. +// +// [ListBuiltInIntents]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html type BuiltInIntentSummary struct { // The description of the intent. @@ -1731,9 +1978,9 @@ type BuiltInSlotTypeSortBy struct { noSmithyDocumentSerde } -// Provides summary information about a built-in slot type for the -// ListBuiltInSlotTypes (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html) -// operation. +// Provides summary information about a built-in slot type for the [ListBuiltInSlotTypes] operation. +// +// [ListBuiltInSlotTypes]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html type BuiltInSlotTypeSummary struct { // The description of the built-in slot type. @@ -2152,8 +2399,9 @@ type DataPrivacy struct { // 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 (http://aws.amazon.com/lex/faqs#data-security) - // . + // targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ]. + // + // [Amazon Lex FAQ]: http://aws.amazon.com/lex/faqs#data-security // // This member is required. ChildDirected bool @@ -2167,21 +2415,23 @@ type DataPrivacy struct { type DataSourceConfiguration struct { // Contains details about the configuration of the Amazon Bedrock knowledge base - // used for the AMAZON.QnAIntent . To set up a knowledge base, follow the steps at - // Building a knowledge base (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) + // used for the AMAZON.QnAIntent . To set up a knowledge base, follow the steps at [Building a knowledge base] // . + // + // [Building a knowledge base]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html BedrockKnowledgeStoreConfiguration *BedrockKnowledgeStoreConfiguration // Contains details about the configuration of the Amazon Kendra index used for - // the AMAZON.QnAIntent . To create a Amazon Kendra index, follow the steps at - // Creating an index (https://docs.aws.amazon.com/kendra/latest/dg/create-index.html) - // . + // the AMAZON.QnAIntent . To create a Amazon Kendra index, follow the steps at [Creating an index]. + // + // [Creating an index]: https://docs.aws.amazon.com/kendra/latest/dg/create-index.html KendraConfiguration *QnAKendraConfiguration // Contains details about the configuration of the Amazon OpenSearch Service - // database used for the AMAZON.QnAIntent . To create a domain, follow the steps at - // Creating and managing Amazon OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) + // database used for the AMAZON.QnAIntent . To create a domain, follow the steps at [Creating and managing Amazon OpenSearch Service domains] // . + // + // [Creating and managing Amazon OpenSearch Service domains]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html OpensearchConfiguration *OpensearchConfiguration noSmithyDocumentSerde @@ -2405,8 +2655,9 @@ type ExecutionErrorDetails struct { noSmithyDocumentSerde } -// Filters the response form the ListExports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) -// operation +// Filters the response form the [ListExports] operation +// +// [ListExports]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html type ExportFilter struct { // The name of the field to use for filtering. @@ -2597,8 +2848,10 @@ 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 @@ -2624,7 +2877,9 @@ type GenerationSortBy struct { // The attribute by which to sort the generation request information. You can sort // by the following attributes. + // // - creationStartTime – The time at which the generation request was created. + // // - lastUpdatedTime – The time at which the generation request was last updated. // // This member is required. @@ -2701,9 +2956,10 @@ type GrammarSlotTypeSource struct { } // A card that is shown to the user by a messaging platform. You define the -// contents of the card, the card is displayed by the platform. When you use a -// response card, the response from the user is constrained to the text associated -// with a button on the card. +// contents of the card, the card is displayed by the platform. +// +// When you use a response card, the response from the user is constrained to the +// text associated with a button on the card. type ImageResponseCard struct { // The title to display on the response card. The format of the title is @@ -2729,8 +2985,9 @@ type ImageResponseCard struct { noSmithyDocumentSerde } -// Filters the response from the ListImports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) -// operation. +// Filters the response from the [ListImports] operation. +// +// [ListImports]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html type ImportFilter struct { // The name of the field to use for filtering. @@ -2957,9 +3214,11 @@ type IntentClosingSetting struct { type IntentConfirmationSetting struct { // Prompts the user to confirm the intent. This question should have a yes or no - // answer. Amazon Lex uses this prompt to ensure that the user acknowledges that - // the intent is ready for fulfillment. For example, with the OrderPizza intent, - // you might want to confirm that the order is correct before placing it. For other + // answer. + // + // Amazon Lex uses this prompt to ensure that the user acknowledges that the + // intent is ready for fulfillment. For example, with the OrderPizza intent, 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. // @@ -3168,8 +3427,9 @@ 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]. + // + // [Filtering queries]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html QueryFilterString *string // Determines whether the AMAZON.KendraSearchIntent intent uses a custom query @@ -3248,10 +3508,12 @@ 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 - // 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 . + // 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 . AllowMultipleValues bool noSmithyDocumentSerde @@ -3457,8 +3719,9 @@ type PostDialogCodeHookInvocationSpecification struct { } // 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) +// 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]: 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 @@ -3503,8 +3766,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) -// . +// more information, see [AWS JSON policy elements: Principal]. +// +// [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. @@ -3591,14 +3855,15 @@ type QnAKendraConfiguration struct { // Specifies whether to return an exact response from the Amazon Kendra index or // to let the Amazon Bedrock model you select generate a response based on the // results. To use this feature, you must first add FAQ questions to your index by - // following the steps at Adding frequently asked questions (FAQs) to an index (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html) - // . + // following the steps at [Adding frequently asked questions (FAQs) to an index]. + // + // [Adding frequently asked questions (FAQs) to an index]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html ExactResponse bool // Contains the Amazon Kendra filter string to use if enabled. For more - // information on the Amazon Kendra search filter JSON format, see Using document - // attributes to filter search results (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering) - // . + // information on the Amazon Kendra search filter JSON format, see [Using document attributes to filter search results]. + // + // [Using document attributes to filter search results]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering QueryFilterString *string // Specifies whether to enable an Amazon Kendra filter string or not. @@ -3628,13 +3893,17 @@ type RecommendedIntentSummary struct { // window is always relative to the last time that the that utterances were // aggregated. For example, if the ListAggregatedUtterances operation is called at // 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. +// 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. @@ -3647,8 +3916,11 @@ 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 // // This member is required. @@ -3694,17 +3966,25 @@ type RuntimeHintDetails struct { // You can provide Amazon Lex with hints to the phrases that a customer is likely // to use for a slot. When a slot with hints is resolved, the phrases in the // 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) -// . +// 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]. +// +// [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]. + // + // The intent name and slot name must exist. + // + // [Using hints to improve accuracy]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html SlotHints map[string]map[string]RuntimeHintDetails noSmithyDocumentSerde @@ -3843,10 +4123,13 @@ type SentimentAnalysisSettings struct { type SessionDataSortBy struct { // The measure by which to sort the session analytics data. + // // - conversationStartTime – The date and time when the conversation began. A // conversation is defined as a unique combination of a sessionId and an // originatingRequestId . + // // - numberOfTurns – The number of turns that the session took. + // // - conversationDurationSeconds – The duration of the conversation in seconds. // // This member is required. @@ -3895,9 +4178,13 @@ type SessionSpecification struct { LocaleId *string // The mode of the session. The possible values are as follows: + // // - Speech – The session was spoken. + // // - Text – The session was written. + // // - DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency). + // // - MultiMode – The session used multiple modes. Mode AnalyticsModality @@ -4187,15 +4474,19 @@ 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) - // . + // information, see [Creating custom slot types]. + // // - 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) - // . + // slot type. For more information, see [AMAZON.AlphaNumeric]AMAZON.AlphaNumeric . + // // - 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) - // . + // For more information, see [Using a custom grammar slot type]. + // + // [AMAZON.AlphaNumeric]: https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html + // [Creating custom slot types]: https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html + // [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. @@ -4291,15 +4582,24 @@ type SlotValueOverride struct { // Provides a regular expression used to validate the value of a slot. 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 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: + // "\⁠u005A". + // + // The following regular expression operators are not supported: + // // - Infinite repeaters: *, +, or {x,} with no upper bound. + // // - Wild card (.) // // This member is required. @@ -4313,11 +4613,14 @@ 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: + // // - 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 . // // This member is required. @@ -4422,13 +4725,16 @@ type SubSlotTypeComposition struct { noSmithyDocumentSerde } -// Subslot elicitation settings. DefaultValueSpecification is a list of default -// values for a constituent sub slot in a composite slot. Default values are used -// when Amazon Lex hasn't determined a value for a slot. You can specify default -// values from context variables, session attributes, and defined values. This is -// similar to DefaultValueSpecification for slots. PromptSpecification is the -// prompt that Amazon Lex uses to elicit the sub slot value from the user. This is -// similar to PromptSpecification for slots. +// Subslot elicitation settings. +// +// DefaultValueSpecification is a list of default values for a constituent sub +// slot in a composite slot. Default values are used when Amazon Lex hasn't +// determined a value for a slot. You can specify default values from context +// variables, session attributes, and defined values. This is similar to +// DefaultValueSpecification for slots. +// +// PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot +// value from the user. This is similar to PromptSpecification for slots. type SubSlotValueElicitationSetting struct { // Specifies a list of message groups that Amazon Lex sends to a user to elicit a @@ -4458,8 +4764,10 @@ type SubSlotValueElicitationSetting struct { // test execution. type TestExecutionResultFilterBy struct { - // Specifies which results to filter. See Test result details">Test results details (https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html) - // for details about different types of results. + // Specifies which results to filter. See [Test result details">Test results details] for details about different types of + // results. + // + // [Test result details">Test results details]: https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html // // This member is required. ResultTypeFilter TestResultTypeFilter @@ -4471,9 +4779,10 @@ type TestExecutionResultFilterBy struct { noSmithyDocumentSerde } -// Contains the results of the test execution, grouped by type of results. See -// Test result details">Test results details (https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html) +// Contains the results of the test execution, grouped by type of results. See [Test result details">Test results details] // for details about different types of results. +// +// [Test result details">Test results details]: https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html type TestExecutionResultItems struct { // Results related to conversations in the test set, including metrics about @@ -5068,20 +5377,26 @@ type UtteranceBotResponse struct { Content *string // The type of the response. The following values are possible: + // // - PlainText – A plain text string. + // // - CustomPayload – A response string that you can customize to include data or // metadata for your application. + // // - SSML – A string that includes Speech Synthesis Markup Language to customize // the audio response. - // - ImageResponseCard – An image with buttons that the customer can select. See - // ImageResponseCard (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html) + // + // - ImageResponseCard – An image with buttons that the customer can select. See [ImageResponseCard] // for more information. + // + // [ImageResponseCard]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html ContentType UtteranceContentType // A card that is shown to the user by a messaging platform. You define the - // contents of the card, the card is displayed by the platform. When you use a - // response card, the response from the user is constrained to the text associated - // with a button on the card. + // contents of the card, the card is displayed by the platform. + // + // When you use a response card, the response from the user is constrained to the + // text associated with a button on the card. ImageResponseCard *ImageResponseCard noSmithyDocumentSerde @@ -5091,7 +5406,9 @@ type UtteranceBotResponse struct { type UtteranceDataSortBy struct { // The measure by which to sort the utterance analytics data. + // // - Count – The number of utterances. + // // - UtteranceTimestamp – The date and time of the utterance. // // This member is required. @@ -5190,20 +5507,29 @@ type UtteranceSpecification struct { ConversationStartTime *time.Time // The type of dialog action that the utterance is associated to. See the type - // field in DialogAction (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html) - // for more information. + // field in [DialogAction]for more information. + // + // [DialogAction]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html DialogActionType *string // The input type of the utterance. The possible values are as follows: + // // - 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 InputType *string @@ -5214,18 +5540,27 @@ type UtteranceSpecification struct { LocaleId *string // The mode of the session. The possible values are as follows: + // // - Speech – The session consisted of spoken dialogue. + // // - Text – The session consisted of written dialogue. + // // - DTMF – The session consisted of touch-tone keypad (Dual Tone // Multi-Frequency) key presses. + // // - MultiMode – The session consisted of multiple modes. Mode AnalyticsModality // The output type of the utterance. The possible values are as follows: + // // - audio/mpeg + // // - audio/ogg + // // - audio/pcm (16 KHz) + // // - audio/ (defaults to mpeg ) + // // - text/plain; charset=utf-8 OutputType *string @@ -5259,10 +5594,12 @@ 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) - // in the Amazon Polly developer guide. If you do not specify a value, the default - // is standard . + // interaction with the user. For more information, see the [engine parameter of the SynthesizeSpeech operation]engine SynthesizeSpeech + // in the Amazon Polly developer guide. + // + // If you do not specify a value, the default is standard . + // + // [engine parameter of the SynthesizeSpeech operation]: https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine Engine VoiceEngine noSmithyDocumentSerde diff --git a/service/lexruntimeservice/api_op_GetSession.go b/service/lexruntimeservice/api_op_GetSession.go index 6e514c94885..bd24f511739 100644 --- a/service/lexruntimeservice/api_op_GetSession.go +++ b/service/lexruntimeservice/api_op_GetSession.go @@ -46,8 +46,10 @@ type GetSessionInput struct { UserId *string // A string used to filter the intents returned in the recentIntentSummaryView - // structure. When you specify a filter, only intents with their checkpointLabel - // field set to that string are returned. + // structure. + // + // When you specify a filter, only intents with their checkpointLabel field set to + // that string are returned. CheckpointLabelFilter *string noSmithyDocumentSerde @@ -56,9 +58,10 @@ 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. @@ -67,8 +70,10 @@ type GetSessionOutput struct { // An array of information about the intents used in the session. The array can // contain a maximum of three summaries. If more than three intents are used in the // session, the recentIntentSummaryView operation contains information about the - // last three intents used. If you set the checkpointLabelFilter parameter in the - // request, the array contains only the intents with the specified label. + // last three intents used. + // + // If you set the checkpointLabelFilter parameter in the 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. diff --git a/service/lexruntimeservice/api_op_PostContent.go b/service/lexruntimeservice/api_op_PostContent.go index f1072fb8a95..bfe90a2d217 100644 --- a/service/lexruntimeservice/api_op_PostContent.go +++ b/service/lexruntimeservice/api_op_PostContent.go @@ -12,19 +12,26 @@ import ( "io" ) -// Sends user input (text or speech) to Amazon Lex. Clients use this API to send +// Sends user input (text or speech) to Amazon Lex. Clients use this API to send +// // text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user -// input using the machine learning model that it built for the bot. The -// PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz -// 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: +// input using the machine learning model that it built for the bot. +// +// The PostContent operation supports audio input at 8kHz and 16kHz. You can use +// 8kHz 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.". // @@ -34,23 +41,31 @@ import ( // 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) -// . +// . For more information, see [Managing Conversation Context]. +// +// [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{} @@ -78,42 +93,59 @@ type PostContentInput struct { // This member is required. BotName *string - // 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: + // 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 // // This member is required. ContentType *string - // User input in PCM or Opus audio format or text format as described in the - // Content-Type HTTP header. You can stream audio data to Amazon Lex or you can - // create a local buffer that captures all of the audio data before sending. In - // general, you get better performance if you stream audio data rather than - // buffering the data locally. + // User input in PCM or Opus audio format or text format as described in the + // Content-Type HTTP header. + // + // You can stream audio data to Amazon Lex or you can create a local buffer that + // captures all of the audio data before sending. In general, you get better + // performance if you stream audio data rather than buffering the data locally. // // 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. + // 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 @@ -123,53 +155,72 @@ type PostContentInput struct { // 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. + // 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 - // previous intent is fulfilled, or by including the context in the request, If you - // don't specify a list of contexts, Amazon Lex will use the current list of - // contexts for the session. If you specify an empty list, all contexts for the + // previous intent is fulfilled, or by including the context in the request, + // + // If you don't specify a list of contexts, Amazon Lex will use the current list + // of contexts for the session. If you specify an empty list, all contexts for the // session are cleared. // // This value conforms to the media type: application/json ActiveContexts *string // 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) - // . + // + // 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]. + // + // [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 // You pass this value as the x-amz-lex-session-attributes HTTP header. + // // 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]. + // + // [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 @@ -180,14 +231,16 @@ 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 // One to four alternative intents that may be applicable to the user's intent. + // // Each alternative includes a score that indicates how confident Amazon Lex is // that the intent matches the user's intent. The intents are sorted by the // confidence score. @@ -215,65 +268,89 @@ type PostContentOutput struct { // Identifies the current state of the user interaction. Amazon Lex returns one of // 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 + // 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., + // 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. + // + // - 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 - // encodedInputTranscript field contains the text extracted from the audio stream. - // This is the text that is actually processed to recognize intents and slot - // values. You can use this information to determine if Amazon Lex is correctly - // processing the audio that you send. The encodedInputTranscript field is base-64 - // encoded. You must decode the field before you can use the value. + // The text used to process the request. + // + // If the input was an audio stream, the encodedInputTranscript field contains the + // text extracted from the audio stream. This is the text that is actually + // processed to recognize intents and slot values. You can use this information to + // determine if Amazon Lex is correctly processing the audio that you send. + // + // The encodedInputTranscript field is base-64 encoded. You must decode the field + // before you can use the value. EncodedInputTranscript *string // The message to convey to the user. The message can come from the bot's - // configuration or from a Lambda function. If the intent is not configured with a - // Lambda function, or if the Lambda function returned Delegate as the - // dialogAction.type in its response, Amazon Lex decides on the next course of - // action and selects an appropriate message from the bot's configuration based on - // the current interaction context. For example, if Amazon Lex isn't able to - // understand user input, it uses a clarification prompt message. When you create - // an intent 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 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. + // configuration or from a Lambda function. + // + // If the intent is not configured with a Lambda function, or if the Lambda + // function returned Delegate as the dialogAction.type in its response, Amazon Lex + // decides on the next course of action and selects an appropriate message from the + // bot's configuration based on the current interaction context. For example, if + // Amazon Lex isn't able to understand user input, it uses a clarification prompt + // message. + // + // When you create an intent 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 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, - // en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In - // all other locales, the inputTranscript field is null. You should use the - // encodedInputTranscript field instead. If the input was an audio stream, the - // inputTranscript field contains the text extracted from the audio stream. This is - // the text that is actually processed to recognize intents and slot values. You - // can use this information to determine if Amazon Lex is correctly processing the - // audio that you send. + // The text used to process the request. + // + // You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, + // es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the + // inputTranscript field is null. You should use the encodedInputTranscript field + // instead. + // + // If the input was an audio stream, the inputTranscript field contains the text + // extracted from the audio stream. This is the text that is actually processed to + // recognize intents and slot values. You can use this information to determine if + // Amazon Lex is correctly processing the audio that you send. // // Deprecated: The inputTranscript field is deprecated, use the // encodedInputTranscript field instead. The inputTranscript field is available @@ -286,19 +363,25 @@ type PostContentOutput struct { // You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, // es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field - // is null. You should use the encodedMessage field instead. The message to convey - // to the user. The message can come from the bot's configuration or from a Lambda - // function. If the intent is not configured with a Lambda function, or if the - // Lambda function returned Delegate as the dialogAction.type in its response, - // Amazon Lex decides on the next course of action and selects an appropriate - // message from the bot's configuration based on the current interaction context. - // For example, if Amazon Lex isn't able to understand user input, it uses a - // clarification prompt message. When you create an intent 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 function returns a - // message, Amazon Lex passes it to the client in its response. + // is null. You should use the encodedMessage field instead. + // + // The message to convey to the user. The message can come from the bot's + // configuration or from a Lambda function. + // + // If the intent is not configured with a Lambda function, or if the Lambda + // function returned Delegate as the dialogAction.type in its response, Amazon Lex + // decides on the next course of action and selects an appropriate message from the + // bot's configuration based on the current interaction context. For example, if + // Amazon Lex isn't able to understand user input, it uses a clarification prompt + // message. + // + // When you create an intent 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 function returns a message, Amazon Lex passes it to the client in + // its response. // // Deprecated: The message field is deprecated, use the encodedMessage field // instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, @@ -306,9 +389,13 @@ 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. @@ -316,18 +403,21 @@ type PostContentOutput struct { // 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. The score is a relative score, not an absolute score. The score may change + // 1.0. + // + // The score is a relative score, not an absolute score. The score may change // based on improvements to Amazon Lex. // // This value conforms to the media type: application/json NluIntentConfidence *string - // The sentiment expressed in an utterance. When the bot is configured to send - // utterances to Amazon Comprehend for sentiment analysis, this field contains the - // result of the analysis. + // The sentiment expressed in an utterance. + // + // When the bot is configured to send utterances to Amazon Comprehend for + // sentiment analysis, this field contains the result of the analysis. SentimentResponse *string - // Map of key/value pairs representing the session-specific context information. + // Map of key/value pairs representing the session-specific context information. // // This value conforms to the media type: application/json SessionAttributes *string @@ -335,19 +425,21 @@ 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 - // 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 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 . + // 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 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 . // // 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 e4660e2427f..1447ca5f7d9 100644 --- a/service/lexruntimeservice/api_op_PostText.go +++ b/service/lexruntimeservice/api_op_PostText.go @@ -13,15 +13,19 @@ import ( // Sends user input to Amazon Lex. Client applications can use this API to send // requests to Amazon Lex at runtime. Amazon Lex then interprets the user input -// 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: +// 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.". @@ -33,23 +37,31 @@ import ( // 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) -// . +// . For more information, see [Managing Conversation Context]. +// +// [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{} @@ -84,15 +96,21 @@ type PostTextInput struct { // 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. + // 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 @@ -103,22 +121,29 @@ type PostTextInput struct { UserId *string // A list of contexts active for the request. A context can be activated when a - // previous intent is fulfilled, or by including the context in the request, If you - // don't specify a list of contexts, Amazon Lex will use the current list of - // contexts for the session. If you specify an empty list, all contexts for the + // previous intent is fulfilled, or by including the context in the request, + // + // If you don't specify a list of contexts, Amazon Lex will use the current list + // of contexts for the session. If you specify an empty list, all contexts for the // 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]. + // + // [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]. + // + // [Setting Session Attributes]: https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs SessionAttributes map[string]string noSmithyDocumentSerde @@ -127,12 +152,14 @@ 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. + // // Each alternative includes a score that indicates how confident Amazon Lex is // that the intent matches the user's intent. The intents are sorted by the // confidence score. @@ -143,56 +170,78 @@ type PostTextOutput struct { // another version. 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 + // Identifies the current state of the user interaction. Amazon Lex returns one + // of 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). + // + // - 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 + // + // 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. + // + // - 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. IntentName *string // The message to convey to the user. The message can come from the bot's - // configuration or from a Lambda function. If the intent is not configured with a - // Lambda function, or if the Lambda function returned Delegate as the - // dialogAction.type its response, Amazon Lex decides on the next course of action - // and selects an appropriate message from the bot's configuration based on the - // current interaction context. For example, if Amazon Lex isn't able to understand - // user input, it uses a clarification prompt message. When you create an intent - // 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 - // function returns a message, Amazon Lex passes it to the client in its response. + // configuration or from a Lambda function. + // + // If the intent is not configured with a Lambda function, or if the Lambda + // function returned Delegate as the dialogAction.type its response, Amazon Lex + // decides on the next course of action and selects an appropriate message from the + // bot's configuration based on the current interaction context. For example, if + // Amazon Lex isn't able to understand user input, it uses a clarification prompt + // message. + // + // When you create an intent 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 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. @@ -200,9 +249,12 @@ type PostTextOutput struct { // 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 + // 1.0. For more information, see [Confidence Scores]. + // + // The score is a relative score, not an absolute score. The score may change // based on improvements to Amazon Lex. + // + // [Confidence Scores]: https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html NluIntentConfidence *types.IntentConfidence // Represents the options that the user has to respond to the current prompt. @@ -211,9 +263,10 @@ type PostTextOutput struct { // function). ResponseCard *types.ResponseCard - // The sentiment expressed in and utterance. When the bot is configured to send - // utterances to Amazon Comprehend for sentiment analysis, this field contains the - // result of the analysis. + // The sentiment expressed in and utterance. + // + // When the bot is configured to send utterances to Amazon Comprehend for + // sentiment analysis, this field contains the result of the analysis. SentimentResponse *types.SentimentResponse // A map of key-value pairs representing the session-specific context information. @@ -226,12 +279,14 @@ type PostTextOutput struct { // 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 + // 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 // 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 . diff --git a/service/lexruntimeservice/api_op_PutSession.go b/service/lexruntimeservice/api_op_PutSession.go index df7adc0ea80..70cc1092c4b 100644 --- a/service/lexruntimeservice/api_op_PutSession.go +++ b/service/lexruntimeservice/api_op_PutSession.go @@ -13,9 +13,11 @@ 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) -// . +// Use this operation to enable your application to set the state of the bot. +// +// For more information, see [Managing Sessions]. +// +// [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{} @@ -51,26 +53,36 @@ type PutSessionInput struct { // 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 - // previous intent is fulfilled, or by including the context in the request, If you - // don't specify a list of contexts, Amazon Lex will use the current list of - // contexts for the session. If you specify an empty list, all contexts for the + // previous intent is fulfilled, or by including the context in the request, + // + // If you don't specify a list of contexts, Amazon Lex will use the current list + // of contexts for the session. If you specify an empty list, all contexts for the // session are cleared. ActiveContexts []types.ActiveContext @@ -79,13 +91,18 @@ type PutSessionInput struct { // 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 + // 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 @@ -116,29 +133,37 @@ type PutSessionOutput struct { // - 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 - // is base-64 encoded. You must decode the field before you can use the value. + // The next message that should be presented to the user. + // + // The encodedMessage field is base-64 encoded. You must decode the field before + // you can use the value. EncodedMessage *string // The name of the current intent. IntentName *string - // The next message that should be presented to the user. You can only use this - // field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and - // it-IT locales. In all other locales, the message field is null. You should use - // the encodedMessage field instead. + // The next message that should be presented to the user. + // + // You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, + // es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field + // is null. You should use the encodedMessage field instead. // // Deprecated: The message field is deprecated, use the encodedMessage field // instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, @@ -146,9 +171,13 @@ 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. @@ -167,14 +196,16 @@ type PutSessionOutput struct { SlotToElicit *string // Map of zero or more intent slots Amazon Lex detected from the user input during - // 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 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 . + // 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 + // 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 . // // This value conforms to the media type: application/json Slots *string diff --git a/service/lexruntimeservice/options.go b/service/lexruntimeservice/options.go index adef318e20c..3cf185f0b0d 100644 --- a/service/lexruntimeservice/options.go +++ b/service/lexruntimeservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lexruntimeservice/types/enums.go b/service/lexruntimeservice/types/enums.go index f0c86c23c8b..91844f8261f 100644 --- a/service/lexruntimeservice/types/enums.go +++ b/service/lexruntimeservice/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ConfirmationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfirmationStatus) Values() []ConfirmationStatus { return []ConfirmationStatus{ "None", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "application/vnd.amazonaws.card.generic", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for DialogActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DialogActionType) Values() []DialogActionType { return []DialogActionType{ "ElicitIntent", @@ -75,8 +78,9 @@ const ( ) // Values returns all known values for DialogState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DialogState) Values() []DialogState { return []DialogState{ "ElicitIntent", @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for FulfillmentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FulfillmentState) Values() []FulfillmentState { return []FulfillmentState{ "Fulfilled", @@ -119,8 +124,9 @@ const ( ) // Values returns all known values for MessageFormatType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageFormatType) Values() []MessageFormatType { return []MessageFormatType{ "PlainText", diff --git a/service/lexruntimeservice/types/errors.go b/service/lexruntimeservice/types/errors.go index bf8f31addd1..e91413661d5 100644 --- a/service/lexruntimeservice/types/errors.go +++ b/service/lexruntimeservice/types/errors.go @@ -34,7 +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 +// 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,11 +88,15 @@ 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 +// 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 { diff --git a/service/lexruntimeservice/types/types.go b/service/lexruntimeservice/types/types.go index f153b6f46d8..27660893749 100644 --- a/service/lexruntimeservice/types/types.go +++ b/service/lexruntimeservice/types/types.go @@ -73,24 +73,31 @@ 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. // // - 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. FulfillmentState FulfillmentState @@ -103,11 +110,15 @@ type DialogAction struct { 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) - // . + // more messages. For more information, see [Message Groups]. + // + // [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. @@ -160,40 +171,51 @@ 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. // // - 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. + // 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 // 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. 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. FulfillmentState FulfillmentState @@ -247,9 +269,10 @@ type ResponseCard struct { noSmithyDocumentSerde } -// The sentiment expressed in an utterance. When the bot is configured to send -// utterances to Amazon Comprehend for sentiment analysis, this field structure -// contains the result of the analysis. +// The sentiment expressed in an utterance. +// +// When the bot is configured to send utterances to Amazon Comprehend for +// sentiment analysis, this field structure contains the result of the analysis. type SentimentResponse struct { // The inferred sentiment that Amazon Comprehend has the highest confidence in. diff --git a/service/lexruntimev2/api_op_DeleteSession.go b/service/lexruntimev2/api_op_DeleteSession.go index b31d19bc0be..cb815f29850 100644 --- a/service/lexruntimev2/api_op_DeleteSession.go +++ b/service/lexruntimev2/api_op_DeleteSession.go @@ -10,15 +10,21 @@ 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 18e7fd0c000..4c9d88e985a 100644 --- a/service/lexruntimev2/api_op_GetSession.go +++ b/service/lexruntimev2/api_op_GetSession.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// . +// 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 . func (c *Client) GetSession(ctx context.Context, params *GetSessionInput, optFns ...func(*Options)) (*GetSessionOutput, error) { if params == nil { params = &GetSessionInput{} @@ -60,10 +62,11 @@ type GetSessionInput struct { type GetSessionOutput struct { // A list of intents that Amazon Lex V2 determined might satisfy the user's - // utterance. Each interpretation includes the intent, a score that indicates how - // confident Amazon Lex V2 is that the interpretation is the correct one, and an - // optional sentiment response that indicates the sentiment expressed in the // utterance. + // + // Each interpretation includes the intent, a score that indicates how confident + // Amazon Lex V2 is that the interpretation is the correct one, and an optional + // sentiment response that indicates the sentiment expressed in the utterance. Interpretations []types.Interpretation // A list of messages that were last sent to the user. The messages are ordered @@ -74,9 +77,10 @@ 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 2ce4d960426..f8875bb24a1 100644 --- a/service/lexruntimev2/api_op_PutSession.go +++ b/service/lexruntimev2/api_op_PutSession.go @@ -64,12 +64,15 @@ type PutSessionInput struct { 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: . + // application. + // + // 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 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. ResponseContentType *string diff --git a/service/lexruntimev2/api_op_RecognizeText.go b/service/lexruntimev2/api_op_RecognizeText.go index b8efa543101..99a70cff688 100644 --- a/service/lexruntimev2/api_op_RecognizeText.go +++ b/service/lexruntimev2/api_op_RecognizeText.go @@ -13,25 +13,31 @@ import ( // Sends user input to Amazon Lex V2. Client applications use this API to send // requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user -// input using the machine learning model that it build for the bot. In response, -// 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) -// . +// input using the machine learning model that it build for the bot. +// +// In response, 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]. +// // - 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]. +// +// [PostFulfillmentStatusSpecification]: https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html +// [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{} @@ -75,8 +81,10 @@ 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. @@ -88,10 +96,11 @@ type RecognizeTextInput struct { type RecognizeTextOutput struct { // A list of intents that Amazon Lex V2 determined might satisfy the user's - // utterance. Each interpretation includes the intent, a score that indicates now - // confident Amazon Lex V2 is that the interpretation is the correct one, and an - // optional sentiment response that indicates the sentiment expressed in the // utterance. + // + // Each interpretation includes the intent, a score that indicates now confident + // Amazon Lex V2 is that the interpretation is the correct one, and an optional + // sentiment response that indicates the sentiment expressed in the utterance. Interpretations []types.Interpretation // A list of messages last sent to the user. The messages are ordered based on the @@ -108,9 +117,10 @@ type RecognizeTextOutput struct { // The identifier of the session in use. SessionId *string - // Represents the current state of the dialog between the user and the bot. Use - // this to determine the progress of the conversation and what the next action may - // be. + // Represents the current state of the dialog between the user and the bot. + // + // Use this to determine the progress of the conversation and what the next action + // may be. SessionState *types.SessionState // Metadata pertaining to the operation's result. diff --git a/service/lexruntimev2/api_op_RecognizeUtterance.go b/service/lexruntimev2/api_op_RecognizeUtterance.go index 41806a3e45f..c0cf0764565 100644 --- a/service/lexruntimev2/api_op_RecognizeUtterance.go +++ b/service/lexruntimev2/api_op_RecognizeUtterance.go @@ -14,39 +14,52 @@ import ( // 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 // // 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) -// . +// response from Amazon Lex V2. +// +// If the optional post-fulfillment response is specified, the messages are +// returned as follows. For more information, see [PostFulfillmentStatusSpecification]. +// // - 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]. +// +// [PostFulfillmentStatusSpecification]: https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html +// [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{} @@ -81,16 +94,23 @@ 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 // // - Text format + // // - text/plain; charset=utf-8 // // This member is required. @@ -106,36 +126,50 @@ 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 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 // 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. + // the user. + // + // The sessionState field must be compressed using gzip and then base64 encoded + // before sending to Amazon Lex V2. SessionState *string noSmithyDocumentSerde @@ -159,51 +193,63 @@ type RecognizeUtteranceOutput struct { // touch-tone keypad. InputMode *string - // The text used to process the request. If the input was an audio stream, the - // inputTranscript field contains the text extracted from the audio stream. This is - // the text that is actually processed to recognize intents and slot values. You - // can use this information to determine if Amazon Lex V2 is correctly processing - // the audio that you send. The inputTranscript field is compressed with gzip and - // then base64 encoded. Before you can use the contents of the field, you must - // decode and decompress the contents. See the example for a simple function to - // decode and decompress the contents. + // The text used to process the request. + // + // If the input was an audio stream, the inputTranscript field contains the text + // extracted from the audio stream. This is the text that is actually processed to + // recognize intents and slot values. You can use this information to determine if + // Amazon Lex V2 is correctly processing the audio that you send. + // + // The inputTranscript field is compressed with gzip and then base64 encoded. + // Before you can use the contents of the field, you must decode and decompress the + // contents. See the example for a simple function to decode and decompress the + // contents. InputTranscript *string // A list of intents that Amazon Lex V2 determined might satisfy the user's - // utterance. Each interpretation includes the intent, a score that indicates how - // confident Amazon Lex V2 is that the interpretation is the correct one, and an - // optional sentiment response that indicates the sentiment expressed in the - // utterance. The interpretations field is compressed with gzip and then base64 - // encoded. Before you can use the contents of the field, you must decode and - // decompress the contents. See the example for a simple function to decode and - // decompress the contents. + // utterance. + // + // Each interpretation includes the intent, a score that indicates how confident + // Amazon Lex V2 is that the interpretation is the correct one, and an optional + // sentiment response that indicates the sentiment expressed in the utterance. + // + // The interpretations field is compressed with gzip and then base64 encoded. + // Before you can use the contents of the field, you must decode and decompress the + // contents. See the example for a simple function to decode and decompress the + // contents. Interpretations *string // A list of messages that were last sent to the user. The messages are ordered // based on the order that you returned the messages from your Lambda function or - // the order that the messages are defined in the bot. The messages field is - // compressed with gzip and then base64 encoded. Before you can use the contents of - // the field, you must decode and decompress the contents. See the example for a - // simple function to decode and decompress the contents. + // the order that the messages are defined in the bot. + // + // The messages field is compressed with gzip and then base64 encoded. Before you + // can use the contents of the field, you must decode and decompress the contents. + // See the example for a simple function to decode and decompress the contents. Messages *string // The bot member that recognized the utterance. RecognizedBotMember *string - // The attributes sent in the request. The requestAttributes field is compressed - // with gzip and then base64 encoded. Before you can use the contents of the field, - // you must decode and decompress the contents. + // The attributes sent in the request. + // + // The requestAttributes field is compressed with gzip and then base64 encoded. + // Before you can use the contents of the field, you must decode and decompress the + // contents. RequestAttributes *string // The identifier of the session in use. SessionId *string - // Represents the current state of the dialog between the user and the bot. Use - // this to determine the progress of the conversation and what the next action - // might be. The sessionState field is compressed with gzip and then base64 - // encoded. Before you can use the contents of the field, you must decode and - // decompress the contents. See the example for a simple function to decode and - // decompress the contents. + // Represents the current state of the dialog between the user and the bot. + // + // Use this to determine the progress of the conversation and what the next action + // might be. + // + // The sessionState field is compressed with gzip and then base64 encoded. Before + // you can use the contents of the field, you must decode and decompress the + // contents. See the example for a simple function to decode and decompress the + // contents. SessionState *string // Metadata pertaining to the operation's result. diff --git a/service/lexruntimev2/api_op_StartConversation.go b/service/lexruntimev2/api_op_StartConversation.go index 0ab8f4297a3..588d25dd927 100644 --- a/service/lexruntimev2/api_op_StartConversation.go +++ b/service/lexruntimev2/api_op_StartConversation.go @@ -18,32 +18,50 @@ import ( // Starts an HTTP/2 bidirectional event stream that enables you to send audio, // text, or DTMF input in real time. After your application starts a conversation, // 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 -// 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) -// . +// 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 post-fulfillment response is specified, the messages are +// returned as follows. For more information, see [PostFulfillmentStatusSpecification]. +// // - 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]. +// +// 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] +// // 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++] +// +// [AWS SDK for Java V2] +// +// [AWS SDK for Ruby V3] +// +// [AWS SDK for Ruby V3]: https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex.v2-2020-08-07/StartConversation +// [PostFulfillmentStatusSpecification]: https://docs.aws.amazon.com/lexv2/latest/dg/API_PostFulfillmentStatusSpecification.html +// [AWS SDK for Java V2]: https://docs.aws.amazon.com/goto/SdkForJavaV2/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 +// [Update message]: https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-update.html +// [Completion message]: https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete.html func (c *Client) StartConversation(ctx context.Context, params *StartConversationInput, optFns ...func(*Options)) (*StartConversationOutput, error) { if params == nil { params = &StartConversationInput{} diff --git a/service/lexruntimev2/options.go b/service/lexruntimev2/options.go index 9f4d6b480db..ca4b109d1a7 100644 --- a/service/lexruntimev2/options.go +++ b/service/lexruntimev2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lexruntimev2/types/enums.go b/service/lexruntimev2/types/enums.go index 85b716638eb..78ad065ce2c 100644 --- a/service/lexruntimev2/types/enums.go +++ b/service/lexruntimev2/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ConfirmationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfirmationState) Values() []ConfirmationState { return []ConfirmationState{ "Confirmed", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ConversationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConversationMode) Values() []ConversationMode { return []ConversationMode{ "AUDIO", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for DialogActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DialogActionType) Values() []DialogActionType { return []DialogActionType{ "Close", @@ -76,8 +79,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -99,8 +103,9 @@ const ( ) // Values returns all known values for IntentState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntentState) Values() []IntentState { return []IntentState{ "Failed", @@ -121,8 +126,9 @@ const ( ) // Values returns all known values for InterpretationSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InterpretationSource) Values() []InterpretationSource { return []InterpretationSource{ "Bedrock", @@ -141,8 +147,9 @@ const ( ) // Values returns all known values for MessageContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageContentType) Values() []MessageContentType { return []MessageContentType{ "CustomPayload", @@ -163,6 +170,7 @@ const ( // Values returns all known values for PlaybackInterruptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PlaybackInterruptionReason) Values() []PlaybackInterruptionReason { return []PlaybackInterruptionReason{ @@ -183,8 +191,9 @@ const ( ) // Values returns all known values for SentimentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SentimentType) Values() []SentimentType { return []SentimentType{ "MIXED", @@ -204,8 +213,9 @@ const ( ) // 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. +// the future, and so 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{ "Scalar", @@ -224,8 +234,9 @@ const ( ) // 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. +// in the future, and so 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 3481b3b18f6..fdcb59ee004 100644 --- a/service/lexruntimev2/types/types.go +++ b/service/lexruntimev2/types/types.go @@ -8,17 +8,20 @@ import ( // Contains information about the contexts that a user is using in a session. You // 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 -// configured as a trigger are considered for follow up. +// 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 configured as a trigger are considered for +// follow up. type ActiveContext struct { // A list of contexts active for the request. A context can be activated when a - // previous intent is fulfilled, or by including the context in the request. If you - // don't specify a list of contexts, Amazon Lex V2 will use the current list of - // contexts for the session. If you specify an empty list, all contexts for the - // session are cleared. + // previous intent is fulfilled, or by including the context in the request. + // + // If you don't specify a list of contexts, Amazon Lex V2 will use the current + // list of contexts for the session. If you specify an empty list, all contexts for + // the session are cleared. // // This member is required. ContextAttributes map[string]string @@ -57,15 +60,17 @@ type ActiveContextTimeToLive struct { } // Represents a chunk of audio sent from the client application to Amazon Lex V2. -// The audio is all or part of an utterance from the user. Amazon Lex V2 -// accumulates audio chunks until it recognizes a natural pause in speech before -// processing the input. +// The audio is all or part of an utterance from the user. +// +// Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause in +// speech before processing the input. 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 + // + // audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; + // is-big-endian=false // // This member is required. ContentType *string @@ -138,20 +143,29 @@ 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 // // This member is required. @@ -162,10 +176,12 @@ type ConfigurationEvent struct { ClientTimestampMillis int64 // Determines whether Amazon Lex V2 should send audio responses to the client - // application. Set this field to false when the client is operating in a playback - // mode where audio responses are played to the user. If the client isn't operating - // in playback mode, such as a text chat application, set this to true so that - // Amazon Lex V2 doesn't wait for the prompt to finish playing on the client. + // application. + // + // Set this field to false when the client is operating in a playback mode where + // audio responses are played to the user. If the client isn't operating in + // playback mode, such as a text chat application, set this to true so that 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 @@ -173,17 +189,22 @@ type ConfigurationEvent struct { 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: . + // Lex V2. + // + // The namespace x-amz-lex: is reserved for special attributes. Don't 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) - // field. + // A list of messages to send to the user. + // + // If you set the welcomeMessage field, you must also set the [DialogAction]DialogAction + // structure's [type]type field. + // + // [DialogAction]: https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html + // [type]: https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type WelcomeMessages []Message noSmithyDocumentSerde @@ -194,13 +215,17 @@ type DialogAction struct { // The next action that the bot should take in its interaction with the user. The // following values are possible: + // // - 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. // // This member is required. @@ -210,9 +235,12 @@ type DialogAction struct { // 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" - // For more information, see Using spelling to enter slot values (https://docs.aws.amazon.com/lexv2/latest/dg/spelling-styles.html) - // . + // + // For more information, see [Using spelling to enter slot values]. + // + // [Using spelling to enter slot values]: https://docs.aws.amazon.com/lexv2/latest/dg/spelling-styles.html SlotElicitationStyle StyleType // The name of the slot that should be elicited from the user. @@ -291,9 +319,10 @@ type HeartbeatEvent struct { } // A card that is shown to the user by a messaging platform. You define the -// contents of the card, the card is displayed by the platform. When you use a -// response card, the response from the user is constrained to the text associated -// with a button on the card. +// contents of the card, the card is displayed by the platform. +// +// When you use a response card, the response from the user is constrained to the +// text associated with a button on the card. type ImageResponseCard struct { // The title to display on the response card. The format of the title is @@ -337,13 +366,19 @@ type Intent struct { // Indicates the fulfillment state for the intent. The meanings of each value are // as follows: + // // - Failed – The bot failed to fulfill the intent. + // // - Fulfilled – The bot has completed fulfillment of the intent. + // // - FulfillmentInProgress – The bot is in the middle of fulfilling the intent. + // // - InProgress – The bot is in the middle of eliciting the slot values that are // necessary to fulfill the intent. + // // - ReadyForFulfillment – The bot has elicited all the slot values for the // intent and is ready to fulfill the intent. + // // - Waiting – The bot is waiting for a response from the user (limited to // streaming conversations). State IntentState @@ -365,10 +400,11 @@ type IntentResultEvent struct { InputMode InputMode // A list of intents that Amazon Lex V2 determined might satisfy the user's - // utterance. Each interpretation includes the intent, a score that indicates how - // confident Amazon Lex V2 is that the interpretation is the correct one, and an - // optional sentiment response that indicates the sentiment expressed in the // utterance. + // + // Each interpretation includes the intent, a score that indicates how confident + // Amazon Lex V2 is that the interpretation is the correct one, and an optional + // sentiment response that indicates the sentiment expressed in the utterance. Interpretations []Interpretation // The bot member that is processing the intent. @@ -404,9 +440,10 @@ type Interpretation struct { // AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. NluConfidence *ConfidenceScore - // The sentiment expressed in an utterance. When the bot is configured to send - // utterances to Amazon Comprehend for sentiment analysis, this field contains the - // result of the analysis. + // The sentiment expressed in an utterance. + // + // When the bot is configured to send utterances to Amazon Comprehend for + // sentiment analysis, this field contains the result of the analysis. SentimentResponse *SentimentResponse noSmithyDocumentSerde @@ -424,9 +461,10 @@ type Message struct { Content *string // A card that is shown to the user by a messaging platform. You define the - // contents of the card, the card is displayed by the platform. When you use a - // response card, the response from the user is constrained to the text associated - // with a button on the card. + // contents of the card, the card is displayed by the platform. + // + // When you use a response card, the response from the user is constrained to the + // text associated with a button on the card. ImageResponseCard *ImageResponseCard noSmithyDocumentSerde @@ -506,17 +544,25 @@ type RuntimeHintDetails struct { // You can provide Amazon Lex V2 with hints to the phrases that a customer is // likely to use for a slot. When a slot with hints is resolved, the phrases in the // 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) -// . +// 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]. +// +// [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]. + // + // The intent name and slot name must exist. + // + // [Using hints to improve accuracy]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html SlotHints map[string]map[string]RuntimeHintDetails noSmithyDocumentSerde @@ -536,9 +582,11 @@ 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. +// only returned if they are enabled for the bot. +// +// For more information, see [Determine Sentiment] in the Amazon Comprehend developer guide. +// +// [Determine Sentiment]: https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html type SentimentResponse struct { // The overall sentiment expressed in the user's response. This is the sentiment @@ -674,8 +722,11 @@ 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. type StartConversationRequestEventStreamMemberDTMFInputEvent struct { diff --git a/service/licensemanager/api_op_CheckoutBorrowLicense.go b/service/licensemanager/api_op_CheckoutBorrowLicense.go index 56d7c828e93..22c216a4fd3 100644 --- a/service/licensemanager/api_op_CheckoutBorrowLicense.go +++ b/service/licensemanager/api_op_CheckoutBorrowLicense.go @@ -36,8 +36,9 @@ type CheckoutBorrowLicenseInput struct { ClientToken *string // 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) . + // algorithm PS384. For more information, see [RFC 7518 Digital Signature with RSASSA-PSS]. + // + // [RFC 7518 Digital Signature with 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 a3a78562088..33ef761dd0e 100644 --- a/service/licensemanager/api_op_CheckoutLicense.go +++ b/service/licensemanager/api_op_CheckoutLicense.go @@ -11,9 +11,10 @@ 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 -// beneficiary. +// 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 { params = &CheckoutLicenseInput{} diff --git a/service/licensemanager/api_op_CreateGrant.go b/service/licensemanager/api_op_CreateGrant.go index 22ac9d13beb..72603d0a31e 100644 --- a/service/licensemanager/api_op_CreateGrant.go +++ b/service/licensemanager/api_op_CreateGrant.go @@ -13,9 +13,10 @@ 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) -// in the License Manager User Guide. +// organizational unit (OU). For more information, see [Granted licenses in License Manager]in the License Manager User +// Guide. +// +// [Granted licenses in License Manager]: https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html func (c *Client) CreateGrant(ctx context.Context, params *CreateGrantInput, optFns ...func(*Options)) (*CreateGrantOutput, error) { if params == nil { params = &CreateGrantInput{} @@ -61,6 +62,7 @@ type CreateGrantInput struct { // 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 organizational unit (OU), which includes all accounts in the OU. diff --git a/service/licensemanager/api_op_CreateGrantVersion.go b/service/licensemanager/api_op_CreateGrantVersion.go index b18c884a21c..54d66f5b620 100644 --- a/service/licensemanager/api_op_CreateGrantVersion.go +++ b/service/licensemanager/api_op_CreateGrantVersion.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the License Manager User Guide. +// Creates a new version of the specified grant. For more information, see [Granted licenses in License Manager] in the +// License Manager User Guide. +// +// [Granted licenses in License Manager]: https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html func (c *Client) CreateGrantVersion(ctx context.Context, params *CreateGrantVersionInput, optFns ...func(*Options)) (*CreateGrantVersionOutput, error) { if params == nil { params = &CreateGrantVersionInput{} diff --git a/service/licensemanager/api_op_CreateLicenseConfiguration.go b/service/licensemanager/api_op_CreateLicenseConfiguration.go index 42f5f959aa8..27ade6c427f 100644 --- a/service/licensemanager/api_op_CreateLicenseConfiguration.go +++ b/service/licensemanager/api_op_CreateLicenseConfiguration.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a license configuration. A license configuration is an abstraction of a -// customer license agreement that can be consumed and enforced by License Manager. -// Components include specifications for the license type (licensing by instance, -// socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, -// Dedicated Host, or all of these), license affinity to host (how long a license -// must be associated with a host), and the number of licenses purchased and used. +// Creates a license configuration. +// +// A license configuration is an abstraction of a customer license agreement that +// can be consumed and enforced by License Manager. Components include +// specifications for the license type (licensing by instance, socket, CPU, or +// vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or +// all of these), license affinity to host (how long a license must be associated +// with a host), and the number of licenses purchased and used. func (c *Client) CreateLicenseConfiguration(ctx context.Context, params *CreateLicenseConfigurationInput, optFns ...func(*Options)) (*CreateLicenseConfigurationOutput, error) { if params == nil { params = &CreateLicenseConfigurationInput{} @@ -60,14 +62,19 @@ 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 diff --git a/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go b/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go index ad7ef4a5c53..fb8d572a2f2 100644 --- a/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go +++ b/service/licensemanager/api_op_CreateLicenseConversionTaskForResource.go @@ -30,8 +30,9 @@ 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) - // in the License Manager User Guide. + // structure of the destination license, see [Convert a license type using the CLI]in the License Manager User Guide. + // + // [Convert a license type using the CLI]: https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli // // This member is required. DestinationLicenseContext *types.LicenseConversionContext @@ -42,9 +43,11 @@ type CreateLicenseConversionTaskForResourceInput struct { // This member is required. 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) - // in the License Manager User Guide. + // 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] in the License Manager User Guide. + // + // [Convert a license type using the CLI]: https://docs.aws.amazon.com/license-manager/latest/userguide/conversion-procedures.html#conversion-cli // // This member is required. SourceLicenseContext *types.LicenseConversionContext diff --git a/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go b/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go index 644a30672f8..016595d0c03 100644 --- a/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go +++ b/service/licensemanager/api_op_CreateLicenseManagerReportGenerator.go @@ -52,8 +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. // diff --git a/service/licensemanager/api_op_CreateToken.go b/service/licensemanager/api_op_CreateToken.go index fcba5adb91d..4c759246014 100644 --- a/service/licensemanager/api_op_CreateToken.go +++ b/service/licensemanager/api_op_CreateToken.go @@ -11,10 +11,11 @@ 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{} diff --git a/service/licensemanager/api_op_DeleteLicenseConfiguration.go b/service/licensemanager/api_op_DeleteLicenseConfiguration.go index 58800ca5856..cb06cb57cc4 100644 --- a/service/licensemanager/api_op_DeleteLicenseConfiguration.go +++ b/service/licensemanager/api_op_DeleteLicenseConfiguration.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified license configuration. You cannot delete a license -// configuration that is in use. +// Deletes the specified license configuration. +// +// You cannot delete a license configuration that is in use. func (c *Client) DeleteLicenseConfiguration(ctx context.Context, params *DeleteLicenseConfigurationInput, optFns ...func(*Options)) (*DeleteLicenseConfigurationOutput, error) { if params == nil { params = &DeleteLicenseConfigurationInput{} diff --git a/service/licensemanager/api_op_DeleteLicenseManagerReportGenerator.go b/service/licensemanager/api_op_DeleteLicenseManagerReportGenerator.go index 4254d512014..7184f42304d 100644 --- a/service/licensemanager/api_op_DeleteLicenseManagerReportGenerator.go +++ b/service/licensemanager/api_op_DeleteLicenseManagerReportGenerator.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified report generator. This action deletes the report -// generator, which stops it from generating future reports. The action cannot be -// reversed. It has no effect on the previous reports from this generator. +// Deletes the specified report generator. +// +// This action deletes the report generator, which stops it from generating future +// reports. The action cannot be reversed. It has no effect on the previous reports +// from this generator. func (c *Client) DeleteLicenseManagerReportGenerator(ctx context.Context, params *DeleteLicenseManagerReportGeneratorInput, optFns ...func(*Options)) (*DeleteLicenseManagerReportGeneratorOutput, error) { if params == nil { params = &DeleteLicenseManagerReportGeneratorInput{} diff --git a/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go b/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go index 9e252d09364..64d22776779 100644 --- a/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go +++ b/service/licensemanager/api_op_ListAssociationsForLicenseConfiguration.go @@ -12,6 +12,7 @@ import ( ) // Lists the resource associations for the specified license configuration. +// // Resource associations need not consume licenses from a license configuration. // For example, an AMI or a stopped instance might not consume a license (depending // on the license rules). diff --git a/service/licensemanager/api_op_ListDistributedGrants.go b/service/licensemanager/api_op_ListDistributedGrants.go index 977176834d2..95d5b80d52d 100644 --- a/service/licensemanager/api_op_ListDistributedGrants.go +++ b/service/licensemanager/api_op_ListDistributedGrants.go @@ -30,10 +30,15 @@ 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 Filters []types.Filter diff --git a/service/licensemanager/api_op_ListLicenseConfigurations.go b/service/licensemanager/api_op_ListLicenseConfigurations.go index e8926418081..14de35a7374 100644 --- a/service/licensemanager/api_op_ListLicenseConfigurations.go +++ b/service/licensemanager/api_op_ListLicenseConfigurations.go @@ -31,11 +31,14 @@ 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 . Filters []types.Filter diff --git a/service/licensemanager/api_op_ListLicenseConversionTasks.go b/service/licensemanager/api_op_ListLicenseConversionTasks.go index afbb8fd963a..b458fad6dac 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 7b989303e9b..e34ad086280 100644 --- a/service/licensemanager/api_op_ListLicenseManagerReportGenerators.go +++ b/service/licensemanager/api_op_ListLicenseManagerReportGenerators.go @@ -30,6 +30,7 @@ func (c *Client) ListLicenseManagerReportGenerators(ctx context.Context, params type ListLicenseManagerReportGeneratorsInput struct { // Filters to scope the results. The following filters are supported: + // // - LicenseConfigurationArn Filters []types.Filter diff --git a/service/licensemanager/api_op_ListLicenses.go b/service/licensemanager/api_op_ListLicenses.go index 5d47c7c82d2..afe7d3282f7 100644 --- a/service/licensemanager/api_op_ListLicenses.go +++ b/service/licensemanager/api_op_ListLicenses.go @@ -30,9 +30,13 @@ 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 Filters []types.Filter diff --git a/service/licensemanager/api_op_ListReceivedGrants.go b/service/licensemanager/api_op_ListReceivedGrants.go index 55feeb5036b..0669e13c50c 100644 --- a/service/licensemanager/api_op_ListReceivedGrants.go +++ b/service/licensemanager/api_op_ListReceivedGrants.go @@ -32,10 +32,15 @@ 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 Filters []types.Filter diff --git a/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go b/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go index 82d47766921..8f2693047a4 100644 --- a/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go +++ b/service/licensemanager/api_op_ListReceivedGrantsForOrganization.go @@ -35,7 +35,9 @@ type ListReceivedGrantsForOrganizationInput struct { LicenseArn *string // Filters to scope the results. The following filters are supported: + // // - ParentArn + // // - GranteePrincipalArn Filters []types.Filter diff --git a/service/licensemanager/api_op_ListReceivedLicenses.go b/service/licensemanager/api_op_ListReceivedLicenses.go index 536718fbdb6..64687d748d1 100644 --- a/service/licensemanager/api_op_ListReceivedLicenses.go +++ b/service/licensemanager/api_op_ListReceivedLicenses.go @@ -30,10 +30,15 @@ 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 Filters []types.Filter diff --git a/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go b/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go index 14472b7c766..26e71ed5f75 100644 --- a/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go +++ b/service/licensemanager/api_op_ListReceivedLicensesForOrganization.go @@ -30,7 +30,9 @@ func (c *Client) ListReceivedLicensesForOrganization(ctx context.Context, params type ListReceivedLicensesForOrganizationInput struct { // Filters to scope the results. The following filters are supported: + // // - Beneficiary + // // - ProductSKU Filters []types.Filter diff --git a/service/licensemanager/api_op_ListResourceInventory.go b/service/licensemanager/api_op_ListResourceInventory.go index 23c7b8e9808..aece1478fc3 100644 --- a/service/licensemanager/api_op_ListResourceInventory.go +++ b/service/licensemanager/api_op_ListResourceInventory.go @@ -31,17 +31,23 @@ 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). Filters []types.InventoryFilter diff --git a/service/licensemanager/api_op_ListTokens.go b/service/licensemanager/api_op_ListTokens.go index 3a6bf073426..62606a84eb9 100644 --- a/service/licensemanager/api_op_ListTokens.go +++ b/service/licensemanager/api_op_ListTokens.go @@ -30,6 +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 Filters []types.Filter diff --git a/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go b/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go index b67fcdb0352..8a2724fd7b3 100644 --- a/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go +++ b/service/licensemanager/api_op_ListUsageForLicenseConfiguration.go @@ -39,11 +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 - // . + // 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 diff --git a/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go b/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go index 1ab51f2b3df..6a1eec437f0 100644 --- a/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go +++ b/service/licensemanager/api_op_UpdateLicenseManagerReportGenerator.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a report generator. After you make changes to a report generator, it -// starts generating new reports within 60 minutes of being updated. +// Updates a report generator. +// +// After you make changes to a report generator, it starts generating new reports +// within 60 minutes of being updated. func (c *Client) UpdateLicenseManagerReportGenerator(ctx context.Context, params *UpdateLicenseManagerReportGeneratorInput, optFns ...func(*Options)) (*UpdateLicenseManagerReportGeneratorOutput, error) { if params == nil { params = &UpdateLicenseManagerReportGeneratorInput{} @@ -57,8 +59,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. // diff --git a/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go b/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go index 6572fc77af0..25a7b76f21e 100644 --- a/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go +++ b/service/licensemanager/api_op_UpdateLicenseSpecificationsForResource.go @@ -12,10 +12,12 @@ import ( ) // Adds or removes the specified license configurations for the specified Amazon -// Web Services resource. You can update the license specifications of AMIs, -// instances, and hosts. You cannot update the license specifications for launch -// templates and CloudFormation templates, as they send license configurations to -// the operation that creates the resource. +// Web Services resource. +// +// You can update the license specifications of AMIs, instances, and hosts. You +// cannot update the license specifications for launch templates and CloudFormation +// templates, as they send license configurations to the operation that creates the +// resource. func (c *Client) UpdateLicenseSpecificationsForResource(ctx context.Context, params *UpdateLicenseSpecificationsForResourceInput, optFns ...func(*Options)) (*UpdateLicenseSpecificationsForResourceOutput, error) { if params == nil { params = &UpdateLicenseSpecificationsForResourceInput{} diff --git a/service/licensemanager/options.go b/service/licensemanager/options.go index ee36a821e3c..fa65279c016 100644 --- a/service/licensemanager/options.go +++ b/service/licensemanager/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/licensemanager/types/enums.go b/service/licensemanager/types/enums.go index 97039f0e05a..03e84134f62 100644 --- a/service/licensemanager/types/enums.go +++ b/service/licensemanager/types/enums.go @@ -12,6 +12,7 @@ const ( // Values returns all known values for ActivationOverrideBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ActivationOverrideBehavior) Values() []ActivationOverrideBehavior { return []ActivationOverrideBehavior{ @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for AllowedOperation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllowedOperation) Values() []AllowedOperation { return []AllowedOperation{ "CreateGrant", @@ -57,8 +59,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for DigitalSignatureMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DigitalSignatureMethod) Values() []DigitalSignatureMethod { return []DigitalSignatureMethod{ "JWT_PS384", @@ -116,8 +120,9 @@ const ( ) // Values returns all known values for EntitlementDataUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntitlementDataUnit) Values() []EntitlementDataUnit { return []EntitlementDataUnit{ "Count", @@ -184,8 +189,9 @@ const ( ) // Values returns all known values for EntitlementUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntitlementUnit) Values() []EntitlementUnit { return []EntitlementUnit{ "Count", @@ -234,8 +240,9 @@ const ( ) // Values returns all known values for GrantStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GrantStatus) Values() []GrantStatus { return []GrantStatus{ "PENDING_WORKFLOW", @@ -262,6 +269,7 @@ const ( // 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{ @@ -282,6 +290,7 @@ const ( // Values returns all known values for LicenseConfigurationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LicenseConfigurationStatus) Values() []LicenseConfigurationStatus { return []LicenseConfigurationStatus{ @@ -301,6 +310,7 @@ const ( // Values returns all known values for LicenseConversionTaskStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LicenseConversionTaskStatus) Values() []LicenseConversionTaskStatus { return []LicenseConversionTaskStatus{ @@ -321,8 +331,9 @@ const ( ) // Values returns all known values for LicenseCountingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseCountingType) Values() []LicenseCountingType { return []LicenseCountingType{ "vCPU", @@ -341,8 +352,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PENDING_DELETE", @@ -364,8 +376,9 @@ const ( ) // Values returns all known values for LicenseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseStatus) Values() []LicenseStatus { return []LicenseStatus{ "AVAILABLE", @@ -393,8 +406,9 @@ const ( ) // Values returns all known values for ReceivedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReceivedStatus) Values() []ReceivedStatus { return []ReceivedStatus{ "PENDING_WORKFLOW", @@ -418,8 +432,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -438,8 +453,9 @@ const ( ) // Values returns all known values for ReportFrequencyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportFrequencyType) Values() []ReportFrequencyType { return []ReportFrequencyType{ "DAY", @@ -457,8 +473,9 @@ const ( ) // Values returns all known values for ReportType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReportType) Values() []ReportType { return []ReportType{ "LicenseConfigurationSummaryReport", @@ -478,8 +495,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -498,8 +516,9 @@ const ( ) // 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. +// in the future, and so 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/errors.go b/service/licensemanager/types/errors.go index 2ef5fb59240..a37b9deeab2 100644 --- a/service/licensemanager/types/errors.go +++ b/service/licensemanager/types/errors.go @@ -193,6 +193,7 @@ func (e *InvalidParameterValueException) ErrorCode() string { func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // License Manager cannot allocate a license to a resource because of its state. +// // For example, you cannot allocate a license to an instance in the process of // shutting down. type InvalidResourceStateException struct { diff --git a/service/licensemanager/types/types.go b/service/licensemanager/types/types.go index 2d5a14f120b..916c2df3098 100644 --- a/service/licensemanager/types/types.go +++ b/service/licensemanager/types/types.go @@ -475,8 +475,9 @@ 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) + // correspond to which usage operation values see [Sample data: usage operation by platform] + // + // [Sample data: usage operation by platform]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html#billing-info UsageOperation *string noSmithyDocumentSerde @@ -594,24 +595,30 @@ 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) -// in the License Manager User Guide. +// activation override behavior. For more information, see [Granted licenses in License Manager]in the License Manager +// User Guide. +// +// [Granted licenses in License Manager]: https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html 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 // 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. + // // 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. @@ -637,35 +644,46 @@ type ProductInformation struct { // A Product information filter consists of a ProductInformationFilterComparator // which is a logical operator, a ProductInformationFilterName which specifies the // 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 : + // 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 - // . + // 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 - // . + // values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap . // // This member is required. ProductInformationFilterList []ProductInformationFilter diff --git a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go index 7b856b23a08..3aeae7a9b8c 100644 --- a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go +++ b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptionInstances.go @@ -36,18 +36,31 @@ type ListLinuxSubscriptionInstancesInput struct { // match one or more sets of key-value pairs that you specify. For example, you can // 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 Filters []types.Filter diff --git a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go index b6d68651370..7886887dc29 100644 --- a/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go +++ b/service/licensemanagerlinuxsubscriptions/api_op_ListLinuxSubscriptions.go @@ -37,11 +37,18 @@ type ListLinuxSubscriptionsInput struct { // match one or more sets of key-value pairs that you specify. For example, you can // 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's name. + // + // The valid names for this filter are: + // // - Subscription + // // The valid Operators for this filter are: + // // - contains + // // - equals + // // - Notequal Filters []types.Filter diff --git a/service/licensemanagerlinuxsubscriptions/options.go b/service/licensemanagerlinuxsubscriptions/options.go index c8dd48f8d40..2dba19abcbc 100644 --- a/service/licensemanagerlinuxsubscriptions/options.go +++ b/service/licensemanagerlinuxsubscriptions/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/licensemanagerlinuxsubscriptions/types/enums.go b/service/licensemanagerlinuxsubscriptions/types/enums.go index 5bca9a680b6..41efc7abd66 100644 --- a/service/licensemanagerlinuxsubscriptions/types/enums.go +++ b/service/licensemanagerlinuxsubscriptions/types/enums.go @@ -14,6 +14,7 @@ const ( // Values returns all known values for LinuxSubscriptionsDiscovery. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LinuxSubscriptionsDiscovery) Values() []LinuxSubscriptionsDiscovery { return []LinuxSubscriptionsDiscovery{ @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "Equal", @@ -56,8 +58,9 @@ const ( ) // Values returns all known values for OrganizationIntegration. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationIntegration) Values() []OrganizationIntegration { return []OrganizationIntegration{ "Enabled", @@ -80,8 +83,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "InProgress", diff --git a/service/licensemanagerlinuxsubscriptions/types/types.go b/service/licensemanagerlinuxsubscriptions/types/types.go index ec384f90543..a75a0a4dd80 100644 --- a/service/licensemanagerlinuxsubscriptions/types/types.go +++ b/service/licensemanagerlinuxsubscriptions/types/types.go @@ -41,9 +41,10 @@ type Instance struct { // The time in which the last discovery updated the instance details. 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) - // in the License Manager User Guide . + // The product code for the instance. For more information, see [Usage operation values] in the License + // Manager User Guide . + // + // [Usage operation values]: https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html ProductCode []string // The Region the instance is running in. @@ -56,8 +57,9 @@ 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) - // in the License Manager User Guide. + // information, see [Usage operation values]in the License Manager User Guide. + // + // [Usage operation values]: https://docs.aws.amazon.com/license-manager/latest/userguide/linux-subscriptions-usage-operation.html UsageOperation *string noSmithyDocumentSerde diff --git a/service/licensemanagerusersubscriptions/api_op_AssociateUser.go b/service/licensemanagerusersubscriptions/api_op_AssociateUser.go index 8fd72b54394..53b0be1e4bb 100644 --- a/service/licensemanagerusersubscriptions/api_op_AssociateUser.go +++ b/service/licensemanagerusersubscriptions/api_op_AssociateUser.go @@ -12,11 +12,13 @@ import ( ) // 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. +// see [Viewing your monthly charges]in the Amazon Web Services Billing User Guide. +// +// [Viewing your monthly charges]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html 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 fbdc7f704da..a88f2d70077 100644 --- a/service/licensemanagerusersubscriptions/api_op_StartProductSubscription.go +++ b/service/licensemanagerusersubscriptions/api_op_StartProductSubscription.go @@ -12,11 +12,13 @@ import ( ) // Starts a product subscription for a user with the specified identity provider. +// // 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]in the Amazon Web Services Billing User Guide. +// +// [Viewing your monthly charges]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html 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 7f04d7a6f0b..e4c612592b8 100644 --- a/service/licensemanagerusersubscriptions/api_op_UpdateIdentityProviderSettings.go +++ b/service/licensemanagerusersubscriptions/api_op_UpdateIdentityProviderSettings.go @@ -43,8 +43,11 @@ 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. // // This member is required. diff --git a/service/licensemanagerusersubscriptions/options.go b/service/licensemanagerusersubscriptions/options.go index cdbf6317e85..1ec51d2e685 100644 --- a/service/licensemanagerusersubscriptions/options.go +++ b/service/licensemanagerusersubscriptions/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lightsail/api_op_AttachCertificateToDistribution.go b/service/lightsail/api_op_AttachCertificateToDistribution.go index 2ca60d7c3ff..b7a8551878d 100644 --- a/service/lightsail/api_op_AttachCertificateToDistribution.go +++ b/service/lightsail/api_op_AttachCertificateToDistribution.go @@ -12,14 +12,19 @@ import ( ) // Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery -// network (CDN) distribution. After the certificate is attached, your distribution -// accepts HTTPS traffic for all of the domains that are associated with the -// certificate. Use the CreateCertificate action to create a certificate that you -// can attach to your distribution. 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. +// network (CDN) distribution. +// +// After the certificate is attached, your distribution accepts HTTPS traffic for +// all of the domains that are associated with the certificate. +// +// Use the CreateCertificate action to create a certificate that you can attach to +// your distribution. +// +// 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. func (c *Client) AttachCertificateToDistribution(ctx context.Context, params *AttachCertificateToDistributionInput, optFns ...func(*Options)) (*AttachCertificateToDistributionOutput, error) { if params == nil { params = &AttachCertificateToDistributionInput{} @@ -37,20 +42,26 @@ func (c *Client) AttachCertificateToDistribution(ctx context.Context, params *At type AttachCertificateToDistributionInput struct { - // The name of the certificate to attach to a distribution. Only certificates with - // a status of ISSUED can be attached to a distribution. Use the GetCertificates - // action to get a list of certificate names that you can specify. This is the name - // of the certificate resource type and is used only to reference the certificate - // in other API actions. It can be different than the domain name of the - // certificate. For example, your certificate name might be + // The name of the certificate to attach to a distribution. + // + // Only certificates with a status of ISSUED can be attached to a distribution. + // + // Use the GetCertificates action to get a list of certificate names that you can + // specify. + // + // This is the name of the certificate resource type and is used only to reference + // the certificate 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 . // // 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. + // 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. // // This member is required. DistributionName *string diff --git a/service/lightsail/api_op_AttachDisk.go b/service/lightsail/api_op_AttachDisk.go index 6294c41e4fa..9d53039f5f7 100644 --- a/service/lightsail/api_op_AttachDisk.go +++ b/service/lightsail/api_op_AttachDisk.go @@ -12,11 +12,13 @@ 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) +// 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] // . +// +// [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{} @@ -50,8 +52,9 @@ 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 - // Lightsail for Research resources. + // a virtual computer. The default value is False . + // + // This value only applies to Lightsail for Research resources. AutoMounting *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_AttachInstancesToLoadBalancer.go b/service/lightsail/api_op_AttachInstancesToLoadBalancer.go index bd3af16d2e5..66de8ddcf3e 100644 --- a/service/lightsail/api_op_AttachInstancesToLoadBalancer.go +++ b/service/lightsail/api_op_AttachInstancesToLoadBalancer.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches one or more Lightsail instances to a load balancer. After some time, -// 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) -// . +// Attaches one or more Lightsail instances to a load balancer. +// +// After some time, 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]. +// +// [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{} @@ -35,10 +39,13 @@ 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). + // 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 1d986a25cc5..56c72cd27f4 100644 --- a/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_AttachLoadBalancerTlsCertificate.go @@ -12,15 +12,19 @@ import ( ) // 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 +// 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) -// . +// 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]. +// +// [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{} @@ -56,8 +60,10 @@ type AttachLoadBalancerTlsCertificateOutput struct { // An array of objects that describe the result of the action, such as the status // of the request, the timestamp of the request, and the resources affected by the - // request. These SSL/TLS certificates are only usable by Lightsail load balancers. - // You can't get the certificate and use it for another purpose. + // request. + // + // These SSL/TLS certificates are only usable by Lightsail load balancers. You + // can't get the certificate and use it for another purpose. Operations []types.Operation // Metadata pertaining to the operation's result. diff --git a/service/lightsail/api_op_CloseInstancePublicPorts.go b/service/lightsail/api_op_CloseInstancePublicPorts.go index 15e2c0d628c..1bde165a4fb 100644 --- a/service/lightsail/api_op_CloseInstancePublicPorts.go +++ b/service/lightsail/api_op_CloseInstancePublicPorts.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 d96466ad07d..86b7da78a0f 100644 --- a/service/lightsail/api_op_CopySnapshot.go +++ b/service/lightsail/api_op_CopySnapshot.go @@ -15,11 +15,13 @@ 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 -// snapshot parameters. +// 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 { params = &CopySnapshotInput{} @@ -50,36 +52,53 @@ 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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: + // The name of the source manual snapshot to copy. + // + // Constraint: + // // - 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: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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 a555b2f8f5b..ba54ab77d22 100644 --- a/service/lightsail/api_op_CreateBucket.go +++ b/service/lightsail/api_op_CreateBucket.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Lightsail Developer Guide. +// 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]in the Amazon Lightsail Developer Guide. +// +// [Buckets in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) { if params == nil { params = &CreateBucketInput{} @@ -33,32 +35,45 @@ 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) - // in the Amazon Lightsail Developer Guide. + // The name for the bucket. + // + // For more information about bucket names, see [Bucket naming rules in Amazon Lightsail] in the Amazon Lightsail Developer + // Guide. + // + // [Bucket naming rules in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail // // This member is required. BucketName *string - // 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) - // 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) - // action to change the bundle after the bucket is created. + // 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] action to get a list of bundle IDs that you can specify. + // + // Use the [UpdateBucketBundle] action to change the bundle after the bucket is created. + // + // [UpdateBucketBundle]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html + // [GetBucketBundles]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html // // This member is required. BundleId *string // 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) - // in the Amazon Lightsail Developer Guide. + // bucket. + // + // For more information about versioning, see [Enabling and suspending object versioning in a bucket in Amazon Lightsail] in the Amazon Lightsail Developer + // Guide. + // + // [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 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) - // action to tag the bucket after it's created. + // The tag keys and optional values to add to the bucket during creation. + // + // Use the [TagResource] action to tag the bucket after it's created. + // + // [TagResource]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateBucketAccessKey.go b/service/lightsail/api_op_CreateBucketAccessKey.go index 091eaeca4ff..1b1dace13bf 100644 --- a/service/lightsail/api_op_CreateBucketAccessKey.go +++ b/service/lightsail/api_op_CreateBucketAccessKey.go @@ -12,17 +12,20 @@ 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) -// 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) -// 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 -// access key later. If you lose the secret access key, you must create a new -// access key. +// 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]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]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 access key later. If you +// lose the secret access key, you must create a new access key. +// +// [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 +// [GetBucketAccessKeys]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html func (c *Client) CreateBucketAccessKey(ctx context.Context, params *CreateBucketAccessKeyInput, optFns ...func(*Options)) (*CreateBucketAccessKeyOutput, error) { if params == nil { params = &CreateBucketAccessKeyInput{} diff --git a/service/lightsail/api_op_CreateCertificate.go b/service/lightsail/api_op_CreateCertificate.go index 71c97ba4a7f..2833ad2b29a 100644 --- a/service/lightsail/api_op_CreateCertificate.go +++ b/service/lightsail/api_op_CreateCertificate.go @@ -12,15 +12,18 @@ import ( ) // Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network -// (CDN) distribution and a container service. After the certificate is valid, use -// 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. +// (CDN) distribution and a container service. +// +// After the certificate is valid, use 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. func (c *Client) CreateCertificate(ctx context.Context, params *CreateCertificateInput, optFns ...func(*Options)) (*CreateCertificateOutput, error) { if params == nil { params = &CreateCertificateInput{} @@ -49,13 +52,17 @@ type CreateCertificateInput struct { DomainName *string // An array of strings that specify the alternate domains ( example2.com ) and - // subdomains ( 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 ( *.example.com ) are not supported. + // subdomains ( 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 ( *.example.com ) are not supported. SubjectAlternativeNames []string - // The tag keys and optional values to add to the certificate during create. Use - // the TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the certificate during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateCloudFormationStack.go b/service/lightsail/api_op_CreateCloudFormationStack.go index d635c266222..eb7f5e33578 100644 --- a/service/lightsail/api_op_CreateCloudFormationStack.go +++ b/service/lightsail/api_op_CreateCloudFormationStack.go @@ -15,9 +15,11 @@ import ( // 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 -// instance is created before running the create cloud formation stack operation -// again with the same export snapshot record. +// 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) { if params == nil { params = &CreateCloudFormationStackInput{} diff --git a/service/lightsail/api_op_CreateContactMethod.go b/service/lightsail/api_op_CreateContactMethod.go index 284032f246f..9dab93c4ee6 100644 --- a/service/lightsail/api_op_CreateContactMethod.go +++ b/service/lightsail/api_op_CreateContactMethod.go @@ -11,13 +11,15 @@ 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 -// 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) -// . +// 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]. +// +// [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{} @@ -36,31 +38,44 @@ func (c *Client) CreateContactMethod(ctx context.Context, params *CreateContactM type CreateContactMethodInput struct { // The destination of the contact method, such as an email address or a mobile - // phone number. Use the E.164 format when specifying a mobile phone number. E.164 - // is a standard for the phone number structure used for international - // 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. + // phone number. + // + // Use the E.164 format when specifying a mobile phone number. E.164 is a standard + // for the phone number structure used for international 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]on Wikipedia. + // + // [E.164]: https://en.wikipedia.org/wiki/E.164 // // 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. + // 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) - // 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) - // . + // latest Amazon Web Services Regions where SMS text messaging is supported, see [Supported Regions and Countries] + // in the Amazon SNS Developer Guide. + // + // For more information about notifications in Amazon Lightsail, see [Notifications in Amazon Lightsail]. + // + // [Supported Regions and Countries]: https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html + // [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 379214669ee..0298027bf8e 100644 --- a/service/lightsail/api_op_CreateContainerService.go +++ b/service/lightsail/api_op_CreateContainerService.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Lightsail Dev Guide. +// 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]in the Lightsail Dev Guide. +// +// [Container services in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services func (c *Client) CreateContainerService(ctx context.Context, params *CreateContainerServiceInput, optFns ...func(*Options)) (*CreateContainerServiceOutput, error) { if params == nil { params = &CreateContainerServiceInput{} @@ -32,75 +34,99 @@ func (c *Client) CreateContainerService(ctx context.Context, params *CreateConta type CreateContainerServiceInput struct { - // The power specification for the container service. The power specifies the - // 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. + // The power specification for the container service. + // + // The power specifies the 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. // // This member is required. Power types.ContainerServicePowerName - // The scale specification 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. + // The scale specification 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. // // 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 - // 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: + // 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. // // This member is required. ServiceName *string - // An object that describes a deployment for the container service. A deployment - // specifies the containers that will be launched on the container service and - // their settings, such as the ports to open, the environment variables to apply, - // and the launch command to run. It also specifies the container that will serve - // as the public endpoint of the deployment and its settings, such as the HTTP or - // HTTPS port to use, and the health check configuration. + // An object that describes a deployment for the container service. + // + // A deployment specifies the containers that will be launched on the container + // service and their settings, such as the ports to open, the environment variables + // to apply, and the launch command to run. It also specifies the container that + // will serve as the public endpoint of the deployment and its settings, such as + // the HTTP or HTTPS port to use, and the health check configuration. Deployment *types.ContainerServiceDeploymentRequest // 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) - // in the Amazon Lightsail Developer Guide. + // (Amazon ECR) private repositories. + // + // For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service] in the Amazon Lightsail Developer Guide. + // + // [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 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 - // 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 the container service. You must create and validate an SSL/TLS - // certificate before you can use public domain names with your container service. - // Use the CreateCertificate action to create a certificate for the public domain - // names you want to use with your container service. You can specify public domain - // names using a string to array map as shown in the example later on this page. + // 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 domain + // of the container service. + // + // You must create and validate an SSL/TLS certificate before you can use public + // domain names with your container service. Use the CreateCertificate action to + // create a certificate for the public domain names you want to use with your + // container service. + // + // You can specify public domain names using a string to array map as shown in the + // example later on this page. PublicDomainNames map[string][]string // 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) - // . + // + // 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]. + // + // [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 2af5c883bce..70f3d109691 100644 --- a/service/lightsail/api_op_CreateContainerServiceDeployment.go +++ b/service/lightsail/api_op_CreateContainerServiceDeployment.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a deployment for your Amazon Lightsail container service. A deployment -// specifies the containers that will be launched on the container service and -// their settings, such as the ports to open, the environment variables to apply, -// and the launch command to run. It also specifies the container that will serve -// as the public endpoint of the deployment and its settings, such as the HTTP or -// 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) -// in the Amazon Lightsail Developer Guide. +// Creates a deployment for your Amazon Lightsail container service. +// +// A deployment specifies the containers that will be launched on the container +// service and their settings, such as the ports to open, the environment variables +// to apply, and the launch command to run. It also specifies the container that +// will serve as the public endpoint of the deployment and its settings, such as +// the HTTP or 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]in the Amazon Lightsail Developer Guide. +// +// [Creating container images for your Amazon Lightsail container services]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images func (c *Client) CreateContainerServiceDeployment(ctx context.Context, params *CreateContainerServiceDeploymentInput, optFns ...func(*Options)) (*CreateContainerServiceDeploymentOutput, error) { if params == nil { params = &CreateContainerServiceDeploymentInput{} diff --git a/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go b/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go index 57681ec5806..14991960023 100644 --- a/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go +++ b/service/lightsail/api_op_CreateContainerServiceRegistryLogin.go @@ -17,17 +17,21 @@ import ( // image registry of your Amazon Lightsail account so that you can use them with // your Lightsail container service. The log in credentials expire 12 hours after // they are created, at which point you will need to create a new set of log in -// credentials. You can only push container images to the container service -// registry of your Lightsail account. You cannot pull container images or perform -// any other container image management actions on the container service registry. +// credentials. +// +// You can only push container images to the container service registry of your +// Lightsail account. You cannot pull container images or perform any other +// container image management actions on the container service registry. +// // After you push your container images to the container image registry of your // Lightsail account, use the RegisterContainerImage action to register the pushed -// images to a specific 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) -// in the Amazon Lightsail Developer Guide. +// images to a specific 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]in the Amazon Lightsail Developer Guide. +// +// [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 func (c *Client) CreateContainerServiceRegistryLogin(ctx context.Context, params *CreateContainerServiceRegistryLoginInput, optFns ...func(*Options)) (*CreateContainerServiceRegistryLoginOutput, error) { if params == nil { params = &CreateContainerServiceRegistryLoginInput{} diff --git a/service/lightsail/api_op_CreateDisk.go b/service/lightsail/api_op_CreateDisk.go index 916f78e2957..a6deb247ec1 100644 --- a/service/lightsail/api_op_CreateDisk.go +++ b/service/lightsail/api_op_CreateDisk.go @@ -12,10 +12,12 @@ import ( ) // Creates a block storage disk that can be attached to an Amazon Lightsail -// instance in the same Availability Zone ( 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) -// . +// instance in the same Availability Zone ( us-east-2a ). +// +// The create disk operation supports tag-based access control via request tags. +// For more information, see the [Amazon Lightsail Developer Guide]. +// +// [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{} @@ -35,8 +37,10 @@ type CreateDiskInput struct { // The Availability Zone where you want to create the disk ( 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. + // disk. + // + // Use the get regions operation to list the Availability Zones where Lightsail is + // currently available. // // This member is required. AvailabilityZone *string @@ -54,8 +58,9 @@ type CreateDiskInput struct { // An array of objects that represent the add-ons to enable for the new disk. AddOns []types.AddOnRequest - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateDiskFromSnapshot.go b/service/lightsail/api_op_CreateDiskFromSnapshot.go index 84bdd2a4be4..40d20f2154e 100644 --- a/service/lightsail/api_op_CreateDiskFromSnapshot.go +++ b/service/lightsail/api_op_CreateDiskFromSnapshot.go @@ -13,11 +13,13 @@ 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 ( 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) -// . +// Availability Zone ( 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]. +// +// [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{} @@ -37,8 +39,10 @@ type CreateDiskFromSnapshotInput struct { // The Availability Zone where you want to create the disk ( 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. + // the disk. + // + // Use the GetRegions operation to list the Availability Zones where Lightsail is + // currently available. // // This member is required. AvailabilityZone *string @@ -57,7 +61,10 @@ type CreateDiskFromSnapshotInput struct { AddOns []types.AddOnRequest // The name of the disk snapshot ( my-snapshot ) from which to create the new - // storage disk. Constraint: + // 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. @@ -65,38 +72,54 @@ type CreateDiskFromSnapshotInput struct { // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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 - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag // A Boolean value to indicate whether to use the latest available automatic - // snapshot. Constraints: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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 d674a47f926..2ca3170b9ae 100644 --- a/service/lightsail/api_op_CreateDiskSnapshot.go +++ b/service/lightsail/api_op_CreateDiskSnapshot.go @@ -13,26 +13,32 @@ import ( // Creates a snapshot of a block storage disk. You can use snapshots for backups, // to make copies of disks, and to save data before shutting down a Lightsail -// instance. You can take a snapshot of an attached disk that is in use; however, -// snapshots only capture data that has been written to your disk at the time the -// snapshot command is issued. This may exclude any data that has been cached by -// any applications or the operating system. If you can pause any file systems on -// the disk long enough to take a snapshot, your snapshot should be complete. +// instance. +// +// You can take a snapshot of an attached disk that is in use; however, snapshots +// only capture data that has been written to your disk at the time the snapshot +// command is issued. This may exclude any data that has been cached by any +// applications or the operating system. If you can pause any file systems on the +// disk long enough to take a snapshot, your snapshot should be complete. // Nevertheless, if you cannot pause all file writes to the disk, you should // unmount the disk from within the Lightsail instance, issue the create disk // snapshot command, and then remount the disk to ensure a consistent and complete // snapshot. You may remount and use your disk while the snapshot status is -// pending. You can also use this operation to create a snapshot of an instance's -// system volume. You might want to do this, for example, to recover data from the -// system volume of a botched instance or to create a backup of the system volume -// like you would for a block storage disk. To create a snapshot of a system -// volume, just define the instance name parameter when issuing the snapshot -// command, and a snapshot of the defined instance's system volume will be created. -// 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) -// . +// pending. +// +// You can also use this operation to create a snapshot of an instance's system +// volume. You might want to do this, for example, to recover data from the system +// volume of a botched instance or to create a backup of the system volume like you +// would for a block storage disk. To create a snapshot of a system volume, just +// define the instance name parameter when issuing the snapshot command, and a +// snapshot of the defined instance's system volume will be created. 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]. +// +// [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{} @@ -56,19 +62,22 @@ type CreateDiskSnapshotInput struct { // This member is required. DiskSnapshotName *string - // The unique name of the source disk ( Disk-Virginia-1 ). This parameter cannot be - // defined together with the instance name parameter. The disk name and instance - // name parameters are mutually exclusive. + // The unique name of the source disk ( 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 ( 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. + // 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. InstanceName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateDistribution.go b/service/lightsail/api_op_CreateDistribution.go index b72b7ba52d9..420ecc5a9d6 100644 --- a/service/lightsail/api_op_CreateDistribution.go +++ b/service/lightsail/api_op_CreateDistribution.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon Lightsail content delivery network (CDN) distribution. A -// 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) -// . +// Creates an Amazon Lightsail content delivery network (CDN) distribution. +// +// A 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]. +// +// [Content delivery networks in Amazon 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{} @@ -34,10 +35,13 @@ func (c *Client) CreateDistribution(ctx context.Context, params *CreateDistribut type CreateDistributionInput struct { - // The bundle ID to use for the distribution. A distribution bundle describes the - // specifications of your distribution, such as the monthly cost and monthly - // network transfer quota. Use the GetDistributionBundles action to get a list of - // distribution bundle IDs that you can specify. + // The bundle ID to use for the distribution. + // + // A distribution bundle describes the specifications of your distribution, such + // as the monthly cost and monthly network transfer quota. + // + // Use the GetDistributionBundles action to get a list of distribution bundle IDs + // that you can specify. // // This member is required. BundleId *string @@ -53,8 +57,9 @@ type CreateDistributionInput struct { DistributionName *string // An object that describes the origin resource for the distribution, such as a - // Lightsail instance, bucket, or load balancer. The distribution pulls, caches, - // and serves content from the origin. + // Lightsail instance, bucket, or load balancer. + // + // The distribution pulls, caches, and serves content from the origin. // // This member is required. Origin *types.InputOrigin @@ -66,17 +71,23 @@ type CreateDistributionInput struct { // distribution. CacheBehaviors []types.CacheBehaviorPerPath - // The name of the SSL/TLS certificate that you want to attach to the - // distribution. Use the GetCertificates (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetCertificates.html) - // action to get a list of certificate names that you can specify. + // The name of the SSL/TLS certificate that you want to attach to the distribution. + // + // Use the [GetCertificates] action to get a list of certificate names that you can specify. + // + // [GetCertificates]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetCertificates.html CertificateName *string - // 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 . + // 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 . IpAddressType types.IpAddressType - // The tag keys and optional values to add to the distribution during create. Use - // the TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the distribution during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag // The minimum TLS protocol version for the SSL/TLS certificate. diff --git a/service/lightsail/api_op_CreateDomain.go b/service/lightsail/api_op_CreateDomain.go index a73a7cb9008..0869ff30610 100644 --- a/service/lightsail/api_op_CreateDomain.go +++ b/service/lightsail/api_op_CreateDomain.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a domain resource for the specified domain (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) -// . +// Creates a domain resource for the specified domain (example.com). +// +// The create domain operation supports tag-based access control via request tags. +// For more information, see the [Amazon Lightsail Developer Guide]. +// +// [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{} @@ -37,8 +39,9 @@ type CreateDomainInput struct { // This member is required. DomainName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateDomainEntry.go b/service/lightsail/api_op_CreateDomainEntry.go index b8dcdf118c6..c6d02e307f2 100644 --- a/service/lightsail/api_op_CreateDomainEntry.go +++ b/service/lightsail/api_op_CreateDomainEntry.go @@ -13,11 +13,13 @@ 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]. +// +// [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{} diff --git a/service/lightsail/api_op_CreateGUISessionAccessDetails.go b/service/lightsail/api_op_CreateGUISessionAccessDetails.go index 3bd5b97c3e8..39ba7c9cf79 100644 --- a/service/lightsail/api_op_CreateGUISessionAccessDetails.go +++ b/service/lightsail/api_op_CreateGUISessionAccessDetails.go @@ -14,8 +14,9 @@ import ( // Creates two URLs that are used to access a virtual computer’s graphical user // interface (GUI) session. The primary URL initiates a web-based NICE DCV session // to the virtual computer's application. The secondary URL initiates a web-based -// NICE DCV session to the virtual computer's operating session. Use -// StartGUISession to open the session. +// NICE DCV session to the virtual computer's operating session. +// +// Use StartGUISession to open the session. func (c *Client) CreateGUISessionAccessDetails(ctx context.Context, params *CreateGUISessionAccessDetailsInput, optFns ...func(*Options)) (*CreateGUISessionAccessDetailsOutput, error) { if params == nil { params = &CreateGUISessionAccessDetailsInput{} diff --git a/service/lightsail/api_op_CreateInstanceSnapshot.go b/service/lightsail/api_op_CreateInstanceSnapshot.go index dfe36ef46e1..0df909a6d13 100644 --- a/service/lightsail/api_op_CreateInstanceSnapshot.go +++ b/service/lightsail/api_op_CreateInstanceSnapshot.go @@ -12,10 +12,12 @@ 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) -// . +// 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]. +// +// [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{} @@ -43,8 +45,9 @@ type CreateInstanceSnapshotInput struct { // This member is required. InstanceSnapshotName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateInstances.go b/service/lightsail/api_op_CreateInstances.go index b74fdb6f3c7..7bb6c4fa487 100644 --- a/service/lightsail/api_op_CreateInstances.go +++ b/service/lightsail/api_op_CreateInstances.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -34,20 +36,22 @@ 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) - // operation. Be sure to add the include Availability Zones parameter to your - // request. + // by using the [get regions]operation. Be sure to add the include Availability Zones parameter + // to your request. + // + // [get regions]: http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html // // This member is required. AvailabilityZone *string // The ID for a virtual private server image ( app_wordpress_4_4 or 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 inactive - // when they become outdated due to operating system updates or new application - // releases. + // 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 inactive when they + // become outdated due to operating system updates or new application releases. // // This member is required. BlueprintId *string @@ -68,29 +72,37 @@ type CreateInstancesInput struct { // An array of objects representing the add-ons to enable for the new instance. AddOns []types.AddOnRequest - // (Discontinued) The name for your custom image. In releases prior to June 12, - // 2017, this parameter was ignored by the API. It is now discontinued. + // (Discontinued) The name for your custom image. + // + // In releases prior to June 12, 2017, this parameter was ignored by the API. It + // is now discontinued. // // 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 . + // 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 . IpAddressType types.IpAddressType // The name of your key pair. KeyPairName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. 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 - // 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, 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]. + // + // [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 08b1942b82d..9b8098e3870 100644 --- a/service/lightsail/api_op_CreateInstancesFromSnapshot.go +++ b/service/lightsail/api_op_CreateInstancesFromSnapshot.go @@ -12,11 +12,13 @@ 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]. +// +// [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{} @@ -36,9 +38,10 @@ 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) - // operation. Be sure to add the include Availability Zones parameter to your - // request. + // Availability Zones by using the [get regions]operation. Be sure to add the include + // Availability Zones parameter to your request. + // + // [get regions]: http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html // // This member is required. AvailabilityZone *string @@ -62,14 +65,20 @@ 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: + // 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. 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 . + // 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 . IpAddressType types.IpAddressType // The name for your key pair. @@ -77,46 +86,65 @@ type CreateInstancesFromSnapshotInput struct { // 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: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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 - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag // A Boolean value to indicate whether to use the latest available automatic - // snapshot. Constraints: + // 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) - // . + // snapshot. For more information, see the [Amazon Lightsail Developer Guide]. + // + // [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]. + // + // [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 97f17c2c137..9e145552901 100644 --- a/service/lightsail/api_op_CreateKeyPair.go +++ b/service/lightsail/api_op_CreateKeyPair.go @@ -12,12 +12,16 @@ 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) -// 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) -// . +// instance. +// +// Use the [DownloadDefaultKeyPair] 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]. +// +// [DownloadDefaultKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html +// [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{} @@ -40,8 +44,9 @@ type CreateKeyPairInput struct { // This member is required. KeyPairName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateLoadBalancer.go b/service/lightsail/api_op_CreateLoadBalancer.go index 27a80f345b5..faa02862ae9 100644 --- a/service/lightsail/api_op_CreateLoadBalancer.go +++ b/service/lightsail/api_op_CreateLoadBalancer.go @@ -12,14 +12,18 @@ 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 -// 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) -// . +// balance your application, see [Configure your 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]. +// +// [Configure your Lightsail instances for load balancing]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/configure-lightsail-instances-for-load-balancing +// [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{} @@ -51,36 +55,48 @@ type CreateLoadBalancerInput struct { // certificate ( www.example.com , example.com , m.example.com , blog.example.com ). CertificateAlternativeNames []string - // The domain name with which your certificate is associated ( example.com ). If - // you specify certificateDomainName , then certificateName is required (and + // The domain name with which your certificate is associated ( 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 - // certificateDomainName is required (and vice-versa). + // 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 ( "/" - // ). 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. + // ). + // + // 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 - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. 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) - // 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) - // in the Amazon Lightsail Developer Guide. + // The name of the TLS policy to apply to the load balancer. + // + // Use the [GetLoadBalancerTlsPolicies] 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] in the Amazon + // Lightsail Developer Guide. + // + // [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 + // [GetLoadBalancerTlsPolicies]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html TlsPolicyName *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go b/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go index 590740360a0..f217a42b68a 100644 --- a/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_CreateLoadBalancerTlsCertificate.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -39,11 +42,14 @@ type CreateLoadBalancerTlsCertificateInput struct { // 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 - // 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) . + // 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]. + // + // [Limits]: http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html // // This member is required. CertificateName *string @@ -59,8 +65,9 @@ type CreateLoadBalancerTlsCertificateInput struct { // wildcards ( *.example.com ). CertificateAlternativeNames []string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateRelationalDatabase.go b/service/lightsail/api_op_CreateRelationalDatabase.go index 89d3287a676..79dc29daac0 100644 --- a/service/lightsail/api_op_CreateRelationalDatabase.go +++ b/service/lightsail/api_op_CreateRelationalDatabase.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -33,111 +35,185 @@ func (c *Client) CreateRelationalDatabase(ctx context.Context, params *CreateRel type CreateRelationalDatabaseInput struct { // The meaning of this parameter differs according to the database engine you use. - // MySQL The name of the database to create when the Lightsail database resource is + // + // 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: + // 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: + // + // - 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], [MySQL 5.7], and [MySQL 8.0]. + // + // 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) - // . + // + // - 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], [PostgreSQL 10], [PostgreSQL 11], and [PostgreSQL 12]. + // + // [MySQL 5.6]: https://dev.mysql.com/doc/refman/5.6/en/keywords.html + // [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 + // [MySQL 8.0]: https://dev.mysql.com/doc/refman/8.0/en/keywords.html + // [PostgreSQL 12]: https://www.postgresql.org/docs/12/sql-keywords-appendix.html + // [PostgreSQL 11]: https://www.postgresql.org/docs/11/sql-keywords-appendix.html + // [MySQL 5.7]: https://dev.mysql.com/doc/refman/5.7/en/keywords.html // // This member is required. MasterDatabaseName *string - // The name for the master user. MySQL Constraints: + // 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: + // + // - 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], [MySQL 5.7], or [MySQL 8.0]. + // + // 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) - // . + // + // - 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], [PostgreSQL 10], [PostgreSQL 11], and [PostgreSQL 12]. + // + // [MySQL 5.6]: https://dev.mysql.com/doc/refman/5.6/en/keywords.html + // [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 + // [MySQL 8.0]: https://dev.mysql.com/doc/refman/8.0/en/keywords.html + // [PostgreSQL 12]: https://www.postgresql.org/docs/12/sql-keywords-appendix.html + // [PostgreSQL 11]: https://www.postgresql.org/docs/11/sql-keywords-appendix.html + // [MySQL 5.7]: https://dev.mysql.com/doc/refman/5.7/en/keywords.html // // This member is required. MasterUsername *string // The blueprint ID for your new database. A blueprint describes the major engine - // version of a database. You can get a list of database blueprints IDs by using - // the get relational database blueprints operation. + // version of a database. + // + // You can get a list of database blueprints IDs by using the get relational + // database blueprints operation. // // This member is required. RelationalDatabaseBlueprintId *string // The bundle ID for your new database. A bundle describes the performance - // specifications for your database. You can get a list of database bundle IDs by - // using the get relational database bundles operation. + // specifications for your database. + // + // You can get a list of database bundle IDs by using the get relational database + // bundles operation. // // This member is required. RelationalDatabaseBundleId *string - // The name to use for your new Lightsail database resource. Constraints: + // 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. // // 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 - // character except "/", """, or "@". It cannot contain spaces. MySQL Constraints: - // Must contain from 8 to 41 characters. PostgreSQL Constraints: Must contain from - // 8 to 128 characters. + // character except "/", """, or "@". It cannot contain spaces. + // + // MySQL + // + // Constraints: Must contain from 8 to 41 characters. + // + // PostgreSQL + // + // Constraints: Must contain from 8 to 128 characters. MasterUserPassword *string // The daily time range during which automated backups are created for your new - // 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) - // guide in the Amazon Relational Database Service documentation. Constraints: - // - Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 + // 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]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. + // + // [Working With Backups]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow 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. + // 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 PreferredMaintenanceWindow *string @@ -147,8 +223,9 @@ type CreateRelationalDatabaseInput struct { // Lightsail resources in the same region as your database. PubliclyAccessible *bool - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go b/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go index fe1ce93489f..b5751048c21 100644 --- a/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go +++ b/service/lightsail/api_op_CreateRelationalDatabaseFromSnapshot.go @@ -13,13 +13,16 @@ import ( ) // Creates a new database from an existing database snapshot in Amazon Lightsail. +// // You can create a new database from a snapshot in if something goes wrong with // your original database, or to change it to a different plan, such as a high -// 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) -// . +// 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]. +// +// [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{} @@ -37,17 +40,23 @@ func (c *Client) CreateRelationalDatabaseFromSnapshot(ctx context.Context, param type CreateRelationalDatabaseFromSnapshotInput struct { - // The name to use for your new Lightsail database resource. Constraints: + // 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. // // 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 @@ -57,34 +66,48 @@ type CreateRelationalDatabaseFromSnapshotInput struct { PubliclyAccessible *bool // The bundle ID for your new database. A bundle describes the performance - // specifications for your database. You can get a list of database bundle IDs by - // using the get relational database bundles operation. When creating a new - // database from a snapshot, you cannot choose a bundle that is smaller than the - // bundle of the source database. + // specifications for your database. + // + // You can get a list of database bundle IDs by using the get relational database + // bundles operation. + // + // When creating a new database from a snapshot, you cannot choose a bundle that + // is smaller than the bundle of the source database. RelationalDatabaseBundleId *string // The name of the database snapshot from which to create your new database. RelationalDatabaseSnapshotName *string - // The date and time to restore your database from. Constraints: + // 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. + // + // - 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. SourceRelationalDatabaseName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the 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. + // 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 54ae84db8ad..8e22ad2a69f 100644 --- a/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go +++ b/service/lightsail/api_op_CreateRelationalDatabaseSnapshot.go @@ -13,10 +13,12 @@ import ( // Creates a snapshot of your database in Amazon Lightsail. You can use snapshots // 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) -// . +// database. +// +// The create relational database snapshot operation supports tag-based access +// control via request tags. For more information, see the [Amazon Lightsail Developer Guide]. +// +// [Amazon Lightsail 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{} @@ -39,15 +41,20 @@ type CreateRelationalDatabaseSnapshotInput struct { // This member is required. RelationalDatabaseName *string - // The name for your new database snapshot. Constraints: + // 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. // // This member is required. RelationalDatabaseSnapshotName *string - // The tag keys and optional values to add to the resource during create. Use the - // TagResource action to tag a resource after it's created. + // The tag keys and optional values to add to the resource during create. + // + // Use the TagResource action to tag a resource after it's created. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteAlarm.go b/service/lightsail/api_op_DeleteAlarm.go index 7fb3f075897..e23fba5543b 100644 --- a/service/lightsail/api_op_DeleteAlarm.go +++ b/service/lightsail/api_op_DeleteAlarm.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 f556281f98d..961a3fa4b72 100644 --- a/service/lightsail/api_op_DeleteAutoSnapshot.go +++ b/service/lightsail/api_op_DeleteAutoSnapshot.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/lightsail/api_op_DeleteBucket.go b/service/lightsail/api_op_DeleteBucket.go index cf9fbbcbfdd..12348e2293f 100644 --- a/service/lightsail/api_op_DeleteBucket.go +++ b/service/lightsail/api_op_DeleteBucket.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a Amazon Lightsail bucket. When you delete your bucket, the bucket name -// is released and can be reused for a new bucket in your account or another Amazon -// Web Services account. +// Deletes a Amazon Lightsail bucket. +// +// When you delete your bucket, the bucket name is released and can be reused for +// a new bucket in your account or another Amazon Web Services account. func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error) { if params == nil { params = &DeleteBucketInput{} @@ -31,22 +32,31 @@ 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) - // action to get a list of bucket names that you can specify. + // The name of the bucket to delete. + // + // Use the [GetBuckets] action to get a list of bucket names that you can specify. + // + // [GetBuckets]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html // // This member is required. BucketName *string - // 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: + // 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 instances that were granted access to it using the [SetResourceAccessForBucket]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. + // + // [SetResourceAccessForBucket]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html ForceDelete *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteBucketAccessKey.go b/service/lightsail/api_op_DeleteBucketAccessKey.go index 022e7e83134..3d502e1fe97 100644 --- a/service/lightsail/api_op_DeleteBucketAccessKey.go +++ b/service/lightsail/api_op_DeleteBucketAccessKey.go @@ -11,11 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Lightsail Developer Guide. +// 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] in the Amazon Lightsail Developer +// Guide. +// +// [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 func (c *Client) DeleteBucketAccessKey(ctx context.Context, params *DeleteBucketAccessKeyInput, optFns ...func(*Options)) (*DeleteBucketAccessKeyOutput, error) { if params == nil { params = &DeleteBucketAccessKeyInput{} @@ -33,8 +37,11 @@ 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) - // action to get a list of access key IDs that you can specify. + // The ID of the access key to delete. + // + // Use the [GetBucketAccessKeys] action to get a list of access key IDs that you can specify. + // + // [GetBucketAccessKeys]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html // // This member is required. AccessKeyId *string diff --git a/service/lightsail/api_op_DeleteCertificate.go b/service/lightsail/api_op_DeleteCertificate.go index 043415a94fb..a76502c7637 100644 --- a/service/lightsail/api_op_DeleteCertificate.go +++ b/service/lightsail/api_op_DeleteCertificate.go @@ -12,9 +12,11 @@ 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. +// 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. func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificateInput, optFns ...func(*Options)) (*DeleteCertificateOutput, error) { if params == nil { params = &DeleteCertificateInput{} @@ -32,8 +34,10 @@ func (c *Client) DeleteCertificate(ctx context.Context, params *DeleteCertificat type DeleteCertificateInput struct { - // The name of the certificate to delete. Use the GetCertificates action to get a - // list of certificate names that you can specify. + // The name of the certificate to delete. + // + // Use the GetCertificates action to get a list of certificate names that you can + // specify. // // This member is required. CertificateName *string diff --git a/service/lightsail/api_op_DeleteContactMethod.go b/service/lightsail/api_op_DeleteContactMethod.go index a27d7b51f4b..3d41d70cf84 100644 --- a/service/lightsail/api_op_DeleteContactMethod.go +++ b/service/lightsail/api_op_DeleteContactMethod.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a 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) -// . +// Deletes a 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]. +// +// [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{} @@ -35,8 +37,9 @@ func (c *Client) DeleteContactMethod(ctx context.Context, params *DeleteContactM type DeleteContactMethodInput struct { - // The protocol that will be deleted, such as Email or SMS (text messaging). To - // delete an Email and an SMS contact method if you added both, you must run + // The protocol that will be deleted, such as Email or SMS (text messaging). + // + // To delete an Email and an SMS contact method if you added both, you must run // separate DeleteContactMethod actions to delete each protocol. // // This member is required. diff --git a/service/lightsail/api_op_DeleteContainerImage.go b/service/lightsail/api_op_DeleteContainerImage.go index 6dffcff191e..d43df6f84db 100644 --- a/service/lightsail/api_op_DeleteContainerImage.go +++ b/service/lightsail/api_op_DeleteContainerImage.go @@ -29,13 +29,16 @@ func (c *Client) DeleteContainerImage(ctx context.Context, params *DeleteContain type DeleteContainerImageInput struct { - // The name of the container image to delete from the container service. Use the - // 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 . + // The name of the container image to delete from the container service. + // + // Use the 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 . // // This member is required. Image *string diff --git a/service/lightsail/api_op_DeleteDisk.go b/service/lightsail/api_op_DeleteDisk.go index f7a2c428450..3d7e6cfc9ac 100644 --- a/service/lightsail/api_op_DeleteDisk.go +++ b/service/lightsail/api_op_DeleteDisk.go @@ -12,11 +12,15 @@ 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) +// 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] // . +// +// [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{} diff --git a/service/lightsail/api_op_DeleteDiskSnapshot.go b/service/lightsail/api_op_DeleteDiskSnapshot.go index 9f9d9ade80d..1fea58b7df5 100644 --- a/service/lightsail/api_op_DeleteDiskSnapshot.go +++ b/service/lightsail/api_op_DeleteDiskSnapshot.go @@ -11,16 +11,20 @@ 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 -// 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) -// . +// 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]. +// +// [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{} diff --git a/service/lightsail/api_op_DeleteDistribution.go b/service/lightsail/api_op_DeleteDistribution.go index 86cfcdac040..21f40009a7b 100644 --- a/service/lightsail/api_op_DeleteDistribution.go +++ b/service/lightsail/api_op_DeleteDistribution.go @@ -29,8 +29,10 @@ 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 7ebe34e24a8..254aa64334d 100644 --- a/service/lightsail/api_op_DeleteDomain.go +++ b/service/lightsail/api_op_DeleteDomain.go @@ -11,11 +11,13 @@ 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 +// 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) -// . +// the [Amazon Lightsail Developer Guide]. +// +// [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 b9ab6cb1dcb..b4e5e552638 100644 --- a/service/lightsail/api_op_DeleteDomainEntry.go +++ b/service/lightsail/api_op_DeleteDomainEntry.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 b855c1174c1..73d9294c43f 100644 --- a/service/lightsail/api_op_DeleteInstance.go +++ b/service/lightsail/api_op_DeleteInstance.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 0c7983a49ce..fcfc6c6838a 100644 --- a/service/lightsail/api_op_DeleteInstanceSnapshot.go +++ b/service/lightsail/api_op_DeleteInstanceSnapshot.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specific snapshot of a virtual private server (or instance). The -// delete instance snapshot operation supports tag-based access control via +// 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) -// . +// more information, see the [Amazon Lightsail Developer Guide]. +// +// [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 7356f606b4a..63ac0ddfedd 100644 --- a/service/lightsail/api_op_DeleteKeyPair.go +++ b/service/lightsail/api_op_DeleteKeyPair.go @@ -11,16 +11,21 @@ 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) -// 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) -// 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) -// . +// Deletes the specified key pair by removing the public key from Amazon Lightsail. +// +// You can delete key pairs that were created using the [ImportKeyPair] and [CreateKeyPair] 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]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]. +// +// [ImportKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html +// [CreateKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html +// [DownloadDefaultKeyPair]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html +// [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{} @@ -43,8 +48,9 @@ type DeleteKeyPairInput struct { // This member is required. KeyPairName *string - // The RSA fingerprint of the Lightsail default key pair to delete. The - // expectedFingerprint parameter is required only when specifying to delete a + // The RSA fingerprint of the Lightsail default key pair to delete. + // + // The expectedFingerprint parameter is required only when specifying to delete a // Lightsail default key pair. ExpectedFingerprint *string diff --git a/service/lightsail/api_op_DeleteKnownHostKeys.go b/service/lightsail/api_op_DeleteKnownHostKeys.go index 495e35851f3..26590b25aa0 100644 --- a/service/lightsail/api_op_DeleteKnownHostKeys.go +++ b/service/lightsail/api_op_DeleteKnownHostKeys.go @@ -14,12 +14,13 @@ import ( // Deletes the known host key or certificate used by the Amazon Lightsail // browser-based SSH or RDP clients to authenticate an instance. This operation // enables the Lightsail browser-based SSH or RDP clients to connect to the -// instance after a host key mismatch. Perform this operation only if you were -// 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) -// . +// instance after a host key mismatch. +// +// Perform this operation only if you were 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]. +// +// [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 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 846d373994c..7027697d353 100644 --- a/service/lightsail/api_op_DeleteLoadBalancer.go +++ b/service/lightsail/api_op_DeleteLoadBalancer.go @@ -13,11 +13,13 @@ import ( // Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. // 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) -// . +// 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]. +// +// [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 65ae7a0c736..4921d42e7d6 100644 --- a/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go +++ b/service/lightsail/api_op_DeleteLoadBalancerTlsCertificate.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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,10 +45,11 @@ type DeleteLoadBalancerTlsCertificateInput struct { // This member is required. LoadBalancerName *string - // 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. + // 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. Force *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteRelationalDatabase.go b/service/lightsail/api_op_DeleteRelationalDatabase.go index 78d4ba591db..a0357e4a7eb 100644 --- a/service/lightsail/api_op_DeleteRelationalDatabase.go +++ b/service/lightsail/api_op_DeleteRelationalDatabase.go @@ -11,11 +11,13 @@ 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]. +// +// [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{} @@ -39,18 +41,26 @@ type DeleteRelationalDatabaseInput struct { 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. + // 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. 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 + // 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 SkipFinalSnapshot *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go b/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go index 68459636849..75efd3b16f6 100644 --- a/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go +++ b/service/lightsail/api_op_DeleteRelationalDatabaseSnapshot.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 55fc6c33bae..95cb6930ba3 100644 --- a/service/lightsail/api_op_DetachCertificateFromDistribution.go +++ b/service/lightsail/api_op_DetachCertificateFromDistribution.go @@ -12,9 +12,10 @@ import ( ) // Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery -// network (CDN) distribution. After the certificate is detached, your distribution -// stops accepting traffic for all of the domains that are associated with the -// certificate. +// network (CDN) distribution. +// +// After the certificate is detached, your distribution stops accepting traffic +// for all of the domains that are associated with the certificate. func (c *Client) DetachCertificateFromDistribution(ctx context.Context, params *DetachCertificateFromDistributionInput, optFns ...func(*Options)) (*DetachCertificateFromDistributionOutput, error) { if params == nil { params = &DetachCertificateFromDistributionInput{} @@ -32,8 +33,10 @@ 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. + // 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. // // This member is required. DistributionName *string diff --git a/service/lightsail/api_op_DetachDisk.go b/service/lightsail/api_op_DetachDisk.go index 4fc0d2bba0f..0368e6be5fa 100644 --- a/service/lightsail/api_op_DetachDisk.go +++ b/service/lightsail/api_op_DetachDisk.go @@ -13,11 +13,13 @@ 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] // . +// +// [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{} diff --git a/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go b/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go index 26f4ff62e4b..d65cab2ed1e 100644 --- a/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go +++ b/service/lightsail/api_op_DetachInstancesFromLoadBalancer.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detaches the specified instances from a Lightsail load balancer. This operation -// 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) -// . +// Detaches the specified instances from a Lightsail load balancer. +// +// This operation 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]. +// +// [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 05de4b65d33..24d58039c34 100644 --- a/service/lightsail/api_op_DisableAddOn.go +++ b/service/lightsail/api_op_DisableAddOn.go @@ -12,8 +12,9 @@ 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]. +// +// [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_DownloadDefaultKeyPair.go b/service/lightsail/api_op_DownloadDefaultKeyPair.go index 39cd2f863e1..5692407dbe6 100644 --- a/service/lightsail/api_op_DownloadDefaultKeyPair.go +++ b/service/lightsail/api_op_DownloadDefaultKeyPair.go @@ -11,9 +11,10 @@ import ( "time" ) -// Downloads the regional Amazon Lightsail default key pair. This action also -// creates a Lightsail default key pair if a default key pair does not currently -// exist in the Amazon Web Services Region. +// Downloads the regional Amazon Lightsail default key pair. +// +// This action also creates a Lightsail default key pair if a default key pair +// does not currently exist in the Amazon Web Services Region. func (c *Client) DownloadDefaultKeyPair(ctx context.Context, params *DownloadDefaultKeyPairInput, optFns ...func(*Options)) (*DownloadDefaultKeyPairOutput, error) { if params == nil { params = &DownloadDefaultKeyPairInput{} diff --git a/service/lightsail/api_op_EnableAddOn.go b/service/lightsail/api_op_EnableAddOn.go index 24164dd52fa..1ccd87d2460 100644 --- a/service/lightsail/api_op_EnableAddOn.go +++ b/service/lightsail/api_op_EnableAddOn.go @@ -12,8 +12,9 @@ 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]. +// +// [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 f2633642014..22260b208c2 100644 --- a/service/lightsail/api_op_ExportSnapshot.go +++ b/service/lightsail/api_op_ExportSnapshot.go @@ -14,16 +14,22 @@ import ( // Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon // Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot // record that can be used with the create cloud formation stack operation to -// create new Amazon EC2 instances. Exported instance snapshots appear in Amazon -// EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an -// Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear -// 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 +// create new Amazon EC2 instances. +// +// Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images +// (AMIs), and the instance system disk appears as an Amazon Elastic Block Store +// (Amazon EBS) volume. Exported disk snapshots appear 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]. +// +// Use the get instance snapshots or get disk snapshots operations to get a list // of snapshots that you can export to Amazon EC2. +// +// [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags 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_GetActiveNames.go b/service/lightsail/api_op_GetActiveNames.go index 058bc0417bf..38599a25a93 100644 --- a/service/lightsail/api_op_GetActiveNames.go +++ b/service/lightsail/api_op_GetActiveNames.go @@ -28,10 +28,11 @@ func (c *Client) GetActiveNames(ctx context.Context, params *GetActiveNamesInput type GetActiveNamesInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetActiveNames 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetActiveNames 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 @@ -42,10 +43,12 @@ type GetActiveNamesOutput struct { // The list of active names returned by the get active names request. ActiveNames []string - // 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 GetActiveNames request and specify the next - // page token using the pageToken parameter. + // 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 GetActiveNames 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_GetAlarms.go b/service/lightsail/api_op_GetAlarms.go index 03e46cae11c..5ad9b85f49b 100644 --- a/service/lightsail/api_op_GetAlarms.go +++ b/service/lightsail/api_op_GetAlarms.go @@ -13,12 +13,14 @@ import ( // Returns information about the configured alarms. Specify an alarm name in your // request to return information about a specific alarm, or specify a monitored -// resource name to return information about all alarms for a specific resource. An -// alarm is used to monitor a single metric for one of your resources. When a +// resource name to return information about all alarms for a specific resource. +// +// 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) -// . +// see [Alarms in Amazon Lightsail]. +// +// [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{} @@ -36,17 +38,20 @@ func (c *Client) GetAlarms(ctx context.Context, params *GetAlarmsInput, optFns . type GetAlarmsInput struct { - // The name of the alarm. Specify an alarm name to return information about a - // specific alarm. + // The name of the alarm. + // + // Specify an alarm name to return information about a specific alarm. AlarmName *string - // The name of the Lightsail resource being monitored by the alarm. Specify a - // monitored resource name to return information about all alarms for a specific - // resource. + // The name of the Lightsail resource being monitored by the alarm. + // + // Specify a monitored resource name to return information about all alarms for a + // specific resource. 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 + // 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. PageToken *string @@ -59,10 +64,12 @@ type GetAlarmsOutput struct { // An array of objects that describe the alarms. Alarms []types.Alarm - // 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 GetAlarms request and specify the next page - // token using the pageToken parameter. + // 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 GetAlarms 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_GetAutoSnapshots.go b/service/lightsail/api_op_GetAutoSnapshots.go index a8f305ce719..00838930a6d 100644 --- a/service/lightsail/api_op_GetAutoSnapshots.go +++ b/service/lightsail/api_op_GetAutoSnapshots.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/lightsail/api_op_GetBlueprints.go b/service/lightsail/api_op_GetBlueprints.go index d0ea6450dc9..bbc1a6a66dd 100644 --- a/service/lightsail/api_op_GetBlueprints.go +++ b/service/lightsail/api_op_GetBlueprints.go @@ -14,11 +14,12 @@ import ( // Returns the list of available instance images, or blueprints. You can use a // blueprint to create a new instance already running a specific operating system, // as well as a preinstalled app or development stack. The software each instance -// is running depends on the blueprint image you choose. 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 inactive when they become outdated due to operating system -// updates or new application releases. +// is running depends on the blueprint image you choose. +// +// 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 inactive when they +// become outdated due to operating system updates or new application releases. func (c *Client) GetBlueprints(ctx context.Context, params *GetBlueprintsInput, optFns ...func(*Options)) (*GetBlueprintsOutput, error) { if params == nil { params = &GetBlueprintsInput{} @@ -36,18 +37,20 @@ func (c *Client) GetBlueprints(ctx context.Context, params *GetBlueprintsInput, type GetBlueprintsInput struct { - // Returns a list of blueprints that are specific to Lightsail for Research. You - // must use this parameter to view Lightsail for Research blueprints. + // Returns a list of blueprints that are specific to Lightsail for Research. + // + // You must use this parameter to view Lightsail for Research blueprints. AppCategory types.AppCategory // A Boolean value that indicates whether to include inactive (unavailable) // blueprints in the response of your request. IncludeInactive *bool - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetBlueprints 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetBlueprints 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 @@ -59,10 +62,12 @@ type GetBlueprintsOutput struct { // blueprints. Blueprints []types.Blueprint - // 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. + // 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. 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 7f9692c0f9c..7dd32f18a79 100644 --- a/service/lightsail/api_op_GetBucketAccessKeys.go +++ b/service/lightsail/api_op_GetBucketAccessKeys.go @@ -12,10 +12,12 @@ 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) +// can get a secret access key only when you create it from the response of the [CreateBucketAccessKey] // action. If you lose the secret access key, you must create a new access key. +// +// [CreateBucketAccessKey]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html func (c *Client) GetBucketAccessKeys(ctx context.Context, params *GetBucketAccessKeysInput, optFns ...func(*Options)) (*GetBucketAccessKeysOutput, error) { if params == nil { params = &GetBucketAccessKeysInput{} diff --git a/service/lightsail/api_op_GetBucketBundles.go b/service/lightsail/api_op_GetBucketBundles.go index 7a7215fd2d5..e514c0fe432 100644 --- a/service/lightsail/api_op_GetBucketBundles.go +++ b/service/lightsail/api_op_GetBucketBundles.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// action to update the bundle for a bucket. +// 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] action to update the bundle for a bucket. +// +// [UpdateBucketBundle]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html func (c *Client) GetBucketBundles(ctx context.Context, params *GetBucketBundlesInput, optFns ...func(*Options)) (*GetBucketBundlesOutput, error) { if params == nil { params = &GetBucketBundlesInput{} diff --git a/service/lightsail/api_op_GetBucketMetricData.go b/service/lightsail/api_op_GetBucketMetricData.go index 2a01b17da44..fbb4b751ec2 100644 --- a/service/lightsail/api_op_GetBucketMetricData.go +++ b/service/lightsail/api_op_GetBucketMetricData.go @@ -13,6 +13,7 @@ import ( ) // Returns the data points of a specific metric for an Amazon Lightsail bucket. +// // Metrics report the utilization of a bucket. View and collect metric data // regularly to monitor the number of objects stored in a bucket (including object // versions) and the storage space used by those objects. @@ -43,27 +44,38 @@ type GetBucketMetricDataInput struct { // This member is required. EndTime *time.Time - // The metric for which you want to return information. Valid bucket metric names - // 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. + // The metric for which you want to return information. + // + // Valid bucket metric names 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 . + // 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 . + // 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 @@ -73,27 +85,35 @@ type GetBucketMetricDataInput struct { // This member is required. StartTime *time.Time - // The statistic for the metric. The following statistics are available: + // 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. // // This member is required. Statistics []types.MetricStatistic - // The unit for the metric data request. Valid units depend on the metric data - // being requested. For the valid units with each available metric, see the - // metricName parameter. + // The unit for the metric data request. + // + // Valid units depend on the metric data being requested. For the valid units with + // each available metric, see the metricName parameter. // // This member is required. Unit types.MetricUnit diff --git a/service/lightsail/api_op_GetBuckets.go b/service/lightsail/api_op_GetBuckets.go index ca721165e0b..04b60fee186 100644 --- a/service/lightsail/api_op_GetBuckets.go +++ b/service/lightsail/api_op_GetBuckets.go @@ -14,8 +14,12 @@ 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) -// in the Amazon Lightsail Developer Guide. +// buckets. +// +// For more information about buckets, see [Buckets in Amazon Lightsail] in the Amazon Lightsail Developer +// Guide. +// +// [Buckets in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail func (c *Client) GetBuckets(ctx context.Context, params *GetBucketsInput, optFns ...func(*Options)) (*GetBucketsOutput, error) { if params == nil { params = &GetBucketsInput{} @@ -33,18 +37,21 @@ func (c *Client) GetBuckets(ctx context.Context, params *GetBucketsInput, optFns type GetBucketsInput struct { - // The name of the bucket for which to return information. When omitted, the - // response includes all of your buckets in the Amazon Web Services Region where - // the request is made. + // The name of the bucket for which to return information. + // + // When omitted, the response includes all of your buckets in the Amazon Web + // Services Region where the request is made. 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) - // action. + // given access to the bucket using the [SetResourceAccessForBucket]action. + // + // [SetResourceAccessForBucket]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html IncludeConnectedResources *bool - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetBuckets request. If your results are + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetBuckets 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 @@ -55,19 +62,23 @@ type GetBucketsInput struct { 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) - // . + // 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]. + // + // [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 AccountLevelBpaSync *types.AccountLevelBpaSync // An array of objects that describe buckets. Buckets []types.Bucket - // 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 GetBuckets request and specify the next page - // token using the pageToken parameter. + // 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 GetBuckets 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_GetBundles.go b/service/lightsail/api_op_GetBundles.go index 6d82bce5833..32e9c626539 100644 --- a/service/lightsail/api_op_GetBundles.go +++ b/service/lightsail/api_op_GetBundles.go @@ -12,10 +12,13 @@ import ( ) // Returns the bundles that you can apply to an Amazon Lightsail instance when you -// create it. A bundle describes the specifications of an instance, such as the -// monthly cost, amount of memory, the number of vCPUs, amount of storage space, -// and monthly network data transfer quota. Bundles are referred to as instance -// plans in the Lightsail console. +// create it. +// +// A bundle describes the specifications of an instance, such as the monthly cost, +// amount of memory, the number of vCPUs, amount of storage space, and monthly +// network data transfer quota. +// +// Bundles are referred to as instance plans in the Lightsail console. func (c *Client) GetBundles(ctx context.Context, params *GetBundlesInput, optFns ...func(*Options)) (*GetBundlesOutput, error) { if params == nil { params = &GetBundlesInput{} @@ -33,16 +36,18 @@ func (c *Client) GetBundles(ctx context.Context, params *GetBundlesInput, optFns type GetBundlesInput struct { - // Returns a list of bundles that are specific to Lightsail for Research. You must - // use this parameter to view Lightsail for Research bundles. + // Returns a list of bundles that are specific to Lightsail for Research. + // + // You must 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. IncludeInactive *bool - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetBundles request. If your results are + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetBundles 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 @@ -56,10 +61,12 @@ type GetBundlesOutput struct { // bundles. Bundles []types.Bundle - // 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 GetBundles request and specify the next page - // token using the pageToken parameter. + // 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 GetBundles 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_GetCertificates.go b/service/lightsail/api_op_GetCertificates.go index c8b0ebeca5c..8a9a7fb2402 100644 --- a/service/lightsail/api_op_GetCertificates.go +++ b/service/lightsail/api_op_GetCertificates.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about one or more Amazon Lightsail SSL/TLS certificates. To -// get a summary of a certificate, omit includeCertificateDetails from your +// Returns information about one or more Amazon Lightsail SSL/TLS certificates. +// +// To get a summary of a certificate, omit includeCertificateDetails from your // request. The response will include only the certificate Amazon Resource Name // (ARN), certificate name, domain name, and tags. func (c *Client) GetCertificates(ctx context.Context, params *GetCertificatesInput, optFns ...func(*Options)) (*GetCertificatesOutput, error) { @@ -32,26 +33,32 @@ func (c *Client) GetCertificates(ctx context.Context, params *GetCertificatesInp type GetCertificatesInput struct { - // The name for the certificate for which to return information. When omitted, the - // response includes all of your certificates in the Amazon Web Services Region - // where the request is made. + // The name for the certificate for which to return information. + // + // When omitted, the response includes all of your certificates in the Amazon Web + // Services Region where the request is made. CertificateName *string - // The status of the certificates for which to return information. For example, - // specify ISSUED to return only certificates with an ISSUED status. When omitted, - // the response includes all of your certificates in the Amazon Web Services Region - // where the request is made, regardless of their current status. + // The status of the certificates for which to return information. + // + // For example, specify ISSUED to return only certificates with an ISSUED status. + // + // When omitted, the response includes all of your certificates in the Amazon Web + // Services Region where the request is made, regardless of their current status. CertificateStatuses []types.CertificateStatus // Indicates whether to include detailed information about the certificates in the - // response. When omitted, the response includes only the certificate names, Amazon - // Resource Names (ARNs), domain names, and tags. + // response. + // + // When omitted, the response includes only the certificate names, Amazon Resource + // Names (ARNs), domain names, and tags. IncludeCertificateDetails bool - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetCertificates 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetCertificates 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_GetCloudFormationStackRecords.go b/service/lightsail/api_op_GetCloudFormationStackRecords.go index ef2e65aed51..1778b0e438d 100644 --- a/service/lightsail/api_op_GetCloudFormationStackRecords.go +++ b/service/lightsail/api_op_GetCloudFormationStackRecords.go @@ -12,8 +12,10 @@ import ( ) // Returns the CloudFormation stack record created as a result of the create cloud -// formation stack operation. An AWS CloudFormation stack is used to create a new -// Amazon EC2 instance from an exported Lightsail snapshot. +// formation stack operation. +// +// An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an +// exported Lightsail snapshot. func (c *Client) GetCloudFormationStackRecords(ctx context.Context, params *GetCloudFormationStackRecordsInput, optFns ...func(*Options)) (*GetCloudFormationStackRecordsOutput, error) { if params == nil { params = &GetCloudFormationStackRecordsInput{} @@ -31,10 +33,11 @@ func (c *Client) GetCloudFormationStackRecords(ctx context.Context, params *GetC type GetCloudFormationStackRecordsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetClouFormationStackRecords 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetClouFormationStackRecords 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 @@ -45,10 +48,12 @@ type GetCloudFormationStackRecordsOutput struct { // A list of objects describing the CloudFormation stack records. CloudFormationStackRecords []types.CloudFormationStackRecord - // 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 GetCloudFormationStackRecords request and - // specify the next page token using the pageToken parameter. + // 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 GetCloudFormationStackRecords + // 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_GetContactMethods.go b/service/lightsail/api_op_GetContactMethods.go index 47163c1df76..31aba6bd110 100644 --- a/service/lightsail/api_op_GetContactMethods.go +++ b/service/lightsail/api_op_GetContactMethods.go @@ -12,13 +12,15 @@ import ( ) // Returns information about the configured contact methods. Specify a protocol in -// your request to return information about a specific 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) -// . +// your request to return information about a specific 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]. +// +// [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{} @@ -37,8 +39,10 @@ func (c *Client) GetContactMethods(ctx context.Context, params *GetContactMethod type GetContactMethodsInput struct { // 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. + // messaging). + // + // Specify a protocol in your request to return information about a specific + // contact method protocol. Protocols []types.ContactProtocol noSmithyDocumentSerde diff --git a/service/lightsail/api_op_GetContainerImages.go b/service/lightsail/api_op_GetContainerImages.go index 8c91f2a2cd5..6f7b9bef160 100644 --- a/service/lightsail/api_op_GetContainerImages.go +++ b/service/lightsail/api_op_GetContainerImages.go @@ -12,10 +12,12 @@ import ( ) // Returns the container images that are registered to your Amazon Lightsail -// container service. If you created a deployment on your Lightsail container -// service that uses container images from a public registry like Docker Hub, those -// images are not returned as part of this action. Those images are not registered -// to your Lightsail container service. +// container service. +// +// If you created a deployment on your Lightsail container service that uses +// container images from a public registry like Docker Hub, those images are not +// returned as part of this action. Those images are not registered to your +// Lightsail container service. func (c *Client) GetContainerImages(ctx context.Context, params *GetContainerImagesInput, optFns ...func(*Options)) (*GetContainerImagesOutput, error) { if params == nil { params = &GetContainerImagesInput{} diff --git a/service/lightsail/api_op_GetContainerLog.go b/service/lightsail/api_op_GetContainerLog.go index 795bb6c93d0..2aea45405bf 100644 --- a/service/lightsail/api_op_GetContainerLog.go +++ b/service/lightsail/api_op_GetContainerLog.go @@ -13,12 +13,16 @@ import ( ) // Returns the log events of a container of your Amazon Lightsail container -// service. If your container service has more than one node (i.e., a scale greater -// than 1), then the log events that are returned for the specified container are -// merged from all nodes on your container service. Container logs are retained for -// a certain amount of time. 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. +// service. +// +// If your container service has more than one node (i.e., a scale greater than +// 1), then the log events that are returned for the specified container are merged +// from all nodes on your container service. +// +// Container logs are retained for a certain amount of time. For more information, +// see [Amazon Lightsail endpoints and quotas]in the Amazon Web Services General Reference. +// +// [Amazon Lightsail endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/lightsail.html func (c *Client) GetContainerLog(ctx context.Context, params *GetContainerLogInput, optFns ...func(*Options)) (*GetContainerLogOutput, error) { if params == nil { params = &GetContainerLogInput{} @@ -47,39 +51,64 @@ type GetContainerLogInput struct { // This member is required. ServiceName *string - // The end of the time interval for which to get log data. Constraints: + // 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. + // + // - 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/) . + // like [Epoch converter]. + // + // [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: + // 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" . FilterPattern *string - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetContainerLog 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetContainerLog 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 - // The start of the time interval for which to get log data. Constraints: + // 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. + // + // - 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/) . + // like [Epoch converter]. + // + // [Epoch converter]: https://www.epochconverter.com/ StartTime *time.Time noSmithyDocumentSerde @@ -90,10 +119,12 @@ type GetContainerLogOutput struct { // An array of objects that describe the log events of a container. LogEvents []types.ContainerServiceLogEvent - // 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 GetContainerLog request and specify the next - // page token using the pageToken parameter. + // 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 GetContainerLog 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_GetContainerServiceDeployments.go b/service/lightsail/api_op_GetContainerServiceDeployments.go index 0c85985adae..669c7bb48da 100644 --- a/service/lightsail/api_op_GetContainerServiceDeployments.go +++ b/service/lightsail/api_op_GetContainerServiceDeployments.go @@ -11,14 +11,19 @@ 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]in the Amazon Web Services General +// Reference. +// +// [Amazon Lightsail endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/lightsail.html 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 448f18c6269..96da488bada 100644 --- a/service/lightsail/api_op_GetContainerServiceMetricData.go +++ b/service/lightsail/api_op_GetContainerServiceMetricData.go @@ -13,9 +13,11 @@ import ( ) // Returns the data points of a specific metric of your Amazon Lightsail container -// service. Metrics report the utilization of your resources. Monitor and collect -// metric data regularly to maintain the reliability, availability, and performance -// of your resources. +// service. +// +// Metrics report the utilization of your resources. Monitor and collect metric +// data regularly to maintain the reliability, availability, and performance of +// your resources. func (c *Client) GetContainerServiceMetricData(ctx context.Context, params *GetContainerServiceMetricDataInput, optFns ...func(*Options)) (*GetContainerServiceMetricDataOutput, error) { if params == nil { params = &GetContainerServiceMetricDataInput{} @@ -38,25 +40,36 @@ type GetContainerServiceMetricDataInput struct { // This member is required. EndTime *time.Time - // 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. + // 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 . + // 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 . + // service. + // + // Statistics: The most useful statistics are Maximum and Average . + // + // Unit: The published unit is Percent . // // This member is required. MetricName types.ContainerServiceMetricName - // The granularity, in seconds, of the returned data points. All container service - // metric data is available in 5-minute (300 seconds) granularity. + // The granularity, in seconds, of the returned data points. + // + // All container service metric data is available in 5-minute (300 seconds) + // granularity. // // This member is required. Period *int32 @@ -71,18 +84,25 @@ type GetContainerServiceMetricDataInput struct { // This member is required. StartTime *time.Time - // The statistic for the metric. The following statistics are available: + // 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. // diff --git a/service/lightsail/api_op_GetContainerServicePowers.go b/service/lightsail/api_op_GetContainerServicePowers.go index 2daf90aae46..8864fdc20b5 100644 --- a/service/lightsail/api_op_GetContainerServicePowers.go +++ b/service/lightsail/api_op_GetContainerServicePowers.go @@ -12,8 +12,10 @@ import ( ) // Returns the list of powers that can be specified for your Amazon Lightsail -// container services. The power specifies the amount of memory, the number of -// vCPUs, and the base price of the container service. +// container services. +// +// The power specifies the amount of memory, the number of vCPUs, and the base +// price of the container service. func (c *Client) GetContainerServicePowers(ctx context.Context, params *GetContainerServicePowersInput, optFns ...func(*Options)) (*GetContainerServicePowersOutput, error) { if params == nil { params = &GetContainerServicePowersInput{} diff --git a/service/lightsail/api_op_GetContainerServices.go b/service/lightsail/api_op_GetContainerServices.go index 387eac45f3a..5079f5fd4a7 100644 --- a/service/lightsail/api_op_GetContainerServices.go +++ b/service/lightsail/api_op_GetContainerServices.go @@ -30,9 +30,10 @@ 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 f66922e2586..30e67e2c91b 100644 --- a/service/lightsail/api_op_GetCostEstimate.go +++ b/service/lightsail/api_op_GetCostEstimate.go @@ -31,12 +31,21 @@ func (c *Client) GetCostEstimate(ctx context.Context, params *GetCostEstimateInp type GetCostEstimateInput struct { - // The cost estimate end time. Constraints: + // The cost estimate end time. + // + // Constraints: + // // - Specified in Coordinated Universal Time (UTC). - // - Specified in the Unix time format. For example, if you want to use an end - // time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. + // + // - Specified in the Unix time format. + // + // For example, if you want 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/) . + // like [Epoch converter]. + // + // [Epoch converter]: https://www.epochconverter.com/ // // This member is required. EndTime *time.Time @@ -46,12 +55,21 @@ type GetCostEstimateInput struct { // This member is required. ResourceName *string - // The cost estimate start time. Constraints: + // The cost estimate start time. + // + // Constraints: + // // - Specified in Coordinated Universal Time (UTC). - // - Specified in the Unix time format. For example, if you want to use a start - // time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. + // + // - Specified in the Unix time format. + // + // For example, if you want 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/) . + // like [Epoch converter]. + // + // [Epoch converter]: https://www.epochconverter.com/ // // This member is required. StartTime *time.Time diff --git a/service/lightsail/api_op_GetDiskSnapshots.go b/service/lightsail/api_op_GetDiskSnapshots.go index 380322aaca1..f0e897d3b88 100644 --- a/service/lightsail/api_op_GetDiskSnapshots.go +++ b/service/lightsail/api_op_GetDiskSnapshots.go @@ -30,10 +30,11 @@ func (c *Client) GetDiskSnapshots(ctx context.Context, params *GetDiskSnapshotsI type GetDiskSnapshotsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetDiskSnapshots 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetDiskSnapshots 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 @@ -45,10 +46,12 @@ type GetDiskSnapshotsOutput struct { // snapshots. DiskSnapshots []types.DiskSnapshot - // 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 GetDiskSnapshots request and specify the next - // page token using the pageToken parameter. + // 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 GetDiskSnapshots 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_GetDisks.go b/service/lightsail/api_op_GetDisks.go index 34328f823b2..b6dd7d7c5ef 100644 --- a/service/lightsail/api_op_GetDisks.go +++ b/service/lightsail/api_op_GetDisks.go @@ -30,10 +30,11 @@ func (c *Client) GetDisks(ctx context.Context, params *GetDisksInput, optFns ... type GetDisksInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetDisks 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetDisks 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 @@ -44,10 +45,12 @@ type GetDisksOutput struct { // An array of objects containing information about all block storage disks. Disks []types.Disk - // 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 GetDisks request and specify the next page - // token using the pageToken parameter. + // 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 GetDisks 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_GetDistributionBundles.go b/service/lightsail/api_op_GetDistributionBundles.go index c4fd5db093b..14b8e03e8d3 100644 --- a/service/lightsail/api_op_GetDistributionBundles.go +++ b/service/lightsail/api_op_GetDistributionBundles.go @@ -12,8 +12,10 @@ import ( ) // Returns the bundles that can be applied to your Amazon Lightsail content -// delivery network (CDN) distributions. A distribution bundle specifies the -// monthly network transfer quota and monthly cost of your distribution. +// delivery network (CDN) distributions. +// +// A distribution bundle specifies the monthly network transfer quota and monthly +// cost of your distribution. func (c *Client) GetDistributionBundles(ctx context.Context, params *GetDistributionBundlesInput, optFns ...func(*Options)) (*GetDistributionBundlesOutput, error) { if params == nil { params = &GetDistributionBundlesInput{} diff --git a/service/lightsail/api_op_GetDistributionLatestCacheReset.go b/service/lightsail/api_op_GetDistributionLatestCacheReset.go index e17ce2d98f6..11cd06f9948 100644 --- a/service/lightsail/api_op_GetDistributionLatestCacheReset.go +++ b/service/lightsail/api_op_GetDistributionLatestCacheReset.go @@ -31,9 +31,13 @@ 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. + // 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 diff --git a/service/lightsail/api_op_GetDistributionMetricData.go b/service/lightsail/api_op_GetDistributionMetricData.go index 1e997cc3d98..6fee649ace2 100644 --- a/service/lightsail/api_op_GetDistributionMetricData.go +++ b/service/lightsail/api_op_GetDistributionMetricData.go @@ -13,10 +13,11 @@ import ( ) // Returns the data points of a specific metric for an Amazon Lightsail content -// delivery network (CDN) distribution. Metrics report the utilization of your -// resources, and the error counts generated by them. Monitor and collect metric -// data regularly to maintain the reliability, availability, and performance of -// your resources. +// delivery network (CDN) distribution. +// +// Metrics report the utilization of your resources, and the error counts +// generated by them. Monitor and collect metric data regularly to maintain the +// reliability, availability, and performance of your resources. func (c *Client) GetDistributionMetricData(ctx context.Context, params *GetDistributionMetricDataInput, optFns ...func(*Options)) (*GetDistributionMetricDataOutput, error) { if params == nil { params = &GetDistributionMetricDataInput{} @@ -34,48 +35,83 @@ 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. + // 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. // // This member is required. DistributionName *string - // The end of the time interval for which to get metric data. Constraints: + // 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. + // + // - 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/) . + // like [Epoch converter]. + // + // [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. + // 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 . + // + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 @@ -85,37 +121,54 @@ type GetDistributionMetricDataInput struct { // This member is required. Period *int32 - // The start of the time interval for which to get metric data. Constraints: + // 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. + // + // - 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/) . + // like [Epoch converter]. + // + // [Epoch converter]: https://www.epochconverter.com/ // // This member is required. StartTime *time.Time - // The statistic for the metric. The following statistics are available: + // 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. // // This member is required. Statistics []types.MetricStatistic - // The unit for the metric data request. Valid units depend on the metric data - // being requested. For the valid units with each available metric, see the - // metricName parameter. + // The unit for the metric data request. + // + // Valid units depend on the metric data being requested. For the valid units with + // each available metric, see the metricName parameter. // // This member is required. Unit types.MetricUnit diff --git a/service/lightsail/api_op_GetDistributions.go b/service/lightsail/api_op_GetDistributions.go index 895eef83ec0..dcb0d82cf4e 100644 --- a/service/lightsail/api_op_GetDistributions.go +++ b/service/lightsail/api_op_GetDistributions.go @@ -30,15 +30,17 @@ func (c *Client) GetDistributions(ctx context.Context, params *GetDistributionsI type GetDistributionsInput struct { - // The name of the distribution for which to return information. When omitted, the - // response includes all of your distributions in the Amazon Web Services Region - // where the request is made. + // The name of the distribution for which to return information. + // + // When omitted, the response includes all of your distributions in the Amazon Web + // Services Region where the request is made. DistributionName *string - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetDistributions 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetDistributions 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 @@ -49,10 +51,12 @@ type GetDistributionsOutput struct { // An array of objects that describe your distributions. Distributions []types.LightsailDistribution - // 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 GetDistributions request and specify the next - // page token using the pageToken parameter. + // 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 GetDistributions 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_GetDomains.go b/service/lightsail/api_op_GetDomains.go index e5322913c8a..21f33470f06 100644 --- a/service/lightsail/api_op_GetDomains.go +++ b/service/lightsail/api_op_GetDomains.go @@ -29,8 +29,9 @@ func (c *Client) GetDomains(ctx context.Context, params *GetDomainsInput, optFns type GetDomainsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetDomains request. If your results are + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetDomains 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 @@ -44,10 +45,12 @@ type GetDomainsOutput struct { // entries in the user's account. Domains []types.Domain - // 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 GetDomains request and specify the next page - // token using the pageToken parameter. + // 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 GetDomains 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_GetExportSnapshotRecords.go b/service/lightsail/api_op_GetExportSnapshotRecords.go index 3cb373661c1..282674d6976 100644 --- a/service/lightsail/api_op_GetExportSnapshotRecords.go +++ b/service/lightsail/api_op_GetExportSnapshotRecords.go @@ -12,9 +12,12 @@ 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) -// action. +// operation. +// +// An export snapshot record can be used to create a new Amazon EC2 instance and +// its related resources with the [CreateCloudFormationStack]action. +// +// [CreateCloudFormationStack]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html func (c *Client) GetExportSnapshotRecords(ctx context.Context, params *GetExportSnapshotRecordsInput, optFns ...func(*Options)) (*GetExportSnapshotRecordsOutput, error) { if params == nil { params = &GetExportSnapshotRecordsInput{} @@ -32,10 +35,11 @@ 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. + // 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. PageToken *string noSmithyDocumentSerde @@ -46,10 +50,12 @@ type GetExportSnapshotRecordsOutput struct { // A list of objects describing the export snapshot records. ExportSnapshotRecords []types.ExportSnapshotRecord - // 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 GetExportSnapshotRecords request and specify - // the next page token using the pageToken parameter. + // 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 GetExportSnapshotRecords + // 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_GetInstanceAccessDetails.go b/service/lightsail/api_op_GetInstanceAccessDetails.go index ab7aade2a7f..75ac58443d1 100644 --- a/service/lightsail/api_op_GetInstanceAccessDetails.go +++ b/service/lightsail/api_op_GetInstanceAccessDetails.go @@ -12,10 +12,13 @@ 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) -// . +// 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]. +// +// [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{} diff --git a/service/lightsail/api_op_GetInstanceMetricData.go b/service/lightsail/api_op_GetInstanceMetricData.go index 94ce65a712b..c9245c42615 100644 --- a/service/lightsail/api_op_GetInstanceMetricData.go +++ b/service/lightsail/api_op_GetInstanceMetricData.go @@ -13,9 +13,11 @@ import ( ) // Returns the data points for the specified Amazon Lightsail instance metric, -// given an instance name. Metrics report the utilization of your resources, and -// the error counts generated by them. Monitor and collect metric data regularly to -// maintain the reliability, availability, and performance of your resources. +// given an instance name. +// +// Metrics report the utilization of your resources, and the error counts +// generated by them. Monitor and collect metric data regularly to maintain the +// reliability, availability, and performance of your resources. func (c *Client) GetInstanceMetricData(ctx context.Context, params *GetInstanceMetricDataInput, optFns ...func(*Options)) (*GetInstanceMetricDataOutput, error) { if params == nil { params = &GetInstanceMetricDataInput{} @@ -43,74 +45,112 @@ 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. + // 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 . + // BurstCapacityPercentage reaches 100%. For more information, see [Viewing instance burst capacity in Amazon Lightsail]. + // + // 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 . + // 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]. + // + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // + // Statistics : The most useful statistic is Sum . + // + // Unit : The published unit is Count . + // + // [Viewing instance burst capacity in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity // // 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 @@ -120,18 +160,25 @@ type GetInstanceMetricDataInput struct { // This member is required. StartTime *time.Time - // The statistic for the metric. The following statistics are available: + // 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. // diff --git a/service/lightsail/api_op_GetInstanceSnapshots.go b/service/lightsail/api_op_GetInstanceSnapshots.go index 4fffb117dcf..a746014d730 100644 --- a/service/lightsail/api_op_GetInstanceSnapshots.go +++ b/service/lightsail/api_op_GetInstanceSnapshots.go @@ -29,10 +29,11 @@ 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. + // 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. PageToken *string noSmithyDocumentSerde @@ -44,10 +45,12 @@ type GetInstanceSnapshotsOutput struct { // get instance snapshots request. InstanceSnapshots []types.InstanceSnapshot - // 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 GetInstanceSnapshots request and specify the - // next page token using the pageToken parameter. + // 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 GetInstanceSnapshots 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_GetInstances.go b/service/lightsail/api_op_GetInstances.go index a00f150ff5d..08cad6e4931 100644 --- a/service/lightsail/api_op_GetInstances.go +++ b/service/lightsail/api_op_GetInstances.go @@ -30,10 +30,11 @@ func (c *Client) GetInstances(ctx context.Context, params *GetInstancesInput, op type GetInstancesInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetInstances 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetInstances 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 @@ -44,10 +45,12 @@ type GetInstancesOutput struct { // An array of key-value pairs containing information about your instances. Instances []types.Instance - // 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 GetInstances request and specify the next page - // token using the pageToken parameter. + // 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 GetInstances 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_GetKeyPairs.go b/service/lightsail/api_op_GetKeyPairs.go index e706d9b8205..93dc79bf176 100644 --- a/service/lightsail/api_op_GetKeyPairs.go +++ b/service/lightsail/api_op_GetKeyPairs.go @@ -33,10 +33,11 @@ type GetKeyPairsInput struct { // response of your request. IncludeDefaultKeyPair *bool - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetKeyPairs 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetKeyPairs 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 @@ -47,10 +48,12 @@ type GetKeyPairsOutput struct { // An array of key-value pairs containing information about the key pairs. KeyPairs []types.KeyPair - // 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 GetKeyPairs request and specify the next page - // token using the pageToken parameter. + // 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 GetKeyPairs 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_GetLoadBalancerMetricData.go b/service/lightsail/api_op_GetLoadBalancerMetricData.go index eb7d7237ae4..e13497efe90 100644 --- a/service/lightsail/api_op_GetLoadBalancerMetricData.go +++ b/service/lightsail/api_op_GetLoadBalancerMetricData.go @@ -13,9 +13,10 @@ import ( ) // Returns information about health metrics for your Lightsail load balancer. -// Metrics report the utilization of your resources, and the error counts generated -// by them. Monitor and collect metric data regularly to maintain the reliability, -// availability, and performance of your resources. +// +// Metrics report the utilization of your resources, and the error counts +// generated by them. Monitor and collect metric data regularly to maintain the +// reliability, availability, and performance of your resources. func (c *Client) GetLoadBalancerMetricData(ctx context.Context, params *GetLoadBalancerMetricDataInput, optFns ...func(*Options)) (*GetLoadBalancerMetricDataOutput, error) { if params == nil { params = &GetLoadBalancerMetricDataInput{} @@ -43,66 +44,114 @@ type GetLoadBalancerMetricDataInput struct { // This member is required. 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. + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // 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 . + // + // 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 . + // + // 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 . + // 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 . + // unhealthy. + // + // Statistics : The most useful statistic are Average , Minimum , and Maximum . + // + // Unit : The published unit is Count . // // This member is required. MetricName types.LoadBalancerMetricName @@ -117,18 +166,25 @@ type GetLoadBalancerMetricDataInput struct { // This member is required. StartTime *time.Time - // The statistic for the metric. The following statistics are available: + // 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. // diff --git a/service/lightsail/api_op_GetLoadBalancerTlsCertificates.go b/service/lightsail/api_op_GetLoadBalancerTlsCertificates.go index 01c120d90f4..9d08750d5be 100644 --- a/service/lightsail/api_op_GetLoadBalancerTlsCertificates.go +++ b/service/lightsail/api_op_GetLoadBalancerTlsCertificates.go @@ -12,10 +12,12 @@ import ( ) // Returns information about the TLS certificates that are associated with the -// specified Lightsail load balancer. TLS is just an updated, more secure version -// of Secure Socket Layer (SSL). You can have a maximum of 2 certificates -// associated with a Lightsail load balancer. One is active and the other is -// inactive. +// specified Lightsail load balancer. +// +// TLS is just an updated, more secure version of Secure Socket Layer (SSL). +// +// You can have a maximum of 2 certificates associated with a Lightsail load +// balancer. One is active and the other is inactive. func (c *Client) GetLoadBalancerTlsCertificates(ctx context.Context, params *GetLoadBalancerTlsCertificatesInput, optFns ...func(*Options)) (*GetLoadBalancerTlsCertificatesOutput, error) { if params == nil { params = &GetLoadBalancerTlsCertificatesInput{} diff --git a/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go b/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go index ec00fbfa499..737ec7270b8 100644 --- a/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go +++ b/service/lightsail/api_op_GetLoadBalancerTlsPolicies.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Lightsail Developer Guide. +// balancers. +// +// For more information about load balancer TLS security policies, see [Configuring TLS security policies on your Amazon Lightsail load balancers] in the +// Amazon Lightsail Developer Guide. +// +// [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 func (c *Client) GetLoadBalancerTlsPolicies(ctx context.Context, params *GetLoadBalancerTlsPoliciesInput, optFns ...func(*Options)) (*GetLoadBalancerTlsPoliciesOutput, error) { if params == nil { params = &GetLoadBalancerTlsPoliciesInput{} @@ -32,10 +35,11 @@ func (c *Client) GetLoadBalancerTlsPolicies(ctx context.Context, params *GetLoad type GetLoadBalancerTlsPoliciesInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetLoadBalancerTlsPolicies 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetLoadBalancerTlsPolicies 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 @@ -43,10 +47,12 @@ type GetLoadBalancerTlsPoliciesInput struct { type GetLoadBalancerTlsPoliciesOutput 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 GetLoadBalancerTlsPolicies request and specify - // the next page token using the pageToken parameter. + // 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 GetLoadBalancerTlsPolicies + // request and specify the next page token using the pageToken parameter. NextPageToken *string // An array of objects that describe the TLS security policies that are available. diff --git a/service/lightsail/api_op_GetLoadBalancers.go b/service/lightsail/api_op_GetLoadBalancers.go index d26337d972f..5021eab52c4 100644 --- a/service/lightsail/api_op_GetLoadBalancers.go +++ b/service/lightsail/api_op_GetLoadBalancers.go @@ -29,10 +29,11 @@ func (c *Client) GetLoadBalancers(ctx context.Context, params *GetLoadBalancersI type GetLoadBalancersInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetLoadBalancers 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetLoadBalancers 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 @@ -43,10 +44,12 @@ type GetLoadBalancersOutput struct { // An array of LoadBalancer objects describing your load balancers. LoadBalancers []types.LoadBalancer - // 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 GetLoadBalancers request and specify the next - // page token using the pageToken parameter. + // 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 GetLoadBalancers 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_GetOperations.go b/service/lightsail/api_op_GetOperations.go index 489ae263ee4..792e3ef0772 100644 --- a/service/lightsail/api_op_GetOperations.go +++ b/service/lightsail/api_op_GetOperations.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about all operations. Results are returned from oldest to -// newest, up to a maximum of 200. Results can be paged by making each subsequent -// call to GetOperations use the maximum (last) statusChangedAt value from the -// previous request. +// Returns information about all operations. +// +// Results are returned from oldest to newest, up to a maximum of 200. Results can +// be paged by making each subsequent call to GetOperations use the maximum (last) +// statusChangedAt value from the previous request. func (c *Client) GetOperations(ctx context.Context, params *GetOperationsInput, optFns ...func(*Options)) (*GetOperationsOutput, error) { if params == nil { params = &GetOperationsInput{} @@ -32,10 +33,11 @@ func (c *Client) GetOperations(ctx context.Context, params *GetOperationsInput, type GetOperationsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetOperations 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetOperations 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 @@ -43,10 +45,12 @@ type GetOperationsInput struct { 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. + // 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. 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 22469a002e1..67c9fbeb9bd 100644 --- a/service/lightsail/api_op_GetOperationsForResource.go +++ b/service/lightsail/api_op_GetOperationsForResource.go @@ -34,10 +34,11 @@ type GetOperationsForResourceInput struct { // This member is required. 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. + // 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. PageToken *string noSmithyDocumentSerde @@ -45,17 +46,20 @@ type GetOperationsForResourceInput struct { type GetOperationsForResourceOutput struct { - // (Discontinued) Returns the number of pages of results that remain. In releases - // prior to June 12, 2017, this parameter returned null by the API. It is now - // discontinued, and the API returns the next page token parameter instead. + // (Discontinued) Returns the number of pages of results that remain. + // + // In releases prior to June 12, 2017, this parameter returned null by the API. It + // is now discontinued, and the API returns the next page token parameter instead. // // Deprecated: This member has been deprecated. NextPageCount *string - // 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 GetOperationsForResource request and specify - // the next page token using the pageToken parameter. + // 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 GetOperationsForResource + // 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_GetRelationalDatabaseBlueprints.go b/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go index ac7f4d86492..8c9264106ba 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go +++ b/service/lightsail/api_op_GetRelationalDatabaseBlueprints.go @@ -12,8 +12,10 @@ import ( ) // 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. +// 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{} @@ -31,10 +33,11 @@ func (c *Client) GetRelationalDatabaseBlueprints(ctx context.Context, params *Ge type GetRelationalDatabaseBlueprintsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetRelationalDatabaseBlueprints 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetRelationalDatabaseBlueprints + // 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 @@ -46,10 +49,12 @@ type GetRelationalDatabaseBlueprintsOutput struct { // request. Blueprints []types.RelationalDatabaseBlueprint - // 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 GetRelationalDatabaseBlueprints request and - // specify the next page token using the pageToken parameter. + // 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 GetRelationalDatabaseBlueprints + // 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_GetRelationalDatabaseBundles.go b/service/lightsail/api_op_GetRelationalDatabaseBundles.go index 96f611f8b59..706fb018c0c 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseBundles.go +++ b/service/lightsail/api_op_GetRelationalDatabaseBundles.go @@ -12,8 +12,10 @@ import ( ) // Returns the list of bundles that are available in Amazon Lightsail. A bundle -// describes the performance specifications for a database. You can use a bundle ID -// to create a new database with explicit performance specifications. +// describes the performance specifications for a database. +// +// You can use a bundle ID to create a new database with explicit performance +// specifications. func (c *Client) GetRelationalDatabaseBundles(ctx context.Context, params *GetRelationalDatabaseBundlesInput, optFns ...func(*Options)) (*GetRelationalDatabaseBundlesOutput, error) { if params == nil { params = &GetRelationalDatabaseBundlesInput{} @@ -35,10 +37,11 @@ type GetRelationalDatabaseBundlesInput struct { // 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 - // page token, perform an initial GetRelationalDatabaseBundles 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetRelationalDatabaseBundles 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 @@ -49,10 +52,12 @@ type GetRelationalDatabaseBundlesOutput struct { // An object describing the result of your get relational database bundles request. Bundles []types.RelationalDatabaseBundle - // 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 GetRelationalDatabaseBundles request and - // specify the next page token using the pageToken parameter. + // 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 GetRelationalDatabaseBundles + // 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_GetRelationalDatabaseEvents.go b/service/lightsail/api_op_GetRelationalDatabaseEvents.go index 9455f6512b3..b50a7ccad2c 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseEvents.go +++ b/service/lightsail/api_op_GetRelationalDatabaseEvents.go @@ -35,14 +35,18 @@ type GetRelationalDatabaseEventsInput struct { 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). + // 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 - // page token, perform an initial GetRelationalDatabaseEvents 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetRelationalDatabaseEvents 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 @@ -50,10 +54,12 @@ type GetRelationalDatabaseEventsInput struct { 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. + // 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. 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 55334d92771..e0ed186a150 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go +++ b/service/lightsail/api_op_GetRelationalDatabaseLogEvents.go @@ -30,8 +30,10 @@ func (c *Client) GetRelationalDatabaseLogEvents(ctx context.Context, params *Get type GetRelationalDatabaseLogEventsInput struct { - // The name of the log stream. Use the get relational database log streams - // operation to get a list of available log streams. + // The name of the log stream. + // + // Use the get relational database log streams operation to get a list of + // available log streams. // // This member is required. LogStreamName *string @@ -41,14 +43,20 @@ type GetRelationalDatabaseLogEventsInput struct { // This member is required. RelationalDatabaseName *string - // The end of the time interval from which to get log events. Constraints: + // 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 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. + // // To get a page token, perform an initial GetRelationalDatabaseLogEvents request. // If your results are paginated, the response will return a next forward token // and/or next backward token that you can specify as the page token in a @@ -57,15 +65,21 @@ type GetRelationalDatabaseLogEventsInput struct { // 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 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: + // 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 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 461fa2bbd38..e112b781539 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go +++ b/service/lightsail/api_op_GetRelationalDatabaseMasterUserPassword.go @@ -13,9 +13,11 @@ import ( ) // Returns the current, previous, or pending versions of the master user password -// for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation -// supports tag-based access control via resource tags applied to the resource -// identified by relationalDatabaseName. +// for a Lightsail database. +// +// The GetRelationalDatabaseMasterUserPassword operation supports tag-based access +// control via resource tags applied to the resource identified by +// relationalDatabaseName. func (c *Client) GetRelationalDatabaseMasterUserPassword(ctx context.Context, params *GetRelationalDatabaseMasterUserPasswordInput, optFns ...func(*Options)) (*GetRelationalDatabaseMasterUserPasswordOutput, error) { if params == nil { params = &GetRelationalDatabaseMasterUserPasswordInput{} @@ -38,10 +40,13 @@ type GetRelationalDatabaseMasterUserPasswordInput struct { // This member is required. RelationalDatabaseName *string - // 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. + // 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. + // // Default: CURRENT PasswordVersion types.RelationalDatabasePasswordVersion diff --git a/service/lightsail/api_op_GetRelationalDatabaseMetricData.go b/service/lightsail/api_op_GetRelationalDatabaseMetricData.go index 89c62b1c922..004f79a2522 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseMetricData.go +++ b/service/lightsail/api_op_GetRelationalDatabaseMetricData.go @@ -13,9 +13,11 @@ import ( ) // Returns the data points of the specified metric for a database in Amazon -// Lightsail. Metrics report the utilization of your resources, and the error -// counts generated by them. Monitor and collect metric data regularly to maintain -// the reliability, availability, and performance of your resources. +// Lightsail. +// +// Metrics report the utilization of your resources, and the error counts +// generated by them. Monitor and collect metric data regularly to maintain the +// reliability, availability, and performance of your resources. func (c *Client) GetRelationalDatabaseMetricData(ctx context.Context, params *GetRelationalDatabaseMetricDataInput, optFns ...func(*Options)) (*GetRelationalDatabaseMetricDataOutput, error) { if params == nil { params = &GetRelationalDatabaseMetricDataInput{} @@ -33,44 +35,76 @@ 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: + // 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 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 - // The metric for which you want to return information. Valid relational database - // 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. + // The metric for which you want to return information. + // + // Valid relational database 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 . + // 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 . + // 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 . + // 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 . + // monitoring and replication. + // + // Statistics : The most useful statistic is Average . + // + // Unit : The published unit is Bytes/Second . // // This member is required. MetricName types.RelationalDatabaseMetricName - // The granularity, in seconds, of the returned data points. All relational - // database metric data is available in 1-minute (60 seconds) granularity. + // The granularity, in seconds, of the returned data points. + // + // All relational database metric data is available in 1-minute (60 seconds) + // granularity. // // This member is required. Period *int32 @@ -80,27 +114,39 @@ type GetRelationalDatabaseMetricDataInput struct { // This member is required. RelationalDatabaseName *string - // The start of the time interval from which to get metric data. Constraints: + // 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 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: + // 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. // diff --git a/service/lightsail/api_op_GetRelationalDatabaseParameters.go b/service/lightsail/api_op_GetRelationalDatabaseParameters.go index 9af46d72ccf..279519cca19 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseParameters.go +++ b/service/lightsail/api_op_GetRelationalDatabaseParameters.go @@ -12,10 +12,12 @@ import ( ) // Returns all of the runtime parameters offered by the underlying database -// software, or engine, for a specific database in Amazon Lightsail. In addition to -// the parameter names and values, this operation returns other information about -// each parameter. This information includes whether changes require a reboot, -// whether the parameter is modifiable, the allowed values, and the data types. +// software, or engine, for a specific database in Amazon Lightsail. +// +// In addition to the parameter names and values, this operation returns other +// information about each parameter. This information includes whether changes +// require a reboot, whether the parameter is modifiable, the allowed values, and +// the data types. func (c *Client) GetRelationalDatabaseParameters(ctx context.Context, params *GetRelationalDatabaseParametersInput, optFns ...func(*Options)) (*GetRelationalDatabaseParametersOutput, error) { if params == nil { params = &GetRelationalDatabaseParametersInput{} @@ -38,10 +40,11 @@ type GetRelationalDatabaseParametersInput struct { // This member is required. RelationalDatabaseName *string - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetRelationalDatabaseParameters 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetRelationalDatabaseParameters + // 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 @@ -49,10 +52,12 @@ type GetRelationalDatabaseParametersInput struct { type GetRelationalDatabaseParametersOutput 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 GetRelationalDatabaseParameters request and - // specify the next page token using the pageToken parameter. + // 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 GetRelationalDatabaseParameters + // request and specify the next page token using the pageToken parameter. NextPageToken *string // An object describing the result of your get relational database parameters diff --git a/service/lightsail/api_op_GetRelationalDatabaseSnapshots.go b/service/lightsail/api_op_GetRelationalDatabaseSnapshots.go index fc03d9bb264..4ede9768d58 100644 --- a/service/lightsail/api_op_GetRelationalDatabaseSnapshots.go +++ b/service/lightsail/api_op_GetRelationalDatabaseSnapshots.go @@ -29,10 +29,11 @@ func (c *Client) GetRelationalDatabaseSnapshots(ctx context.Context, params *Get type GetRelationalDatabaseSnapshotsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetRelationalDatabaseSnapshots 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetRelationalDatabaseSnapshots 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,10 +41,12 @@ type GetRelationalDatabaseSnapshotsInput struct { type GetRelationalDatabaseSnapshotsOutput 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 GetRelationalDatabaseSnapshots request and - // specify the next page token using the pageToken parameter. + // 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 GetRelationalDatabaseSnapshots + // request and specify the next page token using the pageToken parameter. NextPageToken *string // An object describing the result of your get relational database snapshots diff --git a/service/lightsail/api_op_GetRelationalDatabases.go b/service/lightsail/api_op_GetRelationalDatabases.go index 06da1eaa838..fe0521b3c40 100644 --- a/service/lightsail/api_op_GetRelationalDatabases.go +++ b/service/lightsail/api_op_GetRelationalDatabases.go @@ -29,10 +29,11 @@ func (c *Client) GetRelationalDatabases(ctx context.Context, params *GetRelation type GetRelationalDatabasesInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetRelationalDatabases 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetRelationalDatabases 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,10 +41,12 @@ type GetRelationalDatabasesInput struct { type GetRelationalDatabasesOutput 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 GetRelationalDatabases request and specify the - // next page token using the pageToken parameter. + // 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 GetRelationalDatabases request + // and specify the next page token using the pageToken parameter. NextPageToken *string // An object describing the result of your get relational databases request. diff --git a/service/lightsail/api_op_GetSetupHistory.go b/service/lightsail/api_op_GetSetupHistory.go index 2b4159b4a6c..a2e5f139424 100644 --- a/service/lightsail/api_op_GetSetupHistory.go +++ b/service/lightsail/api_op_GetSetupHistory.go @@ -35,10 +35,11 @@ type GetSetupHistoryInput struct { // This member is required. ResourceName *string - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetSetupHistory 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetSetupHistory 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 @@ -46,10 +47,12 @@ type GetSetupHistoryInput struct { type GetSetupHistoryOutput 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 GetSetupHistory request and specify the next - // page token using the pageToken parameter. + // 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 GetSetupHistory request and + // specify the next page token using the pageToken parameter. NextPageToken *string // The historical information that's returned. diff --git a/service/lightsail/api_op_GetStaticIps.go b/service/lightsail/api_op_GetStaticIps.go index d31d19d9b3d..a65202322d0 100644 --- a/service/lightsail/api_op_GetStaticIps.go +++ b/service/lightsail/api_op_GetStaticIps.go @@ -29,10 +29,11 @@ func (c *Client) GetStaticIps(ctx context.Context, params *GetStaticIpsInput, op type GetStaticIpsInput struct { - // The token to advance to the next page of results from your request. To get a - // page token, perform an initial GetStaticIps 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. + // The token to advance to the next page of results from your request. + // + // To get a page token, perform an initial GetStaticIps 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,10 +41,12 @@ type GetStaticIpsInput struct { type GetStaticIpsOutput 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 GetStaticIps request and specify the next page - // token using the pageToken parameter. + // 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 GetStaticIps request and + // specify the next page token using the pageToken parameter. NextPageToken *string // An array of key-value pairs containing information about your get static IPs diff --git a/service/lightsail/api_op_OpenInstancePublicPorts.go b/service/lightsail/api_op_OpenInstancePublicPorts.go index d0ab6d24084..05ec989a45c 100644 --- a/service/lightsail/api_op_OpenInstancePublicPorts.go +++ b/service/lightsail/api_op_OpenInstancePublicPorts.go @@ -13,10 +13,13 @@ 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) -// . +// 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]. +// +// [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 43322758a28..80ef7df573d 100644 --- a/service/lightsail/api_op_PutAlarm.go +++ b/service/lightsail/api_op_PutAlarm.go @@ -11,17 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates an alarm, and associates it with the specified metric. An -// alarm is used to monitor a single metric for one of your resources. When a +// Creates or updates an alarm, and associates it with the specified metric. +// +// 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) -// . When this action creates an alarm, the alarm state is immediately set to +// see [Alarms in Amazon Lightsail]. +// +// 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 +// 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 // evaluated with the updated configuration. +// +// [Alarms in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms func (c *Client) PutAlarm(ctx context.Context, params *PutAlarmInput, optFns ...func(*Options)) (*PutAlarmOutput, error) { if params == nil { params = &PutAlarmInput{} @@ -53,39 +58,51 @@ type PutAlarmInput struct { // 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 - // 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 - // period of 24 to evaluate a metric over a rolling period of two hours. You can - // specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation - // period of 288 (24 hours). + // 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 + // period of 24 to evaluate a metric over a rolling period of two hours. + // + // You can specify a minimum valuation period of 1 (5 minutes), and a maximum + // evaluation period of 288 (24 hours). // // This member is required. 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: + // 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) - // . + // , FreeStorageSpace , NetworkReceiveThroughput , and NetworkTransmitThroughput . + // + // For more information about these metrics, see [Metrics available in Lightsail]. + // + // [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 - // The name of the Lightsail resource that will be monitored. Instances, load - // balancers, and relational databases are the only Lightsail resources that can - // currently be monitored by alarms. + // The name of the Lightsail resource that will be monitored. + // + // Instances, load balancers, and relational databases are the only Lightsail + // resources that can currently be monitored by alarms. // // This member is required. MonitoredResourceName *string @@ -96,13 +113,18 @@ type PutAlarmInput struct { 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 - // notification is not sent if a contact protocol is not specified, if the + // 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 @@ -110,37 +132,51 @@ type PutAlarmInput struct { // datapointsToAlarm ) is the M. DatapointsToAlarm *int32 - // Indicates whether the alarm is enabled. Notifications are enabled by default if - // you don't specify this parameter. + // Indicates whether the alarm is enabled. + // + // Notifications are enabled by default if you don't specify this parameter. NotificationEnabled *bool - // The alarm states that trigger a notification. An alarm has the following - // possible states: + // 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. + // 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: + // 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. TreatMissingData types.TreatMissingData diff --git a/service/lightsail/api_op_PutInstancePublicPorts.go b/service/lightsail/api_op_PutInstancePublicPorts.go index be97d0f29d4..93d8e2dc364 100644 --- a/service/lightsail/api_op_PutInstancePublicPorts.go +++ b/service/lightsail/api_op_PutInstancePublicPorts.go @@ -16,11 +16,13 @@ import ( // 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 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) -// . +// 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]. +// +// [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 9ad5b3feedc..fd60b40ed37 100644 --- a/service/lightsail/api_op_RebootInstance.go +++ b/service/lightsail/api_op_RebootInstance.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 e9021a0afaa..45dcc177c3b 100644 --- a/service/lightsail/api_op_RebootRelationalDatabase.go +++ b/service/lightsail/api_op_RebootRelationalDatabase.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 7224f82e9d1..d22fb9921ea 100644 --- a/service/lightsail/api_op_RegisterContainerImage.go +++ b/service/lightsail/api_op_RegisterContainerImage.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a container image to your Amazon Lightsail container service. This -// action is not required if you install and use the Lightsail Control +// 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) -// in the Amazon Lightsail Developer Guide. +// service. For more information, see [Pushing and managing container images on your Amazon Lightsail container services]in the Amazon Lightsail Developer Guide. +// +// [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 func (c *Client) RegisterContainerImage(ctx context.Context, params *RegisterContainerImageInput, optFns ...func(*Options)) (*RegisterContainerImageOutput, error) { if params == nil { params = &RegisterContainerImageInput{} @@ -39,20 +40,26 @@ 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: + // 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. + // 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. // // This member is required. Label *string diff --git a/service/lightsail/api_op_ResetDistributionCache.go b/service/lightsail/api_op_ResetDistributionCache.go index e8100ea0a99..791854033fb 100644 --- a/service/lightsail/api_op_ResetDistributionCache.go +++ b/service/lightsail/api_op_ResetDistributionCache.go @@ -13,8 +13,10 @@ import ( ) // Deletes currently cached content from your Amazon Lightsail content delivery -// network (CDN) distribution. After resetting the cache, the next time a content -// request is made, your distribution pulls, serves, and caches it from the origin. +// network (CDN) distribution. +// +// After resetting the cache, the next time a content request is made, your +// distribution pulls, serves, and caches it from the origin. func (c *Client) ResetDistributionCache(ctx context.Context, params *ResetDistributionCacheInput, optFns ...func(*Options)) (*ResetDistributionCacheOutput, error) { if params == nil { params = &ResetDistributionCacheInput{} @@ -32,8 +34,10 @@ func (c *Client) ResetDistributionCache(ctx context.Context, params *ResetDistri type ResetDistributionCacheInput struct { - // The name of the distribution for which to reset cache. Use the GetDistributions - // action to get a list of distribution names that you can specify. + // The name of the distribution for which to reset cache. + // + // 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_SendContactMethodVerification.go b/service/lightsail/api_op_SendContactMethodVerification.go index 14b4bfa100e..e3918c2a557 100644 --- a/service/lightsail/api_op_SendContactMethodVerification.go +++ b/service/lightsail/api_op_SendContactMethodVerification.go @@ -12,16 +12,22 @@ import ( ) // Sends a verification request to an email contact method to ensure it's owned by -// the requester. SMS contact methods don't need to be verified. 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) -// . A verification request is sent to the contact method when you initially create +// the requester. SMS contact methods don't need to be verified. +// +// 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]. +// +// 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. +// 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. +// +// [Notifications in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications func (c *Client) SendContactMethodVerification(ctx context.Context, params *SendContactMethodVerificationInput, optFns ...func(*Options)) (*SendContactMethodVerificationOutput, error) { if params == nil { params = &SendContactMethodVerificationInput{} diff --git a/service/lightsail/api_op_SetIpAddressType.go b/service/lightsail/api_op_SetIpAddressType.go index ec02d9c71d7..9cd0289b9a6 100644 --- a/service/lightsail/api_op_SetIpAddressType.go +++ b/service/lightsail/api_op_SetIpAddressType.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the IP address type for an Amazon Lightsail resource. Use this action to -// enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified -// resource. Alternately, you can use this action to disable dual-stack, and enable -// IPv4 only. +// Sets the IP address type for an Amazon Lightsail resource. +// +// Use this action to enable dual-stack for a resource, which enables IPv4 and +// IPv6 for the specified resource. Alternately, you can use this action to disable +// dual-stack, and enable IPv4 only. func (c *Client) SetIpAddressType(ctx context.Context, params *SetIpAddressTypeInput, optFns ...func(*Options)) (*SetIpAddressTypeOutput, error) { if params == nil { params = &SetIpAddressTypeInput{} @@ -32,8 +33,9 @@ func (c *Client) SetIpAddressType(ctx context.Context, params *SetIpAddressTypeI type SetIpAddressTypeInput struct { - // The IP address type to set for the specified resource. The possible values are - // ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. + // The IP address type to set for the specified resource. + // + // The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. // // This member is required. IpAddressType types.IpAddressType @@ -43,10 +45,13 @@ type SetIpAddressTypeInput struct { // This member is required. ResourceName *string - // The resource type. The resource 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. + // The resource type. + // + // The resource 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. ResourceType types.ResourceType diff --git a/service/lightsail/api_op_SetResourceAccessForBucket.go b/service/lightsail/api_op_SetResourceAccessForBucket.go index c8fb0690daf..06adf2a5d3b 100644 --- a/service/lightsail/api_op_SetResourceAccessForBucket.go +++ b/service/lightsail/api_op_SetResourceAccessForBucket.go @@ -12,8 +12,10 @@ import ( ) // Sets the Amazon Lightsail resources that can access the specified Lightsail -// bucket. Lightsail buckets currently support setting access for Lightsail -// instances in the same Amazon Web Services Region. +// bucket. +// +// Lightsail buckets currently support setting access for Lightsail instances in +// the same Amazon Web Services Region. func (c *Client) SetResourceAccessForBucket(ctx context.Context, params *SetResourceAccessForBucketInput, optFns ...func(*Options)) (*SetResourceAccessForBucketOutput, error) { if params == nil { params = &SetResourceAccessForBucketInput{} @@ -31,8 +33,12 @@ func (c *Client) SetResourceAccessForBucket(ctx context.Context, params *SetReso type SetResourceAccessForBucketInput struct { - // The access setting. The following access settings are available: + // 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 . // diff --git a/service/lightsail/api_op_SetupInstanceHttps.go b/service/lightsail/api_op_SetupInstanceHttps.go index ac705eb5847..94f8634dcec 100644 --- a/service/lightsail/api_op_SetupInstanceHttps.go +++ b/service/lightsail/api_op_SetupInstanceHttps.go @@ -12,9 +12,10 @@ import ( ) // Creates an SSL/TLS certificate that secures traffic for your website. After the -// certificate is created, it is installed on the specified Lightsail instance. If -// you provide more than one domain name in the request, at least one name must be -// less than or equal to 63 characters in length. +// certificate is created, it is installed on the specified Lightsail instance. +// +// If you provide more than one domain name in the request, at least one name must +// be less than or equal to 63 characters in length. func (c *Client) SetupInstanceHttps(ctx context.Context, params *SetupInstanceHttpsInput, optFns ...func(*Options)) (*SetupInstanceHttpsOutput, error) { if params == nil { params = &SetupInstanceHttpsInput{} diff --git a/service/lightsail/api_op_StartInstance.go b/service/lightsail/api_op_StartInstance.go index 9c59ca7c7a9..294a7adae25 100644 --- a/service/lightsail/api_op_StartInstance.go +++ b/service/lightsail/api_op_StartInstance.go @@ -12,15 +12,18 @@ import ( ) // Starts a specific Amazon Lightsail instance from a stopped state. To restart an -// instance, use the reboot instance operation. When you 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 start instance operation supports tag-based access control via resource +// instance, use the reboot instance operation. +// +// When you 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]. +// +// 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) -// . +// see the [Amazon Lightsail Developer Guide]. +// +// [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 dbbb0ea5431..61c497a5302 100644 --- a/service/lightsail/api_op_StartRelationalDatabase.go +++ b/service/lightsail/api_op_StartRelationalDatabase.go @@ -12,11 +12,13 @@ import ( ) // Starts a specific database from a stopped state in Amazon Lightsail. To restart -// 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) -// . +// 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]. +// +// [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 f5f536767a5..f496dbc118f 100644 --- a/service/lightsail/api_op_StopInstance.go +++ b/service/lightsail/api_op_StopInstance.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a specific Amazon Lightsail instance that is currently running. When you -// 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) -// . +// Stops a specific Amazon Lightsail instance that is currently running. +// +// When you 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]. +// +// 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]. +// +// [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,9 +46,11 @@ type StopInstanceInput struct { 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. + // 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 4660627ae25..86505194f6a 100644 --- a/service/lightsail/api_op_StopRelationalDatabase.go +++ b/service/lightsail/api_op_StopRelationalDatabase.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a specific database that is currently running in Amazon Lightsail. The -// stop relational database operation supports tag-based access control via +// 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]. +// +// [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 63b0be04710..1525be85a19 100644 --- a/service/lightsail/api_op_TagResource.go +++ b/service/lightsail/api_op_TagResource.go @@ -13,12 +13,13 @@ 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 +// Tag keys must be unique per resource. For more information about tags, see the [Amazon Lightsail Developer Guide]. +// +// 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) -// . +// information, see the [Amazon Lightsail Developer Guide]. +// +// [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 96f914856cf..5dc4673f7f9 100644 --- a/service/lightsail/api_op_TestAlarm.go +++ b/service/lightsail/api_op_TestAlarm.go @@ -14,11 +14,14 @@ 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 -// 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) -// . +// 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]. +// +// [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{} @@ -41,11 +44,15 @@ type TestAlarmInput struct { // This member is required. AlarmName *string - // The alarm state to test. An alarm has the following possible states that can be - // tested: + // 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. // // This member is required. diff --git a/service/lightsail/api_op_UntagResource.go b/service/lightsail/api_op_UntagResource.go index c7f65a91986..be72e4a47b7 100644 --- a/service/lightsail/api_op_UntagResource.go +++ b/service/lightsail/api_op_UntagResource.go @@ -12,11 +12,13 @@ import ( ) // 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) -// . +// 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]. +// +// [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 baf6fa1075e..706c350a455 100644 --- a/service/lightsail/api_op_UpdateBucket.go +++ b/service/lightsail/api_op_UpdateBucket.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an existing Amazon Lightsail bucket. Use this action to update the -// configuration of an existing bucket, such as versioning, public accessibility, -// and the Amazon Web Services accounts that can access the bucket. +// Updates an existing Amazon Lightsail bucket. +// +// Use this action to update the configuration of an existing bucket, such as +// versioning, public accessibility, and the Amazon Web Services accounts that can +// access the bucket. func (c *Client) UpdateBucket(ctx context.Context, params *UpdateBucketInput, optFns ...func(*Options)) (*UpdateBucketOutput, error) { if params == nil { params = &UpdateBucketInput{} @@ -43,13 +45,17 @@ type UpdateBucketInput struct { AccessRules *types.AccessRules // An array of strings to specify the Amazon Web Services account IDs that can - // access the bucket. You can give a maximum of 10 Amazon Web Services accounts - // access to a bucket. + // access the bucket. + // + // You can give a maximum of 10 Amazon Web Services accounts access to a bucket. ReadonlyAccessAccounts []string - // Specifies whether to enable or suspend versioning of objects in the bucket. The - // following options can be specified: + // 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. Versioning *string diff --git a/service/lightsail/api_op_UpdateBucketBundle.go b/service/lightsail/api_op_UpdateBucketBundle.go index 1885623984c..a19750c3801 100644 --- a/service/lightsail/api_op_UpdateBucketBundle.go +++ b/service/lightsail/api_op_UpdateBucketBundle.go @@ -11,20 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A -// 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) -// 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 -// bucket's usage is consistently in the lower range of its storage space or data -// transfer quota. Due to the unpredictable usage fluctuations that a bucket might -// experience, we strongly recommend that you update a bucket's bundle only as a -// long-term strategy, instead of as a short-term, monthly cost-cutting measure. -// Choose a bucket bundle that will provide the bucket with ample storage space and -// data transfer for a long time to come. +// Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket. +// +// A 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]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 bucket's usage is consistently in the lower range +// of its storage space or data transfer quota. Due to the unpredictable usage +// fluctuations that a bucket might experience, we strongly recommend that you +// update a bucket's bundle only as a long-term strategy, instead of as a +// short-term, monthly cost-cutting measure. Choose a bucket bundle that will +// provide the bucket with ample storage space and data transfer for a long time to +// come. +// +// [GetBuckets]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html func (c *Client) UpdateBucketBundle(ctx context.Context, params *UpdateBucketBundleInput, optFns ...func(*Options)) (*UpdateBucketBundleOutput, error) { if params == nil { params = &UpdateBucketBundleInput{} @@ -47,8 +51,11 @@ 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) - // action to get a list of bundle IDs that you can specify. + // The ID of the new bundle to apply to the bucket. + // + // Use the [GetBucketBundles] action to get a list of bundle IDs that you can specify. + // + // [GetBucketBundles]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html // // This member is required. BundleId *string diff --git a/service/lightsail/api_op_UpdateContainerService.go b/service/lightsail/api_op_UpdateContainerService.go index 0c5f6349224..072fb000bd1 100644 --- a/service/lightsail/api_op_UpdateContainerService.go +++ b/service/lightsail/api_op_UpdateContainerService.go @@ -38,38 +38,52 @@ type UpdateContainerServiceInput struct { // A Boolean value to indicate whether the container service is disabled. IsDisabled *bool - // The power for the container service. The power specifies the 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 view the specifications of each power option. + // The power for the container service. + // + // The power specifies the 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 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) - // in the Amazon Lightsail Developer Guide. + // (Amazon ECR) private repositories. + // + // For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service] in the Amazon Lightsail Developer Guide. + // + // [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 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 - // 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 the container service. You must create and validate an SSL/TLS - // certificate before you can use public domain names with your container service. - // Use the CreateCertificate action to create a certificate for the public domain - // names you want to use with your container service. You can specify public domain - // names using a string to array map as shown in the example later on this page. + // 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 domain + // of the container service. + // + // You must create and validate an SSL/TLS certificate before you can use public + // domain names with your container service. Use the CreateCertificate action to + // create a certificate for the public domain names you want to use with your + // container service. + // + // You can specify public domain names using a string to array map as shown in the + // example later on this page. 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. + // 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. Scale *int32 noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateDistribution.go b/service/lightsail/api_op_UpdateDistribution.go index 0f7ae0d602a..b0d0596da98 100644 --- a/service/lightsail/api_op_UpdateDistribution.go +++ b/service/lightsail/api_op_UpdateDistribution.go @@ -12,8 +12,9 @@ import ( ) // Updates an existing Amazon Lightsail content delivery network (CDN) -// distribution. Use this action to update the configuration of your existing // distribution. +// +// Use this action to update the configuration of your existing distribution. func (c *Client) UpdateDistribution(ctx context.Context, params *UpdateDistributionInput, optFns ...func(*Options)) (*UpdateDistributionOutput, error) { if params == nil { params = &UpdateDistributionInput{} @@ -31,25 +32,31 @@ 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 - // An object that describes the cache behavior settings for the distribution. The - // cacheBehaviorSettings specified in your UpdateDistributionRequest will replace - // your distribution's existing settings. + // An object that describes the cache behavior settings for the distribution. + // + // The cacheBehaviorSettings specified in your UpdateDistributionRequest will + // replace your distribution's existing settings. CacheBehaviorSettings *types.CacheSettings // An array of objects that describe the per-path cache behavior for the // distribution. CacheBehaviors []types.CacheBehaviorPerPath - // The name of the SSL/TLS certificate that you want to attach to the - // distribution. Only certificates with a status of ISSUED can be attached to a - // distribution. Use the GetCertificates (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetCertificates.html) - // action to get a list of certificate names that you can specify. + // The name of the SSL/TLS certificate that you want to attach to the distribution. + // + // Only certificates with a status of ISSUED can be attached to a distribution. + // + // Use the [GetCertificates] action to get a list of certificate names that you can specify. + // + // [GetCertificates]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetCertificates.html CertificateName *string // An object that describes the default cache behavior for the distribution. @@ -59,14 +66,16 @@ type UpdateDistributionInput struct { IsEnabled *bool // An object that describes the origin resource for the distribution, such as a - // Lightsail instance, bucket, or load balancer. The distribution pulls, caches, - // and serves content from the origin. + // Lightsail instance, bucket, or load balancer. + // + // The distribution pulls, caches, and serves content from the origin. Origin *types.InputOrigin // Indicates whether the default SSL/TLS certificate is attached to the // distribution. The default value is true . When true , the distribution uses the - // default domain name such as d111111abcdef8.cloudfront.net . Set this value to - // false to attach a new certificate to the distribution. + // default domain name such as d111111abcdef8.cloudfront.net . + // + // Set this value to false to attach a new certificate to the distribution. UseDefaultCertificate *bool // Use this parameter to update the minimum TLS protocol version for the SSL/TLS diff --git a/service/lightsail/api_op_UpdateDistributionBundle.go b/service/lightsail/api_op_UpdateDistributionBundle.go index 008a8666ee9..0034938d6cd 100644 --- a/service/lightsail/api_op_UpdateDistributionBundle.go +++ b/service/lightsail/api_op_UpdateDistributionBundle.go @@ -12,14 +12,19 @@ import ( ) // Updates the bundle of your Amazon Lightsail content delivery network (CDN) -// distribution. A distribution bundle specifies the monthly network transfer quota -// and monthly cost of your distribution. Update your distribution's bundle if your -// distribution is going over its monthly network transfer quota and is incurring -// an overage fee. You can update your distribution's bundle only one time within -// your monthly Amazon Web Services billing cycle. To determine if you can update -// your distribution's bundle, use the GetDistributions action. The -// ableToUpdateBundle parameter in the result will indicate whether you can -// currently update your distribution's bundle. +// distribution. +// +// A distribution bundle specifies the monthly network transfer quota and monthly +// cost of your distribution. +// +// Update your distribution's bundle if your distribution is going over its +// monthly network transfer quota and is incurring an overage fee. +// +// You can update your distribution's bundle only one time within your monthly +// Amazon Web Services billing cycle. To determine if you can update your +// distribution's bundle, use the GetDistributions action. The ableToUpdateBundle +// parameter in the result will indicate whether you can currently update your +// distribution's bundle. func (c *Client) UpdateDistributionBundle(ctx context.Context, params *UpdateDistributionBundleInput, optFns ...func(*Options)) (*UpdateDistributionBundleOutput, error) { if params == nil { params = &UpdateDistributionBundleInput{} @@ -37,13 +42,16 @@ func (c *Client) UpdateDistributionBundle(ctx context.Context, params *UpdateDis type UpdateDistributionBundleInput struct { - // The bundle ID of the new bundle to apply to your distribution. Use the - // GetDistributionBundles action to get a list of distribution bundle IDs that you - // can specify. + // The bundle ID of the new bundle to apply to your distribution. + // + // Use the GetDistributionBundles action to get a list of distribution bundle IDs + // that you can specify. 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. + // 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. DistributionName *string noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateDomainEntry.go b/service/lightsail/api_op_UpdateDomainEntry.go index 7faa0afa62a..62f6138dac2 100644 --- a/service/lightsail/api_op_UpdateDomainEntry.go +++ b/service/lightsail/api_op_UpdateDomainEntry.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 c7e6dcc67a2..e187fc8c381 100644 --- a/service/lightsail/api_op_UpdateInstanceMetadataOptions.go +++ b/service/lightsail/api_op_UpdateInstanceMetadataOptions.go @@ -16,8 +16,9 @@ import ( // 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) -// in the Amazon Lightsail Developer Guide. +// more information, see [Use IMDSv2 with an Amazon Lightsail instance]in the Amazon Lightsail Developer Guide. +// +// [Use IMDSv2 with an Amazon Lightsail instance]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-instance-metadata-service func (c *Client) UpdateInstanceMetadataOptions(ctx context.Context, params *UpdateInstanceMetadataOptionsInput, optFns ...func(*Options)) (*UpdateInstanceMetadataOptionsOutput, error) { if params == nil { params = &UpdateInstanceMetadataOptionsInput{} @@ -41,14 +42,16 @@ type UpdateInstanceMetadataOptionsInput struct { InstanceName *string // 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. + // parameter is not specified, the existing state is maintained. + // + // If you specify a 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 ). + // 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 ). HttpProtocolIpv6 types.HttpProtocolIpv6 // The desired HTTP PUT response hop limit for instance metadata requests. A @@ -57,15 +60,18 @@ type UpdateInstanceMetadataOptionsInput 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 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 - // credentials are not available. + // 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 credentials are not + // available. HttpTokens types.HttpTokens noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateLoadBalancerAttribute.go b/service/lightsail/api_op_UpdateLoadBalancerAttribute.go index 8b98d56e201..aa946a6f462 100644 --- a/service/lightsail/api_op_UpdateLoadBalancerAttribute.go +++ b/service/lightsail/api_op_UpdateLoadBalancerAttribute.go @@ -12,11 +12,13 @@ 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) -// . +// 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]. +// +// [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{} @@ -39,25 +41,33 @@ type UpdateLoadBalancerAttributeInput struct { // This member is required. AttributeName types.LoadBalancerAttributeName - // 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: + // 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. + // the attributeValue request parameter must be the name of the TLS policy. + // + // Use the [GetLoadBalancerTlsPolicies]action to get a list of TLS policy names that you can specify. + // + // [GetLoadBalancerTlsPolicies]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html // // This member is required. AttributeValue *string diff --git a/service/lightsail/api_op_UpdateRelationalDatabase.go b/service/lightsail/api_op_UpdateRelationalDatabase.go index 28c97b860e3..01f643ef46a 100644 --- a/service/lightsail/api_op_UpdateRelationalDatabase.go +++ b/service/lightsail/api_op_UpdateRelationalDatabase.go @@ -12,12 +12,15 @@ import ( ) // Allows the update of one or more attributes of a database in Amazon Lightsail. +// // Updates are applied immediately, or in cases where the updates could result in -// an outage, are applied during the database's predefined maintenance window. The -// update relational database operation supports tag-based access control via +// 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]. +// +// [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{} @@ -41,44 +44,74 @@ type UpdateRelationalDatabaseInput struct { RelationalDatabaseName *string // When true , applies changes immediately. When false , applies changes during the - // preferred maintenance window. Some changes may cause an outage. Default: false + // 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 - // 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. + // 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 - // applied during the next maintenance window because this can result in an outage. + // 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 // The password for the master user. The password can include any printable ASCII - // character except "/", """, or "@". MySQL Constraints: Must contain from 8 to 41 - // characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. + // character except "/", """, or "@". + // + // MySQL + // + // Constraints: Must contain from 8 to 41 characters. + // + // PostgreSQL + // + // Constraints: Must contain from 8 to 128 characters. MasterUserPassword *string // 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 + // 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. 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: + // 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 PreferredMaintenanceWindow *string @@ -89,14 +122,18 @@ type UpdateRelationalDatabaseInput struct { PubliclyAccessible *bool // This parameter is used to update the major version of the database. Enter the - // blueprintId for the major version that you want to update to. Use the - // GetRelationalDatabaseBlueprints (https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRelationalDatabaseBlueprints.html) - // action to get a list of available blueprint IDs. + // blueprintId for the major version that you want to update to. + // + // Use the [GetRelationalDatabaseBlueprints] action to get a list of available blueprint IDs. + // + // [GetRelationalDatabaseBlueprints]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRelationalDatabaseBlueprints.html RelationalDatabaseBlueprintId *string // 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. + // generated by Lightsail. + // + // Use the get relational database master user password operation to get the new + // password. RotateMasterUserPassword *bool noSmithyDocumentSerde diff --git a/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go b/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go index 5893f798a99..f68c74e8958 100644 --- a/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go +++ b/service/lightsail/api_op_UpdateRelationalDatabaseParameters.go @@ -12,16 +12,19 @@ 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) -// . +// 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]. +// +// [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 cdbfd6bbe84..7db87ac80ab 100644 --- a/service/lightsail/doc.go +++ b/service/lightsail/doc.go @@ -10,12 +10,17 @@ // managed databases, SSD-based block storage, static IP addresses, load balancers, // content delivery network (CDN) distributions, DNS management of registered // 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. +// 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]. +// +// 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]in the Amazon Web Services General Reference. +// +// [Amazon Lightsail Endpoints and Quotas]: https://docs.aws.amazon.com/general/latest/gr/lightsail.html +// [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 package lightsail diff --git a/service/lightsail/options.go b/service/lightsail/options.go index ec95be44fc2..b579f150c15 100644 --- a/service/lightsail/options.go +++ b/service/lightsail/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lightsail/types/enums.go b/service/lightsail/types/enums.go index b11b5a517ff..980890ecf8d 100644 --- a/service/lightsail/types/enums.go +++ b/service/lightsail/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessDirection) Values() []AccessDirection { return []AccessDirection{ "inbound", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AccessType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessType) Values() []AccessType { return []AccessType{ "public", @@ -50,6 +52,7 @@ const ( // Values returns all known values for AccountLevelBpaSyncStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AccountLevelBpaSyncStatus) Values() []AccountLevelBpaSyncStatus { return []AccountLevelBpaSyncStatus{ @@ -69,8 +72,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for AlarmState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlarmState) Values() []AlarmState { return []AlarmState{ "OK", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for AppCategory. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppCategory) Values() []AppCategory { return []AppCategory{ "LfR", @@ -125,8 +131,9 @@ const ( ) // Values returns all known values for AutoMountStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMountStatus) Values() []AutoMountStatus { return []AutoMountStatus{ "Failed", @@ -147,8 +154,9 @@ const ( ) // Values returns all known values for AutoSnapshotStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoSnapshotStatus) Values() []AutoSnapshotStatus { return []AutoSnapshotStatus{ "Success", @@ -167,8 +175,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -185,8 +194,9 @@ const ( ) // Values returns all known values for BlueprintType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlueprintType) Values() []BlueprintType { return []BlueprintType{ "os", @@ -205,8 +215,9 @@ const ( ) // Values returns all known values for BPAStatusMessage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BPAStatusMessage) Values() []BPAStatusMessage { return []BPAStatusMessage{ "DEFAULTED_FOR_SLR_MISSING", @@ -225,8 +236,9 @@ const ( ) // Values returns all known values for BucketMetricName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketMetricName) Values() []BucketMetricName { return []BucketMetricName{ "BucketSizeBytes", @@ -245,8 +257,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateDomainValidationStatus) Values() []CertificateDomainValidationStatus { return []CertificateDomainValidationStatus{ "PENDING_VALIDATION", @@ -263,8 +276,9 @@ const ( ) // Values returns all known values for CertificateProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateProvider) Values() []CertificateProvider { return []CertificateProvider{ "LetsEncrypt", @@ -285,8 +299,9 @@ const ( ) // Values returns all known values for CertificateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateStatus) Values() []CertificateStatus { return []CertificateStatus{ "PENDING_VALIDATION", @@ -308,8 +323,9 @@ const ( // Values returns all known values for CloudFormationStackRecordSourceType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudFormationStackRecordSourceType) Values() []CloudFormationStackRecordSourceType { return []CloudFormationStackRecordSourceType{ "ExportSnapshotRecord", @@ -327,8 +343,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GreaterThanOrEqualToThreshold", @@ -348,8 +365,9 @@ const ( ) // Values returns all known values for ContactMethodStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactMethodStatus) Values() []ContactMethodStatus { return []ContactMethodStatus{ "PendingVerification", @@ -367,8 +385,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactMethodVerificationProtocol) Values() []ContactMethodVerificationProtocol { return []ContactMethodVerificationProtocol{ "Email", @@ -384,8 +403,9 @@ const ( ) // Values returns all known values for ContactProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactProtocol) Values() []ContactProtocol { return []ContactProtocol{ "Email", @@ -405,8 +425,9 @@ const ( // Values returns all known values for ContainerServiceDeploymentState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerServiceDeploymentState) Values() []ContainerServiceDeploymentState { return []ContainerServiceDeploymentState{ "ACTIVATING", @@ -426,6 +447,7 @@ const ( // Values returns all known values for ContainerServiceMetricName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContainerServiceMetricName) Values() []ContainerServiceMetricName { return []ContainerServiceMetricName{ @@ -448,6 +470,7 @@ const ( // Values returns all known values for ContainerServicePowerName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContainerServicePowerName) Values() []ContainerServicePowerName { return []ContainerServicePowerName{ @@ -472,6 +495,7 @@ const ( // 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{ @@ -496,8 +520,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PENDING", @@ -527,8 +552,9 @@ const ( // Values returns all known values for ContainerServiceStateDetailCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerServiceStateDetailCode) Values() []ContainerServiceStateDetailCode { return []ContainerServiceStateDetailCode{ "CREATING_SYSTEM_RESOURCES", @@ -551,8 +577,9 @@ const ( ) // Values returns all known values for Currency. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Currency) Values() []Currency { return []Currency{ "USD", @@ -570,8 +597,9 @@ const ( ) // Values returns all known values for DiskSnapshotState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiskSnapshotState) Values() []DiskSnapshotState { return []DiskSnapshotState{ "pending", @@ -593,8 +621,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -618,8 +647,9 @@ const ( ) // Values returns all known values for DistributionMetricName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DistributionMetricName) Values() []DistributionMetricName { return []DistributionMetricName{ "Requests", @@ -642,6 +672,7 @@ const ( // Values returns all known values for DnsRecordCreationStateCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DnsRecordCreationStateCode) Values() []DnsRecordCreationStateCode { return []DnsRecordCreationStateCode{ @@ -661,8 +692,9 @@ const ( // Values returns all known values for ExportSnapshotRecordSourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportSnapshotRecordSourceType) Values() []ExportSnapshotRecordSourceType { return []ExportSnapshotRecordSourceType{ "InstanceSnapshot", @@ -680,8 +712,9 @@ const ( ) // Values returns all known values for ForwardValues. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ForwardValues) Values() []ForwardValues { return []ForwardValues{ "none", @@ -712,8 +745,9 @@ const ( ) // Values returns all known values for HeaderEnum. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HeaderEnum) Values() []HeaderEnum { return []HeaderEnum{ "Accept", @@ -743,8 +777,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -761,8 +796,9 @@ const ( ) // Values returns all known values for HttpProtocolIpv6. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpProtocolIpv6) Values() []HttpProtocolIpv6 { return []HttpProtocolIpv6{ "disabled", @@ -779,8 +815,9 @@ const ( ) // Values returns all known values for HttpTokens. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpTokens) Values() []HttpTokens { return []HttpTokens{ "optional", @@ -797,8 +834,9 @@ const ( ) // Values returns all known values for InstanceAccessProtocol. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceAccessProtocol) Values() []InstanceAccessProtocol { return []InstanceAccessProtocol{ "ssh", @@ -824,8 +862,9 @@ const ( ) // Values returns all known values for InstanceHealthReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceHealthReason) Values() []InstanceHealthReason { return []InstanceHealthReason{ "Lb.RegistrationInProgress", @@ -855,8 +894,9 @@ const ( ) // Values returns all known values for InstanceHealthState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceHealthState) Values() []InstanceHealthState { return []InstanceHealthState{ "initial", @@ -877,8 +917,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "pending", @@ -902,8 +943,9 @@ const ( ) // Values returns all known values for InstanceMetricName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceMetricName) Values() []InstanceMetricName { return []InstanceMetricName{ "CPUUtilization", @@ -927,8 +969,9 @@ const ( ) // Values returns all known values for InstancePlatform. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstancePlatform) Values() []InstancePlatform { return []InstancePlatform{ "LINUX_UNIX", @@ -946,8 +989,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "pending", @@ -965,8 +1009,9 @@ const ( ) // Values returns all known values for IpAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressType) Values() []IpAddressType { return []IpAddressType{ "dualstack", @@ -987,6 +1032,7 @@ const ( // Values returns all known values for LoadBalancerAttributeName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerAttributeName) Values() []LoadBalancerAttributeName { return []LoadBalancerAttributeName{ @@ -1017,8 +1063,9 @@ const ( ) // Values returns all known values for LoadBalancerMetricName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerMetricName) Values() []LoadBalancerMetricName { return []LoadBalancerMetricName{ "ClientTLSNegotiationErrorCount", @@ -1045,8 +1092,9 @@ const ( ) // Values returns all known values for LoadBalancerProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerProtocol) Values() []LoadBalancerProtocol { return []LoadBalancerProtocol{ "HTTP_HTTPS", @@ -1066,8 +1114,9 @@ const ( ) // Values returns all known values for LoadBalancerState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerState) Values() []LoadBalancerState { return []LoadBalancerState{ "active", @@ -1089,8 +1138,9 @@ const ( // Values returns all known values for // LoadBalancerTlsCertificateDnsRecordCreationStateCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTlsCertificateDnsRecordCreationStateCode) Values() []LoadBalancerTlsCertificateDnsRecordCreationStateCode { return []LoadBalancerTlsCertificateDnsRecordCreationStateCode{ "SUCCEEDED", @@ -1110,8 +1160,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTlsCertificateDomainStatus) Values() []LoadBalancerTlsCertificateDomainStatus { return []LoadBalancerTlsCertificateDomainStatus{ "PENDING_VALIDATION", @@ -1133,8 +1184,9 @@ const ( // Values returns all known values for LoadBalancerTlsCertificateFailureReason. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTlsCertificateFailureReason) Values() []LoadBalancerTlsCertificateFailureReason { return []LoadBalancerTlsCertificateFailureReason{ "NO_AVAILABLE_CONTACTS", @@ -1157,8 +1209,9 @@ const ( // Values returns all known values for LoadBalancerTlsCertificateRenewalStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTlsCertificateRenewalStatus) Values() []LoadBalancerTlsCertificateRenewalStatus { return []LoadBalancerTlsCertificateRenewalStatus{ "PENDING_AUTO_RENEWAL", @@ -1186,8 +1239,9 @@ const ( // Values returns all known values for LoadBalancerTlsCertificateRevocationReason. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTlsCertificateRevocationReason) Values() []LoadBalancerTlsCertificateRevocationReason { return []LoadBalancerTlsCertificateRevocationReason{ "UNSPECIFIED", @@ -1219,8 +1273,9 @@ const ( // Values returns all known values for LoadBalancerTlsCertificateStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LoadBalancerTlsCertificateStatus) Values() []LoadBalancerTlsCertificateStatus { return []LoadBalancerTlsCertificateStatus{ "PENDING_VALIDATION", @@ -1266,8 +1321,9 @@ const ( ) // Values returns all known values for MetricName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricName) Values() []MetricName { return []MetricName{ "CPUUtilization", @@ -1310,8 +1366,9 @@ const ( ) // Values returns all known values for MetricStatistic. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricStatistic) Values() []MetricStatistic { return []MetricStatistic{ "Minimum", @@ -1356,8 +1413,9 @@ const ( ) // Values returns all known values for MetricUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricUnit) Values() []MetricUnit { return []MetricUnit{ "Seconds", @@ -1402,6 +1460,7 @@ const ( // Values returns all known values for NameServersUpdateStateCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NameServersUpdateStateCode) Values() []NameServersUpdateStateCode { return []NameServersUpdateStateCode{ @@ -1423,8 +1482,9 @@ const ( ) // Values returns all known values for NetworkProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkProtocol) Values() []NetworkProtocol { return []NetworkProtocol{ "tcp", @@ -1446,8 +1506,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "NotStarted", @@ -1548,8 +1609,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "DeleteKnownHostKeys", @@ -1648,6 +1710,7 @@ const ( // 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{ @@ -1665,8 +1728,9 @@ const ( ) // Values returns all known values for PortAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PortAccessType) Values() []PortAccessType { return []PortAccessType{ "Public", @@ -1685,8 +1749,9 @@ const ( ) // Values returns all known values for PortInfoSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PortInfoSourceType) Values() []PortInfoSourceType { return []PortInfoSourceType{ "DEFAULT", @@ -1705,8 +1770,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1726,8 +1792,9 @@ const ( ) // Values returns all known values for PricingUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingUnit) Values() []PricingUnit { return []PricingUnit{ "GB", @@ -1750,8 +1817,9 @@ const ( // Values returns all known values for R53HostedZoneDeletionStateCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (R53HostedZoneDeletionStateCode) Values() []R53HostedZoneDeletionStateCode { return []R53HostedZoneDeletionStateCode{ "SUCCEEDED", @@ -1771,8 +1839,9 @@ const ( ) // Values returns all known values for RecordState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordState) Values() []RecordState { return []RecordState{ "Started", @@ -1803,8 +1872,9 @@ const ( ) // Values returns all known values for RegionName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegionName) Values() []RegionName { return []RegionName{ "us-east-1", @@ -1834,6 +1904,7 @@ const ( // 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{ @@ -1855,8 +1926,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationalDatabaseMetricName) Values() []RelationalDatabaseMetricName { return []RelationalDatabaseMetricName{ "CPUUtilization", @@ -1879,8 +1951,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationalDatabasePasswordVersion) Values() []RelationalDatabasePasswordVersion { return []RelationalDatabasePasswordVersion{ "CURRENT", @@ -1900,8 +1973,9 @@ const ( ) // Values returns all known values for RenewalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenewalStatus) Values() []RenewalStatus { return []RenewalStatus{ "PendingAutoRenewal", @@ -1920,8 +1994,9 @@ const ( ) // Values returns all known values for ResourceBucketAccess. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceBucketAccess) Values() []ResourceBucketAccess { return []ResourceBucketAccess{ "allow", @@ -1956,8 +2031,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1993,8 +2069,9 @@ const ( ) // Values returns all known values for SetupStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SetupStatus) Values() []SetupStatus { return []SetupStatus{ "succeeded", @@ -2020,8 +2097,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "startExpired", @@ -2046,8 +2124,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "Active", @@ -2066,8 +2145,9 @@ const ( ) // Values returns all known values for TreatMissingData. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TreatMissingData) Values() []TreatMissingData { return []TreatMissingData{ "breaching", @@ -2089,8 +2169,9 @@ const ( // Values returns all known values for ViewerMinimumTlsProtocolVersionEnum. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ViewerMinimumTlsProtocolVersionEnum) Values() []ViewerMinimumTlsProtocolVersionEnum { return []ViewerMinimumTlsProtocolVersionEnum{ "TLSv1.1_2016", diff --git a/service/lightsail/types/errors.go b/service/lightsail/types/errors.go index c2d54c67ec6..8853e627eb4 100644 --- a/service/lightsail/types/errors.go +++ b/service/lightsail/types/errors.go @@ -70,10 +70,11 @@ func (e *AccountSetupInProgressException) ErrorCode() string { func (e *AccountSetupInProgressException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// 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. type InvalidInputException struct { Message *string diff --git a/service/lightsail/types/types.go b/service/lightsail/types/types.go index 2f08cd5276b..33c2ae6bd5e 100644 --- a/service/lightsail/types/types.go +++ b/service/lightsail/types/types.go @@ -7,16 +7,20 @@ import ( "time" ) -// 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) -// 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) -// 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 -// access key later. If you lose the secret access key, you must create a new -// access key. +// 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]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]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 access key later. If you +// lose the secret access key, you must create a new access key. +// +// [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 +// [CreateBucketAccessKey]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html type AccessKey struct { // The ID of the access key. @@ -25,70 +29,93 @@ 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) - // action. If the access key has not been used, the region and serviceName values - // are N/A , and the lastUsedDate value is null. + // An object that describes the last time the access key was used. + // + // This object does not include data in the response of a [CreateBucketAccessKey] action. If the access + // key has not been used, the region and serviceName values are N/A , and the + // lastUsedDate value is null. + // + // [CreateBucketAccessKey]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html LastUsed *AccessKeyLastUsed - // The secret access key used to sign requests. You should store the secret access - // key in a safe location. We recommend that you delete the access key if the - // secret access key is compromised. + // The secret access key used to sign requests. + // + // You should store the secret access key in a safe location. We recommend that + // you delete the access key if the secret access key is compromised. SecretAccessKey *string - // The status of the access key. A status of Active means that the key is valid, - // while Inactive means it is not. + // The status of the access key. + // + // A status of Active means that the key is valid, while Inactive means it is not. Status StatusType noSmithyDocumentSerde } -// 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) -// action. +// Describes the last time an access key was used. +// +// This object does not include data in the response of a [CreateBucketAccessKey] action. +// +// [CreateBucketAccessKey]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html 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. + // // This value is N/A if the access key has not been used. Region *string // The name of the Amazon Web Services service with which this access key was most - // recently used. This value is N/A if the access key has not been used. + // recently used. + // + // This value is N/A if the access key has not been used. ServiceName *string noSmithyDocumentSerde } // 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) -// in the Amazon Lightsail Developer Guide. +// its objects. +// +// For more information about bucket access permissions, see [Understanding bucket permissions in Amazon Lightsail] in the +// +// Amazon Lightsail Developer Guide. +// +// [Understanding bucket permissions in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions 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 - // public-read ACL, or to private using the private ACL. + // option that is currently specified. + // + // When this is true, you can use the [PutObjectAcl] Amazon S3 API action to set individual + // objects to public (read-only) using the public-read ACL, or to private using + // the private ACL. + // + // [PutObjectAcl]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html AllowPublicOverrides *bool - // Specifies the anonymous access to all objects in a bucket. The following - // options can be specified: + // 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. + // 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. + // 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 @@ -96,18 +123,21 @@ type AccessRules struct { // Describes the synchronization status of the Amazon Simple Storage Service // (Amazon S3) account-level block public access (BPA) feature for your Lightsail -// buckets. The account-level BPA feature of Amazon S3 provides centralized -// controls to limit public access to all Amazon S3 buckets in an account. BPA can -// make all Amazon S3 buckets in an Amazon Web Services account private regardless -// of the individual bucket and object permissions that are configured. Lightsail -// 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 +// buckets. +// +// The account-level BPA feature of Amazon S3 provides centralized controls to +// limit public access to all Amazon S3 buckets in an account. BPA can make all +// Amazon S3 buckets in an Amazon Web Services account private regardless of the +// individual bucket and object permissions that are configured. Lightsail 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 // 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) -// in the Amazon Lightsail Developer Guide. +// see [Block public access for buckets in Amazon Lightsail]in the Amazon Lightsail Developer Guide. +// +// [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 type AccountLevelBpaSync struct { // A Boolean value that indicates whether account-level block public access is @@ -120,41 +150,53 @@ type AccountLevelBpaSync struct { LastSyncedAt *time.Time // A message that provides a reason for a Failed or Defaulted synchronization - // status. The following messages are possible: + // 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. + // the required service-linked role to allow synchronization, see [Using Service-Linked Roles for Amazon Lightsail]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. + // required service-linked role to allow synchronization, see [Using Service-Linked Roles for Amazon Lightsail]in the Amazon + // Lightsail Developer Guide. + // // - Unknown - The reason that synchronization failed is unknown. Contact Amazon // Web Services Support for more information. + // + // [Using Service-Linked Roles for Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles Message BPAStatusMessage - // The status of the account-level BPA synchronization. The following statuses are - // possible: + // 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. Status AccountLevelBpaSyncStatus @@ -166,37 +208,48 @@ type AccountLevelBpaSync struct { type AddOn struct { // The amount of idle time in minutes after which your virtual computer will - // automatically stop. This add-on only applies to Lightsail for Research - // resources. + // automatically stop. + // + // This add-on only applies to Lightsail for Research resources. Duration *string // The name of the add-on. Name *string - // The next daily time an automatic snapshot will be created. The time shown is in - // HH:00 format, and in Coordinated Universal Time (UTC). The snapshot is - // automatically created between the time shown and up to 45 minutes after. + // The next daily time an automatic snapshot will be created. + // + // The time shown is in HH:00 format, and in Coordinated Universal Time (UTC). + // + // The snapshot is automatically created between the time shown and up to 45 + // minutes after. NextSnapshotTimeOfDay *string - // The daily time when an automatic snapshot is created. The time shown is in HH:00 - // format, and in Coordinated Universal Time (UTC). The snapshot is automatically - // created between the time shown and up to 45 minutes after. + // The daily time when an automatic snapshot is created. + // + // The time shown is in HH:00 format, and in Coordinated Universal Time (UTC). + // + // The snapshot is automatically created between the time shown and up to 45 + // minutes after. SnapshotTimeOfDay *string // The status of the add-on. Status *string - // The trigger threshold of the action. This add-on only applies to Lightsail for - // Research resources. + // The trigger threshold of the action. + // + // This add-on only applies to Lightsail for Research resources. Threshold *string noSmithyDocumentSerde } // 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/) -// . +// Lightsail resource. +// +// An additional cost may be associated with enabling add-ons. For more +// information, see the [Lightsail pricing page]. +// +// [Lightsail pricing page]: https://aws.amazon.com/lightsail/pricing/ type AddOnRequest struct { // The add-on type. @@ -209,16 +262,20 @@ type AddOnRequest struct { AutoSnapshotAddOnRequest *AutoSnapshotAddOnRequest // An object that represents additional parameters when enabling or modifying the - // StopInstanceOnIdle add-on. This object only applies to Lightsail for Research - // resources. + // StopInstanceOnIdle add-on. + // + // This object only applies to Lightsail for Research resources. StopInstanceOnIdleRequest *StopInstanceOnIdleRequest noSmithyDocumentSerde } -// 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) -// . +// Describes an alarm. +// +// An alarm is a way to monitor your Lightsail resource metrics. For more +// information, see [Alarms in Amazon Lightsail]. +// +// [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. @@ -266,26 +323,37 @@ type Alarm struct { // The Lightsail resource type of the alarm. ResourceType ResourceType - // The current state of the alarm. An alarm has the following possible states: + // 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. State AlarmState - // The statistic for the metric associated with the alarm. The following - // statistics are available: + // 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 @@ -298,14 +366,19 @@ type Alarm struct { // The value against which the specified statistic is compared. Threshold *float64 - // Specifies how the alarm handles missing data points. An alarm can treat missing - // data in the following ways: + // 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. TreatMissingData TreatMissingData @@ -329,18 +402,22 @@ type AttachedDisk struct { } // Describes a request to enable or modify the automatic snapshot add-on for an -// 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: +// 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 @@ -348,6 +425,7 @@ type AttachedDisk struct { // 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 @@ -356,9 +434,14 @@ type AttachedDisk struct { // time and the new snapshot time that you specify. type AutoSnapshotAddOnRequest struct { - // The daily time when an automatic snapshot will be created. Constraints: + // 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. SnapshotTimeOfDay *string @@ -401,8 +484,9 @@ type AvailabilityZone struct { // Describes a blueprint (a virtual private server image). type Blueprint struct { - // Virtual computer blueprints that are supported by Lightsail for Research. This - // parameter only applies to Lightsail for Research resources. + // Virtual computer blueprints that are supported by Lightsail for Research. + // + // This parameter only applies to Lightsail for Research resources. AppCategory AppCategory // The ID for the virtual private server image ( app_wordpress_4_4 or app_lamp_7_0 @@ -456,9 +540,14 @@ type Blueprint struct { 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) - // action to change a bucket's bundle. + // 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] action to change a bucket's bundle. + // + // [UpdateBucketBundle]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html AbleToUpdateBundle *bool // An object that describes the access log configuration for the bucket. @@ -470,10 +559,14 @@ type Bucket struct { // The Amazon Resource Name (ARN) of the bucket. Arn *string - // 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) - // action to change the bundle of a bucket. + // 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] action to change the bundle of a bucket. + // + // [UpdateBucketBundle]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html BundleId *string // The timestamp when the distribution was created. @@ -486,11 +579,15 @@ type Bucket struct { // The name of the bucket. Name *string - // Indicates whether object versioning is enabled for the bucket. The following - // options can be configured: + // 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. ObjectVersioning *string @@ -502,8 +599,11 @@ type Bucket struct { 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) - // action to update the instances that have access to a bucket. + // bucket. + // + // Use the [SetResourceAccessForBucket] action to update the instances that have access to a bucket. + // + // [SetResourceAccessForBucket]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html ResourcesReceivingAccess []ResourceReceivingAccess // An object that describes the state of the bucket. @@ -514,9 +614,10 @@ type Bucket struct { // to look up your Lightsail information more easily. 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. + // The tag keys and optional values for the bucket. For more information, see [Tags in Amazon Lightsail] in + // the Amazon Lightsail Developer Guide. + // + // [Tags in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags Tags []Tag // The URL of the bucket. @@ -526,9 +627,12 @@ 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) -// in the Amazon Lightsail Developer Guide. +// object storage service. +// +// For more information about bucket access logs, see [Logging bucket requests using access logging in Amazon Lightsail] in the Amazon Lightsail +// Developer Guide. +// +// [Logging bucket requests using access logging in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-bucket-access-logs type BucketAccessLogConfig struct { // A Boolean value that indicates whether bucket access logging is enabled for the @@ -539,25 +643,31 @@ type BucketAccessLogConfig struct { // 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. + // 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 - // specified when enabling the access log for a bucket, and should be omitted when - // disabling the access log. + // 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 specified when enabling the access log for a + // bucket, and should be omitted when disabling the access log. Prefix *string noSmithyDocumentSerde } // Describes the specifications of a bundle that can be applied to an Amazon -// Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and -// data transfer quota for a bucket. +// Lightsail bucket. +// +// A bucket bundle specifies the monthly cost, storage space, and data transfer +// quota for a bucket. type BucketBundle struct { // The ID of the bundle. @@ -584,8 +694,12 @@ type BucketBundle struct { // Describes the state of an Amazon Lightsail bucket. type BucketState struct { - // The state code of the bucket. The following codes are possible: + // 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. Code *string @@ -636,7 +750,9 @@ type Bundle struct { RamSizeInGb *float32 // Virtual computer blueprints that are supported by a Lightsail for Research - // bundle. This parameter only applies to Lightsail for Research resources. + // bundle. + // + // This parameter only applies to Lightsail for Research resources. SupportedAppCategories []AppCategory // The operating system platform (Linux/Unix-based or Windows Server-based) that @@ -655,13 +771,16 @@ type Bundle struct { // network (CDN) distribution. type CacheBehavior struct { - // The cache behavior of the distribution. The following cache behaviors can be - // specified: + // 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 @@ -673,71 +792,106 @@ 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. +// 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. type CacheBehaviorPerPath struct { - // The cache behavior for the specified path. You can specify one of the following - // per-path cache behaviors: + // 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. 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: + // *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/ + // 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 + // 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 + // 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/ + // + // 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 } // 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 . +// (CDN) distribution. +// +// These settings apply only to your distribution's 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. AllowedHTTPMethods *string - // The HTTP method responses that are cached by your distribution. You can specify - // the following options: + // 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. 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. + // 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. DefaultTTL *int64 // An object that describes the cookies that are forwarded to the origin. Your @@ -754,22 +908,26 @@ 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. + // 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. MaximumTTL *int64 // The minimum 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. A value of 0 must be specified for minimumTTL if the - // distribution is configured to forward all headers to the origin. + // object has been updated. + // + // A value of 0 must be specified for minimumTTL if the distribution is configured + // to forward all headers to the origin. MinimumTTL *int64 noSmithyDocumentSerde } -// Describes the full details of an Amazon Lightsail SSL/TLS certificate. To get a -// summary of a certificate, use the GetCertificates action and omit +// Describes the full details of an Amazon Lightsail SSL/TLS certificate. +// +// To get a summary of a certificate, use the GetCertificates action and omit // includeCertificateDetails from your request. The response will include only the // certificate Amazon Resource Name (ARN), certificate name, domain name, and tags. type Certificate struct { @@ -816,29 +974,36 @@ type Certificate struct { // Lightsail. RenewalSummary *RenewalSummary - // The validation failure reason, if any, of the certificate. The following - // failure reasons are possible: + // 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. + // provide the required information, use the [Amazon Web Services Support Center]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. + // request was reported as an unsafe domain by [VirusTotal]. To correct the problem, search + // for your domain name on the [VirusTotal]website. If your domain is reported as + // suspicious, see [Google Help for Hacked Websites]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]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 @@ -846,10 +1011,15 @@ type Certificate struct { // 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. + // + // [Google Help for Hacked Websites]: https://developers.google.com/web/fundamentals/security/hacked + // [VirusTotal]: https://www.virustotal.com/gui/home/url + // [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/home RequestFailureReason *string // The reason the certificate was revoked. This value is present only when the @@ -876,8 +1046,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -899,17 +1070,20 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde } // Describes a CloudFormation stack record created as a result of the create cloud -// formation stack action. A CloudFormation stack record provides information about -// the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud -// instance from an exported Lightsail instance snapshot. +// formation stack action. +// +// A CloudFormation stack record provides information about the AWS CloudFormation +// stack used to create a new Amazon Elastic Compute Cloud instance from an +// exported Lightsail instance snapshot. type CloudFormationStackRecord struct { // The Amazon Resource Name (ARN) of the CloudFormation stack record. @@ -959,9 +1133,11 @@ type CloudFormationStackRecordSourceInfo struct { 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]. +// +// [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. @@ -987,11 +1163,15 @@ type ContactMethod struct { // The Lightsail resource type of the contact method. ResourceType ResourceType - // The current status of the contact method. A contact method has the following - // possible status: + // 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. Status ContactMethodStatus @@ -1014,17 +1194,20 @@ 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 - // 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 . + // 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 . Image *string // The open firewall ports of the container. @@ -1072,90 +1255,119 @@ type ContainerService struct { // Amazon Web Services Region and Availability Zone. Location *ResourceLocation - // An object that describes the next deployment of the container service. This - // value is null when there is no deployment in a pending state. + // An object that describes the next deployment of the container service. + // + // This 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. PowerId *string - // The principal ARN of the container service. The principal ARN can be used to - // create a trust relationship between your standard Amazon Web Services account - // and your Lightsail container service. This allows you to give your service - // permission to access resources in your standard Amazon Web Services account. + // The principal ARN of the container service. + // + // The principal ARN can be used to create a trust relationship between your + // standard Amazon Web Services account and your Lightsail container service. This + // allows you to give your service permission to access resources in your standard + // Amazon Web Services account. PrincipalArn *string - // The private domain name of the container service. The private domain name is - // accessible only by other resources within the default virtual private cloud - // (VPC) of your Lightsail account. + // The private domain name of the container service. + // + // The private domain name is accessible only by other resources within the + // default virtual private cloud (VPC) of your Lightsail account. PrivateDomainName *string // 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) - // in the Amazon Lightsail Developer Guide. + // (Amazon ECR) private repositories. + // + // For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service] in the Amazon Lightsail Developer Guide. + // + // [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 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 - // 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 - // the container service. You must create and validate an SSL/TLS certificate - // before you can use public domain names with your container service. Use the - // CreateCertificate action to create a certificate for the public domain names you - // want to use with your container service. See CreateContainerService or - // UpdateContainerService for information about how to specify public domain names - // for your Lightsail container service. + // 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 the container service. + // + // You must create and validate an SSL/TLS certificate before you can use public + // domain names with your container service. Use the CreateCertificate action to + // create a certificate for the public domain names you want to use with your + // container service. + // + // See CreateContainerService or UpdateContainerService for information about how + // to specify public domain names for your Lightsail container service. PublicDomainNames map[string][]string // The Lightsail resource type of the container service. ResourceType ResourceType - // The scale specification of the container service. The scale specifies the - // allocated compute nodes of the container service. + // The scale specification of the container service. + // + // The scale specifies the allocated compute nodes of the container service. Scale *int32 - // The current state of the container service. The following container service - // states are possible: + // 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. 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. + // 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. 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]. + // + // [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. + // The publicly accessible URL of the container service. + // + // If no public endpoint is specified in the currentDeployment , this URL returns a + // 404 response. Url *string noSmithyDocumentSerde } // Describes a container deployment configuration of an 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. +// service. +// +// A deployment specifies the settings, such as the ports and launch command, of +// containers that are deployed to your container service. type ContainerServiceDeployment struct { // An object that describes the configuration for the containers of the deployment. @@ -1167,14 +1379,19 @@ type ContainerServiceDeployment struct { // An object that describes the endpoint of the deployment. PublicEndpoint *ContainerServiceEndpoint - // The state of the deployment. A deployment can be in one of the following - // states: + // 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. @@ -1187,8 +1404,10 @@ type ContainerServiceDeployment struct { } // Describes a container deployment configuration of an 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. +// service. +// +// A deployment specifies the settings, such as the ports and launch command, of +// containers that are deployed to your container service. type ContainerServiceDeploymentRequest struct { // An object that describes the configuration for the containers of the deployment. @@ -1202,14 +1421,16 @@ type ContainerServiceDeploymentRequest struct { // Describes the activation status of 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 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) -// in the Amazon Lightsail Developer Guide. +// 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 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]in the Amazon Lightsail Developer Guide. +// +// [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 type ContainerServiceECRImagePullerRole struct { // A Boolean value that indicates whether the role is activated. @@ -1223,15 +1444,16 @@ type ContainerServiceECRImagePullerRole struct { // 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 -// 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) -// in the Amazon Lightsail Developer Guide. +// 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 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]in the Amazon Lightsail Developer Guide. +// +// [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 type ContainerServiceECRImagePullerRoleRequest struct { // A Boolean value that indicates whether to activate the role. @@ -1303,8 +1525,10 @@ type ContainerServiceLogEvent struct { } // Describes the powers that can be specified for an Amazon Lightsail container -// service. The power specifies the amount of RAM, the number of vCPUs, and the -// base price of the container service. +// service. +// +// The power specifies the amount of RAM, the number of vCPUs, and the base price +// of the container service. type ContainerServicePower struct { // The number of vCPUs included in the power. @@ -1334,6 +1558,7 @@ type ContainerServicePower struct { type ContainerServiceRegistryLogin struct { // The timestamp of when the container image registry sign-in credentials expire. + // // The log in credentials expire 12 hours after they are created, at which point // you will need to create a new set of log in credentials using the // CreateContainerServiceRegistryLogin action. @@ -1357,42 +1582,56 @@ type ContainerServiceRegistryLogin struct { // Describes the current state of a container service. type ContainerServiceStateDetail struct { - // The state code of the container service. The following state codes are - // possible: + // 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. 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 } // Describes whether an Amazon Lightsail content delivery network (CDN) -// distribution forwards cookies to the origin and, if so, which ones. For the -// cookies that you specify, your distribution caches separate versions of the -// specified content based on the cookie values in viewer requests. +// distribution forwards cookies to the origin and, if so, which ones. +// +// For the cookies that you specify, your distribution caches separate versions of +// the specified content based on the cookie values in viewer requests. type CookieObject struct { // The specific cookies to forward to your distribution's origin. @@ -1444,24 +1683,27 @@ type Disk struct { // The resources to which the disk is attached. AttachedTo *string - // (Discontinued) 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 discontinued, but still included in the response. Use - // isAttached instead. + // (Discontinued) 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 discontinued, but still included in + // the response. Use isAttached instead. // // Deprecated: This member has been deprecated. AttachmentState *string - // The status of automatically mounting a storage disk to a virtual computer. This - // parameter only applies to Lightsail for Research resources. + // The status of automatically mounting a storage disk to a virtual computer. + // + // This parameter only applies to Lightsail for Research resources. AutoMountStatus AutoMountStatus // The date when the disk was created. CreatedAt *time.Time - // (Discontinued) The number of GB in use by the disk. In releases prior to - // November 14, 2017, this parameter was not included in the API response. It is - // now discontinued. + // (Discontinued) The number of GB in use by the disk. + // + // In releases prior to November 14, 2017, this parameter was not included in the + // API response. It is now discontinued. // // Deprecated: This member has been deprecated. GbInUse *int32 @@ -1500,8 +1742,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -1590,8 +1833,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -1630,22 +1874,28 @@ type DistributionBundle struct { // Describes the creation state of the canonical name (CNAME) records that are // automatically added by Amazon Lightsail to the DNS of a domain to validate -// domain ownership for an SSL/TLS certificate. When you create an SSL/TLS -// certificate for a Lightsail resource, you must add a set of CNAME records to the -// DNS of the domains for the certificate to validate that you own the domains. -// Lightsail can automatically add the CNAME records to the DNS of the domain if -// the DNS zone for the domain exists within your Lightsail account. If automatic -// 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) -// in the Amazon Lightsail Developer Guide. +// domain ownership for an SSL/TLS certificate. +// +// When you create an SSL/TLS certificate for a Lightsail resource, you must add a +// set of CNAME records to the DNS of the domains for the certificate to validate +// that you own the domains. Lightsail can automatically add the CNAME records to +// the DNS of the domain if the DNS zone for the domain exists within your +// Lightsail account. If automatic 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]in the Amazon +// Lightsail Developer Guide. +// +// [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 type DnsRecordCreationState struct { - // The status code for the automated DNS record creation. Following are the - // possible values: + // 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. Code DnsRecordCreationStateCode @@ -1688,8 +1938,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -1712,15 +1963,18 @@ type DomainEntry struct { // The name of the domain. Name *string - // (Discontinued) 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 - // discontinued. + // (Discontinued) 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 discontinued. // // Deprecated: This member has been deprecated. Options map[string]string // The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. - // ). For Lightsail load balancers, the value looks like + // ). + // + // 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 @@ -1731,15 +1985,24 @@ type DomainEntry struct { // 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: + // authority (SOA), service locator (SRV), or text (TXT). + // + // The following domain entry types can be used: + // // - A + // // - AAAA + // // - CNAME + // // - MX + // // - NS + // // - SOA + // // - SRV + // // - TXT Type *string @@ -1875,6 +2138,7 @@ type ExportSnapshotRecordSourceInfo struct { } // Describes the request headers that a Lightsail distribution bases caching on. +// // 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 @@ -1888,9 +2152,14 @@ type HeaderObject struct { HeadersAllowList []HeaderEnum // 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: + // 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. Option ForwardValues @@ -1901,30 +2170,42 @@ 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 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 + // + // 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 + // + // 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 - // is listed only for RDP certificates. + // The returned RDP certificate is not valid after this point in time. + // + // This value is listed only for RDP certificates. NotValidAfter *time.Time - // The returned RDP certificate is valid after this point in time. This value is - // listed only for RDP certificates. + // The returned RDP certificate is valid after this point in time. + // + // This value is listed only for RDP certificates. NotValidBefore *time.Time // The public SSH host key or the RDP certificate. @@ -1937,9 +2218,11 @@ type HostKeyAttributes struct { } // Describes the origin resource of an Amazon Lightsail content delivery network -// (CDN) distribution. An origin can be a Lightsail instance, bucket, container -// service, or load balancer. A distribution pulls content from an origin, caches -// it, and serves it to viewers via a worldwide network of edge servers. +// (CDN) distribution. +// +// An origin can be a Lightsail instance, bucket, container service, or load +// balancer. A distribution pulls content from an origin, caches it, and serves it +// to viewers via a worldwide network of edge servers. type InputOrigin struct { // The name of the origin resource. @@ -1988,8 +2271,9 @@ type Instance struct { // 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. @@ -2033,8 +2317,9 @@ 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]. + // + // [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 ( ec2-user ). @@ -2069,12 +2354,15 @@ 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 - // 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 - // default. + // 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 default. Password *string // For a Windows Server-based instance, an object with the data you can use to @@ -2110,11 +2398,14 @@ type InstanceEntry struct { // This member is required. InstanceType *string - // The port configuration to use for the new Amazon EC2 instance. The following - // configuration options are available: + // 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. @@ -2128,6 +2419,7 @@ type InstanceEntry struct { // // - 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 @@ -2138,17 +2430,20 @@ type InstanceEntry struct { // The name of the export snapshot record, which contains the exported Lightsail // instance snapshot that will be used as the source of the new Amazon EC2 - // instance. Use the get export snapshot records operation to get a list of export - // snapshot records that you can use to create a CloudFormation stack. + // instance. + // + // Use the get export snapshot records operation to get a list of export snapshot + // records that you can use to create a CloudFormation stack. // // This member is required. 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 - // 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 . + // 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 . UserData *string noSmithyDocumentSerde @@ -2176,35 +2471,50 @@ type InstanceHealthSummary struct { 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: + // 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. InstanceHealthReason InstanceHealthReason @@ -2220,7 +2530,9 @@ 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 @@ -2231,25 +2543,34 @@ type InstanceMetadataOptions struct { // 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 - // 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 - // 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) - // in the Amazon Lightsail Developer Guide. + // 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 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 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]in the Amazon Lightsail Developer Guide. + // + // [Viewing instance metrics in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-health-metrics HttpTokens HttpTokens - // The state of the metadata option changes. The following states are possible: + // 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. State InstanceMetadataState @@ -2273,8 +2594,9 @@ 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 - // inbound access direction. + // 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) , @@ -2284,51 +2606,70 @@ type InstancePortInfo struct { // 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 - // instance. + // 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. + // 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] on Wikipedia. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation 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: + // 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. + // For more information, see [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) - // . + // see [Internet Control Message Protocol for IPv6]. + // + // [Control Messages]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages + // [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. + // 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] on Wikipedia. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation Ipv6Cidrs []string - // The IP protocol name. The name can be one of the following: + // 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. + // + // - all - All transport layer protocol types. For more general information, see [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 @@ -2336,24 +2677,33 @@ type InstancePortInfo struct { // 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. + // + // [Transport layer]: https://en.wikipedia.org/wiki/Transport_layer Protocol NetworkProtocol - // The last port in a range of open ports on an instance. Allowed ports: + // 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. + // For more information, see [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) - // . + // see [Internet Control Message Protocol for IPv6]. + // + // [Control Messages]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages + // [Internet Control Message Protocol for IPv6]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 ToPort int32 noSmithyDocumentSerde @@ -2363,48 +2713,67 @@ 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 - // instance. + // 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. + // 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] on Wikipedia. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation Cidrs []string - // The first port in a range of open ports on an instance. Allowed ports: + // 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. + // For more information, see [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) - // . + // see [Internet Control Message Protocol for IPv6]. + // + // [Control Messages]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages + // [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. + // 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] on Wikipedia. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation Ipv6Cidrs []string - // The IP protocol name. The name can be one of the following: + // 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. + // + // - all - All transport layer protocol types. For more general information, see [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 @@ -2412,28 +2781,38 @@ type InstancePortState struct { // 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. + // + // [Transport layer]: https://en.wikipedia.org/wiki/Transport_layer 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: + // 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. + // For more information, see [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) - // . + // see [Internet Control Message Protocol for IPv6]. + // + // [Control Messages]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages + // [Internet Control Message Protocol for IPv6]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 ToPort int32 noSmithyDocumentSerde @@ -2480,8 +2859,9 @@ type InstanceSnapshot struct { // The name of the snapshot. Name *string - // The progress of the snapshot. This is populated only for disk snapshots, and is - // null for instance snapshots. + // The progress of the snapshot. + // + // This is populated only for disk snapshots, and is null for instance snapshots. Progress *string // The type of resource (usually InstanceSnapshot ). @@ -2499,8 +2879,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -2563,8 +2944,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -2575,8 +2957,9 @@ type LightsailDistribution struct { // Indicates whether the bundle that is currently applied to your distribution, // specified using the distributionName parameter, can be changed to another - // bundle. Use the UpdateDistributionBundle action to change your distribution's // bundle. + // + // Use the UpdateDistributionBundle action to change your distribution's bundle. AbleToUpdateBundle *bool // The alternate domain names of the distribution. @@ -2607,26 +2990,29 @@ type LightsailDistribution struct { // The domain name of the distribution. DomainName *string - // The IP address type of the distribution. The possible values are ipv4 for IPv4 - // only, and dualstack for IPv4 and IPv6. + // The IP address type of the distribution. + // + // The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. IpAddressType IpAddressType // Indicates whether the distribution is enabled. IsEnabled *bool // An object that describes the location of the distribution, such as the Amazon - // Web Services Region and Availability Zone. 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. + // Web Services Region and Availability Zone. + // + // 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. Location *ResourceLocation // The name of the distribution. Name *string // An object that describes the origin resource of the distribution, such as a - // Lightsail instance, bucket, or load balancer. The distribution pulls, caches, - // and serves content from the origin. + // Lightsail instance, bucket, or load balancer. + // + // The distribution pulls, caches, and serves content from the origin. Origin *Origin // The public DNS of the origin. @@ -2644,8 +3030,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag // The minimum TLS protocol version that the distribution can use to communicate @@ -2687,8 +3074,9 @@ type LoadBalancer struct { // instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443. InstancePort *int32 - // The IP address type of the load balancer. The possible values are ipv4 for IPv4 - // only, and dualstack for IPv4 and IPv6. + // The IP address type of the load balancer. + // + // The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6. IpAddressType IpAddressType // The AWS Region where your load balancer was created ( us-east-2a ). Lightsail @@ -2699,6 +3087,7 @@ type LoadBalancer struct { 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 . Protocol LoadBalancerProtocol @@ -2718,8 +3107,9 @@ 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]. + // + // [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 @@ -2733,8 +3123,9 @@ type LoadBalancer struct { noSmithyDocumentSerde } -// Describes a load balancer SSL/TLS certificate. TLS is just an updated, more -// secure version of Secure Socket Layer (SSL). +// Describes a load balancer SSL/TLS certificate. +// +// TLS is just an updated, more secure version of Secure Socket Layer (SSL). type LoadBalancerTlsCertificate struct { // The Amazon Resource Name (ARN) of the SSL/TLS certificate. @@ -2750,29 +3141,35 @@ type LoadBalancerTlsCertificate struct { // the records. DomainValidationRecords []LoadBalancerTlsCertificateDomainValidationRecord - // The validation failure reason, if any, of the certificate. The following - // failure reasons are possible: + // 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. + // provide the required information, use the [AWS Support Center]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. + // request was reported as an unsafe domain by [VirusTotal]. To correct the problem, search + // for your domain name on the [VirusTotal]website. If your domain is reported as + // suspicious, see [Google Help for Hacked Websites]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]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 @@ -2780,10 +3177,15 @@ type LoadBalancerTlsCertificate struct { // 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. + // + // [Google Help for Hacked Websites]: https://developers.google.com/web/fundamentals/security/hacked + // [VirusTotal]: https://www.virustotal.com/gui/home/url + // [AWS Support Center]: https://console.aws.amazon.com/support/home FailureReason LoadBalancerTlsCertificateFailureReason // When true , the SSL/TLS certificate is attached to the Lightsail load balancer. @@ -2819,16 +3221,26 @@ type LoadBalancerTlsCertificate struct { RenewalSummary *LoadBalancerTlsCertificateRenewalSummary // The resource type ( 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 @@ -2863,8 +3275,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -2875,10 +3288,14 @@ type LoadBalancerTlsCertificate struct { // ownership. type LoadBalancerTlsCertificateDnsRecordCreationState struct { - // The status code for the automated DNS record creation. Following are the - // possible values: + // 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. Code LoadBalancerTlsCertificateDnsRecordCreationStateCode @@ -2928,17 +3345,24 @@ 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: +// 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. @@ -2950,17 +3374,22 @@ type LoadBalancerTlsCertificateRenewalSummary struct { // request. DomainValidationOptions []LoadBalancerTlsCertificateDomainValidationOption - // The renewal status of the certificate. The following renewal status are - // possible: + // 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. @@ -2982,13 +3411,17 @@ 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) -// in the Amazon Lightsail Developer Guide. +// balancers. +// +// For more information about load balancer TLS security policies, see [Configuring TLS security policies on your Amazon Lightsail load balancers] in the +// Amazon Lightsail Developer Guide. +// +// [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 type LoadBalancerTlsPolicy struct { - // The ciphers used by the TLS security policy. The ciphers are listed in order of - // preference. + // The ciphers used by the TLS security policy. + // + // The ciphers are listed in order of preference. Ciphers []string // The description of the TLS security policy. @@ -3045,10 +3478,12 @@ type MetricDatapoint struct { noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [Alarms in 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. @@ -3057,9 +3492,10 @@ type MonitoredResourceInfo struct { // The name of the Lightsail resource being monitored. Name *string - // The Lightsail resource type of the resource being monitored. Instances, load - // balancers, and relational databases are the only Lightsail resources that can - // currently be monitored by alarms. + // The Lightsail resource type of the resource being monitored. + // + // Instances, load balancers, and relational databases are the only Lightsail + // resources that can currently be monitored by alarms. ResourceType ResourceType noSmithyDocumentSerde @@ -3076,15 +3512,23 @@ 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) -// in the Amazon Lightsail Developer Guide. +// to an Amazon Route 53 registered domain. +// +// For more information, see [DNS in Amazon Lightsail] in the Amazon Lightsail Developer Guide. +// +// [DNS in Amazon Lightsail]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail type NameServersUpdateState struct { - // The status code for the name servers update. Following are the possible values: + // 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 @@ -3137,9 +3581,11 @@ type Operation struct { } // Describes the origin resource of an Amazon Lightsail content delivery network -// (CDN) distribution. An origin can be a Lightsail instance, bucket, or load -// balancer. A distribution pulls content from an origin, caches it, and serves it -// to viewers via a worldwide network of edge servers. +// (CDN) distribution. +// +// An origin can be a Lightsail instance, bucket, or load balancer. A distribution +// pulls content from an origin, caches it, and serves it to viewers via a +// worldwide network of edge servers. type Origin struct { // The name of the origin resource. @@ -3170,21 +3616,27 @@ 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 - // 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 - // the instance using RDP, you need to manually enter the Administrator password - // after changing it from the default. + // 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 the instance + // using RDP, you need to manually enter the Administrator password after changing + // it from the default. Ciphertext *string // 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 . - // Lightsail creates the ciphertext by encrypting your password with the public key - // part of this key pair. + // 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 noSmithyDocumentSerde @@ -3224,51 +3676,73 @@ 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 - // instance. + // 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: + // 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. + // + // For more information about CIDR block notation, see [Classless Inter-Domain Routing] on Wikipedia. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation Cidrs []string - // The first port in a range of open ports on an instance. Allowed ports: + // 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. + // For more information, see [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) - // . + // see [Internet Control Message Protocol for IPv6]. + // + // [Control Messages]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages + // [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. + // 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] on Wikipedia. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation Ipv6Cidrs []string - // The IP protocol name. The name can be one of the following: + // 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. + // + // - all - All transport layer protocol types. For more general information, see [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 @@ -3276,24 +3750,33 @@ type PortInfo struct { // 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. + // + // [Transport layer]: https://en.wikipedia.org/wiki/Transport_layer Protocol NetworkProtocol - // The last port in a range of open ports on an instance. Allowed ports: + // 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. + // For more information, see [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) - // . + // see [Internet Control Message Protocol for IPv6]. + // + // [Control Messages]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages + // [Internet Control Message Protocol for IPv6]: https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6 ToPort int32 noSmithyDocumentSerde @@ -3301,9 +3784,11 @@ 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) -// in the Amazon Lightsail Developer Guide. +// (Amazon ECR) private repositories. +// +// For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service] in the Amazon Lightsail Developer Guide. +// +// [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 type PrivateRegistryAccess struct { // An object that describes the activation status of the role that you can use to @@ -3317,10 +3802,11 @@ type PrivateRegistryAccess struct { // 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. +// Registry (Amazon ECR) private repositories. +// +// For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service] in the Amazon Lightsail Developer Guide. +// +// [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 type PrivateRegistryAccessRequest struct { // An object to describe a request to activate or deactivate the role that you can @@ -3332,18 +3818,23 @@ type PrivateRegistryAccessRequest struct { } // Describes the query string parameters that an Amazon Lightsail content delivery -// network (CDN) distribution to bases caching on. For the query strings that you -// specify, your distribution caches separate versions of the specified content -// based on the query string values in viewer requests. +// network (CDN) distribution to bases caching on. +// +// For the query strings that you specify, your distribution caches separate +// versions of the specified content based on the query string values in viewer +// requests. type QueryStringObject struct { // Indicates whether the distribution forwards and caches based on query strings. Option *bool - // The specific query strings that the distribution forwards to the origin. Your - // distribution will cache content based on the specified query strings. If the - // option parameter is true, then your distribution forwards all query strings, - // regardless of what you specify using the queryStringsAllowList parameter. + // The specific query strings that the distribution forwards to the origin. + // + // Your distribution will cache content based on the specified query strings. + // + // If the option parameter is true, then your distribution forwards all query + // strings, regardless of what you specify using the queryStringsAllowList + // parameter. QueryStringsAllowList []string noSmithyDocumentSerde @@ -3353,10 +3844,16 @@ type QueryStringObject struct { // 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: + // 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. Code R53HostedZoneDeletionStateCode @@ -3393,27 +3890,33 @@ type Region struct { } // 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: +// 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. // // 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. +// to Lightsail. For more information, see [Creating a DNS zone to manage your domain’s records in Amazon Lightsail]in the Amazon Lightsail Developer Guide. +// +// [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 type RegisteredDomainDelegationInfo struct { // An object that describes the state of the name server records that are @@ -3485,9 +3988,9 @@ type RelationalDatabase struct { // 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. @@ -3504,8 +4007,10 @@ type RelationalDatabase struct { // The Lightsail resource type for the database (for example, RelationalDatabase ). ResourceType ResourceType - // Describes the secondary Availability Zone of a high availability database. The - // secondary database is used for failover support of a high availability database. + // Describes the secondary Availability Zone of a high availability database. + // + // The secondary database is used for failover support of a high availability + // database. SecondaryAvailabilityZone *string // Describes the current state of the database. @@ -3517,8 +4022,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -3635,8 +4141,9 @@ 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. @@ -3710,8 +4217,9 @@ 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]. + // + // [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags Tags []Tag noSmithyDocumentSerde @@ -3725,17 +4233,22 @@ type RenewalSummary struct { // certificate. DomainValidationRecords []DomainValidationRecord - // The renewal status of the certificate. The following renewal status are - // possible: + // 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. @@ -3856,8 +4369,9 @@ type SetupExecutionDetails struct { noSmithyDocumentSerde } -// Returns a list of the commands that were ran on the target resource. The status -// of each command is also returned. +// Returns a list of the commands that were ran on the target resource. +// +// The status of each command is also returned. type SetupHistory struct { // Describes the full details of the request. @@ -3952,8 +4466,9 @@ 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 @@ -3966,18 +4481,23 @@ 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]. +// +// [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, - // numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ + // The key of the tag. + // + // Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in + // UTF-8, or the following characters: + - = . _ : / @ Key *string - // The value of the tag. Constraints: Tag values accept a maximum of 256 letters, - // numbers, spaces in UTF-8, or the following characters: + - = . _ : / @ + // The value of the tag. + // + // Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in + // UTF-8, or the following characters: + - = . _ : / @ Value *string noSmithyDocumentSerde diff --git a/service/location/api_op_AssociateTrackerConsumer.go b/service/location/api_op_AssociateTrackerConsumer.go index 6bf3e23ed66..64b9370fe5c 100644 --- a/service/location/api_op_AssociateTrackerConsumer.go +++ b/service/location/api_op_AssociateTrackerConsumer.go @@ -12,10 +12,13 @@ import ( // Creates an association between a geofence collection and a tracker resource. // This allows the tracker resource to communicate location data to the linked -// geofence collection. You can associate up to five geofence collections to each -// tracker resource. Currently not supported — Cross-account configurations, such -// as creating associations between a tracker resource in one account and a -// geofence collection in another account. +// geofence collection. +// +// You can associate up to five geofence collections to each tracker resource. +// +// Currently not supported — Cross-account configurations, such as creating +// associations between a tracker resource in one account and a geofence collection +// in another account. func (c *Client) AssociateTrackerConsumer(ctx context.Context, params *AssociateTrackerConsumerInput, optFns ...func(*Options)) (*AssociateTrackerConsumerOutput, error) { if params == nil { params = &AssociateTrackerConsumerInput{} @@ -36,6 +39,7 @@ 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 // diff --git a/service/location/api_op_BatchDeleteDevicePositionHistory.go b/service/location/api_op_BatchDeleteDevicePositionHistory.go index 7f9407b8aef..8e0d2f5b0e9 100644 --- a/service/location/api_op_BatchDeleteDevicePositionHistory.go +++ b/service/location/api_op_BatchDeleteDevicePositionHistory.go @@ -30,6 +30,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] // // This member is required. diff --git a/service/location/api_op_BatchDeleteGeofence.go b/service/location/api_op_BatchDeleteGeofence.go index a2094017c82..1efa74cd19d 100644 --- a/service/location/api_op_BatchDeleteGeofence.go +++ b/service/location/api_op_BatchDeleteGeofence.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a batch of geofences from a geofence collection. This operation deletes -// the resource permanently. +// Deletes a batch of geofences from a geofence collection. +// +// This operation deletes the resource permanently. func (c *Client) BatchDeleteGeofence(ctx context.Context, params *BatchDeleteGeofenceInput, optFns ...func(*Options)) (*BatchDeleteGeofenceOutput, error) { if params == nil { params = &BatchDeleteGeofenceInput{} diff --git a/service/location/api_op_BatchEvaluateGeofences.go b/service/location/api_op_BatchEvaluateGeofences.go index fe46b06753c..7ed3c704895 100644 --- a/service/location/api_op_BatchEvaluateGeofences.go +++ b/service/location/api_op_BatchEvaluateGeofences.go @@ -12,20 +12,27 @@ import ( ) // 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: +// 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. // // 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 . +// 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 c0ed91720f4..eff5860766a 100644 --- a/service/location/api_op_BatchGetDevicePosition.go +++ b/service/location/api_op_BatchGetDevicePosition.go @@ -30,6 +30,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 // // This member is required. diff --git a/service/location/api_op_BatchUpdateDevicePosition.go b/service/location/api_op_BatchUpdateDevicePosition.go index a732ce9959a..3bb5206d752 100644 --- a/service/location/api_op_BatchUpdateDevicePosition.go +++ b/service/location/api_op_BatchUpdateDevicePosition.go @@ -14,21 +14,27 @@ import ( // Uploads position update data for one or more devices to a tracker resource (up // to 10 devices per batch). 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 . +// 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 . 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 e36f2403172..e8c77346476 100644 --- a/service/location/api_op_CalculateRoute.go +++ b/service/location/api_op_CalculateRoute.go @@ -12,23 +12,35 @@ import ( "time" ) -// 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 +// [Calculates a route] given the following required parameters: DeparturePosition and +// DestinationPosition . Requires that you first [create a route calculator resource]. +// +// 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] +// - 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] +// - 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 +// [Specifying a travel mode]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html +// [Calculates a route]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route.html +// [create a route calculator resource]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html func (c *Client) CalculateRoute(ctx context.Context, params *CalculateRouteInput, optFns ...func(*Options)) (*CalculateRouteOutput, error) { if params == nil { params = &CalculateRouteInput{} @@ -52,59 +64,84 @@ 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] . + // The start position for the route. Defined in [World Geodetic System (WGS 84)] 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] + // + // If you specify a departure that's not located on a road, Amazon Location [moves the position to the nearest road]. 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] + // + // [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html + // [World Geodetic System (WGS 84)]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84 // // 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] . + // The finish position for the route. Defined in [World Geodetic System (WGS 84)] 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] + // + // If you specify a destination that's not located on a road, Amazon Location [moves the position to the nearest road]. + // + // Valid Values: [-180 to 180,-90 to 90] + // + // [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html + // [World Geodetic System (WGS 84)]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84 // // This member is required. DestinationPosition []float64 // Specifies the desired time of arrival. Uses the given time to calculate the // route. Otherwise, the best time of day to travel with the best traffic - // conditions is used to calculate the route. ArrivalTime is not supported Esri. + // conditions is used to calculate the route. + // + // ArrivalTime is not supported Esri. ArrivalTime *time.Time // Specifies route preferences when traveling by Car , such as avoiding routes that - // use ferries or tolls. Requirements: TravelMode must be specified as Car . + // 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 a route. Otherwise, the best time of day to travel with the best - // traffic conditions is used to calculate the route. Default Value: false Valid - // Values: false | true + // traffic conditions is used to calculate the route. + // + // Default Value: false + // + // Valid Values: false | true DepartNow *bool // Specifies the desired time of departure. Uses the given time to calculate the // route. Otherwise, the best time of day to travel with the best traffic // conditions is used to calculate the route. - // - 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]format: YYYY-MM-DDThh:mm:ss.sssZ . For example, + // 2020–07-2T12:15:20.000Z+01:00 + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html DepartureTime *time.Time - // Set the unit system to specify the distance. Default Value: Kilometers + // Set the unit system to specify the distance. + // + // Default Value: Kilometers DistanceUnit types.DistanceUnit // Set to include the geometry details in the result for each path between a pair - // of positions. Default Value: false Valid Values: false | true + // of positions. + // + // Default Value: false + // + // Valid Values: false | true IncludeLegGeometry *bool - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *string // Specifies the distance to optimize for when calculating a route. @@ -112,33 +149,52 @@ type CalculateRouteInput struct { // 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: + // , 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]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. + // // Default Value: Car + // + // [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html TravelMode types.TravelMode // 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 - // 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] + // Location [moves the position to the nearest road]. + // + // 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] + // + // [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html WaypointPositions [][]float64 noSmithyDocumentSerde @@ -151,19 +207,26 @@ 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 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]: + // // - 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. // + // [snapped to a nearby road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html + // // This member is required. Legs []types.Leg diff --git a/service/location/api_op_CalculateRouteMatrix.go b/service/location/api_op_CalculateRouteMatrix.go index f9323abb275..553a10d12bb 100644 --- a/service/location/api_op_CalculateRouteMatrix.go +++ b/service/location/api_op_CalculateRouteMatrix.go @@ -12,30 +12,41 @@ import ( "time" ) -// Calculates a route matrix (https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html) -// -// given the following required parameters: DeparturePositions and +// [Calculates a route matrix] given the following required parameters: DeparturePositions and // 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 -// 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 +// 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]. +// +// 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 +// +// [Specifying a departure time] +// - 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] +// - 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 +// [Specifying a travel mode]: https://docs.aws.amazon.com/location/latest/developerguide/travel-mode.html +// [Calculates a route matrix]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html +// [create a route calculator resource]: https://docs.aws.amazon.com/location-routes/latest/APIReference/API_CreateRouteCalculator.html func (c *Client) CalculateRouteMatrix(ctx context.Context, params *CalculateRouteMatrixInput, optFns ...func(*Options)) (*CalculateRouteMatrixOutput, error) { if params == nil { params = &CalculateRouteMatrixInput{} @@ -60,74 +71,113 @@ 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) - // 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 . + // points, each of which is itself a 2-value array defined in [WGS 84]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]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]. The snapped value is + // available in the result in SnappedDeparturePositions . + // // Valid Values: [-180 to 180,-90 to 90] // + // [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html + // [WGS 84]: https://earth-info.nga.mil/GandG/wgs84/index.html + // [Position restrictions]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits + // // 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) - // 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 . + // each of which is itself a 2-value array defined in [WGS 84]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]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]. The snapped value + // is available in the result in SnappedDestinationPositions . + // // Valid Values: [-180 to 180,-90 to 90] // + // [moves the position to the nearest road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html + // [WGS 84]: https://earth-info.nga.mil/GandG/wgs84/index.html + // [Position restrictions]: https://docs.aws.amazon.com/location/latest/developerguide/calculate-route-matrix.html#matrix-routing-position-limits + // // 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 . + // 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 // 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 + // 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 - // 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 + // calculate the route matrix. + // + // Setting a departure time in the past returns a 400 ValidationException error. + // + // - In [ISO 8601]format: YYYY-MM-DDThh:mm:ss.sssZ . For example, + // 2020–07-2T12:15:20.000Z+01:00 + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html DepartureTime *time.Time - // Set the unit system to specify the distance. Default Value: Kilometers + // Set the unit system to specify the distance. + // + // Default Value: Kilometers DistanceUnit types.DistanceUnit - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *string // 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: + // 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 + // only within Southeast Asia. + // + // Truck is not available for Grab. + // + // For more information about using Grab as a data provider, see [GrabMaps] in the Amazon + // Location Service Developer Guide. + // + // Default Value: Car + // + // [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html TravelMode types.TravelMode // 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 diff --git a/service/location/api_op_CreateGeofenceCollection.go b/service/location/api_op_CreateGeofenceCollection.go index 1da274cd44e..b6786e59ab9 100644 --- a/service/location/api_op_CreateGeofenceCollection.go +++ b/service/location/api_op_CreateGeofenceCollection.go @@ -30,10 +30,15 @@ func (c *Client) CreateGeofenceCollection(ctx context.Context, params *CreateGeo type CreateGeofenceCollectionInput struct { - // A custom name for the geofence collection. Requirements: + // 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 . // // This member is required. @@ -42,8 +47,9 @@ 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]. Enter a key ID, key ARN, alias name, or alias ARN. + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyId *string // No longer used. If included, the only allowed value is RequestBasedUsage . @@ -59,13 +65,22 @@ 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: + // + // 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 @@ -76,6 +91,7 @@ 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 // @@ -87,8 +103,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time diff --git a/service/location/api_op_CreateKey.go b/service/location/api_op_CreateKey.go index 0817da6711e..27caa1503f2 100644 --- a/service/location/api_op_CreateKey.go +++ b/service/location/api_op_CreateKey.go @@ -13,9 +13,11 @@ import ( ) // Creates an API key resource in your Amazon Web Services account, which lets you -// grant actions for Amazon Location resources to the API key bearer. For more -// information, see Using API keys (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) -// . +// grant actions for Amazon Location resources to the API key bearer. +// +// For more information, see [Using API keys]. +// +// [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{} @@ -33,10 +35,15 @@ func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns . type CreateKeyInput struct { - // A custom name for the API key resource. Requirements: + // 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 . // // This member is required. @@ -50,8 +57,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . One of NoExpiry or ExpireTime must be set. + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html ExpireTime *time.Time // Optionally set to true to set no expiration time for the API key. One of @@ -60,13 +69,22 @@ 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: + // + // 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 @@ -75,21 +93,25 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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]. + // + // [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 // // This member is required. diff --git a/service/location/api_op_CreateMap.go b/service/location/api_op_CreateMap.go index c64597065de..820b94684b0 100644 --- a/service/location/api_op_CreateMap.go +++ b/service/location/api_op_CreateMap.go @@ -13,11 +13,13 @@ import ( ) // Creates a map resource in your Amazon Web Services account, which provides map -// 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. +// 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]for more details. +// +// [Amazon Web Services service terms]: http://aws.amazon.com/service-terms func (c *Client) CreateMap(ctx context.Context, params *CreateMapInput, optFns ...func(*Options)) (*CreateMapOutput, error) { if params == nil { params = &CreateMapInput{} @@ -42,10 +44,15 @@ type CreateMapInput struct { // This member is required. Configuration *types.MapConfiguration - // The name for the map resource. Requirements: + // 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 . // // This member is required. @@ -61,14 +68,23 @@ type CreateMapInput struct { PricingPlan types.PricingPlan // 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: + // 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. Tags map[string]string @@ -77,14 +93,17 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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 // // This member is required. diff --git a/service/location/api_op_CreatePlaceIndex.go b/service/location/api_op_CreatePlaceIndex.go index abf3c3ec0d2..bccc4c8a0c5 100644 --- a/service/location/api_op_CreatePlaceIndex.go +++ b/service/location/api_op_CreatePlaceIndex.go @@ -16,11 +16,13 @@ import ( // index resource to geocode addresses and other text queries by using the // SearchPlaceIndexForText operation, and reverse geocode coordinates by using the // 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 -// details. +// 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]for more details. +// +// [Amazon Web Services service terms]: http://aws.amazon.com/service-terms func (c *Client) CreatePlaceIndex(ctx context.Context, params *CreatePlaceIndexInput, optFns ...func(*Options)) (*CreatePlaceIndexOutput, error) { if params == nil { params = &CreatePlaceIndexInput{} @@ -38,33 +40,50 @@ func (c *Client) CreatePlaceIndex(ctx context.Context, params *CreatePlaceIndexI 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) - // . + // 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]'s coverage in your region of + // interest, see [Esri details on geocoding coverage]. + // // - 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. + // additional information about [GrabMaps]' coverage, see [GrabMaps countries and areas covered]. + // + // - Here – For additional information about [HERE Technologies]' coverage in your region of + // interest, see [HERE details on goecoding coverage]. + // + // If you specify HERE Technologies ( Here ) as the data provider, you may not [store results]for + // locations in Japan. For more information, see the [Amazon Web Services Service Terms]for Amazon Location Service. + // + // For additional information , see [Data providers] on the Amazon Location Service Developer + // Guide. + // + // [Amazon Web Services Service Terms]: http://aws.amazon.com/service-terms/ + // [Esri]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html + // [Esri details on geocoding coverage]: https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm + // [HERE Technologies]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html + // [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html + // [Data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html + // [GrabMaps countries and areas covered]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area + // [store results]: https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html + // [HERE details on goecoding coverage]: https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html // // This member is required. DataSource *string - // The name of the place index resource. Requirements: + // 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 . // // This member is required. @@ -83,14 +102,23 @@ type CreatePlaceIndexInput struct { PricingPlan types.PricingPlan // 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: + // 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. Tags map[string]string @@ -99,14 +127,17 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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 // // This member is required. diff --git a/service/location/api_op_CreateRouteCalculator.go b/service/location/api_op_CreateRouteCalculator.go index 710b392c747..8fd933121c0 100644 --- a/service/location/api_op_CreateRouteCalculator.go +++ b/service/location/api_op_CreateRouteCalculator.go @@ -12,14 +12,17 @@ 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, +// 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. +// 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]for more details. +// +// [Amazon Web Services service terms]: http://aws.amazon.com/service-terms func (c *Client) CreateRouteCalculator(ctx context.Context, params *CreateRouteCalculatorInput, optFns ...func(*Options)) (*CreateRouteCalculatorOutput, error) { if params == nil { params = &CreateRouteCalculatorInput{} @@ -37,33 +40,50 @@ func (c *Client) CreateRouteCalculator(ctx context.Context, params *CreateRouteC type CreateRouteCalculatorInput struct { - // The name of the route calculator resource. Requirements: + // 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 . // // This member is required. CalculatorName *string - // 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. + // 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]'s coverage in your region of + // interest, see [Esri details on street networks and traffic coverage]. + // + // 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. + // additional information about [GrabMaps]' coverage, see [GrabMaps countries and areas covered]. + // + // - Here – For additional information about [HERE Technologies]' coverage in your region of + // interest, see [HERE car routing coverage]and [HERE truck routing coverage]. + // + // For additional information , see [Data providers] on the Amazon Location Service Developer + // Guide. + // + // [HERE car routing coverage]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html + // [Esri]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html + // [HERE truck routing coverage]: https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html + // [HERE Technologies]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html + // [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html + // [Esri details on street networks and traffic coverage]: https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm + // [Data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html + // [GrabMaps countries and areas covered]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area // // This member is required. DataSource *string @@ -80,14 +100,24 @@ 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: + // + // 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 @@ -98,6 +128,7 @@ 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 // @@ -105,15 +136,19 @@ type CreateRouteCalculatorOutput struct { CalculatorArn *string // The name of the route calculator resource. + // // - 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 . + // The timestamp when the route calculator resource was created in [ISO 8601] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // // - For example, 2020–07-2T12:15:20.000Z+01:00 // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html + // // This member is required. CreateTime *time.Time diff --git a/service/location/api_op_CreateTracker.go b/service/location/api_op_CreateTracker.go index 2cd735504c0..287a2f5bb47 100644 --- a/service/location/api_op_CreateTracker.go +++ b/service/location/api_op_CreateTracker.go @@ -31,10 +31,15 @@ func (c *Client) CreateTracker(ctx context.Context, params *CreateTrackerInput, type CreateTrackerInput struct { - // The name for the tracker resource. Requirements: + // 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 . // // This member is required. @@ -44,38 +49,50 @@ type CreateTrackerInput struct { Description *string // Whether to enable position UPDATE events from this tracker to be sent to - // EventBridge. You do not need enable this feature to get ENTER and EXIT events - // for geofences with this tracker. Those events are always sent to EventBridge. + // EventBridge. + // + // You do not need enable this feature to get ENTER and EXIT events for geofences + // with this tracker. Those events are always sent to EventBridge. EventBridgeEnabled *bool - // Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS - // customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) - // . This parameter is only used if you are using a KMS customer managed key. If - // you wish to encrypt your data using your own KMS customer managed key, then the - // Bounding Polygon Queries feature will be disabled by default. This is because by - // using this feature, a representation of your device positions will not be - // encrypted using the your KMS managed key. The exact device position, however; is - // still encrypted using your managed key. You can choose to opt-in to the Bounding - // Polygon Quseries feature. This is done by setting the - // KmsKeyEnableGeospatialQueries parameter to true when creating or updating a - // Tracker. + // Enables GeospatialQueries for a tracker that uses a [Amazon Web Services KMS customer managed key]. + // + // This parameter is only used if you are using a KMS customer managed key. + // + // If you wish to encrypt your data using your own KMS customer managed key, then + // the Bounding Polygon Queries feature will be disabled by default. This is + // because by using this feature, a representation of your device positions will + // not be encrypted using the your KMS managed key. The exact device position, + // however; is still encrypted using your managed key. + // + // You can choose to opt-in to the Bounding Polygon Quseries feature. This is done + // by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or + // updating a Tracker. + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyEnableGeospatialQueries *bool - // 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]. Enter a key ID, key ARN, alias name, or alias ARN. + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyId *string - // Specifies the position filtering for the tracker resource. Valid values: + // 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 @@ -83,6 +100,7 @@ type CreateTrackerInput struct { // 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 @@ -99,13 +117,22 @@ 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: + // + // 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 @@ -114,14 +141,17 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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 // // This member is required. diff --git a/service/location/api_op_DeleteGeofenceCollection.go b/service/location/api_op_DeleteGeofenceCollection.go index 59dcb5d3df5..7f90ac23119 100644 --- a/service/location/api_op_DeleteGeofenceCollection.go +++ b/service/location/api_op_DeleteGeofenceCollection.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a geofence collection from your Amazon Web Services account. This -// operation deletes the resource permanently. If the geofence collection is the -// target of a tracker resource, the devices will no longer be monitored. +// Deletes a geofence collection from your Amazon Web Services account. +// +// This operation deletes the resource permanently. If the geofence collection is +// the target of a tracker resource, the devices will no longer be monitored. func (c *Client) DeleteGeofenceCollection(ctx context.Context, params *DeleteGeofenceCollectionInput, optFns ...func(*Options)) (*DeleteGeofenceCollectionOutput, error) { if params == nil { params = &DeleteGeofenceCollectionInput{} diff --git a/service/location/api_op_DeleteKey.go b/service/location/api_op_DeleteKey.go index 23e69f6c761..1ea32b6c60a 100644 --- a/service/location/api_op_DeleteKey.go +++ b/service/location/api_op_DeleteKey.go @@ -36,9 +36,14 @@ type DeleteKeyInput struct { // ForceDelete bypasses an API key's expiry conditions and deletes the key. Set // the parameter true to delete the key or to false to not preemptively delete the - // API key. Valid values: true , or false . Required: No This action is - // irreversible. Only use ForceDelete if you are certain the key is no longer in - // use. + // API key. + // + // Valid values: true , or false . + // + // Required: No + // + // This action is irreversible. Only use ForceDelete if you are certain the key is + // no longer in use. ForceDelete *bool noSmithyDocumentSerde diff --git a/service/location/api_op_DeleteMap.go b/service/location/api_op_DeleteMap.go index 332007f7ed2..8b5b3a39535 100644 --- a/service/location/api_op_DeleteMap.go +++ b/service/location/api_op_DeleteMap.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a map resource from your Amazon Web Services account. This operation -// deletes the resource permanently. If the map is being used in an application, -// the map may not render. +// Deletes a map resource from your Amazon Web Services account. +// +// This operation deletes the resource permanently. If the map is being used in an +// application, the map may not render. func (c *Client) DeleteMap(ctx context.Context, params *DeleteMapInput, optFns ...func(*Options)) (*DeleteMapOutput, error) { if params == nil { params = &DeleteMapInput{} diff --git a/service/location/api_op_DeletePlaceIndex.go b/service/location/api_op_DeletePlaceIndex.go index fca5dbfa8e1..53de802355f 100644 --- a/service/location/api_op_DeletePlaceIndex.go +++ b/service/location/api_op_DeletePlaceIndex.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a place index resource from your Amazon Web Services account. This -// operation deletes the resource permanently. +// Deletes a place index resource from your Amazon Web Services account. +// +// This operation deletes the resource permanently. func (c *Client) DeletePlaceIndex(ctx context.Context, params *DeletePlaceIndexInput, optFns ...func(*Options)) (*DeletePlaceIndexOutput, error) { if params == nil { params = &DeletePlaceIndexInput{} diff --git a/service/location/api_op_DeleteRouteCalculator.go b/service/location/api_op_DeleteRouteCalculator.go index e62b301078c..5672bacbec5 100644 --- a/service/location/api_op_DeleteRouteCalculator.go +++ b/service/location/api_op_DeleteRouteCalculator.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a route calculator resource from your Amazon Web Services account. This -// operation deletes the resource permanently. +// Deletes a route calculator resource from your Amazon Web Services account. +// +// This operation deletes the resource permanently. func (c *Client) DeleteRouteCalculator(ctx context.Context, params *DeleteRouteCalculatorInput, optFns ...func(*Options)) (*DeleteRouteCalculatorOutput, error) { if params == nil { params = &DeleteRouteCalculatorInput{} diff --git a/service/location/api_op_DeleteTracker.go b/service/location/api_op_DeleteTracker.go index f37acd7b263..802c58f799c 100644 --- a/service/location/api_op_DeleteTracker.go +++ b/service/location/api_op_DeleteTracker.go @@ -10,9 +10,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 +// 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 { diff --git a/service/location/api_op_DescribeGeofenceCollection.go b/service/location/api_op_DescribeGeofenceCollection.go index 9e0bb135177..c16cffc0895 100644 --- a/service/location/api_op_DescribeGeofenceCollection.go +++ b/service/location/api_op_DescribeGeofenceCollection.go @@ -42,6 +42,7 @@ 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 // @@ -53,8 +54,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -64,8 +67,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -73,8 +78,9 @@ type DescribeGeofenceCollectionOutput struct { // The number of geofences in the geofence collection. GeofenceCount *int32 - // 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 + // A key identifier for an [Amazon Web Services KMS customer managed key] assigned to the Amazon Location resource + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyId *string // No longer used. Always returns RequestBasedUsage . diff --git a/service/location/api_op_DescribeKey.go b/service/location/api_op_DescribeKey.go index d7cbf9b871e..c5d876b160c 100644 --- a/service/location/api_op_DescribeKey.go +++ b/service/location/api_op_DescribeKey.go @@ -40,14 +40,18 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. ExpireTime *time.Time @@ -59,6 +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 // // This member is required. @@ -75,8 +80,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_DescribeMap.go b/service/location/api_op_DescribeMap.go index e6fe4af67f4..67293ce72c2 100644 --- a/service/location/api_op_DescribeMap.go +++ b/service/location/api_op_DescribeMap.go @@ -45,8 +45,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -63,6 +65,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 // // This member is required. @@ -73,8 +76,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_DescribePlaceIndex.go b/service/location/api_op_DescribePlaceIndex.go index 67d7aae800d..78873868b54 100644 --- a/service/location/api_op_DescribePlaceIndex.go +++ b/service/location/api_op_DescribePlaceIndex.go @@ -40,19 +40,25 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -69,6 +75,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 // // This member is required. @@ -79,8 +86,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_DescribeRouteCalculator.go b/service/location/api_op_DescribeRouteCalculator.go index bbee9a57111..78e20ebe06e 100644 --- a/service/location/api_op_DescribeRouteCalculator.go +++ b/service/location/api_op_DescribeRouteCalculator.go @@ -42,6 +42,7 @@ 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 // @@ -53,21 +54,28 @@ 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 . + // The timestamp when the route calculator resource was created in [ISO 8601] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // // - For example, 2020–07-2T12:15:20.000Z+01:00 // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html + // // 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -77,10 +85,13 @@ 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 . + // The timestamp when the route calculator resource was last updated in [ISO 8601] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // // - For example, 2020–07-2T12:15:20.000Z+01:00 // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html + // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_DescribeTracker.go b/service/location/api_op_DescribeTracker.go index 88c1e9fb0cd..f182b3d0983 100644 --- a/service/location/api_op_DescribeTracker.go +++ b/service/location/api_op_DescribeTracker.go @@ -40,8 +40,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -53,6 +55,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 // // This member is required. @@ -63,8 +66,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -73,21 +78,26 @@ type DescribeTrackerOutput struct { // true these events will be sent to EventBridge. EventBridgeEnabled *bool - // Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS - // customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) - // . This parameter is only used if you are using a KMS customer managed key. If - // you wish to encrypt your data using your own KMS customer managed key, then the - // Bounding Polygon Queries feature will be disabled by default. This is because by - // using this feature, a representation of your device positions will not be - // encrypted using the your KMS managed key. The exact device position, however; is - // still encrypted using your managed key. You can choose to opt-in to the Bounding - // Polygon Quseries feature. This is done by setting the - // KmsKeyEnableGeospatialQueries parameter to true when creating or updating a - // Tracker. + // Enables GeospatialQueries for a tracker that uses a [Amazon Web Services KMS customer managed key]. + // + // This parameter is only used if you are using a KMS customer managed key. + // + // If you wish to encrypt your data using your own KMS customer managed key, then + // the Bounding Polygon Queries feature will be disabled by default. This is + // because by using this feature, a representation of your device positions will + // not be encrypted using the your KMS managed key. The exact device position, + // however; is still encrypted using your managed key. + // + // You can choose to opt-in to the Bounding Polygon Quseries feature. This is done + // by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or + // updating a Tracker. + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyEnableGeospatialQueries *bool - // 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. + // A key identifier for an [Amazon Web Services KMS customer managed key] assigned to the Amazon Location resource. + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyId *string // The position filtering method of the tracker resource. diff --git a/service/location/api_op_DisassociateTrackerConsumer.go b/service/location/api_op_DisassociateTrackerConsumer.go index 1ef76fc8053..7a0330bbb39 100644 --- a/service/location/api_op_DisassociateTrackerConsumer.go +++ b/service/location/api_op_DisassociateTrackerConsumer.go @@ -11,6 +11,7 @@ import ( ) // Removes the association between a tracker resource and a geofence collection. +// // Once you unlink a tracker resource from a geofence collection, the tracker // positions will no longer be automatically evaluated against geofences. func (c *Client) DisassociateTrackerConsumer(ctx context.Context, params *DisassociateTrackerConsumerInput, optFns ...func(*Options)) (*DisassociateTrackerConsumerOutput, error) { @@ -33,6 +34,7 @@ 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 // diff --git a/service/location/api_op_GetDevicePosition.go b/service/location/api_op_GetDevicePosition.go index fedd5b17bad..8ad2436ccbc 100644 --- a/service/location/api_op_GetDevicePosition.go +++ b/service/location/api_op_GetDevicePosition.go @@ -12,8 +12,9 @@ import ( "time" ) -// Retrieves a device's most recent position according to its sample time. Device -// positions are deleted after 30 days. +// Retrieves a device's most recent position according to its sample time. +// +// Device positions are deleted after 30 days. func (c *Client) GetDevicePosition(ctx context.Context, params *GetDevicePositionInput, optFns ...func(*Options)) (*GetDevicePositionOutput, error) { if params == nil { params = &GetDevicePositionInput{} @@ -51,15 +52,18 @@ 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] + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. SampleTime *time.Time diff --git a/service/location/api_op_GetDevicePositionHistory.go b/service/location/api_op_GetDevicePositionHistory.go index 749cb361537..5e9ebf017b9 100644 --- a/service/location/api_op_GetDevicePositionHistory.go +++ b/service/location/api_op_GetDevicePositionHistory.go @@ -13,7 +13,9 @@ import ( ) // Retrieves the device position history from a tracker resource within a -// specified range of time. Device positions are deleted after 30 days. +// 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{} @@ -41,26 +43,38 @@ 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: + // Specify the end time for the position history in [ISO 8601] 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 . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html 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 + // 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: + // Specify the start time for the position history in [ISO 8601] 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 . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html StartTimeInclusive *time.Time noSmithyDocumentSerde @@ -204,6 +218,7 @@ var _ GetDevicePositionHistoryAPIClient = (*Client)(nil) // GetDevicePositionHistory type GetDevicePositionHistoryPaginatorOptions struct { // An optional limit for the number of device positions returned in a single call. + // // Default value: 100 Limit int32 diff --git a/service/location/api_op_GetGeofence.go b/service/location/api_op_GetGeofence.go index 1304f1caf9d..8a4be13827c 100644 --- a/service/location/api_op_GetGeofence.go +++ b/service/location/api_op_GetGeofence.go @@ -45,8 +45,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -63,23 +65,31 @@ 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. // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time // User defined properties of the geofence. A property is a key-value pair stored // with the geofence and added to any geofence event triggered with that geofence. + // // Format: "key" : "value" GeofenceProperties map[string]string diff --git a/service/location/api_op_GetMapGlyphs.go b/service/location/api_op_GetMapGlyphs.go index cfb1eab4e46..85ea896d1e4 100644 --- a/service/location/api_op_GetMapGlyphs.go +++ b/service/location/api_op_GetMapGlyphs.go @@ -29,29 +29,39 @@ 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 font stacks for Esri (https://docs.aws.amazon.com/location/latest/developerguide/esri.html) - // styles: + // example, Noto Sans Regular, Arial Unicode . + // + // Valid font stacks for [Esri] 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 | Arial // Unicode MS Bold | Arial Unicode MS Regular - // Valid font stacks for HERE Technologies (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) - // styles: + // + // Valid font stacks for [HERE Technologies] 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) - // styles: + // + // Valid font stacks for [GrabMaps] 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) - // styles: + // + // Valid font stacks for [Open Data] styles: + // // - VectorOpenDataStandardLight, VectorOpenDataStandardDark, // VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – Amazon // Ember Regular,Noto Sans Regular | Amazon Ember Bold,Noto Sans Bold | Amazon @@ -63,9 +73,15 @@ type GetMapGlyphsInput struct { // | Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular | // Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed // Regular | Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium + // // 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 . // + // [Esri]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html + // [HERE Technologies]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html + // [GrabMaps]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html + // [Open Data]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html + // // This member is required. FontStack *string @@ -81,8 +97,9 @@ type GetMapGlyphsInput struct { // This member is required. MapName *string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *string noSmithyDocumentSerde diff --git a/service/location/api_op_GetMapSprites.go b/service/location/api_op_GetMapSprites.go index 82b997c849f..ff53acf7be6 100644 --- a/service/location/api_op_GetMapSprites.go +++ b/service/location/api_op_GetMapSprites.go @@ -31,10 +31,15 @@ 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 // // This member is required. @@ -45,8 +50,9 @@ type GetMapSpritesInput struct { // This member is required. MapName *string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *string noSmithyDocumentSerde diff --git a/service/location/api_op_GetMapStyleDescriptor.go b/service/location/api_op_GetMapStyleDescriptor.go index 566a7ddfe98..7577592a9f8 100644 --- a/service/location/api_op_GetMapStyleDescriptor.go +++ b/service/location/api_op_GetMapStyleDescriptor.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the map style descriptor from a map resource. The style descriptor -// contains specifications on how features render on a map. For example, what data -// to display, what order to display the data in, and the style for the data. Style -// descriptors follow the Mapbox Style Specification. +// Retrieves the map style descriptor from a map resource. +// +// The style descriptor contains specifications on how features render on a map. +// For example, what data to display, what order to display the data in, and the +// style for the data. Style descriptors follow the Mapbox Style Specification. func (c *Client) GetMapStyleDescriptor(ctx context.Context, params *GetMapStyleDescriptorInput, optFns ...func(*Options)) (*GetMapStyleDescriptorOutput, error) { if params == nil { params = &GetMapStyleDescriptorInput{} @@ -36,8 +37,9 @@ type GetMapStyleDescriptorInput struct { // This member is required. MapName *string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *string noSmithyDocumentSerde diff --git a/service/location/api_op_GetMapTile.go b/service/location/api_op_GetMapTile.go index 945302f1e32..31484f685c6 100644 --- a/service/location/api_op_GetMapTile.go +++ b/service/location/api_op_GetMapTile.go @@ -12,10 +12,12 @@ import ( // Retrieves a vector data tile from the map resource. Map tiles are used by // clients to render a map. they're addressed using a grid arrangement with an X -// coordinate, Y coordinate, and Z (zoom) level. The origin (0, 0) is the top left -// of the map. Increasing the zoom level by 1 doubles both the X and Y dimensions, -// so a tile containing data for the entire world at (0/0/0) will be split into 4 -// tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, 1/1/1). +// coordinate, Y coordinate, and Z (zoom) level. +// +// The origin (0, 0) is the top left of the map. Increasing the zoom level by 1 +// doubles both the X and Y dimensions, so a tile containing data for the entire +// world at (0/0/0) will be split into 4 tiles at zoom 1 (1/0/0, 1/0/1, 1/1/0, +// 1/1/1). func (c *Client) GetMapTile(ctx context.Context, params *GetMapTileInput, optFns ...func(*Options)) (*GetMapTileOutput, error) { if params == nil { params = &GetMapTileInput{} @@ -53,8 +55,9 @@ type GetMapTileInput struct { // This member is required. Z *string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *string noSmithyDocumentSerde diff --git a/service/location/api_op_GetPlace.go b/service/location/api_op_GetPlace.go index 01cb5a769f3..61942b39abb 100644 --- a/service/location/api_op_GetPlace.go +++ b/service/location/api_op_GetPlace.go @@ -12,10 +12,15 @@ 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 . +// 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 func (c *Client) GetPlace(ctx context.Context, params *GetPlaceInput, optFns ...func(*Options)) (*GetPlaceOutput, error) { if params == nil { @@ -39,22 +44,28 @@ type GetPlaceInput struct { // This member is required. IndexName *string - // The identifier of the place to find. While you can use PlaceID in subsequent - // requests, PlaceID is not intended to be a permanent identifier and the ID can - // change between consecutive API calls. Please see the following PlaceID behaviour - // for each data provider: + // The identifier of the place to find. + // + // While you can use PlaceID in subsequent requests, PlaceID is not intended to be + // a permanent identifier and the ID can change between consecutive API calls. + // Please see the following PlaceID behaviour for each data provider: + // // - Esri: Place IDs will change every quarter at a minimum. The typical time // period for these changes would be March, June, September, and December. Place // IDs might also change between the typical quarterly change but that will be much // less frequent. + // // - HERE: We recommend that you cache data for no longer than a week to keep // your data data fresh. You can assume that less than 1% ID shifts will release // over release which is approximately 1 - 2 times per week. + // // - Grab: Place IDs can expire or become invalid in the following situations. + // // - Data operations: The POI may be removed from Grab POI database by Grab Map // Ops based on the ground-truth, such as being closed in the real world, being // detected as a duplicate POI, or having incorrect information. Grab will // synchronize data to the Waypoint environment on weekly basis. + // // - Interpolated POI: Interpolated POI is a temporary POI generated in real // time when serving a request, and it will be marked as derived in the // place.result_type field in the response. The information of interpolated POIs @@ -66,21 +77,29 @@ type GetPlaceInput struct { // This member is required. PlaceId *string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *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] + // 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. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string noSmithyDocumentSerde diff --git a/service/location/api_op_ListDevicePositions.go b/service/location/api_op_ListDevicePositions.go index cbc94908425..95c5ad386d6 100644 --- a/service/location/api_op_ListDevicePositions.go +++ b/service/location/api_op_ListDevicePositions.go @@ -37,13 +37,15 @@ type ListDevicePositionsInput struct { // The geometry used to filter device positions. FilterGeometry *types.TrackingFilterGeometry - // An optional limit for the number of entries returned in a single call. Default - // value: 100 + // An optional limit for the number of entries 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -186,8 +188,9 @@ var _ ListDevicePositionsAPIClient = (*Client)(nil) // ListDevicePositionsPaginatorOptions is the paginator options for // ListDevicePositions type ListDevicePositionsPaginatorOptions struct { - // An optional limit for the number of entries returned in a single call. Default - // value: 100 + // An optional limit for the number of entries 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_ListGeofenceCollections.go b/service/location/api_op_ListGeofenceCollections.go index c195b22e4b4..4214bcc31b0 100644 --- a/service/location/api_op_ListGeofenceCollections.go +++ b/service/location/api_op_ListGeofenceCollections.go @@ -30,12 +30,14 @@ 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 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -176,6 +178,7 @@ var _ ListGeofenceCollectionsAPIClient = (*Client)(nil) // ListGeofenceCollections type ListGeofenceCollectionsPaginatorOptions struct { // An optional limit for the number of resources returned in a single call. + // // Default value: 100 Limit int32 diff --git a/service/location/api_op_ListGeofences.go b/service/location/api_op_ListGeofences.go index 04669ef2d5f..0878879f4e7 100644 --- a/service/location/api_op_ListGeofences.go +++ b/service/location/api_op_ListGeofences.go @@ -35,12 +35,14 @@ type ListGeofencesInput struct { CollectionName *string // 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -182,6 +184,7 @@ 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 Limit int32 diff --git a/service/location/api_op_ListKeys.go b/service/location/api_op_ListKeys.go index 3048af09e47..2dca53de3af 100644 --- a/service/location/api_op_ListKeys.go +++ b/service/location/api_op_ListKeys.go @@ -33,12 +33,14 @@ type ListKeysInput struct { Filter *types.ApiKeyFilter // 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -178,6 +180,7 @@ 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 Limit int32 diff --git a/service/location/api_op_ListMaps.go b/service/location/api_op_ListMaps.go index 28d32a8c070..290208a4645 100644 --- a/service/location/api_op_ListMaps.go +++ b/service/location/api_op_ListMaps.go @@ -30,12 +30,14 @@ 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 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -174,6 +176,7 @@ 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 Limit int32 diff --git a/service/location/api_op_ListPlaceIndexes.go b/service/location/api_op_ListPlaceIndexes.go index 2e6fa0e9940..9e1db59b405 100644 --- a/service/location/api_op_ListPlaceIndexes.go +++ b/service/location/api_op_ListPlaceIndexes.go @@ -30,12 +30,14 @@ func (c *Client) ListPlaceIndexes(ctx context.Context, params *ListPlaceIndexesI type ListPlaceIndexesInput struct { // An optional limit for the maximum number of results 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -175,6 +177,7 @@ var _ ListPlaceIndexesAPIClient = (*Client)(nil) // ListPlaceIndexesPaginatorOptions is the paginator options for ListPlaceIndexes type ListPlaceIndexesPaginatorOptions struct { // An optional limit for the maximum number of results returned in a single call. + // // Default value: 100 Limit int32 diff --git a/service/location/api_op_ListRouteCalculators.go b/service/location/api_op_ListRouteCalculators.go index 2262398a256..1482c5a5f81 100644 --- a/service/location/api_op_ListRouteCalculators.go +++ b/service/location/api_op_ListRouteCalculators.go @@ -29,13 +29,15 @@ func (c *Client) ListRouteCalculators(ctx context.Context, params *ListRouteCalc type ListRouteCalculatorsInput struct { - // An optional maximum number of results returned in a single call. Default Value: - // 100 + // An optional maximum number of results 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 + // response. If no token is provided, the default page is the first page. + // + // Default Value: null NextToken *string noSmithyDocumentSerde @@ -176,8 +178,9 @@ var _ ListRouteCalculatorsAPIClient = (*Client)(nil) // ListRouteCalculatorsPaginatorOptions is the paginator options for // ListRouteCalculators type ListRouteCalculatorsPaginatorOptions struct { - // An optional maximum number of results returned in a single call. Default Value: - // 100 + // An optional maximum number of results 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_ListTagsForResource.go b/service/location/api_op_ListTagsForResource.go index e9ab7e30d8b..ad940103d55 100644 --- a/service/location/api_op_ListTagsForResource.go +++ b/service/location/api_op_ListTagsForResource.go @@ -30,6 +30,7 @@ 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 // // This member is required. @@ -42,6 +43,7 @@ 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"} Tags map[string]string diff --git a/service/location/api_op_ListTrackerConsumers.go b/service/location/api_op_ListTrackerConsumers.go index 6538cf0bbb3..5ab897a77c0 100644 --- a/service/location/api_op_ListTrackerConsumers.go +++ b/service/location/api_op_ListTrackerConsumers.go @@ -34,12 +34,14 @@ type ListTrackerConsumersInput struct { TrackerName *string // 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -184,6 +186,7 @@ var _ ListTrackerConsumersAPIClient = (*Client)(nil) // ListTrackerConsumers type ListTrackerConsumersPaginatorOptions struct { // An optional limit for the number of resources returned in a single call. + // // Default value: 100 Limit int32 diff --git a/service/location/api_op_ListTrackers.go b/service/location/api_op_ListTrackers.go index c4be70e6da3..b7db236a312 100644 --- a/service/location/api_op_ListTrackers.go +++ b/service/location/api_op_ListTrackers.go @@ -30,12 +30,14 @@ 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 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 + // response. If no token is provided, the default page is the first page. + // + // Default value: null NextToken *string noSmithyDocumentSerde @@ -176,6 +178,7 @@ 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 Limit int32 diff --git a/service/location/api_op_PutGeofence.go b/service/location/api_op_PutGeofence.go index 356f8ea1c36..fb08bc49253 100644 --- a/service/location/api_op_PutGeofence.go +++ b/service/location/api_op_PutGeofence.go @@ -42,16 +42,20 @@ type PutGeofenceInput struct { 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) - // can have a maximum of 1,000 vertices. + // polygon or a circle. Including both will return a validation error. + // + // Each [geofence polygon] can have a maximum of 1,000 vertices. + // + // [geofence polygon]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html // // This member is required. Geometry *types.GeofenceGeometry // Associates one of more properties with the geofence. A property is a key-value // pair stored with the geofence and added to any geofence event triggered with - // that geofence. Format: "key" : "value" + // that geofence. + // + // Format: "key" : "value" GeofenceProperties map[string]string noSmithyDocumentSerde @@ -59,8 +63,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -70,8 +76,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_SearchPlaceIndexForPosition.go b/service/location/api_op_SearchPlaceIndexForPosition.go index 5c0727b468f..4039d8785ef 100644 --- a/service/location/api_op_SearchPlaceIndexForPosition.go +++ b/service/location/api_op_SearchPlaceIndexForPosition.go @@ -35,33 +35,45 @@ type SearchPlaceIndexForPositionInput struct { // This member is required. IndexName *string - // 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 + // 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 . // // This member is required. Position []float64 - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *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] + // 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. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string // An optional parameter. The maximum number of results returned per request. + // // Default value: 50 MaxResults *int32 diff --git a/service/location/api_op_SearchPlaceIndexForSuggestions.go b/service/location/api_op_SearchPlaceIndexForSuggestions.go index 3e9768b6bf7..d9c94262862 100644 --- a/service/location/api_op_SearchPlaceIndexForSuggestions.go +++ b/service/location/api_op_SearchPlaceIndexForSuggestions.go @@ -13,12 +13,15 @@ import ( // Generates suggestions for addresses and points of interest based on partial or // misspelled free-form text. This operation is also known as autocomplete, -// 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. +// 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. func (c *Client) SearchPlaceIndexForSuggestions(ctx context.Context, params *SearchPlaceIndexForSuggestionsInput, optFns ...func(*Options)) (*SearchPlaceIndexForSuggestionsOutput, error) { if params == nil { params = &SearchPlaceIndexForSuggestionsInput{} @@ -48,58 +51,83 @@ type SearchPlaceIndexForSuggestionsInput struct { 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. + // 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 - // suggestions within a specified bounding box. If provided, this parameter must - // contain a total of four consecutive numbers in two pairs. The first pair of - // numbers represents the X and Y coordinates (longitude and latitude, - // respectively) of the southwest corner of the bounding box; the second pair of - // 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. + // suggestions within a specified bounding box. + // + // If provided, this parameter must contain a total of four consecutive numbers in + // two pairs. The first pair of numbers represents the X and Y coordinates + // (longitude and latitude, respectively) of the southwest corner of the bounding + // box; the second pair of 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. FilterBBox []float64 // A list of one or more Amazon Location categories to filter the returned places. // If you include more than one category, the results will include results that - // match any of the categories listed. For more information about using categories, - // including a list of Amazon Location categories, see Categories and filtering (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html) - // , in the Amazon Location Service Developer Guide. + // match any of the categories listed. + // + // For more information about using categories, including a list of Amazon + // Location categories, see [Categories and filtering], in the Amazon Location Service Developer Guide. + // + // [Categories and filtering]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html FilterCategories []string // 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]3-digit country code. For example, Australia uses three upper-case + // characters: AUS . + // + // [ISO 3166]: https://www.iso.org/iso-3166-country-codes.html FilterCountries []string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *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. + // The preferred language used to return results. The value must be a valid [BCP 47] + // 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 Αθήνα, Ελλάδα . + // 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. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string - // An optional parameter. The maximum number of results returned per request. The - // default: 5 + // An optional parameter. The maximum number of results returned per request. + // + // The default: 5 MaxResults *int32 noSmithyDocumentSerde diff --git a/service/location/api_op_SearchPlaceIndexForText.go b/service/location/api_op_SearchPlaceIndexForText.go index 04889c90b9c..b3ea8e84ddf 100644 --- a/service/location/api_op_SearchPlaceIndexForText.go +++ b/service/location/api_op_SearchPlaceIndexForText.go @@ -12,12 +12,16 @@ import ( ) // Geocodes free-form text, such as an address, name, city, or region to allow you -// 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 . -// Providing both parameters simultaneously returns an error. Search results are -// returned in order of highest to lowest relevance. +// 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 . 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) { if params == nil { params = &SearchPlaceIndexForTextInput{} @@ -47,59 +51,83 @@ type SearchPlaceIndexForTextInput struct { Text *string // An optional parameter that indicates a preference for places 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 . + // 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 places - // that are within the provided bounding box. If provided, this parameter must - // contain a total of four consecutive numbers in two pairs. The first pair of - // numbers represents the X and Y coordinates (longitude and latitude, - // respectively) of the southwest corner of the bounding box; the second pair of - // 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. + // that are within the provided bounding box. + // + // If provided, this parameter must contain a total of four consecutive numbers in + // two pairs. The first pair of numbers represents the X and Y coordinates + // (longitude and latitude, respectively) of the southwest corner of the bounding + // box; the second pair of 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. FilterBBox []float64 // A list of one or more Amazon Location categories to filter the returned places. // If you include more than one category, the results will include results that - // match any of the categories listed. For more information about using categories, - // including a list of Amazon Location categories, see Categories and filtering (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html) - // , in the Amazon Location Service Developer Guide. + // match any of the categories listed. + // + // For more information about using categories, including a list of Amazon + // Location categories, see [Categories and filtering], in the Amazon Location Service Developer Guide. + // + // [Categories and filtering]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html FilterCategories []string // 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]3-digit country codes. For example, Australia uses + // three upper-case characters: AUS . + // + // [ISO 3166]: https://www.iso.org/iso-3166-country-codes.html FilterCountries []string - // The optional API key (https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html) - // to authorize the request. + // The optional [API key] to authorize the request. + // + // [API key]: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html Key *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] + // 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. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string - // An optional parameter. The maximum number of results returned per request. The - // default: 50 + // An optional parameter. The maximum number of results returned per request. + // + // The default: 50 MaxResults *int32 noSmithyDocumentSerde @@ -108,9 +136,10 @@ type SearchPlaceIndexForTextInput struct { type SearchPlaceIndexForTextOutput struct { // A list of Places matching the input text. Each result contains additional - // information about the specific point of interest. Not all response properties - // are included with all responses. Some properties may only be returned by - // specific data partners. + // information about the specific point of interest. + // + // Not all response properties are included with all responses. Some properties + // may only be returned by specific data partners. // // This member is required. Results []types.SearchForTextResult diff --git a/service/location/api_op_TagResource.go b/service/location/api_op_TagResource.go index 9603816c786..76ae8207ca2 100644 --- a/service/location/api_op_TagResource.go +++ b/service/location/api_op_TagResource.go @@ -11,15 +11,19 @@ import ( ) // Assigns one or more tags (key-value pairs) to the specified Amazon Location -// Service resource. 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 the -// TagResource operation with an Amazon Location Service resource that already has -// tags. If you specify a new tag key for the resource, this tag is appended to the -// tags already associated with the resource. If you specify a tag key that's -// already associated with the resource, the new tag value that you specify -// replaces the previous value for that tag. You can associate up to 50 tags with a -// resource. +// Service resource. +// +// 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 the TagResource operation with an Amazon Location Service resource +// that already has tags. If you specify a new tag key for the resource, this tag +// is appended to the tags already associated with the resource. If you specify a +// tag key that's already associated with the resource, the new tag value that you +// specify replaces the previous value for that tag. +// +// You can associate up to 50 tags with a resource. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -38,20 +42,30 @@ 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 // // This member is required. ResourceArn *string // 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: + // 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. // // This member is required. diff --git a/service/location/api_op_UntagResource.go b/service/location/api_op_UntagResource.go index 876723c7acf..4ee7809af0d 100644 --- a/service/location/api_op_UntagResource.go +++ b/service/location/api_op_UntagResource.go @@ -30,6 +30,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 // // This member is required. diff --git a/service/location/api_op_UpdateGeofenceCollection.go b/service/location/api_op_UpdateGeofenceCollection.go index 53c11c46a14..276ebc80713 100644 --- a/service/location/api_op_UpdateGeofenceCollection.go +++ b/service/location/api_op_UpdateGeofenceCollection.go @@ -56,6 +56,7 @@ 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 // @@ -67,8 +68,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateKey.go b/service/location/api_op_UpdateKey.go index ee528baec1b..cab72a3ed37 100644 --- a/service/location/api_op_UpdateKey.go +++ b/service/location/api_op_UpdateKey.go @@ -38,13 +38,20 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html 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 @@ -61,6 +68,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 // // This member is required. @@ -71,8 +79,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateMap.go b/service/location/api_op_UpdateMap.go index 70d7756bd97..74396a7ede0 100644 --- a/service/location/api_op_UpdateMap.go +++ b/service/location/api_op_UpdateMap.go @@ -55,6 +55,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 // // This member is required. @@ -65,8 +66,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdatePlaceIndex.go b/service/location/api_op_UpdatePlaceIndex.go index 132bf59bc48..4be6c0f00c9 100644 --- a/service/location/api_op_UpdatePlaceIndex.go +++ b/service/location/api_op_UpdatePlaceIndex.go @@ -54,6 +54,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 // // This member is required. @@ -64,8 +65,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateRouteCalculator.go b/service/location/api_op_UpdateRouteCalculator.go index 8f54b74475c..5ac62c649f4 100644 --- a/service/location/api_op_UpdateRouteCalculator.go +++ b/service/location/api_op_UpdateRouteCalculator.go @@ -51,6 +51,7 @@ 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 // @@ -62,8 +63,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/api_op_UpdateTracker.go b/service/location/api_op_UpdateTracker.go index dfaa2bb2a15..37b0d913024 100644 --- a/service/location/api_op_UpdateTracker.go +++ b/service/location/api_op_UpdateTracker.go @@ -39,26 +39,35 @@ type UpdateTrackerInput struct { Description *string // Whether to enable position UPDATE events from this tracker to be sent to - // EventBridge. You do not need enable this feature to get ENTER and EXIT events - // for geofences with this tracker. Those events are always sent to EventBridge. + // EventBridge. + // + // You do not need enable this feature to get ENTER and EXIT events for geofences + // with this tracker. Those events are always sent to EventBridge. EventBridgeEnabled *bool - // Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS - // customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) - // . This parameter is only used if you are using a KMS customer managed key. + // Enables GeospatialQueries for a tracker that uses a [Amazon Web Services KMS customer managed key]. + // + // This parameter is only used if you are using a KMS customer managed key. + // + // [Amazon Web Services KMS customer managed key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html KmsKeyEnableGeospatialQueries *bool - // Updates the position filtering for the tracker resource. Valid values: + // 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 @@ -86,6 +95,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 // // This member is required. @@ -96,8 +106,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time diff --git a/service/location/options.go b/service/location/options.go index b2f09612356..d1b175c5f46 100644 --- a/service/location/options.go +++ b/service/location/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/location/types/enums.go b/service/location/types/enums.go index 9a8b0fa83af..a405e881a8b 100644 --- a/service/location/types/enums.go +++ b/service/location/types/enums.go @@ -5,8 +5,9 @@ package types type BatchItemErrorCode string // Values returns all known values for BatchItemErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchItemErrorCode) Values() []BatchItemErrorCode { return []BatchItemErrorCode{ "AccessDeniedError", @@ -21,8 +22,9 @@ func (BatchItemErrorCode) Values() []BatchItemErrorCode { type DimensionUnit string // Values returns all known values for DimensionUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionUnit) Values() []DimensionUnit { return []DimensionUnit{ "Meters", @@ -33,8 +35,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. +// expanded in the future, and so 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", @@ -45,8 +48,9 @@ func (DistanceUnit) Values() []DistanceUnit { type IntendedUse string // Values returns all known values for IntendedUse. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntendedUse) Values() []IntendedUse { return []IntendedUse{ "SingleUse", @@ -57,8 +61,9 @@ func (IntendedUse) Values() []IntendedUse { type OptimizationMode string // Values returns all known values for OptimizationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptimizationMode) Values() []OptimizationMode { return []OptimizationMode{ "FastestRoute", @@ -69,8 +74,9 @@ func (OptimizationMode) Values() []OptimizationMode { type PositionFiltering string // Values returns all known values for PositionFiltering. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionFiltering) Values() []PositionFiltering { return []PositionFiltering{ "TimeBased", @@ -82,8 +88,9 @@ func (PositionFiltering) Values() []PositionFiltering { type PricingPlan string // Values returns all known values for PricingPlan. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingPlan) Values() []PricingPlan { return []PricingPlan{ "RequestBasedUsage", @@ -95,8 +102,9 @@ func (PricingPlan) Values() []PricingPlan { type RouteMatrixErrorCode string // Values returns all known values for RouteMatrixErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteMatrixErrorCode) Values() []RouteMatrixErrorCode { return []RouteMatrixErrorCode{ "RouteNotFound", @@ -111,8 +119,9 @@ func (RouteMatrixErrorCode) Values() []RouteMatrixErrorCode { type Status string // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "Active", @@ -123,8 +132,9 @@ func (Status) Values() []Status { type TravelMode string // Values returns all known values for TravelMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TravelMode) Values() []TravelMode { return []TravelMode{ "Car", @@ -139,6 +149,7 @@ type ValidationExceptionReason string // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -153,8 +164,9 @@ func (ValidationExceptionReason) Values() []ValidationExceptionReason { type VehicleWeightUnit string // Values returns all known values for VehicleWeightUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VehicleWeightUnit) Values() []VehicleWeightUnit { return []VehicleWeightUnit{ "Kilograms", diff --git a/service/location/types/errors.go b/service/location/types/errors.go index cfcbe84270d..348574c2c1c 100644 --- a/service/location/types/errors.go +++ b/service/location/types/errors.go @@ -113,8 +113,10 @@ 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) -// set for Amazon Location Service. +// The operation was denied because the request would exceed the maximum [quota] set for +// Amazon Location Service. +// +// [quota]: https://docs.aws.amazon.com/location/latest/developerguide/location-quotas.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/location/types/types.go b/service/location/types/types.go index 02b7bab8f77..dea8e3ef9ad 100644 --- a/service/location/types/types.go +++ b/service/location/types/types.go @@ -23,18 +23,30 @@ type ApiKeyRestrictions struct { // A list of allowed actions that an API key resource grants permissions to // perform. You must have at least one action for each type of resource. For // example, if you have a place resource, you must include at least one place - // action. The following are valid values for the actions. + // action. + // + // The following are valid values for the actions. + // // - Map actions + // // - geo:GetMap* - Allows all actions needed for map rendering. + // // - Place actions + // // - geo:SearchPlaceIndexForText - Allows geocoding. + // // - geo:SearchPlaceIndexForPosition - Allows reverse geocoding. - // - geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from - // text. + // + // - geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text. + // // - GetPlace - Allows finding a place by place ID. + // // - Route actions + // // - geo:CalculateRoute - Allows point to point routing. + // // - geo:CalculateRouteMatrix - Allows calculating a matrix of routes. + // // You must use these strings exactly. For example, to provide access to map // rendering, the only valid action is geo:GetMap* as an input to the list. // ["geo:GetMap*"] is valid but ["geo:GetMapTile"] is not. Similarly, you cannot @@ -45,33 +57,47 @@ type ApiKeyRestrictions struct { AllowActions []string // A list of allowed resource ARNs that a API key bearer can perform actions on. + // // - The ARN must be the correct ARN for a map, place, or route ARN. You may // include wildcards in the resource-id to match multiple resources of the same // type. + // // - The resources must be in the same partition , region , and account-id as the // key that is being created. + // // - Other than wildcards, you must include the full ARN, including the arn , // partition , service , region , account-id and resource-id delimited by colons // (:). + // // - No spaces allowed, even with wildcards. For example, // arn:aws:geo:region:account-id:map/ExampleMap* . - // For more information about ARN format, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // . + // + // For more information about ARN format, see [Amazon Resource Names (ARNs)]. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AllowResources []string // 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 + // + // 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 @@ -125,8 +151,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. SampleTime *time.Time @@ -188,16 +216,20 @@ type BatchPutGeofenceRequestEntry struct { 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) - // can have a maximum of 1,000 vertices. + // or a circle. Including both will return a validation error. + // + // Each [geofence polygon] can have a maximum of 1,000 vertices. + // + // [geofence polygon]: https://docs.aws.amazon.com/location-geofences/latest/APIReference/API_GeofenceGeometry.html // // This member is required. Geometry *GeofenceGeometry // Associates one of more properties with the geofence. A property is a key-value // pair stored with the geofence and added to any geofence event triggered with - // that geofence. Format: "key" : "value" + // that geofence. + // + // Format: "key" : "value" GeofenceProperties map[string]string noSmithyDocumentSerde @@ -207,9 +239,10 @@ type BatchPutGeofenceRequestEntry struct { // geofence collection. type BatchPutGeofenceSuccess struct { - // The timestamp for when the geofence was stored in a geofence collection 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 stored in a geofence collection in [ISO 8601] + // format: YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -219,8 +252,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -242,8 +277,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. SampleTime *time.Time @@ -255,12 +292,18 @@ type BatchUpdateDevicePositionError struct { // TravelMode as Car . type CalculateRouteCarModeOptions struct { - // Avoids ferries when calculating routes. Default Value: false Valid Values: false - // | true + // 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 @@ -271,12 +314,16 @@ 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -306,20 +353,26 @@ 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string // The total distance covered by the route. The sum of the distance travelled - // between every stop on the route. If Esri is the data source for the route - // calculator, the route distance can’t be greater than 400 km. If the route - // exceeds 400 km, the response is a 400 RoutesValidationException error. + // between every stop on the route. + // + // If Esri is the data source for the route calculator, the route distance can’t + // be greater than 400 km. If the route exceeds 400 km, the response is a 400 + // RoutesValidationException error. // // This member is required. Distance *float64 @@ -336,15 +389,21 @@ type CalculateRouteSummary struct { 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: + // 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. // @@ -358,12 +417,18 @@ type CalculateRouteSummary struct { // TravelMode as Truck . type CalculateRouteTruckModeOptions struct { - // Avoids ferries when calculating routes. Default Value: false Valid Values: false - // | true + // 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, @@ -381,9 +446,11 @@ 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/) + // A single point geometry, specifying the center of the circle, using [WGS 84] // coordinates, in the form [longitude, latitude] . // + // [WGS 84]: https://gisgeography.com/wgs84-world-geodetic-system/ + // // This member is required. Center []float64 @@ -396,22 +463,30 @@ type Circle struct { noSmithyDocumentSerde } -// Specifies the data storage option chosen for requesting Places. When using -// Amazon Location Places: +// 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. // -// For more information, see the AWS Service Terms (https://aws.amazon.com/service-terms/) -// for Amazon Location Service. +// For more information, see the [AWS Service Terms] for Amazon Location Service. +// +// [AWS Service Terms]: https://aws.amazon.com/service-terms/ type DataSourceConfiguration struct { - // Specifies how the results of an operation will be stored by the caller. Valid - // values include: + // 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. + // // Default value: SingleUse IntendedUse IntendedUse @@ -426,15 +501,18 @@ 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] + // format: YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. SampleTime *time.Time @@ -459,14 +537,17 @@ 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] format: [X or longitude, Y or latitude] . + // + // [WGS 84]: https://earth-info.nga.mil/index.php?dir=wgs84&action=wgs84 // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. SampleTime *time.Time @@ -476,34 +557,43 @@ type DevicePositionUpdate struct { // Associates one of more properties with the position update. A property is a // key-value pair stored with the position update and added to any geofence event - // the update may trigger. Format: "key" : "value" + // the update may trigger. + // + // Format: "key" : "value" PositionProperties map[string]string 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. Circle *Circle // 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 - // 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 - // of between 4 and 1,000 vertices. + // 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 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 of between 4 and 1,000 vertices. Polygon [][][]float64 noSmithyDocumentSerde @@ -511,23 +601,30 @@ type GeofenceGeometry struct { // Contains the calculated route's details for each path between a pair of // 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) -// : +// 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]: +// // - 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. +// +// [snapped to a nearby road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html 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 . // @@ -542,15 +639,19 @@ type Leg struct { 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) - // . + // + // If the EndPosition isn't located on a road, it's [snapped to a nearby road]. + // + // [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]. + // + // [snapped to a nearby road]: https://docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html // // This member is required. StartPosition []float64 @@ -573,9 +674,11 @@ type Leg struct { // 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. + // 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]] LineString [][]float64 @@ -595,8 +698,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. SampleTime *time.Time @@ -618,8 +723,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -629,8 +736,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -651,9 +760,10 @@ type ListGeofenceCollectionsResponseEntry struct { // Contains a list of geofences stored in a given geofence collection. type ListGeofenceResponseEntry struct { - // The timestamp for when the geofence was stored in a geofence collection 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 stored in a geofence collection in [ISO 8601] + // format: YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -670,23 +780,31 @@ 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. // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time // User defined properties of the geofence. A property is a key-value pair stored // with the geofence and added to any geofence event triggered with that geofence. + // // Format: "key" : "value" GeofenceProperties map[string]string @@ -696,14 +814,18 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. ExpireTime *time.Time @@ -719,8 +841,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -735,8 +859,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -756,8 +882,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -773,19 +901,25 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -800,8 +934,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -822,21 +958,28 @@ 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 . + // The timestamp when the route calculator resource was created in [ISO 8601] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // // - For example, 2020–07-2T12:15:20.000Z+01:00 // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html + // // 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -846,10 +989,13 @@ 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 . + // The timestamp when the route calculator resource was last updated in [ISO 8601] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // // - For example, 2020–07-2T12:15:20.000Z+01:00 // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html + // // This member is required. UpdateTime *time.Time @@ -864,8 +1010,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. CreateTime *time.Time @@ -880,8 +1028,10 @@ 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] format: + // YYYY-MM-DDThh:mm:ss.sssZ . + // + // [ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html // // This member is required. UpdateTime *time.Time @@ -902,99 +1052,132 @@ 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) - // : + // Specifies the map style selected from an available data provider. + // + // Valid [Esri map styles]: + // // - VectorEsriNavigation – The Esri 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. It also includes a // richer set of places, such as shops, services, restaurants, attractions, and // other points of interest. Enable the POI layer by setting it in CustomLayers // to leverage the additional places data. + // // - 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 Street 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. + // // - 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. - // Valid HERE Technologies map styles (https://docs.aws.amazon.com/location/latest/developerguide/HERE.html) - // : + // + // Valid [HERE Technologies map styles]: + // // - 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. + // // - 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. + // 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. + // // - 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 . + // 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. + // // - 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. - // Valid GrabMaps map styles (https://docs.aws.amazon.com/location/latest/developerguide/grab.html) - // : + // + // Valid [GrabMaps map styles]: + // // - 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) - // : + // see [GrabMaps countries and area covered]. + // + // Valid [Open Data map styles]: + // // - 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. // + // [GrabMaps map styles]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html + // [GrabMaps countries and area covered]: https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area + // [Open Data map styles]: https://docs.aws.amazon.com/location/latest/developerguide/open-data.html + // [Esri map styles]: https://docs.aws.amazon.com/location/latest/developerguide/esri.html + // [HERE Technologies map styles]: https://docs.aws.amazon.com/location/latest/developerguide/HERE.html + // // This member is required. Style *string // Specifies the custom layers for the style. Leave unset to not enable any custom // layer, or, for styles that support custom layers, you can enable layer(s), such - // as POI layer for the VectorEsriNavigation style. Default is unset . Currenlty - // only VectorEsriNavigation supports CustomLayers. For more information, see - // Custom Layers (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers) - // . + // as POI layer for the VectorEsriNavigation style. Default is unset . + // + // Currenlty only VectorEsriNavigation supports CustomLayers. For more + // information, see [Custom Layers]. + // + // [Custom Layers]: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers CustomLayers []string // Specifies the political view for the style. Leave unset to not use a political // view, or, for styles that support specific political views, you can choose a - // view, such as IND for the Indian view. Default is unset. Not all map resources - // or styles support political view styles. See Political views (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#political-views) - // for more information. + // view, such as IND for the Indian view. + // + // Default is unset. + // + // Not all map resources or styles support political view styles. See [Political views] for more + // information. + // + // [Political views]: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#political-views PoliticalView *string noSmithyDocumentSerde @@ -1005,25 +1188,32 @@ type MapConfigurationUpdate struct { // Specifies the custom layers for the style. Leave unset to not enable any custom // layer, or, for styles that support custom layers, you can enable layer(s), such - // as POI layer for the VectorEsriNavigation style. Default is unset . Currenlty - // only VectorEsriNavigation supports CustomLayers. For more information, see - // Custom Layers (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers) - // . + // as POI layer for the VectorEsriNavigation style. Default is unset . + // + // Currenlty only VectorEsriNavigation supports CustomLayers. For more + // information, see [Custom Layers]. + // + // [Custom Layers]: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#map-custom-layers CustomLayers []string // Specifies the political view for the style. Set to an empty string to not use a // political view, or, for styles that support specific political views, you can - // choose a view, such as IND for the Indian view. Not all map resources or styles - // support political view styles. See Political views (https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#political-views) - // for more information. + // choose a view, such as IND for the Indian view. + // + // Not all map resources or styles support political view styles. See [Political views] for more + // information. + // + // [Political views]: https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html#political-views PoliticalView *string noSmithyDocumentSerde } // Contains details about addresses or points of interest that match the search -// criteria. Not all details are included with all responses. Some details may only -// be returned by specific data partners. +// criteria. +// +// Not all details are included with all responses. Some details may only be +// returned by specific data partners. type Place struct { // Places uses a point geometry to specify a location or a Place. @@ -1034,22 +1224,28 @@ type Place struct { // The numerical portion of an address, such as a building number. AddressNumber *string - // The Amazon Location categories that describe this Place. For more information - // about using categories, including a list of Amazon Location categories, see - // Categories and filtering (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html) - // , in the Amazon Location Service Developer Guide. + // The Amazon Location categories that describe this Place. + // + // For more information about using categories, including a list of Amazon + // Location categories, see [Categories and filtering], in the Amazon Location Service Developer Guide. + // + // [Categories and filtering]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html Categories []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] 3-digit country/region code. For example, CAN . + // + // [ISO 3166]: https://www.iso.org/iso-3166-country-codes.html 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 - // addresses. + // 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 addresses. Interpolated *bool // The full name and address of the point of interest such as a city, region, or @@ -1075,11 +1271,14 @@ type Place struct { Street *string // An area that's part of a larger municipality. For example, Blissville is a - // submunicipality in the Queen County in New York. This property is only returned - // for a place index that uses Esri as a data provider. The property is represented - // as a district . 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) - // . + // submunicipality in the Queen County in New York. + // + // This property is only returned for a place index that uses Esri as a data + // provider. The property is represented as a district . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html SubMunicipality *string // A county, or an area that's part of a larger region. For example, Metro @@ -1095,12 +1294,14 @@ type Place struct { TimeZone *TimeZone // For addresses with multiple units, the unit identifier. Can include numbers and - // letters, for example 3B or Unit 123 . This property is returned only for a place - // index that uses Esri or Grab as a data provider. It is not returned for - // SearchPlaceIndexForPosition . + // letters, for example 3B or Unit 123 . + // + // This property is returned only for a place index that uses Esri or Grab as a + // data provider. It is not returned for SearchPlaceIndexForPosition . UnitNumber *string // For addresses with a UnitNumber , the type of unit. For example, Apartment . + // // This property is returned only for a place index that uses Esri as a data // provider. UnitType *string @@ -1111,10 +1312,13 @@ 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: + // A single point geometry specifies a location for a Place using [WGS 84] coordinates: + // // - x — Specifies the x coordinate or longitude. + // // - y — Specifies the y coordinate or latitude. + // + // [WGS 84]: https://gisgeography.com/wgs84-world-geodetic-system/ Point []float64 noSmithyDocumentSerde @@ -1150,8 +1354,9 @@ type RouteMatrixEntry struct { } // An error corresponding to the calculation of a route between the -// DeparturePosition and DestinationPosition . The error code can be one of the -// following: +// DeparturePosition and DestinationPosition . +// +// The error code can be one of the following: // // - RouteNotFound - Unable to find a valid route with the given parameters. // @@ -1187,8 +1392,10 @@ type RouteMatrixEntryError struct { type SearchForPositionResult struct { // The distance in meters of a great-circle arc between the query position and the - // result. A great-circle arc is the shortest path on a sphere, in this case the - // Earth. This returns the shortest distance between two locations. + // result. + // + // A great-circle arc is the shortest path on a sphere, in this case the Earth. + // This returns the shortest distance between two locations. // // This member is required. Distance *float64 @@ -1199,9 +1406,10 @@ type SearchForPositionResult struct { 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. + // 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 @@ -1216,33 +1424,44 @@ type SearchForSuggestionsResult struct { // This member is required. Text *string - // The Amazon Location categories that describe the Place. For more information - // about using categories, including a list of Amazon Location categories, see - // Categories and filtering (https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html) - // , in the Amazon Location Service Developer Guide. + // The Amazon Location categories that describe the Place. + // + // For more information about using categories, including a list of Amazon + // Location categories, see [Categories and filtering], in the Amazon Location Service Developer Guide. + // + // [Categories and filtering]: https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html Categories []string // The unique identifier of the Place. You can use this with the GetPlace // operation to find the place again later, or to get full information for the - // Place. The GetPlace request must use the same PlaceIndex resource as the - // SearchPlaceIndexForSuggestions that generated the Place ID. For - // SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place - // indexes that use Esri, Grab, or HERE as data providers. While you can use - // PlaceID in subsequent requests, PlaceID is not intended to be a permanent - // identifier and the ID can change between consecutive API calls. Please see the - // following PlaceID behaviour for each data provider: + // Place. + // + // The GetPlace request must use the same PlaceIndex resource as the + // SearchPlaceIndexForSuggestions that generated the Place ID. + // + // For SearchPlaceIndexForSuggestions operations, the PlaceId is returned by place + // indexes that use Esri, Grab, or HERE as data providers. + // + // While you can use PlaceID in subsequent requests, PlaceID is not intended to be + // a permanent identifier and the ID can change between consecutive API calls. + // Please see the following PlaceID behaviour for each data provider: + // // - Esri: Place IDs will change every quarter at a minimum. The typical time // period for these changes would be March, June, September, and December. Place // IDs might also change between the typical quarterly change but that will be much // less frequent. + // // - HERE: We recommend that you cache data for no longer than a week to keep // your data data fresh. You can assume that less than 1% ID shifts will release // over release which is approximately 1 - 2 times per week. + // // - Grab: Place IDs can expire or become invalid in the following situations. + // // - Data operations: The POI may be removed from Grab POI database by Grab Map // Ops based on the ground-truth, such as being closed in the real world, being // detected as a duplicate POI, or having incorrect information. Grab will // synchronize data to the Waypoint environment on weekly basis. + // // - Interpolated POI: Interpolated POI is a temporary POI generated in real // time when serving a request, and it will be marked as derived in the // place.result_type field in the response. The information of interpolated POIs @@ -1270,20 +1489,25 @@ type SearchForTextResult struct { // 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. + // 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. + // 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. // For example, if more fields for an address match (including house number, // street, city, country/region, and postal code), the relevance score is closer to - // 1. Returned only when the partner selected is Esri or Grab. + // 1. + // + // Returned only when the partner selected is Esri or Grab. Relevance *float64 noSmithyDocumentSerde @@ -1294,12 +1518,16 @@ 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -1310,11 +1538,13 @@ type SearchPlaceIndexForPositionSummary struct { Position []float64 // The preferred language used to return results. Matches the language in the - // request. The value is a valid BCP 47 (https://tools.ietf.org/search/bcp47) - // language tag, for example, en for English. + // request. The value is a valid [BCP 47]language tag, for example, en for English. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string // Contains the optional result count limit that is specified in the request. + // // Default value: 50 MaxResults *int32 @@ -1326,12 +1556,16 @@ 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -1342,10 +1576,14 @@ type SearchPlaceIndexForSuggestionsSummary struct { Text *string // Contains the coordinates for the optional bias position specified in the - // 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 . + // 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 . BiasPosition []float64 // Contains the coordinates for the optional bounding box specified in the request. @@ -1358,8 +1596,9 @@ type SearchPlaceIndexForSuggestionsSummary struct { FilterCountries []string // The preferred language used to return results. Matches the language in the - // request. The value is a valid BCP 47 (https://tools.ietf.org/search/bcp47) - // language tag, for example, en for English. + // request. The value is a valid [BCP 47]language tag, for example, en for English. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string // Contains the optional result count limit specified in the request. @@ -1373,12 +1612,16 @@ 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) - // . + // + // For more information about data providers, see [Amazon Location Service data providers]. + // + // [Amazon Location Service data providers]: https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html // // This member is required. DataSource *string @@ -1389,10 +1632,14 @@ type SearchPlaceIndexForTextSummary struct { Text *string // Contains the coordinates for the optional bias position specified in the - // 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 . + // 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 . BiasPosition []float64 // Contains the coordinates for the optional bounding box specified in the request. @@ -1405,23 +1652,26 @@ type SearchPlaceIndexForTextSummary struct { FilterCountries []string // The preferred language used to return results. Matches the language in the - // request. The value is a valid BCP 47 (https://tools.ietf.org/search/bcp47) - // language tag, for example, en for English. + // request. The value is a valid [BCP 47]language tag, for example, en for English. + // + // [BCP 47]: https://tools.ietf.org/search/bcp47 Language *string // Contains the optional result count limit specified in the request. MaxResults *int32 - // The bounding box that fully contains all search results. If you specified the - // optional FilterBBox parameter in the request, ResultBBox is contained within - // FilterBBox . + // The bounding box that fully contains all search results. + // + // If you specified the optional FilterBBox parameter in the request, ResultBBox + // is contained within FilterBBox . ResultBBox []float64 noSmithyDocumentSerde } -// Represents an element of a leg within a route. A step contains instructions for -// how to move to the next step in the leg. +// Represents an element of a leg within a route. A step contains instructions +// +// for how to move to the next step in the leg. type Step struct { // The travel distance between the step's StartPosition and EndPosition . @@ -1450,8 +1700,9 @@ type Step struct { // 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 . + // geometry is 0 . + // + // Included in the response for queries that set IncludeLegGeometry to True . GeometryOffset *int32 noSmithyDocumentSerde @@ -1461,8 +1712,9 @@ type Step struct { // 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]. For example, America/Los_Angeles . + // + // [IANA time zone standard]: https://www.iana.org/time-zones // // This member is required. Name *string @@ -1489,23 +1741,30 @@ type TrackingFilterGeometry struct { 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. 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. Length *float64 - // Specifies the unit of measurement for the truck dimensions. Default Value: - // Meters + // Specifies the unit of measurement for the truck dimensions. + // + // Default Value: Meters 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. Width *float64 @@ -1519,10 +1778,13 @@ type TruckDimensions struct { type TruckWeight struct { // The total weight of the truck. + // // - For example, 3500 . Total *float64 - // The unit of measurement to use for the truck weight. Default Value: Kilograms + // The unit of measurement to use for the truck weight. + // + // Default Value: Kilograms Unit VehicleWeightUnit noSmithyDocumentSerde diff --git a/service/lookoutequipment/api_op_CreateDataset.go b/service/lookoutequipment/api_op_CreateDataset.go index dc775dc78f1..8c85496570f 100644 --- a/service/lookoutequipment/api_op_CreateDataset.go +++ b/service/lookoutequipment/api_op_CreateDataset.go @@ -33,7 +33,7 @@ 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 + // 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. @@ -60,7 +60,7 @@ type CreateDatasetInput struct { type CreateDatasetOutput struct { - // The Amazon Resource Name (ARN) of the dataset being created. + // The Amazon Resource Name (ARN) of the dataset being created. DatasetArn *string // The name of the dataset being created. diff --git a/service/lookoutequipment/api_op_CreateInferenceScheduler.go b/service/lookoutequipment/api_op_CreateInferenceScheduler.go index 8a568b07f8f..3d28696d658 100644 --- a/service/lookoutequipment/api_op_CreateInferenceScheduler.go +++ b/service/lookoutequipment/api_op_CreateInferenceScheduler.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a scheduled inference. Scheduling an inference is setting up a +// Creates a scheduled inference. Scheduling an inference is setting up a +// // continuous real-time inference plan to analyze new measurement data. When // setting up the schedule, you provide an S3 bucket location for the input data, // assign it a delimiter between separate entries in the data, set an offset delay @@ -34,7 +35,7 @@ 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 + // 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. @@ -52,13 +53,15 @@ type CreateInferenceSchedulerInput struct { // This member is required. DataOutputConfiguration *types.InferenceOutputConfiguration - // How often data is uploaded to the source Amazon S3 bucket for the input data. + // How often data is uploaded to the source Amazon 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 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) - // . + // how often Amazon Lookout for Equipment runs inference on your data. + // + // For more information, see [Understanding the inference process]. + // + // [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 @@ -87,9 +90,11 @@ type CreateInferenceSchedulerInput struct { // plus the additional five minute delay time (so 09:15) to check your Amazon S3 // 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) - // . + // uploading new data. + // + // For more information, see [Understanding the inference process]. + // + // [Understanding the inference 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 @@ -113,14 +118,19 @@ type CreateInferenceSchedulerOutput struct { // Provides a quality assessment for a model that uses labels. If Lookout for // Equipment determines that the model quality is poor based on training metrics, // the value is POOR_QUALITY_DETECTED . Otherwise, the value is - // QUALITY_THRESHOLD_MET . If the model is unlabeled, the model quality can't be - // assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY . In this - // situation, you can get a model quality assessment by adding labels to the input - // dataset and retraining the model. For information about using labels with your - // models, see Understanding labeling (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html) - // . For information about improving the quality of a model, see Best practices - // with Amazon Lookout for Equipment (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html) - // . + // QUALITY_THRESHOLD_MET . + // + // If the model is unlabeled, the model quality can't be assessed and the value of + // ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a + // model quality assessment by adding labels to the input dataset and retraining + // the model. + // + // For information about using labels with your models, see [Understanding labeling]. + // + // For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment]. + // + // [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html + // [Understanding labeling]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html ModelQuality types.ModelQuality // Indicates the status of the CreateInferenceScheduler operation. diff --git a/service/lookoutequipment/api_op_CreateLabel.go b/service/lookoutequipment/api_op_CreateLabel.go index a784f966fa9..e8d65cda534 100644 --- a/service/lookoutequipment/api_op_CreateLabel.go +++ b/service/lookoutequipment/api_op_CreateLabel.go @@ -30,46 +30,52 @@ func (c *Client) CreateLabel(ctx context.Context, params *CreateLabelInput, optF type CreateLabelInput struct { - // A unique identifier for the request to create a label. If you do not set the + // A unique identifier for the request to create a label. If you do not set the // client request token, Lookout for Equipment generates one. // // This member is required. ClientToken *string - // The end time of the labeled event. + // The end time of the labeled event. // // This member is required. EndTime *time.Time - // The name of a group of labels. Data in this field will be retained for service - // usage. Follow best practices for the security of your data. + // The name of a group of labels. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. // // This member is required. LabelGroupName *string - // Indicates whether a labeled event represents an anomaly. + // Indicates whether a labeled event represents an anomaly. // // This member is required. Rating types.LabelRating - // The start time of the labeled event. + // The start time of the labeled event. // // 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 - // in the FaultCodes attribute of the label group. Data in this field will be - // retained for service usage. Follow best practices for the security of your data. + // Provides additional information about the label. The fault code must be + // defined in the FaultCodes attribute of the label group. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. FaultCode *string - // Metadata providing additional information about the label. Data in this field - // will be retained for service usage. Follow best practices for the security of - // your data. + // Metadata providing additional information about the label. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. Notes *string noSmithyDocumentSerde @@ -77,7 +83,7 @@ type CreateLabelInput struct { type CreateLabelOutput struct { - // The ID of the label that you have created. + // The ID of the label that you have created. LabelId *string // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_CreateLabelGroup.go b/service/lookoutequipment/api_op_CreateLabelGroup.go index cd109d8cf77..7cbfa28c9f4 100644 --- a/service/lookoutequipment/api_op_CreateLabelGroup.go +++ b/service/lookoutequipment/api_op_CreateLabelGroup.go @@ -29,26 +29,31 @@ func (c *Client) CreateLabelGroup(ctx context.Context, params *CreateLabelGroupI type CreateLabelGroupInput struct { - // A unique identifier for the request to create a label group. If you do not set + // A unique identifier for the request to create a label group. If you do not set // the client request token, Lookout for Equipment generates one. // // This member is required. ClientToken *string - // Names a group of labels. Data in this field will be retained for service usage. - // Follow best practices for the security of your data. + // Names a group of labels. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. // // This member is required. LabelGroupName *string - // The acceptable fault codes (indicating the type of anomaly associated with the - // label) that can be used with this label group. Data in this field will be - // retained for service usage. Follow best practices for the security of your data. + // The acceptable fault codes (indicating the type of anomaly associated with the + // label) that can be used with this label group. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. FaultCodes []string - // Tags that provide metadata about the label group you are creating. Data in this - // field will be retained for service usage. Follow best practices for the security - // of your data. + // Tags that provide metadata about the label group you are creating. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. Tags []types.Tag noSmithyDocumentSerde @@ -56,10 +61,10 @@ type CreateLabelGroupInput struct { type CreateLabelGroupOutput struct { - // The Amazon Resource Name (ARN) of the label group that you have created. + // The Amazon Resource Name (ARN) of the label group that you have created. LabelGroupArn *string - // The name of the label group that you have created. Data in this field will be + // The name of the label group that you have created. Data in this field will be // retained for service usage. Follow best practices for the security of your data. LabelGroupName *string diff --git a/service/lookoutequipment/api_op_CreateModel.go b/service/lookoutequipment/api_op_CreateModel.go index aa79bfa0a5e..f656110db08 100644 --- a/service/lookoutequipment/api_op_CreateModel.go +++ b/service/lookoutequipment/api_op_CreateModel.go @@ -12,15 +12,18 @@ import ( "time" ) -// Creates a machine learning model for data inference. A machine-learning (ML) -// model is a mathematical model that finds patterns in your data. In Amazon -// Lookout for Equipment, the model learns the patterns of normal behavior and -// detects abnormal behavior that could be potential equipment failure (or -// maintenance events). The models are made by analyzing normal data and -// abnormalities in machine behavior that have already occurred. Your model is -// trained using a portion of the data from your dataset and uses that data to -// learn patterns of normal behavior and abnormal patterns that lead to equipment -// failure. Another portion of the data is used to evaluate the model's accuracy. +// Creates a machine learning model for data inference. +// +// A machine-learning (ML) model is a mathematical model that finds patterns in +// your data. In Amazon Lookout for Equipment, the model learns the patterns of +// normal behavior and detects abnormal behavior that could be potential equipment +// failure (or maintenance events). The models are made by analyzing normal data +// and abnormalities in machine behavior that have already occurred. +// +// Your model is trained using a portion of the data from your dataset and uses +// that data to learn patterns of normal behavior and abnormal patterns that lead +// to equipment failure. Another portion of the data is used to evaluate the +// model's accuracy. func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error) { if params == nil { params = &CreateModelInput{} @@ -58,16 +61,17 @@ type CreateModelInput struct { // 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 - // 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 + // 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 DataPreProcessingConfiguration *types.DataPreProcessingConfiguration // The data schema for the machine learning model being created. DatasetSchema *types.DatasetSchema - // Indicates the time reference in the dataset that should be used to end the + // Indicates the time reference in the dataset that should be used to end the // subset of evaluation data for the machine learning model. EvaluationDataEndTime *time.Time @@ -80,8 +84,9 @@ type CreateModelInput struct { LabelsInputConfiguration *types.LabelsInputConfiguration // The Amazon S3 location where you want Amazon Lookout for Equipment to save the - // pointwise model diagnostics. You must also specify the RoleArn request - // parameter. + // pointwise model diagnostics. + // + // You must also specify the RoleArn request parameter. ModelDiagnosticsOutputConfiguration *types.ModelDiagnosticsOutputConfiguration // Indicates that the asset associated with this sensor has been shut off. As long @@ -89,7 +94,7 @@ type CreateModelInput struct { // asset for training, evaluation, or inference. OffCondition *string - // The Amazon Resource Name (ARN) of a role with permission to access the data + // The Amazon Resource Name (ARN) of a role with permission to access the data // source being used to create the machine learning model. RoleArn *string @@ -97,7 +102,7 @@ type CreateModelInput struct { // Lookout for Equipment. ServerSideKmsKeyId *string - // Any tags associated with the machine learning model being created. + // Any tags associated with the machine learning model being created. Tags []types.Tag // Indicates the time reference in the dataset that should be used to end the diff --git a/service/lookoutequipment/api_op_CreateRetrainingScheduler.go b/service/lookoutequipment/api_op_CreateRetrainingScheduler.go index 50ec23e5335..f40e2ae6b06 100644 --- a/service/lookoutequipment/api_op_CreateRetrainingScheduler.go +++ b/service/lookoutequipment/api_op_CreateRetrainingScheduler.go @@ -46,23 +46,28 @@ type CreateRetrainingSchedulerInput struct { // This member is required. ModelName *string - // This parameter uses the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) - // standard to set the frequency at which you want retraining to occur in terms of - // Years, Months, and/or Days (note: other parameters like Time are not currently - // supported). The minimum value is 30 days (P30D) and the maximum value is 1 year - // (P1Y). For example, the following values are valid: + // This parameter uses the [ISO 8601] standard to set the frequency at which you want + // retraining to occur in terms of Years, Months, and/or Days (note: other + // parameters like Time are not currently supported). The minimum value is 30 days + // (P30D) and the maximum value is 1 year (P1Y). For example, the following values + // are valid: + // // - P3M15D – Every 3 months and 15 days + // // - P2M – Every 2 months + // // - P150D – Every 150 days // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601#Durations + // // This member is required. RetrainingFrequency *string // Indicates how the service will use new models. In MANAGED mode, new models will // automatically be used for inference if they have better performance than the - // current model. In MANUAL mode, the new models will not be used until they are - // manually activated (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation) - // . + // current model. In MANUAL mode, the new models will not be used [until they are manually activated]. + // + // [until they are manually activated]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation PromoteMode types.ModelPromoteMode // The start date for the retraining scheduler. Lookout for Equipment truncates diff --git a/service/lookoutequipment/api_op_DeleteDataset.go b/service/lookoutequipment/api_op_DeleteDataset.go index 4cc37d47a2f..0ad43b4e585 100644 --- a/service/lookoutequipment/api_op_DeleteDataset.go +++ b/service/lookoutequipment/api_op_DeleteDataset.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a dataset and associated artifacts. The operation will check to see if +// Deletes a dataset and associated artifacts. The operation will check to see if +// // any inference scheduler or data ingestion job is currently using the dataset, // and if there isn't, the dataset, its metadata, and any associated data stored in // S3 will be deleted. This does not affect any models that used this dataset for diff --git a/service/lookoutequipment/api_op_DeleteLabel.go b/service/lookoutequipment/api_op_DeleteLabel.go index 781c8a37019..f069ec4cb0f 100644 --- a/service/lookoutequipment/api_op_DeleteLabel.go +++ b/service/lookoutequipment/api_op_DeleteLabel.go @@ -28,14 +28,14 @@ func (c *Client) DeleteLabel(ctx context.Context, params *DeleteLabelInput, optF type DeleteLabelInput struct { - // The name of the label group that contains the label that you want to delete. + // The name of the label group that contains the label that you want to delete. // Data in this field will be retained for service usage. Follow best practices for // the security of your data. // // This member is required. LabelGroupName *string - // The ID of the label that you want to delete. + // The ID of the label that you want to delete. // // This member is required. LabelId *string diff --git a/service/lookoutequipment/api_op_DeleteLabelGroup.go b/service/lookoutequipment/api_op_DeleteLabelGroup.go index 118c7c58d4f..e93958d7898 100644 --- a/service/lookoutequipment/api_op_DeleteLabelGroup.go +++ b/service/lookoutequipment/api_op_DeleteLabelGroup.go @@ -28,8 +28,9 @@ func (c *Client) DeleteLabelGroup(ctx context.Context, params *DeleteLabelGroupI type DeleteLabelGroupInput struct { - // The name of the label group that you want to delete. Data in this field will be - // retained for service usage. Follow best practices for the security of your data. + // The name of the label group that you want to delete. Data in this field will + // be retained for service usage. Follow best practices for the security of your + // data. // // This member is required. LabelGroupName *string diff --git a/service/lookoutequipment/api_op_DescribeDataIngestionJob.go b/service/lookoutequipment/api_op_DescribeDataIngestionJob.go index b85c12d6a9c..0270b08ab9f 100644 --- a/service/lookoutequipment/api_op_DescribeDataIngestionJob.go +++ b/service/lookoutequipment/api_op_DescribeDataIngestionJob.go @@ -44,17 +44,17 @@ type DescribeDataIngestionJobOutput struct { // The time at which the data ingestion job was created. CreatedAt *time.Time - // Indicates the latest timestamp corresponding to data that was successfully + // Indicates the latest timestamp corresponding to data that was successfully // ingested during this specific ingestion job. DataEndTime *time.Time - // Gives statistics about a completed ingestion job. These statistics primarily + // Gives statistics about a completed ingestion job. These statistics primarily // relate to quantifying incorrect data such as MissingCompleteSensorData, // MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and // DuplicateTimeStamps. DataQualitySummary *types.DataQualitySummary - // Indicates the earliest timestamp corresponding to data that was successfully + // Indicates the earliest timestamp corresponding to data that was successfully // ingested during this specific ingestion job. DataStartTime *time.Time @@ -65,7 +65,7 @@ type DescribeDataIngestionJobOutput struct { // Specifies the reason for failure when a data ingestion job has failed. FailedReason *string - // Indicates the size of the ingested dataset. + // Indicates the size of the ingested dataset. IngestedDataSize *int64 // Gives statistics about how many files have been ingested, and which files have @@ -90,7 +90,7 @@ type DescribeDataIngestionJobOutput struct { // Indicates the status of the DataIngestionJob operation. Status types.IngestionJobStatus - // Provides details about status of the ingestion job that is currently in + // Provides details about status of the ingestion job that is currently in // progress. StatusDetail *string diff --git a/service/lookoutequipment/api_op_DescribeDataset.go b/service/lookoutequipment/api_op_DescribeDataset.go index 0dca4f4ca4f..b68265c62b3 100644 --- a/service/lookoutequipment/api_op_DescribeDataset.go +++ b/service/lookoutequipment/api_op_DescribeDataset.go @@ -44,17 +44,17 @@ type DescribeDatasetOutput struct { // Specifies the time the dataset was created in Lookout for Equipment. CreatedAt *time.Time - // Indicates the latest timestamp corresponding to data that was successfully + // Indicates the latest timestamp corresponding to data that was successfully // ingested during the most recent ingestion of this particular dataset. DataEndTime *time.Time - // Gives statistics associated with the given dataset for the latest successful + // Gives statistics associated with the given dataset for the latest successful // associated ingestion job id. These statistics primarily relate to quantifying // incorrect data such as MissingCompleteSensorData, MissingSensorData, // UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps. DataQualitySummary *types.DataQualitySummary - // Indicates the earliest timestamp corresponding to data that was successfully + // Indicates the earliest timestamp corresponding to data that was successfully // ingested during the most recent ingestion of this particular dataset. DataStartTime *time.Time @@ -75,7 +75,7 @@ type DescribeDatasetOutput struct { // Specifies the time the dataset was last updated, if it was. LastUpdatedAt *time.Time - // The Amazon Resource Name (ARN) of the IAM role that you are using for this the + // The Amazon Resource Name (ARN) of the IAM role that you are using for this the // data ingestion job. RoleArn *string diff --git a/service/lookoutequipment/api_op_DescribeInferenceScheduler.go b/service/lookoutequipment/api_op_DescribeInferenceScheduler.go index 069e43b93bb..a5301426f40 100644 --- a/service/lookoutequipment/api_op_DescribeInferenceScheduler.go +++ b/service/lookoutequipment/api_op_DescribeInferenceScheduler.go @@ -12,8 +12,9 @@ import ( "time" ) -// Specifies information about the inference scheduler being used, including name, -// model, status, and associated metadata +// Specifies information about the inference scheduler being used, including +// +// name, model, status, and associated metadata func (c *Client) DescribeInferenceScheduler(ctx context.Context, params *DescribeInferenceSchedulerInput, optFns ...func(*Options)) (*DescribeInferenceSchedulerOutput, error) { if params == nil { params = &DescribeInferenceSchedulerInput{} @@ -44,7 +45,7 @@ type DescribeInferenceSchedulerOutput struct { // Specifies the time at which the inference scheduler was created. CreatedAt *time.Time - // A period of time (in minutes) by which inference on the data is delayed after + // A period of time (in minutes) by which inference on the data is delayed after // the data starts. For instance, if you select an offset delay time of five // minutes, inference will not begin on the data until the first data measurement // after the five minute mark. For example, if five minutes is selected, the @@ -54,11 +55,11 @@ type DescribeInferenceSchedulerOutput struct { // when uploading new data. DataDelayOffsetInMinutes *int64 - // Specifies configuration information for the input data for the inference + // Specifies configuration information for the input data for the inference // scheduler, including delimiter, format, and dataset location. DataInputConfiguration *types.InferenceInputConfiguration - // Specifies information for the output results for the inference scheduler, + // Specifies information for the output results for the inference scheduler, // including the output S3 location. DataOutputConfiguration *types.InferenceOutputConfiguration @@ -88,7 +89,7 @@ type DescribeInferenceSchedulerOutput struct { // described. ModelName *string - // The Amazon Resource Name (ARN) of a role with permission to access the data + // The Amazon Resource Name (ARN) of a role with permission to access the data // source for the inference scheduler being described. RoleArn *string @@ -99,7 +100,8 @@ type DescribeInferenceSchedulerOutput struct { // Indicates the status of the inference scheduler. Status types.InferenceSchedulerStatus - // Specifies the time at which the inference scheduler was last updated, if it was. + // Specifies the time at which the inference scheduler was last updated, if it + // was. UpdatedAt *time.Time // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_DescribeLabel.go b/service/lookoutequipment/api_op_DescribeLabel.go index 712a1de2b0b..5dceac6c651 100644 --- a/service/lookoutequipment/api_op_DescribeLabel.go +++ b/service/lookoutequipment/api_op_DescribeLabel.go @@ -30,12 +30,12 @@ func (c *Client) DescribeLabel(ctx context.Context, params *DescribeLabelInput, type DescribeLabelInput struct { - // Returns the name of the group containing the label. + // Returns the name of the group containing the label. // // This member is required. LabelGroupName *string - // Returns the ID of the label. + // Returns the ID of the label. // // This member is required. LabelId *string @@ -45,38 +45,40 @@ type DescribeLabelInput struct { type DescribeLabelOutput struct { - // The time at which the label was created. + // The time at which the label was created. CreatedAt *time.Time - // The end time of the requested label. + // The end time of the requested label. EndTime *time.Time - // Indicates that a label pertains to a particular piece of equipment. + // 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 Amazon Resource Name (ARN) of the requested label group. + // The Amazon Resource Name (ARN) of the requested label group. LabelGroupArn *string - // The name of the requested label group. + // The name of the requested label group. LabelGroupName *string - // The ID of the requested label. + // The ID of the requested label. LabelId *string - // Metadata providing additional information about the label. Data in this field - // will be retained for service usage. Follow best practices for the security of - // your data. + // Metadata providing additional information about the label. + // + // Data in this field will be retained for service usage. Follow best practices + // for the security of your data. Notes *string - // Indicates whether a labeled event represents an anomaly. + // Indicates whether a labeled event represents an anomaly. Rating types.LabelRating - // The start time of the requested label. + // The start time of the requested label. StartTime *time.Time // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_DescribeLabelGroup.go b/service/lookoutequipment/api_op_DescribeLabelGroup.go index 89aa17c550a..d3dc9388f4b 100644 --- a/service/lookoutequipment/api_op_DescribeLabelGroup.go +++ b/service/lookoutequipment/api_op_DescribeLabelGroup.go @@ -29,7 +29,7 @@ func (c *Client) DescribeLabelGroup(ctx context.Context, params *DescribeLabelGr type DescribeLabelGroupInput struct { - // Returns the name of the label group. + // Returns the name of the label group. // // This member is required. LabelGroupName *string @@ -39,20 +39,20 @@ type DescribeLabelGroupInput struct { type DescribeLabelGroupOutput struct { - // The time at which the label group was created. + // The time at which the label group was created. CreatedAt *time.Time - // Codes indicating the type of anomaly associated with the labels in the lagbel + // Codes indicating the type of anomaly associated with the labels in the lagbel // group. FaultCodes []string - // The Amazon Resource Name (ARN) of the label group. + // The Amazon Resource Name (ARN) of the label group. LabelGroupArn *string - // The name of the label group. + // The name of the label group. LabelGroupName *string - // The time at which the label group was updated. + // The time at which the label group was updated. UpdatedAt *time.Time // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_DescribeModel.go b/service/lookoutequipment/api_op_DescribeModel.go index 75832ed88ae..1b20016d999 100644 --- a/service/lookoutequipment/api_op_DescribeModel.go +++ b/service/lookoutequipment/api_op_DescribeModel.go @@ -63,10 +63,11 @@ type DescribeModelOutput struct { // 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 - // 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 + // 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 DataPreProcessingConfiguration *types.DataPreProcessingConfiguration // The Amazon Resouce Name (ARN) of the dataset used to create the machine @@ -76,11 +77,11 @@ type DescribeModelOutput struct { // The name of the dataset being used by the machine learning being described. DatasetName *string - // Indicates the time reference in the dataset that was used to end the subset of + // Indicates the time reference in the dataset that was used to end the subset of // evaluation data for the machine learning model. EvaluationDataEndTime *time.Time - // Indicates the time reference in the dataset that was used to begin the subset + // Indicates the time reference in the dataset that was used to begin the subset // of evaluation data for the machine learning model. EvaluationDataStartTime *time.Time @@ -140,14 +141,19 @@ type DescribeModelOutput struct { // Provides a quality assessment for a model that uses labels. If Lookout for // Equipment determines that the model quality is poor based on training metrics, // the value is POOR_QUALITY_DETECTED . Otherwise, the value is - // QUALITY_THRESHOLD_MET . If the model is unlabeled, the model quality can't be - // assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY . In this - // situation, you can get a model quality assessment by adding labels to the input - // dataset and retraining the model. For information about using labels with your - // models, see Understanding labeling (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html) - // . For information about improving the quality of a model, see Best practices - // with Amazon Lookout for Equipment (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html) - // . + // QUALITY_THRESHOLD_MET . + // + // If the model is unlabeled, the model quality can't be assessed and the value of + // ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a + // model quality assessment by adding labels to the input dataset and retraining + // the model. + // + // For information about using labels with your models, see [Understanding labeling]. + // + // For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment]. + // + // [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html + // [Understanding labeling]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html ModelQuality types.ModelQuality // The date the active model version was activated. @@ -184,7 +190,7 @@ type DescribeModelOutput struct { // Indicates the status of the retraining scheduler. RetrainingSchedulerStatus types.RetrainingSchedulerStatus - // The Amazon Resource Name (ARN) of a role with permission to access the data + // The Amazon Resource Name (ARN) of a role with permission to access the data // source for the machine learning model being described. RoleArn *string @@ -206,11 +212,11 @@ type DescribeModelOutput struct { // status of the most recent action of the model. Status types.ModelStatus - // Indicates the time reference in the dataset that was used to end the subset of + // Indicates the time reference in the dataset that was used to end the subset of // training data for the machine learning model. TrainingDataEndTime *time.Time - // Indicates the time reference in the dataset that was used to begin the subset + // Indicates the time reference in the dataset that was used to begin the subset // of training data for the machine learning model. TrainingDataStartTime *time.Time diff --git a/service/lookoutequipment/api_op_DescribeModelVersion.go b/service/lookoutequipment/api_op_DescribeModelVersion.go index 394f120f515..b3826b0a58d 100644 --- a/service/lookoutequipment/api_op_DescribeModelVersion.go +++ b/service/lookoutequipment/api_op_DescribeModelVersion.go @@ -64,10 +64,11 @@ type DescribeModelVersionOutput struct { // 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 - // 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 + // 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 DataPreProcessingConfiguration *types.DataPreProcessingConfiguration // The Amazon Resource Name (ARN) of the dataset used to train the model version. @@ -130,14 +131,19 @@ type DescribeModelVersionOutput struct { // Provides a quality assessment for a model that uses labels. If Lookout for // Equipment determines that the model quality is poor based on training metrics, // the value is POOR_QUALITY_DETECTED . Otherwise, the value is - // QUALITY_THRESHOLD_MET . If the model is unlabeled, the model quality can't be - // assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY . In this - // situation, you can get a model quality assessment by adding labels to the input - // dataset and retraining the model. For information about using labels with your - // models, see Understanding labeling (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html) - // . For information about improving the quality of a model, see Best practices - // with Amazon Lookout for Equipment (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html) - // . + // QUALITY_THRESHOLD_MET . + // + // If the model is unlabeled, the model quality can't be assessed and the value of + // ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a + // model quality assessment by adding labels to the input dataset and retraining + // the model. + // + // For information about using labels with your models, see [Understanding labeling]. + // + // For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment]. + // + // [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html + // [Understanding labeling]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html ModelQuality types.ModelQuality // The version of the machine learning model. diff --git a/service/lookoutequipment/api_op_DescribeRetrainingScheduler.go b/service/lookoutequipment/api_op_DescribeRetrainingScheduler.go index 206ea171ce3..494c875f55a 100644 --- a/service/lookoutequipment/api_op_DescribeRetrainingScheduler.go +++ b/service/lookoutequipment/api_op_DescribeRetrainingScheduler.go @@ -55,12 +55,15 @@ type DescribeRetrainingSchedulerOutput struct { // Indicates how the service uses new models. In MANAGED mode, new models are used // for inference if they have better performance than the current model. In MANUAL - // mode, the new models are not used until they are manually activated (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation) - // . + // mode, the new models are not used until they are [manually activated]. + // + // [manually activated]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation PromoteMode types.ModelPromoteMode - // The frequency at which the model retraining is set. This follows the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) + // The frequency at which the model retraining is set. This follows the [ISO 8601] // guidelines. + // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601#Durations RetrainingFrequency *string // The start date for the retraining scheduler. Lookout for Equipment truncates diff --git a/service/lookoutequipment/api_op_ImportModelVersion.go b/service/lookoutequipment/api_op_ImportModelVersion.go index 077bdabbd98..99855d5a17d 100644 --- a/service/lookoutequipment/api_op_ImportModelVersion.go +++ b/service/lookoutequipment/api_op_ImportModelVersion.go @@ -47,9 +47,12 @@ type ImportModelVersionInput struct { // Indicates how to import the accumulated inference data when a model version is // imported. The possible values are as follows: + // // - NO_IMPORT – Don't import the data. + // // - ADD_WHEN_EMPTY – Only import the data from the source model if there is no // existing data in the target model. + // // - OVERWRITE – Import the data from the source model and overwrite the // existing data in the target model. InferenceDataImportStrategy types.InferenceDataImportStrategy diff --git a/service/lookoutequipment/api_op_ListDataIngestionJobs.go b/service/lookoutequipment/api_op_ListDataIngestionJobs.go index f964d8ee9cd..d50ad955f18 100644 --- a/service/lookoutequipment/api_op_ListDataIngestionJobs.go +++ b/service/lookoutequipment/api_op_ListDataIngestionJobs.go @@ -33,7 +33,7 @@ type ListDataIngestionJobsInput struct { // The name of the dataset being used for the data ingestion job. DatasetName *string - // Specifies the maximum number of data ingestion jobs to list. + // Specifies the maximum number of data ingestion jobs to list. MaxResults *int32 // An opaque pagination token indicating where to continue the listing of data @@ -52,7 +52,7 @@ type ListDataIngestionJobsOutput struct { // name and status. DataIngestionJobSummaries []types.DataIngestionJobSummary - // An opaque pagination token indicating where to continue the listing of data + // An opaque pagination token indicating where to continue the listing of data // ingestion jobs. NextToken *string @@ -149,7 +149,7 @@ var _ ListDataIngestionJobsAPIClient = (*Client)(nil) // ListDataIngestionJobsPaginatorOptions is the paginator options for // ListDataIngestionJobs type ListDataIngestionJobsPaginatorOptions struct { - // Specifies the maximum number of data ingestion jobs to list. + // Specifies the maximum number of data ingestion jobs to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lookoutequipment/api_op_ListDatasets.go b/service/lookoutequipment/api_op_ListDatasets.go index ea7efedaad7..894165927a6 100644 --- a/service/lookoutequipment/api_op_ListDatasets.go +++ b/service/lookoutequipment/api_op_ListDatasets.go @@ -33,10 +33,11 @@ type ListDatasetsInput struct { // The beginning of the name of the datasets to be listed. DatasetNameBeginsWith *string - // Specifies the maximum number of datasets to list. + // Specifies the maximum number of datasets to list. MaxResults *int32 - // An opaque pagination token indicating where to continue the listing of datasets. + // An opaque pagination token indicating where to continue the listing of + // datasets. NextToken *string noSmithyDocumentSerde @@ -48,7 +49,8 @@ type ListDatasetsOutput struct { // dataset ARN, and status. DatasetSummaries []types.DatasetSummary - // An opaque pagination token indicating where to continue the listing of datasets. + // An opaque pagination token indicating where to continue the listing of + // datasets. NextToken *string // Metadata pertaining to the operation's result. @@ -142,7 +144,7 @@ var _ ListDatasetsAPIClient = (*Client)(nil) // ListDatasetsPaginatorOptions is the paginator options for ListDatasets type ListDatasetsPaginatorOptions struct { - // Specifies the maximum number of datasets to list. + // Specifies the maximum number of datasets to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lookoutequipment/api_op_ListInferenceEvents.go b/service/lookoutequipment/api_op_ListInferenceEvents.go index 77c7ecd55d0..02443e83353 100644 --- a/service/lookoutequipment/api_op_ListInferenceEvents.go +++ b/service/lookoutequipment/api_op_ListInferenceEvents.go @@ -12,7 +12,8 @@ import ( "time" ) -// Lists all inference events that have been found for the specified inference +// Lists all inference events that have been found for the specified inference +// // scheduler. func (c *Client) ListInferenceEvents(ctx context.Context, params *ListInferenceEventsInput, optFns ...func(*Options)) (*ListInferenceEventsOutput, error) { if params == nil { @@ -42,7 +43,7 @@ type ListInferenceEventsInput struct { // This member is required. IntervalEndTime *time.Time - // Lookout for Equipment will return all the inference events with an end time + // Lookout for Equipment will return all the inference events with an end time // equal to or greater than the start time given. // // This member is required. diff --git a/service/lookoutequipment/api_op_ListInferenceExecutions.go b/service/lookoutequipment/api_op_ListInferenceExecutions.go index 9fb1d01c8ef..c12fe5179ca 100644 --- a/service/lookoutequipment/api_op_ListInferenceExecutions.go +++ b/service/lookoutequipment/api_op_ListInferenceExecutions.go @@ -12,7 +12,8 @@ import ( "time" ) -// Lists all inference executions that have been performed by the specified +// Lists all inference executions that have been performed by the specified +// // inference scheduler. func (c *Client) ListInferenceExecutions(ctx context.Context, params *ListInferenceExecutionsInput, optFns ...func(*Options)) (*ListInferenceExecutionsOutput, error) { if params == nil { @@ -61,13 +62,14 @@ type ListInferenceExecutionsOutput struct { // Provides an array of information about the individual inference executions // returned from the ListInferenceExecutions operation, including model used, - // inference scheduler, data configuration, and so on. If you don't supply the - // InferenceSchedulerName request parameter, or if you supply the name of an - // inference scheduler that doesn't exist, ListInferenceExecutions returns an - // empty array in InferenceExecutionSummaries . + // inference scheduler, data configuration, and so on. + // + // If you don't supply the InferenceSchedulerName request parameter, or if you + // supply the name of an inference scheduler that doesn't exist, + // ListInferenceExecutions returns an empty array in InferenceExecutionSummaries . InferenceExecutionSummaries []types.InferenceExecutionSummary - // An opaque pagination token indicating where to continue the listing of + // An opaque pagination token indicating where to continue the listing of // inference executions. NextToken *string diff --git a/service/lookoutequipment/api_op_ListInferenceSchedulers.go b/service/lookoutequipment/api_op_ListInferenceSchedulers.go index a8f21fd6936..d040676b692 100644 --- a/service/lookoutequipment/api_op_ListInferenceSchedulers.go +++ b/service/lookoutequipment/api_op_ListInferenceSchedulers.go @@ -33,14 +33,14 @@ type ListInferenceSchedulersInput struct { // The beginning of the name of the inference schedulers to be listed. InferenceSchedulerNameBeginsWith *string - // Specifies the maximum number of inference schedulers to list. + // Specifies the maximum number of inference schedulers to list. MaxResults *int32 // The name of the machine learning model used by the inference scheduler to be // listed. ModelName *string - // An opaque pagination token indicating where to continue the listing of + // An opaque pagination token indicating where to continue the listing of // inference schedulers. NextToken *string @@ -56,7 +56,7 @@ 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 + // An opaque pagination token indicating where to continue the listing of // inference schedulers. NextToken *string @@ -153,7 +153,7 @@ var _ ListInferenceSchedulersAPIClient = (*Client)(nil) // ListInferenceSchedulersPaginatorOptions is the paginator options for // ListInferenceSchedulers type ListInferenceSchedulersPaginatorOptions struct { - // Specifies the maximum number of inference schedulers to list. + // Specifies the maximum number of inference schedulers to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lookoutequipment/api_op_ListLabelGroups.go b/service/lookoutequipment/api_op_ListLabelGroups.go index 584eaec9e74..e1324c17778 100644 --- a/service/lookoutequipment/api_op_ListLabelGroups.go +++ b/service/lookoutequipment/api_op_ListLabelGroups.go @@ -29,13 +29,13 @@ func (c *Client) ListLabelGroups(ctx context.Context, params *ListLabelGroupsInp type ListLabelGroupsInput struct { - // The beginning of the name of the label groups to be listed. + // The beginning of the name of the label groups to be listed. LabelGroupNameBeginsWith *string - // Specifies the maximum number of label groups to list. + // Specifies the maximum number of label groups to list. MaxResults *int32 - // An opaque pagination token indicating where to continue the listing of label + // An opaque pagination token indicating where to continue the listing of label // groups. NextToken *string @@ -44,10 +44,10 @@ type ListLabelGroupsInput struct { type ListLabelGroupsOutput struct { - // A summary of the label groups. + // A summary of the label groups. LabelGroupSummaries []types.LabelGroupSummary - // An opaque pagination token indicating where to continue the listing of label + // An opaque pagination token indicating where to continue the listing of label // groups. NextToken *string @@ -143,7 +143,7 @@ var _ ListLabelGroupsAPIClient = (*Client)(nil) // ListLabelGroupsPaginatorOptions is the paginator options for ListLabelGroups type ListLabelGroupsPaginatorOptions struct { - // Specifies the maximum number of label groups to list. + // Specifies the maximum number of label groups to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lookoutequipment/api_op_ListLabels.go b/service/lookoutequipment/api_op_ListLabels.go index 4d48f99fd3b..cbdc0ae4d29 100644 --- a/service/lookoutequipment/api_op_ListLabels.go +++ b/service/lookoutequipment/api_op_ListLabels.go @@ -30,28 +30,28 @@ func (c *Client) ListLabels(ctx context.Context, params *ListLabelsInput, optFns type ListLabelsInput struct { - // Returns the name of the label group. + // Returns the name of the label group. // // This member is required. LabelGroupName *string - // Lists the labels that pertain to a particular piece of equipment. + // Lists the labels that pertain to a particular piece of equipment. Equipment *string - // Returns labels with a particular fault code. + // Returns labels with a particular fault code. FaultCode *string - // Returns all labels with a start time earlier than the end time given. + // Returns all labels with a start time earlier than the end time given. IntervalEndTime *time.Time - // Returns all the labels with a end time equal to or later than the start time + // Returns all the labels with a end time equal to or later than the start time // given. IntervalStartTime *time.Time - // Specifies the maximum number of labels to list. + // Specifies the maximum number of labels to list. MaxResults *int32 - // An opaque pagination token indicating where to continue the listing of label + // An opaque pagination token indicating where to continue the listing of label // groups. NextToken *string @@ -60,12 +60,15 @@ type ListLabelsInput struct { type ListLabelsOutput struct { - // A summary of the items in the label group. If you don't supply the - // LabelGroupName request parameter, or if you supply the name of a label group - // that doesn't exist, ListLabels returns an empty array in LabelSummaries . + // A summary of the items in the label group. + // + // If you don't supply the LabelGroupName request parameter, or if you supply the + // name of a label group that doesn't exist, ListLabels returns an empty array in + // LabelSummaries . LabelSummaries []types.LabelSummary - // An opaque pagination token indicating where to continue the listing of datasets. + // An opaque pagination token indicating where to continue the listing of + // datasets. NextToken *string // Metadata pertaining to the operation's result. @@ -162,7 +165,7 @@ var _ ListLabelsAPIClient = (*Client)(nil) // ListLabelsPaginatorOptions is the paginator options for ListLabels type ListLabelsPaginatorOptions struct { - // Specifies the maximum number of labels to list. + // Specifies the maximum number of labels to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lookoutequipment/api_op_ListModelVersions.go b/service/lookoutequipment/api_op_ListModelVersions.go index 3a229ba27fd..832e94ddcaf 100644 --- a/service/lookoutequipment/api_op_ListModelVersions.go +++ b/service/lookoutequipment/api_op_ListModelVersions.go @@ -71,9 +71,11 @@ type ListModelVersionsInput struct { type ListModelVersionsOutput struct { // Provides information on the specified model version, including the created - // time, model and dataset ARNs, and status. If you don't supply the ModelName - // request parameter, or if you supply the name of a model that doesn't exist, - // ListModelVersions returns an empty array in ModelVersionSummaries . + // time, model and dataset ARNs, and status. + // + // If you don't supply the ModelName request parameter, or if you supply the name + // of a model that doesn't exist, ListModelVersions returns an empty array in + // ModelVersionSummaries . ModelVersionSummaries []types.ModelVersionSummary // If the total number of results exceeds the limit that the response can display, diff --git a/service/lookoutequipment/api_op_ListModels.go b/service/lookoutequipment/api_op_ListModels.go index 15521fec340..c1732647f8b 100644 --- a/service/lookoutequipment/api_op_ListModels.go +++ b/service/lookoutequipment/api_op_ListModels.go @@ -34,13 +34,13 @@ type ListModelsInput struct { // listed. DatasetNameBeginsWith *string - // Specifies the maximum number of machine learning models to list. + // Specifies the maximum number of machine learning models to list. MaxResults *int32 // The beginning of the name of the machine learning models being listed. ModelNameBeginsWith *string - // An opaque pagination token indicating where to continue the listing of machine + // An opaque pagination token indicating where to continue the listing of machine // learning models. NextToken *string @@ -56,7 +56,7 @@ type ListModelsOutput struct { // dataset ARNs, and status. ModelSummaries []types.ModelSummary - // An opaque pagination token indicating where to continue the listing of machine + // An opaque pagination token indicating where to continue the listing of machine // learning models. NextToken *string @@ -151,7 +151,7 @@ var _ ListModelsAPIClient = (*Client)(nil) // ListModelsPaginatorOptions is the paginator options for ListModels type ListModelsPaginatorOptions struct { - // Specifies the maximum number of machine learning models to list. + // Specifies the maximum number of machine learning models to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/lookoutequipment/api_op_ListSensorStatistics.go b/service/lookoutequipment/api_op_ListSensorStatistics.go index 958fceee1ea..f96bdabc74f 100644 --- a/service/lookoutequipment/api_op_ListSensorStatistics.go +++ b/service/lookoutequipment/api_op_ListSensorStatistics.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists statistics about the data collected for each of the sensors that have +// 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) { @@ -31,12 +32,12 @@ func (c *Client) ListSensorStatistics(ctx context.Context, params *ListSensorSta type ListSensorStatisticsInput struct { - // The name of the dataset associated with the list of Sensor Statistics. + // The name of the dataset associated with the list of Sensor Statistics. // // This member is required. DatasetName *string - // The ingestion job id associated with the list of Sensor Statistics. To get + // The ingestion job id associated with the list of Sensor Statistics. To get // sensor statistics for a particular ingestion job id, both dataset name and // ingestion job id must be submitted as inputs. IngestionJobId *string diff --git a/service/lookoutequipment/api_op_ListTagsForResource.go b/service/lookoutequipment/api_op_ListTagsForResource.go index 6b4a936ce0f..38f57c0c52f 100644 --- a/service/lookoutequipment/api_op_ListTagsForResource.go +++ b/service/lookoutequipment/api_op_ListTagsForResource.go @@ -40,7 +40,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // Any tags associated with the resource. + // Any tags associated with the resource. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/lookoutequipment/api_op_StartDataIngestionJob.go b/service/lookoutequipment/api_op_StartDataIngestionJob.go index d59777fde33..df3d13d3144 100644 --- a/service/lookoutequipment/api_op_StartDataIngestionJob.go +++ b/service/lookoutequipment/api_op_StartDataIngestionJob.go @@ -30,7 +30,7 @@ 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 + // 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. @@ -41,13 +41,13 @@ type StartDataIngestionJobInput struct { // This member is required. DatasetName *string - // Specifies information for the input data for the data ingestion job, including + // Specifies information for the input data for the data ingestion job, including // dataset S3 location. // // This member is required. IngestionInputConfiguration *types.IngestionInputConfiguration - // The Amazon Resource Name (ARN) of a role with permission to access the data + // The Amazon Resource Name (ARN) of a role with permission to access the data // source for the data ingestion job. // // This member is required. diff --git a/service/lookoutequipment/api_op_UpdateInferenceScheduler.go b/service/lookoutequipment/api_op_UpdateInferenceScheduler.go index 8af68b33574..ac20c29e20e 100644 --- a/service/lookoutequipment/api_op_UpdateInferenceScheduler.go +++ b/service/lookoutequipment/api_op_UpdateInferenceScheduler.go @@ -34,7 +34,7 @@ type UpdateInferenceSchedulerInput struct { // This member is required. InferenceSchedulerName *string - // A period of time (in minutes) by which inference on the data is delayed after + // A period of time (in minutes) by which inference on the data is delayed after // the data starts. For instance, if you select an offset delay time of five // minutes, inference will not begin on the data until the first data measurement // after the five minute mark. For example, if five minutes is selected, the @@ -44,11 +44,11 @@ type UpdateInferenceSchedulerInput struct { // when uploading new data. DataDelayOffsetInMinutes *int64 - // Specifies information for the input data for the inference scheduler, including - // delimiter, format, and dataset location. + // Specifies information for the input data for the inference scheduler, + // including delimiter, format, and dataset location. DataInputConfiguration *types.InferenceInputConfiguration - // Specifies information for the output results from the inference scheduler, + // Specifies information for the output results from the inference scheduler, // including the output S3 location. DataOutputConfiguration *types.InferenceOutputConfiguration @@ -60,7 +60,7 @@ type UpdateInferenceSchedulerInput struct { // example, it starts once every 5 minutes. DataUploadFrequency types.DataUploadFrequency - // The Amazon Resource Name (ARN) of a role with permission to access the data + // The Amazon Resource Name (ARN) of a role with permission to access the data // source for the inference scheduler. RoleArn *string diff --git a/service/lookoutequipment/api_op_UpdateLabelGroup.go b/service/lookoutequipment/api_op_UpdateLabelGroup.go index 120e701324a..dbb7740f6ef 100644 --- a/service/lookoutequipment/api_op_UpdateLabelGroup.go +++ b/service/lookoutequipment/api_op_UpdateLabelGroup.go @@ -28,14 +28,15 @@ func (c *Client) UpdateLabelGroup(ctx context.Context, params *UpdateLabelGroupI type UpdateLabelGroupInput struct { - // The name of the label group to be updated. + // The name of the label group to be updated. // // This member is required. LabelGroupName *string - // Updates the code indicating 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. + // Updates the code indicating 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. FaultCodes []string noSmithyDocumentSerde diff --git a/service/lookoutequipment/api_op_UpdateRetrainingScheduler.go b/service/lookoutequipment/api_op_UpdateRetrainingScheduler.go index 4464512ed0b..d19197bf419 100644 --- a/service/lookoutequipment/api_op_UpdateRetrainingScheduler.go +++ b/service/lookoutequipment/api_op_UpdateRetrainingScheduler.go @@ -40,19 +40,24 @@ type UpdateRetrainingSchedulerInput struct { // Indicates how the service will use new models. In MANAGED mode, new models will // automatically be used for inference if they have better performance than the - // current model. In MANUAL mode, the new models will not be used until they are - // manually activated (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation) - // . + // current model. In MANUAL mode, the new models will not be used [until they are manually activated]. + // + // [until they are manually activated]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation PromoteMode types.ModelPromoteMode - // This parameter uses the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) - // standard to set the frequency at which you want retraining to occur in terms of - // Years, Months, and/or Days (note: other parameters like Time are not currently - // supported). The minimum value is 30 days (P30D) and the maximum value is 1 year - // (P1Y). For example, the following values are valid: + // This parameter uses the [ISO 8601] standard to set the frequency at which you want + // retraining to occur in terms of Years, Months, and/or Days (note: other + // parameters like Time are not currently supported). The minimum value is 30 days + // (P30D) and the maximum value is 1 year (P1Y). For example, the following values + // are valid: + // // - P3M15D – Every 3 months and 15 days + // // - P2M – Every 2 months + // // - P150D – Every 150 days + // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601#Durations RetrainingFrequency *string // The start date for the retraining scheduler. Lookout for Equipment truncates diff --git a/service/lookoutequipment/options.go b/service/lookoutequipment/options.go index dbb223aa037..b1d214ecc1c 100644 --- a/service/lookoutequipment/options.go +++ b/service/lookoutequipment/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lookoutequipment/types/enums.go b/service/lookoutequipment/types/enums.go index ecf1002c2b6..aad0147d7ac 100644 --- a/service/lookoutequipment/types/enums.go +++ b/service/lookoutequipment/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AutoPromotionResult. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoPromotionResult) Values() []AutoPromotionResult { return []AutoPromotionResult{ "MODEL_PROMOTED", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for DatasetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatus) Values() []DatasetStatus { return []DatasetStatus{ "CREATED", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for DataUploadFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataUploadFrequency) Values() []DataUploadFrequency { return []DataUploadFrequency{ "PT5M", @@ -83,6 +86,7 @@ const ( // Values returns all known values for InferenceDataImportStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InferenceDataImportStrategy) Values() []InferenceDataImportStrategy { return []InferenceDataImportStrategy{ @@ -103,6 +107,7 @@ const ( // 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{ @@ -124,6 +129,7 @@ const ( // 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{ @@ -145,8 +151,9 @@ const ( ) // Values returns all known values for IngestionJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionJobStatus) Values() []IngestionJobStatus { return []IngestionJobStatus{ "IN_PROGRESS", @@ -166,8 +173,9 @@ const ( ) // Values returns all known values for LabelRating. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LabelRating) Values() []LabelRating { return []LabelRating{ "ANOMALY", @@ -185,8 +193,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ANOMALOUS", @@ -203,8 +212,9 @@ const ( ) // Values returns all known values for ModelPromoteMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPromoteMode) Values() []ModelPromoteMode { return []ModelPromoteMode{ "MANAGED", @@ -222,8 +232,9 @@ const ( ) // Values returns all known values for ModelQuality. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelQuality) Values() []ModelQuality { return []ModelQuality{ "QUALITY_THRESHOLD_MET", @@ -243,8 +254,9 @@ const ( ) // Values returns all known values for ModelStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelStatus) Values() []ModelStatus { return []ModelStatus{ "IN_PROGRESS", @@ -264,8 +276,9 @@ const ( ) // Values returns all known values for ModelVersionSourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelVersionSourceType) Values() []ModelVersionSourceType { return []ModelVersionSourceType{ "TRAINING", @@ -286,8 +299,9 @@ const ( ) // Values returns all known values for ModelVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelVersionStatus) Values() []ModelVersionStatus { return []ModelVersionStatus{ "IN_PROGRESS", @@ -308,8 +322,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -330,6 +345,7 @@ const ( // Values returns all known values for RetrainingSchedulerStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RetrainingSchedulerStatus) Values() []RetrainingSchedulerStatus { return []RetrainingSchedulerStatus{ @@ -349,8 +365,9 @@ const ( ) // Values returns all known values for StatisticalIssueStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatisticalIssueStatus) Values() []StatisticalIssueStatus { return []StatisticalIssueStatus{ "POTENTIAL_ISSUE_DETECTED", @@ -376,8 +393,9 @@ const ( ) // Values returns all known values for TargetSamplingRate. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetSamplingRate) Values() []TargetSamplingRate { return []TargetSamplingRate{ "PT1S", diff --git a/service/lookoutequipment/types/errors.go b/service/lookoutequipment/types/errors.go index 7a86e4c347b..86f84914382 100644 --- a/service/lookoutequipment/types/errors.go +++ b/service/lookoutequipment/types/errors.go @@ -34,7 +34,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request could not be completed due to a conflict with the current state of +// The request could not be completed due to a conflict with the current state of +// // the target resource. type ConflictException struct { Message *string @@ -61,7 +62,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Processing of the request has failed because of an unknown error, exception or +// Processing of the request has failed because of an unknown error, exception or +// // failure. type InternalServerException struct { Message *string @@ -88,7 +90,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 +// The resource requested could not be found. Verify the resource ID and retry +// // your request. type ResourceNotFoundException struct { Message *string @@ -167,7 +170,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 +// The input fails to satisfy constraints specified by Amazon Lookout for +// // Equipment or a related Amazon Web Services 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 12c34319397..ce531955b4a 100644 --- a/service/lookoutequipment/types/types.go +++ b/service/lookoutequipment/types/types.go @@ -10,12 +10,13 @@ import ( // Entity that comprises information on categorical values in data. type CategoricalValues struct { - // Indicates whether there is a potential data issue related to categorical values. + // Indicates whether there is a potential data issue related to categorical + // values. // // This member is required. Status StatisticalIssueStatus - // Indicates the number of categories in the data. + // Indicates the number of categories in the data. NumberOfCategory *int32 noSmithyDocumentSerde @@ -24,12 +25,12 @@ type CategoricalValues struct { // Entity that comprises information of count and percentage. type CountPercent struct { - // Indicates the count of occurences of the given statistic. + // Indicates the count of occurences of the given statistic. // // This member is required. Count *int32 - // Indicates the percentage of occurances of the given statistic. + // Indicates the percentage of occurances of the given statistic. // // This member is required. Percentage float32 @@ -47,7 +48,7 @@ type DataIngestionJobSummary struct { // The name of the dataset used for the data ingestion job. DatasetName *string - // Specifies information for the input data for the data inference job, including + // Specifies information for the input data for the data inference job, including // data Amazon S3 location parameters. IngestionInputConfiguration *IngestionInputConfiguration @@ -64,55 +65,59 @@ type DataIngestionJobSummary struct { // 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 -// 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 +// 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 type DataPreProcessingConfiguration struct { // 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 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 + // 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 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 noSmithyDocumentSerde } -// DataQualitySummary gives aggregated statistics over all the sensors about a +// DataQualitySummary gives aggregated statistics over all the sensors about a +// // completed ingestion job. It primarily gives more information about statistics // over different incorrect data like MissingCompleteSensorData, MissingSensorData, // UnsupportedDateFormats, InsufficientSensorData, DuplicateTimeStamps. type DataQualitySummary struct { - // Parameter that gives information about duplicate timestamps in the input data. + // Parameter that gives information about duplicate timestamps in the input data. // // This member is required. DuplicateTimestamps *DuplicateTimestamps - // Parameter that gives information about insufficient data for sensors in the + // Parameter that gives information about insufficient data for sensors in the // dataset. This includes information about those sensors that have complete data // missing and those with a short date range. // // This member is required. InsufficientSensorData *InsufficientSensorData - // Parameter that gives information about data that is invalid over all the + // 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 + // Parameter that gives information about data that is missing over all the // sensors in the input data. // // This member is required. MissingSensorData *MissingSensorData - // Parameter that gives information about unsupported timestamps in the input data. + // Parameter that gives information about unsupported timestamps in the input + // data. // // This member is required. UnsupportedTimestamps *UnsupportedTimestamps @@ -153,7 +158,7 @@ type DatasetSummary struct { // Entity that comprises information abount duplicate timestamps in the dataset. type DuplicateTimestamps struct { - // Indicates the total number of duplicate timestamps. + // Indicates the total number of duplicate timestamps. // // This member is required. TotalNumberOfDuplicateTimestamps *int32 @@ -165,11 +170,11 @@ type DuplicateTimestamps struct { // 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 - // inference event. + // An array which specifies the names and values of all sensors contributing to + // an inference event. Diagnostics *string - // Indicates the size of an inference event in seconds. + // Indicates the size of an inference event in seconds. EventDurationInSeconds *int64 // Indicates the ending time of an inference event. @@ -178,7 +183,7 @@ type InferenceEventSummary struct { // Indicates the starting time of an inference event. EventStartTime *time.Time - // The Amazon Resource Name (ARN) of the inference scheduler being used for the + // The Amazon Resource Name (ARN) of the inference scheduler being used for the // inference event. InferenceSchedulerArn *string @@ -200,11 +205,11 @@ type InferenceExecutionSummary struct { // stopped. DataEndTime *time.Time - // Specifies configuration information for the input data for the inference + // Specifies configuration information for the input data for the inference // scheduler, including delimiter, format, and dataset location. DataInputConfiguration *InferenceInputConfiguration - // Specifies configuration information for the output results from for the + // Specifies configuration information for the output results from for the // inference execution, including the output Amazon S3 location. DataOutputConfiguration *InferenceOutputConfiguration @@ -212,10 +217,10 @@ type InferenceExecutionSummary struct { // began. DataStartTime *time.Time - // Specifies the reason for failure when an inference execution has failed. + // Specifies the reason for failure when an inference execution has failed. FailedReason *string - // The Amazon Resource Name (ARN) of the inference scheduler being used for the + // The Amazon Resource Name (ARN) of the inference scheduler being used for the // inference execution. InferenceSchedulerArn *string @@ -258,7 +263,7 @@ type InferenceInputConfiguration struct { // (UTC). InputTimeZoneOffset *string - // Specifies configuration information for the input data for the inference, + // Specifies configuration information for the input data for the inference, // including Amazon S3 location of input data. S3InputConfiguration *InferenceS3InputConfiguration @@ -279,11 +284,12 @@ type InferenceInputNameConfiguration struct { noSmithyDocumentSerde } -// Specifies configuration information for the output results from for the +// Specifies configuration information for the output results from for the +// // inference, including KMS key ID and output S3 location. type InferenceOutputConfiguration struct { - // Specifies configuration information for the output results from for the + // Specifies configuration information for the output results from for the // inference, output S3 location. // // This member is required. @@ -295,7 +301,8 @@ type InferenceOutputConfiguration struct { noSmithyDocumentSerde } -// Specifies configuration information for the input data for the inference, +// Specifies configuration information for the input data for the inference, +// // including input data S3 location. type InferenceS3InputConfiguration struct { @@ -310,16 +317,17 @@ type InferenceS3InputConfiguration struct { noSmithyDocumentSerde } -// Specifies configuration information for the output results from the inference, +// Specifies configuration information for the output results from the inference, +// // including output S3 location. type InferenceS3OutputConfiguration struct { - // The bucket containing the output results from the inference + // The bucket containing the output results from the inference // // This member is required. Bucket *string - // The prefix for the S3 bucket used for the output results from the inference. + // The prefix for the S3 bucket used for the output results from the inference. Prefix *string noSmithyDocumentSerde @@ -347,7 +355,7 @@ type InferenceSchedulerSummary struct { // example, it starts once every 5 minutes. DataUploadFrequency DataUploadFrequency - // The Amazon Resource Name (ARN) of the inference scheduler. + // The Amazon Resource Name (ARN) of the inference scheduler. InferenceSchedulerArn *string // The name of the inference scheduler. @@ -357,7 +365,7 @@ type InferenceSchedulerSummary struct { // Anomalous (anomalous events found) or Normal (no anomalous events found). LatestInferenceResult LatestInferenceResult - // The Amazon Resource Name (ARN) of the machine learning model used by the + // The Amazon Resource Name (ARN) of the machine learning model used by the // inference scheduler. ModelArn *string @@ -391,7 +399,8 @@ type IngestedFilesSummary struct { noSmithyDocumentSerde } -// Specifies configuration information for the input data for the data ingestion +// Specifies configuration information for the input data for the data ingestion +// // job, including input data S3 location. type IngestionInputConfiguration struct { @@ -404,7 +413,8 @@ type IngestionInputConfiguration struct { noSmithyDocumentSerde } -// Specifies S3 configuration information for the input data for the data +// Specifies S3 configuration information for the input data for the data +// // ingestion job. type IngestionS3InputConfiguration struct { @@ -413,13 +423,15 @@ type IngestionS3InputConfiguration struct { // This member is required. Bucket *string - // The pattern for matching the Amazon S3 files that will be used for ingestion. + // The pattern for matching the Amazon S3 files that will be used for ingestion. // If the schema was created previously without any KeyPattern, then the default // KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 // according to the schema. This field is required when ingestion is being done for - // the first time. Valid Values: {prefix}/{component_name}_* | - // {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed - // delimiters : space, dot, underscore, hyphen) + // the first time. + // + // Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | + // {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, + // underscore, hyphen) KeyPattern *string // The prefix for the S3 location being used for the input data for the data @@ -429,17 +441,18 @@ type IngestionS3InputConfiguration struct { noSmithyDocumentSerde } -// Entity that comprises aggregated information on sensors having insufficient +// Entity that comprises aggregated information on sensors having insufficient +// // data. type InsufficientSensorData struct { - // Parameter that describes the total number of sensors that have data completely + // Parameter that describes the total number of sensors that have data completely // missing for it. // // This member is required. MissingCompleteSensorData *MissingCompleteSensorData - // Parameter that describes the total number of sensors that have a short date + // Parameter that describes the total number of sensors that have a short date // range of less than 14 days of data overall. // // This member is required. @@ -448,16 +461,17 @@ type InsufficientSensorData struct { noSmithyDocumentSerde } -// Entity that comprises aggregated information on sensors having insufficient +// Entity that comprises aggregated information on sensors having insufficient +// // data. type InvalidSensorData struct { - // Indicates the number of sensors that have at least some invalid values. + // Indicates the number of sensors that have at least some invalid values. // // This member is required. AffectedSensorCount *int32 - // Indicates the total number of invalid values across all the sensors. + // Indicates the total number of invalid values across all the sensors. // // This member is required. TotalNumberOfInvalidValues *int32 @@ -468,16 +482,16 @@ type InvalidSensorData struct { // Contains information about the label group. type LabelGroupSummary struct { - // The time at which the label group was created. + // The time at which the label group was created. CreatedAt *time.Time - // The Amazon Resource Name (ARN) of the label group. + // The Amazon Resource Name (ARN) of the label group. LabelGroupArn *string - // The name of the label group. + // The name of the label group. LabelGroupName *string - // The time at which the label group was updated. + // The time at which the label group was updated. UpdatedAt *time.Time noSmithyDocumentSerde @@ -487,7 +501,7 @@ type LabelGroupSummary struct { // label data. type LabelsInputConfiguration struct { - // The name of the label group to be used for label data. + // The name of the label group to be used for label data. LabelGroupName *string // Contains location information for the S3 location being used for label data. @@ -505,7 +519,7 @@ type LabelsS3InputConfiguration struct { // This member is required. Bucket *string - // The prefix for the S3 bucket used for the label data. + // The prefix for the S3 bucket used for the label data. Prefix *string noSmithyDocumentSerde @@ -514,62 +528,65 @@ type LabelsS3InputConfiguration struct { // Information about the label. type LabelSummary struct { - // The time at which the label was created. + // The time at which the label was created. CreatedAt *time.Time - // The timestamp indicating the end of the label. + // The timestamp indicating the end of the label. EndTime *time.Time - // Indicates that a label pertains to a particular piece of equipment. + // 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 Amazon Resource Name (ARN) of the label group. + // The Amazon Resource Name (ARN) of the label group. LabelGroupArn *string - // The name of the label group. + // The name of the label group. LabelGroupName *string - // The ID of the label. + // The ID of the label. LabelId *string - // Indicates whether a labeled event represents an anomaly. + // Indicates whether a labeled event represents an anomaly. Rating LabelRating - // The timestamp indicating the start of the label. + // The timestamp indicating the start of the label. StartTime *time.Time noSmithyDocumentSerde } -// Entity that comprises information on large gaps between consecutive timestamps +// Entity that comprises information on large gaps between consecutive timestamps +// // in data. type LargeTimestampGaps struct { - // Indicates whether there is a potential data issue related to large gaps in + // Indicates whether there is a potential data issue related to large gaps in // timestamps. // // This member is required. Status StatisticalIssueStatus - // Indicates the size of the largest timestamp gap, in days. + // Indicates the size of the largest timestamp gap, in days. MaxTimestampGapInDays *int32 - // Indicates the number of large timestamp gaps, if there are any. + // Indicates the number of large timestamp gaps, if there are any. NumberOfLargeTimestampGaps *int32 noSmithyDocumentSerde } -// Entity that comprises information on sensors that have sensor data completely +// Entity that comprises information on sensors that have sensor data completely +// // missing. type MissingCompleteSensorData struct { - // Indicates the number of sensors that have data missing completely. + // Indicates the number of sensors that have data missing completely. // // This member is required. AffectedSensorCount *int32 @@ -580,12 +597,12 @@ type MissingCompleteSensorData struct { // Entity that comprises aggregated information on sensors having missing data. type MissingSensorData struct { - // Indicates the number of sensors that have atleast some data missing. + // Indicates the number of sensors that have atleast some data missing. // // This member is required. AffectedSensorCount *int32 - // Indicates the total number of missing values across all the sensors. + // Indicates the total number of missing values across all the sensors. // // This member is required. TotalNumberOfMissingValues *int32 @@ -620,13 +637,15 @@ type ModelDiagnosticsS3OutputConfiguration struct { Bucket *string // The Amazon S3 prefix for the location of the pointwise model diagnostics. The - // prefix specifies the folder and evaluation result file name. ( bucket ). When - // you call CreateModel or UpdateModel , specify the path within the bucket that - // you want Lookout for Equipment to save the model to. During training, Lookout - // for Equipment creates the model evaluation model as a compressed JSON file with - // the name model_diagnostics_results.json.gz . When you call DescribeModel or - // DescribeModelVersion , prefix contains the file path and filename of the model - // evaluation file. + // prefix specifies the folder and evaluation result file name. ( bucket ). + // + // When you call CreateModel or UpdateModel , specify the path within the bucket + // that you want Lookout for Equipment to save the model to. During training, + // Lookout for Equipment creates the model evaluation model as a compressed JSON + // file with the name model_diagnostics_results.json.gz . + // + // When you call DescribeModel or DescribeModelVersion , prefix contains the file + // path and filename of the model evaluation file. Prefix *string noSmithyDocumentSerde @@ -648,7 +667,7 @@ type ModelSummary struct { // The time at which the specific model was created. CreatedAt *time.Time - // The Amazon Resource Name (ARN) of the dataset used to create the model. + // The Amazon Resource Name (ARN) of the dataset used to create the model. DatasetArn *string // The name of the dataset being used for the machine learning model. @@ -663,7 +682,7 @@ type ModelSummary struct { // Indicates the status of the most recent scheduled retraining run. LatestScheduledRetrainingStatus ModelVersionStatus - // The Amazon Resource Name (ARN) of the machine learning model. + // The Amazon Resource Name (ARN) of the machine learning model. ModelArn *string // Output configuration information for the pointwise model diagnostics for an @@ -676,19 +695,25 @@ type ModelSummary struct { // Provides a quality assessment for a model that uses labels. If Lookout for // Equipment determines that the model quality is poor based on training metrics, // the value is POOR_QUALITY_DETECTED . Otherwise, the value is - // QUALITY_THRESHOLD_MET . If the model is unlabeled, the model quality can't be - // assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY . In this - // situation, you can get a model quality assessment by adding labels to the input - // dataset and retraining the model. For information about using labels with your - // models, see Understanding labeling (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html) - // . For information about improving the quality of a model, see Best practices - // with Amazon Lookout for Equipment (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html) - // . + // QUALITY_THRESHOLD_MET . + // + // If the model is unlabeled, the model quality can't be assessed and the value of + // ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a + // model quality assessment by adding labels to the input dataset and retraining + // the model. + // + // For information about using labels with your models, see [Understanding labeling]. + // + // For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment]. + // + // [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html + // [Understanding labeling]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html ModelQuality ModelQuality // Indicates the date that the next scheduled retraining run will start on. - // Lookout for Equipment truncates the time you provide to the nearest UTC day (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // . + // Lookout for Equipment truncates the time you provide to [the nearest UTC day]. + // + // [the nearest UTC day]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp NextScheduledRetrainingStartDate *time.Time // Indicates the status of the retraining scheduler. @@ -716,12 +741,16 @@ type ModelVersionSummary struct { // Provides a quality assessment for a model that uses labels. If Lookout for // Equipment determines that the model quality is poor based on training metrics, // the value is POOR_QUALITY_DETECTED . Otherwise, the value is - // QUALITY_THRESHOLD_MET . If the model is unlabeled, the model quality can't be - // assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY . In this - // situation, you can get a model quality assessment by adding labels to the input - // dataset and retraining the model. For information about improving the quality of - // a model, see Best practices with Amazon Lookout for Equipment (https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html) - // . + // QUALITY_THRESHOLD_MET . + // + // If the model is unlabeled, the model quality can't be assessed and the value of + // ModelQuality is CANNOT_DETERMINE_QUALITY . In this situation, you can get a + // model quality assessment by adding labels to the input dataset and retraining + // the model. + // + // For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment]. + // + // [Best practices with Amazon Lookout for Equipment]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html ModelQuality ModelQuality // The version of the model. @@ -742,13 +771,14 @@ type ModelVersionSummary struct { // Entity that comprises information on monotonic values in the data. type MonotonicValues struct { - // Indicates whether there is a potential data issue related to having monotonic + // Indicates whether there is a potential data issue related to having monotonic // values. // // This member is required. Status StatisticalIssueStatus - // Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC. + // Indicates the monotonicity of values. Can be INCREASING, DECREASING, or + // STATIC. Monotonicity Monotonicity noSmithyDocumentSerde @@ -757,7 +787,7 @@ type MonotonicValues struct { // Entity that comprises information on operating modes in data. type MultipleOperatingModes struct { - // Indicates whether there is a potential data issue related to having multiple + // Indicates whether there is a potential data issue related to having multiple // operating modes. // // This member is required. @@ -779,8 +809,10 @@ type RetrainingSchedulerSummary struct { // The name of the model that the retraining scheduler is attached to. ModelName *string - // The frequency at which the model retraining is set. This follows the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) + // The frequency at which the model retraining is set. This follows the [ISO 8601] // guidelines. + // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601#Durations RetrainingFrequency *string // The start date for the retraining scheduler. Lookout for Equipment truncates @@ -810,59 +842,60 @@ type S3Object struct { noSmithyDocumentSerde } -// Summary of ingestion statistics like whether data exists, number of missing +// Summary of ingestion statistics like whether data exists, number of missing +// // values, number of invalid values and so on related to the particular sensor. type SensorStatisticsSummary struct { - // Parameter that describes potential risk about whether data associated with the + // Parameter that describes potential risk about whether data associated with the // sensor is categorical. CategoricalValues *CategoricalValues - // Name of the component to which the particular sensor belongs for which the + // Name of the component to which the particular sensor belongs for which the // statistics belong to. ComponentName *string - // Indicates the time reference to indicate the end of valid data associated with + // Indicates the time reference to indicate the end of valid data associated with // the sensor that the statistics belong to. DataEndTime *time.Time - // Parameter that indicates whether data exists for the sensor that the statistics - // belong to. + // Parameter that indicates whether data exists for the sensor that the + // statistics belong to. DataExists bool - // Indicates the time reference to indicate the beginning of valid data associated - // with the sensor that the statistics belong to. + // Indicates the time reference to indicate the beginning of valid data + // associated with the sensor that the statistics belong to. DataStartTime *time.Time - // Parameter that describes the total number of duplicate timestamp records + // Parameter that describes the total number of duplicate timestamp records // associated with the sensor that the statistics belong to. DuplicateTimestamps *CountPercent - // Parameter that describes the total number of invalid date entries associated + // Parameter that describes the total number of invalid date entries associated // with the sensor that the statistics belong to. InvalidDateEntries *CountPercent - // Parameter that describes the total number of, and percentage of, values that + // 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 + // 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 + // 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 + // Parameter that describes potential risk about whether data associated with the // sensor is mostly monotonic. MonotonicValues *MonotonicValues - // Parameter that describes potential risk about whether data associated with the + // Parameter that describes potential risk about whether data associated with the // sensor has more than one operating mode. MultipleOperatingModes *MultipleOperatingModes - // Name of the sensor that the statistics belong to. + // Name of the sensor that the statistics belong to. SensorName *string noSmithyDocumentSerde @@ -871,7 +904,7 @@ type SensorStatisticsSummary struct { // Entity that comprises information on sensors that have shorter date range. type SensorsWithShortDateRange struct { - // Indicates the number of sensors that have less than 14 days of data. + // Indicates the number of sensors that have less than 14 days of data. // // This member is required. AffectedSensorCount *int32 @@ -895,10 +928,12 @@ type Tag struct { noSmithyDocumentSerde } -// Entity that comprises information abount unsupported timestamps in the dataset. +// Entity that comprises information abount unsupported timestamps in the +// +// dataset. type UnsupportedTimestamps struct { - // Indicates the total number of unsupported timestamps across the ingested data. + // Indicates the total number of unsupported timestamps across the ingested data. // // This member is required. TotalNumberOfUnsupportedTimestamps *int32 diff --git a/service/lookoutmetrics/api_op_CreateAlert.go b/service/lookoutmetrics/api_op_CreateAlert.go index 4b66c512b6f..bb9fc08d625 100644 --- a/service/lookoutmetrics/api_op_CreateAlert.go +++ b/service/lookoutmetrics/api_op_CreateAlert.go @@ -54,8 +54,9 @@ 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] to apply to the alert. + // + // [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/lookoutmetrics/api_op_CreateAnomalyDetector.go b/service/lookoutmetrics/api_op_CreateAnomalyDetector.go index 6d20f436ee0..13908585d6f 100644 --- a/service/lookoutmetrics/api_op_CreateAnomalyDetector.go +++ b/service/lookoutmetrics/api_op_CreateAnomalyDetector.go @@ -45,8 +45,9 @@ 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] to apply to the anomaly detector. + // + // [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/lookoutmetrics/api_op_CreateMetricSet.go b/service/lookoutmetrics/api_op_CreateMetricSet.go index 55a0cb41ec3..d626c232ab8 100644 --- a/service/lookoutmetrics/api_op_CreateMetricSet.go +++ b/service/lookoutmetrics/api_op_CreateMetricSet.go @@ -66,8 +66,9 @@ 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] to apply to the dataset. + // + // [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html Tags map[string]string // Contains information about the column used for tracking time in your source diff --git a/service/lookoutmetrics/api_op_DescribeAlert.go b/service/lookoutmetrics/api_op_DescribeAlert.go index 509acb1b051..413c499924c 100644 --- a/service/lookoutmetrics/api_op_DescribeAlert.go +++ b/service/lookoutmetrics/api_op_DescribeAlert.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an alert. Amazon Lookout for Metrics API actions are eventually -// consistent. If you do a read operation on a resource immediately after creating -// or modifying it, use retries to allow time for the write operation to complete. +// Describes an alert. +// +// Amazon Lookout for Metrics API actions are eventually consistent. If you do a +// read operation on a resource immediately after creating or modifying it, use +// retries to allow time for the write operation to complete. func (c *Client) DescribeAlert(ctx context.Context, params *DescribeAlertInput, optFns ...func(*Options)) (*DescribeAlertOutput, error) { if params == nil { params = &DescribeAlertInput{} diff --git a/service/lookoutmetrics/api_op_DescribeAnomalyDetector.go b/service/lookoutmetrics/api_op_DescribeAnomalyDetector.go index d63b115d2ce..933d4ea9aa5 100644 --- a/service/lookoutmetrics/api_op_DescribeAnomalyDetector.go +++ b/service/lookoutmetrics/api_op_DescribeAnomalyDetector.go @@ -12,9 +12,11 @@ import ( "time" ) -// Describes a detector. Amazon Lookout for Metrics API actions are eventually -// consistent. If you do a read operation on a resource immediately after creating -// or modifying it, use retries to allow time for the write operation to complete. +// Describes a detector. +// +// Amazon Lookout for Metrics API actions are eventually consistent. If you do a +// read operation on a resource immediately after creating or modifying it, use +// retries to allow time for the write operation to complete. func (c *Client) DescribeAnomalyDetector(ctx context.Context, params *DescribeAnomalyDetectorInput, optFns ...func(*Options)) (*DescribeAnomalyDetectorOutput, error) { if params == nil { params = &DescribeAnomalyDetectorInput{} diff --git a/service/lookoutmetrics/api_op_DescribeMetricSet.go b/service/lookoutmetrics/api_op_DescribeMetricSet.go index cff84067fa8..0ce3d5b39c1 100644 --- a/service/lookoutmetrics/api_op_DescribeMetricSet.go +++ b/service/lookoutmetrics/api_op_DescribeMetricSet.go @@ -12,9 +12,11 @@ import ( "time" ) -// Describes a dataset. Amazon Lookout for Metrics API actions are eventually -// consistent. If you do a read operation on a resource immediately after creating -// or modifying it, use retries to allow time for the write operation to complete. +// Describes a dataset. +// +// Amazon Lookout for Metrics API actions are eventually consistent. If you do a +// read operation on a resource immediately after creating or modifying it, use +// retries to allow time for the write operation to complete. func (c *Client) DescribeMetricSet(ctx context.Context, params *DescribeMetricSetInput, optFns ...func(*Options)) (*DescribeMetricSetOutput, error) { if params == nil { params = &DescribeMetricSetInput{} diff --git a/service/lookoutmetrics/api_op_ListAlerts.go b/service/lookoutmetrics/api_op_ListAlerts.go index da365e57e99..ddfa8999a32 100644 --- a/service/lookoutmetrics/api_op_ListAlerts.go +++ b/service/lookoutmetrics/api_op_ListAlerts.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the alerts attached to a detector. Amazon Lookout for Metrics API actions -// are eventually consistent. If you do a read operation on a resource immediately -// after creating or modifying it, use retries to allow time for the write -// operation to complete. +// Lists the alerts attached to a detector. +// +// Amazon Lookout for Metrics API actions are eventually consistent. If you do a +// read operation on a resource immediately after creating or modifying it, use +// retries to allow time for the write operation to complete. func (c *Client) ListAlerts(ctx context.Context, params *ListAlertsInput, optFns ...func(*Options)) (*ListAlertsOutput, error) { if params == nil { params = &ListAlertsInput{} diff --git a/service/lookoutmetrics/api_op_ListAnomalyDetectors.go b/service/lookoutmetrics/api_op_ListAnomalyDetectors.go index 9ee14575287..6ce7220303f 100644 --- a/service/lookoutmetrics/api_op_ListAnomalyDetectors.go +++ b/service/lookoutmetrics/api_op_ListAnomalyDetectors.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the detectors in the current AWS Region. Amazon Lookout for Metrics API -// actions are eventually consistent. If you do a read operation on a resource -// immediately after creating or modifying it, use retries to allow time for the -// write operation to complete. +// Lists the detectors in the current AWS Region. +// +// Amazon Lookout for Metrics API actions are eventually consistent. If you do a +// read operation on a resource immediately after creating or modifying it, use +// retries to allow time for the write operation to complete. func (c *Client) ListAnomalyDetectors(ctx context.Context, params *ListAnomalyDetectorsInput, optFns ...func(*Options)) (*ListAnomalyDetectorsOutput, error) { if params == nil { params = &ListAnomalyDetectorsInput{} diff --git a/service/lookoutmetrics/api_op_ListMetricSets.go b/service/lookoutmetrics/api_op_ListMetricSets.go index 455956df046..50c76269996 100644 --- a/service/lookoutmetrics/api_op_ListMetricSets.go +++ b/service/lookoutmetrics/api_op_ListMetricSets.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the datasets in the current AWS Region. Amazon Lookout for Metrics API -// actions are eventually consistent. If you do a read operation on a resource -// immediately after creating or modifying it, use retries to allow time for the -// write operation to complete. +// Lists the datasets in the current AWS Region. +// +// Amazon Lookout for Metrics API actions are eventually consistent. If you do a +// read operation on a resource immediately after creating or modifying it, use +// retries to allow time for the write operation to complete. func (c *Client) ListMetricSets(ctx context.Context, params *ListMetricSetsInput, optFns ...func(*Options)) (*ListMetricSetsOutput, error) { if params == nil { params = &ListMetricSetsInput{} diff --git a/service/lookoutmetrics/api_op_ListTagsForResource.go b/service/lookoutmetrics/api_op_ListTagsForResource.go index fc05ae74395..bc903416be7 100644 --- a/service/lookoutmetrics/api_op_ListTagsForResource.go +++ b/service/lookoutmetrics/api_op_ListTagsForResource.go @@ -10,8 +10,9 @@ 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] for a detector, dataset, or alert. +// +// [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html 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 9b37a3a5e0d..78c3cfa4e4a 100644 --- a/service/lookoutmetrics/api_op_TagResource.go +++ b/service/lookoutmetrics/api_op_TagResource.go @@ -10,8 +10,9 @@ 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] to a detector, dataset, or alert. +// +// [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/lookoutmetrics/api_op_UntagResource.go b/service/lookoutmetrics/api_op_UntagResource.go index 71653f1516e..f6a2e7b962d 100644 --- a/service/lookoutmetrics/api_op_UntagResource.go +++ b/service/lookoutmetrics/api_op_UntagResource.go @@ -10,8 +10,9 @@ 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] from a detector, dataset, or alert. +// +// [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/lookoutmetrics/doc.go b/service/lookoutmetrics/doc.go index 01c003ce057..19d15f80e3f 100644 --- a/service/lookoutmetrics/doc.go +++ b/service/lookoutmetrics/doc.go @@ -4,6 +4,7 @@ // 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) . +// the service with tutorials for getting started, visit [Amazon Lookout for Metrics Developer Guide]. +// +// [Amazon Lookout for Metrics Developer Guide]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev package lookoutmetrics diff --git a/service/lookoutmetrics/options.go b/service/lookoutmetrics/options.go index 2438aeaa481..7a5ea5fa9e8 100644 --- a/service/lookoutmetrics/options.go +++ b/service/lookoutmetrics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lookoutmetrics/types/enums.go b/service/lookoutmetrics/types/enums.go index af8c4a0ac1a..26f00c1f91a 100644 --- a/service/lookoutmetrics/types/enums.go +++ b/service/lookoutmetrics/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AggregationFunction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationFunction) Values() []AggregationFunction { return []AggregationFunction{ "AVG", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AlertStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlertStatus) Values() []AlertStatus { return []AlertStatus{ "ACTIVE", @@ -47,8 +49,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -69,6 +72,7 @@ const ( // Values returns all known values for AnomalyDetectionTaskStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyDetectionTaskStatus) Values() []AnomalyDetectionTaskStatus { return []AnomalyDetectionTaskStatus{ @@ -92,6 +96,7 @@ const ( // Values returns all known values for AnomalyDetectorFailureType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnomalyDetectorFailureType) Values() []AnomalyDetectorFailureType { return []AnomalyDetectorFailureType{ @@ -120,8 +125,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -148,8 +154,9 @@ const ( ) // Values returns all known values for Confidence. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Confidence) Values() []Confidence { return []Confidence{ "HIGH", @@ -167,8 +174,9 @@ const ( ) // Values returns all known values for CSVFileCompression. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CSVFileCompression) Values() []CSVFileCompression { return []CSVFileCompression{ "NONE", @@ -193,8 +201,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "COLUMN_COMPLETENESS", @@ -218,8 +227,9 @@ const ( ) // Values returns all known values for FilterOperation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperation) Values() []FilterOperation { return []FilterOperation{ "EQUALS", @@ -237,8 +247,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -257,8 +268,9 @@ const ( ) // Values returns all known values for JsonFileCompression. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JsonFileCompression) Values() []JsonFileCompression { return []JsonFileCompression{ "NONE", @@ -275,8 +287,9 @@ const ( ) // Values returns all known values for RelationshipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationshipType) Values() []RelationshipType { return []RelationshipType{ "CAUSE_OF_INPUT_ANOMALY_GROUP", @@ -294,8 +307,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -316,6 +330,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/lookoutmetrics/types/types.go b/service/lookoutmetrics/types/types.go index 0133de4a5cc..2246fe310b1 100644 --- a/service/lookoutmetrics/types/types.go +++ b/service/lookoutmetrics/types/types.go @@ -99,8 +99,9 @@ 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]. + // + // [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html Tags map[string]string noSmithyDocumentSerde @@ -159,8 +160,9 @@ 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]. + // + // [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html Tags map[string]string noSmithyDocumentSerde @@ -264,7 +266,7 @@ type AnomalyGroupTimeSeriesFeedback struct { // Details about an Amazon AppFlow flow datasource. type AppFlowConfig struct { - // name of the flow. + // name of the flow. FlowName *string // An IAM role that gives Amazon Lookout for Metrics permission to access the flow. @@ -758,8 +760,9 @@ 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]. + // + // [tags]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html Tags map[string]string noSmithyDocumentSerde @@ -909,10 +912,13 @@ 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. SnsFormat SnsFormat diff --git a/service/lookoutvision/api_op_CreateDataset.go b/service/lookoutvision/api_op_CreateDataset.go index 9609cc4fb65..17cb143de94 100644 --- a/service/lookoutvision/api_op_CreateDataset.go +++ b/service/lookoutvision/api_op_CreateDataset.go @@ -13,12 +13,17 @@ import ( // 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. +// 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{} @@ -51,22 +56,27 @@ type CreateDatasetInput struct { // 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 // 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. + // 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 4ebad539a6a..c174fa9dd89 100644 --- a/service/lookoutvision/api_op_CreateModel.go +++ b/service/lookoutvision/api_op_CreateModel.go @@ -13,16 +13,22 @@ import ( // 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 +// 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 -// permissions to perform the lookoutvision:CreateModel operation. If you want to -// tag your model, you also require permission to the lookoutvision:TagResource -// operation. +// train and test the model. +// +// After training completes, the evaluation metrics are 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. func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error) { if params == nil { params = &CreateModelInput{} @@ -54,12 +60,15 @@ type CreateModelInput struct { // 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. + // 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. diff --git a/service/lookoutvision/api_op_CreateProject.go b/service/lookoutvision/api_op_CreateProject.go index 30021b3f9a8..8e8e8cac457 100644 --- a/service/lookoutvision/api_op_CreateProject.go +++ b/service/lookoutvision/api_op_CreateProject.go @@ -12,8 +12,10 @@ import ( ) // Creates an empty Amazon Lookout for Vision project. After you create the -// project, add a dataset by calling CreateDataset . This operation requires -// permissions to perform the lookoutvision:CreateProject operation. +// 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 { params = &CreateProjectInput{} @@ -40,12 +42,15 @@ type CreateProjectInput struct { // 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 // 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. + // 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 f20d3d40290..4d637a49fd7 100644 --- a/service/lookoutvision/api_op_DeleteDataset.go +++ b/service/lookoutvision/api_op_DeleteDataset.go @@ -10,13 +10,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 training dataset, you must create a training dataset // before you can create a model. // @@ -55,12 +60,15 @@ type DeleteDatasetInput struct { // 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 // 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. + // 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 f5790549a2e..141099c145f 100644 --- a/service/lookoutvision/api_op_DeleteModel.go +++ b/service/lookoutvision/api_op_DeleteModel.go @@ -11,11 +11,14 @@ import ( ) // 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. +// To stop a running model, use the StopModeloperation. +// +// It might take a few seconds to delete a model. To determine if a model has been +// deleted, call ListModelsand 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{} @@ -47,12 +50,15 @@ type DeleteModelInput struct { // 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. + // + // 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. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_DeleteProject.go b/service/lookoutvision/api_op_DeleteProject.go index dec3538da3d..e7ef7ceba21 100644 --- a/service/lookoutvision/api_op_DeleteProject.go +++ b/service/lookoutvision/api_op_DeleteProject.go @@ -10,12 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// referenced by the training and test datasets aren't deleted. This operation -// requires permissions to perform the lookoutvision:DeleteProject operation. +// 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 DeleteModeloperation. +// +// You also have to delete the dataset(s) 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) { if params == nil { params = &DeleteProjectInput{} @@ -42,12 +47,15 @@ type DeleteProjectInput struct { // 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 // 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. + // 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 bd5f24165a8..4a484fd55f6 100644 --- a/service/lookoutvision/api_op_DescribeDataset.go +++ b/service/lookoutvision/api_op_DescribeDataset.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe an Amazon Lookout for Vision dataset. This operation requires -// permissions to perform the lookoutvision:DescribeDataset operation. +// Describe an Amazon Lookout for Vision dataset. +// +// This operation requires permissions to perform the lookoutvision:DescribeDataset +// operation. func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} diff --git a/service/lookoutvision/api_op_DescribeModel.go b/service/lookoutvision/api_op_DescribeModel.go index d19a8282232..5a039766478 100644 --- a/service/lookoutvision/api_op_DescribeModel.go +++ b/service/lookoutvision/api_op_DescribeModel.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a version of an Amazon Lookout for Vision model. This operation -// requires permissions to perform the lookoutvision:DescribeModel operation. +// Describes a version of an Amazon Lookout for Vision model. +// +// This operation requires permissions to perform the lookoutvision:DescribeModel +// operation. func (c *Client) DescribeModel(ctx context.Context, params *DescribeModelInput, optFns ...func(*Options)) (*DescribeModelOutput, error) { if params == nil { params = &DescribeModelInput{} diff --git a/service/lookoutvision/api_op_DescribeModelPackagingJob.go b/service/lookoutvision/api_op_DescribeModelPackagingJob.go index 12823d25f6a..ea810c80266 100644 --- a/service/lookoutvision/api_op_DescribeModelPackagingJob.go +++ b/service/lookoutvision/api_op_DescribeModelPackagingJob.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an Amazon Lookout for Vision model packaging job. This operation -// requires permissions to perform the lookoutvision:DescribeModelPackagingJob -// operation. For more information, see Using your Amazon Lookout for Vision model -// on an edge device in the Amazon Lookout for Vision Developer Guide. +// Describes an Amazon Lookout for Vision model packaging job. +// +// This operation requires permissions to perform the +// lookoutvision:DescribeModelPackagingJob operation. +// +// 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) DescribeModelPackagingJob(ctx context.Context, params *DescribeModelPackagingJobInput, optFns ...func(*Options)) (*DescribeModelPackagingJobOutput, error) { if params == nil { params = &DescribeModelPackagingJobInput{} diff --git a/service/lookoutvision/api_op_DescribeProject.go b/service/lookoutvision/api_op_DescribeProject.go index 39229edefa0..0f47756b8dd 100644 --- a/service/lookoutvision/api_op_DescribeProject.go +++ b/service/lookoutvision/api_op_DescribeProject.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an Amazon Lookout for Vision project. This operation requires -// permissions to perform the lookoutvision:DescribeProject operation. +// Describes an Amazon Lookout for Vision project. +// +// This operation requires permissions to perform the lookoutvision:DescribeProject +// operation. func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error) { if params == nil { params = &DescribeProjectInput{} diff --git a/service/lookoutvision/api_op_DetectAnomalies.go b/service/lookoutvision/api_op_DetectAnomalies.go index 323d36e9220..8ffc921c6ef 100644 --- a/service/lookoutvision/api_op_DetectAnomalies.go +++ b/service/lookoutvision/api_op_DetectAnomalies.go @@ -12,17 +12,23 @@ import ( "io" ) -// Detects anomalies in an image that you supply. The response from DetectAnomalies -// 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 -// 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 -// requires permissions to perform the lookoutvision:DetectAnomalies operation. +// Detects anomalies in an image that you supply. +// +// The response from DetectAnomalies 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 units that your model uses. If you are +// not using a model, use the StopModeloperation to stop your model. +// +// For more information, see Detecting anomalies in an image in the Amazon Lookout +// for Vision developer guide. +// +// This operation requires permissions to perform the lookoutvision:DetectAnomalies +// operation. func (c *Client) DetectAnomalies(ctx context.Context, params *DetectAnomaliesInput, optFns ...func(*Options)) (*DetectAnomaliesOutput, error) { if params == nil { params = &DetectAnomaliesInput{} diff --git a/service/lookoutvision/api_op_ListDatasetEntries.go b/service/lookoutvision/api_op_ListDatasetEntries.go index 2d7e235e5e9..d25ac20bd1d 100644 --- a/service/lookoutvision/api_op_ListDatasetEntries.go +++ b/service/lookoutvision/api_op_ListDatasetEntries.go @@ -13,8 +13,10 @@ import ( // Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line // contains the anomaly information for a single image, including the image -// location and the assigned label. This operation requires permissions to perform -// the lookoutvision:ListDatasetEntries operation. +// location and the assigned label. +// +// This operation requires permissions to perform the +// lookoutvision:ListDatasetEntries operation. func (c *Client) ListDatasetEntries(ctx context.Context, params *ListDatasetEntriesInput, optFns ...func(*Options)) (*ListDatasetEntriesOutput, error) { if params == nil { params = &ListDatasetEntriesInput{} diff --git a/service/lookoutvision/api_op_ListModelPackagingJobs.go b/service/lookoutvision/api_op_ListModelPackagingJobs.go index 154335953c6..a25d65a7e86 100644 --- a/service/lookoutvision/api_op_ListModelPackagingJobs.go +++ b/service/lookoutvision/api_op_ListModelPackagingJobs.go @@ -11,11 +11,15 @@ 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 -// 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. +// 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. func (c *Client) ListModelPackagingJobs(ctx context.Context, params *ListModelPackagingJobsInput, optFns ...func(*Options)) (*ListModelPackagingJobsOutput, error) { if params == nil { params = &ListModelPackagingJobsInput{} @@ -33,7 +37,7 @@ func (c *Client) ListModelPackagingJobs(ctx context.Context, params *ListModelPa type ListModelPackagingJobsInput struct { - // The name of the project for which you want to list the model packaging jobs. + // The name of the project for which you want to list the model packaging jobs. // // This member is required. ProjectName *string @@ -53,8 +57,8 @@ type ListModelPackagingJobsInput struct { type ListModelPackagingJobsOutput struct { - // A list of the model packaging jobs created for the specified Amazon Lookout for - // Vision project. + // A list of the model packaging jobs created for the specified Amazon Lookout + // for Vision project. ModelPackagingJobs []types.ModelPackagingJobMetadata // If the previous response was incomplete (because there is more results to diff --git a/service/lookoutvision/api_op_ListModels.go b/service/lookoutvision/api_op_ListModels.go index a43c8709dcc..f60d48780e3 100644 --- a/service/lookoutvision/api_op_ListModels.go +++ b/service/lookoutvision/api_op_ListModels.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// requires permissions to perform the lookoutvision:ListModels operation. +// 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 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 { params = &ListModelsInput{} diff --git a/service/lookoutvision/api_op_ListProjects.go b/service/lookoutvision/api_op_ListProjects.go index 3c2650bd8f3..928ef9052c9 100644 --- a/service/lookoutvision/api_op_ListProjects.go +++ b/service/lookoutvision/api_op_ListProjects.go @@ -12,10 +12,14 @@ import ( ) // 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 -// requires permissions to perform the lookoutvision:ListProjects operation. +// 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 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 { params = &ListProjectsInput{} diff --git a/service/lookoutvision/api_op_ListTagsForResource.go b/service/lookoutvision/api_op_ListTagsForResource.go index 68bca543b2a..740441f12c2 100644 --- a/service/lookoutvision/api_op_ListTagsForResource.go +++ b/service/lookoutvision/api_op_ListTagsForResource.go @@ -12,7 +12,9 @@ import ( ) // Returns a list of tags attached to the specified Amazon Lookout for Vision -// model. This operation requires permissions to perform the +// model. +// +// This operation requires permissions to perform the // lookoutvision:ListTagsForResource operation. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { diff --git a/service/lookoutvision/api_op_StartModel.go b/service/lookoutvision/api_op_StartModel.go index 318bfc2a423..18e41cb9209 100644 --- a/service/lookoutvision/api_op_StartModel.go +++ b/service/lookoutvision/api_op_StartModel.go @@ -13,11 +13,18 @@ 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 . -// 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 -// permissions to perform the lookoutvision:StartModel operation. +// 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 permissions to perform the lookoutvision:StartModel +// operation. func (c *Client) StartModel(ctx context.Context, params *StartModelInput, optFns ...func(*Options)) (*StartModelOutput, error) { if params == nil { params = &StartModelInput{} @@ -56,13 +63,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 value for ClientToken is considered a new call to StartModel . - // An idempotency token is active for 8 hours. + // 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. 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 04b8e7c7427..c5127ee7a51 100644 --- a/service/lookoutvision/api_op_StartModelPackagingJob.go +++ b/service/lookoutvision/api_op_StartModelPackagingJob.go @@ -14,22 +14,35 @@ import ( // Starts an Amazon Lookout for Vision model packaging job. A model packaging job // 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 . +// +// 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) -// API. This operation requires the following permissions: +// component version with the AWS IoT Greengrass [CreateDeployment]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. // // For more information, see Using your Amazon Lookout for Vision model on an edge // device in the Amazon Lookout for Vision Developer Guide. +// +// [CreateDeployment]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_CreateDeployment.html func (c *Client) StartModelPackagingJob(ctx context.Context, params *StartModelPackagingJobInput, optFns ...func(*Options)) (*StartModelPackagingJobOutput, error) { if params == nil { params = &StartModelPackagingJobInput{} @@ -52,12 +65,12 @@ type StartModelPackagingJobInput struct { // This member is required. Configuration *types.ModelPackagingConfiguration - // The version of the model within the project that you want to package. + // The version of the model within the project that you want to package. // // This member is required. ModelVersion *string - // The name of the project which contains the version of the model that you want + // The name of the project which contains the version of the model that you want // to package. // // This member is required. @@ -67,13 +80,16 @@ type StartModelPackagingJobInput struct { // 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 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 StartModelPackagingJob . An idempotency token is active for 8 hours. + // 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 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. 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 a1a21acc7a2..b598284a0cc 100644 --- a/service/lookoutvision/api_op_StopModel.go +++ b/service/lookoutvision/api_op_StopModel.go @@ -12,9 +12,12 @@ 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 -// permissions to perform the lookoutvision:StopModel operation. +// 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 { params = &StopModelInput{} @@ -45,13 +48,16 @@ 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 - // 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 - // 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 - // idempotency token is active for 8 hours. + // 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 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 idempotency token is active for 8 hours. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/api_op_TagResource.go b/service/lookoutvision/api_op_TagResource.go index d08917fc728..0d2c2921eab 100644 --- a/service/lookoutvision/api_op_TagResource.go +++ b/service/lookoutvision/api_op_TagResource.go @@ -13,8 +13,10 @@ import ( // Adds one or more key-value tags to an Amazon Lookout for Vision model. For more // information, see Tagging a model in the Amazon Lookout for Vision Developer -// Guide. This operation requires permissions to perform the -// lookoutvision:TagResource operation. +// Guide. +// +// This operation requires permissions to perform the lookoutvision:TagResource +// operation. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/lookoutvision/api_op_UntagResource.go b/service/lookoutvision/api_op_UntagResource.go index 86326c5f7aa..13fd00897eb 100644 --- a/service/lookoutvision/api_op_UntagResource.go +++ b/service/lookoutvision/api_op_UntagResource.go @@ -12,8 +12,10 @@ import ( // Removes one or more tags from an Amazon Lookout for Vision model. For more // information, see Tagging a model in the Amazon Lookout for Vision Developer -// Guide. This operation requires permissions to perform the -// lookoutvision:UntagResource operation. +// Guide. +// +// This operation requires permissions to perform the lookoutvision:UntagResource +// operation. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/lookoutvision/api_op_UpdateDatasetEntries.go b/service/lookoutvision/api_op_UpdateDatasetEntries.go index e2b950019ac..72a67a7cdbc 100644 --- a/service/lookoutvision/api_op_UpdateDatasetEntries.go +++ b/service/lookoutvision/api_op_UpdateDatasetEntries.go @@ -13,16 +13,24 @@ import ( // 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. +// 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 DescribeDatasetand 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{} @@ -61,13 +69,16 @@ type UpdateDatasetEntriesInput struct { // 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, // 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 - // 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 - // token is active for 8 hours. + // 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 token is active for 8 hours. ClientToken *string noSmithyDocumentSerde diff --git a/service/lookoutvision/doc.go b/service/lookoutvision/doc.go index 913a8af6410..6bde9a2d6e8 100644 --- a/service/lookoutvision/doc.go +++ b/service/lookoutvision/doc.go @@ -4,11 +4,12 @@ // 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 -// 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 -// production lines, and even minuscule defects in silicon wafers — or any other -// physical item where quality is important such as a missing capacitor on printed -// circuit boards. +// 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 production lines, and even minuscule defects in silicon wafers +// — or any other physical item where quality is important such as a missing +// capacitor on printed circuit boards. package lookoutvision diff --git a/service/lookoutvision/options.go b/service/lookoutvision/options.go index ba9ea96c772..83f7b08ab93 100644 --- a/service/lookoutvision/options.go +++ b/service/lookoutvision/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/lookoutvision/types/enums.go b/service/lookoutvision/types/enums.go index 3920d0a9f9f..b67c2b874d1 100644 --- a/service/lookoutvision/types/enums.go +++ b/service/lookoutvision/types/enums.go @@ -19,8 +19,9 @@ const ( ) // Values returns all known values for DatasetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatus) Values() []DatasetStatus { return []DatasetStatus{ "CREATE_IN_PROGRESS", @@ -48,8 +49,9 @@ const ( ) // Values returns all known values for ModelHostingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelHostingStatus) Values() []ModelHostingStatus { return []ModelHostingStatus{ "STARTING_HOSTING", @@ -71,8 +73,9 @@ const ( ) // Values returns all known values for ModelPackagingJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPackagingJobStatus) Values() []ModelPackagingJobStatus { return []ModelPackagingJobStatus{ "CREATED", @@ -98,8 +101,9 @@ const ( ) // Values returns all known values for ModelStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelStatus) Values() []ModelStatus { return []ModelStatus{ "TRAINING", @@ -126,8 +130,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -146,8 +151,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -163,6 +169,7 @@ const ( // Values returns all known values for TargetPlatformAccelerator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TargetPlatformAccelerator) Values() []TargetPlatformAccelerator { return []TargetPlatformAccelerator{ @@ -179,8 +186,9 @@ const ( ) // Values returns all known values for TargetPlatformArch. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetPlatformArch) Values() []TargetPlatformArch { return []TargetPlatformArch{ "ARM64", @@ -196,8 +204,9 @@ const ( ) // Values returns all known values for TargetPlatformOs. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetPlatformOs) Values() []TargetPlatformOs { return []TargetPlatformOs{ "LINUX", diff --git a/service/lookoutvision/types/types.go b/service/lookoutvision/types/types.go index b67c3af5e34..9aec13e9e86 100644 --- a/service/lookoutvision/types/types.go +++ b/service/lookoutvision/types/types.go @@ -8,7 +8,7 @@ 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 @@ -23,7 +23,7 @@ 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. @@ -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 DescribeDatasetand ProjectDescription. type DatasetMetadata struct { // The Unix timestamp for the date and time that the dataset was created. @@ -108,12 +108,12 @@ 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 -// segmentation information and you shouldn't assume a relationship between them. +// 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 { // If the model is an image segmentation model, Anomalies contains a list of @@ -122,16 +122,20 @@ type DetectAnomalyResult struct { // first element in the list is always an anomaly type representing the image // background ('background') and shouldn't be considered an anomaly. Amazon Lookout // for Vision automatically add the background anomaly type to the response, and - // you don't need to declare a background anomaly type in your dataset. If the list - // has one entry ('background'), no anomalies were found on the image. An image - // classification model doesn't return an Anomalies list. + // you don't need to declare a background anomaly type in your dataset. + // + // If the list has one entry ('background'), no anomalies were found on the image. + // + // An image classification model doesn't return an Anomalies list. Anomalies []Anomaly // If the model is an image segmentation model, AnomalyMask contains pixel masks - // that covers all anomaly types found on the image. Each anomaly type has a - // different mask color. To map a color to an anomaly type, see the color field of - // the PixelAnomaly object. An image classification model doesn't return an - // Anomalies list. + // that covers all anomaly types found on the image. + // + // Each anomaly type has a different mask color. To map a color to an anomaly + // type, see the color field of the PixelAnomaly object. + // + // An image classification model doesn't return an Anomalies list. AnomalyMask []byte // The confidence that Lookout for Vision has in the accuracy of the @@ -150,35 +154,38 @@ 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. + // A name for the AWS IoT Greengrass component. // // This member is required. ComponentName *string - // An S3 location in which Lookout for Vision stores the component artifacts. + // An S3 location in which Lookout for Vision stores the component artifacts. // // 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. + // 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. + // 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. ComponentVersion *string - // A set of tags (key-value pairs) that you want to attach to the AWS IoT + // A set of tags (key-value pairs) that you want to attach to the AWS IoT // Greengrass component. Tags []Tag @@ -197,13 +204,13 @@ type GreengrassConfiguration struct { // job. type GreengrassOutputDetails struct { - // The name of the component. + // The name of the component. ComponentName *string - // The version of the component. + // The version of the component. ComponentVersion *string - // The Amazon Resource Name (ARN) of the component. + // The Amazon Resource Name (ARN) of the component. ComponentVersionArn *string noSmithyDocumentSerde @@ -261,7 +268,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, @@ -317,11 +324,12 @@ type ModelMetadata struct { noSmithyDocumentSerde } -// Configuration information for a Amazon Lookout for Vision model packaging job. -// For more information, see StartModelPackagingJob . +// Configuration information for a Amazon Lookout for Vision model packaging job. +// +// For more information, see StartModelPackagingJob. type ModelPackagingConfiguration struct { - // Configuration information for the AWS IoT Greengrass component in a model + // Configuration information for the AWS IoT Greengrass component in a model // packaging job. // // This member is required. @@ -330,22 +338,21 @@ type ModelPackagingConfiguration struct { noSmithyDocumentSerde } -// Information about a model packaging job. For more information, see -// DescribeModelPackagingJob . +// Information about a model packaging job. For more information, see DescribeModelPackagingJob. type ModelPackagingDescription struct { - // The Unix timestamp for the time and date that the model packaging job was + // The Unix timestamp for the time and date that the model packaging job was // created. CreationTimestamp *time.Time - // The name of the model packaging job. + // The name of the model packaging job. JobName *string - // The Unix timestamp for the time and date that the model packaging job was last + // The Unix timestamp for the time and date that the model packaging job was last // updated. LastUpdatedTimestamp *time.Time - // The configuration information used in the model packaging job. + // The configuration information used in the model packaging job. ModelPackagingConfiguration *ModelPackagingConfiguration // The description for the model packaging job. @@ -356,7 +363,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. @@ -366,41 +373,40 @@ type ModelPackagingDescription struct { // package. ProjectName *string - // The status of the model packaging job. + // The status of the model packaging job. Status ModelPackagingJobStatus - // The status message for the model packaging job. + // The status message for the model packaging job. StatusMessage *string noSmithyDocumentSerde } -// Metadata for a model packaging job. For more information, see -// ListModelPackagingJobs . +// Metadata for a model packaging job. For more information, see ListModelPackagingJobs. type ModelPackagingJobMetadata struct { // The Unix timestamp for the time and date that the model packaging job was // created. CreationTimestamp *time.Time - // The name of the model packaging job. + // The name of the model packaging job. JobName *string // The Unix timestamp for the time and date that the model packaging job was last // updated. LastUpdatedTimestamp *time.Time - // The description for the model packaging job. + // The description for the model packaging job. ModelPackagingJobDescription *string - // The AWS service used to package the job. Currently Lookout for Vision can + // The AWS service used to package the job. Currently Lookout for Vision can // package jobs with AWS IoT Greengrass. ModelPackagingMethod *string - // The version of the model that is in the model package. + // The version of the model that is in the model package. ModelVersion *string - // The project that contains the model that is in the model package. + // The project that contains the model that is in the model package. ProjectName *string // The status of the model packaging job. @@ -415,7 +421,7 @@ type ModelPackagingJobMetadata struct { // Information about the output from a model packaging job. type ModelPackagingOutputDetails struct { - // Information about the AWS IoT Greengrass component in a model packaging job. + // Information about the AWS IoT Greengrass component in a model packaging job. Greengrass *GreengrassOutputDetails noSmithyDocumentSerde @@ -463,8 +469,8 @@ type OutputS3Object struct { noSmithyDocumentSerde } -// Information about the pixels in an anomaly mask. For more information, see -// Anomaly . PixelAnomaly is only returned by image segmentation models. +// Information about the pixels in an anomaly mask. For more information, see 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 @@ -478,8 +484,7 @@ type PixelAnomaly struct { noSmithyDocumentSerde } -// Describe an Amazon Lookout for Vision project. For more information, see -// DescribeProject . +// Describe an Amazon Lookout for Vision project. For more information, see DescribeProject. type ProjectDescription struct { // The unix timestamp for the date and time that the project was created. @@ -567,10 +572,11 @@ type TargetPlatform struct { // 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 , // 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: + // 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']} Accelerator TargetPlatformAccelerator diff --git a/service/m2/api_op_CreateDataSetImportTask.go b/service/m2/api_op_CreateDataSetImportTask.go index ea46891bb9a..28d26eb1f7f 100644 --- a/service/m2/api_op_CreateDataSetImportTask.go +++ b/service/m2/api_op_CreateDataSetImportTask.go @@ -39,7 +39,7 @@ type CreateDataSetImportTaskInput struct { // This member is required. ImportConfig types.DataSetImportConfig - // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request to create a data set import. The service generates the clientToken when // the API call is triggered. The token expires after one hour, so if you retry the // API within this timeframe with the same clientToken, you will get the same @@ -52,7 +52,7 @@ type CreateDataSetImportTaskInput struct { type CreateDataSetImportTaskOutput struct { // The task identifier. This operation is asynchronous. Use this identifier with - // the GetDataSetImportTask operation to obtain the status of this task. + // the GetDataSetImportTaskoperation to obtain the status of this task. // // This member is required. TaskId *string diff --git a/service/m2/api_op_CreateEnvironment.go b/service/m2/api_op_CreateEnvironment.go index 1373bfbaf54..002e8068131 100644 --- a/service/m2/api_op_CreateEnvironment.go +++ b/service/m2/api_op_CreateEnvironment.go @@ -66,8 +66,9 @@ type CreateEnvironmentInput struct { // Configures the maintenance window that you want for the runtime environment. // The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be // less than 24 hours. The following two examples are valid maintenance windows: - // sun:23:45-mon:00:15 or sat:01:00-sat:03:00 . If you do not provide a value, a - // random system-generated value will be assigned. + // sun:23:45-mon:00:15 or sat:01:00-sat:03:00 . + // + // If you do not provide a value, a random system-generated value will be assigned. PreferredMaintenanceWindow *string // Specifies whether the runtime environment is publicly accessible. diff --git a/service/m2/api_op_GetBatchJobExecution.go b/service/m2/api_op_GetBatchJobExecution.go index 34a85fb6d9e..23166cf146c 100644 --- a/service/m2/api_op_GetBatchJobExecution.go +++ b/service/m2/api_op_GetBatchJobExecution.go @@ -87,8 +87,10 @@ type GetBatchJobExecutionOutput struct { JobUser *string // The batch job return code from either the Blu Age or Micro Focus runtime - // engines. For more information, see Batch return codes (https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes) - // in the IBM WebSphere Application Server documentation. + // engines. For more information, see [Batch return codes]in the IBM WebSphere Application Server + // documentation. + // + // [Batch return codes]: https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes ReturnCode *string // The reason for the reported status. diff --git a/service/m2/api_op_GetDataSetImportTask.go b/service/m2/api_op_GetDataSetImportTask.go index 0ca5f0fccd2..17c23940cda 100644 --- a/service/m2/api_op_GetDataSetImportTask.go +++ b/service/m2/api_op_GetDataSetImportTask.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the status of a data set import task initiated with the -// CreateDataSetImportTask operation. +// Gets the status of a data set import task initiated with the CreateDataSetImportTask operation. func (c *Client) GetDataSetImportTask(ctx context.Context, params *GetDataSetImportTaskInput, optFns ...func(*Options)) (*GetDataSetImportTaskOutput, error) { if params == nil { params = &GetDataSetImportTaskInput{} diff --git a/service/m2/api_op_ListDataSets.go b/service/m2/api_op_ListDataSets.go index 9786332cf0a..8826c620457 100644 --- a/service/m2/api_op_ListDataSets.go +++ b/service/m2/api_op_ListDataSets.go @@ -14,9 +14,9 @@ import ( // Lists the data sets imported for a specific application. In Amazon Web Services // 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) -// . +// Web Services Mainframe Modernization can import data sets into catalogs using [CreateDataSetImportTask]. +// +// [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 04c226bd8f8..f421f3a3117 100644 --- a/service/m2/api_op_StartBatchJob.go +++ b/service/m2/api_op_StartBatchJob.go @@ -42,8 +42,9 @@ 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]. + // + // [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 786f3377aa9..ac72a5bc396 100644 --- a/service/m2/api_op_UpdateEnvironment.go +++ b/service/m2/api_op_UpdateEnvironment.go @@ -50,10 +50,13 @@ type UpdateEnvironmentInput struct { // Forces the updates on the environment. This option is needed if the // applications in the environment are not stopped or if there are ongoing - // application-related activities in the environment. If you use this option, be - // aware that it could lead to data corruption in the applications, and that you - // might need to perform repair and recovery procedures for the applications. This - // option is not needed if the attribute being updated is + // application-related activities in the environment. + // + // If you use this option, be aware that it could lead to data corruption in the + // applications, and that you might need to perform repair and recovery procedures + // for the applications. + // + // This option is not needed if the attribute being updated is // preferredMaintenanceWindow . ForceUpdate bool @@ -63,8 +66,9 @@ type UpdateEnvironmentInput struct { // Configures the maintenance window that you want for the runtime environment. // The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be // less than 24 hours. The following two examples are valid maintenance windows: - // sun:23:45-mon:00:15 or sat:01:00-sat:03:00 . If you do not provide a value, a - // random system-generated value will be assigned. + // sun:23:45-mon:00:15 or sat:01:00-sat:03:00 . + // + // If you do not provide a value, a random system-generated value will be assigned. PreferredMaintenanceWindow *string noSmithyDocumentSerde diff --git a/service/m2/options.go b/service/m2/options.go index eaa056a41d4..3f515b3db05 100644 --- a/service/m2/options.go +++ b/service/m2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/m2/types/enums.go b/service/m2/types/enums.go index 91690c92209..7a6d3e7314d 100644 --- a/service/m2/types/enums.go +++ b/service/m2/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for ApplicationDeploymentLifecycle. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationDeploymentLifecycle) Values() []ApplicationDeploymentLifecycle { return []ApplicationDeploymentLifecycle{ "Deploying", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for ApplicationLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationLifecycle) Values() []ApplicationLifecycle { return []ApplicationLifecycle{ "Creating", @@ -68,6 +70,7 @@ const ( // Values returns all known values for ApplicationVersionLifecycle. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationVersionLifecycle) Values() []ApplicationVersionLifecycle { return []ApplicationVersionLifecycle{ @@ -94,8 +97,9 @@ const ( ) // Values returns all known values for BatchJobExecutionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchJobExecutionStatus) Values() []BatchJobExecutionStatus { return []BatchJobExecutionStatus{ "Submitting", @@ -121,8 +125,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -142,8 +147,9 @@ const ( ) // Values returns all known values for DataSetTaskLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSetTaskLifecycle) Values() []DataSetTaskLifecycle { return []DataSetTaskLifecycle{ "Creating", @@ -164,8 +170,9 @@ const ( ) // Values returns all known values for DeploymentLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentLifecycle) Values() []DeploymentLifecycle { return []DeploymentLifecycle{ "Deploying", @@ -184,8 +191,9 @@ const ( ) // Values returns all known values for EngineType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EngineType) Values() []EngineType { return []EngineType{ "microfocus", @@ -205,8 +213,9 @@ const ( ) // Values returns all known values for EnvironmentLifecycle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentLifecycle) Values() []EnvironmentLifecycle { return []EnvironmentLifecycle{ "Creating", @@ -231,6 +240,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/m2/types/errors.go b/service/m2/types/errors.go index a2d0b61407a..5decf44a67f 100644 --- a/service/m2/types/errors.go +++ b/service/m2/types/errors.go @@ -62,7 +62,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Failed to connect to server, or didn’t receive response within expected time +// Failed to connect to server, or didn’t receive response within expected time +// // period. type ExecutionTimeoutException struct { Message *string diff --git a/service/m2/types/types.go b/service/m2/types/types.go index f3fe8832c72..c34a70ee6ef 100644 --- a/service/m2/types/types.go +++ b/service/m2/types/types.go @@ -185,8 +185,10 @@ type BatchJobExecutionSummary struct { JobType BatchJobType // The batch job return code from either the Blu Age or Micro Focus runtime - // engines. For more information, see Batch return codes (https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes) - // in the IBM WebSphere Application Server documentation. + // engines. For more information, see [Batch return codes]in the IBM WebSphere Application Server + // documentation. + // + // [Batch return codes]: https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes ReturnCode *string noSmithyDocumentSerde @@ -322,8 +324,7 @@ type DatasetDetailOrgAttributesMemberVsam struct { func (*DatasetDetailOrgAttributesMemberVsam) isDatasetDetailOrgAttributes() {} -// Identifies one or more data sets you want to import with the -// CreateDataSetImportTask operation. +// Identifies one or more data sets you want to import with the CreateDataSetImportTask operation. // // The following types satisfy this interface: // @@ -730,9 +731,9 @@ type FsxStorageConfiguration struct { // The required attributes for a generation data group data set. A generation data // 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) -// . +// structure when you want to import a GDG. For more information on GDG, see [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. @@ -747,9 +748,9 @@ type GdgAttributes struct { // The required attributes for a generation data group data set. A generation data // 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) -// . +// structure when you want to import a GDG. For more information on GDG, see [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. diff --git a/service/machinelearning/api_op_CreateBatchPrediction.go b/service/machinelearning/api_op_CreateBatchPrediction.go index 1c73cb78303..726f099244c 100644 --- a/service/machinelearning/api_op_CreateBatchPrediction.go +++ b/service/machinelearning/api_op_CreateBatchPrediction.go @@ -13,14 +13,16 @@ 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 -// 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 -// 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. +// 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 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. func (c *Client) CreateBatchPrediction(ctx context.Context, params *CreateBatchPredictionInput, optFns ...func(*Options)) (*CreateBatchPredictionOutput, error) { if params == nil { params = &CreateBatchPredictionInput{} @@ -57,10 +59,12 @@ type CreateBatchPredictionInput struct { // 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) - // . + // '/../'. + // + // 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]. + // + // [Amazon Machine Learning Developer Guide]: https://docs.aws.amazon.com/machine-learning/latest/dg // // This member is required. OutputUri *string @@ -72,10 +76,13 @@ type CreateBatchPredictionInput struct { noSmithyDocumentSerde } -// Represents the output of a CreateBatchPrediction operation, and is an -// acknowledgement that Amazon ML received the request. The CreateBatchPrediction -// operation is asynchronous. You can poll for status updates by using the -// >GetBatchPrediction operation and checking the Status parameter of the result. +// Represents the output of a CreateBatchPrediction operation, and is an +// +// acknowledgement that Amazon ML received the request. +// +// The CreateBatchPrediction operation is asynchronous. You can poll for status +// updates by using the >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 diff --git a/service/machinelearning/api_op_CreateDataSourceFromRDS.go b/service/machinelearning/api_op_CreateDataSourceFromRDS.go index 5ab3d388f01..0453e2d2cda 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromRDS.go +++ b/service/machinelearning/api_op_CreateDataSourceFromRDS.go @@ -11,18 +11,22 @@ 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. +// Creates a DataSource object from an [Amazon Relational Database Service] (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. +// >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. +// +// [Amazon Relational Database Service]: http://aws.amazon.com/rds/ func (c *Client) CreateDataSourceFromRDS(ctx context.Context, params *CreateDataSourceFromRDSInput, optFns ...func(*Options)) (*CreateDataSourceFromRDSOutput, error) { if params == nil { params = &CreateDataSourceFromRDSInput{} @@ -47,35 +51,47 @@ type CreateDataSourceFromRDSInput struct { 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. + // Service (Amazon S3). For more information, see [Role templates]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. + // Amazon S3. For more information, see [Role templates]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. + // 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}}" + // rearrangement requirements for the Datasource . + // + // Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" + // + // [Role templates]: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html // // This member is required. RDSData *types.RDSDataSpec @@ -99,13 +115,16 @@ type CreateDataSourceFromRDSInput struct { 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. +// 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. type CreateDataSourceFromRDSOutput struct { // A user-supplied ID that uniquely identifies the datasource. This value should diff --git a/service/machinelearning/api_op_CreateDataSourceFromRedshift.go b/service/machinelearning/api_op_CreateDataSourceFromRedshift.go index 6522ac443b2..b3dd1559065 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromRedshift.go +++ b/service/machinelearning/api_op_CreateDataSourceFromRedshift.go @@ -14,30 +14,36 @@ 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. +// // 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 . // 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 -// 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 +// 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. +// 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{} @@ -61,30 +67,42 @@ type CreateDataSourceFromRedshiftInput struct { 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}}" + // 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 // @@ -103,10 +121,13 @@ type CreateDataSourceFromRedshiftInput struct { noSmithyDocumentSerde } -// Represents the output of a CreateDataSourceFromRedshift operation, and is an -// acknowledgement that Amazon ML received the request. The -// CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates -// by using the GetBatchPrediction operation and checking the Status parameter. +// Represents the output of a CreateDataSourceFromRedshift operation, and is an +// +// acknowledgement that Amazon ML received the request. +// +// The CreateDataSourceFromRedshift operation is asynchronous. You can poll for +// updates 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 diff --git a/service/machinelearning/api_op_CreateDataSourceFromS3.go b/service/machinelearning/api_op_CreateDataSourceFromS3.go index 4d8786e622e..7750049e25b 100644 --- a/service/machinelearning/api_op_CreateDataSourceFromS3.go +++ b/service/machinelearning/api_op_CreateDataSourceFromS3.go @@ -13,22 +13,27 @@ import ( // Creates a DataSource object. A DataSource references data that can be used to // 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 . // DataSource in the COMPLETED or PENDING state 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 -// 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 -// 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 +// 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 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 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 // 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 // training? Will the variable be manipulated; for example, will it be combined @@ -57,13 +62,18 @@ type CreateDataSourceFromS3Input struct { 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}}" + // rearrangement requirements for the Datasource . + // + // Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}" // // This member is required. DataSpec *types.S3DataSpec @@ -80,10 +90,12 @@ type CreateDataSourceFromS3Input struct { noSmithyDocumentSerde } -// Represents the output of a CreateDataSourceFromS3 operation, and is an -// acknowledgement that Amazon ML received the request. The CreateDataSourceFromS3 -// operation is asynchronous. You can poll for updates by using the -// GetBatchPrediction operation and checking the Status parameter. +// Represents the output of a CreateDataSourceFromS3 operation, and is an +// +// acknowledgement that Amazon ML received the request. +// +// The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates +// by using the GetBatchPrediction operation and checking the Status parameter. type CreateDataSourceFromS3Output struct { // A user-supplied ID that uniquely identifies the DataSource . This value should diff --git a/service/machinelearning/api_op_CreateEvaluation.go b/service/machinelearning/api_op_CreateEvaluation.go index fbefe59cd7a..cd617efd1f0 100644 --- a/service/machinelearning/api_op_CreateEvaluation.go +++ b/service/machinelearning/api_op_CreateEvaluation.go @@ -17,12 +17,15 @@ import ( // 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 -// 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 -// of the evaluation during the creation operation. +// 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 of the evaluation +// during the creation operation. func (c *Client) CreateEvaluation(ctx context.Context, params *CreateEvaluationInput, optFns ...func(*Options)) (*CreateEvaluationOutput, error) { if params == nil { params = &CreateEvaluationInput{} @@ -51,8 +54,10 @@ type CreateEvaluationInput struct { // 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 . + // 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 . // // This member is required. MLModelId *string @@ -63,10 +68,12 @@ type CreateEvaluationInput struct { 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 diff --git a/service/machinelearning/api_op_CreateMLModel.go b/service/machinelearning/api_op_CreateMLModel.go index cedb083e4a1..8a00afbb4be 100644 --- a/service/machinelearning/api_op_CreateMLModel.go +++ b/service/machinelearning/api_op_CreateMLModel.go @@ -12,13 +12,19 @@ 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 . +// 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. +// 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. @@ -46,11 +52,16 @@ type CreateMLModelInput struct { // 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) - // . + // + // For more information, see the [Amazon Machine Learning Developer Guide]. + // + // [Amazon Machine Learning Developer Guide]: https://docs.aws.amazon.com/machine-learning/latest/dg // // This member is required. MLModelType types.MLModelType @@ -64,32 +75,42 @@ type CreateMLModelInput struct { 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: + // 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 . + // 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. + // 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. + // 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 @@ -104,10 +125,12 @@ type CreateMLModelInput struct { noSmithyDocumentSerde } -// Represents the output of a CreateMLModel operation, and is an acknowledgement -// that Amazon ML received the request. The CreateMLModel operation is -// asynchronous. You can poll for status updates by using the GetMLModel operation -// and checking the Status parameter. +// Represents the output of a CreateMLModel operation, and is an acknowledgement +// +// that Amazon ML received the request. +// +// The CreateMLModel operation is asynchronous. You can poll for status updates by +// using the GetMLModel operation and checking the Status parameter. type CreateMLModelOutput struct { // A user-supplied ID that uniquely identifies the MLModel . This value should be diff --git a/service/machinelearning/api_op_CreateRealtimeEndpoint.go b/service/machinelearning/api_op_CreateRealtimeEndpoint.go index fe62deeba4f..deca15f5fae 100644 --- a/service/machinelearning/api_op_CreateRealtimeEndpoint.go +++ b/service/machinelearning/api_op_CreateRealtimeEndpoint.go @@ -39,10 +39,12 @@ type CreateRealtimeEndpointInput struct { noSmithyDocumentSerde } -// 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 . +// 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 . type CreateRealtimeEndpointOutput struct { // A user-supplied ID that uniquely identifies the MLModel . This value should be diff --git a/service/machinelearning/api_op_DeleteBatchPrediction.go b/service/machinelearning/api_op_DeleteBatchPrediction.go index 66a60063000..7a104b2dbfe 100644 --- a/service/machinelearning/api_op_DeleteBatchPrediction.go +++ b/service/machinelearning/api_op_DeleteBatchPrediction.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) DeleteBatchPrediction(ctx context.Context, params *DeleteBatchPredictionInput, optFns ...func(*Options)) (*DeleteBatchPredictionOutput, error) { if params == nil { @@ -39,9 +41,10 @@ type DeleteBatchPredictionInput struct { noSmithyDocumentSerde } -// 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 . +// 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 . type DeleteBatchPredictionOutput struct { // A user-supplied ID that uniquely identifies the BatchPrediction . This value diff --git a/service/machinelearning/api_op_DeleteDataSource.go b/service/machinelearning/api_op_DeleteDataSource.go index 3a939f39e1a..8680e5f4dec 100644 --- a/service/machinelearning/api_op_DeleteDataSource.go +++ b/service/machinelearning/api_op_DeleteDataSource.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error) { if params == nil { params = &DeleteDataSourceInput{} diff --git a/service/machinelearning/api_op_DeleteEvaluation.go b/service/machinelearning/api_op_DeleteEvaluation.go index 115f98cb7f0..999fcdb0258 100644 --- a/service/machinelearning/api_op_DeleteEvaluation.go +++ b/service/machinelearning/api_op_DeleteEvaluation.go @@ -10,9 +10,11 @@ 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 +// 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 { @@ -39,10 +41,12 @@ 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 -// GetEvaluation operation and check the value of the Status parameter to see -// whether an Evaluation is marked as DELETED . +// 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 . type DeleteEvaluationOutput struct { // A user-supplied ID that uniquely identifies the Evaluation . This value should diff --git a/service/machinelearning/api_op_DeleteMLModel.go b/service/machinelearning/api_op_DeleteMLModel.go index 9cb9fef6a81..f6998d0495c 100644 --- a/service/machinelearning/api_op_DeleteMLModel.go +++ b/service/machinelearning/api_op_DeleteMLModel.go @@ -10,10 +10,12 @@ 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 -// DeleteMLModel operation is irreversible. +// 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 { params = &DeleteMLModelInput{} @@ -39,9 +41,10 @@ type DeleteMLModelInput struct { noSmithyDocumentSerde } -// 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 . +// 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 . type DeleteMLModelOutput struct { // A user-supplied ID that uniquely identifies the MLModel . This value should be diff --git a/service/machinelearning/api_op_DeleteRealtimeEndpoint.go b/service/machinelearning/api_op_DeleteRealtimeEndpoint.go index 697450efde0..393c4e024ed 100644 --- a/service/machinelearning/api_op_DeleteRealtimeEndpoint.go +++ b/service/machinelearning/api_op_DeleteRealtimeEndpoint.go @@ -37,8 +37,9 @@ type DeleteRealtimeEndpointInput struct { noSmithyDocumentSerde } -// Represents the output of an DeleteRealtimeEndpoint operation. The result -// contains the MLModelId and the endpoint information for the MLModel . +// Represents the output of an DeleteRealtimeEndpoint operation. +// +// The result 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 diff --git a/service/machinelearning/api_op_DeleteTags.go b/service/machinelearning/api_op_DeleteTags.go index f6806a30f3a..b28edc4593c 100644 --- a/service/machinelearning/api_op_DeleteTags.go +++ b/service/machinelearning/api_op_DeleteTags.go @@ -12,8 +12,9 @@ import ( ) // 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. +// 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 { params = &DeleteTagsInput{} diff --git a/service/machinelearning/api_op_DescribeBatchPredictions.go b/service/machinelearning/api_op_DescribeBatchPredictions.go index e2d3fe86515..e15009abccc 100644 --- a/service/machinelearning/api_op_DescribeBatchPredictions.go +++ b/service/machinelearning/api_op_DescribeBatchPredictions.go @@ -39,16 +39,22 @@ type DescribeBatchPredictionsInput struct { 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 BatchPrediction Name - // . + // + // - 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. @@ -83,19 +89,26 @@ type DescribeBatchPredictionsInput struct { // 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 Name + // 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 // 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 @@ -322,12 +335,13 @@ type BatchPredictionAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeBatchPredictionsInput, *DescribeBatchPredictionsOutput, error) (bool, error) } diff --git a/service/machinelearning/api_op_DescribeDataSources.go b/service/machinelearning/api_op_DescribeDataSources.go index 4490df48669..c5c2c135bc1 100644 --- a/service/machinelearning/api_op_DescribeDataSources.go +++ b/service/machinelearning/api_op_DescribeDataSources.go @@ -38,12 +38,17 @@ type DescribeDataSourcesInput struct { 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 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 @@ -66,7 +71,7 @@ type DescribeDataSourcesInput struct { // that are less than the value specified with LT . LT *string - // The maximum number of DataSource to include in the result. + // The maximum number of DataSource to include in the result. Limit *int32 // The not equal to operator. The DataSource results will have FilterVariable @@ -76,27 +81,34 @@ type DescribeDataSourcesInput struct { // 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 Name 2014-09-09-HolidayGiftMailer . To + // 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 . SortOrder types.SortOrder noSmithyDocumentSerde } -// Represents the query results from a DescribeDataSources operation. The content -// is essentially a list of DataSource . +// Represents the query results from a DescribeDataSources operation. The content is essentially a +// list of DataSource . type DescribeDataSourcesOutput struct { // An ID of the next page in the paginated results that indicates at least one @@ -199,7 +211,7 @@ var _ DescribeDataSourcesAPIClient = (*Client)(nil) // DescribeDataSourcesPaginatorOptions is the paginator options for // DescribeDataSources type DescribeDataSourcesPaginatorOptions struct { - // The maximum number of DataSource to include in the result. + // The maximum number of DataSource to include in the result. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -313,12 +325,13 @@ type DataSourceAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDataSourcesInput, *DescribeDataSourcesOutput, error) (bool, error) } diff --git a/service/machinelearning/api_op_DescribeEvaluations.go b/service/machinelearning/api_op_DescribeEvaluations.go index 48ea04e2abb..2a978b86db1 100644 --- a/service/machinelearning/api_op_DescribeEvaluations.go +++ b/service/machinelearning/api_op_DescribeEvaluations.go @@ -39,14 +39,21 @@ type DescribeEvaluationsInput struct { 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 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. @@ -70,7 +77,7 @@ type DescribeEvaluationsInput struct { // that are less than the value specified with LT . LT *string - // The maximum number of Evaluation to include in the result. + // The maximum number of Evaluation to include in the result. Limit *int32 // The not equal to operator. The Evaluation results will have FilterVariable @@ -80,19 +87,26 @@ type DescribeEvaluationsInput struct { // 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 Name 2014-09-09-HolidayGiftMailer . To + // 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 . SortOrder types.SortOrder @@ -203,7 +217,7 @@ var _ DescribeEvaluationsAPIClient = (*Client)(nil) // DescribeEvaluationsPaginatorOptions is the paginator options for // DescribeEvaluations type DescribeEvaluationsPaginatorOptions struct { - // The maximum number of Evaluation to include in the result. + // The maximum number of Evaluation to include in the result. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -317,12 +331,13 @@ type EvaluationAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEvaluationsInput, *DescribeEvaluationsOutput, error) (bool, error) } diff --git a/service/machinelearning/api_op_DescribeMLModels.go b/service/machinelearning/api_op_DescribeMLModels.go index 9f2641b0318..78e42e9aa8a 100644 --- a/service/machinelearning/api_op_DescribeMLModels.go +++ b/service/machinelearning/api_op_DescribeMLModels.go @@ -38,18 +38,27 @@ type DescribeMLModelsInput struct { 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 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. @@ -83,19 +92,26 @@ type DescribeMLModelsInput struct { // 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 Name 2014-09-09-HolidayGiftMailer . To search - // for this MLModel , select Name for the FilterVariable and any of the following - // strings for the Prefix : + // 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 . SortOrder types.SortOrder @@ -318,12 +334,13 @@ type MLModelAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeMLModelsInput, *DescribeMLModelsOutput, error) (bool, error) } diff --git a/service/machinelearning/api_op_GetBatchPrediction.go b/service/machinelearning/api_op_GetBatchPrediction.go index 48c5fba8676..1b735d3fbe1 100644 --- a/service/machinelearning/api_op_GetBatchPrediction.go +++ b/service/machinelearning/api_op_GetBatchPrediction.go @@ -105,12 +105,17 @@ type GetBatchPredictionOutput struct { 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. Status types.EntityStatus diff --git a/service/machinelearning/api_op_GetDataSource.go b/service/machinelearning/api_op_GetDataSource.go index 5535fa0996e..a32e9b74a88 100644 --- a/service/machinelearning/api_op_GetDataSource.go +++ b/service/machinelearning/api_op_GetDataSource.go @@ -13,9 +13,11 @@ import ( ) // Returns a DataSource that includes metadata and data file information, as well -// 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. +// 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) { if params == nil { params = &GetDataSourceInput{} @@ -39,8 +41,10 @@ type GetDataSourceInput struct { DataSourceId *string // Specifies whether the GetDataSource operation should return DataSourceSchema . - // If true, DataSourceSchema is returned. If false, DataSourceSchema is not - // returned. + // + // If true, DataSourceSchema is returned. + // + // If false, DataSourceSchema is not returned. Verbose bool noSmithyDocumentSerde @@ -49,7 +53,7 @@ type GetDataSourceInput struct { // 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 + // The parameter is true if statistics need to be generated from the observation // data. ComputeStatistics bool @@ -82,8 +86,9 @@ type GetDataSourceOutput struct { // 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 - // parameter is provided as part of the verbose format. + // 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 @@ -114,8 +119,10 @@ 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], such as the following: + // arn:aws:iam::account:role/rolename. + // + // [AWS IAM Role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts RoleARN *string // The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS @@ -124,11 +131,16 @@ type GetDataSourceOutput struct { // 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 diff --git a/service/machinelearning/api_op_GetEvaluation.go b/service/machinelearning/api_op_GetEvaluation.go index e1477108ce3..67680735f52 100644 --- a/service/machinelearning/api_op_GetEvaluation.go +++ b/service/machinelearning/api_op_GetEvaluation.go @@ -90,30 +90,38 @@ type GetEvaluationOutput struct { // 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) - // . + // + // For more information about performance metrics, please see the [Amazon Machine Learning Developer Guide]. + // + // [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. StartedAt *time.Time - // The status of the evaluation. This element can have one of the following - // values: + // 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. Status types.EntityStatus diff --git a/service/machinelearning/api_op_GetMLModel.go b/service/machinelearning/api_op_GetMLModel.go index 5baa98e7b5a..cceda72b224 100644 --- a/service/machinelearning/api_op_GetMLModel.go +++ b/service/machinelearning/api_op_GetMLModel.go @@ -13,8 +13,9 @@ import ( ) // 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. +// 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,8 +38,11 @@ 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 @@ -84,10 +88,13 @@ 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?" MLModelType types.MLModelType @@ -100,19 +107,22 @@ type GetMLModelOutput struct { // 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. + // 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: - // This parameter is provided as part of the verbose format. + // 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 . + // 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 . ScoreThreshold *float32 // The time of the most recent edit to the ScoreThreshold . The time is expressed @@ -128,11 +138,16 @@ type GetMLModelOutput struct { // 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. Status types.EntityStatus @@ -140,32 +155,42 @@ type GetMLModelOutput struct { 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: + // 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 . + // 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. + // 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. + // 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 6df98d9846e..163ef743f7d 100644 --- a/service/machinelearning/api_op_Predict.go +++ b/service/machinelearning/api_op_Predict.go @@ -13,9 +13,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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) { if params == nil { params = &PredictInput{} @@ -52,12 +53,16 @@ type PredictInput struct { type PredictOutput struct { // The output from a Predict operation: + // // - 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 diff --git a/service/machinelearning/api_op_UpdateBatchPrediction.go b/service/machinelearning/api_op_UpdateBatchPrediction.go index 2df77a0b995..d20642dd8d7 100644 --- a/service/machinelearning/api_op_UpdateBatchPrediction.go +++ b/service/machinelearning/api_op_UpdateBatchPrediction.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the BatchPredictionName of a BatchPrediction . You can use the -// GetBatchPrediction operation to view the contents of the updated data element. +// 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 { params = &UpdateBatchPredictionInput{} @@ -42,8 +44,9 @@ type UpdateBatchPredictionInput struct { noSmithyDocumentSerde } -// Represents the output of an UpdateBatchPrediction operation. You can see the -// updated content by using the GetBatchPrediction operation. +// Represents the output of an UpdateBatchPrediction operation. +// +// You can see the updated content by using the GetBatchPrediction operation. type UpdateBatchPredictionOutput struct { // The ID assigned to the BatchPrediction during creation. This value should be diff --git a/service/machinelearning/api_op_UpdateDataSource.go b/service/machinelearning/api_op_UpdateDataSource.go index 32c0c3bb24a..724e42466d6 100644 --- a/service/machinelearning/api_op_UpdateDataSource.go +++ b/service/machinelearning/api_op_UpdateDataSource.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the DataSourceName of a DataSource . You can use the GetDataSource -// operation to view the contents of the updated data element. +// 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 { params = &UpdateDataSourceInput{} @@ -43,8 +45,9 @@ type UpdateDataSourceInput struct { noSmithyDocumentSerde } -// Represents the output of an UpdateDataSource operation. You can see the updated -// content by using the GetBatchPrediction operation. +// Represents the output of an UpdateDataSource operation. +// +// You can see the updated content by using the GetBatchPrediction operation. type UpdateDataSourceOutput struct { // The ID assigned to the DataSource during creation. This value should be diff --git a/service/machinelearning/api_op_UpdateEvaluation.go b/service/machinelearning/api_op_UpdateEvaluation.go index 2d2df6428d7..ec1ee6dcaf4 100644 --- a/service/machinelearning/api_op_UpdateEvaluation.go +++ b/service/machinelearning/api_op_UpdateEvaluation.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the EvaluationName of an Evaluation . You can use the GetEvaluation -// operation to view the contents of the updated data element. +// 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 { params = &UpdateEvaluationInput{} @@ -43,8 +45,9 @@ type UpdateEvaluationInput struct { noSmithyDocumentSerde } -// Represents the output of an UpdateEvaluation operation. You can see the updated -// content by using the GetEvaluation operation. +// Represents the output of an UpdateEvaluation operation. +// +// You can see the updated content by using the GetEvaluation operation. type UpdateEvaluationOutput struct { // The ID assigned to the Evaluation during creation. This value should be diff --git a/service/machinelearning/api_op_UpdateMLModel.go b/service/machinelearning/api_op_UpdateMLModel.go index 644352f5269..3cc5b9161f5 100644 --- a/service/machinelearning/api_op_UpdateMLModel.go +++ b/service/machinelearning/api_op_UpdateMLModel.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the MLModelName and the ScoreThreshold of an MLModel . You can use the -// GetMLModel operation to view the contents of the updated data element. +// 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 { params = &UpdateMLModelInput{} @@ -38,17 +40,19 @@ type UpdateMLModelInput struct { 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 . + // 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 } -// Represents the output of an UpdateMLModel operation. You can see the updated -// content by using the GetMLModel operation. +// Represents the output of an UpdateMLModel operation. +// +// You can see the updated content by using the GetMLModel operation. type UpdateMLModelOutput struct { // The ID assigned to the MLModel during creation. This value should be identical diff --git a/service/machinelearning/options.go b/service/machinelearning/options.go index daf5223a2f6..76ddebdd396 100644 --- a/service/machinelearning/options.go +++ b/service/machinelearning/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/machinelearning/types/enums.go b/service/machinelearning/types/enums.go index 8348ddc6e20..d68fad4eda8 100644 --- a/service/machinelearning/types/enums.go +++ b/service/machinelearning/types/enums.go @@ -10,8 +10,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -34,8 +35,9 @@ const ( // Values returns all known values for BatchPredictionFilterVariable. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchPredictionFilterVariable) Values() []BatchPredictionFilterVariable { return []BatchPredictionFilterVariable{ "CreatedAt", @@ -63,6 +65,7 @@ const ( // 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{ @@ -84,8 +87,9 @@ const ( ) // Values returns all known values for DetailsAttributes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetailsAttributes) Values() []DetailsAttributes { return []DetailsAttributes{ "PredictiveModelType", @@ -105,8 +109,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -133,6 +138,7 @@ const ( // 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{ @@ -164,8 +170,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CreatedAt", @@ -191,8 +198,9 @@ const ( ) // Values returns all known values for MLModelType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MLModelType) Values() []MLModelType { return []MLModelType{ "REGRESSION", @@ -212,8 +220,9 @@ const ( ) // Values returns all known values for RealtimeEndpointStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RealtimeEndpointStatus) Values() []RealtimeEndpointStatus { return []RealtimeEndpointStatus{ "NONE", @@ -232,8 +241,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -252,8 +262,9 @@ const ( ) // Values returns all known values for TaggableResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaggableResourceType) Values() []TaggableResourceType { return []TaggableResourceType{ "BatchPrediction", diff --git a/service/machinelearning/types/types.go b/service/machinelearning/types/types.go index fd8aab8abdb..bc1e2eb3226 100644 --- a/service/machinelearning/types/types.go +++ b/service/machinelearning/types/types.go @@ -7,9 +7,10 @@ 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. @@ -66,12 +67,17 @@ type BatchPrediction struct { // 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. Status EntityStatus @@ -81,12 +87,13 @@ type BatchPrediction struct { noSmithyDocumentSerde } -// 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 . +// 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 . type DataSource struct { - // The parameter is true if statistics need to be generated from the observation + // The parameter is true if statistics need to be generated from the observation // data. ComputeStatistics bool @@ -138,8 +145,10 @@ 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], such as the following: + // arn:aws:iam::account:role/rolename. + // + // [AWS IAM Role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts RoleARN *string // A timestamp represented in epoch time. @@ -147,21 +156,27 @@ type DataSource struct { // 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 } -// Represents the output of GetEvaluation operation. The content consists of the -// detailed metadata and data file information and the current status of the -// Evaluation . +// Represents the output of GetEvaluation operation. +// +// The content consists of the detailed metadata and data file information and the +// current status of the Evaluation . type Evaluation struct { // Long integer type that is a 64-bit signed number. @@ -204,40 +219,51 @@ type Evaluation struct { // 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) - // . + // + // For more information about performance metrics, please see the [Amazon Machine Learning Developer Guide]. + // + // [Amazon Machine Learning Developer Guide]: https://docs.aws.amazon.com/machine-learning/latest/dg PerformanceMetrics *PerformanceMetrics // A timestamp represented in epoch time. StartedAt *time.Time - // The status of the evaluation. This element can have one of the following - // values: + // 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. Status EntityStatus noSmithyDocumentSerde } -// Represents the output of a GetMLModel operation. The content consists of the -// detailed metadata and the current status of the MLModel . +// Represents the output of a GetMLModel operation. +// +// The content consists of the 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. Algorithm Algorithm @@ -271,10 +297,13 @@ 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?". MLModelType MLModelType @@ -299,12 +328,17 @@ type MLModel struct { // 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. Status EntityStatus @@ -313,32 +347,41 @@ type MLModel struct { 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: + // 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 . + // 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 - // . + // 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. + // 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. + // 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 @@ -346,17 +389,20 @@ type MLModel struct { // 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. // -// 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]. +// +// [Amazon Machine Learning Developer Guide]: https://docs.aws.amazon.com/machine-learning/latest/dg type PerformanceMetrics struct { Properties map[string]string @@ -364,12 +410,16 @@ type PerformanceMetrics struct { } // The output from a Predict operation: +// // - 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 { @@ -441,8 +491,9 @@ 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) - // for data pipelines. + // an Amazon S3 task. For more information, see [Role templates]for data pipelines. + // + // [Role templates]: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html // // This member is required. ResourceRole *string @@ -468,8 +519,9 @@ type RDSDataSpec struct { // 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) - // for data pipelines. + // information, see [Role templates]for data pipelines. + // + // [Role templates]: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html // // This member is required. ServiceRole *string @@ -483,70 +535,118 @@ type RDSDataSpec struct { // 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 - // 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 , + // 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. - // - 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"}} + // + // - 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 // 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", - // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", - // "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, - // "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", - // "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { - // "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": - // "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": - // "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": - // "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } + // 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", "fieldType": + // "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": + // "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" + // }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": + // "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": + // "WEIGHTED_STRING_SEQUENCE" } ], + // + // "excludedVariableNames": [ "F6" ] } DataSchema *string // The Amazon S3 location of the DataSchema . @@ -572,19 +672,21 @@ type RDSMetadata struct { DatabaseUserName *string // 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) + // carry out the copy task from Amazon RDS to Amazon S3. For more information, see [Role templates] // for data pipelines. + // + // [Role templates]: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html 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) - // for data pipelines. + // information, see [Role templates]for data pipelines. + // + // [Role templates]: https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html ServiceRole *string noSmithyDocumentSerde @@ -597,20 +699,25 @@ type RealtimeEndpointInfo struct { // 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. 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 - // before using this URI. + // 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 - // incoming requests per second. + // The maximum processing rate for the real-time endpoint for MLModel , measured + // in incoming requests per second. PeakRequestsPerSecond int32 noSmithyDocumentSerde @@ -640,8 +747,9 @@ 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]. + // + // [USER]: https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html // // This member is required. Password *string @@ -649,8 +757,9 @@ 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]. + // + // [USER]: https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html // // This member is required. Username *string @@ -687,70 +796,118 @@ type RedshiftDataSpec struct { // 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 - // 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 , + // 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. - // - 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"}} + // + // - 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 // 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", - // "recordAnnotationFieldName": "F1", "recordWeightFieldName": "F2", - // "targetFieldName": "F3", "dataFormat": "CSV", "dataFileContainsHeader": true, - // "attributes": [ { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", - // "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { - // "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": - // "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": - // "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": - // "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } + // 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", "fieldType": + // "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": + // "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" + // }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": + // "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": + // "WEIGHTED_STRING_SEQUENCE" } ], + // + // "excludedVariableNames": [ "F6" ] } DataSchema *string // Describes the schema location for an Amazon Redshift DataSource . @@ -765,16 +922,17 @@ 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]. + // + // [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 - // only if Verbose is true in GetDataSourceInput. + // The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in + // GetDataSourceInput. SelectSqlQuery *string noSmithyDocumentSerde @@ -792,70 +950,118 @@ type S3DataSpec struct { // 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 - // 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 , + // 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. - // - 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"}} + // + // - 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. - // 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", - // "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { - // "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": - // "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": - // "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": - // "WEIGHTED_STRING_SEQUENCE" } ], "excludedVariableNames": [ "F6" ] } + // 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", + // + // "recordAnnotationFieldName": "F1", + // + // "recordWeightFieldName": "F2", + // + // "targetFieldName": "F3", + // + // "dataFormat": "CSV", + // + // "dataFileContainsHeader": true, + // + // "attributes": [ + // + // { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": + // "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": + // "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" + // }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": + // "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": + // "WEIGHTED_STRING_SEQUENCE" } ], + // + // "excludedVariableNames": [ "F6" ] } DataSchema *string // Describes the schema location in Amazon S3. You must provide either the diff --git a/service/macie2/api_op_CreateAllowList.go b/service/macie2/api_op_CreateAllowList.go index 2d7848ed762..59cd6f19084 100644 --- a/service/macie2/api_op_CreateAllowList.go +++ b/service/macie2/api_op_CreateAllowList.go @@ -54,9 +54,11 @@ type CreateAllowListInput struct { Description *string // A map of key-value pairs that specifies the tags to associate with the allow - // list. An allow list 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. + // list. + // + // An allow list 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 noSmithyDocumentSerde diff --git a/service/macie2/api_op_CreateClassificationJob.go b/service/macie2/api_op_CreateClassificationJob.go index ba0c121f6d5..96fba9c60eb 100644 --- a/service/macie2/api_op_CreateClassificationJob.go +++ b/service/macie2/api_op_CreateClassificationJob.go @@ -36,8 +36,10 @@ type CreateClassificationJobInput struct { 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. @@ -73,41 +75,55 @@ type CreateClassificationJobInput struct { // 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. + // 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 // 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. + // for the job (managedDataIdentifierSelector). + // + // To retrieve a list of valid values for this property, use the + // ListManagedDataIdentifiers operation. ManagedDataIdentifierIds []string // The selection type to apply when determining which managed data identifiers the // job uses to analyze data. Valid values are: + // // - ALL - Use all managed data identifiers. If you specify this value, don't // specify any values for the managedDataIdentifierIds property. + // // - EXCLUDE - Use all managed data identifiers except the ones 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 value for the customDataIdentifierIds property and don't // specify any values for the managedDataIdentifierIds property. + // // - RECOMMENDED (default) - Use the recommended set of managed data // identifiers. If you specify this value, don't specify any values for the // managedDataIdentifierIds property. + // // If you don't specify a value for this property, the job uses the recommended - // set of managed data identifiers. If the job is a recurring job and you specify - // ALL or EXCLUDE, each job run automatically uses new managed data identifiers - // that are released. If you don't specify a value for this property or you specify - // RECOMMENDED for a recurring job, each job run automatically uses all the managed - // data identifiers that are in the recommended set when the run starts. For - // information about individual managed data identifiers or to determine which ones - // are in the recommended set, see Using managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) - // and Recommended managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-mdis-recommended.html) - // in the Amazon Macie User Guide. + // set of managed data identifiers. + // + // If the job is a recurring job and you specify ALL or EXCLUDE, each job run + // automatically uses new managed data identifiers that are released. If you don't + // specify a value for this property or you specify RECOMMENDED for a recurring + // job, each job run automatically uses all the managed data identifiers that are + // in the recommended set when the run starts. + // + // For information about individual managed data identifiers or to determine which + // ones are in the recommended set, see [Using managed data identifiers]and [Recommended managed data identifiers] in the Amazon Macie User Guide. + // + // [Using managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html + // [Recommended managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-mdis-recommended.html ManagedDataIdentifierSelector types.ManagedDataIdentifierSelector // The sampling depth, as a percentage, for the job to apply when processing @@ -122,8 +138,9 @@ type CreateClassificationJobInput struct { // ONE_TIME. ScheduleFrequency *types.JobScheduleFrequency - // A map of key-value pairs that specifies the tags to associate with the job. A - // job can have a maximum of 50 tags. Each tag consists of a tag key and an + // A map of key-value pairs that specifies the tags to associate with the job. + // + // A job 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_CreateCustomDataIdentifier.go b/service/macie2/api_op_CreateCustomDataIdentifier.go index 7627f4f912d..1c823f3a1a4 100644 --- a/service/macie2/api_op_CreateCustomDataIdentifier.go +++ b/service/macie2/api_op_CreateCustomDataIdentifier.go @@ -31,10 +31,12 @@ func (c *Client) CreateCustomDataIdentifier(ctx context.Context, params *CreateC type CreateCustomDataIdentifierInput struct { // A custom name for the custom data identifier. The name can contain as many as - // 128 characters. We strongly recommend that you avoid including any sensitive - // data in the name of a custom data identifier. Other users of your account might - // be able to see this name, depending on the actions that they're allowed to - // perform in Amazon Macie. + // 128 characters. + // + // We strongly recommend that you avoid including any sensitive data in the name + // of a custom data identifier. Other users of your account might be able to see + // this name, depending on the actions that they're allowed to perform in Amazon + // Macie. // // This member is required. Name *string @@ -50,10 +52,12 @@ type CreateCustomDataIdentifierInput struct { ClientToken *string // A custom description of the custom data identifier. The description can contain - // as many as 512 characters. We strongly recommend that you avoid including any - // sensitive data in the description of a custom data identifier. Other users of - // your account might be able to see this description, depending on the actions - // that they're allowed to perform in Amazon Macie. + // as many as 512 characters. + // + // We strongly recommend that you avoid including any sensitive data in the + // description of a custom data identifier. Other users of your account might be + // able to see this description, depending on the actions that they're allowed to + // perform in Amazon Macie. Description *string // An array that lists specific character sequences (ignore words) to exclude from @@ -84,16 +88,19 @@ type CreateCustomDataIdentifierInput struct { // specify more than one, the occurrences thresholds must be in ascending order by // severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and // 100 for HIGH. If an S3 object contains fewer occurrences than the lowest - // specified threshold, Amazon Macie doesn't create a finding. If you don't specify - // any values for this array, Macie creates findings for S3 objects that contain at - // least one occurrence of text that matches the detection criteria, and Macie - // assigns the MEDIUM severity to those findings. + // specified threshold, Amazon Macie doesn't create a finding. + // + // If you don't specify any values for this array, Macie creates findings for S3 + // objects that contain at least one occurrence of text that matches the detection + // criteria, and Macie assigns the MEDIUM severity to those findings. SeverityLevels []types.SeverityLevel // A map of key-value pairs that specifies the tags to associate with the custom - // data identifier. A custom data identifier 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. + // data identifier. + // + // A custom data identifier 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 noSmithyDocumentSerde diff --git a/service/macie2/api_op_CreateFindingsFilter.go b/service/macie2/api_op_CreateFindingsFilter.go index 8232fa741cf..5770e187a69 100644 --- a/service/macie2/api_op_CreateFindingsFilter.go +++ b/service/macie2/api_op_CreateFindingsFilter.go @@ -42,10 +42,11 @@ type CreateFindingsFilterInput struct { FindingCriteria *types.FindingCriteria // A custom name for the filter. The name must contain at least 3 characters and - // can contain as many as 64 characters. We strongly recommend that you avoid - // including any sensitive data in the name of a filter. Other users of your - // account might be able to see this name, depending on the actions that they're - // allowed to perform in Amazon Macie. + // can contain as many as 64 characters. + // + // We strongly recommend that you avoid including any sensitive data in the name + // of a filter. Other users of your account might be able to see this name, + // depending on the actions that they're allowed to perform in Amazon Macie. // // This member is required. Name *string @@ -55,10 +56,12 @@ type CreateFindingsFilterInput struct { ClientToken *string // A custom description of the filter. The description can contain as many as 512 - // characters. We strongly recommend that you avoid including any sensitive data in - // the description of a filter. Other users of your account might be able to see - // this description, depending on the actions that they're allowed to perform in - // Amazon Macie. + // characters. + // + // We strongly recommend that you avoid including any sensitive data in the + // description of a filter. Other users of your account might be able to see this + // description, depending on the actions that they're allowed to perform in Amazon + // Macie. Description *string // The position of the filter in the list of saved filters on the Amazon Macie @@ -67,6 +70,7 @@ type CreateFindingsFilterInput struct { 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 // 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. diff --git a/service/macie2/api_op_CreateMember.go b/service/macie2/api_op_CreateMember.go index eddb3ceff93..053d3800818 100644 --- a/service/macie2/api_op_CreateMember.go +++ b/service/macie2/api_op_CreateMember.go @@ -35,9 +35,11 @@ type CreateMemberInput struct { Account *types.AccountDetail // A map of key-value pairs that specifies the tags to associate with the account - // in Amazon Macie. An account 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. + // in Amazon Macie. + // + // An account 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 noSmithyDocumentSerde diff --git a/service/macie2/api_op_DeleteAllowList.go b/service/macie2/api_op_DeleteAllowList.go index fc649efdd82..aea5d6e794c 100644 --- a/service/macie2/api_op_DeleteAllowList.go +++ b/service/macie2/api_op_DeleteAllowList.go @@ -34,12 +34,13 @@ type DeleteAllowListInput struct { Id *string // Specifies whether to force deletion of the allow list, even if active - // classification jobs are configured to use the list. When you try to delete an - // allow list, Amazon Macie checks for classification jobs that use the list and - // have a status other than COMPLETE or CANCELLED. By default, Macie rejects your - // request if any jobs meet these criteria. To skip these checks and delete the - // list, set this value to true. To delete the list only if no active jobs are - // configured to use it, set this value to false. + // classification jobs are configured to use the list. + // + // When you try to delete an allow list, Amazon Macie checks for classification + // jobs that use the list and have a status other than COMPLETE or CANCELLED. By + // default, Macie rejects your request if any jobs meet these criteria. To skip + // these checks and delete the list, set this value to true. To delete the list + // only if no active jobs are configured to use it, set this value to false. IgnoreJobChecks *string noSmithyDocumentSerde diff --git a/service/macie2/api_op_DescribeClassificationJob.go b/service/macie2/api_op_DescribeClassificationJob.go index 8657a7ab660..ca116f8ba7e 100644 --- a/service/macie2/api_op_DescribeClassificationJob.go +++ b/service/macie2/api_op_DescribeClassificationJob.go @@ -74,17 +74,23 @@ 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 @@ -92,7 +98,9 @@ type DescribeClassificationJobOutput struct { 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. JobType types.JobType @@ -110,31 +118,41 @@ type DescribeClassificationJobOutput struct { // An array of unique identifiers, one for each managed data identifier that the // job is explicitly configured to include (use) or exclude (not use) when it // analyzes data. Inclusion or exclusion depends on the managed data identifier - // selection type specified for the job (managedDataIdentifierSelector).This value - // is null if the job's managed data identifier selection type is ALL, NONE, or - // RECOMMENDED. + // selection type specified for the job (managedDataIdentifierSelector). + // + // This value is null if the job's managed data identifier selection type is ALL, + // NONE, or RECOMMENDED. ManagedDataIdentifierIds []string // The selection type that determines which managed data identifiers the job uses // when it analyzes data. Possible values are: + // // - ALL - Use all managed data identifiers. + // // - EXCLUDE - Use all managed data identifiers except the ones 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. Use only custom data // identifiers (customDataIdentifierIds). + // // - RECOMMENDED (default) - Use the recommended set of managed data identifiers. + // // If this value is null, the job uses the recommended set of managed data - // identifiers. If the job is a recurring job and this value is ALL or EXCLUDE, - // each job run automatically uses new managed data identifiers that are released. - // If this value is null or RECOMMENDED for a recurring job, each job run uses all - // the managed data identifiers that are in the recommended set when the run - // starts. For information about individual managed data identifiers or to - // determine which ones are in the recommended set, see Using managed data - // identifiers (https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html) - // and Recommended managed data identifiers (https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-mdis-recommended.html) - // in the Amazon Macie User Guide. + // identifiers. + // + // If the job is a recurring job and this value is ALL or EXCLUDE, each job run + // automatically uses new managed data identifiers that are released. If this value + // is null or RECOMMENDED for a recurring job, each job run uses all the managed + // data identifiers that are in the recommended set when the run starts. + // + // For information about individual managed data identifiers or to determine which + // ones are in the recommended set, see [Using managed data identifiers]and [Recommended managed data identifiers] in the Amazon Macie User Guide. + // + // [Using managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html + // [Recommended managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-mdis-recommended.html ManagedDataIdentifierSelector types.ManagedDataIdentifierSelector // The custom name of the job. diff --git a/service/macie2/api_op_GetBucketStatistics.go b/service/macie2/api_op_GetBucketStatistics.go index 1c3e1cc6d02..9344de8f45e 100644 --- a/service/macie2/api_op_GetBucketStatistics.go +++ b/service/macie2/api_op_GetBucketStatistics.go @@ -71,10 +71,12 @@ type GetBucketStatisticsOutput struct { // The total storage size, in bytes, of all the objects that Amazon Macie can // analyze in the buckets. These objects use a supported storage class and have a - // file name extension for a supported file or storage format. If versioning is - // enabled for any of the buckets, this value is based on the size of the latest - // version of each applicable object in the buckets. This value doesn't reflect the - // storage size of all versions of all applicable objects in the buckets. + // file name extension for a supported file or storage format. + // + // If versioning is enabled for any of the buckets, this value is based on the + // size of the latest version of each applicable object in the buckets. This value + // doesn't reflect the storage size of all versions of all applicable objects in + // the buckets. ClassifiableSizeInBytes *int64 // The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most @@ -84,17 +86,20 @@ type GetBucketStatisticsOutput struct { // The total number of objects in the buckets. ObjectCount *int64 - // The total storage size, in bytes, of the buckets. If versioning is enabled for - // any of the buckets, this value is based on the size of the latest version of - // each object in the buckets. This value doesn't reflect the storage size of all - // versions of the objects in the buckets. + // The total storage size, in bytes, of the buckets. + // + // If versioning is enabled for any of the buckets, this value is based on the + // size of the latest version of each object in the buckets. This value doesn't + // reflect the storage size of all versions of the objects in the buckets. SizeInBytes *int64 // The total storage size, in bytes, of the objects that are compressed (.gz, - // .gzip, .zip) files in the buckets. If versioning is enabled for any of the - // buckets, this value is based on the size of the latest version of each - // applicable object in the buckets. This value doesn't reflect the storage size of - // all versions of the applicable objects in the buckets. + // .gzip, .zip) files in the buckets. + // + // If versioning is enabled for any of the buckets, this value is based on the + // size of the latest version of each applicable object in the buckets. This value + // doesn't reflect the storage size of all versions of the applicable objects in + // the buckets. SizeInBytesCompressed *int64 // The total number of objects that Amazon Macie can't analyze in the buckets. diff --git a/service/macie2/api_op_GetFindingStatistics.go b/service/macie2/api_op_GetFindingStatistics.go index d2b93ca9a66..8b50d4382be 100644 --- a/service/macie2/api_op_GetFindingStatistics.go +++ b/service/macie2/api_op_GetFindingStatistics.go @@ -30,12 +30,16 @@ 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. // diff --git a/service/macie2/api_op_GetSensitiveDataOccurrences.go b/service/macie2/api_op_GetSensitiveDataOccurrences.go index fdf8e298b3f..a60e4c24bfd 100644 --- a/service/macie2/api_op_GetSensitiveDataOccurrences.go +++ b/service/macie2/api_op_GetSensitiveDataOccurrences.go @@ -55,10 +55,13 @@ 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. Status types.RevealRequestStatus @@ -188,12 +191,13 @@ type FindingRevealedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetSensitiveDataOccurrencesInput, *GetSensitiveDataOccurrencesOutput, error) (bool, error) } diff --git a/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go b/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go index 0b7cbd9d87c..ef02de06caf 100644 --- a/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go +++ b/service/macie2/api_op_GetSensitiveDataOccurrencesAvailability.go @@ -47,46 +47,58 @@ type GetSensitiveDataOccurrencesAvailabilityOutput struct { // Specifies why occurrences of sensitive data can't be retrieved for the finding. // Possible values are: + // // - ACCOUNT_NOT_IN_ORGANIZATION - The affected account isn't currently part of // your organization. Or the account is part of your organization but Macie isn't // currently enabled for the account. You're not allowed to access the affected S3 // object by using Macie. + // // - INVALID_CLASSIFICATION_RESULT - There isn't a corresponding sensitive data // discovery result for the finding. Or the corresponding sensitive data discovery // result isn't available in the current Amazon Web Services Region, is malformed // or corrupted, or uses an unsupported storage format. Macie can't verify the // location of the sensitive data to retrieve. + // // - INVALID_RESULT_SIGNATURE - The corresponding sensitive data discovery // result is stored in an S3 object that wasn't signed by Macie. Macie can't verify // the integrity and authenticity of the sensitive data discovery result. // Therefore, Macie can't verify the location of the sensitive data to retrieve. + // // - MEMBER_ROLE_TOO_PERMISSIVE - The trust or permissions policy for the IAM // role in the affected member account doesn't meet Macie requirements for // restricting access to the role. Or the role's trust policy doesn't specify the // correct external ID for your organization. Macie can't assume the role to // retrieve the sensitive data. + // // - MISSING_GET_MEMBER_PERMISSION - You're not allowed to retrieve information // about the association between your account and the affected account. Macie can't // determine whether you’re allowed to access the affected S3 object as the // delegated Macie administrator for the affected account. + // // - OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object // exceeds the size quota for retrieving occurrences of sensitive data from this // type of file. + // // - OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object was // renamed, moved, deleted, or changed after Macie created the finding. Or the // object is encrypted with an KMS key that's currently disabled. + // // - RESULT_NOT_SIGNED - The corresponding sensitive data discovery result is // stored in an S3 object that hasn't been signed. Macie can't verify the integrity // and authenticity of the sensitive data discovery result. Therefore, Macie can't // verify the location of the sensitive data to retrieve. + // // - ROLE_TOO_PERMISSIVE - Your account is configured to retrieve occurrences of // sensitive data by using an IAM role whose trust or permissions policy doesn't // meet Macie requirements for restricting access to the role. Macie can’t assume // the role to retrieve the sensitive data. + // // - 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 diff --git a/service/macie2/api_op_ListResourceProfileArtifacts.go b/service/macie2/api_op_ListResourceProfileArtifacts.go index 30c17e8d186..2687397faf6 100644 --- a/service/macie2/api_op_ListResourceProfileArtifacts.go +++ b/service/macie2/api_op_ListResourceProfileArtifacts.go @@ -45,12 +45,14 @@ 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. + // 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_TagResource.go b/service/macie2/api_op_TagResource.go index 48290cee95c..76c98491ef3 100644 --- a/service/macie2/api_op_TagResource.go +++ b/service/macie2/api_op_TagResource.go @@ -34,10 +34,11 @@ 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_UpdateAllowList.go b/service/macie2/api_op_UpdateAllowList.go index b43097bbdb9..3f327e77d6b 100644 --- a/service/macie2/api_op_UpdateAllowList.go +++ b/service/macie2/api_op_UpdateAllowList.go @@ -32,8 +32,10 @@ type UpdateAllowListInput struct { // The criteria that specify the text or text pattern to ignore. The criteria can // be the location and name of an S3 object that lists specific text to ignore // (s3WordsList), or a regular expression that defines a text pattern to ignore - // (regex). You can change a list's underlying criteria, such as the name of the S3 - // object or the regular expression to use. However, you can't change the type from + // (regex). + // + // You can change a list's underlying criteria, such as the name of the S3 object + // or the regular expression to use. However, you can't change the type from // s3WordsList to regex or the other way around. // // This member is required. diff --git a/service/macie2/api_op_UpdateAutomatedDiscoveryConfiguration.go b/service/macie2/api_op_UpdateAutomatedDiscoveryConfiguration.go index fad1d61d7a4..79f58cce233 100644 --- a/service/macie2/api_op_UpdateAutomatedDiscoveryConfiguration.go +++ b/service/macie2/api_op_UpdateAutomatedDiscoveryConfiguration.go @@ -32,13 +32,14 @@ type UpdateAutomatedDiscoveryConfigurationInput struct { // The new status of automated sensitive data discovery for the account. Valid // values are: ENABLED, start or resume automated sensitive data discovery // activities for the account; and, DISABLED, stop performing automated sensitive - // data discovery activities for the account. When you enable automated sensitive - // data discovery for the first time, Amazon Macie uses default configuration - // settings to determine which data sources to analyze and which managed data - // identifiers to use. To change these settings, use the UpdateClassificationScope - // and UpdateSensitivityInspectionTemplate operations, respectively. If you change - // the settings and subsequently disable the configuration, Amazon Macie retains - // your changes. + // data discovery activities for the account. + // + // When you enable automated sensitive data discovery for the first time, Amazon + // Macie uses default configuration settings to determine which data sources to + // analyze and which managed data identifiers to use. To change these settings, use + // the UpdateClassificationScope and UpdateSensitivityInspectionTemplate + // operations, respectively. If you change the settings and subsequently disable + // the configuration, Amazon Macie retains your changes. // // This member is required. Status types.AutomatedDiscoveryStatus diff --git a/service/macie2/api_op_UpdateClassificationJob.go b/service/macie2/api_op_UpdateClassificationJob.go index 2457478a61a..0591e2c7984 100644 --- a/service/macie2/api_op_UpdateClassificationJob.go +++ b/service/macie2/api_op_UpdateClassificationJob.go @@ -35,25 +35,32 @@ 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 + // 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. + // 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. + // 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 b0c59641812..4258bf77755 100644 --- a/service/macie2/api_op_UpdateFindingsFilter.go +++ b/service/macie2/api_op_UpdateFindingsFilter.go @@ -44,20 +44,23 @@ type UpdateFindingsFilterInput struct { ClientToken *string // A custom description of the filter. The description can contain as many as 512 - // characters. We strongly recommend that you avoid including any sensitive data in - // the description of a filter. Other users of your account might be able to see - // this description, depending on the actions that they're allowed to perform in - // Amazon Macie. + // characters. + // + // We strongly recommend that you avoid including any sensitive data in the + // description of a filter. Other users of your account might be able to see this + // description, depending on the actions that they're allowed to perform in Amazon + // Macie. Description *string // The criteria to use to filter findings. FindingCriteria *types.FindingCriteria // A custom name for the filter. The name must contain at least 3 characters and - // can contain as many as 64 characters. We strongly recommend that you avoid - // including any sensitive data in the name of a filter. Other users of your - // account might be able to see this name, depending on the actions that they're - // allowed to perform in Amazon Macie. + // can contain as many as 64 characters. + // + // We strongly recommend that you avoid including any sensitive data in the name + // of a filter. Other users of your account might be able to see this name, + // depending on the actions that they're allowed to perform in Amazon Macie. Name *string // The position of the filter in the list of saved filters on the Amazon Macie diff --git a/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go b/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go index 39f0a7bc2e0..43de970433e 100644 --- a/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go +++ b/service/macie2/api_op_UpdateSensitivityInspectionTemplate.go @@ -39,8 +39,10 @@ type UpdateSensitivityInspectionTemplateInput struct { Description *string // The managed data identifiers to explicitly exclude (not use) when analyzing - // data. To exclude an allow list or custom data identifier that's currently - // included by the template, update the values for the + // data. + // + // To exclude an allow list or custom data identifier that's currently included by + // the template, update the values for the // SensitivityInspectionTemplateIncludes.allowListIds and // SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, // respectively. diff --git a/service/macie2/options.go b/service/macie2/options.go index bf8cee97437..88f7612c01e 100644 --- a/service/macie2/options.go +++ b/service/macie2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/macie2/types/enums.go b/service/macie2/types/enums.go index 1245faa1b3d..081f7f2887b 100644 --- a/service/macie2/types/enums.go +++ b/service/macie2/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AdminStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdminStatus) Values() []AdminStatus { return []AdminStatus{ "ENABLED", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AllowListStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllowListStatusCode) Values() []AllowListStatusCode { return []AllowListStatusCode{ "OK", @@ -61,8 +63,9 @@ const ( // Values returns all known values for AllowsUnencryptedObjectUploads. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllowsUnencryptedObjectUploads) Values() []AllowsUnencryptedObjectUploads { return []AllowsUnencryptedObjectUploads{ "TRUE", @@ -81,6 +84,7 @@ const ( // 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{ @@ -98,8 +102,9 @@ const ( ) // Values returns all known values for AvailabilityCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvailabilityCode) Values() []AvailabilityCode { return []AvailabilityCode{ "AVAILABLE", @@ -115,8 +120,9 @@ const ( ) // Values returns all known values for BucketMetadataErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketMetadataErrorCode) Values() []BucketMetadataErrorCode { return []BucketMetadataErrorCode{ "ACCESS_DENIED", @@ -134,8 +140,9 @@ const ( // Values returns all known values for ClassificationScopeUpdateOperation. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClassificationScopeUpdateOperation) Values() []ClassificationScopeUpdateOperation { return []ClassificationScopeUpdateOperation{ "ADD", @@ -152,8 +159,9 @@ const ( ) // Values returns all known values for Currency. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Currency) Values() []Currency { return []Currency{ "USD", @@ -170,8 +178,9 @@ const ( ) // Values returns all known values for DataIdentifierSeverity. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataIdentifierSeverity) Values() []DataIdentifierSeverity { return []DataIdentifierSeverity{ "LOW", @@ -189,8 +198,9 @@ const ( ) // Values returns all known values for DataIdentifierType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataIdentifierType) Values() []DataIdentifierType { return []DataIdentifierType{ "CUSTOM", @@ -212,8 +222,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -236,8 +247,9 @@ const ( ) // Values returns all known values for EffectivePermission. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EffectivePermission) Values() []EffectivePermission { return []EffectivePermission{ "PUBLIC", @@ -258,8 +270,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "NONE", @@ -279,8 +292,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -296,8 +310,9 @@ const ( ) // Values returns all known values for FindingActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingActionType) Values() []FindingActionType { return []FindingActionType{ "AWS_API_CALL", @@ -313,8 +328,9 @@ const ( ) // Values returns all known values for FindingCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingCategory) Values() []FindingCategory { return []FindingCategory{ "CLASSIFICATION", @@ -333,6 +349,7 @@ const ( // Values returns all known values for FindingPublishingFrequency. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FindingPublishingFrequency) Values() []FindingPublishingFrequency { return []FindingPublishingFrequency{ @@ -351,8 +368,9 @@ const ( ) // Values returns all known values for FindingsFilterAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingsFilterAction) Values() []FindingsFilterAction { return []FindingsFilterAction{ "ARCHIVE", @@ -370,8 +388,9 @@ const ( // Values returns all known values for FindingStatisticsSortAttributeName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingStatisticsSortAttributeName) Values() []FindingStatisticsSortAttributeName { return []FindingStatisticsSortAttributeName{ "groupKey", @@ -397,8 +416,9 @@ const ( ) // Values returns all known values for FindingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingType) Values() []FindingType { return []FindingType{ "SensitiveData:S3Object/Multiple", @@ -426,8 +446,9 @@ const ( ) // Values returns all known values for GroupBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupBy) Values() []GroupBy { return []GroupBy{ "resourcesAffected.s3Bucket.name", @@ -447,8 +468,9 @@ const ( ) // Values returns all known values for IsDefinedInJob. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IsDefinedInJob) Values() []IsDefinedInJob { return []IsDefinedInJob{ "TRUE", @@ -467,8 +489,9 @@ const ( ) // Values returns all known values for IsMonitoredByJob. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IsMonitoredByJob) Values() []IsMonitoredByJob { return []IsMonitoredByJob{ "TRUE", @@ -492,8 +515,9 @@ const ( ) // Values returns all known values for JobComparator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobComparator) Values() []JobComparator { return []JobComparator{ "EQ", @@ -520,8 +544,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -542,8 +567,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "ONE_TIME", @@ -560,8 +586,9 @@ const ( ) // Values returns all known values for LastRunErrorStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastRunErrorStatusCode) Values() []LastRunErrorStatusCode { return []LastRunErrorStatusCode{ "NONE", @@ -580,8 +607,9 @@ const ( ) // Values returns all known values for ListJobsFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListJobsFilterKey) Values() []ListJobsFilterKey { return []ListJobsFilterKey{ "jobType", @@ -603,6 +631,7 @@ const ( // Values returns all known values for ListJobsSortAttributeName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListJobsSortAttributeName) Values() []ListJobsSortAttributeName { return []ListJobsSortAttributeName{ @@ -622,8 +651,9 @@ const ( ) // Values returns all known values for MacieStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MacieStatus) Values() []MacieStatus { return []MacieStatus{ "PAUSED", @@ -644,8 +674,9 @@ const ( // Values returns all known values for ManagedDataIdentifierSelector. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedDataIdentifierSelector) Values() []ManagedDataIdentifierSelector { return []ManagedDataIdentifierSelector{ "ALL", @@ -665,8 +696,9 @@ const ( ) // Values returns all known values for OrderBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderBy) Values() []OrderBy { return []OrderBy{ "ASC", @@ -683,8 +715,9 @@ const ( ) // Values returns all known values for OriginType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginType) Values() []OriginType { return []OriginType{ "SENSITIVE_DATA_DISCOVERY_JOB", @@ -709,8 +742,9 @@ const ( ) // Values returns all known values for RelationshipStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationshipStatus) Values() []RelationshipStatus { return []RelationshipStatus{ "Enabled", @@ -735,8 +769,9 @@ const ( ) // Values returns all known values for RetrievalMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetrievalMode) Values() []RetrievalMode { return []RetrievalMode{ "CALLER_CREDENTIALS", @@ -754,8 +789,9 @@ const ( ) // Values returns all known values for RevealRequestStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RevealRequestStatus) Values() []RevealRequestStatus { return []RevealRequestStatus{ "SUCCESS", @@ -773,8 +809,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -793,8 +830,9 @@ const ( ) // Values returns all known values for ScopeFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScopeFilterKey) Values() []ScopeFilterKey { return []ScopeFilterKey{ "OBJECT_EXTENSION", @@ -814,6 +852,7 @@ const ( // Values returns all known values for SearchResourcesComparator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SearchResourcesComparator) Values() []SearchResourcesComparator { return []SearchResourcesComparator{ @@ -834,8 +873,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchResourcesSimpleCriterionKey) Values() []SearchResourcesSimpleCriterionKey { return []SearchResourcesSimpleCriterionKey{ "ACCOUNT_ID", @@ -857,8 +897,9 @@ const ( // Values returns all known values for SearchResourcesSortAttributeName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchResourcesSortAttributeName) Values() []SearchResourcesSortAttributeName { return []SearchResourcesSortAttributeName{ "ACCOUNT_ID", @@ -880,6 +921,7 @@ const ( // Values returns all known values for SensitiveDataItemCategory. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SensitiveDataItemCategory) Values() []SensitiveDataItemCategory { return []SensitiveDataItemCategory{ @@ -900,8 +942,9 @@ const ( ) // Values returns all known values for SeverityDescription. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SeverityDescription) Values() []SeverityDescription { return []SeverityDescription{ "Low", @@ -921,8 +964,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -944,6 +988,7 @@ const ( // 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{ @@ -970,8 +1015,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -994,8 +1040,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1011,8 +1058,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1031,8 +1079,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "NONE", @@ -1061,6 +1110,7 @@ const ( // 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{ @@ -1086,8 +1136,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "TERABYTES", @@ -1109,8 +1160,9 @@ const ( // Values returns all known values for UsageStatisticsFilterComparator. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageStatisticsFilterComparator) Values() []UsageStatisticsFilterComparator { return []UsageStatisticsFilterComparator{ "GT", @@ -1135,6 +1187,7 @@ const ( // 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{ @@ -1156,8 +1209,9 @@ const ( ) // Values returns all known values for UsageStatisticsSortKey. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageStatisticsSortKey) Values() []UsageStatisticsSortKey { return []UsageStatisticsSortKey{ "accountId", @@ -1178,8 +1232,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1202,8 +1257,9 @@ const ( ) // Values returns all known values for UserIdentityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserIdentityType) Values() []UserIdentityType { return []UserIdentityType{ "AssumedRole", diff --git a/service/macie2/types/types.go b/service/macie2/types/types.go index 69adf7ddc87..c5d90a39092 100644 --- a/service/macie2/types/types.go +++ b/service/macie2/types/types.go @@ -84,24 +84,33 @@ 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: + // 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 @@ -109,6 +118,7 @@ type AllowListStatus struct { // 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 @@ -253,9 +263,10 @@ 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) -// in the Amazon Simple Storage Service User Guide. +// detailed information about each setting, see [Blocking public access to your Amazon S3 storage]in the Amazon Simple Storage +// Service User Guide. +// +// [Blocking public access to your Amazon S3 storage]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html type BlockPublicAccess struct { // Specifies whether Amazon S3 blocks public access control lists (ACLs) for the @@ -301,9 +312,10 @@ 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) -// in the Amazon Simple Storage Service User Guide. +// the buckets. For detailed information about these settings, see [Setting default server-side encryption behavior for Amazon S3 buckets]in the Amazon +// Simple Storage Service User Guide. +// +// [Setting default server-side encryption behavior for Amazon S3 buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html type BucketCountByEncryptionType struct { // The total number of buckets whose default encryption settings are configured to @@ -440,14 +452,17 @@ type BucketLevelPermissions struct { // Provides statistical data and other information about an S3 bucket that Amazon // 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) -// 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 -// other properties is null. Key exceptions are accountId, bucketArn, -// bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of -// the error, refer to the errorCode and errorMessage values. +// incomplete multipart uploads. For more information, see [How Macie monitors Amazon S3 data security]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 other properties is null. Key +// exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, +// and region. To identify the cause of the error, refer to the errorCode and +// errorMessage values. +// +// [How Macie monitors Amazon S3 data security]: https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html type BucketMetadata struct { // The unique identifier for the Amazon Web Services account that owns the bucket. @@ -458,12 +473,15 @@ type BucketMetadata struct { // // - 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. @@ -487,10 +505,12 @@ type BucketMetadata struct { // The total storage size, in bytes, of the objects that Amazon Macie can analyze // in the bucket. These objects use a supported storage class and have a file name - // extension for a supported file or storage format. If versioning is enabled for - // the bucket, Macie calculates this value based on the size of the latest version - // of each applicable object in the bucket. This value doesn't reflect the storage - // size of all versions of each applicable object in the bucket. + // extension for a supported file or storage format. + // + // If versioning is enabled for the bucket, Macie calculates this value based on + // the size of the latest version of each applicable object in the bucket. This + // value doesn't reflect the storage size of all versions of each applicable object + // in the bucket. ClassifiableSizeInBytes *int64 // The error code for an error that prevented Amazon Macie from retrieving and @@ -552,32 +572,40 @@ type BucketMetadata struct { // 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 - // the bucket, Amazon Macie calculates this value based on the size of the latest - // version of each object in the bucket. This value doesn't reflect the storage - // size of all versions of each object in the bucket. + // The total storage size, in bytes, of the bucket. + // + // If versioning is enabled for the bucket, Amazon Macie calculates this value + // based on the size of the latest version of each object in the bucket. This value + // doesn't reflect the storage size of all versions of each object in the bucket. SizeInBytes *int64 // The total storage size, in bytes, of the objects that are compressed (.gz, - // .gzip, .zip) files in the bucket. If versioning is enabled for the bucket, - // Amazon Macie calculates this value based on the size of the latest version of - // each applicable object in the bucket. This value doesn't reflect the storage - // size of all versions of each applicable object in the bucket. + // .gzip, .zip) files in the bucket. + // + // If versioning is enabled for the bucket, Amazon Macie calculates this value + // based on the size of the latest version of each applicable object in the bucket. + // This value doesn't reflect the storage size of all versions of each applicable + // object in the bucket. SizeInBytesCompressed *int64 // An array that specifies the tags (keys and values) that are associated with the @@ -634,8 +662,11 @@ 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. EffectivePermission EffectivePermission @@ -647,9 +678,10 @@ type BucketPublicAccess struct { } // 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. +// S3 bucket. For detailed information about these settings, see [Setting default server-side encryption behavior for Amazon S3 buckets]in the Amazon +// Simple Storage Service User Guide. +// +// [Setting default server-side encryption behavior for Amazon S3 buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html type BucketServerSideEncryption struct { // The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key @@ -660,14 +692,18 @@ 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 use SSE-S3 encryption. They're encrypted with an // Amazon S3 managed key. + // // - aws:kms - New objects use SSE-KMS encryption. They're encrypted with an KMS // key (kmsMasterKeyId), either an Amazon Web Services managed key or a customer // managed key. + // // - aws:kms:dsse - New objects use DSSE-KMS encryption. They're encrypted with // an KMS key (kmsMasterKeyId), either an Amazon Web Services managed key or a // customer managed key. + // // - NONE - The bucket's default encryption settings don't specify server-side // encryption behavior for new objects. Type Type @@ -790,10 +826,12 @@ 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 - // 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 - // finding (classificationDetails.detailedResultsLocation). + // 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 finding + // (classificationDetails.detailedResultsLocation). AdditionalOccurrences *bool // The custom data identifiers that detected the sensitive data and the number of @@ -822,77 +860,105 @@ 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. 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: + // 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) - // in the Amazon Macie User Guide. + // storage formats, see [Quotas]and [Supported storage classes and formats] in the Amazon Macie User Guide. + // + // [Quotas]: https://docs.aws.amazon.com/macie/latest/user/macie-quotas.html + // [Supported storage classes and formats]: https://docs.aws.amazon.com/macie/latest/user/discovery-supported-storage.html Reason *string noSmithyDocumentSerde @@ -941,8 +1007,9 @@ 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]in the Amazon Macie User Guide. +// +// [Fundamentals of filtering findings]: https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html type CriterionAdditionalProperties struct { // The value for the property matches (equals) the specified value. If you specify @@ -951,12 +1018,13 @@ type CriterionAdditionalProperties struct { // The value for the property exclusively matches (equals an exact match for) all // the specified values. If you specify multiple values, Amazon Macie uses AND - // logic to join the values. You can use this operator with the following - // properties: customDataIdentifiers.detections.arn, - // customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, - // resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, - // resourcesAffected.s3Object.tags.value, sensitiveData.category, and - // sensitiveData.detections.type. + // logic to join the values. + // + // You can use this operator with the following properties: + // customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, + // resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, + // resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, + // sensitiveData.category, and sensitiveData.detections.type. EqExactMatch []string // The value for the property is greater than the specified value. @@ -1093,8 +1161,9 @@ 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]in the Amazon Macie User Guide. + // + // [Using managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html Id *string // The name of the custom data identifier or managed data identifier that detected @@ -1449,44 +1518,54 @@ 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. 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. IsMonitoredByJob IsMonitoredByJob // The unique identifier for the job that ran most recently and is configured to // analyze data in the bucket, either the latest run of a recurring job or the only - // run of a one-time job. This value is typically null if the value for the - // isDefinedInJob property is FALSE or UNKNOWN. + // run of a one-time job. + // + // This value is typically null if the value for the 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 - // isDefinedInJob property is FALSE or UNKNOWN. + // the most recent run started. + // + // This value is typically null if the value for the isDefinedInJob property is + // FALSE or UNKNOWN. LastJobRunTime *time.Time noSmithyDocumentSerde @@ -1560,17 +1639,23 @@ 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 @@ -1578,7 +1663,9 @@ type JobSummary struct { 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. JobType JobType @@ -1615,15 +1702,18 @@ 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) -// in the Amazon Macie User Guide. +// these errors, see [Monitoring sensitive data discovery jobs]in the Amazon Macie User Guide. +// +// [Monitoring sensitive data discovery jobs]: https://docs.aws.amazon.com/macie/latest/user/discovery-jobs-monitor-cw-logs.html 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. Code LastRunErrorStatusCode @@ -1679,8 +1769,9 @@ 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]in the Amazon Macie User Guide. +// +// [Using managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html type ManagedDataIdentifierSummary struct { // The category of sensitive data that the managed data identifier detects: @@ -1703,13 +1794,15 @@ type ManagedDataIdentifierSummary struct { // Provides statistical data and other information about an S3 bucket that Amazon // 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) -// 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 -// bucketName. To identify the cause of the error, refer to the errorCode and -// errorMessage values. +// incomplete multipart uploads. For more information, see [How Macie monitors Amazon S3 data security]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 bucketName. To identify the cause of +// the error, refer to the errorCode and errorMessage values. +// +// [How Macie monitors Amazon S3 data security]: https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-how-it-works.html type MatchingBucket struct { // The unique identifier for the Amazon Web Services account that owns the bucket. @@ -1725,10 +1818,12 @@ type MatchingBucket struct { // The total storage size, in bytes, of the objects that Amazon Macie can analyze // in the bucket. These objects use a supported storage class and have a file name - // extension for a supported file or storage format. If versioning is enabled for - // the bucket, Macie calculates this value based on the size of the latest version - // of each applicable object in the bucket. This value doesn't reflect the storage - // size of all versions of each applicable object in the bucket. + // extension for a supported file or storage format. + // + // If versioning is enabled for the bucket, Macie calculates this value based on + // the size of the latest version of each applicable object in the bucket. This + // value doesn't reflect the storage size of all versions of each applicable object + // in the bucket. ClassifiableSizeInBytes *int64 // The error code for an error that prevented Amazon Macie from retrieving and @@ -1768,17 +1863,20 @@ type MatchingBucket struct { // discovery is currently disabled for your account. SensitivityScore *int32 - // The total storage size, in bytes, of the bucket. If versioning is enabled for - // the bucket, Amazon Macie calculates this value based on the size of the latest - // version of each object in the bucket. This value doesn't reflect the storage - // size of all versions of each object in the bucket. + // The total storage size, in bytes, of the bucket. + // + // If versioning is enabled for the bucket, Amazon Macie calculates this value + // based on the size of the latest version of each object in the bucket. This value + // doesn't reflect the storage size of all versions of each object in the bucket. SizeInBytes *int64 // The total storage size, in bytes, of the objects that are compressed (.gz, - // .gzip, .zip) files in the bucket. If versioning is enabled for the bucket, - // Amazon Macie calculates this value based on the size of the latest version of - // each applicable object in the bucket. This value doesn't reflect the storage - // size of all versions of each applicable object in the bucket. + // .gzip, .zip) files in the bucket. + // + // If versioning is enabled for the bucket, Amazon Macie calculates this value + // based on the size of the latest version of each applicable object in the bucket. + // This value doesn't reflect the storage 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. @@ -1851,11 +1949,13 @@ type Member struct { type MonthlySchedule struct { // The numeric day of the month when Amazon Macie runs the job. This value can be - // an integer from 1 through 31. If this value exceeds the number of days in a - // certain month, Macie doesn't run the job that month. Macie runs the job only - // during months that have the specified day. For example, if this value is 31 and - // a month has only 30 days, Macie doesn't run the job that month. To run the job - // every month, specify a value that's less than 29. + // an integer from 1 through 31. + // + // If this value exceeds the number of days in a certain month, Macie doesn't run + // the job that month. Macie runs the job only during months that have the + // specified day. For example, if this value is 31 and a month has only 30 days, + // Macie doesn't run the job that month. To run the job every month, specify a + // value that's less than 29. DayOfMonth *int32 noSmithyDocumentSerde @@ -1924,19 +2024,21 @@ type Occurrences struct { // An array of objects, one for each occurrence of sensitive data in a Microsoft // Excel workbook, CSV file, or TSV file. This value is null for all other types of - // files. Each Cell object specifies a cell or field that contains the sensitive - // data. + // files. + // + // Each Cell object specifies a cell or field that contains the sensitive data. Cells []Cell // An array of objects, one for each occurrence of sensitive data in an email // message or a non-binary text file such as an HTML, TXT, or XML file. Each Range // object specifies a line or inclusive range of lines that contains the sensitive - // data, and the position of the data on the specified line or lines. This value is - // often null for file types that are supported by Cell, Page, or Record objects. - // Exceptions are the location of sensitive data in: unstructured sections of an - // otherwise structured file, such as a comment in a file; a malformed file that - // Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column - // names that contain sensitive data. + // data, and the position of the data on the specified line or lines. + // + // This value is often null for file types that are supported by Cell, Page, or + // Record objects. Exceptions are the location of sensitive data in: unstructured + // sections of an otherwise structured file, such as a comment in a file; a + // malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file + // that has any column names that contain sensitive data. LineRanges []Range // Reserved for future use. @@ -1944,17 +2046,19 @@ type Occurrences struct { // An array of objects, one for each occurrence of sensitive data in an Adobe // Portable Document Format file. This value is null for all other types of files. + // // 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. + // 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 @@ -2016,12 +2120,14 @@ type Record struct { // container or Parquet file, this is the path to the field in the record // (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the // path to the field or array that contains the data. If the data is a value in an - // array, the path also indicates which value contains the data. If Amazon Macie - // detects sensitive data in the name of any element in the path, Macie omits this - // field. If the name of an element exceeds 240 characters, Macie truncates the - // name by removing characters from the beginning of the name. If the resulting - // full path exceeds 250 characters, Macie also truncates the path, starting with - // the first element in the path, until the path contains 250 or fewer characters. + // array, the path also indicates which value contains the data. + // + // If Amazon Macie detects sensitive data in the name of any element in the path, + // Macie omits this field. If the name of an element exceeds 240 characters, Macie + // truncates the name by removing characters from the beginning of the name. If the + // resulting full path exceeds 250 characters, Macie also truncates the path, + // starting with the 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 @@ -2069,9 +2175,12 @@ 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. // @@ -2165,12 +2274,13 @@ type RetrievalConfiguration struct { // The external ID to specify in the trust policy for the IAM role to assume when // retrieving sensitive data from affected S3 objects (roleName). This value is - // null if the value for retrievalMode is CALLER_CREDENTIALS. This ID is a unique - // alphanumeric string that Amazon Macie generates automatically after you - // configure it to assume an IAM role. For a Macie administrator to retrieve - // sensitive data from an affected S3 object for a member account, the trust policy - // for the role in the member account must include an sts:ExternalId condition that - // requires this ID. + // null if the value for retrievalMode is CALLER_CREDENTIALS. + // + // This ID is a unique alphanumeric string that Amazon Macie generates + // automatically after you configure it to assume an IAM role. For a Macie + // administrator to retrieve sensitive data from an affected S3 object for a member + // account, the trust policy for the role in the member account must include an + // sts:ExternalId condition that requires this ID. ExternalId *string // The name of the IAM role that is in the affected Amazon Web Services account @@ -2193,9 +2303,10 @@ type RevealConfiguration struct { // possible values are: ENABLED, the configuration is currently enabled for the // account; and, DISABLED, the configuration is currently disabled for the account. // In a request, valid values are: ENABLED, enable the configuration for the - // account; and, DISABLED, disable the configuration for the account. If you - // disable the configuration, you also permanently delete current settings that - // specify how to access affected S3 objects. If your current access method is + // account; and, DISABLED, disable the configuration for the account. + // + // If you disable the configuration, you also permanently delete current settings + // that specify how to access affected S3 objects. If your current access method is // ASSUME_ROLE, Macie also deletes the external ID and role name currently // specified for the configuration. These settings can't be recovered after they're // deleted. @@ -2206,10 +2317,11 @@ type RevealConfiguration struct { // The Amazon Resource Name (ARN), ID, or alias of the KMS key to use to encrypt // sensitive data that's retrieved. The key must be an existing, customer managed, // symmetric encryption key that's enabled in the same Amazon Web Services Region - // as the Amazon Macie account. If this value specifies an alias, it must include - // the following prefix: alias/. If this value specifies a key that's owned by - // another Amazon Web Services account, it must specify the ARN of the key or the - // ARN of the key's alias. + // as the Amazon Macie account. + // + // If this value specifies an alias, it must include the following prefix: alias/. + // If this value specifies a key that's owned by another Amazon Web Services + // account, it must specify the ARN of the key or the ARN of the key's alias. KmsKeyId *string noSmithyDocumentSerde @@ -2223,12 +2335,15 @@ type S3Bucket struct { // // - 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. @@ -2349,8 +2464,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. @@ -2563,17 +2681,23 @@ 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. + // value that Macie defines for the [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. + // Macie defines for the [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. + // + // [BucketMetadata.sharedAccess]: https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess + // [BucketPublicAccess.effectivePermission]: https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission Values []string noSmithyDocumentSerde @@ -2625,8 +2749,9 @@ 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]in the Amazon Macie User Guide. +// +// [Amazon Macie integration with Security Hub]: https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html type SecurityHubConfiguration struct { // Specifies whether to publish sensitive data findings to Security Hub. If you @@ -2680,10 +2805,12 @@ type SensitivityAggregations struct { // The total storage size, in bytes, of all the objects that Amazon Macie can // analyze in the buckets. These objects use a supported storage class and have a - // file name extension for a supported file or storage format. If versioning is - // enabled for any of the buckets, this value is based on the size of the latest - // version of each applicable object in the buckets. This value doesn't reflect the - // storage size of all versions of all applicable objects in the buckets. + // file name extension for a supported file or storage format. + // + // If versioning is enabled for any of the buckets, this value is based on the + // size of the latest version of each applicable object in the buckets. This value + // doesn't reflect the 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 @@ -2693,10 +2820,11 @@ type SensitivityAggregations struct { // The total number of buckets. TotalCount *int64 - // The total storage size, in bytes, of the buckets. If versioning is enabled for - // any of the buckets, this value is based on the size of the latest version of - // each object in the buckets. This value doesn't reflect the storage size of all - // versions of the objects in the buckets. + // The total storage size, in bytes, of the buckets. + // + // If versioning is enabled for any of the buckets, this value is based on the + // size of the latest version of each object in the buckets. This value doesn't + // reflect the storage size of all versions of the objects in the buckets. TotalSizeInBytes *int64 noSmithyDocumentSerde @@ -2704,9 +2832,10 @@ 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. +// about the managed data identifiers that Amazon Macie currently provides, see [Using managed data identifiers]in +// the Amazon Macie User Guide. +// +// [Using managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html type SensitivityInspectionTemplateExcludes struct { // An array of unique identifiers, one for each managed data identifier to @@ -2721,9 +2850,10 @@ type SensitivityInspectionTemplateExcludes struct { // 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. +// data identifiers that Amazon Macie currently provides, see [Using managed data identifiers]in the Amazon Macie +// User Guide. +// +// [Using managed data identifiers]: https://docs.aws.amazon.com/macie/latest/user/managed-data-identifiers.html type SensitivityInspectionTemplateIncludes struct { // An array of unique identifiers, one for each allow list to include. @@ -2732,9 +2862,10 @@ 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. @@ -2901,17 +3032,23 @@ 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. + // value that Macie defines for the [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. + // Macie defines for the [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. + // + // [BucketMetadata.sharedAccess]: https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess + // [BucketPublicAccess.effectivePermission]: https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission Values []string noSmithyDocumentSerde @@ -2923,10 +3060,14 @@ 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 - EQ (equals), GT (greater than), GTE (greater // than or equals), LT (less than), LTE (less than or equals), or NE (not equals) + // // - OBJECT_SIZE - EQ (equals), GT (greater than), GTE (greater than or equals), // LT (less than), LTE (less than or equals), or NE (not equals) Comparator JobComparator @@ -2937,17 +3078,24 @@ type SimpleScopeTerm struct { // 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: + // 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: 2023-09-24T14: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 @@ -3092,9 +3240,10 @@ type UnprocessedAccount struct { // sensitive data reported by findings. If your request specifies an Identity and // Access Management (IAM) role to assume, Amazon Macie verifies that the role // exists and the attached policies are configured correctly. If there's an issue, -// Macie returns an error. For information about addressing the issue, see -// Configuration options and requirements for retrieving sensitive data samples (https://docs.aws.amazon.com/macie/latest/user/findings-retrieve-sd-options.html) -// in the Amazon Macie User Guide. +// Macie returns an error. For information about addressing the issue, see [Configuration options and requirements for retrieving sensitive data samples]in the +// Amazon Macie User Guide. +// +// [Configuration options and requirements for retrieving sensitive data samples]: https://docs.aws.amazon.com/macie/latest/user/findings-retrieve-sd-options.html type UpdateRetrievalConfiguration struct { // The access method to use when retrieving sensitive data from affected S3 @@ -3102,10 +3251,12 @@ type UpdateRetrievalConfiguration struct { // affected Amazon Web Services account and delegates access to Amazon Macie; and, // CALLER_CREDENTIALS, use the credentials of the IAM user who requests the // sensitive data. If you specify ASSUME_ROLE, also specify the name of an existing - // IAM role for Macie to assume (roleName). If you change this value from - // ASSUME_ROLE to CALLER_CREDENTIALS for an existing configuration, Macie - // permanently deletes the external ID and role name currently specified for the - // configuration. These settings can't be recovered after they're deleted. + // IAM role for Macie to assume (roleName). + // + // If you change this value from ASSUME_ROLE to CALLER_CREDENTIALS for an existing + // configuration, Macie permanently deletes the external ID and role name currently + // specified for the configuration. These settings can't be recovered after they're + // deleted. // // This member is required. RetrievalMode RetrievalMode @@ -3184,12 +3335,18 @@ type UsageStatisticsFilter struct { // An array that lists values to use in the condition, based on the value for the // 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: + // 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. Values []string diff --git a/service/managedblockchain/api_op_CreateAccessor.go b/service/managedblockchain/api_op_CreateAccessor.go index c5f910fdb31..2a284801040 100644 --- a/service/managedblockchain/api_op_CreateAccessor.go +++ b/service/managedblockchain/api_op_CreateAccessor.go @@ -31,7 +31,9 @@ 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 @@ -45,22 +47,31 @@ type CreateAccessorInput struct { // This member is required. ClientRequestToken *string - // The blockchain network that the Accessor token is created for. We recommend - // using the appropriate networkType value for the blockchain network that you are - // creating the Accessor token for. You cannnot use the value + // The blockchain network that the Accessor token is created for. + // + // We recommend using the appropriate networkType value for the blockchain network + // that you are creating the Accessor token for. You cannnot use the value // ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token. + // // The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied: + // // - when the CreateAccessor action does not set a networkType . + // // - to all existing Accessor tokens that were created before the networkType // property was introduced. NetworkType types.AccessorNetworkType - // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // 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] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_CreateMember.go b/service/managedblockchain/api_op_CreateMember.go index d76b64e7e61..262a81bbeca 100644 --- a/service/managedblockchain/api_op_CreateMember.go +++ b/service/managedblockchain/api_op_CreateMember.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a member within a Managed Blockchain network. Applies only to -// Hyperledger Fabric. +// Creates a member within a Managed Blockchain network. +// +// Applies only to Hyperledger Fabric. func (c *Client) CreateMember(ctx context.Context, params *CreateMemberInput, optFns ...func(*Options)) (*CreateMemberOutput, error) { if params == nil { params = &CreateMemberInput{} diff --git a/service/managedblockchain/api_op_CreateNetwork.go b/service/managedblockchain/api_op_CreateNetwork.go index cb4c651f7ff..2e1463013b7 100644 --- a/service/managedblockchain/api_op_CreateNetwork.go +++ b/service/managedblockchain/api_op_CreateNetwork.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new blockchain network using Amazon Managed Blockchain. Applies only -// to Hyperledger Fabric. +// Creates a new blockchain network using Amazon Managed Blockchain. +// +// Applies only to Hyperledger Fabric. func (c *Client) CreateNetwork(ctx context.Context, params *CreateNetworkInput, optFns ...func(*Options)) (*CreateNetworkOutput, error) { if params == nil { params = &CreateNetworkInput{} @@ -59,7 +60,7 @@ type CreateNetworkInput struct { // This member is required. Name *string - // The voting rules used by the network to determine if a proposal is approved. + // The voting rules used by the network to determine if a proposal is approved. // // This member is required. VotingPolicy *types.VotingPolicy @@ -67,16 +68,21 @@ type CreateNetworkInput struct { // An optional description for the network. Description *string - // Configuration properties of the blockchain framework relevant to the network + // Configuration properties of the blockchain framework relevant to the network // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // 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] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_CreateNode.go b/service/managedblockchain/api_op_CreateNode.go index 33e52b4dda4..2886a032d09 100644 --- a/service/managedblockchain/api_op_CreateNode.go +++ b/service/managedblockchain/api_op_CreateNode.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a node on the specified blockchain network. Applies to Hyperledger -// Fabric and Ethereum. +// Creates a node on the specified blockchain network. +// +// Applies to Hyperledger Fabric and Ethereum. func (c *Client) CreateNode(ctx context.Context, params *CreateNodeInput, optFns ...func(*Options)) (*CreateNodeOutput, error) { if params == nil { params = &CreateNodeInput{} @@ -39,9 +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 NetworkId s: + // The unique identifier of the network for the node. + // + // Ethereum public networks have the following NetworkId s: + // // - n-ethereum-mainnet + // // - n-ethereum-goerli // // This member is required. @@ -52,16 +56,22 @@ type CreateNodeInput struct { // This member is required. NodeConfiguration *types.NodeConfiguration - // The unique identifier of the member that owns this node. Applies only to - // Hyperledger Fabric. + // The unique identifier of the member that owns this node. + // + // Applies only to Hyperledger Fabric. MemberId *string - // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // 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] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_CreateProposal.go b/service/managedblockchain/api_op_CreateProposal.go index 42a23af17ed..bdb349c0c71 100644 --- a/service/managedblockchain/api_op_CreateProposal.go +++ b/service/managedblockchain/api_op_CreateProposal.go @@ -13,7 +13,9 @@ import ( // 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. +// 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{} @@ -54,7 +56,7 @@ type CreateProposalInput struct { // This member is required. MemberId *string - // The unique identifier of the network for which the proposal is made. + // The unique identifier of the network for which the proposal is made. // // This member is required. NetworkId *string @@ -63,12 +65,17 @@ type CreateProposalInput struct { // "Proposal to add Example Corp. as member." Description *string - // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // 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] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_DeleteMember.go b/service/managedblockchain/api_op_DeleteMember.go index 461bfe8abf8..7cefb75365c 100644 --- a/service/managedblockchain/api_op_DeleteMember.go +++ b/service/managedblockchain/api_op_DeleteMember.go @@ -16,8 +16,9 @@ import ( // Web Services account that owns the member. In all other cases, the DeleteMember // action is carried out as the result of an approved proposal to remove a member. // If MemberId is the last member in a network specified by the last Amazon Web -// Services account, the network is deleted also. Applies only to Hyperledger -// Fabric. +// Services account, the network is deleted also. +// +// Applies only to Hyperledger Fabric. func (c *Client) DeleteMember(ctx context.Context, params *DeleteMemberInput, optFns ...func(*Options)) (*DeleteMemberOutput, error) { if params == nil { params = &DeleteMemberInput{} diff --git a/service/managedblockchain/api_op_DeleteNode.go b/service/managedblockchain/api_op_DeleteNode.go index f39f2281982..79da77cb6ce 100644 --- a/service/managedblockchain/api_op_DeleteNode.go +++ b/service/managedblockchain/api_op_DeleteNode.go @@ -11,7 +11,9 @@ import ( ) // Deletes a node that your Amazon Web Services account owns. All data on the node -// is lost and cannot be recovered. Applies to Hyperledger Fabric and Ethereum. +// is lost and cannot be recovered. +// +// Applies to Hyperledger Fabric and Ethereum. func (c *Client) DeleteNode(ctx context.Context, params *DeleteNodeInput, optFns ...func(*Options)) (*DeleteNodeOutput, error) { if params == nil { params = &DeleteNodeInput{} @@ -29,9 +31,12 @@ 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 NetworkId s: + // The unique identifier of the network that the node is on. + // + // Ethereum public networks have the following NetworkId s: + // // - n-ethereum-mainnet + // // - n-ethereum-goerli // // This member is required. @@ -42,8 +47,9 @@ type DeleteNodeInput struct { // This member is required. NodeId *string - // The unique identifier of the member that owns this node. Applies only to - // Hyperledger Fabric and is required for Hyperledger Fabric. + // The unique identifier of the member that owns this node. + // + // Applies only to Hyperledger Fabric and is required for Hyperledger Fabric. MemberId *string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_GetMember.go b/service/managedblockchain/api_op_GetMember.go index fa3f4306803..9ec80e768ca 100644 --- a/service/managedblockchain/api_op_GetMember.go +++ b/service/managedblockchain/api_op_GetMember.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns detailed information about a member. Applies only to Hyperledger Fabric. +// Returns detailed information about a member. +// +// Applies only to Hyperledger Fabric. func (c *Client) GetMember(ctx context.Context, params *GetMemberInput, optFns ...func(*Options)) (*GetMemberOutput, error) { if params == nil { params = &GetMemberInput{} diff --git a/service/managedblockchain/api_op_GetNetwork.go b/service/managedblockchain/api_op_GetNetwork.go index 1ce7ffa6e79..a893e0371ac 100644 --- a/service/managedblockchain/api_op_GetNetwork.go +++ b/service/managedblockchain/api_op_GetNetwork.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns detailed information about a network. Applies to Hyperledger Fabric and -// Ethereum. +// Returns detailed information about a network. +// +// Applies to Hyperledger Fabric and Ethereum. func (c *Client) GetNetwork(ctx context.Context, params *GetNetworkInput, optFns ...func(*Options)) (*GetNetworkOutput, error) { if params == nil { params = &GetNetworkInput{} diff --git a/service/managedblockchain/api_op_GetNode.go b/service/managedblockchain/api_op_GetNode.go index 8f81252956b..af95bd099ba 100644 --- a/service/managedblockchain/api_op_GetNode.go +++ b/service/managedblockchain/api_op_GetNode.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns detailed information about a node. Applies to Hyperledger Fabric and -// Ethereum. +// Returns detailed information about a node. +// +// Applies to Hyperledger Fabric and Ethereum. func (c *Client) GetNode(ctx context.Context, params *GetNodeInput, optFns ...func(*Options)) (*GetNodeOutput, error) { if params == nil { params = &GetNodeInput{} @@ -40,8 +41,9 @@ type GetNodeInput struct { // This member is required. NodeId *string - // The unique identifier of the member that owns the node. Applies only to - // Hyperledger Fabric and is required for Hyperledger Fabric. + // The unique identifier of the member that owns the node. + // + // Applies only to Hyperledger Fabric and is required for Hyperledger Fabric. MemberId *string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_GetProposal.go b/service/managedblockchain/api_op_GetProposal.go index a3433cb181f..ba57667c615 100644 --- a/service/managedblockchain/api_op_GetProposal.go +++ b/service/managedblockchain/api_op_GetProposal.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns detailed information about a proposal. Applies only to Hyperledger -// Fabric. +// Returns detailed information about a proposal. +// +// Applies only to Hyperledger Fabric. func (c *Client) GetProposal(ctx context.Context, params *GetProposalInput, optFns ...func(*Options)) (*GetProposalOutput, error) { if params == nil { params = &GetProposalInput{} diff --git a/service/managedblockchain/api_op_ListAccessors.go b/service/managedblockchain/api_op_ListAccessors.go index f4906b4b657..6b2495c49e7 100644 --- a/service/managedblockchain/api_op_ListAccessors.go +++ b/service/managedblockchain/api_op_ListAccessors.go @@ -31,15 +31,16 @@ func (c *Client) ListAccessors(ctx context.Context, params *ListAccessorsInput, type ListAccessorsInput struct { - // The maximum number of accessors to list. + // The maximum number of accessors to list. MaxResults *int32 - // The blockchain network that the Accessor token is created for. Use the value - // ETHEREUM_MAINNET_AND_GOERLI for all existing Accessors tokens that were created - // before the networkType property was introduced. + // The blockchain network that the Accessor token is created for. + // + // Use the value ETHEREUM_MAINNET_AND_GOERLI for all existing Accessors tokens + // that were created before the networkType property was introduced. NetworkType types.AccessorNetworkType - // The pagination token that indicates the next set of results to retrieve. + // The pagination token that indicates the next set of results to retrieve. NextToken *string noSmithyDocumentSerde @@ -51,7 +52,7 @@ type ListAccessorsOutput struct { // each accessor. Accessors []types.AccessorSummary - // The pagination token that indicates the next set of results to retrieve. + // The pagination token that indicates the next set of results to retrieve. NextToken *string // Metadata pertaining to the operation's result. @@ -145,7 +146,7 @@ var _ ListAccessorsAPIClient = (*Client)(nil) // ListAccessorsPaginatorOptions is the paginator options for ListAccessors type ListAccessorsPaginatorOptions struct { - // The maximum number of accessors to list. + // The maximum number of accessors to list. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchain/api_op_ListInvitations.go b/service/managedblockchain/api_op_ListInvitations.go index 10aca4068f6..98525669306 100644 --- a/service/managedblockchain/api_op_ListInvitations.go +++ b/service/managedblockchain/api_op_ListInvitations.go @@ -12,6 +12,7 @@ import ( ) // Returns a list of all invitations for the current Amazon Web Services account. +// // Applies only to Hyperledger Fabric. func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error) { if params == nil { diff --git a/service/managedblockchain/api_op_ListMembers.go b/service/managedblockchain/api_op_ListMembers.go index 166716d15d1..1626c6f8c00 100644 --- a/service/managedblockchain/api_op_ListMembers.go +++ b/service/managedblockchain/api_op_ListMembers.go @@ -12,7 +12,9 @@ import ( ) // Returns a list of the members in a network and properties of their -// configurations. Applies only to Hyperledger Fabric. +// configurations. +// +// Applies only to Hyperledger Fabric. func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error) { if params == nil { params = &ListMembersInput{} diff --git a/service/managedblockchain/api_op_ListNetworks.go b/service/managedblockchain/api_op_ListNetworks.go index c9751ded12e..d69d8421c5f 100644 --- a/service/managedblockchain/api_op_ListNetworks.go +++ b/service/managedblockchain/api_op_ListNetworks.go @@ -12,7 +12,9 @@ import ( ) // Returns information about the networks in which the current Amazon Web Services -// account participates. Applies to Hyperledger Fabric and Ethereum. +// account participates. +// +// Applies to Hyperledger Fabric and Ethereum. func (c *Client) ListNetworks(ctx context.Context, params *ListNetworksInput, optFns ...func(*Options)) (*ListNetworksOutput, error) { if params == nil { params = &ListNetworksInput{} @@ -44,7 +46,9 @@ type ListNetworksInput struct { NextToken *string // An optional status specifier. If provided, only networks currently in this - // status are listed. Applies only to Hyperledger Fabric. + // status are listed. + // + // Applies only to Hyperledger Fabric. Status types.NetworkStatus noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_ListNodes.go b/service/managedblockchain/api_op_ListNodes.go index 8f9d64dc62c..9c78ada002d 100644 --- a/service/managedblockchain/api_op_ListNodes.go +++ b/service/managedblockchain/api_op_ListNodes.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the nodes within a network. Applies to Hyperledger -// Fabric and Ethereum. +// Returns information about the nodes within a network. +// +// Applies to Hyperledger Fabric and Ethereum. func (c *Client) ListNodes(ctx context.Context, params *ListNodesInput, optFns ...func(*Options)) (*ListNodesOutput, error) { if params == nil { params = &ListNodesInput{} @@ -38,8 +39,9 @@ type ListNodesInput struct { // The maximum number of nodes to list. MaxResults *int32 - // The unique identifier of the member who owns the nodes to list. Applies only to - // Hyperledger Fabric and is required for Hyperledger Fabric. + // The unique identifier of the member who owns the nodes to list. + // + // Applies only to Hyperledger Fabric and is required for Hyperledger Fabric. MemberId *string // The pagination token that indicates the next set of results to retrieve. diff --git a/service/managedblockchain/api_op_ListProposalVotes.go b/service/managedblockchain/api_op_ListProposalVotes.go index 4375a0c7bba..8d0dea32a46 100644 --- a/service/managedblockchain/api_op_ListProposalVotes.go +++ b/service/managedblockchain/api_op_ListProposalVotes.go @@ -12,8 +12,9 @@ import ( ) // Returns the list of votes for a specified proposal, including the value of each -// vote and the unique identifier of the member that cast the vote. Applies only to -// Hyperledger Fabric. +// vote and the unique identifier of the member that cast the vote. +// +// Applies only to Hyperledger Fabric. func (c *Client) ListProposalVotes(ctx context.Context, params *ListProposalVotesInput, optFns ...func(*Options)) (*ListProposalVotesOutput, error) { if params == nil { params = &ListProposalVotesInput{} @@ -31,20 +32,20 @@ func (c *Client) ListProposalVotes(ctx context.Context, params *ListProposalVote type ListProposalVotesInput struct { - // The unique identifier of the network. + // The unique identifier of the network. // // This member is required. NetworkId *string - // The unique identifier of the proposal. + // The unique identifier of the proposal. // // This member is required. ProposalId *string - // The maximum number of votes to return. + // The maximum number of votes to return. MaxResults *int32 - // The pagination token that indicates the next set of results to retrieve. + // The pagination token that indicates the next set of results to retrieve. NextToken *string noSmithyDocumentSerde @@ -52,10 +53,10 @@ type ListProposalVotesInput struct { type ListProposalVotesOutput struct { - // The pagination token that indicates the next set of results to retrieve. + // The pagination token that indicates the next set of results to retrieve. NextToken *string - // The list of votes. + // The list of votes. ProposalVotes []types.VoteSummary // Metadata pertaining to the operation's result. @@ -153,7 +154,7 @@ var _ ListProposalVotesAPIClient = (*Client)(nil) // ListProposalVotesPaginatorOptions is the paginator options for ListProposalVotes type ListProposalVotesPaginatorOptions struct { - // The maximum number of votes to return. + // The maximum number of votes to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchain/api_op_ListProposals.go b/service/managedblockchain/api_op_ListProposals.go index dbf202547f0..5134a52be77 100644 --- a/service/managedblockchain/api_op_ListProposals.go +++ b/service/managedblockchain/api_op_ListProposals.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of proposals for the network. Applies only to Hyperledger Fabric. +// Returns a list of proposals for the network. +// +// Applies only to Hyperledger Fabric. func (c *Client) ListProposals(ctx context.Context, params *ListProposalsInput, optFns ...func(*Options)) (*ListProposalsOutput, error) { if params == nil { params = &ListProposalsInput{} @@ -29,15 +31,15 @@ func (c *Client) ListProposals(ctx context.Context, params *ListProposalsInput, type ListProposalsInput struct { - // The unique identifier of the network. + // The unique identifier of the network. // // This member is required. NetworkId *string - // The maximum number of proposals to return. + // The maximum number of proposals to return. MaxResults *int32 - // The pagination token that indicates the next set of results to retrieve. + // The pagination token that indicates the next set of results to retrieve. NextToken *string noSmithyDocumentSerde @@ -145,7 +147,7 @@ var _ ListProposalsAPIClient = (*Client)(nil) // ListProposalsPaginatorOptions is the paginator options for ListProposals type ListProposalsPaginatorOptions struct { - // The maximum number of proposals to return. + // The maximum number of proposals to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchain/api_op_ListTagsForResource.go b/service/managedblockchain/api_op_ListTagsForResource.go index 29db979d692..07e47ab3f5a 100644 --- a/service/managedblockchain/api_op_ListTagsForResource.go +++ b/service/managedblockchain/api_op_ListTagsForResource.go @@ -11,9 +11,13 @@ 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) -// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. +// and optional value. +// +// For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum +// Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric +// Developer Guide. +// +// [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -32,8 +36,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 - // 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/managedblockchain/api_op_RejectInvitation.go b/service/managedblockchain/api_op_RejectInvitation.go index e0c8fffd371..1736aa353fa 100644 --- a/service/managedblockchain/api_op_RejectInvitation.go +++ b/service/managedblockchain/api_op_RejectInvitation.go @@ -12,7 +12,9 @@ import ( // Rejects an invitation to join a network. This action can be called by a // principal in an Amazon Web Services account that has received an invitation to -// create a member and join a network. Applies only to Hyperledger Fabric. +// create a member and join a network. +// +// Applies only to Hyperledger Fabric. func (c *Client) RejectInvitation(ctx context.Context, params *RejectInvitationInput, optFns ...func(*Options)) (*RejectInvitationOutput, error) { if params == nil { params = &RejectInvitationInput{} diff --git a/service/managedblockchain/api_op_TagResource.go b/service/managedblockchain/api_op_TagResource.go index 71dbfd1cae8..83fb6e227ec 100644 --- a/service/managedblockchain/api_op_TagResource.go +++ b/service/managedblockchain/api_op_TagResource.go @@ -11,13 +11,19 @@ import ( ) // Adds or overwrites the specified tags for the specified Amazon Managed -// Blockchain resource. Each tag consists of a key and optional value. When you -// 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) -// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. +// Blockchain resource. Each tag consists of a key and optional value. +// +// When you 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] in the Amazon Managed Blockchain Ethereum +// Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric +// Developer Guide. +// +// [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -36,8 +42,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/managedblockchain/api_op_UntagResource.go b/service/managedblockchain/api_op_UntagResource.go index ad84db09484..f6075d2f962 100644 --- a/service/managedblockchain/api_op_UntagResource.go +++ b/service/managedblockchain/api_op_UntagResource.go @@ -10,10 +10,13 @@ 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) -// in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. +// Removes the specified tags from the Amazon Managed Blockchain resource. +// +// For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum +// Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric +// Developer Guide. +// +// [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -32,8 +35,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/managedblockchain/api_op_UpdateMember.go b/service/managedblockchain/api_op_UpdateMember.go index 087d2e944da..6964d59a4bc 100644 --- a/service/managedblockchain/api_op_UpdateMember.go +++ b/service/managedblockchain/api_op_UpdateMember.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a member configuration with new parameters. Applies only to Hyperledger -// Fabric. +// Updates a member configuration with new parameters. +// +// Applies only to Hyperledger Fabric. func (c *Client) UpdateMember(ctx context.Context, params *UpdateMemberInput, optFns ...func(*Options)) (*UpdateMemberOutput, error) { if params == nil { params = &UpdateMemberInput{} diff --git a/service/managedblockchain/api_op_UpdateNode.go b/service/managedblockchain/api_op_UpdateNode.go index f44e86cfe10..6932b24e1dd 100644 --- a/service/managedblockchain/api_op_UpdateNode.go +++ b/service/managedblockchain/api_op_UpdateNode.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a node configuration with new parameters. Applies only to Hyperledger -// Fabric. +// Updates a node configuration with new parameters. +// +// Applies only to Hyperledger Fabric. func (c *Client) UpdateNode(ctx context.Context, params *UpdateNodeInput, optFns ...func(*Options)) (*UpdateNodeOutput, error) { if params == nil { params = &UpdateNodeInput{} @@ -43,8 +44,9 @@ type UpdateNodeInput struct { // Configuration properties for publishing to Amazon CloudWatch Logs. LogPublishingConfiguration *types.NodeLogPublishingConfiguration - // The unique identifier of the member that owns the node. Applies only to - // Hyperledger Fabric. + // The unique identifier of the member that owns the node. + // + // Applies only to Hyperledger Fabric. MemberId *string noSmithyDocumentSerde diff --git a/service/managedblockchain/api_op_VoteOnProposal.go b/service/managedblockchain/api_op_VoteOnProposal.go index 969a8f06921..df8a2ecb8c1 100644 --- a/service/managedblockchain/api_op_VoteOnProposal.go +++ b/service/managedblockchain/api_op_VoteOnProposal.go @@ -13,8 +13,9 @@ 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 -// account as the principal that calls the action. Applies only to Hyperledger -// Fabric. +// 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) { if params == nil { params = &VoteOnProposalInput{} @@ -32,17 +33,17 @@ func (c *Client) VoteOnProposal(ctx context.Context, params *VoteOnProposalInput type VoteOnProposalInput struct { - // The unique identifier of the network. + // The unique identifier of the network. // // This member is required. NetworkId *string - // The unique identifier of the proposal. + // The unique identifier of the proposal. // // This member is required. ProposalId *string - // The value of the vote. + // The value of the vote. // // This member is required. Vote types.VoteValue diff --git a/service/managedblockchain/doc.go b/service/managedblockchain/doc.go index 80c7a742b73..98c5cd881b1 100644 --- a/service/managedblockchain/doc.go +++ b/service/managedblockchain/doc.go @@ -7,12 +7,14 @@ // blockchain networks using open-source frameworks. Blockchain allows you to build // applications where multiple parties can securely and transparently run // transactions and share data without the need for a trusted, central authority. +// // Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source // frameworks. Because of fundamental differences between the frameworks, some API // actions or data types may only apply in the context of one framework and not the // other. For example, actions related to Hyperledger Fabric network members such -// as CreateMember and DeleteMember don't apply to Ethereum. The description for -// each action indicates the framework or frameworks to which it applies. Data -// types and properties that apply only in the context of a particular framework -// are similarly indicated. +// as CreateMember and DeleteMember don't apply to Ethereum. +// +// The description for each action indicates the framework or frameworks to which +// it applies. Data types and properties that apply only in the context of a +// particular framework are similarly indicated. package managedblockchain diff --git a/service/managedblockchain/options.go b/service/managedblockchain/options.go index d6b01206e49..1bbe413213d 100644 --- a/service/managedblockchain/options.go +++ b/service/managedblockchain/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/managedblockchain/types/enums.go b/service/managedblockchain/types/enums.go index 87f0190c8e0..5cfc9caea0d 100644 --- a/service/managedblockchain/types/enums.go +++ b/service/managedblockchain/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AccessorNetworkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessorNetworkType) Values() []AccessorNetworkType { return []AccessorNetworkType{ "ETHEREUM_GOERLI", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for AccessorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessorStatus) Values() []AccessorStatus { return []AccessorStatus{ "AVAILABLE", @@ -54,8 +56,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for Edition. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Edition) Values() []Edition { return []Edition{ "STARTER", @@ -89,8 +93,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -110,8 +115,9 @@ const ( ) // Values returns all known values for InvitationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvitationStatus) Values() []InvitationStatus { return []InvitationStatus{ "PENDING", @@ -136,8 +142,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -162,8 +169,9 @@ const ( ) // Values returns all known values for NetworkStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkStatus) Values() []NetworkStatus { return []NetworkStatus{ "CREATING", @@ -190,8 +198,9 @@ const ( ) // Values returns all known values for NodeStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeStatus) Values() []NodeStatus { return []NodeStatus{ "CREATING", @@ -218,8 +227,9 @@ const ( ) // Values returns all known values for ProposalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProposalStatus) Values() []ProposalStatus { return []ProposalStatus{ "IN_PROGRESS", @@ -239,8 +249,9 @@ const ( ) // Values returns all known values for StateDBType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StateDBType) Values() []StateDBType { return []StateDBType{ "LevelDB", @@ -257,8 +268,9 @@ const ( ) // Values returns all known values for ThresholdComparator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThresholdComparator) Values() []ThresholdComparator { return []ThresholdComparator{ "GREATER_THAN", @@ -275,8 +287,9 @@ const ( ) // 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. +// in the future, and so 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/types.go b/service/managedblockchain/types/types.go index 9b6d048f071..901da4c70b9 100644 --- a/service/managedblockchain/types/types.go +++ b/service/managedblockchain/types/types.go @@ -11,8 +11,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The billing token is a property of the Accessor. Use this token to when making @@ -32,14 +33,18 @@ type Accessor struct { // The current status of the accessor. 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // The tags assigned to the Accessor. + // + // For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html 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,8 +54,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The creation date and time of the accessor. @@ -65,8 +71,9 @@ 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 @@ -75,8 +82,9 @@ type AccessorSummary struct { // 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. +// all proposals and is specified when the network is created. +// +// Applies only to Hyperledger Fabric. type ApprovalThresholdPolicy struct { // The duration from the time that a proposal is created until it expires. If @@ -102,12 +110,15 @@ type ApprovalThresholdPolicy struct { } // An invitation to an Amazon Web Services account to create a member and join the -// network. Applies only to Hyperledger Fabric. +// network. +// +// Applies only to Hyperledger Fabric. 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time that the invitation was created. @@ -126,13 +137,18 @@ 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 . Status InvitationStatus @@ -142,7 +158,9 @@ 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. @@ -171,12 +189,15 @@ type LogConfigurations struct { noSmithyDocumentSerde } -// Member configuration properties. Applies only to Hyperledger Fabric. +// Member configuration properties. +// +// Applies only to Hyperledger Fabric. 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time that the member was created. @@ -196,8 +217,12 @@ type Member struct { // 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 // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // member owns. + // + // For more information, see [Encryption at Rest] in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Encryption at Rest]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html KmsKeyArn *string // Configuration properties for logging events associated with a member. @@ -210,39 +235,53 @@ 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 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. + // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // Tags assigned to the member. Tags consist of a key and optional value. + // + // For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde } -// Configuration properties of the member. Applies only to Hyperledger Fabric. +// Configuration properties of the member. +// +// Applies only to Hyperledger Fabric. type MemberConfiguration struct { // Configuration properties of the blockchain framework relevant to the member. @@ -260,31 +299,41 @@ 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Use one of - // the following options to specify this parameter: + // inherited by any nodes that this member creates. For more information, see [Encryption at Rest]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: + // 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]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 + // + // [Using symmetric and asymmetric keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + // [Encryption at Rest]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html KmsKeyArn *string // Configuration properties for logging events associated with a member of a // Managed Blockchain network. LogPublishingConfiguration *MemberLogPublishingConfiguration - // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // 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] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde @@ -369,13 +418,15 @@ type MemberLogPublishingConfiguration struct { noSmithyDocumentSerde } -// A summary of configuration properties for a member. Applies only to Hyperledger -// Fabric. +// A summary of configuration properties for a member. +// +// Applies only to Hyperledger Fabric. 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time that the member was created. @@ -395,27 +446,36 @@ 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 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. + // 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 @@ -425,8 +485,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time that the network was created. @@ -454,9 +515,12 @@ type Network struct { 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // + // For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string // The voting rules that the network uses to decide if a proposal is accepted. @@ -475,7 +539,9 @@ type NetworkEthereumAttributes struct { // The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as // follows: + // // - mainnet = 1 + // // - goerli = 5 ChainId *string @@ -486,8 +552,9 @@ 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]. + // + // [Amazon Managed Blockchain Pricing]: http://aws.amazon.com/managed-blockchain/pricing/ Edition Edition // The endpoint of the ordering service for the network. @@ -500,8 +567,9 @@ 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]. + // + // [Amazon Managed Blockchain Pricing]: http://aws.amazon.com/managed-blockchain/pricing/ // // This member is required. Edition Edition @@ -524,11 +592,12 @@ type NetworkFrameworkAttributes struct { noSmithyDocumentSerde } -// Configuration properties relevant to the network for the blockchain framework +// Configuration properties relevant to the network for the blockchain framework +// // that the network uses. type NetworkFrameworkConfiguration struct { - // Hyperledger Fabric configuration properties for a Managed Blockchain network + // Hyperledger Fabric configuration properties for a Managed Blockchain network // that uses Hyperledger Fabric. Fabric *NetworkFabricConfiguration @@ -539,8 +608,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time that the network was created. @@ -571,8 +641,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The Availability Zone in which the node exists. Required for Ethereum nodes. @@ -594,54 +665,75 @@ type Node struct { // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Applies - // only to Hyperledger Fabric. + // belongs to. + // + // For more information, see [Encryption at Rest] in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // Applies only to Hyperledger Fabric. + // + // [Encryption at Rest]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html KmsKeyArn *string // Configuration properties for logging events associated with a peer node on a // Hyperledger Fabric network on Managed Blockchain. LogPublishingConfiguration *NodeLogPublishingConfiguration - // The unique identifier of the member to which the node belongs. Applies only to - // Hyperledger Fabric. + // The unique identifier of the member to which the node belongs. + // + // Applies only to Hyperledger Fabric. MemberId *string // 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 - // only to Hyperledger Fabric. + // 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. + // 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // Tags assigned to the node. Each tag consists of a key and optional value. + // + // For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string noSmithyDocumentSerde @@ -664,7 +756,9 @@ type NodeConfiguration struct { // 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. + // or later, the default is CouchDB . + // + // Applies only to Hyperledger Fabric. StateDB StateDBType noSmithyDocumentSerde @@ -676,15 +770,17 @@ 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 // 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]. + // + // [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) - // . + // endpoint are authenticated using [Signature Version 4]. + // + // [Signature Version 4]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html WebSocketEndpoint *string noSmithyDocumentSerde @@ -756,8 +852,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The Availability Zone in which the node exists. @@ -778,25 +875,27 @@ type NodeSummary struct { noSmithyDocumentSerde } -// Properties of a proposal on a Managed Blockchain network. Applies only to -// Hyperledger Fabric. +// Properties of a proposal on a Managed Blockchain network. +// +// Applies only to Hyperledger Fabric. type Proposal struct { // 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string - // The date and time that the proposal was created. + // The date and time that the proposal was created. CreationDate *time.Time // The description of the proposal. Description *string - // The date and time that the proposal expires. This is the CreationDate plus the + // The date and time that the proposal expires. This is the CreationDate plus the // 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 @@ -806,10 +905,10 @@ type Proposal struct { // The unique identifier of the network for which the proposal is made. NetworkId *string - // The current total of NO votes cast on the proposal by members. + // The current total of NO votes cast on the proposal by members. NoVoteCount *int32 - // The number of votes remaining to be cast on the proposal by members. In other + // The number of votes remaining to be cast on the proposal by members. In other // words, the number of members minus the sum of YES votes and NO votes. OutstandingVoteCount *int32 @@ -823,16 +922,21 @@ 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 @@ -840,26 +944,30 @@ type Proposal struct { 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) - // in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide. + // + // For more information about tags, see [Tagging Resources] in the Amazon Managed Blockchain Ethereum + // Developer Guide, or [Tagging Resources]in the Amazon Managed Blockchain Hyperledger Fabric + // Developer Guide. + // + // [Tagging Resources]: https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html Tags map[string]string - // The current total of YES votes cast on the proposal by members. + // The current total of YES votes cast on the proposal by members. YesVoteCount *int32 noSmithyDocumentSerde } -// The actions to carry out if a proposal is APPROVED . Applies only to Hyperledger -// Fabric. +// 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 + // 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 + // The actions to perform for an APPROVED proposal to remove a member from the // network, which deletes the member and all associated member resources from the // network. Removals []RemoveAction @@ -867,47 +975,55 @@ type ProposalActions struct { noSmithyDocumentSerde } -// Properties of a proposal. Applies only to Hyperledger Fabric. +// Properties of a proposal. +// +// Applies only to Hyperledger Fabric. 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string - // The date and time that the proposal was created. + // The date and time that the proposal was created. CreationDate *time.Time - // The description of the proposal. + // The description of the proposal. Description *string - // The date and time that the proposal expires. This is the CreationDate plus the + // The date and time that the proposal expires. This is the CreationDate plus the // 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. ExpirationDate *time.Time - // The unique identifier of the proposal. + // The unique identifier of the proposal. ProposalId *string - // The unique identifier of the member that created the proposal. + // The unique identifier of the member that created the proposal. ProposedByMemberId *string - // The name of the member that created the proposal. + // The name of the member that created the proposal. 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. Status ProposalStatus @@ -917,7 +1033,9 @@ type ProposalSummary struct { // 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. +// are deleted from the network. +// +// Applies only to Hyperledger Fabric. type RemoveAction struct { // The unique identifier of the member to remove. @@ -928,24 +1046,26 @@ 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. + // The unique identifier of the member that cast the vote. MemberId *string - // The name of the member that cast the vote. + // 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 } -// The voting rules for the network to decide if a proposal is accepted Applies -// only to Hyperledger Fabric. +// The voting rules for the network to decide if a proposal is accepted +// +// Applies only to Hyperledger Fabric. type VotingPolicy struct { // Defines the rules for the network for voting on proposals, such as the diff --git a/service/managedblockchainquery/api_op_BatchGetTokenBalance.go b/service/managedblockchainquery/api_op_BatchGetTokenBalance.go index 335bd814ebc..e03ca26b135 100644 --- a/service/managedblockchainquery/api_op_BatchGetTokenBalance.go +++ b/service/managedblockchainquery/api_op_BatchGetTokenBalance.go @@ -12,8 +12,10 @@ import ( ) // Gets the token balance for a batch of tokens by using the BatchGetTokenBalance -// action for every token in the request. Only the native tokens BTC and ETH, and -// the ERC-20, ERC-721, and ERC 1155 token standards are supported. +// action for every token in the request. +// +// Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token +// standards are supported. func (c *Client) BatchGetTokenBalance(ctx context.Context, params *BatchGetTokenBalanceInput, optFns ...func(*Options)) (*BatchGetTokenBalanceOutput, error) { if params == nil { params = &BatchGetTokenBalanceInput{} diff --git a/service/managedblockchainquery/api_op_GetAssetContract.go b/service/managedblockchainquery/api_op_GetAssetContract.go index 2eb8c1d2e2b..b6aeb39235c 100644 --- a/service/managedblockchainquery/api_op_GetAssetContract.go +++ b/service/managedblockchainquery/api_op_GetAssetContract.go @@ -12,7 +12,9 @@ import ( ) // Gets the information about a specific contract deployed on the blockchain. +// // - The Bitcoin blockchain networks do not support this operation. +// // - Metadata is currently only available for some ERC-20 contracts. Metadata // will be available for additional contracts in the future. func (c *Client) GetAssetContract(ctx context.Context, params *GetAssetContractInput, optFns ...func(*Options)) (*GetAssetContractOutput, error) { diff --git a/service/managedblockchainquery/api_op_GetTokenBalance.go b/service/managedblockchainquery/api_op_GetTokenBalance.go index dae5ef05ca5..af773129670 100644 --- a/service/managedblockchainquery/api_op_GetTokenBalance.go +++ b/service/managedblockchainquery/api_op_GetTokenBalance.go @@ -12,8 +12,10 @@ import ( ) // Gets the balance of a specific token, including native tokens, for a given -// address (wallet or contract) on the blockchain. Only the native tokens BTC and -// ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported. +// address (wallet or contract) on the blockchain. +// +// Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token +// standards are supported. func (c *Client) GetTokenBalance(ctx context.Context, params *GetTokenBalanceInput, optFns ...func(*Options)) (*GetTokenBalanceOutput, error) { if params == nil { params = &GetTokenBalanceInput{} @@ -43,8 +45,9 @@ type GetTokenBalanceInput struct { TokenIdentifier *types.TokenIdentifier // The time for when the TokenBalance is requested or the current time if a time - // is not provided in the request. This time will only be recorded up to the - // second. + // is not provided in the request. + // + // This time will only be recorded up to the second. AtBlockchainInstant *types.BlockchainInstant noSmithyDocumentSerde @@ -69,8 +72,10 @@ type GetTokenBalanceOutput struct { OwnerIdentifier *types.OwnerIdentifier // The container for the identifier for the token including the unique token ID - // and its blockchain network. Only the native tokens BTC and ETH, and the ERC-20, - // ERC-721, and ERC 1155 token standards are supported. + // and its blockchain network. + // + // Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token + // standards are supported. TokenIdentifier *types.TokenIdentifier // Metadata pertaining to the operation's result. diff --git a/service/managedblockchainquery/api_op_GetTransaction.go b/service/managedblockchainquery/api_op_GetTransaction.go index c4eb62460fc..62f400c8e50 100644 --- a/service/managedblockchainquery/api_op_GetTransaction.go +++ b/service/managedblockchainquery/api_op_GetTransaction.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the details of a transaction. This action will return transaction details -// for all transactions that are confirmed on the blockchain, even if they have not -// reached finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) -// . +// Gets the details of a transaction. +// +// This action will return transaction details for all transactions that are +// confirmed on the blockchain, even if they have not reached [finality]. +// +// [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality func (c *Client) GetTransaction(ctx context.Context, params *GetTransactionInput, optFns ...func(*Options)) (*GetTransactionOutput, error) { if params == nil { params = &GetTransactionInput{} @@ -41,7 +43,9 @@ type GetTransactionInput struct { TransactionHash *string // The identifier of a Bitcoin transaction. It is generated when a transaction is - // created. transactionId is only supported on the Bitcoin networks. + // created. + // + // transactionId is only supported on the Bitcoin networks. TransactionId *string noSmithyDocumentSerde diff --git a/service/managedblockchainquery/api_op_ListAssetContracts.go b/service/managedblockchainquery/api_op_ListAssetContracts.go index 220123147a2..9655897c0a1 100644 --- a/service/managedblockchainquery/api_op_ListAssetContracts.go +++ b/service/managedblockchainquery/api_op_ListAssetContracts.go @@ -12,8 +12,9 @@ import ( ) // Lists all the contracts for a given contract type deployed by an address -// (either a contract address or a wallet address). The Bitcoin blockchain networks -// do not support this operation. +// (either a contract address or a wallet address). +// +// The Bitcoin blockchain networks do not support this operation. func (c *Client) ListAssetContracts(ctx context.Context, params *ListAssetContractsInput, optFns ...func(*Options)) (*ListAssetContractsOutput, error) { if params == nil { params = &ListAssetContractsInput{} @@ -36,14 +37,19 @@ type ListAssetContractsInput struct { // This member is required. ContractFilter *types.ContractFilter - // The maximum number of contracts to list. Default: 100 Even if additional - // results can be retrieved, the request can return less results than maxResults - // or an empty array of results. To retrieve the next set of results, make another - // request with the returned nextToken value. The value of nextToken is null when - // there are no more results to return + // The maximum number of contracts to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return MaxResults *int32 - // The pagination token that indicates the next set of results to retrieve. + // The pagination token that indicates the next set of results to retrieve. NextToken *string noSmithyDocumentSerde @@ -155,11 +161,16 @@ var _ ListAssetContractsAPIClient = (*Client)(nil) // ListAssetContractsPaginatorOptions is the paginator options for // ListAssetContracts type ListAssetContractsPaginatorOptions struct { - // The maximum number of contracts to list. Default: 100 Even if additional - // results can be retrieved, the request can return less results than maxResults - // or an empty array of results. To retrieve the next set of results, make another - // request with the returned nextToken value. The value of nextToken is null when - // there are no more results to return + // The maximum number of contracts to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchainquery/api_op_ListFilteredTransactionEvents.go b/service/managedblockchainquery/api_op_ListFilteredTransactionEvents.go index b86bc99a732..db91995cf4b 100644 --- a/service/managedblockchainquery/api_op_ListFilteredTransactionEvents.go +++ b/service/managedblockchainquery/api_op_ListFilteredTransactionEvents.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the transaction events for an address on the blockchain. This -// operation is only supported on the Bitcoin networks. +// Lists all the transaction events for an address on the blockchain. +// +// This operation is only supported on the Bitcoin networks. func (c *Client) ListFilteredTransactionEvents(ctx context.Context, params *ListFilteredTransactionEventsInput, optFns ...func(*Options)) (*ListFilteredTransactionEventsOutput, error) { if params == nil { params = &ListFilteredTransactionEventsInput{} @@ -36,21 +37,29 @@ type ListFilteredTransactionEventsInput struct { // This member is required. AddressIdentifierFilter *types.AddressIdentifierFilter - // The blockchain network where the transaction occurred. Valid Values: - // BITCOIN_MAINNET | BITCOIN_TESTNET + // The blockchain network where the transaction occurred. + // + // Valid Values: BITCOIN_MAINNET | BITCOIN_TESTNET // // This member is required. Network *string - // The container for the ConfirmationStatusFilter that filters for the finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) - // of the results. + // The container for the ConfirmationStatusFilter that filters for the [finality] of the + // results. + // + // [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality ConfirmationStatusFilter *types.ConfirmationStatusFilter - // The maximum number of transaction events to list. Default: 100 Even if - // additional results can be retrieved, the request can return less results than - // maxResults or an empty array of results. To retrieve the next set of results, - // make another request with the returned nextToken value. The value of nextToken - // is null when there are no more results to return + // The maximum number of transaction events to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return MaxResults *int32 // The pagination token that indicates the next set of results to retrieve. @@ -176,11 +185,16 @@ var _ ListFilteredTransactionEventsAPIClient = (*Client)(nil) // ListFilteredTransactionEventsPaginatorOptions is the paginator options for // ListFilteredTransactionEvents type ListFilteredTransactionEventsPaginatorOptions struct { - // The maximum number of transaction events to list. Default: 100 Even if - // additional results can be retrieved, the request can return less results than - // maxResults or an empty array of results. To retrieve the next set of results, - // make another request with the returned nextToken value. The value of nextToken - // is null when there are no more results to return + // The maximum number of transaction events to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchainquery/api_op_ListTokenBalances.go b/service/managedblockchainquery/api_op_ListTokenBalances.go index 56d544bbb71..ccd12a3b23a 100644 --- a/service/managedblockchainquery/api_op_ListTokenBalances.go +++ b/service/managedblockchainquery/api_op_ListTokenBalances.go @@ -12,9 +12,12 @@ import ( ) // This action returns the following for a given blockchain network: +// // - Lists all token balances owned by an address (either a contract address or // a wallet address). +// // - Lists all token balances for all tokens created by a contract. +// // - Lists all token balances for a given token. // // You must always specify the network property of the tokenFilter when using this @@ -38,17 +41,24 @@ type ListTokenBalancesInput struct { // The contract address or a token identifier on the blockchain network by which // to filter the request. You must specify the contractAddress property of this - // container when listing tokens minted by a contract. You must always specify the - // network property of this container when using this operation. + // container when listing tokens minted by a contract. + // + // You must always specify the network property of this container when using this + // operation. // // This member is required. TokenFilter *types.TokenFilter - // The maximum number of token balances to return. Default: 100 Even if additional - // results can be retrieved, the request can return less results than maxResults - // or an empty array of results. To retrieve the next set of results, make another - // request with the returned nextToken value. The value of nextToken is null when - // there are no more results to return + // The maximum number of token balances to return. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return MaxResults *int32 // The pagination token that indicates the next set of results to retrieve. @@ -168,11 +178,16 @@ var _ ListTokenBalancesAPIClient = (*Client)(nil) // ListTokenBalancesPaginatorOptions is the paginator options for ListTokenBalances type ListTokenBalancesPaginatorOptions struct { - // The maximum number of token balances to return. Default: 100 Even if additional - // results can be retrieved, the request can return less results than maxResults - // or an empty array of results. To retrieve the next set of results, make another - // request with the returned nextToken value. The value of nextToken is null when - // there are no more results to return + // The maximum number of token balances to return. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchainquery/api_op_ListTransactionEvents.go b/service/managedblockchainquery/api_op_ListTransactionEvents.go index 6ff5cad4eac..5266409cc3c 100644 --- a/service/managedblockchainquery/api_op_ListTransactionEvents.go +++ b/service/managedblockchainquery/api_op_ListTransactionEvents.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the transaction events for a transaction This action will return -// transaction details for all transactions that are confirmed on the blockchain, -// even if they have not reached finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) -// . +// Lists all the transaction events for a transaction +// +// This action will return transaction details for all transactions that are +// confirmed on the blockchain, even if they have not reached [finality]. +// +// [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality func (c *Client) ListTransactionEvents(ctx context.Context, params *ListTransactionEventsInput, optFns ...func(*Options)) (*ListTransactionEventsOutput, error) { if params == nil { params = &ListTransactionEventsInput{} @@ -37,11 +39,16 @@ type ListTransactionEventsInput struct { // This member is required. Network types.QueryNetwork - // The maximum number of transaction events to list. Default: 100 Even if - // additional results can be retrieved, the request can return less results than - // maxResults or an empty array of results. To retrieve the next set of results, - // make another request with the returned nextToken value. The value of nextToken - // is null when there are no more results to return + // The maximum number of transaction events to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return MaxResults *int32 // The pagination token that indicates the next set of results to retrieve. @@ -51,7 +58,9 @@ type ListTransactionEventsInput struct { TransactionHash *string // The identifier of a Bitcoin transaction. It is generated when a transaction is - // created. transactionId is only supported on the Bitcoin networks. + // created. + // + // transactionId is only supported on the Bitcoin networks. TransactionId *string noSmithyDocumentSerde @@ -164,11 +173,16 @@ var _ ListTransactionEventsAPIClient = (*Client)(nil) // ListTransactionEventsPaginatorOptions is the paginator options for // ListTransactionEvents type ListTransactionEventsPaginatorOptions struct { - // The maximum number of transaction events to list. Default: 100 Even if - // additional results can be retrieved, the request can return less results than - // maxResults or an empty array of results. To retrieve the next set of results, - // make another request with the returned nextToken value. The value of nextToken - // is null when there are no more results to return + // The maximum number of transaction events to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchainquery/api_op_ListTransactions.go b/service/managedblockchainquery/api_op_ListTransactions.go index 3093a0aa983..b2436649d9e 100644 --- a/service/managedblockchainquery/api_op_ListTransactions.go +++ b/service/managedblockchainquery/api_op_ListTransactions.go @@ -41,18 +41,25 @@ type ListTransactionsInput struct { Network types.QueryNetwork // This filter is used to include transactions in the response that haven't - // reached finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) - // . Transactions that have reached finality are always part of the response. + // reached [finality]. Transactions that have reached finality are always part of the + // response. + // + // [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality ConfirmationStatusFilter *types.ConfirmationStatusFilter // The container for time. FromBlockchainInstant *types.BlockchainInstant - // The maximum number of transactions to list. Default: 100 Even if additional - // results can be retrieved, the request can return less results than maxResults - // or an empty array of results. To retrieve the next set of results, make another - // request with the returned nextToken value. The value of nextToken is null when - // there are no more results to return + // The maximum number of transactions to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return MaxResults *int32 // The pagination token that indicates the next set of results to retrieve. @@ -172,11 +179,16 @@ var _ ListTransactionsAPIClient = (*Client)(nil) // ListTransactionsPaginatorOptions is the paginator options for ListTransactions type ListTransactionsPaginatorOptions struct { - // The maximum number of transactions to list. Default: 100 Even if additional - // results can be retrieved, the request can return less results than maxResults - // or an empty array of results. To retrieve the next set of results, make another - // request with the returned nextToken value. The value of nextToken is null when - // there are no more results to return + // The maximum number of transactions to list. + // + // Default: 100 + // + // Even if additional results can be retrieved, the request can return less + // results than maxResults or an empty array of results. + // + // To retrieve the next set of results, make another request with the returned + // nextToken value. The value of nextToken is null when there are no more results + // to return Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/managedblockchainquery/options.go b/service/managedblockchainquery/options.go index 8738f17a254..361e8a445c5 100644 --- a/service/managedblockchainquery/options.go +++ b/service/managedblockchainquery/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/managedblockchainquery/types/enums.go b/service/managedblockchainquery/types/enums.go index d1f80fe3bdd..d75acfbf6cc 100644 --- a/service/managedblockchainquery/types/enums.go +++ b/service/managedblockchainquery/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ConfirmationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfirmationStatus) Values() []ConfirmationStatus { return []ConfirmationStatus{ "FINAL", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ErrorType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ErrorType) Values() []ErrorType { return []ErrorType{ "VALIDATION_EXCEPTION", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "FAILED", @@ -68,8 +71,9 @@ const ( // Values returns all known values for ListFilteredTransactionEventsSortBy. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListFilteredTransactionEventsSortBy) Values() []ListFilteredTransactionEventsSortBy { return []ListFilteredTransactionEventsSortBy{ "blockchainInstant", @@ -85,8 +89,9 @@ const ( ) // Values returns all known values for ListTransactionsSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListTransactionsSortBy) Values() []ListTransactionsSortBy { return []ListTransactionsSortBy{ "TRANSACTION_TIMESTAMP", @@ -108,8 +113,9 @@ const ( ) // Values returns all known values for QueryNetwork. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryNetwork) Values() []QueryNetwork { return []QueryNetwork{ "ETHEREUM_MAINNET", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for QueryTokenStandard. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryTokenStandard) Values() []QueryTokenStandard { return []QueryTokenStandard{ "ERC20", @@ -169,6 +176,7 @@ const ( // Values returns all known values for QueryTransactionEventType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (QueryTransactionEventType) Values() []QueryTransactionEventType { return []QueryTransactionEventType{ @@ -194,8 +202,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "collection", @@ -213,8 +222,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -234,6 +244,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/managedblockchainquery/types/types.go b/service/managedblockchainquery/types/types.go index 1bc770af021..05e70a1776c 100644 --- a/service/managedblockchainquery/types/types.go +++ b/service/managedblockchainquery/types/types.go @@ -65,8 +65,10 @@ type BatchGetTokenBalanceErrorItem struct { OwnerIdentifier *OwnerIdentifier // The container for the identifier for the token including the unique token ID - // and its blockchain network. Only the native tokens BTC and ETH, and the ERC-20, - // ERC-721, and ERC 1155 token standards are supported. + // and its blockchain network. + // + // Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token + // standards are supported. TokenIdentifier *TokenIdentifier noSmithyDocumentSerde @@ -81,8 +83,10 @@ type BatchGetTokenBalanceInputItem struct { OwnerIdentifier *OwnerIdentifier // The container for the identifier for the token including the unique token ID - // and its blockchain network. Only the native tokens BTC and ETH, and the ERC-20, - // ERC-721, and ERC 1155 token standards are supported. + // and its blockchain network. + // + // Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token + // standards are supported. // // This member is required. TokenIdentifier *TokenIdentifier @@ -113,8 +117,10 @@ type BatchGetTokenBalanceOutputItem struct { OwnerIdentifier *OwnerIdentifier // The container for the identifier for the token including the unique token ID - // and its blockchain network. Only the native tokens BTC and ETH, and the ERC-20, - // ERC-721, and ERC 1155 token standards are supported. + // and its blockchain network. + // + // Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token + // standards are supported. TokenIdentifier *TokenIdentifier noSmithyDocumentSerde @@ -123,20 +129,24 @@ type BatchGetTokenBalanceOutputItem struct { // The container for time. type BlockchainInstant struct { - // The container of the Timestamp of the blockchain instant. This timestamp will - // only be recorded up to the second. + // The container of the Timestamp of the blockchain instant. + // + // This timestamp will only be recorded up to the second. Time *time.Time noSmithyDocumentSerde } -// The container for the ConfirmationStatusFilter that filters for the finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) -// of the results. +// The container for the ConfirmationStatusFilter that filters for the [finality] of the +// results. +// +// [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality type ConfirmationStatusFilter struct { - // The container to determine whether to list results that have only reached - // finality (https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality) - // . Transactions that have reached finality are always part of the response. + // The container to determine whether to list results that have only reached [finality]. + // Transactions that have reached finality are always part of the response. + // + // [finality]: https://docs.aws.amazon.com/managed-blockchain/latest/ambq-dg/key-concepts.html#finality // // This member is required. Include []ConfirmationStatus @@ -196,8 +206,9 @@ type ContractMetadata struct { noSmithyDocumentSerde } -// Lists all the transaction events for an address on the blockchain. This -// operation is only supported on the Bitcoin blockchain networks. +// Lists all the transaction events for an address on the blockchain. +// +// This operation is only supported on the Bitcoin blockchain networks. type ListFilteredTransactionEventsSort struct { // Container on how the results will be sorted by? @@ -263,8 +274,9 @@ type TimeFilter struct { type TokenBalance struct { // The time for when the TokenBalance is requested or the current time if a time - // is not provided in the request. This time will only be recorded up to the - // second. + // is not provided in the request. + // + // This time will only be recorded up to the second. // // This member is required. AtBlockchainInstant *BlockchainInstant @@ -290,6 +302,7 @@ type TokenBalance struct { // The container of the token filter like the contract address on a given // blockchain network or a unique token identifier on a given blockchain network. +// // You must always specify the network property of this container when using this // operation. type TokenFilter struct { @@ -309,8 +322,10 @@ type TokenFilter struct { } // The container for the identifier for the token including the unique token ID -// and its blockchain network. Only the native tokens BTC and ETH, and the ERC-20, -// ERC-721, and ERC 1155 token standards are supported. +// and its blockchain network. +// +// Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token +// standards are supported. type TokenIdentifier struct { // The blockchain network of the token. @@ -321,17 +336,21 @@ type TokenIdentifier struct { // This is the token's contract address. ContractAddress *string - // The unique identifier of the token. For native tokens, use the 3 character - // abbreviation that best matches your token. For example, btc for Bitcoin, eth for - // Ether, etc. For all other token types you must specify the tokenId in the 64 - // character hexadecimal tokenid format. + // The unique identifier of the token. + // + // For native tokens, use the 3 character abbreviation that best matches your + // token. For example, btc for Bitcoin, eth for Ether, etc. For all other token + // types you must specify the tokenId in the 64 character hexadecimal tokenid + // format. TokenId *string noSmithyDocumentSerde } // There are two possible types of transactions used for this data type: +// // - A Bitcoin transaction is a movement of BTC from one address to another. +// // - An Ethereum transaction refers to an action initiated by an externally // owned account, which is an account managed by a human, not a contract. For // example, if Bob sends Alice 1 ETH, Bob's account must be debited and Alice's @@ -450,15 +469,19 @@ type TransactionEvent struct { From *string // The position of the spent transaction output in the output list of the creating - // transaction. This is only returned for BITCOIN_VIN event types. + // transaction. + // + // This is only returned for BITCOIN_VIN event types. SpentVoutIndex *int32 - // The transactionHash that created the spent transaction output. This is only - // returned for BITCOIN_VIN event types. + // The transactionHash that created the spent transaction output. + // + // This is only returned for BITCOIN_VIN event types. SpentVoutTransactionHash *string - // The transactionId that created the spent transaction output. This is only - // returned for BITCOIN_VIN event types. + // The transactionId that created the spent transaction output. + // + // This is only returned for BITCOIN_VIN event types. SpentVoutTransactionId *string // The wallet address receiving the transaction. It can either be a public key or @@ -479,8 +502,9 @@ type TransactionEvent struct { VoutIndex *int32 // Specifies if the transaction output is spent or unspent. This is only returned - // for BITCOIN_VOUT event types. This is only returned for BITCOIN_VOUT event - // types. + // for BITCOIN_VOUT event types. + // + // This is only returned for BITCOIN_VOUT event types. VoutSpent *bool noSmithyDocumentSerde diff --git a/service/marketplaceagreement/api_op_DescribeAgreement.go b/service/marketplaceagreement/api_op_DescribeAgreement.go index f9d1f2f340d..4d08925e2a7 100644 --- a/service/marketplaceagreement/api_op_DescribeAgreement.go +++ b/service/marketplaceagreement/api_op_DescribeAgreement.go @@ -42,6 +42,7 @@ type DescribeAgreementInput struct { type DescribeAgreementOutput struct { // The date and time the offer was accepted or the agreement was created. + // // AcceptanceTime and StartTime can differ for future dated agreements (FDAs). AcceptanceTime *time.Time @@ -72,19 +73,30 @@ type DescribeAgreementOutput struct { // The date and time when the agreement starts. StartTime *time.Time - // The current status of the agreement. Statuses include: + // The current status of the agreement. + // + // Statuses include: + // // - ACTIVE – The terms of the agreement are active. + // // - ARCHIVED – The agreement ended without a specified reason. + // // - CANCELLED – The acceptor ended the agreement before the defined end date. + // // - EXPIRED – The agreement ended on the defined end date. + // // - RENEWED – The agreement was renewed into a new agreement (for example, an // auto-renewal). + // // - REPLACED – The agreement was replaced using an agreement replacement offer. + // // - ROLLED_BACK (Only applicable to inactive agreement revisions) – The // agreement revision has been rolled back because of an error. An earlier revision // is now active. + // // - SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement // revision is no longer active and another agreement revision is now active. + // // - TERMINATED – The agreement ended before the defined end date because of an // AWS termination (for example, a payment failure). Status types.AgreementStatus diff --git a/service/marketplaceagreement/api_op_GetAgreementTerms.go b/service/marketplaceagreement/api_op_GetAgreementTerms.go index 65e02d9ca74..7939565fc5d 100644 --- a/service/marketplaceagreement/api_op_GetAgreementTerms.go +++ b/service/marketplaceagreement/api_op_GetAgreementTerms.go @@ -12,7 +12,9 @@ import ( ) // Obtains details about the terms in an agreement that you participated in as -// proposer or acceptor. The details include: +// proposer or acceptor. +// +// The details include: // // - TermType – The type of term, such as LegalTerm , RenewalTerm , or // ConfigurableUpfrontPricingTerm . diff --git a/service/marketplaceagreement/api_op_SearchAgreements.go b/service/marketplaceagreement/api_op_SearchAgreements.go index 4e9163583d5..4e6a24a3087 100644 --- a/service/marketplaceagreement/api_op_SearchAgreements.go +++ b/service/marketplaceagreement/api_op_SearchAgreements.go @@ -13,23 +13,39 @@ import ( // Searches across all agreements that a proposer or an acceptor has in AWS // Marketplace. The search returns a list of agreements with basic agreement -// information. The following filter combinations are supported: +// information. +// +// The following filter combinations are supported: +// // - PartyType as Proposer + AgreementType + ResourceIdentifier +// // - PartyType as Proposer + AgreementType + OfferId +// // - PartyType as Proposer + AgreementType + AcceptorAccountId +// // - PartyType as Proposer + AgreementType + Status +// // - PartyType as Proposer + AgreementType + ResourceIdentifier + Status +// // - PartyType as Proposer + AgreementType + OfferId + Status +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + Status +// // - PartyType as Proposer + AgreementType + ResourceType + Status +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType + // Status +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + OfferId + Status +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + // ResourceIdentifier +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + // ResourceIdentifier + Status +// // - PartyType as Proposer + AgreementType + AcceptorAccountId + ResourceType func (c *Client) SearchAgreements(ctx context.Context, params *SearchAgreementsInput, optFns ...func(*Options)) (*SearchAgreementsOutput, error) { if params == nil { @@ -51,24 +67,34 @@ type SearchAgreementsInput struct { // The catalog in which the agreement was created. Catalog *string - // The filter name and value pair used to return a specific list of results. The - // following filters are supported: + // The filter name and value pair used to return a specific list of results. + // + // The following filters are supported: + // // - ResourceIdentifier – The unique identifier of the resource. + // // - ResourceType – Type of the resource, which is the product ( AmiProduct , // ContainerProduct , or SaaSProduct ). + // // - PartyType – The party type (either Acceptor or Proposer ) of the caller. For // agreements where the caller is the proposer, use the Proposer filter. For // agreements where the caller is the acceptor, use the Acceptor filter. + // // - AcceptorAccountId – The AWS account ID of the party accepting the agreement // terms. + // // - OfferId – The unique identifier of the offer in which the terms are // registered in the agreement token. + // // - Status – The current status of the agreement. Values include ACTIVE , // ARCHIVED , CANCELLED , EXPIRED , RENEWED , REPLACED , and TERMINATED . + // // - BeforeEndTime – A date used to filter agreements with a date before the // endTime of an agreement. + // // - AfterEndTime – A date used to filter agreements with a date after the // endTime of an agreement. + // // - AgreementType – The type of agreement. Values include PurchaseAgreement or // VendorInsightsAgreement . Filters []types.Filter diff --git a/service/marketplaceagreement/doc.go b/service/marketplaceagreement/doc.go index 3abaf5b3eb2..abd55cca295 100644 --- a/service/marketplaceagreement/doc.go +++ b/service/marketplaceagreement/doc.go @@ -8,14 +8,19 @@ // solutions and run their businesses. The AWS Marketplace Agreement Service // provides an API interface that helps AWS Marketplace sellers manage their // product-related agreements, including listing, searching, and filtering -// agreements. To manage agreements in AWS Marketplace, you must ensure that your -// AWS Identity and Access Management (IAM) policies and roles are set up. The user -// must have the required policies/permissions that allow them to carry out the -// actions in AWS: +// agreements. +// +// To manage agreements in AWS Marketplace, you must ensure that your AWS Identity +// and Access Management (IAM) policies and roles are set up. The user must have +// the required policies/permissions that allow them to carry out the actions in +// AWS: +// // - DescribeAgreement – Grants permission to users to obtain detailed meta data // about any of their agreements. +// // - GetAgreementTerms – Grants permission to users to obtain details about the // terms of an agreement. +// // - SearchAgreements – Grants permission to users to search through all their // agreements. package marketplaceagreement diff --git a/service/marketplaceagreement/options.go b/service/marketplaceagreement/options.go index 9ee60337932..b1fc050f4aa 100644 --- a/service/marketplaceagreement/options.go +++ b/service/marketplaceagreement/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/marketplaceagreement/types/enums.go b/service/marketplaceagreement/types/enums.go index be3849ee842..653571cde35 100644 --- a/service/marketplaceagreement/types/enums.go +++ b/service/marketplaceagreement/types/enums.go @@ -18,8 +18,9 @@ const ( ) // Values returns all known values for AgreementStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgreementStatus) Values() []AgreementStatus { return []AgreementStatus{ "ACTIVE", @@ -42,8 +43,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "Agreement", @@ -59,8 +61,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -87,6 +90,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/marketplaceagreement/types/types.go b/service/marketplaceagreement/types/types.go index c9de9d93134..f43c5f2ece5 100644 --- a/service/marketplaceagreement/types/types.go +++ b/service/marketplaceagreement/types/types.go @@ -283,9 +283,10 @@ type Dimension struct { // This member is required. DimensionKey *string - // The number of units of the dimension the acceptor has purchased. For Agreements - // with ConfigurableUpfrontPricingTerm , the RateCard section will define the - // prices and dimensions defined by the seller (proposer), whereas the + // The number of units of the dimension the acceptor has purchased. + // + // For Agreements with ConfigurableUpfrontPricingTerm , the RateCard section will + // define the prices and dimensions defined by the seller (proposer), whereas the // Configuration section will define the actual dimensions, prices, and units the // buyer has chosen to accept. // @@ -300,14 +301,18 @@ type Dimension struct { type DocumentItem struct { // Category of the document. Document types include: + // // - CustomEula – A custom EULA provided by you as seller. A URL for a EULA // stored in an accessible Amazon S3 bucket is required for this document type. + // // - CustomDsa – A custom Data Subscription Agreement (DSA) provided by you as // seller. A URL for a DSA stored in an accessible Amazon S3 bucket is required for // this document type. + // // - StandardEula – The Standard Contract for AWS Marketplace (SCMP). For more // information about SCMP, see the AWS Marketplace Seller Guide. You don’t provide // a URL for this type because it’s managed by AWS Marketplace. + // // - StandardDsa – DSA for AWS Marketplace. For more information about the DSA, // see the AWS Data Exchange User Guide. You don’t provide a URL for this type // because it’s managed by AWS Marketplace. @@ -328,20 +333,26 @@ type DocumentItem struct { type EstimatedCharges struct { // The total known amount customer has to pay across the lifecycle of the - // agreement. This is the total contract value if accepted terms contain + // agreement. + // + // This is the total contract value if accepted terms contain // ConfigurableUpfrontPricingTerm or FixedUpfrontPricingTerm . In the case of pure // contract pricing, this will be the total value of the contract. In the case of // contracts with consumption pricing, this will only include the committed value - // and not include any overages that occur. If the accepted terms contain - // PaymentScheduleTerm , it will be the total payment schedule amount. This occurs - // when flexible payment schedule is used, and is the sum of all invoice charges in - // the payment schedule. In case a customer has amended an agreement, by purchasing - // more units of any dimension, this will include both the original cost as well as - // the added cost incurred due to addition of new units. This is 0 if the accepted - // terms contain UsageBasedPricingTerm without ConfigurableUpfrontPricingTerm or - // RecurringPaymentTerm . This occurs for usage-based pricing (such as SaaS metered - // or AMI/container hourly or monthly), because the exact usage is not known - // upfront. + // and not include any overages that occur. + // + // If the accepted terms contain PaymentScheduleTerm , it will be the total payment + // schedule amount. This occurs when flexible payment schedule is used, and is the + // sum of all invoice charges in the payment schedule. + // + // In case a customer has amended an agreement, by purchasing more units of any + // dimension, this will include both the original cost as well as the added cost + // incurred due to addition of new units. + // + // This is 0 if the accepted terms contain UsageBasedPricingTerm without + // ConfigurableUpfrontPricingTerm or RecurringPaymentTerm . This occurs for + // usage-based pricing (such as SaaS metered or AMI/container hourly or monthly), + // because the exact usage is not known upfront. AgreementValue *string // Defines the currency code for the charge. @@ -542,8 +553,10 @@ type RenewalTermConfiguration struct { // The list of resources involved in the agreement. type Resource struct { - // The unique identifier of the resource. We mention the term resource, which is - // most commonly a product, so a resourceId is also a productId . + // The unique identifier of the resource. + // + // We mention the term resource, which is most commonly a product, so a resourceId + // is also a productId . Id *string // Type of the resource, which is the product. Values include SaaSProduct or diff --git a/service/marketplacecatalog/api_op_ListChangeSets.go b/service/marketplacecatalog/api_op_ListChangeSets.go index df4c4dd1d8e..a115439eb35 100644 --- a/service/marketplacecatalog/api_op_ListChangeSets.go +++ b/service/marketplacecatalog/api_op_ListChangeSets.go @@ -14,8 +14,10 @@ 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 -// operation applies a logical AND between the filters. You can describe a change -// during the 60-day request history retention period for API calls. +// 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) { if params == nil { params = &ListChangeSetsInput{} @@ -58,7 +60,7 @@ type ListChangeSetsInput struct { type ListChangeSetsOutput struct { - // Array of ChangeSetSummaryListItem objects. + // Array of ChangeSetSummaryListItem objects. ChangeSetSummaryList []types.ChangeSetSummaryListItem // The value of the next token, if it exists. Null if there are no more results. diff --git a/service/marketplacecatalog/api_op_ListTagsForResource.go b/service/marketplacecatalog/api_op_ListTagsForResource.go index d1163e3344f..34acde979d9 100644 --- a/service/marketplacecatalog/api_op_ListTagsForResource.go +++ b/service/marketplacecatalog/api_op_ListTagsForResource.go @@ -11,9 +11,10 @@ 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] or [change set]). +// +// [change set]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets +// [entity]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities 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 f3d5dbb97ec..e3d4e0018d6 100644 --- a/service/marketplacecatalog/api_op_StartChangeSet.go +++ b/service/marketplacecatalog/api_op_StartChangeSet.go @@ -17,16 +17,20 @@ import ( // 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) -// 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) -// . For information about change types for single-AMI products, see Working with -// single-AMI products (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products) -// . Also, for more information about change types available for container-based -// products, see Working with container products (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products) -// . +// ResourceInUseException error. +// +// For example, you can't start the ChangeSet described in the [example] 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]. For information +// about change types for single-AMI products, see [Working with single-AMI products]. Also, for more information +// about change types available for container-based products, see [Working with container products]. +// +// [Working with single-AMI products]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products +// [Working with change sets]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets +// [Working with container products]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products +// [example]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples func (c *Client) StartChangeSet(ctx context.Context, params *StartChangeSetInput, optFns ...func(*Options)) (*StartChangeSetOutput, error) { if params == nil { params = &StartChangeSetInput{} @@ -68,8 +72,9 @@ type StartChangeSetInput struct { // The intent related to the request. The default is APPLY . To test your request // before applying changes to your entities, use VALIDATE . This feature is // currently available for adding versions to single-AMI products. For more - // information, see Add a new version (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#ami-add-version) - // . + // information, see [Add a new version]. + // + // [Add a new version]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#ami-add-version Intent types.Intent noSmithyDocumentSerde diff --git a/service/marketplacecatalog/api_op_TagResource.go b/service/marketplacecatalog/api_op_TagResource.go index f812e7b9564..a433c49b0f4 100644 --- a/service/marketplacecatalog/api_op_TagResource.go +++ b/service/marketplacecatalog/api_op_TagResource.go @@ -11,9 +11,10 @@ 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] or [change set]). +// +// [change set]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets +// [entity]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities 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 172d9770d56..a29e5046ca0 100644 --- a/service/marketplacecatalog/api_op_UntagResource.go +++ b/service/marketplacecatalog/api_op_UntagResource.go @@ -10,9 +10,10 @@ 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] or [change set]). +// +// [change set]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets +// [entity]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#catalog-api-entities func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/marketplacecatalog/doc.go b/service/marketplacecatalog/doc.go index 2af2cc0ad0e..eb26b8edb85 100644 --- a/service/marketplacecatalog/doc.go +++ b/service/marketplacecatalog/doc.go @@ -5,8 +5,10 @@ // // Catalog API actions allow you to manage your entities through list, describe, // and update capabilities. An entity can be a product or an offer on AWS -// Marketplace. You can automate your entity update process by integrating the AWS -// Marketplace Catalog API with your AWS Marketplace product build or deployment -// pipelines. You can also create your own applications on top of the Catalog API -// to manage your products on AWS Marketplace. +// Marketplace. +// +// You can automate your entity update process by integrating the AWS Marketplace +// Catalog API with your AWS Marketplace product build or deployment pipelines. You +// can also create your own applications on top of the Catalog API to manage your +// products on AWS Marketplace. package marketplacecatalog diff --git a/service/marketplacecatalog/options.go b/service/marketplacecatalog/options.go index 8b1efa9bf6c..caf2ad3f9da 100644 --- a/service/marketplacecatalog/options.go +++ b/service/marketplacecatalog/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/marketplacecatalog/types/enums.go b/service/marketplacecatalog/types/enums.go index 268a43dc243..03d22525124 100644 --- a/service/marketplacecatalog/types/enums.go +++ b/service/marketplacecatalog/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AmiProductSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AmiProductSortBy) Values() []AmiProductSortBy { return []AmiProductSortBy{ "EntityId", @@ -36,6 +37,7 @@ const ( // Values returns all known values for AmiProductVisibilityString. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AmiProductVisibilityString) Values() []AmiProductVisibilityString { return []AmiProductVisibilityString{ @@ -58,8 +60,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for ContainerProductSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerProductSortBy) Values() []ContainerProductSortBy { return []ContainerProductSortBy{ "EntityId", @@ -104,8 +108,9 @@ const ( // Values returns all known values for ContainerProductVisibilityString. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerProductVisibilityString) Values() []ContainerProductVisibilityString { return []ContainerProductVisibilityString{ "Limited", @@ -126,8 +131,9 @@ const ( ) // Values returns all known values for DataProductSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataProductSortBy) Values() []DataProductSortBy { return []DataProductSortBy{ "EntityId", @@ -150,6 +156,7 @@ const ( // Values returns all known values for DataProductVisibilityString. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataProductVisibilityString) Values() []DataProductVisibilityString { return []DataProductVisibilityString{ @@ -170,8 +177,9 @@ const ( ) // Values returns all known values for FailureCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureCode) Values() []FailureCode { return []FailureCode{ "CLIENT_ERROR", @@ -188,8 +196,9 @@ const ( ) // Values returns all known values for Intent. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Intent) Values() []Intent { return []Intent{ "VALIDATE", @@ -214,8 +223,9 @@ const ( ) // Values returns all known values for OfferSortBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferSortBy) Values() []OfferSortBy { return []OfferSortBy{ "EntityId", @@ -240,8 +250,9 @@ const ( ) // Values returns all known values for OfferStateString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferStateString) Values() []OfferStateString { return []OfferStateString{ "Draft", @@ -260,8 +271,9 @@ const ( ) // Values returns all known values for OfferTargetingString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfferTargetingString) Values() []OfferTargetingString { return []OfferTargetingString{ "BuyerAccounts", @@ -280,8 +292,9 @@ const ( ) // Values returns all known values for OwnershipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OwnershipType) Values() []OwnershipType { return []OwnershipType{ "SELF", @@ -310,6 +323,7 @@ const ( // Values returns all known values for ResaleAuthorizationSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResaleAuthorizationSortBy) Values() []ResaleAuthorizationSortBy { return []ResaleAuthorizationSortBy{ @@ -340,8 +354,9 @@ const ( // Values returns all known values for ResaleAuthorizationStatusString. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResaleAuthorizationStatusString) Values() []ResaleAuthorizationStatusString { return []ResaleAuthorizationStatusString{ "Draft", @@ -361,8 +376,9 @@ const ( ) // Values returns all known values for SaaSProductSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SaaSProductSortBy) Values() []SaaSProductSortBy { return []SaaSProductSortBy{ "EntityId", @@ -384,6 +400,7 @@ const ( // Values returns all known values for SaaSProductVisibilityString. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SaaSProductVisibilityString) Values() []SaaSProductVisibilityString { return []SaaSProductVisibilityString{ @@ -403,8 +420,9 @@ const ( ) // 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. +// in the future, and so 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/errors.go b/service/marketplacecatalog/types/errors.go index 859cc5956f1..64462a2c945 100644 --- a/service/marketplacecatalog/types/errors.go +++ b/service/marketplacecatalog/types/errors.go @@ -7,7 +7,9 @@ import ( smithy "github.com/aws/smithy-go" ) -// Access is denied. HTTP status code: 403 +// Access is denied. +// +// HTTP status code: 403 type AccessDeniedException struct { Message *string @@ -33,7 +35,9 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// There was an internal service exception. HTTP status code: 500 +// There was an internal service exception. +// +// HTTP status code: 500 type InternalServiceException struct { Message *string @@ -85,7 +89,9 @@ func (e *ResourceInUseException) ErrorCode() string { } func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The specified resource wasn't found. HTTP status code: 404 +// The specified resource wasn't found. +// +// HTTP status code: 404 type ResourceNotFoundException struct { Message *string @@ -163,7 +169,9 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Too many requests. HTTP status code: 429 +// Too many requests. +// +// HTTP status code: 429 type ThrottlingException struct { Message *string @@ -189,7 +197,9 @@ func (e *ThrottlingException) ErrorCode() string { } func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An error occurred during validation. HTTP status code: 422 +// An error occurred during validation. +// +// HTTP status code: 422 type ValidationException struct { Message *string diff --git a/service/marketplacecatalog/types/types.go b/service/marketplacecatalog/types/types.go index 87560d5851e..23e1440e241 100644 --- a/service/marketplacecatalog/types/types.go +++ b/service/marketplacecatalog/types/types.go @@ -124,10 +124,11 @@ type Change struct { // Change types are single string values that describe your intention for the // change. Each change type is unique for each EntityType provided in the change's // scope. For more information about change types available for single-AMI - // products, see Working with single-AMI products (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products) - // . Also, for more information about change types available for container-based - // products, see Working with container products (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products) - // . + // products, see [Working with single-AMI products]. Also, for more information about change types available for + // container-based products, see [Working with container products]. + // + // [Working with single-AMI products]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products + // [Working with container products]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products // // This member is required. ChangeType *string @@ -142,10 +143,11 @@ type Change struct { // This object contains details specific to the change type of the requested // change. For more information about change types available for single-AMI - // products, see Working with single-AMI products (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products) - // . Also, for more information about change types available for container-based - // products, see Working with container products (https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products) - // . + // products, see [Working with single-AMI products]. Also, for more information about change types available for + // container-based products, see [Working with container products]. + // + // [Working with single-AMI products]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products + // [Working with container products]: https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products Details *string // Alternative field that accepts a JSON value instead of a string for ChangeType @@ -678,23 +680,33 @@ 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 EntityId s. ListChangeSets - The - // supported filter names and associated ValueList s is as follows: + // 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 @@ -768,9 +780,10 @@ type OfferFilters struct { // Allows filtering on the ReleaseDate of an offer. ReleaseDate *OfferReleaseDateFilter - // Allows filtering on the ResaleAuthorizationId of an offer. Not all offers have - // a ResaleAuthorizationId . The response will only include offers for which you - // have permissions. + // Allows filtering on the ResaleAuthorizationId of an offer. + // + // Not all offers have a ResaleAuthorizationId . The response will only include + // offers for which you have permissions. ResaleAuthorizationId *OfferResaleAuthorizationIdFilter // Allows filtering on the State of an offer. @@ -845,9 +858,10 @@ type OfferReleaseDateFilterDateRange struct { noSmithyDocumentSerde } -// Allows filtering on the ResaleAuthorizationId of an offer. Not all offers have -// a ResaleAuthorizationId . The response will only include offers for which you -// have permissions. +// Allows filtering on the ResaleAuthorizationId of an offer. +// +// Not all offers have a ResaleAuthorizationId . The response will only include +// offers for which you have permissions. type OfferResaleAuthorizationIdFilter struct { // Allows filtering on the ResaleAuthorizationId of an offer with list input. @@ -1316,8 +1330,9 @@ type Sort struct { // For ListEntities , supported attributes include LastModifiedDate (default) and // EntityId . In addition to LastModifiedDate and EntityId , each EntityType might - // support additional fields. For ListChangeSets , supported attributes include - // StartTime and EndTime . + // support additional fields. + // + // For ListChangeSets , supported attributes include StartTime and EndTime . SortBy *string // The sorting order. Can be ASCENDING or DESCENDING . The default value is diff --git a/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go b/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go index 66e7082a717..2512ca17594 100644 --- a/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go +++ b/service/marketplacecommerceanalytics/api_op_GenerateDataSet.go @@ -52,58 +52,83 @@ 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! // diff --git a/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go b/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go index 8454876abd2..eb022d49c0d 100644 --- a/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go +++ b/service/marketplacecommerceanalytics/api_op_StartSupportDataExport.go @@ -46,13 +46,14 @@ func (c *Client) StartSupportDataExport(ctx context.Context, params *StartSuppor // StartSupportDataExport operation. type StartSupportDataExportInput struct { - // This target has been deprecated. Specifies the data set type to be written to + // This target has been deprecated. Specifies the data set type to be written to // the output csv file. The data set types customer_support_contacts_data and // test_customer_support_contacts_data both result in a csv file containing the // following fields: Product Id, Product 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. diff --git a/service/marketplacecommerceanalytics/options.go b/service/marketplacecommerceanalytics/options.go index 1330c0fc695..8f26e645ea9 100644 --- a/service/marketplacecommerceanalytics/options.go +++ b/service/marketplacecommerceanalytics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/marketplacecommerceanalytics/types/enums.go b/service/marketplacecommerceanalytics/types/enums.go index 1ef88b09c15..50d7d86dedd 100644 --- a/service/marketplacecommerceanalytics/types/enums.go +++ b/service/marketplacecommerceanalytics/types/enums.go @@ -34,8 +34,9 @@ const ( ) // Values returns all known values for DataSetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSetType) Values() []DataSetType { return []DataSetType{ "customer_subscriber_hourly_monthly_subscriptions", @@ -75,8 +76,9 @@ const ( ) // Values returns all known values for SupportDataSetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SupportDataSetType) Values() []SupportDataSetType { return []SupportDataSetType{ "customer_support_contacts_data", diff --git a/service/marketplacedeployment/options.go b/service/marketplacedeployment/options.go index 8389de8c430..d7d3325cf08 100644 --- a/service/marketplacedeployment/options.go +++ b/service/marketplacedeployment/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/marketplaceentitlementservice/doc.go b/service/marketplaceentitlementservice/doc.go index 490b70c3704..a804ab59cb4 100644 --- a/service/marketplaceentitlementservice/doc.go +++ b/service/marketplaceentitlementservice/doc.go @@ -3,12 +3,18 @@ // Package marketplaceentitlementservice provides the API client, operations, and // parameter types for AWS Marketplace Entitlement Service. // -// AWS Marketplace Entitlement Service This reference provides descriptions of the -// AWS Marketplace Entitlement Service API. AWS Marketplace Entitlement Service is -// used to determine the entitlement of a customer to a given product. An -// entitlement represents capacity in a product owned by the customer. For example, -// 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 +// # AWS Marketplace Entitlement Service +// +// This reference provides descriptions of the AWS Marketplace Entitlement Service +// API. +// +// AWS Marketplace Entitlement Service is used to determine the entitlement of a +// customer to a given product. An entitlement represents capacity in a product +// owned by the customer. For example, 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. package marketplaceentitlementservice diff --git a/service/marketplaceentitlementservice/options.go b/service/marketplaceentitlementservice/options.go index c2184e89dfb..44727f8fc36 100644 --- a/service/marketplaceentitlementservice/options.go +++ b/service/marketplaceentitlementservice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/marketplaceentitlementservice/types/enums.go b/service/marketplaceentitlementservice/types/enums.go index 6d5b693c192..0af647cc221 100644 --- a/service/marketplaceentitlementservice/types/enums.go +++ b/service/marketplaceentitlementservice/types/enums.go @@ -12,6 +12,7 @@ const ( // 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{ diff --git a/service/marketplacemetering/api_op_BatchMeterUsage.go b/service/marketplacemetering/api_op_BatchMeterUsage.go index 58e19fae1ed..2e4906672d0 100644 --- a/service/marketplacemetering/api_op_BatchMeterUsage.go +++ b/service/marketplacemetering/api_op_BatchMeterUsage.go @@ -12,21 +12,34 @@ import ( ) // BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to -// post metering records for a set of customers. For identical requests, the API is -// 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 -// 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 -// 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) -// in the AWS Marketplace Seller Guide. +// post metering records for a set of customers. +// +// For identical requests, the API is 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 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 should retry. +// +// BatchMeterUsage requests must be less than 1MB in size. +// +// For an example of using BatchMeterUsage , see [BatchMeterUsage code example] in the AWS Marketplace Seller +// Guide. +// +// [BatchMeterUsage code example]: https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example func (c *Client) BatchMeterUsage(ctx context.Context, params *BatchMeterUsageInput, optFns ...func(*Options)) (*BatchMeterUsageOutput, error) { if params == nil { params = &BatchMeterUsageInput{} diff --git a/service/marketplacemetering/api_op_MeterUsage.go b/service/marketplacemetering/api_op_MeterUsage.go index a842c3a9465..2386ce9a464 100644 --- a/service/marketplacemetering/api_op_MeterUsage.go +++ b/service/marketplacemetering/api_op_MeterUsage.go @@ -13,13 +13,18 @@ import ( ) // API to emit metering records. For identical requests, the API is idempotent. It -// simply returns the metering record ID. MeterUsage is authenticated on the -// buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS -// pod. MeterUsage can optionally include multiple usage allocations, to provide +// simply returns the metering record ID. +// +// MeterUsage is authenticated on the buyer's AWS account using credentials from +// the EC2 instance, ECS task, or EKS pod. +// +// MeterUsage 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). 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. +// the customer to define). +// +// 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. func (c *Client) MeterUsage(ctx context.Context, params *MeterUsageInput, optFns ...func(*Options)) (*MeterUsageOutput, error) { if params == nil { params = &MeterUsageInput{} @@ -63,9 +68,11 @@ type MeterUsageInput struct { // 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 f7430aa227d..b1c7beb8ec8 100644 --- a/service/marketplacemetering/api_op_RegisterUsage.go +++ b/service/marketplacemetering/api_op_RegisterUsage.go @@ -18,6 +18,7 @@ import ( // 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 @@ -28,6 +29,7 @@ import ( // 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 diff --git a/service/marketplacemetering/api_op_ResolveCustomer.go b/service/marketplacemetering/api_op_ResolveCustomer.go index 81cfa262be8..2ae6c01badb 100644 --- a/service/marketplacemetering/api_op_ResolveCustomer.go +++ b/service/marketplacemetering/api_op_ResolveCustomer.go @@ -14,11 +14,15 @@ import ( // 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) -// in the AWS Marketplace Seller Guide. +// 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] in the AWS Marketplace Seller +// Guide. +// +// [ResolveCustomer code example]: https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example func (c *Client) ResolveCustomer(ctx context.Context, params *ResolveCustomerInput, optFns ...func(*Options)) (*ResolveCustomerOutput, error) { if params == nil { params = &ResolveCustomerInput{} @@ -49,6 +53,7 @@ type ResolveCustomerInput struct { } // The result of the ResolveCustomer operation. Contains the CustomerIdentifier +// // along with the CustomerAWSAccountId and ProductCode . type ResolveCustomerOutput struct { diff --git a/service/marketplacemetering/doc.go b/service/marketplacemetering/doc.go index d686a967f36..1a3b01eb133 100644 --- a/service/marketplacemetering/doc.go +++ b/service/marketplacemetering/doc.go @@ -3,38 +3,49 @@ // Package marketplacemetering provides the API client, operations, and parameter // types for AWSMarketplace Metering. // -// AWS Marketplace Metering Service This reference provides descriptions of the -// 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) -// in the AWS Marketplace Seller Guide. Submitting Metering Records +// # AWS Marketplace Metering Service +// +// This reference provides descriptions of the 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] 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. +// 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 . +// 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) -// . +// information on using the RegisterUsage operation, see [Container-Based Products]. // // 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) -// . +// use CloudTrail to audit records over time. For more information, see the [AWS CloudTrail User Guide]. +// +// [Container-Based Products]: https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html +// [AWS CloudTrail User Guide]: http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html +// [AWS Marketplace metering and entitlement API permissions]: https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html package marketplacemetering diff --git a/service/marketplacemetering/options.go b/service/marketplacemetering/options.go index 37da8e25dcc..005634dff95 100644 --- a/service/marketplacemetering/options.go +++ b/service/marketplacemetering/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/marketplacemetering/types/enums.go b/service/marketplacemetering/types/enums.go index 592309b530d..f798735c56a 100644 --- a/service/marketplacemetering/types/enums.go +++ b/service/marketplacemetering/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for UsageRecordResultStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageRecordResultStatus) Values() []UsageRecordResultStatus { return []UsageRecordResultStatus{ "Success", diff --git a/service/marketplacemetering/types/errors.go b/service/marketplacemetering/types/errors.go index 6e13eeb870f..201a08dd416 100644 --- a/service/marketplacemetering/types/errors.go +++ b/service/marketplacemetering/types/errors.go @@ -441,9 +441,11 @@ 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 -// entire batch is not processed. You must remove invalid records and try again. +// 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 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 da02bc441e3..a1eb757abad 100644 --- a/service/marketplacemetering/types/types.go +++ b/service/marketplacemetering/types/types.go @@ -25,8 +25,9 @@ type Tag struct { noSmithyDocumentSerde } -// Usage allocations allow you to split usage into buckets by tags. Each -// UsageAllocation indicates the usage quantity for a specific set of tags. +// Usage allocations allow you to split usage into buckets by tags. +// +// Each UsageAllocation indicates the usage quantity for a specific set of tags. type UsageAllocation struct { // The total quantity allocated to this bucket of usage. @@ -42,8 +43,10 @@ type UsageAllocation struct { } // A UsageRecord indicates a quantity of usage for a given product, customer, -// dimension and time. Multiple requests with the same UsageRecords as input will -// be de-duplicated to prevent double charges. +// dimension and time. +// +// Multiple requests with the same UsageRecords as input will be de-duplicated to +// prevent double charges. type UsageRecord struct { // The CustomerIdentifier is obtained through the ResolveCustomer operation and @@ -58,9 +61,10 @@ type UsageRecord struct { // This member is required. 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. + // 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. // // This member is required. Timestamp *time.Time @@ -85,15 +89,21 @@ type UsageRecordResult struct { // 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. diff --git a/service/mediaconnect/api_op_DescribeFlow.go b/service/mediaconnect/api_op_DescribeFlow.go index 42d195d8430..46f95cb9214 100644 --- a/service/mediaconnect/api_op_DescribeFlow.go +++ b/service/mediaconnect/api_op_DescribeFlow.go @@ -176,12 +176,13 @@ type FlowActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFlowInput, *DescribeFlowOutput, error) (bool, error) } @@ -412,12 +413,13 @@ type FlowDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFlowInput, *DescribeFlowOutput, error) (bool, error) } @@ -621,12 +623,13 @@ type FlowStandbyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeFlowInput, *DescribeFlowOutput, error) (bool, error) } diff --git a/service/mediaconnect/options.go b/service/mediaconnect/options.go index ee6b25da336..3af08245a7e 100644 --- a/service/mediaconnect/options.go +++ b/service/mediaconnect/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediaconnect/types/enums.go b/service/mediaconnect/types/enums.go index e8495f28cdf..64a38e9756b 100644 --- a/service/mediaconnect/types/enums.go +++ b/service/mediaconnect/types/enums.go @@ -12,8 +12,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for BridgePlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BridgePlacement) Values() []BridgePlacement { return []BridgePlacement{ "AVAILABLE", @@ -59,8 +61,9 @@ const ( ) // Values returns all known values for BridgeState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BridgeState) Values() []BridgeState { return []BridgeState{ "CREATING", @@ -92,8 +95,9 @@ const ( ) // Values returns all known values for Colorimetry. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Colorimetry) Values() []Colorimetry { return []Colorimetry{ "BT601", @@ -115,8 +119,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "CONNECTED", @@ -134,8 +139,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "ACTIVE", @@ -152,8 +158,9 @@ const ( ) // Values returns all known values for DurationUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DurationUnits) Values() []DurationUnits { return []DurationUnits{ "MONTHS", @@ -169,8 +176,9 @@ const ( ) // Values returns all known values for EncoderProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncoderProfile) Values() []EncoderProfile { return []EncoderProfile{ "main", @@ -189,8 +197,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -209,8 +218,9 @@ const ( ) // Values returns all known values for EntitlementStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntitlementStatus) Values() []EntitlementStatus { return []EntitlementStatus{ "ENABLED", @@ -227,8 +237,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -249,8 +260,9 @@ const ( ) // Values returns all known values for GatewayState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayState) Values() []GatewayState { return []GatewayState{ "CREATING", @@ -275,8 +287,9 @@ const ( ) // Values returns all known values for InstanceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceState) Values() []InstanceState { return []InstanceState{ "REGISTERING", @@ -298,8 +311,9 @@ const ( ) // Values returns all known values for KeyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyType) Values() []KeyType { return []KeyType{ "speke", @@ -322,8 +336,9 @@ const ( ) // Values returns all known values for MaintenanceDay. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceDay) Values() []MaintenanceDay { return []MaintenanceDay{ "Monday", @@ -346,8 +361,9 @@ const ( ) // Values returns all known values for MediaStreamType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaStreamType) Values() []MediaStreamType { return []MediaStreamType{ "video", @@ -365,8 +381,9 @@ const ( ) // Values returns all known values for NetworkInterfaceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceType) Values() []NetworkInterfaceType { return []NetworkInterfaceType{ "ena", @@ -382,8 +399,9 @@ const ( ) // Values returns all known values for PriceUnits. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PriceUnits) Values() []PriceUnits { return []PriceUnits{ "HOURLY", @@ -408,8 +426,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "zixi-push", @@ -436,8 +455,9 @@ const ( ) // 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. +// the future, and so 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{ "NARROW", @@ -457,8 +477,9 @@ const ( ) // Values returns all known values for ReservationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservationState) Values() []ReservationState { return []ReservationState{ "ACTIVE", @@ -476,8 +497,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -494,8 +516,9 @@ const ( ) // Values returns all known values for ScanMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScanMode) Values() []ScanMode { return []ScanMode{ "progressive", @@ -513,8 +536,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "OWNED", @@ -531,8 +555,9 @@ const ( ) // 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. +// the future, and so 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{ "ENABLED", @@ -554,8 +579,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "STANDBY", @@ -584,8 +610,9 @@ const ( ) // Values returns all known values for Tcs. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tcs) Values() []Tcs { return []Tcs{ "SDR", diff --git a/service/mediaconvert/options.go b/service/mediaconvert/options.go index 4fe061edf71..70095be33d3 100644 --- a/service/mediaconvert/options.go +++ b/service/mediaconvert/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediaconvert/types/enums.go b/service/mediaconvert/types/enums.go index 022564376ee..ac9521192b8 100644 --- a/service/mediaconvert/types/enums.go +++ b/service/mediaconvert/types/enums.go @@ -12,8 +12,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacAudioDescriptionBroadcasterMix) Values() []AacAudioDescriptionBroadcasterMix { return []AacAudioDescriptionBroadcasterMix{ "BROADCASTER_MIXED_AD", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AacCodecProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacCodecProfile) Values() []AacCodecProfile { return []AacCodecProfile{ "LC", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for AacCodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacCodingMode) Values() []AacCodingMode { return []AacCodingMode{ "AD_RECEIVER_MIX", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for AacRateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacRateControlMode) Values() []AacRateControlMode { return []AacRateControlMode{ "CBR", @@ -92,8 +96,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -110,8 +115,9 @@ const ( ) // Values returns all known values for AacSpecification. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacSpecification) Values() []AacSpecification { return []AacSpecification{ "MPEG2", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for AacVbrQuality. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacVbrQuality) Values() []AacVbrQuality { return []AacVbrQuality{ "LOW", @@ -156,8 +163,9 @@ const ( ) // Values returns all known values for Ac3BitstreamMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3BitstreamMode) Values() []Ac3BitstreamMode { return []Ac3BitstreamMode{ "COMPLETE_MAIN", @@ -182,8 +190,9 @@ const ( ) // Values returns all known values for Ac3CodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3CodingMode) Values() []Ac3CodingMode { return []Ac3CodingMode{ "CODING_MODE_1_0", @@ -207,8 +216,9 @@ const ( // Values returns all known values for Ac3DynamicRangeCompressionLine. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3DynamicRangeCompressionLine) Values() []Ac3DynamicRangeCompressionLine { return []Ac3DynamicRangeCompressionLine{ "FILM_STANDARD", @@ -230,8 +240,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3DynamicRangeCompressionProfile) Values() []Ac3DynamicRangeCompressionProfile { return []Ac3DynamicRangeCompressionProfile{ "FILM_STANDARD", @@ -253,8 +264,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3DynamicRangeCompressionRf) Values() []Ac3DynamicRangeCompressionRf { return []Ac3DynamicRangeCompressionRf{ "FILM_STANDARD", @@ -275,8 +287,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -293,8 +306,9 @@ const ( ) // Values returns all known values for Ac3MetadataControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3MetadataControl) Values() []Ac3MetadataControl { return []Ac3MetadataControl{ "FOLLOW_INPUT", @@ -312,8 +326,9 @@ const ( ) // Values returns all known values for AccelerationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccelerationMode) Values() []AccelerationMode { return []AccelerationMode{ "DISABLED", @@ -333,8 +348,9 @@ const ( ) // Values returns all known values for AccelerationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccelerationStatus) Values() []AccelerationStatus { return []AccelerationStatus{ "NOT_APPLICABLE", @@ -353,8 +369,9 @@ const ( ) // Values returns all known values for AdvancedInputFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdvancedInputFilter) Values() []AdvancedInputFilter { return []AdvancedInputFilter{ "ENABLED", @@ -372,8 +389,9 @@ const ( // Values returns all known values for AdvancedInputFilterAddTexture. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdvancedInputFilterAddTexture) Values() []AdvancedInputFilterAddTexture { return []AdvancedInputFilterAddTexture{ "ENABLED", @@ -392,6 +410,7 @@ const ( // Values returns all known values for AdvancedInputFilterSharpen. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AdvancedInputFilterSharpen) Values() []AdvancedInputFilterSharpen { return []AdvancedInputFilterSharpen{ @@ -411,8 +430,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -430,8 +450,9 @@ const ( ) // Values returns all known values for AlphaBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlphaBehavior) Values() []AlphaBehavior { return []AlphaBehavior{ "DISCARD", @@ -449,6 +470,7 @@ const ( // 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{ @@ -467,6 +489,7 @@ const ( // Values returns all known values for AncillaryTerminateCaptions. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AncillaryTerminateCaptions) Values() []AncillaryTerminateCaptions { return []AncillaryTerminateCaptions{ @@ -484,8 +507,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -528,8 +552,9 @@ const ( ) // Values returns all known values for AudioChannelTag. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioChannelTag) Values() []AudioChannelTag { return []AudioChannelTag{ "L", @@ -582,8 +607,9 @@ const ( ) // Values returns all known values for AudioCodec. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioCodec) Values() []AudioCodec { return []AudioCodec{ "AAC", @@ -610,8 +636,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DEFAULT", @@ -630,8 +657,9 @@ const ( ) // Values returns all known values for AudioDurationCorrection. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioDurationCorrection) Values() []AudioDurationCorrection { return []AudioDurationCorrection{ "DISABLED", @@ -651,6 +679,7 @@ const ( // 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{ @@ -671,6 +700,7 @@ const ( // Values returns all known values for AudioNormalizationAlgorithm. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AudioNormalizationAlgorithm) Values() []AudioNormalizationAlgorithm { return []AudioNormalizationAlgorithm{ @@ -691,8 +721,9 @@ const ( // Values returns all known values for AudioNormalizationAlgorithmControl. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioNormalizationAlgorithmControl) Values() []AudioNormalizationAlgorithmControl { return []AudioNormalizationAlgorithmControl{ "CORRECT_AUDIO", @@ -710,8 +741,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioNormalizationLoudnessLogging) Values() []AudioNormalizationLoudnessLogging { return []AudioNormalizationLoudnessLogging{ "LOG", @@ -729,8 +761,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioNormalizationPeakCalculation) Values() []AudioNormalizationPeakCalculation { return []AudioNormalizationPeakCalculation{ "TRUE_PEAK", @@ -749,8 +782,9 @@ const ( ) // Values returns all known values for AudioSelectorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioSelectorType) Values() []AudioSelectorType { return []AudioSelectorType{ "PID", @@ -769,8 +803,9 @@ const ( ) // Values returns all known values for AudioTypeControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioTypeControl) Values() []AudioTypeControl { return []AudioTypeControl{ "FOLLOW_INPUT", @@ -791,8 +826,9 @@ const ( ) // Values returns all known values for Av1AdaptiveQuantization. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1AdaptiveQuantization) Values() []Av1AdaptiveQuantization { return []Av1AdaptiveQuantization{ "OFF", @@ -813,8 +849,9 @@ const ( ) // Values returns all known values for Av1BitDepth. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1BitDepth) Values() []Av1BitDepth { return []Av1BitDepth{ "BIT_8", @@ -831,8 +868,9 @@ const ( ) // Values returns all known values for Av1FilmGrainSynthesis. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1FilmGrainSynthesis) Values() []Av1FilmGrainSynthesis { return []Av1FilmGrainSynthesis{ "DISABLED", @@ -849,8 +887,9 @@ const ( ) // Values returns all known values for Av1FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1FramerateControl) Values() []Av1FramerateControl { return []Av1FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -869,8 +908,9 @@ const ( // Values returns all known values for Av1FramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1FramerateConversionAlgorithm) Values() []Av1FramerateConversionAlgorithm { return []Av1FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -887,8 +927,9 @@ const ( ) // Values returns all known values for Av1RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1RateControlMode) Values() []Av1RateControlMode { return []Av1RateControlMode{ "QVBR", @@ -905,8 +946,9 @@ const ( // Values returns all known values for Av1SpatialAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Av1SpatialAdaptiveQuantization) Values() []Av1SpatialAdaptiveQuantization { return []Av1SpatialAdaptiveQuantization{ "DISABLED", @@ -925,8 +967,9 @@ const ( ) // Values returns all known values for AvcIntraClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraClass) Values() []AvcIntraClass { return []AvcIntraClass{ "CLASS_50", @@ -946,6 +989,7 @@ const ( // 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{ @@ -965,8 +1009,9 @@ const ( // Values returns all known values for AvcIntraFramerateConversionAlgorithm. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraFramerateConversionAlgorithm) Values() []AvcIntraFramerateConversionAlgorithm { return []AvcIntraFramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -987,8 +1032,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PROGRESSIVE", @@ -1009,8 +1055,9 @@ const ( // Values returns all known values for AvcIntraScanTypeConversionMode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraScanTypeConversionMode) Values() []AvcIntraScanTypeConversionMode { return []AvcIntraScanTypeConversionMode{ "INTERLACED", @@ -1027,8 +1074,9 @@ const ( ) // Values returns all known values for AvcIntraSlowPal. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraSlowPal) Values() []AvcIntraSlowPal { return []AvcIntraSlowPal{ "DISABLED", @@ -1045,8 +1093,9 @@ const ( ) // Values returns all known values for AvcIntraTelecine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraTelecine) Values() []AvcIntraTelecine { return []AvcIntraTelecine{ "NONE", @@ -1064,8 +1113,9 @@ const ( // Values returns all known values for AvcIntraUhdQualityTuningLevel. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvcIntraUhdQualityTuningLevel) Values() []AvcIntraUhdQualityTuningLevel { return []AvcIntraUhdQualityTuningLevel{ "SINGLE_PASS", @@ -1085,8 +1135,9 @@ const ( // Values returns all known values for BandwidthReductionFilterSharpening. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BandwidthReductionFilterSharpening) Values() []BandwidthReductionFilterSharpening { return []BandwidthReductionFilterSharpening{ "LOW", @@ -1109,8 +1160,9 @@ const ( // Values returns all known values for BandwidthReductionFilterStrength. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BandwidthReductionFilterStrength) Values() []BandwidthReductionFilterStrength { return []BandwidthReductionFilterStrength{ "LOW", @@ -1132,8 +1184,9 @@ const ( ) // Values returns all known values for BillingTagsSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BillingTagsSource) Values() []BillingTagsSource { return []BillingTagsSource{ "QUEUE", @@ -1153,8 +1206,9 @@ const ( ) // Values returns all known values for BurninSubtitleAlignment. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleAlignment) Values() []BurninSubtitleAlignment { return []BurninSubtitleAlignment{ "CENTERED", @@ -1173,8 +1227,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleApplyFontColor) Values() []BurninSubtitleApplyFontColor { return []BurninSubtitleApplyFontColor{ "WHITE_TEXT_ONLY", @@ -1194,8 +1249,9 @@ const ( // Values returns all known values for BurninSubtitleBackgroundColor. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleBackgroundColor) Values() []BurninSubtitleBackgroundColor { return []BurninSubtitleBackgroundColor{ "NONE", @@ -1218,6 +1274,7 @@ const ( // Values returns all known values for BurninSubtitleFallbackFont. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleFallbackFont) Values() []BurninSubtitleFallbackFont { return []BurninSubtitleFallbackFont{ @@ -1244,8 +1301,9 @@ const ( ) // Values returns all known values for BurninSubtitleFontColor. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleFontColor) Values() []BurninSubtitleFontColor { return []BurninSubtitleFontColor{ "WHITE", @@ -1274,6 +1332,7 @@ const ( // Values returns all known values for BurninSubtitleOutlineColor. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleOutlineColor) Values() []BurninSubtitleOutlineColor { return []BurninSubtitleOutlineColor{ @@ -1299,6 +1358,7 @@ const ( // Values returns all known values for BurninSubtitleShadowColor. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleShadowColor) Values() []BurninSubtitleShadowColor { return []BurninSubtitleShadowColor{ @@ -1319,8 +1379,9 @@ const ( // Values returns all known values for BurnInSubtitleStylePassthrough. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurnInSubtitleStylePassthrough) Values() []BurnInSubtitleStylePassthrough { return []BurnInSubtitleStylePassthrough{ "ENABLED", @@ -1339,8 +1400,9 @@ const ( // Values returns all known values for BurninSubtitleTeletextSpacing. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurninSubtitleTeletextSpacing) Values() []BurninSubtitleTeletextSpacing { return []BurninSubtitleTeletextSpacing{ "FIXED_GRID", @@ -1368,8 +1430,9 @@ const ( ) // Values returns all known values for CaptionDestinationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CaptionDestinationType) Values() []CaptionDestinationType { return []CaptionDestinationType{ "BURN_IN", @@ -1397,8 +1460,9 @@ const ( // Values returns all known values for CaptionSourceConvertPaintOnToPopOn. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CaptionSourceConvertPaintOnToPopOn) Values() []CaptionSourceConvertPaintOnToPopOn { return []CaptionSourceConvertPaintOnToPopOn{ "ENABLED", @@ -1427,8 +1491,9 @@ const ( ) // Values returns all known values for CaptionSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CaptionSourceType) Values() []CaptionSourceType { return []CaptionSourceType{ "ANCILLARY", @@ -1457,8 +1522,9 @@ const ( ) // Values returns all known values for CmafClientCache. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafClientCache) Values() []CmafClientCache { return []CmafClientCache{ "DISABLED", @@ -1475,8 +1541,9 @@ const ( ) // Values returns all known values for CmafCodecSpecification. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafCodecSpecification) Values() []CmafCodecSpecification { return []CmafCodecSpecification{ "RFC_6381", @@ -1493,8 +1560,9 @@ const ( ) // Values returns all known values for CmafEncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafEncryptionType) Values() []CmafEncryptionType { return []CmafEncryptionType{ "SAMPLE_AES", @@ -1513,8 +1581,9 @@ const ( ) // Values returns all known values for CmafImageBasedTrickPlay. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafImageBasedTrickPlay) Values() []CmafImageBasedTrickPlay { return []CmafImageBasedTrickPlay{ "NONE", @@ -1534,8 +1603,9 @@ const ( // Values returns all known values for CmafInitializationVectorInManifest. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafInitializationVectorInManifest) Values() []CmafInitializationVectorInManifest { return []CmafInitializationVectorInManifest{ "INCLUDE", @@ -1552,8 +1622,9 @@ const ( ) // Values returns all known values for CmafIntervalCadence. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafIntervalCadence) Values() []CmafIntervalCadence { return []CmafIntervalCadence{ "FOLLOW_IFRAME", @@ -1570,8 +1641,9 @@ const ( ) // Values returns all known values for CmafKeyProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafKeyProviderType) Values() []CmafKeyProviderType { return []CmafKeyProviderType{ "SPEKE", @@ -1588,8 +1660,9 @@ const ( ) // Values returns all known values for CmafManifestCompression. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafManifestCompression) Values() []CmafManifestCompression { return []CmafManifestCompression{ "GZIP", @@ -1607,6 +1680,7 @@ const ( // Values returns all known values for CmafManifestDurationFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CmafManifestDurationFormat) Values() []CmafManifestDurationFormat { return []CmafManifestDurationFormat{ @@ -1625,8 +1699,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafMpdManifestBandwidthType) Values() []CmafMpdManifestBandwidthType { return []CmafMpdManifestBandwidthType{ "AVERAGE", @@ -1643,8 +1718,9 @@ const ( ) // Values returns all known values for CmafMpdProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafMpdProfile) Values() []CmafMpdProfile { return []CmafMpdProfile{ "MAIN_PROFILE", @@ -1662,8 +1738,9 @@ const ( // Values returns all known values for CmafPtsOffsetHandlingForBFrames. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafPtsOffsetHandlingForBFrames) Values() []CmafPtsOffsetHandlingForBFrames { return []CmafPtsOffsetHandlingForBFrames{ "ZERO_BASED", @@ -1680,8 +1757,9 @@ const ( ) // Values returns all known values for CmafSegmentControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafSegmentControl) Values() []CmafSegmentControl { return []CmafSegmentControl{ "SINGLE_FILE", @@ -1699,6 +1777,7 @@ const ( // 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{ @@ -1716,8 +1795,9 @@ const ( ) // Values returns all known values for CmafStreamInfResolution. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafStreamInfResolution) Values() []CmafStreamInfResolution { return []CmafStreamInfResolution{ "INCLUDE", @@ -1735,8 +1815,9 @@ const ( // Values returns all known values for CmafTargetDurationCompatibilityMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafTargetDurationCompatibilityMode) Values() []CmafTargetDurationCompatibilityMode { return []CmafTargetDurationCompatibilityMode{ "LEGACY", @@ -1754,6 +1835,7 @@ const ( // Values returns all known values for CmafVideoCompositionOffsets. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CmafVideoCompositionOffsets) Values() []CmafVideoCompositionOffsets { return []CmafVideoCompositionOffsets{ @@ -1771,8 +1853,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -1789,8 +1872,9 @@ const ( ) // Values returns all known values for CmafWriteHLSManifest. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafWriteHLSManifest) Values() []CmafWriteHLSManifest { return []CmafWriteHLSManifest{ "DISABLED", @@ -1808,8 +1892,9 @@ const ( // Values returns all known values for CmafWriteSegmentTimelineInRepresentation. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafWriteSegmentTimelineInRepresentation) Values() []CmafWriteSegmentTimelineInRepresentation { return []CmafWriteSegmentTimelineInRepresentation{ "ENABLED", @@ -1826,8 +1911,9 @@ const ( ) // Values returns all known values for CmfcAudioDuration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcAudioDuration) Values() []CmfcAudioDuration { return []CmfcAudioDuration{ "DEFAULT_CODEC_DURATION", @@ -1846,8 +1932,9 @@ const ( ) // Values returns all known values for CmfcAudioTrackType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcAudioTrackType) Values() []CmfcAudioTrackType { return []CmfcAudioTrackType{ "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT", @@ -1867,8 +1954,9 @@ const ( // Values returns all known values for CmfcDescriptiveVideoServiceFlag. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcDescriptiveVideoServiceFlag) Values() []CmfcDescriptiveVideoServiceFlag { return []CmfcDescriptiveVideoServiceFlag{ "DONT_FLAG", @@ -1885,8 +1973,9 @@ const ( ) // Values returns all known values for CmfcIFrameOnlyManifest. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcIFrameOnlyManifest) Values() []CmfcIFrameOnlyManifest { return []CmfcIFrameOnlyManifest{ "INCLUDE", @@ -1903,8 +1992,9 @@ const ( ) // Values returns all known values for CmfcKlvMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcKlvMetadata) Values() []CmfcKlvMetadata { return []CmfcKlvMetadata{ "PASSTHROUGH", @@ -1922,8 +2012,9 @@ const ( // Values returns all known values for CmfcManifestMetadataSignaling. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcManifestMetadataSignaling) Values() []CmfcManifestMetadataSignaling { return []CmfcManifestMetadataSignaling{ "ENABLED", @@ -1940,8 +2031,9 @@ const ( ) // Values returns all known values for CmfcScte35Esam. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcScte35Esam) Values() []CmfcScte35Esam { return []CmfcScte35Esam{ "INSERT", @@ -1958,8 +2050,9 @@ const ( ) // Values returns all known values for CmfcScte35Source. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcScte35Source) Values() []CmfcScte35Source { return []CmfcScte35Source{ "PASSTHROUGH", @@ -1976,8 +2069,9 @@ const ( ) // Values returns all known values for CmfcTimedMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmfcTimedMetadata) Values() []CmfcTimedMetadata { return []CmfcTimedMetadata{ "PASSTHROUGH", @@ -1995,6 +2089,7 @@ const ( // Values returns all known values for CmfcTimedMetadataBoxVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CmfcTimedMetadataBoxVersion) Values() []CmfcTimedMetadataBoxVersion { return []CmfcTimedMetadataBoxVersion{ @@ -2012,8 +2107,9 @@ const ( ) // Values returns all known values for ColorMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColorMetadata) Values() []ColorMetadata { return []ColorMetadata{ "IGNORE", @@ -2036,8 +2132,9 @@ const ( ) // Values returns all known values for ColorSpace. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColorSpace) Values() []ColorSpace { return []ColorSpace{ "FOLLOW", @@ -2066,8 +2163,9 @@ const ( ) // Values returns all known values for ColorSpaceConversion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColorSpaceConversion) Values() []ColorSpaceConversion { return []ColorSpaceConversion{ "NONE", @@ -2090,8 +2188,9 @@ const ( ) // Values returns all known values for ColorSpaceUsage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColorSpaceUsage) Values() []ColorSpaceUsage { return []ColorSpaceUsage{ "FORCE", @@ -2107,8 +2206,9 @@ const ( ) // Values returns all known values for Commitment. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Commitment) Values() []Commitment { return []Commitment{ "ONE_YEAR", @@ -2134,8 +2234,9 @@ const ( ) // Values returns all known values for ContainerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerType) Values() []ContainerType { return []ContainerType{ "F4V", @@ -2162,8 +2263,9 @@ const ( ) // Values returns all known values for CopyProtectionAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CopyProtectionAction) Values() []CopyProtectionAction { return []CopyProtectionAction{ "PASSTHROUGH", @@ -2181,8 +2283,9 @@ const ( // Values returns all known values for DashIsoGroupAudioChannelConfigSchemeIdUri. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoGroupAudioChannelConfigSchemeIdUri) Values() []DashIsoGroupAudioChannelConfigSchemeIdUri { return []DashIsoGroupAudioChannelConfigSchemeIdUri{ "MPEG_CHANNEL_CONFIGURATION", @@ -2199,8 +2302,9 @@ const ( ) // Values returns all known values for DashIsoHbbtvCompliance. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoHbbtvCompliance) Values() []DashIsoHbbtvCompliance { return []DashIsoHbbtvCompliance{ "HBBTV_1_5", @@ -2220,6 +2324,7 @@ const ( // Values returns all known values for DashIsoImageBasedTrickPlay. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoImageBasedTrickPlay) Values() []DashIsoImageBasedTrickPlay { return []DashIsoImageBasedTrickPlay{ @@ -2239,8 +2344,9 @@ const ( ) // Values returns all known values for DashIsoIntervalCadence. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoIntervalCadence) Values() []DashIsoIntervalCadence { return []DashIsoIntervalCadence{ "FOLLOW_IFRAME", @@ -2258,8 +2364,9 @@ const ( // Values returns all known values for DashIsoMpdManifestBandwidthType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoMpdManifestBandwidthType) Values() []DashIsoMpdManifestBandwidthType { return []DashIsoMpdManifestBandwidthType{ "AVERAGE", @@ -2276,8 +2383,9 @@ const ( ) // Values returns all known values for DashIsoMpdProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoMpdProfile) Values() []DashIsoMpdProfile { return []DashIsoMpdProfile{ "MAIN_PROFILE", @@ -2295,8 +2403,9 @@ const ( // Values returns all known values for DashIsoPlaybackDeviceCompatibility. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoPlaybackDeviceCompatibility) Values() []DashIsoPlaybackDeviceCompatibility { return []DashIsoPlaybackDeviceCompatibility{ "CENC_V1", @@ -2314,8 +2423,9 @@ const ( // Values returns all known values for DashIsoPtsOffsetHandlingForBFrames. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoPtsOffsetHandlingForBFrames) Values() []DashIsoPtsOffsetHandlingForBFrames { return []DashIsoPtsOffsetHandlingForBFrames{ "ZERO_BASED", @@ -2332,8 +2442,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SINGLE_FILE", @@ -2351,6 +2462,7 @@ const ( // Values returns all known values for DashIsoSegmentLengthControl. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoSegmentLengthControl) Values() []DashIsoSegmentLengthControl { return []DashIsoSegmentLengthControl{ @@ -2369,8 +2481,9 @@ const ( // Values returns all known values for DashIsoVideoCompositionOffsets. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashIsoVideoCompositionOffsets) Values() []DashIsoVideoCompositionOffsets { return []DashIsoVideoCompositionOffsets{ "SIGNED", @@ -2388,8 +2501,9 @@ const ( // 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. +// the future, and so 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", @@ -2407,8 +2521,9 @@ const ( ) // Values returns all known values for DashManifestStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashManifestStyle) Values() []DashManifestStyle { return []DashManifestStyle{ "BASIC", @@ -2427,8 +2542,9 @@ const ( ) // Values returns all known values for DecryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DecryptionMode) Values() []DecryptionMode { return []DecryptionMode{ "AES_CTR", @@ -2449,8 +2565,9 @@ const ( ) // Values returns all known values for DeinterlaceAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeinterlaceAlgorithm) Values() []DeinterlaceAlgorithm { return []DeinterlaceAlgorithm{ "INTERPOLATE", @@ -2470,8 +2587,9 @@ const ( ) // Values returns all known values for DeinterlacerControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeinterlacerControl) Values() []DeinterlacerControl { return []DeinterlacerControl{ "FORCE_ALL_FRAMES", @@ -2489,8 +2607,9 @@ const ( ) // Values returns all known values for DeinterlacerMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeinterlacerMode) Values() []DeinterlacerMode { return []DeinterlacerMode{ "DEINTERLACE", @@ -2508,8 +2627,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DEFAULT", @@ -2527,8 +2647,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PASSTHROUGH", @@ -2546,8 +2667,9 @@ const ( ) // Values returns all known values for DolbyVisionMapping. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DolbyVisionMapping) Values() []DolbyVisionMapping { return []DolbyVisionMapping{ "HDR10_NOMAP", @@ -2564,8 +2686,9 @@ const ( ) // Values returns all known values for DolbyVisionProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DolbyVisionProfile) Values() []DolbyVisionProfile { return []DolbyVisionProfile{ "PROFILE_5", @@ -2582,8 +2705,9 @@ const ( ) // Values returns all known values for DropFrameTimecode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DropFrameTimecode) Values() []DropFrameTimecode { return []DropFrameTimecode{ "DISABLED", @@ -2601,8 +2725,9 @@ const ( ) // Values returns all known values for DvbddsHandling. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbddsHandling) Values() []DvbddsHandling { return []DvbddsHandling{ "NONE", @@ -2624,6 +2749,7 @@ const ( // Values returns all known values for DvbSubSubtitleFallbackFont. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubSubtitleFallbackFont) Values() []DvbSubSubtitleFallbackFont { return []DvbSubSubtitleFallbackFont{ @@ -2645,8 +2771,9 @@ const ( ) // Values returns all known values for DvbSubtitleAlignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleAlignment) Values() []DvbSubtitleAlignment { return []DvbSubtitleAlignment{ "CENTERED", @@ -2665,6 +2792,7 @@ const ( // Values returns all known values for DvbSubtitleApplyFontColor. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleApplyFontColor) Values() []DvbSubtitleApplyFontColor { return []DvbSubtitleApplyFontColor{ @@ -2685,6 +2813,7 @@ const ( // Values returns all known values for DvbSubtitleBackgroundColor. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleBackgroundColor) Values() []DvbSubtitleBackgroundColor { return []DvbSubtitleBackgroundColor{ @@ -2710,8 +2839,9 @@ const ( ) // Values returns all known values for DvbSubtitleFontColor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleFontColor) Values() []DvbSubtitleFontColor { return []DvbSubtitleFontColor{ "WHITE", @@ -2739,8 +2869,9 @@ const ( ) // Values returns all known values for DvbSubtitleOutlineColor. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleOutlineColor) Values() []DvbSubtitleOutlineColor { return []DvbSubtitleOutlineColor{ "BLACK", @@ -2764,8 +2895,9 @@ const ( ) // Values returns all known values for DvbSubtitleShadowColor. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleShadowColor) Values() []DvbSubtitleShadowColor { return []DvbSubtitleShadowColor{ "NONE", @@ -2785,6 +2917,7 @@ const ( // Values returns all known values for DvbSubtitleStylePassthrough. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleStylePassthrough) Values() []DvbSubtitleStylePassthrough { return []DvbSubtitleStylePassthrough{ @@ -2804,6 +2937,7 @@ const ( // Values returns all known values for DvbSubtitleTeletextSpacing. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitleTeletextSpacing) Values() []DvbSubtitleTeletextSpacing { return []DvbSubtitleTeletextSpacing{ @@ -2822,8 +2956,9 @@ const ( ) // Values returns all known values for DvbSubtitlingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubtitlingType) Values() []DvbSubtitlingType { return []DvbSubtitlingType{ "HEARING_IMPAIRED", @@ -2839,8 +2974,9 @@ const ( ) // Values returns all known values for Eac3AtmosBitstreamMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosBitstreamMode) Values() []Eac3AtmosBitstreamMode { return []Eac3AtmosBitstreamMode{ "COMPLETE_MAIN", @@ -2858,8 +2994,9 @@ const ( ) // Values returns all known values for Eac3AtmosCodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosCodingMode) Values() []Eac3AtmosCodingMode { return []Eac3AtmosCodingMode{ "CODING_MODE_AUTO", @@ -2879,8 +3016,9 @@ const ( // Values returns all known values for Eac3AtmosDialogueIntelligence. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDialogueIntelligence) Values() []Eac3AtmosDialogueIntelligence { return []Eac3AtmosDialogueIntelligence{ "ENABLED", @@ -2897,8 +3035,9 @@ const ( ) // Values returns all known values for Eac3AtmosDownmixControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDownmixControl) Values() []Eac3AtmosDownmixControl { return []Eac3AtmosDownmixControl{ "SPECIFIED", @@ -2920,8 +3059,9 @@ const ( // Values returns all known values for Eac3AtmosDynamicRangeCompressionLine. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDynamicRangeCompressionLine) Values() []Eac3AtmosDynamicRangeCompressionLine { return []Eac3AtmosDynamicRangeCompressionLine{ "NONE", @@ -2947,8 +3087,9 @@ const ( // Values returns all known values for Eac3AtmosDynamicRangeCompressionRf. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDynamicRangeCompressionRf) Values() []Eac3AtmosDynamicRangeCompressionRf { return []Eac3AtmosDynamicRangeCompressionRf{ "NONE", @@ -2970,8 +3111,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDynamicRangeControl) Values() []Eac3AtmosDynamicRangeControl { return []Eac3AtmosDynamicRangeControl{ "SPECIFIED", @@ -2991,8 +3133,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "LEQ_A", @@ -3014,8 +3157,9 @@ const ( ) // Values returns all known values for Eac3AtmosStereoDownmix. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosStereoDownmix) Values() []Eac3AtmosStereoDownmix { return []Eac3AtmosStereoDownmix{ "NOT_INDICATED", @@ -3035,8 +3179,9 @@ const ( ) // Values returns all known values for Eac3AtmosSurroundExMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosSurroundExMode) Values() []Eac3AtmosSurroundExMode { return []Eac3AtmosSurroundExMode{ "NOT_INDICATED", @@ -3054,8 +3199,9 @@ const ( ) // Values returns all known values for Eac3AttenuationControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AttenuationControl) Values() []Eac3AttenuationControl { return []Eac3AttenuationControl{ "ATTENUATE_3_DB", @@ -3075,8 +3221,9 @@ const ( ) // Values returns all known values for Eac3BitstreamMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3BitstreamMode) Values() []Eac3BitstreamMode { return []Eac3BitstreamMode{ "COMPLETE_MAIN", @@ -3097,8 +3244,9 @@ const ( ) // Values returns all known values for Eac3CodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3CodingMode) Values() []Eac3CodingMode { return []Eac3CodingMode{ "CODING_MODE_1_0", @@ -3116,8 +3264,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -3139,8 +3288,9 @@ const ( // Values returns all known values for Eac3DynamicRangeCompressionLine. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3DynamicRangeCompressionLine) Values() []Eac3DynamicRangeCompressionLine { return []Eac3DynamicRangeCompressionLine{ "NONE", @@ -3166,8 +3316,9 @@ const ( // Values returns all known values for Eac3DynamicRangeCompressionRf. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3DynamicRangeCompressionRf) Values() []Eac3DynamicRangeCompressionRf { return []Eac3DynamicRangeCompressionRf{ "NONE", @@ -3188,8 +3339,9 @@ const ( ) // Values returns all known values for Eac3LfeControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3LfeControl) Values() []Eac3LfeControl { return []Eac3LfeControl{ "LFE", @@ -3206,8 +3358,9 @@ const ( ) // Values returns all known values for Eac3LfeFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3LfeFilter) Values() []Eac3LfeFilter { return []Eac3LfeFilter{ "ENABLED", @@ -3224,8 +3377,9 @@ const ( ) // Values returns all known values for Eac3MetadataControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3MetadataControl) Values() []Eac3MetadataControl { return []Eac3MetadataControl{ "FOLLOW_INPUT", @@ -3242,8 +3396,9 @@ const ( ) // Values returns all known values for Eac3PassthroughControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3PassthroughControl) Values() []Eac3PassthroughControl { return []Eac3PassthroughControl{ "WHEN_POSSIBLE", @@ -3260,8 +3415,9 @@ const ( ) // Values returns all known values for Eac3PhaseControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3PhaseControl) Values() []Eac3PhaseControl { return []Eac3PhaseControl{ "SHIFT_90_DEGREES", @@ -3280,8 +3436,9 @@ const ( ) // Values returns all known values for Eac3StereoDownmix. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3StereoDownmix) Values() []Eac3StereoDownmix { return []Eac3StereoDownmix{ "NOT_INDICATED", @@ -3301,8 +3458,9 @@ const ( ) // Values returns all known values for Eac3SurroundExMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3SurroundExMode) Values() []Eac3SurroundExMode { return []Eac3SurroundExMode{ "NOT_INDICATED", @@ -3321,8 +3479,9 @@ const ( ) // Values returns all known values for Eac3SurroundMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3SurroundMode) Values() []Eac3SurroundMode { return []Eac3SurroundMode{ "NOT_INDICATED", @@ -3340,8 +3499,9 @@ const ( ) // Values returns all known values for EmbeddedConvert608To708. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmbeddedConvert608To708) Values() []EmbeddedConvert608To708 { return []EmbeddedConvert608To708{ "UPCONVERT", @@ -3359,6 +3519,7 @@ const ( // Values returns all known values for EmbeddedTerminateCaptions. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EmbeddedTerminateCaptions) Values() []EmbeddedTerminateCaptions { return []EmbeddedTerminateCaptions{ @@ -3377,6 +3538,7 @@ const ( // 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{ @@ -3394,8 +3556,9 @@ const ( ) // Values returns all known values for F4vMoovPlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (F4vMoovPlacement) Values() []F4vMoovPlacement { return []F4vMoovPlacement{ "PROGRESSIVE_DOWNLOAD", @@ -3413,6 +3576,7 @@ const ( // Values returns all known values for FileSourceConvert608To708. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (FileSourceConvert608To708) Values() []FileSourceConvert608To708 { return []FileSourceConvert608To708{ @@ -3431,6 +3595,7 @@ const ( // 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{ @@ -3449,8 +3614,9 @@ const ( ) // Values returns all known values for FontScript. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FontScript) Values() []FontScript { return []FontScript{ "AUTOMATIC", @@ -3474,6 +3640,7 @@ const ( // 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{ @@ -3511,8 +3678,9 @@ const ( ) // Values returns all known values for H264CodecLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264CodecLevel) Values() []H264CodecLevel { return []H264CodecLevel{ "AUTO", @@ -3548,8 +3716,9 @@ const ( ) // Values returns all known values for H264CodecProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264CodecProfile) Values() []H264CodecProfile { return []H264CodecProfile{ "BASELINE", @@ -3570,8 +3739,9 @@ const ( ) // Values returns all known values for H264DynamicSubGop. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264DynamicSubGop) Values() []H264DynamicSubGop { return []H264DynamicSubGop{ "ADAPTIVE", @@ -3588,8 +3758,9 @@ const ( ) // Values returns all known values for H264EndOfStreamMarkers. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264EndOfStreamMarkers) Values() []H264EndOfStreamMarkers { return []H264EndOfStreamMarkers{ "INCLUDE", @@ -3606,8 +3777,9 @@ const ( ) // Values returns all known values for H264EntropyEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264EntropyEncoding) Values() []H264EntropyEncoding { return []H264EntropyEncoding{ "CABAC", @@ -3625,8 +3797,9 @@ const ( ) // Values returns all known values for H264FieldEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264FieldEncoding) Values() []H264FieldEncoding { return []H264FieldEncoding{ "PAFF", @@ -3645,8 +3818,9 @@ const ( // Values returns all known values for H264FlickerAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264FlickerAdaptiveQuantization) Values() []H264FlickerAdaptiveQuantization { return []H264FlickerAdaptiveQuantization{ "DISABLED", @@ -3663,8 +3837,9 @@ const ( ) // Values returns all known values for H264FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264FramerateControl) Values() []H264FramerateControl { return []H264FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -3683,8 +3858,9 @@ const ( // Values returns all known values for H264FramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264FramerateConversionAlgorithm) Values() []H264FramerateConversionAlgorithm { return []H264FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -3702,8 +3878,9 @@ const ( ) // Values returns all known values for H264GopBReference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264GopBReference) Values() []H264GopBReference { return []H264GopBReference{ "DISABLED", @@ -3721,8 +3898,9 @@ const ( ) // Values returns all known values for H264GopSizeUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264GopSizeUnits) Values() []H264GopSizeUnits { return []H264GopSizeUnits{ "FRAMES", @@ -3743,8 +3921,9 @@ const ( ) // Values returns all known values for H264InterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264InterlaceMode) Values() []H264InterlaceMode { return []H264InterlaceMode{ "PROGRESSIVE", @@ -3764,8 +3943,9 @@ const ( ) // Values returns all known values for H264ParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264ParControl) Values() []H264ParControl { return []H264ParControl{ "INITIALIZE_FROM_SOURCE", @@ -3783,8 +3963,9 @@ const ( ) // Values returns all known values for H264QualityTuningLevel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264QualityTuningLevel) Values() []H264QualityTuningLevel { return []H264QualityTuningLevel{ "SINGLE_PASS", @@ -3803,8 +3984,9 @@ const ( ) // Values returns all known values for H264RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264RateControlMode) Values() []H264RateControlMode { return []H264RateControlMode{ "VBR", @@ -3822,8 +4004,9 @@ const ( ) // Values returns all known values for H264RepeatPps. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264RepeatPps) Values() []H264RepeatPps { return []H264RepeatPps{ "DISABLED", @@ -3841,6 +4024,7 @@ const ( // Values returns all known values for H264ScanTypeConversionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (H264ScanTypeConversionMode) Values() []H264ScanTypeConversionMode { return []H264ScanTypeConversionMode{ @@ -3859,8 +4043,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -3878,8 +4063,9 @@ const ( ) // Values returns all known values for H264SlowPal. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264SlowPal) Values() []H264SlowPal { return []H264SlowPal{ "DISABLED", @@ -3897,8 +4083,9 @@ const ( // Values returns all known values for H264SpatialAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264SpatialAdaptiveQuantization) Values() []H264SpatialAdaptiveQuantization { return []H264SpatialAdaptiveQuantization{ "DISABLED", @@ -3915,8 +4102,9 @@ const ( ) // Values returns all known values for H264Syntax. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264Syntax) Values() []H264Syntax { return []H264Syntax{ "DEFAULT", @@ -3934,8 +4122,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -3954,8 +4143,9 @@ const ( // Values returns all known values for H264TemporalAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264TemporalAdaptiveQuantization) Values() []H264TemporalAdaptiveQuantization { return []H264TemporalAdaptiveQuantization{ "DISABLED", @@ -3973,6 +4163,7 @@ const ( // Values returns all known values for H264UnregisteredSeiTimecode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (H264UnregisteredSeiTimecode) Values() []H264UnregisteredSeiTimecode { return []H264UnregisteredSeiTimecode{ @@ -3996,6 +4187,7 @@ const ( // 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{ @@ -4019,8 +4211,9 @@ const ( // Values returns all known values for H265AlternateTransferFunctionSei. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265AlternateTransferFunctionSei) Values() []H265AlternateTransferFunctionSei { return []H265AlternateTransferFunctionSei{ "DISABLED", @@ -4049,8 +4242,9 @@ const ( ) // Values returns all known values for H265CodecLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265CodecLevel) Values() []H265CodecLevel { return []H265CodecLevel{ "AUTO", @@ -4085,8 +4279,9 @@ const ( ) // Values returns all known values for H265CodecProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265CodecProfile) Values() []H265CodecProfile { return []H265CodecProfile{ "MAIN_MAIN", @@ -4109,8 +4304,9 @@ const ( ) // Values returns all known values for H265DynamicSubGop. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265DynamicSubGop) Values() []H265DynamicSubGop { return []H265DynamicSubGop{ "ADAPTIVE", @@ -4127,8 +4323,9 @@ const ( ) // Values returns all known values for H265EndOfStreamMarkers. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265EndOfStreamMarkers) Values() []H265EndOfStreamMarkers { return []H265EndOfStreamMarkers{ "INCLUDE", @@ -4146,8 +4343,9 @@ const ( // Values returns all known values for H265FlickerAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265FlickerAdaptiveQuantization) Values() []H265FlickerAdaptiveQuantization { return []H265FlickerAdaptiveQuantization{ "DISABLED", @@ -4164,8 +4362,9 @@ const ( ) // Values returns all known values for H265FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265FramerateControl) Values() []H265FramerateControl { return []H265FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -4184,8 +4383,9 @@ const ( // Values returns all known values for H265FramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265FramerateConversionAlgorithm) Values() []H265FramerateConversionAlgorithm { return []H265FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -4203,8 +4403,9 @@ const ( ) // Values returns all known values for H265GopBReference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265GopBReference) Values() []H265GopBReference { return []H265GopBReference{ "DISABLED", @@ -4222,8 +4423,9 @@ const ( ) // Values returns all known values for H265GopSizeUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265GopSizeUnits) Values() []H265GopSizeUnits { return []H265GopSizeUnits{ "FRAMES", @@ -4244,8 +4446,9 @@ const ( ) // Values returns all known values for H265InterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265InterlaceMode) Values() []H265InterlaceMode { return []H265InterlaceMode{ "PROGRESSIVE", @@ -4265,8 +4468,9 @@ const ( ) // Values returns all known values for H265ParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265ParControl) Values() []H265ParControl { return []H265ParControl{ "INITIALIZE_FROM_SOURCE", @@ -4284,8 +4488,9 @@ const ( ) // Values returns all known values for H265QualityTuningLevel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265QualityTuningLevel) Values() []H265QualityTuningLevel { return []H265QualityTuningLevel{ "SINGLE_PASS", @@ -4304,8 +4509,9 @@ const ( ) // Values returns all known values for H265RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265RateControlMode) Values() []H265RateControlMode { return []H265RateControlMode{ "VBR", @@ -4325,8 +4531,9 @@ const ( // Values returns all known values for H265SampleAdaptiveOffsetFilterMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265SampleAdaptiveOffsetFilterMode) Values() []H265SampleAdaptiveOffsetFilterMode { return []H265SampleAdaptiveOffsetFilterMode{ "DEFAULT", @@ -4345,6 +4552,7 @@ const ( // Values returns all known values for H265ScanTypeConversionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (H265ScanTypeConversionMode) Values() []H265ScanTypeConversionMode { return []H265ScanTypeConversionMode{ @@ -4363,8 +4571,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -4382,8 +4591,9 @@ const ( ) // Values returns all known values for H265SlowPal. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265SlowPal) Values() []H265SlowPal { return []H265SlowPal{ "DISABLED", @@ -4401,8 +4611,9 @@ const ( // Values returns all known values for H265SpatialAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265SpatialAdaptiveQuantization) Values() []H265SpatialAdaptiveQuantization { return []H265SpatialAdaptiveQuantization{ "DISABLED", @@ -4420,8 +4631,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -4440,8 +4652,9 @@ const ( // Values returns all known values for H265TemporalAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265TemporalAdaptiveQuantization) Values() []H265TemporalAdaptiveQuantization { return []H265TemporalAdaptiveQuantization{ "DISABLED", @@ -4458,8 +4671,9 @@ const ( ) // Values returns all known values for H265TemporalIds. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265TemporalIds) Values() []H265TemporalIds { return []H265TemporalIds{ "DISABLED", @@ -4476,8 +4690,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -4495,6 +4710,7 @@ const ( // Values returns all known values for H265UnregisteredSeiTimecode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (H265UnregisteredSeiTimecode) Values() []H265UnregisteredSeiTimecode { return []H265UnregisteredSeiTimecode{ @@ -4513,6 +4729,7 @@ const ( // Values returns all known values for H265WriteMp4PackagingType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (H265WriteMp4PackagingType) Values() []H265WriteMp4PackagingType { return []H265WriteMp4PackagingType{ @@ -4530,8 +4747,9 @@ const ( ) // Values returns all known values for HDRToSDRToneMapper. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HDRToSDRToneMapper) Values() []HDRToSDRToneMapper { return []HDRToSDRToneMapper{ "PRESERVE_DETAILS", @@ -4548,8 +4766,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -4566,8 +4785,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AUTOMATIC", @@ -4584,8 +4804,9 @@ const ( ) // Values returns all known values for HlsAudioOnlyHeader. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsAudioOnlyHeader) Values() []HlsAudioOnlyHeader { return []HlsAudioOnlyHeader{ "INCLUDE", @@ -4604,8 +4825,9 @@ const ( ) // Values returns all known values for HlsAudioTrackType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsAudioTrackType) Values() []HlsAudioTrackType { return []HlsAudioTrackType{ "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT", @@ -4626,6 +4848,7 @@ const ( // Values returns all known values for HlsCaptionLanguageSetting. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsCaptionLanguageSetting) Values() []HlsCaptionLanguageSetting { return []HlsCaptionLanguageSetting{ @@ -4645,8 +4868,9 @@ const ( // Values returns all known values for HlsCaptionSegmentLengthControl. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsCaptionSegmentLengthControl) Values() []HlsCaptionSegmentLengthControl { return []HlsCaptionSegmentLengthControl{ "LARGE_SEGMENTS", @@ -4663,8 +4887,9 @@ const ( ) // Values returns all known values for HlsClientCache. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsClientCache) Values() []HlsClientCache { return []HlsClientCache{ "DISABLED", @@ -4681,8 +4906,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RFC_6381", @@ -4700,8 +4926,9 @@ const ( // Values returns all known values for HlsDescriptiveVideoServiceFlag. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsDescriptiveVideoServiceFlag) Values() []HlsDescriptiveVideoServiceFlag { return []HlsDescriptiveVideoServiceFlag{ "DONT_FLAG", @@ -4718,8 +4945,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SINGLE_DIRECTORY", @@ -4736,8 +4964,9 @@ const ( ) // Values returns all known values for HlsEncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsEncryptionType) Values() []HlsEncryptionType { return []HlsEncryptionType{ "AES128", @@ -4754,8 +4983,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INCLUDE", @@ -4774,8 +5004,9 @@ const ( ) // Values returns all known values for HlsImageBasedTrickPlay. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsImageBasedTrickPlay) Values() []HlsImageBasedTrickPlay { return []HlsImageBasedTrickPlay{ "NONE", @@ -4795,8 +5026,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsInitializationVectorInManifest) Values() []HlsInitializationVectorInManifest { return []HlsInitializationVectorInManifest{ "INCLUDE", @@ -4813,8 +5045,9 @@ const ( ) // Values returns all known values for HlsIntervalCadence. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsIntervalCadence) Values() []HlsIntervalCadence { return []HlsIntervalCadence{ "FOLLOW_IFRAME", @@ -4831,8 +5064,9 @@ const ( ) // Values returns all known values for HlsKeyProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsKeyProviderType) Values() []HlsKeyProviderType { return []HlsKeyProviderType{ "SPEKE", @@ -4849,8 +5083,9 @@ const ( ) // Values returns all known values for HlsManifestCompression. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsManifestCompression) Values() []HlsManifestCompression { return []HlsManifestCompression{ "GZIP", @@ -4868,6 +5103,7 @@ const ( // Values returns all known values for HlsManifestDurationFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsManifestDurationFormat) Values() []HlsManifestDurationFormat { return []HlsManifestDurationFormat{ @@ -4885,8 +5121,9 @@ const ( ) // Values returns all known values for HlsOfflineEncrypted. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsOfflineEncrypted) Values() []HlsOfflineEncrypted { return []HlsOfflineEncrypted{ "ENABLED", @@ -4903,8 +5140,9 @@ const ( ) // Values returns all known values for HlsOutputSelection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsOutputSelection) Values() []HlsOutputSelection { return []HlsOutputSelection{ "MANIFESTS_AND_SEGMENTS", @@ -4921,8 +5159,9 @@ const ( ) // Values returns all known values for HlsProgramDateTime. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsProgramDateTime) Values() []HlsProgramDateTime { return []HlsProgramDateTime{ "INCLUDE", @@ -4940,8 +5179,9 @@ const ( // Values returns all known values for HlsProgressiveWriteHlsManifest. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsProgressiveWriteHlsManifest) Values() []HlsProgressiveWriteHlsManifest { return []HlsProgressiveWriteHlsManifest{ "ENABLED", @@ -4958,8 +5198,9 @@ const ( ) // Values returns all known values for HlsSegmentControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsSegmentControl) Values() []HlsSegmentControl { return []HlsSegmentControl{ "SINGLE_FILE", @@ -4976,8 +5217,9 @@ const ( ) // Values returns all known values for HlsSegmentLengthControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsSegmentLengthControl) Values() []HlsSegmentLengthControl { return []HlsSegmentLengthControl{ "EXACT", @@ -4994,8 +5236,9 @@ const ( ) // Values returns all known values for HlsStreamInfResolution. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsStreamInfResolution) Values() []HlsStreamInfResolution { return []HlsStreamInfResolution{ "INCLUDE", @@ -5013,8 +5256,9 @@ const ( // Values returns all known values for HlsTargetDurationCompatibilityMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsTargetDurationCompatibilityMode) Values() []HlsTargetDurationCompatibilityMode { return []HlsTargetDurationCompatibilityMode{ "LEGACY", @@ -5033,6 +5277,7 @@ const ( // 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{ @@ -5051,8 +5296,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -5069,8 +5315,9 @@ const ( ) // Values returns all known values for ImscStylePassthrough. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImscStylePassthrough) Values() []ImscStylePassthrough { return []ImscStylePassthrough{ "ENABLED", @@ -5087,8 +5334,9 @@ const ( ) // Values returns all known values for InputDeblockFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeblockFilter) Values() []InputDeblockFilter { return []InputDeblockFilter{ "ENABLED", @@ -5105,8 +5353,9 @@ const ( ) // Values returns all known values for InputDenoiseFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDenoiseFilter) Values() []InputDenoiseFilter { return []InputDenoiseFilter{ "ENABLED", @@ -5124,8 +5373,9 @@ const ( ) // Values returns all known values for InputFilterEnable. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputFilterEnable) Values() []InputFilterEnable { return []InputFilterEnable{ "AUTO", @@ -5143,8 +5393,9 @@ const ( ) // Values returns all known values for InputPolicy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputPolicy) Values() []InputPolicy { return []InputPolicy{ "ALLOWED", @@ -5161,8 +5412,9 @@ const ( ) // Values returns all known values for InputPsiControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputPsiControl) Values() []InputPsiControl { return []InputPsiControl{ "IGNORE_PSI", @@ -5182,8 +5434,9 @@ const ( ) // Values returns all known values for InputRotate. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputRotate) Values() []InputRotate { return []InputRotate{ "DEGREE_0", @@ -5204,8 +5457,9 @@ const ( ) // Values returns all known values for InputSampleRange. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputSampleRange) Values() []InputSampleRange { return []InputSampleRange{ "FOLLOW", @@ -5223,8 +5477,9 @@ const ( ) // Values returns all known values for InputScanType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputScanType) Values() []InputScanType { return []InputScanType{ "AUTO", @@ -5242,8 +5497,9 @@ const ( ) // Values returns all known values for InputTimecodeSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputTimecodeSource) Values() []InputTimecodeSource { return []InputTimecodeSource{ "EMBEDDED", @@ -5262,8 +5518,9 @@ const ( ) // Values returns all known values for JobPhase. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobPhase) Values() []JobPhase { return []JobPhase{ "PROBING", @@ -5284,8 +5541,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -5306,8 +5564,9 @@ const ( ) // Values returns all known values for JobTemplateListBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobTemplateListBy) Values() []JobTemplateListBy { return []JobTemplateListBy{ "NAME", @@ -5515,8 +5774,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -5723,8 +5983,9 @@ const ( ) // Values returns all known values for M2tsAudioBufferModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAudioBufferModel) Values() []M2tsAudioBufferModel { return []M2tsAudioBufferModel{ "DVB", @@ -5741,8 +6002,9 @@ const ( ) // Values returns all known values for M2tsAudioDuration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAudioDuration) Values() []M2tsAudioDuration { return []M2tsAudioDuration{ "DEFAULT_CODEC_DURATION", @@ -5759,8 +6021,9 @@ const ( ) // Values returns all known values for M2tsBufferModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsBufferModel) Values() []M2tsBufferModel { return []M2tsBufferModel{ "MULTIPLEX", @@ -5777,8 +6040,9 @@ const ( ) // Values returns all known values for M2tsDataPtsControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsDataPtsControl) Values() []M2tsDataPtsControl { return []M2tsDataPtsControl{ "AUTO", @@ -5795,8 +6059,9 @@ const ( ) // Values returns all known values for M2tsEbpAudioInterval. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsEbpAudioInterval) Values() []M2tsEbpAudioInterval { return []M2tsEbpAudioInterval{ "VIDEO_AND_FIXED_INTERVALS", @@ -5813,8 +6078,9 @@ const ( ) // Values returns all known values for M2tsEbpPlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsEbpPlacement) Values() []M2tsEbpPlacement { return []M2tsEbpPlacement{ "VIDEO_AND_AUDIO_PIDS", @@ -5831,8 +6097,9 @@ const ( ) // Values returns all known values for M2tsEsRateInPes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsEsRateInPes) Values() []M2tsEsRateInPes { return []M2tsEsRateInPes{ "INCLUDE", @@ -5850,6 +6117,7 @@ const ( // 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{ @@ -5867,8 +6135,9 @@ const ( ) // Values returns all known values for M2tsKlvMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsKlvMetadata) Values() []M2tsKlvMetadata { return []M2tsKlvMetadata{ "PASSTHROUGH", @@ -5885,8 +6154,9 @@ const ( ) // Values returns all known values for M2tsNielsenId3. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsNielsenId3) Values() []M2tsNielsenId3 { return []M2tsNielsenId3{ "INSERT", @@ -5903,8 +6173,9 @@ const ( ) // Values returns all known values for M2tsPcrControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsPcrControl) Values() []M2tsPcrControl { return []M2tsPcrControl{ "PCR_EVERY_PES_PACKET", @@ -5922,6 +6193,7 @@ const ( // Values returns all known values for M2tsPreventBufferUnderflow. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (M2tsPreventBufferUnderflow) Values() []M2tsPreventBufferUnderflow { return []M2tsPreventBufferUnderflow{ @@ -5939,8 +6211,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -5957,8 +6230,9 @@ const ( ) // Values returns all known values for M2tsScte35Source. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsScte35Source) Values() []M2tsScte35Source { return []M2tsScte35Source{ "PASSTHROUGH", @@ -5979,8 +6253,9 @@ const ( ) // Values returns all known values for M2tsSegmentationMarkers. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsSegmentationMarkers) Values() []M2tsSegmentationMarkers { return []M2tsSegmentationMarkers{ "NONE", @@ -6001,8 +6276,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MAINTAIN_CADENCE", @@ -6019,8 +6295,9 @@ const ( ) // Values returns all known values for M3u8AudioDuration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8AudioDuration) Values() []M3u8AudioDuration { return []M3u8AudioDuration{ "DEFAULT_CODEC_DURATION", @@ -6037,8 +6314,9 @@ const ( ) // Values returns all known values for M3u8DataPtsControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8DataPtsControl) Values() []M3u8DataPtsControl { return []M3u8DataPtsControl{ "AUTO", @@ -6055,8 +6333,9 @@ const ( ) // Values returns all known values for M3u8NielsenId3. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8NielsenId3) Values() []M3u8NielsenId3 { return []M3u8NielsenId3{ "INSERT", @@ -6073,8 +6352,9 @@ const ( ) // Values returns all known values for M3u8PcrControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8PcrControl) Values() []M3u8PcrControl { return []M3u8PcrControl{ "PCR_EVERY_PES_PACKET", @@ -6091,8 +6371,9 @@ const ( ) // Values returns all known values for M3u8Scte35Source. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8Scte35Source) Values() []M3u8Scte35Source { return []M3u8Scte35Source{ "PASSTHROUGH", @@ -6110,6 +6391,7 @@ const ( // 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{ @@ -6127,8 +6409,9 @@ const ( ) // Values returns all known values for MotionImagePlayback. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MotionImagePlayback) Values() []MotionImagePlayback { return []MotionImagePlayback{ "ONCE", @@ -6145,8 +6428,9 @@ const ( ) // Values returns all known values for MovClapAtom. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MovClapAtom) Values() []MovClapAtom { return []MovClapAtom{ "INCLUDE", @@ -6163,8 +6447,9 @@ const ( ) // Values returns all known values for MovCslgAtom. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MovCslgAtom) Values() []MovCslgAtom { return []MovCslgAtom{ "INCLUDE", @@ -6181,8 +6466,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "XDCAM", @@ -6199,8 +6485,9 @@ const ( ) // Values returns all known values for MovPaddingControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MovPaddingControl) Values() []MovPaddingControl { return []MovPaddingControl{ "OMNEON", @@ -6217,8 +6504,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -6235,8 +6523,9 @@ const ( ) // Values returns all known values for Mp3RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mp3RateControlMode) Values() []Mp3RateControlMode { return []Mp3RateControlMode{ "CBR", @@ -6253,8 +6542,9 @@ const ( ) // Values returns all known values for Mp4CslgAtom. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mp4CslgAtom) Values() []Mp4CslgAtom { return []Mp4CslgAtom{ "INCLUDE", @@ -6271,8 +6561,9 @@ const ( ) // Values returns all known values for Mp4FreeSpaceBox. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mp4FreeSpaceBox) Values() []Mp4FreeSpaceBox { return []Mp4FreeSpaceBox{ "INCLUDE", @@ -6289,8 +6580,9 @@ const ( ) // Values returns all known values for Mp4MoovPlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mp4MoovPlacement) Values() []Mp4MoovPlacement { return []Mp4MoovPlacement{ "PROGRESSIVE_DOWNLOAD", @@ -6308,8 +6600,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdAccessibilityCaptionHints) Values() []MpdAccessibilityCaptionHints { return []MpdAccessibilityCaptionHints{ "INCLUDE", @@ -6326,8 +6619,9 @@ const ( ) // Values returns all known values for MpdAudioDuration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdAudioDuration) Values() []MpdAudioDuration { return []MpdAudioDuration{ "DEFAULT_CODEC_DURATION", @@ -6344,8 +6638,9 @@ const ( ) // Values returns all known values for MpdCaptionContainerType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdCaptionContainerType) Values() []MpdCaptionContainerType { return []MpdCaptionContainerType{ "RAW", @@ -6362,8 +6657,9 @@ const ( ) // Values returns all known values for MpdKlvMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdKlvMetadata) Values() []MpdKlvMetadata { return []MpdKlvMetadata{ "NONE", @@ -6381,8 +6677,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdManifestMetadataSignaling) Values() []MpdManifestMetadataSignaling { return []MpdManifestMetadataSignaling{ "ENABLED", @@ -6399,8 +6696,9 @@ const ( ) // Values returns all known values for MpdScte35Esam. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdScte35Esam) Values() []MpdScte35Esam { return []MpdScte35Esam{ "INSERT", @@ -6417,8 +6715,9 @@ const ( ) // Values returns all known values for MpdScte35Source. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdScte35Source) Values() []MpdScte35Source { return []MpdScte35Source{ "PASSTHROUGH", @@ -6435,8 +6734,9 @@ const ( ) // Values returns all known values for MpdTimedMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MpdTimedMetadata) Values() []MpdTimedMetadata { return []MpdTimedMetadata{ "PASSTHROUGH", @@ -6454,6 +6754,7 @@ const ( // Values returns all known values for MpdTimedMetadataBoxVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MpdTimedMetadataBoxVersion) Values() []MpdTimedMetadataBoxVersion { return []MpdTimedMetadataBoxVersion{ @@ -6474,6 +6775,7 @@ const ( // Values returns all known values for Mpeg2AdaptiveQuantization. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2AdaptiveQuantization) Values() []Mpeg2AdaptiveQuantization { return []Mpeg2AdaptiveQuantization{ @@ -6496,8 +6798,9 @@ const ( ) // Values returns all known values for Mpeg2CodecLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2CodecLevel) Values() []Mpeg2CodecLevel { return []Mpeg2CodecLevel{ "AUTO", @@ -6517,8 +6820,9 @@ const ( ) // Values returns all known values for Mpeg2CodecProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2CodecProfile) Values() []Mpeg2CodecProfile { return []Mpeg2CodecProfile{ "MAIN", @@ -6535,8 +6839,9 @@ const ( ) // Values returns all known values for Mpeg2DynamicSubGop. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2DynamicSubGop) Values() []Mpeg2DynamicSubGop { return []Mpeg2DynamicSubGop{ "ADAPTIVE", @@ -6553,8 +6858,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INITIALIZE_FROM_SOURCE", @@ -6573,8 +6879,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2FramerateConversionAlgorithm) Values() []Mpeg2FramerateConversionAlgorithm { return []Mpeg2FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -6592,8 +6899,9 @@ const ( ) // Values returns all known values for Mpeg2GopSizeUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2GopSizeUnits) Values() []Mpeg2GopSizeUnits { return []Mpeg2GopSizeUnits{ "FRAMES", @@ -6613,8 +6921,9 @@ const ( ) // Values returns all known values for Mpeg2InterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2InterlaceMode) Values() []Mpeg2InterlaceMode { return []Mpeg2InterlaceMode{ "PROGRESSIVE", @@ -6637,8 +6946,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "AUTO", @@ -6658,8 +6968,9 @@ const ( ) // Values returns all known values for Mpeg2ParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2ParControl) Values() []Mpeg2ParControl { return []Mpeg2ParControl{ "INITIALIZE_FROM_SOURCE", @@ -6676,8 +6987,9 @@ const ( ) // Values returns all known values for Mpeg2QualityTuningLevel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2QualityTuningLevel) Values() []Mpeg2QualityTuningLevel { return []Mpeg2QualityTuningLevel{ "SINGLE_PASS", @@ -6694,8 +7006,9 @@ const ( ) // Values returns all known values for Mpeg2RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2RateControlMode) Values() []Mpeg2RateControlMode { return []Mpeg2RateControlMode{ "VBR", @@ -6713,6 +7026,7 @@ const ( // Values returns all known values for Mpeg2ScanTypeConversionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2ScanTypeConversionMode) Values() []Mpeg2ScanTypeConversionMode { return []Mpeg2ScanTypeConversionMode{ @@ -6730,8 +7044,9 @@ const ( ) // Values returns all known values for Mpeg2SceneChangeDetect. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2SceneChangeDetect) Values() []Mpeg2SceneChangeDetect { return []Mpeg2SceneChangeDetect{ "DISABLED", @@ -6748,8 +7063,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -6767,8 +7083,9 @@ const ( // Values returns all known values for Mpeg2SpatialAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2SpatialAdaptiveQuantization) Values() []Mpeg2SpatialAdaptiveQuantization { return []Mpeg2SpatialAdaptiveQuantization{ "DISABLED", @@ -6785,8 +7102,9 @@ const ( ) // Values returns all known values for Mpeg2Syntax. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2Syntax) Values() []Mpeg2Syntax { return []Mpeg2Syntax{ "DEFAULT", @@ -6804,8 +7122,9 @@ const ( ) // Values returns all known values for Mpeg2Telecine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2Telecine) Values() []Mpeg2Telecine { return []Mpeg2Telecine{ "NONE", @@ -6824,8 +7143,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2TemporalAdaptiveQuantization) Values() []Mpeg2TemporalAdaptiveQuantization { return []Mpeg2TemporalAdaptiveQuantization{ "DISABLED", @@ -6843,6 +7163,7 @@ const ( // Values returns all known values for MsSmoothAudioDeduplication. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MsSmoothAudioDeduplication) Values() []MsSmoothAudioDeduplication { return []MsSmoothAudioDeduplication{ @@ -6861,8 +7182,9 @@ const ( // Values returns all known values for MsSmoothFragmentLengthControl. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MsSmoothFragmentLengthControl) Values() []MsSmoothFragmentLengthControl { return []MsSmoothFragmentLengthControl{ "EXACT", @@ -6880,6 +7202,7 @@ const ( // 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{ @@ -6897,8 +7220,9 @@ const ( ) // Values returns all known values for MxfAfdSignaling. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MxfAfdSignaling) Values() []MxfAfdSignaling { return []MxfAfdSignaling{ "NO_COPY", @@ -6918,8 +7242,9 @@ const ( ) // Values returns all known values for MxfProfile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MxfProfile) Values() []MxfProfile { return []MxfProfile{ "D_10", @@ -6939,8 +7264,9 @@ const ( ) // Values returns all known values for MxfXavcDurationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MxfXavcDurationMode) Values() []MxfXavcDurationMode { return []MxfXavcDurationMode{ "ALLOW_ANY_DURATION", @@ -6959,8 +7285,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NielsenActiveWatermarkProcessType) Values() []NielsenActiveWatermarkProcessType { return []NielsenActiveWatermarkProcessType{ "NAES2_AND_NW", @@ -6979,8 +7306,9 @@ const ( // Values returns all known values for NielsenSourceWatermarkStatusType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NielsenSourceWatermarkStatusType) Values() []NielsenSourceWatermarkStatusType { return []NielsenSourceWatermarkStatusType{ "CLEAN", @@ -6998,8 +7326,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NielsenUniqueTicPerAudioTrackType) Values() []NielsenUniqueTicPerAudioTrackType { return []NielsenUniqueTicPerAudioTrackType{ "RESERVE_UNIQUE_TICS_PER_TRACK", @@ -7018,8 +7347,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NoiseFilterPostTemporalSharpening) Values() []NoiseFilterPostTemporalSharpening { return []NoiseFilterPostTemporalSharpening{ "DISABLED", @@ -7039,8 +7369,9 @@ const ( // Values returns all known values for NoiseFilterPostTemporalSharpeningStrength. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NoiseFilterPostTemporalSharpeningStrength) Values() []NoiseFilterPostTemporalSharpeningStrength { return []NoiseFilterPostTemporalSharpeningStrength{ "LOW", @@ -7064,8 +7395,9 @@ const ( ) // Values returns all known values for NoiseReducerFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NoiseReducerFilter) Values() []NoiseReducerFilter { return []NoiseReducerFilter{ "BILATERAL", @@ -7088,8 +7420,9 @@ const ( ) // 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. +// the future, and so 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{ "ASCENDING", @@ -7109,8 +7442,9 @@ const ( ) // Values returns all known values for OutputGroupType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputGroupType) Values() []OutputGroupType { return []OutputGroupType{ "HLS_GROUP_SETTINGS", @@ -7132,8 +7466,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -7152,8 +7487,9 @@ const ( ) // Values returns all known values for PadVideo. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PadVideo) Values() []PadVideo { return []PadVideo{ "DISABLED", @@ -7171,8 +7507,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -7190,8 +7527,9 @@ const ( ) // Values returns all known values for PricingPlan. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PricingPlan) Values() []PricingPlan { return []PricingPlan{ "ON_DEMAND", @@ -7208,8 +7546,9 @@ const ( ) // Values returns all known values for ProresChromaSampling. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresChromaSampling) Values() []ProresChromaSampling { return []ProresChromaSampling{ "PRESERVE_444_SAMPLING", @@ -7230,8 +7569,9 @@ const ( ) // Values returns all known values for ProresCodecProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresCodecProfile) Values() []ProresCodecProfile { return []ProresCodecProfile{ "APPLE_PRORES_422", @@ -7252,8 +7592,9 @@ const ( ) // Values returns all known values for ProresFramerateControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresFramerateControl) Values() []ProresFramerateControl { return []ProresFramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -7272,8 +7613,9 @@ const ( // Values returns all known values for ProresFramerateConversionAlgorithm. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresFramerateConversionAlgorithm) Values() []ProresFramerateConversionAlgorithm { return []ProresFramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -7294,8 +7636,9 @@ const ( ) // Values returns all known values for ProresInterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresInterlaceMode) Values() []ProresInterlaceMode { return []ProresInterlaceMode{ "PROGRESSIVE", @@ -7315,8 +7658,9 @@ const ( ) // Values returns all known values for ProresParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresParControl) Values() []ProresParControl { return []ProresParControl{ "INITIALIZE_FROM_SOURCE", @@ -7334,8 +7678,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresScanTypeConversionMode) Values() []ProresScanTypeConversionMode { return []ProresScanTypeConversionMode{ "INTERLACED", @@ -7352,8 +7697,9 @@ const ( ) // Values returns all known values for ProresSlowPal. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresSlowPal) Values() []ProresSlowPal { return []ProresSlowPal{ "DISABLED", @@ -7370,8 +7716,9 @@ const ( ) // Values returns all known values for ProresTelecine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProresTelecine) Values() []ProresTelecine { return []ProresTelecine{ "NONE", @@ -7388,8 +7735,9 @@ const ( ) // Values returns all known values for QueueListBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueListBy) Values() []QueueListBy { return []QueueListBy{ "NAME", @@ -7406,8 +7754,9 @@ const ( ) // Values returns all known values for QueueStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueStatus) Values() []QueueStatus { return []QueueStatus{ "ACTIVE", @@ -7424,8 +7773,9 @@ const ( ) // Values returns all known values for RenewalType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenewalType) Values() []RenewalType { return []RenewalType{ "AUTO_RENEW", @@ -7442,8 +7792,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -7460,8 +7811,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -7479,8 +7831,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -7500,8 +7853,9 @@ const ( ) // Values returns all known values for RuleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleType) Values() []RuleType { return []RuleType{ "MIN_TOP_RENDITION_SIZE", @@ -7522,8 +7876,9 @@ const ( ) // Values returns all known values for S3ObjectCannedAcl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ObjectCannedAcl) Values() []S3ObjectCannedAcl { return []S3ObjectCannedAcl{ "PUBLIC_READ", @@ -7543,6 +7898,7 @@ const ( // Values returns all known values for S3ServerSideEncryptionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (S3ServerSideEncryptionType) Values() []S3ServerSideEncryptionType { return []S3ServerSideEncryptionType{ @@ -7565,8 +7921,9 @@ const ( ) // Values returns all known values for S3StorageClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3StorageClass) Values() []S3StorageClass { return []S3StorageClass{ "STANDARD", @@ -7589,8 +7946,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "LIMITED_RANGE_SQUEEZE", @@ -7611,8 +7969,9 @@ const ( ) // Values returns all known values for ScalingBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingBehavior) Values() []ScalingBehavior { return []ScalingBehavior{ "DEFAULT", @@ -7635,8 +7994,9 @@ const ( ) // Values returns all known values for SccDestinationFramerate. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SccDestinationFramerate) Values() []SccDestinationFramerate { return []SccDestinationFramerate{ "FRAMERATE_23_97", @@ -7656,8 +8016,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -7674,8 +8035,9 @@ const ( ) // Values returns all known values for SrtStylePassthrough. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SrtStylePassthrough) Values() []SrtStylePassthrough { return []SrtStylePassthrough{ "ENABLED", @@ -7705,8 +8067,9 @@ const ( ) // Values returns all known values for StatusUpdateInterval. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusUpdateInterval) Values() []StatusUpdateInterval { return []StatusUpdateInterval{ "SECONDS_10", @@ -7739,8 +8102,9 @@ const ( ) // Values returns all known values for TeletextPageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TeletextPageType) Values() []TeletextPageType { return []TeletextPageType{ "PAGE_TYPE_INITIAL", @@ -7767,8 +8131,9 @@ const ( ) // Values returns all known values for TimecodeBurninPosition. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimecodeBurninPosition) Values() []TimecodeBurninPosition { return []TimecodeBurninPosition{ "TOP_CENTER", @@ -7793,8 +8158,9 @@ const ( ) // Values returns all known values for TimecodeSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimecodeSource) Values() []TimecodeSource { return []TimecodeSource{ "EMBEDDED", @@ -7812,8 +8178,9 @@ const ( ) // Values returns all known values for TimedMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimedMetadata) Values() []TimedMetadata { return []TimedMetadata{ "PASSTHROUGH", @@ -7830,8 +8197,9 @@ const ( ) // Values returns all known values for TsPtsOffset. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TsPtsOffset) Values() []TsPtsOffset { return []TsPtsOffset{ "AUTO", @@ -7848,8 +8216,9 @@ const ( ) // Values returns all known values for TtmlStylePassthrough. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TtmlStylePassthrough) Values() []TtmlStylePassthrough { return []TtmlStylePassthrough{ "ENABLED", @@ -7866,8 +8235,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "SYSTEM", @@ -7885,8 +8255,9 @@ const ( ) // Values returns all known values for UncompressedFourcc. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedFourcc) Values() []UncompressedFourcc { return []UncompressedFourcc{ "I420", @@ -7905,8 +8276,9 @@ const ( // Values returns all known values for UncompressedFramerateControl. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedFramerateControl) Values() []UncompressedFramerateControl { return []UncompressedFramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -7925,8 +8297,9 @@ const ( // Values returns all known values for UncompressedFramerateConversionAlgorithm. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedFramerateConversionAlgorithm) Values() []UncompressedFramerateConversionAlgorithm { return []UncompressedFramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -7945,6 +8318,7 @@ const ( // Values returns all known values for UncompressedInterlaceMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedInterlaceMode) Values() []UncompressedInterlaceMode { return []UncompressedInterlaceMode{ @@ -7963,8 +8337,9 @@ const ( // Values returns all known values for UncompressedScanTypeConversionMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedScanTypeConversionMode) Values() []UncompressedScanTypeConversionMode { return []UncompressedScanTypeConversionMode{ "INTERLACED", @@ -7981,8 +8356,9 @@ const ( ) // Values returns all known values for UncompressedSlowPal. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedSlowPal) Values() []UncompressedSlowPal { return []UncompressedSlowPal{ "DISABLED", @@ -7999,8 +8375,9 @@ const ( ) // Values returns all known values for UncompressedTelecine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UncompressedTelecine) Values() []UncompressedTelecine { return []UncompressedTelecine{ "NONE", @@ -8018,8 +8395,9 @@ const ( ) // Values returns all known values for Vc3Class. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vc3Class) Values() []Vc3Class { return []Vc3Class{ "CLASS_145_8BIT", @@ -8037,8 +8415,9 @@ const ( ) // Values returns all known values for Vc3FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vc3FramerateControl) Values() []Vc3FramerateControl { return []Vc3FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -8057,8 +8436,9 @@ const ( // Values returns all known values for Vc3FramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vc3FramerateConversionAlgorithm) Values() []Vc3FramerateConversionAlgorithm { return []Vc3FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -8076,8 +8456,9 @@ const ( ) // Values returns all known values for Vc3InterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vc3InterlaceMode) Values() []Vc3InterlaceMode { return []Vc3InterlaceMode{ "INTERLACED", @@ -8095,6 +8476,7 @@ const ( // Values returns all known values for Vc3ScanTypeConversionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Vc3ScanTypeConversionMode) Values() []Vc3ScanTypeConversionMode { return []Vc3ScanTypeConversionMode{ @@ -8112,8 +8494,9 @@ const ( ) // Values returns all known values for Vc3SlowPal. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vc3SlowPal) Values() []Vc3SlowPal { return []Vc3SlowPal{ "DISABLED", @@ -8130,8 +8513,9 @@ const ( ) // Values returns all known values for Vc3Telecine. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vc3Telecine) Values() []Vc3Telecine { return []Vc3Telecine{ "NONE", @@ -8148,8 +8532,9 @@ const ( ) // Values returns all known values for VchipAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VchipAction) Values() []VchipAction { return []VchipAction{ "PASSTHROUGH", @@ -8177,8 +8562,9 @@ const ( ) // Values returns all known values for VideoCodec. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoCodec) Values() []VideoCodec { return []VideoCodec{ "AV1", @@ -8206,8 +8592,9 @@ const ( ) // Values returns all known values for VideoTimecodeInsertion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoTimecodeInsertion) Values() []VideoTimecodeInsertion { return []VideoTimecodeInsertion{ "DISABLED", @@ -8224,8 +8611,9 @@ const ( ) // Values returns all known values for Vp8FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp8FramerateControl) Values() []Vp8FramerateControl { return []Vp8FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -8244,8 +8632,9 @@ const ( // Values returns all known values for Vp8FramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp8FramerateConversionAlgorithm) Values() []Vp8FramerateConversionAlgorithm { return []Vp8FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -8263,8 +8652,9 @@ const ( ) // Values returns all known values for Vp8ParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp8ParControl) Values() []Vp8ParControl { return []Vp8ParControl{ "INITIALIZE_FROM_SOURCE", @@ -8281,8 +8671,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MULTI_PASS", @@ -8298,8 +8689,9 @@ const ( ) // Values returns all known values for Vp8RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp8RateControlMode) Values() []Vp8RateControlMode { return []Vp8RateControlMode{ "VBR", @@ -8315,8 +8707,9 @@ const ( ) // Values returns all known values for Vp9FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp9FramerateControl) Values() []Vp9FramerateControl { return []Vp9FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -8335,8 +8728,9 @@ const ( // Values returns all known values for Vp9FramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp9FramerateConversionAlgorithm) Values() []Vp9FramerateConversionAlgorithm { return []Vp9FramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -8354,8 +8748,9 @@ const ( ) // Values returns all known values for Vp9ParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp9ParControl) Values() []Vp9ParControl { return []Vp9ParControl{ "INITIALIZE_FROM_SOURCE", @@ -8372,8 +8767,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MULTI_PASS", @@ -8389,8 +8785,9 @@ const ( ) // Values returns all known values for Vp9RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Vp9RateControlMode) Values() []Vp9RateControlMode { return []Vp9RateControlMode{ "VBR", @@ -8409,8 +8806,9 @@ const ( ) // Values returns all known values for WatermarkingStrength. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WatermarkingStrength) Values() []WatermarkingStrength { return []WatermarkingStrength{ "LIGHTEST", @@ -8430,8 +8828,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -8448,8 +8847,9 @@ const ( ) // Values returns all known values for WebvttAccessibilitySubs. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebvttAccessibilitySubs) Values() []WebvttAccessibilitySubs { return []WebvttAccessibilitySubs{ "DISABLED", @@ -8467,8 +8867,9 @@ const ( ) // Values returns all known values for WebvttStylePassthrough. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebvttStylePassthrough) Values() []WebvttStylePassthrough { return []WebvttStylePassthrough{ "ENABLED", @@ -8488,6 +8889,7 @@ const ( // Values returns all known values for Xavc4kIntraCbgProfileClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Xavc4kIntraCbgProfileClass) Values() []Xavc4kIntraCbgProfileClass { return []Xavc4kIntraCbgProfileClass{ @@ -8508,6 +8910,7 @@ const ( // Values returns all known values for Xavc4kIntraVbrProfileClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Xavc4kIntraVbrProfileClass) Values() []Xavc4kIntraVbrProfileClass { return []Xavc4kIntraVbrProfileClass{ @@ -8528,6 +8931,7 @@ const ( // Values returns all known values for Xavc4kProfileBitrateClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Xavc4kProfileBitrateClass) Values() []Xavc4kProfileBitrateClass { return []Xavc4kProfileBitrateClass{ @@ -8547,6 +8951,7 @@ const ( // Values returns all known values for Xavc4kProfileCodecProfile. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Xavc4kProfileCodecProfile) Values() []Xavc4kProfileCodecProfile { return []Xavc4kProfileCodecProfile{ @@ -8566,8 +8971,9 @@ const ( // Values returns all known values for Xavc4kProfileQualityTuningLevel. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Xavc4kProfileQualityTuningLevel) Values() []Xavc4kProfileQualityTuningLevel { return []Xavc4kProfileQualityTuningLevel{ "SINGLE_PASS", @@ -8591,6 +8997,7 @@ const ( // 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{ @@ -8614,8 +9021,9 @@ const ( ) // Values returns all known values for XavcEntropyEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcEntropyEncoding) Values() []XavcEntropyEncoding { return []XavcEntropyEncoding{ "AUTO", @@ -8634,8 +9042,9 @@ const ( // Values returns all known values for XavcFlickerAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcFlickerAdaptiveQuantization) Values() []XavcFlickerAdaptiveQuantization { return []XavcFlickerAdaptiveQuantization{ "DISABLED", @@ -8652,8 +9061,9 @@ const ( ) // Values returns all known values for XavcFramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcFramerateControl) Values() []XavcFramerateControl { return []XavcFramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -8672,8 +9082,9 @@ const ( // Values returns all known values for XavcFramerateConversionAlgorithm. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcFramerateConversionAlgorithm) Values() []XavcFramerateConversionAlgorithm { return []XavcFramerateConversionAlgorithm{ "DUPLICATE_DROP", @@ -8691,8 +9102,9 @@ const ( ) // Values returns all known values for XavcGopBReference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcGopBReference) Values() []XavcGopBReference { return []XavcGopBReference{ "DISABLED", @@ -8711,6 +9123,7 @@ const ( // Values returns all known values for XavcHdIntraCbgProfileClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (XavcHdIntraCbgProfileClass) Values() []XavcHdIntraCbgProfileClass { return []XavcHdIntraCbgProfileClass{ @@ -8731,6 +9144,7 @@ const ( // Values returns all known values for XavcHdProfileBitrateClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (XavcHdProfileBitrateClass) Values() []XavcHdProfileBitrateClass { return []XavcHdProfileBitrateClass{ @@ -8751,8 +9165,9 @@ const ( // Values returns all known values for XavcHdProfileQualityTuningLevel. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcHdProfileQualityTuningLevel) Values() []XavcHdProfileQualityTuningLevel { return []XavcHdProfileQualityTuningLevel{ "SINGLE_PASS", @@ -8770,8 +9185,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NONE", @@ -8791,8 +9207,9 @@ const ( ) // Values returns all known values for XavcInterlaceMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcInterlaceMode) Values() []XavcInterlaceMode { return []XavcInterlaceMode{ "PROGRESSIVE", @@ -8815,8 +9232,9 @@ const ( ) // Values returns all known values for XavcProfile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcProfile) Values() []XavcProfile { return []XavcProfile{ "XAVC_HD_INTRA_CBG", @@ -8836,8 +9254,9 @@ const ( ) // Values returns all known values for XavcSlowPal. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcSlowPal) Values() []XavcSlowPal { return []XavcSlowPal{ "DISABLED", @@ -8855,8 +9274,9 @@ const ( // Values returns all known values for XavcSpatialAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcSpatialAdaptiveQuantization) Values() []XavcSpatialAdaptiveQuantization { return []XavcSpatialAdaptiveQuantization{ "DISABLED", @@ -8874,8 +9294,9 @@ const ( // Values returns all known values for XavcTemporalAdaptiveQuantization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (XavcTemporalAdaptiveQuantization) Values() []XavcTemporalAdaptiveQuantization { return []XavcTemporalAdaptiveQuantization{ "DISABLED", diff --git a/service/mediaconvert/types/types.go b/service/mediaconvert/types/types.go index f49cb091a19..539865b103b 100644 --- a/service/mediaconvert/types/types.go +++ b/service/mediaconvert/types/types.go @@ -1877,6 +1877,7 @@ 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 @@ -2251,6 +2252,7 @@ type Deinterlacer struct { // Use Deinterlacer to choose how the service will do deinterlacing. Default is // Deinterlace. + // // - Deinterlace converts interlaced to progressive. // - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. // - Adaptive auto-detects and converts to progressive. @@ -4583,6 +4585,7 @@ type Input struct { // Set PSI control for transport stream inputs to specify which data the demux // process to scans. + // // - Ignore PSI - Scan all PIDs for audio and video. // - Use PSI - Scan only PSI data. PsiControl InputPsiControl @@ -4802,6 +4805,7 @@ type InputTemplate struct { // Set PSI control for transport stream inputs to specify which data the demux // process to scans. + // // - Ignore PSI - Scan all PIDs for audio and video. // - Use PSI - Scan only PSI data. PsiControl InputPsiControl @@ -8104,6 +8108,7 @@ 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 diff --git a/service/medialive/api_op_DescribeChannel.go b/service/medialive/api_op_DescribeChannel.go index a3a8e84dac2..0948a326bb1 100644 --- a/service/medialive/api_op_DescribeChannel.go +++ b/service/medialive/api_op_DescribeChannel.go @@ -228,12 +228,13 @@ type ChannelCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } @@ -441,12 +442,13 @@ type ChannelDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } @@ -637,12 +639,13 @@ type ChannelRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } @@ -833,12 +836,13 @@ type ChannelStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } diff --git a/service/medialive/api_op_DescribeInput.go b/service/medialive/api_op_DescribeInput.go index 8d59cb44b47..bfbde8c0495 100644 --- a/service/medialive/api_op_DescribeInput.go +++ b/service/medialive/api_op_DescribeInput.go @@ -228,12 +228,13 @@ type InputAttachedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInputInput, *DescribeInputOutput, error) (bool, error) } @@ -424,12 +425,13 @@ type InputDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInputInput, *DescribeInputOutput, error) (bool, error) } @@ -619,12 +621,13 @@ type InputDetachedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInputInput, *DescribeInputOutput, error) (bool, error) } diff --git a/service/medialive/api_op_DescribeMultiplex.go b/service/medialive/api_op_DescribeMultiplex.go index 2a2a6d4fe84..d2fe196bd83 100644 --- a/service/medialive/api_op_DescribeMultiplex.go +++ b/service/medialive/api_op_DescribeMultiplex.go @@ -201,12 +201,13 @@ type MultiplexCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeMultiplexInput, *DescribeMultiplexOutput, error) (bool, error) } @@ -414,12 +415,13 @@ type MultiplexDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeMultiplexInput, *DescribeMultiplexOutput, error) (bool, error) } @@ -610,12 +612,13 @@ type MultiplexRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeMultiplexInput, *DescribeMultiplexOutput, error) (bool, error) } @@ -806,12 +809,13 @@ type MultiplexStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeMultiplexInput, *DescribeMultiplexOutput, error) (bool, error) } diff --git a/service/medialive/api_op_GetSignalMap.go b/service/medialive/api_op_GetSignalMap.go index 5fa2e0aa22e..bbc458523cd 100644 --- a/service/medialive/api_op_GetSignalMap.go +++ b/service/medialive/api_op_GetSignalMap.go @@ -227,12 +227,13 @@ type SignalMapCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetSignalMapInput, *GetSignalMapOutput, error) (bool, error) } @@ -435,12 +436,13 @@ type SignalMapMonitorDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetSignalMapInput, *GetSignalMapOutput, error) (bool, error) } @@ -643,12 +645,13 @@ type SignalMapMonitorDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetSignalMapInput, *GetSignalMapOutput, error) (bool, error) } @@ -900,12 +903,13 @@ type SignalMapUpdatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetSignalMapInput, *GetSignalMapOutput, error) (bool, error) } diff --git a/service/medialive/options.go b/service/medialive/options.go index ec81cc5dee8..2d3ebb9d940 100644 --- a/service/medialive/options.go +++ b/service/medialive/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/medialive/types/enums.go b/service/medialive/types/enums.go index c2ea1239382..a3686e0ae3e 100644 --- a/service/medialive/types/enums.go +++ b/service/medialive/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AacCodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacCodingMode) Values() []AacCodingMode { return []AacCodingMode{ "AD_RECEIVER_MIX", @@ -35,8 +36,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for AacProfile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacProfile) Values() []AacProfile { return []AacProfile{ "HEV1", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for AacRateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacRateControlMode) Values() []AacRateControlMode { return []AacRateControlMode{ "CBR", @@ -91,8 +95,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for AacSpec. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacSpec) Values() []AacSpec { return []AacSpec{ "MPEG2", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for AacVbrQuality. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AacVbrQuality) Values() []AacVbrQuality { return []AacVbrQuality{ "HIGH", @@ -149,8 +156,9 @@ const ( ) // Values returns all known values for Ac3AttenuationControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3AttenuationControl) Values() []Ac3AttenuationControl { return []Ac3AttenuationControl{ "ATTENUATE_3_DB", @@ -173,8 +181,9 @@ const ( ) // Values returns all known values for Ac3BitstreamMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3BitstreamMode) Values() []Ac3BitstreamMode { return []Ac3BitstreamMode{ "COMMENTARY", @@ -199,8 +208,9 @@ const ( ) // Values returns all known values for Ac3CodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3CodingMode) Values() []Ac3CodingMode { return []Ac3CodingMode{ "CODING_MODE_1_0", @@ -219,8 +229,9 @@ const ( ) // Values returns all known values for Ac3DrcProfile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3DrcProfile) Values() []Ac3DrcProfile { return []Ac3DrcProfile{ "FILM_STANDARD", @@ -237,8 +248,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -255,8 +267,9 @@ const ( ) // Values returns all known values for Ac3MetadataControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Ac3MetadataControl) Values() []Ac3MetadataControl { return []Ac3MetadataControl{ "FOLLOW_INPUT", @@ -272,8 +285,9 @@ const ( ) // 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. +// expanded in the future, and so 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,8 +303,9 @@ const ( ) // Values returns all known values for AccessibilityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessibilityType) Values() []AccessibilityType { return []AccessibilityType{ "DOES_NOT_IMPLEMENT_ACCESSIBILITY_FEATURES", @@ -308,8 +323,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -328,8 +344,9 @@ const ( // Values returns all known values for AudioDescriptionAudioTypeControl. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioDescriptionAudioTypeControl) Values() []AudioDescriptionAudioTypeControl { return []AudioDescriptionAudioTypeControl{ "FOLLOW_INPUT", @@ -347,8 +364,9 @@ const ( // Values returns all known values for AudioDescriptionLanguageCodeControl. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioDescriptionLanguageCodeControl) Values() []AudioDescriptionLanguageCodeControl { return []AudioDescriptionLanguageCodeControl{ "FOLLOW_INPUT", @@ -366,8 +384,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioLanguageSelectionPolicy) Values() []AudioLanguageSelectionPolicy { return []AudioLanguageSelectionPolicy{ "LOOSE", @@ -385,6 +404,7 @@ const ( // Values returns all known values for AudioNormalizationAlgorithm. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AudioNormalizationAlgorithm) Values() []AudioNormalizationAlgorithm { return []AudioNormalizationAlgorithm{ @@ -402,8 +422,9 @@ const ( // Values returns all known values for AudioNormalizationAlgorithmControl. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioNormalizationAlgorithmControl) Values() []AudioNormalizationAlgorithmControl { return []AudioNormalizationAlgorithmControl{ "CORRECT_AUDIO", @@ -419,8 +440,9 @@ const ( ) // Values returns all known values for AudioOnlyHlsSegmentType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AudioOnlyHlsSegmentType) Values() []AudioOnlyHlsSegmentType { return []AudioOnlyHlsSegmentType{ "AAC", @@ -439,8 +461,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ALTERNATE_AUDIO_AUTO_SELECT", @@ -461,8 +484,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -481,8 +505,9 @@ const ( ) // Values returns all known values for AuthenticationScheme. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationScheme) Values() []AuthenticationScheme { return []AuthenticationScheme{ "AKAMAI", @@ -499,8 +524,9 @@ const ( ) // Values returns all known values for AvailBlankingState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvailBlankingState) Values() []AvailBlankingState { return []AvailBlankingState{ "DISABLED", @@ -518,8 +544,9 @@ const ( // Values returns all known values for BlackoutSlateNetworkEndBlackout. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlackoutSlateNetworkEndBlackout) Values() []BlackoutSlateNetworkEndBlackout { return []BlackoutSlateNetworkEndBlackout{ "DISABLED", @@ -536,8 +563,9 @@ const ( ) // Values returns all known values for BlackoutSlateState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlackoutSlateState) Values() []BlackoutSlateState { return []BlackoutSlateState{ "DISABLED", @@ -555,8 +583,9 @@ const ( ) // Values returns all known values for BurnInAlignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurnInAlignment) Values() []BurnInAlignment { return []BurnInAlignment{ "CENTERED", @@ -575,8 +604,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "BLACK", @@ -598,8 +628,9 @@ const ( ) // Values returns all known values for BurnInFontColor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurnInFontColor) Values() []BurnInFontColor { return []BurnInFontColor{ "BLACK", @@ -624,8 +655,9 @@ const ( ) // Values returns all known values for BurnInOutlineColor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurnInOutlineColor) Values() []BurnInOutlineColor { return []BurnInOutlineColor{ "BLACK", @@ -647,8 +679,9 @@ const ( ) // Values returns all known values for BurnInShadowColor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BurnInShadowColor) Values() []BurnInShadowColor { return []BurnInShadowColor{ "BLACK", @@ -667,6 +700,7 @@ const ( // Values returns all known values for BurnInTeletextGridControl. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BurnInTeletextGridControl) Values() []BurnInTeletextGridControl { return []BurnInTeletextGridControl{ @@ -686,8 +720,9 @@ const ( ) // Values returns all known values for CdiInputResolution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CdiInputResolution) Values() []CdiInputResolution { return []CdiInputResolution{ "SD", @@ -706,8 +741,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -725,6 +761,7 @@ const ( // Values returns all known values for ChannelPipelineIdToRestart. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ChannelPipelineIdToRestart) Values() []ChannelPipelineIdToRestart { return []ChannelPipelineIdToRestart{ @@ -751,8 +788,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -781,8 +819,9 @@ const ( // Values returns all known values for CloudWatchAlarmTemplateComparisonOperator. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchAlarmTemplateComparisonOperator) Values() []CloudWatchAlarmTemplateComparisonOperator { return []CloudWatchAlarmTemplateComparisonOperator{ "GreaterThanOrEqualToThreshold", @@ -805,8 +844,9 @@ const ( // Values returns all known values for CloudWatchAlarmTemplateStatistic. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchAlarmTemplateStatistic) Values() []CloudWatchAlarmTemplateStatistic { return []CloudWatchAlarmTemplateStatistic{ "SampleCount", @@ -833,8 +873,9 @@ const ( // Values returns all known values for CloudWatchAlarmTemplateTargetResourceType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchAlarmTemplateTargetResourceType) Values() []CloudWatchAlarmTemplateTargetResourceType { return []CloudWatchAlarmTemplateTargetResourceType{ "CLOUDFRONT_DISTRIBUTION", @@ -860,8 +901,9 @@ const ( // Values returns all known values for CloudWatchAlarmTemplateTreatMissingData. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchAlarmTemplateTreatMissingData) Values() []CloudWatchAlarmTemplateTreatMissingData { return []CloudWatchAlarmTemplateTreatMissingData{ "notBreaching", @@ -881,8 +923,9 @@ const ( // Values returns all known values for CmafIngestSegmentLengthUnits. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafIngestSegmentLengthUnits) Values() []CmafIngestSegmentLengthUnits { return []CmafIngestSegmentLengthUnits{ "MILLISECONDS", @@ -899,8 +942,9 @@ const ( ) // Values returns all known values for CmafNielsenId3Behavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafNielsenId3Behavior) Values() []CmafNielsenId3Behavior { return []CmafNielsenId3Behavior{ "NO_PASSTHROUGH", @@ -919,8 +963,9 @@ const ( ) // Values returns all known values for ColorSpace. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColorSpace) Values() []ColorSpace { return []ColorSpace{ "HDR10", @@ -938,8 +983,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "image/jpeg", @@ -962,8 +1008,9 @@ const ( ) // Values returns all known values for DashRoleAudio. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashRoleAudio) Values() []DashRoleAudio { return []DashRoleAudio{ "ALTERNATE", @@ -998,8 +1045,9 @@ const ( ) // Values returns all known values for DashRoleCaption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashRoleCaption) Values() []DashRoleCaption { return []DashRoleCaption{ "ALTERNATE", @@ -1027,8 +1075,9 @@ const ( ) // Values returns all known values for DeviceSettingsSyncState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceSettingsSyncState) Values() []DeviceSettingsSyncState { return []DeviceSettingsSyncState{ "SYNCED", @@ -1046,8 +1095,9 @@ const ( ) // Values returns all known values for DeviceUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceUpdateStatus) Values() []DeviceUpdateStatus { return []DeviceUpdateStatus{ "UP_TO_DATE", @@ -1072,8 +1122,9 @@ const ( ) // Values returns all known values for DolbyEProgramSelection. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DolbyEProgramSelection) Values() []DolbyEProgramSelection { return []DolbyEProgramSelection{ "ALL_CHANNELS", @@ -1102,8 +1153,9 @@ const ( ) // Values returns all known values for DvbDashAccessibility. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbDashAccessibility) Values() []DvbDashAccessibility { return []DvbDashAccessibility{ "DVBDASH_1_VISUALLY_IMPAIRED", @@ -1127,8 +1179,9 @@ const ( ) // Values returns all known values for DvbSdtOutputSdt. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSdtOutputSdt) Values() []DvbSdtOutputSdt { return []DvbSdtOutputSdt{ "SDT_FOLLOW", @@ -1149,6 +1202,7 @@ const ( // Values returns all known values for DvbSubDestinationAlignment. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubDestinationAlignment) Values() []DvbSubDestinationAlignment { return []DvbSubDestinationAlignment{ @@ -1169,8 +1223,9 @@ const ( // Values returns all known values for DvbSubDestinationBackgroundColor. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubDestinationBackgroundColor) Values() []DvbSubDestinationBackgroundColor { return []DvbSubDestinationBackgroundColor{ "BLACK", @@ -1193,6 +1248,7 @@ const ( // Values returns all known values for DvbSubDestinationFontColor. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubDestinationFontColor) Values() []DvbSubDestinationFontColor { return []DvbSubDestinationFontColor{ @@ -1219,8 +1275,9 @@ const ( // Values returns all known values for DvbSubDestinationOutlineColor. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubDestinationOutlineColor) Values() []DvbSubDestinationOutlineColor { return []DvbSubDestinationOutlineColor{ "BLACK", @@ -1243,8 +1300,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubDestinationShadowColor) Values() []DvbSubDestinationShadowColor { return []DvbSubDestinationShadowColor{ "BLACK", @@ -1263,8 +1321,9 @@ const ( // Values returns all known values for DvbSubDestinationTeletextGridControl. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubDestinationTeletextGridControl) Values() []DvbSubDestinationTeletextGridControl { return []DvbSubDestinationTeletextGridControl{ "FIXED", @@ -1285,8 +1344,9 @@ const ( ) // Values returns all known values for DvbSubOcrLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DvbSubOcrLanguage) Values() []DvbSubOcrLanguage { return []DvbSubOcrLanguage{ "DEU", @@ -1308,8 +1368,9 @@ const ( ) // Values returns all known values for Eac3AtmosCodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosCodingMode) Values() []Eac3AtmosCodingMode { return []Eac3AtmosCodingMode{ "CODING_MODE_5_1_4", @@ -1331,8 +1392,9 @@ const ( ) // Values returns all known values for Eac3AtmosDrcLine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDrcLine) Values() []Eac3AtmosDrcLine { return []Eac3AtmosDrcLine{ "FILM_LIGHT", @@ -1357,8 +1419,9 @@ const ( ) // Values returns all known values for Eac3AtmosDrcRf. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AtmosDrcRf) Values() []Eac3AtmosDrcRf { return []Eac3AtmosDrcRf{ "FILM_LIGHT", @@ -1379,8 +1442,9 @@ const ( ) // Values returns all known values for Eac3AttenuationControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3AttenuationControl) Values() []Eac3AttenuationControl { return []Eac3AttenuationControl{ "ATTENUATE_3_DB", @@ -1400,8 +1464,9 @@ const ( ) // Values returns all known values for Eac3BitstreamMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3BitstreamMode) Values() []Eac3BitstreamMode { return []Eac3BitstreamMode{ "COMMENTARY", @@ -1422,8 +1487,9 @@ const ( ) // Values returns all known values for Eac3CodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3CodingMode) Values() []Eac3CodingMode { return []Eac3CodingMode{ "CODING_MODE_1_0", @@ -1441,8 +1507,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1463,8 +1530,9 @@ const ( ) // Values returns all known values for Eac3DrcLine. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3DrcLine) Values() []Eac3DrcLine { return []Eac3DrcLine{ "FILM_LIGHT", @@ -1489,8 +1557,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1511,8 +1580,9 @@ const ( ) // Values returns all known values for Eac3LfeControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3LfeControl) Values() []Eac3LfeControl { return []Eac3LfeControl{ "LFE", @@ -1529,8 +1599,9 @@ const ( ) // Values returns all known values for Eac3LfeFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3LfeFilter) Values() []Eac3LfeFilter { return []Eac3LfeFilter{ "DISABLED", @@ -1547,8 +1618,9 @@ const ( ) // Values returns all known values for Eac3MetadataControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3MetadataControl) Values() []Eac3MetadataControl { return []Eac3MetadataControl{ "FOLLOW_INPUT", @@ -1565,8 +1637,9 @@ const ( ) // Values returns all known values for Eac3PassthroughControl. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3PassthroughControl) Values() []Eac3PassthroughControl { return []Eac3PassthroughControl{ "NO_PASSTHROUGH", @@ -1583,8 +1656,9 @@ const ( ) // Values returns all known values for Eac3PhaseControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3PhaseControl) Values() []Eac3PhaseControl { return []Eac3PhaseControl{ "NO_SHIFT", @@ -1603,8 +1677,9 @@ const ( ) // Values returns all known values for Eac3StereoDownmix. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3StereoDownmix) Values() []Eac3StereoDownmix { return []Eac3StereoDownmix{ "DPL2", @@ -1624,8 +1699,9 @@ const ( ) // Values returns all known values for Eac3SurroundExMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3SurroundExMode) Values() []Eac3SurroundExMode { return []Eac3SurroundExMode{ "DISABLED", @@ -1644,8 +1720,9 @@ const ( ) // Values returns all known values for Eac3SurroundMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Eac3SurroundMode) Values() []Eac3SurroundMode { return []Eac3SurroundMode{ "DISABLED", @@ -1664,8 +1741,9 @@ const ( // Values returns all known values for EbuTtDDestinationStyleControl. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EbuTtDDestinationStyleControl) Values() []EbuTtDDestinationStyleControl { return []EbuTtDDestinationStyleControl{ "EXCLUDE", @@ -1683,6 +1761,7 @@ const ( // 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{ @@ -1700,8 +1779,9 @@ const ( ) // Values returns all known values for EmbeddedConvert608To708. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmbeddedConvert608To708) Values() []EmbeddedConvert608To708 { return []EmbeddedConvert608To708{ "DISABLED", @@ -1718,8 +1798,9 @@ const ( ) // Values returns all known values for EmbeddedScte20Detection. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmbeddedScte20Detection) Values() []EmbeddedScte20Detection { return []EmbeddedScte20Detection{ "AUTO", @@ -1748,8 +1829,9 @@ const ( // Values returns all known values for EventBridgeRuleTemplateEventType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EventBridgeRuleTemplateEventType) Values() []EventBridgeRuleTemplateEventType { return []EventBridgeRuleTemplateEventType{ "MEDIALIVE_MULTIPLEX_ALERT", @@ -1778,8 +1860,9 @@ const ( // Values returns all known values for // FeatureActivationsInputPrepareScheduleActions. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureActivationsInputPrepareScheduleActions) Values() []FeatureActivationsInputPrepareScheduleActions { return []FeatureActivationsInputPrepareScheduleActions{ "DISABLED", @@ -1797,8 +1880,9 @@ const ( // Values returns all known values for // FeatureActivationsOutputStaticImageOverlayScheduleActions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureActivationsOutputStaticImageOverlayScheduleActions) Values() []FeatureActivationsOutputStaticImageOverlayScheduleActions { return []FeatureActivationsOutputStaticImageOverlayScheduleActions{ "DISABLED", @@ -1815,8 +1899,9 @@ const ( ) // Values returns all known values for FecOutputIncludeFec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FecOutputIncludeFec) Values() []FecOutputIncludeFec { return []FecOutputIncludeFec{ "COLUMN", @@ -1842,8 +1927,9 @@ const ( ) // Values returns all known values for FixedAfd. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FixedAfd) Values() []FixedAfd { return []FixedAfd{ "AFD_0000", @@ -1869,8 +1955,9 @@ const ( ) // Values returns all known values for Fmp4NielsenId3Behavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Fmp4NielsenId3Behavior) Values() []Fmp4NielsenId3Behavior { return []Fmp4NielsenId3Behavior{ "NO_PASSTHROUGH", @@ -1888,6 +1975,7 @@ const ( // Values returns all known values for Fmp4TimedMetadataBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Fmp4TimedMetadataBehavior) Values() []Fmp4TimedMetadataBehavior { return []Fmp4TimedMetadataBehavior{ @@ -1905,8 +1993,9 @@ const ( ) // Values returns all known values for FollowPoint. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FollowPoint) Values() []FollowPoint { return []FollowPoint{ "END", @@ -1924,6 +2013,7 @@ const ( // 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{ @@ -1942,8 +2032,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalConfigurationInputEndAction) Values() []GlobalConfigurationInputEndAction { return []GlobalConfigurationInputEndAction{ "NONE", @@ -1961,8 +2052,9 @@ const ( // Values returns all known values for GlobalConfigurationLowFramerateInputs. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalConfigurationLowFramerateInputs) Values() []GlobalConfigurationLowFramerateInputs { return []GlobalConfigurationLowFramerateInputs{ "DISABLED", @@ -1980,8 +2072,9 @@ const ( // Values returns all known values for GlobalConfigurationOutputLockingMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalConfigurationOutputLockingMode) Values() []GlobalConfigurationOutputLockingMode { return []GlobalConfigurationOutputLockingMode{ "EPOCH_LOCKING", @@ -1999,8 +2092,9 @@ const ( // Values returns all known values for GlobalConfigurationOutputTimingSource. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalConfigurationOutputTimingSource) Values() []GlobalConfigurationOutputTimingSource { return []GlobalConfigurationOutputTimingSource{ "INPUT_CLOCK", @@ -2023,6 +2117,7 @@ const ( // 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{ @@ -2045,8 +2140,9 @@ const ( ) // Values returns all known values for H264ColorMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264ColorMetadata) Values() []H264ColorMetadata { return []H264ColorMetadata{ "IGNORE", @@ -2063,8 +2159,9 @@ const ( ) // Values returns all known values for H264EntropyEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264EntropyEncoding) Values() []H264EntropyEncoding { return []H264EntropyEncoding{ "CABAC", @@ -2081,8 +2178,9 @@ const ( ) // Values returns all known values for H264FlickerAq. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264FlickerAq) Values() []H264FlickerAq { return []H264FlickerAq{ "DISABLED", @@ -2099,8 +2197,9 @@ const ( ) // Values returns all known values for H264ForceFieldPictures. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264ForceFieldPictures) Values() []H264ForceFieldPictures { return []H264ForceFieldPictures{ "DISABLED", @@ -2117,8 +2216,9 @@ const ( ) // Values returns all known values for H264FramerateControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264FramerateControl) Values() []H264FramerateControl { return []H264FramerateControl{ "INITIALIZE_FROM_SOURCE", @@ -2135,8 +2235,9 @@ const ( ) // Values returns all known values for H264GopBReference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264GopBReference) Values() []H264GopBReference { return []H264GopBReference{ "DISABLED", @@ -2153,8 +2254,9 @@ const ( ) // Values returns all known values for H264GopSizeUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264GopSizeUnits) Values() []H264GopSizeUnits { return []H264GopSizeUnits{ "FRAMES", @@ -2186,8 +2288,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2221,6 +2324,7 @@ const ( // 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{ @@ -2239,8 +2343,9 @@ const ( ) // Values returns all known values for H264ParControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264ParControl) Values() []H264ParControl { return []H264ParControl{ "INITIALIZE_FROM_SOURCE", @@ -2261,8 +2366,9 @@ const ( ) // Values returns all known values for H264Profile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264Profile) Values() []H264Profile { return []H264Profile{ "BASELINE", @@ -2283,8 +2389,9 @@ const ( ) // Values returns all known values for H264QualityLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264QualityLevel) Values() []H264QualityLevel { return []H264QualityLevel{ "ENHANCED_QUALITY", @@ -2303,8 +2410,9 @@ const ( ) // Values returns all known values for H264RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264RateControlMode) Values() []H264RateControlMode { return []H264RateControlMode{ "CBR", @@ -2323,8 +2431,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2341,8 +2450,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -2359,8 +2469,9 @@ const ( ) // Values returns all known values for H264SpatialAq. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264SpatialAq) Values() []H264SpatialAq { return []H264SpatialAq{ "DISABLED", @@ -2377,8 +2488,9 @@ const ( ) // Values returns all known values for H264SubGopLength. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264SubGopLength) Values() []H264SubGopLength { return []H264SubGopLength{ "DYNAMIC", @@ -2395,8 +2507,9 @@ const ( ) // Values returns all known values for H264Syntax. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264Syntax) Values() []H264Syntax { return []H264Syntax{ "DEFAULT", @@ -2413,8 +2526,9 @@ const ( ) // Values returns all known values for H264TemporalAq. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264TemporalAq) Values() []H264TemporalAq { return []H264TemporalAq{ "DISABLED", @@ -2432,8 +2546,9 @@ const ( // Values returns all known values for H264TimecodeInsertionBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H264TimecodeInsertionBehavior) Values() []H264TimecodeInsertionBehavior { return []H264TimecodeInsertionBehavior{ "DISABLED", @@ -2456,6 +2571,7 @@ const ( // 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{ @@ -2479,8 +2595,9 @@ const ( // Values returns all known values for H265AlternativeTransferFunction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265AlternativeTransferFunction) Values() []H265AlternativeTransferFunction { return []H265AlternativeTransferFunction{ "INSERT", @@ -2497,8 +2614,9 @@ const ( ) // Values returns all known values for H265ColorMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265ColorMetadata) Values() []H265ColorMetadata { return []H265ColorMetadata{ "IGNORE", @@ -2515,8 +2633,9 @@ const ( ) // Values returns all known values for H265FlickerAq. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265FlickerAq) Values() []H265FlickerAq { return []H265FlickerAq{ "DISABLED", @@ -2533,8 +2652,9 @@ const ( ) // Values returns all known values for H265GopSizeUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265GopSizeUnits) Values() []H265GopSizeUnits { return []H265GopSizeUnits{ "FRAMES", @@ -2563,8 +2683,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2595,6 +2716,7 @@ const ( // 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{ @@ -2614,6 +2736,7 @@ const ( // Values returns all known values for H265MvOverPictureBoundaries. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (H265MvOverPictureBoundaries) Values() []H265MvOverPictureBoundaries { return []H265MvOverPictureBoundaries{ @@ -2631,8 +2754,9 @@ const ( ) // Values returns all known values for H265MvTemporalPredictor. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265MvTemporalPredictor) Values() []H265MvTemporalPredictor { return []H265MvTemporalPredictor{ "DISABLED", @@ -2649,8 +2773,9 @@ const ( ) // Values returns all known values for H265Profile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265Profile) Values() []H265Profile { return []H265Profile{ "MAIN", @@ -2668,8 +2793,9 @@ const ( ) // Values returns all known values for H265RateControlMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265RateControlMode) Values() []H265RateControlMode { return []H265RateControlMode{ "CBR", @@ -2687,8 +2813,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2705,8 +2832,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -2723,8 +2851,9 @@ const ( ) // Values returns all known values for H265Tier. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265Tier) Values() []H265Tier { return []H265Tier{ "HIGH", @@ -2741,8 +2870,9 @@ const ( ) // Values returns all known values for H265TilePadding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265TilePadding) Values() []H265TilePadding { return []H265TilePadding{ "NONE", @@ -2760,8 +2890,9 @@ const ( // Values returns all known values for H265TimecodeInsertionBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265TimecodeInsertionBehavior) Values() []H265TimecodeInsertionBehavior { return []H265TimecodeInsertionBehavior{ "DISABLED", @@ -2778,8 +2909,9 @@ const ( ) // Values returns all known values for H265TreeblockSize. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (H265TreeblockSize) Values() []H265TreeblockSize { return []H265TreeblockSize{ "AUTO", @@ -2797,8 +2929,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2817,6 +2950,7 @@ const ( // Values returns all known values for HlsAkamaiHttpTransferMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsAkamaiHttpTransferMode) Values() []HlsAkamaiHttpTransferMode { return []HlsAkamaiHttpTransferMode{ @@ -2836,6 +2970,7 @@ const ( // Values returns all known values for HlsCaptionLanguageSetting. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsCaptionLanguageSetting) Values() []HlsCaptionLanguageSetting { return []HlsCaptionLanguageSetting{ @@ -2854,8 +2989,9 @@ const ( ) // Values returns all known values for HlsClientCache. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsClientCache) Values() []HlsClientCache { return []HlsClientCache{ "DISABLED", @@ -2872,8 +3008,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RFC_4281", @@ -2890,8 +3027,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SINGLE_DIRECTORY", @@ -2908,8 +3046,9 @@ const ( ) // Values returns all known values for HlsDiscontinuityTags. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsDiscontinuityTags) Values() []HlsDiscontinuityTags { return []HlsDiscontinuityTags{ "INSERT", @@ -2926,8 +3065,9 @@ const ( ) // Values returns all known values for HlsEncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsEncryptionType) Values() []HlsEncryptionType { return []HlsEncryptionType{ "AES128", @@ -2944,8 +3084,9 @@ const ( ) // Values returns all known values for HlsH265PackagingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsH265PackagingType) Values() []HlsH265PackagingType { return []HlsH265PackagingType{ "HEV1", @@ -2963,6 +3104,7 @@ const ( // Values returns all known values for HlsId3SegmentTaggingState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsId3SegmentTaggingState) Values() []HlsId3SegmentTaggingState { return []HlsId3SegmentTaggingState{ @@ -2981,8 +3123,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsIncompleteSegmentBehavior) Values() []HlsIncompleteSegmentBehavior { return []HlsIncompleteSegmentBehavior{ "AUTO", @@ -2999,8 +3142,9 @@ const ( ) // Values returns all known values for HlsIvInManifest. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsIvInManifest) Values() []HlsIvInManifest { return []HlsIvInManifest{ "EXCLUDE", @@ -3017,8 +3161,9 @@ const ( ) // Values returns all known values for HlsIvSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsIvSource) Values() []HlsIvSource { return []HlsIvSource{ "EXPLICIT", @@ -3035,8 +3180,9 @@ const ( ) // Values returns all known values for HlsManifestCompression. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsManifestCompression) Values() []HlsManifestCompression { return []HlsManifestCompression{ "GZIP", @@ -3054,6 +3200,7 @@ const ( // Values returns all known values for HlsManifestDurationFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsManifestDurationFormat) Values() []HlsManifestDurationFormat { return []HlsManifestDurationFormat{ @@ -3071,6 +3218,7 @@ const ( // Values returns all known values for HlsMediaStoreStorageClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsMediaStoreStorageClass) Values() []HlsMediaStoreStorageClass { return []HlsMediaStoreStorageClass{ @@ -3087,8 +3235,9 @@ const ( ) // Values returns all known values for HlsMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsMode) Values() []HlsMode { return []HlsMode{ "LIVE", @@ -3106,8 +3255,9 @@ const ( ) // Values returns all known values for HlsOutputSelection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsOutputSelection) Values() []HlsOutputSelection { return []HlsOutputSelection{ "MANIFESTS_AND_SEGMENTS", @@ -3125,8 +3275,9 @@ const ( ) // Values returns all known values for HlsProgramDateTime. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsProgramDateTime) Values() []HlsProgramDateTime { return []HlsProgramDateTime{ "EXCLUDE", @@ -3143,8 +3294,9 @@ const ( ) // Values returns all known values for HlsProgramDateTimeClock. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsProgramDateTimeClock) Values() []HlsProgramDateTimeClock { return []HlsProgramDateTimeClock{ "INITIALIZE_FROM_OUTPUT_TIMECODE", @@ -3161,8 +3313,9 @@ const ( ) // Values returns all known values for HlsRedundantManifest. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsRedundantManifest) Values() []HlsRedundantManifest { return []HlsRedundantManifest{ "DISABLED", @@ -3179,8 +3332,9 @@ const ( ) // Values returns all known values for HlsScte35SourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsScte35SourceType) Values() []HlsScte35SourceType { return []HlsScte35SourceType{ "MANIFEST", @@ -3197,8 +3351,9 @@ const ( ) // Values returns all known values for HlsSegmentationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsSegmentationMode) Values() []HlsSegmentationMode { return []HlsSegmentationMode{ "USE_INPUT_SEGMENTATION", @@ -3215,8 +3370,9 @@ const ( ) // Values returns all known values for HlsStreamInfResolution. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsStreamInfResolution) Values() []HlsStreamInfResolution { return []HlsStreamInfResolution{ "EXCLUDE", @@ -3235,6 +3391,7 @@ const ( // 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{ @@ -3253,8 +3410,9 @@ const ( ) // Values returns all known values for HlsTsFileMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HlsTsFileMode) Values() []HlsTsFileMode { return []HlsTsFileMode{ "SEGMENTED_FILES", @@ -3272,6 +3430,7 @@ const ( // Values returns all known values for HlsWebdavHttpTransferMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HlsWebdavHttpTransferMode) Values() []HlsWebdavHttpTransferMode { return []HlsWebdavHttpTransferMode{ @@ -3289,8 +3448,9 @@ const ( ) // Values returns all known values for IFrameOnlyPlaylistType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IFrameOnlyPlaylistType) Values() []IFrameOnlyPlaylistType { return []IFrameOnlyPlaylistType{ "DISABLED", @@ -3308,8 +3468,9 @@ const ( ) // Values returns all known values for IncludeFillerNalUnits. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IncludeFillerNalUnits) Values() []IncludeFillerNalUnits { return []IncludeFillerNalUnits{ "AUTO", @@ -3327,8 +3488,9 @@ const ( ) // Values returns all known values for InputClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputClass) Values() []InputClass { return []InputClass{ "STANDARD", @@ -3346,8 +3508,9 @@ const ( ) // Values returns all known values for InputCodec. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputCodec) Values() []InputCodec { return []InputCodec{ "MPEG2", @@ -3365,8 +3528,9 @@ const ( ) // Values returns all known values for InputDeblockFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeblockFilter) Values() []InputDeblockFilter { return []InputDeblockFilter{ "DISABLED", @@ -3383,8 +3547,9 @@ const ( ) // Values returns all known values for InputDenoiseFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDenoiseFilter) Values() []InputDenoiseFilter { return []InputDenoiseFilter{ "DISABLED", @@ -3401,8 +3566,9 @@ const ( ) // Values returns all known values for InputDeviceActiveInput. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceActiveInput) Values() []InputDeviceActiveInput { return []InputDeviceActiveInput{ "HDMI", @@ -3419,8 +3585,9 @@ const ( ) // Values returns all known values for InputDeviceCodec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceCodec) Values() []InputDeviceCodec { return []InputDeviceCodec{ "HEVC", @@ -3444,8 +3611,9 @@ const ( // Values returns all known values for // InputDeviceConfigurableAudioChannelPairProfile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceConfigurableAudioChannelPairProfile) Values() []InputDeviceConfigurableAudioChannelPairProfile { return []InputDeviceConfigurableAudioChannelPairProfile{ "DISABLED", @@ -3470,6 +3638,7 @@ const ( // Values returns all known values for InputDeviceConfiguredInput. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceConfiguredInput) Values() []InputDeviceConfiguredInput { return []InputDeviceConfiguredInput{ @@ -3489,6 +3658,7 @@ const ( // Values returns all known values for InputDeviceConnectionState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceConnectionState) Values() []InputDeviceConnectionState { return []InputDeviceConnectionState{ @@ -3506,8 +3676,9 @@ const ( ) // Values returns all known values for InputDeviceIpScheme. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceIpScheme) Values() []InputDeviceIpScheme { return []InputDeviceIpScheme{ "STATIC", @@ -3525,8 +3696,9 @@ const ( ) // Values returns all known values for InputDeviceOutputType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceOutputType) Values() []InputDeviceOutputType { return []InputDeviceOutputType{ "NONE", @@ -3544,8 +3716,9 @@ const ( ) // Values returns all known values for InputDeviceScanType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceScanType) Values() []InputDeviceScanType { return []InputDeviceScanType{ "INTERLACED", @@ -3562,8 +3735,9 @@ const ( ) // Values returns all known values for InputDeviceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceState) Values() []InputDeviceState { return []InputDeviceState{ "IDLE", @@ -3580,8 +3754,9 @@ const ( ) // Values returns all known values for InputDeviceTransferType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceTransferType) Values() []InputDeviceTransferType { return []InputDeviceTransferType{ "OUTGOING", @@ -3598,8 +3773,9 @@ const ( ) // Values returns all known values for InputDeviceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceType) Values() []InputDeviceType { return []InputDeviceType{ "HD", @@ -3623,8 +3799,9 @@ const ( // Values returns all known values for InputDeviceUhdAudioChannelPairProfile. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputDeviceUhdAudioChannelPairProfile) Values() []InputDeviceUhdAudioChannelPairProfile { return []InputDeviceUhdAudioChannelPairProfile{ "DISABLED", @@ -3648,8 +3825,9 @@ const ( ) // Values returns all known values for InputFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputFilter) Values() []InputFilter { return []InputFilter{ "AUTO", @@ -3668,6 +3846,7 @@ const ( // 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{ @@ -3686,8 +3865,9 @@ const ( // Values returns all known values for InputLossActionForMsSmoothOut. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputLossActionForMsSmoothOut) Values() []InputLossActionForMsSmoothOut { return []InputLossActionForMsSmoothOut{ "EMIT_OUTPUT", @@ -3705,6 +3885,7 @@ const ( // Values returns all known values for InputLossActionForRtmpOut. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InputLossActionForRtmpOut) Values() []InputLossActionForRtmpOut { return []InputLossActionForRtmpOut{ @@ -3724,6 +3905,7 @@ const ( // 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{ @@ -3742,8 +3924,9 @@ const ( ) // Values returns all known values for InputLossImageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputLossImageType) Values() []InputLossImageType { return []InputLossImageType{ "COLOR", @@ -3761,8 +3944,9 @@ const ( ) // Values returns all known values for InputMaximumBitrate. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputMaximumBitrate) Values() []InputMaximumBitrate { return []InputMaximumBitrate{ "MAX_10_MBPS", @@ -3780,8 +3964,9 @@ const ( ) // Values returns all known values for InputPreference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputPreference) Values() []InputPreference { return []InputPreference{ "EQUAL_INPUT_PREFERENCE", @@ -3799,8 +3984,9 @@ const ( ) // Values returns all known values for InputResolution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputResolution) Values() []InputResolution { return []InputResolution{ "SD", @@ -3820,8 +4006,9 @@ const ( ) // Values returns all known values for InputSecurityGroupState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputSecurityGroupState) Values() []InputSecurityGroupState { return []InputSecurityGroupState{ "IDLE", @@ -3840,8 +4027,9 @@ const ( ) // Values returns all known values for InputSourceEndBehavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputSourceEndBehavior) Values() []InputSourceEndBehavior { return []InputSourceEndBehavior{ "CONTINUE", @@ -3858,8 +4046,9 @@ const ( ) // Values returns all known values for InputSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputSourceType) Values() []InputSourceType { return []InputSourceType{ "STATIC", @@ -3879,8 +4068,9 @@ const ( ) // Values returns all known values for InputState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputState) Values() []InputState { return []InputState{ "CREATING", @@ -3900,8 +4090,9 @@ const ( ) // Values returns all known values for InputTimecodeSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputTimecodeSource) Values() []InputTimecodeSource { return []InputTimecodeSource{ "ZEROBASED", @@ -3926,8 +4117,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -3953,6 +4145,7 @@ const ( // Values returns all known values for LastFrameClippingBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LastFrameClippingBehavior) Values() []LastFrameClippingBehavior { return []LastFrameClippingBehavior{ @@ -3973,8 +4166,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "ERROR", @@ -3995,8 +4189,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAbsentInputAudioBehavior) Values() []M2tsAbsentInputAudioBehavior { return []M2tsAbsentInputAudioBehavior{ "DROP", @@ -4013,8 +4208,9 @@ const ( ) // Values returns all known values for M2tsArib. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsArib) Values() []M2tsArib { return []M2tsArib{ "DISABLED", @@ -4032,6 +4228,7 @@ const ( // Values returns all known values for M2tsAribCaptionsPidControl. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAribCaptionsPidControl) Values() []M2tsAribCaptionsPidControl { return []M2tsAribCaptionsPidControl{ @@ -4049,8 +4246,9 @@ const ( ) // Values returns all known values for M2tsAudioBufferModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAudioBufferModel) Values() []M2tsAudioBufferModel { return []M2tsAudioBufferModel{ "ATSC", @@ -4067,8 +4265,9 @@ const ( ) // Values returns all known values for M2tsAudioInterval. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAudioInterval) Values() []M2tsAudioInterval { return []M2tsAudioInterval{ "VIDEO_AND_FIXED_INTERVALS", @@ -4085,8 +4284,9 @@ const ( ) // Values returns all known values for M2tsAudioStreamType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsAudioStreamType) Values() []M2tsAudioStreamType { return []M2tsAudioStreamType{ "ATSC", @@ -4103,8 +4303,9 @@ const ( ) // Values returns all known values for M2tsBufferModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsBufferModel) Values() []M2tsBufferModel { return []M2tsBufferModel{ "MULTIPLEX", @@ -4121,8 +4322,9 @@ const ( ) // Values returns all known values for M2tsCcDescriptor. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsCcDescriptor) Values() []M2tsCcDescriptor { return []M2tsCcDescriptor{ "DISABLED", @@ -4139,8 +4341,9 @@ const ( ) // Values returns all known values for M2tsEbifControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsEbifControl) Values() []M2tsEbifControl { return []M2tsEbifControl{ "NONE", @@ -4157,8 +4360,9 @@ const ( ) // Values returns all known values for M2tsEbpPlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsEbpPlacement) Values() []M2tsEbpPlacement { return []M2tsEbpPlacement{ "VIDEO_AND_AUDIO_PIDS", @@ -4175,8 +4379,9 @@ const ( ) // Values returns all known values for M2tsEsRateInPes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsEsRateInPes) Values() []M2tsEsRateInPes { return []M2tsEsRateInPes{ "EXCLUDE", @@ -4193,8 +4398,9 @@ const ( ) // Values returns all known values for M2tsKlv. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsKlv) Values() []M2tsKlv { return []M2tsKlv{ "NONE", @@ -4211,8 +4417,9 @@ const ( ) // Values returns all known values for M2tsNielsenId3Behavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsNielsenId3Behavior) Values() []M2tsNielsenId3Behavior { return []M2tsNielsenId3Behavior{ "NO_PASSTHROUGH", @@ -4229,8 +4436,9 @@ const ( ) // Values returns all known values for M2tsPcrControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsPcrControl) Values() []M2tsPcrControl { return []M2tsPcrControl{ "CONFIGURED_PCR_PERIOD", @@ -4247,8 +4455,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -4265,8 +4474,9 @@ const ( ) // Values returns all known values for M2tsScte35Control. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsScte35Control) Values() []M2tsScte35Control { return []M2tsScte35Control{ "NONE", @@ -4287,8 +4497,9 @@ const ( ) // Values returns all known values for M2tsSegmentationMarkers. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M2tsSegmentationMarkers) Values() []M2tsSegmentationMarkers { return []M2tsSegmentationMarkers{ "EBP", @@ -4309,8 +4520,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MAINTAIN_CADENCE", @@ -4328,6 +4540,7 @@ const ( // Values returns all known values for M2tsTimedMetadataBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (M2tsTimedMetadataBehavior) Values() []M2tsTimedMetadataBehavior { return []M2tsTimedMetadataBehavior{ @@ -4345,8 +4558,9 @@ const ( ) // Values returns all known values for M3u8KlvBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8KlvBehavior) Values() []M3u8KlvBehavior { return []M3u8KlvBehavior{ "NO_PASSTHROUGH", @@ -4363,8 +4577,9 @@ const ( ) // Values returns all known values for M3u8NielsenId3Behavior. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8NielsenId3Behavior) Values() []M3u8NielsenId3Behavior { return []M3u8NielsenId3Behavior{ "NO_PASSTHROUGH", @@ -4381,8 +4596,9 @@ const ( ) // Values returns all known values for M3u8PcrControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8PcrControl) Values() []M3u8PcrControl { return []M3u8PcrControl{ "CONFIGURED_PCR_PERIOD", @@ -4399,8 +4615,9 @@ const ( ) // Values returns all known values for M3u8Scte35Behavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (M3u8Scte35Behavior) Values() []M3u8Scte35Behavior { return []M3u8Scte35Behavior{ "NO_PASSTHROUGH", @@ -4418,6 +4635,7 @@ const ( // Values returns all known values for M3u8TimedMetadataBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (M3u8TimedMetadataBehavior) Values() []M3u8TimedMetadataBehavior { return []M3u8TimedMetadataBehavior{ @@ -4440,8 +4658,9 @@ const ( ) // Values returns all known values for MaintenanceDay. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceDay) Values() []MaintenanceDay { return []MaintenanceDay{ "MONDAY", @@ -4463,8 +4682,9 @@ const ( ) // Values returns all known values for MotionGraphicsInsertion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MotionGraphicsInsertion) Values() []MotionGraphicsInsertion { return []MotionGraphicsInsertion{ "DISABLED", @@ -4481,8 +4701,9 @@ const ( ) // Values returns all known values for Mp2CodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mp2CodingMode) Values() []Mp2CodingMode { return []Mp2CodingMode{ "CODING_MODE_1_0", @@ -4503,6 +4724,7 @@ const ( // Values returns all known values for Mpeg2AdaptiveQuantization. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2AdaptiveQuantization) Values() []Mpeg2AdaptiveQuantization { return []Mpeg2AdaptiveQuantization{ @@ -4523,8 +4745,9 @@ const ( ) // Values returns all known values for Mpeg2ColorMetadata. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2ColorMetadata) Values() []Mpeg2ColorMetadata { return []Mpeg2ColorMetadata{ "IGNORE", @@ -4541,8 +4764,9 @@ const ( ) // Values returns all known values for Mpeg2ColorSpace. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2ColorSpace) Values() []Mpeg2ColorSpace { return []Mpeg2ColorSpace{ "AUTO", @@ -4559,8 +4783,9 @@ const ( ) // Values returns all known values for Mpeg2DisplayRatio. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2DisplayRatio) Values() []Mpeg2DisplayRatio { return []Mpeg2DisplayRatio{ "DISPLAYRATIO16X9", @@ -4577,8 +4802,9 @@ const ( ) // Values returns all known values for Mpeg2GopSizeUnits. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2GopSizeUnits) Values() []Mpeg2GopSizeUnits { return []Mpeg2GopSizeUnits{ "FRAMES", @@ -4595,8 +4821,9 @@ const ( ) // Values returns all known values for Mpeg2ScanType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2ScanType) Values() []Mpeg2ScanType { return []Mpeg2ScanType{ "INTERLACED", @@ -4613,8 +4840,9 @@ const ( ) // Values returns all known values for Mpeg2SubGopLength. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2SubGopLength) Values() []Mpeg2SubGopLength { return []Mpeg2SubGopLength{ "DYNAMIC", @@ -4632,8 +4860,9 @@ const ( // Values returns all known values for Mpeg2TimecodeInsertionBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mpeg2TimecodeInsertionBehavior) Values() []Mpeg2TimecodeInsertionBehavior { return []Mpeg2TimecodeInsertionBehavior{ "DISABLED", @@ -4651,6 +4880,7 @@ const ( // Values returns all known values for MsSmoothH265PackagingType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MsSmoothH265PackagingType) Values() []MsSmoothH265PackagingType { return []MsSmoothH265PackagingType{ @@ -4675,8 +4905,9 @@ const ( ) // Values returns all known values for MultiplexState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MultiplexState) Values() []MultiplexState { return []MultiplexState{ "CREATING", @@ -4701,8 +4932,9 @@ const ( // 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. +// 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", @@ -4720,6 +4952,7 @@ const ( // Values returns all known values for NielsenPcmToId3TaggingState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NielsenPcmToId3TaggingState) Values() []NielsenPcmToId3TaggingState { return []NielsenPcmToId3TaggingState{ @@ -4738,8 +4971,9 @@ const ( // Values returns all known values for NielsenWatermarksCbetStepaside. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NielsenWatermarksCbetStepaside) Values() []NielsenWatermarksCbetStepaside { return []NielsenWatermarksCbetStepaside{ "DISABLED", @@ -4757,8 +4991,9 @@ const ( // Values returns all known values for NielsenWatermarksDistributionTypes. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NielsenWatermarksDistributionTypes) Values() []NielsenWatermarksDistributionTypes { return []NielsenWatermarksDistributionTypes{ "FINAL_DISTRIBUTOR", @@ -4784,6 +5019,7 @@ const ( // Values returns all known values for NielsenWatermarkTimezones. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NielsenWatermarkTimezones) Values() []NielsenWatermarkTimezones { return []NielsenWatermarkTimezones{ @@ -4808,8 +5044,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MONTHS", @@ -4824,8 +5061,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -4841,8 +5079,9 @@ const ( ) // Values returns all known values for PipelineId. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineId) Values() []PipelineId { return []PipelineId{ "PIPELINE_0", @@ -4861,6 +5100,7 @@ const ( // 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{ @@ -4879,8 +5119,9 @@ const ( ) // Values returns all known values for RebootInputDeviceForce. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RebootInputDeviceForce) Values() []RebootInputDeviceForce { return []RebootInputDeviceForce{ "NO", @@ -4899,6 +5140,7 @@ const ( // Values returns all known values for ReservationAutomaticRenewal. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReservationAutomaticRenewal) Values() []ReservationAutomaticRenewal { return []ReservationAutomaticRenewal{ @@ -4920,8 +5162,9 @@ const ( ) // Values returns all known values for ReservationCodec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservationCodec) Values() []ReservationCodec { return []ReservationCodec{ "MPEG2", @@ -4943,6 +5186,7 @@ const ( // Values returns all known values for ReservationMaximumBitrate. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReservationMaximumBitrate) Values() []ReservationMaximumBitrate { return []ReservationMaximumBitrate{ @@ -4962,6 +5206,7 @@ const ( // Values returns all known values for ReservationMaximumFramerate. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReservationMaximumFramerate) Values() []ReservationMaximumFramerate { return []ReservationMaximumFramerate{ @@ -4981,8 +5226,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SD", @@ -5003,8 +5249,9 @@ const ( ) // Values returns all known values for ReservationResourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservationResourceType) Values() []ReservationResourceType { return []ReservationResourceType{ "INPUT", @@ -5026,6 +5273,7 @@ const ( // Values returns all known values for ReservationSpecialFeature. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReservationSpecialFeature) Values() []ReservationSpecialFeature { return []ReservationSpecialFeature{ @@ -5047,8 +5295,9 @@ const ( ) // Values returns all known values for ReservationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservationState) Values() []ReservationState { return []ReservationState{ "ACTIVE", @@ -5068,8 +5317,9 @@ const ( ) // Values returns all known values for ReservationVideoQuality. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservationVideoQuality) Values() []ReservationVideoQuality { return []ReservationVideoQuality{ "STANDARD", @@ -5086,8 +5336,9 @@ const ( ) // Values returns all known values for RtmpAdMarkers. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RtmpAdMarkers) Values() []RtmpAdMarkers { return []RtmpAdMarkers{ "ON_CUE_POINT_SCTE35", @@ -5103,8 +5354,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISCONNECT_IMMEDIATELY", @@ -5122,8 +5374,9 @@ const ( ) // Values returns all known values for RtmpCaptionData. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RtmpCaptionData) Values() []RtmpCaptionData { return []RtmpCaptionData{ "ALL", @@ -5142,6 +5395,7 @@ const ( // Values returns all known values for RtmpOutputCertificateMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RtmpOutputCertificateMode) Values() []RtmpOutputCertificateMode { return []RtmpOutputCertificateMode{ @@ -5161,8 +5415,9 @@ const ( ) // Values returns all known values for S3CannedAcl. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3CannedAcl) Values() []S3CannedAcl { return []S3CannedAcl{ "AUTHENTICATED_READ", @@ -5181,8 +5436,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DISABLED", @@ -5203,8 +5459,9 @@ const ( ) // Values returns all known values for Scte27OcrLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte27OcrLanguage) Values() []Scte27OcrLanguage { return []Scte27OcrLanguage{ "DEU", @@ -5226,8 +5483,9 @@ const ( // Values returns all known values for Scte35AposNoRegionalBlackoutBehavior. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35AposNoRegionalBlackoutBehavior) Values() []Scte35AposNoRegionalBlackoutBehavior { return []Scte35AposNoRegionalBlackoutBehavior{ "FOLLOW", @@ -5245,8 +5503,9 @@ const ( // Values returns all known values for Scte35AposWebDeliveryAllowedBehavior. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35AposWebDeliveryAllowedBehavior) Values() []Scte35AposWebDeliveryAllowedBehavior { return []Scte35AposWebDeliveryAllowedBehavior{ "FOLLOW", @@ -5264,6 +5523,7 @@ const ( // 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{ @@ -5284,6 +5544,7 @@ const ( // 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{ @@ -5303,8 +5564,9 @@ const ( ) // Values returns all known values for Scte35InputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35InputMode) Values() []Scte35InputMode { return []Scte35InputMode{ "FIXED", @@ -5322,8 +5584,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35NoRegionalBlackoutFlag) Values() []Scte35NoRegionalBlackoutFlag { return []Scte35NoRegionalBlackoutFlag{ "REGIONAL_BLACKOUT", @@ -5341,8 +5604,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35SegmentationCancelIndicator) Values() []Scte35SegmentationCancelIndicator { return []Scte35SegmentationCancelIndicator{ "SEGMENTATION_EVENT_NOT_CANCELED", @@ -5359,8 +5623,9 @@ const ( ) // Values returns all known values for Scte35SegmentationScope. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35SegmentationScope) Values() []Scte35SegmentationScope { return []Scte35SegmentationScope{ "ALL_OUTPUT_GROUPS", @@ -5378,8 +5643,9 @@ const ( // Values returns all known values for // Scte35SpliceInsertNoRegionalBlackoutBehavior. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35SpliceInsertNoRegionalBlackoutBehavior) Values() []Scte35SpliceInsertNoRegionalBlackoutBehavior { return []Scte35SpliceInsertNoRegionalBlackoutBehavior{ "FOLLOW", @@ -5397,8 +5663,9 @@ const ( // Values returns all known values for // Scte35SpliceInsertWebDeliveryAllowedBehavior. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35SpliceInsertWebDeliveryAllowedBehavior) Values() []Scte35SpliceInsertWebDeliveryAllowedBehavior { return []Scte35SpliceInsertWebDeliveryAllowedBehavior{ "FOLLOW", @@ -5415,8 +5682,9 @@ const ( ) // Values returns all known values for Scte35Type. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35Type) Values() []Scte35Type { return []Scte35Type{ "NONE", @@ -5434,8 +5702,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Scte35WebDeliveryAllowedFlag) Values() []Scte35WebDeliveryAllowedFlag { return []Scte35WebDeliveryAllowedFlag{ "WEB_DELIVERY_NOT_ALLOWED", @@ -5461,8 +5730,9 @@ const ( // Values returns all known values for SignalMapMonitorDeploymentStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignalMapMonitorDeploymentStatus) Values() []SignalMapMonitorDeploymentStatus { return []SignalMapMonitorDeploymentStatus{ "NOT_DEPLOYED", @@ -5494,8 +5764,9 @@ const ( ) // Values returns all known values for SignalMapStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignalMapStatus) Values() []SignalMapStatus { return []SignalMapStatus{ "CREATE_IN_PROGRESS", @@ -5520,8 +5791,9 @@ const ( // Values returns all known values for SmoothGroupAudioOnlyTimecodeControl. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupAudioOnlyTimecodeControl) Values() []SmoothGroupAudioOnlyTimecodeControl { return []SmoothGroupAudioOnlyTimecodeControl{ "PASSTHROUGH", @@ -5539,6 +5811,7 @@ const ( // Values returns all known values for SmoothGroupCertificateMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupCertificateMode) Values() []SmoothGroupCertificateMode { return []SmoothGroupCertificateMode{ @@ -5557,8 +5830,9 @@ const ( ) // Values returns all known values for SmoothGroupEventIdMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupEventIdMode) Values() []SmoothGroupEventIdMode { return []SmoothGroupEventIdMode{ "NO_EVENT_ID", @@ -5577,8 +5851,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupEventStopBehavior) Values() []SmoothGroupEventStopBehavior { return []SmoothGroupEventStopBehavior{ "NONE", @@ -5596,6 +5871,7 @@ const ( // Values returns all known values for SmoothGroupSegmentationMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupSegmentationMode) Values() []SmoothGroupSegmentationMode { return []SmoothGroupSegmentationMode{ @@ -5615,6 +5891,7 @@ const ( // Values returns all known values for SmoothGroupSparseTrackType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupSparseTrackType) Values() []SmoothGroupSparseTrackType { return []SmoothGroupSparseTrackType{ @@ -5634,8 +5911,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupStreamManifestBehavior) Values() []SmoothGroupStreamManifestBehavior { return []SmoothGroupStreamManifestBehavior{ "DO_NOT_SEND", @@ -5653,8 +5931,9 @@ const ( // Values returns all known values for SmoothGroupTimestampOffsetMode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmoothGroupTimestampOffsetMode) Values() []SmoothGroupTimestampOffsetMode { return []SmoothGroupTimestampOffsetMode{ "USE_CONFIGURED_OFFSET", @@ -5671,8 +5950,9 @@ const ( ) // Values returns all known values for Smpte2038DataPreference. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Smpte2038DataPreference) Values() []Smpte2038DataPreference { return []Smpte2038DataPreference{ "IGNORE", @@ -5691,8 +5971,9 @@ const ( // Values returns all known values for TemporalFilterPostFilterSharpening. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemporalFilterPostFilterSharpening) Values() []TemporalFilterPostFilterSharpening { return []TemporalFilterPostFilterSharpening{ "AUTO", @@ -5725,8 +6006,9 @@ const ( ) // Values returns all known values for TemporalFilterStrength. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemporalFilterStrength) Values() []TemporalFilterStrength { return []TemporalFilterStrength{ "AUTO", @@ -5758,8 +6040,9 @@ const ( ) // Values returns all known values for ThumbnailState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThumbnailState) Values() []ThumbnailState { return []ThumbnailState{ "AUTO", @@ -5776,8 +6059,9 @@ const ( ) // Values returns all known values for ThumbnailType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThumbnailType) Values() []ThumbnailType { return []ThumbnailType{ "UNSPECIFIED", @@ -5796,8 +6080,9 @@ const ( ) // Values returns all known values for TimecodeBurninFontSize. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimecodeBurninFontSize) Values() []TimecodeBurninFontSize { return []TimecodeBurninFontSize{ "EXTRA_SMALL_10", @@ -5823,8 +6108,9 @@ const ( ) // Values returns all known values for TimecodeBurninPosition. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimecodeBurninPosition) Values() []TimecodeBurninPosition { return []TimecodeBurninPosition{ "BOTTOM_CENTER", @@ -5849,8 +6135,9 @@ const ( ) // Values returns all known values for TimecodeConfigSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimecodeConfigSource) Values() []TimecodeConfigSource { return []TimecodeConfigSource{ "EMBEDDED", @@ -5869,6 +6156,7 @@ const ( // Values returns all known values for TtmlDestinationStyleControl. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TtmlDestinationStyleControl) Values() []TtmlDestinationStyleControl { return []TtmlDestinationStyleControl{ @@ -5888,6 +6176,7 @@ const ( // 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{ @@ -5908,8 +6197,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoDescriptionRespondToAfd) Values() []VideoDescriptionRespondToAfd { return []VideoDescriptionRespondToAfd{ "NONE", @@ -5928,8 +6218,9 @@ const ( // Values returns all known values for VideoDescriptionScalingBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoDescriptionScalingBehavior) Values() []VideoDescriptionScalingBehavior { return []VideoDescriptionScalingBehavior{ "DEFAULT", @@ -5949,8 +6240,9 @@ const ( ) // Values returns all known values for VideoSelectorColorSpace. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoSelectorColorSpace) Values() []VideoSelectorColorSpace { return []VideoSelectorColorSpace{ "FOLLOW", @@ -5971,8 +6263,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoSelectorColorSpaceUsage) Values() []VideoSelectorColorSpaceUsage { return []VideoSelectorColorSpaceUsage{ "FALLBACK", @@ -5991,8 +6284,9 @@ const ( ) // Values returns all known values for WavCodingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WavCodingMode) Values() []WavCodingMode { return []WavCodingMode{ "CODING_MODE_1_0", @@ -6012,8 +6306,9 @@ const ( // Values returns all known values for WebvttDestinationStyleControl. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebvttDestinationStyleControl) Values() []WebvttDestinationStyleControl { return []WebvttDestinationStyleControl{ "NO_STYLE_DATA", diff --git a/service/medialive/types/types.go b/service/medialive/types/types.go index 2521ef0b7c0..e2c9abc296f 100644 --- a/service/medialive/types/types.go +++ b/service/medialive/types/types.go @@ -26,6 +26,7 @@ type AacSettings struct { // AD". Note that the input received by the encoder must contain pre-mixed audio; // the encoder does not perform the mixing. The values in audioTypeControl and // audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. + // // Leave set to "normal" when input does not contain pre-mixed audio + AD. InputType AacInputType @@ -381,22 +382,29 @@ type AudioOnlyHlsSettings struct { // Optional. Specifies the .jpg or .png image to use as the cover art for an // audio-only output. We recommend a low bit-size file because the image increases - // the output audio bandwidth. The image is attached to the audio as an ID3 tag, - // frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native - // Frames" standard. + // the output audio bandwidth. + // + // The image is attached to the audio as an ID3 tag, frame type APIC, picture type + // 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. AudioOnlyImage *InputLocation - // Four types of audio-only tracks are supported: Audio-Only Variant Stream The - // client can play back this audio-only stream instead of video in low-bandwidth - // scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate - // Audio, Auto Select, Default Alternate rendition that the client should try to - // play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with - // DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate - // rendition that the client may try to play back by default. Represented as an - // EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, - // not Auto Select Alternate rendition that the client will not try to play back by - // default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, - // AUTOSELECT=NO + // Four types of audio-only tracks are supported: + // + // Audio-Only Variant Stream The client can play back this audio-only stream + // instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF + // in the HLS manifest. + // + // Alternate Audio, Auto Select, Default Alternate rendition that the client + // should try to play back by default. Represented as an EXT-X-MEDIA in the HLS + // manifest with DEFAULT=YES, AUTOSELECT=YES + // + // Alternate Audio, Auto Select, Not Default Alternate rendition that the client + // may try to play back by default. Represented as an EXT-X-MEDIA in the HLS + // manifest with DEFAULT=NO, AUTOSELECT=YES + // + // Alternate Audio, not Auto Select Alternate rendition that the client will not + // try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest + // with DEFAULT=NO, AUTOSELECT=NO AudioTrackType AudioOnlyHlsTrackType // Specifies the segment type. @@ -555,8 +563,10 @@ type AvailConfiguration struct { // groups that use segmented outputs. Insertion of a SCTE 35 message typically // results in a segment break, in addition to the regular cadence of breaks. The // segment breaks appear in video outputs, audio outputs, and captions outputs (if - // any). ALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output - // groups that have segmented outputs. This is the legacy behavior. + // any). + // + // ALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups + // that have segmented outputs. This is the legacy behavior. // SCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups // that have SCTE 35 passthrough enabled. This is the recommended value, because it // reduces unnecessary segment breaks. @@ -1665,6 +1675,7 @@ 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. @@ -1673,10 +1684,12 @@ type EbuTtDDestinationSettings struct { // Specifies the font family to include in the font data attached to the EBU-TT // captions. Valid only if styleControl is set to include. If you leave this field // empty, the font family is set to "monospaced". (If styleControl is set to - // exclude, the font family is always set to "monospaced".) You specify only the - // 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. + // exclude, the font family is always set to "monospaced".) + // + // You specify only the 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 @@ -1686,6 +1699,7 @@ type EbuTtDDestinationSettings struct { // 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 @@ -2148,10 +2162,11 @@ 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. - // EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each - // pipeline to the Unix epoch. + // 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 // Advanced output locking settings @@ -2303,8 +2318,10 @@ type H264Settings struct { // 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 - // order to accommodate expected spikes in the complexity of the video. + // For QVBR: See the tooltip for Quality level + // + // For VBR: Set the maximum bitrate in order to accommodate expected spikes in the + // complexity of the video. MaxBitrate *int32 // Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if @@ -2338,6 +2355,7 @@ 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 @@ -2350,6 +2368,7 @@ 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 @@ -2358,22 +2377,29 @@ type H264Settings struct { // "Video - rate control mode" in the MediaLive user guide QvbrQualityLevel *int32 - // Rate control mode. QVBR: Quality will match the specified quality level except - // when it is constrained by the maximum bitrate. Recommended if you or your - // viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video - // complexity. Recommended instead of QVBR if you want to maintain a specific - // average bitrate over the duration of the channel. CBR: Quality varies, depending - // on the video complexity. Recommended only if you distribute your assets to - // devices that cannot handle variable bitrates. Multiplex: This rate control mode - // is only supported (and is required) when the video is being delivered to a - // MediaLive Multiplex in which case the rate control configuration is controlled - // by the properties within the Multiplex Program. + // Rate control mode. + // + // QVBR: Quality will match the specified quality level except when it is + // constrained by the maximum bitrate. Recommended if you or your viewers pay for + // bandwidth. + // + // VBR: Quality and bitrate vary, depending on the video complexity. Recommended + // instead of QVBR if you want to maintain a specific average bitrate over the + // duration of the channel. + // + // CBR: Quality varies, depending on the video complexity. Recommended only if you + // distribute your assets to devices that cannot handle variable bitrates. + // + // Multiplex: This rate control mode is only supported (and is required) when the + // video is being delivered to a MediaLive Multiplex in which case the rate control + // configuration is controlled by the properties within the Multiplex Program. RateControlMode H264RateControlMode // Sets the scan type of the output to progressive or top-field-first interlaced. 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. SceneChangeDetect H264SceneChangeDetect @@ -2424,6 +2450,7 @@ 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 @@ -2569,19 +2596,24 @@ 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 QvbrQualityLevel *int32 - // Rate control mode. QVBR: Quality will match the specified quality level except - // when it is constrained by the maximum bitrate. Recommended if you or your - // viewers pay for bandwidth. CBR: Quality varies, depending on the video - // complexity. Recommended only if you distribute your assets to devices that - // cannot handle variable bitrates. Multiplex: This rate control mode is only - // supported (and is required) when the video is being delivered to a MediaLive - // Multiplex in which case the rate control configuration is controlled by the - // properties within the Multiplex Program. + // Rate control mode. + // + // QVBR: Quality will match the specified quality level except when it is + // constrained by the maximum bitrate. Recommended if you or your viewers pay for + // bandwidth. + // + // CBR: Quality varies, depending on the video complexity. Recommended only if you + // distribute your assets to devices that cannot handle variable bitrates. + // + // Multiplex: This rate control mode is only supported (and is required) when the + // video is being delivered to a MediaLive Multiplex in which case the rate control + // configuration is controlled by the properties within the Multiplex Program. RateControlMode H265RateControlMode // Sets the scan type of the output to progressive or top-field-first interlaced. @@ -2622,6 +2654,7 @@ 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 @@ -2744,10 +2777,11 @@ type HlsGroupSettings struct { // main .m3u8 file. BaseUrlContent *string - // Optional. One value per output group. This field is required only if you are - // completing Base URL content A, and the downstream system has notified you that - // the media files for pipeline 1 of all outputs are in a location different from - // the media files for pipeline 0. + // Optional. One value per output group. + // + // This field is required only if you are completing Base URL content A, and the + // downstream system has notified you that the media files for pipeline 1 of all + // outputs are in a location different from the media files for pipeline 0. BaseUrlContent1 *string // A partial URI prefix that will be prepended to each output in the media .m3u8 @@ -2755,10 +2789,12 @@ type HlsGroupSettings struct { // main .m3u8 file. BaseUrlManifest *string - // Optional. One value per output group. Complete this field only if you are - // completing Base URL manifest A, and the downstream system has notified you that - // the child manifest files for pipeline 1 of all outputs are in a location - // different from the child manifest files for pipeline 0. + // Optional. One value per output group. + // + // Complete this field only if you are completing Base URL manifest A, and the + // downstream system has notified you that the child manifest files for pipeline 1 + // of all outputs are in a location different from the child manifest files for + // pipeline 0. BaseUrlManifest1 *string // Mapping of up to 4 caption channels to caption languages. Is only meaningful if @@ -2811,12 +2847,13 @@ type HlsGroupSettings struct { HlsId3SegmentTagging HlsId3SegmentTaggingState // DISABLED: Do not create an I-frame-only manifest, but do create the master and - // media manifests (according to the Output Selection field). STANDARD: Create an - // I-frame-only manifest for each output that contains video, as well as the other - // manifests (according to the Output Selection field). The I-frame manifest - // contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or - // more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, - // #EXT-X-BYTERANGE:160364@1461888" + // media manifests (according to the Output Selection field). + // + // STANDARD: Create an I-frame-only manifest for each output that contains video, + // as well as the other manifests (according to the Output Selection field). The + // I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame + // only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. + // For example, #EXT-X-BYTERANGE:160364@1461888" IFrameOnlyPlaylists IFrameOnlyPlaylistType // Specifies whether to include the final (incomplete) segment in the media output @@ -2827,10 +2864,11 @@ type HlsGroupSettings struct { // We recommend you choose Auto and let MediaLive control the behavior. IncompleteSegmentBehavior HlsIncompleteSegmentBehavior - // Applies only if Mode field is LIVE. Specifies the maximum number of segments in - // the media manifest file. After this maximum, older segments are removed from the - // media manifest. This number must be smaller than the number in the Keep Segments - // field. + // Applies only if Mode field is LIVE. + // + // Specifies the maximum number of segments in the media manifest file. After this + // maximum, older segments are removed from the media manifest. This number must be + // smaller than the number in the Keep Segments field. IndexNSegments *int32 // Parameter that control output group behavior on input loss. @@ -2848,9 +2886,12 @@ type HlsGroupSettings struct { // value. IvSource HlsIvSource - // Applies only if Mode field is LIVE. Specifies the number of media segments to - // retain in the destination directory. This number should be bigger than - // indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). + // Applies only if Mode field is LIVE. + // + // Specifies the number of media segments to retain in the destination directory. + // This number should be bigger than indexNSegments (Num segments). We recommend + // (value = (2 x indexNsegments) + 1). + // // If this "keep segments" number is too low, the following might happen: the // player is still reading a media manifest file that lists this segment, but that // segment has been removed from the destination directory (as directed by @@ -2884,14 +2925,18 @@ type HlsGroupSettings struct { // If "vod", all segments are indexed and kept permanently in the destination and // manifest. If "live", only the number segments specified in keepSegments and // indexNSegments are kept; newer segments replace older segments, which may - // prevent players from rewinding all the way to the beginning of the event. VOD - // mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, + // prevent players from rewinding all the way to the beginning of the event. + // + // VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, // 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: - // Generates media manifests for this output group, but not a master manifest. + // 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 @@ -2900,12 +2945,16 @@ type HlsGroupSettings struct { ProgramDateTime HlsProgramDateTime // Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. - // Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized - // as a function of the first output timecode, then incremented by the EXTINF - // duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as - // a function of the UTC wall clock, then incremented by the EXTINF duration of - // each encoded segment. If the PDT clock diverges from the wall clock by more than - // 500ms, it is resynchronized to the wall clock. + // Options include: + // + // INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of + // the first output timecode, then incremented by the EXTINF duration of each + // encoded segment. + // + // SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, + // then incremented by the EXTINF duration of each encoded segment. If the PDT + // clock diverges from the wall clock by more than 500ms, it is resynchronized to + // the wall clock. ProgramDateTimeClock HlsProgramDateTimeClock // Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. @@ -2917,11 +2966,14 @@ type HlsGroupSettings struct { // 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 - // manifest from MediaLive is irrelevant. + // 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 manifest from MediaLive is irrelevant. RedundantManifest HlsRedundantManifest // Length of MPEG-2 Transport Stream segments to create in seconds. Note that @@ -2952,11 +3004,13 @@ type HlsGroupSettings struct { TimestampDeltaMilliseconds *int32 // SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. - // SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single .ts - // media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments - // for playback. A typical use for this value is when sending the output to AWS - // Elemental MediaConvert, which can accept only a single media file. Playback - // while the channel is running is not guaranteed due to HTTP server caching. + // + // SINGLE_FILE: Applies only if Mode field is VOD. Emit the program as a single + // .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index + // segments for playback. A typical use for this value is when sending the output + // to AWS Elemental MediaConvert, which can accept only a single media file. + // Playback while the channel is running is not guaranteed due to HTTP server + // caching. TsFileMode HlsTsFileMode noSmithyDocumentSerde @@ -3710,6 +3764,7 @@ 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 @@ -3725,6 +3780,7 @@ 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. @@ -4066,14 +4122,16 @@ type M2tsSettings struct { // The segmentation style parameter controls how segmentation markers are inserted // into the transport stream. With avails, it is possible that segments may be // 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 - // 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 - // is a slight exception to this rule. + // 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 is a slight exception to this rule. SegmentationStyle M2tsSegmentationStyle // The length in seconds of each segment. Required unless markers is set to none. @@ -4529,13 +4587,17 @@ type MsSmoothGroupSettings struct { // be be delivered to the IIS server once the connection is re-established. ConnectionRetryInterval *int32 - // MS Smooth event ID to be sent to the IIS server. Should only be specified if - // eventIdMode is set to useConfigured. + // MS Smooth event ID to be sent to the IIS server. + // + // Should only be specified if eventIdMode is set to useConfigured. EventId *string // 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: + // 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 @@ -4570,6 +4632,7 @@ 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 @@ -4586,6 +4649,7 @@ 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 TimestampOffsetMode SmoothGroupTimestampOffsetMode @@ -5000,6 +5064,7 @@ type NielsenWatermarksSettings struct { NielsenCbetSettings *NielsenCBET // Choose the distribution types that you want to assign to the watermarks: + // // - PROGRAM_CONTENT // - FINAL_DISTRIBUTOR NielsenDistributionType NielsenWatermarksDistributionTypes @@ -5457,6 +5522,7 @@ type RtmpGroupSettings struct { IncludeFillerNalUnits IncludeFillerNalUnits // 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. @@ -5621,6 +5687,7 @@ 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. @@ -6137,6 +6204,7 @@ 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 diff --git a/service/mediapackage/options.go b/service/mediapackage/options.go index 39ec32fa1d3..f6ccb4cfc5b 100644 --- a/service/mediapackage/options.go +++ b/service/mediapackage/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediapackage/types/enums.go b/service/mediapackage/types/enums.go index 76994b5c8b3..4ca42edd254 100644 --- a/service/mediapackage/types/enums.go +++ b/service/mediapackage/types/enums.go @@ -17,8 +17,9 @@ const ( ) // Values returns all known values for AdTriggersElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdTriggersElement) Values() []AdTriggersElement { return []AdTriggersElement{ "SPLICE_INSERT", @@ -40,8 +41,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ADS", @@ -59,8 +61,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -82,6 +85,7 @@ const ( // Values returns all known values for AdsOnDeliveryRestrictions. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AdsOnDeliveryRestrictions) Values() []AdsOnDeliveryRestrictions { return []AdsOnDeliveryRestrictions{ @@ -101,8 +105,9 @@ const ( ) // Values returns all known values for CmafEncryptionMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafEncryptionMethod) Values() []CmafEncryptionMethod { return []CmafEncryptionMethod{ "SAMPLE_AES", @@ -119,8 +124,9 @@ const ( ) // Values returns all known values for EncryptionMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionMethod) Values() []EncryptionMethod { return []EncryptionMethod{ "AES_128", @@ -138,8 +144,9 @@ const ( ) // Values returns all known values for ManifestLayout. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManifestLayout) Values() []ManifestLayout { return []ManifestLayout{ "FULL", @@ -157,8 +164,9 @@ const ( ) // Values returns all known values for Origination. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Origination) Values() []Origination { return []Origination{ "ALLOW", @@ -176,8 +184,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -198,8 +207,9 @@ const ( ) // Values returns all known values for PresetSpeke20Audio. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresetSpeke20Audio) Values() []PresetSpeke20Audio { return []PresetSpeke20Audio{ "PRESET-AUDIO-1", @@ -227,8 +237,9 @@ const ( ) // Values returns all known values for PresetSpeke20Video. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresetSpeke20Video) Values() []PresetSpeke20Video { return []PresetSpeke20Video{ "PRESET-VIDEO-1", @@ -255,8 +266,9 @@ const ( ) // Values returns all known values for Profile. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Profile) Values() []Profile { return []Profile{ "NONE", @@ -276,8 +288,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NUMBER_WITH_TIMELINE", @@ -296,8 +309,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "IN_PROGRESS", @@ -316,8 +330,9 @@ const ( ) // Values returns all known values for StreamOrder. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamOrder) Values() []StreamOrder { return []StreamOrder{ "ORIGINAL", @@ -337,8 +352,9 @@ const ( ) // 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. +// in the future, and so 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/mediapackagev2/api_op_CreateChannel.go b/service/mediapackagev2/api_op_CreateChannel.go index ddb0cbbd2ce..cef5a0fb773 100644 --- a/service/mediapackagev2/api_op_CreateChannel.go +++ b/service/mediapackagev2/api_op_CreateChannel.go @@ -58,7 +58,9 @@ type CreateChannelInput struct { Description *string // A comma-separated list of tag key:value pairs that you define. For example: - // "Key1": "Value1", + // + // "Key1": "Value1", + // // "Key2": "Value2" Tags map[string]string diff --git a/service/mediapackagev2/api_op_CreateChannelGroup.go b/service/mediapackagev2/api_op_CreateChannelGroup.go index e77a8426b4d..ff5d46c1647 100644 --- a/service/mediapackagev2/api_op_CreateChannelGroup.go +++ b/service/mediapackagev2/api_op_CreateChannelGroup.go @@ -50,7 +50,9 @@ type CreateChannelGroupInput struct { Description *string // A comma-separated list of tag key:value pairs that you define. For example: - // "Key1": "Value1", + // + // "Key1": "Value1", + // // "Key2": "Value2" Tags map[string]string diff --git a/service/mediapackagev2/api_op_CreateOriginEndpoint.go b/service/mediapackagev2/api_op_CreateOriginEndpoint.go index c351c96135a..303151afd2c 100644 --- a/service/mediapackagev2/api_op_CreateOriginEndpoint.go +++ b/service/mediapackagev2/api_op_CreateOriginEndpoint.go @@ -90,7 +90,9 @@ type CreateOriginEndpointInput struct { StartoverWindowSeconds *int32 // A comma-separated list of tag key:value pairs that you define. For example: - // "Key1": "Value1", + // + // "Key1": "Value1", + // // "Key2": "Value2" Tags map[string]string diff --git a/service/mediapackagev2/api_op_TagResource.go b/service/mediapackagev2/api_op_TagResource.go index fbc629272f2..34b35f55c1f 100644 --- a/service/mediapackagev2/api_op_TagResource.go +++ b/service/mediapackagev2/api_op_TagResource.go @@ -11,13 +11,15 @@ import ( ) // Assigns one of more tags (key-value pairs) to the specified MediaPackage -// resource. 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 the TagResource -// operation with a resource that already has tags. If you specify a new tag key -// for the resource, this tag is appended to the list of tags associated with the -// resource. 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. +// resource. +// +// 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 the TagResource operation +// with a resource that already has tags. If you specify a new tag key for the +// resource, this tag is appended to the list of tags associated with the resource. +// 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/mediapackagev2/api_op_UpdateChannel.go b/service/mediapackagev2/api_op_UpdateChannel.go index 0750a209ac8..f40d13e8f05 100644 --- a/service/mediapackagev2/api_op_UpdateChannel.go +++ b/service/mediapackagev2/api_op_UpdateChannel.go @@ -15,8 +15,10 @@ import ( // Update the specified channel. You can edit if MediaPackage sends ingest or // egress access logs to the CloudWatch log group, if content will be encrypted, // the description on a channel, and your channel's policy settings. You can't edit -// the name of the channel or CloudFront distribution details. Any edits you make -// that impact the video output may not be reflected for a few minutes. +// the name of the channel or CloudFront distribution details. +// +// Any edits you make that impact the video output may not be reflected for a few +// minutes. func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error) { if params == nil { params = &UpdateChannelInput{} diff --git a/service/mediapackagev2/api_op_UpdateChannelGroup.go b/service/mediapackagev2/api_op_UpdateChannelGroup.go index f85c4277fac..55b368058b4 100644 --- a/service/mediapackagev2/api_op_UpdateChannelGroup.go +++ b/service/mediapackagev2/api_op_UpdateChannelGroup.go @@ -13,8 +13,10 @@ import ( // Update the specified channel group. You can edit the description on a channel // group for easier identification later from the AWS Elemental MediaPackage -// console. You can't edit the name of the channel group. Any edits you make that -// impact the video output may not be reflected for a few minutes. +// console. You can't edit the name of the channel group. +// +// Any edits you make that impact the video output may not be reflected for a few +// minutes. func (c *Client) UpdateChannelGroup(ctx context.Context, params *UpdateChannelGroupInput, optFns ...func(*Options)) (*UpdateChannelGroupOutput, error) { if params == nil { params = &UpdateChannelGroupInput{} diff --git a/service/mediapackagev2/api_op_UpdateOriginEndpoint.go b/service/mediapackagev2/api_op_UpdateOriginEndpoint.go index bf2b5791a5d..4f838409029 100644 --- a/service/mediapackagev2/api_op_UpdateOriginEndpoint.go +++ b/service/mediapackagev2/api_op_UpdateOriginEndpoint.go @@ -14,8 +14,10 @@ import ( // Update the specified origin endpoint. Edit the packaging preferences on an // endpoint to optimize the viewing experience. You can't edit the name of the -// endpoint. Any edits you make that impact the video output may not be reflected -// for a few minutes. +// endpoint. +// +// Any edits you make that impact the video output may not be reflected for a few +// minutes. func (c *Client) UpdateOriginEndpoint(ctx context.Context, params *UpdateOriginEndpointInput, optFns ...func(*Options)) (*UpdateOriginEndpointOutput, error) { if params == nil { params = &UpdateOriginEndpointInput{} diff --git a/service/mediapackagev2/doc.go b/service/mediapackagev2/doc.go index fce7b1f8e1a..5123fba7b67 100644 --- a/service/mediapackagev2/doc.go +++ b/service/mediapackagev2/doc.go @@ -6,19 +6,25 @@ // This guide is intended for creating AWS Elemental MediaPackage resources in // MediaPackage Version 2 (v2) starting from May 2023. To get started with // MediaPackage v2, create your MediaPackage resources. There isn't an automated -// process to migrate your resources from MediaPackage v1 to MediaPackage v2. The -// names of the entities that you use to access this API, like URLs and ARNs, all -// have the versioning information added, like "v2", to distinguish from the prior -// version. If you used MediaPackage prior to this release, you can't use the +// process to migrate your resources from MediaPackage v1 to MediaPackage v2. +// +// The names of the entities that you use to access this API, like URLs and ARNs, +// all have the versioning information added, like "v2", to distinguish from the +// prior version. If you used MediaPackage prior to this release, you can't use the // MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 -// resources. If you created resources in MediaPackage v1, use video on demand -// (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the -// MediaPackage v1 Live API Reference (https://docs.aws.amazon.com/mediapackage/latest/apireference/what-is.html) -// . This is the AWS Elemental MediaPackage v2 Live REST API Reference. It -// describes all the MediaPackage API operations for live content in detail, and -// provides sample requests, responses, and errors for the supported web services -// protocols. We assume that you have the IAM permissions that you need to use -// MediaPackage via the REST API. We also assume that you are familiar with the -// features and operations of MediaPackage, as described in the AWS Elemental -// MediaPackage User Guide. +// resources. +// +// If you created resources in MediaPackage v1, use video on demand (VOD) +// workflows, and aren't looking to migrate to MediaPackage v2 yet, see the [MediaPackage v1 Live API Reference]. +// +// This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes +// all the MediaPackage API operations for live content in detail, and provides +// sample requests, responses, and errors for the supported web services protocols. +// +// We assume that you have the IAM permissions that you need to use MediaPackage +// via the REST API. We also assume that you are familiar with the features and +// operations of MediaPackage, as described in the AWS Elemental MediaPackage User +// Guide. +// +// [MediaPackage v1 Live API Reference]: https://docs.aws.amazon.com/mediapackage/latest/apireference/what-is.html package mediapackagev2 diff --git a/service/mediapackagev2/options.go b/service/mediapackagev2/options.go index 1675fdc9ee6..2924881d009 100644 --- a/service/mediapackagev2/options.go +++ b/service/mediapackagev2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediapackagev2/types/enums.go b/service/mediapackagev2/types/enums.go index 008585a14ff..05a4779a79b 100644 --- a/service/mediapackagev2/types/enums.go +++ b/service/mediapackagev2/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AdMarkerDash. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdMarkerDash) Values() []AdMarkerDash { return []AdMarkerDash{ "BINARY", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for AdMarkerHls. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdMarkerHls) Values() []AdMarkerHls { return []AdMarkerHls{ "DATERANGE", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for CmafEncryptionMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CmafEncryptionMethod) Values() []CmafEncryptionMethod { return []CmafEncryptionMethod{ "CENC", @@ -65,8 +68,9 @@ const ( ) // Values returns all known values for ConflictExceptionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionType) Values() []ConflictExceptionType { return []ConflictExceptionType{ "RESOURCE_IN_USE", @@ -85,8 +89,9 @@ const ( ) // Values returns all known values for ContainerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerType) Values() []ContainerType { return []ContainerType{ "TS", @@ -103,8 +108,9 @@ const ( ) // Values returns all known values for DashDrmSignaling. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashDrmSignaling) Values() []DashDrmSignaling { return []DashDrmSignaling{ "INDIVIDUAL", @@ -124,8 +130,9 @@ const ( ) // Values returns all known values for DashPeriodTrigger. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashPeriodTrigger) Values() []DashPeriodTrigger { return []DashPeriodTrigger{ "AVAILS", @@ -145,6 +152,7 @@ const ( // Values returns all known values for DashSegmentTemplateFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DashSegmentTemplateFormat) Values() []DashSegmentTemplateFormat { return []DashSegmentTemplateFormat{ @@ -163,8 +171,9 @@ const ( ) // Values returns all known values for DashUtcTimingMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashUtcTimingMode) Values() []DashUtcTimingMode { return []DashUtcTimingMode{ "HTTP_HEAD", @@ -185,8 +194,9 @@ const ( ) // Values returns all known values for DrmSystem. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DrmSystem) Values() []DrmSystem { return []DrmSystem{ "CLEAR_KEY_AES_128", @@ -208,8 +218,9 @@ const ( ) // Values returns all known values for PresetSpeke20Audio. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresetSpeke20Audio) Values() []PresetSpeke20Audio { return []PresetSpeke20Audio{ "PRESET_AUDIO_1", @@ -237,8 +248,9 @@ const ( ) // Values returns all known values for PresetSpeke20Video. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresetSpeke20Video) Values() []PresetSpeke20Video { return []PresetSpeke20Video{ "PRESET_VIDEO_1", @@ -264,8 +276,9 @@ const ( ) // Values returns all known values for ResourceTypeNotFound. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceTypeNotFound) Values() []ResourceTypeNotFound { return []ResourceTypeNotFound{ "CHANNEL_GROUP", @@ -290,8 +303,9 @@ const ( ) // Values returns all known values for ScteFilter. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScteFilter) Values() []ScteFilter { return []ScteFilter{ "SPLICE_INSERT", @@ -315,8 +329,9 @@ const ( ) // Values returns all known values for TsEncryptionMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TsEncryptionMethod) Values() []TsEncryptionMethod { return []TsEncryptionMethod{ "AES_128", @@ -376,8 +391,9 @@ const ( ) // Values returns all known values for ValidationExceptionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionType) Values() []ValidationExceptionType { return []ValidationExceptionType{ "CONTAINER_TYPE_IMMUTABLE", diff --git a/service/mediapackagev2/types/types.go b/service/mediapackagev2/types/types.go index 0b4b0e32635..e02aa33515d 100644 --- a/service/mediapackagev2/types/types.go +++ b/service/mediapackagev2/types/types.go @@ -109,9 +109,9 @@ type CreateDashManifestConfiguration struct { // Elemental MediaPackage must create periods in the output manifest that // correspond to SCTE-35 ad markers in the input source. Leave this value empty to // indicate that the manifest is contained all in one period. For more information - // about periods in the DASH manifest, see Multi-period DASH in AWS Elemental - // MediaPackage (https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html) - // . + // about periods in the DASH manifest, see [Multi-period DASH in AWS Elemental MediaPackage]. + // + // [Multi-period DASH in AWS Elemental MediaPackage]: https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html PeriodTriggers []DashPeriodTrigger // The SCTE configuration. @@ -119,7 +119,10 @@ type CreateDashManifestConfiguration struct { // Determines the type of variable used in the media URL of the SegmentTemplate // tag in the manifest. Also specifies if segment timeline information is included - // in SegmentTimeline or SegmentTemplate . Value description: + // in SegmentTimeline or SegmentTemplate . + // + // Value description: + // // - NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The // value of this variable is the sequential number of the segment. A full // SegmentTimeline object is presented in each SegmentTemplate . @@ -169,8 +172,10 @@ type CreateHlsManifestConfiguration struct { // aren't included in the manifest. The tags sync the stream to the wall clock so // that viewers can seek to a specific time in the playback timeline on the player. // ID3Timed metadata messages generate every 5 seconds whenever the content is - // ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS - // input, it is passed through to the HLS output. + // ingested. + // + // Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, + // it is passed through to the HLS output. ProgramDateTimeIntervalSeconds *int32 // The SCTE configuration. @@ -212,8 +217,10 @@ type CreateLowLatencyHlsManifestConfiguration struct { // aren't included in the manifest. The tags sync the stream to the wall clock so // that viewers can seek to a specific time in the playback timeline on the player. // ID3Timed metadata messages generate every 5 seconds whenever the content is - // ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS - // input, it is passed through to the HLS output. + // ingested. + // + // Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, + // it is passed through to the HLS output. ProgramDateTimeIntervalSeconds *int32 // The SCTE configuration. @@ -259,8 +266,10 @@ type Encryption struct { // content begins streaming, and then retrieves them as needed over the lifetime of // the workflow. By default, key rotation is set to 300 seconds (5 minutes), the // minimum rotation interval, which is equivalent to setting it to 300. If you - // don't enter an interval, content keys aren't rotated. The following example - // setting causes the service to rotate keys every thirty minutes: 1800 + // don't enter an interval, content keys aren't rotated. + // + // The following example setting causes the service to rotate keys every thirty + // minutes: 1800 KeyRotationIntervalSeconds *int32 noSmithyDocumentSerde @@ -272,48 +281,67 @@ type Encryption struct { // contract, specify which audio and video encryption presets to use. type EncryptionContractConfiguration struct { - // A collection of audio encryption presets. Value description: + // A collection of audio encryption presets. + // + // Value description: + // // - PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in // your stream. + // // - PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio // tracks and one content key to encrypt all of the multichannel audio tracks. + // // - PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio // tracks, one content key to encrypt all of the multichannel audio tracks with 3 // to 6 channels, and one content key to encrypt all of the multichannel audio // tracks with more than 6 channels. + // // - SHARED - Use the same content key for all of the audio and video tracks in // your stream. + // // - UNENCRYPTED - Don't encrypt any of the audio tracks in your stream. // // This member is required. PresetSpeke20Audio PresetSpeke20Audio - // A collection of video encryption presets. Value description: + // A collection of video encryption presets. + // + // Value description: + // // - PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in // your stream. + // // - PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks // and one content key for all HD and higher resolutions video tracks. + // // - PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, // one content key for HD video tracks and one content key for all UHD video // tracks. + // // - PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, // one content key for HD video tracks, one content key for all UHD1 video tracks // and one content key for all UHD2 video tracks. + // // - PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, // one content key for HD1 video tracks, one content key for HD2 video tracks, one // content key for all UHD1 video tracks and one content key for all UHD2 video // tracks. + // // - PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, // one content key for HD1 video tracks, one content key for HD2 video tracks and // one content key for all UHD video tracks. + // // - PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video // tracks, one content key for HD2 video tracks and one content key for all UHD // video tracks. + // // - PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video // tracks, one content key for HD2 video tracks, one content key for all UHD1 video // tracks and one content key for all UHD2 video tracks. + // // - SHARED - Use the same content key for all of the video and audio tracks in // your stream. + // // - UNENCRYPTED - Don't encrypt any of the video tracks in your stream. // // This member is required. @@ -400,9 +428,9 @@ type GetDashManifestConfiguration struct { // A list of triggers that controls when AWS Elemental MediaPackage separates the // MPEG-DASH manifest into multiple periods. Leave this value empty to indicate // that the manifest is contained all in one period. For more information about - // periods in the DASH manifest, see Multi-period DASH in AWS Elemental - // MediaPackage (https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html) - // . + // periods in the DASH manifest, see [Multi-period DASH in AWS Elemental MediaPackage]. + // + // [Multi-period DASH in AWS Elemental MediaPackage]: https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html PeriodTriggers []DashPeriodTrigger // The SCTE configuration. @@ -410,7 +438,10 @@ type GetDashManifestConfiguration struct { // Determines the type of variable used in the media URL of the SegmentTemplate // tag in the manifest. Also specifies if segment timeline information is included - // in SegmentTimeline or SegmentTemplate . Value description: + // in SegmentTimeline or SegmentTemplate . + // + // Value description: + // // - NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The // value of this variable is the sequential number of the segment. A full // SegmentTimeline object is presented in each SegmentTemplate . @@ -465,8 +496,10 @@ type GetHlsManifestConfiguration struct { // aren't included in the manifest. The tags sync the stream to the wall clock so // that viewers can seek to a specific time in the playback timeline on the player. // ID3Timed metadata messages generate every 5 seconds whenever the content is - // ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS - // input, it is passed through to the HLS output. + // ingested. + // + // Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, + // it is passed through to the HLS output. ProgramDateTimeIntervalSeconds *int32 // The SCTE configuration. @@ -513,8 +546,10 @@ type GetLowLatencyHlsManifestConfiguration struct { // aren't included in the manifest. The tags sync the stream to the wall clock so // that viewers can seek to a specific time in the playback timeline on the player. // ID3Timed metadata messages generate every 5 seconds whenever the content is - // ingested. Irrespective of this parameter, if any ID3Timed metadata is in the HLS - // input, it is passed through to the HLS output. + // ingested. + // + // Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, + // it is passed through to the HLS output. ProgramDateTimeIntervalSeconds *int32 // The SCTE configuration. @@ -675,9 +710,13 @@ type ScteDash struct { // Choose how ad markers are included in the packaged content. If you include ad // markers in the content stream in your upstream encoders, then you need to inform - // MediaPackage what to do with the ad markers in the output. Value description: + // MediaPackage what to do with the ad markers in the output. + // + // Value description: + // // - Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) // rather than full XML. + // // - XML - The SCTE marker is expressed fully in XML. AdMarkerDash AdMarkerDash @@ -690,12 +729,16 @@ type ScteHls struct { // Ad markers indicate when ads should be inserted during playback. If you include // ad markers in the content stream in your upstream encoders, then you need to // inform MediaPackage what to do with the ad markers in the output. Choose what - // you want MediaPackage to do with the ad markers. Value description: + // you want MediaPackage to do with the ad markers. + // + // Value description: + // // - DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition // events in TS and CMAF manifests. If you use DATERANGE, you must set a // programDateTimeIntervalSeconds value of 1 or higher. To learn more about - // DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE (http://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html) - // . + // DATERANGE, see [SCTE-35 Ad Marker EXT-X-DATERANGE]. + // + // [SCTE-35 Ad Marker EXT-X-DATERANGE]: http://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html AdMarkerHls AdMarkerHls noSmithyDocumentSerde @@ -763,8 +806,9 @@ type SpekeKeyProvider struct { // to identify the current endpoint. How unique you make this depends on how // fine-grained you want access controls to be. The service does not permit you to // use the same ID for two simultaneous encryption processes. The resource ID is - // also known as the content ID. The following example shows a resource ID: - // MovieNight20171126093045 + // also known as the content ID. + // + // The following example shows a resource ID: MovieNight20171126093045 // // This member is required. ResourceId *string @@ -773,15 +817,19 @@ type SpekeKeyProvider struct { // the key provider API. This role must have a trust policy that allows // MediaPackage to assume the role, and it must have a sufficient permissions // policy to allow access to the specific key retrieval URL. Get this from your DRM - // solution provider. Valid format: arn:aws:iam::{accountID}:role/{name} . The - // following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess + // solution provider. + // + // Valid format: arn:aws:iam::{accountID}:role/{name} . The following example shows + // a role ARN: arn:aws:iam::444455556666:role/SpekeAccess // // This member is required. RoleArn *string // The URL of the API Gateway proxy that you set up to talk to your key server. // The API Gateway proxy must reside in the same AWS Region as MediaPackage and - // must start with https://. The following example shows a URL: + // must start with https://. + // + // The following example shows a URL: // https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection // // This member is required. diff --git a/service/mediapackagevod/options.go b/service/mediapackagevod/options.go index c442d68e51b..1b9ae551bbd 100644 --- a/service/mediapackagevod/options.go +++ b/service/mediapackagevod/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediapackagevod/types/enums.go b/service/mediapackagevod/types/enums.go index 9deaa430e41..3bf9977d8f7 100644 --- a/service/mediapackagevod/types/enums.go +++ b/service/mediapackagevod/types/enums.go @@ -10,8 +10,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ADS", @@ -28,8 +29,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for EncryptionMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionMethod) Values() []EncryptionMethod { return []EncryptionMethod{ "AES_128", @@ -65,8 +68,9 @@ const ( ) // Values returns all known values for ManifestLayout. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManifestLayout) Values() []ManifestLayout { return []ManifestLayout{ "FULL", @@ -86,8 +90,9 @@ const ( ) // Values returns all known values for PresetSpeke20Audio. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresetSpeke20Audio) Values() []PresetSpeke20Audio { return []PresetSpeke20Audio{ "PRESET-AUDIO-1", @@ -115,8 +120,9 @@ const ( ) // Values returns all known values for PresetSpeke20Video. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PresetSpeke20Video) Values() []PresetSpeke20Video { return []PresetSpeke20Video{ "PRESET-VIDEO-1", @@ -141,8 +147,9 @@ const ( ) // Values returns all known values for Profile. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Profile) Values() []Profile { return []Profile{ "NONE", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for ScteMarkersSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScteMarkersSource) Values() []ScteMarkersSource { return []ScteMarkersSource{ "SEGMENTS", @@ -178,8 +186,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NUMBER_WITH_TIMELINE", @@ -198,8 +207,9 @@ const ( ) // Values returns all known values for StreamOrder. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamOrder) Values() []StreamOrder { return []StreamOrder{ "ORIGINAL", diff --git a/service/mediastore/api_op_CreateContainer.go b/service/mediastore/api_op_CreateContainer.go index 45548f0dfeb..83165f7a895 100644 --- a/service/mediastore/api_op_CreateContainer.go +++ b/service/mediastore/api_op_CreateContainer.go @@ -43,8 +43,9 @@ 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]. + // + // [Tagging Resources in MediaStore]: https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -54,14 +55,19 @@ 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: - // arn:aws:mediastore:us-west-2:111122223333:container/movies ContainerName: The - // container name as specified in the request. CreationTime: Unix time stamp. + // 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. - // To make downstream requests, you must obtain this value by using - // DescribeContainer or ListContainers . + // changes to ACTIVE . + // + // The return value does not include the container's endpoint. To make downstream + // requests, you must obtain this value by using DescribeContaineror ListContainers. // // This member is required. Container *types.Container diff --git a/service/mediastore/api_op_DeleteCorsPolicy.go b/service/mediastore/api_op_DeleteCorsPolicy.go index d3cd8e2ffba..12b3d1a4aa1 100644 --- a/service/mediastore/api_op_DeleteCorsPolicy.go +++ b/service/mediastore/api_op_DeleteCorsPolicy.go @@ -11,9 +11,11 @@ import ( ) // Deletes 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:DeleteCorsPolicy action. The container owner has this -// permission by default and can grant this permission to others. +// is set for the container. +// +// To use this operation, you must have permission to perform the +// MediaStore:DeleteCorsPolicy action. The container owner has this permission by +// default and can grant this permission to others. func (c *Client) DeleteCorsPolicy(ctx context.Context, params *DeleteCorsPolicyInput, optFns ...func(*Options)) (*DeleteCorsPolicyOutput, error) { if params == nil { params = &DeleteCorsPolicyInput{} diff --git a/service/mediastore/api_op_DescribeContainer.go b/service/mediastore/api_op_DescribeContainer.go index b137a564600..a26bff11944 100644 --- a/service/mediastore/api_op_DescribeContainer.go +++ b/service/mediastore/api_op_DescribeContainer.go @@ -16,7 +16,7 @@ import ( // 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 . +// 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 3af64c4c8e8..df7dd166127 100644 --- a/service/mediastore/api_op_GetContainerPolicy.go +++ b/service/mediastore/api_op_GetContainerPolicy.go @@ -11,8 +11,9 @@ 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/) . +// the data that is included in an access policy, see the [AWS Identity and Access Management User Guide]. +// +// [AWS Identity and Access 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 53efe595309..b0eaa68d226 100644 --- a/service/mediastore/api_op_GetCorsPolicy.go +++ b/service/mediastore/api_op_GetCorsPolicy.go @@ -12,9 +12,11 @@ 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. +// 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. 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 97fdd70ca05..dba00a2deb6 100644 --- a/service/mediastore/api_op_ListContainers.go +++ b/service/mediastore/api_op_ListContainers.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the properties of all containers in AWS Elemental MediaStore. You can -// query to receive all the containers in one response. Or you can include the -// MaxResults parameter to receive a limited number of containers in each response. -// 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 -// gets the properties of one container. +// Lists the properties of all containers in AWS Elemental MediaStore. +// +// You can query to receive all the containers in one response. Or you can include +// the MaxResults parameter to receive a limited number of containers in each +// response. 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 gets the properties of one container. func (c *Client) ListContainers(ctx context.Context, params *ListContainersInput, optFns ...func(*Options)) (*ListContainersOutput, error) { if params == nil { params = &ListContainersInput{} diff --git a/service/mediastore/api_op_PutContainerPolicy.go b/service/mediastore/api_op_PutContainerPolicy.go index 60ae5bb407b..7a5744c0fdb 100644 --- a/service/mediastore/api_op_PutContainerPolicy.go +++ b/service/mediastore/api_op_PutContainerPolicy.go @@ -12,10 +12,13 @@ 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 +// an access policy, see the [AWS Identity and Access Management User Guide]. +// +// 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. +// +// [AWS Identity and Access Management User Guide]: https://aws.amazon.com/documentation/iam/ func (c *Client) PutContainerPolicy(ctx context.Context, params *PutContainerPolicyInput, optFns ...func(*Options)) (*PutContainerPolicyOutput, error) { if params == nil { params = &PutContainerPolicyInput{} @@ -39,7 +42,9 @@ 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. // // This member is required. diff --git a/service/mediastore/api_op_PutCorsPolicy.go b/service/mediastore/api_op_PutCorsPolicy.go index ef09096f340..0987fa7be56 100644 --- a/service/mediastore/api_op_PutCorsPolicy.go +++ b/service/mediastore/api_op_PutCorsPolicy.go @@ -15,14 +15,17 @@ import ( // that the container can service cross-origin requests. For example, you might // want to enable a request whose origin is http://www.example.com to access your // AWS Elemental MediaStore container at my.example.container.com by using the -// browser's XMLHttpRequest capability. To enable CORS on a container, you attach a -// CORS policy to the container. In the CORS policy, you configure rules that -// identify origins and the HTTP methods that can be executed on your container. -// 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) -// . +// browser's XMLHttpRequest capability. +// +// To enable CORS on a container, you attach a CORS policy to the container. In +// the CORS policy, you configure rules that identify origins and the HTTP methods +// that can be executed on your container. 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]. +// +// [Cross-Origin Resource 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 96ad1e05cb8..82b5dc0456e 100644 --- a/service/mediastore/api_op_PutLifecyclePolicy.go +++ b/service/mediastore/api_op_PutLifecyclePolicy.go @@ -12,10 +12,11 @@ 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) -// . +// 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]. +// +// [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 76352d225a7..e6f767667eb 100644 --- a/service/mediastore/api_op_PutMetricPolicy.go +++ b/service/mediastore/api_op_PutMetricPolicy.go @@ -41,11 +41,13 @@ 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). diff --git a/service/mediastore/api_op_TagResource.go b/service/mediastore/api_op_TagResource.go index a6b52203dac..b50cc99f0f3 100644 --- a/service/mediastore/api_op_TagResource.go +++ b/service/mediastore/api_op_TagResource.go @@ -16,8 +16,9 @@ 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]. +// +// [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/options.go b/service/mediastore/options.go index eb2dfdac997..88f934d24ba 100644 --- a/service/mediastore/options.go +++ b/service/mediastore/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediastore/types/enums.go b/service/mediastore/types/enums.go index 3bb52b7f915..c901b9ba22b 100644 --- a/service/mediastore/types/enums.go +++ b/service/mediastore/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ENABLED", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ContainerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerStatus) Values() []ContainerStatus { return []ContainerStatus{ "ACTIVE", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for MethodName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MethodName) Values() []MethodName { return []MethodName{ "PUT", diff --git a/service/mediastore/types/types.go b/service/mediastore/types/types.go index 10e2ef570ff..df530ee9976 100644 --- a/service/mediastore/types/types.go +++ b/service/mediastore/types/types.go @@ -12,8 +12,11 @@ import ( type Container struct { // The Amazon Resource Name (ARN) of the container. The ARN has the following - // format: arn:aws:::container/ For example: - // arn:aws:mediastore:us-west-2:111122223333:container/movies + // format: + // + // arn:aws:::container/ + // + // For example: arn:aws:mediastore:us-west-2:111122223333:container/movies ARN *string // The state of access logging on the container. This value is false by default, @@ -51,16 +54,18 @@ type CorsRule struct { // Specifies which headers are allowed in a preflight OPTIONS request through the // Access-Control-Request-Headers header. Each header name that is specified in // Access-Control-Request-Headers must have a corresponding entry in the rule. Only - // the headers that were requested are sent back. This element can contain only one - // wildcard character (*). + // the headers that were requested are sent back. + // + // This element can contain only one wildcard character (*). // // 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. + // 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. // @@ -68,17 +73,22 @@ type CorsRule struct { AllowedOrigins []string // Identifies an HTTP method that the origin that is specified in the rule is - // allowed to execute. Each CORS rule must contain at least one AllowedMethods and - // one AllowedOrigins element. + // allowed to execute. + // + // Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins + // element. AllowedMethods []MethodName // One or more headers in the response that you want users to be able to access // from their applications (for example, from a JavaScript XMLHttpRequest object). + // // This element is optional for each rule. ExposeHeaders []string // The time in seconds that your browser caches the preflight response for the - // specified resource. A CORS rule can have only one MaxAgeSeconds element. + // specified resource. + // + // A CORS rule can have only one MaxAgeSeconds element. MaxAgeSeconds int32 noSmithyDocumentSerde @@ -88,9 +98,11 @@ type CorsRule struct { // AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, // 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) -// . +// to send object-level metrics for. +// +// To view examples of how to construct a metric policy for your use case, see [Example Metric Policies]. +// +// [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,8 +113,9 @@ 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) - // to allow up to 300 rules per policy. + // You can also [request a quota increase]to allow up to 300 rules per policy. + // + // [request a quota increase]: https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas MetricPolicyRules []MetricPolicyRule noSmithyDocumentSerde @@ -111,9 +124,10 @@ type MetricPolicy struct { // 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. +// policy can include up to five rules by default. You can also [request a quota increase]to allow up to 300 +// rules per policy. +// +// [request a quota increase]: https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas type MetricPolicyRule struct { // A path or file name that defines which objects to include in the group. @@ -135,8 +149,9 @@ type MetricPolicyRule struct { // 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 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) . +// about tagging, including naming and usage conventions, see [Tagging Resources in MediaStore]. +// +// [Tagging Resources in 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 diff --git a/service/mediastoredata/api_op_DescribeObject.go b/service/mediastoredata/api_op_DescribeObject.go index d060f5b1ec3..5c79578cf2f 100644 --- a/service/mediastoredata/api_op_DescribeObject.go +++ b/service/mediastoredata/api_op_DescribeObject.go @@ -41,9 +41,11 @@ type DescribeObjectInput struct { 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. + // cache behavior. Headers can be passed in as specified in the HTTP at [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 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 1f320c38d49..d09df6737f0 100644 --- a/service/mediastoredata/api_op_GetObject.go +++ b/service/mediastoredata/api_op_GetObject.go @@ -33,27 +33,37 @@ func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns . 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 + // 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]. + // + // 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. // + // [AWS Elemental MediaStore User Guide]: http://docs.aws.amazon.com/mediastore/latest/ug/ + // // 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]. AWS Elemental MediaStore ignores this header for partially + // uploaded objects that have streaming upload availability. + // + // [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35 Range *string noSmithyDocumentSerde @@ -72,9 +82,11 @@ type GetObjectOutput struct { Body io.ReadCloser // 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. + // 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]. + // + // 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 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 660cf4d78ba..32829ab53f1 100644 --- a/service/mediastoredata/api_op_ListItems.go +++ b/service/mediastoredata/api_op_ListItems.go @@ -35,6 +35,7 @@ type ListItemsInput struct { // 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 @@ -43,7 +44,9 @@ type ListItemsInput struct { // 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. + // and specify the NextToken value. + // + // Tokens expire after 15 minutes. NextToken *string // The path in the container from which to retrieve items. Format: // @@ -159,6 +162,7 @@ type ListItemsPaginatorOptions struct { // 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 diff --git a/service/mediastoredata/api_op_PutObject.go b/service/mediastoredata/api_op_PutObject.go index c1c5584c478..f8c1b37f5f0 100644 --- a/service/mediastoredata/api_op_PutObject.go +++ b/service/mediastoredata/api_op_PutObject.go @@ -37,27 +37,38 @@ type PutObjectInput struct { Body io.Reader // 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 + // 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]. + // + // 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. // + // [AWS Elemental MediaStore User Guide]: http://docs.aws.amazon.com/mediastore/latest/ug/ + // // 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. + // cache behavior. Headers can be passed in as specified in the HTTP at [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 CacheControl *string // The content type of the object. @@ -72,8 +83,10 @@ type PutObjectInput struct { // 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 . + // 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/options.go b/service/mediastoredata/options.go index dc72f32ff42..20dfd96d9ad 100644 --- a/service/mediastoredata/options.go +++ b/service/mediastoredata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediastoredata/types/enums.go b/service/mediastoredata/types/enums.go index 98e380f8358..a9eb35c2533 100644 --- a/service/mediastoredata/types/enums.go +++ b/service/mediastoredata/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ItemType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ItemType) Values() []ItemType { return []ItemType{ "OBJECT", @@ -28,8 +29,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for UploadAvailability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UploadAvailability) Values() []UploadAvailability { return []UploadAvailability{ "STANDARD", diff --git a/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go b/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go index fde87703213..0839c15b6aa 100644 --- a/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go +++ b/service/mediatailor/api_op_ConfigureLogsForPlaybackConfiguration.go @@ -34,8 +34,11 @@ type ConfigureLogsForPlaybackConfigurationInput struct { // 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]. + // + // Valid values: 0 - 100 + // + // [debug log mode]: https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html // // This member is required. PercentEnabled int32 diff --git a/service/mediatailor/api_op_CreateChannel.go b/service/mediatailor/api_op_CreateChannel.go index 66fcde1f701..98f5f9033bd 100644 --- a/service/mediatailor/api_op_CreateChannel.go +++ b/service/mediatailor/api_op_CreateChannel.go @@ -12,9 +12,10 @@ import ( "time" ) -// Creates a channel. For information about MediaTailor channels, see Working with -// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) -// in the MediaTailor User Guide. +// Creates a channel. For information about MediaTailor channels, see [Working with channels] in the +// MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error) { if params == nil { params = &CreateChannelInput{} @@ -42,11 +43,13 @@ type CreateChannelInput struct { // This member is required. Outputs []types.RequestOutputItem - // The type of playback mode to use for this channel. LINEAR - The programs in the - // schedule play once back-to-back in the schedule. LOOP - The programs in the - // schedule play back-to-back in an endless loop. When the last program in the - // schedule stops playing, playback loops back to the first program in the - // schedule. + // The type of playback mode to use for this channel. + // + // LINEAR - The programs in the schedule play once back-to-back in the schedule. + // + // LOOP - The programs in the schedule play back-to-back in an endless loop. When + // the last program in the schedule stops playing, playback loops back to the first + // program in the schedule. // // This member is required. PlaybackMode types.PlaybackMode @@ -62,14 +65,15 @@ type CreateChannelInput 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string // The tier of the channel. Tier types.Tier - // The time-shifted viewing configuration you want to associate to the channel. + // The time-shifted viewing configuration you want to associate to the channel. TimeShiftConfiguration *types.TimeShiftConfiguration noSmithyDocumentSerde @@ -107,14 +111,15 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string // The tier of the channel. Tier *string - // The time-shifted viewing configuration assigned to the channel. + // The time-shifted viewing configuration assigned to the channel. TimeShiftConfiguration *types.TimeShiftConfiguration // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_CreateLiveSource.go b/service/mediatailor/api_op_CreateLiveSource.go index c3733eb27cd..48d030f0bda 100644 --- a/service/mediatailor/api_op_CreateLiveSource.go +++ b/service/mediatailor/api_op_CreateLiveSource.go @@ -47,8 +47,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde @@ -76,8 +77,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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_CreatePrefetchSchedule.go b/service/mediatailor/api_op_CreatePrefetchSchedule.go index 1f696bd48a3..5d24ab54bc8 100644 --- a/service/mediatailor/api_op_CreatePrefetchSchedule.go +++ b/service/mediatailor/api_op_CreatePrefetchSchedule.go @@ -13,9 +13,10 @@ 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. +// break happens. For more information about ad prefetching, see [Using ad prefetching]in the +// MediaTailor User Guide. +// +// [Using ad prefetching]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html func (c *Client) CreatePrefetchSchedule(ctx context.Context, params *CreatePrefetchScheduleInput, optFns ...func(*Options)) (*CreatePrefetchScheduleOutput, error) { if params == nil { params = &CreatePrefetchScheduleInput{} diff --git a/service/mediatailor/api_op_CreateProgram.go b/service/mediatailor/api_op_CreateProgram.go index fd3b0db480a..93582648889 100644 --- a/service/mediatailor/api_op_CreateProgram.go +++ b/service/mediatailor/api_op_CreateProgram.go @@ -12,9 +12,10 @@ import ( "time" ) -// 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) -// in the MediaTailor User Guide. +// Creates a program within a channel. For information about programs, see [Working with programs] in the +// MediaTailor User Guide. +// +// [Working with programs]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html func (c *Client) CreateProgram(ctx context.Context, params *CreateProgramInput, optFns ...func(*Options)) (*CreateProgramOutput, error) { if params == nil { params = &CreateProgramInput{} diff --git a/service/mediatailor/api_op_CreateSourceLocation.go b/service/mediatailor/api_op_CreateSourceLocation.go index 01547c69669..81d1d4762ba 100644 --- a/service/mediatailor/api_op_CreateSourceLocation.go +++ b/service/mediatailor/api_op_CreateSourceLocation.go @@ -13,8 +13,9 @@ 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) -// in the MediaTailor User Guide. +// more information about source locations, see [Working with source locations]in the MediaTailor User Guide. +// +// [Working with source locations]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html func (c *Client) CreateSourceLocation(ctx context.Context, params *CreateSourceLocationInput, optFns ...func(*Options)) (*CreateSourceLocationOutput, error) { if params == nil { params = &CreateSourceLocationInput{} @@ -54,8 +55,9 @@ type CreateSourceLocationInput struct { // 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) . + // and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde @@ -83,9 +85,9 @@ type CreateSourceLocationOutput struct { LastModifiedTime *time.Time // 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) - // . + // about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor]. + // + // [Working with configurations in AWS Elemental MediaTailor]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html SegmentDeliveryConfigurations []types.SegmentDeliveryConfiguration // The name to assign to the source location. @@ -93,8 +95,9 @@ type CreateSourceLocationOutput struct { // 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) . + // and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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 c90255cbea0..7f54af4447f 100644 --- a/service/mediatailor/api_op_CreateVodSource.go +++ b/service/mediatailor/api_op_CreateVodSource.go @@ -47,8 +47,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde @@ -73,8 +74,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor 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 0d8b049b267..dbe084e077a 100644 --- a/service/mediatailor/api_op_DeleteChannel.go +++ b/service/mediatailor/api_op_DeleteChannel.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a channel. For information about MediaTailor channels, see Working with -// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) -// in the MediaTailor User Guide. +// Deletes a channel. For information about MediaTailor channels, see [Working with channels] in the +// MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error) { if params == nil { params = &DeleteChannelInput{} diff --git a/service/mediatailor/api_op_DeletePlaybackConfiguration.go b/service/mediatailor/api_op_DeletePlaybackConfiguration.go index 569463e9f41..1d7a6be7b88 100644 --- a/service/mediatailor/api_op_DeletePlaybackConfiguration.go +++ b/service/mediatailor/api_op_DeletePlaybackConfiguration.go @@ -11,8 +11,9 @@ 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]. +// +// [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 d77fd690d40..f347d12dbb2 100644 --- a/service/mediatailor/api_op_DeletePrefetchSchedule.go +++ b/service/mediatailor/api_op_DeletePrefetchSchedule.go @@ -12,9 +12,10 @@ 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. +// HTTP 404 status code. For more information about ad prefetching, see [Using ad prefetching]in the +// MediaTailor User Guide. +// +// [Using ad prefetching]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html 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 97aa38589d1..b05eec484e2 100644 --- a/service/mediatailor/api_op_DeleteProgram.go +++ b/service/mediatailor/api_op_DeleteProgram.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the MediaTailor User Guide. +// Deletes a program within a channel. For information about programs, see [Working with programs] in the +// MediaTailor User Guide. +// +// [Working with programs]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html func (c *Client) DeleteProgram(ctx context.Context, params *DeleteProgramInput, optFns ...func(*Options)) (*DeleteProgramOutput, error) { if params == nil { params = &DeleteProgramInput{} diff --git a/service/mediatailor/api_op_DeleteSourceLocation.go b/service/mediatailor/api_op_DeleteSourceLocation.go index 346415e5be7..b1f1e94c200 100644 --- a/service/mediatailor/api_op_DeleteSourceLocation.go +++ b/service/mediatailor/api_op_DeleteSourceLocation.go @@ -11,8 +11,9 @@ 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) -// in the MediaTailor User Guide. +// more information about source locations, see [Working with source locations]in the MediaTailor User Guide. +// +// [Working with source locations]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html func (c *Client) DeleteSourceLocation(ctx context.Context, params *DeleteSourceLocationInput, optFns ...func(*Options)) (*DeleteSourceLocationOutput, error) { if params == nil { params = &DeleteSourceLocationInput{} diff --git a/service/mediatailor/api_op_DescribeChannel.go b/service/mediatailor/api_op_DescribeChannel.go index af412265418..58a5528841d 100644 --- a/service/mediatailor/api_op_DescribeChannel.go +++ b/service/mediatailor/api_op_DescribeChannel.go @@ -12,9 +12,10 @@ import ( "time" ) -// Describes a channel. For information about MediaTailor channels, see Working -// with channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) -// in the MediaTailor User Guide. +// Describes a channel. For information about MediaTailor channels, see [Working with channels] in the +// MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error) { if params == nil { params = &DescribeChannelInput{} @@ -77,14 +78,15 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string // The channel's tier. Tier *string - // The time-shifted viewing configuration for the channel. + // The time-shifted viewing configuration for the channel. TimeShiftConfiguration *types.TimeShiftConfiguration // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_DescribeLiveSource.go b/service/mediatailor/api_op_DescribeLiveSource.go index 9660030e008..108337011d1 100644 --- a/service/mediatailor/api_op_DescribeLiveSource.go +++ b/service/mediatailor/api_op_DescribeLiveSource.go @@ -65,8 +65,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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_DescribeProgram.go b/service/mediatailor/api_op_DescribeProgram.go index d14f1a4c3fc..766de126982 100644 --- a/service/mediatailor/api_op_DescribeProgram.go +++ b/service/mediatailor/api_op_DescribeProgram.go @@ -12,9 +12,10 @@ import ( "time" ) -// 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) -// in the MediaTailor User Guide. +// Describes a program within a channel. For information about programs, see [Working with programs] in +// the MediaTailor User Guide. +// +// [Working with programs]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html func (c *Client) DescribeProgram(ctx context.Context, params *DescribeProgramInput, optFns ...func(*Options)) (*DescribeProgramOutput, error) { if params == nil { params = &DescribeProgramInput{} diff --git a/service/mediatailor/api_op_DescribeSourceLocation.go b/service/mediatailor/api_op_DescribeSourceLocation.go index 5313c9ab89e..9eeec21f4c4 100644 --- a/service/mediatailor/api_op_DescribeSourceLocation.go +++ b/service/mediatailor/api_op_DescribeSourceLocation.go @@ -13,8 +13,9 @@ 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) -// in the MediaTailor User Guide. +// more information about source locations, see [Working with source locations]in the MediaTailor User Guide. +// +// [Working with source locations]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html func (c *Client) DescribeSourceLocation(ctx context.Context, params *DescribeSourceLocationInput, optFns ...func(*Options)) (*DescribeSourceLocationOutput, error) { if params == nil { params = &DescribeSourceLocationInput{} @@ -68,8 +69,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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_DescribeVodSource.go b/service/mediatailor/api_op_DescribeVodSource.go index dc57200931b..c2aef46334c 100644 --- a/service/mediatailor/api_op_DescribeVodSource.go +++ b/service/mediatailor/api_op_DescribeVodSource.go @@ -66,8 +66,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor 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 8e3f353305b..831951653b1 100644 --- a/service/mediatailor/api_op_GetChannelSchedule.go +++ b/service/mediatailor/api_op_GetChannelSchedule.go @@ -47,11 +47,15 @@ type GetChannelScheduleInput struct { MaxResults *int32 // (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. + // 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. NextToken *string noSmithyDocumentSerde diff --git a/service/mediatailor/api_op_GetPlaybackConfiguration.go b/service/mediatailor/api_op_GetPlaybackConfiguration.go index e7ce1ea45e6..d48c1d0b9b7 100644 --- a/service/mediatailor/api_op_GetPlaybackConfiguration.go +++ b/service/mediatailor/api_op_GetPlaybackConfiguration.go @@ -12,8 +12,9 @@ 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]. +// +// [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 +50,16 @@ 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]. + // + // [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) . + // at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers] + // . + // + // [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 +67,9 @@ 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]. + // + // [Domain Variables]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html ConfigurationAliases map[string]map[string]string // The configuration for DASH content. @@ -99,8 +104,9 @@ 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]. + // + // [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. @@ -124,9 +130,9 @@ 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) - // . + // control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental 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 15cba6757de..e8a466fc239 100644 --- a/service/mediatailor/api_op_GetPrefetchSchedule.go +++ b/service/mediatailor/api_op_GetPrefetchSchedule.go @@ -13,9 +13,10 @@ 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. +// break happens. For more information about ad prefetching, see [Using ad prefetching]in the +// MediaTailor User Guide. +// +// [Using ad prefetching]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html 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_ListPlaybackConfigurations.go b/service/mediatailor/api_op_ListPlaybackConfigurations.go index 31309d946c5..e9b47117cb7 100644 --- a/service/mediatailor/api_op_ListPlaybackConfigurations.go +++ b/service/mediatailor/api_op_ListPlaybackConfigurations.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/mediatailor/api_op_ListPrefetchSchedules.go b/service/mediatailor/api_op_ListPrefetchSchedules.go index 6be09ef1696..faf2ec462be 100644 --- a/service/mediatailor/api_op_ListPrefetchSchedules.go +++ b/service/mediatailor/api_op_ListPrefetchSchedules.go @@ -41,11 +41,15 @@ type ListPrefetchSchedulesInput struct { MaxResults *int32 // (Optional) If the playback configuration has more than MaxResults prefetch - // schedules, use NextToken to get the second and subsequent pages of results. For - // the first ListPrefetchSchedulesRequest 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 prefetch schedules to get. + // schedules, use NextToken to get the second and subsequent pages of results. + // + // For the first ListPrefetchSchedulesRequest 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 + // prefetch schedules to get. NextToken *string // An optional filtering parameter whereby MediaTailor filters the prefetch diff --git a/service/mediatailor/api_op_ListSourceLocations.go b/service/mediatailor/api_op_ListSourceLocations.go index dd2a5dbbe24..055f692b603 100644 --- a/service/mediatailor/api_op_ListSourceLocations.go +++ b/service/mediatailor/api_op_ListSourceLocations.go @@ -30,7 +30,7 @@ func (c *Client) ListSourceLocations(ctx context.Context, params *ListSourceLoca type ListSourceLocationsInput struct { - // The maximum number of source locations that you want MediaTailor to return in + // The maximum number of source locations that you want MediaTailor to return in // response to the current request. If there are more than MaxResults source // locations, use the value of NextToken in the response to get the next page of // results. @@ -145,7 +145,7 @@ var _ ListSourceLocationsAPIClient = (*Client)(nil) // ListSourceLocationsPaginatorOptions is the paginator options for // ListSourceLocations type ListSourceLocationsPaginatorOptions struct { - // The maximum number of source locations that you want MediaTailor to return in + // The maximum number of source locations that you want MediaTailor to return in // response to the current request. If there are more than MaxResults source // locations, use the value of NextToken in the response to get the next page of // results. diff --git a/service/mediatailor/api_op_ListTagsForResource.go b/service/mediatailor/api_op_ListTagsForResource.go index 29ae225d56d..a02cdb52c66 100644 --- a/service/mediatailor/api_op_ListTagsForResource.go +++ b/service/mediatailor/api_op_ListTagsForResource.go @@ -12,9 +12,9 @@ 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) -// . +// control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. +// +// [Tagging AWS Elemental 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{} @@ -44,8 +44,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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_ListVodSources.go b/service/mediatailor/api_op_ListVodSources.go index 7b5186d8c54..43107d5d945 100644 --- a/service/mediatailor/api_op_ListVodSources.go +++ b/service/mediatailor/api_op_ListVodSources.go @@ -35,7 +35,7 @@ type ListVodSourcesInput struct { // This member is required. SourceLocationName *string - // The maximum number of VOD sources that you want MediaTailor to return in + // The maximum number of VOD sources that you want MediaTailor to return in // response to the current request. If there are more than MaxResults VOD sources, // use the value of NextToken in the response to get the next page of results. MaxResults *int32 @@ -151,7 +151,7 @@ var _ ListVodSourcesAPIClient = (*Client)(nil) // ListVodSourcesPaginatorOptions is the paginator options for ListVodSources type ListVodSourcesPaginatorOptions struct { - // The maximum number of VOD sources that you want MediaTailor to return in + // The maximum number of VOD sources that you want MediaTailor to return in // response to the current request. If there are more than MaxResults VOD sources, // use the value of NextToken in the response to get the next page of results. Limit int32 diff --git a/service/mediatailor/api_op_PutPlaybackConfiguration.go b/service/mediatailor/api_op_PutPlaybackConfiguration.go index dd9690bfb93..24527b8d688 100644 --- a/service/mediatailor/api_op_PutPlaybackConfiguration.go +++ b/service/mediatailor/api_op_PutPlaybackConfiguration.go @@ -12,8 +12,9 @@ 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]. +// +// [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 +45,16 @@ 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]. + // + // [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) . + // at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers] + // . + // + // [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 +62,9 @@ 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]. + // + // [Domain Variables]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html ConfigurationAliases map[string]map[string]string // The configuration for DASH content. @@ -85,8 +90,9 @@ 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]. + // + // [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 @@ -99,9 +105,9 @@ 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) - // . + // control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental 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 @@ -127,13 +133,16 @@ 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]. + // + // [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) . + // at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers] + // . + // + // [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 @@ -141,8 +150,9 @@ 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]. + // + // [Domain Variables]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html ConfigurationAliases map[string]map[string]string // The configuration for DASH content. @@ -177,8 +187,9 @@ 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]. + // + // [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. @@ -201,9 +212,9 @@ 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) - // . + // control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental 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 9baa90260a6..f776621bcea 100644 --- a/service/mediatailor/api_op_StartChannel.go +++ b/service/mediatailor/api_op_StartChannel.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a channel. For information about MediaTailor channels, see Working with -// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) -// in the MediaTailor User Guide. +// Starts a channel. For information about MediaTailor channels, see [Working with channels] in the +// MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html func (c *Client) StartChannel(ctx context.Context, params *StartChannelInput, optFns ...func(*Options)) (*StartChannelOutput, error) { if params == nil { params = &StartChannelInput{} diff --git a/service/mediatailor/api_op_StopChannel.go b/service/mediatailor/api_op_StopChannel.go index 38061a28ef4..5d0b7ecbf9e 100644 --- a/service/mediatailor/api_op_StopChannel.go +++ b/service/mediatailor/api_op_StopChannel.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a channel. For information about MediaTailor channels, see Working with -// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) -// in the MediaTailor User Guide. +// Stops a channel. For information about MediaTailor channels, see [Working with channels] in the +// MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html func (c *Client) StopChannel(ctx context.Context, params *StopChannelInput, optFns ...func(*Options)) (*StopChannelOutput, error) { if params == nil { params = &StopChannelInput{} diff --git a/service/mediatailor/api_op_TagResource.go b/service/mediatailor/api_op_TagResource.go index 65b8c81dbf1..4bba907b0e5 100644 --- a/service/mediatailor/api_op_TagResource.go +++ b/service/mediatailor/api_op_TagResource.go @@ -12,8 +12,9 @@ import ( // 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) -// . +// For more information, see [Tagging AWS Elemental MediaTailor Resources]. +// +// [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{} @@ -38,8 +39,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor 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 4351f3a927b..89bc36da1e0 100644 --- a/service/mediatailor/api_op_UpdateChannel.go +++ b/service/mediatailor/api_op_UpdateChannel.go @@ -12,9 +12,10 @@ import ( "time" ) -// Updates a channel. For information about MediaTailor channels, see Working with -// channels (https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) -// in the MediaTailor User Guide. +// Updates a channel. For information about MediaTailor channels, see [Working with channels] in the +// MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error) { if params == nil { params = &UpdateChannelInput{} @@ -51,7 +52,7 @@ type UpdateChannelInput struct { // . FillerSlate *types.SlateSource - // The time-shifted viewing configuration you want to associate to the channel. + // The time-shifted viewing configuration you want to associate to the channel. TimeShiftConfiguration *types.TimeShiftConfiguration noSmithyDocumentSerde @@ -86,22 +87,25 @@ type UpdateChannelOutput struct { // The channel's output properties. Outputs []types.ResponseOutputItem - // The type of playback mode for this channel. LINEAR - Programs play back-to-back - // only once. LOOP - Programs play back-to-back in an endless loop. When the last - // program in the schedule plays, playback loops back to the first program in the - // schedule. + // The type of playback mode for this channel. + // + // LINEAR - Programs play back-to-back only once. + // + // LOOP - Programs play back-to-back in an endless loop. When the last program in + // the schedule plays, playback loops back to the first program in the schedule. PlaybackMode *string // 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string // The tier associated with this Channel. Tier *string - // The time-shifted viewing configuration for the channel. + // The time-shifted viewing configuration for the channel. TimeShiftConfiguration *types.TimeShiftConfiguration // Metadata pertaining to the operation's result. diff --git a/service/mediatailor/api_op_UpdateLiveSource.go b/service/mediatailor/api_op_UpdateLiveSource.go index 44d5521527b..8a220f46bf4 100644 --- a/service/mediatailor/api_op_UpdateLiveSource.go +++ b/service/mediatailor/api_op_UpdateLiveSource.go @@ -70,8 +70,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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_UpdateSourceLocation.go b/service/mediatailor/api_op_UpdateSourceLocation.go index 946be7a9098..77baf33ff39 100644 --- a/service/mediatailor/api_op_UpdateSourceLocation.go +++ b/service/mediatailor/api_op_UpdateSourceLocation.go @@ -13,8 +13,9 @@ 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) -// in the MediaTailor User Guide. +// more information about source locations, see [Working with source locations]in the MediaTailor User Guide. +// +// [Working with source locations]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html func (c *Client) UpdateSourceLocation(ctx context.Context, params *UpdateSourceLocationInput, optFns ...func(*Options)) (*UpdateSourceLocationOutput, error) { if params == nil { params = &UpdateSourceLocationInput{} @@ -77,9 +78,9 @@ type UpdateSourceLocationOutput struct { LastModifiedTime *time.Time // 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) - // . + // about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor]. + // + // [Working with configurations in AWS Elemental MediaTailor]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html SegmentDeliveryConfigurations []types.SegmentDeliveryConfiguration // The name of the source location. @@ -87,8 +88,9 @@ type UpdateSourceLocationOutput struct { // 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) . + // and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [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 30b35fd9d0b..0a8606c483d 100644 --- a/service/mediatailor/api_op_UpdateVodSource.go +++ b/service/mediatailor/api_op_UpdateVodSource.go @@ -67,8 +67,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor 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 672c638dcdf..a45016884ce 100644 --- a/service/mediatailor/doc.go +++ b/service/mediatailor/doc.go @@ -8,9 +8,12 @@ // 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 +// covered in this guide, see the [AWS Elemental MediaTailor User Guide]. +// +// 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). +// +// [AWS Elemental MediaTailor User Guide]: https://docs.aws.amazon.com/mediatailor/latest/ug/ package mediatailor diff --git a/service/mediatailor/options.go b/service/mediatailor/options.go index 6a54a999684..b17547065fa 100644 --- a/service/mediatailor/options.go +++ b/service/mediatailor/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mediatailor/types/enums.go b/service/mediatailor/types/enums.go index 76cab669547..7a0ae155e81 100644 --- a/service/mediatailor/types/enums.go +++ b/service/mediatailor/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AccessType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessType) Values() []AccessType { return []AccessType{ "S3_SIGV4", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AdMarkupType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdMarkupType) Values() []AdMarkupType { return []AdMarkupType{ "DATERANGE", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for AlertCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlertCategory) Values() []AlertCategory { return []AlertCategory{ "SCHEDULING_ERROR", @@ -69,8 +72,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for FillPolicy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FillPolicy) Values() []FillPolicy { return []FillPolicy{ "FULL_AVAIL_ONLY", @@ -105,8 +110,9 @@ const ( ) // Values returns all known values for InsertionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsertionMode) Values() []InsertionMode { return []InsertionMode{ "STITCHED_ONLY", @@ -122,8 +128,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "AS_RUN", @@ -139,8 +146,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "SPLICE_INSERT", @@ -158,8 +166,9 @@ const ( ) // Values returns all known values for Mode. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mode) Values() []Mode { return []Mode{ "OFF", @@ -176,8 +185,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "EQUALS", @@ -193,8 +203,9 @@ const ( ) // Values returns all known values for OriginManifestType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OriginManifestType) Values() []OriginManifestType { return []OriginManifestType{ "SINGLE_PERIOD", @@ -211,8 +222,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -229,8 +241,9 @@ const ( ) // Values returns all known values for RelativePosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelativePosition) Values() []RelativePosition { return []RelativePosition{ "BEFORE_PROGRAM", @@ -248,8 +261,9 @@ const ( ) // Values returns all known values for ScheduleEntryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleEntryType) Values() []ScheduleEntryType { return []ScheduleEntryType{ "PROGRAM", @@ -267,8 +281,9 @@ const ( ) // Values returns all known values for Tier. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tier) Values() []Tier { return []Tier{ "BASIC", @@ -285,8 +300,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "DASH", diff --git a/service/mediatailor/types/types.go b/service/mediatailor/types/types.go index 4d55e78d9e7..065cfa15b70 100644 --- a/service/mediatailor/types/types.go +++ b/service/mediatailor/types/types.go @@ -11,41 +11,62 @@ import ( type AccessConfiguration struct { // The type of authentication used to access content from - // HttpConfiguration::BaseUrl on your source location. 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 - // 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 - // permissions to read all top level manifests referenced by the VodSource - // packaging configurations. • The caller of the API must have s3:GetObject IAM - // permissions to read all top level manifests referenced by your MediaTailor - // VodSource packaging configurations. AUTODETECT_SIGV4 - AWS Signature Version 4 - // authentication for a set of supported services: MediaPackage Version 2 and - // Amazon S3 hosted virtual-style access. If your source location base URL is a - // MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS - // Signature Version 4 (SigV4) authentication to access the resource where your - // source content is stored. Before you can use AUTODETECT_SIGV4 with a - // MediaPackage Version 2 endpoint, you must meet these requirements: • You must - // grant MediaTailor access to your MediaPackage endpoint by granting + // HttpConfiguration::BaseUrl on your source location. + // + // 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 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 permissions to read + // all top level manifests referenced by the VodSource packaging configurations. + // + // • The caller of the API must have s3:GetObject IAM permissions to read all top + // level manifests referenced by your MediaTailor VodSource packaging + // configurations. + // + // AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of + // supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style + // access. If your source location base URL is a MediaPackage Version 2 endpoint or + // an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) + // authentication to access the resource where your source content is stored. + // + // Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you + // must meet these requirements: + // + // • You must grant MediaTailor access to your MediaPackage endpoint by granting // mediatailor.amazonaws.com principal access in an Origin Access policy on the - // endpoint. • Your MediaTailor source location base URL must be a MediaPackage V2 - // endpoint. • The caller of the API must have mediapackagev2:GetObject IAM - // permissions to read all top level manifests referenced by the MediaTailor source - // packaging configurations. Before you can use AUTODETECT_SIGV4 with an Amazon S3 - // bucket, you must meet these requirements: • You must grant MediaTailor access to - // your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. - // For more information about configuring access in IAM, see Access management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) - // in the IAM User Guide.. • The mediatailor.amazonaws.com service principal must - // have permissions to read all top-level manifests referenced by the VodSource - // packaging configurations. • The caller of the API must have s3:GetObject IAM - // permissions to read all top level manifests referenced by your MediaTailor - // VodSource packaging configurations. + // endpoint. + // + // • Your MediaTailor source location base URL must be a MediaPackage V2 endpoint. + // + // • The caller of the API must have mediapackagev2:GetObject IAM permissions to + // read all top level manifests referenced by the MediaTailor source packaging + // configurations. + // + // Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet + // these requirements: + // + // • You must grant MediaTailor access to your S3 bucket by granting + // mediatailor.amazonaws.com principal access in IAM. For more information about + // configuring access in IAM, see [Access management]in the IAM User Guide.. + // + // • The mediatailor.amazonaws.com service principal must have permissions to read + // all top-level manifests referenced by the VodSource packaging configurations. + // + // • The caller of the API must have s3:GetObject IAM permissions to read all top + // level manifests referenced by your MediaTailor VodSource packaging + // configurations. + // + // [Access management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html AccessType AccessType // AWS Secrets Manager access token configuration parameters. @@ -79,11 +100,13 @@ type AdBreak struct { // 9.7.3.1. SpliceInsertMessage *SpliceInsertMessage - // Defines the SCTE-35 time_signal message inserted around the ad. Programs on a - // channel's schedule can be configured with one or more ad breaks. You can attach - // a splice_insert SCTE-35 message to the ad break. This message provides basic - // metadata about the ad break. See section 9.7.4 of the 2022 SCTE-35 specification - // for more information. + // Defines the SCTE-35 time_signal message inserted around the ad. + // + // Programs on a channel's schedule can be configured with one or more ad breaks. + // You can attach a splice_insert SCTE-35 message to the ad break. This message + // provides basic metadata about the ad break. + // + // See section 9.7.4 of the 2022 SCTE-35 specification for more information. TimeSignalMessage *TimeSignalMessage noSmithyDocumentSerde @@ -104,9 +127,11 @@ type AdBreakOpportunity 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 . +// 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. @@ -193,25 +218,30 @@ type AudienceMedia 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 -// playback configuration has an ADS URL of +// 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 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 . // 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 -// 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. +// 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. 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]in the MediaTailor User Guide. + // + // You can include up to 100 dynamic variables. + // + // [Using dynamic ad variables]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html // // This member is required. DynamicVariable *string @@ -226,8 +256,9 @@ 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]. +// +// [Ad Suppression]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html type AvailSuppression struct { // Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE @@ -257,8 +288,10 @@ 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) . +// at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers] +// . +// +// [Bumpers]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html type Bumper struct { // The URL for the end bumper asset. @@ -293,8 +326,9 @@ 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) -// in the MediaTailor User Guide. +// channels, see [Working with channels]in the MediaTailor User Guide. +// +// [Working with channels]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html type Channel struct { // The ARN of the channel. @@ -322,10 +356,12 @@ type Channel struct { // This member is required. Outputs []ResponseOutputItem - // The type of playback mode for this channel. LINEAR - Programs play back-to-back - // only once. LOOP - Programs play back-to-back in an endless loop. When the last - // program in the schedule plays, playback loops back to the first program in the - // schedule. + // The type of playback mode for this channel. + // + // LINEAR - Programs play back-to-back only once. + // + // LOOP - Programs play back-to-back in an endless loop. When the last program in + // the schedule plays, playback loops back to the first program in the schedule. // // This member is required. PlaybackMode *string @@ -352,8 +388,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde @@ -590,8 +627,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde @@ -605,8 +643,11 @@ type LogConfiguration struct { // 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]. + // + // Valid values: 0 - 100 + // + // [debug log mode]: https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html // // This member is required. PercentEnabled int32 @@ -629,17 +670,20 @@ 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 . + // 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) +// A playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor] // . +// +// [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 @@ -650,13 +694,16 @@ 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]. + // + // [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) . + // at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers] + // . + // + // [Bumpers]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html Bumper *Bumper // The configuration for using a content delivery network (CDN), like Amazon @@ -664,8 +711,9 @@ 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]. + // + // [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. @@ -700,8 +748,9 @@ 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]. + // + // [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. @@ -725,9 +774,9 @@ 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) - // . + // control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental 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 @@ -780,10 +829,13 @@ type PrefetchRetrieval struct { 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 - // DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic - // variables in the request to the ADS. + // ad decision server (ADS). + // + // You initially configure [dynamic variables] 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. + // + // [dynamic variables]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html DynamicVariables map[string]string // The time when prefetch retrievals can start for this break. Ad prefetching will @@ -796,9 +848,10 @@ 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) +// ads before an ad break happens. For more information about ad prefetching, see [Using ad prefetching] // in the MediaTailor User Guide. +// +// [Using ad prefetching]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html type PrefetchSchedule struct { // The Amazon Resource Name (ARN) of the prefetch schedule. @@ -971,9 +1024,9 @@ type ScheduleEntry struct { } // 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) -// . +// about Secrets Manager access token authentication, see [Working with AWS Secrets Manager access token authentication]. +// +// [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 @@ -984,9 +1037,10 @@ 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) - // key associated with the access token. MediaTailor uses the key to look up - // SecretString key and value pair containing the access token. + // The AWS Secrets Manager [SecretString] key associated with the access token. MediaTailor uses + // the key to look up SecretString key and value pair containing the access token. + // + // [SecretString]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html SecretStringKey *string noSmithyDocumentSerde @@ -995,10 +1049,12 @@ type SecretsManagerAccessTokenConfiguration struct { // The segmentation_descriptor message can contain advanced metadata fields, like // content identifiers, to convey a wide range of information about the ad break. // MediaTailor writes the ad metadata in the egress manifest as part of the -// EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data. segmentation_descriptor -// messages must be sent with the time_signal message type. See the -// segmentation_descriptor() table of the 2022 SCTE-35 specification for more -// information. +// EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data. +// +// segmentation_descriptor messages must be sent with the time_signal message type. +// +// See the segmentation_descriptor() table of the 2022 SCTE-35 specification for +// more information. type SegmentationDescriptor struct { // The segment number to assign to the segmentation_descriptor.segment_num @@ -1079,8 +1135,9 @@ 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) -// in the MediaTailor User Guide. +// locations, see [Working with source locations]in the MediaTailor User Guide. +// +// [Working with source locations]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html type SourceLocation struct { // The ARN of the SourceLocation. @@ -1115,8 +1172,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde @@ -1150,7 +1208,7 @@ type SpliceInsertMessage struct { // The configuration for time-shifted viewing. type TimeShiftConfiguration struct { - // The maximum time delay for time-shifted viewing. The minimum allowed maximum + // The maximum time delay for time-shifted viewing. The minimum allowed maximum // time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 // seconds (6 hours). // @@ -1162,11 +1220,14 @@ type TimeShiftConfiguration 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 +// 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 { @@ -1187,14 +1248,22 @@ type Transition struct { 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 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 . + // 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 . // // This member is required. Type *string @@ -1267,8 +1336,9 @@ 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) . + // cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources]. + // + // [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/medicalimaging/api_op_DeleteDatastore.go b/service/medicalimaging/api_op_DeleteDatastore.go index b6514893d88..9e32649d5b3 100644 --- a/service/medicalimaging/api_op_DeleteDatastore.go +++ b/service/medicalimaging/api_op_DeleteDatastore.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a data store. Before a data store can be deleted, you must first delete -// all image sets within it. +// Delete a data store. +// +// Before a data store can be deleted, you must first delete all image sets within +// it. func (c *Client) DeleteDatastore(ctx context.Context, params *DeleteDatastoreInput, optFns ...func(*Options)) (*DeleteDatastoreOutput, error) { if params == nil { params = &DeleteDatastoreInput{} diff --git a/service/medicalimaging/api_op_GetDICOMImportJob.go b/service/medicalimaging/api_op_GetDICOMImportJob.go index 625db9cab75..6720c0c309b 100644 --- a/service/medicalimaging/api_op_GetDICOMImportJob.go +++ b/service/medicalimaging/api_op_GetDICOMImportJob.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get the import job properties to learn more about the job or job progress. The -// jobStatus refers to the execution of the import job. Therefore, an import job -// can return a jobStatus as COMPLETED even if validation issues are discovered -// during the import process. If a jobStatus returns as COMPLETED , we still -// recommend you review the output manifests written to S3, as they provide details -// on the success or failure of individual P10 object imports. +// Get the import job properties to learn more about the job or job progress. +// +// The jobStatus refers to the execution of the import job. Therefore, an import +// job can return a jobStatus as COMPLETED even if validation issues are +// discovered during the import process. If a jobStatus returns as COMPLETED , we +// still recommend you review the output manifests written to S3, as they provide +// details on the success or failure of individual P10 object imports. func (c *Client) GetDICOMImportJob(ctx context.Context, params *GetDICOMImportJobInput, optFns ...func(*Options)) (*GetDICOMImportJobOutput, error) { if params == nil { params = &GetDICOMImportJobInput{} diff --git a/service/medicalimaging/api_op_SearchImageSets.go b/service/medicalimaging/api_op_SearchImageSets.go index 857a511031f..0a0b937a4b6 100644 --- a/service/medicalimaging/api_op_SearchImageSets.go +++ b/service/medicalimaging/api_op_SearchImageSets.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Search image sets based on defined input attributes. SearchImageSets accepts a -// single search query parameter and returns a paginated response of all image sets -// that have the matching criteria. All range queries must be input as -// (lowerBound, upperBound) . SearchImageSets uses the updatedAt field for sorting -// in decreasing order from latest to oldest. +// Search image sets based on defined input attributes. +// +// SearchImageSets accepts a single search query parameter and returns a paginated +// response of all image sets that have the matching criteria. All range queries +// must be input as (lowerBound, upperBound) . +// +// SearchImageSets uses the updatedAt field for sorting in decreasing order from +// latest to oldest. func (c *Client) SearchImageSets(ctx context.Context, params *SearchImageSetsInput, optFns ...func(*Options)) (*SearchImageSetsOutput, error) { if params == nil { params = &SearchImageSetsInput{} diff --git a/service/medicalimaging/doc.go b/service/medicalimaging/doc.go index 4eb933f57bc..e2f8dd3b8c7 100644 --- a/service/medicalimaging/doc.go +++ b/service/medicalimaging/doc.go @@ -6,76 +6,117 @@ // This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA // eligible service that empowers healthcare providers, life science organizations, // and their software partners to store, analyze, and share medical images in the -// cloud at petabyte scale. For an introduction to the service, see the AWS -// HealthImaging Developer Guide (https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html) -// . We recommend using one of the AWS Software Development Kits (SDKs) for your +// cloud at petabyte scale. For an introduction to the service, see the [AWS HealthImaging Developer Guide]. +// +// We recommend using one of the AWS Software Development Kits (SDKs) for your // programming language, as they take care of request authentication, -// serialization, and connection management. For more information, see Tools to -// build on AWS (http://aws.amazon.com/developer/tools) . The following sections -// list AWS HealthImaging API actions categorized according to functionality. Links -// are provided to actions within this Reference, along with links back to -// corresponding sections in the AWS HealthImaging Developer Guide where you can -// view tested code examples. Data store actions -// - CreateDatastore (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html) -// – See Creating a data store (https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html) -// . -// - GetDatastore (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html) -// – See Getting data store properties (https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html) -// . -// - ListDatastores (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html) -// – See Listing data stores (https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html) -// . -// - DeleteDatastore (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html) -// – See Deleting a data store (https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html) -// . -// -// Import job actions -// - StartDICOMImportJob (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_StartDICOMImportJob.html) -// – See Starting an import job (https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html) -// . -// - GetDICOMImportJob (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDICOMImportJob.html) -// – See Getting import job properties (https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html) -// . -// - ListDICOMImportJobs (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDICOMImportJobs.html) -// – See Listing import jobs (https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html) -// . -// -// Image set access actions -// - SearchImageSets (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_SearchImageSets.html) -// – See Searching image sets (https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html) -// . -// - GetImageSet (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSet.html) -// – See Getting image set properties (https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html) -// . -// - GetImageSetMetadata (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSetMetadata.html) -// – See Getting image set metadata (https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html) -// . -// - GetImageFrame (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageFrame.html) -// – See Getting image set pixel data (https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html) -// . -// -// Image set modification actions -// - ListImageSetVersions (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListImageSetVersions.html) -// – See Listing image set versions (https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html) -// . -// - UpdateImageSetMetadata (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UpdateImageSetMetadata.html) -// – See Updating image set metadata (https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html) -// . -// - CopyImageSet (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CopyImageSet.html) -// – See Copying an image set (https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html) -// . -// - DeleteImageSet (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteImageSet.html) -// – See Deleting an image set (https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html) -// . -// -// Tagging actions -// - TagResource (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html) -// – See Tagging a resource (https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html) -// . -// - ListTagsForResource (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html) -// – See Listing tags for a resource (https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html) -// . -// - UntagResource (https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html) -// – See Untagging a resource (https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html) -// . +// serialization, and connection management. For more information, see [Tools to build on AWS]. +// +// The following sections list AWS HealthImaging API actions categorized according +// to functionality. Links are provided to actions within this Reference, along +// with links back to corresponding sections in the AWS HealthImaging Developer +// Guide where you can view tested code examples. +// +// # Data store actions +// +// [CreateDatastore] +// - – See [Creating a data store]. +// +// [GetDatastore] +// - – See [Getting data store properties]. +// +// [ListDatastores] +// - – See [Listing data stores]. +// +// [DeleteDatastore] +// - – See [Deleting a data store]. +// +// # Import job actions +// +// [StartDICOMImportJob] +// - – See [Starting an import job]. +// +// [GetDICOMImportJob] +// - – See [Getting import job properties]. +// +// [ListDICOMImportJobs] +// - – See [Listing import jobs]. +// +// # Image set access actions +// +// [SearchImageSets] +// - – See [Searching image sets]. +// +// [GetImageSet] +// - – See [Getting image set properties]. +// +// [GetImageSetMetadata] +// - – See [Getting image set metadata]. +// +// [GetImageFrame] +// - – See [Getting image set pixel data]. +// +// # Image set modification actions +// +// [ListImageSetVersions] +// - – See [Listing image set versions]. +// +// [UpdateImageSetMetadata] +// - – See [Updating image set metadata]. +// +// [CopyImageSet] +// - – See [Copying an image set]. +// +// [DeleteImageSet] +// - – See [Deleting an image set]. +// +// # Tagging actions +// +// [TagResource] +// - – See [Tagging a resource]. +// +// [ListTagsForResource] +// - – See [Listing tags for a resource]. +// +// [UntagResource] +// - – See [Untagging a resource]. +// +// [ListDICOMImportJobs]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDICOMImportJobs.html +// [CopyImageSet]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CopyImageSet.html +// [TagResource]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_TagResource.html +// [Updating image set metadata]: https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html +// [Creating a data store]: https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html +// [GetDatastore]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDatastore.html +// [Tagging a resource]: https://docs.aws.amazon.com/healthimaging/latest/devguide/tag-resource.html +// [Listing data stores]: https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html +// [DeleteDatastore]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteDatastore.html +// [Getting image set pixel data]: https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html +// [CreateDatastore]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_CreateDatastore.html +// [ListImageSetVersions]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListImageSetVersions.html +// [GetImageFrame]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageFrame.html +// [Copying an image set]: https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html +// [GetImageSet]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSet.html +// [Listing image set versions]: https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html +// [DeleteImageSet]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_DeleteImageSet.html +// [GetImageSetMetadata]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetImageSetMetadata.html +// [Starting an import job]: https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html +// [SearchImageSets]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_SearchImageSets.html +// [UpdateImageSetMetadata]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UpdateImageSetMetadata.html +// [Deleting a data store]: https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html +// [Listing import jobs]: https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html +// [Deleting an image set]: https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html +// [Listing tags for a resource]: https://docs.aws.amazon.com/healthimaging/latest/devguide/list-tag-resource.html +// [Getting image set metadata]: https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html +// [Untagging a resource]: https://docs.aws.amazon.com/healthimaging/latest/devguide/untag-resource.html +// [ListDatastores]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListDatastores.html +// [UntagResource]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_UntagResource.html +// [StartDICOMImportJob]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_StartDICOMImportJob.html +// [Getting import job properties]: https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html +// [Getting data store properties]: https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html +// [Searching image sets]: https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html +// [GetDICOMImportJob]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_GetDICOMImportJob.html +// [AWS HealthImaging Developer Guide]: https://docs.aws.amazon.com/healthimaging/latest/devguide/what-is.html +// [Tools to build on AWS]: http://aws.amazon.com/developer/tools +// [Getting image set properties]: https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html +// [ListTagsForResource]: https://docs.aws.amazon.com/healthimaging/latest/APIReference/API_ListTagsForResource.html package medicalimaging diff --git a/service/medicalimaging/options.go b/service/medicalimaging/options.go index e58a40aff2c..c8b557aa0cb 100644 --- a/service/medicalimaging/options.go +++ b/service/medicalimaging/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/medicalimaging/types/enums.go b/service/medicalimaging/types/enums.go index a533a442d64..7ed46334448 100644 --- a/service/medicalimaging/types/enums.go +++ b/service/medicalimaging/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for DatastoreStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatastoreStatus) Values() []DatastoreStatus { return []DatastoreStatus{ "CREATING", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for ImageSetState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSetState) Values() []ImageSetState { return []ImageSetState{ "ACTIVE", @@ -63,8 +65,9 @@ const ( ) // Values returns all known values for ImageSetWorkflowStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSetWorkflowStatus) Values() []ImageSetWorkflowStatus { return []ImageSetWorkflowStatus{ "CREATED", @@ -91,8 +94,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -111,8 +115,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "EQUAL", @@ -130,8 +135,9 @@ const ( ) // 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. +// in the future, and so 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{ "updatedAt", @@ -149,8 +155,9 @@ const ( ) // 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. +// in the future, and so 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/memorydb/api_op_BatchUpdateCluster.go b/service/memorydb/api_op_BatchUpdateCluster.go index 581655fa6e8..aac0785d440 100644 --- a/service/memorydb/api_op_BatchUpdateCluster.go +++ b/service/memorydb/api_op_BatchUpdateCluster.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// on service updates and applying them, see [Applying the service updates]. +// +// [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 d51a6e17eb3..2bccc6d3759 100644 --- a/service/memorydb/api_op_CopySnapshot.go +++ b/service/memorydb/api_op_CopySnapshot.go @@ -49,11 +49,14 @@ type CopySnapshotInput struct { Tags []types.Tag // The Amazon S3 bucket to which the snapshot is exported. This parameter is used - // 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) - // . + // 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]. + // + // [Step 2: Grant MemoryDB Access to Your Amazon 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 48383c29db2..50d2b85d739 100644 --- a/service/memorydb/api_op_CreateACL.go +++ b/service/memorydb/api_op_CreateACL.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates an Access Control List. For more information, see [Authenticating users with Access Contol Lists (ACLs)]. +// +// [Authenticating users 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 e55f79396df..0a04c39e8bf 100644 --- a/service/memorydb/api_op_CreateCluster.go +++ b/service/memorydb/api_op_CreateCluster.go @@ -52,8 +52,9 @@ type CreateClusterInput struct { // 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) - // . + // information, see [Data tiering]. + // + // [Data tiering]: https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html DataTiering *bool // An optional description of the cluster. @@ -67,15 +68,24 @@ type CreateClusterInput struct { // Specifies the weekly time range during which maintenance on the 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: + // 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 MaintenanceWindow *string @@ -110,8 +120,12 @@ type CreateClusterInput struct { SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which MemoryDB begins taking a daily - // snapshot of your shard. Example: 05:00-09:00 If you do not specify this - // parameter, MemoryDB automatically chooses an appropriate time range. + // snapshot of your shard. + // + // Example: 05:00-09:00 + // + // If you do not specify this parameter, MemoryDB automatically chooses an + // appropriate time range. SnapshotWindow *string // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) diff --git a/service/memorydb/api_op_CreateParameterGroup.go b/service/memorydb/api_op_CreateParameterGroup.go index 325f04d7e3b..a67abd4016a 100644 --- a/service/memorydb/api_op_CreateParameterGroup.go +++ b/service/memorydb/api_op_CreateParameterGroup.go @@ -13,8 +13,9 @@ 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]. +// +// [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 8c619b0dff5..8b566af6e26 100644 --- a/service/memorydb/api_op_CreateSubnetGroup.go +++ b/service/memorydb/api_op_CreateSubnetGroup.go @@ -13,11 +13,13 @@ import ( // Creates a subnet group. 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. 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) -// . +// 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]. +// +// [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 d311750f313..f68a7b40359 100644 --- a/service/memorydb/api_op_CreateUser.go +++ b/service/memorydb/api_op_CreateUser.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates a MemoryDB user. For more information, see [Authenticating users with Access Contol Lists (ACLs)]. +// +// [Authenticating users with 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 980417988d3..96b806145d9 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)]. +// +// [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_DescribeEvents.go b/service/memorydb/api_op_DescribeEvents.go index 65292e01598..5cd9c07599b 100644 --- a/service/memorydb/api_op_DescribeEvents.go +++ b/service/memorydb/api_op_DescribeEvents.go @@ -14,9 +14,10 @@ import ( // Returns events related to clusters, security groups, and parameter groups. You // can obtain events specific to a particular cluster, security group, or parameter -// group by providing the name as a parameter. By default, only the events -// occurring within the last hour are returned; however, you can retrieve up to 14 -// days' worth of events if necessary. +// group by providing the name as a parameter. +// +// By default, only the events occurring within the last hour are returned; +// however, you can retrieve up to 14 days' worth of events if necessary. func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -38,7 +39,9 @@ type DescribeEventsInput struct { 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 + // 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,7 +65,9 @@ type DescribeEventsInput struct { 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 + // 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 4f55b5d23cc..1fc350835c2 100644 --- a/service/memorydb/api_op_DescribeReservedNodes.go +++ b/service/memorydb/api_op_DescribeReservedNodes.go @@ -46,8 +46,9 @@ type DescribeReservedNodesInput struct { 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]. + // + // [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 diff --git a/service/memorydb/api_op_DescribeReservedNodesOfferings.go b/service/memorydb/api_op_DescribeReservedNodesOfferings.go index 62ebd3fe0b4..795798a44a2 100644 --- a/service/memorydb/api_op_DescribeReservedNodesOfferings.go +++ b/service/memorydb/api_op_DescribeReservedNodesOfferings.go @@ -44,9 +44,9 @@ type DescribeReservedNodesOfferingsInput struct { // 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) - // . + // The node type for the reserved nodes. For more information, see [Supported node types]. + // + // [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 diff --git a/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go b/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go index a6757877a8b..ed2d4cffb55 100644 --- a/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go +++ b/service/memorydb/api_op_ListAllowedNodeTypeUpdates.go @@ -11,9 +11,10 @@ import ( ) // 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. +// 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 47c6e419331..1c40c8dbb6b 100644 --- a/service/memorydb/api_op_ListTags.go +++ b/service/memorydb/api_op_ListTags.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// 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] +// +// [Tagging your MemoryDB 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_TagResource.go b/service/memorydb/api_op_TagResource.go index 45eb3fd0dcb..f6e408d48a5 100644 --- a/service/memorydb/api_op_TagResource.go +++ b/service/memorydb/api_op_TagResource.go @@ -12,16 +12,23 @@ 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, +// 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]. +// +// 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) -// . +// owners) to organize your costs across multiple services. +// +// For more information, see [Using Cost Allocation Tags]. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging.html +// [Resource-level permissions]: https://docs.aws.amazon.com/MemoryDB/latest/devguide/iam.resourcelevelpermissions.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 6395498ef02..e71597d10d5 100644 --- a/service/memorydb/api_op_UpdateCluster.go +++ b/service/memorydb/api_op_UpdateCluster.go @@ -50,15 +50,24 @@ type UpdateClusterInput struct { // Specifies the weekly time range during which maintenance on the 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: + // 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 MaintenanceWindow *string diff --git a/service/memorydb/api_op_UpdateSubnetGroup.go b/service/memorydb/api_op_UpdateSubnetGroup.go index e41bf1d9e42..9751a8294cd 100644 --- a/service/memorydb/api_op_UpdateSubnetGroup.go +++ b/service/memorydb/api_op_UpdateSubnetGroup.go @@ -11,7 +11,9 @@ 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] +// +// [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 9bd4224c543..9bd05179b5c 100644 --- a/service/memorydb/doc.go +++ b/service/memorydb/doc.go @@ -5,8 +5,10 @@ // // 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. +// 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/options.go b/service/memorydb/options.go index 8f1b5c652a2..b30df55fa7c 100644 --- a/service/memorydb/options.go +++ b/service/memorydb/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/memorydb/types/enums.go b/service/memorydb/types/enums.go index 7ab8948d432..0620f6e0bc2 100644 --- a/service/memorydb/types/enums.go +++ b/service/memorydb/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "password", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AZStatus. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AZStatus) Values() []AZStatus { return []AZStatus{ "singleaz", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for DataTieringStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataTieringStatus) Values() []DataTieringStatus { return []DataTieringStatus{ "true", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for InputAuthenticationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputAuthenticationType) Values() []InputAuthenticationType { return []InputAuthenticationType{ "password", @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for ServiceUpdateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceUpdateStatus) Values() []ServiceUpdateStatus { return []ServiceUpdateStatus{ "available", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for ServiceUpdateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceUpdateType) Values() []ServiceUpdateType { return []ServiceUpdateType{ "security-update", @@ -127,8 +133,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "node", diff --git a/service/memorydb/types/types.go b/service/memorydb/types/types.go index ec327e1215e..3a62d055e85 100644 --- a/service/memorydb/types/types.go +++ b/service/memorydb/types/types.go @@ -8,6 +8,7 @@ import ( ) // An Access Control List. You can authenticate users with Access Contol Lists. +// // ACLs enable you to control cluster access by grouping users. These Access // control lists are designed as a way to organize access to clusters. type ACL struct { @@ -116,8 +117,9 @@ type Cluster struct { // 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) - // . + // information, see [Data tiering]. + // + // [Data tiering]: https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html DataTiering DataTieringStatus // A description of the cluster @@ -169,8 +171,12 @@ type Cluster struct { SnapshotRetentionLimit *int32 // The daily time range (in UTC) during which MemoryDB begins taking a daily - // snapshot of your shard. Example: 05:00-09:00 If you do not specify this - // parameter, MemoryDB automatically chooses an appropriate time range. + // snapshot of your shard. + // + // Example: 05:00-09:00 + // + // If you do not specify this parameter, MemoryDB automatically chooses an + // appropriate time range. SnapshotWindow *string // The Amazon Resource Name (ARN) of the SNS notification topic @@ -483,9 +489,9 @@ type ReservedNodesOffering struct { // The fixed price charged for this reserved node. 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) - // . + // The node type for the reserved nodes. For more information, see [Supported node types]. + // + // [Supported node types]: https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported NodeType *string // The offering type of this reserved node. @@ -647,8 +653,9 @@ type Snapshot struct { // 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) - // . + // information, see [Data tiering]. + // + // [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,7 +690,9 @@ type Subnet struct { } // Represents the output of one of the following operations: +// // - CreateSubnetGroup +// // - UpdateSubnetGroup // // A subnet group is a collection of subnets (typically private) that you can @@ -713,7 +722,9 @@ 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] +// +// [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. diff --git a/service/mgn/api_op_UpdateLaunchConfiguration.go b/service/mgn/api_op_UpdateLaunchConfiguration.go index 576c0cebae2..99f97dd9ae7 100644 --- a/service/mgn/api_op_UpdateLaunchConfiguration.go +++ b/service/mgn/api_op_UpdateLaunchConfiguration.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates multiple LaunchConfigurations by Source Server ID. bootMode valid -// values are LEGACY_BIOS | UEFI +// Updates multiple LaunchConfigurations by Source Server ID. +// +// bootMode valid values are LEGACY_BIOS | UEFI func (c *Client) UpdateLaunchConfiguration(ctx context.Context, params *UpdateLaunchConfigurationInput, optFns ...func(*Options)) (*UpdateLaunchConfigurationOutput, error) { if params == nil { params = &UpdateLaunchConfigurationInput{} diff --git a/service/mgn/options.go b/service/mgn/options.go index a9c905a99dc..feb804e8972 100644 --- a/service/mgn/options.go +++ b/service/mgn/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mgn/types/enums.go b/service/mgn/types/enums.go index 7255c4de8b5..57a81fd4e3e 100644 --- a/service/mgn/types/enums.go +++ b/service/mgn/types/enums.go @@ -20,8 +20,9 @@ const ( ) // Values returns all known values for ActionCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionCategory) Values() []ActionCategory { return []ActionCategory{ "DISASTER_RECOVERY", @@ -48,8 +49,9 @@ const ( ) // Values returns all known values for ApplicationHealthStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationHealthStatus) Values() []ApplicationHealthStatus { return []ApplicationHealthStatus{ "HEALTHY", @@ -69,6 +71,7 @@ const ( // Values returns all known values for ApplicationProgressStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationProgressStatus) Values() []ApplicationProgressStatus { return []ApplicationProgressStatus{ @@ -88,8 +91,9 @@ const ( ) // Values returns all known values for BootMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BootMode) Values() []BootMode { return []BootMode{ "LEGACY_BIOS", @@ -109,8 +113,9 @@ const ( // Values returns all known values for // ChangeServerLifeCycleStateSourceServerLifecycleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeServerLifeCycleStateSourceServerLifecycleState) Values() []ChangeServerLifeCycleStateSourceServerLifecycleState { return []ChangeServerLifeCycleStateSourceServerLifecycleState{ "READY_FOR_TEST", @@ -143,6 +148,7 @@ const ( // Values returns all known values for DataReplicationErrorString. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationErrorString) Values() []DataReplicationErrorString { return []DataReplicationErrorString{ @@ -184,8 +190,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationInitiationStepName) Values() []DataReplicationInitiationStepName { return []DataReplicationInitiationStepName{ "WAIT", @@ -215,8 +222,9 @@ const ( // Values returns all known values for DataReplicationInitiationStepStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationInitiationStepStatus) Values() []DataReplicationInitiationStepStatus { return []DataReplicationInitiationStepStatus{ "NOT_STARTED", @@ -246,8 +254,9 @@ const ( ) // Values returns all known values for DataReplicationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationState) Values() []DataReplicationState { return []DataReplicationState{ "STOPPED", @@ -276,8 +285,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -298,8 +308,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -318,8 +329,9 @@ const ( ) // Values returns all known values for ImportErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportErrorType) Values() []ImportErrorType { return []ImportErrorType{ "VALIDATION_ERROR", @@ -338,8 +350,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -360,8 +373,9 @@ const ( ) // Values returns all known values for InitiatedBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InitiatedBy) Values() []InitiatedBy { return []InitiatedBy{ "START_TEST", @@ -394,8 +408,9 @@ const ( ) // Values returns all known values for JobLogEvent. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobLogEvent) Values() []JobLogEvent { return []JobLogEvent{ "JOB_START", @@ -427,8 +442,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -446,8 +462,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "LAUNCH", @@ -464,8 +481,9 @@ const ( ) // Values returns all known values for LaunchDisposition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchDisposition) Values() []LaunchDisposition { return []LaunchDisposition{ "STOPPED", @@ -485,8 +503,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -514,8 +533,9 @@ const ( ) // Values returns all known values for LifeCycleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifeCycleState) Values() []LifeCycleState { return []LifeCycleState{ "STOPPED", @@ -542,8 +562,9 @@ const ( // Values returns all known values for PostLaunchActionExecutionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PostLaunchActionExecutionStatus) Values() []PostLaunchActionExecutionStatus { return []PostLaunchActionExecutionStatus{ "IN_PROGRESS", @@ -563,8 +584,9 @@ const ( // Values returns all known values for PostLaunchActionsDeploymentType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PostLaunchActionsDeploymentType) Values() []PostLaunchActionsDeploymentType { return []PostLaunchActionsDeploymentType{ "TEST_AND_CUTOVER", @@ -583,8 +605,9 @@ const ( // Values returns all known values for ReplicationConfigurationDataPlaneRouting. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationDataPlaneRouting) Values() []ReplicationConfigurationDataPlaneRouting { return []ReplicationConfigurationDataPlaneRouting{ "PRIVATE_IP", @@ -603,8 +626,9 @@ const ( // Values returns all known values for // ReplicationConfigurationDefaultLargeStagingDiskType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationDefaultLargeStagingDiskType) Values() []ReplicationConfigurationDefaultLargeStagingDiskType { return []ReplicationConfigurationDefaultLargeStagingDiskType{ "GP2", @@ -623,8 +647,9 @@ const ( // Values returns all known values for ReplicationConfigurationEbsEncryption. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationEbsEncryption) Values() []ReplicationConfigurationEbsEncryption { return []ReplicationConfigurationEbsEncryption{ "DEFAULT", @@ -648,8 +673,9 @@ const ( // Values returns all known values for // ReplicationConfigurationReplicatedDiskStagingDiskType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationConfigurationReplicatedDiskStagingDiskType) Values() []ReplicationConfigurationReplicatedDiskStagingDiskType { return []ReplicationConfigurationReplicatedDiskStagingDiskType{ "AUTO", @@ -672,8 +698,9 @@ const ( ) // Values returns all known values for ReplicationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationType) Values() []ReplicationType { return []ReplicationType{ "AGENT_BASED", @@ -690,8 +717,9 @@ const ( ) // Values returns all known values for SsmDocumentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SsmDocumentType) Values() []SsmDocumentType { return []SsmDocumentType{ "AUTOMATION", @@ -708,8 +736,9 @@ const ( // Values returns all known values for SsmParameterStoreParameterType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SsmParameterStoreParameterType) Values() []SsmParameterStoreParameterType { return []SsmParameterStoreParameterType{ "STRING", @@ -726,8 +755,9 @@ const ( // Values returns all known values for TargetInstanceTypeRightSizingMethod. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetInstanceTypeRightSizingMethod) Values() []TargetInstanceTypeRightSizingMethod { return []TargetInstanceTypeRightSizingMethod{ "NONE", @@ -747,6 +777,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -771,8 +802,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "io1", @@ -795,8 +827,9 @@ const ( ) // Values returns all known values for WaveHealthStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WaveHealthStatus) Values() []WaveHealthStatus { return []WaveHealthStatus{ "HEALTHY", @@ -815,8 +848,9 @@ const ( ) // Values returns all known values for WaveProgressStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WaveProgressStatus) Values() []WaveProgressStatus { return []WaveProgressStatus{ "NOT_STARTED", diff --git a/service/migrationhub/api_op_AssociateCreatedArtifact.go b/service/migrationhub/api_op_AssociateCreatedArtifact.go index 36115c7ce43..7b1928e0c09 100644 --- a/service/migrationhub/api_op_AssociateCreatedArtifact.go +++ b/service/migrationhub/api_op_AssociateCreatedArtifact.go @@ -14,11 +14,14 @@ import ( // 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) { diff --git a/service/migrationhub/api_op_DeleteProgressUpdateStream.go b/service/migrationhub/api_op_DeleteProgressUpdateStream.go index 0d82547f3a5..a7103e80e7e 100644 --- a/service/migrationhub/api_op_DeleteProgressUpdateStream.go +++ b/service/migrationhub/api_op_DeleteProgressUpdateStream.go @@ -13,17 +13,22 @@ 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 diff --git a/service/migrationhub/api_op_DisassociateCreatedArtifact.go b/service/migrationhub/api_op_DisassociateCreatedArtifact.go index 0007a94a433..54524c67906 100644 --- a/service/migrationhub/api_op_DisassociateCreatedArtifact.go +++ b/service/migrationhub/api_op_DisassociateCreatedArtifact.go @@ -13,11 +13,14 @@ 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. func (c *Client) DisassociateCreatedArtifact(ctx context.Context, params *DisassociateCreatedArtifactInput, optFns ...func(*Options)) (*DisassociateCreatedArtifactOutput, error) { diff --git a/service/migrationhub/api_op_ImportMigrationTask.go b/service/migrationhub/api_op_ImportMigrationTask.go index 5e1dcd3684d..3adb6718b03 100644 --- a/service/migrationhub/api_op_ImportMigrationTask.go +++ b/service/migrationhub/api_op_ImportMigrationTask.go @@ -11,9 +11,10 @@ import ( ) // Registers a new migration task which represents a server, database, etc., being -// migrated to AWS by a migration tool. This API is a prerequisite to calling the -// NotifyMigrationTaskState API as the migration tool must first register the -// migration task with Migration Hub. +// migrated to AWS by a migration tool. +// +// This API is a prerequisite to calling the NotifyMigrationTaskState API as the +// migration tool must first register the migration task with Migration Hub. func (c *Client) ImportMigrationTask(ctx context.Context, params *ImportMigrationTaskInput, optFns ...func(*Options)) (*ImportMigrationTaskOutput, error) { if params == nil { params = &ImportMigrationTaskInput{} diff --git a/service/migrationhub/api_op_ListCreatedArtifacts.go b/service/migrationhub/api_op_ListCreatedArtifacts.go index 9621e7692d3..c1405cb4d20 100644 --- a/service/migrationhub/api_op_ListCreatedArtifacts.go +++ b/service/migrationhub/api_op_ListCreatedArtifacts.go @@ -13,9 +13,12 @@ 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. func (c *Client) ListCreatedArtifacts(ctx context.Context, params *ListCreatedArtifactsInput, optFns ...func(*Options)) (*ListCreatedArtifactsOutput, error) { if params == nil { diff --git a/service/migrationhub/api_op_ListMigrationTasks.go b/service/migrationhub/api_op_ListMigrationTasks.go index 88091b1b869..bbe348ed7c9 100644 --- a/service/migrationhub/api_op_ListMigrationTasks.go +++ b/service/migrationhub/api_op_ListMigrationTasks.go @@ -13,9 +13,12 @@ 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. func (c *Client) ListMigrationTasks(ctx context.Context, params *ListMigrationTasksInput, optFns ...func(*Options)) (*ListMigrationTasksOutput, error) { if params == nil { diff --git a/service/migrationhub/api_op_NotifyMigrationTaskState.go b/service/migrationhub/api_op_NotifyMigrationTaskState.go index 87ed08040da..a08075d6e74 100644 --- a/service/migrationhub/api_op_NotifyMigrationTaskState.go +++ b/service/migrationhub/api_op_NotifyMigrationTaskState.go @@ -14,9 +14,12 @@ 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. func (c *Client) NotifyMigrationTaskState(ctx context.Context, params *NotifyMigrationTaskStateInput, optFns ...func(*Options)) (*NotifyMigrationTaskStateOutput, error) { diff --git a/service/migrationhub/api_op_PutResourceAttributes.go b/service/migrationhub/api_op_PutResourceAttributes.go index c13fd6c5fe3..d651916d4de 100644 --- a/service/migrationhub/api_op_PutResourceAttributes.go +++ b/service/migrationhub/api_op_PutResourceAttributes.go @@ -14,18 +14,21 @@ 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. +// +// - Note the instructions regarding the special use case of the [ResourceAttributeList] +// 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 . +// +// [ResourceAttributeList]: https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList func (c *Client) PutResourceAttributes(ctx context.Context, params *PutResourceAttributesInput, optFns ...func(*Options)) (*PutResourceAttributesOutput, error) { if params == nil { params = &PutResourceAttributesInput{} @@ -56,21 +59,26 @@ type PutResourceAttributesInput struct { // 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. + // repository. See the [Example]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. // + // [Example]: https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples + // // This member is required. ResourceAttributeList []types.ResourceAttribute diff --git a/service/migrationhub/doc.go b/service/migrationhub/doc.go index 6f481300424..68059a2194d 100644 --- a/service/migrationhub/doc.go +++ b/service/migrationhub/doc.go @@ -5,8 +5,9 @@ // // The AWS Migration Hub API methods help to obtain server and application // migration status and integrate your resource-specific migration tool by -// providing a programmatic interface to Migration Hub. Remember that you must set -// your AWS Migration Hub home region before you call any of these APIs, or a -// HomeRegionNotSetException error will be returned. Also, you must make the API -// calls while in your home region. +// providing a programmatic interface to Migration Hub. +// +// Remember that you must set your AWS Migration Hub home region before you call +// any of these APIs, or a HomeRegionNotSetException error will be returned. Also, +// you must make the API calls while in your home region. package migrationhub diff --git a/service/migrationhub/options.go b/service/migrationhub/options.go index 63b9a730057..17967f52707 100644 --- a/service/migrationhub/options.go +++ b/service/migrationhub/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/migrationhub/types/enums.go b/service/migrationhub/types/enums.go index 6dd02b5451e..c51b2998fef 100644 --- a/service/migrationhub/types/enums.go +++ b/service/migrationhub/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "NOT_STARTED", @@ -39,8 +40,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "IPV4_ADDRESS", @@ -67,8 +69,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "NOT_STARTED", diff --git a/service/migrationhub/types/types.go b/service/migrationhub/types/types.go index 904aca8ab72..8db861ccd1a 100644 --- a/service/migrationhub/types/types.go +++ b/service/migrationhub/types/types.go @@ -116,11 +116,21 @@ 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 -// ^[^<>{}\\/?,=\p{Cntrl}]{1,256}$ +// 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 { // Type of resource. diff --git a/service/migrationhubconfig/doc.go b/service/migrationhubconfig/doc.go index ada54308b23..f21c92b5245 100644 --- a/service/migrationhubconfig/doc.go +++ b/service/migrationhubconfig/doc.go @@ -7,13 +7,17 @@ // 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. // diff --git a/service/migrationhubconfig/options.go b/service/migrationhubconfig/options.go index e769426399a..b0fc03edd00 100644 --- a/service/migrationhubconfig/options.go +++ b/service/migrationhubconfig/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/migrationhubconfig/types/enums.go b/service/migrationhubconfig/types/enums.go index 4d27a548063..7c4fe970be9 100644 --- a/service/migrationhubconfig/types/enums.go +++ b/service/migrationhubconfig/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "ACCOUNT", diff --git a/service/migrationhuborchestrator/api_op_CreateTemplate.go b/service/migrationhuborchestrator/api_op_CreateTemplate.go index 0ccc77a36c1..7a7e73fd767 100644 --- a/service/migrationhuborchestrator/api_op_CreateTemplate.go +++ b/service/migrationhuborchestrator/api_op_CreateTemplate.go @@ -40,8 +40,9 @@ type CreateTemplateInput struct { TemplateSource types.TemplateSource // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. For more information, see Idempotency (https://smithy.io/2.0/spec/behavior-traits.html#idempotencytoken-trait) - // in the Smithy documentation. + // of the request. For more information, see [Idempotency]in the Smithy documentation. + // + // [Idempotency]: https://smithy.io/2.0/spec/behavior-traits.html#idempotencytoken-trait ClientToken *string // The tags to add to the migration workflow template. @@ -61,8 +62,9 @@ type CreateTemplateOutput struct { // The Amazon Resource Name (ARN) of the migration workflow template. The format // for an Migration Hub Orchestrator template ARN is // arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . - // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) - // in the AWS General Reference. + // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html TemplateArn *string // The ID of the migration workflow template. diff --git a/service/migrationhuborchestrator/api_op_GetTemplate.go b/service/migrationhuborchestrator/api_op_GetTemplate.go index 479a0484677..d01dd559582 100644 --- a/service/migrationhuborchestrator/api_op_GetTemplate.go +++ b/service/migrationhuborchestrator/api_op_GetTemplate.go @@ -70,17 +70,24 @@ type GetTemplateOutput struct { // >The Amazon Resource Name (ARN) of the migration workflow template. The format // for an Migration Hub Orchestrator template ARN is // arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . - // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) - // in the AWS General Reference. + // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html TemplateArn *string // The class of the migration workflow template. The available template classes // are: + // // - A2C + // // - MGN + // // - SAP_MULTI + // // - SQL_EC2 + // // - SQL_RDS + // // - VMIE TemplateClass *string diff --git a/service/migrationhuborchestrator/api_op_UpdateTemplate.go b/service/migrationhuborchestrator/api_op_UpdateTemplate.go index 3c831c550cc..2f6aca373c8 100644 --- a/service/migrationhuborchestrator/api_op_UpdateTemplate.go +++ b/service/migrationhuborchestrator/api_op_UpdateTemplate.go @@ -54,8 +54,9 @@ type UpdateTemplateOutput struct { // The ARN of the migration workflow template being updated. The format for an // Migration Hub Orchestrator template ARN is // arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . - // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) - // in the AWS General Reference. + // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the AWS General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html TemplateArn *string // The ID of the migration workflow template being updated. diff --git a/service/migrationhuborchestrator/options.go b/service/migrationhuborchestrator/options.go index dcfab000136..dba804a8f01 100644 --- a/service/migrationhuborchestrator/options.go +++ b/service/migrationhuborchestrator/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/migrationhuborchestrator/types/enums.go b/service/migrationhuborchestrator/types/enums.go index 3e90940a320..02d9c834bf3 100644 --- a/service/migrationhuborchestrator/types/enums.go +++ b/service/migrationhuborchestrator/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for DataType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataType) Values() []DataType { return []DataType{ "STRING", @@ -46,6 +47,7 @@ const ( // Values returns all known values for MigrationWorkflowStatusEnum. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MigrationWorkflowStatusEnum) Values() []MigrationWorkflowStatusEnum { return []MigrationWorkflowStatusEnum{ @@ -75,8 +77,9 @@ const ( ) // 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. +// the future, and so 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{ "AWS_MANAGED", @@ -93,8 +96,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -111,8 +115,9 @@ const ( ) // Values returns all known values for RunEnvironment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunEnvironment) Values() []RunEnvironment { return []RunEnvironment{ "AWS", @@ -129,8 +134,9 @@ const ( ) // Values returns all known values for StepActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepActionType) Values() []StepActionType { return []StepActionType{ "MANUAL", @@ -153,8 +159,9 @@ const ( ) // Values returns all known values for StepGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepGroupStatus) Values() []StepGroupStatus { return []StepGroupStatus{ "AWAITING_DEPENDENCIES", @@ -183,8 +190,9 @@ const ( ) // Values returns all known values for StepStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepStatus) Values() []StepStatus { return []StepStatus{ "AWAITING_DEPENDENCIES", @@ -208,8 +216,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "SINGLE", @@ -230,8 +239,9 @@ const ( ) // Values returns all known values for TemplateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateStatus) Values() []TemplateStatus { return []TemplateStatus{ "CREATED", diff --git a/service/migrationhubrefactorspaces/api_op_CreateApplication.go b/service/migrationhubrefactorspaces/api_op_CreateApplication.go index 663207f883c..63897e618a8 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateApplication.go +++ b/service/migrationhubrefactorspaces/api_op_CreateApplication.go @@ -16,13 +16,16 @@ import ( // account that owns the environment also owns the applications created inside the // environment, regardless of the account that creates the application. Refactor // Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load -// Balancer for the application proxy inside your account. In environments created -// with a CreateEnvironment:NetworkFabricType (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) -// of NONE you need to configure VPC to VPC connectivity (https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) -// between your service VPC and the application proxy VPC to route traffic through -// the application proxy to a service with a private URL endpoint. For more -// information, see Create an application (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html) -// in the Refactor Spaces User Guide. +// Balancer for the application proxy inside your account. +// +// In environments created with a [CreateEnvironment:NetworkFabricType] of NONE you need to configure [VPC to VPC connectivity] between your +// service VPC and the application proxy VPC to route traffic through the +// application proxy to a service with a private URL endpoint. For more +// information, see [Create an application]in the Refactor Spaces User Guide. +// +// [VPC to VPC connectivity]: https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html +// [Create an application]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html +// [CreateEnvironment:NetworkFabricType]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -86,8 +89,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The Amazon Web Services account ID of application creator. diff --git a/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go b/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go index 38ab1dae165..c6d585169ed 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go +++ b/service/migrationhubrefactorspaces/api_op_CreateEnvironment.go @@ -17,14 +17,15 @@ import ( // services, and routes created within the environment. They are referred to as the // 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 CreateEnvironment:NetworkFabricType (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) -// of TRANSIT_GATEWAY , Refactor Spaces provisions a transit gateway to enable -// services in VPCs to communicate directly across accounts. If -// CreateEnvironment:NetworkFabricType (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) -// is NONE , Refactor Spaces does not create a transit gateway and you must use -// your network infrastructure to route traffic to services with private URL -// endpoints. +// accounts that the environment is shared with. +// +// When creating an environment with a [CreateEnvironment:NetworkFabricType] of TRANSIT_GATEWAY , Refactor Spaces +// provisions a transit gateway to enable services in VPCs to communicate directly +// across accounts. If [CreateEnvironment:NetworkFabricType]is NONE , Refactor Spaces does not create a transit gateway +// and you must use your network infrastructure to route traffic to services with +// private URL endpoints. +// +// [CreateEnvironment:NetworkFabricType]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error) { if params == nil { params = &CreateEnvironmentInput{} diff --git a/service/migrationhubrefactorspaces/api_op_CreateRoute.go b/service/migrationhubrefactorspaces/api_op_CreateRoute.go index 327007eb52b..0fbc288e097 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateRoute.go +++ b/service/migrationhubrefactorspaces/api_op_CreateRoute.go @@ -16,58 +16,89 @@ 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 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: -// - URL Endpoints 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 a service endpoint resolves to a public IP address, Refactor Spaces -// routes traffic over the public internet. 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 -// publicly resolvable. Refactor Spaces automatically resolves the public Domain -// Name System (DNS) names that are set in CreateService: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. One-time health check 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 private URLs, a target group is created on -// the Network Load Balancer and the load balancer target group runs default target -// health checks. By default, the health check is run against the service endpoint -// URL. Optionally, the health check can be performed against a different protocol, -// port, and/or path using the CreateService:UrlEndpoint (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint) -// parameter. All other health check settings for the load balancer use the default -// values described in the Health checks for your target groups (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) -// in the Elastic Load Balancing guide. The health check is considered successful -// if at least one target within the target group transitions to a healthy state. -// - Lambda function endpoints 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. 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. 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. +// a DEFAULT RouteType . // -// Environments without a network bridge When you create environments without a -// network bridge ( CreateEnvironment:NetworkFabricType (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) -// is NONE) and you use your own networking infrastructure, you need to configure -// VPC to VPC connectivity (https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) -// between your network and the application proxy VPC. Route creation from the -// application proxy to service endpoints will fail if your network is not -// configured to connect to the application proxy VPC. For more information, see -// Create a route (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html) -// in the Refactor Spaces User Guide. +// 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: +// +// - URL Endpoints +// +// 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 a +// service endpoint resolves to a public IP address, Refactor Spaces routes traffic +// over the public internet. 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 publicly +// resolvable. +// +// Refactor Spaces automatically resolves the public Domain Name System (DNS) +// +// names that are set in CreateService: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. +// +// # One-time health check +// +// 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 private URLs, a target group is created on the Network Load Balancer and +// +// the load balancer target group runs default target health checks. By default, +// the health check is run against the service endpoint URL. Optionally, the health +// check can be performed against a different protocol, port, and/or path using the +// [CreateService:UrlEndpoint]parameter. All other health check settings for the load balancer use the +// default values described in the [Health checks for your target groups]in the Elastic Load Balancing guide. The +// health check is considered successful if at least one target within the target +// group transitions to a healthy state. +// +// - Lambda function endpoints +// +// 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. +// +// 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]in the Lambda Developer Guide. +// +// 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. +// +// # Environments without a network bridge +// +// When you create environments without a network bridge ([CreateEnvironment:NetworkFabricType] is NONE) and you use +// your own networking infrastructure, you need to configure [VPC to VPC connectivity]between your network +// and the application proxy VPC. Route creation from the application proxy to +// service endpoints will fail if your network is not configured to connect to the +// application proxy VPC. For more information, see [Create a route]in the Refactor Spaces User +// Guide. +// +// [VPC to VPC connectivity]: https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html +// [Create a route]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html +// [CreateEnvironment:NetworkFabricType]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType +// +// [CreateService:UrlEndpoint]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint +// [Health checks for your target groups]: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html +// [GetFunctionConfiguration's State response parameter]: https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error) { if params == nil { params = &CreateRouteInput{} @@ -113,7 +144,7 @@ type CreateRouteInput struct { // of the request. ClientToken *string - // Configuration for the default route type. + // Configuration for the default route type. DefaultRoute *types.DefaultRouteInput // The tags to assign to the route. A tag is a label that you assign to an Amazon @@ -133,8 +164,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The Amazon Web Services account ID of the route creator. diff --git a/service/migrationhubrefactorspaces/api_op_CreateService.go b/service/migrationhubrefactorspaces/api_op_CreateService.go index 95998642b2a..c86fc7f2d4d 100644 --- a/service/migrationhubrefactorspaces/api_op_CreateService.go +++ b/service/migrationhubrefactorspaces/api_op_CreateService.go @@ -15,11 +15,12 @@ import ( // Creates an Amazon Web Services Migration Hub Refactor Spaces service. The // account owner of the service is always the environment owner, regardless of // which account in the environment creates the service. Services have either a URL -// endpoint in a virtual private cloud (VPC), or a Lambda function endpoint. If an -// Amazon Web Services resource is launched in a service VPC, and you want it to be -// accessible to all of an environment’s services with VPCs and routes, apply the -// RefactorSpacesSecurityGroup to the resource. Alternatively, to add more -// cross-account constraints, apply your own security group. +// endpoint in a virtual private cloud (VPC), or a Lambda function endpoint. +// +// If an Amazon Web Services resource is launched in a service VPC, and you want +// it to be accessible to all of an environment’s services with VPCs and routes, +// apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add +// more cross-account constraints, apply your own security group. func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} diff --git a/service/migrationhubrefactorspaces/api_op_DeleteService.go b/service/migrationhubrefactorspaces/api_op_DeleteService.go index cd7aa3c4bc2..b685a020e07 100644 --- a/service/migrationhubrefactorspaces/api_op_DeleteService.go +++ b/service/migrationhubrefactorspaces/api_op_DeleteService.go @@ -30,9 +30,11 @@ func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, type DeleteServiceInput struct { - // Deletes a Refactor Spaces service. The RefactorSpacesSecurityGroup security - // group must be removed from all Amazon Web Services resources in the virtual - // private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC. + // Deletes a Refactor Spaces service. + // + // The RefactorSpacesSecurityGroup security group must be removed from all Amazon + // Web Services resources in the virtual private cloud (VPC) prior to deleting a + // service with a URL endpoint in a VPC. // // This member is required. ApplicationIdentifier *string diff --git a/service/migrationhubrefactorspaces/api_op_GetResourcePolicy.go b/service/migrationhubrefactorspaces/api_op_GetResourcePolicy.go index e0a54775100..f2c8111a11b 100644 --- a/service/migrationhubrefactorspaces/api_op_GetResourcePolicy.go +++ b/service/migrationhubrefactorspaces/api_op_GetResourcePolicy.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the resource-based permission policy that is set for the given environment. +// Gets the resource-based permission policy that is set for the given +// environment. func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) { if params == nil { params = &GetResourcePolicyInput{} diff --git a/service/migrationhubrefactorspaces/api_op_GetRoute.go b/service/migrationhubrefactorspaces/api_op_GetRoute.go index cd1a9520ad2..4ff25913879 100644 --- a/service/migrationhubrefactorspaces/api_op_GetRoute.go +++ b/service/migrationhubrefactorspaces/api_op_GetRoute.go @@ -90,10 +90,13 @@ type GetRouteOutput struct { // A mapping of Amazon API Gateway path resources to resource IDs. PathResourceToId map[string]string - // The unique identifier of the route. DEFAULT: 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: A route that is - // based on a URI path. + // The unique identifier of the route. + // + // DEFAULT: 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: A route that is based on a URI path. RouteId *string // The type of route. diff --git a/service/migrationhubrefactorspaces/api_op_GetService.go b/service/migrationhubrefactorspaces/api_op_GetService.go index c664ec57a83..05b43aa6ea9 100644 --- a/service/migrationhubrefactorspaces/api_op_GetService.go +++ b/service/migrationhubrefactorspaces/api_op_GetService.go @@ -74,8 +74,10 @@ type GetServiceOutput struct { // Any error associated with the service resource. Error *types.ErrorResponse - // The configuration for the Lambda endpoint type. The Arn is the Amazon Resource - // Name (ARN) of the Lambda function associated with this service. + // The configuration for the Lambda endpoint type. + // + // The Arn is the Amazon Resource Name (ARN) of the Lambda function associated + // with this service. LambdaEndpoint *types.LambdaEndpointConfig // A timestamp that indicates when the service was last updated. @@ -97,8 +99,11 @@ type GetServiceOutput struct { // Web Services resource. Each tag consists of a key-value pair. Tags map[string]string - // The configuration for the URL endpoint type. The Url isthe URL of the endpoint - // type. The HealthUrl is the health check URL of the endpoint type. + // The configuration for the URL endpoint type. + // + // The Url isthe URL of the endpoint type. + // + // The HealthUrl is the health check URL of the endpoint type. UrlEndpoint *types.UrlEndpointConfig // The ID of the virtual private cloud (VPC). diff --git a/service/migrationhubrefactorspaces/api_op_ListServices.go b/service/migrationhubrefactorspaces/api_op_ListServices.go index 9ef8c175552..a32f7e85a8b 100644 --- a/service/migrationhubrefactorspaces/api_op_ListServices.go +++ b/service/migrationhubrefactorspaces/api_op_ListServices.go @@ -55,7 +55,7 @@ type ListServicesOutput struct { // The token for the next page of results. NextToken *string - // The list of ServiceSummary objects. + // The list of ServiceSummary objects. ServiceSummaryList []types.ServiceSummary // Metadata pertaining to the operation's result. diff --git a/service/migrationhubrefactorspaces/api_op_TagResource.go b/service/migrationhubrefactorspaces/api_op_TagResource.go index 490eb31c6e0..9252d628874 100644 --- a/service/migrationhubrefactorspaces/api_op_TagResource.go +++ b/service/migrationhubrefactorspaces/api_op_TagResource.go @@ -12,9 +12,10 @@ 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_UpdateRoute.go b/service/migrationhubrefactorspaces/api_op_UpdateRoute.go index 98a0267d2f4..f36f6a7d59a 100644 --- a/service/migrationhubrefactorspaces/api_op_UpdateRoute.go +++ b/service/migrationhubrefactorspaces/api_op_UpdateRoute.go @@ -30,23 +30,23 @@ 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. ActivationState types.RouteActivationState - // The ID of the application within which the route is being updated. + // The ID of the application within which the route is being updated. // // This member is required. ApplicationIdentifier *string - // The ID of the environment in which the route is being updated. + // The ID of the environment in which the route is being updated. // // This member is required. EnvironmentIdentifier *string - // The unique identifier of the route to update. + // The unique identifier of the route to update. // // This member is required. RouteIdentifier *string @@ -56,26 +56,27 @@ type UpdateRouteInput struct { type UpdateRouteOutput struct { - // The ID of the application in which the route is being updated. + // The ID of the application in which the route is being updated. ApplicationId *string - // The Amazon Resource Name (ARN) of the route. The format for this ARN is + // 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string - // A timestamp that indicates when the route was last updated. + // A timestamp that indicates when the route was last updated. LastUpdatedTime *time.Time - // The unique identifier of the route. + // The unique identifier of the route. RouteId *string - // The ID of service in which the route was created. Traffic that matches this + // The ID of service in which the route was created. Traffic that matches this // route is forwarded to this service. ServiceId *string - // The current state of the route. + // The current state of the route. State types.RouteState // Metadata pertaining to the operation's result. diff --git a/service/migrationhubrefactorspaces/doc.go b/service/migrationhubrefactorspaces/doc.go index a05c5d917f7..21ae920170c 100644 --- a/service/migrationhubrefactorspaces/doc.go +++ b/service/migrationhubrefactorspaces/doc.go @@ -3,15 +3,19 @@ // Package migrationhubrefactorspaces provides the API client, operations, and // parameter types for AWS Migration Hub Refactor Spaces. // -// Amazon Web Services Migration Hub Refactor Spaces This API reference provides -// descriptions, syntax, and other details about each of the actions and data types -// for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). 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 (https://aws.amazon.com/tools/#SDKs) -// . To share Refactor Spaces environments with other Amazon Web Services accounts +// # Amazon Web Services Migration Hub Refactor Spaces +// +// This API reference provides descriptions, syntax, and other details about each +// of the actions and data types for Amazon Web Services Migration Hub Refactor +// Spaces (Refactor Spaces). 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]. +// +// 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. +// CreateResourceShare API. See [CreateResourceShare] in the Amazon Web Services RAM API Reference. +// +// [Amazon Web Services SDKs]: https://aws.amazon.com/tools/#SDKs +// [CreateResourceShare]: https://docs.aws.amazon.com/ram/latest/APIReference/API_CreateResourceShare.html package migrationhubrefactorspaces diff --git a/service/migrationhubrefactorspaces/options.go b/service/migrationhubrefactorspaces/options.go index dc47d3edcc7..7af4e0d7f4d 100644 --- a/service/migrationhubrefactorspaces/options.go +++ b/service/migrationhubrefactorspaces/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/migrationhubrefactorspaces/types/enums.go b/service/migrationhubrefactorspaces/types/enums.go index 4fa89aa70d4..f974ff15c80 100644 --- a/service/migrationhubrefactorspaces/types/enums.go +++ b/service/migrationhubrefactorspaces/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApiGatewayEndpointType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApiGatewayEndpointType) Values() []ApiGatewayEndpointType { return []ApiGatewayEndpointType{ "REGIONAL", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for ApplicationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationState) Values() []ApplicationState { return []ApplicationState{ "CREATING", @@ -55,8 +57,9 @@ const ( ) // Values returns all known values for EnvironmentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentState) Values() []EnvironmentState { return []EnvironmentState{ "CREATING", @@ -85,8 +88,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -130,8 +134,9 @@ const ( ) // Values returns all known values for ErrorResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ErrorResourceType) Values() []ErrorResourceType { return []ErrorResourceType{ "ENVIRONMENT", @@ -170,8 +175,9 @@ const ( ) // Values returns all known values for HttpMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpMethod) Values() []HttpMethod { return []HttpMethod{ "DELETE", @@ -193,8 +199,9 @@ const ( ) // Values returns all known values for NetworkFabricType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkFabricType) Values() []NetworkFabricType { return []NetworkFabricType{ "TRANSIT_GATEWAY", @@ -210,8 +217,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -227,8 +235,9 @@ const ( ) // Values returns all known values for RouteActivationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteActivationState) Values() []RouteActivationState { return []RouteActivationState{ "ACTIVE", @@ -249,8 +258,9 @@ const ( ) // Values returns all known values for RouteState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteState) Values() []RouteState { return []RouteState{ "CREATING", @@ -271,8 +281,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -289,8 +300,9 @@ const ( ) // Values returns all known values for ServiceEndpointType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceEndpointType) Values() []ServiceEndpointType { return []ServiceEndpointType{ "LAMBDA", @@ -309,8 +321,9 @@ const ( ) // 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. +// expanded in the future, and so 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 dbe902c0604..6b315c36b83 100644 --- a/service/migrationhubrefactorspaces/types/types.go +++ b/service/migrationhubrefactorspaces/types/types.go @@ -40,15 +40,16 @@ type ApiGatewayProxyConfig struct { type ApiGatewayProxyInput struct { // The type of endpoint to use for the API Gateway proxy. If no value is specified - // in the request, the value is set to REGIONAL by default. If the value is set to - // PRIVATE in the request, this creates a private API endpoint that is isolated - // from the public internet. The private endpoint can only be accessed by using - // Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API - // Gateway that has been granted access. For more information about creating a - // private connection with Refactor Spaces and interface endpoint (Amazon Web - // Services PrivateLink) availability, see Access Refactor Spaces using an - // interface endpoint (Amazon Web Services PrivateLink) (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/vpc-interface-endpoints.html) - // . + // in the request, the value is set to REGIONAL by default. + // + // If the value is set to PRIVATE in the request, this creates a private API + // endpoint that is isolated from the public internet. The private endpoint can + // only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface + // endpoints for the Amazon API Gateway that has been granted access. For more + // information about creating a private connection with Refactor Spaces and + // interface endpoint (Amazon Web Services PrivateLink) availability, see [Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink)]. + // + // [Access Refactor Spaces using an interface endpoint (Amazon Web Services PrivateLink)]: https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/vpc-interface-endpoints.html EndpointType ApiGatewayEndpointType // The name of the API Gateway stage. The name defaults to prod . @@ -440,10 +441,12 @@ 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]. 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]. + // + // [IANA root zone database]: https://www.iana.org/domains/root/db + // [rfc3986-formatted URL]: https://datatracker.ietf.org/doc/html/rfc3986 // // This member is required. Url *string @@ -466,10 +469,12 @@ 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]. 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]. + // + // [IANA root zone database]: https://www.iana.org/domains/root/db + // [rfc3986-formatted URL]: https://datatracker.ietf.org/doc/html/rfc3986 Url *string noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_GetApplicationComponentDetails.go b/service/migrationhubstrategy/api_op_GetApplicationComponentDetails.go index aa25720d731..e67ae5090e2 100644 --- a/service/migrationhubstrategy/api_op_GetApplicationComponentDetails.go +++ b/service/migrationhubstrategy/api_op_GetApplicationComponentDetails.go @@ -29,7 +29,7 @@ func (c *Client) GetApplicationComponentDetails(ctx context.Context, params *Get type GetApplicationComponentDetailsInput struct { - // The ID of the application component. The ID is unique within an AWS account. + // The ID of the application component. The ID is unique within an AWS account. // // This member is required. ApplicationComponentId *string @@ -39,17 +39,18 @@ type GetApplicationComponentDetailsInput struct { type GetApplicationComponentDetailsOutput struct { - // Detailed information about an application component. + // Detailed information about an application component. ApplicationComponentDetail *types.ApplicationComponentDetail - // The associated application group as defined in AWS Application Discovery + // The associated application group as defined in AWS Application Discovery // Service. AssociatedApplications []types.AssociatedApplication - // A list of the IDs of the servers on which the application component is running. + // A list of the IDs of the servers on which the application component is + // running. AssociatedServerIds []string - // Set to true if the application component belongs to more than one application + // Set to true if the application component belongs to more than one application // group. MoreApplicationResource *bool diff --git a/service/migrationhubstrategy/api_op_GetApplicationComponentStrategies.go b/service/migrationhubstrategy/api_op_GetApplicationComponentStrategies.go index 6a8c8fd9beb..f633f551b88 100644 --- a/service/migrationhubstrategy/api_op_GetApplicationComponentStrategies.go +++ b/service/migrationhubstrategy/api_op_GetApplicationComponentStrategies.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of all the recommended strategies and tools for an application -// component running on a server. +// Retrieves a list of all the recommended strategies and tools for an +// +// application component running on a server. func (c *Client) GetApplicationComponentStrategies(ctx context.Context, params *GetApplicationComponentStrategiesInput, optFns ...func(*Options)) (*GetApplicationComponentStrategiesOutput, error) { if params == nil { params = &GetApplicationComponentStrategiesInput{} @@ -30,7 +31,7 @@ func (c *Client) GetApplicationComponentStrategies(ctx context.Context, params * type GetApplicationComponentStrategiesInput struct { - // The ID of the application component. The ID is unique within an AWS account. + // The ID of the application component. The ID is unique within an AWS account. // // This member is required. ApplicationComponentId *string @@ -40,7 +41,7 @@ type GetApplicationComponentStrategiesInput struct { type GetApplicationComponentStrategiesOutput struct { - // A list of application component strategy recommendations. + // A list of application component strategy recommendations. ApplicationComponentStrategies []types.ApplicationComponentStrategy // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_GetAssessment.go b/service/migrationhubstrategy/api_op_GetAssessment.go index 7a8eb9e4c87..77ba971e46f 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 @@ -42,10 +42,10 @@ type GetAssessmentOutput struct { // List of criteria for assessment. AssessmentTargets []types.AssessmentTarget - // Detailed information about the assessment. + // Detailed information about the assessment. DataCollectionDetails *types.DataCollectionDetails - // The ID for the specific assessment task. + // The ID for the specific assessment task. Id *string // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_GetImportFileTask.go b/service/migrationhubstrategy/api_op_GetImportFileTask.go index 9acc3bffa44..80a67bacb97 100644 --- a/service/migrationhubstrategy/api_op_GetImportFileTask.go +++ b/service/migrationhubstrategy/api_op_GetImportFileTask.go @@ -30,8 +30,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 . + // The ID of the import file task. This ID is returned in the response of StartImportFileTask. // // This member is required. Id *string @@ -41,37 +40,37 @@ type GetImportFileTaskInput struct { type GetImportFileTaskOutput struct { - // The time that the import task completed. + // 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. + // The S3 bucket where import file is located. InputS3Bucket *string - // The Amazon S3 key name of the import file. + // The Amazon S3 key name of the import file. InputS3Key *string - // The number of records that failed to be imported. + // The number of records that failed to be imported. NumberOfRecordsFailed *int32 - // The number of records successfully imported. + // The number of records successfully imported. NumberOfRecordsSuccess *int32 - // Start time of the import task. + // Start time of the import task. StartTime *time.Time - // Status of import file task. + // Status of import file task. Status types.ImportFileTaskStatus - // The S3 bucket name for status report of import task. + // The S3 bucket name for status report of import task. StatusReportS3Bucket *string - // The Amazon S3 key name for status report of import task. The report contains + // The Amazon S3 key name for status report of import task. The report contains // details about whether each record imported successfully or why it did not. StatusReportS3Key *string diff --git a/service/migrationhubstrategy/api_op_GetPortfolioPreferences.go b/service/migrationhubstrategy/api_op_GetPortfolioPreferences.go index f340cf5df17..cd552d89bb0 100644 --- a/service/migrationhubstrategy/api_op_GetPortfolioPreferences.go +++ b/service/migrationhubstrategy/api_op_GetPortfolioPreferences.go @@ -36,13 +36,13 @@ type GetPortfolioPreferencesOutput struct { // The classification for application component types. ApplicationMode types.ApplicationMode - // The transformation preferences for non-database applications. + // The transformation preferences for non-database applications. ApplicationPreferences *types.ApplicationPreferences - // The transformation preferences for database applications. + // The transformation preferences for database applications. DatabasePreferences *types.DatabasePreferences - // The rank of business goals based on priority. + // The rank of business goals based on priority. PrioritizeBusinessGoals *types.PrioritizeBusinessGoals // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_GetPortfolioSummary.go b/service/migrationhubstrategy/api_op_GetPortfolioSummary.go index c86c603a1f9..5753ce09670 100644 --- a/service/migrationhubstrategy/api_op_GetPortfolioSummary.go +++ b/service/migrationhubstrategy/api_op_GetPortfolioSummary.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves overall summary including the number of servers to rehost and the +// Retrieves overall summary including the number of servers to rehost and the +// // overall number of anti-patterns. func (c *Client) GetPortfolioSummary(ctx context.Context, params *GetPortfolioSummaryInput, optFns ...func(*Options)) (*GetPortfolioSummaryOutput, error) { if params == nil { @@ -34,7 +35,7 @@ type GetPortfolioSummaryInput struct { type GetPortfolioSummaryOutput struct { - // An assessment summary for the portfolio including the number of servers to + // An assessment summary for the portfolio including the number of servers to // rehost and the overall number of anti-patterns. AssessmentSummary *types.AssessmentSummary diff --git a/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go b/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go index 28f203477e5..fb1c9a0821b 100644 --- a/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go +++ b/service/migrationhubstrategy/api_op_GetRecommendationReportDetails.go @@ -29,8 +29,7 @@ func (c *Client) GetRecommendationReportDetails(ctx context.Context, params *Get type GetRecommendationReportDetailsInput struct { - // The recommendation report generation task id returned by - // StartRecommendationReportGeneration . + // The recommendation report generation task id returned by StartRecommendationReportGeneration. // // This member is required. Id *string @@ -40,11 +39,10 @@ type GetRecommendationReportDetailsInput struct { type GetRecommendationReportDetailsOutput struct { - // The ID of the recommendation report generation task. See the response of - // StartRecommendationReportGeneration . + // The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration. Id *string - // Detailed information about the recommendation report. + // Detailed information about the recommendation report. RecommendationReportDetails *types.RecommendationReportDetails // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_GetServerDetails.go b/service/migrationhubstrategy/api_op_GetServerDetails.go index c50420a7c1b..61aad94790a 100644 --- a/service/migrationhubstrategy/api_op_GetServerDetails.go +++ b/service/migrationhubstrategy/api_op_GetServerDetails.go @@ -29,16 +29,16 @@ func (c *Client) GetServerDetails(ctx context.Context, params *GetServerDetailsI type GetServerDetailsInput struct { - // The ID of the server. + // The ID of the server. // // This member is required. ServerId *string - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of + // 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. @@ -49,15 +49,15 @@ type GetServerDetailsInput struct { type GetServerDetailsOutput struct { - // The associated application group the server belongs to, as defined in AWS + // The associated application group the server belongs to, as defined in AWS // Application Discovery Service. AssociatedApplications []types.AssociatedApplication - // The token you use to retrieve the next set of results, or null if there are no + // The token you use to retrieve the next set of results, or null if there are no // more results. NextToken *string - // Detailed information about the server. + // Detailed information about the server. ServerDetail *types.ServerDetail // Metadata pertaining to the operation's result. @@ -155,7 +155,7 @@ var _ GetServerDetailsAPIClient = (*Client)(nil) // GetServerDetailsPaginatorOptions is the paginator options for GetServerDetails type GetServerDetailsPaginatorOptions struct { - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. Limit int32 diff --git a/service/migrationhubstrategy/api_op_GetServerStrategies.go b/service/migrationhubstrategy/api_op_GetServerStrategies.go index be231a0df70..6ae0ec37f5e 100644 --- a/service/migrationhubstrategy/api_op_GetServerStrategies.go +++ b/service/migrationhubstrategy/api_op_GetServerStrategies.go @@ -29,7 +29,7 @@ func (c *Client) GetServerStrategies(ctx context.Context, params *GetServerStrat type GetServerStrategiesInput struct { - // The ID of the server. + // The ID of the server. // // This member is required. ServerId *string @@ -39,7 +39,7 @@ type GetServerStrategiesInput struct { type GetServerStrategiesOutput struct { - // A list of strategy recommendations for the server. + // A list of strategy recommendations for the server. ServerStrategies []types.ServerStrategy // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_ListApplicationComponents.go b/service/migrationhubstrategy/api_op_ListApplicationComponents.go index 4801fbb46f1..3e8c4279817 100644 --- a/service/migrationhubstrategy/api_op_ListApplicationComponents.go +++ b/service/migrationhubstrategy/api_op_ListApplicationComponents.go @@ -29,29 +29,29 @@ func (c *Client) ListApplicationComponents(ctx context.Context, params *ListAppl type ListApplicationComponentsInput struct { - // Criteria for filtering the list of application components. + // Criteria for filtering the list of application components. ApplicationComponentCriteria types.ApplicationComponentCriteria - // Specify the value based on the application component criteria type. For + // 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. + // set to server1 , then ListApplicationComponents returns all the application components running on + // server1. FilterValue *string - // The group ID specified in to filter on. + // The group ID specified in to filter on. GroupIdFilter []types.Group - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of + // 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 @@ -59,11 +59,11 @@ type ListApplicationComponentsInput struct { type ListApplicationComponentsOutput struct { - // The list of application components with detailed information about each + // The list of application components with detailed information about each // component. ApplicationComponentInfos []types.ApplicationComponentDetail - // The token you use to retrieve the next set of results, or null if there are no + // The token you use to retrieve the next set of results, or null if there are no // more results. NextToken *string @@ -160,7 +160,7 @@ var _ ListApplicationComponentsAPIClient = (*Client)(nil) // ListApplicationComponentsPaginatorOptions is the paginator options for // ListApplicationComponents type ListApplicationComponentsPaginatorOptions struct { - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. Limit int32 diff --git a/service/migrationhubstrategy/api_op_ListCollectors.go b/service/migrationhubstrategy/api_op_ListCollectors.go index 14573a0b054..a9521f95509 100644 --- a/service/migrationhubstrategy/api_op_ListCollectors.go +++ b/service/migrationhubstrategy/api_op_ListCollectors.go @@ -29,11 +29,11 @@ func (c *Client) ListCollectors(ctx context.Context, params *ListCollectorsInput type ListCollectorsInput struct { - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of + // 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. @@ -44,10 +44,10 @@ type ListCollectorsInput struct { type ListCollectorsOutput struct { - // The list of all the installed collectors. + // The list of all the installed collectors. Collectors []types.Collector - // The token you use to retrieve the next set of results, or null if there are no + // The token you use to retrieve the next set of results, or null if there are no // more results. NextToken *string @@ -143,7 +143,7 @@ var _ ListCollectorsAPIClient = (*Client)(nil) // ListCollectorsPaginatorOptions is the paginator options for ListCollectors type ListCollectorsPaginatorOptions struct { - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. Limit int32 diff --git a/service/migrationhubstrategy/api_op_ListImportFileTask.go b/service/migrationhubstrategy/api_op_ListImportFileTask.go index 334e7f46585..7dc621b3470 100644 --- a/service/migrationhubstrategy/api_op_ListImportFileTask.go +++ b/service/migrationhubstrategy/api_op_ListImportFileTask.go @@ -29,10 +29,10 @@ func (c *Client) ListImportFileTask(ctx context.Context, params *ListImportFileT type ListImportFileTaskInput struct { - // The total number of items to return. The maximum value is 100. + // 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 + // 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. @@ -43,11 +43,11 @@ type ListImportFileTaskInput struct { type ListImportFileTaskOutput struct { - // The token you use to retrieve the next set of results, or null if there are no + // The token you use to retrieve the next set of results, or null if there are no // more results. NextToken *string - // Lists information about the files you import. + // Lists information about the files you import. TaskInfos []types.ImportFileTaskInformation // Metadata pertaining to the operation's result. @@ -143,7 +143,7 @@ var _ ListImportFileTaskAPIClient = (*Client)(nil) // ListImportFileTaskPaginatorOptions is the paginator options for // ListImportFileTask type ListImportFileTaskPaginatorOptions struct { - // The total number of items to return. The maximum value is 100. + // The total number of items to return. 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/migrationhubstrategy/api_op_ListServers.go b/service/migrationhubstrategy/api_op_ListServers.go index 057c047f99b..0976f20362c 100644 --- a/service/migrationhubstrategy/api_op_ListServers.go +++ b/service/migrationhubstrategy/api_op_ListServers.go @@ -29,29 +29,29 @@ 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 + // 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 . FilterValue *string - // Specifies the group ID to filter on. + // Specifies the group ID to filter on. GroupIdFilter []types.Group - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. MaxResults *int32 - // The token from a previous call that you use to retrieve the next set of + // 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. + // 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 @@ -59,11 +59,11 @@ type ListServersInput struct { type ListServersOutput struct { - // The token you use to retrieve the next set of results, or null if there are no + // The token you use to retrieve the next set of results, or null if there are no // more results. NextToken *string - // The list of servers with detailed information about each server. + // The list of servers with detailed information about each server. ServerInfos []types.ServerDetail // Metadata pertaining to the operation's result. @@ -157,7 +157,7 @@ var _ ListServersAPIClient = (*Client)(nil) // ListServersPaginatorOptions is the paginator options for ListServers type ListServersPaginatorOptions struct { - // The maximum number of items to include in the response. The maximum value is + // The maximum number of items to include in the response. The maximum value is // 100. Limit int32 diff --git a/service/migrationhubstrategy/api_op_PutPortfolioPreferences.go b/service/migrationhubstrategy/api_op_PutPortfolioPreferences.go index 65da82e7cae..02ea9e4b958 100644 --- a/service/migrationhubstrategy/api_op_PutPortfolioPreferences.go +++ b/service/migrationhubstrategy/api_op_PutPortfolioPreferences.go @@ -32,13 +32,13 @@ type PutPortfolioPreferencesInput struct { // The classification for application component types. ApplicationMode types.ApplicationMode - // The transformation preferences for non-database applications. + // The transformation preferences for non-database applications. ApplicationPreferences *types.ApplicationPreferences - // The transformation preferences for database applications. + // The transformation preferences for database applications. DatabasePreferences *types.DatabasePreferences - // The rank of the business goals based on priority. + // The rank of the business goals based on priority. PrioritizeBusinessGoals *types.PrioritizeBusinessGoals noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_StartAssessment.go b/service/migrationhubstrategy/api_op_StartAssessment.go index 910bf148e6e..55fa5488b0f 100644 --- a/service/migrationhubstrategy/api_op_StartAssessment.go +++ b/service/migrationhubstrategy/api_op_StartAssessment.go @@ -35,11 +35,11 @@ type StartAssessmentInput struct { // List of criteria for assessment. AssessmentTargets []types.AssessmentTarget - // The S3 bucket used by the collectors to send analysis data to the service. The + // The S3 bucket used by the collectors to send analysis data to the service. The // bucket name must begin with migrationhub-strategy- . S3bucketForAnalysisData *string - // The S3 bucket where all the reports generated by the service are stored. The + // The S3 bucket where all the reports generated by the service are stored. The // bucket name must begin with migrationhub-strategy- . S3bucketForReportData *string @@ -48,7 +48,7 @@ type StartAssessmentInput struct { type StartAssessmentOutput struct { - // The ID of the assessment. + // The ID of the assessment. AssessmentId *string // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_StartImportFileTask.go b/service/migrationhubstrategy/api_op_StartImportFileTask.go index 7c7d9e14ad5..81e33f55fc9 100644 --- a/service/migrationhubstrategy/api_op_StartImportFileTask.go +++ b/service/migrationhubstrategy/api_op_StartImportFileTask.go @@ -29,18 +29,18 @@ func (c *Client) StartImportFileTask(ctx context.Context, params *StartImportFil type StartImportFileTaskInput struct { - // A descriptive name for the request. + // A descriptive name for the request. // // This member is required. Name *string - // The S3 bucket where the import file is located. The bucket name is required to + // The S3 bucket where the import file is located. The bucket name is required to // begin with migrationhub-strategy- . // // This member is required. S3Bucket *string - // The Amazon S3 key name of the import file. + // The Amazon S3 key name of the import file. // // This member is required. S3key *string @@ -54,8 +54,8 @@ type StartImportFileTaskInput struct { // can be as filter in ListApplicationComponents and ListServers . GroupId []types.Group - // The S3 bucket where Strategy Recommendations uploads import results. The bucket - // name is required to begin with migrationhub-strategy-. + // The S3 bucket where Strategy Recommendations uploads import results. The + // bucket name is required to begin with migrationhub-strategy-. S3bucketForReportData *string noSmithyDocumentSerde @@ -63,7 +63,7 @@ type StartImportFileTaskInput struct { type StartImportFileTaskOutput struct { - // The ID for a specific import task. The ID is unique within an AWS account. + // The ID for a specific import task. The ID is unique within an AWS account. Id *string // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_StartRecommendationReportGeneration.go b/service/migrationhubstrategy/api_op_StartRecommendationReportGeneration.go index bc1d5db9f54..1e59d52f81b 100644 --- a/service/migrationhubstrategy/api_op_StartRecommendationReportGeneration.go +++ b/service/migrationhubstrategy/api_op_StartRecommendationReportGeneration.go @@ -29,10 +29,10 @@ func (c *Client) StartRecommendationReportGeneration(ctx context.Context, params type StartRecommendationReportGenerationInput struct { - // Groups the resources in the recommendation report with a unique name. + // Groups the resources in the recommendation report with a unique name. GroupIdFilter []types.Group - // The output format for the recommendation report file. The default format is + // The output format for the recommendation report file. The default format is // Microsoft Excel. OutputFormat types.OutputFormat @@ -41,7 +41,7 @@ type StartRecommendationReportGenerationInput struct { type StartRecommendationReportGenerationOutput struct { - // The ID of the recommendation report generation task. + // The ID of the recommendation report generation task. Id *string // Metadata pertaining to the operation's result. diff --git a/service/migrationhubstrategy/api_op_StopAssessment.go b/service/migrationhubstrategy/api_op_StopAssessment.go index e5b4e231314..a9be85bb6a7 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_UpdateApplicationComponentConfig.go b/service/migrationhubstrategy/api_op_UpdateApplicationComponentConfig.go index c3f6a8b501f..9b81709f205 100644 --- a/service/migrationhubstrategy/api_op_UpdateApplicationComponentConfig.go +++ b/service/migrationhubstrategy/api_op_UpdateApplicationComponentConfig.go @@ -29,7 +29,7 @@ func (c *Client) UpdateApplicationComponentConfig(ctx context.Context, params *U type UpdateApplicationComponentConfigInput struct { - // The ID of the application component. The ID is unique within an AWS account. + // The ID of the application component. The ID is unique within an AWS account. // // This member is required. ApplicationComponentId *string @@ -43,18 +43,19 @@ type UpdateApplicationComponentConfigInput struct { // is initiated. ConfigureOnly *bool - // Indicates whether the application component has been included for server + // Indicates whether the application component has been included for server // recommendation or not. InclusionStatus types.InclusionStatus - // Database credentials. + // Database credentials. SecretsManagerKey *string - // The list of source code configurations to update for the application component. + // The list of source code configurations to update for the application + // component. SourceCodeList []types.SourceCode - // The preferred strategy options for the application component. Use values from - // the GetApplicationComponentStrategies response. + // The preferred strategy options for the application component. Use values from + // the GetApplicationComponentStrategiesresponse. StrategyOption *types.StrategyOption noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/api_op_UpdateServerConfig.go b/service/migrationhubstrategy/api_op_UpdateServerConfig.go index b3f94281a9c..b0bf24ff0d1 100644 --- a/service/migrationhubstrategy/api_op_UpdateServerConfig.go +++ b/service/migrationhubstrategy/api_op_UpdateServerConfig.go @@ -29,13 +29,13 @@ func (c *Client) UpdateServerConfig(ctx context.Context, params *UpdateServerCon type UpdateServerConfigInput struct { - // The ID of the server. + // The ID of the server. // // This member is required. ServerId *string - // The preferred strategy options for the application component. See the response - // from GetServerStrategies . + // The preferred strategy options for the application component. See the response + // from GetServerStrategies. StrategyOption *types.StrategyOption noSmithyDocumentSerde diff --git a/service/migrationhubstrategy/doc.go b/service/migrationhubstrategy/doc.go index f2988416a1f..2e2dcb6e3dc 100644 --- a/service/migrationhubstrategy/doc.go +++ b/service/migrationhubstrategy/doc.go @@ -3,11 +3,14 @@ // 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]. +// +// [AWS SDKs]: http://aws.amazon.com/tools/#SDKs package migrationhubstrategy diff --git a/service/migrationhubstrategy/options.go b/service/migrationhubstrategy/options.go index 988fd79ade1..2a63246c670 100644 --- a/service/migrationhubstrategy/options.go +++ b/service/migrationhubstrategy/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/migrationhubstrategy/types/enums.go b/service/migrationhubstrategy/types/enums.go index f9920970cbe..b1566828182 100644 --- a/service/migrationhubstrategy/types/enums.go +++ b/service/migrationhubstrategy/types/enums.go @@ -13,8 +13,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for AntipatternReportStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AntipatternReportStatus) Values() []AntipatternReportStatus { return []AntipatternReportStatus{ "FAILED", @@ -60,8 +62,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationComponentCriteria) Values() []ApplicationComponentCriteria { return []ApplicationComponentCriteria{ "NOT_DEFINED", @@ -85,8 +88,9 @@ const ( ) // Values returns all known values for ApplicationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationMode) Values() []ApplicationMode { return []ApplicationMode{ "ALL", @@ -124,8 +128,9 @@ const ( ) // Values returns all known values for AppType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppType) Values() []AppType { return []AppType{ "DotNetFramework", @@ -165,8 +170,9 @@ const ( ) // Values returns all known values for AppUnitErrorCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppUnitErrorCategory) Values() []AppUnitErrorCategory { return []AppUnitErrorCategory{ "CREDENTIAL_ERROR", @@ -188,6 +194,7 @@ const ( // Values returns all known values for AssessmentDataSourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentDataSourceType) Values() []AssessmentDataSourceType { return []AssessmentDataSourceType{ @@ -208,8 +215,9 @@ const ( ) // Values returns all known values for AssessmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentStatus) Values() []AssessmentStatus { return []AssessmentStatus{ "IN_PROGRESS", @@ -229,8 +237,9 @@ const ( ) // Values returns all known values for AuthType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthType) Values() []AuthType { return []AuthType{ "NTLM", @@ -250,6 +259,7 @@ const ( // Values returns all known values for AwsManagedTargetDestination. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AwsManagedTargetDestination) Values() []AwsManagedTargetDestination { return []AwsManagedTargetDestination{ @@ -268,8 +278,9 @@ const ( ) // Values returns all known values for BinaryAnalyzerName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BinaryAnalyzerName) Values() []BinaryAnalyzerName { return []BinaryAnalyzerName{ "DLL_ANALYZER", @@ -286,8 +297,9 @@ const ( ) // Values returns all known values for CollectorHealth. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CollectorHealth) Values() []CollectorHealth { return []CollectorHealth{ "COLLECTOR_HEALTHY", @@ -306,8 +318,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -328,8 +341,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseManagementPreference) Values() []DatabaseManagementPreference { return []DatabaseManagementPreference{ "AWS-managed", @@ -349,8 +363,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "ApplicationDiscoveryService", @@ -369,8 +384,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -396,8 +412,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HeterogeneousTargetDatabaseEngine) Values() []HeterogeneousTargetDatabaseEngine { return []HeterogeneousTargetDatabaseEngine{ "None specified", @@ -422,8 +439,9 @@ const ( // Values returns all known values for HomogeneousTargetDatabaseEngine. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HomogeneousTargetDatabaseEngine) Values() []HomogeneousTargetDatabaseEngine { return []HomogeneousTargetDatabaseEngine{ "None specified", @@ -445,8 +463,9 @@ const ( ) // Values returns all known values for ImportFileTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportFileTaskStatus) Values() []ImportFileTaskStatus { return []ImportFileTaskStatus{ "ImportInProgress", @@ -469,8 +488,9 @@ const ( ) // Values returns all known values for InclusionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InclusionStatus) Values() []InclusionStatus { return []InclusionStatus{ "excludeFromAssessment", @@ -492,8 +512,9 @@ const ( // Values returns all known values for NoPreferenceTargetDestination. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NoPreferenceTargetDestination) Values() []NoPreferenceTargetDestination { return []NoPreferenceTargetDestination{ "None specified", @@ -514,8 +535,9 @@ const ( ) // Values returns all known values for OSType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OSType) Values() []OSType { return []OSType{ "LINUX", @@ -532,8 +554,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -549,8 +572,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -568,6 +592,7 @@ const ( // Values returns all known values for RecommendationReportStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationReportStatus) Values() []RecommendationReportStatus { return []RecommendationReportStatus{ @@ -587,8 +612,9 @@ const ( ) // Values returns all known values for ResourceSubType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSubType) Values() []ResourceSubType { return []ResourceSubType{ "Database", @@ -608,8 +634,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ANALYSIS_TO_BE_SCHEDULED", @@ -631,8 +658,9 @@ const ( ) // Values returns all known values for RunTimeAnalyzerName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunTimeAnalyzerName) Values() []RunTimeAnalyzerName { return []RunTimeAnalyzerName{ "A2C_ANALYZER", @@ -657,8 +685,9 @@ const ( ) // Values returns all known values for RunTimeAssessmentStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunTimeAssessmentStatus) Values() []RunTimeAssessmentStatus { return []RunTimeAssessmentStatus{ "dataCollectionTaskToBeScheduled", @@ -683,6 +712,7 @@ const ( // Values returns all known values for SelfManageTargetDestination. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SelfManageTargetDestination) Values() []SelfManageTargetDestination { return []SelfManageTargetDestination{ @@ -707,8 +737,9 @@ const ( ) // Values returns all known values for ServerCriteria. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerCriteria) Values() []ServerCriteria { return []ServerCriteria{ "NOT_DEFINED", @@ -733,8 +764,9 @@ const ( ) // Values returns all known values for ServerErrorCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerErrorCategory) Values() []ServerErrorCategory { return []ServerErrorCategory{ "CONNECTIVITY_ERROR", @@ -757,8 +789,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -779,8 +812,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "HIGH", @@ -798,8 +832,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -818,8 +853,9 @@ const ( ) // Values returns all known values for SourceCodeAnalyzerName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceCodeAnalyzerName) Values() []SourceCodeAnalyzerName { return []SourceCodeAnalyzerName{ "CSHARP_ANALYZER", @@ -844,6 +880,7 @@ const ( // Values returns all known values for SrcCodeOrDbAnalysisStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SrcCodeOrDbAnalysisStatus) Values() []SrcCodeOrDbAnalysisStatus { return []SrcCodeOrDbAnalysisStatus{ @@ -871,8 +908,9 @@ const ( ) // Values returns all known values for Strategy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Strategy) Values() []Strategy { return []Strategy{ "Rehost", @@ -896,8 +934,9 @@ const ( ) // Values returns all known values for StrategyRecommendation. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StrategyRecommendation) Values() []StrategyRecommendation { return []StrategyRecommendation{ "recommended", @@ -924,8 +963,9 @@ const ( ) // Values returns all known values for TargetDatabaseEngine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetDatabaseEngine) Values() []TargetDatabaseEngine { return []TargetDatabaseEngine{ "None specified", @@ -962,8 +1002,9 @@ const ( ) // Values returns all known values for TargetDestination. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetDestination) Values() []TargetDestination { return []TargetDestination{ "None specified", @@ -1000,8 +1041,9 @@ const ( ) // Values returns all known values for TransformationToolName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformationToolName) Values() []TransformationToolName { return []TransformationToolName{ "App2Container", @@ -1027,8 +1069,9 @@ const ( ) // Values returns all known values for VersionControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VersionControl) Values() []VersionControl { return []VersionControl{ "GITHUB", @@ -1047,8 +1090,9 @@ const ( ) // Values returns all known values for VersionControlType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VersionControlType) Values() []VersionControlType { return []VersionControlType{ "GITHUB", diff --git a/service/migrationhubstrategy/types/errors.go b/service/migrationhubstrategy/types/errors.go index 5a3b6b86084..b5dd4822012 100644 --- a/service/migrationhubstrategy/types/errors.go +++ b/service/migrationhubstrategy/types/errors.go @@ -7,8 +7,9 @@ import ( smithy "github.com/aws/smithy-go" ) -// The user does not have permission to perform the action. Check the AWS Identity -// and Access Management (IAM) policy associated with this user. +// The user does not have permission to perform the action. Check the AWS +// +// Identity and Access Management (IAM) policy associated with this user. type AccessDeniedException struct { Message *string @@ -34,8 +35,9 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Exception to indicate that there is an ongoing task when a new task is created. -// Return when once the existing tasks are complete. +// Exception to indicate that there is an ongoing task when a new task is +// +// created. Return when once the existing tasks are complete. type ConflictException struct { Message *string @@ -167,7 +169,8 @@ func (e *ServiceLinkedRoleLockClientException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The AWS account has reached its quota of imports. Contact AWS Support to +// The AWS account has reached its quota of imports. Contact AWS Support to +// // increase the quota for this account. type ServiceQuotaExceededException struct { Message *string diff --git a/service/migrationhubstrategy/types/types.go b/service/migrationhubstrategy/types/types.go index 45b25bb805d..3dd7d83e19d 100644 --- a/service/migrationhubstrategy/types/types.go +++ b/service/migrationhubstrategy/types/types.go @@ -97,7 +97,7 @@ type AntipatternReportResult struct { // The analyzer name. AnalyzerName AnalyzerNameUnion - // Contains the S3 bucket name and the Amazon S3 key name. + // Contains the S3 bucket name and the Amazon S3 key name. AntiPatternReportS3Object *S3Object // The status of the anti-pattern report generation. @@ -112,10 +112,10 @@ type AntipatternReportResult struct { // Contains the summary of anti-patterns and their severity. type AntipatternSeveritySummary struct { - // Contains the count of anti-patterns. + // Contains the count of anti-patterns. Count *int32 - // Contains the severity of anti-patterns. + // Contains the severity of anti-patterns. Severity Severity noSmithyDocumentSerde @@ -124,61 +124,61 @@ type AntipatternSeveritySummary struct { // Contains detailed information about an application component. type ApplicationComponentDetail struct { - // The status of analysis, if the application component has source code or an + // The status of analysis, if the application component has source code or an // associated database. AnalysisStatus SrcCodeOrDbAnalysisStatus - // The S3 bucket name and the Amazon S3 key name for the anti-pattern report. + // The S3 bucket name and the Amazon S3 key name for the anti-pattern report. AntipatternReportS3Object *S3Object - // The status of the anti-pattern report generation. + // The status of the anti-pattern report generation. AntipatternReportStatus AntipatternReportStatus - // The status message for the anti-pattern. + // The status message for the anti-pattern. AntipatternReportStatusMessage *string - // The type of application component. + // The type of application component. AppType AppType // The error in the analysis of the source code or database. AppUnitError *AppUnitError - // The ID of the server that the application component is running on. + // The ID of the server that the application component is running on. AssociatedServerId *string - // Configuration details for the database associated with the application + // Configuration details for the database associated with the application // component. DatabaseConfigDetail *DatabaseConfigDetail - // The ID of the application component. + // The ID of the application component. Id *string - // Indicates whether the application component has been included for server + // Indicates whether the application component has been included for server // recommendation or not. InclusionStatus InclusionStatus - // The timestamp of when the application component was assessed. + // The timestamp of when the application component was assessed. LastAnalyzedTimestamp *time.Time - // A list of anti-pattern severity summaries. + // A list of anti-pattern severity summaries. ListAntipatternSeveritySummary []AntipatternSeveritySummary - // Set to true if the application component is running on multiple servers. + // Set to true if the application component is running on multiple servers. MoreServerAssociationExists *bool - // The name of application component. + // The name of application component. Name *string - // OS driver. + // OS driver. OsDriver *string - // OS version. + // OS version. OsVersion *string - // The top recommendation set for the application component. + // The top recommendation set for the application component. RecommendationSet *RecommendationSet - // The application component subtype. + // The application component subtype. ResourceSubType ResourceSubType // A list of the analysis results. @@ -190,11 +190,11 @@ type ApplicationComponentDetail struct { // The status message for the application unit. RuntimeStatusMessage *string - // Details about the source code repository associated with the application + // Details about the source code repository associated with the application // component. SourceCodeRepositories []SourceCodeRepository - // A detailed description of the analysis status and any failure message. + // A detailed description of the analysis status and any failure message. StatusMessage *string noSmithyDocumentSerde @@ -213,17 +213,18 @@ type ApplicationComponentStatusSummary struct { noSmithyDocumentSerde } -// Contains information about a strategy recommendation for an application +// Contains information about a strategy recommendation for an application +// // component. type ApplicationComponentStrategy struct { - // Set to true if the recommendation is set as preferred. + // Set to true if the recommendation is set as preferred. IsPreferred *bool - // Strategy recommendation for the application component. + // Strategy recommendation for the application component. Recommendation *RecommendationSet - // The recommendation status of a strategy for an application component. + // The recommendation status of a strategy for an application component. Status StrategyRecommendation noSmithyDocumentSerde @@ -232,10 +233,10 @@ type ApplicationComponentStrategy struct { // Contains the summary of application components. type ApplicationComponentSummary struct { - // Contains the name of application types. + // Contains the name of application types. AppType AppType - // Contains the count of application type. + // Contains the count of application type. Count *int32 noSmithyDocumentSerde @@ -244,7 +245,7 @@ type ApplicationComponentSummary struct { // Application preferences that you specify. type ApplicationPreferences struct { - // Application preferences that you specify to prefer managed environment. + // Application preferences that you specify to prefer managed environment. ManagementPreference ManagementPreference noSmithyDocumentSerde @@ -262,37 +263,37 @@ type AppUnitError struct { // Contains the summary of the assessment results. type AssessmentSummary struct { - // The Amazon S3 object containing the anti-pattern report. + // The Amazon S3 object containing the anti-pattern report. AntipatternReportS3Object *S3Object - // The status of the anti-pattern report. + // The status of the anti-pattern report. AntipatternReportStatus AntipatternReportStatus - // The status message of the anti-pattern report. + // The status message of the anti-pattern report. AntipatternReportStatusMessage *string - // The time the assessment was performed. + // The time the assessment was performed. LastAnalyzedTimestamp *time.Time - // List of AntipatternSeveritySummary. + // List of AntipatternSeveritySummary. ListAntipatternSeveritySummary []AntipatternSeveritySummary // List of status summaries of the analyzed application components. ListApplicationComponentStatusSummary []ApplicationComponentStatusSummary - // List of ApplicationComponentStrategySummary. + // List of ApplicationComponentStrategySummary. ListApplicationComponentStrategySummary []StrategySummary - // List of ApplicationComponentSummary. + // List of ApplicationComponentSummary. ListApplicationComponentSummary []ApplicationComponentSummary // List of status summaries of the analyzed servers. ListServerStatusSummary []ServerStatusSummary - // List of ServerStrategySummary. + // List of ServerStrategySummary. ListServerStrategySummary []StrategySummary - // List of ServerSummary. + // List of ServerSummary. ListServerSummary []ServerSummary noSmithyDocumentSerde @@ -319,14 +320,15 @@ type AssessmentTarget struct { noSmithyDocumentSerde } -// Object containing details about applications as defined in Application +// Object containing details about applications as defined in Application +// // Discovery Service. type AssociatedApplication struct { - // ID of the application as defined in Application Discovery Service. + // ID of the application as defined in Application Discovery Service. Id *string - // Name of the application as defined in Application Discovery Service. + // Name of the application as defined in Application Discovery Service. Name *string noSmithyDocumentSerde @@ -335,7 +337,7 @@ type AssociatedApplication struct { // Object containing the choice of application destination that you specify. type AwsManagedResources struct { - // The choice of application destination that you specify. + // The choice of application destination that you specify. // // This member is required. TargetDestination []AwsManagedTargetDestination @@ -346,18 +348,18 @@ type AwsManagedResources struct { // Business goals that you specify. type BusinessGoals struct { - // Business goal to reduce license costs. + // Business goal to reduce license costs. LicenseCostReduction *int32 - // Business goal to modernize infrastructure by moving to cloud native + // Business goal to modernize infrastructure by moving to cloud native // technologies. ModernizeInfrastructureWithCloudNativeTechnologies *int32 - // Business goal to reduce the operational overhead on the team by moving into + // Business goal to reduce the operational overhead on the team by moving into // managed services. ReduceOperationalOverheadWithManagedServices *int32 - // Business goal to achieve migration at a fast pace. + // Business goal to achieve migration at a fast pace. SpeedOfMigration *int32 noSmithyDocumentSerde @@ -366,29 +368,29 @@ type BusinessGoals struct { // Process data collector that runs in the environment that you specify. type Collector struct { - // Indicates the health of a collector. + // Indicates the health of a collector. CollectorHealth CollectorHealth - // The ID of the collector. + // The ID of the collector. CollectorId *string - // Current version of the collector that is running in the environment that you + // Current version of the collector that is running in the environment that you // specify. CollectorVersion *string // Summary of the collector configuration. ConfigurationSummary *ConfigurationSummary - // Hostname of the server that is hosting the collector. + // Hostname of the server that is hosting the collector. HostName *string - // IP address of the server that is hosting the collector. + // IP address of the server that is hosting the collector. IpAddress *string - // Time when the collector last pinged the service. + // Time when the collector last pinged the service. LastActivityTimeStamp *string - // Time when the collector registered with the service. + // Time when the collector registered with the service. RegisteredTimeStamp *string noSmithyDocumentSerde @@ -418,14 +420,14 @@ type ConfigurationSummary struct { // Configuration information used for assessing databases. type DatabaseConfigDetail struct { - // AWS Secrets Manager key that holds the credentials that you use to connect to a - // database. + // AWS Secrets Manager key that holds the credentials that you use to connect to + // a database. SecretName *string noSmithyDocumentSerde } -// Preferences for migrating a database to AWS. +// Preferences for migrating a database to AWS. // // The following types satisfy this interface: // @@ -436,7 +438,8 @@ type DatabaseMigrationPreference interface { isDatabaseMigrationPreference() } -// Indicates whether you are interested in moving from one type of database to +// Indicates whether you are interested in moving from one type of database to +// // another. For example, from SQL Server to Amazon Aurora MySQL-Compatible Edition. type DatabaseMigrationPreferenceMemberHeterogeneous struct { Value Heterogeneous @@ -446,7 +449,8 @@ type DatabaseMigrationPreferenceMemberHeterogeneous struct { func (*DatabaseMigrationPreferenceMemberHeterogeneous) isDatabaseMigrationPreference() {} -// Indicates whether you are interested in moving to the same type of database +// 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 @@ -468,11 +472,11 @@ func (*DatabaseMigrationPreferenceMemberNoPreference) isDatabaseMigrationPrefere // Preferences on managing your databases on AWS. type DatabasePreferences struct { - // Specifies whether you're interested in self-managed databases or databases + // Specifies whether you're interested in self-managed databases or databases // managed by AWS. DatabaseManagementPreference DatabaseManagementPreference - // Specifies your preferred migration path. + // Specifies your preferred migration path. DatabaseMigrationPreference DatabaseMigrationPreference noSmithyDocumentSerde @@ -481,41 +485,42 @@ type DatabasePreferences struct { // Detailed information about an assessment. type DataCollectionDetails struct { - // The time the assessment completes. + // The time the assessment completes. CompletionTime *time.Time - // The number of failed servers in the assessment. + // 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. + // The total number of servers in the assessment. Servers *int32 - // The start time of assessment. + // The start time of assessment. StartTime *time.Time - // The status of the assessment. + // The status of the assessment. Status AssessmentStatus // The status message of the assessment. StatusMessage *string - // The number of successful servers in the assessment. + // The number of successful servers in the assessment. Success *int32 noSmithyDocumentSerde } -// The object containing information about distinct imports or groups for Strategy -// Recommendations. +// The object containing information about distinct imports or groups for +// +// Strategy Recommendations. type Group struct { - // The key of the specific import group. + // The key of the specific import group. Name GroupName - // The value of the specific import group. + // The value of the specific import group. Value *string noSmithyDocumentSerde @@ -524,7 +529,7 @@ type Group struct { // The object containing details about heterogeneous database preferences. type Heterogeneous struct { - // The target database engine for heterogeneous database migration preference. + // The target database engine for heterogeneous database migration preference. // // This member is required. TargetDatabaseEngine []HeterogeneousTargetDatabaseEngine @@ -535,7 +540,7 @@ type Heterogeneous struct { // The object containing details about homogeneous database preferences. type Homogeneous struct { - // The target database engine for homogeneous database migration preferences. + // The target database engine for homogeneous database migration preferences. TargetDatabaseEngine []HomogeneousTargetDatabaseEngine noSmithyDocumentSerde @@ -544,37 +549,37 @@ type Homogeneous struct { // Information about the import file tasks you request. type ImportFileTaskInformation struct { - // The time that the import task completes. + // The time that the import task completes. CompletionTime *time.Time - // The ID of the import file task. + // 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. + // The S3 bucket where the import file is located. InputS3Bucket *string - // The Amazon S3 key name of the import file. + // The Amazon S3 key name of the import file. InputS3Key *string - // The number of records that failed to be imported. + // The number of records that failed to be imported. NumberOfRecordsFailed *int32 - // The number of records successfully imported. + // The number of records successfully imported. NumberOfRecordsSuccess *int32 - // Start time of the import task. + // Start time of the import task. StartTime *time.Time - // Status of import file task. + // Status of import file task. Status ImportFileTaskStatus - // The S3 bucket name for status report of import task. + // The S3 bucket name for status report of import task. StatusReportS3Bucket *string - // The Amazon S3 key name for status report of import task. The report contains + // The Amazon S3 key name for status report of import task. The report contains // details about whether each record imported successfully or why it did not. StatusReportS3Key *string @@ -596,7 +601,7 @@ type IPAddressBasedRemoteInfo struct { noSmithyDocumentSerde } -// Preferences for migrating an application to AWS. +// Preferences for migrating an application to AWS. // // The following types satisfy this interface: // @@ -637,24 +642,25 @@ func (*ManagementPreferenceMemberSelfManageResources) isManagementPreference() { // Information about the server's network for which the assessment was run. type NetworkInfo struct { - // Information about the name of the interface of the server for which the + // Information about the name of the interface of the server for which the // assessment was run. // // This member is required. InterfaceName *string - // Information about the IP address of the server for which the assessment was run. + // Information about the IP address of the server for which the assessment was + // run. // // This member is required. IpAddress *string - // Information about the MAC address of the server for which the assessment was + // Information about the MAC address of the server for which the assessment was // run. // // This member is required. MacAddress *string - // Information about the subnet mask of the server for which the assessment was + // Information about the subnet mask of the server for which the assessment was // run. // // This member is required. @@ -663,11 +669,12 @@ type NetworkInfo struct { noSmithyDocumentSerde } -// The object containing details about database migration preferences, when you +// The object containing details about database migration preferences, when you +// // have no particular preference. type NoDatabaseMigrationPreference struct { - // The target database engine for database migration preference that you specify. + // The target database engine for database migration preference that you specify. // // This member is required. TargetDatabaseEngine []TargetDatabaseEngine @@ -678,7 +685,7 @@ type NoDatabaseMigrationPreference struct { // Object containing the choice of application destination that you specify. type NoManagementPreference struct { - // The choice of application destination that you specify. + // The choice of application destination that you specify. // // This member is required. TargetDestination []NoPreferenceTargetDestination @@ -689,10 +696,10 @@ type NoManagementPreference struct { // Information about the operating system. type OSInfo struct { - // Information about the type of operating system. + // Information about the type of operating system. Type OSType - // Information about the version of operating system. + // Information about the version of operating system. Version *string noSmithyDocumentSerde @@ -713,7 +720,7 @@ type PipelineInfo struct { // Rank of business goals based on priority. type PrioritizeBusinessGoals struct { - // Rank of business goals based on priority. + // Rank of business goals based on priority. BusinessGoals *BusinessGoals noSmithyDocumentSerde @@ -722,22 +729,22 @@ type PrioritizeBusinessGoals struct { // Contains detailed information about a recommendation report. type RecommendationReportDetails struct { - // The time that the recommendation report generation task completes. + // The time that the recommendation report generation task completes. CompletionTime *time.Time - // The S3 bucket where the report file is located. + // The S3 bucket where the report file is located. S3Bucket *string - // The Amazon S3 key name of the report file. + // The Amazon S3 key name of the report file. S3Keys []string - // The time that the recommendation report generation task starts. + // The time that the recommendation report generation task starts. StartTime *time.Time - // The status of the recommendation report generation task. + // The status of the recommendation report generation task. Status RecommendationReportStatus - // The status message for recommendation report generation. + // The status message for recommendation report generation. StatusMessage *string noSmithyDocumentSerde @@ -746,13 +753,13 @@ type RecommendationReportDetails struct { // Contains a recommendation set. type RecommendationSet struct { - // The recommended strategy. + // The recommended strategy. Strategy Strategy - // The recommended target destination. + // The recommended target destination. TargetDestination TargetDestination - // The target destination for the recommendation set. + // The target destination for the recommendation set. TransformationTool *TransformationTool noSmithyDocumentSerde @@ -788,10 +795,10 @@ type Result struct { // Contains the S3 bucket name and the Amazon S3 key name. type S3Object struct { - // The S3 bucket name. + // The S3 bucket name. S3Bucket *string - // The Amazon S3 key name. + // The Amazon S3 key name. S3key *string noSmithyDocumentSerde @@ -800,7 +807,7 @@ type S3Object struct { // Self-managed resources. type SelfManageResources struct { - // Self-managed resources target destination. + // Self-managed resources target destination. // // This member is required. TargetDestination []SelfManageTargetDestination @@ -811,47 +818,47 @@ type SelfManageResources struct { // Detailed information about a server. type ServerDetail struct { - // The S3 bucket name and Amazon S3 key name for anti-pattern report. + // The S3 bucket name and Amazon S3 key name for anti-pattern report. AntipatternReportS3Object *S3Object - // The status of the anti-pattern report generation. + // The status of the anti-pattern report generation. AntipatternReportStatus AntipatternReportStatus - // A message about the status of the anti-pattern report generation. + // A message about the status of the anti-pattern report generation. AntipatternReportStatusMessage *string - // A list of strategy summaries. + // A list of strategy summaries. ApplicationComponentStrategySummary []StrategySummary - // The status of assessment for the server. + // The status of assessment for the server. DataCollectionStatus RunTimeAssessmentStatus - // The server ID. + // The server ID. Id *string - // The timestamp of when the server was assessed. + // The timestamp of when the server was assessed. LastAnalyzedTimestamp *time.Time - // A list of anti-pattern severity summaries. + // A list of anti-pattern severity summaries. ListAntipatternSeveritySummary []AntipatternSeveritySummary - // The name of the server. + // The name of the server. Name *string - // A set of recommendations. + // A set of recommendations. RecommendationSet *RecommendationSet // The error in server analysis. ServerError *ServerError - // The type of server. + // The type of server. ServerType *string - // A message about the status of data collection, which contains detailed + // A message about the status of data collection, which contains detailed // descriptions of any error messages. StatusMessage *string - // System information about the server. + // System information about the server. SystemInfo *SystemInfo noSmithyDocumentSerde @@ -882,88 +889,92 @@ type ServerStatusSummary struct { // Contains information about a strategy recommendation for a server. type ServerStrategy struct { - // Set to true if the recommendation is set as preferred. + // Set to true if the recommendation is set as preferred. IsPreferred *bool - // The number of application components with this strategy recommendation running + // The number of application components with this strategy recommendation running // on the server. NumberOfApplicationComponents *int32 - // Strategy recommendation for the server. + // Strategy recommendation for the server. Recommendation *RecommendationSet - // The recommendation status of the strategy for the server. + // The recommendation status of the strategy for the server. Status StrategyRecommendation noSmithyDocumentSerde } -// Object containing details about the servers imported by Application Discovery +// Object containing details about the servers imported by Application Discovery +// // Service type ServerSummary struct { - // Number of servers. + // Number of servers. Count *int32 - // Type of operating system for the servers. + // Type of operating system for the servers. ServerOsType ServerOsType noSmithyDocumentSerde } -// Object containing source code information that is linked to an application +// Object containing source code information that is linked to an application +// // component. type SourceCode struct { - // The repository name for the source code. + // The repository name for the source code. Location *string // The name of the project. ProjectName *string - // The branch of the source code. + // The branch of the source code. SourceVersion *string - // The type of repository to use for the source code. + // The type of repository to use for the source code. VersionControl VersionControl noSmithyDocumentSerde } -// Object containing source code information that is linked to an application +// Object containing source code information that is linked to an application +// // component. type SourceCodeRepository struct { - // The branch of the source code. + // The branch of the source code. Branch *string // The name of the project. ProjectName *string - // The repository name for the source code. + // The repository name for the source code. Repository *string - // The type of repository to use for the source code. + // The type of repository to use for the source code. VersionControlType *string noSmithyDocumentSerde } -// Information about all the available strategy options for migrating and +// Information about all the available strategy options for migrating and +// // modernizing an application component. type StrategyOption struct { - // Indicates if a specific strategy is preferred for the application component. + // Indicates if a specific strategy is preferred for the application component. IsPreferred *bool - // Type of transformation. For example, Rehost, Replatform, and so on. + // Type of transformation. For example, Rehost, Replatform, and so on. Strategy Strategy - // Destination information about where the application component can migrate to. + // Destination information about where the application component can migrate to. // For example, EC2 , ECS , and so on. TargetDestination TargetDestination - // The name of the tool that can be used to transform an application component + // The name of the tool that can be used to transform an application component // using this strategy. ToolName TransformationToolName @@ -973,10 +984,10 @@ type StrategyOption struct { // Object containing the summary of the strategy recommendations. type StrategySummary struct { - // The count of recommendations per strategy. + // The count of recommendations per strategy. Count *int32 - // The name of recommended strategy. + // The name of recommended strategy. Strategy Strategy noSmithyDocumentSerde @@ -985,32 +996,33 @@ type StrategySummary struct { // Information about the server that hosts application components. type SystemInfo struct { - // CPU architecture type for the server. + // CPU architecture type for the server. CpuArchitecture *string - // File system type for the server. + // File system type for the server. FileSystemType *string - // Networking information related to a server. + // Networking information related to a server. NetworkInfoList []NetworkInfo - // Operating system corresponding to a server. + // Operating system corresponding to a server. OsInfo *OSInfo noSmithyDocumentSerde } -// Information of the transformation tool that can be used to migrate and +// Information of the transformation tool that can be used to migrate and +// // modernize the application. type TransformationTool struct { - // Description of the tool. + // Description of the tool. Description *string - // Name of the tool. + // Name of the tool. Name TransformationToolName - // URL for installing the tool. + // URL for installing the tool. TranformationToolInstallationLink *string noSmithyDocumentSerde diff --git a/service/mobile/api_op_CreateProject.go b/service/mobile/api_op_CreateProject.go index f007a475a0e..3f8b721ad37 100644 --- a/service/mobile/api_op_CreateProject.go +++ b/service/mobile/api_op_CreateProject.go @@ -30,18 +30,18 @@ func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, // Request structure used to request a project be created. type CreateProjectInput struct { - // ZIP or YAML file which contains configuration settings to be used when creating - // the project. This may be the contents of the file downloaded from the URL - // provided in an export project operation. + // ZIP or YAML file which contains configuration settings to be used when + // creating the project. This may be the contents of the file downloaded from the + // URL provided in an export project operation. Contents []byte - // Name of the project. + // Name of the project. Name *string - // Default region where project resources should be created. + // Default region where project resources should be created. Region *string - // Unique identifier for an exported snapshot of project configuration. This + // Unique identifier for an exported snapshot of project configuration. This // snapshot identifier is included in the share URL when a project is exported. SnapshotId *string @@ -51,7 +51,7 @@ type CreateProjectInput struct { // Result structure used in response to a request to create a project. type CreateProjectOutput struct { - // Detailed information about the created AWS Mobile Hub project. + // Detailed information about the created AWS Mobile Hub project. Details *types.ProjectDetails // Metadata pertaining to the operation's result. diff --git a/service/mobile/api_op_DeleteProject.go b/service/mobile/api_op_DeleteProject.go index e268c376ee3..8f5ffd2021b 100644 --- a/service/mobile/api_op_DeleteProject.go +++ b/service/mobile/api_op_DeleteProject.go @@ -30,7 +30,7 @@ func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, // Request structure used to request a project be deleted. type DeleteProjectInput struct { - // Unique project identifier. + // Unique project identifier. // // This member is required. ProjectId *string @@ -41,11 +41,11 @@ type DeleteProjectInput struct { // Result structure used in response to request to delete a project. type DeleteProjectOutput struct { - // Resources which were deleted. + // Resources which were deleted. DeletedResources []types.Resource - // Resources which were not deleted, due to a risk of losing potentially important - // data or files. + // Resources which were not deleted, due to a risk of losing potentially + // important data or files. OrphanedResources []types.Resource // Metadata pertaining to the operation's result. diff --git a/service/mobile/api_op_DescribeBundle.go b/service/mobile/api_op_DescribeBundle.go index 6aaa664ca8d..d6f3bde9c2b 100644 --- a/service/mobile/api_op_DescribeBundle.go +++ b/service/mobile/api_op_DescribeBundle.go @@ -30,7 +30,7 @@ func (c *Client) DescribeBundle(ctx context.Context, params *DescribeBundleInput // Request structure to request the details of a specific bundle. type DescribeBundleInput struct { - // Unique bundle identifier. + // Unique bundle identifier. // // This member is required. BundleId *string @@ -41,7 +41,7 @@ type DescribeBundleInput struct { // Result structure contains the details of the bundle. type DescribeBundleOutput struct { - // The details of the bundle. + // The details of the bundle. Details *types.BundleDetails // Metadata pertaining to the operation's result. diff --git a/service/mobile/api_op_DescribeProject.go b/service/mobile/api_op_DescribeProject.go index 8832648401b..55f5861ff11 100644 --- a/service/mobile/api_op_DescribeProject.go +++ b/service/mobile/api_op_DescribeProject.go @@ -30,12 +30,12 @@ func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInp // Request structure used to request details about a project. type DescribeProjectInput struct { - // Unique project identifier. + // Unique project identifier. // // This member is required. ProjectId *string - // If set to true, causes AWS Mobile Hub to synchronize information from other + // If set to true, causes AWS Mobile Hub to synchronize information from other // services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub // project. SyncFromResources bool @@ -46,7 +46,7 @@ type DescribeProjectInput struct { // Result structure used for requests of project details. type DescribeProjectOutput struct { - // Detailed information about an AWS Mobile Hub project. + // Detailed information about an AWS Mobile Hub project. Details *types.ProjectDetails // Metadata pertaining to the operation's result. diff --git a/service/mobile/api_op_ExportBundle.go b/service/mobile/api_op_ExportBundle.go index 440adf3dee6..a94bddd584c 100644 --- a/service/mobile/api_op_ExportBundle.go +++ b/service/mobile/api_op_ExportBundle.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Generates customized software development kit (SDK) and or tool packages used +// 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 { @@ -28,31 +29,33 @@ func (c *Client) ExportBundle(ctx context.Context, params *ExportBundleInput, op return out, nil } -// Request structure used to request generation of custom SDK and tool packages +// Request structure used to request generation of custom SDK and tool packages +// // required to integrate mobile web or app clients with backed AWS resources. type ExportBundleInput struct { - // Unique bundle identifier. + // Unique bundle identifier. // // This member is required. BundleId *string - // Developer desktop or target application platform. + // Developer desktop or target application platform. Platform types.Platform - // Unique project identifier. + // Unique project identifier. ProjectId *string noSmithyDocumentSerde } -// Result structure which contains link to download custom-generated SDK and tool +// Result structure which contains link to download custom-generated SDK and tool +// // packages used to integrate mobile web or app clients with backed AWS resources. type ExportBundleOutput struct { - // URL which contains the custom-generated SDK and tool packages used to integrate - // the client mobile app or web app with the AWS resources created by the AWS - // Mobile Hub project. + // URL which contains the custom-generated SDK and tool packages used to + // integrate the client mobile app or web app with the AWS resources created by the + // AWS Mobile Hub project. DownloadUrl *string // Metadata pertaining to the operation's result. diff --git a/service/mobile/api_op_ExportProject.go b/service/mobile/api_op_ExportProject.go index 22bdafee8d0..6d16814ae5d 100644 --- a/service/mobile/api_op_ExportProject.go +++ b/service/mobile/api_op_ExportProject.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports project configuration to a snapshot which can be downloaded and shared. -// Note that mobile app push credentials are encrypted in exported projects, so -// they can only be shared successfully within the same AWS account. +// Exports project configuration to a snapshot which can be downloaded and +// +// shared. Note that mobile app push credentials are encrypted in exported +// projects, so they can only be shared successfully within the same AWS account. func (c *Client) ExportProject(ctx context.Context, params *ExportProjectInput, optFns ...func(*Options)) (*ExportProjectOutput, error) { if params == nil { params = &ExportProjectInput{} @@ -31,7 +32,7 @@ func (c *Client) ExportProject(ctx context.Context, params *ExportProjectInput, // Request structure used in requests to export project configuration details. type ExportProjectInput struct { - // Unique project identifier. + // Unique project identifier. // // This member is required. ProjectId *string @@ -42,18 +43,18 @@ type ExportProjectInput struct { // Result structure used for requests to export project configuration details. type ExportProjectOutput struct { - // URL which can be used to download the exported project configuation file(s). + // URL which can be used to download the exported project configuation file(s). DownloadUrl *string - // URL which can be shared to allow other AWS users to create their own project in - // AWS Mobile Hub with the same configuration as the specified project. This URL + // URL which can be shared to allow other AWS users to create their own project + // in AWS Mobile Hub with the same configuration as the specified project. This URL // pertains to a snapshot in time of the project configuration that is created when // this API is called. If you want to share additional changes to your project // configuration, then you will need to create and share a new snapshot by calling // this method again. ShareUrl *string - // Unique identifier for the exported snapshot of the project configuration. This + // Unique identifier for the exported snapshot of the project configuration. This // snapshot identifier is included in the share URL. SnapshotId *string diff --git a/service/mobile/api_op_ListBundles.go b/service/mobile/api_op_ListBundles.go index 807e5fce0bb..35b4484a461 100644 --- a/service/mobile/api_op_ListBundles.go +++ b/service/mobile/api_op_ListBundles.go @@ -30,10 +30,10 @@ func (c *Client) ListBundles(ctx context.Context, params *ListBundlesInput, optF // Request structure to request all available bundles. type ListBundlesInput struct { - // Maximum number of records to list in a single response. + // Maximum number of records to list in a single response. MaxResults int32 - // Pagination token. Set to null to start listing bundles from start. If non-null + // Pagination token. Set to null to start listing bundles from start. If non-null // pagination token is returned in a result, then pass its value in here in another // request to list more bundles. NextToken *string @@ -44,10 +44,10 @@ type ListBundlesInput struct { // Result structure contains a list of all available bundles with details. type ListBundlesOutput struct { - // A list of bundles. + // A list of bundles. BundleList []types.BundleDetails - // Pagination token. If non-null pagination token is returned in a result, then + // Pagination token. If non-null pagination token is returned in a result, then // pass its value in another request to fetch more entries. NextToken *string @@ -142,7 +142,7 @@ var _ ListBundlesAPIClient = (*Client)(nil) // ListBundlesPaginatorOptions is the paginator options for ListBundles type ListBundlesPaginatorOptions struct { - // Maximum number of records to list in a single response. + // Maximum number of records to list in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mobile/api_op_ListProjects.go b/service/mobile/api_op_ListProjects.go index c432ada86b8..0a773eb15fd 100644 --- a/service/mobile/api_op_ListProjects.go +++ b/service/mobile/api_op_ListProjects.go @@ -30,12 +30,12 @@ func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, op // Request structure used to request projects list in AWS Mobile Hub. type ListProjectsInput struct { - // Maximum number of records to list in a single response. + // Maximum number of records to list in a single response. MaxResults int32 - // Pagination token. Set to null to start listing projects from start. If non-null - // pagination token is returned in a result, then pass its value in here in another - // request to list more projects. + // Pagination token. Set to null to start listing projects from start. If + // non-null pagination token is returned in a result, then pass its value in here + // in another request to list more projects. NextToken *string noSmithyDocumentSerde @@ -44,12 +44,12 @@ type ListProjectsInput struct { // Result structure used for requests to list projects in AWS Mobile Hub. type ListProjectsOutput struct { - // Pagination token. Set to null to start listing records from start. If non-null + // Pagination token. Set to null to start listing records from start. If non-null // pagination token is returned in a result, then pass its value in here in another // request to list more entries. NextToken *string - // List of projects. + // List of projects. Projects []types.ProjectSummary // Metadata pertaining to the operation's result. @@ -143,7 +143,7 @@ var _ ListProjectsAPIClient = (*Client)(nil) // ListProjectsPaginatorOptions is the paginator options for ListProjects type ListProjectsPaginatorOptions struct { - // Maximum number of records to list in a single response. + // Maximum number of records to list in a single response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mobile/api_op_UpdateProject.go b/service/mobile/api_op_UpdateProject.go index ea9792eeb9b..7fc7256edc3 100644 --- a/service/mobile/api_op_UpdateProject.go +++ b/service/mobile/api_op_UpdateProject.go @@ -30,12 +30,12 @@ func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, // Request structure used for requests to update project configuration. type UpdateProjectInput struct { - // Unique project identifier. + // Unique project identifier. // // This member is required. ProjectId *string - // ZIP or YAML file which contains project configuration to be updated. This + // 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 @@ -46,7 +46,7 @@ type UpdateProjectInput struct { // Result structure used for requests to updated project configuration. type UpdateProjectOutput struct { - // Detailed information about the updated AWS Mobile Hub project. + // Detailed information about the updated AWS Mobile Hub project. Details *types.ProjectDetails // Metadata pertaining to the operation's result. diff --git a/service/mobile/doc.go b/service/mobile/doc.go index e1655d61318..24c4e59de32 100644 --- a/service/mobile/doc.go +++ b/service/mobile/doc.go @@ -3,8 +3,9 @@ // Package mobile provides the API client, operations, and parameter types for AWS // Mobile. // -// AWS Mobile Service provides mobile app and website developers with capabilities -// required to configure AWS resources and bootstrap their developer desktop -// projects with the necessary SDKs, constants, tools and samples to make use of -// those resources. +// AWS Mobile Service provides mobile app and website developers with +// +// capabilities required to configure AWS resources and bootstrap their developer +// desktop projects with the necessary SDKs, constants, tools and samples to make +// use of those resources. package mobile diff --git a/service/mobile/options.go b/service/mobile/options.go index 6d00135e699..b2f766d238a 100644 --- a/service/mobile/options.go +++ b/service/mobile/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mobile/types/enums.go b/service/mobile/types/enums.go index d5cd56954fe..34eec3bca1c 100644 --- a/service/mobile/types/enums.go +++ b/service/mobile/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for Platform. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Platform) Values() []Platform { return []Platform{ "OSX", @@ -40,8 +41,9 @@ const ( ) // 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. +// expanded in the future, and so 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 c6817354256..6130f706cc5 100644 --- a/service/mobile/types/errors.go +++ b/service/mobile/types/errors.go @@ -33,7 +33,8 @@ func (e *AccountActionRequiredException) ErrorCode() string { } func (e *AccountActionRequiredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request cannot be processed because some parameter is not valid or the +// The request cannot be processed because some parameter is not valid or the +// // project state prevents the operation from being performed. type BadRequestException struct { Message *string @@ -60,7 +61,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 +// The service has encountered an unexpected error condition which prevents it +// // from servicing the request. type InternalFailureException struct { Message *string @@ -87,7 +89,8 @@ func (e *InternalFailureException) ErrorCode() string { } func (e *InternalFailureException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// There are too many AWS Mobile Hub projects in the account or the account has +// There are too many AWS Mobile Hub projects in the account or the account has +// // exceeded the maximum number of resources in some AWS service. You should create // another sub-account using AWS Organizations or remove some resources and retry // your request. @@ -144,7 +147,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 +// The service is temporarily unavailable. The request should be retried after +// // some time delay. type ServiceUnavailableException struct { Message *string @@ -173,7 +177,8 @@ func (e *ServiceUnavailableException) ErrorCode() string { } func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// Too many requests have been received for this AWS account in too short a time. +// Too many requests have been received for this AWS account in too short a time. +// // The request should be retried after some time delay. type TooManyRequestsException struct { Message *string diff --git a/service/mobile/types/types.go b/service/mobile/types/types.go index 3b7e10fce3d..fc7974f05b2 100644 --- a/service/mobile/types/types.go +++ b/service/mobile/types/types.go @@ -10,22 +10,22 @@ import ( // The details of the bundle. type BundleDetails struct { - // Developer desktop or mobile app or website platforms. + // Developer desktop or mobile app or website platforms. AvailablePlatforms []Platform - // Unique bundle identifier. + // Unique bundle identifier. BundleId *string - // Description of the download bundle. + // Description of the download bundle. Description *string - // Icon for the download bundle. + // Icon for the download bundle. IconUrl *string - // Title of the download bundle. + // Title of the download bundle. Title *string - // Version of the download bundle. + // Version of the download bundle. Version *string noSmithyDocumentSerde @@ -34,28 +34,28 @@ type BundleDetails struct { // Detailed information about an AWS Mobile Hub project. type ProjectDetails struct { - // Website URL for this project in the AWS Mobile Hub console. + // Website URL for this project in the AWS Mobile Hub console. ConsoleUrl *string - // Date the project was created. + // Date the project was created. CreatedDate *time.Time - // Date of the last modification of the project. + // Date of the last modification of the project. LastUpdatedDate *time.Time - // Name of the project. + // Name of the project. Name *string - // Unique project identifier. + // Unique project identifier. ProjectId *string - // Default region to use for AWS resource creation in the AWS Mobile Hub project. + // Default region to use for AWS resource creation in the AWS Mobile Hub project. Region *string - // List of AWS resources associated with a project. + // List of AWS resources associated with a project. Resources []Resource - // Synchronization state for a project. + // Synchronization state for a project. State ProjectState noSmithyDocumentSerde @@ -64,10 +64,10 @@ type ProjectDetails struct { // Summary information about an AWS Mobile Hub project. type ProjectSummary struct { - // Name of the project. + // Name of the project. Name *string - // Unique project identifier. + // Unique project identifier. ProjectId *string noSmithyDocumentSerde @@ -76,20 +76,22 @@ type ProjectSummary struct { // Information about an instance of an AWS resource associated with a project. type Resource struct { - // AWS resource name which uniquely identifies the resource in AWS systems. + // AWS resource name which uniquely identifies the resource in AWS systems. Arn *string - // Key-value attribute pairs. + // Key-value attribute pairs. Attributes map[string]string - // Identifies which feature in AWS Mobile Hub is associated with this AWS resource. + // Identifies which feature in AWS Mobile Hub is associated with this AWS + // resource. Feature *string - // Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the - // bucket). + // Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of + // the bucket). Name *string - // Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket). + // Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 + // bucket). Type *string noSmithyDocumentSerde diff --git a/service/mq/api_op_CreateBroker.go b/service/mq/api_op_CreateBroker.go index 0dc52b058ba..b151fb2b665 100644 --- a/service/mq/api_op_CreateBroker.go +++ b/service/mq/api_op_CreateBroker.go @@ -11,28 +11,45 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 // -// For more information, see Create an IAM User and Get Your Amazon Web Services -// 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. +// For more information, see [Create an IAM User and Get Your Amazon Web Services Credentials] and [Never Modify or Delete the Amazon MQ Elastic Network Interface] in the Amazon MQ Developer Guide. +// +// [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 +// [Create an IAM User and Get Your Amazon Web Services Credentials]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user func (c *Client) CreateBroker(ctx context.Context, params *CreateBrokerInput, optFns ...func(*Options)) (*CreateBrokerOutput, error) { if params == nil { params = &CreateBrokerInput{} @@ -62,11 +79,12 @@ type CreateBrokerInput struct { // Required. The broker's name. This value must be unique in your Amazon Web // Services 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. Do not add personally identifiable - // information (PII) or other confidential or sensitive information in broker - // names. Broker names are accessible to other Amazon Web Services services, - // including CloudWatch Logs. Broker names are not intended to be used for private - // or sensitive data. + // characters, or special characters. + // + // Do not add personally identifiable information (PII) or other confidential or + // sensitive information in broker names. Broker names are accessible to other + // Amazon Web Services services, including CloudWatch Logs. Broker names are not + // intended to be used for private or sensitive data. // // This member is required. BrokerName *string @@ -83,8 +101,9 @@ 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]. + // + // [Supported engines]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html // // This member is required. EngineVersion *string @@ -117,9 +136,11 @@ type CreateBrokerInput struct { Configuration *types.ConfigurationId // The unique ID that the requester receives for the created broker. Amazon MQ - // passes your ID with the API action. We recommend using a Universally Unique - // Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if - // your application doesn't require idempotency. + // passes your ID with the API action. + // + // We recommend using a Universally Unique Identifier (UUID) for the + // creatorRequestId. You may omit the creatorRequestId if your application doesn't + // require idempotency. CreatorRequestId *string // Defines whether this broker is a part of a data replication pair. @@ -158,12 +179,14 @@ type CreateBrokerInput struct { // example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ // 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 Amazon Web Services account. Amazon MQ will not be able to - // create VPC endpoints in VPCs that are not owned by your Amazon Web Services - // account. + // Deployment without public accessibility requires at least one subnet. + // + // If you specify subnets in a [shared VPC] for a RabbitMQ broker, the associated VPC to which + // the specified subnets belong must be owned by your Amazon Web Services account. + // Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by + // your Amazon Web Services account. + // + // [shared VPC]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html 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 2262cf6fcc1..ef32f744a64 100644 --- a/service/mq/api_op_CreateConfiguration.go +++ b/service/mq/api_op_CreateConfiguration.go @@ -40,8 +40,9 @@ 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]. + // + // [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_CreateUser.go b/service/mq/api_op_CreateUser.go index b861e52f0b1..4033cfb9c28 100644 --- a/service/mq/api_op_CreateUser.go +++ b/service/mq/api_op_CreateUser.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an ActiveMQ user. Do not add personally identifiable information (PII) -// or other confidential or sensitive information in broker usernames. Broker -// usernames are accessible to other Amazon Web Services services, including -// CloudWatch Logs. Broker usernames are not intended to be used for private or -// sensitive data. +// Creates an ActiveMQ user. +// +// Do not add personally identifiable information (PII) or other confidential or +// sensitive information in broker usernames. Broker usernames are accessible to +// other Amazon Web Services services, including CloudWatch Logs. Broker usernames +// are not intended to be used for private or sensitive data. func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} diff --git a/service/mq/api_op_DescribeBroker.go b/service/mq/api_op_DescribeBroker.go index 95c18091935..32f1498a5df 100644 --- a/service/mq/api_op_DescribeBroker.go +++ b/service/mq/api_op_DescribeBroker.go @@ -91,9 +91,9 @@ type DescribeBrokerOutput struct { // The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ. 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) - // . + // The broker engine's version. For a list of supported engine versions, see [Supported engines]. + // + // [Supported engines]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html EngineVersion *string // The broker's instance type. @@ -123,13 +123,15 @@ type DescribeBrokerOutput struct { PendingDataReplicationMode types.DataReplicationMode // 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]. + // + // [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]. + // + // [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 diff --git a/service/mq/api_op_DescribeConfiguration.go b/service/mq/api_op_DescribeConfiguration.go index ff34fbcc3eb..2e7c8e23d27 100644 --- a/service/mq/api_op_DescribeConfiguration.go +++ b/service/mq/api_op_DescribeConfiguration.go @@ -58,8 +58,9 @@ 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]. + // + // [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_UpdateBroker.go b/service/mq/api_op_UpdateBroker.go index 971c793e42e..7458bf28b23 100644 --- a/service/mq/api_op_UpdateBroker.go +++ b/service/mq/api_op_UpdateBroker.go @@ -50,14 +50,15 @@ type UpdateBrokerInput struct { // Defines whether this broker is a part of a data replication pair. DataReplicationMode types.DataReplicationMode - // 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) - // . + // The broker engine version. For a list of supported engine versions, see [Supported engines]. + // + // [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]. + // + // [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 @@ -102,13 +103,15 @@ type UpdateBrokerOutput struct { DataReplicationMode types.DataReplicationMode // 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]. + // + // [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]. + // + // [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/options.go b/service/mq/options.go index 8f7eb0483e4..fe5626712fc 100644 --- a/service/mq/options.go +++ b/service/mq/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mq/types/enums.go b/service/mq/types/enums.go index 0700dcfa59c..67b54d896ee 100644 --- a/service/mq/types/enums.go +++ b/service/mq/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AuthenticationStrategy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationStrategy) Values() []AuthenticationStrategy { return []AuthenticationStrategy{ "SIMPLE", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for BrokerState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BrokerState) Values() []BrokerState { return []BrokerState{ "CREATION_IN_PROGRESS", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for BrokerStorageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BrokerStorageType) Values() []BrokerStorageType { return []BrokerStorageType{ "EBS", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "CREATE", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for DataReplicationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplicationMode) Values() []DataReplicationMode { return []DataReplicationMode{ "NONE", @@ -118,8 +123,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -142,8 +148,9 @@ const ( ) // Values returns all known values for DeploymentMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentMode) Values() []DeploymentMode { return []DeploymentMode{ "SINGLE_INSTANCE", @@ -161,8 +168,9 @@ const ( ) // Values returns all known values for EngineType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EngineType) Values() []EngineType { return []EngineType{ "ACTIVEMQ", @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for PromoteMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PromoteMode) Values() []PromoteMode { return []PromoteMode{ "SWITCHOVER", @@ -199,6 +208,7 @@ const ( // Values returns all known values for SanitizationWarningReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SanitizationWarningReason) Values() []SanitizationWarningReason { return []SanitizationWarningReason{ diff --git a/service/mq/types/types.go b/service/mq/types/types.go index 1d43325d879..7b89093cc77 100644 --- a/service/mq/types/types.go +++ b/service/mq/types/types.go @@ -149,8 +149,9 @@ 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]. + // + // [Supported engines]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html // // This member is required. EngineVersion *string @@ -286,7 +287,9 @@ type EngineVersion struct { } // Optional. The metadata of the LDAP server used to authenticate and authorize -// connections to the broker. Does not apply to RabbitMQ brokers. +// connections to the broker. +// +// Does not apply to RabbitMQ brokers. type LdapServerMetadataInput struct { // Specifies the location of the LDAP server such as Directory Service for @@ -525,13 +528,16 @@ type User struct { // The username of the broker user. The following restrictions apply to broker // usernames: + // // - For Amazon MQ for ActiveMQ brokers, this value can contain only // alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). // This value must be 2-100 characters long. + // // - para>For Amazon MQ for RabbitMQ brokers, this value can contain only // alphanumeric characters, dashes, periods, underscores (- . _). This value must // not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid // usename. This value must be 2-100 characters long. + // // Do not add personally identifiable information (PII) or other confidential or // sensitive information in broker usernames. Broker usernames are accessible to // other Amazon Web Services services, including CloudWatch Logs. Broker usernames diff --git a/service/mturk/api_op_AcceptQualificationRequest.go b/service/mturk/api_op_AcceptQualificationRequest.go index 2c448de51e1..315734d647e 100644 --- a/service/mturk/api_op_AcceptQualificationRequest.go +++ b/service/mturk/api_op_AcceptQualificationRequest.go @@ -10,10 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The AcceptQualificationRequest operation approves a Worker's request for a -// Qualification. Only the owner of the Qualification type can grant a -// Qualification request for that type. A successful request for the -// AcceptQualificationRequest operation returns with no errors and an empty body. +// The AcceptQualificationRequest operation approves a Worker's request for a +// +// Qualification. +// +// Only the owner of the Qualification type can grant a Qualification request for +// that type. +// +// A successful request for the AcceptQualificationRequest operation returns with +// no errors and an empty body. func (c *Client) AcceptQualificationRequest(ctx context.Context, params *AcceptQualificationRequestInput, optFns ...func(*Options)) (*AcceptQualificationRequestOutput, error) { if params == nil { params = &AcceptQualificationRequestInput{} @@ -37,7 +42,7 @@ type AcceptQualificationRequestInput struct { // This member is required. QualificationRequestId *string - // The value of the Qualification. You can omit this value if you are using the + // The value of the Qualification. You can omit this value if you are using the // presence or absence of the Qualification as the basis for a HIT requirement. IntegerValue *int32 diff --git a/service/mturk/api_op_ApproveAssignment.go b/service/mturk/api_op_ApproveAssignment.go index e8fcdb32cb4..ef3d44bc3e7 100644 --- a/service/mturk/api_op_ApproveAssignment.go +++ b/service/mturk/api_op_ApproveAssignment.go @@ -10,21 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ApproveAssignment operation approves the results of a completed assignment. +// 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. // // 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. +// 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{} @@ -42,18 +48,18 @@ 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 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 + // A flag indicating that an assignment should be approved even if it was // previously rejected. Defaults to False . OverrideRejection *bool - // A message for the Worker, which the Worker can see in the Status section of the - // web site. + // A message for the Worker, which the Worker can see in the Status section of + // the web site. RequesterFeedback *string noSmithyDocumentSerde diff --git a/service/mturk/api_op_AssociateQualificationWithWorker.go b/service/mturk/api_op_AssociateQualificationWithWorker.go index a146ab834cd..13ac5294c5d 100644 --- a/service/mturk/api_op_AssociateQualificationWithWorker.go +++ b/service/mturk/api_op_AssociateQualificationWithWorker.go @@ -10,17 +10,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The AssociateQualificationWithWorker operation gives a Worker a Qualification. +// The AssociateQualificationWithWorker operation gives a Worker a Qualification. +// // AssociateQualificationWithWorker does not require that the Worker submit a -// Qualification request. It gives the Qualification directly to the Worker. You -// can only assign a Qualification of a Qualification type that you created (using -// the CreateQualificationType operation). Note: AssociateQualificationWithWorker -// does not affect any pending Qualification requests for the Qualification by the -// Worker. If you assign a Qualification to a Worker, then later grant a -// Qualification request made by the Worker, the granting of the request may modify -// the Qualification score. To resolve a pending Qualification request without -// affecting the Qualification the Worker already has, reject the request with the -// RejectQualificationRequest operation. +// Qualification request. It gives the Qualification directly to the Worker. +// +// You can only assign a Qualification of a Qualification type that you created +// (using the CreateQualificationType operation). +// +// Note: AssociateQualificationWithWorker does not affect any pending +// Qualification requests for the Qualification by the Worker. If you assign a +// Qualification to a Worker, then later grant a Qualification request made by the +// Worker, the granting of the request may modify the Qualification score. To +// resolve a pending Qualification request without affecting the Qualification the +// Worker already has, reject the request with the RejectQualificationRequest +// operation. func (c *Client) AssociateQualificationWithWorker(ctx context.Context, params *AssociateQualificationWithWorkerInput, optFns ...func(*Options)) (*AssociateQualificationWithWorkerOutput, error) { if params == nil { params = &AssociateQualificationWithWorkerInput{} @@ -43,7 +47,7 @@ type AssociateQualificationWithWorkerInput struct { // This member is required. QualificationTypeId *string - // The ID of the Worker to whom the Qualification is being assigned. Worker IDs + // 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. @@ -52,7 +56,7 @@ type AssociateQualificationWithWorkerInput struct { // The value of the Qualification to assign. IntegerValue *int32 - // Specifies whether to send a notification email message to the Worker saying + // 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 diff --git a/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go b/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go index 15144f7cd92..c4f4e8ab10f 100644 --- a/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go +++ b/service/mturk/api_op_CreateAdditionalAssignmentsForHIT.go @@ -10,14 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. @@ -48,7 +53,7 @@ type CreateAdditionalAssignmentsForHITInput struct { // This member is required. NumberOfAdditionalAssignments *int32 - // A unique identifier for this request, which allows you to retry the call on + // A unique identifier for this request, which allows you to retry the call on // 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 diff --git a/service/mturk/api_op_CreateHIT.go b/service/mturk/api_op_CreateHIT.go index 6a0216802b9..c337288ca67 100644 --- a/service/mturk/api_op_CreateHIT.go +++ b/service/mturk/api_op_CreateHIT.go @@ -13,20 +13,28 @@ import ( // 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) . +// 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]. +// +// [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{} @@ -44,7 +52,7 @@ func (c *Client) CreateHIT(ctx context.Context, params *CreateHITInput, optFns . type CreateHITInput struct { - // The amount of time, in seconds, that a Worker has to complete the HIT after + // The amount of time, in seconds, that a Worker has to complete the HIT after // accepting it. If a Worker does not complete the assignment within the specified // duration, the assignment is considered abandoned. If the HIT is still active // (that is, its lifetime has not elapsed), the assignment becomes available for @@ -53,7 +61,7 @@ type CreateHITInput struct { // This member is required. AssignmentDurationInSeconds *int64 - // A general description of the HIT. A description includes detailed information + // A general description of the HIT. A description includes detailed information // about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, // the HIT description appears in the expanded view of search results, and in the // HIT and assignment screens. A good description gives the user enough information @@ -62,7 +70,7 @@ type CreateHITInput struct { // This member is required. Description *string - // An amount of time, in seconds, after which the HIT is no longer available for + // An amount of time, in seconds, after which the HIT is no longer available for // users to accept. After the lifetime of the HIT elapses, the HIT no longer // appears in HIT searches, even if not all of the assignments for the HIT have // been accepted. @@ -70,80 +78,88 @@ type CreateHITInput struct { // This member is required. LifetimeInSeconds *int64 - // The amount of money the Requester will pay a Worker for successfully completing - // the HIT. + // The amount of money the Requester will pay a Worker for successfully + // completing the HIT. // // This member is required. Reward *string - // The title of the HIT. A title should be short and descriptive about the kind of - // task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title + // The title of the HIT. A title should be short and descriptive about the kind + // of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title // appears in search results, and everywhere the HIT is mentioned. // // This member is required. Title *string - // The Assignment-level Review Policy applies to the assignments under the HIT. + // 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 - // which the assignment is considered Approved automatically unless the Requester - // explicitly rejects it. + // The number of seconds after an assignment for the HIT has been submitted, + // after which the assignment is considered Approved automatically unless the + // Requester explicitly rejects it. AutoApprovalDelayInSeconds *int64 - // The HITLayoutId allows you to use a pre-existing HIT design with placeholder + // The HITLayoutId allows you to use a pre-existing HIT design with placeholder // values and create an additional HIT by providing those values as - // HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId - // parameter must be provided. + // HITLayoutParameters. + // + // Constraints: Either a Question parameter or a HITLayoutId parameter must be + // provided. HITLayoutId *string - // If the HITLayoutId is provided, any placeholder values must be filled in with + // If the HITLayoutId is provided, any placeholder values must be filled in with // values using the HITLayoutParameter structure. For more information, see // HITLayout. HITLayoutParameters []types.HITLayoutParameter - // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical + // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical // Turk to take various actions based on the policy. HITReviewPolicy *types.ReviewPolicy - // One or more words or phrases that describe the HIT, separated by commas. These + // One or more words or phrases that describe the HIT, separated by commas. These // words are used in searches to find HITs. Keywords *string - // The number of times the HIT can be accepted and completed before the HIT + // 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. - // A HIT can have between zero and ten Qualification requirements. All requirements - // must be met in order for a Worker to accept the HIT. Additionally, other actions - // can be restricted using the ActionsGuarded field on each + // Conditions that a Worker's Qualifications must meet in order to accept the + // HIT. A HIT can have between zero and ten Qualification requirements. All + // requirements must be met in order for a Worker to accept the HIT. Additionally, + // other actions can be restricted using the ActionsGuarded field on each // QualificationRequirement structure. QualificationRequirements []types.QualificationRequirement - // The data the person completing the HIT uses to produce the results. + // 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. + // 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 + // 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. + // 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 + // 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 // AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. + // // Note: It is your responsibility to ensure uniqueness of the token. The unique // token expires after 24 hours. Subsequent calls using the same UniqueRequestToken // made after the 24 hour limit could create duplicate HITs. @@ -154,7 +170,7 @@ type CreateHITInput struct { type CreateHITOutput struct { - // Contains the newly created HIT data. For a description of the HIT data + // 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 diff --git a/service/mturk/api_op_CreateHITType.go b/service/mturk/api_op_CreateHITType.go index 043a055d947..d9062caeba9 100644 --- a/service/mturk/api_op_CreateHITType.go +++ b/service/mturk/api_op_CreateHITType.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The CreateHITType operation creates a new HIT type. This operation allows 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. @@ -32,7 +33,7 @@ func (c *Client) CreateHITType(ctx context.Context, params *CreateHITTypeInput, type CreateHITTypeInput struct { - // The amount of time, in seconds, that a Worker has to complete the HIT after + // The amount of time, in seconds, that a Worker has to complete the HIT after // accepting it. If a Worker does not complete the assignment within the specified // duration, the assignment is considered abandoned. If the HIT is still active // (that is, its lifetime has not elapsed), the assignment becomes available for @@ -41,7 +42,7 @@ type CreateHITTypeInput struct { // This member is required. AssignmentDurationInSeconds *int64 - // A general description of the HIT. A description includes detailed information + // A general description of the HIT. A description includes detailed information // about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, // the HIT description appears in the expanded view of search results, and in the // HIT and assignment screens. A good description gives the user enough information @@ -50,32 +51,32 @@ type CreateHITTypeInput struct { // This member is required. Description *string - // The amount of money the Requester will pay a Worker for successfully completing - // the HIT. + // The amount of money the Requester will pay a Worker for successfully + // completing the HIT. // // This member is required. Reward *string - // The title of the HIT. A title should be short and descriptive about the kind of - // task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title + // The title of the HIT. A title should be short and descriptive about the kind + // of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title // appears in search results, and everywhere the HIT is mentioned. // // This member is required. Title *string - // The number of seconds after an assignment for the HIT has been submitted, after - // which the assignment is considered Approved automatically unless the Requester - // explicitly rejects it. + // The number of seconds after an assignment for the HIT has been submitted, + // after which the assignment is considered Approved automatically unless the + // Requester explicitly rejects it. AutoApprovalDelayInSeconds *int64 - // One or more words or phrases that describe the HIT, separated by commas. These + // One or more words or phrases that describe the HIT, separated by commas. These // words are used in searches to find HITs. Keywords *string - // Conditions that a Worker's Qualifications must meet in order to accept the HIT. - // A HIT can have between zero and ten Qualification requirements. All requirements - // must be met in order for a Worker to accept the HIT. Additionally, other actions - // can be restricted using the ActionsGuarded field on each + // Conditions that a Worker's Qualifications must meet in order to accept the + // HIT. A HIT can have between zero and ten Qualification requirements. All + // requirements must be met in order for a Worker to accept the HIT. Additionally, + // other actions can be restricted using the ActionsGuarded field on each // QualificationRequirement structure. QualificationRequirements []types.QualificationRequirement @@ -84,7 +85,7 @@ type CreateHITTypeInput struct { type CreateHITTypeOutput struct { - // The ID of the newly registered HIT type. + // The ID of the newly registered HIT type. HITTypeId *string // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_CreateHITWithHITType.go b/service/mturk/api_op_CreateHITWithHITType.go index 90d5c2c16a1..df7268415b5 100644 --- a/service/mturk/api_op_CreateHITWithHITType.go +++ b/service/mturk/api_op_CreateHITWithHITType.go @@ -11,16 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// recommended best practice for Requesters who are creating large numbers of HITs. +// 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 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) -// . +// fee. For more information, see [Amazon Mechanical Turk Pricing]. +// +// [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{} @@ -43,7 +49,7 @@ type CreateHITWithHITTypeInput struct { // This member is required. HITTypeId *string - // An amount of time, in seconds, after which the HIT is no longer available for + // An amount of time, in seconds, after which the HIT is no longer available for // users to accept. After the lifetime of the HIT elapses, the HIT no longer // appears in HIT searches, even if not all of the assignments for the HIT have // been accepted. @@ -51,51 +57,59 @@ type CreateHITWithHITTypeInput struct { // This member is required. LifetimeInSeconds *int64 - // The Assignment-level Review Policy applies to the assignments under the HIT. + // 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 + // The HITLayoutId allows you to use a pre-existing HIT design with placeholder // values and create an additional HIT by providing those values as - // HITLayoutParameters. Constraints: Either a Question parameter or a HITLayoutId - // parameter must be provided. + // HITLayoutParameters. + // + // Constraints: Either a Question parameter or a HITLayoutId parameter must be + // provided. HITLayoutId *string - // If the HITLayoutId is provided, any placeholder values must be filled in with + // If the HITLayoutId is provided, any placeholder values must be filled in with // values using the HITLayoutParameter structure. For more information, see // HITLayout. HITLayoutParameters []types.HITLayoutParameter - // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical + // The HIT-level Review Policy applies to the HIT. You can specify for Mechanical // 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 + // 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. + // 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. + // 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 + // 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. + // 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 + // 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 // AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId. + // // Note: It is your responsibility to ensure uniqueness of the token. The unique // token expires after 24 hours. Subsequent calls using the same UniqueRequestToken // made after the 24 hour limit could create duplicate HITs. @@ -106,7 +120,7 @@ type CreateHITWithHITTypeInput struct { type CreateHITWithHITTypeOutput struct { - // Contains the newly created HIT data. For a description of the HIT data + // 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 diff --git a/service/mturk/api_op_CreateQualificationType.go b/service/mturk/api_op_CreateQualificationType.go index 926d56773ba..2d45e3c2a80 100644 --- a/service/mturk/api_op_CreateQualificationType.go +++ b/service/mturk/api_op_CreateQualificationType.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The CreateQualificationType operation creates a new Qualification type, which +// 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 { @@ -37,28 +38,34 @@ type CreateQualificationTypeInput struct { // This member is required. Description *string - // The name you give to the Qualification type. The type name is used to represent - // the Qualification to Workers, and to find the type using a Qualification type - // search. It must be unique across all of your Qualification types. + // The name you give to the Qualification type. The type name is used to + // represent the Qualification to Workers, and to find the type using a + // Qualification type search. It must be unique across all of your Qualification + // types. // // This member is required. Name *string - // The initial status of the Qualification type. Constraints: Valid values are: - // Active | Inactive + // The initial status of the Qualification type. + // + // Constraints: Valid values are: Active | Inactive // // This member is required. QualificationTypeStatus types.QualificationTypeStatus // The answers to the Qualification test specified in the Test parameter, in the - // form of an AnswerKey data structure. Constraints: Must not be longer than 65535 - // bytes. Constraints: None. If not specified, you must process Qualification - // requests manually. + // form of an AnswerKey data structure. + // + // Constraints: Must not be longer than 65535 bytes. + // + // Constraints: None. If not specified, you must process Qualification requests + // manually. AnswerKey *string // Specifies whether requests for the Qualification type are granted immediately, - // without prompting the Worker with a Qualification test. Constraints: If the Test - // parameter is specified, this parameter cannot be true. + // without prompting the Worker with a Qualification test. + // + // Constraints: If the Test parameter is specified, this parameter cannot be true. AutoGranted *bool // The Qualification value to use for automatically granted Qualifications. This @@ -71,6 +78,7 @@ type CreateQualificationTypeInput struct { // The number of seconds that a Worker must wait after requesting a Qualification // of the Qualification type before the worker can retry the Qualification request. + // // Constraints: None. If not specified, retries are disabled and Workers can // request a Qualification of this type only once, even if the Worker has not been // granted the Qualification. It is not possible to disable retries for a @@ -79,12 +87,15 @@ type CreateQualificationTypeInput struct { // and then create a new Qualification type with retries disabled. RetryDelayInSeconds *int64 - // The questions for the Qualification test a Worker must answer correctly to + // The questions for the Qualification test a Worker must answer correctly to // obtain a Qualification of this type. If this parameter is specified, - // TestDurationInSeconds must also be specified. Constraints: Must not be longer - // than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot - // be specified if AutoGranted is true. Constraints: None. If not specified, the - // Worker may request the Qualification without answering any questions. + // TestDurationInSeconds must also be specified. + // + // Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data + // structure. This parameter cannot be specified if AutoGranted is true. + // + // Constraints: None. If not specified, the Worker may request the Qualification + // without answering any questions. Test *string // The number of seconds the Worker has to complete the Qualification test, diff --git a/service/mturk/api_op_DeleteHIT.go b/service/mturk/api_op_DeleteHIT.go index ee526504032..0018a0bd8c3 100644 --- a/service/mturk/api_op_DeleteHIT.go +++ b/service/mturk/api_op_DeleteHIT.go @@ -10,18 +10,24 @@ 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. +// 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) { diff --git a/service/mturk/api_op_DeleteQualificationType.go b/service/mturk/api_op_DeleteQualificationType.go index f384da6bb95..adfd4888fdb 100644 --- a/service/mturk/api_op_DeleteQualificationType.go +++ b/service/mturk/api_op_DeleteQualificationType.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DeleteQualificationType deletes a Qualification type and deletes any HIT -// types that are associated with the Qualification type. This operation does not -// revoke Qualifications already assigned to Workers because the Qualifications -// might be needed for active HITs. If there are any pending requests for the -// Qualification type, Amazon Mechanical Turk rejects those requests. After you -// delete a Qualification type, you can no longer use it to create HITs or HIT -// types. DeleteQualificationType must wait for all the HITs that use the deleted +// The DeleteQualificationType deletes a Qualification type and deletes any HIT +// +// types that are associated with the Qualification type. +// +// This operation does not revoke Qualifications already assigned to Workers +// because the Qualifications might be needed for active HITs. If there are any +// pending requests for the Qualification type, Amazon Mechanical Turk rejects +// those requests. After you delete a Qualification type, you can no longer use it +// to create HITs or HIT types. +// +// DeleteQualificationType must wait for all the HITs that use the deleted // Qualification type to be deleted before completing. It may take up to 48 hours // before DeleteQualificationType completes and the unique name of the // Qualification type is available for reuse with CreateQualificationType. diff --git a/service/mturk/api_op_DisassociateQualificationFromWorker.go b/service/mturk/api_op_DisassociateQualificationFromWorker.go index 4679837b500..73600a9800d 100644 --- a/service/mturk/api_op_DisassociateQualificationFromWorker.go +++ b/service/mturk/api_op_DisassociateQualificationFromWorker.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The DisassociateQualificationFromWorker revokes a previously granted -// Qualification from a user. You can provide a text message explaining why the -// Qualification was revoked. The user who had the Qualification can see this -// message. +// The DisassociateQualificationFromWorker revokes a previously granted +// +// Qualification from a user. +// +// You can provide a text message explaining why the Qualification was revoked. +// The user who had the Qualification can see this message. func (c *Client) DisassociateQualificationFromWorker(ctx context.Context, params *DisassociateQualificationFromWorkerInput, optFns ...func(*Options)) (*DisassociateQualificationFromWorkerOutput, error) { if params == nil { params = &DisassociateQualificationFromWorkerInput{} diff --git a/service/mturk/api_op_GetAssignment.go b/service/mturk/api_op_GetAssignment.go index 58f9403c26c..dc82e7df814 100644 --- a/service/mturk/api_op_GetAssignment.go +++ b/service/mturk/api_op_GetAssignment.go @@ -39,10 +39,10 @@ type GetAssignmentInput struct { type GetAssignmentOutput struct { - // The assignment. The response includes one Assignment element. + // The assignment. The response includes one Assignment element. Assignment *types.Assignment - // The HIT associated with this assignment. The response includes one HIT element. + // The HIT associated with this assignment. The response includes one HIT element. HIT *types.HIT // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_GetFileUploadURL.go b/service/mturk/api_op_GetFileUploadURL.go index 1c0e9772888..d04a76db5cb 100644 --- a/service/mturk/api_op_GetFileUploadURL.go +++ b/service/mturk/api_op_GetFileUploadURL.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The GetFileUploadURL operation generates and returns a temporary URL. You use +// The GetFileUploadURL operation generates and returns a temporary URL. You use +// // the temporary URL to retrieve a file uploaded by a Worker as an answer to a // FileUploadAnswer question for a HIT. The temporary URL is generated the instant // the GetFileUploadURL operation is called, and is valid for 60 seconds. You can // get a temporary file upload URL any time until the HIT is disposed. After the // 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 @@ -54,7 +56,7 @@ type GetFileUploadURLInput struct { type GetFileUploadURLOutput struct { - // A temporary URL for the file that the Worker uploaded for the answer. + // A temporary URL for the file that the Worker uploaded for the answer. FileUploadURL *string // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_GetHIT.go b/service/mturk/api_op_GetHIT.go index 00415d72747..41383fe5b64 100644 --- a/service/mturk/api_op_GetHIT.go +++ b/service/mturk/api_op_GetHIT.go @@ -39,7 +39,7 @@ type GetHITInput struct { type GetHITOutput struct { - // Contains the requested HIT data. + // Contains the requested HIT data. HIT *types.HIT // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_GetQualificationScore.go b/service/mturk/api_op_GetQualificationScore.go index d3762375f4f..cf385624512 100644 --- a/service/mturk/api_op_GetQualificationScore.go +++ b/service/mturk/api_op_GetQualificationScore.go @@ -11,11 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The GetQualificationScore operation returns the value of a Worker's -// Qualification for a given Qualification type. To get a Worker's Qualification, -// you must know the Worker's ID. The Worker's ID is included in the assignment -// data returned by the ListAssignmentsForHIT operation. Only the owner of a -// Qualification type can query the value of a Worker's Qualification of that type. +// The GetQualificationScore operation returns the value of a Worker's +// +// Qualification for a given Qualification type. +// +// To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID +// is included in the assignment data returned by the ListAssignmentsForHIT +// operation. +// +// Only the owner of a Qualification type can query the value of a Worker's +// Qualification of that type. func (c *Client) GetQualificationScore(ctx context.Context, params *GetQualificationScoreInput, optFns ...func(*Options)) (*GetQualificationScoreOutput, error) { if params == nil { params = &GetQualificationScoreInput{} @@ -48,7 +53,7 @@ type GetQualificationScoreInput struct { type GetQualificationScoreOutput struct { - // The Qualification data structure of the Qualification assigned to a user, + // The Qualification data structure of the Qualification assigned to a user, // including the Qualification type and the value (score). Qualification *types.Qualification diff --git a/service/mturk/api_op_GetQualificationType.go b/service/mturk/api_op_GetQualificationType.go index 18b90bc9b02..12039523733 100644 --- a/service/mturk/api_op_GetQualificationType.go +++ b/service/mturk/api_op_GetQualificationType.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The GetQualificationType operation 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 { @@ -40,7 +41,7 @@ type GetQualificationTypeInput struct { type GetQualificationTypeOutput struct { - // The returned Qualification Type + // The returned Qualification Type QualificationType *types.QualificationType // Metadata pertaining to the operation's result. diff --git a/service/mturk/api_op_ListAssignmentsForHIT.go b/service/mturk/api_op_ListAssignmentsForHIT.go index bfdcf7987f3..98ec6117e86 100644 --- a/service/mturk/api_op_ListAssignmentsForHIT.go +++ b/service/mturk/api_op_ListAssignmentsForHIT.go @@ -11,20 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. -// You can use this operation to retrieve the results for a HIT. You can get -// assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a -// HIT requested multiple assignments, and has received some results but has not -// yet become Reviewable, you can still retrieve the partial results with this -// operation. Use the AssignmentStatus parameter to control which set of -// assignments for a HIT are returned. The ListAssignmentsForHIT operation can -// return submitted assignments awaiting approval, or it can return assignments -// that have already been approved or rejected. You can set -// AssignmentStatus=Approved,Rejected to get assignments that have already been -// approved and rejected together in one result set. Only the Requester who created -// the HIT can retrieve the assignments for that HIT. Results are sorted and -// divided into numbered pages and the operation returns a single page of results. -// You can use the parameters of the operation to control sorting and pagination. +// The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. +// +// You can use this operation to retrieve the results for a HIT. +// +// You can get assignments for a HIT at any time, even if the HIT is not yet +// Reviewable. If a HIT requested multiple assignments, and has received some +// results but has not yet become Reviewable, you can still retrieve the partial +// results with this operation. +// +// Use the AssignmentStatus parameter to control which set of assignments for a +// HIT are returned. The ListAssignmentsForHIT operation can return submitted +// assignments awaiting approval, or it can return assignments that have already +// been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get +// assignments that have already been approved and rejected together in one result +// set. +// +// Only the Requester who created the HIT can retrieve the assignments for that +// HIT. +// +// Results are sorted and divided into numbered pages and the operation returns a +// single page of results. You can use the parameters of the operation to control +// sorting and pagination. func (c *Client) ListAssignmentsForHIT(ctx context.Context, params *ListAssignmentsForHITInput, optFns ...func(*Options)) (*ListAssignmentsForHITOutput, error) { if params == nil { params = &ListAssignmentsForHITInput{} @@ -60,7 +68,7 @@ type ListAssignmentsForHITInput struct { type ListAssignmentsForHITOutput struct { - // The collection of Assignment data structures returned by this call. + // The collection of Assignment data structures returned by this call. Assignments []types.Assignment // If the previous response was incomplete (because there is more data to @@ -68,7 +76,7 @@ type ListAssignmentsForHITOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The number of assignments on the page in the filtered results list, equivalent + // The number of assignments on the page in the filtered results list, equivalent // to the number of assignments returned by this call. NumResults *int32 diff --git a/service/mturk/api_op_ListBonusPayments.go b/service/mturk/api_op_ListBonusPayments.go index bfc44b4ee55..4b1d8f081df 100644 --- a/service/mturk/api_op_ListBonusPayments.go +++ b/service/mturk/api_op_ListBonusPayments.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListBonusPayments operation retrieves the amounts of bonuses you have paid +// The ListBonusPayments operation retrieves the amounts of bonuses you have paid +// // to Workers for a given HIT or assignment. func (c *Client) ListBonusPayments(ctx context.Context, params *ListBonusPaymentsInput, optFns ...func(*Options)) (*ListBonusPaymentsOutput, error) { if params == nil { diff --git a/service/mturk/api_op_ListHITs.go b/service/mturk/api_op_ListHITs.go index 8c1e4a4ad85..d27a00b0abf 100644 --- a/service/mturk/api_op_ListHITs.go +++ b/service/mturk/api_op_ListHITs.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListHITs operation returns all of a Requester's HITs. The operation returns -// HITs of any status, except for HITs that have been deleted of with the DeleteHIT -// operation or that have been auto-deleted. +// The ListHITs operation returns all of a Requester's HITs. The operation +// +// returns HITs of any status, except for HITs that have been deleted of with the +// DeleteHIT operation or that have been auto-deleted. func (c *Client) ListHITs(ctx context.Context, params *ListHITsInput, optFns ...func(*Options)) (*ListHITsOutput, error) { if params == nil { params = &ListHITsInput{} @@ -40,7 +41,7 @@ type ListHITsInput struct { type ListHITsOutput struct { - // The list of HIT elements returned by the query. + // The list of HIT elements returned by the query. HITs []types.HIT // If the previous response was incomplete (because there is more data to diff --git a/service/mturk/api_op_ListHITsForQualificationType.go b/service/mturk/api_op_ListHITsForQualificationType.go index 5d24c0d55fa..ef4512ca34c 100644 --- a/service/mturk/api_op_ListHITsForQualificationType.go +++ b/service/mturk/api_op_ListHITsForQualificationType.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListHITsForQualificationType operation returns the HITs that use the given +// The ListHITsForQualificationType operation returns the HITs that use the given +// // Qualification type for a Qualification requirement. The operation returns HITs // of any status, except for HITs that have been deleted with the DeleteHIT // operation or that have been auto-deleted. @@ -32,12 +33,12 @@ func (c *Client) ListHITsForQualificationType(ctx context.Context, params *ListH type ListHITsForQualificationTypeInput struct { - // The ID of the Qualification type to use when querying HITs. + // The ID of the Qualification type to use when querying HITs. // // This member is required. QualificationTypeId *string - // Limit the number of results returned. + // Limit the number of results returned. MaxResults *int32 // Pagination Token @@ -48,7 +49,7 @@ type ListHITsForQualificationTypeInput struct { type ListHITsForQualificationTypeOutput struct { - // The list of HIT elements returned by the query. + // The list of HIT elements returned by the query. HITs []types.HIT // If the previous response was incomplete (because there is more data to @@ -56,8 +57,8 @@ type ListHITsForQualificationTypeOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The number of HITs on this page in the filtered results list, equivalent to the - // number of HITs being returned by this call. + // The number of HITs on this page in the filtered results list, equivalent to + // the number of HITs being returned by this call. NumResults *int32 // Metadata pertaining to the operation's result. @@ -156,7 +157,7 @@ var _ ListHITsForQualificationTypeAPIClient = (*Client)(nil) // ListHITsForQualificationTypePaginatorOptions is the paginator options for // ListHITsForQualificationType type ListHITsForQualificationTypePaginatorOptions struct { - // Limit the number of results returned. + // Limit the number of results returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mturk/api_op_ListQualificationRequests.go b/service/mturk/api_op_ListQualificationRequests.go index 1b6123cb766..9cd6a57d77b 100644 --- a/service/mturk/api_op_ListQualificationRequests.go +++ b/service/mturk/api_op_ListQualificationRequests.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListQualificationRequests operation retrieves requests for Qualifications +// 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. @@ -32,7 +33,7 @@ func (c *Client) ListQualificationRequests(ctx context.Context, params *ListQual type ListQualificationRequestsInput struct { - // The maximum number of results to return in a single call. + // The maximum number of results to return in a single call. MaxResults *int32 // If the previous response was incomplete (because there is more data to @@ -154,7 +155,7 @@ var _ ListQualificationRequestsAPIClient = (*Client)(nil) // ListQualificationRequestsPaginatorOptions is the paginator options for // ListQualificationRequests type ListQualificationRequestsPaginatorOptions struct { - // The maximum number of results to return in a single call. + // The maximum number of results to return in a single call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mturk/api_op_ListQualificationTypes.go b/service/mturk/api_op_ListQualificationTypes.go index c8408d97a83..191ade0f6bb 100644 --- a/service/mturk/api_op_ListQualificationTypes.go +++ b/service/mturk/api_op_ListQualificationTypes.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListQualificationTypes operation returns a list of Qualification types, +// The ListQualificationTypes operation returns a list of Qualification types, +// // filtered by an optional search term. func (c *Client) ListQualificationTypes(ctx context.Context, params *ListQualificationTypesInput, optFns ...func(*Options)) (*ListQualificationTypesOutput, error) { if params == nil { @@ -40,10 +41,10 @@ type ListQualificationTypesInput struct { // This member is required. MustBeRequestable *bool - // The maximum number of results to return in a single call. + // The maximum number of results to return in a single call. MaxResults *int32 - // Specifies that only Qualification types that the Requester created are + // Specifies that only Qualification types that the Requester created are // returned. If false, the operation returns all Qualification types. MustBeOwnedByCaller *bool @@ -52,7 +53,7 @@ type ListQualificationTypesInput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // A text query against all of the searchable attributes of Qualification types. + // A text query against all of the searchable attributes of Qualification types. Query *string noSmithyDocumentSerde @@ -65,11 +66,11 @@ type ListQualificationTypesOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The number of Qualification types on this page in the filtered results list, + // The number of Qualification types on this page in the filtered results list, // equivalent to the number of types this operation returns. NumResults *int32 - // The list of QualificationType elements returned by the query. + // The list of QualificationType elements returned by the query. QualificationTypes []types.QualificationType // Metadata pertaining to the operation's result. @@ -168,7 +169,7 @@ var _ ListQualificationTypesAPIClient = (*Client)(nil) // ListQualificationTypesPaginatorOptions is the paginator options for // ListQualificationTypes type ListQualificationTypesPaginatorOptions struct { - // The maximum number of results to return in a single call. + // The maximum number of results to return in a single call. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mturk/api_op_ListReviewPolicyResultsForHIT.go b/service/mturk/api_op_ListReviewPolicyResultsForHIT.go index 303d4d14eb9..6600790bc8a 100644 --- a/service/mturk/api_op_ListReviewPolicyResultsForHIT.go +++ b/service/mturk/api_op_ListReviewPolicyResultsForHIT.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListReviewPolicyResultsForHIT operation retrieves the computed results and +// The ListReviewPolicyResultsForHIT operation retrieves the computed results and +// // the actions taken in the course of executing your Review Policies for a given // HIT. For information about how to specify Review Policies when you call // CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can @@ -44,16 +45,16 @@ type ListReviewPolicyResultsForHITInput struct { // Pagination token NextToken *string - // The Policy Level(s) to retrieve review results for - HIT or Assignment. If + // The Policy Level(s) to retrieve review results for - HIT or Assignment. If // omitted, the default behavior is to retrieve all data for both policy levels. // For a list of all the described policies, see Review Policies. PolicyLevels []types.ReviewPolicyLevel - // Specify if the operation should retrieve a list of the actions taken executing + // Specify if the operation should retrieve a list of the actions taken executing // the Review Policies and their outcomes. RetrieveActions *bool - // Specify if the operation should retrieve a list of the results computed by the + // Specify if the operation should retrieve a list of the results computed by the // Review Policies. RetrieveResults *bool @@ -62,11 +63,11 @@ type ListReviewPolicyResultsForHITInput struct { type ListReviewPolicyResultsForHITOutput struct { - // The name of the Assignment-level Review Policy. This contains only the + // The name of the Assignment-level Review Policy. This contains only the // PolicyName element. AssignmentReviewPolicy *types.ReviewPolicy - // Contains both ReviewResult and ReviewAction elements for an Assignment. + // Contains both ReviewResult and ReviewAction elements for an Assignment. AssignmentReviewReport *types.ReviewReport // The HITId of the HIT for which results have been returned. diff --git a/service/mturk/api_op_ListReviewableHITs.go b/service/mturk/api_op_ListReviewableHITs.go index 4a731663374..7cec16131b8 100644 --- a/service/mturk/api_op_ListReviewableHITs.go +++ b/service/mturk/api_op_ListReviewableHITs.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListReviewableHITs operation retrieves the HITs with Status equal to +// The ListReviewableHITs operation retrieves the HITs with Status equal to +// // Reviewable or Status equal to Reviewing that belong to the Requester calling the // operation. func (c *Client) ListReviewableHITs(ctx context.Context, params *ListReviewableHITsInput, optFns ...func(*Options)) (*ListReviewableHITsOutput, error) { @@ -31,17 +32,17 @@ func (c *Client) ListReviewableHITs(ctx context.Context, params *ListReviewableH type ListReviewableHITsInput struct { - // The ID of the HIT type of the HITs to consider for the query. If not specified, - // all HITs for the Reviewer are considered + // The ID of the HIT type of the HITs to consider for the query. If not + // specified, all HITs for the Reviewer are considered HITTypeId *string - // Limit the number of results returned. + // Limit the number of results returned. MaxResults *int32 // 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 @@ -49,7 +50,7 @@ type ListReviewableHITsInput struct { type ListReviewableHITsOutput struct { - // The list of HIT elements returned by the query. + // The list of HIT elements returned by the query. HITs []types.HIT // If the previous response was incomplete (because there is more data to @@ -57,8 +58,8 @@ type ListReviewableHITsOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The number of HITs on this page in the filtered results list, equivalent to the - // number of HITs being returned by this call. + // The number of HITs on this page in the filtered results list, equivalent to + // the number of HITs being returned by this call. NumResults *int32 // Metadata pertaining to the operation's result. @@ -154,7 +155,7 @@ var _ ListReviewableHITsAPIClient = (*Client)(nil) // ListReviewableHITsPaginatorOptions is the paginator options for // ListReviewableHITs type ListReviewableHITsPaginatorOptions struct { - // Limit the number of results returned. + // Limit the number of results returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mturk/api_op_ListWorkerBlocks.go b/service/mturk/api_op_ListWorkerBlocks.go index 0b50003273f..7eabc52cdb5 100644 --- a/service/mturk/api_op_ListWorkerBlocks.go +++ b/service/mturk/api_op_ListWorkerBlocks.go @@ -44,11 +44,11 @@ type ListWorkerBlocksOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The number of assignments on the page in the filtered results list, equivalent + // The number of assignments on the page in the filtered results list, equivalent // to the number of assignments returned by this call. NumResults *int32 - // The list of WorkerBlocks, containing the collection of Worker IDs and reasons + // The list of WorkerBlocks, containing the collection of Worker IDs and reasons // for blocking. WorkerBlocks []types.WorkerBlock diff --git a/service/mturk/api_op_ListWorkersWithQualificationType.go b/service/mturk/api_op_ListWorkersWithQualificationType.go index afc48233633..4f7881c307b 100644 --- a/service/mturk/api_op_ListWorkersWithQualificationType.go +++ b/service/mturk/api_op_ListWorkersWithQualificationType.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The ListWorkersWithQualificationType operation returns all of the Workers that +// The ListWorkersWithQualificationType operation returns all of the Workers that +// // have been associated with a given Qualification type. func (c *Client) ListWorkersWithQualificationType(ctx context.Context, params *ListWorkersWithQualificationTypeInput, optFns ...func(*Options)) (*ListWorkersWithQualificationTypeOutput, error) { if params == nil { @@ -35,13 +36,13 @@ type ListWorkersWithQualificationTypeInput struct { // This member is required. QualificationTypeId *string - // Limit the number of results returned. + // Limit the number of results returned. MaxResults *int32 // 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 @@ -54,11 +55,11 @@ type ListWorkersWithQualificationTypeOutput struct { // You can use this pagination token to retrieve the next set of results. NextToken *string - // The number of Qualifications on this page in the filtered results list, + // The number of Qualifications on this page in the filtered results list, // equivalent to the number of Qualifications being returned by this call. NumResults *int32 - // The list of Qualification elements returned by this call. + // The list of Qualification elements returned by this call. Qualifications []types.Qualification // Metadata pertaining to the operation's result. @@ -157,7 +158,7 @@ var _ ListWorkersWithQualificationTypeAPIClient = (*Client)(nil) // ListWorkersWithQualificationTypePaginatorOptions is the paginator options for // ListWorkersWithQualificationType type ListWorkersWithQualificationTypePaginatorOptions struct { - // Limit the number of results returned. + // Limit the number of results returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/mturk/api_op_NotifyWorkers.go b/service/mturk/api_op_NotifyWorkers.go index bd655677046..c7dd5908417 100644 --- a/service/mturk/api_op_NotifyWorkers.go +++ b/service/mturk/api_op_NotifyWorkers.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The NotifyWorkers operation sends an email to one or more Workers that you +// The NotifyWorkers operation sends an email to one or more Workers that you +// // specify with the Worker ID. You can specify up to 100 Worker IDs to send the // same message with a single call to the NotifyWorkers operation. The // NotifyWorkers operation will send a notification email to a Worker only if you @@ -54,7 +55,7 @@ type NotifyWorkersInput struct { type NotifyWorkersOutput struct { - // When MTurk sends notifications to the list of Workers, it returns back any + // When MTurk sends notifications to the list of Workers, it returns back any // failures it encounters in this list of NotifyWorkersFailureStatus objects. NotifyWorkersFailureStatuses []types.NotifyWorkersFailureStatus diff --git a/service/mturk/api_op_RejectAssignment.go b/service/mturk/api_op_RejectAssignment.go index 90c3b88a10d..dccba5ae64b 100644 --- a/service/mturk/api_op_RejectAssignment.go +++ b/service/mturk/api_op_RejectAssignment.go @@ -10,13 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The RejectAssignment operation rejects the results of a completed assignment. +// The RejectAssignment operation rejects the results of a completed assignment. +// // You can include an optional feedback message with the rejection, which the // Worker can see in the Status section of the web site. When you include a // feedback message with the rejection, it helps the Worker understand why the // assignment was rejected, and can improve the quality of the results the Worker -// submits in the future. Only the Requester who created the HIT can reject an -// assignment for the HIT. +// submits in the future. +// +// Only the Requester who created the HIT can reject an assignment for the HIT. func (c *Client) RejectAssignment(ctx context.Context, params *RejectAssignmentInput, optFns ...func(*Options)) (*RejectAssignmentOutput, error) { if params == nil { params = &RejectAssignmentInput{} @@ -34,14 +36,14 @@ 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 ID of the assignment. The assignment must correspond to a HIT created by // the Requester. // // This member is required. AssignmentId *string - // A message for the Worker, which the Worker can see in the Status section of the - // web site. + // A message for the Worker, which the Worker can see in the Status section of + // the web site. // // This member is required. RequesterFeedback *string diff --git a/service/mturk/api_op_RejectQualificationRequest.go b/service/mturk/api_op_RejectQualificationRequest.go index ed77f3e133e..34ee4974a4d 100644 --- a/service/mturk/api_op_RejectQualificationRequest.go +++ b/service/mturk/api_op_RejectQualificationRequest.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The RejectQualificationRequest operation rejects a user's request for a -// Qualification. You can provide a text message explaining why the request was -// rejected. The Worker who made the request can see this message. +// The RejectQualificationRequest operation rejects a user's request for a +// +// Qualification. +// +// You can provide a text message explaining why the request was rejected. The +// Worker who made the request can see this message. func (c *Client) RejectQualificationRequest(ctx context.Context, params *RejectQualificationRequestInput, optFns ...func(*Options)) (*RejectQualificationRequestOutput, error) { if params == nil { params = &RejectQualificationRequestInput{} @@ -30,7 +33,7 @@ func (c *Client) RejectQualificationRequest(ctx context.Context, params *RejectQ type RejectQualificationRequestInput struct { - // The ID of the Qualification request, as returned by the + // The ID of the Qualification request, as returned by the // ListQualificationRequests operation. // // This member is required. diff --git a/service/mturk/api_op_SendBonus.go b/service/mturk/api_op_SendBonus.go index d1724983ac7..a8bcf487ea7 100644 --- a/service/mturk/api_op_SendBonus.go +++ b/service/mturk/api_op_SendBonus.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The SendBonus operation issues a payment of money from your account to a +// 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 @@ -41,7 +42,7 @@ type SendBonusInput struct { // This member is required. AssignmentId *string - // The Bonus amount is a US Dollar amount specified using a string (for example, + // The Bonus amount is a US Dollar amount specified using a string (for example, // "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include // currency symbols or currency codes. // diff --git a/service/mturk/api_op_SendTestEventNotification.go b/service/mturk/api_op_SendTestEventNotification.go index 790054b93e4..31d4d2f7b22 100644 --- a/service/mturk/api_op_SendTestEventNotification.go +++ b/service/mturk/api_op_SendTestEventNotification.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The SendTestEventNotification operation causes Amazon Mechanical Turk to send a -// notification message as if a HIT event occurred, according to the provided +// The SendTestEventNotification operation causes Amazon Mechanical Turk to send +// +// a notification message as if a HIT event occurred, according to the provided // notification specification. This allows you to test notifications without // setting up notifications for a real HIT type and trying to trigger them using // the website. When you call this operation, the service attempts to send the test @@ -34,14 +35,14 @@ func (c *Client) SendTestEventNotification(ctx context.Context, params *SendTest type SendTestEventNotificationInput struct { - // The notification specification to test. This value is identical to the value + // 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 - // The event to simulate to test the notification specification. This event is + // The event to simulate to test the notification specification. This event is // included in the test message even if the notification specification does not // include the event type. The notification specification does not filter out the // test event. diff --git a/service/mturk/api_op_UpdateExpirationForHIT.go b/service/mturk/api_op_UpdateExpirationForHIT.go index ca8dd49f884..6e0dbadf323 100644 --- a/service/mturk/api_op_UpdateExpirationForHIT.go +++ b/service/mturk/api_op_UpdateExpirationForHIT.go @@ -11,8 +11,9 @@ import ( "time" ) -// The UpdateExpirationForHIT operation allows you update the expiration time of a -// HIT. If you update it to a time in the past, the HIT will be immediately +// The UpdateExpirationForHIT operation allows you update the expiration time of +// +// a HIT. If you update it to a time in the past, the HIT will be immediately // expired. func (c *Client) UpdateExpirationForHIT(ctx context.Context, params *UpdateExpirationForHITInput, optFns ...func(*Options)) (*UpdateExpirationForHITOutput, error) { if params == nil { @@ -31,12 +32,12 @@ func (c *Client) UpdateExpirationForHIT(ctx context.Context, params *UpdateExpir type UpdateExpirationForHITInput struct { - // The date and time at which you want the HIT to expire + // The date and time at which you want the HIT to expire // // This member is required. ExpireAt *time.Time - // The HIT to update. + // The HIT to update. // // This member is required. HITId *string diff --git a/service/mturk/api_op_UpdateHITReviewStatus.go b/service/mturk/api_op_UpdateHITReviewStatus.go index a06d8538814..da0bf7b6fdc 100644 --- a/service/mturk/api_op_UpdateHITReviewStatus.go +++ b/service/mturk/api_op_UpdateHITReviewStatus.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UpdateHITReviewStatus operation updates the status of a HIT. If the status +// The UpdateHITReviewStatus operation updates the status of a HIT. If the status +// // is Reviewable, this operation can update the status to Reviewing, or it can // revert a Reviewing HIT back to the Reviewable status. func (c *Client) UpdateHITReviewStatus(ctx context.Context, params *UpdateHITReviewStatusInput, optFns ...func(*Options)) (*UpdateHITReviewStatusOutput, error) { @@ -30,14 +31,16 @@ func (c *Client) UpdateHITReviewStatus(ctx context.Context, params *UpdateHITRev type UpdateHITReviewStatusInput struct { - // The ID of the HIT to update. + // The ID of the HIT to update. // // This member is required. HITId *string - // Specifies how to update the HIT status. Default is False . + // 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 diff --git a/service/mturk/api_op_UpdateHITTypeOfHIT.go b/service/mturk/api_op_UpdateHITTypeOfHIT.go index bee15e91225..7bad72265fc 100644 --- a/service/mturk/api_op_UpdateHITTypeOfHIT.go +++ b/service/mturk/api_op_UpdateHITTypeOfHIT.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UpdateHITTypeOfHIT operation allows you to change the HITType properties of -// a HIT. This operation disassociates the HIT from its old HITType properties and -// associates it with the new HITType properties. The HIT takes on the properties -// of the new HITType in place of the old ones. +// The UpdateHITTypeOfHIT operation allows you to change the HITType properties +// +// of a HIT. This operation disassociates the HIT from its old HITType properties +// and associates it with the new HITType properties. The HIT takes on the +// properties of the new HITType in place of the old ones. func (c *Client) UpdateHITTypeOfHIT(ctx context.Context, params *UpdateHITTypeOfHITInput, optFns ...func(*Options)) (*UpdateHITTypeOfHITOutput, error) { if params == nil { params = &UpdateHITTypeOfHITInput{} diff --git a/service/mturk/api_op_UpdateNotificationSettings.go b/service/mturk/api_op_UpdateNotificationSettings.go index 3e7db390b3b..9374672a3ca 100644 --- a/service/mturk/api_op_UpdateNotificationSettings.go +++ b/service/mturk/api_op_UpdateNotificationSettings.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UpdateNotificationSettings operation creates, updates, disables or +// The UpdateNotificationSettings operation creates, updates, disables or +// // re-enables notifications for a HIT type. If you call the // UpdateNotificationSettings operation for a HIT type that already has a // notification specification, the operation replaces the old specification with a @@ -39,18 +40,18 @@ func (c *Client) UpdateNotificationSettings(ctx context.Context, params *UpdateN type UpdateNotificationSettingsInput struct { - // The ID of the HIT type whose notification specification is being updated. + // The ID of the HIT type whose notification specification is being updated. // // This member is required. HITTypeId *string - // Specifies whether notifications are sent for HITs of this HIT type, according + // 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 - // The notification specification for the HIT type. + // The notification specification for the HIT type. Notification *types.NotificationSpecification noSmithyDocumentSerde diff --git a/service/mturk/api_op_UpdateQualificationType.go b/service/mturk/api_op_UpdateQualificationType.go index 783a8407649..398ee41dfea 100644 --- a/service/mturk/api_op_UpdateQualificationType.go +++ b/service/mturk/api_op_UpdateQualificationType.go @@ -11,29 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// The UpdateQualificationType operation modifies the attributes of an existing +// The UpdateQualificationType operation modifies the attributes of an existing +// // Qualification type, which is represented by a QualificationType data structure. -// Only the owner of a Qualification type can modify its attributes. Most -// attributes of a Qualification type can be changed after the type has been +// Only the owner of a Qualification type can modify its attributes. +// +// Most attributes of a Qualification type can be changed after the type has been // created. However, the Name and Keywords fields cannot be modified. The // RetryDelayInSeconds parameter can be modified or added to change the delay or to -// enable retries, but RetryDelayInSeconds cannot be used to disable retries. You -// can use this operation to update the test for a Qualification type. The test is -// updated based on the values specified for the Test, TestDurationInSeconds and -// AnswerKey parameters. All three parameters specify the updated test. If you are -// updating the test for a type, you must specify the Test and -// TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting -// it specifies that the updated test does not have an answer key. If you omit the -// Test parameter, the test for the Qualification type is unchanged. There is no -// way to remove a test from a Qualification type that has one. If the type already -// has a test, you cannot update it to be AutoGranted. If the Qualification type -// does not have a test and one is provided by an update, the type will henceforth -// have a test. If you want to update the test duration or answer key for an -// existing test without changing the questions, you must specify a Test parameter -// with the original questions, along with the updated values. If you provide an -// updated Test but no AnswerKey, the new test will not have an answer key. -// Requests for such Qualifications must be granted manually. You can also update -// the AutoGranted and AutoGrantedValue attributes of the Qualification type. +// enable retries, but RetryDelayInSeconds cannot be used to disable retries. +// +// You can use this operation to update the test for a Qualification type. The +// test is updated based on the values specified for the Test, +// TestDurationInSeconds and AnswerKey parameters. All three parameters specify the +// updated test. If you are updating the test for a type, you must specify the Test +// and TestDurationInSeconds parameters. The AnswerKey parameter is optional; +// omitting it specifies that the updated test does not have an answer key. +// +// If you omit the Test parameter, the test for the Qualification type is +// unchanged. There is no way to remove a test from a Qualification type that has +// one. If the type already has a test, you cannot update it to be AutoGranted. If +// the Qualification type does not have a test and one is provided by an update, +// the type will henceforth have a test. +// +// If you want to update the test duration or answer key for an existing test +// without changing the questions, you must specify a Test parameter with the +// original questions, along with the updated values. +// +// If you provide an updated Test but no AnswerKey, the new test will not have an +// answer key. Requests for such Qualifications must be granted manually. +// +// You can also update the AutoGranted and AutoGrantedValue attributes of the +// Qualification type. func (c *Client) UpdateQualificationType(ctx context.Context, params *UpdateQualificationTypeInput, optFns ...func(*Options)) (*UpdateQualificationTypeOutput, error) { if params == nil { params = &UpdateQualificationTypeInput{} @@ -61,8 +70,9 @@ type UpdateQualificationTypeInput struct { AnswerKey *string // Specifies whether requests for the Qualification type are granted immediately, - // without prompting the Worker with a Qualification test. Constraints: If the Test - // parameter is specified, this parameter cannot be true. + // without prompting the Worker with a Qualification test. + // + // Constraints: If the Test parameter is specified, this parameter cannot be true. AutoGranted *bool // The Qualification value to use for automatically granted Qualifications. This @@ -86,10 +96,13 @@ type UpdateQualificationTypeInput struct { // The questions for the Qualification test a Worker must answer correctly to // obtain a Qualification of this type. If this parameter is specified, - // TestDurationInSeconds must also be specified. Constraints: Must not be longer - // than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot - // be specified if AutoGranted is true. Constraints: None. If not specified, the - // Worker may request the Qualification without answering any questions. + // TestDurationInSeconds must also be specified. + // + // Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data + // structure. This parameter cannot be specified if AutoGranted is true. + // + // Constraints: None. If not specified, the Worker may request the Qualification + // without answering any questions. Test *string // The number of seconds the Worker has to complete the Qualification test, @@ -101,7 +114,7 @@ type UpdateQualificationTypeInput struct { type UpdateQualificationTypeOutput struct { - // Contains a QualificationType data structure. + // Contains a QualificationType data structure. QualificationType *types.QualificationType // Metadata pertaining to the operation's result. diff --git a/service/mturk/options.go b/service/mturk/options.go index a3035071e59..5f4f6c52f4d 100644 --- a/service/mturk/options.go +++ b/service/mturk/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mturk/types/enums.go b/service/mturk/types/enums.go index 56a19f95419..51d9301d67f 100644 --- a/service/mturk/types/enums.go +++ b/service/mturk/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AssignmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignmentStatus) Values() []AssignmentStatus { return []AssignmentStatus{ "Submitted", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for Comparator. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Comparator) Values() []Comparator { return []Comparator{ "LessThan", @@ -75,8 +77,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -104,8 +107,9 @@ const ( ) // Values returns all known values for HITAccessActions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HITAccessActions) Values() []HITAccessActions { return []HITAccessActions{ "Accept", @@ -125,8 +129,9 @@ const ( ) // Values returns all known values for HITReviewStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HITReviewStatus) Values() []HITReviewStatus { return []HITReviewStatus{ "NotReviewed", @@ -148,8 +153,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -170,8 +176,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Email", @@ -190,6 +197,7 @@ const ( // 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{ @@ -207,8 +215,9 @@ const ( ) // Values returns all known values for QualificationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QualificationStatus) Values() []QualificationStatus { return []QualificationStatus{ "Granted", @@ -225,8 +234,9 @@ const ( ) // Values returns all known values for QualificationTypeStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QualificationTypeStatus) Values() []QualificationTypeStatus { return []QualificationTypeStatus{ "Active", @@ -243,8 +253,9 @@ const ( ) // Values returns all known values for ReviewableHITStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReviewableHITStatus) Values() []ReviewableHITStatus { return []ReviewableHITStatus{ "Reviewable", @@ -263,8 +274,9 @@ const ( ) // Values returns all known values for ReviewActionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReviewActionStatus) Values() []ReviewActionStatus { return []ReviewActionStatus{ "Intended", @@ -283,8 +295,9 @@ const ( ) // Values returns all known values for ReviewPolicyLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReviewPolicyLevel) Values() []ReviewPolicyLevel { return []ReviewPolicyLevel{ "Assignment", diff --git a/service/mturk/types/types.go b/service/mturk/types/types.go index a62579072db..a13a557b6d5 100644 --- a/service/mturk/types/types.go +++ b/service/mturk/types/types.go @@ -7,33 +7,34 @@ import ( "time" ) -// The Assignment data structure represents a single assignment of a HIT to a +// The Assignment data structure represents a single assignment of a HIT to a +// // Worker. The assignment tracks the Worker's efforts to complete the HIT, and // contains the results for later retrieval. type Assignment struct { - // The date and time the Worker accepted the assignment. + // The date and time the Worker accepted the assignment. AcceptTime *time.Time - // The Worker's answers submitted for the HIT contained in a QuestionFormAnswers + // The Worker's answers submitted for the HIT contained in a QuestionFormAnswers // document, if the Worker provides an answer. If the Worker does not provide any // answers, Answer may contain a QuestionFormAnswers document, or Answer may be // empty. Answer *string - // If the Worker has submitted results and the Requester has approved the results, - // ApprovalTime is the date and time the Requester approved the results. This value - // is omitted from the assignment if the Requester has not yet approved the - // results. + // If the Worker has submitted results and the Requester has approved the + // results, ApprovalTime is the date and time the Requester approved the results. + // This value is omitted from the assignment if the Requester has not yet approved + // the results. ApprovalTime *time.Time - // A unique identifier for the assignment. + // A unique identifier for the assignment. AssignmentId *string - // The status of the assignment. + // The status of the assignment. AssignmentStatus AssignmentStatus - // If results have been submitted, AutoApprovalTime is the date and time the + // If results have been submitted, AutoApprovalTime is the date and time the // results of the assignment results are considered Approved automatically if they // have not already been explicitly approved or rejected by the Requester. This // value is derived from the auto-approval delay specified by the Requester in the @@ -41,29 +42,29 @@ type Assignment struct { // submitted results. AutoApprovalTime *time.Time - // The date and time of the deadline for the assignment. This value is derived + // 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. + // The ID of the HIT. HITId *string - // If the Worker has submitted results and the Requester has rejected the results, - // RejectionTime is the date and time the Requester rejected the results. + // If the Worker has submitted results and the Requester has rejected the + // results, 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 + // 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 - // If the Worker has submitted results, SubmitTime is the date and time the + // If the Worker has submitted results, SubmitTime is the date and time the // assignment was submitted. This value is omitted from the assignment if the // Worker has not yet submitted results. SubmitTime *time.Time - // The ID of the Worker who accepted the HIT. + // The ID of the Worker who accepted the HIT. WorkerId *string noSmithyDocumentSerde @@ -90,11 +91,12 @@ type BonusPayment struct { noSmithyDocumentSerde } -// The HIT data structure represents a single HIT, including all the information +// The HIT data structure represents a single HIT, including all the information +// // necessary for a Worker to accept and complete the HIT. type HIT struct { - // The length of time, in seconds, that a Worker has to complete the HIT after + // The length of time, in seconds, that a Worker has to complete the HIT after // accepting it. AssignmentDurationInSeconds *int64 @@ -104,25 +106,25 @@ type HIT struct { // Worker before the assignment is auto-approved and the Worker is paid. AutoApprovalDelayInSeconds *int64 - // The date and time the HIT was created. + // The date and time the HIT was created. CreationTime *time.Time - // A general description of the HIT. + // A general description of the HIT. Description *string // The date and time the HIT expires. Expiration *time.Time - // The ID of the HIT Group of this HIT. + // The ID of the HIT Group of this HIT. HITGroupId *string - // A unique identifier for the HIT. + // A unique identifier for the HIT. HITId *string - // The ID of the HIT Layout of this HIT. + // The ID of the HIT Layout of this HIT. HITLayoutId *string - // Indicates the review status of the HIT. Valid Values are NotReviewed | + // Indicates the review status of the HIT. Valid Values are NotReviewed | // MarkedForReview | ReviewedAppropriate | ReviewedInappropriate. HITReviewStatus HITReviewStatus @@ -133,55 +135,58 @@ type HIT struct { // The ID of the HIT type of this HIT HITTypeId *string - // One or more words or phrases that describe the HIT, separated by commas. Search - // terms similar to the keywords of a HIT are more likely to have the HIT in the - // search results. + // One or more words or phrases that describe the HIT, separated by commas. + // Search terms similar to the keywords of a HIT are more likely to have the HIT in + // the search results. Keywords *string // 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. + // The number of assignments for this HIT that are available for Workers to + // accept. NumberOfAssignmentsAvailable *int32 - // The number of assignments for this HIT that have been approved or rejected. + // The number of assignments for this HIT that have been approved or rejected. NumberOfAssignmentsCompleted *int32 - // The number of assignments for this HIT that are being previewed or have been + // The number of assignments for this HIT that are being previewed or have been // accepted by Workers, but have not yet been submitted, returned, or abandoned. NumberOfAssignmentsPending *int32 - // Conditions that a Worker's Qualifications must meet in order to accept the HIT. - // A HIT can have between zero and ten Qualification requirements. All requirements - // must be met in order for a Worker to accept the HIT. Additionally, other actions - // can be restricted using the ActionsGuarded field on each + // Conditions that a Worker's Qualifications must meet in order to accept the + // HIT. A HIT can have between zero and ten Qualification requirements. All + // requirements must be met in order for a Worker to accept the HIT. Additionally, + // other actions can be restricted using the ActionsGuarded field on each // QualificationRequirement structure. QualificationRequirements []QualificationRequirement - // The data the Worker completing the HIT uses produce the results. This is either - // either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure. + // The data the Worker completing the HIT uses produce the results. This is + // either 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 + // 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. Reward *string - // The title of the HIT. + // The title of the HIT. Title *string noSmithyDocumentSerde } -// The HITLayoutParameter data structure defines parameter values used with a +// The HITLayoutParameter data structure defines parameter values used with a +// // HITLayout. A HITLayout is a reusable Amazon Mechanical Turk project template // used to provide Human Intelligence Task (HIT) question data for CreateHIT. type HITLayoutParameter struct { - // The name of the parameter in the HITLayout. + // The name of the parameter in the HITLayout. // // This member is required. Name *string @@ -197,7 +202,7 @@ type HITLayoutParameter struct { // The Locale data structure represents a geographical region or location. type Locale struct { - // The country of the locale. Must be a valid ISO 3166 country code. For example, + // The country of the locale. Must be a valid ISO 3166 country code. For example, // the code US refers to the United States of America. // // This member is required. @@ -214,16 +219,19 @@ type Locale struct { // for a HIT type. type NotificationSpecification struct { - // The target for notification messages. The Destination’s format is determined by - // the specified Transport: + // 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. // // This member is required. Destination *string - // The list of events that should cause notifications to be sent. Valid Values: + // The list of events that should cause notifications to be sent. Valid Values: // AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | // AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | // HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is @@ -232,7 +240,7 @@ type NotificationSpecification struct { // This member is required. EventTypes []EventType - // The method Amazon Mechanical Turk uses to send the notification. Valid Values: + // The method Amazon Mechanical Turk uses to send the notification. Valid Values: // Email | SQS | SNS. // // This member is required. @@ -246,32 +254,34 @@ type NotificationSpecification struct { noSmithyDocumentSerde } -// When MTurk encounters an issue with notifying the Workers you specified, it +// When MTurk encounters an issue with notifying the Workers you specified, it +// // returns back this object with failure details. type NotifyWorkersFailureStatus struct { - // Encoded value for the failure type. + // Encoded value for the failure type. NotifyWorkersFailureCode NotifyWorkersFailureCode - // A message detailing the reason the Worker could not be notified. + // A message detailing the reason the Worker could not be notified. NotifyWorkersFailureMessage *string - // The ID of the Worker. + // The ID of the Worker. WorkerId *string noSmithyDocumentSerde } -// This data structure is the data type for the AnswerKey parameter of the +// This data structure is the data type for the AnswerKey parameter of the +// // ScoreMyKnownAnswers/2011-09-01 Review Policy. type ParameterMapEntry struct { - // The QuestionID from the HIT that is used to identify which question requires + // The QuestionID from the HIT that is used to identify which question requires // Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review // Policy. Key *string - // The list of answers to the question specified in the MapEntry Key element. The + // The list of answers to the question specified in the MapEntry Key element. The // Worker must match all values in order for the answer to be scored correctly. Values []string @@ -281,13 +291,13 @@ type ParameterMapEntry struct { // Name of the parameter from the Review policy. type PolicyParameter struct { - // Name of the parameter from the list of Review Polices. + // Name of the parameter from the list of Review Polices. Key *string - // List of ParameterMapEntry objects. + // List of ParameterMapEntry objects. MapEntries []ParameterMapEntry - // The list of values of the Parameter + // The list of values of the Parameter Values []string noSmithyDocumentSerde @@ -297,36 +307,37 @@ type PolicyParameter struct { // including the Qualification type and the value (score). type Qualification struct { - // The date and time the Qualification was granted to the Worker. If the Worker's + // The date and time the Qualification was granted to the Worker. If the Worker's // Qualification was revoked, and then re-granted based on a new Qualification // request, GrantTime is the date and time of the last call to the // AcceptQualificationRequest operation. GrantTime *time.Time - // The value (score) of the Qualification, if the Qualification has an integer + // The value (score) of the Qualification, if the Qualification has an integer // value. IntegerValue *int32 // The Locale data structure represents a geographical region or location. LocaleValue *Locale - // The ID of the Qualification type for the Qualification. + // The ID of the Qualification type for the Qualification. QualificationTypeId *string - // The status of the Qualification. Valid values are Granted | Revoked. + // The status of the Qualification. Valid values are Granted | Revoked. Status QualificationStatus - // The ID of the Worker who possesses the Qualification. + // The ID of the Worker who possesses the Qualification. WorkerId *string noSmithyDocumentSerde } -// The QualificationRequest data structure represents a request a Worker has made +// The QualificationRequest data structure represents a request a Worker has made +// // for a Qualification. type QualificationRequest struct { - // The Worker's answers for the Qualification type's test contained in a + // The Worker's answers for the Qualification type's test contained in a // QuestionFormAnswers document, if the type has a test and the Worker has // submitted answers. If the Worker does not provide any answers, Answer may be // empty. @@ -336,7 +347,7 @@ type QualificationRequest struct { // request was submitted. QualificationRequestId *string - // The ID of the Qualification type the Worker is requesting, as returned by the + // The ID of the Qualification type the Worker is requesting, as returned by the // CreateQualificationType operation. QualificationTypeId *string @@ -346,19 +357,20 @@ type QualificationRequest struct { // have a test. SubmitTime *time.Time - // The contents of the Qualification test that was presented to the Worker, if the - // type has a test and the Worker has submitted answers. This value is identical to - // the QuestionForm associated with the Qualification type at the time the Worker - // requests the Qualification. + // The contents of the Qualification test that was presented to the Worker, if + // the type has a test and the Worker has submitted answers. This value is + // identical to the QuestionForm associated with the Qualification type at the time + // the Worker requests the Qualification. Test *string - // The ID of the Worker requesting the Qualification. + // The ID of the Worker requesting the Qualification. WorkerId *string noSmithyDocumentSerde } -// The QualificationRequirement data structure describes a Qualification that a +// The QualificationRequirement data structure describes a Qualification that a +// // Worker must have before the Worker is allowed to accept a HIT. A requirement may // optionally state that a Worker must have the Qualification in order to preview // the HIT, or see the HIT in search results. @@ -376,12 +388,12 @@ type QualificationRequirement struct { // This member is required. Comparator Comparator - // The ID of the Qualification type for the requirement. + // The ID of the Qualification type for the requirement. // // This member is required. QualificationTypeId *string - // Setting this attribute prevents Workers whose Qualifications do not meet this + // Setting this attribute prevents Workers whose Qualifications do not meet this // QualificationRequirement from taking the specified action. Valid arguments // include "Accept" (Worker cannot accept the HIT, but can preview the HIT and see // it in their search results), "PreviewAndAccept" (Worker cannot accept or preview @@ -400,7 +412,7 @@ type QualificationRequirement struct { // field. ActionsGuarded HITAccessActions - // The integer value to compare against the Qualification's value. IntegerValue + // The integer value to compare against the Qualification's value. IntegerValue // must not be present if Comparator is Exists or DoesNotExist. IntegerValue can // only be used if the Qualification type has an integer value; it cannot be used // with the Worker_Locale QualificationType ID. When performing a set comparison by @@ -408,7 +420,7 @@ type QualificationRequirement struct { // in a QualificationRequirement data structure. IntegerValues []int32 - // The locale value to compare against the Qualification's value. The local value + // The locale value to compare against the Qualification's value. The local value // must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. // LocaleValue can only be used with a Worker_Locale QualificationType ID. // LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn @@ -418,8 +430,8 @@ type QualificationRequirement struct { // QualificationRequirement data structure. LocaleValues []Locale - // DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, - // the question data for the HIT will not be shown when a Worker whose + // DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is + // true, the question data for the HIT will not be shown when a Worker whose // Qualifications do not meet this requirement tries to preview the HIT. That is, a // Worker's Qualifications must meet all of the requirements for which // RequiredToPreview is true in order to preview the HIT. If a Worker meets all of @@ -435,7 +447,8 @@ type QualificationRequirement struct { noSmithyDocumentSerde } -// The QualificationType data structure represents a Qualification type, a +// The QualificationType data structure represents a Qualification type, a +// // description of a property of a Worker that must match the requirements of a HIT // for the Worker to be able to accept the HIT. The type also describes how a // Worker can obtain a Qualification of that type, such as through a Qualification @@ -450,41 +463,41 @@ type QualificationType struct { // False. AutoGranted *bool - // The Qualification integer value to use for automatically granted + // 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. + // The date and time the Qualification type was created. CreationTime *time.Time - // A long description for the Qualification type. + // A long description for the Qualification type. Description *string - // Specifies whether the Qualification type is one that a user can request through - // the Amazon Mechanical Turk web site, such as by taking a Qualification test. - // This value is False for Qualifications assigned automatically by the system. - // Valid values are True | False. + // Specifies whether the Qualification type is one that a user can request + // through the Amazon Mechanical Turk web site, such as by taking a Qualification + // test. This value is False for Qualifications assigned automatically by the + // system. Valid values are True | False. IsRequestable *bool - // One or more words or phrases that describe theQualification type, separated by + // One or more words or phrases that describe theQualification type, separated by // commas. The Keywords make the type easier to find using a search. Keywords *string - // The name of the Qualification type. The type name is used to identify the type, - // and to find the type using a Qualification type search. + // The name of the Qualification type. The type name is used to identify the + // type, and to find the type using a Qualification type search. Name *string - // A unique identifier for the Qualification type. A Qualification type is given a - // Qualification type ID when you call the CreateQualificationType operation. + // A unique identifier for the Qualification type. A Qualification type is given + // a Qualification type ID when you call the CreateQualificationType operation. QualificationTypeId *string - // The status of the Qualification type. A Qualification type's status determines + // The status of the Qualification type. A Qualification type's status determines // if users can apply to receive a Qualification of this type, and if HITs can be // created with requirements based on this type. Valid values are Active | // Inactive. QualificationTypeStatus QualificationTypeStatus - // The amount of time, in seconds, Workers must wait after taking the + // 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 @@ -492,20 +505,22 @@ type QualificationType struct { // Qualification only once. RetryDelayInSeconds *int64 - // The questions for a Qualification test associated with this Qualification type + // The questions for a Qualification test associated with this Qualification type // that a user can take to obtain a Qualification of this type. This parameter must // be specified if AnswerKey is present. A Qualification type cannot have both a // specified Test parameter and an AutoGranted value of true. Test *string - // The amount of time, in seconds, given to a Worker to complete the Qualification - // test, beginning from the time the Worker requests the Qualification. + // The amount of time, in seconds, given to a Worker to complete the + // Qualification test, beginning from the time the Worker requests the + // Qualification. TestDurationInSeconds *int64 noSmithyDocumentSerde } -// Both the AssignmentReviewReport and the HITReviewReport elements contains the +// Both the AssignmentReviewReport and the HITReviewReport elements contains the +// // ReviewActionDetail data structure. This structure is returned multiple times for // each action specified in the Review Policy. type ReviewActionDetail struct { @@ -513,38 +528,39 @@ type ReviewActionDetail struct { // The unique identifier for the action. ActionId *string - // The nature of the action itself. The Review Policy is responsible for examining - // the HIT and Assignments, emitting results, and deciding which other actions will - // be necessary. + // The nature of the action itself. The Review Policy is responsible for + // examining the HIT and Assignments, emitting results, and deciding which other + // actions will be necessary. ActionName *string - // The date when the action was completed. + // The date when the action was completed. CompleteTime *time.Time - // Present only when the Results have a FAILED Status. + // Present only when the Results have a FAILED Status. ErrorCode *string - // A description of the outcome of the review. + // A description of the outcome of the review. Result *string - // The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or + // The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or // CANCELLED. Status ReviewActionStatus - // The specific HITId or AssignmentID targeted by the action. + // The specific HITId or AssignmentID targeted by the action. TargetId *string - // The type of object in TargetId. + // The type of object in TargetId. TargetType *string noSmithyDocumentSerde } -// HIT Review Policy data structures represent HIT review policies, which you +// HIT Review Policy data structures represent HIT review policies, which you +// // specify when you create a HIT. type ReviewPolicy struct { - // Name of a Review Policy: SimplePlurality/2011-09-01 or + // Name of a Review Policy: SimplePlurality/2011-09-01 or // ScoreMyKnownAnswers/2011-09-01 // // This member is required. @@ -559,26 +575,28 @@ type ReviewPolicy struct { // Contains both ReviewResult and ReviewAction elements for a particular HIT. type ReviewReport struct { - // A list of ReviewAction objects for each action specified in the Review Policy. + // A list of ReviewAction objects for each action specified in the Review Policy. ReviewActions []ReviewActionDetail - // A list of ReviewResults objects for each action specified in the Review Policy. + // A list of ReviewResults objects for each action specified in the Review + // Policy. ReviewResults []ReviewResultDetail noSmithyDocumentSerde } -// This data structure is returned multiple times for each result specified in the -// Review Policy. +// This data structure is returned multiple times for each result specified in +// +// the Review Policy. type ReviewResultDetail struct { - // A unique identifier of the Review action result. + // A unique identifier of the Review action result. ActionId *string - // Key identifies the particular piece of reviewed information. + // Key identifies the particular piece of reviewed information. Key *string - // Specifies the QuestionId the result is describing. Depending on whether the + // Specifies the QuestionId the result is describing. Depending on whether the // TargetType is a HIT or Assignment this results could specify multiple values. If // TargetType is HIT and QuestionId is absent, then the result describes results of // the HIT, including the HIT agreement score. If ObjectType is Assignment and @@ -592,23 +610,24 @@ type ReviewResultDetail struct { // results about the Assignment itself. SubjectId *string - // The type of the object from the SubjectId field. + // The type of the object from the SubjectId field. SubjectType *string - // The values of Key provided by the review policies you have selected. + // The values of Key provided by the review policies you have selected. Value *string noSmithyDocumentSerde } -// The WorkerBlock data structure represents a Worker who has been blocked. It has -// two elements: the WorkerId and the Reason for the block. +// The WorkerBlock data structure represents a Worker who has been blocked. It +// +// has two elements: the WorkerId and the Reason for the block. type WorkerBlock struct { - // A message explaining the reason the Worker was blocked. + // A message explaining the reason the Worker was blocked. Reason *string - // The ID of the Worker who accepted the HIT. + // The ID of the Worker who accepted the HIT. WorkerId *string noSmithyDocumentSerde diff --git a/service/mwaa/api_op_CreateCliToken.go b/service/mwaa/api_op_CreateCliToken.go index 1e0275e035e..8f901972fc5 100644 --- a/service/mwaa/api_op_CreateCliToken.go +++ b/service/mwaa/api_op_CreateCliToken.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates a CLI token for the Airflow CLI. To learn more, see [Creating an Apache Airflow CLI token]. +// +// [Creating an Apache 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{} diff --git a/service/mwaa/api_op_CreateEnvironment.go b/service/mwaa/api_op_CreateEnvironment.go index 059811287e6..8673214e708 100644 --- a/service/mwaa/api_op_CreateEnvironment.go +++ b/service/mwaa/api_op_CreateEnvironment.go @@ -28,14 +28,16 @@ func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmen } // 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) +// API reference documentation to create an environment. For more information, see [Get started with Amazon Managed Workflows for Apache Airflow] // . +// +// [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) - // . + // . For more information, see [Adding or updating DAGs]. + // + // [Adding or updating DAGs]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html // // This member is required. DagS3Path *string @@ -44,9 +46,9 @@ 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]. + // + // [Amazon MWAA Execution role]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html // // This member is required. ExecutionRoleArn *string @@ -58,32 +60,35 @@ type CreateEnvironmentInput struct { // 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]. + // + // [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]. + // + // [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]. + // + // [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. 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) - // . Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 + // defaults to the latest version. For more information, see [Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA)]. + // + // Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 // 2.8.1 + // + // [Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA)]: https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html AirflowVersion *string // Defines whether the VPC endpoints configured for the environment are created, @@ -98,15 +103,16 @@ type CreateEnvironmentInput struct { EndpointManagement types.EndpointManagement // 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) - // . + // For more information, see [Amazon MWAA environment class]. + // + // [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) - // . + // managed CMK (advanced). For more information, see [Create an Amazon MWAA environment]. + // + // [Create an Amazon MWAA environment]: https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html KmsKey *string // Defines the Apache Airflow logs to send to CloudWatch Logs. @@ -127,63 +133,76 @@ type CreateEnvironmentInput struct { 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) - // . + // a version each time a plugins.zip file is updated. For more information, see [How S3 Versioning works]. + // + // [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) - // . + // For more information, see [Installing custom plugins]. + // + // [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]. + // + // [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) - // . + // information, see [Installing Python dependencies]. + // + // [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. 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) - // 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) - // . + // specify the [version ID]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]. + // + // [Using a startup script]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html + // [version ID]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.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 - // 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) - // . + // 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]. + // + // [Using a 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]. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string // Defines the access mode for the Apache Airflow web server. For more - // information, see Apache Airflow access modes (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) - // . + // information, see [Apache Airflow access modes]. + // + // [Apache 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 diff --git a/service/mwaa/api_op_CreateWebLoginToken.go b/service/mwaa/api_op_CreateWebLoginToken.go index 511b819a4c0..57c6c67e9eb 100644 --- a/service/mwaa/api_op_CreateWebLoginToken.go +++ b/service/mwaa/api_op_CreateWebLoginToken.go @@ -10,9 +10,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]. +// +// [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{} diff --git a/service/mwaa/api_op_ListTagsForResource.go b/service/mwaa/api_op_ListTagsForResource.go index e03f7ad21d3..c3ec3eebcea 100644 --- a/service/mwaa/api_op_ListTagsForResource.go +++ b/service/mwaa/api_op_ListTagsForResource.go @@ -41,8 +41,9 @@ 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]. + // + // [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 7bf905c2f0a..43a54cecc36 100644 --- a/service/mwaa/api_op_PublishMetrics.go +++ b/service/mwaa/api_op_PublishMetrics.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Internal only. Publishes environment health metrics to Amazon CloudWatch. +// Internal only. Publishes environment health metrics to Amazon CloudWatch. // // Deprecated: This API is for internal use and not meant for public use, and is // no longer available. @@ -32,15 +32,15 @@ func (c *Client) PublishMetrics(ctx context.Context, params *PublishMetricsInput type PublishMetricsInput struct { - // Internal only. The name of the environment. + // Internal only. The name of the environment. // // This member is required. EnvironmentName *string - // 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) - // . + // 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]. + // + // [Amazon MWAA performance metrics in Amazon CloudWatch]: https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html // // This member is required. // diff --git a/service/mwaa/api_op_TagResource.go b/service/mwaa/api_op_TagResource.go index 6ab4801484c..25beca1056b 100644 --- a/service/mwaa/api_op_TagResource.go +++ b/service/mwaa/api_op_TagResource.go @@ -36,9 +36,9 @@ type TagResourceInput struct { 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]. + // + // [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_UpdateEnvironment.go b/service/mwaa/api_op_UpdateEnvironment.go index e4b18d40455..b09de50d2d1 100644 --- a/service/mwaa/api_op_UpdateEnvironment.go +++ b/service/mwaa/api_op_UpdateEnvironment.go @@ -35,35 +35,40 @@ type UpdateEnvironmentInput struct { 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]. + // + // [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. To upgrade your environment, - // specify a newer version of Apache Airflow supported by Amazon MWAA. Before you - // upgrade an environment, make sure your requirements, DAGs, plugins, and other - // resources used in your workflows are compatible with the new Apache Airflow - // version. For more information about updating your resources, see Upgrading an - // Amazon MWAA environment (https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html) - // . Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 . + // specify a newer version of Apache Airflow supported by Amazon MWAA. + // + // Before you upgrade an environment, make sure your requirements, DAGs, plugins, + // and other resources used in your workflows are compatible with the new Apache + // Airflow version. For more information about updating your resources, see [Upgrading an Amazon MWAA environment]. + // + // Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 . + // + // [Upgrading an Amazon MWAA environment]: https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html 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) - // . + // . For more information, see [Adding or updating DAGs]. + // + // [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) - // . + // For more information, see [Amazon MWAA environment class]. + // + // [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]. + // + // [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. @@ -85,32 +90,36 @@ type UpdateEnvironmentInput struct { // 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]. + // + // [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) - // . + // a version each time a plugins.zip file is updated. For more information, see [How S3 Versioning works]. + // + // [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) - // . + // For more information, see [Installing custom plugins]. + // + // [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]. + // + // [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) - // . + // more information, see [Installing Python dependencies]. + // + // [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. @@ -118,33 +127,40 @@ 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]. + // + // [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) - // 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) - // . + // The version of the startup shell script in your Amazon S3 bucket. You must + // specify the [version ID]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]. + // + // [Using a startup script]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html + // [version ID]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.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 - // 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) - // . + // 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]. + // + // [Using a 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) - // . + // The Apache Airflow Web server access mode. For more information, see [Apache Airflow access modes]. + // + // [Apache 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 diff --git a/service/mwaa/doc.go b/service/mwaa/doc.go index 679c38ac3cb..86f3eeb3500 100644 --- a/service/mwaa/doc.go +++ b/service/mwaa/doc.go @@ -3,25 +3,54 @@ // Package mwaa provides the API client, operations, and parameter types for // AmazonMWAA. // -// 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 +// # 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?]. +// +// 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) +// +// [CreateEnvironment] +// +// [DeleteEnvironment] +// +// [GetEnvironment] +// +// [ListEnvironments] +// +// [ListTagsForResource] +// +// [TagResource] +// +// [UntagResource] +// +// [UpdateEnvironment] +// // - 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) // -// Regions For a list of supported regions, see Amazon MWAA endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/mwaa.html) -// in the Amazon Web Services General Reference. +// [CreateCliToken] +// +// [CreateWebLoginToken] +// +// # Regions +// +// For a list of supported regions, see [Amazon MWAA endpoints and quotas] in the Amazon Web Services General +// Reference. +// +// [CreateWebLoginToken]: https://docs.aws.amazon.com/mwaa/latest/API/API_CreateWebLoginToken.html +// [CreateEnvironment]: https://docs.aws.amazon.com/mwaa/latest/API/API_CreateEnvironment.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 +// [Amazon MWAA endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/mwaa.html +// [DeleteEnvironment]: https://docs.aws.amazon.com/mwaa/latest/API/API_DeleteEnvironment.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 +// [What is Amazon MWAA?]: https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html +// [UpdateEnvironment]: https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html +// [ListTagsForResource]: https://docs.aws.amazon.com/mwaa/latest/API/API_ListTagsForResource.html +// [CreateCliToken]: https://docs.aws.amazon.com/mwaa/latest/API/API_CreateCliToken.html package mwaa diff --git a/service/mwaa/options.go b/service/mwaa/options.go index 406e538271a..2e037408f1e 100644 --- a/service/mwaa/options.go +++ b/service/mwaa/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/mwaa/types/enums.go b/service/mwaa/types/enums.go index d4b1f4fa761..a244e43ab65 100644 --- a/service/mwaa/types/enums.go +++ b/service/mwaa/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for EndpointManagement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointManagement) Values() []EndpointManagement { return []EndpointManagement{ "CUSTOMER", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for EnvironmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentStatus) Values() []EnvironmentStatus { return []EnvironmentStatus{ "CREATING", @@ -70,8 +72,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -116,8 +119,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "Seconds", @@ -160,8 +164,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -179,8 +184,9 @@ const ( ) // Values returns all known values for WebserverAccessMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebserverAccessMode) Values() []WebserverAccessMode { return []WebserverAccessMode{ "PRIVATE_ONLY", diff --git a/service/mwaa/types/errors.go b/service/mwaa/types/errors.go index e3d8b1bd121..7640b307bed 100644 --- a/service/mwaa/types/errors.go +++ b/service/mwaa/types/errors.go @@ -8,8 +8,9 @@ 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]. +// +// [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 7f39e234833..ef890185d54 100644 --- a/service/mwaa/types/types.go +++ b/service/mwaa/types/types.go @@ -7,18 +7,19 @@ import ( "time" ) -// 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) -// . +// 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]. +// +// [Amazon MWAA performance metrics in Amazon CloudWatch]: https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html type Dimension struct { - // Internal only. The name of the dimension. + // Internal only. The name of the dimension. // // This member is required. Name *string - // Internal only. The value of the dimension. + // Internal only. The value of the dimension. // // This member is required. Value *string @@ -30,30 +31,33 @@ type Dimension struct { 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) - // . + // attached to your environment. For more information, see [Apache Airflow configuration options]. + // + // [Apache Airflow 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 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 . + // The Apache Airflow version on your environment. + // + // Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 . AirflowVersion *string // The Amazon Resource Name (ARN) of the Amazon MWAA environment. Arn *string - // The queue ARN for the environment's Celery Executor (https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html) - // . Amazon MWAA uses a Celery Executor to distribute tasks across multiple - // workers. When you create an environment in a shared VPC, you must provide access - // to the Celery Executor queue from your VPC. + // The queue ARN for the environment's [Celery Executor]. Amazon MWAA uses a Celery Executor to + // distribute tasks across multiple workers. When you create an environment in a + // shared VPC, you must provide access to the Celery Executor queue from your VPC. + // + // [Celery Executor]: https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html CeleryExecutorQueue *string // The day and time the environment was created. 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]. + // + // [Adding or updating DAGs]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html DagS3Path *string // The VPC endpoint for the environment's Amazon RDS database. @@ -66,15 +70,16 @@ type Environment struct { EndpointManagement EndpointManagement // 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) - // . + // For more information, see [Amazon MWAA environment class]. + // + // [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]. + // + // [Amazon MWAA Execution role]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html ExecutionRoleArn *string // The KMS encryption key used to encrypt the data in your environment. @@ -97,38 +102,49 @@ type Environment 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]. + // + // [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) - // 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) - // . + // the [version ID]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]. + // + // [Installing custom plugins]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html + // [version ID]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.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]. + // + // [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) - // 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) - // . + // specify the [version ID]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]. + // + // [Installing Python dependencies]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html + // [version ID]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.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]. + // + // [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 @@ -136,85 +152,110 @@ 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]. + // + // [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]. + // + // [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) - // 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) - // . + // specify the [version ID]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]. + // + // [Using a startup script]: https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html + // [version ID]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.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 - // 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) - // . + // 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]. + // + // [Using a 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: + // The status of the Amazon MWAA environment. + // + // Valid values: + // // - CREATING - Indicates the request to create the environment is in progress. + // // - CREATING_SNAPSHOT - Indicates the request to update environment details, or // upgrade the environment version, is in progress and Amazon MWAA is creating a // storage volume snapshot of the Amazon RDS database cluster associated with the // environment. A database snapshot is a backup created at a specific point in // time. Amazon MWAA uses snapshots to recover environment metadata if the process // to update or upgrade an environment fails. + // // - 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. + // // - PENDING - Indicates the request was successful, but the process to create // the environment is paused until you create the required VPC endpoints in your // VPC. After you create the VPC endpoints, the process resumes. + // // - UPDATING - Indicates the request to update the environment is in progress. + // // - ROLLING_BACK - Indicates the request to update environment details, or // upgrade the environment version, failed and Amazon MWAA is restoring the // environment using the latest storage volume snapshot. + // // - 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 did not // return to its previous state and is not stable. + // // - UPDATE_FAILED - Indicates the request to update the environment failed, and // the environment was restored to its previous state successfully and is ready to // use. + // // - MAINTENANCE - Indicates that the environment is undergoing maintenance. // Depending on the type of work Amazon MWAA is performing, your environment might // become unavailable during this process. After all operations are done, your // environment will return to its status prior to mainteneace operations. + // // 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) - // . + // and their solutions. For more information, see [Amazon MWAA troubleshooting]. + // + // [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]. + // + // [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) - // . + // The Apache Airflow web server access mode. For more information, see [Apache Airflow access modes]. + // + // [Apache 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]. + // + // [Accessing the Apache Airflow UI]: https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html WebserverUrl *string // The VPC endpoint for the environment's web server. @@ -290,37 +331,39 @@ type LoggingConfigurationInput struct { noSmithyDocumentSerde } -// 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) . +// Internal only. Collects Apache Airflow metrics. To learn more about the +// +// metrics published to Amazon CloudWatch, see [Amazon MWAA performance metrics in Amazon CloudWatch]. +// +// [Amazon MWAA performance metrics in Amazon CloudWatch]: https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html type MetricDatum struct { - // Internal only. The name of the metric. + // Internal only. The name of the metric. // // This member is required. MetricName *string - // Internal only. The time the metric data was received. + // Internal only. The time the metric data was received. // // This member is required. Timestamp *time.Time - // Internal only. The dimensions associated with the metric. + // Internal only. The dimensions associated with the metric. // // Deprecated: This type is for internal use and not meant for public use. Data // set for this type will be ignored. Dimensions []Dimension - // Internal only. The statistical values for the metric. + // Internal only. The statistical values for the metric. // // Deprecated: This type is for internal use and not meant for public use. Data // set for this type will be ignored. StatisticValues *StatisticSet - // Internal only. The unit used to store the metric. + // Internal only. The unit used to store the metric. Unit Unit - // Internal only. The value for the metric. + // Internal only. The value for the metric. Value *float64 noSmithyDocumentSerde @@ -366,38 +409,41 @@ 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]. +// +// [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) - // . + // A list of security group IDs. For more information, see [Security in your VPC on Amazon MWAA]. + // + // [Security in your VPC on 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]. + // + // [About networking on Amazon MWAA]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html SubnetIds []string noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [Amazon MWAA 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. + // Internal only. The maximum value of the sample set. Maximum *float64 - // Internal only. The minimum value of the sample set. + // Internal only. The minimum value of the sample set. Minimum *float64 - // Internal only. The number of samples used for the statistic set. + // Internal only. The number of samples used for the statistic set. SampleCount *int32 - // Internal only. The sum of values for the sample set. + // Internal only. The sum of values for the sample set. Sum *float64 noSmithyDocumentSerde @@ -417,13 +463,15 @@ 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]. +// +// [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]. + // + // [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_op_AddRoleToDBCluster.go b/service/neptune/api_op_AddRoleToDBCluster.go index ea5608a107a..40220c99e01 100644 --- a/service/neptune/api_op_AddRoleToDBCluster.go +++ b/service/neptune/api_op_AddRoleToDBCluster.go @@ -41,7 +41,7 @@ type AddRoleToDBClusterInput struct { 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 a1f82ea6449..4a9e0095f88 100644 --- a/service/neptune/api_op_AddSourceIdentifierToSubscription.go +++ b/service/neptune/api_op_AddSourceIdentifierToSubscription.go @@ -29,15 +29,20 @@ func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params * type AddSourceIdentifierToSubscriptionInput struct { - // The identifier of the event source to be added. Constraints: + // 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 snapshot, a DBSnapshotIdentifier must be supplied. // // This member is required. SourceIdentifier *string @@ -53,8 +58,7 @@ type AddSourceIdentifierToSubscriptionInput struct { type AddSourceIdentifierToSubscriptionOutput struct { - // Contains the results of a successful invocation of the - // DescribeEventSubscriptions action. + // Contains the results of a successful invocation of the DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_AddTagsToResource.go b/service/neptune/api_op_AddTagsToResource.go index 8c282e3ceb6..a78fd8c03e9 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)]. + // + // [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 3ca8e1f4c0c..ec27ad62085 100644 --- a/service/neptune/api_op_ApplyPendingMaintenanceAction.go +++ b/service/neptune/api_op_ApplyPendingMaintenanceAction.go @@ -30,26 +30,32 @@ 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 + // The pending maintenance action to apply to this resource. + // + // Valid values: 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: + // 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. // // 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)]. + // + // [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 bf399e12a54..2c114c193db 100644 --- a/service/neptune/api_op_CopyDBClusterParameterGroup.go +++ b/service/neptune/api_op_CopyDBClusterParameterGroup.go @@ -30,17 +30,22 @@ 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: + // parameter group. For information about creating an ARN, see [Constructing an Amazon Resource Name (ARN)]. + // + // 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 . // + // [Constructing an Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing + // // This member is required. SourceDBClusterParameterGroupIdentifier *string @@ -49,11 +54,18 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. TargetDBClusterParameterGroupDescription *string - // The identifier for the copied DB cluster parameter group. Constraints: + // 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 + // // Example: my-cluster-param-group1 // // This member is required. @@ -67,9 +79,9 @@ type CopyDBClusterParameterGroupInput struct { type CopyDBClusterParameterGroupOutput struct { - // Contains the details of an Amazon Neptune DB cluster parameter group. This data - // type is used as a response element in the DescribeDBClusterParameterGroups - // action. + // Contains the details of an Amazon Neptune 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/neptune/api_op_CopyDBClusterSnapshot.go b/service/neptune/api_op_CopyDBClusterSnapshot.go index fcd65ce3736..cfe358c1268 100644 --- a/service/neptune/api_op_CopyDBClusterSnapshot.go +++ b/service/neptune/api_op_CopyDBClusterSnapshot.go @@ -13,9 +13,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error) { if params == nil { params = &CopyDBClusterSnapshotInput{} @@ -34,19 +36,30 @@ func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBCluste type CopyDBClusterSnapshotInput struct { // The identifier of the DB cluster snapshot to copy. This parameter is not - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - 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: + // 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. + // // Example: my-cluster-snapshot2 // // This member is required. @@ -58,17 +71,23 @@ type CopyDBClusterSnapshotInput struct { // The Amazon Amazon KMS key ID for an encrypted DB 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 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 - // 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 . + // 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 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 . + // // 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. - // If you try to copy an unencrypted DB cluster snapshot and specify a value for - // the KmsKeyId parameter, an error is returned. + // Region. + // + // You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you + // try to copy an unencrypted DB cluster snapshot and specify a value for the + // KmsKeyId parameter, an error is returned. KmsKeyId *string // Not currently supported. @@ -90,8 +109,9 @@ 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 43ba7e46ebc..2c1be8c1702 100644 --- a/service/neptune/api_op_CopyDBParameterGroup.go +++ b/service/neptune/api_op_CopyDBParameterGroup.go @@ -30,12 +30,17 @@ 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: + // creating an ARN, see [Constructing an Amazon Resource Name (ARN)]. + // + // 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. // + // [Constructing an Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing + // // This member is required. SourceDBParameterGroupIdentifier *string @@ -44,11 +49,18 @@ type CopyDBParameterGroupInput struct { // This member is required. TargetDBParameterGroupDescription *string - // The identifier for the copied DB parameter group. Constraints: + // 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. + // // Example: my-db-parameter-group // // This member is required. @@ -62,8 +74,9 @@ type CopyDBParameterGroupInput struct { type CopyDBParameterGroupOutput struct { - // Contains the details of an Amazon Neptune DB parameter group. This data type is - // used as a response element in the DescribeDBParameterGroups action. + // Contains the details of an Amazon Neptune 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/neptune/api_op_CreateDBCluster.go b/service/neptune/api_op_CreateDBCluster.go index 3a817c9bf08..9e9d15f0e98 100644 --- a/service/neptune/api_op_CreateDBCluster.go +++ b/service/neptune/api_op_CreateDBCluster.go @@ -13,13 +13,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Amazon Neptune DB cluster. You can use the -// ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica -// of another DB cluster or Amazon Neptune DB instance. Note that when you create a -// 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 . +// Creates a new Amazon Neptune DB cluster. +// +// You can use the ReplicationSourceIdentifier parameter to create the DB cluster +// as a Read Replica of another DB cluster or Amazon Neptune DB instance. +// +// Note that when you create a 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 . func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*Options)) (*CreateDBClusterOutput, error) { if params == nil { params = &CreateDBClusterInput{} @@ -38,17 +40,23 @@ func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInp 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. + // // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string - // The name of the database engine to be used for this DB cluster. Valid Values: - // neptune + // The name of the database engine to be used for this DB cluster. + // + // Valid Values: neptune // // This member is required. Engine *string @@ -58,25 +66,36 @@ type CreateDBClusterInput struct { AvailabilityZones []string // The number of days for which automated backups are retained. You must specify a - // minimum value of 1. Default: 1 Constraints: + // minimum value of 1. + // + // Default: 1 + // + // Constraints: + // // - Must be a value from 1 to 35 BackupRetentionPeriod *int32 - // (Not supported by Neptune) + // (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: + // 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 @@ -91,16 +110,20 @@ type CreateDBClusterInput struct { // A list of the log types that this DB cluster should export to CloudWatch Logs. // Valid log types are: audit (to publish audit logs) and slowquery (to publish - // slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs (https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html) - // . + // slow-query logs). See [Publishing Neptune logs to Amazon CloudWatch logs]. + // + // [Publishing Neptune logs to Amazon CloudWatch logs]: https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html EnableCloudwatchLogsExports []string // 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. + // // Example: 1.0.2.1 EngineVersion *string @@ -108,22 +131,29 @@ type CreateDBClusterInput struct { // added. GlobalClusterIdentifier *string - // The Amazon KMS key identifier for an encrypted DB cluster. The KMS key - // identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you - // 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 : + // The Amazon KMS key identifier for an encrypted DB cluster. + // + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you 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. + // 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. @@ -132,10 +162,11 @@ type CreateDBClusterInput struct { // Not supported by Neptune. MasterUsername *string - // (Not supported by Neptune) + // (Not supported by Neptune) OptionGroupName *string // The port number on which the instances in the DB cluster accept connections. + // // Default: 8182 Port *int32 @@ -143,32 +174,50 @@ type CreateDBClusterInput struct { PreSignedUrl *string // 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 Neptune Maintenance Window (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) - // in the Amazon Neptune User Guide. Constraints: + // 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 [Neptune Maintenance Window]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. + // + // [Neptune Maintenance Window]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window 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 Neptune Maintenance Window (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) - // in the Amazon Neptune User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // 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 [Neptune Maintenance Window]in the Amazon Neptune User Guide. + // + // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // // Constraints: Minimum 30-minute window. + // + // [Neptune Maintenance Window]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window PreferredMaintenanceWindow *string // The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this // DB cluster is created as a Read Replica. 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) - // in the Amazon Neptune User Guide. + // Contains the scaling configuration of a Neptune Serverless DB cluster. + // + // For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. + // + // [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // The AWS region the resource is in. The presigned URL will be created with this @@ -178,10 +227,16 @@ type CreateDBClusterInput struct { // Specifies whether the DB cluster is encrypted. StorageEncrypted *bool - // The storage type to associate with the DB cluster. Valid Values: + // The storage type to associate with the DB cluster. + // + // Valid Values: + // // - standard | iopt1 + // // Default: + // // - standard + // // When you create a Neptune cluster with the storage type set to iopt1 , the // storage type is returned in the response. The storage type isn't returned when // you set it to standard . @@ -202,8 +257,9 @@ type CreateDBClusterInput struct { type CreateDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_CreateDBClusterEndpoint.go b/service/neptune/api_op_CreateDBClusterEndpoint.go index 009d458690c..cbe536e40a4 100644 --- a/service/neptune/api_op_CreateDBClusterEndpoint.go +++ b/service/neptune/api_op_CreateDBClusterEndpoint.go @@ -64,9 +64,13 @@ 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 // // For the data structure that represents Amazon Neptune DB instance endpoints, diff --git a/service/neptune/api_op_CreateDBClusterParameterGroup.go b/service/neptune/api_op_CreateDBClusterParameterGroup.go index 5fbe7fc487f..2c27a4ca01c 100644 --- a/service/neptune/api_op_CreateDBClusterParameterGroup.go +++ b/service/neptune/api_op_CreateDBClusterParameterGroup.go @@ -11,26 +11,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB cluster parameter group. Parameters in a DB cluster parameter -// group apply to all of the instances in a DB cluster. A DB cluster parameter -// 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 -// 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. +// Creates a new DB cluster parameter group. +// +// Parameters in a DB cluster parameter group apply to all of the instances in a +// DB cluster. +// +// A DB cluster parameter 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 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]or the DescribeDBClusterParameters command to +// verify that your DB cluster parameter group has been created or modified. +// +// [Amazon Neptune console]: https://console.aws.amazon.com/rds/ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error) { if params == nil { params = &CreateDBClusterParameterGroupInput{} @@ -48,8 +53,12 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea type CreateDBClusterParameterGroupInput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. // // This member is required. @@ -76,9 +85,9 @@ type CreateDBClusterParameterGroupInput struct { type CreateDBClusterParameterGroupOutput struct { - // Contains the details of an Amazon Neptune DB cluster parameter group. This data - // type is used as a response element in the DescribeDBClusterParameterGroups - // action. + // Contains the details of an Amazon Neptune 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/neptune/api_op_CreateDBClusterSnapshot.go b/service/neptune/api_op_CreateDBClusterSnapshot.go index 59cc595b8a1..e9575427227 100644 --- a/service/neptune/api_op_CreateDBClusterSnapshot.go +++ b/service/neptune/api_op_CreateDBClusterSnapshot.go @@ -30,18 +30,28 @@ 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: + // not case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DBCluster. + // // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string // The identifier of the DB cluster snapshot. This parameter is stored as a - // lowercase string. Constraints: + // 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. + // // Example: my-cluster1-snapshot1 // // This member is required. @@ -55,8 +65,9 @@ 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 30925b5cc2e..36ea7e1ce08 100644 --- a/service/neptune/api_op_CreateDBInstance.go +++ b/service/neptune/api_op_CreateDBInstance.go @@ -29,8 +29,11 @@ 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 + // The identifier of the DB cluster that the instance will belong to. + // + // For information on creating a DB cluster, see CreateDBCluster. + // + // Type: String // // This member is required. DBClusterIdentifier *string @@ -42,17 +45,23 @@ type CreateDBInstanceInput struct { DBInstanceClass *string // 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. + // // Example: mydbinstance // // This member is required. DBInstanceIdentifier *string - // The name of the database engine to be used for this instance. Valid Values: - // neptune + // The name of the database engine to be used for this instance. + // + // Valid Values: neptune // // This member is required. Engine *string @@ -61,24 +70,38 @@ type CreateDBInstanceInput struct { AllocatedStorage *int32 // Indicates that minor engine upgrades are applied automatically to the DB - // instance during the maintenance window. Default: true + // instance during the maintenance window. + // + // Default: true AutoMinorVersionUpgrade *bool - // 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. + // 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. 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: + // 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) + // (Not supported by Neptune) CharacterSetName *string // True to copy all tags from the DB instance to snapshots of the DB instance, and @@ -90,25 +113,35 @@ 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: + // 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 DBParameterGroupName *string - // A list of DB security groups to associate with this DB instance. Default: The - // default DB security group for the database engine. + // A list of DB security groups to associate with this DB instance. + // + // Default: The default DB security group for the database engine. DBSecurityGroups []string - // A DB subnet group to associate with this DB instance. If there is no DB subnet - // group, then it is a non-VPC DB instance. + // A DB subnet group to associate with this DB instance. + // + // If there is no DB subnet group, then it is a non-VPC DB instance. 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 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]. + // + // DB instances in a DB cluster can be deleted even when deletion protection is // enabled in their parent DB cluster. + // + // [Deleting a DB Instance]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html DeletionProtection *bool // Specify the Active Directory Domain to create the instance in. @@ -124,7 +157,7 @@ type CreateDBInstanceInput struct { // Not supported by Neptune (ignored). EnableIAMDatabaseAuthentication *bool - // (Not supported by Neptune) + // (Not supported by Neptune) EnablePerformanceInsights *bool // The version number of the database engine to use. Currently, setting this @@ -135,21 +168,25 @@ type CreateDBInstanceInput struct { // initially allocated for the DB instance. Iops *int32 - // The Amazon KMS key identifier for an encrypted DB instance. The KMS key - // identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you - // are creating a DB instance with the same Amazon account that owns the KMS - // 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 - // 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. + // The Amazon KMS key identifier for an encrypted DB instance. + // + // The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption + // key. If you are creating a DB instance with the same Amazon account that owns + // the KMS 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 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. @@ -160,46 +197,66 @@ type CreateDBInstanceInput struct { // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB instance. To disable collecting Enhanced Monitoring - // metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then - // you must also set MonitoringInterval to a value other than 0. Valid Values: 0, - // 1, 5, 10, 15, 30, 60 + // metrics, specify 0. The default is 0. + // + // If MonitoringRoleArn is specified, then you must also set MonitoringInterval to + // a value other than 0. + // + // Valid Values: 0, 1, 5, 10, 15, 30, 60 MonitoringInterval *int32 // 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 // AvailabilityZone parameter if the MultiAZ parameter is set to true. MultiAZ *bool - // (Not supported by Neptune) + // (Not supported by Neptune) OptionGroupName *string - // (Not supported by Neptune) + // (Not supported by Neptune) 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 . - // Default: 8182 Type: Integer + // The port number on which the database accepts connections. + // + // Not applicable. The 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. + // 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 - // primary instance after a failure of the existing primary instance. Default: 1 + // primary instance after a failure of the existing primary instance. + // + // Default: 1 + // // Valid Values: 0 - 15 PromotionTier *int32 @@ -208,13 +265,17 @@ type CreateDBInstanceInput struct { // Deprecated: This member has been deprecated. PubliclyAccessible *bool - // 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 + // 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 StorageEncrypted *bool - // Specifies the storage type to be associated with the DB instance. Not - // applicable. Storage is managed by the DB Cluster. + // Specifies the storage type to be associated with the DB instance. + // + // Not applicable. Storage is managed by the DB Cluster. StorageType *string // The tags to assign to the new instance. @@ -230,10 +291,12 @@ type CreateDBInstanceInput struct { // The time zone of the DB instance. Timezone *string - // 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. + // 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. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -241,8 +304,9 @@ 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 90e358b9880..1bae696d1b3 100644 --- a/service/neptune/api_op_CreateDBParameterGroup.go +++ b/service/neptune/api_op_CreateDBParameterGroup.go @@ -11,23 +11,27 @@ 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 -// 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. -// 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. After you create 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 -// Neptune to fully complete the create action before the 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 your -// DB parameter group has been created or modified. +// 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. 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. +// +// After you create 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 Neptune to fully complete the create +// action before the 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 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{} @@ -53,10 +57,16 @@ type CreateDBParameterGroupInput struct { // This member is required. DBParameterGroupFamily *string - // The name of the DB parameter group. Constraints: + // 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. // // This member is required. @@ -75,8 +85,9 @@ type CreateDBParameterGroupInput struct { type CreateDBParameterGroupOutput struct { - // Contains the details of an Amazon Neptune DB parameter group. This data type is - // used as a response element in the DescribeDBParameterGroups action. + // Contains the details of an Amazon Neptune 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/neptune/api_op_CreateDBSubnetGroup.go b/service/neptune/api_op_CreateDBSubnetGroup.go index e943249fae7..402ea98237a 100644 --- a/service/neptune/api_op_CreateDBSubnetGroup.go +++ b/service/neptune/api_op_CreateDBSubnetGroup.go @@ -36,8 +36,11 @@ type CreateDBSubnetGroupInput struct { DBSubnetGroupDescription *string // 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. Example: mySubnetgroup + // underscores, spaces, or hyphens. Must not be default. + // + // Example: mySubnetgroup // // This member is required. DBSubnetGroupName *string @@ -55,8 +58,9 @@ type CreateDBSubnetGroupInput struct { type CreateDBSubnetGroupOutput struct { - // Contains the details of an Amazon Neptune DB subnet group. This data type is - // used as a response element in the DescribeDBSubnetGroups action. + // Contains the details of an Amazon Neptune 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/neptune/api_op_CreateEventSubscription.go b/service/neptune/api_op_CreateEventSubscription.go index e879813e1d6..5d1e66027d0 100644 --- a/service/neptune/api_op_CreateEventSubscription.go +++ b/service/neptune/api_op_CreateEventSubscription.go @@ -14,19 +14,21 @@ import ( // Creates an event notification subscription. This action requires a topic ARN // (Amazon Resource Name) created by either the Neptune 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) you want to be notified of, provide a -// list of Neptune sources (SourceIds) that triggers the events, and provide a list -// of event categories (EventCategories) for events 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 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 Neptune sources. If you do not specify either the SourceType nor the -// SourceIdentifier, you are notified of events generated from all Neptune sources -// belonging to your customer account. +// and subscribe to the topic. The ARN is displayed in the SNS console. +// +// You can specify the type of source (SourceType) you want to be notified of, +// provide a list of Neptune sources (SourceIds) that triggers the events, and +// provide a list of event categories (EventCategories) for events 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 +// 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 Neptune sources. If you do not specify either the SourceType +// nor the SourceIdentifier, you are notified of events generated from all Neptune +// 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{} @@ -50,17 +52,18 @@ type CreateEventSubscriptionInput struct { // This member is required. SnsTopicArn *string - // The name of the subscription. Constraints: The name must be less than 255 - // characters. + // The name of the subscription. + // + // Constraints: The name must be less than 255 characters. // // This member is required. SubscriptionName *string - // A Boolean value; set to true to activate the subscription, set to false to + // A Boolean value; set to true to activate the subscription, set to false to // create the subscription but not active it. Enabled *bool - // A list of event categories for a SourceType that you want to subscribe to. You + // A list of event categories for a SourceType that you want to subscribe to. You // can see a list of the categories for a given SourceType by using the // DescribeEventCategories action. EventCategories []string @@ -68,23 +71,30 @@ type CreateEventSubscriptionInput struct { // 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: + // 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 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 - // values: db-instance | db-cluster | db-parameter-group | db-security-group | - // db-snapshot | db-cluster-snapshot + // 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 // The tags to be applied to the new event subscription. @@ -95,8 +105,7 @@ type CreateEventSubscriptionInput struct { type CreateEventSubscriptionOutput struct { - // Contains the results of a successful invocation of the - // DescribeEventSubscriptions action. + // Contains the results of a successful invocation of the DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_CreateGlobalCluster.go b/service/neptune/api_op_CreateGlobalCluster.go index 74ce10f8152..0fdc61f3020 100644 --- a/service/neptune/api_op_CreateGlobalCluster.go +++ b/service/neptune/api_op_CreateGlobalCluster.go @@ -14,11 +14,12 @@ import ( // Creates a Neptune global database spread across multiple Amazon Regions. The // global database contains a single primary cluster with read-write capability, // and read-only secondary clusters that receive data from the primary cluster -// through high-speed replication performed by the Neptune storage subsystem. You -// can create a global database that is initially empty, and then add a primary -// cluster and secondary clusters to it, or you can specify an existing Neptune -// cluster during the create operation to become the primary cluster of the global -// database. +// through high-speed replication performed by the Neptune storage subsystem. +// +// You can create a global database that is initially empty, and then add a +// primary cluster and secondary clusters to it, or you can specify an existing +// Neptune cluster during the create operation to become the primary cluster of the +// global database. func (c *Client) CreateGlobalCluster(ctx context.Context, params *CreateGlobalClusterInput, optFns ...func(*Options)) (*CreateGlobalClusterOutput, error) { if params == nil { params = &CreateGlobalClusterInput{} @@ -45,12 +46,14 @@ type CreateGlobalClusterInput struct { // 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: - // 1.2.0.0 or above. + // The Neptune engine version to be used by the global database. + // + // Valid values: 1.2.0.0 or above. EngineVersion *string // (Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to @@ -65,10 +68,9 @@ 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 - // RemoveFromGlobalCluster actions. + // 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 RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DeleteDBCluster.go b/service/neptune/api_op_DeleteDBCluster.go index bb57af25e77..2f8875a30dc 100644 --- a/service/neptune/api_op_DeleteDBCluster.go +++ b/service/neptune/api_op_DeleteDBCluster.go @@ -14,9 +14,10 @@ import ( // 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 . +// 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{} @@ -35,25 +36,39 @@ 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: + // 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 - // the SkipFinalShapshot parameter to true results in an error. Constraints: + // The DB cluster snapshot identifier of the new DB cluster snapshot 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, 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. + // 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. + // // You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is - // false . Default: false + // false . + // + // Default: false SkipFinalSnapshot *bool noSmithyDocumentSerde @@ -61,8 +76,9 @@ type DeleteDBClusterInput struct { type DeleteDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DeleteDBClusterEndpoint.go b/service/neptune/api_op_DeleteDBClusterEndpoint.go index 5b01f937c62..9f349087a20 100644 --- a/service/neptune/api_op_DeleteDBClusterEndpoint.go +++ b/service/neptune/api_op_DeleteDBClusterEndpoint.go @@ -40,9 +40,13 @@ 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 // // For the data structure that represents Amazon RDS DB instance endpoints, see diff --git a/service/neptune/api_op_DeleteDBClusterParameterGroup.go b/service/neptune/api_op_DeleteDBClusterParameterGroup.go index 3d5467b08fd..2f6d2b25cdc 100644 --- a/service/neptune/api_op_DeleteDBClusterParameterGroup.go +++ b/service/neptune/api_op_DeleteDBClusterParameterGroup.go @@ -29,9 +29,14 @@ func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *Dele type DeleteDBClusterParameterGroupInput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. // // This member is required. diff --git a/service/neptune/api_op_DeleteDBClusterSnapshot.go b/service/neptune/api_op_DeleteDBClusterSnapshot.go index 86c955f4bc6..cbe587408b9 100644 --- a/service/neptune/api_op_DeleteDBClusterSnapshot.go +++ b/service/neptune/api_op_DeleteDBClusterSnapshot.go @@ -12,8 +12,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. +// operation is terminated. +// +// The DB cluster snapshot must be in the available state to be deleted. func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBClusterSnapshotInput, optFns ...func(*Options)) (*DeleteDBClusterSnapshotOutput, error) { if params == nil { params = &DeleteDBClusterSnapshotInput{} @@ -31,8 +32,10 @@ func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBCl type DeleteDBClusterSnapshotInput struct { - // The identifier of the DB cluster snapshot to delete. Constraints: Must be the - // name of an existing DB cluster snapshot in the available state. + // The identifier of the DB cluster snapshot to delete. + // + // Constraints: Must be the name of an existing DB cluster snapshot in the + // available state. // // This member is required. DBClusterSnapshotIdentifier *string @@ -42,8 +45,9 @@ 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 afc8b8049c4..8af1352ff44 100644 --- a/service/neptune/api_op_DeleteDBInstance.go +++ b/service/neptune/api_op_DeleteDBInstance.go @@ -14,15 +14,19 @@ import ( // The DeleteDBInstance action deletes a previously provisioned DB instance. When // you delete a DB instance, all automated backups for that instance are deleted // and can't be recovered. Manual DB snapshots of the DB instance to be deleted by -// DeleteDBInstance are not deleted. If you request a final DB snapshot the status -// 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 , +// DeleteDBInstance are not deleted. +// +// If you request a final DB snapshot the status 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 -// enabled. +// 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 { params = &DeleteDBInstanceInput{} @@ -41,29 +45,46 @@ func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceI type DeleteDBInstanceInput struct { // The DB instance identifier for the DB instance to be deleted. This parameter - // isn't case-sensitive. Constraints: + // isn't case-sensitive. + // + // Constraints: + // // - 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: + // 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 + // Determines whether a final DB snapshot is created before the DB instance is // deleted. If true is specified, no DBSnapshot is created. If false is specified, - // a DB snapshot is created before the DB instance is deleted. Note that when a DB - // instance is in a failure state and has a status of 'failed', - // '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 + // a DB snapshot is created before the DB instance is deleted. + // + // Note that when a DB instance is in a failure state and has a status of + // 'failed', '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 *bool noSmithyDocumentSerde @@ -71,8 +92,9 @@ 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 404b7f99230..8950b307fe4 100644 --- a/service/neptune/api_op_DeleteDBParameterGroup.go +++ b/service/neptune/api_op_DeleteDBParameterGroup.go @@ -29,9 +29,14 @@ func (c *Client) DeleteDBParameterGroup(ctx context.Context, params *DeleteDBPar type DeleteDBParameterGroupInput struct { - // The name of the DB parameter group. Constraints: + // 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 // // This member is required. diff --git a/service/neptune/api_op_DeleteDBSubnetGroup.go b/service/neptune/api_op_DeleteDBSubnetGroup.go index 924d1c32d3b..2e19085da16 100644 --- a/service/neptune/api_op_DeleteDBSubnetGroup.go +++ b/service/neptune/api_op_DeleteDBSubnetGroup.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a DB subnet group. The specified database subnet group must not be -// associated with any DB instances. +// Deletes a DB subnet group. +// +// The specified database subnet group must not be associated with any DB +// instances. func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnetGroupInput, optFns ...func(*Options)) (*DeleteDBSubnetGroupOutput, error) { if params == nil { params = &DeleteDBSubnetGroupInput{} @@ -29,9 +31,16 @@ func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnet type DeleteDBSubnetGroupInput struct { - // The name of the database subnet group to delete. You can't delete the default - // subnet group. Constraints: Constraints: Must match the name of an existing - // DBSubnetGroup. Must not be default. Example: mySubnetgroup + // The name of the database subnet group to delete. + // + // You can't delete the default subnet group. + // + // Constraints: + // + // Constraints: Must match the name of an existing DBSubnetGroup. Must not be + // default. + // + // Example: mySubnetgroup // // This member is required. DBSubnetGroupName *string diff --git a/service/neptune/api_op_DeleteEventSubscription.go b/service/neptune/api_op_DeleteEventSubscription.go index f710227af0e..2f972791c80 100644 --- a/service/neptune/api_op_DeleteEventSubscription.go +++ b/service/neptune/api_op_DeleteEventSubscription.go @@ -39,8 +39,7 @@ type DeleteEventSubscriptionInput struct { type DeleteEventSubscriptionOutput struct { - // Contains the results of a successful invocation of the - // DescribeEventSubscriptions action. + // Contains the results of a successful invocation of the DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DeleteGlobalCluster.go b/service/neptune/api_op_DeleteGlobalCluster.go index 402b5363175..107ad6c42a3 100644 --- a/service/neptune/api_op_DeleteGlobalCluster.go +++ b/service/neptune/api_op_DeleteGlobalCluster.go @@ -40,10 +40,9 @@ 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 - // RemoveFromGlobalCluster actions. + // 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 RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBClusterEndpoints.go b/service/neptune/api_op_DescribeDBClusterEndpoints.go index 939b2845233..f495492d7ed 100644 --- a/service/neptune/api_op_DescribeDBClusterEndpoints.go +++ b/service/neptune/api_op_DescribeDBClusterEndpoints.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about endpoints for an Amazon Neptune DB cluster. This -// operation can also return information for Amazon RDS clusters and Amazon DocDB -// clusters. +// Returns information about endpoints for an Amazon Neptune DB cluster. +// +// This operation can also return information for Amazon RDS clusters and Amazon +// DocDB clusters. func (c *Client) DescribeDBClusterEndpoints(ctx context.Context, params *DescribeDBClusterEndpointsInput, optFns ...func(*Options)) (*DescribeDBClusterEndpointsOutput, error) { if params == nil { params = &DescribeDBClusterEndpointsInput{} @@ -50,14 +51,17 @@ type DescribeDBClusterEndpointsInput struct { // more of: available , creating , deleting , inactive , modifying . Filters []types.Filter - // An optional pagination token provided by a previous DescribeDBClusterEndpoints + // 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 . 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 you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -70,7 +74,7 @@ type DescribeDBClusterEndpointsOutput struct { // any filter conditions. DBClusterEndpoints []types.DBClusterEndpoint - // An optional pagination token provided by a previous DescribeDBClusterEndpoints + // 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 . Marker *string @@ -173,7 +177,10 @@ var _ DescribeDBClusterEndpointsAPIClient = (*Client)(nil) type DescribeDBClusterEndpointsPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/neptune/api_op_DescribeDBClusterParameterGroups.go b/service/neptune/api_op_DescribeDBClusterParameterGroups.go index bfa35891b59..7b5958d5ca4 100644 --- a/service/neptune/api_op_DescribeDBClusterParameterGroups.go +++ b/service/neptune/api_op_DescribeDBClusterParameterGroups.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of DBClusterParameterGroup descriptions. If a +// 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. func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *DescribeDBClusterParameterGroupsInput, optFns ...func(*Options)) (*DescribeDBClusterParameterGroupsOutput, error) { @@ -32,23 +33,28 @@ func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *D 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. DBClusterParameterGroupName *string // This parameter is not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -59,7 +65,7 @@ type DescribeDBClusterParameterGroupsOutput struct { // A list of DB cluster parameter groups. DBClusterParameterGroups []types.DBClusterParameterGroup - // An optional pagination token provided by a previous + // 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 . @@ -161,10 +167,13 @@ var _ DescribeDBClusterParameterGroupsAPIClient = (*Client)(nil) // DescribeDBClusterParameterGroupsPaginatorOptions is the paginator options for // DescribeDBClusterParameterGroups type DescribeDBClusterParameterGroupsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeDBClusterParameters.go b/service/neptune/api_op_DescribeDBClusterParameters.go index 11822ffdb6d..f22950c0470 100644 --- a/service/neptune/api_op_DescribeDBClusterParameters.go +++ b/service/neptune/api_op_DescribeDBClusterParameters.go @@ -30,7 +30,10 @@ func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *Descri type DescribeDBClusterParametersInput struct { // The name of a specific DB cluster parameter group to return parameter details - // for. Constraints: + // for. + // + // Constraints: + // // - If supplied, must match the name of an existing DBClusterParameterGroup. // // This member is required. @@ -39,18 +42,21 @@ type DescribeDBClusterParametersInput struct { // This parameter is not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous DescribeDBClusterParameters + // 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 . 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. + // 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. MaxRecords *int32 - // A value that indicates to return only parameters for a specific source. + // A value that indicates to return only parameters for a specific source. // Parameter sources can be engine , service , or customer . Source *string @@ -59,9 +65,10 @@ type DescribeDBClusterParametersInput struct { 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 . + // 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 . Marker *string // Provides a list of parameters for the DB cluster parameter group. @@ -163,10 +170,13 @@ var _ DescribeDBClusterParametersAPIClient = (*Client)(nil) // DescribeDBClusterParametersPaginatorOptions is the paginator options for // DescribeDBClusterParameters type DescribeDBClusterParametersPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go b/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go index 127a851edbb..982d7b80d1f 100644 --- a/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go +++ b/service/neptune/api_op_DescribeDBClusterSnapshotAttributes.go @@ -12,15 +12,18 @@ import ( ) // Returns a list of DB cluster snapshot attribute names and values for a manual -// DB cluster snapshot. When sharing snapshots with other Amazon accounts, +// 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. +// 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 ModifyDBClusterSnapshotAttributeAPI action. func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotAttributesOutput, error) { if params == nil { params = &DescribeDBClusterSnapshotAttributesInput{} @@ -48,11 +51,11 @@ type DescribeDBClusterSnapshotAttributesInput struct { type DescribeDBClusterSnapshotAttributesOutput struct { - // Contains the results of a successful call to the - // DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot - // attributes are used to authorize other Amazon accounts to copy or restore a - // manual DB cluster snapshot. For more information, see the - // ModifyDBClusterSnapshotAttribute API action. + // Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action. + // + // Manual DB cluster snapshot attributes are used to authorize other Amazon + // accounts to copy or restore a manual DB cluster snapshot. For more information, + // see the ModifyDBClusterSnapshotAttributeAPI action. DBClusterSnapshotAttributesResult *types.DBClusterSnapshotAttributesResult // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeDBClusterSnapshots.go b/service/neptune/api_op_DescribeDBClusterSnapshots.go index 2916d042bcf..8adb3f7b447 100644 --- a/service/neptune/api_op_DescribeDBClusterSnapshots.go +++ b/service/neptune/api_op_DescribeDBClusterSnapshots.go @@ -32,14 +32,21 @@ 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: + // parameter. This parameter is not case-sensitive. + // + // Constraints: + // // - 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: + // 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 @@ -49,15 +56,17 @@ type DescribeDBClusterSnapshotsInput struct { // 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. + // 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 ModifyDBClusterSnapshotAttributeAPI action. IncludeShared *bool // An optional pagination token provided by a previous DescribeDBClusterSnapshots @@ -68,26 +77,36 @@ type DescribeDBClusterSnapshotsInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // 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 . + // 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 @@ -98,9 +117,9 @@ type DescribeDBClusterSnapshotsOutput struct { // Provides a list of DB cluster snapshots for the user. DBClusterSnapshots []types.DBClusterSnapshot - // 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 . + // 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 . Marker *string // Metadata pertaining to the operation's result. @@ -202,7 +221,10 @@ type DescribeDBClusterSnapshotsPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeDBClusters.go b/service/neptune/api_op_DescribeDBClusters.go index 5ba6e726116..17d9b82e89c 100644 --- a/service/neptune/api_op_DescribeDBClusters.go +++ b/service/neptune/api_op_DescribeDBClusters.go @@ -12,6 +12,7 @@ import ( ) // 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) { @@ -33,29 +34,40 @@ 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: + // 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: + // 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 . + // 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 *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. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -168,7 +180,10 @@ type DescribeDBClustersPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeDBEngineVersions.go b/service/neptune/api_op_DescribeDBEngineVersions.go index 1d861ed0795..a3374a79ca6 100644 --- a/service/neptune/api_op_DescribeDBEngineVersions.go +++ b/service/neptune/api_op_DescribeDBEngineVersions.go @@ -30,7 +30,9 @@ func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeD type DescribeDBEngineVersionsInput struct { // The name of a specific DB parameter group family to return details for. + // // Constraints: + // // - If supplied, must match an existing DBParameterGroupFamily. DBParameterGroupFamily *string @@ -41,7 +43,9 @@ type DescribeDBEngineVersionsInput struct { // The database engine to return. Engine *string - // The database engine version to return. Example: 5.1.49 + // The database engine version to return. + // + // Example: 5.1.49 EngineVersion *string // Not currently supported. @@ -57,14 +61,17 @@ type DescribeDBEngineVersionsInput struct { // zones for each engine version. ListSupportedTimezones *bool - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string - // The maximum number of records to include in the response. If more than the + // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so that the following results can be retrieved. Default: 100 + // the response so that the following results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -73,10 +80,10 @@ type DescribeDBEngineVersionsInput struct { type DescribeDBEngineVersionsOutput struct { - // A list of DBEngineVersion elements. + // A list of DBEngineVersion elements. DBEngineVersions []types.DBEngineVersion - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -177,9 +184,12 @@ var _ DescribeDBEngineVersionsAPIClient = (*Client)(nil) // DescribeDBEngineVersionsPaginatorOptions is the paginator options for // DescribeDBEngineVersions type DescribeDBEngineVersionsPaginatorOptions struct { - // The maximum number of records to include in the response. If more than the + // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so that the following results can be retrieved. Default: 100 + // the response so that the following results can be retrieved. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/neptune/api_op_DescribeDBInstances.go b/service/neptune/api_op_DescribeDBInstances.go index 036a5864e06..e90b4453297 100644 --- a/service/neptune/api_op_DescribeDBInstances.go +++ b/service/neptune/api_op_DescribeDBInstances.go @@ -17,9 +17,10 @@ import ( "time" ) -// Returns information about provisioned instances, and supports pagination. This -// operation can also return information for Amazon RDS instances and Amazon DocDB -// instances. +// Returns information about provisioned instances, and supports pagination. +// +// This operation can also return information for Amazon RDS instances and Amazon +// DocDB instances. func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInstancesInput, optFns ...func(*Options)) (*DescribeDBInstancesOutput, error) { if params == nil { params = &DescribeDBInstancesInput{} @@ -39,30 +40,40 @@ 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: + // case-sensitive. + // + // Constraints: + // // - 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: + // 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: Filters []types.Filter - // An optional pagination token provided by a previous DescribeDBInstances + // 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 - // 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -70,10 +81,10 @@ type DescribeDBInstancesInput struct { type DescribeDBInstancesOutput struct { - // A list of DBInstance instances. + // A list of DBInstance instances. DBInstances []types.DBInstance - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -174,10 +185,13 @@ var _ DescribeDBInstancesAPIClient = (*Client)(nil) // DescribeDBInstancesPaginatorOptions is the paginator options for // DescribeDBInstances type DescribeDBInstancesPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -291,12 +305,13 @@ type DBInstanceAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) } @@ -598,12 +613,13 @@ type DBInstanceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) } diff --git a/service/neptune/api_op_DescribeDBParameterGroups.go b/service/neptune/api_op_DescribeDBParameterGroups.go index 16237f53255..0d3d370d283 100644 --- a/service/neptune/api_op_DescribeDBParameterGroups.go +++ b/service/neptune/api_op_DescribeDBParameterGroups.go @@ -31,7 +31,10 @@ 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: + // The name of a specific DB parameter group to return details for. + // + // Constraints: + // // - If supplied, must match the name of an existing DBClusterParameterGroup. DBParameterGroupName *string @@ -46,7 +49,10 @@ type DescribeDBParameterGroupsInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -161,7 +167,10 @@ type DescribeDBParameterGroupsPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeDBParameters.go b/service/neptune/api_op_DescribeDBParameters.go index d6bea3eec99..6521d75cc82 100644 --- a/service/neptune/api_op_DescribeDBParameters.go +++ b/service/neptune/api_op_DescribeDBParameters.go @@ -29,7 +29,10 @@ 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: + // The name of a specific DB parameter group to return details for. + // + // Constraints: + // // - If supplied, must match the name of an existing DBParameterGroup. // // This member is required. @@ -46,11 +49,17 @@ type DescribeDBParametersInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // The parameter types to return. Default: All parameter types returned Valid - // Values: user | system | engine-default + // The parameter types to return. + // + // Default: All parameter types returned + // + // Valid Values: user | system | engine-default Source *string noSmithyDocumentSerde @@ -165,7 +174,10 @@ type DescribeDBParametersPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeDBSubnetGroups.go b/service/neptune/api_op_DescribeDBSubnetGroups.go index 75405d3e67a..da3d453c287 100644 --- a/service/neptune/api_op_DescribeDBSubnetGroups.go +++ b/service/neptune/api_op_DescribeDBSubnetGroups.go @@ -13,8 +13,11 @@ 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]. +// +// [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{} @@ -38,15 +41,18 @@ type DescribeDBSubnetGroupsInput struct { // This parameter is not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous DescribeDBSubnetGroups + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -54,10 +60,10 @@ type DescribeDBSubnetGroupsInput struct { type DescribeDBSubnetGroupsOutput struct { - // A list of DBSubnetGroup instances. + // A list of DBSubnetGroup instances. DBSubnetGroups []types.DBSubnetGroup - // An optional pagination token provided by a previous request. If this parameter + // 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 . Marker *string @@ -158,10 +164,13 @@ var _ DescribeDBSubnetGroupsAPIClient = (*Client)(nil) // DescribeDBSubnetGroupsPaginatorOptions is the paginator options for // DescribeDBSubnetGroups type DescribeDBSubnetGroupsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go b/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go index 207088189b1..2cbb2a75a57 100644 --- a/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/neptune/api_op_DescribeEngineDefaultClusterParameters.go @@ -39,16 +39,19 @@ type DescribeEngineDefaultClusterParametersInput struct { // This parameter is not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -56,8 +59,7 @@ type DescribeEngineDefaultClusterParametersInput struct { type DescribeEngineDefaultClusterParametersOutput struct { - // Contains the result of a successful invocation of the - // DescribeEngineDefaultParameters action. + // Contains the result of a successful invocation of the DescribeEngineDefaultParameters action. EngineDefaults *types.EngineDefaults // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_DescribeEngineDefaultParameters.go b/service/neptune/api_op_DescribeEngineDefaultParameters.go index c9f2ea67fab..22727e478dd 100644 --- a/service/neptune/api_op_DescribeEngineDefaultParameters.go +++ b/service/neptune/api_op_DescribeEngineDefaultParameters.go @@ -38,16 +38,19 @@ type DescribeEngineDefaultParametersInput struct { // Not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous + // 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 . 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. + // 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. MaxRecords *int32 noSmithyDocumentSerde @@ -55,8 +58,7 @@ type DescribeEngineDefaultParametersInput struct { type DescribeEngineDefaultParametersOutput struct { - // Contains the result of a successful invocation of the - // DescribeEngineDefaultParameters action. + // Contains the result of a successful invocation of the DescribeEngineDefaultParameters action. EngineDefaults *types.EngineDefaults // Metadata pertaining to the operation's result. @@ -155,10 +157,13 @@ var _ DescribeEngineDefaultParametersAPIClient = (*Client)(nil) // DescribeEngineDefaultParametersPaginatorOptions is the paginator options for // DescribeEngineDefaultParameters type DescribeEngineDefaultParametersPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeEventCategories.go b/service/neptune/api_op_DescribeEventCategories.go index 2a7670d2faf..5ee9afb7ed8 100644 --- a/service/neptune/api_op_DescribeEventCategories.go +++ b/service/neptune/api_op_DescribeEventCategories.go @@ -33,8 +33,9 @@ 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 | db-snapshot + // The type of source that is generating the events. + // + // Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot SourceType *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_DescribeEventSubscriptions.go b/service/neptune/api_op_DescribeEventSubscriptions.go index 400d77c3eda..b57f746fcd3 100644 --- a/service/neptune/api_op_DescribeEventSubscriptions.go +++ b/service/neptune/api_op_DescribeEventSubscriptions.go @@ -13,8 +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. +// 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{} @@ -35,16 +36,19 @@ type DescribeEventSubscriptionsInput struct { // This parameter is not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous + // 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 . 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. + // 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. MaxRecords *int32 // The name of the event notification subscription you want to describe. @@ -58,7 +62,7 @@ type DescribeEventSubscriptionsOutput struct { // A list of EventSubscriptions data types. EventSubscriptionsList []types.EventSubscription - // An optional pagination token provided by a previous + // 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 . @@ -160,10 +164,13 @@ var _ DescribeEventSubscriptionsAPIClient = (*Client)(nil) // DescribeEventSubscriptionsPaginatorOptions is the paginator options for // DescribeEventSubscriptions type DescribeEventSubscriptionsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeEvents.go b/service/neptune/api_op_DescribeEvents.go index e52e922847e..ebb153fccb3 100644 --- a/service/neptune/api_op_DescribeEvents.go +++ b/service/neptune/api_op_DescribeEvents.go @@ -34,12 +34,17 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput type DescribeEventsInput struct { - // The number of minutes to retrieve events for. Default: 60 + // 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.] + // + // Example: 2009-07-08T18:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 EndTime *time.Time // A list of event categories that trigger notifications for a event notification @@ -49,27 +54,38 @@ type DescribeEventsInput struct { // This parameter is not currently supported. Filters []types.Filter - // An optional pagination token provided by a previous DescribeEvents request. If + // 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 *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. + // 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. MaxRecords *int32 // The identifier of the event source for which events are returned. If not - // specified, then all sources are included in the response. Constraints: + // 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. SourceIdentifier *string @@ -77,9 +93,12 @@ type DescribeEventsInput struct { // 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.] + // + // Example: 2009-07-08T18:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 StartTime *time.Time noSmithyDocumentSerde @@ -87,10 +106,10 @@ type DescribeEventsInput struct { type DescribeEventsOutput struct { - // A list of Event instances. + // A list of Event instances. Events []types.Event - // An optional pagination token provided by a previous Events request. If this + // 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 . Marker *string @@ -190,10 +209,13 @@ var _ DescribeEventsAPIClient = (*Client)(nil) // DescribeEventsPaginatorOptions is the paginator options for DescribeEvents type DescribeEventsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeGlobalClusters.go b/service/neptune/api_op_DescribeGlobalClusters.go index ef0f5e5d462..2c883505c69 100644 --- a/service/neptune/api_op_DescribeGlobalClusters.go +++ b/service/neptune/api_op_DescribeGlobalClusters.go @@ -32,8 +32,9 @@ type DescribeGlobalClustersInput struct { // The user-supplied DB cluster identifier. If this parameter is specified, only // information about the specified DB cluster is returned. This parameter is not - // case-sensitive. Constraints: If supplied, must match an existing DB cluster - // identifier. + // case-sensitive. + // + // Constraints: If supplied, must match an existing DB cluster identifier. GlobalClusterIdentifier *string // (Optional) A pagination token returned by a previous call to @@ -43,7 +44,10 @@ type DescribeGlobalClustersInput struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination marker token is included in - // the response that you can use to retrieve the remaining results. Default: 100 + // the response that you can use to retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -155,7 +159,10 @@ var _ DescribeGlobalClustersAPIClient = (*Client)(nil) type DescribeGlobalClustersPaginatorOptions struct { // The maximum number of records to include in the response. If more records exist // than the specified MaxRecords value, a pagination marker token is included in - // the response that you can use to retrieve the remaining results. Default: 100 + // the response that you can use to retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go b/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go index 96f4aa85716..578f25a25a5 100644 --- a/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/neptune/api_op_DescribeOrderableDBInstanceOptions.go @@ -49,16 +49,19 @@ type DescribeOrderableDBInstanceOptionsInput struct { // available offerings matching the specified license model. LicenseModel *string - // An optional pagination token provided by a previous + // 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 . 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. + // 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. MaxRecords *int32 // The VPC filter value. Specify this parameter to show only the available VPC or @@ -70,13 +73,13 @@ type DescribeOrderableDBInstanceOptionsInput struct { type DescribeOrderableDBInstanceOptionsOutput struct { - // An optional pagination token provided by a previous OrderableDBInstanceOptions + // 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 . Marker *string - // An OrderableDBInstanceOption structure containing information about orderable - // options for the DB instance. + // An OrderableDBInstanceOption structure containing information about orderable options for the DB + // instance. OrderableDBInstanceOptions []types.OrderableDBInstanceOption // Metadata pertaining to the operation's result. @@ -175,10 +178,13 @@ var _ DescribeOrderableDBInstanceOptionsAPIClient = (*Client)(nil) // DescribeOrderableDBInstanceOptionsPaginatorOptions is the paginator options for // DescribeOrderableDBInstanceOptions type DescribeOrderableDBInstanceOptionsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribePendingMaintenanceActions.go b/service/neptune/api_op_DescribePendingMaintenanceActions.go index 54cf1ec443f..b4dad5337b2 100644 --- a/service/neptune/api_op_DescribePendingMaintenanceActions.go +++ b/service/neptune/api_op_DescribePendingMaintenanceActions.go @@ -31,25 +31,32 @@ func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params * type DescribePendingMaintenanceActionsInput struct { // A filter that specifies one or more resources to return pending maintenance - // actions for. Supported filters: + // 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. Filters []types.Filter - // An optional pagination token provided by a previous + // 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 . 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. + // 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. MaxRecords *int32 // The ARN of a resource to return pending maintenance actions for. @@ -60,7 +67,7 @@ type DescribePendingMaintenanceActionsInput struct { type DescribePendingMaintenanceActionsOutput struct { - // An optional pagination token provided by a previous + // 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 . @@ -165,10 +172,13 @@ var _ DescribePendingMaintenanceActionsAPIClient = (*Client)(nil) // DescribePendingMaintenanceActionsPaginatorOptions is the paginator options for // DescribePendingMaintenanceActions type DescribePendingMaintenanceActionsPaginatorOptions 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 - // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptune/api_op_DescribeValidDBInstanceModifications.go b/service/neptune/api_op_DescribeValidDBInstanceModifications.go index 56260d61be7..7b11191f119 100644 --- a/service/neptune/api_op_DescribeValidDBInstanceModifications.go +++ b/service/neptune/api_op_DescribeValidDBInstanceModifications.go @@ -11,9 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// You can call DescribeValidDBInstanceModifications to learn what modifications -// you can make to your DB instance. You can use this information when you call -// ModifyDBInstance . +// You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You +// can use this information when you call ModifyDBInstance. func (c *Client) DescribeValidDBInstanceModifications(ctx context.Context, params *DescribeValidDBInstanceModificationsInput, optFns ...func(*Options)) (*DescribeValidDBInstanceModificationsOutput, error) { if params == nil { params = &DescribeValidDBInstanceModificationsInput{} @@ -42,9 +41,8 @@ type DescribeValidDBInstanceModificationsInput struct { 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 . + // Contains the result of a successful call to the DescribeValidDBInstanceModificationsaction. You can use this + // information when 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 71440a0d562..e4e63aef4a0 100644 --- a/service/neptune/api_op_FailoverDBCluster.go +++ b/service/neptune/api_op_FailoverDBCluster.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Forces a failover for a DB cluster. A failover for a DB cluster promotes one of -// the Read Replicas (read-only instances) in the DB cluster to be the primary -// instance (the cluster writer). Amazon Neptune will automatically fail over to a -// Read Replica, if one exists, when the primary instance fails. You can force a -// failover when you want to simulate a failure of a primary instance for testing. -// Because each instance in a DB cluster has its own endpoint address, you will -// need to clean up and re-establish any existing connections that use those -// endpoint addresses when the failover is complete. +// Forces a failover for a DB cluster. +// +// A failover for a DB cluster promotes one of the Read Replicas (read-only +// instances) in the DB cluster to be the primary instance (the cluster writer). +// +// Amazon Neptune will automatically fail over to a Read Replica, if one exists, +// when the primary instance fails. You can force a failover when you want to +// simulate a failure of a primary instance for testing. Because each instance in a +// DB cluster has its own endpoint address, you will need to clean up and +// re-establish any existing connections that use those endpoint addresses when the +// failover is complete. func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBClusterInput, optFns ...func(*Options)) (*FailoverDBClusterOutput, error) { if params == nil { params = &FailoverDBClusterInput{} @@ -37,13 +40,17 @@ func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBCluste type FailoverDBClusterInput struct { // A DB cluster identifier to force a failover for. This parameter is not - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - 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 . + // 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 . TargetDBInstanceIdentifier *string noSmithyDocumentSerde @@ -51,8 +58,9 @@ type FailoverDBClusterInput struct { type FailoverDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_FailoverGlobalCluster.go b/service/neptune/api_op_FailoverGlobalCluster.go index a4397724cfa..0b44de29446 100644 --- a/service/neptune/api_op_FailoverGlobalCluster.go +++ b/service/neptune/api_op_FailoverGlobalCluster.go @@ -11,16 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates the failover process for a Neptune global database. A failover for a -// Neptune 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 secondary DB cluster are switched. The selected -// secondary DB cluster assumes full read/write capabilities for the Neptune global -// database. This action applies only to Neptune global databases. This action is -// only intended for use on healthy Neptune global databases with healthy Neptune -// DB clusters and no region-wide outages, to test disaster recovery scenarios or -// to reconfigure the global database topology. +// Initiates the failover process for a Neptune global database. +// +// A failover for a Neptune 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 secondary DB cluster are +// switched. The selected secondary DB cluster assumes full read/write capabilities +// for the Neptune global database. +// +// This action applies only to Neptune global databases. This action is only +// intended for use on healthy Neptune global databases with healthy Neptune DB +// clusters and no region-wide outages, to test disaster recovery scenarios or to +// reconfigure the global database topology. func (c *Client) FailoverGlobalCluster(ctx context.Context, params *FailoverGlobalClusterInput, optFns ...func(*Options)) (*FailoverGlobalClusterOutput, error) { if params == nil { params = &FailoverGlobalClusterInput{} @@ -41,8 +44,9 @@ type FailoverGlobalClusterInput struct { // Identifier of the Neptune global database that should be failed over. The // identifier is the unique key assigned by the user when the Neptune global // database was created. In other words, it's the name of the global database that - // you want to fail over. Constraints: Must match the identifier of an existing - // Neptune global database. + // you want to fail over. + // + // Constraints: Must match the identifier of an existing Neptune global database. // // This member is required. GlobalClusterIdentifier *string @@ -58,10 +62,9 @@ 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 - // RemoveFromGlobalCluster actions. + // 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 RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ListTagsForResource.go b/service/neptune/api_op_ListTagsForResource.go index d67f761a45c..22170c3f2b9 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)]. + // + // [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 5bde1771e1e..a8c6d7f163e 100644 --- a/service/neptune/api_op_ModifyDBCluster.go +++ b/service/neptune/api_op_ModifyDBCluster.go @@ -32,41 +32,55 @@ func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInp type ModifyDBClusterInput struct { // The DB cluster identifier for the cluster being modified. This parameter is not - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DBCluster. // // This member is required. DBClusterIdentifier *string // A value that indicates whether upgrades between different major versions are - // allowed. Constraints: You must set the allow-major-version-upgrade flag when - // providing an EngineVersion parameter that uses a different major version than - // the DB cluster's current version. + // allowed. + // + // Constraints: You must set the allow-major-version-upgrade flag when providing + // an EngineVersion parameter that uses a different major version than 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 + // 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: + // minimum value of 1. + // + // Default: 1 + // + // Constraints: + // // - 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. See Using the CLI to publish Neptune - // audit logs to CloudWatch Logs (https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli) - // . + // CloudWatch Logs for a specific DB cluster. See [Using the CLI to publish Neptune audit logs to CloudWatch Logs]. + // + // [Using the CLI to publish Neptune audit logs to CloudWatch Logs]: https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli 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 @@ -74,11 +88,18 @@ 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 // changes aren't applied during the next maintenance window but instead are - // applied immediately. Default: The existing name setting Constraints: + // 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. DBInstanceParameterGroupName *string @@ -89,59 +110,92 @@ type ModifyDBClusterInput struct { DeletionProtection *bool // True to enable mapping of Amazon Identity and Access Management (IAM) accounts - // to database accounts, and otherwise false. Default: false + // 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 . + // + // For a list of valid engine versions, see [Engine Releases for Amazon Neptune], or call DescribeDBEngineVersions. + // + // [Engine Releases for Amazon Neptune]: https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html EngineVersion *string // Not supported by Neptune. MasterUserPassword *string // The new DB cluster identifier for the DB cluster when renaming a DB cluster. - // This value is stored as a lowercase string. Constraints: + // 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 NewDBClusterIdentifier *string - // Not supported by Neptune. + // Not supported by Neptune. OptionGroupName *string - // 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. + // 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. 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: + // 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 - // 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. + // 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 - // 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) - // in the Amazon Neptune User Guide. + // Contains the scaling configuration of a Neptune Serverless DB cluster. + // + // For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. + // + // [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // The storage type to associate with the DB cluster. Valid Values: + // The storage type to associate with the DB cluster. + // + // Valid Values: + // // - standard | iopt1 + // // Default: + // // - standard StorageType *string @@ -153,8 +207,9 @@ type ModifyDBClusterInput struct { type ModifyDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ModifyDBClusterEndpoint.go b/service/neptune/api_op_ModifyDBClusterEndpoint.go index e291f337a79..c1eb8fb28c7 100644 --- a/service/neptune/api_op_ModifyDBClusterEndpoint.go +++ b/service/neptune/api_op_ModifyDBClusterEndpoint.go @@ -51,9 +51,13 @@ 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 // // For the data structure that represents Amazon RDS DB instance endpoints, see diff --git a/service/neptune/api_op_ModifyDBClusterParameterGroup.go b/service/neptune/api_op_ModifyDBClusterParameterGroup.go index 04c7657f2f5..2dc9bc2172e 100644 --- a/service/neptune/api_op_ModifyDBClusterParameterGroup.go +++ b/service/neptune/api_op_ModifyDBClusterParameterGroup.go @@ -11,22 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a DB cluster parameter group. To modify more than +// 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 -// 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 or the DescribeDBClusterParameters -// command to verify that your DB cluster parameter group has been created or -// modified. +// 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 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 +// or the DescribeDBClusterParameterscommand to verify that your DB cluster parameter group has been created +// or modified. func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *ModifyDBClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyDBClusterParameterGroupOutput, error) { if params == nil { params = &ModifyDBClusterParameterGroupInput{} @@ -59,10 +62,16 @@ type ModifyDBClusterParameterGroupInput struct { type ModifyDBClusterParameterGroupOutput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. DBClusterParameterGroupName *string diff --git a/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go b/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go index 310650ad74b..fcd5a608cf9 100644 --- a/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/neptune/api_op_ModifyDBClusterSnapshotAttribute.go @@ -12,19 +12,22 @@ import ( ) // Adds an attribute and values to, or removes an attribute and values from, a -// manual DB cluster snapshot. To share a manual DB cluster snapshot with other -// Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd -// parameter to add a list of IDs of the Amazon 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 accounts. 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. 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 -// snapshot, or whether a manual DB cluster snapshot public or private, use the -// DescribeDBClusterSnapshotAttributes API action. +// manual DB cluster snapshot. +// +// To share a manual DB cluster snapshot with other Amazon accounts, specify +// restore as the AttributeName and use the ValuesToAdd parameter to add a list of +// IDs of the Amazon 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 accounts. 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. 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 snapshot, or whether a manual DB cluster snapshot public or private, use +// the DescribeDBClusterSnapshotAttributesAPI action. func (c *Client) ModifyDBClusterSnapshotAttribute(ctx context.Context, params *ModifyDBClusterSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBClusterSnapshotAttributeOutput, error) { if params == nil { params = &ModifyDBClusterSnapshotAttributeInput{} @@ -42,9 +45,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 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 +59,24 @@ 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 - // 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 + // 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 - // 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. + // 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. ValuesToRemove []string noSmithyDocumentSerde @@ -76,11 +84,11 @@ type ModifyDBClusterSnapshotAttributeInput struct { type ModifyDBClusterSnapshotAttributeOutput struct { - // Contains the results of a successful call to the - // DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot - // attributes are used to authorize other Amazon accounts to copy or restore a - // manual DB cluster snapshot. For more information, see the - // ModifyDBClusterSnapshotAttribute API action. + // Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action. + // + // Manual DB cluster snapshot attributes are used to authorize other Amazon + // accounts to copy or restore a manual DB cluster snapshot. For more information, + // see the ModifyDBClusterSnapshotAttributeAPI action. DBClusterSnapshotAttributesResult *types.DBClusterSnapshotAttributesResult // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ModifyDBInstance.go b/service/neptune/api_op_ModifyDBInstance.go index b03793a5126..50129a8be7c 100644 --- a/service/neptune/api_op_ModifyDBInstance.go +++ b/service/neptune/api_op_ModifyDBInstance.go @@ -13,8 +13,8 @@ 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 . +// the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications +// before you call ModifyDBInstance. func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error) { if params == nil { params = &ModifyDBInstanceInput{} @@ -33,7 +33,9 @@ func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceI type ModifyDBInstanceInput struct { // The DB instance identifier. This value is stored as a lowercase string. + // // Constraints: + // // - Must match the identifier of an existing DBInstance. // // This member is required. @@ -49,13 +51,16 @@ 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 - // window. Some parameter changes can cause an outage and are applied on the next - // call to RebootDBInstance , or the next failure reboot. Default: false + // PreferredMaintenanceWindow setting for the DB instance. + // + // If this parameter is set 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 ApplyImmediately *bool - // Indicates that minor version upgrades are applied automatically to the DB + // Indicates that minor version upgrades are applied automatically to the DB // instance during the maintenance window. Changing this parameter doesn't result // in an outage except in the following case and the change is asynchronously // applied as soon as possible. An outage will result if this parameter is set to @@ -64,8 +69,9 @@ 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 - // setting + // cluster. For more information, see ModifyDBCluster. + // + // Default: Uses existing setting BackupRetentionPeriod *int32 // Indicates the certificate that needs to be associated with the instance. @@ -80,10 +86,13 @@ type ModifyDBInstanceInput struct { 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 + // . 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 @@ -91,35 +100,51 @@ type ModifyDBInstanceInput struct { // immediately, but the actual parameter changes are not applied until you reboot // the instance without failover. The db instance will NOT be rebooted // automatically and the parameter changes will NOT be applied during the next - // maintenance window. Default: Uses existing setting Constraints: The DB parameter - // group must be in the same DB parameter group family as this DB instance. + // maintenance window. + // + // Default: Uses existing setting + // + // Constraints: The DB parameter group must be in the same DB parameter group + // family as this DB instance. DBParameterGroupName *string - // The port number on which the database accepts connections. The value of the - // DBPortNumber parameter must not match any of the port values specified for - // options in the option group for the DB instance. Your database will restart when - // you change the DBPortNumber value regardless of the value of the - // ApplyImmediately parameter. Default: 8182 + // The port number on which the database accepts connections. + // + // The value of the DBPortNumber parameter must not match any of the port values + // specified for options in the option group for the DB instance. + // + // Your database will restart when you change the DBPortNumber value regardless of + // the value of the ApplyImmediately parameter. + // + // Default: 8182 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. Constraints: + // soon as possible. + // + // Constraints: + // // - 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. Changing the subnet group causes an outage - // during the change. The change is applied during the next maintenance window, - // unless you specify true for the ApplyImmediately parameter. Constraints: If - // supplied, must match the name of an existing DBSubnetGroup. Example: - // mySubnetGroup + // your DB instance to a different VPC. + // + // Changing the subnet group causes an outage during the change. The change is + // applied during the next maintenance window, unless you specify true for the + // ApplyImmediately parameter. + // + // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // + // Example: mySubnetGroup 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 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]. + // + // [Deleting a DB Instance]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html DeletionProtection *bool // Not supported. @@ -129,24 +154,31 @@ type ModifyDBInstanceInput struct { DomainIAMRoleName *string // True to enable mapping of Amazon Identity and Access Management (IAM) accounts - // 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 + // 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 EnableIAMDatabaseAuthentication *bool - // (Not supported by Neptune) + // (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 - // release, use the ApplyPendingMaintenanceAction API. + // release, use the ApplyPendingMaintenanceActionAPI. EngineVersion *string // The new Provisioned IOPS (I/O operations per second) value for the 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 set - // to true for this request. Default: Uses existing setting + // to true for this request. + // + // Default: Uses existing setting Iops *int32 // Not supported by Neptune. @@ -157,15 +189,20 @@ type ModifyDBInstanceInput struct { // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB instance. To disable collecting Enhanced Monitoring - // metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then - // you must also set MonitoringInterval to a value other than 0. Valid Values: 0, - // 1, 5, 10, 15, 30, 60 + // metrics, specify 0. The default is 0. + // + // If MonitoringRoleArn is specified, then you must also set MonitoringInterval to + // a value other than 0. + // + // Valid Values: 0, 1, 5, 10, 15, 30, 60 MonitoringInterval *int32 // 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 @@ -174,30 +211,43 @@ type ModifyDBInstanceInput struct { // this request. MultiAZ *bool - // The new DB instance identifier for the DB instance when renaming a DB instance. - // When you change the DB instance identifier, an instance reboot will occur - // 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: + // The new DB instance identifier for the DB instance when renaming a DB + // instance. When you change the DB instance identifier, an instance reboot will + // occur 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. + // // Example: mydbinstance NewDBInstanceIdentifier *string - // (Not supported by Neptune) + // (Not supported by Neptune) OptionGroupName *string - // (Not supported by Neptune) + // (Not supported by Neptune) PerformanceInsightsKMSKeyId *string - // 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: + // 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 PreferredBackupWindow *string @@ -208,13 +258,22 @@ type ModifyDBInstanceInput struct { // maintenance window is changed to include the current time, then changing this // 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. 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 + // of the window to ensure pending changes are applied. + // + // 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 PreferredMaintenanceWindow *string // A value that specifies the order in which a Read Replica is promoted to the - // primary instance after a failure of the existing primary instance. Default: 1 + // primary instance after a failure of the existing primary instance. + // + // Default: 1 + // // Valid Values: 0 - 15 PromotionTier *int32 @@ -234,9 +293,13 @@ type ModifyDBInstanceInput struct { TdeCredentialPassword *string // 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: + // 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. VpcSecurityGroupIds []string @@ -245,8 +308,9 @@ 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 410d415966c..4d658895da7 100644 --- a/service/neptune/api_op_ModifyDBParameterGroup.go +++ b/service/neptune/api_op_ModifyDBParameterGroup.go @@ -14,18 +14,21 @@ 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. +// // 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 -// 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 Neptune to fully complete the modify action before the -// 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 -// your DB parameter group has been created or modified. +// the parameter group before the change can take effect. +// +// 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 Neptune to fully complete the modify +// action before the 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 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{} @@ -43,7 +46,10 @@ func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBPar type ModifyDBParameterGroupInput struct { - // The name of the DB parameter group. Constraints: + // The name of the DB parameter group. + // + // Constraints: + // // - If supplied, must match the name of an existing DBParameterGroup. // // This member is required. @@ -52,10 +58,13 @@ type ModifyDBParameterGroupInput struct { // An array of parameter names, values, and the apply method for the parameter // update. At least one parameter name, value, and apply method must be supplied; // subsequent arguments are optional. A maximum of 20 parameters can 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, and - // changes are applied when you reboot the DB instance without failover. + // 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, and changes are + // applied when you reboot the DB instance without failover. // // This member is required. Parameters []types.Parameter diff --git a/service/neptune/api_op_ModifyDBSubnetGroup.go b/service/neptune/api_op_ModifyDBSubnetGroup.go index 8e87081e6ce..812af2884f2 100644 --- a/service/neptune/api_op_ModifyDBSubnetGroup.go +++ b/service/neptune/api_op_ModifyDBSubnetGroup.go @@ -31,8 +31,12 @@ func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnet type ModifyDBSubnetGroupInput struct { // The name for the DB 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 + // You can't modify the default subnet group. + // + // Constraints: Must match the name of an existing DBSubnetGroup. Must not be + // default. + // + // Example: mySubnetgroup // // This member is required. DBSubnetGroupName *string @@ -50,8 +54,9 @@ type ModifyDBSubnetGroupInput struct { type ModifyDBSubnetGroupOutput struct { - // Contains the details of an Amazon Neptune DB subnet group. This data type is - // used as a response element in the DescribeDBSubnetGroups action. + // Contains the details of an Amazon Neptune 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/neptune/api_op_ModifyEventSubscription.go b/service/neptune/api_op_ModifyEventSubscription.go index aaafd19ba0b..b9742b10f3f 100644 --- a/service/neptune/api_op_ModifyEventSubscription.go +++ b/service/neptune/api_op_ModifyEventSubscription.go @@ -13,9 +13,10 @@ import ( // 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. +// a subscription, use the AddSourceIdentifierToSubscriptionand 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) { if params == nil { params = &ModifyEventSubscriptionInput{} @@ -38,12 +39,13 @@ type ModifyEventSubscriptionInput struct { // This member is required. SubscriptionName *string - // A Boolean value; set to true to activate the subscription. + // A Boolean value; set to true to activate the subscription. Enabled *bool - // A list of event categories for a SourceType that you want to subscribe to. You - // can see a list of the categories for a given SourceType by using the - // DescribeEventCategories action. + // A list of event categories for a SourceType that you want to subscribe to. You + // can see a list of the categories for a given SourceType + // + // by using the DescribeEventCategories action. EventCategories []string // The Amazon Resource Name (ARN) of the SNS topic created for event notification. @@ -52,8 +54,9 @@ type ModifyEventSubscriptionInput struct { // 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 + // 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 noSmithyDocumentSerde @@ -61,8 +64,7 @@ type ModifyEventSubscriptionInput struct { type ModifyEventSubscriptionOutput struct { - // Contains the results of a successful invocation of the - // DescribeEventSubscriptions action. + // Contains the results of a successful invocation of the DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_ModifyGlobalCluster.go b/service/neptune/api_op_ModifyGlobalCluster.go index d3189308410..385debcf914 100644 --- a/service/neptune/api_op_ModifyGlobalCluster.go +++ b/service/neptune/api_op_ModifyGlobalCluster.go @@ -32,19 +32,23 @@ func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalCl type ModifyGlobalClusterInput struct { // The DB cluster identifier for the global cluster being modified. This parameter - // is not case-sensitive. Constraints: Must match the identifier of an existing - // global database cluster. + // is not case-sensitive. + // + // Constraints: Must match the identifier of an existing global database cluster. // // This member is required. GlobalClusterIdentifier *string - // A value that indicates whether major version upgrades are allowed. Constraints: - // You must allow major version upgrades if you specify a value for the - // EngineVersion parameter that is a different major version than the DB cluster's - // current version. If you upgrade the major version of a global database, the - // cluster and DB instance parameter groups are set to the default parameter groups - // for the new version, so you will need to apply any custom parameter groups after - // completing the upgrade. + // A value that indicates whether major version upgrades are allowed. + // + // Constraints: You must allow major version upgrades if you specify a value for + // the EngineVersion parameter that is a different major version than the DB + // cluster's current version. + // + // If you upgrade the major version of a global database, the cluster and DB + // instance parameter groups are set to the default parameter groups for the new + // version, so you will need to apply any custom parameter groups after completing + // the upgrade. AllowMajorVersionUpgrade *bool // Indicates whether the global database has deletion protection enabled. The @@ -53,15 +57,22 @@ type ModifyGlobalClusterInput struct { // 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 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: + // 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 NewGlobalClusterIdentifier *string @@ -70,10 +81,9 @@ 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 - // RemoveFromGlobalCluster actions. + // 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 RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_PromoteReadReplicaDBCluster.go b/service/neptune/api_op_PromoteReadReplicaDBCluster.go index a1facb05b7b..2d19c153ca1 100644 --- a/service/neptune/api_op_PromoteReadReplicaDBCluster.go +++ b/service/neptune/api_op_PromoteReadReplicaDBCluster.go @@ -39,8 +39,9 @@ type PromoteReadReplicaDBClusterInput struct { type PromoteReadReplicaDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_RebootDBInstance.go b/service/neptune/api_op_RebootDBInstance.go index c2f7198ebe0..d9af2268605 100644 --- a/service/neptune/api_op_RebootDBInstance.go +++ b/service/neptune/api_op_RebootDBInstance.go @@ -14,9 +14,11 @@ import ( // You might need to reboot your DB instance, usually for maintenance reasons. For // example, if you make certain modifications, or if you change the DB parameter // group associated with the DB instance, you must reboot the instance for the -// 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. +// 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. func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceInput, optFns ...func(*Options)) (*RebootDBInstanceOutput, error) { if params == nil { params = &RebootDBInstanceInput{} @@ -35,14 +37,18 @@ func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceI type RebootDBInstanceInput struct { // The DB instance identifier. This parameter is stored as a lowercase string. + // // Constraints: + // // - 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 - // can't specify true if the instance is not configured for MultiAZ. + // 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 noSmithyDocumentSerde @@ -50,8 +56,9 @@ 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 878f362f882..ea38bbde720 100644 --- a/service/neptune/api_op_RemoveFromGlobalCluster.go +++ b/service/neptune/api_op_RemoveFromGlobalCluster.go @@ -48,10 +48,9 @@ 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 - // RemoveFromGlobalCluster actions. + // 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 RemoveFromGlobalCluster actions. GlobalCluster *types.GlobalCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_RemoveRoleFromDBCluster.go b/service/neptune/api_op_RemoveRoleFromDBCluster.go index a1f6f759295..29dd868e75d 100644 --- a/service/neptune/api_op_RemoveRoleFromDBCluster.go +++ b/service/neptune/api_op_RemoveRoleFromDBCluster.go @@ -40,8 +40,7 @@ type RemoveRoleFromDBClusterInput struct { 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 . + // disassociated from. For the list of supported feature names, see DescribeDBEngineVersions. FeatureName *string noSmithyDocumentSerde diff --git a/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go b/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go index 0571c3d7082..08d26cb063b 100644 --- a/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go +++ b/service/neptune/api_op_RemoveSourceIdentifierFromSubscription.go @@ -29,7 +29,7 @@ func (c *Client) RemoveSourceIdentifierFromSubscription(ctx context.Context, par type RemoveSourceIdentifierFromSubscriptionInput struct { - // The source identifier to be removed from the subscription, such as the DB + // The source identifier to be removed from the subscription, such as the DB // instance identifier for a DB instance or the name of a security group. // // This member is required. @@ -46,8 +46,7 @@ type RemoveSourceIdentifierFromSubscriptionInput struct { type RemoveSourceIdentifierFromSubscriptionOutput struct { - // Contains the results of a successful invocation of the - // DescribeEventSubscriptions action. + // Contains the results of a successful invocation of the DescribeEventSubscriptions action. EventSubscription *types.EventSubscription // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_RemoveTagsFromResource.go b/service/neptune/api_op_RemoveTagsFromResource.go index 130b941ccbb..5acc6d6c8bf 100644 --- a/service/neptune/api_op_RemoveTagsFromResource.go +++ b/service/neptune/api_op_RemoveTagsFromResource.go @@ -29,9 +29,9 @@ func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsF 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) - // . + // Amazon Resource Name (ARN). For information about creating an ARN, see [Constructing an Amazon Resource Name (ARN)]. + // + // [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 ac866e84c1e..2a6a9f61048 100644 --- a/service/neptune/api_op_ResetDBClusterParameterGroup.go +++ b/service/neptune/api_op_ResetDBClusterParameterGroup.go @@ -11,15 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the parameters of a DB cluster parameter group to the default value. +// 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. +// 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 RebootDBInstancerequest. 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{} @@ -58,10 +59,16 @@ type ResetDBClusterParameterGroupInput struct { type ResetDBClusterParameterGroupOutput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. DBClusterParameterGroupName *string diff --git a/service/neptune/api_op_ResetDBParameterGroup.go b/service/neptune/api_op_ResetDBParameterGroup.go index 6b9ebfae462..26f833e0679 100644 --- a/service/neptune/api_op_ResetDBParameterGroup.go +++ b/service/neptune/api_op_ResetDBParameterGroup.go @@ -35,7 +35,10 @@ func (c *Client) ResetDBParameterGroup(ctx context.Context, params *ResetDBParam type ResetDBParameterGroupInput struct { - // The name of the DB parameter group. Constraints: + // The name of the DB parameter group. + // + // Constraints: + // // - Must match the name of an existing DBParameterGroup. // // This member is required. @@ -44,11 +47,15 @@ type ResetDBParameterGroupInput struct { // 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. Valid Values (for Apply method): pending-reboot + // 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 - // parameter group to default values. Default: true + // parameter group to default values. + // + // Default: true ResetAllParameters *bool noSmithyDocumentSerde diff --git a/service/neptune/api_op_RestoreDBClusterFromSnapshot.go b/service/neptune/api_op_RestoreDBClusterFromSnapshot.go index 6bdcea1d31d..c1927352e44 100644 --- a/service/neptune/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/neptune/api_op_RestoreDBClusterFromSnapshot.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB -// snapshot is specified, the target DB cluster is created from the source DB -// snapshot with a default configuration and default security group. If a DB -// cluster snapshot is specified, the target DB cluster is created from the source -// DB cluster restore point with the same configuration as the original source DB -// cluster, except that the new DB cluster is created with the default security -// group. +// Creates a new DB cluster from a DB snapshot or DB cluster snapshot. +// +// If a DB snapshot is specified, the target DB cluster is created from the source +// DB snapshot with a default configuration and default security group. +// +// If a DB cluster snapshot is specified, the target DB cluster is created from +// the source DB cluster restore point with the same configuration as the original +// source DB cluster, except that the new DB cluster is created with the default +// security group. func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error) { if params == nil { params = &RestoreDBClusterFromSnapshotInput{} @@ -36,25 +38,37 @@ func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *Resto 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: + // 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 // // This member is required. DBClusterIdentifier *string - // The database engine to use for the new DB cluster. Default: The same as source + // The database engine to use for the new DB cluster. + // + // Default: The same as source + // // Constraint: Must be compatible with the engine of the source // // This member is required. Engine *string - // The identifier for the DB snapshot or DB cluster snapshot to restore from. You - // can use either the name or the Amazon Resource Name (ARN) to specify a DB + // The identifier for the DB snapshot or DB cluster snapshot to restore from. + // + // You 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. // // This member is required. @@ -64,18 +78,22 @@ 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 - // is created. + // 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: + // 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 - // supplied, must match the name of an existing DBSubnetGroup. Example: - // mySubnetgroup + // The name of the DB subnet group to use for the new DB cluster. + // + // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // + // Example: mySubnetgroup DBSubnetGroupName *string // Not supported. @@ -91,40 +109,55 @@ type RestoreDBClusterFromSnapshotInput struct { EnableCloudwatchLogsExports []string // True to enable mapping of Amazon Identity and Access Management (IAM) accounts - // to database accounts, and otherwise false. Default: false + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool // 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 - // 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: + // 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. KmsKeyId *string - // (Not supported by Neptune) + // (Not supported by Neptune) OptionGroupName *string - // The port number on which the new DB cluster accepts connections. Constraints: - // Value must be 1150-65535 Default: The same port as the original DB cluster. + // The port number on which the new DB cluster accepts connections. + // + // Constraints: Value must be 1150-65535 + // + // Default: The same port as the original DB cluster. 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) - // in the Amazon Neptune User Guide. + // Contains the scaling configuration of a Neptune Serverless DB cluster. + // + // For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. + // + // [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // Specifies the storage type to be associated with the DB cluster. Valid values: - // standard , iopt1 Default: standard + // Specifies the storage type to be associated with the DB cluster. + // + // Valid values: standard , iopt1 + // + // Default: standard StorageType *string // The tags to be assigned to the restored DB cluster. @@ -138,8 +171,9 @@ type RestoreDBClusterFromSnapshotInput struct { type RestoreDBClusterFromSnapshotOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_RestoreDBClusterToPointInTime.go b/service/neptune/api_op_RestoreDBClusterToPointInTime.go index d7d40564b81..40be39acc3f 100644 --- a/service/neptune/api_op_RestoreDBClusterToPointInTime.go +++ b/service/neptune/api_op_RestoreDBClusterToPointInTime.go @@ -16,12 +16,14 @@ import ( // point in time before LatestRestorableTime for up to BackupRetentionPeriod days. // The target DB cluster is created from the source DB cluster with the same // configuration as the original DB cluster, except that the new DB cluster is -// 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. +// 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 CreateDBInstanceaction 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. func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBClusterToPointInTimeOutput, error) { if params == nil { params = &RestoreDBClusterToPointInTimeInput{} @@ -39,28 +41,40 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest type RestoreDBClusterToPointInTimeInput struct { - // The name of the new DB cluster to be created. Constraints: + // 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 // // This member is required. DBClusterIdentifier *string - // The identifier of the source DB cluster from which to restore. Constraints: + // The identifier of the source DB cluster from which to restore. + // + // Constraints: + // // - 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: + // 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 - // supplied, must match the name of an existing DBSubnetGroup. Example: - // mySubnetgroup + // The DB subnet group name to use for the new DB cluster. + // + // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // + // Example: mySubnetgroup DBSubnetGroupName *string // A value that indicates whether the DB cluster has deletion protection enabled. @@ -72,68 +86,100 @@ type RestoreDBClusterToPointInTimeInput struct { EnableCloudwatchLogsExports []string // True to enable mapping of Amazon Identity and Access Management (IAM) accounts - // to database accounts, and otherwise false. Default: false + // 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 - // (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. You can restore to a new DB cluster and encrypt the new DB - // cluster with a KMS key that is different than 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 do not specify a value for the KmsKeyId - // parameter, then the following will occur: + // 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 encryption key. + // + // You can restore to a new DB cluster and encrypt the new DB cluster with a KMS + // key that is different than 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 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. KmsKeyId *string - // (Not supported by Neptune) + // (Not supported by Neptune) OptionGroupName *string - // The port number on which the new DB cluster accepts connections. Constraints: - // Value must be 1150-65535 Default: The same port as the original DB cluster. + // The port number on which the new DB cluster accepts connections. + // + // Constraints: Value must be 1150-65535 + // + // Default: The same port as the original DB cluster. Port *int32 - // The date and time to restore the DB cluster to. Valid Values: Value must be a - // time in Universal Coordinated Time (UTC) format Constraints: + // 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 + // // 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. 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) - // in the Amazon Neptune User Guide. + // Contains the scaling configuration of a Neptune Serverless DB cluster. + // + // For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. + // + // [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // Specifies the storage type to be associated with the DB cluster. Valid values: - // standard , iopt1 Default: standard + // Specifies the storage type to be associated with the DB cluster. + // + // Valid values: standard , iopt1 + // + // Default: standard StorageType *string // The tags to be applied to the restored DB cluster. Tags []types.Tag // A value that is set to true to restore the DB cluster to the latest restorable - // backup time, and false otherwise. Default: false Constraints: Cannot be - // specified if RestoreToTime parameter is provided. + // backup time, and false otherwise. + // + // Default: false + // + // Constraints: Cannot be specified if RestoreToTime parameter is provided. UseLatestRestorableTime *bool // A list of VPC security groups that the new DB cluster belongs to. @@ -144,8 +190,9 @@ type RestoreDBClusterToPointInTimeInput struct { type RestoreDBClusterToPointInTimeOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_StartDBCluster.go b/service/neptune/api_op_StartDBCluster.go index 20899be379e..689fc6bc9d7 100644 --- a/service/neptune/api_op_StartDBCluster.go +++ b/service/neptune/api_op_StartDBCluster.go @@ -41,8 +41,9 @@ type StartDBClusterInput struct { type StartDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/api_op_StopDBCluster.go b/service/neptune/api_op_StopDBCluster.go index 9ae13f1e40d..da772ff0f31 100644 --- a/service/neptune/api_op_StopDBCluster.go +++ b/service/neptune/api_op_StopDBCluster.go @@ -13,6 +13,7 @@ import ( // Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains // the DB cluster's metadata, including its endpoints and DB parameter groups. +// // Neptune also retains the transaction logs so you can do a point-in-time restore // if necessary. func (c *Client) StopDBCluster(ctx context.Context, params *StopDBClusterInput, optFns ...func(*Options)) (*StopDBClusterOutput, error) { @@ -43,8 +44,9 @@ type StopDBClusterInput struct { type StopDBClusterOutput struct { - // Contains the details of an Amazon Neptune DB cluster. This data type is used as - // a response element in the DescribeDBClusters . + // Contains the details of an Amazon Neptune DB cluster. + // + // This data type is used as a response element in the DescribeDBClusters. DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/neptune/doc.go b/service/neptune/doc.go index dabd6ec3a1e..c16c27abf1b 100644 --- a/service/neptune/doc.go +++ b/service/neptune/doc.go @@ -3,22 +3,25 @@ // Package neptune provides the API client, operations, and parameter types for // Amazon Neptune. // -// Amazon Neptune Amazon Neptune is a fast, reliable, fully-managed graph database -// service that makes it easy to build and run applications that work with highly -// connected datasets. The core of Amazon Neptune is a purpose-built, -// high-performance graph database engine optimized for storing billions of -// relationships and querying the graph with milliseconds latency. Amazon Neptune -// supports popular graph models Property Graph and W3C's RDF, and their respective -// query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily -// build queries that efficiently navigate highly connected datasets. Neptune -// powers graph use cases such as recommendation engines, fraud detection, -// knowledge graphs, drug discovery, and network security. This interface reference -// for Amazon Neptune contains documentation for a programming or command line -// interface you can use to manage Amazon Neptune. Note that Amazon Neptune is -// asynchronous, which means that some interfaces might require techniques such as -// polling or callback functions to determine when a command has been applied. In -// this reference, the parameter descriptions indicate whether a 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 Neptune +// +// Amazon Neptune is a fast, reliable, fully-managed graph database service that +// makes it easy to build and run applications that work with highly connected +// datasets. The core of Amazon Neptune is a purpose-built, high-performance graph +// database engine optimized for storing billions of relationships and querying the +// graph with milliseconds latency. Amazon Neptune supports popular graph models +// Property Graph and W3C's RDF, and their respective query languages Apache +// TinkerPop Gremlin and SPARQL, allowing you to easily build queries that +// efficiently navigate highly connected datasets. Neptune powers graph use cases +// such as recommendation engines, fraud detection, knowledge graphs, drug +// discovery, and network security. +// +// This interface reference for Amazon Neptune contains documentation for a +// programming or command line interface you can use to manage Amazon Neptune. Note +// that Amazon Neptune is asynchronous, which means that some interfaces might +// require techniques such as polling or callback functions to determine when a +// command has been applied. In this reference, the parameter descriptions indicate +// whether a 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. package neptune diff --git a/service/neptune/options.go b/service/neptune/options.go index 2ca079c69a3..0fc458c8e7f 100644 --- a/service/neptune/options.go +++ b/service/neptune/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/neptune/types/enums.go b/service/neptune/types/enums.go index 91e91f9f84c..8667f0358cd 100644 --- a/service/neptune/types/enums.go +++ b/service/neptune/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApplyMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplyMethod) Values() []ApplyMethod { return []ApplyMethod{ "immediate", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "db-instance", diff --git a/service/neptune/types/errors.go b/service/neptune/types/errors.go index 17c147c5109..35e09d43c55 100644 --- a/service/neptune/types/errors.go +++ b/service/neptune/types/errors.go @@ -8,8 +8,10 @@ import ( ) // Specified CIDRIP or EC2 security group is not authorized for the specified DB -// security group. Neptune may not also be authorized via IAM to perform necessary -// actions on your behalf. +// security group. +// +// Neptune may not also be authorized via IAM to perform necessary actions on your +// behalf. type AuthorizationNotFoundFault struct { Message *string @@ -195,7 +197,8 @@ func (e *DBClusterNotFoundFault) ErrorCode() string { } func (e *DBClusterNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// DBClusterParameterGroupName does not refer to an existing DB Cluster parameter +// DBClusterParameterGroupName does not refer to an existing DB Cluster parameter +// // group. type DBClusterParameterGroupNotFoundFault struct { Message *string diff --git a/service/neptune/types/types.go b/service/neptune/types/types.go index 167a0e3ec23..2645064f493 100644 --- a/service/neptune/types/types.go +++ b/service/neptune/types/types.go @@ -29,12 +29,15 @@ 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. Valid log types are: audit (to publish audit -// logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs -// to Amazon CloudWatch logs (https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html) -// . +// 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. +// +// Valid log types are: audit (to publish audit logs) and slowquery (to publish +// slow-query logs). See [Publishing Neptune logs to Amazon CloudWatch logs]. +// +// [Publishing Neptune logs to Amazon CloudWatch logs]: https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html type CloudwatchLogsExportConfiguration struct { // The list of log types to disable. @@ -82,8 +85,9 @@ type ClusterPendingModifiedValues struct { noSmithyDocumentSerde } -// Contains the details of an Amazon Neptune DB cluster. This data type is used as -// a response element in the DescribeDBClusters . +// Contains the details of an Amazon Neptune DB cluster. +// +// This data type is used as a response element in the DescribeDBClusters. type DBCluster struct { // AllocatedStorage always returns 1, because Neptune DB cluster storage size is @@ -116,7 +120,7 @@ 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 @@ -163,9 +167,9 @@ type DBCluster struct { // A list of the log types that this DB cluster is configured to export to // CloudWatch Logs. Valid log types are: audit (to publish audit logs to - // CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See - // Publishing Neptune logs to Amazon CloudWatch logs (https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html) - // . + // CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See [Publishing Neptune logs to Amazon CloudWatch logs]. + // + // [Publishing Neptune logs to Amazon CloudWatch logs]: https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html EnabledCloudwatchLogsExports []string // Specifies the connection endpoint for the primary instance of the DB cluster. @@ -232,18 +236,22 @@ type DBCluster struct { // cluster. As clients request new connections to the reader endpoint, Neptune // distributes the connection requests among the Read Replicas in the DB cluster. // This functionality can help balance your read workload across multiple Read - // Replicas in your DB cluster. If a failover occurs, and the Read Replica that you - // are connected to is promoted to be the primary instance, your connection is - // dropped. To continue sending your read workload to other Read Replicas in the - // cluster, you can then reconnect to the reader endpoint. + // Replicas in your DB cluster. + // + // If a failover occurs, and the Read Replica that you are connected to is + // promoted to be the primary instance, your connection is dropped. To continue + // sending your read workload to other Read Replicas in the cluster, you can then + // reconnect to the reader endpoint. ReaderEndpoint *string // Not supported by Neptune. 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) - // in the Amazon Neptune User Guide. + // Shows the scaling configuration for a Neptune Serverless DB cluster. + // + // For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. + // + // [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo // Specifies the current state of this DB cluster. @@ -264,9 +272,13 @@ 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 // // For the data structure that represents Amazon Neptune DB instance endpoints, @@ -347,9 +359,9 @@ type DBClusterOptionGroupStatus struct { noSmithyDocumentSerde } -// Contains the details of an Amazon Neptune DB cluster parameter group. This data -// type is used as a response element in the DescribeDBClusterParameterGroups -// action. +// Contains the details of an Amazon Neptune 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. @@ -373,8 +385,7 @@ type DBClusterParameterGroup struct { 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 . + // Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions. FeatureName *string // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB @@ -383,9 +394,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 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. @@ -394,8 +408,9 @@ type DBClusterRole struct { 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). @@ -417,16 +432,18 @@ type DBClusterSnapshot struct { 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 - // 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, - // 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. + // 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, 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. DBClusterSnapshotIdentifier *string // Specifies the name of the database engine. @@ -483,33 +500,37 @@ type DBClusterSnapshot struct { noSmithyDocumentSerde } -// Contains the name and values of a manual DB cluster snapshot attribute. Manual -// DB cluster snapshot attributes are used to authorize other Amazon accounts to -// restore a manual DB cluster snapshot. For more information, see the -// ModifyDBClusterSnapshotAttribute API action. +// Contains the name and values of a manual DB cluster snapshot attribute. +// +// Manual DB cluster snapshot attributes are used to authorize other Amazon +// accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute +// API action. type DBClusterSnapshotAttribute struct { - // The name of the manual DB cluster snapshot attribute. The attribute named - // restore refers to the list of Amazon accounts that have permission to copy or - // restore the manual DB cluster snapshot. For more information, see the - // ModifyDBClusterSnapshotAttribute API action. + // The name of the manual DB cluster snapshot attribute. + // + // The attribute named restore refers to the list of Amazon accounts that have + // permission to copy or restore the manual DB cluster snapshot. For more + // information, see the ModifyDBClusterSnapshotAttributeAPI action. 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 - // 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. + // 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 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. AttributeValues []string noSmithyDocumentSerde } -// Contains the results of a successful call to the -// DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot -// attributes are used to authorize other Amazon accounts to copy or restore a -// manual DB cluster snapshot. For more information, see the -// ModifyDBClusterSnapshotAttribute API action. +// Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action. +// +// Manual DB cluster snapshot attributes are used to authorize other Amazon +// accounts to copy or restore a manual DB cluster snapshot. For more information, +// see the ModifyDBClusterSnapshotAttributeAPI action. type DBClusterSnapshotAttributesResult struct { // The list of attributes and values for the manual DB cluster snapshot. @@ -521,8 +542,7 @@ type DBClusterSnapshotAttributesResult struct { noSmithyDocumentSerde } -// This data type is used as a response element in the action -// DescribeDBEngineVersions . +// This data type is used as a response element in the action DescribeDBEngineVersions. type DBEngineVersion struct { // The description of the database engine. @@ -534,7 +554,7 @@ type DBEngineVersion struct { // The name of the DB parameter group family for the database engine. DBParameterGroupFamily *string - // (Not supported by Neptune) + // (Not supported by Neptune) DefaultCharacterSet *CharacterSet // The name of the database engine. @@ -547,7 +567,7 @@ type DBEngineVersion struct { // CloudWatch Logs. ExportableLogTypes []string - // (Not supported by Neptune) + // (Not supported by Neptune) SupportedCharacterSets []CharacterSet // A list of the time zones supported by this engine for the Timezone parameter of @@ -571,8 +591,9 @@ 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. @@ -590,7 +611,7 @@ type DBInstance struct { // The identifier of the CA certificate for this DB instance. CACertificateIdentifier *string - // (Not supported by Neptune) + // (Not supported by Neptune) CharacterSetName *string // Specifies whether tags are copied from the DB instance to snapshots of the DB @@ -620,8 +641,8 @@ type DBInstance struct { // Provides the list of DB parameter groups applied to this DB instance. DBParameterGroups []DBParameterGroupStatus - // Provides List of DB security group elements containing only DBSecurityGroup.Name - // and DBSecurityGroup.Status subelements. + // Provides List of DB security group elements containing only + // DBSecurityGroup.Name and DBSecurityGroup.Status subelements. DBSecurityGroups []DBSecurityGroupMembership // Specifies information on the subnet group associated with the DB instance, @@ -638,9 +659,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]. + // + // [Deleting a DB Instance]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html DeletionProtection *bool // Not supported @@ -673,7 +694,7 @@ type DBInstance struct { // Specifies the Provisioned IOPS (I/O operations per second) value. Iops *int32 - // Not supported: The encryption for DB instances is managed by the DB cluster. + // 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 @@ -697,7 +718,7 @@ type DBInstance struct { // Specifies if the DB instance is a Multi-AZ deployment. MultiAZ *bool - // (Not supported by Neptune) + // (Not supported by Neptune) OptionGroupMemberships []OptionGroupMembership // Specifies that changes to the DB instance are pending. This element is only @@ -705,13 +726,13 @@ type DBInstance struct { // subelements. PendingModifiedValues *PendingModifiedValues - // (Not supported by Neptune) + // (Not supported by Neptune) PerformanceInsightsEnabled *bool - // (Not supported by Neptune) + // (Not supported by Neptune) PerformanceInsightsKMSKeyId *string - // Specifies the daily time range during which automated backups are created if + // Specifies the daily time range during which automated backups are created if // automated backups are enabled, as determined by the BackupRetentionPeriod . PreferredBackupWindow *string @@ -788,8 +809,9 @@ type DBInstanceStatusInfo struct { noSmithyDocumentSerde } -// Contains the details of an Amazon Neptune DB parameter group. This data type is -// used as a response element in the DescribeDBParameterGroups action. +// Contains the details of an Amazon Neptune 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. @@ -808,12 +830,17 @@ type DBParameterGroup struct { noSmithyDocumentSerde } -// The status of the DB parameter group. This data type is used as a response -// element in the following actions: -// - CreateDBInstance -// - DeleteDBInstance -// - ModifyDBInstance -// - RebootDBInstance +// The status of the DB parameter group. +// +// This data type is used as a response element in the following actions: +// +// # CreateDBInstance +// +// # DeleteDBInstance +// +// # ModifyDBInstance +// +// RebootDBInstance type DBParameterGroupStatus struct { // The name of the DP parameter group. @@ -837,8 +864,9 @@ type DBSecurityGroupMembership struct { noSmithyDocumentSerde } -// Contains the details of an Amazon Neptune DB subnet group. This data type is -// used as a response element in the DescribeDBSubnetGroups action. +// Contains the details of an Amazon Neptune 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. @@ -853,7 +881,7 @@ type DBSubnetGroup struct { // Provides the status of the DB subnet group. SubnetGroupStatus *string - // Contains a list of Subnet elements. + // Contains a list of Subnet elements. Subnets []Subnet // Provides the VpcId of the DB subnet group. @@ -894,8 +922,10 @@ type DoubleRange struct { noSmithyDocumentSerde } -// Specifies a connection endpoint. For the data structure that represents Amazon -// Neptune DB cluster endpoints, see DBClusterEndpoint . +// Specifies a connection endpoint. +// +// For the data structure that represents Amazon Neptune DB cluster endpoints, see +// DBClusterEndpoint . type Endpoint struct { // Specifies the DNS address of the DB instance. @@ -910,15 +940,14 @@ type Endpoint struct { noSmithyDocumentSerde } -// Contains the result of a successful invocation of the -// DescribeEngineDefaultParameters action. +// Contains the result of a successful invocation of the DescribeEngineDefaultParameters action. type EngineDefaults struct { // Specifies the name of the DB parameter group family that the engine default // parameters apply to. DBParameterGroupFamily *string - // An optional pagination token provided by a previous EngineDefaults request. If + // An optional pagination token provided by a previous EngineDefaults request. If // this parameter is specified, the response includes only records beyond the // marker, up to the value specified by MaxRecords . Marker *string @@ -953,8 +982,7 @@ type Event struct { noSmithyDocumentSerde } -// Contains the results of a successful invocation of the DescribeEventCategories -// action. +// Contains the results of a successful invocation of the DescribeEventCategories action. type EventCategoriesMap struct { // The event categories for the specified source type @@ -966,8 +994,7 @@ type EventCategoriesMap struct { noSmithyDocumentSerde } -// Contains the results of a successful invocation of the -// DescribeEventSubscriptions action. +// Contains the results of a successful invocation of the DescribeEventSubscriptions action. type EventSubscription struct { // The event notification subscription Id. @@ -995,11 +1022,16 @@ type EventSubscription struct { // The source type for the event notification subscription. SourceType *string - // The status of the event notification subscription. Constraints: Can be one of - // the following: creating | modifying | deleting | active | no-permission | - // topic-not-exist The status "no-permission" indicates that Neptune no longer has - // permission to post to the SNS topic. The status "topic-not-exist" indicates that - // the topic was deleted after the subscription was created. + // The status of the event notification subscription. + // + // Constraints: + // + // Can be one of the following: creating | modifying | deleting | active | + // no-permission | topic-not-exist + // + // The status "no-permission" indicates that Neptune no longer has permission to + // post to the SNS topic. The status "topic-not-exist" indicates that the topic was + // deleted after the subscription was created. Status *string // The time the event notification subscription was created. @@ -1024,10 +1056,9 @@ type Filter struct { noSmithyDocumentSerde } -// 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 -// RemoveFromGlobalCluster actions. +// 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 RemoveFromGlobalCluster actions. type GlobalCluster struct { // The deletion protection setting for the global database. @@ -1064,19 +1095,20 @@ type GlobalCluster struct { noSmithyDocumentSerde } -// A data structure with information about any primary and secondary clusters +// A data structure with information about any primary and secondary clusters +// // associated with an Neptune global database. type GlobalClusterMember struct { - // The Amazon Resource Name (ARN) for each Neptune cluster. + // The Amazon Resource Name (ARN) for each Neptune cluster. DBClusterArn *string - // Specifies whether the Neptune cluster is the primary cluster (that is, has + // Specifies whether the Neptune cluster is the primary cluster (that is, has // read-write capability) for the Neptune global database with which it is // associated. IsWriter *bool - // The Amazon Resource Name (ARN) for each read-only secondary cluster associated + // The Amazon Resource Name (ARN) for each read-only secondary cluster associated // with the Neptune global database. Readers []string @@ -1095,8 +1127,9 @@ type OptionGroupMembership struct { noSmithyDocumentSerde } -// Contains a list of available options for a DB instance. This data type is used -// as a response element in the DescribeOrderableDBInstanceOptions action. +// Contains a list of available options for a DB instance. +// +// This data type is used as a response element in the DescribeOrderableDBInstanceOptions action. type OrderableDBInstanceOption struct { // A list of Availability Zones for a DB instance. @@ -1155,7 +1188,7 @@ type OrderableDBInstanceOption struct { // Indicates whether a DB instance supports provisioned IOPS. SupportsIops *bool - // (Not supported by Neptune) + // (Not supported by Neptune) SupportsPerformanceInsights *bool // Indicates whether a DB instance supports encrypted storage. @@ -1185,7 +1218,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 @@ -1206,10 +1239,12 @@ type Parameter struct { } // A list of the log types whose configuration is still pending. In other words, -// these log types are in the process of being activated or deactivated. Valid log -// types are: audit (to publish audit logs) and slowquery (to publish slow-query -// logs). See Publishing Neptune logs to Amazon CloudWatch logs (https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html) -// . +// these log types are in the process of being activated or deactivated. +// +// Valid log types are: audit (to publish audit logs) and slowquery (to publish +// slow-query logs). See [Publishing Neptune logs to Amazon CloudWatch logs]. +// +// [Publishing Neptune logs to Amazon CloudWatch logs]: https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html type PendingCloudwatchLogsExports struct { // Log types that are in the process of being enabled. After they are enabled, @@ -1236,10 +1271,10 @@ type PendingMaintenanceAction struct { AutoAppliedAfterDate *time.Time // 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 . + // resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceActionAPI, + // 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. @@ -1260,8 +1295,8 @@ type PendingMaintenanceAction struct { // This data type is used as a response element in the ModifyDBInstance action. type PendingModifiedValues struct { - // Contains the new AllocatedStorage size for the DB instance that will be applied - // or is currently being applied. + // Contains the new AllocatedStorage size for the DB instance that will be + // applied or is currently being applied. AllocatedStorage *int32 // Specifies the pending number of days for which automated backups are retained. @@ -1270,11 +1305,11 @@ type PendingModifiedValues struct { // Specifies the identifier of the CA certificate for the DB instance. CACertificateIdentifier *string - // Contains the new DBInstanceClass for the DB instance that will be applied or is - // currently being applied. + // Contains the new DBInstanceClass for the DB instance that will be applied or + // is currently being applied. DBInstanceClass *string - // Contains the new DBInstanceIdentifier for the DB instance that will be applied + // Contains the new DBInstanceIdentifier for the DB instance that will be applied // or is currently being applied. DBInstanceIdentifier *string @@ -1341,9 +1376,11 @@ type ResourcePendingMaintenanceActions struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Neptune User Guide. +// Contains the scaling configuration of a Neptune Serverless DB cluster. +// +// For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. +// +// [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html type ServerlessV2ScalingConfiguration struct { // The maximum number of Neptune capacity units (NCUs) for a DB instance in a @@ -1359,9 +1396,11 @@ type ServerlessV2ScalingConfiguration struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Neptune User Guide. +// Shows the scaling configuration for a Neptune Serverless DB cluster. +// +// For more information, see [Using Amazon Neptune Serverless] in the Amazon Neptune User Guide. +// +// [Using Amazon Neptune Serverless]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html type ServerlessV2ScalingConfigurationInfo struct { // The maximum number of Neptune capacity units (NCUs) for a DB instance in a @@ -1377,8 +1416,9 @@ type ServerlessV2ScalingConfigurationInfo struct { noSmithyDocumentSerde } -// Specifies a subnet. This data type is used as a response element in the -// DescribeDBSubnetGroups action. +// Specifies a subnet. +// +// This data type is used as a response element in the DescribeDBSubnetGroups action. type Subnet struct { // Specifies the EC2 Availability Zone that the subnet is in. @@ -1411,7 +1451,7 @@ type Tag struct { 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,9 +1487,8 @@ 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 . +// Contains the result of a successful call to the DescribeValidDBInstanceModificationsaction. You can use this +// information when you call ModifyDBInstance. type ValidDBInstanceModificationsMessage struct { // Valid storage options for your DB instance. @@ -1459,8 +1498,8 @@ type ValidDBInstanceModificationsMessage struct { } // Information about valid modifications that you can make to your DB instance. -// Contains the result of a successful call to the -// DescribeValidDBInstanceModifications action. +// +// Contains the result of a successful call to the DescribeValidDBInstanceModifications action. type ValidStorageOptions struct { // The valid range of Provisioned IOPS to gibibytes of storage multiplier. For diff --git a/service/neptunedata/api_op_CancelGremlinQuery.go b/service/neptunedata/api_op_CancelGremlinQuery.go index 397962aab2c..c1dcd80cf3e 100644 --- a/service/neptunedata/api_op_CancelGremlinQuery.go +++ b/service/neptunedata/api_op_CancelGremlinQuery.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a Gremlin query. See Gremlin query cancellation (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html) -// for more information. When invoking this operation in a Neptune cluster that has -// IAM authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:CancelQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) -// IAM action in that cluster. +// Cancels a Gremlin query. See [Gremlin query cancellation] for more information. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:CancelQuery]IAM action in that cluster. +// +// [neptune-db:CancelQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery +// [Gremlin query cancellation]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status-cancel.html func (c *Client) CancelGremlinQuery(ctx context.Context, params *CancelGremlinQueryInput, optFns ...func(*Options)) (*CancelGremlinQueryOutput, error) { if params == nil { params = &CancelGremlinQueryInput{} diff --git a/service/neptunedata/api_op_CancelLoaderJob.go b/service/neptunedata/api_op_CancelLoaderJob.go index eb016b02c31..39763824763 100644 --- a/service/neptunedata/api_op_CancelLoaderJob.go +++ b/service/neptunedata/api_op_CancelLoaderJob.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a specified load job. This is an HTTP DELETE request. See Neptune -// Loader Get-Status API (https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm) -// for more information. When invoking this operation in a Neptune cluster that has -// IAM authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:CancelLoaderJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob) -// IAM action in that cluster.. +// Cancels a specified load job. This is an HTTP DELETE request. See [Neptune Loader Get-Status API] for more +// information. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:CancelLoaderJob]IAM action in that cluster.. +// +// [neptune-db:CancelLoaderJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelloaderjob +// [Neptune Loader Get-Status API]: https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm func (c *Client) CancelLoaderJob(ctx context.Context, params *CancelLoaderJobInput, optFns ...func(*Options)) (*CancelLoaderJobOutput, error) { if params == nil { params = &CancelLoaderJobInput{} diff --git a/service/neptunedata/api_op_CancelMLDataProcessingJob.go b/service/neptunedata/api_op_CancelMLDataProcessingJob.go index 52eb9955295..e7a8718b8cd 100644 --- a/service/neptunedata/api_op_CancelMLDataProcessingJob.go +++ b/service/neptunedata/api_op_CancelMLDataProcessingJob.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a Neptune ML data processing job. See The dataprocessing command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Cancels a Neptune ML data processing job. See [The dataprocessing command]dataprocessing . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:CancelMLDataProcessingJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob) -// IAM action in that cluster. +// that allows the [neptune-db:CancelMLDataProcessingJob]IAM action in that cluster. +// +// [neptune-db:CancelMLDataProcessingJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmldataprocessingjob +// [The dataprocessing command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html func (c *Client) CancelMLDataProcessingJob(ctx context.Context, params *CancelMLDataProcessingJobInput, optFns ...func(*Options)) (*CancelMLDataProcessingJobOutput, error) { if params == nil { params = &CancelMLDataProcessingJobInput{} diff --git a/service/neptunedata/api_op_CancelMLModelTrainingJob.go b/service/neptunedata/api_op_CancelMLModelTrainingJob.go index 74cddf5ff50..592020fb5c7 100644 --- a/service/neptunedata/api_op_CancelMLModelTrainingJob.go +++ b/service/neptunedata/api_op_CancelMLModelTrainingJob.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a Neptune ML model training job. See Model training using the -// modeltraining command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Cancels a Neptune ML model training job. See [Model training using the modeltraining command]modeltraining . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:CancelMLModelTrainingJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob) -// IAM action in that cluster. +// that allows the [neptune-db:CancelMLModelTrainingJob]IAM action in that cluster. +// +// [Model training using the modeltraining command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html +// [neptune-db:CancelMLModelTrainingJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltrainingjob func (c *Client) CancelMLModelTrainingJob(ctx context.Context, params *CancelMLModelTrainingJobInput, optFns ...func(*Options)) (*CancelMLModelTrainingJobOutput, error) { if params == nil { params = &CancelMLModelTrainingJobInput{} diff --git a/service/neptunedata/api_op_CancelMLModelTransformJob.go b/service/neptunedata/api_op_CancelMLModelTransformJob.go index b3292d47c40..75aa5b1c83e 100644 --- a/service/neptunedata/api_op_CancelMLModelTransformJob.go +++ b/service/neptunedata/api_op_CancelMLModelTransformJob.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a specified model transform job. See Use a trained model to generate -// new model artifacts (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Cancels a specified model transform job. See [Use a trained model to generate new model artifacts]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:CancelMLModelTransformJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob) -// IAM action in that cluster. +// that allows the [neptune-db:CancelMLModelTransformJob]IAM action in that cluster. +// +// [Use a trained model to generate new model artifacts]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html +// [neptune-db:CancelMLModelTransformJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelmlmodeltransformjob func (c *Client) CancelMLModelTransformJob(ctx context.Context, params *CancelMLModelTransformJobInput, optFns ...func(*Options)) (*CancelMLModelTransformJobOutput, error) { if params == nil { params = &CancelMLModelTransformJobInput{} diff --git a/service/neptunedata/api_op_CancelOpenCypherQuery.go b/service/neptunedata/api_op_CancelOpenCypherQuery.go index 42bc6ccb3ba..a945140cd84 100644 --- a/service/neptunedata/api_op_CancelOpenCypherQuery.go +++ b/service/neptunedata/api_op_CancelOpenCypherQuery.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a specified openCypher query. See Neptune openCypher status endpoint (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) -// for more information. When invoking this operation in a Neptune cluster that has -// IAM authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:CancelQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery) -// IAM action in that cluster. +// Cancels a specified openCypher query. See [Neptune openCypher status endpoint] for more information. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:CancelQuery]IAM action in that cluster. +// +// [neptune-db:CancelQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#cancelquery +// [Neptune openCypher status endpoint]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html func (c *Client) CancelOpenCypherQuery(ctx context.Context, params *CancelOpenCypherQueryInput, optFns ...func(*Options)) (*CancelOpenCypherQueryOutput, error) { if params == nil { params = &CancelOpenCypherQueryInput{} diff --git a/service/neptunedata/api_op_CreateMLEndpoint.go b/service/neptunedata/api_op_CreateMLEndpoint.go index b329eb7c304..9a9b80e5fe1 100644 --- a/service/neptunedata/api_op_CreateMLEndpoint.go +++ b/service/neptunedata/api_op_CreateMLEndpoint.go @@ -11,12 +11,14 @@ import ( ) // Creates a new Neptune ML inference endpoint that lets you query one specific -// model that the model-training process constructed. See Managing inference -// endpoints using the endpoints command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// model that the model-training process constructed. See [Managing inference endpoints using the endpoints command]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:CreateMLEndpoint (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint) -// IAM action in that cluster. +// that allows the [neptune-db:CreateMLEndpoint]IAM action in that cluster. +// +// [Managing inference endpoints using the endpoints command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html +// [neptune-db:CreateMLEndpoint]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#createmlendpoint func (c *Client) CreateMLEndpoint(ctx context.Context, params *CreateMLEndpointInput, optFns ...func(*Options)) (*CreateMLEndpointOutput, error) { if params == nil { params = &CreateMLEndpointInput{} diff --git a/service/neptunedata/api_op_DeleteMLEndpoint.go b/service/neptunedata/api_op_DeleteMLEndpoint.go index 8065ffdddd8..c4d4259895d 100644 --- a/service/neptunedata/api_op_DeleteMLEndpoint.go +++ b/service/neptunedata/api_op_DeleteMLEndpoint.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels the creation of a Neptune ML inference endpoint. See Managing inference -// endpoints using the endpoints command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Cancels the creation of a Neptune ML inference endpoint. See [Managing inference endpoints using the endpoints command]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:DeleteMLEndpoint (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint) -// IAM action in that cluster. +// that allows the [neptune-db:DeleteMLEndpoint]IAM action in that cluster. +// +// [neptune-db:DeleteMLEndpoint]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletemlendpoint +// [Managing inference endpoints using the endpoints command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html func (c *Client) DeleteMLEndpoint(ctx context.Context, params *DeleteMLEndpointInput, optFns ...func(*Options)) (*DeleteMLEndpointOutput, error) { if params == nil { params = &DeleteMLEndpointInput{} diff --git a/service/neptunedata/api_op_DeletePropertygraphStatistics.go b/service/neptunedata/api_op_DeletePropertygraphStatistics.go index e9e4dd0fa4a..fcfa4fad49d 100644 --- a/service/neptunedata/api_op_DeletePropertygraphStatistics.go +++ b/service/neptunedata/api_op_DeletePropertygraphStatistics.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes statistics for Gremlin and openCypher (property graph) data. When -// invoking this operation in a Neptune cluster that has IAM authentication +// Deletes statistics for Gremlin and openCypher (property graph) data. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:DeleteStatistics (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) -// IAM action in that cluster. +// that allows the [neptune-db:DeleteStatistics]IAM action in that cluster. +// +// [neptune-db:DeleteStatistics]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics func (c *Client) DeletePropertygraphStatistics(ctx context.Context, params *DeletePropertygraphStatisticsInput, optFns ...func(*Options)) (*DeletePropertygraphStatisticsOutput, error) { if params == nil { params = &DeletePropertygraphStatisticsInput{} diff --git a/service/neptunedata/api_op_DeleteSparqlStatistics.go b/service/neptunedata/api_op_DeleteSparqlStatistics.go index af16e30054d..ec7c6abe7ef 100644 --- a/service/neptunedata/api_op_DeleteSparqlStatistics.go +++ b/service/neptunedata/api_op_DeleteSparqlStatistics.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes SPARQL statistics When invoking this operation in a Neptune cluster -// that has IAM authentication enabled, the IAM user or role making the request -// must have a policy attached that allows the neptune-db:DeleteStatistics (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics) -// IAM action in that cluster. +// Deletes SPARQL statistics +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:DeleteStatistics]IAM action in that cluster. +// +// [neptune-db:DeleteStatistics]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletestatistics func (c *Client) DeleteSparqlStatistics(ctx context.Context, params *DeleteSparqlStatisticsInput, optFns ...func(*Options)) (*DeleteSparqlStatisticsOutput, error) { if params == nil { params = &DeleteSparqlStatisticsInput{} diff --git a/service/neptunedata/api_op_ExecuteFastReset.go b/service/neptunedata/api_op_ExecuteFastReset.go index 7c35f5b0bcd..7c0c1c61457 100644 --- a/service/neptunedata/api_op_ExecuteFastReset.go +++ b/service/neptunedata/api_op_ExecuteFastReset.go @@ -12,15 +12,19 @@ import ( ) // The fast reset REST API lets you reset a Neptune graph quicky and easily, -// removing all of its data. Neptune fast reset is a two-step process. First you -// call ExecuteFastReset with action set to initiateDatabaseReset . This returns a -// UUID token which you then include when calling ExecuteFastReset again with -// action set to performDatabaseReset . See Empty an Amazon Neptune DB cluster -// using the fast reset API (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// removing all of its data. +// +// Neptune fast reset is a two-step process. First you call ExecuteFastReset with +// action set to initiateDatabaseReset . This returns a UUID token which you then +// include when calling ExecuteFastReset again with action set to +// performDatabaseReset . See [Empty an Amazon Neptune DB cluster using the fast reset API]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:ResetDatabase (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase) -// IAM action in that cluster. +// that allows the [neptune-db:ResetDatabase]IAM action in that cluster. +// +// [Empty an Amazon Neptune DB cluster using the fast reset API]: https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html +// [neptune-db:ResetDatabase]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase func (c *Client) ExecuteFastReset(ctx context.Context, params *ExecuteFastResetInput, optFns ...func(*Options)) (*ExecuteFastResetOutput, error) { if params == nil { params = &ExecuteFastResetInput{} @@ -39,8 +43,10 @@ func (c *Client) ExecuteFastReset(ctx context.Context, params *ExecuteFastResetI type ExecuteFastResetInput struct { // The fast reset action. One of the following values: + // // - initiateDatabaseReset – This action generates a unique token needed to // actually perform the fast reset. + // // - performDatabaseReset – This action uses the token generated by the // initiateDatabaseReset action to actually perform the fast reset. // diff --git a/service/neptunedata/api_op_ExecuteGremlinExplainQuery.go b/service/neptunedata/api_op_ExecuteGremlinExplainQuery.go index 46437e3328b..b1206178c9c 100644 --- a/service/neptunedata/api_op_ExecuteGremlinExplainQuery.go +++ b/service/neptunedata/api_op_ExecuteGremlinExplainQuery.go @@ -10,27 +10,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Executes a Gremlin Explain query. Amazon Neptune has added a Gremlin feature -// named explain that provides is a self-service tool for understanding the -// execution approach being taken by the Neptune engine for the query. You invoke -// it by adding an explain parameter to an HTTP call that submits a Gremlin query. +// Executes a Gremlin Explain query. +// +// Amazon Neptune has added a Gremlin feature named explain that provides is a +// self-service tool for understanding the execution approach being taken by the +// Neptune engine for the query. You invoke it by adding an explain parameter to +// an HTTP call that submits a Gremlin query. +// // The explain feature provides information about the logical structure of query // execution plans. You can use this information to identify potential evaluation -// and execution bottlenecks and to tune your query, as explained in Tuning -// Gremlin queries (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html) -// . You can also use query hints to improve query execution plans. When invoking -// this operation in a Neptune cluster that has IAM authentication enabled, the IAM -// user or role making the request must have a policy attached that allows one of -// the following IAM actions in that cluster, depending on the query: -// - neptune-db:ReadDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) -// - neptune-db:WriteDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery) -// - neptune-db:DeleteDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery) +// and execution bottlenecks and to tune your query, as explained in [Tuning Gremlin queries]. You can +// also use query hints to improve query execution plans. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows one of the following IAM actions in that cluster, depending on the +// query: +// +// [neptune-db:ReadDataViaQuery] // -// Note that the neptune-db:QueryLanguage:Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// Gremlin queries (see Condition keys available in Neptune IAM data-access policy -// statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// [neptune-db:WriteDataViaQuery] +// +// [neptune-db:DeleteDataViaQuery] +// +// Note that the [neptune-db:QueryLanguage:Gremlin] IAM condition key can be used in the policy document to restrict +// the use of Gremlin queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [neptune-db:DeleteDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune-db:ReadDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery +// [Tuning Gremlin queries]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html +// [neptune-db:WriteDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery +// [neptune-db:QueryLanguage:Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ExecuteGremlinExplainQuery(ctx context.Context, params *ExecuteGremlinExplainQueryInput, optFns ...func(*Options)) (*ExecuteGremlinExplainQueryOutput, error) { if params == nil { params = &ExecuteGremlinExplainQueryInput{} @@ -58,9 +69,9 @@ type ExecuteGremlinExplainQueryInput struct { type ExecuteGremlinExplainQueryOutput struct { - // A text blob containing the Gremlin explain result, as described in Tuning - // Gremlin queries (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html) - // . + // A text blob containing the Gremlin explain result, as described in [Tuning Gremlin queries]. + // + // [Tuning Gremlin queries]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-traversal-tuning.html // // This value conforms to the media type: text/plain Output []byte diff --git a/service/neptunedata/api_op_ExecuteGremlinProfileQuery.go b/service/neptunedata/api_op_ExecuteGremlinProfileQuery.go index 9a12fa10fea..8147dec62fd 100644 --- a/service/neptunedata/api_op_ExecuteGremlinProfileQuery.go +++ b/service/neptunedata/api_op_ExecuteGremlinProfileQuery.go @@ -11,16 +11,20 @@ import ( ) // Executes a Gremlin Profile query, which runs a specified traversal, collects -// various metrics about the run, and produces a profile report as output. See -// Gremlin profile API in Neptune (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) -// for details. When invoking this operation in a Neptune cluster that has IAM -// authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:ReadDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// Gremlin queries (see Condition keys available in Neptune IAM data-access policy -// statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// various metrics about the run, and produces a profile report as output. See [Gremlin profile API in Neptune]for +// details. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:ReadDataViaQuery]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:Gremlin] IAM condition key can be used in the policy document to restrict +// the use of Gremlin queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Gremlin profile API in Neptune]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune-db:ReadDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery +// [neptune-db:QueryLanguage:Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ExecuteGremlinProfileQuery(ctx context.Context, params *ExecuteGremlinProfileQueryInput, optFns ...func(*Options)) (*ExecuteGremlinProfileQueryOutput, error) { if params == nil { params = &ExecuteGremlinProfileQueryInput{} @@ -56,8 +60,9 @@ type ExecuteGremlinProfileQueryInput struct { Results *bool // If non-null, the gathered results are returned in a serialized response message - // in the format specified by this parameter. See Gremlin profile API in Neptune (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) - // for more information. + // in the format specified by this parameter. See [Gremlin profile API in Neptune]for more information. + // + // [Gremlin profile API in Neptune]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html Serializer *string noSmithyDocumentSerde @@ -65,9 +70,9 @@ type ExecuteGremlinProfileQueryInput struct { type ExecuteGremlinProfileQueryOutput struct { - // A text blob containing the Gremlin Profile result. See Gremlin profile API in - // Neptune (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html) - // for details. + // A text blob containing the Gremlin Profile result. See [Gremlin profile API in Neptune] for details. + // + // [Gremlin profile API in Neptune]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html // // This value conforms to the media type: text/plain Output []byte diff --git a/service/neptunedata/api_op_ExecuteGremlinQuery.go b/service/neptunedata/api_op_ExecuteGremlinQuery.go index 02cb4e7d00d..7e66e2d45b0 100644 --- a/service/neptunedata/api_op_ExecuteGremlinQuery.go +++ b/service/neptunedata/api_op_ExecuteGremlinQuery.go @@ -14,22 +14,30 @@ import ( // This commands executes a Gremlin query. Amazon Neptune is compatible with // Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to -// query the graph, as described under The Graph (https://tinkerpop.apache.org/docs/current/reference/#graph) -// in the Apache TinkerPop3 documentation. More details can also be found in -// Accessing a Neptune graph with Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// query the graph, as described under [The Graph]in the Apache TinkerPop3 documentation. +// More details can also be found in [Accessing a Neptune graph with Gremlin]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached // that enables one of the following IAM actions in that cluster, depending on the // query: -// - neptune-db:ReadDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) -// - neptune-db:WriteDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery) -// - neptune-db:DeleteDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery) // -// Note that the neptune-db:QueryLanguage:Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// Gremlin queries (see Condition keys available in Neptune IAM data-access policy -// statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// [neptune-db:ReadDataViaQuery] +// +// [neptune-db:WriteDataViaQuery] +// +// [neptune-db:DeleteDataViaQuery] +// +// Note that the [neptune-db:QueryLanguage:Gremlin] IAM condition key can be used in the policy document to restrict +// the use of Gremlin queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [neptune-db:DeleteDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [The Graph]: https://tinkerpop.apache.org/docs/current/reference/#graph +// [Accessing a Neptune graph with Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin.html +// [neptune-db:ReadDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery +// [neptune-db:WriteDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery +// [neptune-db:QueryLanguage:Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ExecuteGremlinQuery(ctx context.Context, params *ExecuteGremlinQueryInput, optFns ...func(*Options)) (*ExecuteGremlinQueryOutput, error) { if params == nil { params = &ExecuteGremlinQueryInput{} @@ -49,16 +57,19 @@ type ExecuteGremlinQueryInput struct { // Using this API, you can run Gremlin queries in string format much as you can // using the HTTP endpoint. The interface is compatible with whatever Gremlin - // version your DB cluster is using (see the Tinkerpop client section (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest) - // to determine which Gremlin releases your engine version supports). + // version your DB cluster is using (see the [Tinkerpop client section]to determine which Gremlin releases + // your engine version supports). + // + // [Tinkerpop client section]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-client.html#best-practices-gremlin-java-latest // // This member is required. GremlinQuery *string // If non-null, the query results are returned in a serialized response message in - // the format specified by this parameter. See the GraphSON (https://tinkerpop.apache.org/docs/current/reference/#_graphson) - // section in the TinkerPop documentation for a list of the formats that are - // currently supported. + // the format specified by this parameter. See the [GraphSON]section in the TinkerPop + // documentation for a list of the formats that are currently supported. + // + // [GraphSON]: https://tinkerpop.apache.org/docs/current/reference/#_graphson Serializer *string noSmithyDocumentSerde diff --git a/service/neptunedata/api_op_ExecuteOpenCypherExplainQuery.go b/service/neptunedata/api_op_ExecuteOpenCypherExplainQuery.go index dcb202eaee4..f1270578d0b 100644 --- a/service/neptunedata/api_op_ExecuteOpenCypherExplainQuery.go +++ b/service/neptunedata/api_op_ExecuteOpenCypherExplainQuery.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Executes an openCypher explain request. See The openCypher explain feature (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html) -// for more information. When invoking this operation in a Neptune cluster that has -// IAM authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:ReadDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// openCypher queries (see Condition keys available in Neptune IAM data-access -// policy statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// Executes an openCypher explain request. See [The openCypher explain feature] for more information. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:ReadDataViaQuery]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:OpenCypher] IAM condition key can be used in the policy document to restrict +// the use of openCypher queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [The openCypher explain feature]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-explain.html +// [neptune-db:ReadDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery +// [neptune-db:QueryLanguage:OpenCypher]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ExecuteOpenCypherExplainQuery(ctx context.Context, params *ExecuteOpenCypherExplainQueryInput, optFns ...func(*Options)) (*ExecuteOpenCypherExplainQueryOutput, error) { if params == nil { params = &ExecuteOpenCypherExplainQueryInput{} diff --git a/service/neptunedata/api_op_ExecuteOpenCypherQuery.go b/service/neptunedata/api_op_ExecuteOpenCypherQuery.go index 1a9cc499009..1888ea440d0 100644 --- a/service/neptunedata/api_op_ExecuteOpenCypherQuery.go +++ b/service/neptunedata/api_op_ExecuteOpenCypherQuery.go @@ -11,27 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Executes an openCypher query. See Accessing the Neptune Graph with openCypher (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html) -// for more information. Neptune supports building graph applications using -// openCypher, which is currently one of the most popular query languages among -// developers working with graph databases. Developers, business analysts, and data -// scientists like openCypher's declarative, SQL-inspired syntax because it -// provides a familiar structure in which to querying property graphs. The -// openCypher language was originally developed by Neo4j, then open-sourced in 2015 -// and contributed to the openCypher project (https://opencypher.org/) under an -// Apache 2 open-source license. Note that when invoking this operation in a -// Neptune cluster that has IAM authentication enabled, the IAM user or role making -// the request must have a policy attached that allows one of the following IAM -// actions in that cluster, depending on the query: -// - neptune-db:ReadDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery) -// - neptune-db:WriteDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery) -// - neptune-db:DeleteDataViaQuery (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery) +// Executes an openCypher query. See [Accessing the Neptune Graph with openCypher] for more information. // -// Note also that the neptune-db:QueryLanguage:OpenCypher (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// openCypher queries (see Condition keys available in Neptune IAM data-access -// policy statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// Neptune supports building graph applications using openCypher, which is +// currently one of the most popular query languages among developers working with +// graph databases. Developers, business analysts, and data scientists like +// openCypher's declarative, SQL-inspired syntax because it provides a familiar +// structure in which to querying property graphs. +// +// The openCypher language was originally developed by Neo4j, then open-sourced in +// 2015 and contributed to the [openCypher project]under an Apache 2 open-source license. +// +// Note that when invoking this operation in a Neptune cluster that has IAM +// authentication enabled, the IAM user or role making the request must have a +// policy attached that allows one of the following IAM actions in that cluster, +// depending on the query: +// +// [neptune-db:ReadDataViaQuery] +// +// [neptune-db:WriteDataViaQuery] +// +// [neptune-db:DeleteDataViaQuery] +// +// Note also that the [neptune-db:QueryLanguage:OpenCypher] IAM condition key can be used in the policy document to +// restrict the use of openCypher queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [neptune-db:DeleteDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#deletedataviaquery +// [Accessing the Neptune Graph with openCypher]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher.html +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [openCypher project]: https://opencypher.org/ +// [neptune-db:ReadDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#readdataviaquery +// [neptune-db:WriteDataViaQuery]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#writedataviaquery +// [neptune-db:QueryLanguage:OpenCypher]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ExecuteOpenCypherQuery(ctx context.Context, params *ExecuteOpenCypherQueryInput, optFns ...func(*Options)) (*ExecuteOpenCypherQueryOutput, error) { if params == nil { params = &ExecuteOpenCypherQueryInput{} @@ -54,9 +65,9 @@ type ExecuteOpenCypherQueryInput struct { // This member is required. OpenCypherQuery *string - // The openCypher query parameters for query execution. See Examples of openCypher - // parameterized queries (https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html) - // for more information. + // The openCypher query parameters for query execution. See [Examples of openCypher parameterized queries] for more information. + // + // [Examples of openCypher parameterized queries]: https://docs.aws.amazon.com/neptune/latest/userguide/opencypher-parameterized-queries.html Parameters *string noSmithyDocumentSerde diff --git a/service/neptunedata/api_op_GetEngineStatus.go b/service/neptunedata/api_op_GetEngineStatus.go index c9cfa61cc5e..2c60b5f22c1 100644 --- a/service/neptunedata/api_op_GetEngineStatus.go +++ b/service/neptunedata/api_op_GetEngineStatus.go @@ -12,11 +12,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the status of the graph database on the host. When invoking this -// operation in a Neptune cluster that has IAM authentication enabled, the IAM user -// or role making the request must have a policy attached that allows the -// neptune-db:GetEngineStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus) -// IAM action in that cluster. +// Retrieves the status of the graph database on the host. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetEngineStatus]IAM action in that cluster. +// +// [neptune-db:GetEngineStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getenginestatus func (c *Client) GetEngineStatus(ctx context.Context, params *GetEngineStatusInput, optFns ...func(*Options)) (*GetEngineStatusOutput, error) { if params == nil { params = &GetEngineStatusInput{} diff --git a/service/neptunedata/api_op_GetGremlinQueryStatus.go b/service/neptunedata/api_op_GetGremlinQueryStatus.go index 66fb9c87df3..6656de3d843 100644 --- a/service/neptunedata/api_op_GetGremlinQueryStatus.go +++ b/service/neptunedata/api_op_GetGremlinQueryStatus.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the status of a specified Gremlin query. When invoking this operation in a -// Neptune cluster that has IAM authentication enabled, the IAM user or role making -// the request must have a policy attached that allows the -// neptune-db:GetQueryStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// Gremlin queries (see Condition keys available in Neptune IAM data-access policy -// statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// Gets the status of a specified Gremlin query. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetQueryStatus]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:Gremlin] IAM condition key can be used in the policy document to restrict +// the use of Gremlin queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune-db:GetQueryStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus +// [neptune-db:QueryLanguage:Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) GetGremlinQueryStatus(ctx context.Context, params *GetGremlinQueryStatusInput, optFns ...func(*Options)) (*GetGremlinQueryStatusOutput, error) { if params == nil { params = &GetGremlinQueryStatusInput{} diff --git a/service/neptunedata/api_op_GetLoaderJobStatus.go b/service/neptunedata/api_op_GetLoaderJobStatus.go index ca258473934..d9c9ce51fee 100644 --- a/service/neptunedata/api_op_GetLoaderJobStatus.go +++ b/service/neptunedata/api_op_GetLoaderJobStatus.go @@ -13,11 +13,16 @@ import ( // Gets status information about a specified load job. Neptune keeps track of the // most recent 1,024 bulk load jobs, and stores the last 10,000 error details per -// job. See Neptune Loader Get-Status API (https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm) -// for more information. When invoking this operation in a Neptune cluster that has -// IAM authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:GetLoaderJobStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus) -// IAM action in that cluster.. +// job. +// +// See [Neptune Loader Get-Status API] for more information. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetLoaderJobStatus]IAM action in that cluster.. +// +// [neptune-db:GetLoaderJobStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getloaderjobstatus +// [Neptune Loader Get-Status API]: https://docs.aws.amazon.com/neptune/latest/userguide/load-api-reference-status.htm func (c *Client) GetLoaderJobStatus(ctx context.Context, params *GetLoaderJobStatusInput, optFns ...func(*Options)) (*GetLoaderJobStatusOutput, error) { if params == nil { params = &GetLoaderJobStatusInput{} @@ -45,8 +50,10 @@ type GetLoaderJobStatusInput struct { Details *bool // Flag indicating whether or not to include a list of errors encountered ( TRUE - // or FALSE ; the default is FALSE ). The list of errors is paged. The page and - // errorsPerPage parameters allow you to page through all the errors. + // or FALSE ; the default is FALSE ). + // + // The list of errors is paged. The page and errorsPerPage parameters allow you to + // page through all the errors. Errors *bool // The number of errors returned in each page (a positive integer; the default is diff --git a/service/neptunedata/api_op_GetMLDataProcessingJob.go b/service/neptunedata/api_op_GetMLDataProcessingJob.go index db794711b26..a4ac46dc06e 100644 --- a/service/neptunedata/api_op_GetMLDataProcessingJob.go +++ b/service/neptunedata/api_op_GetMLDataProcessingJob.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a specified data processing job. See The -// dataprocessing command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Retrieves information about a specified data processing job. See [The dataprocessing command]dataprocessing . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:neptune-db:GetMLDataProcessingJobStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus) -// IAM action in that cluster. +// that allows the [neptune-db:neptune-db:GetMLDataProcessingJobStatus]IAM action in that cluster. +// +// [The dataprocessing command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html +// [neptune-db:neptune-db:GetMLDataProcessingJobStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmldataprocessingjobstatus func (c *Client) GetMLDataProcessingJob(ctx context.Context, params *GetMLDataProcessingJobInput, optFns ...func(*Options)) (*GetMLDataProcessingJobOutput, error) { if params == nil { params = &GetMLDataProcessingJobInput{} diff --git a/service/neptunedata/api_op_GetMLEndpoint.go b/service/neptunedata/api_op_GetMLEndpoint.go index 1ce77ce8002..ba7785fc4b8 100644 --- a/service/neptunedata/api_op_GetMLEndpoint.go +++ b/service/neptunedata/api_op_GetMLEndpoint.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves details about an inference endpoint. See Managing inference endpoints -// using the endpoints command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Retrieves details about an inference endpoint. See [Managing inference endpoints using the endpoints command]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:GetMLEndpointStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus) -// IAM action in that cluster. +// that allows the [neptune-db:GetMLEndpointStatus]IAM action in that cluster. +// +// [Managing inference endpoints using the endpoints command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html +// [neptune-db:GetMLEndpointStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlendpointstatus func (c *Client) GetMLEndpoint(ctx context.Context, params *GetMLEndpointInput, optFns ...func(*Options)) (*GetMLEndpointOutput, error) { if params == nil { params = &GetMLEndpointInput{} diff --git a/service/neptunedata/api_op_GetMLModelTrainingJob.go b/service/neptunedata/api_op_GetMLModelTrainingJob.go index e160b3f3d2e..a112739f409 100644 --- a/service/neptunedata/api_op_GetMLModelTrainingJob.go +++ b/service/neptunedata/api_op_GetMLModelTrainingJob.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a Neptune ML model training job. See Model training -// using the modeltraining command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Retrieves information about a Neptune ML model training job. See [Model training using the modeltraining command]modeltraining . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:GetMLModelTrainingJobStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus) -// IAM action in that cluster. +// that allows the [neptune-db:GetMLModelTrainingJobStatus]IAM action in that cluster. +// +// [neptune-db:GetMLModelTrainingJobStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltrainingjobstatus +// [Model training using the modeltraining command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html func (c *Client) GetMLModelTrainingJob(ctx context.Context, params *GetMLModelTrainingJobInput, optFns ...func(*Options)) (*GetMLModelTrainingJobOutput, error) { if params == nil { params = &GetMLModelTrainingJobInput{} diff --git a/service/neptunedata/api_op_GetMLModelTransformJob.go b/service/neptunedata/api_op_GetMLModelTransformJob.go index 735b168cae9..a770d310c97 100644 --- a/service/neptunedata/api_op_GetMLModelTransformJob.go +++ b/service/neptunedata/api_op_GetMLModelTransformJob.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about a specified model transform job. See Use a trained model -// to generate new model artifacts (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Gets information about a specified model transform job. See [Use a trained model to generate new model artifacts]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:GetMLModelTransformJobStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus) -// IAM action in that cluster. +// that allows the [neptune-db:GetMLModelTransformJobStatus]IAM action in that cluster. +// +// [Use a trained model to generate new model artifacts]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html +// [neptune-db:GetMLModelTransformJobStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getmlmodeltransformjobstatus func (c *Client) GetMLModelTransformJob(ctx context.Context, params *GetMLModelTransformJobInput, optFns ...func(*Options)) (*GetMLModelTransformJobOutput, error) { if params == nil { params = &GetMLModelTransformJobInput{} diff --git a/service/neptunedata/api_op_GetOpenCypherQueryStatus.go b/service/neptunedata/api_op_GetOpenCypherQueryStatus.go index 00ae91efc55..7cb343fba54 100644 --- a/service/neptunedata/api_op_GetOpenCypherQueryStatus.go +++ b/service/neptunedata/api_op_GetOpenCypherQueryStatus.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the status of a specified openCypher query. When invoking this -// operation in a Neptune cluster that has IAM authentication enabled, the IAM user -// or role making the request must have a policy attached that allows the -// neptune-db:GetQueryStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// openCypher queries (see Condition keys available in Neptune IAM data-access -// policy statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// Retrieves the status of a specified openCypher query. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetQueryStatus]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:OpenCypher] IAM condition key can be used in the policy document to restrict +// the use of openCypher queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune-db:GetQueryStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus +// [neptune-db:QueryLanguage:OpenCypher]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) GetOpenCypherQueryStatus(ctx context.Context, params *GetOpenCypherQueryStatusInput, optFns ...func(*Options)) (*GetOpenCypherQueryStatusOutput, error) { if params == nil { params = &GetOpenCypherQueryStatusInput{} diff --git a/service/neptunedata/api_op_GetPropertygraphStatistics.go b/service/neptunedata/api_op_GetPropertygraphStatistics.go index 8e565f1eb80..e55f08cc941 100644 --- a/service/neptunedata/api_op_GetPropertygraphStatistics.go +++ b/service/neptunedata/api_op_GetPropertygraphStatistics.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets property graph statistics (Gremlin and openCypher). When invoking this -// operation in a Neptune cluster that has IAM authentication enabled, the IAM user -// or role making the request must have a policy attached that allows the -// neptune-db:GetStatisticsStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) -// IAM action in that cluster. +// Gets property graph statistics (Gremlin and openCypher). +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetStatisticsStatus]IAM action in that cluster. +// +// [neptune-db:GetStatisticsStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus func (c *Client) GetPropertygraphStatistics(ctx context.Context, params *GetPropertygraphStatisticsInput, optFns ...func(*Options)) (*GetPropertygraphStatisticsOutput, error) { if params == nil { params = &GetPropertygraphStatisticsInput{} @@ -43,8 +45,9 @@ type GetPropertygraphStatisticsOutput struct { Payload *types.Statistics // The HTTP return code of the request. If the request succeeded, the code is 200. - // See Common error codes for DFE statistics request (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors) - // for a list of common errors. + // See [Common error codes for DFE statistics request]for a list of common errors. + // + // [Common error codes for DFE statistics request]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors // // This member is required. Status *string diff --git a/service/neptunedata/api_op_GetPropertygraphStream.go b/service/neptunedata/api_op_GetPropertygraphStream.go index dac7c32952c..6f88b87f997 100644 --- a/service/neptunedata/api_op_GetPropertygraphStream.go +++ b/service/neptunedata/api_op_GetPropertygraphStream.go @@ -11,26 +11,41 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a stream for a property graph. With the Neptune Streams feature, you can -// generate a complete sequence of change-log entries that record every change made -// to your graph data as it happens. GetPropertygraphStream lets you collect these -// change-log entries for a property graph. The Neptune streams feature needs to be -// enabled on your Neptune DBcluster. To enable streams, set the neptune_streams (https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) -// DB cluster parameter to 1 . See Capturing graph changes in real time using -// Neptune streams (https://docs.aws.amazon.com/neptune/latest/userguide/streams.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Gets a stream for a property graph. +// +// With the Neptune Streams feature, you can generate a complete sequence of +// change-log entries that record every change made to your graph data as it +// happens. GetPropertygraphStream lets you collect these change-log entries for a +// property graph. +// +// The Neptune streams feature needs to be enabled on your Neptune DBcluster. To +// enable streams, set the [neptune_streams]DB cluster parameter to 1 . +// +// See [Capturing graph changes in real time using Neptune streams]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:GetStreamRecords (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) -// IAM action in that cluster. When invoking this operation in a Neptune cluster -// that has IAM authentication enabled, the IAM user or role making the request -// must have a policy attached that enables one of the following IAM actions, -// depending on the query: Note that you can restrict property-graph queries using -// the following IAM context keys: -// - neptune-db:QueryLanguage:Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// - neptune-db:QueryLanguage:OpenCypher (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) +// that allows the [neptune-db:GetStreamRecords]IAM action in that cluster. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that enables one of the following IAM actions, depending on the query: +// +// Note that you can restrict property-graph queries using the following IAM +// context keys: +// +// [neptune-db:QueryLanguage:Gremlin] // -// See Condition keys available in Neptune IAM data-access policy statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// [neptune-db:QueryLanguage:OpenCypher] +// +// See [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune_streams]: https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams +// [Capturing graph changes in real time using Neptune streams]: https://docs.aws.amazon.com/neptune/latest/userguide/streams.html +// [neptune-db:GetStreamRecords]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords +// [neptune-db:QueryLanguage:Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys +// [neptune-db:QueryLanguage:OpenCypher]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) GetPropertygraphStream(ctx context.Context, params *GetPropertygraphStreamInput, optFns ...func(*Options)) (*GetPropertygraphStreamOutput, error) { if params == nil { params = &GetPropertygraphStreamInput{} @@ -57,13 +72,17 @@ type GetPropertygraphStreamInput struct { Encoding types.Encoding // Can be one of: + // // - AT_SEQUENCE_NUMBER – Indicates that reading should start from the event // sequence number specified jointly by the commitNum and opNum parameters. + // // - AFTER_SEQUENCE_NUMBER – Indicates that reading should start right after the // event sequence number specified jointly by the commitNum and opNum parameters. + // // - TRIM_HORIZON – Indicates that reading should start at the last untrimmed // record in the system, which is the oldest unexpired (not yet deleted) record in // the change-log stream. + // // - LATEST – Indicates that reading should start at the most recent record in // the system, which is the latest unexpired (not yet deleted) record in the // change-log stream. @@ -72,8 +91,9 @@ type GetPropertygraphStreamInput struct { // Specifies the maximum number of records to return. There is also a size limit // of 10 MB on the response that can't be modified and that takes precedence over // the number of records specified in the limit parameter. The response does - // include a threshold-breaching record if the 10 MB limit was reached. The range - // for limit is 1 to 100,000, with a default of 10. + // include a threshold-breaching record if the 10 MB limit was reached. + // + // The range for limit is 1 to 100,000, with a default of 10. Limit *int64 // The operation sequence number within the specified commit to start reading from @@ -91,10 +111,11 @@ type GetPropertygraphStreamOutput struct { // This member is required. Format *string - // Sequence identifier of the last change in the stream response. An event ID is - // composed of two fields: a commitNum , which identifies a transaction that - // changed the graph, and an opNum , which identifies a specific operation within - // that transaction: + // Sequence identifier of the last change in the stream response. + // + // An event ID is composed of two fields: a commitNum , which identifies a + // transaction that changed the graph, and an opNum , which identifies a specific + // operation within that transaction: // // This member is required. LastEventId map[string]string diff --git a/service/neptunedata/api_op_GetPropertygraphSummary.go b/service/neptunedata/api_op_GetPropertygraphSummary.go index 5e9aba10ce1..836484376a2 100644 --- a/service/neptunedata/api_op_GetPropertygraphSummary.go +++ b/service/neptunedata/api_op_GetPropertygraphSummary.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a graph summary for a property graph. When invoking this operation in a -// Neptune cluster that has IAM authentication enabled, the IAM user or role making -// the request must have a policy attached that allows the -// neptune-db:GetGraphSummary (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) -// IAM action in that cluster. +// Gets a graph summary for a property graph. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetGraphSummary]IAM action in that cluster. +// +// [neptune-db:GetGraphSummary]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary func (c *Client) GetPropertygraphSummary(ctx context.Context, params *GetPropertygraphSummaryInput, optFns ...func(*Options)) (*GetPropertygraphSummaryOutput, error) { if params == nil { params = &GetPropertygraphSummaryInput{} diff --git a/service/neptunedata/api_op_GetRDFGraphSummary.go b/service/neptunedata/api_op_GetRDFGraphSummary.go index a12b19aac40..6d0c2918249 100644 --- a/service/neptunedata/api_op_GetRDFGraphSummary.go +++ b/service/neptunedata/api_op_GetRDFGraphSummary.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a graph summary for an RDF graph. When invoking this operation in a -// Neptune cluster that has IAM authentication enabled, the IAM user or role making -// the request must have a policy attached that allows the -// neptune-db:GetGraphSummary (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary) -// IAM action in that cluster. +// Gets a graph summary for an RDF graph. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetGraphSummary]IAM action in that cluster. +// +// [neptune-db:GetGraphSummary]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getgraphsummary func (c *Client) GetRDFGraphSummary(ctx context.Context, params *GetRDFGraphSummaryInput, optFns ...func(*Options)) (*GetRDFGraphSummaryOutput, error) { if params == nil { params = &GetRDFGraphSummaryInput{} diff --git a/service/neptunedata/api_op_GetSparqlStatistics.go b/service/neptunedata/api_op_GetSparqlStatistics.go index 083d7c22fbb..df46f5a5a90 100644 --- a/service/neptunedata/api_op_GetSparqlStatistics.go +++ b/service/neptunedata/api_op_GetSparqlStatistics.go @@ -39,11 +39,14 @@ type GetSparqlStatisticsOutput struct { Payload *types.Statistics // The HTTP return code of the request. If the request succeeded, the code is 200. - // See Common error codes for DFE statistics request (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors) - // for a list of common errors. When invoking this operation in a Neptune cluster - // that has IAM authentication enabled, the IAM user or role making the request - // must have a policy attached that allows the neptune-db:GetStatisticsStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus) - // IAM action in that cluster. + // See [Common error codes for DFE statistics request]for a list of common errors. + // + // When invoking this operation in a Neptune cluster that has IAM authentication + // enabled, the IAM user or role making the request must have a policy attached + // that allows the [neptune-db:GetStatisticsStatus]IAM action in that cluster. + // + // [Common error codes for DFE statistics request]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html#neptune-dfe-statistics-errors + // [neptune-db:GetStatisticsStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstatisticsstatus // // This member is required. Status *string diff --git a/service/neptunedata/api_op_GetSparqlStream.go b/service/neptunedata/api_op_GetSparqlStream.go index 4caee151554..e31d72ef0be 100644 --- a/service/neptunedata/api_op_GetSparqlStream.go +++ b/service/neptunedata/api_op_GetSparqlStream.go @@ -11,21 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a stream for an RDF graph. With the Neptune Streams feature, you can -// generate a complete sequence of change-log entries that record every change made -// to your graph data as it happens. GetSparqlStream lets you collect these -// change-log entries for an RDF graph. The Neptune streams feature needs to be -// enabled on your Neptune DBcluster. To enable streams, set the neptune_streams (https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) -// DB cluster parameter to 1 . See Capturing graph changes in real time using -// Neptune streams (https://docs.aws.amazon.com/neptune/latest/userguide/streams.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Gets a stream for an RDF graph. +// +// With the Neptune Streams feature, you can generate a complete sequence of +// change-log entries that record every change made to your graph data as it +// happens. GetSparqlStream lets you collect these change-log entries for an RDF +// graph. +// +// The Neptune streams feature needs to be enabled on your Neptune DBcluster. To +// enable streams, set the [neptune_streams]DB cluster parameter to 1 . +// +// See [Capturing graph changes in real time using Neptune streams]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:GetStreamRecords (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:Sparql (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// SPARQL queries (see Condition keys available in Neptune IAM data-access policy -// statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// that allows the [neptune-db:GetStreamRecords]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:Sparql] IAM condition key can be used in the policy document to restrict +// the use of SPARQL queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune-db:QueryLanguage:Sparql]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys +// [neptune_streams]: https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams +// [Capturing graph changes in real time using Neptune streams]: https://docs.aws.amazon.com/neptune/latest/userguide/streams.html +// [neptune-db:GetStreamRecords]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords func (c *Client) GetSparqlStream(ctx context.Context, params *GetSparqlStreamInput, optFns ...func(*Options)) (*GetSparqlStreamOutput, error) { if params == nil { params = &GetSparqlStreamInput{} @@ -52,13 +61,17 @@ type GetSparqlStreamInput struct { Encoding types.Encoding // Can be one of: + // // - AT_SEQUENCE_NUMBER – Indicates that reading should start from the event // sequence number specified jointly by the commitNum and opNum parameters. + // // - AFTER_SEQUENCE_NUMBER – Indicates that reading should start right after the // event sequence number specified jointly by the commitNum and opNum parameters. + // // - TRIM_HORIZON – Indicates that reading should start at the last untrimmed // record in the system, which is the oldest unexpired (not yet deleted) record in // the change-log stream. + // // - LATEST – Indicates that reading should start at the most recent record in // the system, which is the latest unexpired (not yet deleted) record in the // change-log stream. @@ -67,8 +80,9 @@ type GetSparqlStreamInput struct { // Specifies the maximum number of records to return. There is also a size limit // of 10 MB on the response that can't be modified and that takes precedence over // the number of records specified in the limit parameter. The response does - // include a threshold-breaching record if the 10 MB limit was reached. The range - // for limit is 1 to 100,000, with a default of 10. + // include a threshold-breaching record if the 10 MB limit was reached. + // + // The range for limit is 1 to 100,000, with a default of 10. Limit *int64 // The operation sequence number within the specified commit to start reading from @@ -86,10 +100,11 @@ type GetSparqlStreamOutput struct { // This member is required. Format *string - // Sequence identifier of the last change in the stream response. An event ID is - // composed of two fields: a commitNum , which identifies a transaction that - // changed the graph, and an opNum , which identifies a specific operation within - // that transaction: + // Sequence identifier of the last change in the stream response. + // + // An event ID is composed of two fields: a commitNum , which identifies a + // transaction that changed the graph, and an opNum , which identifies a specific + // operation within that transaction: // // This member is required. LastEventId map[string]string diff --git a/service/neptunedata/api_op_ListGremlinQueries.go b/service/neptunedata/api_op_ListGremlinQueries.go index 93bdeadb973..a934cbb113f 100644 --- a/service/neptunedata/api_op_ListGremlinQueries.go +++ b/service/neptunedata/api_op_ListGremlinQueries.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists active Gremlin queries. See Gremlin query status API (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) -// for details about the output. When invoking this operation in a Neptune cluster -// that has IAM authentication enabled, the IAM user or role making the request -// must have a policy attached that allows the neptune-db:GetQueryStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// Gremlin queries (see Condition keys available in Neptune IAM data-access policy -// statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// Lists active Gremlin queries. See [Gremlin query status API] for details about the output. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetQueryStatus]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:Gremlin] IAM condition key can be used in the policy document to restrict +// the use of Gremlin queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [neptune-db:GetQueryStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus +// [Gremlin query status API]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html +// [neptune-db:QueryLanguage:Gremlin]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ListGremlinQueries(ctx context.Context, params *ListGremlinQueriesInput, optFns ...func(*Options)) (*ListGremlinQueriesOutput, error) { if params == nil { params = &ListGremlinQueriesInput{} diff --git a/service/neptunedata/api_op_ListLoaderJobs.go b/service/neptunedata/api_op_ListLoaderJobs.go index 88276e9cea7..99087618aea 100644 --- a/service/neptunedata/api_op_ListLoaderJobs.go +++ b/service/neptunedata/api_op_ListLoaderJobs.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of the loadIds for all active loader jobs. When invoking this -// operation in a Neptune cluster that has IAM authentication enabled, the IAM user -// or role making the request must have a policy attached that allows the -// neptune-db:ListLoaderJobs (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs) -// IAM action in that cluster.. +// Retrieves a list of the loadIds for all active loader jobs. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:ListLoaderJobs]IAM action in that cluster.. +// +// [neptune-db:ListLoaderJobs]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listloaderjobs func (c *Client) ListLoaderJobs(ctx context.Context, params *ListLoaderJobsInput, optFns ...func(*Options)) (*ListLoaderJobsOutput, error) { if params == nil { params = &ListLoaderJobsInput{} diff --git a/service/neptunedata/api_op_ListMLDataProcessingJobs.go b/service/neptunedata/api_op_ListMLDataProcessingJobs.go index 2f6428f294e..d1beaa6cd7d 100644 --- a/service/neptunedata/api_op_ListMLDataProcessingJobs.go +++ b/service/neptunedata/api_op_ListMLDataProcessingJobs.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of Neptune ML data processing jobs. See Listing active -// data-processing jobs using the Neptune ML dataprocessing command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Returns a list of Neptune ML data processing jobs. See [Listing active data-processing jobs using the Neptune ML dataprocessing command]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:ListMLDataProcessingJobs (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs) -// IAM action in that cluster. +// that allows the [neptune-db:ListMLDataProcessingJobs]IAM action in that cluster. +// +// [Listing active data-processing jobs using the Neptune ML dataprocessing command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html#machine-learning-api-dataprocessing-list-jobs +// [neptune-db:ListMLDataProcessingJobs]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmldataprocessingjobs func (c *Client) ListMLDataProcessingJobs(ctx context.Context, params *ListMLDataProcessingJobsInput, optFns ...func(*Options)) (*ListMLDataProcessingJobsOutput, error) { if params == nil { params = &ListMLDataProcessingJobsInput{} diff --git a/service/neptunedata/api_op_ListMLEndpoints.go b/service/neptunedata/api_op_ListMLEndpoints.go index 1b8c9370cf5..9995029bd1c 100644 --- a/service/neptunedata/api_op_ListMLEndpoints.go +++ b/service/neptunedata/api_op_ListMLEndpoints.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists existing inference endpoints. See Managing inference endpoints using the -// endpoints command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Lists existing inference endpoints. See [Managing inference endpoints using the endpoints command]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:ListMLEndpoints (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints) -// IAM action in that cluster. +// that allows the [neptune-db:ListMLEndpoints]IAM action in that cluster. +// +// [Managing inference endpoints using the endpoints command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-endpoints.html +// [neptune-db:ListMLEndpoints]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlendpoints func (c *Client) ListMLEndpoints(ctx context.Context, params *ListMLEndpointsInput, optFns ...func(*Options)) (*ListMLEndpointsOutput, error) { if params == nil { params = &ListMLEndpointsInput{} diff --git a/service/neptunedata/api_op_ListMLModelTrainingJobs.go b/service/neptunedata/api_op_ListMLModelTrainingJobs.go index 15762b9d2e7..985df9fd404 100644 --- a/service/neptunedata/api_op_ListMLModelTrainingJobs.go +++ b/service/neptunedata/api_op_ListMLModelTrainingJobs.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists Neptune ML model-training jobs. See Model training using the modeltraining -// command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Lists Neptune ML model-training jobs. See [Model training using the modeltraining command]modeltraining . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:neptune-db:ListMLModelTrainingJobs (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs) -// IAM action in that cluster. +// that allows the [neptune-db:neptune-db:ListMLModelTrainingJobs]IAM action in that cluster. +// +// [Model training using the modeltraining command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html +// [neptune-db:neptune-db:ListMLModelTrainingJobs]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#neptune-db:listmlmodeltrainingjobs func (c *Client) ListMLModelTrainingJobs(ctx context.Context, params *ListMLModelTrainingJobsInput, optFns ...func(*Options)) (*ListMLModelTrainingJobsOutput, error) { if params == nil { params = &ListMLModelTrainingJobsInput{} diff --git a/service/neptunedata/api_op_ListMLModelTransformJobs.go b/service/neptunedata/api_op_ListMLModelTransformJobs.go index 4d5d933bef4..ae86a5c9930 100644 --- a/service/neptunedata/api_op_ListMLModelTransformJobs.go +++ b/service/neptunedata/api_op_ListMLModelTransformJobs.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of model transform job IDs. See Use a trained model to generate -// new model artifacts (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Returns a list of model transform job IDs. See [Use a trained model to generate new model artifacts]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:ListMLModelTransformJobs (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs) -// IAM action in that cluster. +// that allows the [neptune-db:ListMLModelTransformJobs]IAM action in that cluster. +// +// [Use a trained model to generate new model artifacts]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html +// [neptune-db:ListMLModelTransformJobs]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#listmlmodeltransformjobs func (c *Client) ListMLModelTransformJobs(ctx context.Context, params *ListMLModelTransformJobsInput, optFns ...func(*Options)) (*ListMLModelTransformJobsOutput, error) { if params == nil { params = &ListMLModelTransformJobsInput{} diff --git a/service/neptunedata/api_op_ListOpenCypherQueries.go b/service/neptunedata/api_op_ListOpenCypherQueries.go index e61cde5e314..29185ef16b2 100644 --- a/service/neptunedata/api_op_ListOpenCypherQueries.go +++ b/service/neptunedata/api_op_ListOpenCypherQueries.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists active openCypher queries. See Neptune openCypher status endpoint (https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html) -// for more information. When invoking this operation in a Neptune cluster that has -// IAM authentication enabled, the IAM user or role making the request must have a -// policy attached that allows the neptune-db:GetQueryStatus (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus) -// IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys) -// IAM condition key can be used in the policy document to restrict the use of -// openCypher queries (see Condition keys available in Neptune IAM data-access -// policy statements (https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html) -// ). +// Lists active openCypher queries. See [Neptune openCypher status endpoint] for more information. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:GetQueryStatus]IAM action in that cluster. +// +// Note that the [neptune-db:QueryLanguage:OpenCypher] IAM condition key can be used in the policy document to restrict +// the use of openCypher queries (see [Condition keys available in Neptune IAM data-access policy statements]). +// +// [Condition keys available in Neptune IAM data-access policy statements]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html +// [Neptune openCypher status endpoint]: https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-opencypher-status.html +// [neptune-db:GetQueryStatus]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus +// [neptune-db:QueryLanguage:OpenCypher]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys func (c *Client) ListOpenCypherQueries(ctx context.Context, params *ListOpenCypherQueriesInput, optFns ...func(*Options)) (*ListOpenCypherQueriesOutput, error) { if params == nil { params = &ListOpenCypherQueriesInput{} @@ -37,7 +41,7 @@ func (c *Client) ListOpenCypherQueries(ctx context.Context, params *ListOpenCyph type ListOpenCypherQueriesInput struct { - // When set to TRUE and other parameters are not present, causes status + // When set to TRUE and other parameters are not present, causes status // information to be returned for waiting queries as well as for running queries. IncludeWaiting *bool diff --git a/service/neptunedata/api_op_ManagePropertygraphStatistics.go b/service/neptunedata/api_op_ManagePropertygraphStatistics.go index 8e6fa347e01..e3ac62df1fd 100644 --- a/service/neptunedata/api_op_ManagePropertygraphStatistics.go +++ b/service/neptunedata/api_op_ManagePropertygraphStatistics.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Manages the generation and use of property graph statistics. When invoking this -// operation in a Neptune cluster that has IAM authentication enabled, the IAM user -// or role making the request must have a policy attached that allows the -// neptune-db:ManageStatistics (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) -// IAM action in that cluster. +// Manages the generation and use of property graph statistics. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:ManageStatistics]IAM action in that cluster. +// +// [neptune-db:ManageStatistics]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics func (c *Client) ManagePropertygraphStatistics(ctx context.Context, params *ManagePropertygraphStatisticsInput, optFns ...func(*Options)) (*ManagePropertygraphStatisticsOutput, error) { if params == nil { params = &ManagePropertygraphStatisticsInput{} diff --git a/service/neptunedata/api_op_ManageSparqlStatistics.go b/service/neptunedata/api_op_ManageSparqlStatistics.go index f80e3bec4da..5b5fb56860f 100644 --- a/service/neptunedata/api_op_ManageSparqlStatistics.go +++ b/service/neptunedata/api_op_ManageSparqlStatistics.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Manages the generation and use of RDF graph statistics. When invoking this -// operation in a Neptune cluster that has IAM authentication enabled, the IAM user -// or role making the request must have a policy attached that allows the -// neptune-db:ManageStatistics (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics) -// IAM action in that cluster. +// Manages the generation and use of RDF graph statistics. +// +// When invoking this operation in a Neptune cluster that has IAM authentication +// enabled, the IAM user or role making the request must have a policy attached +// that allows the [neptune-db:ManageStatistics]IAM action in that cluster. +// +// [neptune-db:ManageStatistics]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#managestatistics func (c *Client) ManageSparqlStatistics(ctx context.Context, params *ManageSparqlStatisticsInput, optFns ...func(*Options)) (*ManageSparqlStatisticsOutput, error) { if params == nil { params = &ManageSparqlStatisticsInput{} diff --git a/service/neptunedata/api_op_StartLoaderJob.go b/service/neptunedata/api_op_StartLoaderJob.go index 3052f66d288..cba1274e5fb 100644 --- a/service/neptunedata/api_op_StartLoaderJob.go +++ b/service/neptunedata/api_op_StartLoaderJob.go @@ -12,11 +12,14 @@ import ( ) // Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a -// Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest Data (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Neptune DB instance. See [Using the Amazon Neptune Bulk Loader to Ingest Data]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:StartLoaderJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob) -// IAM action in that cluster. +// that allows the [neptune-db:StartLoaderJob]IAM action in that cluster. +// +// [neptune-db:StartLoaderJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startloaderjob +// [Using the Amazon Neptune Bulk Loader to Ingest Data]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load.html func (c *Client) StartLoaderJob(ctx context.Context, params *StartLoaderJobInput, optFns ...func(*Options)) (*StartLoaderJobOutput, error) { if params == nil { params = &StartLoaderJobInput{} @@ -35,26 +38,38 @@ func (c *Client) StartLoaderJob(ctx context.Context, params *StartLoaderJobInput type StartLoaderJobInput struct { // The format of the data. For more information about data formats for the Neptune - // Loader command, see Load Data Formats (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html) - // . Allowed values - // - csv for the Gremlin CSV data format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) - // . - // - opencypher for the openCypher CSV data format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) - // . - // - ntriples for the N-Triples RDF data format (https://www.w3.org/TR/n-triples/) - // . - // - nquads for the N-Quads RDF data format (https://www.w3.org/TR/n-quads/) . - // - rdfxml for the RDF\XML RDF data format (https://www.w3.org/TR/rdf-syntax-grammar/) - // . - // - turtle for the Turtle RDF data format (https://www.w3.org/TR/turtle/) . + // Loader command, see [Load Data Formats]. + // + // Allowed values + // + // - csv for the [Gremlin CSV data format]. + // + // - opencypher for the [openCypher CSV data format]. + // + // - ntriples for the [N-Triples RDF data format]. + // + // - nquads for the [N-Quads RDF data format]. + // + // - rdfxml for the [RDF\XML RDF data format]. + // + // - turtle for the [Turtle RDF data format]. + // + // [RDF\XML RDF data format]: https://www.w3.org/TR/rdf-syntax-grammar/ + // [Gremlin CSV data format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html + // [N-Triples RDF data format]: https://www.w3.org/TR/n-triples/ + // [openCypher CSV data format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html + // [Turtle RDF data format]: https://www.w3.org/TR/turtle/ + // [Load Data Formats]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format.html + // [N-Quads RDF data format]: https://www.w3.org/TR/n-quads/ // // This member is required. Format types.Format // The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB // instance for access to the S3 bucket. The IAM role ARN provided here should be - // attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html) - // . + // attached to the DB cluster (see [Adding the IAM Role to an Amazon Neptune Cluster]. + // + // [Adding the IAM Role to an Amazon Neptune Cluster]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-IAM-add-role-cluster.html // // This member is required. IamRoleArn *string @@ -67,116 +82,179 @@ type StartLoaderJobInput struct { // The source parameter accepts an S3 URI that identifies a single file, multiple // files, a folder, or multiple folders. Neptune loads every data file in any - // folder that is specified. The URI can be in any of the following formats. + // folder that is specified. + // + // The URI can be in any of the following formats. + // // - s3://(bucket_name)/(object-key-name) + // // - https://s3.amazonaws.com/(bucket_name)/(object-key-name) + // // - https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name) - // The object-key-name element of the URI is equivalent to the prefix (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters) - // parameter in an S3 ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) + // + // The object-key-name element of the URI is equivalent to the [prefix] parameter in an S3 [ListObjects] // API call. It identifies all the objects in the specified S3 bucket whose names // begin with that prefix. That can be a single file or folder, or multiple files - // and/or folders. The specified folder or folders can contain multiple vertex - // files and multiple edge files. + // and/or folders. + // + // The specified folder or folders can contain multiple vertex files and multiple + // edge files. + // + // [ListObjects]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html + // [prefix]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestParameters // // This member is required. Source *string // This is an optional parameter that can make a queued load request contingent on - // the successful completion of one or more previous jobs in the queue. Neptune can - // queue up as many as 64 load requests at a time, if their queueRequest - // parameters are set to "TRUE" . The dependencies parameter lets you make - // execution of such a queued request dependent on the successful completion of one - // or more specified previous requests in the queue. For example, if load Job-A - // and Job-B are independent of each other, but load Job-C needs Job-A and Job-B - // to be finished before it begins, proceed as follows: + // the successful completion of one or more previous jobs in the queue. + // + // Neptune can queue up as many as 64 load requests at a time, if their + // queueRequest parameters are set to "TRUE" . The dependencies parameter lets you + // make execution of such a queued request dependent on the successful completion + // of one or more specified previous requests in the queue. + // + // For example, if load Job-A and Job-B are independent of each other, but load + // Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows: + // // - Submit load-job-A and load-job-B one after another in any order, and save // their load-ids. + // // - Submit load-job-C with the load-ids of the two jobs in its dependencies // field: + // // Because of the dependencies parameter, the bulk loader will not start Job-C // until Job-A and Job-B have completed successfully. If either one of them fails, // Job-C will not be executed, and its status will be set to - // LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED . You can set up multiple levels of - // dependency in this way, so that the failure of one job will cause all requests - // that are directly or indirectly dependent on it to be cancelled. + // LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED . + // + // You can set up multiple levels of dependency in this way, so that the failure + // of one job will cause all requests that are directly or indirectly dependent on + // it to be cancelled. Dependencies []string - // failOnError – A flag to toggle a complete stop on an error. Allowed values: - // "TRUE" , "FALSE" . Default value: "TRUE" . When this parameter is set to "FALSE" - // , the loader tries to load all the data in the location specified, skipping any - // entries with errors. When this parameter is set to "TRUE" , the loader stops as - // soon as it encounters an error. Data loaded up to that point persists. + // failOnError – A flag to toggle a complete stop on an error. + // + // Allowed values: "TRUE" , "FALSE" . + // + // Default value: "TRUE" . + // + // When this parameter is set to "FALSE" , the loader tries to load all the data in + // the location specified, skipping any entries with errors. + // + // When this parameter is set to "TRUE" , the loader stops as soon as it encounters + // an error. Data loaded up to that point persists. FailOnError *bool - // The load job mode. Allowed values: RESUME , NEW , AUTO . Default value: AUTO . + // The load job mode. + // + // Allowed values: RESUME , NEW , AUTO . + // + // Default value: AUTO . + // // - RESUME – In RESUME mode, the loader looks for a previous load from this // source, and if it finds one, resumes that load job. If no previous load job is - // found, the loader stops. The loader avoids reloading files that were - // successfully loaded in a previous job. It only tries to process failed files. If - // you dropped previously loaded data from your Neptune cluster, that data is not - // reloaded in this mode. If a previous load job loaded all files from the same - // source successfully, nothing is reloaded, and the loader returns success. + // found, the loader stops. + // + // The loader avoids reloading files that were successfully loaded in a previous + // job. It only tries to process failed files. If you dropped previously loaded + // data from your Neptune cluster, that data is not reloaded in this mode. If a + // previous load job loaded all files from the same source successfully, nothing is + // reloaded, and the loader returns success. + // // - NEW – In NEW mode, the creates a new load request regardless of any previous // loads. You can use this mode to reload all the data from a source after dropping // previously loaded data from your Neptune cluster, or to load new data available // at the same source. + // // - AUTO – In AUTO mode, the loader looks for a previous load job from the same - // source, and if it finds one, resumes that job, just as in RESUME mode. If the - // loader doesn't find a previous load job from the same source, it loads all data - // from the source, just as in NEW mode. + // source, and if it finds one, resumes that job, just as in RESUME mode. + // + // If the loader doesn't find a previous load job from the same source, it loads + // all data from the source, just as in NEW mode. Mode types.Mode // The optional parallelism parameter can be set to reduce the number of threads - // used by the bulk load process. Allowed values: + // used by the bulk load process. + // + // Allowed values: + // // - LOW – The number of threads used is the number of available vCPUs divided by // 8. + // // - MEDIUM – The number of threads used is the number of available vCPUs divided // by 2. + // // - HIGH – The number of threads used is the same as the number of available // vCPUs. + // // - OVERSUBSCRIBE – The number of threads used is the number of available vCPUs // multiplied by 2. If this value is used, the bulk loader takes up all available - // resources. This does not mean, however, that the OVERSUBSCRIBE setting results - // in 100% CPU utilization. Because the load operation is I/O bound, the highest - // CPU utilization to expect is in the 60% to 70% range. - // Default value: HIGH The parallelism setting can sometimes result in a deadlock - // between threads when loading openCypher data. When this happens, Neptune returns - // the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting - // parallelism to a lower setting and retrying the load command. + // resources. + // + // This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU + // utilization. Because the load operation is I/O bound, the highest CPU + // utilization to expect is in the 60% to 70% range. + // + // Default value: HIGH + // + // The parallelism setting can sometimes result in a deadlock between threads when + // loading openCypher data. When this happens, Neptune returns the + // LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism + // to a lower setting and retrying the load command. Parallelism types.Parallelism // parserConfiguration – An optional object with additional parser configuration // values. Each of the child parameters is also optional: + // // - namedGraphUri – The default graph for all RDF formats when no graph is - // specified (for non-quads formats and NQUAD entries with no graph). The default - // is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph . - // - baseUri – The base URI for RDF/XML and Turtle formats. The default is - // https://aws.amazon.com/neptune/default . + // specified (for non-quads formats and NQUAD entries with no graph). + // + // The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph . + // + // - baseUri – The base URI for RDF/XML and Turtle formats. + // + // The default is https://aws.amazon.com/neptune/default . + // // - allowEmptyStrings – Gremlin users need to be able to pass empty string // values("") as node and edge properties when loading CSV data. If // allowEmptyStrings is set to false (the default), such empty strings are - // treated as nulls and are not loaded. If allowEmptyStrings is set to true , the - // loader treats empty strings as valid property values and loads them accordingly. + // treated as nulls and are not loaded. + // + // If allowEmptyStrings is set to true , the loader treats empty strings as valid + // property values and loads them accordingly. ParserConfiguration map[string]string // This is an optional flag parameter that indicates whether the load request can - // be queued up or not. You don't have to wait for one load job to complete before - // issuing the next one, because Neptune can queue up as many as 64 jobs at a time, - // provided that their queueRequest parameters are all set to "TRUE" . The queue - // order of the jobs will be first-in-first-out (FIFO). If the queueRequest - // parameter is omitted or set to "FALSE" , the load request will fail if another - // load job is already running. Allowed values: "TRUE" , "FALSE" . Default value: - // "FALSE" . + // be queued up or not. + // + // You don't have to wait for one load job to complete before issuing the next + // one, because Neptune can queue up as many as 64 jobs at a time, provided that + // their queueRequest parameters are all set to "TRUE" . The queue order of the + // jobs will be first-in-first-out (FIFO). + // + // If the queueRequest parameter is omitted or set to "FALSE" , the load request + // will fail if another load job is already running. + // + // Allowed values: "TRUE" , "FALSE" . + // + // Default value: "FALSE" . QueueRequest *bool // updateSingleCardinalityProperties is an optional parameter that controls how // the bulk loader treats a new value for single-cardinality vertex or edge - // properties. This is not supported for loading openCypher data. Allowed values: - // "TRUE" , "FALSE" . Default value: "FALSE" . By default, or when - // updateSingleCardinalityProperties is explicitly set to "FALSE" , the loader - // treats a new value as an error, because it violates single cardinality. When - // updateSingleCardinalityProperties is set to "TRUE" , on the other hand, the bulk - // loader replaces the existing value with the new one. If multiple edge or + // properties. This is not supported for loading openCypher data. + // + // Allowed values: "TRUE" , "FALSE" . + // + // Default value: "FALSE" . + // + // By default, or when updateSingleCardinalityProperties is explicitly set to + // "FALSE" , the loader treats a new value as an error, because it violates single + // cardinality. + // + // When updateSingleCardinalityProperties is set to "TRUE" , on the other hand, the + // bulk loader replaces the existing value with the new one. If multiple edge or // single-cardinality vertex property values are provided in the source file(s) // being loaded, the final value at the end of the bulk load could be any one of // those new values. The loader only guarantees that the existing value has been @@ -185,15 +263,19 @@ type StartLoaderJobInput struct { // This parameter is required only when loading openCypher data that contains // relationship IDs. It must be included and set to True when openCypher - // relationship IDs are explicitly provided in the load data (recommended). When - // userProvidedEdgeIds is absent or set to True , an :ID column must be present in - // every relationship file in the load. When userProvidedEdgeIds is present and - // set to False , relationship files in the load must not contain an :ID column. - // Instead, the Neptune loader automatically generates an ID for each relationship. - // It's useful to provide relationship IDs explicitly so that the loader can resume - // loading after error in the CSV data have been fixed, without having to reload - // any relationships that have already been loaded. If relationship IDs have not - // been explicitly assigned, the loader cannot resume a failed load if any + // relationship IDs are explicitly provided in the load data (recommended). + // + // When userProvidedEdgeIds is absent or set to True , an :ID column must be + // present in every relationship file in the load. + // + // When userProvidedEdgeIds is present and set to False , relationship files in the + // load must not contain an :ID column. Instead, the Neptune loader automatically + // generates an ID for each relationship. + // + // It's useful to provide relationship IDs explicitly so that the loader can + // resume loading after error in the CSV data have been fixed, without having to + // reload any relationships that have already been loaded. If relationship IDs have + // not been explicitly assigned, the loader cannot resume a failed load if any // relationship file has had to be corrected, and must instead reload all the // relationships. UserProvidedEdgeIds *bool diff --git a/service/neptunedata/api_op_StartMLDataProcessingJob.go b/service/neptunedata/api_op_StartMLDataProcessingJob.go index 179f6210ada..9449ac9e8ca 100644 --- a/service/neptunedata/api_op_StartMLDataProcessingJob.go +++ b/service/neptunedata/api_op_StartMLDataProcessingJob.go @@ -11,11 +11,14 @@ import ( ) // Creates a new Neptune ML data processing job for processing the graph data -// exported from Neptune for training. See The dataprocessing command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// exported from Neptune for training. See [The dataprocessing command]dataprocessing . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:StartMLModelDataProcessingJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob) -// IAM action in that cluster. +// that allows the [neptune-db:StartMLModelDataProcessingJob]IAM action in that cluster. +// +// [neptune-db:StartMLModelDataProcessingJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeldataprocessingjob +// [The dataprocessing command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-dataprocessing.html func (c *Client) StartMLDataProcessingJob(ctx context.Context, params *StartMLDataProcessingJobInput, optFns ...func(*Options)) (*StartMLDataProcessingJobOutput, error) { if params == nil { params = &StartMLDataProcessingJobInput{} diff --git a/service/neptunedata/api_op_StartMLModelTrainingJob.go b/service/neptunedata/api_op_StartMLModelTrainingJob.go index aaf9e7f8d71..73d86a627ef 100644 --- a/service/neptunedata/api_op_StartMLModelTrainingJob.go +++ b/service/neptunedata/api_op_StartMLModelTrainingJob.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Neptune ML model training job. See Model training using the -// modeltraining command (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Creates a new Neptune ML model training job. See [Model training using the modeltraining command]modeltraining . +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:StartMLModelTrainingJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob) -// IAM action in that cluster. +// that allows the [neptune-db:StartMLModelTrainingJob]IAM action in that cluster. +// +// [Model training using the modeltraining command]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-api-modeltraining.html +// [neptune-db:StartMLModelTrainingJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltrainingjob func (c *Client) StartMLModelTrainingJob(ctx context.Context, params *StartMLModelTrainingJobInput, optFns ...func(*Options)) (*StartMLModelTrainingJobOutput, error) { if params == nil { params = &StartMLModelTrainingJobInput{} diff --git a/service/neptunedata/api_op_StartMLModelTransformJob.go b/service/neptunedata/api_op_StartMLModelTransformJob.go index 7cc4fdcdd2a..0733a56fbd6 100644 --- a/service/neptunedata/api_op_StartMLModelTransformJob.go +++ b/service/neptunedata/api_op_StartMLModelTransformJob.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new model transform job. See Use a trained model to generate new -// model artifacts (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html) -// . When invoking this operation in a Neptune cluster that has IAM authentication +// Creates a new model transform job. See [Use a trained model to generate new model artifacts]. +// +// When invoking this operation in a Neptune cluster that has IAM authentication // enabled, the IAM user or role making the request must have a policy attached -// that allows the neptune-db:StartMLModelTransformJob (https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob) -// IAM action in that cluster. +// that allows the [neptune-db:StartMLModelTransformJob]IAM action in that cluster. +// +// [Use a trained model to generate new model artifacts]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html +// [neptune-db:StartMLModelTransformJob]: https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#startmlmodeltransformjob func (c *Client) StartMLModelTransformJob(ctx context.Context, params *StartMLModelTransformJobInput, optFns ...func(*Options)) (*StartMLModelTransformJobOutput, error) { if params == nil { params = &StartMLModelTransformJobInput{} diff --git a/service/neptunedata/doc.go b/service/neptunedata/doc.go index 7bf8088e4e3..4a42c47901f 100644 --- a/service/neptunedata/doc.go +++ b/service/neptunedata/doc.go @@ -3,9 +3,11 @@ // Package neptunedata provides the API client, operations, and parameter types // for Amazon NeptuneData. // -// Neptune Data API The Amazon Neptune data API provides SDK support for more than -// 40 of Neptune's data operations, including data loading, query execution, data -// inquiry, and machine learning. It supports the Gremlin and openCypher query -// languages, and is available in all SDK languages. It automatically signs API -// requests and greatly simplifies integrating Neptune into your applications. +// # Neptune Data API +// +// The Amazon Neptune data API provides SDK support for more than 40 of Neptune's +// data operations, including data loading, query execution, data inquiry, and +// machine learning. It supports the Gremlin and openCypher query languages, and is +// available in all SDK languages. It automatically signs API requests and greatly +// simplifies integrating Neptune into your applications. package neptunedata diff --git a/service/neptunedata/options.go b/service/neptunedata/options.go index 447aae298a4..f8da0e94963 100644 --- a/service/neptunedata/options.go +++ b/service/neptunedata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/neptunedata/types/enums.go b/service/neptunedata/types/enums.go index 5d5448df691..381f58ba4ee 100644 --- a/service/neptunedata/types/enums.go +++ b/service/neptunedata/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for Action. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Action) Values() []Action { return []Action{ "initiateDatabaseReset", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for Encoding. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Encoding) Values() []Encoding { return []Encoding{ "gzip", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "csv", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for GraphSummaryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GraphSummaryType) Values() []GraphSummaryType { return []GraphSummaryType{ "basic", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for IteratorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IteratorType) Values() []IteratorType { return []IteratorType{ "AT_SEQUENCE_NUMBER", @@ -112,8 +117,9 @@ const ( ) // Values returns all known values for Mode. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mode) Values() []Mode { return []Mode{ "RESUME", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for OpenCypherExplainMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpenCypherExplainMode) Values() []OpenCypherExplainMode { return []OpenCypherExplainMode{ "static", @@ -153,8 +160,9 @@ const ( ) // Values returns all known values for Parallelism. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Parallelism) Values() []Parallelism { return []Parallelism{ "LOW", @@ -194,8 +202,9 @@ const ( ) // Values returns all known values for S3BucketRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3BucketRegion) Values() []S3BucketRegion { return []S3BucketRegion{ "us-east-1", @@ -235,8 +244,9 @@ const ( // Values returns all known values for StatisticsAutoGenerationMode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatisticsAutoGenerationMode) Values() []StatisticsAutoGenerationMode { return []StatisticsAutoGenerationMode{ "disableAutoCompute", diff --git a/service/neptunedata/types/types.go b/service/neptunedata/types/types.go index a481cb32037..358c171b1c9 100644 --- a/service/neptunedata/types/types.go +++ b/service/neptunedata/types/types.go @@ -8,8 +8,9 @@ import ( "time" ) -// Contains custom model training parameters. See Custom models in Neptune ML (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html) -// . +// Contains custom model training parameters. See [Custom models in Neptune ML]. +// +// [Custom models in Neptune ML]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-custom-models.html type CustomModelTrainingParameters struct { // The path to the Amazon S3 location where the Python module implementing your @@ -34,9 +35,9 @@ type CustomModelTrainingParameters struct { noSmithyDocumentSerde } -// Contains custom model transform parameters. See Use a trained model to generate -// new model artifacts (https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html) -// . +// Contains custom model transform parameters. See [Use a trained model to generate new model artifacts]. +// +// [Use a trained model to generate new model artifacts]: https://docs.aws.amazon.com/neptune/latest/userguide/machine-learning-model-transform.html type CustomModelTransformParameters struct { // The path to the Amazon S3 location where the Python module implementing your @@ -90,8 +91,9 @@ type FastResetToken struct { noSmithyDocumentSerde } -// Captures the status of a Gremlin query (see the Gremlin query status API (https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html) -// page). +// Captures the status of a Gremlin query (see the [Gremlin query status API] page). +// +// [Gremlin query status API]: https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-api-status.html type GremlinQueryStatus struct { // The query statistics of the Gremlin query. @@ -195,10 +197,14 @@ type PropertygraphData struct { Key *string // The type of this Gremlin or openCypher element. Must be one of: + // // - v1 - Vertex label for Gremlin, or node label for openCypher. + // // - vp - Vertex properties for Gremlin, or node properties for openCypher. + // // - e - Edge and edge label for Gremlin, or relationship and relationship type // for openCypher. + // // - ep - Edge properties for Gremlin, or relationship properties for openCypher. // // This member is required. @@ -254,9 +260,9 @@ type PropertygraphRecord struct { } // The graph summary API returns a read-only list of node and edge labels and -// property keys, along with counts of nodes, edges, and properties. See Graph -// summary response for a property graph (PG) (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response) -// . +// property keys, along with counts of nodes, edges, and properties. See [Graph summary response for a property graph (PG)]. +// +// [Graph summary response for a property graph (PG)]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-pg-response type PropertygraphSummary struct { // A list of the distinct edge labels in the graph. @@ -386,8 +392,9 @@ type RDFGraphSummary struct { // Payload for an RDF graph summary response. type RDFGraphSummaryValueMap struct { - // The graph summary of an RDF graph. See Graph summary response for an RDF graph (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-rdf-response) - // . + // The graph summary of an RDF graph. See [Graph summary response for an RDF graph]. + // + // [Graph summary response for an RDF graph]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-graph-summary.html#neptune-graph-summary-rdf-response GraphSummary *RDFGraphSummary // The timestamp, in ISO 8601 format, of the time at which Neptune last computed @@ -410,12 +417,15 @@ type RefreshStatisticsIdMap struct { } // Neptune logs are converted to SPARQL quads in the graph using the Resource -// Description Framework (RDF) N-QUADS (https://www.w3.org/TR/n-quads/) language -// defined in the W3C RDF 1.1 N-Quads specification +// Description Framework (RDF) [N-QUADS]language defined in the W3C RDF 1.1 N-Quads +// specification +// +// [N-QUADS]: https://www.w3.org/TR/n-quads/ type SparqlData struct { - // Holds an N-QUADS (https://www.w3.org/TR/n-quads/) statement expressing the - // changed quad. + // Holds an [N-QUADS] statement expressing the changed quad. + // + // [N-QUADS]: https://www.w3.org/TR/n-quads/ // // This member is required. Stmt *string @@ -434,8 +444,9 @@ type SparqlRecord struct { CommitTimestampInMillis *int64 // The serialized SPARQL change record. The serialization formats of each record - // are described in more detail in Serialization Formats in Neptune Streams (https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.html) - // . + // are described in more detail in [Serialization Formats in Neptune Streams]. + // + // [Serialization Formats in Neptune Streams]: https://docs.aws.amazon.com/neptune/latest/userguide/streams-change-formats.html // // This member is required. Data *SparqlData @@ -461,9 +472,10 @@ type SparqlRecord struct { // Contains statistics information. The DFE engine uses information about the data // in your Neptune graph to make effective trade-offs when planning query // execution. This information takes the form of statistics that include so-called -// characteristic sets and predicate statistics that can guide query planning. See -// Managing statistics for the Neptune DFE to use (https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html) +// characteristic sets and predicate statistics that can guide query planning. See [Managing statistics for the Neptune DFE to use] // . +// +// [Managing statistics for the Neptune DFE to use]: https://docs.aws.amazon.com/neptune/latest/userguide/neptune-dfe-statistics.html type Statistics struct { // Indicates whether or not DFE statistics generation is enabled at all. @@ -479,9 +491,12 @@ type Statistics struct { Note *string // A StatisticsSummary structure that contains: + // // - signatureCount - The total number of signatures across all characteristic // sets. + // // - instanceCount - The total number of characteristic-set instances. + // // - predicateCount - The total number of unique predicates. SignatureInfo *StatisticsSummary diff --git a/service/neptunegraph/api_op_CancelImportTask.go b/service/neptunegraph/api_op_CancelImportTask.go index 6c32435d0b2..41628722f8a 100644 --- a/service/neptunegraph/api_op_CancelImportTask.go +++ b/service/neptunegraph/api_op_CancelImportTask.go @@ -69,9 +69,10 @@ type CancelImportTaskOutput struct { TaskId *string // Specifies the format of S3 data to be imported. Valid values are CSV , which - // identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) - // or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) - // . + // identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format]. + // + // [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html + // [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html Format types.Format // The unique identifier of the Neptune Analytics graph. diff --git a/service/neptunegraph/api_op_CreateGraph.go b/service/neptunegraph/api_op_CreateGraph.go index f85c9697f5b..50b6f263140 100644 --- a/service/neptunegraph/api_op_CreateGraph.go +++ b/service/neptunegraph/api_op_CreateGraph.go @@ -31,9 +31,11 @@ func (c *Client) CreateGraph(ctx context.Context, params *CreateGraphInput, optF type CreateGraphInput struct { - // A name for the new Neptune Analytics graph to be created. The name must contain - // from 1 to 63 letters, numbers, or hyphens, and its first character must be a - // letter. It cannot end with a hyphen or contain two consecutive hyphens. + // A name for the new Neptune Analytics graph to be created. + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. GraphName *string @@ -55,8 +57,10 @@ type CreateGraphInput struct { // access to graphs is IAM authenticated. ( true to enable, or false to disable. PublicConnectivity *bool - // The number of replicas in other AZs. Min =0, Max = 2, Default = 1. Additional - // charges equivalent to the m-NCUs selected for the graph apply for each replica. + // The number of replicas in other AZs. Min =0, Max = 2, Default = 1. + // + // Additional charges equivalent to the m-NCUs selected for the graph apply for + // each replica. ReplicaCount *int32 // Adds metadata tags to the new graph. These tags can also be used with cost @@ -87,9 +91,11 @@ type CreateGraphOutput struct { // This member is required. Id *string - // The graph name. For example: my-graph-1 . The name must contain from 1 to 63 - // letters, numbers, or hyphens, and its first character must be a letter. It - // cannot end with a hyphen or contain two consecutive hyphens. + // The graph name. For example: my-graph-1 . + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. Name *string @@ -111,16 +117,21 @@ type CreateGraphOutput struct { KmsKeyIdentifier *string // The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the - // graph. Min = 128 + // graph. + // + // Min = 128 ProvisionedMemory *int32 // Specifies whether or not the graph can be reachable over the internet. All - // access to graphs is IAM authenticated. If enabling public connectivity for the - // first time, there will be a delay while it is enabled. + // access to graphs is IAM authenticated. + // + // If enabling public connectivity for the first time, there will be a delay while + // it is enabled. PublicConnectivity *bool - // The number of replicas in other AZs. Default: If not specified, the default - // value is 1. + // The number of replicas in other AZs. + // + // Default: If not specified, the default value is 1. ReplicaCount *int32 // The ID of the source graph. diff --git a/service/neptunegraph/api_op_CreateGraphSnapshot.go b/service/neptunegraph/api_op_CreateGraphSnapshot.go index 37f0dab4c8f..b477017c43c 100644 --- a/service/neptunegraph/api_op_CreateGraphSnapshot.go +++ b/service/neptunegraph/api_op_CreateGraphSnapshot.go @@ -36,9 +36,11 @@ type CreateGraphSnapshotInput struct { // This member is required. GraphIdentifier *string - // The snapshot name. For example: my-snapshot-1 . The name must contain from 1 to - // 63 letters, numbers, or hyphens, and its first character must be a letter. It - // cannot end with a hyphen or contain two consecutive hyphens. + // The snapshot name. For example: my-snapshot-1 . + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. SnapshotName *string diff --git a/service/neptunegraph/api_op_CreateGraphUsingImportTask.go b/service/neptunegraph/api_op_CreateGraphUsingImportTask.go index 2138b9d16c6..9bcaf695492 100644 --- a/service/neptunegraph/api_op_CreateGraphUsingImportTask.go +++ b/service/neptunegraph/api_op_CreateGraphUsingImportTask.go @@ -14,10 +14,12 @@ import ( // Creates a new Neptune Analytics graph and imports data into it, either from // Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune -// database snapshot. The data can be loaded from files in S3 that in either the -// Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) -// or the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) -// . +// database snapshot. +// +// The data can be loaded from files in S3 that in either the [Gremlin CSV format] or the [openCypher load format]. +// +// [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html +// [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html func (c *Client) CreateGraphUsingImportTask(ctx context.Context, params *CreateGraphUsingImportTaskInput, optFns ...func(*Options)) (*CreateGraphUsingImportTaskOutput, error) { if params == nil { params = &CreateGraphUsingImportTaskInput{} @@ -35,9 +37,11 @@ func (c *Client) CreateGraphUsingImportTask(ctx context.Context, params *CreateG type CreateGraphUsingImportTaskInput struct { - // A name for the new Neptune Analytics graph to be created. The name must contain - // from 1 to 63 letters, numbers, or hyphens, and its first character must be a - // letter. It cannot end with a hyphen or contain two consecutive hyphens. + // A name for the new Neptune Analytics graph to be created. + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. GraphName *string @@ -63,9 +67,10 @@ type CreateGraphUsingImportTaskInput struct { FailOnError *bool // Specifies the format of S3 data to be imported. Valid values are CSV , which - // identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) - // or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) - // . + // identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format]. + // + // [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html + // [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html Format types.Format // Contains options for controlling the import process. For example, if the @@ -78,8 +83,9 @@ type CreateGraphUsingImportTaskInput struct { KmsKeyIdentifier *string // The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use - // for the graph. Default: 1024, or the approved upper limit for your account. If - // both the minimum and maximum values are specified, the max of the + // for the graph. Default: 1024, or the approved upper limit for your account. + // + // If both the minimum and maximum values are specified, the max of the // min-provisioned-memory and max-provisioned memory is used to create the graph. // If neither value is specified 128 m-NCUs are used. MaxProvisionedMemory *int32 @@ -93,8 +99,10 @@ type CreateGraphUsingImportTaskInput struct { PublicConnectivity *bool // The number of replicas in other AZs to provision on the new graph after import. - // Default = 0, Min = 0, Max = 2. Additional charges equivalent to the m-NCUs - // selected for the graph apply for each replica. + // Default = 0, Min = 0, Max = 2. + // + // Additional charges equivalent to the m-NCUs selected for the graph apply for + // each replica. ReplicaCount *int32 // Adds metadata tags to the new graph. These tags can also be used with cost @@ -138,9 +146,10 @@ type CreateGraphUsingImportTaskOutput struct { TaskId *string // Specifies the format of S3 data to be imported. Valid values are CSV , which - // identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) - // or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) - // . + // identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format]. + // + // [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html + // [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html Format types.Format // The unique identifier of the Neptune Analytics graph. diff --git a/service/neptunegraph/api_op_CreatePrivateGraphEndpoint.go b/service/neptunegraph/api_op_CreatePrivateGraphEndpoint.go index 9fa03824451..380792e0564 100644 --- a/service/neptunegraph/api_op_CreatePrivateGraphEndpoint.go +++ b/service/neptunegraph/api_op_CreatePrivateGraphEndpoint.go @@ -13,8 +13,9 @@ import ( ) // Create a private graph endpoint to allow private access from to the graph from -// within a VPC. You can attach security groups to the private graph endpoint. VPC -// endpoint charges apply. +// within a VPC. You can attach security groups to the private graph endpoint. +// +// VPC endpoint charges apply. func (c *Client) CreatePrivateGraphEndpoint(ctx context.Context, params *CreatePrivateGraphEndpointInput, optFns ...func(*Options)) (*CreatePrivateGraphEndpointOutput, error) { if params == nil { params = &CreatePrivateGraphEndpointInput{} @@ -40,7 +41,7 @@ type CreatePrivateGraphEndpointInput struct { // Subnets in which private graph endpoint ENIs are created. SubnetIds []string - // The VPC in which the private graph endpoint needs to be created. + // The VPC in which the private graph endpoint needs to be created. VpcId *string // Security groups to be attached to the private graph endpoint.. diff --git a/service/neptunegraph/api_op_DeleteGraphSnapshot.go b/service/neptunegraph/api_op_DeleteGraphSnapshot.go index 82bc2aa4de1..08a7925e34d 100644 --- a/service/neptunegraph/api_op_DeleteGraphSnapshot.go +++ b/service/neptunegraph/api_op_DeleteGraphSnapshot.go @@ -56,9 +56,11 @@ type DeleteGraphSnapshotOutput struct { // This member is required. Id *string - // The snapshot name. For example: my-snapshot-1 . The name must contain from 1 to - // 63 letters, numbers, or hyphens, and its first character must be a letter. It - // cannot end with a hyphen or contain two consecutive hyphens. + // The snapshot name. For example: my-snapshot-1 . + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. Name *string diff --git a/service/neptunegraph/api_op_ExecuteQuery.go b/service/neptunegraph/api_op_ExecuteQuery.go index 0c5c250296e..9131ab1e6a8 100644 --- a/service/neptunegraph/api_op_ExecuteQuery.go +++ b/service/neptunegraph/api_op_ExecuteQuery.go @@ -16,12 +16,16 @@ import ( "strings" ) -// Execute an openCypher query. When invoking this operation in a Neptune -// Analytics cluster, the IAM user or role making the request must have a policy -// attached that allows one of the following IAM actions in that cluster, depending -// on the query: +// Execute an openCypher query. +// +// When invoking this operation in a Neptune Analytics cluster, the IAM user or +// role making the request must have a policy attached that allows one of the +// following IAM actions in that cluster, depending on the query: +// // - neptune-graph:ReadDataViaQuery +// // - neptune-graph:WriteDataViaQuery +// // - neptune-graph:DeleteDataViaQuery func (c *Client) ExecuteQuery(ctx context.Context, params *ExecuteQueryInput, optFns ...func(*Options)) (*ExecuteQueryOutput, error) { if params == nil { diff --git a/service/neptunegraph/api_op_GetGraph.go b/service/neptunegraph/api_op_GetGraph.go index 2f3e0ce4b12..abc83475f20 100644 --- a/service/neptunegraph/api_op_GetGraph.go +++ b/service/neptunegraph/api_op_GetGraph.go @@ -229,12 +229,13 @@ type GraphAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetGraphInput, *GetGraphOutput, error) (bool, error) } @@ -435,12 +436,13 @@ type GraphDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetGraphInput, *GetGraphOutput, error) (bool, error) } diff --git a/service/neptunegraph/api_op_GetGraphSnapshot.go b/service/neptunegraph/api_op_GetGraphSnapshot.go index 106d9b25558..f4f7bda3ca8 100644 --- a/service/neptunegraph/api_op_GetGraphSnapshot.go +++ b/service/neptunegraph/api_op_GetGraphSnapshot.go @@ -61,9 +61,11 @@ type GetGraphSnapshotOutput struct { // This member is required. Id *string - // The snapshot name. For example: my-snapshot-1 . The name must contain from 1 to - // 63 letters, numbers, or hyphens, and its first character must be a letter. It - // cannot end with a hyphen or contain two consecutive hyphens. + // The snapshot name. For example: my-snapshot-1 . + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. Name *string @@ -207,12 +209,13 @@ type GraphSnapshotAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetGraphSnapshotInput, *GetGraphSnapshotOutput, error) (bool, error) } @@ -415,12 +418,13 @@ type GraphSnapshotDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetGraphSnapshotInput, *GetGraphSnapshotOutput, error) (bool, error) } diff --git a/service/neptunegraph/api_op_GetImportTask.go b/service/neptunegraph/api_op_GetImportTask.go index cafb0d5ba66..e15674e4a4b 100644 --- a/service/neptunegraph/api_op_GetImportTask.go +++ b/service/neptunegraph/api_op_GetImportTask.go @@ -63,22 +63,32 @@ type GetImportTaskOutput struct { Source *string // The status of the import task: + // // - INITIALIZING – The necessary resources needed to create the graph are being // prepared. + // // - ANALYZING_DATA – The data is being analyzed to determine the optimal // infrastructure configuration for the new graph. + // // - RE_PROVISIONING – The data did not fit into the provisioned graph, so it is // being re-provisioned with more capacity. + // // - IMPORTING – The data is being loaded. + // // - ERROR_ENCOUNTERED – An error has been encountered while trying to create // the graph and import the data. + // // - ERROR_ENCOUNTERED_ROLLING_BACK – Because of the error that was encountered, // the graph is being rolled back and all its resources released. + // // - SUCCEEDED – Graph creation and data loading succeeded. + // // - FAILED – Graph creation or data loading failed. When the status is FAILED , // you can use get-graphs to get more information about the state of the graph. + // // - CANCELLING – Because you cancelled the import task, cancellation is in // progress. + // // - CANCELLED – You have successfully cancelled the import task. // // This member is required. @@ -93,9 +103,10 @@ type GetImportTaskOutput struct { AttemptNumber *int32 // Specifies the format of S3 data to be imported. Valid values are CSV , which - // identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) - // or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) - // . + // identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format]. + // + // [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html + // [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html Format types.Format // The unique identifier of the Neptune Analytics graph. @@ -239,12 +250,13 @@ type ImportTaskSuccessfulWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetImportTaskInput, *GetImportTaskOutput, error) (bool, error) } @@ -481,12 +493,13 @@ type ImportTaskCancelledWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetImportTaskInput, *GetImportTaskOutput, error) (bool, error) } diff --git a/service/neptunegraph/api_op_GetPrivateGraphEndpoint.go b/service/neptunegraph/api_op_GetPrivateGraphEndpoint.go index 69779f3827a..90281756e60 100644 --- a/service/neptunegraph/api_op_GetPrivateGraphEndpoint.go +++ b/service/neptunegraph/api_op_GetPrivateGraphEndpoint.go @@ -202,12 +202,13 @@ type PrivateGraphEndpointAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetPrivateGraphEndpointInput, *GetPrivateGraphEndpointOutput, error) (bool, error) } @@ -412,12 +413,13 @@ type PrivateGraphEndpointDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetPrivateGraphEndpointInput, *GetPrivateGraphEndpointOutput, error) (bool, error) } diff --git a/service/neptunegraph/api_op_GetQuery.go b/service/neptunegraph/api_op_GetQuery.go index e3e9aa353b9..554b11e878f 100644 --- a/service/neptunegraph/api_op_GetQuery.go +++ b/service/neptunegraph/api_op_GetQuery.go @@ -14,9 +14,11 @@ import ( "strings" ) -// Retrieves the status of a specified query. When invoking this operation in a -// Neptune Analytics cluster, the IAM user or role making the request must have the -// neptune-graph:GetQueryStatus IAM action attached. +// Retrieves the status of a specified query. +// +// When invoking this operation in a Neptune Analytics cluster, the IAM user or +// role making the request must have the neptune-graph:GetQueryStatus IAM action +// attached. func (c *Client) GetQuery(ctx context.Context, params *GetQueryInput, optFns ...func(*Options)) (*GetQueryOutput, error) { if params == nil { params = &GetQueryInput{} diff --git a/service/neptunegraph/api_op_ListGraphSnapshots.go b/service/neptunegraph/api_op_ListGraphSnapshots.go index 732a15c2de3..b885a554607 100644 --- a/service/neptunegraph/api_op_ListGraphSnapshots.go +++ b/service/neptunegraph/api_op_ListGraphSnapshots.go @@ -33,17 +33,19 @@ type ListGraphSnapshotsInput struct { // The unique identifier of the Neptune Analytics graph. GraphIdentifier *string - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. MaxResults *int32 - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string noSmithyDocumentSerde @@ -61,10 +63,11 @@ type ListGraphSnapshotsOutput struct { // This member is required. GraphSnapshots []types.GraphSnapshotSummary - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string // Metadata pertaining to the operation's result. @@ -160,11 +163,12 @@ var _ ListGraphSnapshotsAPIClient = (*Client)(nil) // ListGraphSnapshotsPaginatorOptions is the paginator options for // ListGraphSnapshots type ListGraphSnapshotsPaginatorOptions struct { - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptunegraph/api_op_ListGraphs.go b/service/neptunegraph/api_op_ListGraphs.go index cdf7ea75204..6fece251fc5 100644 --- a/service/neptunegraph/api_op_ListGraphs.go +++ b/service/neptunegraph/api_op_ListGraphs.go @@ -30,17 +30,19 @@ func (c *Client) ListGraphs(ctx context.Context, params *ListGraphsInput, optFns type ListGraphsInput struct { - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. MaxResults *int32 - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string noSmithyDocumentSerde @@ -58,10 +60,11 @@ type ListGraphsOutput struct { // This member is required. Graphs []types.GraphSummary - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string // Metadata pertaining to the operation's result. @@ -155,11 +158,12 @@ var _ ListGraphsAPIClient = (*Client)(nil) // ListGraphsPaginatorOptions is the paginator options for ListGraphs type ListGraphsPaginatorOptions struct { - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptunegraph/api_op_ListImportTasks.go b/service/neptunegraph/api_op_ListImportTasks.go index 3426171d835..74ac299dc1c 100644 --- a/service/neptunegraph/api_op_ListImportTasks.go +++ b/service/neptunegraph/api_op_ListImportTasks.go @@ -30,17 +30,19 @@ func (c *Client) ListImportTasks(ctx context.Context, params *ListImportTasksInp type ListImportTasksInput struct { - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. MaxResults *int32 - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string noSmithyDocumentSerde @@ -58,10 +60,11 @@ type ListImportTasksOutput struct { // This member is required. Tasks []types.ImportTaskSummary - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string // Metadata pertaining to the operation's result. @@ -156,11 +159,12 @@ var _ ListImportTasksAPIClient = (*Client)(nil) // ListImportTasksPaginatorOptions is the paginator options for ListImportTasks type ListImportTasksPaginatorOptions struct { - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptunegraph/api_op_ListPrivateGraphEndpoints.go b/service/neptunegraph/api_op_ListPrivateGraphEndpoints.go index 44829802004..430ebb4da3d 100644 --- a/service/neptunegraph/api_op_ListPrivateGraphEndpoints.go +++ b/service/neptunegraph/api_op_ListPrivateGraphEndpoints.go @@ -35,17 +35,19 @@ type ListPrivateGraphEndpointsInput struct { // This member is required. GraphIdentifier *string - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. MaxResults *int32 - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string noSmithyDocumentSerde @@ -63,10 +65,11 @@ type ListPrivateGraphEndpointsOutput struct { // This member is required. PrivateGraphEndpoints []types.PrivateGraphEndpointSummary - // Pagination token used to paginate output. When this value is provided as input, - // the service returns results from where the previous response left off. When this - // value is present in output, it indicates that there are more results to - // retrieve. + // Pagination token used to paginate output. + // + // When this value is provided as input, the service returns results from where + // the previous response left off. When this value is present in output, it + // indicates that there are more results to retrieve. NextToken *string // Metadata pertaining to the operation's result. @@ -165,11 +168,12 @@ var _ ListPrivateGraphEndpointsAPIClient = (*Client)(nil) // ListPrivateGraphEndpointsPaginatorOptions is the paginator options for // ListPrivateGraphEndpoints type ListPrivateGraphEndpointsPaginatorOptions struct { - // The total number of records to return in the command's output. If the total - // number of records available is more than the value specified, nextToken is - // provided in the command's output. To resume pagination, provide the nextToken - // output value in the nextToken argument of a subsequent command. Do not use the - // nextToken response element directly outside of the Amazon CLI. + // The total number of records to return in the command's output. + // + // If the total number of records available is more than the value specified, + // nextToken is provided in the command's output. To resume pagination, provide the + // nextToken output value in the nextToken argument of a subsequent command. Do + // not use the nextToken response element directly outside of the Amazon CLI. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/neptunegraph/api_op_RestoreGraphFromSnapshot.go b/service/neptunegraph/api_op_RestoreGraphFromSnapshot.go index 8b31f890bab..f63a456e809 100644 --- a/service/neptunegraph/api_op_RestoreGraphFromSnapshot.go +++ b/service/neptunegraph/api_op_RestoreGraphFromSnapshot.go @@ -31,8 +31,9 @@ func (c *Client) RestoreGraphFromSnapshot(ctx context.Context, params *RestoreGr type RestoreGraphFromSnapshotInput struct { - // A name for the new Neptune Analytics graph to be created from the snapshot. The - // name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // A name for the new Neptune Analytics graph to be created from the snapshot. + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first // character must be a letter. It cannot end with a hyphen or contain two // consecutive hyphens. // @@ -49,15 +50,19 @@ type RestoreGraphFromSnapshotInput struct { DeletionProtection *bool // The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the - // graph. Min = 128 + // graph. + // + // Min = 128 ProvisionedMemory *int32 // Specifies whether or not the graph can be reachable over the internet. All // access to graphs is IAM authenticated. ( true to enable, or false to disable). PublicConnectivity *bool - // The number of replicas in other AZs. Min =0, Max = 2, Default =1 Additional - // charges equivalent to the m-NCUs selected for the graph apply for each replica. + // The number of replicas in other AZs. Min =0, Max = 2, Default =1 + // + // Additional charges equivalent to the m-NCUs selected for the graph apply for + // each replica. ReplicaCount *int32 // Adds metadata tags to the snapshot. These tags can also be used with cost diff --git a/service/neptunegraph/api_op_TagResource.go b/service/neptunegraph/api_op_TagResource.go index 29e7aa4bda2..8980364051a 100644 --- a/service/neptunegraph/api_op_TagResource.go +++ b/service/neptunegraph/api_op_TagResource.go @@ -34,16 +34,19 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The tags to be assigned to the Neptune Analytics resource. The tags are - // metadata that are specified as a list of key-value pairs: Key (string) – A key - // is the required name of the tag. The string value can be from 1 to 128 Unicode - // characters in length. It can't be prefixed with aws: and can only contain the - // set of Unicode characters specified by this Java regular expression: - // "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") . Value (string) – A value is the optional - // value of the tag. The string value can be from 1 to 256 Unicode characters in - // length. It can't be prefixed with aws: and can only contain the set of Unicode - // characters specified by this Java regular expression: - // "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") . + // The tags to be assigned to the Neptune Analytics resource. + // + // The tags are metadata that are specified as a list of key-value pairs: + // + // Key (string) – A key is the required name of the tag. The string value can be + // from 1 to 128 Unicode characters in length. It can't be prefixed with aws: and + // can only contain the set of Unicode characters specified by this Java regular + // expression: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") . + // + // Value (string) – A value is the optional value of the tag. The string value can + // be from 1 to 256 Unicode characters in length. It can't be prefixed with aws: + // and can only contain the set of Unicode characters specified by this Java + // regular expression: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$") . // // This member is required. Tags map[string]string diff --git a/service/neptunegraph/api_op_UpdateGraph.go b/service/neptunegraph/api_op_UpdateGraph.go index b8b8c8c49d2..d421e0bca00 100644 --- a/service/neptunegraph/api_op_UpdateGraph.go +++ b/service/neptunegraph/api_op_UpdateGraph.go @@ -41,7 +41,9 @@ type UpdateGraphInput struct { DeletionProtection *bool // The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the - // graph. Min = 128 + // graph. + // + // Min = 128 ProvisionedMemory *int32 // Specifies whether or not the graph can be reachable over the internet. All diff --git a/service/neptunegraph/options.go b/service/neptunegraph/options.go index 846efcca619..9be49291b98 100644 --- a/service/neptunegraph/options.go +++ b/service/neptunegraph/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/neptunegraph/types/enums.go b/service/neptunegraph/types/enums.go index 599f9cb46d2..7481dc71d85 100644 --- a/service/neptunegraph/types/enums.go +++ b/service/neptunegraph/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "CONCURRENT_MODIFICATION", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for ExplainMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExplainMode) Values() []ExplainMode { return []ExplainMode{ "STATIC", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "CSV", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for GraphStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GraphStatus) Values() []GraphStatus { return []GraphStatus{ "CREATING", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for GraphSummaryMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GraphSummaryMode) Values() []GraphSummaryMode { return []GraphSummaryMode{ "BASIC", @@ -119,8 +124,9 @@ const ( ) // Values returns all known values for ImportTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportTaskStatus) Values() []ImportTaskStatus { return []ImportTaskStatus{ "INITIALIZING", @@ -146,8 +152,9 @@ const ( ) // Values returns all known values for PlanCacheType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlanCacheType) Values() []PlanCacheType { return []PlanCacheType{ "ENABLED", @@ -168,6 +175,7 @@ const ( // Values returns all known values for PrivateGraphEndpointStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PrivateGraphEndpointStatus) Values() []PrivateGraphEndpointStatus { return []PrivateGraphEndpointStatus{ @@ -186,8 +194,9 @@ const ( ) // Values returns all known values for QueryLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryLanguage) Values() []QueryLanguage { return []QueryLanguage{ "OPEN_CYPHER", @@ -204,8 +213,9 @@ const ( ) // Values returns all known values for QueryState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryState) Values() []QueryState { return []QueryState{ "RUNNING", @@ -225,8 +235,9 @@ const ( ) // Values returns all known values for QueryStateInput. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryStateInput) Values() []QueryStateInput { return []QueryStateInput{ "ALL", @@ -247,8 +258,9 @@ const ( ) // Values returns all known values for SnapshotStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotStatus) Values() []SnapshotStatus { return []SnapshotStatus{ "CREATING", @@ -271,8 +283,9 @@ const ( // Values returns all known values for UnprocessableExceptionReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnprocessableExceptionReason) Values() []UnprocessableExceptionReason { return []UnprocessableExceptionReason{ "QUERY_TIMEOUT", @@ -298,6 +311,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/neptunegraph/types/types.go b/service/neptunegraph/types/types.go index 8e77c0fc08e..cd7f1213807 100644 --- a/service/neptunegraph/types/types.go +++ b/service/neptunegraph/types/types.go @@ -84,9 +84,11 @@ type GraphSnapshotSummary struct { // This member is required. Id *string - // The snapshot name. For example: my-snapshot-1 . The name must contain from 1 to - // 63 letters, numbers, or hyphens, and its first character must be a letter. It - // cannot end with a hyphen or contain two consecutive hyphens. + // The snapshot name. For example: my-snapshot-1 . + // + // The name must contain from 1 to 63 letters, numbers, or hyphens, and its first + // character must be a letter. It cannot end with a hyphen or contain two + // consecutive hyphens. // // This member is required. Name *string @@ -237,9 +239,10 @@ type ImportTaskSummary struct { TaskId *string // Specifies the format of S3 data to be imported. Valid values are CSV , which - // identifies the Gremlin CSV format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html) - // or OPENCYPHER , which identies the openCypher load format (https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html) - // . + // identifies the [Gremlin CSV format]or OPENCYPHER , which identies the [openCypher load format]. + // + // [Gremlin CSV format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-gremlin.html + // [openCypher load format]: https://docs.aws.amazon.com/neptune/latest/userguide/bulk-load-tutorial-format-opencypher.html Format Format // The unique identifier of the Neptune Analytics graph. diff --git a/service/networkfirewall/api_op_AssociateFirewallPolicy.go b/service/networkfirewall/api_op_AssociateFirewallPolicy.go index a868463ce04..ce8f87ef11c 100644 --- a/service/networkfirewall/api_op_AssociateFirewallPolicy.go +++ b/service/networkfirewall/api_op_AssociateFirewallPolicy.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) AssociateFirewallPolicy(ctx context.Context, params *AssociateFirewallPolicyInput, optFns ...func(*Options)) (*AssociateFirewallPolicyOutput, error) { if params == nil { params = &AssociateFirewallPolicyInput{} @@ -36,25 +38,29 @@ type AssociateFirewallPolicyInput struct { // This member is required. FirewallPolicyArn *string - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -76,14 +82,16 @@ type AssociateFirewallPolicyOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 1d945e13829..3b7d25208ed 100644 --- a/service/networkfirewall/api_op_AssociateSubnets.go +++ b/service/networkfirewall/api_op_AssociateSubnets.go @@ -12,11 +12,12 @@ import ( ) // Associates the specified subnets in the Amazon VPC to the firewall. You can -// specify one subnet for each of the Availability Zones that the VPC spans. This -// request creates an Network Firewall firewall endpoint in each of the subnets. To -// enable the firewall's protections, you must also modify the VPC's route tables -// for each subnet's Availability Zone, to redirect the traffic that's coming into -// and going out of the zone through the firewall endpoint. +// specify one subnet for each of the Availability Zones that the VPC spans. +// +// This request creates an Network Firewall firewall endpoint in each of the +// subnets. To enable the firewall's protections, you must also modify the VPC's +// route tables for each subnet's Availability Zone, to redirect the traffic that's +// coming into and going out of the zone through the firewall endpoint. func (c *Client) AssociateSubnets(ctx context.Context, params *AssociateSubnetsInput, optFns ...func(*Options)) (*AssociateSubnetsOutput, error) { if params == nil { params = &AssociateSubnetsInput{} @@ -39,25 +40,29 @@ type AssociateSubnetsInput struct { // This member is required. SubnetMappings []types.SubnetMapping - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -79,14 +84,16 @@ type AssociateSubnetsOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 2c43e24a778..e202a1044f0 100644 --- a/service/networkfirewall/api_op_CreateFirewall.go +++ b/service/networkfirewall/api_op_CreateFirewall.go @@ -12,17 +12,22 @@ import ( ) // Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC. +// // The firewall defines the configuration settings for an Network Firewall // firewall. The settings that you can define at creation include the firewall // policy, the subnets in your VPC to use for the firewall endpoints, and any tags -// that are attached to the firewall Amazon Web Services resource. After you create -// a firewall, you can provide additional settings, like the logging configuration. +// 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{} @@ -46,8 +51,7 @@ type CreateFirewallInput struct { // This member is required. FirewallName *string - // The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for - // the firewall. + // The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall. // // This member is required. FirewallPolicyArn *string @@ -60,7 +64,9 @@ type CreateFirewallInput struct { SubnetMappings []types.SubnetMapping // The unique identifier of the VPC where Network Firewall should create the - // firewall. You can't change this setting after you create the firewall. + // firewall. + // + // You can't change this setting after you create the firewall. // // This member is required. VpcId *string @@ -101,9 +107,8 @@ type CreateFirewallOutput struct { // 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 - // this for a firewall by calling DescribeFirewall and providing the firewall name - // and ARN. + // Detailed information about the current status of a Firewall. You can retrieve this for + // a firewall by calling DescribeFirewalland providing the firewall name and ARN. FirewallStatus *types.FirewallStatus // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_CreateFirewallPolicy.go b/service/networkfirewall/api_op_CreateFirewallPolicy.go index b8b29975a01..3c2d81809cd 100644 --- a/service/networkfirewall/api_op_CreateFirewallPolicy.go +++ b/service/networkfirewall/api_op_CreateFirewallPolicy.go @@ -12,6 +12,7 @@ import ( ) // 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. @@ -47,13 +48,17 @@ 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 - // 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 - // 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. + // 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 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. DryRun bool // A complex type that contains settings for encryption of your firewall policy @@ -68,22 +73,22 @@ 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 . + // 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. // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the firewall policy. The token marks the state of the - // 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. + // 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. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_CreateRuleGroup.go b/service/networkfirewall/api_op_CreateRuleGroup.go index a7aae3eaced..c7d1fdfae91 100644 --- a/service/networkfirewall/api_op_CreateRuleGroup.go +++ b/service/networkfirewall/api_op_CreateRuleGroup.go @@ -12,8 +12,10 @@ import ( ) // 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 . +// 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{} @@ -34,29 +36,42 @@ type CreateRuleGroupInput struct { // The maximum operating resources that this rule group can use. Rule group // capacity is fixed at creation. When you update a rule group, you are limited to // 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 - // 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: + // 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 CreateRuleGroupwith 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. + // 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 @@ -85,30 +100,39 @@ 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 - // 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 - // 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. + // 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 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. DryRun bool // A complex type that contains settings for encryption of your rule group // resources. EncryptionConfiguration *types.EncryptionConfiguration - // An object that defines the rule group rules. You must provide either this rule - // group setting or a Rules setting, but not both. + // An object that defines the rule group rules. + // + // You must provide either this rule group setting or a Rules setting, but not + // both. RuleGroup *types.RuleGroup // A string containing stateful rule group rules specifications in Suricata flat // format, with one rule per line. Use this to import your existing Suricata - // compatible rule groups. You must provide either this rules setting or a - // populated RuleGroup setting, but not both. You can provide your rule group - // specification in Suricata flat format through this setting when you create or - // update your rule group. The call response returns a RuleGroup object that - // Network Firewall has populated from your string. + // compatible rule groups. + // + // You must provide either this rules setting or a populated RuleGroup setting, + // but not both. + // + // You can provide your rule group specification in Suricata flat format through + // this setting when you create or update your rule group. The call response + // returns a RuleGroupobject that Network Firewall has populated from your string. Rules *string // A complex type that contains metadata about the rule group that your own rule @@ -124,22 +148,22 @@ type CreateRuleGroupInput struct { type CreateRuleGroupOutput struct { - // 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 . + // 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. // // This member is required. RuleGroupResponse *types.RuleGroupResponse // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the rule group. The token marks the state of the rule group - // 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, - // 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. + // 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, 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. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go b/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go index 841983c5354..bf612f6dbf2 100644 --- a/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_CreateTLSInspectionConfiguration.go @@ -14,17 +14,22 @@ import ( // Creates an Network Firewall TLS inspection configuration. A TLS inspection // configuration contains Certificate Manager certificate associations between and // the scope configurations that Network Firewall uses to decrypt and re-encrypt -// traffic traveling through your firewall. After you create a TLS inspection -// configuration, you can associate it with a new firewall policy. To update the -// settings for a TLS inspection configuration, use -// 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 -// about TLS inspection configurations, use ListTLSInspectionConfigurations and -// DescribeTLSInspectionConfiguration . For more information about TLS inspection -// configurations, see Inspecting 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. +// traffic traveling through your firewall. +// +// After you create a TLS inspection configuration, you can associate it with a +// new firewall policy. +// +// To update the settings for a TLS inspection configuration, use 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 about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration. +// +// For more information about TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations] in the Network +// Firewall Developer Guide. +// +// [Inspecting SSL/TLS traffic with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html func (c *Client) CreateTLSInspectionConfiguration(ctx context.Context, params *CreateTLSInspectionConfigurationInput, optFns ...func(*Options)) (*CreateTLSInspectionConfigurationOutput, error) { if params == nil { params = &CreateTLSInspectionConfigurationInput{} @@ -42,20 +47,22 @@ 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 - // 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 new Network Firewall firewall policy, then you apply the firewall - // policy to a firewall. Network Firewall acts as a proxy service to decrypt and - // inspect the traffic traveling through your firewalls. 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 Inspecting 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. + // 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 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 new Network Firewall + // firewall policy, then you apply the firewall policy to a firewall. Network + // Firewall acts as a proxy service to decrypt and inspect the traffic traveling + // through your firewalls. 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 [Inspecting SSL/TLS traffic with TLS inspection configurations]in the Network Firewall Developer Guide. + // + // [Inspecting SSL/TLS traffic with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html // // This member is required. TLSInspectionConfiguration *types.TLSInspectionConfiguration @@ -74,9 +81,10 @@ type CreateTLSInspectionConfigurationInput struct { // 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) - // in the Network Firewall Developer Guide. + // encryption of your Network Firewall resources, see [Encryption at rest with Amazon Web Services Key Managment Service]in the Network Firewall + // Developer Guide. + // + // [Encryption at rest with Amazon Web Services Key Managment Service]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html EncryptionConfiguration *types.EncryptionConfiguration // The key:value pairs to associate with the resource. @@ -88,18 +96,18 @@ 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 // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the TLS inspection configuration. The token marks the state - // of the TLS inspection configuration resource at the time of the request. To make - // changes to the TLS inspection configuration, you provide the token in your - // request. Network Firewall uses the token to ensure that the TLS inspection + // of the TLS inspection configuration resource at the time of the request. + // + // To make 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 diff --git a/service/networkfirewall/api_op_DeleteFirewall.go b/service/networkfirewall/api_op_DeleteFirewall.go index bb5d60c3ae5..6f6c9a0d8a7 100644 --- a/service/networkfirewall/api_op_DeleteFirewall.go +++ b/service/networkfirewall/api_op_DeleteFirewall.go @@ -11,16 +11,18 @@ 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 -// 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 -// 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 . +// 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 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. func (c *Client) DeleteFirewall(ctx context.Context, params *DeleteFirewallInput, optFns ...func(*Options)) (*DeleteFirewallOutput, error) { if params == nil { params = &DeleteFirewallInput{} @@ -38,13 +40,15 @@ func (c *Client) DeleteFirewall(ctx context.Context, params *DeleteFirewallInput type DeleteFirewallInput struct { - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string noSmithyDocumentSerde @@ -55,14 +59,15 @@ type DeleteFirewallOutput struct { // The firewall defines the configuration settings for an Network Firewall // firewall. These settings include the firewall policy, the subnets in your VPC to // 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 . + // 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. Firewall *types.Firewall - // 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. + // Detailed information about the current status of a Firewall. You can retrieve this for + // a firewall by calling DescribeFirewalland providing the firewall name and ARN. FirewallStatus *types.FirewallStatus // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_DeleteFirewallPolicy.go b/service/networkfirewall/api_op_DeleteFirewallPolicy.go index cc43f9fb6fe..46a1d2f4201 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{} @@ -29,13 +29,15 @@ func (c *Client) DeleteFirewallPolicy(ctx context.Context, params *DeleteFirewal type DeleteFirewallPolicyInput struct { - // The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN - // or the name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall policy. + // + // You must specify the ARN or the name, and you can specify both. FirewallPolicyArn *string // The descriptive name of the firewall policy. You can't change the name of a - // firewall policy after you create it. You must specify the ARN or the name, and - // you can specify both. + // firewall policy after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallPolicyName *string noSmithyDocumentSerde @@ -43,8 +45,7 @@ type DeleteFirewallPolicyInput struct { type DeleteFirewallPolicyOutput struct { - // The object containing the definition of the FirewallPolicyResponse that you - // asked to delete. + // The object containing the definition of the FirewallPolicyResponse that you asked to delete. // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse diff --git a/service/networkfirewall/api_op_DeleteRuleGroup.go b/service/networkfirewall/api_op_DeleteRuleGroup.go index 878dda90f9a..d9e5ff168a9 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{} @@ -29,19 +29,22 @@ func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInp type DeleteRuleGroupInput struct { - // The Amazon Resource Name (ARN) of the rule group. You must specify the ARN or - // the name, and you can specify both. + // The Amazon Resource Name (ARN) of the rule group. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupArn *string // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupName *string // 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 . + // rules. + // + // This setting is required for requests that do not include the RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -49,9 +52,8 @@ type DeleteRuleGroupInput struct { type DeleteRuleGroupOutput struct { - // 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 . + // 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. // // This member is required. RuleGroupResponse *types.RuleGroupResponse diff --git a/service/networkfirewall/api_op_DeleteTLSInspectionConfiguration.go b/service/networkfirewall/api_op_DeleteTLSInspectionConfiguration.go index 842b41b47fa..58d4fc8ac7a 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{} @@ -29,13 +29,15 @@ func (c *Client) DeleteTLSInspectionConfiguration(ctx context.Context, params *D type DeleteTLSInspectionConfigurationInput struct { - // The Amazon Resource Name (ARN) of the TLS inspection configuration. You must - // specify the ARN or the name, and you can specify both. + // The Amazon Resource Name (ARN) of the TLS inspection configuration. + // + // You must specify the ARN or the name, and you can specify both. TLSInspectionConfigurationArn *string // The descriptive name of the TLS inspection configuration. You can't change the - // name of a TLS inspection configuration after you create it. You must specify the - // ARN or the name, and you can specify both. + // name of a TLS inspection configuration after you create it. + // + // You must specify the ARN or the name, and you can specify both. TLSInspectionConfigurationName *string noSmithyDocumentSerde @@ -44,9 +46,8 @@ 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 760f1f859bc..7be4b159d51 100644 --- a/service/networkfirewall/api_op_DescribeFirewall.go +++ b/service/networkfirewall/api_op_DescribeFirewall.go @@ -29,13 +29,15 @@ func (c *Client) DescribeFirewall(ctx context.Context, params *DescribeFirewallI type DescribeFirewallInput struct { - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string noSmithyDocumentSerde @@ -47,21 +49,22 @@ type DescribeFirewallOutput struct { // 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 - // this for a firewall by calling DescribeFirewall and providing the firewall name - // and ARN. + // Detailed information about the current status of a Firewall. You can retrieve this for + // a firewall by calling DescribeFirewalland providing the firewall name and ARN. FirewallStatus *types.FirewallStatus // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 6dfb5261423..1dc55f9555a 100644 --- a/service/networkfirewall/api_op_DescribeFirewallPolicy.go +++ b/service/networkfirewall/api_op_DescribeFirewallPolicy.go @@ -29,13 +29,15 @@ func (c *Client) DescribeFirewallPolicy(ctx context.Context, params *DescribeFir type DescribeFirewallPolicyInput struct { - // The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN - // or the name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall policy. + // + // You must specify the ARN or the name, and you can specify both. FirewallPolicyArn *string // The descriptive name of the firewall policy. You can't change the name of a - // firewall policy after you create it. You must specify the ARN or the name, and - // you can specify both. + // firewall policy after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallPolicyName *string noSmithyDocumentSerde @@ -43,22 +45,22 @@ 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 . + // 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. // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the firewall policy. The token marks the state of the - // 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. + // 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. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_DescribeLoggingConfiguration.go b/service/networkfirewall/api_op_DescribeLoggingConfiguration.go index da03b0f04f4..6097dbe86bf 100644 --- a/service/networkfirewall/api_op_DescribeLoggingConfiguration.go +++ b/service/networkfirewall/api_op_DescribeLoggingConfiguration.go @@ -29,13 +29,15 @@ func (c *Client) DescribeLoggingConfiguration(ctx context.Context, params *Descr type DescribeLoggingConfigurationInput struct { - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string noSmithyDocumentSerde @@ -46,7 +48,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 3147c2dd262..804c96c5095 100644 --- a/service/networkfirewall/api_op_DescribeRuleGroup.go +++ b/service/networkfirewall/api_op_DescribeRuleGroup.go @@ -34,19 +34,22 @@ type DescribeRuleGroupInput struct { // Network Firewall runs the analysis. AnalyzeRuleGroup bool - // The Amazon Resource Name (ARN) of the rule group. You must specify the ARN or - // the name, and you can specify both. + // The Amazon Resource Name (ARN) of the rule group. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupArn *string // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupName *string // 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 . + // rules. + // + // This setting is required for requests that do not include the RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -54,35 +57,37 @@ type DescribeRuleGroupInput struct { type DescribeRuleGroupOutput struct { - // 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 . + // 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. // // This member is required. RuleGroupResponse *types.RuleGroupResponse // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the rule group. The token marks the state of the rule group - // 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, - // 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. + // 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, 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. // // This member is required. 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 - // 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 - // in an Network Firewall firewall policy, then you use the policy in a firewall. - // You can reference a rule group from more than one firewall policy, and you can - // use a firewall policy in more than one firewall. + // 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 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 in an Network Firewall + // firewall policy, then you use the policy in a firewall. You can reference a rule + // group from more than one firewall policy, and you can use a firewall policy in + // more than one firewall. RuleGroup *types.RuleGroup // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_DescribeRuleGroupMetadata.go b/service/networkfirewall/api_op_DescribeRuleGroupMetadata.go index 4e71817b787..a3183992612 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{} @@ -34,19 +34,22 @@ func (c *Client) DescribeRuleGroupMetadata(ctx context.Context, params *Describe type DescribeRuleGroupMetadataInput struct { // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupArn *string // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupName *string // 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 . + // rules. + // + // This setting is required for requests that do not include the RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -55,15 +58,17 @@ type DescribeRuleGroupMetadataInput struct { type DescribeRuleGroupMetadataOutput struct { // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. // // This member is required. RuleGroupArn *string // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. // // This member is required. RuleGroupName *string @@ -71,9 +76,10 @@ type DescribeRuleGroupMetadataOutput struct { // The maximum operating resources that this rule group can use. Rule group // capacity is fixed at creation. When you update a rule group, you are limited to // 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 . + // 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 CreateRuleGroupwith DryRun set to TRUE . Capacity *int32 // Returns the metadata objects for the specified rule group. @@ -88,8 +94,9 @@ 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 . + // rules. + // + // This setting is required for requests that do not include the 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 102a7f2c1ca..6f06036792f 100644 --- a/service/networkfirewall/api_op_DescribeTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_DescribeTLSInspectionConfiguration.go @@ -29,13 +29,15 @@ func (c *Client) DescribeTLSInspectionConfiguration(ctx context.Context, params type DescribeTLSInspectionConfigurationInput struct { - // The Amazon Resource Name (ARN) of the TLS inspection configuration. You must - // specify the ARN or the name, and you can specify both. + // The Amazon Resource Name (ARN) of the TLS inspection configuration. + // + // You must specify the ARN or the name, and you can specify both. TLSInspectionConfigurationArn *string // The descriptive name of the TLS inspection configuration. You can't change the - // name of a TLS inspection configuration after you create it. You must specify the - // ARN or the name, and you can specify both. + // name of a TLS inspection configuration after you create it. + // + // You must specify the ARN or the name, and you can specify both. TLSInspectionConfigurationName *string noSmithyDocumentSerde @@ -44,18 +46,18 @@ 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 // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the TLS inspection configuration. The token marks the state - // of the TLS inspection configuration resource at the time of the request. To make - // changes to the TLS inspection configuration, you provide the token in your - // request. Network Firewall uses the token to ensure that the TLS inspection + // of the TLS inspection configuration resource at the time of the request. + // + // To make 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 @@ -65,20 +67,22 @@ type DescribeTLSInspectionConfigurationOutput struct { // 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 - // 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 new Network Firewall firewall policy, then you apply the firewall - // policy to a firewall. Network Firewall acts as a proxy service to decrypt and - // inspect the traffic traveling through your firewalls. 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 Inspecting 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. + // 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 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 new Network Firewall + // firewall policy, then you apply the firewall policy to a firewall. Network + // Firewall acts as a proxy service to decrypt and inspect the traffic traveling + // through your firewalls. 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 [Inspecting SSL/TLS traffic with TLS inspection configurations]in the Network Firewall Developer Guide. + // + // [Inspecting SSL/TLS traffic with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html TLSInspectionConfiguration *types.TLSInspectionConfiguration // Metadata pertaining to the operation's result. diff --git a/service/networkfirewall/api_op_DisassociateSubnets.go b/service/networkfirewall/api_op_DisassociateSubnets.go index 79ded0ad063..ef1001431ca 100644 --- a/service/networkfirewall/api_op_DisassociateSubnets.go +++ b/service/networkfirewall/api_op_DisassociateSubnets.go @@ -36,25 +36,29 @@ type DisassociateSubnetsInput struct { // This member is required. SubnetIds []string - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -76,14 +80,16 @@ type DisassociateSubnetsOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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_ListFirewalls.go b/service/networkfirewall/api_op_ListFirewalls.go index 7d207286c92..eea32adbf07 100644 --- a/service/networkfirewall/api_op_ListFirewalls.go +++ b/service/networkfirewall/api_op_ListFirewalls.go @@ -13,6 +13,7 @@ import ( // Retrieves the metadata for the firewalls that you have defined. If you provide // VPC identifiers in your request, this returns only the firewalls for those VPCs. +// // Depending on your setting for max results and the number of firewalls, a single // call might not return the full list. func (c *Client) ListFirewalls(ctx context.Context, params *ListFirewallsInput, optFns ...func(*Options)) (*ListFirewallsOutput, error) { diff --git a/service/networkfirewall/api_op_ListTagsForResource.go b/service/networkfirewall/api_op_ListTagsForResource.go index efcd49fc8e1..232dad1fa3f 100644 --- a/service/networkfirewall/api_op_ListTagsForResource.go +++ b/service/networkfirewall/api_op_ListTagsForResource.go @@ -15,9 +15,10 @@ import ( // 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. +// 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) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/networkfirewall/api_op_PutResourcePolicy.go b/service/networkfirewall/api_op_PutResourcePolicy.go index 6d2147ff4ba..15b3248547a 100644 --- a/service/networkfirewall/api_op_PutResourcePolicy.go +++ b/service/networkfirewall/api_op_PutResourcePolicy.go @@ -13,21 +13,29 @@ import ( // Creates or updates an IAM policy for your rule group or firewall policy. Use // this to share rule groups and firewall policies between accounts. This operation // works in conjunction with the Amazon Web Services Resource Access Manager (RAM) -// service to manage resource sharing for Network Firewall. Use this operation to -// create or update a resource policy for your rule group or firewall policy. In -// the policy, you specify the accounts that you want to share the resource with -// and the operations that you want the accounts to be able to perform. When you -// 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. +// service to manage resource sharing for Network Firewall. // -// 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) -// . +// Use this operation to create or update a resource policy for your rule group or +// firewall policy. In the policy, you specify the accounts that you want to share +// the resource with and the operations that you want the accounts to be able to +// perform. +// +// When you 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] +// - - Returns the Amazon Resource Names (ARNs) of the resource share +// invitations. +// +// [AcceptResourceShareInvitation] +// - - Accepts the share invitation for a specified resource share. +// +// For additional information about resource sharing using RAM, see [Resource Access Manager User Guide]. +// +// [AcceptResourceShareInvitation]: https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html +// [GetResourceShareInvitations]: https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html +// [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{} @@ -47,15 +55,24 @@ type PutResourcePolicyInput struct { // The IAM policy statement that lists the accounts that you want to share your // 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: + // 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 // Actions section of the statement: + // // - 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 . diff --git a/service/networkfirewall/api_op_TagResource.go b/service/networkfirewall/api_op_TagResource.go index 9bedb44d1e9..bc796abbdad 100644 --- a/service/networkfirewall/api_op_TagResource.go +++ b/service/networkfirewall/api_op_TagResource.go @@ -15,9 +15,10 @@ import ( // 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. +// 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) { if params == nil { params = &TagResourceInput{} diff --git a/service/networkfirewall/api_op_UntagResource.go b/service/networkfirewall/api_op_UntagResource.go index d4e2dab990b..f79687aa2e0 100644 --- a/service/networkfirewall/api_op_UntagResource.go +++ b/service/networkfirewall/api_op_UntagResource.go @@ -14,9 +14,10 @@ import ( // 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 manage -// tags for the Amazon Web Services resources that you manage through Network -// Firewall: firewalls, firewall policies, and rule groups. +// each Amazon Web Services resource, up to 50 tags for a resource. +// +// You can manage tags for the Amazon Web Services resources that you manage +// through Network Firewall: firewalls, firewall policies, and rule groups. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go b/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go index 81e11416e41..631cbb0fb56 100644 --- a/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go +++ b/service/networkfirewall/api_op_UpdateFirewallDeleteProtection.go @@ -39,25 +39,29 @@ type UpdateFirewallDeleteProtectionInput struct { // This member is required. DeleteProtection bool - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -82,14 +86,16 @@ type UpdateFirewallDeleteProtectionOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 30e33252c04..1532237fbd8 100644 --- a/service/networkfirewall/api_op_UpdateFirewallDescription.go +++ b/service/networkfirewall/api_op_UpdateFirewallDescription.go @@ -33,25 +33,29 @@ type UpdateFirewallDescriptionInput struct { // Firewall removes the description for the firewall. Description *string - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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,14 +77,16 @@ type UpdateFirewallDescriptionOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 b65f3ae382d..d7124305f73 100644 --- a/service/networkfirewall/api_op_UpdateFirewallEncryptionConfiguration.go +++ b/service/networkfirewall/api_op_UpdateFirewallEncryptionConfiguration.go @@ -34,9 +34,10 @@ type UpdateFirewallEncryptionConfigurationInput struct { // 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) - // in the Network Firewall Developer Guide. + // encryption of your Network Firewall resources, see [Encryption at rest with Amazon Web Services Key Managment Service]in the Network Firewall + // Developer Guide. + // + // [Encryption at rest with Amazon Web Services Key Managment Service]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html EncryptionConfiguration *types.EncryptionConfiguration // The Amazon Resource Name (ARN) of the firewall. @@ -48,14 +49,16 @@ type UpdateFirewallEncryptionConfigurationInput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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,9 +73,10 @@ type UpdateFirewallEncryptionConfigurationOutput struct { // 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) - // in the Network Firewall Developer Guide. + // encryption of your Network Firewall resources, see [Encryption at rest with Amazon Web Services Key Managment Service]in the Network Firewall + // Developer Guide. + // + // [Encryption at rest with Amazon Web Services Key Managment Service]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html EncryptionConfiguration *types.EncryptionConfiguration // The Amazon Resource Name (ARN) of the firewall. @@ -84,14 +88,16 @@ type UpdateFirewallEncryptionConfigurationOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 aa053c05377..db0cc3c1047 100644 --- a/service/networkfirewall/api_op_UpdateFirewallPolicy.go +++ b/service/networkfirewall/api_op_UpdateFirewallPolicy.go @@ -29,23 +29,23 @@ func (c *Client) UpdateFirewallPolicy(ctx context.Context, params *UpdateFirewal type UpdateFirewallPolicyInput struct { - // The updated firewall policy to use for the firewall. You can't add or remove a - // TLSInspectionConfiguration after you create a firewall policy. However, you can - // replace an existing TLS inspection configuration with another - // TLSInspectionConfiguration . + // The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration + // after you create a firewall policy. However, you can replace an existing TLS + // inspection configuration with another TLSInspectionConfiguration . // // This member is required. FirewallPolicy *types.FirewallPolicy // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the firewall policy. The token marks the state of the - // 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. + // 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. // // This member is required. UpdateToken *string @@ -54,26 +54,32 @@ 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 - // 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 - // 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. + // 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 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. DryRun bool // A complex type that contains settings for encryption of your firewall policy // resources. EncryptionConfiguration *types.EncryptionConfiguration - // The Amazon Resource Name (ARN) of the firewall policy. You must specify the ARN - // or the name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall policy. + // + // You must specify the ARN or the name, and you can specify both. FirewallPolicyArn *string // The descriptive name of the firewall policy. You can't change the name of a - // firewall policy after you create it. You must specify the ARN or the name, and - // you can specify both. + // firewall policy after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallPolicyName *string noSmithyDocumentSerde @@ -81,22 +87,22 @@ 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 . + // 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. // // This member is required. FirewallPolicyResponse *types.FirewallPolicyResponse // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the firewall policy. The token marks the state of the - // 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. + // 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. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go b/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go index dde6c8a6f66..64a805c957b 100644 --- a/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go +++ b/service/networkfirewall/api_op_UpdateFirewallPolicyChangeProtection.go @@ -39,25 +39,29 @@ type UpdateFirewallPolicyChangeProtectionInput struct { // This member is required. FirewallPolicyChangeProtection bool - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -82,14 +86,16 @@ type UpdateFirewallPolicyChangeProtectionOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 dada6b7321f..648abf2f4ab 100644 --- a/service/networkfirewall/api_op_UpdateLoggingConfiguration.go +++ b/service/networkfirewall/api_op_UpdateLoggingConfiguration.go @@ -11,17 +11,21 @@ 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 -// 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 +// 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 LogDestinationConfigat 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. // @@ -45,13 +49,15 @@ func (c *Client) UpdateLoggingConfiguration(ctx context.Context, params *UpdateL type UpdateLoggingConfigurationInput struct { - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // Defines how Network Firewall performs logging for a firewall. If you omit this @@ -70,7 +76,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 9e538c341ac..c32be5641c1 100644 --- a/service/networkfirewall/api_op_UpdateRuleGroup.go +++ b/service/networkfirewall/api_op_UpdateRuleGroup.go @@ -13,9 +13,10 @@ import ( // Updates the rule settings for the specified rule group. You use a rule group by // reference in one or more firewall policies. When you modify a rule group, you -// modify all firewall policies that use the rule group. To update a rule group, -// first call DescribeRuleGroup to retrieve the current RuleGroup object, update -// the object as needed, and then provide the updated object to this call. +// modify all firewall policies that use the rule group. +// +// To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the +// object as needed, and then provide the updated object to this call. func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error) { if params == nil { params = &UpdateRuleGroupInput{} @@ -35,13 +36,14 @@ type UpdateRuleGroupInput struct { // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the rule group. The token marks the state of the rule group - // 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, - // 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. + // 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, 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. // // This member is required. UpdateToken *string @@ -57,39 +59,50 @@ 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 - // 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 - // 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. + // 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 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. DryRun bool // A complex type that contains settings for encryption of your rule group // resources. EncryptionConfiguration *types.EncryptionConfiguration - // An object that defines the rule group rules. You must provide either this rule - // group setting or a Rules setting, but not both. + // An object that defines the rule group rules. + // + // You must provide either this rule group setting or a Rules setting, but not + // both. RuleGroup *types.RuleGroup - // The Amazon Resource Name (ARN) of the rule group. You must specify the ARN or - // the name, and you can specify both. + // The Amazon Resource Name (ARN) of the rule group. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupArn *string // The descriptive name of the rule group. You can't change the name of a rule - // group after you create it. You must specify the ARN or the name, and you can - // specify both. + // group after you create it. + // + // You must specify the ARN or the name, and you can specify both. RuleGroupName *string // A string containing stateful rule group rules specifications in Suricata flat // format, with one rule per line. Use this to import your existing Suricata - // compatible rule groups. You must provide either this rules setting or a - // populated RuleGroup setting, but not both. You can provide your rule group - // specification in Suricata flat format through this setting when you create or - // update your rule group. The call response returns a RuleGroup object that - // Network Firewall has populated from your string. + // compatible rule groups. + // + // You must provide either this rules setting or a populated RuleGroup setting, + // but not both. + // + // You can provide your rule group specification in Suricata flat format through + // this setting when you create or update your rule group. The call response + // returns a RuleGroupobject that Network Firewall has populated from your string. Rules *string // A complex type that contains metadata about the rule group that your own rule @@ -99,8 +112,9 @@ 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 . + // rules. + // + // This setting is required for requests that do not include the RuleGroupARN . Type types.RuleGroupType noSmithyDocumentSerde @@ -108,22 +122,22 @@ type UpdateRuleGroupInput struct { type UpdateRuleGroupOutput struct { - // 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 . + // 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. // // This member is required. RuleGroupResponse *types.RuleGroupResponse // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the rule group. The token marks the state of the rule group - // 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, - // 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. + // 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, 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. // // This member is required. UpdateToken *string diff --git a/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go b/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go index 110f58f0431..f74a0d15947 100644 --- a/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go +++ b/service/networkfirewall/api_op_UpdateSubnetChangeProtection.go @@ -35,25 +35,29 @@ type UpdateSubnetChangeProtectionInput struct { // This member is required. SubnetChangeProtection bool - // The Amazon Resource Name (ARN) of the firewall. You must specify the ARN or the - // name, and you can specify both. + // The Amazon Resource Name (ARN) of the firewall. + // + // You must specify the ARN or the name, and you can specify both. FirewallArn *string // The descriptive name of the firewall. You can't change the name of a firewall - // after you create it. You must specify the ARN or the name, and you can specify - // both. + // after you create it. + // + // You must specify the ARN or the name, and you can specify both. FirewallName *string // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // current copy of it with a new token. Reapply your changes as needed, then try // the operation again using the new token. UpdateToken *string @@ -78,14 +82,16 @@ type UpdateSubnetChangeProtectionOutput struct { // An optional token that you can use for optimistic locking. Network Firewall // returns a token to your requests that access the firewall. The token marks the - // state of the firewall resource at the time of the request. To make an - // unconditional change to the firewall, omit the token in your update request. - // Without the token, Network Firewall performs your updates regardless of whether - // the firewall has changed since you last retrieved it. To make a conditional - // 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 + // state of the firewall resource at the time of the request. + // + // To make an unconditional change to the firewall, omit the token in your update + // request. Without the token, Network Firewall performs your updates regardless of + // whether the firewall has changed since you last retrieved it. + // + // To make a conditional 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 // 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 23a46711a47..6df65a13994 100644 --- a/service/networkfirewall/api_op_UpdateTLSInspectionConfiguration.go +++ b/service/networkfirewall/api_op_UpdateTLSInspectionConfiguration.go @@ -15,10 +15,11 @@ import ( // inspection configuration. You use a TLS inspection configuration by referencing // it in one or more firewall policies. When you modify a TLS inspection // configuration, you modify all firewall policies that use the TLS inspection -// configuration. To update a TLS inspection configuration, first call -// DescribeTLSInspectionConfiguration to retrieve the current -// TLSInspectionConfiguration object, update the object as needed, and then provide -// the updated object to this call. +// configuration. +// +// To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration +// object, update the object as needed, and then provide the updated object to this +// call. func (c *Client) UpdateTLSInspectionConfiguration(ctx context.Context, params *UpdateTLSInspectionConfigurationInput, optFns ...func(*Options)) (*UpdateTLSInspectionConfigurationOutput, error) { if params == nil { params = &UpdateTLSInspectionConfigurationInput{} @@ -36,29 +37,32 @@ 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 - // 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 new Network Firewall firewall policy, then you apply the firewall - // policy to a firewall. Network Firewall acts as a proxy service to decrypt and - // inspect the traffic traveling through your firewalls. 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 Inspecting 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. + // 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 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 new Network Firewall + // firewall policy, then you apply the firewall policy to a firewall. Network + // Firewall acts as a proxy service to decrypt and inspect the traffic traveling + // through your firewalls. 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 [Inspecting SSL/TLS traffic with TLS inspection configurations]in the Network Firewall Developer Guide. + // + // [Inspecting SSL/TLS traffic with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html // // This member is required. TLSInspectionConfiguration *types.TLSInspectionConfiguration // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the TLS inspection configuration. The token marks the state - // of the TLS inspection configuration resource at the time of the request. To make - // changes to the TLS inspection configuration, you provide the token in your - // request. Network Firewall uses the token to ensure that the TLS inspection + // of the TLS inspection configuration resource at the time of the request. + // + // To make 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 @@ -88,18 +92,18 @@ 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 // A token used for optimistic locking. Network Firewall returns a token to your // requests that access the TLS inspection configuration. The token marks the state - // of the TLS inspection configuration resource at the time of the request. To make - // changes to the TLS inspection configuration, you provide the token in your - // request. Network Firewall uses the token to ensure that the TLS inspection + // of the TLS inspection configuration resource at the time of the request. + // + // To make 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 diff --git a/service/networkfirewall/doc.go b/service/networkfirewall/doc.go index 55e994046b4..9be6e7668fb 100644 --- a/service/networkfirewall/doc.go +++ b/service/networkfirewall/doc.go @@ -6,20 +6,22 @@ // 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/) -// . +// information about using the Amazon Web Services REST APIs, see [Amazon Web Services APIs]. +// +// 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]. +// +// - 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] +// . // // Network Firewall is a stateful, managed, network firewall and intrusion // detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). @@ -28,33 +30,51 @@ // 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: +// information about Suricata, see the [Suricata website]. +// +// 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: +// and in Network Firewall. For information about using Amazon VPC, see [Amazon VPC User Guide]. +// +// 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. +// +// [Suricata website]: https://suricata.io/ +// [Amazon Web Services APIs]: https://docs.aws.amazon.com/general/latest/gr/aws-apis.html +// [Amazon VPC User Guide]: https://docs.aws.amazon.com/vpc/latest/userguide/ +// +// [Network Firewall Developer Guide]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/ +// [Amazon Web Services SDKs]: http://aws.amazon.com/tools/#SDKs package networkfirewall diff --git a/service/networkfirewall/options.go b/service/networkfirewall/options.go index 062e8dc6628..9eef84305fc 100644 --- a/service/networkfirewall/options.go +++ b/service/networkfirewall/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/networkfirewall/types/enums.go b/service/networkfirewall/types/enums.go index 12aebc3a81c..633f5fd6a26 100644 --- a/service/networkfirewall/types/enums.go +++ b/service/networkfirewall/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AttachmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentStatus) Values() []AttachmentStatus { return []AttachmentStatus{ "CREATING", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for ConfigurationSyncState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationSyncState) Values() []ConfigurationSyncState { return []ConfigurationSyncState{ "PENDING", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "CUSTOMER_KMS", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for FirewallStatusValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallStatusValue) Values() []FirewallStatusValue { return []FirewallStatusValue{ "PROVISIONING", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for GeneratedRulesType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeneratedRulesType) Values() []GeneratedRulesType { return []GeneratedRulesType{ "ALLOWLIST", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for IdentifiedType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentifiedType) Values() []IdentifiedType { return []IdentifiedType{ "STATELESS_RULE_FORWARDING_ASYMMETRICALLY", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for IPAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IPAddressType) Values() []IPAddressType { return []IPAddressType{ "DUALSTACK", @@ -152,8 +159,9 @@ const ( ) // Values returns all known values for LogDestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogDestinationType) Values() []LogDestinationType { return []LogDestinationType{ "S3", @@ -171,8 +179,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "ALERT", @@ -188,8 +197,9 @@ const ( ) // Values returns all known values for OverrideAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverrideAction) Values() []OverrideAction { return []OverrideAction{ "DROP_TO_ALERT", @@ -206,8 +216,9 @@ const ( ) // Values returns all known values for PerObjectSyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PerObjectSyncStatus) Values() []PerObjectSyncStatus { return []PerObjectSyncStatus{ "PENDING", @@ -225,8 +236,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "MANAGED", @@ -243,8 +255,9 @@ const ( ) // Values returns all known values for ResourceManagedType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceManagedType) Values() []ResourceManagedType { return []ResourceManagedType{ "AWS_MANAGED_THREAT_SIGNATURES", @@ -262,8 +275,9 @@ const ( ) // Values returns all known values for ResourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStatus) Values() []ResourceStatus { return []ResourceStatus{ "ACTIVE", @@ -282,8 +296,9 @@ const ( ) // Values returns all known values for RevocationCheckAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RevocationCheckAction) Values() []RevocationCheckAction { return []RevocationCheckAction{ "PASS", @@ -301,8 +316,9 @@ const ( ) // Values returns all known values for RuleGroupType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleGroupType) Values() []RuleGroupType { return []RuleGroupType{ "STATELESS", @@ -319,8 +335,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -339,8 +356,9 @@ const ( ) // Values returns all known values for StatefulAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatefulAction) Values() []StatefulAction { return []StatefulAction{ "PASS", @@ -359,8 +377,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "FORWARD", @@ -394,8 +413,9 @@ const ( ) // Values returns all known values for StatefulRuleProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatefulRuleProtocol) Values() []StatefulRuleProtocol { return []StatefulRuleProtocol{ "IP", @@ -430,8 +450,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "DROP", @@ -449,8 +470,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "TLS_SNI", @@ -473,8 +495,9 @@ const ( ) // Values returns all known values for TCPFlag. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TCPFlag) Values() []TCPFlag { return []TCPFlag{ "FIN", diff --git a/service/networkfirewall/types/errors.go b/service/networkfirewall/types/errors.go index ba9c0daf284..e6b9af93c49 100644 --- a/service/networkfirewall/types/errors.go +++ b/service/networkfirewall/types/errors.go @@ -89,9 +89,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. type InvalidRequestException struct { diff --git a/service/networkfirewall/types/types.go b/service/networkfirewall/types/types.go index 6ca55fa08f3..bcaef2e6cff 100644 --- a/service/networkfirewall/types/types.go +++ b/service/networkfirewall/types/types.go @@ -7,43 +7,51 @@ import ( "time" ) -// A custom action to use in stateless rule actions settings. This is used in -// CustomAction . +// A custom action to use in stateless rule actions settings. This is used in CustomAction. type ActionDefinition struct { // Stateless inspection criteria that publishes the specified metrics to Amazon // CloudWatch for the matching packet. This setting defines a CloudWatch dimension - // value to be published. You can pair this custom action with any of the standard - // stateless rule actions. For example, you could pair this in a rule action with - // the standard action that forwards the packet for stateful inspection. Then, when - // a packet matches the rule, Network Firewall publishes metrics for the packet and - // forwards it. + // value to be published. + // + // You can pair this custom action with any of the standard stateless rule + // actions. For example, you could pair this in a rule action with the standard + // action that forwards the packet for stateful inspection. Then, when a packet + // matches the rule, Network Firewall publishes metrics for the packet and forwards + // it. PublishMetricAction *PublishMetricAction noSmithyDocumentSerde } -// A single IP address specification. This is used in the MatchAttributes source -// and destination specifications. +// A single IP address specification. This is used in the MatchAttributes source and destination +// specifications. 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: + // 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) - // . + // + // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing]. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing // // This member is required. AddressDefinition *string @@ -52,12 +60,12 @@ type Address struct { } // The analysis result for Network Firewall's stateless rule group analyzer. Every -// time you call CreateRuleGroup , UpdateRuleGroup , or DescribeRuleGroup on a -// stateless rule group, Network Firewall analyzes the stateless rule groups in -// your account and identifies the rules that might adversely effect your -// firewall's functionality. For example, if Network Firewall detects a rule that's -// routing traffic asymmetrically, which impacts the service's ability to properly -// process traffic, the service includes the rule in a list of analysis results. +// time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the +// stateless rule groups in your account and identifies the rules that might +// adversely effect your firewall's functionality. For example, if Network Firewall +// detects a rule that's routing traffic asymmetrically, which impacts the +// service's ability to properly process traffic, the service includes the rule in +// a list of analysis results. type AnalysisResult struct { // Provides analysis details for the identified rule. @@ -69,19 +77,28 @@ type AnalysisResult struct { // The types of rule configurations that Network Firewall analyzes your rule // groups for. Network Firewall analyzes stateless rule groups for the following // types of rule configurations: - // - STATELESS_RULE_FORWARDING_ASYMMETRICALLY Cause: One or more stateless rules - // with the action pass or forward are forwarding traffic asymmetrically. - // Specifically, the rule's set of source IP addresses or their associated port - // numbers, don't match the set of destination IP addresses or their associated - // port numbers. To mitigate: Make sure that there's an existing return path. For - // example, if the rule allows traffic from source 10.1.0.0/24 to destination - // 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to - // destination 10.1.0.0/24. - // - STATELESS_RULE_CONTAINS_TCP_FLAGS Cause: At least one stateless rule with - // the action pass or forward contains TCP flags that are inconsistent in the - // forward and return directions. To mitigate: Prevent asymmetric routing issues - // caused by TCP flags by following these actions: + // + // - STATELESS_RULE_FORWARDING_ASYMMETRICALLY + // + // Cause: One or more stateless rules with the action pass or forward are + // forwarding traffic asymmetrically. Specifically, the rule's set of source IP + // addresses or their associated port numbers, don't match the set of destination + // IP addresses or their associated port numbers. + // + // To mitigate: Make sure that there's an existing return path. For example, if + // the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you + // should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24. + // + // - STATELESS_RULE_CONTAINS_TCP_FLAGS + // + // Cause: At least one stateless rule with the action pass or forward contains TCP + // flags that are inconsistent in the forward and return directions. + // + // To mitigate: Prevent asymmetric routing issues caused by TCP flags by following + // these actions: + // // - Remove unnecessary TCP flag inspections from the rules. + // // - If you need to inspect TCP flags, check that the rules correctly account // for changes in TCP flags throughout the TCP connection cycle, for example SYN // and ACK flags used in a 3-way TCP handshake. @@ -91,7 +108,7 @@ type AnalysisResult 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 @@ -112,9 +129,10 @@ type Attachment struct { // resolve it. A FAILED status indicates a non-recoverable state, and a ERROR // status indicates an issue that you can fix. Depending on the error, it can take // as many as 15 minutes to populate this field. For more information about the - // causes for failiure or 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) - // in the Network Firewall Developer Guide. + // causes for failiure or errors and solutions available for this field, see [Troubleshooting firewall endpoint failures]in + // the Network Firewall Developer Guide. + // + // [Troubleshooting firewall endpoint failures]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-troubleshooting-endpoint-failures.html StatusMessage *string // The unique identifier of the subnet that you've specified to be used for a @@ -124,8 +142,7 @@ type Attachment struct { noSmithyDocumentSerde } -// The capacity usage summary of the resources used by the ReferenceSets in a -// firewall. +// The capacity usage summary of the resources used by the ReferenceSets in a firewall. type CapacityUsageSummary struct { // Describes the capacity usage of the CIDR blocks used by the IP set references @@ -142,10 +159,13 @@ type CheckCertificateRevocationStatusActions struct { // Configures how Network Firewall processes traffic when it determines that the // certificate presented by the server in the SSL/TLS connection has a revoked // status. + // // - PASS - Allow the connection to continue, and pass subsequent packets to the // stateful engine for inspection. + // // - DROP - Network Firewall closes the connection and drops subsequent packets // for that connection. + // // - REJECT - Network Firewall sends a TCP reject packet back to your client. // The service closes the connection and drops subsequent packets for that // connection. REJECT is available only for TCP traffic. @@ -156,10 +176,13 @@ type CheckCertificateRevocationStatusActions struct { // status, or a status that cannot be determined for any other reason, including // when the service is unable to connect to the OCSP and CRL endpoints for the // certificate. + // // - PASS - Allow the connection to continue, and pass subsequent packets to the // stateful engine for inspection. + // // - DROP - Network Firewall closes the connection and drops subsequent packets // for that connection. + // // - REJECT - Network Firewall sends a TCP reject packet back to your client. // The service closes the connection and drops subsequent packets for that // connection. REJECT is available only for TCP traffic. @@ -187,19 +210,22 @@ type CIDRSummary struct { } // An optional, non-standard action to use for stateless packet handling. You can -// define this in addition to the standard action that you must specify. You define -// 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. +// define this in addition to the standard action that you must specify. +// +// You define 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 StatelessRulesAndCustomActionsspecification. 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 FirewallPolicyspecification, 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. @@ -217,13 +243,16 @@ type CustomAction struct { } // The value to use in an Amazon CloudWatch custom metric dimension. This is used -// 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) -// . +// in the PublishMetricsCustomAction . 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] in the [Amazon CloudWatch User Guide]. +// +// [Amazon CloudWatch User Guide]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html +// [Publishing Custom Metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions type Dimension struct { // The value to use in the custom metric dimension. @@ -239,9 +268,10 @@ type Dimension struct { // 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) -// in the Network Firewall Developer Guide. +// encryption of your Network Firewall resources, see [Encryption at rest with Amazon Web Services Key Managment Service]in the Network Firewall +// Developer Guide. +// +// [Encryption at rest with Amazon Web Services Key Managment Service]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html type EncryptionConfiguration struct { // The type of Amazon Web Services KMS key to use for encryption of your Network @@ -253,8 +283,10 @@ 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]in the + // Amazon Web Services KMS Developer Guide. + // + // [Key ID]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id KeyId *string noSmithyDocumentSerde @@ -263,9 +295,11 @@ type EncryptionConfiguration struct { // The firewall defines the configuration settings for an Network Firewall // firewall. These settings include the firewall policy, the subnets in your VPC to // 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 . +// 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. type Firewall struct { // The unique identifier for the firewall. @@ -273,10 +307,11 @@ type Firewall struct { // This member is required. FirewallId *string - // The Amazon Resource Name (ARN) of the firewall policy. The relationship of - // firewall to firewall policy is many to one. Each firewall requires one firewall - // policy association, and you can use the same firewall policy for multiple - // firewalls. + // The Amazon Resource Name (ARN) of the firewall policy. + // + // The relationship of firewall to firewall policy is many to one. Each firewall + // requires one firewall policy association, and you can use the same firewall + // policy for multiple firewalls. // // This member is required. FirewallPolicyArn *string @@ -347,19 +382,23 @@ 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 -// the policy. You can retrieve all objects for a firewall policy by calling -// DescribeFirewallPolicy . +// policy for multiple firewalls. +// +// This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a +// firewall policy by calling 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. + // 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 . + // descriptions under CustomAction. // // This member is required. StatelessDefaultActions []string @@ -368,12 +407,15 @@ 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", + // 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 . + // descriptions under CustomAction. // // This member is required. StatelessFragmentDefaultActions []string @@ -384,13 +426,21 @@ 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: + // 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) - // in the Network Firewall Developer Guide. + // + // For more information, see [Strict evaluation order] in the Network Firewall Developer Guide. + // + // [Strict evaluation order]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html StatefulDefaultActions []string // Additional options governing how Network Firewall handles stateful rules. The @@ -420,7 +470,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. @@ -433,14 +483,14 @@ type FirewallPolicyMetadata struct { noSmithyDocumentSerde } -// 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 . +// 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. 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 @@ -470,8 +520,7 @@ type FirewallPolicyResponse struct { EncryptionConfiguration *EncryptionConfiguration // The current status of the firewall policy. You can retrieve this for a firewall - // policy by calling DescribeFirewallPolicy and providing the firewall policy's - // name or ARN. + // policy by calling DescribeFirewallPolicyand providing the firewall policy's name or ARN. FirewallPolicyStatus ResourceStatus // The last time that the firewall policy was changed. @@ -486,20 +535,22 @@ type FirewallPolicyResponse struct { noSmithyDocumentSerde } -// 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. +// Detailed information about the current status of a Firewall. You can retrieve this for +// a firewall by calling DescribeFirewalland 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. + // 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 @@ -530,27 +581,36 @@ type FirewallStatus struct { // 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 . +// 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 - // addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall - // supports all address ranges for IPv4 and IPv6. Examples: + // 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) - // . + // + // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing]. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing // // This member is required. Destination *string @@ -577,23 +637,32 @@ type Header struct { 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 - // addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall - // supports all address ranges for IPv4 and IPv6. Examples: + // 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) - // . + // + // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing]. + // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing // // This member is required. Source *string @@ -608,8 +677,8 @@ type Header struct { noSmithyDocumentSerde } -// A list of IP addresses and address ranges, in CIDR notation. This is part of a -// RuleVariables . +// A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables +// . type IPSet struct { // The list of IP addresses and address ranges, in CIDR notation. @@ -632,18 +701,20 @@ type IPSetMetadata struct { } // 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 -// 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) -// 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) -// in IP set references. +// This is used in CreateRuleGroupor 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]in the Network Firewall +// Developer Guide. +// +// Network Firewall currently supports [Amazon VPC prefix lists] and [resource groups] in IP set references. +// +// [Using IP set references]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references +// [Amazon VPC prefix lists]: https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html +// [resource groups]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html#rule-groups-referencing-resource-groups type IPSetReference struct { // The Amazon Resource Name (ARN) of the resource that you are referencing in your @@ -654,27 +725,35 @@ 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 +// 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" } + // + // "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" } + // 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" } + // delivery stream named alert-delivery-stream : + // + // "LogDestination": { "deliveryStream": "alert-delivery-stream" } // // This member is required. LogDestination map[string]string @@ -686,9 +765,9 @@ type LogDestinationConfig struct { // This member is required. LogDestinationType LogDestinationType - // The type of log to send. Alert logs report traffic that matches a StatefulRule - // with an action setting that sends an alert log message. Flow logs are standard - // network traffic flow logs. + // The type of log to send. Alert logs report traffic that matches a StatefulRule with an + // action setting that sends an alert log message. Flow logs are standard network + // traffic flow logs. // // This member is required. LogType LogType @@ -696,7 +775,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 @@ -715,6 +794,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 . DestinationPorts []PortRange @@ -728,9 +808,10 @@ type MatchAttributes struct { Protocols []int32 // 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 . + // 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 . SourcePorts []PortRange // The source IP addresses and address ranges to inspect for, in CIDR notation. If @@ -748,8 +829,8 @@ type MatchAttributes struct { // 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. +// endpoint, so it can properly filter network traffic. This is part of a SyncStatefor a +// firewall. type PerObjectStatus struct { // Indicates whether this object is in sync with the version indicated in the @@ -778,8 +859,7 @@ type PolicyVariables 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 @@ -836,22 +916,29 @@ 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 - // aws:forward_to_sfe for the StatelessDefaultActions setting for the - // FirewallPolicy . For every rule, you must specify exactly one of the following - // standard actions. + // 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 aws:forward_to_sfe for the + // StatelessDefaultActions setting for the 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 + // 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”] . @@ -869,15 +956,17 @@ type RuleDefinition struct { noSmithyDocumentSerde } -// 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 -// 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 -// in an Network Firewall firewall policy, then you use the policy in a firewall. -// You can reference a rule group from more than one firewall policy, and you can -// use a firewall policy in more than one firewall. +// 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 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 in an Network Firewall +// firewall policy, then you use the policy in a firewall. You can reference a rule +// group from more than one firewall policy, and you can use a firewall policy in +// more than one firewall. type RuleGroup struct { // The stateful rules or stateless rules for the rule group. @@ -895,16 +984,16 @@ type RuleGroup struct { // Additional options governing how Network Firewall handles stateful rules. The // policies where you use your stateful rule group must have stateful rule options // settings that are compatible with these settings. Some limitations apply; for - // more information, see Strict evaluation order (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-limitations-caveats.html) - // in the Network Firewall Developer Guide. + // more information, see [Strict evaluation order]in the Network Firewall Developer Guide. + // + // [Strict evaluation order]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-limitations-caveats.html StatefulRuleOptions *StatefulRuleOptions noSmithyDocumentSerde } -// 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. +// 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 { // The Amazon Resource Name (ARN) of the rule group. @@ -917,14 +1006,14 @@ type RuleGroupMetadata struct { noSmithyDocumentSerde } -// 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 . +// 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. 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 - // isn't attached to a valid resource. + // 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 isn't attached to a valid resource. // // This member is required. RuleGroupArn *string @@ -941,20 +1030,20 @@ type RuleGroupResponse struct { RuleGroupName *string // The list of analysis results for AnalyzeRuleGroup . If you set AnalyzeRuleGroup - // to TRUE in CreateRuleGroup , UpdateRuleGroup , or DescribeRuleGroup , Network - // Firewall analyzes the rule group and identifies the rules that might adversely - // effect your firewall's functionality. For example, if Network Firewall detects a - // rule that's routing traffic asymmetrically, which impacts the service's ability - // to properly process traffic, the service includes the rule in the list of - // analysis results. + // to TRUE in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the + // rules that might adversely effect your firewall's functionality. For example, if + // Network Firewall detects a rule that's routing traffic asymmetrically, which + // impacts the service's ability to properly process traffic, the service includes + // the rule in the list of analysis results. AnalysisResults []AnalysisResult // The maximum operating resources that this rule group can use. Rule group // capacity is fixed at creation. When you update a rule group, you are limited to // 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 . + // 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 CreateRuleGroupwith DryRun set to TRUE . Capacity *int32 // The number of capacity units currently consumed by the rule group rules. @@ -980,8 +1069,9 @@ 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.]. + // + // [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 @@ -1000,23 +1090,24 @@ type RuleGroupResponse struct { noSmithyDocumentSerde } -// Additional settings for a stateful rule. This is part of the StatefulRule -// configuration. +// Additional settings for a stateful rule. This is part of the StatefulRule configuration. type RuleOption struct { // The keyword for the Suricata compatible rule option. You must include a sid // (signature ID), and can optionally include other keywords. For information about - // Suricata compatible keywords, see Rule options (https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) - // in the Suricata documentation. + // Suricata compatible keywords, see [Rule options]in the Suricata documentation. + // + // [Rule options]: https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options // // This member is required. Keyword *string // The settings of the Suricata compatible rule option. Rule options have zero or // more setting values, and the number of possible and required settings depends on - // the Keyword . For more information about the settings for specific options, see - // Rule options (https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) + // the Keyword . For more information about the settings for specific options, see [Rule options] // . + // + // [Rule options]: https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options Settings []string noSmithyDocumentSerde @@ -1032,18 +1123,22 @@ type RulesSource struct { // Stateful inspection criteria, provided in Suricata compatible rules. Suricata // is an open-source threat detection framework that includes a standard rule-based - // language for network traffic inspection. These rules contain the inspection - // criteria and the action to take for traffic that matches the criteria, so this - // type of rule group doesn't have a separate action setting. You can't use the - // priority keyword if the RuleOrder option in StatefulRuleOptions is set to + // language for network traffic inspection. + // + // These rules contain the inspection criteria and the action to take for traffic + // that matches the criteria, so this type of rule group doesn't have a separate + // action setting. + // + // You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to // STRICT_ORDER . 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 // protocol, source and destination, ports, direction, and rule options. For - // information about the Suricata Rules format, see Rules Format (https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html) - // . + // information about the Suricata Rules format, see [Rules Format]. + // + // [Rules Format]: https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html StatefulRules []StatefulRule // Stateless inspection criteria to be used in a stateless rule group. @@ -1052,15 +1147,19 @@ type RulesSource struct { noSmithyDocumentSerde } -// Stateful inspection criteria for a domain list rule group. For HTTPS traffic, -// domain filtering is SNI-based. It uses the server name indicator extension of -// the TLS handshake. By default, Network Firewall domain list inspection only -// includes traffic coming from the VPC where you deploy the firewall. To inspect -// 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) -// in the Network Firewall Developer Guide. +// Stateful inspection criteria for a domain list rule group. +// +// For HTTPS traffic, domain filtering is SNI-based. It uses the server name +// indicator extension of the TLS handshake. +// +// By default, Network Firewall domain list inspection only includes traffic +// coming from the VPC where you deploy the firewall. To inspect 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 RuleVariablesin this guide and [Stateful domain list rule groups in Network Firewall] in the Network Firewall Developer +// Guide. +// +// [Stateful domain list rule groups in Network Firewall]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html type RulesSourceList struct { // Whether you want to allow or deny access to the domains in your target list. @@ -1076,8 +1175,10 @@ type RulesSourceList struct { // 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 . @@ -1088,8 +1189,7 @@ type RulesSourceList struct { noSmithyDocumentSerde } -// Settings that are available for use in the rules in the RuleGroup where this is -// defined. +// Settings that are available for use in the rules in the RuleGroup where this is defined. type RuleVariables struct { // A list of IP addresses and address ranges, in CIDR notation. @@ -1102,15 +1202,16 @@ type RuleVariables struct { } // Any Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security -// (SSL/TLS) server certificate that's associated with a -// ServerCertificateConfiguration . Used in a TLSInspectionConfiguration for +// (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration. Used in a TLSInspectionConfiguration for // inspection of inbound traffic to your firewall. 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]or [Importing certificates] in the Certificate Manager +// User Guide. +// +// [Request a public certificate]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html +// [Importing certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html type ServerCertificate struct { // The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server @@ -1121,36 +1222,43 @@ type ServerCertificate struct { } // Configures the Certificate Manager certificates and scope that Network Firewall -// uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration . You -// can configure ServerCertificates for inbound SSL/TLS inspection, a -// CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For -// information about working with certificates for TLS inspection, see 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. +// uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration. You can configure +// ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn +// for outbound SSL/TLS inspection, or both. For information about working with +// certificates for TLS inspection, see [Using SSL/TLS server certficiates with TLS inspection configurations]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. +// +// [Using SSL/TLS server certficiates with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html type ServerCertificateConfiguration struct { // The Amazon Resource Name (ARN) of the imported certificate authority (CA) // certificate within Certificate Manager (ACM) to use for outbound SSL/TLS - // inspection. The following limitations apply: + // inspection. + // + // The following limitations apply: + // // - You can use CA certificates that you imported into ACM, but you can't // generate CA certificates with ACM. + // // - You can't use certificates issued by Private Certificate Authority. + // // For more information about configuring certificates for outbound inspection, - // see Using SSL/TLS certificates with certificates with TLS inspection - // configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) - // in the Network Firewall Developer Guide. For information about working with - // certificates in ACM, see Importing certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) - // in the Certificate Manager User Guide. + // see [Using SSL/TLS certificates with certificates with TLS inspection configurations]in the Network Firewall Developer Guide. + // + // For information about working with certificates in ACM, see [Importing certificates] in the Certificate + // Manager User Guide. + // + // [Importing certificates]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html + // [Using SSL/TLS certificates with certificates with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html CertificateAuthorityArn *string // When enabled, Network Firewall checks if the server certificate presented by // the server in the SSL/TLS connection has a revoked or unkown status. If the // certificate has an unknown or revoked status, you must specify the actions that // Network Firewall takes on outbound traffic. To check the certificate revocation - // status, you must also specify a CertificateAuthorityArn in - // ServerCertificateConfiguration . + // status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration. CheckCertificateRevocationStatus *CheckCertificateRevocationStatusActions // A list of scopes. @@ -1169,6 +1277,7 @@ 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 . DestinationPorts []PortRange @@ -1183,9 +1292,10 @@ type ServerCertificateScope struct { Protocols []int32 // 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 . + // (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 . SourcePorts []PortRange // The source IP addresses and address ranges to decrypt for inspection, in CIDR @@ -1198,8 +1308,9 @@ 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]. +// +// [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 @@ -1208,8 +1319,9 @@ 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]. + // + // [DescribeRuleGroup]: https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken SourceUpdateToken *string noSmithyDocumentSerde @@ -1227,15 +1339,18 @@ type StatefulEngineOptions struct { // your rules. The default action for this rule order is PASS , followed by DROP , // REJECT , and ALERT actions. Stateful rules are provided to the rule engine as // Suricata compatible strings, and Suricata evaluates them based on your 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. + // For more information, see [Evaluation order for stateful rules]in the Network Firewall Developer Guide. + // + // [Evaluation order for stateful rules]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html 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 @@ -1244,6 +1359,7 @@ type StatefulEngineOptions struct { // 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. + // // - REJECT - Network Firewall fails closed and drops all subsequent traffic // going to the firewall. Network Firewall also sends a TCP reject packet back to // your client so that the client can immediately establish a new session. Network @@ -1257,23 +1373,28 @@ 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.io/en/suricata-6.0.9/rules/intro.html) -// . +// Suricata Rules format, see [Rules Format]. +// +// [Rules Format]: https://suricata.readthedocs.io/en/suricata-6.0.9/rules/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: + // 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 Firewall - // LoggingConfiguration . - // - ALERT - 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 . + // an alert log message, if alert logging is configured in the FirewallLoggingConfiguration. + // + // - ALERT - 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 . // // This member is required. Action StatefulAction @@ -1316,14 +1437,16 @@ 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 @@ -1336,24 +1459,29 @@ 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) - // in the Network Firewall Developer Guide. + // certain settings. For more information, see [Evaluation order for stateful rules]in the Network Firewall Developer + // Guide. + // + // [Evaluation order for stateful rules]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html 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 // are defined for a stateless rule group. Network Firewall evaluates the rules in // a rule group starting with the lowest priority setting. You must ensure that the - // priority settings are unique for the rule group. Each stateless rule group uses - // 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. + // priority settings are unique for the rule group. + // + // Each stateless rule group uses 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. @@ -1375,9 +1503,9 @@ type StatelessRule struct { 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 - // 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. + // 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. // // This member is required. Priority *int32 @@ -1402,16 +1530,16 @@ type StatelessRulesAndCustomActions struct { // 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 StatelessRule RuleDefinition Actions specification. + // it by name in your StatelessRuleRuleDefinitionActions 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 -// of the associated firewall in each subnet that you specify, to filter traffic in -// the subnet's Availability Zone. +// with CreateFirewalland 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 { // The unique identifier for the subnet. @@ -1427,9 +1555,13 @@ 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: +// 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. // @@ -1441,14 +1573,14 @@ 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 @@ -1478,16 +1610,18 @@ type Tag struct { noSmithyDocumentSerde } -// TCP flags and masks to inspect packets for, used in stateless rules -// MatchAttributes settings. +// TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings. type TCPFlagField struct { // Used in conjunction with the Masks setting to define the flags that must be set // and flags that must not be set in order for the packet to match. This setting - // 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: + // 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. // @@ -1520,20 +1654,22 @@ type TlsCertificateData struct { noSmithyDocumentSerde } -// 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 -// 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 new Network Firewall firewall policy, then you apply the firewall -// policy to a firewall. Network Firewall acts as a proxy service to decrypt and -// inspect the traffic traveling through your firewalls. 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 Inspecting 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. +// 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 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 new Network Firewall +// firewall policy, then you apply the firewall policy to a firewall. Network +// Firewall acts as a proxy service to decrypt and inspect the traffic traveling +// through your firewalls. 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 [Inspecting SSL/TLS traffic with TLS inspection configurations]in the Network Firewall Developer Guide. +// +// [Inspecting SSL/TLS traffic with TLS inspection configurations]: https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html type TLSInspectionConfiguration struct { // Lists the server certificate configurations that are associated with the TLS @@ -1601,9 +1737,8 @@ 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 . - // You can retrieve this for a TLS inspection configuration by calling - // DescribeTLSInspectionConfiguration and providing the TLS inspection + // Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for + // a TLS inspection configuration by calling DescribeTLSInspectionConfigurationand providing the TLS inspection // configuration name and ARN. TLSInspectionConfigurationStatus ResourceStatus diff --git a/service/networkmanager/api_op_AcceptAttachment.go b/service/networkmanager/api_op_AcceptAttachment.go index dfec6295bef..779bfc2beb4 100644 --- a/service/networkmanager/api_op_AcceptAttachment.go +++ b/service/networkmanager/api_op_AcceptAttachment.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Accepts a core network attachment request. Once the attachment request is -// accepted by a core network owner, the attachment is created and connected to a -// core network. +// Accepts a core network attachment request. +// +// Once the attachment request is accepted by a core network owner, the attachment +// is created and connected to a core network. func (c *Client) AcceptAttachment(ctx context.Context, params *AcceptAttachmentInput, optFns ...func(*Options)) (*AcceptAttachmentOutput, error) { if params == nil { params = &AcceptAttachmentInput{} diff --git a/service/networkmanager/api_op_AssociateConnectPeer.go b/service/networkmanager/api_op_AssociateConnectPeer.go index 4cb76990b82..a24cb6cd135 100644 --- a/service/networkmanager/api_op_AssociateConnectPeer.go +++ b/service/networkmanager/api_op_AssociateConnectPeer.go @@ -12,9 +12,11 @@ import ( ) // Associates a core network Connect peer with a device and optionally, with a -// link. If you specify a link, it must be associated with the specified device. -// You can only associate core network Connect peers that have been created on a -// core network Connect attachment on a core network. +// link. +// +// If you specify a link, it must be associated with the specified device. You can +// only associate core network Connect peers that have been created on a core +// network Connect attachment on a core network. func (c *Client) AssociateConnectPeer(ctx context.Context, params *AssociateConnectPeerInput, optFns ...func(*Options)) (*AssociateConnectPeerOutput, error) { if params == nil { params = &AssociateConnectPeerInput{} diff --git a/service/networkmanager/api_op_AssociateCustomerGateway.go b/service/networkmanager/api_op_AssociateCustomerGateway.go index a89e393b5cd..a22743be0f5 100644 --- a/service/networkmanager/api_op_AssociateCustomerGateway.go +++ b/service/networkmanager/api_op_AssociateCustomerGateway.go @@ -12,15 +12,18 @@ import ( ) // Associates a customer gateway with a device and optionally, with a link. If you -// specify a link, it must be associated with the specified device. You can only -// associate customer gateways that are connected to a VPN attachment on a transit -// gateway or core network registered in your global network. When you register a -// 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 -// gateway with more than one device and link. +// specify a link, it must be associated with the specified device. +// +// You can only associate customer gateways that are connected to a VPN attachment +// on a transit gateway or core network registered in your global network. When you +// register a 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]EC2 API and +// filter by transit-gateway-id . +// +// You cannot associate a customer gateway with more than one device and link. +// +// [DescribeVpnConnections]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html func (c *Client) AssociateCustomerGateway(ctx context.Context, params *AssociateCustomerGatewayInput, optFns ...func(*Options)) (*AssociateCustomerGatewayOutput, error) { if params == nil { params = &AssociateCustomerGatewayInput{} diff --git a/service/networkmanager/api_op_AssociateTransitGatewayConnectPeer.go b/service/networkmanager/api_op_AssociateTransitGatewayConnectPeer.go index 4396f1ac5d0..043139063e0 100644 --- a/service/networkmanager/api_op_AssociateTransitGatewayConnectPeer.go +++ b/service/networkmanager/api_op_AssociateTransitGatewayConnectPeer.go @@ -13,9 +13,12 @@ import ( // Associates a transit gateway Connect peer with a device, and optionally, with a // link. If you specify a link, it must be associated with the specified device. -// You can only associate transit gateway Connect peers that have been created on a -// transit gateway that's registered in your global network. You cannot associate a -// transit gateway Connect peer with more than one device and link. +// +// You can only associate transit gateway Connect peers that have been created on +// a transit gateway that's registered in your global network. +// +// You cannot associate a transit gateway Connect peer with more than one device +// and link. func (c *Client) AssociateTransitGatewayConnectPeer(ctx context.Context, params *AssociateTransitGatewayConnectPeerInput, optFns ...func(*Options)) (*AssociateTransitGatewayConnectPeerOutput, error) { if params == nil { params = &AssociateTransitGatewayConnectPeerInput{} diff --git a/service/networkmanager/api_op_CreateConnectAttachment.go b/service/networkmanager/api_op_CreateConnectAttachment.go index c8f5599a955..7f567aa44b1 100644 --- a/service/networkmanager/api_op_CreateConnectAttachment.go +++ b/service/networkmanager/api_op_CreateConnectAttachment.go @@ -12,10 +12,12 @@ import ( ) // Creates a core network Connect attachment from a specified core network -// attachment. A core network Connect attachment is a GRE-based tunnel attachment -// that you can use to establish a connection between a core network and an -// appliance. A core network Connect attachment uses an existing VPC attachment as -// the underlying transport mechanism. +// attachment. +// +// A core network Connect attachment is a GRE-based tunnel attachment that you can +// use to establish a connection between a core network and an appliance. A core +// network Connect attachment uses an existing VPC attachment as the underlying +// transport mechanism. func (c *Client) CreateConnectAttachment(ctx context.Context, params *CreateConnectAttachmentInput, optFns ...func(*Options)) (*CreateConnectAttachmentOutput, error) { if params == nil { params = &CreateConnectAttachmentInput{} diff --git a/service/networkmanager/api_op_CreateConnection.go b/service/networkmanager/api_op_CreateConnection.go index a2b58e1c786..86fcef055fb 100644 --- a/service/networkmanager/api_op_CreateConnection.go +++ b/service/networkmanager/api_op_CreateConnection.go @@ -50,8 +50,9 @@ type CreateConnectionInput struct { // The ID of the link for the second device. ConnectedLinkId *string - // A description of the connection. Length Constraints: Maximum length of 256 - // characters. + // A description of the connection. + // + // Length Constraints: Maximum length of 256 characters. Description *string // The ID of the link for the first device. diff --git a/service/networkmanager/api_op_CreateDevice.go b/service/networkmanager/api_op_CreateDevice.go index d9c12348d16..10655cfe66f 100644 --- a/service/networkmanager/api_op_CreateDevice.go +++ b/service/networkmanager/api_op_CreateDevice.go @@ -40,16 +40,22 @@ type CreateDeviceInput struct { // on-premises device, you can omit this parameter. AWSLocation *types.AWSLocation - // A description of the device. Constraints: Maximum length of 256 characters. + // A description of the device. + // + // Constraints: Maximum length of 256 characters. Description *string // The location of the device. Location *types.Location - // The model of the device. Constraints: Maximum length of 128 characters. + // The model of the device. + // + // Constraints: Maximum length of 128 characters. Model *string - // The serial number of the device. Constraints: Maximum length of 128 characters. + // The serial number of the device. + // + // Constraints: Maximum length of 128 characters. SerialNumber *string // The ID of the site. @@ -61,7 +67,9 @@ type CreateDeviceInput struct { // The type of the device. Type *string - // The vendor of the device. Constraints: Maximum length of 128 characters. + // The vendor of the device. + // + // Constraints: Maximum length of 128 characters. Vendor *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_CreateGlobalNetwork.go b/service/networkmanager/api_op_CreateGlobalNetwork.go index e6b2226090a..3010ea4adfa 100644 --- a/service/networkmanager/api_op_CreateGlobalNetwork.go +++ b/service/networkmanager/api_op_CreateGlobalNetwork.go @@ -29,8 +29,9 @@ func (c *Client) CreateGlobalNetwork(ctx context.Context, params *CreateGlobalNe type CreateGlobalNetworkInput struct { - // A description of the global network. Constraints: Maximum length of 256 - // characters. + // A description of the global network. + // + // Constraints: Maximum length of 256 characters. Description *string // The tags to apply to the resource during creation. diff --git a/service/networkmanager/api_op_CreateLink.go b/service/networkmanager/api_op_CreateLink.go index 65eceb5e5e1..7b80701028c 100644 --- a/service/networkmanager/api_op_CreateLink.go +++ b/service/networkmanager/api_op_CreateLink.go @@ -29,7 +29,7 @@ func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns type CreateLinkInput struct { - // The upload speed and download speed in Mbps. + // The upload speed and download speed in Mbps. // // This member is required. Bandwidth *types.Bandwidth @@ -44,18 +44,24 @@ type CreateLinkInput struct { // This member is required. SiteId *string - // A description of the link. Constraints: Maximum length of 256 characters. + // A description of the link. + // + // Constraints: Maximum length of 256 characters. Description *string - // The provider of the link. Constraints: Maximum length of 128 characters. Cannot - // include the following characters: | \ ^ + // The provider of the link. + // + // Constraints: Maximum length of 128 characters. Cannot include the following + // characters: | \ ^ Provider *string // The tags to apply to the resource during creation. Tags []types.Tag - // The type of the link. Constraints: Maximum length of 128 characters. Cannot - // include the following characters: | \ ^ + // The type of the link. + // + // Constraints: Maximum length of 128 characters. Cannot include the following + // characters: | \ ^ Type *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_CreateSite.go b/service/networkmanager/api_op_CreateSite.go index b27f33b939e..cce4b62c811 100644 --- a/service/networkmanager/api_op_CreateSite.go +++ b/service/networkmanager/api_op_CreateSite.go @@ -34,14 +34,19 @@ type CreateSiteInput struct { // This member is required. GlobalNetworkId *string - // A description of your site. Constraints: Maximum length of 256 characters. + // A description of your site. + // + // Constraints: Maximum length of 256 characters. Description *string // 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. Location *types.Location diff --git a/service/networkmanager/api_op_DescribeGlobalNetworks.go b/service/networkmanager/api_op_DescribeGlobalNetworks.go index bea03f2d3d0..3493cc1f328 100644 --- a/service/networkmanager/api_op_DescribeGlobalNetworks.go +++ b/service/networkmanager/api_op_DescribeGlobalNetworks.go @@ -14,7 +14,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_GetLinks.go b/service/networkmanager/api_op_GetLinks.go index f2e266368e6..ac8920c862c 100644 --- a/service/networkmanager/api_op_GetLinks.go +++ b/service/networkmanager/api_op_GetLinks.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about one or more links in a specified global network. If you -// specify the site ID, you cannot specify the type or provider in the same +// Gets information about one or more links in a specified global network. +// +// If you specify the site ID, you cannot specify the type or provider in the same // request. You can specify the type and provider in the same request. func (c *Client) GetLinks(ctx context.Context, params *GetLinksInput, optFns ...func(*Options)) (*GetLinksOutput, error) { if params == nil { diff --git a/service/networkmanager/api_op_GetNetworkResourceCounts.go b/service/networkmanager/api_op_GetNetworkResourceCounts.go index a11d5172129..49b86d62510 100644 --- a/service/networkmanager/api_op_GetNetworkResourceCounts.go +++ b/service/networkmanager/api_op_GetNetworkResourceCounts.go @@ -41,22 +41,38 @@ type GetNetworkResourceCountsInput struct { // The token for the next page of results. NextToken *string - // The resource type. The following are the supported resource types for Direct - // Connect: + // 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 ResourceType *string diff --git a/service/networkmanager/api_op_GetNetworkResourceRelationships.go b/service/networkmanager/api_op_GetNetworkResourceRelationships.go index 850342cfe7f..9e3a175e448 100644 --- a/service/networkmanager/api_op_GetNetworkResourceRelationships.go +++ b/service/networkmanager/api_op_GetNetworkResourceRelationships.go @@ -55,22 +55,38 @@ type GetNetworkResourceRelationshipsInput struct { // The ARN of the gateway. ResourceArn *string - // The resource type. The following are the supported resource types for Direct - // Connect: + // 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 ResourceType *string diff --git a/service/networkmanager/api_op_GetNetworkResources.go b/service/networkmanager/api_op_GetNetworkResources.go index a4fd25713e2..7afeaf56ca2 100644 --- a/service/networkmanager/api_op_GetNetworkResources.go +++ b/service/networkmanager/api_op_GetNetworkResources.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the network resources for the specified global network. The results -// include information from the corresponding Describe call for the resource, minus -// any sensitive information such as pre-shared keys. +// Describes the network resources for the specified global network. +// +// The results include information from the corresponding Describe call for the +// resource, minus any sensitive information such as pre-shared keys. func (c *Client) GetNetworkResources(ctx context.Context, params *GetNetworkResourcesInput, optFns ...func(*Options)) (*GetNetworkResourcesOutput, error) { if params == nil { params = &GetNetworkResourcesInput{} @@ -57,39 +58,52 @@ type GetNetworkResourcesInput struct { // The ARN of the resource. ResourceArn *string - // 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 resource type. + // + // The following are the supported resource types for Direct Connect: + // + // - dxcon - The definition model is [Connection]. + // + // - dx-gateway - The definition model is [DirectConnectGateway]. + // + // - dx-vif - The definition model is [VirtualInterface]. + // // 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) - // . + // + // - connection - The definition model is [Connection]. + // + // - device - The definition model is [Device]. + // + // - link - The definition model is [Link]. + // + // - site - The definition model is [Site]. + // // 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) - // . + // + // - customer-gateway - The definition model is [CustomerGateway]. + // + // - transit-gateway - The definition model is [TransitGateway]. + // + // - transit-gateway-attachment - The definition model is [TransitGatewayAttachment]. + // + // - transit-gateway-connect-peer - The definition model is [TransitGatewayConnectPeer]. + // + // - transit-gateway-route-table - The definition model is [TransitGatewayRouteTable]. + // + // - vpn-connection - The definition model is [VpnConnection]. + // + // [Site]: https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Site.html + // [TransitGatewayAttachment]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayAttachment.html + // [DirectConnectGateway]: https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGateway.html + // [VirtualInterface]: https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualInterface.html + // [TransitGatewayRouteTable]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayRouteTable.html + // [VpnConnection]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpnConnection.html + // [Device]: https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Device.html + // [Connection]: https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Connection.html + // [TransitGatewayConnectPeer]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayConnectPeer.html + // [CustomerGateway]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CustomerGateway.html + // [Link]: https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Link.html + // [TransitGateway]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGateway.html ResourceType *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_GetNetworkTelemetry.go b/service/networkmanager/api_op_GetNetworkTelemetry.go index 008144d78c7..84473cbedc5 100644 --- a/service/networkmanager/api_op_GetNetworkTelemetry.go +++ b/service/networkmanager/api_op_GetNetworkTelemetry.go @@ -55,22 +55,38 @@ type GetNetworkTelemetryInput struct { // The ARN of the resource. ResourceArn *string - // The resource type. The following are the supported resource types for Direct - // Connect: + // 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 ResourceType *string diff --git a/service/networkmanager/api_op_RegisterTransitGateway.go b/service/networkmanager/api_op_RegisterTransitGateway.go index 2dd1f4684a4..5699134ad07 100644 --- a/service/networkmanager/api_op_RegisterTransitGateway.go +++ b/service/networkmanager/api_op_RegisterTransitGateway.go @@ -12,12 +12,13 @@ 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) +// transit gateways for global networks. For a list of the supported Regions, see [Region Availability] // 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 // network. You cannot register a transit gateway in more than one global network. +// +// [Region Availability]: https://docs.aws.amazon.com/network-manager/latest/tgwnm/what-are-global-networks.html#nm-available-regions func (c *Client) RegisterTransitGateway(ctx context.Context, params *RegisterTransitGatewayInput, optFns ...func(*Options)) (*RegisterTransitGatewayOutput, error) { if params == nil { params = &RegisterTransitGatewayInput{} diff --git a/service/networkmanager/api_op_StartRouteAnalysis.go b/service/networkmanager/api_op_StartRouteAnalysis.go index 6591de7e77d..e8159d9ffa4 100644 --- a/service/networkmanager/api_op_StartRouteAnalysis.go +++ b/service/networkmanager/api_op_StartRouteAnalysis.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/networkmanager/api_op_UpdateConnection.go b/service/networkmanager/api_op_UpdateConnection.go index f108e945289..184e149765c 100644 --- a/service/networkmanager/api_op_UpdateConnection.go +++ b/service/networkmanager/api_op_UpdateConnection.go @@ -43,8 +43,9 @@ type UpdateConnectionInput struct { // The ID of the link for the second device in the connection. ConnectedLinkId *string - // A description of the connection. Length Constraints: Maximum length of 256 - // characters. + // A description of the connection. + // + // Length Constraints: Maximum length of 256 characters. Description *string // The ID of the link for the first device in the connection. diff --git a/service/networkmanager/api_op_UpdateDevice.go b/service/networkmanager/api_op_UpdateDevice.go index f05c0a65e2b..88d036c2a91 100644 --- a/service/networkmanager/api_op_UpdateDevice.go +++ b/service/networkmanager/api_op_UpdateDevice.go @@ -44,16 +44,22 @@ type UpdateDeviceInput struct { // on-premises device, you can omit this parameter. AWSLocation *types.AWSLocation - // A description of the device. Constraints: Maximum length of 256 characters. + // A description of the device. + // + // Constraints: Maximum length of 256 characters. Description *string // Describes a location. Location *types.Location - // The model of the device. Constraints: Maximum length of 128 characters. + // The model of the device. + // + // Constraints: Maximum length of 128 characters. Model *string - // The serial number of the device. Constraints: Maximum length of 128 characters. + // The serial number of the device. + // + // Constraints: Maximum length of 128 characters. SerialNumber *string // The ID of the site. @@ -62,7 +68,9 @@ type UpdateDeviceInput struct { // The type of the device. Type *string - // The vendor of the device. Constraints: Maximum length of 128 characters. + // The vendor of the device. + // + // Constraints: Maximum length of 128 characters. Vendor *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_UpdateGlobalNetwork.go b/service/networkmanager/api_op_UpdateGlobalNetwork.go index 87e15b13c7e..beef32716c8 100644 --- a/service/networkmanager/api_op_UpdateGlobalNetwork.go +++ b/service/networkmanager/api_op_UpdateGlobalNetwork.go @@ -35,8 +35,9 @@ type UpdateGlobalNetworkInput struct { // This member is required. GlobalNetworkId *string - // A description of the global network. Constraints: Maximum length of 256 - // characters. + // A description of the global network. + // + // Constraints: Maximum length of 256 characters. Description *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_UpdateLink.go b/service/networkmanager/api_op_UpdateLink.go index 880ad97a2f9..4872223e798 100644 --- a/service/networkmanager/api_op_UpdateLink.go +++ b/service/networkmanager/api_op_UpdateLink.go @@ -43,13 +43,19 @@ type UpdateLinkInput struct { // The upload and download speed in Mbps. Bandwidth *types.Bandwidth - // A description of the link. Constraints: Maximum length of 256 characters. + // A description of the link. + // + // Constraints: Maximum length of 256 characters. Description *string - // The provider of the link. Constraints: Maximum length of 128 characters. + // The provider of the link. + // + // Constraints: Maximum length of 128 characters. Provider *string - // The type of the link. Constraints: Maximum length of 128 characters. + // The type of the link. + // + // Constraints: Maximum length of 128 characters. Type *string noSmithyDocumentSerde diff --git a/service/networkmanager/api_op_UpdateSite.go b/service/networkmanager/api_op_UpdateSite.go index a6425c5f593..368c6a2af18 100644 --- a/service/networkmanager/api_op_UpdateSite.go +++ b/service/networkmanager/api_op_UpdateSite.go @@ -40,12 +40,17 @@ type UpdateSiteInput struct { // This member is required. SiteId *string - // A description of your site. Constraints: Maximum length of 256 characters. + // A description of your site. + // + // Constraints: Maximum length of 256 characters. Description *string // The site location: + // // - Address : The physical address of the site. + // // - Latitude : The latitude of the site. + // // - Longitude : The longitude of the site. Location *types.Location diff --git a/service/networkmanager/options.go b/service/networkmanager/options.go index c3a80a8f19f..98e079ca82e 100644 --- a/service/networkmanager/options.go +++ b/service/networkmanager/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/networkmanager/types/enums.go b/service/networkmanager/types/enums.go index 1a7e0b447d8..07560ec6c4d 100644 --- a/service/networkmanager/types/enums.go +++ b/service/networkmanager/types/enums.go @@ -18,8 +18,9 @@ const ( ) // Values returns all known values for AttachmentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentState) Values() []AttachmentState { return []AttachmentState{ "REJECTED", @@ -45,8 +46,9 @@ const ( ) // Values returns all known values for AttachmentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentType) Values() []AttachmentType { return []AttachmentType{ "CONNECT", @@ -66,8 +68,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -89,8 +92,9 @@ const ( ) // Values returns all known values for ChangeSetState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeSetState) Values() []ChangeSetState { return []ChangeSetState{ "PENDING_GENERATION", @@ -113,8 +117,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -140,8 +145,9 @@ const ( ) // Values returns all known values for ChangeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeType) Values() []ChangeType { return []ChangeType{ "CORE_NETWORK_SEGMENT", @@ -167,8 +173,9 @@ const ( ) // Values returns all known values for ConnectionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionState) Values() []ConnectionState { return []ConnectionState{ "PENDING", @@ -187,8 +194,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "UP", @@ -205,8 +213,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "BGP", @@ -226,6 +235,7 @@ const ( // Values returns all known values for ConnectPeerAssociationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConnectPeerAssociationState) Values() []ConnectPeerAssociationState { return []ConnectPeerAssociationState{ @@ -247,8 +257,9 @@ const ( ) // Values returns all known values for ConnectPeerState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectPeerState) Values() []ConnectPeerState { return []ConnectPeerState{ "CREATING", @@ -267,8 +278,9 @@ const ( ) // Values returns all known values for CoreNetworkPolicyAlias. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoreNetworkPolicyAlias) Values() []CoreNetworkPolicyAlias { return []CoreNetworkPolicyAlias{ "LIVE", @@ -287,8 +299,9 @@ const ( ) // Values returns all known values for CoreNetworkState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CoreNetworkState) Values() []CoreNetworkState { return []CoreNetworkState{ "CREATING", @@ -310,8 +323,9 @@ const ( // Values returns all known values for CustomerGatewayAssociationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomerGatewayAssociationState) Values() []CustomerGatewayAssociationState { return []CustomerGatewayAssociationState{ "PENDING", @@ -332,8 +346,9 @@ const ( ) // Values returns all known values for DeviceState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceState) Values() []DeviceState { return []DeviceState{ "PENDING", @@ -354,8 +369,9 @@ const ( ) // Values returns all known values for GlobalNetworkState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalNetworkState) Values() []GlobalNetworkState { return []GlobalNetworkState{ "PENDING", @@ -376,8 +392,9 @@ const ( ) // Values returns all known values for LinkAssociationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LinkAssociationState) Values() []LinkAssociationState { return []LinkAssociationState{ "PENDING", @@ -398,8 +415,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -420,8 +438,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -439,8 +458,9 @@ const ( ) // Values returns all known values for PeeringType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PeeringType) Values() []PeeringType { return []PeeringType{ "TRANSIT_GATEWAY", @@ -466,8 +486,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteAnalysisCompletionReasonCode) Values() []RouteAnalysisCompletionReasonCode { return []RouteAnalysisCompletionReasonCode{ "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", @@ -494,8 +515,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteAnalysisCompletionResultCode) Values() []RouteAnalysisCompletionResultCode { return []RouteAnalysisCompletionResultCode{ "CONNECTED", @@ -513,8 +535,9 @@ const ( ) // Values returns all known values for RouteAnalysisStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteAnalysisStatus) Values() []RouteAnalysisStatus { return []RouteAnalysisStatus{ "RUNNING", @@ -532,8 +555,9 @@ const ( ) // Values returns all known values for RouteState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteState) Values() []RouteState { return []RouteState{ "ACTIVE", @@ -550,8 +574,9 @@ const ( ) // Values returns all known values for RouteTableType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RouteTableType) Values() []RouteTableType { return []RouteTableType{ "TRANSIT_GATEWAY_ROUTE_TABLE", @@ -568,8 +593,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -588,8 +614,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -611,8 +638,9 @@ const ( // Values returns all known values for TransitGatewayConnectPeerAssociationState. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayConnectPeerAssociationState) Values() []TransitGatewayConnectPeerAssociationState { return []TransitGatewayConnectPeerAssociationState{ "PENDING", @@ -635,8 +663,9 @@ const ( // Values returns all known values for TransitGatewayRegistrationState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitGatewayRegistrationState) Values() []TransitGatewayRegistrationState { return []TransitGatewayRegistrationState{ "PENDING", @@ -656,8 +685,9 @@ const ( ) // Values returns all known values for TunnelProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TunnelProtocol) Values() []TunnelProtocol { return []TunnelProtocol{ "GRE", @@ -677,6 +707,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/networkmanager/types/types.go b/service/networkmanager/types/types.go index af1cf86dd88..2ea13ba8011 100644 --- a/service/networkmanager/types/types.go +++ b/service/networkmanager/types/types.go @@ -782,22 +782,38 @@ type NetworkResource struct { // The ID of the resource. ResourceId *string - // The resource type. The following are the supported resource types for Direct - // Connect: + // 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 ResourceType *string @@ -1068,20 +1084,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. ReasonCode RouteAnalysisCompletionReasonCode @@ -1196,10 +1221,14 @@ type SiteToSiteVpnAttachment struct { // Describes a tag. type Tag struct { - // The tag key. Constraints: Maximum length of 128 characters. + // The tag key. + // + // Constraints: Maximum length of 128 characters. Key *string - // The tag value. Constraints: Maximum length of 256 characters. + // The tag value. + // + // Constraints: Maximum length of 256 characters. Value *string noSmithyDocumentSerde diff --git a/service/networkmonitor/api_op_CreateMonitor.go b/service/networkmonitor/api_op_CreateMonitor.go index ae8764cc089..596853d59d6 100644 --- a/service/networkmonitor/api_op_CreateMonitor.go +++ b/service/networkmonitor/api_op_CreateMonitor.go @@ -14,16 +14,23 @@ import ( // Creates a monitor between a source subnet and destination IP address. Within a // monitor you'll create one or more probes that monitor network traffic between // your source Amazon Web Services VPC subnets and your destination IP addresses. -// Each probe then aggregates and sends metrics to Amazon CloudWatch. You can also -// create a monitor with probes using this command. For each probe, you define the -// following: +// Each probe then aggregates and sends metrics to Amazon CloudWatch. +// +// You can also create a monitor with probes using this command. For each probe, +// you define the following: +// // - source —The subnet IDs where the probes will be created. +// // - destination — The target destination IP address for the probe. +// // - destinationPort —Required only if the protocol is TCP . +// // - protocol —The communication protocol between the source and destination. // This will be either TCP or ICMP . +// // - packetSize —The size of the packets. This must be a number between 56 and // 8500 . +// // - (Optional) tags —Key-value pairs created and assigned to the probe. func (c *Client) CreateMonitor(ctx context.Context, params *CreateMonitorInput, optFns ...func(*Options)) (*CreateMonitorOutput, error) { if params == nil { diff --git a/service/networkmonitor/api_op_DeleteMonitor.go b/service/networkmonitor/api_op_DeleteMonitor.go index ea36f94aa2f..3ba88b7522d 100644 --- a/service/networkmonitor/api_op_DeleteMonitor.go +++ b/service/networkmonitor/api_op_DeleteMonitor.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specified monitor. This action requires the monitorName parameter. -// Run ListMonitors to get a list of monitor names. +// Deletes a specified monitor. +// +// This action requires the monitorName parameter. Run ListMonitors to get a list +// of monitor names. func (c *Client) DeleteMonitor(ctx context.Context, params *DeleteMonitorInput, optFns ...func(*Options)) (*DeleteMonitorOutput, error) { if params == nil { params = &DeleteMonitorInput{} diff --git a/service/networkmonitor/api_op_DeleteProbe.go b/service/networkmonitor/api_op_DeleteProbe.go index db7c3654c3b..497df840a3c 100644 --- a/service/networkmonitor/api_op_DeleteProbe.go +++ b/service/networkmonitor/api_op_DeleteProbe.go @@ -11,10 +11,12 @@ import ( ) // Deletes the specified probe. Once a probe is deleted you'll no longer incur any -// billing fees for that probe. This action requires both the monitorName and -// probeId parameters. Run ListMonitors to get a list of monitor names. Run -// GetMonitor to get a list of probes and probe IDs. You can only delete a single -// probe at a time using this action. +// billing fees for that probe. +// +// This action requires both the monitorName and probeId parameters. Run +// ListMonitors to get a list of monitor names. Run GetMonitor to get a list of +// probes and probe IDs. You can only delete a single probe at a time using this +// action. func (c *Client) DeleteProbe(ctx context.Context, params *DeleteProbeInput, optFns ...func(*Options)) (*DeleteProbeOutput, error) { if params == nil { params = &DeleteProbeInput{} diff --git a/service/networkmonitor/api_op_GetMonitor.go b/service/networkmonitor/api_op_GetMonitor.go index 4b6d16d2019..f6a7c489455 100644 --- a/service/networkmonitor/api_op_GetMonitor.go +++ b/service/networkmonitor/api_op_GetMonitor.go @@ -12,8 +12,10 @@ import ( "time" ) -// Returns details about a specific monitor. This action requires the monitorName -// parameter. Run ListMonitors to get a list of monitor names. +// Returns details about a specific monitor. +// +// This action requires the monitorName parameter. Run ListMonitors to get a list +// of monitor names. func (c *Client) GetMonitor(ctx context.Context, params *GetMonitorInput, optFns ...func(*Options)) (*GetMonitorOutput, error) { if params == nil { params = &GetMonitorInput{} diff --git a/service/networkmonitor/api_op_ListMonitors.go b/service/networkmonitor/api_op_ListMonitors.go index e5ba97a83c8..663008278c4 100644 --- a/service/networkmonitor/api_op_ListMonitors.go +++ b/service/networkmonitor/api_op_ListMonitors.go @@ -30,8 +30,9 @@ func (c *Client) ListMonitors(ctx context.Context, params *ListMonitorsInput, op type ListMonitorsInput 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. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. MaxResults *int32 // The token for the next page of results. @@ -145,8 +146,9 @@ var _ ListMonitorsAPIClient = (*Client)(nil) // ListMonitorsPaginatorOptions is the paginator options for ListMonitors type ListMonitorsPaginatorOptions 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. If - // MaxResults is given a value larger than 100, only 100 results are returned. + // remaining results, make another call with the returned nextToken value. + // + // If MaxResults is given a value larger than 100, only 100 results are returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/networkmonitor/api_op_UpdateProbe.go b/service/networkmonitor/api_op_UpdateProbe.go index 8fb374fe674..64ce7f81eb3 100644 --- a/service/networkmonitor/api_op_UpdateProbe.go +++ b/service/networkmonitor/api_op_UpdateProbe.go @@ -14,16 +14,23 @@ import ( // Updates a monitor probe. This action requires both the monitorName and probeId // parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to -// get a list of probes and probe IDs. You can update the following para create a -// monitor with probes using this command. For each probe, you define the -// following: +// get a list of probes and probe IDs. +// +// You can update the following para create a monitor with probes using this +// command. For each probe, you define the following: +// // - state —The state of the probe. +// // - destination — The target destination IP address for the probe. +// // - destinationPort —Required only if the protocol is TCP . +// // - protocol —The communication protocol between the source and destination. // This will be either TCP or ICMP . +// // - packetSize —The size of the packets. This must be a number between 56 and // 8500 . +// // - (Optional) tags —Key-value pairs created and assigned to the probe. func (c *Client) UpdateProbe(ctx context.Context, params *UpdateProbeInput, optFns ...func(*Options)) (*UpdateProbeOutput, error) { if params == nil { diff --git a/service/networkmonitor/doc.go b/service/networkmonitor/doc.go index a10f9e2131f..c6152b47512 100644 --- a/service/networkmonitor/doc.go +++ b/service/networkmonitor/doc.go @@ -12,11 +12,14 @@ // creates a monitor containing all the possible source and destination // combinations, each of which is called a probe, within a single monitor. These // probes then monitor network traffic to help you identify where network issues -// might be affecting your traffic. Before you begin, ensure the Amazon Web -// Services CLI is configured in the Amazon Web Services Account where you will -// create the Network Monitor resource. Network Monitor doesn’t support creation on -// cross-account resources, but you can create a Network Monitor in any subnet -// belonging to a VPC owned by your Account. For more information, see Using -// Amazon CloudWatch Network Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/what-is-network-monitor.html) -// in the Amazon CloudWatch User Guide. +// might be affecting your traffic. +// +// Before you begin, ensure the Amazon Web Services CLI is configured in the +// Amazon Web Services Account where you will create the Network Monitor resource. +// Network Monitor doesn’t support creation on cross-account resources, but you can +// create a Network Monitor in any subnet belonging to a VPC owned by your Account. +// +// For more information, see [Using Amazon CloudWatch Network Monitor] in the Amazon CloudWatch User Guide. +// +// [Using Amazon CloudWatch Network Monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/what-is-network-monitor.html package networkmonitor diff --git a/service/networkmonitor/options.go b/service/networkmonitor/options.go index 90427c15d77..1cd558322db 100644 --- a/service/networkmonitor/options.go +++ b/service/networkmonitor/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/networkmonitor/types/enums.go b/service/networkmonitor/types/enums.go index 600af4fc250..0843b82170f 100644 --- a/service/networkmonitor/types/enums.go +++ b/service/networkmonitor/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AddressFamily. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddressFamily) Values() []AddressFamily { return []AddressFamily{ "IPV4", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for MonitorState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitorState) Values() []MonitorState { return []MonitorState{ "PENDING", @@ -57,8 +59,9 @@ const ( ) // Values returns all known values for ProbeState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProbeState) Values() []ProbeState { return []ProbeState{ "PENDING", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "TCP", diff --git a/service/nimble/api_op_CreateStreamingSession.go b/service/nimble/api_op_CreateStreamingSession.go index f7b1e3a5d1e..3b7e75facbd 100644 --- a/service/nimble/api_op_CreateStreamingSession.go +++ b/service/nimble/api_op_CreateStreamingSession.go @@ -11,8 +11,10 @@ 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_CreateStreamingSessionStream.go b/service/nimble/api_op_CreateStreamingSessionStream.go index 66f3560d2e6..4a24ce283f2 100644 --- a/service/nimble/api_op_CreateStreamingSessionStream.go +++ b/service/nimble/api_op_CreateStreamingSessionStream.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a streaming session stream for a streaming session. After invoking this -// API, invoke GetStreamingSessionStream with the returned streamId to poll the -// resource until it is in the READY state. +// Creates a streaming session stream for a streaming session. +// +// After invoking this API, invoke GetStreamingSessionStream with the returned +// streamId to poll the resource until it is in the READY state. func (c *Client) CreateStreamingSessionStream(ctx context.Context, params *CreateStreamingSessionStreamInput, optFns ...func(*Options)) (*CreateStreamingSessionStreamOutput, error) { if params == nil { params = &CreateStreamingSessionStreamInput{} diff --git a/service/nimble/api_op_CreateStudio.go b/service/nimble/api_op_CreateStudio.go index 68fa4f83ef1..26a6e57d172 100644 --- a/service/nimble/api_op_CreateStudio.go +++ b/service/nimble/api_op_CreateStudio.go @@ -11,22 +11,34 @@ 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 -// 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 -// 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 -// when calling CreateStudio to encrypt this data using a key you own and manage. +// 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 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 when calling CreateStudio to encrypt this data +// using a key you own and manage. +// // When providing an KMS key during studio creation, Nimble Studio creates KMS // grants in your account to provide your studio user and admin roles access to -// these KMS keys. If you delete this grant, the studio will no longer be -// accessible to your portal users. If you delete the studio KMS key, your studio -// will no longer be accessible. +// these KMS keys. +// +// If you delete this grant, the studio will no longer be accessible to your +// portal users. +// +// If you delete the studio KMS key, your studio will no longer be accessible. func (c *Client) CreateStudio(ctx context.Context, params *CreateStudioInput, optFns ...func(*Options)) (*CreateStudioOutput, error) { if params == nil { params = &CreateStudioInput{} diff --git a/service/nimble/api_op_DeleteStreamingSession.go b/service/nimble/api_op_DeleteStreamingSession.go index 05bee958a13..6b37a76ec5a 100644 --- a/service/nimble/api_op_DeleteStreamingSession.go +++ b/service/nimble/api_op_DeleteStreamingSession.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . 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 d9707d135ec..5137c0638d8 100644 --- a/service/nimble/api_op_GetLaunchProfile.go +++ b/service/nimble/api_op_GetLaunchProfile.go @@ -176,12 +176,13 @@ type LaunchProfileReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetLaunchProfileInput, *GetLaunchProfileOutput, error) (bool, error) } @@ -384,12 +385,13 @@ type LaunchProfileDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetLaunchProfileInput, *GetLaunchProfileOutput, error) (bool, error) } diff --git a/service/nimble/api_op_GetStreamingImage.go b/service/nimble/api_op_GetStreamingImage.go index 34bfff5d5a7..0dfb13e24b2 100644 --- a/service/nimble/api_op_GetStreamingImage.go +++ b/service/nimble/api_op_GetStreamingImage.go @@ -178,12 +178,13 @@ type StreamingImageReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingImageInput, *GetStreamingImageOutput, error) (bool, error) } @@ -386,12 +387,13 @@ type StreamingImageDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingImageInput, *GetStreamingImageOutput, error) (bool, error) } diff --git a/service/nimble/api_op_GetStreamingSession.go b/service/nimble/api_op_GetStreamingSession.go index 71f69826dcc..ade3d9a1e68 100644 --- a/service/nimble/api_op_GetStreamingSession.go +++ b/service/nimble/api_op_GetStreamingSession.go @@ -15,8 +15,10 @@ import ( "time" ) -// Gets StreamingSession resource. Invoke this operation to poll for a streaming -// session state while creating or deleting a session. +// Gets StreamingSession resource. +// +// Invoke this operation to poll for a streaming session state while creating or +// deleting a session. func (c *Client) GetStreamingSession(ctx context.Context, params *GetStreamingSessionInput, optFns ...func(*Options)) (*GetStreamingSessionOutput, error) { if params == nil { params = &GetStreamingSessionInput{} @@ -179,12 +181,13 @@ type StreamingSessionReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingSessionInput, *GetStreamingSessionOutput, error) (bool, error) } @@ -387,12 +390,13 @@ type StreamingSessionStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingSessionInput, *GetStreamingSessionOutput, error) (bool, error) } @@ -578,12 +582,13 @@ type StreamingSessionDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingSessionInput, *GetStreamingSessionOutput, error) (bool, error) } diff --git a/service/nimble/api_op_GetStreamingSessionBackup.go b/service/nimble/api_op_GetStreamingSessionBackup.go index 1a7a441e2c3..a784474cb10 100644 --- a/service/nimble/api_op_GetStreamingSessionBackup.go +++ b/service/nimble/api_op_GetStreamingSessionBackup.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets StreamingSessionBackup resource. Invoke this operation to poll for a -// streaming session backup while stopping a streaming session. +// Gets StreamingSessionBackup resource. +// +// Invoke this operation to poll for a streaming session backup while stopping a +// streaming session. func (c *Client) GetStreamingSessionBackup(ctx context.Context, params *GetStreamingSessionBackupInput, optFns ...func(*Options)) (*GetStreamingSessionBackupOutput, error) { if params == nil { params = &GetStreamingSessionBackupInput{} diff --git a/service/nimble/api_op_GetStreamingSessionStream.go b/service/nimble/api_op_GetStreamingSessionStream.go index 30ee39e01d5..842fd67f364 100644 --- a/service/nimble/api_op_GetStreamingSessionStream.go +++ b/service/nimble/api_op_GetStreamingSessionStream.go @@ -15,10 +15,13 @@ import ( "time" ) -// 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. +// 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. func (c *Client) GetStreamingSessionStream(ctx context.Context, params *GetStreamingSessionStreamInput, optFns ...func(*Options)) (*GetStreamingSessionStreamOutput, error) { if params == nil { params = &GetStreamingSessionStreamInput{} @@ -186,12 +189,13 @@ type StreamingSessionStreamReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStreamingSessionStreamInput, *GetStreamingSessionStreamOutput, error) (bool, error) } diff --git a/service/nimble/api_op_GetStudio.go b/service/nimble/api_op_GetStudio.go index ba64f852084..e0e6c0b2745 100644 --- a/service/nimble/api_op_GetStudio.go +++ b/service/nimble/api_op_GetStudio.go @@ -172,12 +172,13 @@ type StudioReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStudioInput, *GetStudioOutput, error) (bool, error) } @@ -377,12 +378,13 @@ type StudioDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStudioInput, *GetStudioOutput, error) (bool, error) } diff --git a/service/nimble/api_op_GetStudioComponent.go b/service/nimble/api_op_GetStudioComponent.go index 4a564ac8331..75d10c06157 100644 --- a/service/nimble/api_op_GetStudioComponent.go +++ b/service/nimble/api_op_GetStudioComponent.go @@ -178,12 +178,13 @@ type StudioComponentReadyWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStudioComponentInput, *GetStudioComponentOutput, error) (bool, error) } @@ -386,12 +387,13 @@ type StudioComponentDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetStudioComponentInput, *GetStudioComponentOutput, error) (bool, error) } diff --git a/service/nimble/api_op_ListStreamingImages.go b/service/nimble/api_op_ListStreamingImages.go index 21836c1aa38..5614b430fa6 100644 --- a/service/nimble/api_op_ListStreamingImages.go +++ b/service/nimble/api_op_ListStreamingImages.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the streaming image resources available to this studio. This list will -// contain both images provided by Amazon Web Services, as well as streaming images -// that you have created in your studio. +// List the streaming image resources available to this studio. +// +// This list will contain both images provided by Amazon Web Services, as well as +// streaming images that you have created in your studio. func (c *Client) ListStreamingImages(ctx context.Context, params *ListStreamingImagesInput, optFns ...func(*Options)) (*ListStreamingImagesOutput, error) { if params == nil { params = &ListStreamingImagesInput{} diff --git a/service/nimble/api_op_ListStudioMembers.go b/service/nimble/api_op_ListStudioMembers.go index 13370bc3e05..3da7464ab9b 100644 --- a/service/nimble/api_op_ListStudioMembers.go +++ b/service/nimble/api_op_ListStudioMembers.go @@ -11,8 +11,9 @@ 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_ListTagsForResource.go b/service/nimble/api_op_ListTagsForResource.go index 667a7eb24da..a4376ce157e 100644 --- a/service/nimble/api_op_ListTagsForResource.go +++ b/service/nimble/api_op_ListTagsForResource.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the tags for a resource, given its Amazon Resource Names (ARN). This -// operation supports ARNs for all resource types in Nimble Studio that support -// tags, including studio, studio component, launch profile, streaming image, and -// streaming session. All resources that can be tagged will contain an ARN -// property, so you do not have to create this ARN yourself. +// Gets the tags for a resource, given its Amazon Resource Names (ARN). +// +// This operation supports ARNs for all resource types in Nimble Studio that +// support tags, including studio, studio component, launch profile, streaming +// image, and streaming session. All resources that can be tagged will contain an +// ARN property, so you do not have to create this ARN yourself. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/nimble/api_op_StartStudioSSOConfigurationRepair.go b/service/nimble/api_op_StartStudioSSOConfigurationRepair.go index e0b266ae79b..00a8cd37420 100644 --- a/service/nimble/api_op_StartStudioSSOConfigurationRepair.go +++ b/service/nimble/api_op_StartStudioSSOConfigurationRepair.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Repairs the IAM Identity Center configuration for a given studio. If the studio -// has a valid IAM Identity Center configuration currently associated with it, this -// operation will fail with a validation error. If the studio does not have a valid -// IAM Identity Center configuration currently associated with it, then a new IAM -// Identity Center application is created for the studio and the studio is changed -// to the READY state. After the IAM Identity Center application is repaired, you -// must use the Amazon Nimble Studio console to add administrators and users to -// your studio. +// Repairs the IAM Identity Center configuration for a given studio. +// +// If the studio has a valid IAM Identity Center configuration currently +// associated with it, this operation will fail with a validation error. +// +// If the studio does not have a valid IAM Identity Center configuration currently +// associated with it, then a new IAM Identity Center application is created for +// the studio and the studio is changed to the READY state. +// +// After the IAM Identity Center application is repaired, you must use the Amazon +// Nimble Studio console to add administrators and users to your studio. func (c *Client) StartStudioSSOConfigurationRepair(ctx context.Context, params *StartStudioSSOConfigurationRepairInput, optFns ...func(*Options)) (*StartStudioSSOConfigurationRepairOutput, error) { if params == nil { params = &StartStudioSSOConfigurationRepairInput{} diff --git a/service/nimble/api_op_UpdateStreamingImage.go b/service/nimble/api_op_UpdateStreamingImage.go index e7dffefaa43..cbbf71e950a 100644 --- a/service/nimble/api_op_UpdateStreamingImage.go +++ b/service/nimble/api_op_UpdateStreamingImage.go @@ -56,12 +56,17 @@ 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 - // 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 - // include software that your users require. + // 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 include software that your users + // require. StreamingImage *types.StreamingImage // Metadata pertaining to the operation's result. diff --git a/service/nimble/api_op_UpdateStudio.go b/service/nimble/api_op_UpdateStudio.go index b674cf2a1f1..b0bf1eb777a 100644 --- a/service/nimble/api_op_UpdateStudio.go +++ b/service/nimble/api_op_UpdateStudio.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a Studio resource. Currently, this operation only supports updating the -// displayName of your studio. +// Update a Studio resource. +// +// Currently, this operation only supports updating the displayName of your studio. func (c *Client) UpdateStudio(ctx context.Context, params *UpdateStudioInput, optFns ...func(*Options)) (*UpdateStudioOutput, error) { if params == nil { params = &UpdateStudioInput{} diff --git a/service/nimble/doc.go b/service/nimble/doc.go index 0bcc97b54a4..102991f98b9 100644 --- a/service/nimble/doc.go +++ b/service/nimble/doc.go @@ -5,7 +5,9 @@ // // Welcome to the Amazon Nimble Studio API reference. This API reference provides // methods, schema, resources, parameters, and more to help you get the most out of -// Nimble Studio. Nimble Studio is a virtual studio that empowers visual effects, -// animation, and interactive content teams to create content securely within a -// scalable, private cloud service. +// Nimble Studio. +// +// Nimble Studio is a virtual studio that empowers visual effects, animation, and +// interactive content teams to create content securely within a scalable, private +// cloud service. package nimble diff --git a/service/nimble/options.go b/service/nimble/options.go index d839d14c433..76c946139af 100644 --- a/service/nimble/options.go +++ b/service/nimble/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/nimble/types/enums.go b/service/nimble/types/enums.go index e4de2621e3e..d00c7c04eae 100644 --- a/service/nimble/types/enums.go +++ b/service/nimble/types/enums.go @@ -12,6 +12,7 @@ const ( // 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{ @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for LaunchProfilePersona. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfilePersona) Values() []LaunchProfilePersona { return []LaunchProfilePersona{ "USER", @@ -45,8 +47,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "LINUX", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for LaunchProfileState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfileState) Values() []LaunchProfileState { return []LaunchProfileState{ "CREATE_IN_PROGRESS", @@ -106,8 +110,9 @@ const ( ) // Values returns all known values for LaunchProfileStatusCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfileStatusCode) Values() []LaunchProfileStatusCode { return []LaunchProfileStatusCode{ "LAUNCH_PROFILE_CREATED", @@ -141,8 +146,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfileValidationState) Values() []LaunchProfileValidationState { return []LaunchProfileValidationState{ "VALIDATION_NOT_STARTED", @@ -170,8 +176,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfileValidationStatusCode) Values() []LaunchProfileValidationStatusCode { return []LaunchProfileValidationStatusCode{ "VALIDATION_NOT_STARTED", @@ -198,6 +205,7 @@ const ( // Values returns all known values for LaunchProfileValidationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LaunchProfileValidationType) Values() []LaunchProfileValidationType { return []LaunchProfileValidationType{ @@ -217,8 +225,9 @@ const ( ) // Values returns all known values for SessionBackupMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionBackupMode) Values() []SessionBackupMode { return []SessionBackupMode{ "AUTOMATIC", @@ -235,8 +244,9 @@ const ( ) // Values returns all known values for SessionPersistenceMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionPersistenceMode) Values() []SessionPersistenceMode { return []SessionPersistenceMode{ "DEACTIVATED", @@ -253,8 +263,9 @@ const ( ) // Values returns all known values for StreamingClipboardMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingClipboardMode) Values() []StreamingClipboardMode { return []StreamingClipboardMode{ "ENABLED", @@ -271,8 +282,9 @@ const ( // Values returns all known values for // StreamingImageEncryptionConfigurationKeyType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingImageEncryptionConfigurationKeyType) Values() []StreamingImageEncryptionConfigurationKeyType { return []StreamingImageEncryptionConfigurationKeyType{ "CUSTOMER_MANAGED_KEY", @@ -294,8 +306,9 @@ const ( ) // Values returns all known values for StreamingImageState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingImageState) Values() []StreamingImageState { return []StreamingImageState{ "CREATE_IN_PROGRESS", @@ -324,6 +337,7 @@ const ( // 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{ @@ -357,8 +371,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "g4dn.xlarge", @@ -395,8 +410,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CREATE_IN_PROGRESS", @@ -437,6 +453,7 @@ const ( // Values returns all known values for StreamingSessionStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StreamingSessionStatusCode) Values() []StreamingSessionStatusCode { return []StreamingSessionStatusCode{ @@ -468,6 +485,7 @@ const ( // Values returns all known values for StreamingSessionStorageMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StreamingSessionStorageMode) Values() []StreamingSessionStorageMode { return []StreamingSessionStorageMode{ @@ -489,6 +507,7 @@ const ( // Values returns all known values for StreamingSessionStreamState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StreamingSessionStreamState) Values() []StreamingSessionStreamState { return []StreamingSessionStreamState{ @@ -515,8 +534,9 @@ const ( // Values returns all known values for StreamingSessionStreamStatusCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingSessionStreamStatusCode) Values() []StreamingSessionStreamStatusCode { return []StreamingSessionStreamStatusCode{ "STREAM_CREATE_IN_PROGRESS", @@ -538,8 +558,9 @@ const ( // Values returns all known values for // StudioComponentInitializationScriptRunContext. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioComponentInitializationScriptRunContext) Values() []StudioComponentInitializationScriptRunContext { return []StudioComponentInitializationScriptRunContext{ "SYSTEM_INITIALIZATION", @@ -562,8 +583,9 @@ const ( ) // Values returns all known values for StudioComponentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioComponentState) Values() []StudioComponentState { return []StudioComponentState{ "CREATE_IN_PROGRESS", @@ -595,6 +617,7 @@ const ( // Values returns all known values for StudioComponentStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (StudioComponentStatusCode) Values() []StudioComponentStatusCode { return []StudioComponentStatusCode{ @@ -622,8 +645,9 @@ const ( ) // Values returns all known values for StudioComponentSubtype. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioComponentSubtype) Values() []StudioComponentSubtype { return []StudioComponentSubtype{ "AWS_MANAGED_MICROSOFT_AD", @@ -645,8 +669,9 @@ const ( ) // Values returns all known values for StudioComponentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioComponentType) Values() []StudioComponentType { return []StudioComponentType{ "ACTIVE_DIRECTORY", @@ -667,8 +692,9 @@ const ( // Values returns all known values for StudioEncryptionConfigurationKeyType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioEncryptionConfigurationKeyType) Values() []StudioEncryptionConfigurationKeyType { return []StudioEncryptionConfigurationKeyType{ "AWS_OWNED_KEY", @@ -684,8 +710,9 @@ const ( ) // Values returns all known values for StudioPersona. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioPersona) Values() []StudioPersona { return []StudioPersona{ "ADMINISTRATOR", @@ -707,8 +734,9 @@ const ( ) // Values returns all known values for StudioState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioState) Values() []StudioState { return []StudioState{ "CREATE_IN_PROGRESS", @@ -748,8 +776,9 @@ const ( ) // Values returns all known values for StudioStatusCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioStatusCode) Values() []StudioStatusCode { return []StudioStatusCode{ "STUDIO_CREATED", @@ -783,8 +812,9 @@ const ( ) // Values returns all known values for VolumeRetentionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeRetentionMode) Values() []VolumeRetentionMode { return []VolumeRetentionMode{ "RETAIN", diff --git a/service/nimble/types/errors.go b/service/nimble/types/errors.go index f01156bdf45..60742b0b74a 100644 --- a/service/nimble/types/errors.go +++ b/service/nimble/types/errors.go @@ -125,8 +125,9 @@ func (e *ResourceNotFoundException) ErrorCode() string { func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Your current quota does not allow you to perform the request action. You can -// request increases for some quotas, and other quotas cannot be increased. Please -// use Amazon Web Services Service Quotas to request an increase. +// request increases for some quotas, and other quotas cannot be increased. +// +// Please use Amazon Web Services Service Quotas to request an increase. type ServiceQuotaExceededException struct { Message *string diff --git a/service/nimble/types/types.go b/service/nimble/types/types.go index 372441496fb..138568eaf21 100644 --- a/service/nimble/types/types.go +++ b/service/nimble/types/types.go @@ -97,9 +97,11 @@ type EulaAcceptance struct { // A launch profile controls your artist workforce’s access to studio components, // like compute farms, shared file systems, managed file systems, and license // server configurations, as well as instance types and Amazon Machine Images -// (AMIs). Studio administrators create launch profiles in the Nimble Studio -// console. Artists can use their launch profiles to launch an instance from the -// Nimble Studio portal. Each user’s launch profile defines how they can launch a +// (AMIs). +// +// Studio administrators create launch profiles in the Nimble Studio console. +// Artists can use their launch profiles to launch an instance from the Nimble +// Studio portal. Each user’s launch profile defines how they can launch a // streaming session. By default, studio admins can use all launch profiles. type LaunchProfile struct { @@ -162,8 +164,10 @@ type LaunchProfile struct { } // A launch profile initialization contains information required for a workstation -// or server to connect to a launch profile. This includes scripts, endpoints, -// security groups, subnets, and other configuration. +// or server to connect to a launch profile. +// +// This includes scripts, endpoints, security groups, subnets, and other +// configuration. type LaunchProfileInitialization struct { // A LaunchProfileInitializationActiveDirectory resource. @@ -256,13 +260,20 @@ type LaunchProfileInitializationScript struct { // access to studio users in the Nimble Studio portal without writing or // maintaining complex IAM policies. A launch profile member is a user association // 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 type LaunchProfileMembership struct { @@ -383,11 +394,14 @@ 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 . AutomaticTerminationMode AutomaticTerminationMode @@ -400,16 +414,20 @@ type StreamConfiguration struct { // 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 - // maxSessionLengthInMinutes value, the session will automatically be terminated - // (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 - // (instead of terminated). + // 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 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 (instead of terminated). MaxStoppedSessionLengthInMinutes int32 // Information about the streaming session backup. @@ -424,8 +442,9 @@ type StreamConfiguration struct { SessionStorage *StreamConfigurationSessionStorage // Custom volume configuration for the root volumes that are attached to streaming - // sessions. This parameter is only allowed when sessionPersistenceMode is - // ACTIVATED . + // sessions. + // + // This parameter is only allowed when sessionPersistenceMode is ACTIVATED . VolumeConfiguration *VolumeConfiguration noSmithyDocumentSerde @@ -455,11 +474,14 @@ 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 . AutomaticTerminationMode AutomaticTerminationMode @@ -472,16 +494,20 @@ type StreamConfigurationCreate struct { // 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 - // maxSessionLengthInMinutes value, the session will automatically be terminated - // (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 - // (instead of terminated). + // 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 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 (instead of terminated). MaxStoppedSessionLengthInMinutes int32 // Configures how streaming sessions are backed up when launched from this launch @@ -498,8 +524,9 @@ type StreamConfigurationCreate struct { SessionStorage *StreamConfigurationSessionStorage // Custom volume configuration for the root volumes that are attached to streaming - // sessions. This parameter is only allowed when sessionPersistenceMode is - // ACTIVATED . + // sessions. + // + // This parameter is only allowed when sessionPersistenceMode is ACTIVATED . VolumeConfiguration *VolumeConfiguration noSmithyDocumentSerde @@ -513,10 +540,11 @@ type StreamConfigurationSessionBackup struct { // launch profile can have. MaxBackupsToRetain int32 - // Specifies how artists sessions are backed up. Configures backups for streaming - // 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 . + // Specifies how artists sessions are backed up. + // + // Configures backups for streaming 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 . Mode SessionBackupMode noSmithyDocumentSerde @@ -537,12 +565,17 @@ 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 -// 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 -// include software that your users require. +// 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 include software that your users +// require. type StreamingImage struct { // The Amazon Resource Name (ARN) that is assigned to a studio resource and @@ -616,11 +649,14 @@ 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 . AutomaticTerminationMode AutomaticTerminationMode @@ -703,8 +739,9 @@ type StreamingSession struct { UpdatedBy *string // Custom volume configuration for the root volumes that are attached to streaming - // sessions. This parameter is only allowed when sessionPersistenceMode is - // ACTIVATED . + // sessions. + // + // This parameter is only allowed when sessionPersistenceMode is ACTIVATED . VolumeConfiguration *VolumeConfiguration // Determine if an EBS volume created from this streaming session will be backed @@ -801,17 +838,24 @@ type StreamingSessionStream struct { noSmithyDocumentSerde } -// Represents a studio resource. A studio is the core resource used with Nimble -// Studio. You must create a studio first, before any other resource type can be -// created. All other resources you create and manage in Nimble Studio are -// contained within a studio. When creating a studio, you must provides two IAM -// roles for use with the Nimble Studio portal. These roles are assumed by your -// users when they log in to the Nimble Studio portal via IAM Identity Center and -// your identity source. 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. Your studio roles must trust the -// identity.nimble.amazonaws.com service principal to function properly. +// Represents a studio resource. +// +// A studio is the core resource used with Nimble Studio. You must create a studio +// first, before any other resource type can be created. All other resources you +// create and manage in Nimble Studio are contained within a studio. +// +// When creating a studio, you must provides two IAM roles for use with the Nimble +// Studio portal. These roles are assumed by your users when they log in to the +// Nimble Studio portal via IAM Identity Center and your identity source. +// +// 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. +// +// Your studio roles must trust the identity.nimble.amazonaws.com service +// principal to function properly. type Studio struct { // The IAM role that studio admins assume when logging in to the Nimble Studio @@ -875,13 +919,15 @@ type Studio struct { // A studio component represents a network resource to be used by a studio's users // and workflows. A typical studio contains studio components for each of the -// 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 -// 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. +// 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 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. type StudioComponent struct { // The Amazon Resource Name (ARN) that is assigned to a studio resource and @@ -1041,14 +1087,17 @@ type StudioEncryptionConfiguration struct { } // A studio member is an association of a user from your studio identity source to -// elevated permissions that they are granted in the studio. When you add a user to -// your studio using the Nimble Studio console, they are given access to the -// studio's IAM Identity Center application and are given access to log in to the -// Nimble Studio portal. These users have the permissions provided by the studio's -// user IAM role and do not appear in the studio membership collection. Only studio -// admins appear in studio membership. When you add a user to studio membership -// with the ADMIN persona, upon logging in to the Nimble Studio portal, they are -// granted permissions specified by the Studio's Admin IAM role. +// elevated permissions that they are granted in the studio. +// +// When you add a user to your studio using the Nimble Studio console, they are +// given access to the studio's IAM Identity Center application and are given +// access to log in to the Nimble Studio portal. These users have the permissions +// provided by the studio's user IAM role and do not appear in the studio +// membership collection. Only studio admins appear in studio membership. +// +// When you add a user to studio membership with the ADMIN persona, upon logging +// in to the Nimble Studio portal, they are granted permissions specified by the +// Studio's Admin IAM role. type StudioMembership struct { // The ID of the identity store. @@ -1094,8 +1143,9 @@ 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 . +// sessions. +// +// This parameter is only allowed when sessionPersistenceMode is 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_op_CreateLink.go b/service/oam/api_op_CreateLink.go index 0a3469de4a4..c27b862baf9 100644 --- a/service/oam/api_op_CreateLink.go +++ b/service/oam/api_op_CreateLink.go @@ -15,14 +15,21 @@ import ( // monitoring account. After the link is created, data is sent from the source // account to the monitoring account. When you create a link, you can optionally // specify filters that specify which metric namespaces and which log groups are -// shared from the source account to the monitoring account. Before you create a -// link, you must create a sink in the 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. +// shared from the source account to the monitoring account. +// +// Before you create a link, you must create a sink in the 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] and [PutSinkPolicy]. +// +// 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. +// +// [CreateSink]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html +// [PutSinkPolicy]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns ...func(*Options)) (*CreateLinkOutput, error) { if params == nil { params = &CreateLinkInput{} @@ -41,10 +48,14 @@ func (c *Client) CreateLink(ctx context.Context, params *CreateLinkInput, optFns 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: + // 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 // @@ -57,9 +68,13 @@ 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] to find the ARNs + // of sinks. + // + // For more information about sinks, see [CreateSink]. + // + // [CreateSink]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_CreateSink.html + // [ListSinks]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html // // This member is required. SinkIdentifier *string @@ -69,12 +84,15 @@ type CreateLinkInput struct { // monitoring account. LinkConfiguration *types.LinkConfiguration - // Assigns one or more tags (key-value pairs) to the link. 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. 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) - // . + // Assigns one or more tags (key-value pairs) to the link. + // + // 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. + // + // For more information about using tags to control access, see [Controlling access to Amazon Web Services resources using tags]. + // + // [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 24d11d63ebd..e41beb70a47 100644 --- a/service/oam/api_op_CreateSink.go +++ b/service/oam/api_op_CreateSink.go @@ -13,11 +13,15 @@ import ( // Use this to create a sink in the current account, so that it can be used as a // monitoring account in CloudWatch cross-account observability. A sink is a // 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 per Region. If you delete a sink, you can +// 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]. +// +// Each account can contain one sink per Region. If you delete a sink, you can // then create a new one in that Region. +// +// [PutSinkPolicy]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html func (c *Client) CreateSink(ctx context.Context, params *CreateSinkInput, optFns ...func(*Options)) (*CreateSinkOutput, error) { if params == nil { params = &CreateSinkInput{} @@ -40,12 +44,15 @@ type CreateSinkInput struct { // This member is required. Name *string - // Assigns one or more tags (key-value pairs) to the link. 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. 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) - // . + // Assigns one or more tags (key-value pairs) to the link. + // + // 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. + // + // For more information about using tags to control access, see [Controlling access to Amazon Web Services resources using tags]. + // + // [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 4498af3d0c8..9339002e975 100644 --- a/service/oam/api_op_GetLink.go +++ b/service/oam/api_op_GetLink.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Returns complete information about one link. +// +// To use this operation, provide the link ARN. To retrieve a list of link ARNs, +// use [ListLinks]. +// +// [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 9197acecb5a..1344cf55e33 100644 --- a/service/oam/api_op_GetSink.go +++ b/service/oam/api_op_GetSink.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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_ListAttachedLinks.go b/service/oam/api_op_ListAttachedLinks.go index 377969bc7b7..e74b6cd0c2d 100644 --- a/service/oam/api_op_ListAttachedLinks.go +++ b/service/oam/api_op_ListAttachedLinks.go @@ -12,10 +12,15 @@ 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) -// . +// account sink. +// +// To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, +// use [ListSinks]. +// +// To find a list of links for one source account, use [ListLinks]. +// +// [ListLinks]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListLinks.html +// [ListSinks]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.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 3bb4426f095..5028f3e7100 100644 --- a/service/oam/api_op_ListLinks.go +++ b/service/oam/api_op_ListLinks.go @@ -12,9 +12,12 @@ 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) -// from within the monitoring account. +// account sinks that this source account has. +// +// To find a list of links for one monitoring account sink, use [ListAttachedLinks] from within the +// monitoring account. +// +// [ListAttachedLinks]: https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListAttachedLinks.html func (c *Client) ListLinks(ctx context.Context, params *ListLinksInput, optFns ...func(*Options)) (*ListLinksOutput, error) { if params == nil { params = &ListLinksInput{} diff --git a/service/oam/api_op_ListTagsForResource.go b/service/oam/api_op_ListTagsForResource.go index 7088eb94737..90eccbb0225 100644 --- a/service/oam/api_op_ListTagsForResource.go +++ b/service/oam/api_op_ListTagsForResource.go @@ -29,15 +29,21 @@ 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 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]. + // + // 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. // + // [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_PutSinkPolicy.go b/service/oam/api_op_PutSinkPolicy.go index b91a9943949..3dab81ff651 100644 --- a/service/oam/api_op_PutSinkPolicy.go +++ b/service/oam/api_op_PutSinkPolicy.go @@ -13,11 +13,17 @@ import ( // Creates or updates the resource policy that grants permissions to source // accounts to link to the monitoring account sink. When you create a sink policy, // 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: +// 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 +// // - Application Insights - Applications - Specify with // AWS::ApplicationInsights::Application // @@ -41,9 +47,13 @@ func (c *Client) PutSinkPolicy(ctx context.Context, params *PutSinkPolicyInput, type PutSinkPolicyInput struct { // The JSON policy to use. If you are updating an existing policy, the entire - // existing policy is replaced by what you specify here. The policy must be in JSON - // string format with quotation marks escaped and no newlines. For examples of - // different types of policies, see the Examples section on this page. + // existing policy is replaced by what you specify here. + // + // The policy must be in JSON string format with quotation marks escaped and no + // newlines. + // + // For examples of different types of policies, see the Examples section on this + // page. // // This member is required. Policy *string diff --git a/service/oam/api_op_TagResource.go b/service/oam/api_op_TagResource.go index d1e61bfb23e..5db02c0ee7d 100644 --- a/service/oam/api_op_TagResource.go +++ b/service/oam/api_op_TagResource.go @@ -11,19 +11,26 @@ import ( ) // 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 -// strictly as strings of characters. You can use the TagResource action with a -// resource that already has tags. If you specify a new tag key for the alarm, this -// tag is appended to the list of tags associated with the alarm. If you specify a -// tag key that is already associated with the alarm, 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. 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:ResourceTag permission does not allow you to tag and untag -// links and sinks. +// 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 +// strictly as strings of characters. +// +// You can use the TagResource action with a resource that already has tags. If +// you specify a new tag key for the alarm, this tag is appended to the list of +// tags associated with the alarm. If you specify a tag key that is already +// associated with the alarm, 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. +// +// 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:ResourceTag permission does not allow you to tag and untag links and sinks. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -41,11 +48,15 @@ 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) - // . + // 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]. + // + // [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 f0fa43b92b7..4c30249d47b 100644 --- a/service/oam/api_op_UntagResource.go +++ b/service/oam/api_op_UntagResource.go @@ -10,10 +10,11 @@ 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 +32,15 @@ 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]. + // + // [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 63376dca7d0..1a5fe695aad 100644 --- a/service/oam/api_op_UpdateLink.go +++ b/service/oam/api_op_UpdateLink.go @@ -13,11 +13,15 @@ import ( // 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. When you update a link, you -// can optionally specify filters that specify which metric namespaces and which -// log groups are shared from the source account to the monitoring account. To -// update the list of tags associated with the sink, use TagResource (https://docs.aws.amazon.com/OAM/latest/APIReference/API_TagResource.html) -// . +// change the monitoring account with this operation. +// +// When you update a link, you can optionally specify filters that specify which +// metric namespaces and which log groups are shared from the source account to the +// monitoring account. +// +// To update the list of tags associated with the sink, use [TagResource]. +// +// [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{} @@ -41,8 +45,9 @@ type UpdateLinkInput struct { 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. + // 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/doc.go b/service/oam/doc.go index acb07929824..a15cbf85d19 100644 --- a/service/oam/doc.go +++ b/service/oam/doc.go @@ -9,13 +9,15 @@ // can monitor and troubleshoot applications that span multiple accounts within a // Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, // and Application Insights applications in any of the linked accounts without -// account boundaries. Set up one or more Amazon Web Services accounts as -// monitoring accounts and link them with multiple source accounts. A monitoring -// account is a central Amazon Web Services account that can view and interact with -// observability data generated from source accounts. A source account is an -// individual Amazon Web Services account that generates observability data for the -// resources that reside in it. Source accounts share their observability data with -// the monitoring account. The shared observability data can include metrics in -// Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and -// applications in Amazon CloudWatch Application Insights. +// account boundaries. +// +// Set up one or more Amazon Web Services accounts as monitoring accounts and link +// them with multiple source accounts. A monitoring account is a central Amazon Web +// Services account that can view and interact with observability data generated +// from source accounts. A source account is an individual Amazon Web Services +// account that generates observability data for the resources that reside in it. +// Source accounts share their observability data with the monitoring account. The +// shared observability data can include metrics in Amazon CloudWatch, logs in +// Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch +// Application Insights. package oam diff --git a/service/oam/options.go b/service/oam/options.go index 24180adaa4e..40eb34fd851 100644 --- a/service/oam/options.go +++ b/service/oam/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/oam/types/enums.go b/service/oam/types/enums.go index d1a8aa8edaf..7063b2fa163 100644 --- a/service/oam/types/enums.go +++ b/service/oam/types/enums.go @@ -14,8 +14,9 @@ const ( ) // 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. +// expanded in the future, and so 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 3f68fd67eb9..4670a23fd6f 100644 --- a/service/oam/types/types.go +++ b/service/oam/types/types.go @@ -88,20 +88,30 @@ type LogGroupConfiguration struct { // following operands. Use single quotation marks (') around log group names. The // matching of log group names is case sensitive. Each filter has a limit of five // conditional operands. Conditional operands are AND and OR . + // // - = and != + // // - AND + // // - OR + // // - LIKE and NOT LIKE . These can be used only as prefix searches. Include a % // at the end of the string that you want to search for and include. + // // - IN and NOT IN , using parentheses ( ) + // // Examples: + // // - LogGroupName IN ('This-Log-Group', 'Other-Log-Group') includes only the log // groups with names This-Log-Group and Other-Log-Group . + // // - LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') includes // all log groups except the log groups with names Private-Log-Group and // Private-Log-Group-2 . + // // - LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' includes // all log groups that have names that start with aws/lambda/ or AWSLogs . + // // If you are updating a link that uses filters, you can specify * as the only // value for the filter parameter to delete the filter and share all log groups // with the monitoring account. @@ -122,19 +132,29 @@ type MetricConfiguration struct { // single quotation marks (') around namespace names. The matching of namespace // names is case sensitive. Each filter has a limit of five conditional operands. // Conditional operands are AND and OR . + // // - = and != + // // - AND + // // - OR + // // - LIKE and NOT LIKE . These can be used only as prefix searches. Include a % // at the end of the string that you want to search for and include. + // // - IN and NOT IN , using parentheses ( ) + // // Examples: + // // - Namespace NOT LIKE 'AWS/%' includes only namespaces that don't start with // AWS/ , such as custom namespaces. + // // - Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') includes only the metrics in // the EC2, Elastic Load Balancing, and Amazon S3 namespaces. + // // - Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' includes only the EC2 // namespace and your custom namespaces. + // // If you are updating a link that uses filters, you can specify * as the only // value for the filter parameter to delete the filter and share all metric // namespaces with the monitoring account. diff --git a/service/omics/api_op_CreateAnnotationStore.go b/service/omics/api_op_CreateAnnotationStore.go index 724a537147d..c13d2cff644 100644 --- a/service/omics/api_op_CreateAnnotationStore.go +++ b/service/omics/api_op_CreateAnnotationStore.go @@ -53,7 +53,7 @@ type CreateAnnotationStoreInput struct { // Tags for the store. Tags map[string]string - // The name given to an annotation store version to distinguish it from other + // The name given to an annotation store version to distinguish it from other // versions. VersionName *string @@ -82,7 +82,7 @@ type CreateAnnotationStoreOutput struct { // This member is required. Status types.StoreStatus - // The name given to an annotation store version to distinguish it from other + // The name given to an annotation store version to distinguish it from other // versions. // // This member is required. diff --git a/service/omics/api_op_CreateAnnotationStoreVersion.go b/service/omics/api_op_CreateAnnotationStoreVersion.go index 292aa4ffeaa..8edf3966a87 100644 --- a/service/omics/api_op_CreateAnnotationStoreVersion.go +++ b/service/omics/api_op_CreateAnnotationStoreVersion.go @@ -30,24 +30,24 @@ func (c *Client) CreateAnnotationStoreVersion(ctx context.Context, params *Creat type CreateAnnotationStoreVersionInput struct { - // The name of an annotation store version from which versions are being created. + // The name of an annotation store version from which versions are being created. // // This member is required. Name *string - // The name given to an annotation store version to distinguish it from other + // The name given to an annotation store version to distinguish it from other // versions. // // This member is required. VersionName *string - // The description of an annotation store version. + // The description of an annotation store version. Description *string - // Any tags added to annotation store version. + // Any tags added to annotation store version. Tags map[string]string - // The options for an annotation store version. + // The options for an annotation store version. VersionOptions types.VersionOptions noSmithyDocumentSerde @@ -55,39 +55,39 @@ type CreateAnnotationStoreVersionInput struct { type CreateAnnotationStoreVersionOutput struct { - // The time stamp for the creation of an annotation store version. + // The time stamp for the creation of an annotation store version. // // This member is required. CreationTime *time.Time - // A generated ID for the annotation store + // A generated ID for the annotation store // // This member is required. Id *string - // The name given to an annotation store version to distinguish it from other + // The name given to an annotation store version to distinguish it from other // versions. // // This member is required. Name *string - // The status of a annotation store version. + // The status of a annotation store version. // // This member is required. Status types.VersionStatus - // The ID for the annotation store from which new versions are being created. + // The ID for the annotation store from which new versions are being created. // // This member is required. StoreId *string - // The name given to an annotation store version to distinguish it from other + // The name given to an annotation store version to distinguish it from other // versions. // // This member is required. VersionName *string - // The options for an annotation store version. + // The options for an annotation store version. VersionOptions types.VersionOptions // Metadata pertaining to the operation's result. diff --git a/service/omics/api_op_CreateShare.go b/service/omics/api_op_CreateShare.go index c25718e52e0..f72de0bda08 100644 --- a/service/omics/api_op_CreateShare.go +++ b/service/omics/api_op_CreateShare.go @@ -13,10 +13,14 @@ import ( // Creates a cross-account shared resource. The resource owner makes an offer to // share the resource with the principal subscriber (an AWS user with a different -// account than the resource owner). The following resources support cross-account -// sharing: +// account than the resource owner). +// +// The following resources support cross-account sharing: +// // - Healthomics variant stores +// // - Healthomics annotation stores +// // - Private workflows func (c *Client) CreateShare(ctx context.Context, params *CreateShareInput, optFns ...func(*Options)) (*CreateShareOutput, error) { if params == nil { diff --git a/service/omics/api_op_DeleteAnnotationStoreVersions.go b/service/omics/api_op_DeleteAnnotationStoreVersions.go index 3153f9e7e0d..4f58d362fec 100644 --- a/service/omics/api_op_DeleteAnnotationStoreVersions.go +++ b/service/omics/api_op_DeleteAnnotationStoreVersions.go @@ -29,17 +29,17 @@ func (c *Client) DeleteAnnotationStoreVersions(ctx context.Context, params *Dele type DeleteAnnotationStoreVersionsInput struct { - // The name of the annotation store from which versions are being deleted. + // The name of the annotation store from which versions are being deleted. // // This member is required. Name *string - // The versions of an annotation store to be deleted. + // The versions of an annotation store to be deleted. // // This member is required. Versions []string - // Forces the deletion of an annotation store version when imports are + // Forces the deletion of an annotation store version when imports are // in-progress.. Force bool @@ -48,7 +48,7 @@ type DeleteAnnotationStoreVersionsInput struct { type DeleteAnnotationStoreVersionsOutput struct { - // Any errors that occur when attempting to delete an annotation store version. + // Any errors that occur when attempting to delete an annotation store version. Errors []types.VersionDeleteError // Metadata pertaining to the operation's result. diff --git a/service/omics/api_op_GetAnnotationImportJob.go b/service/omics/api_op_GetAnnotationImportJob.go index d9d35a07b9e..16db7f11651 100644 --- a/service/omics/api_op_GetAnnotationImportJob.go +++ b/service/omics/api_op_GetAnnotationImportJob.go @@ -98,7 +98,7 @@ type GetAnnotationImportJobOutput struct { // This member is required. UpdateTime *time.Time - // The name of the annotation store version. + // The name of the annotation store version. // // This member is required. VersionName *string @@ -263,12 +263,13 @@ type AnnotationImportJobCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetAnnotationImportJobInput, *GetAnnotationImportJobOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetAnnotationStore.go b/service/omics/api_op_GetAnnotationStore.go index 8945b5bcd5d..4906bb555b6 100644 --- a/service/omics/api_op_GetAnnotationStore.go +++ b/service/omics/api_op_GetAnnotationStore.go @@ -64,7 +64,7 @@ type GetAnnotationStoreOutput struct { // This member is required. Name *string - // An integer indicating how many versions of an annotation store exist. + // An integer indicating how many versions of an annotation store exist. // // This member is required. NumVersions *int32 @@ -272,12 +272,13 @@ type AnnotationStoreCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetAnnotationStoreInput, *GetAnnotationStoreOutput, error) (bool, error) } @@ -497,12 +498,13 @@ type AnnotationStoreDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetAnnotationStoreInput, *GetAnnotationStoreOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetAnnotationStoreVersion.go b/service/omics/api_op_GetAnnotationStoreVersion.go index 8da6b52bea2..b9ea107932b 100644 --- a/service/omics/api_op_GetAnnotationStoreVersion.go +++ b/service/omics/api_op_GetAnnotationStoreVersion.go @@ -34,12 +34,12 @@ func (c *Client) GetAnnotationStoreVersion(ctx context.Context, params *GetAnnot type GetAnnotationStoreVersionInput struct { - // The name given to an annotation store version to distinguish it from others. + // The name given to an annotation store version to distinguish it from others. // // This member is required. Name *string - // The name given to an annotation store version to distinguish it from others. + // The name given to an annotation store version to distinguish it from others. // // This member is required. VersionName *string @@ -49,67 +49,67 @@ type GetAnnotationStoreVersionInput struct { type GetAnnotationStoreVersionOutput struct { - // The time stamp for when an annotation store version was created. + // The time stamp for when an annotation store version was created. // // This member is required. CreationTime *time.Time - // The description for an annotation store version. + // The description for an annotation store version. // // This member is required. Description *string - // The annotation store version ID. + // The annotation store version ID. // // This member is required. Id *string - // The name of the annotation store. + // The name of the annotation store. // // This member is required. Name *string - // The status of an annotation store version. + // The status of an annotation store version. // // This member is required. Status types.VersionStatus - // The status of an annotation store version. + // The status of an annotation store version. // // This member is required. StatusMessage *string - // The store ID for annotation store version. + // The store ID for annotation store version. // // This member is required. StoreId *string - // Any tags associated with an annotation store version. + // Any tags associated with an annotation store version. // // This member is required. Tags map[string]string - // The time stamp for when an annotation store version was updated. + // The time stamp for when an annotation store version was updated. // // This member is required. UpdateTime *time.Time - // The Arn for the annotation store. + // The Arn for the annotation store. // // This member is required. VersionArn *string - // The name given to an annotation store version to distinguish it from others. + // The name given to an annotation store version to distinguish it from others. // // This member is required. VersionName *string - // The size of the annotation store version in Bytes. + // The size of the annotation store version in Bytes. // // This member is required. VersionSizeBytes *int64 - // The options for an annotation store version. + // The options for an annotation store version. VersionOptions types.VersionOptions // Metadata pertaining to the operation's result. @@ -270,12 +270,13 @@ type AnnotationStoreVersionCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetAnnotationStoreVersionInput, *GetAnnotationStoreVersionOutput, error) (bool, error) } @@ -498,12 +499,13 @@ type AnnotationStoreVersionDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetAnnotationStoreVersionInput, *GetAnnotationStoreVersionOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetReadSetActivationJob.go b/service/omics/api_op_GetReadSetActivationJob.go index 8ffbcad75d6..cc24bce75ba 100644 --- a/service/omics/api_op_GetReadSetActivationJob.go +++ b/service/omics/api_op_GetReadSetActivationJob.go @@ -235,12 +235,13 @@ type ReadSetActivationJobCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReadSetActivationJobInput, *GetReadSetActivationJobOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetReadSetExportJob.go b/service/omics/api_op_GetReadSetExportJob.go index f552c185563..f36dc2b60c8 100644 --- a/service/omics/api_op_GetReadSetExportJob.go +++ b/service/omics/api_op_GetReadSetExportJob.go @@ -239,12 +239,13 @@ type ReadSetExportJobCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReadSetExportJobInput, *GetReadSetExportJobOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetReadSetImportJob.go b/service/omics/api_op_GetReadSetImportJob.go index 1cbc497ee51..b49a8e1543d 100644 --- a/service/omics/api_op_GetReadSetImportJob.go +++ b/service/omics/api_op_GetReadSetImportJob.go @@ -241,12 +241,13 @@ type ReadSetImportJobCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReadSetImportJobInput, *GetReadSetImportJobOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetReadSetMetadata.go b/service/omics/api_op_GetReadSetMetadata.go index 72596f1a34e..181ea1f6b03 100644 --- a/service/omics/api_op_GetReadSetMetadata.go +++ b/service/omics/api_op_GetReadSetMetadata.go @@ -75,7 +75,7 @@ type GetReadSetMetadataOutput struct { // This member is required. Status types.ReadSetStatus - // The creation type of the read set. + // The creation type of the read set. CreationType types.CreationType // The read set's description. diff --git a/service/omics/api_op_GetReferenceImportJob.go b/service/omics/api_op_GetReferenceImportJob.go index 90bc5e74309..f4161fb7bc1 100644 --- a/service/omics/api_op_GetReferenceImportJob.go +++ b/service/omics/api_op_GetReferenceImportJob.go @@ -241,12 +241,13 @@ type ReferenceImportJobCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReferenceImportJobInput, *GetReferenceImportJobOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetRun.go b/service/omics/api_op_GetRun.go index abf5c43cfaa..c34ba07ab6a 100644 --- a/service/omics/api_op_GetRun.go +++ b/service/omics/api_op_GetRun.go @@ -16,8 +16,9 @@ import ( "time" ) -// Gets information about a workflow run. If a workflow is shared with you, you -// cannot export information about the run. +// Gets information about a workflow run. +// +// If a workflow is shared with you, you cannot export information about the run. func (c *Client) GetRun(ctx context.Context, params *GetRunInput, optFns ...func(*Options)) (*GetRunOutput, error) { if params == nil { params = &GetRunInput{} @@ -296,12 +297,13 @@ type RunRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetRunInput, *GetRunOutput, error) (bool, error) } @@ -535,12 +537,13 @@ type RunCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetRunInput, *GetRunOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetRunTask.go b/service/omics/api_op_GetRunTask.go index 758ee28849c..b0c70f99a17 100644 --- a/service/omics/api_op_GetRunTask.go +++ b/service/omics/api_op_GetRunTask.go @@ -241,12 +241,13 @@ type TaskRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetRunTaskInput, *GetRunTaskOutput, error) (bool, error) } @@ -480,12 +481,13 @@ type TaskCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetRunTaskInput, *GetRunTaskOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetVariantImportJob.go b/service/omics/api_op_GetVariantImportJob.go index 891c2ff5ea6..f4559045f06 100644 --- a/service/omics/api_op_GetVariantImportJob.go +++ b/service/omics/api_op_GetVariantImportJob.go @@ -251,12 +251,13 @@ type VariantImportJobCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetVariantImportJobInput, *GetVariantImportJobOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetVariantStore.go b/service/omics/api_op_GetVariantStore.go index 06b3658ccc3..7dac14e6acb 100644 --- a/service/omics/api_op_GetVariantStore.go +++ b/service/omics/api_op_GetVariantStore.go @@ -261,12 +261,13 @@ type VariantStoreCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetVariantStoreInput, *GetVariantStoreOutput, error) (bool, error) } @@ -486,12 +487,13 @@ type VariantStoreDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetVariantStoreInput, *GetVariantStoreOutput, error) (bool, error) } diff --git a/service/omics/api_op_GetWorkflow.go b/service/omics/api_op_GetWorkflow.go index 13d0ebf2377..43d7bc5175f 100644 --- a/service/omics/api_op_GetWorkflow.go +++ b/service/omics/api_op_GetWorkflow.go @@ -15,8 +15,9 @@ import ( "time" ) -// Gets information about a workflow. If a workflow is shared with you, you cannot -// export the workflow. +// Gets information about a workflow. +// +// If a workflow is shared with you, you cannot export the workflow. func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optFns ...func(*Options)) (*GetWorkflowOutput, error) { if params == nil { params = &GetWorkflowInput{} @@ -258,12 +259,13 @@ type WorkflowActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetWorkflowInput, *GetWorkflowOutput, error) (bool, error) } diff --git a/service/omics/api_op_ListAnnotationStoreVersions.go b/service/omics/api_op_ListAnnotationStoreVersions.go index d428cbed0e6..8084ab055ab 100644 --- a/service/omics/api_op_ListAnnotationStoreVersions.go +++ b/service/omics/api_op_ListAnnotationStoreVersions.go @@ -29,19 +29,19 @@ func (c *Client) ListAnnotationStoreVersions(ctx context.Context, params *ListAn type ListAnnotationStoreVersionsInput struct { - // The name of an annotation store. + // The name of an annotation store. // // This member is required. Name *string - // A filter to apply to the list of annotation store versions. + // A filter to apply to the list of annotation store versions. Filter *types.ListAnnotationStoreVersionsFilter - // The maximum number of annotation store versions to return in one page of + // The maximum number of annotation store versions to return in one page of // results. MaxResults *int32 - // Specifies the pagination token from a previous request to retrieve the next + // Specifies the pagination token from a previous request to retrieve the next // page of results. NextToken *string @@ -50,10 +50,10 @@ type ListAnnotationStoreVersionsInput struct { type ListAnnotationStoreVersionsOutput struct { - // Lists all versions of an annotation store. + // Lists all versions of an annotation store. AnnotationStoreVersions []types.AnnotationStoreVersionItem - // Specifies the pagination token from a previous request to retrieve the next + // Specifies the pagination token from a previous request to retrieve the next // page of results. NextToken *string @@ -183,7 +183,7 @@ var _ ListAnnotationStoreVersionsAPIClient = (*Client)(nil) // ListAnnotationStoreVersionsPaginatorOptions is the paginator options for // ListAnnotationStoreVersions type ListAnnotationStoreVersionsPaginatorOptions struct { - // The maximum number of annotation store versions to return in one page of + // The maximum number of annotation store versions to return in one page of // results. Limit int32 diff --git a/service/omics/api_op_ListShares.go b/service/omics/api_op_ListShares.go index 243d6d36a54..d9f87750005 100644 --- a/service/omics/api_op_ListShares.go +++ b/service/omics/api_op_ListShares.go @@ -55,8 +55,8 @@ type ListSharesOutput struct { // This member is required. Shares []types.ShareDetails - // Next token returned in the response of a previous ListSharesResponse call. Used - // to get the next page of results. + // Next token returned in the response of a previous ListSharesResponse call. + // Used to get the next page of results. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/omics/api_op_StartAnnotationImportJob.go b/service/omics/api_op_StartAnnotationImportJob.go index cfd70e3d410..48272bca17a 100644 --- a/service/omics/api_op_StartAnnotationImportJob.go +++ b/service/omics/api_op_StartAnnotationImportJob.go @@ -53,7 +53,7 @@ type StartAnnotationImportJobInput struct { // The job's left normalization setting. RunLeftNormalization bool - // The name of the annotation store version. + // The name of the annotation store version. VersionName *string noSmithyDocumentSerde diff --git a/service/omics/api_op_StartRun.go b/service/omics/api_op_StartRun.go index 6a8d92b9201..1ca49c63b30 100644 --- a/service/omics/api_op_StartRun.go +++ b/service/omics/api_op_StartRun.go @@ -13,16 +13,22 @@ import ( ) // Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. -// The remaining parameters are copied from the previous run. StartRun will not -// support re-run for a workflow that is shared with you. The total number of runs -// in your account is subject to a quota per Region. To avoid needing to delete -// runs manually, you can set the retention mode to REMOVE . Runs with this setting -// are deleted automatically when the run quoata is exceeded. By default, the run -// uses STATIC storage. For STATIC storage, set the storageCapacity field. You can -// set the storage type to DYNAMIC. You do not set storageCapacity , because -// HealthOmics dynamically scales the storage up or down as required. For more -// information about static and dynamic storage, see Running workflows (https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html) -// in the AWS HealthOmics User Guide. +// The remaining parameters are copied from the previous run. +// +// StartRun will not support re-run for a workflow that is shared with you. +// +// The total number of runs in your account is subject to a quota per Region. To +// avoid needing to delete runs manually, you can set the retention mode to REMOVE +// . Runs with this setting are deleted automatically when the run quoata is +// exceeded. +// +// By default, the run uses STATIC storage. For STATIC storage, set the +// storageCapacity field. You can set the storage type to DYNAMIC. You do not set +// storageCapacity , because HealthOmics dynamically scales the storage up or down +// as required. For more information about static and dynamic storage, see [Running workflows]in the +// AWS HealthOmics User Guide. +// +// [Running workflows]: https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html func (c *Client) StartRun(ctx context.Context, params *StartRunInput, optFns ...func(*Options)) (*StartRunOutput, error) { if params == nil { params = &StartRunInput{} diff --git a/service/omics/api_op_UpdateAnnotationStoreVersion.go b/service/omics/api_op_UpdateAnnotationStoreVersion.go index 503f7805e03..93fca9a5c52 100644 --- a/service/omics/api_op_UpdateAnnotationStoreVersion.go +++ b/service/omics/api_op_UpdateAnnotationStoreVersion.go @@ -30,17 +30,17 @@ func (c *Client) UpdateAnnotationStoreVersion(ctx context.Context, params *Updat type UpdateAnnotationStoreVersionInput struct { - // The name of an annotation store. + // The name of an annotation store. // // This member is required. Name *string - // The name of an annotation store version. + // The name of an annotation store version. // // This member is required. VersionName *string - // The description of an annotation store. + // The description of an annotation store. Description *string noSmithyDocumentSerde @@ -48,42 +48,42 @@ type UpdateAnnotationStoreVersionInput struct { type UpdateAnnotationStoreVersionOutput struct { - // The time stamp for when an annotation store version was created. + // The time stamp for when an annotation store version was created. // // This member is required. CreationTime *time.Time - // The description of an annotation store version. + // The description of an annotation store version. // // This member is required. Description *string - // The annotation store version ID. + // The annotation store version ID. // // This member is required. Id *string - // The name of an annotation store. + // The name of an annotation store. // // This member is required. Name *string - // The status of an annotation store version. + // The status of an annotation store version. // // This member is required. Status types.VersionStatus - // The annotation store ID. + // The annotation store ID. // // This member is required. StoreId *string - // The time stamp for when an annotation store version was updated. + // The time stamp for when an annotation store version was updated. // // This member is required. UpdateTime *time.Time - // The name of an annotation store version. + // The name of an annotation store version. // // This member is required. VersionName *string diff --git a/service/omics/doc.go b/service/omics/doc.go index 80e40cf482a..401b1df8cd0 100644 --- a/service/omics/doc.go +++ b/service/omics/doc.go @@ -4,6 +4,7 @@ // Amazon Omics. // // This is the AWS HealthOmics API Reference. For an introduction to the service, -// see What is AWS HealthOmics? (https://docs.aws.amazon.com/omics/latest/dev/) in -// the AWS HealthOmics User Guide. +// see [What is AWS HealthOmics?]in the AWS HealthOmics User Guide. +// +// [What is AWS HealthOmics?]: https://docs.aws.amazon.com/omics/latest/dev/ package omics diff --git a/service/omics/options.go b/service/omics/options.go index 2f58759c3b9..7566e06a564 100644 --- a/service/omics/options.go +++ b/service/omics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/omics/types/enums.go b/service/omics/types/enums.go index 9af12f2e8df..acb3dde6711 100644 --- a/service/omics/types/enums.go +++ b/service/omics/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for Accelerators. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Accelerators) Values() []Accelerators { return []Accelerators{ "GPU", @@ -41,8 +42,9 @@ const ( ) // Values returns all known values for AnnotationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnnotationType) Values() []AnnotationType { return []AnnotationType{ "GENERIC", @@ -64,8 +66,9 @@ const ( ) // Values returns all known values for CreationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreationType) Values() []CreationType { return []CreationType{ "IMPORT", @@ -82,8 +85,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "KMS", @@ -106,8 +110,9 @@ const ( ) // Values returns all known values for ETagAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ETagAlgorithm) Values() []ETagAlgorithm { return []ETagAlgorithm{ "FASTQ_MD5up", @@ -132,8 +137,9 @@ const ( ) // Values returns all known values for ETagAlgorithmFamily. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ETagAlgorithmFamily) Values() []ETagAlgorithmFamily { return []ETagAlgorithmFamily{ "MD5up", @@ -153,8 +159,9 @@ const ( ) // Values returns all known values for FileType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileType) Values() []FileType { return []FileType{ "FASTQ", @@ -177,8 +184,9 @@ const ( ) // Values returns all known values for FormatToHeaderKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FormatToHeaderKey) Values() []FormatToHeaderKey { return []FormatToHeaderKey{ "CHR", @@ -209,8 +217,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -234,8 +243,9 @@ const ( // Values returns all known values for ReadSetActivationJobItemStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetActivationJobItemStatus) Values() []ReadSetActivationJobItemStatus { return []ReadSetActivationJobItemStatus{ "NOT_STARTED", @@ -260,6 +270,7 @@ const ( // Values returns all known values for ReadSetActivationJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetActivationJobStatus) Values() []ReadSetActivationJobStatus { return []ReadSetActivationJobStatus{ @@ -285,6 +296,7 @@ const ( // Values returns all known values for ReadSetExportJobItemStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetExportJobItemStatus) Values() []ReadSetExportJobItemStatus { return []ReadSetExportJobItemStatus{ @@ -309,8 +321,9 @@ const ( ) // Values returns all known values for ReadSetExportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetExportJobStatus) Values() []ReadSetExportJobStatus { return []ReadSetExportJobStatus{ "SUBMITTED", @@ -333,8 +346,9 @@ const ( ) // Values returns all known values for ReadSetFile. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetFile) Values() []ReadSetFile { return []ReadSetFile{ "SOURCE1", @@ -355,6 +369,7 @@ const ( // Values returns all known values for ReadSetImportJobItemStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetImportJobItemStatus) Values() []ReadSetImportJobItemStatus { return []ReadSetImportJobItemStatus{ @@ -379,8 +394,9 @@ const ( ) // Values returns all known values for ReadSetImportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetImportJobStatus) Values() []ReadSetImportJobStatus { return []ReadSetImportJobStatus{ "SUBMITTED", @@ -402,8 +418,9 @@ const ( ) // Values returns all known values for ReadSetPartSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetPartSource) Values() []ReadSetPartSource { return []ReadSetPartSource{ "SOURCE1", @@ -425,8 +442,9 @@ const ( ) // Values returns all known values for ReadSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadSetStatus) Values() []ReadSetStatus { return []ReadSetStatus{ "ARCHIVED", @@ -448,8 +466,9 @@ const ( ) // Values returns all known values for ReferenceFile. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceFile) Values() []ReferenceFile { return []ReferenceFile{ "SOURCE", @@ -469,8 +488,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceImportJobItemStatus) Values() []ReferenceImportJobItemStatus { return []ReferenceImportJobItemStatus{ "NOT_STARTED", @@ -495,6 +515,7 @@ const ( // 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{ @@ -518,8 +539,9 @@ const ( ) // Values returns all known values for ReferenceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceStatus) Values() []ReferenceStatus { return []ReferenceStatus{ "ACTIVE", @@ -539,8 +561,9 @@ const ( ) // Values returns all known values for ResourceOwner. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceOwner) Values() []ResourceOwner { return []ResourceOwner{ "SELF", @@ -556,8 +579,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -575,8 +599,9 @@ const ( ) // Values returns all known values for RunLogLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunLogLevel) Values() []RunLogLevel { return []RunLogLevel{ "OFF", @@ -595,8 +620,9 @@ const ( ) // Values returns all known values for RunRetentionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunRetentionMode) Values() []RunRetentionMode { return []RunRetentionMode{ "RETAIN", @@ -619,8 +645,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -653,8 +680,9 @@ const ( ) // Values returns all known values for SchemaValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SchemaValueType) Values() []SchemaValueType { return []SchemaValueType{ "LONG", @@ -679,8 +707,9 @@ const ( ) // Values returns all known values for ShareResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareResourceType) Values() []ShareResourceType { return []ShareResourceType{ "VARIANT_STORE", @@ -708,8 +737,9 @@ const ( ) // Values returns all known values for ShareStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatus) Values() []ShareStatus { return []ShareStatus{ "PENDING", @@ -730,8 +760,9 @@ const ( ) // Values returns all known values for StorageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageType) Values() []StorageType { return []StorageType{ "STATIC", @@ -752,8 +783,9 @@ const ( ) // Values returns all known values for StoreFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StoreFormat) Values() []StoreFormat { return []StoreFormat{ "GFF", @@ -779,8 +811,9 @@ const ( ) // Values returns all known values for StoreStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StoreStatus) Values() []StoreStatus { return []StoreStatus{ "CREATING", @@ -805,8 +838,9 @@ const ( ) // Values returns all known values for TaskStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatus) Values() []TaskStatus { return []TaskStatus{ "PENDING", @@ -836,8 +870,9 @@ const ( ) // Values returns all known values for VersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VersionStatus) Values() []VersionStatus { return []VersionStatus{ "CREATING", @@ -858,8 +893,9 @@ const ( ) // Values returns all known values for WorkflowEngine. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowEngine) Values() []WorkflowEngine { return []WorkflowEngine{ "WDL", @@ -876,8 +912,9 @@ const ( ) // Values returns all known values for WorkflowExport. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowExport) Values() []WorkflowExport { return []WorkflowExport{ "DEFINITION", @@ -897,8 +934,9 @@ const ( ) // Values returns all known values for WorkflowStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStatus) Values() []WorkflowStatus { return []WorkflowStatus{ "CREATING", @@ -919,8 +957,9 @@ const ( ) // 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. +// expanded in the future, and so 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/omics/types/types.go b/service/omics/types/types.go index 35988e4bb15..0504cd73978 100644 --- a/service/omics/types/types.go +++ b/service/omics/types/types.go @@ -130,12 +130,12 @@ type AnnotationImportJobItem struct { // This member is required. UpdateTime *time.Time - // The name of the annotation store version. + // The name of the annotation store version. // // This member is required. VersionName *string - // The annotation schema generated by the parsed annotation data. + // The annotation schema generated by the parsed annotation data. AnnotationFields map[string]string // When the job completed. @@ -216,57 +216,57 @@ type AnnotationStoreItem struct { // Annotation store versions. type AnnotationStoreVersionItem struct { - // The time stamp for when an annotation store version was created. + // The time stamp for when an annotation store version was created. // // This member is required. CreationTime *time.Time - // The description of an annotation store version. + // The description of an annotation store version. // // This member is required. Description *string - // The annotation store version ID. + // The annotation store version ID. // // This member is required. Id *string - // A name given to an annotation store version to distinguish it from others. + // A name given to an annotation store version to distinguish it from others. // // This member is required. Name *string - // The status of an annotation store version. + // The status of an annotation store version. // // This member is required. Status VersionStatus - // The status of an annotation store version. + // The status of an annotation store version. // // This member is required. StatusMessage *string - // The store ID for an annotation store version. + // The store ID for an annotation store version. // // This member is required. StoreId *string - // The time stamp for when an annotation store version was updated. + // The time stamp for when an annotation store version was updated. // // This member is required. UpdateTime *time.Time - // The Arn for an annotation store version. + // The Arn for an annotation store version. // // This member is required. VersionArn *string - // The name of an annotation store version. + // The name of an annotation store version. // // This member is required. VersionName *string - // The size of an annotation store version in Bytes. + // The size of an annotation store version in Bytes. // // This member is required. VersionSizeBytes *int64 @@ -277,18 +277,18 @@ type AnnotationStoreVersionItem struct { // Part of the response to the CompleteReadSetUpload API, including metadata. type CompleteReadSetUploadPartListItem struct { - // A unique identifier used to confirm that parts are being added to the correct + // A unique identifier used to confirm that parts are being added to the correct // upload. // // This member is required. Checksum *string - // A number identifying the part in a read set upload. + // A number identifying the part in a read set upload. // // This member is required. PartNumber *int32 - // The source file of the part being uploaded. + // The source file of the part being uploaded. // // This member is required. PartSource ReadSetPartSource @@ -679,57 +679,58 @@ type ListVariantStoresFilter struct { noSmithyDocumentSerde } -// Part of the response to ListMultipartReadSetUploads, excluding completed and +// Part of the response to ListMultipartReadSetUploads, excluding completed and +// // aborted multipart uploads. type MultipartReadSetUploadListItem struct { - // The time stamp for when a direct upload was created. + // The time stamp for when a direct upload was created. // // This member is required. CreationTime *time.Time - // The source of an uploaded part. + // The source of an uploaded part. // // This member is required. GeneratedFrom *string - // The source's reference ARN. + // The source's reference ARN. // // This member is required. ReferenceArn *string - // The read set source's sample ID. + // The read set source's sample ID. // // This member is required. SampleId *string - // The sequence store ID used for the multipart upload. + // The sequence store ID used for the multipart upload. // // This member is required. SequenceStoreId *string - // The type of file the read set originated from. + // The type of file the read set originated from. // // This member is required. SourceFileType FileType - // The read set source's subject ID. + // The read set source's subject ID. // // This member is required. SubjectId *string - // The ID for the initiated multipart upload. + // The ID for the initiated multipart upload. // // This member is required. UploadId *string - // The description of a read set. + // The description of a read set. Description *string - // The name of a read set. + // The name of a read set. Name *string - // Any tags you wish to add to a read set. + // Any tags you wish to add to a read set. Tags map[string]string noSmithyDocumentSerde @@ -813,10 +814,10 @@ type ReadSetFilter struct { // The filter's end date. CreatedBefore *time.Time - // The creation type of the read set. + // The creation type of the read set. CreationType CreationType - // Where the source originated. + // Where the source originated. GeneratedFrom *string // A name to filter on. @@ -825,13 +826,13 @@ type ReadSetFilter struct { // A genome reference ARN to filter on. ReferenceArn *string - // The read set source's sample ID. + // The read set source's sample ID. SampleId *string // A status to filter on. Status ReadSetStatus - // The read set source's subject ID. + // The read set source's subject ID. SubjectId *string noSmithyDocumentSerde @@ -870,7 +871,7 @@ type ReadSetListItem struct { // This member is required. Status ReadSetStatus - // The creation type of the read set. + // The creation type of the read set. CreationType CreationType // The read set's description. @@ -891,8 +892,8 @@ type ReadSetListItem struct { // Details about a sequence. SequenceInformation *SequenceInformation - // The status for a read set. It provides more detail as to why the read set has a - // status. + // The status for a read set. It provides more detail as to why the read set has + // a status. StatusMessage *string // The read set's subject ID. @@ -913,45 +914,46 @@ type ReadSetS3Access struct { // Filter settings that select for read set upload parts of interest. type ReadSetUploadPartListFilter struct { - // Filters for read set uploads after a specified time. + // Filters for read set uploads after a specified time. CreatedAfter *time.Time - // Filters for read set part uploads before a specified time. + // Filters for read set part uploads before a specified time. CreatedBefore *time.Time noSmithyDocumentSerde } -// The metadata of a single part of a file that was added to a multipart upload. A -// list of these parts is returned in the response to the ListReadSetUploadParts +// The metadata of a single part of a file that was added to a multipart upload. +// +// A list of these parts is returned in the response to the ListReadSetUploadParts // API. type ReadSetUploadPartListItem struct { - // A unique identifier used to confirm that parts are being added to the correct + // A unique identifier used to confirm that parts are being added to the correct // upload. // // This member is required. Checksum *string - // The number identifying the part in an upload. + // The number identifying the part in an upload. // // This member is required. PartNumber *int32 - // The size of the the part in an upload. + // The size of the the part in an upload. // // This member is required. PartSize *int64 - // The origin of the part being direct uploaded. + // The origin of the part being direct uploaded. // // This member is required. PartSource ReadSetPartSource - // The time stamp for when a direct upload was created. + // The time stamp for when a direct upload was created. CreationTime *time.Time - // The time stamp for the most recent update to an uploaded part. + // The time stamp for the most recent update to an uploaded part. LastUpdatedTime *time.Time noSmithyDocumentSerde @@ -1113,7 +1115,7 @@ type RunGroupListItem struct { // The group's maximum duration setting in minutes. MaxDuration *int32 - // The maximum GPUs that can be used by a run group. + // The maximum GPUs that can be used by a run group. MaxGpus *int32 // The group's maximum concurrent run setting. @@ -1219,7 +1221,7 @@ type SequenceStoreDetail struct { // The algorithm family of the ETag. ETagAlgorithmFamily ETagAlgorithmFamily - // An S3 location that is used to store files that have failed a direct upload. + // An S3 location that is used to store files that have failed a direct upload. FallbackLocation *string // The store's name. @@ -1424,10 +1426,10 @@ type TaskListItem struct { // When the task was created. CreationTime *time.Time - // The number of Graphics Processing Units (GPU) specified for the task. + // The number of Graphics Processing Units (GPU) specified for the task. Gpus *int32 - // The instance type for a task. + // The instance type for a task. InstanceType *string // The task's memory use in gigabyes. @@ -1478,13 +1480,13 @@ type TsvStoreOptions struct { // The options for a TSV file. type TsvVersionOptions struct { - // The store version's annotation type. + // The store version's annotation type. AnnotationType AnnotationType - // The annotation store version's header key to column name mapping. + // The annotation store version's header key to column name mapping. FormatToHeader map[string]string - // The TSV schema for an annotation store version. + // The TSV schema for an annotation store version. Schema []map[string]SchemaValueType noSmithyDocumentSerde @@ -1503,7 +1505,7 @@ type VariantImportItemDetail struct { // This member is required. Source *string - // A message that provides additional context about a job + // A message that provides additional context about a job StatusMessage *string noSmithyDocumentSerde @@ -1553,7 +1555,7 @@ type VariantImportJobItem struct { // This member is required. UpdateTime *time.Time - // The annotation schema generated by the parsed annotation data. + // The annotation schema generated by the parsed annotation data. AnnotationFields map[string]string // When the job completed. @@ -1641,12 +1643,12 @@ type VcfOptions struct { // The error preventing deletion of the annotation store version. type VersionDeleteError struct { - // The message explaining the error in annotation store deletion. + // The message explaining the error in annotation store deletion. // // This member is required. Message *string - // The name given to an annotation store version. + // The name given to an annotation store version. // // This member is required. VersionName *string @@ -1654,7 +1656,7 @@ type VersionDeleteError struct { noSmithyDocumentSerde } -// The options for an annotation store version. +// The options for an annotation store version. // // The following types satisfy this interface: // @@ -1687,7 +1689,7 @@ type WorkflowListItem struct { // The workflow's ID. Id *string - // Any metadata available for workflow. The information listed may vary depending + // Any metadata available for workflow. The information listed may vary depending // on the workflow, and there may also be no metadata to return. Metadata map[string]string diff --git a/service/opensearch/api_op_AcceptInboundConnection.go b/service/opensearch/api_op_AcceptInboundConnection.go index 711f2daacb4..36f133f3b67 100644 --- a/service/opensearch/api_op_AcceptInboundConnection.go +++ b/service/opensearch/api_op_AcceptInboundConnection.go @@ -12,9 +12,9 @@ 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) -// . +// inbound cross-cluster search connection request. For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [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_AddDataSource.go b/service/opensearch/api_op_AddDataSource.go index f3d194d441b..e0bb23b00f9 100644 --- a/service/opensearch/api_op_AddDataSource.go +++ b/service/opensearch/api_op_AddDataSource.go @@ -12,9 +12,9 @@ import ( ) // Creates a new direct-query data source to the specified domain. For more -// information, see Creating Amazon OpenSearch Service data source integrations -// with Amazon S3 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html) -// . +// information, see [Creating Amazon OpenSearch Service data source integrations with Amazon S3]. +// +// [Creating Amazon OpenSearch Service data source integrations with Amazon S3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html func (c *Client) AddDataSource(ctx context.Context, params *AddDataSourceInput, optFns ...func(*Options)) (*AddDataSourceOutput, error) { if params == nil { params = &AddDataSourceInput{} diff --git a/service/opensearch/api_op_AddTags.go b/service/opensearch/api_op_AddTags.go index ff9882d783c..ce7f82c1f57 100644 --- a/service/opensearch/api_op_AddTags.go +++ b/service/opensearch/api_op_AddTags.go @@ -13,8 +13,9 @@ import ( // 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) -// . +// information, see [Tagging Amazon OpenSearch Service domains]. +// +// [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 877e2bcef96..1726a5e1fd1 100644 --- a/service/opensearch/api_op_AssociatePackage.go +++ b/service/opensearch/api_op_AssociatePackage.go @@ -12,8 +12,9 @@ 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]. +// +// [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 64592a9ccfe..11a1a7ad281 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]. +// +// [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 71766a309bb..029feca9dbf 100644 --- a/service/opensearch/api_op_CreateDomain.go +++ b/service/opensearch/api_op_CreateDomain.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates an Amazon OpenSearch Service domain. For more information, see [Creating and managing Amazon OpenSearch Service domains]. +// +// [Creating 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,24 +43,30 @@ 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) - // . + // + // For more information, see [Advanced cluster parameters]. + // + // [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. @@ -73,9 +79,9 @@ type CreateDomainInput struct { ClusterConfig *types.ClusterConfig // 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) - // . + // information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards]. + // + // [Configuring Amazon Cognito authentication for OpenSearch 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 @@ -91,9 +97,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]. + // + // [Creating and managing Amazon OpenSearch Service domains]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains EngineVersion *string // Specify either dual stack or IPv4 as your IP address type. Dual stack allows @@ -127,9 +133,9 @@ 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) - // . + // endpoint. For more information, see [Launching your Amazon OpenSearch Service domains using a VPC]. + // + // [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_CreateOutboundConnection.go b/service/opensearch/api_op_CreateOutboundConnection.go index 3852ced0e6c..dc60d8e45e6 100644 --- a/service/opensearch/api_op_CreateOutboundConnection.go +++ b/service/opensearch/api_op_CreateOutboundConnection.go @@ -12,9 +12,9 @@ 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) -// . +// Service domain to a destination domain. For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [Cross-cluster 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 15559d9a81b..0de68e565e0 100644 --- a/service/opensearch/api_op_CreatePackage.go +++ b/service/opensearch/api_op_CreatePackage.go @@ -12,8 +12,9 @@ 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]. +// +// [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_DeleteDataSource.go b/service/opensearch/api_op_DeleteDataSource.go index 6003e61d750..31c5ceff8bc 100644 --- a/service/opensearch/api_op_DeleteDataSource.go +++ b/service/opensearch/api_op_DeleteDataSource.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a direct-query data source. For more information, see Deleting an -// Amazon OpenSearch Service data source with Amazon S3 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html) -// . +// Deletes a direct-query data source. For more information, see [Deleting an Amazon OpenSearch Service data source with Amazon S3]. +// +// [Deleting an Amazon OpenSearch Service data source with Amazon S3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error) { if params == nil { params = &DeleteDataSourceInput{} diff --git a/service/opensearch/api_op_DeleteInboundConnection.go b/service/opensearch/api_op_DeleteInboundConnection.go index 8f8c221856d..c3d9b5b6b85 100644 --- a/service/opensearch/api_op_DeleteInboundConnection.go +++ b/service/opensearch/api_op_DeleteInboundConnection.go @@ -12,9 +12,9 @@ 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) -// . +// existing inbound cross-cluster search connection. For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [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 ea3516caae2..9f6133af960 100644 --- a/service/opensearch/api_op_DeleteOutboundConnection.go +++ b/service/opensearch/api_op_DeleteOutboundConnection.go @@ -12,9 +12,9 @@ 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) -// . +// outbound cross-cluster search connection. For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [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 20727225063..2bbda249ea6 100644 --- a/service/opensearch/api_op_DeletePackage.go +++ b/service/opensearch/api_op_DeletePackage.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Deletes an Amazon OpenSearch Service package. For more information, see [Custom packages for Amazon OpenSearch Service]. +// +// [Custom 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{} @@ -45,7 +45,7 @@ type DeletePackageInput struct { // Container for the response parameters to the DeletePackage operation. type DeletePackageOutput struct { - // Information about the deleted package. + // Information about the deleted package. PackageDetails *types.PackageDetails // Metadata pertaining to the operation's result. diff --git a/service/opensearch/api_op_DescribeDomainAutoTunes.go b/service/opensearch/api_op_DescribeDomainAutoTunes.go index 968da61c485..4d03a085b0b 100644 --- a/service/opensearch/api_op_DescribeDomainAutoTunes.go +++ b/service/opensearch/api_op_DescribeDomainAutoTunes.go @@ -12,9 +12,9 @@ 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 domain. For more information, see [Auto-Tune for Amazon OpenSearch Service]. +// +// [Auto-Tune for Amazon 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{} diff --git a/service/opensearch/api_op_DescribeDomainChangeProgress.go b/service/opensearch/api_op_DescribeDomainChangeProgress.go index 3679a250d50..c756d76c17f 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]. +// +// [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_DescribeDomainHealth.go b/service/opensearch/api_op_DescribeDomainHealth.go index 997de133c94..105906bb3dc 100644 --- a/service/opensearch/api_op_DescribeDomainHealth.go +++ b/service/opensearch/api_op_DescribeDomainHealth.go @@ -52,10 +52,13 @@ type DescribeDomainHealthOutput struct { AvailabilityZoneCount *string // The current health status of your cluster. + // // - Red - At least one primary shard is not allocated to any node. - // - Yellow - All primary shards are allocated to nodes, but some replicas - // aren’t. + // + // - Yellow - All primary shards are allocated to nodes, but some replicas aren’t. + // // - Green - All primary shards and their replicas are allocated to nodes. + // // - NotAvailable - Unable to retrieve cluster health. ClusterHealth types.DomainHealth @@ -67,7 +70,9 @@ type DescribeDomainHealthOutput struct { DedicatedMaster *bool // The current state of the domain. + // // - Processing - The domain has updates in progress. + // // - Active - Requested changes have been processed and deployed to the domain. DomainState types.DomainState @@ -81,7 +86,9 @@ type DescribeDomainHealthOutput struct { MasterEligibleNodeCount *string // Indicates whether the domain has an elected master node. + // // - Available - The domain has an elected master node. + // // - UnAvailable - The master node hasn't yet been elected, and a quorum to // elect a new master node hasn't been reached. MasterNode types.MasterNodeStatus diff --git a/service/opensearch/api_op_DescribeDryRunProgress.go b/service/opensearch/api_op_DescribeDryRunProgress.go index fdfa7c76b26..776f2e40f1b 100644 --- a/service/opensearch/api_op_DescribeDryRunProgress.go +++ b/service/opensearch/api_op_DescribeDryRunProgress.go @@ -12,9 +12,9 @@ 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) -// . +// Service domain. For more information, see [Determining whether a change will cause a blue/green deployment]. +// +// [Determining whether a change will 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 7479ec7e29d..040c67c4daa 100644 --- a/service/opensearch/api_op_DescribeInboundConnections.go +++ b/service/opensearch/api_op_DescribeInboundConnections.go @@ -12,9 +12,9 @@ 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) -// . +// (remote) Amazon OpenSearch Service domain. For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [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{} @@ -33,7 +33,7 @@ func (c *Client) DescribeInboundConnections(ctx context.Context, params *Describ // Container for the parameters to the DescribeInboundConnections operation. type DescribeInboundConnectionsInput struct { - // A list of filters used to match properties for inbound cross-cluster + // A list of filters used to match properties for inbound cross-cluster // connections. Filters []types.Filter diff --git a/service/opensearch/api_op_DescribeOutboundConnections.go b/service/opensearch/api_op_DescribeOutboundConnections.go index ae44c7465bc..b40c1bb8163 100644 --- a/service/opensearch/api_op_DescribeOutboundConnections.go +++ b/service/opensearch/api_op_DescribeOutboundConnections.go @@ -12,9 +12,9 @@ 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) -// . +// OpenSearch Service domain. For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [Cross-cluster search for 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{} diff --git a/service/opensearch/api_op_DescribePackages.go b/service/opensearch/api_op_DescribePackages.go index facfbeccffc..33f292c36ce 100644 --- a/service/opensearch/api_op_DescribePackages.go +++ b/service/opensearch/api_op_DescribePackages.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/opensearch/api_op_DescribeReservedInstanceOfferings.go b/service/opensearch/api_op_DescribeReservedInstanceOfferings.go index 375ff373967..e677ad54369 100644 --- a/service/opensearch/api_op_DescribeReservedInstanceOfferings.go +++ b/service/opensearch/api_op_DescribeReservedInstanceOfferings.go @@ -12,9 +12,9 @@ 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) -// . +// for a given Region. For more information, see [Reserved Instances in Amazon OpenSearch Service]. +// +// [Reserved Instances in Amazon 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{} diff --git a/service/opensearch/api_op_DescribeReservedInstances.go b/service/opensearch/api_op_DescribeReservedInstances.go index c4aa02081bf..a8c0e89d8fd 100644 --- a/service/opensearch/api_op_DescribeReservedInstances.go +++ b/service/opensearch/api_op_DescribeReservedInstances.go @@ -12,9 +12,9 @@ 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) -// . +// given Region. For more information, see [Reserved Instances in Amazon OpenSearch Service]. +// +// [Reserved Instances in Amazon OpenSearch 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{} diff --git a/service/opensearch/api_op_DissociatePackage.go b/service/opensearch/api_op_DissociatePackage.go index 4597eb20d51..60a6b8396b4 100644 --- a/service/opensearch/api_op_DissociatePackage.go +++ b/service/opensearch/api_op_DissociatePackage.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} @@ -51,7 +52,7 @@ type DissociatePackageInput struct { // Container for the response returned by an DissociatePackage operation. type DissociatePackageOutput struct { - // Information about a package that has been dissociated from the domain. + // Information about a package that has been dissociated from the domain. DomainPackageDetails *types.DomainPackageDetails // Metadata pertaining to the operation's result. diff --git a/service/opensearch/api_op_GetPackageVersionHistory.go b/service/opensearch/api_op_GetPackageVersionHistory.go index ad83d15d30c..b50763e6690 100644 --- a/service/opensearch/api_op_GetPackageVersionHistory.go +++ b/service/opensearch/api_op_GetPackageVersionHistory.go @@ -13,9 +13,9 @@ import ( // Returns a list of Amazon OpenSearch Service package versions, along with their // creation time, commit message, and plugin properties (if the package is a zip -// plugin package). For more information, see Custom packages for Amazon -// OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html) -// . +// plugin package). For more information, see [Custom packages for Amazon OpenSearch Service]. +// +// [Custom packages for 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{} diff --git a/service/opensearch/api_op_ListDataSources.go b/service/opensearch/api_op_ListDataSources.go index 4765754fd8e..5ae7d27e00b 100644 --- a/service/opensearch/api_op_ListDataSources.go +++ b/service/opensearch/api_op_ListDataSources.go @@ -12,9 +12,9 @@ import ( ) // Lists direct-query data sources for a specific domain. For more information, -// see For more information, see Working with Amazon OpenSearch Service direct -// queries with Amazon S3 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html) -// . +// see For more information, see [Working with Amazon OpenSearch Service direct queries with Amazon S3]. +// +// [Working with Amazon OpenSearch Service direct queries with Amazon S3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error) { if params == nil { params = &ListDataSourcesInput{} diff --git a/service/opensearch/api_op_ListDomainsForPackage.go b/service/opensearch/api_op_ListDomainsForPackage.go index 47701b87c05..ef93e753446 100644 --- a/service/opensearch/api_op_ListDomainsForPackage.go +++ b/service/opensearch/api_op_ListDomainsForPackage.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// For more information, see [Custom packages for Amazon OpenSearch Service]. +// +// [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{} diff --git a/service/opensearch/api_op_ListPackagesForDomain.go b/service/opensearch/api_op_ListPackagesForDomain.go index 7e78b592fb3..08827cdcfd9 100644 --- a/service/opensearch/api_op_ListPackagesForDomain.go +++ b/service/opensearch/api_op_ListPackagesForDomain.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// more information, see [Custom packages for Amazon OpenSearch Service]. +// +// [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{} diff --git a/service/opensearch/api_op_ListScheduledActions.go b/service/opensearch/api_op_ListScheduledActions.go index b6e62775c2a..ce1feb16f57 100644 --- a/service/opensearch/api_op_ListScheduledActions.go +++ b/service/opensearch/api_op_ListScheduledActions.go @@ -12,9 +12,10 @@ import ( ) // 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) -// . +// These changes can be [service software updates]or [blue/green Auto-Tune enhancements]. +// +// [blue/green Auto-Tune enhancements]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types +// [service software updates]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html func (c *Client) ListScheduledActions(ctx context.Context, params *ListScheduledActionsInput, optFns ...func(*Options)) (*ListScheduledActionsOutput, error) { if params == nil { params = &ListScheduledActionsInput{} diff --git a/service/opensearch/api_op_ListTags.go b/service/opensearch/api_op_ListTags.go index 0cb3dc8b441..e8a88aaaf24 100644 --- a/service/opensearch/api_op_ListTags.go +++ b/service/opensearch/api_op_ListTags.go @@ -12,8 +12,9 @@ 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]. +// +// [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_ListVpcEndpointAccess.go b/service/opensearch/api_op_ListVpcEndpointAccess.go index 59b9274797d..018e0b0e1f1 100644 --- a/service/opensearch/api_op_ListVpcEndpointAccess.go +++ b/service/opensearch/api_op_ListVpcEndpointAccess.go @@ -46,8 +46,9 @@ type ListVpcEndpointAccessInput struct { type ListVpcEndpointAccessOutput struct { - // A list of IAM principals (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) - // that can currently access the domain. + // A list of [IAM principals] that can currently access the domain. + // + // [IAM principals]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html // // This member is required. AuthorizedPrincipalList []types.AuthorizedPrincipal diff --git a/service/opensearch/api_op_RemoveTags.go b/service/opensearch/api_op_RemoveTags.go index 2b8791af51b..8b0c11e8768 100644 --- a/service/opensearch/api_op_RemoveTags.go +++ b/service/opensearch/api_op_RemoveTags.go @@ -11,8 +11,9 @@ 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]. +// +// [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 0eb7c55af07..b9ff32c2c30 100644 --- a/service/opensearch/api_op_StartServiceSoftwareUpdate.go +++ b/service/opensearch/api_op_StartServiceSoftwareUpdate.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// For more information, see [Service software updates in Amazon OpenSearch Service]. +// +// [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{} @@ -43,14 +44,18 @@ type StartServiceSoftwareUpdateInput struct { 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. ScheduleAt types.ScheduleAt diff --git a/service/opensearch/api_op_UpdateDataSource.go b/service/opensearch/api_op_UpdateDataSource.go index d129d929afc..3fa59a97a2f 100644 --- a/service/opensearch/api_op_UpdateDataSource.go +++ b/service/opensearch/api_op_UpdateDataSource.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a direct-query data source. For more information, see Working with -// Amazon OpenSearch Service data source integrations with Amazon S3 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html) -// . +// Updates a direct-query data source. For more information, see [Working with Amazon OpenSearch Service data source integrations with Amazon S3]. +// +// [Working with Amazon OpenSearch Service data source integrations with Amazon S3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error) { if params == nil { params = &UpdateDataSourceInput{} diff --git a/service/opensearch/api_op_UpdateDomainConfig.go b/service/opensearch/api_op_UpdateDomainConfig.go index 8f57664554f..256f89f73f3 100644 --- a/service/opensearch/api_op_UpdateDomainConfig.go +++ b/service/opensearch/api_op_UpdateDomainConfig.go @@ -41,20 +41,25 @@ 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. - // 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]. + // + // [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. @@ -81,11 +86,14 @@ 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) - // . + // more information, see [Validating a domain update]. + // + // [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. @@ -117,8 +125,9 @@ type UpdateDomainConfigInput struct { 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]. + // + // [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 44cf4acf967..8071fefa28a 100644 --- a/service/opensearch/api_op_UpdatePackage.go +++ b/service/opensearch/api_op_UpdatePackage.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/opensearch/api_op_UpdateScheduledAction.go b/service/opensearch/api_op_UpdateScheduledAction.go index a9e91b7004c..e3c1dd8fab3 100644 --- a/service/opensearch/api_op_UpdateScheduledAction.go +++ b/service/opensearch/api_op_UpdateScheduledAction.go @@ -12,9 +12,10 @@ 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]or a [blue/green Auto-Tune enhancement]. +// +// [service software update]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html +// [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{} @@ -32,18 +33,20 @@ 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) + // The unique identifier of the action to reschedule. To retrieve this ID, send a [ListScheduledActions] // request. // + // [ListScheduledActions]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html + // // 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) + // JVM_HEAP_SIZE_TUNING , or JVM_YOUNG_GEN_TUNING . To retrieve this value, send a [ListScheduledActions] // request. // + // [ListScheduledActions]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html + // // This member is required. ActionType types.ActionType @@ -53,10 +56,13 @@ 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 diff --git a/service/opensearch/doc.go b/service/opensearch/doc.go index a3500290c80..7f4e3c2fcae 100644 --- a/service/opensearch/doc.go +++ b/service/opensearch/doc.go @@ -7,6 +7,7 @@ // manage OpenSearch Service domains. 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]. +// +// [Amazon Web Services service endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions package opensearch diff --git a/service/opensearch/options.go b/service/opensearch/options.go index e2478fcd762..7b2d5e332be 100644 --- a/service/opensearch/options.go +++ b/service/opensearch/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/opensearch/types/enums.go b/service/opensearch/types/enums.go index 90a08b33073..506af0d01bc 100644 --- a/service/opensearch/types/enums.go +++ b/service/opensearch/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ActionSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionSeverity) Values() []ActionSeverity { return []ActionSeverity{ "HIGH", @@ -35,8 +36,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "SERVICE_SOFTWARE_UPDATE", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for AutoTuneDesiredState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoTuneDesiredState) Values() []AutoTuneDesiredState { return []AutoTuneDesiredState{ "ENABLED", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for AutoTuneState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoTuneState) Values() []AutoTuneState { return []AutoTuneState{ "ENABLED", @@ -126,8 +131,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -149,8 +155,9 @@ const ( ) // Values returns all known values for ConfigChangeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigChangeStatus) Values() []ConfigChangeStatus { return []ConfigChangeStatus{ "Pending", @@ -173,8 +180,9 @@ const ( ) // Values returns all known values for ConnectionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionMode) Values() []ConnectionMode { return []ConnectionMode{ "DIRECT", @@ -194,8 +202,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "PENDING_UPDATE", @@ -219,6 +228,7 @@ const ( // Values returns all known values for DescribePackagesFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DescribePackagesFilterName) Values() []DescribePackagesFilterName { return []DescribePackagesFilterName{ @@ -241,8 +251,9 @@ const ( ) // Values returns all known values for DomainHealth. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainHealth) Values() []DomainHealth { return []DomainHealth{ "Red", @@ -264,8 +275,9 @@ const ( ) // Values returns all known values for DomainPackageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainPackageStatus) Values() []DomainPackageStatus { return []DomainPackageStatus{ "ASSOCIATING", @@ -291,6 +303,7 @@ const ( // Values returns all known values for DomainProcessingStatusType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DomainProcessingStatusType) Values() []DomainProcessingStatusType { return []DomainProcessingStatusType{ @@ -314,8 +327,9 @@ const ( ) // Values returns all known values for DomainState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainState) Values() []DomainState { return []DomainState{ "Active", @@ -333,8 +347,9 @@ const ( ) // Values returns all known values for DryRunMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DryRunMode) Values() []DryRunMode { return []DryRunMode{ "Basic", @@ -351,8 +366,9 @@ const ( ) // Values returns all known values for EngineType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EngineType) Values() []EngineType { return []EngineType{ "OpenSearch", @@ -376,6 +392,7 @@ const ( // Values returns all known values for InboundConnectionStatusCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InboundConnectionStatusCode) Values() []InboundConnectionStatusCode { return []InboundConnectionStatusCode{ @@ -399,8 +416,9 @@ const ( ) // Values returns all known values for InitiatedBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InitiatedBy) Values() []InitiatedBy { return []InitiatedBy{ "CUSTOMER", @@ -417,8 +435,9 @@ const ( ) // Values returns all known values for IPAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IPAddressType) Values() []IPAddressType { return []IPAddressType{ "ipv4", @@ -437,8 +456,9 @@ const ( ) // Values returns all known values for LogType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogType) Values() []LogType { return []LogType{ "INDEX_SLOW_LOGS", @@ -460,8 +480,9 @@ const ( ) // Values returns all known values for MaintenanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceStatus) Values() []MaintenanceStatus { return []MaintenanceStatus{ "PENDING", @@ -482,8 +503,9 @@ const ( ) // Values returns all known values for MaintenanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceType) Values() []MaintenanceType { return []MaintenanceType{ "REBOOT_NODE", @@ -501,8 +523,9 @@ const ( ) // Values returns all known values for MasterNodeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MasterNodeStatus) Values() []MasterNodeStatus { return []MasterNodeStatus{ "Available", @@ -520,8 +543,9 @@ const ( ) // Values returns all known values for NodeStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeStatus) Values() []NodeStatus { return []NodeStatus{ "Active", @@ -540,8 +564,9 @@ const ( ) // Values returns all known values for NodeType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeType) Values() []NodeType { return []NodeType{ "Data", @@ -661,8 +686,9 @@ const ( // Values returns all known values for OpenSearchPartitionInstanceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpenSearchPartitionInstanceType) Values() []OpenSearchPartitionInstanceType { return []OpenSearchPartitionInstanceType{ "m3.medium.search", @@ -782,8 +808,9 @@ const ( // Values returns all known values for OpenSearchWarmPartitionInstanceType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpenSearchWarmPartitionInstanceType) Values() []OpenSearchWarmPartitionInstanceType { return []OpenSearchWarmPartitionInstanceType{ "ultrawarm1.medium.search", @@ -802,8 +829,9 @@ const ( ) // Values returns all known values for OptionState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptionState) Values() []OptionState { return []OptionState{ "RequiresIndexDocuments", @@ -830,8 +858,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutboundConnectionStatusCode) Values() []OutboundConnectionStatusCode { return []OutboundConnectionStatusCode{ "VALIDATING", @@ -858,8 +887,9 @@ const ( ) // Values returns all known values for OverallChangeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverallChangeStatus) Values() []OverallChangeStatus { return []OverallChangeStatus{ "PENDING", @@ -884,8 +914,9 @@ const ( ) // Values returns all known values for PackageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageStatus) Values() []PackageStatus { return []PackageStatus{ "COPYING", @@ -908,8 +939,9 @@ const ( ) // Values returns all known values for PackageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageType) Values() []PackageType { return []PackageType{ "TXT-DICTIONARY", @@ -926,8 +958,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "AWS_ACCOUNT", @@ -944,8 +977,9 @@ const ( ) // Values returns all known values for PropertyValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyValueType) Values() []PropertyValueType { return []PropertyValueType{ "PLAIN_TEXT", @@ -964,8 +998,9 @@ const ( // Values returns all known values for ReservedInstancePaymentOption. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservedInstancePaymentOption) Values() []ReservedInstancePaymentOption { return []ReservedInstancePaymentOption{ "ALL_UPFRONT", @@ -983,8 +1018,9 @@ const ( ) // Values returns all known values for RollbackOnDisable. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RollbackOnDisable) Values() []RollbackOnDisable { return []RollbackOnDisable{ "NO_ROLLBACK", @@ -1002,8 +1038,9 @@ const ( ) // Values returns all known values for ScheduleAt. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleAt) Values() []ScheduleAt { return []ScheduleAt{ "NOW", @@ -1022,6 +1059,7 @@ const ( // Values returns all known values for ScheduledAutoTuneActionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledAutoTuneActionType) Values() []ScheduledAutoTuneActionType { return []ScheduledAutoTuneActionType{ @@ -1041,8 +1079,9 @@ const ( // Values returns all known values for ScheduledAutoTuneSeverityType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledAutoTuneSeverityType) Values() []ScheduledAutoTuneSeverityType { return []ScheduledAutoTuneSeverityType{ "LOW", @@ -1060,8 +1099,9 @@ const ( ) // Values returns all known values for ScheduledBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledBy) Values() []ScheduledBy { return []ScheduledBy{ "CUSTOMER", @@ -1078,8 +1118,9 @@ const ( ) // Values returns all known values for SkipUnavailableStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SkipUnavailableStatus) Values() []SkipUnavailableStatus { return []SkipUnavailableStatus{ "ENABLED", @@ -1095,8 +1136,9 @@ const ( ) // Values returns all known values for TimeUnit. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeUnit) Values() []TimeUnit { return []TimeUnit{ "HOURS", @@ -1113,8 +1155,9 @@ const ( ) // Values returns all known values for TLSSecurityPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TLSSecurityPolicy) Values() []TLSSecurityPolicy { return []TLSSecurityPolicy{ "Policy-Min-TLS-1-0-2019-07", @@ -1134,8 +1177,9 @@ const ( ) // Values returns all known values for UpgradeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpgradeStatus) Values() []UpgradeStatus { return []UpgradeStatus{ "IN_PROGRESS", @@ -1155,8 +1199,9 @@ const ( ) // Values returns all known values for UpgradeStep. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpgradeStep) Values() []UpgradeStep { return []UpgradeStep{ "PRE_UPGRADE_CHECK", @@ -1176,8 +1221,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "standard", @@ -1196,8 +1242,9 @@ const ( ) // Values returns all known values for VpcEndpointErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointErrorCode) Values() []VpcEndpointErrorCode { return []VpcEndpointErrorCode{ "ENDPOINT_NOT_FOUND", @@ -1219,8 +1266,9 @@ const ( ) // Values returns all known values for VpcEndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointStatus) Values() []VpcEndpointStatus { return []VpcEndpointStatus{ "CREATING", @@ -1243,8 +1291,9 @@ const ( ) // Values returns all known values for ZoneStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ZoneStatus) Values() []ZoneStatus { return []ZoneStatus{ "Active", diff --git a/service/opensearch/types/types.go b/service/opensearch/types/types.go index fbfbeae18ab..84b61602534 100644 --- a/service/opensearch/types/types.go +++ b/service/opensearch/types/types.go @@ -12,9 +12,9 @@ import ( 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) - // . + // resource-based, IP-based, or IAM-based. For more information, see [Configuring access policies]. + // + // [Configuring access policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies // // This member is required. Options *string @@ -33,12 +33,13 @@ 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. LimitName *string - // The values of the additional instance type limits. + // The values of the additional instance type limits. LimitValues []string noSmithyDocumentSerde @@ -46,25 +47,30 @@ 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. // -// 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]. +// +// [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. @@ -83,15 +89,15 @@ type AdvancedOptionsStatus struct { // Container for fine-grained access control settings. 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) - // . + // Date and time when the migration period will be disabled. Only necessary when [enabling fine-grained access control on an existing domain]. + // + // [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) - // . + // create role mappings. Only necessary when [enabling fine-grained access control on an existing domain]. + // + // [enabling fine-grained access control 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. @@ -108,14 +114,15 @@ 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]. +// +// [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) - // . + // role mappings. Only necessary when [enabling fine-grained access control on an existing domain]. + // + // [enabling fine-grained access control on an 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. @@ -155,8 +162,9 @@ type AdvancedSecurityOptionsStatus struct { // endpoint. type AuthorizedPrincipal struct { - // The IAM principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) - // that is allowed access to the domain. + // The [IAM principal] that is allowed access to the domain. + // + // [IAM principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html Principal *string // The type of principal. @@ -165,9 +173,9 @@ type AuthorizedPrincipal struct { noSmithyDocumentSerde } -// 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) -// . +// Information about an Auto-Tune action. For more information, see [Auto-Tune for Amazon OpenSearch Service]. +// +// [Auto-Tune for Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html type AutoTune struct { // Details about an Auto-Tune action. @@ -179,9 +187,10 @@ type AutoTune struct { noSmithyDocumentSerde } -// 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) +// Specifies details about a scheduled Auto-Tune action. For more information, see [Auto-Tune for Amazon OpenSearch Service] // . +// +// [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. @@ -190,12 +199,14 @@ 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) -// 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) -// . +// This object is deprecated. Use the domain's [off-peak window] to schedule Auto-Tune +// optimizations. For migration instructions, see [Migrating from Auto-Tune maintenance windows]. +// +// The Auto-Tune maintenance schedule. For more information, see [Auto-Tune for Amazon OpenSearch Service]. +// +// [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html +// [Auto-Tune for Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html +// [Migrating from Auto-Tune maintenance windows]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate type AutoTuneMaintenanceSchedule struct { // A cron expression for a recurring maintenance schedule during which Auto-Tune @@ -212,17 +223,19 @@ type AutoTuneMaintenanceSchedule struct { noSmithyDocumentSerde } -// 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) -// . +// Auto-Tune settings when updating a domain. For more information, see [Auto-Tune for Amazon OpenSearch Service]. +// +// [Auto-Tune 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) - // instead. A list of maintenance schedules during which Auto-Tune can deploy - // changes. + // DEPRECATED. Use [off-peak window] instead. + // + // A list of maintenance schedules during which Auto-Tune can deploy changes. + // + // [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html MaintenanceSchedules []AutoTuneMaintenanceSchedule // When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune @@ -231,24 +244,27 @@ type AutoTuneOptions struct { // 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) - // to deploy configuration changes on the domain rather than a maintenance - // schedule. + // Whether to use the domain's [off-peak window] to deploy configuration changes on the domain + // rather than a maintenance schedule. + // + // [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html UseOffPeakWindow *bool noSmithyDocumentSerde } -// 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) +// Options for configuring Auto-Tune. For more information, see [Auto-Tune for Amazon OpenSearch Service] +// +// [Auto-Tune for 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]. + // + // [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 @@ -287,9 +303,9 @@ type AutoTuneOptionsStatus struct { noSmithyDocumentSerde } -// 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) -// . +// The current status of Auto-Tune for the domain. For more information, see [Auto-Tune for Amazon OpenSearch Service]. +// +// [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. @@ -340,8 +356,11 @@ type AvailabilityZoneInfo struct { // The current state of the Availability Zone. Current options are Active and // StandBy . + // // - Active - Data nodes in the Availability Zone are in use. + // // - StandBy - Data nodes in the Availability Zone are in a standby state. + // // - NotAvailable - Unable to retrieve information. ZoneStatus ZoneStatus @@ -464,8 +483,9 @@ 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]. +// +// [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. @@ -490,9 +510,9 @@ type ClusterConfig struct { InstanceType OpenSearchPartitionInstanceType // A boolean that indicates whether a multi-AZ domain is turned on with a standby - // AZ. 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) - // . + // AZ. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service]. + // + // [Configuring a multi-AZ domain in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html MultiAZWithStandbyEnabled *bool // The number of warm nodes in the cluster. @@ -509,8 +529,9 @@ type ClusterConfig struct { 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) - // . + // information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service]. + // + // [Configuring a multi-AZ domain in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html ZoneAwarenessEnabled *bool noSmithyDocumentSerde @@ -533,9 +554,9 @@ 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) -// . +// OpenSearch Service domain. For more information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards]. +// +// [Configuring Amazon Cognito 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 @@ -574,9 +595,9 @@ 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 domain. For more information, see [Cold storage for Amazon OpenSearch Service]. +// +// [Cold storage for Amazon OpenSearch 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. You must enable @@ -607,8 +628,9 @@ type ConnectionProperties struct { // The connection properties for cross cluster search. CrossClusterSearch *CrossClusterSearchConnectionProperties - // The Endpoint attribute cannot be modified. The endpoint of the remote domain. - // Applicable for VPC_ENDPOINT connection mode. + // The Endpoint attribute cannot be modified. + // + // The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode. Endpoint *string noSmithyDocumentSerde @@ -678,8 +700,9 @@ type DomainConfig struct { 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) - // . + // information, see [Advanced options]. + // + // [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. @@ -761,10 +784,13 @@ type DomainEndpointOptions struct { // Specify the TLS security policy to apply to the HTTPS endpoint of the domain. // The policy can be one of the following values: + // // - Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version // 1.0 to TLS version 1.2 + // // - Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS // version 1.2 + // // - Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS // version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites TLSSecurityPolicy TLSSecurityPolicy @@ -872,8 +898,9 @@ type DomainNodesStatus 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]. +// +// [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. @@ -910,9 +937,10 @@ type DomainPackageDetails struct { // The current status of an OpenSearch Service domain. 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. + // The Amazon Resource Name (ARN) of the domain. For more information, see [IAM identifiers] in the + // AWS Identity and Access Management User Guide. + // + // [IAM identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. ARN *string @@ -990,8 +1018,10 @@ type DomainStatus struct { // The key-value pair that exists if the OpenSearch Service domain uses VPC // endpoints. For example: + // // - IPv4 IP addresses - // 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' + // // - Dual stack IP addresses - // 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws' Endpoints map[string]string @@ -1073,12 +1103,16 @@ type DryRunProgressStatus struct { // Results of a dry run performed in an update domain request. type DryRunResults struct { - // Specifies the way in which OpenSearch Service will apply an update. Possible + // 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. DeploymentType *string @@ -1088,9 +1122,9 @@ type DryRunResults struct { noSmithyDocumentSerde } -// 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) -// . +// The duration of a maintenance schedule. For more information, see [Auto-Tune for Amazon OpenSearch Service]. +// +// [Auto-Tune for 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. @@ -1179,7 +1213,7 @@ type EncryptionAtRestOptionsStatus struct { // Information about the active domain environment. type EnvironmentInfo struct { - // A list of AvailabilityZoneInfo for the domain. + // A list of AvailabilityZoneInfo for the domain. AvailabilityZoneInformation []AvailabilityZoneInfo noSmithyDocumentSerde @@ -1213,8 +1247,9 @@ type Filter struct { } // 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) -// . +// For more information, see [Cross-cluster search for Amazon OpenSearch Service]. +// +// [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. @@ -1242,15 +1277,23 @@ 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. StatusCode InboundConnectionStatusCode @@ -1345,10 +1388,12 @@ 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 +// application and slow logs to Amazon CloudWatch. For more information, see [Monitoring OpenSearch logs with Amazon CloudWatch Logs]. +// +// 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 type LogPublishingOption struct { // The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. @@ -1405,8 +1450,9 @@ type ModifyingProperties struct { // The type of value that is currently being modified. Properties can have two // types: - // - PLAIN_TEXT : Contain direct values such as "1", "True", or - // "c5.large.search". + // + // - PLAIN_TEXT : Contain direct values such as "1", "True", or "c5.large.search". + // // - STRINGIFIED_JSON : Contain content in JSON format, such as // {"Enabled":"True"}". ValueType PropertyValueType @@ -1414,9 +1460,9 @@ type ModifyingProperties struct { 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) -// . +// Enables or disables node-to-node encryption. For more information, see [Node-to-node encryption for Amazon OpenSearch Service]. +// +// [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. @@ -1445,10 +1491,13 @@ type NodeToNodeEncryptionOptionsStatus struct { // 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) -// . +// 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]. +// +// [Defining off-peak maintenance windows for 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 @@ -1460,15 +1509,18 @@ 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 -// the domain. +// Options for a domain's [off-peak window], during which OpenSearch Service can perform mandatory +// configuration changes on the domain. +// +// [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html type OffPeakWindowOptions struct { - // Whether to enable an off-peak window. This option is only available when - // modifying a domain created prior to February 16, 2023, not when creating a new - // domain. All domains created after this date have the off-peak window enabled by - // default. You can't disable the off-peak window after it's enabled for a domain. + // Whether to enable an off-peak window. + // + // This option is only available when modifying a domain created prior to February + // 16, 2023, not when creating a new domain. All domains created after this date + // have the off-peak window enabled by default. You can't disable the off-peak + // window after it's enabled for a domain. Enabled *bool // Off-peak window settings for the domain. @@ -1477,8 +1529,9 @@ type OffPeakWindowOptions struct { noSmithyDocumentSerde } -// The status of off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html) -// options for a domain. +// The status of [off-peak window] options for a domain. +// +// [off-peak window]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html type OffPeakWindowOptionsStatus struct { // The domain's off-peak window configuration. @@ -1551,18 +1604,28 @@ 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. StatusCode OutboundConnectionStatusCode @@ -1837,9 +1900,10 @@ 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]or a [blue/green Auto-Tune enhancement]. +// +// [service software update]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html +// [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. @@ -1881,9 +1945,10 @@ type ScheduledAction struct { noSmithyDocumentSerde } -// 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) +// Specifies details about a scheduled Auto-Tune action. For more information, see [Auto-Tune for Amazon OpenSearch Service] // . +// +// [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. @@ -1902,16 +1967,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) -// . +// domain. For more information, see [Service software updates in Amazon OpenSearch Service]. +// +// [Service software updates in Amazon OpenSearch 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 + // True if you're able to cancel your service software version update. False if // you can't cancel your service software update. Cancellable *bool @@ -2007,18 +2072,24 @@ type StorageType struct { // Limits that are applicable for the given Amazon OpenSearch Service storage type. type StorageTypeLimit struct { - // Name of storage limits that are applicable for the given storage type. If + // 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. LimitName *string @@ -2062,11 +2133,15 @@ type UpgradeHistory struct { // A string that describes the upgrade. UpgradeName *string - // The current status of the upgrade. The status can take one of the following + // The current status of the upgrade. The status can take one of the following // values: + // // - In Progress + // // - Succeeded + // // - Succeeded with Issues + // // - Failed UpgradeStatus UpgradeStatus @@ -2084,17 +2159,24 @@ type UpgradeStepItem struct { // step. ProgressPercent *float64 - // One of three steps that an upgrade or upgrade eligibility check goes through: + // One of three steps that an upgrade or upgrade eligibility check goes through: + // // - PreUpgradeCheck + // // - Snapshot + // // - Upgrade UpgradeStep UpgradeStep - // The current status of the upgrade. The status can take one of the following + // The current status of the upgrade. The status can take one of the following // values: + // // - In Progress + // // - Succeeded + // // - Succeeded with Issues + // // - Failed UpgradeStepStatus UpgradeStatus @@ -2133,8 +2215,10 @@ 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]. This information only exists if the domain was created with +// VPCOptions . +// +// [Launching your Amazon OpenSearch Service domains using a VPC]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html type VPCDerivedInfo struct { // The list of Availability Zones associated with the VPC subnets. @@ -2229,9 +2313,9 @@ 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]. +// +// [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 @@ -2247,8 +2331,9 @@ 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]. +// +// [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 diff --git a/service/opensearchserverless/api_op_BatchGetCollection.go b/service/opensearchserverless/api_op_BatchGetCollection.go index 883ee3094d8..2b475e3923a 100644 --- a/service/opensearchserverless/api_op_BatchGetCollection.go +++ b/service/opensearchserverless/api_op_BatchGetCollection.go @@ -12,9 +12,9 @@ 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) -// . +// endpoint and the OpenSearch Dashboards endpoint. For more information, see [Creating and managing Amazon OpenSearch Serverless collections]. +// +// [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{} @@ -33,9 +33,10 @@ func (c *Client) BatchGetCollection(ctx context.Context, params *BatchGetCollect 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) + // The ID is part of the collection endpoint. You can also retrieve it using the [ListCollections] // API. + // + // [ListCollections]: https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html Ids []string // A list of collection names. You can't provide names and IDs in the same request. diff --git a/service/opensearchserverless/api_op_BatchGetEffectiveLifecyclePolicy.go b/service/opensearchserverless/api_op_BatchGetEffectiveLifecyclePolicy.go index 43ea86fff6c..ee93e5b83a1 100644 --- a/service/opensearchserverless/api_op_BatchGetEffectiveLifecyclePolicy.go +++ b/service/opensearchserverless/api_op_BatchGetEffectiveLifecyclePolicy.go @@ -12,8 +12,9 @@ import ( ) // Returns a list of successful and failed retrievals for the OpenSearch -// Serverless indexes. For more information, see Viewing data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list) -// . +// Serverless indexes. For more information, see [Viewing data lifecycle policies]. +// +// [Viewing data lifecycle policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list func (c *Client) BatchGetEffectiveLifecyclePolicy(ctx context.Context, params *BatchGetEffectiveLifecyclePolicyInput, optFns ...func(*Options)) (*BatchGetEffectiveLifecyclePolicyOutput, error) { if params == nil { params = &BatchGetEffectiveLifecyclePolicyInput{} diff --git a/service/opensearchserverless/api_op_BatchGetLifecyclePolicy.go b/service/opensearchserverless/api_op_BatchGetLifecyclePolicy.go index 48b514f3f85..ae3537c483f 100644 --- a/service/opensearchserverless/api_op_BatchGetLifecyclePolicy.go +++ b/service/opensearchserverless/api_op_BatchGetLifecyclePolicy.go @@ -12,8 +12,9 @@ import ( ) // Returns one or more configured OpenSearch Serverless lifecycle policies. For -// more information, see Viewing data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list) -// . +// more information, see [Viewing data lifecycle policies]. +// +// [Viewing data lifecycle policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list func (c *Client) BatchGetLifecyclePolicy(ctx context.Context, params *BatchGetLifecyclePolicyInput, optFns ...func(*Options)) (*BatchGetLifecyclePolicyOutput, error) { if params == nil { params = &BatchGetLifecyclePolicyInput{} diff --git a/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go b/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go index 1c3fde2c548..fb82a5f640c 100644 --- a/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go +++ b/service/opensearchserverless/api_op_BatchGetVpcEndpoint.go @@ -12,9 +12,9 @@ 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) -// . +// account. For more information, see [Access Amazon OpenSearch Serverless using an interface endpoint]. +// +// [Access Amazon OpenSearch Serverless using an 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 05096499053..3f5332919e8 100644 --- a/service/opensearchserverless/api_op_CreateAccessPolicy.go +++ b/service/opensearchserverless/api_op_CreateAccessPolicy.go @@ -14,8 +14,9 @@ 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]. +// +// [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 9c65f4198cb..8ba0abc0b96 100644 --- a/service/opensearchserverless/api_op_CreateCollection.go +++ b/service/opensearchserverless/api_op_CreateCollection.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates a new OpenSearch Serverless collection. For more information, see [Creating and managing Amazon OpenSearch Serverless collections]. +// +// [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_CreateLifecyclePolicy.go b/service/opensearchserverless/api_op_CreateLifecyclePolicy.go index 9414c9dee8e..a2dbdea542f 100644 --- a/service/opensearchserverless/api_op_CreateLifecyclePolicy.go +++ b/service/opensearchserverless/api_op_CreateLifecyclePolicy.go @@ -13,9 +13,9 @@ import ( // Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. // Lifecycle policies define the number of days or hours to retain the data on an -// OpenSearch Serverless index. For more information, see Creating data lifecycle -// policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create) -// . +// OpenSearch Serverless index. For more information, see [Creating data lifecycle policies]. +// +// [Creating data lifecycle policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create func (c *Client) CreateLifecyclePolicy(ctx context.Context, params *CreateLifecyclePolicyInput, optFns ...func(*Options)) (*CreateLifecyclePolicyOutput, error) { if params == nil { params = &CreateLifecyclePolicyInput{} diff --git a/service/opensearchserverless/api_op_CreateSecurityConfig.go b/service/opensearchserverless/api_op_CreateSecurityConfig.go index 5081f63aae1..e8ec332a786 100644 --- a/service/opensearchserverless/api_op_CreateSecurityConfig.go +++ b/service/opensearchserverless/api_op_CreateSecurityConfig.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/opensearchserverless/api_op_CreateSecurityPolicy.go b/service/opensearchserverless/api_op_CreateSecurityPolicy.go index 4837e34f6c4..bcc46d8ce72 100644 --- a/service/opensearchserverless/api_op_CreateSecurityPolicy.go +++ b/service/opensearchserverless/api_op_CreateSecurityPolicy.go @@ -15,9 +15,10 @@ 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]and [Encryption at rest for Amazon OpenSearch Serverless]. +// +// [Network access for Amazon OpenSearch Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html +// [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 ae6554f92a2..ca618138c53 100644 --- a/service/opensearchserverless/api_op_CreateVpcEndpoint.go +++ b/service/opensearchserverless/api_op_CreateVpcEndpoint.go @@ -12,8 +12,9 @@ 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]. +// +// [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 1a82dc931e3..540997eda16 100644 --- a/service/opensearchserverless/api_op_DeleteAccessPolicy.go +++ b/service/opensearchserverless/api_op_DeleteAccessPolicy.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Deletes an OpenSearch Serverless access policy. For more information, see [Data access control for Amazon OpenSearch Serverless]. +// +// [Data 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 3a59ceb5644..5d3866f5465 100644 --- a/service/opensearchserverless/api_op_DeleteCollection.go +++ b/service/opensearchserverless/api_op_DeleteCollection.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Deletes an OpenSearch Serverless collection. For more information, see [Creating and managing Amazon OpenSearch Serverless collections]. +// +// [Creating 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,9 +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 - // 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) - // API. + // part of the collection endpoint. You can also retrieve it using the [ListCollections]API. + // + // [ListCollections]: https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html // // This member is required. Id *string diff --git a/service/opensearchserverless/api_op_DeleteLifecyclePolicy.go b/service/opensearchserverless/api_op_DeleteLifecyclePolicy.go index c1f20a9f49d..3470c63da3b 100644 --- a/service/opensearchserverless/api_op_DeleteLifecyclePolicy.go +++ b/service/opensearchserverless/api_op_DeleteLifecyclePolicy.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an OpenSearch Serverless lifecycle policy. For more information, see -// Deleting data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-delete) -// . +// Deletes an OpenSearch Serverless lifecycle policy. For more information, see [Deleting data lifecycle policies]. +// +// [Deleting data lifecycle policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-delete func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, optFns ...func(*Options)) (*DeleteLifecyclePolicyOutput, error) { if params == nil { params = &DeleteLifecyclePolicyInput{} diff --git a/service/opensearchserverless/api_op_DeleteSecurityConfig.go b/service/opensearchserverless/api_op_DeleteSecurityConfig.go index d253b105571..587b1a312de 100644 --- a/service/opensearchserverless/api_op_DeleteSecurityConfig.go +++ b/service/opensearchserverless/api_op_DeleteSecurityConfig.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} diff --git a/service/opensearchserverless/api_op_DeleteVpcEndpoint.go b/service/opensearchserverless/api_op_DeleteVpcEndpoint.go index 986160acc74..623d98f675b 100644 --- a/service/opensearchserverless/api_op_DeleteVpcEndpoint.go +++ b/service/opensearchserverless/api_op_DeleteVpcEndpoint.go @@ -12,8 +12,9 @@ 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]. +// +// [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 b999e57b814..10b4552bcd4 100644 --- a/service/opensearchserverless/api_op_GetAccessPolicy.go +++ b/service/opensearchserverless/api_op_GetAccessPolicy.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Returns an OpenSearch Serverless access policy. For more information, see [Data access control for Amazon OpenSearch Serverless]. +// +// [Data 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{} diff --git a/service/opensearchserverless/api_op_GetSecurityConfig.go b/service/opensearchserverless/api_op_GetSecurityConfig.go index cd4cc2c8e7a..04abe1a517f 100644 --- a/service/opensearchserverless/api_op_GetSecurityConfig.go +++ b/service/opensearchserverless/api_op_GetSecurityConfig.go @@ -12,8 +12,9 @@ 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]. +// +// [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 443202cc601..043a24b50b4 100644 --- a/service/opensearchserverless/api_op_GetSecurityPolicy.go +++ b/service/opensearchserverless/api_op_GetSecurityPolicy.go @@ -12,9 +12,10 @@ 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]and [Encryption at rest for Amazon OpenSearch Serverless]. +// +// [Network access for Amazon OpenSearch Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html +// [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_ListCollections.go b/service/opensearchserverless/api_op_ListCollections.go index e1f668969c5..8446c73f706 100644 --- a/service/opensearchserverless/api_op_ListCollections.go +++ b/service/opensearchserverless/api_op_ListCollections.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Lists all OpenSearch Serverless collections. For more information, see [Creating and managing Amazon OpenSearch Serverless collections]. +// +// Make sure to include an empty request body {} if you don't include any // collection filters in the request. +// +// [Creating and managing Amazon OpenSearch Serverless collections]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInput, optFns ...func(*Options)) (*ListCollectionsOutput, error) { if params == nil { params = &ListCollectionsInput{} @@ -32,7 +34,7 @@ func (c *Client) ListCollections(ctx context.Context, params *ListCollectionsInp type ListCollectionsInput struct { - // A list of filter names and values that you can use for requests. + // A 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 diff --git a/service/opensearchserverless/api_op_ListLifecyclePolicies.go b/service/opensearchserverless/api_op_ListLifecyclePolicies.go index 750d6d27049..8c1c97bf931 100644 --- a/service/opensearchserverless/api_op_ListLifecyclePolicies.go +++ b/service/opensearchserverless/api_op_ListLifecyclePolicies.go @@ -12,8 +12,9 @@ import ( ) // Returns a list of OpenSearch Serverless lifecycle policies. For more -// information, see Viewing data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list) -// . +// information, see [Viewing data lifecycle policies]. +// +// [Viewing data lifecycle policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list func (c *Client) ListLifecyclePolicies(ctx context.Context, params *ListLifecyclePoliciesInput, optFns ...func(*Options)) (*ListLifecyclePoliciesOutput, error) { if params == nil { params = &ListLifecyclePoliciesInput{} diff --git a/service/opensearchserverless/api_op_ListSecurityConfigs.go b/service/opensearchserverless/api_op_ListSecurityConfigs.go index b34b0a484fc..21a83a01fdd 100644 --- a/service/opensearchserverless/api_op_ListSecurityConfigs.go +++ b/service/opensearchserverless/api_op_ListSecurityConfigs.go @@ -12,9 +12,9 @@ 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) -// . +// configurations. For more information, see [SAML authentication for Amazon OpenSearch Serverless]. +// +// [SAML authentication for Amazon 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{} diff --git a/service/opensearchserverless/api_op_ListTagsForResource.go b/service/opensearchserverless/api_op_ListTagsForResource.go index 1ad11612fcb..ab6f9f70656 100644 --- a/service/opensearchserverless/api_op_ListTagsForResource.go +++ b/service/opensearchserverless/api_op_ListTagsForResource.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/opensearchserverless/api_op_ListVpcEndpoints.go b/service/opensearchserverless/api_op_ListVpcEndpoints.go index 109c10ed02e..6b34918bd50 100644 --- a/service/opensearchserverless/api_op_ListVpcEndpoints.go +++ b/service/opensearchserverless/api_op_ListVpcEndpoints.go @@ -12,9 +12,9 @@ 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) -// . +// with the current account. For more information, see [Access Amazon OpenSearch Serverless using an interface endpoint]. +// +// [Access Amazon OpenSearch 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{} diff --git a/service/opensearchserverless/api_op_TagResource.go b/service/opensearchserverless/api_op_TagResource.go index aee3895604f..2cbfe2e7c70 100644 --- a/service/opensearchserverless/api_op_TagResource.go +++ b/service/opensearchserverless/api_op_TagResource.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/opensearchserverless/api_op_UntagResource.go b/service/opensearchserverless/api_op_UntagResource.go index 9760ee40831..bce986148d9 100644 --- a/service/opensearchserverless/api_op_UntagResource.go +++ b/service/opensearchserverless/api_op_UntagResource.go @@ -11,8 +11,9 @@ 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]. +// +// [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{} diff --git a/service/opensearchserverless/api_op_UpdateAccessPolicy.go b/service/opensearchserverless/api_op_UpdateAccessPolicy.go index 14cfd0d4ea0..c03cd0ea4c5 100644 --- a/service/opensearchserverless/api_op_UpdateAccessPolicy.go +++ b/service/opensearchserverless/api_op_UpdateAccessPolicy.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates an OpenSearch Serverless access policy. For more information, see [Data access control for Amazon OpenSearch Serverless]. +// +// [Data 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 1e2e992fd7e..b6242eecea8 100644 --- a/service/opensearchserverless/api_op_UpdateAccountSettings.go +++ b/service/opensearchserverless/api_op_UpdateAccountSettings.go @@ -12,9 +12,9 @@ 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) -// . +// account. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless]. +// +// [Managing capacity limits for Amazon 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{} @@ -34,9 +34,9 @@ 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) - // . + // based on the current workload. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless]. + // + // [Managing capacity 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_UpdateLifecyclePolicy.go b/service/opensearchserverless/api_op_UpdateLifecyclePolicy.go index 3dd74ceb6a7..7c74fc183f5 100644 --- a/service/opensearchserverless/api_op_UpdateLifecyclePolicy.go +++ b/service/opensearchserverless/api_op_UpdateLifecyclePolicy.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an OpenSearch Serverless access policy. For more information, see -// Updating data lifecycle policies (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-update) -// . +// Updates an OpenSearch Serverless access policy. For more information, see [Updating data lifecycle policies]. +// +// [Updating data lifecycle policies]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-update func (c *Client) UpdateLifecyclePolicy(ctx context.Context, params *UpdateLifecyclePolicyInput, optFns ...func(*Options)) (*UpdateLifecyclePolicyOutput, error) { if params == nil { params = &UpdateLifecyclePolicyInput{} @@ -41,7 +41,7 @@ type UpdateLifecyclePolicyInput struct { // This member is required. PolicyVersion *string - // The type of lifecycle policy. + // The type of lifecycle policy. // // This member is required. Type types.LifecyclePolicyType diff --git a/service/opensearchserverless/api_op_UpdateSecurityConfig.go b/service/opensearchserverless/api_op_UpdateSecurityConfig.go index b93c7d410e5..1bcd63b6812 100644 --- a/service/opensearchserverless/api_op_UpdateSecurityConfig.go +++ b/service/opensearchserverless/api_op_UpdateSecurityConfig.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} diff --git a/service/opensearchserverless/api_op_UpdateSecurityPolicy.go b/service/opensearchserverless/api_op_UpdateSecurityPolicy.go index e4550cc18fa..d263bbf94e1 100644 --- a/service/opensearchserverless/api_op_UpdateSecurityPolicy.go +++ b/service/opensearchserverless/api_op_UpdateSecurityPolicy.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Updates an OpenSearch Serverless security policy. For more information, see [Network access for Amazon OpenSearch Serverless] +// and [Encryption at rest for Amazon OpenSearch Serverless]. +// +// [Network access for Amazon OpenSearch Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html +// [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 7e26a2030d4..54c67505e98 100644 --- a/service/opensearchserverless/api_op_UpdateVpcEndpoint.go +++ b/service/opensearchserverless/api_op_UpdateVpcEndpoint.go @@ -12,8 +12,9 @@ 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]. +// +// [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 c1ff55e1a0b..f6277e6ad29 100644 --- a/service/opensearchserverless/doc.go +++ b/service/opensearchserverless/doc.go @@ -4,11 +4,15 @@ // types for OpenSearch Service Serverless. // // Use the Amazon OpenSearch Serverless API to create, configure, and manage -// OpenSearch Serverless collections and security policies. OpenSearch Serverless -// is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch -// Service. OpenSearch Serverless removes the operational complexities of -// 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) +// OpenSearch Serverless collections and security policies. +// +// OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration +// for Amazon OpenSearch Service. OpenSearch Serverless removes the operational +// complexities of 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?] +// +// [What is Amazon OpenSearch Serverless?]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html package opensearchserverless diff --git a/service/opensearchserverless/options.go b/service/opensearchserverless/options.go index 5ae7820a093..272ed4255cd 100644 --- a/service/opensearchserverless/options.go +++ b/service/opensearchserverless/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/opensearchserverless/types/enums.go b/service/opensearchserverless/types/enums.go index 662e2ef107e..e0751976ed9 100644 --- a/service/opensearchserverless/types/enums.go +++ b/service/opensearchserverless/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessPolicyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessPolicyType) Values() []AccessPolicyType { return []AccessPolicyType{ "data", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for CollectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CollectionStatus) Values() []CollectionStatus { return []CollectionStatus{ "CREATING", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for CollectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CollectionType) Values() []CollectionType { return []CollectionType{ "SEARCH", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for LifecyclePolicyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LifecyclePolicyType) Values() []LifecyclePolicyType { return []LifecyclePolicyType{ "retention", @@ -94,8 +98,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "index", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for SecurityConfigType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityConfigType) Values() []SecurityConfigType { return []SecurityConfigType{ "saml", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for SecurityPolicyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityPolicyType) Values() []SecurityPolicyType { return []SecurityPolicyType{ "encryption", @@ -150,8 +157,9 @@ const ( ) // Values returns all known values for StandbyReplicas. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StandbyReplicas) Values() []StandbyReplicas { return []StandbyReplicas{ "ENABLED", @@ -174,8 +182,9 @@ const ( ) // Values returns all known values for VpcEndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointStatus) Values() []VpcEndpointStatus { return []VpcEndpointStatus{ "PENDING", diff --git a/service/opensearchserverless/types/types.go b/service/opensearchserverless/types/types.go index 605d03ff1b9..27fff675f0b 100644 --- a/service/opensearchserverless/types/types.go +++ b/service/opensearchserverless/types/types.go @@ -72,9 +72,9 @@ 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) - // . + // based on the current workload. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless]. + // + // [Managing capacity limits for Amazon OpenSearch Serverless]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html CapacityLimits *CapacityLimits noSmithyDocumentSerde @@ -82,9 +82,9 @@ 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) -// . +// based on the current workload. For more information, see [Managing capacity limits for Amazon OpenSearch Serverless]. +// +// [Managing capacity 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. @@ -229,9 +229,9 @@ 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) -// . +// more information, see [Access Amazon OpenSearch Serverless using an interface endpoint]. +// +// [Access Amazon OpenSearch Serverless using an interface 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_op_AssignInstance.go b/service/opsworks/api_op_AssignInstance.go index 2e1df3eeb0c..6438e357978 100644 --- a/service/opsworks/api_op_AssignInstance.go +++ b/service/opsworks/api_op_AssignInstance.go @@ -11,16 +11,20 @@ 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. // // 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) -// . +// permissions, see [Managing User Permissions]. +// +// [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 7ecfb5af1b6..755119c64d4 100644 --- a/service/opsworks/api_op_AssignVolume.go +++ b/service/opsworks/api_op_AssignVolume.go @@ -11,15 +11,16 @@ 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 +// instance. The volume must first be registered with the stack by calling RegisterVolume. After +// you register the volume, you must call UpdateVolumeto specify a mount point before calling +// AssignVolume . For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 7462e4c1abf..448795c9e5a 100644 --- a/service/opsworks/api_op_AssociateElasticIp.go +++ b/service/opsworks/api_op_AssociateElasticIp.go @@ -11,13 +11,15 @@ 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 +// instance. The address must first be registered with the stack by calling RegisterElasticIp. For +// more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 117db49fa65..3aca1221715 100644 --- a/service/opsworks/api_op_AttachElasticLoadBalancer.go +++ b/service/opsworks/api_op_AttachElasticLoadBalancer.go @@ -12,16 +12,18 @@ 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 +// Classic Load Balancer with AWS OpsWorks Stacks. For more information, see [Elastic Load Balancing]. +// +// 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]. +// +// 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]. +// +// [Elastic Load Balancing]: https://docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html +// [Elastic Load Balancing Developer Guide]: https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html +// [Managing User 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 450c63a7b84..5d1b181f01e 100644 --- a/service/opsworks/api_op_CloneStack.go +++ b/service/opsworks/api_op_CloneStack.go @@ -11,12 +11,15 @@ 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]. 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]. +// +// [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html +// [Clone a Stack]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html func (c *Client) CloneStack(ctx context.Context, params *CloneStackInput, optFns ...func(*Options)) (*CloneStackOutput, error) { if params == nil { params = &CloneStackInput{} @@ -38,12 +41,15 @@ type CloneStackInput struct { // 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. 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 + // you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. + // For more information about IAM ARNs, see [Using Identifiers]. + // + // 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. // + // [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html + // // This member is required. ServiceRoleArn *string @@ -53,19 +59,23 @@ type CloneStackInput struct { 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. + // 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 @@ -73,9 +83,9 @@ type CloneStackInput struct { Attributes map[string]string // 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) - // . + // Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack]. + // + // [Create a New 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. @@ -91,66 +101,85 @@ 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]or [Cookbooks and Recipes]. + // + // [Cookbooks and Recipes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html + // [Adding Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.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) + // the following format: + // + // "{\"key1\": \"value1\", \"key2\": \"value2\",...}" + // + // For more information about custom JSON, see [Use Custom JSON to Modify the Stack Configuration Attributes] + // + // [Use Custom JSON to Modify the Stack 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]. If you also specify a value for + // DefaultSubnetId , the subnet must be in the same zone. For more information, see + // the VpcId parameter description. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html 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) - // . + // for all of the stack's EC2 instances. For more information about IAM ARNs, see [Using Identifiers]. + // + // [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) - // . + // OpsWorks, see [Using Custom AMIs]. + // // 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 + // about supported operating systems, see [AWS OpsWorks Stacks Operating Systems]. + // + // You can specify a different Linux operating system for the cloned stack, but // you cannot change from Linux to Windows or Windows to Linux. + // + // [AWS OpsWorks Stacks Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html + // [Using Custom AMIs]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html 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) - // . + // more information, see [Storage for the Root Device]. + // + // [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]and [Managing SSH Access]. You can override this setting by specifying a different + // key pair, or no key pair, when you [create an instance]. + // + // [Using SSH to Communicate with an Instance]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html + // [Managing SSH Access]: https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html + // [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 @@ -165,17 +194,29 @@ type CloneStackInput struct { // 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. HostnameTheme *string @@ -184,52 +225,66 @@ type CloneStackInput struct { 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]. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html Region *string // Whether to use custom cookbooks. UseCustomCookbooks *bool // Whether to associate the AWS OpsWorks Stacks built-in security groups with the - // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security - // groups, one for each layer, which are associated with layers by default. With + // stack's layers. + // + // AWS OpsWorks Stacks provides a standard set of built-in security 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) - // . + // + // For more information, see [Create a New Stack]. + // + // [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: + // 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) - // . + // + // For more information about how to use AWS OpsWorks Stacks with a VPC, see [Running a Stack in a VPC]. For + // more information about default VPC and EC2 Classic, see [Supported Platforms]. + // + // [Supported Platforms]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html + // [Running a Stack in a VPC]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html VpcId *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_CreateApp.go b/service/opsworks/api_op_CreateApp.go index fb3806da2de..6a372d86c64 100644 --- a/service/opsworks/api_op_CreateApp.go +++ b/service/opsworks/api_op_CreateApp.go @@ -11,12 +11,14 @@ 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]. +// +// 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]. +// +// [Creating Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html +// [Managing User 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{} @@ -74,15 +76,18 @@ type CreateAppInput struct { // 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, + // defined on the associated app server instance. For more information, see [Environment Variables]. + // + // 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 - // specified one or more environment variables, you cannot modify the stack's Chef - // version. + // the message, "Environment: is too large (maximum is 20KB)." + // + // If you have specified one or more environment variables, you cannot modify the + // stack's Chef version. + // + // [Environment Variables]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment Environment []types.EnvironmentVariable // The app's short name. diff --git a/service/opsworks/api_op_CreateDeployment.go b/service/opsworks/api_op_CreateDeployment.go index 52f1f860231..4cc3ef7f2fd 100644 --- a/service/opsworks/api_op_CreateDeployment.go +++ b/service/opsworks/api_op_CreateDeployment.go @@ -11,13 +11,15 @@ 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] and [Run Stack Commands]. +// +// 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) -// . +// grants permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Run Stack Commands]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html +// [Deploying Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html +// [Managing User 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{} @@ -55,11 +57,14 @@ type CreateDeploymentInput struct { // A string that contains user-defined, custom JSON. You can use this parameter to // 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) - // . + // 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] and [Overriding Attributes With Custom JSON]. + // + // [Overriding Attributes With Custom JSON]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html + // [Use Custom JSON to Modify the Stack Configuration Attributes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.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 3c14bfceb67..25e01be617d 100644 --- a/service/opsworks/api_op_CreateInstance.go +++ b/service/opsworks/api_op_CreateInstance.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Creates an instance in a specified stack. For more information, see [Adding an Instance to a 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Adding an Instance to a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html +// [Managing User 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{} @@ -37,10 +38,11 @@ type CreateInstanceInput struct { // 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. + // list contains the currently supported types. For more information, see [Instance Families and Types]. The + // parameter values that you use to specify the various types are in the API Name + // column of the Available Instance Types table. + // + // [Instance Families and Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html // // This member is required. InstanceType *string @@ -56,40 +58,49 @@ type CreateInstanceInput struct { 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. + // 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 . + // one of the supported operating systems. For more information, see [Using Custom AMIs]. + // + // If you specify a custom AMI, you must set Os to Custom . + // + // [Using Custom AMIs]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html AmiId *string // 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]. + // + // [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]. + // + // [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]. Note that block device mappings are not + // supported for custom AMIs. + // + // [Block Device Mapping]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html BlockDeviceMappings []types.BlockDeviceMapping // Whether to create an Amazon EBS-optimized instance. @@ -100,42 +111,52 @@ type CreateInstanceInput struct { // 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. + // 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) + // + // For more information about the supported operating systems, see [AWS OpsWorks Stacks Operating Systems]. + // + // 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] + // For more information about how to use custom AMIs with AWS OpsWorks Stacks, see [Using Custom AMIs] // . + // + // [AWS OpsWorks Stacks Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html + // [Using Custom AMIs]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html + // [Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.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) - // . + // The instance root device type. For more information, see [Storage for the Root Device]. + // + // [Storage for the Root 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. @@ -151,11 +172,13 @@ type CreateInstanceInput struct { // 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]and [Amazon EC2 Dedicated Hosts]. For more information about + // dedicated instances, see [Dedicated Instances]and [Amazon EC2 Dedicated Instances]. + // + // [Dedicated Hosts Overview]: http://aws.amazon.com/ec2/dedicated-hosts/ + // [Dedicated Instances]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html + // [Amazon EC2 Dedicated Hosts]: http://aws.amazon.com/ec2/dedicated-hosts/ + // [Amazon EC2 Dedicated Instances]: http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/ Tenancy *string // The instance's virtualization type, paravirtual or hvm . diff --git a/service/opsworks/api_op_CreateLayer.go b/service/opsworks/api_op_CreateLayer.go index ade8bad6d02..3d6455fcba3 100644 --- a/service/opsworks/api_op_CreateLayer.go +++ b/service/opsworks/api_op_CreateLayer.go @@ -11,17 +11,21 @@ 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 +// Creates a layer. For more information, see [How to Create a Layer]. +// +// 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 +// 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. For more information on user permissions, see [Managing User Permissions]. +// +// [How to Create a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html +// [Managing User 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{} @@ -48,9 +52,12 @@ type CreateLayerInput struct { // which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short // 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) - // . + // alphanumeric characters, '-', '_', and '.'. + // + // The built-in layers' short names are defined by AWS OpsWorks Stacks. For more + // information, see the [Layer Reference]. + // + // [Layer Reference]: https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html // // This member is required. Shortname *string @@ -68,33 +75,38 @@ type CreateLayerInput struct { 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. 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] to the layer's instances. For more + // information, see [How to Edit a Layer]. + // + // [How to Edit a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html + // [Elastic IP address]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.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) - // . + // IP address to the layer's instances. For more information, see [How to Edit a Layer]. + // + // [How to Edit a 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]. + // + // [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) + // attributes to be installed on the layer's instances. For more information, see [Using Custom JSON] // . 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 CustomJson *string // A LayerCustomRecipes object that specifies the layer custom recipes. @@ -108,11 +120,12 @@ type CreateLayerInput struct { // 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 . + // 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 2158566c343..0cbcca43833 100644 --- a/service/opsworks/api_op_CreateStack.go +++ b/service/opsworks/api_op_CreateStack.go @@ -11,11 +11,14 @@ 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]. +// +// 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]. +// +// [Create a New Stack]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html +// [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,9 +37,9 @@ 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) - // . + // for all of the stack's EC2 instances. For more information about IAM ARNs, see [Using Identifiers]. + // + // [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html // // This member is required. DefaultInstanceProfileArn *string @@ -47,8 +50,9 @@ type CreateStackInput struct { 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 + // regions, see [Regions and Endpoints]. + // + // 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 @@ -64,41 +68,48 @@ type CreateStackInput struct { // specifies a regional API endpoint; it cannot be used to specify a classic AWS // OpsWorks Stacks region. // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html + // // This member is required. Region *string // 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]. + // + // [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. + // 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. Attributes map[string]string // 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) - // . + // Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack]. + // + // [Create a New 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 @@ -108,62 +119,78 @@ type CreateStackInput 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]or [Cookbooks and Recipes]. + // + // [Cookbooks and Recipes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html + // [Adding Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.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) - // . + // 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]. + // + // [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]. If you also specify a value for DefaultSubnetId , + // the subnet must be in the same zone. For more information, see the VpcId + // parameter description. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html 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) - // . + // create instances. For more information, see [Using Custom AMIs]. + // // 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) - // . + // about supported operating systems, see [AWS OpsWorks Stacks Operating Systems]. + // + // [AWS OpsWorks Stacks Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html + // [Using Custom AMIs]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.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) - // . + // option is instance-store . For more information, see [Storage for the Root Device]. + // + // [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]and [Managing SSH Access]. You can override this setting by specifying a different + // key pair, or no key pair, when you [create an instance]. + // + // [Using SSH to Communicate with an Instance]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html + // [Managing SSH Access]: https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html + // [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 @@ -178,17 +205,29 @@ type CreateStackInput struct { // 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. HostnameTheme *string @@ -197,43 +236,56 @@ type CreateStackInput struct { UseCustomCookbooks *bool // Whether to associate the AWS OpsWorks Stacks built-in security groups with the - // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security - // groups, one for each layer, which are associated with layers by default. With + // stack's layers. + // + // AWS OpsWorks Stacks provides a standard set of built-in security 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) - // . + // + // For more information, see [Create a New Stack]. + // + // [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: + // 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) - // . + // + // For more information about how to use AWS OpsWorks Stacks with a VPC, see [Running a Stack in a VPC]. For + // more information about default VPC and EC2-Classic, see [Supported Platforms]. + // + // [Supported Platforms]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html + // [Running a Stack in a VPC]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html VpcId *string noSmithyDocumentSerde diff --git a/service/opsworks/api_op_CreateUserProfile.go b/service/opsworks/api_op_CreateUserProfile.go index ae4f9aa6f3f..4792d294cfe 100644 --- a/service/opsworks/api_op_CreateUserProfile.go +++ b/service/opsworks/api_op_CreateUserProfile.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -37,8 +40,9 @@ type CreateUserProfileInput struct { 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) - // . + // page. For more information, see [Setting an IAM User's Public SSH Key]. + // + // [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. diff --git a/service/opsworks/api_op_DeleteApp.go b/service/opsworks/api_op_DeleteApp.go index e171ea310bc..ecde41510a9 100644 --- a/service/opsworks/api_op_DeleteApp.go +++ b/service/opsworks/api_op_DeleteApp.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 ee81d4d3d8f..8b6e2a12237 100644 --- a/service/opsworks/api_op_DeleteInstance.go +++ b/service/opsworks/api_op_DeleteInstance.go @@ -11,13 +11,16 @@ 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 +// instance. You must stop an instance before you can delete it. +// +// For more information, see [Deleting 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Deleting Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html +// [Managing User 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 8e2198b8af7..dcdfa0409f4 100644 --- a/service/opsworks/api_op_DeleteLayer.go +++ b/service/opsworks/api_op_DeleteLayer.go @@ -11,13 +11,14 @@ 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 +// instances or unassign registered instances. For more information, see [How to Delete a 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [How to Delete a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html +// [Managing User 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 c95d8eda689..64375160644 100644 --- a/service/opsworks/api_op_DeleteStack.go +++ b/service/opsworks/api_op_DeleteStack.go @@ -11,13 +11,14 @@ import ( ) // 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 +// apps or deregister registered instances. For more information, see [Shut Down 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Shut Down a Stack]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html +// [Managing User 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 7c0a584ae46..eb7e5a2f949 100644 --- a/service/opsworks/api_op_DeleteUserProfile.go +++ b/service/opsworks/api_op_DeleteUserProfile.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 d3b85ae6e3d..f6e89af727e 100644 --- a/service/opsworks/api_op_DeregisterEcsCluster.go +++ b/service/opsworks/api_op_DeregisterEcsCluster.go @@ -11,12 +11,14 @@ 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]. +// +// 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) -// . +// 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 +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete 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 ae9f82b0cf9..cf73419936e 100644 --- a/service/opsworks/api_op_DeregisterElasticIp.go +++ b/service/opsworks/api_op_DeregisterElasticIp.go @@ -11,12 +11,14 @@ 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 +// by another stack. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 33390b6437d..6a5c41ea5aa 100644 --- a/service/opsworks/api_op_DeregisterInstance.go +++ b/service/opsworks/api_op_DeregisterInstance.go @@ -12,11 +12,13 @@ import ( // Deregister a registered Amazon EC2 or on-premises instance. This action removes // the instance from the stack and returns it to your control. This action cannot -// 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) -// . +// 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]. +// +// [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 7585a4d5c0f..0171ae91ea6 100644 --- a/service/opsworks/api_op_DeregisterRdsDbInstance.go +++ b/service/opsworks/api_op_DeregisterRdsDbInstance.go @@ -10,11 +10,13 @@ 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 -// 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) -// . +// 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]. +// +// [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 2e81b2cb07c..425dc19b980 100644 --- a/service/opsworks/api_op_DeregisterVolume.go +++ b/service/opsworks/api_op_DeregisterVolume.go @@ -11,12 +11,14 @@ 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 +// stack. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 73a6a50ef90..1305b58a007 100644 --- a/service/opsworks/api_op_DescribeApps.go +++ b/service/opsworks/api_op_DescribeApps.go @@ -14,12 +14,15 @@ import ( "time" ) -// Requests a description of a specified set of apps. 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 apps. +// +// 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]. +// +// [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{} @@ -176,12 +179,13 @@ type AppExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeAppsInput, *DescribeAppsOutput, error) (bool, error) } diff --git a/service/opsworks/api_op_DescribeCommands.go b/service/opsworks/api_op_DescribeCommands.go index fc0ece381a4..1591df086da 100644 --- a/service/opsworks/api_op_DescribeCommands.go +++ b/service/opsworks/api_op_DescribeCommands.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the results of specified commands. 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 the results of specified commands. +// +// 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]. +// +// [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{} diff --git a/service/opsworks/api_op_DescribeDeployments.go b/service/opsworks/api_op_DescribeDeployments.go index cb4b261fef6..94d7ed838c7 100644 --- a/service/opsworks/api_op_DescribeDeployments.go +++ b/service/opsworks/api_op_DescribeDeployments.go @@ -15,12 +15,15 @@ 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]. +// +// [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{} @@ -184,12 +187,13 @@ type DeploymentSuccessfulWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDeploymentsInput, *DescribeDeploymentsOutput, error) (bool, error) } diff --git a/service/opsworks/api_op_DescribeEcsClusters.go b/service/opsworks/api_op_DescribeEcsClusters.go index 74e485b7a41..6c5a8898feb 100644 --- a/service/opsworks/api_op_DescribeEcsClusters.go +++ b/service/opsworks/api_op_DescribeEcsClusters.go @@ -14,12 +14,15 @@ 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. +// 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]. +// +// This call accepts only one resource-identifying parameter. +// +// [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html func (c *Client) DescribeEcsClusters(ctx context.Context, params *DescribeEcsClustersInput, optFns ...func(*Options)) (*DescribeEcsClustersOutput, error) { if params == nil { params = &DescribeEcsClustersInput{} diff --git a/service/opsworks/api_op_DescribeElasticIps.go b/service/opsworks/api_op_DescribeElasticIps.go index 6f7da2002c5..eaac64b11c3 100644 --- a/service/opsworks/api_op_DescribeElasticIps.go +++ b/service/opsworks/api_op_DescribeElasticIps.go @@ -11,13 +11,16 @@ 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]. +// +// 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]. +// +// [Elastic IP addresses]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html +// [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{} diff --git a/service/opsworks/api_op_DescribeElasticLoadBalancers.go b/service/opsworks/api_op_DescribeElasticLoadBalancers.go index 572234c11ce..14f7a7c7237 100644 --- a/service/opsworks/api_op_DescribeElasticLoadBalancers.go +++ b/service/opsworks/api_op_DescribeElasticLoadBalancers.go @@ -11,12 +11,15 @@ 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]. +// +// [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 17ab664aa2f..a815fa1e969 100644 --- a/service/opsworks/api_op_DescribeInstances.go +++ b/service/opsworks/api_op_DescribeInstances.go @@ -16,12 +16,15 @@ import ( "time" ) -// Requests a description of a set of 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) -// . +// Requests a description of a set of 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]. +// +// [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{} @@ -183,12 +186,13 @@ type InstanceOnlineWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } @@ -562,12 +566,13 @@ type InstanceRegisteredWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } @@ -917,12 +922,13 @@ type InstanceStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } @@ -1296,12 +1302,13 @@ type InstanceTerminatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error) } diff --git a/service/opsworks/api_op_DescribeLayers.go b/service/opsworks/api_op_DescribeLayers.go index 01702d1cb25..41cba2ec6a3 100644 --- a/service/opsworks/api_op_DescribeLayers.go +++ b/service/opsworks/api_op_DescribeLayers.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests a description of one or more layers in a specified stack. 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 one or more layers in a specified stack. +// +// 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]. +// +// [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 0906134c337..77a0721d17e 100644 --- a/service/opsworks/api_op_DescribeLoadBasedAutoScaling.go +++ b/service/opsworks/api_op_DescribeLoadBasedAutoScaling.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes load-based auto scaling configurations for specified layers. You 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) -// . +// Describes load-based auto scaling configurations for specified layers. +// +// You 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]. +// +// [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{} diff --git a/service/opsworks/api_op_DescribeMyUserProfile.go b/service/opsworks/api_op_DescribeMyUserProfile.go index 5aa10fb6304..ee02ce8d844 100644 --- a/service/opsworks/api_op_DescribeMyUserProfile.go +++ b/service/opsworks/api_op_DescribeMyUserProfile.go @@ -11,11 +11,13 @@ 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]. +// +// [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 212e4dcaf30..ff51327c535 100644 --- a/service/opsworks/api_op_DescribePermissions.go +++ b/service/opsworks/api_op_DescribePermissions.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 +36,9 @@ 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]. + // + // [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html IamUserArn *string // The stack ID. @@ -48,10 +51,13 @@ 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. Permissions []types.Permission diff --git a/service/opsworks/api_op_DescribeRaidArrays.go b/service/opsworks/api_op_DescribeRaidArrays.go index 074ab35ab5c..53f8c304065 100644 --- a/service/opsworks/api_op_DescribeRaidArrays.go +++ b/service/opsworks/api_op_DescribeRaidArrays.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describe an instance's RAID arrays. 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) -// . +// Describe an instance's RAID arrays. +// +// 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]. +// +// [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 1c445a12f2a..544149d69f8 100644 --- a/service/opsworks/api_op_DescribeRdsDbInstances.go +++ b/service/opsworks/api_op_DescribeRdsDbInstances.go @@ -11,11 +11,15 @@ 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]. +// +// This call accepts only one resource-identifying parameter. +// +// [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html 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 153fb0f7950..076acc1e550 100644 --- a/service/opsworks/api_op_DescribeServiceErrors.go +++ b/service/opsworks/api_op_DescribeServiceErrors.go @@ -11,11 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]. +// +// This call accepts only one resource-identifying parameter. +// +// [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html 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 16eba117bb7..e173d232401 100644 --- a/service/opsworks/api_op_DescribeStackProvisioningParameters.go +++ b/service/opsworks/api_op_DescribeStackProvisioningParameters.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests a description of a stack's provisioning 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) -// . +// Requests a description of a stack's provisioning 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]. +// +// [Managing User 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 c36a25524df..611f68e02d2 100644 --- a/service/opsworks/api_op_DescribeStackSummary.go +++ b/service/opsworks/api_op_DescribeStackSummary.go @@ -12,11 +12,13 @@ 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: -// 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) -// . +// 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]. +// +// [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 0d1d2f5dd68..983b7d0dc23 100644 --- a/service/opsworks/api_op_DescribeStacks.go +++ b/service/opsworks/api_op_DescribeStacks.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 f9c0b2b5170..6092bf1f0cc 100644 --- a/service/opsworks/api_op_DescribeTimeBasedAutoScaling.go +++ b/service/opsworks/api_op_DescribeTimeBasedAutoScaling.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes time-based auto scaling configurations for specified instances. You -// 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) -// . +// Describes time-based auto scaling configurations for specified instances. +// +// You 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]. +// +// [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 e22caeade94..0c994ae0bd4 100644 --- a/service/opsworks/api_op_DescribeUserProfiles.go +++ b/service/opsworks/api_op_DescribeUserProfiles.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 63174bfafbb..d9434f652d6 100644 --- a/service/opsworks/api_op_DescribeVolumes.go +++ b/service/opsworks/api_op_DescribeVolumes.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes an instance's Amazon EBS volumes. 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 an instance's Amazon EBS volumes. +// +// 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]. +// +// [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{} diff --git a/service/opsworks/api_op_DetachElasticLoadBalancer.go b/service/opsworks/api_op_DetachElasticLoadBalancer.go index ea9e5a0c7ed..914da55f939 100644 --- a/service/opsworks/api_op_DetachElasticLoadBalancer.go +++ b/service/opsworks/api_op_DetachElasticLoadBalancer.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 00e69b29307..d76c3ba65d3 100644 --- a/service/opsworks/api_op_DisassociateElasticIp.go +++ b/service/opsworks/api_op_DisassociateElasticIp.go @@ -11,12 +11,14 @@ 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 +// registered with the stack. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 af87067ccb1..ceb346c31a2 100644 --- a/service/opsworks/api_op_GetHostnameSuggestion.go +++ b/service/opsworks/api_op_GetHostnameSuggestion.go @@ -11,11 +11,13 @@ import ( ) // Gets a generated host name for the specified layer, based on the current host -// 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) -// . +// 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]. +// +// [Managing User 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 1e6bb875377..508dc231a81 100644 --- a/service/opsworks/api_op_GrantAccess.go +++ b/service/opsworks/api_op_GrantAccess.go @@ -11,8 +11,9 @@ 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_RebootInstance.go b/service/opsworks/api_op_RebootInstance.go index 2ef1fe70666..adf9a5124cf 100644 --- a/service/opsworks/api_op_RebootInstance.go +++ b/service/opsworks/api_op_RebootInstance.go @@ -10,13 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Reboots a specified instance. For more information, see [Starting, Stopping, and Rebooting 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Starting, Stopping, and Rebooting Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html +// [Managing User 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 3b6ca5e2b2d..35bf124980e 100644 --- a/service/opsworks/api_op_RegisterEcsCluster.go +++ b/service/opsworks/api_op_RegisterEcsCluster.go @@ -12,12 +12,14 @@ import ( // 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 +// more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html +// [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 9b221b3a770..1563155dbf7 100644 --- a/service/opsworks/api_op_RegisterElasticIp.go +++ b/service/opsworks/api_op_RegisterElasticIp.go @@ -12,13 +12,14 @@ 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 +// you must first deregister it by calling DeregisterElasticIp. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 edaf77253f4..02d700de825 100644 --- a/service/opsworks/api_op_RegisterInstance.go +++ b/service/opsworks/api_op_RegisterInstance.go @@ -12,23 +12,28 @@ import ( ) // Registers instances that were created outside of AWS OpsWorks Stacks with a -// 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 -// 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 +// 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]. +// +// Registered instances have the same requirements as instances that are created +// by using the CreateInstanceAPI. 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]. +// +// 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]. +// +// [Preparing the Instance]: https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html +// [Registering an Instance with an AWS OpsWorks Stacks Stack]: https://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html +// [Managing User 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 d50d1f54462..3c723d9d0d8 100644 --- a/service/opsworks/api_op_RegisterRdsDbInstance.go +++ b/service/opsworks/api_op_RegisterRdsDbInstance.go @@ -10,11 +10,13 @@ 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]. +// +// [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 77eea978d51..687d26fa27a 100644 --- a/service/opsworks/api_op_RegisterVolume.go +++ b/service/opsworks/api_op_RegisterVolume.go @@ -12,13 +12,14 @@ 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 +// you must first deregister it by calling DeregisterVolume. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 81fbaef8296..d77d8fe76d8 100644 --- a/service/opsworks/api_op_SetLoadBasedAutoScaling.go +++ b/service/opsworks/api_op_SetLoadBasedAutoScaling.go @@ -12,15 +12,19 @@ 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 +// more information, see [Managing Load with Time-based and Load-based Instances]. +// +// 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) -// . +// 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]. +// +// [Managing Load with Time-based and Load-based Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html +// [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{} diff --git a/service/opsworks/api_op_SetPermission.go b/service/opsworks/api_op_SetPermission.go index dce81540c68..9dda9e423da 100644 --- a/service/opsworks/api_op_SetPermission.go +++ b/service/opsworks/api_op_SetPermission.go @@ -10,13 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Specifies a user's permissions. For more information, see [Security and Permissions]. +// +// 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]. +// +// [Security and Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html +// [Managing User 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{} @@ -52,14 +53,20 @@ 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) - // . + // + // For more information about the permissions associated with these levels, see [Managing User Permissions]. + // + // [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 8a287812b4a..39e45ec5029 100644 --- a/service/opsworks/api_op_SetTimeBasedAutoScaling.go +++ b/service/opsworks/api_op_SetTimeBasedAutoScaling.go @@ -12,12 +12,14 @@ 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]. +// +// 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]. +// +// [Managing Load with Time-based and Load-based Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html +// [Managing User 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 b3445cddd5d..a2592962a62 100644 --- a/service/opsworks/api_op_StartInstance.go +++ b/service/opsworks/api_op_StartInstance.go @@ -10,13 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Starts a specified instance. For more information, see [Starting, Stopping, and Rebooting 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Starting, Stopping, and Rebooting Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html +// [Managing User 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 a9c94e75e5e..6fee6e45373 100644 --- a/service/opsworks/api_op_StartStack.go +++ b/service/opsworks/api_op_StartStack.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 f5ece0896a5..c6db7169a2b 100644 --- a/service/opsworks/api_op_StopInstance.go +++ b/service/opsworks/api_op_StopInstance.go @@ -12,13 +12,14 @@ 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 +// an Amazon EBS-backed instance without losing data. For more information, see [Starting, Stopping, and Rebooting 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) -// . +// permissions. For more information on user permissions, see [Managing User Permissions]. +// +// [Starting, Stopping, and Rebooting Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html +// [Managing User 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{} diff --git a/service/opsworks/api_op_StopStack.go b/service/opsworks/api_op_StopStack.go index 68514026bf5..6a0a8065046 100644 --- a/service/opsworks/api_op_StopStack.go +++ b/service/opsworks/api_op_StopStack.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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 f37391a3832..cf4f18735b2 100644 --- a/service/opsworks/api_op_TagResource.go +++ b/service/opsworks/api_op_TagResource.go @@ -11,8 +11,10 @@ import ( ) // 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. +// Stacks. For more information about how tagging works, see [Tags]in the AWS OpsWorks +// User Guide. +// +// [Tags]: https://docs.aws.amazon.com/opsworks/latest/userguide/tagging.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -37,14 +39,19 @@ 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. // // This member is required. diff --git a/service/opsworks/api_op_UnassignInstance.go b/service/opsworks/api_op_UnassignInstance.go index 150626fef0e..5cb7d63f358 100644 --- a/service/opsworks/api_op_UnassignInstance.go +++ b/service/opsworks/api_op_UnassignInstance.go @@ -13,11 +13,13 @@ import ( // 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) -// . +// 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]. +// +// [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 a892caea5dc..298da6f63a9 100644 --- a/service/opsworks/api_op_UnassignVolume.go +++ b/service/opsworks/api_op_UnassignVolume.go @@ -11,12 +11,14 @@ 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 +// stack. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 5d68752de29..57c1fb1592b 100644 --- a/service/opsworks/api_op_UpdateApp.go +++ b/service/opsworks/api_op_UpdateApp.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -59,15 +61,18 @@ type UpdateAppInput struct { // 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, + // defined on the associated app server instances.For more information, see [Environment Variables]. + // + // 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 - // specified one or more environment variables, you cannot modify the stack's Chef - // version. + // the message, "Environment: is too large (maximum is 20 KB)." + // + // If you have specified one or more environment variables, you cannot modify the + // stack's Chef version. + // + // [Environment Variables]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment Environment []types.EnvironmentVariable // The app name. diff --git a/service/opsworks/api_op_UpdateElasticIp.go b/service/opsworks/api_op_UpdateElasticIp.go index 0d0c289abce..f9238c52ce0 100644 --- a/service/opsworks/api_op_UpdateElasticIp.go +++ b/service/opsworks/api_op_UpdateElasticIp.go @@ -10,13 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Updates a registered Elastic IP address's name. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 24472f10fe6..60c11c83d9a 100644 --- a/service/opsworks/api_op_UpdateInstance.go +++ b/service/opsworks/api_op_UpdateInstance.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -39,14 +41,18 @@ type UpdateInstanceInput struct { 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 . + // list of available agent version numbers, call DescribeAgentVersions. + // // AgentVersion cannot be set to Chef 12.2. AgentVersion *string @@ -58,8 +64,9 @@ 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]. + // + // [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 @@ -74,19 +81,21 @@ type UpdateInstanceInput struct { // 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. + // 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, // 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. + // list contains the currently supported types. For more information, see [Instance Families and Types]. The + // parameter values that you use to specify the various types are in the API Name + // column of the Available Instance Types table. + // + // [Instance Families and Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html InstanceType *string // The instance's layer IDs. @@ -94,28 +103,37 @@ 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 + // + // For more information about supported operating systems, see [AWS OpsWorks Stacks Operating Systems]. + // + // 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]. For more information about how to use custom AMIs with OpsWorks, see [Using Custom AMIs]. + // + // You can specify a different Linux operating system for the updated stack, but // you cannot change from Linux to Windows or Windows to Linux. + // + // [AWS OpsWorks Stacks Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html + // [Using Custom AMIs]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html + // [Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html Os *string // The instance's Amazon EC2 key name. diff --git a/service/opsworks/api_op_UpdateLayer.go b/service/opsworks/api_op_UpdateLayer.go index bbf078a7fa1..3d0a25e507a 100644 --- a/service/opsworks/api_op_UpdateLayer.go +++ b/service/opsworks/api_op_UpdateLayer.go @@ -11,11 +11,13 @@ 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]. +// +// [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,30 +43,34 @@ 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] to the layer's instances. For more + // information, see [How to Edit a Layer]. + // + // [How to Edit a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html + // [Elastic IP address]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.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) - // . + // IP address to the layer's instances. For more information, see [How to Edit a Layer]. + // + // [How to Edit a 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]. + // + // [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) + // attributes to be installed on the layer's instances. For more information, see [Using Custom JSON] // . + // + // [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. @@ -78,11 +84,12 @@ type UpdateLayerInput struct { // 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. + // 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 // @@ -98,8 +105,12 @@ type UpdateLayerInput struct { // which is used internally by AWS OpsWorks Stacks and by Chef. The short name is // 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) + // /\A[a-z0-9\-\_\.]+\Z/. + // + // The built-in layers' short names are defined by AWS OpsWorks Stacks. For more + // information, see the [Layer Reference] + // + // [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 a47e7ffad81..0910921fea5 100644 --- a/service/opsworks/api_op_UpdateMyUserProfile.go +++ b/service/opsworks/api_op_UpdateMyUserProfile.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [Managing 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 f20ca853919..2e7672b75ee 100644 --- a/service/opsworks/api_op_UpdateRdsDbInstance.go +++ b/service/opsworks/api_op_UpdateRdsDbInstance.go @@ -10,11 +10,13 @@ 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]. +// +// [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 634883da688..23aa42b38de 100644 --- a/service/opsworks/api_op_UpdateStack.go +++ b/service/opsworks/api_op_UpdateStack.go @@ -11,11 +11,13 @@ 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]. +// +// [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{} @@ -39,28 +41,32 @@ type UpdateStackInput struct { 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. + // 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. Attributes map[string]string // 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) - // . + // Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack]. + // + // [Create a New 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 @@ -70,67 +76,82 @@ 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]or [Cookbooks and Recipes]. + // + // [Cookbooks and Recipes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html + // [Adding Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.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 - // 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) - // . + // 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]. + // + // [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 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]. If you also specify a value for DefaultSubnetId , the + // subnet must be in the same zone. For more information, see CreateStack. + // + // [Regions and 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) - // . + // EC2 instances. For more information about IAM ARNs, see [Using Identifiers]. + // + // [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) - // . + // OpsWorks, see [Using Custom AMIs]. + // // 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) - // . + // information about supported operating systems, see [AWS OpsWorks Stacks Operating Systems]. + // + // [AWS OpsWorks Stacks Operating Systems]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html + // [Using Custom AMIs]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.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) - // . + // information, see [Storage for the Root Device]. + // + // [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 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]and [Managing SSH Access]. You can override this setting by specifying a + // different key pair, or no key pair, when you [create an instance]. + // + // [Using SSH to Communicate with an Instance]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html + // [Managing SSH Access]: https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html + // [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 @@ -145,17 +166,29 @@ type UpdateStackInput struct { // 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. HostnameTheme *string @@ -170,22 +203,28 @@ type UpdateStackInput struct { UseCustomCookbooks *bool // Whether to associate the AWS OpsWorks Stacks built-in security groups with the - // stack's layers. AWS OpsWorks Stacks provides a standard set of built-in security - // groups, one for each layer, which are associated with layers by default. + // stack's layers. + // + // AWS OpsWorks Stacks provides a standard set of built-in security groups, one + // for each layer, which are associated with layers by default. // 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) - // . + // + // For more information, see [Create a New Stack]. + // + // [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 384b74199ec..8a6f2ce2679 100644 --- a/service/opsworks/api_op_UpdateUserProfile.go +++ b/service/opsworks/api_op_UpdateUserProfile.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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{} @@ -37,8 +40,9 @@ type UpdateUserProfileInput struct { 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) - // . + // page. For more information, see [Managing User Permissions]. + // + // [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html AllowSelfManagement *bool // The user's new SSH public key. diff --git a/service/opsworks/api_op_UpdateVolume.go b/service/opsworks/api_op_UpdateVolume.go index 2742a7a3e47..6cca6bd85d4 100644 --- a/service/opsworks/api_op_UpdateVolume.go +++ b/service/opsworks/api_op_UpdateVolume.go @@ -10,13 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Updates an Amazon EBS volume's name or mount point. For more information, see [Resource Management]. +// +// 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]. +// +// [Resource Management]: https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html +// [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 5450eb434cf..53a7ee7561a 100644 --- a/service/opsworks/doc.go +++ b/service/opsworks/doc.go @@ -3,48 +3,89 @@ // Package opsworks provides the API client, operations, and parameter types for // AWS OpsWorks. // -// AWS OpsWorks Welcome to the AWS OpsWorks Stacks API Reference. This guide -// provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks -// actions and data types, including common parameters and error codes. AWS -// OpsWorks Stacks is an application management service that provides an integrated -// experience for overseeing the complete application lifecycle. For information -// about this product, go to the AWS OpsWorks (http://aws.amazon.com/opsworks/) -// details page. SDKs and CLI The most common way to use the AWS OpsWorks Stacks -// 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 OpsWorks +// +// Welcome to the AWS OpsWorks Stacks API Reference. This guide provides +// descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and +// data types, including common parameters and error codes. +// +// AWS OpsWorks Stacks is an application management service that provides an +// integrated experience for overseeing the complete application lifecycle. For +// information about this product, go to the [AWS OpsWorks]details page. +// +// # SDKs and CLI +// +// The most common way to use the AWS OpsWorks Stacks 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] +// +// [AWS SDK for Java] +// +// [AWS SDK for .NET] +// +// [AWS SDK for PHP 2] +// +// [AWS SDK for Ruby] +// +// [AWS SDK for Node.js] +// +// [AWS SDK for Python(Boto)] +// +// # 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 +// # 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]. +// +// 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. +// +// [AWS OpsWorks]: http://aws.amazon.com/opsworks/ +// [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 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 Node.js]: http://aws.amazon.com/documentation/sdkforjavascript/ +// [AWS CLI]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html +// [AWS SDK for Python(Boto)]: http://docs.pythonboto.org/en/latest/ref/opsworks.html +// [Chef Versions]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html package opsworks diff --git a/service/opsworks/options.go b/service/opsworks/options.go index 2f822c32416..f1fb7ecac96 100644 --- a/service/opsworks/options.go +++ b/service/opsworks/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/opsworks/types/enums.go b/service/opsworks/types/enums.go index 78a260f0c99..5e83dc7022e 100644 --- a/service/opsworks/types/enums.go +++ b/service/opsworks/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AppAttributesKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppAttributesKeys) Values() []AppAttributesKeys { return []AppAttributesKeys{ "DocumentRoot", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for AppType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppType) Values() []AppType { return []AppType{ "aws-flow-ruby", @@ -61,8 +63,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for AutoScalingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoScalingType) Values() []AutoScalingType { return []AutoScalingType{ "load", @@ -187,8 +191,9 @@ const ( ) // Values returns all known values for CloudWatchLogsEncoding. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchLogsEncoding) Values() []CloudWatchLogsEncoding { return []CloudWatchLogsEncoding{ "ascii", @@ -296,8 +301,9 @@ const ( // Values returns all known values for CloudWatchLogsInitialPosition. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchLogsInitialPosition) Values() []CloudWatchLogsInitialPosition { return []CloudWatchLogsInitialPosition{ "start_of_file", @@ -314,8 +320,9 @@ const ( ) // Values returns all known values for CloudWatchLogsTimeZone. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchLogsTimeZone) Values() []CloudWatchLogsTimeZone { return []CloudWatchLogsTimeZone{ "LOCAL", @@ -342,8 +349,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "install_dependencies", @@ -393,8 +401,9 @@ const ( ) // Values returns all known values for LayerAttributesKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LayerAttributesKeys) Values() []LayerAttributesKeys { return []LayerAttributesKeys{ "EcsClusterArn", @@ -444,8 +453,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -472,8 +482,9 @@ const ( ) // Values returns all known values for RootDeviceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RootDeviceType) Values() []RootDeviceType { return []RootDeviceType{ "ebs", @@ -492,8 +503,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "git", @@ -511,8 +523,9 @@ const ( ) // Values returns all known values for StackAttributesKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackAttributesKeys) Values() []StackAttributesKeys { return []StackAttributesKeys{ "Color", @@ -528,8 +541,9 @@ const ( ) // Values returns all known values for VirtualizationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VirtualizationType) Values() []VirtualizationType { return []VirtualizationType{ "paravirtual", @@ -547,8 +561,9 @@ const ( ) // Values returns all known values for VolumeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VolumeType) Values() []VolumeType { return []VolumeType{ "gp2", diff --git a/service/opsworks/types/types.go b/service/opsworks/types/types.go index 64a813763dc..653fcb09f15 100644 --- a/service/opsworks/types/types.go +++ b/service/opsworks/types/types.go @@ -48,14 +48,16 @@ type App struct { // 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, + // defined on the associated app server instances. For more information, see [Environment Variables]. + // + // 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)" // message. + // + // [Environment Variables]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment Environment []EnvironmentVariable // The app name. @@ -83,12 +85,14 @@ 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) - // . + // 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]. + // + // [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 @@ -109,8 +113,9 @@ 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)]. + // + // [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,8 +130,9 @@ type AutoScalingThresholds struct { } // 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. +// EC2 [BlockDeviceMapping]data type. +// +// [BlockDeviceMapping]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html type BlockDeviceMapping struct { // The device name that is exposed to the instance, such as /dev/sdh . For the root @@ -141,8 +147,9 @@ 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]. + // + // [BlockDeviceMapping]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html VirtualName *string noSmithyDocumentSerde @@ -173,9 +180,9 @@ 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) -// . +// information about members of this data type, see the [CloudWatch Logs Agent Reference]. +// +// [CloudWatch Logs Agent 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 @@ -192,8 +199,9 @@ type CloudWatchLogsLogStream struct { 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]. + // + // [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. @@ -201,16 +209,19 @@ type CloudWatchLogsLogStream struct { // 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 - // 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 - // stream entry to the configuration file, so that each log file type is stored in - // a different log group. Zipped files are not supported. + // 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 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 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 // Specifies the range of lines for identifying a file. The valid values are one @@ -267,24 +278,40 @@ type Command struct { LogUrl *string // The command status: + // // - 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 Type *string @@ -327,10 +354,13 @@ type Deployment struct { // A string that contains user-defined custom JSON. It can be used to override the // 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) - // . + // 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]. + // + // [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. @@ -349,8 +379,11 @@ type Deployment struct { StackId *string // The deployment status: + // // - running + // // - successful + // // - failed Status *string @@ -360,78 +393,102 @@ type Deployment struct { // Used to specify a stack or deployment command. type DeploymentCommand struct { - // Specifies the operation. You can specify only one command. For stacks, the - // following commands are available: + // 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: + // 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 // The arguments of those commands that take arguments. It should be set to a JSON - // object with the following format: {"arg_name1" : ["value1", "value2", ...], - // "arg_name2" : ["value1", "value2", ...], ...} The update_dependencies command - // takes two arguments: + // 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"] - // } + // 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) +// Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 [EbsBlockDevice] // data type. +// +// [EbsBlockDevice]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html type EbsBlockDevice struct { // Whether the volume is deleted on instance termination. 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]. + // + // [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]. + // + // [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). + // 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 @@ -470,8 +527,9 @@ 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]. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html Region *string noSmithyDocumentSerde @@ -529,10 +587,10 @@ type EnvironmentVariable struct { // This member is required. 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 . - // DescribeApps then returns *****FILTERED***** instead of the actual value. The - // default value for Secure is false . + // (Optional) Whether the variable's value will be returned by the DescribeApps 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 . Secure *bool noSmithyDocumentSerde @@ -545,8 +603,9 @@ type Instance struct { // 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) + // A custom AMI ID to be used to create the instance. For more information, see [Instances] + // + // [Instances]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html AmiId *string // The instance architecture: "i386" or "x86_64". @@ -558,8 +617,9 @@ 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]. + // + // [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 @@ -581,8 +641,9 @@ 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]. + // + // [Elastic IP address]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html ElasticIp *string // The instance host name. @@ -593,25 +654,27 @@ type Instance struct { // 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. + // update your instances manually by using CreateDeploymentto 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) + // The ARN of the instance's IAM profile. For more information about IAM ARNs, see [Using Identifiers] // . + // + // [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html InstanceProfileArn *string // The instance type, such as t2.micro . InstanceType *string - // The ID of the last service error. For more information, call - // DescribeServiceErrors . + // The ID of the last service error. For more information, call DescribeServiceErrors. LastServiceErrorId *string // An array containing the instance layer IDs. @@ -644,9 +707,9 @@ type Instance struct { // For registered instances, the reported operating system. 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) - // . + // The instance's root device type. For more information, see [Storage for the Root Device]. + // + // [Storage for the Root Device]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device RootDeviceType RootDeviceType // The root device volume ID. @@ -668,20 +731,35 @@ 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 Status *string @@ -698,8 +776,9 @@ type Instance struct { } // 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]. +// +// [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. @@ -783,21 +862,27 @@ type Layer struct { // The Amazon Resource Number (ARN) of a layer. Arn *string - // 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. + // 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] to the layer's instances. For more + // information, see [How to Edit a Layer]. + // + // [How to Edit a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html + // [Elastic IP address]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.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) - // . + // IP address to the layer's instances. For more information, see [How to Edit a Layer]. + // + // [How to Edit a Layer]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html AutoAssignPublicIps *bool // The Amazon CloudWatch Logs configuration settings for the layer. @@ -807,8 +892,9 @@ type Layer struct { 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) - // . + // For more information about IAM ARNs, see [Using Identifiers]. + // + // [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 @@ -826,11 +912,12 @@ type Layer struct { // of standard recipes for each event. You can also provide custom recipes for any // or all layers and events. AWS OpsWorks Stacks runs custom event recipes after // the standard recipes. LayerCustomRecipes specifies the custom recipes for a - // particular layer to be run in response to each of the five events. To specify a - // recipe, use the cookbook's directory name in the repository followed by two - // colons and the recipe name, which is the recipe's file name without the .rb - // extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the - // repository's phpapp2 folder. + // particular layer to be run in response to each of the five events. + // + // To specify a recipe, use the cookbook's directory name in the repository + // followed by two colons and the recipe name, which is the recipe's file name + // without the .rb extension. For example: phpapp2::dbsetup specifies the + // dbsetup.rb recipe in the repository's phpapp2 folder. DefaultRecipes *Recipes // An array containing the layer's security group names. @@ -841,10 +928,12 @@ type Layer struct { // 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. + // update your instances manually by using CreateDeploymentto 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. @@ -963,18 +1052,26 @@ 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]. + // + // [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) + // + // For more information on the permissions associated with these levels, see [Managing User Permissions] + // + // [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html Level *string // A stack ID. @@ -986,8 +1083,9 @@ 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]. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html AvailabilityZone *string // When the RAID array was created. @@ -1014,7 +1112,9 @@ type RaidArray struct { // The array ID. RaidArrayId *string - // The RAID level (http://en.wikipedia.org/wiki/Standard_RAID_levels) . + // The [RAID level]. + // + // [RAID level]: http://en.wikipedia.org/wiki/Standard_RAID_levels RaidLevel *int32 // The array's size. @@ -1070,11 +1170,12 @@ type RdsDbInstance struct { // of standard recipes for each event. In addition, you can provide custom recipes // for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes // after the standard recipes. LayerCustomRecipes specifies the custom recipes for -// a particular layer to be run in response to each of the five events. To specify -// a recipe, use the cookbook's directory name in the repository followed by two -// colons and the recipe name, which is the recipe's file name without the .rb -// extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the -// repository's phpapp2 folder. +// a particular layer to be run in response to each of the five events. +// +// To specify a recipe, use the cookbook's directory name in the repository +// followed by two colons and the recipe name, which is the recipe's file name +// without the .rb extension. For example: phpapp2::dbsetup specifies the +// dbsetup.rb recipe in the repository's phpapp2 folder. type Recipes struct { // An array of custom recipe names to be run following a configure event. @@ -1156,7 +1257,9 @@ 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] + // + // [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 @@ -1167,19 +1270,24 @@ 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]or [Custom Recipes and Cookbooks]. +// +// [Custom Recipes and Cookbooks]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html +// [Creating Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.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 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 more information on how to safely handle IAM credentials, see [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. + // + // [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 Password *string // The application's version. AWS OpsWorks Stacks enables you to easily deploy new @@ -1188,8 +1296,10 @@ 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. @@ -1200,7 +1310,9 @@ type Source struct { 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. Username *string @@ -1242,8 +1354,9 @@ 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]. + // + // [Create a New Stack]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html ChefConfiguration *ChefConfiguration // The configuration manager. @@ -1253,27 +1366,33 @@ 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]or [Cookbooks and Recipes]. + // + // [Cookbooks and Recipes]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html + // [Adding Apps]: https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html CustomCookbooksSource *Source // A JSON object that contains user-defined attributes to be added to the stack // configuration and deployment attributes. You can use custom JSON 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 on custom JSON, see Use Custom - // JSON to Modify the Stack Configuration Attributes (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) - // . + // 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]. + // + // [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. For more information, see Regions and - // Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html) . + // The stack's default Availability Zone. For more information, see [Regions and Endpoints]. + // + // [Regions and 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) - // . + // EC2 instances. For more information about IAM ARNs, see [Using Identifiers]. + // + // [Using Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html DefaultInstanceProfileArn *string // The stack's default operating system. @@ -1281,8 +1400,9 @@ type Stack struct { // 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) - // . + // information, see [Storage for the Root Device]. + // + // [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 @@ -1299,8 +1419,9 @@ 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]. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html Region *string // The stack AWS Identity and Access Management (IAM) role. @@ -1398,8 +1519,9 @@ type TimeBasedAutoScalingConfiguration struct { 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) - // . + // page. For more information, see [Managing User Permissions]. + // + // [Managing User Permissions]: https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html AllowSelfManagement *bool // The user's IAM ARN. @@ -1420,8 +1542,9 @@ 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]. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html AvailabilityZone *string // The device name. @@ -1430,9 +1553,9 @@ type Volume struct { // The Amazon EC2 volume ID. 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) - // . + // Specifies whether an Amazon EBS volume is encrypted. For more information, see [Amazon EBS Encryption]. + // + // [Amazon EBS Encryption]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html Encrypted *bool // The instance ID. @@ -1450,32 +1573,40 @@ type Volume struct { // The RAID array ID. 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) . + // The AWS region. For more information about AWS regions, see [Regions and Endpoints]. + // + // [Regions and 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]. + // + // [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) - // . + // The volume type. For more information, see [Amazon EBS Volume Types]. + // // - 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. + // + // [Amazon EBS Volume Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html VolumeType *string noSmithyDocumentSerde @@ -1499,29 +1630,37 @@ type VolumeConfiguration struct { // This member is required. 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) - // . + // Specifies whether an Amazon EBS volume is encrypted. For more information, see [Amazon EBS Encryption]. + // + // [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]. + // + // [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) - // . + // The volume type. For more information, see [Amazon EBS Volume Types]. + // // - 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. + // + // [Amazon EBS Volume Types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html VolumeType *string noSmithyDocumentSerde @@ -1529,16 +1668,21 @@ 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 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 // specify offline periods unless you want to change an online period to an offline -// period. The following example specifies that the instance should be online for -// four hours, from UTC 1200 - 1600. It will be off for the remainder of the day. -// { "12":"on", "13":"on", "14":"on", "15":"on" } +// period. +// +// The following example specifies that the instance should be online for four +// hours, from UTC 1200 - 1600. It will be off for the remainder of the day. +// +// { "12":"on", "13":"on", "14":"on", "15":"on" } type WeeklyAutoScalingSchedule struct { // The schedule for Friday. diff --git a/service/opsworkscm/api_op_AssociateNode.go b/service/opsworkscm/api_op_AssociateNode.go index 9b50a9187d6..3ca53856c65 100644 --- a/service/opsworkscm/api_op_AssociateNode.go +++ b/service/opsworkscm/api_op_AssociateNode.go @@ -11,21 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// --server-name MyServer --node-name MyManagedNode --engine-attributes +// 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 --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 -// command is an alternative to the puppet cert sign command that signs a Puppet -// node CSR. Example (Puppet): aws opsworks-cm associate-node --server-name -// MyServer --node-name MyManagedNode --engine-attributes -// "Name=PUPPET_NODE_CSR,Value=csr-pem" A node can can only be associated with -// servers that are 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 request are not valid. The -// AssociateNode API call can be integrated into Auto Scaling configurations, AWS -// Cloudformation templates, or the user data of a server's instance. +// "Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem" +// +// On a Puppet server, this command is an alternative to the puppet cert sign +// command that signs a Puppet node CSR. +// +// Example (Puppet): aws opsworks-cm associate-node --server-name MyServer +// --node-name MyManagedNode --engine-attributes +// "Name=PUPPET_NODE_CSR,Value=csr-pem" +// +// A node can can only be associated with servers that are 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 request are not valid. The AssociateNode API call can be +// integrated into Auto Scaling configurations, AWS Cloudformation templates, or +// the user data of a server's instance. func (c *Client) AssociateNode(ctx context.Context, params *AssociateNodeInput, optFns ...func(*Options)) (*AssociateNodeOutput, error) { if params == nil { params = &AssociateNodeInput{} @@ -43,13 +52,18 @@ func (c *Client) AssociateNode(ctx context.Context, params *AssociateNodeInput, type AssociateNodeInput struct { - // Engine attributes used for associating the node. Attributes accepted in a - // AssociateNode request for Chef + // 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. // diff --git a/service/opsworkscm/api_op_CreateBackup.go b/service/opsworkscm/api_op_CreateBackup.go index b57a4af1c51..a36113831b1 100644 --- a/service/opsworkscm/api_op_CreateBackup.go +++ b/service/opsworkscm/api_op_CreateBackup.go @@ -11,15 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an application-level backup of a server. While the server is in the +// 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 -// 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. +// 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. func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error) { if params == nil { params = &CreateBackupInput{} @@ -42,19 +48,24 @@ type CreateBackupInput struct { // This member is required. ServerName *string - // A user-defined description of the backup. + // A user-defined description of the backup. Description *string // 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. Tags []types.Tag diff --git a/service/opsworkscm/api_op_CreateServer.go b/service/opsworkscm/api_op_CreateServer.go index 94a66af09ac..ecc585600e0 100644 --- a/service/opsworkscm/api_op_CreateServer.go +++ b/service/opsworkscm/api_op_CreateServer.go @@ -11,27 +11,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates and immedately starts a new server. The server is ready to use when it +// 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{} @@ -49,13 +60,13 @@ func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, op type CreateServerInput struct { - // The configuration management engine to use. Valid values include ChefAutomate + // The configuration management engine to use. Valid values include ChefAutomate // and Puppet . // // This member is required. Engine *string - // The ARN of the instance profile that your Amazon EC2 instances use. Although + // 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 @@ -66,19 +77,19 @@ 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 - // The name of the server. The server name must be unique within your AWS account, - // within each region. Server names must start with a letter; then letters, - // numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. + // The name of the server. The server name must be unique within your AWS + // account, within each region. Server names must start with a letter; then + // letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters. // // This member is required. ServerName *string - // The service role that the AWS OpsWorks CM service backend uses to work with + // 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 @@ -89,32 +100,37 @@ type CreateServerInput struct { // This member is required. ServiceRoleArn *string - // Associate a public IP address with a server that you are launching. Valid + // 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 + // If you specify this field, AWS OpsWorks CM creates the server by using the // backup represented by BackupId. BackupId *string - // 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 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 . 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 // 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 . CustomCertificate *string @@ -133,16 +149,19 @@ type CreateServerInput struct { // for CustomDomain and CustomCertificate . CustomPrivateKey *string - // Enable or disable scheduled backups. Valid values are true or false . The + // 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: + // 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 @@ -150,79 +169,101 @@ type CreateServerInput struct { // 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 + // 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 + // 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 - // desired, you may specify this parameter to connect to your instances by using + // The Amazon EC2 key pair to set for the instance. This parameter is optional; + // if desired, you may specify this parameter to connect to your instances by using // SSH. KeyPair *string - // The start time for a one-hour period during which AWS OpsWorks CM backs up + // 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.) + // (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 + // 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 // 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 - // at 08:00 UTC. (8:00 a.m.) + // 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 + // 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 - // creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 - // (everyone). + // 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 - // The IDs of subnets in which to launch the server EC2 instance. Amazon - // EC2-Classic customers: This field is required. All servers must run within a - // VPC. The VPC must have "Auto Assign Public IP" enabled. EC2-VPC customers: This - // 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) - // . + // The IDs of subnets in which to launch the server EC2 instance. + // + // Amazon EC2-Classic customers: This field is required. All servers must run + // within a VPC. The VPC must have "Auto Assign Public IP" enabled. + // + // EC2-VPC customers: This 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]. + // + // [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. + // + // - 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 e628b6a90f6..88aa887a944 100644 --- a/service/opsworkscm/api_op_DeleteBackup.go +++ b/service/opsworkscm/api_op_DeleteBackup.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a backup. You can delete both manual and automated backups. This -// operation is asynchronous. An InvalidStateException is thrown when a backup -// deletion is already in progress. A ResourceNotFoundException is thrown when the -// backup does not exist. A ValidationException is thrown when parameters of the -// request are not valid. +// Deletes a backup. You can delete both manual and automated backups. This +// +// operation is asynchronous. +// +// An InvalidStateException is thrown when a backup deletion is already in +// progress. A ResourceNotFoundException is thrown when the backup does not exist. +// A ValidationException is thrown when parameters of the request are not valid. func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, optFns ...func(*Options)) (*DeleteBackupOutput, error) { if params == nil { params = &DeleteBackupInput{} diff --git a/service/opsworkscm/api_op_DeleteServer.go b/service/opsworkscm/api_op_DeleteServer.go index 2e78ba7510c..b30397b22f8 100644 --- a/service/opsworkscm/api_op_DeleteServer.go +++ b/service/opsworkscm/api_op_DeleteServer.go @@ -10,14 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the server and the underlying AWS CloudFormation stacks (including the +// 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 // 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 -// ResourceNotFoundException is thrown when the server does not exist. A -// ValidationException is raised when parameters of the request are not valid. +// server cannot be deleted. +// +// This operation is asynchronous. +// +// An InvalidStateException is thrown when a server deletion is already in +// progress. 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) DeleteServer(ctx context.Context, params *DeleteServerInput, optFns ...func(*Options)) (*DeleteServerOutput, error) { if params == nil { params = &DeleteServerInput{} diff --git a/service/opsworkscm/api_op_DescribeAccountAttributes.go b/service/opsworkscm/api_op_DescribeAccountAttributes.go index 3a0eb1c504f..1d2693a6be7 100644 --- a/service/opsworkscm/api_op_DescribeAccountAttributes.go +++ b/service/opsworkscm/api_op_DescribeAccountAttributes.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes your OpsWorks-CM account attributes. This operation is synchronous. +// Describes your OpsWorks-CM account attributes. +// +// This operation is synchronous. func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { params = &DescribeAccountAttributesInput{} @@ -33,7 +35,7 @@ type DescribeAccountAttributesInput struct { type DescribeAccountAttributesOutput struct { - // The attributes that are currently set for the account. + // The attributes that are currently set for the account. Attributes []types.AccountAttribute // Metadata pertaining to the operation's result. diff --git a/service/opsworkscm/api_op_DescribeBackups.go b/service/opsworkscm/api_op_DescribeBackups.go index 38896f3132f..479851287b3 100644 --- a/service/opsworkscm/api_op_DescribeBackups.go +++ b/service/opsworkscm/api_op_DescribeBackups.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes backups. The results are ordered by time, with newest backups first. +// Describes backups. The results are ordered by time, with newest backups first. +// // If you do not specify a BackupId or ServerName, the command returns all backups. -// This operation is synchronous. A ResourceNotFoundException is thrown when the -// backup does not exist. A ValidationException is raised when parameters of the -// request are not valid. +// +// This operation is synchronous. +// +// A ResourceNotFoundException is thrown when the backup does not exist. A +// ValidationException is raised when parameters of the request are not valid. func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInput, optFns ...func(*Options)) (*DescribeBackupsOutput, error) { if params == nil { params = &DescribeBackupsInput{} diff --git a/service/opsworkscm/api_op_DescribeEvents.go b/service/opsworkscm/api_op_DescribeEvents.go index 1c0715f5fd9..2f125502e3f 100644 --- a/service/opsworkscm/api_op_DescribeEvents.go +++ b/service/opsworkscm/api_op_DescribeEvents.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes events for a specified server. Results are ordered by time, with -// newest events first. This operation is synchronous. A ResourceNotFoundException -// is thrown when the server does not exist. A ValidationException is raised when -// parameters of the request are not valid. +// Describes events for a specified server. Results are ordered by time, with +// +// newest events first. +// +// This operation is synchronous. +// +// 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) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} diff --git a/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go b/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go index ec35c2edd8e..1e18233e9fa 100644 --- a/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go +++ b/service/opsworkscm/api_op_DescribeNodeAssociationStatus.go @@ -15,8 +15,11 @@ 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. @@ -57,9 +60,14 @@ type DescribeNodeAssociationStatusOutput struct { // PUPPET_NODE_CERT contains the signed certificate (the result of the CSR). EngineAttributes []types.EngineAttribute - // The status of the association or disassociation request. Possible values: + // 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. NodeAssociationStatus types.NodeAssociationStatus @@ -188,12 +196,13 @@ type NodeAssociatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNodeAssociationStatusInput, *DescribeNodeAssociationStatusOutput, error) (bool, error) } diff --git a/service/opsworkscm/api_op_DescribeServers.go b/service/opsworkscm/api_op_DescribeServers.go index ebe62cc750e..e40c09f76ee 100644 --- a/service/opsworkscm/api_op_DescribeServers.go +++ b/service/opsworkscm/api_op_DescribeServers.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all configuration management servers that are identified with your +// Lists all configuration management servers that are identified with your +// // account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks -// CM does not query other services. This operation is synchronous. A -// ResourceNotFoundException is thrown when the server does not exist. A +// CM does not query other services. +// +// This operation is synchronous. +// +// 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) DescribeServers(ctx context.Context, params *DescribeServersInput, optFns ...func(*Options)) (*DescribeServersOutput, error) { if params == nil { @@ -50,21 +54,25 @@ type DescribeServersOutput struct { // This is not currently implemented for DescribeServers requests. NextToken *string - // Contains the response to a DescribeServers request. For Chef Automate servers: - // If DescribeServersResponse$Servers$EngineAttributes includes - // CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef - // Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must - // have had at least one successful maintenance run after November 1, 2019. For - // Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the - // following two responses: + // Contains the response to a DescribeServers request. + // + // For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes + // includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server + // to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 + // must 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 certificate revocation list, see [Man Page: puppet certificate_revocation_list]in the Puppet documentation. + // + // [Man Page: puppet certificate_revocation_list]: https://puppet.com/docs/puppet/5.5/man/certificate_revocation_list.html 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 8f919b7c37f..b62a33d59c7 100644 --- a/service/opsworkscm/api_op_DisassociateNode.go +++ b/service/opsworkscm/api_op_DisassociateNode.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a node from an AWS OpsWorks CM server, and removes the node from +// 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 -// 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 -// request are not valid. +// 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 request are not valid. func (c *Client) DisassociateNode(ctx context.Context, params *DisassociateNodeInput, optFns ...func(*Options)) (*DisassociateNodeOutput, error) { if params == nil { params = &DisassociateNodeInput{} @@ -47,7 +49,10 @@ 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 + // 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 diff --git a/service/opsworkscm/api_op_ExportServerEngineAttribute.go b/service/opsworkscm/api_op_ExportServerEngineAttribute.go index 2d4ef7ee5f0..8de4091b6d1 100644 --- a/service/opsworkscm/api_op_ExportServerEngineAttribute.go +++ b/service/opsworkscm/api_op_ExportServerEngineAttribute.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports a specified server engine attribute as a base64-encoded string. For +// Exports a specified server engine attribute as a base64-encoded string. For +// // example, you can export user data that you can use in EC2 to associate nodes -// with a server. This operation is synchronous. A ValidationException is raised -// when parameters of the request are not valid. A ResourceNotFoundException is -// thrown when the server does not exist. An InvalidStateException is thrown when -// the server is in any of the following states: CREATING, TERMINATED, FAILED or -// DELETING. +// with a server. +// +// This operation is synchronous. +// +// A ValidationException is raised when parameters of the request are not valid. A +// ResourceNotFoundException is thrown when the server does not exist. An +// InvalidStateException is thrown when the server is in any of the following +// states: CREATING, TERMINATED, FAILED or DELETING. func (c *Client) ExportServerEngineAttribute(ctx context.Context, params *ExportServerEngineAttributeInput, optFns ...func(*Options)) (*ExportServerEngineAttributeOutput, error) { if params == nil { params = &ExportServerEngineAttributeInput{} @@ -51,13 +55,17 @@ type ExportServerEngineAttributeInput struct { // 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 diff --git a/service/opsworkscm/api_op_RestoreServer.go b/service/opsworkscm/api_op_RestoreServer.go index 21108fce431..7bbf38b2d93 100644 --- a/service/opsworkscm/api_op_RestoreServer.go +++ b/service/opsworkscm/api_op_RestoreServer.go @@ -11,19 +11,24 @@ 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 -// is performed by creating a new EC2 instance. If restoration is successful, and -// the server is in a HEALTHY state, AWS OpsWorks CM switches traffic over to the -// new instance. After restoration is finished, the old EC2 instance is maintained -// in a Running or Stopped state, but is eventually terminated. This operation is -// asynchronous. An InvalidStateException is thrown when the server is not in a -// valid state. A ResourceNotFoundException is thrown when the server does not -// exist. A ValidationException is raised when parameters of the request are not -// valid. +// server's client devices (nodes) should continue to work. +// +// Restoring from a backup is performed by creating a new EC2 instance. If +// restoration is successful, and the server is in a HEALTHY state, AWS OpsWorks +// CM switches traffic over to the new instance. After restoration is finished, the +// old EC2 instance is maintained in a Running or Stopped state, but is eventually +// terminated. +// +// This operation is asynchronous. +// +// An InvalidStateException is thrown when the server is not in a valid state. 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) RestoreServer(ctx context.Context, params *RestoreServerInput, optFns ...func(*Options)) (*RestoreServerOutput, error) { if params == nil { params = &RestoreServerInput{} @@ -41,24 +46,24 @@ func (c *Client) RestoreServer(ctx context.Context, params *RestoreServerInput, type RestoreServerInput struct { - // The ID of the backup that you want to use to restore a server. + // The ID of the backup that you want to use to restore a server. // // This member is required. BackupId *string - // The name of the server that you want to restore. + // The name of the server that you want to restore. // // This member is required. ServerName *string - // The type of instance to restore. Valid values must be specified in the + // 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 - // the administrator no longer has the SSH key. + // The name of the key pair to set on the new EC2 instance. This can be helpful + // if the administrator no longer has the SSH key. KeyPair *string noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_StartMaintenance.go b/service/opsworkscm/api_op_StartMaintenance.go index 43a61e5b5a2..4ad498f1cdb 100644 --- a/service/opsworkscm/api_op_StartMaintenance.go +++ b/service/opsworkscm/api_op_StartMaintenance.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Manually starts server maintenance. This command can be useful if an earlier +// Manually starts server maintenance. This command can be useful if an earlier +// // maintenance attempt failed, and the underlying cause of maintenance failure has // been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is -// in progress. Maintenance can only be started on servers in HEALTHY and UNHEALTHY -// states. Otherwise, an InvalidStateException is thrown. A -// ResourceNotFoundException is thrown when the server does not exist. A -// ValidationException is raised when parameters of the request are not valid. +// in progress. +// +// Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. +// Otherwise, an InvalidStateException is thrown. 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) StartMaintenance(ctx context.Context, params *StartMaintenanceInput, optFns ...func(*Options)) (*StartMaintenanceOutput, error) { if params == nil { params = &StartMaintenanceInput{} @@ -41,13 +44,16 @@ type StartMaintenanceInput struct { ServerName *string // Engine attributes that are specific to the server on which you want to run - // maintenance. Attributes accepted in a StartMaintenance request for Chef + // 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) - // . + // information, see [Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2]. + // + // [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 f7aab975ee0..abc550cfb0c 100644 --- a/service/opsworkscm/api_op_TagResource.go +++ b/service/opsworkscm/api_op_TagResource.go @@ -40,14 +40,19 @@ type TagResourceInput struct { // 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. // diff --git a/service/opsworkscm/api_op_UpdateServer.go b/service/opsworkscm/api_op_UpdateServer.go index eae238f82bf..b9ee8bdf163 100644 --- a/service/opsworkscm/api_op_UpdateServer.go +++ b/service/opsworkscm/api_op_UpdateServer.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates settings for a server. This operation is synchronous. +// Updates settings for a server. +// +// This operation is synchronous. func (c *Client) UpdateServer(ctx context.Context, params *UpdateServerInput, optFns ...func(*Options)) (*UpdateServerOutput, error) { if params == nil { params = &UpdateServerInput{} @@ -41,14 +43,16 @@ type UpdateServerInput struct { // Automated backups are enabled by default. 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 . + // 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 . 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 . + // 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 . PreferredMaintenanceWindow *string noSmithyDocumentSerde diff --git a/service/opsworkscm/api_op_UpdateServerEngineAttributes.go b/service/opsworkscm/api_op_UpdateServerEngineAttributes.go index b54074882de..9071d550d27 100644 --- a/service/opsworkscm/api_op_UpdateServerEngineAttributes.go +++ b/service/opsworkscm/api_op_UpdateServerEngineAttributes.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 ( +// 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 -// ValidationException is raised when parameters of the request are not valid. +// ). +// +// 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 { params = &UpdateServerEngineAttributesInput{} diff --git a/service/opsworkscm/doc.go b/service/opsworkscm/doc.go index dbaafdcdb95..d4fd51621ab 100644 --- a/service/opsworkscm/doc.go +++ b/service/opsworkscm/doc.go @@ -3,11 +3,15 @@ // 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. +// # 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 @@ -15,34 +19,54 @@ // 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. +// # 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. +// For more information, see [AWS OpsWorks endpoints and quotas] 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 endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html package opsworkscm diff --git a/service/opsworkscm/options.go b/service/opsworkscm/options.go index e70c2ac0ffb..e30b4f50797 100644 --- a/service/opsworkscm/options.go +++ b/service/opsworkscm/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/opsworkscm/types/enums.go b/service/opsworkscm/types/enums.go index 2e9e9495532..36de25dff72 100644 --- a/service/opsworkscm/types/enums.go +++ b/service/opsworkscm/types/enums.go @@ -13,8 +13,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for BackupType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackupType) Values() []BackupType { return []BackupType{ "AUTOMATED", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for MaintenanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceStatus) Values() []MaintenanceStatus { return []MaintenanceStatus{ "SUCCESS", @@ -70,8 +73,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SUCCESS", @@ -100,8 +104,9 @@ const ( ) // 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. +// expanded in the future, and so 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 eb0ee00d520..7b90980746e 100644 --- a/service/opsworkscm/types/types.go +++ b/service/opsworkscm/types/types.go @@ -10,17 +10,19 @@ import ( // Stores account attributes. type AccountAttribute struct { - // The maximum allowed value. + // The maximum allowed value. Maximum *int32 - // The attribute name. The following are supported attribute names. + // 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. Name *string - // The current usage, such as the current number of servers that are associated + // The current usage, such as the current number of servers that are associated // with the account. Used *int32 @@ -33,86 +35,87 @@ type Backup struct { // The ARN of the backup. BackupArn *string - // The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS + // 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: + // The time stamp when the backup was created in the database. Example: // 2016-07-29T13:38:47.520Z CreatedAt *time.Time - // A user-provided description for a manual backup. This field is empty for + // A user-provided description for a manual backup. This field is empty for // automated backups. Description *string - // The engine type that is obtained from the server when the backup is created. + // The engine type that is obtained from the server when the backup is created. Engine *string - // The engine model that is obtained from the server when the backup is created. + // The engine model that is obtained from the server when the backup is created. EngineModel *string - // The engine version that is obtained from the server when the backup is created. + // 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 + // 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 - // The instance type that is obtained from the server when the backup is created. + // The instance type that is obtained from the server when the backup is created. InstanceType *string - // The key pair that is obtained from the server when the backup is created. + // The key pair that is obtained from the server when the backup is created. KeyPair *string - // The preferred backup period that is obtained from the server when the backup is - // created. + // The preferred backup period that is obtained from the server when the backup + // is created. PreferredBackupWindow *string - // The preferred maintenance period that is obtained from the server when the + // The preferred maintenance period that is obtained from the server when the // backup is created. PreferredMaintenanceWindow *string - // This field is deprecated and is no longer used. + // This field is deprecated and is no longer used. // // Deprecated: This member has been deprecated. S3DataSize *int32 - // This field is deprecated and is no longer used. + // This field is deprecated and is no longer used. // // Deprecated: This member has been deprecated. S3DataUrl *string - // The Amazon S3 URL of the backup's log file. + // The Amazon S3 URL of the backup's log file. S3LogUrl *string - // The security group IDs that are obtained from the server when the backup is + // The security group IDs that are obtained from the server when the backup is // created. SecurityGroupIds []string - // The name of the server from which the backup was made. + // The name of the server from which the backup was made. ServerName *string - // The service role ARN that is obtained from the server when the backup is + // The service role ARN that is obtained from the server when the backup is // created. ServiceRoleArn *string // The status of a backup while in progress. Status BackupStatus - // An informational message about backup status. + // An informational message about backup status. StatusDescription *string - // The subnet IDs that are obtained from the server when the backup is created. + // The subnet IDs that are obtained from the server when the backup is created. SubnetIds []string - // The version of AWS OpsWorks CM-specific tools that is obtained from the server + // The version of AWS OpsWorks CM-specific tools that is obtained from the server // when the backup is created. ToolsVersion *string - // The IAM user ARN of the requester for manual backups. This field is empty for + // The IAM user ARN of the requester for manual backups. This field is empty for // automated backups. UserArn *string @@ -155,7 +158,7 @@ type Server struct { // value of PreferredBackupCount. DisableAutomatedBackup *bool - // A DNS name that can be used to access the engine. Example: + // 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 // the Endpoint value if the server has a CustomDomain specified. Endpoint *string @@ -167,20 +170,26 @@ type Server struct { // 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. EngineAttributes []EngineAttribute @@ -190,13 +199,14 @@ 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. + // 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 @@ -212,7 +222,7 @@ 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 + // 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 @@ -226,17 +236,17 @@ 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, + // 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 + // Depending on the server status, this field has either a human-readable message // (such as a create or backup error), or an escaped block of JSON (used for health // check results). StatusReason *string - // The subnet IDs specified in a CreateServer request. + // The subnet IDs specified in a CreateServer request. SubnetIds []string noSmithyDocumentSerde diff --git a/service/organizations/api_op_AcceptHandshake.go b/service/organizations/api_op_AcceptHandshake.go index cc95ac9239b..91e297ad973 100644 --- a/service/organizations/api_op_AcceptHandshake.go +++ b/service/organizations/api_op_AcceptHandshake.go @@ -12,26 +12,37 @@ 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: +// 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_integrate_services-using_slrs) -// 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. +// 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]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]in the Organizations User Guide. +// +// For more information about requests to enable all features in the organization, +// see [Enabling all features in your organization]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. +// +// [Inviting an Amazon Web Services account to join your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html +// +// [Enabling all features in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html +// [Organizations and service-linked roles]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integration_services.html#orgs_integrate_services-using_slrs func (c *Client) AcceptHandshake(ctx context.Context, params *AcceptHandshakeInput, optFns ...func(*Options)) (*AcceptHandshakeOutput, error) { if params == nil { params = &AcceptHandshakeInput{} @@ -49,9 +60,12 @@ func (c *Client) AcceptHandshake(ctx context.Context, params *AcceptHandshakeInp type AcceptHandshakeInput struct { - // The unique identifier (ID) of the handshake that you want to accept. 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 accept. + // + // The [regex pattern] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. HandshakeId *string diff --git a/service/organizations/api_op_AttachPolicy.go b/service/organizations/api_op_AttachPolicy.go index dfcaa0d971f..04c1c8f79f0 100644 --- a/service/organizations/api_op_AttachPolicy.go +++ b/service/organizations/api_op_AttachPolicy.go @@ -13,14 +13,23 @@ 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] +// +// [BACKUP_POLICY] +// +// [SERVICE_CONTROL_POLICY] +// +// [TAG_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. +// +// [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 func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error) { if params == nil { params = &AttachPolicyInput{} @@ -39,26 +48,33 @@ func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, op type AttachPolicyInput struct { // The unique identifier (ID) of the policy that you want to attach to the target. - // You can get the ID for the policy by calling the ListPolicies operation. 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 (_). + // You can get the ID for the policy by calling the ListPoliciesoperation. + // + // The [regex pattern] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. 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: + // the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. TargetId *string diff --git a/service/organizations/api_op_CancelHandshake.go b/service/organizations/api_op_CancelHandshake.go index f8b8fef20f4..7fe7b1be3cf 100644 --- a/service/organizations/api_op_CancelHandshake.go +++ b/service/organizations/api_op_CancelHandshake.go @@ -11,13 +11,15 @@ 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 -// 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 -// appear in the results of relevant APIs for only 30 days. After that, it's -// deleted. +// 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 DeclineHandshakeinstead. +// After a handshake is canceled, the recipient can no longer respond to that +// handshake. +// +// After you cancel a handshake, it continues to appear in the results of relevant +// APIs for only 30 days. After that, it's deleted. func (c *Client) CancelHandshake(ctx context.Context, params *CancelHandshakeInput, optFns ...func(*Options)) (*CancelHandshakeOutput, error) { if params == nil { params = &CancelHandshakeInput{} @@ -36,9 +38,12 @@ 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. + // get the ID from the ListHandshakesForOrganizationoperation. + // + // The [regex pattern] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. HandshakeId *string diff --git a/service/organizations/api_op_CloseAccount.go b/service/organizations/api_op_CloseAccount.go index 64dd6966227..0f0192c3cb6 100644 --- a/service/organizations/api_op_CloseAccount.go +++ b/service/organizations/api_op_CloseAccount.go @@ -11,40 +11,44 @@ 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 -// 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: +// close an account when [all features are enabled]. 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. +// parameter to the DescribeAccountoperation. // -// - 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. +// While the close account request is in progress, Account status will indicate // -// - You can close only 10% of member accounts, between 10 and 1000, 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. For more information, see Closing a member account in your -// organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) -// and Quotas for Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html) -// in the Organizations User Guide. +// PENDING_CLOSURE. When the close account request completes, the status will +// change to SUSPENDED. // -// - To reinstate a closed account, contact Amazon Web Services Support within -// the 90-day grace period while the account is in SUSPENDED status. +// - 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]in the Organizations 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. +// - You can close only 10% of member accounts, between 10 and 1000, 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. For more information, see [Closing a member account in your organization]and [Quotas for Organizations]in the Organizations 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. +// +// - 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]in the Amazon Web +// Services GovCloud User Guide. +// +// [all features are enabled]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html +// +// [Quotas for Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html +// [Logging and monitoring in Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration +// [Closing an Amazon Web Services GovCloud (US) account]: https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/Closing-govcloud-account.html +// [Closing a member account in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html func (c *Client) CloseAccount(ctx context.Context, params *CloseAccountInput, optFns ...func(*Options)) (*CloseAccountOutput, error) { if params == nil { params = &CloseAccountInput{} diff --git a/service/organizations/api_op_CreateAccount.go b/service/organizations/api_op_CreateAccount.go index b607cdd26af..8fd477f6c04 100644 --- a/service/organizations/api_op_CreateAccount.go +++ b/service/organizations/api_op_CreateAccount.go @@ -18,60 +18,68 @@ 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. +// operation to provide as a parameter to the DescribeCreateAccountStatusoperation. +// // - 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. +// on using CloudTrail with Organizations, see [Logging and monitoring in Organizations]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) -// 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 +// AWSServiceRoleForOrganizations . For more information, see [Organizations and service-linked roles] 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 // OrganizationAccountAccessRole by default) that grants users in the management // account administrator permissions in the new member account. Principals in the // management account can assume the role. Organizations clones the company name // 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 a member -// account in your organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) -// in the Organizations User Guide. +// account. +// +// This operation can be called only from the organization's management account. +// +// For more information about creating accounts, see [Creating a member account in your organization] 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. For more information, see Considerations before -// removing an account from an organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html) -// in the Organizations User Guide. +// the missing information. For more information, see [Considerations before removing an account from an organization]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#/) -// . +// limits for the organization, contact [Amazon Web Services Support]. +// // - 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#/) -// . +// the error persists, contact [Amazon Web Services Support]. +// // - 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 a member account in your -// organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) -// in the Organizations User Guide. +// process for closing an account, see [Closing a member account in your organization]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/control-access-billing.html#grantaccess) -// . +// how to disable this switch for an account, see [Granting access to your billing information and tools]. +// +// [Granting access to your billing information and tools]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/control-access-billing.html#grantaccess +// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/ +// [Logging and monitoring in Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html#orgs_cloudtrail-integration +// [Organizations and service-linked roles]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs +// [Creating a member account in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html +// [Considerations before removing an account from an organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html +// [Closing a member account in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html func (c *Client) CreateAccount(ctx context.Context, params *CreateAccountInput, optFns ...func(*Options)) (*CreateAccountOutput, error) { if params == nil { params = &CreateAccountInput{} @@ -96,19 +104,30 @@ type CreateAccountInput struct { // The email address of the owner to assign to the new member account. 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: + // 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 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. // @@ -118,37 +137,52 @@ type CreateAccountInput struct { // 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 About IAM 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 - // with the required permissions can access billing information for the new - // account. + // information, see [About IAM access to the Billing and Cost Management console]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 with the required permissions can access billing information for the + // new account. + // + // [About IAM access to the Billing and Cost Management console]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate IamUserAccessToBilling types.IAMUserAccessToBilling // The name of an IAM role that Organizations automatically preconfigures in the // new member account. This role trusts the 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 how to use this role - // to access the member account, see the following links: - // - Creating the OrganizationAccountAccessRole in an invited member account (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 IAM 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: =,.@- + // account. + // + // If you don't specify this parameter, the role name defaults to + // OrganizationAccountAccessRole . + // + // For more information about how to use this role to access the member account, + // see the following links: + // + // [Creating the OrganizationAccountAccessRole in an invited member account] + // - in the Organizations User Guide + // + // - Steps 2 and 3 in [IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles]in the IAM User Guide + // + // The [regex pattern] 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: =,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [Creating the OrganizationAccountAccessRole in an invited member account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role + // [IAM 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 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) - // 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. + // about tagging, see [Tagging Organizations resources]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. + // + // [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -159,11 +193,12 @@ type CreateAccountOutput struct { // A structure that contains details about the request to create an account. This // response structure might not be fully populated when you first receive it // because account creation is an asynchronous process. You can pass the returned - // 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 - // Logging and monitoring in Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html) - // in the Organizations User Guide. + // 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 [Logging and monitoring in Organizations] in the Organizations User + // Guide. + // + // [Logging and monitoring in Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html CreateAccountStatus *types.CreateAccountStatus // Metadata pertaining to the operation's result. diff --git a/service/organizations/api_op_CreateGovCloudAccount.go b/service/organizations/api_op_CreateGovCloudAccount.go index b493506fde5..fa48f552695 100644 --- a/service/organizations/api_op_CreateGovCloudAccount.go +++ b/service/organizations/api_op_CreateGovCloudAccount.go @@ -12,99 +12,118 @@ 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) +// Region, see the [Amazon Web Services GovCloud User Guide.] +// // - 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) -// 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: +// AWSServiceRoleForOrganizations . For more information, see [Organizations and service-linked roles] 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. +// +// - Create an Amazon S3 bucket for CloudTrail log storage. +// +// For more information, see [Verifying CloudTrail Is Enabled]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. -// 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: +// itself. To add tags to the GovCloud account, call the TagResourceoperation 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]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: // // - Use the OperationId response element from this operation to provide as a -// parameter to the DescribeCreateAccountStatus operation. +// parameter to the DescribeCreateAccountStatusoperation. +// // - 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) -// in the Organizations User Guide. +// on using CloudTrail with Organizations, see [Logging and monitoring in Organizations]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) -// in the Amazon Web Services GovCloud User Guide. For more information about -// creating accounts, see Creating a member account in your organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html) -// in the Organizations User Guide. +// 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]in the Amazon Web Services GovCloud User +// Guide. +// +// For more information about creating accounts, see [Creating a member account in your organization] 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. For more information, see Considerations -// before removing an account from an organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html) -// in the Organizations User Guide. +// provide the missing information. For more information, see [Considerations before removing an account from an organization]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#/) -// . +// limits for the organization, contact [Amazon Web Services Support]. +// // - 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#/) -// . +// the error persists, contact [Amazon Web Services Support]. +// // - 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 a member account in your organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html) -// in the Organizations User Guide. +// information on the requirements and process for closing an account, see [Closing a member account in your organization]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) -// . +// how to disable this switch for an account, see [Granting access to your billing information and tools]. +// +// [Granting access to your billing information and tools]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html +// [Verifying CloudTrail Is Enabled]: https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/verifying-cloudtrail.html +// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/ +// [Logging and monitoring in Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_security_incident-response.html +// [Organizations]: https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html +// [Organizations and service-linked roles]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs +// [Creating a member account in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html +// [Considerations before removing an account from an organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html +// [Amazon Web Services GovCloud User Guide.]: https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/welcome.html +// [Closing a member account in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html func (c *Client) CreateGovCloudAccount(ctx context.Context, params *CreateGovCloudAccountInput, optFns ...func(*Options)) (*CreateGovCloudAccountOutput, error) { if params == nil { params = &CreateGovCloudAccountInput{} @@ -122,9 +141,10 @@ func (c *Client) CreateGovCloudAccount(ctx context.Context, params *CreateGovClo type CreateGovCloudAccountInput struct { - // The friendly name of the member account. The account name can consist of only - // the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate - // characters with a dash (–). + // The friendly name of the member account. + // + // The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen + // (-), or dot (.) You can't separate characters with a dash (–). // // This member is required. AccountName *string @@ -132,18 +152,30 @@ type CreateGovCloudAccountInput struct { // Specifies the email address of the owner to assign to the new member account in // 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: + // 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 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 @@ -156,42 +188,59 @@ type CreateGovCloudAccountInput struct { // 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 - // account billing information. For more information, see About IAM 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 - // with the required permissions can access billing information for the new - // account. + // account billing information. For more information, see [About IAM access to the Billing and Cost Management console]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 with the required permissions can access billing information for the + // new account. + // + // [About IAM access to the Billing and Cost Management console]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate IamUserAccessToBilling types.IAMUserAccessToBilling - // (Optional) The name of an IAM role that Organizations automatically - // preconfigures in the new member accounts in both the Amazon Web Services - // GovCloud (US) Region and in the commercial Region. This role trusts the - // 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 - // how to use this role to access the member account, see the following links: - // - Creating the OrganizationAccountAccessRole in an invited member account (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 IAM 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: =,.@- + // (Optional) + // + // The name of an IAM role that Organizations automatically preconfigures in the + // new member accounts in both the Amazon Web Services GovCloud (US) Region and in + // the commercial Region. This role trusts the 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 how to use this role to access the member account, + // see the following links: + // + // [Creating the OrganizationAccountAccessRole in an invited member account] + // - in the Organizations User Guide + // + // - Steps 2 and 3 in [IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles]in the IAM User Guide + // + // The [regex pattern] 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: =,.@- + // + // [regex pattern]: http://wikipedia.org/wiki/regex + // [Creating the OrganizationAccountAccessRole in an invited member account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role + // [IAM 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 RoleName *string // A list of tags that you want to attach to the newly created account. These tags // are attached to the commercial account associated with the GovCloud account, and // 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) - // 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. + // call the TagResourceoperation 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]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. + // + // [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -199,9 +248,8 @@ type CreateGovCloudAccountInput struct { type CreateGovCloudAccountOutput struct { - // Contains the status about a CreateAccount or CreateGovCloudAccount request to - // create an Amazon Web Services account or an Amazon Web Services GovCloud (US) - // account in an organization. + // Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services + // account or an Amazon Web Services GovCloud (US) account in an organization. CreateAccountStatus *types.CreateAccountStatus // Metadata pertaining to the operation's result. diff --git a/service/organizations/api_op_CreateOrganization.go b/service/organizations/api_op_CreateOrganization.go index 0fb59c09a92..ecc16b1a973 100644 --- a/service/organizations/api_op_CreateOrganization.go +++ b/service/organizations/api_op_CreateOrganization.go @@ -12,16 +12,21 @@ 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) -// 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 -// 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. +// the CreateOrganization operation automatically becomes the [management 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 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. +// +// [management account]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account func (c *Client) CreateOrganization(ctx context.Context, params *CreateOrganizationInput, optFns ...func(*Options)) (*CreateOrganizationOutput, error) { if params == nil { params = &CreateOrganizationInput{} @@ -41,15 +46,21 @@ 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. + // and paid by the management account. For more information, see [Consolidated billing]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. + // account in the organization. For more information, see [All features]in the Organizations + // User Guide. + // + // [All features]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all + // [Consolidated billing]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only FeatureSet types.OrganizationFeatureSet noSmithyDocumentSerde diff --git a/service/organizations/api_op_CreateOrganizationalUnit.go b/service/organizations/api_op_CreateOrganizationalUnit.go index cd84bc2c218..50c3fc6c987 100644 --- a/service/organizations/api_op_CreateOrganizationalUnit.go +++ b/service/organizations/api_op_CreateOrganizationalUnit.go @@ -15,11 +15,16 @@ import ( // container for accounts that enables you to organize your accounts to apply // 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 (OUs) (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. +// service control policies, the limit is five. +// +// For more information about OUs, see [Managing organizational units (OUs)] 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. +// +// [Managing organizational units (OUs)]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html func (c *Client) CreateOrganizationalUnit(ctx context.Context, params *CreateOrganizationalUnitInput, optFns ...func(*Options)) (*CreateOrganizationalUnitOutput, error) { if params == nil { params = &CreateOrganizationalUnitInput{} @@ -43,25 +48,32 @@ type CreateOrganizationalUnitInput struct { Name *string // 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: + // new OU in. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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) - // 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. + // tagging, see [Tagging Organizations resources]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. + // + // [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/organizations/api_op_CreatePolicy.go b/service/organizations/api_op_CreatePolicy.go index d72d703c3ba..7f72a5fb972 100644 --- a/service/organizations/api_op_CreatePolicy.go +++ b/service/organizations/api_op_CreatePolicy.go @@ -12,12 +12,18 @@ 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 Organizations 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 or by a member account that is a delegated -// administrator for an Amazon Web Services service. +// organizational unit (OU), or an individual Amazon Web Services account. +// +// For more information about policies and their use, see [Managing Organizations policies]. +// +// 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 or +// by a member account that is a delegated administrator for an Amazon Web Services +// service. +// +// [Managing Organizations policies]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { if params == nil { params = &CreatePolicyInput{} @@ -36,10 +42,12 @@ func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, op type CreatePolicyInput struct { // The policy text content to add to the new policy. The text that you supply must - // adhere to the rules of the policy type you specify in the Type parameter. The - // maximum size of a policy document depends on the policy's type. For more - // information, see Maximum and minimum values (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html#min-max-values) - // in the Organizations User Guide. + // adhere to the rules of the policy type you specify in the Type parameter. + // + // The maximum size of a policy document depends on the policy's type. For more + // information, see [Maximum and minimum values]in the Organizations User Guide. + // + // [Maximum and minimum values]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html#min-max-values // // This member is required. Content *string @@ -49,18 +57,30 @@ 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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] + // + // [BACKUP_POLICY] + // + // [SERVICE_CONTROL_POLICY] + // + // [TAG_POLICY] + // + // [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 @@ -68,10 +88,12 @@ type CreatePolicyInput struct { // 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. + // about tagging, see [Tagging Organizations resources]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. + // + // [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/organizations/api_op_DeclineHandshake.go b/service/organizations/api_op_DeclineHandshake.go index 410bb8f7712..22b07c9c54b 100644 --- a/service/organizations/api_op_DeclineHandshake.go +++ b/service/organizations/api_op_DeclineHandshake.go @@ -12,12 +12,15 @@ import ( ) // Declines a handshake request. This sets the handshake state to DECLINED and -// effectively deactivates the request. This operation can be called only from the -// account that received the handshake. The originator of the handshake can use -// CancelHandshake instead. The originator can't reactivate a declined request, but -// can reinitiate the process with a new handshake request. After you decline a -// handshake, it continues to appear in the results of relevant APIs for only 30 -// days. After that, it's deleted. +// effectively deactivates the request. +// +// This operation can be called only from the account that received the handshake. +// The originator of the handshake can use CancelHandshakeinstead. The originator can't +// reactivate a declined request, but can reinitiate the process with a new +// handshake request. +// +// After you decline a handshake, it continues to appear in the results of +// relevant APIs for only 30 days. After that, it's deleted. func (c *Client) DeclineHandshake(ctx context.Context, params *DeclineHandshakeInput, optFns ...func(*Options)) (*DeclineHandshakeOutput, error) { if params == nil { params = &DeclineHandshakeInput{} @@ -36,9 +39,12 @@ 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 ListHandshakesForAccountoperation. + // + // The [regex pattern] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. HandshakeId *string diff --git a/service/organizations/api_op_DeleteOrganizationalUnit.go b/service/organizations/api_op_DeleteOrganizationalUnit.go index 490179bbeff..98b06151334 100644 --- a/service/organizations/api_op_DeleteOrganizationalUnit.go +++ b/service/organizations/api_op_DeleteOrganizationalUnit.go @@ -11,8 +11,9 @@ import ( ) // Deletes an organizational unit (OU) from a root or another OU. You must first -// remove all accounts and child OUs from the OU that you want to delete. This -// operation can be called only from the organization's management account. +// remove all accounts and child OUs from the OU that you want to delete. +// +// This operation can be called only from the organization's management account. func (c *Client) DeleteOrganizationalUnit(ctx context.Context, params *DeleteOrganizationalUnitInput, optFns ...func(*Options)) (*DeleteOrganizationalUnitOutput, error) { if params == nil { params = &DeleteOrganizationalUnitInput{} @@ -31,11 +32,14 @@ func (c *Client) DeleteOrganizationalUnit(ctx context.Context, params *DeleteOrg type DeleteOrganizationalUnitInput struct { // The unique identifier (ID) of the organizational unit that you want to delete. - // 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. + // You can get the ID from the ListOrganizationalUnitsForParentoperation. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. OrganizationalUnitId *string diff --git a/service/organizations/api_op_DeletePolicy.go b/service/organizations/api_op_DeletePolicy.go index de384a710a8..a2065909b67 100644 --- a/service/organizations/api_op_DeletePolicy.go +++ b/service/organizations/api_op_DeletePolicy.go @@ -12,9 +12,11 @@ import ( // Deletes the specified policy from your organization. Before you perform this // operation, you must first detach the policy from all organizational units (OUs), -// roots, and accounts. 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. +// roots, and accounts. +// +// 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) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} @@ -33,10 +35,12 @@ func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, op type DeletePolicyInput struct { // The unique identifier (ID) of the policy that you want to delete. 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 (_). + // the ID from the ListPoliciesor ListPoliciesForTarget operations. + // + // The [regex pattern] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyId *string diff --git a/service/organizations/api_op_DeleteResourcePolicy.go b/service/organizations/api_op_DeleteResourcePolicy.go index 3130905c8e5..e250582feac 100644 --- a/service/organizations/api_op_DeleteResourcePolicy.go +++ b/service/organizations/api_op_DeleteResourcePolicy.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the resource policy from your organization. You can only call this -// operation from the organization's management account. +// Deletes the resource policy from your organization. +// +// You can only call this operation from the organization's management account. func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { params = &DeleteResourcePolicyInput{} diff --git a/service/organizations/api_op_DeregisterDelegatedAdministrator.go b/service/organizations/api_op_DeregisterDelegatedAdministrator.go index ca75b8aac92..89240fafd41 100644 --- a/service/organizations/api_op_DeregisterDelegatedAdministrator.go +++ b/service/organizations/api_op_DeregisterDelegatedAdministrator.go @@ -11,16 +11,20 @@ import ( ) // Removes the specified member Amazon Web Services account as a delegated -// administrator for the specified Amazon Web Services service. Deregistering a -// delegated administrator can have unintended impacts on the functionality of the -// enabled Amazon Web Services service. See the documentation for the enabled -// service before you deregister a delegated administrator so that you understand -// 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) -// in the Organizations User Guide. This operation can be called only from the -// organization's management account. +// administrator for the specified Amazon Web Services service. +// +// Deregistering a delegated administrator can have unintended impacts on the +// functionality of the enabled Amazon Web Services service. See the documentation +// for the enabled service before you deregister a delegated administrator so that +// you understand 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]in the Organizations User Guide. +// +// This operation can be called only from the organization's management account. +// +// [Amazon Web Services Services that you can use with Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html func (c *Client) DeregisterDelegatedAdministrator(ctx context.Context, params *DeregisterDelegatedAdministratorInput, optFns ...func(*Options)) (*DeregisterDelegatedAdministratorOutput, error) { if params == nil { params = &DeregisterDelegatedAdministratorInput{} @@ -45,11 +49,12 @@ type DeregisterDelegatedAdministratorInput struct { AccountId *string // The service principal name of an Amazon Web Services service for which the - // account is a delegated administrator. Delegated administrator privileges are - // revoked for only the specified Amazon Web Services service from the member - // account. If the specified service is the only service for which the member - // account is a delegated administrator, the operation also revokes Organizations - // read action permissions. + // account is a delegated administrator. + // + // Delegated administrator privileges are revoked for only the specified Amazon + // Web Services service from the member account. If the specified service is the + // only service for which the member account is a delegated administrator, the + // operation also revokes Organizations read action permissions. // // This member is required. ServicePrincipal *string diff --git a/service/organizations/api_op_DescribeAccount.go b/service/organizations/api_op_DescribeAccount.go index d43b4204b43..bb3006faf92 100644 --- a/service/organizations/api_op_DescribeAccount.go +++ b/service/organizations/api_op_DescribeAccount.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves Organizations-related information about the specified account. 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 +// Retrieves Organizations-related information about the specified account. +// +// 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) DescribeAccount(ctx context.Context, params *DescribeAccountInput, optFns ...func(*Options)) (*DescribeAccountOutput, error) { if params == nil { @@ -33,9 +34,11 @@ func (c *Client) DescribeAccount(ctx context.Context, params *DescribeAccountInp 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. + // information about. You can get the ID from the ListAccountsor ListAccountsForParent operations. + // + // The [regex pattern] for an account ID string requires exactly 12 digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountId *string diff --git a/service/organizations/api_op_DescribeCreateAccountStatus.go b/service/organizations/api_op_DescribeCreateAccountStatus.go index 324681f6a95..edf2eb8dc7a 100644 --- a/service/organizations/api_op_DescribeCreateAccountStatus.go +++ b/service/organizations/api_op_DescribeCreateAccountStatus.go @@ -12,6 +12,7 @@ import ( ) // Retrieves the current status of an asynchronous request to create an account. +// // 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. @@ -33,10 +34,13 @@ func (c *Client) DescribeCreateAccountStatus(ctx context.Context, params *Descri type DescribeCreateAccountStatusInput struct { // Specifies the Id value that uniquely identifies the CreateAccount request. You - // can get the value from the CreateAccountStatus.Id response in an earlier - // CreateAccount request, or from the ListCreateAccountStatus operation. 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. + // can get the value from the CreateAccountStatus.Id response in an earlier CreateAccount + // request, or from the ListCreateAccountStatusoperation. + // + // The [regex pattern] for a create account request ID string requires "car-" followed by from 8 + // to 32 lowercase letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. CreateAccountRequestId *string diff --git a/service/organizations/api_op_DescribeEffectivePolicy.go b/service/organizations/api_op_DescribeEffectivePolicy.go index 349d3881221..ceec65540dd 100644 --- a/service/organizations/api_op_DescribeEffectivePolicy.go +++ b/service/organizations/api_op_DescribeEffectivePolicy.go @@ -14,11 +14,17 @@ import ( // Returns the contents of the effective policy for specified policy type and // account. The effective policy is the aggregation of any policies of the // 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 Understanding management policy inheritance (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_inheritance_mgmt.html) -// in the Organizations User Guide. This operation can be called from any account -// in the organization. +// 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 [Understanding management policy inheritance] in the Organizations User +// Guide. +// +// This operation can be called from any account in the organization. +// +// [Understanding management policy inheritance]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_inheritance_mgmt.html func (c *Client) DescribeEffectivePolicy(ctx context.Context, params *DescribeEffectivePolicyInput, optFns ...func(*Options)) (*DescribeEffectivePolicyOutput, error) { if params == nil { params = &DescribeEffectivePolicyInput{} @@ -38,9 +44,16 @@ 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] + // + // [BACKUP_POLICY] + // + // [TAG_POLICY] + // + // [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 ec59d306f17..a9e2f1bfd68 100644 --- a/service/organizations/api_op_DescribeHandshake.go +++ b/service/organizations/api_op_DescribeHandshake.go @@ -12,11 +12,13 @@ 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. +// comes from the response to the original InviteAccountToOrganizationoperation 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{} @@ -35,10 +37,12 @@ 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. + // You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization. + // + // The [regex pattern] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. HandshakeId *string diff --git a/service/organizations/api_op_DescribeOrganization.go b/service/organizations/api_op_DescribeOrganization.go index ce11fba1640..975e763b3b0 100644 --- a/service/organizations/api_op_DescribeOrganization.go +++ b/service/organizations/api_op_DescribeOrganization.go @@ -11,11 +11,13 @@ 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 -// 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 -// status of policy types for a specified root. +// 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 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 { params = &DescribeOrganizationInput{} @@ -37,11 +39,12 @@ type DescribeOrganizationInput struct { type DescribeOrganizationOutput struct { - // A structure that contains information about the organization. The - // AvailablePolicyTypes part of the response is deprecated, and you shouldn't use - // it in your apps. It doesn't include any policy type supported by Organizations - // other than SCPs. To determine which policy types are enabled in your - // organization, use the ListRoots operation. + // A structure that contains information about the organization. + // + // The AvailablePolicyTypes part of the response is deprecated, and you shouldn't + // use it in your apps. It doesn't include any policy type supported by + // Organizations other than SCPs. To determine which policy types are enabled in + // your organization, use the ListRootsoperation. Organization *types.Organization // Metadata pertaining to the operation's result. diff --git a/service/organizations/api_op_DescribeOrganizationalUnit.go b/service/organizations/api_op_DescribeOrganizationalUnit.go index 5083afdc862..14cb9f2acdd 100644 --- a/service/organizations/api_op_DescribeOrganizationalUnit.go +++ b/service/organizations/api_op_DescribeOrganizationalUnit.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about an organizational unit (OU). 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. +// Retrieves information about an organizational unit (OU). +// +// 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) DescribeOrganizationalUnit(ctx context.Context, params *DescribeOrganizationalUnitInput, optFns ...func(*Options)) (*DescribeOrganizationalUnitOutput, error) { if params == nil { params = &DescribeOrganizationalUnitInput{} @@ -32,11 +34,14 @@ func (c *Client) DescribeOrganizationalUnit(ctx context.Context, params *Describ type DescribeOrganizationalUnitInput struct { // The unique identifier (ID) of the organizational unit that you want details - // about. 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. + // about. You can get the ID from the ListOrganizationalUnitsForParentoperation. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. OrganizationalUnitId *string diff --git a/service/organizations/api_op_DescribePolicy.go b/service/organizations/api_op_DescribePolicy.go index 557669bd51a..99b5c9ae6fa 100644 --- a/service/organizations/api_op_DescribePolicy.go +++ b/service/organizations/api_op_DescribePolicy.go @@ -11,9 +11,11 @@ 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 -// administrator for an Amazon Web Services service. +// 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 { params = &DescribePolicyInput{} @@ -32,10 +34,12 @@ func (c *Client) DescribePolicy(ctx context.Context, params *DescribePolicyInput type DescribePolicyInput struct { // The unique identifier (ID) of the policy that you want details about. 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 (_). + // get the ID from the ListPoliciesor ListPoliciesForTarget operations. + // + // The [regex pattern] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyId *string diff --git a/service/organizations/api_op_DescribeResourcePolicy.go b/service/organizations/api_op_DescribeResourcePolicy.go index de9c431d4d1..232f71c3dc9 100644 --- a/service/organizations/api_op_DescribeResourcePolicy.go +++ b/service/organizations/api_op_DescribeResourcePolicy.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves information about a resource 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. +// Retrieves information about a resource 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) DescribeResourcePolicy(ctx context.Context, params *DescribeResourcePolicyInput, optFns ...func(*Options)) (*DescribeResourcePolicyOutput, error) { if params == nil { params = &DescribeResourcePolicyInput{} diff --git a/service/organizations/api_op_DetachPolicy.go b/service/organizations/api_op_DetachPolicy.go index 476881cfb11..107df04e052 100644 --- a/service/organizations/api_op_DetachPolicy.go +++ b/service/organizations/api_op_DetachPolicy.go @@ -10,21 +10,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Detaches a policy from a target root, organizational unit (OU), or account. If -// the policy being detached is a service control policy (SCP), the changes to +// Detaches a policy from a target root, organizational unit (OU), or account. +// +// If the policy being detached is a service control policy (SCP), the changes to // permissions for Identity and Access Management (IAM) users and roles in affected -// accounts are immediate. Every root, OU, and account must have at least one SCP -// 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 -// 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 -// or by a member account that is a delegated administrator for an Amazon Web -// Services service. +// accounts are immediate. +// +// Every root, OU, and account must have at least one SCP 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] ". 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] ". +// +// 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. +// +// [deny list]: https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_denylist +// [allow list]: https://docs.aws.amazon.com/organizations/latest/userguide/SCP_strategies.html#orgs_policies_allowlist func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error) { if params == nil { params = &DetachPolicyInput{} @@ -43,25 +49,33 @@ 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 ListPoliciesor ListPoliciesForTarget operations. + // + // The [regex pattern] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // 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: + // the policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. TargetId *string diff --git a/service/organizations/api_op_DisableAWSServiceAccess.go b/service/organizations/api_op_DisableAWSServiceAccess.go index a213a9de980..dbdff29869b 100644 --- a/service/organizations/api_op_DisableAWSServiceAccess.go +++ b/service/organizations/api_op_DisableAWSServiceAccess.go @@ -12,32 +12,38 @@ 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) -// 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 -// clean-up from Organizations. We strongly recommend that you don't use this -// command to disable integration between Organizations and the specified Amazon -// Web Services service. Instead, use the console or commands that are provided by -// the specified service. This lets the trusted service perform any required -// initialization when enabling trusted access, such as creating any required -// resources and any required clean up of resources when disabling trusted access. -// 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 -// following actions to occur: +// integration, the specified service no longer can create a [service-linked role]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 clean-up from +// Organizations. +// +// We strongly recommend that you don't use this command to disable integration +// between Organizations and the specified Amazon Web Services service. Instead, +// use the console or commands that are provided by the specified service. This +// lets the trusted service perform any required initialization when enabling +// trusted access, such as creating any required resources and any required clean +// up of resources when disabling trusted access. +// +// 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]. 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 @@ -47,14 +53,20 @@ import ( // 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 Using 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. +// 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 [Using Organizations with other Amazon Web Services services]in the +// Organizations User Guide. +// +// This operation can be called only from the organization's management account. +// +// [Amazon Web Services services that you can use with Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html +// [Using Organizations with other Amazon Web Services services]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html +// [service-linked role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html func (c *Client) DisableAWSServiceAccess(ctx context.Context, params *DisableAWSServiceAccessInput, optFns ...func(*Options)) (*DisableAWSServiceAccessOutput, error) { if params == nil { params = &DisableAWSServiceAccessInput{} diff --git a/service/organizations/api_op_DisablePolicyType.go b/service/organizations/api_op_DisablePolicyType.go index 8726e4dad19..60d56f416b0 100644 --- a/service/organizations/api_op_DisablePolicyType.go +++ b/service/organizations/api_op_DisablePolicyType.go @@ -15,16 +15,21 @@ import ( // 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) -// 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 or by a member account that is a delegated administrator for -// an Amazon Web Services service. To view the status of available policy types in -// the organization, use DescribeOrganization . +// that root. You can undo this by using the EnablePolicyTypeoperation. +// +// 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]are enabled for the organization. Amazon Web Services +// recommends that you first use ListRootsto 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 or +// by a member account that is a delegated administrator for an Amazon Web Services +// service. +// +// To view the status of available policy types in the organization, use DescribeOrganization. +// +// [all features]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html func (c *Client) DisablePolicyType(ctx context.Context, params *DisablePolicyTypeInput, optFns ...func(*Options)) (*DisablePolicyTypeOutput, error) { if params == nil { params = &DisablePolicyTypeInput{} @@ -44,18 +49,30 @@ 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] + // + // [BACKUP_POLICY] + // + // [SERVICE_CONTROL_POLICY] + // + // [TAG_POLICY] + // + // [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 ListRootsoperation. + // + // The [regex pattern] for a root ID string requires "r-" followed by from 4 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RootId *string diff --git a/service/organizations/api_op_EnableAWSServiceAccess.go b/service/organizations/api_op_EnableAWSServiceAccess.go index f7d30efb995..4303951d836 100644 --- a/service/organizations/api_op_EnableAWSServiceAccess.go +++ b/service/organizations/api_op_EnableAWSServiceAccess.go @@ -12,21 +12,27 @@ 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) -// 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 -// Services service by using the console or commands that are provided by the -// specified service. Doing so ensures that the service is aware that it can create -// the resources that are required for the integration. How the service creates -// those resources in the organization's accounts depends on that service. For more -// information, see the documentation for the other Amazon Web Services service. +// you allow the specified service to create a [service-linked role]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 Services service by using the console or commands that are +// provided by the specified service. Doing so ensures that the service is aware +// that it can create the resources that are required for the integration. How the +// service creates 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 Using 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) -// . +// see [Using Organizations with other Amazon Web Services services]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]. +// +// [enabled all features]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html +// [Using Organizations with other Amazon Web Services services]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html +// [service-linked role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html func (c *Client) EnableAWSServiceAccess(ctx context.Context, params *EnableAWSServiceAccessInput, optFns ...func(*Options)) (*EnableAWSServiceAccessOutput, error) { if params == nil { params = &EnableAWSServiceAccessInput{} diff --git a/service/organizations/api_op_EnableAllFeatures.go b/service/organizations/api_op_EnableAllFeatures.go index 0d81f7e9c5c..1a2b6b05cf4 100644 --- a/service/organizations/api_op_EnableAllFeatures.go +++ b/service/organizations/api_op_EnableAllFeatures.go @@ -15,25 +15,33 @@ import ( // policies that can restrict the services and actions that can be called in each // 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) -// 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 -// account in the organization. The feature set change can be finalized and the -// 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 -// handshake, you finalize the feature set change by accepting the handshake that -// 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 +// that Organizations supports. For more information, see [Enabling all features in your organization]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 account in the organization. The feature set +// change can be finalized and the 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 EnablePolicyTypeand 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 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 // management account can apply policies that prevent accounts from leaving the -// organization. Ensure that your account administrators are aware of this. This -// operation can be called only from the organization's management account. +// organization. Ensure that your account administrators are aware of this. +// +// This operation can be called only from the organization's management account. +// +// [Enabling all features in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html func (c *Client) EnableAllFeatures(ctx context.Context, params *EnableAllFeaturesInput, optFns ...func(*Options)) (*EnableAllFeaturesOutput, error) { if params == nil { params = &EnableAllFeaturesInput{} diff --git a/service/organizations/api_op_EnablePolicyType.go b/service/organizations/api_op_EnablePolicyType.go index cf2b905c98a..922efa0ff33 100644 --- a/service/organizations/api_op_EnablePolicyType.go +++ b/service/organizations/api_op_EnablePolicyType.go @@ -13,15 +13,19 @@ import ( // Enables a policy type in a root. After you enable a policy type in a root, you // can attach policies of that type to the root, any organizational unit (OU), or -// account in that root. You can undo this by using the DisablePolicyType -// operation. This is an asynchronous request that Amazon Web Services performs in -// the background. 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 or by a member account that is a delegated administrator for an Amazon -// Web Services service. 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 . +// account in that root. You can undo this by using the DisablePolicyTypeoperation. +// +// This is an asynchronous request that Amazon Web Services performs in the +// background. Amazon Web Services recommends that you first use ListRootsto 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 or +// by a member account that is a delegated administrator for an Amazon Web Services +// service. +// +// 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. func (c *Client) EnablePolicyType(ctx context.Context, params *EnablePolicyTypeInput, optFns ...func(*Options)) (*EnablePolicyTypeOutput, error) { if params == nil { params = &EnablePolicyTypeInput{} @@ -41,18 +45,30 @@ 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] + // + // [BACKUP_POLICY] + // + // [SERVICE_CONTROL_POLICY] + // + // [TAG_POLICY] + // + // [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 ListRootsoperation. + // + // The [regex pattern] for a root ID string requires "r-" followed by from 4 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. RootId *string diff --git a/service/organizations/api_op_InviteAccountToOrganization.go b/service/organizations/api_op_InviteAccountToOrganization.go index 5f7631c032a..18a978c2108 100644 --- a/service/organizations/api_op_InviteAccountToOrganization.go +++ b/service/organizations/api_op_InviteAccountToOrganization.go @@ -13,25 +13,28 @@ import ( // Sends an invitation to another account to join your organization as a member // 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. +// 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/useconsolidatedbilling-India.html) -// . +// Amazon Web Services seller. For more information, see [Consolidated billing in India]. +// // - 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#/) -// . +// error persists after an hour, contact [Amazon Web Services Support]. // // 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. +// organizations:TagResource permission. +// +// This operation can be called only from the organization's management account. +// +// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/ +// [Consolidated billing in India]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilling-India.html func (c *Client) InviteAccountToOrganization(ctx context.Context, params *InviteAccountToOrganizationInput, optFns ...func(*Options)) (*InviteAccountToOrganizationOutput, error) { if params == nil { params = &InviteAccountToOrganizationInput{} @@ -51,12 +54,20 @@ type InviteAccountToOrganizationInput struct { // The identifier (ID) of the Amazon Web Services account that you want to invite // 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 + // 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 // // This member is required. Target *types.HandshakeParty @@ -68,16 +79,20 @@ 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) - // 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 - // the policy at that time. Tag policy compliance is not checked again when the - // invitation is accepted and the tags are actually attached to the account. That - // means that if the tag policy changes between the invitation and the acceptance, - // then that tags could potentially be non-compliant. If any one of the tags is not - // valid or if you exceed the allowed number of tags for an account, then the - // entire request fails and invitations are not sent. + // null . For more information about tagging, see [Tagging Organizations resources] 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 the policy at that time. Tag policy + // compliance is not checked again when the invitation is accepted and the tags are + // actually attached to the account. That means that if the tag policy changes + // between the invitation and the acceptance, then that tags could potentially be + // non-compliant. + // + // If any one of the tags is not valid or if you exceed the allowed number of tags + // for an account, then the entire request fails and invitations are not sent. + // + // [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/organizations/api_op_LeaveOrganization.go b/service/organizations/api_op_LeaveOrganization.go index 0a40ff50aea..7253284710d 100644 --- a/service/organizations/api_op_LeaveOrganization.go +++ b/service/organizations/api_op_LeaveOrganization.go @@ -12,13 +12,15 @@ import ( // Removes a member account from its parent organization. This version of the // operation is performed by the account that wants to leave. To remove a member -// account as a user in the management account, use RemoveAccountFromOrganization -// instead. This operation can be called only from a member account in the -// organization. +// account as a user in the management account, use RemoveAccountFromOrganizationinstead. +// +// 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, @@ -26,31 +28,42 @@ import ( // 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. For more -// information, see Considerations before removing an account from an -// organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html) -// 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 About IAM 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. -// - If you are using an organization principal to call LeaveOrganization across -// multiple accounts, you can only do this up to 5 accounts per second in a single -// organization. +// +// - 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. For more information, see [Considerations before removing an account from an organization]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 [About IAM access to the Billing and Cost Management console]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. +// +// - If you are using an organization principal to call LeaveOrganization across +// multiple accounts, you can only do this up to 5 accounts per second in a single +// organization. +// +// [About IAM access to the Billing and Cost Management console]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate +// [Considerations before removing an account from an organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html 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 3a1a92a2180..c3fc98ed580 100644 --- a/service/organizations/api_op_ListAWSServiceAccessForOrganization.go +++ b/service/organizations/api_op_ListAWSServiceAccessForOrganization.go @@ -14,13 +14,17 @@ import ( // 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 Using 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. +// 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 [Using Organizations with other Amazon Web Services services]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. +// +// [Using Organizations with other Amazon Web Services services]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html func (c *Client) ListAWSServiceAccessForOrganization(ctx context.Context, params *ListAWSServiceAccessForOrganizationInput, optFns ...func(*Options)) (*ListAWSServiceAccessForOrganizationOutput, error) { if params == nil { params = &ListAWSServiceAccessForOrganizationInput{} diff --git a/service/organizations/api_op_ListAccounts.go b/service/organizations/api_op_ListAccounts.go index efccfc4e99f..d2b58dd4396 100644 --- a/service/organizations/api_op_ListAccounts.go +++ b/service/organizations/api_op_ListAccounts.go @@ -12,14 +12,16 @@ import ( ) // Lists all the accounts in the organization. To request only the accounts in a -// specified root or organizational unit (OU), use the ListAccountsForParent -// operation instead. 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. +// specified root or organizational unit (OU), use the ListAccountsForParentoperation instead. +// +// 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) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error) { if params == nil { params = &ListAccountsInput{} diff --git a/service/organizations/api_op_ListAccountsForParent.go b/service/organizations/api_op_ListAccountsForParent.go index 014ce100247..78b6817e888 100644 --- a/service/organizations/api_op_ListAccountsForParent.go +++ b/service/organizations/api_op_ListAccountsForParent.go @@ -15,13 +15,16 @@ import ( // 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. +// all accounts in the organization, use the ListAccountsoperation. +// +// 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{} diff --git a/service/organizations/api_op_ListChildren.go b/service/organizations/api_op_ListChildren.go index f90992c58e1..dd5f4ab829d 100644 --- a/service/organizations/api_op_ListChildren.go +++ b/service/organizations/api_op_ListChildren.go @@ -12,14 +12,17 @@ import ( ) // Lists all of the organizational units (OUs) or accounts that are contained in -// the specified parent OU or root. This operation, along with ListParents 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 called only -// from the organization's management account or by a member account that is a -// delegated administrator for an Amazon Web Services service. +// the specified parent OU or root. This operation, along with ListParentsenables 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 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) ListChildren(ctx context.Context, params *ListChildrenInput, optFns ...func(*Options)) (*ListChildrenOutput, error) { if params == nil { params = &ListChildrenInput{} @@ -43,15 +46,20 @@ 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: + // list. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. ParentId *string diff --git a/service/organizations/api_op_ListCreateAccountStatus.go b/service/organizations/api_op_ListCreateAccountStatus.go index 954d4044822..e4437cdc106 100644 --- a/service/organizations/api_op_ListCreateAccountStatus.go +++ b/service/organizations/api_op_ListCreateAccountStatus.go @@ -12,13 +12,16 @@ import ( ) // Lists the account creation requests that match the specified status that is -// 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. +// 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. func (c *Client) ListCreateAccountStatus(ctx context.Context, params *ListCreateAccountStatusInput, optFns ...func(*Options)) (*ListCreateAccountStatusOutput, error) { if params == nil { params = &ListCreateAccountStatusInput{} diff --git a/service/organizations/api_op_ListDelegatedAdministrators.go b/service/organizations/api_op_ListDelegatedAdministrators.go index 38b3e6c2491..3b340e13520 100644 --- a/service/organizations/api_op_ListDelegatedAdministrators.go +++ b/service/organizations/api_op_ListDelegatedAdministrators.go @@ -12,9 +12,11 @@ import ( ) // Lists the Amazon Web Services accounts that are designated as delegated -// administrators in this organization. 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. +// administrators in this organization. +// +// 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) ListDelegatedAdministrators(ctx context.Context, params *ListDelegatedAdministratorsInput, optFns ...func(*Options)) (*ListDelegatedAdministratorsOutput, error) { if params == nil { params = &ListDelegatedAdministratorsInput{} @@ -50,9 +52,10 @@ type ListDelegatedAdministratorsInput struct { NextToken *string // Specifies a service principal name. If specified, then the operation lists the - // delegated administrators only for the specified service. If you don't specify a - // service principal, the operation lists all delegated administrators for all - // services in your organization. + // delegated administrators only for the specified service. + // + // If you don't specify a service principal, the operation lists all delegated + // administrators for all services in your organization. ServicePrincipal *string noSmithyDocumentSerde diff --git a/service/organizations/api_op_ListDelegatedServicesForAccount.go b/service/organizations/api_op_ListDelegatedServicesForAccount.go index 89aa1ba020b..7c03c9f9366 100644 --- a/service/organizations/api_op_ListDelegatedServicesForAccount.go +++ b/service/organizations/api_op_ListDelegatedServicesForAccount.go @@ -12,9 +12,11 @@ import ( ) // List the Amazon Web Services services for which the specified account is a -// delegated administrator. 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. +// delegated administrator. +// +// 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) ListDelegatedServicesForAccount(ctx context.Context, params *ListDelegatedServicesForAccountInput, optFns ...func(*Options)) (*ListDelegatedServicesForAccountOutput, error) { if params == nil { params = &ListDelegatedServicesForAccountInput{} diff --git a/service/organizations/api_op_ListHandshakesForAccount.go b/service/organizations/api_op_ListHandshakesForAccount.go index ce5e7506411..c3df13ac49f 100644 --- a/service/organizations/api_op_ListHandshakesForAccount.go +++ b/service/organizations/api_op_ListHandshakesForAccount.go @@ -12,14 +12,18 @@ import ( ) // Lists the current handshakes that are associated with the account of the -// 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 -// account in the organization. +// 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 account in the organization. func (c *Client) ListHandshakesForAccount(ctx context.Context, params *ListHandshakesForAccountInput, optFns ...func(*Options)) (*ListHandshakesForAccountOutput, error) { if params == nil { params = &ListHandshakesForAccountInput{} @@ -67,8 +71,8 @@ type ListHandshakesForAccountInput struct { type ListHandshakesForAccountOutput struct { - // A list of Handshake objects with details about each of the handshakes that is - // associated with the specified account. + // A list of Handshake objects with details about each of the handshakes that is associated + // with the specified account. Handshakes []types.Handshake // If present, indicates that more output is available than is included in the diff --git a/service/organizations/api_op_ListHandshakesForOrganization.go b/service/organizations/api_op_ListHandshakesForOrganization.go index a0baed088c5..1e4d6acc704 100644 --- a/service/organizations/api_op_ListHandshakesForOrganization.go +++ b/service/organizations/api_op_ListHandshakesForOrganization.go @@ -14,15 +14,20 @@ 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 -// 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. +// 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. func (c *Client) ListHandshakesForOrganization(ctx context.Context, params *ListHandshakesForOrganizationInput, optFns ...func(*Options)) (*ListHandshakesForOrganizationOutput, error) { if params == nil { params = &ListHandshakesForOrganizationInput{} diff --git a/service/organizations/api_op_ListOrganizationalUnitsForParent.go b/service/organizations/api_op_ListOrganizationalUnitsForParent.go index 2022d65494e..e27871dea99 100644 --- a/service/organizations/api_op_ListOrganizationalUnitsForParent.go +++ b/service/organizations/api_op_ListOrganizationalUnitsForParent.go @@ -12,12 +12,14 @@ import ( ) // Lists the organizational units (OUs) in a parent organizational unit or 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 called only from the organization's management account or by a -// member account that is a delegated administrator for an Amazon Web Services +// 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) ListOrganizationalUnitsForParent(ctx context.Context, params *ListOrganizationalUnitsForParentInput, optFns ...func(*Options)) (*ListOrganizationalUnitsForParentOutput, error) { if params == nil { @@ -37,15 +39,19 @@ func (c *Client) ListOrganizationalUnitsForParent(ctx context.Context, params *L 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: + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. ParentId *string diff --git a/service/organizations/api_op_ListParents.go b/service/organizations/api_op_ListParents.go index 17ea0db25c7..816fc08fe92 100644 --- a/service/organizations/api_op_ListParents.go +++ b/service/organizations/api_op_ListParents.go @@ -12,15 +12,19 @@ import ( ) // Lists the root or organizational units (OUs) that serve as the immediate parent -// of the specified child OU or account. This operation, along with ListChildren -// 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 -// 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. +// of the specified child OU or account. This operation, along with ListChildrenenables 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 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. func (c *Client) ListParents(ctx context.Context, params *ListParentsInput, optFns ...func(*Options)) (*ListParentsOutput, error) { if params == nil { params = &ListParentsInput{} @@ -39,14 +43,19 @@ 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: + // want to list. Don't specify a root. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. ChildId *string diff --git a/service/organizations/api_op_ListPolicies.go b/service/organizations/api_op_ListPolicies.go index dc9dac7e0a0..4f392e260c1 100644 --- a/service/organizations/api_op_ListPolicies.go +++ b/service/organizations/api_op_ListPolicies.go @@ -12,12 +12,14 @@ import ( ) // Retrieves the list of all policies in an organization of a specified type. +// // 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 +// 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) ListPolicies(ctx context.Context, params *ListPoliciesInput, optFns ...func(*Options)) (*ListPoliciesOutput, error) { if params == nil { @@ -38,10 +40,19 @@ 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] + // + // [BACKUP_POLICY] + // + // [SERVICE_CONTROL_POLICY] + // + // [TAG_POLICY] + // + // [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 @@ -75,8 +86,7 @@ type ListPoliciesOutput struct { 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 . + // list doesn't include the policy contents. To see the content for a policy, see DescribePolicy. Policies []types.PolicySummary // Metadata pertaining to the operation's result. diff --git a/service/organizations/api_op_ListPoliciesForTarget.go b/service/organizations/api_op_ListPoliciesForTarget.go index 5135aa0d954..b399fd93058 100644 --- a/service/organizations/api_op_ListPoliciesForTarget.go +++ b/service/organizations/api_op_ListPoliciesForTarget.go @@ -13,13 +13,16 @@ import ( // Lists the policies that are directly attached to the specified target root, // organizational unit (OU), or account. You must specify the policy type that you -// 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 -// organization's management account or by a member account that is a delegated -// administrator for an Amazon Web Services service. +// 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 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) { if params == nil { params = &ListPoliciesForTargetInput{} @@ -39,25 +42,40 @@ 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] + // + // [BACKUP_POLICY] + // + // [SERVICE_CONTROL_POLICY] + // + // [TAG_POLICY] + // + // [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 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: + // policies you want to list. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. TargetId *string diff --git a/service/organizations/api_op_ListRoots.go b/service/organizations/api_op_ListRoots.go index 130a6355d3e..12479e94ff5 100644 --- a/service/organizations/api_op_ListRoots.go +++ b/service/organizations/api_op_ListRoots.go @@ -11,18 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the roots that are defined in the current 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. Policy types can be -// enabled and disabled in roots. This is distinct from whether they're available -// 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 . +// Lists the roots that are defined in the current 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. +// +// Policy types can be enabled and disabled in roots. This is distinct from +// whether they're available 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. func (c *Client) ListRoots(ctx context.Context, params *ListRootsInput, optFns ...func(*Options)) (*ListRootsOutput, error) { if params == nil { params = &ListRootsInput{} diff --git a/service/organizations/api_op_ListTagsForResource.go b/service/organizations/api_op_ListTagsForResource.go index e8b6bc2676a..045437a7e70 100644 --- a/service/organizations/api_op_ListTagsForResource.go +++ b/service/organizations/api_op_ListTagsForResource.go @@ -11,11 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists tags that are attached to the specified resource. You can attach tags to -// the following resources in Organizations. +// 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) // // This operation can be called only from the organization's management account or @@ -38,12 +43,17 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The ID of the resource with the tags to list. You can specify any of the - // following taggable resources. + // 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 // diff --git a/service/organizations/api_op_ListTargetsForPolicy.go b/service/organizations/api_op_ListTargetsForPolicy.go index 8c708381237..47f58360899 100644 --- a/service/organizations/api_op_ListTargetsForPolicy.go +++ b/service/organizations/api_op_ListTargetsForPolicy.go @@ -12,13 +12,16 @@ import ( ) // 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. +// 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,9 +40,11 @@ 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 [regex pattern] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyId *string diff --git a/service/organizations/api_op_MoveAccount.go b/service/organizations/api_op_MoveAccount.go index 792e26b24ab..f4a4b7f3f04 100644 --- a/service/organizations/api_op_MoveAccount.go +++ b/service/organizations/api_op_MoveAccount.go @@ -11,8 +11,9 @@ import ( ) // 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. +// (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{} @@ -30,36 +31,48 @@ func (c *Client) MoveAccount(ctx context.Context, params *MoveAccountInput, optF type MoveAccountInput struct { - // The unique identifier (ID) of the account that you want to move. The regex - // pattern (http://wikipedia.org/wiki/regex) for an account ID string requires - // exactly 12 digits. + // The unique identifier (ID) of the account that you want to move. + // + // The [regex pattern] for an account ID string requires exactly 12 digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountId *string // 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: + // move the account to. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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: + // move the account from. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // This member is required. SourceParentId *string diff --git a/service/organizations/api_op_PutResourcePolicy.go b/service/organizations/api_op_PutResourcePolicy.go index ae1ea359250..e86dcc5d0d6 100644 --- a/service/organizations/api_op_PutResourcePolicy.go +++ b/service/organizations/api_op_PutResourcePolicy.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates or updates a resource policy. You can only call this operation from the -// organization's management account. +// Creates or updates a resource policy. +// +// You can only call this operation from the organization's management account. func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} @@ -32,8 +33,9 @@ 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 SCP syntax (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html) - // in the Organizations User Guide. + // type. For more information, see [SCP syntax]in the Organizations User Guide. + // + // [SCP syntax]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html // // This member is required. Content *string @@ -41,11 +43,14 @@ type PutResourcePolicyInput struct { // 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 - // policy, then the entire request fails and the resource policy is not created. + // information about tagging, see [Tagging Organizations resources]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 policy, then the entire request fails + // and the resource policy is not created. + // + // [Tagging Organizations resources]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/organizations/api_op_RegisterDelegatedAdministrator.go b/service/organizations/api_op_RegisterDelegatedAdministrator.go index 5b2bbd246f9..39b15935967 100644 --- a/service/organizations/api_op_RegisterDelegatedAdministrator.go +++ b/service/organizations/api_op_RegisterDelegatedAdministrator.go @@ -13,12 +13,15 @@ import ( // 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) -// in the Organizations User Guide. This operation can be called only from the -// organization's management account. +// 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]in the Organizations User Guide. +// +// This operation can be called only from the organization's management account. +// +// [Amazon Web Services Services that you can use with Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html func (c *Client) RegisterDelegatedAdministrator(ctx context.Context, params *RegisterDelegatedAdministratorInput, optFns ...func(*Options)) (*RegisterDelegatedAdministratorOutput, error) { if params == nil { params = &RegisterDelegatedAdministratorInput{} diff --git a/service/organizations/api_op_RemoveAccountFromOrganization.go b/service/organizations/api_op_RemoveAccountFromOrganization.go index 17588bdc166..1aa152dbb1d 100644 --- a/service/organizations/api_op_RemoveAccountFromOrganization.go +++ b/service/organizations/api_op_RemoveAccountFromOrganization.go @@ -10,27 +10,34 @@ 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 -// 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. +// 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 LeaveOrganizationinstead. +// // - 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 more information, see Considerations before -// removing an account from an organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html) -// in the Organizations User Guide. +// automatically collected. For more information, see [Considerations before removing an account from an organization]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. +// +// [Considerations before removing an account from an organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html func (c *Client) RemoveAccountFromOrganization(ctx context.Context, params *RemoveAccountFromOrganizationInput, optFns ...func(*Options)) (*RemoveAccountFromOrganizationOutput, error) { if params == nil { params = &RemoveAccountFromOrganizationInput{} @@ -49,8 +56,11 @@ func (c *Client) RemoveAccountFromOrganization(ctx context.Context, params *Remo type RemoveAccountFromOrganizationInput struct { // The unique identifier (ID) of the member account that you want to remove from - // the organization. The regex pattern (http://wikipedia.org/wiki/regex) for an - // account ID string requires exactly 12 digits. + // the organization. + // + // The [regex pattern] for an account ID string requires exactly 12 digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. AccountId *string diff --git a/service/organizations/api_op_TagResource.go b/service/organizations/api_op_TagResource.go index 4be6cf56635..9828cd5a113 100644 --- a/service/organizations/api_op_TagResource.go +++ b/service/organizations/api_op_TagResource.go @@ -11,11 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to the specified resource. Currently, you can attach tags -// to the following resources in Organizations. +// 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) // // This operation can be called only from the organization's management account or @@ -38,23 +43,30 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ID of the resource to add a tag to. You can specify any of the following - // taggable resources. + // 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 // // 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 - // the maximum allowed number of tags for a resource, then the entire request - // fails. + // 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 the maximum allowed number + // of tags for a resource, then the entire request fails. // // This member is required. Tags []types.Tag diff --git a/service/organizations/api_op_UntagResource.go b/service/organizations/api_op_UntagResource.go index 2cf32408671..72a1e2a521e 100644 --- a/service/organizations/api_op_UntagResource.go +++ b/service/organizations/api_op_UntagResource.go @@ -10,11 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes any tags with the specified keys from the specified resource. You can -// attach tags to the following resources in Organizations. +// 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) // // This operation can be called only from the organization's management account or @@ -37,12 +42,17 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The ID of the resource to remove a tag from. You can specify any of the - // following taggable resources. + // 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 // diff --git a/service/organizations/api_op_UpdateOrganizationalUnit.go b/service/organizations/api_op_UpdateOrganizationalUnit.go index 5abf0c261d8..e0fa3d131e3 100644 --- a/service/organizations/api_op_UpdateOrganizationalUnit.go +++ b/service/organizations/api_op_UpdateOrganizationalUnit.go @@ -13,8 +13,9 @@ import ( // 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. +// 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) { if params == nil { params = &UpdateOrganizationalUnitInput{} @@ -33,18 +34,24 @@ 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 + // ID from the ListOrganizationalUnitsForParentoperation. + // + // The [regex pattern] 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. // + // [regex pattern]: http://wikipedia.org/wiki/regex + // // 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Name *string noSmithyDocumentSerde diff --git a/service/organizations/api_op_UpdatePolicy.go b/service/organizations/api_op_UpdatePolicy.go index 0a1fc661ca0..4db01da01cd 100644 --- a/service/organizations/api_op_UpdatePolicy.go +++ b/service/organizations/api_op_UpdatePolicy.go @@ -13,9 +13,11 @@ import ( // Updates an existing policy with a new name, description, or content. If you // don't supply any parameter, that value remains unchanged. You can't change a -// policy's 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 service. +// policy's 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 +// service. func (c *Client) UpdatePolicy(ctx context.Context, params *UpdatePolicyInput, optFns ...func(*Options)) (*UpdatePolicyOutput, error) { if params == nil { params = &UpdatePolicyInput{} @@ -33,28 +35,36 @@ func (c *Client) UpdatePolicy(ctx context.Context, params *UpdatePolicyInput, op type UpdatePolicyInput struct { - // The unique identifier (ID) of the policy that you want to update. 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 that you want to update. + // + // The [regex pattern] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. PolicyId *string // 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 SCP syntax (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html) - // in the Organizations User Guide. The maximum size of a policy document depends - // on the policy's type. For more information, see Maximum and minimum values (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html#min-max-values) - // in the Organizations User Guide. + // information, see [SCP syntax]in the Organizations User Guide. + // + // The maximum size of a policy document depends on the policy's type. For more + // information, see [Maximum and minimum values]in the Organizations User Guide. + // + // [Maximum and minimum values]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html#min-max-values + // [SCP syntax]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Name *string noSmithyDocumentSerde diff --git a/service/organizations/doc.go b/service/organizations/doc.go index 59bedab8822..70395af7e14 100644 --- a/service/organizations/doc.go +++ b/service/organizations/doc.go @@ -5,40 +5,74 @@ // // Organizations is a web service that enables you to consolidate your multiple // 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: +// accounts and their resources. +// +// This guide provides descriptions of the Organizations operations. For more +// information about using this service, see the [Organizations User Guide]. +// +// # Support and feedback for Organizations +// +// We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and +// questions in the [Organizations support forum]. For more information about the Amazon Web Services support +// forums, see [Forums Help]. +// +// # 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) -// -// 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 API calls 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) -// . +// 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 API calls with CloudTrail]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]. +// +// [Forums Help]: http://forums.aws.amazon.com/help.jspa +// [Organizations support forum]: http://forums.aws.amazon.com/forum.jspa?forumID=219 +// [CloudTrail User Guide]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html +// [Organizations User Guide]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html +// [Logging Organizations API calls with CloudTrail]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration package organizations diff --git a/service/organizations/options.go b/service/organizations/options.go index ba05eb89a41..9717d00470c 100644 --- a/service/organizations/options.go +++ b/service/organizations/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/organizations/types/enums.go b/service/organizations/types/enums.go index 516d00553ac..e709360a4bf 100644 --- a/service/organizations/types/enums.go +++ b/service/organizations/types/enums.go @@ -11,8 +11,9 @@ const ( // Values returns all known values for AccessDeniedForDependencyExceptionReason. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessDeniedForDependencyExceptionReason) Values() []AccessDeniedForDependencyExceptionReason { return []AccessDeniedForDependencyExceptionReason{ "ACCESS_DENIED_DURING_CREATE_SERVICE_LINKED_ROLE", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for AccountJoinedMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountJoinedMethod) Values() []AccountJoinedMethod { return []AccountJoinedMethod{ "INVITED", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for AccountStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountStatus) Values() []AccountStatus { return []AccountStatus{ "ACTIVE", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "INVITE", @@ -88,8 +92,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -139,8 +144,9 @@ const ( // Values returns all known values for ConstraintViolationExceptionReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConstraintViolationExceptionReason) Values() []ConstraintViolationExceptionReason { return []ConstraintViolationExceptionReason{ "ACCOUNT_NUMBER_LIMIT_EXCEEDED", @@ -203,6 +209,7 @@ const ( // Values returns all known values for CreateAccountFailureReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CreateAccountFailureReason) Values() []CreateAccountFailureReason { return []CreateAccountFailureReason{ @@ -234,8 +241,9 @@ const ( ) // Values returns all known values for CreateAccountState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreateAccountState) Values() []CreateAccountState { return []CreateAccountState{ "IN_PROGRESS", @@ -254,8 +262,9 @@ const ( ) // Values returns all known values for EffectivePolicyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EffectivePolicyType) Values() []EffectivePolicyType { return []EffectivePolicyType{ "TAG_POLICY", @@ -282,8 +291,9 @@ const ( // 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. +// the future, and so 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", @@ -309,8 +319,9 @@ const ( ) // Values returns all known values for HandshakePartyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HandshakePartyType) Values() []HandshakePartyType { return []HandshakePartyType{ "ACCOUNT", @@ -334,8 +345,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACCOUNT", @@ -362,8 +374,9 @@ const ( ) // Values returns all known values for HandshakeState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HandshakeState) Values() []HandshakeState { return []HandshakeState{ "REQUESTED", @@ -384,8 +397,9 @@ const ( ) // Values returns all known values for IAMUserAccessToBilling. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IAMUserAccessToBilling) Values() []IAMUserAccessToBilling { return []IAMUserAccessToBilling{ "ALLOW", @@ -429,6 +443,7 @@ const ( // Values returns all known values for InvalidInputExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InvalidInputExceptionReason) Values() []InvalidInputExceptionReason { return []InvalidInputExceptionReason{ @@ -472,8 +487,9 @@ const ( ) // Values returns all known values for OrganizationFeatureSet. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationFeatureSet) Values() []OrganizationFeatureSet { return []OrganizationFeatureSet{ "ALL", @@ -490,8 +506,9 @@ const ( ) // Values returns all known values for ParentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParentType) Values() []ParentType { return []ParentType{ "ROOT", @@ -510,8 +527,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "SERVICE_CONTROL_POLICY", @@ -531,8 +549,9 @@ const ( ) // Values returns all known values for PolicyTypeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyTypeStatus) Values() []PolicyTypeStatus { return []PolicyTypeStatus{ "ENABLED", @@ -551,8 +570,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "ACCOUNT", diff --git a/service/organizations/types/errors.go b/service/organizations/types/errors.go index d27f2ce6cc6..d5a47bd7c0d 100644 --- a/service/organizations/types/errors.go +++ b/service/organizations/types/errors.go @@ -9,9 +9,10 @@ import ( // You don't have permissions to perform the requested operation. The user or role // that is making the request must have at least one IAM permissions policy -// attached that grants the required permissions. For more information, see Access -// Management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the +// attached that grants the required permissions. For more information, see [Access Management]in the // IAM User Guide. +// +// [Access Management]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html type AccessDeniedException struct { Message *string @@ -123,7 +124,8 @@ func (e *AccountAlreadyRegisteredException) ErrorCode() string { } func (e *AccountAlreadyRegisteredException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// We can't find an Amazon Web Services account with the AccountId that you +// We can't find an Amazon Web Services account with the AccountId that you +// // specified, or the account whose credentials you used to make this request isn't // a member of an organization. type AccountNotFoundException struct { @@ -180,8 +182,9 @@ 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) -// in the Organizations User Guide. +// information, see [Email address verification]in the Organizations User Guide. +// +// [Email address verification]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html#about-email-verification type AccountOwnerNotVerifiedException struct { Message *string @@ -346,125 +349,166 @@ func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.Fault // example, attempting to remove the last service control policy (SCP) from an OU // or root, inviting or creating too many accounts to the organization, or // attaching too many policies to an account, OU, or root. 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. +// 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. +// verification. Follow the steps at [Removing a member account from your organization]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://console.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://console.aws.amazon.com/support/home#/) . -// - CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot -// register a suspended account as a delegated administrator. -// - 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. For more information, see -// Considerations before removing an account from an organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html) -// 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. For more information, see Considerations -// before removing an account from an organization (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html) -// 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. +// number of accounts in an organization. If you need more accounts, contact [Amazon Web Services Support]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]. +// +// - CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot +// register a suspended account as a delegated administrator. +// +// - 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]. +// +// - 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]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. For more information, see [Considerations before removing an account from an organization]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. For more information, see [Considerations before removing an account from an organization]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. +// +// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/ +// [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 +// +// [Managing your Amazon Web Services payments]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-general.html +// [Organizations]: https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-organizations.html +// [Considerations before removing an account from an organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_account-before-remove.html type ConstraintViolationException struct { Message *string @@ -719,8 +763,9 @@ 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]. +// +// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/ type FinalizingOrganizationException struct { Message *string @@ -774,37 +819,52 @@ func (e *HandshakeAlreadyInStateException) ErrorCode() string { func (e *HandshakeAlreadyInStateException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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 +// 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://console.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. +// 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]. +// +// - 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. +// +// [Amazon Web Services Support]: https://console.aws.amazon.com/support/home#/ type HandshakeConstraintViolationException struct { Message *string @@ -892,52 +952,78 @@ func (e *InvalidHandshakeTransitionException) ErrorFault() smithy.ErrorFault { // The requested operation failed because you provided invalid values for one or // 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. +// 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. type InvalidInputException struct { @@ -969,8 +1055,9 @@ 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 SCP syntax (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html) -// in the Organizations User Guide. +// service control policy syntax, see [SCP syntax]in the Organizations User Guide. +// +// [SCP syntax]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps_syntax.html type MalformedPolicyDocumentException struct { Message *string @@ -1270,9 +1357,10 @@ 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. +// all features in the organization. For more information, see [Managing Organizations policies]in the +// Organizations User Guide. +// +// [Managing Organizations policies]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html#enable_policies_on_root type PolicyTypeNotAvailableForOrganizationException struct { Message *string @@ -1302,9 +1390,10 @@ func (e *PolicyTypeNotAvailableForOrganizationException) ErrorFault() smithy.Err // 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. +// that type in the root. For more information, see [Enabling all features in your organization]in the Organizations User +// Guide. +// +// [Enabling all features in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html type PolicyTypeNotEnabledException struct { Message *string @@ -1463,9 +1552,12 @@ func (e *TargetNotFoundException) ErrorCode() string { func (e *TargetNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// protect against denial-of-service attacks. Try again later. +// +// For information about quotas that affect Organizations, see [Quotas for Organizations] in the +// Organizations User Guide. +// +// [Quotas for Organizations]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html type TooManyRequestsException struct { Message *string diff --git a/service/organizations/types/types.go b/service/organizations/types/types.go index 4fa3fd7ee61..d725efd87e1 100644 --- a/service/organizations/types/types.go +++ b/service/organizations/types/types.go @@ -11,18 +11,27 @@ import ( // 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 the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of the account. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies Arn *string - // The email address associated with the Amazon Web Services account. The regex - // pattern (http://wikipedia.org/wiki/regex) for this parameter is a string of - // characters that represents a standard internet email address. + // The email address associated with the Amazon Web Services account. + // + // The [regex pattern] for this parameter is a string of characters that represents a standard + // internet email address. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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] for an account ID string requires exactly 12 digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Id *string // The method by which the account joined the organization. @@ -31,9 +40,12 @@ 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Name *string // The status of the account in the organization. @@ -45,13 +57,18 @@ 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: + // The unique identifier (ID) of this child entity. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Id *string // The type of this child entity. @@ -60,14 +77,16 @@ type Child struct { noSmithyDocumentSerde } -// Contains the status about a CreateAccount or CreateGovCloudAccount request to -// create an Amazon Web Services account or an Amazon Web Services GovCloud (US) -// account in an organization. +// Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services +// account or an Amazon Web Services GovCloud (US) account in an organization. type CreateAccountStatus struct { // If the account was created successfully, the unique identifier (ID) of the new - // account. The regex pattern (http://wikipedia.org/wiki/regex) for an account ID - // string requires exactly 12 digits. + // account. + // + // The [regex pattern] for an account ID string requires exactly 12 digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex AccountId *string // The account name given to the account when it was created. @@ -77,41 +96,55 @@ 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) - // . + // institutions in Russia or Belarus. For more information, see [Managing your Amazon Web Services payments]. + // // - 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. + // + // [Managing your Amazon Web Services payments]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-general.html FailureReason CreateAccountFailureReason // If the account was created successfully, the unique identifier (ID) of the new @@ -119,10 +152,12 @@ type CreateAccountStatus struct { 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. + // from the response of the initial CreateAccountrequest to create the account. + // + // The [regex pattern] for a create account request ID string requires "car-" followed by from 8 + // to 32 lowercase letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Id *string // The date and time that the request was made for the account creation. @@ -221,30 +256,37 @@ type EnabledServicePrincipal struct { // 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. +// 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. 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 the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of a handshake. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies Arn *string // The date and time that the handshake expires. If the recipient of the handshake @@ -253,9 +295,12 @@ 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] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Id *string // Information about the two accounts that are participating in the handshake. @@ -270,18 +315,24 @@ 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). @@ -293,14 +344,20 @@ 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] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex ParentHandshakeId *string noSmithyDocumentSerde @@ -309,9 +366,12 @@ 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] for handshake ID string requires "h-" followed by from 8 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex // // This member is required. Id *string @@ -332,14 +392,20 @@ 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. Type HandshakeResourceType @@ -357,43 +423,56 @@ type HandshakeResource struct { // policies . 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) - // in the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of an organization. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies Arn *string // Do not use. This field is deprecated and doesn't provide complete information - // about the policies in your organization. To determine the policies that are - // enabled and available for use in your organization, use the ListRoots operation - // instead. + // about the policies in your organization. + // + // To determine the policies that are enabled and available for use in your + // organization, use the ListRootsoperation instead. AvailablePolicyTypes []PolicyTypeSummary // Specifies the functionality that currently is available to the organization. If // 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) - // in the Organizations User Guide. + // consolidated billing functionality is available. For more information, see [Enabling all features in your organization]in + // the Organizations User Guide. + // + // [Enabling all features in your organization]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html 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] for an organization ID string requires "o-" followed by from 10 to 32 + // lowercase letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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) - // in the Amazon Web Services Service Authorization Reference. + // management account for the organization. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies MasterAccountArn *string // The email address that is associated with the Amazon Web Services account that // is designated as the management account for the organization. MasterAccountEmail *string - // The unique identifier (ID) of the management account of an organization. The - // regex pattern (http://wikipedia.org/wiki/regex) for an account ID string - // requires exactly 12 digits. + // The unique identifier (ID) of the management account of an organization. + // + // The [regex pattern] for an account ID string requires exactly 12 digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex MasterAccountId *string noSmithyDocumentSerde @@ -405,22 +484,31 @@ type Organization struct { // OUs. 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) - // in the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of this OU. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies Arn *string // The unique identifier (ID) associated with this OU. The ID is unique to the - // organization only. 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. + // organization only. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Name *string noSmithyDocumentSerde @@ -430,14 +518,19 @@ type OrganizationalUnit struct { // 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: + // The unique identifier (ID) of the parent entity. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Id *string // The type of the parent entity. @@ -461,12 +554,15 @@ 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) - // in the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of the policy. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies Arn *string // A boolean value that indicates whether the specified policy is an Amazon Web @@ -477,14 +573,20 @@ 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] for a policy ID string requires "p-" followed by from 8 to 128 lowercase + // or uppercase letters, digits, or the underscore character (_). + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex Name *string // The type of policy. @@ -496,25 +598,37 @@ type PolicySummary struct { // Contains information about a root, OU, or account that a policy is attached to. 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) - // in the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of the policy target. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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: + // The unique identifier (ID) of the policy target. + // + // The [regex pattern] 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. + // + // [regex pattern]: http://wikipedia.org/wiki/regex TargetId *string // The type of the policy target. @@ -567,37 +681,52 @@ type ResourcePolicySummary struct { // organization. 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) - // in the Amazon Web Services Service Authorization Reference. + // The Amazon Resource Name (ARN) of the root. + // + // For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the Amazon Web + // Services Service Authorization Reference. + // + // [ARN Formats Supported by Organizations]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies Arn *string // The unique identifier (ID) for the root. The ID is unique to the organization - // only. 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. + // only. + // + // The [regex pattern] for a root ID string requires "r-" followed by from 4 to 32 lowercase + // letters or digits. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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] that is used to validate this parameter is a string of any of the + // characters in the ASCII character range. + // + // [regex pattern]: http://wikipedia.org/wiki/regex 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 - // DescribeOrganization to see the availability of the policy types in that - // organization. + // 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 EnablePolicyTypeand DisablePolicyType. Use DescribeOrganization to see + // the availability of the policy types in that organization. PolicyTypes []PolicyTypeSummary 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 type Tag struct { diff --git a/service/osis/api_op_CreatePipeline.go b/service/osis/api_op_CreatePipeline.go index a3fe15ddfbf..9745d6207fc 100644 --- a/service/osis/api_op_CreatePipeline.go +++ b/service/osis/api_op_CreatePipeline.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an OpenSearch Ingestion pipeline. For more information, see Creating -// Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html) -// . +// Creates an OpenSearch Ingestion pipeline. For more information, see [Creating Amazon OpenSearch Ingestion pipelines]. +// +// [Creating Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error) { if params == nil { params = &CreatePipelineInput{} diff --git a/service/osis/api_op_DeletePipeline.go b/service/osis/api_op_DeletePipeline.go index 573d89e05af..97dbb6d41ca 100644 --- a/service/osis/api_op_DeletePipeline.go +++ b/service/osis/api_op_DeletePipeline.go @@ -10,9 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting -// Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/delete-pipeline.html) -// . +// Deletes an OpenSearch Ingestion pipeline. For more information, see [Deleting Amazon OpenSearch Ingestion pipelines]. +// +// [Deleting Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/delete-pipeline.html func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error) { if params == nil { params = &DeletePipelineInput{} diff --git a/service/osis/api_op_GetPipelineBlueprint.go b/service/osis/api_op_GetPipelineBlueprint.go index 6e5ee917c95..3193322b848 100644 --- a/service/osis/api_op_GetPipelineBlueprint.go +++ b/service/osis/api_op_GetPipelineBlueprint.go @@ -13,8 +13,9 @@ import ( // Retrieves information about a specific blueprint for OpenSearch Ingestion. // Blueprints are templates for the configuration needed for a CreatePipeline -// request. For more information, see Using blueprints to create a pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint) -// . +// request. For more information, see [Using blueprints to create a pipeline]. +// +// [Using blueprints to create a pipeline]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint func (c *Client) GetPipelineBlueprint(ctx context.Context, params *GetPipelineBlueprintInput, optFns ...func(*Options)) (*GetPipelineBlueprintOutput, error) { if params == nil { params = &GetPipelineBlueprintInput{} diff --git a/service/osis/api_op_GetPipelineChangeProgress.go b/service/osis/api_op_GetPipelineChangeProgress.go index 43b599ca647..3e335f2cb4c 100644 --- a/service/osis/api_op_GetPipelineChangeProgress.go +++ b/service/osis/api_op_GetPipelineChangeProgress.go @@ -13,9 +13,11 @@ import ( // Returns progress information for the current change happening on an OpenSearch // Ingestion pipeline. Currently, this operation only returns information when a -// pipeline is being created. For more information, see Tracking the status of -// pipeline creation (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress) -// . +// pipeline is being created. +// +// For more information, see [Tracking the status of pipeline creation]. +// +// [Tracking the status of pipeline creation]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress func (c *Client) GetPipelineChangeProgress(ctx context.Context, params *GetPipelineChangeProgressInput, optFns ...func(*Options)) (*GetPipelineChangeProgressOutput, error) { if params == nil { params = &GetPipelineChangeProgressInput{} diff --git a/service/osis/api_op_ListPipelineBlueprints.go b/service/osis/api_op_ListPipelineBlueprints.go index cf7176d3f75..8b6d7900d4f 100644 --- a/service/osis/api_op_ListPipelineBlueprints.go +++ b/service/osis/api_op_ListPipelineBlueprints.go @@ -12,8 +12,9 @@ import ( ) // Retrieves a list of all available blueprints for Data Prepper. For more -// information, see Using blueprints to create a pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint) -// . +// information, see [Using blueprints to create a pipeline]. +// +// [Using blueprints to create a pipeline]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint func (c *Client) ListPipelineBlueprints(ctx context.Context, params *ListPipelineBlueprintsInput, optFns ...func(*Options)) (*ListPipelineBlueprintsOutput, error) { if params == nil { params = &ListPipelineBlueprintsInput{} diff --git a/service/osis/api_op_ListPipelines.go b/service/osis/api_op_ListPipelines.go index ac13b0f21bd..f2af7837038 100644 --- a/service/osis/api_op_ListPipelines.go +++ b/service/osis/api_op_ListPipelines.go @@ -12,9 +12,9 @@ import ( ) // Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services -// account and Region. For more information, see Viewing Amazon OpenSearch -// Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html) -// . +// account and Region. For more information, see [Viewing Amazon OpenSearch Ingestion pipelines]. +// +// [Viewing Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error) { if params == nil { params = &ListPipelinesInput{} diff --git a/service/osis/api_op_ListTagsForResource.go b/service/osis/api_op_ListTagsForResource.go index b7b34a7b6e5..0aeae38cb29 100644 --- a/service/osis/api_op_ListTagsForResource.go +++ b/service/osis/api_op_ListTagsForResource.go @@ -12,8 +12,9 @@ import ( ) // Lists all resource tags associated with an OpenSearch Ingestion pipeline. For -// more information, see Tagging Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html) -// . +// more information, see [Tagging Amazon OpenSearch Ingestion pipelines]. +// +// [Tagging Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/osis/api_op_StartPipeline.go b/service/osis/api_op_StartPipeline.go index 28cc6ee4197..6bfa3b66645 100644 --- a/service/osis/api_op_StartPipeline.go +++ b/service/osis/api_op_StartPipeline.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an OpenSearch Ingestion pipeline. For more information, see Starting an -// OpenSearch Ingestion pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--start) -// . +// Starts an OpenSearch Ingestion pipeline. For more information, see [Starting an OpenSearch Ingestion pipeline]. +// +// [Starting an OpenSearch Ingestion pipeline]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--start func (c *Client) StartPipeline(ctx context.Context, params *StartPipelineInput, optFns ...func(*Options)) (*StartPipelineOutput, error) { if params == nil { params = &StartPipelineInput{} diff --git a/service/osis/api_op_StopPipeline.go b/service/osis/api_op_StopPipeline.go index 812c23a2a70..2770b78d888 100644 --- a/service/osis/api_op_StopPipeline.go +++ b/service/osis/api_op_StopPipeline.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an -// OpenSearch Ingestion pipeline (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--stop) -// . +// Stops an OpenSearch Ingestion pipeline. For more information, see [Stopping an OpenSearch Ingestion pipeline]. +// +// [Stopping an OpenSearch Ingestion pipeline]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--stop func (c *Client) StopPipeline(ctx context.Context, params *StopPipelineInput, optFns ...func(*Options)) (*StopPipelineOutput, error) { if params == nil { params = &StopPipelineInput{} diff --git a/service/osis/api_op_TagResource.go b/service/osis/api_op_TagResource.go index 582a02a65ab..0d075ddc16a 100644 --- a/service/osis/api_op_TagResource.go +++ b/service/osis/api_op_TagResource.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon -// OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html) -// . +// Tags an OpenSearch Ingestion pipeline. For more information, see [Tagging Amazon OpenSearch Ingestion pipelines]. +// +// [Tagging Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/osis/api_op_UntagResource.go b/service/osis/api_op_UntagResource.go index 716d9285bda..42b930bc3ef 100644 --- a/service/osis/api_op_UntagResource.go +++ b/service/osis/api_op_UntagResource.go @@ -11,8 +11,9 @@ import ( ) // Removes one or more tags from an OpenSearch Ingestion pipeline. For more -// information, see Tagging Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html) -// . +// information, see [Tagging Amazon OpenSearch Ingestion pipelines]. +// +// [Tagging Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/osis/api_op_UpdatePipeline.go b/service/osis/api_op_UpdatePipeline.go index 568e19ccfaa..7b55db0241f 100644 --- a/service/osis/api_op_UpdatePipeline.go +++ b/service/osis/api_op_UpdatePipeline.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an OpenSearch Ingestion pipeline. For more information, see Updating -// Amazon OpenSearch Ingestion pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/update-pipeline.html) -// . +// Updates an OpenSearch Ingestion pipeline. For more information, see [Updating Amazon OpenSearch Ingestion pipelines]. +// +// [Updating Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/update-pipeline.html func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput, optFns ...func(*Options)) (*UpdatePipelineOutput, error) { if params == nil { params = &UpdatePipelineInput{} diff --git a/service/osis/api_op_ValidatePipeline.go b/service/osis/api_op_ValidatePipeline.go index 69b159eeb0c..6ebf42159f9 100644 --- a/service/osis/api_op_ValidatePipeline.go +++ b/service/osis/api_op_ValidatePipeline.go @@ -12,9 +12,9 @@ import ( ) // Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to -// creation. For more information, see Creating Amazon OpenSearch Ingestion -// pipelines (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html) -// . +// creation. For more information, see [Creating Amazon OpenSearch Ingestion pipelines]. +// +// [Creating Amazon OpenSearch Ingestion pipelines]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html func (c *Client) ValidatePipeline(ctx context.Context, params *ValidatePipelineInput, optFns ...func(*Options)) (*ValidatePipelineOutput, error) { if params == nil { params = &ValidatePipelineInput{} diff --git a/service/osis/doc.go b/service/osis/doc.go index 9d9610c8322..c97bf009c2a 100644 --- a/service/osis/doc.go +++ b/service/osis/doc.go @@ -6,6 +6,7 @@ // Use the Amazon OpenSearch Ingestion API to create and manage ingestion // pipelines. OpenSearch Ingestion is a fully managed data collector that delivers // real-time log and trace data to OpenSearch Service domains. For more -// information, see Getting data into your cluster using OpenSearch Ingestion (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html) -// . +// information, see [Getting data into your cluster using OpenSearch Ingestion]. +// +// [Getting data into your cluster using OpenSearch Ingestion]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html package osis diff --git a/service/osis/options.go b/service/osis/options.go index 467d937e6f0..008834c5cf6 100644 --- a/service/osis/options.go +++ b/service/osis/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/osis/types/enums.go b/service/osis/types/enums.go index 8acd62fbbd8..2246aa0bef0 100644 --- a/service/osis/types/enums.go +++ b/service/osis/types/enums.go @@ -14,6 +14,7 @@ const ( // Values returns all known values for ChangeProgressStageStatuses. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ChangeProgressStageStatuses) Values() []ChangeProgressStageStatuses { return []ChangeProgressStageStatuses{ @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for ChangeProgressStatuses. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeProgressStatuses) Values() []ChangeProgressStatuses { return []ChangeProgressStatuses{ "PENDING", @@ -63,8 +65,9 @@ const ( ) // Values returns all known values for PipelineStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineStatus) Values() []PipelineStatus { return []PipelineStatus{ "CREATING", @@ -88,8 +91,9 @@ const ( ) // Values returns all known values for VpcEndpointServiceName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VpcEndpointServiceName) Values() []VpcEndpointServiceName { return []VpcEndpointServiceName{ "OPENSEARCH_SERVERLESS", diff --git a/service/outposts/api_op_CancelOrder.go b/service/outposts/api_op_CancelOrder.go index a580e3ad136..d71fedb63bc 100644 --- a/service/outposts/api_op_CancelOrder.go +++ b/service/outposts/api_op_CancelOrder.go @@ -28,7 +28,7 @@ func (c *Client) CancelOrder(ctx context.Context, params *CancelOrderInput, optF type CancelOrderInput struct { - // The ID of the order. + // The ID of the order. // // This member is required. OrderId *string diff --git a/service/outposts/api_op_CreateOrder.go b/service/outposts/api_op_CreateOrder.go index 1e46865de14..ccf965828e1 100644 --- a/service/outposts/api_op_CreateOrder.go +++ b/service/outposts/api_op_CreateOrder.go @@ -34,7 +34,7 @@ type CreateOrderInput struct { // This member is required. LineItems []types.LineItemRequest - // The ID or the Amazon Resource Name (ARN) of the Outpost. + // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostIdentifier *string diff --git a/service/outposts/api_op_CreateOutpost.go b/service/outposts/api_op_CreateOutpost.go index f96033ea966..6aeadebc683 100644 --- a/service/outposts/api_op_CreateOutpost.go +++ b/service/outposts/api_op_CreateOutpost.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Outpost. You can specify either an Availability one or an AZ ID. +// Creates an Outpost. +// +// You can specify either an Availability one or an AZ ID. func (c *Client) CreateOutpost(ctx context.Context, params *CreateOutpostInput, optFns ...func(*Options)) (*CreateOutpostOutput, error) { if params == nil { params = &CreateOutpostInput{} @@ -34,7 +36,7 @@ type CreateOutpostInput struct { // This member is required. Name *string - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string @@ -48,7 +50,7 @@ type CreateOutpostInput struct { // The description of the Outpost. Description *string - // The type of hardware for this Outpost. + // The type of hardware for this Outpost. SupportedHardwareType types.SupportedHardwareType // The tags to apply to the Outpost. diff --git a/service/outposts/api_op_CreateSite.go b/service/outposts/api_op_CreateSite.go index c894491d2f9..aa5ffbb824b 100644 --- a/service/outposts/api_op_CreateSite.go +++ b/service/outposts/api_op_CreateSite.go @@ -42,21 +42,22 @@ type CreateSiteInput struct { // equipment materials that could affect your installation process. Notes *string - // The location to install and power on the hardware. This address might be + // The location to install and power on the hardware. This address might be // 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) - // in the Amazon Web Services Outposts User Guide. + // 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]in the + // Amazon Web Services Outposts User Guide. + // + // [Network readiness checklist]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist RackPhysicalProperties *types.RackPhysicalProperties - // The location to ship the hardware. This address might be different from the + // The location to ship the hardware. This address might be different from the // operating address. ShippingAddress *types.Address - // The tags to apply to a site. + // The tags to apply to a site. Tags map[string]string noSmithyDocumentSerde diff --git a/service/outposts/api_op_DeleteOutpost.go b/service/outposts/api_op_DeleteOutpost.go index a4b3f4d7fd6..d36d2893d8f 100644 --- a/service/outposts/api_op_DeleteOutpost.go +++ b/service/outposts/api_op_DeleteOutpost.go @@ -28,7 +28,7 @@ func (c *Client) DeleteOutpost(ctx context.Context, params *DeleteOutpostInput, type DeleteOutpostInput struct { - // The ID or ARN of the Outpost. + // The ID or ARN of the Outpost. // // This member is required. OutpostId *string diff --git a/service/outposts/api_op_DeleteSite.go b/service/outposts/api_op_DeleteSite.go index c7c7d618923..a5369a9c1f5 100644 --- a/service/outposts/api_op_DeleteSite.go +++ b/service/outposts/api_op_DeleteSite.go @@ -28,7 +28,7 @@ func (c *Client) DeleteSite(ctx context.Context, params *DeleteSiteInput, optFns type DeleteSiteInput struct { - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string diff --git a/service/outposts/api_op_GetCapacityTask.go b/service/outposts/api_op_GetCapacityTask.go index 121aa23551f..4f7dad4be13 100644 --- a/service/outposts/api_op_GetCapacityTask.go +++ b/service/outposts/api_op_GetCapacityTask.go @@ -48,11 +48,15 @@ type GetCapacityTaskOutput struct { // ID of the capacity task. CapacityTaskId *string - // Status of the capacity task. A capacity task can have one of the following - // statuses: + // Status of the capacity task. + // + // A capacity task can have one of the following statuses: + // // - REQUESTED - The capacity task was created and is awaiting the next step by // Amazon Web Services Outposts. + // // - IN_PROGRESS - The capacity task is running and cannot be cancelled. + // // - WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You // must stop the recommended EC2 running instances to free up capacity for the task // to run. diff --git a/service/outposts/api_op_GetConnection.go b/service/outposts/api_op_GetConnection.go index 457f060db3d..29cec7009a8 100644 --- a/service/outposts/api_op_GetConnection.go +++ b/service/outposts/api_op_GetConnection.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services Outposts User Guide. +// 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]and [Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail] in +// the Amazon Web Services Outposts User Guide. +// +// [Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail]: https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html +// [Amazon Web Services managed policies for Amazon Web Services Outposts]: https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html func (c *Client) GetConnection(ctx context.Context, params *GetConnectionInput, optFns ...func(*Options)) (*GetConnectionOutput, error) { if params == nil { params = &GetConnectionInput{} @@ -36,7 +38,7 @@ func (c *Client) GetConnection(ctx context.Context, params *GetConnectionInput, type GetConnectionInput struct { - // The ID of the connection. + // The ID of the connection. // // This member is required. ConnectionId *string @@ -46,10 +48,10 @@ type GetConnectionInput struct { type GetConnectionOutput struct { - // Information about the connection. + // Information about the connection. ConnectionDetails *types.ConnectionDetails - // The ID of the connection. + // The ID of the connection. ConnectionId *string // Metadata pertaining to the operation's result. diff --git a/service/outposts/api_op_GetOutpost.go b/service/outposts/api_op_GetOutpost.go index c7e1507f314..9f74a4bbc94 100644 --- a/service/outposts/api_op_GetOutpost.go +++ b/service/outposts/api_op_GetOutpost.go @@ -29,7 +29,7 @@ func (c *Client) GetOutpost(ctx context.Context, params *GetOutpostInput, optFns type GetOutpostInput struct { - // The ID or ARN of the Outpost. + // The ID or ARN of the Outpost. // // This member is required. OutpostId *string diff --git a/service/outposts/api_op_GetOutpostInstanceTypes.go b/service/outposts/api_op_GetOutpostInstanceTypes.go index 928eabccdc9..af25bfea9d8 100644 --- a/service/outposts/api_op_GetOutpostInstanceTypes.go +++ b/service/outposts/api_op_GetOutpostInstanceTypes.go @@ -29,7 +29,7 @@ func (c *Client) GetOutpostInstanceTypes(ctx context.Context, params *GetOutpost type GetOutpostInstanceTypesInput struct { - // The ID or ARN of the Outpost. + // The ID or ARN of the Outpost. // // This member is required. OutpostId *string @@ -54,7 +54,7 @@ type GetOutpostInstanceTypesOutput struct { // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string - // The ID of the Outpost. + // The ID of the Outpost. OutpostId *string // Metadata pertaining to the operation's result. diff --git a/service/outposts/api_op_GetSite.go b/service/outposts/api_op_GetSite.go index e3a55f972fa..dbcf7c17c9d 100644 --- a/service/outposts/api_op_GetSite.go +++ b/service/outposts/api_op_GetSite.go @@ -29,7 +29,7 @@ func (c *Client) GetSite(ctx context.Context, params *GetSiteInput, optFns ...fu type GetSiteInput struct { - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string diff --git a/service/outposts/api_op_GetSiteAddress.go b/service/outposts/api_op_GetSiteAddress.go index 677a817b94d..fe62c611385 100644 --- a/service/outposts/api_op_GetSiteAddress.go +++ b/service/outposts/api_op_GetSiteAddress.go @@ -34,7 +34,7 @@ type GetSiteAddressInput struct { // This member is required. AddressType types.AddressType - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string @@ -44,7 +44,7 @@ type GetSiteAddressInput struct { type GetSiteAddressOutput struct { - // Information about the address. + // Information about the address. Address *types.Address // The type of the address you receive. diff --git a/service/outposts/api_op_ListAssets.go b/service/outposts/api_op_ListAssets.go index 83e37a3fcc8..70df191643c 100644 --- a/service/outposts/api_op_ListAssets.go +++ b/service/outposts/api_op_ListAssets.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the hardware assets for the specified Outpost. Use filters to return -// specific results. If you specify multiple filters, the results include only the -// resources that match all of the specified filters. For a filter where you can -// specify multiple values, the results include items that match any of the values -// that you specify for the filter. +// Lists the hardware assets for the specified Outpost. +// +// Use filters to return specific results. If you specify multiple filters, the +// results include only the resources that match all of the specified filters. For +// a filter where you can specify multiple values, the results include items that +// match any of the values that you specify for the filter. func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error) { if params == nil { params = &ListAssetsInput{} @@ -33,7 +34,7 @@ func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns type ListAssetsInput struct { - // The ID or the Amazon Resource Name (ARN) of the Outpost. + // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostIdentifier *string diff --git a/service/outposts/api_op_ListCapacityTasks.go b/service/outposts/api_op_ListCapacityTasks.go index d7bc4f5bc43..c07db7a475b 100644 --- a/service/outposts/api_op_ListCapacityTasks.go +++ b/service/outposts/api_op_ListCapacityTasks.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the capacity tasks for your Amazon Web Services account. Use filters to -// return specific results. If you specify multiple filters, the results include -// only the resources that match all of the specified filters. For a filter where -// you can specify multiple values, the results include items that match any of the -// values that you specify for the filter. +// Lists the capacity tasks for your Amazon Web Services account. +// +// Use filters to return specific results. If you specify multiple filters, the +// results include only the resources that match all of the specified filters. For +// a filter where you can specify multiple values, the results include items that +// match any of the values that you specify for the filter. func (c *Client) ListCapacityTasks(ctx context.Context, params *ListCapacityTasksInput, optFns ...func(*Options)) (*ListCapacityTasksOutput, error) { if params == nil { params = &ListCapacityTasksInput{} diff --git a/service/outposts/api_op_ListCatalogItems.go b/service/outposts/api_op_ListCatalogItems.go index 07a0cd53f3a..8a9dfee059b 100644 --- a/service/outposts/api_op_ListCatalogItems.go +++ b/service/outposts/api_op_ListCatalogItems.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the items in the catalog. Use filters to return specific results. If you -// specify multiple filters, the results include only the resources that match all -// of the specified filters. For a filter where you can specify multiple values, -// the results include items that match any of the values that you specify for the -// filter. +// Lists the items in the catalog. +// +// Use filters to return specific results. If you specify multiple filters, the +// results include only the resources that match all of the specified filters. For +// a filter where you can specify multiple values, the results include items that +// match any of the values that you specify for the filter. func (c *Client) ListCatalogItems(ctx context.Context, params *ListCatalogItemsInput, optFns ...func(*Options)) (*ListCatalogItemsOutput, error) { if params == nil { params = &ListCatalogItemsInput{} diff --git a/service/outposts/api_op_ListOrders.go b/service/outposts/api_op_ListOrders.go index 86f4d7dcd2c..02e4e201220 100644 --- a/service/outposts/api_op_ListOrders.go +++ b/service/outposts/api_op_ListOrders.go @@ -35,7 +35,7 @@ type ListOrdersInput struct { // The pagination token. NextToken *string - // The ID or the Amazon Resource Name (ARN) of the Outpost. + // The ID or the Amazon Resource Name (ARN) of the Outpost. OutpostIdentifierFilter *string noSmithyDocumentSerde @@ -46,7 +46,7 @@ type ListOrdersOutput struct { // The pagination token. NextToken *string - // Information about the orders. + // Information about the orders. Orders []types.OrderSummary // Metadata pertaining to the operation's result. diff --git a/service/outposts/api_op_ListOutposts.go b/service/outposts/api_op_ListOutposts.go index ab0fe8d6874..a11368ce959 100644 --- a/service/outposts/api_op_ListOutposts.go +++ b/service/outposts/api_op_ListOutposts.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the Outposts for your Amazon Web Services account. Use filters to return -// specific results. If you specify multiple filters, the results include only the -// resources that match all of the specified filters. For a filter where you can -// specify multiple values, the results include items that match any of the values -// that you specify for the filter. +// Lists the Outposts for your Amazon Web Services account. +// +// Use filters to return specific results. If you specify multiple filters, the +// results include only the resources that match all of the specified filters. For +// a filter where you can specify multiple values, the results include items that +// match any of the values that you specify for the filter. func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, optFns ...func(*Options)) (*ListOutpostsOutput, error) { if params == nil { params = &ListOutpostsInput{} diff --git a/service/outposts/api_op_ListSites.go b/service/outposts/api_op_ListSites.go index 676c2dd3a88..0df4b79b4bb 100644 --- a/service/outposts/api_op_ListSites.go +++ b/service/outposts/api_op_ListSites.go @@ -12,11 +12,12 @@ import ( ) // Lists the Outpost sites for your Amazon Web Services account. Use filters to -// return specific results. Use filters to return specific results. If you specify -// multiple filters, the results include only the resources that match all of the -// specified filters. For a filter where you can specify multiple values, the -// results include items that match any of the values that you specify for the -// filter. +// return specific results. +// +// Use filters to return specific results. If you specify multiple filters, the +// results include only the resources that match all of the specified filters. For +// a filter where you can specify multiple values, the results include items that +// match any of the values that you specify for the filter. func (c *Client) ListSites(ctx context.Context, params *ListSitesInput, optFns ...func(*Options)) (*ListSitesOutput, error) { if params == nil { params = &ListSitesInput{} diff --git a/service/outposts/api_op_StartConnection.go b/service/outposts/api_op_StartConnection.go index 625a6fd7cc7..e8303bb44f7 100644 --- a/service/outposts/api_op_StartConnection.go +++ b/service/outposts/api_op_StartConnection.go @@ -10,14 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services Outposts User Guide. +// 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]and [Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail] in +// the Amazon Web Services Outposts User Guide. +// +// [Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail]: https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html +// [Amazon Web Services managed policies for Amazon Web Services Outposts]: https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html func (c *Client) StartConnection(ctx context.Context, params *StartConnectionInput, optFns ...func(*Options)) (*StartConnectionOutput, error) { if params == nil { params = &StartConnectionInput{} @@ -35,22 +37,22 @@ func (c *Client) StartConnection(ctx context.Context, params *StartConnectionInp type StartConnectionInput struct { - // The ID of the Outpost server. + // The ID of the Outpost server. // // This member is required. AssetId *string - // The public key of the client. + // The public key of the client. // // This member is required. ClientPublicKey *string - // The device index of the network interface on the Outpost server. + // The device index of the network interface on the Outpost server. // // This member is required. NetworkInterfaceDeviceIndex int32 - // The serial number of the dongle. + // The serial number of the dongle. DeviceSerialNumber *string noSmithyDocumentSerde @@ -58,10 +60,10 @@ type StartConnectionInput struct { type StartConnectionOutput struct { - // The ID of the connection. + // The ID of the connection. ConnectionId *string - // The underlay IP address. + // The underlay IP address. UnderlayIpAddress *string // Metadata pertaining to the operation's result. diff --git a/service/outposts/api_op_UpdateOutpost.go b/service/outposts/api_op_UpdateOutpost.go index 598289c163a..81c63787984 100644 --- a/service/outposts/api_op_UpdateOutpost.go +++ b/service/outposts/api_op_UpdateOutpost.go @@ -29,7 +29,7 @@ func (c *Client) UpdateOutpost(ctx context.Context, params *UpdateOutpostInput, type UpdateOutpostInput struct { - // The ID or ARN of the Outpost. + // The ID or ARN of the Outpost. // // This member is required. OutpostId *string @@ -40,7 +40,7 @@ type UpdateOutpostInput struct { // The name of the Outpost. Name *string - // The type of hardware for this Outpost. + // The type of hardware for this Outpost. SupportedHardwareType types.SupportedHardwareType noSmithyDocumentSerde diff --git a/service/outposts/api_op_UpdateSite.go b/service/outposts/api_op_UpdateSite.go index 9561ef02397..83081870c09 100644 --- a/service/outposts/api_op_UpdateSite.go +++ b/service/outposts/api_op_UpdateSite.go @@ -29,7 +29,7 @@ func (c *Client) UpdateSite(ctx context.Context, params *UpdateSiteInput, optFns type UpdateSiteInput struct { - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string diff --git a/service/outposts/api_op_UpdateSiteAddress.go b/service/outposts/api_op_UpdateSiteAddress.go index 69ad855e02b..f476b80f733 100644 --- a/service/outposts/api_op_UpdateSiteAddress.go +++ b/service/outposts/api_op_UpdateSiteAddress.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the address of the specified site. You can't update a site address if -// there is an order in progress. You must wait for the order to complete or cancel -// the order. You can update the operating address before you place an order at the -// site, or after all Outposts that belong to the site have been deactivated. +// Updates the address of the specified site. +// +// You can't update a site address if there is an order in progress. You must wait +// for the order to complete or cancel the order. +// +// You can update the operating address before you place an order at the site, or +// after all Outposts that belong to the site have been deactivated. func (c *Client) UpdateSiteAddress(ctx context.Context, params *UpdateSiteAddressInput, optFns ...func(*Options)) (*UpdateSiteAddressOutput, error) { if params == nil { params = &UpdateSiteAddressInput{} @@ -32,17 +35,17 @@ func (c *Client) UpdateSiteAddress(ctx context.Context, params *UpdateSiteAddres type UpdateSiteAddressInput struct { - // The address for the site. + // The address for the site. // // This member is required. Address *types.Address - // The type of the address. + // The type of the address. // // This member is required. AddressType types.AddressType - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string @@ -52,10 +55,10 @@ type UpdateSiteAddressInput struct { type UpdateSiteAddressOutput struct { - // Information about an address. + // Information about an address. Address *types.Address - // The type of the address. + // The type of the address. AddressType types.AddressType // Metadata pertaining to the operation's result. diff --git a/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go b/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go index d45fdfac345..87303f03557 100644 --- a/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go +++ b/service/outposts/api_op_UpdateSiteRackPhysicalProperties.go @@ -12,11 +12,13 @@ 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) -// 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 -// order. +// information about hardware requirements for racks, see [Network readiness 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 order. +// +// [Network readiness checklist]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist func (c *Client) UpdateSiteRackPhysicalProperties(ctx context.Context, params *UpdateSiteRackPhysicalPropertiesInput, optFns ...func(*Options)) (*UpdateSiteRackPhysicalPropertiesOutput, error) { if params == nil { params = &UpdateSiteRackPhysicalPropertiesInput{} @@ -34,7 +36,7 @@ func (c *Client) UpdateSiteRackPhysicalProperties(ctx context.Context, params *U type UpdateSiteRackPhysicalPropertiesInput struct { - // The ID or the Amazon Resource Name (ARN) of the site. + // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string @@ -48,31 +50,51 @@ 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) - // in the Amazon Web Services Outposts User Guide. + // racks, see [Network]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 + // + // [Network]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking 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 types.PowerConnector @@ -84,7 +106,9 @@ 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 PowerPhase types.PowerPhase @@ -93,8 +117,11 @@ type UpdateSiteRackPhysicalPropertiesInput struct { // 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 UplinkCount types.UplinkCount diff --git a/service/outposts/options.go b/service/outposts/options.go index 5c4fa3244f0..ac35fc3254d 100644 --- a/service/outposts/options.go +++ b/service/outposts/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/outposts/types/enums.go b/service/outposts/types/enums.go index 2ca1702240a..b2cd4000de9 100644 --- a/service/outposts/types/enums.go +++ b/service/outposts/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AddressType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddressType) Values() []AddressType { return []AddressType{ "SHIPPING_ADDRESS", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AssetState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetState) Values() []AssetState { return []AssetState{ "ACTIVE", @@ -48,8 +50,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -64,8 +67,9 @@ const ( ) // Values returns all known values for CapacityTaskFailureType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityTaskFailureType) Values() []CapacityTaskFailureType { return []CapacityTaskFailureType{ "UNSUPPORTED_CAPACITY_CONFIGURATION", @@ -84,8 +88,9 @@ const ( ) // Values returns all known values for CapacityTaskStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacityTaskStatus) Values() []CapacityTaskStatus { return []CapacityTaskStatus{ "REQUESTED", @@ -105,8 +110,9 @@ const ( ) // Values returns all known values for CatalogItemClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CatalogItemClass) Values() []CatalogItemClass { return []CatalogItemClass{ "RACK", @@ -123,8 +129,9 @@ const ( ) // Values returns all known values for CatalogItemStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CatalogItemStatus) Values() []CatalogItemStatus { return []CatalogItemStatus{ "AVAILABLE", @@ -142,8 +149,9 @@ const ( ) // Values returns all known values for ComputeAssetState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeAssetState) Values() []ComputeAssetState { return []ComputeAssetState{ "ACTIVE", @@ -161,8 +169,9 @@ const ( ) // Values returns all known values for FiberOpticCableType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FiberOpticCableType) Values() []FiberOpticCableType { return []FiberOpticCableType{ "SINGLE_MODE", @@ -186,8 +195,9 @@ const ( ) // Values returns all known values for LineItemStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineItemStatus) Values() []LineItemStatus { return []LineItemStatus{ "PREPARING", @@ -215,6 +225,7 @@ const ( // Values returns all known values for MaximumSupportedWeightLbs. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MaximumSupportedWeightLbs) Values() []MaximumSupportedWeightLbs { return []MaximumSupportedWeightLbs{ @@ -246,8 +257,9 @@ const ( ) // Values returns all known values for OpticalStandard. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpticalStandard) Values() []OpticalStandard { return []OpticalStandard{ "OPTIC_10GBASE_SR", @@ -283,8 +295,9 @@ const ( ) // Values returns all known values for OrderStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderStatus) Values() []OrderStatus { return []OrderStatus{ "RECEIVED", @@ -309,8 +322,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -328,8 +342,9 @@ const ( ) // Values returns all known values for PaymentOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PaymentOption) Values() []PaymentOption { return []PaymentOption{ "ALL_UPFRONT", @@ -347,8 +362,9 @@ const ( ) // Values returns all known values for PaymentTerm. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PaymentTerm) Values() []PaymentTerm { return []PaymentTerm{ "THREE_YEARS", @@ -367,8 +383,9 @@ const ( ) // Values returns all known values for PowerConnector. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PowerConnector) Values() []PowerConnector { return []PowerConnector{ "L6_30P", @@ -389,8 +406,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -409,8 +427,9 @@ const ( ) // Values returns all known values for PowerFeedDrop. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PowerFeedDrop) Values() []PowerFeedDrop { return []PowerFeedDrop{ "ABOVE_RACK", @@ -427,8 +446,9 @@ const ( ) // Values returns all known values for PowerPhase. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PowerPhase) Values() []PowerPhase { return []PowerPhase{ "SINGLE_PHASE", @@ -445,8 +465,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -466,8 +487,9 @@ const ( ) // Values returns all known values for ShipmentCarrier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShipmentCarrier) Values() []ShipmentCarrier { return []ShipmentCarrier{ "DHL", @@ -487,8 +509,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RACK", @@ -505,8 +528,9 @@ const ( ) // Values returns all known values for SupportedStorageEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SupportedStorageEnum) Values() []SupportedStorageEnum { return []SupportedStorageEnum{ "EBS", @@ -531,8 +555,9 @@ const ( ) // Values returns all known values for UplinkCount. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UplinkCount) Values() []UplinkCount { return []UplinkCount{ "UPLINK_COUNT_1", @@ -559,8 +584,9 @@ const ( ) // Values returns all known values for UplinkGbps. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UplinkGbps) Values() []UplinkGbps { return []UplinkGbps{ "UPLINK_1G", diff --git a/service/outposts/types/types.go b/service/outposts/types/types.go index 50cbcbb3f81..dabef63c81c 100644 --- a/service/outposts/types/types.go +++ b/service/outposts/types/types.go @@ -59,19 +59,19 @@ type Address struct { // Information about hardware assets. type AssetInfo struct { - // The ID of the asset. + // The ID of the asset. AssetId *string - // The position of an asset in a rack. + // The position of an asset in a rack. AssetLocation *AssetLocation - // The type of the asset. + // The type of the asset. AssetType AssetType - // Information about compute hardware assets. + // Information about compute hardware assets. ComputeAttributes *ComputeAttributes - // The rack ID of the asset. + // The rack ID of the asset. RackId *string noSmithyDocumentSerde @@ -80,7 +80,7 @@ type AssetInfo struct { // Information about the position of the asset in a rack. type AssetLocation struct { - // The position of an asset in a rack measured in rack units. + // The position of an asset in a rack measured in rack units. RackElevation *float32 noSmithyDocumentSerde @@ -131,25 +131,25 @@ type CapacityTaskSummary struct { // Information about a catalog item. type CatalogItem struct { - // The ID of the catalog item. + // The ID of the catalog item. CatalogItemId *string - // Information about the EC2 capacity of an item. + // Information about the EC2 capacity of an item. EC2Capacities []EC2Capacity - // The status of a catalog item. + // The status of a catalog item. ItemStatus CatalogItemStatus - // Information about the power draw of an item. + // Information about the power draw of an item. PowerKva *float32 - // The supported storage options for the catalog item. + // The supported storage options for the catalog item. SupportedStorage []SupportedStorageEnum - // The uplink speed this catalog item requires for the connection to the Region. + // The uplink speed this catalog item requires for the connection to the Region. SupportedUplinkGbps []int32 - // The weight of the item in pounds. + // The weight of the item in pounds. WeightLbs *int32 noSmithyDocumentSerde @@ -158,7 +158,7 @@ type CatalogItem struct { // Information about compute hardware assets. type ComputeAttributes struct { - // The host ID of the Dedicated Host on the asset. + // The host ID of the Dedicated Host on the asset. HostId *string // A list of the names of instance families that are currently associated with a @@ -166,11 +166,14 @@ type ComputeAttributes struct { InstanceFamilies []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. @@ -182,22 +185,22 @@ type ComputeAttributes struct { // Information about a connection. type ConnectionDetails struct { - // The allowed IP addresses. + // The allowed IP addresses. AllowedIps []string - // The public key of the client. + // The public key of the client. ClientPublicKey *string - // The client tunnel address. + // The client tunnel address. ClientTunnelAddress *string - // The endpoint for the server. + // The endpoint for the server. ServerEndpoint *string - // The public key of the server. + // The public key of the server. ServerPublicKey *string - // The server tunnel address. + // The server tunnel address. ServerTunnelAddress *string noSmithyDocumentSerde @@ -206,13 +209,13 @@ type ConnectionDetails struct { // Information about EC2 capacity. type EC2Capacity struct { - // The family of the EC2 capacity. + // The family of the EC2 capacity. Family *string - // The maximum size of the EC2 capacity. + // The maximum size of the EC2 capacity. MaxSize *string - // The quantity of the EC2 capacity. + // The quantity of the EC2 capacity. Quantity *string noSmithyDocumentSerde @@ -247,10 +250,10 @@ type InstanceTypeItem struct { // Information about a line item. type LineItem struct { - // Information about assets. + // Information about assets. AssetInformationList []LineItemAssetInformation - // The ID of the catalog item. + // The ID of the catalog item. CatalogItemId *string // The ID of the line item. @@ -265,7 +268,7 @@ type LineItem struct { // The quantity of the line item. Quantity *int32 - // Information about a line item shipment. + // Information about a line item shipment. ShipmentInformation *ShipmentInformation // The status of the line item. @@ -277,10 +280,10 @@ type LineItem struct { // Information about a line item asset. type LineItemAssetInformation struct { - // The ID of the asset. + // The ID of the asset. AssetId *string - // The MAC addresses of the asset. + // The MAC addresses of the asset. MacAddressList []string noSmithyDocumentSerde @@ -316,7 +319,7 @@ type Order struct { // The type of order. OrderType OrderType - // The ID of the Outpost in the order. + // The ID of the Outpost in the order. OutpostId *string // The payment option for the order. @@ -326,12 +329,18 @@ 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 . Status OrderStatus @@ -342,31 +351,37 @@ type Order struct { // A summary of line items in your order. type OrderSummary struct { - // The status of all line items in the order. + // The status of all line items in the order. LineItemCountsByStatus map[string]int32 - // The fulfilment date for the order. + // The fulfilment date for the order. OrderFulfilledDate *time.Time - // The ID of the order. + // The ID of the order. OrderId *string - // The submission date for the order. + // The submission date for the order. OrderSubmissionDate *time.Time // The type of order. OrderType OrderType - // The ID of the Outpost. + // The ID of the Outpost. 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 . Status OrderStatus @@ -395,7 +410,7 @@ type Outpost struct { // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string - // The ID of the Outpost. + // The ID of the Outpost. OutpostId *string // The Amazon Web Services account ID of the Outpost owner. @@ -407,7 +422,7 @@ type Outpost struct { // The ID of the site. SiteId *string - // The hardware type. + // The hardware type. SupportedHardwareType SupportedHardwareType // The Outpost tags. @@ -416,10 +431,12 @@ type Outpost struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Web Services Outposts User Guide. +// Information about the physical and logistical details for racks at sites. For +// +// more information about hardware requirements for racks, see [Network readiness checklist]in the Amazon Web +// Services Outposts User Guide. +// +// [Network readiness checklist]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist type RackPhysicalProperties struct { // The type of fiber used to attach the Outpost to the network. @@ -431,9 +448,10 @@ 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) - // in the Amazon Web Services Outposts User Guide. + // device. For more information about networking requirements for racks, see [Network]in + // the Amazon Web Services Outposts User Guide. + // + // [Network]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking OpticalStandard OpticalStandard // The power connector for the hardware. @@ -460,10 +478,10 @@ type RackPhysicalProperties struct { // Information about a line item shipment. type ShipmentInformation struct { - // The carrier of the shipment. + // The carrier of the shipment. ShipmentCarrier ShipmentCarrier - // The tracking number of the shipment. + // The tracking number of the shipment. ShipmentTrackingNumber *string noSmithyDocumentSerde @@ -481,20 +499,20 @@ type Site struct { // The name of the site. Name *string - // Notes about a site. + // Notes about a site. Notes *string - // City where the hardware is installed and powered on. + // City where the hardware is installed and powered on. OperatingAddressCity *string - // The ISO-3166 two-letter country code where the hardware is installed and + // 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. + // State or region where the hardware is installed and powered on. OperatingAddressStateOrRegion *string - // Information about the physical and logistical details for a rack at the site. + // Information about the physical and logistical details for a rack at the site. RackPhysicalProperties *RackPhysicalProperties // The Amazon Resource Name (ARN) of the site. diff --git a/service/panorama/api_op_DeletePackage.go b/service/panorama/api_op_DeletePackage.go index 0881fff93ff..c0c581e3f15 100644 --- a/service/panorama/api_op_DeletePackage.go +++ b/service/panorama/api_op_DeletePackage.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a package. To delete a package, you need permission to call -// s3:DeleteObject in addition to permissions for the AWS Panorama API. +// Deletes a package. +// +// To delete a package, you need permission to call s3:DeleteObject in addition to +// permissions for the AWS Panorama API. func (c *Client) DeletePackage(ctx context.Context, params *DeletePackageInput, optFns ...func(*Options)) (*DeletePackageOutput, error) { if params == nil { params = &DeletePackageInput{} diff --git a/service/panorama/doc.go b/service/panorama/doc.go index 8ce0f2373e9..894445fedf6 100644 --- a/service/panorama/doc.go +++ b/service/panorama/doc.go @@ -3,7 +3,12 @@ // Package panorama provides the API client, operations, and parameter types for // 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) +// # AWS Panorama +// +// # Overview +// +// This is the AWS Panorama API Reference. For an introduction to the service, see [What is AWS Panorama?] // in the AWS Panorama Developer Guide. +// +// [What is AWS Panorama?]: https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html package panorama diff --git a/service/panorama/options.go b/service/panorama/options.go index 7586bafeb49..d448b7c1ce1 100644 --- a/service/panorama/options.go +++ b/service/panorama/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/panorama/types/enums.go b/service/panorama/types/enums.go index 029a6b111f8..ee1f7ca84ec 100644 --- a/service/panorama/types/enums.go +++ b/service/panorama/types/enums.go @@ -13,8 +13,9 @@ const ( // Values returns all known values for ApplicationInstanceHealthStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationInstanceHealthStatus) Values() []ApplicationInstanceHealthStatus { return []ApplicationInstanceHealthStatus{ "RUNNING", @@ -42,6 +43,7 @@ const ( // Values returns all known values for ApplicationInstanceStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationInstanceStatus) Values() []ApplicationInstanceStatus { return []ApplicationInstanceStatus{ @@ -68,8 +70,9 @@ const ( ) // Values returns all known values for ConnectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionType) Values() []ConnectionType { return []ConnectionType{ "STATIC_IP", @@ -87,8 +90,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -114,8 +118,9 @@ const ( ) // Values returns all known values for DeviceAggregatedStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceAggregatedStatus) Values() []DeviceAggregatedStatus { return []DeviceAggregatedStatus{ "ERROR", @@ -140,8 +145,9 @@ const ( ) // Values returns all known values for DeviceBrand. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceBrand) Values() []DeviceBrand { return []DeviceBrand{ "AWS_PANORAMA", @@ -161,8 +167,9 @@ const ( ) // Values returns all known values for DeviceConnectionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceConnectionStatus) Values() []DeviceConnectionStatus { return []DeviceConnectionStatus{ "ONLINE", @@ -191,8 +198,9 @@ const ( ) // Values returns all known values for DeviceReportedStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceReportedStatus) Values() []DeviceReportedStatus { return []DeviceReportedStatus{ "STOPPING", @@ -222,8 +230,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -244,8 +253,9 @@ const ( ) // Values returns all known values for DeviceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceType) Values() []DeviceType { return []DeviceType{ "PANORAMA_APPLIANCE_DEVELOPER_KIT", @@ -261,8 +271,9 @@ const ( ) // Values returns all known values for JobResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobResourceType) Values() []JobResourceType { return []JobResourceType{ "PACKAGE", @@ -278,8 +289,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "OTA", @@ -298,8 +310,9 @@ const ( ) // Values returns all known values for ListDevicesSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListDevicesSortBy) Values() []ListDevicesSortBy { return []ListDevicesSortBy{ "DEVICE_ID", @@ -319,8 +332,9 @@ const ( ) // Values returns all known values for NetworkConnectionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkConnectionStatus) Values() []NetworkConnectionStatus { return []NetworkConnectionStatus{ "CONNECTED", @@ -340,8 +354,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -362,6 +377,7 @@ const ( // Values returns all known values for NodeFromTemplateJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NodeFromTemplateJobStatus) Values() []NodeFromTemplateJobStatus { return []NodeFromTemplateJobStatus{ @@ -382,8 +398,9 @@ const ( ) // Values returns all known values for NodeInstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeInstanceStatus) Values() []NodeInstanceStatus { return []NodeInstanceStatus{ "RUNNING", @@ -402,8 +419,9 @@ const ( ) // Values returns all known values for NodeSignalValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeSignalValue) Values() []NodeSignalValue { return []NodeSignalValue{ "PAUSE", @@ -421,8 +439,9 @@ const ( ) // Values returns all known values for PackageImportJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageImportJobStatus) Values() []PackageImportJobStatus { return []PackageImportJobStatus{ "PENDING", @@ -440,8 +459,9 @@ const ( ) // Values returns all known values for PackageImportJobType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageImportJobType) Values() []PackageImportJobType { return []PackageImportJobType{ "NODE_PACKAGE_VERSION", @@ -460,8 +480,9 @@ const ( ) // Values returns all known values for PackageVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageVersionStatus) Values() []PackageVersionStatus { return []PackageVersionStatus{ "REGISTER_PENDING", @@ -483,8 +504,9 @@ const ( ) // Values returns all known values for PortType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PortType) Values() []PortType { return []PortType{ "BOOLEAN", @@ -504,8 +526,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -527,8 +550,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -549,8 +573,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -571,8 +596,9 @@ const ( ) // Values returns all known values for UpdateProgress. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateProgress) Values() []UpdateProgress { return []UpdateProgress{ "PENDING", @@ -597,6 +623,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/paymentcryptography/api_op_CreateAlias.go b/service/paymentcryptography/api_op_CreateAlias.go index 57ca0941806..638fa14f067 100644 --- a/service/paymentcryptography/api_op_CreateAlias.go +++ b/service/paymentcryptography/api_op_CreateAlias.go @@ -13,23 +13,37 @@ import ( // Creates an alias, or a friendly name, for an Amazon Web Services Payment // Cryptography key. You can use an alias to identify a key in the console and when -// you call cryptographic operations such as EncryptData (https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_EncryptData.html) -// or DecryptData (https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_DecryptData.html) -// . You can associate the alias with any key in the same Amazon Web Services +// you call cryptographic operations such as [EncryptData]or [DecryptData]. +// +// You can associate the alias with any key in the same Amazon Web Services // Region. Each alias is associated with only one key at a time, but a key can have // multiple aliases. You can't create an alias without a key. The alias must be // unique in the account and Amazon Web Services Region, but you can create another -// alias with the same name in a different Amazon Web Services Region. To change -// the key that's associated with the alias, call UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) -// . To delete the alias, call DeleteAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html) -// . These operations don't affect the underlying key. To get the alias that you -// created, call ListAliases (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html) -// . Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - DeleteAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html) -// - GetAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html) -// - ListAliases (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html) -// - UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) +// alias with the same name in a different Amazon Web Services Region. +// +// To change the key that's associated with the alias, call [UpdateAlias]. To delete the alias, +// call [DeleteAlias]. These operations don't affect the underlying key. To get the alias that +// you created, call [ListAliases]. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [DeleteAlias] +// +// [GetAlias] +// +// [ListAliases] +// +// [UpdateAlias] +// +// [ListAliases]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html +// [DeleteAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html +// [UpdateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html +// [GetAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html +// [EncryptData]: https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_EncryptData.html +// [DecryptData]: https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/API_DecryptData.html func (c *Client) CreateAlias(ctx context.Context, params *CreateAliasInput, optFns ...func(*Options)) (*CreateAliasOutput, error) { if params == nil { params = &CreateAliasInput{} @@ -50,6 +64,7 @@ type CreateAliasInput struct { // A friendly name that you can use to refer to a key. An alias must begin with // alias/ followed by a name, for example alias/ExampleAlias . It can contain only // alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). + // // Don't include personal, confidential or sensitive information in this field. // This field may be displayed in plaintext in CloudTrail logs and other output. // diff --git a/service/paymentcryptography/api_op_CreateKey.go b/service/paymentcryptography/api_op_CreateKey.go index 2b56bfa25d8..aa4f80fd6b4 100644 --- a/service/paymentcryptography/api_op_CreateKey.go +++ b/service/paymentcryptography/api_op_CreateKey.go @@ -14,26 +14,41 @@ import ( // Creates an Amazon Web Services Payment Cryptography key, a logical // representation of a cryptographic key, that is unique in your account and Amazon // Web Services Region. You use keys for cryptographic functions such as encryption -// and decryption. In addition to the key material used in cryptographic -// operations, an Amazon Web Services Payment Cryptography key includes metadata -// such as the key ARN, key usage, key origin, creation date, description, and key -// state. When you create a key, you specify both immutable and mutable data about -// the key. The immutable data contains key attributes that define the scope and +// and decryption. +// +// In addition to the key material used in cryptographic operations, an Amazon Web +// Services Payment Cryptography key includes metadata such as the key ARN, key +// usage, key origin, creation date, description, and key state. +// +// When you create a key, you specify both immutable and mutable data about the +// key. The immutable data contains key attributes that define the scope and // cryptographic operations that you can perform using the key, for example key // class (example: SYMMETRIC_KEY ), key algorithm (example: TDES_2KEY ), key usage // (example: TR31_P0_PIN_ENCRYPTION_KEY ) and key modes of use (example: Encrypt ). -// For information about valid combinations of key attributes, see Understanding -// key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// in the Amazon Web Services Payment Cryptography User Guide. The mutable data -// contained within a key includes usage timestamp and key deletion timestamp and -// can be modified after creation. Amazon Web Services Payment Cryptography binds -// key attributes to keys using key blocks when you store or export them. Amazon -// Web Services Payment Cryptography stores the key contents wrapped and never -// stores or transmits them in the clear. Cross-account use: This operation can't -// be used across different Amazon Web Services accounts. Related operations: -// - DeleteKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) -// - GetKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html) -// - ListKeys (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html) +// For information about valid combinations of key attributes, see [Understanding key attributes]in the Amazon +// Web Services Payment Cryptography User Guide. The mutable data contained within +// a key includes usage timestamp and key deletion timestamp and can be modified +// after creation. +// +// Amazon Web Services Payment Cryptography binds key attributes to keys using key +// blocks when you store or export them. Amazon Web Services Payment Cryptography +// stores the key contents wrapped and never stores or transmits them in the clear. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [DeleteKey] +// +// [GetKey] +// +// [ListKeys] +// +// [DeleteKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html +// [GetKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html +// [ListKeys]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) CreateKey(ctx context.Context, params *CreateKeyInput, optFns ...func(*Options)) (*CreateKeyOutput, error) { if params == nil { params = &CreateKeyInput{} @@ -69,24 +84,31 @@ type CreateKeyInput struct { Enabled *bool // The algorithm that Amazon Web Services Payment Cryptography uses to calculate - // the key check value (KCV). It is used to validate the key integrity. For TDES - // keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with - // the key to be checked and retaining the 3 highest order bytes of the encrypted - // result. For AES keys, the KCV is computed using a CMAC algorithm where the input - // data is 16 bytes of zero and retaining the 3 highest order bytes of the - // encrypted result. + // the key check value (KCV). It is used to validate the key integrity. + // + // For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of + // zero, with the key to be checked and retaining the 3 highest order bytes of the + // encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where + // the input data is 16 bytes of zero and retaining the 3 highest order bytes of + // the encrypted result. KeyCheckValueAlgorithm types.KeyCheckValueAlgorithm // Assigns one or more tags to the Amazon Web Services Payment Cryptography key. // Use this parameter to tag a key when it is created. To tag an existing Amazon - // Web Services Payment Cryptography key, use the TagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html) - // operation. 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 - // can't have more than one tag on an Amazon Web Services Payment Cryptography key - // with the same tag key. Don't include personal, confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. Tagging or untagging an Amazon Web Services - // Payment Cryptography key can allow or deny permission to the key. + // Web Services Payment Cryptography key, use the [TagResource]operation. + // + // 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 can't + // have more than one tag on an Amazon Web Services Payment Cryptography key with + // the same tag key. + // + // Don't include personal, confidential or sensitive information in this field. + // This field may be displayed in plaintext in CloudTrail logs and other output. + // + // Tagging or untagging an Amazon Web Services Payment Cryptography key can allow + // or deny permission to the key. + // + // [TagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/paymentcryptography/api_op_DeleteAlias.go b/service/paymentcryptography/api_op_DeleteAlias.go index 855f51d2ba9..bed6d162de7 100644 --- a/service/paymentcryptography/api_op_DeleteAlias.go +++ b/service/paymentcryptography/api_op_DeleteAlias.go @@ -10,18 +10,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the alias, but doesn't affect the underlying key. Each key can have -// multiple aliases. To get the aliases of all keys, use the UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) -// operation. To change the alias of a key, first use DeleteAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html) -// to delete the current alias and then use CreateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html) -// to create a new alias. To associate an existing alias with a different key, call -// UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) -// . Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - CreateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html) -// - GetAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html) -// - ListAliases (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html) -// - UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) +// Deletes the alias, but doesn't affect the underlying key. +// +// Each key can have multiple aliases. To get the aliases of all keys, use the [UpdateAlias] +// operation. To change the alias of a key, first use [DeleteAlias]to delete the current alias +// and then use [CreateAlias]to create a new alias. To associate an existing alias with a +// different key, call [UpdateAlias]. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [CreateAlias] +// +// [GetAlias] +// +// [ListAliases] +// +// [UpdateAlias] +// +// [ListAliases]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html +// [DeleteAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html +// [UpdateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html +// [CreateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html +// [GetAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html func (c *Client) DeleteAlias(ctx context.Context, params *DeleteAliasInput, optFns ...func(*Options)) (*DeleteAliasOutput, error) { if params == nil { params = &DeleteAliasInput{} diff --git a/service/paymentcryptography/api_op_DeleteKey.go b/service/paymentcryptography/api_op_DeleteKey.go index 602c43f796d..b88c2cec416 100644 --- a/service/paymentcryptography/api_op_DeleteKey.go +++ b/service/paymentcryptography/api_op_DeleteKey.go @@ -12,24 +12,37 @@ import ( ) // Deletes the key material and metadata associated with Amazon Web Services -// Payment Cryptography key. Key deletion is irreversible. After a key is deleted, -// you can't perform cryptographic operations using the key. For example, you can't -// decrypt data that was encrypted by a deleted Amazon Web Services Payment -// Cryptography key, and the data may become unrecoverable. Because key deletion is -// destructive, Amazon Web Services Payment Cryptography has a safety mechanism to -// prevent accidental deletion of a key. When you call this operation, Amazon Web -// Services Payment Cryptography disables the specified key but doesn't delete it -// until after a waiting period set using DeleteKeyInDays . The default waiting -// period is 7 days. During the waiting period, the KeyState is DELETE_PENDING . -// After the key is deleted, the KeyState is DELETE_COMPLETE . You should delete a -// key only when you are sure that you don't need to use it anymore and no other -// parties are utilizing this key. If you aren't sure, consider deactivating it -// instead by calling StopKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html) -// . Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - RestoreKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RestoreKey.html) -// - StartKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html) -// - StopKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html) +// Payment Cryptography key. +// +// Key deletion is irreversible. After a key is deleted, you can't perform +// cryptographic operations using the key. For example, you can't decrypt data that +// was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the +// data may become unrecoverable. Because key deletion is destructive, Amazon Web +// Services Payment Cryptography has a safety mechanism to prevent accidental +// deletion of a key. When you call this operation, Amazon Web Services Payment +// Cryptography disables the specified key but doesn't delete it until after a +// waiting period set using DeleteKeyInDays . The default waiting period is 7 days. +// During the waiting period, the KeyState is DELETE_PENDING . After the key is +// deleted, the KeyState is DELETE_COMPLETE . +// +// You should delete a key only when you are sure that you don't need to use it +// anymore and no other parties are utilizing this key. If you aren't sure, +// consider deactivating it instead by calling [StopKeyUsage]. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [RestoreKey] +// +// [StartKeyUsage] +// +// [StopKeyUsage] +// +// [StartKeyUsage]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html +// [StopKeyUsage]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html +// [RestoreKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_RestoreKey.html func (c *Client) DeleteKey(ctx context.Context, params *DeleteKeyInput, optFns ...func(*Options)) (*DeleteKeyOutput, error) { if params == nil { params = &DeleteKeyInput{} diff --git a/service/paymentcryptography/api_op_ExportKey.go b/service/paymentcryptography/api_op_ExportKey.go index 800082c02b9..e1a4d5aa9c2 100644 --- a/service/paymentcryptography/api_op_ExportKey.go +++ b/service/paymentcryptography/api_op_ExportKey.go @@ -11,78 +11,97 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Exports a key from Amazon Web Services Payment Cryptography. Amazon Web -// Services Payment Cryptography simplifies key exchange by replacing the existing -// paper-based approach with a modern electronic approach. With ExportKey you can -// export symmetric keys using either symmetric and asymmetric key exchange -// mechanisms. Using this operation, you can share your Amazon Web Services Payment -// Cryptography generated keys with other service partners to perform cryptographic -// operations outside of Amazon Web Services Payment Cryptography For symmetric key -// exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm -// in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon -// Web Services Payment Cryptography supports ANSI X9 TR-34 norm and RSA wrap and -// unwrap key exchange mechanism. Asymmetric key exchange methods are typically -// used to establish bi-directional trust between the two parties exhanging keys -// and are used for initial key exchange such as Key Encryption Key (KEK). After -// which you can export working keys using symmetric method to perform various -// cryptographic operations within Amazon Web Services Payment Cryptography. The -// TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a -// WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, +// Exports a key from Amazon Web Services Payment Cryptography. +// +// Amazon Web Services Payment Cryptography simplifies key exchange by replacing +// the existing paper-based approach with a modern electronic approach. With +// ExportKey you can export symmetric keys using either symmetric and asymmetric +// key exchange mechanisms. Using this operation, you can share your Amazon Web +// Services Payment Cryptography generated keys with other service partners to +// perform cryptographic operations outside of Amazon Web Services Payment +// Cryptography +// +// For symmetric key exchange, Amazon Web Services Payment Cryptography uses the +// ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key +// exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm +// and RSA wrap and unwrap key exchange mechanism. Asymmetric key exchange methods +// are typically used to establish bi-directional trust between the two parties +// exhanging keys and are used for initial key exchange such as Key Encryption Key +// (KEK). After which you can export working keys using symmetric method to perform +// various cryptographic operations within Amazon Web Services Payment +// Cryptography. +// +// The TR-34 norm is intended for exchanging 3DES keys only and keys are imported +// in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, // KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap // and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported // in a WrappedKeyCryptogram format and you will need to specify the key attributes -// during import. You can also use ExportKey functionality to generate and export -// an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment -// Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated -// from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN ( -// KeySerialNumber ). The generated IPEK does not persist within Amazon Web -// Services Payment Cryptography and has to be re-generated each time during -// export. For key exchange using TR-31 or TR-34 key blocks, you can also export -// optional blocks within the key block header which contain additional attribute +// during import. +// +// You can also use ExportKey functionality to generate and export an IPEK +// (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using +// either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base +// Derivation Key) and ExportDukptInitialKey attribute KSN ( KeySerialNumber ). The +// generated IPEK does not persist within Amazon Web Services Payment Cryptography +// and has to be re-generated each time during export. +// +// For key exchange using TR-31 or TR-34 key blocks, you can also export optional +// blocks within the key block header which contain additional attribute // information about the key. The KeyVersion within KeyBlockHeaders indicates the // version of the key within the key block. Furthermore, KeyExportability within // KeyBlockHeaders can be used to further restrict exportability of the key after -// export from Amazon Web Services Payment Cryptography. The OptionalBlocks -// contain the additional data related to the key. For information on data type -// that can be included within optional blocks, refer to ASC X9.143-2022 (https://webstore.ansi.org/standards/ascx9/ansix91432022) -// . Data included in key block headers is signed but transmitted in clear text. +// export from Amazon Web Services Payment Cryptography. +// +// The OptionalBlocks contain the additional data related to the key. For +// information on data type that can be included within optional blocks, refer to [ASC X9.143-2022]. +// +// Data included in key block headers is signed but transmitted in clear text. // Sensitive or confidential information should not be included in optional blocks. -// Refer to ASC X9.143-2022 standard for information on allowed data type. To -// export initial keys (KEK) or IPEK using TR-34 Using this operation, you can -// export initial key using TR-34 asymmetric key exchange. You can only export KEK -// generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, -// the sending party of the key is called Key Distribution Host (KDH) and the -// receiving party of the key is called Key Receiving Device (KRD). During key -// export process, KDH is Amazon Web Services Payment Cryptography which initiates -// key export and KRD is the user receiving the key. To initiate TR-34 key export, -// the KRD must obtain an export token by calling GetParametersForExport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html) -// . This operation also generates a key pair for the purpose of key export, signs +// Refer to ASC X9.143-2022 standard for information on allowed data type. +// +// # To export initial keys (KEK) or IPEK using TR-34 +// +// Using this operation, you can export initial key using TR-34 asymmetric key +// exchange. You can only export KEK generated within Amazon Web Services Payment +// Cryptography. In TR-34 terminology, the sending party of the key is called Key +// Distribution Host (KDH) and the receiving party of the key is called Key +// Receiving Device (KRD). During key export process, KDH is Amazon Web Services +// Payment Cryptography which initiates key export and KRD is the user receiving +// the key. +// +// To initiate TR-34 key export, the KRD must obtain an export token by calling [GetParametersForExport]. +// This operation also generates a key pair for the purpose of key export, signs // the key and returns back the signing public key certificate (also known as KDH // signing certificate) and root certificate chain. The KDH uses the private key to // sign the the export payload and the signing public key certificate is provided // to KRD to verify the signature. The KRD can import the root certificate into its // Hardware Security Module (HSM), as required. The export token and the associated -// KDH signing certificate expires after 7 days. Next the KRD generates a key pair -// for the the purpose of encrypting the KDH key and provides the public key -// cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will -// also import the root cerificate chain into Amazon Web Services Payment -// Cryptography by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// for RootCertificatePublicKey . The KDH, Amazon Web Services Payment -// Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key -// under export and signs it with signing private key to generate a TR-34 -// WrappedKeyBlock. For more information on TR-34 key export, see section -// Exporting symmetric keys (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html) -// in the Amazon Web Services Payment Cryptography User Guide. Set the following -// parameters: +// KDH signing certificate expires after 7 days. +// +// Next the KRD generates a key pair for the the purpose of encrypting the KDH key +// and provides the public key cerificate (also known as KRD wrapping certificate) +// back to KDH. The KRD will also import the root cerificate chain into Amazon Web +// Services Payment Cryptography by calling [ImportKey]for RootCertificatePublicKey . The KDH, +// Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate +// to encrypt (wrap) the key under export and signs it with signing private key to +// generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see +// section [Exporting symmetric keys]in the Amazon Web Services Payment Cryptography User Guide. +// +// Set the following parameters: +// // - ExportAttributes : Specify export attributes in case of IPEK export. This // parameter is optional for KEK export. +// // - ExportKeyIdentifier : The KeyARN of the KEK or BDK (in case of IPEK) under // export. +// // - KeyMaterial : Use Tr34KeyBlock parameters. +// // - CertificateAuthorityPublicKeyIdentifier : The KeyARN of the certificate // chain that signed the KRD wrapping key certificate. -// - ExportToken : Obtained from KDH by calling GetParametersForImport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html) -// . +// +// - ExportToken : Obtained from KDH by calling [GetParametersForImport]. +// // - WrappingKeyCertificate : The public key certificate in PEM format (base64 // encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses // for encryption of the TR-34 export payload. This certificate must be signed by @@ -90,18 +109,24 @@ import ( // Amazon Web Services Payment Cryptography. // // When this operation is successful, Amazon Web Services Payment Cryptography -// returns the KEK or IPEK as a TR-34 WrappedKeyBlock. To export initial keys (KEK) -// or IPEK using RSA Wrap and Unwrap Using this operation, you can export initial -// key using asymmetric RSA wrap and unwrap key exchange method. To initiate -// export, generate an asymmetric key pair on the receiving HSM and obtain the -// public key certificate in PEM format (base64 encoded) for the purpose of -// wrapping and the root certifiate chain. Import the root certificate into Amazon -// Web Services Payment Cryptography by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// for RootCertificatePublicKey . Next call ExportKey and set the following -// parameters: +// returns the KEK or IPEK as a TR-34 WrappedKeyBlock. +// +// # To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap +// +// Using this operation, you can export initial key using asymmetric RSA wrap and +// unwrap key exchange method. To initiate export, generate an asymmetric key pair +// on the receiving HSM and obtain the public key certificate in PEM format (base64 +// encoded) for the purpose of wrapping and the root certifiate chain. Import the +// root certificate into Amazon Web Services Payment Cryptography by calling [ImportKey]for +// RootCertificatePublicKey . +// +// Next call ExportKey and set the following parameters: +// // - CertificateAuthorityPublicKeyIdentifier : The KeyARN of the certificate // chain that signed wrapping key certificate. +// // - KeyMaterial : Set to KeyCryptogram . +// // - WrappingKeyCertificate : The public key certificate in PEM format (base64 // encoded) obtained by the receiving HSM and signed by the root certificate // (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services @@ -109,24 +134,42 @@ import ( // the WrappedKeyCryptogram. // // When this operation is successful, Amazon Web Services Payment Cryptography -// returns the WrappedKeyCryptogram. To export working keys or IPEK using TR-31 +// returns the WrappedKeyCryptogram. +// +// # To export working keys or IPEK using TR-31 +// // Using this operation, you can export working keys or IPEK using TR-31 symmetric // key exchange. In TR-31, you must use an initial key such as KEK to encrypt or -// wrap the key under export. To establish a KEK, you can use CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// or ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . Set the following parameters: +// wrap the key under export. To establish a KEK, you can use [CreateKey]or [ImportKey]. +// +// Set the following parameters: +// // - ExportAttributes : Specify export attributes in case of IPEK export. This // parameter is optional for KEK export. +// // - ExportKeyIdentifier : The KeyARN of the KEK or BDK (in case of IPEK) under // export. +// // - KeyMaterial : Use Tr31KeyBlock parameters. // // When this operation is successful, Amazon Web Services Payment Cryptography -// returns the working key or IPEK as a TR-31 WrappedKeyBlock. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// returns the working key or IPEK as a TR-31 WrappedKeyBlock. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - GetParametersForExport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html) -// - ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) +// +// [GetParametersForExport] +// +// [ImportKey] +// +// [Exporting symmetric keys]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html +// [GetParametersForExport]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html +// [ASC X9.143-2022]: https://webstore.ansi.org/standards/ascx9/ansix91432022 +// [GetParametersForImport]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) ExportKey(ctx context.Context, params *ExportKeyInput, optFns ...func(*Options)) (*ExportKeyOutput, error) { if params == nil { params = &ExportKeyInput{} diff --git a/service/paymentcryptography/api_op_GetAlias.go b/service/paymentcryptography/api_op_GetAlias.go index a491dfe6c1c..753a467dbac 100644 --- a/service/paymentcryptography/api_op_GetAlias.go +++ b/service/paymentcryptography/api_op_GetAlias.go @@ -11,13 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the Amazon Web Services Payment Cryptography key associated with the -// alias. Cross-account use: This operation can't be used across different Amazon -// Web Services accounts. Related operations: -// - CreateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html) -// - DeleteAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html) -// - ListAliases (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html) -// - UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) +// Gets the Amazon Web Services Payment Cryptography key associated with the alias. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [CreateAlias] +// +// [DeleteAlias] +// +// [ListAliases] +// +// [UpdateAlias] +// +// [ListAliases]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html +// [DeleteAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html +// [UpdateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html +// [CreateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html func (c *Client) GetAlias(ctx context.Context, params *GetAliasInput, optFns ...func(*Options)) (*GetAliasOutput, error) { if params == nil { params = &GetAliasInput{} diff --git a/service/paymentcryptography/api_op_GetKey.go b/service/paymentcryptography/api_op_GetKey.go index 1b9c4a866b5..1d34d7a2c27 100644 --- a/service/paymentcryptography/api_op_GetKey.go +++ b/service/paymentcryptography/api_op_GetKey.go @@ -13,11 +13,21 @@ import ( // Gets the key material for an Amazon Web Services Payment Cryptography key, // including the immutable and mutable data specified when the key was created. +// // Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// - DeleteKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) -// - ListKeys (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html) +// Services accounts. +// +// Related operations: +// +// [CreateKey] +// +// [DeleteKey] +// +// [ListKeys] +// +// [DeleteKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html +// [ListKeys]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListKeys.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) GetKey(ctx context.Context, params *GetKeyInput, optFns ...func(*Options)) (*GetKeyOutput, error) { if params == nil { params = &GetKeyInput{} diff --git a/service/paymentcryptography/api_op_GetParametersForExport.go b/service/paymentcryptography/api_op_GetParametersForExport.go index 26f80fee3c3..4630ff6b026 100644 --- a/service/paymentcryptography/api_op_GetParametersForExport.go +++ b/service/paymentcryptography/api_op_GetParametersForExport.go @@ -13,16 +13,24 @@ import ( ) // Gets the export token and the signing key certificate to initiate a TR-34 key -// export from Amazon Web Services Payment Cryptography. The signing key -// certificate signs the wrapped key under export within the TR-34 key payload. The -// export token and signing key certificate must be in place and operational before -// calling ExportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html) -// . The export token expires in 7 days. You can use the same export token to -// export multiple keys from your service account. Cross-account use: This -// operation can't be used across different Amazon Web Services accounts. Related -// operations: -// - ExportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html) -// - GetParametersForImport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html) +// export from Amazon Web Services Payment Cryptography. +// +// The signing key certificate signs the wrapped key under export within the TR-34 +// key payload. The export token and signing key certificate must be in place and +// operational before calling [ExportKey]. The export token expires in 7 days. You can use +// the same export token to export multiple keys from your service account. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [ExportKey] +// +// [GetParametersForImport] +// +// [ExportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html +// [GetParametersForImport]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html func (c *Client) GetParametersForExport(ctx context.Context, params *GetParametersForExportInput, optFns ...func(*Options)) (*GetParametersForExportOutput, error) { if params == nil { params = &GetParametersForExportInput{} diff --git a/service/paymentcryptography/api_op_GetParametersForImport.go b/service/paymentcryptography/api_op_GetParametersForImport.go index 14666d8a6e7..29b5999d092 100644 --- a/service/paymentcryptography/api_op_GetParametersForImport.go +++ b/service/paymentcryptography/api_op_GetParametersForImport.go @@ -14,15 +14,24 @@ import ( // Gets the import token and the wrapping key certificate in PEM format (base64 // encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram -// import into Amazon Web Services Payment Cryptography. The wrapping key -// certificate wraps the key under import. The import token and wrapping key -// certificate must be in place and operational before calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . The import token expires in 7 days. You can use the same import token to -// import multiple keys into your service account. Cross-account use: This -// operation can't be used across different Amazon Web Services accounts. Related -// operations: -// - GetParametersForExport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html) -// - ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) +// import into Amazon Web Services Payment Cryptography. +// +// The wrapping key certificate wraps the key under import. The import token and +// wrapping key certificate must be in place and operational before calling [ImportKey]. The +// import token expires in 7 days. You can use the same import token to import +// multiple keys into your service account. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [GetParametersForExport] +// +// [ImportKey] +// +// [GetParametersForExport]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html func (c *Client) GetParametersForImport(ctx context.Context, params *GetParametersForImportInput, optFns ...func(*Options)) (*GetParametersForImportOutput, error) { if params == nil { params = &GetParametersForImportInput{} @@ -42,16 +51,20 @@ type GetParametersForImportInput struct { // The method to use for key material import. Import token is only required for // TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK ) and RSA WrappedKeyCryptogram ( - // KEY_CRYPTOGRAM ). Import token is not required for TR-31, root public key - // cerificate or trusted public key certificate. + // KEY_CRYPTOGRAM ). + // + // Import token is not required for TR-31, root public key cerificate or trusted + // public key certificate. // // This member is required. KeyMaterialType types.KeyMaterialType // The wrapping key algorithm to generate a wrapping key certificate. This - // certificate wraps the key under import. At this time, RSA_2048 is the allowed - // algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048 , RSA_3072 , - // RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import. + // certificate wraps the key under import. + // + // At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock + // import. Additionally, RSA_2048 , RSA_3072 , RSA_4096 are the allowed algorithms + // for RSA WrappedKeyCryptogram import. // // This member is required. WrappingKeyAlgorithm types.KeyAlgorithm diff --git a/service/paymentcryptography/api_op_GetPublicKeyCertificate.go b/service/paymentcryptography/api_op_GetPublicKeyCertificate.go index 989997f7207..2bcbce3ab38 100644 --- a/service/paymentcryptography/api_op_GetPublicKeyCertificate.go +++ b/service/paymentcryptography/api_op_GetPublicKeyCertificate.go @@ -11,13 +11,16 @@ import ( ) // Gets the public key certificate of the asymmetric key pair that exists within -// Amazon Web Services Payment Cryptography. Unlike the private key of an -// asymmetric key, which never leaves Amazon Web Services Payment Cryptography -// unencrypted, callers with GetPublicKeyCertificate permission can download the -// public key certificate of the asymmetric key. You can share the public key -// certificate to allow others to encrypt messages and verify signatures outside of -// Amazon Web Services Payment Cryptography Cross-account use: This operation can't -// be used across different Amazon Web Services accounts. +// Amazon Web Services Payment Cryptography. +// +// Unlike the private key of an asymmetric key, which never leaves Amazon Web +// Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate +// permission can download the public key certificate of the asymmetric key. You +// can share the public key certificate to allow others to encrypt messages and +// verify signatures outside of Amazon Web Services Payment Cryptography +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. func (c *Client) GetPublicKeyCertificate(ctx context.Context, params *GetPublicKeyCertificateInput, optFns ...func(*Options)) (*GetPublicKeyCertificateOutput, error) { if params == nil { params = &GetPublicKeyCertificateInput{} diff --git a/service/paymentcryptography/api_op_ImportKey.go b/service/paymentcryptography/api_op_ImportKey.go index a6ea32ebc6c..fe937282cd4 100644 --- a/service/paymentcryptography/api_op_ImportKey.go +++ b/service/paymentcryptography/api_op_ImportKey.go @@ -12,117 +12,166 @@ import ( ) // Imports symmetric keys and public key certificates in PEM format (base64 -// encoded) into Amazon Web Services Payment Cryptography. Amazon Web Services -// Payment Cryptography simplifies key exchange by replacing the existing -// paper-based approach with a modern electronic approach. With ImportKey you can -// import symmetric keys using either symmetric and asymmetric key exchange -// mechanisms. For symmetric key exchange, Amazon Web Services Payment Cryptography -// uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for -// asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI -// X9 TR-34 norm and RSA wrap and unwrap key exchange mechanisms. Asymmetric key -// exchange methods are typically used to establish bi-directional trust between -// the two parties exhanging keys and are used for initial key exchange such as Key -// Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import -// working keys using symmetric method to perform various cryptographic operations -// within Amazon Web Services Payment Cryptography. The TR-34 norm is intended for -// exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key -// attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are -// contained within the key block. With RSA wrap and unwrap, you can exchange both -// 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format -// and you will need to specify the key attributes during import. You can also -// import a root public key certificate, used to sign other public key -// certificates, or a trusted public key certificate under an already established -// root public key certificate. To import a public root key certificate You can -// also import a root public key certificate, used to sign other public key -// certificates, or a trusted public key certificate under an already established -// root public key certificate. To import a public root key certificate Using this -// operation, you can import the public component (in PEM cerificate format) of -// your private root key. You can use the imported public root key certificate for -// digital signatures, for example signing wrapping key or signing key in TR-34, -// within your Amazon Web Services Payment Cryptography account. Set the following -// parameters: +// encoded) into Amazon Web Services Payment Cryptography. +// +// Amazon Web Services Payment Cryptography simplifies key exchange by replacing +// the existing paper-based approach with a modern electronic approach. With +// ImportKey you can import symmetric keys using either symmetric and asymmetric +// key exchange mechanisms. +// +// For symmetric key exchange, Amazon Web Services Payment Cryptography uses the +// ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key +// exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm +// and RSA wrap and unwrap key exchange mechanisms. Asymmetric key exchange methods +// are typically used to establish bi-directional trust between the two parties +// exhanging keys and are used for initial key exchange such as Key Encryption Key +// (KEK) or Zone Master Key (ZMK). After which you can import working keys using +// symmetric method to perform various cryptographic operations within Amazon Web +// Services Payment Cryptography. +// +// The TR-34 norm is intended for exchanging 3DES keys only and keys are imported +// in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, +// KeyModesOfUse, Exportability) are contained within the key block. With RSA wrap +// and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported +// in a WrappedKeyCryptogram format and you will need to specify the key attributes +// during import. +// +// You can also import a root public key certificate, used to sign other public +// key certificates, or a trusted public key certificate under an already +// established root public key certificate. +// +// # To import a public root key certificate +// +// You can also import a root public key certificate, used to sign other public +// key certificates, or a trusted public key certificate under an already +// established root public key certificate. +// +// # To import a public root key certificate +// +// Using this operation, you can import the public component (in PEM cerificate +// format) of your private root key. You can use the imported public root key +// certificate for digital signatures, for example signing wrapping key or signing +// key in TR-34, within your Amazon Web Services Payment Cryptography account. +// +// Set the following parameters: +// // - KeyMaterial : RootCertificatePublicKey +// // - KeyClass : PUBLIC_KEY +// // - KeyModesOfUse : Verify +// // - KeyUsage : TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE +// // - PublicKeyCertificate : The public key certificate in PEM format (base64 // encoded) of the private root key under import. // -// To import a trusted public key certificate The root public key certificate must -// be in place and operational before you import a trusted public key certificate. -// Set the following parameters: +// # To import a trusted public key certificate +// +// The root public key certificate must be in place and operational before you +// import a trusted public key certificate. Set the following parameters: +// // - KeyMaterial : TrustedCertificatePublicKey +// // - CertificateAuthorityPublicKeyIdentifier : KeyArn of the // RootCertificatePublicKey . +// // - KeyModesOfUse and KeyUsage : Corresponding to the cryptographic operations // such as wrap, sign, or encrypt that you will allow the trusted public key // certificate to perform. +// // - PublicKeyCertificate : The trusted public key certificate in PEM format // (base64 encoded) under import. // -// To import initial keys (KEK or ZMK or similar) using TR-34 Using this -// operation, you can import initial key using TR-34 asymmetric key exchange. In -// TR-34 terminology, the sending party of the key is called Key Distribution Host -// (KDH) and the receiving party of the key is called Key Receiving Device (KRD). -// During the key import process, KDH is the user who initiates the key import and -// KRD is Amazon Web Services Payment Cryptography who receives the key. To -// initiate TR-34 key import, the KDH must obtain an import token by calling -// GetParametersForImport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html) -// . This operation generates an encryption keypair for the purpose of key import, +// # To import initial keys (KEK or ZMK or similar) using TR-34 +// +// Using this operation, you can import initial key using TR-34 asymmetric key +// exchange. In TR-34 terminology, the sending party of the key is called Key +// Distribution Host (KDH) and the receiving party of the key is called Key +// Receiving Device (KRD). During the key import process, KDH is the user who +// initiates the key import and KRD is Amazon Web Services Payment Cryptography who +// receives the key. +// +// To initiate TR-34 key import, the KDH must obtain an import token by calling [GetParametersForImport]. +// This operation generates an encryption keypair for the purpose of key import, // signs the key and returns back the wrapping key certificate (also known as KRD // wrapping certificate) and the root certificate chain. The KDH must trust and // install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the // KDH key during TR-34 WrappedKeyBlock generation. The import token and associated -// KRD wrapping certificate expires after 7 days. Next the KDH generates a key pair -// for the purpose of signing the encrypted KDH key and provides the public -// certificate of the signing key to Amazon Web Services Payment Cryptography. The -// KDH will also need to import the root certificate chain of the KDH signing -// certificate by calling ImportKey for RootCertificatePublicKey . For more -// information on TR-34 key import, see section Importing symmetric keys (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html) -// in the Amazon Web Services Payment Cryptography User Guide. Set the following -// parameters: +// KRD wrapping certificate expires after 7 days. +// +// Next the KDH generates a key pair for the purpose of signing the encrypted KDH +// key and provides the public certificate of the signing key to Amazon Web +// Services Payment Cryptography. The KDH will also need to import the root +// certificate chain of the KDH signing certificate by calling ImportKey for +// RootCertificatePublicKey . For more information on TR-34 key import, see section [Importing symmetric keys] +// in the Amazon Web Services Payment Cryptography User Guide. +// +// Set the following parameters: +// // - KeyMaterial : Use Tr34KeyBlock parameters. +// // - CertificateAuthorityPublicKeyIdentifier : The KeyARN of the certificate // chain that signed the KDH signing key certificate. -// - ImportToken : Obtained from KRD by calling GetParametersForImport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html) -// . +// +// - ImportToken : Obtained from KRD by calling [GetParametersForImport]. +// // - WrappedKeyBlock : The TR-34 wrapped key material from KDH. It contains the // KDH key under import, wrapped with KRD wrapping certificate and signed by KDH // signing private key. This TR-34 key block is typically generated by the KDH // Hardware Security Module (HSM) outside of Amazon Web Services Payment // Cryptography. +// // - SigningKeyCertificate : The public key certificate in PEM format (base64 // encoded) of the KDH signing key generated under the root certificate // (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services // Payment Cryptography. // -// To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap Using -// this operation, you can import initial key using asymmetric RSA wrap and unwrap -// key exchange method. To initiate import, call GetParametersForImport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html) -// with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This -// operation also generates an encryption keypair for the purpose of key import, -// signs the key and returns back the wrapping key certificate in PEM format -// (base64 encoded) and its root certificate chain. The import token and associated -// KRD wrapping certificate expires after 7 days. You must trust and install the -// wrapping certificate and its certificate chain on the sending HSM and use it to -// wrap the key under export for WrappedKeyCryptogram generation. Next call -// ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken -// and KeyAttributes for the key under import. To import working keys using TR-31 +// # To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap +// +// Using this operation, you can import initial key using asymmetric RSA wrap and +// unwrap key exchange method. To initiate import, call [GetParametersForImport]with KeyMaterial set to +// KEY_CRYPTOGRAM to generate an import token. This operation also generates an +// encryption keypair for the purpose of key import, signs the key and returns back +// the wrapping key certificate in PEM format (base64 encoded) and its root +// certificate chain. The import token and associated KRD wrapping certificate +// expires after 7 days. +// +// You must trust and install the wrapping certificate and its certificate chain +// on the sending HSM and use it to wrap the key under export for +// WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to +// KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under +// import. +// +// # To import working keys using TR-31 +// // Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm // to import working keys. A KEK must be established within Amazon Web Services -// Payment Cryptography by using TR-34 key import or by using CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// . To initiate a TR-31 key import, set the following parameters: +// Payment Cryptography by using TR-34 key import or by using [CreateKey]. To initiate a +// TR-31 key import, set the following parameters: +// // - KeyMaterial : Use Tr31KeyBlock parameters. +// // - WrappedKeyBlock : The TR-31 wrapped key material. It contains the key under // import, encrypted using KEK. The TR-31 key block is typically generated by a HSM // outside of Amazon Web Services Payment Cryptography. +// // - WrappingKeyIdentifier : The KeyArn of the KEK that Amazon Web Services // Payment Cryptography uses to decrypt or unwrap the key under import. // // Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - ExportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html) -// - GetParametersForImport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html) +// Services accounts. +// +// Related operations: +// +// [ExportKey] +// +// [GetParametersForImport] +// +// [Importing symmetric keys]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html +// [ExportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ExportKey.html +// [GetParametersForImport]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForImport.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) ImportKey(ctx context.Context, params *ImportKeyInput, optFns ...func(*Options)) (*ImportKeyOutput, error) { if params == nil { params = &ImportKeyInput{} @@ -150,26 +199,33 @@ type ImportKeyInput struct { Enabled *bool // The algorithm that Amazon Web Services Payment Cryptography uses to calculate - // the key check value (KCV). It is used to validate the key integrity. For TDES - // keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with - // the key to be checked and retaining the 3 highest order bytes of the encrypted - // result. For AES keys, the KCV is computed using a CMAC algorithm where the input - // data is 16 bytes of zero and retaining the 3 highest order bytes of the - // encrypted result. + // the key check value (KCV). It is used to validate the key integrity. + // + // For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of + // zero, with the key to be checked and retaining the 3 highest order bytes of the + // encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where + // the input data is 16 bytes of zero and retaining the 3 highest order bytes of + // the encrypted result. KeyCheckValueAlgorithm types.KeyCheckValueAlgorithm // Assigns one or more tags to the Amazon Web Services Payment Cryptography key. // Use this parameter to tag a key when it is imported. To tag an existing Amazon - // Web Services Payment Cryptography key, use the TagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html) - // operation. 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 - // can't have more than one tag on an Amazon Web Services Payment Cryptography key - // with the same tag key. If you specify an existing tag key with a different tag - // value, Amazon Web Services Payment Cryptography replaces the current tag value - // with the specified one. Don't include personal, confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. Tagging or untagging an Amazon Web Services - // Payment Cryptography key can allow or deny permission to the key. + // Web Services Payment Cryptography key, use the [TagResource]operation. + // + // 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 can't + // have more than one tag on an Amazon Web Services Payment Cryptography key with + // the same tag key. If you specify an existing tag key with a different tag value, + // Amazon Web Services Payment Cryptography replaces the current tag value with the + // specified one. + // + // Don't include personal, confidential or sensitive information in this field. + // This field may be displayed in plaintext in CloudTrail logs and other output. + // + // Tagging or untagging an Amazon Web Services Payment Cryptography key can allow + // or deny permission to the key. + // + // [TagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/paymentcryptography/api_op_ListAliases.go b/service/paymentcryptography/api_op_ListAliases.go index d61ba7c9d25..0b33bb88b69 100644 --- a/service/paymentcryptography/api_op_ListAliases.go +++ b/service/paymentcryptography/api_op_ListAliases.go @@ -13,19 +13,33 @@ import ( // Lists the aliases for all keys in the caller's Amazon Web Services account and // Amazon Web Services Region. You can filter the list of aliases. For more -// information, see Using aliases (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-managealias.html) -// in the Amazon Web Services Payment Cryptography User Guide. This is a paginated -// operation, which means that each response might contain only a subset of all the -// aliases. When the response contains only a subset of aliases, it includes a -// NextToken value. Use this value in a subsequent ListAliases request to get more -// aliases. When you receive a response with no NextToken (or an empty or null -// value), that means there are no more aliases to get. Cross-account use: This -// operation can't be used across different Amazon Web Services accounts. Related -// operations: -// - CreateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html) -// - DeleteAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html) -// - GetAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html) -// - UpdateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html) +// information, see [Using aliases]in the Amazon Web Services Payment Cryptography User Guide. +// +// This is a paginated operation, which means that each response might contain +// only a subset of all the aliases. When the response contains only a subset of +// aliases, it includes a NextToken value. Use this value in a subsequent +// ListAliases request to get more aliases. When you receive a response with no +// NextToken (or an empty or null value), that means there are no more aliases to +// get. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [CreateAlias] +// +// [DeleteAlias] +// +// [GetAlias] +// +// [UpdateAlias] +// +// [DeleteAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html +// [UpdateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html +// [Using aliases]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-managealias.html +// [CreateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html +// [GetAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error) { if params == nil { params = &ListAliasesInput{} @@ -45,9 +59,10 @@ type ListAliasesInput struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, Amazon Web Services Payment Cryptography does not return more - // than the specified number of items, but it might return fewer. This value is - // optional. If you include a value, it must be between 1 and 100, inclusive. If - // you do not include a value, it defaults to 50. + // than the specified number of items, but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. MaxResults *int32 // Use this parameter in a subsequent request after you receive a response with @@ -162,9 +177,10 @@ var _ ListAliasesAPIClient = (*Client)(nil) type ListAliasesPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, Amazon Web Services Payment Cryptography does not return more - // than the specified number of items, but it might return fewer. This value is - // optional. If you include a value, it must be between 1 and 100, inclusive. If - // you do not include a value, it defaults to 50. + // than the specified number of items, but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/paymentcryptography/api_op_ListKeys.go b/service/paymentcryptography/api_op_ListKeys.go index fd2bbd1665f..2865c2c350f 100644 --- a/service/paymentcryptography/api_op_ListKeys.go +++ b/service/paymentcryptography/api_op_ListKeys.go @@ -12,16 +12,28 @@ import ( ) // Lists the keys in the caller's Amazon Web Services account and Amazon Web -// Services Region. You can filter the list of keys. This is a paginated operation, -// which means that each response might contain only a subset of all the keys. When -// the response contains only a subset of keys, it includes a NextToken value. Use -// this value in a subsequent ListKeys request to get more keys. When you receive -// a response with no NextToken (or an empty or null value), that means there are -// no more keys to get. Cross-account use: This operation can't be used across -// different Amazon Web Services accounts. Related operations: -// - CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// - DeleteKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) -// - GetKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html) +// Services Region. You can filter the list of keys. +// +// This is a paginated operation, which means that each response might contain +// only a subset of all the keys. When the response contains only a subset of keys, +// it includes a NextToken value. Use this value in a subsequent ListKeys request +// to get more keys. When you receive a response with no NextToken (or an empty or +// null value), that means there are no more keys to get. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [CreateKey] +// +// [DeleteKey] +// +// [GetKey] +// +// [DeleteKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html +// [GetKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetKey.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) ListKeys(ctx context.Context, params *ListKeysInput, optFns ...func(*Options)) (*ListKeysOutput, error) { if params == nil { params = &ListKeysInput{} @@ -44,9 +56,10 @@ type ListKeysInput struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, Amazon Web Services Payment Cryptography does not return more - // than the specified number of items, but it might return fewer. This value is - // optional. If you include a value, it must be between 1 and 100, inclusive. If - // you do not include a value, it defaults to 50. + // than the specified number of items, but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. MaxResults *int32 // Use this parameter in a subsequent request after you receive a response with @@ -162,9 +175,10 @@ var _ ListKeysAPIClient = (*Client)(nil) type ListKeysPaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, Amazon Web Services Payment Cryptography does not return more - // than the specified number of items, but it might return fewer. This value is - // optional. If you include a value, it must be between 1 and 100, inclusive. If - // you do not include a value, it defaults to 50. + // than the specified number of items, but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/paymentcryptography/api_op_ListTagsForResource.go b/service/paymentcryptography/api_op_ListTagsForResource.go index 7a24ed32e32..becabbcb38a 100644 --- a/service/paymentcryptography/api_op_ListTagsForResource.go +++ b/service/paymentcryptography/api_op_ListTagsForResource.go @@ -11,16 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags for an Amazon Web Services resource. This is a paginated -// 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 ListTagsForResource 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. Cross-account use: This operation -// can't be used across different Amazon Web Services accounts. Related operations: +// Lists the tags for an Amazon Web Services resource. // -// - TagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html) -// - UntagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html) +// This is a paginated 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 +// ListTagsForResource 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. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [TagResource] +// +// [UntagResource] +// +// [TagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html +// [UntagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -45,9 +55,10 @@ type ListTagsForResourceInput struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, Amazon Web Services Payment Cryptography does not return more - // than the specified number of items, but it might return fewer. This value is - // optional. If you include a value, it must be between 1 and 100, inclusive. If - // you do not include a value, it defaults to 50. + // than the specified number of items, but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. MaxResults *int32 // Use this parameter in a subsequent request after you receive a response with @@ -168,9 +179,10 @@ var _ ListTagsForResourceAPIClient = (*Client)(nil) type ListTagsForResourcePaginatorOptions struct { // Use this parameter to specify the maximum number of items to return. When this // value is present, Amazon Web Services Payment Cryptography does not return more - // than the specified number of items, but it might return fewer. This value is - // optional. If you include a value, it must be between 1 and 100, inclusive. If - // you do not include a value, it defaults to 50. + // than the specified number of items, but it might return fewer. + // + // This value is optional. If you include a value, it must be between 1 and 100, + // inclusive. If you do not include a value, it defaults to 50. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/paymentcryptography/api_op_RestoreKey.go b/service/paymentcryptography/api_op_RestoreKey.go index 4df385e80c5..24e650862b8 100644 --- a/service/paymentcryptography/api_op_RestoreKey.go +++ b/service/paymentcryptography/api_op_RestoreKey.go @@ -12,15 +12,27 @@ import ( ) // Cancels a scheduled key deletion during the waiting period. Use this operation -// to restore a Key that is scheduled for deletion. During the waiting period, the -// KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and -// time after which the Key will be deleted. After Key is restored, the KeyState -// is CREATE_COMPLETE , and the value for deletePendingTimestamp is removed. +// to restore a Key that is scheduled for deletion. +// +// During the waiting period, the KeyState is DELETE_PENDING and +// deletePendingTimestamp contains the date and time after which the Key will be +// deleted. After Key is restored, the KeyState is CREATE_COMPLETE , and the value +// for deletePendingTimestamp is removed. +// // Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - DeleteKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) -// - StartKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html) -// - StopKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html) +// Services accounts. +// +// Related operations: +// +// [DeleteKey] +// +// [StartKeyUsage] +// +// [StopKeyUsage] +// +// [DeleteKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html +// [StartKeyUsage]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html +// [StopKeyUsage]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html func (c *Client) RestoreKey(ctx context.Context, params *RestoreKeyInput, optFns ...func(*Options)) (*RestoreKeyOutput, error) { if params == nil { params = &RestoreKeyInput{} diff --git a/service/paymentcryptography/api_op_StartKeyUsage.go b/service/paymentcryptography/api_op_StartKeyUsage.go index b142dd2e008..b9214560528 100644 --- a/service/paymentcryptography/api_op_StartKeyUsage.go +++ b/service/paymentcryptography/api_op_StartKeyUsage.go @@ -13,9 +13,15 @@ import ( // Enables an Amazon Web Services Payment Cryptography key, which makes it active // for cryptographic operations within Amazon Web Services Payment Cryptography +// // Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - StopKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html) +// Services accounts. +// +// Related operations: +// +// [StopKeyUsage] +// +// [StopKeyUsage]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StopKeyUsage.html func (c *Client) StartKeyUsage(ctx context.Context, params *StartKeyUsageInput, optFns ...func(*Options)) (*StartKeyUsageOutput, error) { if params == nil { params = &StartKeyUsageInput{} diff --git a/service/paymentcryptography/api_op_StopKeyUsage.go b/service/paymentcryptography/api_op_StopKeyUsage.go index 8dbeced85b1..883d72e8f63 100644 --- a/service/paymentcryptography/api_op_StopKeyUsage.go +++ b/service/paymentcryptography/api_op_StopKeyUsage.go @@ -12,14 +12,22 @@ import ( ) // Disables an Amazon Web Services Payment Cryptography key, which makes it -// inactive within Amazon Web Services Payment Cryptography. You can use this -// operation instead of DeleteKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) -// to deactivate a key. You can enable the key in the future by calling -// StartKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html) -// . Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - DeleteKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html) -// - StartKeyUsage (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html) +// inactive within Amazon Web Services Payment Cryptography. +// +// You can use this operation instead of [DeleteKey] to deactivate a key. You can enable the +// key in the future by calling [StartKeyUsage]. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [DeleteKey] +// +// [StartKeyUsage] +// +// [DeleteKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteKey.html +// [StartKeyUsage]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_StartKeyUsage.html func (c *Client) StopKeyUsage(ctx context.Context, params *StopKeyUsageInput, optFns ...func(*Options)) (*StopKeyUsageOutput, error) { if params == nil { params = &StopKeyUsageInput{} diff --git a/service/paymentcryptography/api_op_TagResource.go b/service/paymentcryptography/api_op_TagResource.go index 1ddd53ca7f4..4980e33e9bd 100644 --- a/service/paymentcryptography/api_op_TagResource.go +++ b/service/paymentcryptography/api_op_TagResource.go @@ -11,17 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds or edits tags on an Amazon Web Services Payment Cryptography key. Tagging -// or untagging an Amazon Web Services Payment Cryptography key can allow or deny -// permission to the key. 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 also add tags to an Amazon Web -// Services Payment Cryptography key when you create it with CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// . Cross-account use: This operation can't be used across different Amazon Web -// Services accounts. Related operations: -// - ListTagsForResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html) -// - UntagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html) +// Adds or edits tags on an Amazon Web Services Payment Cryptography key. +// +// Tagging or untagging an Amazon Web Services Payment Cryptography key can allow +// or deny permission to the key. +// +// 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 also add tags to an Amazon Web Services +// Payment Cryptography key when you create it with [CreateKey]. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [ListTagsForResource] +// +// [UntagResource] +// +// [UntagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html +// [ListTagsForResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -48,13 +60,17 @@ type TagResourceInput struct { // can be an empty (null) string. You can't have more than one tag on an Amazon Web // Services Payment Cryptography key with the same tag key. If you specify an // existing tag key with a different tag value, Amazon Web Services Payment - // Cryptography replaces the current tag value with the new one. Don't include - // personal, confidential or sensitive information in this field. This field may be - // displayed in plaintext in CloudTrail logs and other output. To use this - // parameter, you must have TagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html) - // permission in an IAM policy. Don't include personal, confidential or sensitive - // information in this field. This field may be displayed in plaintext in - // CloudTrail logs and other output. + // Cryptography replaces the current tag value with the new one. + // + // Don't include personal, confidential or sensitive information in this field. + // This field may be displayed in plaintext in CloudTrail logs and other output. + // + // To use this parameter, you must have [TagResource] permission in an IAM policy. + // + // Don't include personal, confidential or sensitive information in this field. + // This field may be displayed in plaintext in CloudTrail logs and other output. + // + // [TagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html // // This member is required. Tags []types.Tag diff --git a/service/paymentcryptography/api_op_UntagResource.go b/service/paymentcryptography/api_op_UntagResource.go index 2f2524d85a5..8321459ab0a 100644 --- a/service/paymentcryptography/api_op_UntagResource.go +++ b/service/paymentcryptography/api_op_UntagResource.go @@ -10,12 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a tag from an Amazon Web Services Payment Cryptography key. Tagging or -// untagging an Amazon Web Services Payment Cryptography key can allow or deny -// permission to the key. Cross-account use: This operation can't be used across -// different Amazon Web Services accounts. Related operations: -// - ListTagsForResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html) -// - TagResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html) +// Deletes a tag from an Amazon Web Services Payment Cryptography key. +// +// Tagging or untagging an Amazon Web Services Payment Cryptography key can allow +// or deny permission to the key. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// [ListTagsForResource] +// +// [TagResource] +// +// [TagResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html +// [ListTagsForResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -38,11 +48,13 @@ type UntagResourceInput struct { // This member is required. ResourceArn *string - // One or more tag keys. Don't include the tag values. If the Amazon Web Services - // Payment Cryptography key doesn't have the specified tag key, Amazon Web Services - // Payment Cryptography doesn't throw an exception or return a response. To confirm - // that the operation succeeded, use the ListTagsForResource (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html) - // operation. + // One or more tag keys. Don't include the tag values. + // + // If the Amazon Web Services Payment Cryptography key doesn't have the specified + // tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or + // return a response. To confirm that the operation succeeded, use the [ListTagsForResource]operation. + // + // [ListTagsForResource]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html // // This member is required. TagKeys []string diff --git a/service/paymentcryptography/api_op_UpdateAlias.go b/service/paymentcryptography/api_op_UpdateAlias.go index 315d614db6f..d7dcd110e5f 100644 --- a/service/paymentcryptography/api_op_UpdateAlias.go +++ b/service/paymentcryptography/api_op_UpdateAlias.go @@ -15,13 +15,25 @@ import ( // different key. Each alias is associated with only one Amazon Web Services // Payment Cryptography key at a time, although a key can have multiple aliases. // The alias and the Amazon Web Services Payment Cryptography key must be in the -// same Amazon Web Services account and Amazon Web Services Region Cross-account -// use: This operation can't be used across different Amazon Web Services accounts. +// same Amazon Web Services account and Amazon Web Services Region +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - CreateAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html) -// - DeleteAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html) -// - GetAlias (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html) -// - ListAliases (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html) +// +// [CreateAlias] +// +// [DeleteAlias] +// +// [GetAlias] +// +// [ListAliases] +// +// [ListAliases]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html +// [DeleteAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html +// [CreateAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html +// [GetAlias]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html func (c *Client) UpdateAlias(ctx context.Context, params *UpdateAliasInput, optFns ...func(*Options)) (*UpdateAliasOutput, error) { if params == nil { params = &UpdateAliasInput{} diff --git a/service/paymentcryptography/doc.go b/service/paymentcryptography/doc.go index 7e521bfdcbb..60fc0080832 100644 --- a/service/paymentcryptography/doc.go +++ b/service/paymentcryptography/doc.go @@ -6,22 +6,27 @@ // Amazon Web Services Payment Cryptography Control Plane APIs manage encryption // keys for use during payment-related cryptographic operations. You can create, // import, export, share, manage, and delete keys. You can also manage Identity and -// Access Management (IAM) policies for keys. For more information, see Identity -// and access management (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html) -// in the Amazon Web Services Payment Cryptography User Guide. To use encryption -// keys for payment-related transaction processing and associated cryptographic -// operations, you use the Amazon Web Services Payment Cryptography Data Plane (https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html) -// . You can perform actions like encrypt, decrypt, generate, and verify -// payment-related data. All Amazon Web Services Payment Cryptography API calls -// must be signed and transmitted using Transport Layer Security (TLS). We -// recommend you always use the latest supported TLS version for logging API -// requests. Amazon Web Services Payment Cryptography supports CloudTrail for -// control plane operations, 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 you specify. By using the information collected by CloudTrail, -// you can determine what requests were made to Amazon Web Services Payment -// Cryptography, who made the request, when it was made, and so on. If you don't -// configure a trail, you can still view the most recent events in the CloudTrail -// console. For more information, see the CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/) -// . +// Access Management (IAM) policies for keys. For more information, see [Identity and access management]in the +// Amazon Web Services Payment Cryptography User Guide. +// +// To use encryption keys for payment-related transaction processing and +// associated cryptographic operations, you use the [Amazon Web Services Payment Cryptography Data Plane]. You can perform actions like +// encrypt, decrypt, generate, and verify payment-related data. +// +// All Amazon Web Services Payment Cryptography API calls must be signed and +// transmitted using Transport Layer Security (TLS). We recommend you always use +// the latest supported TLS version for logging API requests. +// +// Amazon Web Services Payment Cryptography supports CloudTrail for control plane +// operations, 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 +// you specify. By using the information collected by CloudTrail, you can determine +// what requests were made to Amazon Web Services Payment Cryptography, who made +// the request, when it was made, and so on. If you don't configure a trail, you can +// still view the most recent events in the CloudTrail console. For more +// information, see the [CloudTrail User Guide]. +// +// [Identity and access management]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/security-iam.html +// [Amazon Web Services Payment Cryptography Data Plane]: https://docs.aws.amazon.com/payment-cryptography/latest/DataAPIReference/Welcome.html +// [CloudTrail User Guide]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/ package paymentcryptography diff --git a/service/paymentcryptography/options.go b/service/paymentcryptography/options.go index af359cb2b43..1cbf6b549a0 100644 --- a/service/paymentcryptography/options.go +++ b/service/paymentcryptography/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/paymentcryptography/types/enums.go b/service/paymentcryptography/types/enums.go index 3b0611caad9..622ef083fe3 100644 --- a/service/paymentcryptography/types/enums.go +++ b/service/paymentcryptography/types/enums.go @@ -17,8 +17,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "TDES_2KEY", @@ -41,8 +42,9 @@ const ( ) // Values returns all known values for KeyCheckValueAlgorithm. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyCheckValueAlgorithm) Values() []KeyCheckValueAlgorithm { return []KeyCheckValueAlgorithm{ "CMAC", @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for KeyClass. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyClass) Values() []KeyClass { return []KeyClass{ "SYMMETRIC_KEY", @@ -82,8 +85,9 @@ const ( ) // Values returns all known values for KeyExportability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyExportability) Values() []KeyExportability { return []KeyExportability{ "EXPORTABLE", @@ -104,8 +108,9 @@ const ( ) // Values returns all known values for KeyMaterialType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyMaterialType) Values() []KeyMaterialType { return []KeyMaterialType{ "TR34_KEY_BLOCK", @@ -125,8 +130,9 @@ const ( ) // Values returns all known values for KeyOrigin. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyOrigin) Values() []KeyOrigin { return []KeyOrigin{ "EXTERNAL", @@ -145,8 +151,9 @@ const ( ) // Values returns all known values for KeyState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyState) Values() []KeyState { return []KeyState{ "CREATE_IN_PROGRESS", @@ -186,8 +193,9 @@ const ( ) // Values returns all known values for KeyUsage. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyUsage) Values() []KeyUsage { return []KeyUsage{ "TR31_B0_BASE_DERIVATION_KEY", @@ -224,8 +232,9 @@ const ( ) // Values returns all known values for Tr34KeyBlockFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tr34KeyBlockFormat) Values() []Tr34KeyBlockFormat { return []Tr34KeyBlockFormat{ "X9_TR34_2012", @@ -243,6 +252,7 @@ const ( // Values returns all known values for WrappedKeyMaterialFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WrappedKeyMaterialFormat) Values() []WrappedKeyMaterialFormat { return []WrappedKeyMaterialFormat{ @@ -261,8 +271,9 @@ const ( ) // Values returns all known values for WrappingKeySpec. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WrappingKeySpec) Values() []WrappingKeySpec { return []WrappingKeySpec{ "RSA_OAEP_SHA_256", diff --git a/service/paymentcryptography/types/types.go b/service/paymentcryptography/types/types.go index 8cc5b2801cd..1ef6868d06a 100644 --- a/service/paymentcryptography/types/types.go +++ b/service/paymentcryptography/types/types.go @@ -11,8 +11,10 @@ import ( type Alias struct { // A friendly name that you can use to refer to a key. The value must begin with - // alias/ . Do not include confidential or sensitive information in this field. - // This field may be displayed in plaintext in CloudTrail logs and other output. + // alias/ . + // + // Do not include confidential or sensitive information in this field. This field + // may be displayed in plaintext in CloudTrail logs and other output. // // This member is required. AliasName *string @@ -31,11 +33,13 @@ type ExportAttributes struct { // The algorithm that Amazon Web Services Payment Cryptography uses to calculate // the key check value (KCV). It is used to validate the key integrity. Specify KCV - // for IPEK export only. For TDES keys, the KCV is computed by encrypting 8 bytes, - // each with value of zero, with the key to be checked and retaining the 3 highest - // order bytes of the encrypted result. For AES keys, the KCV is computed using a - // CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 - // highest order bytes of the encrypted result. + // for IPEK export only. + // + // For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of + // zero, with the key to be checked and retaining the 3 highest order bytes of the + // encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where + // the input data is 16 bytes of zero and retaining the 3 highest order bytes of + // the encrypted result. KeyCheckValueAlgorithm KeyCheckValueAlgorithm noSmithyDocumentSerde @@ -44,9 +48,10 @@ type ExportAttributes struct { // Parameter information for IPEK generation during export. type ExportDukptInitialKey struct { - // The KSN for IPEK generation using DUKPT. KSN must be padded before sending to - // Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a - // TDES_2KEY key or 24 for an AES key. + // The KSN for IPEK generation using DUKPT. + // + // KSN must be padded before sending to Amazon Web Services Payment Cryptography. + // KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key. // // This member is required. KeySerialNumber *string @@ -148,9 +153,11 @@ type ExportTr34KeyBlock struct { // The export token to initiate key export from Amazon Web Services Payment // Cryptography. It also contains the signing key certificate that will sign the - // wrapped key during TR-34 key block generation. Call GetParametersForExport (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html) - // to receive an export token. It expires after 7 days. You can use the same export - // token to export multiple keys from the same service account. + // wrapped key during TR-34 key block generation. Call [GetParametersForExport]to receive an export token. + // It expires after 7 days. You can use the same export token to export multiple + // keys from the same service account. + // + // [GetParametersForExport]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetParametersForExport.html // // This member is required. ExportToken *string @@ -375,12 +382,13 @@ type Key struct { KeyCheckValue *string // The algorithm that Amazon Web Services Payment Cryptography uses to calculate - // the key check value (KCV). It is used to validate the key integrity. For TDES - // keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with - // the key to be checked and retaining the 3 highest order bytes of the encrypted - // result. For AES keys, the KCV is computed using a CMAC algorithm where the input - // data is 16 bytes of zero and retaining the 3 highest order bytes of the - // encrypted result. + // the key check value (KCV). It is used to validate the key integrity. + // + // For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of + // zero, with the key to be checked and retaining the 3 highest order bytes of the + // encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where + // the input data is 16 bytes of zero and retaining the 3 highest order bytes of + // the encrypted result. // // This member is required. KeyCheckValueAlgorithm KeyCheckValueAlgorithm @@ -424,9 +432,11 @@ type Key struct { type KeyAttributes struct { // The key algorithm to be use during creation of an Amazon Web Services Payment - // Cryptography key. For symmetric keys, Amazon Web Services Payment Cryptography - // supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services - // Payment Cryptography supports RSA and ECC_NIST algorithms. + // Cryptography key. + // + // For symmetric keys, Amazon Web Services Payment Cryptography supports AES and + // TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography + // supports RSA and ECC_NIST algorithms. // // This member is required. KeyAlgorithm KeyAlgorithm @@ -460,13 +470,16 @@ type KeyBlockHeaders struct { // Specifies subsequent exportability of the key within the key block after it is // received by the receiving party. It can be used to further restrict // exportability of the key after export from Amazon Web Services Payment - // Cryptography. When set to EXPORTABLE , the key can be subsequently exported by - // the receiver under a KEK using TR-31 or TR-34 key block export only. When set to + // Cryptography. + // + // When set to EXPORTABLE , the key can be subsequently exported by the receiver + // under a KEK using TR-31 or TR-34 key block export only. When set to // NON_EXPORTABLE , the key cannot be subsequently exported by the receiver. When // set to SENSITIVE , the key can be exported by the receiver under a KEK using // TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key - // export method. For further information refer to ANSI X9.143-2022 (https://webstore.ansi.org/standards/ascx9/ansix91432022) - // . + // export method. For further information refer to [ANSI X9.143-2022]. + // + // [ANSI X9.143-2022]: https://webstore.ansi.org/standards/ascx9/ansix91432022 KeyExportability KeyExportability // The list of cryptographic operations that you can perform using the key. The @@ -478,12 +491,14 @@ type KeyBlockHeaders struct { KeyVersion *string // Parameter used to indicate the type of optional data in key block headers. - // Refer to ANSI X9.143-2022 (https://webstore.ansi.org/standards/ascx9/ansix91432022) - // for information on allowed data type for optional blocks. Optional block - // character limit is 112 characters. For each optional block, 2 characters are - // reserved for optional block ID and 2 characters reserved for optional block - // length. More than one optional blocks can be included as long as the combined - // length does not increase 112 characters. + // Refer to [ANSI X9.143-2022]for information on allowed data type for optional blocks. + // + // Optional block character limit is 112 characters. For each optional block, 2 + // characters are reserved for optional block ID and 2 characters reserved for + // optional block length. More than one optional blocks can be included as long as + // the combined length does not increase 112 characters. + // + // [ANSI X9.143-2022]: https://webstore.ansi.org/standards/ascx9/ansix91432022 OptionalBlocks map[string]string noSmithyDocumentSerde @@ -653,12 +668,13 @@ type WrappedKey struct { KeyCheckValue *string // The algorithm that Amazon Web Services Payment Cryptography uses to calculate - // the key check value (KCV). It is used to validate the key integrity. For TDES - // keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with - // the key to be checked and retaining the 3 highest order bytes of the encrypted - // result. For AES keys, the KCV is computed using a CMAC algorithm where the input - // data is 16 bytes of zero and retaining the 3 highest order bytes of the - // encrypted result. + // the key check value (KCV). It is used to validate the key integrity. + // + // For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of + // zero, with the key to be checked and retaining the 3 highest order bytes of the + // encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where + // the input data is 16 bytes of zero and retaining the 3 highest order bytes of + // the encrypted result. KeyCheckValueAlgorithm KeyCheckValueAlgorithm noSmithyDocumentSerde diff --git a/service/paymentcryptographydata/api_op_DecryptData.go b/service/paymentcryptographydata/api_op_DecryptData.go index 25a758c9999..3e6492de6ab 100644 --- a/service/paymentcryptographydata/api_op_DecryptData.go +++ b/service/paymentcryptographydata/api_op_DecryptData.go @@ -13,31 +13,45 @@ import ( // Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric // (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, -// see Decrypt data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/decrypt-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. You can use an -// encryption key generated within Amazon Web Services Payment Cryptography, or you -// can import your own encryption key by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . For this operation, the key must have KeyModesOfUse set to Decrypt . In -// asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the -// ciphertext using the private component of the asymmetric encryption key pair. -// For data encryption outside of Amazon Web Services Payment Cryptography, you can -// export the public component of the asymmetric key pair by calling -// GetPublicCertificate (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html) -// . For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography +// see [Decrypt data]in the Amazon Web Services Payment Cryptography User Guide. +// +// You can use an encryption key generated within Amazon Web Services Payment +// Cryptography, or you can import your own encryption key by calling [ImportKey]. For this +// operation, the key must have KeyModesOfUse set to Decrypt . In asymmetric +// decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext +// using the private component of the asymmetric encryption key pair. For data +// encryption outside of Amazon Web Services Payment Cryptography, you can export +// the public component of the asymmetric key pair by calling [GetPublicCertificate]. +// +// For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography // supports TDES and AES algorithms. For EMV decryption, Amazon Web Services // Payment Cryptography supports TDES algorithms. For asymmetric decryption, -// Amazon Web Services Payment Cryptography supports RSA . When you use TDES or -// TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or -// AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, -// it sould be equal to the key size unless padding is enabled. For information -// about valid keys for this operation, see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// Amazon Web Services Payment Cryptography supports RSA . +// +// When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple +// of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple +// of 16 bytes. For RSA, it sould be equal to the key size unless padding is +// enabled. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - EncryptData -// - GetPublicCertificate (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html) -// - ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) +// +// # EncryptData +// +// [GetPublicCertificate] +// +// [ImportKey] +// +// [GetPublicCertificate]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Decrypt data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/decrypt-data.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) DecryptData(ctx context.Context, params *DecryptDataInput, optFns ...func(*Options)) (*DecryptDataOutput, error) { if params == nil { params = &DecryptDataInput{} @@ -84,8 +98,10 @@ type DecryptDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_EncryptData.go b/service/paymentcryptographydata/api_op_EncryptData.go index 851fa1840b3..a5a9c2394b6 100644 --- a/service/paymentcryptographydata/api_op_EncryptData.go +++ b/service/paymentcryptographydata/api_op_EncryptData.go @@ -13,36 +13,52 @@ import ( // Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric // (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, -// see Encrypt data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. You can generate an -// encryption key within Amazon Web Services Payment Cryptography by calling -// CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// . You can import your own encryption key by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . For this operation, the key must have KeyModesOfUse set to Encrypt . In +// see [Encrypt data]in the Amazon Web Services Payment Cryptography User Guide. +// +// You can generate an encryption key within Amazon Web Services Payment +// Cryptography by calling [CreateKey]. You can import your own encryption key by calling [ImportKey]. +// For this operation, the key must have KeyModesOfUse set to Encrypt . In // asymmetric encryption, plaintext is encrypted using public component. You can // import the public component of an asymmetric key pair created outside Amazon Web -// Services Payment Cryptography by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography +// Services Payment Cryptography by calling [ImportKey]. +// +// For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography // supports TDES and AES algorithms. For EMV encryption, Amazon Web Services // Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon -// Web Services Payment Cryptography supports RSA . When you use TDES or TDES -// DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES -// DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it -// sould be equal to the key size unless padding is enabled. To encrypt using -// DUKPT, you must already have a BDK (Base Derivation Key) key in your account -// with KeyModesOfUse set to DeriveKey , or you can generate a new DUKPT key by -// calling CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// . To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in -// your account with KeyModesOfUse set to DeriveKey . For information about valid -// keys for this operation, see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// Web Services Payment Cryptography supports RSA . +// +// When you use TDES or TDES DUKPT, the plaintext data length must be a multiple +// of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple +// of 16 bytes. For RSA, it sould be equal to the key size unless padding is +// enabled. +// +// To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key +// in your account with KeyModesOfUse set to DeriveKey , or you can generate a new +// DUKPT key by calling [CreateKey]. To encrypt using EMV, you must already have an IMK +// (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey . +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - DecryptData -// - GetPublicCertificate (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html) -// - ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// - ReEncryptData +// +// # DecryptData +// +// [GetPublicCertificate] +// +// [ImportKey] +// +// # ReEncryptData +// +// [GetPublicCertificate]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html +// [Encrypt data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) EncryptData(ctx context.Context, params *EncryptDataInput, optFns ...func(*Options)) (*EncryptDataOutput, error) { if params == nil { params = &EncryptDataInput{} @@ -71,11 +87,14 @@ type EncryptDataInput struct { // This member is required. KeyIdentifier *string - // The plaintext to be encrypted. For encryption using asymmetric keys, plaintext - // data length is constrained by encryption key strength that you define in - // KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes - // . For more information, see Encrypt data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html) - // in the Amazon Web Services Payment Cryptography User Guide. + // The plaintext to be encrypted. + // + // For encryption using asymmetric keys, plaintext data length is constrained by + // encryption key strength that you define in KeyAlgorithm and padding type that + // you define in AsymmetricEncryptionAttributes . For more information, see [Encrypt data] in + // the Amazon Web Services Payment Cryptography User Guide. + // + // [Encrypt data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html // // This member is required. PlainText *string @@ -98,8 +117,10 @@ type EncryptDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. KeyCheckValue *string // Metadata pertaining to the operation's result. diff --git a/service/paymentcryptographydata/api_op_GenerateCardValidationData.go b/service/paymentcryptographydata/api_op_GenerateCardValidationData.go index 2157c57fd63..590077b97ec 100644 --- a/service/paymentcryptographydata/api_op_GenerateCardValidationData.go +++ b/service/paymentcryptographydata/api_op_GenerateCardValidationData.go @@ -13,24 +13,34 @@ import ( // Generates card-related validation data using algorithms such as Card // Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), -// or Card Security Codes (CSC). For more information, see Generate card data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. This operation -// generates a CVV or CSC value that is printed on a payment credit or debit card -// during card production. The CVV or CSC, PAN (Primary Account Number) and -// expiration date of the card are required to check its validity during -// transaction processing. To begin this operation, a CVK (Card Verification Key) -// encryption key is required. You can use CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// or ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// to establish a CVK within Amazon Web Services Payment Cryptography. The -// KeyModesOfUse should be set to Generate and Verify for a CVK encryption key. -// For information about valid keys for this operation, see Understanding key -// attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// or Card Security Codes (CSC). For more information, see [Generate card data]in the Amazon Web +// Services Payment Cryptography User Guide. +// +// This operation generates a CVV or CSC value that is printed on a payment credit +// or debit card during card production. The CVV or CSC, PAN (Primary Account +// Number) and expiration date of the card are required to check its validity +// during transaction processing. To begin this operation, a CVK (Card Verification +// Key) encryption key is required. You can use [CreateKey]or [ImportKey] to establish a CVK within +// Amazon Web Services Payment Cryptography. The KeyModesOfUse should be set to +// Generate and Verify for a CVK encryption key. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// - VerifyCardValidationData +// +// [ImportKey] +// +// # VerifyCardValidationData +// +// [Generate card data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) GenerateCardValidationData(ctx context.Context, params *GenerateCardValidationDataInput, optFns ...func(*Options)) (*GenerateCardValidationDataOutput, error) { if params == nil { params = &GenerateCardValidationDataInput{} @@ -82,8 +92,10 @@ type GenerateCardValidationDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_GenerateMac.go b/service/paymentcryptographydata/api_op_GenerateMac.go index 3ac490ff45f..fc4553ae9e8 100644 --- a/service/paymentcryptographydata/api_op_GenerateMac.go +++ b/service/paymentcryptographydata/api_op_GenerateMac.go @@ -12,23 +12,33 @@ import ( ) // Generates a Message Authentication Code (MAC) cryptogram within Amazon Web -// Services Payment Cryptography. You can use this operation to authenticate -// card-related data by using known data values to generate MAC for data validation -// between the sending and receiving parties. This operation uses message data, a -// secret encryption key and MAC algorithm to generate a unique MAC value for -// transmission. The receiving party of the MAC must use the same message data, -// secret encryption key and MAC algorithm to reproduce another MAC value for -// comparision. You can use this operation to generate a DUPKT, CMAC, HMAC or EMV -// MAC by setting generation attributes and algorithm to the associated values. The -// MAC generation encryption key must have valid values for KeyUsage such as +// Services Payment Cryptography. +// +// You can use this operation to authenticate card-related data by using known +// data values to generate MAC for data validation between the sending and +// receiving parties. This operation uses message data, a secret encryption key and +// MAC algorithm to generate a unique MAC value for transmission. The receiving +// party of the MAC must use the same message data, secret encryption key and MAC +// algorithm to reproduce another MAC value for comparision. +// +// You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by +// setting generation attributes and algorithm to the associated values. The MAC +// generation encryption key must have valid values for KeyUsage such as // TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set -// to Generate and Verify . For information about valid keys for this operation, -// see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// to Generate and Verify . +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - VerifyMac +// +// # VerifyMac +// +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) GenerateMac(ctx context.Context, params *GenerateMacInput, optFns ...func(*Options)) (*GenerateMacOutput, error) { if params == nil { params = &GenerateMacInput{} @@ -78,8 +88,10 @@ type GenerateMacOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_GeneratePinData.go b/service/paymentcryptographydata/api_op_GeneratePinData.go index 1a57ddc0186..ae42e832dcf 100644 --- a/service/paymentcryptographydata/api_op_GeneratePinData.go +++ b/service/paymentcryptographydata/api_op_GeneratePinData.go @@ -13,21 +13,31 @@ import ( // Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN // Block, and PIN Offset during new card issuance or reissuance. For more -// information, see Generate PIN data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-pin-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. PIN data is never -// transmitted in clear to or from Amazon Web Services Payment Cryptography. This -// operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin -// Encryption Key (PEK) to create an EncryptedPinBlock for transmission from -// Amazon Web Services Payment Cryptography. This operation uses a separate Pin -// Verification Key (PVK) for VISA PVV generation. For information about valid keys -// for this operation, see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// information, see [Generate PIN data]in the Amazon Web Services Payment Cryptography User Guide. +// +// PIN data is never transmitted in clear to or from Amazon Web Services Payment +// Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts +// it using Pin Encryption Key (PEK) to create an EncryptedPinBlock for +// transmission from Amazon Web Services Payment Cryptography. This operation uses +// a separate Pin Verification Key (PVK) for VISA PVV generation. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - GenerateCardValidationData -// - TranslatePinData -// - VerifyPinData +// +// # GenerateCardValidationData +// +// # TranslatePinData +// +// # VerifyPinData +// +// [Generate PIN data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-pin-data.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) GeneratePinData(ctx context.Context, params *GeneratePinDataInput, optFns ...func(*Options)) (*GeneratePinDataOutput, error) { if params == nil { params = &GeneratePinDataInput{} @@ -63,12 +73,14 @@ type GeneratePinDataInput struct { GenerationKeyIdentifier *string // The PIN encoding format for pin data generation as specified in ISO 9564. - // Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3 - // . The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and + // Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3 . + // + // The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and // ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports - // a PIN from 4 to 12 digits in length. The ISO_Format_3 PIN block format is the - // same as ISO_Format_0 except that the fill digits are random values from 10 to - // 15. + // a PIN from 4 to 12 digits in length. + // + // The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the + // fill digits are random values from 10 to 15. // // This member is required. PinBlockFormat types.PinBlockFormatForPinData @@ -103,8 +115,10 @@ type GeneratePinDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. EncryptionKeyCheckValue *string @@ -117,8 +131,10 @@ type GeneratePinDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. GenerationKeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_ReEncryptData.go b/service/paymentcryptographydata/api_op_ReEncryptData.go index 70df0c4cb21..5efcf4f0bb6 100644 --- a/service/paymentcryptographydata/api_op_ReEncryptData.go +++ b/service/paymentcryptographydata/api_op_ReEncryptData.go @@ -12,28 +12,42 @@ import ( ) // Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption -// Keys. You can either generate an encryption key within Amazon Web Services -// Payment Cryptography by calling CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// or import your own encryption key by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . The KeyArn for use with this operation must be in a compatible key state with +// Keys. +// +// You can either generate an encryption key within Amazon Web Services Payment +// Cryptography by calling [CreateKey]or import your own encryption key by calling [ImportKey]. The +// KeyArn for use with this operation must be in a compatible key state with // KeyModesOfUse set to Encrypt . In asymmetric encryption, ciphertext is encrypted -// using public component (imported by calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// ) of the asymmetric key pair created outside of Amazon Web Services Payment -// Cryptography. For symmetric and DUKPT encryption, Amazon Web Services Payment -// Cryptography supports TDES and AES algorithms. For asymmetric encryption, -// Amazon Web Services Payment Cryptography supports RSA . To encrypt using DUKPT, -// a DUKPT key must already exist within your account with KeyModesOfUse set to -// DeriveKey or a new DUKPT can be generated by calling CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// . For information about valid keys for this operation, see Understanding key -// attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// using public component (imported by calling [ImportKey]) of the asymmetric key pair +// created outside of Amazon Web Services Payment Cryptography. +// +// For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography +// supports TDES and AES algorithms. For asymmetric encryption, Amazon Web +// Services Payment Cryptography supports RSA . To encrypt using DUKPT, a DUKPT key +// must already exist within your account with KeyModesOfUse set to DeriveKey or a +// new DUKPT can be generated by calling [CreateKey]. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - DecryptData -// - EncryptData -// - GetPublicCertificate (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html) -// - ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) +// +// # DecryptData +// +// # EncryptData +// +// [GetPublicCertificate] +// +// [ImportKey] +// +// [GetPublicCertificate]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) ReEncryptData(ctx context.Context, params *ReEncryptDataInput, optFns ...func(*Options)) (*ReEncryptDataOutput, error) { if params == nil { params = &ReEncryptDataInput{} @@ -97,8 +111,10 @@ type ReEncryptDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_TranslatePinData.go b/service/paymentcryptographydata/api_op_TranslatePinData.go index a717b2b0b1d..c8323e4a74c 100644 --- a/service/paymentcryptographydata/api_op_TranslatePinData.go +++ b/service/paymentcryptographydata/api_op_TranslatePinData.go @@ -12,29 +12,41 @@ import ( ) // Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more -// information, see Translate PIN data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/translate-pin-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. PIN block -// translation involves changing the encrytion of PIN block from one encryption key -// to another encryption key and changing PIN block format from one to another -// without PIN block data leaving Amazon Web Services Payment Cryptography. The -// encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base -// Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services -// Payment Cryptography supports TDES and AES key derivation type for DUKPT -// translations. The allowed combinations of PIN block format translations are -// guided by PCI. It is important to note that not all encrypted PIN block formats -// (example, format 1) require PAN (Primary Account Number) as input. And as such, -// PIN block format that requires PAN (example, formats 0,3,4) cannot be translated -// to a format (format 1) that does not require a PAN for generation. For -// information about valid keys for this operation, see Understanding key -// attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Amazon Web Services -// Payment Cryptography currently supports ISO PIN block 4 translation for PIN -// block built using legacy PAN length. That is, PAN is the right most 12 digits -// excluding the check digits. Cross-account use: This operation can't be used -// across different Amazon Web Services accounts. Related operations: -// - GeneratePinData -// - VerifyPinData +// information, see [Translate PIN data]in the Amazon Web Services Payment Cryptography User Guide. +// +// PIN block translation involves changing the encrytion of PIN block from one +// encryption key to another encryption key and changing PIN block format from one +// to another without PIN block data leaving Amazon Web Services Payment +// Cryptography. The encryption key transformation can be from PEK (Pin Encryption +// Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon +// Web Services Payment Cryptography supports TDES and AES key derivation type for +// DUKPT translations. +// +// The allowed combinations of PIN block format translations are guided by PCI. It +// is important to note that not all encrypted PIN block formats (example, format +// 1) require PAN (Primary Account Number) as input. And as such, PIN block format +// that requires PAN (example, formats 0,3,4) cannot be translated to a format +// (format 1) that does not require a PAN for generation. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 +// translation for PIN block built using legacy PAN length. That is, PAN is the +// right most 12 digits excluding the check digits. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// +// Related operations: +// +// # GeneratePinData +// +// # VerifyPinData +// +// [Translate PIN data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/translate-pin-data.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) TranslatePinData(ctx context.Context, params *TranslatePinDataInput, optFns ...func(*Options)) (*TranslatePinDataOutput, error) { if params == nil { params = &TranslatePinDataInput{} @@ -103,8 +115,10 @@ type TranslatePinDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_VerifyAuthRequestCryptogram.go b/service/paymentcryptographydata/api_op_VerifyAuthRequestCryptogram.go index 9ff2aa133c0..d4382061952 100644 --- a/service/paymentcryptographydata/api_op_VerifyAuthRequestCryptogram.go +++ b/service/paymentcryptographydata/api_op_VerifyAuthRequestCryptogram.go @@ -12,26 +12,36 @@ import ( ) // Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card -// authorization. For more information, see Verify auth request cryptogram (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.verifyauthrequestcryptogram.html) -// in the Amazon Web Services Payment Cryptography User Guide. ARQC generation is -// done outside of Amazon Web Services Payment Cryptography and is typically -// generated on a point of sale terminal for an EMV chip card to obtain payment -// authorization during transaction time. For ARQC verification, you must first -// import the ARQC generated outside of Amazon Web Services Payment Cryptography by -// calling ImportKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html) -// . This operation uses the imported ARQC and an major encryption key (DUKPT) -// created by calling CreateKey (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) -// to either provide a boolean ARQC verification result or provide an APRC -// (Authorization Response Cryptogram) response using Method 1 or Method 2. The -// ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and ARPC_METHOD_2 uses -// CardStatusUpdate to generate ARPC. For information about valid keys for this -// operation, see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// authorization. For more information, see [Verify auth request cryptogram]in the Amazon Web Services Payment +// Cryptography User Guide. +// +// ARQC generation is done outside of Amazon Web Services Payment Cryptography and +// is typically generated on a point of sale terminal for an EMV chip card to +// obtain payment authorization during transaction time. For ARQC verification, you +// must first import the ARQC generated outside of Amazon Web Services Payment +// Cryptography by calling [ImportKey]. This operation uses the imported ARQC and an major +// encryption key (DUKPT) created by calling [CreateKey]to either provide a boolean ARQC +// verification result or provide an APRC (Authorization Response Cryptogram) +// response using Method 1 or Method 2. The ARPC_METHOD_1 uses AuthResponseCode to +// generate ARPC and ARPC_METHOD_2 uses CardStatusUpdate to generate ARPC. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - VerifyCardValidationData -// - VerifyPinData +// +// # VerifyCardValidationData +// +// # VerifyPinData +// +// [Verify auth request cryptogram]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.verifyauthrequestcryptogram.html +// [ImportKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html +// [CreateKey]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html func (c *Client) VerifyAuthRequestCryptogram(ctx context.Context, params *VerifyAuthRequestCryptogramInput, optFns ...func(*Options)) (*VerifyAuthRequestCryptogramOutput, error) { if params == nil { params = &VerifyAuthRequestCryptogramInput{} @@ -103,8 +113,10 @@ type VerifyAuthRequestCryptogramOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_VerifyCardValidationData.go b/service/paymentcryptographydata/api_op_VerifyCardValidationData.go index f98f3c22ef9..b55c80f5a93 100644 --- a/service/paymentcryptographydata/api_op_VerifyCardValidationData.go +++ b/service/paymentcryptographydata/api_op_VerifyCardValidationData.go @@ -13,24 +13,35 @@ import ( // Verifies card-related validation data using algorithms such as Card // Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) -// and Card Security Codes (CSC). For more information, see Verify card data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-card-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. This operation -// validates the CVV or CSC codes that is printed on a payment credit or debit card -// during card payment transaction. The input values are typically provided as part -// of an inbound transaction to an issuer or supporting platform partner. Amazon -// Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) -// and expiration date of the card to check its validity during transaction -// processing. In this operation, the CVK (Card Verification Key) encryption key -// for use with card data verification is same as the one in used for -// GenerateCardValidationData . For information about valid keys for this -// operation, see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// and Card Security Codes (CSC). For more information, see [Verify card data]in the Amazon Web +// Services Payment Cryptography User Guide. +// +// This operation validates the CVV or CSC codes that is printed on a payment +// credit or debit card during card payment transaction. The input values are +// typically provided as part of an inbound transaction to an issuer or supporting +// platform partner. Amazon Web Services Payment Cryptography uses CVV or CSC, PAN +// (Primary Account Number) and expiration date of the card to check its validity +// during transaction processing. In this operation, the CVK (Card Verification +// Key) encryption key for use with card data verification is same as the one in +// used for GenerateCardValidationData. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - GenerateCardValidationData -// - VerifyAuthRequestCryptogram -// - VerifyPinData +// +// # GenerateCardValidationData +// +// # VerifyAuthRequestCryptogram +// +// # VerifyPinData +// +// [Verify card data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-card-data.html +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) VerifyCardValidationData(ctx context.Context, params *VerifyCardValidationDataInput, optFns ...func(*Options)) (*VerifyCardValidationDataOutput, error) { if params == nil { params = &VerifyCardValidationDataInput{} @@ -85,8 +96,10 @@ type VerifyCardValidationDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_VerifyMac.go b/service/paymentcryptographydata/api_op_VerifyMac.go index 193aa63f41a..fa9a264370e 100644 --- a/service/paymentcryptographydata/api_op_VerifyMac.go +++ b/service/paymentcryptographydata/api_op_VerifyMac.go @@ -11,18 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Verifies a Message Authentication Code (MAC). You can use this operation to -// verify MAC for message data authentication such as . In this operation, you must -// use the same message data, secret encryption key and MAC algorithm that was used -// to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV -// MAC by setting generation attributes and algorithm to the associated values. For -// information about valid keys for this operation, see Understanding key -// attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// Verifies a Message Authentication Code (MAC). +// +// You can use this operation to verify MAC for message data authentication such +// as . In this operation, you must use the same message data, secret encryption +// key and MAC algorithm that was used to generate MAC. You can use this operation +// to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and +// algorithm to the associated values. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - GenerateMac +// +// # GenerateMac +// +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html func (c *Client) VerifyMac(ctx context.Context, params *VerifyMacInput, optFns ...func(*Options)) (*VerifyMacOutput, error) { if params == nil { params = &VerifyMacInput{} @@ -78,8 +86,10 @@ type VerifyMacOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. KeyCheckValue *string diff --git a/service/paymentcryptographydata/api_op_VerifyPinData.go b/service/paymentcryptographydata/api_op_VerifyPinData.go index 22558eb03d9..806052b97e1 100644 --- a/service/paymentcryptographydata/api_op_VerifyPinData.go +++ b/service/paymentcryptographydata/api_op_VerifyPinData.go @@ -12,20 +12,31 @@ import ( ) // Verifies pin-related data such as PIN and PIN Offset using algorithms including -// VISA PVV and IBM3624. For more information, see Verify PIN data (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html) -// in the Amazon Web Services Payment Cryptography User Guide. This operation -// verifies PIN data for user payment card. A card holder PIN data is never -// transmitted in clear to or from Amazon Web Services Payment Cryptography. This -// operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and -// then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock -// for transmission from Amazon Web Services Payment Cryptography. For information -// about valid keys for this operation, see Understanding key attributes (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html) -// and Key types for specific data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html) -// in the Amazon Web Services Payment Cryptography User Guide. Cross-account use: -// This operation can't be used across different Amazon Web Services accounts. +// VISA PVV and IBM3624. For more information, see [Verify PIN data]in the Amazon Web Services +// Payment Cryptography User Guide. +// +// This operation verifies PIN data for user payment card. A card holder PIN data +// is never transmitted in clear to or from Amazon Web Services Payment +// Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN +// Offset generation and then encrypts it using PIN Encryption Key (PEK) to create +// an EncryptedPinBlock for transmission from Amazon Web Services Payment +// Cryptography. +// +// For information about valid keys for this operation, see [Understanding key attributes] and [Key types for specific data operations] in the Amazon +// Web Services Payment Cryptography User Guide. +// +// Cross-account use: This operation can't be used across different Amazon Web +// Services accounts. +// // Related operations: -// - GeneratePinData -// - TranslatePinData +// +// # GeneratePinData +// +// # TranslatePinData +// +// [Key types for specific data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html +// [Understanding key attributes]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html +// [Verify PIN data]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html func (c *Client) VerifyPinData(ctx context.Context, params *VerifyPinDataInput, optFns ...func(*Options)) (*VerifyPinDataOutput, error) { if params == nil { params = &VerifyPinDataInput{} @@ -56,12 +67,14 @@ type VerifyPinDataInput struct { EncryptionKeyIdentifier *string // The PIN encoding format for pin data generation as specified in ISO 9564. - // Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3 - // . The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and + // Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3 . + // + // The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and // ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports - // a PIN from 4 to 12 digits in length. The ISO_Format_3 PIN block format is the - // same as ISO_Format_0 except that the fill digits are random values from 10 to - // 15. + // a PIN from 4 to 12 digits in length. + // + // The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the + // fill digits are random values from 10 to 15. // // This member is required. PinBlockFormat types.PinBlockFormatForPinData @@ -101,8 +114,10 @@ type VerifyPinDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. EncryptionKeyCheckValue *string @@ -115,8 +130,10 @@ type VerifyPinDataOutput struct { // The key check value (KCV) of the encryption key. The KCV is used to check if // all parties holding a given key have the same key or to detect that a key has - // changed. Amazon Web Services Payment Cryptography computes the KCV according to - // the CMAC specification. + // changed. + // + // Amazon Web Services Payment Cryptography computes the KCV according to the CMAC + // specification. // // This member is required. VerificationKeyCheckValue *string diff --git a/service/paymentcryptographydata/doc.go b/service/paymentcryptographydata/doc.go index 08a2ac78f06..fbcaec5d070 100644 --- a/service/paymentcryptographydata/doc.go +++ b/service/paymentcryptographydata/doc.go @@ -7,10 +7,13 @@ // encryption keys are used for payment-related transaction processing and // associated cryptographic operations. You can encrypt, decrypt, generate, verify, // and translate payment-related cryptographic operations in Amazon Web Services -// Payment Cryptography. For more information, see Data operations (https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.html) -// in the Amazon Web Services Payment Cryptography User Guide. To manage your -// encryption keys, you use the Amazon Web Services Payment Cryptography Control -// Plane (https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/Welcome.html) -// . You can create, import, export, share, manage, and delete keys. You can also -// manage Identity and Access Management (IAM) policies for keys. +// Payment Cryptography. For more information, see [Data operations]in the Amazon Web Services +// Payment Cryptography User Guide. +// +// To manage your encryption keys, you use the [Amazon Web Services Payment Cryptography Control Plane]. You can create, import, export, +// share, manage, and delete keys. You can also manage Identity and Access +// Management (IAM) policies for keys. +// +// [Amazon Web Services Payment Cryptography Control Plane]: https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/Welcome.html +// [Data operations]: https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.html package paymentcryptographydata diff --git a/service/paymentcryptographydata/options.go b/service/paymentcryptographydata/options.go index 3eda695222a..d4a82cc04d5 100644 --- a/service/paymentcryptographydata/options.go +++ b/service/paymentcryptographydata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/paymentcryptographydata/types/enums.go b/service/paymentcryptographydata/types/enums.go index 04dbc45c2ce..4e70bf793b7 100644 --- a/service/paymentcryptographydata/types/enums.go +++ b/service/paymentcryptographydata/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for DukptDerivationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DukptDerivationType) Values() []DukptDerivationType { return []DukptDerivationType{ "TDES_2KEY", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for DukptEncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DukptEncryptionMode) Values() []DukptEncryptionMode { return []DukptEncryptionMode{ "ECB", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for DukptKeyVariant. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DukptKeyVariant) Values() []DukptKeyVariant { return []DukptKeyVariant{ "BIDIRECTIONAL", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for EmvEncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmvEncryptionMode) Values() []EmvEncryptionMode { return []EmvEncryptionMode{ "ECB", @@ -92,6 +96,7 @@ const ( // Values returns all known values for EmvMajorKeyDerivationMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EmvMajorKeyDerivationMode) Values() []EmvMajorKeyDerivationMode { return []EmvMajorKeyDerivationMode{ @@ -115,8 +120,9 @@ const ( ) // Values returns all known values for EncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionMode) Values() []EncryptionMode { return []EncryptionMode{ "ECB", @@ -144,8 +150,9 @@ const ( ) // Values returns all known values for MacAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MacAlgorithm) Values() []MacAlgorithm { return []MacAlgorithm{ "ISO9797_ALGORITHM1", @@ -167,8 +174,9 @@ const ( ) // Values returns all known values for MajorKeyDerivationMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MajorKeyDerivationMode) Values() []MajorKeyDerivationMode { return []MajorKeyDerivationMode{ "EMV_OPTION_A", @@ -187,8 +195,9 @@ const ( ) // Values returns all known values for PaddingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PaddingType) Values() []PaddingType { return []PaddingType{ "PKCS1", @@ -208,6 +217,7 @@ const ( // Values returns all known values for PinBlockFormatForPinData. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PinBlockFormatForPinData) Values() []PinBlockFormatForPinData { return []PinBlockFormatForPinData{ @@ -229,6 +239,7 @@ const ( // Values returns all known values for SessionKeyDerivationMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SessionKeyDerivationMode) Values() []SessionKeyDerivationMode { return []SessionKeyDerivationMode{ @@ -252,6 +263,7 @@ const ( // Values returns all known values for VerificationFailedReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VerificationFailedReason) Values() []VerificationFailedReason { return []VerificationFailedReason{ diff --git a/service/paymentcryptographydata/types/types.go b/service/paymentcryptographydata/types/types.go index e446a3fb526..c5964245b03 100644 --- a/service/paymentcryptographydata/types/types.go +++ b/service/paymentcryptographydata/types/types.go @@ -438,7 +438,9 @@ type DukptEncryptionAttributes struct { // Services Payment Cryptography defaults it to zero. InitializationVector *string - // The block cipher method to use for encryption. The default is CBC. + // The block cipher method to use for encryption. + // + // The default is CBC. Mode DukptEncryptionMode noSmithyDocumentSerde diff --git a/service/pcaconnectorad/api_op_CreateConnector.go b/service/pcaconnectorad/api_op_CreateConnector.go index 5ae52c9d693..b517ffa3c6a 100644 --- a/service/pcaconnectorad/api_op_CreateConnector.go +++ b/service/pcaconnectorad/api_op_CreateConnector.go @@ -30,7 +30,7 @@ func (c *Client) CreateConnector(ctx context.Context, params *CreateConnectorInp type CreateConnectorInput struct { - // The Amazon Resource Name (ARN) of the certificate authority being used. + // The Amazon Resource Name (ARN) of the certificate authority being used. // // This member is required. CertificateAuthorityArn *string diff --git a/service/pcaconnectorad/api_op_CreateDirectoryRegistration.go b/service/pcaconnectorad/api_op_CreateDirectoryRegistration.go index a6096b5ab67..e403aa01328 100644 --- a/service/pcaconnectorad/api_op_CreateDirectoryRegistration.go +++ b/service/pcaconnectorad/api_op_CreateDirectoryRegistration.go @@ -29,7 +29,7 @@ func (c *Client) CreateDirectoryRegistration(ctx context.Context, params *Create type CreateDirectoryRegistrationInput struct { - // The identifier of the Active Directory. + // The identifier of the Active Directory. // // This member is required. DirectoryId *string @@ -45,9 +45,9 @@ type CreateDirectoryRegistrationInput struct { type CreateDirectoryRegistrationOutput struct { - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html DirectoryRegistrationArn *string // Metadata pertaining to the operation's result. diff --git a/service/pcaconnectorad/api_op_CreateServicePrincipalName.go b/service/pcaconnectorad/api_op_CreateServicePrincipalName.go index d1df0ee2dd0..bc5651fa481 100644 --- a/service/pcaconnectorad/api_op_CreateServicePrincipalName.go +++ b/service/pcaconnectorad/api_op_CreateServicePrincipalName.go @@ -30,15 +30,16 @@ func (c *Client) CreateServicePrincipalName(ctx context.Context, params *CreateS type CreateServicePrincipalNameInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html // // This member is required. DirectoryRegistrationArn *string diff --git a/service/pcaconnectorad/api_op_CreateTemplate.go b/service/pcaconnectorad/api_op_CreateTemplate.go index d144ebb6335..1caee16a18b 100644 --- a/service/pcaconnectorad/api_op_CreateTemplate.go +++ b/service/pcaconnectorad/api_op_CreateTemplate.go @@ -31,8 +31,9 @@ func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput type CreateTemplateInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string diff --git a/service/pcaconnectorad/api_op_CreateTemplateGroupAccessControlEntry.go b/service/pcaconnectorad/api_op_CreateTemplateGroupAccessControlEntry.go index 1247223b147..5088ea2aad8 100644 --- a/service/pcaconnectorad/api_op_CreateTemplateGroupAccessControlEntry.go +++ b/service/pcaconnectorad/api_op_CreateTemplateGroupAccessControlEntry.go @@ -31,8 +31,8 @@ func (c *Client) CreateTemplateGroupAccessControlEntry(ctx context.Context, para type CreateTemplateGroupAccessControlEntryInput struct { - // Allow or deny permissions for an Active Directory group to enroll or autoenroll - // certificates for a template. + // Allow or deny permissions for an Active Directory group to enroll or + // autoenroll certificates for a template. // // This member is required. AccessRights *types.AccessRights @@ -49,8 +49,9 @@ type CreateTemplateGroupAccessControlEntryInput struct { // This member is required. GroupSecurityIdentifier *string - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_DeleteConnector.go b/service/pcaconnectorad/api_op_DeleteConnector.go index fa24c9329cf..716cc797b86 100644 --- a/service/pcaconnectorad/api_op_DeleteConnector.go +++ b/service/pcaconnectorad/api_op_DeleteConnector.go @@ -12,12 +12,12 @@ import ( // Deletes a connector for Active Directory. You must provide the Amazon Resource // Name (ARN) of the connector that you want to delete. You can find the ARN by -// calling the -// https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors) -// action. Deleting a connector does not deregister your directory with Amazon Web -// Services Private CA. You can deregister your directory by calling the -// https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration) -// action. +// calling the [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors]action. Deleting a connector does not deregister your directory +// with Amazon Web Services Private CA. You can deregister your directory by +// calling the [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration]action. +// +// [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors +// [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration func (c *Client) DeleteConnector(ctx context.Context, params *DeleteConnectorInput, optFns ...func(*Options)) (*DeleteConnectorOutput, error) { if params == nil { params = &DeleteConnectorInput{} @@ -35,8 +35,9 @@ func (c *Client) DeleteConnector(ctx context.Context, params *DeleteConnectorInp type DeleteConnectorInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string diff --git a/service/pcaconnectorad/api_op_DeleteDirectoryRegistration.go b/service/pcaconnectorad/api_op_DeleteDirectoryRegistration.go index b70ffbc0c94..e6a1fd7c870 100644 --- a/service/pcaconnectorad/api_op_DeleteDirectoryRegistration.go +++ b/service/pcaconnectorad/api_op_DeleteDirectoryRegistration.go @@ -29,9 +29,9 @@ func (c *Client) DeleteDirectoryRegistration(ctx context.Context, params *Delete type DeleteDirectoryRegistrationInput struct { - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html // // This member is required. DirectoryRegistrationArn *string diff --git a/service/pcaconnectorad/api_op_DeleteServicePrincipalName.go b/service/pcaconnectorad/api_op_DeleteServicePrincipalName.go index c3124a5e48f..65f875d3b50 100644 --- a/service/pcaconnectorad/api_op_DeleteServicePrincipalName.go +++ b/service/pcaconnectorad/api_op_DeleteServicePrincipalName.go @@ -29,15 +29,16 @@ func (c *Client) DeleteServicePrincipalName(ctx context.Context, params *DeleteS type DeleteServicePrincipalNameInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html // // This member is required. DirectoryRegistrationArn *string diff --git a/service/pcaconnectorad/api_op_DeleteTemplate.go b/service/pcaconnectorad/api_op_DeleteTemplate.go index 6434301c52e..faf7b30f47d 100644 --- a/service/pcaconnectorad/api_op_DeleteTemplate.go +++ b/service/pcaconnectorad/api_op_DeleteTemplate.go @@ -29,8 +29,9 @@ func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput type DeleteTemplateInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_DeleteTemplateGroupAccessControlEntry.go b/service/pcaconnectorad/api_op_DeleteTemplateGroupAccessControlEntry.go index 35fbfc1c988..666382f8f33 100644 --- a/service/pcaconnectorad/api_op_DeleteTemplateGroupAccessControlEntry.go +++ b/service/pcaconnectorad/api_op_DeleteTemplateGroupAccessControlEntry.go @@ -34,8 +34,9 @@ type DeleteTemplateGroupAccessControlEntryInput struct { // This member is required. GroupSecurityIdentifier *string - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_GetConnector.go b/service/pcaconnectorad/api_op_GetConnector.go index 8479cc9ace6..2efec179ef2 100644 --- a/service/pcaconnectorad/api_op_GetConnector.go +++ b/service/pcaconnectorad/api_op_GetConnector.go @@ -30,8 +30,9 @@ func (c *Client) GetConnector(ctx context.Context, params *GetConnectorInput, op type GetConnectorInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string diff --git a/service/pcaconnectorad/api_op_GetDirectoryRegistration.go b/service/pcaconnectorad/api_op_GetDirectoryRegistration.go index 8357afd5673..f190c2a8363 100644 --- a/service/pcaconnectorad/api_op_GetDirectoryRegistration.go +++ b/service/pcaconnectorad/api_op_GetDirectoryRegistration.go @@ -29,9 +29,9 @@ func (c *Client) GetDirectoryRegistration(ctx context.Context, params *GetDirect type GetDirectoryRegistrationInput struct { - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html // // This member is required. DirectoryRegistrationArn *string diff --git a/service/pcaconnectorad/api_op_GetServicePrincipalName.go b/service/pcaconnectorad/api_op_GetServicePrincipalName.go index 9f083afe121..cf0d3168e82 100644 --- a/service/pcaconnectorad/api_op_GetServicePrincipalName.go +++ b/service/pcaconnectorad/api_op_GetServicePrincipalName.go @@ -30,15 +30,16 @@ func (c *Client) GetServicePrincipalName(ctx context.Context, params *GetService type GetServicePrincipalNameInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html // // This member is required. DirectoryRegistrationArn *string diff --git a/service/pcaconnectorad/api_op_GetTemplate.go b/service/pcaconnectorad/api_op_GetTemplate.go index 88e3f981dce..36c35860431 100644 --- a/service/pcaconnectorad/api_op_GetTemplate.go +++ b/service/pcaconnectorad/api_op_GetTemplate.go @@ -30,8 +30,9 @@ func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optF type GetTemplateInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_GetTemplateGroupAccessControlEntry.go b/service/pcaconnectorad/api_op_GetTemplateGroupAccessControlEntry.go index 36928814eff..c761955af45 100644 --- a/service/pcaconnectorad/api_op_GetTemplateGroupAccessControlEntry.go +++ b/service/pcaconnectorad/api_op_GetTemplateGroupAccessControlEntry.go @@ -35,8 +35,9 @@ type GetTemplateGroupAccessControlEntryInput struct { // This member is required. GroupSecurityIdentifier *string - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_ListConnectors.go b/service/pcaconnectorad/api_op_ListConnectors.go index 8b14df9ee07..2c8423f5777 100644 --- a/service/pcaconnectorad/api_op_ListConnectors.go +++ b/service/pcaconnectorad/api_op_ListConnectors.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the connectors that you created by using the -// https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector) -// action. +// Lists the connectors that you created by using the [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector] action. +// +// [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector func (c *Client) ListConnectors(ctx context.Context, params *ListConnectorsInput, optFns ...func(*Options)) (*ListConnectorsOutput, error) { if params == nil { params = &ListConnectorsInput{} diff --git a/service/pcaconnectorad/api_op_ListDirectoryRegistrations.go b/service/pcaconnectorad/api_op_ListDirectoryRegistrations.go index fbecbcc1ccf..88b23cb3e01 100644 --- a/service/pcaconnectorad/api_op_ListDirectoryRegistrations.go +++ b/service/pcaconnectorad/api_op_ListDirectoryRegistrations.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the directory registrations that you created by using the -// https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration) -// action. +// Lists the directory registrations that you created by using the [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration] action. +// +// [https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration func (c *Client) ListDirectoryRegistrations(ctx context.Context, params *ListDirectoryRegistrationsInput, optFns ...func(*Options)) (*ListDirectoryRegistrationsOutput, error) { if params == nil { params = &ListDirectoryRegistrationsInput{} diff --git a/service/pcaconnectorad/api_op_ListServicePrincipalNames.go b/service/pcaconnectorad/api_op_ListServicePrincipalNames.go index 365957e98e3..13c69b35a98 100644 --- a/service/pcaconnectorad/api_op_ListServicePrincipalNames.go +++ b/service/pcaconnectorad/api_op_ListServicePrincipalNames.go @@ -30,9 +30,9 @@ func (c *Client) ListServicePrincipalNames(ctx context.Context, params *ListServ type ListServicePrincipalNamesInput struct { - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html // // This member is required. DirectoryRegistrationArn *string diff --git a/service/pcaconnectorad/api_op_ListTemplateGroupAccessControlEntries.go b/service/pcaconnectorad/api_op_ListTemplateGroupAccessControlEntries.go index af9a755df82..3cb80900bac 100644 --- a/service/pcaconnectorad/api_op_ListTemplateGroupAccessControlEntries.go +++ b/service/pcaconnectorad/api_op_ListTemplateGroupAccessControlEntries.go @@ -29,8 +29,9 @@ func (c *Client) ListTemplateGroupAccessControlEntries(ctx context.Context, para type ListTemplateGroupAccessControlEntriesInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_ListTemplates.go b/service/pcaconnectorad/api_op_ListTemplates.go index 7883c90d145..17eefebc88b 100644 --- a/service/pcaconnectorad/api_op_ListTemplates.go +++ b/service/pcaconnectorad/api_op_ListTemplates.go @@ -29,8 +29,9 @@ func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, type ListTemplatesInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html // // This member is required. ConnectorArn *string diff --git a/service/pcaconnectorad/api_op_UpdateTemplate.go b/service/pcaconnectorad/api_op_UpdateTemplate.go index ba8c4e175a2..522da147edd 100644 --- a/service/pcaconnectorad/api_op_UpdateTemplate.go +++ b/service/pcaconnectorad/api_op_UpdateTemplate.go @@ -30,8 +30,9 @@ func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput type UpdateTemplateInput struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/api_op_UpdateTemplateGroupAccessControlEntry.go b/service/pcaconnectorad/api_op_UpdateTemplateGroupAccessControlEntry.go index bf31fc4b240..16be0ec0d54 100644 --- a/service/pcaconnectorad/api_op_UpdateTemplateGroupAccessControlEntry.go +++ b/service/pcaconnectorad/api_op_UpdateTemplateGroupAccessControlEntry.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a group access control entry you created using -// CreateTemplateGroupAccessControlEntry (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplateGroupAccessControlEntry.html) -// . +// Update a group access control entry you created using [CreateTemplateGroupAccessControlEntry]. +// +// [CreateTemplateGroupAccessControlEntry]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplateGroupAccessControlEntry.html func (c *Client) UpdateTemplateGroupAccessControlEntry(ctx context.Context, params *UpdateTemplateGroupAccessControlEntryInput, optFns ...func(*Options)) (*UpdateTemplateGroupAccessControlEntryOutput, error) { if params == nil { params = &UpdateTemplateGroupAccessControlEntryInput{} @@ -37,8 +37,9 @@ type UpdateTemplateGroupAccessControlEntryInput struct { // This member is required. GroupSecurityIdentifier *string - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html // // This member is required. TemplateArn *string diff --git a/service/pcaconnectorad/doc.go b/service/pcaconnectorad/doc.go index 66a08990750..d8302b34e02 100644 --- a/service/pcaconnectorad/doc.go +++ b/service/pcaconnectorad/doc.go @@ -6,7 +6,7 @@ // Amazon Web Services Private CA Connector for Active Directory creates a // connector between Amazon Web Services Private CA and Active Directory (AD) that // enables you to provision security certificates for AD signed by a private CA -// that you own. For more information, see Amazon Web Services Private CA -// Connector for Active Directory (https://docs.aws.amazon.com/privateca/latest/userguide/ad-connector.html) -// . +// that you own. For more information, see [Amazon Web Services Private CA Connector for Active Directory]. +// +// [Amazon Web Services Private CA Connector for Active Directory]: https://docs.aws.amazon.com/privateca/latest/userguide/ad-connector.html package pcaconnectorad diff --git a/service/pcaconnectorad/options.go b/service/pcaconnectorad/options.go index 083818f4014..a580d4db024 100644 --- a/service/pcaconnectorad/options.go +++ b/service/pcaconnectorad/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pcaconnectorad/types/enums.go b/service/pcaconnectorad/types/enums.go index d8a2d490d1d..657ddb4fc9e 100644 --- a/service/pcaconnectorad/types/enums.go +++ b/service/pcaconnectorad/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessRight. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessRight) Values() []AccessRight { return []AccessRight{ "ALLOW", @@ -94,8 +95,9 @@ const ( ) // Values returns all known values for ApplicationPolicyType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationPolicyType) Values() []ApplicationPolicyType { return []ApplicationPolicyType{ "ALL_APPLICATION_POLICIES", @@ -181,8 +183,9 @@ const ( ) // Values returns all known values for ClientCompatibilityV2. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientCompatibilityV2) Values() []ClientCompatibilityV2 { return []ClientCompatibilityV2{ "WINDOWS_SERVER_2003", @@ -206,8 +209,9 @@ const ( ) // Values returns all known values for ClientCompatibilityV3. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientCompatibilityV3) Values() []ClientCompatibilityV3 { return []ClientCompatibilityV3{ "WINDOWS_SERVER_2008", @@ -228,8 +232,9 @@ const ( ) // Values returns all known values for ClientCompatibilityV4. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientCompatibilityV4) Values() []ClientCompatibilityV4 { return []ClientCompatibilityV4{ "WINDOWS_SERVER_2012", @@ -249,8 +254,9 @@ const ( ) // Values returns all known values for ConnectorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorStatus) Values() []ConnectorStatus { return []ConnectorStatus{ "CREATING", @@ -275,8 +281,9 @@ const ( ) // Values returns all known values for ConnectorStatusReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorStatusReason) Values() []ConnectorStatusReason { return []ConnectorStatusReason{ "DIRECTORY_ACCESS_DENIED", @@ -302,6 +309,7 @@ const ( // Values returns all known values for DirectoryRegistrationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryRegistrationStatus) Values() []DirectoryRegistrationStatus { return []DirectoryRegistrationStatus{ @@ -326,8 +334,9 @@ const ( // Values returns all known values for DirectoryRegistrationStatusReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryRegistrationStatusReason) Values() []DirectoryRegistrationStatusReason { return []DirectoryRegistrationStatusReason{ "DIRECTORY_ACCESS_DENIED", @@ -349,8 +358,9 @@ const ( ) // Values returns all known values for HashAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HashAlgorithm) Values() []HashAlgorithm { return []HashAlgorithm{ "SHA256", @@ -368,8 +378,9 @@ const ( ) // Values returns all known values for KeySpec. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeySpec) Values() []KeySpec { return []KeySpec{ "KEY_EXCHANGE", @@ -385,8 +396,9 @@ const ( ) // Values returns all known values for KeyUsagePropertyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeyUsagePropertyType) Values() []KeyUsagePropertyType { return []KeyUsagePropertyType{ "ALL", @@ -404,8 +416,9 @@ const ( ) // Values returns all known values for PrivateKeyAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrivateKeyAlgorithm) Values() []PrivateKeyAlgorithm { return []PrivateKeyAlgorithm{ "RSA", @@ -427,6 +440,7 @@ const ( // Values returns all known values for ServicePrincipalNameStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServicePrincipalNameStatus) Values() []ServicePrincipalNameStatus { return []ServicePrincipalNameStatus{ @@ -450,8 +464,9 @@ const ( // Values returns all known values for ServicePrincipalNameStatusReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServicePrincipalNameStatusReason) Values() []ServicePrincipalNameStatusReason { return []ServicePrincipalNameStatusReason{ "DIRECTORY_ACCESS_DENIED", @@ -471,8 +486,9 @@ const ( ) // Values returns all known values for TemplateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateStatus) Values() []TemplateStatus { return []TemplateStatus{ "ACTIVE", @@ -496,6 +512,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -522,8 +539,9 @@ const ( ) // Values returns all known values for ValidityPeriodType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidityPeriodType) Values() []ValidityPeriodType { return []ValidityPeriodType{ "HOURS", diff --git a/service/pcaconnectorad/types/types.go b/service/pcaconnectorad/types/types.go index b939738af5c..fe38b3ed7c1 100644 --- a/service/pcaconnectorad/types/types.go +++ b/service/pcaconnectorad/types/types.go @@ -7,8 +7,9 @@ import ( "time" ) -// An access control entry allows or denies Active Directory groups based on their -// security identifiers (SIDs) from enrolling and/or autoenrolling with the +// An access control entry allows or denies Active Directory groups based on +// +// their security identifiers (SIDs) from enrolling and/or autoenrolling with the // template. type AccessControlEntry struct { @@ -27,8 +28,9 @@ type AccessControlEntry struct { // starts with "S-". GroupSecurityIdentifier *string - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html TemplateArn *string // The date and time that the Access Control Entry was updated. @@ -57,8 +59,9 @@ type AccessControlEntrySummary struct { // starts with "S-". GroupSecurityIdentifier *string - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html TemplateArn *string // The date and time that the Access Control Entry was updated. @@ -67,8 +70,9 @@ type AccessControlEntrySummary struct { noSmithyDocumentSerde } -// Allow or deny permissions for an Active Directory group to enroll or autoenroll -// certificates for a template. +// Allow or deny permissions for an Active Directory group to enroll or +// +// autoenroll certificates for a template. type AccessRights struct { // Allow or deny an Active Directory group from autoenrolling certificates issued @@ -164,8 +168,9 @@ type CertificateValidity struct { // domain-joined users and machines managed with Active Directory. type Connector struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html Arn *string // The Amazon Resource Name (ARN) of the certificate authority being used. @@ -200,8 +205,9 @@ type Connector struct { // belonging to an Amazon Web Services account. type ConnectorSummary struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html Arn *string // The Amazon Resource Name (ARN) of the certificate authority being used. @@ -263,9 +269,9 @@ type DirectoryRegistration struct { // service with the Active Directory. type DirectoryRegistrationSummary struct { - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html Arn *string // The date and time that the directory registration was created. @@ -699,17 +705,17 @@ type PrivateKeyFlagsV4 struct { // Directory. type ServicePrincipalName struct { - // The Amazon Resource Name (ARN) that was returned when you called - // CreateConnector.html (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector.html]. + // + // [CreateConnector.html]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html ConnectorArn *string // The date and time that the service principal name was created. CreatedAt *time.Time - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html DirectoryRegistrationArn *string // The status of a service principal name. @@ -729,16 +735,17 @@ type ServicePrincipalName struct { // Directory. type ServicePrincipalNameSummary struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html ConnectorArn *string // The date and time that the service principal name was created. CreatedAt *time.Time - // The Amazon Resource Name (ARN) that was returned when you called - // CreateDirectoryRegistration (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateDirectoryRegistration]. + // + // [CreateDirectoryRegistration]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html DirectoryRegistrationArn *string // The status of a service principal name. @@ -888,12 +895,14 @@ type SubjectNameFlagsV4 struct { // group membership. type Template struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html Arn *string - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html ConnectorArn *string // The date and time that the template was created. @@ -1004,12 +1013,14 @@ type TemplateRevision struct { // group membership. type TemplateSummary struct { - // The Amazon Resource Name (ARN) that was returned when you called CreateTemplate (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateTemplate]. + // + // [CreateTemplate]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html Arn *string - // The Amazon Resource Name (ARN) that was returned when you called CreateConnector (https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html) - // . + // The Amazon Resource Name (ARN) that was returned when you called [CreateConnector]. + // + // [CreateConnector]: https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html ConnectorArn *string // The date and time that the template was created. diff --git a/service/personalize/api_op_CreateBatchInferenceJob.go b/service/personalize/api_op_CreateBatchInferenceJob.go index 45df344a364..af71a79d605 100644 --- a/service/personalize/api_op_CreateBatchInferenceJob.go +++ b/service/personalize/api_op_CreateBatchInferenceJob.go @@ -12,20 +12,29 @@ import ( ) // Generates batch recommendations based on a list of items or users stored in -// Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate -// batch recommendations, specify the ARN of a solution version and an Amazon S3 -// URI for the input and output data. For user personalization, popular items, and -// personalized ranking solutions, the batch inference job generates a list of -// recommended items for each user ID in the input file. For related items +// Amazon S3 and exports the recommendations to an Amazon S3 bucket. +// +// To generate batch recommendations, specify the ARN of a solution version and an +// Amazon S3 URI for the input and output data. For user personalization, popular +// items, and personalized ranking solutions, the batch inference job generates a +// list of recommended items for each user ID in the input file. For related items // solutions, the job generates a list of recommended items for each item ID in the -// input file. For more information, see Creating a batch inference job (https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html) -// . If you use the Similar-Items recipe, Amazon Personalize can add descriptive +// input file. +// +// For more information, see [Creating a batch inference job]. +// +// If you use the Similar-Items recipe, Amazon Personalize can add descriptive // themes to batch recommendations. To generate themes, set the job's mode to // THEME_GENERATION and specify the name of the field that contains item names in -// the input data. For more information about generating themes, see Batch -// recommendations with themes from Content Generator (https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html) -// . You can't get batch recommendations with the Trending-Now or Next-Best-Action +// the input data. +// +// For more information about generating themes, see [Batch recommendations with themes from Content Generator]. +// +// You can't get batch recommendations with the Trending-Now or Next-Best-Action // recipes. +// +// [Creating a batch inference job]: https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html +// [Batch recommendations with themes from Content Generator]: https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html func (c *Client) CreateBatchInferenceJob(ctx context.Context, params *CreateBatchInferenceJobInput, optFns ...func(*Options)) (*CreateBatchInferenceJobOutput, error) { if params == nil { params = &CreateBatchInferenceJobInput{} @@ -76,22 +85,26 @@ type CreateBatchInferenceJobInput struct { // The mode of the batch inference job. To generate descriptive themes for groups // of similar items, set the job mode to THEME_GENERATION . If you don't want to - // generate themes, use the default BATCH_INFERENCE . When you get batch - // recommendations with themes, you will incur additional costs. For more - // information, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/) - // . + // generate themes, use the default BATCH_INFERENCE . + // + // When you get batch recommendations with themes, you will incur additional + // costs. For more information, see [Amazon Personalize pricing]. + // + // [Amazon Personalize pricing]: https://aws.amazon.com/personalize/pricing/ BatchInferenceJobMode types.BatchInferenceJobMode // 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]. + // + // [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/dg/tagging-resources.html) - // to apply to the batch inference job. + // A list of [tags] to apply to the batch inference job. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag // For theme generation jobs, specify the name of the column in your Items dataset diff --git a/service/personalize/api_op_CreateBatchSegmentJob.go b/service/personalize/api_op_CreateBatchSegmentJob.go index f33e374ae60..b3de1366bce 100644 --- a/service/personalize/api_op_CreateBatchSegmentJob.go +++ b/service/personalize/api_op_CreateBatchSegmentJob.go @@ -12,9 +12,9 @@ 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) -// . +// and the input file must be in JSON format. For more information, see [Getting batch recommendations and user segments]. +// +// [Getting 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{} @@ -60,16 +60,18 @@ type CreateBatchSegmentJobInput struct { 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) - // . + // on using filters, see [Filtering batch recommendations]. + // + // [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. The maximum number of users per segment is 5 million. NumResults *int32 - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the batch segment job. + // A list of [tags] to apply to the batch segment job. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateCampaign.go b/service/personalize/api_op_CreateCampaign.go index 371b319d2a8..f38b8c11696 100644 --- a/service/personalize/api_op_CreateCampaign.go +++ b/service/personalize/api_op_CreateCampaign.go @@ -11,43 +11,71 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// You incur campaign costs while it is active. To avoid unnecessary costs, make +// You incur campaign costs while it is active. To avoid unnecessary costs, make +// // sure to delete the campaign when you are finished. For information about -// campaign costs, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/) -// . 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) -// APIs, a campaign is specified in the request. Minimum Provisioned TPS and -// Auto-Scaling A high minProvisionedTPS will increase your cost. We recommend -// starting with 1 for minProvisionedTPS (the default). Track your usage using -// Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary. +// campaign costs, see [Amazon Personalize pricing]. +// +// Creates a campaign that deploys a solution version. When a client calls the [GetRecommendations] +// and [GetPersonalizedRanking]APIs, a campaign is specified in the request. +// +// # Minimum Provisioned TPS and Auto-Scaling +// +// A high minProvisionedTPS will increase your cost. We recommend starting with 1 +// for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch +// metrics, and increase the minProvisionedTPS as necessary. +// // When you create an Amazon Personalize campaign, you can specify the minimum // provisioned transactions per second ( minProvisionedTPS ) for the campaign. This // is the baseline transaction throughput for the campaign provisioned by Amazon // Personalize. It sets the minimum billing charge for the campaign while it is // active. A transaction is a single GetRecommendations or GetPersonalizedRanking -// request. The default minProvisionedTPS is 1. If your TPS increases beyond the -// 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. When your -// traffic reduces, capacity returns to the minProvisionedTPS . You are charged for -// the the minimum provisioned TPS or, if your requests exceed the -// minProvisionedTPS , the actual TPS. The actual TPS is the total number of +// request. The default minProvisionedTPS is 1. +// +// If your TPS increases beyond the 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. When your traffic reduces, capacity +// returns to the minProvisionedTPS . +// +// You are charged for the the minimum provisioned TPS or, if your requests exceed +// the minProvisionedTPS , the actual TPS. The actual TPS is the total number of // recommendation requests you make. We recommend starting with a low // minProvisionedTPS , track your usage using Amazon CloudWatch metrics, and then -// increase the minProvisionedTPS as necessary. For more information about -// campaign costs, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/) -// . Status A campaign can be in one of the following states: +// increase the minProvisionedTPS as necessary. +// +// For more information about campaign costs, see [Amazon Personalize pricing]. +// +// # 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 // -// 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]. +// +// Wait until the status of the campaign is ACTIVE before asking the campaign for +// recommendations. +// +// # Related APIs +// +// [ListCampaigns] +// +// [DescribeCampaign] +// +// [UpdateCampaign] +// +// [DeleteCampaign] +// +// [UpdateCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html +// [ListCampaigns]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html +// [DeleteCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html +// [GetPersonalizedRanking]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html +// [Amazon Personalize pricing]: https://aws.amazon.com/personalize/pricing/ +// [DescribeCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error) { if params == nil { params = &CreateCampaignInput{} @@ -74,11 +102,15 @@ type CreateCampaignInput struct { // The Amazon Resource Name (ARN) of the trained model to deploy with the // campaign. To specify the latest solution version of your solution, specify the // ARN of your solution in SolutionArn/$LATEST format. You must use this format if - // you set syncWithLatestSolutionVersion to True in the CampaignConfig (https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) - // . To deploy a model that isn't the latest solution version of your solution, - // specify the ARN of the solution version. For more information about automatic - // campaign updates, see Enabling automatic campaign updates (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update) - // . + // you set syncWithLatestSolutionVersion to True in the [CampaignConfig]. + // + // To deploy a model that isn't the latest solution version of your solution, + // specify the ARN of the solution version. + // + // For more information about automatic campaign updates, see [Enabling automatic campaign updates]. + // + // [Enabling automatic campaign updates]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update + // [CampaignConfig]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html // // This member is required. SolutionVersionArn *string @@ -93,8 +125,9 @@ type CreateCampaignInput struct { // minProvisionedTPS as necessary. MinProvisionedTPS *int32 - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the campaign. + // A list of [tags] to apply to the campaign. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDataDeletionJob.go b/service/personalize/api_op_CreateDataDeletionJob.go index 18422d2183e..b2e92bf0a02 100644 --- a/service/personalize/api_op_CreateDataDeletionJob.go +++ b/service/personalize/api_op_CreateDataDeletionJob.go @@ -16,33 +16,43 @@ import ( // a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon // Personalize no longer trains on the users’ data and no longer considers the // users when generating user segments. For more information about creating a data -// deletion job, see Deleting users (https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html) -// . +// deletion job, see [Deleting users]. +// // - Your input file must be a CSV file with a single USER_ID column that lists -// the users IDs. For more information about preparing the CSV file, see -// Preparing your data deletion file and uploading it to Amazon S3 (https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html) -// . +// the users IDs. For more information about preparing the CSV file, see [Preparing your data deletion file and uploading it to Amazon S3]. +// // - To give Amazon Personalize permission to access your input CSV file of // userIds, you must specify an IAM service role that has permission to read from // the data source. This role needs GetObject and ListBucket permissions for the // bucket and its content. These permissions are the same as importing data. 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) -// . +// information on granting access to your Amazon S3 bucket, see [Giving Amazon Personalize Access to Amazon S3 Resources]. // // After you create a job, it can take up to a day to delete all references to the // users from datasets and models. Until the job completes, Amazon Personalize // continues to use the data when training. And if you use a User Segmentation -// recipe, the users might appear in user segments. Status A data deletion job can -// have one of the following statuses: +// recipe, the users might appear in user segments. +// +// # Status +// +// A data deletion job can have one of the following statuses: +// // - PENDING > IN_PROGRESS > COMPLETED -or- FAILED // -// To get the status of the data deletion job, call DescribeDataDeletionJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) -// API operation and specify the Amazon Resource Name (ARN) of the job. If the -// status is FAILED, the response includes a failureReason key, which describes -// why the job failed. Related APIs -// - ListDataDeletionJobs (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html) -// - DescribeDataDeletionJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) +// To get the status of the data deletion job, call [DescribeDataDeletionJob] API operation and specify the +// Amazon Resource Name (ARN) of the job. If the status is FAILED, the response +// includes a failureReason key, which describes why the job failed. +// +// # Related APIs +// +// [ListDataDeletionJobs] +// +// [DescribeDataDeletionJob] +// +// [ListDataDeletionJobs]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html +// [Giving Amazon Personalize Access to Amazon S3 Resources]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html +// [Deleting users]: https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html +// [Preparing your data deletion file and uploading it to Amazon S3]: https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html +// [DescribeDataDeletionJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html func (c *Client) CreateDataDeletionJob(ctx context.Context, params *CreateDataDeletionJobInput, optFns ...func(*Options)) (*CreateDataDeletionJobOutput, error) { if params == nil { params = &CreateDataDeletionJobInput{} @@ -82,8 +92,9 @@ type CreateDataDeletionJobInput struct { // This member is required. RoleArn *string - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the data deletion job. + // A list of [tags] to apply to the data deletion job. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDataset.go b/service/personalize/api_op_CreateDataset.go index 9f0938efe94..21184e93301 100644 --- a/service/personalize/api_op_CreateDataset.go +++ b/service/personalize/api_op_CreateDataset.go @@ -11,27 +11,48 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// to import your training data to a dataset. There are 5 types of datasets: +// Creates an empty dataset and adds it to the specified dataset group. Use [CreateDatasetImportJob] to +// import your training data to a dataset. +// +// There are 5 types of datasets: +// // - Item interactions +// // - Items +// // - Users +// // - Action interactions +// // - Actions // // Each dataset type has an associated schema with required field types. Only the // Item 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: +// 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]. +// +// # Related APIs +// +// [CreateDatasetGroup] +// +// [ListDatasets] +// +// [DescribeDataset] +// +// [DeleteDataset] +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html +// [DescribeDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html +// [ListDatasets]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html +// [DeleteDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html +// [CreateDatasetGroup]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} @@ -54,11 +75,18 @@ type CreateDatasetInput struct { // This member is required. DatasetGroupArn *string - // The type of dataset. One of the following (case insensitive) values: + // The type of dataset. + // + // One of the following (case insensitive) values: + // // - Interactions + // // - Items + // // - Users + // // - Actions + // // - Action_Interactions // // This member is required. @@ -75,8 +103,9 @@ type CreateDatasetInput struct { // This member is required. SchemaArn *string - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the dataset. + // A list of [tags] to apply to the dataset. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDatasetExportJob.go b/service/personalize/api_op_CreateDatasetExportJob.go index 7bc4adbc83a..2e0a50e7057 100644 --- a/service/personalize/api_op_CreateDatasetExportJob.go +++ b/service/personalize/api_op_CreateDatasetExportJob.go @@ -11,19 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a job that exports data from your dataset to an Amazon S3 bucket. To +// 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]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 // -// 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. +// To get the status of the export job, call [DescribeDatasetExportJob], 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. +// +// [Exporting a dataset]: https://docs.aws.amazon.com/personalize/latest/dg/export-data.html +// [DescribeDatasetExportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html func (c *Client) CreateDatasetExportJob(ctx context.Context, params *CreateDatasetExportJobInput, optFns ...func(*Options)) (*CreateDatasetExportJobOutput, error) { if params == nil { params = &CreateDatasetExportJobInput{} @@ -68,8 +75,9 @@ type CreateDatasetExportJobInput struct { // 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/dg/tagging-resources.html) - // to apply to the dataset export job. + // A list of [tags] to apply to the dataset export job. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDatasetGroup.go b/service/personalize/api_op_CreateDatasetGroup.go index 28904ae51ea..b5be3719876 100644 --- a/service/personalize/api_op_CreateDatasetGroup.go +++ b/service/personalize/api_op_CreateDatasetGroup.go @@ -14,10 +14,15 @@ 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: +// // - Item interactions +// // - Items +// // - Users +// // - Actions +// // - Action interactions // // A dataset group can be a Domain dataset group, where you specify a domain and @@ -25,27 +30,47 @@ import ( // 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: +// 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) +// To get the status of the dataset group, call [DescribeDatasetGroup]. 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] +// +// [CreateEventTracker] +// +// [CreateSolution] +// +// # Related APIs +// +// [ListDatasetGroups] +// +// [DescribeDatasetGroup] +// +// [DeleteDatasetGroup] +// +// [CreateDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html +// [ListDatasetGroups]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html +// [CreateEventTracker]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.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{} @@ -84,8 +109,9 @@ type CreateDatasetGroupInput struct { // valid when also specifying a KMS key. RoleArn *string - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the dataset group. + // A list of [tags] to apply to the dataset group. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateDatasetImportJob.go b/service/personalize/api_op_CreateDatasetImportJob.go index de1108faffd..a4ca712ed8f 100644 --- a/service/personalize/api_op_CreateDatasetImportJob.go +++ b/service/personalize/api_op_CreateDatasetImportJob.go @@ -16,25 +16,40 @@ 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) -// . If you already created a recommender or deployed a custom solution version -// with a campaign, how new bulk records influence recommendations depends on the -// domain use case or recipe that you use. For more information, see How new data -// influences real-time recommendations (https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.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]. +// +// If you already created a recommender or deployed a custom solution version with +// a campaign, how new bulk records influence recommendations depends on the domain +// use case or recipe that you use. For more information, see [How new data influences real-time recommendations]. +// +// 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: +// +// # Status +// +// A dataset import job can be in one of the following states: +// // - 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], 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] +// +// [DescribeDatasetImportJob] +// +// [ListDatasetImportJobs]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html +// [Giving Amazon Personalize Access to Amazon S3 Resources]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html +// [DescribeDatasetImportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html +// [How new data influences real-time recommendations]: https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html func (c *Client) CreateDatasetImportJob(ctx context.Context, params *CreateDatasetImportJobInput, optFns ...func(*Options)) (*CreateDatasetImportJobOutput, error) { if params == nil { params = &CreateDatasetImportJobInput{} @@ -76,8 +91,10 @@ type CreateDatasetImportJobInput struct { // 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. @@ -87,8 +104,9 @@ type CreateDatasetImportJobInput struct { // this import job to Amazon S3 PublishAttributionMetricsToS3 *bool - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the dataset import job. + // A list of [tags] to apply to the dataset import job. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateEventTracker.go b/service/personalize/api_op_CreateEventTracker.go index dfd63133ada..84f99fa18ea 100644 --- a/service/personalize/api_op_CreateEventTracker.go +++ b/service/personalize/api_op_CreateEventTracker.go @@ -12,23 +12,39 @@ 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) -// operation. Amazon Personalize then appends the event data to the Item -// interactions dataset of the dataset group you specify in your event tracker. The -// event tracker can be in one of the following states: +// dataset group using the [PutEvents]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]operation. Amazon Personalize then +// appends the event data to the Item 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 // -// 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) +// To get the status of the event tracker, call [DescribeEventTracker]. +// +// The event tracker must be in the ACTIVE state before using the tracking ID. +// +// # Related APIs +// +// [ListEventTrackers] +// +// [DescribeEventTracker] +// +// [DeleteEventTracker] +// +// [PutEvents]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html +// [DescribeEventTracker]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html +// [ListEventTrackers]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.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{} @@ -57,8 +73,9 @@ type CreateEventTrackerInput struct { // This member is required. Name *string - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the event tracker. + // A list of [tags] to apply to the event tracker. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde @@ -69,8 +86,9 @@ 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] API. + // + // [PutEvents]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html 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 1f201f5e222..b16a79fce79 100644 --- a/service/personalize/api_op_CreateFilter.go +++ b/service/personalize/api_op_CreateFilter.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a recommendation filter. For more information, see Filtering -// recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) -// . +// Creates a recommendation filter. For more information, see [Filtering recommendations and user segments]. +// +// [Filtering 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,9 @@ 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]. + // + // [Filter expressions]: https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html // // This member is required. FilterExpression *string @@ -49,8 +50,9 @@ type CreateFilterInput struct { // This member is required. Name *string - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the filter. + // A list of [tags] to apply to the filter. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateMetricAttribution.go b/service/personalize/api_op_CreateMetricAttribution.go index be97db1b351..b5a49334730 100644 --- a/service/personalize/api_op_CreateMetricAttribution.go +++ b/service/personalize/api_op_CreateMetricAttribution.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} diff --git a/service/personalize/api_op_CreateRecommender.go b/service/personalize/api_op_CreateRecommender.go index 6e45e00819c..e7b3fb740df 100644 --- a/service/personalize/api_op_CreateRecommender.go +++ b/service/personalize/api_op_CreateRecommender.go @@ -13,43 +13,69 @@ 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) -// request. Minimum recommendation requests per second A high -// minRecommendationRequestsPerSecond will increase your bill. We recommend +// recommender's Amazon Resource Name (ARN) when you make a [GetRecommendations]request. +// +// # Minimum recommendation requests per second +// +// A high minRecommendationRequestsPerSecond will increase your bill. We recommend // starting with 1 for minRecommendationRequestsPerSecond (the default). Track // your usage using Amazon CloudWatch metrics, and increase the -// minRecommendationRequestsPerSecond as necessary. 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 -// request throughput provisioned by Amazon Personalize. The default +// minRecommendationRequestsPerSecond as necessary. +// +// 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 request throughput provisioned by Amazon Personalize. The default // 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 -// auto-scales the provisioned capacity up and down, but never below -// 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 +// requests per hour and the price of your recommender usage. +// +// If your requests per 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 +// 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 -// metrics, and then increase the minRecommendationRequestsPerSecond as necessary. -// Status A recommender can be in one of the following states: +// one-hour window. +// +// We recommend starting with the default 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 // -// 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]. +// +// Wait until the status of the recommender is ACTIVE before asking the +// recommender for recommendations. +// +// # Related APIs +// +// [ListRecommenders] +// +// [DescribeRecommender] +// +// [UpdateRecommender] +// +// [DeleteRecommender] +// +// [ListRecommenders]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.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 +// [DescribeRecommender]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html func (c *Client) CreateRecommender(ctx context.Context, params *CreateRecommenderInput, optFns ...func(*Options)) (*CreateRecommenderOutput, error) { if params == nil { params = &CreateRecommenderInput{} @@ -81,8 +107,9 @@ 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]. + // + // [Choosing recommender use cases]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html // // This member is required. RecipeArn *string @@ -90,8 +117,9 @@ type CreateRecommenderInput struct { // The configuration details of the recommender. RecommenderConfig *types.RecommenderConfig - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the recommender. + // A list of [tags] to apply to the recommender. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateSchema.go b/service/personalize/api_op_CreateSchema.go index 2adfc3eee3a..186cebb3bd4 100644 --- a/service/personalize/api_op_CreateSchema.go +++ b/service/personalize/api_op_CreateSchema.go @@ -12,15 +12,25 @@ import ( ) // Creates an Amazon Personalize schema from the specified schema string. The -// schema you create must be in Avro JSON format. Amazon Personalize recognizes -// 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) +// schema you create must be in Avro JSON format. +// +// Amazon Personalize recognizes 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]. +// +// # Related APIs +// +// [ListSchemas] +// +// [DescribeSchema] +// +// [DeleteSchema] +// +// [CreateDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.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 +// [ListSchemas]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.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 3a13ba35e79..03409a813bf 100644 --- a/service/personalize/api_op_CreateSolution.go +++ b/service/personalize/api_op_CreateSolution.go @@ -15,51 +15,71 @@ import ( // all new solutions use automatic training. With automatic training, you incur // training costs while your solution is active. You can't stop automatic training // for a solution. To avoid unnecessary costs, make sure to delete the solution -// when you are finished. For information about training costs, see Amazon -// Personalize pricing (https://aws.amazon.com/personalize/pricing/) . Creates the -// configuration for training a model (creating a solution version). This -// configuration includes the recipe to use for model training and optional +// when you are finished. For information about training costs, see [Amazon Personalize pricing]. +// +// Creates the configuration for training a model (creating a solution version). +// This configuration includes the recipe to use for model training and optional // training configuration, such as columns to use in training and feature // transformation parameters. For more information about configuring a solution, -// see Creating and configuring a solution (https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html) -// . By default, new solutions use automatic training to create solution versions +// see [Creating and configuring a solution]. +// +// By default, new solutions use automatic training to create solution versions // every 7 days. You can change the training frequency. Automatic solution version // creation starts one hour after the solution is ACTIVE. If you manually create a // solution version within the hour, the solution skips the first automatic -// training. For more information, see Configuring automatic training (https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html) -// . To turn off automatic training, set performAutoTraining to false. If you turn +// training. For more information, see [Configuring automatic training]. +// +// To turn off automatic training, set performAutoTraining to false. If you turn // off automatic training, you must manually create a solution version by calling -// the CreateSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) -// operation. After training starts, you can get the solution version's Amazon -// Resource Name (ARN) with the ListSolutionVersions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) -// API operation. To get its status, use the DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) -// . After training completes you can evaluate model accuracy by calling -// GetSolutionMetrics (https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html) -// . When you are satisfied with the solution 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. 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: +// the [CreateSolutionVersion]operation. +// +// After training starts, you can get the solution version's Amazon Resource Name +// (ARN) with the [ListSolutionVersions]API operation. To get its status, use the [DescribeSolutionVersion]. +// +// After training completes you can evaluate model accuracy by calling [GetSolutionMetrics]. When you +// are satisfied with the solution version, you deploy it using [CreateCampaign]. The campaign +// provides recommendations to a client through the [GetRecommendations]API. +// +// 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 // -// To get the status of the solution, call DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) -// . If you use manual training, the status must be ACTIVE before you call -// CreateSolutionVersion . Related APIs +// To get the status of the solution, call [DescribeSolution]. If you use manual training, the +// status must be ACTIVE before you call CreateSolutionVersion . +// +// # Related APIs +// +// [ListSolutions] // -// - ListSolutions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) +// [CreateSolutionVersion] // -// - CreateSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) +// [DescribeSolution] // -// - DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) +// [DeleteSolution] // -// - DeleteSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) +// [ListSolutionVersions] // -// - ListSolutionVersions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) +// [DescribeSolutionVersion] // -// - DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) +// [DescribeSolutionVersion]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html +// [CreateCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html +// [DeleteSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html +// [GetSolutionMetrics]: https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html +// [ListSolutionVersions]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html +// [Creating and configuring a solution]: https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html +// [ListSolutions]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html +// [Configuring automatic training]: https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html +// [Amazon Personalize pricing]: https://aws.amazon.com/personalize/pricing/ +// [CreateSolutionVersion]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html +// [DescribeSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html func (c *Client) CreateSolution(ctx context.Context, params *CreateSolutionInput, optFns ...func(*Options)) (*CreateSolutionOutput, error) { if params == nil { params = &CreateSolutionInput{} @@ -90,55 +110,69 @@ 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 - // will use all interactions for training with equal weight regardless of type. + // 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 // We don't recommend enabling automated machine learning. Instead, match your use - // case to the available Amazon Personalize recipes. For more information, see - // Choosing a recipe (https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html) - // . 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. + // case to the available Amazon Personalize recipes. For more information, see [Choosing a 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. + // + // [Choosing a recipe]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html PerformAutoML bool // Whether the solution uses automatic training to create new solution versions // (trained models). The default is True and the solution automatically creates // new solution versions every 7 days. You can change the training frequency by // specifying a schedulingExpression in the AutoTrainingConfig as part of solution - // configuration. For more information about automatic training, see Configuring - // automatic training (https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html) - // . Automatic solution version creation starts one hour after the solution is + // configuration. For more information about automatic training, see [Configuring automatic training]. + // + // Automatic solution version creation starts one hour after the solution is // ACTIVE. If you manually create a solution version within the hour, the solution - // skips the first automatic training. After training starts, you can get the - // solution version's Amazon Resource Name (ARN) with the ListSolutionVersions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) - // API operation. To get its status, use the DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) - // . + // skips the first automatic training. + // + // After training starts, you can get the solution version's Amazon Resource Name + // (ARN) with the [ListSolutionVersions]API operation. To get its status, use the [DescribeSolutionVersion]. + // + // [DescribeSolutionVersion]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html + // [ListSolutionVersions]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html + // [Configuring automatic training]: https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html PerformAutoTraining *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 Amazon Resource Name (ARN) of the recipe to use for model training. This is // required when performAutoML is false. For information about different Amazon - // Personalize recipes and their ARNs, see Choosing a recipe (https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html) - // . + // Personalize recipes and their ARNs, see [Choosing a recipe]. + // + // [Choosing a recipe]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html RecipeArn *string // The configuration to use with the solution. When performAutoML is set to true, // Amazon Personalize only evaluates the autoMLConfig section of the solution - // configuration. Amazon Personalize doesn't support configuring the hpoObjective - // at this time. + // configuration. + // + // Amazon Personalize doesn't support configuring the hpoObjective at this time. SolutionConfig *types.SolutionConfig - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the solution. + // A list of [tags] to apply to the solution. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/personalize/api_op_CreateSolutionVersion.go b/service/personalize/api_op_CreateSolutionVersion.go index b9abd32ba5f..5506bdc53fd 100644 --- a/service/personalize/api_op_CreateSolutionVersion.go +++ b/service/personalize/api_op_CreateSolutionVersion.go @@ -12,27 +12,52 @@ 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 . -// 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: +// created using the [CreateSolution]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 // -// 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) +// To get the status of the version, call [DescribeSolutionVersion]. 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] +// +// [DescribeSolutionVersion] +// +// [ListSolutions] +// +// [CreateSolution] +// +// [DescribeSolution] +// +// [DeleteSolution] +// +// [DescribeSolutionVersion]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html +// [DeleteSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html +// [ListSolutionVersions]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html +// [ListSolutions]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html +// [DescribeSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html func (c *Client) CreateSolutionVersion(ctx context.Context, params *CreateSolutionVersionInput, optFns ...func(*Options)) (*CreateSolutionVersionOutput, error) { if params == nil { params = &CreateSolutionVersionInput{} @@ -59,25 +84,29 @@ type CreateSolutionVersionInput struct { // The name of the solution version. Name *string - // A list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // to apply to the solution version. + // A list of [tags] to apply to the solution version. + // + // [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html Tags []types.Tag // The scope of training to be performed when creating the solution version. The // default is FULL . This creates a completely new model based on the entirety of - // the training data from the datasets in your dataset group. If you use - // User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) - // , you can specify a training mode of UPDATE . This updates the model to consider - // new items for recommendations. It is not a full retraining. You should still - // complete a full retraining weekly. If you specify UPDATE , Amazon Personalize - // will stop automatic updates for the solution version. To resume updates, create - // a new solution with training mode set to FULL and deploy it in a campaign. For - // more information about automatic updates, see Automatic updates (https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates) - // . The UPDATE option can only be used when you already have an active solution + // the training data from the datasets in your dataset group. + // + // If you use [User-Personalization], you can specify a training mode of UPDATE . This updates the model + // to consider new items for recommendations. It is not a full retraining. You + // should still complete a full retraining weekly. If you specify UPDATE , Amazon + // Personalize will stop automatic updates for the solution version. To resume + // updates, create a new solution with training mode set to FULL and deploy it in + // a campaign. For more information about automatic updates, see [Automatic updates]. + // + // 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 legacy HRNN-Coldstart (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) - // recipe. + // solution was trained with the [User-Personalization]recipe or the legacy [HRNN-Coldstart] recipe. + // + // [User-Personalization]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html + // [HRNN-Coldstart]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html + // [Automatic updates]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates TrainingMode types.TrainingMode noSmithyDocumentSerde diff --git a/service/personalize/api_op_DeleteCampaign.go b/service/personalize/api_op_DeleteCampaign.go index 1592c95d578..ab2f7ab3540 100644 --- a/service/personalize/api_op_DeleteCampaign.go +++ b/service/personalize/api_op_DeleteCampaign.go @@ -12,9 +12,11 @@ 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]request. For information on creating +// campaigns, see [CreateCampaign]. +// +// [CreateCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.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 d5eb7628e4d..c6b8462cc9d 100644 --- a/service/personalize/api_op_DeleteDataset.go +++ b/service/personalize/api_op_DeleteDataset.go @@ -12,8 +12,9 @@ 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]. +// +// [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 5496daca345..905d5ad66b8 100644 --- a/service/personalize/api_op_DeleteDatasetGroup.go +++ b/service/personalize/api_op_DeleteDatasetGroup.go @@ -12,8 +12,11 @@ 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. func (c *Client) DeleteDatasetGroup(ctx context.Context, params *DeleteDatasetGroupInput, optFns ...func(*Options)) (*DeleteDatasetGroupOutput, error) { if params == nil { diff --git a/service/personalize/api_op_DeleteEventTracker.go b/service/personalize/api_op_DeleteEventTracker.go index 840a4dbbed0..a23f4a8c893 100644 --- a/service/personalize/api_op_DeleteEventTracker.go +++ b/service/personalize/api_op_DeleteEventTracker.go @@ -11,8 +11,9 @@ import ( ) // Deletes the event tracker. Does not delete the dataset from the dataset group. -// For more information on event trackers, see CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) -// . +// For more information on event trackers, see [CreateEventTracker]. +// +// [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 d3ad7f5155e..2bffe91aa78 100644 --- a/service/personalize/api_op_DeleteRecommender.go +++ b/service/personalize/api_op_DeleteRecommender.go @@ -11,8 +11,9 @@ 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) -// request. +// specified in a [GetRecommendations]request. +// +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html func (c *Client) DeleteRecommender(ctx context.Context, params *DeleteRecommenderInput, optFns ...func(*Options)) (*DeleteRecommenderOutput, error) { if params == nil { params = &DeleteRecommenderInput{} diff --git a/service/personalize/api_op_DeleteSchema.go b/service/personalize/api_op_DeleteSchema.go index 9611d4696b7..ab540f335a6 100644 --- a/service/personalize/api_op_DeleteSchema.go +++ b/service/personalize/api_op_DeleteSchema.go @@ -11,8 +11,9 @@ 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]. +// +// [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 1ff9ebf6f50..5f70b6737a1 100644 --- a/service/personalize/api_op_DeleteSolution.go +++ b/service/personalize/api_op_DeleteSolution.go @@ -12,11 +12,13 @@ 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 -// 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) -// . +// determine what campaigns are using the solution, call [ListCampaigns]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]. +// +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html +// [ListCampaigns]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.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 2888f8d22ff..9732d68e61b 100644 --- a/service/personalize/api_op_DescribeCampaign.go +++ b/service/personalize/api_op_DescribeCampaign.go @@ -11,14 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the given campaign, including its status. A campaign can be in one of -// the following states: +// 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 // // 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) -// . +// which describes why. +// +// For more information on campaigns, see [CreateCampaign]. +// +// [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_DescribeDataDeletionJob.go b/service/personalize/api_op_DescribeDataDeletionJob.go index 7d7af9375f8..9981fb5de6e 100644 --- a/service/personalize/api_op_DescribeDataDeletionJob.go +++ b/service/personalize/api_op_DescribeDataDeletionJob.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the data deletion job created by CreateDataDeletionJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html) -// , including the job status. +// Describes the data deletion job created by [CreateDataDeletionJob], including the job status. +// +// [CreateDataDeletionJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html func (c *Client) DescribeDataDeletionJob(ctx context.Context, params *DescribeDataDeletionJobInput, optFns ...func(*Options)) (*DescribeDataDeletionJobOutput, error) { if params == nil { params = &DescribeDataDeletionJobInput{} @@ -40,11 +41,16 @@ type DescribeDataDeletionJobInput struct { type DescribeDataDeletionJobOutput struct { - // Information about the data deletion job, including the status. The status is - // one of the following values: + // Information about the data deletion job, including the status. + // + // The status is one of the following values: + // // - PENDING + // // - IN_PROGRESS + // // - COMPLETED + // // - FAILED DataDeletionJob *types.DataDeletionJob diff --git a/service/personalize/api_op_DescribeDataset.go b/service/personalize/api_op_DescribeDataset.go index 503f54458c7..7361a8569ff 100644 --- a/service/personalize/api_op_DescribeDataset.go +++ b/service/personalize/api_op_DescribeDataset.go @@ -11,8 +11,9 @@ 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]. +// +// [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 7409605f23f..43848070d2a 100644 --- a/service/personalize/api_op_DescribeDatasetExportJob.go +++ b/service/personalize/api_op_DescribeDatasetExportJob.go @@ -11,8 +11,9 @@ 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], including the export job status. +// +// [CreateDatasetExportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html func (c *Client) DescribeDatasetExportJob(ctx context.Context, params *DescribeDatasetExportJobInput, optFns ...func(*Options)) (*DescribeDatasetExportJobOutput, error) { if params == nil { params = &DescribeDatasetExportJobInput{} @@ -40,11 +41,16 @@ type DescribeDatasetExportJobInput struct { type DescribeDatasetExportJobOutput struct { - // Information about the dataset export job, including the status. The status is - // one of the following values: + // 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 DatasetExportJob *types.DatasetExportJob diff --git a/service/personalize/api_op_DescribeDatasetGroup.go b/service/personalize/api_op_DescribeDatasetGroup.go index 06fe98f81fd..242daa1a67b 100644 --- a/service/personalize/api_op_DescribeDatasetGroup.go +++ b/service/personalize/api_op_DescribeDatasetGroup.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the given dataset group. For more information on dataset groups, see -// CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) -// . +// Describes the given dataset group. For more information on dataset groups, see [CreateDatasetGroup]. +// +// [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 c61bd4a95c7..a98a4b27737 100644 --- a/service/personalize/api_op_DescribeDatasetImportJob.go +++ b/service/personalize/api_op_DescribeDatasetImportJob.go @@ -11,8 +11,9 @@ 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], including the import job status. +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html func (c *Client) DescribeDatasetImportJob(ctx context.Context, params *DescribeDatasetImportJobInput, optFns ...func(*Options)) (*DescribeDatasetImportJobOutput, error) { if params == nil { params = &DescribeDatasetImportJobInput{} @@ -40,11 +41,16 @@ type DescribeDatasetImportJobInput struct { type DescribeDatasetImportJobOutput struct { - // Information about the dataset import job, including the status. The status is - // one of the following values: + // 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 DatasetImportJob *types.DatasetImportJob diff --git a/service/personalize/api_op_DescribeEventTracker.go b/service/personalize/api_op_DescribeEventTracker.go index 640611f52c6..82e9be5fc85 100644 --- a/service/personalize/api_op_DescribeEventTracker.go +++ b/service/personalize/api_op_DescribeEventTracker.go @@ -12,9 +12,9 @@ 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) -// . +// the event tracker. For more information on event trackers, see [CreateEventTracker]. +// +// [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 7be3aa55cc4..891638d3640 100644 --- a/service/personalize/api_op_DescribeRecipe.go +++ b/service/personalize/api_op_DescribeRecipe.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a recipe. A recipe contains three items: +// 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. // // 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. +// when you create a solution with the [CreateSolution]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]API. +// +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html func (c *Client) DescribeRecipe(ctx context.Context, params *DescribeRecipeInput, optFns ...func(*Options)) (*DescribeRecipeOutput, error) { if params == nil { params = &DescribeRecipeInput{} diff --git a/service/personalize/api_op_DescribeRecommender.go b/service/personalize/api_op_DescribeRecommender.go index 99af5bb5d79..69b7f7535b6 100644 --- a/service/personalize/api_op_DescribeRecommender.go +++ b/service/personalize/api_op_DescribeRecommender.go @@ -11,17 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the given recommender, including its status. A recommender can be in -// one of the following states: +// 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 // // 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) -// . +// which describes why. +// +// The modelMetrics key is null when the recommender is being created or deleted. +// +// For more information on recommenders, see [CreateRecommender]. +// +// [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 01e7dd38a8d..67d2d197e14 100644 --- a/service/personalize/api_op_DescribeSchema.go +++ b/service/personalize/api_op_DescribeSchema.go @@ -11,8 +11,9 @@ 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]. +// +// [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 c51eb74d14f..3e6a34cdd17 100644 --- a/service/personalize/api_op_DescribeSolution.go +++ b/service/personalize/api_op_DescribeSolution.go @@ -11,8 +11,9 @@ 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]. +// +// [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 eb102eeb536..3aafcdc7eac 100644 --- a/service/personalize/api_op_DescribeSolutionVersion.go +++ b/service/personalize/api_op_DescribeSolutionVersion.go @@ -12,7 +12,9 @@ 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] +// +// [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 0eeb4f83c93..8b2f84d7541 100644 --- a/service/personalize/api_op_GetSolutionMetrics.go +++ b/service/personalize/api_op_GetSolutionMetrics.go @@ -38,9 +38,9 @@ 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) - // . + // The metrics for the solution version. For more information, see [Evaluating a solution version with metrics]. + // + // [Evaluating a 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_ListCampaigns.go b/service/personalize/api_op_ListCampaigns.go index f4efc54b63e..684c2d77c26 100644 --- a/service/personalize/api_op_ListCampaigns.go +++ b/service/personalize/api_op_ListCampaigns.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} @@ -36,8 +37,10 @@ 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] for getting the next set of + // campaigns (if they exist). + // + // [ListCampaigns]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html NextToken *string // The Amazon Resource Name (ARN) of the solution to list the campaigns for. When diff --git a/service/personalize/api_op_ListDataDeletionJobs.go b/service/personalize/api_op_ListDataDeletionJobs.go index 1ac762eccd7..5acafa093c9 100644 --- a/service/personalize/api_op_ListDataDeletionJobs.go +++ b/service/personalize/api_op_ListDataDeletionJobs.go @@ -15,8 +15,9 @@ import ( // time, with the most recent first. When a dataset group is not specified, all the // data deletion jobs associated with the account are listed. The response provides // the properties for each job, including the Amazon Resource Name (ARN). For more -// information on data deletion jobs, see Deleting users (https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html) -// . +// information on data deletion jobs, see [Deleting users]. +// +// [Deleting users]: https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html func (c *Client) ListDataDeletionJobs(ctx context.Context, params *ListDataDeletionJobsInput, optFns ...func(*Options)) (*ListDataDeletionJobsOutput, error) { if params == nil { params = &ListDataDeletionJobsInput{} diff --git a/service/personalize/api_op_ListDatasetExportJobs.go b/service/personalize/api_op_ListDatasetExportJobs.go index 7e6a1252981..c51397610ee 100644 --- a/service/personalize/api_op_ListDatasetExportJobs.go +++ b/service/personalize/api_op_ListDatasetExportJobs.go @@ -15,9 +15,10 @@ import ( // 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) -// . +// export jobs, see [CreateDatasetExportJob]. For more information on datasets, see [CreateDataset]. +// +// [CreateDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html +// [CreateDatasetExportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html func (c *Client) ListDatasetExportJobs(ctx context.Context, params *ListDatasetExportJobsInput, optFns ...func(*Options)) (*ListDatasetExportJobsOutput, error) { if params == nil { params = &ListDatasetExportJobsInput{} diff --git a/service/personalize/api_op_ListDatasetGroups.go b/service/personalize/api_op_ListDatasetGroups.go index 66440013b5f..8016622d72f 100644 --- a/service/personalize/api_op_ListDatasetGroups.go +++ b/service/personalize/api_op_ListDatasetGroups.go @@ -13,8 +13,9 @@ 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]. +// +// [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 f633a39394e..e4b9afc31a2 100644 --- a/service/personalize/api_op_ListDatasetImportJobs.go +++ b/service/personalize/api_op_ListDatasetImportJobs.go @@ -15,9 +15,10 @@ import ( // 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) -// . +// import jobs, see [CreateDatasetImportJob]. For more information on datasets, see [CreateDataset]. +// +// [CreateDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetImportJobsInput, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error) { if params == nil { params = &ListDatasetImportJobsInput{} diff --git a/service/personalize/api_op_ListDatasets.go b/service/personalize/api_op_ListDatasets.go index f46e6513b52..0a8bae4507a 100644 --- a/service/personalize/api_op_ListDatasets.go +++ b/service/personalize/api_op_ListDatasets.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} diff --git a/service/personalize/api_op_ListEventTrackers.go b/service/personalize/api_op_ListEventTrackers.go index 07d60037a1c..83a85357be6 100644 --- a/service/personalize/api_op_ListEventTrackers.go +++ b/service/personalize/api_op_ListEventTrackers.go @@ -13,9 +13,9 @@ 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) -// . +// Name (ARN) and tracking ID. For more information on event trackers, see [CreateEventTracker]. +// +// [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 d0cf7a75f43..902a284708a 100644 --- a/service/personalize/api_op_ListRecipes.go +++ b/service/personalize/api_op_ListRecipes.go @@ -30,7 +30,7 @@ func (c *Client) ListRecipes(ctx context.Context, params *ListRecipesInput, optF type ListRecipesInput struct { - // Filters returned recipes by domain for a Domain dataset group. Only recipes + // Filters returned recipes by domain for a Domain dataset group. Only recipes // (Domain dataset group use cases) for this domain are included in the response. // If you don't specify a domain, all recipes are returned. Domain types.Domain diff --git a/service/personalize/api_op_ListRecommenders.go b/service/personalize/api_op_ListRecommenders.go index 50654454a40..491b9f01ad6 100644 --- a/service/personalize/api_op_ListRecommenders.go +++ b/service/personalize/api_op_ListRecommenders.go @@ -14,9 +14,9 @@ import ( // Returns a list of recommenders in a given Domain dataset group. When a Domain // 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) -// . +// the Amazon Resource Name (ARN). For more information on recommenders, see [CreateRecommender]. +// +// [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{} diff --git a/service/personalize/api_op_ListSchemas.go b/service/personalize/api_op_ListSchemas.go index bdd6bf705d4..9ac66c4188c 100644 --- a/service/personalize/api_op_ListSchemas.go +++ b/service/personalize/api_op_ListSchemas.go @@ -13,8 +13,9 @@ 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]. +// +// [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 3c69317ce2d..8ff4e9956e1 100644 --- a/service/personalize/api_op_ListSolutions.go +++ b/service/personalize/api_op_ListSolutions.go @@ -14,8 +14,9 @@ import ( // Returns a list of solutions in a given dataset group. When a dataset 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) -// . +// Resource Name (ARN). For more information on solutions, see [CreateSolution]. +// +// [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 13866355b5d..6b4aefad9c1 100644 --- a/service/personalize/api_op_ListTagsForResource.go +++ b/service/personalize/api_op_ListTagsForResource.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get a list of tags (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) -// attached to a resource. +// Get a list of [tags] attached to a resource. +// +// [tags]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/personalize/api_op_StopSolutionVersionCreation.go b/service/personalize/api_op_StopSolutionVersionCreation.go index 868d5b316e6..4361d157339 100644 --- a/service/personalize/api_op_StopSolutionVersionCreation.go +++ b/service/personalize/api_op_StopSolutionVersionCreation.go @@ -11,9 +11,15 @@ import ( ) // 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. +// +// 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 // // You are billed for all of the training completed up until you stop the solution diff --git a/service/personalize/api_op_TagResource.go b/service/personalize/api_op_TagResource.go index 618e2c9f65a..ce9792a8ec0 100644 --- a/service/personalize/api_op_TagResource.go +++ b/service/personalize/api_op_TagResource.go @@ -34,9 +34,9 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // Tags to apply to the resource. For more information see Tagging Amazon - // Personalize resources (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) - // . + // Tags to apply to the resource. For more information see [Tagging Amazon Personalize resources]. + // + // [Tagging Amazon Personalize resources]: https://docs.aws.amazon.com/personalize/latest/dg/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 535b491dbd8..4adccd0571d 100644 --- a/service/personalize/api_op_UntagResource.go +++ b/service/personalize/api_op_UntagResource.go @@ -11,8 +11,9 @@ import ( ) // Removes the specified tags that are attached to a resource. For more -// information, see Removing tags from Amazon Personalize resources (https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html) -// . +// information, see [Removing tags from Amazon Personalize resources]. +// +// [Removing tags from Amazon Personalize resources]: https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html 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 56ffc067f86..07944efa6e4 100644 --- a/service/personalize/api_op_UpdateCampaign.go +++ b/service/personalize/api_op_UpdateCampaign.go @@ -11,24 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a campaign to deploy a retrained solution version with an existing +// Updates a campaign to deploy a retrained solution version with an existing +// // campaign, change your campaign's minProvisionedTPS , or modify your campaign's // configuration. For example, you can set enableMetadataWithRecommendations to -// true for an existing campaign. To update a campaign to start automatically using -// the latest solution version, specify the following: +// true for an existing campaign. +// +// To update a campaign to start automatically using the latest solution version, +// specify the following: +// // - For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) // of your solution in SolutionArn/$LATEST format. +// // - In the campaignConfig , set syncWithLatestSolutionVersion to true . // // 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) -// 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 +// Check the campaign status using the [DescribeCampaign]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 about updating a campaign, including -// code samples, see Updating a campaign (https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html) -// . For more information about campaigns, see Creating a campaign (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html) -// . +// status is Active . +// +// For more information about updating a campaign, including code samples, see [Updating a campaign]. +// For more information about campaigns, see [Creating a campaign]. +// +// [Creating a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html +// [Updating a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html +// [DescribeCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput, optFns ...func(*Options)) (*UpdateCampaignOutput, error) { if params == nil { params = &UpdateCampaignInput{} @@ -64,11 +74,15 @@ type UpdateCampaignInput struct { // The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest // solution version of your solution, specify the ARN of your solution in // SolutionArn/$LATEST format. You must use this format if you set - // syncWithLatestSolutionVersion to True in the CampaignConfig (https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) - // . To deploy a model that isn't the latest solution version of your solution, - // specify the ARN of the solution version. For more information about automatic - // campaign updates, see Enabling automatic campaign updates (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update) - // . + // syncWithLatestSolutionVersion to True in the [CampaignConfig]. + // + // To deploy a model that isn't the latest solution version of your solution, + // specify the ARN of the solution version. + // + // For more information about automatic campaign updates, see [Enabling automatic campaign updates]. + // + // [Enabling automatic campaign updates]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update + // [CampaignConfig]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html SolutionVersionArn *string noSmithyDocumentSerde diff --git a/service/personalize/api_op_UpdateDataset.go b/service/personalize/api_op_UpdateDataset.go index 6bed553630b..a5e9b3ad32a 100644 --- a/service/personalize/api_op_UpdateDataset.go +++ b/service/personalize/api_op_UpdateDataset.go @@ -11,8 +11,9 @@ import ( ) // Update a dataset to replace its schema with a new or existing one. For more -// information, see Replacing a dataset's schema (https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html) -// . +// information, see [Replacing a dataset's schema]. +// +// [Replacing a dataset's schema]: https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html func (c *Client) UpdateDataset(ctx context.Context, params *UpdateDatasetInput, optFns ...func(*Options)) (*UpdateDatasetOutput, error) { if params == nil { params = &UpdateDatasetInput{} diff --git a/service/personalize/api_op_UpdateRecommender.go b/service/personalize/api_op_UpdateRecommender.go index ae064bb8408..a9f63d63f52 100644 --- a/service/personalize/api_op_UpdateRecommender.go +++ b/service/personalize/api_op_UpdateRecommender.go @@ -17,8 +17,9 @@ import ( // While the update completes, you can still get recommendations from the // recommender. The recommender uses the previous configuration until the update // completes. To track the status of this update, use the latestRecommenderUpdate -// returned in the DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) -// operation. +// returned in the [DescribeRecommender]operation. +// +// [DescribeRecommender]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html func (c *Client) UpdateRecommender(ctx context.Context, params *UpdateRecommenderInput, optFns ...func(*Options)) (*UpdateRecommenderOutput, error) { if params == nil { params = &UpdateRecommenderInput{} diff --git a/service/personalize/options.go b/service/personalize/options.go index 7ae259d20af..dca85afa390 100644 --- a/service/personalize/options.go +++ b/service/personalize/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/personalize/types/enums.go b/service/personalize/types/enums.go index 1f1ab0620c0..afca4ee2a14 100644 --- a/service/personalize/types/enums.go +++ b/service/personalize/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BatchInferenceJobMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchInferenceJobMode) Values() []BatchInferenceJobMode { return []BatchInferenceJobMode{ "BATCH_INFERENCE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for Domain. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Domain) Values() []Domain { return []Domain{ "ECOMMERCE", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for ImportMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportMode) Values() []ImportMode { return []ImportMode{ "FULL", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for IngestionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionMode) Values() []IngestionMode { return []IngestionMode{ "BULK", @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for ObjectiveSensitivity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectiveSensitivity) Values() []ObjectiveSensitivity { return []ObjectiveSensitivity{ "LOW", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for RecipeProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecipeProvider) Values() []RecipeProvider { return []RecipeProvider{ "SERVICE", @@ -124,8 +130,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for TrainingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingType) Values() []TrainingType { return []TrainingType{ "AUTOMATIC", diff --git a/service/personalize/types/types.go b/service/personalize/types/types.go index 3f8f1075bcf..5d784696b39 100644 --- a/service/personalize/types/types.go +++ b/service/personalize/types/types.go @@ -60,10 +60,11 @@ 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]), Amazon +// Personalize determines which recipe, from the specified list, optimizes the +// given metric. Amazon Personalize then uses that recipe for the solution. +// +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html type AutoMLConfig struct { // The metric to optimize. @@ -75,8 +76,10 @@ 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]), specifies the +// recipe that best optimized the specified metric. +// +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html type AutoMLResult struct { // The Amazon Resource Name (ARN) of the best recipe. @@ -92,9 +95,11 @@ type AutoTrainingConfig struct { // rate expression in rate(value unit) format. For value, specify a number between // 1 and 30. For unit, specify day or days . For example, to automatically create a // new solution version every 5 days, specify rate(5 days) . The default is every 7 - // days. For more information about auto training, see Creating and configuring a - // solution (https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html) - // . + // days. + // + // For more information about auto training, see [Creating and configuring a solution]. + // + // [Creating and configuring a solution]: https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html SchedulingExpression *string noSmithyDocumentSerde @@ -149,9 +154,13 @@ type BatchInferenceJob struct { // The status of the batch inference job. The status is one of the following // values: + // // - PENDING + // // - IN PROGRESS + // // - ACTIVE + // // - CREATE FAILED Status *string @@ -167,8 +176,9 @@ 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) - // . + // when recommending items. See [User-Personalization]. + // + // [User-Personalization]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html ItemExplorationConfig map[string]string noSmithyDocumentSerde @@ -198,9 +208,11 @@ 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) -// operation returns a list of batch inference job summaries. +// A truncated version of the [BatchInferenceJob]. The [ListBatchInferenceJobs] operation returns a list of batch inference +// job summaries. +// +// [BatchInferenceJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html +// [ListBatchInferenceJobs]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html type BatchInferenceJobSummary struct { // The Amazon Resource Name (ARN) of the batch inference job. @@ -226,9 +238,13 @@ type BatchInferenceJobSummary struct { // The status of the batch inference job. The status is one of the following // values: + // // - PENDING + // // - IN PROGRESS + // // - ACTIVE + // // - CREATE FAILED Status *string @@ -277,9 +293,13 @@ type BatchSegmentJob struct { SolutionVersionArn *string // The status of the batch segment job. The status is one of the following values: + // // - PENDING + // // - IN PROGRESS + // // - ACTIVE + // // - CREATE FAILED Status *string @@ -308,9 +328,11 @@ 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) -// operation returns a list of batch segment job summaries. +// A truncated version of the [BatchSegmentJob] datatype. [ListBatchSegmentJobs] operation returns a list of batch +// segment job summaries. +// +// [ListBatchSegmentJobs]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html +// [BatchSegmentJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html type BatchSegmentJobSummary struct { // The Amazon Resource Name (ARN) of the batch segment job. @@ -333,9 +355,13 @@ type BatchSegmentJobSummary struct { SolutionVersionArn *string // The status of the batch segment job. The status is one of the following values: + // // - PENDING + // // - IN PROGRESS + // // - ACTIVE + // // - CREATE FAILED Status *string @@ -343,8 +369,9 @@ type BatchSegmentJobSummary struct { } // 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]. +// +// [CreateCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html type Campaign struct { // The Amazon Resource Name (ARN) of the campaign. @@ -363,8 +390,9 @@ 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) - // API. + // listing, call the [DescribeCampaign]API. + // + // [DescribeCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html LatestCampaignUpdate *CampaignUpdateSummary // Specifies the requested minimum provisioned transactions (recommendations) per @@ -379,8 +407,12 @@ type Campaign struct { // The Amazon Resource Name (ARN) of the solution version the campaign uses. SolutionVersionArn *string - // The status of the campaign. A campaign can be in one of the following states: + // 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 Status *string @@ -394,35 +426,41 @@ type CampaignConfig struct { // you can specify the columns from your Items dataset in your request for // recommendations. Amazon Personalize returns this data for each item in the // recommendation response. For information about enabling metadata for a campaign, - // see Enabling metadata in recommendations for a campaign (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata) - // . If you enable metadata in recommendations, you will incur additional costs. - // For more information, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/) - // . + // see [Enabling metadata in recommendations for a campaign]. + // + // If you enable metadata in recommendations, you will incur additional costs. For + // more information, see [Amazon Personalize pricing]. + // + // [Enabling metadata in recommendations for a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata + // [Amazon Personalize pricing]: https://aws.amazon.com/personalize/pricing/ EnableMetadataWithRecommendations *bool // 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. - // 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) - // recipe. + // Provide itemExplorationConfig data only if your solution uses the [User-Personalization] recipe. + // + // [User-Personalization]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html ItemExplorationConfig map[string]string // Whether the campaign automatically updates to use the latest solution version // (trained model) of a solution. If you specify True , you must specify the ARN of // your solution for the SolutionVersionArn parameter. It must be in // SolutionArn/$LATEST format. The default is False and you must manually update - // the campaign to deploy the latest solution version. For more information about - // automatic campaign updates, see Enabling automatic campaign updates (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update) - // . + // the campaign to deploy the latest solution version. + // + // For more information about automatic campaign updates, see [Enabling automatic campaign updates]. + // + // [Enabling automatic campaign updates]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update SyncWithLatestSolutionVersion *bool 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) -// API. +// call the [DescribeCampaign]API. +// +// [DescribeCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html type CampaignSummary struct { // The Amazon Resource Name (ARN) of the campaign. @@ -440,8 +478,12 @@ type CampaignSummary struct { // The name of the campaign. Name *string - // The status of the campaign. A campaign can be in one of the following states: + // 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 Status *string @@ -449,8 +491,9 @@ type CampaignSummary struct { } // 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) -// API. +// listing, call the [DescribeCampaign]API. +// +// [DescribeCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html type CampaignUpdateSummary struct { // The configuration details of a campaign. @@ -472,9 +515,12 @@ type CampaignUpdateSummary struct { // The Amazon Resource Name (ARN) of the deployed solution version. SolutionVersionArn *string - // The status of the campaign update. A campaign update can be in one of the - // following states: + // 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 Status *string @@ -510,8 +556,9 @@ type ContinuousHyperParameterRange struct { // Describes a job that deletes all references to specific users from an Amazon // Personalize dataset group in batches. For information about creating a data -// deletion job, see Deleting users (https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html) -// . +// deletion job, see [Deleting users]. +// +// [Deleting users]: https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html type DataDeletionJob struct { // The creation date and time (in Unix time) of the data deletion job. @@ -544,8 +591,10 @@ type DataDeletionJob struct { // from the Amazon S3 data source. RoleArn *string - // The status of the data deletion job. A data deletion job can have one of the - // following statuses: + // The status of the data deletion job. + // + // A data deletion job can have one of the following statuses: + // // - PENDING > IN_PROGRESS > COMPLETED -or- FAILED Status *string @@ -553,8 +602,9 @@ type DataDeletionJob struct { } // Provides a summary of the properties of a data deletion job. For a complete -// listing, call the DescribeDataDeletionJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) -// API operation. +// listing, call the [DescribeDataDeletionJob]API operation. +// +// [DescribeDataDeletionJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html type DataDeletionJobSummary struct { // The creation date and time (in Unix time) of the data deletion job. @@ -576,8 +626,10 @@ type DataDeletionJobSummary struct { // The date and time (in Unix time) the data deletion job was last updated. LastUpdatedDateTime *time.Time - // The status of the data deletion job. A data deletion job can have one of the - // following statuses: + // The status of the data deletion job. + // + // A data deletion job can have one of the following statuses: + // // - PENDING > IN_PROGRESS > COMPLETED -or- FAILED Status *string @@ -597,10 +649,15 @@ type Dataset struct { DatasetGroupArn *string // One of the following values: + // // - Interactions + // // - Items + // // - Users + // // - Actions + // // - Action_Interactions DatasetType *string @@ -616,8 +673,12 @@ type Dataset struct { // The ARN of the associated schema. SchemaArn *string - // The status of the dataset. A dataset can be in one of the following states: + // 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 Status *string @@ -631,9 +692,13 @@ type Dataset struct { } // 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: +// information, see [CreateDatasetExportJob]. +// +// A dataset export job can be in one of the following states: +// // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// +// [CreateDatasetExportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html type DatasetExportJob struct { // The creation date and time (in Unix time) of the dataset export job. @@ -658,7 +723,8 @@ type DatasetExportJob struct { JobName *string // The path to the Amazon S3 bucket where the job's output is stored. For example: - // s3://bucket-name/folder-name/ + // + // s3://bucket-name/folder-name/ JobOutput *DatasetExportJobOutput // The date and time (in Unix time) the status of the dataset export job was last @@ -669,8 +735,10 @@ type DatasetExportJob struct { // add data to your output Amazon S3 bucket. RoleArn *string - // The status of the dataset export job. A dataset export job can be in one of the - // following states: + // 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 Status *string @@ -689,8 +757,9 @@ 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) -// API. +// listing, call the [DescribeDatasetExportJob]API. +// +// [DescribeDatasetExportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html type DatasetExportJobSummary struct { // The date and time (in Unix time) that the dataset export job was created. @@ -709,8 +778,10 @@ type DatasetExportJobSummary struct { // updated. LastUpdatedDateTime *time.Time - // The status of the dataset export job. A dataset export job can be in one of the - // following states: + // 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 Status *string @@ -718,14 +789,17 @@ type DatasetExportJobSummary struct { } // A dataset group is a collection of related datasets (Item interactions, Users, -// Items, Actions, Action interactions). 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. +// Items, Actions, Action interactions). You create a dataset group by calling [CreateDatasetGroup]. +// You then create a dataset and add it to a dataset group by calling [CreateDataset]. The +// dataset group is used to create and train a solution by calling [CreateSolution]. 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. +// +// [CreateDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html +// [CreateDatasetGroup]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html type DatasetGroup struct { // The creation date and time (in Unix time) of the dataset group. @@ -755,9 +829,12 @@ type DatasetGroup struct { // valid when also specifying a KMS key. RoleArn *string - // The current status of the dataset group. A dataset group can be in one of the - // following states: + // 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 Status *string @@ -765,8 +842,9 @@ type DatasetGroup struct { } // 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. +// listing, call the [DescribeDatasetGroup]API. +// +// [DescribeDatasetGroup]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html type DatasetGroupSummary struct { // The date and time (in Unix time) that the dataset group was created. @@ -787,9 +865,12 @@ type DatasetGroupSummary struct { // The name of the dataset group. Name *string - // The status of the dataset group. A dataset group can be in one of the following - // states: + // 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 Status *string @@ -797,10 +878,13 @@ type DatasetGroupSummary struct { } // 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: +// bucket) to an Amazon Personalize dataset. For more information, see [CreateDatasetImportJob]. +// +// A dataset import job can be in one of the following states: +// // - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// +// [CreateDatasetImportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html type DatasetImportJob struct { // The creation date and time (in Unix time) of the dataset import job. @@ -834,8 +918,10 @@ type DatasetImportJob struct { // source. RoleArn *string - // The status of the dataset import job. A dataset import job can be in one of the - // following states: + // 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 Status *string @@ -843,8 +929,9 @@ type DatasetImportJob struct { } // 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) -// API. +// listing, call the [DescribeDatasetImportJob]API. +// +// [DescribeDatasetImportJob]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html type DatasetImportJobSummary struct { // The date and time (in Unix time) that the dataset import job was created. @@ -857,8 +944,9 @@ 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]. + // + // [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. @@ -868,17 +956,19 @@ type DatasetImportJobSummary struct { // updated. LastUpdatedDateTime *time.Time - // The status of the dataset import job. A dataset import job can be in one of the - // following states: + // 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 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) -// . +// Describes the schema for a dataset. For more information on schemas, see [CreateSchema]. +// +// [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. @@ -903,8 +993,9 @@ 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]API. +// +// [DescribeSchema]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html type DatasetSchemaSummary struct { // The date and time (in Unix time) that the schema was created. @@ -926,8 +1017,9 @@ 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) -// API. +// the [DescribeDataset]API. +// +// [DescribeDataset]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html type DatasetSummary struct { // The date and time (in Unix time) that the dataset was created. @@ -937,9 +1029,13 @@ type DatasetSummary struct { DatasetArn *string // The dataset type. One of the following values: + // // - Interactions + // // - Items + // // - Users + // // - Event-Interactions DatasetType *string @@ -949,8 +1045,12 @@ type DatasetSummary struct { // The name of the dataset. Name *string - // The status of the dataset. A dataset can be in one of the following states: + // 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 Status *string @@ -985,13 +1085,19 @@ type DataSource struct { // For dataset import jobs, the path to the Amazon S3 bucket where the data that // you want to upload to your dataset is stored. For data deletion jobs, the path - // to the Amazon S3 bucket that stores the list of records to delete. For example: - // s3://bucket-name/folder-name/fileName.csv If your CSV files are in a folder in - // your Amazon S3 bucket and you want your import job or data deletion job to - // consider multiple files, you can specify the path to the folder. With a data - // deletion job, Amazon Personalize uses all files in the folder and any sub - // folder. Use the following syntax with a / after the folder name: - // s3://bucket-name/folder-name/ + // to the Amazon S3 bucket that stores the list of records to delete. + // + // For example: + // + // s3://bucket-name/folder-name/fileName.csv + // + // If your CSV files are in a folder in your Amazon S3 bucket and you want your + // import job or data deletion job to consider multiple files, you can specify the + // path to the folder. With a data deletion job, Amazon Personalize uses all files + // in the folder and any sub folder. Use the following syntax with a / after the + // folder name: + // + // s3://bucket-name/folder-name/ DataLocation *string noSmithyDocumentSerde @@ -1092,22 +1198,27 @@ 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: + // 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] API. + // + // [PutEvents]: https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html 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) -// API. +// listing, call the [DescribeEventTracker]API. +// +// [DescribeEventTracker]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html type EventTrackerSummary struct { // The date and time (in Unix time) that the event tracker was created. @@ -1122,9 +1233,12 @@ 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: + // 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 @@ -1151,8 +1265,10 @@ 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: + // 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 @@ -1189,8 +1305,9 @@ type Filter struct { // 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) - // . + // information about filter expression structure and syntax, see [Filter expressions]. + // + // [Filter expressions]: https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html FilterExpression *string // The time at which the filter was last updated. @@ -1238,8 +1355,9 @@ type HPOConfig struct { // The hyperparameters and their allowable ranges. AlgorithmHyperParameterRanges *HyperParameterRanges - // The metric to optimize during HPO. Amazon Personalize doesn't support - // configuring the hpoObjective at this time. + // The metric to optimize during HPO. + // + // Amazon Personalize doesn't support configuring the hpoObjective at this time. HpoObjective *HPOObjective // Describes the resource configuration for HPO. @@ -1248,8 +1366,9 @@ type HPOConfig struct { noSmithyDocumentSerde } -// The metric to optimize during hyperparameter optimization (HPO). Amazon -// Personalize doesn't support configuring the hpoObjective at this time. +// The metric to optimize during hyperparameter optimization (HPO). +// +// Amazon Personalize doesn't support configuring the hpoObjective at this time. type HPOObjective struct { // The name of the metric. @@ -1310,8 +1429,9 @@ 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]. +// +// [Measuring impact of recommendations]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html type MetricAttribute struct { // The metric's event type. @@ -1338,8 +1458,9 @@ 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]. +// +// [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. @@ -1374,8 +1495,9 @@ 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]. + // + // [Measuring impact of recommendations]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html // // This member is required. RoleArn *string @@ -1387,8 +1509,9 @@ 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]. +// +// [DescribeMetricAttribution]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html type MetricAttributionSummary struct { // The metric attribution's creation date time. @@ -1413,9 +1536,9 @@ 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) -// . +// streaming minutes or increasing revenue. For more information see [Optimizing a solution]. +// +// [Optimizing a 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 @@ -1431,8 +1554,9 @@ 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) -// operation. +// Amazon Personalize uses in model training when you use the [CreateSolution]operation. +// +// [CreateSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html type Recipe struct { // The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to @@ -1458,8 +1582,11 @@ type Recipe struct { RecipeArn *string // One of the following values: + // // - PERSONALIZED_RANKING + // // - RELATED_ITEMS + // // - USER_PERSONALIZATION RecipeType *string @@ -1470,8 +1597,9 @@ 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]API. +// +// [DescribeRecipe]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html type RecipeSummary struct { // The date and time (in Unix time) that the recipe was created. @@ -1497,8 +1625,9 @@ 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) -// request. +// recipe), and specify the recommender in a [GetRecommendations]request. +// +// [GetRecommendations]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html type Recommender struct { // The date and time (in Unix format) that the recommender was created. @@ -1518,8 +1647,9 @@ 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]. + // + // [Evaluating a recommender]: https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html ModelMetrics map[string]float64 // The name of the recommender. @@ -1535,11 +1665,15 @@ type Recommender struct { // The configuration details of the recommender. RecommenderConfig *RecommenderConfig - // The status of the recommender. A recommender can be in one of the following - // states: + // 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 Status *string @@ -1553,10 +1687,13 @@ type RecommenderConfig struct { // enabled, you can specify the columns from your Items dataset in your request for // recommendations. Amazon Personalize returns this data for each item in the // recommendation response. For information about enabling metadata for a - // recommender, see Enabling metadata in recommendations for a recommender (https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata) - // . If you enable metadata in recommendations, you will incur additional costs. - // For more information, see Amazon Personalize pricing (https://aws.amazon.com/personalize/pricing/) - // . + // recommender, see [Enabling metadata in recommendations for a recommender]. + // + // If you enable metadata in recommendations, you will incur additional costs. For + // more information, see [Amazon Personalize pricing]. + // + // [Enabling metadata in recommendations for a recommender]: https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata + // [Amazon Personalize pricing]: https://aws.amazon.com/personalize/pricing/ EnableMetadataWithRecommendations *bool // Specifies the exploration configuration hyperparameters, including @@ -1574,7 +1711,7 @@ type RecommenderConfig struct { // necessary. MinRecommendationRequestsPerSecond *int32 - // Specifies the training data configuration to use when creating a domain + // Specifies the training data configuration to use when creating a domain // recommender. TrainingDataConfig *TrainingDataConfig @@ -1609,9 +1746,12 @@ 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 Status *string @@ -1619,8 +1759,9 @@ type RecommenderSummary struct { } // 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) -// API. +// listing, call the [DescribeRecommender]API. +// +// [DescribeRecommender]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html type RecommenderUpdateSummary struct { // The date and time (in Unix format) that the recommender update was created. @@ -1635,11 +1776,15 @@ type RecommenderUpdateSummary struct { // The configuration details of the recommender update. RecommenderConfig *RecommenderConfig - // The status of the recommender update. A recommender can be in one of the - // following states: + // 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 Status *string @@ -1665,14 +1810,17 @@ type S3DataConfig struct { // all new solutions use automatic training. With automatic training, you incur // training costs while your solution is active. You can't stop automatic training // for a solution. To avoid unnecessary costs, make sure to delete the solution -// when you are finished. For information about training costs, see Amazon -// Personalize pricing (https://aws.amazon.com/personalize/pricing/) . An object -// that provides information about a solution. A solution includes the custom -// recipe, customized parameters, and trained models (Solution Versions) that -// Amazon Personalize uses to generate recommendations. After you create a -// solution, you can’t change its configuration. If you need to make changes, you -// can clone the solution (https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html) -// with the Amazon Personalize console or create a new one. +// when you are finished. For information about training costs, see [Amazon Personalize pricing]. +// +// An object that provides information about a solution. A solution includes the +// custom recipe, customized parameters, and trained models (Solution Versions) +// that Amazon Personalize uses to generate recommendations. +// +// After you create a solution, you can’t change its configuration. If you need to +// make changes, you can [clone the solution]with the Amazon Personalize console or create a new one. +// +// [clone the solution]: https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html +// [Amazon Personalize pricing]: https://aws.amazon.com/personalize/pricing/ type Solution struct { // When performAutoML is true, specifies the best recipe found. @@ -1700,19 +1848,23 @@ type Solution struct { Name *string // We don't recommend enabling automated machine learning. Instead, match your use - // case to the available Amazon Personalize recipes. For more information, see - // Determining your use case. (https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) + // case to the available Amazon Personalize recipes. For more information, see [Determining your use case.] + // // 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), // Amazon Personalize uses recipeArn for training. + // + // [Determining your use case.]: https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html PerformAutoML bool // Specifies whether the solution automatically creates solution versions. The // default is True and the solution automatically creates new solution versions - // every 7 days. For more information about auto training, see Creating and - // configuring a solution (https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html) - // . + // every 7 days. + // + // For more information about auto training, see [Creating and configuring a solution]. + // + // [Creating and configuring a solution]: https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html PerformAutoTraining *bool // Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The @@ -1729,8 +1881,12 @@ type Solution struct { // Describes the configuration properties for the solution. SolutionConfig *SolutionConfig - // The status of the solution. A solution can be in one of the following states: + // 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 Status *string @@ -1743,8 +1899,9 @@ type SolutionConfig struct { // Lists the algorithm hyperparameters and their values. 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] object containing a list of recipes to search when AutoML is performed. + // + // [AutoMLConfig]: https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html AutoMLConfig *AutoMLConfig // Specifies the automatic training configuration to use. @@ -1761,12 +1918,12 @@ type SolutionConfig struct { HpoConfig *HPOConfig // 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) - // . + // streaming minutes or increasing revenue. For more information see [Optimizing a solution]. + // + // [Optimizing a solution]: https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html OptimizationObjective *OptimizationObjective - // Specifies the training data configuration to use when creating a custom + // Specifies the training data configuration to use when creating a custom // solution version (trained model). TrainingDataConfig *TrainingDataConfig @@ -1774,8 +1931,9 @@ type SolutionConfig struct { } // 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. +// call the [DescribeSolution]API. +// +// [DescribeSolution]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html type SolutionSummary struct { // The date and time (in Unix time) that the solution was created. @@ -1793,16 +1951,22 @@ type SolutionSummary struct { // The Amazon Resource Name (ARN) of the solution. SolutionArn *string - // The status of the solution. A solution can be in one of the following states: + // 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 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] in a Custom +// dataset group. +// +// [Solution]: https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html type SolutionVersion struct { // The date and time (in Unix time) that this version of the solution was created. @@ -1845,13 +2009,20 @@ type SolutionVersion struct { // The ARN of the solution version. SolutionVersionArn *string - // The status of the solution version. A solution version can be in one of the - // following states: + // 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 Status *string @@ -1877,8 +2048,9 @@ type SolutionVersion struct { } // 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) -// API. +// listing, call the [DescribeSolutionVersion]API. +// +// [DescribeSolutionVersion]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html type SolutionVersionSummary struct { // The date and time (in Unix time) that this version of a solution was created. @@ -1893,8 +2065,10 @@ type SolutionVersionSummary struct { // The Amazon Resource Name (ARN) of the solution version. SolutionVersionArn *string - // The status of the solution version. A solution version can be in one of the - // following states: + // 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 Status *string @@ -1912,8 +2086,9 @@ 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 Amazon Personalize resources (https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html) -// . +// you define. For more information see [Tagging Amazon Personalize resources]. +// +// [Tagging Amazon Personalize resources]: https://docs.aws.amazon.com/personalize/latest/dg/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 @@ -1948,9 +2123,11 @@ type TrainingDataConfig struct { // Specifies the columns to exclude from training. Each key is a dataset type, and // each value is a list of columns. Exclude columns to control what data Amazon - // Personalize uses to generate recommendations. For example, you might have a - // column that you want to use only to filter recommendations. You can exclude this - // column from training and Amazon Personalize considers it only when filtering. + // Personalize uses to generate recommendations. + // + // For example, you might have a column that you want to use only to filter + // recommendations. You can exclude this column from training and Amazon + // Personalize considers it only when filtering. ExcludedDatasetColumns map[string][]string noSmithyDocumentSerde diff --git a/service/personalizeevents/api_op_PutActionInteractions.go b/service/personalizeevents/api_op_PutActionInteractions.go index cd8429de09d..bf12a09f5e5 100644 --- a/service/personalizeevents/api_op_PutActionInteractions.go +++ b/service/personalizeevents/api_op_PutActionInteractions.go @@ -13,11 +13,13 @@ import ( // Records action interaction event data. An action interaction event is an // interaction between a user and an action. For example, a user taking an action, -// such a enrolling in a membership program or downloading your app. For more -// information about recording action interactions, see Recording action -// interaction events (https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html) -// . For more information about actions in an Actions dataset, see Actions dataset (https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html) -// . +// such a enrolling in a membership program or downloading your app. +// +// For more information about recording action interactions, see [Recording action interaction events]. For more +// information about actions in an Actions dataset, see [Actions dataset]. +// +// [Recording action interaction events]: https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html +// [Actions dataset]: https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html func (c *Client) PutActionInteractions(ctx context.Context, params *PutActionInteractionsInput, optFns ...func(*Options)) (*PutActionInteractionsOutput, error) { if params == nil { params = &PutActionInteractionsInput{} @@ -42,8 +44,9 @@ type PutActionInteractionsInput struct { // The ID of your action interaction event tracker. When you create an Action // interactions dataset, Amazon Personalize creates an action interaction event - // tracker for you. For more information, see Action interaction event tracker ID (https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html) - // . + // tracker for you. For more information, see [Action interaction event tracker ID]. + // + // [Action interaction event tracker ID]: https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html // // This member is required. TrackingId *string diff --git a/service/personalizeevents/api_op_PutActions.go b/service/personalizeevents/api_op_PutActions.go index 69bee794e58..6b601225a55 100644 --- a/service/personalizeevents/api_op_PutActions.go +++ b/service/personalizeevents/api_op_PutActions.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more actions to an Actions dataset. For more information see -// Importing actions individually (https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html) -// . +// Adds one or more actions to an Actions dataset. For more information see [Importing actions individually]. +// +// [Importing actions individually]: https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html func (c *Client) PutActions(ctx context.Context, params *PutActionsInput, optFns ...func(*Options)) (*PutActionsOutput, error) { if params == nil { params = &PutActionsInput{} diff --git a/service/personalizeevents/api_op_PutEvents.go b/service/personalizeevents/api_op_PutEvents.go index 88a33cf6396..fe5ead93118 100644 --- a/service/personalizeevents/api_op_PutEvents.go +++ b/service/personalizeevents/api_op_PutEvents.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Records item interaction event data. For more information see Recording item -// interaction events (https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html) -// . +// Records item interaction event data. For more information see [Recording item interaction events]. +// +// [Recording item interaction events]: https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html func (c *Client) PutEvents(ctx context.Context, params *PutEventsInput, optFns ...func(*Options)) (*PutEventsOutput, error) { if params == nil { params = &PutEventsInput{} @@ -39,15 +39,16 @@ 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 item interaction events (https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html) - // . + // in. For more information, see [Recording item interaction events]. + // + // [Recording item interaction events]: https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-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) - // API. + // The tracking ID for the event. The ID is generated by a call to the [CreateEventTracker] API. + // + // [CreateEventTracker]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html // // This member is required. TrackingId *string diff --git a/service/personalizeevents/api_op_PutItems.go b/service/personalizeevents/api_op_PutItems.go index 7df4a13eece..081bbd0e898 100644 --- a/service/personalizeevents/api_op_PutItems.go +++ b/service/personalizeevents/api_op_PutItems.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more items to an Items dataset. For more information see Importing -// items individually (https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html) -// . +// Adds one or more items to an Items dataset. For more information see [Importing items individually]. +// +// [Importing items individually]: 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 752cc826add..3d8b3dec950 100644 --- a/service/personalizeevents/api_op_PutUsers.go +++ b/service/personalizeevents/api_op_PutUsers.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more users to a Users dataset. For more information see Importing -// users individually (https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html) -// . +// Adds one or more users to a Users dataset. For more information see [Importing users individually]. +// +// [Importing users individually]: 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 d7fc44ae726..b813be02dab 100644 --- a/service/personalizeevents/doc.go +++ b/service/personalizeevents/doc.go @@ -5,6 +5,7 @@ // // 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 item interaction events (https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html) -// . +// historical data. For more information see [Recording item interaction events]. +// +// [Recording item interaction events]: https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html package personalizeevents diff --git a/service/personalizeevents/options.go b/service/personalizeevents/options.go index 55912cfdb51..6ab7f969ebe 100644 --- a/service/personalizeevents/options.go +++ b/service/personalizeevents/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/personalizeevents/types/types.go b/service/personalizeevents/types/types.go index 540b4362020..89a10c745f8 100644 --- a/service/personalizeevents/types/types.go +++ b/service/personalizeevents/types/types.go @@ -8,8 +8,9 @@ import ( ) // Represents action metadata added to an Action dataset using the PutActions API. -// For more information see Importing actions individually (https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html) -// . +// For more information see [Importing actions individually]. +// +// [Importing actions individually]: https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html type Action struct { // The ID associated with the action. @@ -18,12 +19,13 @@ type Action struct { ActionId *string // A string map of action-specific metadata. Each element in the map consists of a - // key-value pair. For example, {"value": "100"} . The keys use camel case names - // that match the fields in the schema for the Actions dataset. In the previous - // example, the value matches the 'VALUE' field defined in the Actions schema. For - // categorical string data, to include multiple categories for a single action, - // separate each category with a pipe separator ( | ). For example, - // \"Deluxe|Premium\" . + // key-value pair. For example, {"value": "100"} . + // + // The keys use camel case names that match the fields in the schema for the + // Actions dataset. In the previous example, the value matches the 'VALUE' field + // defined in the Actions schema. For categorical string data, to include multiple + // categories for a single action, separate each category with a pipe separator ( | + // ). For example, \"Deluxe|Premium\" . // // This value conforms to the media type: application/json Properties *string @@ -42,8 +44,9 @@ type ActionInteraction struct { // The type of action interaction event. You can specify Viewed , Taken , and Not // Taken event types. For more information about action interaction event type - // data, see Event type data (https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html) - // . + // data, see [Event type data]. + // + // [Event type data]: https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html // // This member is required. EventType *string @@ -75,17 +78,28 @@ type ActionInteraction struct { // A string map of event-specific data that you might choose to record. For // example, if a user takes an action, other than the action ID, you might also - // send the number of actions taken by the user. Each item in the map consists of a - // key-value pair. For example, {"numberOfActions": "12"} The keys use camel case - // names that match the fields in the Action interactions schema. In the above - // example, the numberOfActions would match the 'NUMBER_OF_ACTIONS' field defined - // in the Action interactions schema. The following can't be included as a keyword - // for properties (case insensitive). + // send the number of actions taken by the user. + // + // Each item in the map consists of a key-value pair. For example, + // + // {"numberOfActions": "12"} + // + // The keys use camel case names that match the fields in the Action interactions + // schema. In the above example, the numberOfActions would match the + // 'NUMBER_OF_ACTIONS' field defined in the Action interactions schema. + // + // The following can't be included as a keyword for properties (case insensitive). + // // - userId + // // - sessionId + // // - eventType + // // - timestamp + // // - recommendationId + // // - impression // // This value conforms to the media type: application/json @@ -131,8 +145,9 @@ type Event struct { // 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) - // . + // recording impressions data, see [Recording impressions data]. + // + // [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 Item interactions @@ -140,25 +155,36 @@ type Event struct { ItemId *string // 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) - // . + // more information about metric attributions, see [Measuring impact of recommendations]. + // + // [Measuring impact of 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, - // {"numberOfRatings": "12"} The keys use camel case names that match the fields in - // the Item interactions dataset's schema. In the above example, the - // numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Item - // interactions dataset's schema. The following can't be included as a keyword for - // properties (case insensitive). + // 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 Item interactions + // dataset's schema. In the above example, the numberOfRatings would match the + // 'NUMBER_OF_RATINGS' field defined in the Item interactions dataset's schema. + // + // The following can't be included as a keyword for properties (case insensitive). + // // - userId + // // - sessionId + // // - eventType + // // - timestamp + // // - recommendationId + // // - impression // // This value conforms to the media type: application/json @@ -168,19 +194,22 @@ type Event struct { // 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) - // . + // impact of recommendations. + // + // For more information on recording impressions data, see [Recording impressions data]. For more information + // on creating a metric attribution see [Measuring impact of recommendations]. + // + // [Recording impressions data]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data + // [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 individually (https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html) -// . +// more information see [Importing items individually]. +// +// [Importing items individually]: https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html type Item struct { // The ID associated with the item. @@ -189,12 +218,13 @@ 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 - // 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\" . + // 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\" . // // This value conforms to the media type: application/json Properties *string @@ -203,9 +233,9 @@ 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) -// . +// more information about metric attributions, see [Measuring impact of recommendations]. +// +// [Measuring impact of 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. @@ -217,8 +247,9 @@ type MetricAttribution struct { } // Represents user metadata added to a Users dataset using the PutUsers API. For -// more information see Importing users individually (https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html) -// . +// more information see [Importing users individually]. +// +// [Importing users individually]: https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html type User struct { // The ID associated with the user. @@ -227,9 +258,10 @@ 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\" . diff --git a/service/personalizeruntime/api_op_GetActionRecommendations.go b/service/personalizeruntime/api_op_GetActionRecommendations.go index f1a21b28e13..d51262864c0 100644 --- a/service/personalizeruntime/api_op_GetActionRecommendations.go +++ b/service/personalizeruntime/api_op_GetActionRecommendations.go @@ -14,11 +14,13 @@ import ( // Returns a list of recommended actions in sorted in descending order by // prediction score. Use the GetActionRecommendations API if you have a custom // campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS -// recipe. For more information about PERSONALIZED_ACTIONS recipes, see -// PERSONALIZED_ACTIONS recipes (https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html) -// . For more information about getting action recommendations, see Getting action -// recommendations (https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html) -// . +// recipe. +// +// For more information about PERSONALIZED_ACTIONS recipes, see [PERSONALIZED_ACTIONS recipes]. For more +// information about getting action recommendations, see [Getting action recommendations]. +// +// [Getting action recommendations]: https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html +// [PERSONALIZED_ACTIONS recipes]: https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html func (c *Client) GetActionRecommendations(ctx context.Context, params *GetActionRecommendationsInput, optFns ...func(*Options)) (*GetActionRecommendationsOutput, error) { if params == nil { params = &GetActionRecommendationsInput{} @@ -42,20 +44,27 @@ type GetActionRecommendationsInput struct { CampaignArn *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]. + // + // When using this parameter, be sure the filter resource is ACTIVE . + // + // [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 actions, you must provide values for all - // parameters that are defined in the expression. For filters with expressions that - // use an EXCLUDE element to exclude actions, 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) . + // multiple values for one parameter with a comma. + // + // For filter expressions that use an INCLUDE element to include actions, you must + // provide values for all parameters that are defined in the expression. For + // filters with expressions that use an EXCLUDE element to exclude actions, 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]. + // + // [Filtering recommendations and user segments]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html FilterValues map[string]string // The number of results to return. The default is 5. The maximum is 100. @@ -71,8 +80,9 @@ type GetActionRecommendationsOutput struct { // A list of action recommendations sorted in descending order by prediction // score. There can be a maximum of 100 actions in the list. For information about - // action scores, see How action recommendation scoring works (https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html) - // . + // action scores, see [How action recommendation scoring works]. + // + // [How action recommendation scoring works]: https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html ActionList []types.PredictedAction // The ID of the recommendation. diff --git a/service/personalizeruntime/api_op_GetPersonalizedRanking.go b/service/personalizeruntime/api_op_GetPersonalizedRanking.go index 4936eeb6631..ced51c7cdd5 100644 --- a/service/personalizeruntime/api_op_GetPersonalizedRanking.go +++ b/service/personalizeruntime/api_op_GetPersonalizedRanking.go @@ -12,8 +12,9 @@ import ( ) // Re-ranks a list of recommended items for the given user. The first item in the -// list is deemed the most likely item to be of interest to the user. The solution -// backing the campaign must have been created using a recipe of type +// list is deemed the most likely item to be of interest to the user. +// +// The solution backing the campaign must have been created using a recipe of type // PERSONALIZED_RANKING. func (c *Client) GetPersonalizedRanking(ctx context.Context, params *GetPersonalizedRankingInput, optFns ...func(*Options)) (*GetPersonalizedRankingOutput, error) { if params == nil { @@ -58,30 +59,36 @@ type GetPersonalizedRankingInput struct { 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) - // . + // exclude items from recommendations for a given user. For more information, see [Filtering Recommendations]. + // + // [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) - // . + // 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]. + // + // [Filtering Recommendations]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html FilterValues map[string]string // If you enabled metadata in recommendations when you created or updated the // campaign, specify metadata columns from your Items dataset to include in the // personalized ranking. The map key is ITEMS and the value is a list of column // names from your Items dataset. The maximum number of columns you can provide is - // 10. For information about enabling metadata for a campaign, see Enabling - // metadata in recommendations for a campaign (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata) - // . + // 10. + // + // For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign]. + // + // [Enabling metadata in recommendations for a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata MetadataColumns map[string][]string noSmithyDocumentSerde diff --git a/service/personalizeruntime/api_op_GetRecommendations.go b/service/personalizeruntime/api_op_GetRecommendations.go index 3053769ced7..cf8afb3ff0a 100644 --- a/service/personalizeruntime/api_op_GetRecommendations.go +++ b/service/personalizeruntime/api_op_GetRecommendations.go @@ -14,15 +14,19 @@ 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 // // 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) -// . +// 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]. +// +// [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{} @@ -51,35 +55,45 @@ type GetRecommendationsInput struct { 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]. + // + // When using this parameter, be sure the filter resource is ACTIVE . + // + // [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 and user - // segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) . + // 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]. + // + // [Filtering recommendations and user 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 - // type. + // The item ID to provide recommendations for. + // + // Required for RELATED_ITEMS recipe type. ItemId *string // If you enabled metadata in recommendations when you created or updated the // campaign or recommender, specify the metadata columns from your Items dataset to // include in item recommendations. The map key is ITEMS and the value is a list // of column names from your Items dataset. The maximum number of columns you can - // provide is 10. For information about enabling metadata for a campaign, see - // Enabling metadata in recommendations for a campaign (https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata) - // . For information about enabling metadata for a recommender, see Enabling - // metadata in recommendations for a recommender (https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata) - // . + // provide is 10. + // + // For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign]. For information + // about enabling metadata for a recommender, see [Enabling metadata in recommendations for a recommender]. + // + // [Enabling metadata in recommendations for a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata + // [Enabling metadata in recommendations for a recommender]: https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata MetadataColumns map[string][]string // The number of results to return. The default is 25. If you are including @@ -96,8 +110,9 @@ type GetRecommendationsInput struct { // with a recommender for a domain use case. RecommenderArn *string - // The user ID to provide recommendations for. Required for USER_PERSONALIZATION - // recipe type. + // The user ID to provide recommendations for. + // + // Required for USER_PERSONALIZATION recipe type. UserId *string noSmithyDocumentSerde diff --git a/service/personalizeruntime/options.go b/service/personalizeruntime/options.go index 2151d25767a..c8e03c30aeb 100644 --- a/service/personalizeruntime/options.go +++ b/service/personalizeruntime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/personalizeruntime/types/types.go b/service/personalizeruntime/types/types.go index 190dcf28f01..6375871c981 100644 --- a/service/personalizeruntime/types/types.go +++ b/service/personalizeruntime/types/types.go @@ -6,21 +6,25 @@ import ( smithydocument "github.com/aws/smithy-go/document" ) -// An object that identifies an action. The API returns a list of PredictedAction s. +// An object that identifies an action. +// +// The API returns a list of PredictedAction s. type PredictedAction struct { // The ID of the recommended action. ActionId *string - // The score of the recommended action. For information about action scores, see - // How action recommendation scoring works (https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html) - // . + // The score of the recommended action. For information about action scores, see [How action recommendation scoring works]. + // + // [How action recommendation scoring works]: https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html Score *float64 noSmithyDocumentSerde } -// An object that identifies an item. The and APIs return a list of PredictedItem s. +// An object that identifies an item. +// +// The and APIs return a list of PredictedItem s. type PredictedItem struct { // The recommended item ID. @@ -34,23 +38,26 @@ type PredictedItem struct { // If you use User-Personalization-v2, a list of reasons for why the item was // included in recommendations. Possible reasons include the following: + // // - Promoted item - Indicates the item was included as part of a promotion that // you applied in your recommendation request. + // // - Exploration - Indicates the item was included with exploration. With // exploration, recommendations include items with less interactions data or - // relevance for the user. For more information about exploration, see - // Exploration (https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration) - // . + // relevance for the user. For more information about exploration, see [Exploration]. + // // - Popular item - Indicates the item was included as a placeholder popular // item. If you use a filter, depending on how many recommendations the filter // removes, Amazon Personalize might add placeholder items to meet the numResults // for your recommendation request. These items are popular items, based on // interactions data, that satisfy your filter criteria. They don't have a // relevance score for the user. + // + // [Exploration]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration Reason []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 . + // next user selection. For more information on scoring logic, see how-scores-work. Score *float64 noSmithyDocumentSerde @@ -61,22 +68,25 @@ type PredictedItem struct { 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) - // . + // defines the criteria for promoted items. For more information, see [Promotion filters]. + // + // [Promotion 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 // promotion's 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 on creating filters, see Filtering - // recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html) - // . + // 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 on creating filters, see [Filtering recommendations and user segments]. + // + // [Filtering 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_op_CreatePerformanceAnalysisReport.go b/service/pi/api_op_CreatePerformanceAnalysisReport.go index 7589be3a7a3..4a07cc423e6 100644 --- a/service/pi/api_op_CreatePerformanceAnalysisReport.go +++ b/service/pi/api_op_CreatePerformanceAnalysisReport.go @@ -37,9 +37,10 @@ type CreatePerformanceAnalysisReportInput struct { EndTime *time.Time // 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-ADECBTYHKTSAUMUZQYPDS2GW4A . + // 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-ADECBTYHKTSAUMUZQYPDS2GW4A . // // This member is required. Identifier *string diff --git a/service/pi/api_op_DeletePerformanceAnalysisReport.go b/service/pi/api_op_DeletePerformanceAnalysisReport.go index ae714bc19d5..03520a25e27 100644 --- a/service/pi/api_op_DeletePerformanceAnalysisReport.go +++ b/service/pi/api_op_DeletePerformanceAnalysisReport.go @@ -37,9 +37,10 @@ type DeletePerformanceAnalysisReportInput 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 diff --git a/service/pi/api_op_DescribeDimensionKeys.go b/service/pi/api_op_DescribeDimensionKeys.go index 6109cad4416..81873fb4da0 100644 --- a/service/pi/api_op_DescribeDimensionKeys.go +++ b/service/pi/api_op_DescribeDimensionKeys.go @@ -13,6 +13,7 @@ import ( ) // 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) { @@ -34,8 +35,9 @@ 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 . + // equal to) EndTime are returned. + // + // The value for EndTime must be later than the value for StartTime . // // This member is required. EndTime *time.Time @@ -50,19 +52,24 @@ type DescribeDimensionKeysInput struct { GroupBy *types.DimensionGroup // 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 . + // 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 . // // This member is required. Identifier *string - // The name of a Performance Insights metric to be measured. Valid values for - // Metric are: + // 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 @@ -75,7 +82,9 @@ type DescribeDimensionKeysInput struct { // The Amazon Web Services service for which Performance Insights will return // metrics. Valid values are as follows: + // // - RDS + // // - DOCDB // // This member is required. @@ -84,7 +93,9 @@ 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 @@ -96,8 +107,10 @@ type DescribeDimensionKeysInput struct { 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. Filter map[string]string @@ -118,11 +131,17 @@ type DescribeDimensionKeysInput struct { // 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. PeriodInSeconds *int32 diff --git a/service/pi/api_op_GetDimensionKeyDetails.go b/service/pi/api_op_GetDimensionKeyDetails.go index cfb7ba94f03..824d915a63b 100644 --- a/service/pi/api_op_GetDimensionKeyDetails.go +++ b/service/pi/api_op_GetDimensionKeyDetails.go @@ -35,7 +35,9 @@ 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) // // This member is required. @@ -44,7 +46,9 @@ type GetDimensionKeyDetailsInput struct { // 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) // // This member is required. @@ -68,8 +72,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). RequestedDimensions []string diff --git a/service/pi/api_op_GetPerformanceAnalysisReport.go b/service/pi/api_op_GetPerformanceAnalysisReport.go index 1497f067a26..6a4d82f5ab1 100644 --- a/service/pi/api_op_GetPerformanceAnalysisReport.go +++ b/service/pi/api_op_GetPerformanceAnalysisReport.go @@ -40,9 +40,10 @@ type GetPerformanceAnalysisReportInput 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 diff --git a/service/pi/api_op_GetResourceMetadata.go b/service/pi/api_op_GetResourceMetadata.go index a644da42635..13432cb23f7 100644 --- a/service/pi/api_op_GetResourceMetadata.go +++ b/service/pi/api_op_GetResourceMetadata.go @@ -53,9 +53,11 @@ type GetResourceMetadataOutput struct { Features map[string]types.FeatureMetadata // 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 . + // 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 . 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 f35ac0049cb..14a85d8f144 100644 --- a/service/pi/api_op_GetResourceMetrics.go +++ b/service/pi/api_op_GetResourceMetrics.go @@ -15,8 +15,10 @@ import ( // Retrieve Performance Insights metrics for a set of data sources over a time // period. You can provide specific dimension groups and dimensions, and provide // filtering criteria for each group. You must specify an aggregate function for -// each metric. Each response element returns a maximum of 500 bytes. For larger -// elements, such as SQL statements, only the first 500 bytes are returned. +// each 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) GetResourceMetrics(ctx context.Context, params *GetResourceMetricsInput, optFns ...func(*Options)) (*GetResourceMetricsOutput, error) { if params == nil { params = &GetResourceMetricsInput{} @@ -36,8 +38,9 @@ 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 @@ -45,9 +48,10 @@ 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 @@ -64,7 +68,9 @@ type GetResourceMetricsInput struct { // The Amazon Web Services service for which Performance Insights returns metrics. // Valid values are as follows: + // // - RDS + // // - DOCDB // // This member is required. @@ -74,8 +80,9 @@ 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 @@ -97,11 +104,17 @@ type GetResourceMetricsInput struct { // 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. diff --git a/service/pi/api_op_ListAvailableResourceMetrics.go b/service/pi/api_op_ListAvailableResourceMetrics.go index a85dfb4c556..34e3a5bc31d 100644 --- a/service/pi/api_op_ListAvailableResourceMetrics.go +++ b/service/pi/api_op_ListAvailableResourceMetrics.go @@ -40,9 +40,13 @@ type ListAvailableResourceMetricsInput struct { // 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 // diff --git a/service/pi/api_op_ListPerformanceAnalysisReports.go b/service/pi/api_op_ListPerformanceAnalysisReports.go index be4532851da..5f88b1da1d4 100644 --- a/service/pi/api_op_ListPerformanceAnalysisReports.go +++ b/service/pi/api_op_ListPerformanceAnalysisReports.go @@ -33,9 +33,10 @@ type ListPerformanceAnalysisReportsInput 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 diff --git a/service/pi/api_op_ListTagsForResource.go b/service/pi/api_op_ListTagsForResource.go index 675c22d237b..b8a0f3da931 100644 --- a/service/pi/api_op_ListTagsForResource.go +++ b/service/pi/api_op_ListTagsForResource.go @@ -31,9 +31,9 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // Lists all the tags for the Amazon RDS Performance Insights resource. 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) - // . + // is an Amazon Resource Name (ARN). For information about creating an ARN, see [Constructing an RDS Amazon Resource Name (ARN)]. + // + // [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. ResourceARN *string diff --git a/service/pi/api_op_TagResource.go b/service/pi/api_op_TagResource.go index f6fa1661cd0..74166503431 100644 --- a/service/pi/api_op_TagResource.go +++ b/service/pi/api_op_TagResource.go @@ -31,8 +31,9 @@ type TagResourceInput struct { // The Amazon RDS Performance Insights 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) - // . + // see [Constructing an RDS Amazon Resource Name (ARN)]. + // + // [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. ResourceARN *string diff --git a/service/pi/api_op_UntagResource.go b/service/pi/api_op_UntagResource.go index 86c8593d446..1815fa56849 100644 --- a/service/pi/api_op_UntagResource.go +++ b/service/pi/api_op_UntagResource.go @@ -31,8 +31,9 @@ type UntagResourceInput struct { // The Amazon RDS Performance Insights 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) - // . + // see [Constructing an RDS Amazon Resource Name (ARN)]. + // + // [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. ResourceARN *string diff --git a/service/pi/doc.go b/service/pi/doc.go index 875be7f1fcf..8a7c069aa04 100644 --- a/service/pi/doc.go +++ b/service/pi/doc.go @@ -3,26 +3,35 @@ // Package pi provides the API client, operations, and parameter types for AWS // Performance Insights. // -// Amazon RDS Performance Insights Amazon RDS Performance Insights enables you to -// monitor and explore different dimensions of database load based on data captured -// from a running DB instance. The guide provides detailed information about -// Performance Insights data types, parameters and errors. When Performance -// Insights is enabled, the Amazon RDS Performance Insights API provides visibility -// into the performance of your DB instance. Amazon CloudWatch provides the -// authoritative source for Amazon Web Services service-vended monitoring metrics. -// Performance Insights offers a domain-specific view of DB load. DB load is -// measured as average active sessions. Performance Insights provides the data to -// API consumers as a two-dimensional time-series dataset. The time dimension -// 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. +// # Amazon RDS Performance Insights +// +// Amazon RDS Performance Insights enables you to monitor and explore different +// dimensions of database load based on data captured from a running DB instance. +// The guide provides detailed information about Performance Insights data types, +// parameters and errors. +// +// When Performance Insights is enabled, the Amazon RDS Performance Insights API +// provides visibility into the performance of your DB instance. Amazon CloudWatch +// provides the authoritative source for Amazon Web Services service-vended +// monitoring metrics. Performance Insights offers a domain-specific view of DB +// load. +// +// DB load is measured as average active sessions. Performance Insights provides +// the data to API consumers as a two-dimensional time-series dataset. The time +// dimension 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 the [Amazon Aurora User Guide]. +// // - 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) -// . +// the [Amazon RDS User Guide]. +// // - 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 the [Amazon DocumentDB Developer Guide]. +// +// [Amazon RDS User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html +// [Amazon DocumentDB Developer Guide]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html +// [Amazon Aurora User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html package pi diff --git a/service/pi/options.go b/service/pi/options.go index 45e4e44cfc3..a87997c9b04 100644 --- a/service/pi/options.go +++ b/service/pi/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pi/types/enums.go b/service/pi/types/enums.go index e4ca51a1074..f904c103db3 100644 --- a/service/pi/types/enums.go +++ b/service/pi/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for AcceptLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceptLanguage) Values() []AcceptLanguage { return []AcceptLanguage{ "EN_US", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for AnalysisStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisStatus) Values() []AnalysisStatus { return []AnalysisStatus{ "RUNNING", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for ContextType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContextType) Values() []ContextType { return []ContextType{ "CAUSAL", @@ -66,8 +69,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for FeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureStatus) Values() []FeatureStatus { return []FeatureStatus{ "ENABLED", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for PeriodAlignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PeriodAlignment) Values() []PeriodAlignment { return []PeriodAlignment{ "END_TIME", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for ServiceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceType) Values() []ServiceType { return []ServiceType{ "RDS", @@ -148,8 +155,9 @@ const ( ) // Values returns all known values for Severity. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Severity) Values() []Severity { return []Severity{ "LOW", @@ -167,8 +175,9 @@ const ( ) // Values returns all known values for TextFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextFormat) Values() []TextFormat { return []TextFormat{ "PLAIN_TEXT", diff --git a/service/pi/types/types.go b/service/pi/types/types.go index 59fc979a5a9..6f6a104e47f 100644 --- a/service/pi/types/types.go +++ b/service/pi/types/types.go @@ -30,7 +30,9 @@ type AnalysisReport struct { // List the tags for the Amazon Web Services service for which Performance // Insights returns metrics. Valid values are as follows: + // // - RDS + // // - DOCDB ServiceType ServiceType @@ -108,12 +110,16 @@ 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. // @@ -122,33 +128,54 @@ type DimensionDetail struct { 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). // @@ -157,66 +184,101 @@ type DimensionGroup 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: + // 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). Dimensions []string @@ -263,21 +325,28 @@ 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) 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. 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) Value *string @@ -290,13 +359,19 @@ 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. Status FeatureStatus @@ -311,7 +386,7 @@ type Insight struct { // This member is required. InsightId *string - // Metric names and values from the timeframe used as baseline to generate the + // Metric names and values from the timeframe used as baseline to generate the // insight. BaselineData []Data @@ -386,16 +461,20 @@ type MetricKeyDataPoints struct { // Filter ). type MetricQuery struct { - // The name of a Performance Insights metric to be measured. Valid values for - // Metric are: + // 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. - // - The counter metrics listed in Performance Insights operating system counters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) - // in the Amazon RDS User Guide. + // + // - The counter metrics listed in [Performance Insights operating system counters]in the Amazon Aurora User Guide. + // + // - The counter metrics listed in [Performance Insights operating system counters]in the Amazon RDS 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 @@ -403,12 +482,16 @@ type MetricQuery struct { // 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. // + // [Performance Insights operating system counters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS + // // 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. Filter map[string]string @@ -486,16 +569,20 @@ type ResponseResourceMetric struct { // for that metric. type ResponseResourceMetricKey struct { - // The name of a Performance Insights metric to be measured. Valid values for - // Metric are: + // 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. - // - The counter metrics listed in Performance Insights operating system counters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS) - // in the Amazon RDS User Guide. + // + // - The counter metrics listed in [Performance Insights operating system counters]in the Amazon Aurora User Guide. + // + // - The counter metrics listed in [Performance Insights operating system counters]in the Amazon RDS 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 @@ -503,6 +590,8 @@ type ResponseResourceMetricKey struct { // 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. // + // [Performance Insights operating system counters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS + // // This member is required. Metric *string diff --git a/service/pinpoint/api_op_DeleteEmailTemplate.go b/service/pinpoint/api_op_DeleteEmailTemplate.go index 8d2589da254..b8a34a0797c 100644 --- a/service/pinpoint/api_op_DeleteEmailTemplate.go +++ b/service/pinpoint/api_op_DeleteEmailTemplate.go @@ -41,16 +41,23 @@ type DeleteEmailTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_DeleteInAppTemplate.go b/service/pinpoint/api_op_DeleteInAppTemplate.go index 755acaa4453..06107454801 100644 --- a/service/pinpoint/api_op_DeleteInAppTemplate.go +++ b/service/pinpoint/api_op_DeleteInAppTemplate.go @@ -40,16 +40,23 @@ type DeleteInAppTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_DeletePushTemplate.go b/service/pinpoint/api_op_DeletePushTemplate.go index abafe7b9c72..ef047b4a718 100644 --- a/service/pinpoint/api_op_DeletePushTemplate.go +++ b/service/pinpoint/api_op_DeletePushTemplate.go @@ -41,16 +41,23 @@ type DeletePushTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_DeleteSmsTemplate.go b/service/pinpoint/api_op_DeleteSmsTemplate.go index 9d4bcccd53a..409cda45fab 100644 --- a/service/pinpoint/api_op_DeleteSmsTemplate.go +++ b/service/pinpoint/api_op_DeleteSmsTemplate.go @@ -40,16 +40,23 @@ type DeleteSmsTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_DeleteVoiceTemplate.go b/service/pinpoint/api_op_DeleteVoiceTemplate.go index 97cf70b6e7c..95d458cebbf 100644 --- a/service/pinpoint/api_op_DeleteVoiceTemplate.go +++ b/service/pinpoint/api_op_DeleteVoiceTemplate.go @@ -41,16 +41,23 @@ type DeleteVoiceTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_GetApplicationDateRangeKpi.go b/service/pinpoint/api_op_GetApplicationDateRangeKpi.go index 7f68a6210c4..118ebd2fa72 100644 --- a/service/pinpoint/api_op_GetApplicationDateRangeKpi.go +++ b/service/pinpoint/api_op_GetApplicationDateRangeKpi.go @@ -41,9 +41,9 @@ type GetApplicationDateRangeKpiInput struct { // to retrieve data 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. 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) - // . + // successful-delivery-rate. For a list of valid values, see the [Amazon Pinpoint Developer Guide]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. KpiName *string diff --git a/service/pinpoint/api_op_GetCampaignDateRangeKpi.go b/service/pinpoint/api_op_GetCampaignDateRangeKpi.go index a9fe36c7490..08273c3ec5a 100644 --- a/service/pinpoint/api_op_GetCampaignDateRangeKpi.go +++ b/service/pinpoint/api_op_GetCampaignDateRangeKpi.go @@ -46,9 +46,9 @@ type GetCampaignDateRangeKpiInput struct { // to retrieve data 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. 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) - // . + // successful-delivery-rate. For a list of valid values, see the [Amazon Pinpoint Developer Guide]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. KpiName *string diff --git a/service/pinpoint/api_op_GetEmailTemplate.go b/service/pinpoint/api_op_GetEmailTemplate.go index bea99df57c4..e5427f88253 100644 --- a/service/pinpoint/api_op_GetEmailTemplate.go +++ b/service/pinpoint/api_op_GetEmailTemplate.go @@ -41,16 +41,23 @@ type GetEmailTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_GetInAppTemplate.go b/service/pinpoint/api_op_GetInAppTemplate.go index 1461a4c4184..31a1c341f4c 100644 --- a/service/pinpoint/api_op_GetInAppTemplate.go +++ b/service/pinpoint/api_op_GetInAppTemplate.go @@ -41,16 +41,23 @@ type GetInAppTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_GetJourneyDateRangeKpi.go b/service/pinpoint/api_op_GetJourneyDateRangeKpi.go index 11d6e0a172a..16a2d3f13a0 100644 --- a/service/pinpoint/api_op_GetJourneyDateRangeKpi.go +++ b/service/pinpoint/api_op_GetJourneyDateRangeKpi.go @@ -46,9 +46,9 @@ type GetJourneyDateRangeKpiInput struct { // to retrieve data 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. 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) - // . + // successful-delivery-rate. For a list of valid values, see the [Amazon Pinpoint Developer Guide]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. KpiName *string diff --git a/service/pinpoint/api_op_GetPushTemplate.go b/service/pinpoint/api_op_GetPushTemplate.go index a6a50116420..7bd5b41834f 100644 --- a/service/pinpoint/api_op_GetPushTemplate.go +++ b/service/pinpoint/api_op_GetPushTemplate.go @@ -41,16 +41,23 @@ type GetPushTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_GetSmsTemplate.go b/service/pinpoint/api_op_GetSmsTemplate.go index 44ee4212722..2998c731d32 100644 --- a/service/pinpoint/api_op_GetSmsTemplate.go +++ b/service/pinpoint/api_op_GetSmsTemplate.go @@ -41,16 +41,23 @@ type GetSmsTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_GetVoiceTemplate.go b/service/pinpoint/api_op_GetVoiceTemplate.go index 04f2c49df91..b271c502ea2 100644 --- a/service/pinpoint/api_op_GetVoiceTemplate.go +++ b/service/pinpoint/api_op_GetVoiceTemplate.go @@ -41,16 +41,23 @@ type GetVoiceTemplateInput struct { // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_RemoveAttributes.go b/service/pinpoint/api_op_RemoveAttributes.go index 6b1415d9140..2baf785a4ed 100644 --- a/service/pinpoint/api_op_RemoveAttributes.go +++ b/service/pinpoint/api_op_RemoveAttributes.go @@ -38,12 +38,15 @@ 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. // diff --git a/service/pinpoint/api_op_UpdateEmailTemplate.go b/service/pinpoint/api_op_UpdateEmailTemplate.go index ffbdc310d27..1fee85e7299 100644 --- a/service/pinpoint/api_op_UpdateEmailTemplate.go +++ b/service/pinpoint/api_op_UpdateEmailTemplate.go @@ -46,26 +46,34 @@ type UpdateEmailTemplateInput struct { // Specifies whether to save the updates as a new version of the message template. // Valid values are: true, save the updates as a new version; and, false, save the - // updates to (overwrite) the latest existing version of the template. If you don't - // specify a value for this parameter, Amazon Pinpoint saves the updates to - // (overwrites) the latest existing version of the template. If you specify a value - // of true for this parameter, don't specify a value for the version parameter. - // Otherwise, an error will occur. + // updates to (overwrite) the latest existing version of the template. + // + // If you don't specify a value for this parameter, Amazon Pinpoint saves the + // updates to (overwrites) the latest existing version of the template. If you + // specify a value of true for this parameter, don't specify a value for the + // version parameter. Otherwise, an error will occur. CreateNewVersion *bool // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_UpdateInAppTemplate.go b/service/pinpoint/api_op_UpdateInAppTemplate.go index 8a6f4295cf5..4048ad8a15d 100644 --- a/service/pinpoint/api_op_UpdateInAppTemplate.go +++ b/service/pinpoint/api_op_UpdateInAppTemplate.go @@ -45,26 +45,34 @@ type UpdateInAppTemplateInput struct { // Specifies whether to save the updates as a new version of the message template. // Valid values are: true, save the updates as a new version; and, false, save the - // updates to (overwrite) the latest existing version of the template. If you don't - // specify a value for this parameter, Amazon Pinpoint saves the updates to - // (overwrites) the latest existing version of the template. If you specify a value - // of true for this parameter, don't specify a value for the version parameter. - // Otherwise, an error will occur. + // updates to (overwrite) the latest existing version of the template. + // + // If you don't specify a value for this parameter, Amazon Pinpoint saves the + // updates to (overwrites) the latest existing version of the template. If you + // specify a value of true for this parameter, don't specify a value for the + // version parameter. Otherwise, an error will occur. CreateNewVersion *bool // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_UpdatePushTemplate.go b/service/pinpoint/api_op_UpdatePushTemplate.go index 497502f5a7d..f68e943d3d6 100644 --- a/service/pinpoint/api_op_UpdatePushTemplate.go +++ b/service/pinpoint/api_op_UpdatePushTemplate.go @@ -46,26 +46,34 @@ type UpdatePushTemplateInput struct { // Specifies whether to save the updates as a new version of the message template. // Valid values are: true, save the updates as a new version; and, false, save the - // updates to (overwrite) the latest existing version of the template. If you don't - // specify a value for this parameter, Amazon Pinpoint saves the updates to - // (overwrites) the latest existing version of the template. If you specify a value - // of true for this parameter, don't specify a value for the version parameter. - // Otherwise, an error will occur. + // updates to (overwrite) the latest existing version of the template. + // + // If you don't specify a value for this parameter, Amazon Pinpoint saves the + // updates to (overwrites) the latest existing version of the template. If you + // specify a value of true for this parameter, don't specify a value for the + // version parameter. Otherwise, an error will occur. CreateNewVersion *bool // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_UpdateSmsTemplate.go b/service/pinpoint/api_op_UpdateSmsTemplate.go index 8dbaaabf978..2cc8f6c0386 100644 --- a/service/pinpoint/api_op_UpdateSmsTemplate.go +++ b/service/pinpoint/api_op_UpdateSmsTemplate.go @@ -46,26 +46,34 @@ type UpdateSmsTemplateInput struct { // Specifies whether to save the updates as a new version of the message template. // Valid values are: true, save the updates as a new version; and, false, save the - // updates to (overwrite) the latest existing version of the template. If you don't - // specify a value for this parameter, Amazon Pinpoint saves the updates to - // (overwrites) the latest existing version of the template. If you specify a value - // of true for this parameter, don't specify a value for the version parameter. - // Otherwise, an error will occur. + // updates to (overwrite) the latest existing version of the template. + // + // If you don't specify a value for this parameter, Amazon Pinpoint saves the + // updates to (overwrites) the latest existing version of the template. If you + // specify a value of true for this parameter, don't specify a value for the + // version parameter. Otherwise, an error will occur. CreateNewVersion *bool // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/api_op_UpdateVoiceTemplate.go b/service/pinpoint/api_op_UpdateVoiceTemplate.go index e455494f63e..901681834c7 100644 --- a/service/pinpoint/api_op_UpdateVoiceTemplate.go +++ b/service/pinpoint/api_op_UpdateVoiceTemplate.go @@ -46,26 +46,34 @@ type UpdateVoiceTemplateInput struct { // Specifies whether to save the updates as a new version of the message template. // Valid values are: true, save the updates as a new version; and, false, save the - // updates to (overwrite) the latest existing version of the template. If you don't - // specify a value for this parameter, Amazon Pinpoint saves the updates to - // (overwrites) the latest existing version of the template. If you specify a value - // of true for this parameter, don't specify a value for the version parameter. - // Otherwise, an error will occur. + // updates to (overwrite) the latest existing version of the template. + // + // If you don't specify a value for this parameter, Amazon Pinpoint saves the + // updates to (overwrites) the latest existing version of the template. If you + // specify a value of true for this parameter, don't specify a value for the + // version parameter. Otherwise, an error will occur. CreateNewVersion *bool // The unique identifier for the version of the message template to update, // retrieve information about, or delete. To retrieve identifiers and other // information for all the versions of a template, use the Template Versions - // resource. If specified, this value must match the identifier for an existing - // template version. If specified for an update operation, this value must match - // 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: + // resource. + // + // If specified, this value must match the identifier for an existing template + // version. If specified for an update operation, this value must match 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. Version *string diff --git a/service/pinpoint/options.go b/service/pinpoint/options.go index 8637dc98f5e..91d57536c08 100644 --- a/service/pinpoint/options.go +++ b/service/pinpoint/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pinpoint/types/enums.go b/service/pinpoint/types/enums.go index 9ccb39d9d4f..dc8b79430d3 100644 --- a/service/pinpoint/types/enums.go +++ b/service/pinpoint/types/enums.go @@ -22,8 +22,9 @@ const ( ) // Values returns all known values for EndpointTypesElement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointTypesElement) Values() []EndpointTypesElement { return []EndpointTypesElement{ "PUSH", @@ -52,8 +53,9 @@ const ( // Values returns all known values for TimezoneEstimationMethodsElement. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimezoneEstimationMethodsElement) Values() []TimezoneEstimationMethodsElement { return []TimezoneEstimationMethodsElement{ "PHONE_NUMBER", @@ -71,8 +73,9 @@ const ( ) // Values returns all known values for Action. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Action) Values() []Action { return []Action{ "OPEN_APP", @@ -91,8 +94,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -115,8 +119,9 @@ const ( ) // Values returns all known values for AttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeType) Values() []AttributeType { return []AttributeType{ "INCLUSIVE", @@ -139,8 +144,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -163,8 +169,9 @@ const ( ) // Values returns all known values for CampaignStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CampaignStatus) Values() []CampaignStatus { return []CampaignStatus{ "SCHEDULED", @@ -197,8 +204,9 @@ const ( ) // Values returns all known values for ChannelType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelType) Values() []ChannelType { return []ChannelType{ "PUSH", @@ -231,8 +239,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -259,8 +268,9 @@ const ( ) // Values returns all known values for DeliveryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryStatus) Values() []DeliveryStatus { return []DeliveryStatus{ "SUCCESSFUL", @@ -282,8 +292,9 @@ const ( ) // Values returns all known values for DimensionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionType) Values() []DimensionType { return []DimensionType{ "INCLUSIVE", @@ -302,8 +313,9 @@ const ( ) // Values returns all known values for Duration. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Duration) Values() []Duration { return []Duration{ "HR_24", @@ -322,8 +334,9 @@ const ( ) // Values returns all known values for FilterType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterType) Values() []FilterType { return []FilterType{ "SYSTEM", @@ -340,8 +353,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "CSV", @@ -363,8 +377,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -387,8 +402,9 @@ const ( ) // Values returns all known values for Include. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Include) Values() []Include { return []Include{ "ALL", @@ -413,8 +429,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -440,8 +457,9 @@ const ( ) // Values returns all known values for JourneyRunStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JourneyRunStatus) Values() []JourneyRunStatus { return []JourneyRunStatus{ "SCHEDULED", @@ -464,8 +482,9 @@ const ( ) // Values returns all known values for Layout. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Layout) Values() []Layout { return []Layout{ "BOTTOM_BANNER", @@ -486,8 +505,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "TRANSACTIONAL", @@ -504,8 +524,9 @@ const ( ) // Values returns all known values for Mode. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mode) Values() []Mode { return []Mode{ "DELIVERY", @@ -522,8 +543,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "ALL", @@ -540,8 +562,9 @@ const ( ) // Values returns all known values for RecencyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecencyType) Values() []RecencyType { return []RecencyType{ "ACTIVE", @@ -558,8 +581,9 @@ const ( ) // Values returns all known values for SegmentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SegmentType) Values() []SegmentType { return []SegmentType{ "DIMENSIONAL", @@ -577,8 +601,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "ALL", @@ -600,8 +625,9 @@ const ( ) // 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. +// the future, and so 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{ "DRAFT", @@ -625,8 +651,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -647,8 +674,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "ALL", diff --git a/service/pinpoint/types/types.go b/service/pinpoint/types/types.go index 32afcf2ea0d..9989a7a6e92 100644 --- a/service/pinpoint/types/types.go +++ b/service/pinpoint/types/types.go @@ -99,8 +99,9 @@ type ActivityResponse struct { // A JSON object that contains metrics relating to the campaign execution for this // campaign activity. For information about the structure and contents of the - // results, see Standard Amazon Pinpoint analytics metrics (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html) - // in the Amazon Pinpoint Developer Guide. + // results, see [Standard Amazon Pinpoint analytics metrics]in the Amazon Pinpoint Developer Guide. + // + // [Standard Amazon Pinpoint analytics metrics]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html ExecutionMetrics map[string]string // Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. @@ -150,10 +151,11 @@ type AddressConfiguration struct { ChannelType ChannelType // An object that maps custom attributes to attributes for the address and is - // attached to the message. Attribute names are case sensitive. For a push - // notification, this payload is added to the data.pinpoint object. For an email or - // text message, this payload is added to email/SMS delivery receipt event - // attributes. + // attached to the message. Attribute names are case sensitive. + // + // For a push notification, this payload is added to the data.pinpoint object. For + // an email or text message, this payload is added to email/SMS delivery receipt + // event attributes. Context map[string]string // The raw, JSON-formatted string to use as the payload for the message. If @@ -239,10 +241,13 @@ 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. Action Action @@ -321,10 +326,13 @@ 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. Action Action @@ -460,33 +468,46 @@ 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 // 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) - // on the Apple Developer website. + // the message. + // + // For more information about the apns-push-type request header, see [Sending Notification Requests to APNs] on the Apple + // Developer website. + // + // [Sending Notification Requests to APNs]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns 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. Action Action @@ -507,9 +528,10 @@ type APNSMessage struct { // An arbitrary identifier that, if assigned to multiple messages, APNs uses to // coalesce the messages into a single push notification instead of delivering each - // message individually. This value can't exceed 64 bytes. Amazon Pinpoint - // specifies this value in the apns-collapse-id request header when it sends the - // notification message to APNs. + // message individually. This value can't exceed 64 bytes. + // + // Amazon Pinpoint specifies this value in the apns-collapse-id request header + // when it sends the notification message to APNs. CollapseId *string // The JSON payload to use for a silent push notification. This payload is added @@ -524,47 +546,60 @@ type APNSMessage struct { 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 - // immediately. This is the default value. A high priority notification should - // trigger an alert, play a sound, or badge your app's icon on the recipient's - // device. /para> Amazon Pinpoint specifies this value in the apns-priority request - // header when it sends the notification message to APNs. The equivalent values for - // Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are - // normal, for 5, and high, for 10. If you specify an FCM value for this property, - // Amazon Pinpoint accepts and converts the value to the corresponding APNs value. + // a group, or throttled. + // + // /listitem> 10 - High priority, the notification is sent immediately. This is + // the default value. A high priority notification should trigger an alert, play a + // sound, or badge your app's icon on the recipient's device. + // + // /para> Amazon Pinpoint specifies this value in the apns-priority request header + // when it sends the notification message to APNs. + // + // The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud + // Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM + // value for this property, Amazon Pinpoint accepts and converts the value to the + // corresponding APNs value. Priority *string // The raw, JSON-formatted string to use as the payload for the notification // message. If specified, this value overrides all other content for the message. - // If you specify the raw content of an APNs push notification, the message payload - // has to include the content-available key. The value of the content-available key - // has to be an integer, and can only be 0 or 1. If you're sending a standard - // 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) - // on the Apple Developer website. + // + // If you specify the raw content of an APNs push notification, the message + // payload has to include the content-available key. The value of the + // content-available key has to be an integer, and can only be 0 or 1. If you're + // sending a standard 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]and [Pushing Background Updates to Your App] on the Apple + // Developer website. + // + // [Generating a Remote Notification]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification + // [Pushing Background Updates to Your App]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app RawContent *string // Specifies whether the notification is a silent push notification. A silent (or // background) push notification isn't displayed on recipients' devices. You can // use silent push notifications to make small updates to your app, or to display - // messages in an in-app message center. Amazon Pinpoint uses this property to - // determine the correct value for the apns-push-type request header when it sends - // the notification message to APNs. If you specify a value of true for this - // property, Amazon Pinpoint sets the value for the apns-push-type header field to - // background. If you specify the raw content of an APNs push notification, the - // message payload has to include the content-available key. For silent - // (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) - // 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. + // messages in an in-app message center. + // + // Amazon Pinpoint uses this property to determine the correct value for the + // apns-push-type request header when it sends the notification message to APNs. If + // you specify a value of true for this property, Amazon Pinpoint sets the value + // for the apns-push-type header field to background. + // + // If you specify the raw content of an APNs push notification, the message + // payload has to include the content-available key. For silent (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]and [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. + // + // [Generating a Remote Notification]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification + // [Pushing Background Updates to Your App]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app SilentPush *bool // The key for the sound to play when the recipient receives the push @@ -587,8 +622,10 @@ type APNSMessage struct { // the push notification, if the service is unable to deliver the notification the // first time. If this value is 0, APNs treats the notification as if it expires // immediately and the service doesn't store or try to deliver the notification - // again. Amazon Pinpoint specifies this value in the apns-expiration request - // header when it sends the notification message to APNs. + // again. + // + // Amazon Pinpoint specifies this value in the apns-expiration request header when + // it sends the notification message to APNs. TimeToLive *int32 // The title to display above the notification message on the recipient's device. @@ -608,10 +645,13 @@ 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. Action Action @@ -932,9 +972,9 @@ 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]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. KpiName *string @@ -1041,14 +1081,18 @@ 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. QuietTime *QuietTime @@ -1081,6 +1125,7 @@ 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 @@ -1111,9 +1156,12 @@ 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. // // This member is required. @@ -1201,10 +1249,13 @@ 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. Action Action @@ -1313,9 +1364,9 @@ 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]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. KpiName *string @@ -1390,8 +1441,10 @@ 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 @@ -1620,10 +1673,12 @@ type CampaignsResponse struct { type CampaignState struct { // The current status of the campaign, or the current status of a treatment that - // belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign - // has a status of COMPLETED only if all campaign treatments have a status of - // COMPLETED. If you delete the segment that's associated with a campaign, the - // campaign fails and has a status of DELETED. + // belongs to an A/B test campaign. + // + // If a campaign uses A/B testing, the campaign has a status of COMPLETED only if + // all campaign treatments have a status of COMPLETED. If you delete the segment + // that's associated with a campaign, the campaign fails and has a status of + // DELETED. CampaignStatus CampaignStatus noSmithyDocumentSerde @@ -1731,12 +1786,14 @@ type Condition struct { // Specifies the settings for a yes/no split activity in a journey. This type of // activity sends participants down one of two paths in a journey, based on -// conditions that you specify. To create yes/no 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. +// conditions that you specify. +// +// To create yes/no 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]in the Amazon Pinpoint Developer Guide. +// +// [Integrating Amazon Pinpoint with your application]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html type ConditionalSplitActivity struct { // The conditions that define the paths for the activity, and the relationship @@ -1805,17 +1862,21 @@ type CreateRecommenderConfigurationShape struct { // depending on the value for the RecommendationProviderIdType property. Each of // these attributes temporarily stores a recommended item that's retrieved from the // recommender model and sent to an AWS Lambda function for additional processing. - // Each attribute can be used as a message variable in a message template. In the - // map, the key is the name of a custom attribute and the value is a custom display - // 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: + // Each attribute can be used as a message variable in a message template. + // + // In the map, the key is the name of a custom attribute and the value is a custom + // display 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. @@ -1835,9 +1896,11 @@ 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 @@ -1855,19 +1918,23 @@ type CreateRecommenderConfigurationShape struct { // endpoint or user, depending on the value for the RecommendationProviderIdType // property. This value is required if the configuration doesn't invoke an AWS // Lambda function (RecommendationTransformerUri) to perform additional processing - // of recommendation data. This name appears in the Attribute finder of the - // template editor on the Amazon Pinpoint console. The name can contain up to 25 - // characters. The characters can be letters, numbers, spaces, underscores (_), or - // hyphens (-). These restrictions don't apply to attribute values. + // of recommendation data. + // + // This name appears in the Attribute finder of the template editor on the Amazon + // Pinpoint console. The name can contain up to 25 characters. The characters can + // be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions + // don't apply to attribute values. RecommendationsDisplayName *string // The number of recommended items to retrieve from the model for each endpoint or // user, depending on the value for the RecommendationProviderIdType property. This // number determines how many recommended items are available for use in message // variables. The minimum value is 1. The maximum value is 5. The default value is - // 5. To use multiple recommended items and custom attributes with message - // variables, you have to use an AWS Lambda function (RecommendationTransformerUri) - // to perform additional processing of recommendation data. + // 5. + // + // To use multiple recommended items and custom attributes with message variables, + // you have to use an AWS Lambda function (RecommendationTransformerUri) to perform + // additional processing of recommendation data. RecommendationsPerMessage *int32 noSmithyDocumentSerde @@ -1897,8 +1964,10 @@ 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. // @@ -1919,8 +1988,10 @@ 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. DeliveryUri *string @@ -1945,11 +2016,12 @@ type CustomMessageActivity struct { // The unique identifier for the version of the message template to use for the // message. If specified, this value must match the identifier for an existing // template version. To retrieve a list of versions and version identifiers for a - // template, use the Template Versions resource. If you don't specify a value for - // this property, Amazon Pinpoint uses the active version of the template. The - // active version is typically the version of a template that's been most recently - // reviewed and approved for use, depending on your workflow. It isn't necessarily - // the latest version of a template. + // template, use the Template Versions resource. + // + // If you don't specify a value for this property, Amazon Pinpoint uses the active + // version of the template. The active version is typically the version of a + // template that's been most recently reviewed and approved for use, depending on + // your workflow. It isn't necessarily the latest version of a template. TemplateVersion *string noSmithyDocumentSerde @@ -2002,11 +2074,14 @@ 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. Action Action @@ -2046,11 +2121,14 @@ 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. Action Action @@ -2062,10 +2140,12 @@ type DefaultPushNotificationTemplate struct { // The sound to play when a recipient receives a push notification that's based on // the message template. 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/. For an iOS platform, this value is the key for - // 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. + // file must reside in /res/raw/. + // + // For an iOS platform, this value is the key for 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 title to use in push notifications that are based on the message template. @@ -2142,8 +2222,9 @@ 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) - // that you want to apply to messages that you send through the channel. + // The [Amazon SES configuration set] that you want to apply to messages that you send through the channel. + // + // [Amazon SES configuration set]: https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html ConfigurationSet *string // Specifies whether to enable the email channel for the application. @@ -2173,8 +2254,9 @@ 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) - // that's applied to messages that are sent through the channel. + // The [Amazon SES configuration set] that's applied to messages that are sent through the channel. + // + // [Amazon SES configuration set]: https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html ConfigurationSet *string // The date and time, in ISO 8601 format, when the email channel was enabled. @@ -2275,11 +2357,12 @@ type EmailMessageActivity struct { // The unique identifier for the version of the email template to use for the // message. If specified, this value must match the identifier for an existing // template version. To retrieve a list of versions and version identifiers for a - // template, use the Template Versions resource. If you don't specify a value for - // this property, Amazon Pinpoint uses the active version of the template. The - // active version is typically the version of a template that's been most recently - // reviewed and approved for use, depending on your workflow. It isn't necessarily - // the latest version of a template. + // template, use the Template Versions resource. + // + // If you don't specify a value for this property, Amazon Pinpoint uses the active + // version of the template. The active version is typically the version of a + // template that's been most recently reviewed and approved for use, depending on + // your workflow. It isn't necessarily the latest version of a template. TemplateVersion *string noSmithyDocumentSerde @@ -2315,13 +2398,15 @@ type EmailTemplateRequest struct { // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the message template. Each tag consists of a - // required tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the message template. Each tag consists of a required tag key and + // an associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string // A custom description of the message template. @@ -2418,6 +2503,7 @@ type EndpointBatchItem struct { // with an array of values. For example, the value of a custom attribute named // Interests might be: ["Science", "Music", "Travel"]. You can use these attributes // as filter criteria when you create segments. Attribute names are case sensitive. + // // An attribute name can contain up to 50 characters. An attribute value can // contain up to 100 characters. When you define the name of a custom attribute, // avoid using the following characters: number sign (#), colon (:), question mark @@ -2438,10 +2524,12 @@ type EndpointBatchItem struct { // Specifies whether to send messages or push notifications to the endpoint. Valid // values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages - // aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to - // ACTIVE when you create an endpoint or update an existing endpoint. Amazon - // Pinpoint automatically sets this value to INACTIVE if you update another - // endpoint that has the same address specified by the Address property. + // aren’t sent to the endpoint. + // + // Amazon Pinpoint automatically sets this value to ACTIVE when you create an + // endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this + // value to INACTIVE if you update another endpoint that has the same address + // specified by the Address property. EndpointStatus *string // The unique identifier for the endpoint in the context of the batch. @@ -2564,18 +2652,25 @@ 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. + // // - UNKNOWN_FAILURE - An unknown error occurred. // // This member is required. @@ -2618,6 +2713,7 @@ type EndpointRequest struct { // with an array of values. For example, the value of a custom attribute named // Interests might be: ["Science", "Music", "Travel"]. You can use these attributes // as filter criteria when you create segments. Attribute names are case sensitive. + // // An attribute name can contain up to 50 characters. An attribute value can // contain up to 100 characters. When you define the name of a custom attribute, // avoid using the following characters: number sign (#), colon (:), question mark @@ -2638,10 +2734,12 @@ type EndpointRequest struct { // Specifies whether to send messages or push notifications to the endpoint. Valid // values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages - // aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to - // ACTIVE when you create an endpoint or update an existing endpoint. Amazon - // Pinpoint automatically sets this value to INACTIVE if you update another - // endpoint that has the same address specified by the Address property. + // aren’t sent to the endpoint. + // + // Amazon Pinpoint automatically sets this value to ACTIVE when you create an + // endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this + // value to INACTIVE if you update another endpoint that has the same address + // specified by the Address property. EndpointStatus *string // The geographic information for the endpoint. @@ -2711,10 +2809,12 @@ type EndpointResponse struct { // Specifies whether messages or push notifications are sent to the endpoint. // Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, - // messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this - // value to ACTIVE when you create an endpoint or update an existing endpoint. - // Amazon Pinpoint automatically sets this value to INACTIVE if you update another - // endpoint that has the same address specified by the Address property. + // messages aren’t sent to the endpoint. + // + // Amazon Pinpoint automatically sets this value to ACTIVE when you create an + // endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this + // value to INACTIVE if you update another endpoint that has the same address + // specified by the Address property. EndpointStatus *string // The unique identifier that you assigned to the endpoint. The identifier should @@ -2755,9 +2855,11 @@ type EndpointSendConfiguration struct { BodyOverride *string // A map of custom attributes to attach to the message for the address. Attribute - // names are case sensitive. For a push notification, this payload is added to the - // data.pinpoint object. For an email or text message, this payload is added to - // email/SMS delivery receipt event attributes. + // names are case sensitive. + // + // For a push notification, this payload is added to the data.pinpoint object. For + // an email or text message, this payload is added to email/SMS delivery receipt + // event attributes. Context map[string]string // The raw, JSON-formatted string to use as the payload for the message. If @@ -2794,11 +2896,12 @@ type EndpointUser struct { // One or more custom attributes that describe the user by associating a name with // an array of values. For example, the value of an attribute named Interests might // be: ["Science", "Music", "Travel"]. You can use these attributes as filter - // criteria when you create segments. Attribute names are case sensitive. An - // attribute name can contain up to 50 characters. An attribute value can contain - // up to 100 characters. When you define the name of a custom attribute, avoid - // using the following characters: number sign (#), colon (:), question mark (?), - // backslash (\), and slash (/). The Amazon Pinpoint console can't display + // criteria when you create segments. Attribute names are case sensitive. + // + // An attribute name can contain up to 50 characters. An attribute value can + // contain up to 100 characters. When you define the name of a custom attribute, + // avoid using the following characters: number sign (#), colon (:), question mark + // (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display // attribute names that contain these characters. This restriction doesn't apply to // attribute values. UserAttributes map[string][]string @@ -2876,8 +2979,9 @@ 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) - // in the Amazon Pinpoint Developer Guide. + // events, see [Streaming Amazon Pinpoint Events]in the Amazon Pinpoint Developer Guide. + // + // [Streaming Amazon Pinpoint Events]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html EventType *SetDimension // One or more custom metrics that your application reports to Amazon Pinpoint. @@ -2987,10 +3091,12 @@ type EventStream struct { ApplicationId *string // The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon - // Kinesis Data Firehose delivery stream to publish event data to. For a Kinesis - // data stream, the ARN format is: - // arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose - // delivery stream, the ARN format is: + // Kinesis Data Firehose delivery stream to publish event data to. + // + // For a Kinesis data stream, the ARN format is: + // arn:aws:kinesis:region:account-id:stream/stream_name + // + // For a Kinesis Data Firehose delivery stream, the ARN format is: // arn:aws:firehose:region:account-id:deliverystream/stream_name // // This member is required. @@ -3182,9 +3288,9 @@ type GCMChannelRequest struct { Enabled *bool // The contents of the JSON file provided by Google during registration in order - // to generate an access token for authentication. For more information see - // Migrate from legacy FCM APIs to HTTP v1 (https://firebase.google.com/docs/cloud-messaging/migrate-v1) - // . + // to generate an access token for authentication. For more information see [Migrate from legacy FCM APIs to HTTP v1]. + // + // [Migrate from legacy FCM APIs to HTTP v1]: https://firebase.google.com/docs/cloud-messaging/migrate-v1 ServiceJson *string noSmithyDocumentSerde @@ -3253,10 +3359,13 @@ 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. Action Action @@ -3267,9 +3376,10 @@ type GCMMessage struct { // 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. + // 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 @@ -3293,11 +3403,16 @@ 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 - // 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 + // delivery is required. + // + // /listitem> high – The notification is sent immediately and might wake a + // sleeping device. + // + // /para> Amazon Pinpoint specifies this value in the FCM priority parameter when + // it sends the notification message to FCM. + // + // The equivalent values for Apple Push Notification service (APNs) are 5, for + // normal, and 10, for high. If you specify an APNs value for this property, Amazon // Pinpoint accepts and converts the value to the corresponding FCM value. Priority *string @@ -3332,8 +3447,10 @@ type GCMMessage struct { // 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. + // which is 2,419,200 seconds (28 days). + // + // Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it + // sends the notification message to FCM. TimeToLive *int32 // The title to display above the notification message on the recipient's device. @@ -3381,11 +3498,12 @@ type GPSPointDimension struct { // activity stops a journey for a specified percentage of participants. type HoldoutActivity struct { - // The percentage of participants who shouldn't continue the journey. To determine - // which participants are held out, Amazon Pinpoint applies a probability-based - // algorithm to the percentage that you specify. Therefore, the actual percentage - // of participants who are held out may not be equal to the percentage that you - // specify. + // The percentage of participants who shouldn't continue the journey. + // + // To determine which participants are held out, Amazon Pinpoint applies a + // probability-based algorithm to the percentage that you specify. Therefore, the + // actual percentage of participants who are held out may not be equal to the + // percentage that you specify. // // This member is required. Percentage *int32 @@ -3421,7 +3539,9 @@ type ImportJobRequest struct { // the endpoint definitions to import. This location can be a folder or a single // file. If the location is a folder, Amazon Pinpoint imports endpoint definitions // from the files in this location, including any subfolders that the folder - // contains. The URL should be in the following format: + // contains. + // + // The URL should be in the following format: // s3://bucket-name/folder-name/file-name. The location can end with the key for an // individual object or a prefix that qualifies multiple objects. // @@ -3462,9 +3582,11 @@ type ImportJobResource struct { // The format of the files that contain the endpoint definitions to import. Valid // values are: CSV, for comma-separated values format; and, JSON, for - // newline-delimited JSON format. If the files are stored in an Amazon S3 location - // and that location contains multiple files that use different formats, Amazon - // Pinpoint imports data only from the files that use the specified format. + // newline-delimited JSON format. + // + // If the files are stored in an Amazon S3 location and that location contains + // multiple files that use different formats, Amazon Pinpoint imports data only + // from the files that use the specified format. // // This member is required. Format Format @@ -3480,7 +3602,9 @@ type ImportJobResource struct { // the endpoint definitions to import. This location can be a folder or a single // file. If the location is a folder, Amazon Pinpoint imports endpoint definitions // from the files in this location, including any subfolders that the folder - // contains. The URL should be in the following format: + // contains. + // + // The URL should be in the following format: // s3://bucket-name/folder-name/file-name. The location can end with the key for an // individual object or a prefix that qualifies multiple objects. // @@ -3772,13 +3896,15 @@ type InAppTemplateRequest struct { // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the message template. Each tag consists of a - // required tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the message template. Each tag consists of a required tag key and + // an associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string // The description of the template. @@ -3899,9 +4025,9 @@ 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]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. KpiName *string @@ -3943,17 +4069,23 @@ type JourneyEmailMessage struct { 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. @@ -3984,8 +4116,9 @@ type JourneyExecutionActivityMetricsResponse struct { // 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) - // . + // structure and contents of the results, see the [Amazon Pinpoint Developer Guide]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. Metrics map[string]string @@ -4015,8 +4148,9 @@ 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]. + // + // [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. Metrics map[string]string @@ -4064,8 +4198,10 @@ type JourneyPushMessage struct { // This value is converted to an expiration value when it's sent to a // push-notification service. If this value is 0, the service treats the // notification as if it expires immediately and the service doesn't store or try - // to deliver the notification again. This value doesn't apply to messages that are - // sent through the Amazon Device Messaging (ADM) service. + // to deliver the notification again. + // + // This value doesn't apply to messages that are sent through the Amazon Device + // Messaging (ADM) service. TimeToLive *string noSmithyDocumentSerde @@ -4123,12 +4259,16 @@ 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. QuietTime *QuietTime @@ -4155,17 +4295,22 @@ 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 @@ -4177,17 +4322,21 @@ type JourneyResponse struct { // This object is not used or supported. Tags map[string]string - // An array of time zone estimation methods, if any, to use for determining an - // Endpoints (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html) + // An array of time zone estimation methods, if any, to use for determining an [Endpoints] // time zone if the Endpoint does not have a value for the Demographic.Timezone // attribute. + // // - PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and // Endpoint.Location.Country. + // // - POSTAL_CODE - A time zone is determined based on the - // Endpoint.Location.PostalCode and Endpoint.Location.Country. POSTAL_CODE - // detection is only supported in the United States, United Kingdom, Australia, New - // Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon - // Pinpoint is available. + // Endpoint.Location.PostalCode and Endpoint.Location.Country. + // + // POSTAL_CODE detection is only supported in the United States, United Kingdom, + // Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions + // where Amazon Pinpoint is available. + // + // [Endpoints]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html TimezoneEstimationMethods []TimezoneEstimationMethodsElement // Indicates whether endpoints in quiet hours should enter a wait activity until @@ -4203,17 +4352,23 @@ type JourneyResponse struct { type JourneyRunExecutionActivityMetricsResponse 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. @@ -4244,9 +4399,10 @@ type JourneyRunExecutionActivityMetricsResponse struct { LastEvaluatedTime *string // A JSON object that contains the results of the query. For information about the - // structure and contents of the results, see see Standard Amazon Pinpoint - // analytics metrics (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html) - // in the Amazon Pinpoint Developer Guide. + // structure and contents of the results, see see [Standard Amazon Pinpoint analytics metrics]in the Amazon Pinpoint Developer + // Guide. + // + // [Standard Amazon Pinpoint analytics metrics]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. Metrics map[string]string @@ -4281,9 +4437,10 @@ type JourneyRunExecutionMetricsResponse 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 Standard Amazon Pinpoint - // analytics metrics (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html) - // in the Amazon Pinpoint Developer Guide. + // structure and contents of the results, see the [Standard Amazon Pinpoint analytics metrics]in the Amazon Pinpoint Developer + // Guide. + // + // [Standard Amazon Pinpoint analytics metrics]: https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html // // This member is required. Metrics map[string]string @@ -4377,9 +4534,10 @@ type JourneySMSMessage struct { OriginationNumber *string // 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) + // Support for sender IDs varies by country or region. For more information, see [Supported Countries and Regions] // in the Amazon Pinpoint User Guide. + // + // [Supported Countries and Regions]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html SenderId *string // The template ID received from the regulatory body for sending SMS in your @@ -4410,19 +4568,24 @@ type JourneysResponse struct { type JourneyStateRequest struct { // The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and - // CANCELLED If you cancel a journey, Amazon Pinpoint continues to perform - // activities that are currently in progress, until those activities are complete. - // Amazon Pinpoint also continues to collect and aggregate analytics data for those - // activities, until they are complete, and any activities that were complete when - // you cancelled the journey. After you cancel a journey, you can't add, change, or - // remove any activities from the journey. In addition, Amazon Pinpoint stops - // evaluating the journey and doesn't perform any activities that haven't started. - // When the journey is paused, Amazon Pinpoint continues to perform activities that - // are currently in progress, until those activities are complete. Endpoints will - // stop entering journeys when the journey is paused and will resume entering the - // journey after the journey is resumed. For wait activities, wait time is paused - // when the journey is paused. Currently, PAUSED only supports journeys with a - // segment refresh interval. + // CANCELLED + // + // If you cancel a journey, Amazon Pinpoint continues to perform activities that + // are currently in progress, until those activities are complete. Amazon Pinpoint + // also continues to collect and aggregate analytics data for those activities, + // until they are complete, and any activities that were complete when you + // cancelled the journey. + // + // After you cancel a journey, you can't add, change, or remove any activities + // from the journey. In addition, Amazon Pinpoint stops evaluating the journey and + // doesn't perform any activities that haven't started. + // + // When the journey is paused, Amazon Pinpoint continues to perform activities + // that are currently in progress, until those activities are complete. Endpoints + // will stop entering journeys when the journey is paused and will resume entering + // the journey after the journey is resumed. For wait activities, wait time is + // paused when the journey is paused. Currently, PAUSED only supports journeys with + // a segment refresh interval. State State noSmithyDocumentSerde @@ -4465,12 +4628,14 @@ type ListRecommenderConfigurationsResponse struct { // recipients of a campaign. type Message struct { - // The action to occur if a recipient taps the push notification. Valid values - // are: + // The action to occur if a recipient taps the push notification. Valid values are: + // // - OPEN_APP - Your app opens or it becomes the foreground app if it was sent // to the background. This is the default action. + // // - DEEP_LINK - Your app opens and displays a designated user interface in the // app. This setting uses the deep-linking features of iOS and Android. + // // - URL - The default mobile browser on the recipient's device opens and loads // the web page at a URL that you specify. Action Action @@ -4511,8 +4676,10 @@ type Message struct { // This value is converted to an expiration value when it's sent to a // push-notification service. If this value is 0, the service treats the // notification as if it expires immediately and the service doesn't store or try - // to deliver the notification again. This value doesn't apply to messages that are - // sent through the Amazon Device Messaging (ADM) service. + // to deliver the notification again. + // + // This value doesn't apply to messages that are sent through the Amazon Device + // Messaging (ADM) service. TimeToLive *int32 // The title to display above the notification message on a recipient's device. @@ -4590,12 +4757,12 @@ type MessageRequest struct { // This member is required. 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) + // A map of key-value pairs, where each key is an address and each value is an [AddressConfiguration] // object. An address can be a push notification token, a phone number, or an email - // address. 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. + // address. You can use an [AddressConfiguration]object to tailor the message for an address by + // specifying settings such as content overrides and message variables. + // + // [AddressConfiguration]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration Addresses map[string]AddressConfiguration // A map of custom attributes to attach to the message. For a push notification, @@ -4603,11 +4770,11 @@ type MessageRequest struct { // this payload is added to email/SMS delivery receipt event attributes. 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) - // object to tailor the message for an endpoint by specifying settings such as - // content overrides and message variables. + // A map of key-value pairs, where each key is an endpoint ID and each value is an [EndpointSendConfiguration] + // object. You can use an [EndpointSendConfiguration]object to tailor the message for an endpoint by + // specifying settings such as content overrides and message variables. + // + // [EndpointSendConfiguration]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration Endpoints map[string]EndpointSendConfiguration // The message template to use for the message. @@ -4649,18 +4816,25 @@ 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. + // // - UNKNOWN_FAILURE - An unknown error occurred. // // This member is required. @@ -4719,12 +4893,14 @@ type MultiConditionalBranch struct { // 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. +// 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]in the Amazon Pinpoint Developer Guide. +// +// [Integrating Amazon Pinpoint with your application]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html type MultiConditionalSplitActivity struct { // The paths for the activity, including the conditions for entering each path and @@ -4891,10 +5067,12 @@ type PublicEndpoint struct { // Specifies whether to send messages or push notifications to the endpoint. Valid // values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages - // aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to - // ACTIVE when you create an endpoint or update an existing endpoint. Amazon - // Pinpoint automatically sets this value to INACTIVE if you update another - // endpoint that has the same address specified by the Address property. + // aren’t sent to the endpoint. + // + // Amazon Pinpoint automatically sets this value to ACTIVE when you create an + // endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this + // value to INACTIVE if you update another endpoint that has the same address + // specified by the Address property. EndpointStatus *string // The geographic information for the endpoint. @@ -4940,11 +5118,12 @@ type PushMessageActivity struct { // The unique identifier for the version of the push notification template to use // for the message. If specified, this value must match the identifier for an // existing template version. To retrieve a list of versions and version - // identifiers for a template, use the Template Versions resource. If you don't - // specify a value for this property, Amazon Pinpoint uses the active version of - // the template. The active version is typically the version of a template that's - // been most recently reviewed and approved for use, depending on your workflow. It - // isn't necessarily the latest version of a template. + // identifiers for a template, use the Template Versions resource. + // + // If you don't specify a value for this property, Amazon Pinpoint uses the active + // version of the template. The active version is typically the version of a + // template that's been most recently reviewed and approved for use, depending on + // your workflow. It isn't necessarily the latest version of a template. TemplateVersion *string noSmithyDocumentSerde @@ -4994,13 +5173,15 @@ type PushNotificationTemplateRequest struct { // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the message template. Each tag consists of a - // required tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the message template. Each tag consists of a required tag key and + // an associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string // A custom description of the message template. @@ -5125,11 +5306,12 @@ type RandomSplitEntry struct { // activity for the path. NextActivity *string - // The percentage of participants to send down the activity path. To determine - // which participants are sent down each path, Amazon Pinpoint applies a - // probability-based algorithm to the percentages that you specify for the paths. - // Therefore, the actual percentage of participants who are sent down a path may - // not be equal to the percentage that you specify. + // The percentage of participants to send down the activity path. + // + // To determine which participants are sent down each path, Amazon Pinpoint + // applies a probability-based algorithm to the percentages that you specify for + // the paths. Therefore, the actual percentage of participants who are sent down a + // path may not be equal to the percentage that you specify. Percentage *int32 noSmithyDocumentSerde @@ -5204,8 +5386,9 @@ type RecommenderConfigurationResponse struct { // value for the RecommendationProviderIdType property. Each of these attributes // temporarily stores a recommended item that's retrieved from the recommender // model and sent to an AWS Lambda function for additional processing. Each - // attribute can be used as a message variable in a message template. This value is - // null if the configuration doesn't invoke an AWS Lambda function + // attribute can be used as a message variable in a message template. + // + // This value is null if the configuration doesn't invoke an AWS Lambda function // (RecommendationTransformerUri) to perform additional processing of // recommendation data. Attributes map[string]string @@ -5220,9 +5403,11 @@ 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 @@ -5239,9 +5424,11 @@ type RecommenderConfigurationResponse struct { // (RecommendationItems) that temporarily stores recommended items for each // endpoint or user, depending on the value for the RecommendationProviderIdType // property. This name appears in the Attribute finder of the template editor on - // the Amazon Pinpoint console. This value is null if the configuration doesn't - // invoke an AWS Lambda function (RecommendationTransformerUri) to perform - // additional processing of recommendation data. + // the Amazon Pinpoint console. + // + // This value is null if the configuration doesn't invoke an AWS Lambda function + // (RecommendationTransformerUri) to perform additional processing of + // recommendation data. RecommendationsDisplayName *string // The number of recommended items that are retrieved from the model for each @@ -5327,12 +5514,16 @@ 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. QuietTime *QuietTime @@ -5430,10 +5621,12 @@ type SegmentGroup struct { // The base segment to build the segment on. A base segment, also referred to as a // source segment, defines the initial population of endpoints for a segment. When // you add dimensions to a segment, Amazon Pinpoint filters the base segment by - // using the dimensions that you specify. You can specify more than one dimensional - // segment or only one imported segment. If you specify an imported segment, the - // Amazon Pinpoint console displays a segment size estimate that indicates the size - // of the imported segment without any filters applied to it. + // using the dimensions that you specify. + // + // You can specify more than one dimensional segment or only one imported segment. + // If you specify an imported segment, the Amazon Pinpoint console displays a + // segment size estimate that indicates the size of the imported segment without + // any filters applied to it. SourceSegments []SegmentReference // Specifies how to handle multiple base segments for the segment. For example, if @@ -5562,9 +5755,11 @@ 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. @@ -5679,10 +5874,11 @@ 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) - // object to tailor the message for a user by specifying settings such as content - // overrides and message variables. + // A map that associates user IDs with [EndpointSendConfiguration] objects. You can use an [EndpointSendConfiguration] object to tailor + // the message for a user by specifying settings such as content overrides and + // message variables. + // + // [EndpointSendConfiguration]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration // // This member is required. Users map[string]EndpointSendConfiguration @@ -5947,11 +6143,12 @@ type SMSMessageActivity struct { // The unique identifier for the version of the SMS template to use for the // message. If specified, this value must match the identifier for an existing // template version. To retrieve a list of versions and version identifiers for a - // template, use the Template Versions resource. If you don't specify a value for - // this property, Amazon Pinpoint uses the active version of the template. The - // active version is typically the version of a template that's been most recently - // reviewed and approved for use, depending on your workflow. It isn't necessarily - // the latest version of a template. + // template, use the Template Versions resource. + // + // If you don't specify a value for this property, Amazon Pinpoint uses the active + // version of the template. The active version is typically the version of a + // template that's been most recently reviewed and approved for use, depending on + // your workflow. It isn't necessarily the latest version of a template. TemplateVersion *string noSmithyDocumentSerde @@ -5980,13 +6177,15 @@ type SMSTemplateRequest struct { // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the message template. Each tag consists of a - // required tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the message template. Each tag consists of a required tag key and + // an associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string // A custom description of the message template. @@ -6076,9 +6275,11 @@ type TagsModel struct { // A string-to-string map of key-value pairs that defines the tags for an // application, campaign, message template, or segment. Each of these resources can - // have a maximum of 50 tags. Each tag consists of a required tag key and an - // associated tag value. The maximum length of a tag key is 128 characters. The - // maximum length of a tag value is 256 characters. + // have a maximum of 50 tags. + // + // Each tag consists of a required tag key and an associated tag value. The + // maximum length of a tag key is 128 characters. The maximum length of a tag value + // is 256 characters. // // This member is required. Tags map[string]string @@ -6096,11 +6297,12 @@ type Template struct { // The unique identifier for the version of the message template to use for the // message. If specified, this value must match the identifier for an existing // template version. To retrieve a list of versions and version identifiers for a - // template, use the Template Versions resource. If you don't specify a value for - // this property, Amazon Pinpoint uses the active version of the template. The - // active version is typically the version of a template that's been most recently - // reviewed and approved for use, depending on your workflow. It isn't necessarily - // the latest version of a template. + // template, use the Template Versions resource. + // + // If you don't specify a value for this property, Amazon Pinpoint uses the active + // version of the template. The active version is typically the version of a + // template that's been most recently reviewed and approved for use, depending on + // your workflow. It isn't necessarily the latest version of a template. Version *string noSmithyDocumentSerde @@ -6381,17 +6583,21 @@ type UpdateRecommenderConfigurationShape struct { // depending on the value for the RecommendationProviderIdType property. Each of // these attributes temporarily stores a recommended item that's retrieved from the // recommender model and sent to an AWS Lambda function for additional processing. - // Each attribute can be used as a message variable in a message template. In the - // map, the key is the name of a custom attribute and the value is a custom display - // 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: + // Each attribute can be used as a message variable in a message template. + // + // In the map, the key is the name of a custom attribute and the value is a custom + // display 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. @@ -6411,9 +6617,11 @@ 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 @@ -6431,19 +6639,23 @@ type UpdateRecommenderConfigurationShape struct { // endpoint or user, depending on the value for the RecommendationProviderIdType // property. This value is required if the configuration doesn't invoke an AWS // Lambda function (RecommendationTransformerUri) to perform additional processing - // of recommendation data. This name appears in the Attribute finder of the - // template editor on the Amazon Pinpoint console. The name can contain up to 25 - // characters. The characters can be letters, numbers, spaces, underscores (_), or - // hyphens (-). These restrictions don't apply to attribute values. + // of recommendation data. + // + // This name appears in the Attribute finder of the template editor on the Amazon + // Pinpoint console. The name can contain up to 25 characters. The characters can + // be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions + // don't apply to attribute values. RecommendationsDisplayName *string // The number of recommended items to retrieve from the model for each endpoint or // user, depending on the value for the RecommendationProviderIdType property. This // number determines how many recommended items are available for use in message // variables. The minimum value is 1. The maximum value is 5. The default value is - // 5. To use multiple recommended items and custom attributes with message - // variables, you have to use an AWS Lambda function (RecommendationTransformerUri) - // to perform additional processing of recommendation data. + // 5. + // + // To use multiple recommended items and custom attributes with message variables, + // you have to use an AWS Lambda function (RecommendationTransformerUri) to perform + // additional processing of recommendation data. RecommendationsPerMessage *int32 noSmithyDocumentSerde @@ -6537,9 +6749,9 @@ type VoiceMessage struct { Body *string // 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) - // . + // script. For a list of supported languages and the code for each one, see the [Amazon Polly Developer Guide]. + // + // [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 @@ -6553,8 +6765,9 @@ 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]. + // + // [Amazon Polly Developer Guide]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html VoiceId *string noSmithyDocumentSerde @@ -6578,27 +6791,31 @@ 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]. + // + // [Amazon Polly Developer Guide]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html LanguageCode *string // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the message template. Each tag consists of a - // required tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the message template. Each tag consists of a required tag key and + // an associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string // A custom description of the message template. 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]. + // + // [Amazon Polly Developer Guide]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html VoiceId *string noSmithyDocumentSerde @@ -6644,8 +6861,9 @@ 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]. + // + // [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 @@ -6662,8 +6880,9 @@ type VoiceTemplateResponse struct { 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 message template. For a list of supported voices, see the [Amazon Polly Developer Guide]. + // + // [Amazon Polly Developer Guide]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html VoiceId *string noSmithyDocumentSerde @@ -6708,9 +6927,10 @@ 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. + // 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. @@ -6731,19 +6951,24 @@ 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. + // 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 @@ -6802,13 +7027,15 @@ type WriteCampaignRequest struct { // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the campaign. Each tag consists of a required - // tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the campaign. Each tag consists of a required tag key and an + // associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string // The message template to use for the campaign. @@ -6832,9 +7059,11 @@ type WriteEventStream struct { // The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon // Kinesis Data Firehose delivery stream that you want to publish event data to. + // // For a Kinesis data stream, the ARN format is: - // arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose - // delivery stream, the ARN format is: + // arn:aws:kinesis:region:account-id:stream/stream_name + // + // For a Kinesis Data Firehose delivery stream, the ARN format is: // arn:aws:firehose:region:account-id:deliverystream/stream_name // // This member is required. @@ -6894,12 +7123,16 @@ 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. QuietTime *QuietTime @@ -6928,27 +7161,34 @@ 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. State State - // An array of time zone estimation methods, if any, to use for determining an - // Endpoints (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html) + // An array of time zone estimation methods, if any, to use for determining an [Endpoints] // time zone if the Endpoint does not have a value for the Demographic.Timezone // attribute. + // // - PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and // Endpoint.Location.Country. + // // - POSTAL_CODE - A time zone is determined based on the - // Endpoint.Location.PostalCode and Endpoint.Location.Country. POSTAL_CODE - // detection is only supported in the United States, United Kingdom, Australia, New - // Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon - // Pinpoint is available. + // Endpoint.Location.PostalCode and Endpoint.Location.Country. + // + // POSTAL_CODE detection is only supported in the United States, United Kingdom, + // Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions + // where Amazon Pinpoint is available. + // + // [Endpoints]: https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html TimezoneEstimationMethods []TimezoneEstimationMethodsElement // Specifies whether endpoints in quiet hours should enter a wait till the end of @@ -6976,13 +7216,15 @@ type WriteSegmentRequest struct { // As of 22-05-2023 tags has been deprecated for update operations. After this // date any value in tags is not processed and an error code is not returned. To - // manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html) - // in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html) - // commands in the AWS Command Line Interface Documentation or - // resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html) - // in the AWS SDK. (Deprecated) A string-to-string map of key-value pairs that - // defines the tags to associate with the segment. Each tag consists of a required - // tag key and an associated tag value. + // manage tags we recommend using either [Tags]in the API Reference for Amazon Pinpoint, [resourcegroupstaggingapi] + // commands in the AWS Command Line Interface Documentation or [resourcegroupstaggingapi]in the AWS SDK. + // + // (Deprecated) A string-to-string map of key-value pairs that defines the tags to + // associate with the segment. Each tag consists of a required tag key and an + // associated tag value. + // + // [resourcegroupstaggingapi]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html + // [Tags]: https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html Tags map[string]string noSmithyDocumentSerde diff --git a/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go b/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go index e3fb577c7ce..27f01947ab4 100644 --- a/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go +++ b/service/pinpointemail/api_op_CreateConfigurationSetEventDestination.go @@ -16,8 +16,9 @@ import ( // 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. A single configuration set can include more -// than one event destination. +// Amazon S3 for long-term storage. +// +// A single configuration set can include more than one event destination. func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, params *CreateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*CreateConfigurationSetEventDestinationOutput, error) { if params == nil { params = &CreateConfigurationSetEventDestinationInput{} diff --git a/service/pinpointemail/api_op_CreateEmailIdentity.go b/service/pinpointemail/api_op_CreateEmailIdentity.go index fe2961f5232..a0cc4795c10 100644 --- a/service/pinpointemail/api_op_CreateEmailIdentity.go +++ b/service/pinpointemail/api_op_CreateEmailIdentity.go @@ -16,13 +16,17 @@ import ( // you can use an identity to send email with Amazon Pinpoint, you first have to // verify it. By verifying an address, you demonstrate that you're the owner of the // address, and that you've given Amazon Pinpoint permission to send email from the -// address. When you verify an email address, Amazon Pinpoint sends an email to the +// address. +// +// When you verify an email address, Amazon Pinpoint sends an email to the // address. Your email address is verified as soon as you follow the link in the -// verification email. When you verify a domain, this operation provides a set of -// DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens -// to the DNS configuration for your domain. Your domain is verified when Amazon -// Pinpoint detects these records in the DNS configuration for your domain. It -// usually takes around 72 hours to complete the domain verification process. +// verification email. +// +// When you verify a domain, this operation provides a set of DKIM tokens, which +// you can convert into CNAME tokens. You add these CNAME tokens to the DNS +// configuration for your domain. Your domain is verified when Amazon Pinpoint +// detects these records in the DNS configuration for your domain. It usually takes +// around 72 hours to complete the domain verification process. func (c *Client) CreateEmailIdentity(ctx context.Context, params *CreateEmailIdentityInput, optFns ...func(*Options)) (*CreateEmailIdentityOutput, error) { if params == nil { params = &CreateEmailIdentityInput{} @@ -56,8 +60,9 @@ type CreateEmailIdentityInput struct { // If the email identity is a domain, this object contains tokens that you can use // to create a set of CNAME records. To sucessfully verify your domain, you have to -// add these records to the DNS configuration for your domain. If the email -// identity is an email address, this object is empty. +// add these records to the DNS configuration for your domain. +// +// If the email identity is an email address, this object is empty. type CreateEmailIdentityOutput struct { // An object that contains information about the DKIM attributes for the identity. @@ -70,8 +75,9 @@ 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]. + // + // [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 77a2e409f2b..9f31ebd48a8 100644 --- a/service/pinpointemail/api_op_DeleteConfigurationSet.go +++ b/service/pinpointemail/api_op_DeleteConfigurationSet.go @@ -10,11 +10,13 @@ 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 -// 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. +// 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. func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error) { if params == nil { params = &DeleteConfigurationSetInput{} diff --git a/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go b/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go index 34c394ba953..4fdec49a107 100644 --- a/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go +++ b/service/pinpointemail/api_op_DeleteConfigurationSetEventDestination.go @@ -10,12 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an event destination. In Amazon Pinpoint, 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. +// Delete an event destination. +// +// In Amazon Pinpoint, 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) DeleteConfigurationSetEventDestination(ctx context.Context, params *DeleteConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*DeleteConfigurationSetEventDestinationOutput, error) { if params == nil { params = &DeleteConfigurationSetEventDestinationInput{} diff --git a/service/pinpointemail/api_op_GetAccount.go b/service/pinpointemail/api_op_GetAccount.go index 3e2289063c1..1c4c6baa9bb 100644 --- a/service/pinpointemail/api_op_GetAccount.go +++ b/service/pinpointemail/api_op_GetAccount.go @@ -44,11 +44,14 @@ 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 @@ -56,14 +59,18 @@ type GetAccountOutput struct { 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 - // 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 - // account vary based on your specific use case. + // 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 account vary based on your specific use + // case. ProductionAccessEnabled bool // An object that contains information about the per-day and per-second sending diff --git a/service/pinpointemail/api_op_GetConfigurationSet.go b/service/pinpointemail/api_op_GetConfigurationSet.go index b9270dcc4b5..c51f5f7bed5 100644 --- a/service/pinpointemail/api_op_GetConfigurationSet.go +++ b/service/pinpointemail/api_op_GetConfigurationSet.go @@ -13,11 +13,13 @@ import ( // Get information about an existing configuration set, including the dedicated IP // pool that it's associated with, whether or not it's enabled for sending email, -// and more. 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. +// and more. +// +// 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. func (c *Client) GetConfigurationSet(ctx context.Context, params *GetConfigurationSetInput, optFns ...func(*Options)) (*GetConfigurationSetOutput, error) { if params == nil { params = &GetConfigurationSetInput{} diff --git a/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go b/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go index c529c41d5e1..9882873c60a 100644 --- a/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go +++ b/service/pinpointemail/api_op_GetConfigurationSetEventDestinations.go @@ -12,8 +12,10 @@ import ( ) // Retrieve a list of event destinations that are associated with a configuration -// set. In Amazon Pinpoint, events include message sends, deliveries, opens, -// clicks, bounces, and complaints. Event destinations are places that you can send +// set. +// +// In Amazon Pinpoint, 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 diff --git a/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go b/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go index af71b2c2783..46757aef006 100644 --- a/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go +++ b/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go @@ -16,11 +16,14 @@ import ( // Amazon Pinpoint account. When the Deliverability dashboard is enabled, 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/) -// . +// 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]. +// +// [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{} @@ -40,11 +43,14 @@ func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params * // Amazon Pinpoint account. When the Deliverability dashboard is enabled, 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/) -// . +// 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]. +// +// [Amazon Pinpoint Pricing]: http://aws.amazon.com/pinpoint/pricing/ type GetDeliverabilityDashboardOptionsInput struct { noSmithyDocumentSerde } diff --git a/service/pinpointemail/api_op_GetEmailIdentity.go b/service/pinpointemail/api_op_GetEmailIdentity.go index 33f009a860d..c9b7a2f5414 100644 --- a/service/pinpointemail/api_op_GetEmailIdentity.go +++ b/service/pinpointemail/api_op_GetEmailIdentity.go @@ -48,16 +48,18 @@ 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 , - // 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 - // 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 - // an email notification when these events occur (even if this setting is - // disabled). + // 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 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 an email notification when these + // events occur (even if this setting is disabled). FeedbackForwardingStatus bool // The email identity type. @@ -73,8 +75,9 @@ 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]. + // + // [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 0fa84b2957a..1b8f2d817b5 100644 --- a/service/pinpointemail/api_op_ListConfigurationSets.go +++ b/service/pinpointemail/api_op_ListConfigurationSets.go @@ -11,11 +11,13 @@ import ( ) // List all of the configuration sets associated with your Amazon Pinpoint account -// in the current region. 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. +// in the current region. +// +// 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. func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigurationSetsInput, optFns ...func(*Options)) (*ListConfigurationSetsOutput, error) { if params == nil { params = &ListConfigurationSetsInput{} diff --git a/service/pinpointemail/api_op_ListDeliverabilityTestReports.go b/service/pinpointemail/api_op_ListDeliverabilityTestReports.go index 8e2a44f51d7..66bd4e73f51 100644 --- a/service/pinpointemail/api_op_ListDeliverabilityTestReports.go +++ b/service/pinpointemail/api_op_ListDeliverabilityTestReports.go @@ -41,8 +41,9 @@ type ListDeliverabilityTestReportsInput 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 // 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. + // obtain additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. PageSize *int32 noSmithyDocumentSerde @@ -160,8 +161,9 @@ 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 // 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. + // obtain additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/pinpointemail/api_op_ListEmailIdentities.go b/service/pinpointemail/api_op_ListEmailIdentities.go index 85d6ac3193d..ea3772a804d 100644 --- a/service/pinpointemail/api_op_ListEmailIdentities.go +++ b/service/pinpointemail/api_op_ListEmailIdentities.go @@ -43,8 +43,9 @@ type ListEmailIdentitiesInput struct { // 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 - // more than 1000. + // additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. PageSize *int32 noSmithyDocumentSerde @@ -160,8 +161,9 @@ type ListEmailIdentitiesPaginatorOptions struct { // 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 - // more than 1000. + // additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/pinpointemail/api_op_PutAccountSendingAttributes.go b/service/pinpointemail/api_op_PutAccountSendingAttributes.go index 554227333f9..c3e3356c5b4 100644 --- a/service/pinpointemail/api_op_PutAccountSendingAttributes.go +++ b/service/pinpointemail/api_op_PutAccountSendingAttributes.go @@ -30,9 +30,10 @@ func (c *Client) PutAccountSendingAttributes(ctx context.Context, params *PutAcc type PutAccountSendingAttributesInput struct { // Enables or disables your account's ability to send email. Set to true to enable - // email sending, or set to false to disable email sending. If AWS paused your - // account's ability to send email, you can't use this operation to resume your - // account's ability to send email. + // email sending, or set to false to disable email sending. + // + // If AWS paused your account's ability to send email, you can't use this + // operation to resume your account's ability to send email. SendingEnabled bool noSmithyDocumentSerde diff --git a/service/pinpointemail/api_op_PutDedicatedIpInPool.go b/service/pinpointemail/api_op_PutDedicatedIpInPool.go index 7db7a7198e7..8a5a33a8de4 100644 --- a/service/pinpointemail/api_op_PutDedicatedIpInPool.go +++ b/service/pinpointemail/api_op_PutDedicatedIpInPool.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP -// address that you specify must already exist, and must be associated with your -// Amazon Pinpoint account. The dedicated IP pool you specify must already exist. -// You can create a new pool by using the CreateDedicatedIpPool operation. +// Move a dedicated IP address to an existing dedicated IP pool. +// +// The dedicated IP address that you specify must already exist, and must be +// associated with your Amazon Pinpoint account. +// +// The dedicated IP pool you specify must already exist. You can create a new pool +// by using the CreateDedicatedIpPool operation. func (c *Client) PutDedicatedIpInPool(ctx context.Context, params *PutDedicatedIpInPoolInput, optFns ...func(*Options)) (*PutDedicatedIpInPoolOutput, error) { if params == nil { params = &PutDedicatedIpInPoolInput{} diff --git a/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go b/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go index 9c05bb7f41a..18b08dd91d1 100644 --- a/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go +++ b/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go @@ -15,11 +15,14 @@ import ( // 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/) -// . +// 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]. +// +// [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{} @@ -39,11 +42,14 @@ func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *P // 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/) -// . +// 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]. +// +// [Amazon Pinpoint Pricing]: http://aws.amazon.com/pinpoint/pricing/ type PutDeliverabilityDashboardOptionInput struct { // Specifies whether to enable the Deliverability dashboard for your Amazon diff --git a/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go b/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go index 8662249c83e..876b15d730d 100644 --- a/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go +++ b/service/pinpointemail/api_op_PutEmailIdentityDkimAttributes.go @@ -35,10 +35,11 @@ type PutEmailIdentityDkimAttributesInput struct { // This member is required. 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 - // Pinpoint sends from the identity aren't DKIM-signed. + // 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 Pinpoint sends from the identity aren't DKIM-signed. SigningEnabled bool noSmithyDocumentSerde diff --git a/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go b/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go index 99a9bc1c797..fbadd055469 100644 --- a/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go +++ b/service/pinpointemail/api_op_PutEmailIdentityFeedbackAttributes.go @@ -12,15 +12,19 @@ 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. When you enable feedback forwarding, 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 disable feedback forwarding, -// Amazon Pinpoint sends notifications through other mechanisms, such as by -// notifying an Amazon SNS topic. 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 an email notification -// when these events occur (even if this setting is disabled). +// in a bounce or complaint event. +// +// When you enable feedback forwarding, 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 disable feedback forwarding, Amazon Pinpoint sends notifications +// through other mechanisms, such as by notifying an Amazon SNS topic. 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 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{} @@ -46,16 +50,18 @@ type PutEmailIdentityFeedbackAttributesInput struct { // This member is required. 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 - // 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 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 an email notification when these events occur (even if this - // setting is disabled). + // Sets 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 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 an email notification when these + // events occur (even if this setting is disabled). EmailForwardingEnabled bool noSmithyDocumentSerde diff --git a/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go b/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go index 9fec2ea451a..2a5d99c0fee 100644 --- a/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go +++ b/service/pinpointemail/api_op_PutEmailIdentityMailFromAttributes.go @@ -41,15 +41,19 @@ type PutEmailIdentityMailFromAttributesInput struct { // 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 - // 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. + // 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 + // 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 diff --git a/service/pinpointemail/api_op_SendEmail.go b/service/pinpointemail/api_op_SendEmail.go index 11814a9ef3f..dd8ade8733d 100644 --- a/service/pinpointemail/api_op_SendEmail.go +++ b/service/pinpointemail/api_op_SendEmail.go @@ -13,9 +13,11 @@ 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. @@ -77,10 +79,12 @@ type SendEmailInput struct { type SendEmailOutput struct { // A unique identifier for the message that is generated when Amazon Pinpoint - // accepts the message. It is possible for Amazon Pinpoint to accept a message - // without sending it. This can happen when the message you're trying to send has - // an attachment doesn't pass a virus check, or when you send a templated email - // that contains invalid personalization content, for example. + // accepts the message. + // + // It is possible for Amazon Pinpoint to accept a message without sending it. This + // can happen when the message you're trying to send has an attachment doesn't pass + // a virus check, or when you send a templated email that contains invalid + // personalization content, for example. MessageId *string // Metadata pertaining to the operation's result. diff --git a/service/pinpointemail/api_op_TagResource.go b/service/pinpointemail/api_op_TagResource.go index 40a51a85ba9..3ffb801b2ee 100644 --- a/service/pinpointemail/api_op_TagResource.go +++ b/service/pinpointemail/api_op_TagResource.go @@ -15,10 +15,11 @@ import ( // 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. +// 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{} diff --git a/service/pinpointemail/api_op_UntagResource.go b/service/pinpointemail/api_op_UntagResource.go index 0d0866b485a..49cbdcda802 100644 --- a/service/pinpointemail/api_op_UntagResource.go +++ b/service/pinpointemail/api_op_UntagResource.go @@ -35,8 +35,9 @@ type UntagResourceInput struct { ResourceArn *string // The tags (tag keys) that you want to remove from the resource. When you specify - // a tag key, the action removes both that key and its associated tag value. To - // remove more than one tag from the resource, append the TagKeys parameter and + // a tag key, the action removes both that key and its associated tag value. + // + // To remove more than one tag from the resource, append the TagKeys parameter and // argument for each additional tag to remove, separated by an ampersand. For // example: /v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2 // diff --git a/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go b/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go index 557a5b85f42..bc21422f60d 100644 --- a/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/pinpointemail/api_op_UpdateConfigurationSetEventDestination.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the configuration of an event destination for a configuration set. In -// Amazon Pinpoint, events include message sends, deliveries, opens, clicks, +// Update the configuration of an event destination for a configuration set. +// +// In Amazon Pinpoint, 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 diff --git a/service/pinpointemail/doc.go b/service/pinpointemail/doc.go index c9b033fe81c..ab2f89aaca8 100644 --- a/service/pinpointemail/doc.go +++ b/service/pinpointemail/doc.go @@ -3,34 +3,42 @@ // Package pinpointemail provides the API client, operations, and parameter types // for Amazon Pinpoint Email Service. // -// Amazon Pinpoint Email Service Welcome to the Amazon Pinpoint Email API -// Reference. This guide provides information about the Amazon Pinpoint Email API -// (version 1.0), including supported operations, data types, parameters, and -// schemas. Amazon Pinpoint (https://aws.amazon.com/pinpoint) is an AWS service -// that you can use to engage with your customers across multiple messaging -// channels. You can use Amazon Pinpoint to send email, SMS text messages, voice -// messages, and push notifications. The Amazon Pinpoint Email API provides -// 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) +// # Amazon Pinpoint Email Service +// +// Welcome to the Amazon Pinpoint Email API Reference. This guide provides +// information about the Amazon Pinpoint Email API (version 1.0), including +// supported operations, data types, parameters, and schemas. +// +// [Amazon Pinpoint]is an AWS service that you can use to engage with your customers across +// multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text +// messages, voice messages, and push notifications. The Amazon Pinpoint Email API +// provides 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] // . 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/) -// . +// 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]in the Amazon Web +// Services General Reference. To learn more about AWS Regions, see [Managing AWS Regions]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]. +// +// [Amazon Pinpoint Developer Guide]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html +// [AWS Service Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region +// [Managing AWS Regions]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html +// [Amazon Pinpoint]: https://aws.amazon.com/pinpoint +// [AWS Global Infrastructure]: http://aws.amazon.com/about-aws/global-infrastructure/ package pinpointemail diff --git a/service/pinpointemail/options.go b/service/pinpointemail/options.go index a6031918084..85907bf9629 100644 --- a/service/pinpointemail/options.go +++ b/service/pinpointemail/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pinpointemail/types/enums.go b/service/pinpointemail/types/enums.go index b2c51077367..950fd0287fd 100644 --- a/service/pinpointemail/types/enums.go +++ b/service/pinpointemail/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BehaviorOnMxFailure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BehaviorOnMxFailure) Values() []BehaviorOnMxFailure { return []BehaviorOnMxFailure{ "USE_DEFAULT_VALUE", @@ -31,8 +32,9 @@ const ( // Values returns all known values for DeliverabilityDashboardAccountStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliverabilityDashboardAccountStatus) Values() []DeliverabilityDashboardAccountStatus { return []DeliverabilityDashboardAccountStatus{ "ACTIVE", @@ -51,6 +53,7 @@ const ( // 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{ @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for DimensionValueSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionValueSource) Values() []DimensionValueSource { return []DimensionValueSource{ "MESSAGE_TAG", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for DkimStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DkimStatus) Values() []DkimStatus { return []DkimStatus{ "PENDING", @@ -118,8 +123,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -143,8 +149,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -164,8 +171,9 @@ const ( ) // Values returns all known values for MailFromDomainStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MailFromDomainStatus) Values() []MailFromDomainStatus { return []MailFromDomainStatus{ "PENDING", @@ -184,8 +192,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -202,8 +211,9 @@ const ( ) // 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. +// expanded in the future, and so 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 2b7e0c4ac64..1b1ea44e526 100644 --- a/service/pinpointemail/types/types.go +++ b/service/pinpointemail/types/types.go @@ -61,8 +61,10 @@ 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. // // This member is required. @@ -70,8 +72,10 @@ type CloudWatchDimensionConfiguration struct { // 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. // // This member is required. @@ -143,8 +147,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. // @@ -233,15 +239,20 @@ type DkimAttributes struct { // 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. Status DkimStatus @@ -377,19 +388,26 @@ 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. + // + // - 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) - // . + // characters. This restriction is defined in [RFC 5321]. + // + // [RFC 5321]: https://tools.ietf.org/html/rfc5321 Raw *RawMessage // The simple email message. The message consists of a subject and a message body. @@ -427,9 +445,10 @@ type EventDestination struct { // 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 - // the event destination is disabled, events aren't sent to the specified - // destinations. + // EventDestinationDefinition . + // + // If false , the event destination is disabled. When the event destination is + // disabled, events aren't sent to the specified destinations. Enabled bool // An object that defines an Amazon Kinesis Data Firehose destination for email @@ -462,9 +481,10 @@ type EventDestinationDefinition struct { // 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 - // the event destination is disabled, events aren't sent to the specified - // destinations. + // EventDestinationDefinition . + // + // If false , the event destination is disabled. When the event destination is + // disabled, events aren't sent to the specified destinations. Enabled bool // An object that defines an Amazon Kinesis Data Firehose destination for email @@ -495,16 +515,20 @@ 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. IdentityType IdentityType - // Indicates whether or not you can send email from the identity. In Amazon - // Pinpoint, 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 Pinpoint to send email from that - // identity. + // Indicates whether or not you can send email from the identity. + // + // In Amazon Pinpoint, 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 Pinpoint to send email + // from that identity. SendingEnabled bool noSmithyDocumentSerde @@ -566,9 +590,10 @@ type MailFromAttributes struct { // 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 - // TemporaryFailure states. + // 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 @@ -579,11 +604,15 @@ type MailFromAttributes struct { 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. // @@ -605,8 +634,9 @@ 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]. + // + // [RFC 2047]: https://tools.ietf.org/html/rfc2047 // // This member is required. Subject *Content @@ -620,8 +650,10 @@ 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. // // This member is required. @@ -629,8 +661,10 @@ type MessageTag struct { // 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. // // This member is required. @@ -700,18 +734,25 @@ 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. + // + // - 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) - // . + // characters. This restriction is defined in [RFC 5321]. + // + // [RFC 5321]: https://tools.ietf.org/html/rfc5321 // // This member is required. Data []byte @@ -771,9 +812,9 @@ type SendQuota struct { 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) - // . + // email events to. For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html // // This member is required. TopicArn *string @@ -785,20 +826,26 @@ type SnsDestination struct { // 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 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: +// 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 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. 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 @@ -839,8 +886,9 @@ type Template struct { // An object that defines the tracking options for a configuration set. When you // use Amazon Pinpoint to send an email, it contains an invisible image that's used // to track when recipients open your email. If your email contains links, those -// links are changed slightly in order to track when recipients click them. These -// images and links include references to a domain operated by AWS. You can +// links are changed slightly in order to track when recipients click them. +// +// These images and links include references to a domain operated by AWS. You can // optionally configure Amazon Pinpoint to use a domain that you operate for these // images and links. type TrackingOptions struct { diff --git a/service/pinpointsmsvoice/options.go b/service/pinpointsmsvoice/options.go index a0f22871ffa..74ae6fb9423 100644 --- a/service/pinpointsmsvoice/options.go +++ b/service/pinpointsmsvoice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pinpointsmsvoice/types/enums.go b/service/pinpointsmsvoice/types/enums.go index 2934295cd91..9d48685e590 100644 --- a/service/pinpointsmsvoice/types/enums.go +++ b/service/pinpointsmsvoice/types/enums.go @@ -16,8 +16,9 @@ const ( ) // 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. +// in the future, and so 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/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go b/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go index c7e45f142bb..fe9bead3e54 100644 --- a/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go +++ b/service/pinpointsmsvoicev2/api_op_AssociateOriginationIdentity.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates the specified origination identity with a pool. If the origination -// identity is a phone number and is already associated with another pool, an error -// is returned. A sender ID can be associated with multiple pools. If the -// origination identity configuration doesn't match the pool's configuration, an -// error is returned. +// Associates the specified origination identity with a pool. +// +// If the origination identity is a phone number and is already associated with +// another pool, an error is returned. A sender ID can be associated with multiple +// pools. +// +// If the origination identity configuration doesn't match the pool's +// configuration, an error is returned. func (c *Client) AssociateOriginationIdentity(ctx context.Context, params *AssociateOriginationIdentityInput, optFns ...func(*Options)) (*AssociateOriginationIdentityOutput, error) { if params == nil { params = &AssociateOriginationIdentityInput{} @@ -39,15 +42,15 @@ type AssociateOriginationIdentityInput struct { IsoCountryCode *string // 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. + // SenderId, or SenderIdArn. You can use DescribePhoneNumbersto find the values for PhoneNumberId and + // PhoneNumberArn, while DescribeSenderIdscan 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 . + // or PoolArn, and you can find these values using DescribePools. // // This member is required. PoolId *string @@ -62,7 +65,8 @@ type AssociateOriginationIdentityInput struct { type AssociateOriginationIdentityOutput struct { - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. IsoCountryCode *string // The PhoneNumberId or SenderId of the origination identity. diff --git a/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go b/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go index 3a7119c3964..55cb8f2f277 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go +++ b/service/pinpointsmsvoicev2/api_op_CreateConfigurationSet.go @@ -13,9 +13,12 @@ import ( ) // 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. +// 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{} @@ -58,8 +61,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // An array of key and value pair tags that's associated with the configuration diff --git a/service/pinpointsmsvoicev2/api_op_CreateEventDestination.go b/service/pinpointsmsvoicev2/api_op_CreateEventDestination.go index 681238b8a65..4070abd406e 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateEventDestination.go +++ b/service/pinpointsmsvoicev2/api_op_CreateEventDestination.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new event destination in a configuration set. An event destination is -// a location where you send message events. The event options are Amazon -// CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a -// message is delivered successfully, you can send information about that event to -// an event destination, or send notifications to endpoints that are subscribed to -// an Amazon SNS topic. Each configuration set can contain between 0 and 5 event -// destinations. Each event destination can contain a reference to a single -// destination, such as a CloudWatch or Kinesis Data Firehose destination. +// Creates a new event destination in a configuration set. +// +// An event destination is a location where you send message events. The event +// options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For +// example, when a message is delivered successfully, you can send information +// about that event to an event destination, or send notifications to endpoints +// that are subscribed to an Amazon SNS topic. +// +// Each configuration set can contain between 0 and 5 event destinations. Each +// event destination can contain a reference to a single destination, such as a +// CloudWatch or Kinesis Data Firehose destination. func (c *Client) CreateEventDestination(ctx context.Context, params *CreateEventDestinationInput, optFns ...func(*Options)) (*CreateEventDestinationOutput, error) { if params == nil { params = &CreateEventDestinationInput{} @@ -38,7 +41,7 @@ type CreateEventDestinationInput struct { // Either the name of the configuration set or the configuration set ARN to apply // event logging to. The ConfigurateSetName and ConfigurationSetArn can be found - // using the DescribeConfigurationSets action. + // using the DescribeConfigurationSetsaction. // // This member is required. ConfigurationSetName *string @@ -49,8 +52,9 @@ type CreateEventDestinationInput struct { EventDestinationName *string // An array of event types that determine which events to log. If "ALL" is used, - // then Amazon Pinpoint logs every event type. The TEXT_SENT event type is not - // supported. + // then Amazon Pinpoint logs every event type. + // + // The TEXT_SENT event type is not supported. // // This member is required. MatchingEventTypes []types.EventType diff --git a/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go b/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go index 10c135ae875..8d5132f16cc 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go +++ b/service/pinpointsmsvoicev2/api_op_CreateOptOutList.go @@ -12,13 +12,18 @@ 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) -// in the Amazon Pinpoint User Guide. +// 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]in the Amazon Pinpoint +// User Guide. +// +// [SMS opt out]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout func (c *Client) CreateOptOutList(ctx context.Context, params *CreateOptOutListInput, optFns ...func(*Options)) (*CreateOptOutListOutput, error) { if params == nil { params = &CreateOptOutListInput{} @@ -54,8 +59,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ 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 a2bf1943fea..5006d4c69b4 100644 --- a/service/pinpointsmsvoicev2/api_op_CreatePool.go +++ b/service/pinpointsmsvoicev2/api_op_CreatePool.go @@ -14,13 +14,16 @@ import ( // Creates a new pool and associates the specified origination identity to the // pool. A pool can include one or more phone numbers and SenderIds that are -// associated with your Amazon Web Services account. The new pool inherits its -// configuration from the specified origination identity. This includes keywords, -// message type, opt-out list, two-way configuration, and self-managed opt-out -// configuration. Deletion protection isn't inherited from the origination identity -// and defaults to false. If the origination identity is a phone number and is -// already associated with another pool, an error is returned. A sender ID can be -// associated with multiple pools. +// associated with your Amazon Web Services account. +// +// The new pool inherits its configuration from the specified origination +// identity. This includes keywords, message type, opt-out list, two-way +// configuration, and self-managed opt-out configuration. Deletion protection isn't +// inherited from the origination identity and defaults to false. +// +// If the origination identity is a phone number and is already associated with +// another pool, an error is returned. A sender ID can be associated with multiple +// pools. func (c *Client) CreatePool(ctx context.Context, params *CreatePoolInput, optFns ...func(*Options)) (*CreatePoolOutput, error) { if params == nil { params = &CreatePoolInput{} @@ -52,9 +55,8 @@ 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 DescribePhoneNumbersto find the values for PhoneNumberId and + // PhoneNumberArn while DescribeSenderIdscan be used to get the values for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string @@ -65,7 +67,7 @@ type CreatePoolInput struct { 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. + // You can change this value using the UpdatePoolaction. DeletionProtectionEnabled *bool // An array of tags (key and value pairs) associated with the pool. @@ -76,8 +78,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // When set to true deletion protection is enabled. By default this is set to @@ -108,9 +111,12 @@ 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. Status types.PoolStatus diff --git a/service/pinpointsmsvoicev2/api_op_CreateProtectConfiguration.go b/service/pinpointsmsvoicev2/api_op_CreateProtectConfiguration.go index d5c6a690164..590ae91e71d 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateProtectConfiguration.go +++ b/service/pinpointsmsvoicev2/api_op_CreateProtectConfiguration.go @@ -57,8 +57,9 @@ type CreateProtectConfigurationOutput struct { // This member is required. AccountDefault bool - // The time when the protect configuration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the protect configuration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/api_op_CreateRegistration.go b/service/pinpointsmsvoicev2/api_op_CreateRegistration.go index 3d0de793b4a..e8ea88c3dc5 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateRegistration.go +++ b/service/pinpointsmsvoicev2/api_op_CreateRegistration.go @@ -31,7 +31,7 @@ func (c *Client) CreateRegistration(ctx context.Context, params *CreateRegistrat type CreateRegistrationInput struct { // The type of registration form to create. The list of RegistrationTypes can be - // found using the DescribeRegistrationTypeDefinitions action. + // found using the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string @@ -49,8 +49,9 @@ type CreateRegistrationInput struct { type CreateRegistrationOutput struct { - // The time when the registration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -71,23 +72,31 @@ type CreateRegistrationOutput struct { RegistrationId *string // The status of the registration. + // // - CREATED : Your registration is created but not submitted. + // // - SUBMITTED : Your registration has been submitted and is awaiting review. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - PROVISIONING : Your registration has been approved and your origination // identity is being created. + // // - COMPLETE : Your registration has been approved and and your origination // identity has been created. + // // - REQUIRES_UPDATES : You must fix your registration and resubmit it. + // // - CLOSED : The phone number or sender ID has been deleted and you must also // delete the registration for the number. + // // - DELETED : The registration has been deleted. // // This member is required. RegistrationStatus types.RegistrationStatus // The type of registration form to create. The list of RegistrationTypes can be - // found using the DescribeRegistrationTypeDefinitions action. + // found using the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string diff --git a/service/pinpointsmsvoicev2/api_op_CreateRegistrationAssociation.go b/service/pinpointsmsvoicev2/api_op_CreateRegistrationAssociation.go index c9064673785..a4b88d9bb8c 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateRegistrationAssociation.go +++ b/service/pinpointsmsvoicev2/api_op_CreateRegistrationAssociation.go @@ -56,7 +56,7 @@ type CreateRegistrationAssociationOutput struct { RegistrationId *string // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string diff --git a/service/pinpointsmsvoicev2/api_op_CreateRegistrationAttachment.go b/service/pinpointsmsvoicev2/api_op_CreateRegistrationAttachment.go index 42a42793949..7e11cbf39d1 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateRegistrationAttachment.go +++ b/service/pinpointsmsvoicev2/api_op_CreateRegistrationAttachment.go @@ -56,16 +56,21 @@ type CreateRegistrationAttachmentInput struct { type CreateRegistrationAttachmentOutput struct { // The status of the registration attachment. + // // - UPLOAD_IN_PROGRESS The attachment is being uploaded. + // // - UPLOAD_COMPLETE The attachment has been uploaded. + // // - UPLOAD_FAILED The attachment failed to uploaded. + // // - DELETED The attachment has been deleted.. // // This member is required. AttachmentStatus types.AttachmentStatus - // The time when the registration attachment was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration attachment was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/api_op_CreateRegistrationVersion.go b/service/pinpointsmsvoicev2/api_op_CreateRegistrationVersion.go index 816be500a53..854ee1aa6de 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateRegistrationVersion.go +++ b/service/pinpointsmsvoicev2/api_op_CreateRegistrationVersion.go @@ -51,14 +51,22 @@ type CreateRegistrationVersionOutput struct { RegistrationId *string // The status of the registration. + // // - DRAFT : The initial status of a registration version after it’s created. + // // - SUBMITTED : Your registration has been submitted. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - APPROVED : Your registration has been approved. + // // - DISCARDED : You've abandon this version of their registration to start over // with a new version. + // // - DENIED : You must fix your registration and resubmit it. + // // - REVOKED : Your previously approved registration has been revoked. + // // - ARCHIVED : Your previously approved registration version moves into this // status when a more recently submitted version is approved. // diff --git a/service/pinpointsmsvoicev2/api_op_CreateVerifiedDestinationNumber.go b/service/pinpointsmsvoicev2/api_op_CreateVerifiedDestinationNumber.go index b51373ec48d..88388d14296 100644 --- a/service/pinpointsmsvoicev2/api_op_CreateVerifiedDestinationNumber.go +++ b/service/pinpointsmsvoicev2/api_op_CreateVerifiedDestinationNumber.go @@ -49,8 +49,9 @@ type CreateVerifiedDestinationNumberInput struct { type CreateVerifiedDestinationNumberOutput struct { - // The time when the verified phone number was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the verified phone number was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -61,7 +62,9 @@ type CreateVerifiedDestinationNumberOutput struct { DestinationPhoneNumber *string // The status of the verified destination phone number. + // // - PENDING : The phone number hasn't been verified yet. + // // - VERIFIED : The phone number is verified and can receive messages. // // This member is required. diff --git a/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go b/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go index e265667902a..9a1c9c3602f 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteConfigurationSet.go @@ -12,10 +12,11 @@ import ( "time" ) -// Deletes an existing configuration set. A configuration set is a set of rules -// that you apply to voice and SMS messages that you send. In a configuration set, -// you can specify a destination for specific types of events related to voice and -// SMS messages. +// Deletes an existing configuration set. +// +// A configuration set is a set of rules that you apply to voice and SMS messages +// that you send. In a configuration set, you can specify a destination for +// specific types of events related to voice and SMS messages. func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error) { if params == nil { params = &DeleteConfigurationSetInput{} @@ -34,8 +35,8 @@ func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfi type DeleteConfigurationSetInput struct { // The name of the configuration set or the configuration set ARN that you want to - // delete. The ConfigurationSetName and ConfigurationSetArn can be found using the - // DescribeConfigurationSets action. + // delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets + // action. // // This member is required. ConfigurationSetName *string @@ -51,8 +52,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // The default message type of the configuration set that was deleted. diff --git a/service/pinpointsmsvoicev2/api_op_DeleteDefaultMessageType.go b/service/pinpointsmsvoicev2/api_op_DeleteDefaultMessageType.go index 6cce27035e6..cfa1845098b 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteDefaultMessageType.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteDefaultMessageType.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing default message type on a configuration set. A message type -// is a type of messages that you plan to send. 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. +// Deletes an existing default message type on a configuration set. +// +// A message type is a type of messages that you plan to send. 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) DeleteDefaultMessageType(ctx context.Context, params *DeleteDefaultMessageTypeInput, optFns ...func(*Options)) (*DeleteDefaultMessageTypeOutput, error) { if params == nil { params = &DeleteDefaultMessageTypeInput{} @@ -36,7 +37,7 @@ type DeleteDefaultMessageTypeInput struct { // The name of the configuration set or the configuration set Amazon Resource Name // (ARN) to delete the default message type from. The ConfigurationSetName and - // ConfigurationSetArn can be found using the DescribeConfigurationSets action. + // ConfigurationSetArn can be found using the DescribeConfigurationSetsaction. // // This member is required. ConfigurationSetName *string diff --git a/service/pinpointsmsvoicev2/api_op_DeleteDefaultSenderId.go b/service/pinpointsmsvoicev2/api_op_DeleteDefaultSenderId.go index cc9c5aa7b0e..9685a1ace27 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteDefaultSenderId.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteDefaultSenderId.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing default sender ID on a configuration set. A default sender -// ID is the identity that appears on recipients' devices when they receive SMS -// messages. Support for sender ID capabilities varies by country or region. +// Deletes an existing default sender ID on a configuration set. +// +// A default sender ID is the identity that appears on recipients' devices when +// they receive SMS messages. Support for sender ID capabilities varies by country +// or region. func (c *Client) DeleteDefaultSenderId(ctx context.Context, params *DeleteDefaultSenderIdInput, optFns ...func(*Options)) (*DeleteDefaultSenderIdOutput, error) { if params == nil { params = &DeleteDefaultSenderIdInput{} @@ -32,7 +34,7 @@ type DeleteDefaultSenderIdInput struct { // The name of the configuration set or the configuration set Amazon Resource Name // (ARN) to delete the default sender ID from. The ConfigurationSetName and - // ConfigurationSetArn can be found using the DescribeConfigurationSets action. + // ConfigurationSetArn can be found using the DescribeConfigurationSetsaction. // // This member is required. ConfigurationSetName *string diff --git a/service/pinpointsmsvoicev2/api_op_DeleteEventDestination.go b/service/pinpointsmsvoicev2/api_op_DeleteEventDestination.go index 2ec9a1de12c..84853eeacc4 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteEventDestination.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteEventDestination.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing event destination. An event destination is a location where -// you send response information about the messages that you send. For example, -// when a message is delivered successfully, you can send information about that -// event to an Amazon CloudWatch destination, or send notifications to endpoints -// that are subscribed to an Amazon SNS topic. +// Deletes an existing event destination. +// +// An event destination is a location where you send response information about +// the messages that you send. For example, when a message is delivered +// successfully, you can send information about that event to an Amazon CloudWatch +// destination, or send notifications to endpoints that are subscribed to an Amazon +// SNS topic. func (c *Client) DeleteEventDestination(ctx context.Context, params *DeleteEventDestinationInput, optFns ...func(*Options)) (*DeleteEventDestinationOutput, error) { if params == nil { params = &DeleteEventDestinationInput{} @@ -35,7 +37,7 @@ type DeleteEventDestinationInput struct { // The name of the configuration set or the configuration set's Amazon Resource // Name (ARN) to remove the event destination from. The ConfigurateSetName and - // ConfigurationSetArn can be found using the DescribeConfigurationSets action. + // ConfigurationSetArn can be found using the DescribeConfigurationSetsaction. // // This member is required. ConfigurationSetName *string diff --git a/service/pinpointsmsvoicev2/api_op_DeleteKeyword.go b/service/pinpointsmsvoicev2/api_op_DeleteKeyword.go index 3236c331626..07eb11bfb84 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteKeyword.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteKeyword.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an existing keyword from an origination phone number or pool. A keyword -// is a word that you can search for on a particular phone number or pool. It is -// also a specific word or phrase that an end user can send to your number to -// elicit a response, such as an informational message or a special offer. When -// your number receives a message that begins with a keyword, Amazon Pinpoint -// responds with a customizable message. Keywords "HELP" and "STOP" can't be -// deleted or modified. +// Deletes an existing keyword from an origination phone number or pool. +// +// A keyword is a word that you can search for on a particular phone number or +// pool. It is also a specific word or phrase that an end user can send to your +// number to elicit a response, such as an informational message or a special +// offer. When your number receives a message that begins with a keyword, Amazon +// Pinpoint responds with a customizable message. +// +// Keywords "HELP" and "STOP" can't be deleted or modified. func (c *Client) DeleteKeyword(ctx context.Context, params *DeleteKeywordInput, optFns ...func(*Options)) (*DeleteKeywordOutput, error) { if params == nil { params = &DeleteKeywordInput{} @@ -41,9 +43,8 @@ type DeleteKeywordInput struct { Keyword *string // The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId - // or PoolArn. You can use DescribePhoneNumbers to find the values for - // PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId - // and PoolArn. + // or PoolArn. You can use DescribePhoneNumbersto find the values for PhoneNumberId and PhoneNumberArn + // and DescribePoolsto find the values of PoolId and PoolArn. // // This member is required. OriginationIdentity *string diff --git a/service/pinpointsmsvoicev2/api_op_DeleteMediaMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_DeleteMediaMessageSpendLimitOverride.go index d3bf35bea67..5cd3200b700 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteMediaMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteMediaMessageSpendLimitOverride.go @@ -13,8 +13,10 @@ import ( // Deletes an account-level monthly spending limit override for sending multimedia // messages (MMS). 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 Quotas for Server Migration Service (https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html) -// in the Server Migration Service User Guide. +// information on spend limits (quotas) see [Quotas for Server Migration Service]in the Server Migration Service User +// Guide. +// +// [Quotas for Server Migration Service]: https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html func (c *Client) DeleteMediaMessageSpendLimitOverride(ctx context.Context, params *DeleteMediaMessageSpendLimitOverrideInput, optFns ...func(*Options)) (*DeleteMediaMessageSpendLimitOverrideOutput, error) { if params == nil { params = &DeleteMediaMessageSpendLimitOverrideInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go b/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go index 46759e7c8ae..97ea91206db 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteOptOutList.go @@ -12,8 +12,10 @@ import ( ) // Deletes an existing opt-out list. All opted out phone numbers in the opt-out -// list are deleted. If the specified opt-out list name doesn't exist or is in-use -// by an origination phone number or pool, an error is returned. +// list are deleted. +// +// If the specified opt-out list name doesn't exist or is in-use by an origination +// phone number or pool, an error is returned. func (c *Client) DeleteOptOutList(ctx context.Context, params *DeleteOptOutListInput, optFns ...func(*Options)) (*DeleteOptOutListOutput, error) { if params == nil { params = &DeleteOptOutListInput{} @@ -31,8 +33,8 @@ func (c *Client) DeleteOptOutList(ctx context.Context, params *DeleteOptOutListI type DeleteOptOutListInput struct { - // The OptOutListName or OptOutListArn of the OptOutList to delete. You can use - // DescribeOptOutLists to find the values for OptOutListName and OptOutListArn. + // The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists + // to find the values for OptOutListName and OptOutListArn. // // This member is required. OptOutListName *string @@ -42,8 +44,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ 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 332962a21c4..ff559931a4d 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteOptedOutNumber.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteOptedOutNumber.go @@ -12,9 +12,12 @@ import ( ) // Deletes an existing opted out destination phone number from the specified -// opt-out list. Each destination phone number can only be deleted once every 30 -// days. If the specified destination phone number doesn't exist or if the opt-out -// list doesn't exist, an error is returned. +// opt-out list. +// +// Each destination phone number can only be deleted once every 30 days. +// +// If the specified destination phone number doesn't exist or if the opt-out list +// doesn't exist, an error is returned. func (c *Client) DeleteOptedOutNumber(ctx context.Context, params *DeleteOptedOutNumberInput, optFns ...func(*Options)) (*DeleteOptedOutNumberOutput, error) { if params == nil { params = &DeleteOptedOutNumberInput{} @@ -47,7 +50,8 @@ type DeleteOptedOutNumberInput struct { type DeleteOptedOutNumberOutput struct { - // This is true if it was the end user who requested their phone number be removed. + // This is true if it was the end user who requested their phone number be + // removed. EndUserOptedOut bool // The OptOutListArn that the phone number was removed from. @@ -59,8 +63,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ 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 cfee581ad7f..a7ad73ce990 100644 --- a/service/pinpointsmsvoicev2/api_op_DeletePool.go +++ b/service/pinpointsmsvoicev2/api_op_DeletePool.go @@ -13,10 +13,14 @@ import ( ) // Deletes an existing pool. Deleting a pool disassociates all origination -// identities from that pool. If the pool status isn't active or if deletion -// protection is enabled, an error is returned. A pool is a collection of phone -// numbers and SenderIds. A pool can include one or more phone numbers and -// SenderIds that are associated with your Amazon Web Services account. +// identities from that pool. +// +// If the pool status isn't active or if deletion protection is enabled, an error +// is returned. +// +// A pool is a collection of phone numbers and SenderIds. A pool can include one +// or more phone numbers and SenderIds that are associated with your Amazon Web +// Services account. func (c *Client) DeletePool(ctx context.Context, params *DeletePoolInput, optFns ...func(*Options)) (*DeletePoolOutput, error) { if params == nil { params = &DeletePoolInput{} @@ -34,8 +38,8 @@ func (c *Client) DeletePool(ctx context.Context, params *DeletePoolInput, optFns type DeletePoolInput struct { - // The PoolId or PoolArn of the pool to delete. You can use DescribePools to find - // the values for PoolId and PoolArn . + // The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values + // for PoolId and PoolArn . // // This member is required. PoolId *string @@ -45,8 +49,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // The message type that was associated with the deleted pool. @@ -73,9 +78,12 @@ 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. Status types.PoolStatus diff --git a/service/pinpointsmsvoicev2/api_op_DeleteProtectConfiguration.go b/service/pinpointsmsvoicev2/api_op_DeleteProtectConfiguration.go index a653c916d1f..9eef40646d1 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteProtectConfiguration.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteProtectConfiguration.go @@ -47,8 +47,9 @@ type DeleteProtectConfigurationOutput struct { // This member is required. AccountDefault bool - // The time when the protect configuration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the protect configuration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/api_op_DeleteRegistration.go b/service/pinpointsmsvoicev2/api_op_DeleteRegistration.go index c22eb996626..42f50ce87b9 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteRegistration.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteRegistration.go @@ -40,8 +40,9 @@ type DeleteRegistrationInput struct { type DeleteRegistrationOutput struct { - // The time when the registration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -62,23 +63,31 @@ type DeleteRegistrationOutput struct { RegistrationId *string // The status of the registration. + // // - CREATED : Your registration is created but not submitted. + // // - SUBMITTED : Your registration has been submitted and is awaiting review. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - PROVISIONING : Your registration has been approved and your origination // identity is being created. + // // - COMPLETE : Your registration has been approved and and your origination // identity has been created. + // // - REQUIRES_UPDATES : You must fix your registration and resubmit it. + // // - CLOSED : The phone number or sender ID has been deleted and you must also // delete the registration for the number. + // // - DELETED : The registration has been deleted. // // This member is required. RegistrationStatus types.RegistrationStatus // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string diff --git a/service/pinpointsmsvoicev2/api_op_DeleteRegistrationAttachment.go b/service/pinpointsmsvoicev2/api_op_DeleteRegistrationAttachment.go index 34a7e8d52de..f93ed5147b7 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteRegistrationAttachment.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteRegistrationAttachment.go @@ -41,16 +41,21 @@ type DeleteRegistrationAttachmentInput struct { type DeleteRegistrationAttachmentOutput struct { // The status of the registration attachment. + // // - UPLOAD_IN_PROGRESS The attachment is being uploaded. + // // - UPLOAD_COMPLETE The attachment has been uploaded. + // // - UPLOAD_FAILED The attachment failed to uploaded. + // // - DELETED The attachment has been deleted.. // // This member is required. AttachmentStatus types.AttachmentStatus - // The time when the registration attachment was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration attachment was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/api_op_DeleteRegistrationFieldValue.go b/service/pinpointsmsvoicev2/api_op_DeleteRegistrationFieldValue.go index 75a0ec59db7..bd790e230a3 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteRegistrationFieldValue.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteRegistrationFieldValue.go @@ -28,8 +28,7 @@ func (c *Client) DeleteRegistrationFieldValue(ctx context.Context, params *Delet type DeleteRegistrationFieldValueInput struct { - // The path to the registration form field. You can use - // DescribeRegistrationFieldDefinitions for a list of FieldPaths. + // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string diff --git a/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go index f1b9caa0f3b..33a998d6b62 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteTextMessageSpendLimitOverride.go @@ -13,8 +13,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. +// on spend limits (quotas) see [Amazon Pinpoint quotas]in the Amazon Pinpoint Developer Guide. +// +// [Amazon Pinpoint quotas]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html 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_DeleteVerifiedDestinationNumber.go b/service/pinpointsmsvoicev2/api_op_DeleteVerifiedDestinationNumber.go index 30b17b28b5b..5b10053e8e9 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteVerifiedDestinationNumber.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteVerifiedDestinationNumber.go @@ -39,8 +39,9 @@ type DeleteVerifiedDestinationNumberInput struct { type DeleteVerifiedDestinationNumberOutput struct { - // The time when the destination phone number was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the destination phone number was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go b/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go index da19cf1c81b..ee0d1df8b6a 100644 --- a/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go +++ b/service/pinpointsmsvoicev2/api_op_DeleteVoiceMessageSpendLimitOverride.go @@ -13,8 +13,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. +// spending limits (quotas) see [Amazon Pinpoint quotas]in the Amazon Pinpoint Developer Guide. +// +// [Amazon Pinpoint quotas]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html 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_DescribeAccountAttributes.go b/service/pinpointsmsvoicev2/api_op_DescribeAccountAttributes.go index f70b21a7014..9260fa9922d 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeAccountAttributes.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeAccountAttributes.go @@ -15,9 +15,11 @@ import ( // attributes include account tier, which indicates whether your account is in the // sandbox or production environment. When you're ready to move your account out of // the sandbox, create an Amazon Web Services Support case for a service limit -// increase request. New Amazon Pinpoint accounts are placed into an SMS or voice -// sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or -// voice recipients from fraud and abuse. +// increase request. +// +// New Amazon Pinpoint accounts are placed into an SMS or voice sandbox. The +// sandbox protects both Amazon Web Services end recipients and SMS or voice +// recipients from fraud and abuse. func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { params = &DescribeAccountAttributesInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go b/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go index 04cf5e2a3e3..9f635c21199 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeAccountLimits.go @@ -13,11 +13,14 @@ import ( // Describes the current Amazon Pinpoint SMS Voice V2 resource quotas for your // account. The description for a quota includes the quota name, current usage -// 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. +// 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]in the Amazon Pinpoint Developer Guide. +// +// [Amazon Pinpoint quotas]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/quotas.html 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_DescribeConfigurationSets.go b/service/pinpointsmsvoicev2/api_op_DescribeConfigurationSets.go index 7e1b879a8ef..6931d62350b 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeConfigurationSets.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeConfigurationSets.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified configuration sets or all in your account. If you -// specify configuration set names, the output includes information for only the -// specified configuration sets. If you specify filters, the output includes -// information for only those configuration sets that meet the filter criteria. If -// you don't specify configuration set names or filters, the output includes -// information for all configuration sets. If you specify a configuration set name -// that isn't valid, an error is returned. +// Describes the specified configuration sets or all in your account. +// +// If you specify configuration set names, the output includes information for +// only the specified configuration sets. If you specify filters, the output +// includes information for only those configuration sets that meet the filter +// criteria. If you don't specify configuration set names or filters, the output +// includes information for all configuration sets. +// +// If you specify a configuration set name that isn't valid, an error is returned. func (c *Client) DescribeConfigurationSets(ctx context.Context, params *DescribeConfigurationSetsInput, optFns ...func(*Options)) (*DescribeConfigurationSetsOutput, error) { if params == nil { params = &DescribeConfigurationSetsInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go b/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go index cf3fb5fdc9c..9ef412085e8 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeKeywords.go @@ -12,12 +12,15 @@ import ( ) // Describes the specified keywords or all keywords on your origination phone -// number or pool. A keyword is a word that you can search for on a particular -// phone number or pool. It is also a specific word or phrase that an end user can -// send to your number to elicit a response, such as an informational message or a -// special offer. When your number receives a message that begins with a keyword, -// Amazon Pinpoint responds with a customizable message. If you specify a keyword -// that isn't valid, an error is returned. +// number or pool. +// +// A keyword is a word that you can search for on a particular phone number or +// pool. It is also a specific word or phrase that an end user can send to your +// number to elicit a response, such as an informational message or a special +// offer. When your number receives a message that begins with a keyword, Amazon +// Pinpoint responds with a customizable message. +// +// If you specify a keyword that isn't valid, an error is returned. func (c *Client) DescribeKeywords(ctx context.Context, params *DescribeKeywordsInput, optFns ...func(*Options)) (*DescribeKeywordsOutput, error) { if params == nil { params = &DescribeKeywordsInput{} @@ -36,9 +39,8 @@ 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 DescribePhoneNumbersto find the values for PhoneNumberId and + // PhoneNumberArn while DescribeSenderIdscan 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 62f807e0ef1..4c6fc3866f5 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeOptOutLists.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeOptOutLists.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified opt-out list or all opt-out lists in your account. If -// you specify opt-out list names, the output includes information for only the +// Describes the specified opt-out list or all opt-out lists in your account. +// +// If you specify opt-out list names, the output includes information for only the // specified opt-out lists. Opt-out lists include only those that meet the filter // criteria. If you don't specify opt-out list names or filters, the output -// includes information for all opt-out lists. If you specify an opt-out list name -// that isn't valid, an error is returned. +// includes information for all opt-out lists. +// +// If you specify an opt-out list name that isn't valid, an error is returned. func (c *Client) DescribeOptOutLists(ctx context.Context, params *DescribeOptOutListsInput, optFns ...func(*Options)) (*DescribeOptOutListsOutput, error) { if params == nil { params = &DescribeOptOutListsInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribeOptedOutNumbers.go b/service/pinpointsmsvoicev2/api_op_DescribeOptedOutNumbers.go index 30a90af3151..f78f79559d2 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeOptedOutNumbers.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeOptedOutNumbers.go @@ -12,13 +12,15 @@ import ( ) // Describes the specified opted out destination numbers or all opted out -// destination numbers in an opt-out list. If you specify opted out numbers, the -// output includes information for only the specified opted out numbers. If you -// specify filters, the output includes information for only those opted out -// numbers that meet the filter criteria. If you don't specify opted out numbers or -// filters, the output includes information for all opted out destination numbers -// in your opt-out list. If you specify an opted out number that isn't valid, an -// error is returned. +// destination numbers in an opt-out list. +// +// If you specify opted out numbers, the output includes information for only the +// specified opted out numbers. If you specify filters, the output includes +// information for only those opted out numbers that meet the filter criteria. If +// you don't specify opted out numbers or filters, the output includes information +// for all opted out destination numbers in your opt-out list. +// +// If you specify an opted out number that isn't valid, an error is returned. func (c *Client) DescribeOptedOutNumbers(ctx context.Context, params *DescribeOptedOutNumbersInput, optFns ...func(*Options)) (*DescribeOptedOutNumbersOutput, error) { if params == nil { params = &DescribeOptedOutNumbersInput{} @@ -36,8 +38,8 @@ func (c *Client) DescribeOptedOutNumbers(ctx context.Context, params *DescribeOp type DescribeOptedOutNumbersInput struct { - // The OptOutListName or OptOutListArn of the OptOutList. You can use - // DescribeOptOutLists to find the values for OptOutListName and OptOutListArn. + // The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the + // values for OptOutListName and OptOutListArn. // // This member is required. OptOutListName *string diff --git a/service/pinpointsmsvoicev2/api_op_DescribePhoneNumbers.go b/service/pinpointsmsvoicev2/api_op_DescribePhoneNumbers.go index 254eb1933d7..287f5aec2fd 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribePhoneNumbers.go +++ b/service/pinpointsmsvoicev2/api_op_DescribePhoneNumbers.go @@ -12,12 +12,15 @@ import ( ) // Describes the specified origination phone number, or all the phone numbers in -// your account. If you specify phone number IDs, the output includes information -// for only the specified phone numbers. If you specify filters, the output -// includes information for only those phone numbers that meet the filter criteria. -// If you don't specify phone number IDs or filters, the output includes -// information for all phone numbers. If you specify a phone number ID that isn't -// valid, an error is returned. +// your account. +// +// If you specify phone number IDs, the output includes information for only the +// specified phone numbers. If you specify filters, the output includes information +// for only those phone numbers that meet the filter criteria. If you don't specify +// phone number IDs or filters, the output includes information for all phone +// numbers. +// +// If you specify a phone number ID that isn't valid, an error is returned. func (c *Client) DescribePhoneNumbers(ctx context.Context, params *DescribePhoneNumbersInput, optFns ...func(*Options)) (*DescribePhoneNumbersOutput, error) { if params == nil { params = &DescribePhoneNumbersInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribePools.go b/service/pinpointsmsvoicev2/api_op_DescribePools.go index 6ee37398a52..dcf9a0d8995 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribePools.go +++ b/service/pinpointsmsvoicev2/api_op_DescribePools.go @@ -12,13 +12,18 @@ import ( ) // Retrieves the specified pools or all pools associated with your Amazon Web -// Services account. If you specify pool IDs, the output includes information for -// only the specified pools. If you specify filters, the output includes -// information for only those pools that meet the filter criteria. If you don't -// specify pool IDs or filters, the output includes information for all pools. If -// you specify a pool ID that isn't valid, an error is returned. A pool is a -// collection of phone numbers and SenderIds. A pool can include one or more phone -// numbers and SenderIds that are associated with your Amazon Web Services account. +// Services account. +// +// If you specify pool IDs, the output includes information for only the specified +// pools. If you specify filters, the output includes information for only those +// pools that meet the filter criteria. If you don't specify pool IDs or filters, +// the output includes information for all pools. +// +// If you specify a pool ID that isn't valid, an error is returned. +// +// A pool is a collection of phone numbers and SenderIds. A pool can include one +// or more phone numbers and SenderIds that are associated with your Amazon Web +// Services account. func (c *Client) DescribePools(ctx context.Context, params *DescribePoolsInput, optFns ...func(*Options)) (*DescribePoolsOutput, error) { if params == nil { params = &DescribePoolsInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DescribeRegistrationFieldDefinitions.go b/service/pinpointsmsvoicev2/api_op_DescribeRegistrationFieldDefinitions.go index 6442928759c..faf84c0eeb2 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeRegistrationFieldDefinitions.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeRegistrationFieldDefinitions.go @@ -32,7 +32,7 @@ func (c *Client) DescribeRegistrationFieldDefinitions(ctx context.Context, param type DescribeRegistrationFieldDefinitionsInput struct { // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string @@ -62,7 +62,7 @@ type DescribeRegistrationFieldDefinitionsOutput struct { RegistrationFieldDefinitions []types.RegistrationFieldDefinition // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string diff --git a/service/pinpointsmsvoicev2/api_op_DescribeRegistrationSectionDefinitions.go b/service/pinpointsmsvoicev2/api_op_DescribeRegistrationSectionDefinitions.go index bd389f62988..ce282bdbb54 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeRegistrationSectionDefinitions.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeRegistrationSectionDefinitions.go @@ -32,7 +32,7 @@ func (c *Client) DescribeRegistrationSectionDefinitions(ctx context.Context, par type DescribeRegistrationSectionDefinitionsInput struct { // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string @@ -58,7 +58,7 @@ type DescribeRegistrationSectionDefinitionsOutput struct { RegistrationSectionDefinitions []types.RegistrationSectionDefinition // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string diff --git a/service/pinpointsmsvoicev2/api_op_DescribeRegistrationTypeDefinitions.go b/service/pinpointsmsvoicev2/api_op_DescribeRegistrationTypeDefinitions.go index 5352e49c1a4..c9edd48f086 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeRegistrationTypeDefinitions.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeRegistrationTypeDefinitions.go @@ -42,7 +42,7 @@ type DescribeRegistrationTypeDefinitionsInput struct { NextToken *string // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. RegistrationTypes []string noSmithyDocumentSerde @@ -51,7 +51,7 @@ type DescribeRegistrationTypeDefinitionsInput struct { type DescribeRegistrationTypeDefinitionsOutput struct { // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationTypeDefinitions []types.RegistrationTypeDefinition diff --git a/service/pinpointsmsvoicev2/api_op_DescribeSenderIds.go b/service/pinpointsmsvoicev2/api_op_DescribeSenderIds.go index e13d9648a98..a3a7c7ff966 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeSenderIds.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeSenderIds.go @@ -12,10 +12,13 @@ import ( ) // Describes the specified SenderIds or all SenderIds associated with your Amazon -// Web Services account. If you specify SenderIds, the output includes information -// for only the specified SenderIds. If you specify filters, the output includes -// information for only those SenderIds that meet the filter criteria. If you don't -// specify SenderIds or filters, the output includes information for all SenderIds. +// Web Services account. +// +// If you specify SenderIds, the output includes information for only the +// specified SenderIds. If you specify filters, the output includes information for +// only those SenderIds that meet the filter criteria. If you don't specify +// SenderIds or filters, the output includes information for all SenderIds. +// // f you specify a sender ID that isn't valid, an error is returned. func (c *Client) DescribeSenderIds(ctx context.Context, params *DescribeSenderIdsInput, optFns ...func(*Options)) (*DescribeSenderIdsOutput, error) { if params == nil { diff --git a/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go b/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go index ec7adeed242..d719c3f9e73 100644 --- a/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go +++ b/service/pinpointsmsvoicev2/api_op_DescribeSpendLimits.go @@ -12,11 +12,13 @@ import ( ) // 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. +// 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]in the Amazon Pinpoint User Guide. +// +// [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 func (c *Client) DescribeSpendLimits(ctx context.Context, params *DescribeSpendLimitsInput, optFns ...func(*Options)) (*DescribeSpendLimitsOutput, error) { if params == nil { params = &DescribeSpendLimitsInput{} diff --git a/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go b/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go index bcbb1cb5f13..9efe1888f2f 100644 --- a/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go +++ b/service/pinpointsmsvoicev2/api_op_DisassociateOriginationIdentity.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes the specified origination identity from an existing pool. If the -// origination identity isn't associated with the specified pool, an error is -// returned. +// Removes the specified origination identity from an existing pool. +// +// If the origination identity isn't associated with the specified pool, an error +// is returned. func (c *Client) DisassociateOriginationIdentity(ctx context.Context, params *DisassociateOriginationIdentityInput, optFns ...func(*Options)) (*DisassociateOriginationIdentityOutput, error) { if params == nil { params = &DisassociateOriginationIdentityInput{} @@ -30,15 +31,15 @@ func (c *Client) DisassociateOriginationIdentity(ctx context.Context, params *Di type DisassociateOriginationIdentityInput struct { - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. // // This member is required. IsoCountryCode *string // 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. + // SenderId or SenderIdArn. You can use DescribePhoneNumbersfind the values for PhoneNumberId and + // PhoneNumberArn, or use DescribeSenderIdsto get the values for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string diff --git a/service/pinpointsmsvoicev2/api_op_DiscardRegistrationVersion.go b/service/pinpointsmsvoicev2/api_op_DiscardRegistrationVersion.go index 9281d4d20a9..4b49a7346d1 100644 --- a/service/pinpointsmsvoicev2/api_op_DiscardRegistrationVersion.go +++ b/service/pinpointsmsvoicev2/api_op_DiscardRegistrationVersion.go @@ -50,14 +50,22 @@ type DiscardRegistrationVersionOutput struct { RegistrationId *string // The status of the registration version. + // // - DRAFT : The initial status of a registration version after it’s created. + // // - SUBMITTED : Your registration has been submitted. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - APPROVED : Your registration has been approved. + // // - DISCARDED : You've abandon this version of their registration to start over // with a new version. + // // - DENIED : You must fix your registration and resubmit it. + // // - REVOKED : Your previously approved registration has been revoked. + // // - ARCHIVED : Your previously approved registration version moves into this // status when a more recently submitted version is approved. // diff --git a/service/pinpointsmsvoicev2/api_op_GetProtectConfigurationCountryRuleSet.go b/service/pinpointsmsvoicev2/api_op_GetProtectConfigurationCountryRuleSet.go index 58cb6444c7e..e6dfade701b 100644 --- a/service/pinpointsmsvoicev2/api_op_GetProtectConfigurationCountryRuleSet.go +++ b/service/pinpointsmsvoicev2/api_op_GetProtectConfigurationCountryRuleSet.go @@ -48,9 +48,10 @@ type GetProtectConfigurationCountryRuleSetOutput struct { // A map of ProtectConfigurationCountryRuleSetInformation objects that contain the // details for the requested NumberCapability. The Key is the two-letter ISO - // country code. For a list of supported ISO country codes, see Supported - // countries and regions (SMS channel) (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html) - // in the Amazon Pinpoint SMS user guide. + // country code. For a list of supported ISO country codes, see [Supported countries and regions (SMS channel)]in the Amazon + // Pinpoint SMS user guide. + // + // [Supported countries and regions (SMS channel)]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html // // This member is required. CountryRuleSet map[string]types.ProtectConfigurationCountryRuleSetInformation diff --git a/service/pinpointsmsvoicev2/api_op_ListPoolOriginationIdentities.go b/service/pinpointsmsvoicev2/api_op_ListPoolOriginationIdentities.go index 0f286df559f..d5c5ad1071d 100644 --- a/service/pinpointsmsvoicev2/api_op_ListPoolOriginationIdentities.go +++ b/service/pinpointsmsvoicev2/api_op_ListPoolOriginationIdentities.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all associated origination identities in your pool. If you specify -// filters, the output includes information for only those origination identities -// that meet the filter criteria. +// Lists all associated origination identities in your pool. +// +// If you specify filters, the output includes information for only those +// origination identities that meet the filter criteria. func (c *Client) ListPoolOriginationIdentities(ctx context.Context, params *ListPoolOriginationIdentitiesInput, optFns ...func(*Options)) (*ListPoolOriginationIdentitiesOutput, error) { if params == nil { params = &ListPoolOriginationIdentitiesInput{} diff --git a/service/pinpointsmsvoicev2/api_op_ListRegistrationAssociations.go b/service/pinpointsmsvoicev2/api_op_ListRegistrationAssociations.go index 022b4cec0f7..1682fa089bd 100644 --- a/service/pinpointsmsvoicev2/api_op_ListRegistrationAssociations.go +++ b/service/pinpointsmsvoicev2/api_op_ListRegistrationAssociations.go @@ -67,7 +67,7 @@ type ListRegistrationAssociationsOutput struct { RegistrationId *string // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string diff --git a/service/pinpointsmsvoicev2/api_op_PutKeyword.go b/service/pinpointsmsvoicev2/api_op_PutKeyword.go index 8503b90c226..f4ac82f7a76 100644 --- a/service/pinpointsmsvoicev2/api_op_PutKeyword.go +++ b/service/pinpointsmsvoicev2/api_op_PutKeyword.go @@ -12,12 +12,15 @@ import ( ) // Creates or updates a keyword configuration on an origination phone number or -// pool. A keyword is a word that you can search for on a particular phone number -// or pool. It is also a specific word or phrase that an end user can send to your +// pool. +// +// A keyword is a word that you can search for on a particular phone number or +// pool. It is also a specific word or phrase that an end user can send to your // number to elicit a response, such as an informational message or a special // offer. When your number receives a message that begins with a keyword, Amazon -// Pinpoint responds with a customizable message. If you specify a keyword that -// isn't valid, an error is returned. +// Pinpoint responds with a customizable message. +// +// If you specify a keyword that isn't valid, an error is returned. func (c *Client) PutKeyword(ctx context.Context, params *PutKeywordInput, optFns ...func(*Options)) (*PutKeywordOutput, error) { if params == nil { params = &PutKeywordInput{} @@ -46,16 +49,18 @@ type PutKeywordInput struct { KeywordMessage *string // The origination identity to use such as a PhoneNumberId, PhoneNumberArn, - // SenderId or SenderIdArn. You can use DescribePhoneNumbers get 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 DescribePhoneNumbersget the values for PhoneNumberId and + // PhoneNumberArn while DescribeSenderIdscan be used to get the values for SenderId and SenderIdArn. // // This member is required. OriginationIdentity *string // The action to perform for the new keyword when it is received. + // // - 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. KeywordAction types.KeywordAction diff --git a/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go b/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go index 8e43dbd0589..aacbb0d2e50 100644 --- a/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go +++ b/service/pinpointsmsvoicev2/api_op_PutOptedOutNumber.go @@ -11,9 +11,10 @@ import ( "time" ) -// Creates an opted out destination phone number in the opt-out list. If the -// destination phone number isn't valid or if the specified opt-out list doesn't -// exist, an error is returned. +// Creates an opted out destination phone number in the opt-out list. +// +// If the destination phone number isn't valid or if the specified opt-out list +// doesn't exist, an error is returned. func (c *Client) PutOptedOutNumber(ctx context.Context, params *PutOptedOutNumberInput, optFns ...func(*Options)) (*PutOptedOutNumberOutput, error) { if params == nil { params = &PutOptedOutNumberInput{} @@ -46,7 +47,8 @@ type PutOptedOutNumberInput struct { type PutOptedOutNumberOutput struct { - // This is true if it was the end user who requested their phone number be removed. + // This is true if it was the end user who requested their phone number be + // removed. EndUserOptedOut bool // The OptOutListArn that the phone number was removed from. @@ -58,8 +60,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ OptedOutTimestamp *time.Time // Metadata pertaining to the operation's result. diff --git a/service/pinpointsmsvoicev2/api_op_PutRegistrationFieldValue.go b/service/pinpointsmsvoicev2/api_op_PutRegistrationFieldValue.go index 0de2b67da27..a4b7cb16561 100644 --- a/service/pinpointsmsvoicev2/api_op_PutRegistrationFieldValue.go +++ b/service/pinpointsmsvoicev2/api_op_PutRegistrationFieldValue.go @@ -28,8 +28,7 @@ func (c *Client) PutRegistrationFieldValue(ctx context.Context, params *PutRegis type PutRegistrationFieldValueInput struct { - // The path to the registration form field. You can use - // DescribeRegistrationFieldDefinitions for a list of FieldPaths. + // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string @@ -53,8 +52,7 @@ type PutRegistrationFieldValueInput struct { type PutRegistrationFieldValueOutput struct { - // The path to the registration form field. You can use - // DescribeRegistrationFieldDefinitions for a list of FieldPaths. + // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string diff --git a/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go b/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go index 26dc2849d3e..f3ae31e76f0 100644 --- a/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go +++ b/service/pinpointsmsvoicev2/api_op_ReleasePhoneNumber.go @@ -13,9 +13,10 @@ import ( ) // Releases an existing origination phone number in your account. Once released, a -// phone number is no longer available for sending messages. If the origination -// phone number has deletion protection enabled or is associated with a pool, an -// error is returned. +// phone number is no longer available for sending messages. +// +// If the origination phone number has deletion protection enabled or is +// associated with a pool, an error is returned. func (c *Client) ReleasePhoneNumber(ctx context.Context, params *ReleasePhoneNumberInput, optFns ...func(*Options)) (*ReleasePhoneNumberOutput, error) { if params == nil { params = &ReleasePhoneNumberInput{} @@ -33,8 +34,8 @@ func (c *Client) ReleasePhoneNumber(ctx context.Context, params *ReleasePhoneNum type ReleasePhoneNumberInput struct { - // The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use - // DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn. + // The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers + // to get the values for PhoneNumberId and PhoneNumberArn. // // This member is required. PhoneNumberId *string @@ -44,8 +45,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ 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 2a868fdc6bf..55cb077ac59 100644 --- a/service/pinpointsmsvoicev2/api_op_RequestPhoneNumber.go +++ b/service/pinpointsmsvoicev2/api_op_RequestPhoneNumber.go @@ -13,8 +13,9 @@ 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) -// in the Amazon Pinpoint User Guide. +// information on phone number request see [Requesting a number]in the Amazon Pinpoint User Guide. +// +// [Requesting a number]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-request-number.html func (c *Client) RequestPhoneNumber(ctx context.Context, params *RequestPhoneNumberInput, optFns ...func(*Options)) (*RequestPhoneNumberOutput, error) { if params == nil { params = &RequestPhoneNumberInput{} @@ -32,7 +33,8 @@ func (c *Client) RequestPhoneNumber(ctx context.Context, params *RequestPhoneNum type RequestPhoneNumberInput struct { - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. // // This member is required. IsoCountryCode *string @@ -68,7 +70,8 @@ type RequestPhoneNumberInput struct { // OptOutListName or OptOutListArn. OptOutListName *string - // The pool to associated with the phone number. You can use the PoolId or PoolArn. + // The pool to associated with the phone number. You can use the PoolId or + // PoolArn. PoolId *string // Use this field to attach your phone number for an external registration process. @@ -83,15 +86,17 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // By default this is set to false. When set to true the phone number can't be // deleted. DeletionProtectionEnabled bool - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. IsoCountryCode *string // The type of message. Valid values are TRANSACTIONAL for messages that are diff --git a/service/pinpointsmsvoicev2/api_op_SendDestinationNumberVerificationCode.go b/service/pinpointsmsvoicev2/api_op_SendDestinationNumberVerificationCode.go index 10a772b2473..94147c541d1 100644 --- a/service/pinpointsmsvoicev2/api_op_SendDestinationNumberVerificationCode.go +++ b/service/pinpointsmsvoicev2/api_op_SendDestinationNumberVerificationCode.go @@ -14,8 +14,8 @@ import ( // Before you can send test messages to a verified destination phone number you // need to opt-in the verified destination phone number. Creates a new text message // with a verification code and send it to a verified destination phone number. -// Once you have the verification code use VerifyDestinationNumber to opt-in the -// verified destination phone number to receive messages. +// Once you have the verification code use VerifyDestinationNumberto opt-in the verified destination +// phone number to receive messages. func (c *Client) SendDestinationNumberVerificationCode(ctx context.Context, params *SendDestinationNumberVerificationCodeInput, optFns ...func(*Options)) (*SendDestinationNumberVerificationCodeOutput, error) { if params == nil { params = &SendDestinationNumberVerificationCodeInput{} @@ -53,9 +53,9 @@ type SendDestinationNumberVerificationCodeInput struct { // 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) - // . + // India using a sender ID. For more information see [Special requirements for sending SMS messages to recipients in India]. + // + // [Special requirements for sending SMS messages to recipients in India]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html DestinationCountryParameters map[string]string // Choose the language to use for the message. diff --git a/service/pinpointsmsvoicev2/api_op_SendMediaMessage.go b/service/pinpointsmsvoicev2/api_op_SendMediaMessage.go index 123cb253990..2801f27900f 100644 --- a/service/pinpointsmsvoicev2/api_op_SendMediaMessage.go +++ b/service/pinpointsmsvoicev2/api_op_SendMediaMessage.go @@ -55,13 +55,15 @@ type SendMediaMessageInput struct { // The maximum amount that you want to spend, in US dollars, per each MMS message. MaxPrice *string - // An array of URLs to each media file to send. The media files have to be stored - // in a publicly available S3 bucket. Supported media file formats are listed in - // MMS file types, size and character limits (https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html) - // . For more information on creating an S3 bucket and managing objects, see - // Creating a bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html) - // and Uploading objects (https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html) - // in the S3 user guide. + // An array of URLs to each media file to send. + // + // The media files have to be stored in a publicly available S3 bucket. Supported + // media file formats are listed in [MMS file types, size and character limits]. For more information on creating an S3 + // bucket and managing objects, see [Creating a bucket]and [Uploading objects] in the S3 user guide. + // + // [Creating a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html + // [MMS file types, size and character limits]: https://docs.aws.amazon.com/sms-voice/latest/userguide/mms-limitations-character.html + // [Uploading objects]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html MediaUrls []string // The text body of the message. diff --git a/service/pinpointsmsvoicev2/api_op_SendTextMessage.go b/service/pinpointsmsvoicev2/api_op_SendTextMessage.go index b898456e433..2c321387041 100644 --- a/service/pinpointsmsvoicev2/api_op_SendTextMessage.go +++ b/service/pinpointsmsvoicev2/api_op_SendTextMessage.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new text message and sends it to a recipient's phone number. SMS -// 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) -// in the Amazon Pinpoint User Guide. +// Creates a new text message and sends it to a recipient's phone number. +// +// SMS 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]in the Amazon Pinpoint User Guide. +// +// [Message Parts per Second (MPS) limits]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-limitations-mps.html func (c *Client) SendTextMessage(ctx context.Context, params *SendTextMessageInput, optFns ...func(*Options)) (*SendTextMessageOutput, error) { if params == nil { params = &SendTextMessageInput{} @@ -49,9 +51,9 @@ type SendTextMessageInput struct { // 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) - // . + // India using a sender ID. For more information see [Special requirements for sending SMS messages to recipients in India]. + // + // [Special requirements for 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 f1414e8d695..3fd1137a170 100644 --- a/service/pinpointsmsvoicev2/api_op_SendVoiceMessage.go +++ b/service/pinpointsmsvoicev2/api_op_SendVoiceMessage.go @@ -12,8 +12,9 @@ import ( ) // Allows you to send a request that sends a voice message through Amazon -// Pinpoint. This operation uses Amazon Polly (http://aws.amazon.com/polly/) to -// convert a text script into a voice message. +// Pinpoint. This operation uses [Amazon Polly]to convert a text script into a voice message. +// +// [Amazon Polly]: http://aws.amazon.com/polly/ func (c *Client) SendVoiceMessage(ctx context.Context, params *SendVoiceMessageInput, optFns ...func(*Options)) (*SendVoiceMessageOutput, error) { if params == nil { params = &SendVoiceMessageInput{} @@ -60,11 +61,14 @@ type SendVoiceMessageInput struct { // The text to convert to a voice message. 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) . + // Specifies if the MessageBody field contains text or [speech synthesis markup language (SSML)]. + // // - 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. + // + // [speech synthesis markup language (SSML)]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html MessageBodyTextType types.VoiceMessageBodyTextType // The unique identifier for the protect configuration. @@ -73,8 +77,9 @@ type SendVoiceMessageInput struct { // 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] service to use. By default this is set to "MATTHEW". + // + // [Amazon Polly]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html VoiceId types.VoiceId noSmithyDocumentSerde diff --git a/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go b/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go index 0b393d7b31c..f814832f375 100644 --- a/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go +++ b/service/pinpointsmsvoicev2/api_op_SetDefaultMessageType.go @@ -11,12 +11,13 @@ 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_SetDefaultSenderId.go b/service/pinpointsmsvoicev2/api_op_SetDefaultSenderId.go index 0f233e767a9..c34711ec9ed 100644 --- a/service/pinpointsmsvoicev2/api_op_SetDefaultSenderId.go +++ b/service/pinpointsmsvoicev2/api_op_SetDefaultSenderId.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets default sender ID on a configuration set. When sending a text message to a -// destination country that supports sender IDs, the default sender ID on the -// configuration set specified will be used if no dedicated origination phone -// numbers or registered sender IDs are available in your account. +// Sets default sender ID on a configuration set. +// +// When sending a text message to a destination country that supports sender IDs, +// the default sender ID on the configuration set specified will be used if no +// dedicated origination phone numbers or registered sender IDs are available in +// your account. func (c *Client) SetDefaultSenderId(ctx context.Context, params *SetDefaultSenderIdInput, optFns ...func(*Options)) (*SetDefaultSenderIdOutput, error) { if params == nil { params = &SetDefaultSenderIdInput{} @@ -39,9 +41,9 @@ type SetDefaultSenderIdInput struct { // The current sender ID for the configuration set. When sending a text message to // a destination country which supports SenderIds, the default sender ID on the - // configuration set specified on SendTextMessage will be used if no dedicated - // origination phone numbers or registered SenderIds are available in your account, - // instead of a generic sender ID, such as 'NOTICE'. + // configuration set specified on SendTextMessagewill be used if no dedicated origination phone + // numbers or registered SenderIds are available in your account, instead of a + // generic sender ID, such as 'NOTICE'. // // This member is required. SenderId *string diff --git a/service/pinpointsmsvoicev2/api_op_SubmitRegistrationVersion.go b/service/pinpointsmsvoicev2/api_op_SubmitRegistrationVersion.go index aa8d06584a4..ac0f69cb2c4 100644 --- a/service/pinpointsmsvoicev2/api_op_SubmitRegistrationVersion.go +++ b/service/pinpointsmsvoicev2/api_op_SubmitRegistrationVersion.go @@ -50,14 +50,22 @@ type SubmitRegistrationVersionOutput struct { RegistrationId *string // The status of the registration version. + // // - DRAFT : The initial status of a registration version after it’s created. + // // - SUBMITTED : Your registration has been submitted. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - APPROVED : Your registration has been approved. + // // - DISCARDED : You've abandon this version of their registration to start over // with a new version. + // // - DENIED : You must fix your registration and resubmit it. + // // - REVOKED : Your previously approved registration has been revoked. + // // - ARCHIVED : Your previously approved registration version moves into this // status when a more recently submitted version is approved. // diff --git a/service/pinpointsmsvoicev2/api_op_TagResource.go b/service/pinpointsmsvoicev2/api_op_TagResource.go index dd2a934a0c3..20d119c4a35 100644 --- a/service/pinpointsmsvoicev2/api_op_TagResource.go +++ b/service/pinpointsmsvoicev2/api_op_TagResource.go @@ -15,8 +15,10 @@ import ( // 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) -// in the Amazon Pinpoint Developer Guide. +// resource. For more information about tags, see [Tagging Amazon Pinpoint resources]in the Amazon Pinpoint Developer +// Guide. +// +// [Tagging Amazon Pinpoint resources]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/pinpointsmsvoicev2/api_op_UntagResource.go b/service/pinpointsmsvoicev2/api_op_UntagResource.go index d1bfd206cc9..b456346a131 100644 --- a/service/pinpointsmsvoicev2/api_op_UntagResource.go +++ b/service/pinpointsmsvoicev2/api_op_UntagResource.go @@ -11,8 +11,10 @@ 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) -// in the Amazon Pinpoint Developer Guide. +// V2 resource. For more information on tags see [Tagging Amazon Pinpoint resources]in the Amazon Pinpoint Developer +// Guide. +// +// [Tagging Amazon Pinpoint resources]: https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go b/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go index c83d1472d92..e6f5091c1a8 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go +++ b/service/pinpointsmsvoicev2/api_op_UpdateEventDestination.go @@ -13,10 +13,12 @@ import ( // 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. +// 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{} @@ -56,8 +58,9 @@ type UpdateEventDestinationInput struct { // Kinesis Data Firehose. KinesisFirehoseDestination *types.KinesisFirehoseDestination - // An array of event types that determine which events to log. The TEXT_SENT event - // type is not supported. + // An array of event types that determine which events to log. + // + // The TEXT_SENT event type is not supported. MatchingEventTypes []types.EventType // An object that contains information about an event destination that sends data diff --git a/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go b/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go index c9577c9c1b9..98d710d918f 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go +++ b/service/pinpointsmsvoicev2/api_op_UpdatePhoneNumber.go @@ -15,8 +15,9 @@ import ( // Updates the configuration of an existing origination phone number. You can // update the opt-out list, enable or disable two-way messaging, change the // TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable -// deletion protection. If the origination phone number is associated with a pool, -// an error is returned. +// deletion protection. +// +// If the origination phone number is associated with a pool, an error is returned. func (c *Client) UpdatePhoneNumber(ctx context.Context, params *UpdatePhoneNumberInput, optFns ...func(*Options)) (*UpdatePhoneNumberOutput, error) { if params == nil { params = &UpdatePhoneNumberInput{} @@ -72,14 +73,16 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // When set to true the phone number can't be deleted. DeletionProtectionEnabled bool - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. IsoCountryCode *string // The type of message. Valid values are TRANSACTIONAL for messages that are diff --git a/service/pinpointsmsvoicev2/api_op_UpdatePool.go b/service/pinpointsmsvoicev2/api_op_UpdatePool.go index 81caf810e15..3f7ea6ded94 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdatePool.go +++ b/service/pinpointsmsvoicev2/api_op_UpdatePool.go @@ -73,8 +73,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ CreatedTimestamp *time.Time // When set to true the pool can't be deleted. diff --git a/service/pinpointsmsvoicev2/api_op_UpdateProtectConfiguration.go b/service/pinpointsmsvoicev2/api_op_UpdateProtectConfiguration.go index af9977cef08..0919a579a91 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdateProtectConfiguration.go +++ b/service/pinpointsmsvoicev2/api_op_UpdateProtectConfiguration.go @@ -49,8 +49,9 @@ type UpdateProtectConfigurationOutput struct { // This member is required. AccountDefault bool - // The time when the protect configuration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the protect configuration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/api_op_UpdateProtectConfigurationCountryRuleSet.go b/service/pinpointsmsvoicev2/api_op_UpdateProtectConfigurationCountryRuleSet.go index ed29aa5d106..45a34b6b14e 100644 --- a/service/pinpointsmsvoicev2/api_op_UpdateProtectConfigurationCountryRuleSet.go +++ b/service/pinpointsmsvoicev2/api_op_UpdateProtectConfigurationCountryRuleSet.go @@ -33,9 +33,10 @@ type UpdateProtectConfigurationCountryRuleSetInput struct { // A map of ProtectConfigurationCountryRuleSetInformation objects that contain the // details for the requested NumberCapability. The Key is the two-letter ISO - // country code. For a list of supported ISO country codes, see Supported - // countries and regions (SMS channel) (https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html) - // in the Amazon Pinpoint SMS user guide. + // country code. For a list of supported ISO country codes, see [Supported countries and regions (SMS channel)]in the Amazon + // Pinpoint SMS user guide. + // + // [Supported countries and regions (SMS channel)]: https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html // // This member is required. CountryRuleSetUpdates map[string]types.ProtectConfigurationCountryRuleSetInformation diff --git a/service/pinpointsmsvoicev2/api_op_VerifyDestinationNumber.go b/service/pinpointsmsvoicev2/api_op_VerifyDestinationNumber.go index 188283439a6..6a643c49d3d 100644 --- a/service/pinpointsmsvoicev2/api_op_VerifyDestinationNumber.go +++ b/service/pinpointsmsvoicev2/api_op_VerifyDestinationNumber.go @@ -47,8 +47,9 @@ type VerifyDestinationNumberInput struct { type VerifyDestinationNumberOutput struct { - // The time when the destination phone number was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the destination phone number was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time diff --git a/service/pinpointsmsvoicev2/doc.go b/service/pinpointsmsvoicev2/doc.go index af972d595e8..d59c42dbd02 100644 --- a/service/pinpointsmsvoicev2/doc.go +++ b/service/pinpointsmsvoicev2/doc.go @@ -5,33 +5,42 @@ // // Welcome to the Amazon Pinpoint SMS and Voice, version 2 API Reference. This // guide provides information about Amazon Pinpoint SMS and Voice, version 2 API -// resources, including supported HTTP methods, parameters, and schemas. Amazon -// Pinpoint is an Amazon Web Services service that you can use to engage with your -// recipients across multiple messaging channels. The Amazon Pinpoint SMS and -// Voice, version 2 API provides programmatic access to options that are unique to -// the SMS and voice channels. Amazon Pinpoint SMS and Voice, version 2 resources -// such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon -// Pinpoint API. If you're new to Amazon Pinpoint SMS, it's also helpful to review -// the Amazon Pinpoint SMS User Guide (https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html) -// . The Amazon Pinpoint Developer Guide provides tutorials, code samples, and -// procedures that demonstrate how to use Amazon Pinpoint SMS 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. Regional availability The Amazon -// Pinpoint SMS and Voice, version 2 API Reference is available in several Amazon -// Web Services 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 Amazon Web Services Service Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) -// and Amazon Pinpoint endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/pinpoint.html) -// in the Amazon Web Services General Reference. To learn more about Amazon Web -// Services Regions, see Managing Amazon Web Services Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) -// in the Amazon Web Services General Reference. In each Region, Amazon Web -// Services 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 Amazon Web Services Global -// Infrastructure. (https://aws.amazon.com/about-aws/global-infrastructure/) +// resources, including supported HTTP methods, parameters, and schemas. +// +// Amazon Pinpoint is an Amazon Web Services service that you can use to engage +// with your recipients across multiple messaging channels. The Amazon Pinpoint SMS +// and Voice, version 2 API provides programmatic access to options that are unique +// to the SMS and voice channels. Amazon Pinpoint SMS and Voice, version 2 +// resources such as phone numbers, sender IDs, and opt-out lists can be used by +// the Amazon Pinpoint API. +// +// If you're new to Amazon Pinpoint SMS, it's also helpful to review the [Amazon Pinpoint SMS User Guide]. The +// Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures +// that demonstrate how to use Amazon Pinpoint SMS 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. +// +// # Regional availability +// +// The Amazon Pinpoint SMS and Voice, version 2 API Reference is available in +// several Amazon Web Services 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 [Amazon Web Services Service Endpoints]and [Amazon Pinpoint endpoints and quotas] in the Amazon Web Services General Reference. To +// learn more about Amazon Web Services Regions, see [Managing Amazon Web Services Regions]in the Amazon Web Services +// General Reference. +// +// In each Region, Amazon Web Services 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 [Amazon Web Services Global Infrastructure.] +// +// [Managing Amazon Web Services Regions]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html +// [Amazon Web Services Global Infrastructure.]: https://aws.amazon.com/about-aws/global-infrastructure/ +// [Amazon Pinpoint endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/pinpoint.html +// [Amazon Pinpoint SMS User Guide]: https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html +// [Amazon Web Services Service Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region package pinpointsmsvoicev2 diff --git a/service/pinpointsmsvoicev2/options.go b/service/pinpointsmsvoicev2/options.go index 48eb5cd75c2..87f89ae6bb2 100644 --- a/service/pinpointsmsvoicev2/options.go +++ b/service/pinpointsmsvoicev2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pinpointsmsvoicev2/types/enums.go b/service/pinpointsmsvoicev2/types/enums.go index 3427b5ee74c..7e4df92fc51 100644 --- a/service/pinpointsmsvoicev2/types/enums.go +++ b/service/pinpointsmsvoicev2/types/enums.go @@ -12,6 +12,7 @@ const ( // Values returns all known values for AccessDeniedExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AccessDeniedExceptionReason) Values() []AccessDeniedExceptionReason { return []AccessDeniedExceptionReason{ @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AccountAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountAttributeName) Values() []AccountAttributeName { return []AccountAttributeName{ "ACCOUNT_TIER", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for AccountLimitName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountLimitName) Values() []AccountLimitName { return []AccountLimitName{ "PHONE_NUMBERS", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for AttachmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentStatus) Values() []AttachmentStatus { return []AttachmentStatus{ "UPLOAD_IN_PROGRESS", @@ -99,6 +103,7 @@ const ( // Values returns all known values for AttachmentUploadErrorReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentUploadErrorReason) Values() []AttachmentUploadErrorReason { return []AttachmentUploadErrorReason{ @@ -119,6 +124,7 @@ const ( // Values returns all known values for ConfigurationSetFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationSetFilterName) Values() []ConfigurationSetFilterName { return []ConfigurationSetFilterName{ @@ -172,8 +178,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "CREATE_REGISTRATION_VERSION_NOT_ALLOWED", @@ -224,8 +231,9 @@ const ( // Values returns all known values for DestinationCountryParameterKey. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DestinationCountryParameterKey) Values() []DestinationCountryParameterKey { return []DestinationCountryParameterKey{ "IN_TEMPLATE_ID", @@ -282,8 +290,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -341,8 +350,9 @@ const ( ) // Values returns all known values for FieldRequirement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FieldRequirement) Values() []FieldRequirement { return []FieldRequirement{ "REQUIRED", @@ -361,8 +371,9 @@ const ( ) // 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. +// in the future, and so 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{ "SELECT", @@ -381,8 +392,9 @@ const ( ) // Values returns all known values for KeywordAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeywordAction) Values() []KeywordAction { return []KeywordAction{ "AUTOMATIC_RESPONSE", @@ -399,8 +411,9 @@ const ( ) // Values returns all known values for KeywordFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KeywordFilterName) Values() []KeywordFilterName { return []KeywordFilterName{ "keyword-action", @@ -427,8 +440,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "DE_DE", @@ -456,8 +470,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "TRANSACTIONAL", @@ -475,8 +490,9 @@ const ( ) // Values returns all known values for NumberCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumberCapability) Values() []NumberCapability { return []NumberCapability{ "SMS", @@ -497,8 +513,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -521,8 +538,9 @@ const ( ) // Values returns all known values for NumberType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumberType) Values() []NumberType { return []NumberType{ "SHORT_CODE", @@ -541,8 +559,9 @@ const ( ) // Values returns all known values for OptedOutFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OptedOutFilterName) Values() []OptedOutFilterName { return []OptedOutFilterName{ "end-user-opted-out", @@ -566,8 +585,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "status", @@ -598,8 +618,9 @@ const ( ) // Values returns all known values for PoolFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PoolFilterName) Values() []PoolFilterName { return []PoolFilterName{ "status", @@ -623,8 +644,9 @@ const ( // Values returns all known values for PoolOriginationIdentitiesFilterName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PoolOriginationIdentitiesFilterName) Values() []PoolOriginationIdentitiesFilterName { return []PoolOriginationIdentitiesFilterName{ "iso-country-code", @@ -642,8 +664,9 @@ const ( ) // Values returns all known values for PoolStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PoolStatus) Values() []PoolStatus { return []PoolStatus{ "CREATING", @@ -662,8 +685,9 @@ const ( // Values returns all known values for ProtectConfigurationFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectConfigurationFilterName) Values() []ProtectConfigurationFilterName { return []ProtectConfigurationFilterName{ "account-default", @@ -680,8 +704,9 @@ const ( ) // Values returns all known values for ProtectStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectStatus) Values() []ProtectStatus { return []ProtectStatus{ "ALLOW", @@ -700,8 +725,9 @@ const ( // Values returns all known values for RegistrationAssociationBehavior. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationAssociationBehavior) Values() []RegistrationAssociationBehavior { return []RegistrationAssociationBehavior{ "ASSOCIATE_BEFORE_SUBMIT", @@ -720,8 +746,9 @@ const ( // Values returns all known values for RegistrationAssociationFilterName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationAssociationFilterName) Values() []RegistrationAssociationFilterName { return []RegistrationAssociationFilterName{ "resource-type", @@ -738,8 +765,9 @@ const ( // Values returns all known values for RegistrationAttachmentFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationAttachmentFilterName) Values() []RegistrationAttachmentFilterName { return []RegistrationAttachmentFilterName{ "attachment-status", @@ -757,8 +785,9 @@ const ( // Values returns all known values for RegistrationDisassociationBehavior. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationDisassociationBehavior) Values() []RegistrationDisassociationBehavior { return []RegistrationDisassociationBehavior{ "DISASSOCIATE_ALL_CLOSES_REGISTRATION", @@ -776,8 +805,9 @@ const ( ) // Values returns all known values for RegistrationFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationFilterName) Values() []RegistrationFilterName { return []RegistrationFilterName{ "registration-type", @@ -800,8 +830,9 @@ const ( ) // Values returns all known values for RegistrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationStatus) Values() []RegistrationStatus { return []RegistrationStatus{ "CREATED", @@ -825,6 +856,7 @@ const ( // Values returns all known values for RegistrationTypeFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationTypeFilterName) Values() []RegistrationTypeFilterName { return []RegistrationTypeFilterName{ @@ -842,8 +874,9 @@ const ( // Values returns all known values for RegistrationVersionFilterName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationVersionFilterName) Values() []RegistrationVersionFilterName { return []RegistrationVersionFilterName{ "registration-version-status", @@ -866,6 +899,7 @@ const ( // Values returns all known values for RegistrationVersionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationVersionStatus) Values() []RegistrationVersionStatus { return []RegistrationVersionStatus{ @@ -891,8 +925,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "LONG_CODE", @@ -922,8 +957,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -954,8 +990,9 @@ const ( ) // Values returns all known values for SenderIdFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SenderIdFilterName) Values() []SenderIdFilterName { return []SenderIdFilterName{ "sender-id", @@ -997,8 +1034,9 @@ const ( // Values returns all known values for ServiceQuotaExceededExceptionReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceQuotaExceededExceptionReason) Values() []ServiceQuotaExceededExceptionReason { return []ServiceQuotaExceededExceptionReason{ "ASSOCIATIONS_PER_REGISTRATION", @@ -1037,8 +1075,9 @@ const ( ) // Values returns all known values for SpendLimitName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpendLimitName) Values() []SpendLimitName { return []SpendLimitName{ "TEXT_MESSAGE_MONTHLY_SPEND_LIMIT", @@ -1094,6 +1133,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -1148,8 +1188,9 @@ const ( ) // Values returns all known values for VerificationChannel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationChannel) Values() []VerificationChannel { return []VerificationChannel{ "TEXT", @@ -1166,8 +1207,9 @@ const ( ) // Values returns all known values for VerificationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationStatus) Values() []VerificationStatus { return []VerificationStatus{ "PENDING", @@ -1184,8 +1226,9 @@ const ( // Values returns all known values for VerifiedDestinationNumberFilterName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerifiedDestinationNumberFilterName) Values() []VerifiedDestinationNumberFilterName { return []VerifiedDestinationNumberFilterName{ "status", @@ -1258,8 +1301,9 @@ const ( ) // Values returns all known values for VoiceId. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceId) Values() []VoiceId { return []VoiceId{ "AMY", @@ -1334,6 +1378,7 @@ const ( // 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{ diff --git a/service/pinpointsmsvoicev2/types/types.go b/service/pinpointsmsvoicev2/types/types.go index 4b8fdebad95..0d353001640 100644 --- a/service/pinpointsmsvoicev2/types/types.go +++ b/service/pinpointsmsvoicev2/types/types.go @@ -92,8 +92,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -118,9 +119,11 @@ type ConfigurationSetInformation struct { noSmithyDocumentSerde } -// Contains information about an event destination. Event destinations are -// associated with configuration sets, which enable you to publish message sending -// events to CloudWatch, Kinesis Data Firehose, or Amazon SNS. +// Contains information about an event destination. +// +// Event destinations are associated with configuration sets, which enable you to +// publish message sending events to CloudWatch, Kinesis Data Firehose, or Amazon +// SNS. type EventDestination struct { // When set to true events will be logged. @@ -133,8 +136,9 @@ type EventDestination struct { // This member is required. EventDestinationName *string - // An array of event types that determine which events to log. The TEXT_SENT event - // type is not supported. + // An array of event types that determine which events to log. + // + // The TEXT_SENT event type is not supported. // // This member is required. MatchingEventTypes []EventType @@ -193,9 +197,10 @@ type KeywordInformation struct { // Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the // Identity and Access Management (IAM) role associated with a Kinesis Data -// Firehose event destination. Event destinations, such as Kinesis Data Firehose, -// are associated with configuration sets, which enable you to publish message -// sending events. +// Firehose event destination. +// +// Event destinations, such as Kinesis Data Firehose, are associated with +// configuration sets, which enable you to publish message sending events. type KinesisFirehoseDestination struct { // The Amazon Resource Name (ARN) of the delivery stream. @@ -241,8 +246,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. OptedOutTimestamp *time.Time @@ -253,8 +259,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -275,7 +282,8 @@ type OptOutListInformation struct { // The metadata for an origination identity associated with a pool. type OriginationIdentityMetadata struct { - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. // // This member is required. IsoCountryCode *string @@ -322,8 +330,9 @@ type PhoneNumberFilter struct { // 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -333,7 +342,8 @@ type PhoneNumberInformation struct { // This member is required. DeletionProtectionEnabled bool - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. // // This member is required. IsoCountryCode *string @@ -381,7 +391,9 @@ type PhoneNumberInformation 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 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) + // see [Self-managed opt-outs] + // + // [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 @@ -435,8 +447,9 @@ 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] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -473,17 +486,20 @@ 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] + // + // [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. + // 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. // // This member is required. SharedRoutesEnabled bool @@ -563,8 +579,9 @@ type ProtectConfigurationInformation struct { // This member is required. AccountDefault bool - // The time when the protect configuration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the protect configuration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -655,16 +672,21 @@ type RegistrationAttachmentFilter struct { type RegistrationAttachmentsInformation struct { // The status of the registration attachment. + // // - UPLOAD_IN_PROGRESS The attachment is being uploaded. + // // - UPLOAD_COMPLETE The attachment has been uploaded. + // // - UPLOAD_FAILED The attachment failed to uploaded. + // // - DELETED The attachment has been deleted.. // // This member is required. AttachmentStatus AttachmentStatus - // The time when the registration attachment was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration attachment was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -718,8 +740,7 @@ type RegistrationFieldDefinition struct { // This member is required. DisplayHints *RegistrationFieldDisplayHints - // The path to the registration form field. You can use - // DescribeRegistrationFieldDefinitions for a list of FieldPaths. + // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string @@ -786,8 +807,7 @@ type RegistrationFieldDisplayHints struct { // Provides the values of the specified field. type RegistrationFieldValueInformation struct { - // The path to the registration form field. You can use - // DescribeRegistrationFieldDefinitions for a list of FieldPaths. + // The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. // // This member is required. FieldPath *string @@ -827,8 +847,9 @@ type RegistrationFilter struct { // Provides information about the requested registration. type RegistrationInformation struct { - // The time when the registration was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -849,23 +870,31 @@ type RegistrationInformation struct { RegistrationId *string // The status of the registration. + // // - CREATED : Your registration is created but not submitted. + // // - SUBMITTED : Your registration has been submitted and is awaiting review. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - PROVISIONING : Your registration has been approved and your origination // identity is being created. + // // - COMPLETE : Your registration has been approved and and your origination // identity has been created. + // // - REQUIRES_UPDATES : You must fix your registration and resubmit it. + // // - CLOSED : The phone number or sender ID has been deleted and you must also // delete the registration for the number. + // // - DELETED : The registration has been deleted. // // This member is required. RegistrationStatus RegistrationStatus // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string @@ -932,7 +961,7 @@ type RegistrationTypeDefinition struct { DisplayHints *RegistrationTypeDisplayHints // The type of registration form. The list of RegistrationTypes can be found using - // the DescribeRegistrationTypeDefinitions action. + // the DescribeRegistrationTypeDefinitionsaction. // // This member is required. RegistrationType *string @@ -1004,14 +1033,22 @@ type RegistrationVersionFilter struct { type RegistrationVersionInformation struct { // The status of the registration. + // // - DRAFT : The initial status of a registration version after it’s created. + // // - SUBMITTED : Your registration has been submitted. + // // - REVIEWING : Your registration has been accepted and is being reviewed. + // // - APPROVED : Your registration has been approved. + // // - DISCARDED : You've abandon this version of their registration to start over // with a new version. + // // - DENIED : You must fix your registration and resubmit it. + // // - REVOKED : Your previously approved registration has been revoked. + // // - ARCHIVED : Your previously approved registration version moves into this // status when a more recently submitted version is approved. // @@ -1039,38 +1076,46 @@ type RegistrationVersionInformation struct { // the reservations status changes. type RegistrationVersionStatusHistory struct { - // The time when the registration was in the draft state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the draft state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. DraftTimestamp *time.Time - // The time when the registration was in the approved state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the approved state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ ApprovedTimestamp *time.Time - // The time when the registration was in the archived state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the archived state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ ArchivedTimestamp *time.Time - // The time when the registration was in the denied state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the denied state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ DeniedTimestamp *time.Time - // The time when the registration was in the discarded state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the discarded state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ DiscardedTimestamp *time.Time - // The time when the registration was in the reviewing state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the reviewing state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ ReviewingTimestamp *time.Time - // The time when the registration was in the revoked state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the revoked state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ RevokedTimestamp *time.Time - // The time when the registration was in the submitted state, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the registration was in the submitted state, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ SubmittedTimestamp *time.Time noSmithyDocumentSerde @@ -1114,13 +1159,15 @@ type SelectValidation struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Pinpoint User Guide. +// 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]in the Amazon Pinpoint User Guide. +// +// [Requesting sender IDs for SMS messaging with Amazon Pinpoint]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html type SenderIdAndCountry struct { - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. // // This member is required. IsoCountryCode *string @@ -1158,7 +1205,8 @@ type SenderIdInformation struct { // This member is required. DeletionProtectionEnabled bool - // The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. + // The two-character code, in ISO 3166-1 alpha-2 format, for the country or + // region. // // This member is required. IsoCountryCode *string @@ -1211,8 +1259,9 @@ type SnsDestination struct { // 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. +// see [Requesting increases to your monthly SMS spending quota for Amazon Pinpoint]in the Amazon Pinpoint User Guide. +// +// [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 type SpendLimit struct { // The maximum amount of money, in US dollars, that you want to be able to spend @@ -1222,7 +1271,7 @@ type SpendLimit struct { // This member is required. EnforcedLimit int64 - // The maximum amount of money that you are able to spend to send messages each + // The maximum amount of money that you are able to spend to send messages each // month, in US dollars. // // This member is required. @@ -1248,10 +1297,13 @@ type SpendLimit struct { type SupportedAssociation struct { // The association behavior. + // // - ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when // creating a registration. + // // - ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The // short code will be automatically provisioned once the registration is approved. + // // - ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you // must complete a registration first, then associate one or more phone numbers // later. For example 10DLC campaigns and long codes. @@ -1260,10 +1312,13 @@ type SupportedAssociation struct { AssociationBehavior RegistrationAssociationBehavior // The disassociation behavior. + // // - DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be // disassociated from the registration before the registration can be closed. + // // - DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must // be disassociated from the registration before the registration can be deleted. + // // - DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all // origination identities will be disasscoiated. // @@ -1356,8 +1411,9 @@ type VerifiedDestinationNumberFilter struct { // Provides information about the requested verified destintion phone number. type VerifiedDestinationNumberInformation struct { - // The time when the destination phone number was created, in UNIX epoch time (https://www.epochconverter.com/) - // format. + // The time when the destination phone number was created, in [UNIX epoch time] format. + // + // [UNIX epoch time]: https://www.epochconverter.com/ // // This member is required. CreatedTimestamp *time.Time @@ -1368,7 +1424,9 @@ type VerifiedDestinationNumberInformation struct { DestinationPhoneNumber *string // The status of the verified destination phone number. + // // - PENDING : The phone number hasn't been verified yet. + // // - VERIFIED : The phone number is verified and can receive messages. // // This member is required. diff --git a/service/pipes/api_op_CreatePipe.go b/service/pipes/api_op_CreatePipe.go index 138db2b101b..a154010e5bd 100644 --- a/service/pipes/api_op_CreatePipe.go +++ b/service/pipes/api_op_CreatePipe.go @@ -72,10 +72,12 @@ type CreatePipeInput struct { // The list of key-value pairs to associate with the pipe. Tags map[string]string - // The parameters required to set up a target for your pipe. For more information - // about pipe target parameters, including how to use dynamic path parameters, see - // Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) - // in the Amazon EventBridge User Guide. + // The parameters required to set up a target for your pipe. + // + // For more information about pipe target parameters, including how to use dynamic + // path parameters, see [Target parameters]in the Amazon EventBridge User Guide. + // + // [Target parameters]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html TargetParameters *types.PipeTargetParameters noSmithyDocumentSerde @@ -95,8 +97,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime 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 0de20b267df..21042c50a2f 100644 --- a/service/pipes/api_op_DeletePipe.go +++ b/service/pipes/api_op_DeletePipe.go @@ -12,9 +12,10 @@ import ( "time" ) -// 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. +// Delete an existing pipe. For more information about pipes, see [Amazon EventBridge Pipes] in the Amazon +// EventBridge User Guide. +// +// [Amazon EventBridge Pipes]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html func (c *Client) DeletePipe(ctx context.Context, params *DeletePipeInput, optFns ...func(*Options)) (*DeletePipeOutput, error) { if params == nil { params = &DeletePipeInput{} @@ -54,8 +55,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime 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 2cc2534fe88..0f8827952f8 100644 --- a/service/pipes/api_op_DescribePipe.go +++ b/service/pipes/api_op_DescribePipe.go @@ -13,8 +13,9 @@ 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]in the Amazon EventBridge User Guide. +// +// [Amazon EventBridge Pipes]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html func (c *Client) DescribePipe(ctx context.Context, params *DescribePipeInput, optFns ...func(*Options)) (*DescribePipeOutput, error) { if params == nil { params = &DescribePipeInput{} @@ -63,8 +64,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModifiedTime *time.Time // The logging configuration settings for the pipe. @@ -91,10 +93,12 @@ type DescribePipeOutput struct { // The ARN of the target resource. Target *string - // The parameters required to set up a target for your pipe. For more information - // about pipe target parameters, including how to use dynamic path parameters, see - // Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) - // in the Amazon EventBridge User Guide. + // The parameters required to set up a target for your pipe. + // + // For more information about pipe target parameters, including how to use dynamic + // path parameters, see [Target parameters]in the Amazon EventBridge User Guide. + // + // [Target parameters]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html TargetParameters *types.PipeTargetParameters // Metadata pertaining to the operation's result. diff --git a/service/pipes/api_op_ListPipes.go b/service/pipes/api_op_ListPipes.go index f02f5379134..468f475356f 100644 --- a/service/pipes/api_op_ListPipes.go +++ b/service/pipes/api_op_ListPipes.go @@ -12,8 +12,9 @@ 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]in the Amazon EventBridge User Guide. +// +// [Amazon EventBridge Pipes]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html func (c *Client) ListPipes(ctx context.Context, params *ListPipesInput, optFns ...func(*Options)) (*ListPipesOutput, error) { if params == nil { params = &ListPipesInput{} diff --git a/service/pipes/api_op_StartPipe.go b/service/pipes/api_op_StartPipe.go index 5bc82cbdfb6..c1b734899c2 100644 --- a/service/pipes/api_op_StartPipe.go +++ b/service/pipes/api_op_StartPipe.go @@ -52,8 +52,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime 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 c8ec6ea71a2..4dc8758de32 100644 --- a/service/pipes/api_op_StopPipe.go +++ b/service/pipes/api_op_StopPipe.go @@ -52,8 +52,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/api_op_TagResource.go b/service/pipes/api_op_TagResource.go index 607ec3d693e..7ea048701cd 100644 --- a/service/pipes/api_op_TagResource.go +++ b/service/pipes/api_op_TagResource.go @@ -13,13 +13,17 @@ import ( // Assigns one or more tags (key-value pairs) to the specified pipe. 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 pipe that already has tags. If you specify a new tag -// key, this tag is appended to the list of tags associated with the pipe. If you -// specify a tag key that is already associated with the pipe, the new tag value -// that you specify replaces the previous value for that tag. You can associate as -// many as 50 tags with a pipe. +// 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 pipe that already has tags. If you +// specify a new tag key, this tag is appended to the list of tags associated with +// the pipe. If you specify a tag key that is already associated with the pipe, the +// new tag value that you specify replaces the previous value for that tag. +// +// You can associate as many as 50 tags with a pipe. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/pipes/api_op_UpdatePipe.go b/service/pipes/api_op_UpdatePipe.go index ae397c1f55c..598f8664270 100644 --- a/service/pipes/api_op_UpdatePipe.go +++ b/service/pipes/api_op_UpdatePipe.go @@ -20,9 +20,11 @@ import ( // . EventBridge updates the fields in these objects atomically as one and // overrides existing values. This is by design, and means that if you don't // specify an optional field in one of these Parameters objects, EventBridge sets -// that field to its system-default value during 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. +// that field to its system-default value during the update. +// +// For more information about pipes, see [Amazon EventBridge Pipes] in the Amazon EventBridge User Guide. +// +// [Amazon EventBridge Pipes]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html func (c *Client) UpdatePipe(ctx context.Context, params *UpdatePipeInput, optFns ...func(*Options)) (*UpdatePipeOutput, error) { if params == nil { params = &UpdatePipeInput{} @@ -71,10 +73,12 @@ type UpdatePipeInput struct { // The ARN of the target resource. Target *string - // The parameters required to set up a target for your pipe. For more information - // about pipe target parameters, including how to use dynamic path parameters, see - // Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) - // in the Amazon EventBridge User Guide. + // The parameters required to set up a target for your pipe. + // + // For more information about pipe target parameters, including how to use dynamic + // path parameters, see [Target parameters]in the Amazon EventBridge User Guide. + // + // [Target parameters]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html TargetParameters *types.PipeTargetParameters noSmithyDocumentSerde @@ -94,8 +98,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModifiedTime *time.Time // The name of the pipe. diff --git a/service/pipes/options.go b/service/pipes/options.go index f3d862a64b0..5dd80d89116 100644 --- a/service/pipes/options.go +++ b/service/pipes/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pipes/types/enums.go b/service/pipes/types/enums.go index 3c7b25bd00a..4c3ef757f78 100644 --- a/service/pipes/types/enums.go +++ b/service/pipes/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AssignPublicIp. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignPublicIp) Values() []AssignPublicIp { return []AssignPublicIp{ "ENABLED", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for BatchJobDependencyType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchJobDependencyType) Values() []BatchJobDependencyType { return []BatchJobDependencyType{ "N_TO_N", @@ -49,8 +51,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchResourceRequirementType) Values() []BatchResourceRequirementType { return []BatchResourceRequirementType{ "GPU", @@ -69,6 +72,7 @@ const ( // Values returns all known values for DynamoDBStreamStartPosition. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DynamoDBStreamStartPosition) Values() []DynamoDBStreamStartPosition { return []DynamoDBStreamStartPosition{ @@ -85,8 +89,9 @@ const ( ) // Values returns all known values for EcsEnvironmentFileType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EcsEnvironmentFileType) Values() []EcsEnvironmentFileType { return []EcsEnvironmentFileType{ "s3", @@ -103,6 +108,7 @@ const ( // Values returns all known values for EcsResourceRequirementType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EcsResourceRequirementType) Values() []EcsResourceRequirementType { return []EcsResourceRequirementType{ @@ -120,6 +126,7 @@ const ( // Values returns all known values for IncludeExecutionDataOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (IncludeExecutionDataOption) Values() []IncludeExecutionDataOption { return []IncludeExecutionDataOption{ @@ -138,6 +145,7 @@ const ( // Values returns all known values for KinesisStreamStartPosition. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (KinesisStreamStartPosition) Values() []KinesisStreamStartPosition { return []KinesisStreamStartPosition{ @@ -157,8 +165,9 @@ const ( ) // Values returns all known values for LaunchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchType) Values() []LaunchType { return []LaunchType{ "EC2", @@ -178,8 +187,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "OFF", @@ -198,8 +208,9 @@ const ( ) // Values returns all known values for MSKStartPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MSKStartPosition) Values() []MSKStartPosition { return []MSKStartPosition{ "TRIM_HORIZON", @@ -216,8 +227,9 @@ const ( // Values returns all known values for OnPartialBatchItemFailureStreams. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnPartialBatchItemFailureStreams) Values() []OnPartialBatchItemFailureStreams { return []OnPartialBatchItemFailureStreams{ "AUTOMATIC_BISECT", @@ -246,8 +258,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -278,6 +291,7 @@ const ( // 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{ @@ -295,8 +309,9 @@ const ( ) // Values returns all known values for PlacementConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementConstraintType) Values() []PlacementConstraintType { return []PlacementConstraintType{ "distinctInstance", @@ -314,8 +329,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "random", @@ -332,8 +348,9 @@ const ( ) // Values returns all known values for PropagateTags. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropagateTags) Values() []PropagateTags { return []PropagateTags{ "TASK_DEFINITION", @@ -349,8 +366,9 @@ const ( ) // Values returns all known values for RequestedPipeState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestedPipeState) Values() []RequestedPipeState { return []RequestedPipeState{ "RUNNING", @@ -369,8 +387,9 @@ const ( // Values returns all known values for RequestedPipeStateDescribeResponse. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestedPipeStateDescribeResponse) Values() []RequestedPipeStateDescribeResponse { return []RequestedPipeStateDescribeResponse{ "RUNNING", @@ -389,8 +408,9 @@ const ( ) // Values returns all known values for S3OutputFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3OutputFormat) Values() []S3OutputFormat { return []S3OutputFormat{ "json", @@ -409,8 +429,9 @@ const ( // Values returns all known values for SelfManagedKafkaStartPosition. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SelfManagedKafkaStartPosition) Values() []SelfManagedKafkaStartPosition { return []SelfManagedKafkaStartPosition{ "TRIM_HORIZON", diff --git a/service/pipes/types/types.go b/service/pipes/types/types.go index b3cc88e5755..207603802f0 100644 --- a/service/pipes/types/types.go +++ b/service/pipes/types/types.go @@ -54,13 +54,15 @@ 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 // reserved for variables that Batch sets. Environment []BatchEnvironmentVariable - // The instance type to use for a multi-node parallel job. This parameter isn't - // applicable to single-node container jobs or jobs that run on Fargate resources, - // and shouldn't be provided. + // The instance type to use for a multi-node parallel job. + // + // This parameter isn't applicable to single-node container jobs or jobs that run + // on Fargate resources, and shouldn't be provided. InstanceType *string // The type and amount of resources to assign to a container. This overrides the @@ -74,6 +76,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 // reserved for variables that Batch sets. type BatchEnvironmentVariable struct { @@ -112,59 +115,98 @@ type BatchResourceRequirement struct { Type BatchResourceRequirementType // The quantity of the specified resource to reserve for the container. The values - // vary based on the type specified. type="GPU" The number of physical GPUs to - // reserve for the container. Make sure that the number of GPUs reserved for all - // containers in a job doesn't exceed the number of available GPUs on the compute - // resource that the job is launched on. GPUs aren't available for jobs that are - // 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 - // 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) - // 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, + // vary based on the type specified. + // + // type="GPU" The number of physical GPUs to reserve for the container. Make sure + // that the number of GPUs reserved for all containers in a job doesn't exceed the + // number of available GPUs on the compute resource that the job is launched on. + // + // GPUs aren't available for jobs that are 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] section of the [Docker Remote API] and the --memory option + // to [docker 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] + // section of the [Docker Remote API]and the --memory option to [docker 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]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] section of the [Docker Remote API] and the --cpu-shares option to [docker 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]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 + // 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 + // + // [docker run]: https://docs.docker.com/engine/reference/run/ + // [Create a container]: https://docs.docker.com/engine/api/v1.23/#create-a-container + // [Memory management]: https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html + // [Docker Remote API]: https://docs.docker.com/engine/api/v1.23/ + // [Fargate quotas]: https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate // // This member is required. Value *string @@ -172,9 +214,10 @@ type BatchResourceRequirement struct { noSmithyDocumentSerde } -// 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. +// The retry strategy that's associated with a job. For more information, see [Automated job retries] in +// the Batch User Guide. +// +// [Automated job retries]: https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html type BatchRetryStrategy struct { // The number of times to move a job to the RUNNABLE status. If the value of @@ -185,9 +228,10 @@ type BatchRetryStrategy struct { noSmithyDocumentSerde } -// The details of a capacity provider strategy. To learn more, see -// CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) -// in the Amazon ECS API Reference. +// The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem] in the Amazon +// ECS API Reference. +// +// [CapacityProviderStrategyItem]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html type CapacityProviderStrategyItem struct { // The short name of the capacity provider. @@ -235,9 +279,10 @@ type CloudwatchLogsLogDestinationParameters struct { // configuration. type DeadLetterConfig struct { - // The ARN of the specified target for the dead-letter queue. For Amazon Kinesis - // stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or - // Amazon SQS queue ARN. + // The ARN of the specified target for the dead-letter queue. + // + // For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an + // Amazon SNS topic or Amazon SQS queue ARN. Arn *string noSmithyDocumentSerde @@ -293,17 +338,24 @@ type EcsContainerOverride struct { // 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) -// in the Amazon Elastic Container Service Developer Guide. This parameter is only -// supported for tasks hosted on Fargate using the following platform versions: +// file syntax, see [Declare default environment variables in 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]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. +// +// [Declare default environment variables in file]: https://docs.docker.com/compose/env-file/ +// [Specifying environment variables]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html type EcsEnvironmentFile struct { // The file type to use. The only supported value is s3 . @@ -339,11 +391,14 @@ type EcsEnvironmentVariable struct { // 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. +// default amount, for tasks hosted on Fargate. For more information, see [Fargate task storage]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. +// +// [Fargate task storage]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html type EcsEphemeralStorage struct { // The total amount, in GiB, of ephemeral storage to set for the task. The minimum @@ -357,9 +412,10 @@ 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. +// definition. For more information, see [Working with Amazon Elastic Inference on Amazon ECS]in the Amazon Elastic Container Service +// Developer Guide. +// +// [Working with Amazon Elastic Inference on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html type EcsInferenceAcceleratorOverride struct { // The Elastic Inference accelerator device name to override for the task. This @@ -374,9 +430,10 @@ 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) -// in the Amazon Elastic Container Service Developer Guide +// information, see [Working with GPUs on Amazon ECS]or [Working with Amazon Elastic Inference on Amazon ECS] in the Amazon Elastic Container Service Developer Guide +// +// [Working with Amazon Elastic Inference on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html +// [Working with GPUs on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html type EcsResourceRequirement struct { // The type of resource to assign to a container. The supported values are GPU or @@ -385,12 +442,15 @@ type EcsResourceRequirement struct { // 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 - // 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 specified in a task definition. + // 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 specified in a task definition. // // This member is required. Value *string @@ -407,15 +467,21 @@ type EcsTaskOverride struct { // The cpu override for the task. 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: + // 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. 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) - // in the Amazon Elastic Container Service Developer Guide. + // task. For more information, see [Amazon ECS task execution IAM role]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Amazon ECS task execution IAM role]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html ExecutionRoleArn *string // The Elastic Inference accelerator override for the task. @@ -426,16 +492,19 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // specified in this role. For more information, see [IAM Role for Tasks]in the Amazon Elastic + // Container Service Developer Guide. + // + // [IAM Role for Tasks]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html 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) -// in the Amazon EventBridge User Guide. +// Filter events using an event pattern. For more information, see [Events and Event Patterns] in the Amazon +// EventBridge User Guide. +// +// [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html type Filter struct { // The event pattern. @@ -444,10 +513,14 @@ type Filter struct { noSmithyDocumentSerde } -// The collection of event patterns used to filter events. To remove a filter, -// specify a FilterCriteria object with an empty array of Filter objects. 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. +// The collection of event patterns used to filter events. +// +// To remove a filter, specify a FilterCriteria object with an empty array of +// Filter objects. +// +// For more information, see [Events and Event Patterns] in the Amazon EventBridge User Guide. +// +// [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html type FilterCriteria struct { // The event patterns. @@ -554,8 +627,9 @@ 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] (YYYY-MM-DDThh:mm:ss.sTZD). + // + // [ISO-8601 format]: https://www.w3.org/TR/NOTE-datetime LastModifiedTime *time.Time // The name of the pipe. @@ -598,18 +672,22 @@ type PipeEnrichmentHttpParameters struct { type PipeEnrichmentParameters struct { // Contains the HTTP parameters to use when the target is a API Gateway REST - // endpoint or EventBridge ApiDestination. If you specify an API Gateway REST 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 have these values configured. In case of any conflicting keys, values - // from the Connection take precedence. + // endpoint or EventBridge ApiDestination. + // + // If you specify an API Gateway REST 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 have these values + // configured. In case of any conflicting keys, values from the Connection take + // precedence. HttpParameters *PipeEnrichmentHttpParameters // 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) - // . To remove an input template, specify an empty string. + // itself is passed to the enrichment. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format]. + // + // To remove an input template, specify an empty string. + // + // [The JavaScript Object Notation (JSON) Data Interchange Format]: http://www.rfc-editor.org/rfc/rfc7159.txt InputTemplate *string noSmithyDocumentSerde @@ -625,10 +703,13 @@ type PipeLogConfiguration struct { FirehoseLogDestination *FirehoseLogDestination // Whether the execution data (specifically, the payload , awsRequest , and - // awsResponse fields) is included in the log messages for this pipe. This applies - // to all log destinations for the pipe. For more information, see Including - // execution data in logs (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) - // in the Amazon EventBridge User Guide. + // awsResponse fields) is included in the log messages for this pipe. + // + // This applies to all log destinations for the pipe. + // + // For more information, see [Including execution data in logs] in the Amazon EventBridge User Guide. + // + // [Including execution data in logs]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data IncludeExecutionData []IncludeExecutionDataOption // The level of logging detail to include. This applies to all log destinations @@ -641,26 +722,33 @@ type PipeLogConfiguration struct { noSmithyDocumentSerde } -// Specifies the logging configuration settings for the pipe. When you call -// UpdatePipe , EventBridge updates the fields in the +// Specifies the logging configuration settings for the pipe. +// +// When you call UpdatePipe , EventBridge updates the fields in the // PipeLogConfigurationParameters object atomically as one and overrides existing // values. This is by design. If you don't specify an optional field in any of the // Amazon Web Services service parameters objects ( // CloudwatchLogsLogDestinationParameters , FirehoseLogDestinationParameters , or // S3LogDestinationParameters ), EventBridge sets that field to its system-default -// value during the update. For example, suppose when you created the pipe you -// specified a Kinesis Data Firehose stream log destination. You then update the -// pipe to add an Amazon S3 log destination. In addition to specifying the -// S3LogDestinationParameters for the new log destination, you must also specify -// the fields in the FirehoseLogDestinationParameters object in order to retain -// the Kinesis Data Firehose stream log destination. For more information on -// generating pipe log records, see Log EventBridge Pipes in the Amazon +// value during the update. +// +// For example, suppose when you created the pipe you specified a Kinesis Data +// Firehose stream log destination. You then update the pipe to add an Amazon S3 +// log destination. In addition to specifying the S3LogDestinationParameters for +// the new log destination, you must also specify the fields in the +// FirehoseLogDestinationParameters object in order to retain the Kinesis Data +// Firehose stream log destination. +// +// For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon // EventBridge User Guide. type PipeLogConfigurationParameters struct { // The level of logging detail to include. This applies to all log destinations - // for the pipe. For more information, see Specifying EventBridge Pipes log level (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level) - // in the Amazon EventBridge User Guide. + // for the pipe. + // + // For more information, see [Specifying EventBridge Pipes log level] in the Amazon EventBridge User Guide. + // + // [Specifying EventBridge Pipes log level]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level // // This member is required. Level LogLevel @@ -672,10 +760,15 @@ type PipeLogConfigurationParameters struct { FirehoseLogDestination *FirehoseLogDestinationParameters // Specify ON to include the execution data (specifically, the payload and - // awsRequest fields) in the log messages for this pipe. This applies to all log - // destinations for the pipe. For more information, see Including execution data - // in logs (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) - // in the Amazon EventBridge User Guide. The default is OFF . + // awsRequest fields) in the log messages for this pipe. + // + // This applies to all log destinations for the pipe. + // + // For more information, see [Including execution data in logs] in the Amazon EventBridge User Guide. + // + // The default is OFF . + // + // [Including execution data in logs]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data IncludeExecutionData []IncludeExecutionDataOption // The Amazon S3 logging configuration settings for the pipe. @@ -825,10 +918,14 @@ type PipeSourceParameters struct { // The parameters for using a DynamoDB stream as a source. DynamoDBStreamParameters *PipeSourceDynamoDBStreamParameters - // The collection of event patterns used to filter events. To remove a filter, - // specify a FilterCriteria object with an empty array of Filter objects. 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. + // The collection of event patterns used to filter events. + // + // To remove a filter, specify a FilterCriteria object with an empty array of + // Filter objects. + // + // For more information, see [Events and Event Patterns] in the Amazon EventBridge User Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html FilterCriteria *FilterCriteria // The parameters for using a Kinesis stream as a source. @@ -985,20 +1082,23 @@ type PipeTargetCloudWatchLogsParameters struct { // The parameters for using an Amazon ECS task as a target. type PipeTargetEcsTaskParameters struct { - // The ARN of the task definition to use if the event target is an Amazon ECS task. + // The ARN of the task definition to use if the event target is an Amazon ECS + // task. // // This member is required. TaskDefinitionArn *string - // The capacity provider strategy to use for the task. If a - // capacityProviderStrategy is specified, the launchType parameter must be + // 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 // 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) - // in the Amazon Elastic Container Service Developer Guide. + // information, see [Tagging Your Amazon ECS Resources]in the Amazon Elastic Container Service Developer Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags bool // Whether or not to enable the execute command functionality for the containers @@ -1013,14 +1113,17 @@ 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) - // in the Amazon Elastic Container Service Developer Guide. + // with Amazon ECS is supported. For more information, see [Fargate on Amazon ECS]in the Amazon Elastic + // Container Service Developer Guide. + // + // [Fargate on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html LaunchType LaunchType // Use this structure if the Amazon ECS task uses the awsvpc network mode. This // structure specifies the VPC subnets and security groups associated with the // task, and whether a public IP address is to be used. This structure is required // if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. + // // If you specify NetworkConfiguration when the target ECS task does not use the // awsvpc network mode, the task fails. NetworkConfiguration *NetworkConfiguration @@ -1038,10 +1141,13 @@ type PipeTargetEcsTaskParameters struct { 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) - // in the Amazon Elastic Container Service Developer Guide. + // 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]in the Amazon Elastic Container Service + // Developer Guide. + // + // [Fargate Platform Versions]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html PlatformVersion *string // Specifies whether to propagate the tags from the task definition to the task. @@ -1055,8 +1161,9 @@ 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) - // in the Amazon ECS API Reference. + // define. To learn more, see [RunTask]in the Amazon ECS API Reference. + // + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags Tags []Tag // The number of tasks to create based on TaskDefinition . The default is 1. @@ -1084,9 +1191,11 @@ 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) - // call is used. + // The time stamp of the event, per [RFC3339]. If no time stamp is provided, the time stamp + // of the [PutEvents]call is used. + // + // [PutEvents]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html + // [RFC3339]: https://www.rfc-editor.org/rfc/rfc3339.txt Time *string noSmithyDocumentSerde @@ -1133,23 +1242,28 @@ type PipeTargetKinesisStreamParameters struct { type PipeTargetLambdaFunctionParameters struct { // Specify whether to invoke the function synchronously or asynchronously. + // // - REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds to the - // RequestResponse option in the InvocationType parameter for the Lambda Invoke (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) - // API. + // RequestResponse option in the InvocationType parameter for the Lambda [Invoke]API. + // // - FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event - // option in the InvocationType parameter for the Lambda Invoke (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) - // API. - // For more information, see Invocation types (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) - // in the Amazon EventBridge User Guide. + // option in the InvocationType parameter for the Lambda [Invoke]API. + // + // For more information, see [Invocation types] in the Amazon EventBridge User Guide. + // + // [Invocation types]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation + // [Invoke]: https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax InvocationType PipeTargetInvocationType noSmithyDocumentSerde } -// The parameters required to set up a target for your pipe. For more information -// about pipe target parameters, including how to use dynamic path parameters, see -// Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) -// in the Amazon EventBridge User Guide. +// The parameters required to set up a target for your pipe. +// +// For more information about pipe target parameters, including how to use dynamic +// path parameters, see [Target parameters]in the Amazon EventBridge User Guide. +// +// [Target parameters]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html type PipeTargetParameters struct { // The parameters for using an Batch job as a target. @@ -1169,9 +1283,11 @@ type PipeTargetParameters struct { HttpParameters *PipeTargetHttpParameters // 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) - // . To remove an input template, specify an empty string. + // itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format]. + // + // To remove an input template, specify an empty string. + // + // [The JavaScript Object Notation (JSON) Data Interchange Format]: http://www.rfc-editor.org/rfc/rfc7159.txt InputTemplate *string // The parameters for using a Kinesis stream as a target. @@ -1243,8 +1359,9 @@ type PipeTargetSageMakerPipelineParameters struct { // The parameters for using a Amazon SQS stream as a target. type PipeTargetSqsQueueParameters struct { - // This parameter applies only to FIFO (first-in-first-out) queues. The token used - // for deduplication of sent messages. + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The token used for deduplication of sent messages. MessageDeduplicationId *string // The FIFO message group ID to use as the target. @@ -1258,29 +1375,36 @@ type PipeTargetStateMachineParameters struct { // Specify whether to invoke the Step Functions state machine synchronously or // asynchronously. - // - REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see - // StartSyncExecution (https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) - // in the Step Functions API Reference. REQUEST_RESPONSE is not supported for - // STANDARD state machine workflows. - // - FIRE_AND_FORGET - Invoke asynchronously. For more information, see - // StartExecution (https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) + // + // - REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see [StartSyncExecution] // in the Step Functions API Reference. - // For more information, see Invocation types (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) - // in the Amazon EventBridge User Guide. + // + // REQUEST_RESPONSE is not supported for STANDARD state machine workflows. + // + // - FIRE_AND_FORGET - Invoke asynchronously. For more information, see [StartExecution]in the + // Step Functions API Reference. + // + // For more information, see [Invocation types] in the Amazon EventBridge User Guide. + // + // [StartExecution]: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html + // [StartSyncExecution]: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html + // [Invocation types]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation InvocationType PipeTargetInvocationType noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Developer Guide. +// An object representing a constraint on task placement. To learn more, see [Task Placement Constraints] in +// the Amazon Elastic Container Service Developer Guide. +// +// [Task Placement Constraints]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html 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) - // in the Amazon Elastic Container Service Developer Guide. + // more, see [Cluster Query Language]in the Amazon Elastic Container Service Developer Guide. + // + // [Cluster Query Language]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html Expression *string // The type of constraint. Use distinctInstance to ensure that each task in a @@ -1291,9 +1415,10 @@ type PlacementConstraint struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Container Service Service Developer Guide. +// The task placement strategy for a task or service. To learn more, see [Task Placement Strategies] in the +// Amazon Elastic Container Service Service Developer Guide. +// +// [Task Placement Strategies]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement @@ -1328,14 +1453,21 @@ type S3LogDestination struct { BucketOwner *string // The format EventBridge uses for the log records. + // // - json : JSON + // // - plain : Plain text - // - w3c : W3C extended logging file format (https://www.w3.org/TR/WD-logfile) + // + // - w3c : [W3C extended logging file format] + // + // [W3C extended logging file format]: https://www.w3.org/TR/WD-logfile OutputFormat S3OutputFormat - // The prefix text with which to begin Amazon S3 log object names. 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. + // The prefix text with which to begin Amazon S3 log object names. + // + // For more information, see [Organizing objects using prefixes] in the Amazon Simple Storage Service User Guide. + // + // [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html Prefix *string noSmithyDocumentSerde @@ -1357,17 +1489,25 @@ type S3LogDestinationParameters struct { BucketOwner *string // How EventBridge should format the log records. + // // - json : JSON + // // - plain : Plain text - // - w3c : W3C extended logging file format (https://www.w3.org/TR/WD-logfile) + // + // - w3c : [W3C extended logging file format] + // + // [W3C extended logging file format]: https://www.w3.org/TR/WD-logfile OutputFormat S3OutputFormat - // Specifies any prefix text with which to begin Amazon S3 log object names. You - // can use prefixes to organize the data that you store in Amazon S3 buckets. A - // prefix is a string of characters at the beginning of the object key name. A + // Specifies any prefix text with which to begin Amazon S3 log object names. + // + // You can use prefixes to organize the data that you store in Amazon S3 buckets. + // A prefix is a string of characters at the beginning of the object key name. A // prefix can be any length, subject to the maximum length of the object key name - // (1,024 bytes). 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. + // (1,024 bytes). For more information, see [Organizing objects using prefixes]in the Amazon Simple Storage Service + // User Guide. + // + // [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html Prefix *string noSmithyDocumentSerde @@ -1588,10 +1728,14 @@ type UpdatePipeSourceParameters struct { // The parameters for using a DynamoDB stream as a source. DynamoDBStreamParameters *UpdatePipeSourceDynamoDBStreamParameters - // The collection of event patterns used to filter events. To remove a filter, - // specify a FilterCriteria object with an empty array of Filter objects. 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. + // The collection of event patterns used to filter events. + // + // To remove a filter, specify a FilterCriteria object with an empty array of + // Filter objects. + // + // For more information, see [Events and Event Patterns] in the Amazon EventBridge User Guide. + // + // [Events and Event Patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html FilterCriteria *FilterCriteria // The parameters for using a Kinesis stream as a source. diff --git a/service/polly/api_op_DeleteLexicon.go b/service/polly/api_op_DeleteLexicon.go index 46efc8eff9d..877348481a2 100644 --- a/service/polly/api_op_DeleteLexicon.go +++ b/service/polly/api_op_DeleteLexicon.go @@ -13,8 +13,11 @@ 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]. +// +// [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 d2ba0a6b23a..2f6456bf4ab 100644 --- a/service/polly/api_op_DescribeVoices.go +++ b/service/polly/api_op_DescribeVoices.go @@ -13,16 +13,21 @@ 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. +// 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. func (c *Client) DescribeVoices(ctx context.Context, params *DescribeVoicesInput, optFns ...func(*Options)) (*DescribeVoicesOutput, error) { if params == nil { params = &DescribeVoicesInput{} @@ -51,7 +56,7 @@ type DescribeVoicesInput struct { // yes but not if you specify no . IncludeAdditionalLanguageCodes bool - // The language identification tag (ISO 639 code for the language name-ISO 3166 + // The language identification tag (ISO 639 code for the language name-ISO 3166 // country code) for filtering the list of voices returned. If you don't specify // this optional parameter, all available voices are returned. LanguageCode types.LanguageCode diff --git a/service/polly/api_op_GetLexicon.go b/service/polly/api_op_GetLexicon.go index d921f92497a..8c7e0566d7a 100644 --- a/service/polly/api_op_GetLexicon.go +++ b/service/polly/api_op_GetLexicon.go @@ -12,8 +12,9 @@ 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]. +// +// [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_ListLexicons.go b/service/polly/api_op_ListLexicons.go index 20bbb19eecb..2f0cdfaf437 100644 --- a/service/polly/api_op_ListLexicons.go +++ b/service/polly/api_op_ListLexicons.go @@ -12,8 +12,9 @@ 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]. +// +// [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 4f785eac456..2fe5e840d80 100644 --- a/service/polly/api_op_PutLexicon.go +++ b/service/polly/api_op_PutLexicon.go @@ -13,9 +13,11 @@ import ( // Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon // 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) -// . +// some time before the lexicon is available to the SynthesizeSpeech operation. +// +// For more information, see [Managing Lexicons]. +// +// [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 8e455233119..754d58222f2 100644 --- a/service/polly/api_op_StartSpeechSynthesisTask.go +++ b/service/polly/api_op_StartSpeechSynthesisTask.go @@ -65,12 +65,15 @@ type StartSpeechSynthesisTaskInput struct { // Optional language code for the Speech Synthesis 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. + // 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]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 LanguageCode types.LanguageCode // List of one or more pronunciation lexicon names you want the service to apply @@ -81,11 +84,13 @@ 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". The default value - // for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The - // default value is "16000". + // 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". The default value for long-form voices is "24000". + // + // Valid values for pcm are "8000" and "16000" The default value is "16000". SampleRate *string // ARN for the SNS topic optionally used for providing status notification for a diff --git a/service/polly/api_op_SynthesizeSpeech.go b/service/polly/api_op_SynthesizeSpeech.go index 5e060796365..3ff4153df21 100644 --- a/service/polly/api_op_SynthesizeSpeech.go +++ b/service/polly/api_op_SynthesizeSpeech.go @@ -16,8 +16,9 @@ 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]. +// +// [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{} @@ -35,72 +36,97 @@ func (c *Client) SynthesizeSpeech(ctx context.Context, params *SynthesizeSpeechI type SynthesizeSpeechInput struct { - // The format in which the returned output will be encoded. For audio stream, this - // will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. When pcm - // is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), - // little-endian format. + // The format in which the returned output will be encoded. For audio stream, + // this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. + // + // When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 + // channel (mono), little-endian format. // // 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. + // Voice ID to use for the synthesis. You can get a list of available voice IDs + // by calling the [DescribeVoices]operation. + // + // [DescribeVoices]: https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html // // This member is required. VoiceId types.VoiceId // Specifies the engine ( standard , neural or long-form ) for Amazon Polly to use // when processing input text for speech synthesis. For information on Amazon Polly - // voices and which voices are available for each engine, 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. long-form-only - // voices When using long-form-only voices such as Danielle (en-US), this parameter - // is required and must be set to long-form . If the engine is not specified, or is - // set to standard or neural , this will result in an error. Type: String Valid - // Values: standard | neural | long-form 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. + // voices and which voices are available for each engine, see [Available Voices]. + // + // 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. + // + // long-form-only voices + // + // When using long-form-only voices such as Danielle (en-US), this parameter is + // required and must be set to long-form . If the engine is not specified, or is + // set to standard or neural , this will result in an error. + // + // Type: String + // + // Valid Values: standard | neural | long-form + // + // 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. + // + // [Available Voices]: https://docs.aws.amazon.com/polly/latest/dg/voicelist.html 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. + // 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]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 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]. + // + // [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". The default value - // for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The - // default value is "16000". + // 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". The default value for long-form voices is "24000". + // + // Valid values for pcm are "8000" and "16000" The default value is "16000". SampleRate *string // The type of speech marks returned for the input text. 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) - // . + // Specifies whether the input text is plain text or SSML. The default value is + // plain text. For more information, see [Using SSML]. + // + // [Using SSML]: https://docs.aws.amazon.com/polly/latest/dg/ssml.html TextType types.TextType noSmithyDocumentSerde @@ -108,17 +134,21 @@ type SynthesizeSpeechInput struct { type SynthesizeSpeechOutput struct { - // Stream containing the synthesized speech. + // Stream containing the synthesized speech. AudioStream io.ReadCloser - // Specifies the type audio stream. This should reflect the OutputFormat parameter - // in your request. + // 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. ContentType *string diff --git a/service/polly/doc.go b/service/polly/doc.go index ce56a60e122..8eb2de8c429 100644 --- a/service/polly/doc.go +++ b/service/polly/doc.go @@ -3,9 +3,10 @@ // 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/options.go b/service/polly/options.go index 0941ae37fe2..09db4f1da2c 100644 --- a/service/polly/options.go +++ b/service/polly/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/polly/types/enums.go b/service/polly/types/enums.go index 3d9a2280fd4..44335ddaad7 100644 --- a/service/polly/types/enums.go +++ b/service/polly/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for Engine. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Engine) Values() []Engine { return []Engine{ "standard", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for Gender. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Gender) Values() []Gender { return []Gender{ "Female", @@ -86,8 +88,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -143,8 +146,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -165,8 +169,9 @@ const ( ) // Values returns all known values for SpeechMarkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpeechMarkType) Values() []SpeechMarkType { return []SpeechMarkType{ "sentence", @@ -187,8 +192,9 @@ const ( ) // Values returns all known values for TaskStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatus) Values() []TaskStatus { return []TaskStatus{ "scheduled", @@ -207,8 +213,9 @@ const ( ) // Values returns all known values for TextType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextType) Values() []TextType { return []TextType{ "ssml", @@ -319,8 +326,9 @@ const ( ) // Values returns all known values for VoiceId. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VoiceId) Values() []VoiceId { return []VoiceId{ "Aditi", diff --git a/service/polly/types/errors.go b/service/polly/types/errors.go index b0b412f13b6..ed92f1cbb63 100644 --- a/service/polly/types/errors.go +++ b/service/polly/types/errors.go @@ -278,9 +278,10 @@ func (e *LanguageNotSupportedException) ErrorFault() smithy.ErrorFault { return // 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. +// 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 @@ -554,8 +555,9 @@ 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]. +// +// [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 f625558720a..92b222ca815 100644 --- a/service/polly/types/types.go +++ b/service/polly/types/types.go @@ -8,8 +8,9 @@ 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]. +// +// [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 @@ -23,8 +24,9 @@ type Lexicon struct { } // 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) -// . +// language code, and so on. For more information, see [Managing Lexicons]. +// +// [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 . @@ -75,11 +77,15 @@ type SynthesisTask struct { // Optional language code for a synthesis task. 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. + // (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]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 LanguageCode LanguageCode // List of one or more pronunciation lexicon names you want the service to apply @@ -97,11 +103,13 @@ 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". The default value - // for long-form voices is "24000". Valid values for pcm are "8000" and "16000" The - // default value is "16000". + // 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". The default value for long-form voices is "24000". + // + // Valid values for pcm are "8000" and "16000" The default value is "16000". SampleRate *string // ARN for the SNS topic optionally used for providing status notification for a @@ -135,10 +143,11 @@ type SynthesisTask struct { type Voice struct { // Additional codes for languages available for the specified voice in addition to - // 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 . + // 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 . AdditionalLanguageCodes []LanguageCode // Gender of the voice. diff --git a/service/pricing/api_op_DescribeServices.go b/service/pricing/api_op_DescribeServices.go index 03672d25512..6c379f13fa1 100644 --- a/service/pricing/api_op_DescribeServices.go +++ b/service/pricing/api_op_DescribeServices.go @@ -35,7 +35,9 @@ func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesI type DescribeServicesInput struct { - // The format version that you want the response to be in. Valid values are: aws_v1 + // The format version that you want the response to be in. + // + // Valid values are: aws_v1 FormatVersion *string // The maximum number of results that you want returned in the response. diff --git a/service/pricing/api_op_GetAttributeValues.go b/service/pricing/api_op_GetAttributeValues.go index 974cf7ff404..b313e61995e 100644 --- a/service/pricing/api_op_GetAttributeValues.go +++ b/service/pricing/api_op_GetAttributeValues.go @@ -12,10 +12,10 @@ 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) -// . +// Price List API offer file. For a list of available attributes, see [Offer File Definitions]in the [Billing and Cost Management User Guide]. +// +// [Billing and Cost Management User Guide]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html +// [Offer File Definitions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs func (c *Client) GetAttributeValues(ctx context.Context, params *GetAttributeValuesInput, optFns ...func(*Options)) (*GetAttributeValuesOutput, error) { if params == nil { params = &GetAttributeValuesInput{} diff --git a/service/pricing/api_op_GetPriceListFileUrl.go b/service/pricing/api_op_GetPriceListFileUrl.go index 27a987726c2..9baf27073c3 100644 --- a/service/pricing/api_op_GetPriceListFileUrl.go +++ b/service/pricing/api_op_GetPriceListFileUrl.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This feature is in preview release and is subject to change. Your use of Amazon -// 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 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) +// This feature is in preview release and is subject to change. Your use of +// +// Amazon Web Services Price List API is subject to the Beta Service Participation +// terms of the [Amazon Web Services 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] // response. +// +// [Amazon Web Services Service Terms]: https://aws.amazon.com/service-terms/ +// [ListPriceLists]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html func (c *Client) GetPriceListFileUrl(ctx context.Context, params *GetPriceListFileUrlInput, optFns ...func(*Options)) (*GetPriceListFileUrlOutput, error) { if params == nil { params = &GetPriceListFileUrlInput{} @@ -35,15 +39,17 @@ 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) - // response. + // can be obtained from the [ListPriceLists]response. + // + // [ListPriceLists]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html // // 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) - // response. + // PriceListArn can be obtained from the [ListPriceLists] response. + // + // [ListPriceLists]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html // // This member is required. PriceListArn *string diff --git a/service/pricing/api_op_GetProducts.go b/service/pricing/api_op_GetProducts.go index 1e2fdd3a3e2..04ddacb0632 100644 --- a/service/pricing/api_op_GetProducts.go +++ b/service/pricing/api_op_GetProducts.go @@ -38,7 +38,9 @@ type GetProductsInput struct { // all filters are returned. Filters []types.Filter - // The format version that you want the response to be in. Valid values are: aws_v1 + // The format version that you want the response to be in. + // + // Valid values are: aws_v1 FormatVersion *string // The maximum number of results to return in the response. diff --git a/service/pricing/api_op_ListPriceLists.go b/service/pricing/api_op_ListPriceLists.go index 2bbcb54f213..3b50a2bd89d 100644 --- a/service/pricing/api_op_ListPriceLists.go +++ b/service/pricing/api_op_ListPriceLists.go @@ -12,17 +12,21 @@ import ( "time" ) -// This feature is in preview release and is subject to change. Your use of Amazon -// 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) -// API. +// This feature is in preview release and is subject to change. Your use of +// +// Amazon Web Services Price List API is subject to the Beta Service Participation +// terms of the [Amazon Web Services 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]API. +// +// [Amazon Web Services Service Terms]: https://aws.amazon.com/service-terms/ +// [GetPriceListFileUrl]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html func (c *Client) ListPriceLists(ctx context.Context, params *ListPriceListsInput, optFns ...func(*Options)) (*ListPriceListsOutput, error) { if params == nil { params = &ListPriceListsInput{} @@ -54,10 +58,15 @@ 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 Reserved Instance and Compute Savings Plan price lists, use - // ComputeSavingsPlans . To retrieve Machine Learning Savings Plans price lists, - // use MachineLearningSavingsPlans . + // Reserved Instance (RI) pricing, use the [DescribeServices]API. + // + // To retrieve the Reserved Instance and Compute Savings Plan price lists, use + // ComputeSavingsPlans . + // + // To retrieve Machine Learning Savings Plans price lists, use + // MachineLearningSavingsPlans . + // + // [DescribeServices]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion // // This member is required. ServiceCode *string @@ -72,8 +81,9 @@ 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) - // API. + // Regions. The available RegionCode list can be retrieved from [GetAttributeValues] API. + // + // [GetAttributeValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html RegionCode *string noSmithyDocumentSerde diff --git a/service/pricing/doc.go b/service/pricing/doc.go index 8dcea6f283b..fe9afd3369e 100644 --- a/service/pricing/doc.go +++ b/service/pricing/doc.go @@ -9,9 +9,13 @@ // 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 do the following: +// // - Build cost control and scenario planning tools +// // - Reconcile billing data +// // - Forecast future spend for budgeting purposes +// // - Provide cost benefit analysis that compare your internal workloads with // Amazon Web Services // @@ -21,7 +25,9 @@ // 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 IOPS volumeType . For more information, -// see Using the Amazon Web Services Price List API (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html) -// in the Billing User Guide. +// AmazonEC2 instance, with a Provisioned IOPS volumeType . +// +// For more information, see [Using the Amazon Web Services Price List API] in the Billing User Guide. +// +// [Using the Amazon Web Services Price List API]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html package pricing diff --git a/service/pricing/options.go b/service/pricing/options.go index 75cf87de816..8e74b2f2c1a 100644 --- a/service/pricing/options.go +++ b/service/pricing/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/pricing/types/enums.go b/service/pricing/types/enums.go index 6a3160d0e1e..45046cc9fdd 100644 --- a/service/pricing/types/enums.go +++ b/service/pricing/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for FilterType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterType) Values() []FilterType { return []FilterType{ "TERM_MATCH", diff --git a/service/pricing/types/types.go b/service/pricing/types/types.go index 3d358ed62c1..22cd0ab478b 100644 --- a/service/pricing/types/types.go +++ b/service/pricing/types/types.go @@ -23,16 +23,20 @@ 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, - // you can filter by the AmazonEC2 service code and the volumeType attribute name - // to get the prices for only Amazon EC2 volumes. + // 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 . - // TERM_MATCH returns only products that match both the given filter field and the - // given value. + // 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. // // This member is required. Type FilterType @@ -48,11 +52,14 @@ type Filter struct { noSmithyDocumentSerde } -// This feature is in preview release and is subject to change. Your use of Amazon -// 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 is the type of price list references that match your -// request. +// This feature is in preview release and is subject to change. Your use of +// +// Amazon Web Services Price List API is subject to the Beta Service Participation +// terms of the [Amazon Web Services Service Terms](Section 1.10). +// +// This is the type of price list references that match your request. +// +// [Amazon Web Services Service Terms]: https://aws.amazon.com/service-terms/ type PriceList struct { // The three alphabetical character ISO-4217 currency code the Price List files @@ -60,20 +67,24 @@ type PriceList struct { 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) - // response. + // obtained from the [ListPriceList]ListPriceList response. + // + // [ListPriceList]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html 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) - // response. + // PriceListArn can be obtained from the [ListPriceList]ListPriceList response. + // + // [ListPriceList]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html 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) + // Regions. The available RegionCode list can be retrieved from [GetAttributeValues]GetAttributeValues // API. + // + // [GetAttributeValues]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html RegionCode *string noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_ActivateDeviceIdentifier.go b/service/privatenetworks/api_op_ActivateDeviceIdentifier.go index 546373042a4..38bc9e8cef0 100644 --- a/service/privatenetworks/api_op_ActivateDeviceIdentifier.go +++ b/service/privatenetworks/api_op_ActivateDeviceIdentifier.go @@ -35,8 +35,9 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string noSmithyDocumentSerde @@ -49,7 +50,7 @@ type ActivateDeviceIdentifierOutput struct { // This member is required. DeviceIdentifier *types.DeviceIdentifier - // The tags on the device identifier. + // The tags on the device identifier. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_ActivateNetworkSite.go b/service/privatenetworks/api_op_ActivateNetworkSite.go index d09e3f6f148..365fa4d9f62 100644 --- a/service/privatenetworks/api_op_ActivateNetworkSite.go +++ b/service/privatenetworks/api_op_ActivateNetworkSite.go @@ -40,20 +40,29 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string // Determines the duration and renewal status of the commitment period for all - // pending radio units. If you include commitmentConfiguration in the - // ActivateNetworkSiteRequest action, you must specify the following: + // pending radio units. + // + // If you include commitmentConfiguration in the ActivateNetworkSiteRequest + // action, you must specify the following: + // // - The commitment period for the radio unit. You can choose a 60-day, 1-year, // or 3-year period. + // // - Whether you want your commitment period to automatically renew for one more // year after your current commitment period expires. - // For pricing, see Amazon Web Services Private 5G Pricing (http://aws.amazon.com/private5g/pricing) - // . If you do not include commitmentConfiguration in the - // ActivateNetworkSiteRequest action, the commitment period is set to 60-days. + // + // For pricing, see [Amazon Web Services Private 5G Pricing]. + // + // If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest + // action, the commitment period is set to 60-days. + // + // [Amazon Web Services Private 5G Pricing]: http://aws.amazon.com/private5g/pricing CommitmentConfiguration *types.CommitmentConfiguration noSmithyDocumentSerde diff --git a/service/privatenetworks/api_op_ConfigureAccessPoint.go b/service/privatenetworks/api_op_ConfigureAccessPoint.go index c33f54b2019..6b4408728ec 100644 --- a/service/privatenetworks/api_op_ConfigureAccessPoint.go +++ b/service/privatenetworks/api_op_ConfigureAccessPoint.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Web Services Private 5G User Guide. +// 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]in the Amazon Web +// Services Private 5G User Guide. +// +// [Radio units]: https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html func (c *Client) ConfigureAccessPoint(ctx context.Context, params *ConfigureAccessPointInput, optFns ...func(*Options)) (*ConfigureAccessPointOutput, error) { if params == nil { params = &ConfigureAccessPointInput{} diff --git a/service/privatenetworks/api_op_CreateNetwork.go b/service/privatenetworks/api_op_CreateNetwork.go index 8c3ab326d2b..471ce8cc38d 100644 --- a/service/privatenetworks/api_op_CreateNetwork.go +++ b/service/privatenetworks/api_op_CreateNetwork.go @@ -35,14 +35,15 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string // The description of the network. Description *string - // The tags to apply to the network. + // The tags to apply to the network. Tags map[string]string noSmithyDocumentSerde @@ -55,7 +56,7 @@ type CreateNetworkOutput struct { // This member is required. Network *types.Network - // The network tags. + // The network tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_CreateNetworkSite.go b/service/privatenetworks/api_op_CreateNetworkSite.go index d96ff2bb1f7..d185b5c0bc8 100644 --- a/service/privatenetworks/api_op_CreateNetworkSite.go +++ b/service/privatenetworks/api_op_CreateNetworkSite.go @@ -48,8 +48,9 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string // The description of the site. @@ -58,7 +59,7 @@ type CreateNetworkSiteInput struct { // Information about the pending plan for this site. PendingPlan *types.SitePlan - // The tags to apply to the network site. + // The tags to apply to the network site. Tags map[string]string noSmithyDocumentSerde @@ -69,7 +70,7 @@ type CreateNetworkSiteOutput struct { // Information about the network site. NetworkSite *types.NetworkSite - // The network site tags. + // The network site tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go b/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go index 3a88ddb0055..ba4bb184563 100644 --- a/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go +++ b/service/privatenetworks/api_op_DeactivateDeviceIdentifier.go @@ -35,8 +35,9 @@ 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]. + // + // [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 ca5e2c842ad..7477d9f21b0 100644 --- a/service/privatenetworks/api_op_DeleteNetwork.go +++ b/service/privatenetworks/api_op_DeleteNetwork.go @@ -12,8 +12,10 @@ 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) -// in the API Reference for Amazon Web Services Private 5G. +// the network. For more information, see [DeleteNetworkSite]in the API Reference for Amazon Web +// Services Private 5G. +// +// [DeleteNetworkSite]: https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html func (c *Client) DeleteNetwork(ctx context.Context, params *DeleteNetworkInput, optFns ...func(*Options)) (*DeleteNetworkOutput, error) { if params == nil { params = &DeleteNetworkInput{} @@ -37,8 +39,9 @@ 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]. + // + // [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 7422234177f..b966605099e 100644 --- a/service/privatenetworks/api_op_DeleteNetworkSite.go +++ b/service/privatenetworks/api_op_DeleteNetworkSite.go @@ -13,8 +13,9 @@ 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) -// in the Amazon Web Services Private 5G User Guide. +// [Hardware returns]in the Amazon Web Services Private 5G User Guide. +// +// [Hardware returns]: https://docs.aws.amazon.com/private-networks/latest/userguide/hardware-maintenance.html func (c *Client) DeleteNetworkSite(ctx context.Context, params *DeleteNetworkSiteInput, optFns ...func(*Options)) (*DeleteNetworkSiteOutput, error) { if params == nil { params = &DeleteNetworkSiteInput{} @@ -38,8 +39,9 @@ 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]. + // + // [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_GetDeviceIdentifier.go b/service/privatenetworks/api_op_GetDeviceIdentifier.go index d67b95e40ee..62a8c122452 100644 --- a/service/privatenetworks/api_op_GetDeviceIdentifier.go +++ b/service/privatenetworks/api_op_GetDeviceIdentifier.go @@ -42,7 +42,7 @@ type GetDeviceIdentifierOutput struct { // Information about the device identifier. DeviceIdentifier *types.DeviceIdentifier - // The device identifier tags. + // The device identifier tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_GetNetwork.go b/service/privatenetworks/api_op_GetNetwork.go index ce118ef6190..5373ab6b38e 100644 --- a/service/privatenetworks/api_op_GetNetwork.go +++ b/service/privatenetworks/api_op_GetNetwork.go @@ -44,7 +44,7 @@ type GetNetworkOutput struct { // This member is required. Network *types.Network - // The network tags. + // The network tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_GetNetworkResource.go b/service/privatenetworks/api_op_GetNetworkResource.go index 60d8476aa9e..7134ece989a 100644 --- a/service/privatenetworks/api_op_GetNetworkResource.go +++ b/service/privatenetworks/api_op_GetNetworkResource.go @@ -44,7 +44,7 @@ type GetNetworkResourceOutput struct { // This member is required. NetworkResource *types.NetworkResource - // The network resource tags. + // The network resource tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_GetNetworkSite.go b/service/privatenetworks/api_op_GetNetworkSite.go index 45b2e233ef8..7fb5aa97408 100644 --- a/service/privatenetworks/api_op_GetNetworkSite.go +++ b/service/privatenetworks/api_op_GetNetworkSite.go @@ -42,7 +42,7 @@ type GetNetworkSiteOutput struct { // Information about the network site. NetworkSite *types.NetworkSite - // The network site tags. + // The network site tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_GetOrder.go b/service/privatenetworks/api_op_GetOrder.go index cffd0ffc8f7..eb992bb6c26 100644 --- a/service/privatenetworks/api_op_GetOrder.go +++ b/service/privatenetworks/api_op_GetOrder.go @@ -44,7 +44,7 @@ type GetOrderOutput struct { // This member is required. Order *types.Order - // The order tags. + // The order tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_ListDeviceIdentifiers.go b/service/privatenetworks/api_op_ListDeviceIdentifiers.go index 36073077af2..00fc7ef78e6 100644 --- a/service/privatenetworks/api_op_ListDeviceIdentifiers.go +++ b/service/privatenetworks/api_op_ListDeviceIdentifiers.go @@ -13,9 +13,10 @@ import ( // Lists device identifiers. Add filters to your request to return a more specific // list of results. Use filters to match the Amazon Resource Name (ARN) of an -// order, the status of device identifiers, or the ARN of the traffic group. If you -// specify multiple filters, filters are joined with an OR, and the request returns -// results that match all of the specified filters. +// order, the status of device identifiers, or the ARN of the traffic group. +// +// If you specify multiple filters, filters are joined with an OR, and the request +// returns results that match all of the specified filters. func (c *Client) ListDeviceIdentifiers(ctx context.Context, params *ListDeviceIdentifiersInput, optFns ...func(*Options)) (*ListDeviceIdentifiersOutput, error) { if params == nil { params = &ListDeviceIdentifiersInput{} @@ -39,9 +40,13 @@ 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. diff --git a/service/privatenetworks/api_op_ListNetworkResources.go b/service/privatenetworks/api_op_ListNetworkResources.go index 8f432f4c7e0..e1bce037d33 100644 --- a/service/privatenetworks/api_op_ListNetworkResources.go +++ b/service/privatenetworks/api_op_ListNetworkResources.go @@ -13,9 +13,10 @@ import ( // Lists network resources. Add filters to your request to return a more specific // list of results. Use filters to match the Amazon Resource Name (ARN) of an order -// or the status of network resources. If you specify multiple filters, filters are -// joined with an OR, and the request returns results that match all of the -// specified filters. +// or the status of network resources. +// +// If you specify multiple filters, filters are joined with an OR, and the request +// returns results that match all of the specified filters. func (c *Client) ListNetworkResources(ctx context.Context, params *ListNetworkResourcesInput, optFns ...func(*Options)) (*ListNetworkResourcesOutput, error) { if params == nil { params = &ListNetworkResourcesInput{} @@ -39,9 +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. diff --git a/service/privatenetworks/api_op_ListNetworkSites.go b/service/privatenetworks/api_op_ListNetworkSites.go index 6f9ef4110da..d301559a371 100644 --- a/service/privatenetworks/api_op_ListNetworkSites.go +++ b/service/privatenetworks/api_op_ListNetworkSites.go @@ -37,8 +37,10 @@ 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. diff --git a/service/privatenetworks/api_op_ListNetworks.go b/service/privatenetworks/api_op_ListNetworks.go index 071b3172181..ea93f63d8c1 100644 --- a/service/privatenetworks/api_op_ListNetworks.go +++ b/service/privatenetworks/api_op_ListNetworks.go @@ -31,8 +31,10 @@ 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. diff --git a/service/privatenetworks/api_op_ListOrders.go b/service/privatenetworks/api_op_ListOrders.go index 2c06bdce5c0..b541fb9a490 100644 --- a/service/privatenetworks/api_op_ListOrders.go +++ b/service/privatenetworks/api_op_ListOrders.go @@ -13,9 +13,10 @@ import ( // Lists orders. Add filters to your request to return a more specific list of // results. Use filters to match the Amazon Resource Name (ARN) of the network site -// or the status of the order. If you specify multiple filters, filters are joined -// with an OR, and the request returns results that match all of the specified -// filters. +// or the status of the order. +// +// If you specify multiple filters, filters are joined with an OR, and the request +// returns results that match all of the specified filters. func (c *Client) ListOrders(ctx context.Context, params *ListOrdersInput, optFns ...func(*Options)) (*ListOrdersOutput, error) { if params == nil { params = &ListOrdersInput{} @@ -39,8 +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. diff --git a/service/privatenetworks/api_op_StartNetworkResourceUpdate.go b/service/privatenetworks/api_op_StartNetworkResourceUpdate.go index 6875e8a74b5..c4f01ae5432 100644 --- a/service/privatenetworks/api_op_StartNetworkResourceUpdate.go +++ b/service/privatenetworks/api_op_StartNetworkResourceUpdate.go @@ -12,17 +12,21 @@ import ( ) // Use this action to do the following tasks: +// // - Update the duration and renewal status of the commitment period for a radio // unit. The update goes into effect immediately. +// // - Request a replacement for a network resource. +// // - Request that you return a network resource. // // After you submit a request to replace or return a network resource, the status // of the network resource changes to 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 changes to DELETED . -// For more information, see Return a radio unit (https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit) -// . +// For more information, see [Return a radio unit]. +// +// [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{} @@ -46,36 +50,46 @@ 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 return a radio unit that you no longer need. // We provide a shipping label that you can use for the return process. + // // - COMMITMENT - Submits a request to change or renew the commitment period. If - // you choose this value, then you must set commitmentConfiguration (https://docs.aws.amazon.com/private-networks/latest/APIReference/API_StartNetworkResourceUpdate.html#privatenetworks-StartNetworkResourceUpdate-request-commitmentConfiguration) - // . + // you choose this value, then you must set [commitmentConfiguration]commitmentConfiguration . + // + // [commitmentConfiguration]: https://docs.aws.amazon.com/private-networks/latest/APIReference/API_StartNetworkResourceUpdate.html#privatenetworks-StartNetworkResourceUpdate-request-commitmentConfiguration // // This member is required. UpdateType types.UpdateType // Use this action to extend and automatically renew the commitment period for the // radio unit. You can do the following: + // // - Change a 60-day commitment to a 1-year or 3-year commitment. The change is // immediate and the hourly rate decreases to the rate for the new commitment // period. + // // - Change a 1-year commitment to a 3-year commitment. The change is immediate // and the hourly rate decreases to the rate for the 3-year commitment period. + // // - Set a 1-year commitment to automatically renew for an additional 1 year. // The hourly rate for the additional year will continue to be the same as your // existing 1-year rate. + // // - Set a 3-year commitment to automatically renew for an additional 1 year. // The hourly rate for the additional year will continue to be the same as your // existing 3-year rate. + // // - Turn off a previously-enabled automatic renewal on a 1-year or 3-year // commitment. You cannot use the automatic-renewal option for a 60-day commitment. // - // For pricing, see Amazon Web Services Private 5G Pricing (http://aws.amazon.com/private5g/pricing) - // . + // For pricing, see [Amazon Web Services Private 5G Pricing]. + // + // [Amazon Web Services Private 5G Pricing]: http://aws.amazon.com/private5g/pricing CommitmentConfiguration *types.CommitmentConfiguration // The reason for the return. Providing a reason for a return is optional. diff --git a/service/privatenetworks/api_op_TagResource.go b/service/privatenetworks/api_op_TagResource.go index ddd4c177c3f..f4b7a0a980f 100644 --- a/service/privatenetworks/api_op_TagResource.go +++ b/service/privatenetworks/api_op_TagResource.go @@ -28,7 +28,7 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Resource Name (ARN) of the resource. + // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string diff --git a/service/privatenetworks/api_op_UpdateNetworkSite.go b/service/privatenetworks/api_op_UpdateNetworkSite.go index beaddbb7e0e..5b7cb04a4f3 100644 --- a/service/privatenetworks/api_op_UpdateNetworkSite.go +++ b/service/privatenetworks/api_op_UpdateNetworkSite.go @@ -35,8 +35,9 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string // The description. @@ -50,7 +51,7 @@ type UpdateNetworkSiteOutput struct { // Information about the network site. NetworkSite *types.NetworkSite - // The network site tags. + // The network site tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/api_op_UpdateNetworkSitePlan.go b/service/privatenetworks/api_op_UpdateNetworkSitePlan.go index cc23242455b..037374dcac3 100644 --- a/service/privatenetworks/api_op_UpdateNetworkSitePlan.go +++ b/service/privatenetworks/api_op_UpdateNetworkSitePlan.go @@ -40,8 +40,9 @@ 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]. + // + // [How to ensure idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html ClientToken *string noSmithyDocumentSerde @@ -52,7 +53,7 @@ type UpdateNetworkSitePlanOutput struct { // Information about the network site. NetworkSite *types.NetworkSite - // The network site tags. + // The network site tags. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/privatenetworks/options.go b/service/privatenetworks/options.go index e48aa49665e..052f6472319 100644 --- a/service/privatenetworks/options.go +++ b/service/privatenetworks/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/privatenetworks/types/enums.go b/service/privatenetworks/types/enums.go index 1d59244f433..26516f94129 100644 --- a/service/privatenetworks/types/enums.go +++ b/service/privatenetworks/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AcknowledgmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcknowledgmentStatus) Values() []AcknowledgmentStatus { return []AcknowledgmentStatus{ "ACKNOWLEDGING", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for CommitmentLength. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommitmentLength) Values() []CommitmentLength { return []CommitmentLength{ "SIXTY_DAYS", @@ -53,6 +55,7 @@ const ( // Values returns all known values for DeviceIdentifierFilterKeys. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DeviceIdentifierFilterKeys) Values() []DeviceIdentifierFilterKeys { return []DeviceIdentifierFilterKeys{ @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for DeviceIdentifierStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceIdentifierStatus) Values() []DeviceIdentifierStatus { return []DeviceIdentifierStatus{ "ACTIVE", @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for ElevationReference. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ElevationReference) Values() []ElevationReference { return []ElevationReference{ "AGL", @@ -107,8 +112,9 @@ const ( ) // Values returns all known values for ElevationUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ElevationUnit) Values() []ElevationUnit { return []ElevationUnit{ "FEET", @@ -125,8 +131,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for NetworkFilterKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkFilterKeys) Values() []NetworkFilterKeys { return []NetworkFilterKeys{ "STATUS", @@ -161,8 +169,9 @@ const ( // Values returns all known values for NetworkResourceDefinitionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkResourceDefinitionType) Values() []NetworkResourceDefinitionType { return []NetworkResourceDefinitionType{ "RADIO_UNIT", @@ -180,6 +189,7 @@ const ( // Values returns all known values for NetworkResourceFilterKeys. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NetworkResourceFilterKeys) Values() []NetworkResourceFilterKeys { return []NetworkResourceFilterKeys{ @@ -204,8 +214,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PENDING", @@ -228,8 +239,9 @@ const ( ) // Values returns all known values for NetworkResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkResourceType) Values() []NetworkResourceType { return []NetworkResourceType{ "RADIO_UNIT", @@ -244,8 +256,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "STATUS", @@ -264,8 +277,9 @@ const ( ) // Values returns all known values for NetworkSiteStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkSiteStatus) Values() []NetworkSiteStatus { return []NetworkSiteStatus{ "CREATED", @@ -288,8 +302,9 @@ const ( ) // Values returns all known values for NetworkStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkStatus) Values() []NetworkStatus { return []NetworkStatus{ "CREATED", @@ -309,8 +324,9 @@ const ( ) // Values returns all known values for OrderFilterKeys. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderFilterKeys) Values() []OrderFilterKeys { return []OrderFilterKeys{ "STATUS", @@ -328,8 +344,9 @@ const ( ) // Values returns all known values for UpdateType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateType) Values() []UpdateType { return []UpdateType{ "REPLACE", @@ -351,6 +368,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/privatenetworks/types/types.go b/service/privatenetworks/types/types.go index 6bf93cb4b15..fcd7e78a90d 100644 --- a/service/privatenetworks/types/types.go +++ b/service/privatenetworks/types/types.go @@ -59,23 +59,33 @@ type Address struct { } // Determines the duration and renewal status of the commitment period for a radio -// unit. For pricing, see Amazon Web Services Private 5G Pricing (http://aws.amazon.com/private5g/pricing) -// . +// unit. +// +// For pricing, see [Amazon Web Services Private 5G Pricing]. +// +// [Amazon Web Services Private 5G Pricing]: http://aws.amazon.com/private5g/pricing type CommitmentConfiguration struct { // Determines whether the commitment period for a radio unit is set to // automatically renew for an additional 1 year after your current commitment - // period expires. Set to True , if you want your commitment period to - // automatically renew. Set to False if you do not want your commitment to - // automatically renew. You can do the following: + // period expires. + // + // Set to True , if you want your commitment period to automatically renew. Set to + // False if you do not want your commitment to automatically renew. + // + // You can do the following: + // // - Set a 1-year commitment to automatically renew for an additional 1 year. // The hourly rate for the additional year will continue to be the same as your // existing 1-year rate. + // // - Set a 3-year commitment to automatically renew for an additional 1 year. // The hourly rate for the additional year will continue to be the same as your // existing 3-year rate. + // // - Turn off a previously-enabled automatic renewal on a 1-year or 3-year // commitment. + // // You cannot use the automatic-renewal option for a 60-day commitment. // // This member is required. @@ -294,10 +304,10 @@ type NetworkSite struct { // This member is required. Status NetworkSiteStatus - // The parent Availability Zone for the network site. + // The parent Availability Zone for the network site. AvailabilityZone *string - // The parent Availability Zone ID for the network site. + // The parent Availability Zone ID for the network site. AvailabilityZoneId *string // The creation time of the network site. @@ -404,8 +414,9 @@ type ReturnInformation struct { // 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) - // . + // information, see [Return a radio unit]. + // + // [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_op_AcceptEnvironmentAccountConnection.go b/service/proton/api_op_AcceptEnvironmentAccountConnection.go index 3adce5b7a66..b3c7a474f81 100644 --- a/service/proton/api_op_AcceptEnvironmentAccountConnection.go +++ b/service/proton/api_op_AcceptEnvironmentAccountConnection.go @@ -14,9 +14,11 @@ import ( // In a management account, an environment account connection request is accepted. // 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) -// in the Proton User guide. +// associated environment account. +// +// For more information, see [Environment account connections] in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) AcceptEnvironmentAccountConnection(ctx context.Context, params *AcceptEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*AcceptEnvironmentAccountConnectionOutput, error) { if params == nil { params = &AcceptEnvironmentAccountConnectionInput{} diff --git a/service/proton/api_op_CancelComponentDeployment.go b/service/proton/api_op_CancelComponentDeployment.go index 5c966bfb88e..ab6f9b0b754 100644 --- a/service/proton/api_op_CancelComponentDeployment.go +++ b/service/proton/api_op_CancelComponentDeployment.go @@ -12,9 +12,11 @@ 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. +// IN_PROGRESS deployment status). +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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 6f618ca2a8d..0a8d352ffaf 100644 --- a/service/proton/api_op_CancelEnvironmentDeployment.go +++ b/service/proton/api_op_CancelEnvironmentDeployment.go @@ -11,17 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// scenarios. +// Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment +// is IN_PROGRESS . For more information, see [Update an environment] 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 fails, the resulting deployment state is FAILED . +// +// - If the current UpdateEnvironmentaction succeeds before the cancellation attempt starts, the +// resulting deployment state is SUCCEEDED and the cancellation attempt has no +// effect. +// +// [Update an environment]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html 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 be6b54d71d2..aae69242461 100644 --- a/service/proton/api_op_CancelServiceInstanceDeployment.go +++ b/service/proton/api_op_CancelServiceInstanceDeployment.go @@ -11,18 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Proton User guide. The following list includes potential cancellation -// scenarios. +// 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] 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 fails, the resulting deployment state is FAILED . +// +// - If the current UpdateServiceInstanceaction succeeds before the cancellation attempt starts, the +// resulting deployment state is SUCCEEDED and the cancellation attempt has no +// effect. +// +// [Update a service instance]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html 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 a109c25330a..17b2320b939 100644 --- a/service/proton/api_op_CancelServicePipelineDeployment.go +++ b/service/proton/api_op_CancelServicePipelineDeployment.go @@ -11,18 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Proton User guide. The following list includes potential cancellation -// scenarios. +// 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] 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 fails, the resulting deployment state is FAILED . +// +// - If the current UpdateServicePipelineaction succeeds before the cancellation attempt starts, the +// resulting deployment state is SUCCEEDED and the cancellation attempt has no +// effect. +// +// [Update a service pipeline]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html 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 45476dff321..eaffae9c313 100644 --- a/service/proton/api_op_CreateComponent.go +++ b/service/proton/api_op_CreateComponent.go @@ -12,8 +12,11 @@ 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] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html func (c *Client) CreateComponent(ctx context.Context, params *CreateComponentInput, optFns ...func(*Options)) (*CreateComponentOutput, error) { if params == nil { params = &CreateComponentInput{} @@ -46,8 +49,10 @@ type CreateComponentInput struct { 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 - // use Terraform as your template language. + // 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 // @@ -82,9 +87,11 @@ 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) - // in the Proton User Guide. + // component. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateEnvironment.go b/service/proton/api_op_CreateEnvironment.go index 51c0c2c4955..761565fefe2 100644 --- a/service/proton/api_op_CreateEnvironment.go +++ b/service/proton/api_op_CreateEnvironment.go @@ -13,16 +13,21 @@ 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: +// 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. // -// 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. +// For more information, see [Environments] and [Provisioning methods] in the Proton User Guide. +// +// [Environments]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html +// [Provisioning methods]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error) { if params == nil { params = &CreateEnvironmentInput{} @@ -46,8 +51,9 @@ 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]in the Proton User Guide. + // + // [Environments]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html // // This value conforms to the media type: application/yaml // @@ -59,26 +65,32 @@ type CreateEnvironmentInput struct { // This member is required. 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. + // The name of the environment template. For more information, see [Environment Templates] in the Proton + // User Guide. + // + // [Environment Templates]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html // // This member is required. TemplateName *string // 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. + // 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. 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string // A description of the environment that's being created and deployed. @@ -86,30 +98,37 @@ 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) - // 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. + // account. For more information, see [Environment account connections]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. + // + // [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html EnvironmentAccountConnectionId *string // The Amazon Resource Name (ARN) of the Proton service role that allows Proton to - // make calls to other services on your behalf. To use Amazon Web Services-managed - // provisioning for the environment, specify either the - // environmentAccountConnectionId or protonServiceRoleArn parameter and omit the - // provisioningRepository parameter. + // make calls to other services on your behalf. + // + // To use Amazon Web Services-managed provisioning for the environment, specify + // either the environmentAccountConnectionId or protonServiceRoleArn parameter and + // omit the provisioningRepository parameter. ProtonServiceRoleArn *string // 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 + // 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. + // environment. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html 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 a0a993428e2..0abb57db203 100644 --- a/service/proton/api_op_CreateEnvironmentAccountConnection.go +++ b/service/proton/api_op_CreateEnvironmentAccountConnection.go @@ -13,11 +13,13 @@ import ( // Create an environment account connection in an environment account so that // environment infrastructure resources can be provisioned in the environment -// 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) -// in the Proton User guide. +// 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]in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) CreateEnvironmentAccountConnection(ctx context.Context, params *CreateEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*CreateEnvironmentAccountConnectionOutput, error) { if params == nil { params = &CreateEnvironmentAccountConnectionInput{} @@ -63,10 +65,14 @@ type CreateEnvironmentAccountConnectionInput struct { // The Amazon Resource Name (ARN) of the IAM service role that Proton uses when // provisioning directly defined components in the associated environment account. // 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string // The Amazon Resource Name (ARN) of the IAM service role that's created in the @@ -75,9 +81,11 @@ type CreateEnvironmentAccountConnectionInput struct { RoleArn *string // 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. + // environment account connection. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateEnvironmentTemplate.go b/service/proton/api_op_CreateEnvironmentTemplate.go index 1fb5fad28f9..5b87a942e29 100644 --- a/service/proton/api_op_CreateEnvironmentTemplate.go +++ b/service/proton/api_op_CreateEnvironmentTemplate.go @@ -11,19 +11,23 @@ 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: +// Create an environment template for Proton. For more information, see [Environment Templates] 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. +// more information, see [Register and publish an environment template]in the Proton User Guide. +// +// [Register and publish an environment template]: https://docs.aws.amazon.com/proton/latest/userguide/template-create.html +// [Environment Templates]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html func (c *Client) CreateEnvironmentTemplate(ctx context.Context, params *CreateEnvironmentTemplateInput, optFns ...func(*Options)) (*CreateEnvironmentTemplateOutput, error) { if params == nil { params = &CreateEnvironmentTemplateInput{} @@ -60,9 +64,11 @@ type CreateEnvironmentTemplateInput struct { Provisioning types.Provisioning // 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. + // environment template. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateEnvironmentTemplateVersion.go b/service/proton/api_op_CreateEnvironmentTemplateVersion.go index 1189d19cbed..73427e3c781 100644 --- a/service/proton/api_op_CreateEnvironmentTemplateVersion.go +++ b/service/proton/api_op_CreateEnvironmentTemplateVersion.go @@ -51,14 +51,18 @@ type CreateEnvironmentTemplateVersionInput struct { 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 + // . + // + // 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. + // environment template version. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateRepository.go b/service/proton/api_op_CreateRepository.go index fb656c52f7c..f30c8a96a8b 100644 --- a/service/proton/api_op_CreateRepository.go +++ b/service/proton/api_op_CreateRepository.go @@ -15,12 +15,14 @@ import ( // access the repository, to either push to it (self-managed provisioning) or pull // 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) -// in the Proton User Guide. +// templates). When you create a repository link, Proton creates a [service-linked role]for you. +// +// For more information, see [Self-managed provisioning], [Template bundles], and [Template sync configurations] in the Proton User Guide. +// +// [Self-managed provisioning]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self +// [Template sync configurations]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html +// [Template bundles]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles +// [service-linked role]: https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error) { if params == nil { params = &CreateRepositoryInput{} @@ -39,9 +41,10 @@ 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) - // in the Proton User Guide. + // Proton to your repository provider account. For more information, see [Setting up for Proton]in the + // Proton User Guide. + // + // [Setting up for Proton]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html // // This member is required. ConnectionArn *string @@ -61,9 +64,11 @@ type CreateRepositoryInput struct { EncryptionKey *string // 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. + // repository. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateService.go b/service/proton/api_op_CreateService.go index fbba27aa035..6beaaf873a5 100644 --- a/service/proton/api_op_CreateService.go +++ b/service/proton/api_op_CreateService.go @@ -13,8 +13,9 @@ 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]in the Proton User Guide. +// +// [Services]: https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -40,8 +41,9 @@ 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]in the Proton User Guide. + // + // [Create a service]: https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html // // This value conforms to the media type: application/yaml // @@ -67,9 +69,10 @@ 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) - // in the Proton User Guide. Don't include this parameter if your service template - // doesn't include a service pipeline. + // information, see [Setting up an AWS CodeStar connection]in the Proton User Guide. Don't include this parameter if your + // service template doesn't include a service pipeline. + // + // [Setting up an AWS CodeStar connection]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol RepositoryConnectionArn *string // The ID of the code repository. Don't include this parameter if your service @@ -77,9 +80,11 @@ type CreateServiceInput struct { RepositoryId *string // An optional list of metadata items that you can associate with the Proton - // service. 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. + // service. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag // The minor version of the service template that was used to create the service. diff --git a/service/proton/api_op_CreateServiceInstance.go b/service/proton/api_op_CreateServiceInstance.go index 5d9eb13fe02..be7414771ac 100644 --- a/service/proton/api_op_CreateServiceInstance.go +++ b/service/proton/api_op_CreateServiceInstance.go @@ -50,9 +50,11 @@ type CreateServiceInstanceInput struct { ClientToken *string // 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. + // service instance. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag // To create a new major and minor version of the service template, exclude major diff --git a/service/proton/api_op_CreateServiceTemplate.go b/service/proton/api_op_CreateServiceTemplate.go index f4679bb874d..992c66fb02c 100644 --- a/service/proton/api_op_CreateServiceTemplate.go +++ b/service/proton/api_op_CreateServiceTemplate.go @@ -16,9 +16,10 @@ import ( // Developers, in turn, select the service template from Proton. If the selected // 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. +// defined by the selected service template. For more information, see [Proton templates]in the +// Proton User Guide. +// +// [Proton templates]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html func (c *Client) CreateServiceTemplate(ctx context.Context, params *CreateServiceTemplateInput, optFns ...func(*Options)) (*CreateServiceTemplateOutput, error) { if params == nil { params = &CreateServiceTemplateInput{} @@ -53,14 +54,17 @@ 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) - // in the Proton User Guide. + // information, see [Template bundles]in the Proton User Guide. + // + // [Template bundles]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles 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. + // service template. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateServiceTemplateVersion.go b/service/proton/api_op_CreateServiceTemplateVersion.go index ff80e63d6a1..85a77d84722 100644 --- a/service/proton/api_op_CreateServiceTemplateVersion.go +++ b/service/proton/api_op_CreateServiceTemplateVersion.go @@ -58,20 +58,25 @@ type CreateServiceTemplateVersionInput struct { Description *string // 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 . 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. + // be attached to service instances based on this service template version. + // + // For more information about components, see [Proton components] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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. + // service template version. A tag is a key-value pair. + // + // For more information, see [Proton resources and tagging] in the Proton User Guide. + // + // [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/proton/api_op_CreateTemplateSyncConfig.go b/service/proton/api_op_CreateTemplateSyncConfig.go index ec8a25608e8..a9b5907ba75 100644 --- a/service/proton/api_op_CreateTemplateSyncConfig.go +++ b/service/proton/api_op_CreateTemplateSyncConfig.go @@ -13,12 +13,14 @@ 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) -// in the Proton User Guide. +// 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]in the Proton User Guide. +// +// [Template sync configurations]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html func (c *Client) CreateTemplateSyncConfig(ctx context.Context, params *CreateTemplateSyncConfigInput, optFns ...func(*Options)) (*CreateTemplateSyncConfigOutput, error) { if params == nil { params = &CreateTemplateSyncConfigInput{} diff --git a/service/proton/api_op_DeleteComponent.go b/service/proton/api_op_DeleteComponent.go index a9c451178c9..591576c2ad9 100644 --- a/service/proton/api_op_DeleteComponent.go +++ b/service/proton/api_op_DeleteComponent.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Delete an Proton component resource. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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 3423ee4e519..0274676b770 100644 --- a/service/proton/api_op_DeleteEnvironmentAccountConnection.go +++ b/service/proton/api_op_DeleteEnvironmentAccountConnection.go @@ -11,14 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// In an environment account, delete an environment account connection. After you -// delete an environment account connection that’s in use by an Proton environment, -// Proton can’t manage the environment infrastructure resources until a new -// environment account connection is accepted for the environment account and +// In an environment account, delete an environment account connection. +// +// After you delete an environment account connection that’s in use by an Proton +// environment, Proton can’t manage the environment infrastructure resources until +// a new 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) -// in the Proton User guide. +// that remain without an environment connection. +// +// For more information, see [Environment account connections] in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) DeleteEnvironmentAccountConnection(ctx context.Context, params *DeleteEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*DeleteEnvironmentAccountConnectionOutput, error) { if params == nil { params = &DeleteEnvironmentAccountConnectionInput{} diff --git a/service/proton/api_op_DeleteEnvironmentTemplateVersion.go b/service/proton/api_op_DeleteEnvironmentTemplateVersion.go index 5e1a53099fe..7ef9bf18122 100644 --- a/service/proton/api_op_DeleteEnvironmentTemplateVersion.go +++ b/service/proton/api_op_DeleteEnvironmentTemplateVersion.go @@ -15,11 +15,12 @@ import ( // version of the environment template if it's not the Recommended version. Delete // 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. +// 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. 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 e0ebef9f45b..4ab479fa0ac 100644 --- a/service/proton/api_op_DeleteService.go +++ b/service/proton/api_op_DeleteService.go @@ -11,10 +11,14 @@ 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] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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 a5f85702cc2..f0ba3153f8c 100644 --- a/service/proton/api_op_DeleteServiceTemplateVersion.go +++ b/service/proton/api_op_DeleteServiceTemplateVersion.go @@ -15,11 +15,12 @@ import ( // of the service template if it's not the Recommended version. Delete the // 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. +// 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. 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 ced0b5c3342..8ad95030b9d 100644 --- a/service/proton/api_op_GetComponent.go +++ b/service/proton/api_op_GetComponent.go @@ -16,9 +16,11 @@ import ( "time" ) -// 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. +// Get detailed data for a component. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html func (c *Client) GetComponent(ctx context.Context, params *GetComponentInput, optFns ...func(*Options)) (*GetComponentOutput, error) { if params == nil { params = &GetComponentInput{} @@ -173,12 +175,13 @@ type ComponentDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetComponentInput, *GetComponentOutput, error) (bool, error) } @@ -362,12 +365,13 @@ type ComponentDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetComponentInput, *GetComponentOutput, error) (bool, error) } diff --git a/service/proton/api_op_GetEnvironment.go b/service/proton/api_op_GetEnvironment.go index 1f642962c7e..88181e666ff 100644 --- a/service/proton/api_op_GetEnvironment.go +++ b/service/proton/api_op_GetEnvironment.go @@ -175,12 +175,13 @@ type EnvironmentDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetEnvironmentInput, *GetEnvironmentOutput, error) (bool, error) } diff --git a/service/proton/api_op_GetEnvironmentAccountConnection.go b/service/proton/api_op_GetEnvironmentAccountConnection.go index b4cdfc3ae98..090014243da 100644 --- a/service/proton/api_op_GetEnvironmentAccountConnection.go +++ b/service/proton/api_op_GetEnvironmentAccountConnection.go @@ -12,8 +12,11 @@ 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) -// in the Proton User guide. +// connection. +// +// For more information, see [Environment account connections] in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) GetEnvironmentAccountConnection(ctx context.Context, params *GetEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*GetEnvironmentAccountConnectionOutput, error) { if params == nil { params = &GetEnvironmentAccountConnectionInput{} diff --git a/service/proton/api_op_GetEnvironmentTemplateVersion.go b/service/proton/api_op_GetEnvironmentTemplateVersion.go index cb5a5bb6c24..b8f991685f2 100644 --- a/service/proton/api_op_GetEnvironmentTemplateVersion.go +++ b/service/proton/api_op_GetEnvironmentTemplateVersion.go @@ -187,12 +187,13 @@ type EnvironmentTemplateVersionRegisteredWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetEnvironmentTemplateVersionInput, *GetEnvironmentTemplateVersionOutput, error) (bool, error) } diff --git a/service/proton/api_op_GetRepositorySyncStatus.go b/service/proton/api_op_GetRepositorySyncStatus.go index af26b0da141..e6c4b388387 100644 --- a/service/proton/api_op_GetRepositorySyncStatus.go +++ b/service/proton/api_op_GetRepositorySyncStatus.go @@ -12,12 +12,16 @@ import ( ) // Get the sync status of a repository used for Proton template sync. For more -// information about template sync, see . A repository sync status isn't tied to -// 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) -// in the Proton User Guide. +// information about template sync, see . +// +// A repository sync status isn't tied to 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] in the Proton User Guide. +// +// [ABAC]: https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags func (c *Client) GetRepositorySyncStatus(ctx context.Context, params *GetRepositorySyncStatusInput, optFns ...func(*Options)) (*GetRepositorySyncStatusOutput, error) { if params == nil { params = &GetRepositorySyncStatusInput{} diff --git a/service/proton/api_op_GetResourcesSummary.go b/service/proton/api_op_GetResourcesSummary.go index b9d07480923..3af8fbda358 100644 --- a/service/proton/api_op_GetResourcesSummary.go +++ b/service/proton/api_op_GetResourcesSummary.go @@ -11,19 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get counts of Proton resources. For infrastructure-provisioning resources -// (environments, services, service instances, pipelines), the action returns -// staleness counts. A resource is stale when it's behind the recommended version -// of the Proton template that it uses and it needs an update to become current. +// Get counts of Proton resources. +// +// For infrastructure-provisioning resources (environments, services, service +// instances, pipelines), the action returns staleness counts. A resource is stale +// when it's behind the recommended version of the Proton template that it uses and +// it needs an update to become current. +// // The action returns staleness counts (counts of resources that are up-to-date, // 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) -// in the Proton User Guide. +// 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] in the Proton User Guide. +// +// [Proton dashboard]: https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html func (c *Client) GetResourcesSummary(ctx context.Context, params *GetResourcesSummaryInput, optFns ...func(*Options)) (*GetResourcesSummaryOutput, error) { if params == nil { params = &GetResourcesSummaryInput{} diff --git a/service/proton/api_op_GetService.go b/service/proton/api_op_GetService.go index 5b8c00629cd..e081039e42b 100644 --- a/service/proton/api_op_GetService.go +++ b/service/proton/api_op_GetService.go @@ -171,12 +171,13 @@ type ServiceCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetServiceInput, *GetServiceOutput, error) (bool, error) } @@ -394,12 +395,13 @@ type ServiceUpdatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetServiceInput, *GetServiceOutput, error) (bool, error) } @@ -634,12 +636,13 @@ type ServiceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetServiceInput, *GetServiceOutput, error) (bool, error) } @@ -815,12 +818,13 @@ type ServicePipelineDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetServiceInput, *GetServiceOutput, error) (bool, error) } diff --git a/service/proton/api_op_GetServiceInstance.go b/service/proton/api_op_GetServiceInstance.go index 817f3b45d71..1c86dbfe42b 100644 --- a/service/proton/api_op_GetServiceInstance.go +++ b/service/proton/api_op_GetServiceInstance.go @@ -181,12 +181,13 @@ type ServiceInstanceDeployedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetServiceInstanceInput, *GetServiceInstanceOutput, error) (bool, error) } diff --git a/service/proton/api_op_GetServiceTemplateVersion.go b/service/proton/api_op_GetServiceTemplateVersion.go index 1dfee88938c..4bc6e3f76b3 100644 --- a/service/proton/api_op_GetServiceTemplateVersion.go +++ b/service/proton/api_op_GetServiceTemplateVersion.go @@ -187,12 +187,13 @@ type ServiceTemplateVersionRegisteredWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetServiceTemplateVersionInput, *GetServiceTemplateVersionOutput, error) (bool, error) } diff --git a/service/proton/api_op_ListComponentOutputs.go b/service/proton/api_op_ListComponentOutputs.go index 21b80102b2a..2c5b960b79a 100644 --- a/service/proton/api_op_ListComponentOutputs.go +++ b/service/proton/api_op_ListComponentOutputs.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// Get a list of component Infrastructure as Code (IaC) outputs. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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 8c80b1b94bd..c24439af8a1 100644 --- a/service/proton/api_op_ListComponentProvisionedResources.go +++ b/service/proton/api_op_ListComponentProvisionedResources.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// List provisioned resources for a component with details. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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 47d950fcfaa..72e3cf1ac5d 100644 --- a/service/proton/api_op_ListComponents.go +++ b/service/proton/api_op_ListComponents.go @@ -12,9 +12,11 @@ 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. +// environment, service, or a single service instance. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html 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 fbd172ba057..09a123ab122 100644 --- a/service/proton/api_op_ListEnvironmentAccountConnections.go +++ b/service/proton/api_op_ListEnvironmentAccountConnections.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Proton User guide. +// View a list of environment account connections. +// +// For more information, see [Environment account connections] in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) ListEnvironmentAccountConnections(ctx context.Context, params *ListEnvironmentAccountConnectionsInput, optFns ...func(*Options)) (*ListEnvironmentAccountConnectionsOutput, error) { if params == nil { params = &ListEnvironmentAccountConnectionsInput{} diff --git a/service/proton/api_op_ListEnvironmentTemplateVersions.go b/service/proton/api_op_ListEnvironmentTemplateVersions.go index 84654f95813..562d96d803a 100644 --- a/service/proton/api_op_ListEnvironmentTemplateVersions.go +++ b/service/proton/api_op_ListEnvironmentTemplateVersions.go @@ -35,8 +35,10 @@ 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_ListServiceInstances.go b/service/proton/api_op_ListServiceInstances.go index 46907e5967c..4da6077f3ba 100644 --- a/service/proton/api_op_ListServiceInstances.go +++ b/service/proton/api_op_ListServiceInstances.go @@ -44,12 +44,17 @@ type ListServiceInstancesInput struct { // The name of the service that the service instance belongs to. 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 - // instance name. Default: serviceName + // 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 instance name. + // + // Default: serviceName SortBy types.ListServiceInstancesSortBy - // Result list sort order. Default: ASCENDING + // Result list sort order. + // + // Default: ASCENDING SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/proton/api_op_ListServiceTemplateVersions.go b/service/proton/api_op_ListServiceTemplateVersions.go index 46cf7e7e7da..3dfa71a8032 100644 --- a/service/proton/api_op_ListServiceTemplateVersions.go +++ b/service/proton/api_op_ListServiceTemplateVersions.go @@ -35,8 +35,9 @@ type ListServiceTemplateVersionsInput struct { 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 . + // 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_ListTagsForResource.go b/service/proton/api_op_ListTagsForResource.go index 49fb9f7f357..1342acc17dd 100644 --- a/service/proton/api_op_ListTagsForResource.go +++ b/service/proton/api_op_ListTagsForResource.go @@ -11,8 +11,9 @@ 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] in the Proton User Guide. +// +// [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/proton/api_op_NotifyResourceDeploymentStatusChange.go b/service/proton/api_op_NotifyResourceDeploymentStatusChange.go index e7fa1e6105f..888fb8e6a7d 100644 --- a/service/proton/api_op_NotifyResourceDeploymentStatusChange.go +++ b/service/proton/api_op_NotifyResourceDeploymentStatusChange.go @@ -12,8 +12,11 @@ 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) -// in the Proton User Guide. +// self-managed provisioning. +// +// For more information, see [Self-managed provisioning] in the Proton User Guide. +// +// [Self-managed provisioning]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self func (c *Client) NotifyResourceDeploymentStatusChange(ctx context.Context, params *NotifyResourceDeploymentStatusChangeInput, optFns ...func(*Options)) (*NotifyResourceDeploymentStatusChangeOutput, error) { if params == nil { params = &NotifyResourceDeploymentStatusChangeInput{} diff --git a/service/proton/api_op_RejectEnvironmentAccountConnection.go b/service/proton/api_op_RejectEnvironmentAccountConnection.go index b5a9aa85a13..eae51a57ca4 100644 --- a/service/proton/api_op_RejectEnvironmentAccountConnection.go +++ b/service/proton/api_op_RejectEnvironmentAccountConnection.go @@ -12,11 +12,17 @@ import ( ) // In a management account, reject an environment account connection from another -// 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) -// in the Proton User guide. +// 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] in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) RejectEnvironmentAccountConnection(ctx context.Context, params *RejectEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*RejectEnvironmentAccountConnectionOutput, error) { if params == nil { params = &RejectEnvironmentAccountConnectionInput{} diff --git a/service/proton/api_op_TagResource.go b/service/proton/api_op_TagResource.go index 2c221b3987e..4139ac6fa68 100644 --- a/service/proton/api_op_TagResource.go +++ b/service/proton/api_op_TagResource.go @@ -12,8 +12,11 @@ import ( ) // 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. +// an Proton resource. +// +// For more information, see [Proton resources and tagging] in the Proton User Guide. +// +// [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html 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_UntagResource.go b/service/proton/api_op_UntagResource.go index 37dba9ade05..16b592f5913 100644 --- a/service/proton/api_op_UntagResource.go +++ b/service/proton/api_op_UntagResource.go @@ -11,9 +11,11 @@ import ( ) // Remove a customer tag from a resource. A tag is a key-value pair of metadata -// associated 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. +// associated with an Proton resource. +// +// For more information, see [Proton resources and tagging] in the Proton User Guide. +// +// [Proton resources and tagging]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/proton/api_op_UpdateAccountSettings.go b/service/proton/api_op_UpdateAccountSettings.go index b5920190444..2bc9438470e 100644 --- a/service/proton/api_op_UpdateAccountSettings.go +++ b/service/proton/api_op_UpdateAccountSettings.go @@ -43,15 +43,18 @@ 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 // provisioning pipelines. Assumed by Proton for Amazon Web Services-managed - // provisioning, and by customer-owned automation for self-managed provisioning. To - // remove a previously configured ARN, specify an empty string. + // provisioning, and by customer-owned automation for self-managed provisioning. + // + // To remove a previously configured ARN, specify an empty string. PipelineServiceRoleArn *string noSmithyDocumentSerde diff --git a/service/proton/api_op_UpdateComponent.go b/service/proton/api_op_UpdateComponent.go index 0d5217bbb43..d22e0d03ca3 100644 --- a/service/proton/api_op_UpdateComponent.go +++ b/service/proton/api_op_UpdateComponent.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html func (c *Client) UpdateComponent(ctx context.Context, params *UpdateComponentInput, optFns ...func(*Options)) (*UpdateComponentOutput, error) { if params == nil { params = &UpdateComponentInput{} @@ -35,11 +40,17 @@ func (c *Client) UpdateComponent(ctx context.Context, params *UpdateComponentInp type UpdateComponentInput struct { // The deployment type. It defines the mode for updating a component, as follows: - // NONE In this mode, a deployment doesn't occur. Only the requested metadata + // + // 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 - // parameters are updated. + // + // CURRENT_VERSION + // + // In this mode, the component is deployed and updated with the new serviceSpec , + // templateSource , and/or type that you provide. Only requested parameters are + // updated. // // This member is required. DeploymentType types.ComponentDeploymentUpdateType @@ -76,8 +87,10 @@ type UpdateComponentInput struct { 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 - // use Terraform as your template language. + // 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 TemplateFile *string diff --git a/service/proton/api_op_UpdateEnvironment.go b/service/proton/api_op_UpdateEnvironment.go index 19e9a775e85..ff953742f4d 100644 --- a/service/proton/api_op_UpdateEnvironment.go +++ b/service/proton/api_op_UpdateEnvironment.go @@ -11,38 +11,64 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update an environment. If the environment is associated with an environment -// account connection, don't update or include the protonServiceRoleArn and -// provisioningRepository parameter to update or connect to an environment account -// connection. You can only update to a new environment account connection if that -// connection was created in the same environment account that the current -// environment account connection was created in. The account connection must also -// be associated with the current environment. If the environment isn't associated -// with an environment account connection, don't update or include the -// environmentAccountConnectionId parameter. You can't update or connect the -// environment to an environment account connection if it isn't already associated -// 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 +// Update an environment. +// +// If the environment is associated with an environment account connection, don't +// update or include the protonServiceRoleArn and provisioningRepository parameter +// to update or connect to an environment account connection. +// +// You can only update to a new environment account connection if that connection +// was created in the same environment account that the current environment account +// connection was created in. The account connection must also be associated with +// the current environment. +// +// If the environment isn't associated with an environment account connection, +// don't update or include the environmentAccountConnectionId parameter. You can't +// update or connect the environment to an environment account connection if it +// isn't already associated 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 // 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) -// 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 -// 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. -// MAJOR_VERSION In this mode, the environment is deployed and updated with the -// published, recommended (latest) major and minor version of the current template, -// by default. You can also specify a different major version that's higher than -// the major version in use and a minor version. +// environmentAccountConnectionId parameters. +// +// For more information, see [Environments] and [Provisioning methods] 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 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. +// +// MAJOR_VERSION +// +// In this mode, the environment is deployed and updated with the published, +// recommended (latest) major and minor version of the current template, by +// default. You can also specify a different major version that's higher than the +// major version in use and a minor version. +// +// [Environments]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html +// [Provisioning methods]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmentInput, optFns ...func(*Options)) (*UpdateEnvironmentOutput, error) { if params == nil { params = &UpdateEnvironmentInput{} @@ -61,18 +87,32 @@ func (c *Client) UpdateEnvironment(ctx context.Context, params *UpdateEnvironmen type UpdateEnvironmentInput struct { // 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 major or minor 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. - // MAJOR_VERSION In this mode, the environment is deployed and updated with the - // published, recommended (latest) major and minor version of the current template, - // by default. You can also specify a different major version that is higher than - // the major version in use and a minor version (optional). + // 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 major or minor + // 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. + // + // MAJOR_VERSION + // + // In this mode, the environment is deployed and updated with the published, + // recommended (latest) major and minor version of the current template, by + // default. You can also specify a different major version that is higher than the + // major version in use and a minor version (optional). // // This member is required. DeploymentType types.DeploymentUpdateType @@ -88,20 +128,24 @@ type UpdateEnvironmentInput struct { // 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. 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string // A description of the environment update. Description *string - // The ID of the environment account connection. You can only update to a new - // environment account connection if it was created in the same environment account - // that the current environment account connection was created in and is associated - // with the current environment. + // The ID of the environment account connection. + // + // You can only update to a new environment account connection if it was created + // in the same environment account that the current environment account connection + // was created in and is associated with the current environment. EnvironmentAccountConnectionId *string // The Amazon Resource Name (ARN) of the Proton service role that allows Proton to @@ -110,8 +154,7 @@ 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 c8c937da84e..536674b6937 100644 --- a/service/proton/api_op_UpdateEnvironmentAccountConnection.go +++ b/service/proton/api_op_UpdateEnvironmentAccountConnection.go @@ -12,8 +12,11 @@ import ( ) // 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. +// new IAM role. +// +// For more information, see [Environment account connections] in the Proton User guide. +// +// [Environment account connections]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html func (c *Client) UpdateEnvironmentAccountConnection(ctx context.Context, params *UpdateEnvironmentAccountConnectionInput, optFns ...func(*Options)) (*UpdateEnvironmentAccountConnectionOutput, error) { if params == nil { params = &UpdateEnvironmentAccountConnectionInput{} @@ -44,10 +47,15 @@ type UpdateEnvironmentAccountConnectionInput struct { // The Amazon Resource Name (ARN) of the IAM service role that Proton uses when // provisioning directly defined components in the associated environment account. // 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string // The Amazon Resource Name (ARN) of the IAM service role that's associated with diff --git a/service/proton/api_op_UpdateService.go b/service/proton/api_op_UpdateService.go index 4b0fd9eba61..709ba06c285 100644 --- a/service/proton/api_op_UpdateService.go +++ b/service/proton/api_op_UpdateService.go @@ -12,12 +12,20 @@ import ( ) // Edit a service description or use a spec to add and delete service instances. +// // Existing service instances and the service pipeline can't be edited using this -// 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. +// 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] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html func (c *Client) UpdateService(ctx context.Context, params *UpdateServiceInput, optFns ...func(*Options)) (*UpdateServiceOutput, error) { if params == nil { params = &UpdateServiceInput{} @@ -46,8 +54,9 @@ type UpdateServiceInput struct { // 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. + // information, see [Edit a service]in the Proton User Guide. + // + // [Edit a service]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html // // This value conforms to the media type: application/yaml Spec *string diff --git a/service/proton/api_op_UpdateServiceInstance.go b/service/proton/api_op_UpdateServiceInstance.go index ddc5dd3bd30..b1dcd2c3360 100644 --- a/service/proton/api_op_UpdateServiceInstance.go +++ b/service/proton/api_op_UpdateServiceInstance.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html func (c *Client) UpdateServiceInstance(ctx context.Context, params *UpdateServiceInstanceInput, optFns ...func(*Options)) (*UpdateServiceInstanceOutput, error) { if params == nil { params = &UpdateServiceInstanceInput{} @@ -35,18 +40,32 @@ func (c *Client) UpdateServiceInstance(ctx context.Context, params *UpdateServic type UpdateServiceInstanceInput struct { // The deployment type. It defines the mode for updating a service instance, as - // follows: NONE In this mode, a deployment doesn't occur. Only the requested - // metadata parameters are updated. CURRENT_VERSION In this mode, the service - // instance 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 - // service instance 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. - // MAJOR_VERSION In this mode, the service instance 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. + // follows: + // + // NONE + // + // In this mode, a deployment doesn't occur. Only the requested metadata + // parameters are updated. + // + // CURRENT_VERSION + // + // In this mode, the service instance 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 service instance 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. + // + // MAJOR_VERSION + // + // In this mode, the service instance 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_UpdateServicePipeline.go b/service/proton/api_op_UpdateServicePipeline.go index ff972d8d788..9a67c5653f8 100644 --- a/service/proton/api_op_UpdateServicePipeline.go +++ b/service/proton/api_op_UpdateServicePipeline.go @@ -11,19 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update the service pipeline. There are four modes for updating a service -// pipeline. 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 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 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. +// Update the service pipeline. +// +// There are four modes for updating a service pipeline. 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 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 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. func (c *Client) UpdateServicePipeline(ctx context.Context, params *UpdateServicePipelineInput, optFns ...func(*Options)) (*UpdateServicePipelineOutput, error) { if params == nil { params = &UpdateServicePipelineInput{} @@ -41,19 +57,35 @@ func (c *Client) UpdateServicePipeline(ctx context.Context, params *UpdateServic type UpdateServicePipelineInput struct { - // The deployment type. There are four modes for updating a service pipeline. 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 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 - // mode, the service pipeline is deployed and updated with the published, + // The deployment type. + // + // There are four modes for updating a service pipeline. 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 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 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 716b6209440..e03ffdec91b 100644 --- a/service/proton/api_op_UpdateServiceTemplateVersion.go +++ b/service/proton/api_op_UpdateServiceTemplateVersion.go @@ -56,11 +56,15 @@ type UpdateServiceTemplateVersionInput struct { Status types.TemplateVersionStatus // An array of supported component sources. Components with supported sources can - // be attached to service instances based on this service template version. A - // change to supportedComponentSources doesn't impact existing component + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html SupportedComponentSources []types.ServiceTemplateSupportedComponentSourceType noSmithyDocumentSerde diff --git a/service/proton/api_op_UpdateTemplateSyncConfig.go b/service/proton/api_op_UpdateTemplateSyncConfig.go index ce132650d34..1807aa66bd3 100644 --- a/service/proton/api_op_UpdateTemplateSyncConfig.go +++ b/service/proton/api_op_UpdateTemplateSyncConfig.go @@ -14,7 +14,7 @@ import ( // Update template sync configuration parameters, except for the templateName and // 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{} diff --git a/service/proton/doc.go b/service/proton/doc.go index 8aebab631cd..b00407505ba 100644 --- a/service/proton/doc.go +++ b/service/proton/doc.go @@ -4,87 +4,153 @@ // 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. +// usage examples for each of the [actions]and [data types] 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]. +// +// 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]. +// +// # 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: +// 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: +// # 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: +// # 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: +// # 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: +// 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 +// +// [data types]: https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html +// [actions]: https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html +// [Amazon Web Services Command Line Interface User Guide]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html +// [Proton User Guide]: https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html package proton diff --git a/service/proton/options.go b/service/proton/options.go index 58fa104099b..3d93e5d9117 100644 --- a/service/proton/options.go +++ b/service/proton/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/proton/types/enums.go b/service/proton/types/enums.go index 2dbf0f67e50..1d7661852a3 100644 --- a/service/proton/types/enums.go +++ b/service/proton/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BlockerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerStatus) Values() []BlockerStatus { return []BlockerStatus{ "ACTIVE", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for BlockerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockerType) Values() []BlockerType { return []BlockerType{ "AUTOMATED", @@ -46,8 +48,9 @@ const ( // Values returns all known values for ComponentDeploymentUpdateType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentDeploymentUpdateType) Values() []ComponentDeploymentUpdateType { return []ComponentDeploymentUpdateType{ "NONE", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "IN_PROGRESS", @@ -97,8 +101,9 @@ const ( // Values returns all known values for DeploymentTargetResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentTargetResourceType) Values() []DeploymentTargetResourceType { return []DeploymentTargetResourceType{ "ENVIRONMENT", @@ -119,8 +124,9 @@ const ( ) // Values returns all known values for DeploymentUpdateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentUpdateType) Values() []DeploymentUpdateType { return []DeploymentUpdateType{ "NONE", @@ -140,8 +146,9 @@ const ( // Values returns all known values for // EnvironmentAccountConnectionRequesterAccountType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentAccountConnectionRequesterAccountType) Values() []EnvironmentAccountConnectionRequesterAccountType { return []EnvironmentAccountConnectionRequesterAccountType{ "MANAGEMENT_ACCOUNT", @@ -160,8 +167,9 @@ const ( // Values returns all known values for EnvironmentAccountConnectionStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentAccountConnectionStatus) Values() []EnvironmentAccountConnectionStatus { return []EnvironmentAccountConnectionStatus{ "PENDING", @@ -188,8 +196,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListServiceInstancesFilterBy) Values() []ListServiceInstancesFilterBy { return []ListServiceInstancesFilterBy{ "name", @@ -220,6 +229,7 @@ const ( // Values returns all known values for ListServiceInstancesSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListServiceInstancesSortBy) Values() []ListServiceInstancesSortBy { return []ListServiceInstancesSortBy{ @@ -243,6 +253,7 @@ const ( // Values returns all known values for ProvisionedResourceEngine. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedResourceEngine) Values() []ProvisionedResourceEngine { return []ProvisionedResourceEngine{ @@ -259,8 +270,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -277,8 +289,9 @@ const ( ) // Values returns all known values for RepositoryProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositoryProvider) Values() []RepositoryProvider { return []RepositoryProvider{ "GITHUB", @@ -305,8 +318,9 @@ const ( ) // Values returns all known values for RepositorySyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositorySyncStatus) Values() []RepositorySyncStatus { return []RepositorySyncStatus{ "INITIATED", @@ -328,6 +342,7 @@ const ( // 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{ @@ -352,8 +367,9 @@ const ( ) // Values returns all known values for ResourceSyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSyncStatus) Values() []ResourceSyncStatus { return []ResourceSyncStatus{ "INITIATED", @@ -384,8 +400,9 @@ const ( ) // Values returns all known values for ServiceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceStatus) Values() []ServiceStatus { return []ServiceStatus{ "CREATE_IN_PROGRESS", @@ -414,8 +431,9 @@ const ( // 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. +// the future, and so 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", @@ -431,8 +449,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -451,8 +470,9 @@ const ( ) // Values returns all known values for SyncType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncType) Values() []SyncType { return []SyncType{ "TEMPLATE_SYNC", @@ -469,8 +489,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -489,8 +510,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "REGISTRATION_IN_PROGRESS", diff --git a/service/proton/types/errors.go b/service/proton/types/errors.go index 7d869e089dd..56e2d3f7ad4 100644 --- a/service/proton/types/errors.go +++ b/service/proton/types/errors.go @@ -111,8 +111,9 @@ 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] in the Proton User Guide. +// +// [Proton Quotas]: https://docs.aws.amazon.com/proton/latest/userguide/ag-limits.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/proton/types/types.go b/service/proton/types/types.go index bd2cf5f51ab..d11798afa25 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 @@ -62,9 +62,11 @@ type CompatibleEnvironmentTemplateInput struct { noSmithyDocumentSerde } -// 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. +// Detailed data of an Proton component resource. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html type Component struct { // The Amazon Resource Name (ARN) of the component. @@ -160,9 +162,11 @@ type ComponentState struct { noSmithyDocumentSerde } -// 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. +// Summary data of an Proton component resource. +// +// For more information about components, see [Proton components] in the Proton User Guide. +// +// [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html type ComponentSummary struct { // The Amazon Resource Name (ARN) of the component. @@ -224,10 +228,11 @@ 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 + // 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 @@ -509,11 +514,14 @@ type Environment struct { // 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. 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string // An environment deployment status message. @@ -546,8 +554,9 @@ 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]. + // + // [CreateRepository]: https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html ProvisioningRepository *RepositoryBranch // The environment spec. @@ -616,10 +625,15 @@ type EnvironmentAccountConnection struct { // The Amazon Resource Name (ARN) of the IAM service role that Proton uses when // provisioning directly defined components in the associated environment account. // 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string noSmithyDocumentSerde @@ -679,10 +693,15 @@ type EnvironmentAccountConnectionSummary struct { // The Amazon Resource Name (ARN) of the IAM service role that Proton uses when // provisioning directly defined components in the associated environment account. // 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string noSmithyDocumentSerde @@ -767,11 +786,14 @@ type EnvironmentSummary struct { // 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. 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. + // 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] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html ComponentRoleArn *string // An environment deployment status message. @@ -1009,17 +1031,19 @@ type EnvironmentTemplateVersionSummary struct { noSmithyDocumentSerde } -// A filtering criterion to scope down the result list of the ListServiceInstances -// action. +// A filtering criterion to scope down the result list of the ListServiceInstances action. 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] string // with no UTC offset and with an optional fractional precision (for example, // 1985-04-12T23:20:50.52Z ). + // + // [RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339.html Value *string noSmithyDocumentSerde @@ -1048,8 +1072,11 @@ 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) - // in the Proton User Guide. + // self-managed provisioning. + // + // For more information, see [Self-managed provisioning] in the Proton User Guide. + // + // [Self-managed provisioning]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self ProvisioningEngine ProvisionedResourceEngine noSmithyDocumentSerde @@ -1418,8 +1445,9 @@ 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) - // in the Proton User Guide. + // information, see [Setting up an AWS CodeStar connection]in the Proton User Guide. + // + // [Setting up an AWS CodeStar connection]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol RepositoryConnectionArn *string // The ID of the source code repository. @@ -1754,18 +1782,20 @@ type ServiceSummary struct { } // If a service instance is manually updated, Proton wants to prevent accidentally -// overriding a manual change. A blocker is created because of the manual update or -// deletion of a service instance. The summary describes the blocker as being -// active or resolved. +// overriding a manual change. +// +// A blocker is created because of the manual update or deletion of a service +// instance. The summary describes the blocker as being active or resolved. type ServiceSyncBlockerSummary struct { // The name of the service that you want to get the sync blocker summary for. If // given a service instance name and a service name, it will return the blockers - // only applying to the instance that is blocked. If given only a service name, it - // will return the blockers that apply to all of the instances. In order to get the - // blockers for a single instance, you will need to make two distinct calls, one to - // get the sync blocker summary for the service and the other to get the sync - // blocker for the service instance. + // only applying to the instance that is blocked. + // + // If given only a service name, it will return the blockers that apply to all of + // the instances. In order to get the blockers for a single instance, you will need + // to make two distinct calls, one to get the sync blocker summary for the service + // and the other to get the sync blocker for the service instance. // // This member is required. ServiceName *string @@ -1956,9 +1986,11 @@ type ServiceTemplateVersion struct { StatusMessage *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. + // be attached to service instances based on this service template version. + // + // For more information about components, see [Proton components] in the Proton User Guide. + // + // [Proton components]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html SupportedComponentSources []ServiceTemplateSupportedComponentSourceType noSmithyDocumentSerde diff --git a/service/qbusiness/api_op_BatchDeleteDocument.go b/service/qbusiness/api_op_BatchDeleteDocument.go index 482662fd403..bfd844258df 100644 --- a/service/qbusiness/api_op_BatchDeleteDocument.go +++ b/service/qbusiness/api_op_BatchDeleteDocument.go @@ -12,8 +12,10 @@ import ( ) // Asynchronously deletes one or more documents added using the BatchPutDocument -// API from an Amazon Q Business index. You can see the progress of the deletion, -// and any error messages related to the process, by using CloudWatch. +// API from an Amazon Q Business index. +// +// You can see the progress of the deletion, and any error messages related to the +// process, by using CloudWatch. func (c *Client) BatchDeleteDocument(ctx context.Context, params *BatchDeleteDocumentInput, optFns ...func(*Options)) (*BatchDeleteDocumentOutput, error) { if params == nil { params = &BatchDeleteDocumentInput{} diff --git a/service/qbusiness/api_op_BatchPutDocument.go b/service/qbusiness/api_op_BatchPutDocument.go index 5b6d33555d2..6cf2b8fcda9 100644 --- a/service/qbusiness/api_op_BatchPutDocument.go +++ b/service/qbusiness/api_op_BatchPutDocument.go @@ -11,10 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more documents to an Amazon Q Business index. You use this API to: +// Adds one or more documents to an Amazon Q Business index. +// +// You use this API to: +// // - ingest your structured and unstructured documents and documents stored in // an Amazon S3 bucket into an Amazon Q Business index. +// // - add custom attributes to documents in an Amazon Q Business index. +// // - attach an access control list to the documents added to an Amazon Q // Business index. // @@ -64,7 +69,7 @@ type BatchPutDocumentInput struct { type BatchPutDocumentOutput struct { - // A list of documents that were not added to the Amazon Q Business index because + // A list of documents that were not added to the Amazon Q Business 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. FailedDocuments []types.FailedDocument diff --git a/service/qbusiness/api_op_ChatSync.go b/service/qbusiness/api_op_ChatSync.go index 06144d3f32e..31cbef37684 100644 --- a/service/qbusiness/api_op_ChatSync.go +++ b/service/qbusiness/api_op_ChatSync.go @@ -51,18 +51,23 @@ type ChatSyncInput struct { AuthChallengeResponse *types.AuthChallengeResponse // The chat modes available to an Amazon Q Business end user. + // // - RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. // When this mode is enabled, Amazon Q Business generates responses only from data // sources connected to an Amazon Q Business application. + // // - CREATOR_MODE - By selecting this mode, users can choose to generate // responses only from the LLM knowledge, without consulting connected data // sources, for a chat request. + // // - PLUGIN_MODE - By selecting this mode, users can choose to use plugins in // chat. - // For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) - // , Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html) - // , and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) - // . + // + // For more information, see [Admin controls and guardrails], [Plugins], and [Conversation settings]. + // + // [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope + // [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html + // [Plugins]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html ChatMode types.ChatMode // The chat mode configuration for an Amazon Q Business application. diff --git a/service/qbusiness/api_op_CreateApplication.go b/service/qbusiness/api_op_CreateApplication.go index 2af532b111b..8c4b14494d9 100644 --- a/service/qbusiness/api_op_CreateApplication.go +++ b/service/qbusiness/api_op_CreateApplication.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon Q Business application. There are new tiers for Amazon Q -// Business. Not all features in Amazon Q Business Pro are also available in Amazon -// Q Business Lite. For information on what's included in Amazon Q Business Lite -// and what's included in Amazon Q Business Pro, see Amazon Q Business tiers (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers) -// . You must use the Amazon Q Business console to assign subscription tiers to -// users. +// Creates an Amazon Q Business application. +// +// There are new tiers for Amazon Q Business. Not all features in Amazon Q +// Business Pro are also available in Amazon Q Business Lite. For information on +// what's included in Amazon Q Business Lite and what's included in Amazon Q +// Business Pro, see [Amazon Q Business tiers]. You must use the Amazon Q Business console to assign +// subscription tiers to users. +// +// [Amazon Q Business tiers]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error) { if params == nil { params = &CreateApplicationInput{} @@ -53,11 +56,11 @@ type CreateApplicationInput struct { // Business doesn't support asymmetric keys. EncryptionConfiguration *types.EncryptionConfiguration - // The Amazon Resource Name (ARN) of the IAM Identity Center instance you are + // The Amazon Resource Name (ARN) of the IAM Identity Center instance you are // either creating for—or connecting to—your Amazon Q Business application. IdentityCenterInstanceArn *string - // The Amazon Resource Name (ARN) of an IAM role with permissions to access your + // The Amazon Resource Name (ARN) of an IAM role with permissions to access your // Amazon CloudWatch logs and metrics. RoleArn *string @@ -72,7 +75,7 @@ type CreateApplicationInput struct { type CreateApplicationOutput struct { - // The Amazon Resource Name (ARN) of the Amazon Q Business application. + // The Amazon Resource Name (ARN) of the Amazon Q Business application. ApplicationArn *string // The identifier of the Amazon Q Business application. diff --git a/service/qbusiness/api_op_CreateDataSource.go b/service/qbusiness/api_op_CreateDataSource.go index 4aa5736771b..1a451a8e3bd 100644 --- a/service/qbusiness/api_op_CreateDataSource.go +++ b/service/qbusiness/api_op_CreateDataSource.go @@ -13,6 +13,7 @@ import ( ) // Creates a data source connector for an Amazon Q Business application. +// // CreateDataSource is a synchronous operation. The operation returns 200 if the // data source was successfully created. Otherwise, an exception is raised. func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error) { @@ -32,15 +33,16 @@ func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceI type CreateDataSourceInput struct { - // The identifier of the Amazon Q Business application the data source will be + // The identifier of the Amazon Q Business application the data source will be // attached to. // // This member is required. ApplicationId *string // Configuration information to connect to your data source repository. For - // configuration templates for your specific data source, see Supported connectors (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html) - // . + // configuration templates for your specific data source, see [Supported connectors]. + // + // [Supported connectors]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html // // This member is required. Configuration document.Interface @@ -64,9 +66,11 @@ type CreateDataSourceInput struct { Description *string // Provides the configuration information for altering document metadata and - // content during the document ingestion process. For more information, see Custom - // document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) - // . + // content during the document ingestion process. + // + // For more information, see [Custom document enrichment]. + // + // [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html DocumentEnrichmentConfiguration *types.DocumentEnrichmentConfiguration // The Amazon Resource Name (ARN) of an IAM role with permission to access the @@ -75,10 +79,12 @@ type CreateDataSourceInput struct { // Sets the frequency for Amazon Q Business to check the documents in your data // source repository and update your index. If you don't set a schedule, Amazon Q - // Business won't periodically 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 ValidationException exception. + // Business won't periodically 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 ValidationException + // exception. SyncSchedule *string // A list of key-value pairs that identify or categorize the data source @@ -88,9 +94,9 @@ type CreateDataSourceInput struct { Tags []types.Tag // Configuration information for an Amazon VPC (Virtual Private Cloud) to connect - // to your data source. For more information, see Using Amazon VPC with Amazon Q - // Business connectors (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html) - // . + // to your data source. For more information, see [Using Amazon VPC with Amazon Q Business connectors]. + // + // [Using Amazon VPC with Amazon Q Business connectors]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html VpcConfiguration *types.DataSourceVpcConfiguration noSmithyDocumentSerde @@ -98,7 +104,7 @@ type CreateDataSourceInput struct { type CreateDataSourceOutput struct { - // The Amazon Resource Name (ARN) of a data source in an Amazon Q Business + // The Amazon Resource Name (ARN) of a data source in an Amazon Q Business // application. DataSourceArn *string diff --git a/service/qbusiness/api_op_CreateIndex.go b/service/qbusiness/api_op_CreateIndex.go index 29c1478aaed..090eb3cced2 100644 --- a/service/qbusiness/api_op_CreateIndex.go +++ b/service/qbusiness/api_op_CreateIndex.go @@ -11,12 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon Q Business index. 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 ready to use. Once the index is -// active, you can index your documents using the BatchPutDocument (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html) -// API or the CreateDataSource (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) -// API. +// Creates an Amazon Q Business index. +// +// 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 ready to use. +// +// Once the index is active, you can index your documents using the [BatchPutDocument] +// BatchPutDocument API or the [CreateDataSource]CreateDataSource API. +// +// [BatchPutDocument]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html +// [CreateDataSource]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) { if params == nil { params = &CreateIndexInput{} @@ -63,8 +68,9 @@ type CreateIndexInput struct { Tags []types.Tag // The index type that's suitable for your needs. For more information on what's - // included in each type of index or index tier, see Amazon Q Business tiers (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers) - // . + // included in each type of index or index tier, see [Amazon Q Business tiers]. + // + // [Amazon Q Business tiers]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers Type types.IndexType noSmithyDocumentSerde @@ -72,7 +78,7 @@ type CreateIndexInput struct { type CreateIndexOutput struct { - // The Amazon Resource Name (ARN) of an Amazon Q Business index. + // The Amazon Resource Name (ARN) of an Amazon Q Business index. IndexArn *string // The identifier for the Amazon Q Business index. diff --git a/service/qbusiness/api_op_CreateWebExperience.go b/service/qbusiness/api_op_CreateWebExperience.go index d2f09ce6847..d66c278a182 100644 --- a/service/qbusiness/api_op_CreateWebExperience.go +++ b/service/qbusiness/api_op_CreateWebExperience.go @@ -67,7 +67,7 @@ type CreateWebExperienceInput struct { type CreateWebExperienceOutput struct { - // The Amazon Resource Name (ARN) of an Amazon Q Business web experience. + // The Amazon Resource Name (ARN) of an Amazon Q Business web experience. WebExperienceArn *string // The identifier of the Amazon Q Business web experience. diff --git a/service/qbusiness/api_op_DeleteGroup.go b/service/qbusiness/api_op_DeleteGroup.go index 6aeff2e2d26..88c15766984 100644 --- a/service/qbusiness/api_op_DeleteGroup.go +++ b/service/qbusiness/api_op_DeleteGroup.go @@ -13,12 +13,13 @@ import ( // 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 chat results. If you want to delete, -// update, or replace users or sub groups of a group, you need to use the PutGroup -// 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 -// PutGroup . +// longer see intern-only documents in their chat results. +// +// If you want to delete, update, or replace users or sub groups of a group, you +// need to use the PutGroup 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 PutGroup . func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error) { if params == nil { params = &DeleteGroupInput{} @@ -51,14 +52,15 @@ type DeleteGroupInput struct { // This member is required. IndexId *string - // The identifier of the data source linked to the group A group can be tied to - // multiple data sources. You can delete a group from accessing documents in 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. You want to delete "Research" and - // "Engineering" groups from Salesforce, so that these groups cannot access - // customer-related documents stored in Salesforce. Only "Sales and Marketing" - // should access documents in the Salesforce data source. + // The identifier of the data source linked to the group + // + // A group can be tied to multiple data sources. You can delete a group from + // accessing documents in 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. You + // want to delete "Research" and "Engineering" groups from Salesforce, so that + // these groups cannot access customer-related documents stored in Salesforce. Only + // "Sales and Marketing" should access documents in the Salesforce data source. DataSourceId *string noSmithyDocumentSerde diff --git a/service/qbusiness/api_op_GetDataSource.go b/service/qbusiness/api_op_GetDataSource.go index 23ee0df896a..49c8f2b9e57 100644 --- a/service/qbusiness/api_op_GetDataSource.go +++ b/service/qbusiness/api_op_GetDataSource.go @@ -73,9 +73,11 @@ type GetDataSourceOutput struct { DisplayName *string // Provides the configuration information for altering document metadata and - // content during the document ingestion process. For more information, see Custom - // document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) - // . + // content during the document ingestion process. + // + // For more information, see [Custom document enrichment]. + // + // [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html DocumentEnrichmentConfiguration *types.DocumentEnrichmentConfiguration // When the Status field value is FAILED , the ErrorMessage field contains a diff --git a/service/qbusiness/api_op_GetIndex.go b/service/qbusiness/api_op_GetIndex.go index aba543c7394..2bdaad677b1 100644 --- a/service/qbusiness/api_op_GetIndex.go +++ b/service/qbusiness/api_op_GetIndex.go @@ -62,16 +62,16 @@ type GetIndexOutput struct { // Configuration information for document attributes or metadata. Document // metadata are fields associated with your documents. For example, the company - // department name associated with each document. For more information, see - // Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes) - // . + // department name associated with each document. For more information, see [Understanding document attributes]. + // + // [Understanding document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes DocumentAttributeConfigurations []types.DocumentAttributeConfiguration // When the Status field value is FAILED , the ErrorMessage field contains a // message that explains why. Error *types.ErrorDetail - // The Amazon Resource Name (ARN) of the Amazon Q Business index. + // The Amazon Resource Name (ARN) of the Amazon Q Business index. IndexArn *string // The identifier of the Amazon Q Business index. diff --git a/service/qbusiness/api_op_GetWebExperience.go b/service/qbusiness/api_op_GetWebExperience.go index 06cd0620de0..f55d4d6b681 100644 --- a/service/qbusiness/api_op_GetWebExperience.go +++ b/service/qbusiness/api_op_GetWebExperience.go @@ -67,7 +67,7 @@ type GetWebExperienceOutput struct { // description of the error that caused the data source connector to fail. Error *types.ErrorDetail - // The Amazon Resource Name (ARN) of the service role attached to your web + // The Amazon Resource Name (ARN) of the service role attached to your web // experience. RoleArn *string diff --git a/service/qbusiness/api_op_ListDataSourceSyncJobs.go b/service/qbusiness/api_op_ListDataSourceSyncJobs.go index 93bb6452905..998aa2bda1d 100644 --- a/service/qbusiness/api_op_ListDataSourceSyncJobs.go +++ b/service/qbusiness/api_op_ListDataSourceSyncJobs.go @@ -37,7 +37,7 @@ type ListDataSourceSyncJobsInput struct { // This member is required. ApplicationId *string - // The identifier of the data source connector. + // The identifier of the data source connector. // // This member is required. DataSourceId *string @@ -48,7 +48,7 @@ type ListDataSourceSyncJobsInput struct { // This member is required. IndexId *string - // The end time of the data source connector sync. + // The end time of the data source connector sync. EndTime *time.Time // The maximum number of synchronization jobs to return in the response. @@ -59,7 +59,7 @@ type ListDataSourceSyncJobsInput struct { // use this pagination token to retrieve the next set of responses. NextToken *string - // The start time of the data source connector sync. + // The start time of the data source connector sync. StartTime *time.Time // Only returns synchronization jobs with the Status field equal to the specified diff --git a/service/qbusiness/api_op_PutGroup.go b/service/qbusiness/api_op_PutGroup.go index e441f70f58a..5c49b542f45 100644 --- a/service/qbusiness/api_op_PutGroup.go +++ b/service/qbusiness/api_op_PutGroup.go @@ -12,6 +12,7 @@ import ( ) // Create, or updates, a mapping of users—who have access to a document—to groups. +// // 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 @@ -48,11 +49,12 @@ type PutGroupInput struct { // The list that contains your users or sub groups that belong the same group. For // example, the group "Company" includes the user "CEO" and the sub groups - // "Research", "Engineering", and "Sales and Marketing". If you have more than 1000 - // users and/or sub groups for a single group, you need 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. + // "Research", "Engineering", and "Sales and Marketing". + // + // If you have more than 1000 users and/or sub groups for a single group, you need + // 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. // // This member is required. GroupName *string diff --git a/service/qbusiness/api_op_StartDataSourceSyncJob.go b/service/qbusiness/api_op_StartDataSourceSyncJob.go index 54eb6fee334..013660cac5b 100644 --- a/service/qbusiness/api_op_StartDataSourceSyncJob.go +++ b/service/qbusiness/api_op_StartDataSourceSyncJob.go @@ -34,7 +34,7 @@ type StartDataSourceSyncJobInput struct { // This member is required. ApplicationId *string - // The identifier of the data source connector. + // The identifier of the data source connector. // // This member is required. DataSourceId *string diff --git a/service/qbusiness/api_op_StopDataSourceSyncJob.go b/service/qbusiness/api_op_StopDataSourceSyncJob.go index d16a8e99658..67c38616164 100644 --- a/service/qbusiness/api_op_StopDataSourceSyncJob.go +++ b/service/qbusiness/api_op_StopDataSourceSyncJob.go @@ -35,7 +35,7 @@ type StopDataSourceSyncJobInput struct { // This member is required. ApplicationId *string - // The identifier of the data source connector. + // The identifier of the data source connector. // // This member is required. DataSourceId *string diff --git a/service/qbusiness/api_op_UpdateApplication.go b/service/qbusiness/api_op_UpdateApplication.go index 6d03ed43d4b..18247baa016 100644 --- a/service/qbusiness/api_op_UpdateApplication.go +++ b/service/qbusiness/api_op_UpdateApplication.go @@ -43,7 +43,7 @@ type UpdateApplicationInput struct { // A name for the Amazon Q Business application. DisplayName *string - // The Amazon Resource Name (ARN) of the IAM Identity Center instance you are + // The Amazon Resource Name (ARN) of the IAM Identity Center instance you are // either creating for—or connecting to—your Amazon Q Business application. IdentityCenterInstanceArn *string diff --git a/service/qbusiness/api_op_UpdateDataSource.go b/service/qbusiness/api_op_UpdateDataSource.go index b9d34e97bd1..27b4c40ff76 100644 --- a/service/qbusiness/api_op_UpdateDataSource.go +++ b/service/qbusiness/api_op_UpdateDataSource.go @@ -30,8 +30,8 @@ func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceI type UpdateDataSourceInput struct { - // The identifier of the Amazon Q Business application the data source is attached - // to. + // The identifier of the Amazon Q Business application the data source is + // attached to. // // This member is required. ApplicationId *string @@ -56,9 +56,11 @@ type UpdateDataSourceInput struct { DisplayName *string // Provides the configuration information for altering document metadata and - // content during the document ingestion process. For more information, see Custom - // document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) - // . + // content during the document ingestion process. + // + // For more information, see [Custom document enrichment]. + // + // [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html DocumentEnrichmentConfiguration *types.DocumentEnrichmentConfiguration // The Amazon Resource Name (ARN) of an IAM role with permission to access the diff --git a/service/qbusiness/api_op_UpdateIndex.go b/service/qbusiness/api_op_UpdateIndex.go index 93bc0ffdd49..f911e3d272a 100644 --- a/service/qbusiness/api_op_UpdateIndex.go +++ b/service/qbusiness/api_op_UpdateIndex.go @@ -52,8 +52,9 @@ type UpdateIndexInput struct { // 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. For more information, see - // Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes) - // . + // [Understanding document attributes]. + // + // [Understanding document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes DocumentAttributeConfigurations []types.DocumentAttributeConfiguration noSmithyDocumentSerde diff --git a/service/qbusiness/doc.go b/service/qbusiness/doc.go index 3994781875d..f5666628782 100644 --- a/service/qbusiness/doc.go +++ b/service/qbusiness/doc.go @@ -10,24 +10,49 @@ // email messages, summarizing text, drafting document outlines, and brainstorming // ideas. Users ask questions of Amazon Q Business and get answers that are // presented in a conversational manner. For an introduction to the service, see -// the Amazon Q Business User Guide (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html) -// . For an overview of the Amazon Q Business APIs, see Overview of Amazon Q -// Business API operations (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview) -// . For information about the IAM access control permissions you need to use this -// API, see IAM roles for Amazon Q Business (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html) -// in the Amazon Q Business User Guide. You can use the following AWS SDKs to -// access Amazon Q Business APIs: -// - AWS SDK for C++ (https://docs.aws.amazon.com/sdk-for-cpp) -// - AWS SDK for Go (https://docs.aws.amazon.com/sdk-for-go) -// - AWS SDK for Java (https://docs.aws.amazon.com/sdk-for-java) -// - AWS SDK for JavaScript (https://docs.aws.amazon.com/sdk-for-javascript) -// - AWS SDK for .NET (https://docs.aws.amazon.com/sdk-for-net) -// - AWS SDK for Python (Boto3) (https://docs.aws.amazon.com/pythonsdk) -// - AWS SDK for Ruby (https://docs.aws.amazon.com/sdk-for-ruby) +// the [Amazon Q Business User Guide]. +// +// For an overview of the Amazon Q Business APIs, see [Overview of Amazon Q Business API operations]. +// +// For information about the IAM access control permissions you need to use this +// API, see [IAM roles for Amazon Q Business]in the Amazon Q Business User Guide. +// +// You can use the following AWS SDKs to access Amazon Q Business APIs: +// +// [AWS SDK for C++] +// +// [AWS SDK for Go] +// +// [AWS SDK for Java] +// +// [AWS SDK for JavaScript] +// +// [AWS SDK for .NET] +// +// [AWS SDK for Python (Boto3)] +// +// [AWS SDK for Ruby] // // The following resources provide additional information about using the Amazon Q // Business API: -// - Setting up for Amazon Q Business (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html) -// - Amazon Q Business CLI Reference (https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html) -// - Amazon Web Services General Reference (https://docs.aws.amazon.com/general/latest/gr/amazonq.html) +// +// [Setting up for Amazon Q Business] +// +// [Amazon Q Business CLI Reference] +// +// [Amazon Web Services General Reference] +// +// [Overview of Amazon Q Business API operations]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview +// [IAM roles for Amazon Q Business]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html +// [AWS SDK for Java]: https://docs.aws.amazon.com/sdk-for-java +// [AWS SDK for Go]: https://docs.aws.amazon.com/sdk-for-go +// [Amazon Q Business CLI Reference]: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html +// [AWS SDK for JavaScript]: https://docs.aws.amazon.com/sdk-for-javascript +// [AWS SDK for Ruby]: https://docs.aws.amazon.com/sdk-for-ruby +// [Amazon Web Services General Reference]: https://docs.aws.amazon.com/general/latest/gr/amazonq.html +// [AWS SDK for .NET]: https://docs.aws.amazon.com/sdk-for-net +// [Setting up for Amazon Q Business]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html +// [Amazon Q Business User Guide]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html +// [AWS SDK for C++]: https://docs.aws.amazon.com/sdk-for-cpp +// [AWS SDK for Python (Boto3)]: https://docs.aws.amazon.com/pythonsdk package qbusiness diff --git a/service/qbusiness/options.go b/service/qbusiness/options.go index 963714ee904..bff9ed2cadc 100644 --- a/service/qbusiness/options.go +++ b/service/qbusiness/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/qbusiness/types/enums.go b/service/qbusiness/types/enums.go index 5cda9a81f8d..1563c23d1af 100644 --- a/service/qbusiness/types/enums.go +++ b/service/qbusiness/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for ActionPayloadFieldType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionPayloadFieldType) Values() []ActionPayloadFieldType { return []ActionPayloadFieldType{ "STRING", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for APISchemaType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (APISchemaType) Values() []APISchemaType { return []APISchemaType{ "OPEN_API_V3", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "CREATING", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for AttachmentsControlMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentsControlMode) Values() []AttachmentsControlMode { return []AttachmentsControlMode{ "ENABLED", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for AttachmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentStatus) Values() []AttachmentStatus { return []AttachmentStatus{ "FAILED", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for AttributeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeType) Values() []AttributeType { return []AttributeType{ "STRING", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for AttributeValueOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttributeValueOperator) Values() []AttributeValueOperator { return []AttributeValueOperator{ "DELETE", @@ -148,8 +155,9 @@ const ( ) // Values returns all known values for ChatMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChatMode) Values() []ChatMode { return []ChatMode{ "RETRIEVAL_MODE", @@ -177,8 +185,9 @@ const ( ) // Values returns all known values for ContentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentType) Values() []ContentType { return []ContentType{ "PDF", @@ -205,8 +214,9 @@ const ( ) // Values returns all known values for CreatorModeControl. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CreatorModeControl) Values() []CreatorModeControl { return []CreatorModeControl{ "ENABLED", @@ -227,8 +237,9 @@ const ( ) // Values returns all known values for DataSourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceStatus) Values() []DataSourceStatus { return []DataSourceStatus{ "PENDING_CREATION", @@ -254,8 +265,9 @@ const ( ) // Values returns all known values for DataSourceSyncJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceSyncJobStatus) Values() []DataSourceSyncJobStatus { return []DataSourceSyncJobStatus{ "FAILED", @@ -281,8 +293,9 @@ const ( // Values returns all known values for DocumentAttributeBoostingLevel. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentAttributeBoostingLevel) Values() []DocumentAttributeBoostingLevel { return []DocumentAttributeBoostingLevel{ "NONE", @@ -301,8 +314,9 @@ const ( ) // Values returns all known values for DocumentContentOperator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentContentOperator) Values() []DocumentContentOperator { return []DocumentContentOperator{ "DELETE", @@ -328,8 +342,9 @@ const ( // Values returns all known values for DocumentEnrichmentConditionOperator. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentEnrichmentConditionOperator) Values() []DocumentEnrichmentConditionOperator { return []DocumentEnrichmentConditionOperator{ "GREATER_THAN", @@ -361,8 +376,9 @@ const ( ) // Values returns all known values for DocumentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentStatus) Values() []DocumentStatus { return []DocumentStatus{ "RECEIVED", @@ -387,8 +403,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -410,8 +427,9 @@ const ( ) // Values returns all known values for GroupStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupStatus) Values() []GroupStatus { return []GroupStatus{ "FAILED", @@ -434,8 +452,9 @@ const ( ) // Values returns all known values for IndexStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndexStatus) Values() []IndexStatus { return []IndexStatus{ "CREATING", @@ -455,8 +474,9 @@ const ( ) // 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. +// in the future, and so 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{ "ENTERPRISE", @@ -473,8 +493,9 @@ const ( ) // Values returns all known values for MemberRelation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberRelation) Values() []MemberRelation { return []MemberRelation{ "AND", @@ -491,8 +512,9 @@ const ( ) // Values returns all known values for MembershipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MembershipType) Values() []MembershipType { return []MembershipType{ "INDEX", @@ -509,8 +531,9 @@ const ( ) // Values returns all known values for MessageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageType) Values() []MessageType { return []MessageType{ "USER", @@ -527,8 +550,9 @@ const ( ) // Values returns all known values for MessageUsefulness. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageUsefulness) Values() []MessageUsefulness { return []MessageUsefulness{ "USEFUL", @@ -555,8 +579,9 @@ const ( ) // Values returns all known values for MessageUsefulnessReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageUsefulnessReason) Values() []MessageUsefulnessReason { return []MessageUsefulnessReason{ "NOT_FACTUALLY_CORRECT", @@ -584,6 +609,7 @@ const ( // Values returns all known values for NumberAttributeBoostingType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NumberAttributeBoostingType) Values() []NumberAttributeBoostingType { return []NumberAttributeBoostingType{ @@ -606,8 +632,9 @@ const ( ) // Values returns all known values for PluginBuildStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PluginBuildStatus) Values() []PluginBuildStatus { return []PluginBuildStatus{ "READY", @@ -629,8 +656,9 @@ const ( ) // Values returns all known values for PluginState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PluginState) Values() []PluginState { return []PluginState{ "ENABLED", @@ -650,8 +678,9 @@ const ( ) // Values returns all known values for PluginType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PluginType) Values() []PluginType { return []PluginType{ "SERVICE_NOW", @@ -671,8 +700,9 @@ const ( ) // Values returns all known values for ReadAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReadAccessType) Values() []ReadAccessType { return []ReadAccessType{ "ALLOW", @@ -689,8 +719,9 @@ const ( ) // Values returns all known values for ResponseScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResponseScope) Values() []ResponseScope { return []ResponseScope{ "ENTERPRISE_CONTENT_ONLY", @@ -708,8 +739,9 @@ const ( ) // Values returns all known values for RetrieverStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetrieverStatus) Values() []RetrieverStatus { return []RetrieverStatus{ "CREATING", @@ -727,8 +759,9 @@ const ( ) // Values returns all known values for RetrieverType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetrieverType) Values() []RetrieverType { return []RetrieverType{ "NATIVE_INDEX", @@ -745,8 +778,9 @@ const ( ) // Values returns all known values for RuleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleType) Values() []RuleType { return []RuleType{ "CONTENT_BLOCKER_RULE", @@ -763,8 +797,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "ENABLED", @@ -784,8 +819,9 @@ const ( // Values returns all known values for StringAttributeValueBoostingLevel. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StringAttributeValueBoostingLevel) Values() []StringAttributeValueBoostingLevel { return []StringAttributeValueBoostingLevel{ "LOW", @@ -806,6 +842,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -825,8 +862,9 @@ const ( // Values returns all known values for WebExperienceSamplePromptsControlMode. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebExperienceSamplePromptsControlMode) Values() []WebExperienceSamplePromptsControlMode { return []WebExperienceSamplePromptsControlMode{ "ENABLED", @@ -846,8 +884,9 @@ const ( ) // Values returns all known values for WebExperienceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WebExperienceStatus) Values() []WebExperienceStatus { return []WebExperienceStatus{ "CREATING", diff --git a/service/qbusiness/types/errors.go b/service/qbusiness/types/errors.go index 3452426fa88..95c553e1f2d 100644 --- a/service/qbusiness/types/errors.go +++ b/service/qbusiness/types/errors.go @@ -7,7 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// You don't have access to perform this action. Make sure you have the required +// You don't have access to perform this action. Make sure you have the required +// // permission policies and user accounts and try again. type AccessDeniedException struct { Message *string @@ -65,8 +66,9 @@ func (e *ConflictException) ErrorCode() string { func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // An issue occurred with the internal server used for your Amazon Q Business -// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) -// for help. +// service. Wait some minutes and try again, or contact [Support]for help. +// +// [Support]: http://aws.amazon.com/contact-us/ type InternalServerException struct { Message *string diff --git a/service/qbusiness/types/types.go b/service/qbusiness/types/types.go index eb26724a619..aab9f8ad872 100644 --- a/service/qbusiness/types/types.go +++ b/service/qbusiness/types/types.go @@ -172,7 +172,7 @@ type ActionReviewPayloadField struct { // field. DisplayDescription *string - // The name of the field. + // The name of the field. DisplayName *string // The display order of fields in a payload. @@ -204,14 +204,16 @@ type ActionReviewPayloadFieldAllowedValue struct { } // Contains details about the OpenAPI schema for a custom plugin. For more -// information, see custom plugin OpenAPI schemas (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema) -// . You can either include the schema directly in the payload field or you can -// upload it to an S3 bucket and specify the S3 bucket location in the s3 field. +// information, see [custom plugin OpenAPI schemas]. You can either include the schema directly in the payload +// field or you can upload it to an S3 bucket and specify the S3 bucket location in +// the s3 field. // // The following types satisfy this interface: // // APISchemaMemberPayload // APISchemaMemberS3 +// +// [custom plugin OpenAPI schemas]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema type APISchema interface { isAPISchema() } @@ -271,13 +273,15 @@ type AppliedAttachmentsConfiguration struct { // The creator mode specific admin controls configured for an Amazon Q Business // application. Determines whether an end user can generate LLM-only responses when -// they use the web experience. For more information, see Admin controls and -// guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) -// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) -// . +// they use the web experience. +// +// For more information, see [Admin controls and guardrails] and [Conversation settings]. +// +// [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope +// [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html type AppliedCreatorModeConfiguration struct { - // Information about whether creator mode is enabled or disabled for an Amazon Q + // Information about whether creator mode is enabled or disabled for an Amazon Q // Business application. // // This member is required. @@ -346,44 +350,53 @@ type AttributeFilter struct { AndAllFilters []AttributeFilter // Returns true when a document contains all the specified document attributes or - // metadata fields. Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : stringListValue . + // metadata fields. Supported for the following [document attribute value types]: stringListValue . + // + // [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html ContainsAll *DocumentAttribute // Returns true when a document contains any of the specified document attributes - // or metadata fields. Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : dateValue , longValue , stringListValue and stringValue . + // or metadata fields. Supported for the following [document attribute value types]: dateValue , longValue , + // stringListValue and stringValue . + // + // [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html ContainsAny *DocumentAttribute // Performs an equals operation on two document attributes or metadata fields. - // Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : dateValue , longValue , stringListValue and stringValue . + // Supported for the following [document attribute value types]: dateValue , longValue , stringListValue and + // stringValue . + // + // [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html EqualsTo *DocumentAttribute // Performs a greater than operation on two document attributes or metadata - // fields. Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : dateValue and longValue . + // fields. Supported for the following [document attribute value types]: dateValue and longValue . + // + // [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html GreaterThan *DocumentAttribute // Performs a greater or equals than operation on two document attributes or - // metadata fields. Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : dateValue and longValue . + // metadata fields. Supported for the following [document attribute value types]: dateValue and longValue . + // + // [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html GreaterThanOrEquals *DocumentAttribute // Performs a less than operation on two document attributes or metadata fields. - // Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : dateValue and longValue . + // Supported for the following [document attribute value types]: dateValue and longValue . + // + // [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html LessThan *DocumentAttribute // Performs a less than or equals operation on two document attributes or metadata - // fields.Supported for the following document attribute value type (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) - // : dateValue and longValue . + // fields.Supported for the following [document attribute value type]: dateValue and longValue . + // + // [document attribute value type]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html LessThanOrEquals *DocumentAttribute // Performs a logical NOT operation on all supplied filters. NotFilter *AttributeFilter - // Performs a logical OR operation on all supplied filters. + // Performs a logical OR operation on all supplied filters. OrAllFilters []AttributeFilter noSmithyDocumentSerde @@ -561,14 +574,16 @@ type ChatInputStreamMemberTextEvent struct { func (*ChatInputStreamMemberTextEvent) isChatInputStream() {} -// Configuration information for Amazon Q Business conversation modes. For more -// information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) -// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) -// . +// Configuration information for Amazon Q Business conversation modes. +// +// For more information, see [Admin controls and guardrails] and [Conversation settings]. // // The following types satisfy this interface: // // ChatModeConfigurationMemberPluginConfiguration +// +// [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope +// [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html type ChatModeConfiguration interface { isChatModeConfiguration() } @@ -652,24 +667,31 @@ type ConfigurationEvent struct { AttributeFilter *AttributeFilter // The chat modes available to an Amazon Q Business end user. + // // - RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. // When this mode is enabled, Amazon Q Business generates responses only from data // sources connected to an Amazon Q Business application. + // // - CREATOR_MODE - By selecting this mode, users can choose to generate // responses only from the LLM knowledge, without consulting connected data // sources, for a chat request. + // // - PLUGIN_MODE - By selecting this mode, users can choose to use plugins in // chat. - // For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) - // , Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html) - // , and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) - // . + // + // For more information, see [Admin controls and guardrails], [Plugins], and [Conversation settings]. + // + // [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope + // [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html + // [Plugins]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html ChatMode ChatMode - // Configuration information for Amazon Q Business conversation modes. For more - // information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) - // and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) - // . + // Configuration information for Amazon Q Business conversation modes. + // + // For more information, see [Admin controls and guardrails] and [Conversation settings]. + // + // [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope + // [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html ChatModeConfiguration ChatModeConfiguration noSmithyDocumentSerde @@ -714,10 +736,12 @@ type Conversation struct { noSmithyDocumentSerde } -// Configuration information required to invoke chat in CREATOR_MODE . For more -// information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) -// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) -// . +// Configuration information required to invoke chat in CREATOR_MODE . +// +// For more information, see [Admin controls and guardrails] and [Conversation settings]. +// +// [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope +// [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html type CreatorModeConfiguration struct { // Status information about whether CREATOR_MODE has been enabled or disabled. The @@ -856,10 +880,12 @@ type DataSourceVpcConfiguration struct { noSmithyDocumentSerde } -// Provides information on boosting DATE type document attributes. For more -// information on how boosting document attributes work in Amazon Q Business, see -// Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html) -// . +// Provides information on boosting DATE type document attributes. +// +// For more information on how boosting document attributes work in Amazon Q +// Business, see [Boosting using document attributes]. +// +// [Boosting using document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html type DateAttributeBoostingConfiguration struct { // Specifies how much a document attribute is boosted. @@ -903,9 +929,11 @@ type Document struct { // The contents of the document. Content DocumentContent - // The file type of the document in the Blob field. If you want to index snippets - // or subsets of HTML documents instead of the entirety of the HTML documents, you - // add the HTML start and closing tags ( content ) around the content. + // The file type of the document in the Blob field. + // + // If you want to index snippets or subsets of HTML documents instead of the + // entirety of the HTML documents, you add the HTML start and closing tags ( + // content ) around the content. ContentType ContentType // The configuration information for altering document metadata and content during @@ -937,15 +965,15 @@ type DocumentAttribute struct { // Provides information on boosting supported Amazon Q Business document attribute // types. When an end user chat query matches document attributes that have been // boosted, Amazon Q Business prioritizes generating responses from content that -// matches the boosted document attributes. For STRING and STRING_LIST type -// document attributes to be used for boosting on the console and the API, they -// must be enabled for search using the DocumentAttributeConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html) -// object of the UpdateIndex (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html) -// API. If you haven't enabled searching on these attributes, you can't boost -// attributes of these data types on either the console or the API. For more -// information on how boosting document attributes work in Amazon Q Business, see -// Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html) -// . +// matches the boosted document attributes. +// +// For STRING and STRING_LIST type document attributes to be used for boosting on +// the console and the API, they must be enabled for search using the [DocumentAttributeConfiguration]object of +// the [UpdateIndex]API. If you haven't enabled searching on these attributes, you can't boost +// attributes of these data types on either the console or the API. +// +// For more information on how boosting document attributes work in Amazon Q +// Business, see [Boosting using document attributes]. // // The following types satisfy this interface: // @@ -953,6 +981,10 @@ type DocumentAttribute struct { // DocumentAttributeBoostingConfigurationMemberNumberConfiguration // DocumentAttributeBoostingConfigurationMemberStringConfiguration // DocumentAttributeBoostingConfigurationMemberStringListConfiguration +// +// [Boosting using document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html +// [DocumentAttributeConfiguration]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html +// [UpdateIndex]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html type DocumentAttributeBoostingConfiguration interface { isDocumentAttributeBoostingConfiguration() } @@ -998,31 +1030,41 @@ func (*DocumentAttributeBoostingConfigurationMemberStringListConfiguration) isDo } // The condition used for the target document attribute or metadata field when -// ingesting documents into Amazon Q Business. You use this with -// DocumentAttributeTarget (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) -// to apply the condition. 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 Q Business can't 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 Q Business then will map -// your newly created metadata field to your index field. +// ingesting documents into Amazon Q Business. You use this with [DocumentAttributeTarget] +// DocumentAttributeTarget to apply the condition. +// +// 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 Q Business can't 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 Q Business then +// will map your newly created metadata field to your index field. +// +// [DocumentAttributeTarget]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html type DocumentAttributeCondition struct { - // The identifier of the document attribute used for the condition. For example, - // 'Source_URI' could be an identifier for the attribute or metadata field that - // contains source URIs associated with the documents. Amazon Q Business currently - // doesn't support _document_body as an attribute key used for the condition. + // The identifier of the document attribute used for the condition. + // + // For example, 'Source_URI' could be an identifier for the attribute or metadata + // field that contains source URIs associated with the documents. + // + // Amazon Q Business currently doesn't support _document_body as an attribute key + // used for the condition. // // This member is required. Key *string - // The identifier of the document attribute used for the condition. For example, - // 'Source_URI' could be an identifier for the attribute or metadata field that - // contains source URIs associated with the documents. Amazon Q Business currently - // does not support _document_body as an attribute key used for the condition. + // The identifier of the document attribute used for the condition. + // + // For example, 'Source_URI' could be an identifier for the attribute or metadata + // field that contains source URIs associated with the documents. + // + // Amazon Q Business currently does not support _document_body as an attribute key + // used for the condition. // // This member is required. Operator DocumentEnrichmentConditionOperator @@ -1036,9 +1078,11 @@ type DocumentAttributeCondition struct { // Configuration information for document attributes. Document attributes are // metadata or fields associated with your documents. For example, the company -// department name associated with each document. For more information, see -// Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html) -// . +// department name associated with each document. +// +// For more information, see [Understanding document attributes]. +// +// [Understanding document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html type DocumentAttributeConfiguration struct { // The name of the document attribute. @@ -1055,18 +1099,23 @@ type DocumentAttributeConfiguration struct { } // The target document attribute or metadata field you want to alter when -// ingesting documents into Amazon Q Business. For example, you can delete all -// customer identification numbers associated with the documents, stored in the -// document metadata field called 'Customer_ID' by setting the target key as -// 'Customer_ID' and 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 Q Business can't 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) -// . Amazon Q Business will then map your newly created document attribute to your -// index field. You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html) -// . +// ingesting documents into Amazon Q Business. +// +// For example, you can delete all customer identification numbers associated with +// the documents, stored in the document metadata field called 'Customer_ID' by +// setting the target key as 'Customer_ID' and 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 Q Business can't 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]DocumentAttributeTarget . Amazon Q Business will +// then map your newly created document attribute to your index field. +// +// You can also use this with [DocumentAttributeCondition]DocumentAttributeCondition . +// +// [DocumentAttributeTarget]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html +// [DocumentAttributeCondition]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html type DocumentAttributeTarget struct { // The identifier of the target document attribute or metadata field. For example, @@ -1100,10 +1149,11 @@ type DocumentAttributeValue interface { isDocumentAttributeValue() } -// A date expressed as an ISO 8601 string. It's important for the time zone to be -// included in the ISO 8601 date-time format. For example, -// 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 -// at 12:30PM (plus 10 seconds) in Central European Time. +// A date expressed as an ISO 8601 string. +// +// It's important for the time zone to be included in the ISO 8601 date-time +// format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format +// for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. type DocumentAttributeValueMemberDateValue struct { Value time.Time @@ -1193,9 +1243,11 @@ type DocumentDetails struct { } // Provides the configuration information for altering document metadata and -// content during the document ingestion process. For more information, see Custom -// document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) -// . +// content during the document ingestion process. +// +// For more information, see [Custom document enrichment]. +// +// [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html type DocumentEnrichmentConfiguration struct { // Configuration information to alter document attributes or metadata fields and @@ -1204,26 +1256,42 @@ type DocumentEnrichmentConfiguration struct { // Provides the configuration information for invoking a Lambda function in Lambda // to alter document metadata and content when ingesting documents into Amazon Q - // Business. You can configure your Lambda function using the - // PreExtractionHookConfiguration parameter if you want to apply advanced - // alterations on the original or raw documents. If you want to apply advanced - // alterations on the Amazon Q Business structured documents, you must configure - // your Lambda function using PostExtractionHookConfiguration . You can only invoke - // one Lambda function. However, this function can invoke other functions it - // requires. For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) - // . + // Business. + // + // You can configure your Lambda function using the PreExtractionHookConfiguration + // parameter if you want to apply advanced alterations on the original or raw + // documents. + // + // If you want to apply advanced alterations on the Amazon Q Business structured + // documents, you must configure your Lambda function using + // PostExtractionHookConfiguration . + // + // You can only invoke one Lambda function. However, this function can invoke + // other functions it requires. + // + // For more information, see [Custom document enrichment]. + // + // [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html PostExtractionHookConfiguration *HookConfiguration // Provides the configuration information for invoking a Lambda function in Lambda // to alter document metadata and content when ingesting documents into Amazon Q - // Business. You can configure your Lambda function using the - // PreExtractionHookConfiguration parameter if you want to apply advanced - // alterations on the original or raw documents. If you want to apply advanced - // alterations on the Amazon Q Business structured documents, you must configure - // your Lambda function using PostExtractionHookConfiguration . You can only invoke - // one Lambda function. However, this function can invoke other functions it - // requires. For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) - // . + // Business. + // + // You can configure your Lambda function using the PreExtractionHookConfiguration + // parameter if you want to apply advanced alterations on the original or raw + // documents. + // + // If you want to apply advanced alterations on the Amazon Q Business structured + // documents, you must configure your Lambda function using + // PostExtractionHookConfiguration . + // + // You can only invoke one Lambda function. However, this function can invoke + // other functions it requires. + // + // For more information, see [Custom document enrichment]. + // + // [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html PreExtractionHookConfiguration *HookConfiguration noSmithyDocumentSerde @@ -1276,7 +1344,7 @@ type FailedAttachmentEvent struct { // The details of a file uploaded during chat. Attachment *AttachmentOutput - // The identifier of the conversation associated with the failed file upload. + // The identifier of the conversation associated with the failed file upload. ConversationId *string // The identifier of the AI-generated message associated with the file upload. @@ -1349,25 +1417,35 @@ type GroupSummary struct { // Provides the configuration information for invoking a Lambda function in Lambda // to alter document metadata and content when ingesting documents into Amazon Q -// Business. You can configure your Lambda function using the -// PreExtractionHookConfiguration parameter if you want to apply advanced -// alterations on the original or raw documents. If you want to apply advanced -// alterations on the Amazon Q Business structured documents, you must configure -// your Lambda function using PostExtractionHookConfiguration . You can only invoke -// one Lambda function. However, this function can invoke other functions it -// requires. For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) -// . +// Business. +// +// You can configure your Lambda function using the PreExtractionHookConfiguration +// parameter if you want to apply advanced alterations on the original or raw +// documents. +// +// If you want to apply advanced alterations on the Amazon Q Business structured +// documents, you must configure your Lambda function using +// PostExtractionHookConfiguration . +// +// You can only invoke one Lambda function. However, this function can invoke +// other functions it requires. +// +// For more information, see [Custom document enrichment]. +// +// [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html type HookConfiguration struct { - // The condition used for when a Lambda function should be invoked. For example, - // you can specify a condition that if there are empty date-time values, then - // Amazon Q Business should invoke a function that inserts the current date-time. + // The condition used for when a Lambda function should be invoked. + // + // For example, you can specify a condition that if there are empty date-time + // values, then Amazon Q Business should invoke a function that inserts the current + // date-time. InvocationCondition *DocumentAttributeCondition // The Amazon Resource Name (ARN) of a role with permission to run a Lambda - // function during ingestion. For more information, see IAM roles for Custom - // Document Enrichment (CDE) (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role) - // . + // function during ingestion. For more information, see [IAM roles for Custom Document Enrichment (CDE)]. + // + // [IAM roles for Custom Document Enrichment (CDE)]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role LambdaArn *string // The Amazon Resource Name (ARN) of a role with permission to run @@ -1376,9 +1454,9 @@ type HookConfiguration struct { RoleArn *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/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts) - // . + // and after altering them. For more information, see [Data contracts for Lambda functions]. + // + // [Data contracts for Lambda functions]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts S3BucketName *string noSmithyDocumentSerde @@ -1425,42 +1503,55 @@ type IndexStatistics struct { // Provides the configuration information for applying basic logic to alter // document metadata and content when ingesting documents into Amazon Q Business. -// To apply advanced logic, to go beyond what you can do with basic logic, see -// HookConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html) -// . For more information, see Custom document enrichment (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) -// . +// +// To apply advanced logic, to go beyond what you can do with basic logic, see [HookConfiguration] +// HookConfiguration . +// +// For more information, see [Custom document enrichment]. +// +// [Custom document enrichment]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html +// [HookConfiguration]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html type InlineDocumentEnrichmentConfiguration struct { // The condition used for the target document attribute or metadata field when - // ingesting documents into Amazon Q Business. You use this with - // DocumentAttributeTarget (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) - // to apply the condition. 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 Q Business can't 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 Q Business then will map - // your newly created metadata field to your index field. + // ingesting documents into Amazon Q Business. You use this with [DocumentAttributeTarget] + // DocumentAttributeTarget to apply the condition. + // + // 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 Q Business can't 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 Q Business then + // will map your newly created metadata field to your index field. + // + // [DocumentAttributeTarget]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html Condition *DocumentAttributeCondition // TRUE to delete content if the condition used for the target attribute is met. DocumentContentOperator DocumentContentOperator // The target document attribute or metadata field you want to alter when - // ingesting documents into Amazon Q Business. For example, you can delete all - // customer identification numbers associated with the documents, stored in the - // document metadata field called 'Customer_ID' by setting the target key as - // 'Customer_ID' and 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 Q Business can't 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) - // . Amazon Q Business will then map your newly created document attribute to your - // index field. You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html) - // . + // ingesting documents into Amazon Q Business. + // + // For example, you can delete all customer identification numbers associated with + // the documents, stored in the document metadata field called 'Customer_ID' by + // setting the target key as 'Customer_ID' and 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 Q Business can't 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]DocumentAttributeTarget . Amazon Q Business will + // then map your newly created document attribute to your index field. + // + // You can also use this with [DocumentAttributeCondition]DocumentAttributeCondition . + // + // [DocumentAttributeTarget]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html + // [DocumentAttributeCondition]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html Target *DocumentAttributeTarget noSmithyDocumentSerde @@ -1608,10 +1699,12 @@ type NoAuthConfiguration struct { noSmithyDocumentSerde } -// Provides information on boosting NUMBER type document attributes. For more -// information on how boosting document attributes work in Amazon Q Business, see -// Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html) -// . +// Provides information on boosting NUMBER type document attributes. +// +// For more information on how boosting document attributes work in Amazon Q +// Business, see [Boosting using document attributes]. +// +// [Boosting using document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html type NumberAttributeBoostingConfiguration struct { // Specifies the duration, in seconds, of a boost applies to a NUMBER type @@ -1716,14 +1809,16 @@ type PluginAuthConfigurationMemberOAuth2ClientCredentialConfiguration struct { func (*PluginAuthConfigurationMemberOAuth2ClientCredentialConfiguration) isPluginAuthConfiguration() { } -// Configuration information required to invoke chat in PLUGIN_MODE . For more -// information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) -// , Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html) -// , and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope) -// . +// Configuration information required to invoke chat in PLUGIN_MODE . +// +// For more information, see [Admin controls and guardrails], [Plugins], and [Conversation settings]. +// +// [Conversation settings]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope +// [Admin controls and guardrails]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html +// [Plugins]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html type PluginConfiguration struct { - // The identifier of the plugin you want to use. + // The identifier of the plugin you want to use. // // This member is required. PluginId *string @@ -1785,7 +1880,7 @@ type PrincipalUser struct { // This member is required. Access ReadAccessType - // The identifier of the user. + // The identifier of the user. Id *string // The type of group. @@ -1980,16 +2075,19 @@ type SourceAttribution struct { noSmithyDocumentSerde } -// Provides information on boosting STRING type document attributes. For STRING -// and STRING_LIST type document attributes to be used for boosting on the console -// and the API, they must be enabled for search using the -// DocumentAttributeConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html) -// object of the UpdateIndex (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html) -// API. If you haven't enabled searching on these attributes, you can't boost -// attributes of these data types on either the console or the API. For more -// information on how boosting document attributes work in Amazon Q Business, see -// Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html) -// . +// Provides information on boosting STRING type document attributes. +// +// For STRING and STRING_LIST type document attributes to be used for boosting on +// the console and the API, they must be enabled for search using the [DocumentAttributeConfiguration]object of +// the [UpdateIndex]API. If you haven't enabled searching on these attributes, you can't boost +// attributes of these data types on either the console or the API. +// +// For more information on how boosting document attributes work in Amazon Q +// Business, see [Boosting using document attributes]. +// +// [Boosting using document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html +// [DocumentAttributeConfiguration]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html +// [UpdateIndex]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html type StringAttributeBoostingConfiguration struct { // Specifies how much a document attribute is boosted. @@ -2003,16 +2101,19 @@ type StringAttributeBoostingConfiguration struct { noSmithyDocumentSerde } -// Provides information on boosting STRING_LIST type document attributes. For -// STRING and STRING_LIST type document attributes to be used for boosting on the -// console and the API, they must be enabled for search using the -// DocumentAttributeConfiguration (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html) -// object of the UpdateIndex (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html) -// API. If you haven't enabled searching on these attributes, you can't boost -// attributes of these data types on either the console or the API. For more -// information on how boosting document attributes work in Amazon Q Business, see -// Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html) -// . +// Provides information on boosting STRING_LIST type document attributes. +// +// For STRING and STRING_LIST type document attributes to be used for boosting on +// the console and the API, they must be enabled for search using the [DocumentAttributeConfiguration]object of +// the [UpdateIndex]API. If you haven't enabled searching on these attributes, you can't boost +// attributes of these data types on either the console or the API. +// +// For more information on how boosting document attributes work in Amazon Q +// Business, see [Boosting using document attributes]. +// +// [Boosting using document attributes]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html +// [DocumentAttributeConfiguration]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html +// [UpdateIndex]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html type StringListAttributeBoostingConfiguration struct { // Specifies how much a document attribute is boosted. @@ -2028,7 +2129,7 @@ type StringListAttributeBoostingConfiguration struct { // following symbols: _ . : / = + - @. type Tag struct { - // The key for the tag. Keys are not case sensitive and must be unique for the + // The key for the tag. Keys are not case sensitive and must be unique for the // Amazon Q Business application or data source. // // This member is required. diff --git a/service/qconnect/api_op_CreateAssistant.go b/service/qconnect/api_op_CreateAssistant.go index 08bc0530d58..adeaa0a0755 100644 --- a/service/qconnect/api_op_CreateAssistant.go +++ b/service/qconnect/api_op_CreateAssistant.go @@ -41,23 +41,26 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the assistant. Description *string // The configuration information for the customer managed key used for encryption. + // // The customer managed key must have a policy that allows kms:CreateGrant , // kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM // identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect // with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , // and kms:DescribeKey permissions to the connect.amazonaws.com service principal. + // // For more information about setting up a customer managed key for Amazon Q in - // Connect, see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . + // Connect, see [Enable Amazon Q in Connect for your instance]. + // + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. diff --git a/service/qconnect/api_op_CreateAssistantAssociation.go b/service/qconnect/api_op_CreateAssistantAssociation.go index 3465fc8b1d1..af94468af95 100644 --- a/service/qconnect/api_op_CreateAssistantAssociation.go +++ b/service/qconnect/api_op_CreateAssistantAssociation.go @@ -49,9 +49,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The tags used to organize, track, or control access for this resource. diff --git a/service/qconnect/api_op_CreateContent.go b/service/qconnect/api_op_CreateContent.go index 502e0d694ff..fa26e42d88a 100644 --- a/service/qconnect/api_op_CreateContent.go +++ b/service/qconnect/api_op_CreateContent.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates Amazon Q in Connect content. Before to calling this API, use -// StartContentUpload (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html) -// to upload an asset. +// Creates Amazon Q in Connect content. Before to calling this API, use [StartContentUpload] to upload +// an asset. +// +// [StartContentUpload]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html func (c *Client) CreateContent(ctx context.Context, params *CreateContentInput, optFns ...func(*Options)) (*CreateContentOutput, error) { if params == nil { params = &CreateContentInput{} @@ -39,23 +40,25 @@ 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/amazon-q-connect/latest/APIReference/API_SearchContent.html) - // API. + // and its name with the [SearchContent]API. + // + // [SearchContent]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html // // This member is required. Name *string - // A pointer to the uploaded asset. This value is returned by StartContentUpload (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html) - // . + // A pointer to the uploaded asset. This value is returned by [StartContentUpload]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A key/value map to store attributes without affecting tagging or diff --git a/service/qconnect/api_op_CreateKnowledgeBase.go b/service/qconnect/api_op_CreateKnowledgeBase.go index 4ef62fccc0a..609f1adce3e 100644 --- a/service/qconnect/api_op_CreateKnowledgeBase.go +++ b/service/qconnect/api_op_CreateKnowledgeBase.go @@ -11,20 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a knowledge base. When using this API, you cannot reuse Amazon -// 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/amazon-q-connect/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. +// Creates a knowledge base. +// +// When using this API, you cannot reuse [Amazon AppIntegrations] 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]. +// +// - Call [DeleteDataIntegration]. +// +// - Call [CreateDataIntegration]to recreate the DataIntegration or a create different one. +// // - Call CreateKnowledgeBase. +// +// [Amazon AppIntegrations]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html +// [DeleteKnowledgeBase]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html +// [DeleteDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error) { if params == nil { params = &CreateKnowledgeBaseInput{} @@ -56,9 +64,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description. @@ -68,12 +76,15 @@ type CreateKnowledgeBaseInput struct { RenderingConfiguration *types.RenderingConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using - // the key to invoke Amazon Q in Connect. For more information about setting up a - // customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect - // for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . + // the key to invoke Amazon Q in Connect. + // + // For more information about setting up a customer managed key for Amazon Q in + // Connect, see [Enable Amazon Q in Connect for your instance]. + // + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // The source of the knowledge base content. Only set this argument for EXTERNAL diff --git a/service/qconnect/api_op_CreateQuickResponse.go b/service/qconnect/api_op_CreateQuickResponse.go index ade9eba4003..5ef99cadcb2 100644 --- a/service/qconnect/api_op_CreateQuickResponse.go +++ b/service/qconnect/api_op_CreateQuickResponse.go @@ -50,14 +50,16 @@ type CreateQuickResponseInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for a quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for a quick response written // in richtext. ContentType *string diff --git a/service/qconnect/api_op_CreateSession.go b/service/qconnect/api_op_CreateSession.go index e323fadcc12..af0cc91ac1e 100644 --- a/service/qconnect/api_op_CreateSession.go +++ b/service/qconnect/api_op_CreateSession.go @@ -44,9 +44,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description. diff --git a/service/qconnect/api_op_DeleteKnowledgeBase.go b/service/qconnect/api_op_DeleteKnowledgeBase.go index 0041dfdcf1f..2a363203253 100644 --- a/service/qconnect/api_op_DeleteKnowledgeBase.go +++ b/service/qconnect/api_op_DeleteKnowledgeBase.go @@ -10,14 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// in the Amazon AppIntegrations API Reference. +// 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]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]and [CreateDataIntegration] in the Amazon +// AppIntegrations API Reference. +// +// [Amazon AppIntegrations]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html +// [DeleteDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error) { if params == nil { params = &DeleteKnowledgeBaseInput{} diff --git a/service/qconnect/api_op_GetRecommendations.go b/service/qconnect/api_op_GetRecommendations.go index 571c53d2456..714c0cf837a 100644 --- a/service/qconnect/api_op_GetRecommendations.go +++ b/service/qconnect/api_op_GetRecommendations.go @@ -14,18 +14,21 @@ import ( // This API will be discontinued starting June 1, 2024. To receive generative // responses after March 1, 2024, you will need to create a new Assistant in the // Amazon Connect console and integrate the Amazon Q in Connect JavaScript library -// (amazon-q-connectjs) into your applications. Retrieves recommendations for the -// specified session. To avoid retrieving the same recommendations in subsequent -// calls, use NotifyRecommendationsReceived (https://docs.aws.amazon.com/amazon-q-connect/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/amazon-q-connect/latest/APIReference/API_QueryAssistant.html) -// . +// (amazon-q-connectjs) into your applications. +// +// Retrieves recommendations for the specified session. To avoid retrieving the +// same recommendations in subsequent calls, use [NotifyRecommendationsReceived]. 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]. // // Deprecated: GetRecommendations API will be discontinued starting June 1, 2024. // To receive generative responses after March 1, 2024 you will need to create a // new Assistant in the Connect console and integrate the Amazon Q in Connect // JavaScript library (amazon-q-connectjs) into your applications. +// +// [QueryAssistant]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html +// [NotifyRecommendationsReceived]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error) { if params == nil { params = &GetRecommendationsInput{} diff --git a/service/qconnect/api_op_NotifyRecommendationsReceived.go b/service/qconnect/api_op_NotifyRecommendationsReceived.go index af6881d76ec..6534c3b1d4c 100644 --- a/service/qconnect/api_op_NotifyRecommendationsReceived.go +++ b/service/qconnect/api_op_NotifyRecommendationsReceived.go @@ -12,10 +12,11 @@ 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/amazon-q-connect/latest/APIReference/API_GetRecommendations.html) -// and a waitTimeSeconds input for long-polling behavior and avoiding duplicate +// newly available recommendations. You can use this API in conjunction with [GetRecommendations]and a +// waitTimeSeconds input for long-polling behavior and avoiding duplicate // recommendations. +// +// [GetRecommendations]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html func (c *Client) NotifyRecommendationsReceived(ctx context.Context, params *NotifyRecommendationsReceivedInput, optFns ...func(*Options)) (*NotifyRecommendationsReceivedOutput, error) { if params == nil { params = &NotifyRecommendationsReceivedInput{} diff --git a/service/qconnect/api_op_QueryAssistant.go b/service/qconnect/api_op_QueryAssistant.go index 8efcad458aa..8fba6195441 100644 --- a/service/qconnect/api_op_QueryAssistant.go +++ b/service/qconnect/api_op_QueryAssistant.go @@ -14,15 +14,17 @@ import ( // This API will be discontinued starting June 1, 2024. To receive generative // responses after March 1, 2024, you will need to create a new Assistant in the // Amazon Connect console and integrate the Amazon Q in Connect JavaScript library -// (amazon-q-connectjs) into your applications. Performs a manual search against -// the specified assistant. To retrieve recommendations for an assistant, use -// GetRecommendations (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html) -// . +// (amazon-q-connectjs) into your applications. +// +// Performs a manual search against the specified assistant. To retrieve +// recommendations for an assistant, use [GetRecommendations]. // // Deprecated: QueryAssistant API will be discontinued starting June 1, 2024. To // receive generative responses after March 1, 2024 you will need to create a new // Assistant in the Connect console and integrate the Amazon Q in Connect // JavaScript library (amazon-q-connectjs) into your applications. +// +// [GetRecommendations]: https://docs.aws.amazon.com/amazon-q-connect/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/qconnect/api_op_SearchQuickResponses.go b/service/qconnect/api_op_SearchQuickResponses.go index 4ac5bfd2e03..1f3fca78f36 100644 --- a/service/qconnect/api_op_SearchQuickResponses.go +++ b/service/qconnect/api_op_SearchQuickResponses.go @@ -41,8 +41,9 @@ type SearchQuickResponsesInput struct { // This member is required. SearchExpression *types.QuickResponseSearchExpression - // The user-defined Amazon Connect contact attributes (https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes) - // to be resolved when search results are returned. + // The [user-defined Amazon Connect contact attributes] to be resolved when search results are returned. + // + // [user-defined Amazon Connect contact attributes]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes Attributes map[string]string // The maximum number of results to return per page. diff --git a/service/qconnect/api_op_StartContentUpload.go b/service/qconnect/api_op_StartContentUpload.go index ebd033ecbf3..350d4069c50 100644 --- a/service/qconnect/api_op_StartContentUpload.go +++ b/service/qconnect/api_op_StartContentUpload.go @@ -13,10 +13,12 @@ import ( // 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/amazon-q-connect/latest/APIReference/API_CreateContent.html) -// to finalize the content creation process or UpdateContent (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html) -// to modify an existing resource. You can only upload content to a knowledge base -// of type CUSTOM. +// required headers. Then use [CreateContent]to finalize the content creation process or [UpdateContent] to +// modify an existing resource. You can only upload content to a knowledge base of +// type CUSTOM. +// +// [CreateContent]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_CreateContent.html +// [UpdateContent]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html func (c *Client) StartContentUpload(ctx context.Context, params *StartContentUploadInput, optFns ...func(*Options)) (*StartContentUploadOutput, error) { if params == nil { params = &StartContentUploadInput{} diff --git a/service/qconnect/api_op_StartImportJob.go b/service/qconnect/api_op_StartImportJob.go index 83dae73b845..8ec81c8e6a6 100644 --- a/service/qconnect/api_op_StartImportJob.go +++ b/service/qconnect/api_op_StartImportJob.go @@ -12,12 +12,15 @@ import ( ) // Start an asynchronous job to import Amazon Q in Connect resources from an -// uploaded source file. Before calling this API, use StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) -// to upload an asset that contains the resource data. +// uploaded source file. Before calling this API, use [StartContentUpload]to upload an asset that +// contains the resource data. +// // - For importing Amazon Q in Connect quick responses, you need to upload a csv // file including the quick responses. For information about how to format the csv -// file for importing quick responses, see Import quick responses (https://docs.aws.amazon.com/console/connect/quick-responses/add-data) -// . +// file for importing quick responses, see [Import quick responses]. +// +// [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html +// [Import quick responses]: https://docs.aws.amazon.com/console/connect/quick-responses/add-data func (c *Client) StartImportJob(ctx context.Context, params *StartImportJobInput, optFns ...func(*Options)) (*StartImportJobOutput, error) { if params == nil { params = &StartImportJobInput{} @@ -36,6 +39,7 @@ func (c *Client) StartImportJob(ctx context.Context, params *StartImportJobInput type StartImportJobInput struct { // The type of the import job. + // // - For importing quick response resource, set the value to QUICK_RESPONSES . // // This member is required. @@ -43,14 +47,16 @@ type StartImportJobInput struct { // The identifier of the knowledge base. Can be either the ID or the ARN. URLs // cannot contain the ARN. + // // - For importing Amazon Q in Connect quick responses, this should be a // QUICK_RESPONSES type knowledge base. // // This member is required. KnowledgeBaseId *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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string diff --git a/service/qconnect/api_op_UpdateContent.go b/service/qconnect/api_op_UpdateContent.go index 38247d0fd9a..549d69f3a94 100644 --- a/service/qconnect/api_op_UpdateContent.go +++ b/service/qconnect/api_op_UpdateContent.go @@ -66,8 +66,9 @@ type UpdateContentInput struct { // The title of the content. Title *string - // A pointer to the uploaded asset. This value is returned by StartContentUpload (https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html) - // . + // A pointer to the uploaded asset. This value is returned by [StartContentUpload]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html UploadId *string noSmithyDocumentSerde diff --git a/service/qconnect/api_op_UpdateQuickResponse.go b/service/qconnect/api_op_UpdateQuickResponse.go index f914c0c901b..979944e38a0 100644 --- a/service/qconnect/api_op_UpdateQuickResponse.go +++ b/service/qconnect/api_op_UpdateQuickResponse.go @@ -48,8 +48,10 @@ type UpdateQuickResponseInput struct { Content types.QuickResponseDataProvider // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. ContentType *string diff --git a/service/qconnect/doc.go b/service/qconnect/doc.go index 9e8cc2867f1..df625fb281d 100644 --- a/service/qconnect/doc.go +++ b/service/qconnect/doc.go @@ -3,22 +3,30 @@ // Package qconnect provides the API client, operations, and parameter types for // Amazon Q Connect. // -// Powered by Amazon Bedrock: Amazon Web Services implements automated abuse -// detection (https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html) -// . Because Amazon Q in Connect is built on Amazon Bedrock, users can take full -// advantage of the controls implemented in Amazon Bedrock to enforce safety, -// security, and the responsible use of artificial intelligence (AI). Amazon Q in -// Connect is a generative AI customer service assistant. It is an LLM-enhanced -// evolution of Amazon Connect Wisdom that delivers real-time recommendations to -// help contact center agents resolve customer issues quickly and accurately. -// Amazon Q in Connect automatically detects customer intent during calls and chats -// using conversational analytics and natural language understanding (NLU). It then -// provides agents with immediate, real-time generative responses and suggested -// actions, and links to relevant documents and articles. Agents can also query -// Amazon Q in Connect directly using natural language or keywords to answer -// customer requests. Use the Amazon Q in Connect APIs to create an assistant and a -// knowledge base, for example, or manage content by uploading custom files. For -// more information, see Use Amazon Q in Connect for generative AI powered agent -// assistance in real-time (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html) -// in the Amazon Connect Administrator Guide. +// Powered by Amazon Bedrock: Amazon Web Services implements [automated abuse detection]. Because Amazon Q +// +// in Connect is built on Amazon Bedrock, users can take full advantage of the +// controls implemented in Amazon Bedrock to enforce safety, security, and the +// responsible use of artificial intelligence (AI). +// +// Amazon Q in Connect is a generative AI customer service assistant. It is an +// LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time +// recommendations to help contact center agents resolve customer issues quickly +// and accurately. +// +// Amazon Q in Connect automatically detects customer intent during calls and +// chats using conversational analytics and natural language understanding (NLU). +// It then provides agents with immediate, real-time generative responses and +// suggested actions, and links to relevant documents and articles. Agents can also +// query Amazon Q in Connect directly using natural language or keywords to answer +// customer requests. +// +// Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, +// for example, or manage content by uploading custom files. +// +// For more information, see [Use Amazon Q in Connect for generative AI powered agent assistance in real-time] in the Amazon Connect Administrator Guide. +// +// [Use Amazon Q in Connect for generative AI powered agent assistance in real-time]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html +// +// [automated abuse detection]: https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html package qconnect diff --git a/service/qconnect/options.go b/service/qconnect/options.go index 42c2b4fba85..5add8bde102 100644 --- a/service/qconnect/options.go +++ b/service/qconnect/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/qconnect/types/enums.go b/service/qconnect/types/enums.go index f76c6637d29..869ab796573 100644 --- a/service/qconnect/types/enums.go +++ b/service/qconnect/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AssistantCapabilityType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssistantCapabilityType) Values() []AssistantCapabilityType { return []AssistantCapabilityType{ "V1", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for AssistantStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssistantStatus) Values() []AssistantStatus { return []AssistantStatus{ "CREATE_IN_PROGRESS", @@ -54,8 +56,9 @@ const ( ) // Values returns all known values for AssistantType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssistantType) Values() []AssistantType { return []AssistantType{ "AGENT", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for AssociationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationType) Values() []AssociationType { return []AssociationType{ "KNOWLEDGE_BASE", @@ -92,8 +96,9 @@ const ( ) // Values returns all known values for ContentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentStatus) Values() []ContentStatus { return []ContentStatus{ "CREATE_IN_PROGRESS", @@ -114,8 +119,9 @@ const ( ) // Values returns all known values for ExternalSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExternalSource) Values() []ExternalSource { return []ExternalSource{ "AMAZON_CONNECT", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for FilterField. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterField) Values() []FilterField { return []FilterField{ "NAME", @@ -146,8 +153,9 @@ const ( ) // Values returns all known values for FilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperator) Values() []FilterOperator { return []FilterOperator{ "EQUALS", @@ -167,8 +175,9 @@ const ( ) // Values returns all known values for ImportJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportJobStatus) Values() []ImportJobStatus { return []ImportJobStatus{ "START_IN_PROGRESS", @@ -188,8 +197,9 @@ const ( ) // Values returns all known values for ImportJobType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportJobType) Values() []ImportJobType { return []ImportJobType{ "QUICK_RESPONSES", @@ -209,8 +219,9 @@ const ( ) // Values returns all known values for KnowledgeBaseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus { return []KnowledgeBaseStatus{ "CREATE_IN_PROGRESS", @@ -232,8 +243,9 @@ const ( ) // Values returns all known values for KnowledgeBaseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseType) Values() []KnowledgeBaseType { return []KnowledgeBaseType{ "EXTERNAL", @@ -251,8 +263,9 @@ const ( ) // 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. +// the future, and so 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{ "ASC", @@ -270,8 +283,9 @@ const ( ) // Values returns all known values for Priority. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Priority) Values() []Priority { return []Priority{ "HIGH", @@ -289,8 +303,9 @@ const ( // Values returns all known values for QueryConditionComparisonOperator. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryConditionComparisonOperator) Values() []QueryConditionComparisonOperator { return []QueryConditionComparisonOperator{ "EQUALS", @@ -305,8 +320,9 @@ const ( ) // Values returns all known values for QueryConditionFieldName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryConditionFieldName) Values() []QueryConditionFieldName { return []QueryConditionFieldName{ "RESULT_TYPE", @@ -322,8 +338,9 @@ const ( ) // Values returns all known values for QueryResultType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryResultType) Values() []QueryResultType { return []QueryResultType{ "KNOWLEDGE_CONTENT", @@ -341,6 +358,7 @@ const ( // Values returns all known values for QuickResponseFilterOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (QuickResponseFilterOperator) Values() []QuickResponseFilterOperator { return []QuickResponseFilterOperator{ @@ -359,6 +377,7 @@ const ( // Values returns all known values for QuickResponseQueryOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (QuickResponseQueryOperator) Values() []QuickResponseQueryOperator { return []QuickResponseQueryOperator{ @@ -382,8 +401,9 @@ const ( ) // Values returns all known values for QuickResponseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuickResponseStatus) Values() []QuickResponseStatus { return []QuickResponseStatus{ "CREATE_IN_PROGRESS", @@ -408,6 +428,7 @@ const ( // 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{ @@ -427,6 +448,7 @@ const ( // Values returns all known values for RecommendationTriggerType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationTriggerType) Values() []RecommendationTriggerType { return []RecommendationTriggerType{ @@ -445,8 +467,9 @@ const ( ) // Values returns all known values for RecommendationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationType) Values() []RecommendationType { return []RecommendationType{ "KNOWLEDGE_CONTENT", @@ -464,8 +487,9 @@ const ( ) // Values returns all known values for Relevance. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Relevance) Values() []Relevance { return []Relevance{ "HELPFUL", @@ -483,8 +507,9 @@ const ( ) // Values returns all known values for RelevanceLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelevanceLevel) Values() []RelevanceLevel { return []RelevanceLevel{ "HIGH", @@ -501,8 +526,9 @@ const ( ) // Values returns all known values for SourceContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceContentType) Values() []SourceContentType { return []SourceContentType{ "KNOWLEDGE_CONTENT", @@ -518,8 +544,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "RECOMMENDATION", diff --git a/service/qconnect/types/types.go b/service/qconnect/types/types.go index 17a6856ea50..da72b7b2563 100644 --- a/service/qconnect/types/types.go +++ b/service/qconnect/types/types.go @@ -13,28 +13,36 @@ 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 , + // + // - For [Salesforce], 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 . - // - For Amazon S3 (https://aws.amazon.com/s3/) , the ObjectConfiguration and - // FileConfiguration of your AppIntegrations DataIntegration must be null. The - // SourceURI of your DataIntegration must use the following format: - // s3://your_s3_bucket_name . The bucket policy of the corresponding S3 bucket - // must allow the Amazon Web Services principal app-integrations.amazonaws.com to - // perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the - // bucket. + // + // - For [ServiceNow], 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], 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], your AppIntegrations DataIntegration must have a FileConfiguration, + // including only file extensions that are among docx , pdf , html , htm , and + // txt . + // + // - For [Amazon S3], the ObjectConfiguration and FileConfiguration of your AppIntegrations + // DataIntegration must be null. The SourceURI of your DataIntegration must use + // the following format: s3://your_s3_bucket_name . + // + // The bucket policy of the corresponding S3 bucket must allow the Amazon Web + // Services principal app-integrations.amazonaws.com to perform s3:ListBucket , + // s3:GetObject , and s3:GetBucketLocation against the bucket. + // + // [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api + // [Amazon S3]: https://aws.amazon.com/s3/ + // [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/ + // [SharePoint]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index + // [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm // // This member is required. AppIntegrationArn *string @@ -42,16 +50,21 @@ type AppIntegrationsConfiguration struct { // The fields from the source that are made available to your agents in Amazon Q // in Connect. 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 , + // + // - For [Salesforce], 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 , + // + // - For [ServiceNow], 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 . + // + // - For [Zendesk], 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. + // + // [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api + // [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/ + // [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm ObjectFields []string noSmithyDocumentSerde @@ -221,14 +234,17 @@ type AssistantData struct { IntegrationConfiguration *AssistantIntegrationConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using // the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the // key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and - // kms:DescribeKey permissions to the connect.amazonaws.com service principal. For - // more information about setting up a customer managed key for Amazon Q in - // Connect, see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . + // kms:DescribeKey permissions to the connect.amazonaws.com service principal. + // + // For more information about setting up a customer managed key for Amazon Q in + // Connect, see [Enable Amazon Q in Connect for your instance]. + // + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. @@ -285,14 +301,17 @@ type AssistantSummary struct { IntegrationConfiguration *AssistantIntegrationConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using // the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the // key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and - // kms:DescribeKey permissions to the connect.amazonaws.com service principal. For - // more information about setting up a customer managed key for Amazon Q in - // Connect, see Enable Amazon Q in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . + // kms:DescribeKey permissions to the connect.amazonaws.com service principal. + // + // For more information about setting up a customer managed key for Amazon Q in + // Connect, see [Enable Amazon Q in Connect for your instance]. + // + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. @@ -703,7 +722,7 @@ type GenerativeDataDetails struct { // Reference information about generative content. type GenerativeReference struct { - // The identifier of the LLM model. + // The identifier of the LLM model. GenerationId *string // The identifier of the LLM model. @@ -715,19 +734,24 @@ type GenerativeReference struct { // The configuration information of the grouping of Amazon Q in Connect users. type GroupingConfiguration struct { - // The criteria used for grouping Amazon Q in Connect users. The following is the - // list of supported criteria values. - // - RoutingProfileArn : Grouping the users by their Amazon Connect routing - // profile ARN (https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) - // . User should have SearchRoutingProfile (https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html) - // and DescribeRoutingProfile (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html) + // The criteria used for grouping Amazon Q in Connect users. + // + // The following is the list of supported criteria values. + // + // - RoutingProfileArn : Grouping the users by their [Amazon Connect routing profile ARN]. User should have [SearchRoutingProfile]and [DescribeRoutingProfile] // permissions when setting criteria to this value. + // + // [Amazon Connect routing profile ARN]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html + // [SearchRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html + // [DescribeRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html Criteria *string // The list of values that define different groups of Amazon Q in Connect users. + // // - When setting criteria to RoutingProfileArn , you need to provide a list of - // ARNs of Amazon Connect routing profiles (https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) - // as values of this parameter. + // ARNs of [Amazon Connect routing profiles]as values of this parameter. + // + // [Amazon Connect routing profiles]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html Values []string noSmithyDocumentSerde @@ -784,8 +808,9 @@ type ImportJobData struct { // This member is required. Status ImportJobStatus - // 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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string @@ -851,8 +876,9 @@ type ImportJobSummary struct { // This member is required. Status ImportJobStatus - // 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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string @@ -918,12 +944,15 @@ type KnowledgeBaseData struct { RenderingConfiguration *RenderingConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using - // the key to invoke Amazon Q in Connect. For more information about setting up a - // customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect - // for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . + // the key to invoke Amazon Q in Connect. + // + // For more information about setting up a customer managed key for Amazon Q in + // Connect, see [Enable Amazon Q in Connect for your instance]. + // + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // Source configuration information about the knowledge base. @@ -970,12 +999,15 @@ type KnowledgeBaseSummary struct { RenderingConfiguration *RenderingConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using - // the key to invoke Amazon Q in Connect. For more information about setting up a - // customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect - // for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . + // the key to invoke Amazon Q in Connect. + // + // For more information about setting up a customer managed key for Amazon Q in + // Connect, see [Enable Amazon Q in Connect for your instance]. + // + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // Configuration information about the external data source. @@ -1053,7 +1085,7 @@ type QueryConditionItem struct { // This member is required. Comparator QueryConditionComparisonOperator - // The name of the field for query condition to query on. + // The name of the field for query condition to query on. // // This member is required. Field QueryConditionFieldName @@ -1109,8 +1141,10 @@ type QuickResponseContents struct { type QuickResponseData struct { // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. // @@ -1210,19 +1244,32 @@ type QuickResponseDataProviderMemberContent struct { func (*QuickResponseDataProviderMemberContent) isQuickResponseDataProvider() {} -// The quick response fields to filter the quick response query results by. The -// following is the list of supported field names. +// The quick response fields to filter the quick response query results by. +// +// The following is the list of supported field names. +// // - name +// // - description +// // - shortcutKey +// // - isActive +// // - channels +// // - language +// // - contentType +// // - createdTime +// // - lastModifiedTime +// // - lastModifiedBy +// // - groupingConfiguration.criteria +// // - groupingConfiguration.values type QuickResponseFilterField struct { @@ -1245,19 +1292,32 @@ type QuickResponseFilterField struct { noSmithyDocumentSerde } -// The quick response fields to order the quick response query results by. The -// following is the list of supported field names. +// The quick response fields to order the quick response query results by. +// +// The following is the list of supported field names. +// // - name +// // - description +// // - shortcutKey +// // - isActive +// // - channels +// // - language +// // - contentType +// // - createdTime +// // - lastModifiedTime +// // - lastModifiedBy +// // - groupingConfiguration.criteria +// // - groupingConfiguration.values type QuickResponseOrderField struct { @@ -1272,11 +1332,16 @@ type QuickResponseOrderField struct { noSmithyDocumentSerde } -// The quick response fields to query quick responses by. The following is the -// list of supported field names. +// The quick response fields to query quick responses by. +// +// The following is the list of supported field names. +// // - content +// // - name +// // - description +// // - shortcutKey type QuickResponseQueryField struct { @@ -1326,8 +1391,10 @@ type QuickResponseSearchExpression struct { type QuickResponseSearchResultData struct { // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. // @@ -1425,8 +1492,10 @@ type QuickResponseSearchResultData struct { type QuickResponseSummary struct { // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. // @@ -1513,7 +1582,7 @@ type RecommendationData struct { // This member is required. RecommendationId *string - // Summary of the recommended content. + // Summary of the recommended content. Data *DataSummary // The recommended document. @@ -1552,8 +1621,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. // @@ -1592,14 +1663,19 @@ 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/amazon-q-connect/latest/APIReference/API_GetContent.html) - // . + // calling [GetContent]. + // + // [GetContent]: https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html TemplateUri *string noSmithyDocumentSerde @@ -1613,7 +1689,7 @@ type ResultData struct { // This member is required. ResultId *string - // Summary of the recommended content. + // Summary of the recommended content. Data *DataSummary // The document. @@ -1643,10 +1719,11 @@ type SearchExpression struct { type ServerSideEncryptionConfiguration struct { // The customer managed key used for encryption. For more information about - // setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q - // in Connect for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html) - // . For information about valid ID values, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) - // . + // setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance]. For + // information about valid ID values, see [Key identifiers (KeyId)]. + // + // [Key identifiers (KeyId)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id + // [Enable Amazon Q in Connect for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html KmsKeyId *string noSmithyDocumentSerde @@ -1753,7 +1830,7 @@ type SourceContentDataDetails struct { // This member is required. RankingData *RankingData - // Details about the source content text data. + // Details about the source content text data. // // This member is required. TextData *TextData diff --git a/service/qldb/api_op_CancelJournalKinesisStream.go b/service/qldb/api_op_CancelJournalKinesisStream.go index 22e4f5994ca..b176a63717b 100644 --- a/service/qldb/api_op_CancelJournalKinesisStream.go +++ b/service/qldb/api_op_CancelJournalKinesisStream.go @@ -11,9 +11,11 @@ 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. -// Canceled QLDB stream resources are subject to a 7-day retention period, so they -// are automatically deleted after this limit expires. +// 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) { if params == nil { params = &CancelJournalKinesisStreamInput{} diff --git a/service/qldb/api_op_CreateLedger.go b/service/qldb/api_op_CreateLedger.go index d8e80aec686..807c1a80e94 100644 --- a/service/qldb/api_op_CreateLedger.go +++ b/service/qldb/api_op_CreateLedger.go @@ -32,64 +32,88 @@ 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) - // in the Amazon QLDB Developer Guide. + // + // Naming constraints for ledger names are defined in [Quotas in Amazon QLDB] in the Amazon QLDB + // Developer Guide. + // + // [Quotas in Amazon QLDB]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming // // This member is required. Name *string // 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. + // 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. + // 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]in the Amazon QLDB Developer Guide. + // // We strongly recommend using the STANDARD permissions mode to maximize the // security of your ledger data. // + // [Getting started with the standard permissions mode]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html + // // This member is required. PermissionsMode types.PermissionsMode // Specifies whether the ledger is protected from being deleted by any user. If // not defined during 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 this parameter 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) - // in the Amazon QLDB Developer Guide. Use one of the following options to specify - // this parameter: + // in the ledger. For more information, see [Encryption at rest]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 symmetric - // encryption 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. + // encryption 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]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: + // 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. + // + // For more information, see [Key identifiers (KeyId)] in the Key Management Service Developer Guide. + // + // [Using symmetric and asymmetric keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + // [Key identifiers (KeyId)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id + // [Encryption at rest]: https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html KmsKey *string // The key-value pairs to add as tags to the ledger that you want to create. Tag @@ -111,6 +135,7 @@ type CreateLedgerOutput struct { // Specifies whether the ledger is protected from being deleted by any user. If // not defined during 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 this parameter to false . diff --git a/service/qldb/api_op_DeleteLedger.go b/service/qldb/api_op_DeleteLedger.go index 977fa48a304..3511241779f 100644 --- a/service/qldb/api_op_DeleteLedger.go +++ b/service/qldb/api_op_DeleteLedger.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// this parameter to false . +// 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 this parameter 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 b319a4fed6a..4ff27270896 100644 --- a/service/qldb/api_op_DescribeJournalKinesisStream.go +++ b/service/qldb/api_op_DescribeJournalKinesisStream.go @@ -13,10 +13,12 @@ import ( // Returns detailed information about a given Amazon QLDB journal stream. The // 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) -// in the Amazon QLDB Developer Guide. +// 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]in the Amazon QLDB Developer Guide. +// +// [Expiration for terminal streams]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration func (c *Client) DescribeJournalKinesisStream(ctx context.Context, params *DescribeJournalKinesisStreamInput, optFns ...func(*Options)) (*DescribeJournalKinesisStreamOutput, error) { if params == nil { params = &DescribeJournalKinesisStreamInput{} diff --git a/service/qldb/api_op_DescribeJournalS3Export.go b/service/qldb/api_op_DescribeJournalS3Export.go index 53bec084455..950bcf71b19 100644 --- a/service/qldb/api_op_DescribeJournalS3Export.go +++ b/service/qldb/api_op_DescribeJournalS3Export.go @@ -13,11 +13,18 @@ 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) -// 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 . +// export creation request. +// +// This action does not return any expired export jobs. For more information, see [Export job 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 . +// +// [Export job expiration]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration 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 3a2e6c70e06..b0645374b8c 100644 --- a/service/qldb/api_op_DescribeLedger.go +++ b/service/qldb/api_op_DescribeLedger.go @@ -51,6 +51,7 @@ type DescribeLedgerOutput struct { // Specifies whether the ledger is protected from being deleted by any user. If // not defined during 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 this parameter to false . diff --git a/service/qldb/api_op_ExportJournalToS3.go b/service/qldb/api_op_ExportJournalToS3.go index 9aeef4718dd..4a6b5655207 100644 --- a/service/qldb/api_op_ExportJournalToS3.go +++ b/service/qldb/api_op_ExportJournalToS3.go @@ -15,12 +15,16 @@ import ( // Exports journal contents within a date and time range from a ledger into a // specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job // can write the data objects in either the text or binary representation of Amazon -// Ion format, or in JSON Lines text format. 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 . +// Ion format, or in JSON Lines text format. +// +// 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 . func (c *Client) ExportJournalToS3(ctx context.Context, params *ExportJournalToS3Input, optFns ...func(*Options)) (*ExportJournalToS3Output, error) { if params == nil { params = &ExportJournalToS3Input{} @@ -39,19 +43,25 @@ 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 - // must be less than or equal to the current UTC date and time. + // 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 . + // 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 @@ -63,9 +73,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 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. @@ -80,12 +93,18 @@ type ExportJournalToS3Input struct { S3ExportConfiguration *types.S3ExportConfiguration // The output format of your exported journal data. A journal export job can write - // the data objects in either the text or binary representation of Amazon Ion (https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html) - // format, or in JSON Lines (https://jsonlines.org/) text format. Default: ION_TEXT + // the data objects in either the text or binary representation of [Amazon Ion]format, or in [JSON Lines] + // text format. + // + // Default: ION_TEXT + // // In JSON Lines format, each journal block in an exported data object is a valid // JSON object that is delimited by a newline. You can use this format to directly // integrate JSON exports with analytics tools such as Amazon Athena and Glue // because these services can parse newline-delimited JSON automatically. + // + // [Amazon Ion]: https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html + // [JSON Lines]: https://jsonlines.org/ OutputFormat types.OutputFormat noSmithyDocumentSerde @@ -94,8 +113,10 @@ type ExportJournalToS3Input struct { 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 . + // export job. + // + // To describe your export request and check the status of the job, you 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 586713f509a..1dcd6b20f5e 100644 --- a/service/qldb/api_op_GetBlock.go +++ b/service/qldb/api_op_GetBlock.go @@ -13,12 +13,20 @@ import ( // 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 . +// +// For information about the data contents in a block, see [Journal contents] 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 . +// // If no block exists with the specified address, then throws // InvalidParameterException . +// +// [Journal contents]: https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html func (c *Client) GetBlock(ctx context.Context, params *GetBlockInput, optFns ...func(*Options)) (*GetBlockOutput, error) { if params == nil { params = &GetBlockInput{} @@ -37,8 +45,9 @@ 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 @@ -50,7 +59,9 @@ type GetBlockInput struct { // 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} . + // sequenceNo . + // + // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49} . DigestTipAddress *types.ValueHolder noSmithyDocumentSerde diff --git a/service/qldb/api_op_GetRevision.go b/service/qldb/api_op_GetRevision.go index 631cd49573d..d2661330874 100644 --- a/service/qldb/api_op_GetRevision.go +++ b/service/qldb/api_op_GetRevision.go @@ -32,8 +32,9 @@ 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 @@ -50,7 +51,9 @@ type GetRevisionInput struct { // 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} . + // sequenceNo . + // + // For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49} . DigestTipAddress *types.ValueHolder noSmithyDocumentSerde diff --git a/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go b/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go index f8b73ee72ca..559e8f66eba 100644 --- a/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go +++ b/service/qldb/api_op_ListJournalKinesisStreamsForLedger.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns all Amazon QLDB journal streams for a given ledger. 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) -// 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. +// Returns all Amazon QLDB journal streams for a given ledger. +// +// This action does not return any expired journal streams. For more information, +// see [Expiration for terminal streams]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. +// +// [Expiration for terminal streams]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration func (c *Client) ListJournalKinesisStreamsForLedger(ctx context.Context, params *ListJournalKinesisStreamsForLedgerInput, optFns ...func(*Options)) (*ListJournalKinesisStreamsForLedgerOutput, error) { if params == nil { params = &ListJournalKinesisStreamsForLedgerInput{} @@ -56,6 +60,7 @@ 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. diff --git a/service/qldb/api_op_ListJournalS3Exports.go b/service/qldb/api_op_ListJournalS3Exports.go index 07c819562ad..8fee0ccb122 100644 --- a/service/qldb/api_op_ListJournalS3Exports.go +++ b/service/qldb/api_op_ListJournalS3Exports.go @@ -12,11 +12,15 @@ import ( ) // Returns all journal export jobs 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) +// 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] // in the Amazon QLDB Developer Guide. +// +// [Export job expiration]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration func (c *Client) ListJournalS3Exports(ctx context.Context, params *ListJournalS3ExportsInput, optFns ...func(*Options)) (*ListJournalS3ExportsOutput, error) { if params == nil { params = &ListJournalS3ExportsInput{} @@ -54,6 +58,7 @@ type ListJournalS3ExportsOutput struct { // - 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. diff --git a/service/qldb/api_op_ListJournalS3ExportsForLedger.go b/service/qldb/api_op_ListJournalS3ExportsForLedger.go index c1e3fa59041..345c6adf159 100644 --- a/service/qldb/api_op_ListJournalS3ExportsForLedger.go +++ b/service/qldb/api_op_ListJournalS3ExportsForLedger.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns all journal export jobs 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 all journal export jobs 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] // in the Amazon QLDB Developer Guide. +// +// [Export job expiration]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration func (c *Client) ListJournalS3ExportsForLedger(ctx context.Context, params *ListJournalS3ExportsForLedgerInput, optFns ...func(*Options)) (*ListJournalS3ExportsForLedgerOutput, error) { if params == nil { params = &ListJournalS3ExportsForLedgerInput{} @@ -59,6 +63,7 @@ type ListJournalS3ExportsForLedgerOutput struct { // - 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. diff --git a/service/qldb/api_op_ListLedgers.go b/service/qldb/api_op_ListLedgers.go index 22266f22635..3e219834733 100644 --- a/service/qldb/api_op_ListLedgers.go +++ b/service/qldb/api_op_ListLedgers.go @@ -12,9 +12,10 @@ import ( ) // Returns 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 ListLedgers -// multiple times. +// account and Region. +// +// This action returns a maximum of MaxResults 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{} @@ -51,8 +52,10 @@ 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. diff --git a/service/qldb/api_op_ListTagsForResource.go b/service/qldb/api_op_ListTagsForResource.go index a473bb4fe6f..14fe478b0b5 100644 --- a/service/qldb/api_op_ListTagsForResource.go +++ b/service/qldb/api_op_ListTagsForResource.go @@ -29,7 +29,8 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) for which to list the tags. For example: - // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger + // + // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger // // This member is required. ResourceArn *string diff --git a/service/qldb/api_op_StreamJournalToKinesis.go b/service/qldb/api_op_StreamJournalToKinesis.go index d0c21ea6fbc..d409eb778ea 100644 --- a/service/qldb/api_op_StreamJournalToKinesis.go +++ b/service/qldb/api_op_StreamJournalToKinesis.go @@ -34,8 +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 // . @@ -55,26 +58,31 @@ type StreamJournalToKinesisInput struct { LedgerName *string // The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for - // a journal stream to write data records to a Kinesis Data Streams resource. To - // pass a role to QLDB when requesting a journal stream, you must have permissions - // to perform the iam:PassRole action on the IAM role resource. This is required - // for all journal stream requests. + // a journal stream to write data records to a Kinesis Data Streams resource. + // + // To pass a role to QLDB when requesting a journal stream, you must have + // permissions to perform the iam:PassRole action on the IAM role resource. This + // is required for all journal stream requests. // // This member is required. RoleArn *string // 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) - // in the Amazon QLDB Developer Guide. + // 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]in + // the Amazon QLDB Developer Guide. + // + // [Quotas in Amazon QLDB]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming // // This member is required. StreamName *string // 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 + // 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 . ExclusiveEndTime *time.Time diff --git a/service/qldb/api_op_TagResource.go b/service/qldb/api_op_TagResource.go index efd8bce5a8c..17aa9b732d9 100644 --- a/service/qldb/api_op_TagResource.go +++ b/service/qldb/api_op_TagResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to a specified Amazon QLDB resource. 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. +// Adds one or more tags to a specified Amazon QLDB resource. +// +// 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. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -31,7 +32,8 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { // The Amazon Resource Name (ARN) to which you want to add the tags. For example: - // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger + // + // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger // // This member is required. ResourceArn *string diff --git a/service/qldb/api_op_UntagResource.go b/service/qldb/api_op_UntagResource.go index 32707cecbae..68d3ff5a769 100644 --- a/service/qldb/api_op_UntagResource.go +++ b/service/qldb/api_op_UntagResource.go @@ -30,7 +30,8 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { // The Amazon Resource Name (ARN) from which to remove the tags. For example: - // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger + // + // arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger // // This member is required. ResourceArn *string diff --git a/service/qldb/api_op_UpdateLedger.go b/service/qldb/api_op_UpdateLedger.go index d9e29ea18ed..b5380bae6e5 100644 --- a/service/qldb/api_op_UpdateLedger.go +++ b/service/qldb/api_op_UpdateLedger.go @@ -37,34 +37,49 @@ type UpdateLedgerInput struct { // Specifies whether the ledger is protected from being deleted by any user. If // not defined during 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 this parameter 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) - // in the Amazon QLDB Developer Guide. Use one of the following options to specify - // this parameter: + // in the ledger. For more information, see [Encryption at rest]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 symmetric - // encryption 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. + // encryption 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]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: + // 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. + // + // For more information, see [Key identifiers (KeyId)] in the Key Management Service Developer Guide. + // + // [Using symmetric and asymmetric keys]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + // [Key identifiers (KeyId)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id + // [Encryption at rest]: https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html KmsKey *string noSmithyDocumentSerde @@ -82,6 +97,7 @@ type UpdateLedgerOutput struct { // Specifies whether the ledger is protected from being deleted by any user. If // not defined during 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 this parameter to false . diff --git a/service/qldb/api_op_UpdateLedgerPermissionsMode.go b/service/qldb/api_op_UpdateLedgerPermissionsMode.go index ee80958b56e..9dfe60e442d 100644 --- a/service/qldb/api_op_UpdateLedgerPermissionsMode.go +++ b/service/qldb/api_op_UpdateLedgerPermissionsMode.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon QLDB Developer Guide. +// 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]in the Amazon QLDB Developer Guide. +// +// [Migrating to the standard permissions mode]: https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating func (c *Client) UpdateLedgerPermissionsMode(ctx context.Context, params *UpdateLedgerPermissionsModeInput, optFns ...func(*Options)) (*UpdateLedgerPermissionsModeOutput, error) { if params == nil { params = &UpdateLedgerPermissionsModeInput{} @@ -40,23 +42,29 @@ type UpdateLedgerPermissionsModeInput struct { // 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. + // 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. + // 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]in the Amazon QLDB Developer Guide. + // // We strongly recommend using the STANDARD permissions mode to maximize the // security of your ledger data. // + // [Getting started with the standard permissions mode]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html + // // This member is required. PermissionsMode types.PermissionsMode diff --git a/service/qldb/options.go b/service/qldb/options.go index 28bc949451c..aa21c704746 100644 --- a/service/qldb/options.go +++ b/service/qldb/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/qldb/types/enums.go b/service/qldb/types/enums.go index 0a097327e64..8c7f363b2b3 100644 --- a/service/qldb/types/enums.go +++ b/service/qldb/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for EncryptionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionStatus) Values() []EncryptionStatus { return []EncryptionStatus{ "ENABLED", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ErrorCause. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ErrorCause) Values() []ErrorCause { return []ErrorCause{ "KINESIS_STREAM_NOT_FOUND", @@ -50,8 +52,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for LedgerState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LedgerState) Values() []LedgerState { return []LedgerState{ "CREATING", @@ -92,8 +96,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -111,8 +116,9 @@ const ( ) // Values returns all known values for PermissionsMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionsMode) Values() []PermissionsMode { return []PermissionsMode{ "ALLOW_ALL", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for S3ObjectEncryptionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ObjectEncryptionType) Values() []S3ObjectEncryptionType { return []S3ObjectEncryptionType{ "SSE_KMS", @@ -152,8 +159,9 @@ const ( ) // 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. +// expanded in the future, and so 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 18f23476c35..1048fc6904b 100644 --- a/service/qldb/types/types.go +++ b/service/qldb/types/types.go @@ -103,7 +103,9 @@ 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. // @@ -137,12 +139,16 @@ type KinesisConfiguration struct { StreamArn *string // Enables QLDB to publish multiple data records in a single Kinesis Data Streams - // record, increasing the number of records sent per API call. Default: True + // record, increasing the number of records sent per API call. + // + // Default: True + // // 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) - // in the Amazon Kinesis Data Streams Developer Guide. + // requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts]and [Consumer De-aggregation] in the + // Amazon Kinesis Data Streams Developer Guide. + // + // [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 AggregationEnabled *bool noSmithyDocumentSerde @@ -150,26 +156,33 @@ 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) -// in the Amazon QLDB Developer Guide. +// the key became inaccessible (in the case of an error). +// +// For more information, see [Encryption at rest] in the Amazon QLDB Developer Guide. +// +// [Encryption at rest]: https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html 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. + // + // - 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 + // 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. @@ -186,8 +199,9 @@ type LedgerEncryptionDescription struct { // The date and time, in epoch time format, when the KMS key first became // inaccessible, in the case of an error. (Epoch time format is the number of - // seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.) This parameter - // is undefined if the KMS key is accessible. + // seconds that have elapsed since 12:00:00 AM January 1, 1970 UTC.) + // + // This parameter is undefined if the KMS key is accessible. InaccessibleKmsKeyDateTime *time.Time noSmithyDocumentSerde @@ -214,18 +228,22 @@ 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] in the + // Amazon S3 Developer Guide. + // + // [Protecting Data Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html // // This member is required. ObjectEncryptionType S3ObjectEncryptionType // The Amazon Resource Name (ARN) of a symmetric encryption 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 . + // 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 *string noSmithyDocumentSerde @@ -236,9 +254,12 @@ type S3EncryptionConfiguration struct { 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. + // contents. + // + // The bucket name must comply with the Amazon S3 bucket naming conventions. For + // more information, see [Bucket Restrictions and Limitations]in the Amazon S3 Developer Guide. + // + // [Bucket Restrictions and Limitations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html // // This member is required. Bucket *string @@ -250,14 +271,21 @@ type S3ExportConfiguration struct { EncryptionConfiguration *S3EncryptionConfiguration // 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: + // journal contents. + // + // The prefix must comply with Amazon S3 key naming rules and restrictions. For + // more information, see [Object Key and Metadata]in the Amazon S3 Developer Guide. + // + // The following are examples of valid Prefix values: + // // - JournalExports-ForMyLedger/Testing/ + // // - JournalExports + // // - My:Tests/ // + // [Object Key and Metadata]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html + // // This member is required. Prefix *string diff --git a/service/qldbsession/api_op_SendCommand.go b/service/qldbsession/api_op_SendCommand.go index 9a970eff519..d91806b0153 100644 --- a/service/qldbsession/api_op_SendCommand.go +++ b/service/qldbsession/api_op_SendCommand.go @@ -11,19 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. +// programming languages, see [Getting started with the driver]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) -// . +// interact with a ledger. For information, see [Accessing Amazon QLDB using the QLDB shell]. +// +// [Getting started with the driver]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html +// [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{} @@ -57,9 +60,10 @@ type SendCommandInput struct { 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. + // 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 e0bc10391ef..3fdfa513efe 100644 --- a/service/qldbsession/doc.go +++ b/service/qldbsession/doc.go @@ -3,17 +3,20 @@ // 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. +// # 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. +// programming languages, see [Getting started with the driver]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) -// . +// interact with a ledger. For information, see [Accessing Amazon QLDB using the QLDB shell]. +// +// [Getting started with the driver]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html +// [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/options.go b/service/qldbsession/options.go index b79b15fb87f..6111737b4aa 100644 --- a/service/qldbsession/options.go +++ b/service/qldbsession/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/qldbsession/types/types.go b/service/qldbsession/types/types.go index 41e49211bc5..3099f40f96f 100644 --- a/service/qldbsession/types/types.go +++ b/service/qldbsession/types/types.go @@ -26,10 +26,12 @@ type CommitTransactionRequest struct { // Specifies the commit digest for the transaction to commit. For every active // transaction, the commit digest must be passed. QLDB validates CommitDigest and // rejects the commit with an error if the digest computed on the client does not - // match the digest computed by QLDB. The purpose of the CommitDigest parameter is - // to ensure that QLDB commits a transaction if and only if the server has - // processed the exact set of statements sent by the client, in the same order that - // client sent them, and with no duplicates. + // match the digest computed by QLDB. + // + // The purpose of the CommitDigest parameter is to ensure that QLDB commits a + // transaction if and only if the server has processed the exact set of statements + // sent by the client, in the same order that client sent them, and with no + // duplicates. // // This member is required. CommitDigest []byte diff --git a/service/quicksight/api_op_CreateAccountCustomization.go b/service/quicksight/api_op_CreateAccountCustomization.go index 0432c4cf9cd..c302843666f 100644 --- a/service/quicksight/api_op_CreateAccountCustomization.go +++ b/service/quicksight/api_op_CreateAccountCustomization.go @@ -15,20 +15,24 @@ 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) -// 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. +// and videos for all new users, see [Customizing Amazon QuickSight]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) -// API operation. To share the theme, grant permissions by using the -// UpdateThemePermissions (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) -// API operation. +// shared, view the current permissions by using the [DescribeThemePermissions]API operation. To share the +// theme, grant permissions by using the [UpdateThemePermissions]API operation. +// +// [UpdateThemePermissions]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html +// [DescribeThemePermissions]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html +// [Customizing Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html func (c *Client) CreateAccountCustomization(ctx context.Context, params *CreateAccountCustomizationInput, optFns ...func(*Options)) (*CreateAccountCustomizationOutput, error) { if params == nil { params = &CreateAccountCustomizationInput{} @@ -48,10 +52,12 @@ type CreateAccountCustomizationInput struct { // The Amazon QuickSight customizations you're adding in the current Amazon Web // 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 - // custom theme by specifying "AccountCustomization": { "DefaultTheme": + // 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 custom theme by + // specifying "AccountCustomization": { "DefaultTheme": // "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" // } . // diff --git a/service/quicksight/api_op_CreateAccountSubscription.go b/service/quicksight/api_op_CreateAccountSubscription.go index 5b890f2ba1b..63e581451e1 100644 --- a/service/quicksight/api_op_CreateAccountSubscription.go +++ b/service/quicksight/api_op_CreateAccountSubscription.go @@ -11,26 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The -// Amazon Web Services Region for the account is derived from what is configured in -// the CLI or SDK. 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) -// in the Amazon QuickSight User Guide. The person who signs up for Amazon +// Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. +// +// The Amazon Web Services Region for the account is derived from what is +// configured in the CLI or SDK. +// +// 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]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) -// 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) -// in the Amazon QuickSight User Guide. +// permissions. For more information, see [IAM Policy Examples for Amazon QuickSight]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]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]in the Amazon QuickSight User Guide. +// +// [Passing IAM roles to Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role +// [Setting default resource access to Amazon Web Services services]: https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html +// [Sign up for Amazon Web Services]: https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html +// [IAM Policy Examples for Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html func (c *Client) CreateAccountSubscription(ctx context.Context, params *CreateAccountSubscriptionInput, optFns ...func(*Options)) (*CreateAccountSubscriptionOutput, error) { if params == nil { params = &CreateAccountSubscriptionInput{} @@ -56,10 +64,12 @@ type CreateAccountSubscriptionInput struct { AccountName *string // The method that you want to use to authenticate your Amazon QuickSight account. + // // If you choose ACTIVE_DIRECTORY , provide an ActiveDirectoryName and an - // AdminGroup associated with your Active Directory. If you choose - // IAM_IDENTITY_CENTER , provide an AdminGroup associated with your IAM Identity - // Center account. + // AdminGroup associated with your Active Directory. + // + // If you choose IAM_IDENTITY_CENTER , provide an AdminGroup associated with your + // IAM Identity Center account. // // This member is required. AuthenticationMethod types.AuthenticationMethodOption @@ -83,45 +93,49 @@ type CreateAccountSubscriptionInput struct { // The admin group associated with your Active Directory or IAM Identity Center // account. Either this field or the AdminProGroup field is required if // ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method - // of the new Amazon QuickSight account. For more information about using IAM - // Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon - // QuickSight Enterprise Edition (https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html) + // of the new Amazon QuickSight account. + // + // For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] // in the Amazon QuickSight User Guide. 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) - // in the Amazon QuickSight User Guide. + // Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide. + // + // [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html + // [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html AdminGroup []string // The admin pro group associated with your Active Directory or IAM Identity // Center account. Either this field or the AdminGroup field is required if // ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method - // of the new Amazon QuickSight account. For more information about using IAM - // Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon - // QuickSight Enterprise Edition (https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html) + // of the new Amazon QuickSight account. + // + // For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] // in the Amazon QuickSight User Guide. 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) - // in the Amazon QuickSight User Guide. + // Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide. + // + // [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html + // [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html AdminProGroup []string // The author group associated with your Active Directory or IAM Identity Center - // account. For more information about using IAM Identity Center in Amazon - // QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise - // Edition (https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html) + // account. + // + // For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] // in the Amazon QuickSight User Guide. 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) - // in the Amazon QuickSight User Guide. + // Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide. + // + // [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html + // [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html AuthorGroup []string // The author pro group associated with your Active Directory or IAM Identity - // Center account. For more information about using IAM Identity Center in Amazon - // QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise - // Edition (https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html) + // Center account. + // + // For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] // in the Amazon QuickSight User Guide. 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) - // in the Amazon QuickSight User Guide. + // Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide. + // + // [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html + // [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html AuthorProGroup []string // A 10-digit phone number for the author of the Amazon QuickSight account to use @@ -134,11 +148,16 @@ type CreateAccountSubscriptionInput struct { DirectoryId *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: + // you can choose from ENTERPRISE or ENTERPRISE_AND_Q . + // + // If you choose ENTERPRISE_AND_Q , the following parameters are required: + // // - FirstName + // // - LastName + // // - EmailAddress + // // - ContactNumber Edition types.Edition @@ -161,23 +180,25 @@ type CreateAccountSubscriptionInput struct { LastName *string // The reader group associated with your Active Directory or IAM Identity Center - // account. For more information about using IAM Identity Center in Amazon - // QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise - // Edition (https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html) + // account. + // + // For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] // in the Amazon QuickSight User Guide. 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) - // in the Amazon QuickSight User Guide. + // Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide. + // + // [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html + // [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html ReaderGroup []string // The reader pro group associated with your Active Directory or IAM Identity - // Center account. For more information about using IAM Identity Center in Amazon - // QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise - // Edition (https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html) + // Center account. + // + // For more information about using IAM Identity Center in Amazon QuickSight, see [Using IAM Identity Center with Amazon QuickSight Enterprise Edition] // in the Amazon QuickSight User Guide. 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) - // in the Amazon QuickSight User Guide. + // Directory in Amazon QuickSight, see [Using Active Directory with Amazon QuickSight Enterprise Edition]in the Amazon QuickSight User Guide. + // + // [Using Active Directory with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html + // [Using IAM Identity Center with Amazon QuickSight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html ReaderProGroup []string // The realm of the Active Directory that is associated with your Amazon diff --git a/service/quicksight/api_op_CreateAnalysis.go b/service/quicksight/api_op_CreateAnalysis.go index f1ae44379d4..365d890b9de 100644 --- a/service/quicksight/api_op_CreateAnalysis.go +++ b/service/quicksight/api_op_CreateAnalysis.go @@ -47,9 +47,13 @@ type CreateAnalysisInput struct { // 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 // When you create the analysis, Amazon QuickSight adds the analysis to these @@ -63,14 +67,17 @@ type CreateAnalysisInput struct { // A structure that describes the principals and the resource-level permissions on // 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 . + // each principal listed by Amazon Resource Name (ARN). + // + // To specify no permissions, omit Permissions . Permissions []types.ResourcePermission // A source entity to use for the analysis that you're creating. This metadata // structure contains details that describe a source template and one or more - // datasets. Either a SourceEntity or a Definition must be provided in order for - // the request to be valid. + // datasets. + // + // Either a SourceEntity or a Definition must be provided in order for the request + // to be valid. SourceEntity *types.AnalysisSourceEntity // Contains a map of the key-value pairs for the resource tag or tags assigned to diff --git a/service/quicksight/api_op_CreateDashboard.go b/service/quicksight/api_op_CreateDashboard.go index 7952992c07c..1325ddcd60f 100644 --- a/service/quicksight/api_op_CreateDashboard.go +++ b/service/quicksight/api_op_CreateDashboard.go @@ -12,13 +12,15 @@ 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) -// 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 -// email reports from them. If you have the correct permissions, you can create a -// dashboard from a template that exists in a different Amazon Web Services -// account. +// DashboardDefinition . To first create a template, see the [CreateTemplate] 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 email reports from them. If you +// have the correct permissions, you can create a dashboard from a template that +// exists in a different Amazon Web Services account. +// +// [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error) { if params == nil { params = &CreateDashboardInput{} @@ -53,20 +55,27 @@ 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. 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 // When you create the dashboard, Amazon QuickSight adds the dashboard to these @@ -86,21 +95,28 @@ type CreateDashboardInput struct { // A structure that contains the permissions of the dashboard. You can use this // structure for granting permissions by providing a list of IAM action information - // for each principal ARN. To specify no permissions, omit the permissions list. + // for each principal ARN. + // + // To specify no permissions, omit the permissions list. 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 // 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 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. + // template by using the [CreateTemplate]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. + // + // [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html SourceEntity *types.DashboardSourceEntity // Contains a map of the key-value pairs for the resource tag or tags assigned to diff --git a/service/quicksight/api_op_CreateDataSet.go b/service/quicksight/api_op_CreateDataSet.go index c39f3bc2b94..d677ba95904 100644 --- a/service/quicksight/api_op_CreateDataSet.go +++ b/service/quicksight/api_op_CreateDataSet.go @@ -60,8 +60,9 @@ 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]. + // + // [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 diff --git a/service/quicksight/api_op_CreateDataSource.go b/service/quicksight/api_op_CreateDataSource.go index 90eb0d500f2..d8487525f03 100644 --- a/service/quicksight/api_op_CreateDataSource.go +++ b/service/quicksight/api_op_CreateDataSource.go @@ -46,7 +46,9 @@ 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 c7113a6186a..8cc4c3e9431 100644 --- a/service/quicksight/api_op_CreateFolder.go +++ b/service/quicksight/api_op_CreateFolder.go @@ -45,12 +45,16 @@ type CreateFolderInput struct { // The name of the folder. Name *string - // The Amazon Resource Name (ARN) for the parent folder. ParentFolderArn can be - // null. An empty parentFolderArn creates a root-level folder. + // The Amazon Resource Name (ARN) for the parent folder. + // + // ParentFolderArn can be null. An empty parentFolderArn creates a root-level + // folder. 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 // An optional parameter that determines the sharing scope of the folder. The diff --git a/service/quicksight/api_op_CreateGroup.go b/service/quicksight/api_op_CreateGroup.go index 06c1214f143..f0e87d5e0fe 100644 --- a/service/quicksight/api_op_CreateGroup.go +++ b/service/quicksight/api_op_CreateGroup.go @@ -13,9 +13,11 @@ import ( // Use the CreateGroup operation to create a group in Amazon QuickSight. You can // create up to 10,000 groups in a namespace. If you want to create more than -// 10,000 groups in a namespace, contact Amazon Web Services Support. The -// permissions resource is arn:aws:quicksight:::group/default/ . The response is a -// group object. +// 10,000 groups in a namespace, contact Amazon Web Services Support. +// +// The permissions resource is arn:aws:quicksight:::group/default/ . +// +// The response is a group object. func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} diff --git a/service/quicksight/api_op_CreateIAMPolicyAssignment.go b/service/quicksight/api_op_CreateIAMPolicyAssignment.go index b6c2af5fdf0..6cd1409df10 100644 --- a/service/quicksight/api_op_CreateIAMPolicyAssignment.go +++ b/service/quicksight/api_op_CreateIAMPolicyAssignment.go @@ -40,9 +40,12 @@ 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. // @@ -81,9 +84,12 @@ 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. AssignmentStatus types.AssignmentStatus diff --git a/service/quicksight/api_op_CreateIngestion.go b/service/quicksight/api_op_CreateIngestion.go index 3d884de13fa..b74a97ad97c 100644 --- a/service/quicksight/api_op_CreateIngestion.go +++ b/service/quicksight/api_op_CreateIngestion.go @@ -15,11 +15,14 @@ import ( // 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. +// 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?]in the Amazon Web Services +// Knowledge Center. Tags are visible on the tagged dataset, but not on the +// ingestion resource. +// +// [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/ func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error) { if params == nil { params = &CreateIngestionInput{} diff --git a/service/quicksight/api_op_CreateNamespace.go b/service/quicksight/api_op_CreateNamespace.go index ec06f2b7d4a..ffe7b29d7a7 100644 --- a/service/quicksight/api_op_CreateNamespace.go +++ b/service/quicksight/api_op_CreateNamespace.go @@ -12,14 +12,16 @@ import ( ) // (Enterprise edition only) Creates a new namespace for you to use with Amazon -// QuickSight. A namespace allows you to isolate the Amazon QuickSight users and -// groups that are registered for that namespace. Users that access the namespace -// can share assets only with other users or groups in the same namespace. They -// can't see users and groups in other namespaces. You can create a namespace after -// your Amazon Web Services account is subscribed to Amazon QuickSight. The -// namespace must be unique within the Amazon Web Services account. By default, -// there is a limit of 100 namespaces per Amazon Web Services account. To increase -// your limit, create a ticket with Amazon Web Services Support. +// QuickSight. +// +// A namespace allows you to isolate the Amazon QuickSight users and groups that +// are registered for that namespace. Users that access the namespace can share +// assets only with other users or groups in the same namespace. They can't see +// users and groups in other namespaces. You can create a namespace after your +// Amazon Web Services account is subscribed to Amazon QuickSight. The namespace +// must be unique within the Amazon Web Services account. By default, there is a +// limit of 100 namespaces per Amazon Web Services account. To increase your limit, +// create a ticket with Amazon Web Services Support. func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error) { if params == nil { params = &CreateNamespaceInput{} diff --git a/service/quicksight/api_op_CreateTemplate.go b/service/quicksight/api_op_CreateTemplate.go index 83af6f5d8e9..a0acee997bf 100644 --- a/service/quicksight/api_op_CreateTemplate.go +++ b/service/quicksight/api_op_CreateTemplate.go @@ -13,13 +13,14 @@ import ( // Creates a template either from a TemplateDefinition or from an existing Amazon // QuickSight analysis or template. You can use the resulting template to create -// additional dashboards, templates, or analyses. A template is an entity in Amazon -// QuickSight that encapsulates the metadata required to create an analysis and -// that you can use to create s dashboard. A template adds a layer of abstraction -// by using placeholders to replace the dataset associated with the analysis. You -// can use templates to create dashboards by replacing dataset placeholders with -// datasets that follow the same schema that was used to create the source analysis -// and template. +// additional dashboards, templates, or analyses. +// +// A template is an entity in Amazon QuickSight that encapsulates the metadata +// required to create an analysis and that you can use to create s dashboard. A +// template adds a layer of abstraction by using placeholders to replace the +// dataset associated with the analysis. You can use templates to create dashboards +// by replacing dataset placeholders with datasets that follow the same schema that +// was used to create the source analysis and template. func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error) { if params == nil { params = &CreateTemplateInput{} @@ -50,9 +51,13 @@ type CreateTemplateInput struct { // This member is required. TemplateId *string - // The definition of a template. 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 template. + // + // 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.TemplateVersionDefinition // A display name for the template. @@ -67,11 +72,14 @@ type CreateTemplateInput struct { // 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 - // must be provided in order for the request to be valid. + // 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 must be provided in order for the request + // to be valid. SourceEntity *types.TemplateSourceEntity // Contains a map of the key-value pairs for the resource tag or tags assigned to diff --git a/service/quicksight/api_op_CreateTheme.go b/service/quicksight/api_op_CreateTheme.go index 4cdf431868b..90ff0ac2c8b 100644 --- a/service/quicksight/api_op_CreateTheme.go +++ b/service/quicksight/api_op_CreateTheme.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 the Amazon QuickSight User Guide. +// 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]in the Amazon QuickSight +// User Guide. +// +// [Using Themes in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optFns ...func(*Options)) (*CreateThemeOutput, error) { if params == nil { params = &CreateThemeInput{} @@ -32,7 +35,8 @@ func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optF type CreateThemeInput struct { - // The ID of the Amazon Web Services account where you want to store the new theme. + // The ID of the Amazon Web Services account where you want to store the new + // theme. // // This member is required. AwsAccountId *string diff --git a/service/quicksight/api_op_DeleteAnalysis.go b/service/quicksight/api_op_DeleteAnalysis.go index c73ad0cd0eb..1b078398a8b 100644 --- a/service/quicksight/api_op_DeleteAnalysis.go +++ b/service/quicksight/api_op_DeleteAnalysis.go @@ -16,13 +16,16 @@ import ( // a recovery window value, the operation defaults to 30 days. Amazon QuickSight // attaches a DeletionTime stamp to the response that specifies the end of the // recovery window. At the end of the recovery window, Amazon QuickSight deletes -// the analysis permanently. At any time before recovery window ends, you can use -// the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel -// the deletion of the analysis. The analysis remains visible in the API until it's -// deleted, so you can describe it but you can't make a template from it. An -// analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight -// console. To access it in the console, restore it. Deleting an analysis doesn't -// delete the dashboards that you publish from it. +// the analysis permanently. +// +// At any time before recovery window ends, you can use the RestoreAnalysis API +// operation to remove the DeletionTime stamp and cancel the deletion of the +// analysis. The analysis remains visible in the API until it's deleted, so you can +// describe it but you can't make a template from it. +// +// An analysis that's scheduled for deletion isn't accessible in the Amazon +// QuickSight console. To access it in the console, restore it. Deleting an +// analysis doesn't delete the dashboards that you publish from it. func (c *Client) DeleteAnalysis(ctx context.Context, params *DeleteAnalysisInput, optFns ...func(*Options)) (*DeleteAnalysisOutput, error) { if params == nil { params = &DeleteAnalysisInput{} diff --git a/service/quicksight/api_op_DeleteIdentityPropagationConfig.go b/service/quicksight/api_op_DeleteIdentityPropagationConfig.go index 8397a62e7d7..f5bb6258254 100644 --- a/service/quicksight/api_op_DeleteIdentityPropagationConfig.go +++ b/service/quicksight/api_op_DeleteIdentityPropagationConfig.go @@ -12,9 +12,10 @@ import ( ) // Deletes all access scopes and authorized targets that are associated with a -// service from the Amazon QuickSight IAM Identity Center application. This -// operation is only supported for Amazon QuickSight accounts that use IAM Identity -// Center. +// service from the Amazon QuickSight IAM Identity Center application. +// +// This operation is only supported for Amazon QuickSight accounts that use IAM +// Identity Center. func (c *Client) DeleteIdentityPropagationConfig(ctx context.Context, params *DeleteIdentityPropagationConfigInput, optFns ...func(*Options)) (*DeleteIdentityPropagationConfigOutput, error) { if params == nil { params = &DeleteIdentityPropagationConfigInput{} diff --git a/service/quicksight/api_op_DeleteTheme.go b/service/quicksight/api_op_DeleteTheme.go index 053d15e4c5b..af9ab7ac7e3 100644 --- a/service/quicksight/api_op_DeleteTheme.go +++ b/service/quicksight/api_op_DeleteTheme.go @@ -39,9 +39,10 @@ type DeleteThemeInput struct { // This member is required. ThemeId *string - // The version of the theme that you want to delete. Note: If you don't provide a - // version number, you're using this call to DeleteTheme to delete all versions of - // the theme. + // The version of the theme that you want to delete. + // + // Note: If you don't provide a version number, you're using this call to + // DeleteTheme to delete all versions of the theme. VersionNumber *int64 noSmithyDocumentSerde diff --git a/service/quicksight/api_op_DescribeAccountCustomization.go b/service/quicksight/api_op_DescribeAccountCustomization.go index ebfdabf426e..950b1ed63d4 100644 --- a/service/quicksight/api_op_DescribeAccountCustomization.go +++ b/service/quicksight/api_op_DescribeAccountCustomization.go @@ -14,44 +14,55 @@ import ( // Describes the customizations associated with the provided Amazon Web Services // account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. // The Amazon QuickSight console evaluates which customizations to apply by running -// 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. +// 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. +// 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]. +// +// - Use [named profiles]. +// +// - 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]. +// +// - 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. +// +// [named profiles]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html +// [Configuring the CLI]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html +// [command line options]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error) { if params == nil { params = &DescribeAccountCustomizationInput{} diff --git a/service/quicksight/api_op_DescribeAccountSettings.go b/service/quicksight/api_op_DescribeAccountSettings.go index 962a1a6a197..af1d29da736 100644 --- a/service/quicksight/api_op_DescribeAccountSettings.go +++ b/service/quicksight/api_op_DescribeAccountSettings.go @@ -44,12 +44,13 @@ type DescribeAccountSettingsOutput struct { // The Amazon QuickSight settings for this Amazon Web Services account. This // information includes the edition of Amazon Amazon QuickSight that you subscribed // to (Standard or Enterprise) and the notification email for the Amazon QuickSight - // subscription. In the QuickSight console, the Amazon QuickSight subscription is - // sometimes referred to as a QuickSight "account" even though it's technically not - // an account by itself. Instead, it's a subscription to the Amazon QuickSight - // service for your Amazon Web Services account. The edition that you subscribe to - // applies to Amazon QuickSight in every Amazon Web Services Region where you use - // it. + // subscription. + // + // In the QuickSight console, the Amazon QuickSight subscription is sometimes + // referred to as a QuickSight "account" even though it's technically not an + // account by itself. Instead, it's a subscription to the Amazon QuickSight service + // for your Amazon Web Services account. The edition that you subscribe to applies + // to Amazon QuickSight in every Amazon Web Services Region where you use it. AccountSettings *types.AccountSettings // The Amazon Web Services request ID for this operation. diff --git a/service/quicksight/api_op_DescribeAccountSubscription.go b/service/quicksight/api_op_DescribeAccountSubscription.go index 7c1799feacd..762ca6857cf 100644 --- a/service/quicksight/api_op_DescribeAccountSubscription.go +++ b/service/quicksight/api_op_DescribeAccountSubscription.go @@ -44,11 +44,16 @@ 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. AccountInfo *types.AccountInfo diff --git a/service/quicksight/api_op_DescribeAnalysisDefinition.go b/service/quicksight/api_op_DescribeAnalysisDefinition.go index 6fd292197b2..e9fb6c9651f 100644 --- a/service/quicksight/api_op_DescribeAnalysisDefinition.go +++ b/service/quicksight/api_op_DescribeAnalysisDefinition.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// instead. +// 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]DescribeAnalysis instead. +// +// [DescribeAnalysis]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html func (c *Client) DescribeAnalysisDefinition(ctx context.Context, params *DescribeAnalysisDefinitionInput, optFns ...func(*Options)) (*DescribeAnalysisDefinitionOutput, error) { if params == nil { params = &DescribeAnalysisDefinitionInput{} @@ -53,8 +55,10 @@ 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. @@ -67,12 +71,19 @@ 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 ResourceStatus types.ResourceStatus diff --git a/service/quicksight/api_op_DescribeAssetBundleExportJob.go b/service/quicksight/api_op_DescribeAssetBundleExportJob.go index 0d5582f5637..5327a749884 100644 --- a/service/quicksight/api_op_DescribeAssetBundleExportJob.go +++ b/service/quicksight/api_op_DescribeAssetBundleExportJob.go @@ -12,12 +12,14 @@ import ( "time" ) -// Describes an existing export job. Poll job descriptions after a job starts to -// know the status of the job. When a job succeeds, a URL is provided to download -// the exported assets' data from. Download URLs are valid for five minutes after -// they are generated. You can call the DescribeAssetBundleExportJob API for a new -// download URL as needed. Job descriptions are available for 14 days after the job -// starts. +// Describes an existing export job. +// +// Poll job descriptions after a job starts to know the status of the job. When a +// job succeeds, a URL is provided to download the exported assets' data from. +// Download URLs are valid for five minutes after they are generated. You can call +// the DescribeAssetBundleExportJob API for a new download URL as needed. +// +// Job descriptions are available for 14 days after the job starts. func (c *Client) DescribeAssetBundleExportJob(ctx context.Context, params *DescribeAssetBundleExportJobInput, optFns ...func(*Options)) (*DescribeAssetBundleExportJobOutput, error) { if params == nil { params = &DescribeAssetBundleExportJobInput{} @@ -67,17 +69,24 @@ type DescribeAssetBundleExportJobOutput struct { // The time that the export job was created. CreatedTime *time.Time - // The URL to download the exported asset bundle data from. This URL is available - // only after the job has succeeded. This URL is valid for 5 minutes after - // issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. + // The URL to download the exported asset bundle data from. + // + // This URL is available only after the job has succeeded. This URL is valid for 5 + // minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL + // if needed. + // // The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs . The - // file has a .qs extension. This URL can't be used in a StartAssetBundleImportJob - // API call and should only be used for download purposes. + // file has a .qs extension. + // + // This URL can't be used in a StartAssetBundleImportJob API call and should only + // be used for download purposes. DownloadUrl *string // An array of error records that describes any failures that occurred during the - // export job processing. Error records accumulate while the job runs. The complete - // set of error records is available after the job has completed and failed. + // export job processing. + // + // Error records accumulate while the job runs. The complete set of error records + // is available after the job has completed and failed. Errors []types.AssetBundleExportJobError // The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can @@ -95,8 +104,10 @@ type DescribeAssetBundleExportJobOutput struct { // The include tags flag. IncludeTags bool - // Indicates the status of a job through its queuing and execution. Poll this - // DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED . + // Indicates the status of a job through its queuing and execution. + // + // Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or + // FAILED . JobStatus types.AssetBundleExportJobStatus // The Amazon Web Services request ID for this operation. @@ -113,8 +124,10 @@ type DescribeAssetBundleExportJobOutput struct { // An array of warning records that describe the analysis or dashboard that is // exported. This array includes UI errors that can be skipped during the - // validation process. This property only appears if StrictModeForAllResources in - // ValidationStrategy is set to FALSE . + // validation process. + // + // This property only appears if StrictModeForAllResources in ValidationStrategy + // is set to FALSE . Warnings []types.AssetBundleExportJobWarning // Metadata pertaining to the operation's result. diff --git a/service/quicksight/api_op_DescribeAssetBundleImportJob.go b/service/quicksight/api_op_DescribeAssetBundleImportJob.go index 980622167bd..6ef7d938bd3 100644 --- a/service/quicksight/api_op_DescribeAssetBundleImportJob.go +++ b/service/quicksight/api_op_DescribeAssetBundleImportJob.go @@ -12,9 +12,10 @@ import ( "time" ) -// Describes an existing import job. Poll job descriptions after starting a job to -// know when it has succeeded or failed. Job descriptions are available for 14 days -// after job starts. +// Describes an existing import job. +// +// Poll job descriptions after starting a job to know when it has succeeded or +// failed. Job descriptions are available for 14 days after job starts. func (c *Client) DescribeAssetBundleImportJob(ctx context.Context, params *DescribeAssetBundleImportJobInput, optFns ...func(*Options)) (*DescribeAssetBundleImportJobOutput, error) { if params == nil { params = &DescribeAssetBundleImportJobInput{} @@ -66,20 +67,26 @@ type DescribeAssetBundleImportJobOutput struct { CreatedTime *time.Time // An array of error records that describes any failures that occurred during the - // export job processing. Error records accumulate while the job is still running. - // The complete set of error records is available after the job has completed and - // failed. + // export job processing. + // + // Error records accumulate while the job is still running. The complete set of + // error records is available after the job has completed and failed. Errors []types.AssetBundleImportJobError // The failure action for the import job. FailureAction types.AssetBundleImportFailureAction - // Indicates the status of a job through its queuing and execution. Poll the - // DescribeAssetBundleImport API until JobStatus returns one of the following - // values: + // Indicates the status of a job through its queuing and execution. + // + // Poll the DescribeAssetBundleImport API until JobStatus returns one of the + // following values: + // // - SUCCESSFUL + // // - FAILED + // // - FAILED_ROLLBACK_COMPLETED + // // - FAILED_ROLLBACK_ERROR JobStatus types.AssetBundleImportJobStatus @@ -102,9 +109,10 @@ type DescribeAssetBundleImportJobOutput struct { RequestId *string // An array of error records that describes any failures that occurred while an - // import job was attempting a rollback. Error records accumulate while the job is - // still running. The complete set of error records is available after the job has - // completed and failed. + // import job was attempting a rollback. + // + // Error records accumulate while the job is still running. The complete set of + // error records is available after the job has completed and failed. RollbackErrors []types.AssetBundleImportJobError // The HTTP status of the response. diff --git a/service/quicksight/api_op_DescribeDashboardDefinition.go b/service/quicksight/api_op_DescribeDashboardDefinition.go index f4af1bca46c..3365d09af3c 100644 --- a/service/quicksight/api_op_DescribeDashboardDefinition.go +++ b/service/quicksight/api_op_DescribeDashboardDefinition.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// instead. +// 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]DescribeDashboard instead. +// +// [DescribeDashboard]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html func (c *Client) DescribeDashboardDefinition(ctx context.Context, params *DescribeDashboardDefinitionInput, optFns ...func(*Options)) (*DescribeDashboardDefinitionOutput, error) { if params == nil { params = &DescribeDashboardDefinitionInput{} @@ -60,19 +62,24 @@ 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. 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. @@ -85,12 +92,19 @@ 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 ResourceStatus types.ResourceStatus diff --git a/service/quicksight/api_op_DescribeDashboardPermissions.go b/service/quicksight/api_op_DescribeDashboardPermissions.go index 4b8a59947fc..5ab9fb6e2e0 100644 --- a/service/quicksight/api_op_DescribeDashboardPermissions.go +++ b/service/quicksight/api_op_DescribeDashboardPermissions.go @@ -54,8 +54,9 @@ 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]. + // + // [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_DescribeDashboardSnapshotJob.go b/service/quicksight/api_op_DescribeDashboardSnapshotJob.go index 7e35da9f49c..6e00b09fce0 100644 --- a/service/quicksight/api_op_DescribeDashboardSnapshotJob.go +++ b/service/quicksight/api_op_DescribeDashboardSnapshotJob.go @@ -12,9 +12,10 @@ import ( "time" ) -// Describes an existing snapshot job. Poll job descriptions after a job starts to -// know the status of the job. For information on available status codes, see -// JobStatus . +// Describes an existing snapshot job. +// +// Poll job descriptions after a job starts to know the status of the job. For +// information on available status codes, see JobStatus . func (c *Client) DescribeDashboardSnapshotJob(ctx context.Context, params *DescribeDashboardSnapshotJobInput, optFns ...func(*Options)) (*DescribeDashboardSnapshotJobOutput, error) { if params == nil { params = &DescribeDashboardSnapshotJobInput{} @@ -58,11 +59,11 @@ type DescribeDashboardSnapshotJobOutput struct { // when you start a new job with a StartDashboardSnapshotJob API call. Arn *string - // The ID of the Amazon Web Services account that the dashboard snapshot job is + // The ID of the Amazon Web Services account that the dashboard snapshot job is // executed in. AwsAccountId *string - // The time that the snapshot job was created. + // The time that the snapshot job was created. CreatedTime *time.Time // The ID of the dashboard that you have started a snapshot job for. @@ -70,16 +71,20 @@ type DescribeDashboardSnapshotJobOutput struct { // Indicates the status of a job. The status updates as the job executes. This // shows one of the following values. + // // - COMPLETED - The job was completed successfully. + // // - FAILED - The job failed to execute. + // // - QUEUED - The job is queued and hasn't started yet. + // // - RUNNING - The job is still running. JobStatus types.SnapshotJobStatus - // The time that the snapshot job status was last updated. + // The time that the snapshot job status was last updated. LastUpdatedTime *time.Time - // The Amazon Web Services request ID for this operation. + // The Amazon Web Services request ID for this operation. RequestId *string // The snapshot configuration of the job. This information is provided when you diff --git a/service/quicksight/api_op_DescribeDashboardSnapshotJobResult.go b/service/quicksight/api_op_DescribeDashboardSnapshotJobResult.go index 8804fff23f7..0028f0c2891 100644 --- a/service/quicksight/api_op_DescribeDashboardSnapshotJobResult.go +++ b/service/quicksight/api_op_DescribeDashboardSnapshotJobResult.go @@ -12,11 +12,13 @@ import ( "time" ) -// Describes the result of an existing snapshot job that has finished running. A -// finished snapshot job will return a COMPLETED or FAILED status when you poll -// the job with a DescribeDashboardSnapshotJob API call. If the job has not -// finished running, this operation returns a message that says Dashboard Snapshot -// Job with id has not reached a terminal state. . +// Describes the result of an existing snapshot job that has finished running. +// +// A finished snapshot job will return a COMPLETED or FAILED status when you poll +// the job with a DescribeDashboardSnapshotJob API call. +// +// If the job has not finished running, this operation returns a message that says +// Dashboard Snapshot Job with id has not reached a terminal state. . func (c *Client) DescribeDashboardSnapshotJobResult(ctx context.Context, params *DescribeDashboardSnapshotJobResultInput, optFns ...func(*Options)) (*DescribeDashboardSnapshotJobResultOutput, error) { if params == nil { params = &DescribeDashboardSnapshotJobResultInput{} diff --git a/service/quicksight/api_op_DescribeDataSetPermissions.go b/service/quicksight/api_op_DescribeDataSetPermissions.go index 30b67598864..555588284d9 100644 --- a/service/quicksight/api_op_DescribeDataSetPermissions.go +++ b/service/quicksight/api_op_DescribeDataSetPermissions.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the permissions on a dataset. The permissions resource is +// Describes the permissions on a dataset. +// +// The permissions resource is // 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 { diff --git a/service/quicksight/api_op_DescribeGroup.go b/service/quicksight/api_op_DescribeGroup.go index 8ae14321523..0e90f8cef07 100644 --- a/service/quicksight/api_op_DescribeGroup.go +++ b/service/quicksight/api_op_DescribeGroup.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). +// Returns an Amazon QuickSight group's description and Amazon Resource Name +// (ARN). func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error) { if params == nil { params = &DescribeGroupInput{} diff --git a/service/quicksight/api_op_DescribeTemplateDefinition.go b/service/quicksight/api_op_DescribeTemplateDefinition.go index 61fdf869fc2..b55a5883f27 100644 --- a/service/quicksight/api_op_DescribeTemplateDefinition.go +++ b/service/quicksight/api_op_DescribeTemplateDefinition.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// instead. +// 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]DescribeTemplate instead. +// +// [DescribeTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html func (c *Client) DescribeTemplateDefinition(ctx context.Context, params *DescribeTemplateDefinitionInput, optFns ...func(*Options)) (*DescribeTemplateDefinitionOutput, error) { if params == nil { params = &DescribeTemplateDefinitionInput{} @@ -58,8 +60,10 @@ type DescribeTemplateDefinitionInput struct { type DescribeTemplateDefinitionOutput struct { - // The definition of the template. A definition is the data model of all features - // in a Dashboard, Template, or Analysis. + // The definition of the template. + // + // A definition is the data model of all features in a Dashboard, Template, or + // Analysis. Definition *types.TemplateVersionDefinition // Errors associated with the template version. @@ -72,12 +76,19 @@ 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 ResourceStatus types.ResourceStatus diff --git a/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go b/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go index 345d4085b30..ad4194ebeec 100644 --- a/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go +++ b/service/quicksight/api_op_GenerateEmbedUrlForAnonymousUser.go @@ -14,21 +14,29 @@ import ( // Generates an embed URL that you can use to embed an Amazon QuickSight dashboard // 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: +// 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. +// lifetime that can be customized using the [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 -// 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) -// . +// For more information, see [Embedded Analytics] 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]. +// +// [Embedded Analytics]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html +// [Amazon QuickSight Developer Portal]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html +// [SessionLifetimeInMinutes]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes func (c *Client) GenerateEmbedUrlForAnonymousUser(ctx context.Context, params *GenerateEmbedUrlForAnonymousUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForAnonymousUserOutput, error) { if params == nil { params = &GenerateEmbedUrlForAnonymousUserInput{} @@ -47,12 +55,15 @@ func (c *Client) GenerateEmbedUrlForAnonymousUser(ctx context.Context, params *G type GenerateEmbedUrlForAnonymousUserInput struct { // The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the - // user is authorized to access during the lifetime of the session. If you choose - // Dashboard embedding experience, pass the list of dashboard ARNs in the account - // that you want the user to be able to view. If you want to make changes to the - // theme of your embedded content, pass a list of theme ARNs that the anonymous - // users need access to. Currently, you can pass up to 25 theme ARNs in each API - // call. + // user is authorized to access during the lifetime of the session. + // + // If you choose Dashboard embedding experience, pass the list of dashboard ARNs + // in the account that you want the user to be able to view. + // + // If you want to make changes to the theme of your embedded content, pass a list + // of theme ARNs that the anonymous users need access to. + // + // Currently, you can pass up to 25 theme ARNs in each API call. // // This member is required. AuthorizedResourceArns []string @@ -78,9 +89,11 @@ type GenerateEmbedUrlForAnonymousUserInput struct { // URL that is then embedded. This optional parameter overrides the static domains // 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 . + // 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 . AllowedDomains []string // How many minutes the session is valid. The session lifetime must be in [15-600] @@ -90,10 +103,12 @@ type GenerateEmbedUrlForAnonymousUserInput struct { // The session tags used for row-level security. Before you use this parameter, // 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. + // 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]in the Amazon QuickSight User Guide. + // + // [Using Row-Level Security (RLS) with Tags]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html SessionTags []types.SessionTag noSmithyDocumentSerde diff --git a/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go b/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go index fcaf2ec9590..32ed2e845f0 100644 --- a/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go +++ b/service/quicksight/api_op_GenerateEmbedUrlForRegisteredUser.go @@ -15,21 +15,31 @@ import ( // 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: +// 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. +// lifetime that can be customized using the [SessionLifetimeInMinutes]parameter. +// +// The resulting user session is valid for 15 minutes (minimum) to 10 hours +// +// (maximum). The default session duration is 10 hours. // -// 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) -// . +// - You are charged only when the URL is used or there is interaction with +// Amazon QuickSight. +// +// For more information, see [Embedded Analytics] 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]. +// +// [Embedded Analytics]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html +// [Amazon QuickSight Developer Portal]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html +// [SessionLifetimeInMinutes]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes func (c *Client) GenerateEmbedUrlForRegisteredUser(ctx context.Context, params *GenerateEmbedUrlForRegisteredUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForRegisteredUserOutput, error) { if params == nil { params = &GenerateEmbedUrlForRegisteredUserInput{} @@ -70,9 +80,11 @@ type GenerateEmbedUrlForRegisteredUserInput struct { // URL that is then embedded. This optional parameter overrides the static domains // 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 . + // 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 . 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 6696b5cd918..a4d222effe4 100644 --- a/service/quicksight/api_op_GetDashboardEmbedUrl.go +++ b/service/quicksight/api_op_GetDashboardEmbedUrl.go @@ -14,23 +14,31 @@ import ( // Generates a temporary session URL and authorization code(bearer token) that you // can use to embed an Amazon QuickSight read-only dashboard in your website or // application. Before you use this command, make sure that you have configured the -// 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: +// 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. // -// 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) -// . +// For more information, see [Embedding Analytics Using GetDashboardEmbedUrl] 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]. +// +// [Amazon QuickSight Developer Portal]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html +// [Embedding Analytics Using GetDashboardEmbedUrl]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, optFns ...func(*Options)) (*GetDashboardEmbedUrlOutput, error) { if params == nil { params = &GetDashboardEmbedUrlInput{} @@ -100,10 +108,14 @@ 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. UserArn *string diff --git a/service/quicksight/api_op_GetSessionEmbedUrl.go b/service/quicksight/api_op_GetSessionEmbedUrl.go index 829f6469feb..42d884c1fd2 100644 --- a/service/quicksight/api_op_GetSessionEmbedUrl.go +++ b/service/quicksight/api_op_GetSessionEmbedUrl.go @@ -16,13 +16,18 @@ 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) -// 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) +// permissions profile to the user with the [UpdateUser]API operation. Use [RegisterUser] 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] +// +// [Customizing Access to the Amazon QuickSight Console] +// +// [Customizing Access to the Amazon QuickSight Console]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html +// [UpdateUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html +// [RegisterUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html +// [Embedding Analytics]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html func (c *Client) GetSessionEmbedUrl(ctx context.Context, params *GetSessionEmbedUrlInput, optFns ...func(*Options)) (*GetSessionEmbedUrlOutput, error) { if params == nil { params = &GetSessionEmbedUrlInput{} @@ -48,12 +53,18 @@ 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 EntryPoint *string @@ -66,10 +77,14 @@ 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. UserArn *string diff --git a/service/quicksight/api_op_ListAssetBundleExportJobs.go b/service/quicksight/api_op_ListAssetBundleExportJobs.go index 090b1d4af60..18da00a3be0 100644 --- a/service/quicksight/api_op_ListAssetBundleExportJobs.go +++ b/service/quicksight/api_op_ListAssetBundleExportJobs.go @@ -33,7 +33,8 @@ func (c *Client) ListAssetBundleExportJobs(ctx context.Context, params *ListAsse type ListAssetBundleExportJobsInput struct { - // The ID of the Amazon Web Services account that the export jobs were executed in. + // The ID of the Amazon Web Services account that the export jobs were executed + // in. // // This member is required. AwsAccountId *string diff --git a/service/quicksight/api_op_ListDataSets.go b/service/quicksight/api_op_ListDataSets.go index 8f791f58a44..eb5f5b6c405 100644 --- a/service/quicksight/api_op_ListDataSets.go +++ b/service/quicksight/api_op_ListDataSets.go @@ -12,8 +12,9 @@ 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/* . +// in an Amazon Web Services Region. +// +// The permissions resource is 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_ListIdentityPropagationConfigs.go b/service/quicksight/api_op_ListIdentityPropagationConfigs.go index a06d5cd3a4c..b1478d6d09a 100644 --- a/service/quicksight/api_op_ListIdentityPropagationConfigs.go +++ b/service/quicksight/api_op_ListIdentityPropagationConfigs.go @@ -12,8 +12,10 @@ import ( ) // Lists all services and authorized targets that the Amazon QuickSight IAM -// Identity Center application can access. This operation is only supported for -// Amazon QuickSight accounts that use IAM Identity Center. +// Identity Center application can access. +// +// This operation is only supported for Amazon QuickSight accounts that use IAM +// Identity Center. func (c *Client) ListIdentityPropagationConfigs(ctx context.Context, params *ListIdentityPropagationConfigsInput, optFns ...func(*Options)) (*ListIdentityPropagationConfigsOutput, error) { if params == nil { params = &ListIdentityPropagationConfigsInput{} diff --git a/service/quicksight/api_op_ListThemes.go b/service/quicksight/api_op_ListThemes.go index 8f6aca57379..3c560508224 100644 --- a/service/quicksight/api_op_ListThemes.go +++ b/service/quicksight/api_op_ListThemes.go @@ -42,8 +42,11 @@ type ListThemesInput struct { 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. Type types.ThemeType diff --git a/service/quicksight/api_op_RegisterUser.go b/service/quicksight/api_op_RegisterUser.go index 483ecbf057e..2a61b5a638a 100644 --- a/service/quicksight/api_op_RegisterUser.go +++ b/service/quicksight/api_op_RegisterUser.go @@ -19,8 +19,9 @@ import ( // 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]. +// +// [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{} @@ -63,12 +64,17 @@ type RegisterUserInput 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 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. @@ -83,31 +89,43 @@ type RegisterUserInput struct { // (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) - // 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 - // 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, admin pro, author pro, reader pro). + // + // To add custom permissions to an existing user, use [UpdateUser] 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 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, admin pro, author pro, reader pro). + // // This feature is available only to Amazon QuickSight Enterprise edition // subscriptions. + // + // [UpdateUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html 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. @@ -116,7 +134,8 @@ type RegisterUserInput struct { // The identity ID for a user in the external login provider. ExternalLoginId *string - // The ARN of the IAM user or role that you are registering with Amazon QuickSight. + // 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 @@ -124,8 +143,9 @@ type RegisterUserInput struct { // 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]assume-role in the CLI Reference. + // + // [assume-role]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html SessionName *string // The tags to associate with the user. diff --git a/service/quicksight/api_op_SearchAnalyses.go b/service/quicksight/api_op_SearchAnalyses.go index cf4e5560ab4..37ff8e08a16 100644 --- a/service/quicksight/api_op_SearchAnalyses.go +++ b/service/quicksight/api_op_SearchAnalyses.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for analyses that belong to the user specified in the filter. This -// operation is eventually consistent. The results are best effort and may not -// reflect very recent updates and changes. +// Searches for analyses that belong to the user specified in the filter. +// +// This operation is eventually consistent. The results are best effort and may +// not reflect very recent updates and changes. func (c *Client) SearchAnalyses(ctx context.Context, params *SearchAnalysesInput, optFns ...func(*Options)) (*SearchAnalysesOutput, error) { if params == nil { params = &SearchAnalysesInput{} diff --git a/service/quicksight/api_op_SearchDashboards.go b/service/quicksight/api_op_SearchDashboards.go index e515f0fe26c..1af6c430740 100644 --- a/service/quicksight/api_op_SearchDashboards.go +++ b/service/quicksight/api_op_SearchDashboards.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Searches for dashboards that belong to a user. This operation is eventually -// consistent. The results are best effort and may not reflect very recent updates -// and changes. +// Searches for dashboards that belong to a user. +// +// This operation is eventually consistent. The results are best effort and may +// not reflect very recent updates and changes. func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, error) { if params == nil { params = &SearchDashboardsInput{} diff --git a/service/quicksight/api_op_StartAssetBundleExportJob.go b/service/quicksight/api_op_StartAssetBundleExportJob.go index 103cf45d818..4fa918a0e52 100644 --- a/service/quicksight/api_op_StartAssetBundleExportJob.go +++ b/service/quicksight/api_op_StartAssetBundleExportJob.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an Asset Bundle export job. An Asset Bundle export job exports specified -// Amazon QuickSight assets. You can also choose to export any asset dependencies -// in the same job. Export jobs run asynchronously and can be polled with a -// DescribeAssetBundleExportJob API call. When a job is successfully completed, a -// download URL that contains the exported assets is returned. The URL is valid for -// 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. -// Each Amazon QuickSight account can run up to 5 export jobs concurrently. The API -// caller must have the necessary permissions in their IAM role to access each -// resource before the resources can be exported. +// Starts an Asset Bundle export job. +// +// An Asset Bundle export job exports specified Amazon QuickSight assets. You can +// also choose to export any asset dependencies in the same job. Export jobs run +// asynchronously and can be polled with a DescribeAssetBundleExportJob API call. +// When a job is successfully completed, a download URL that contains the exported +// assets is returned. The URL is valid for 5 minutes and can be refreshed with a +// DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up +// to 5 export jobs concurrently. +// +// The API caller must have the necessary permissions in their IAM role to access +// each resource before the resources can be exported. func (c *Client) StartAssetBundleExportJob(ctx context.Context, params *StartAssetBundleExportJobInput, optFns ...func(*Options)) (*StartAssetBundleExportJobOutput, error) { if params == nil { params = &StartAssetBundleExportJobInput{} @@ -54,13 +57,21 @@ type StartAssetBundleExportJobInput struct { ExportFormat types.AssetBundleExportFormat // An array of resource ARNs to export. The following resources are supported. + // // - Analysis + // // - Dashboard + // // - DataSet + // // - DataSource + // // - RefreshSchedule + // // - Theme + // // - VPCConnection + // // The API caller must have the necessary permissions in their IAM role to access // each resource before the resources can be exported. // @@ -69,8 +80,10 @@ type StartAssetBundleExportJobInput struct { // An optional collection of structures that generate CloudFormation parameters to // override the existing resource property values when the resource is exported to - // a new CloudFormation template. Use this field if the ExportFormat field of a - // StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON . + // a new CloudFormation template. + // + // Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest + // API call is set to CLOUDFORMATION_JSON . CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration // A Boolean that determines whether all dependencies of each resource ARN are @@ -85,7 +98,7 @@ type StartAssetBundleExportJobInput struct { // associated with each resource are exported. IncludePermissions bool - // A Boolean that determines whether all tags for each resource ARN are exported + // A Boolean that determines whether all tags for each resource ARN are exported // with the job. If you set IncludeTags to TRUE , any tags associated with each // resource are exported. IncludeTags bool diff --git a/service/quicksight/api_op_StartAssetBundleImportJob.go b/service/quicksight/api_op_StartAssetBundleImportJob.go index 37f414a9e73..82b1c1fecc6 100644 --- a/service/quicksight/api_op_StartAssetBundleImportJob.go +++ b/service/quicksight/api_op_StartAssetBundleImportJob.go @@ -11,15 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts an Asset Bundle import job. An Asset Bundle import job imports specified -// Amazon QuickSight assets into an Amazon QuickSight account. You can also choose -// to import a naming prefix and specified configuration overrides. The assets that -// are contained in the bundle file that you provide are used to create or update a -// new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight -// account can run up to 5 import jobs concurrently. The API caller must have the -// necessary "create" , "describe" , and "update" permissions in their IAM role to -// access each resource type that is contained in the bundle file before the -// resources can be imported. +// Starts an Asset Bundle import job. +// +// An Asset Bundle import job imports specified Amazon QuickSight assets into an +// Amazon QuickSight account. You can also choose to import a naming prefix and +// specified configuration overrides. The assets that are contained in the bundle +// file that you provide are used to create or update a new or existing asset in +// your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 +// import jobs concurrently. +// +// The API caller must have the necessary "create" , "describe" , and "update" +// permissions in their IAM role to access each resource type that is contained in +// the bundle file before the resources can be imported. func (c *Client) StartAssetBundleImportJob(ctx context.Context, params *StartAssetBundleImportJobInput, optFns ...func(*Options)) (*StartAssetBundleImportJobOutput, error) { if params == nil { params = &StartAssetBundleImportJobInput{} @@ -54,11 +57,14 @@ type StartAssetBundleImportJobInput struct { // This member is required. AwsAccountId *string - // The failure action for the import job. If you choose ROLLBACK , failed import - // jobs will attempt to undo any asset changes caused by the failed job. If you - // choose DO_NOTHING , failed import jobs will not attempt to roll back any asset - // changes caused by the failed job, possibly keeping the Amazon QuickSight account - // in an inconsistent state. + // The failure action for the import job. + // + // If you choose ROLLBACK , failed import jobs will attempt to undo any asset + // changes caused by the failed job. + // + // If you choose DO_NOTHING , failed import jobs will not attempt to roll back any + // asset changes caused by the failed job, possibly keeping the Amazon QuickSight + // account in an inconsistent state. FailureAction types.AssetBundleImportFailureAction // Optional overrides that are applied to the resource configuration before import. diff --git a/service/quicksight/api_op_StartDashboardSnapshotJob.go b/service/quicksight/api_op_StartDashboardSnapshotJob.go index d14b4353155..35cbb41f3f9 100644 --- a/service/quicksight/api_op_StartDashboardSnapshotJob.go +++ b/service/quicksight/api_op_StartDashboardSnapshotJob.go @@ -14,8 +14,11 @@ import ( // Starts an asynchronous job that generates a snapshot of a dashboard's output. // You can request one or several of the following format configurations in each // API call. +// // - 1 Paginated PDF +// // - 1 Excel workbook that includes up to 5 table or pivot table visuals +// // - 5 CSVs from table or pivot table visuals // // The status of a submitted job can be polled with the @@ -24,47 +27,69 @@ import ( // or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the // URLs for the generated files. If the job fails, the // DescribeDashboardSnapshotJobResult API returns detailed information about the -// error that occurred. StartDashboardSnapshotJob API throttling Amazon QuickSight -// utilizes API throttling to create a more consistent user experience within a -// time span for customers when they call the StartDashboardSnapshotJob . By -// default, 12 jobs can run simlutaneously in one Amazon Web Services account and -// users can submit up 10 API requests per second before an account is throttled. -// If an overwhelming number of API requests are made by the same user in a short -// period of time, Amazon QuickSight throttles the API calls to maintin an optimal -// experience and reliability for all Amazon QuickSight users. Common throttling -// scenarios The following list provides information about the most commin -// throttling scenarios that can occur. +// error that occurred. +// +// # StartDashboardSnapshotJob API throttling +// +// Amazon QuickSight utilizes API throttling to create a more consistent user +// experience within a time span for customers when they call the +// StartDashboardSnapshotJob . By default, 12 jobs can run simlutaneously in one +// Amazon Web Services account and users can submit up 10 API requests per second +// before an account is throttled. If an overwhelming number of API requests are +// made by the same user in a short period of time, Amazon QuickSight throttles the +// API calls to maintin an optimal experience and reliability for all Amazon +// QuickSight users. +// +// # Common throttling scenarios +// +// The following list provides information about the most commin throttling +// scenarios that can occur. +// // - A large number of SnapshotExport API jobs are running simultaneously on an // Amazon Web Services account. When a new StartDashboardSnapshotJob is created // and there are already 12 jobs with the RUNNING status, the new job request // fails and returns a LimitExceededException error. Wait for a current job to // comlpete before you resubmit the new job. +// // - A large number of API requests are submitted on an Amazon Web Services // account. When a user makes more than 10 API calls to the Amazon QuickSight API // in one second, a ThrottlingException is returned. // // If your use case requires a higher throttling limit, contact your account admin -// or Amazon Web ServicesSupport (http://aws.amazon.com/contact-us/) to explore -// options to tailor a more optimal expereince for your account. Best practices to -// handle throttling If your use case projects high levels of API traffic, try to -// reduce the degree of frequency and parallelism of API calls as much as you can -// to avoid throttling. You can also perform a timing test to calculate an estimate -// for the total processing time of your projected load that stays within the -// throttling limits of the Amazon QuickSight APIs. For example, if your projected -// traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel -// and measure the amount of time it takes to proccess all 12 jobs. Once you obtain -// the result, multiply the duration by 9, for example (12 minutes * 9 = 108 -// minutes) . Use the new result to determine the latest time at which the jobs -// need to be started to meet your target deadline. The time that it takes to -// process a job can be impacted by the following factors: +// or [Amazon Web ServicesSupport]to explore options to tailor a more optimal expereince for your account. +// +// # Best practices to handle throttling +// +// If your use case projects high levels of API traffic, try to reduce the degree +// of frequency and parallelism of API calls as much as you can to avoid +// throttling. You can also perform a timing test to calculate an estimate for the +// total processing time of your projected load that stays within the throttling +// limits of the Amazon QuickSight APIs. For example, if your projected traffic is +// 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure +// the amount of time it takes to proccess all 12 jobs. Once you obtain the result, +// multiply the duration by 9, for example (12 minutes * 9 = 108 minutes) . Use the +// new result to determine the latest time at which the jobs need to be started to +// meet your target deadline. +// +// The time that it takes to process a job can be impacted by the following +// factors: +// // - The dataset type (Direct Query or SPICE). +// // - The size of the dataset. +// // - The complexity of the calculated fields that are used in the dashboard. +// // - The number of visuals that are on a sheet. +// // - The types of visuals that are on the sheet. +// // - The number of formats and snapshots that are requested in the job // configuration. +// // - The size of the generated snapshots. +// +// [Amazon Web ServicesSupport]: http://aws.amazon.com/contact-us/ func (c *Client) StartDashboardSnapshotJob(ctx context.Context, params *StartDashboardSnapshotJobInput, optFns ...func(*Options)) (*StartDashboardSnapshotJobOutput, error) { if params == nil { params = &StartDashboardSnapshotJobInput{} @@ -106,7 +131,7 @@ type StartDashboardSnapshotJobInput struct { // This member is required. SnapshotJobId *string - // A structure that contains information about the anonymous users that the + // A structure that contains information about the anonymous users that the // generated snapshot is for. This API will not return information about registered // Amazon QuickSight. // @@ -121,7 +146,7 @@ type StartDashboardSnapshotJobOutput struct { // The Amazon Resource Name (ARN) for the dashboard snapshot job. Arn *string - // The Amazon Web Services request ID for this operation. + // The Amazon Web Services request ID for this operation. RequestId *string // The ID of the job. The job ID is set when you start a new job with a diff --git a/service/quicksight/api_op_TagResource.go b/service/quicksight/api_op_TagResource.go index 5b3563d008c..37b5c00a63b 100644 --- a/service/quicksight/api_op_TagResource.go +++ b/service/quicksight/api_op_TagResource.go @@ -12,20 +12,26 @@ import ( ) // Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight -// resource. 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 the TagResource -// operation with a resource that already has tags. If you specify a new tag key -// for the resource, this tag is appended to the list of tags associated with the -// resource. 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. Amazon QuickSight supports -// tagging on data set, data source, dashboard, template, topic, and user. Tagging -// for Amazon QuickSight works in a similar way to tagging for other Amazon Web -// Services services, except for the following: +// resource. +// +// 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 the TagResource operation +// with a resource that already has tags. If you specify a new tag key for the +// resource, this tag is appended to the list of tags associated with the resource. +// 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. Amazon QuickSight +// supports tagging on data set, data source, dashboard, template, topic, and user. +// +// Tagging for Amazon QuickSight works in a similar way to tagging for other +// Amazon Web Services services, except for the following: +// // - Tags are used to track costs for users in Amazon QuickSight. You can't tag // other resources that Amazon QuickSight costs are based on, such as storage // capacoty (SPICE), session usage, alert consumption, or reporting units. +// // - 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) { diff --git a/service/quicksight/api_op_UpdateAccountCustomization.go b/service/quicksight/api_op_UpdateAccountCustomization.go index ec5a3c637ef..864d57f3ee5 100644 --- a/service/quicksight/api_op_UpdateAccountCustomization.go +++ b/service/quicksight/api_op_UpdateAccountCustomization.go @@ -12,11 +12,12 @@ import ( ) // Updates Amazon QuickSight customizations for the current Amazon Web Services -// Region. Currently, the only customization that you can use is a theme. You can -// use customizations for your Amazon Web Services account or, if you specify a -// namespace, for a Amazon QuickSight namespace instead. Customizations that apply -// to a namespace override customizations that apply to an Amazon Web Services -// account. To find out which customizations apply, use the +// Region. Currently, the only customization that you can use is a theme. +// +// You can use customizations for your Amazon Web Services account or, if you +// specify a namespace, for a Amazon QuickSight namespace instead. Customizations +// that apply to a namespace override customizations that apply to an Amazon Web +// Services account. To find out which customizations apply, use the // DescribeAccountCustomization API operation. func (c *Client) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, optFns ...func(*Options)) (*UpdateAccountCustomizationOutput, error) { if params == nil { diff --git a/service/quicksight/api_op_UpdateAnalysis.go b/service/quicksight/api_op_UpdateAnalysis.go index aebe63ead25..cde316ded4c 100644 --- a/service/quicksight/api_op_UpdateAnalysis.go +++ b/service/quicksight/api_op_UpdateAnalysis.go @@ -47,8 +47,10 @@ type UpdateAnalysisInput struct { // 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_UpdateDashboard.go b/service/quicksight/api_op_UpdateDashboard.go index cfc8e540801..4a3bc6464b9 100644 --- a/service/quicksight/api_op_UpdateDashboard.go +++ b/service/quicksight/api_op_UpdateDashboard.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// API operation. +// 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]API operation. +// +// [UpdateDashboardPublishedVersion]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error) { if params == nil { params = &UpdateDashboardInput{} @@ -50,19 +52,24 @@ 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. 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 @@ -74,13 +81,16 @@ type UpdateDashboardInput struct { // 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 - // 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. + // template by using the [CreateTemplate]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. + // + // [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html SourceEntity *types.DashboardSourceEntity // The Amazon Resource Name (ARN) of the theme that is being used for this diff --git a/service/quicksight/api_op_UpdateDashboardLinks.go b/service/quicksight/api_op_UpdateDashboardLinks.go index be5c23a0da5..4d7f9ca2cb0 100644 --- a/service/quicksight/api_op_UpdateDashboardLinks.go +++ b/service/quicksight/api_op_UpdateDashboardLinks.go @@ -39,7 +39,7 @@ type UpdateDashboardLinksInput struct { // This member is required. DashboardId *string - // list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. + // list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. // // This member is required. LinkEntities []string diff --git a/service/quicksight/api_op_UpdateDataSet.go b/service/quicksight/api_op_UpdateDataSet.go index fa785ee13f2..552fbc55992 100644 --- a/service/quicksight/api_op_UpdateDataSet.go +++ b/service/quicksight/api_op_UpdateDataSet.go @@ -60,8 +60,9 @@ 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]. + // + // [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 diff --git a/service/quicksight/api_op_UpdateDataSetPermissions.go b/service/quicksight/api_op_UpdateDataSetPermissions.go index 55c159a2780..476ae2e4dc1 100644 --- a/service/quicksight/api_op_UpdateDataSetPermissions.go +++ b/service/quicksight/api_op_UpdateDataSetPermissions.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the permissions on a dataset. The permissions resource is +// Updates the permissions on a dataset. +// +// The permissions resource is // 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 { diff --git a/service/quicksight/api_op_UpdateIAMPolicyAssignment.go b/service/quicksight/api_op_UpdateIAMPolicyAssignment.go index 8be8965a347..bef374ea29b 100644 --- a/service/quicksight/api_op_UpdateIAMPolicyAssignment.go +++ b/service/quicksight/api_op_UpdateIAMPolicyAssignment.go @@ -49,9 +49,12 @@ 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. AssignmentStatus types.AssignmentStatus @@ -76,9 +79,12 @@ 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. AssignmentStatus types.AssignmentStatus diff --git a/service/quicksight/api_op_UpdateIdentityPropagationConfig.go b/service/quicksight/api_op_UpdateIdentityPropagationConfig.go index f57ba515675..bafc637d223 100644 --- a/service/quicksight/api_op_UpdateIdentityPropagationConfig.go +++ b/service/quicksight/api_op_UpdateIdentityPropagationConfig.go @@ -12,8 +12,10 @@ import ( ) // Adds or updates services and authorized targets to configure what the Amazon -// QuickSight IAM Identity Center application can access. This operation is only -// supported for Amazon QuickSight accounts using IAM Identity Center +// QuickSight IAM Identity Center application can access. +// +// This operation is only supported for Amazon QuickSight accounts using IAM +// Identity Center func (c *Client) UpdateIdentityPropagationConfig(ctx context.Context, params *UpdateIdentityPropagationConfigInput, optFns ...func(*Options)) (*UpdateIdentityPropagationConfigOutput, error) { if params == nil { params = &UpdateIdentityPropagationConfigInput{} diff --git a/service/quicksight/api_op_UpdatePublicSharingSettings.go b/service/quicksight/api_op_UpdatePublicSharingSettings.go index 2fe7b6beb9f..ba17c90bfaa 100644 --- a/service/quicksight/api_op_UpdatePublicSharingSettings.go +++ b/service/quicksight/api_op_UpdatePublicSharingSettings.go @@ -11,13 +11,17 @@ import ( ) // Use the UpdatePublicSharingSettings operation to turn on or turn off the public -// sharing settings of an Amazon QuickSight dashboard. To use this operation, turn -// on session capacity pricing for your Amazon QuickSight account. Before you can -// 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) -// in the Amazon QuickSight User Guide. +// sharing settings of an Amazon QuickSight dashboard. +// +// To use this operation, turn on session capacity pricing for your Amazon +// QuickSight account. +// +// Before you can 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]in the Amazon QuickSight User Guide. +// +// [Using Amazon QuickSight with IAM]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html func (c *Client) UpdatePublicSharingSettings(ctx context.Context, params *UpdatePublicSharingSettingsInput, optFns ...func(*Options)) (*UpdatePublicSharingSettingsOutput, error) { if params == nil { params = &UpdatePublicSharingSettingsInput{} diff --git a/service/quicksight/api_op_UpdateSPICECapacityConfiguration.go b/service/quicksight/api_op_UpdateSPICECapacityConfiguration.go index 1fff0ed81fa..d0387908f3d 100644 --- a/service/quicksight/api_op_UpdateSPICECapacityConfiguration.go +++ b/service/quicksight/api_op_UpdateSPICECapacityConfiguration.go @@ -37,7 +37,9 @@ type UpdateSPICECapacityConfigurationInput struct { // Determines how SPICE capacity can be purchased. The following options are // available. + // // - MANUAL : SPICE capacity can only be purchased manually. + // // - AUTO_PURCHASE : Extra SPICE capacity is automatically purchased on your // behalf as needed. SPICE capacity can also be purchased manually with this // option. diff --git a/service/quicksight/api_op_UpdateTemplate.go b/service/quicksight/api_op_UpdateTemplate.go index 19a8a3668ae..f435f80f090 100644 --- a/service/quicksight/api_op_UpdateTemplate.go +++ b/service/quicksight/api_op_UpdateTemplate.go @@ -41,8 +41,10 @@ type UpdateTemplateInput struct { // This member is required. TemplateId *string - // The definition of a template. A definition is the data model of all features in - // a Dashboard, Template, or Analysis. + // The definition of a template. + // + // A definition is the data model of all features in a Dashboard, Template, or + // Analysis. Definition *types.TemplateVersionDefinition // The name for the template. @@ -54,10 +56,11 @@ type UpdateTemplateInput struct { // 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. + // 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 // The option to relax the validation needed to update a template with definition diff --git a/service/quicksight/api_op_UpdateThemePermissions.go b/service/quicksight/api_op_UpdateThemePermissions.go index 701d0a5a78f..8e3e834bba9 100644 --- a/service/quicksight/api_op_UpdateThemePermissions.go +++ b/service/quicksight/api_op_UpdateThemePermissions.go @@ -13,25 +13,44 @@ import ( // 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 { diff --git a/service/quicksight/api_op_UpdateUser.go b/service/quicksight/api_op_UpdateUser.go index 966128ca48c..1c20867d9b4 100644 --- a/service/quicksight/api_op_UpdateUser.go +++ b/service/quicksight/api_op_UpdateUser.go @@ -48,20 +48,27 @@ type UpdateUserInput struct { // 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. + // // - READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. // Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, // and can generate executive summaries from dashboards. + // // - AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. // Author Pros can author dashboards with natural language with Amazon Q, build // stories with Amazon Q, create Topics for Q&A, and generate executive summaries // from dashboards. + // // - ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight // administrative settings. Admin Pro users are billed at Author Pro pricing. + // // The name of the Amazon QuickSight role is invisible to the user except for the // console screens dealing with permissions. // @@ -82,35 +89,47 @@ type UpdateUserInput struct { // (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. + // (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. + // user. Use the [DescribeUser]API operation to check the external login information. + // + // [DescribeUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html 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 f96e55eefe6..9ab357400a4 100644 --- a/service/quicksight/doc.go +++ b/service/quicksight/doc.go @@ -3,9 +3,10 @@ // 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/options.go b/service/quicksight/options.go index bef20fecb97..fb8fb383321 100644 --- a/service/quicksight/options.go +++ b/service/quicksight/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/quicksight/types/enums.go b/service/quicksight/types/enums.go index b9aaefba04e..3988b15a421 100644 --- a/service/quicksight/types/enums.go +++ b/service/quicksight/types/enums.go @@ -19,8 +19,9 @@ const ( ) // Values returns all known values for AnalysisErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisErrorType) Values() []AnalysisErrorType { return []AnalysisErrorType{ "ACCESS_DENIED", @@ -50,8 +51,9 @@ const ( ) // Values returns all known values for AnalysisFilterAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AnalysisFilterAttribute) Values() []AnalysisFilterAttribute { return []AnalysisFilterAttribute{ "QUICKSIGHT_USER", @@ -72,8 +74,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -91,8 +94,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -112,8 +116,9 @@ const ( ) // Values returns all known values for ArcThicknessOptions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArcThicknessOptions) Values() []ArcThicknessOptions { return []ArcThicknessOptions{ "SMALL", @@ -131,8 +136,9 @@ const ( ) // Values returns all known values for AssetBundleExportFormat. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportFormat) Values() []AssetBundleExportFormat { return []AssetBundleExportFormat{ "CLOUDFORMATION_JSON", @@ -149,8 +155,9 @@ const ( // Values returns all known values for // AssetBundleExportJobAnalysisPropertyToOverride. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobAnalysisPropertyToOverride) Values() []AssetBundleExportJobAnalysisPropertyToOverride { return []AssetBundleExportJobAnalysisPropertyToOverride{ "Name", @@ -166,8 +173,9 @@ const ( // Values returns all known values for // AssetBundleExportJobDashboardPropertyToOverride. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobDashboardPropertyToOverride) Values() []AssetBundleExportJobDashboardPropertyToOverride { return []AssetBundleExportJobDashboardPropertyToOverride{ "Name", @@ -183,8 +191,9 @@ const ( // Values returns all known values for // AssetBundleExportJobDataSetPropertyToOverride. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobDataSetPropertyToOverride) Values() []AssetBundleExportJobDataSetPropertyToOverride { return []AssetBundleExportJobDataSetPropertyToOverride{ "Name", @@ -217,8 +226,9 @@ const ( // Values returns all known values for // AssetBundleExportJobDataSourcePropertyToOverride. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobDataSourcePropertyToOverride) Values() []AssetBundleExportJobDataSourcePropertyToOverride { return []AssetBundleExportJobDataSourcePropertyToOverride{ "Name", @@ -251,8 +261,9 @@ const ( // Values returns all known values for // AssetBundleExportJobRefreshSchedulePropertyToOverride. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobRefreshSchedulePropertyToOverride) Values() []AssetBundleExportJobRefreshSchedulePropertyToOverride { return []AssetBundleExportJobRefreshSchedulePropertyToOverride{ "StartAfterDateTime", @@ -271,6 +282,7 @@ const ( // Values returns all known values for AssetBundleExportJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobStatus) Values() []AssetBundleExportJobStatus { return []AssetBundleExportJobStatus{ @@ -290,8 +302,9 @@ const ( // Values returns all known values for // AssetBundleExportJobThemePropertyToOverride. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobThemePropertyToOverride) Values() []AssetBundleExportJobThemePropertyToOverride { return []AssetBundleExportJobThemePropertyToOverride{ "Name", @@ -309,8 +322,9 @@ const ( // Values returns all known values for // AssetBundleExportJobVPCConnectionPropertyToOverride. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleExportJobVPCConnectionPropertyToOverride) Values() []AssetBundleExportJobVPCConnectionPropertyToOverride { return []AssetBundleExportJobVPCConnectionPropertyToOverride{ "Name", @@ -329,8 +343,9 @@ const ( // Values returns all known values for AssetBundleImportFailureAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleImportFailureAction) Values() []AssetBundleImportFailureAction { return []AssetBundleImportFailureAction{ "DO_NOTHING", @@ -353,6 +368,7 @@ const ( // Values returns all known values for AssetBundleImportJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AssetBundleImportJobStatus) Values() []AssetBundleImportJobStatus { return []AssetBundleImportJobStatus{ @@ -376,8 +392,9 @@ const ( ) // Values returns all known values for AssignmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignmentStatus) Values() []AssignmentStatus { return []AssignmentStatus{ "ENABLED", @@ -398,6 +415,7 @@ const ( // Values returns all known values for AuthenticationMethodOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationMethodOption) Values() []AuthenticationMethodOption { return []AuthenticationMethodOption{ @@ -428,6 +446,7 @@ const ( // Values returns all known values for AuthorSpecifiedAggregation. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuthorSpecifiedAggregation) Values() []AuthorSpecifiedAggregation { return []AuthorSpecifiedAggregation{ @@ -455,8 +474,9 @@ const ( ) // Values returns all known values for AxisBinding. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AxisBinding) Values() []AxisBinding { return []AxisBinding{ "PRIMARY_YAXIS", @@ -473,8 +493,9 @@ const ( ) // Values returns all known values for BarChartOrientation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BarChartOrientation) Values() []BarChartOrientation { return []BarChartOrientation{ "HORIZONTAL", @@ -492,8 +513,9 @@ const ( ) // Values returns all known values for BarsArrangement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BarsArrangement) Values() []BarsArrangement { return []BarsArrangement{ "CLUSTERED", @@ -513,8 +535,9 @@ const ( ) // Values returns all known values for BaseMapStyleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BaseMapStyleType) Values() []BaseMapStyleType { return []BaseMapStyleType{ "LIGHT_GRAY", @@ -533,8 +556,9 @@ const ( ) // Values returns all known values for BoxPlotFillStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BoxPlotFillStyle) Values() []BoxPlotFillStyle { return []BoxPlotFillStyle{ "SOLID", @@ -552,8 +576,9 @@ const ( // Values returns all known values for CategoricalAggregationFunction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CategoricalAggregationFunction) Values() []CategoricalAggregationFunction { return []CategoricalAggregationFunction{ "COUNT", @@ -570,8 +595,9 @@ const ( ) // Values returns all known values for CategoryFilterFunction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CategoryFilterFunction) Values() []CategoryFilterFunction { return []CategoryFilterFunction{ "EXACT", @@ -593,6 +619,7 @@ const ( // Values returns all known values for CategoryFilterMatchOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CategoryFilterMatchOperator) Values() []CategoryFilterMatchOperator { return []CategoryFilterMatchOperator{ @@ -614,8 +641,9 @@ const ( // Values returns all known values for CategoryFilterSelectAllOptions. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CategoryFilterSelectAllOptions) Values() []CategoryFilterSelectAllOptions { return []CategoryFilterSelectAllOptions{ "FILTER_ALL_VALUES", @@ -632,8 +660,9 @@ const ( ) // Values returns all known values for CategoryFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CategoryFilterType) Values() []CategoryFilterType { return []CategoryFilterType{ "CUSTOM_FILTER", @@ -651,8 +680,9 @@ const ( ) // Values returns all known values for ColorFillType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColorFillType) Values() []ColorFillType { return []ColorFillType{ "DISCRETE", @@ -669,8 +699,9 @@ const ( ) // Values returns all known values for ColumnDataRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnDataRole) Values() []ColumnDataRole { return []ColumnDataRole{ "DIMENSION", @@ -687,8 +718,9 @@ const ( ) // Values returns all known values for ColumnDataSubType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnDataSubType) Values() []ColumnDataSubType { return []ColumnDataSubType{ "FLOAT", @@ -707,8 +739,9 @@ const ( ) // Values returns all known values for ColumnDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnDataType) Values() []ColumnDataType { return []ColumnDataType{ "STRING", @@ -728,8 +761,9 @@ const ( ) // Values returns all known values for ColumnOrderingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnOrderingType) Values() []ColumnOrderingType { return []ColumnOrderingType{ "GREATER_IS_BETTER", @@ -747,8 +781,9 @@ const ( ) // Values returns all known values for ColumnRole. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnRole) Values() []ColumnRole { return []ColumnRole{ "DIMENSION", @@ -765,8 +800,9 @@ const ( ) // Values returns all known values for ColumnTagName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ColumnTagName) Values() []ColumnTagName { return []ColumnTagName{ "COLUMN_GEOGRAPHIC_ROLE", @@ -784,8 +820,9 @@ const ( ) // Values returns all known values for ComparisonMethod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonMethod) Values() []ComparisonMethod { return []ComparisonMethod{ "DIFFERENCE", @@ -803,8 +840,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConditionalFormattingIconDisplayOption) Values() []ConditionalFormattingIconDisplayOption { return []ConditionalFormattingIconDisplayOption{ "ICON_ONLY", @@ -830,8 +868,9 @@ const ( // Values returns all known values for ConditionalFormattingIconSetType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConditionalFormattingIconSetType) Values() []ConditionalFormattingIconSetType { return []ConditionalFormattingIconSetType{ "PLUS_MINUS", @@ -858,8 +897,9 @@ const ( ) // Values returns all known values for ConstantType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConstantType) Values() []ConstantType { return []ConstantType{ "SINGULAR", @@ -877,8 +917,9 @@ const ( ) // Values returns all known values for CrossDatasetTypes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CrossDatasetTypes) Values() []CrossDatasetTypes { return []CrossDatasetTypes{ "ALL_DATASETS", @@ -898,8 +939,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomContentImageScalingConfiguration) Values() []CustomContentImageScalingConfiguration { return []CustomContentImageScalingConfiguration{ "FIT_TO_HEIGHT", @@ -918,8 +960,9 @@ const ( ) // Values returns all known values for CustomContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomContentType) Values() []CustomContentType { return []CustomContentType{ "IMAGE", @@ -936,8 +979,9 @@ const ( ) // Values returns all known values for DashboardBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashboardBehavior) Values() []DashboardBehavior { return []DashboardBehavior{ "ENABLED", @@ -962,8 +1006,9 @@ const ( ) // Values returns all known values for DashboardErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashboardErrorType) Values() []DashboardErrorType { return []DashboardErrorType{ "ACCESS_DENIED", @@ -994,6 +1039,7 @@ const ( // 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{ @@ -1016,8 +1062,9 @@ const ( ) // Values returns all known values for DashboardUIState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DashboardUIState) Values() []DashboardUIState { return []DashboardUIState{ "EXPANDED", @@ -1035,8 +1082,9 @@ const ( ) // Values returns all known values for DataLabelContent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataLabelContent) Values() []DataLabelContent { return []DataLabelContent{ "VALUE", @@ -1054,8 +1102,9 @@ const ( ) // Values returns all known values for DataLabelOverlap. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataLabelOverlap) Values() []DataLabelOverlap { return []DataLabelOverlap{ "DISABLE_OVERLAP", @@ -1076,8 +1125,9 @@ const ( ) // Values returns all known values for DataLabelPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataLabelPosition) Values() []DataLabelPosition { return []DataLabelPosition{ "INSIDE", @@ -1102,8 +1152,9 @@ const ( ) // Values returns all known values for DataSetFilterAttribute. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSetFilterAttribute) Values() []DataSetFilterAttribute { return []DataSetFilterAttribute{ "QUICKSIGHT_VIEWER_OR_OWNER", @@ -1124,8 +1175,9 @@ const ( ) // Values returns all known values for DataSetImportMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSetImportMode) Values() []DataSetImportMode { return []DataSetImportMode{ "SPICE", @@ -1143,6 +1195,7 @@ const ( // Values returns all known values for DatasetParameterValueType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DatasetParameterValueType) Values() []DatasetParameterValueType { return []DatasetParameterValueType{ @@ -1166,8 +1219,9 @@ const ( ) // Values returns all known values for DataSourceErrorInfoType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceErrorInfoType) Values() []DataSourceErrorInfoType { return []DataSourceErrorInfoType{ "ACCESS_DENIED", @@ -1193,6 +1247,7 @@ const ( // Values returns all known values for DataSourceFilterAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceFilterAttribute) Values() []DataSourceFilterAttribute { return []DataSourceFilterAttribute{ @@ -1239,8 +1294,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "ADOBE_ANALYTICS", @@ -1286,8 +1342,9 @@ const ( ) // Values returns all known values for DateAggregationFunction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DateAggregationFunction) Values() []DateAggregationFunction { return []DateAggregationFunction{ "COUNT", @@ -1311,8 +1368,9 @@ const ( ) // Values returns all known values for DayOfTheWeek. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DayOfTheWeek) Values() []DayOfTheWeek { return []DayOfTheWeek{ "SUNDAY", @@ -1339,8 +1397,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1371,8 +1430,9 @@ const ( ) // Values returns all known values for DefaultAggregation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefaultAggregation) Values() []DefaultAggregation { return []DefaultAggregation{ "SUM", @@ -1402,8 +1462,9 @@ const ( ) // Values returns all known values for DisplayFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DisplayFormat) Values() []DisplayFormat { return []DisplayFormat{ "AUTO", @@ -1425,8 +1486,9 @@ const ( ) // Values returns all known values for Edition. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Edition) Values() []Edition { return []Edition{ "STANDARD", @@ -1445,8 +1507,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "IAM", @@ -1471,8 +1534,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "USER", @@ -1500,8 +1564,9 @@ const ( ) // Values returns all known values for FileFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileFormat) Values() []FileFormat { return []FileFormat{ "CSV", @@ -1523,8 +1588,9 @@ const ( ) // Values returns all known values for FilterClass. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterClass) Values() []FilterClass { return []FilterClass{ "ENFORCED_VALUE_FILTER", @@ -1543,8 +1609,9 @@ const ( ) // Values returns all known values for FilterNullOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterNullOption) Values() []FilterNullOption { return []FilterNullOption{ "ALL_VALUES", @@ -1562,8 +1629,9 @@ const ( ) // Values returns all known values for FilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperator) Values() []FilterOperator { return []FilterOperator{ "StringEquals", @@ -1580,8 +1648,9 @@ const ( ) // Values returns all known values for FilterVisualScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterVisualScope) Values() []FilterVisualScope { return []FilterVisualScope{ "ALL_VISUALS", @@ -1603,8 +1672,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PARENT_FOLDER_ARN", @@ -1626,8 +1696,9 @@ const ( ) // Values returns all known values for FolderType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FolderType) Values() []FolderType { return []FolderType{ "SHARED", @@ -1644,8 +1715,9 @@ const ( ) // Values returns all known values for FontDecoration. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FontDecoration) Values() []FontDecoration { return []FontDecoration{ "UNDERLINE", @@ -1662,8 +1734,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1680,8 +1753,9 @@ const ( ) // Values returns all known values for FontWeightName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FontWeightName) Values() []FontWeightName { return []FontWeightName{ "NORMAL", @@ -1699,8 +1773,9 @@ const ( // Values returns all known values for ForecastComputationSeasonality. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ForecastComputationSeasonality) Values() []ForecastComputationSeasonality { return []ForecastComputationSeasonality{ "AUTOMATIC", @@ -1721,8 +1796,9 @@ const ( // Values returns all known values for FunnelChartMeasureDataLabelStyle. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FunnelChartMeasureDataLabelStyle) Values() []FunnelChartMeasureDataLabelStyle { return []FunnelChartMeasureDataLabelStyle{ "VALUE_ONLY", @@ -1741,8 +1817,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "US", @@ -1763,8 +1840,9 @@ const ( ) // Values returns all known values for GeoSpatialDataRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoSpatialDataRole) Values() []GeoSpatialDataRole { return []GeoSpatialDataRole{ "COUNTRY", @@ -1788,8 +1866,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeospatialSelectedPointStyle) Values() []GeospatialSelectedPointStyle { return []GeospatialSelectedPointStyle{ "POINT", @@ -1806,8 +1885,9 @@ const ( ) // Values returns all known values for GroupFilterAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupFilterAttribute) Values() []GroupFilterAttribute { return []GroupFilterAttribute{ "GROUP_NAME", @@ -1822,8 +1902,9 @@ const ( ) // Values returns all known values for GroupFilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupFilterOperator) Values() []GroupFilterOperator { return []GroupFilterOperator{ "StartsWith", @@ -1839,8 +1920,9 @@ const ( ) // Values returns all known values for HistogramBinType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HistogramBinType) Values() []HistogramBinType { return []HistogramBinType{ "BIN_COUNT", @@ -1859,8 +1941,9 @@ const ( ) // Values returns all known values for HorizontalTextAlignment. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HorizontalTextAlignment) Values() []HorizontalTextAlignment { return []HorizontalTextAlignment{ "LEFT", @@ -1903,8 +1986,9 @@ const ( ) // Values returns all known values for Icon. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Icon) Values() []Icon { return []Icon{ "CARET_UP", @@ -1944,8 +2028,9 @@ const ( ) // Values returns all known values for IdentityStore. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentityStore) Values() []IdentityStore { return []IdentityStore{ "QUICKSIGHT", @@ -1962,8 +2047,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -2024,8 +2110,9 @@ const ( ) // Values returns all known values for IngestionErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionErrorType) Values() []IngestionErrorType { return []IngestionErrorType{ "FAILURE_TO_ASSUME_ROLE", @@ -2085,8 +2172,9 @@ const ( ) // Values returns all known values for IngestionRequestSource. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionRequestSource) Values() []IngestionRequestSource { return []IngestionRequestSource{ "MANUAL", @@ -2105,8 +2193,9 @@ const ( ) // Values returns all known values for IngestionRequestType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionRequestType) Values() []IngestionRequestType { return []IngestionRequestType{ "INITIAL_INGESTION", @@ -2129,8 +2218,9 @@ const ( ) // Values returns all known values for IngestionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionStatus) Values() []IngestionStatus { return []IngestionStatus{ "INITIALIZED", @@ -2151,8 +2241,9 @@ const ( ) // Values returns all known values for IngestionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IngestionType) Values() []IngestionType { return []IngestionType{ "INCREMENTAL_REFRESH", @@ -2174,8 +2265,9 @@ const ( ) // Values returns all known values for InputColumnDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InputColumnDataType) Values() []InputColumnDataType { return []InputColumnDataType{ "STRING", @@ -2199,8 +2291,9 @@ const ( ) // Values returns all known values for JoinType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JoinType) Values() []JoinType { return []JoinType{ "INNER", @@ -2219,8 +2312,9 @@ const ( ) // Values returns all known values for KPISparklineType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KPISparklineType) Values() []KPISparklineType { return []KPISparklineType{ "LINE", @@ -2238,6 +2332,7 @@ const ( // Values returns all known values for KPIVisualStandardLayoutType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (KPIVisualStandardLayoutType) Values() []KPIVisualStandardLayoutType { return []KPIVisualStandardLayoutType{ @@ -2257,8 +2352,9 @@ const ( ) // Values returns all known values for LayoutElementType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LayoutElementType) Values() []LayoutElementType { return []LayoutElementType{ "VISUAL", @@ -2279,8 +2375,9 @@ const ( ) // Values returns all known values for LegendPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LegendPosition) Values() []LegendPosition { return []LegendPosition{ "AUTO", @@ -2300,8 +2397,9 @@ const ( ) // Values returns all known values for LineChartLineStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineChartLineStyle) Values() []LineChartLineStyle { return []LineChartLineStyle{ "SOLID", @@ -2322,8 +2420,9 @@ const ( ) // Values returns all known values for LineChartMarkerShape. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineChartMarkerShape) Values() []LineChartMarkerShape { return []LineChartMarkerShape{ "CIRCLE", @@ -2344,8 +2443,9 @@ const ( ) // Values returns all known values for LineChartType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineChartType) Values() []LineChartType { return []LineChartType{ "LINE", @@ -2364,8 +2464,9 @@ const ( ) // Values returns all known values for LineInterpolation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineInterpolation) Values() []LineInterpolation { return []LineInterpolation{ "LINEAR", @@ -2384,8 +2485,9 @@ const ( ) // Values returns all known values for LookbackWindowSizeUnit. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LookbackWindowSizeUnit) Values() []LookbackWindowSizeUnit { return []LookbackWindowSizeUnit{ "HOUR", @@ -2403,8 +2505,9 @@ const ( ) // Values returns all known values for MapZoomMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MapZoomMode) Values() []MapZoomMode { return []MapZoomMode{ "AUTO", @@ -2422,8 +2525,9 @@ const ( // Values returns all known values for MaximumMinimumComputationType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaximumMinimumComputationType) Values() []MaximumMinimumComputationType { return []MaximumMinimumComputationType{ "MAXIMUM", @@ -2443,8 +2547,9 @@ const ( ) // Values returns all known values for MemberType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberType) Values() []MemberType { return []MemberType{ "DASHBOARD", @@ -2466,6 +2571,7 @@ const ( // Values returns all known values for MissingDataTreatmentOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MissingDataTreatmentOption) Values() []MissingDataTreatmentOption { return []MissingDataTreatmentOption{ @@ -2495,8 +2601,9 @@ const ( ) // Values returns all known values for NamedEntityAggType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamedEntityAggType) Values() []NamedEntityAggType { return []NamedEntityAggType{ "SUM", @@ -2534,8 +2641,9 @@ const ( ) // Values returns all known values for NamedFilterAggType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamedFilterAggType) Values() []NamedFilterAggType { return []NamedFilterAggType{ "NO_AGGREGATION", @@ -2565,8 +2673,9 @@ const ( ) // Values returns all known values for NamedFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamedFilterType) Values() []NamedFilterType { return []NamedFilterType{ "CATEGORY_FILTER", @@ -2586,8 +2695,9 @@ const ( ) // Values returns all known values for NamespaceErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceErrorType) Values() []NamespaceErrorType { return []NamespaceErrorType{ "PERMISSION_DENIED", @@ -2607,8 +2717,9 @@ const ( ) // Values returns all known values for NamespaceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceStatus) Values() []NamespaceStatus { return []NamespaceStatus{ "CREATED", @@ -2629,6 +2740,7 @@ const ( // 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{ @@ -2654,8 +2766,9 @@ const ( ) // Values returns all known values for NetworkInterfaceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkInterfaceStatus) Values() []NetworkInterfaceStatus { return []NetworkInterfaceStatus{ "CREATING", @@ -2684,8 +2797,9 @@ const ( ) // Values returns all known values for NumberScale. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumberScale) Values() []NumberScale { return []NumberScale{ "NONE", @@ -2707,8 +2821,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumericEqualityMatchOperator) Values() []NumericEqualityMatchOperator { return []NumericEqualityMatchOperator{ "EQUALS", @@ -2725,8 +2840,9 @@ const ( // Values returns all known values for NumericFilterSelectAllOptions. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumericFilterSelectAllOptions) Values() []NumericFilterSelectAllOptions { return []NumericFilterSelectAllOptions{ "FILTER_ALL_VALUES", @@ -2743,8 +2859,9 @@ const ( ) // Values returns all known values for NumericSeparatorSymbol. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumericSeparatorSymbol) Values() []NumericSeparatorSymbol { return []NumericSeparatorSymbol{ "COMMA", @@ -2762,8 +2879,9 @@ const ( ) // Values returns all known values for OtherCategories. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OtherCategories) Values() []OtherCategories { return []OtherCategories{ "INCLUDE", @@ -2781,8 +2899,9 @@ const ( ) // Values returns all known values for PanelBorderStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PanelBorderStyle) Values() []PanelBorderStyle { return []PanelBorderStyle{ "SOLID", @@ -2800,8 +2919,9 @@ const ( ) // Values returns all known values for PaperOrientation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PaperOrientation) Values() []PaperOrientation { return []PaperOrientation{ "PORTRAIT", @@ -2827,8 +2947,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2854,8 +2975,9 @@ const ( ) // Values returns all known values for ParameterValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterValueType) Values() []ParameterValueType { return []ParameterValueType{ "MULTI_VALUED", @@ -2874,8 +2996,9 @@ const ( // Values returns all known values for PivotTableConditionalFormattingScopeRole. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PivotTableConditionalFormattingScopeRole) Values() []PivotTableConditionalFormattingScopeRole { return []PivotTableConditionalFormattingScopeRole{ "FIELD", @@ -2895,8 +3018,9 @@ const ( ) // Values returns all known values for PivotTableDataPathType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PivotTableDataPathType) Values() []PivotTableDataPathType { return []PivotTableDataPathType{ "HIERARCHY_ROWS_LAYOUT_COLUMN", @@ -2916,8 +3040,9 @@ const ( // Values returns all known values for PivotTableFieldCollapseState. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PivotTableFieldCollapseState) Values() []PivotTableFieldCollapseState { return []PivotTableFieldCollapseState{ "COLLAPSED", @@ -2935,6 +3060,7 @@ const ( // Values returns all known values for PivotTableMetricPlacement. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (PivotTableMetricPlacement) Values() []PivotTableMetricPlacement { return []PivotTableMetricPlacement{ @@ -2952,8 +3078,9 @@ const ( ) // Values returns all known values for PivotTableRowsLayout. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PivotTableRowsLayout) Values() []PivotTableRowsLayout { return []PivotTableRowsLayout{ "TABULAR", @@ -2971,8 +3098,9 @@ const ( ) // Values returns all known values for PivotTableSubtotalLevel. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PivotTableSubtotalLevel) Values() []PivotTableSubtotalLevel { return []PivotTableSubtotalLevel{ "ALL", @@ -2991,8 +3119,9 @@ const ( ) // Values returns all known values for PrimaryValueDisplayType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrimaryValueDisplayType) Values() []PrimaryValueDisplayType { return []PrimaryValueDisplayType{ "HIDDEN", @@ -3010,8 +3139,9 @@ const ( ) // Values returns all known values for PropertyRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyRole) Values() []PropertyRole { return []PropertyRole{ "PRIMARY", @@ -3029,8 +3159,9 @@ const ( ) // Values returns all known values for PropertyUsage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyUsage) Values() []PropertyUsage { return []PropertyUsage{ "INHERIT", @@ -3048,8 +3179,9 @@ const ( ) // Values returns all known values for PurchaseMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PurchaseMode) Values() []PurchaseMode { return []PurchaseMode{ "MANUAL", @@ -3068,6 +3200,7 @@ const ( // Values returns all known values for RadarChartAxesRangeScale. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RadarChartAxesRangeScale) Values() []RadarChartAxesRangeScale { return []RadarChartAxesRangeScale{ @@ -3086,8 +3219,9 @@ const ( ) // Values returns all known values for RadarChartShape. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RadarChartShape) Values() []RadarChartShape { return []RadarChartShape{ "CIRCLE", @@ -3106,8 +3240,9 @@ const ( // Values returns all known values for ReferenceLineLabelHorizontalPosition. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceLineLabelHorizontalPosition) Values() []ReferenceLineLabelHorizontalPosition { return []ReferenceLineLabelHorizontalPosition{ "LEFT", @@ -3126,8 +3261,9 @@ const ( // Values returns all known values for ReferenceLineLabelVerticalPosition. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceLineLabelVerticalPosition) Values() []ReferenceLineLabelVerticalPosition { return []ReferenceLineLabelVerticalPosition{ "ABOVE", @@ -3146,6 +3282,7 @@ const ( // 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{ @@ -3164,8 +3301,9 @@ const ( ) // Values returns all known values for ReferenceLineSeriesType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceLineSeriesType) Values() []ReferenceLineSeriesType { return []ReferenceLineSeriesType{ "BAR", @@ -3183,8 +3321,9 @@ const ( // Values returns all known values for ReferenceLineValueLabelRelativePosition. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReferenceLineValueLabelRelativePosition) Values() []ReferenceLineValueLabelRelativePosition { return []ReferenceLineValueLabelRelativePosition{ "BEFORE_CUSTOM_LABEL", @@ -3205,8 +3344,9 @@ const ( ) // Values returns all known values for RefreshInterval. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RefreshInterval) Values() []RefreshInterval { return []RefreshInterval{ "MINUTE15", @@ -3230,8 +3370,9 @@ const ( ) // Values returns all known values for RelativeDateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelativeDateType) Values() []RelativeDateType { return []RelativeDateType{ "PREVIOUS", @@ -3254,8 +3395,9 @@ const ( ) // Values returns all known values for RelativeFontSize. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelativeFontSize) Values() []RelativeFontSize { return []RelativeFontSize{ "EXTRA_SMALL", @@ -3275,8 +3417,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -3298,8 +3441,9 @@ const ( ) // Values returns all known values for ResourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStatus) Values() []ResourceStatus { return []ResourceStatus{ "CREATION_IN_PROGRESS", @@ -3325,8 +3469,9 @@ const ( ) // Values returns all known values for Role. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Role) Values() []Role { return []Role{ "ADMIN", @@ -3348,8 +3493,9 @@ const ( // Values returns all known values for RowLevelPermissionFormatVersion. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RowLevelPermissionFormatVersion) Values() []RowLevelPermissionFormatVersion { return []RowLevelPermissionFormatVersion{ "VERSION_1", @@ -3367,6 +3513,7 @@ const ( // 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{ @@ -3384,8 +3531,9 @@ const ( ) // Values returns all known values for SectionPageBreakStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SectionPageBreakStatus) Values() []SectionPageBreakStatus { return []SectionPageBreakStatus{ "ENABLED", @@ -3401,8 +3549,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ALL_VALUES", @@ -3417,8 +3566,9 @@ const ( ) // Values returns all known values for SelectedFieldOptions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SelectedFieldOptions) Values() []SelectedFieldOptions { return []SelectedFieldOptions{ "ALL_FIELDS", @@ -3434,8 +3584,9 @@ const ( ) // Values returns all known values for SelectedTooltipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SelectedTooltipType) Values() []SelectedTooltipType { return []SelectedTooltipType{ "BASIC", @@ -3451,8 +3602,9 @@ const ( ) // Values returns all known values for ServiceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceType) Values() []ServiceType { return []ServiceType{ "REDSHIFT", @@ -3468,8 +3620,9 @@ const ( ) // Values returns all known values for SharingModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SharingModel) Values() []SharingModel { return []SharingModel{ "ACCOUNT", @@ -3486,8 +3639,9 @@ const ( ) // Values returns all known values for SheetContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SheetContentType) Values() []SheetContentType { return []SheetContentType{ "PAGINATED", @@ -3505,8 +3659,9 @@ const ( // Values returns all known values for SheetControlDateTimePickerType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SheetControlDateTimePickerType) Values() []SheetControlDateTimePickerType { return []SheetControlDateTimePickerType{ "SINGLE_VALUED", @@ -3523,8 +3678,9 @@ const ( ) // Values returns all known values for SheetControlListType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SheetControlListType) Values() []SheetControlListType { return []SheetControlListType{ "MULTI_SELECT", @@ -3541,8 +3697,9 @@ const ( ) // Values returns all known values for SheetControlSliderType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SheetControlSliderType) Values() []SheetControlSliderType { return []SheetControlSliderType{ "SINGLE_POINT", @@ -3559,8 +3716,9 @@ const ( // Values returns all known values for SimpleAttributeAggregationFunction. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimpleAttributeAggregationFunction) Values() []SimpleAttributeAggregationFunction { return []SimpleAttributeAggregationFunction{ "UNIQUE_VALUE", @@ -3586,8 +3744,9 @@ const ( // Values returns all known values for SimpleNumericalAggregationFunction. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimpleNumericalAggregationFunction) Values() []SimpleNumericalAggregationFunction { return []SimpleNumericalAggregationFunction{ "SUM", @@ -3618,8 +3777,9 @@ const ( // Values returns all known values for SimpleTotalAggregationFunction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimpleTotalAggregationFunction) Values() []SimpleTotalAggregationFunction { return []SimpleTotalAggregationFunction{ "DEFAULT", @@ -3639,8 +3799,9 @@ const ( ) // Values returns all known values for SingleYAxisOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SingleYAxisOption) Values() []SingleYAxisOption { return []SingleYAxisOption{ "PRIMARY_Y_AXIS", @@ -3657,6 +3818,7 @@ const ( // Values returns all known values for SmallMultiplesAxisPlacement. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SmallMultiplesAxisPlacement) Values() []SmallMultiplesAxisPlacement { return []SmallMultiplesAxisPlacement{ @@ -3674,8 +3836,9 @@ const ( ) // Values returns all known values for SmallMultiplesAxisScale. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SmallMultiplesAxisScale) Values() []SmallMultiplesAxisScale { return []SmallMultiplesAxisScale{ "SHARED", @@ -3693,8 +3856,9 @@ const ( ) // Values returns all known values for SnapshotFileFormatType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotFileFormatType) Values() []SnapshotFileFormatType { return []SnapshotFileFormatType{ "CSV", @@ -3713,8 +3877,9 @@ const ( // Values returns all known values for SnapshotFileSheetSelectionScope. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotFileSheetSelectionScope) Values() []SnapshotFileSheetSelectionScope { return []SnapshotFileSheetSelectionScope{ "ALL_VISUALS", @@ -3733,8 +3898,9 @@ const ( ) // Values returns all known values for SnapshotJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotJobStatus) Values() []SnapshotJobStatus { return []SnapshotJobStatus{ "QUEUED", @@ -3753,8 +3919,9 @@ const ( ) // Values returns all known values for SortDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortDirection) Values() []SortDirection { return []SortDirection{ "ASC", @@ -3772,8 +3939,9 @@ const ( ) // Values returns all known values for SpecialValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpecialValue) Values() []SpecialValue { return []SpecialValue{ "EMPTY", @@ -3791,8 +3959,9 @@ const ( ) // Values returns all known values for StarburstProductType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StarburstProductType) Values() []StarburstProductType { return []StarburstProductType{ "GALAXY", @@ -3809,8 +3978,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "ENABLED", @@ -3828,8 +3998,9 @@ const ( ) // Values returns all known values for StyledCellType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StyledCellType) Values() []StyledCellType { return []StyledCellType{ "TOTAL", @@ -3847,8 +4018,9 @@ const ( ) // Values returns all known values for TableBorderStyle. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableBorderStyle) Values() []TableBorderStyle { return []TableBorderStyle{ "NONE", @@ -3867,8 +4039,9 @@ const ( // Values returns all known values for TableCellImageScalingConfiguration. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableCellImageScalingConfiguration) Values() []TableCellImageScalingConfiguration { return []TableCellImageScalingConfiguration{ "FIT_TO_CELL_HEIGHT", @@ -3885,8 +4058,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "LINK", @@ -3902,8 +4076,9 @@ const ( ) // Values returns all known values for TableOrientation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableOrientation) Values() []TableOrientation { return []TableOrientation{ "VERTICAL", @@ -3921,8 +4096,9 @@ const ( ) // Values returns all known values for TableTotalsPlacement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableTotalsPlacement) Values() []TableTotalsPlacement { return []TableTotalsPlacement{ "START", @@ -3940,8 +4116,9 @@ const ( ) // Values returns all known values for TableTotalsScrollStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableTotalsScrollStatus) Values() []TableTotalsScrollStatus { return []TableTotalsScrollStatus{ "PINNED", @@ -3957,8 +4134,9 @@ const ( ) // Values returns all known values for TargetVisualOptions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetVisualOptions) Values() []TargetVisualOptions { return []TargetVisualOptions{ "ALL_VISUALS", @@ -3976,8 +4154,9 @@ const ( ) // Values returns all known values for TemplateErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateErrorType) Values() []TemplateErrorType { return []TemplateErrorType{ "SOURCE_NOT_FOUND", @@ -3996,8 +4175,9 @@ const ( ) // Values returns all known values for TextQualifier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextQualifier) Values() []TextQualifier { return []TextQualifier{ "DOUBLE_QUOTE", @@ -4014,8 +4194,9 @@ const ( ) // Values returns all known values for TextWrap. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextWrap) Values() []TextWrap { return []TextWrap{ "NONE", @@ -4031,8 +4212,9 @@ const ( ) // Values returns all known values for ThemeErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThemeErrorType) Values() []ThemeErrorType { return []ThemeErrorType{ "INTERNAL_FAILURE", @@ -4049,8 +4231,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -4075,8 +4258,9 @@ const ( ) // Values returns all known values for TimeGranularity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeGranularity) Values() []TimeGranularity { return []TimeGranularity{ "YEAR", @@ -4101,8 +4285,9 @@ const ( ) // Values returns all known values for TooltipTarget. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TooltipTarget) Values() []TooltipTarget { return []TooltipTarget{ "BOTH", @@ -4120,8 +4305,9 @@ const ( ) // Values returns all known values for TooltipTitleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TooltipTitleType) Values() []TooltipTitleType { return []TooltipTitleType{ "NONE", @@ -4139,6 +4325,7 @@ const ( // 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{ @@ -4156,8 +4343,9 @@ const ( ) // Values returns all known values for TopBottomSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TopBottomSortOrder) Values() []TopBottomSortOrder { return []TopBottomSortOrder{ "PERCENT_DIFFERENCE", @@ -4175,6 +4363,7 @@ const ( // Values returns all known values for TopicNumericSeparatorSymbol. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TopicNumericSeparatorSymbol) Values() []TopicNumericSeparatorSymbol { return []TopicNumericSeparatorSymbol{ @@ -4195,8 +4384,9 @@ const ( ) // Values returns all known values for TopicRefreshStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TopicRefreshStatus) Values() []TopicRefreshStatus { return []TopicRefreshStatus{ "INITIALIZED", @@ -4220,8 +4410,9 @@ const ( // Values returns all known values for TopicRelativeDateFilterFunction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TopicRelativeDateFilterFunction) Values() []TopicRelativeDateFilterFunction { return []TopicRelativeDateFilterFunction{ "PREVIOUS", @@ -4243,8 +4434,9 @@ const ( ) // Values returns all known values for TopicScheduleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TopicScheduleType) Values() []TopicScheduleType { return []TopicScheduleType{ "HOURLY", @@ -4269,8 +4461,9 @@ const ( ) // Values returns all known values for TopicTimeGranularity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TopicTimeGranularity) Values() []TopicTimeGranularity { return []TopicTimeGranularity{ "SECOND", @@ -4294,6 +4487,7 @@ const ( // Values returns all known values for TopicUserExperienceVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TopicUserExperienceVersion) Values() []TopicUserExperienceVersion { return []TopicUserExperienceVersion{ @@ -4312,6 +4506,7 @@ const ( // Values returns all known values for UndefinedSpecifiedValueType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (UndefinedSpecifiedValueType) Values() []UndefinedSpecifiedValueType { return []UndefinedSpecifiedValueType{ @@ -4330,8 +4525,9 @@ const ( ) // Values returns all known values for URLTargetConfiguration. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (URLTargetConfiguration) Values() []URLTargetConfiguration { return []URLTargetConfiguration{ "NEW_TAB", @@ -4355,8 +4551,9 @@ const ( ) // Values returns all known values for UserRole. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserRole) Values() []UserRole { return []UserRole{ "ADMIN", @@ -4379,8 +4576,9 @@ const ( ) // Values returns all known values for ValidationStrategyMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationStrategyMode) Values() []ValidationStrategyMode { return []ValidationStrategyMode{ "STRICT", @@ -4397,8 +4595,9 @@ const ( ) // Values returns all known values for ValueWhenUnsetOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValueWhenUnsetOption) Values() []ValueWhenUnsetOption { return []ValueWhenUnsetOption{ "RECOMMENDED_VALUE", @@ -4417,8 +4616,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TOP", @@ -4437,8 +4637,9 @@ const ( ) // Values returns all known values for Visibility. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Visibility) Values() []Visibility { return []Visibility{ "HIDDEN", @@ -4456,6 +4657,7 @@ const ( // Values returns all known values for VisualCustomActionTrigger. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VisualCustomActionTrigger) Values() []VisualCustomActionTrigger { return []VisualCustomActionTrigger{ @@ -4475,8 +4677,9 @@ const ( // Values returns all known values for VPCConnectionAvailabilityStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VPCConnectionAvailabilityStatus) Values() []VPCConnectionAvailabilityStatus { return []VPCConnectionAvailabilityStatus{ "AVAILABLE", @@ -4502,6 +4705,7 @@ const ( // Values returns all known values for VPCConnectionResourceStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VPCConnectionResourceStatus) Values() []VPCConnectionResourceStatus { return []VPCConnectionResourceStatus{ @@ -4526,8 +4730,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -4544,8 +4749,9 @@ const ( ) // Values returns all known values for WordCloudCloudLayout. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WordCloudCloudLayout) Values() []WordCloudCloudLayout { return []WordCloudCloudLayout{ "FLUID", @@ -4562,8 +4768,9 @@ const ( ) // Values returns all known values for WordCloudWordCasing. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WordCloudWordCasing) Values() []WordCloudWordCasing { return []WordCloudWordCasing{ "LOWER_CASE", @@ -4581,6 +4788,7 @@ const ( // 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{ @@ -4600,8 +4808,9 @@ const ( ) // Values returns all known values for WordCloudWordPadding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WordCloudWordPadding) Values() []WordCloudWordPadding { return []WordCloudWordPadding{ "NONE", @@ -4620,8 +4829,9 @@ const ( ) // Values returns all known values for WordCloudWordScaling. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WordCloudWordScaling) Values() []WordCloudWordScaling { return []WordCloudWordScaling{ "EMPHASIZE", diff --git a/service/quicksight/types/errors.go b/service/quicksight/types/errors.go index f427d14b4d6..cc7974be07f 100644 --- a/service/quicksight/types/errors.go +++ b/service/quicksight/types/errors.go @@ -504,9 +504,12 @@ func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.Fau // QuickSight without the required pricing plan on your Amazon Web Services // 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) -// API operation with the --identity-type ANONYMOUS option. +// this on the Manage Amazon QuickSight page. +// +// After capacity pricing is added, you can use the [GetDashboardEmbedUrl] API operation with the +// --identity-type ANONYMOUS option. +// +// [GetDashboardEmbedUrl]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html type UnsupportedPricingPlanException struct { Message *string diff --git a/service/quicksight/types/types.go b/service/quicksight/types/types.go index 03179156fc5..0fb695b456b 100644 --- a/service/quicksight/types/types.go +++ b/service/quicksight/types/types.go @@ -21,11 +21,16 @@ 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. type AccountInfo struct { @@ -75,8 +80,9 @@ type AccountSettings struct { // 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) - // . + // see [UpdatePublicSharingSettings]. + // + // [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 @@ -109,8 +115,9 @@ 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 +// 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 { @@ -118,14 +125,20 @@ type AggregationFunction struct { AttributeAggregationFunction *AttributeAggregationFunction // Aggregation for categorical 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. DateAggregationFunction DateAggregationFunction @@ -144,7 +157,9 @@ type AggregationSortConfiguration struct { Column *ColumnIdentifier // The sort direction of values. + // // - ASC : Sort in ascending order. + // // - DESC : Sort in descending order. // // This member is required. @@ -158,9 +173,10 @@ type AggregationSortConfiguration struct { // An empty object that represents that the AllSheets option is the chosen value // for the FilterScopeConfiguration parameter. This structure applies the filter -// to all visuals on all sheets of an Analysis, Dashboard, or Template. This is a -// union type structure. For this structure to be valid, only one of the attributes -// can be defined. +// to all visuals on all sheets of an Analysis, Dashboard, or Template. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type AllSheetsFilterScopeConfiguration struct { noSmithyDocumentSerde } @@ -250,22 +266,28 @@ type AnalysisDefinition struct { // An array of calculated field definitions for the analysis. CalculatedFields []CalculatedField - // An array of analysis-level column configurations. Column configurations can be + // An array of analysis-level column configurations. Column configurations can be // used to set default formatting for a column to be used throughout an analysis. 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. + // Filter definitions for an analysis. + // + // For more information, see [Filtering Data in Amazon QuickSight] in the Amazon QuickSight User Guide. + // + // [Filtering Data in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html FilterGroups []FilterGroup // An array of option definitions for an analysis. Options *AssetOptions - // 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) - // in the Amazon QuickSight User Guide. + // 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] in the Amazon QuickSight User Guide. + // + // [Parameters in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html ParameterDeclarations []ParameterDeclaration // An array of sheet definitions for an analysis. Each SheetDefinition provides @@ -294,37 +316,48 @@ 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_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, // "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 @@ -389,6 +422,7 @@ type AnalysisSummary struct { type AnchorDateConfiguration struct { // The options for the date configuration. Choose one of the options below: + // // - NOW AnchorOption AnchorOption @@ -403,9 +437,11 @@ type AnonymousUserDashboardEmbeddingConfiguration struct { // The dashboard ID for the dashboard that you want the user to see first. This ID // 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 . + // 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 . // // This member is required. InitialDashboardId *string @@ -419,9 +455,11 @@ 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 . + // 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 . // // This member is required. InitialDashboardVisualId *DashboardVisualId @@ -454,10 +492,11 @@ type AnonymousUserGenerativeQnAEmbeddingConfiguration struct { // The Amazon QuickSight Q topic ID of the new reader experience topic that you // want the anonymous user to see first. This ID is included in the output URL. // When the URL in response is accessed, Amazon QuickSight renders the Generative - // Q&A experience with this new reader experience topic pre selected. The Amazon - // Resource Name (ARN) of this Q new reader experience topic must be included in - // the AuthorizedResourceArns parameter. Otherwise, the request fails with an - // InvalidParameterValueException error. + // Q&A experience with this new reader experience topic pre selected. + // + // The Amazon Resource Name (ARN) of this Q new reader experience topic must be + // included in the AuthorizedResourceArns parameter. Otherwise, the request fails + // with an InvalidParameterValueException error. // // This member is required. InitialTopicId *string @@ -471,9 +510,11 @@ type AnonymousUserQSearchBarEmbeddingConfiguration struct { // The Amazon QuickSight Q topic ID of the legacy topic that you want the // anonymous user to see first. This ID is included in the output URL. When the URL // in response is accessed, Amazon QuickSight renders the Q search bar with this - // legacy topic pre-selected. The Amazon Resource Name (ARN) of this Q legacy topic - // must be included in the AuthorizedResourceArns parameter. Otherwise, the - // request fails with an InvalidParameterValueException error. + // legacy topic pre-selected. + // + // The Amazon Resource Name (ARN) of this Q legacy topic must be included in the + // AuthorizedResourceArns parameter. Otherwise, the request fails with an + // InvalidParameterValueException error. // // This member is required. InitialTopicId *string @@ -1075,7 +1116,7 @@ type AssetBundleImportJobOverrideParameters struct { // bundle that is imported. DataSets []AssetBundleImportJobDataSetOverrideParameters - // A list of overrides for any DataSource resources that are present in the asset + // A list of overrides for any DataSource resources that are present in the asset // bundle that is imported. DataSources []AssetBundleImportJobDataSourceOverrideParameters @@ -1338,11 +1379,12 @@ type AssetBundleImportJobWarning struct { type AssetBundleImportSource struct { // The bytes of the base64 encoded asset bundle import zip file. This file can't - // exceed 20 MB. If you are calling the API operations from the Amazon Web Services - // SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically - // to allow the direct setting of the zip file's bytes. If you are using an SDK for - // a different language or receiving related errors, try to base64 encode your - // data. + // exceed 20 MB. + // + // If you are calling the API operations from the Amazon Web Services SDK for + // Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow + // the direct setting of the zip file's bytes. If you are using an SDK for a + // different language or receiving related errors, try to base64 encode your data. Body []byte // The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 @@ -1431,6 +1473,7 @@ type AthenaParameters struct { type AttributeAggregationFunction struct { // The built-in aggregation functions for attributes. + // // - UNIQUE_VALUE : Returns the unique value for a field, aggregated by the // dimension fields. SimpleAttributeAggregation SimpleAttributeAggregationFunction @@ -1509,8 +1552,10 @@ 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. @@ -1564,9 +1609,10 @@ 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. @@ -1610,8 +1656,10 @@ type AxisLabelReferenceOptions struct { noSmithyDocumentSerde } -// The liner axis scale setup. This is a union type structure. For this structure -// to be valid, only one of the attributes can be defined. +// The liner axis scale setup. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type AxisLinearScale struct { // The step count setup of a linear axis. @@ -1632,9 +1680,10 @@ type AxisLogarithmicScale struct { noSmithyDocumentSerde } -// The scale setup options for a numeric axis display. This is a union type -// structure. For this structure to be valid, only one of the attributes can be -// defined. +// The scale setup options for a numeric axis display. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type AxisScale struct { // The linear axis scale setup. @@ -1712,9 +1761,11 @@ type BarChartConfiguration struct { // 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. @@ -1746,8 +1797,10 @@ type BarChartConfiguration struct { noSmithyDocumentSerde } -// 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. +// 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 { // The aggregated field wells of a bar chart. @@ -1780,18 +1833,26 @@ 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 -// structure: +// 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 // -// 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] in the Amazon QuickSight User Guide. +// +// [Using bar charts]: https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html type BarChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -1966,8 +2027,10 @@ type BoxPlotChartConfiguration struct { noSmithyDocumentSerde } -// 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. +// 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 { // The aggregated field wells of a box plot. @@ -2012,8 +2075,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using box plots]: https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html type BoxPlotVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -2210,9 +2276,11 @@ type CategoryDrillDownFilter struct { noSmithyDocumentSerde } -// 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) -// in the Amazon QuickSight User Guide. +// A CategoryFilter filters text values. +// +// For more information, see [Adding text filters] in the Amazon QuickSight User Guide. +// +// [Adding text filters]: https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html type CategoryFilter struct { // The column that the filter is applied to. @@ -2238,8 +2306,10 @@ 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 @@ -2278,9 +2348,10 @@ type ChartAxisLabelOptions struct { // The visibility configuration of the sort icon on a chart's axis label. SortIconVisibility Visibility - // The visibility of an axis label on a chart. Choose one of the following - // options: + // The visibility of an axis label on a chart. Choose one of the following options: + // // - VISIBLE : Shows the axis. + // // - HIDDEN : Hides the axis. Visibility Visibility @@ -2487,9 +2558,10 @@ type ColumnSort struct { noSmithyDocumentSerde } -// 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. +// A tag for a column in a [TagColumnOperation] structure. This is a variant type structure. For this +// structure to be valid, only one of the attributes can be non-null. +// +// [TagColumnOperation]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html type ColumnTag struct { // A description for a column. @@ -2545,14 +2617,18 @@ type ComboChartAggregatedFieldWells struct { // The configuration of a ComboChartVisual . type ComboChartConfiguration struct { - // The options that determine if visual data labels are displayed. The data label - // options for a bar in a combo chart. + // The options that determine if visual data labels are displayed. + // + // The data label options for a bar in a combo chart. BarDataLabels *DataLabelOptions // 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. BarsArrangement BarsArrangement @@ -2577,8 +2653,9 @@ type ComboChartConfiguration struct { // The legend display setup of the visual. Legend *LegendOptions - // The options that determine if visual data labels are displayed. The data label - // options for a line in a combo chart. + // The options that determine if visual data labels are displayed. + // + // The data label options for a line in a combo chart. LineDataLabels *DataLabelOptions // The label display options (grid line, range, scale, and axis step) of a combo @@ -2615,8 +2692,10 @@ type ComboChartConfiguration struct { noSmithyDocumentSerde } -// The field wells of the 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 the visual. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type ComboChartFieldWells struct { // The aggregated field wells of a combo chart. Combo charts only have aggregated @@ -2644,9 +2723,14 @@ type ComboChartSortConfiguration struct { noSmithyDocumentSerde } -// 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. +// A combo chart. +// +// The ComboChartVisual includes stacked bar combo charts and clustered bar combo +// charts +// +// For more information, see [Using combo charts] in the Amazon QuickSight User Guide. +// +// [Using combo charts]: https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html type ComboChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -2698,16 +2782,21 @@ type ComparisonConfiguration struct { ComparisonFormat *ComparisonFormatConfiguration // The method of the comparison. Choose from the following options: + // // - 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. @@ -2719,9 +2808,10 @@ type ComparisonFormatConfiguration struct { noSmithyDocumentSerde } -// The computation union that is used in an insight visual. This is a union type -// structure. For this structure to be valid, only one of the attributes can be -// defined. +// The computation union that is used in an insight visual. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type Computation struct { // The forecast computation configuration. @@ -2983,8 +3073,10 @@ type CustomActionFilterOperation struct { } // The navigation operation that navigates between different sheets in the same -// analysis. This is a union type structure. For this structure to be valid, only -// one of the attributes can be defined. +// analysis. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type CustomActionNavigationOperation struct { // The configuration that chooses the navigation target. @@ -3007,10 +3099,14 @@ 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 - // follows: + // 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. // // This member is required. @@ -3062,9 +3158,11 @@ type CustomContentConfiguration struct { 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) -// in the Amazon QuickSight User Guide. +// A visual that contains custom content. +// +// For more information, see [Using custom visual content] in the Amazon QuickSight User Guide. +// +// [Using custom visual content]: https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html type CustomContentVisual struct { // The dataset that is used to create the custom content visual. You can't create @@ -3105,22 +3203,28 @@ 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. // // This member is required. NullOption FilterNullOption - // The category value for the filter. This field is mutually exclusive to - // ParameterName . + // The category value for the filter. + // + // This field is mutually exclusive to ParameterName . CategoryValue *string - // The parameter whose value should be used for the filter value. This field is - // mutually exclusive to CategoryValue . + // The parameter whose value should be used for the filter value. + // + // This field is mutually exclusive to CategoryValue . ParameterName *string // Select all of the values. Null is not the assigned value of select all. + // // - FILTER_ALL_VALUES SelectAllOptions CategoryFilterSelectAllOptions @@ -3136,8 +3240,11 @@ 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. // // This member is required. @@ -3147,6 +3254,7 @@ type CustomFilterListConfiguration struct { CategoryValues []string // Select all of the values. Null is not the assigned value of select all. + // // - FILTER_ALL_VALUES SelectAllOptions CategoryFilterSelectAllOptions @@ -3164,8 +3272,10 @@ type CustomNarrativeOptions struct { noSmithyDocumentSerde } -// The customized parameter values. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The customized parameter values. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type CustomParameterValues struct { // A list of datetime-type parameter values. @@ -3211,8 +3321,10 @@ type CustomSql struct { // DestinationParameterValueConfiguration . type CustomValuesConfiguration struct { - // The customized parameter values. This is a union type structure. For this - // structure to be valid, only one of the attributes can be defined. + // The customized parameter values. + // + // This is a union type structure. For this structure to be valid, only one of the + // attributes can be defined. // // This member is required. CustomValues *CustomParameterValues @@ -3315,36 +3427,47 @@ 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, // "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_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 @@ -3468,18 +3591,22 @@ 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] in the Amazon QuickSight User Guide. + // + // [Filtering Data in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html FilterGroups []FilterGroup // An array of option definitions for a dashboard. Options *AssetOptions // 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) - // in the Amazon QuickSight User Guide. + // can transfer a value for use by an action or an object. + // + // For more information, see [Parameters in Amazon QuickSight] in the Amazon QuickSight User Guide. + // + // [Parameters in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html ParameterDeclarations []ParameterDeclaration // An array of sheet definitions for a dashboard. @@ -3513,8 +3640,11 @@ 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 , SheetId , and VisualId can be found in the IDs for developers @@ -3696,8 +3826,10 @@ type DataLabelOptions struct { noSmithyDocumentSerde } -// The option that determines the data label type. This is a union type structure. -// For this structure to be valid, only one of the attributes can be defined. +// The option that determines the data label type. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type DataLabelType struct { // The option that specifies individual data values for labels. @@ -3773,13 +3905,17 @@ type DataPathType struct { // The type of data path value utilized in a pivot table. Choose one of the // following options: + // // - HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout // column, when RowsLayout is set to HIERARCHY . + // // - MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column // when the row is set to Metric Placement. + // // - EMPTY_COLUMN_HEADER - The type of data path for the column with empty column // header, when there is no field in ColumnsFieldWell and the row is set to // Metric Placement. + // // - COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the // metric, when there is no field in the ValuesFieldWell . PivotTableDataPathType PivotTableDataPathType @@ -3839,8 +3975,9 @@ 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]. + // + // [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 @@ -4014,22 +4151,30 @@ 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_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. // @@ -4038,14 +4183,17 @@ type DataSetSearchFilter 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 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 - // for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": - // "Test" . The "StringLike" operator only supports the NAME value DATASET_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 + // datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": + // "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME + // value DATASET_NAME . // // This member is required. Operator FilterOperator @@ -4179,8 +4327,9 @@ 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]. + // + // [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 @@ -4476,17 +4625,23 @@ 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_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. // @@ -4495,15 +4650,17 @@ type DataSourceSearchFilter 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 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 @@ -4568,14 +4725,23 @@ type DateDimensionField struct { // The date granularity of the DateDimensionField . Choose one of the following // options: + // // - YEAR + // // - QUARTER + // // - MONTH + // // - WEEK + // // - DAY + // // - HOUR + // // - MINUTE + // // - SECOND + // // - MILLISECOND DateGranularity TimeGranularity @@ -4758,7 +4924,9 @@ type DateTimeValueWhenUnsetConfiguration struct { 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. ValueWhenUnsetOption ValueWhenUnsetOption @@ -4876,7 +5044,9 @@ type DecimalValueWhenUnsetConfiguration struct { 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. ValueWhenUnsetOption ValueWhenUnsetOption @@ -4892,7 +5062,9 @@ type DefaultDateTimePickerControlOptions struct { // The date time picker type of the DefaultDateTimePickerControlOptions . 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. Type SheetControlDateTimePickerType @@ -4954,7 +5126,9 @@ type DefaultFilterDropDownControlOptions struct { 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. Type SheetControlListType @@ -4972,7 +5146,9 @@ type DefaultFilterListControlOptions struct { // The type of the DefaultFilterListControlOptions . 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 @@ -5101,7 +5277,9 @@ type DefaultSliderControlOptions struct { // The type of the DefaultSliderControlOptions . 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 @@ -5129,9 +5307,10 @@ type DefaultTextFieldControlOptions struct { noSmithyDocumentSerde } -// The configuration of destination parameter values. This is a union type -// structure. For this structure to be valid, only one of the attributes can be -// defined. +// The configuration of destination parameter values. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type DestinationParameterValueConfiguration struct { // The configuration of custom values for destination parameter in @@ -5226,9 +5405,13 @@ type DonutCenterOptions struct { 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 ArcOptions *ArcOptions @@ -5239,9 +5422,10 @@ type DonutOptions struct { noSmithyDocumentSerde } -// The drill down filter for the column hierarchies. This is a union type -// structure. For this structure to be valid, only one of the attributes can be -// defined. +// The drill down filter for the column hierarchies. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type DrillDownFilter struct { // The category type drill down filter. This filter is used for string type @@ -5290,9 +5474,11 @@ type DynamicDefaultValue struct { noSmithyDocumentSerde } -// An empty visual. Empty visuals are used in layouts but have not been configured -// to show any data. A new visual created in the Amazon QuickSight console is -// considered an EmptyVisual until a visual type is selected. +// An empty visual. +// +// Empty visuals are used in layouts but have not been configured to show any +// data. A new visual created in the Amazon QuickSight console is considered an +// EmptyVisual until a visual type is selected. type EmptyVisual struct { // The data set that is used in the empty visual. Every visual requires a dataset @@ -5366,7 +5552,9 @@ type ExcludePeriodConfiguration struct { Granularity TimeGranularity // The status of the exclude period. Choose from the following options: + // // - ENABLED + // // - DISABLED Status WidgetStatus @@ -5430,7 +5618,9 @@ type FieldBasedTooltip struct { 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. TooltipTitleType TooltipTitleType @@ -5485,7 +5675,9 @@ type FieldSeriesItem struct { type FieldSort struct { // The sort direction. Choose one of the following options: + // // - ASC : Ascending + // // - DESC : Descending // // This member is required. @@ -5594,8 +5786,10 @@ type FilledMapConfiguration struct { noSmithyDocumentSerde } -// 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. +// 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 { // The aggregated field well of the filled map. @@ -5628,8 +5822,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Creating filled maps]: https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html type FilledMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -5660,14 +5857,17 @@ 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) - // in the Amazon QuickSight User Guide. + // A CategoryFilter filters text values. + // + // For more information, see [Adding text filters] in the Amazon QuickSight User Guide. + // + // [Adding text filters]: https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html CategoryFilter *CategoryFilter // A NumericEqualityFilter filters numeric values that equal or do not equal a @@ -5696,8 +5896,10 @@ type Filter struct { } // The control of a filter that is used to interact with a dashboard or an -// analysis. This is a union type structure. For this structure to be valid, only -// one of the attributes can be defined. +// analysis. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type FilterControl struct { // A control from a filter that is scoped across more than one sheet. This @@ -5774,7 +5976,9 @@ type FilterDateTimePickerControl struct { DisplayOptions *DateTimePickerControlDisplayOptions // 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 SheetControlDateTimePickerType @@ -5811,7 +6015,9 @@ type FilterDropDownControl struct { 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. Type SheetControlListType @@ -5819,14 +6025,18 @@ type FilterDropDownControl struct { } // 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. +// of visuals. +// +// For more information, see [Adding filter conditions (group filters) with AND and OR operators] in the Amazon QuickSight User Guide. +// +// [Adding filter conditions (group filters) with AND and OR operators]: https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html 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 // // This member is required. @@ -5843,8 +6053,9 @@ type FilterGroup struct { // 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 + // 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. @@ -5868,12 +6079,16 @@ type FilterListConfiguration struct { CategoryValues []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. NullOption FilterNullOption // Select all of the values. Null is not the assigned value of select all. + // // - FILTER_ALL_VALUES SelectAllOptions CategoryFilterSelectAllOptions @@ -5910,7 +6125,9 @@ type FilterListControl struct { SelectableValues *FilterSelectableValues // The type of the 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 @@ -5929,8 +6146,9 @@ type FilterOperation struct { noSmithyDocumentSerde } -// The configuration of selected fields in the CustomActionFilterOperation . 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 { @@ -5938,7 +6156,10 @@ type FilterOperationSelectedFieldsConfiguration struct { SelectedColumns []ColumnIdentifier // A structure that contains the options that choose which fields are filtered in - // the CustomActionFilterOperation . Valid values are defined as follows: + // the CustomActionFilterOperation . + // + // Valid values are defined as follows: + // // - ALL_FIELDS : Applies the filter operation to all fields. SelectedFieldOptions SelectedFieldOptions @@ -5948,9 +6169,10 @@ type FilterOperationSelectedFieldsConfiguration struct { noSmithyDocumentSerde } -// The configuration of 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 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 FilterOperationTargetVisualsConfiguration struct { // The configuration of the same-sheet target visuals that you want to be filtered. @@ -5983,8 +6205,10 @@ type FilterRelativeDateTimeControl struct { noSmithyDocumentSerde } -// 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. +// 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 { // The configuration that applies a filter to all sheets. When you choose AllSheets @@ -6046,7 +6270,9 @@ type FilterSliderControl struct { DisplayOptions *SliderControlDisplayOptions // The type of the 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 @@ -6151,24 +6377,33 @@ 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_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. @@ -6176,14 +6411,17 @@ type FolderSearchFilter 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, // "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 @@ -6297,7 +6535,9 @@ type ForecastComputation struct { // The seasonality setup of a forecast computation. Choose one of the following // options: + // // - AUTOMATIC + // // - CUSTOM : Checks the custom seasonality value. Seasonality ForecastComputationSeasonality @@ -6530,8 +6770,9 @@ type FunnelChartDataLabelOptions struct { // The color of the data label text. LabelColor *string - // The font configuration for the data labels. Only the FontSize attribute of the - // font configuration is used for data labels. + // The font configuration for the data labels. + // + // Only the FontSize attribute of the font configuration is used for data labels. LabelFontConfiguration *FontConfiguration // Determines the style of the metric labels. @@ -6550,9 +6791,10 @@ type FunnelChartDataLabelOptions struct { noSmithyDocumentSerde } -// 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. +// 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 . @@ -6573,8 +6815,11 @@ 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) -// in the Amazon QuickSight User Guide. +// A funnel chart. +// +// For more information, see [Using funnel charts] in the Amazon QuickSight User Guide. +// +// [Using funnel charts]: https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html type FunnelChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -6716,9 +6961,12 @@ 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. -type GaugeChartVisual struct { +// A gauge chart. +// +// For more information, see [Using gauge charts] in the Amazon QuickSight User Guide. +// +// [Using gauge charts]: https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html +type GaugeChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the // context of a dashboard, template, or analysis. Two dashboards, analyses, or @@ -6866,8 +7114,10 @@ type GeospatialMapConfiguration struct { noSmithyDocumentSerde } -// 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. +// 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 { // The aggregated field well for a geospatial map. @@ -6885,9 +7135,11 @@ type GeospatialMapStyleOptions struct { noSmithyDocumentSerde } -// A geospatial map or a points on map visual. For more information, see Creating -// point maps (https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) -// in the Amazon QuickSight User Guide. +// A geospatial map or a points on map visual. +// +// For more information, see [Creating point maps] in the Amazon QuickSight User Guide. +// +// [Creating point maps]: https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html type GeospatialMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -6989,9 +7241,10 @@ 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 -// designed, with options to fit to screen or view at actual size. +// 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 { // The elements that are included in a grid layout. @@ -7041,8 +7294,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 . // @@ -7211,8 +7466,10 @@ type HeatMapConfiguration struct { noSmithyDocumentSerde } -// The field well configuration of a heat map. 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 heat map. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type HeatMapFieldWells struct { // The aggregated field wells of a heat map. @@ -7240,8 +7497,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using heat maps]: https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html type HeatMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -7339,8 +7599,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using histograms]: https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html type HistogramVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -7502,8 +7765,11 @@ 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) -// in the Amazon QuickSight User Guide. +// An insight visual. +// +// For more information, see [Working with insights] in the Amazon QuickSight User Guide. +// +// [Working with insights]: https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html type InsightVisual struct { // The dataset that is used in the insight visual. @@ -7624,16 +7890,19 @@ type IntegerParameterDeclaration struct { noSmithyDocumentSerde } -// A parameter declaration for the Integer data type. This is a union type -// structure. For this structure to be valid, only one of the attributes can be -// defined. +// A parameter declaration for the Integer data type. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. 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. ValueWhenUnsetOption ValueWhenUnsetOption @@ -7648,7 +7917,9 @@ type ItemsLimitConfiguration struct { ItemsLimit *int64 // The Show other of an axis in the chart. Choose one of the following options: + // // - INCLUDE + // // - EXCLUDE OtherCategories OtherCategories @@ -7879,8 +8150,11 @@ type KPISparklineOptions 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] in the Amazon QuickSight User Guide. +// +// [Using KPIs]: https://docs.aws.amazon.com/quicksight/latest/user/kpi.html type KPIVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -7946,10 +8220,14 @@ 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] 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. +// +// [Types of layout]: https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html type Layout struct { // The configuration that determines what the type of layout for a sheet. @@ -7961,8 +8239,10 @@ type Layout struct { } // The configuration that determines what the type of layout will be used on a -// sheet. This is a union type structure. For this structure to be valid, only one -// of the attributes can be defined. +// sheet. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type LayoutConfiguration struct { // A free-form is optimized for a fixed width and has more control over the exact @@ -7991,9 +8271,13 @@ type LegendOptions struct { Height *string // The positions for the legend. Choose one of the following options: + // // - AUTO + // // - RIGHT + // // - BOTTOM + // // - LEFT Position LegendPosition @@ -8128,14 +8412,20 @@ type LineChartFieldWells struct { 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. 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. LineStyle LineChartLineStyle @@ -8155,10 +8445,15 @@ type LineChartMarkerStyleSettings struct { 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. MarkerShape LineChartMarkerShape @@ -8204,8 +8499,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using line charts]: https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html type LineChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -8352,8 +8650,10 @@ type LogicalTableSource struct { noSmithyDocumentSerde } -// The text format for a subtitle. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The text format for a subtitle. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type LongFormatText struct { // Plain text format. @@ -8467,7 +8767,9 @@ type MaximumMinimumComputation struct { ComputationId *string // The type of computation. Choose one of the following options: + // // - MAXIMUM: A maximum computation. + // // - MINIMUM: A minimum computation. // // This member is required. @@ -8553,9 +8855,12 @@ 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. TreatmentOption MissingDataTreatmentOption @@ -8772,16 +9077,27 @@ 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. SimpleNumericalAggregation SimpleNumericalAggregationFunction @@ -8880,8 +9196,11 @@ 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. // // This member is required. @@ -8898,6 +9217,7 @@ type NumericEqualityFilter struct { ParameterName *string // Select all of the values. Null is not the assigned value of select all. + // // - FILTER_ALL_VALUES SelectAllOptions NumericFilterSelectAllOptions @@ -8907,9 +9227,10 @@ type NumericEqualityFilter struct { noSmithyDocumentSerde } -// The options that determine the numeric format configuration. This is a union -// type structure. For this structure to be valid, only one of the attributes can -// be defined. +// The options that determine the numeric format configuration. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type NumericFormatConfiguration struct { // The options that determine the currency display format configuration. @@ -8939,8 +9260,11 @@ type NumericRangeFilter struct { 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. // // This member is required. @@ -8968,6 +9292,7 @@ type NumericRangeFilter struct { RangeMinimum *NumericRangeFilterValue // Select all of the values. Null is not the assigned value of select all. + // // - FILTER_ALL_VALUES SelectAllOptions NumericFilterSelectAllOptions @@ -9122,8 +9447,10 @@ type PanelTitleOptions struct { } // The control of a parameter that users can interact with in a dashboard or an -// analysis. This is a union type structure. For this structure to be valid, only -// one of the attributes can be defined. +// analysis. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type ParameterControl struct { // A control from a date parameter that specifies date and time. @@ -9174,10 +9501,14 @@ type ParameterDateTimePickerControl struct { noSmithyDocumentSerde } -// 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 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. +// The declaration definition of a parameter. +// +// For more information, see [Parameters in Amazon QuickSight] 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. +// +// [Parameters in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html type ParameterDeclaration struct { // A parameter declaration for the DateTime data type. @@ -9465,7 +9796,9 @@ 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. PeriodTimeGranularity TimeGranularity @@ -9576,8 +9909,10 @@ 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. @@ -9604,16 +9939,23 @@ type PieChartSortConfiguration struct { noSmithyDocumentSerde } -// 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: +// 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 // -// 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. +// For more information, see [Using pie charts] in the Amazon QuickSight User Guide. +// +// For more information, see [Using donut charts] in the Amazon QuickSight User Guide. +// +// [Using pie charts]: https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html +// [Using donut charts]: https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html type PieChartVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -9772,7 +10114,9 @@ type PivotTableFieldCollapseStateOption struct { // The state of the field target of a pivot table. Choose one of the following // options: + // // - COLLAPSED + // // - EXPANDED State PivotTableFieldCollapseState @@ -9832,8 +10176,10 @@ type PivotTableFieldSubtotalOptions struct { noSmithyDocumentSerde } -// The field wells for a pivot table visual. This is a union type structure. For -// this structure to be valid, only one of the attributes can be defined. +// The field wells for a pivot table visual. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type PivotTableFieldWells struct { // The aggregated field well for the pivot table. @@ -9880,7 +10226,9 @@ type PivotTableOptions struct { // The layout for the row dimension headers of a pivot table. Choose one of the // following options. + // // - TABULAR : (Default) Each row field is displayed in a separate column. + // // - HIERARCHY : All row fields are displayed in a single column. Indentation is // used to differentiate row headers of different fields. RowsLayout PivotTableRowsLayout @@ -9962,8 +10310,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using pivot tables]: https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html type PivotTableVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -10303,8 +10654,9 @@ type RdsParameters struct { // A structure that grants Amazon QuickSight access to your cluster and make a // call to the redshift:GetClusterCredentials API. For more information on the -// redshift:GetClusterCredentials API, see GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html) -// . +// redshift:GetClusterCredentials API, see [GetClusterCredentials]GetClusterCredentials . +// +// [GetClusterCredentials]: https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html type RedshiftIAMParameters struct { // The user whose permissions and group memberships will be used by Amazon @@ -10357,15 +10709,16 @@ type RedshiftParameters struct { Host *string // An optional parameter that uses IAM authentication to grant Amazon QuickSight - // access to your cluster. This parameter can be used instead of - // DataSourceCredentials (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html) - // . + // access to your cluster. This parameter can be used instead of [DataSourceCredentials]. + // + // [DataSourceCredentials]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html IAMParameters *RedshiftIAMParameters // An optional parameter that configures IAM Identity Center authentication to - // grant Amazon QuickSight access to your cluster. This parameter can only be - // specified if your Amazon QuickSight account is configured with IAM Identity - // Center. + // grant Amazon QuickSight access to your cluster. + // + // This parameter can only be specified if your Amazon QuickSight account is + // configured with IAM Identity Center. IdentityCenterConfiguration *IdentityCenterConfiguration // Port. This field can be blank if the ClusterId is provided. @@ -10386,7 +10739,9 @@ type ReferenceLine struct { LabelConfiguration *ReferenceLineLabelConfiguration // The status of the reference line. Choose one of the following options: + // // - ENABLE + // // - DISABLE Status WidgetStatus @@ -10412,7 +10767,9 @@ type ReferenceLineDataConfiguration struct { // The axis binding type of the reference line. Choose one of the following // options: + // // - PrimaryY + // // - SecondaryY AxisBinding AxisBinding @@ -10421,7 +10778,9 @@ type ReferenceLineDataConfiguration struct { // The series type of the reference line data configuration. Choose one of the // following options: + // // - BAR + // // - LINE SeriesType ReferenceLineSeriesType @@ -10464,8 +10823,11 @@ type ReferenceLineLabelConfiguration struct { // The horizontal position configuration of the label in a reference line. Choose // one of the following options: + // // - LEFT + // // - CENTER + // // - RIGHT HorizontalPosition ReferenceLineLabelHorizontalPosition @@ -10474,7 +10836,9 @@ type ReferenceLineLabelConfiguration struct { // The vertical position configuration of the label in a reference line. Choose // one of the following options: + // // - ABOVE + // // - BELOW VerticalPosition ReferenceLineLabelVerticalPosition @@ -10499,8 +10863,11 @@ type ReferenceLineStyleConfiguration struct { Color *string // The pattern type of the line style. Choose one of the following options: + // // - SOLID + // // - DASHED + // // - DOTTED Pattern ReferenceLinePatternType @@ -10514,7 +10881,9 @@ type ReferenceLineValueLabelConfiguration struct { FormatConfiguration *NumericFormatConfiguration // The relative position of the value label. Choose one of the following options: + // // - BEFORE_CUSTOM_LABEL + // // - AFTER_CUSTOM_LABEL RelativePosition ReferenceLineValueLabelRelativePosition @@ -10536,16 +10905,22 @@ 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. // // This member is required. @@ -10570,12 +10945,16 @@ 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) - // in the Amazon QuickSight User Guide. + // + // For more information on full and incremental refreshes, see [Refreshing SPICE data] in the Amazon + // QuickSight User Guide. + // + // [Refreshing SPICE data]: https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html // // This member is required. RefreshType IngestionType @@ -10614,9 +10993,10 @@ type RegisteredUserDashboardEmbeddingConfiguration struct { // The dashboard ID for the dashboard that you want the user to see first. This ID // is included in the output URL. When the URL in response is accessed, Amazon - // QuickSight renders this dashboard if the user has permissions to view it. If the - // user does not have permission to view this dashboard, they see a permissions - // error message. + // QuickSight renders this dashboard if the user has permissions to view it. + // + // If the user does not have permission to view this dashboard, they see a + // permissions error message. // // This member is required. InitialDashboardId *string @@ -10645,9 +11025,11 @@ 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 . + // 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 . // // This member is required. InitialDashboardVisualId *DashboardVisualId @@ -10656,9 +11038,11 @@ 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. +// 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. type RegisteredUserEmbeddingExperienceConfiguration struct { // The configuration details for providing a dashboard embedding experience. @@ -10667,38 +11051,49 @@ type RegisteredUserEmbeddingExperienceConfiguration struct { // The type of embedding experience. In this case, Amazon QuickSight visuals. DashboardVisual *RegisteredUserDashboardVisualEmbeddingConfiguration - // The configuration details for embedding the Generative Q&A experience. For more - // information about embedding the Generative Q&A experience, see Embedding - // Overview (https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) - // in the Amazon QuickSight User Guide. + // The configuration details for embedding the Generative Q&A experience. + // + // For more information about embedding the Generative Q&A experience, see [Embedding Overview] in the + // Amazon QuickSight User Guide. + // + // [Embedding Overview]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html GenerativeQnA *RegisteredUserGenerativeQnAEmbeddingConfiguration - // 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. + // The configuration details for embedding the Q search bar. + // + // For more information about embedding the Q search bar, see [Embedding Overview] in the Amazon + // QuickSight User Guide. + // + // [Embedding Overview]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html 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) - // 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) + // access to certain features. For more information, see [Customizing Access to the Amazon QuickSight Console]in the Amazon QuickSight + // User Guide. + // + // Use [GenerateEmbedUrlForRegisteredUser] 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]API operation. Use the [RegisterUser] // 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) + // + // [Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users] + // + // [Customizing Access to the Amazon QuickSight Console] + // // 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) - // . + // interactive demo of the ways you can customize embedding, visit the [Amazon QuickSight Developer Portal]. + // + // [Customizing Access to the Amazon QuickSight Console]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html + // [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 + // [UpdateUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html + // [GenerateEmbedUrlForRegisteredUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html + // [RegisterUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html QuickSightConsole *RegisteredUserQuickSightConsoleEmbeddingConfiguration noSmithyDocumentSerde @@ -10711,12 +11106,13 @@ type RegisteredUserGenerativeQnAEmbeddingConfiguration struct { // The ID of the new Q reader experience topic that you want to make the starting // topic in the Generative Q&A experience. You can find a topic ID by navigating to // the Topics pane in the Amazon QuickSight application and opening a topic. The ID - // is in the URL for the topic that you open. If you don't specify an initial topic - // or you specify a legacy topic, a list of all shared new reader experience topics - // is shown in the Generative Q&A experience for your readers. When you select an - // initial new reader experience topic, you can specify whether or not readers are - // allowed to select other new reader experience topics from the available ones in - // the list. + // is in the URL for the topic that you open. + // + // If you don't specify an initial topic or you specify a legacy topic, a list of + // all shared new reader experience topics is shown in the Generative Q&A + // experience for your readers. When you select an initial new reader experience + // topic, you can specify whether or not readers are allowed to select other new + // reader experience topics from the available ones in the list. InitialTopicId *string noSmithyDocumentSerde @@ -10727,13 +11123,15 @@ type RegisteredUserQSearchBarEmbeddingConfiguration struct { // The ID of the legacy Q topic that you want to use as the starting topic in the // Q search bar. To locate the topic ID of the topic that you want to use, open the - // Amazon QuickSight console (https://quicksight.aws.amazon.com/) , navigate to the - // Topics pane, and choose thre topic that you want to use. The TopicID is located - // in the URL of the topic that opens. When you select an initial topic, you can - // specify whether or not readers are allowed to select other topics from the list - // of available topics. If you don't specify an initial topic or if you specify a - // new reader experience topic, a list of all shared legacy topics is shown in the - // Q bar. + // [Amazon QuickSight console], navigate to the Topics pane, and choose thre topic that you want to use. The + // TopicID is located in the URL of the topic that opens. When you select an + // initial topic, you can specify whether or not readers are allowed to select + // other topics from the list of available topics. + // + // If you don't specify an initial topic or if you specify a new reader experience + // topic, a list of all shared legacy topics is shown in the Q bar. + // + // [Amazon QuickSight console]: https://quicksight.aws.amazon.com/ InitialTopicId *string noSmithyDocumentSerde @@ -10745,14 +11143,21 @@ 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: + // 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 @@ -10807,18 +11212,26 @@ type RelativeDatesFilter struct { 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. // // This member is required. NullOption FilterNullOption // The range date type of the filter. Choose one of the options below: + // // - PREVIOUS + // // - THIS + // // - LAST + // // - NOW + // // - NEXT // // This member is required. @@ -10889,10 +11302,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.) @@ -10949,9 +11365,12 @@ 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) -// in the Amazon QuickSight User Guide. The option to deny permissions by setting -// PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets. +// information, see [Using Row-Level Security (RLS) to Restrict Access to a Dataset]in the Amazon QuickSight User Guide. +// +// The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is +// not supported for new RLS datasets. +// +// [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 type RowLevelPermissionDataSet struct { // The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS. @@ -10966,9 +11385,11 @@ 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. @@ -11081,8 +11502,10 @@ type S3Source struct { // This member is required. DataSourceArn *string - // A physical table type for an S3 data source. For files that aren't JSON, only - // STRING data types are supported in input columns. + // A physical table type for an S3 data source. + // + // For files that aren't JSON, only STRING data types are supported in input + // columns. // // This member is required. InputColumns []InputColumn @@ -11093,13 +11516,16 @@ 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: + // 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. TargetVisualOptions TargetVisualOptions @@ -11168,8 +11594,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using Sankey diagrams]: https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html type SankeyDiagramVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -11206,10 +11635,14 @@ type ScatterPlotCategoricallyAggregatedFieldWells struct { // The size field well of a scatter plot. Size []MeasureField - // The x-axis field well of a scatter plot. The x-axis is aggregated by category. + // The x-axis field well of a scatter plot. + // + // The x-axis is aggregated by category. XAxis []MeasureField - // The y-axis field well of a scatter plot. The y-axis is aggregated by category. + // The y-axis field well of a scatter plot. + // + // The y-axis is aggregated by category. YAxis []MeasureField noSmithyDocumentSerde @@ -11258,8 +11691,10 @@ type ScatterPlotConfiguration struct { noSmithyDocumentSerde } -// The field well configuration of a scatter plot. 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 scatter plot. +// +// This is a union type structure. 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. The x and y-axes of scatter plots @@ -11294,19 +11729,24 @@ type ScatterPlotUnaggregatedFieldWells struct { // The size field well of a scatter plot. Size []MeasureField - // The x-axis field well of a scatter plot. The x-axis is a dimension field and - // cannot be aggregated. + // The x-axis field well of a scatter plot. + // + // The x-axis is a dimension field and cannot be aggregated. XAxis []DimensionField - // The y-axis field well of a scatter plot. The y-axis is a dimension field and - // cannot be aggregated. + // The y-axis field well of a scatter plot. + // + // The y-axis is a dimension field and cannot be aggregated. YAxis []DimensionField 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] in the Amazon QuickSight User Guide. +// +// [Using scatter plots]: https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html type ScatterPlotVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -11421,7 +11861,9 @@ type SectionBasedLayoutPaperCanvasSizeOptions struct { // The paper orientation that is used to define canvas dimensions. Choose one of // the following options: + // // - PORTRAIT + // // - LANDSCAPE PaperOrientation PaperOrientation @@ -11454,11 +11896,14 @@ type SectionPageBreakConfiguration struct { // The options that style a section. type SectionStyle struct { - // The height of a section. Heights can only be defined for header and footer - // sections. The default height margin is 0.5 inches. + // The height of a section. + // + // Heights can only be defined for header and footer sections. The default height + // margin is 0.5 inches. Height *string // The spacing between section content and its top, bottom, left, and right edges. + // // There is no padding by default. Padding *Spacing @@ -11467,8 +11912,10 @@ type SectionStyle struct { // The configuration for applying a filter to specific sheets or visuals. You can // apply this filter to multiple visuals that are on one sheet or to all visuals on -// a sheet. This is a union type structure. For this structure to be valid, only -// one of the attributes can be defined. +// a sheet. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type SelectedSheetsFilterScopeConfiguration struct { // The sheet ID and visual IDs of the sheet and visuals that the filter is applied @@ -11520,8 +11967,10 @@ type SemanticType struct { noSmithyDocumentSerde } -// The series item configuration of a line chart. This is a union type structure. -// For this structure to be valid, only one of the attributes can be defined. +// The series item configuration of a line chart. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type SeriesItem struct { // The data field series item configuration of a line chart. @@ -11568,9 +12017,10 @@ type SetParameterValueConfiguration struct { // This member is required. DestinationParameterName *string - // The configuration of destination parameter values. This is a union type - // structure. For this structure to be valid, only one of the attributes can be - // defined. + // The configuration of destination parameter values. + // + // This is a union type structure. For this structure to be valid, only one of the + // attributes can be defined. // // This member is required. Value *DestinationParameterValueConfiguration @@ -11610,7 +12060,7 @@ type Sheet struct { // A control to display info icons for filters and parameters. type SheetControlInfoIconLabelOptions struct { - // The text content of info icon. + // The text content of info icon. InfoIconText *string // The visibility configuration of info icon label options. @@ -11662,30 +12112,38 @@ 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. 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. + // The list of filter controls that are on a sheet. + // + // For more information, see [Adding filter controls to analysis sheets] in the Amazon QuickSight User Guide. + // + // [Adding filter controls to analysis sheets]: https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html 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] in the Amazon QuickSight User Guide. + // + // [Types of layout]: https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html Layouts []Layout // The name of the sheet. This name is displayed on the sheet's tab in the Amazon // QuickSight console. 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. + // The list of parameter controls that are on a sheet. + // + // For more information, see [Using a Control with a Parameter in Amazon QuickSight] 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 ParameterControls []ParameterControl // The control layouts of the sheet. @@ -11709,7 +12167,9 @@ type SheetElementConfigurationOverrides struct { // Determines whether or not the overrides are visible. Choose one of the // following options: + // // - VISIBLE + // // - HIDDEN Visibility Visibility @@ -11773,7 +12233,9 @@ type SheetTextBox struct { type SheetVisualScopingConfiguration struct { // The scope of the applied entities. Choose one of the following options: + // // - ALL_VISUALS + // // - SELECTED_VISUALS // // This member is required. @@ -11790,8 +12252,10 @@ type SheetVisualScopingConfiguration struct { noSmithyDocumentSerde } -// The text format for the title. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The text format for the title. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type ShortFormatText struct { // Plain text format. @@ -11874,13 +12338,17 @@ type SmallMultiplesAxisProperties 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 - // in the grid to fit the overall layout and size of the given chart. + // 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 - // rows in the grid to fit the overall layout and size of the given chart. + // 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 // Configures the display options for each small multiples panel. @@ -11901,11 +12369,13 @@ type SnapshotAnonymousUser struct { // The tags to be used for row-level security (RLS). Make sure that the relevant // datasets have RLS tags configured before you start a snapshot export job. You // can configure the RLS tags of a dataset with a - // DataSet$RowLevelPermissionTagConfiguration API call. These are not the tags that - // are used for Amazon Web Services resource tagging. For more information on row - // level security in Amazon QuickSight, 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. + // DataSet$RowLevelPermissionTagConfiguration API call. + // + // These are not the tags that are used for Amazon Web Services resource tagging. + // For more information on row level security in Amazon QuickSight, see [Using Row-Level Security (RLS) with Tags]in the + // Amazon QuickSight User Guide. + // + // [Using Row-Level Security (RLS) with Tags]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html RowLevelPermissionTags []SessionTag noSmithyDocumentSerde @@ -11945,7 +12415,7 @@ type SnapshotConfiguration struct { // generated snapshot. type SnapshotDestinationConfiguration struct { - // A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 + // A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 // destination configurations. This structure can hold a maximum of 1 // S3DestinationConfiguration . S3Destinations []SnapshotS3DestinationConfiguration @@ -11992,8 +12462,10 @@ type SnapshotFileSheetSelection struct { // The selection scope of the visuals on a sheet of a dashboard that you are // generating a snapthot of. You can choose one of the following options. + // // - ALL_VISUALS - Selects all visuals that are on the sheet. This value is // required if the snapshot is a PDF. + // // - SELECTED_VISUALS - Select the visual that you want to add to the snapshot. // This value is required if the snapshot is a CSV or Excel workbook. // @@ -12006,7 +12478,7 @@ type SnapshotFileSheetSelection struct { // This member is required. SheetId *string - // A structure that lists the IDs of the visuals in the selected sheet. Supported + // A structure that lists the IDs of the visuals in the selected sheet. Supported // visual types are table, pivot table visuals. This value is required if you are // generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID // for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are @@ -12035,7 +12507,7 @@ type SnapshotJobErrorInfo struct { // the generated file. type SnapshotJobResult struct { - // A list of AnonymousUserSnapshotJobResult objects that contain information on + // A list of AnonymousUserSnapshotJobResult objects that contain information on // anonymous users and their user configurations. This data provided by you when // you make a StartDashboardSnapshotJob API call. AnonymousUsers []AnonymousUserSnapshotJobResult @@ -12058,10 +12530,10 @@ type SnapshotJobResultErrorInfo struct { // A structure that contains information on the generated snapshot file groups. type SnapshotJobResultFileGroup struct { - // A list of SnapshotFile objects. + // A list of SnapshotFile objects. Files []SnapshotFile - // A list of SnapshotJobS3Result objects. + // A list of SnapshotJobS3Result objects. S3Results []SnapshotJobS3Result noSmithyDocumentSerde @@ -12114,7 +12586,7 @@ type SnapshotUserConfiguration struct { // snapshot is generated for. Sensitive user information is excluded. type SnapshotUserConfigurationRedacted struct { - // An array of records that describe anonymous users that the dashboard snapshot + // An array of records that describe anonymous users that the dashboard snapshot // is generated for. Sensitive user information is excluded. AnonymousUsers []SnapshotAnonymousUserRedacted @@ -12355,7 +12827,9 @@ type StringValueWhenUnsetConfiguration struct { 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. ValueWhenUnsetOption ValueWhenUnsetOption @@ -12640,8 +13114,10 @@ type TableFieldURLConfiguration struct { noSmithyDocumentSerde } -// The field wells for a table visual. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The field wells for a table visual. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type TableFieldWells struct { // The aggregated field well for the table. @@ -12772,8 +13248,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using tables as visuals]: https://docs.aws.amazon.com/quicksight/latest/user/tabular.html type TableVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -12826,8 +13305,9 @@ 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 @@ -12840,10 +13320,11 @@ type TagColumnOperation struct { // create a dashboard. A template adds a layer of abstraction by using placeholders // to replace the dataset associated with an analysis. You can use templates to // create dashboards by replacing dataset placeholders with datasets that follow -// the same schema that was used to create the source analysis and template. You -// can share templates across Amazon Web Services accounts by allowing users in -// other Amazon Web Services accounts to create a template or a dashboard from an -// existing template. +// the same schema that was used to create the source analysis and template. +// +// You can share templates across Amazon Web Services accounts by allowing users +// in other Amazon Web Services accounts to create a template or a dashboard from +// an existing template. type Template struct { // The Amazon Resource Name (ARN) of the template. @@ -12989,12 +13470,19 @@ 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 Status ResourceStatus @@ -13022,21 +13510,28 @@ type TemplateVersionDefinition struct { // An array of calculated field definitions for the template. CalculatedFields []CalculatedField - // An array of template-level column configurations. Column configurations are + // 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) - // in the Amazon QuickSight User Guide. + // Filter definitions for a template. + // + // For more information, see [Filtering Data] in the Amazon QuickSight User Guide. + // + // [Filtering Data]: https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html FilterGroups []FilterGroup // An array of option definitions for a template. Options *AssetOptions - // 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) - // in the Amazon QuickSight User Guide. + // 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] in the Amazon QuickSight User Guide. + // + // [Parameters in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html ParameterDeclarations []ParameterDeclaration // An array of sheet definitions for a template. @@ -13343,7 +13838,9 @@ 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. Seasonality *int32 @@ -13371,19 +13868,22 @@ type TimeEqualityFilter struct { // filters that are scoped to multiple sheets. DefaultFilterControlConfiguration *DefaultFilterControlConfiguration - // The parameter whose value should be used for the filter value. This field is - // mutually exclusive to Value and RollingDate . + // The parameter whose value should be used for the filter value. + // + // This field is mutually exclusive to Value and RollingDate . ParameterName *string - // The rolling date input for the TimeEquality filter. This field is mutually - // exclusive to Value and ParameterName . + // The rolling date input for the TimeEquality filter. + // + // This field is mutually exclusive to Value and ParameterName . RollingDate *RollingDateConfiguration // 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 - // RollingDate and ParameterName . + // The value of a TimeEquality filter. + // + // This field is mutually exclusive to RollingDate and ParameterName . Value *time.Time noSmithyDocumentSerde @@ -13430,8 +13930,11 @@ type TimeRangeFilter struct { 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. // // This member is required. @@ -13464,8 +13967,10 @@ type TimeRangeFilter struct { noSmithyDocumentSerde } -// The value of a time range filter. This is a union type structure. For this -// structure to be valid, only one of the attributes can be defined. +// The value of a time range filter. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type TimeRangeFilterValue struct { // The parameter type input value. @@ -13480,8 +13985,10 @@ type TimeRangeFilterValue struct { noSmithyDocumentSerde } -// The tooltip. This is a union type structure. For this structure to be valid, -// only one of the attributes can be defined. +// The tooltip. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type TooltipItem struct { // The tooltip item for the columns that are not part of a field well. @@ -13501,7 +14008,9 @@ 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. SelectedTooltipType SelectedTooltipType @@ -13555,7 +14064,9 @@ type TopBottomMoversComputation struct { ComputationId *string // The computation type. Choose from the following options: + // // - TOP: Top movers computation. + // // - BOTTOM: Bottom movers computation. // // This member is required. @@ -13591,7 +14102,9 @@ type TopBottomRankedComputation struct { ComputationId *string // The computation type. Choose one of the following options: + // // - TOP: A top ranked computation. + // // - BOTTOM: A bottom ranked computation. // // This member is required. @@ -14273,8 +14786,10 @@ type TreeMapConfiguration struct { noSmithyDocumentSerde } -// The field wells of a tree map. 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 tree map. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type TreeMapFieldWells struct { // The aggregated field wells of a tree map. @@ -14295,8 +14810,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using tree maps]: https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html type TreeMapVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -14382,8 +14900,9 @@ 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) -// in the Amazon QuickSight User Guide. +// information, see [Using Themes in Amazon QuickSight]in the Amazon QuickSight User Guide. +// +// [Using Themes in Amazon QuickSight]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html type UIColorPalette struct { // This color is that applies to selected states and buttons. @@ -14540,8 +15059,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. + // + // - COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. + // // - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. ExternalLoginFederationProviderType *string @@ -14559,21 +15079,29 @@ 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. + // // - READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. // Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, // and can generate executive summaries from dashboards. + // // - AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. // Author Pros can author dashboards with natural language with Amazon Q, build // stories with Amazon Q, create Topics for Q&A, and generate executive summaries // from dashboards. + // // - ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight // administrative settings. Admin Pro users are billed at Author Pro pricing. + // // - RESTRICTED_READER : This role isn't currently available for use. + // // - RESTRICTED_AUTHOR : This role isn't currently available for use. Role UserRole @@ -14610,102 +15138,167 @@ type VisibleRangeOptions struct { noSmithyDocumentSerde } -// A visual displayed on a sheet in an analysis, dashboard, or template. This is a -// union type structure. For this structure to be valid, only one of the attributes -// can be defined. +// A visual displayed on a sheet in an analysis, dashboard, or template. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes 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] in the Amazon QuickSight User Guide. + // + // [Using bar charts]: https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html 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] in the Amazon QuickSight User Guide. + // + // [Using box plots]: https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html 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] in the Amazon QuickSight User Guide. + // + // [Using combo charts]: https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html 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) - // in the Amazon QuickSight User Guide. + // A visual that contains custom content. + // + // For more information, see [Using custom visual content] in the Amazon QuickSight User Guide. + // + // [Using custom visual content]: https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html 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] in the Amazon QuickSight User Guide. + // + // [Creating filled maps]: https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html FilledMapVisual *FilledMapVisual - // 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. + // A funnel chart. + // + // For more information, see [Using funnel charts] in the Amazon QuickSight User Guide. + // + // [Using funnel charts]: https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html 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] in the Amazon QuickSight User Guide. + // + // [Using gauge charts]: https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html GaugeChartVisual *GaugeChartVisual - // A geospatial map or a points on map visual. For more information, see Creating - // point maps (https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) - // in the Amazon QuickSight User Guide. + // A geospatial map or a points on map visual. + // + // For more information, see [Creating point maps] in the Amazon QuickSight User Guide. + // + // [Creating point maps]: https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html 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] in the Amazon QuickSight User Guide. + // + // [Using heat maps]: https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html 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] in the Amazon QuickSight User Guide. + // + // [Using histograms]: https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html HistogramVisual *HistogramVisual - // 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. + // An insight visual. + // + // For more information, see [Working with insights] in the Amazon QuickSight User Guide. + // + // [Working with insights]: https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html 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] in the Amazon QuickSight User Guide. + // + // [Using KPIs]: https://docs.aws.amazon.com/quicksight/latest/user/kpi.html 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] in the Amazon QuickSight User Guide. + // + // [Using line charts]: https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html 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] in the Amazon QuickSight User Guide. + // + // [Using pie charts]: https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html 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] in the Amazon QuickSight User Guide. + // + // [Using pivot tables]: https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html 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] in the Amazon QuickSight User Guide. + // + // [Using radar charts]: https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html 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] in the Amazon QuickSight User Guide. + // + // [Using Sankey diagrams]: https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html 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] in the Amazon QuickSight User Guide. + // + // [Using scatter plots]: https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html 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] in the Amazon QuickSight User Guide. + // + // [Using tables as visuals]: https://docs.aws.amazon.com/quicksight/latest/user/tabular.html 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] in the Amazon QuickSight User Guide. + // + // [Using tree maps]: https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html 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] in the Amazon QuickSight User Guide. + // + // [Using waterfall charts]: https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html 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] in the Amazon QuickSight User Guide. + // + // [Using word clouds]: https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html WordCloudVisual *WordCloudVisual noSmithyDocumentSerde @@ -14723,8 +15316,10 @@ 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 @@ -14739,9 +15334,13 @@ type VisualCustomAction struct { // This member is required. Name *string - // The trigger of the VisualCustomAction . Valid values are defined as follows: + // 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. // @@ -14754,9 +15353,10 @@ type VisualCustomAction struct { noSmithyDocumentSerde } -// The operation that is defined by the custom action. This is a union type -// structure. For this structure to be valid, only one of the attributes can be -// defined. +// The operation that is defined by the custom action. +// +// This is a union type structure. For this structure to be valid, only one of the +// attributes can be defined. type VisualCustomActionOperation struct { // The filter operation that filters data included in a visual or in an entire @@ -15043,8 +15643,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using waterfall charts]: https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html type WaterfallVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -15144,8 +15747,10 @@ 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. @@ -15193,8 +15798,11 @@ 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] in the Amazon QuickSight User Guide. +// +// [Using word clouds]: https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html type WordCloudVisual struct { // The unique identifier of a visual. This identifier must be unique within the @@ -15225,8 +15833,10 @@ type WordCloudVisual struct { // The options that are available for a single Y axis in a chart. type YAxisOptions struct { - // The Y axis type to be used in the chart. If you choose PRIMARY_Y_AXIS , the - // primary Y Axis is located on the leftmost vertical axis of the chart. + // The Y axis type to be used in the chart. + // + // If you choose PRIMARY_Y_AXIS , the primary Y Axis is located on the leftmost + // vertical axis of the chart. // // This member is required. YAxis SingleYAxisOption diff --git a/service/ram/api_op_AcceptResourceShareInvitation.go b/service/ram/api_op_AcceptResourceShareInvitation.go index 3368bd200b8..f935945b0c7 100644 --- a/service/ram/api_op_AcceptResourceShareInvitation.go +++ b/service/ram/api_op_AcceptResourceShareInvitation.go @@ -32,8 +32,9 @@ func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *Acce type AcceptResourceShareInvitationInput struct { - // The Amazon Resource 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 Resource Name (ARN)] of the invitation that you want to accept. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareInvitationArn *string @@ -42,10 +43,15 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_AssociateResourceShare.go b/service/ram/api_op_AssociateResourceShare.go index ac80425c53e..8396a5b7c4b 100644 --- a/service/ram/api_op_AssociateResourceShare.go +++ b/service/ram/api_op_AssociateResourceShare.go @@ -32,8 +32,10 @@ func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateRe type AssociateResourceShareInput struct { - // Specifies the Amazon Resource 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 Resource Name (ARN)] of the resource share that you want to add principals or + // resources to. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string @@ -42,33 +44,48 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier 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 - // the following values: + // 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 the following values: + // // - An Amazon Web Services account ID, for example: 123456789012 - // - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of an organization in Organizations, for example: + // + // - An [Amazon Resource Name (ARN)]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. + // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types 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)] of the resources that you want to share. This can be null + // if you want to add only principals. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // Specifies from which source accounts the service principal has access to the diff --git a/service/ram/api_op_AssociateResourceSharePermission.go b/service/ram/api_op_AssociateResourceSharePermission.go index b421174980a..27106be63ad 100644 --- a/service/ram/api_op_AssociateResourceSharePermission.go +++ b/service/ram/api_op_AssociateResourceSharePermission.go @@ -31,18 +31,21 @@ func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *A type AssociateResourceSharePermissionInput struct { - // Specifies the Amazon Resource 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. + // Specifies the [Amazon Resource Name (ARN)] of the RAM permission to associate with the resource share. To + // find the ARN for a permission, use either the ListPermissionsoperation or go to the [Permissions library] page in + // the RAM console and then choose the name of the permission. The ARN is displayed + // on the detail page. + // + // [Permissions library]: https://console.aws.amazon.com/ram/home#Permissions: + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string - // Specifies the Amazon Resource 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 Resource Name (ARN)] of the resource share to which you want to add or replace + // permissions. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string @@ -51,29 +54,37 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies the version of the RAM permission to associate with the resource // share. You can specify only the version that is currently set as the default // version for the permission. If you also set the replace pararameter to true , // then this operation updates an outdated version of the permission to the current - // default version. You don't need to specify this parameter because the default - // behavior is to use the version that is currently set as the default version for - // the permission. This parameter is supported for backwards compatibility. + // default version. + // + // You don't need to specify this parameter because the default behavior is to use + // the version that is currently set as the default version for the permission. + // This parameter is supported for backwards compatibility. PermissionVersion *int32 // Specifies whether the specified permission should replace the existing // permission associated with the resource share. Use true to replace the current // permissions. Use false to add the permission to a resource share that currently - // doesn't have a 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. + // doesn't have a 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. Replace *bool noSmithyDocumentSerde diff --git a/service/ram/api_op_CreatePermission.go b/service/ram/api_op_CreatePermission.go index 5c32b0f50be..f80d28e313f 100644 --- a/service/ram/api_op_CreatePermission.go +++ b/service/ram/api_op_CreatePermission.go @@ -39,30 +39,37 @@ type CreatePermissionInput struct { // A string in JSON format string that contains the following elements of a // resource-based policy: + // // - Effect: must be set to ALLOW . + // // - Action: specifies the actions that are allowed by this customer managed // permission. The list must contain only actions that are supported by the // specified resource type. For a list of all actions supported by each resource - // type, 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 Identity and Access Management User Guide. + // type, see [Actions, resources, and condition keys for Amazon Web Services services]in the Identity and Access Management User Guide. + // // - Condition: (optional) specifies conditional parameters that must evaluate // to true when a user attempts an action for that action to be allowed. For more - // information about the Condition element, see IAM policies: Condition element (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) - // in the Identity and Access Management User Guide. + // information about the Condition element, see [IAM policies: Condition element]in the Identity and Access + // Management User Guide. + // // This template can't include either the Resource or Principal elements. Those // are both filled in by RAM when it instantiates the resource-based policy on each // resource shared using this managed permission. The Resource comes from the ARN // of the specific resource that you are sharing. The Principal comes from the // list of identities added to the resource share. // + // [IAM policies: Condition element]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html + // [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 + // // This member is required. PolicyTemplate *string // Specifies the name of the resource type that this customer managed permission - // applies to. The format is : and is not case sensitive. For example, to specify - // an Amazon EC2 Subnet, you can use the string ec2:subnet . To see the list of - // valid values for this parameter, query the ListResourceTypes operation. + // applies to. + // + // The format is : and is not case sensitive. For example, to specify an Amazon + // EC2 Subnet, you can use the string ec2:subnet . To see the list of valid values + // for this parameter, query the ListResourceTypesoperation. // // This member is required. ResourceType *string @@ -71,10 +78,15 @@ type CreatePermissionInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies a list of one or more tag key and value pairs to attach to the diff --git a/service/ram/api_op_CreatePermissionVersion.go b/service/ram/api_op_CreatePermissionVersion.go index 18993f1f677..27bddd0c6a8 100644 --- a/service/ram/api_op_CreatePermissionVersion.go +++ b/service/ram/api_op_CreatePermissionVersion.go @@ -15,9 +15,11 @@ import ( // version is automatically set as the default version of the customer managed // permission. New resource shares automatically use the default permission. // Existing resource shares continue to use their original permission versions, but -// you can use ReplacePermissionAssociations to update them. If the specified -// customer managed permission already has the maximum of 5 versions, then you must -// delete one of the existing versions before you can create a new one. +// you can use ReplacePermissionAssociationsto update them. +// +// If the specified customer managed permission already has the maximum of 5 +// versions, then you must delete one of the existing versions before you can +// create a new one. func (c *Client) CreatePermissionVersion(ctx context.Context, params *CreatePermissionVersionInput, optFns ...func(*Options)) (*CreatePermissionVersionOutput, error) { if params == nil { params = &CreatePermissionVersionInput{} @@ -35,31 +37,38 @@ func (c *Client) CreatePermissionVersion(ctx context.Context, params *CreatePerm type CreatePermissionVersionInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the customer managed permission you're creating a new version for. + // Specifies the [Amazon Resource Name (ARN)] of the customer managed permission you're creating a new version + // for. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // A string in JSON format string that contains the following elements of a // resource-based policy: + // // - Effect: must be set to ALLOW . + // // - Action: specifies the actions that are allowed by this customer managed // permission. The list must contain only actions that are supported by the // specified resource type. For a list of all actions supported by each resource - // type, 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 Identity and Access Management User Guide. + // type, see [Actions, resources, and condition keys for Amazon Web Services services]in the Identity and Access Management User Guide. + // // - Condition: (optional) specifies conditional parameters that must evaluate // to true when a user attempts an action for that action to be allowed. For more - // information about the Condition element, see IAM policies: Condition element (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) - // in the Identity and Access Management User Guide. + // information about the Condition element, see [IAM policies: Condition element]in the Identity and Access + // Management User Guide. + // // This template can't include either the Resource or Principal elements. Those // are both filled in by RAM when it instantiates the resource-based policy on each // resource shared using this managed permission. The Resource comes from the ARN // of the specific resource that you are sharing. The Principal comes from the // list of identities added to the resource share. // + // [IAM policies: Condition element]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html + // [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 + // // This member is required. PolicyTemplate *string @@ -67,10 +76,15 @@ type CreatePermissionVersionInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_CreateResourceShare.go b/service/ram/api_op_CreateResourceShare.go index 03776216a32..4474cca038b 100644 --- a/service/ram/api_op_CreateResourceShare.go +++ b/service/ram/api_op_CreateResourceShare.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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. +// Creates a resource share. You can provide a list of the [Amazon Resource Names (ARNs)] 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. +// +// [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, optFns ...func(*Options)) (*CreateResourceShareOutput, error) { if params == nil { params = &CreateResourceShareInput{} @@ -51,32 +54,46 @@ type CreateResourceShareInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier 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)] 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. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PermissionArns []string - // Specifies a list of one or more principals to associate with the resource - // share. You can include the following values: + // 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 Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of an organization in Organizations, for example: + // + // - An [Amazon Resource Name (ARN)]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. + // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types Principals []string // Specifies a list of one or more ARNs of the resources to associate with the diff --git a/service/ram/api_op_DeletePermission.go b/service/ram/api_op_DeletePermission.go index a59b88758a0..00a0df3e33e 100644 --- a/service/ram/api_op_DeletePermission.go +++ b/service/ram/api_op_DeletePermission.go @@ -32,8 +32,9 @@ func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionI type DeletePermissionInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the customer managed permission that you want to delete. + // Specifies the [Amazon Resource Name (ARN)] of the customer managed permission that you want to delete. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string @@ -42,10 +43,15 @@ type DeletePermissionInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_DeletePermissionVersion.go b/service/ram/api_op_DeletePermissionVersion.go index dc2f8e5e537..7884c8744bf 100644 --- a/service/ram/api_op_DeletePermissionVersion.go +++ b/service/ram/api_op_DeletePermissionVersion.go @@ -13,9 +13,10 @@ import ( // Deletes one version of a customer managed permission. The version you specify // must not be attached to any resource share and must not be the default version -// for the permission. If a customer managed permission has the maximum of 5 -// versions, then you must delete at least one version before you can create -// another. +// for the permission. +// +// If a customer managed permission has the maximum of 5 versions, then you must +// delete at least one version before you can create another. func (c *Client) DeletePermissionVersion(ctx context.Context, params *DeletePermissionVersionInput, optFns ...func(*Options)) (*DeletePermissionVersionOutput, error) { if params == nil { params = &DeletePermissionVersionInput{} @@ -33,20 +34,24 @@ func (c *Client) DeletePermissionVersion(ctx context.Context, params *DeletePerm type DeletePermissionVersionInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the permission with the version you want to delete. + // Specifies the [Amazon Resource Name (ARN)] of the permission with the version you want to delete. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string - // Specifies the version number to delete. You can't delete the default version - // for a customer managed permission. You can't delete a version if it's the only - // version of the permission. You must either first create another version, or - // delete the permission completely. You can't delete a version if it is attached - // to any resource shares. If the version is the default, you must first use - // SetDefaultPermissionVersion to set a different version as the default for the - // customer managed permission, and then use AssociateResourceSharePermission to - // update your resource shares to use the new default version. + // Specifies the version number to delete. + // + // You can't delete the default version for a customer managed permission. + // + // You can't delete a version if it's the only version of the permission. You must + // either first create another version, or delete the permission completely. + // + // You can't delete a version if it is attached to any resource shares. If the + // version is the default, you must first use SetDefaultPermissionVersionto set a different version as the + // default for the customer managed permission, and then use AssociateResourceSharePermissionto update your + // resource shares to use the new default version. // // This member is required. PermissionVersion *int32 @@ -55,10 +60,15 @@ type DeletePermissionVersionInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_DeleteResourceShare.go b/service/ram/api_op_DeleteResourceShare.go index 96b357876d9..c8350ca3dbf 100644 --- a/service/ram/api_op_DeleteResourceShare.go +++ b/service/ram/api_op_DeleteResourceShare.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified resource share. This doesn't delete any of the resources -// that were associated with the resource share; it only stops the sharing of those -// resources through this resource share. +// Deletes the specified resource share. +// +// This doesn't delete any of the resources that were associated with the resource +// share; it only stops the sharing of those resources through this resource share. func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, optFns ...func(*Options)) (*DeleteResourceShareOutput, error) { if params == nil { params = &DeleteResourceShareInput{} @@ -30,8 +31,9 @@ func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResource type DeleteResourceShareInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource share to delete. + // Specifies the [Amazon Resource Name (ARN)] of the resource share to delete. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string @@ -40,10 +42,15 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_DisassociateResourceShare.go b/service/ram/api_op_DisassociateResourceShare.go index 4869c651c41..aa7f7810f89 100644 --- a/service/ram/api_op_DisassociateResourceShare.go +++ b/service/ram/api_op_DisassociateResourceShare.go @@ -30,8 +30,10 @@ func (c *Client) DisassociateResourceShare(ctx context.Context, params *Disassoc type DisassociateResourceShareInput struct { - // Specifies Amazon Resource 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 or principals from. + // Specifies [Amazon Resource Name (ARN)] of the resource share that you want to remove resources or + // principals from. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string @@ -40,31 +42,46 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier 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: + // the resources in this resource share. + // + // You can include the following values: + // // - An Amazon Web Services account ID, for example: 123456789012 - // - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of an organization in Organizations, for example: + // + // - An [Amazon Resource Name (ARN)]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. + // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types 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 - // associated with the resource share. + // Specifies a list of [Amazon Resource Names (ARNs)] 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 associated with the resource share. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArns []string // Specifies from which source accounts the service principal no longer has access diff --git a/service/ram/api_op_DisassociateResourceSharePermission.go b/service/ram/api_op_DisassociateResourceSharePermission.go index 5acae750ada..2b5c924d0a2 100644 --- a/service/ram/api_op_DisassociateResourceSharePermission.go +++ b/service/ram/api_op_DisassociateResourceSharePermission.go @@ -31,15 +31,17 @@ func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params type DisassociateResourceSharePermissionInput struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the managed permission to disassociate from the resource share. Changes to - // permissions take effect immediately. + // The [Amazon Resource Name (ARN)] of the managed permission to disassociate from the resource share. Changes + // to permissions take effect immediately. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource share that you want to remove the managed permission from. + // The [Amazon Resource Name (ARN)] of the resource share that you want to remove the managed permission from. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string @@ -48,10 +50,15 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_EnableSharingWithAwsOrganization.go b/service/ram/api_op_EnableSharingWithAwsOrganization.go index 1db93a3f0a5..5dcb6c3c485 100644 --- a/service/ram/api_op_EnableSharingWithAwsOrganization.go +++ b/service/ram/api_op_EnableSharingWithAwsOrganization.go @@ -19,8 +19,10 @@ import ( // by specifying the organization ID, or all of the accounts in an organizational // unit (OU) by specifying the OU ID. Until you enable sharing within the // organization, you can specify only individual Amazon Web Services accounts, or -// for supported resource types, IAM roles and users. You must call this operation -// from an IAM role or user in the organization's management account. +// for supported resource types, IAM roles and users. +// +// You must call this operation from an IAM role or user in the organization's +// management account. func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, optFns ...func(*Options)) (*EnableSharingWithAwsOrganizationOutput, error) { if params == nil { params = &EnableSharingWithAwsOrganizationInput{} diff --git a/service/ram/api_op_GetPermission.go b/service/ram/api_op_GetPermission.go index 85de7fec7b8..3f121284ed8 100644 --- a/service/ram/api_op_GetPermission.go +++ b/service/ram/api_op_GetPermission.go @@ -29,19 +29,21 @@ func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, type GetPermissionInput struct { - // Specifies the Amazon Resource 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 - // detail page. + // Specifies the [Amazon Resource Name (ARN)] of the permission whose contents you want to retrieve. To find + // the ARN for a permission, use either the ListPermissionsoperation or go to the [Permissions library] page in the + // RAM console and then choose the name of the permission. The ARN is displayed on + // the detail page. + // + // [Permissions library]: https://console.aws.amazon.com/ram/home#Permissions: + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies the version number of the RAM permission to retrieve. If you don't - // specify this parameter, the operation retrieves the default version. To see the - // list of available versions, use ListPermissionVersions . + // specify this parameter, the operation retrieves the default version. + // + // To see the list of available versions, use ListPermissionVersions. PermissionVersion *int32 noSmithyDocumentSerde diff --git a/service/ram/api_op_GetResourcePolicies.go b/service/ram/api_op_GetResourcePolicies.go index 600d69617e2..bad85cbb3e7 100644 --- a/service/ram/api_op_GetResourcePolicies.go +++ b/service/ram/api_op_GetResourcePolicies.go @@ -29,8 +29,9 @@ 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)] of the resources whose policies you want to retrieve. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArns []string diff --git a/service/ram/api_op_GetResourceShareAssociations.go b/service/ram/api_op_GetResourceShareAssociations.go index 4659269f749..ad7e5c09833 100644 --- a/service/ram/api_op_GetResourceShareAssociations.go +++ b/service/ram/api_op_GetResourceShareAssociations.go @@ -32,7 +32,9 @@ type GetResourceShareAssociationsInput struct { // Specifies whether you want to retrieve the associations that involve a // specified resource or principal. + // // - PRINCIPAL – list the principals whose associations you want to see. + // // - RESOURCE – list the resources whose associations you want to see. // // This member is required. @@ -60,18 +62,24 @@ 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 Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of an individual IAM role or user. You cannot specify this parameter if the - // association type is RESOURCE . + // organizational unit ID, or the [Amazon Resource Name (ARN)]of an individual IAM role or user. + // + // You cannot specify this parameter if the association type is RESOURCE . + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Principal *string - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of a resource whose resource shares you want to retrieve. You cannot specify - // this parameter if the association type is PRINCIPAL . + // Specifies the [Amazon Resource Name (ARN)] of a resource whose resource shares you want to retrieve. + // + // You cannot specify this parameter if the association type is PRINCIPAL . + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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)] of the resource share whose associations you want to + // retrieve. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string noSmithyDocumentSerde diff --git a/service/ram/api_op_GetResourceShareInvitations.go b/service/ram/api_op_GetResourceShareInvitations.go index 50be68754f0..1e0c44805cf 100644 --- a/service/ram/api_op_GetResourceShareInvitations.go +++ b/service/ram/api_op_GetResourceShareInvitations.go @@ -47,11 +47,14 @@ 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)] + // + // [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)] of the resource share invitations you want information about. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareInvitationArns []string noSmithyDocumentSerde diff --git a/service/ram/api_op_GetResourceShares.go b/service/ram/api_op_GetResourceShares.go index 94d4baed31b..0926da0a62c 100644 --- a/service/ram/api_op_GetResourceShares.go +++ b/service/ram/api_op_GetResourceShares.go @@ -32,7 +32,9 @@ 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 // // This member is required. @@ -60,16 +62,18 @@ type GetResourceSharesInput struct { NextToken *string // Specifies that you want to retrieve details of only those resource shares that - // use the managed permission with this Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // . + // use the managed permission with this [Amazon Resource Name (ARN)]. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PermissionArn *string // Specifies that you want to retrieve details for only those resource shares that // use the specified version of the managed permission. PermissionVersion *int32 - // 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)] of individual resource shares that you want information about. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArns []string // Specifies that you want to retrieve details of only those resource shares that diff --git a/service/ram/api_op_ListPendingInvitationResources.go b/service/ram/api_op_ListPendingInvitationResources.go index cdfb310e0fb..b720fd184ab 100644 --- a/service/ram/api_op_ListPendingInvitationResources.go +++ b/service/ram/api_op_ListPendingInvitationResources.go @@ -31,9 +31,10 @@ func (c *Client) ListPendingInvitationResources(ctx context.Context, params *Lis type ListPendingInvitationResourcesInput struct { - // Specifies the Amazon Resource 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 Resource Name (ARN)] of the invitation. You can use GetResourceShareInvitations to find the ARN of the + // invitation. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareInvitationArn *string @@ -57,10 +58,14 @@ 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 . ResourceRegionScope types.ResourceRegionScopeFilter diff --git a/service/ram/api_op_ListPermissionAssociations.go b/service/ram/api_op_ListPermissionAssociations.go index 97068279481..99cbb3ccab6 100644 --- a/service/ram/api_op_ListPermissionAssociations.go +++ b/service/ram/api_op_ListPermissionAssociations.go @@ -37,8 +37,10 @@ type ListPermissionAssociationsInput struct { // When true , specifies that you want to list only those associations with // resource shares that use the default version of the specified managed - // permission. When false (the default value), lists associations with resource - // shares that use any version of the specified managed permission. + // permission. + // + // When false (the default value), lists associations with resource shares that + // use any version of the specified managed permission. DefaultVersion *bool // Specifies that you want to list only those associations with resource shares @@ -62,8 +64,9 @@ type ListPermissionAssociationsInput struct { // previous call's NextToken response to request the next page of results. NextToken *string - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the managed permission. + // Specifies the [Amazon Resource Name (ARN)] of the managed permission. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PermissionArn *string // Specifies that you want to list only those associations with resource shares diff --git a/service/ram/api_op_ListPermissionVersions.go b/service/ram/api_op_ListPermissionVersions.go index 6569b9967e5..a13f7f08769 100644 --- a/service/ram/api_op_ListPermissionVersions.go +++ b/service/ram/api_op_ListPermissionVersions.go @@ -29,10 +29,11 @@ func (c *Client) ListPermissionVersions(ctx context.Context, params *ListPermiss type ListPermissionVersionsInput struct { - // Specifies the Amazon Resource 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 Resource Name (ARN)] 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. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string diff --git a/service/ram/api_op_ListPermissions.go b/service/ram/api_op_ListPermissions.go index 1518500cdae..5d14258e278 100644 --- a/service/ram/api_op_ListPermissions.go +++ b/service/ram/api_op_ListPermissions.go @@ -48,17 +48,22 @@ type ListPermissionsInput struct { NextToken *string // Specifies that you want to list only permissions of this type: + // // - AWS – returns only Amazon Web Services managed permissions. + // // - LOCAL – returns only customer managed permissions + // // - ALL – returns both Amazon Web Services managed permissions and customer // managed permissions. + // // If you don't specify this parameter, the default is All . PermissionType types.PermissionTypeFilter // Specifies that you want to list only those permissions that apply to the - // specified resource type. This parameter is not case sensitive. For example, to - // list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet . You - // can use the ListResourceTypes operation to get the specific string required. + // specified resource type. This parameter is not case sensitive. + // + // For example, to list only permissions that apply to Amazon EC2 subnets, specify + // ec2:subnet . You can use the ListResourceTypes operation to get the specific string required. ResourceType *string noSmithyDocumentSerde diff --git a/service/ram/api_op_ListPrincipals.go b/service/ram/api_op_ListPrincipals.go index cc81301b8d1..6b98d9cc8a9 100644 --- a/service/ram/api_op_ListPrincipals.go +++ b/service/ram/api_op_ListPrincipals.go @@ -32,7 +32,9 @@ 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 // // This member is required. @@ -55,34 +57,45 @@ type ListPrincipalsInput struct { // previous call's NextToken response to request the next page of results. NextToken *string - // Specifies that you want to list information for only the listed principals. You - // can include the following values: + // 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 Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of an organization in Organizations, for example: + // + // - An [Amazon Resource Name (ARN)]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. + // information, see [Sharing with IAM roles and users]in the Resource Access Manager User Guide. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // [Sharing with IAM roles and users]: https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types Principals []string // Specifies that you want to list principal information for the resource share - // with the specified Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // . + // with the specified [Amazon Resource Name (ARN)]. + // + // [Amazon Resource 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)]. + // + // [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 - // resource shares that include the specified resource type. For a list of valid - // values, query the ListResourceTypes operation. + // resource shares that include the specified resource type. + // + // For a list of valid values, query the ListResourceTypes operation. ResourceType *string noSmithyDocumentSerde diff --git a/service/ram/api_op_ListReplacePermissionAssociationsWork.go b/service/ram/api_op_ListReplacePermissionAssociationsWork.go index 07f6ef22d36..64869ff607b 100644 --- a/service/ram/api_op_ListReplacePermissionAssociationsWork.go +++ b/service/ram/api_op_ListReplacePermissionAssociationsWork.go @@ -12,7 +12,7 @@ import ( ) // Retrieves the current status of the asynchronous tasks performed by RAM when -// you perform the ReplacePermissionAssociationsWork operation. +// you perform the ReplacePermissionAssociationsWorkoperation. func (c *Client) ListReplacePermissionAssociationsWork(ctx context.Context, params *ListReplacePermissionAssociationsWorkInput, optFns ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error) { if params == nil { params = &ListReplacePermissionAssociationsWorkInput{} @@ -52,8 +52,7 @@ type ListReplacePermissionAssociationsWorkInput struct { Status types.ReplacePermissionAssociationsWorkStatus // A list of IDs. These values come from the id field of the - // replacePermissionAssociationsWork structure returned by the - // ReplacePermissionAssociations operation. + // replacePermissionAssociationsWork structure returned by the ReplacePermissionAssociations operation. WorkIds []string noSmithyDocumentSerde diff --git a/service/ram/api_op_ListResourceSharePermissions.go b/service/ram/api_op_ListResourceSharePermissions.go index 1e33e072149..aa8b7d871f3 100644 --- a/service/ram/api_op_ListResourceSharePermissions.go +++ b/service/ram/api_op_ListResourceSharePermissions.go @@ -29,8 +29,10 @@ func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListR type ListResourceSharePermissionsInput struct { - // Specifies the Amazon Resource 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 Resource Name (ARN)] of the resource share for which you want to retrieve the + // associated permissions. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string diff --git a/service/ram/api_op_ListResourceTypes.go b/service/ram/api_op_ListResourceTypes.go index 48a0d698d58..6f4dac9a222 100644 --- a/service/ram/api_op_ListResourceTypes.go +++ b/service/ram/api_op_ListResourceTypes.go @@ -48,10 +48,14 @@ 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 . ResourceRegionScope types.ResourceRegionScopeFilter diff --git a/service/ram/api_op_ListResources.go b/service/ram/api_op_ListResources.go index 2b36457933e..da1ee0ce158 100644 --- a/service/ram/api_op_ListResources.go +++ b/service/ram/api_op_ListResources.go @@ -32,7 +32,9 @@ 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 // // This member is required. @@ -60,27 +62,34 @@ 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)]. + // + // [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 . 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) - // . + // identified by the specified [Amazon Resource Names (ARNs)]. + // + // [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 - // of the specified resource type. For valid values, query the ListResourceTypes - // operation. + // of the specified resource type. + // + // For valid values, query the ListResourceTypes operation. ResourceType *string noSmithyDocumentSerde diff --git a/service/ram/api_op_PromotePermissionCreatedFromPolicy.go b/service/ram/api_op_PromotePermissionCreatedFromPolicy.go index a35279994ef..14734eee12f 100644 --- a/service/ram/api_op_PromotePermissionCreatedFromPolicy.go +++ b/service/ram/api_op_PromotePermissionCreatedFromPolicy.go @@ -16,19 +16,24 @@ import ( // permission that has the same IAM permissions as the original resource-based // policy. However, this type of managed permission is visible to only the resource // share owner, and the associated resource share can't be modified by using RAM. +// // This operation creates a separate, fully manageable customer managed permission // that has the same IAM permissions as the original resource-based policy. You can -// associate this customer managed permission to any resource shares. Before you -// use PromoteResourceShareCreatedFromPolicy , you should first run this operation -// to ensure that you have an appropriate customer managed permission that can be -// associated with the promoted resource share. +// associate this customer managed permission to any resource shares. +// +// Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an +// appropriate customer managed permission that can be associated with the promoted +// resource share. +// // - The original CREATED_FROM_POLICY policy isn't deleted, and resource shares // using that original policy aren't automatically updated. +// // - You can't modify a CREATED_FROM_POLICY resource share so you can't associate // the new customer managed permission by using ReplacePermsissionAssociations . -// However, if you use PromoteResourceShareCreatedFromPolicy , that operation -// automatically associates the fully manageable customer managed permission to the -// newly promoted STANDARD resource share. +// However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully +// manageable customer managed permission to the newly promoted STANDARD resource +// share. +// // - After you promote a resource share, if the original CREATED_FROM_POLICY // managed permission has no other associations to A resource share, then RAM // automatically deletes it. @@ -54,10 +59,10 @@ type PromotePermissionCreatedFromPolicyInput struct { // This member is required. Name *string - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the CREATED_FROM_POLICY permission that you want to promote. You can get - // this Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // by calling the ListResourceSharePermissions operation. + // Specifies the [Amazon Resource Name (ARN)] of the CREATED_FROM_POLICY permission that you want to promote. + // You can get this [Amazon Resource Name (ARN)]by calling the ListResourceSharePermissions operation. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string @@ -66,10 +71,15 @@ type PromotePermissionCreatedFromPolicyInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go b/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go index 8f4bb4247ab..5ce7568733e 100644 --- a/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go +++ b/service/ram/api_op_PromoteResourceShareCreatedFromPolicy.go @@ -15,15 +15,17 @@ import ( // permission that has the same IAM permissions as the original resource-based // policy. However, this type of managed permission is visible to only the resource // share owner, and the associated resource share can't be modified by using RAM. +// // This operation promotes the resource share to a STANDARD resource share that is // fully manageable in RAM. When you promote a resource share, you can then manage // the resource share in RAM and it becomes visible to all of the principals you -// shared it with. Before you perform this operation, you should first run -// PromotePermissionCreatedFromPolicy to ensure that you have an appropriate -// customer managed permission that can be associated with this resource share -// after its is promoted. If this operation can't find a managed permission that -// exactly matches the existing CREATED_FROM_POLICY permission, then this -// operation fails. +// shared it with. +// +// Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have +// an appropriate customer managed permission that can be associated with this +// resource share after its is promoted. If this operation can't find a managed +// permission that exactly matches the existing CREATED_FROM_POLICY permission, +// then this operation fails. func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, optFns ...func(*Options)) (*PromoteResourceShareCreatedFromPolicyOutput, error) { if params == nil { params = &PromoteResourceShareCreatedFromPolicyInput{} @@ -41,8 +43,9 @@ func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, para type PromoteResourceShareCreatedFromPolicyInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource share to promote. + // Specifies the [Amazon Resource Name (ARN)] of the resource share to promote. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string diff --git a/service/ram/api_op_RejectResourceShareInvitation.go b/service/ram/api_op_RejectResourceShareInvitation.go index be1960c75b7..f92015912ab 100644 --- a/service/ram/api_op_RejectResourceShareInvitation.go +++ b/service/ram/api_op_RejectResourceShareInvitation.go @@ -30,8 +30,9 @@ func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *Reje type RejectResourceShareInvitationInput struct { - // Specifies the Amazon Resource 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 Resource Name (ARN)] of the invitation that you want to reject. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareInvitationArn *string @@ -40,10 +41,15 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_ReplacePermissionAssociations.go b/service/ram/api_op_ReplacePermissionAssociations.go index a1ddd52674a..1be8a50f484 100644 --- a/service/ram/api_op_ReplacePermissionAssociations.go +++ b/service/ram/api_op_ReplacePermissionAssociations.go @@ -16,12 +16,17 @@ import ( // target managed permission. You can optionally specify that the update applies to // only resource shares that currently use a specified version. This enables you to // update to the latest version, without changing the which managed permission is -// used. You can use this operation to update all of your resource shares to use -// the current default version of the permission by specifying the same value for -// the fromPermissionArn and toPermissionArn parameters. You can use the optional -// fromPermissionVersion parameter to update only those resources that use a -// specified version of the managed permission to the new managed permission. To -// successfully perform this operation, you must have permission to update the +// used. +// +// You can use this operation to update all of your resource shares to use the +// current default version of the permission by specifying the same value for the +// fromPermissionArn and toPermissionArn parameters. +// +// You can use the optional fromPermissionVersion parameter to update only those +// resources that use a specified version of the managed permission to the new +// managed permission. +// +// To successfully perform this operation, you must have permission to update the // resource-based policy on all affected resource types. func (c *Client) ReplacePermissionAssociations(ctx context.Context, params *ReplacePermissionAssociationsInput, optFns ...func(*Options)) (*ReplacePermissionAssociationsOutput, error) { if params == nil { @@ -40,16 +45,19 @@ func (c *Client) ReplacePermissionAssociations(ctx context.Context, params *Repl type ReplacePermissionAssociationsInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the managed permission that you want to replace. + // Specifies the [Amazon Resource Name (ARN)] of the managed permission that you want to replace. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. FromPermissionArn *string // Specifies the ARN of the managed permission that you want to associate with // resource shares in place of the one specified by fromPerssionArn and - // fromPermissionVersion . The operation always associates the version that is - // currently the default for the specified managed permission. + // fromPermissionVersion . + // + // The operation always associates the version that is currently the default for + // the specified managed permission. // // This member is required. ToPermissionArn *string @@ -58,10 +66,15 @@ type ReplacePermissionAssociationsInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies that you want to updated the permissions for only those resource @@ -80,9 +93,8 @@ type ReplacePermissionAssociationsOutput struct { ClientToken *string // Specifies a data structure that you can use to track the asynchronous tasks - // that RAM performs to complete this operation. You can use the - // ListReplacePermissionAssociationsWork operation and pass the id value returned - // in this structure. + // that RAM performs to complete this operation. You can use the ListReplacePermissionAssociationsWorkoperation and + // pass the id value returned in this structure. ReplacePermissionAssociationsWork *types.ReplacePermissionAssociationsWork // Metadata pertaining to the operation's result. diff --git a/service/ram/api_op_SetDefaultPermissionVersion.go b/service/ram/api_op_SetDefaultPermissionVersion.go index 4b283f90605..fd151c74005 100644 --- a/service/ram/api_op_SetDefaultPermissionVersion.go +++ b/service/ram/api_op_SetDefaultPermissionVersion.go @@ -13,8 +13,7 @@ import ( // Designates the specified version number as the default version for the // specified customer managed permission. New resource shares automatically use // this new default permission. Existing resource shares continue to use their -// original permission version, but you can use ReplacePermissionAssociations to -// update them. +// original permission version, but you can use ReplacePermissionAssociationsto update them. func (c *Client) SetDefaultPermissionVersion(ctx context.Context, params *SetDefaultPermissionVersionInput, optFns ...func(*Options)) (*SetDefaultPermissionVersionOutput, error) { if params == nil { params = &SetDefaultPermissionVersionInput{} @@ -32,15 +31,17 @@ func (c *Client) SetDefaultPermissionVersion(ctx context.Context, params *SetDef type SetDefaultPermissionVersionInput struct { - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the customer managed permission whose default version you want to change. + // Specifies the [Amazon Resource Name (ARN)] of the customer managed permission whose default version you + // want to change. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PermissionArn *string // Specifies the version number that you want to designate as the default for // customer managed permission. To see a list of all available version numbers, use - // ListPermissionVersions . + // ListPermissionVersions. // // This member is required. PermissionVersion *int32 @@ -49,10 +50,15 @@ type SetDefaultPermissionVersionInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/ram/api_op_TagResource.go b/service/ram/api_op_TagResource.go index e2bcc6bbb44..acae1e021ac 100644 --- a/service/ram/api_op_TagResource.go +++ b/service/ram/api_op_TagResource.go @@ -13,8 +13,10 @@ import ( // Adds the specified tag keys and values to a resource share or managed // permission. If you choose a resource share, the tags are attached to only the -// resource share, not to the resources that are in the resource share. The tags on -// a managed permission are the same for all versions of the managed permission. +// resource share, not to the resources that are in the resource share. +// +// The tags on a managed permission are the same for all versions of the managed +// permission. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -39,14 +41,16 @@ type TagResourceInput struct { // This member is required. Tags []types.Tag - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the managed permission that you want to add tags to. You must specify either - // resourceArn , or resourceShareArn , but not both. + // Specifies the [Amazon Resource Name (ARN)] of the managed permission that you want to add tags to. You must + // specify either resourceArn , or resourceShareArn , but not both. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArn *string - // Specifies the Amazon Resource 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. You must specify either - // resourceShareArn , or resourceArn , but not both. + // Specifies the [Amazon Resource Name (ARN)] of the resource share that you want to add tags to. You must + // specify either resourceShareArn , or resourceArn , but not both. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string noSmithyDocumentSerde diff --git a/service/ram/api_op_UntagResource.go b/service/ram/api_op_UntagResource.go index a2e0854fb46..01535c7fa34 100644 --- a/service/ram/api_op_UntagResource.go +++ b/service/ram/api_op_UntagResource.go @@ -34,15 +34,17 @@ type UntagResourceInput struct { // This member is required. TagKeys []string - // Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the managed permission that you want to remove tags from. You must specify - // either resourceArn , or resourceShareArn , but not both. + // Specifies the [Amazon Resource Name (ARN)] of the managed permission that you want to remove tags from. You + // must specify either resourceArn , or resourceShareArn , but not both. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceArn *string - // Specifies the Amazon Resource 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. You must - // specify either resourceShareArn , or resourceArn , but not both. + // Specifies the [Amazon Resource Name (ARN)] 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. You must specify either resourceShareArn , or resourceArn , but not both. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string noSmithyDocumentSerde diff --git a/service/ram/api_op_UpdateResourceShare.go b/service/ram/api_op_UpdateResourceShare.go index 46457ccd379..9bbaf9d143d 100644 --- a/service/ram/api_op_UpdateResourceShare.go +++ b/service/ram/api_op_UpdateResourceShare.go @@ -29,8 +29,9 @@ func (c *Client) UpdateResourceShare(ctx context.Context, params *UpdateResource type UpdateResourceShareInput struct { - // Specifies the Amazon Resource 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 Resource Name (ARN)] of the resource share that you want to modify. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceShareArn *string @@ -43,10 +44,15 @@ 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier 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 c53b97047a0..86a10ccd9de 100644 --- a/service/ram/doc.go +++ b/service/ram/doc.go @@ -10,7 +10,13 @@ // accounts, then you can share your resources with your entire organization or to // organizational units (OUs). For supported resource types, you can also share // resources with individual Identity and Access Management (IAM) roles and 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] +// +// [Resource Access Manager User Guide] +// +// [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/options.go b/service/ram/options.go index 53cb5ed0457..d3c02dce51d 100644 --- a/service/ram/options.go +++ b/service/ram/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ram/types/enums.go b/service/ram/types/enums.go index ec3d2ace37e..18053542fb4 100644 --- a/service/ram/types/enums.go +++ b/service/ram/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for PermissionFeatureSet. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionFeatureSet) Values() []PermissionFeatureSet { return []PermissionFeatureSet{ "CREATED_FROM_POLICY", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for PermissionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionStatus) Values() []PermissionStatus { return []PermissionStatus{ "ATTACHABLE", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for PermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionType) Values() []PermissionType { return []PermissionType{ "CUSTOMER_MANAGED", @@ -72,8 +75,9 @@ const ( ) // Values returns all known values for PermissionTypeFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionTypeFilter) Values() []PermissionTypeFilter { return []PermissionTypeFilter{ "ALL", @@ -93,8 +97,9 @@ const ( // Values returns all known values for ReplacePermissionAssociationsWorkStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplacePermissionAssociationsWorkStatus) Values() []ReplacePermissionAssociationsWorkStatus { return []ReplacePermissionAssociationsWorkStatus{ "IN_PROGRESS", @@ -112,8 +117,9 @@ const ( ) // Values returns all known values for ResourceOwner. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceOwner) Values() []ResourceOwner { return []ResourceOwner{ "SELF", @@ -130,8 +136,9 @@ const ( ) // Values returns all known values for ResourceRegionScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceRegionScope) Values() []ResourceRegionScope { return []ResourceRegionScope{ "REGIONAL", @@ -150,6 +157,7 @@ const ( // Values returns all known values for ResourceRegionScopeFilter. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResourceRegionScopeFilter) Values() []ResourceRegionScopeFilter { return []ResourceRegionScopeFilter{ @@ -172,8 +180,9 @@ const ( // Values returns all known values for ResourceShareAssociationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareAssociationStatus) Values() []ResourceShareAssociationStatus { return []ResourceShareAssociationStatus{ "ASSOCIATING", @@ -194,8 +203,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareAssociationType) Values() []ResourceShareAssociationType { return []ResourceShareAssociationType{ "PRINCIPAL", @@ -213,8 +223,9 @@ const ( ) // Values returns all known values for ResourceShareFeatureSet. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareFeatureSet) Values() []ResourceShareFeatureSet { return []ResourceShareFeatureSet{ "CREATED_FROM_POLICY", @@ -235,8 +246,9 @@ const ( // Values returns all known values for ResourceShareInvitationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareInvitationStatus) Values() []ResourceShareInvitationStatus { return []ResourceShareInvitationStatus{ "PENDING", @@ -258,8 +270,9 @@ const ( ) // Values returns all known values for ResourceShareStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceShareStatus) Values() []ResourceShareStatus { return []ResourceShareStatus{ "PENDING", @@ -282,8 +295,9 @@ const ( ) // Values returns all known values for ResourceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStatus) Values() []ResourceStatus { return []ResourceStatus{ "AVAILABLE", diff --git a/service/ram/types/errors.go b/service/ram/types/errors.go index a60579801d6..24d917b45c7 100644 --- a/service/ram/types/errors.go +++ b/service/ram/types/errors.go @@ -222,8 +222,9 @@ func (e *InvalidStateTransitionException) ErrorCode() string { } func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The operation failed because the specified Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) -// has a format that isn't valid. +// The operation failed because the specified [Amazon Resource Name (ARN)] has a format that isn't valid. +// +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html type MalformedArnException struct { Message *string @@ -356,8 +357,9 @@ func (e *PermissionAlreadyExistsException) ErrorFault() smithy.ErrorFault { retu // The operation failed because it would exceed the maximum number of permissions // you can create in each Amazon Web Services Region. To view the limits for your -// Amazon Web Services account, see the RAM page in the Service Quotas console (https://console.aws.amazon.com/servicequotas/home/services/ram/quotas) -// . +// Amazon Web Services account, see the [RAM page in the Service Quotas console]. +// +// [RAM page in the Service Quotas console]: https://console.aws.amazon.com/servicequotas/home/services/ram/quotas type PermissionLimitExceededException struct { Message *string @@ -385,8 +387,9 @@ func (e *PermissionLimitExceededException) ErrorFault() smithy.ErrorFault { retu // The operation failed because it would exceed the limit for the number of // versions you can have for a permission. To view the limits for your Amazon Web -// Services account, see the RAM page in the Service Quotas console (https://console.aws.amazon.com/servicequotas/home/services/ram/quotas) -// . +// Services account, see the [RAM page in the Service Quotas console]. +// +// [RAM page in the Service Quotas console]: https://console.aws.amazon.com/servicequotas/home/services/ram/quotas type PermissionVersionsLimitExceededException struct { Message *string @@ -414,8 +417,9 @@ func (e *PermissionVersionsLimitExceededException) ErrorFault() smithy.ErrorFaul return smithy.FaultClient } -// The operation failed because the specified Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) -// was not found. +// The operation failed because the specified [Amazon Resource Name (ARN)] was not found. +// +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html type ResourceArnNotFoundException struct { Message *string @@ -497,8 +501,9 @@ func (e *ResourceShareInvitationAlreadyRejectedException) ErrorFault() smithy.Er return smithy.FaultClient } -// The operation failed because the specified Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) -// for an invitation was not found. +// The operation failed because the specified [Amazon Resource Name (ARN)] for an invitation was not found. +// +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html type ResourceShareInvitationArnNotFoundException struct { Message *string @@ -556,9 +561,9 @@ func (e *ResourceShareInvitationExpiredException) ErrorFault() smithy.ErrorFault } // The operation failed because it would exceed the limit for resource shares for -// your account. To view the limits for your Amazon Web Services account, see the -// RAM page in the Service Quotas console (https://console.aws.amazon.com/servicequotas/home/services/ram/quotas) -// . +// your account. To view the limits for your Amazon Web Services account, see the [RAM page in the Service Quotas console]. +// +// [RAM page in the Service Quotas console]: https://console.aws.amazon.com/servicequotas/home/services/ram/quotas type ResourceShareLimitExceededException struct { Message *string @@ -748,7 +753,7 @@ func (e *UnknownResourceException) ErrorFault() smithy.ErrorFault { return smith // There isn't an existing managed permission defined in RAM that has the same IAM // permissions as the resource-based policy attached to the resource. You should -// first run PromotePermissionCreatedFromPolicy to create that managed permission. +// first run PromotePermissionCreatedFromPolicyto create that managed permission. type UnmatchedPolicyPermissionException struct { Message *string diff --git a/service/ram/types/types.go b/service/ram/types/types.go index 69a0f401781..90c9814d6c9 100644 --- a/service/ram/types/types.go +++ b/service/ram/types/types.go @@ -10,8 +10,9 @@ import ( // An object that describes a managed permission associated with a resource share. type AssociatedPermission struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the associated managed permission. + // The [Amazon Resource Name (ARN)] of the associated managed permission. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // Indicates whether the associated resource share is using the default version of @@ -20,22 +21,24 @@ type AssociatedPermission struct { // Indicates what features are available for this resource share. This parameter // can have one of the following values: + // // - STANDARD – A resource share that supports all functionality. 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. This resource // share might have been created by RAM, or it might have been CREATED_FROM_POLICY // and then promoted. + // // - CREATED_FROM_POLICY – The customer manually shared a resource by attaching // a resource-based policy. That policy did not match any existing managed // permissions, so RAM created this customer managed permission automatically on // the customer's behalf based on the attached policy document. 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 . + // it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy + // . + // // - PROMOTING_TO_STANDARD – This resource share was originally - // CREATED_FROM_POLICY , but the customer ran the - // PromoteResourceShareCreatedFromPolicy and that operation is still in progress. - // This value changes to STANDARD when complete. + // CREATED_FROM_POLICY , but the customer ran the PromoteResourceShareCreatedFromPolicyand that operation is still in + // progress. This value changes to STANDARD when complete. FeatureSet PermissionFeatureSet // The date and time when the association between the permission and the resource @@ -45,8 +48,9 @@ type AssociatedPermission struct { // The version of the permission currently associated with the resource share. PermissionVersion *string - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of a resource share associated with this permission. + // The [Amazon Resource Name (ARN)] of a resource share associated with this permission. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string // The resource type to which this permission applies. @@ -54,11 +58,15 @@ type AssociatedPermission struct { // The current status of the association between the permission and the resource // share. The following are the possible values: + // // - ATTACHABLE – This permission or version can be associated with resource // shares. + // // - UNATTACHABLE – This permission or version can't currently be associated with // resource shares. + // // - DELETING – This permission or version is in the process of being deleted. + // // - DELETED – This permission or version is deleted. Status *string @@ -73,7 +81,9 @@ type Principal struct { // Indicates the relationship between the Amazon Web Services account the // principal belongs to and the account that owns the resource share: + // // - True – The two accounts belong to same organization. + // // - False – The two accounts do not belong to the same organization. External *bool @@ -84,29 +94,30 @@ type Principal struct { // principal was last updated. LastUpdatedTime *time.Time - // The Amazon Resource 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 Resource Name (ARN)] of a resource share the principal is associated with. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string noSmithyDocumentSerde } // A structure that represents the background work that RAM performs when you -// invoke the ReplacePermissionAssociations operation. +// invoke the ReplacePermissionAssociationsoperation. type ReplacePermissionAssociationsWork struct { // The date and time when this asynchronous background task was created. CreationTime *time.Time - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the managed permission that this background task is replacing. + // The [Amazon Resource Name (ARN)] of the managed permission that this background task is replacing. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html FromPermissionArn *string // The version of the managed permission that this background task is replacing. FromPermissionVersion *string - // The unique identifier for the background task associated with one - // ReplacePermissionAssociations request. + // The unique identifier for the background task associated with one ReplacePermissionAssociations request. Id *string // The date and time when the status of this background task was last updated. @@ -114,8 +125,11 @@ type ReplacePermissionAssociationsWork struct { // Specifies the current status of the background tasks for the specified ID. The // output is one of the following strings: + // // - IN_PROGRESS + // // - COMPLETED + // // - FAILED Status ReplacePermissionAssociationsWorkStatus @@ -139,8 +153,9 @@ type ReplacePermissionAssociationsWork struct { // Describes a resource associated with a resource share in RAM. 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)] of the resource. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time when the resource was associated with the resource share. @@ -150,19 +165,23 @@ type Resource struct { // share was last updated. LastUpdatedTime *time.Time - // The Amazon Resource 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. + // The [Amazon Resource Name (ARN)] of the resource group. This value is available only if the resource is + // part of a resource group. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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. ResourceRegionScope ResourceRegionScope - // The Amazon Resource 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 Resource Name (ARN)] of the resource share this resource is associated with. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string // The current status of the resource. @@ -184,8 +203,9 @@ type ResourceShare struct { // Indicates whether principals outside your organization in Organizations can be // associated with a resource share. - // - True – the resource share can be shared with any Amazon Web Services - // account. + // + // - True – the resource share can be shared with any Amazon Web Services account. + // // - False – the resource share can be shared with only accounts in the same // organization as the account that owns the resource share. AllowExternalPrincipals *bool @@ -195,22 +215,24 @@ type ResourceShare struct { // Indicates what features are available for this resource share. This parameter // can have one of the following values: + // // - STANDARD – A resource share that supports all functionality. 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. This resource // share might have been created by RAM, or it might have been CREATED_FROM_POLICY // and then promoted. + // // - CREATED_FROM_POLICY – The customer manually shared a resource by attaching // a resource-based policy. That policy did not match any existing managed // permissions, so RAM created this customer managed permission automatically on // the customer's behalf based on the attached policy document. 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 . + // it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy + // . + // // - PROMOTING_TO_STANDARD – This resource share was originally - // CREATED_FROM_POLICY , but the customer ran the - // PromoteResourceShareCreatedFromPolicy and that operation is still in progress. - // This value changes to STANDARD when complete. + // CREATED_FROM_POLICY , but the customer ran the PromoteResourceShareCreatedFromPolicyand that operation is still in + // progress. This value changes to STANDARD when complete. FeatureSet ResourceShareFeatureSet // The date and time when the resource share was last updated. @@ -222,8 +244,9 @@ type ResourceShare struct { // The ID of the Amazon Web Services account that owns the resource share. OwningAccountId *string - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource share + // The [Amazon Resource Name (ARN)] of the resource share + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string // The current status of the resource share. @@ -243,15 +266,22 @@ type ResourceShare struct { type ResourceShareAssociation struct { // The associated entity. This can be either of the following: - // - For a resource association, this is the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource. + // + // - For a resource association, this is the [Amazon Resource Name (ARN)]of the resource. + // // - For principal associations, this is one of the following: + // // - The ID of an Amazon Web Services account - // - The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of an organization in Organizations + // + // - The [Amazon Resource Name (ARN)]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 + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AssociatedEntity *string // The type of entity included in this association. @@ -267,8 +297,9 @@ type ResourceShareAssociation struct { // The date and time when the association was last updated. LastUpdatedTime *time.Time - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource share. + // The [Amazon Resource Name (ARN)] of the resource share. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string // The name of the resource share. @@ -293,22 +324,24 @@ type ResourceShareInvitation struct { // The ID of the Amazon Web Services account that received the invitation. ReceiverAccountId *string - // The Amazon Resource 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 Resource Name (ARN)] of the IAM user or role that received the invitation. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ReceiverArn *string - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the resource share + // The [Amazon Resource Name (ARN)] of the resource share + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareArn *string - // To view the resources associated with a pending resource share invitation, use - // ListPendingInvitationResources . + // To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources. // // Deprecated: This member has been deprecated. Use ListPendingInvitationResources. ResourceShareAssociations []ResourceShareAssociation - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the invitation. + // The [Amazon Resource Name (ARN)] of the invitation. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceShareInvitationArn *string // The name of the resource share. @@ -326,8 +359,9 @@ type ResourceShareInvitation struct { // Information about a RAM managed permission. type ResourceSharePermissionDetail struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of this RAM managed permission. + // The [Amazon Resource Name (ARN)] of this RAM managed permission. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time when the permission was created. @@ -339,22 +373,24 @@ type ResourceSharePermissionDetail struct { // Indicates what features are available for this resource share. This parameter // can have one of the following values: + // // - STANDARD – A resource share that supports all functionality. 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. This resource // share might have been created by RAM, or it might have been CREATED_FROM_POLICY // and then promoted. + // // - CREATED_FROM_POLICY – The customer manually shared a resource by attaching // a resource-based policy. That policy did not match any existing managed // permissions, so RAM created this customer managed permission automatically on // the customer's behalf based on the attached policy document. 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 . + // it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy + // . + // // - PROMOTING_TO_STANDARD – This resource share was originally - // CREATED_FROM_POLICY , but the customer ran the - // PromoteResourceShareCreatedFromPolicy and that operation is still in progress. - // This value changes to STANDARD when complete. + // CREATED_FROM_POLICY , but the customer ran the PromoteResourceShareCreatedFromPolicyand that operation is still in + // progress. This value changes to STANDARD when complete. FeatureSet PermissionFeatureSet // Specifies whether the version of the permission represented in this response is @@ -373,9 +409,11 @@ type ResourceSharePermissionDetail struct { Permission *string // The type of managed permission. This can be one of the following values: + // // - AWS_MANAGED – Amazon Web Services created and manages this managed // permission. You can associate it with your resource shares, but you can't modify // it. + // // - CUSTOMER_MANAGED – You, or another principal in your account created this // managed permission. You can associate it with your resource shares and create // new versions that have different permissions. @@ -386,11 +424,15 @@ type ResourceSharePermissionDetail struct { // The current status of the association between the permission and the resource // share. The following are the possible values: + // // - ATTACHABLE – This permission or version can be associated with resource // shares. + // // - UNATTACHABLE – This permission or version can't currently be associated with // resource shares. + // // - DELETING – This permission or version is in the process of being deleted. + // // - DELETED – This permission or version is deleted. Status PermissionStatus @@ -406,8 +448,9 @@ type ResourceSharePermissionDetail struct { // Information about an RAM permission. type ResourceSharePermissionSummary struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the permission you want information about. + // The [Amazon Resource Name (ARN)] of the permission you want information about. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time when the permission was created. @@ -419,22 +462,24 @@ type ResourceSharePermissionSummary struct { // Indicates what features are available for this resource share. This parameter // can have one of the following values: + // // - STANDARD – A resource share that supports all functionality. 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. This resource // share might have been created by RAM, or it might have been CREATED_FROM_POLICY // and then promoted. + // // - CREATED_FROM_POLICY – The customer manually shared a resource by attaching // a resource-based policy. That policy did not match any existing managed // permissions, so RAM created this customer managed permission automatically on // the customer's behalf based on the attached policy document. 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 . + // it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy + // . + // // - PROMOTING_TO_STANDARD – This resource share was originally - // CREATED_FROM_POLICY , but the customer ran the - // PromoteResourceShareCreatedFromPolicy and that operation is still in progress. - // This value changes to STANDARD when complete. + // CREATED_FROM_POLICY , but the customer ran the PromoteResourceShareCreatedFromPolicyand that operation is still in + // progress. This value changes to STANDARD when complete. FeatureSet PermissionFeatureSet // Specifies whether the managed permission associated with this resource share is @@ -448,9 +493,11 @@ type ResourceSharePermissionSummary struct { Name *string // The type of managed permission. This can be one of the following values: + // // - AWS_MANAGED – Amazon Web Services created and manages this managed // permission. You can associate it with your resource shares, but you can't modify // it. + // // - CUSTOMER_MANAGED – You, or another principal in your account created this // managed permission. You can associate it with your resource shares and create // new versions that have different permissions. @@ -478,8 +525,10 @@ 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. ResourceRegionScope ResourceRegionScope @@ -497,10 +546,13 @@ 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. +// you secure your resources. For more information, see [Controlling access to Amazon Web Services resources using tags]. +// +// For more information about tags, see [Tagging Amazon Web Services resources] in the Amazon Web Services General +// Reference Guide. +// +// [Controlling access to Amazon Web Services resources using tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html +// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html 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_op_CreateRule.go b/service/rbin/api_op_CreateRule.go index d9ea477c02b..d1c0411a9f1 100644 --- a/service/rbin/api_op_CreateRule.go +++ b/service/rbin/api_op_CreateRule.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Elastic Compute Cloud User Guide. +// Creates a Recycle Bin retention rule. For more information, see [Create Recycle Bin retention rules] in the Amazon +// Elastic Compute Cloud User Guide. +// +// [Create Recycle Bin retention rules]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { params = &CreateRuleInput{} @@ -55,12 +56,15 @@ type CreateRuleInput struct { // 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 - // key and value pair to a maximum or five retention rules. To create a - // Region-level retention rule, omit this parameter. A Region-level retention rule - // does not have any resource tags specified. It retains all deleted resources of - // the specified resource type in the Region in which the rule is created, even if - // the resources are not tagged. + // deleted without being retained by the retention rule. + // + // You can add the same tag key and value pair to a maximum or five retention + // rules. + // + // To create a Region-level retention rule, omit this parameter. A Region-level + // retention rule does not have any resource tags specified. It retains all deleted + // resources of the specified resource type in the Region in which the rule is + // created, even if the resources are not tagged. ResourceTags []types.ResourceTag // Information about the tags to assign to the retention rule. @@ -81,12 +85,16 @@ 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 . diff --git a/service/rbin/api_op_DeleteRule.go b/service/rbin/api_op_DeleteRule.go index 960dda5e925..3d80aef1e0c 100644 --- a/service/rbin/api_op_DeleteRule.go +++ b/service/rbin/api_op_DeleteRule.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Elastic Compute Cloud User Guide. +// Deletes a Recycle Bin retention rule. For more information, see [Delete Recycle Bin retention rules] in the Amazon +// Elastic Compute Cloud User Guide. +// +// [Delete Recycle Bin retention rules]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} diff --git a/service/rbin/api_op_GetRule.go b/service/rbin/api_op_GetRule.go index f49a535cd2e..4b211dce83e 100644 --- a/service/rbin/api_op_GetRule.go +++ b/service/rbin/api_op_GetRule.go @@ -55,12 +55,16 @@ 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 . diff --git a/service/rbin/api_op_LockRule.go b/service/rbin/api_op_LockRule.go index 2e94882461c..01ae6d690b7 100644 --- a/service/rbin/api_op_LockRule.go +++ b/service/rbin/api_op_LockRule.go @@ -54,12 +54,16 @@ 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 . diff --git a/service/rbin/api_op_UnlockRule.go b/service/rbin/api_op_UnlockRule.go index b01c8bb5090..7f509665ca7 100644 --- a/service/rbin/api_op_UnlockRule.go +++ b/service/rbin/api_op_UnlockRule.go @@ -56,12 +56,16 @@ 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 . diff --git a/service/rbin/api_op_UpdateRule.go b/service/rbin/api_op_UpdateRule.go index 72dfc7c4386..ba8aee80036 100644 --- a/service/rbin/api_op_UpdateRule.go +++ b/service/rbin/api_op_UpdateRule.go @@ -15,8 +15,9 @@ 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) -// in the Amazon Elastic Compute Cloud User Guide. +// more information, see [Update Recycle Bin retention rules]in the Amazon Elastic Compute Cloud User Guide. +// +// [Update Recycle Bin retention rules]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule func (c *Client) UpdateRule(ctx context.Context, params *UpdateRuleInput, optFns ...func(*Options)) (*UpdateRuleOutput, error) { if params == nil { params = &UpdateRuleInput{} @@ -47,12 +48,15 @@ type UpdateRuleInput struct { // 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 - // key and value pair to a maximum or five retention rules. To create a - // Region-level retention rule, omit this parameter. A Region-level retention rule - // does not have any resource tags specified. It retains all deleted resources of - // the specified resource type in the Region in which the rule is created, even if - // the resources are not tagged. + // deleted without being retained by the retention rule. + // + // You can add the same tag key and value pair to a maximum or five retention + // rules. + // + // To create a Region-level retention rule, omit this parameter. A Region-level + // retention rule does not have any resource tags specified. It retains all deleted + // resources of the specified resource type in the Region in which the rule is + // created, even if the resources are not tagged. ResourceTags []types.ResourceTag // This parameter is currently not supported. You can't update a retention rule's @@ -80,12 +84,16 @@ 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 . diff --git a/service/rbin/doc.go b/service/rbin/doc.go index 27b8999eaaf..17057e1bd03 100644 --- a/service/rbin/doc.go +++ b/service/rbin/doc.go @@ -4,16 +4,21 @@ // 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 -// a resource recovery feature that enables you to restore accidentally deleted -// snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are -// deleted, they are retained in the Recycle Bin for a time period that you -// specify. You can restore a resource from the Recycle Bin at any time before its +// and syntax for each of the actions and data types in Recycle Bin. +// +// Recycle Bin is a resource recovery feature that enables you to restore +// accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if +// your resources are deleted, they are retained in the Recycle Bin for a time +// period that you specify. +// +// You can restore a resource from the Recycle Bin at any time before its // retention period expires. After you restore a resource from the Recycle Bin, the // resource is removed from the Recycle Bin, and you can then use it in the same // 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/recycle-bin.html) -// in the Amazon Elastic Compute Cloud User Guide. +// information about Recycle Bin, see [Recycle Bin]in the Amazon Elastic Compute Cloud User +// Guide. +// +// [Recycle Bin]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html package rbin diff --git a/service/rbin/options.go b/service/rbin/options.go index 8ab81fcf059..a6df028a4fd 100644 --- a/service/rbin/options.go +++ b/service/rbin/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/rbin/types/enums.go b/service/rbin/types/enums.go index c90806ad665..13cd96c8f28 100644 --- a/service/rbin/types/enums.go +++ b/service/rbin/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for ConflictExceptionReason. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConflictExceptionReason) Values() []ConflictExceptionReason { return []ConflictExceptionReason{ "INVALID_RULE_STATE", @@ -28,8 +29,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -47,8 +49,9 @@ const ( // Values returns all known values for ResourceNotFoundExceptionReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceNotFoundExceptionReason) Values() []ResourceNotFoundExceptionReason { return []ResourceNotFoundExceptionReason{ "RULE_NOT_FOUND", @@ -64,8 +67,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -81,8 +85,9 @@ const ( ) // Values returns all known values for RetentionPeriodUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetentionPeriodUnit) Values() []RetentionPeriodUnit { return []RetentionPeriodUnit{ "DAYS", @@ -98,8 +103,9 @@ const ( ) // Values returns all known values for RuleStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleStatus) Values() []RuleStatus { return []RuleStatus{ "pending", @@ -116,8 +122,9 @@ const ( // Values returns all known values for ServiceQuotaExceededExceptionReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceQuotaExceededExceptionReason) Values() []ServiceQuotaExceededExceptionReason { return []ServiceQuotaExceededExceptionReason{ "SERVICE_QUOTA_EXCEEDED", @@ -132,8 +139,9 @@ const ( ) // Values returns all known values for UnlockDelayUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnlockDelayUnit) Values() []UnlockDelayUnit { return []UnlockDelayUnit{ "DAYS", @@ -150,6 +158,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/rbin/types/types.go b/service/rbin/types/types.go index 4dc9f792952..de8af5af331 100644 --- a/service/rbin/types/types.go +++ b/service/rbin/types/types.go @@ -61,12 +61,16 @@ 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 . diff --git a/service/rds/api_op_AddRoleToDBCluster.go b/service/rds/api_op_AddRoleToDBCluster.go index a60d020cbab..2532704db9d 100644 --- a/service/rds/api_op_AddRoleToDBCluster.go +++ b/service/rds/api_op_AddRoleToDBCluster.go @@ -40,8 +40,7 @@ type AddRoleToDBClusterInput struct { 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 . + // 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 61d5dfac79f..0bdedb76cf6 100644 --- a/service/rds/api_op_AddRoleToDBInstance.go +++ b/service/rds/api_op_AddRoleToDBInstance.go @@ -11,8 +11,11 @@ import ( ) // 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. +// 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{} @@ -36,8 +39,7 @@ type AddRoleToDBInstanceInput struct { DBInstanceIdentifier *string // 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 . + // associated with. For information about supported feature names, see DBEngineVersion. // // This member is required. FeatureName *string diff --git a/service/rds/api_op_AddSourceIdentifierToSubscription.go b/service/rds/api_op_AddSourceIdentifierToSubscription.go index 04a1e46f8fb..79eb325fd33 100644 --- a/service/rds/api_op_AddSourceIdentifierToSubscription.go +++ b/service/rds/api_op_AddSourceIdentifierToSubscription.go @@ -29,19 +29,28 @@ func (c *Client) AddSourceIdentifierToSubscription(ctx context.Context, params * type AddSourceIdentifierToSubscriptionInput struct { - // The identifier of the event source to be added. Constraints: + // 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. // // This member is required. diff --git a/service/rds/api_op_AddTagsToResource.go b/service/rds/api_op_AddTagsToResource.go index 76f233abbd7..da91bd022fc 100644 --- a/service/rds/api_op_AddTagsToResource.go +++ b/service/rds/api_op_AddTagsToResource.go @@ -13,9 +13,11 @@ 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) -// . +// 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]. +// +// [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 +36,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)]. + // + // [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 8e66e2e9db1..37ab3f670f7 100644 --- a/service/rds/api_op_ApplyPendingMaintenanceAction.go +++ b/service/rds/api_op_ApplyPendingMaintenanceAction.go @@ -30,26 +30,33 @@ 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 + // The pending maintenance action to apply to this resource. + // + // Valid Values: 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: + // 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. // // 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)]. + // + // [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 20797698874..ff1413389b8 100644 --- a/service/rds/api_op_AuthorizeDBSecurityGroupIngress.go +++ b/service/rds/api_op_AuthorizeDBSecurityGroupIngress.go @@ -17,18 +17,24 @@ import ( // ranges are available if the application accessing your database is running on // the internet. Required parameters for this API are one of CIDR range, // EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either -// EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize -// 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 +// EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). +// +// You can't authorize 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]. +// +// 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. +// more information, see [Migrate from EC2-Classic to a VPC]in the Amazon EC2 User Guide, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare], and [Moving a DB instance not in a VPC into a VPC] in the +// Amazon RDS User Guide. +// +// [Migrate from EC2-Classic to a VPC]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html +// [Wikipedia Tutorial]: http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing +// [EC2-Classic Networking is Retiring – Here’s How to Prepare]: http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/ +// [Moving a DB instance not in a VPC into a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html func (c *Client) AuthorizeDBSecurityGroupIngress(ctx context.Context, params *AuthorizeDBSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeDBSecurityGroupIngressOutput, error) { if params == nil { params = &AuthorizeDBSecurityGroupIngressInput{} @@ -76,8 +82,10 @@ 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 a9a2bb2c5cb..598c6822bc1 100644 --- a/service/rds/api_op_BacktrackDBCluster.go +++ b/service/rds/api_op_BacktrackDBCluster.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Aurora User Guide. This action applies only to Aurora MySQL DB -// clusters. +// +// For more information on backtracking, see [Backtracking an Aurora DB Cluster] in the Amazon Aurora User Guide. +// +// This action applies only to Aurora MySQL DB clusters. +// +// [Backtracking an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html func (c *Client) BacktrackDBCluster(ctx context.Context, params *BacktrackDBClusterInput, optFns ...func(*Options)) (*BacktrackDBClusterOutput, error) { if params == nil { params = &BacktrackDBClusterInput{} @@ -33,22 +36,35 @@ 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) + // format. For more information about ISO 8601, see the [ISO8601 Wikipedia page.] + // // 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 // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 + // // 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: + // 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. @@ -88,12 +104,16 @@ type BacktrackDBClusterOutput struct { 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. Status *string diff --git a/service/rds/api_op_CancelExportTask.go b/service/rds/api_op_CancelExportTask.go index 376b7227a64..728544632eb 100644 --- a/service/rds/api_op_CancelExportTask.go +++ b/service/rds/api_op_CancelExportTask.go @@ -40,14 +40,21 @@ type CancelExportTaskInput struct { noSmithyDocumentSerde } -// Contains the details of a snapshot or cluster export to Amazon S3. This data -// type is used as a response element in the DescribeExportTasks operation. +// Contains the details of a snapshot or cluster export to Amazon S3. +// +// This data type is used as a response element in the DescribeExportTasks +// operation. type CancelExportTaskOutput struct { - // The data exported from the snapshot or cluster. Valid Values: + // The data exported from the snapshot or cluster. + // + // Valid Values: + // // - 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. // @@ -91,11 +98,17 @@ type CancelExportTaskOutput struct { 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 Status *string diff --git a/service/rds/api_op_CopyDBClusterParameterGroup.go b/service/rds/api_op_CopyDBClusterParameterGroup.go index c63ff0656d1..d6213a3efad 100644 --- a/service/rds/api_op_CopyDBClusterParameterGroup.go +++ b/service/rds/api_op_CopyDBClusterParameterGroup.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies the specified DB cluster parameter group. You can't copy a default DB -// cluster parameter group. Instead, create a new custom DB cluster parameter -// group, which copies the default parameters and values for the specified DB -// cluster parameter group family. +// Copies the specified DB cluster parameter group. +// +// You can't copy a default DB cluster parameter group. Instead, create a new +// custom DB cluster parameter group, which copies the default parameters and +// values for the specified DB cluster parameter group family. func (c *Client) CopyDBClusterParameterGroup(ctx context.Context, params *CopyDBClusterParameterGroupInput, optFns ...func(*Options)) (*CopyDBClusterParameterGroupOutput, error) { if params == nil { params = &CopyDBClusterParameterGroupInput{} @@ -33,11 +34,15 @@ 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) - // in the Amazon Aurora User Guide. Constraints: + // parameter group. For information about creating an ARN, see [Constructing an ARN for Amazon RDS]in the Amazon + // Aurora User Guide. + // + // Constraints: + // // - Must specify a valid DB cluster parameter group. // + // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing + // // This member is required. SourceDBClusterParameterGroupIdentifier *string @@ -46,18 +51,26 @@ type CopyDBClusterParameterGroupInput struct { // This member is required. TargetDBClusterParameterGroupDescription *string - // The identifier for the copied DB cluster parameter group. Constraints: + // 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 + // // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -65,9 +78,10 @@ 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 2193db47c7c..517d64a09bf 100644 --- a/service/rds/api_op_CopyDBClusterSnapshot.go +++ b/service/rds/api_op_CopyDBClusterSnapshot.go @@ -13,19 +13,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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: +// // - 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 @@ -33,14 +40,20 @@ import ( // // 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) -// 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) -// 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) -// in the Amazon RDS User Guide. +// 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]in the Amazon Aurora User +// Guide. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [Copying a Snapshot]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error) { if params == nil { params = &CopyDBClusterSnapshotInput{} @@ -59,25 +72,40 @@ func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBCluste 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: + // 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) + // the copy, specify a valid DB cluster snapshot ARN. For more information, go to [Copying Snapshots Across Amazon Web Services Regions] // in the Amazon Aurora User Guide. + // // Example: my-cluster-snapshot1 // + // [Copying Snapshots Across Amazon Web Services Regions]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions + // // This member is required. SourceDBClusterSnapshotIdentifier *string // The identifier of the new DB cluster snapshot to create from the source DB - // cluster snapshot. This parameter isn't case-sensitive. Constraints: + // 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 // // This member is required. @@ -89,20 +117,26 @@ type CopyDBClusterSnapshotInput struct { // 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. + // 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 @@ -111,19 +145,25 @@ type CopyDBClusterSnapshotInput struct { // 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 - // setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored - // in other Amazon Web Services Regions. The presigned URL must be a valid request - // 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: + // encrypted DB cluster snapshot in the same Amazon Web Services Region. + // + // This setting applies only to Amazon Web Services GovCloud (US) Regions. It's + // ignored in other Amazon Web Services Regions. + // + // The presigned URL must be a valid request 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 @@ -132,22 +172,25 @@ type CopyDBClusterSnapshotInput struct { // 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 + // + // To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)] and [Signature Version 4 Signing Process]. + // + // 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. + // + // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html + // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The AWS region the resource is in. The presigned URL will be created with this // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // Used by the SDK's PresignURL autofill customization to specify the region the @@ -159,8 +202,10 @@ type CopyDBClusterSnapshotInput struct { type CopyDBClusterSnapshotOutput struct { - // Contains the details for an Amazon RDS DB cluster snapshot This data type is - // used as a response element in the DescribeDBClusterSnapshots action. + // Contains the details for an Amazon RDS 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/rds/api_op_CopyDBParameterGroup.go b/service/rds/api_op_CopyDBParameterGroup.go index d5300f30b2b..35a3b1db868 100644 --- a/service/rds/api_op_CopyDBParameterGroup.go +++ b/service/rds/api_op_CopyDBParameterGroup.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Copies the specified DB parameter group. You can't copy a default DB parameter -// group. Instead, create a new custom DB parameter group, which copies the default -// parameters and values for the specified DB parameter group family. +// Copies the specified DB parameter group. +// +// You can't copy a default DB parameter group. Instead, create a new custom DB +// parameter group, which copies the default parameters and values for the +// specified DB parameter group family. func (c *Client) CopyDBParameterGroup(ctx context.Context, params *CopyDBParameterGroupInput, optFns ...func(*Options)) (*CopyDBParameterGroupOutput, error) { if params == nil { params = &CopyDBParameterGroupInput{} @@ -32,10 +34,14 @@ 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) - // in the Amazon RDS User Guide. Constraints: + // creating an ARN, see [Constructing an ARN for Amazon RDS]in the Amazon RDS User Guide. + // + // Constraints: + // // - Must specify a valid DB parameter group. // + // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing + // // This member is required. SourceDBParameterGroupIdentifier *string @@ -44,18 +50,26 @@ type CopyDBParameterGroupInput struct { // This member is required. TargetDBParameterGroupDescription *string - // The identifier for the copied DB parameter group. Constraints: + // 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 + // // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -63,8 +77,10 @@ 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 314943df0cb..e9ebe5c8d73 100644 --- a/service/rds/api_op_CopyDBSnapshot.go +++ b/service/rds/api_op_CopyDBSnapshot.go @@ -14,12 +14,18 @@ import ( ) // Copies the specified DB snapshot. The source DB snapshot must be in the -// available state. You can copy a snapshot from one Amazon Web Services Region to -// 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) -// in the Amazon RDS User Guide. +// available state. +// +// You can copy a snapshot from one Amazon Web Services Region to 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] in the Amazon RDS User Guide. +// +// [Copying a DB Snapshot]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot func (c *Client) CopyDBSnapshot(ctx context.Context, params *CopyDBSnapshotInput, optFns ...func(*Options)) (*CopyDBSnapshotOutput, error) { if params == nil { params = &CopyDBSnapshotInput{} @@ -37,28 +43,46 @@ 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 + // 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: + // 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. - // Example: rds:mydb-2012-04-02-00-01 Example: + // + // Example: rds:mydb-2012-04-02-00-01 + // + // Example: // arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 // // This member is required. SourceDBSnapshotIdentifier *string - // The identifier for the copy of the snapshot. Constraints: + // 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 + // // Example: my-db-snapshot // // This member is required. @@ -76,83 +100,103 @@ type CopyDBSnapshotInput struct { // The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The // Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or - // alias name for the KMS key. If you copy an encrypted DB snapshot from your - // Amazon Web Services account, you can specify a value for this parameter to - // encrypt the copy with a new KMS key. If you don't specify a value for this - // parameter, then the copy of the DB snapshot is encrypted with the same Amazon - // Web Services KMS key as the source DB snapshot. If you copy an encrypted DB - // snapshot that is shared from another Amazon Web Services account, then you must - // specify a value for this parameter. If you specify this parameter when you copy - // an unencrypted snapshot, the copy is encrypted. If you copy an encrypted - // snapshot to a different Amazon Web Services Region, then you must specify an - // Amazon Web Services KMS key identifier for 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. + // alias name for the KMS key. + // + // If you copy an encrypted DB snapshot from your Amazon Web Services account, you + // can specify a value for this parameter to encrypt the copy with a new KMS key. + // If you don't specify a value for this parameter, then the copy of the DB + // snapshot is encrypted with the same Amazon Web Services KMS key as the source DB + // snapshot. + // + // If you copy an encrypted DB snapshot that is shared from another Amazon Web + // Services account, then you must specify a value for this parameter. + // + // If you specify this parameter when you copy an unencrypted snapshot, the copy + // is encrypted. + // + // If you copy an encrypted snapshot to a different Amazon Web Services Region, + // then you must specify an Amazon Web Services KMS key identifier for 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. KmsKeyId *string - // The name of an option group to associate with the copy of the snapshot. Specify - // this option if you are copying a snapshot from one Amazon Web Services Region to - // 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) - // in the Amazon RDS User Guide. + // The name of an option group to associate with the copy of the snapshot. + // + // Specify this option if you are copying a snapshot from one Amazon Web Services + // Region to 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]in the Amazon RDS User Guide. + // + // [Option group considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options OptionGroupName *string // When you are copying a snapshot from one Amazon Web Services GovCloud (US) // Region to another, the URL that contains a Signature Version 4 signed request // for the CopyDBSnapshot API operation in the source Amazon Web Services Region - // that contains the source DB snapshot to copy. This setting applies only to - // Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web - // Services Regions. You must specify this parameter when you copy an encrypted DB - // snapshot from another Amazon Web Services Region by using the Amazon RDS API. - // Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the - // same Amazon Web Services Region. The presigned URL must be a valid request 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: + // that contains the source DB snapshot to copy. + // + // This setting applies only to Amazon Web Services GovCloud (US) Regions. It's + // ignored in other Amazon Web Services Regions. + // + // You must specify this parameter when you copy an encrypted DB snapshot from + // another Amazon Web Services Region by using the Amazon RDS API. Don't specify + // PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon + // Web Services Region. + // + // The presigned URL must be a valid request 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: + // // - 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 + // 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 + // 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)] and [Signature Version 4 Signing Process]. + // + // 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. + // + // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html + // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The AWS region the resource is in. The presigned URL will be created with this // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // The external custom Availability Zone (CAZ) identifier for the target CAZ. + // // Example: rds-caz-aiqhTgQv . TargetCustomAvailabilityZone *string @@ -165,8 +209,9 @@ type CopyDBSnapshotInput struct { type CopyDBSnapshotOutput struct { - // Contains the details of an Amazon RDS DB snapshot. This data type is used as a - // response element in the DescribeDBSnapshots action. + // Contains the details of an Amazon RDS DB snapshot. + // + // This data type is used as a response element in the DescribeDBSnapshots action. DBSnapshot *types.DBSnapshot // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CopyOptionGroup.go b/service/rds/api_op_CopyOptionGroup.go index a8512a13f2a..8ef5d12e8c1 100644 --- a/service/rds/api_op_CopyOptionGroup.go +++ b/service/rds/api_op_CopyOptionGroup.go @@ -29,7 +29,10 @@ func (c *Client) CopyOptionGroup(ctx context.Context, params *CopyOptionGroupInp type CopyOptionGroupInput struct { - // The identifier for the source option group. Constraints: + // The identifier for the source option group. + // + // Constraints: + // // - Must specify a valid option group. // // This member is required. @@ -40,18 +43,26 @@ type CopyOptionGroupInput struct { // This member is required. TargetOptionGroupDescription *string - // The identifier for the copied option group. Constraints: + // 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 + // // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_CreateBlueGreenDeployment.go b/service/rds/api_op_CreateBlueGreenDeployment.go index fc1626d0432..04ee34dbca6 100644 --- a/service/rds/api_op_CreateBlueGreenDeployment.go +++ b/service/rds/api_op_CreateBlueGreenDeployment.go @@ -11,21 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a blue/green deployment. A blue/green deployment creates a staging -// environment that copies the production environment. In a blue/green deployment, -// the blue environment is the current production environment. The green -// environment is the staging environment. The staging environment stays in sync -// with the current production environment using logical replication. You can make -// changes to the databases in the green environment without affecting production -// workloads. For example, you can upgrade the major or minor DB engine version, -// change database parameters, or make schema changes in the staging environment. -// 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) -// in the Amazon Aurora User Guide. +// Creates a blue/green deployment. +// +// A blue/green deployment creates a staging environment that copies the +// production environment. In a blue/green deployment, the blue environment is the +// current production environment. The green environment is the staging +// environment. The staging environment stays in sync with the current production +// environment using logical replication. +// +// You can make changes to the databases in the green environment without +// affecting production workloads. For example, you can upgrade the major or minor +// DB engine version, change database parameters, or make schema changes in the +// staging environment. 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] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html func (c *Client) CreateBlueGreenDeployment(ctx context.Context, params *CreateBlueGreenDeploymentInput, optFns ...func(*Options)) (*CreateBlueGreenDeploymentOutput, error) { if params == nil { params = &CreateBlueGreenDeploymentInput{} @@ -43,18 +48,23 @@ func (c *Client) CreateBlueGreenDeployment(ctx context.Context, params *CreateBl type CreateBlueGreenDeploymentInput struct { - // The name of the blue/green deployment. Constraints: + // 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. // // This member is required. BlueGreenDeploymentName *string - // The Amazon Resource Name (ARN) of the source production database. Specify the - // database that you want to clone. The blue/green deployment creates this database - // in the green environment. You can make updates to the database in the green - // environment, such as an engine version upgrade. When you are ready, you can - // switch the database in the green environment to be the production database. + // The Amazon Resource Name (ARN) of the source production database. + // + // Specify the database that you want to clone. The blue/green deployment creates + // this database in the green environment. You can make updates to the database in + // the green environment, such as an engine version upgrade. When you are ready, + // you can switch the database in the green environment to be the production + // database. // // This member is required. Source *string @@ -63,32 +73,37 @@ type CreateBlueGreenDeploymentInput struct { Tags []types.Tag // The DB cluster parameter group associated with the Aurora DB cluster in the - // green environment. To test parameter changes, specify a DB cluster parameter - // group that is different from the one associated with the source DB cluster. + // green environment. + // + // To test parameter changes, specify a DB cluster parameter group that is + // different from the one associated with the source DB cluster. TargetDBClusterParameterGroupName *string - // Specify the DB instance class for the databases in the green environment. This - // parameter only applies to RDS DB instances, because DB instances within an + // Specify the DB instance class for the databases in the green environment. + // + // This parameter only applies to RDS DB instances, because DB instances within an // Aurora DB cluster can have multiple different instance classes. If you're // creating a blue/green deployment from an Aurora DB cluster, don't specify this // parameter. After the green environment is created, you can individually modify // the instance classes of the DB instances within the green DB cluster. TargetDBInstanceClass *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 - // version to upgrade to in the green environment. + // The engine version of the database in the green environment. + // + // Specify the engine version to upgrade to in the green environment. TargetEngineVersion *string // Whether to upgrade the storage file system configuration on the green database. // This option migrates the green DB instance from the older 32-bit file system to - // the preferred configuration. For more information, see Upgrading the storage - // file system for a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem) - // . + // the preferred configuration. For more information, see [Upgrading the storage file system for a DB instance]. + // + // [Upgrading the storage file system for a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem UpgradeTargetStorageConfig *bool noSmithyDocumentSerde @@ -96,11 +111,12 @@ type CreateBlueGreenDeploymentInput struct { type CreateBlueGreenDeploymentOutput struct { - // 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) - // in the Amazon Aurora User Guide. + // Details about a blue/green deployment. + // + // For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon + // Aurora User Guide. + // + // [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html BlueGreenDeployment *types.BlueGreenDeployment // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateCustomDBEngineVersion.go b/service/rds/api_op_CreateCustomDBEngineVersion.go index 1aa7ced921c..928c0a41412 100644 --- a/service/rds/api_op_CreateCustomDBEngineVersion.go +++ b/service/rds/api_op_CreateCustomDBEngineVersion.go @@ -31,9 +31,13 @@ func (c *Client) CreateCustomDBEngineVersion(ctx context.Context, params *Create type CreateCustomDBEngineVersionInput struct { // The database engine. RDS Custom for Oracle supports the following values: + // // - custom-oracle-ee + // // - custom-oracle-ee-cdb + // // - custom-oracle-se2 + // // - custom-oracle-se2-cdb // // This member is required. @@ -62,34 +66,46 @@ type CreateCustomDBEngineVersionInput struct { // The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI // ID is required to create a CEV. For RDS Custom for Oracle, the default is the // most recent AMI available, but you can specify an AMI ID that was used in a - // different Oracle CEV. Find the AMIs used by your CEVs by calling the - // DescribeDBEngineVersions (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html) - // operation. + // different Oracle CEV. Find the AMIs used by your CEVs by calling the [DescribeDBEngineVersions]operation. + // + // [DescribeDBEngineVersions]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html ImageId *string // The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric - // encryption KMS key is required for RDS Custom, but optional for Amazon RDS. If - // 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) - // 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 + // encryption KMS key is required for RDS Custom, but optional for Amazon RDS. + // + // If 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] + // 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. + // + // [Creating a symmetric encryption KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk KMSKeyId *string // The CEV manifest, which is a JSON document that describes the installation .zip // 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 . + // + // The following JSON fields are valid: + // + // MediaImportTemplateVersion Version of the 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) - // in the Amazon RDS User Guide. + // + // 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] in the Amazon RDS User Guide. + // + // [Creating the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest Manifest *string // The ARN of a CEV to use as a source for creating a new CEV. You can specify a @@ -98,8 +114,9 @@ type CreateCustomDBEngineVersionInput struct { // specify SourceCustomDbEngineVersionIdentifier . SourceCustomDbEngineVersionIdentifier *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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // Specifies whether to use the latest service-provided Amazon Machine Image (AMI) @@ -121,8 +138,9 @@ 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) - // in the Amazon RDS User Guide. + // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. + // + // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. @@ -175,11 +193,13 @@ type CreateCustomDBEngineVersionOutput struct { // 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) - // in the Amazon Aurora User Guide. + // A list of the supported CA certificate identifiers. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName @@ -189,14 +209,21 @@ 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 - // SupportedFeatureNames in the output. + // 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 // A list of the character sets supported by the Oracle DB engine for the @@ -227,8 +254,9 @@ type CreateCustomDBEngineVersionOutput struct { // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By - // default, write operations aren't allowed on reader DB instances. Valid for: - // Aurora DB clusters only + // default, write operations aren't allowed on reader DB instances. + // + // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified @@ -242,8 +270,9 @@ type CreateCustomDBEngineVersionOutput struct { // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html 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 591d16975b2..6b40a9d85b8 100644 --- a/service/rds/api_op_CreateDBCluster.go +++ b/service/rds/api_op_CreateDBCluster.go @@ -13,20 +13,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// 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] // 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) -// 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) -// in the Amazon RDS User Guide. +// 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?] +// 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]in the Amazon RDS +// User Guide. +// +// [CreateDBInstance]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInput, optFns ...func(*Options)) (*CreateDBClusterOutput, error) { if params == nil { params = &CreateDBClusterInput{} @@ -45,86 +51,140 @@ func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInp type CreateDBClusterInput struct { // The identifier for this DB cluster. This parameter is stored as a lowercase - // string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // string. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // // Constraints: + // // - Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ // DB clusters) 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 - // The database engine to use for this DB cluster. Valid for Cluster Type: Aurora - // DB clusters and Multi-AZ DB clusters Valid Values: aurora-mysql | - // aurora-postgresql | mysql | postgres + // The database engine to use for this DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres // // This member is required. Engine *string // The amount of storage in gibibytes (GiB) to allocate to each DB instance in the - // Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This - // setting is required to create a Multi-AZ DB cluster. + // Multi-AZ DB cluster. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // This setting is required to create a Multi-AZ DB cluster. AllocatedStorage *int32 // Specifies whether minor engine upgrades are applied automatically to the DB // cluster during the maintenance window. By default, minor engine upgrades are - // applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only + // applied automatically. + // + // Valid for Cluster Type: Multi-AZ DB clusters only AutoMinorVersionUpgrade *bool // 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) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only + // created. + // + // For information on Amazon Web Services Regions and Availability Zones, see [Choosing the Regions and Availability Zones] in + // the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [Choosing the Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZones []string // The target backtrack window, in seconds. To disable backtracking, set this - // value to 0 . Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0 + // value to 0 . + // + // Valid for Cluster Type: Aurora MySQL DB clusters only + // + // Default: 0 + // // Constraints: + // // - 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 are retained. Valid for Cluster - // Type: Aurora DB clusters and Multi-AZ DB clusters Default: 1 Constraints: + // The number of days for which automated backups are retained. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Default: 1 + // + // Constraints: + // // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 // The CA certificate identifier to use for the DB cluster'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. Valid for Cluster Type: Multi-AZ DB clusters + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide. + // + // Valid for Cluster Type: Multi-AZ DB clusters + // + // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // The name of the character set ( CharacterSet ) to associate the DB cluster with. + // // Valid for Cluster Type: Aurora DB clusters only CharacterSetName *string // Specifies whether to copy all tags from the DB cluster to snapshots of the DB - // cluster. The default is not to copy them. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters + // cluster. The default is not to copy them. + // + // Valid for Cluster Type: 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) - // in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB - // cluster. Valid for Cluster Type: Multi-AZ DB clusters only + // 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] + // in the Amazon RDS User Guide. + // + // This setting is required to create a Multi-AZ DB cluster. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // [DB instance class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *string // The name of the DB cluster parameter group to associate with this DB cluster. // If you don't specify a value, then the default DB cluster parameter group for - // the specified DB engine and version is used. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters Constraints: + // the specified DB engine and version is used. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - If supplied, must match the name of an existing DB cluster parameter group. DBClusterParameterGroupName *string - // A DB subnet group to associate with this DB cluster. This setting is required - // to create a Multi-AZ DB cluster. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters Constraints: + // A DB subnet group to associate with this DB cluster. + // + // This setting is required to create a Multi-AZ DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - Must match the name of an existing DB subnet group. + // // - Must not be default . + // // Example: mydbsubnetgroup DBSubnetGroupName *string @@ -133,245 +193,396 @@ type CreateDBClusterInput struct { // The name for your database of up to 64 alphanumeric characters. If you don't // provide a name, Amazon RDS doesn't create a database in the DB cluster you are - // creating. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // creating. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DatabaseName *string // Specifies whether the DB cluster has deletion protection enabled. The database // can't be deleted when deletion protection is enabled. By default, deletion - // protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters + // protection isn't enabled. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB 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) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only + // 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] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [Kerberos authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // The name of the IAM role to use when making API calls to the Directory Service. + // // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *string // The list of log types that need to be enabled for exporting to CloudWatch Logs. - // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The - // following values are valid for each DB engine: + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // The following values are valid for each DB engine: + // // - Aurora MySQL - audit | error | general | slowquery + // // - Aurora PostgreSQL - postgresql + // // - RDS for MySQL - error | general | slowquery + // // - RDS for PostgreSQL - postgresql | upgrade - // 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) - // in the Amazon Aurora User Guide. + // + // For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon RDS User Guide. + // + // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon Aurora User Guide. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable this DB cluster to forward write operations to the // primary cluster of a global cluster (Aurora global database). 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 cluster, and the - // resulting changes are replicated back to this cluster. For the primary DB - // cluster of an Aurora global database, this value is used immediately if the - // primary is demoted by a global cluster API operation, but it does nothing until - // then. Valid for Cluster Type: Aurora DB clusters only + // 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 cluster, and the resulting changes are replicated + // back to this cluster. For the primary DB cluster of an Aurora global database, + // this value is used immediately if the primary is demoted by a global cluster API + // operation, but it does nothing until then. + // + // Valid for Cluster Type: Aurora DB clusters only EnableGlobalWriteForwarding *bool // Specifies whether to enable the HTTP endpoint for the DB cluster. By default, - // the HTTP endpoint isn't enabled. When enabled, the HTTP endpoint provides a - // connectionless web service API (RDS Data API) for running SQL queries on the DB - // cluster. You can also query your database from inside the RDS console with the - // RDS query editor. RDS Data API is supported with the following DB clusters: + // the HTTP endpoint isn't enabled. + // + // When enabled, the HTTP endpoint provides a connectionless web service API (RDS + // Data API) for running SQL queries on the DB cluster. You can also query your + // database from inside the RDS console with the RDS query editor. + // + // RDS Data API is supported with the following DB clusters: + // // - Aurora PostgreSQL Serverless v2 and provisioned + // // - Aurora PostgreSQL and Aurora MySQL Serverless v1 - // For more information, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only + // + // For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html EnableHttpEndpoint *bool // Specifies 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 Cluster Type: Aurora DB clusters only + // enabled. + // + // For more information, see [IAM Database Authentication] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Aurora Limitless Database. You must enable Aurora - // Limitless Database to create a DB shard group. Valid for: Aurora DB clusters - // only + // Limitless Database to create a DB shard group. + // + // Valid for: Aurora DB clusters only EnableLimitlessDatabase *bool // Specifies whether read replicas can forward write operations to the writer DB // instance in the DB cluster. By default, write operations aren't allowed on - // reader DB instances. Valid for: Aurora DB clusters only + // reader DB instances. + // + // Valid for: Aurora DB clusters only EnableLocalWriteForwarding *bool - // Specifies 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) - // in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only + // Specifies whether to turn on Performance Insights for the DB cluster. + // + // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool - // The DB engine mode of the DB cluster, either provisioned or serverless . The - // serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora - // Serverless v2 DB clusters use the provisioned engine mode. For information - // about limitations and requirements for Serverless DB clusters, 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) + // The DB engine mode of the DB cluster, either provisioned or serverless . + // + // The serverless engine mode only applies for Aurora Serverless v1 DB clusters. + // Aurora Serverless v2 DB clusters use the provisioned engine mode. + // + // For information about limitations and requirements for Serverless DB clusters, + // see the following sections in the Amazon Aurora User Guide: + // + // [Limitations of Aurora Serverless v1] + // + // [Requirements for Aurora Serverless v2] + // // Valid for Cluster Type: 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 EngineMode *string - // The version number of the database engine to use. To list all of the available - // engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL - // 8.0-compatible), use the following command: aws rds describe-db-engine-versions - // --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" You can supply - // either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 - // or version 3, respectively. 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 - // "DBEngineVersions[].EngineVersion" To list all of the available engine versions - // for RDS for MySQL, use the following command: aws rds - // describe-db-engine-versions --engine mysql --query - // "DBEngineVersions[].EngineVersion" To list all of the available engine versions - // for RDS for PostgreSQL, use the following command: aws rds - // describe-db-engine-versions --engine postgres --query - // "DBEngineVersions[].EngineVersion" For information about a specific engine, see - // the following topics: - // - Aurora MySQL - see Database 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 - 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. - // - RDS for 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. - // - RDS for PostgreSQL - see Amazon RDS for PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) - // in the Amazon RDS User Guide. + // The version number of the database engine to use. + // + // To list all of the available engine versions for Aurora MySQL version 2 + // (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following + // command: + // + // aws rds describe-db-engine-versions --engine aurora-mysql --query + // "DBEngineVersions[].EngineVersion" + // + // You can supply either 5.7 or 8.0 to use the default engine version for Aurora + // MySQL version 2 or version 3, respectively. + // + // 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 + // "DBEngineVersions[].EngineVersion" + // + // To list all of the available engine versions for RDS for MySQL, use the + // following command: + // + // aws rds describe-db-engine-versions --engine mysql --query + // "DBEngineVersions[].EngineVersion" + // + // To list all of the available engine versions for RDS for PostgreSQL, use the + // following command: + // + // aws rds describe-db-engine-versions --engine postgres --query + // "DBEngineVersions[].EngineVersion" + // + // For information about a specific engine, see the following topics: + // + // - Aurora MySQL - see [Database engine updates for Amazon Aurora MySQL]in the Amazon Aurora User Guide. + // + // - Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and engine versions]in the Amazon Aurora User Guide. + // + // - RDS for MySQL - see [Amazon RDS for MySQL]in the Amazon RDS User Guide. + // + // - RDS for PostgreSQL - see [Amazon RDS for PostgreSQL]in the Amazon RDS User Guide. + // // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // [Database engine updates for Amazon Aurora MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html + // [Amazon RDS for PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts + // [Amazon RDS for MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt + // [Amazon Aurora PostgreSQL releases and engine versions]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html EngineVersion *string // The global cluster ID of an Aurora cluster that becomes the primary cluster in - // the new global database cluster. Valid for Cluster Type: Aurora DB clusters only + // the new global database cluster. + // + // Valid for Cluster Type: Aurora DB clusters only GlobalClusterIdentifier *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 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. Valid for Cluster Type: Multi-AZ DB clusters only Constraints: + // initially allocated for each DB instance in the Multi-AZ DB cluster. + // + // For information about valid IOPS values, see [Provisioned IOPS storage] in the Amazon RDS User Guide. + // + // This setting is required to create a Multi-AZ DB cluster. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // Constraints: + // // - Must be a multiple between .5 and 50 of the storage amount for the DB // cluster. + // + // [Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 - // The Amazon Web Services KMS key identifier for 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. When a KMS key isn't specified in - // KmsKeyId : + // The Amazon Web Services KMS key identifier for 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. + // + // When a KMS key isn't specified in KmsKeyId : + // // - If ReplicationSourceIdentifier identifies an encrypted source, then Amazon // RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your // default KMS key. + // // - If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier // isn't specified, 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. If you create a read replica of an encrypted DB cluster in - // another Amazon Web Services Region, make sure to 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. + // Services Region. + // + // If you create a read replica of an encrypted DB cluster in another Amazon Web + // Services Region, make sure to 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters KmsKeyId *string // Specifies 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) - // 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) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters Constraints: + // Secrets Manager. + // + // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon + // Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool - // The password for the master database user. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters Constraints: + // The password for the master database user. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - Must contain from 8 to 41 characters. + // // - Can contain any printable ASCII character except "/", """, or "@". + // // - Can't be specified if ManageMasterUserPassword is turned on. 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 the master user password is managed by RDS in Amazon - // 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 - // 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. - // 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // automatically generated and managed in Amazon Web Services Secrets Manager. + // + // 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 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 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. + // + // 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string - // The name of the master user for the DB cluster. Valid for Cluster Type: Aurora - // DB clusters and Multi-AZ DB clusters Constraints: + // The name of the master user for the DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // 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. MasterUsername *string // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB cluster. To turn off collecting Enhanced Monitoring - // metrics, specify 0 . If MonitoringRoleArn is specified, also set - // MonitoringInterval to a value other than 0 . Valid for Cluster Type: Multi-AZ DB - // clusters only Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0 + // metrics, specify 0 . + // + // If MonitoringRoleArn is specified, also set MonitoringInterval to a value other + // than 0 . + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + // + // Default: 0 MonitoringInterval *int32 // 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 Cluster Type: Multi-AZ DB - // clusters only + // monitoring role, see [Setting up and enabling Enhanced Monitoring]in the Amazon RDS User Guide. + // + // If MonitoringInterval is set to a value other than 0 , supply a + // MonitoringRoleArn value. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // [Setting up and enabling Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling MonitoringRoleArn *string - // The network type of the DB cluster. 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 Cluster Type: Aurora DB clusters only + // The network type of the DB cluster. + // + // 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] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // // Valid Values: IPV4 | DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string - // The option group to associate the DB cluster with. DB clusters are associated - // with a default option group that can't be modified. + // The option group to associate the DB cluster with. + // + // DB clusters are associated with a default option group that can't be modified. OptionGroupName *string // 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 Cluster Type: Multi-AZ DB clusters only + // 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 Cluster Type: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. Valid for Cluster Type: - // Multi-AZ DB clusters only Valid Values: + // The number of days to retain Performance Insights data. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 - // Default: 7 days If you specify a retention period that isn't valid, such as 94 , - // Amazon RDS issues an error. + // + // Default: 7 days + // + // If you specify a retention period that isn't valid, such as 94 , Amazon RDS + // issues an error. PerformanceInsightsRetentionPeriod *int32 // The port number on which the instances in the DB cluster accept connections. - // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid - // Values: 1150-65535 Default: + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Valid Values: 1150-65535 + // + // Default: + // // - RDS for MySQL and Aurora MySQL - 3306 + // // - RDS for PostgreSQL and Aurora PostgreSQL - 5432 Port *int32 @@ -380,77 +591,118 @@ type CreateDBClusterInput struct { // 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: + // 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 + // + // To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)] and [Signature Version 4 Signing Process]. + // + // 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. + // // Valid for Cluster Type: Aurora DB clusters only + // + // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html + // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The daily time range during which automated backups are created if automated - // backups are enabled using the BackupRetentionPeriod parameter. Valid for - // Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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: + // backups are enabled using the BackupRetentionPeriod parameter. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // 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]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. + // + // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow PreferredBackupWindow *string - // The weekly time range during which system maintenance can occur. Valid for - // Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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) - // in the Amazon Aurora User Guide. Constraints: + // The weekly time range during which system maintenance can occur. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // 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]in the Amazon Aurora User Guide. + // + // Constraints: + // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . + // // - Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun . + // // - Must be in Universal Coordinated Time (UTC). + // // - Must be at least 30 minutes. + // + // [Adjusting the Preferred DB Cluster Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora PreferredMaintenanceWindow *string - // Specifies whether the DB cluster is publicly accessible. When the DB cluster is - // publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security 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 cluster isn't publicly accessible, it is an - // internal DB cluster with a DNS name that resolves to a private IP address. Valid - // for Cluster Type: Multi-AZ DB clusters only Default: The default behavior varies - // depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't - // specified, and PubliclyAccessible isn't specified, the following applies: + // Specifies whether the DB cluster is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // 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 cluster isn't publicly accessible, it is an internal DB cluster + // with a DNS name that resolves to a private IP address. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // 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. PubliclyAccessible *bool @@ -459,51 +711,73 @@ type CreateDBClusterInput struct { RdsCustomClusterConfiguration *types.RdsCustomClusterConfiguration // The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this - // DB cluster is created as a read replica. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters + // DB cluster is created as a read replica. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ReplicationSourceIdentifier *string // For DB clusters in serverless DB engine mode, the scaling properties of the DB - // cluster. Valid for Cluster Type: Aurora DB clusters only + // cluster. + // + // Valid for Cluster Type: 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) - // in the Amazon Aurora User Guide. + // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + // + // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // The AWS region the resource is in. The presigned URL will be created with this // region, if the PresignURL member is empty set. SourceRegion *string - // Specifies whether the DB cluster is encrypted. Valid for Cluster Type: Aurora - // DB clusters and Multi-AZ DB clusters + // Specifies whether the DB cluster is encrypted. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters StorageEncrypted *bool - // The storage type to associate with the DB cluster. For information on storage - // types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB - // clusters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type) - // . For information on storage types for Multi-AZ DB clusters, see Settings for - // creating Multi-AZ DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings) - // . This setting is required to create a Multi-AZ DB cluster. When specified for a - // Multi-AZ DB cluster, a value for the Iops parameter is required. Valid for - // Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: + // The storage type to associate with the DB cluster. + // + // For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters]. For information + // on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters]. + // + // This setting is required to create a Multi-AZ DB cluster. + // + // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is + // required. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Valid Values: + // // - Aurora DB clusters - aurora | aurora-iopt1 + // // - Multi-AZ DB clusters - io1 | io2 | gp3 + // // Default: + // // - Aurora DB clusters - aurora + // // - Multi-AZ DB clusters - io1 + // // When you create an Aurora DB cluster with the storage type set to aurora-iopt1 , // the storage type is returned in the response. The storage type isn't returned // when you set it to aurora . + // + // [Storage configurations for Amazon Aurora DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type + // [Settings for creating Multi-AZ DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings StorageType *string - // Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters - // and Multi-AZ DB clusters + // Tags to assign to the DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Tags []types.Tag - // A list of EC2 VPC security groups to associate with this DB cluster. Valid for - // Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // A list of EC2 VPC security groups to associate with this DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string // Used by the SDK's PresignURL autofill customization to specify the region the @@ -515,20 +789,27 @@ type CreateDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBClusterEndpoint.go b/service/rds/api_op_CreateDBClusterEndpoint.go index d12c6b5e31e..c84c1a66bc8 100644 --- a/service/rds/api_op_CreateDBClusterEndpoint.go +++ b/service/rds/api_op_CreateDBClusterEndpoint.go @@ -12,7 +12,9 @@ import ( ) // Creates a new custom endpoint and associates it with an Amazon Aurora DB -// cluster. This action applies only to Aurora DB clusters. +// cluster. +// +// This action applies only to Aurora DB clusters. func (c *Client) CreateDBClusterEndpoint(ctx context.Context, params *CreateDBClusterEndpointInput, optFns ...func(*Options)) (*CreateDBClusterEndpointOutput, error) { if params == nil { params = &CreateDBClusterEndpointInput{} @@ -64,9 +66,13 @@ 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 // // For the data structure that represents Amazon RDS DB instance endpoints, see diff --git a/service/rds/api_op_CreateDBClusterParameterGroup.go b/service/rds/api_op_CreateDBClusterParameterGroup.go index 310bc50040c..1dff8a74953 100644 --- a/service/rds/api_op_CreateDBClusterParameterGroup.go +++ b/service/rds/api_op_CreateDBClusterParameterGroup.go @@ -11,33 +11,43 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB cluster parameter group. Parameters in a DB cluster parameter -// group apply to all of the instances in a DB cluster. A DB cluster parameter -// 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 +// Creates a new DB cluster parameter group. +// +// Parameters in a DB cluster parameter group apply to all of the instances in a +// DB cluster. +// +// A DB cluster parameter 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 -// 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 -// 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 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 RDS console (https://console.aws.amazon.com/rds/) or the +// 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 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 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 RDS console]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) -// 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) -// in the Amazon RDS User Guide. +// group has been created or modified. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [Amazon RDS console]: https://console.aws.amazon.com/rds/ +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *CreateDBClusterParameterGroupInput, optFns ...func(*Options)) (*CreateDBClusterParameterGroupOutput, error) { if params == nil { params = &CreateDBClusterParameterGroupInput{} @@ -55,8 +65,12 @@ func (c *Client) CreateDBClusterParameterGroup(ctx context.Context, params *Crea type CreateDBClusterParameterGroupInput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. // // This member is required. @@ -65,19 +79,46 @@ type CreateDBClusterParameterGroupInput struct { // The DB cluster parameter group family name. A DB cluster parameter group can be // 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: - // aurora-mysql5.7 , aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 - // RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 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 aurora-postgresql The - // output contains duplicates. The following are the valid DB engine values: + // compatible with that DB cluster parameter group family. + // + // Aurora MySQL + // + // Example: aurora-mysql5.7 , aurora-mysql8.0 + // + // Aurora PostgreSQL + // + // Example: aurora-postgresql14 + // + // RDS for MySQL + // + // Example: mysql8.0 + // + // RDS for PostgreSQL + // + // Example: postgres13 + // + // 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 aurora-postgresql + // + // The output contains duplicates. + // + // The following are the valid DB engine values: + // // - aurora-mysql + // // - aurora-postgresql + // // - mysql + // // - postgres // // This member is required. @@ -96,9 +137,10 @@ 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 885d08a1d61..2fab456bb9e 100644 --- a/service/rds/api_op_CreateDBClusterSnapshot.go +++ b/service/rds/api_op_CreateDBClusterSnapshot.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// in the Amazon RDS User Guide. +// Creates a snapshot of a DB cluster. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) CreateDBClusterSnapshot(ctx context.Context, params *CreateDBClusterSnapshotInput, optFns ...func(*Options)) (*CreateDBClusterSnapshotOutput, error) { if params == nil { params = &CreateDBClusterSnapshotInput{} @@ -34,18 +37,28 @@ 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 isn't - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DBCluster. + // // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string // The identifier of the DB cluster snapshot. This parameter is stored as a - // lowercase string. Constraints: + // 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-snapshot1 // // This member is required. @@ -59,8 +72,10 @@ type CreateDBClusterSnapshotInput struct { type CreateDBClusterSnapshotOutput struct { - // Contains the details for an Amazon RDS DB cluster snapshot This data type is - // used as a response element in the DescribeDBClusterSnapshots action. + // Contains the details for an Amazon RDS 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/rds/api_op_CreateDBInstance.go b/service/rds/api_op_CreateDBInstance.go index a6a3f54ecf3..6a10755eaad 100644 --- a/service/rds/api_op_CreateDBInstance.go +++ b/service/rds/api_op_CreateDBInstance.go @@ -11,14 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) +// 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] 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] // in the Amazon Aurora User Guide. +// +// [Creating an Amazon Aurora DB cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html +// [Creating an Amazon RDS DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceInput, optFns ...func(*Options)) (*CreateDBInstanceOutput, error) { if params == nil { params = &CreateDBInstanceInput{} @@ -39,256 +45,429 @@ 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) - // in the Amazon Aurora User Guide. + // availability for your engine, see [DB instance classes]in the Amazon RDS User Guide or [Aurora DB instance classes] in the + // Amazon Aurora User Guide. + // + // [Aurora DB instance classes]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html + // [DB instance classes]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html // // This member is required. DBInstanceClass *string // The identifier for this DB instance. This parameter is stored as a lowercase - // string. Constraints: + // 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: mydbinstance // // This member is required. DBInstanceIdentifier *string - // The database engine to use for this DB instance. Not every database engine is - // available in every Amazon Web Services Region. Valid Values: + // The database engine to use for this DB instance. + // + // Not every database engine is available in every Amazon Web Services Region. + // + // Valid Values: + // // - aurora-mysql (for Aurora MySQL DB instances) + // // - aurora-postgresql (for Aurora PostgreSQL DB instances) + // // - custom-oracle-ee (for RDS Custom for Oracle DB instances) + // // - custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) + // // - custom-oracle-se2 (for RDS Custom for Oracle DB instances) + // // - custom-oracle-se2-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) + // // - db2-ae + // // - db2-se + // // - 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 amount of storage in gibibytes (GiB) to allocate for the DB instance. This - // setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes - // automatically grow 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: + // The amount of storage in gibibytes (GiB) to allocate for the DB instance. + // + // This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster + // volumes automatically grow 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, io2): Must be an integer from 40 to 65536 // for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. + // // RDS for Db2 Constraints to the amount of storage for each storage type are the // following: + // // - General Purpose (SSD) storage (gp3): Must be an integer from 20 to 65536. + // // - Provisioned IOPS storage (io1, io2): Must be an integer from 100 to 65536. + // // RDS for 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, io2): Must be an integer from 100 to 65536. + // // - Magnetic storage (standard): Must be an integer from 5 to 3072. + // // RDS for 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, io2): Must be an integer from 100 to 65536. + // // - Magnetic storage (standard): Must be an integer from 5 to 3072. + // // RDS for 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, io2): Must be an integer from 100 to 65536. + // // - Magnetic storage (standard): Must be an integer from 10 to 3072. + // // RDS for 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, io2): Must be an integer from 100 to 65536. + // // - Magnetic storage (standard): Must be an integer from 5 to 3072. + // // RDS for 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, io2): + // // - 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 // Specifies 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 . + // applied automatically. + // + // If you create an RDS Custom DB instance, you 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) - // . For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three + // on Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones]. + // + // For 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 - // Services Region. Constraints: + // Services Region. + // + // Constraints: + // // - The AvailabilityZone parameter can't be specified if the DB instance is a // Multi-AZ deployment. + // // - The specified Availability Zone must be in the same Amazon Web Services // Region as the current endpoint. + // // Example: us-east-1d + // + // [Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZone *string // 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. This setting doesn't apply to Amazon Aurora DB - // instances. The retention period for automated backups is managed by the DB - // cluster. Default: 1 Constraints: + // disables automated backups. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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. BackupRetentionPeriod *int32 - // The location for storing automated backups and manual snapshots. Valid Values: + // The location for storing automated backups and manual snapshots. + // + // Valid Values: + // // - outposts (Amazon Web Services Outposts) + // // - region (Amazon Web Services Region) - // Default: 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. + // + // Default: region + // + // For more information, see [Working with Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html BackupTarget *string // The CA certificate identifier to use for the DB instance's server certificate. - // This setting doesn't apply to RDS Custom DB instances. 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. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // For supported engines, the character set ( CharacterSet ) to associate the DB - // instance with. This setting doesn't apply to the following DB instances: + // instance with. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora - The character set is managed by the DB cluster. For more // information, see CreateDBCluster . + // // - RDS Custom - However, if you need to change the character set, you can // change it on the database itself. CharacterSetName *string // Specifies whether to copy tags from the DB instance to snapshots of the DB - // instance. By default, tags are not copied. This setting doesn't apply to Amazon - // Aurora DB instances. 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. + // instance. By default, tags are not copied. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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. This setting is required for RDS Custom. Constraints: + // RDS Custom DB instance. + // + // This setting is required for RDS Custom. + // + // Constraints: + // // - The profile must exist in your account. - // - The profile must have an IAM role that Amazon EC2 has permissions to - // assume. + // + // - 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. + // + // For the list of permissions required for the IAM role, see [Configure IAM and your VPC] in the Amazon RDS + // User Guide. + // + // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *string - // The identifier of the DB cluster that this DB instance will belong to. This - // setting doesn't apply to RDS Custom DB instances. + // The identifier of the DB cluster that this DB instance will belong to. + // + // This setting doesn't apply to RDS Custom DB instances. DBClusterIdentifier *string // The meaning of this parameter differs according to the database engine you use. + // // 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: + // cluster. + // + // Constraints: + // // - Must contain 1 to 64 alphanumeric characters. + // // - 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: + // created in the DB cluster. + // + // Constraints: + // // - It must contain 1 to 63 alphanumeric characters. + // // - Must begin with a letter. Subsequent characters can be letters, // underscores, or digits (0 to 9). + // // - Can't be a word reserved by the database engine. + // // 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 for - // non-CDBs and RDSCDB for CDBs. Default: ORCL Constraints: + // non-CDBs and RDSCDB for CDBs. + // + // Default: ORCL + // + // Constraints: + // // - Must contain 1 to 8 alphanumeric characters. + // // - Must contain a letter. + // // - Can't be a word reserved by the database engine. - // Amazon RDS Custom for SQL Server Not applicable. Must be null. RDS for Db2 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. In some - // cases, we recommend that you don't add a database name. For more information, - // see Additional considerations (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-db-instance-prereqs.html#db2-prereqs-additional-considerations) - // in the Amazon RDS User Guide. Constraints: + // + // Amazon RDS Custom for SQL Server Not applicable. Must be null. + // + // RDS for Db2 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. In + // some cases, we recommend that you don't add a database name. For more + // information, see [Additional considerations]in the Amazon RDS User Guide. + // + // 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. + // // RDS for 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: + // 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. + // // RDS for 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: + // 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. + // // RDS for Oracle The Oracle System ID (SID) of the created DB instance. If you // don't specify a value, the default value is ORCL . You can't specify the string - // null , or any other reserved word, for DBName . Default: ORCL Constraints: + // null , or any other reserved word, for DBName . + // + // Default: ORCL + // + // Constraints: + // // - Can't be longer than 8 characters. + // // RDS for 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: + // 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. + // // RDS for SQL Server Not applicable. Must be null. + // + // [Additional considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-db-instance-prereqs.html#db2-prereqs-additional-considerations DBName *string // The name of the DB parameter group to associate with this DB instance. If you // don't specify a value, then Amazon RDS uses the default DB parameter group for - // the specified DB engine and version. This setting doesn't apply to RDS Custom DB - // instances. Constraints: + // the specified DB engine and version. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Constraints: + // // - Must be 1 to 255 letters, numbers, or hyphens. + // // - The first character must be a letter. + // // - 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 - // applies to the legacy EC2-Classic platform, which is no longer used to create - // new DB instances. Use the VpcSecurityGroupIds setting instead. + // A list of DB security groups to associate with this DB instance. + // + // This setting applies to the legacy EC2-Classic platform, which is no longer + // used to create new DB instances. Use the VpcSecurityGroupIds setting instead. DBSecurityGroups []string - // A DB subnet group to associate with this DB instance. Constraints: + // A DB subnet group to associate with this DB instance. + // + // Constraints: + // // - Must match the name of an existing DB subnet group. + // // - Must not be default . + // // Example: mydbsubnetgroup DBSubnetGroupName *string @@ -304,303 +483,471 @@ type CreateDBInstanceInput struct { // Specifies 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) - // . This setting doesn't apply to Amazon Aurora DB instances. You can enable or + // protection isn't enabled. For more information, see [Deleting a DB Instance]. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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. + // + // [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, you // can create only Db2, 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) - // in the Amazon RDS User Guide. This setting doesn't apply to the following DB - // instances: + // instances in an Active Directory Domain. + // + // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (The domain is managed by the DB cluster.) + // // - RDS Custom + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user - // joining the domain. Example: + // joining the domain. + // + // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain - // controllers. Constraints: + // controllers. + // + // Constraints: + // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. + // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. + // // Constraints: + // // - Can't be longer than 64 characters. + // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string // The name of the IAM role to use when making API calls to the Directory Service. + // // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (The domain is managed by the DB cluster.) + // // - RDS Custom DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. + // // Constraints: + // // - Must be in the distinguished name format. + // // - Can't be longer than 64 characters. + // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // The list of log types to enable for exporting to CloudWatch Logs. 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) - // in the Amazon RDS User Guide. This setting doesn't apply to the following DB - // instances: + // information, see [Publishing Database Logs to Amazon CloudWatch Logs]in the Amazon RDS User Guide. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.) + // // - RDS Custom + // // The following values are valid for each DB engine: + // // - RDS for Db2 - diag.log | notify.log + // // - RDS for MariaDB - audit | error | general | slowquery + // // - RDS for Microsoft SQL Server - agent | error + // // - RDS for MySQL - audit | error | general | slowquery + // // - RDS for Oracle - alert | audit | listener | trace | oemagent + // // - RDS for PostgreSQL - postgresql | upgrade + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on - // Outposts DB instance. A CoIP provides local or external connectivity to - // resources in your Outpost subnets through your on-premises network. For some 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) - // in the Amazon Web Services Outposts User Guide. + // Outposts DB instance. + // + // A CoIP provides local or external connectivity to resources in your Outpost + // subnets through your on-premises network. For some 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] in the Amazon RDS User Guide. + // + // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User + // Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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 the following DB - // instances: + // enabled. + // + // For more information, see [IAM Database Authentication for MySQL and PostgreSQL] in the Amazon RDS User Guide. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (Mapping Amazon Web Services IAM accounts to database // accounts is managed by the DB cluster.) + // // - RDS Custom + // + // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // information, see [Using Amazon Performance Insights]in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool - // The version number of the database engine to use. This setting doesn't apply to - // Amazon Aurora DB instances. The version number of the database engine the DB - // instance uses is managed by the DB cluster. For a list of valid engine versions, - // use the DescribeDBEngineVersions operation. The following are the database - // engines and links to information about the major and minor versions that are - // available with Amazon RDS. Not every database engine is available for every - // Amazon Web Services Region. 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) - // 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. RDS for Db2 For information, see Db2 on Amazon - // RDS versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) - // in the Amazon RDS User Guide. RDS for 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. RDS for 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) - // in the Amazon RDS User Guide. RDS for 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. RDS for 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. RDS for PostgreSQL For information, see Amazon - // RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) - // in the Amazon RDS User Guide. + // The version number of the database engine to use. + // + // This setting doesn't apply to Amazon Aurora DB instances. The version number of + // the database engine the DB instance uses is managed by the DB cluster. + // + // For a list of valid engine versions, use the DescribeDBEngineVersions operation. + // + // The following are the database engines and links to information about the major + // and minor versions that are available with Amazon RDS. Not every database engine + // is available for every Amazon Web Services Region. + // + // 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] in the Amazon RDS User Guide. + // + // Amazon RDS Custom for SQL Server See [RDS Custom for SQL Server general requirements] in the Amazon RDS User Guide. + // + // RDS for Db2 For information, see [Db2 on Amazon RDS versions] in the Amazon RDS User Guide. + // + // RDS for MariaDB For information, see [MariaDB on Amazon RDS versions] in the Amazon RDS User Guide. + // + // RDS for Microsoft SQL Server For information, see [Microsoft SQL Server versions on Amazon RDS] in the Amazon RDS User Guide. + // + // RDS for MySQL For information, see [MySQL on Amazon RDS versions] in the Amazon RDS User Guide. + // + // RDS for Oracle For information, see [Oracle Database Engine release notes] in the Amazon RDS User Guide. + // + // RDS for PostgreSQL For information, see [Amazon RDS for PostgreSQL versions and extensions] in the Amazon RDS User Guide. + // + // [RDS Custom for SQL Server general requirements]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html + // [MariaDB on Amazon RDS versions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt + // [Amazon RDS for PostgreSQL versions and extensions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts + // [Oracle Database Engine release notes]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html + // [Creating an RDS Custom for Oracle DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create + // [Db2 on Amazon RDS versions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt + // [Microsoft SQL Server versions on Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport + // [MySQL on Amazon RDS versions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt EngineVersion *string // The amount of Provisioned IOPS (input/output operations per second) to // initially allocate 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. This setting doesn't apply to Amazon Aurora DB - // instances. Storage is managed by the DB cluster. Constraints: + // see [Amazon RDS DB instance storage]in the Amazon RDS User Guide. + // + // This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by + // the DB cluster. + // + // Constraints: + // // - For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a // multiple between .5 and 50 of the storage amount for the DB instance. + // // - For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage // amount for the DB instance. + // + // [Amazon RDS DB instance storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html Iops *int32 - // The Amazon Web Services KMS key identifier for an encrypted 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. This setting doesn't apply to Amazon - // Aurora DB instances. 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. For Amazon RDS Custom, a KMS key is - // required for DB 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. + // The Amazon Web Services KMS key identifier for an encrypted 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. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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. + // + // For Amazon RDS Custom, a KMS key is required for DB 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 - // The license model information for this DB instance. This setting doesn't apply - // to Amazon Aurora or RDS Custom DB instances. Valid Values: + // The license model information for this DB instance. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. + // + // Valid Values: + // // - RDS for Db2 - bring-your-own-license + // // - RDS for MariaDB - general-public-license + // // - RDS for Microsoft SQL Server - license-included + // // - RDS for MySQL - general-public-license + // // - RDS for Oracle - bring-your-own-license | license-included + // // - RDS for PostgreSQL - postgresql-license LicenseModel *string // Specifies 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) - // in the Amazon RDS User Guide. Constraints: + // Secrets Manager. + // + // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. + // + // Constraints: + // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool - // The password for the master user. This setting doesn't apply to Amazon Aurora - // DB instances. The password for the master user is managed by the DB cluster. + // The password for the master user. + // + // This setting doesn't apply to Amazon Aurora DB instances. The password for the + // master user is managed by the DB cluster. + // // Constraints: + // // - Can't be specified if ManageMasterUserPassword is turned on. + // // - Can include any printable ASCII character except "/", """, or "@". For RDS // for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) // character. + // // Length Constraints: + // // - RDS for Db2 - Must contain from 8 to 255 characters. + // // - RDS for MariaDB - Must contain from 8 to 41 characters. + // // - RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. + // // - RDS for MySQL - Must contain from 8 to 41 characters. + // // - RDS for Oracle - Must contain from 8 to 30 characters. + // // - RDS for PostgreSQL - Must contain from 8 to 128 characters. 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 the master user password is managed by RDS in Amazon - // 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 - // 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. - // 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. + // automatically generated and managed in Amazon Web Services Secrets Manager. + // + // This setting is valid only if the master user password is managed by RDS in + // Amazon 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 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. + // + // 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 name for the master user. This setting doesn't apply to Amazon Aurora DB - // instances. The name for the master user is managed by the DB cluster. This - // setting is required for RDS DB instances. Constraints: + // The name for the master user. + // + // This setting doesn't apply to Amazon Aurora DB instances. The name for the + // master user is managed by the DB cluster. + // + // This setting is required for RDS DB instances. + // + // Constraints: + // // - 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) - // in the Amazon RDS User Guide. This setting doesn't apply to the following DB - // instances: + // 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]in the Amazon RDS User Guide. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (Storage is managed by the DB cluster.) + // // - RDS Custom + // + // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB instance. To disable collection of Enhanced Monitoring - // metrics, specify 0 . If MonitoringRoleArn is specified, then you must set - // MonitoringInterval to a value other than 0 . This setting doesn't apply to RDS - // Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0 + // metrics, specify 0 . + // + // If MonitoringRoleArn is specified, then you must set MonitoringInterval to a + // value other than 0 . + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 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. This setting doesn't - // apply to RDS Custom DB instances. + // For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring]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 DB instances. + // + // [Setting Up and Enabling Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling MonitoringRoleArn *string // Specifies whether the DB instance is a Multi-AZ deployment. You can't set the - // AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. This - // setting doesn't apply to the following DB instances: + // AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB // cluster.) + // // - RDS Custom MultiAZ *bool // Specifies whether to use the multi-tenant configuration or the single-tenant // configuration (default). This parameter only applies to RDS for Oracle container - // database (CDB) engines. Note the following restrictions: + // database (CDB) engines. + // + // Note the following restrictions: + // // - The DB engine that you specify in the request must support the multi-tenant // configuration. If you attempt to enable the multi-tenant configuration on a DB // engine that doesn't support it, the request fails. + // // - If you specify the multi-tenant configuration when you create your DB // instance, you can't later modify this DB instance to use the single-tenant // configuration. MultiTenant *bool - // The name of the NCHAR character set for the Oracle DB instance. This setting - // doesn't apply to RDS Custom DB instances. + // The name of the NCHAR character set for the Oracle DB instance. + // + // This setting doesn't apply to RDS Custom DB instances. NcharCharacterSetName *string - // The network type of the DB instance. 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. Valid Values: IPV4 | DUAL + // The network type of the DB instance. + // + // 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] in the Amazon RDS User Guide. + // + // Valid Values: IPV4 | DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string - // The option group to associate the DB instance with. Permanent options, such as - // the TDE option for Oracle Advanced Security TDE, can't be removed from an option - // group. Also, that option group can't be removed from a DB instance after it is - // associated with a DB instance. This setting doesn't apply to Amazon Aurora or - // RDS Custom DB instances. + // The option group to associate the DB instance with. + // + // Permanent options, such as the TDE option for Oracle Advanced Security TDE, + // can't be removed from an option group. Also, that option group can't be removed + // from a DB instance after it is associated with a DB instance. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. OptionGroupName *string // 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. This setting doesn't apply to RDS Custom DB instances. + // 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. + // + // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. This setting doesn't - // apply to RDS Custom DB instances. Valid Values: + // The number of days to retain Performance Insights data. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 - // Default: 7 days If you specify a retention period that isn't valid, such as 94 , - // Amazon RDS returns an error. + // + // Default: 7 days + // + // If you specify a retention period that isn't valid, such as 94 , Amazon RDS + // returns an error. PerformanceInsightsRetentionPeriod *int32 - // The port number on which the database accepts connections. This setting doesn't - // apply to Aurora DB instances. The port number is managed by the cluster. Valid - // Values: 1150-65535 Default: + // The port number on which the database accepts connections. + // + // This setting doesn't apply to Aurora DB instances. The port number is managed + // by the cluster. + // + // Valid Values: 1150-65535 + // + // Default: + // // - RDS for Db2 - 50000 + // // - RDS for MariaDB - 3306 + // // - RDS for Microsoft SQL Server - 1433 + // // - RDS for MySQL - 3306 + // // - RDS for Oracle - 1521 + // // - RDS for PostgreSQL - 5432 + // // Constraints: + // // - For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , // 3343 , 3389 , 47001 , or 49152-49156 . Port *int32 @@ -608,104 +955,155 @@ type CreateDBInstanceInput 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. 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. This setting doesn't apply to Amazon Aurora DB - // instances. The daily time range for creating automated backups is managed by the - // DB cluster. Constraints: + // Amazon Web Services Region. For more information, see [Backup window]in the Amazon RDS User + // Guide. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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. + // + // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow PreferredBackupWindow *string // The time range each week during which system maintenance can occur. 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. 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: + // information, see [Amazon RDS Maintenance Window]in the Amazon RDS User Guide. + // + // 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 format ddd:hh24:mi-ddd:hh24:mi . + // // - The day values must be 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. + // + // [Amazon RDS Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance PreferredMaintenanceWindow *string // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS - // Custom DB instances. + // class of the DB instance. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. ProcessorFeatures []types.ProcessorFeature // The order of priority 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/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) - // in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB - // instances. Default: 1 Valid Values: 0 - 15 + // see [Fault Tolerance for an Aurora DB Cluster]in the Amazon Aurora User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Default: 1 + // + // Valid Values: 0 - 15 + // + // [Fault Tolerance for an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance PromotionTier *int32 - // Specifies whether the DB instance is publicly accessible. 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. + // Specifies whether the DB instance is publicly accessible. + // + // 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. + // // Default: The default behavior varies depending on whether DBSubnetGroupName is - // specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't - // specified, the following applies: + // 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. PubliclyAccessible *bool // Specifes whether the DB instance is encrypted. By default, it isn't encrypted. + // // For RDS Custom DB instances, either enable this setting or leave it unset. - // Otherwise, Amazon RDS reports an error. This setting doesn't apply to Amazon - // Aurora DB instances. The encryption for DB instances is managed by the DB - // cluster. + // Otherwise, Amazon RDS reports an error. + // + // This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB + // instances is managed by the DB cluster. StorageEncrypted *bool - // The storage throughput value for the DB instance. This setting applies only to - // the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS Custom - // DB instances. + // The storage throughput value for the DB instance. + // + // This setting applies only to the gp3 storage type. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. StorageThroughput *int32 - // The storage type to associate with the DB instance. If you specify io1 , io2 , - // or gp3 , you must also include a value for the Iops parameter. This setting - // doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB - // cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1 , if the - // Iops parameter is specified. Otherwise, gp2 . + // The storage type to associate with the DB instance. + // + // If you specify io1 , io2 , or gp3 , you must also include a value for the Iops + // parameter. + // + // This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by + // the DB cluster. + // + // Valid Values: gp2 | gp3 | io1 | io2 | standard + // + // Default: io1 , if the Iops parameter is specified. Otherwise, gp2 . StorageType *string // Tags to assign to the DB instance. Tags []types.Tag // The ARN from the key store with which to associate the instance for TDE - // encryption. This setting doesn't apply to Amazon Aurora or RDS Custom DB - // instances. + // encryption. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. 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 DB instances. + // The password for the given ARN from the key store in order to access the device. + // + // This setting doesn't apply to RDS Custom DB instances. TdeCredentialPassword *string // The time zone of the DB instance. The time zone parameter is currently - // supported only by RDS for Db2 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) - // and RDS for SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) - // . + // supported only by [RDS for Db2]and [RDS for SQL Server]. + // + // [RDS for Db2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone + // [RDS for 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. - // This setting doesn't apply to Amazon Aurora DB instances. The associated list of - // EC2 VPC security groups is managed by the DB cluster. Default: The default EC2 - // VPC security group for the DB subnet group's VPC. + // + // This setting doesn't apply to Amazon Aurora DB instances. The associated list + // of EC2 VPC security groups is managed by the DB cluster. + // + // Default: The default EC2 VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -713,9 +1111,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_CreateDBInstanceReadReplica.go b/service/rds/api_op_CreateDBInstanceReadReplica.go index 9a5592cf128..b206bc745ce 100644 --- a/service/rds/api_op_CreateDBInstanceReadReplica.go +++ b/service/rds/api_op_CreateDBInstanceReadReplica.go @@ -17,14 +17,19 @@ import ( // instance or Multi-AZ DB cluster. You can create a read replica for a DB instance // running Db2, MariaDB, MySQL, 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) -// in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. To -// create a DB instance for an Aurora DB cluster, use the CreateDBInstance -// operation. 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. +// information, see [Working with read replicas]and [Migrating from a Multi-AZ DB cluster to a DB instance using a read replica] in the Amazon RDS User Guide. +// +// Amazon Aurora doesn't support this operation. To create a DB instance for an +// Aurora DB cluster, use the CreateDBInstance operation. +// +// 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. +// +// [Working with read replicas]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html +// [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 func (c *Client) CreateDBInstanceReadReplica(ctx context.Context, params *CreateDBInstanceReadReplicaInput, optFns ...func(*Options)) (*CreateDBInstanceReadReplicaOutput, error) { if params == nil { params = &CreateDBInstanceReadReplicaInput{} @@ -50,27 +55,38 @@ type CreateDBInstanceReadReplicaInput struct { 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. + // 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 // Specifies whether to automatically apply minor engine upgrades to the read - // replica during the maintenance window. This setting doesn't apply to RDS Custom - // DB instances. Default: Inherits the value from the source DB instance. + // replica during the maintenance window. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Default: Inherits the value from the source DB instance. AutoMinorVersionUpgrade *bool - // The Availability Zone (AZ) where the read replica will be created. Default: A - // random, system-chosen Availability Zone in the endpoint's Amazon Web Services - // Region. Example: us-east-1d + // The Availability Zone (AZ) where the read replica will be created. + // + // Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web + // Services Region. + // + // Example: us-east-1d AvailabilityZone *string // The CA certificate identifier to use for the read replica's server certificate. - // This setting doesn't apply to RDS Custom DB instances. 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. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // Specifies whether to copy all tags from the read replica to snapshots of the @@ -80,50 +96,73 @@ 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 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 DB - // instances. + // + // For the list of permissions required for the IAM role, see [Configure IAM and your VPC] in the Amazon RDS + // User Guide. + // + // This setting is required for RDS Custom DB instances. + // + // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc 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) - // in the Amazon RDS User Guide. Default: Inherits the value from the source DB - // instance. + // availability for your engine, see [DB Instance Class]in the Amazon RDS User Guide. + // + // Default: Inherits the value from the source DB instance. + // + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string - // The name of the DB parameter group to associate with this DB instance. If you - // don't 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 don't specify a value for DBParameterGroupName , then Amazon RDS uses the // DBParameterGroup of the 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 DB instances for cross-Region read replicas and for Oracle DB - // instances. It isn't supported for MySQL DB instances for same Region read - // replicas or for RDS Custom. Constraints: + // read replica. + // + // Specifying a parameter group for this operation is only supported for MySQL DB + // instances for cross-Region read replicas and for Oracle DB instances. It isn't + // supported for MySQL DB instances for same Region read replicas or 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 // 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: + // then the new DB instance isn't created in a VPC. + // + // Constraints: + // // - If supplied, must match the name of an existing DB subnet group. + // // - 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 @@ -132,203 +171,294 @@ type CreateDBInstanceReadReplicaInput struct { // Specifies whether to enable deletion protection for the DB instance. 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]. + // + // [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 the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // in an Active Directory Domain. + // + // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user - // joining the domain. Example: + // joining the domain. + // + // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain - // controllers. Constraints: + // controllers. + // + // Constraints: + // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. + // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. + // // Constraints: + // // - Can't be longer than 64 characters. + // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string // The name of the IAM role to use when making API calls to the Directory Service. + // // This setting doesn't apply to RDS Custom DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. + // // Constraints: + // // - Must be in the distinguished name format. + // // - Can't be longer than 64 characters. + // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // [Publishing Database Logs to Amazon CloudWatch Logs]in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on - // Outposts read replica. A CoIP provides local or external connectivity to - // resources in your Outpost subnets through your on-premises network. For some 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) - // in the Amazon Web Services Outposts User Guide. + // Outposts read replica. + // + // A CoIP provides local or external connectivity to resources in your Outpost + // subnets through your on-premises network. For some 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] in the Amazon RDS User Guide. + // + // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User + // Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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 DB - // instances. + // enabled. + // + // For more information about IAM database authentication, see [IAM Database Authentication for MySQL and PostgreSQL] in the Amazon RDS + // User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool - // Specifies 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // Specifies whether to enable Performance Insights for the read replica. + // + // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The amount of Provisioned IOPS (input/output operations per second) to // initially allocate for the DB instance. Iops *int32 - // The Amazon Web Services KMS key identifier for an encrypted read replica. The - // Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or - // alias name for the KMS key. If you create an encrypted read replica in the same - // Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, - // don't specify a value for this parameter. A read replica in the same Amazon Web - // Services Region is always encrypted with the same KMS key as the source DB - // instance or cluster. If you create an encrypted read replica in a different - // Amazon Web Services Region, then you must specify a KMS key identifier for 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. You can't - // create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB - // cluster. This setting doesn't apply to RDS Custom, which uses the same KMS key - // as the primary replica. + // The Amazon Web Services KMS key identifier for an encrypted read replica. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. + // + // If you create an encrypted read replica in the same Amazon Web Services Region + // as the source DB instance or Multi-AZ DB cluster, don't specify a value for this + // parameter. A read replica in the same Amazon Web Services Region is always + // encrypted with the same KMS key as the source DB instance or cluster. + // + // If you create an encrypted read replica in a different Amazon Web Services + // Region, then you must specify a KMS key identifier for 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. + // + // You can't create an encrypted read replica from an unencrypted DB instance or + // Multi-AZ DB cluster. + // + // This setting doesn't apply to RDS Custom, which uses the same KMS key as the + // primary replica. KmsKeyId *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) - // in the Amazon RDS User Guide. + // 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]in the Amazon RDS User Guide. + // + // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the read replica. To disable collection of Enhanced Monitoring - // metrics, specify 0 . The default is 0 . If MonitoringRoleArn is specified, then - // you must set MonitoringInterval to a value other than 0 . This setting doesn't - // apply to RDS Custom DB instances. Valid Values: 0, 1, 5, 10, 15, 30, 60 + // metrics, specify 0 . The default is 0 . + // + // If MonitoringRoleArn is specified, then you must set MonitoringInterval to a + // value other than 0 . + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: 0, 1, 5, 10, 15, 30, 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, 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 DB instances. + // For information on creating a monitoring role, go to [To create an IAM role for Amazon RDS Enhanced Monitoring]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 DB instances. + // + // [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 MonitoringRoleArn *string - // Specifies 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 DB instances. + // Specifies 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 DB instances. MultiAZ *bool - // The network type of the DB instance. Valid Values: + // 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) - // in the Amazon RDS User Guide. + // protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon RDS User Guide. + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The option group to associate the DB instance with. If not specified, RDS uses - // the option group associated with the source DB instance or cluster. For SQL - // Server, you must use the option group associated with the source. This setting - // doesn't apply to RDS Custom DB instances. + // the option group associated with the source DB instance or cluster. + // + // For SQL Server, you must use the option group associated with the source. + // + // This setting doesn't apply to RDS Custom DB instances. OptionGroupName *string // 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 DB instances. + // 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 DB instances. PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. This setting doesn't - // apply to RDS Custom DB instances. Valid Values: + // The number of days to retain Performance Insights data. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 - // Default: 7 days If you specify a retention period that isn't valid, such as 94 , - // Amazon RDS returns an error. + // + // Default: 7 days + // + // If you specify a retention period that isn't valid, such as 94 , Amazon RDS + // returns an error. PerformanceInsightsRetentionPeriod *int32 - // The port number that the DB instance uses for connections. Valid Values: - // 1150-65535 Default: Inherits the value from the source DB instance. + // The port number that the DB instance uses for connections. + // + // Valid Values: 1150-65535 + // + // Default: Inherits the value from the source DB instance. Port *int32 // When you are creating a read replica from one Amazon Web Services GovCloud (US) // Region to another or from one China Amazon Web Services Region to another, the // URL that contains a Signature Version 4 signed request for the // CreateDBInstanceReadReplica API operation in the source Amazon Web Services - // Region that contains the source DB instance. This setting applies only to Amazon - // Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's - // ignored in other Amazon Web Services Regions. This setting applies only when - // replicating from a source DB instance. Source DB clusters aren't supported in - // Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. + // Region that contains the source DB instance. + // + // This setting applies only to Amazon Web Services GovCloud (US) Regions and + // China Amazon Web Services Regions. It's ignored in other Amazon Web Services + // Regions. + // + // This setting applies only when replicating from a source DB instance. Source DB + // clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China + // Amazon Web Services Regions. + // // You must specify this parameter when you create an encrypted read replica from // another Amazon Web Services Region by using the Amazon RDS API. Don't specify // PreSignedUrl when you are creating an encrypted read replica in the same Amazon - // Web Services Region. The presigned URL must be a valid request for the - // 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: + // Web Services Region. + // + // The presigned URL must be a valid request for the 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. + // 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 @@ -336,99 +466,137 @@ type CreateDBInstanceReadReplicaInput struct { // 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 + // + // To learn how to generate a Signature Version 4 signed request, see [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)] and [Signature Version 4 Signing Process]. + // + // 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. + // // SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server - // doesn't support cross-Region read replicas. This setting doesn't apply to RDS - // Custom DB instances. + // doesn't support cross-Region read replicas. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html + // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. This setting doesn't apply to RDS Custom DB instances. + // class of the DB instance. + // + // This setting doesn't apply to RDS Custom DB instances. ProcessorFeatures []types.ProcessorFeature - // Specifies whether the DB instance is publicly accessible. When the DB cluster - // is publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security 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 . + // Specifies whether the DB instance is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // 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. PubliclyAccessible *bool - // The open mode of the replica database: mounted or read-only. This parameter is - // only supported for Oracle DB instances. Mounted DB replicas are included in - // Oracle Database Enterprise Edition. The main use case for mounted replicas is - // cross-Region disaster recovery. The primary database 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. 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) - // 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 - // creation, you can manage the open mode manually. + // The open mode of the replica database: mounted or read-only. + // + // This parameter is only supported for Oracle DB instances. + // + // Mounted DB replicas are included in Oracle Database Enterprise Edition. The + // main use case for mounted replicas is cross-Region disaster recovery. The + // primary database 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. + // + // 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]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 creation, you can manage the open + // mode manually. + // + // [Working with Oracle Read Replicas for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html 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: + // 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. 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: + // Oracle and SQL Server, which can have up to five. + // + // Constraints: + // // - Must be the identifier of an existing Db2, MariaDB, MySQL, 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. + // + // - For the limitations of Oracle read replicas, see [Version and licensing considerations for RDS for Oracle replicas]in the Amazon RDS User + // Guide. + // + // - For the limitations of SQL Server read replicas, see [Read replica limitations with SQL Server]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) + // the read replica, specify a valid DB instance ARN. For more information, see [Constructing an ARN for Amazon RDS] // in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, // which don't support cross-Region replicas. + // + // [Constructing an ARN for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing + // [Read replica limitations with SQL Server]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations + // [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 SourceDBInstanceIdentifier *string // The AWS region the resource is in. The presigned URL will be created with this // region, if the PresignURL member is empty set. SourceRegion *string - // Specifies the storage throughput value for the read replica. This setting - // doesn't apply to RDS Custom or Amazon Aurora DB instances. + // Specifies the storage throughput value for the read replica. + // + // This setting doesn't apply to RDS Custom or Amazon Aurora DB instances. StorageThroughput *int32 - // The storage type to associate with the read replica. If you specify io1 , io2 , - // or gp3 , you must also include a value for the Iops parameter. Valid Values: - // gp2 | gp3 | io1 | io2 | standard Default: io1 if the Iops parameter is - // specified. Otherwise, gp2 . + // The storage type to associate with the read replica. + // + // If you specify io1 , io2 , or gp3 , you must also include a value for the Iops + // parameter. + // + // Valid Values: gp2 | gp3 | io1 | io2 | standard + // + // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // Whether to upgrade the storage file system configuration on the read replica. @@ -437,12 +605,16 @@ type CreateDBInstanceReadReplicaInput struct { UpgradeStorageConfig *bool // Specifies whether the DB instance class of the DB instance uses its default - // processor features. This setting doesn't apply to RDS Custom DB instances. + // processor features. + // + // This setting doesn't apply to RDS Custom DB instances. UseDefaultProcessorFeatures *bool // A list of Amazon EC2 VPC security groups to associate with the read replica. - // This setting doesn't apply to RDS Custom DB instances. Default: The default EC2 - // VPC security group for the DB subnet group's VPC. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Default: The default EC2 VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []string // Used by the SDK's PresignURL autofill customization to specify the region the @@ -454,9 +626,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_CreateDBParameterGroup.go b/service/rds/api_op_CreateDBParameterGroup.go index 5bbb9743e41..8be8a2c0a38 100644 --- a/service/rds/api_op_CreateDBParameterGroup.go +++ b/service/rds/api_op_CreateDBParameterGroup.go @@ -11,24 +11,30 @@ 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 -// 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 . -// 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. -// After you create 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 create action -// before the 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 RDS console (https://console.aws.amazon.com/rds/) -// or the DescribeDBParameters command to verify that your DB parameter group has -// been created or modified. +// 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 . 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. +// +// After you create 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 create +// action before the 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 RDS console]or the DescribeDBParameters command to verify +// that your DB parameter group has been created or modified. +// +// [Amazon RDS console]: https://console.aws.amazon.com/rds/ func (c *Client) CreateDBParameterGroup(ctx context.Context, params *CreateDBParameterGroupInput, optFns ...func(*Options)) (*CreateDBParameterGroupOutput, error) { if params == nil { params = &CreateDBParameterGroupInput{} @@ -49,35 +55,65 @@ type CreateDBParameterGroupInput struct { // The DB parameter group family name. A DB parameter group can be associated with // one and only one DB parameter group family, and can be applied only to a DB // 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 - // 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: + // 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 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-mysql + // // - aurora-postgresql + // // - db2-ae + // // - db2-se + // // - 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: + // 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. // // This member is required. @@ -96,8 +132,10 @@ 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_CreateDBProxyEndpoint.go b/service/rds/api_op_CreateDBProxyEndpoint.go index 04a32342c1c..c8ffe467b19 100644 --- a/service/rds/api_op_CreateDBProxyEndpoint.go +++ b/service/rds/api_op_CreateDBProxyEndpoint.go @@ -48,8 +48,9 @@ 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // The role of the DB proxy endpoint. The role determines whether the endpoint can diff --git a/service/rds/api_op_CreateDBSecurityGroup.go b/service/rds/api_op_CreateDBSecurityGroup.go index fabb45dfc88..55dacf368a7 100644 --- a/service/rds/api_op_CreateDBSecurityGroup.go +++ b/service/rds/api_op_CreateDBSecurityGroup.go @@ -12,14 +12,19 @@ import ( ) // Creates a new DB security group. DB security groups control access to a DB -// 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) -// in the Amazon RDS User Guide. +// 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]in the Amazon EC2 User Guide, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare], and [Moving a DB instance not in a VPC into a VPC] in the +// Amazon RDS User Guide. +// +// [Migrate from EC2-Classic to a VPC]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html +// [EC2-Classic Networking is Retiring – Here’s How to Prepare]: http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/ +// [Moving a DB instance not in a VPC into a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html func (c *Client) CreateDBSecurityGroup(ctx context.Context, params *CreateDBSecurityGroupInput, optFns ...func(*Options)) (*CreateDBSecurityGroupOutput, error) { if params == nil { params = &CreateDBSecurityGroupInput{} @@ -43,11 +48,17 @@ type CreateDBSecurityGroupInput struct { DBSecurityGroupDescription *string // 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" + // // Example: mysecuritygroup // // This member is required. @@ -61,8 +72,10 @@ 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_CreateDBShardGroup.go b/service/rds/api_op_CreateDBShardGroup.go index 20ed72f70d0..bc88fcb2645 100644 --- a/service/rds/api_op_CreateDBShardGroup.go +++ b/service/rds/api_op_CreateDBShardGroup.go @@ -11,8 +11,9 @@ import ( ) // Creates a new DB shard group for Aurora Limitless Database. You must enable -// Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB -// clusters only +// Aurora Limitless Database to create a DB shard group. +// +// Valid for: Aurora DB clusters only func (c *Client) CreateDBShardGroup(ctx context.Context, params *CreateDBShardGroupInput, optFns ...func(*Options)) (*CreateDBShardGroupOutput, error) { if params == nil { params = &CreateDBShardGroupInput{} @@ -47,33 +48,47 @@ type CreateDBShardGroupInput struct { // Specifies whether to create standby instances for the DB shard group. Valid // values are the following: + // // - 0 - Creates a single, primary DB instance for each physical shard. This is // the default value, and the only one supported for the preview. + // // - 1 - Creates a primary DB instance and a standby instance in a different // Availability Zone (AZ) for each physical shard. + // // - 2 - Creates a primary DB instance and two standby instances in different // AZs for each physical shard. ComputeRedundancy *int32 - // Specifies whether the DB shard group is publicly accessible. When the DB shard - // group is publicly accessible, its Domain Name System (DNS) endpoint resolves to - // the private IP address from within the DB shard group's virtual private cloud - // (VPC). It resolves to the public IP address from outside of the DB shard group's - // VPC. Access to the DB shard group is ultimately controlled by the security group - // it uses. That public access is not permitted if the security group assigned to - // the DB shard group doesn't permit it. When the DB shard group isn't publicly - // accessible, it is an internal DB shard group with a DNS name that resolves 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: + // Specifies whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately + // controlled by the security group it uses. That public access is not permitted if + // the security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves 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 shard group is private. + // // - If the default VPC in the target Region has an internet gateway attached to // it, the DB shard group 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 shard group is private. + // // - If the subnets are part of a VPC that has an internet gateway attached to // it, the DB shard group is public. PubliclyAccessible *bool @@ -85,10 +100,13 @@ type CreateDBShardGroupOutput struct { // Specifies whether to create standby instances for the DB shard group. Valid // values are the following: + // // - 0 - Creates a single, primary DB instance for each physical shard. This is // the default value, and the only one supported for the preview. + // // - 1 - Creates a primary DB instance and a standby instance in a different // Availability Zone (AZ) for each physical shard. + // // - 2 - Creates a primary DB instance and two standby instances in different // AZs for each physical shard. ComputeRedundancy *int32 @@ -109,16 +127,21 @@ type CreateDBShardGroupOutput struct { // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 - // Indicates whether the DB shard group is publicly accessible. When the DB shard - // group is publicly accessible, its Domain Name System (DNS) endpoint resolves to - // the private IP address from within the DB shard group's virtual private cloud - // (VPC). It resolves to the public IP address from outside of the DB shard group's - // VPC. Access to the DB shard group is ultimately controlled by the security group - // it uses. That public access isn't permitted if the security group assigned to - // the DB shard group doesn't permit it. When the DB shard group isn't publicly - // accessible, it is an internal DB shard group with a DNS name that resolves to a - // private IP address. For more information, see CreateDBShardGroup . This setting - // is only for Aurora Limitless Database. + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately + // controlled by the security group it uses. That public access isn't permitted if + // the security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. diff --git a/service/rds/api_op_CreateDBSnapshot.go b/service/rds/api_op_CreateDBSnapshot.go index 8c65706eff2..4af24f19099 100644 --- a/service/rds/api_op_CreateDBSnapshot.go +++ b/service/rds/api_op_CreateDBSnapshot.go @@ -31,24 +31,34 @@ func (c *Client) CreateDBSnapshot(ctx context.Context, params *CreateDBSnapshotI 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. // // This member is required. DBInstanceIdentifier *string - // The identifier for the DB snapshot. Constraints: + // 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 + // // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -56,8 +66,9 @@ type CreateDBSnapshotInput struct { type CreateDBSnapshotOutput struct { - // Contains the details of an Amazon RDS DB snapshot. This data type is used as a - // response element in the DescribeDBSnapshots action. + // Contains the details of an Amazon RDS DB snapshot. + // + // This data type is used as a response element in the DescribeDBSnapshots action. DBSnapshot *types.DBSnapshot // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_CreateDBSubnetGroup.go b/service/rds/api_op_CreateDBSubnetGroup.go index 986e0a6fe99..8c898cd1990 100644 --- a/service/rds/api_op_CreateDBSubnetGroup.go +++ b/service/rds/api_op_CreateDBSubnetGroup.go @@ -36,11 +36,16 @@ type CreateDBSubnetGroupInput struct { DBSubnetGroupDescription *string // 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. + // // Example: mydbsubnetgroup // // This member is required. @@ -59,8 +64,10 @@ 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 feb2fc38b00..78891ff0ba5 100644 --- a/service/rds/api_op_CreateEventSubscription.go +++ b/service/rds/api_op_CreateEventSubscription.go @@ -14,23 +14,30 @@ import ( // Creates an RDS event notification subscription. This operation requires a topic // 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 +// 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) -// 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) +// to your customer account. +// +// For more information about subscribing to an event for RDS DB engines, see [Subscribing to Amazon RDS event notification] 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] // in the Amazon Aurora User Guide. +// +// [Subscribing to Amazon RDS event notification]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Subscribing.html func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error) { if params == nil { params = &CreateEventSubscriptionInput{} @@ -50,15 +57,18 @@ type CreateEventSubscriptionInput struct { // The Amazon Resource Name (ARN) of the SNS topic created for event notification. // SNS automatically creates the ARN when you create a topic and subscribe to it. - // RDS doesn't support FIFO (first in, first out) topics. For more information, see - // Message ordering and deduplication (FIFO topics) (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) - // in the Amazon Simple Notification Service Developer Guide. + // + // RDS doesn't support FIFO (first in, first out) topics. For more information, + // see [Message ordering and deduplication (FIFO topics)]in the Amazon Simple Notification Service Developer Guide. + // + // [Message ordering and deduplication (FIFO topics)]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html // // This member is required. SnsTopicArn *string - // The name of the subscription. Constraints: The name must be less than 255 - // characters. + // The name of the subscription. + // + // Constraints: The name must be less than 255 characters. // // This member is required. SubscriptionName *string @@ -69,42 +79,55 @@ type CreateEventSubscriptionInput struct { // 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. + // type in the "Amazon RDS event categories and event messages" section of the [Amazon RDS User Guide]or + // the [Amazon Aurora User Guide]. 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 + // [Amazon Aurora User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html 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: + // 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. 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 - // specified, all events are returned. Valid Values: db-instance | db-cluster | - // db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | - // db-proxy + // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_CreateGlobalCluster.go b/service/rds/api_op_CreateGlobalCluster.go index 463a647f5cc..d8036d37f0c 100644 --- a/service/rds/api_op_CreateGlobalCluster.go +++ b/service/rds/api_op_CreateGlobalCluster.go @@ -15,11 +15,14 @@ import ( // Regions. The global database contains a single primary cluster with read-write // capability, and a read-only secondary cluster that receives data from the // primary cluster through high-speed replication performed by the Aurora storage -// subsystem. You can create a global database that is initially empty, and then -// create the primary and secondary DB clusters in the global database. Or you can -// specify an existing Aurora cluster during the create operation, and this cluster -// becomes the primary cluster of the global database. This operation applies only -// to Aurora DB clusters. +// subsystem. +// +// You can create a global database that is initially empty, and then create the +// primary and secondary DB clusters in the global database. Or you can specify an +// existing Aurora cluster during the create operation, and this cluster becomes +// the primary cluster of the global database. +// +// This operation applies only to Aurora DB clusters. func (c *Client) CreateGlobalCluster(ctx context.Context, params *CreateGlobalClusterInput, optFns ...func(*Options)) (*CreateGlobalClusterOutput, error) { if params == nil { params = &CreateGlobalClusterInput{} @@ -39,7 +42,10 @@ type CreateGlobalClusterInput struct { // The name for your database of up to 64 alphanumeric characters. If you don't // specify a name, Amazon Aurora doesn't create a database in the global database - // cluster. Constraints: + // cluster. + // + // Constraints: + // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the database name from the source DB cluster. DatabaseName *string @@ -49,13 +55,20 @@ type CreateGlobalClusterInput struct { // enabled. DeletionProtection *bool - // The database engine to use for this global database cluster. Valid Values: - // aurora-mysql | aurora-postgresql Constraints: + // The database engine to use for this global database cluster. + // + // Valid Values: aurora-mysql | aurora-postgresql + // + // Constraints: + // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the engine of the source DB cluster. Engine *string - // The engine version to use for this global database cluster. Constraints: + // The engine version to use for this global database cluster. + // + // Constraints: + // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the engine version of the source DB cluster. EngineVersion *string @@ -65,17 +78,26 @@ type CreateGlobalClusterInput struct { GlobalClusterIdentifier *string // The Amazon Resource Name (ARN) to use as the primary cluster of the global - // database. If you provide a value for this parameter, don't specify values for - // the following settings because Amazon Aurora uses the values from the specified + // database. + // + // If you provide a value for this parameter, don't specify values for the + // following settings because Amazon Aurora uses the values from the specified // source DB cluster: + // // - DatabaseName + // // - Engine + // // - EngineVersion + // // - StorageEncrypted SourceDBClusterIdentifier *string // Specifies whether to enable storage encryption for the new global database - // cluster. Constraints: + // cluster. + // + // Constraints: + // // - Can't be specified if SourceDBClusterIdentifier is specified. In this case, // Amazon Aurora uses the setting from the source DB cluster. StorageEncrypted *bool diff --git a/service/rds/api_op_CreateIntegration.go b/service/rds/api_op_CreateIntegration.go index 7b11622b1df..9bc7a2f0ea9 100644 --- a/service/rds/api_op_CreateIntegration.go +++ b/service/rds/api_op_CreateIntegration.go @@ -47,15 +47,19 @@ type CreateIntegrationInput struct { TargetArn *string // An optional set of non-secret key–value pairs that contains additional - // contextual information about the data. For more information, see Encryption - // context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the Amazon Web Services Key Management Service Developer Guide. You can only - // include this parameter if you specify the KMSKeyId parameter. + // contextual information about the data. For more information, see [Encryption context]in the Amazon + // Web Services Key Management Service Developer Guide. + // + // You can only include this parameter if you specify the KMSKeyId parameter. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string - // Data filtering options for the integration. For more information, see Data - // filtering for Aurora zero-ETL integrations with Amazon Redshift (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html) - // . Valid for: Integrations with Aurora MySQL source DB clusters only + // Data filtering options for the integration. For more information, see [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]. + // + // Valid for: Integrations with Aurora MySQL source DB clusters only + // + // [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html DataFilter *string // A description of the integration. @@ -66,8 +70,9 @@ type CreateIntegrationInput struct { // an encryption key, RDS uses a default Amazon Web Services owned key. KMSKeyId *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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -76,9 +81,10 @@ type CreateIntegrationInput struct { // A zero-ETL integration with Amazon Redshift. type CreateIntegrationOutput struct { - // The encryption context for the integration. For more information, see - // Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the Amazon Web Services Key Management Service Developer Guide. + // The encryption context for the integration. For more information, see [Encryption context] in the + // Amazon Web Services Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). @@ -111,8 +117,9 @@ type CreateIntegrationOutput struct { // The current status of the integration. Status types.IntegrationStatus - // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // The ARN of the Redshift data warehouse used as the target for replication. diff --git a/service/rds/api_op_CreateOptionGroup.go b/service/rds/api_op_CreateOptionGroup.go index e8d47ee2902..a65f7841d93 100644 --- a/service/rds/api_op_CreateOptionGroup.go +++ b/service/rds/api_op_CreateOptionGroup.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new option group. You can create up to 20 option groups. This command -// doesn't apply to RDS Custom. +// Creates a new option group. You can create up to 20 option groups. +// +// This command doesn't apply to RDS Custom. func (c *Client) CreateOptionGroup(ctx context.Context, params *CreateOptionGroupInput, optFns ...func(*Options)) (*CreateOptionGroupOutput, error) { if params == nil { params = &CreateOptionGroupInput{} @@ -30,19 +31,34 @@ func (c *Client) CreateOptionGroup(ctx context.Context, params *CreateOptionGrou type CreateOptionGroupInput struct { - // The name of the engine to associate this option group with. Valid Values: + // The name of the engine to associate this option group with. + // + // Valid Values: + // // - db2-ae + // // - db2-se + // // - 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. @@ -59,10 +75,16 @@ type CreateOptionGroupInput struct { // This member is required. OptionGroupDescription *string - // Specifies the name of the option group to be created. Constraints: + // 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 + // // Example: myoptiongroup // // This member is required. diff --git a/service/rds/api_op_CreateTenantDatabase.go b/service/rds/api_op_CreateTenantDatabase.go index cf7d5124355..37d857e99fb 100644 --- a/service/rds/api_op_CreateTenantDatabase.go +++ b/service/rds/api_op_CreateTenantDatabase.go @@ -37,8 +37,12 @@ type CreateTenantDatabaseInput struct { // This member is required. DBInstanceIdentifier *string - // The password for the master user in your tenant database. Constraints: + // The password for the master user in your tenant database. + // + // Constraints: + // // - Must be 8 to 30 characters. + // // - Can include any printable ASCII character except forward slash ( / ), double // quote ( " ), at symbol ( @ ), ampersand ( & ), or single quote ( ' ). // @@ -47,9 +51,14 @@ type CreateTenantDatabaseInput struct { // The name for the master user account in your tenant database. RDS creates this // user account in the tenant database and grants privileges to the master user. - // This parameter is case-sensitive. Constraints: + // This parameter is case-sensitive. + // + // Constraints: + // // - 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. // // This member is required. @@ -69,8 +78,9 @@ type CreateTenantDatabaseInput struct { // The NCHAR value for the tenant database. NcharCharacterSetName *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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_DeleteBlueGreenDeployment.go b/service/rds/api_op_DeleteBlueGreenDeployment.go index c35a01d746d..cfd65f20f88 100644 --- a/service/rds/api_op_DeleteBlueGreenDeployment.go +++ b/service/rds/api_op_DeleteBlueGreenDeployment.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Aurora User Guide. +// Deletes a blue/green deployment. +// +// For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html func (c *Client) DeleteBlueGreenDeployment(ctx context.Context, params *DeleteBlueGreenDeploymentInput, optFns ...func(*Options)) (*DeleteBlueGreenDeploymentOutput, error) { if params == nil { params = &DeleteBlueGreenDeploymentInput{} @@ -34,15 +35,19 @@ func (c *Client) DeleteBlueGreenDeployment(ctx context.Context, params *DeleteBl type DeleteBlueGreenDeploymentInput struct { // The unique identifier of the blue/green deployment to delete. This parameter - // isn't case-sensitive. Constraints: + // isn't case-sensitive. + // + // Constraints: + // // - Must match an existing blue/green deployment identifier. // // This member is required. BlueGreenDeploymentIdentifier *string // Specifies 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 . + // specify this option if the blue/green deployment [status]is SWITCHOVER_COMPLETED . + // + // [status]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html DeleteTarget *bool noSmithyDocumentSerde @@ -50,11 +55,12 @@ type DeleteBlueGreenDeploymentInput struct { type DeleteBlueGreenDeploymentOutput struct { - // 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) - // in the Amazon Aurora User Guide. + // Details about a blue/green deployment. + // + // For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon + // Aurora User Guide. + // + // [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html BlueGreenDeployment *types.BlueGreenDeployment // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DeleteCustomDBEngineVersion.go b/service/rds/api_op_DeleteCustomDBEngineVersion.go index aebc27f9749..e6e168e3984 100644 --- a/service/rds/api_op_DeleteCustomDBEngineVersion.go +++ b/service/rds/api_op_DeleteCustomDBEngineVersion.go @@ -14,19 +14,25 @@ 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. // -// 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. +// 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] in the Amazon RDS User Guide. +// +// [Deleting a CEV]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete func (c *Client) DeleteCustomDBEngineVersion(ctx context.Context, params *DeleteCustomDBEngineVersionInput, optFns ...func(*Options)) (*DeleteCustomDBEngineVersionOutput, error) { if params == nil { params = &DeleteCustomDBEngineVersionInput{} @@ -45,9 +51,13 @@ func (c *Client) DeleteCustomDBEngineVersion(ctx context.Context, params *Delete type DeleteCustomDBEngineVersionInput struct { // The database engine. RDS Custom for Oracle supports the following values: + // // - custom-oracle-ee + // // - custom-oracle-ee-cdb + // // - custom-oracle-se2 + // // - custom-oracle-se2-cdb // // This member is required. @@ -74,8 +84,9 @@ 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) - // in the Amazon RDS User Guide. + // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. + // + // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. @@ -128,11 +139,13 @@ type DeleteCustomDBEngineVersionOutput struct { // 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) - // in the Amazon Aurora User Guide. + // A list of the supported CA certificate identifiers. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName @@ -142,14 +155,21 @@ 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 - // SupportedFeatureNames in the output. + // 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 // A list of the character sets supported by the Oracle DB engine for the @@ -180,8 +200,9 @@ type DeleteCustomDBEngineVersionOutput struct { // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By - // default, write operations aren't allowed on reader DB instances. Valid for: - // Aurora DB clusters only + // default, write operations aren't allowed on reader DB instances. + // + // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified @@ -195,8 +216,9 @@ type DeleteCustomDBEngineVersionOutput struct { // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html 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 685bda971a6..7d5885d51bc 100644 --- a/service/rds/api_op_DeleteDBCluster.go +++ b/service/rds/api_op_DeleteDBCluster.go @@ -14,12 +14,17 @@ import ( // 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) -// in the Amazon RDS User Guide. +// 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?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DeleteDBCluster(ctx context.Context, params *DeleteDBClusterInput, optFns ...func(*Options)) (*DeleteDBClusterOutput, error) { if params == nil { params = &DeleteDBClusterInput{} @@ -38,7 +43,10 @@ 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: + // isn't case-sensitive. + // + // Constraints: + // // - Must match an existing DBClusterIdentifier. // // This member is required. @@ -50,11 +58,17 @@ type DeleteDBClusterInput struct { DeleteAutomatedBackups *bool // The DB cluster snapshot identifier of the new DB cluster snapshot created when - // 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: + // 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 FinalDBSnapshotIdentifier *string @@ -62,8 +76,10 @@ type DeleteDBClusterInput struct { // the DB cluster is deleted. If skip is specified, no DB cluster snapshot is // created. If skip isn't specified, a DB cluster snapshot is created before the DB // cluster is deleted. By default, skip isn't specified, and the DB cluster - // snapshot is created. By default, this parameter is disabled. You must specify a - // FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled. + // snapshot is created. By default, this parameter is disabled. + // + // You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is + // disabled. SkipFinalSnapshot *bool noSmithyDocumentSerde @@ -71,20 +87,27 @@ type DeleteDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DeleteDBClusterEndpoint.go b/service/rds/api_op_DeleteDBClusterEndpoint.go index df80ee539ae..668685a6271 100644 --- a/service/rds/api_op_DeleteDBClusterEndpoint.go +++ b/service/rds/api_op_DeleteDBClusterEndpoint.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This -// action only applies to Aurora DB clusters. +// Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. +// +// This action only applies to Aurora DB clusters. func (c *Client) DeleteDBClusterEndpoint(ctx context.Context, params *DeleteDBClusterEndpointInput, optFns ...func(*Options)) (*DeleteDBClusterEndpointOutput, error) { if params == nil { params = &DeleteDBClusterEndpointInput{} @@ -41,9 +42,13 @@ 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 // // For the data structure that represents Amazon RDS DB instance endpoints, see diff --git a/service/rds/api_op_DeleteDBClusterParameterGroup.go b/service/rds/api_op_DeleteDBClusterParameterGroup.go index eb4450556aa..7f0247ab9f3 100644 --- a/service/rds/api_op_DeleteDBClusterParameterGroup.go +++ b/service/rds/api_op_DeleteDBClusterParameterGroup.go @@ -11,11 +11,14 @@ 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) -// 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) -// in the Amazon RDS User Guide. +// to be deleted can't be associated with any DB clusters. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *DeleteDBClusterParameterGroupInput, optFns ...func(*Options)) (*DeleteDBClusterParameterGroupOutput, error) { if params == nil { params = &DeleteDBClusterParameterGroupInput{} @@ -33,9 +36,14 @@ func (c *Client) DeleteDBClusterParameterGroup(ctx context.Context, params *Dele type DeleteDBClusterParameterGroupInput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. // // This member is required. diff --git a/service/rds/api_op_DeleteDBClusterSnapshot.go b/service/rds/api_op_DeleteDBClusterSnapshot.go index 52faab3c8ef..1cd440916b2 100644 --- a/service/rds/api_op_DeleteDBClusterSnapshot.go +++ b/service/rds/api_op_DeleteDBClusterSnapshot.go @@ -12,11 +12,16 @@ 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) -// 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) -// in the Amazon RDS User Guide. +// 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?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBClusterSnapshotInput, optFns ...func(*Options)) (*DeleteDBClusterSnapshotOutput, error) { if params == nil { params = &DeleteDBClusterSnapshotInput{} @@ -34,8 +39,10 @@ func (c *Client) DeleteDBClusterSnapshot(ctx context.Context, params *DeleteDBCl type DeleteDBClusterSnapshotInput struct { - // The identifier of the DB cluster snapshot to delete. Constraints: Must be the - // name of an existing DB cluster snapshot in the available state. + // The identifier of the DB cluster snapshot to delete. + // + // Constraints: Must be the name of an existing DB cluster snapshot in the + // available state. // // This member is required. DBClusterSnapshotIdentifier *string @@ -45,8 +52,10 @@ type DeleteDBClusterSnapshotInput struct { type DeleteDBClusterSnapshotOutput struct { - // Contains the details for an Amazon RDS DB cluster snapshot This data type is - // used as a response element in the DescribeDBClusterSnapshots action. + // Contains the details for an Amazon RDS 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/rds/api_op_DeleteDBInstance.go b/service/rds/api_op_DeleteDBInstance.go index ed68730cea8..d16b63766fd 100644 --- a/service/rds/api_op_DeleteDBInstance.go +++ b/service/rds/api_op_DeleteDBInstance.go @@ -13,26 +13,33 @@ import ( // Deletes a previously provisioned DB instance. When you delete a DB instance, // all automated backups for that instance are deleted and can't be recovered. -// However, manual DB snapshots of the DB instance aren't deleted. If you request a -// final DB snapshot, the status of the Amazon RDS DB instance is deleting until -// the DB snapshot is created. This operation can't be canceled or reverted after -// it begins. To monitor the status of this operation, use DescribeDBInstance . +// However, manual DB snapshots of the DB instance aren't deleted. +// +// If you request a final DB snapshot, the status of the Amazon RDS DB instance is +// deleting until the DB snapshot is created. This operation can't be canceled or +// reverted after it begins. To monitor the status of this operation, use +// DescribeDBInstance . +// // 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 +// 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. // // To delete a DB instance in this case, first use the PromoteReadReplicaDBCluster // operation to promote the DB cluster so that it's no longer a read replica. After // the promotion completes, use the DeleteDBInstance operation to delete the final -// instance in the DB cluster. For RDS Custom DB instances, deleting the DB -// instance permanently deletes the EC2 instance and the associated EBS volumes. -// Make sure that you don't terminate or delete these resources before you delete -// the DB instance. Otherwise, deleting the DB instance and creation of the final -// snapshot might fail. +// instance in the DB cluster. +// +// For RDS Custom DB instances, deleting the DB instance permanently deletes the +// EC2 instance and the associated EBS volumes. Make sure that you don't terminate +// or delete these resources before you delete the DB instance. Otherwise, deleting +// the DB instance and creation of the final snapshot might fail. func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceInput, optFns ...func(*Options)) (*DeleteDBInstanceOutput, error) { if params == nil { params = &DeleteDBInstanceInput{} @@ -51,7 +58,10 @@ func (c *Client) DeleteDBInstance(ctx context.Context, params *DeleteDBInstanceI type DeleteDBInstanceInput struct { // The DB instance identifier for the DB instance to be deleted. This parameter - // isn't case-sensitive. Constraints: + // isn't case-sensitive. + // + // Constraints: + // // - Must match the name of an existing DB instance. // // This member is required. @@ -63,12 +73,21 @@ type DeleteDBInstanceInput struct { 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: + // 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. FinalDBSnapshotIdentifier *string @@ -76,12 +95,19 @@ type DeleteDBInstanceInput struct { // the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If // you don't enable this parameter, RDS creates a DB snapshot 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. + // 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. SkipFinalSnapshot *bool noSmithyDocumentSerde @@ -89,9 +115,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go b/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go index 709ece80cba..4f6bf8451d8 100644 --- a/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go +++ b/service/rds/api_op_DeleteDBInstanceAutomatedBackup.go @@ -33,6 +33,7 @@ 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 . + // // This setting doesn't apply to RDS Custom. DBInstanceAutomatedBackupsArn *string diff --git a/service/rds/api_op_DeleteDBParameterGroup.go b/service/rds/api_op_DeleteDBParameterGroup.go index fe538c328b4..a2d1e9fcb8a 100644 --- a/service/rds/api_op_DeleteDBParameterGroup.go +++ b/service/rds/api_op_DeleteDBParameterGroup.go @@ -29,9 +29,14 @@ func (c *Client) DeleteDBParameterGroup(ctx context.Context, params *DeleteDBPar type DeleteDBParameterGroupInput struct { - // The name of the DB parameter group. Constraints: + // 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 // // This member is required. diff --git a/service/rds/api_op_DeleteDBSecurityGroup.go b/service/rds/api_op_DeleteDBSecurityGroup.go index be67489a009..c70ffa14d99 100644 --- a/service/rds/api_op_DeleteDBSecurityGroup.go +++ b/service/rds/api_op_DeleteDBSecurityGroup.go @@ -10,14 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon RDS User Guide. +// 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]in the Amazon EC2 User Guide, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare], and [Moving a DB instance not in a VPC into a VPC] in the +// Amazon RDS User Guide. +// +// [Migrate from EC2-Classic to a VPC]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html +// [EC2-Classic Networking is Retiring – Here’s How to Prepare]: http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/ +// [Moving a DB instance not in a VPC into a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html func (c *Client) DeleteDBSecurityGroup(ctx context.Context, params *DeleteDBSecurityGroupInput, optFns ...func(*Options)) (*DeleteDBSecurityGroupOutput, error) { if params == nil { params = &DeleteDBSecurityGroupInput{} @@ -35,11 +39,18 @@ func (c *Client) DeleteDBSecurityGroup(ctx context.Context, params *DeleteDBSecu type DeleteDBSecurityGroupInput struct { - // The name of the DB security group to delete. You can't delete the default DB - // security group. Constraints: + // 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" // // This member is required. diff --git a/service/rds/api_op_DeleteDBShardGroup.go b/service/rds/api_op_DeleteDBShardGroup.go index 7895e9da544..e4cf2d2b94e 100644 --- a/service/rds/api_op_DeleteDBShardGroup.go +++ b/service/rds/api_op_DeleteDBShardGroup.go @@ -40,10 +40,13 @@ type DeleteDBShardGroupOutput struct { // Specifies whether to create standby instances for the DB shard group. Valid // values are the following: + // // - 0 - Creates a single, primary DB instance for each physical shard. This is // the default value, and the only one supported for the preview. + // // - 1 - Creates a primary DB instance and a standby instance in a different // Availability Zone (AZ) for each physical shard. + // // - 2 - Creates a primary DB instance and two standby instances in different // AZs for each physical shard. ComputeRedundancy *int32 @@ -64,16 +67,21 @@ type DeleteDBShardGroupOutput struct { // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 - // Indicates whether the DB shard group is publicly accessible. When the DB shard - // group is publicly accessible, its Domain Name System (DNS) endpoint resolves to - // the private IP address from within the DB shard group's virtual private cloud - // (VPC). It resolves to the public IP address from outside of the DB shard group's - // VPC. Access to the DB shard group is ultimately controlled by the security group - // it uses. That public access isn't permitted if the security group assigned to - // the DB shard group doesn't permit it. When the DB shard group isn't publicly - // accessible, it is an internal DB shard group with a DNS name that resolves to a - // private IP address. For more information, see CreateDBShardGroup . This setting - // is only for Aurora Limitless Database. + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately + // controlled by the security group it uses. That public access isn't permitted if + // the security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. diff --git a/service/rds/api_op_DeleteDBSnapshot.go b/service/rds/api_op_DeleteDBSnapshot.go index f1550d437b9..53a0bffed44 100644 --- a/service/rds/api_op_DeleteDBSnapshot.go +++ b/service/rds/api_op_DeleteDBSnapshot.go @@ -12,7 +12,9 @@ import ( ) // Deletes a DB snapshot. If the snapshot is being copied, the copy operation is -// terminated. The DB snapshot must be in the available state to be deleted. +// terminated. +// +// The DB snapshot must be in the available state to be deleted. func (c *Client) DeleteDBSnapshot(ctx context.Context, params *DeleteDBSnapshotInput, optFns ...func(*Options)) (*DeleteDBSnapshotOutput, error) { if params == nil { params = &DeleteDBSnapshotInput{} @@ -30,8 +32,9 @@ func (c *Client) DeleteDBSnapshot(ctx context.Context, params *DeleteDBSnapshotI type DeleteDBSnapshotInput struct { - // The DB snapshot identifier. Constraints: Must be the name of an existing DB - // snapshot in the available state. + // The DB snapshot identifier. + // + // Constraints: Must be the name of an existing DB snapshot in the available state. // // This member is required. DBSnapshotIdentifier *string @@ -41,8 +44,9 @@ type DeleteDBSnapshotInput struct { type DeleteDBSnapshotOutput struct { - // Contains the details of an Amazon RDS DB snapshot. This data type is used as a - // response element in the DescribeDBSnapshots action. + // Contains the details of an Amazon RDS DB snapshot. + // + // This data type is used as a response element in the DescribeDBSnapshots action. DBSnapshot *types.DBSnapshot // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DeleteDBSubnetGroup.go b/service/rds/api_op_DeleteDBSubnetGroup.go index 37165f78a54..6de834ded34 100644 --- a/service/rds/api_op_DeleteDBSubnetGroup.go +++ b/service/rds/api_op_DeleteDBSubnetGroup.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a DB subnet group. The specified database subnet group must not be -// associated with any DB instances. +// Deletes a DB subnet group. +// +// The specified database subnet group must not be associated with any DB +// instances. func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnetGroupInput, optFns ...func(*Options)) (*DeleteDBSubnetGroupOutput, error) { if params == nil { params = &DeleteDBSubnetGroupInput{} @@ -29,9 +31,14 @@ func (c *Client) DeleteDBSubnetGroup(ctx context.Context, params *DeleteDBSubnet 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. - // Must not be default. Example: mydbsubnetgroup + // 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. Must not be + // default. + // + // Example: mydbsubnetgroup // // This member is required. DBSubnetGroupName *string diff --git a/service/rds/api_op_DeleteGlobalCluster.go b/service/rds/api_op_DeleteGlobalCluster.go index aa26be80c6c..21264b5635a 100644 --- a/service/rds/api_op_DeleteGlobalCluster.go +++ b/service/rds/api_op_DeleteGlobalCluster.go @@ -12,8 +12,9 @@ import ( ) // Deletes a global database cluster. The primary and secondary clusters must -// already be detached or destroyed first. This action only applies to Aurora DB -// clusters. +// already be detached or destroyed first. +// +// This action only applies to Aurora DB clusters. func (c *Client) DeleteGlobalCluster(ctx context.Context, params *DeleteGlobalClusterInput, optFns ...func(*Options)) (*DeleteGlobalClusterOutput, error) { if params == nil { params = &DeleteGlobalClusterInput{} diff --git a/service/rds/api_op_DeleteIntegration.go b/service/rds/api_op_DeleteIntegration.go index d212867bc38..a76bda34885 100644 --- a/service/rds/api_op_DeleteIntegration.go +++ b/service/rds/api_op_DeleteIntegration.go @@ -41,9 +41,10 @@ type DeleteIntegrationInput struct { // A zero-ETL integration with Amazon Redshift. type DeleteIntegrationOutput struct { - // The encryption context for the integration. For more information, see - // Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the Amazon Web Services Key Management Service Developer Guide. + // The encryption context for the integration. For more information, see [Encryption context] in the + // Amazon Web Services Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). @@ -76,8 +77,9 @@ type DeleteIntegrationOutput struct { // The current status of the integration. Status types.IntegrationStatus - // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // The ARN of the Redshift data warehouse used as the target for replication. diff --git a/service/rds/api_op_DeleteOptionGroup.go b/service/rds/api_op_DeleteOptionGroup.go index 61b10f88f44..ec475404df1 100644 --- a/service/rds/api_op_DeleteOptionGroup.go +++ b/service/rds/api_op_DeleteOptionGroup.go @@ -28,8 +28,9 @@ func (c *Client) DeleteOptionGroup(ctx context.Context, params *DeleteOptionGrou type DeleteOptionGroupInput struct { - // The name of the option group to be deleted. You can't delete default option - // groups. + // The name of the option group to be deleted. + // + // You can't delete default option groups. // // This member is required. OptionGroupName *string diff --git a/service/rds/api_op_DeleteTenantDatabase.go b/service/rds/api_op_DeleteTenantDatabase.go index cd2617fe3a9..bb2ee997955 100644 --- a/service/rds/api_op_DeleteTenantDatabase.go +++ b/service/rds/api_op_DeleteTenantDatabase.go @@ -12,8 +12,10 @@ import ( ) // Deletes a tenant database from your DB instance. This command only applies to -// RDS for Oracle container database (CDB) instances. You can't delete a tenant -// database when it is the only tenant in the DB instance. +// RDS for Oracle container database (CDB) instances. +// +// You can't delete a tenant database when it is the only tenant in the DB +// instance. func (c *Client) DeleteTenantDatabase(ctx context.Context, params *DeleteTenantDatabaseInput, optFns ...func(*Options)) (*DeleteTenantDatabaseOutput, error) { if params == nil { params = &DeleteTenantDatabaseInput{} @@ -45,8 +47,10 @@ type DeleteTenantDatabaseInput struct { TenantDBName *string // 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. + // SkipFinalSnapshot parameter is disabled. + // + // If you enable this parameter and also enable SkipFinalShapshot , the command + // results in an error. FinalDBSnapshotIdentifier *string // Specifies whether to skip the creation of a final DB snapshot before removing diff --git a/service/rds/api_op_DescribeAccountAttributes.go b/service/rds/api_op_DescribeAccountAttributes.go index 0cc5e0c4386..0502c56b5db 100644 --- a/service/rds/api_op_DescribeAccountAttributes.go +++ b/service/rds/api_op_DescribeAccountAttributes.go @@ -14,7 +14,9 @@ import ( // Lists all of the attributes for a customer account. The attributes include // Amazon RDS quotas for the account, such as the number of DB instances allowed. // The description for a quota includes the quota name, current usage toward that -// quota, and the quota's maximum value. This command doesn't take any parameters. +// quota, and the quota's maximum value. +// +// This command doesn't take any parameters. func (c *Client) DescribeAccountAttributes(ctx context.Context, params *DescribeAccountAttributesInput, optFns ...func(*Options)) (*DescribeAccountAttributesOutput, error) { if params == nil { params = &DescribeAccountAttributesInput{} diff --git a/service/rds/api_op_DescribeBlueGreenDeployments.go b/service/rds/api_op_DescribeBlueGreenDeployments.go index 7018dc16c09..4f7b8521fbb 100644 --- a/service/rds/api_op_DescribeBlueGreenDeployments.go +++ b/service/rds/api_op_DescribeBlueGreenDeployments.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes one or more 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) -// in the Amazon Aurora User Guide. +// Describes one or more blue/green deployments. +// +// For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html func (c *Client) DescribeBlueGreenDeployments(ctx context.Context, params *DescribeBlueGreenDeploymentsInput, optFns ...func(*Options)) (*DescribeBlueGreenDeploymentsOutput, error) { if params == nil { params = &DescribeBlueGreenDeploymentsInput{} @@ -35,21 +36,29 @@ type DescribeBlueGreenDeploymentsInput struct { // The blue/green deployment identifier. If you specify this parameter, the // response only includes information about the specific blue/green deployment. - // This parameter isn't case-sensitive. Constraints: + // This parameter isn't case-sensitive. + // + // Constraints: + // // - Must match an existing blue/green deployment identifier. BlueGreenDeploymentIdentifier *string - // A filter that specifies one or more blue/green deployments to describe. Valid - // Values: + // A filter that specifies one or more blue/green deployments to describe. + // + // Valid Values: + // // - 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. @@ -62,9 +71,14 @@ type DescribeBlueGreenDeploymentsInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: + // // - Must be a minimum of 20. + // // - Can't exceed 100. MaxRecords *int32 @@ -179,9 +193,14 @@ var _ DescribeBlueGreenDeploymentsAPIClient = (*Client)(nil) type DescribeBlueGreenDeploymentsPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: + // // - Must be a minimum of 20. + // // - Can't exceed 100. Limit int32 diff --git a/service/rds/api_op_DescribeCertificates.go b/service/rds/api_op_DescribeCertificates.go index b72669a453a..e375e2e7b21 100644 --- a/service/rds/api_op_DescribeCertificates.go +++ b/service/rds/api_op_DescribeCertificates.go @@ -12,11 +12,13 @@ import ( ) // Lists the set of certificate authority (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) -// in the Amazon Aurora User Guide. +// for this Amazon Web Services account. +// +// For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon +// Aurora User Guide. +// +// [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 func (c *Client) DescribeCertificates(ctx context.Context, params *DescribeCertificatesInput, optFns ...func(*Options)) (*DescribeCertificatesOutput, error) { if params == nil { params = &DescribeCertificatesInput{} @@ -36,7 +38,10 @@ 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: + // isn't case-sensitive. + // + // Constraints: + // // - Must match an existing CertificateIdentifier. CertificateIdentifier *string @@ -50,7 +55,10 @@ type DescribeCertificatesInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -172,7 +180,10 @@ var _ DescribeCertificatesAPIClient = (*Client)(nil) type DescribeCertificatesPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeDBClusterAutomatedBackups.go b/service/rds/api_op_DescribeDBClusterAutomatedBackups.go index 7bb74db6ddf..c53855d03ec 100644 --- a/service/rds/api_op_DescribeDBClusterAutomatedBackups.go +++ b/service/rds/api_op_DescribeDBClusterAutomatedBackups.go @@ -14,8 +14,9 @@ import ( // Displays backups for both current and deleted DB clusters. For example, use // this operation to find details about automated backups for previously deleted // clusters. Current clusters are returned for both the -// DescribeDBClusterAutomatedBackups and DescribeDBClusters operations. All -// parameters are optional. +// DescribeDBClusterAutomatedBackups and DescribeDBClusters operations. +// +// All parameters are optional. func (c *Client) DescribeDBClusterAutomatedBackups(ctx context.Context, params *DescribeDBClusterAutomatedBackupsInput, optFns ...func(*Options)) (*DescribeDBClusterAutomatedBackupsOutput, error) { if params == nil { params = &DescribeDBClusterAutomatedBackupsInput{} @@ -43,17 +44,23 @@ type DescribeDBClusterAutomatedBackupsInput struct { // This parameter isn't case-sensitive. DbClusterResourceId *string - // A filter that specifies which resources to return based on status. Supported - // filters are the following: + // A filter that specifies which resources to return based on status. + // + // Supported filters are the following: + // // - status + // // - retained - Automated backups for deleted clusters and after backup // replication is stopped. + // // - db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names // (ARNs). The results list includes only information about the DB cluster // automated backups identified by these ARNs. + // // - db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource // Names (ARNs). The results list includes only information about the DB cluster // resources identified by these ARNs. + // // Returns all resources by default. The status for each resource is specified in // the response. Filters []types.Filter diff --git a/service/rds/api_op_DescribeDBClusterBacktracks.go b/service/rds/api_op_DescribeDBClusterBacktracks.go index 7e9a3b2c223..70e22e41d4f 100644 --- a/service/rds/api_op_DescribeDBClusterBacktracks.go +++ b/service/rds/api_op_DescribeDBClusterBacktracks.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB -// clusters. +// Returns information about backtracks for a DB cluster. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// This action only applies to Aurora MySQL DB clusters. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html func (c *Client) DescribeDBClusterBacktracks(ctx context.Context, params *DescribeDBClusterBacktracksInput, optFns ...func(*Options)) (*DescribeDBClusterBacktracksOutput, error) { if params == nil { params = &DescribeDBClusterBacktracksInput{} @@ -33,34 +36,53 @@ func (c *Client) DescribeDBClusterBacktracks(ctx context.Context, params *Descri type DescribeDBClusterBacktracksInput struct { // The DB cluster identifier of the DB cluster to be described. This parameter is - // stored as a lowercase string. Constraints: + // 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 // If specified, this value is the backtrack identifier of the backtrack to be - // described. Constraints: + // described. + // + // Constraints: + // // - Must contain a valid universally unique identifier (UUID). For more - // information about UUIDs, see Universally unique identifier (https://en.wikipedia.org/wiki/Universally_unique_identifier) - // . + // information about UUIDs, see [Universally unique identifier]. + // // Example: 123e4567-e89b-12d3-a456-426655440000 + // + // [Universally unique identifier]: https://en.wikipedia.org/wiki/Universally_unique_identifier 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. + // + // - 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 @@ -70,7 +92,10 @@ type DescribeDBClusterBacktracksInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -186,7 +211,10 @@ var _ DescribeDBClusterBacktracksAPIClient = (*Client)(nil) type DescribeDBClusterBacktracksPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeDBClusterEndpoints.go b/service/rds/api_op_DescribeDBClusterEndpoints.go index d72e2b779c7..efbb7130052 100644 --- a/service/rds/api_op_DescribeDBClusterEndpoints.go +++ b/service/rds/api_op_DescribeDBClusterEndpoints.go @@ -11,8 +11,9 @@ 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{} @@ -56,7 +57,10 @@ type DescribeDBClusterEndpointsInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -172,7 +176,10 @@ var _ DescribeDBClusterEndpointsAPIClient = (*Client)(nil) type DescribeDBClusterEndpointsPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeDBClusterParameterGroups.go b/service/rds/api_op_DescribeDBClusterParameterGroups.go index cf1d858c9c2..d6b0a581da1 100644 --- a/service/rds/api_op_DescribeDBClusterParameterGroups.go +++ b/service/rds/api_op_DescribeDBClusterParameterGroups.go @@ -13,11 +13,14 @@ 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) -// 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) -// in the Amazon RDS User Guide. +// the description of the specified DB cluster parameter group. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *DescribeDBClusterParameterGroupsInput, optFns ...func(*Options)) (*DescribeDBClusterParameterGroupsOutput, error) { if params == nil { params = &DescribeDBClusterParameterGroupsInput{} @@ -36,7 +39,9 @@ func (c *Client) DescribeDBClusterParameterGroups(ctx context.Context, params *D 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. DBClusterParameterGroupName *string @@ -51,7 +56,10 @@ type DescribeDBClusterParameterGroupsInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -167,7 +175,10 @@ var _ DescribeDBClusterParameterGroupsAPIClient = (*Client)(nil) type DescribeDBClusterParameterGroupsPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeDBClusterParameters.go b/service/rds/api_op_DescribeDBClusterParameters.go index 52a6b078a02..8494644b99f 100644 --- a/service/rds/api_op_DescribeDBClusterParameters.go +++ b/service/rds/api_op_DescribeDBClusterParameters.go @@ -11,11 +11,14 @@ 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) -// 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) -// in the Amazon RDS User Guide. +// Returns the detailed parameter list for a particular DB cluster parameter group. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *DescribeDBClusterParametersInput, optFns ...func(*Options)) (*DescribeDBClusterParametersOutput, error) { if params == nil { params = &DescribeDBClusterParametersInput{} @@ -34,7 +37,10 @@ func (c *Client) DescribeDBClusterParameters(ctx context.Context, params *Descri type DescribeDBClusterParametersInput struct { // The name of a specific DB cluster parameter group to return parameter details - // for. Constraints: + // for. + // + // Constraints: + // // - If supplied, must match the name of an existing DBClusterParameterGroup. // // This member is required. @@ -50,13 +56,21 @@ type DescribeDBClusterParametersInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // A specific source to return parameters for. Valid Values: + // A specific source to return parameters for. + // + // Valid Values: + // // - customer + // // - engine + // // - service Source *string @@ -173,7 +187,10 @@ var _ DescribeDBClusterParametersAPIClient = (*Client)(nil) type DescribeDBClusterParametersPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go b/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go index 6fecc936c93..a1b0bec39d8 100644 --- a/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go +++ b/service/rds/api_op_DescribeDBClusterSnapshotAttributes.go @@ -12,15 +12,18 @@ import ( ) // 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 -// values for the restore attribute, then the manual DB cluster snapshot is public -// and can be copied or restored by all Amazon Web Services accounts. To add or -// remove access for an Amazon Web Services 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. +// 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 values for +// the restore attribute, then the manual DB cluster snapshot is public and can be +// copied or restored by all Amazon Web Services accounts. +// +// To add or remove access for an Amazon Web Services 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. func (c *Client) DescribeDBClusterSnapshotAttributes(ctx context.Context, params *DescribeDBClusterSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotAttributesOutput, error) { if params == nil { params = &DescribeDBClusterSnapshotAttributesInput{} @@ -49,10 +52,11 @@ type DescribeDBClusterSnapshotAttributesInput struct { type DescribeDBClusterSnapshotAttributesOutput struct { // Contains the results of a successful call to the - // DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot - // attributes are used to authorize other Amazon Web Services accounts to copy or - // restore a manual DB cluster snapshot. For more information, see the - // ModifyDBClusterSnapshotAttribute API action. + // DescribeDBClusterSnapshotAttributes API action. + // + // Manual DB cluster snapshot attributes are used to authorize other Amazon Web + // Services accounts to copy or restore a manual DB cluster snapshot. For more + // information, see the ModifyDBClusterSnapshotAttribute API action. DBClusterSnapshotAttributesResult *types.DBClusterSnapshotAttributesResult // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBClusterSnapshots.go b/service/rds/api_op_DescribeDBClusterSnapshots.go index 4f8dab2391e..b0a4882458b 100644 --- a/service/rds/api_op_DescribeDBClusterSnapshots.go +++ b/service/rds/api_op_DescribeDBClusterSnapshots.go @@ -18,11 +18,15 @@ 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) -// 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) -// in the Amazon RDS User Guide. +// pagination. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DescribeDBClusterSnapshots(ctx context.Context, params *DescribeDBClusterSnapshotsInput, optFns ...func(*Options)) (*DescribeDBClusterSnapshotsOutput, error) { if params == nil { params = &DescribeDBClusterSnapshotsInput{} @@ -42,14 +46,21 @@ 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: + // parameter. This parameter isn't case-sensitive. + // + // Constraints: + // // - 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: + // 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 @@ -57,26 +68,34 @@ type DescribeDBClusterSnapshotsInput struct { // A specific DB cluster resource ID to describe. DbClusterResourceId *string - // A filter that specifies one or more DB cluster snapshots to describe. Supported - // filters: + // 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. Filters []types.Filter // Specifies whether to include manual DB cluster snapshots that are public and // can be copied or restored by any Amazon Web Services account. By default, the - // public snapshots are not included. You can share a manual DB cluster snapshot as - // public by using the ModifyDBClusterSnapshotAttribute API action. + // public snapshots are not included. + // + // You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. IncludePublic *bool // Specifies whether to include shared manual DB cluster snapshots from other // Amazon Web Services accounts that this Amazon Web Services account has been // given permission to copy or restore. By default, these snapshots are not - // included. You can give an Amazon Web Services account permission to restore a - // manual DB cluster snapshot from another Amazon Web Services account by the + // included. + // + // You can give an Amazon Web Services account permission to restore a manual DB + // cluster snapshot from another Amazon Web Services account by the // ModifyDBClusterSnapshotAttribute API action. IncludeShared *bool @@ -87,27 +106,36 @@ type DescribeDBClusterSnapshotsInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // 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 . + // 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 @@ -223,7 +251,10 @@ var _ DescribeDBClusterSnapshotsAPIClient = (*Client)(nil) type DescribeDBClusterSnapshotsPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 @@ -340,12 +371,13 @@ type DBClusterSnapshotAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClusterSnapshotsInput, *DescribeDBClusterSnapshotsOutput, error) (bool, error) } @@ -651,12 +683,13 @@ type DBClusterSnapshotDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClusterSnapshotsInput, *DescribeDBClusterSnapshotsOutput, error) (bool, error) } diff --git a/service/rds/api_op_DescribeDBClusters.go b/service/rds/api_op_DescribeDBClusters.go index a6a34f02f59..55da3c8d160 100644 --- a/service/rds/api_op_DescribeDBClusters.go +++ b/service/rds/api_op_DescribeDBClusters.go @@ -18,12 +18,18 @@ import ( ) // Describes existing 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) -// 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) -// in the Amazon RDS User Guide. This operation can also return information for -// Amazon Neptune DB instances and Amazon DocumentDB instances. +// supports pagination. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// This operation can also return information for Amazon Neptune DB instances and +// Amazon DocumentDB instances. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClustersInput, optFns ...func(*Options)) (*DescribeDBClustersOutput, error) { if params == nil { params = &DescribeDBClustersInput{} @@ -44,21 +50,30 @@ 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 for only the // specific DB cluster is returned. This parameter isn't case-sensitive. + // // Constraints: + // // - If supplied, must match an existing DB cluster identifier. DBClusterIdentifier *string - // A filter that specifies one or more DB clusters to describe. Supported Filters: + // 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 @@ -74,7 +89,10 @@ type DescribeDBClustersInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100 MaxRecords *int32 @@ -188,7 +206,10 @@ var _ DescribeDBClustersAPIClient = (*Client)(nil) type DescribeDBClustersPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100 Limit int32 @@ -301,12 +322,13 @@ type DBClusterAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClustersInput, *DescribeDBClustersOutput, error) (bool, error) } @@ -608,12 +630,13 @@ type DBClusterDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBClustersInput, *DescribeDBClustersOutput, error) (bool, error) } diff --git a/service/rds/api_op_DescribeDBEngineVersions.go b/service/rds/api_op_DescribeDBEngineVersions.go index 0cf9e2621ec..b21553781d3 100644 --- a/service/rds/api_op_DescribeDBEngineVersions.go +++ b/service/rds/api_op_DescribeDBEngineVersions.go @@ -30,7 +30,9 @@ func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeD type DescribeDBEngineVersionsInput struct { // The name of a specific DB parameter group family to return details for. + // // Constraints: + // // - If supplied, must match an existing DB parameter group family. DBParameterGroupFamily *string @@ -38,52 +40,88 @@ type DescribeDBEngineVersionsInput struct { // the engine and major version combination. DefaultOnly *bool - // The database engine to return version details for. Valid Values: + // The database engine to return version details for. + // + // Valid Values: + // // - aurora-mysql + // // - aurora-postgresql + // // - custom-oracle-ee + // // - custom-oracle-ee-cdb + // // - custom-oracle-se2 + // // - custom-oracle-se2-cdb + // // - db2-ae + // // - db2-se + // // - mariadb + // // - mysql + // // - oracle-ee + // // - oracle-ee-cdb + // // - oracle-se2 + // // - oracle-se2-cdb + // // - postgres + // // - sqlserver-ee + // // - sqlserver-se + // // - sqlserver-ex + // // - sqlserver-web Engine *string - // A specific database engine version to return details for. Example: 5.1.49 + // A specific database engine version to return details for. + // + // Example: 5.1.49 EngineVersion *string - // A filter that specifies one or more DB engine versions to describe. Supported - // filters: + // 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 Filters []types.Filter @@ -92,19 +130,23 @@ type DescribeDBEngineVersionsInput struct { IncludeAll *bool // Specifies 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 list - // of supported character sets for each engine version. For RDS Custom, the default - // is not to list supported character sets. If you enable this parameter, RDS - // Custom returns no results. + // of supported character sets for each engine version. + // + // For RDS Custom, the default is not to list supported character sets. If you + // enable this parameter, RDS Custom returns no results. ListSupportedCharacterSets *bool - // Specifies whether to list the supported time zones for each engine version. If - // this parameter is enabled and the requested engine supports the TimeZone + // Specifies 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 supported time - // zones for each engine version. For RDS Custom, the default is not to list - // supported time zones. If you enable this parameter, RDS Custom returns no - // results. + // zones for each engine version. + // + // For RDS Custom, the default is not to list supported time zones. If you enable + // this parameter, RDS Custom returns no results. ListSupportedTimezones *bool // An optional pagination token provided by a previous request. If this parameter @@ -114,7 +156,10 @@ type DescribeDBEngineVersionsInput struct { // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so you can retrieve the remaining results. Default: 100 + // the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -231,7 +276,10 @@ var _ DescribeDBEngineVersionsAPIClient = (*Client)(nil) type DescribeDBEngineVersionsPaginatorOptions struct { // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so you can retrieve the remaining results. Default: 100 + // the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go b/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go index 1607e23755a..59423ec2876 100644 --- a/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go +++ b/service/rds/api_op_DescribeDBInstanceAutomatedBackups.go @@ -15,7 +15,9 @@ import ( // operation to find details about automated backups for previously deleted // instances. Current instances with retention periods greater than zero (0) are // returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances -// operations. All parameters are optional. +// operations. +// +// All parameters are optional. func (c *Client) DescribeDBInstanceAutomatedBackups(ctx context.Context, params *DescribeDBInstanceAutomatedBackupsInput, optFns ...func(*Options)) (*DescribeDBInstanceAutomatedBackupsOutput, error) { if params == nil { params = &DescribeDBInstanceAutomatedBackupsInput{} @@ -37,6 +39,7 @@ 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 . + // // This setting doesn't apply to RDS Custom. DBInstanceAutomatedBackupsArn *string @@ -50,20 +53,28 @@ type DescribeDBInstanceAutomatedBackupsInput struct { // This parameter isn't case-sensitive. DbiResourceId *string - // A filter that specifies which resources to return based on status. Supported - // filters are the following: + // A filter that specifies which resources to return based on status. + // + // Supported filters are the following: + // // - status + // // - active - Automated backups for current instances. + // // - creating - Automated backups that are waiting for the first automated // snapshot to be available. + // // - retained - Automated backups for deleted instances and after backup // replication is stopped. + // // - 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 diff --git a/service/rds/api_op_DescribeDBInstances.go b/service/rds/api_op_DescribeDBInstances.go index 647c2a341d9..24aa6f0bfdb 100644 --- a/service/rds/api_op_DescribeDBInstances.go +++ b/service/rds/api_op_DescribeDBInstances.go @@ -18,9 +18,10 @@ import ( "time" ) -// Describes provisioned RDS instances. This API supports pagination. This -// operation can also return information for Amazon Neptune DB instances and Amazon -// DocumentDB instances. +// Describes provisioned RDS instances. This API supports pagination. +// +// This operation can also return information for Amazon Neptune DB instances and +// Amazon DocumentDB instances. func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInstancesInput, optFns ...func(*Options)) (*DescribeDBInstancesOutput, error) { if params == nil { params = &DescribeDBInstancesInput{} @@ -40,23 +41,32 @@ 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: + // DB instance is returned. This parameter isn't case-sensitive. + // + // Constraints: + // // - If supplied, must match the identifier of an existing DB instance. DBInstanceIdentifier *string - // A filter that specifies one or more DB instances to describe. Supported - // Filters: + // 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 // only includes 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 @@ -69,7 +79,10 @@ type DescribeDBInstancesInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -186,7 +199,10 @@ type DescribeDBInstancesPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -300,12 +316,13 @@ type DBInstanceAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) } @@ -607,12 +624,13 @@ type DBInstanceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBInstancesInput, *DescribeDBInstancesOutput, error) (bool, error) } diff --git a/service/rds/api_op_DescribeDBLogFiles.go b/service/rds/api_op_DescribeDBLogFiles.go index 7d488551490..ffb0083f6d7 100644 --- a/service/rds/api_op_DescribeDBLogFiles.go +++ b/service/rds/api_op_DescribeDBLogFiles.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of DB log files for the DB instance. This command doesn't apply -// to RDS Custom. +// Returns a list of DB log files for the DB instance. +// +// This command doesn't apply to RDS Custom. func (c *Client) DescribeDBLogFiles(ctx context.Context, params *DescribeDBLogFilesInput, optFns ...func(*Options)) (*DescribeDBLogFilesOutput, error) { if params == nil { params = &DescribeDBLogFilesInput{} @@ -31,7 +32,10 @@ func (c *Client) DescribeDBLogFiles(ctx context.Context, params *DescribeDBLogFi type DescribeDBLogFilesInput struct { // The customer-assigned name of the DB instance that contains the log files you - // want to list. Constraints: + // want to list. + // + // Constraints: + // // - Must match the identifier of an existing DBInstance. // // This member is required. diff --git a/service/rds/api_op_DescribeDBParameterGroups.go b/service/rds/api_op_DescribeDBParameterGroups.go index 2e5ea904539..6c53957a51e 100644 --- a/service/rds/api_op_DescribeDBParameterGroups.go +++ b/service/rds/api_op_DescribeDBParameterGroups.go @@ -31,7 +31,10 @@ 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: + // The name of a specific DB parameter group to return details for. + // + // Constraints: + // // - If supplied, must match the name of an existing DBClusterParameterGroup. DBParameterGroupName *string @@ -46,7 +49,10 @@ type DescribeDBParameterGroupsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -163,7 +169,10 @@ type DescribeDBParameterGroupsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBParameters.go b/service/rds/api_op_DescribeDBParameters.go index 3cad7a5fdbe..ee2ed494463 100644 --- a/service/rds/api_op_DescribeDBParameters.go +++ b/service/rds/api_op_DescribeDBParameters.go @@ -29,7 +29,10 @@ 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: + // The name of a specific DB parameter group to return details for. + // + // Constraints: + // // - If supplied, must match the name of an existing DBParameterGroup. // // This member is required. @@ -46,11 +49,17 @@ type DescribeDBParametersInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 - // The parameter types to return. Default: All parameter types returned Valid - // Values: user | system | engine-default + // The parameter types to return. + // + // Default: All parameter types returned + // + // Valid Values: user | system | engine-default Source *string noSmithyDocumentSerde @@ -167,7 +176,10 @@ type DescribeDBParametersPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBProxies.go b/service/rds/api_op_DescribeDBProxies.go index 160a5820cb7..10efdbcff91 100644 --- a/service/rds/api_op_DescribeDBProxies.go +++ b/service/rds/api_op_DescribeDBProxies.go @@ -44,7 +44,10 @@ type DescribeDBProxiesInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -158,7 +161,10 @@ type DescribeDBProxiesPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBProxyEndpoints.go b/service/rds/api_op_DescribeDBProxyEndpoints.go index 17269773b78..2568fb7dab8 100644 --- a/service/rds/api_op_DescribeDBProxyEndpoints.go +++ b/service/rds/api_op_DescribeDBProxyEndpoints.go @@ -50,7 +50,10 @@ type DescribeDBProxyEndpointsInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -165,7 +168,10 @@ type DescribeDBProxyEndpointsPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBProxyTargetGroups.go b/service/rds/api_op_DescribeDBProxyTargetGroups.go index 663e79647ff..1ffd87d7ab8 100644 --- a/service/rds/api_op_DescribeDBProxyTargetGroups.go +++ b/service/rds/api_op_DescribeDBProxyTargetGroups.go @@ -46,7 +46,10 @@ type DescribeDBProxyTargetGroupsInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The identifier of the DBProxyTargetGroup to describe. @@ -165,7 +168,10 @@ type DescribeDBProxyTargetGroupsPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBProxyTargets.go b/service/rds/api_op_DescribeDBProxyTargets.go index c26f14d36c1..53be11c7fad 100644 --- a/service/rds/api_op_DescribeDBProxyTargets.go +++ b/service/rds/api_op_DescribeDBProxyTargets.go @@ -45,7 +45,10 @@ type DescribeDBProxyTargetsInput 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The identifier of the DBProxyTargetGroup to describe. @@ -164,7 +167,10 @@ type DescribeDBProxyTargetsPaginatorOptions 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 // included in the response so that the remaining results can be retrieved. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBRecommendations.go b/service/rds/api_op_DescribeDBRecommendations.go index fbbdd1d833f..4fb89485127 100644 --- a/service/rds/api_op_DescribeDBRecommendations.go +++ b/service/rds/api_op_DescribeDBRecommendations.go @@ -31,36 +31,58 @@ func (c *Client) DescribeDBRecommendations(ctx context.Context, params *Describe type DescribeDBRecommendationsInput struct { - // A filter that specifies one or more recommendations to describe. Supported - // Filters: + // A filter that specifies one or more recommendations to describe. + // + // Supported Filters: + // // - recommendation-id - Accepts a list of recommendation identifiers. The // results list only includes the recommendations whose identifier is one of the // specified filter values. - // - status - Accepts a list of recommendation statuses. Valid values: + // + // - status - Accepts a list of recommendation statuses. + // + // Valid values: + // // - active - The recommendations which are ready for you to apply. + // // - pending - The applied or scheduled recommendations which are in progress. + // // - resolved - The recommendations which are completed. - // - dismissed - The recommendations that you dismissed. The results list only - // includes the recommendations whose status is one of the specified filter values. + // + // - dismissed - The recommendations that you dismissed. + // + // The results list only includes the recommendations whose status is one of the + // specified filter values. // // - severity - Accepts a list of recommendation severities. The results list // only includes the recommendations whose severity is one of the specified filter - // values. Valid values: + // values. + // + // Valid values: + // // - high + // // - medium + // // - low + // // - informational + // // - type-id - Accepts a list of recommendation type identifiers. The results // list only includes the recommendations whose type is one of the specified filter // values. + // // - dbi-resource-id - Accepts a list of database resource identifiers. The // results list only includes the recommendations that generated for the specified // databases. + // // - cluster-resource-id - Accepts a list of cluster resource identifiers. The // results list only includes the recommendations that generated for the specified // clusters. + // // - pg-arn - Accepts a list of parameter group ARNs. The results list only // includes the recommendations that generated for the specified parameter groups. + // // - cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results // list only includes the recommendations that generated for the specified cluster // parameter groups. @@ -74,19 +96,32 @@ type DescribeDBRecommendationsInput struct { // specified time. LastUpdatedBefore *time.Time - // The language that you choose to return the list of recommendations. Valid - // values: + // The language that you choose to return the list of recommendations. + // + // Valid values: + // // - en + // // - en_UK + // // - de + // // - es + // // - fr + // // - id + // // - it + // // - ja + // // - ko + // // - pt_BR + // // - zh_TW + // // - zh_CN Locale *string diff --git a/service/rds/api_op_DescribeDBSecurityGroups.go b/service/rds/api_op_DescribeDBSecurityGroups.go index 306bcc85740..17ab31c2ad0 100644 --- a/service/rds/api_op_DescribeDBSecurityGroups.go +++ b/service/rds/api_op_DescribeDBSecurityGroups.go @@ -13,13 +13,16 @@ import ( // Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is // 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) -// in the Amazon RDS User Guide. +// 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]in the Amazon EC2 User Guide, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare], and [Moving a DB instance not in a VPC into a VPC] in the +// Amazon RDS User Guide. +// +// [Migrate from EC2-Classic to a VPC]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html +// [EC2-Classic Networking is Retiring – Here’s How to Prepare]: http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/ +// [Moving a DB instance not in a VPC into a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html func (c *Client) DescribeDBSecurityGroups(ctx context.Context, params *DescribeDBSecurityGroupsInput, optFns ...func(*Options)) (*DescribeDBSecurityGroupsOutput, error) { if params == nil { params = &DescribeDBSecurityGroupsInput{} @@ -51,7 +54,10 @@ type DescribeDBSecurityGroupsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -168,7 +174,10 @@ type DescribeDBSecurityGroupsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeDBShardGroups.go b/service/rds/api_op_DescribeDBShardGroups.go index 11ea9a50420..4ce72bd9012 100644 --- a/service/rds/api_op_DescribeDBShardGroups.go +++ b/service/rds/api_op_DescribeDBShardGroups.go @@ -32,7 +32,9 @@ type DescribeDBShardGroupsInput struct { // The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) // of the DB shard group. If this parameter is specified, information for only the // specific DB shard group is returned. This parameter isn't case-sensitive. + // // Constraints: + // // - If supplied, must match an existing DB shard group identifier. DBShardGroupIdentifier *string @@ -46,7 +48,10 @@ type DescribeDBShardGroupsInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100 MaxRecords *int32 diff --git a/service/rds/api_op_DescribeDBSnapshotAttributes.go b/service/rds/api_op_DescribeDBSnapshotAttributes.go index 9e6f4b332f4..99d51e7831c 100644 --- a/service/rds/api_op_DescribeDBSnapshotAttributes.go +++ b/service/rds/api_op_DescribeDBSnapshotAttributes.go @@ -12,14 +12,18 @@ 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, +// 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 // 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 -// Services account to copy or restore a manual DB snapshot, or to make the manual -// DB snapshot public or private, use the ModifyDBSnapshotAttribute API action. +// by all Amazon Web Services accounts. +// +// To add or remove access for an Amazon Web Services account to copy or restore a +// manual DB snapshot, or to make the manual DB snapshot public or private, use the +// ModifyDBSnapshotAttribute API action. func (c *Client) DescribeDBSnapshotAttributes(ctx context.Context, params *DescribeDBSnapshotAttributesInput, optFns ...func(*Options)) (*DescribeDBSnapshotAttributesOutput, error) { if params == nil { params = &DescribeDBSnapshotAttributesInput{} @@ -48,9 +52,11 @@ type DescribeDBSnapshotAttributesInput struct { type DescribeDBSnapshotAttributesOutput struct { // Contains the results of a successful call to the DescribeDBSnapshotAttributes - // API action. Manual DB snapshot attributes are used to authorize other Amazon Web - // Services accounts to copy or restore a manual DB snapshot. For more information, - // see the ModifyDBSnapshotAttribute API action. + // API action. + // + // Manual DB snapshot attributes are used to authorize other Amazon Web Services + // accounts to copy or restore a manual DB snapshot. For more information, see the + // ModifyDBSnapshotAttribute API action. DBSnapshotAttributesResult *types.DBSnapshotAttributesResult // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_DescribeDBSnapshotTenantDatabases.go b/service/rds/api_op_DescribeDBSnapshotTenantDatabases.go index e88cb5f4fcd..7715f1ed923 100644 --- a/service/rds/api_op_DescribeDBSnapshotTenantDatabases.go +++ b/service/rds/api_op_DescribeDBSnapshotTenantDatabases.go @@ -12,10 +12,11 @@ import ( ) // Describes the tenant databases that exist in a DB snapshot. This command only -// applies to RDS for Oracle DB instances in the multi-tenant configuration. You -// can use this command to inspect the tenant databases within a snapshot before -// restoring it. You can't directly interact with the tenant databases in a DB -// snapshot. If you restore a snapshot that was taken from DB instance using the +// applies to RDS for Oracle DB instances in the multi-tenant configuration. +// +// You can use this command to inspect the tenant databases within a snapshot +// before restoring it. You can't directly interact with the tenant databases in a +// DB snapshot. If you restore a snapshot that was taken from DB instance using the // multi-tenant configuration, you restore all its tenant databases. func (c *Client) DescribeDBSnapshotTenantDatabases(ctx context.Context, params *DescribeDBSnapshotTenantDatabasesInput, optFns ...func(*Options)) (*DescribeDBSnapshotTenantDatabasesOutput, error) { if params == nil { @@ -35,33 +36,47 @@ func (c *Client) DescribeDBSnapshotTenantDatabases(ctx context.Context, params * type DescribeDBSnapshotTenantDatabasesInput struct { // The ID of the DB instance used to create the DB snapshots. This parameter isn't - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - If supplied, must match the identifier of an existing DBInstance . DBInstanceIdentifier *string // The ID of a DB snapshot that contains the tenant databases to describe. This - // value is stored as a lowercase string. Constraints: + // value is stored as a lowercase string. + // + // Constraints: + // // - If you specify this parameter, the value must match the ID of an existing // DB snapshot. + // // - If you specify an automatic snapshot, you must also specify SnapshotType . DBSnapshotIdentifier *string // A specific DB resource identifier to describe. DbiResourceId *string - // A filter that specifies one or more tenant databases to describe. Supported - // filters: + // A filter that specifies one or more tenant databases to describe. + // + // Supported filters: + // // - tenant-db-name - Tenant database names. The results list only includes // information about the tenant databases that match these tenant DB names. + // // - tenant-database-resource-id - Tenant database resource identifiers. The // results list only includes information about the tenant databases contained // within the DB snapshots. + // // - dbi-resource-id - DB instance resource identifiers. The results list only // includes information about snapshots containing tenant databases contained // within the DB instances identified by these resource identifiers. + // // - db-instance-id - Accepts DB instance identifiers and DB instance Amazon // Resource Names (ARNs). + // // - db-snapshot-id - Accepts DB snapshot identifiers. + // // - snapshot-type - Accepts types of DB snapshots. Filters []types.Filter @@ -78,13 +93,18 @@ type DescribeDBSnapshotTenantDatabasesInput struct { // The type of DB snapshots to be returned. You can specify one of the following // values: + // // - automated – All DB snapshots that have been automatically taken by Amazon // RDS for my Amazon Web Services account. + // // - manual – All DB snapshots that have been taken by my Amazon Web Services // account. + // // - shared – All manual DB snapshots that have been shared to my Amazon Web // Services account. + // // - public – All DB snapshots that have been marked as public. + // // - awsbackup – All DB snapshots managed by the Amazon Web Services Backup // service. SnapshotType *string diff --git a/service/rds/api_op_DescribeDBSnapshots.go b/service/rds/api_op_DescribeDBSnapshots.go index 5982ac16361..fa5f6e7c1be 100644 --- a/service/rds/api_op_DescribeDBSnapshots.go +++ b/service/rds/api_op_DescribeDBSnapshots.go @@ -37,13 +37,20 @@ func (c *Client) DescribeDBSnapshots(ctx context.Context, params *DescribeDBSnap type DescribeDBSnapshotsInput struct { // The ID of the DB instance to retrieve the list of DB snapshots for. This - // parameter isn't case-sensitive. Constraints: + // parameter isn't case-sensitive. + // + // Constraints: + // // - 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: + // 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. DBSnapshotIdentifier *string @@ -51,29 +58,41 @@ type DescribeDBSnapshotsInput struct { // A specific DB resource ID to describe. DbiResourceId *string - // A filter that specifies one or more DB snapshots to describe. Supported - // filters: + // 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. Filters []types.Filter // Specifies whether to include manual DB cluster snapshots that are public and // can be copied or restored by any Amazon Web Services account. By default, the - // public snapshots are not included. You can share a manual DB snapshot as public - // by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS - // Custom. + // public snapshots are not included. + // + // You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. + // + // This setting doesn't apply to RDS Custom. IncludePublic *bool // Specifies whether to include shared manual DB cluster snapshots from other // Amazon Web Services accounts that this Amazon Web Services account has been // given permission to copy or restore. By default, these snapshots are not - // included. You can give an Amazon Web Services account permission to restore a - // manual DB snapshot from another Amazon Web Services account by using the - // ModifyDBSnapshotAttribute API action. This setting doesn't apply to RDS Custom. + // included. + // + // You can give an Amazon Web Services account permission to restore a manual DB + // snapshot from another Amazon Web Services account by using the + // ModifyDBSnapshotAttribute API action. + // + // This setting doesn't apply to RDS Custom. IncludeShared *bool // An optional pagination token provided by a previous DescribeDBSnapshots @@ -84,31 +103,45 @@ type DescribeDBSnapshotsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // 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. + // Backup service. + // + // For information about Amazon Web Services Backup, see the [Amazon Web Services Backup Developer Guide.] + // + // 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 . + // 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 . + // + // [Amazon Web Services Backup Developer Guide.]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html SnapshotType *string noSmithyDocumentSerde @@ -225,7 +258,10 @@ type DescribeDBSnapshotsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token @@ -339,12 +375,13 @@ type DBSnapshotAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBSnapshotsInput, *DescribeDBSnapshotsOutput, error) (bool, error) } @@ -646,12 +683,13 @@ type DBSnapshotDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeDBSnapshotsInput, *DescribeDBSnapshotsOutput, error) (bool, error) } diff --git a/service/rds/api_op_DescribeDBSubnetGroups.go b/service/rds/api_op_DescribeDBSubnetGroups.go index 980f2d94f97..a01c0045112 100644 --- a/service/rds/api_op_DescribeDBSubnetGroups.go +++ b/service/rds/api_op_DescribeDBSubnetGroups.go @@ -13,8 +13,11 @@ 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]. +// +// [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{} @@ -46,7 +49,10 @@ type DescribeDBSubnetGroupsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -163,7 +169,10 @@ type DescribeDBSubnetGroupsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeEngineDefaultClusterParameters.go b/service/rds/api_op_DescribeEngineDefaultClusterParameters.go index 842d5997d93..3733c911840 100644 --- a/service/rds/api_op_DescribeEngineDefaultClusterParameters.go +++ b/service/rds/api_op_DescribeEngineDefaultClusterParameters.go @@ -12,9 +12,11 @@ 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) -// in the Amazon Aurora User Guide. +// database engine. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html func (c *Client) DescribeEngineDefaultClusterParameters(ctx context.Context, params *DescribeEngineDefaultClusterParametersInput, optFns ...func(*Options)) (*DescribeEngineDefaultClusterParametersOutput, error) { if params == nil { params = &DescribeEngineDefaultClusterParametersInput{} @@ -49,7 +51,10 @@ type DescribeEngineDefaultClusterParametersInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 diff --git a/service/rds/api_op_DescribeEngineDefaultParameters.go b/service/rds/api_op_DescribeEngineDefaultParameters.go index 3317f371afa..b995b67c9e3 100644 --- a/service/rds/api_op_DescribeEngineDefaultParameters.go +++ b/service/rds/api_op_DescribeEngineDefaultParameters.go @@ -30,55 +30,106 @@ func (c *Client) DescribeEngineDefaultParameters(ctx context.Context, params *De type DescribeEngineDefaultParametersInput struct { - // The name of the DB parameter group family. Valid Values: + // The name of the DB parameter group family. + // + // Valid Values: + // // - aurora-mysql5.7 + // // - aurora-mysql8.0 + // // - aurora-postgresql10 + // // - aurora-postgresql11 + // // - aurora-postgresql12 + // // - aurora-postgresql13 + // // - aurora-postgresql14 + // // - custom-oracle-ee-19 + // // - custom-oracle-ee-cdb-19 + // // - db2-ae + // // - db2-se + // // - 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. @@ -95,7 +146,10 @@ type DescribeEngineDefaultParametersInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -206,7 +260,10 @@ var _ DescribeEngineDefaultParametersAPIClient = (*Client)(nil) type DescribeEngineDefaultParametersPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeEventCategories.go b/service/rds/api_op_DescribeEventCategories.go index 7827bc04081..7327d58405f 100644 --- a/service/rds/api_op_DescribeEventCategories.go +++ b/service/rds/api_op_DescribeEventCategories.go @@ -13,9 +13,10 @@ 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]or the [Amazon Aurora User Guide]. +// +// [Amazon RDS User Guide]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html +// [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{} @@ -37,8 +38,10 @@ 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-security-group | db-snapshot | db-cluster-snapshot | db-proxy + // db-proxy . + // + // Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group + // | db-snapshot | db-cluster-snapshot | db-proxy SourceType *string noSmithyDocumentSerde diff --git a/service/rds/api_op_DescribeEventSubscriptions.go b/service/rds/api_op_DescribeEventSubscriptions.go index ce62c4f82ec..06a9890187c 100644 --- a/service/rds/api_op_DescribeEventSubscriptions.go +++ b/service/rds/api_op_DescribeEventSubscriptions.go @@ -13,8 +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. +// 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{} @@ -44,7 +45,10 @@ type DescribeEventSubscriptionsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The name of the RDS event notification subscription you want to describe. @@ -164,7 +168,10 @@ type DescribeEventSubscriptionsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeEvents.go b/service/rds/api_op_DescribeEvents.go index 48193a23a3f..673ef5b7cd4 100644 --- a/service/rds/api_op_DescribeEvents.go +++ b/service/rds/api_op_DescribeEvents.go @@ -16,11 +16,15 @@ import ( // security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the // 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) -// in the Amazon Aurora User Guide. By default, RDS returns events that were -// generated in the past hour. +// RDS Proxy can be obtained by providing the name as a parameter. +// +// For more information on working with events, see [Monitoring Amazon RDS events] in the Amazon RDS User Guide +// and [Monitoring Amazon Aurora events]in the Amazon Aurora User Guide. +// +// By default, RDS returns events that were generated in the past hour. +// +// [Monitoring Amazon RDS events]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html +// [Monitoring Amazon Aurora events]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput, optFns ...func(*Options)) (*DescribeEventsOutput, error) { if params == nil { params = &DescribeEventsInput{} @@ -38,12 +42,17 @@ func (c *Client) DescribeEvents(ctx context.Context, params *DescribeEventsInput type DescribeEventsInput struct { - // The number of minutes to retrieve events for. Default: 60 + // 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 + // 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.] + // + // Example: 2009-07-08T18:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 EndTime *time.Time // A list of event categories that trigger notifications for a event notification @@ -61,25 +70,39 @@ type DescribeEventsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The identifier of the event source for which events are returned. If not - // specified, then all sources are included in the response. Constraints: + // 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. SourceIdentifier *string @@ -88,8 +111,11 @@ type DescribeEventsInput struct { 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 + // 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.] + // + // Example: 2009-07-08T18:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 StartTime *time.Time noSmithyDocumentSerde @@ -204,7 +230,10 @@ type DescribeEventsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeExportTasks.go b/service/rds/api_op_DescribeExportTasks.go index cab3ff148af..d70163dc523 100644 --- a/service/rds/api_op_DescribeExportTasks.go +++ b/service/rds/api_op_DescribeExportTasks.go @@ -35,20 +35,31 @@ type DescribeExportTasksInput struct { // 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: + // 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 @@ -60,8 +71,11 @@ type DescribeExportTasksInput struct { // The maximum number of records to include in the response. If more records exist // than the specified value, a pagination token called a marker is included in the // response. You can use the marker in a later DescribeExportTasks request to - // retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum - // 100. + // retrieve the remaining results. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. @@ -182,8 +196,11 @@ type DescribeExportTasksPaginatorOptions struct { // The maximum number of records to include in the response. If more records exist // than the specified value, a pagination token called a marker is included in the // response. You can use the marker in a later DescribeExportTasks request to - // retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum - // 100. + // retrieve the remaining results. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeGlobalClusters.go b/service/rds/api_op_DescribeGlobalClusters.go index b9ec6699adf..5d0ef8831de 100644 --- a/service/rds/api_op_DescribeGlobalClusters.go +++ b/service/rds/api_op_DescribeGlobalClusters.go @@ -12,8 +12,13 @@ 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) -// in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. +// pagination. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// This action only applies to Aurora DB clusters. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlobalClustersInput, optFns ...func(*Options)) (*DescribeGlobalClustersOutput, error) { if params == nil { params = &DescribeGlobalClustersInput{} @@ -32,14 +37,20 @@ func (c *Client) DescribeGlobalClusters(ctx context.Context, params *DescribeGlo type DescribeGlobalClustersInput struct { // A filter that specifies one or more global database clusters to describe. This - // parameter is case-sensitive. Currently, the only supported filter is region . If - // used, the request returns information about any global cluster with at least one - // member (primary or secondary) in the specified Amazon Web Services Regions. + // parameter is case-sensitive. + // + // Currently, the only supported filter is region . + // + // If used, the request returns information about any global cluster with at least + // one member (primary or secondary) in the specified Amazon Web Services Regions. Filters []types.Filter // 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: + // case-sensitive. + // + // Constraints: + // // - If supplied, must match an existing DBClusterIdentifier. GlobalClusterIdentifier *string @@ -51,7 +62,10 @@ type DescribeGlobalClustersInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -166,7 +180,10 @@ type DescribeGlobalClustersPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeIntegrations.go b/service/rds/api_op_DescribeIntegrations.go index 09ae92a1abb..8366f556f13 100644 --- a/service/rds/api_op_DescribeIntegrations.go +++ b/service/rds/api_op_DescribeIntegrations.go @@ -43,7 +43,10 @@ type DescribeIntegrationsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -156,7 +159,10 @@ type DescribeIntegrationsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeOptionGroupOptions.go b/service/rds/api_op_DescribeOptionGroupOptions.go index a17f54b5ac5..a8d38d0f9ec 100644 --- a/service/rds/api_op_DescribeOptionGroupOptions.go +++ b/service/rds/api_op_DescribeOptionGroupOptions.go @@ -29,19 +29,34 @@ func (c *Client) DescribeOptionGroupOptions(ctx context.Context, params *Describ type DescribeOptionGroupOptionsInput struct { - // The name of the engine to describe options for. Valid Values: + // The name of the engine to describe options for. + // + // Valid Values: + // // - db2-ae + // // - db2-se + // // - 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. @@ -62,7 +77,10 @@ type DescribeOptionGroupOptionsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -177,7 +195,10 @@ type DescribeOptionGroupOptionsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeOptionGroups.go b/service/rds/api_op_DescribeOptionGroups.go index ee738c725b9..336d6c31b8d 100644 --- a/service/rds/api_op_DescribeOptionGroups.go +++ b/service/rds/api_op_DescribeOptionGroups.go @@ -30,19 +30,33 @@ func (c *Client) DescribeOptionGroups(ctx context.Context, params *DescribeOptio type DescribeOptionGroupsInput struct { // A filter to only include option groups associated with this database engine. + // // Valid Values: + // // - db2-ae + // // - db2-se + // // - mariadb + // // - mysql + // // - oracle-ee + // // - oracle-ee-cdb + // // - oracle-se2 + // // - oracle-se2-cdb + // // - postgres + // // - sqlserver-ee + // // - sqlserver-se + // // - sqlserver-ex + // // - sqlserver-web EngineName *string @@ -62,7 +76,10 @@ type DescribeOptionGroupsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The name of the option group to describe. Can't be supplied together with @@ -182,7 +199,10 @@ type DescribeOptionGroupsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeOrderableDBInstanceOptions.go b/service/rds/api_op_DescribeOrderableDBInstanceOptions.go index e10e639a31b..d4d4825646f 100644 --- a/service/rds/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/rds/api_op_DescribeOrderableDBInstanceOptions.go @@ -29,35 +29,58 @@ func (c *Client) DescribeOrderableDBInstanceOptions(ctx context.Context, params type DescribeOrderableDBInstanceOptionsInput struct { - // The name of the database engine to describe DB instance options for. Valid - // Values: + // The name of the database engine to describe DB instance options for. + // + // Valid Values: + // // - aurora-mysql + // // - aurora-postgresql + // // - custom-oracle-ee + // // - custom-oracle-ee-cdb + // // - custom-oracle-se2 + // // - custom-oracle-se2-cdb + // // - db2-ae + // // - db2-se + // // - 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 options for the Local Zones in the group. Omit - // this parameter to show the available options in the specified Amazon Web - // Services Region. This setting doesn't apply to RDS Custom DB instances. + // parameter to retrieve available options for the Local Zones in the group. + // + // Omit this parameter to show the available options in the specified Amazon Web + // Services Region. + // + // This setting doesn't apply to RDS Custom DB instances. AvailabilityZoneGroup *string // A filter to include only the available options for the specified DB instance @@ -71,6 +94,7 @@ type DescribeOrderableDBInstanceOptionsInput struct { Filters []types.Filter // A filter to include only the available options for the specified license model. + // // RDS Custom supports only the BYOL licensing model. LicenseModel *string @@ -83,12 +107,17 @@ type DescribeOrderableDBInstanceOptionsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 1000. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 1000. MaxRecords *int32 // Specifies 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. + // 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 @@ -206,7 +235,10 @@ type DescribeOrderableDBInstanceOptionsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 1000. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 1000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribePendingMaintenanceActions.go b/service/rds/api_op_DescribePendingMaintenanceActions.go index e9d37f89861..311d23274fc 100644 --- a/service/rds/api_op_DescribePendingMaintenanceActions.go +++ b/service/rds/api_op_DescribePendingMaintenanceActions.go @@ -31,10 +31,14 @@ func (c *Client) DescribePendingMaintenanceActions(ctx context.Context, params * type DescribePendingMaintenanceActionsInput struct { // A filter that specifies one or more resources to return pending maintenance - // actions for. Supported filters: + // 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. @@ -49,7 +53,10 @@ type DescribePendingMaintenanceActionsInput 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The ARN of a resource to return pending maintenance actions for. @@ -169,7 +176,10 @@ type DescribePendingMaintenanceActionsPaginatorOptions 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 // included in the response so that you can retrieve the remaining results. - // Default: 100 Constraints: Minimum 20, maximum 100. + // + // Default: 100 + // + // Constraints: Minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/rds/api_op_DescribeReservedDBInstances.go b/service/rds/api_op_DescribeReservedDBInstances.go index 1b950ed0fe9..205e2ea0393 100644 --- a/service/rds/api_op_DescribeReservedDBInstances.go +++ b/service/rds/api_op_DescribeReservedDBInstances.go @@ -35,16 +35,19 @@ type DescribeReservedDBInstancesInput struct { 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 + // parameter to show only reservations for this duration. + // + // Valid Values: 1 | 3 | 31536000 | 94608000 Duration *string // This parameter isn't currently supported. Filters []types.Filter // The lease identifier filter value. Specify this parameter to show only the - // reservation that matches the specified lease ID. Amazon Web Services Support - // might request the lease ID for an issue related to a reserved DB instance. + // reservation that matches the specified lease ID. + // + // Amazon Web Services Support might request the lease ID for an issue related to + // a reserved DB instance. LeaseId *string // An optional pagination token provided by a previous request. If this parameter @@ -54,7 +57,10 @@ type DescribeReservedDBInstancesInput struct { // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so you can retrieve the remaining results. Default: 100 + // the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -62,8 +68,9 @@ 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 @@ -191,7 +198,10 @@ var _ DescribeReservedDBInstancesAPIClient = (*Client)(nil) type DescribeReservedDBInstancesPaginatorOptions struct { // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so you can retrieve the remaining results. Default: 100 + // the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeReservedDBInstancesOfferings.go b/service/rds/api_op_DescribeReservedDBInstancesOfferings.go index c4f231ec38c..5787c0f4e2a 100644 --- a/service/rds/api_op_DescribeReservedDBInstancesOfferings.go +++ b/service/rds/api_op_DescribeReservedDBInstancesOfferings.go @@ -34,8 +34,9 @@ type DescribeReservedDBInstancesOfferingsInput struct { DBInstanceClass *string // Duration filter value, specified in years or seconds. Specify this parameter to - // show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | - // 94608000 + // show only reservations for this duration. + // + // Valid Values: 1 | 3 | 31536000 | 94608000 Duration *string // This parameter isn't currently supported. @@ -48,7 +49,10 @@ type DescribeReservedDBInstancesOfferingsInput struct { // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so you can retrieve the remaining results. Default: 100 + // the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 @@ -56,18 +60,21 @@ 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 - // available offerings that contain the specified product description. The results - // show offerings that partially match the filter value. + // available offerings that contain the specified product description. + // + // The results show offerings that partially match the filter value. ProductDescription *string // The offering identifier filter value. Specify this parameter to show only the - // available offering that matches the specified reservation identifier. Example: - // 438012d3-4052-4cc7-b2e3-8d3372e0e706 + // available offering that matches the specified reservation identifier. + // + // Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 ReservedDBInstancesOfferingId *string noSmithyDocumentSerde @@ -183,7 +190,10 @@ var _ DescribeReservedDBInstancesOfferingsAPIClient = (*Client)(nil) type DescribeReservedDBInstancesOfferingsPaginatorOptions struct { // The maximum number of records to include in the response. If more than the // MaxRecords value is available, a pagination token called a marker is included in - // the response so you can retrieve the remaining results. Default: 100 + // the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeSourceRegions.go b/service/rds/api_op_DescribeSourceRegions.go index d71477330f1..6dff43fb71b 100644 --- a/service/rds/api_op_DescribeSourceRegions.go +++ b/service/rds/api_op_DescribeSourceRegions.go @@ -13,12 +13,17 @@ import ( // Returns a list of the source Amazon Web Services Regions where the current // Amazon Web Services Region can create a read replica, copy a DB snapshot from, -// or replicate automated backups from. Use this operation to determine whether -// 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) +// or replicate automated backups from. +// +// Use this operation to determine whether 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] // in the Amazon EC2 API Reference. +// +// [DescribeRegions]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html func (c *Client) DescribeSourceRegions(ctx context.Context, params *DescribeSourceRegionsInput, optFns ...func(*Options)) (*DescribeSourceRegionsOutput, error) { if params == nil { params = &DescribeSourceRegionsInput{} @@ -46,12 +51,17 @@ type DescribeSourceRegionsInput 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. MaxRecords *int32 // The source Amazon Web Services Region name. For example, us-east-1 . + // // Constraints: + // // - Must specify a valid Amazon Web Services Region name. RegionName *string @@ -170,7 +180,10 @@ var _ DescribeSourceRegionsAPIClient = (*Client)(nil) type DescribeSourceRegionsPaginatorOptions 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 - // included in the response so you can retrieve the remaining results. Default: 100 + // included in the response so you can retrieve the remaining results. + // + // Default: 100 + // // Constraints: Minimum 20, maximum 100. Limit int32 diff --git a/service/rds/api_op_DescribeTenantDatabases.go b/service/rds/api_op_DescribeTenantDatabases.go index c84c17d3f43..a2a9aec70ca 100644 --- a/service/rds/api_op_DescribeTenantDatabases.go +++ b/service/rds/api_op_DescribeTenantDatabases.go @@ -41,11 +41,15 @@ type DescribeTenantDatabasesInput struct { // case-sensitive. DBInstanceIdentifier *string - // A filter that specifies one or more database tenants to describe. Supported - // filters: + // A filter that specifies one or more database tenants to describe. + // + // Supported filters: + // // - tenant-db-name - Tenant database names. The results list only includes // information about the tenant databases that match these tenant DB names. + // // - tenant-database-resource-id - Tenant database resource identifiers. + // // - dbi-resource-id - DB instance resource identifiers. The results list only // includes information about the tenants contained within the DB instances // identified by these resource identifiers. @@ -293,12 +297,13 @@ type TenantDatabaseAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTenantDatabasesInput, *DescribeTenantDatabasesOutput, error) (bool, error) } @@ -554,12 +559,13 @@ type TenantDatabaseDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTenantDatabasesInput, *DescribeTenantDatabasesOutput, error) (bool, error) } diff --git a/service/rds/api_op_DescribeValidDBInstanceModifications.go b/service/rds/api_op_DescribeValidDBInstanceModifications.go index 7bcecbb9e29..b02754f1dda 100644 --- a/service/rds/api_op_DescribeValidDBInstanceModifications.go +++ b/service/rds/api_op_DescribeValidDBInstanceModifications.go @@ -13,7 +13,9 @@ 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{} diff --git a/service/rds/api_op_DisableHttpEndpoint.go b/service/rds/api_op_DisableHttpEndpoint.go index c5f0ccdb3ca..363b1958e9c 100644 --- a/service/rds/api_op_DisableHttpEndpoint.go +++ b/service/rds/api_op_DisableHttpEndpoint.go @@ -11,11 +11,15 @@ import ( ) // Disables the HTTP endpoint for the specified DB cluster. Disabling this -// endpoint disables RDS Data API. For more information, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) -// in the Amazon Aurora User Guide. This operation applies only to Aurora -// PostgreSQL Serverless v2 and provisioned DB clusters. To disable the HTTP -// endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint -// parameter of the ModifyDBCluster operation. +// endpoint disables RDS Data API. +// +// For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. +// +// This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned +// DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, +// use the EnableHttpEndpoint parameter of the ModifyDBCluster operation. +// +// [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html func (c *Client) DisableHttpEndpoint(ctx context.Context, params *DisableHttpEndpointInput, optFns ...func(*Options)) (*DisableHttpEndpointOutput, error) { if params == nil { params = &DisableHttpEndpointInput{} diff --git a/service/rds/api_op_DownloadDBLogFilePortion.go b/service/rds/api_op_DownloadDBLogFilePortion.go index 6d561253053..d2cda73e15e 100644 --- a/service/rds/api_op_DownloadDBLogFilePortion.go +++ b/service/rds/api_op_DownloadDBLogFilePortion.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Downloads all or a portion of the specified log file, up to 1 MB in size. This -// command doesn't apply to RDS Custom. +// Downloads all or a portion of the specified log file, up to 1 MB in size. +// +// This command doesn't apply to RDS Custom. func (c *Client) DownloadDBLogFilePortion(ctx context.Context, params *DownloadDBLogFilePortionInput, optFns ...func(*Options)) (*DownloadDBLogFilePortionOutput, error) { if params == nil { params = &DownloadDBLogFilePortionInput{} @@ -30,7 +31,10 @@ func (c *Client) DownloadDBLogFilePortion(ctx context.Context, params *DownloadD type DownloadDBLogFilePortionInput struct { // The customer-assigned name of the DB instance that contains the log files you - // want to list. Constraints: + // want to list. + // + // Constraints: + // // - Must match the identifier of an existing DBInstance. // // This member is required. @@ -47,17 +51,22 @@ type DownloadDBLogFilePortionInput struct { Marker *string // The number of lines to download. If the number of lines specified results in a - // file over 1 MB in size, the file is truncated at 1 MB in size. If the - // 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. + // file over 1 MB in size, the file is truncated at 1 MB in size. + // + // If the 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 @@ -177,17 +186,22 @@ var _ DownloadDBLogFilePortionAPIClient = (*Client)(nil) // DownloadDBLogFilePortion type DownloadDBLogFilePortionPaginatorOptions struct { // The number of lines to download. If the number of lines specified results in a - // file over 1 MB in size, the file is truncated at 1 MB in size. If the - // 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. + // file over 1 MB in size, the file is truncated at 1 MB in size. + // + // If the 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 diff --git a/service/rds/api_op_EnableHttpEndpoint.go b/service/rds/api_op_EnableHttpEndpoint.go index e549452a5b0..ef64cf7aafd 100644 --- a/service/rds/api_op_EnableHttpEndpoint.go +++ b/service/rds/api_op_EnableHttpEndpoint.go @@ -11,14 +11,19 @@ import ( ) // Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint -// isn't enabled. When enabled, this endpoint provides a connectionless web service -// API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can -// also query your database from inside the RDS console with the RDS query editor. -// For more information, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) -// in the Amazon Aurora User Guide. This operation applies only to Aurora -// PostgreSQL Serverless v2 and provisioned DB clusters. To enable the HTTP -// endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint -// parameter of the ModifyDBCluster operation. +// isn't enabled. +// +// When enabled, this endpoint provides a connectionless web service API (RDS Data +// API) for running SQL queries on the Aurora DB cluster. You can also query your +// database from inside the RDS console with the RDS query editor. +// +// For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. +// +// This operation applies only to Aurora PostgreSQL Serverless v2 and provisioned +// DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, +// use the EnableHttpEndpoint parameter of the ModifyDBCluster operation. +// +// [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html func (c *Client) EnableHttpEndpoint(ctx context.Context, params *EnableHttpEndpointInput, optFns ...func(*Options)) (*EnableHttpEndpointOutput, error) { if params == nil { params = &EnableHttpEndpointInput{} diff --git a/service/rds/api_op_FailoverDBCluster.go b/service/rds/api_op_FailoverDBCluster.go index 04c5fb50328..98cd7f46caf 100644 --- a/service/rds/api_op_FailoverDBCluster.go +++ b/service/rds/api_op_FailoverDBCluster.go @@ -11,24 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB -// cluster promotes one of the Aurora Replicas (read-only instances) in the DB -// cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB -// cluster, after RDS terminates the primary DB instance, the internal monitoring -// system detects that the primary DB instance is unhealthy and promotes a readable -// standby (read-only instances) in the DB cluster to be the primary DB instance -// (the cluster writer). Failover times are typically less than 35 seconds. An -// Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one -// exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically -// fails over to a readable standby DB instance when the primary DB instance fails. +// Forces a failover for a DB cluster. +// +// For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora +// Replicas (read-only instances) in the DB cluster to be the primary DB instance +// (the cluster writer). +// +// For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the +// internal monitoring system detects that the primary DB instance is unhealthy and +// promotes a readable standby (read-only instances) in the DB cluster to be the +// primary DB instance (the cluster writer). Failover times are typically less than +// 35 seconds. +// +// An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if +// one exists, when the primary DB instance fails. A Multi-AZ DB cluster +// automatically fails over to a readable standby DB instance when the primary DB +// instance fails. +// // To simulate a failure of a primary instance for 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) -// 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) -// in the Amazon RDS User Guide. +// endpoint addresses when the failover is complete. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBClusterInput, optFns ...func(*Options)) (*FailoverDBClusterOutput, error) { if params == nil { params = &FailoverDBClusterInput{} @@ -47,16 +58,21 @@ func (c *Client) FailoverDBCluster(ctx context.Context, params *FailoverDBCluste type FailoverDBClusterInput struct { // The identifier of the DB cluster to force a failover for. This parameter isn't - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DB cluster. // // 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 - // for RDS for MySQL Multi-AZ DB clusters. + // 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 for RDS for MySQL Multi-AZ DB clusters. TargetDBInstanceIdentifier *string noSmithyDocumentSerde @@ -64,20 +80,27 @@ type FailoverDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_FailoverGlobalCluster.go b/service/rds/api_op_FailoverGlobalCluster.go index 29d5eb62542..b11f733e979 100644 --- a/service/rds/api_op_FailoverGlobalCluster.go +++ b/service/rds/api_op_FailoverGlobalCluster.go @@ -14,34 +14,48 @@ import ( // Promotes the specified secondary DB cluster to be the primary DB cluster in the // global database cluster to fail over or switch over a global database. // Switchover operations were previously called "managed planned failovers." +// // Although this operation can be used either to fail over or to switch over a // global database cluster, its intended use is for global database failover. To -// switch over a global database cluster, we recommend that you use the -// SwitchoverGlobalCluster operation instead. How you use this operation depends on -// whether you are failing over or switching over your global database cluster: +// switch over a global database cluster, we recommend that you use the SwitchoverGlobalClusteroperation +// instead. +// +// How you use this operation depends on whether you are failing over or switching +// over your global database cluster: +// // - Failing over - Specify the AllowDataLoss parameter and don't specify the // Switchover parameter. +// // - Switching over - Specify the Switchover parameter or omit it, but don't // specify the AllowDataLoss parameter. // -// About failing over and switching over While failing over and switching over a -// global database cluster both change the primary DB cluster, you use these -// operations for different reasons: +// # About failing over and switching over +// +// While failing over and switching over a global database cluster both change the +// primary DB cluster, you use these operations for different reasons: +// // - Failing over - Use this operation to respond to an unplanned event, such as // a Regional disaster in the primary Region. Failing over can result in a loss of // write transaction data that wasn't replicated to the chosen secondary before the // failover event occurred. However, the recovery process that promotes a DB // instance on the chosen seconday DB cluster to be the primary writer DB instance -// guarantees that the data is in a transactionally consistent state. For more -// information about failing over an Amazon Aurora global database, see -// Performing managed failovers for Aurora global databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-failover.managed-unplanned) -// in the Amazon Aurora User Guide. -// - Switching over - Use this operation on a healthy global database cluster -// for planned events, such as Regional rotation or to fail back to the original -// primary DB cluster after a failover operation. With this operation, there is no -// data loss. For more information about switching over an Amazon Aurora global -// database, see Performing switchovers for 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. +// guarantees that the data is in a transactionally consistent state. +// +// For more information about failing over an Amazon Aurora global database, see [Performing managed failovers for Aurora global databases] +// +// in the Amazon Aurora User Guide. +// +// - Switching over - Use this operation on a healthy global database cluster +// for planned events, such as Regional rotation or to fail back to the original +// primary DB cluster after a failover operation. With this operation, there is no +// data loss. +// +// For more information about switching over an Amazon Aurora global database, see [Performing switchovers for Aurora global databases] +// +// in the Amazon Aurora User Guide. +// +// [Performing managed failovers for Aurora global databases]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-failover.managed-unplanned +// [Performing switchovers for Aurora global databases]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover func (c *Client) FailoverGlobalCluster(ctx context.Context, params *FailoverGlobalClusterInput, optFns ...func(*Options)) (*FailoverGlobalClusterOutput, error) { if params == nil { params = &FailoverGlobalClusterInput{} @@ -62,7 +76,10 @@ type FailoverGlobalClusterInput struct { // The identifier of the global database cluster (Aurora global database) this // operation should apply to. The identifier is the unique key assigned by the user // when the Aurora global database is created. In other words, it's the name of the - // Aurora global database. Constraints: + // Aurora global database. + // + // Constraints: + // // - Must match the identifier of an existing global database cluster. // // This member is required. @@ -77,13 +94,20 @@ type FailoverGlobalClusterInput struct { TargetDbClusterIdentifier *string // Specifies whether to allow data loss for this global database cluster - // operation. Allowing data loss triggers a global failover operation. If you don't - // specify AllowDataLoss , the global database cluster operation defaults to a - // switchover. Constraints: + // operation. Allowing data loss triggers a global failover operation. + // + // If you don't specify AllowDataLoss , the global database cluster operation + // defaults to a switchover. + // + // Constraints: + // // - Can't be specified together with the Switchover parameter. AllowDataLoss *bool - // Specifies whether to switch over this global database cluster. Constraints: + // Specifies whether to switch over this global database cluster. + // + // Constraints: + // // - Can't be specified together with the AllowDataLoss parameter. Switchover *bool diff --git a/service/rds/api_op_ListTagsForResource.go b/service/rds/api_op_ListTagsForResource.go index 94e1b8a8fef..6d9efb9be5f 100644 --- a/service/rds/api_op_ListTagsForResource.go +++ b/service/rds/api_op_ListTagsForResource.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon RDS User Guide. +// Lists all tags on an Amazon RDS resource. +// +// For an overview on tagging an Amazon RDS resource, see [Tagging Amazon RDS Resources] in the Amazon RDS User +// Guide. +// +// [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -32,9 +35,10 @@ 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) - // in the Amazon RDS User Guide. + // Resource Name (ARN). For information about creating an ARN, see [Constructing an ARN for Amazon RDS]in the Amazon + // RDS User Guide. + // + // [Constructing an ARN for Amazon RDS]: 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_ModifyActivityStream.go b/service/rds/api_op_ModifyActivityStream.go index 67e078ad8d8..ec9c054b9f7 100644 --- a/service/rds/api_op_ModifyActivityStream.go +++ b/service/rds/api_op_ModifyActivityStream.go @@ -15,10 +15,12 @@ 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) -// in the Amazon RDS User Guide. This operation is supported for RDS for Oracle and -// Microsoft SQL Server. +// activity stream isn't required. For more information, see [Modifying a database activity stream]in the Amazon RDS +// User Guide. +// +// This operation is supported for RDS for Oracle and Microsoft SQL Server. +// +// [Modifying a database activity stream]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html func (c *Client) ModifyActivityStream(ctx context.Context, params *ModifyActivityStreamInput, optFns ...func(*Options)) (*ModifyActivityStreamOutput, error) { if params == nil { params = &ModifyActivityStreamInput{} diff --git a/service/rds/api_op_ModifyCertificates.go b/service/rds/api_op_ModifyCertificates.go index f5cd6b56c96..00c73d421af 100644 --- a/service/rds/api_op_ModifyCertificates.go +++ b/service/rds/api_op_ModifyCertificates.go @@ -13,24 +13,31 @@ import ( // Override the system-default Secure Sockets Layer/Transport Layer Security // (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the -// override. By using this operation, you can specify an RDS-approved SSL/TLS -// certificate for new DB instances that is different from the default certificate -// 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: +// override. +// +// By using this operation, you can specify an RDS-approved SSL/TLS certificate +// for new DB instances that is different from the default certificate 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. // // 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. +// engines, see [Rotating Your SSL/TLS Certificate]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]in the Amazon Aurora User Guide. +// +// [Rotating Your SSL/TLS Certificate]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html func (c *Client) ModifyCertificates(ctx context.Context, params *ModifyCertificatesInput, optFns ...func(*Options)) (*ModifyCertificatesOutput, error) { if params == nil { params = &ModifyCertificatesInput{} @@ -48,8 +55,9 @@ func (c *Client) ModifyCertificates(ctx context.Context, params *ModifyCertifica type ModifyCertificatesInput struct { - // The new default certificate identifier to override the current one with. To - // determine the valid values, use the describe-certificates CLI command or the + // The new default certificate identifier to override the current one with. + // + // To determine the valid values, use the describe-certificates CLI command or the // DescribeCertificates API operation. CertificateIdentifier *string @@ -62,11 +70,13 @@ 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) - // in the Amazon Aurora User Guide. + // A CA certificate for an Amazon Web Services account. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 Certificate *types.Certificate // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyCurrentDBClusterCapacity.go b/service/rds/api_op_ModifyCurrentDBClusterCapacity.go index 1603c780c92..5bb3a3888c2 100644 --- a/service/rds/api_op_ModifyCurrentDBClusterCapacity.go +++ b/service/rds/api_op_ModifyCurrentDBClusterCapacity.go @@ -11,20 +11,28 @@ import ( ) // Set the capacity of an Aurora Serverless v1 DB cluster to a specific value. +// // Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. // In some cases, the capacity might not scale fast enough to meet a sudden change // in workload, such as a large number of new transactions. Call -// ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call -// 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) -// in the Amazon Aurora User Guide. This operation only applies to Aurora -// Serverless v1 DB clusters. +// ModifyCurrentDBClusterCapacity to set the capacity explicitly. +// +// After this call 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] 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]in the Amazon Aurora +// User Guide. +// +// This operation only applies to Aurora Serverless v1 DB clusters. +// +// [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 +// [Using Amazon Aurora Serverless v1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html func (c *Client) ModifyCurrentDBClusterCapacity(ctx context.Context, params *ModifyCurrentDBClusterCapacityInput, optFns ...func(*Options)) (*ModifyCurrentDBClusterCapacityOutput, error) { if params == nil { params = &ModifyCurrentDBClusterCapacityInput{} @@ -43,30 +51,44 @@ func (c *Client) ModifyCurrentDBClusterCapacity(ctx context.Context, params *Mod type ModifyCurrentDBClusterCapacityInput struct { // The DB cluster identifier for the cluster being modified. This parameter isn't - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - 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: + // 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 . Capacity *int32 // The amount of time, in seconds, that Aurora Serverless v1 tries to find a // scaling point to perform seamless scaling before enforcing the timeout action. - // The default is 300. Specify a value between 10 and 600 seconds. + // The default is 300. + // + // Specify a value between 10 and 600 seconds. SecondsBeforeTimeout *int32 // The action to take when the timeout is reached, either 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. + // 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. TimeoutAction *string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyCustomDBEngineVersion.go b/service/rds/api_op_ModifyCustomDBEngineVersion.go index 9be45a97f61..be6f3deca1f 100644 --- a/service/rds/api_op_ModifyCustomDBEngineVersion.go +++ b/service/rds/api_op_ModifyCustomDBEngineVersion.go @@ -13,14 +13,18 @@ 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) -// in the Amazon RDS User Guide. +// 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] in the Amazon RDS User Guide. +// +// [Modifying CEV status]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.modify func (c *Client) ModifyCustomDBEngineVersion(ctx context.Context, params *ModifyCustomDBEngineVersionInput, optFns ...func(*Options)) (*ModifyCustomDBEngineVersionOutput, error) { if params == nil { params = &ModifyCustomDBEngineVersionInput{} @@ -39,9 +43,13 @@ func (c *Client) ModifyCustomDBEngineVersion(ctx context.Context, params *Modify type ModifyCustomDBEngineVersionInput struct { // The database engine. RDS Custom for Oracle supports the following values: + // // - custom-oracle-ee + // // - custom-oracle-ee-cdb + // // - custom-oracle-se2 + // // - custom-oracle-se2-cdb // // This member is required. @@ -59,15 +67,18 @@ type ModifyCustomDBEngineVersionInput struct { Description *string // The availability status to be assigned to the CEV. Valid values are as follows: - // available You can use this CEV to create a new RDS Custom DB instance. inactive - // You can create a new RDS Custom instance by restoring a DB snapshot with this - // 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 - // automated backup. + // + // available You can use this CEV to create a new RDS Custom DB instance. + // + // inactive You can create a new RDS Custom instance by restoring a DB snapshot + // with this 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 automated backup. Status types.CustomEngineVersionStatus noSmithyDocumentSerde @@ -84,8 +95,9 @@ 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) - // in the Amazon RDS User Guide. + // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. + // + // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. @@ -138,11 +150,13 @@ type ModifyCustomDBEngineVersionOutput struct { // 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) - // in the Amazon Aurora User Guide. + // A list of the supported CA certificate identifiers. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName @@ -152,14 +166,21 @@ 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 - // SupportedFeatureNames in the output. + // 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 // A list of the character sets supported by the Oracle DB engine for the @@ -190,8 +211,9 @@ type ModifyCustomDBEngineVersionOutput struct { // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By - // default, write operations aren't allowed on reader DB instances. Valid for: - // Aurora DB clusters only + // default, write operations aren't allowed on reader DB instances. + // + // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified @@ -205,8 +227,9 @@ type ModifyCustomDBEngineVersionOutput struct { // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html 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 62bd2bcd992..1fd679d0533 100644 --- a/service/rds/api_op_ModifyDBCluster.go +++ b/service/rds/api_op_ModifyDBCluster.go @@ -13,11 +13,15 @@ import ( // Modifies the settings of 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) -// 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) -// in the Amazon RDS User Guide. +// values in the request. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error) { if params == nil { params = &ModifyDBClusterInput{} @@ -36,26 +40,40 @@ func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInp type ModifyDBClusterInput struct { // The DB cluster identifier for the cluster being modified. This parameter isn't - // case-sensitive. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB - // clusters Constraints: + // case-sensitive. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - Must match the identifier of an existing DB cluster. // // This member is required. DBClusterIdentifier *string // The amount of storage in gibibytes (GiB) to allocate to each DB instance in the - // Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only + // Multi-AZ DB cluster. + // + // Valid for Cluster Type: Multi-AZ DB clusters only AllocatedStorage *int32 // Specifies whether engine mode changes from serverless to provisioned are - // allowed. Valid for Cluster Type: Aurora Serverless v1 DB clusters only + // allowed. + // + // Valid for Cluster Type: Aurora Serverless v1 DB clusters only + // // Constraints: + // // - You must allow engine mode changes when specifying a different value for // the EngineMode parameter from the DB cluster's current engine mode. AllowEngineModeChange *bool - // Specifies whether major version upgrades are allowed. Valid for Cluster Type: - // Aurora DB clusters and Multi-AZ DB clusters Constraints: + // Specifies whether major version upgrades are allowed. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - You must allow major version upgrades when specifying a value for the // EngineVersion parameter that is a different major version than the DB // cluster's current version. @@ -65,16 +83,23 @@ type ModifyDBClusterInput struct { // 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 - // of when you choose to apply them. By default, this parameter is disabled. Valid - // for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // 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 of when you + // choose to apply them. + // + // By default, this parameter is disabled. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ApplyImmediately *bool // Specifies whether minor engine upgrades are applied automatically to the DB // cluster during the maintenance window. By default, minor engine upgrades are - // applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only + // applied automatically. + // + // Valid for Cluster Type: Multi-AZ DB clusters only AutoMinorVersionUpgrade *bool // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services @@ -82,334 +107,533 @@ type ModifyDBClusterInput struct { AwsBackupRecoveryPointArn *string // The target backtrack window, in seconds. To disable backtracking, set this - // value to 0 . Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0 + // value to 0 . + // + // Valid for Cluster Type: Aurora MySQL DB clusters only + // + // Default: 0 + // // Constraints: + // // - 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 are retained. Specify a minimum - // value of 1 . Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - // Default: 1 Constraints: + // value of 1 . + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Default: 1 + // + // Constraints: + // // - Must be a value from 1 to 35. BackupRetentionPeriod *int32 // The CA certificate identifier to use for the DB cluster'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. Valid for Cluster Type: Multi-AZ DB clusters + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide. + // + // Valid for Cluster Type: Multi-AZ DB clusters + // + // [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html CACertificateIdentifier *string // The configuration setting for the log types to be enabled for export to - // CloudWatch Logs for a specific DB cluster. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters The following values are valid for each DB - // engine: + // CloudWatch Logs for a specific DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // The following values are valid for each DB engine: + // // - Aurora MySQL - audit | error | general | slowquery + // // - Aurora PostgreSQL - postgresql + // // - RDS for MySQL - error | general | slowquery + // // - RDS for PostgreSQL - postgresql | upgrade - // 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) - // in the Amazon Aurora User Guide. + // + // For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon RDS User Guide. + // + // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon Aurora User Guide. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration // Specifies whether to copy all tags from the DB cluster to snapshots of the DB - // cluster. The default is not to copy them. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters + // cluster. The default is not to copy them. + // + // Valid for Cluster Type: 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) - // in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only + // 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] + // in the Amazon RDS User Guide. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *string - // The name of the DB cluster parameter group to use for the DB cluster. Valid for - // Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // The name of the DB cluster parameter group to use for the DB cluster. + // + // Valid for Cluster Type: 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. + // // When you apply a parameter group using the DBInstanceParameterGroupName // parameter, the DB cluster isn't rebooted automatically. Also, parameter changes - // are applied immediately rather than during the next maintenance window. Valid - // for Cluster Type: Aurora DB clusters only Default: The existing name setting + // are applied immediately rather than during the next maintenance window. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // 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. DBInstanceParameterGroupName *string // Specifies whether the DB cluster has deletion protection enabled. The database // can't be deleted when deletion protection is enabled. By default, deletion - // protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters + // protection isn't enabled. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool // 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) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only + // this operation. + // + // For more information, see [Kerberos Authentication] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // The name of the IAM role to use when making API calls to the Directory Service. + // // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *string // Specifies whether to enable this DB cluster to forward write operations to the // primary cluster of a global cluster (Aurora global database). 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 cluster, and the - // resulting changes are replicated back to this cluster. For the primary DB - // cluster of an Aurora global database, this value is used immediately if the - // primary is demoted by a global cluster API operation, but it does nothing until - // then. Valid for Cluster Type: Aurora DB clusters only + // 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 cluster, and the resulting changes are replicated + // back to this cluster. For the primary DB cluster of an Aurora global database, + // this value is used immediately if the primary is demoted by a global cluster API + // operation, but it does nothing until then. + // + // Valid for Cluster Type: Aurora DB clusters only EnableGlobalWriteForwarding *bool // Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB - // cluster. By default, the HTTP endpoint isn't enabled. When enabled, the HTTP - // endpoint provides a connectionless web service API (RDS Data 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 RDS query editor. For more - // information, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) - // in the Amazon Aurora User Guide. This parameter applies only to Aurora - // Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora - // PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint - // and DisableHttpEndpoint operations. Valid for Cluster Type: Aurora DB clusters - // only + // cluster. By default, the HTTP endpoint isn't enabled. + // + // When enabled, the HTTP endpoint provides a connectionless web service API (RDS + // Data 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 RDS query + // editor. + // + // For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. + // + // This parameter applies only to Aurora Serverless v1 DB clusters. To enable or + // disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2 or provisioned + // DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html EnableHttpEndpoint *bool // Specifies 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 Cluster Type: Aurora DB clusters only + // enabled. + // + // For more information, see [IAM Database Authentication] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // Specifies whether to enable Aurora Limitless Database. You must enable Aurora - // Limitless Database to create a DB shard group. Valid for: Aurora DB clusters - // only + // Limitless Database to create a DB shard group. + // + // Valid for: Aurora DB clusters only EnableLimitlessDatabase *bool // Specifies whether read replicas can forward write operations to the writer DB // instance in the DB cluster. By default, write operations aren't allowed on - // reader DB instances. Valid for: Aurora DB clusters only + // reader DB instances. + // + // Valid for: Aurora DB clusters only EnableLocalWriteForwarding *bool - // Specifies 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) - // in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only + // Specifies whether to turn on Performance Insights for the DB cluster. + // + // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool - // The DB engine mode of the DB cluster, either provisioned or serverless . The DB - // engine mode can be modified only from serverless to provisioned . For more - // information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) - // . Valid for Cluster Type: Aurora DB clusters only + // The DB engine mode of the DB cluster, either provisioned or serverless . + // + // The DB engine mode can be modified only from serverless to provisioned . + // + // For more information, see [CreateDBCluster]. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // [CreateDBCluster]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html EngineMode *string // 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, use the following - // command: aws rds describe-db-engine-versions --engine aurora-mysql --query - // "DBEngineVersions[].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 - // "DBEngineVersions[].EngineVersion" To list all of the available engine versions - // for RDS for MySQL, use the following command: aws rds - // describe-db-engine-versions --engine mysql --query - // "DBEngineVersions[].EngineVersion" To list all of the available engine versions - // for RDS for PostgreSQL, use the following command: aws rds - // describe-db-engine-versions --engine postgres --query - // "DBEngineVersions[].EngineVersion" Valid for Cluster Type: Aurora DB clusters - // and Multi-AZ DB clusters + // 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, use the + // following command: + // + // aws rds describe-db-engine-versions --engine aurora-mysql --query + // "DBEngineVersions[].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 + // "DBEngineVersions[].EngineVersion" + // + // To list all of the available engine versions for RDS for MySQL, use the + // following command: + // + // aws rds describe-db-engine-versions --engine mysql --query + // "DBEngineVersions[].EngineVersion" + // + // To list all of the available engine versions for RDS for PostgreSQL, use the + // following command: + // + // aws rds describe-db-engine-versions --engine postgres --query + // "DBEngineVersions[].EngineVersion" + // + // Valid for Cluster Type: 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) - // in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only + // initially allocated for each DB instance in the Multi-AZ DB cluster. + // + // For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage] in the Amazon RDS User Guide. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // // Constraints: + // // - Must be a multiple between .5 and 50 of the storage amount for the DB // cluster. + // + // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 // Specifies 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 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) - // 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) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters + // 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 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] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon + // Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool - // The new password for the master database user. Valid for Cluster Type: Aurora - // DB clusters and Multi-AZ DB clusters Constraints: + // The new password for the master database user. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - Must contain from 8 to 41 characters. + // // - Can contain any printable ASCII character except "/", """, or "@". + // // - Can't be specified if ManageMasterUserPassword is turned on. 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: + // 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. + // 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. + // 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 Cluster - // Type: Aurora DB clusters and Multi-AZ DB clusters + // 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB cluster. To turn off collecting Enhanced Monitoring - // metrics, specify 0 . If MonitoringRoleArn is specified, also set - // MonitoringInterval to a value other than 0 . Valid for Cluster Type: Multi-AZ DB - // clusters only Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0 + // metrics, specify 0 . + // + // If MonitoringRoleArn is specified, also set MonitoringInterval to a value other + // than 0 . + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + // + // Default: 0 MonitoringInterval *int32 // 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 Cluster Type: Multi-AZ DB - // clusters only + // monitoring role, see [To create an IAM role for Amazon RDS Enhanced Monitoring]in the Amazon RDS User Guide. + // + // If MonitoringInterval is set to a value other than 0 , supply a + // MonitoringRoleArn value. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // [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 MonitoringRoleArn *string - // The network type of the DB cluster. 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 Cluster Type: Aurora DB clusters only + // The network type of the DB cluster. + // + // 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] in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters only + // // Valid Values: IPV4 | DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The new DB cluster identifier for the DB cluster when renaming a DB cluster. - // This value is stored as a lowercase string. Valid for Cluster Type: Aurora DB - // clusters and Multi-AZ DB clusters Constraints: + // This value is stored as a lowercase string. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // 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 NewDBClusterIdentifier *string - // The option group to associate the DB cluster with. DB clusters are associated - // with a default option group that can't be modified. + // The option group to associate the DB cluster with. + // + // DB clusters are associated with a default option group that can't be modified. OptionGroupName *string // 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 Cluster Type: Multi-AZ DB clusters only + // 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 Cluster Type: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. Valid for Cluster Type: - // Multi-AZ DB clusters only Valid Values: + // The number of days to retain Performance Insights data. + // + // Valid for Cluster Type: Multi-AZ DB clusters only + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 - // Default: 7 days If you specify a retention period that isn't valid, such as 94 , - // Amazon RDS issues an error. + // + // Default: 7 days + // + // If you specify a retention period that isn't valid, such as 94 , Amazon RDS + // issues an error. PerformanceInsightsRetentionPeriod *int32 - // The port number on which the DB cluster accepts connections. Valid for Cluster - // Type: Aurora DB clusters only Valid Values: 1150-65535 Default: The same port - // as the original DB cluster. + // The port number on which the DB cluster accepts connections. + // + // Valid for Cluster Type: Aurora DB clusters only + // + // Valid Values: 1150-65535 + // + // Default: The same port as the original DB 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. 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. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters Constraints: + // 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]in the Amazon Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // 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. + // + // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). Valid for Cluster Type: Aurora DB clusters and Multi-AZ - // DB clusters 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) - // in the Amazon Aurora User Guide. Constraints: + // Coordinated Time (UTC). + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // 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]in the Amazon Aurora User Guide. + // + // Constraints: + // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . + // // - Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun . + // // - Must be in Universal Coordinated Time (UTC). + // // - Must be at least 30 minutes. + // + // [Adjusting the Preferred DB Cluster Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora PreferredMaintenanceWindow *string // Specifies 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) - // 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) - // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and - // Multi-AZ DB clusters Constraints: + // 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] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon + // Aurora User Guide. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // + // Constraints: + // // - You must apply the change immediately when rotating the master user // password. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html 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 Cluster - // Type: Aurora DB clusters only + // properties for DB clusters in serverless DB engine mode. + // + // Valid for Cluster Type: 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) - // in the Amazon Aurora User Guide. + // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + // + // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // The storage type to associate with the DB cluster. For information on storage - // types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB - // clusters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type) - // . For information on storage types for Multi-AZ DB clusters, see Settings for - // creating Multi-AZ DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings) - // . When specified for a Multi-AZ DB cluster, a value for the Iops parameter is - // required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // The storage type to associate with the DB cluster. + // + // For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters]. For information + // on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters]. + // + // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is + // required. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // // Valid Values: + // // - Aurora DB clusters - aurora | aurora-iopt1 + // // - Multi-AZ DB clusters - io1 | io2 | gp3 + // // Default: + // // - Aurora DB clusters - aurora + // // - Multi-AZ DB clusters - io1 + // + // [Storage configurations for Amazon Aurora DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type + // [Settings for creating Multi-AZ DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings StorageType *string - // A list of EC2 VPC security groups to associate with this DB cluster. Valid for - // Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + // A list of EC2 VPC security groups to associate with this DB cluster. + // + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -417,20 +641,27 @@ type ModifyDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBClusterEndpoint.go b/service/rds/api_op_ModifyDBClusterEndpoint.go index bc81280fbdd..8a82125a6e1 100644 --- a/service/rds/api_op_ModifyDBClusterEndpoint.go +++ b/service/rds/api_op_ModifyDBClusterEndpoint.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This -// operation only applies to Aurora DB clusters. +// Modifies the properties of an endpoint in an Amazon Aurora DB cluster. +// +// This operation only applies to Aurora DB clusters. func (c *Client) ModifyDBClusterEndpoint(ctx context.Context, params *ModifyDBClusterEndpointInput, optFns ...func(*Options)) (*ModifyDBClusterEndpointOutput, error) { if params == nil { params = &ModifyDBClusterEndpointInput{} @@ -52,9 +53,13 @@ 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 // // For the data structure that represents Amazon RDS DB instance endpoints, see diff --git a/service/rds/api_op_ModifyDBClusterParameterGroup.go b/service/rds/api_op_ModifyDBClusterParameterGroup.go index 473776de798..48aa9ad76a4 100644 --- a/service/rds/api_op_ModifyDBClusterParameterGroup.go +++ b/service/rds/api_op_ModifyDBClusterParameterGroup.go @@ -13,25 +13,34 @@ import ( // 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 +// 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 operation 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) -// 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) -// in the Amazon RDS User Guide. +// parameter. You can use the Parameter Groups option of the [Amazon RDS console]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?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User +// Guide. +// +// [Amazon RDS console]: https://console.aws.amazon.com/rds/ +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) ModifyDBClusterParameterGroup(ctx context.Context, params *ModifyDBClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyDBClusterParameterGroupOutput, error) { if params == nil { params = &ModifyDBClusterParameterGroupInput{} @@ -54,14 +63,18 @@ type ModifyDBClusterParameterGroupInput struct { // This member is required. DBClusterParameterGroupName *string - // A list of parameters in the DB cluster parameter group to modify. 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 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 - // reboot without failover to the DB clusters associated with the parameter group. + // A list of parameters in the DB cluster parameter group to modify. + // + // 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 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 reboot without failover to the DB clusters + // associated with the parameter group. // // This member is required. Parameters []types.Parameter @@ -71,10 +84,16 @@ type ModifyDBClusterParameterGroupInput struct { type ModifyDBClusterParameterGroupOutput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. DBClusterParameterGroupName *string diff --git a/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go b/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go index 9f51682ba91..a5b6e5dbad0 100644 --- a/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go +++ b/service/rds/api_op_ModifyDBClusterSnapshotAttribute.go @@ -12,21 +12,28 @@ import ( ) // Adds an attribute and values to, or removes an attribute and values from, a -// manual DB cluster snapshot. To share a manual DB cluster 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 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 -// DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as -// values for the restore attribute. +// manual DB cluster snapshot. +// +// To share a manual DB cluster 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 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 DescribeDBClusterSnapshotAttributesAPI 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) { if params == nil { params = &ModifyDBClusterSnapshotAttributeInput{} @@ -44,10 +51,12 @@ 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,22 +67,26 @@ 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 - // 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 - // manual DB cluster snapshots that contain private information that you don't want - // available to all Amazon Web Services accounts. + // 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 manual DB cluster + // snapshots that contain private information that you don't want available to all + // Amazon Web Services accounts. 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 @@ -82,10 +95,11 @@ type ModifyDBClusterSnapshotAttributeInput struct { type ModifyDBClusterSnapshotAttributeOutput struct { // Contains the results of a successful call to the - // DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot - // attributes are used to authorize other Amazon Web Services accounts to copy or - // restore a manual DB cluster snapshot. For more information, see the - // ModifyDBClusterSnapshotAttribute API action. + // DescribeDBClusterSnapshotAttributes API action. + // + // Manual DB cluster snapshot attributes are used to authorize other Amazon Web + // Services accounts to copy or restore a manual DB cluster snapshot. For more + // information, see the ModifyDBClusterSnapshotAttribute API action. DBClusterSnapshotAttributesResult *types.DBClusterSnapshotAttributesResult // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBInstance.go b/service/rds/api_op_ModifyDBInstance.go index 200af1f996a..8a58e822083 100644 --- a/service/rds/api_op_ModifyDBInstance.go +++ b/service/rds/api_op_ModifyDBInstance.go @@ -33,18 +33,27 @@ func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceI type ModifyDBInstanceInput struct { // The identifier of DB instance to modify. This value is stored as a lowercase - // string. Constraints: + // string. + // + // Constraints: + // // - Must match the identifier of an existing DB instance. // // This member is required. DBInstanceIdentifier *string // The new amount of storage in gibibytes (GiB) to allocate for the DB instance. - // For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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. For the valid values for allocated - // storage for each engine, see CreateDBInstance . Constraints: + // + // For RDS for Db2, MariaDB, RDS for MySQL, RDS for Oracle, and RDS for + // 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. + // + // For the valid values for allocated storage for each engine, see CreateDBInstance + // . + // + // Constraints: + // // - When you increase the allocated storage for a DB instance that uses // Provisioned IOPS ( gp3 , io1 , or io2 storage type), you must also specify the // Iops parameter. You can use the current value for Iops . @@ -52,7 +61,12 @@ type ModifyDBInstanceInput struct { // Specifies 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 DB instances. Constraints: + // possible. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Constraints: + // // - Major version upgrades must be allowed when specifying a value for the // EngineVersion parameter that's a different major version than the DB // instance's current version. @@ -61,24 +75,33 @@ 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. 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) - // 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. + // 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]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. + // + // [Modifying a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html ApplyImmediately *bool // Specifies 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, Amazon RDS applies the change as - // soon as possible and doesn't cause an outage. For an RDS Custom DB instance, - // don't enable this setting. Otherwise, the operation returns an error. + // soon as possible and doesn't cause an outage. + // + // For an RDS Custom DB instance, don't enable this setting. Otherwise, the + // operation returns an error. AutoMinorVersionUpgrade *bool // The automation mode of the RDS Custom DB instance. If full , the DB instance @@ -87,127 +110,202 @@ type ModifyDBInstanceInput struct { AutomationMode types.AutomationMode // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services - // Backup. This setting doesn't apply to RDS Custom DB instances. + // Backup. + // + // This setting doesn't apply to RDS Custom DB instances. AwsBackupRecoveryPointArn *string // The number of days to retain automated backups. Setting this parameter to a // positive number enables backups. Setting this parameter to 0 disables automated - // 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 - // change is asynchronously applied as soon as possible. This setting doesn't apply - // to Amazon Aurora DB instances. The retention period for automated backups is - // managed by the DB cluster. For more information, see ModifyDBCluster . Default: - // Uses existing setting Constraints: + // 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 change is + // asynchronously applied as soon as possible. + // + // This setting doesn't apply to Amazon Aurora DB instances. The retention period + // for automated backups is managed by the DB cluster. For more information, see + // ModifyDBCluster . + // + // Default: Uses existing setting + // + // 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. BackupRetentionPeriod *int32 // The CA certificate identifier to use for the DB instance's server certificate. - // This setting doesn't apply to RDS Custom DB instances. 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. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // Specifies 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: + // 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. + // engines, see [Rotating Your SSL/TLS Certificate.]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. + // engines, see [Rotating Your SSL/TLS Certificate]in the Amazon Aurora User Guide. + // // This setting doesn't apply to RDS Custom DB instances. + // + // [Rotating Your SSL/TLS Certificate.]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html + // [Rotating Your SSL/TLS Certificate]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html CertificateRotationRestart *bool // The log types to be enabled for export to CloudWatch Logs for a specific DB - // instance. A change to the CloudwatchLogsExportConfiguration parameter is always - // applied to the DB instance immediately. Therefore, the ApplyImmediately - // parameter has no effect. This setting doesn't apply to RDS Custom DB instances. + // instance. + // + // A change to the CloudwatchLogsExportConfiguration parameter is always applied + // to the DB instance immediately. Therefore, the ApplyImmediately parameter has + // no effect. + // + // This setting doesn't apply to RDS Custom DB instances. CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration // Specifies whether to copy all tags from the DB instance to snapshots of the DB - // instance. By default, tags aren't copied. This setting doesn't apply to Amazon - // Aurora DB instances. 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 . + // instance. By default, tags aren't copied. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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 . 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) - // 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 + // availability for your engine, see [DB Instance Class]in the Amazon RDS User Guide or [Aurora DB instance classes] in the + // Amazon Aurora User Guide. For RDS Custom, see [DB instance class support for RDS Custom for Oracle]and [DB instance class support for RDS Custom for SQL Server]. + // + // 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 Constraints: + // ApplyImmediately in your request. + // + // Default: Uses existing setting + // + // Constraints: + // // - If you are modifying the DB instance class and upgrading the engine version // at the same time, the currently running engine version must be supported on the // specified DB instance class. Otherwise, the operation returns an error. In this // case, first run the operation to upgrade the engine version, and then run it // again to modify the DB instance class. + // + // [Aurora DB instance classes]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html + // [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 + // [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 + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string - // The name of the DB parameter group to apply to the DB instance. Changing this - // setting doesn't result in an outage. The parameter group name itself is changed - // immediately, but the actual parameter changes are not applied until you reboot - // the instance without failover. In this case, the DB instance isn't rebooted - // automatically, and the parameter changes aren't applied during the next - // maintenance window. However, if you modify dynamic parameters in the newly - // associated DB parameter group, these changes are applied immediately without a - // reboot. This setting doesn't apply to RDS Custom DB instances. Default: Uses - // existing setting Constraints: + // The name of the DB parameter group to apply to the DB instance. + // + // Changing this setting doesn't result in an outage. The parameter group name + // itself is changed immediately, but the actual parameter changes are not applied + // until you reboot the instance without failover. In this case, the DB instance + // isn't rebooted automatically, and the parameter changes aren't applied during + // the next maintenance window. However, if you modify dynamic parameters in the + // newly associated DB parameter group, these changes are applied immediately + // without a reboot. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Default: Uses existing setting + // + // Constraints: + // // - Must be in the same DB parameter group family as the DB instance. DBParameterGroupName *string - // The port number on which the database accepts connections. The value of the - // DBPortNumber parameter must not match any of the port values specified for - // options in the option group for the DB instance. If you change the DBPortNumber - // value, your database restarts regardless of the value of the ApplyImmediately - // parameter. This setting doesn't apply to RDS Custom DB instances. Valid Values: - // 1150-65535 Default: + // The port number on which the database accepts connections. + // + // The value of the DBPortNumber parameter must not match any of the port values + // specified for options in the option group for the DB instance. + // + // If you change the DBPortNumber value, your database restarts regardless of the + // value of the ApplyImmediately parameter. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: 1150-65535 + // + // Default: + // // - Amazon Aurora - 3306 + // // - RDS for Db2 - 50000 + // // - RDS for MariaDB - 3306 + // // - RDS for Microsoft SQL Server - 1433 + // // - RDS for MySQL - 3306 + // // - RDS for Oracle - 1521 + // // - RDS for PostgreSQL - 5432 + // // Constraints: + // // - For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , // 3343 , 3389 , 47001 , or 49152-49156 . 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 DB instances. + // soon as possible. + // + // This setting doesn't apply to RDS Custom DB instances. + // // Constraints: + // // - If supplied, must match existing DB security groups. 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) - // 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 setting doesn't apply to RDS Custom DB instances. + // 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]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 setting doesn't apply to RDS Custom DB instances. + // // Constraints: + // // - If supplied, must match existing DB subnet group. + // // Example: mydbsubnetgroup + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC DBSubnetGroupName *string // Indicates whether the DB instance has a dedicated log volume (DLV) enabled. @@ -215,11 +313,14 @@ type ModifyDBInstanceInput struct { // Specifies 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) - // . This setting doesn't apply to Amazon Aurora DB instances. You can enable or + // protection isn't enabled. For more information, see [Deleting a DB Instance]. + // + // This setting doesn't apply to Amazon Aurora DB instances. You can enable or // disable deletion protection for the DB cluster. For more information, see // ModifyDBCluster . DB instances in a DB cluster can be deleted even when deletion // protection is enabled for the DB cluster. + // + // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // Specifies whether to remove the DB instance from the Active Directory domain. @@ -228,81 +329,120 @@ type ModifyDBInstanceInput struct { // 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 Db2, 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // Oracle, and PostgreSQL DB instances in an Active Directory Domain. + // + // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user - // joining the domain. Example: + // joining the domain. + // + // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain - // controllers. Constraints: + // controllers. + // + // Constraints: + // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. + // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. + // // Constraints: + // // - Can't be longer than 64 characters. + // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string // The name of the IAM role to use when making API calls to the Directory Service. + // // This setting doesn't apply to RDS Custom DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. + // // Constraints: + // // - Must be in the distinguished name format. + // // - Can't be longer than 64 characters. + // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on - // Outposts DB instance. A CoIP provides local or external connectivity to - // resources in your Outpost subnets through your on-premises network. For some 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) - // in the Amazon Web Services Outposts User Guide. + // Outposts DB instance. + // + // A CoIP provides local or external connectivity to resources in your Outpost + // subnets through your on-premises network. For some 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] in the Amazon RDS User Guide. + // + // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User + // Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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 DB - // instances. + // 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] in the Amazon RDS + // User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool - // Specifies 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // Specifies whether to enable Performance Insights for the DB instance. + // + // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The target Oracle DB engine when you convert a non-CDB to a CDB. This // intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an - // Oracle Database 21c CDB. Note the following requirements: + // Oracle Database 21c CDB. + // + // Note the following requirements: + // // - Make sure that you specify oracle-ee-cdb or oracle-se2-cdb . + // // - Make sure that your DB engine runs Oracle Database 19c with an April 2021 // or later RU. + // // Note the following limitations: + // // - You can't convert a CDB to a non-CDB. + // // - You can't convert a replica database. + // // - You can't convert a non-CDB to a CDB and upgrade the engine version in the // same command. + // // - You can't convert the existing custom parameter or option group when it has // options or parameters that are permanent or persistent. In this situation, the // DB instance reverts to the default option and parameter group. To avoid @@ -313,17 +453,27 @@ type ModifyDBInstanceInput struct { // 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 updates 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 higher 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. Constraints: + // 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 updates 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 higher 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. + // + // Constraints: + // // - If you are upgrading the engine version and modifying the DB instance class // at the same time, the currently running engine version must be supported on the // specified DB instance class. Otherwise, the operation returns an error. In this @@ -331,194 +481,296 @@ type ModifyDBInstanceInput struct { // again to modify the DB instance class. 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: + // 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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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. + // // - When you increase the Provisioned IOPS, you must also specify the // AllocatedStorage parameter. You can use the current value for AllocatedStorage // . + // // Default: Uses existing setting Iops *int32 - // The license model for the DB instance. This setting doesn't apply to Amazon - // Aurora or RDS Custom DB instances. Valid Values: + // The license model for the DB instance. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. + // + // Valid Values: + // // - RDS for Db2 - bring-your-own-license + // // - RDS for MariaDB - general-public-license + // // - RDS for Microsoft SQL Server - license-included + // // - RDS for MySQL - general-public-license + // // - RDS for Oracle - bring-your-own-license | license-included + // // - RDS for PostgreSQL - postgresql-license LicenseModel *string // Specifies whether to manage the master user password with Amazon Web Services - // Secrets Manager. If the DB instance 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 instance 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, Amazon - // 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: + // Secrets Manager. + // + // If the DB instance 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 instance 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, Amazon 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] in the Amazon RDS User Guide. + // + // Constraints: + // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool - // The new password for the master user. Changing this parameter doesn't result in - // an outage and the change is asynchronously applied as soon as possible. Between - // the time of the request and the completion of the request, the - // MasterUserPassword element exists in the PendingModifiedValues element of the - // operation response. Amazon RDS API operations never return the password, so this - // operation provides a way to regain access to a primary instance user if the - // password is lost. This includes restoring privileges that might have been - // accidentally revoked. This setting doesn't apply to the following DB instances: + // The new password for the master user. + // + // Changing this parameter doesn't result in an outage and the change is + // asynchronously applied as soon as possible. Between the time of the request and + // the completion of the request, the MasterUserPassword element exists in the + // PendingModifiedValues element of the operation response. + // + // Amazon RDS API operations never return the password, so this operation provides + // a way to regain access to a primary instance user if the password is lost. This + // includes restoring privileges that might have been accidentally revoked. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (The password for the master user is managed by the DB // cluster. For more information, see ModifyDBCluster .) + // // - RDS Custom - // Default: Uses existing setting Constraints: + // + // Default: Uses existing setting + // + // Constraints: + // // - Can't be specified if ManageMasterUserPassword is turned on. + // // - Can include any printable ASCII character except "/", """, or "@". For RDS // for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) // character. + // // Length Constraints: + // // - RDS for Db2 - Must contain from 8 to 255 characters. + // // - RDS for MariaDB - Must contain from 8 to 41 characters. + // // - RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. + // // - RDS for MySQL - Must contain from 8 to 41 characters. + // // - RDS for Oracle - Must contain from 8 to 30 characters. + // // - RDS for PostgreSQL - Must contain from 8 to 128 characters. 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: + // 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. + // 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. + // 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. + // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // 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]in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 // The interval, in seconds, between points when Enhanced Monitoring metrics are // collected for the DB instance. To disable collection of Enhanced Monitoring - // metrics, specify 0 . If MonitoringRoleArn is specified, set MonitoringInterval - // to a value other than 0 . This setting doesn't apply to RDS Custom DB instances. - // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0 + // metrics, specify 0 . + // + // If MonitoringRoleArn is specified, set MonitoringInterval to a value other than + // 0 . + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 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 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 DB instances. + // For information on creating a monitoring role, see [To create an IAM role for Amazon RDS Enhanced Monitoring]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 DB instances. + // + // [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 MonitoringRoleArn *string // Specifies whether the DB instance is a Multi-AZ deployment. Changing this // parameter doesn't result in an outage. The change is applied during the next // maintenance window unless the ApplyImmediately parameter is enabled for this - // request. This setting doesn't apply to RDS Custom DB instances. + // request. + // + // This setting doesn't apply to RDS Custom DB instances. MultiAZ *bool // Specifies whether the to convert your DB instance from the single-tenant // configuration to the multi-tenant configuration. This parameter is supported only - // for RDS for Oracle CDB instances. During the conversion, RDS creates an initial - // tenant database and associates the DB name, master user name, character set, and - // national character set metadata with this database. The tags associated with the - // instance also propagate to the initial tenant database. You can add more tenant - // databases to your DB instance by using the CreateTenantDatabase operation. The - // conversion to the multi-tenant configuration is permanent and irreversible, so - // you can't later convert back to the single-tenant configuration. When you + // for RDS for Oracle CDB instances. + // + // During the conversion, RDS creates an initial tenant database and associates + // the DB name, master user name, character set, and national character set + // metadata with this database. The tags associated with the instance also + // propagate to the initial tenant database. You can add more tenant databases to + // your DB instance by using the CreateTenantDatabase operation. + // + // The conversion to the multi-tenant configuration is permanent and irreversible, + // so you can't later convert back to the single-tenant configuration. When you // specify this parameter, you must also specify ApplyImmediately . MultiTenant *bool - // The network type of the DB instance. 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. Valid Values: IPV4 | DUAL + // The network type of the DB instance. + // + // 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] in the Amazon RDS User Guide. + // + // Valid Values: IPV4 | DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The new 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 maintenance window if - // you disable ApplyImmediately . This value is stored as a lowercase string. This - // setting doesn't apply to RDS Custom DB instances. Constraints: + // you disable ApplyImmediately . This value is stored as a lowercase string. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // 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: mydbinstance NewDBInstanceIdentifier *string - // The option group to associate the DB instance with. Changing this parameter - // doesn't result in an outage, with one exception. If the parameter change results - // in an option group that enables OEM, it can cause a brief period, lasting less - // than a second, during which new connections are rejected but existing - // connections aren't interrupted. The change is applied during the next - // maintenance window unless the ApplyImmediately parameter is enabled for this - // request. Permanent options, such as the TDE option for Oracle Advanced Security - // TDE, can't be removed from an option group, and that option group can't be - // removed from a DB instance after it is associated with a DB instance. This - // setting doesn't apply to RDS Custom DB instances. + // The option group to associate the DB instance with. + // + // Changing this parameter doesn't result in an outage, with one exception. If the + // parameter change results in an option group that enables OEM, it can cause a + // brief period, lasting less than a second, during which new connections are + // rejected but existing connections aren't interrupted. + // + // The change is applied during the next maintenance window unless the + // ApplyImmediately parameter is enabled for this request. + // + // Permanent options, such as the TDE option for Oracle Advanced Security TDE, + // can't be removed from an option group, and that option group can't be removed + // from a DB instance after it is associated with a DB instance. + // + // This setting doesn't apply to RDS Custom DB instances. OptionGroupName *string // 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. This setting doesn't apply to RDS Custom DB instances. + // 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. + // + // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. This setting doesn't - // apply to RDS Custom DB instances. Valid Values: + // The number of days to retain Performance Insights data. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 - // Default: 7 days If you specify a retention period that isn't valid, such as 94 , - // Amazon RDS returns an error. + // + // Default: 7 days + // + // If you specify a retention period that isn't valid, such as 94 , Amazon RDS + // returns an error. PerformanceInsightsRetentionPeriod *int32 // The daily time range during which automated backups are created if automated @@ -526,14 +778,23 @@ 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) - // in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora DB - // instances. The daily time range for creating automated backups is managed by the - // DB cluster. For more information, see ModifyDBCluster . Constraints: + // Region. For more information, see [Backup window]in the Amazon RDS User Guide. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC). + // // - Must not conflict with the preferred maintenance window. + // // - Must be at least 30 minutes. + // + // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow PreferredBackupWindow *string // The weekly time range during which system maintenance can occur, which might @@ -543,110 +804,171 @@ type ModifyDBInstanceInput struct { // window is changed to include the current time, then changing this parameter // causes a reboot of the DB instance. If you change 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) - // in the Amazon RDS User Guide. Default: Uses existing setting Constraints: + // window to ensure pending changes are applied. + // + // For more information, see [Amazon RDS Maintenance Window] in the Amazon RDS User Guide. + // + // Default: Uses existing setting + // + // Constraints: + // // - Must be in the format ddd:hh24:mi-ddd:hh24:mi . + // // - The day values must be 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. + // + // [Amazon RDS Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance PreferredMaintenanceWindow *string // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. This setting doesn't apply to RDS Custom DB instances. + // class of the DB instance. + // + // This setting doesn't apply to RDS Custom DB instances. ProcessorFeatures []types.ProcessorFeature // The order of priority 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/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) - // in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB - // instances. Default: 1 Valid Values: 0 - 15 + // see [Fault Tolerance for an Aurora DB Cluster]in the Amazon Aurora User Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // Default: 1 + // + // Valid Values: 0 - 15 + // + // [Fault Tolerance for an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance PromotionTier *int32 - // Specifies whether the DB instance is publicly accessible. When the DB cluster - // is publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security 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. + // Specifies whether the DB instance is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // 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. + // // PubliclyAccessible only applies to DB instances in a VPC. The DB instance must // be part of a public subnet and PubliclyAccessible must be enabled for it to be - // publicly accessible. Changes to the PubliclyAccessible parameter are applied - // immediately regardless of the value of the ApplyImmediately parameter. + // publicly accessible. + // + // Changes to the PubliclyAccessible parameter are applied immediately regardless + // of the value of the ApplyImmediately parameter. PubliclyAccessible *bool // A value that sets the open mode of a replica database to either mounted or - // read-only. Currently, this parameter is only supported for Oracle DB instances. - // Mounted DB replicas are included in Oracle Enterprise Edition. The main use case - // for mounted replicas is cross-Region disaster recovery. The primary database - // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB - // instances. + // read-only. + // + // Currently, this parameter is only supported for Oracle DB instances. + // + // Mounted DB replicas are included in Oracle Enterprise Edition. The main use + // case for mounted replicas is cross-Region disaster recovery. The primary + // database 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]in the Amazon RDS User + // Guide. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // [Working with Oracle Read Replicas for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html ReplicaMode types.ReplicaMode // The number of minutes to pause the automation. When the time period ends, RDS - // Custom resumes full automation. Default: 60 Constraints: + // Custom resumes full automation. + // + // Default: 60 + // + // Constraints: + // // - Must be at least 60. + // // - Must be no more than 1,440. ResumeFullAutomationModeMinutes *int32 // Specifies 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) - // in the Amazon RDS User Guide. Constraints: + // 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] in the Amazon RDS User Guide. + // + // Constraints: + // // - You must apply the change immediately when rotating the master user // password. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html RotateMasterUserPassword *bool - // The storage throughput value for the DB instance. This setting applies only to - // the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS Custom - // DB instances. + // The storage throughput value for the DB instance. + // + // This setting applies only to the gp3 storage type. + // + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. StorageThroughput *int32 - // The storage type to associate with the DB instance. If you specify io1 , io2 , - // or gp3 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 | io2 | - // standard Default: io1 , if the Iops parameter is specified. Otherwise, gp2 . + // The storage type to associate with the DB instance. + // + // If you specify io1 , io2 , or gp3 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 | io2 | 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 DB instances. + // encryption. + // + // This setting doesn't apply to RDS Custom DB instances. 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 DB instances. + // The password for the given ARN from the key store in order to access the device. + // + // This setting doesn't apply to RDS Custom DB instances. TdeCredentialPassword *string // Specifies whether the DB instance class of the DB instance uses its default - // processor features. This setting doesn't apply to RDS Custom DB instances. + // processor features. + // + // This setting doesn't apply to RDS Custom DB instances. UseDefaultProcessorFeatures *bool // A list of Amazon EC2 VPC security groups to associate with this DB instance. - // This change is asynchronously applied as soon as possible. This setting doesn't - // apply to the following DB instances: + // This change is asynchronously applied as soon as possible. + // + // This setting doesn't apply to the following DB instances: + // // - Amazon Aurora (The associated list of EC2 VPC security groups is managed by // the DB cluster. For more information, see ModifyDBCluster .) + // // - RDS Custom + // // Constraints: + // // - If supplied, must match existing VPC security group IDs. VpcSecurityGroupIds []string @@ -655,9 +977,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_ModifyDBParameterGroup.go b/service/rds/api_op_ModifyDBParameterGroup.go index 384728274d4..c3e5d266dec 100644 --- a/service/rds/api_op_ModifyDBParameterGroup.go +++ b/service/rds/api_op_ModifyDBParameterGroup.go @@ -14,16 +14,18 @@ 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. -// 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 operation -// before the 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 RDS console (https://console.aws.amazon.com/rds/) -// or the DescribeDBParameters command to verify that your DB parameter group has -// been created or modified. +// +// 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 +// operation before the 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 RDS console]or the DescribeDBParameters command to +// verify that your DB parameter group has been created or modified. +// +// [Amazon RDS console]: https://console.aws.amazon.com/rds/ func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBParameterGroupInput, optFns ...func(*Options)) (*ModifyDBParameterGroupOutput, error) { if params == nil { params = &ModifyDBParameterGroupInput{} @@ -41,7 +43,10 @@ func (c *Client) ModifyDBParameterGroup(ctx context.Context, params *ModifyDBPar type ModifyDBParameterGroupInput struct { - // The name of the DB parameter group. Constraints: + // The name of the DB parameter group. + // + // Constraints: + // // - If supplied, must match the name of an existing DBParameterGroup . // // This member is required. @@ -50,18 +55,27 @@ type ModifyDBParameterGroupInput struct { // An array of parameter names, values, and the application methods for the // parameter update. At least one parameter name, value, and application method // must be supplied; later arguments are optional. A maximum of 20 parameters can - // 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 - // parameters are applied immediately to the DB instances associated with the - // 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 - // more information on modifying DB parameters, see Working with DB parameter - // groups (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) - // in the Amazon RDS User Guide. + // 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 parameters are + // applied immediately to the DB instances associated with the 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 more information on modifying DB parameters, see [Working with DB parameter groups] in the Amazon RDS User + // Guide. + // + // [Working with DB parameter groups]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html // // This member is required. Parameters []types.Parameter diff --git a/service/rds/api_op_ModifyDBRecommendation.go b/service/rds/api_op_ModifyDBRecommendation.go index 9d13de0768b..784e511fc97 100644 --- a/service/rds/api_op_ModifyDBRecommendation.go +++ b/service/rds/api_op_ModifyDBRecommendation.go @@ -42,8 +42,12 @@ type ModifyDBRecommendationInput struct { // recommended actions at one time. RecommendedActionUpdates []types.RecommendedActionUpdate - // The recommendation status to update. Valid values: + // The recommendation status to update. + // + // Valid values: + // // - active + // // - dismissed Status *string diff --git a/service/rds/api_op_ModifyDBShardGroup.go b/service/rds/api_op_ModifyDBShardGroup.go index 5189c08c7bf..c00057cd5d2 100644 --- a/service/rds/api_op_ModifyDBShardGroup.go +++ b/service/rds/api_op_ModifyDBShardGroup.go @@ -45,10 +45,13 @@ type ModifyDBShardGroupOutput struct { // Specifies whether to create standby instances for the DB shard group. Valid // values are the following: + // // - 0 - Creates a single, primary DB instance for each physical shard. This is // the default value, and the only one supported for the preview. + // // - 1 - Creates a primary DB instance and a standby instance in a different // Availability Zone (AZ) for each physical shard. + // // - 2 - Creates a primary DB instance and two standby instances in different // AZs for each physical shard. ComputeRedundancy *int32 @@ -69,16 +72,21 @@ type ModifyDBShardGroupOutput struct { // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 - // Indicates whether the DB shard group is publicly accessible. When the DB shard - // group is publicly accessible, its Domain Name System (DNS) endpoint resolves to - // the private IP address from within the DB shard group's virtual private cloud - // (VPC). It resolves to the public IP address from outside of the DB shard group's - // VPC. Access to the DB shard group is ultimately controlled by the security group - // it uses. That public access isn't permitted if the security group assigned to - // the DB shard group doesn't permit it. When the DB shard group isn't publicly - // accessible, it is an internal DB shard group with a DNS name that resolves to a - // private IP address. For more information, see CreateDBShardGroup . This setting - // is only for Aurora Limitless Database. + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately + // controlled by the security group it uses. That public access isn't permitted if + // the security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. diff --git a/service/rds/api_op_ModifyDBSnapshot.go b/service/rds/api_op_ModifyDBSnapshot.go index 02c4cd850f1..ea51e5781bf 100644 --- a/service/rds/api_op_ModifyDBSnapshot.go +++ b/service/rds/api_op_ModifyDBSnapshot.go @@ -12,9 +12,10 @@ import ( ) // Updates a manual DB snapshot with a new engine version. The snapshot can be -// encrypted or unencrypted, but not shared or public. Amazon RDS supports -// upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't -// apply to RDS Custom or RDS for Db2. +// encrypted or unencrypted, but not shared or public. +// +// Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. +// This operation doesn't apply to RDS Custom or RDS for Db2. func (c *Client) ModifyDBSnapshot(ctx context.Context, params *ModifyDBSnapshotInput, optFns ...func(*Options)) (*ModifyDBSnapshotOutput, error) { if params == nil { params = &ModifyDBSnapshotInput{} @@ -37,26 +38,44 @@ 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 For the list of engine versions that are available for upgrading - // a DB snapshot, see Upgrading a MySQL DB snapshot engine version (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html) - // in the Amazon RDS User Guide. Oracle + // 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 + // + // For the list of engine versions that are available for upgrading a DB snapshot, + // see [Upgrading a MySQL DB snapshot engine version]in the Amazon RDS User Guide. + // + // Oracle + // // - 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots) + // // - 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots) + // // - 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 a PostgreSQL DB snapshot engine version (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html) - // in the Amazon RDS User Guide. + // + // PostgreSQL + // + // For the list of engine versions that are available for upgrading a DB snapshot, + // see [Upgrading a PostgreSQL DB snapshot engine version]in the Amazon RDS User Guide. + // + // [Upgrading a PostgreSQL DB snapshot engine version]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html + // [Upgrading a MySQL DB snapshot engine version]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-upgrade-snapshot.html 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 - // 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) - // in the Amazon RDS User Guide. + // 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]in the Amazon RDS User Guide. + // + // [Option group considerations]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG OptionGroupName *string noSmithyDocumentSerde @@ -64,8 +83,9 @@ type ModifyDBSnapshotInput struct { type ModifyDBSnapshotOutput struct { - // Contains the details of an Amazon RDS DB snapshot. This data type is used as a - // response element in the DescribeDBSnapshots action. + // Contains the details of an Amazon RDS DB snapshot. + // + // This data type is used as a response element in the DescribeDBSnapshots action. DBSnapshot *types.DBSnapshot // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBSnapshotAttribute.go b/service/rds/api_op_ModifyDBSnapshotAttribute.go index 706523388f1..a67e0dd65e0 100644 --- a/service/rds/api_op_ModifyDBSnapshotAttribute.go +++ b/service/rds/api_op_ModifyDBSnapshotAttribute.go @@ -12,20 +12,25 @@ 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. +// 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. func (c *Client) ModifyDBSnapshotAttribute(ctx context.Context, params *ModifyDBSnapshotAttributeInput, optFns ...func(*Options)) (*ModifyDBSnapshotAttributeOutput, error) { if params == nil { params = &ModifyDBSnapshotAttributeInput{} @@ -43,10 +48,12 @@ func (c *Client) ModifyDBSnapshotAttribute(ctx context.Context, params *ModifyDB 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 - // the DescribeDBSnapshotAttributes API operation. + // 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 the DescribeDBSnapshotAttributes API operation. // // This member is required. AttributeName *string @@ -57,21 +64,25 @@ 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 - // 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 - // snapshots that contain private information that you don't want available to all - // Amazon Web Services accounts. + // 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 snapshots that contain + // private information that you don't want available to all Amazon Web Services + // accounts. 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 @@ -80,9 +91,11 @@ type ModifyDBSnapshotAttributeInput struct { type ModifyDBSnapshotAttributeOutput struct { // Contains the results of a successful call to the DescribeDBSnapshotAttributes - // API action. Manual DB snapshot attributes are used to authorize other Amazon Web - // Services accounts to copy or restore a manual DB snapshot. For more information, - // see the ModifyDBSnapshotAttribute API action. + // API action. + // + // Manual DB snapshot attributes are used to authorize other Amazon Web Services + // accounts to copy or restore a manual DB snapshot. For more information, see the + // ModifyDBSnapshotAttribute API action. DBSnapshotAttributesResult *types.DBSnapshotAttributesResult // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_ModifyDBSubnetGroup.go b/service/rds/api_op_ModifyDBSubnetGroup.go index efdb7100eec..0ffc4002d91 100644 --- a/service/rds/api_op_ModifyDBSubnetGroup.go +++ b/service/rds/api_op_ModifyDBSubnetGroup.go @@ -31,8 +31,12 @@ func (c *Client) ModifyDBSubnetGroup(ctx context.Context, params *ModifyDBSubnet type ModifyDBSubnetGroupInput struct { // The name for the DB 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: mydbsubnetgroup + // You can't modify the default subnet group. + // + // Constraints: Must match the name of an existing DBSubnetGroup. Must not be + // default. + // + // Example: mydbsubnetgroup // // This member is required. DBSubnetGroupName *string @@ -50,8 +54,10 @@ 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 8f382a1dcb2..13cc5e91fba 100644 --- a/service/rds/api_op_ModifyEventSubscription.go +++ b/service/rds/api_op_ModifyEventSubscription.go @@ -14,9 +14,13 @@ import ( // Modifies an existing RDS event notification subscription. 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 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. +// RemoveSourceIdentifierFromSubscription calls. +// +// You can see a list of the event categories for a given source type ( SourceType +// ) in [Events]in the Amazon RDS User Guide or by using the DescribeEventCategories +// operation. +// +// [Events]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html func (c *Client) ModifyEventSubscription(ctx context.Context, params *ModifyEventSubscriptionInput, optFns ...func(*Options)) (*ModifyEventSubscriptionOutput, error) { if params == nil { params = &ModifyEventSubscriptionInput{} @@ -43,9 +47,10 @@ type ModifyEventSubscriptionInput struct { Enabled *bool // 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) + // subscribe to. You can see a list of the categories for a given source type in [Events] // in the Amazon RDS User Guide or by using the DescribeEventCategories operation. + // + // [Events]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html EventCategories []string // The Amazon Resource Name (ARN) of the SNS topic created for event notification. @@ -55,9 +60,10 @@ type ModifyEventSubscriptionInput struct { // 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 + // 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 noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyGlobalCluster.go b/service/rds/api_op_ModifyGlobalCluster.go index 4e0f7b1b414..909c63352e5 100644 --- a/service/rds/api_op_ModifyGlobalCluster.go +++ b/service/rds/api_op_ModifyGlobalCluster.go @@ -13,10 +13,12 @@ import ( // Modifies a setting for an Amazon Aurora global database 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 operation only applies to Aurora global -// database clusters. +// the new values in the request. For more information on Amazon Aurora, see [What is Amazon Aurora?]in +// the Amazon Aurora User Guide. +// +// This operation only applies to Aurora global database clusters. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalClusterInput, optFns ...func(*Options)) (*ModifyGlobalClusterOutput, error) { if params == nil { params = &ModifyGlobalClusterInput{} @@ -34,12 +36,15 @@ func (c *Client) ModifyGlobalCluster(ctx context.Context, params *ModifyGlobalCl type ModifyGlobalClusterInput struct { - // Specifies whether to allow major version upgrades. Constraints: Must be enabled - // if you specify a value for the EngineVersion parameter that's a different major - // version than the global cluster's current version. If you upgrade the major - // version of a global database, the cluster and DB instance parameter groups are - // set to the default parameter groups for the new version. Apply any custom - // parameter groups after completing the upgrade. + // Specifies whether to allow major version upgrades. + // + // Constraints: Must be enabled if you specify a value for the EngineVersion + // parameter that's a different major version than the global cluster's current + // version. + // + // If you upgrade the major version of a global database, the cluster and DB + // instance parameter groups are set to the default parameter groups for the new + // version. Apply any custom parameter groups after completing the upgrade. AllowMajorVersionUpgrade *bool // Specifies whether to enable deletion protection for the global database @@ -47,27 +52,40 @@ type ModifyGlobalClusterInput struct { // is enabled. DeletionProtection *bool - // The version number of the database engine to which you want to upgrade. To list - // all of the available engine versions for aurora-mysql (for MySQL-based Aurora - // global databases), 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 (for PostgreSQL-based Aurora - // global databases), use the following command: aws rds - // describe-db-engine-versions --engine aurora-postgresql --query - // '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' + // The version number of the database engine to which you want to upgrade. + // + // To list all of the available engine versions for aurora-mysql (for MySQL-based + // Aurora global databases), 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 (for + // PostgreSQL-based Aurora global databases), use the following command: + // + // aws rds describe-db-engine-versions --engine aurora-postgresql --query + // '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' EngineVersion *string // The cluster identifier for the global cluster to modify. This parameter isn't - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing global database cluster. GlobalClusterIdentifier *string // The new cluster identifier for the global database cluster. This value is - // stored as a lowercase string. Constraints: + // 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 NewGlobalClusterIdentifier *string diff --git a/service/rds/api_op_ModifyIntegration.go b/service/rds/api_op_ModifyIntegration.go index 79ecae720c7..1fe479d8280 100644 --- a/service/rds/api_op_ModifyIntegration.go +++ b/service/rds/api_op_ModifyIntegration.go @@ -12,10 +12,11 @@ import ( "time" ) -// Modifies a zero-ETL integration with Amazon Redshift. Currently, you can only -// modify integrations that have Aurora MySQL source DB clusters. Integrations with -// Aurora PostgreSQL and RDS sources currently don't support modifying the -// integration. +// Modifies a zero-ETL integration with Amazon Redshift. +// +// Currently, you can only modify integrations that have Aurora MySQL source DB +// clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't +// support modifying the integration. func (c *Client) ModifyIntegration(ctx context.Context, params *ModifyIntegrationInput, optFns ...func(*Options)) (*ModifyIntegrationOutput, error) { if params == nil { params = &ModifyIntegrationInput{} @@ -38,9 +39,9 @@ type ModifyIntegrationInput struct { // This member is required. IntegrationIdentifier *string - // A new data filter for the integration. For more information, see Data filtering - // for Aurora zero-ETL integrations with Amazon Redshift (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html) - // . + // A new data filter for the integration. For more information, see [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]. + // + // [Data filtering for Aurora zero-ETL integrations with Amazon Redshift]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html DataFilter *string // A new description for the integration. @@ -55,9 +56,10 @@ type ModifyIntegrationInput struct { // A zero-ETL integration with Amazon Redshift. type ModifyIntegrationOutput struct { - // The encryption context for the integration. For more information, see - // Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the Amazon Web Services Key Management Service Developer Guide. + // The encryption context for the integration. For more information, see [Encryption context] in the + // Amazon Web Services Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). @@ -90,8 +92,9 @@ type ModifyIntegrationOutput struct { // The current status of the integration. Status types.IntegrationStatus - // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // The ARN of the Redshift data warehouse used as the target for replication. diff --git a/service/rds/api_op_ModifyOptionGroup.go b/service/rds/api_op_ModifyOptionGroup.go index a2fc58ce8c8..a1bc78d90d5 100644 --- a/service/rds/api_op_ModifyOptionGroup.go +++ b/service/rds/api_op_ModifyOptionGroup.go @@ -29,10 +29,11 @@ func (c *Client) ModifyOptionGroup(ctx context.Context, params *ModifyOptionGrou type ModifyOptionGroupInput struct { - // The name of the option group to be modified. Permanent options, such as the TDE - // option for Oracle Advanced Security TDE, can't be removed from an option group, - // and that option group can't be removed from a DB instance once it is associated - // with a DB instance + // The name of the option group to be modified. + // + // Permanent options, such as the TDE option for Oracle Advanced Security TDE, + // can't be removed from an option group, and that option group can't be removed + // from a DB instance once it is associated with a DB instance // // This member is required. OptionGroupName *string diff --git a/service/rds/api_op_ModifyTenantDatabase.go b/service/rds/api_op_ModifyTenantDatabase.go index 0342bcaee33..f665ec8585a 100644 --- a/service/rds/api_op_ModifyTenantDatabase.go +++ b/service/rds/api_op_ModifyTenantDatabase.go @@ -32,33 +32,49 @@ func (c *Client) ModifyTenantDatabase(ctx context.Context, params *ModifyTenantD type ModifyTenantDatabaseInput struct { // The identifier of the DB instance that contains the tenant database that you - // are modifying. This parameter isn't case-sensitive. Constraints: + // are modifying. This parameter isn't case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DB instance. // // This member is required. DBInstanceIdentifier *string // The user-supplied name of the tenant database that you want to modify. This - // parameter isn’t case-sensitive. Constraints: + // parameter isn’t case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing tenant database. // // This member is required. TenantDBName *string // The new password for the master user of the specified tenant database in your - // DB instance. Amazon RDS operations never return the password, so this action - // provides a way to regain access to a tenant database user if the password is - // lost. This includes restoring privileges that might have been accidentally - // revoked. Constraints: + // DB instance. + // + // Amazon RDS operations never return the password, so this action provides a way + // to regain access to a tenant database user if the password is lost. This + // includes restoring privileges that might have been accidentally revoked. + // + // Constraints: + // // - Can include any printable ASCII character except / , " (double quote), @ , & // (ampersand), and ' (single quote). + // // Length constraints: + // // - Must contain between 8 and 30 characters. MasterUserPassword *string // The new name of the tenant database when renaming a tenant database. This - // parameter isn’t case-sensitive. Constraints: + // parameter isn’t case-sensitive. + // + // Constraints: + // // - Can't be the string null or any other reserved word. + // // - Can't be longer than 8 characters. NewTenantDBName *string diff --git a/service/rds/api_op_PromoteReadReplica.go b/service/rds/api_op_PromoteReadReplica.go index 752aadc0046..bb2619cd926 100644 --- a/service/rds/api_op_PromoteReadReplica.go +++ b/service/rds/api_op_PromoteReadReplica.go @@ -12,6 +12,7 @@ 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 @@ -19,6 +20,7 @@ import ( // 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) { @@ -39,8 +41,11 @@ func (c *Client) PromoteReadReplica(ctx context.Context, params *PromoteReadRepl 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. + // // Example: mydbinstance // // This member is required. @@ -48,21 +53,35 @@ 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: + // 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. 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) - // in the Amazon RDS User Guide. Constraints: + // 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] + // 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. + // + // [Adjusting the Preferred Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html PreferredBackupWindow *string noSmithyDocumentSerde @@ -70,9 +89,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_PromoteReadReplicaDBCluster.go b/service/rds/api_op_PromoteReadReplicaDBCluster.go index 486a6bdfcb4..9e56bb44d2a 100644 --- a/service/rds/api_op_PromoteReadReplicaDBCluster.go +++ b/service/rds/api_op_PromoteReadReplicaDBCluster.go @@ -30,8 +30,12 @@ func (c *Client) PromoteReadReplicaDBCluster(ctx context.Context, params *Promot type PromoteReadReplicaDBClusterInput struct { // The identifier of the DB cluster read replica to promote. This parameter isn't - // case-sensitive. Constraints: + // case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing DB cluster read replica. + // // Example: my-cluster-replica1 // // This member is required. @@ -42,20 +46,27 @@ type PromoteReadReplicaDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_PurchaseReservedDBInstancesOffering.go b/service/rds/api_op_PurchaseReservedDBInstancesOffering.go index 6def1044cad..1f252c33ff8 100644 --- a/service/rds/api_op_PurchaseReservedDBInstancesOffering.go +++ b/service/rds/api_op_PurchaseReservedDBInstancesOffering.go @@ -29,21 +29,26 @@ func (c *Client) PurchaseReservedDBInstancesOffering(ctx context.Context, params type PurchaseReservedDBInstancesOfferingInput struct { - // The ID of the Reserved DB instance offering to purchase. Example: - // 438012d3-4052-4cc7-b2e3-8d3372e0e706 + // The ID of the Reserved DB instance offering to purchase. + // + // Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 // // This member is required. ReservedDBInstancesOfferingId *string - // The number of instances to reserve. Default: 1 + // The number of instances to reserve. + // + // Default: 1 DBInstanceCount *int32 - // Customer-specified identifier to track this reservation. Example: - // myreservationID + // Customer-specified identifier to track this reservation. + // + // Example: 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/rds/api_op_RebootDBCluster.go b/service/rds/api_op_RebootDBCluster.go index 7b7591d6f35..efc97c5ba49 100644 --- a/service/rds/api_op_RebootDBCluster.go +++ b/service/rds/api_op_RebootDBCluster.go @@ -14,12 +14,18 @@ import ( // You might need to reboot your DB cluster, usually for maintenance reasons. For // example, if you make certain modifications, or if you change the DB cluster // parameter group associated with the DB cluster, reboot the DB cluster for the -// 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) -// in the Amazon RDS User Guide. +// 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] in the Amazon RDS User +// Guide. +// +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) RebootDBCluster(ctx context.Context, params *RebootDBClusterInput, optFns ...func(*Options)) (*RebootDBClusterOutput, error) { if params == nil { params = &RebootDBClusterInput{} @@ -38,7 +44,9 @@ func (c *Client) RebootDBCluster(ctx context.Context, params *RebootDBClusterInp type RebootDBClusterInput struct { // The DB cluster identifier. This parameter is stored as a lowercase string. + // // Constraints: + // // - Must match the identifier of an existing DBCluster. // // This member is required. @@ -49,20 +57,27 @@ type RebootDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RebootDBInstance.go b/service/rds/api_op_RebootDBInstance.go index 2d74be493be..b308bba9c6a 100644 --- a/service/rds/api_op_RebootDBInstance.go +++ b/service/rds/api_op_RebootDBInstance.go @@ -14,13 +14,20 @@ import ( // You might need to reboot your DB instance, usually for maintenance reasons. For // example, if you make certain modifications, or if you change the DB parameter // group associated with the DB instance, you must reboot the instance for the -// 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) -// 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. +// 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] 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. +// +// [Rebooting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceInput, optFns ...func(*Options)) (*RebootDBInstanceOutput, error) { if params == nil { params = &RebootDBInstanceInput{} @@ -39,15 +46,18 @@ func (c *Client) RebootDBInstance(ctx context.Context, params *RebootDBInstanceI type RebootDBInstanceInput struct { // The DB instance identifier. This parameter is stored as a lowercase string. + // // Constraints: + // // - Must match the identifier of an existing DBInstance. // // This member is required. DBInstanceIdentifier *string // Specifies whether the reboot is conducted through a Multi-AZ failover. - // Constraint: You can't enable force failover if the instance isn't configured for - // Multi-AZ. + // + // Constraint: You can't enable force failover if the instance isn't configured + // for Multi-AZ. ForceFailover *bool noSmithyDocumentSerde @@ -55,9 +65,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_RebootDBShardGroup.go b/service/rds/api_op_RebootDBShardGroup.go index fcc145bea61..a26c1fd38c9 100644 --- a/service/rds/api_op_RebootDBShardGroup.go +++ b/service/rds/api_op_RebootDBShardGroup.go @@ -12,8 +12,9 @@ import ( // You might need to reboot your DB shard group, usually for maintenance reasons. // For example, if you make certain modifications, reboot the DB shard group for -// the changes to take effect. This operation applies only to Aurora Limitless -// Database DBb shard groups. +// the changes to take effect. +// +// This operation applies only to Aurora Limitless Database DBb shard groups. func (c *Client) RebootDBShardGroup(ctx context.Context, params *RebootDBShardGroupInput, optFns ...func(*Options)) (*RebootDBShardGroupOutput, error) { if params == nil { params = &RebootDBShardGroupInput{} @@ -43,10 +44,13 @@ type RebootDBShardGroupOutput struct { // Specifies whether to create standby instances for the DB shard group. Valid // values are the following: + // // - 0 - Creates a single, primary DB instance for each physical shard. This is // the default value, and the only one supported for the preview. + // // - 1 - Creates a primary DB instance and a standby instance in a different // Availability Zone (AZ) for each physical shard. + // // - 2 - Creates a primary DB instance and two standby instances in different // AZs for each physical shard. ComputeRedundancy *int32 @@ -67,16 +71,21 @@ type RebootDBShardGroupOutput struct { // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 - // Indicates whether the DB shard group is publicly accessible. When the DB shard - // group is publicly accessible, its Domain Name System (DNS) endpoint resolves to - // the private IP address from within the DB shard group's virtual private cloud - // (VPC). It resolves to the public IP address from outside of the DB shard group's - // VPC. Access to the DB shard group is ultimately controlled by the security group - // it uses. That public access isn't permitted if the security group assigned to - // the DB shard group doesn't permit it. When the DB shard group isn't publicly - // accessible, it is an internal DB shard group with a DNS name that resolves to a - // private IP address. For more information, see CreateDBShardGroup . This setting - // is only for Aurora Limitless Database. + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately + // controlled by the security group it uses. That public access isn't permitted if + // the security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. diff --git a/service/rds/api_op_RemoveFromGlobalCluster.go b/service/rds/api_op_RemoveFromGlobalCluster.go index 7dd1ce69e61..629a2ed4aab 100644 --- a/service/rds/api_op_RemoveFromGlobalCluster.go +++ b/service/rds/api_op_RemoveFromGlobalCluster.go @@ -14,6 +14,7 @@ import ( // 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 operation only applies to Aurora DB clusters. func (c *Client) RemoveFromGlobalCluster(ctx context.Context, params *RemoveFromGlobalClusterInput, optFns ...func(*Options)) (*RemoveFromGlobalClusterOutput, error) { if params == nil { diff --git a/service/rds/api_op_RemoveRoleFromDBCluster.go b/service/rds/api_op_RemoveRoleFromDBCluster.go index 96cc48c07e2..6c49b9ef1d8 100644 --- a/service/rds/api_op_RemoveRoleFromDBCluster.go +++ b/service/rds/api_op_RemoveRoleFromDBCluster.go @@ -11,11 +11,16 @@ 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) -// 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) -// in the Amazon RDS User Guide. +// Management (IAM) role from a DB cluster. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User +// Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) RemoveRoleFromDBCluster(ctx context.Context, params *RemoveRoleFromDBClusterInput, optFns ...func(*Options)) (*RemoveRoleFromDBClusterOutput, error) { if params == nil { params = &RemoveRoleFromDBClusterInput{} @@ -45,8 +50,7 @@ type RemoveRoleFromDBClusterInput struct { 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 . + // disassociated from. For information about supported feature names, see DBEngineVersion. FeatureName *string noSmithyDocumentSerde diff --git a/service/rds/api_op_RemoveTagsFromResource.go b/service/rds/api_op_RemoveTagsFromResource.go index a5fde5c8009..61ef95c09a3 100644 --- a/service/rds/api_op_RemoveTagsFromResource.go +++ b/service/rds/api_op_RemoveTagsFromResource.go @@ -10,9 +10,12 @@ 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) -// in the Amazon RDS User Guide. +// Removes metadata tags from an Amazon RDS resource. +// +// For an overview on tagging an Amazon RDS resource, see [Tagging Amazon RDS Resources] in the Amazon RDS User +// Guide. +// +// [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error) { if params == nil { params = &RemoveTagsFromResourceInput{} @@ -31,9 +34,10 @@ 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) - // in the Amazon RDS User Guide. + // Resource Name (ARN). For information about creating an ARN, see [Constructing an ARN for Amazon RDS]in the Amazon + // RDS User Guide. + // + // [Constructing an ARN for Amazon RDS]: 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_ResetDBClusterParameterGroup.go b/service/rds/api_op_ResetDBClusterParameterGroup.go index e4462d299ad..645939e054f 100644 --- a/service/rds/api_op_ResetDBClusterParameterGroup.go +++ b/service/rds/api_op_ResetDBClusterParameterGroup.go @@ -14,16 +14,22 @@ import ( // 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) -// 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) -// in the Amazon RDS User Guide. +// 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?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User +// Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) ResetDBClusterParameterGroup(ctx context.Context, params *ResetDBClusterParameterGroupInput, optFns ...func(*Options)) (*ResetDBClusterParameterGroupOutput, error) { if params == nil { params = &ResetDBClusterParameterGroupInput{} @@ -61,10 +67,16 @@ type ResetDBClusterParameterGroupInput struct { type ResetDBClusterParameterGroupOutput struct { - // The name of the DB cluster parameter group. Constraints: + // 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. DBClusterParameterGroupName *string diff --git a/service/rds/api_op_ResetDBParameterGroup.go b/service/rds/api_op_ResetDBParameterGroup.go index 11968af1095..b50b11e84fe 100644 --- a/service/rds/api_op_ResetDBParameterGroup.go +++ b/service/rds/api_op_ResetDBParameterGroup.go @@ -35,7 +35,10 @@ func (c *Client) ResetDBParameterGroup(ctx context.Context, params *ResetDBParam type ResetDBParameterGroupInput struct { - // The name of the DB parameter group. Constraints: + // The name of the DB parameter group. + // + // Constraints: + // // - Must match the name of an existing DBParameterGroup . // // This member is required. @@ -44,13 +47,26 @@ type ResetDBParameterGroupInput struct { // 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 + // 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 diff --git a/service/rds/api_op_RestoreDBClusterFromS3.go b/service/rds/api_op_RestoreDBClusterFromS3.go index 3e826b1c362..f4b90e870ce 100644 --- a/service/rds/api_op_RestoreDBClusterFromS3.go +++ b/service/rds/api_op_RestoreDBClusterFromS3.go @@ -13,17 +13,22 @@ 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) -// in the Amazon Aurora User Guide. This operation only restores the DB cluster, -// not the DB instances for that DB cluster. You must invoke the CreateDBInstance -// operation 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 RestoreDBClusterFromS3 operation 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) -// in the Amazon Aurora User Guide. This operation only applies to Aurora DB -// clusters. The source DB engine must be MySQL. +// data must be created using the Percona XtraBackup utility as described in [Migrating Data from MySQL by Using an Amazon S3 Bucket]in +// the Amazon Aurora User Guide. +// +// This operation only restores the DB cluster, not the DB instances for that DB +// cluster. You must invoke the CreateDBInstance operation 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 +// RestoreDBClusterFromS3 operation has completed and the DB cluster is available. +// +// For more information on Amazon Aurora, see [What is Amazon Aurora?] in the Amazon Aurora User Guide. +// +// This operation only applies to Aurora DB clusters. The source DB engine must be +// MySQL. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [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 func (c *Client) RestoreDBClusterFromS3(ctx context.Context, params *RestoreDBClusterFromS3Input, optFns ...func(*Options)) (*RestoreDBClusterFromS3Output, error) { if params == nil { params = &RestoreDBClusterFromS3Input{} @@ -42,24 +47,36 @@ func (c *Client) RestoreDBClusterFromS3(ctx context.Context, params *RestoreDBCl 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: + // 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 // // This member is required. DBClusterIdentifier *string - // The name of the database engine to be used for this DB cluster. Valid Values: - // aurora-mysql (for Aurora MySQL) + // The name of the database engine to be used for this DB cluster. + // + // Valid Values: aurora-mysql (for Aurora MySQL) // // This member is required. Engine *string - // The name of the master user for the restored DB cluster. Constraints: + // 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. // // This member is required. @@ -79,13 +96,18 @@ type RestoreDBClusterFromS3Input struct { S3IngestionRoleArn *string // The identifier for the database engine that was backed up to create the files - // stored in the Amazon S3 bucket. Valid Values: mysql + // stored in the Amazon S3 bucket. + // + // Valid Values: mysql // // This member is required. SourceEngine *string - // The version of the database that the backup files were created from. MySQL - // versions 5.7 and 8.0 are supported. Example: 5.7.40 , 8.0.28 + // The version of the database that the backup files were created from. + // + // MySQL versions 5.7 and 8.0 are supported. + // + // Example: 5.7.40 , 8.0.28 // // This member is required. SourceEngineVersion *string @@ -95,14 +117,25 @@ type RestoreDBClusterFromS3Input struct { 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. - // Default: 0 Constraints: + // 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). 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: + // retained. You must specify a minimum value of 1. + // + // Default: 1 + // + // Constraints: + // // - Must be a value from 1 to 35 BackupRetentionPeriod *int32 @@ -116,13 +149,18 @@ type RestoreDBClusterFromS3Input struct { // The name of the DB cluster parameter group to associate with the restored DB // cluster. If this argument is omitted, the default parameter group for the engine - // version is used. Constraints: + // version is used. + // + // Constraints: + // // - 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 - // supplied, must match the name of an existing DBSubnetGroup. Example: - // mydbsubnetgroup + // A DB subnet group to associate with the restored DB cluster. + // + // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // + // Example: mydbsubnetgroup DBSubnetGroupName *string // The database name for the restored DB cluster. @@ -134,10 +172,13 @@ type RestoreDBClusterFromS3Input struct { DeletionProtection *bool // 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) - // in the Amazon Aurora User Guide. + // 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]in + // the Amazon Aurora User Guide. + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // Specify the name of the IAM role to be used when making API calls to the @@ -145,105 +186,161 @@ type RestoreDBClusterFromS3Input struct { DomainIAMRoleName *string // 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 - // 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) - // in the Amazon Aurora User Guide. + // 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 exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon Aurora User Guide. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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. + // enabled. + // + // For more information, see [IAM Database Authentication] in the Amazon Aurora User Guide. + // + // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool - // The version number of the database engine to use. To list all of the available - // engine versions for aurora-mysql (Aurora MySQL), use the following command: aws - // rds describe-db-engine-versions --engine aurora-mysql --query - // "DBEngineVersions[].EngineVersion" Aurora MySQL Examples: - // 5.7.mysql_aurora.2.12.0 , 8.0.mysql_aurora.3.04.0 + // The version number of the database engine to use. + // + // To list all of the available engine versions for aurora-mysql (Aurora MySQL), + // use the following command: + // + // aws rds describe-db-engine-versions --engine aurora-mysql --query + // "DBEngineVersions[].EngineVersion" + // + // Aurora MySQL + // + // Examples: 5.7.mysql_aurora.2.12.0 , 8.0.mysql_aurora.3.04.0 EngineVersion *string - // The Amazon Web Services KMS key identifier for 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. If the StorageEncrypted parameter is - // enabled, and you do not specify a value for the KmsKeyId parameter, 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. + // The Amazon Web Services KMS key identifier for 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. + // + // If the StorageEncrypted parameter is enabled, and you do not specify a value + // for the KmsKeyId parameter, 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. KmsKeyId *string // Specifies 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) - // 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) - // in the Amazon Aurora User Guide. Constraints: + // Secrets Manager. + // + // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon + // Aurora User Guide. + // + // Constraints: + // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool // The password for the master database user. This password can contain any - // printable ASCII character except "/", """, or "@". Constraints: + // printable ASCII character except "/", """, or "@". + // + // Constraints: + // // - 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 - // automatically generated and managed in Amazon Web Services Secrets Manager. 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 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 - // 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. - // 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. + // automatically generated and managed in Amazon Web Services Secrets Manager. + // + // 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 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 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. + // + // 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 network type of the DB cluster. Valid Values: + // 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) - // in the Amazon Aurora User Guide. + // IPv6 protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon Aurora User Guide. + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // A value that indicates that the restored DB cluster should be associated with - // the specified option group. Permanent options can't be removed from an option - // group. An option group can't be removed from a DB cluster once it is associated - // with a DB cluster. + // the specified option group. + // + // Permanent options can't be removed from an option group. An option group can't + // be removed from a DB cluster once it is associated with a DB cluster. OptionGroupName *string // The port number on which the instances in the restored DB cluster accept - // connections. Default: 3306 + // connections. + // + // Default: 3306 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) - // in the Amazon Aurora User Guide. Constraints: + // 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]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. + // + // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow 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) - // in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // 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]in the Amazon Aurora User Guide. + // + // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // // Constraints: Minimum 30-minute window. + // + // [Adjusting the Preferred Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora PreferredMaintenanceWindow *string // The prefix for all of the file names that contain the data used to create the @@ -252,20 +349,28 @@ type RestoreDBClusterFromS3Input struct { // bucket. 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) - // in the Amazon Aurora User Guide. + // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + // + // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration // Specifies whether the restored DB cluster is encrypted. StorageEncrypted *bool - // Specifies the storage type to be associated with the DB cluster. Valid Values: - // aurora , aurora-iopt1 Default: aurora Valid for: Aurora DB clusters only + // Specifies the storage type to be associated with the DB cluster. + // + // Valid Values: aurora , aurora-iopt1 + // + // Default: aurora + // + // Valid for: Aurora 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // A list of EC2 VPC security groups to associate with the restored DB cluster. @@ -276,20 +381,27 @@ type RestoreDBClusterFromS3Input struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RestoreDBClusterFromSnapshot.go b/service/rds/api_op_RestoreDBClusterFromSnapshot.go index 4b6c56cdc20..bc86a545e9b 100644 --- a/service/rds/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/rds/api_op_RestoreDBClusterFromSnapshot.go @@ -11,19 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target -// DB cluster is created from the source snapshot with a default configuration. If -// you don't specify a security group, the new DB cluster is associated with the -// default security group. This operation only restores the DB cluster, not the DB -// instances for that DB cluster. You must invoke the CreateDBInstance operation -// 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 operation 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) -// in the Amazon RDS User Guide. +// Creates a new DB cluster from a DB snapshot or DB cluster snapshot. +// +// The target DB cluster is created from the source snapshot with a default +// configuration. If you don't specify a security group, the new DB cluster is +// associated with the default security group. +// +// This operation only restores the DB cluster, not the DB instances for that DB +// cluster. You must invoke the CreateDBInstance operation 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 operation has completed and the DB cluster is +// available. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User +// Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error) { if params == nil { params = &RestoreDBClusterFromSnapshotInput{} @@ -42,205 +50,345 @@ func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *Resto 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: + // 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 + // + // Example: my-snapshot-id + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. DBClusterIdentifier *string - // The database engine to use for the new DB cluster. Default: The same as source - // Constraint: Must be compatible with the engine of the source Valid for: Aurora - // DB clusters and Multi-AZ DB clusters + // The database engine to use for the new DB cluster. + // + // Default: The same as source + // + // Constraint: Must be compatible with the engine of the source + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters // // This member is required. Engine *string - // The identifier for the DB snapshot or DB cluster snapshot to restore from. You - // can use either the name or the Amazon Resource Name (ARN) to specify a DB + // The identifier for the DB snapshot or DB cluster snapshot to restore from. + // + // You 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 // // 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 + // 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. - // Default: 0 Constraints: + // 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). + // // Valid for: Aurora DB clusters only BacktrackWindow *int64 // Specifies whether to copy all tags from the restored DB cluster to snapshots of - // the restored DB cluster. The default is not to copy them. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // the restored 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 the 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) - // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only + // 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] + // in the Amazon RDS User Guide. + // + // Valid for: Multi-AZ DB clusters only + // + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html 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 - // specified engine is used. Constraints: + // 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 DBClusterParameterGroupName *string - // The name of the DB subnet group to use for the new DB cluster. Constraints: If - // supplied, must match the name of an existing DB subnet group. Example: - // mydbsubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters + // The name of the DB subnet group to use for the new DB cluster. + // + // Constraints: If supplied, must match the name of an existing DB subnet group. + // + // Example: 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 // Specifies whether to enable deletion protection for the DB cluster. The // database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // deletion protection isn't enabled. + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool // 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) - // in the Amazon RDS User Guide. Valid for: Aurora DB clusters only + // Domain. + // + // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. + // + // Valid for: Aurora DB clusters only + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The name of the IAM role to be used when making API calls to the Directory - // Service. Valid for: Aurora DB clusters only + // Service. + // + // Valid for: Aurora DB clusters only DomainIAMRoleName *string // 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) - // 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) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // 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] in + // the Amazon RDS User Guide. + // + // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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 + // enabled. + // + // For more information, see [IAM Database Authentication] in the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters only + // + // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool - // The DB engine mode of the DB cluster, either provisioned or serverless . 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 or serverless . + // + // For more information, see [CreateDBCluster]. + // + // Valid for: Aurora DB clusters only + // + // [CreateDBCluster]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html EngineMode *string // The version of the database engine to use for the new DB cluster. If you don't // specify an engine version, the default version for the database engine in the - // Amazon Web Services Region is used. To list all of the available engine versions - // for Aurora MySQL, use the following command: aws rds - // describe-db-engine-versions --engine aurora-mysql --query - // "DBEngineVersions[].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 - // "DBEngineVersions[].EngineVersion" To list all of the available engine versions - // for RDS for MySQL, use the following command: aws rds - // describe-db-engine-versions --engine mysql --query - // "DBEngineVersions[].EngineVersion" To list all of the available engine versions - // 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) - // 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) - // 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) - // in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // Amazon Web Services Region is used. + // + // To list all of the available engine versions for Aurora MySQL, use the + // following command: + // + // aws rds describe-db-engine-versions --engine aurora-mysql --query + // "DBEngineVersions[].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 + // "DBEngineVersions[].EngineVersion" + // + // To list all of the available engine versions for RDS for MySQL, use the + // following command: + // + // aws rds describe-db-engine-versions --engine mysql --query + // "DBEngineVersions[].EngineVersion" + // + // To list all of the available engine versions 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] in the Amazon Aurora User Guide. + // + // Aurora PostgreSQL + // + // See [Amazon Aurora PostgreSQL releases and engine versions] in the Amazon Aurora User Guide. + // + // MySQL + // + // See [Amazon RDS for MySQL] in the Amazon RDS User Guide. + // + // PostgreSQL + // + // See [Amazon RDS for PostgreSQL versions and extensions] in the Amazon RDS User Guide. + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // + // [Database engine updates for Amazon Aurora MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html + // [Amazon RDS for PostgreSQL versions and extensions]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts + // [Amazon RDS for MySQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt + // [Amazon Aurora PostgreSQL releases and engine versions]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html 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) - // 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 + // initially allocated for each DB instance in the Multi-AZ DB cluster. + // + // For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage] 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 + // + // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS 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: + // 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: + // 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) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // IPv6 protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters only + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html 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 + // 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 Port *int32 - // Specifies whether the DB cluster is publicly accessible. When the DB cluster is - // publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security group it uses. That - // public access is not permitted if the security group assigned to the DB cluster - // doesn't permit it. When the DB cluster isn't publicly accessible, it is an - // internal DB cluster with a DNS name that resolves to a private IP address. + // Specifies whether the DB cluster is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // group it uses. That public access is not permitted if the security group + // assigned to the DB cluster doesn't permit it. + // + // When the DB cluster isn't publicly accessible, it is an internal DB cluster + // with a DNS name that resolves 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: + // 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 PubliclyAccessible *bool @@ -248,27 +396,39 @@ type RestoreDBClusterFromSnapshotInput struct { RdsCustomClusterConfiguration *types.RdsCustomClusterConfiguration // For DB clusters in serverless DB engine mode, the scaling properties of the DB - // cluster. Valid for: Aurora DB clusters only + // cluster. + // + // 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) - // in the Amazon Aurora User Guide. + // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + // + // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // Specifies the storage type to be associated with the DB cluster. When specified - // for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid - // Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters) - // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // Specifies the storage type to be associated with the DB cluster. + // + // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is + // required. + // + // Valid Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB + // clusters) + // + // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters StorageType *string - // The tags to be assigned to the restored DB cluster. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // The tags to be assigned to the restored DB cluster. + // + // Valid for: Aurora DB 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 @@ -276,20 +436,27 @@ type RestoreDBClusterFromSnapshotInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RestoreDBClusterToPointInTime.go b/service/rds/api_op_RestoreDBClusterToPointInTime.go index 96e16f4beda..4b703e25fb4 100644 --- a/service/rds/api_op_RestoreDBClusterToPointInTime.go +++ b/service/rds/api_op_RestoreDBClusterToPointInTime.go @@ -16,17 +16,23 @@ import ( // point in time before LatestRestorableTime for up to BackupRetentionPeriod days. // The target DB cluster is created from the source DB cluster with the same // configuration as the original DB cluster, except that the new DB cluster is -// created with the default DB security group. For Aurora, this operation only -// restores the DB cluster, not the DB instances for that DB cluster. You must -// invoke the CreateDBInstance operation 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 operation 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) -// in the Amazon RDS User Guide. +// created with the default DB security group. +// +// For Aurora, this operation only restores the DB cluster, not the DB instances +// for that DB cluster. You must invoke the CreateDBInstance operation 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 operation has completed and the DB +// cluster is available. +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User +// Guide. +// +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html +// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *RestoreDBClusterToPointInTimeInput, optFns ...func(*Options)) (*RestoreDBClusterToPointInTimeOutput, error) { if params == nil { params = &RestoreDBClusterToPointInTimeInput{} @@ -44,84 +50,144 @@ func (c *Client) RestoreDBClusterToPointInTime(ctx context.Context, params *Rest type RestoreDBClusterToPointInTimeInput struct { - // The name of the new DB cluster to be created. Constraints: + // 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 // // This member is required. DBClusterIdentifier *string // The target backtrack window, in seconds. To disable backtracking, set this - // value to 0. Default: 0 Constraints: + // 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 // Specifies whether to copy all tags from the restored DB cluster to snapshots of - // the restored DB cluster. The default is not to copy them. Valid for: Aurora DB - // clusters and Multi-AZ DB clusters + // the restored 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 the 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) - // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only + // 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] + // in the Amazon RDS User Guide. + // + // Valid for: Multi-AZ DB clusters only + // + // [DB instance class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBClusterInstanceClass *string // The name of the custom DB cluster parameter group to associate with this DB - // cluster. If the DBClusterParameterGroupName parameter is omitted, the default - // DB cluster parameter group for the specified engine is used. Constraints: + // cluster. + // + // If the DBClusterParameterGroupName parameter 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 DBClusterParameterGroupName *string - // The DB subnet group name to use for the new DB cluster. Constraints: If - // supplied, must match the name of an existing DBSubnetGroup. Example: - // mydbsubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters + // The DB subnet group name to use for the new DB cluster. + // + // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // + // Example: mydbsubnetgroup + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters DBSubnetGroupName *string // Specifies whether to enable deletion protection for the DB cluster. The // database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // deletion protection isn't enabled. + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool // 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) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // 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]in + // the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters only + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html Domain *string // The name of the IAM role to be used when making API calls to the Directory - // Service. Valid for: Aurora DB clusters only + // Service. + // + // Valid for: Aurora DB clusters only DomainIAMRoleName *string // 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) - // 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) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // 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] in + // the Amazon RDS User Guide. + // + // For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in + // the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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 + // enabled. + // + // For more information, see [IAM Database Authentication] in the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters only + // + // [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool // The engine mode of the new cluster. Specify provisioned or serverless , @@ -129,137 +195,212 @@ type RestoreDBClusterToPointInTimeInput struct { // 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 + // 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) - // 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 + // initially allocated for each DB instance in the Multi-AZ DB cluster. + // + // For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage] 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 + // + // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS 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 - // 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: + // 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 + // 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: + // 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) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // IPv6 protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon Aurora User Guide. + // + // Valid for: Aurora DB clusters only + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string - // The name of the option group for the new DB cluster. DB clusters are associated - // with a default option group that can't be modified. + // The name of the option group for the new 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: A - // value from 1150-65535 . Default: The default port for the engine. Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // 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: Aurora DB clusters and Multi-AZ DB clusters Port *int32 - // Specifies whether the DB cluster is publicly accessible. When the DB cluster is - // publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security group it uses. That - // public access is not permitted if the security group assigned to the DB cluster - // doesn't permit it. When the DB cluster isn't publicly accessible, it is an - // internal DB cluster with a DNS name that resolves to a private IP address. + // Specifies whether the DB cluster is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // group it uses. That public access is not permitted if the security group + // assigned to the DB cluster doesn't permit it. + // + // When the DB cluster isn't publicly accessible, it is an internal DB cluster + // with a DNS name that resolves 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: + // 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 PubliclyAccessible *bool // Reserved for future use. RdsCustomClusterConfiguration *types.RdsCustomClusterConfiguration - // The date and time to restore the DB cluster to. Valid Values: Value must be a - // time in Universal Coordinated Time (UTC) format Constraints: + // 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 + // + // 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. + // // 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 + // 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 - // cluster. Valid for: Aurora DB clusters only + // cluster. + // + // 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) - // in the Amazon Aurora User Guide. + // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + // + // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // The identifier of the source DB cluster from which to restore. Constraints: + // 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 SourceDBClusterIdentifier *string // The resource ID of the source DB cluster from which to restore. SourceDbClusterResourceId *string - // Specifies the storage type to be associated with the DB cluster. When specified - // for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid - // Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters) - // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // Specifies the storage type to be associated with the DB cluster. + // + // When specified for a Multi-AZ DB cluster, a value for the Iops parameter is + // required. + // + // Valid Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB + // clusters) + // + // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) + // + // Valid for: Aurora DB clusters and 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // Specifies whether to restore the DB cluster to the latest restorable backup // time. By default, the DB cluster isn't restored to the latest restorable backup - // time. Constraints: Can't be specified if RestoreToTime parameter is provided. + // time. + // + // Constraints: Can't be specified if RestoreToTime parameter is provided. + // // Valid for: Aurora DB clusters and Multi-AZ DB clusters UseLatestRestorableTime *bool - // A list of VPC security groups that the new DB cluster belongs to. Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // A list of VPC security groups that the new DB cluster belongs to. + // + // Valid for: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -267,20 +408,27 @@ type RestoreDBClusterToPointInTimeInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go b/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go index 2411da2e2b9..606b2764c02 100644 --- a/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go +++ b/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go @@ -17,17 +17,22 @@ import ( // default, the new DB instance is created as a Single-AZ deployment, except when // the instance is a SQL Server instance that has an option group associated with // mirroring. In this case, the instance becomes a Multi-AZ deployment, not a -// Single-AZ deployment. If you want to replace your original DB instance with the -// new, restored DB instance, then rename your original DB instance before you call -// the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB -// instances with the same name. After you have renamed your original DB instance -// with a different identifier, then you can pass the original name of the DB -// instance as the DBInstanceIdentifier in the call to the -// RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the -// original DB instance with the DB 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 . +// Single-AZ deployment. +// +// If you want to replace your original DB instance with the new, restored DB +// instance, then rename your original DB instance before you call the +// RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances +// with the same name. After you have renamed your original DB instance with a +// different identifier, then you can pass the original name of the DB instance as +// the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot +// operation. The result is that you replace the original DB instance with the DB +// 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 . func (c *Client) RestoreDBInstanceFromDBSnapshot(ctx context.Context, params *RestoreDBInstanceFromDBSnapshotInput, optFns ...func(*Options)) (*RestoreDBInstanceFromDBSnapshotOutput, error) { if params == nil { params = &RestoreDBInstanceFromDBSnapshotInput{} @@ -46,114 +51,174 @@ func (c *Client) RestoreDBInstanceFromDBSnapshot(ctx context.Context, params *Re type RestoreDBInstanceFromDBSnapshotInput struct { // The name of the DB instance to create from the DB snapshot. This parameter - // isn't case-sensitive. Constraints: + // 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. + // // Example: my-snapshot-id // // This member is required. DBInstanceIdentifier *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 - // enough storage for your new DB instance so that the restore operation can - // succeed. You can also allocate additional storage for future growth. + // 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 // Specifies whether to automatically apply minor version upgrades to the DB - // instance during the maintenance window. If you restore an RDS Custom DB - // instance, you must disable this parameter. + // instance during the maintenance window. + // + // If you restore an RDS Custom DB instance, you must disable this parameter. AutoMinorVersionUpgrade *bool - // The Availability Zone (AZ) where the DB instance will be created. Default: A - // random, system-chosen Availability Zone. Constraint: You can't specify the - // AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: - // us-east-1a + // The Availability Zone (AZ) where the DB instance will be created. + // + // Default: A random, system-chosen Availability Zone. + // + // Constraint: You can't specify the AvailabilityZone parameter if the DB instance + // is a Multi-AZ deployment. + // + // Example: us-east-1a AvailabilityZone *string // 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. + // 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] in the Amazon RDS User Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html BackupTarget *string // The CA certificate identifier to use for the DB instance's server certificate. - // This setting doesn't apply to RDS Custom DB instances. 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. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // Specifies 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) - // in the Amazon RDS User Guide. + // 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] in the Amazon RDS User Guide. + // + // [Copying tags to DB instance snapshots]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.CopyTags 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 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. + // + // For the list of permissions required for the IAM role, see [Configure IAM and your VPC] in the Amazon RDS + // User Guide. + // + // This setting is required for RDS Custom. + // + // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *string - // The identifier for the 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) - // in the Amazon RDS User Guide. Constraints: + // The identifier for the Multi-AZ DB cluster snapshot to restore from. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] 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. + // + // [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html 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) - // in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original - // DB instance. + // classes, and availability for your engine, see [DB Instance Class]in the Amazon RDS User Guide. + // + // Default: The same DBInstanceClass as the original DB instance. + // + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string - // The name of the database for the restored DB instance. This parameter only - // applies to RDS for Oracle and RDS for SQL Server DB instances. It doesn't apply - // to the other engines or to RDS Custom DB instances. + // The name of the database for the restored DB instance. + // + // This parameter only applies to RDS for Oracle and RDS for SQL Server DB + // instances. It doesn't apply to the other engines or to RDS Custom DB instances. 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 - // DBParameterGroup for the specified DB engine. This setting doesn't apply to RDS - // Custom. Constraints: + // 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 DBParameterGroup for the specified DB engine. + // + // This setting doesn't apply to RDS Custom. + // + // Constraints: + // // - If supplied, must match the name of an existing DB 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. DBParameterGroupName *string - // The identifier for the DB snapshot to restore from. Constraints: + // The identifier for the DB snapshot to restore from. + // + // Constraints: + // // - Must match the identifier of an existing DB snapshot. + // // - 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 name of the DB subnet group to use for the new instance. Constraints: + // The name of the DB subnet group to use for the new instance. + // + // Constraints: + // // - If supplied, must match the name of an existing DB subnet group. + // // Example: mydbsubnetgroup DBSubnetGroupName *string @@ -162,91 +227,145 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Specifies whether to enable deletion protection for the DB instance. 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]. + // + // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // 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 Db2, // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + // Directory Domain. + // + // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom. + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user - // joining the domain. Constraints: + // joining the domain. + // + // Constraints: + // // - Can't be longer than 64 characters. + // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain - // controllers. Constraints: + // controllers. + // + // Constraints: + // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. + // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. + // // Constraints: + // // - Can't be longer than 64 characters. + // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string // The name of the IAM role to use when making API calls to the Directory Service. + // // This setting doesn't apply to RDS Custom DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. + // // Constraints: + // // - Must be in the distinguished name format. + // // - Can't be longer than 64 characters. + // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // The list of logs for the restored DB instance to export 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + // values in the list depend on the DB engine. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs]in the + // Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on - // Outposts DB instance. A CoIP provides local or external connectivity to - // resources in your Outpost subnets through your on-premises network. For some 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) - // in the Amazon Web Services Outposts User Guide. + // Outposts DB instance. + // + // A CoIP provides local or external connectivity to resources in your Outpost + // subnets through your on-premises network. For some 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] in the Amazon RDS User Guide. + // + // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User + // Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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. + // + // For more information about IAM database authentication, see [IAM Database Authentication for MySQL and PostgreSQL] in the Amazon RDS + // User Guide. + // + // This setting doesn't apply to RDS Custom. + // + // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html 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. For example, you can restore a MariaDB 10.1 DB instance - // from a MySQL 5.6 snapshot. Valid Values: + // 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. For example, you + // can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. + // + // Valid Values: + // // - db2-ae + // // - db2-se + // // - mariadb + // // - mysql + // // - oracle-ee + // // - oracle-ee-cdb + // // - oracle-se2 + // // - oracle-se2-cdb + // // - postgres + // // - sqlserver-ee + // // - sqlserver-se + // // - sqlserver-ex + // // - sqlserver-web Engine *string @@ -254,86 +373,127 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // operations per second. If this parameter isn't specified, the IOPS value is // taken from the backup. If this parameter is set to 0, the new instance is // 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) - // in the Amazon RDS User Guide. Constraints: Must be an integer greater than 1000. + // 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]in the Amazon RDS User Guide. + // + // Constraints: Must be an integer greater than 1000. + // + // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 - // License model information for the restored DB instance. This setting doesn't - // apply to RDS Custom. Default: Same as source. Valid Values: license-included | - // bring-your-own-license | general-public-license + // License model information for the restored DB instance. + // + // This setting doesn't apply to RDS Custom. + // + // Default: Same as source. + // + // Valid Values: license-included | bring-your-own-license | general-public-license LicenseModel *string - // Specifies whether the DB instance is a Multi-AZ deployment. This setting - // doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone - // parameter if the DB instance is a Multi-AZ deployment. + // Specifies whether the DB instance is a Multi-AZ deployment. + // + // This setting doesn't apply to RDS Custom. + // + // Constraint: You can't specify the AvailabilityZone parameter if the DB instance + // is a Multi-AZ deployment. MultiAZ *bool - // The network type of the DB instance. Valid Values: + // 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. + // the IPv6 protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon RDS User Guide. + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string - // The name of the option group to be used for the restored DB instance. Permanent - // options, such as the TDE option for Oracle Advanced Security TDE, can't be - // removed from an option group, and that option group can't be removed from a DB - // instance after it is associated with a DB instance. This setting doesn't apply - // to RDS Custom. + // The name of the option group to be used for the restored DB instance. + // + // Permanent options, such as the TDE option for Oracle Advanced Security TDE, + // can't be removed from an option group, and that option group can't be removed + // from a DB instance after it is associated with a DB instance. + // + // This setting doesn't apply to RDS Custom. OptionGroupName *string - // The port number on which the database accepts connections. Default: The same - // port as the original DB instance Constraints: Value must be 1150-65535 + // The port number on which the database accepts connections. + // + // Default: The same port as the original DB instance + // + // Constraints: Value must be 1150-65535 Port *int32 // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. This setting doesn't apply to RDS Custom. + // class of the DB instance. + // + // This setting doesn't apply to RDS Custom. ProcessorFeatures []types.ProcessorFeature - // Specifies whether the DB instance is publicly accessible. 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 . + // Specifies whether the DB instance is publicly accessible. + // + // 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. 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 | io2 | standard If you specify io1 , io2 , 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 DB instance. + // + // Valid Values: gp2 | gp3 | io1 | io2 | standard + // + // If you specify io1 , io2 , 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html 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. + // 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 // Specifies whether the DB instance class of the DB instance uses its default - // processor features. This setting doesn't apply to RDS Custom. + // 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: - // The default EC2 VPC security group for the DB subnet group's VPC. + // A list of EC2 VPC security groups to associate with this DB instance. + // + // Default: The default EC2 VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -341,9 +501,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_RestoreDBInstanceFromS3.go b/service/rds/api_op_RestoreDBInstanceFromS3.go index 11c94e67dbc..0ad8159b674 100644 --- a/service/rds/api_op_RestoreDBInstanceFromS3.go +++ b/service/rds/api_op_RestoreDBInstanceFromS3.go @@ -15,8 +15,11 @@ 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) -// in the Amazon RDS User Guide. This operation doesn't apply to RDS Custom. +// more information, see [Importing Data into an Amazon RDS MySQL DB Instance]in the Amazon RDS User Guide. +// +// This operation doesn't apply to RDS Custom. +// +// [Importing Data into an Amazon RDS MySQL DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html func (c *Client) RestoreDBInstanceFromS3(ctx context.Context, params *RestoreDBInstanceFromS3Input, optFns ...func(*Options)) (*RestoreDBInstanceFromS3Output, error) { if params == nil { params = &RestoreDBInstanceFromS3Input{} @@ -37,25 +40,33 @@ 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) - // in the Amazon RDS User Guide. Importing from Amazon S3 isn't supported on the - // db.t2.micro DB instance class. + // availability for your engine, see [DB Instance Class]in the Amazon RDS User Guide. + // + // Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class. + // + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html // // This member is required. DBInstanceClass *string // 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. + // // Example: mydbinstance // // This member is required. DBInstanceIdentifier *string - // The name of the database engine to be used for this instance. Valid Values: - // mysql + // The name of the database engine to be used for this instance. + // + // Valid Values: mysql // // This member is required. Engine *string @@ -71,21 +82,28 @@ type RestoreDBInstanceFromS3Input struct { // This member is required. S3IngestionRoleArn *string - // The name of the engine of your source database. Valid Values: mysql + // The name of the engine of your source database. + // + // Valid Values: mysql // // This member is required. SourceEngine *string - // The version of the database that the backup files were created from. MySQL - // versions 5.6 and 5.7 are supported. Example: 5.6.40 + // The version of the database that the backup files were created from. + // + // MySQL versions 5.6 and 5.7 are supported. + // + // Example: 5.6.40 // // This member is required. 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 - // enough storage for your new DB instance so that the restore operation can - // succeed. You can also allocate additional storage for future growth. + // 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 // Specifies whether to automatically apply minor engine upgrades to the DB @@ -94,13 +112,19 @@ 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) - // 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 - // Multi-AZ deployment. The specified Availability Zone must be in the same Amazon - // Web Services Region as the current endpoint. + // Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones]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 Multi-AZ deployment. The specified Availability Zone must be in + // the same Amazon Web Services Region as the current endpoint. + // + // [Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZone *string // The number of days for which automated backups are retained. Setting this @@ -109,11 +133,14 @@ type RestoreDBInstanceFromS3Input struct { BackupRetentionPeriod *int32 // The CA certificate identifier to use for the DB instance's server certificate. - // This setting doesn't apply to RDS Custom DB instances. 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. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // Specifies whether to copy all tags from the DB instance to snapshots of the DB @@ -124,17 +151,22 @@ type RestoreDBInstanceFromS3Input struct { // 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 + // 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 - // default DB security group for the database engine. + // A list of DB security groups to associate with this DB instance. + // + // Default: The default DB security group for the database engine. DBSecurityGroups []string - // A DB subnet group to associate with this DB instance. Constraints: If supplied, - // must match the name of an existing DBSubnetGroup. Example: mydbsubnetgroup + // A DB subnet group to associate with this DB instance. + // + // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // + // Example: mydbsubnetgroup DBSubnetGroupName *string // Specifies whether to enable a dedicated log volume (DLV) for the DB instance. @@ -142,27 +174,33 @@ type RestoreDBInstanceFromS3Input struct { // Specifies whether to enable deletion protection for the DB instance. 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]. + // + // [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) - // in the Amazon RDS User Guide. + // see [Publishing Database Logs to Amazon CloudWatch Logs]in the Amazon RDS User Guide. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies 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. + // enabled. + // + // For more information about IAM database authentication, see [IAM Database Authentication for MySQL and PostgreSQL] in the Amazon RDS + // User Guide. + // + // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool - // Specifies 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) - // in the Amazon RDS User Guide. + // Specifies whether to enable Performance Insights for the DB instance. + // + // For more information, see [Using Amazon Performance Insights] in the Amazon RDS User Guide. + // + // [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html EnablePerformanceInsights *bool // The version number of the database engine to use. Choose the latest minor @@ -171,101 +209,148 @@ type RestoreDBInstanceFromS3Input struct { 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) - // in the Amazon RDS User Guide. + // initially for the DB instance. For information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage]in + // the Amazon RDS User Guide. + // + // [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS Iops *int32 - // The Amazon Web Services KMS key identifier for an encrypted 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 the StorageEncrypted parameter is - // enabled, and you do not specify a value for the KmsKeyId parameter, 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. + // The Amazon Web Services KMS key identifier for an encrypted 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 the StorageEncrypted parameter is enabled, and you do not specify a value + // for the KmsKeyId parameter, 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. KmsKeyId *string // The license model for this DB instance. Use general-public-license . LicenseModel *string // Specifies 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) - // in the Amazon RDS User Guide. Constraints: + // Secrets Manager. + // + // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. + // + // Constraints: + // // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ManageMasterUserPassword *bool - // The password for the master user. Constraints: + // The password for the master user. + // + // Constraints: + // // - Can't be specified if ManageMasterUserPassword is turned on. + // // - Can include any printable ASCII character except "/", """, or "@". For RDS // for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) // character. + // // Length Constraints: + // // - RDS for Db2 - Must contain from 8 to 128 characters. + // // - RDS for MariaDB - Must contain from 8 to 41 characters. + // // - RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. + // // - RDS for MySQL - Must contain from 8 to 41 characters. + // // - RDS for Oracle - Must contain from 8 to 30 characters. + // // - RDS for PostgreSQL - Must contain from 8 to 128 characters. 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 the master user password is managed by RDS in Amazon - // 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 - // 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. - // 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. + // automatically generated and managed in Amazon Web Services Secrets Manager. + // + // This setting is valid only if the master user password is managed by RDS in + // Amazon 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 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. + // + // 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 name for the master user. Constraints: + // 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. 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) - // in the Amazon RDS User Guide. + // 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]in the Amazon RDS User Guide. + // + // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling 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. If MonitoringRoleArn is specified, then you must also set - // MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, - // 60 Default: 0 + // metrics, specify 0. + // + // If MonitoringRoleArn is specified, then you must also set MonitoringInterval to + // a value other than 0. + // + // Valid Values: 0, 1, 5, 10, 15, 30, 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. + // For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring]in the Amazon RDS User + // Guide. + // + // If MonitoringInterval is set to a value other than 0, then you must supply a + // MonitoringRoleArn value. + // + // [Setting Up and Enabling Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling MonitoringRoleArn *string // Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance // is a Multi-AZ deployment, you can't set the AvailabilityZone parameter. MultiAZ *bool - // The network type of the DB instance. Valid Values: + // 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. + // the IPv6 protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon RDS User Guide. + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The name of the option group to associate with this DB instance. If this @@ -273,65 +358,101 @@ type RestoreDBInstanceFromS3Input struct { OptionGroupName *string // 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. + // 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 *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 + // // 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. PerformanceInsightsRetentionPeriod *int32 - // The port number on which the database accepts connections. Type: Integer Valid - // Values: 1150 - 65535 Default: 3306 + // The port number on which the database accepts connections. + // + // Type: Integer + // + // Valid 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) - // in the Amazon RDS User Guide. Constraints: + // backups are enabled. For more information, see [Backup window]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. + // + // [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow 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) - // in the Amazon RDS User Guide. Constraints: + // Universal Coordinated Time (UTC). For more information, see [Amazon RDS Maintenance Window]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. + // + // [Amazon RDS Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance PreferredMaintenanceWindow *string // The number of CPU cores and the number of threads per core for the DB instance // class of the DB instance. ProcessorFeatures []types.ProcessorFeature - // Specifies whether the DB instance is publicly accessible. 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 . + // Specifies whether the DB instance is publicly accessible. + // + // 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. PubliclyAccessible *bool // The prefix of your Amazon S3 bucket. @@ -340,19 +461,25 @@ type RestoreDBInstanceFromS3Input struct { // Specifies 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 | io2 | standard If you specify io1 , io2 , 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 DB instance. + // + // Valid Values: gp2 | gp3 | io1 | io2 | standard + // + // If you specify io1 , io2 , 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) + // A list of tags to associate with this DB instance. For more information, see [Tagging Amazon RDS Resources] // in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []types.Tag // Specifies whether the DB instance class of the DB instance uses its default @@ -367,9 +494,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_RestoreDBInstanceToPointInTime.go b/service/rds/api_op_RestoreDBInstanceToPointInTime.go index 9a62dc47d9a..b5c843abff2 100644 --- a/service/rds/api_op_RestoreDBInstanceToPointInTime.go +++ b/service/rds/api_op_RestoreDBInstanceToPointInTime.go @@ -15,15 +15,18 @@ import ( // Restores a DB instance to an arbitrary point in time. You can restore to any // point in time before the time identified by the LatestRestorableTime property. // You can restore to a point up to the number of days specified by the -// BackupRetentionPeriod property. The target database is created with most of the -// original configuration, but in a system-selected Availability Zone, with the -// default security group, the default subnet group, and the default DB parameter -// group. By default, the new DB instance is created as a single-AZ deployment -// 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 operation doesn't apply to -// Aurora MySQL and Aurora PostgreSQL. For Aurora, use -// RestoreDBClusterToPointInTime . +// BackupRetentionPeriod property. +// +// The target database is created with most of the original configuration, but in +// a system-selected Availability Zone, with the default security group, the +// default subnet group, and the default DB parameter group. By default, the new DB +// instance is created as a single-AZ deployment 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 operation doesn't apply to Aurora 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,47 +44,70 @@ func (c *Client) RestoreDBInstanceToPointInTime(ctx context.Context, params *Res type RestoreDBInstanceToPointInTimeInput struct { - // The name of the new DB instance to create. Constraints: + // The name of the new DB instance to create. + // + // 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. // // 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 - // enough storage for your new DB instance so that the restore operation can - // succeed. You can also allocate additional storage for future growth. + // 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 // Specifies whether minor version upgrades are applied automatically to the DB - // instance during the maintenance window. This setting doesn't apply to RDS - // Custom. + // instance during the maintenance window. + // + // This setting doesn't apply to RDS Custom. AutoMinorVersionUpgrade *bool - // The Availability Zone (AZ) where the DB instance will be created. Default: A - // random, system-chosen Availability Zone. Constraints: + // The Availability Zone (AZ) where the DB instance will be created. + // + // Default: A random, system-chosen Availability Zone. + // + // Constraints: + // // - You can't specify the AvailabilityZone parameter if the DB instance is a // Multi-AZ deployment. + // // Example: us-east-1a AvailabilityZone *string // The location for storing automated backups and manual snapshots for the - // restored DB instance. Valid Values: + // restored DB instance. + // + // Valid Values: + // // - outposts (Amazon Web Services Outposts) + // // - region (Amazon Web Services Region) - // Default: 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. + // + // Default: region + // + // For more information, see [Working with Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html BackupTarget *string // The CA certificate identifier to use for the DB instance's server certificate. - // This setting doesn't apply to RDS Custom DB instances. 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. + // + // This setting doesn't apply to RDS Custom DB instances. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // Specifies whether to copy all tags from the restored DB instance to snapshots @@ -91,44 +117,69 @@ type RestoreDBInstanceToPointInTimeInput 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 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. + // + // For the list of permissions required for the IAM role, see [Configure IAM and your VPC] in the Amazon RDS + // User Guide. + // + // This setting is required for RDS Custom. + // + // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc 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) - // in the Amazon RDS User Guide. Default: The same DB instance class as the - // original DB instance. + // classes, and availability for your engine, see [DB Instance Class]in the Amazon RDS User Guide. + // + // Default: The same DB instance class as the original DB instance. + // + // [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html DBInstanceClass *string - // The database name for the restored DB instance. This parameter doesn't apply to - // the following DB instances: + // The database name for the restored DB instance. + // + // This parameter doesn't apply to the following DB instances: + // // - RDS Custom + // // - RDS for Db2 + // // - RDS for MariaDB + // // - RDS for MySQL 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: + // 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 DB 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. DBParameterGroupName *string - // The DB subnet group name to use for the new instance. Constraints: + // The DB subnet group name to use for the new instance. + // + // Constraints: + // // - If supplied, must match the name of an existing DB subnet group. + // // Example: mydbsubnetgroup DBSubnetGroupName *string @@ -137,210 +188,326 @@ type RestoreDBInstanceToPointInTimeInput struct { // Specifies 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) - // . + // protection isn't enabled. For more information, see [Deleting a DB Instance]. + // + // [Deleting a DB Instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html DeletionProtection *bool // 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) - // in the Amazon RDS User Guide. + // Domain. + // + // This setting doesn't apply to RDS Custom. + // + // For more information, see [Kerberos Authentication] in the Amazon RDS User Guide. + // + // [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html Domain *string // The ARN for the Secrets Manager secret with the credentials for the user - // joining the domain. Constraints: + // joining the domain. + // + // Constraints: + // // - Can't be longer than 64 characters. + // // Example: // arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456 DomainAuthSecretArn *string // The IPv4 DNS IP addresses of your primary and secondary Active Directory domain - // controllers. Constraints: + // controllers. + // + // Constraints: + // // - Two IP addresses must be provided. If there isn't a secondary domain // controller, use the IP address of the primary domain controller for both entries // in the list. + // // Example: 123.124.125.126,234.235.236.237 DomainDnsIps []string // The fully qualified domain name (FQDN) of an Active Directory domain. + // // Constraints: + // // - Can't be longer than 64 characters. + // // Example: mymanagedADtest.mymanagedAD.mydomain DomainFqdn *string // The name of the IAM role to use when making API calls to the Directory Service. + // // This setting doesn't apply to RDS Custom DB instances. DomainIAMRoleName *string // The Active Directory organizational unit for your DB instance to join. + // // Constraints: + // // - Must be in the distinguished name format. + // // - Can't be longer than 64 characters. + // // Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain DomainOu *string // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + // see [Publishing Database Logs to Amazon CloudWatch Logs]in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom. + // + // [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch EnableCloudwatchLogsExports []string // Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on - // Outposts DB instance. A CoIP provides local or external connectivity to - // resources in your Outpost subnets through your on-premises network. For some 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) - // in the Amazon Web Services Outposts User Guide. + // Outposts DB instance. + // + // A CoIP provides local or external connectivity to resources in your Outpost + // subnets through your on-premises network. For some 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] in the Amazon RDS User Guide. + // + // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User + // Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing EnableCustomerOwnedIp *bool // Specifies 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. + // enabled. + // + // This setting doesn't apply to RDS Custom. + // + // For more information about IAM database authentication, see [IAM Database Authentication for MySQL and PostgreSQL] in the Amazon RDS + // User Guide. + // + // [IAM Database Authentication for MySQL and PostgreSQL]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html EnableIAMDatabaseAuthentication *bool - // The database engine to use for the new instance. This setting doesn't apply to - // RDS Custom. Valid Values: + // The database engine to use for the new instance. + // + // This setting doesn't apply to RDS Custom. + // + // Valid Values: + // // - db2-ae + // // - db2-se + // // - mariadb + // // - mysql + // // - oracle-ee + // // - oracle-ee-cdb + // // - oracle-se2 + // // - oracle-se2-cdb + // // - postgres + // // - sqlserver-ee + // // - sqlserver-se + // // - sqlserver-ex + // // - sqlserver-web - // Default: The same as source Constraints: + // + // Default: The same as source + // + // Constraints: + // // - Must be compatible with the engine of the source. Engine *string // The amount of Provisioned IOPS (input/output operations per second) to - // initially allocate for the DB instance. This setting doesn't apply to SQL - // Server. Constraints: + // initially allocate for the DB instance. + // + // This setting doesn't apply to SQL Server. + // + // Constraints: + // // - Must be an integer greater than 1000. Iops *int32 - // The license model information for the restored DB instance. This setting - // doesn't apply to RDS Custom. Valid Values: license-included | - // bring-your-own-license | general-public-license Default: Same as the source. + // The license model information for the restored DB instance. + // + // This setting doesn't apply to RDS Custom. + // + // Valid Values: license-included | bring-your-own-license | general-public-license + // + // Default: Same as the source. LicenseModel *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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + // 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]in the Amazon RDS User Guide. + // + // This setting doesn't apply to RDS Custom. + // + // [Managing capacity automatically with Amazon RDS storage autoscaling]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling MaxAllocatedStorage *int32 - // Secifies whether the DB instance is a Multi-AZ deployment. This setting doesn't - // apply to RDS Custom. Constraints: + // Secifies whether the DB instance is a Multi-AZ deployment. + // + // This setting doesn't apply to RDS Custom. + // + // Constraints: + // // - You can't specify the AvailabilityZone parameter if the DB instance is a // Multi-AZ deployment. MultiAZ *bool - // The network type of the DB instance. 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. Valid Values: + // The network type of the DB instance. + // + // 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] in the Amazon RDS User Guide. + // + // Valid Values: + // // - IPV4 + // // - DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string - // The name of the option group to use for the restored DB instance. Permanent - // options, such as the TDE option for Oracle Advanced Security TDE, can't be - // removed from an option group, and that option group can't be removed from a DB - // instance after it is associated with a DB instance This setting doesn't apply to - // RDS Custom. + // The name of the option group to use for the restored DB instance. + // + // Permanent options, such as the TDE option for Oracle Advanced Security TDE, + // can't be removed from an option group, and that option group can't be removed + // from a DB instance after it is associated with a DB instance + // + // This setting doesn't apply to RDS Custom. OptionGroupName *string - // The port number on which the database accepts connections. Default: The same - // port as the original DB instance. Constraints: + // The port number on which the database accepts connections. + // + // Default: The same port as the original DB instance. + // + // Constraints: + // // - The value must be 1150-65535 . Port *int32 // The number of CPU cores and the number of threads per core for the DB instance - // class of the DB instance. This setting doesn't apply to RDS Custom. + // class of the DB instance. + // + // This setting doesn't apply to RDS Custom. ProcessorFeatures []types.ProcessorFeature - // Specifies whether the DB instance is publicly accessible. When the DB cluster - // is publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security 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 . + // Specifies whether the DB instance is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // 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. PubliclyAccessible *bool - // The date and time to restore from. Constraints: + // The date and time to restore from. + // + // Constraints: + // // - Must be a time in Universal Coordinated Time (UTC) format. + // // - 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:us-east-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: + // The identifier of the source DB instance from which to restore. + // + // Constraints: + // // - 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 - // The storage throughput value for the DB instance. This setting doesn't apply to - // RDS Custom or Amazon Aurora. + // The storage throughput value for the DB instance. + // + // This setting doesn't apply to RDS Custom or Amazon Aurora. StorageThroughput *int32 - // The storage type to associate with the DB instance. Valid Values: gp2 | gp3 | - // io1 | io2 | standard Default: io1 , if the Iops parameter is specified. - // Otherwise, gp2 . Constraints: + // The storage type to associate with the DB instance. + // + // Valid Values: gp2 | gp3 | io1 | io2 | standard + // + // Default: io1 , if the Iops parameter is specified. Otherwise, gp2 . + // + // Constraints: + // // - If you specify io1 , io2 , or gp3 , you must also include a value for the // Iops parameter. 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html 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. + // 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 // Specifies whether the DB instance class of the DB instance uses its default - // processor features. This setting doesn't apply to RDS Custom. + // processor features. + // + // This setting doesn't apply to RDS Custom. UseDefaultProcessorFeatures *bool // Specifies whether the DB instance is restored from the latest backup time. By // default, the DB instance isn't restored from the latest backup time. + // // Constraints: + // // - Can't be specified if the RestoreTime parameter is provided. UseLatestRestorableTime *bool - // A list of EC2 VPC security groups to associate with this DB instance. Default: - // The default EC2 VPC security group for the DB subnet group's VPC. + // A list of EC2 VPC security groups to associate with this DB instance. + // + // Default: The default EC2 VPC security group for the DB subnet group's VPC. VpcSecurityGroupIds []string noSmithyDocumentSerde @@ -348,9 +515,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_RevokeDBSecurityGroupIngress.go b/service/rds/api_op_RevokeDBSecurityGroupIngress.go index ab090e5578e..a090bc73a3b 100644 --- a/service/rds/api_op_RevokeDBSecurityGroupIngress.go +++ b/service/rds/api_op_RevokeDBSecurityGroupIngress.go @@ -14,14 +14,16 @@ import ( // Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or // EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, // EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either -// 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) -// in the Amazon RDS User Guide. +// 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]in the Amazon EC2 User Guide, the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare], and [Moving a DB instance not in a VPC into a VPC] in the +// Amazon RDS User Guide. +// +// [Migrate from EC2-Classic to a VPC]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html +// [EC2-Classic Networking is Retiring – Here’s How to Prepare]: http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/ +// [Moving a DB instance not in a VPC into a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html func (c *Client) RevokeDBSecurityGroupIngress(ctx context.Context, params *RevokeDBSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeDBSecurityGroupIngressOutput, error) { if params == nil { params = &RevokeDBSecurityGroupIngressInput{} @@ -71,8 +73,10 @@ 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 ae52a399485..50141fcd6a3 100644 --- a/service/rds/api_op_StartActivityStream.go +++ b/service/rds/api_op_StartActivityStream.go @@ -12,10 +12,11 @@ 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) -// in the Amazon RDS User Guide. +// information, see [Monitoring Amazon Aurora with Database Activity Streams]in the Amazon Aurora User Guide or [Monitoring Amazon RDS with Database Activity Streams] in the Amazon RDS User +// Guide. +// +// [Monitoring Amazon Aurora with Database Activity Streams]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html +// [Monitoring Amazon RDS with Database Activity Streams]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html func (c *Client) StartActivityStream(ctx context.Context, params *StartActivityStreamInput, optFns ...func(*Options)) (*StartActivityStreamOutput, error) { if params == nil { params = &StartActivityStreamInput{} diff --git a/service/rds/api_op_StartDBCluster.go b/service/rds/api_op_StartDBCluster.go index 968716bbd60..83bfd71c8b4 100644 --- a/service/rds/api_op_StartDBCluster.go +++ b/service/rds/api_op_StartDBCluster.go @@ -13,9 +13,13 @@ 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 -// operation. 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 operation only applies to Aurora DB -// clusters. +// operation. +// +// For more information, see [Stopping and Starting an Aurora Cluster] in the Amazon Aurora User Guide. +// +// This operation only applies to Aurora DB clusters. +// +// [Stopping and Starting an Aurora Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html func (c *Client) StartDBCluster(ctx context.Context, params *StartDBClusterInput, optFns ...func(*Options)) (*StartDBClusterOutput, error) { if params == nil { params = &StartDBClusterInput{} @@ -44,20 +48,27 @@ type StartDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_StartDBInstance.go b/service/rds/api_op_StartDBInstance.go index f99ed5f341b..33e79bc7df5 100644 --- a/service/rds/api_op_StartDBInstance.go +++ b/service/rds/api_op_StartDBInstance.go @@ -12,12 +12,14 @@ 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 operation. 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) -// 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. +// console, the stop-db-instance CLI command, or the StopDBInstance operation. +// +// For more information, see [Starting an Amazon RDS DB instance That Was Previously Stopped] 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. +// +// [Starting an Amazon RDS DB instance That Was Previously Stopped]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html func (c *Client) StartDBInstance(ctx context.Context, params *StartDBInstanceInput, optFns ...func(*Options)) (*StartDBInstanceOutput, error) { if params == nil { params = &StartDBInstanceInput{} @@ -45,9 +47,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go b/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go index 0f01f31ab53..0b9f5278e25 100644 --- a/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go +++ b/service/rds/api_op_StartDBInstanceAutomatedBackupsReplication.go @@ -12,9 +12,13 @@ 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) -// in the Amazon RDS User Guide. +// Region. +// +// This command doesn't apply to RDS Custom. +// +// For more information, see [Replicating Automated Backups to Another Amazon Web Services Region] in the Amazon RDS User Guide. +// +// [Replicating Automated Backups to Another Amazon Web Services Region]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html func (c *Client) StartDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StartDBInstanceAutomatedBackupsReplicationInput, optFns ...func(*Options)) (*StartDBInstanceAutomatedBackupsReplicationOutput, error) { if params == nil { params = &StartDBInstanceAutomatedBackupsReplicationInput{} @@ -54,15 +58,19 @@ type StartDBInstanceAutomatedBackupsReplicationInput struct { // 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 + // 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)] and [Signature Version 4 Signing Process]. + // + // 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. + // + // [Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html + // [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html PreSignedUrl *string noSmithyDocumentSerde diff --git a/service/rds/api_op_StartExportTask.go b/service/rds/api_op_StartExportTask.go index 024c82dec48..1a40e2cbb07 100644 --- a/service/rds/api_op_StartExportTask.go +++ b/service/rds/api_op_StartExportTask.go @@ -13,14 +13,21 @@ import ( ) // Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided -// IAM role must have access to the S3 bucket. You can't export snapshot data from -// Db2 or 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) -// 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) -// in the Amazon Aurora User Guide. +// IAM role must have access to the S3 bucket. +// +// You can't export snapshot data from Db2 or 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] in the Amazon RDS User +// Guide or [Exporting DB cluster snapshot data to Amazon S3]in the Amazon Aurora User Guide. +// +// For more information on exporting DB cluster data, see [Exporting DB cluster data to Amazon S3] in the Amazon Aurora +// User Guide. +// +// [Exporting DB cluster snapshot data to Amazon S3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html +// [Exporting DB cluster data to Amazon S3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html +// [Exporting DB snapshot data to Amazon S3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html func (c *Client) StartExportTask(ctx context.Context, params *StartExportTaskInput, optFns ...func(*Options)) (*StartExportTaskOutput, error) { if params == nil { params = &StartExportTaskInput{} @@ -45,18 +52,28 @@ type StartExportTaskInput struct { ExportTaskIdentifier *string // The name of the IAM role to use for writing to the Amazon S3 bucket when - // 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: + // 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) // format for accessing S3: + // // - arn:aws:s3:::your-s3-bucket + // // - arn:aws:s3:::your-s3-bucket/* // // This member is required. @@ -67,14 +84,23 @@ type StartExportTaskInput struct { // 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 // // This member is required. @@ -92,10 +118,15 @@ type StartExportTaskInput struct { SourceArn *string // The data to be exported from the snapshot or cluster. If this parameter isn't - // provided, all of the data is exported. Valid Values: + // provided, all of the data is exported. + // + // Valid Values: + // // - 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. // @@ -110,14 +141,21 @@ type StartExportTaskInput struct { noSmithyDocumentSerde } -// Contains the details of a snapshot or cluster export to Amazon S3. This data -// type is used as a response element in the DescribeExportTasks operation. +// Contains the details of a snapshot or cluster export to Amazon S3. +// +// This data type is used as a response element in the DescribeExportTasks +// operation. type StartExportTaskOutput struct { - // The data exported from the snapshot or cluster. Valid Values: + // The data exported from the snapshot or cluster. + // + // Valid Values: + // // - 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. // @@ -161,11 +199,17 @@ type StartExportTaskOutput struct { 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 Status *string diff --git a/service/rds/api_op_StopActivityStream.go b/service/rds/api_op_StopActivityStream.go index a7880393d9f..74299c31fd4 100644 --- a/service/rds/api_op_StopActivityStream.go +++ b/service/rds/api_op_StopActivityStream.go @@ -13,11 +13,13 @@ import ( // Stops a database activity stream that was started using the Amazon Web Services // console, the start-activity-stream CLI command, or the StartActivityStream -// operation. 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. +// operation. +// +// For more information, see [Monitoring Amazon Aurora with Database Activity Streams] in the Amazon Aurora User Guide or [Monitoring Amazon RDS with Database Activity Streams] in the Amazon +// RDS User Guide. +// +// [Monitoring Amazon Aurora with Database Activity Streams]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html +// [Monitoring Amazon RDS with Database Activity Streams]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.html func (c *Client) StopActivityStream(ctx context.Context, params *StopActivityStreamInput, optFns ...func(*Options)) (*StopActivityStreamOutput, error) { if params == nil { params = &StopActivityStreamInput{} @@ -55,8 +57,10 @@ type StopActivityStreamOutput struct { KinesisStreamName *string // The Amazon Web Services KMS key identifier used for encrypting messages in the - // database activity stream. The Amazon Web Services KMS key identifier is the key - // ARN, key ID, alias ARN, or alias name for the KMS key. + // database activity stream. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. KmsKeyId *string // The status of the database activity stream. diff --git a/service/rds/api_op_StopDBCluster.go b/service/rds/api_op_StopDBCluster.go index baa584ee1d0..68edde99db1 100644 --- a/service/rds/api_op_StopDBCluster.go +++ b/service/rds/api_op_StopDBCluster.go @@ -14,9 +14,13 @@ 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) -// in the Amazon Aurora User Guide. This operation only applies to Aurora DB -// clusters. +// if necessary. +// +// For more information, see [Stopping and Starting an Aurora Cluster] in the Amazon Aurora User Guide. +// +// This operation only applies to Aurora DB clusters. +// +// [Stopping and Starting an Aurora Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html func (c *Client) StopDBCluster(ctx context.Context, params *StopDBClusterInput, optFns ...func(*Options)) (*StopDBClusterOutput, error) { if params == nil { params = &StopDBClusterInput{} @@ -45,20 +49,27 @@ type StopDBClusterInput struct { 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 , + // 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 + // 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) - // in the Amazon RDS User Guide. + // RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . + // + // For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora + // User Guide. + // + // For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + // [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html DBCluster *types.DBCluster // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_StopDBInstance.go b/service/rds/api_op_StopDBInstance.go index 9de14bdc527..18fee8a6496 100644 --- a/service/rds/api_op_StopDBInstance.go +++ b/service/rds/api_op_StopDBInstance.go @@ -14,10 +14,14 @@ import ( // 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. +// can do a point-in-time restore if necessary. +// +// For more information, see [Stopping an Amazon RDS DB Instance Temporarily] 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. +// +// [Stopping an Amazon RDS DB Instance Temporarily]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html func (c *Client) StopDBInstance(ctx context.Context, params *StopDBInstanceInput, optFns ...func(*Options)) (*StopDBInstanceOutput, error) { if params == nil { params = &StopDBInstanceInput{} @@ -49,9 +53,10 @@ 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 , + // 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 . diff --git a/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go b/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go index 2ec80c86a3a..a6e6831c41a 100644 --- a/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go +++ b/service/rds/api_op_StopDBInstanceAutomatedBackupsReplication.go @@ -11,10 +11,13 @@ 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) -// in the Amazon RDS User Guide. +// 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] in the Amazon RDS User Guide. +// +// [Replicating Automated Backups to Another Amazon Web Services Region]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html func (c *Client) StopDBInstanceAutomatedBackupsReplication(ctx context.Context, params *StopDBInstanceAutomatedBackupsReplicationInput, optFns ...func(*Options)) (*StopDBInstanceAutomatedBackupsReplicationOutput, error) { if params == nil { params = &StopDBInstanceAutomatedBackupsReplicationInput{} diff --git a/service/rds/api_op_SwitchoverBlueGreenDeployment.go b/service/rds/api_op_SwitchoverBlueGreenDeployment.go index d08ec4f95dc..00a7a1cae21 100644 --- a/service/rds/api_op_SwitchoverBlueGreenDeployment.go +++ b/service/rds/api_op_SwitchoverBlueGreenDeployment.go @@ -11,14 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Switches over a blue/green deployment. Before you switch over, production -// 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) -// in the Amazon Aurora User Guide. +// Switches over a blue/green deployment. +// +// Before you switch over, production 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] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html func (c *Client) SwitchoverBlueGreenDeployment(ctx context.Context, params *SwitchoverBlueGreenDeploymentInput, optFns ...func(*Options)) (*SwitchoverBlueGreenDeploymentOutput, error) { if params == nil { params = &SwitchoverBlueGreenDeploymentInput{} @@ -36,15 +38,21 @@ func (c *Client) SwitchoverBlueGreenDeployment(ctx context.Context, params *Swit type SwitchoverBlueGreenDeploymentInput struct { - // The unique identifier of the blue/green deployment. Constraints: + // The unique identifier of the blue/green deployment. + // + // Constraints: + // // - Must match an existing blue/green deployment identifier. // // This member is required. BlueGreenDeploymentIdentifier *string - // The amount of time, in seconds, for the switchover to complete. Default: 300 If - // the switchover takes longer than the specified duration, then any changes are - // rolled back, and no changes are made to the environments. + // The amount of time, in seconds, for the switchover to complete. + // + // Default: 300 + // + // If the switchover takes longer than the specified duration, then any changes + // are rolled back, and no changes are made to the environments. SwitchoverTimeout *int32 noSmithyDocumentSerde @@ -52,11 +60,12 @@ type SwitchoverBlueGreenDeploymentInput struct { type SwitchoverBlueGreenDeploymentOutput struct { - // 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) - // in the Amazon Aurora User Guide. + // Details about a blue/green deployment. + // + // For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon + // Aurora User Guide. + // + // [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html BlueGreenDeployment *types.BlueGreenDeployment // Metadata pertaining to the operation's result. diff --git a/service/rds/api_op_SwitchoverGlobalCluster.go b/service/rds/api_op_SwitchoverGlobalCluster.go index 6d3ca58e073..7af718be7b7 100644 --- a/service/rds/api_op_SwitchoverGlobalCluster.go +++ b/service/rds/api_op_SwitchoverGlobalCluster.go @@ -13,18 +13,23 @@ import ( // Switches over the specified secondary DB cluster to be the new primary DB // cluster in the global database cluster. Switchover operations were previously -// called "managed planned failovers." Aurora promotes the specified secondary -// cluster to assume full read/write capabilities and demotes the current primary -// cluster to a secondary (read-only) cluster, maintaining the orginal replication -// topology. All secondary clusters are synchronized with the primary at the -// beginning of the process so the new primary continues operations for the Aurora -// global database without losing any data. Your database is unavailable for a -// short time while the primary and selected secondary clusters are assuming their -// new roles. For more information about switching over an Aurora global database, -// see Performing switchovers 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 operation is intended for controlled -// environments, for operations such as "regional rotation" or to fall back to the -// original primary after a global database failover. +// called "managed planned failovers." +// +// Aurora promotes the specified secondary cluster to assume full read/write +// capabilities and demotes the current primary cluster to a secondary (read-only) +// cluster, maintaining the orginal replication topology. All secondary clusters +// are synchronized with the primary at the beginning of the process so the new +// primary continues operations for the Aurora global database without losing any +// data. Your database is unavailable for a short time while the primary and +// selected secondary clusters are assuming their new roles. For more information +// about switching over an Aurora global database, see [Performing switchovers for Amazon Aurora global databases]in the Amazon Aurora User +// Guide. +// +// This operation is intended for controlled environments, for operations such as +// "regional rotation" or to fall back to the original primary after a global +// database failover. +// +// [Performing switchovers 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 func (c *Client) SwitchoverGlobalCluster(ctx context.Context, params *SwitchoverGlobalClusterInput, optFns ...func(*Options)) (*SwitchoverGlobalClusterOutput, error) { if params == nil { params = &SwitchoverGlobalClusterInput{} @@ -43,7 +48,10 @@ func (c *Client) SwitchoverGlobalCluster(ctx context.Context, params *Switchover type SwitchoverGlobalClusterInput struct { // The identifier of the global database cluster to switch over. This parameter - // isn't case-sensitive. Constraints: + // isn't case-sensitive. + // + // Constraints: + // // - Must match the identifier of an existing global database cluster (Aurora // global database). // diff --git a/service/rds/api_op_SwitchoverReadReplica.go b/service/rds/api_op_SwitchoverReadReplica.go index d8f8dd24d50..7afdf07bb90 100644 --- a/service/rds/api_op_SwitchoverReadReplica.go +++ b/service/rds/api_op_SwitchoverReadReplica.go @@ -32,7 +32,10 @@ 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: + // stored as a lowercase string. + // + // Constraints: + // // - Must match the identifier of an existing Oracle read replica DB instance. // // This member is required. @@ -43,9 +46,10 @@ 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 , + // 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 . diff --git a/service/rds/doc.go b/service/rds/doc.go index 5275aba57ea..c4c8e269a5c 100644 --- a/service/rds/doc.go +++ b/service/rds/doc.go @@ -3,40 +3,53 @@ // Package rds provides the API client, operations, and parameter types for Amazon // Relational Database Service. // -// Amazon Relational Database Service Amazon Relational Database Service (Amazon -// RDS) is a web service that makes it easier to set up, operate, and scale a -// relational database in the cloud. It provides cost-efficient, resizeable -// capacity for an industry-standard relational database and manages common -// database administration tasks, freeing up developers to focus on what makes -// their applications and businesses unique. Amazon RDS gives you access to the -// capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, -// or Amazon Aurora database server. These capabilities mean that the code, -// applications, and tools you already use today with your existing databases work -// with Amazon RDS without modification. Amazon RDS automatically backs up your -// database and maintains the database software that powers your DB instance. -// Amazon RDS is flexible: you can scale your DB instance's compute resources and -// storage capacity to meet your application's demand. As with all Amazon Web -// Services, there are no up-front investments, and you pay only for the resources -// you use. This interface reference for Amazon RDS contains documentation for a +// # Amazon Relational Database Service +// +// Amazon Relational Database Service (Amazon RDS) is a web service that makes it +// easier to set up, operate, and scale a relational database in the cloud. It +// provides cost-efficient, resizeable capacity for an industry-standard relational +// database and manages common database administration tasks, freeing up developers +// to focus on what makes their applications and businesses unique. +// +// Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, +// PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. +// These capabilities mean that the code, applications, and tools you already use +// today with your existing databases work with Amazon RDS without modification. +// Amazon RDS automatically backs up your database and maintains the database +// software that powers your DB instance. Amazon RDS is flexible: you can scale +// your DB instance's compute resources and storage capacity to meet your +// application's demand. As with all Amazon Web Services, there are no up-front +// investments, and you pay only for the resources you use. +// +// This interface reference for Amazon RDS contains documentation for a // programming or command line interface you can use to manage Amazon RDS. Amazon // RDS is asynchronous, which means that some interfaces might require techniques // such as polling or callback functions to determine when a command has been // applied. In this reference, the parameter descriptions indicate whether a // 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) -// . +// some related topics from the user guide. +// +// Amazon RDS API Reference +// +// - For the alphabetical list of API actions, see [API Actions]. +// +// - For the alphabetical list of data types, see [Data Types]. +// +// - For a list of common query parameters, see [Common Parameters]. +// +// - For descriptions of the error codes, see [Common Errors]. // // 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 a summary of the Amazon RDS interfaces, see [Available RDS Interfaces]. +// +// - For more information about how to use the Query API, see [Using the Query API]. +// +// [API Actions]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html +// [Common Errors]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html +// [Using the Query API]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html +// [Data Types]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html +// [Common Parameters]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html +// [Available RDS Interfaces]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces package rds diff --git a/service/rds/options.go b/service/rds/options.go index f7d3a50892d..ff89bfa3d45 100644 --- a/service/rds/options.go +++ b/service/rds/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/rds/types/enums.go b/service/rds/types/enums.go index 36c18cdf6eb..655512e87d4 100644 --- a/service/rds/types/enums.go +++ b/service/rds/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ActivityStreamMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActivityStreamMode) Values() []ActivityStreamMode { return []ActivityStreamMode{ "sync", @@ -32,6 +33,7 @@ const ( // Values returns all known values for ActivityStreamPolicyStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ActivityStreamPolicyStatus) Values() []ActivityStreamPolicyStatus { return []ActivityStreamPolicyStatus{ @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for ActivityStreamStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActivityStreamStatus) Values() []ActivityStreamStatus { return []ActivityStreamStatus{ "stopped", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for ApplyMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplyMethod) Values() []ApplyMethod { return []ApplyMethod{ "immediate", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for AuditPolicyState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuditPolicyState) Values() []AuditPolicyState { return []AuditPolicyState{ "locked", @@ -108,8 +113,9 @@ const ( ) // Values returns all known values for AuthScheme. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthScheme) Values() []AuthScheme { return []AuthScheme{ "SECRETS", @@ -125,8 +131,9 @@ const ( ) // Values returns all known values for AutomationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomationMode) Values() []AutomationMode { return []AutomationMode{ "full", @@ -145,8 +152,9 @@ const ( ) // Values returns all known values for ClientPasswordAuthType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientPasswordAuthType) Values() []ClientPasswordAuthType { return []ClientPasswordAuthType{ "MYSQL_NATIVE_PASSWORD", @@ -167,6 +175,7 @@ const ( // Values returns all known values for CustomEngineVersionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CustomEngineVersionStatus) Values() []CustomEngineVersionStatus { return []CustomEngineVersionStatus{ @@ -189,8 +198,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "available", @@ -212,6 +222,7 @@ const ( // Values returns all known values for DBProxyEndpointTargetRole. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DBProxyEndpointTargetRole) Values() []DBProxyEndpointTargetRole { return []DBProxyEndpointTargetRole{ @@ -236,8 +247,9 @@ const ( ) // Values returns all known values for DBProxyStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DBProxyStatus) Values() []DBProxyStatus { return []DBProxyStatus{ "available", @@ -262,8 +274,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -281,8 +294,9 @@ const ( ) // Values returns all known values for ExportSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportSourceType) Values() []ExportSourceType { return []ExportSourceType{ "SNAPSHOT", @@ -300,8 +314,9 @@ const ( ) // Values returns all known values for FailoverStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailoverStatus) Values() []FailoverStatus { return []FailoverStatus{ "pending", @@ -320,8 +335,9 @@ const ( // Values returns all known values for GlobalClusterMemberSynchronizationStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GlobalClusterMemberSynchronizationStatus) Values() []GlobalClusterMemberSynchronizationStatus { return []GlobalClusterMemberSynchronizationStatus{ "connected", @@ -339,8 +355,9 @@ const ( ) // Values returns all known values for IAMAuthMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IAMAuthMode) Values() []IAMAuthMode { return []IAMAuthMode{ "DISABLED", @@ -363,8 +380,9 @@ const ( ) // Values returns all known values for IntegrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationStatus) Values() []IntegrationStatus { return []IntegrationStatus{ "creating", @@ -392,8 +410,9 @@ const ( ) // Values returns all known values for LimitlessDatabaseStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LimitlessDatabaseStatus) Values() []LimitlessDatabaseStatus { return []LimitlessDatabaseStatus{ "active", @@ -420,6 +439,7 @@ const ( // Values returns all known values for LocalWriteForwardingStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LocalWriteForwardingStatus) Values() []LocalWriteForwardingStatus { return []LocalWriteForwardingStatus{ @@ -440,8 +460,9 @@ const ( ) // Values returns all known values for ReplicaMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicaMode) Values() []ReplicaMode { return []ReplicaMode{ "open-read-only", @@ -465,8 +486,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "db-instance", @@ -493,8 +515,9 @@ const ( ) // Values returns all known values for TargetHealthReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetHealthReason) Values() []TargetHealthReason { return []TargetHealthReason{ "UNREACHABLE", @@ -515,8 +538,9 @@ const ( ) // Values returns all known values for TargetRole. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetRole) Values() []TargetRole { return []TargetRole{ "READ_WRITE", @@ -535,8 +559,9 @@ const ( ) // Values returns all known values for TargetState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetState) Values() []TargetState { return []TargetState{ "REGISTERING", @@ -555,8 +580,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "RDS_INSTANCE", @@ -577,8 +603,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "enabled", diff --git a/service/rds/types/errors.go b/service/rds/types/errors.go index 723a2464e3a..851022b5877 100644 --- a/service/rds/types/errors.go +++ b/service/rds/types/errors.go @@ -35,8 +35,10 @@ 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. +// 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 diff --git a/service/rds/types/types.go b/service/rds/types/types.go index e9749eddb6a..21ca2b7d08c 100644 --- a/service/rds/types/types.go +++ b/service/rds/types/types.go @@ -7,66 +7,89 @@ import ( "time" ) -// Describes a quota for an Amazon Web Services account. The following are account -// quotas: +// 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. -// -// 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. +// 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] in the Amazon RDS User Guide and [Quotas for Amazon Aurora] in the Amazon +// Aurora User Guide. +// +// [Quotas for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html +// [Quotas for Amazon Aurora]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html type AccountQuota struct { // The name of the Amazon RDS quota for this Amazon Web Services account. @@ -81,8 +104,9 @@ type AccountQuota struct { noSmithyDocumentSerde } -// Contains Availability Zone information. This data type is used as an element in -// the OrderableDBInstanceOption data type. +// Contains Availability Zone information. +// +// This data type is used as an element in the OrderableDBInstanceOption data type. type AvailabilityZone struct { // The name of the Availability Zone. @@ -92,9 +116,11 @@ 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) -// in the Amazon RDS User Guide. +// of a DB instance. +// +// For more information, see [Configuring the Processor of the DB Instance Class] in the Amazon RDS User Guide. +// +// [Configuring the Processor of the DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor type AvailableProcessorFeature struct { // The allowed values for the processor feature of the DB instance class. @@ -109,11 +135,12 @@ type AvailableProcessorFeature struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Aurora User Guide. +// Details about a blue/green deployment. +// +// For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html type BlueGreenDeployment struct { // The unique identifier of the blue/green deployment. @@ -130,20 +157,31 @@ type BlueGreenDeployment struct { // 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. Valid Values: + // The status of the blue/green deployment. + // + // Valid 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. Status *string @@ -153,12 +191,15 @@ 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html 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 @@ -168,31 +209,40 @@ type BlueGreenDeployment struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Aurora User Guide. +// Details about a task for a blue/green deployment. +// +// For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html type BlueGreenDeploymentTask struct { // The name of the blue/green deployment task. Name *string - // The status of the blue/green deployment task. Valid Values: + // The status of the blue/green deployment task. + // + // Valid Values: + // // - PENDING - The resource is 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) -// in the Amazon Aurora User Guide. +// A CA certificate for an Amazon Web Services account. +// +// For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon +// Aurora User Guide. +// +// [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 type Certificate struct { // The Amazon Resource Name (ARN) for the certificate. @@ -223,11 +273,13 @@ type Certificate struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Aurora User Guide. +// 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] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon +// Aurora User Guide. +// +// [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 type CertificateDetails struct { // The CA identifier of the CA certificate used for the DB instance's server @@ -254,15 +306,19 @@ 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) -// 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) -// in the Amazon Aurora User Guide. +// 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]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]in the Amazon Aurora User Guide. +// +// [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch type CloudwatchLogsExportConfiguration struct { // The list of log types to disable. @@ -286,11 +342,13 @@ type ClusterPendingModifiedValues struct { // The number of days for which automatic DB snapshots are retained. BackupRetentionPeriod *int32 - // 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) - // in the Amazon Aurora User Guide. + // 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] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CertificateDetails *CertificateDetails // The DBClusterIdentifier value for the DB cluster. @@ -330,7 +388,12 @@ type ConnectionPoolConfiguration struct { // The number of seconds for a proxy to wait for a connection to become available // in the connection pool. This setting only applies when the proxy has opened its // maximum number of connections and all connections are busy with client sessions. - // For an unlimited wait time, specify 0 . Default: 120 Constraints: + // For an unlimited wait time, specify 0 . + // + // Default: 120 + // + // Constraints: + // // - Must be between 0 and 3600. ConnectionBorrowTimeout *int32 @@ -338,16 +401,22 @@ type ConnectionPoolConfiguration struct { // 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 + // 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 - // parameter. Default: 10 for RDS for Microsoft SQL Server, and 100 for all other - // engines Constraints: + // 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 @@ -356,20 +425,28 @@ type ConnectionPoolConfiguration struct { // max_connections setting for the RDS DB instance or Aurora DB cluster used by the // target group. 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 - // 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: + // 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 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 . MaxIdleConnectionsPercent *int32 // Each item in the list represents a class of SQL operations that normally cause // all later statements in a session using a proxy to be pinned to the same // underlying database connection. Including an item in the list exempts that class - // of SQL operations from the pinning behavior. Default: no session pinning filters + // of SQL operations from the pinning behavior. + // + // Default: no session pinning filters SessionPinningFilters []string noSmithyDocumentSerde @@ -440,20 +517,27 @@ type CustomDBEngineVersionAMI struct { noSmithyDocumentSerde } -// 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 , +// 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 +// 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) -// in the Amazon RDS User Guide. +// RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime . +// +// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora +// User Guide. +// +// For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User +// Guide. +// +// [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html +// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html type DBCluster struct { // The name of the Amazon Kinesis data stream used for the database activity @@ -461,8 +545,10 @@ type DBCluster struct { ActivityStreamKinesisStreamName *string // The Amazon Web Services KMS key identifier used for encrypting messages in the - // database activity stream. The Amazon Web Services KMS key identifier is the key - // ARN, key ID, alias ARN, or alias name for the KMS key. + // database activity stream. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. ActivityStreamKmsKeyId *string // The mode of the database activity stream. Database events such as a change or @@ -485,8 +571,9 @@ type DBCluster struct { // on your behalf. AssociatedRoles []DBClusterRole - // Indicates whether minor version patches are applied automatically. This setting - // is only for non-Aurora Multi-AZ DB clusters. + // Indicates whether minor version patches are applied automatically. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. AutoMinorVersionUpgrade *bool // The time when a stopped DB cluster is restarted automatically. @@ -511,16 +598,21 @@ type DBCluster struct { BackupRetentionPeriod *int32 // 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) - // in the Amazon Aurora User Guide. + // (zero) when the cluster is paused. + // + // For more information about Aurora Serverless v1, see [Using Amazon Aurora Serverless v1] in the Amazon Aurora User + // Guide. + // + // [Using Amazon Aurora Serverless v1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html Capacity *int32 - // 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) - // in the Amazon Aurora User Guide. + // 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] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CertificateDetails *CertificateDetails // If present, specifies the name of the character set that this cluster is @@ -551,8 +643,9 @@ type DBCluster struct { // key that identifies a DB cluster. DBClusterIdentifier *string - // The name of the compute and memory capacity class of the DB instance. This - // setting is only for non-Aurora Multi-AZ DB clusters. + // The name of the compute and memory capacity class of the DB instance. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. DBClusterInstanceClass *string // The list of DB instances that make up the DB cluster. @@ -596,9 +689,12 @@ type DBCluster struct { EarliestRestorableTime *time.Time // 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) - // in the Amazon Aurora User Guide. + // Logs. + // + // Log types vary by DB engine. For information about the log types for each DB + // engine, see [Amazon RDS Database Log Files]in the Amazon Aurora User Guide. + // + // [Amazon RDS Database Log Files]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html EnabledCloudwatchLogsExports []string // The connection endpoint for the primary instance of the DB cluster. @@ -607,9 +703,11 @@ type DBCluster struct { // The database engine used for this DB cluster. Engine *string - // The DB engine mode of the DB cluster, either provisioned or serverless . 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 or serverless . + // + // For more information, see [CreateDBCluster]. + // + // [CreateDBCluster]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html EngineMode *string // The version of the database engine. @@ -628,12 +726,15 @@ type DBCluster struct { // The ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string - // Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When - // enabled, the HTTP endpoint provides a connectionless web service API (RDS Data - // API) for running SQL queries on the DB cluster. You can also query your database - // from inside the RDS console with the RDS query editor. For more information, see - // Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) - // in the Amazon Aurora User Guide. + // Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. + // + // When enabled, the HTTP endpoint provides a connectionless web service API (RDS + // Data API) for running SQL queries on the DB cluster. You can also query your + // database from inside the RDS console with the RDS query editor. + // + // For more information, see [Using RDS Data API] in the Amazon Aurora User Guide. + // + // [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html HttpEndpointEnabled *bool // Indicates whether the mapping of Amazon Web Services Identity and Access @@ -641,16 +742,21 @@ type DBCluster struct { IAMDatabaseAuthenticationEnabled *bool // The next time you can modify the DB cluster to use the aurora-iopt1 storage - // type. This setting is only for Aurora DB clusters. + // type. + // + // This setting is only for Aurora DB clusters. IOOptimizedNextAllowedModificationTime *time.Time - // 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 - // the 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. + // the 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. KmsKeyId *string // The latest time to which a database can be restored with point-in-time restore. @@ -664,35 +770,45 @@ type DBCluster struct { LocalWriteForwardingStatus LocalWriteForwardingStatus // 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) - // 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) - // in the Amazon Aurora User Guide. + // user password. + // + // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon + // Aurora User Guide. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html MasterUserSecret *MasterUserSecret // The master username for the DB cluster. MasterUsername *string // The interval, in seconds, between points when Enhanced Monitoring metrics are - // collected for the DB cluster. This setting is only for non-Aurora Multi-AZ DB - // clusters. + // collected for the DB cluster. + // + // This setting is only for non-Aurora Multi-AZ DB 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 - // clusters. + // to Amazon CloudWatch Logs. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. MonitoringRoleArn *string // Indicates whether the DB cluster has instances in multiple Availability Zones. MultiAZ *bool - // The network type of the DB instance. 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. + // The network type of the DB instance. + // + // 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] in the Amazon Aurora User Guide. + // + // This setting is only for Aurora DB clusters. + // // Valid Values: IPV4 | DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // Information about pending changes to the DB cluster. This information is @@ -703,22 +819,33 @@ type DBCluster struct { // The progress of the operation as a percentage. PercentProgress *string - // Indicates whether Performance Insights is enabled for the DB cluster. This - // setting is only for non-Aurora Multi-AZ DB clusters. + // Indicates whether Performance Insights is enabled for the DB cluster. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsEnabled *bool // 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. This setting is only for - // non-Aurora Multi-AZ DB clusters. + // Insights data. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. This setting is only - // for non-Aurora Multi-AZ DB clusters. Valid Values: + // The number of days to retain Performance Insights data. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 + // // Default: 7 days PerformanceInsightsRetentionPeriod *int32 @@ -733,16 +860,21 @@ type DBCluster struct { // Coordinated Time (UTC). PreferredMaintenanceWindow *string - // Indicates whether the DB cluster is publicly accessible. When the DB cluster is - // publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security 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 cluster isn't publicly accessible, it is an - // internal DB cluster with a DNS name that resolves to a private IP address. For - // more information, see CreateDBCluster . This setting is only for non-Aurora - // Multi-AZ DB clusters. + // Indicates whether the DB cluster is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // 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 cluster isn't publicly accessible, it is an internal DB cluster + // with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBCluster. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. PubliclyAccessible *bool // Reserved for future use. @@ -757,23 +889,29 @@ type DBCluster struct { // cluster. As clients request new connections to the reader endpoint, Aurora // distributes the connection requests among the Aurora Replicas in the DB cluster. // This functionality can help balance your read workload across multiple Aurora - // Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that - // you are connected to is promoted to be the primary instance, your connection is - // dropped. To continue sending your read workload to other Aurora Replicas in the - // cluster, you can then reconnect to the reader endpoint. + // Replicas in your DB cluster. + // + // If a failover occurs, and the Aurora Replica that you are connected to is + // promoted to be the primary instance, your connection is dropped. To continue + // sending your read workload to other Aurora Replicas in the cluster, you can then + // reconnect to the reader endpoint. ReaderEndpoint *string // The identifier of the source DB cluster if this DB cluster is a read replica. ReplicationSourceIdentifier *string - // 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. + // The scaling configuration for an Aurora DB cluster in serverless DB engine mode. + // + // For more information, see [Using Amazon Aurora Serverless v1] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html ScalingConfigurationInfo *ScalingConfigurationInfo - // 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. + // The scaling configuration for an Aurora Serverless v2 DB cluster. + // + // For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. + // + // [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo // The current state of this DB cluster. @@ -786,15 +924,17 @@ type DBCluster struct { StorageEncrypted *bool // The storage throughput for the DB cluster. The throughput is automatically set - // based on the IOPS that you provision, and is not configurable. This setting is - // only for non-Aurora Multi-AZ DB clusters. + // based on the IOPS that you provision, and is not configurable. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. StorageThroughput *int32 // The storage type associated with the DB cluster. 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // The list of VPC security groups that the DB cluster belongs to. @@ -815,9 +955,9 @@ type DBClusterAutomatedBackup struct { AllocatedStorage *int32 // The Availability Zones where instances in the DB cluster can be created. For - // information on Amazon Web Services Regions and Availability Zones, see Regions - // and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) - // . + // information on Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones]. + // + // [Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZones []string // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services @@ -857,13 +997,15 @@ type DBClusterAutomatedBackup struct { // (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool - // The IOPS (I/O operations per second) value for the automated backup. This - // setting is only for non-Aurora Multi-AZ DB clusters. + // The IOPS (I/O operations per second) value for the automated backup. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. Iops *int32 - // The Amazon Web Services KMS key ID for an automated backup. The Amazon Web - // Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for - // the KMS key. + // The Amazon Web Services KMS key ID for an automated backup. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. KmsKeyId *string // The license model information for this DB cluster automated backup. @@ -872,8 +1014,11 @@ type DBClusterAutomatedBackup struct { // The master user name of the automated backup. MasterUsername *string - // The port number that the automated backup used for connections. Default: - // Inherits from the source DB cluster Valid Values: 1150-65535 + // The port number that the automated backup used for connections. + // + // Default: Inherits from the source DB cluster + // + // Valid Values: 1150-65535 Port *int32 // The Amazon Web Services Region associated with the automated backup. @@ -883,6 +1028,7 @@ type DBClusterAutomatedBackup struct { RestoreWindow *RestoreWindow // A list of status information for an automated backup: + // // - retained - Automated backups for deleted clusters. Status *string @@ -891,11 +1037,13 @@ type DBClusterAutomatedBackup struct { // The storage throughput for the automated backup. The throughput is // automatically set based on the IOPS that you provision, and is not configurable. + // // This setting is only for non-Aurora Multi-AZ DB clusters. StorageThroughput *int32 - // The storage type associated with the DB cluster. This setting is only for - // non-Aurora Multi-AZ DB clusters. + // The storage type associated with the DB cluster. + // + // This setting is only for non-Aurora Multi-AZ DB clusters. StorageType *string // The VPC ID associated with the DB cluster. @@ -925,12 +1073,16 @@ type DBClusterBacktrack struct { 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. Status *string @@ -941,9 +1093,13 @@ 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 // // For the data structure that represents Amazon RDS DB instance endpoints, see @@ -1007,8 +1163,9 @@ 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) - // in the Amazon Aurora User Guide. + // information, see [Fault Tolerance for an Aurora DB Cluster]in the Amazon Aurora User Guide. + // + // [Fault Tolerance for an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance PromotionTier *int32 noSmithyDocumentSerde @@ -1026,9 +1183,10 @@ 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. @@ -1053,7 +1211,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 @@ -1062,9 +1220,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. @@ -1073,8 +1234,10 @@ type DBClusterRole struct { noSmithyDocumentSerde } -// Contains the details for an Amazon RDS DB cluster snapshot This data type is -// used as a response element in the DescribeDBClusterSnapshots action. +// Contains the details for an Amazon RDS DB cluster snapshot +// +// This data type is used as a response element in the DescribeDBClusterSnapshots +// action. type DBClusterSnapshot struct { // The allocated storage size of the DB cluster snapshot in gibibytes (GiB). @@ -1118,8 +1281,10 @@ type DBClusterSnapshot struct { IAMDatabaseAuthenticationEnabled *bool // If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the - // encrypted 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. + // encrypted 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. KmsKeyId *string // The license model information for this DB cluster snapshot. @@ -1146,8 +1311,11 @@ type DBClusterSnapshot struct { SourceDBClusterSnapshotArn *string // The status of this DB cluster snapshot. Valid statuses are the following: + // // - available + // // - copying + // // - creating Status *string @@ -1156,15 +1324,18 @@ type DBClusterSnapshot struct { // The storage throughput for the DB cluster snapshot. The throughput is // automatically set based on the IOPS that you provision, and is not configurable. + // // This setting is only for non-Aurora Multi-AZ DB clusters. StorageThroughput *int32 - // The storage type associated with the DB cluster snapshot. This setting is only - // for Aurora DB clusters. + // The storage type associated with the DB cluster snapshot. + // + // This setting is only for Aurora 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // The VPC ID associated with the DB cluster snapshot. @@ -1173,34 +1344,38 @@ type DBClusterSnapshot struct { noSmithyDocumentSerde } -// Contains the name and values of a manual DB cluster snapshot attribute. Manual -// DB cluster snapshot attributes are used to authorize other Amazon Web Services -// accounts to restore a manual DB cluster snapshot. For more information, see the -// ModifyDBClusterSnapshotAttribute API action. +// Contains the name and values of a manual DB cluster snapshot attribute. +// +// Manual DB cluster snapshot attributes are used to authorize other Amazon Web +// Services accounts to restore a manual DB cluster snapshot. For more information, +// see the ModifyDBClusterSnapshotAttribute API action. type DBClusterSnapshotAttribute struct { - // The name of the manual DB cluster 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 - // ModifyDBClusterSnapshotAttribute API action. + // The name of the manual DB cluster 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 ModifyDBClusterSnapshotAttribute API action. 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 - // 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 - // restore. + // 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 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 restore. AttributeValues []string noSmithyDocumentSerde } // Contains the results of a successful call to the -// DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot -// attributes are used to authorize other Amazon Web Services accounts to copy or -// restore a manual DB cluster snapshot. For more information, see the -// ModifyDBClusterSnapshotAttribute API action. +// DescribeDBClusterSnapshotAttributes API action. +// +// Manual DB cluster snapshot attributes are used to authorize other Amazon Web +// Services accounts to copy or restore a manual DB cluster snapshot. For more +// information, see the ModifyDBClusterSnapshotAttribute API action. type DBClusterSnapshotAttributesResult struct { // The list of attributes and values for the manual DB cluster snapshot. @@ -1241,8 +1416,9 @@ 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) - // in the Amazon RDS User Guide. + // For more information, see [JSON fields in the CEV manifest]in the Amazon RDS User Guide. + // + // [JSON fields in the CEV manifest]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields CustomDBEngineVersionManifest *string // The description of the database engine. @@ -1295,11 +1471,13 @@ type DBEngineVersion struct { // 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) - // in the Amazon Aurora User Guide. + // A list of the supported CA certificate identifiers. + // + // For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 SupportedCACertificateIdentifiers []string // A list of the character sets supported by this engine for the CharacterSetName @@ -1309,14 +1487,21 @@ 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 - // SupportedFeatureNames in the output. + // 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 // A list of the character sets supported by the Oracle DB engine for the @@ -1347,8 +1532,9 @@ type DBEngineVersion struct { // Indicates whether the DB engine version supports forwarding write operations // from reader DB instances to the writer DB instance in the DB cluster. By - // default, write operations aren't allowed on reader DB instances. Valid for: - // Aurora DB clusters only + // default, write operations aren't allowed on reader DB instances. + // + // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether the engine version supports exporting the log types specified @@ -1362,8 +1548,9 @@ type DBEngineVersion struct { // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // A list of engine versions that this database engine version can be upgraded to. @@ -1372,9 +1559,10 @@ type DBEngineVersion struct { noSmithyDocumentSerde } -// 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 , +// 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 . @@ -1437,11 +1625,13 @@ type DBInstance struct { // Web 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) - // in the Amazon Aurora User Guide. + // 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] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // The details of the DB instance's server certificate. @@ -1452,8 +1642,10 @@ type DBInstance struct { CharacterSetName *string // Indicates whether tags are copied from the DB instance to snapshots of the DB - // instance. This setting doesn't apply to Amazon Aurora DB instances. Copying tags - // to snapshots is managed by the DB cluster. Setting this value for an Aurora DB + // instance. + // + // This setting doesn't apply to Amazon Aurora DB instances. 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 . CopyTagsToSnapshot *bool @@ -1461,26 +1653,35 @@ type DBInstance 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 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. + // + // For the list of permissions required for the IAM role, see [Configure IAM and your VPC] in the Amazon RDS + // User Guide. + // + // [Configure IAM and your VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc CustomIamInstanceProfile *string // Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on - // Outposts DB instance. A CoIP provides local or external connectivity to - // resources in your Outpost subnets through your on-premises network. For some 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) - // in the Amazon Web Services Outposts User Guide. + // Outposts DB instance. + // + // A CoIP provides local or external connectivity to resources in your Outpost + // subnets through your on-premises network. For some 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] in the Amazon RDS User Guide. + // + // For more information about CoIPs, see [Customer-owned IP addresses] in the Amazon Web Services Outposts User + // Guide. + // + // [Working with Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html + // [Customer-owned IP addresses]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing CustomerOwnedIpEnabled *bool // If the DB instance is a member of a DB cluster, indicates the name of the DB @@ -1500,9 +1701,11 @@ type DBInstance struct { // identifies a DB instance. DBInstanceIdentifier *string - // 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) - // in the Amazon RDS User Guide. + // The current state of this database. + // + // For information about DB instance statuses, see [Viewing DB instance status] in the Amazon RDS User Guide. + // + // [Viewing DB instance status]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status DBInstanceStatus *string // The initial database name that you provided (if required) when you created the @@ -1539,22 +1742,27 @@ type DBInstance struct { DedicatedLogVolume *bool // Indicates whether 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) + // can't be deleted when deletion protection is enabled. For more information, see [Deleting a DB Instance] // . + // + // [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. DomainMemberships []DomainMembership // 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 Monitoring Amazon RDS log files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) - // in the Amazon RDS User Guide. + // Logs. + // + // Log types vary by DB engine. For information about the log types for each DB + // engine, see [Monitoring Amazon RDS log files]in the Amazon RDS User Guide. + // + // [Monitoring Amazon RDS log files]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html EnabledCloudwatchLogsExports []string - // The connection endpoint for the DB instance. The endpoint might not be shown - // for instances with the status of creating . + // The connection endpoint for the DB instance. + // + // The endpoint might not be shown for instances with the status of creating . Endpoint *Endpoint // The database engine used for this DB instance. @@ -1568,11 +1776,13 @@ type DBInstance struct { EnhancedMonitoringResourceArn *string // Indicates whether mapping of Amazon Web Services Identity and Access Management - // (IAM) accounts to database accounts is enabled for the DB instance. For a list - // of engine versions that support IAM database authentication, see IAM database - // authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html) - // in the Amazon RDS User Guide and IAM database authentication in Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html) - // in the Amazon Aurora User Guide. + // (IAM) accounts to database accounts is enabled for the DB instance. + // + // For a list of engine versions that support IAM database authentication, see [IAM database authentication] in + // the Amazon RDS User Guide and [IAM database authentication in Aurora]in the Amazon Aurora User Guide. + // + // [IAM database authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html + // [IAM database authentication in Aurora]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html IAMDatabaseAuthenticationEnabled *bool // The date and time when the DB instance was created. @@ -1584,14 +1794,16 @@ type DBInstance struct { // Indicates whether an upgrade is recommended for the storage file system // configuration on the DB instance. To migrate to the preferred configuration, you // can either create a blue/green deployment, or create a read replica from the DB - // instance. For more information, see Upgrading the storage file system for a DB - // instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem) - // . + // instance. For more information, see [Upgrading the storage file system for a DB instance]. + // + // [Upgrading the storage file system for a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem IsStorageConfigUpgradeAvailable *bool // If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for - // the encrypted DB instance. The Amazon Web Services KMS key identifier is the key - // ARN, key ID, alias ARN, or alias name for the KMS key. + // the encrypted DB instance. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. KmsKeyId *string // The latest time to which a database in this DB instance can be restored with @@ -1606,9 +1818,11 @@ type DBInstance struct { ListenerEndpoint *Endpoint // 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) - // in the Amazon RDS User Guide. + // user password. + // + // For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide. + // + // [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html MasterUserSecret *MasterUserSecret // The master username for the DB instance. @@ -1639,12 +1853,18 @@ type DBInstance struct { // NCHAR, NCLOB, or NVARCHAR2. NcharCharacterSetName *string - // The network type of the DB instance. 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. Valid Values: IPV4 | DUAL + // The network type of the DB instance. + // + // 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] in the Amazon RDS User Guide and [Working with a DB instance in a VPC] in the Amazon + // Aurora User Guide. + // + // Valid Values: IPV4 | DUAL + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html NetworkType *string // The list of option group memberships for this DB instance. @@ -1662,15 +1882,23 @@ type DBInstance struct { PerformanceInsightsEnabled *bool // 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. + // Insights data. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. PerformanceInsightsKMSKeyId *string - // The number of days to retain Performance Insights data. Valid Values: + // The number of days to retain Performance Insights data. + // + // Valid Values: + // // - 7 + // // - month * 31, where month is a number of months from 1-23. Examples: 93 (3 // months * 31), 341 (11 months * 31), 589 (19 months * 31) + // // - 731 + // // Default: 7 days PerformanceInsightsRetentionPeriod *int32 @@ -1688,27 +1916,33 @@ type DBInstance struct { // The order of priority 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/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) - // in the Amazon Aurora User Guide. + // see [Fault Tolerance for an Aurora DB Cluster]in the Amazon Aurora User Guide. + // + // [Fault Tolerance for an Aurora DB Cluster]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance PromotionTier *int32 - // Indicates whether the DB instance is publicly accessible. When the DB cluster - // is publicly accessible, its Domain Name System (DNS) endpoint resolves to the - // private IP address from within the DB cluster's virtual private cloud (VPC). It - // resolves to the public IP address from outside of the DB cluster's VPC. Access - // to the DB cluster is ultimately controlled by the security 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 . + // Indicates whether the DB instance is publicly accessible. + // + // When the DB cluster is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB cluster's virtual + // private cloud (VPC). It resolves to the public IP address from outside of the DB + // cluster's VPC. Access to the DB cluster is ultimately controlled by the security + // 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. PubliclyAccessible *bool // The identifiers of Aurora DB clusters to which the RDS DB instance is // replicated as a read replica. For example, when you create an Aurora read // replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the // Aurora read replica is shown. This output doesn't contain information about - // cross-Region Aurora read replicas. Currently, each RDS DB instance can have only - // one Aurora read replica. + // cross-Region Aurora read replicas. + // + // Currently, each RDS DB instance can have only one Aurora read replica. ReadReplicaDBClusterIdentifiers []string // The identifiers of the read replicas associated with this DB instance. @@ -1721,9 +1955,11 @@ type DBInstance struct { 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) - // in the Amazon RDS User Guide. This attribute is only supported in RDS for - // Oracle. + // more information, see [Working with Oracle Read Replicas for Amazon RDS]in the Amazon RDS User Guide. + // + // This attribute is only supported in RDS for Oracle. + // + // [Working with Oracle Read Replicas for Amazon RDS]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html ReplicaMode ReplicaMode // The number of minutes to pause the automation. When the time period ends, RDS @@ -1742,15 +1978,17 @@ type DBInstance struct { // Indicates whether the DB instance is encrypted. StorageEncrypted *bool - // The storage throughput for the DB instance. This setting applies only to the gp3 - // storage type. + // The storage throughput for the DB instance. + // + // This setting applies only to the gp3 storage type. StorageThroughput *int32 // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // The ARN from the key store with which the instance is associated for TDE @@ -1777,9 +2015,9 @@ type DBInstanceAutomatedBackup struct { AllocatedStorage *int32 // 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) - // . + // on Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones]. + // + // [Regions and Availability Zones]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html AvailabilityZone *string // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services @@ -1833,9 +2071,10 @@ type DBInstanceAutomatedBackup struct { // The IOPS (I/O operations per second) value for the automated backup. Iops *int32 - // The Amazon Web Services KMS key ID for an automated backup. The Amazon Web - // Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for - // the KMS key. + // The Amazon Web Services KMS key ID for an automated backup. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. KmsKeyId *string // The license model information for the automated backup. @@ -1852,8 +2091,11 @@ type DBInstanceAutomatedBackup struct { // default option group for the engine specified is used. OptionGroupName *string - // The port number that the automated backup used for connections. Default: - // Inherits from the source DB instance Valid Values: 1150-65535 + // The port number that the automated backup used for connections. + // + // Default: Inherits from the source DB instance + // + // Valid Values: 1150-65535 Port *int32 // The Amazon Web Services Region associated with the automated backup. @@ -1863,8 +2105,11 @@ type DBInstanceAutomatedBackup struct { RestoreWindow *RestoreWindow // 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. Status *string @@ -1916,9 +2161,12 @@ type DBInstanceRole struct { // Information about 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. @@ -1949,8 +2197,10 @@ 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. @@ -1969,13 +2219,20 @@ type DBParameterGroup struct { noSmithyDocumentSerde } -// The status of the DB parameter group. This data type is used as a response -// element in the following actions: +// 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 type DBParameterGroupStatus struct { @@ -1988,8 +2245,9 @@ 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 @@ -2029,7 +2287,11 @@ type DBProxy struct { // The number of seconds a connection to the proxy can have no activity before the // proxy drops the client connection. The proxy keeps the underlying database // connection open and puts it back into the connection pool for reuse by later - // connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 + // connection requests. + // + // Default: 1800 (30 minutes) + // + // Constraints: 1 to 28,800 IdleClientTimeout *int32 // Indicates whether Transport Layer Security (TLS) encryption is required for @@ -2064,8 +2326,10 @@ type DBProxy struct { // automatically creates one endpoint for each DB proxy. For Aurora DB clusters, // you can associate additional endpoints with the same DB proxy. These endpoints // can be read/write or read-only. They can also reside in different VPCs than the -// associated DB proxy. This data type is used as a response element in the -// DescribeDBProxyEndpoints operation. +// associated DB proxy. +// +// This data type is used as a response element in the DescribeDBProxyEndpoints +// operation. type DBProxyEndpoint struct { // The date and time when the DB proxy endpoint was first created. @@ -2115,8 +2379,10 @@ type DBProxyEndpoint struct { // Contains the details for an RDS Proxy target. It represents an RDS DB instance // or Aurora DB cluster that the proxy can connect to. One or more targets are -// associated with an RDS Proxy target group. This data type is used as a response -// element in the DescribeDBProxyTargets action. +// associated with an RDS Proxy target group. +// +// This data type is used as a response element in the DescribeDBProxyTargets +// action. type DBProxyTarget struct { // The writer endpoint for the RDS DB instance or Aurora DB cluster. @@ -2153,8 +2419,10 @@ type DBProxyTarget struct { // Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy // can connect to. Currently, each target group is associated with exactly one RDS -// DB instance or Aurora DB cluster. This data type is used as a response element -// in the DescribeDBProxyTargetGroups action. +// DB instance or Aurora DB cluster. +// +// This data type is used as a response element in the DescribeDBProxyTargetGroups +// action. type DBProxyTargetGroup struct { // The settings that determine the size and behavior of the connection pool for @@ -2199,12 +2467,20 @@ type DBRecommendation struct { // markdown. AdditionalInfo *string - // The category of the recommendation. Valid values: + // The category of the recommendation. + // + // Valid values: + // // - performance efficiency + // // - security + // // - reliability + // // - cost optimization + // // - operational excellence + // // - sustainability Category *string @@ -2249,20 +2525,32 @@ type DBRecommendation struct { ResourceArn *string // The severity level of the recommendation. The severity level can help you - // decide the urgency with which to address the recommendation. Valid values: + // decide the urgency with which to address the recommendation. + // + // Valid values: + // // - high + // // - medium + // // - low + // // - informational Severity *string // The Amazon Web Services service that generated the recommendations. Source *string - // The current status of the recommendation. Valid values: + // The current status of the recommendation. + // + // Valid values: + // // - active - The recommendations which are ready for you to apply. + // // - pending - The applied or scheduled recommendations which are in progress. + // // - resolved - The recommendations which are completed. + // // - dismissed - The recommendations that you dismissed. Status *string @@ -2284,8 +2572,10 @@ type DBRecommendation 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. @@ -2314,9 +2604,13 @@ type DBSecurityGroup struct { } // This data type is used as a response element in the following actions: +// // - ModifyDBInstance +// // - RebootDBInstance +// // - RestoreDBInstanceFromDBSnapshot +// // - RestoreDBInstanceToPointInTime type DBSecurityGroupMembership struct { @@ -2333,10 +2627,13 @@ type DBShardGroup struct { // Specifies whether to create standby instances for the DB shard group. Valid // values are the following: + // // - 0 - Creates a single, primary DB instance for each physical shard. This is // the default value, and the only one supported for the preview. + // // - 1 - Creates a primary DB instance and a standby instance in a different // Availability Zone (AZ) for each physical shard. + // // - 2 - Creates a primary DB instance and two standby instances in different // AZs for each physical shard. ComputeRedundancy *int32 @@ -2357,16 +2654,21 @@ type DBShardGroup struct { // The maximum capacity of the DB shard group in Aurora capacity units (ACUs). MaxACU *float64 - // Indicates whether the DB shard group is publicly accessible. When the DB shard - // group is publicly accessible, its Domain Name System (DNS) endpoint resolves to - // the private IP address from within the DB shard group's virtual private cloud - // (VPC). It resolves to the public IP address from outside of the DB shard group's - // VPC. Access to the DB shard group is ultimately controlled by the security group - // it uses. That public access isn't permitted if the security group assigned to - // the DB shard group doesn't permit it. When the DB shard group isn't publicly - // accessible, it is an internal DB shard group with a DNS name that resolves to a - // private IP address. For more information, see CreateDBShardGroup . This setting - // is only for Aurora Limitless Database. + // Indicates whether the DB shard group is publicly accessible. + // + // When the DB shard group is publicly accessible, its Domain Name System (DNS) + // endpoint resolves to the private IP address from within the DB shard group's + // virtual private cloud (VPC). It resolves to the public IP address from outside + // of the DB shard group's VPC. Access to the DB shard group is ultimately + // controlled by the security group it uses. That public access isn't permitted if + // the security group assigned to the DB shard group doesn't permit it. + // + // When the DB shard group isn't publicly accessible, it is an internal DB shard + // group with a DNS name that resolves to a private IP address. + // + // For more information, see CreateDBShardGroup. + // + // This setting is only for Aurora Limitless Database. PubliclyAccessible *bool // The status of the DB shard group. @@ -2375,8 +2677,9 @@ type DBShardGroup struct { noSmithyDocumentSerde } -// Contains the details of an Amazon RDS DB snapshot. This data type is used as a -// response element in the DescribeDBSnapshots action. +// Contains the details of an Amazon RDS DB snapshot. +// +// This data type is used as a response element in the DescribeDBSnapshots action. type DBSnapshot struct { // Specifies the allocated storage size in gibibytes (GiB). @@ -2430,8 +2733,10 @@ type DBSnapshot struct { Iops *int32 // If Encrypted is true, the Amazon Web Services KMS key identifier for the - // encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key - // ARN, key ID, alias ARN, or alias name for the KMS key. + // encrypted DB snapshot. + // + // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, + // or alias name for the KMS key. KmsKeyId *string // License model information for the restored DB instance. @@ -2470,8 +2775,10 @@ type DBSnapshot struct { // 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 + // completed. + // + // If you back up a read replica, you can determine the replica lag by comparing + // SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if // originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then // the replica lag is two hours. SnapshotDatabaseTime *time.Time @@ -2500,8 +2807,9 @@ 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // The ARN from the key store with which to associate the instance for TDE @@ -2519,32 +2827,38 @@ type DBSnapshot struct { noSmithyDocumentSerde } -// Contains the name and values of a manual DB snapshot attribute Manual DB -// snapshot attributes are used to authorize other Amazon Web Services accounts to -// restore a manual DB snapshot. For more information, see the +// Contains the name and values of a manual DB snapshot attribute +// +// Manual DB snapshot attributes are used to authorize other Amazon Web Services +// accounts to restore a manual DB snapshot. For more information, see the // 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 - // ModifyDBSnapshotAttribute API action. + // 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 - // 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. + // 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 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. AttributeValues []string noSmithyDocumentSerde } // Contains the results of a successful call to the DescribeDBSnapshotAttributes -// API action. Manual DB snapshot attributes are used to authorize other Amazon Web -// Services accounts to copy or restore a manual DB snapshot. For more information, -// see the ModifyDBSnapshotAttribute API action. +// API action. +// +// Manual DB snapshot attributes are used to authorize other Amazon Web Services +// accounts to copy or restore a manual DB snapshot. For more information, see the +// ModifyDBSnapshotAttribute API action. type DBSnapshotAttributesResult struct { // The list of attributes and values for the manual DB snapshot. @@ -2587,8 +2901,9 @@ type DBSnapshotTenantDatabase struct { // The type of DB snapshot. SnapshotType *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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // The name of the tenant database. @@ -2604,8 +2919,10 @@ type DBSnapshotTenantDatabase 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. @@ -2623,13 +2940,20 @@ type DBSubnetGroup struct { // Contains a list of Subnet elements. Subnets []Subnet - // The network type of the DB subnet group. Valid values: + // 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) - // in the Amazon RDS User Guide. + // protocols ( DUAL ). + // + // For more information, see [Working with a DB instance in a VPC] in the Amazon RDS User Guide. + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html SupportedNetworkTypes []string // Provides the VpcId of the DB subnet group. @@ -2710,8 +3034,11 @@ type DoubleRange struct { } // This data type is used as a response element in the following actions: +// // - AuthorizeDBSecurityGroupIngress +// // - DescribeDBSecurityGroups +// // - RevokeDBSecurityGroupIngress type EC2SecurityGroup struct { @@ -2735,8 +3062,11 @@ 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 // // For the data structure that represents Amazon Aurora DB cluster endpoints, see @@ -2774,8 +3104,9 @@ 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) -// action. +// This data type is used as a response element in the [DescribeEvents] action. +// +// [DescribeEvents]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html type Event struct { // Specifies the date and time of the event. @@ -2799,8 +3130,9 @@ 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) -// operation. +// Contains the results of a successful invocation of the [DescribeEventCategories] operation. +// +// [DescribeEventCategories]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventCategories.html type EventCategoriesMap struct { // The event categories for the specified source type @@ -2842,11 +3174,16 @@ type EventSubscription struct { // The source type for the RDS event notification subscription. SourceType *string - // The status of the RDS event notification subscription. Constraints: Can be one - // of the following: creating | modifying | deleting | active | no-permission | - // topic-not-exist The status "no-permission" indicates that RDS no longer has - // permission to post to the SNS topic. The status "topic-not-exist" indicates that - // the topic was deleted after the subscription was created. + // The status of the RDS event notification subscription. + // + // Constraints: + // + // Can be one of the following: creating | modifying | deleting | active | + // no-permission | topic-not-exist + // + // The status "no-permission" indicates that RDS no longer has permission to post + // to the SNS topic. The status "topic-not-exist" indicates that the topic was + // deleted after the subscription was created. Status *string // The time the RDS event notification subscription was created. @@ -2855,14 +3192,21 @@ type EventSubscription struct { noSmithyDocumentSerde } -// Contains the details of a snapshot or cluster export to Amazon S3. This data -// type is used as a response element in the DescribeExportTasks operation. +// Contains the details of a snapshot or cluster export to Amazon S3. +// +// This data type is used as a response element in the DescribeExportTasks +// operation. type ExportTask struct { - // The data exported from the snapshot or cluster. Valid Values: + // The data exported from the snapshot or cluster. + // + // Valid Values: + // // - 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. // @@ -2906,11 +3250,17 @@ type ExportTask struct { SourceType ExportSourceType // The progress status of the export task. The status can be one of the following: + // // - CANCELED + // // - CANCELING + // // - COMPLETE + // // - FAILED + // // - IN_PROGRESS + // // - STARTING Status *string @@ -2944,14 +3294,18 @@ type FailoverState struct { IsDataLossAllowed *bool // The current status of the global cluster. Possible values are as follows: + // // - pending – The service received a request to switch over or fail over the // global cluster. The global cluster's primary DB cluster and the specified // secondary DB cluster are being verified before the operation starts. + // // - failing-over – Aurora is promoting the chosen secondary Aurora DB cluster // to become the new primary DB cluster to fail over the global cluster. + // // - cancelling – The request to switch over or fail over the global cluster was // cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB // cluster are returning to their previous states. + // // - switching-over – This status covers the range of Aurora internal operations // that take place during the switchover process, such as demoting the primary // Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing @@ -2968,14 +3322,24 @@ type FailoverState 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 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: +// operation are documented with the describe operation. +// +// Currently, wildcards are not supported in filters. +// +// The following actions can be filtered: +// // - DescribeDBClusterBacktracks +// // - DescribeDBClusterEndpoints +// // - DescribeDBClusters +// // - DescribeDBInstances +// // - DescribeDBRecommendations +// // - DescribeDBShardGroups +// // - DescribePendingMaintenanceActions type Filter struct { @@ -3064,9 +3428,10 @@ type GlobalClusterMember struct { // A zero-ETL integration with Amazon Redshift. type Integration struct { - // The encryption context for the integration. For more information, see - // Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) - // in the Amazon Web Services Key Management Service Developer Guide. + // The encryption context for the integration. For more information, see [Encryption context] in the + // Amazon Web Services Key Management Service Developer Guide. + // + // [Encryption context]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context AdditionalEncryptionContext map[string]string // The time when the integration was created, in Universal Coordinated Time (UTC). @@ -3099,8 +3464,9 @@ type Integration struct { // The current status of the integration. Status IntegrationStatus - // 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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Tags []Tag // The ARN of the Redshift data warehouse used as the target for replication. @@ -3162,11 +3528,12 @@ type LimitlessDatabase 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) -// 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) -// in the Amazon Aurora User Guide. +// the master user password. +// +// For more information, see [Password management with Amazon Web Services Secrets Manager] in the Amazon RDS User Guide and [Password management with Amazon Web Services Secrets Manager] in the Amazon +// Aurora User Guide. +// +// [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html type MasterUserSecret struct { // The Amazon Web Services KMS key identifier that is used to encrypt the secret. @@ -3175,17 +3542,25 @@ type MasterUserSecret struct { // The Amazon Resource Name (ARN) of the secret. SecretArn *string - // The status of the secret. The possible status values include the following: + // 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. + // 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 @@ -3514,8 +3889,10 @@ type OptionVersion struct { noSmithyDocumentSerde } -// Contains a list of available options for a DB instance. This data type is used -// as a response element in the DescribeOrderableDBInstanceOptions action. +// Contains a list of available options for a DB instance. +// +// This data type is used as a response element in the +// DescribeOrderableDBInstanceOptions action. type OrderableDBInstanceOption struct { // The Availability Zone group for a DB instance. @@ -3573,9 +3950,11 @@ type OrderableDBInstanceOption struct { // Indicates whether a DB instance is Multi-AZ capable. MultiAZCapable *bool - // Indicates 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. + // Indicates whether a DB instance supports RDS on Outposts. + // + // For more information about RDS on Outposts, see [Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. + // + // [Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html OutpostCapable *bool // Indicates whether a DB instance can have a read replica. @@ -3593,16 +3972,22 @@ 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) - // in the Amazon RDS User Guide. + // 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] in the Amazon RDS User Guide. + // + // [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html SupportedNetworkTypes []string - // Indicates 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) - // in the Amazon RDS User Guide. + // Indicates 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] in the Amazon RDS User + // Guide. + // + // [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html SupportsClusters *bool // Indicates whether a DB instance supports using a dedicated log volume (DLV). @@ -3644,9 +4029,11 @@ type OrderableDBInstanceOption struct { noSmithyDocumentSerde } -// 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. +// A data type that represents an Outpost. +// +// For more information about RDS on Outposts, see [Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. +// +// [Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html type Outpost struct { // The Amazon Resource Name (ARN) of the Outpost. @@ -3656,8 +4043,10 @@ type Outpost struct { } // This data type is used as a request parameter in the ModifyDBParameterGroup and -// ResetDBParameterGroup actions. This data type is used as a response element in -// the DescribeEngineDefaultParameters and DescribeDBParameters actions. +// ResetDBParameterGroup actions. +// +// This data type is used as a response element in the +// DescribeEngineDefaultParameters and DescribeDBParameters actions. type Parameter struct { // Specifies the valid range of values for the parameter. @@ -3736,10 +4125,12 @@ type PendingMaintenanceAction struct { // 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. @@ -3764,11 +4155,13 @@ type PendingModifiedValues struct { // 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) - // in the Amazon Aurora User Guide. + // 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] in the Amazon RDS User Guide and [Using SSL/TLS to encrypt a connection to a DB cluster] in the Amazon + // Aurora User Guide. + // + // [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 CACertificateIdentifier *string // The name of the compute and memory capacity class for the DB instance. @@ -3796,8 +4189,9 @@ type PendingModifiedValues struct { // The Provisioned IOPS value for the DB instance. Iops *int32 - // The license model for the DB instance. Valid values: license-included | - // bring-your-own-license | general-public-license + // The license model for the DB instance. + // + // Valid values: license-included | bring-your-own-license | general-public-license LicenseModel *string // The master credentials for the DB instance. @@ -3838,12 +4232,16 @@ type PendingModifiedValues 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. // @@ -3869,7 +4267,10 @@ type PerformanceInsightsMetricDimensionGroup struct { // metric to the query. If other parameters aren't specified, Performance Insights // returns all data points for the specified metric. Optionally, you can request // the data points to be aggregated by dimension group ( GroupBy ) and return only -// those data points that match your criteria ( Filter ). Constraints: +// those data points that match your criteria ( Filter ). +// +// Constraints: +// // - Must be a valid Performance Insights query. type PerformanceInsightsMetricQuery struct { @@ -3880,19 +4281,26 @@ type PerformanceInsightsMetricQuery struct { // return a limited number of values for a dimension. GroupBy *PerformanceInsightsMetricDimensionGroup - // The name of a Performance Insights metric to be measured. Valid Values: + // The name of a Performance Insights metric to be measured. + // + // Valid Values: + // // - 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. + // + // - The counter metrics listed in [Performance Insights operating system counters]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. + // + // [Performance Insights operating system counters]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS Metric *string noSmithyDocumentSerde @@ -3916,34 +4324,51 @@ type PerformanceIssueDetails 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 -// parameter. You can set the processor features of the DB instance class for a DB -// instance when you call one of the following actions: +// 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 // // 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: +// 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) -// in the Amazon RDS User Guide. +// For more information, see [Configuring the Processor of the DB Instance Class] in the Amazon RDS User Guide. +// +// [Configuring the Processor of the DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor type ProcessorFeature struct { // The name of the processor feature. Valid names are coreCount and threadsPerCore . @@ -3995,9 +4420,14 @@ type RecommendedAction struct { // The unique identifier of the recommended action. ActionId *string - // The methods to apply the recommended action. Valid values: + // The methods to apply the recommended action. + // + // Valid values: + // // - manual - The action requires you to resolve the recommendation manually. + // // - immediately - The action is applied immediately. + // // - next-maintainance-window - The action is applied during the next scheduled // maintainance. ApplyModes []string @@ -4018,9 +4448,13 @@ type RecommendedAction struct { Parameters []RecommendedActionParameter // The status of the action. + // // - ready + // // - applied + // // - scheduled + // // - resolved Status *string @@ -4053,7 +4487,9 @@ type RecommendedActionUpdate struct { ActionId *string // The status of the updated recommendation action. + // // - applied + // // - scheduled // // This member is required. @@ -4104,8 +4540,9 @@ type ReservedDBInstance struct { FixedPrice *float64 // The unique identifier for the lease associated with the reserved DB instance. - // Amazon Web Services Support might request the lease ID for an issue related to a - // reserved DB instance. + // + // Amazon Web Services Support might request the lease ID for an issue related to + // a reserved DB instance. LeaseId *string // Indicates whether the reservation applies to Multi-AZ deployments. @@ -4212,62 +4649,88 @@ type ScalarReferenceDetails struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Aurora User Guide. +// Contains the scaling configuration of an Aurora Serverless v1 DB cluster. +// +// For more information, see [Using Amazon Aurora Serverless v1] in the Amazon Aurora User Guide. +// +// [Using Amazon Aurora Serverless v1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html type ScalingConfiguration struct { // Indicates whether to allow or disallow automatic pause for an Aurora DB cluster // in serverless DB engine mode. A DB cluster can be paused only when it's idle - // (it has no connections). If a DB cluster is paused for more than seven days, the - // DB cluster might be backed up with a snapshot. In this case, the DB cluster is - // restored when there is a request to connect to it. + // (it has no connections). + // + // If a DB cluster is paused for more than seven days, the DB cluster might be + // backed up with a snapshot. In this case, the DB cluster is restored when there + // is a request to connect to it. 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. + // 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. 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. + // 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. MinCapacity *int32 // The amount of time, in seconds, that Aurora Serverless v1 tries to find a // scaling point to perform seamless scaling before enforcing the timeout action. - // The default is 300. Specify a value between 60 and 600 seconds. + // The default is 300. + // + // Specify a value between 60 and 600 seconds. SecondsBeforeTimeout *int32 // The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + // // Specify a value between 300 and 86,400 seconds. 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, - // 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) - // in the Amazon Aurora User Guide. + // 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] in the Amazon Aurora User Guide. + // + // [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 TimeoutAction *string noSmithyDocumentSerde } -// 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. +// The scaling configuration for an Aurora DB cluster in serverless DB engine mode. +// +// For more information, see [Using Amazon Aurora Serverless v1] in the Amazon Aurora User Guide. +// +// [Using Amazon Aurora Serverless v1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html type ScalingConfigurationInfo struct { // Indicates whether automatic pause is allowed for the Aurora DB cluster in - // serverless DB engine mode. When the value is set to false for an Aurora - // Serverless v1 DB cluster, the DB cluster automatically resumes. + // serverless DB engine mode. + // + // When the value is set to false for an Aurora Serverless v1 DB cluster, the DB + // cluster automatically resumes. AutoPause *bool // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. @@ -4287,8 +4750,11 @@ 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 , - // the default, sets the capacity to the specified value as soon as possible. + // 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. TimeoutAction *string @@ -4296,9 +4762,11 @@ type ScalingConfigurationInfo struct { noSmithyDocumentSerde } -// 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) -// in the Amazon Aurora User Guide. +// Contains the scaling configuration of an Aurora Serverless v2 DB cluster. +// +// For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. +// +// [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html type ServerlessV2ScalingConfiguration struct { // The maximum number of Aurora capacity units (ACUs) for a DB instance in an @@ -4316,9 +4784,11 @@ type ServerlessV2ScalingConfiguration struct { noSmithyDocumentSerde } -// 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. +// The scaling configuration for an Aurora Serverless v2 DB cluster. +// +// For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide. +// +// [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html type ServerlessV2ScalingConfigurationInfo struct { // The maximum number of Aurora capacity units (ACUs) for a DB instance in an @@ -4360,17 +4830,19 @@ type SourceRegion struct { // operation. type Subnet struct { - // Contains Availability Zone information. This data type is used as an element in - // the OrderableDBInstanceOption data type. + // Contains Availability Zone information. + // + // This data type is used as an element in the OrderableDBInstanceOption data type. SubnetAvailabilityZone *AvailabilityZone // The identifier of the subnet. SubnetIdentifier *string // 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. + // + // For more information about RDS on Outposts, see [Amazon RDS on Amazon Web Services Outposts] in the Amazon RDS User Guide. + // + // [Amazon RDS on Amazon Web Services Outposts]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html SubnetOutpost *Outpost // The status of the subnet. @@ -4379,23 +4851,33 @@ type Subnet struct { 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) -// in the Amazon Aurora User Guide. +// Contains the details about a blue/green deployment. +// +// For more information, see [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon RDS User Guide and [Using Amazon RDS Blue/Green Deployments for database updates] in the Amazon +// Aurora User Guide. +// +// [Using Amazon RDS Blue/Green Deployments for database updates]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html type SwitchoverDetail struct { // The Amazon Resource Name (ARN) of a resource in the blue environment. SourceMember *string - // The switchover status of a resource in a blue/green deployment. Values: + // 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. Status *string @@ -4405,9 +4887,11 @@ type SwitchoverDetail struct { noSmithyDocumentSerde } -// 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. +// Metadata assigned to an Amazon RDS resource consisting of a key-value pair. +// +// For more information, see [Tagging Amazon RDS Resources] in the Amazon RDS User Guide. +// +// [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html type Tag struct { // A key is the required name of the tag. The string value can be from 1 to 128 @@ -4439,7 +4923,9 @@ type TargetHealth struct { // The current state of the connection health lifecycle for the RDS Proxy target. // The following is a typical lifecycle example for the states of an RDS Proxy - // target: registering > unavailable > available > unavailable > available + // target: + // + // registering > unavailable > available > unavailable > available State TargetState noSmithyDocumentSerde @@ -4473,8 +4959,9 @@ type TenantDatabase struct { // The status of the tenant database. Status *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] in the Amazon RDS User Guide. + // + // [Tagging Amazon RDS Resources]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html TagList []Tag // The database name of the tenant database. @@ -4557,8 +5044,9 @@ type UpgradeTarget struct { // Indicates whether the target engine version supports forwarding write // operations from reader DB instances to the writer DB instance in the DB cluster. - // By default, write operations aren't allowed on reader DB instances. Valid for: - // Aurora DB clusters only + // By default, write operations aren't allowed on reader DB instances. + // + // Valid for: Aurora DB clusters only SupportsLocalWriteForwarding *bool // Indicates whether you can use Aurora parallel query with the target engine @@ -4687,8 +5175,9 @@ type ValidStorageOptions struct { // membership. type VpcSecurityGroupMembership struct { - // The membership status of the VPC security group. Currently, the only valid - // status is active . + // The membership status of the VPC security group. + // + // Currently, the only valid status is active . Status *string // The name of the VPC security group. diff --git a/service/rdsdata/api_op_BatchExecuteStatement.go b/service/rdsdata/api_op_BatchExecuteStatement.go index 6845dd702c6..561bb462983 100644 --- a/service/rdsdata/api_op_BatchExecuteStatement.go +++ b/service/rdsdata/api_op_BatchExecuteStatement.go @@ -11,20 +11,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs a batch SQL statement over an array of data. You can run bulk update and -// 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 -// 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 -// than 1 MiB of response data, the call is terminated. +// Runs a batch SQL statement over an array of data. +// +// You can run bulk update and 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 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 than 1 MiB of +// response data, the call is terminated. func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) { if params == nil { params = &BatchExecuteStatementInput{} @@ -50,9 +57,11 @@ type BatchExecuteStatementInput struct { ResourceArn *string // 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) - // . + // user name and password for the credentials in the secret. + // + // For information about creating the secret, see [Create a database secret]. + // + // [Create a database secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html // // This member is required. SecretArn *string @@ -66,23 +75,30 @@ 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: + // 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 - // The name of the database schema. Currently, the schema parameter isn't - // supported. + // The name of the database schema. + // + // Currently, the schema parameter isn't supported. Schema *string // The identifier of a transaction that was started by using the BeginTransaction // operation. Specify the transaction ID of the transaction that you want to - // include the SQL statement in. If the SQL statement is not part of a transaction, - // don't set this parameter. + // include the SQL statement in. + // + // If the SQL statement is not part of a transaction, don't set this parameter. TransactionId *string noSmithyDocumentSerde diff --git a/service/rdsdata/api_op_BeginTransaction.go b/service/rdsdata/api_op_BeginTransaction.go index 043d3a09d88..979eeb3f785 100644 --- a/service/rdsdata/api_op_BeginTransaction.go +++ b/service/rdsdata/api_op_BeginTransaction.go @@ -10,12 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A -// transaction is terminated and rolled back automatically after 24 hours. A -// transaction times out if no calls use its transaction ID in three minutes. If a -// transaction times out before it's committed, it's rolled back automatically. DDL -// statements inside a transaction cause an implicit commit. We recommend that you -// run each DDL statement in a separate ExecuteStatement call with +// Starts a SQL transaction. +// +// A transaction can run for a maximum of 24 hours. A transaction is terminated +// and rolled back automatically after 24 hours. +// +// A transaction times out if no calls use its transaction ID in three minutes. If +// a transaction times out before it's committed, it's rolled back automatically. +// +// DDL statements inside a transaction cause an implicit commit. We recommend that +// you run each DDL statement in a separate ExecuteStatement call with // continueAfterTimeout enabled. func (c *Client) BeginTransaction(ctx context.Context, params *BeginTransactionInput, optFns ...func(*Options)) (*BeginTransactionOutput, error) { if params == nil { diff --git a/service/rdsdata/api_op_ExecuteSql.go b/service/rdsdata/api_op_ExecuteSql.go index c3bdafaf54b..43675957bfc 100644 --- a/service/rdsdata/api_op_ExecuteSql.go +++ b/service/rdsdata/api_op_ExecuteSql.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Runs one or more SQL statements. This operation isn't supported for Aurora -// PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless -// v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or -// ExecuteStatement operation. +// Runs one or more SQL statements. +// +// This operation isn't supported for Aurora PostgreSQL Serverless v2 and +// provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the operation +// is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation. // // Deprecated: The ExecuteSql API is deprecated, please use the ExecuteStatement // API. @@ -39,8 +40,11 @@ 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]. + // + // [Create a database secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html // // This member is required. AwsSecretStoreArn *string @@ -50,9 +54,11 @@ type ExecuteSqlInput struct { // This member is required. DbClusterOrInstanceArn *string - // One or more SQL statements to run on the DB cluster. You can separate SQL - // statements from each other with a semicolon (;). Any valid SQL statement is - // permitted, including data definition, data manipulation, and commit statements. + // One or more SQL statements to run on the DB cluster. + // + // You can separate SQL statements from each other with a semicolon (;). Any valid + // SQL statement is permitted, including data definition, data manipulation, and + // commit statements. // // This member is required. SqlStatements *string diff --git a/service/rdsdata/api_op_ExecuteStatement.go b/service/rdsdata/api_op_ExecuteStatement.go index 73d24209502..ea70a48794b 100644 --- a/service/rdsdata/api_op_ExecuteStatement.go +++ b/service/rdsdata/api_op_ExecuteStatement.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// database is more than 1 MB, the call is terminated. +// 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 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 { params = &ExecuteStatementInput{} @@ -40,9 +44,11 @@ type ExecuteStatementInput struct { ResourceArn *string // 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) - // . + // user name and password for the credentials in the secret. + // + // For information about creating the secret, see [Create a database secret]. + // + // [Create a database secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html // // This member is required. SecretArn *string @@ -53,8 +59,9 @@ type ExecuteStatementInput struct { Sql *string // A value that indicates whether to continue running the statement after the call - // times out. By default, the statement stops running when the call times out. For - // DDL statements, we recommend continuing to run the statement after the call + // times out. By default, the statement stops running when the call times out. + // + // For DDL statements, we recommend continuing to run the statement after the call // times out. When a DDL statement terminates before it is finished running, it can // result in errors and possibly corrupted data structures. ContinueAfterTimeout bool @@ -65,28 +72,35 @@ type ExecuteStatementInput struct { // 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. + // 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] in the Amazon + // Aurora User Guide. + // + // [Using the Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html FormatRecordsAs types.RecordsFormatType // A value that indicates whether to include metadata in the results. IncludeResultMetadata bool - // The parameters for the SQL statement. Array parameters are not supported. + // The parameters for the SQL statement. + // + // Array parameters are not supported. Parameters []types.SqlParameter // Options that control how the result set is returned. ResultSetOptions *types.ResultSetOptions - // The name of the database schema. Currently, the schema parameter isn't - // supported. + // The name of the database schema. + // + // Currently, the schema parameter isn't supported. Schema *string // The identifier of a transaction that was started by using the BeginTransaction // operation. Specify the transaction ID of the transaction that you want to - // include the SQL statement in. If the SQL statement is not part of a transaction, - // don't set this parameter. + // include the SQL statement in. + // + // If the SQL statement is not part of a transaction, don't set this parameter. TransactionId *string noSmithyDocumentSerde @@ -102,16 +116,19 @@ type ExecuteStatementOutput struct { // 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 - // string representing the result set requires more than 10 MB, the call returns an - // error. + // 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 - // documentation. + // 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] + // in the PostgreSQL documentation. + // + // [Returning Data From Modified Rows]: https://www.postgresql.org/docs/10/dml-returning.html GeneratedFields []types.Field // The number of records updated by the request. diff --git a/service/rdsdata/doc.go b/service/rdsdata/doc.go index cc183cd6e2e..191faf91de9 100644 --- a/service/rdsdata/doc.go +++ b/service/rdsdata/doc.go @@ -3,12 +3,18 @@ // Package rdsdata provides the API client, operations, and parameter types for // AWS RDS DataService. // -// RDS Data API Amazon RDS provides an HTTP endpoint to run SQL statements on an -// Amazon Aurora DB cluster. To run these statements, you use the RDS Data API -// (Data API). Data API is available with the following types of Aurora databases: +// # RDS Data API +// +// Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora +// DB cluster. To run these statements, you use the RDS Data API (Data API). +// +// Data API is available with the following types of Aurora databases: +// // - Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned +// // - Aurora MySQL - Serverless v1 only // -// For more information about the Data API, see Using RDS Data API (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) -// in the Amazon Aurora User Guide. +// For more information about the Data API, see [Using RDS Data API] in the Amazon Aurora User Guide. +// +// [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html package rdsdata diff --git a/service/rdsdata/options.go b/service/rdsdata/options.go index 3d459c5681a..47be1b4399a 100644 --- a/service/rdsdata/options.go +++ b/service/rdsdata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/rdsdata/types/enums.go b/service/rdsdata/types/enums.go index 4b7071114a5..62db0523b06 100644 --- a/service/rdsdata/types/enums.go +++ b/service/rdsdata/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for DecimalReturnType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DecimalReturnType) Values() []DecimalReturnType { return []DecimalReturnType{ "STRING", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for LongReturnType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LongReturnType) Values() []LongReturnType { return []LongReturnType{ "STRING", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for RecordsFormatType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordsFormatType) Values() []RecordsFormatType { return []RecordsFormatType{ "NONE", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for TypeHint. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TypeHint) Values() []TypeHint { return []TypeHint{ "JSON", diff --git a/service/rdsdata/types/errors.go b/service/rdsdata/types/errors.go index 0a34dec653f..cdedfdb1b01 100644 --- a/service/rdsdata/types/errors.go +++ b/service/rdsdata/types/errors.go @@ -270,8 +270,11 @@ func (e *NotFoundException) ErrorFault() smithy.ErrorFault { return smithy.Fault // There was a problem with the Secrets Manager secret used with the request, // caused by one of the following conditions: +// // - RDS Data API timed out retrieving the secret. +// // - The secret provided wasn't found. +// // - The secret couldn't be decrypted. type SecretsErrorException struct { Message *string @@ -379,8 +382,11 @@ func (e *TransactionNotFoundException) ErrorCode() string { func (e *TransactionNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // There was a problem with the result because of one of the following conditions: +// // - It contained an unsupported data type. +// // - It contained a multidimensional array. +// // - The size was too large. type UnsupportedResultException struct { Message *string diff --git a/service/rdsdata/types/types.go b/service/rdsdata/types/types.go index f488a76ef05..8011dade5fb 100644 --- a/service/rdsdata/types/types.go +++ b/service/rdsdata/types/types.go @@ -190,9 +190,10 @@ type FieldMemberStringValue struct { func (*FieldMemberStringValue) isField() {} -// A record returned by a call. This data structure is only used with the -// deprecated ExecuteSql operation. Use the BatchExecuteStatement or -// ExecuteStatement operation instead. +// A record returned by a call. +// +// This data structure is only used with the deprecated ExecuteSql operation. Use +// the BatchExecuteStatement or ExecuteStatement operation instead. type Record struct { // The values returned in the record. @@ -201,9 +202,10 @@ type Record struct { noSmithyDocumentSerde } -// The result set returned by a SQL statement. This data structure is only used -// with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or -// ExecuteStatement operation instead. +// The result set returned by a SQL statement. +// +// This data structure is only used with the deprecated ExecuteSql operation. Use +// the BatchExecuteStatement or ExecuteStatement operation instead. type ResultFrame struct { // The records in the result set. @@ -233,9 +235,11 @@ 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 // 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 - // converting to String, especially when working with currency values. + // 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 converting to String, especially when working with currency + // values. DecimalReturnType DecimalReturnType // A value that indicates how a field of LONG type is represented. Allowed values @@ -254,17 +258,23 @@ 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. TypeHint TypeHint @@ -275,9 +285,10 @@ type SqlParameter struct { noSmithyDocumentSerde } -// The result of a SQL statement. This data structure is only used with the -// deprecated ExecuteSql operation. Use the BatchExecuteStatement or -// ExecuteStatement operation instead. +// The result of a SQL statement. +// +// This data structure is only used with the deprecated ExecuteSql operation. Use +// the BatchExecuteStatement or ExecuteStatement operation instead. type SqlStatementResult struct { // The number of records updated by a SQL statement. @@ -289,9 +300,10 @@ type SqlStatementResult struct { noSmithyDocumentSerde } -// A structure value returned by a call. This data structure is only used with the -// deprecated ExecuteSql operation. Use the BatchExecuteStatement or -// ExecuteStatement operation instead. +// A structure value returned by a call. +// +// This data structure is only used with the deprecated ExecuteSql operation. Use +// the BatchExecuteStatement or ExecuteStatement operation instead. type StructValue struct { // The attributes returned in the record. @@ -309,9 +321,10 @@ type UpdateResult struct { noSmithyDocumentSerde } -// Contains the value of a column. This data structure is only used with the -// deprecated ExecuteSql operation. Use the BatchExecuteStatement or -// ExecuteStatement operation instead. +// Contains the value of a column. +// +// This data structure is only used with the deprecated ExecuteSql operation. Use +// the BatchExecuteStatement or ExecuteStatement operation instead. // // The following types satisfy this interface: // diff --git a/service/redshift/api_op_AcceptReservedNodeExchange.go b/service/redshift/api_op_AcceptReservedNodeExchange.go index dcad10510ea..d5bf62363df 100644 --- a/service/redshift/api_op_AcceptReservedNodeExchange.go +++ b/service/redshift/api_op_AcceptReservedNodeExchange.go @@ -37,8 +37,7 @@ type AcceptReservedNodeExchangeInput struct { ReservedNodeId *string // The unique identifier of the DC2 Reserved Node offering to be used for the - // exchange. You can obtain the value for the parameter by calling - // GetReservedNodeExchangeOfferings + // exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings // // This member is required. TargetReservedNodeOfferingId *string diff --git a/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go b/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go index 622e25a091a..64d8339dcba 100644 --- a/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go +++ b/service/redshift/api_op_AuthorizeClusterSecurityGroupIngress.go @@ -16,16 +16,22 @@ import ( // an Amazon EC2 instance, you can authorize inbound access to either a Classless // Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 // security group. You can add as many as 20 ingress rules to an Amazon Redshift -// security group. If you authorize access to an Amazon EC2 security group, specify +// security group. +// +// If you authorize access to an Amazon EC2 security group, specify // 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 +// 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]. +// +// 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. +// the cluster. For information about managing security groups, go to [Working with Security Groups]in the +// Amazon Redshift Cluster Management Guide. +// +// [Classless Inter-Domain Routing]: http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing +// [Working with Security Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html func (c *Client) AuthorizeClusterSecurityGroupIngress(ctx context.Context, params *AuthorizeClusterSecurityGroupIngressInput, optFns ...func(*Options)) (*AuthorizeClusterSecurityGroupIngressOutput, error) { if params == nil { params = &AuthorizeClusterSecurityGroupIngressInput{} @@ -56,7 +62,9 @@ type AuthorizeClusterSecurityGroupIngressInput struct { // The Amazon Web Services account number of the owner of the security group // specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access - // Key ID is not an acceptable value. Example: 111122223333 + // Key ID is not an acceptable value. + // + // Example: 111122223333 EC2SecurityGroupOwnerId *string noSmithyDocumentSerde diff --git a/service/redshift/api_op_AuthorizeSnapshotAccess.go b/service/redshift/api_op_AuthorizeSnapshotAccess.go index bf3d9cbc7d4..2ace5b346c2 100644 --- a/service/redshift/api_op_AuthorizeSnapshotAccess.go +++ b/service/redshift/api_op_AuthorizeSnapshotAccess.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// snapshot. +// +// For more information about working with snapshots, go to [Amazon Redshift Snapshots] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Snapshots]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html func (c *Client) AuthorizeSnapshotAccess(ctx context.Context, params *AuthorizeSnapshotAccessInput, optFns ...func(*Options)) (*AuthorizeSnapshotAccessOutput, error) { if params == nil { params = &AuthorizeSnapshotAccessInput{} @@ -33,8 +36,10 @@ func (c *Client) AuthorizeSnapshotAccess(ctx context.Context, params *AuthorizeS type AuthorizeSnapshotAccessInput struct { // The identifier of the Amazon Web Services account authorized to restore the - // specified snapshot. To share a snapshot with Amazon Web Services Support, - // specify amazon-redshift-support. + // specified snapshot. + // + // To share a snapshot with Amazon Web Services Support, specify + // amazon-redshift-support. // // This member is required. AccountWithRestoreAccess *string @@ -43,9 +48,11 @@ type AuthorizeSnapshotAccessInput struct { SnapshotArn *string // The identifier of the cluster the snapshot was created from. + // // - If the snapshot to access doesn't exist and the associated IAM policy // doesn't allow access to all (*) snapshots - This parameter is required. // Otherwise, permissions aren't available to check if the snapshot exists. + // // - If the snapshot to access exists - This parameter isn't required. Redshift // can retrieve the cluster identifier and use it to validate snapshot // authorization. diff --git a/service/redshift/api_op_BatchModifyClusterSnapshots.go b/service/redshift/api_op_BatchModifyClusterSnapshots.go index 1ec2b0bb5f1..90f74dc817a 100644 --- a/service/redshift/api_op_BatchModifyClusterSnapshots.go +++ b/service/redshift/api_op_BatchModifyClusterSnapshots.go @@ -39,11 +39,14 @@ type BatchModifyClusterSnapshotsInput struct { Force *bool // The number of days that a manual snapshot is retained. If you specify the value - // -1, the manual snapshot is retained indefinitely. The number must be either -1 - // or an integer between 1 and 3,653. If you decrease the manual snapshot retention - // period from its current value, existing manual snapshots that fall outside of - // the new retention period will return an error. If you want to suppress the - // errors and delete the snapshots, use the force option. + // -1, the manual snapshot is retained indefinitely. + // + // The number must be either -1 or an integer between 1 and 3,653. + // + // If you decrease the manual snapshot retention period from its current value, + // existing manual snapshots that fall outside of the new retention period will + // return an error. If you want to suppress the errors and delete the snapshots, + // use the force option. ManualSnapshotRetentionPeriod *int32 noSmithyDocumentSerde diff --git a/service/redshift/api_op_CancelResize.go b/service/redshift/api_op_CancelResize.go index 67b90415c5f..5fa7b398964 100644 --- a/service/redshift/api_op_CancelResize.go +++ b/service/redshift/api_op_CancelResize.go @@ -59,16 +59,19 @@ type CancelResizeOutput struct { // complete, this value will be 0. EstimatedTimeToCompletionInSeconds *int64 - // The names of tables that have been completely imported . Valid Values: List of - // table names. + // The names of tables that have been completely imported . + // + // Valid Values: List of table names. ImportTablesCompleted []string - // The names of tables that are being currently imported. Valid Values: List of - // table names. + // The names of tables that are being currently imported. + // + // Valid Values: List of 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. @@ -85,16 +88,19 @@ type CancelResizeOutput struct { // describe the type of resize operation being performed. ResizeType *string - // The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | - // SUCCEEDED | CANCELLING + // The status of the resize operation. + // + // Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING Status *string - // The cluster type after the resize operation is complete. Valid Values: - // multi-node | single-node + // The cluster type after the resize operation is complete. + // + // Valid Values: multi-node | single-node TargetClusterType *string - // The type of encryption for the cluster after the resize is complete. Possible - // values are KMS and None . + // The type of encryption for the cluster after the resize is complete. + // + // Possible 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 b2e3e0e4820..06912120480 100644 --- a/service/redshift/api_op_CopyClusterSnapshot.go +++ b/service/redshift/api_op_CopyClusterSnapshot.go @@ -13,13 +13,18 @@ import ( // Copies the specified automated cluster snapshot to a new manual cluster // snapshot. The source must be an automated snapshot and it must be in the -// available state. When you delete a cluster, Amazon Redshift deletes any -// automated snapshots of the cluster. Also, when the retention period of the -// 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) -// in the Amazon Redshift Cluster Management Guide. +// available state. +// +// When you delete a cluster, Amazon Redshift deletes any automated snapshots of +// the cluster. Also, when the retention period of the 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] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Snapshots]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html func (c *Client) CopyClusterSnapshot(ctx context.Context, params *CopyClusterSnapshotInput, optFns ...func(*Options)) (*CopyClusterSnapshotOutput, error) { if params == nil { params = &CopyClusterSnapshotInput{} @@ -37,18 +42,28 @@ func (c *Client) CopyClusterSnapshot(ctx context.Context, params *CopyClusterSna type CopyClusterSnapshotInput struct { - // The identifier for the source snapshot. Constraints: + // The identifier for the source snapshot. + // + // Constraints: + // // - 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: + // 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. // @@ -56,14 +71,19 @@ type CopyClusterSnapshotInput struct { TargetSnapshotIdentifier *string // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. The default value is -1. + // manual snapshot is retained indefinitely. + // + // The value must be either -1 or an integer between 1 and 3,653. + // + // The default value is -1. ManualSnapshotRetentionPeriod *int32 // The identifier of the cluster the source snapshot was created from. This // parameter is required if your IAM user 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. SourceSnapshotClusterIdentifier *string diff --git a/service/redshift/api_op_CreateCluster.go b/service/redshift/api_op_CreateCluster.go index 47f548a15e6..00dcd95d216 100644 --- a/service/redshift/api_op_CreateCluster.go +++ b/service/redshift/api_op_CreateCluster.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new cluster with the specified parameters. To create a cluster in -// 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. +// Creates a new cluster with the specified parameters. +// +// To create a cluster in 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]in the Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -36,37 +38,55 @@ 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: + // 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. + // // Example: myexamplecluster // // This member is required. ClusterIdentifier *string // The user name associated with the admin user account for the cluster that is - // being created. Constraints: + // 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. + // + // - Cannot be a reserved word. A list of reserved words can be found in [Reserved Words]in the + // Amazon Redshift Database Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html // // 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) - // 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 + // types, go to [Working with Clusters]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 + // + // [Working with Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes // // This member is required. NodeType *string @@ -75,10 +95,13 @@ type CreateClusterInput struct { AdditionalInfo *string // 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 + // 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. @@ -88,86 +111,133 @@ type CreateClusterInput struct { // 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'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. + // 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. AutomatedSnapshotRetentionPeriod *int32 // The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision // the cluster. For example, if you have several EC2 instances running in a // specific Availability Zone, then you might want the cluster to be provisioned in - // the same zone in order to decrease network latency. Default: A random, - // system-chosen Availability Zone in the region that is specified by the endpoint. - // Example: us-east-2d Constraint: The specified Availability Zone must be in the - // same region as the current endpoint. + // the same zone in order to decrease network latency. + // + // Default: A random, system-chosen Availability Zone in the region that is + // specified by the endpoint. + // + // Example: us-east-2d + // + // Constraint: The specified Availability Zone must be in the same region as the + // current endpoint. AvailabilityZone *string // The option to enable relocation for an Amazon Redshift cluster between // 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] + // // 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. + // + // [Working with Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html ClusterParameterGroupName *string - // A list of security groups to be associated with this cluster. Default: The - // default cluster security group for Amazon Redshift. + // A list of security groups to be associated with this cluster. + // + // Default: The default cluster security group for Amazon Redshift. ClusterSecurityGroups []string - // The name of a cluster subnet group to be associated with this cluster. If this - // parameter is not provided the resulting cluster will be deployed outside virtual - // private cloud (VPC). + // The name of a cluster subnet group to be associated with this cluster. + // + // If this parameter is not provided the resulting cluster will be deployed + // outside virtual private cloud (VPC). 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 + // + // 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 - // the cluster. The version selected runs on all the nodes in the cluster. - // Constraints: Only version 1.0 is currently available. Example: 1.0 + // the cluster. + // + // The version selected runs on all the nodes in the cluster. + // + // Constraints: Only version 1.0 is currently available. + // + // Example: 1.0 ClusterVersion *string - // 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: + // 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]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. + // can be found in [Reserved Words]in the Amazon Redshift Database Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html + // [Create a Database]: https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html DBName *string // The Amazon Resource Name (ARN) for the IAM role that was set as default for the // cluster when the cluster was created. DefaultIamRoleArn *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. - // 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) - // in the Amazon Redshift Cluster Management Guide. + // The Elastic IP (EIP) address for the cluster. + // + // Constraints: The cluster must be 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]in the Amazon + // Redshift Cluster Management Guide. + // + // [Supported Platforms to Launch Your Cluster]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms 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 + // must be in a VPC. For more information, see [Enhanced VPC Routing]in the Amazon Redshift Cluster + // Management Guide. + // + // If this option is true , enhanced VPC routing is enabled. + // + // Default: false + // + // [Enhanced VPC Routing]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html EnhancedVpcRouting *bool // Specifies the name of the HSM client certificate the Amazon Redshift cluster @@ -180,10 +250,12 @@ type CreateClusterInput struct { // A list of Identity and Access Management (IAM) roles that can be used by the // 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) - // in the Amazon Redshift Cluster Management Guide. + // 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]in the Amazon Redshift Cluster Management Guide. + // + // [Quotas and limits]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html IamRoles []string // The IP address types that the cluster supports. Possible values are ipv4 and @@ -210,8 +282,9 @@ type CreateClusterInput struct { // 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. The value must be either -1 or an integer between - // 1 and 3,653. + // period of existing snapshots. + // + // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 // The ID of the Key Management Service (KMS) key used to encrypt and store the @@ -220,12 +293,20 @@ type CreateClusterInput struct { MasterPasswordSecretKmsKeyId *string // The password associated with the admin user account for the cluster that is - // being created. You can't use MasterUserPassword if ManageMasterPassword is true - // . Constraints: + // being created. + // + // You can't use MasterUserPassword if ManageMasterPassword is true . + // + // 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 @ . MasterUserPassword *string @@ -234,32 +315,54 @@ type CreateClusterInput struct { MultiAZ *bool // 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) - // 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 + // ClusterType parameter is specified as multi-node . + // + // For information about determining how many nodes you need, go to [Working with Clusters] 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 + // // Constraints: Value must be at least 1 and no more than 100. + // + // [Working with Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes NumberOfNodes *int32 - // The port number on which the cluster accepts incoming connections. The cluster - // is accessible only via the JDBC and ODBC connection strings. Part of the - // connection string requires the port on which the cluster will listen for - // incoming connections. Default: 5439 Valid Values: + // The port number on which the cluster accepts incoming connections. + // + // The cluster is accessible only via the JDBC and ODBC connection strings. Part + // of the connection string requires the port on which the cluster will listen for + // incoming connections. + // + // Default: 5439 + // + // Valid Values: + // // - For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or // 8191-8215 . (If you have an existing cluster with ra3 nodes, it isn't required // that you change the port to these ranges.) + // // - For clusters with ds2 or dc2 nodes - Select a port within the range // 1150-65535 . Port *int32 // The weekly time range (in UTC) during which automated cluster maintenance can - // 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) - // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | - // Fri | Sat | Sun Constraints: Minimum 30-minute window. + // 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]in Amazon Redshift Cluster Management Guide. + // + // Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun + // + // Constraints: Minimum 30-minute window. + // + // [Maintenance Windows]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows PreferredMaintenanceWindow *string // If true , the cluster can be accessed from a public network. @@ -276,7 +379,9 @@ type CreateClusterInput struct { Tags []types.Tag // A list of Virtual Private Cloud (VPC) security groups to be associated with the - // cluster. Default: The default VPC security group is associated with the cluster. + // cluster. + // + // Default: The default VPC security group is associated with the cluster. VpcSecurityGroupIds []string noSmithyDocumentSerde diff --git a/service/redshift/api_op_CreateClusterParameterGroup.go b/service/redshift/api_op_CreateClusterParameterGroup.go index 4e45cc773b6..4b612631396 100644 --- a/service/redshift/api_op_CreateClusterParameterGroup.go +++ b/service/redshift/api_op_CreateClusterParameterGroup.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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. +// // 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) -// in the Amazon Redshift Cluster Management Guide. +// parameter groups, go to [Amazon Redshift Parameter Groups]in the Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html func (c *Client) CreateClusterParameterGroup(ctx context.Context, params *CreateClusterParameterGroupInput, optFns ...func(*Options)) (*CreateClusterParameterGroupOutput, error) { if params == nil { params = &CreateClusterParameterGroupInput{} @@ -42,23 +46,30 @@ type CreateClusterParameterGroupInput struct { 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". + // 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: + // 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. // // This member is required. diff --git a/service/redshift/api_op_CreateClusterSecurityGroup.go b/service/redshift/api_op_CreateClusterSecurityGroup.go index 43b80ed4222..3962af604dd 100644 --- a/service/redshift/api_op_CreateClusterSecurityGroup.go +++ b/service/redshift/api_op_CreateClusterSecurityGroup.go @@ -12,9 +12,12 @@ import ( ) // 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. +// control access to non-VPC clusters. +// +// For information about managing security groups, go to [Amazon Redshift Cluster Security Groups] in the Amazon Redshift +// Cluster Management Guide. +// +// [Amazon Redshift Cluster Security Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html func (c *Client) CreateClusterSecurityGroup(ctx context.Context, params *CreateClusterSecurityGroupInput, optFns ...func(*Options)) (*CreateClusterSecurityGroupOutput, error) { if params == nil { params = &CreateClusterSecurityGroupInput{} @@ -33,11 +36,17 @@ 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: + // 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. diff --git a/service/redshift/api_op_CreateClusterSnapshot.go b/service/redshift/api_op_CreateClusterSnapshot.go index b255bf915ec..c5f1cc5549b 100644 --- a/service/redshift/api_op_CreateClusterSnapshot.go +++ b/service/redshift/api_op_CreateClusterSnapshot.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// available state. +// +// For more information about working with snapshots, go to [Amazon Redshift Snapshots] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Snapshots]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html func (c *Client) CreateClusterSnapshot(ctx context.Context, params *CreateClusterSnapshotInput, optFns ...func(*Options)) (*CreateClusterSnapshotOutput, error) { if params == nil { params = &CreateClusterSnapshotInput{} @@ -39,19 +42,28 @@ 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 + // // Example: my-snapshot-id // // This member is required. SnapshotIdentifier *string // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. The default value is -1. + // manual snapshot is retained indefinitely. + // + // The value must be either -1 or an integer between 1 and 3,653. + // + // The default value is -1. ManualSnapshotRetentionPeriod *int32 // A list of tag instances. diff --git a/service/redshift/api_op_CreateClusterSubnetGroup.go b/service/redshift/api_op_CreateClusterSubnetGroup.go index 616832dfa20..c420e2b8071 100644 --- a/service/redshift/api_op_CreateClusterSubnetGroup.go +++ b/service/redshift/api_op_CreateClusterSubnetGroup.go @@ -13,9 +13,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// creating Amazon Redshift subnet group. +// +// For information about subnet groups, go to [Amazon Redshift Cluster Subnet Groups] in the Amazon Redshift Cluster +// Management Guide. +// +// [Amazon Redshift Cluster Subnet Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html func (c *Client) CreateClusterSubnetGroup(ctx context.Context, params *CreateClusterSubnetGroupInput, optFns ...func(*Options)) (*CreateClusterSubnetGroupOutput, error) { if params == nil { params = &CreateClusterSubnetGroupInput{} @@ -34,11 +37,17 @@ func (c *Client) CreateClusterSubnetGroup(ctx context.Context, params *CreateClu type CreateClusterSubnetGroupInput struct { // The name for the subnet group. Amazon Redshift stores the value as a lowercase - // string. Constraints: + // 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. + // // Example: examplesubnetgroup // // This member is required. diff --git a/service/redshift/api_op_CreateEndpointAccess.go b/service/redshift/api_op_CreateEndpointAccess.go index 9870dd92eaf..c1489becb93 100644 --- a/service/redshift/api_op_CreateEndpointAccess.go +++ b/service/redshift/api_op_CreateEndpointAccess.go @@ -30,10 +30,11 @@ func (c *Client) CreateEndpointAccess(ctx context.Context, params *CreateEndpoin type CreateEndpointAccessInput struct { - // The Redshift-managed VPC endpoint name. An endpoint name must contain 1-30 - // characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first - // character must be a letter. The name can't contain two consecutive hyphens or - // end with a hyphen. + // The Redshift-managed VPC endpoint name. + // + // An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, + // 0-9, and hyphen(-). The first character must be a letter. The name can't contain + // two consecutive hyphens or end with a hyphen. // // This member is required. EndpointName *string diff --git a/service/redshift/api_op_CreateEventSubscription.go b/service/redshift/api_op_CreateEventSubscription.go index 52146d74f7d..88a284163d4 100644 --- a/service/redshift/api_op_CreateEventSubscription.go +++ b/service/redshift/api_op_CreateEventSubscription.go @@ -15,21 +15,24 @@ import ( // 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 -// event severities. Notifications will be sent for all events you want that match -// those criteria. For example, you can specify source type = cluster, source ID = -// my-cluster-1 and mycluster2, event categories = Availability, Backup, and -// severity = ERROR. The subscription will only send notifications for those ERROR -// events in the Availability and Backup categories for the specified clusters. If -// you specify both the source type and source IDs, such as source type = cluster -// and source identifier = my-cluster-1, notifications will be sent for all the -// cluster events for my-cluster-1. If you specify a source type but do not specify -// a source identifier, you will receive notice of the events for the objects of -// that type in your Amazon Web Services account. If you do not specify either the -// SourceType nor the SourceIdentifier, you will be notified of events generated -// from all Amazon Redshift sources belonging to your Amazon Web Services account. -// You must specify a source type if you specify a source ID. +// 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 event severities. Notifications will be sent for all events you +// want that match those criteria. For example, you can specify source type = +// cluster, source ID = my-cluster-1 and mycluster2, event categories = +// Availability, Backup, and severity = ERROR. The subscription will only send +// notifications for those ERROR events in the Availability and Backup categories +// for the specified clusters. +// +// If you specify both the source type and source IDs, such as source type = +// cluster and source identifier = my-cluster-1, notifications will be sent for all +// the cluster events for my-cluster-1. If you specify a source type but do not +// specify a source identifier, you will receive notice of the events for the +// objects of that type in your Amazon Web Services account. If you do not specify +// either the SourceType nor the SourceIdentifier, you will be notified of events +// generated from all Amazon Redshift sources belonging to your Amazon Web Services +// account. You must specify a source type if you specify a source ID. func (c *Client) CreateEventSubscription(ctx context.Context, params *CreateEventSubscriptionInput, optFns ...func(*Options)) (*CreateEventSubscriptionOutput, error) { if params == nil { params = &CreateEventSubscriptionInput{} @@ -54,10 +57,16 @@ type CreateEventSubscriptionInput struct { // This member is required. SnsTopicArn *string - // The name of the event subscription to be created. Constraints: + // 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. // // This member is required. @@ -68,29 +77,36 @@ type CreateEventSubscriptionInput struct { Enabled *bool // Specifies the Amazon Redshift event categories to be published by the event - // notification subscription. Values: configuration, management, monitoring, - // security, pending + // notification subscription. + // + // Values: configuration, management, monitoring, security, pending EventCategories []string // Specifies the Amazon Redshift event severity to be published by the event - // notification subscription. Values: ERROR, INFO + // notification subscription. + // + // Values: ERROR, INFO Severity *string // A list of one or more identifiers of Amazon Redshift source objects. All of the // objects must be of the same type as was specified in the source type parameter. // The event subscription will return only events generated by the specified // objects. If not specified, then events are returned for all objects within the - // source type specified. Example: my-cluster-1, my-cluster-2 Example: - // my-snapshot-20131010 + // source type specified. + // + // Example: my-cluster-1, my-cluster-2 + // + // Example: my-snapshot-20131010 SourceIds []string // The type of source that will be generating the events. For example, if you want // to be notified of events generated by a cluster, you would set this parameter to // cluster. If this value is not specified, events are returned for all Amazon // Redshift objects in your Amazon Web Services account. You must specify a source - // type in order to specify source IDs. Valid values: cluster, - // cluster-parameter-group, cluster-security-group, cluster-snapshot, and - // scheduled-action. + // type in order to specify source IDs. + // + // Valid values: cluster, cluster-parameter-group, cluster-security-group, + // cluster-snapshot, and scheduled-action. SourceType *string // A list of tag instances. diff --git a/service/redshift/api_op_CreateHsmClientCertificate.go b/service/redshift/api_op_CreateHsmClientCertificate.go index 11719f3976b..3e1365aa5ca 100644 --- a/service/redshift/api_op_CreateHsmClientCertificate.go +++ b/service/redshift/api_op_CreateHsmClientCertificate.go @@ -13,12 +13,15 @@ import ( // Creates an HSM client certificate that an Amazon Redshift cluster will use to // connect to the client's HSM in order to store and retrieve the keys used to -// encrypt the cluster databases. The command returns a public key, which you must -// 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) -// in the Amazon Redshift Cluster Management Guide. +// encrypt the cluster databases. +// +// The command returns a public key, which you must 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]in the Amazon Redshift +// Cluster Management Guide. +// +// [Hardware Security Modules]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html#working-with-HSM func (c *Client) CreateHsmClientCertificate(ctx context.Context, params *CreateHsmClientCertificateInput, optFns ...func(*Options)) (*CreateHsmClientCertificateOutput, error) { if params == nil { params = &CreateHsmClientCertificateInput{} diff --git a/service/redshift/api_op_CreateHsmConfiguration.go b/service/redshift/api_op_CreateHsmConfiguration.go index 7234edb26b6..1a3ff6f1a8a 100644 --- a/service/redshift/api_op_CreateHsmConfiguration.go +++ b/service/redshift/api_op_CreateHsmConfiguration.go @@ -15,10 +15,13 @@ import ( // 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. +// 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]in the Amazon Redshift Cluster +// Management Guide. +// +// [Hardware Security Modules]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html 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 804ddc4b760..bad3504ca74 100644 --- a/service/redshift/api_op_CreateScheduledAction.go +++ b/service/redshift/api_op_CreateScheduledAction.go @@ -33,45 +33,42 @@ 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 . + // 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 . + // 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 . + // 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 . + // trigger. For more information about state of the scheduled action, see 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 . + // action does not trigger. For more information about this parameter, see ScheduledAction. EndTime *time.Time // The description of the scheduled action. ScheduledActionDescription *string // 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 . + // action does not trigger. For more information about this parameter, see ScheduledAction. StartTime *time.Time noSmithyDocumentSerde @@ -79,7 +76,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 @@ -89,22 +86,28 @@ type CreateScheduledActionOutput struct { // The IAM role to assume to run the scheduled action. This IAM role must have // permission to run the Amazon Redshift API operation in the scheduled action. // 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) - // in the Amazon Redshift Cluster Management Guide. + // 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]in the Amazon Redshift Cluster Management Guide. + // + // [Using Identity-Based Policies for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html IamRole *string // List of times when the scheduled action will run. NextInvocations []time.Time // 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) - // in the Amazon CloudWatch Events User Guide. + // 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]in the Amazon CloudWatch Events User Guide. + // + // [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions Schedule *string // The description of the scheduled action. @@ -121,7 +124,9 @@ type CreateScheduledActionOutput struct { State types.ScheduledActionState // A JSON format string of the Amazon Redshift API operation with input - // parameters. " + // parameters. + // + // " // {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} // ". TargetAction *types.ScheduledActionType diff --git a/service/redshift/api_op_CreateSnapshotCopyGrant.go b/service/redshift/api_op_CreateSnapshotCopyGrant.go index d95d19053bd..fdd73748b30 100644 --- a/service/redshift/api_op_CreateSnapshotCopyGrant.go +++ b/service/redshift/api_op_CreateSnapshotCopyGrant.go @@ -13,9 +13,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// destination region. +// +// For more information about managing snapshot copy grants, go to [Amazon Redshift Database Encryption] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Database Encryption]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html func (c *Client) CreateSnapshotCopyGrant(ctx context.Context, params *CreateSnapshotCopyGrantInput, optFns ...func(*Options)) (*CreateSnapshotCopyGrantOutput, error) { if params == nil { params = &CreateSnapshotCopyGrantInput{} @@ -35,11 +38,18 @@ func (c *Client) CreateSnapshotCopyGrant(ctx context.Context, params *CreateSnap 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: + // 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. // // This member is required. @@ -59,9 +69,12 @@ 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) - // in the Amazon Redshift Cluster Management Guide. + // Services KMS in the destination region. + // + // For more information about managing snapshot copy grants, go to [Amazon Redshift Database Encryption] in the Amazon + // Redshift Cluster Management Guide. + // + // [Amazon Redshift Database Encryption]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html SnapshotCopyGrant *types.SnapshotCopyGrant // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_CreateTags.go b/service/redshift/api_op_CreateTags.go index aaa0d9d771f..b2ea5daa6e6 100644 --- a/service/redshift/api_op_CreateTags.go +++ b/service/redshift/api_op_CreateTags.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds tags to a cluster. A resource can have up to 50 tags. If you try to create -// more than 50 tags for a resource, you will receive an error and the attempt will -// fail. If you specify a key that already exists for the resource, the value for -// that key will be updated with the new value. +// Adds tags to a cluster. +// +// A resource can have up to 50 tags. If you try to create more than 50 tags for a +// resource, you will receive an error and the attempt will fail. +// +// If you specify a key that already exists for the resource, the value for that +// key will be updated with the new value. func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error) { if params == nil { params = &CreateTagsInput{} diff --git a/service/redshift/api_op_CreateUsageLimit.go b/service/redshift/api_op_CreateUsageLimit.go index 48626204b6b..2262e56ced6 100644 --- a/service/redshift/api_op_CreateUsageLimit.go +++ b/service/redshift/api_op_CreateUsageLimit.go @@ -56,7 +56,7 @@ type CreateUsageLimitInput struct { 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. @@ -78,8 +78,11 @@ type CreateUsageLimitOutput struct { // 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 diff --git a/service/redshift/api_op_DeleteCluster.go b/service/redshift/api_op_DeleteCluster.go index 9c8229dace5..a41368b5dac 100644 --- a/service/redshift/api_op_DeleteCluster.go +++ b/service/redshift/api_op_DeleteCluster.go @@ -13,17 +13,21 @@ import ( // Deletes a previously provisioned cluster without its final snapshot being // 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 -// 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. +// was received correctly. Use DescribeClustersto 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]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] in the Amazon Redshift +// Cluster Management Guide. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error) { if params == nil { params = &DeleteClusterInput{} @@ -41,10 +45,16 @@ func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, type DeleteClusterInput struct { - // The identifier of the cluster to be deleted. Constraints: + // 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. // // This member is required. @@ -52,22 +62,33 @@ type DeleteClusterInput struct { // 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 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 - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. The default value is -1. + // manual snapshot is retained indefinitely. + // + // The value must be either -1 or an integer between 1 and 3,653. + // + // The default value is -1. 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 + // 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 4bbf2415c8a..93a26a4a728 100644 --- a/service/redshift/api_op_DeleteClusterParameterGroup.go +++ b/service/redshift/api_op_DeleteClusterParameterGroup.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a specified Amazon Redshift parameter group. You cannot delete a -// parameter group if it is associated with a cluster. +// Deletes a specified Amazon Redshift parameter group. +// +// You cannot delete a parameter group if it is associated with a cluster. func (c *Client) DeleteClusterParameterGroup(ctx context.Context, params *DeleteClusterParameterGroupInput, optFns ...func(*Options)) (*DeleteClusterParameterGroupOutput, error) { if params == nil { params = &DeleteClusterParameterGroupInput{} @@ -29,8 +30,12 @@ func (c *Client) DeleteClusterParameterGroup(ctx context.Context, params *Delete type DeleteClusterParameterGroupInput struct { - // The name of the parameter group to be deleted. Constraints: + // 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. // // This member is required. diff --git a/service/redshift/api_op_DeleteClusterSecurityGroup.go b/service/redshift/api_op_DeleteClusterSecurityGroup.go index c74139f14ba..d89a8feb72c 100644 --- a/service/redshift/api_op_DeleteClusterSecurityGroup.go +++ b/service/redshift/api_op_DeleteClusterSecurityGroup.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Redshift Cluster Management Guide. +// 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] in the Amazon Redshift +// Cluster Management Guide. +// +// [Amazon Redshift Cluster Security Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html func (c *Client) DeleteClusterSecurityGroup(ctx context.Context, params *DeleteClusterSecurityGroupInput, optFns ...func(*Options)) (*DeleteClusterSecurityGroupOutput, error) { if params == nil { params = &DeleteClusterSecurityGroupInput{} diff --git a/service/redshift/api_op_DeleteClusterSnapshot.go b/service/redshift/api_op_DeleteClusterSnapshot.go index f5748ea7638..f9ec6192d1d 100644 --- a/service/redshift/api_op_DeleteClusterSnapshot.go +++ b/service/redshift/api_op_DeleteClusterSnapshot.go @@ -12,12 +12,13 @@ import ( ) // Deletes the specified manual snapshot. The snapshot must be in the available -// state, with no other users authorized to access the snapshot. Unlike automated -// snapshots, manual snapshots are retained even after you delete your cluster. -// Amazon Redshift does not delete your manual snapshots. You must delete manual -// snapshot explicitly to avoid getting charged. If other accounts are authorized -// to access the snapshot, you must revoke all of the authorizations before you can -// delete the snapshot. +// state, with no other users authorized to access the snapshot. +// +// Unlike automated snapshots, manual snapshots are retained even after you delete +// your cluster. Amazon Redshift does not delete your manual snapshots. You must +// delete manual snapshot explicitly to avoid getting charged. If other accounts +// are authorized to access the snapshot, you must revoke all of the authorizations +// before you can delete the snapshot. func (c *Client) DeleteClusterSnapshot(ctx context.Context, params *DeleteClusterSnapshotInput, optFns ...func(*Options)) (*DeleteClusterSnapshotOutput, error) { if params == nil { params = &DeleteClusterSnapshotInput{} @@ -35,9 +36,10 @@ 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 @@ -45,6 +47,7 @@ type DeleteClusterSnapshotInput struct { // The unique identifier of the cluster the snapshot was created from. This // parameter is required if your IAM user has a policy containing a snapshot // resource element that specifies anything other than * for the cluster name. + // // Constraints: Must be the name of valid cluster. SnapshotClusterIdentifier *string diff --git a/service/redshift/api_op_DescribeClusterDbRevisions.go b/service/redshift/api_op_DescribeClusterDbRevisions.go index 6a0171a441d..d342bb9fbc5 100644 --- a/service/redshift/api_op_DescribeClusterDbRevisions.go +++ b/service/redshift/api_op_DescribeClusterDbRevisions.go @@ -39,15 +39,21 @@ type DescribeClusterDbRevisionsInput struct { // 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. + // 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned 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. Default: 100 Constraints: minimum 20, maximum 100. + // and retrying the request. + // + // Default: 100 + // + // Constraints: minimum 20, maximum 100. MaxRecords *int32 noSmithyDocumentSerde @@ -161,7 +167,11 @@ type DescribeClusterDbRevisionsPaginatorOptions struct { // remaining response records exceeds the specified MaxRecords value, a value is // returned 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. Default: 100 Constraints: minimum 20, maximum 100. + // and retrying the request. + // + // Default: 100 + // + // Constraints: minimum 20, maximum 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/redshift/api_op_DescribeClusterParameterGroups.go b/service/redshift/api_op_DescribeClusterParameterGroups.go index 00ea57f3f9f..cf75f545967 100644 --- a/service/redshift/api_op_DescribeClusterParameterGroups.go +++ b/service/redshift/api_op_DescribeClusterParameterGroups.go @@ -15,15 +15,22 @@ import ( // you created and the default parameter group. For each parameter group, the // 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) -// 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 -// have owner and environment for tag keys, and admin and test for tag values, all -// parameter groups that have any combination of those values are returned. If both -// tag keys and values are omitted from the request, parameter groups are returned -// regardless of whether they have tag keys or values associated with them. +// specific parameter group. +// +// For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups] 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 have owner and environment for +// tag keys, and admin and test for tag values, all parameter groups that have any +// combination of those values are returned. +// +// If both tag keys and values are omitted from the request, parameter groups are +// returned regardless of whether they have tag keys or values associated with +// them. +// +// [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html func (c *Client) DescribeClusterParameterGroups(ctx context.Context, params *DescribeClusterParameterGroupsInput, optFns ...func(*Options)) (*DescribeClusterParameterGroupsOutput, error) { if params == nil { params = &DescribeClusterParameterGroupsInput{} @@ -42,17 +49,19 @@ func (c *Client) DescribeClusterParameterGroups(ctx context.Context, params *Des 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeClusterParameterGroupsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -89,8 +98,7 @@ type DescribeClusterParameterGroupsOutput struct { // records have been retrieved for the request. Marker *string - // A list of ClusterParameterGroup instances. Each instance describes one cluster - // parameter group. + // A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group. ParameterGroups []types.ClusterParameterGroup // Metadata pertaining to the operation's result. @@ -189,7 +197,10 @@ type DescribeClusterParameterGroupsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeClusterParameters.go b/service/redshift/api_op_DescribeClusterParameters.go index 2e10f418598..15f797e4f4a 100644 --- a/service/redshift/api_op_DescribeClusterParameters.go +++ b/service/redshift/api_op_DescribeClusterParameters.go @@ -14,12 +14,16 @@ import ( // Returns a detailed list of parameters contained within the specified Amazon // Redshift parameter group. For each parameter the response includes information // 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 -// 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) -// in the Amazon Redshift Cluster Management Guide. +// 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 specify source equal to user. +// +// For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups] in the +// Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html func (c *Client) DescribeClusterParameters(ctx context.Context, params *DescribeClusterParametersInput, optFns ...func(*Options)) (*DescribeClusterParametersOutput, error) { if params == nil { params = &DescribeClusterParametersInput{} @@ -43,24 +47,29 @@ 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 DescribeClusterParametersrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. 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 + // parameters that are the same as the default parameter group. + // + // Default: All parameter types returned. + // + // Valid Values: user | engine-default Source *string noSmithyDocumentSerde @@ -76,8 +85,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. @@ -179,7 +188,10 @@ type DescribeClusterParametersPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeClusterSecurityGroups.go b/service/redshift/api_op_DescribeClusterSecurityGroups.go index 038330e316c..4c6b8ad294b 100644 --- a/service/redshift/api_op_DescribeClusterSecurityGroups.go +++ b/service/redshift/api_op_DescribeClusterSecurityGroups.go @@ -13,15 +13,22 @@ 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) -// 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 -// have owner and environment for tag keys, and admin and test for tag values, all -// security groups that have any combination of those values are returned. If both -// tag keys and values are omitted from the request, security groups are returned -// regardless of whether they have tag keys or values associated with them. +// only that security group. +// +// For information about managing security groups, go to [Amazon Redshift Cluster Security Groups] 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 have owner and environment for tag keys, +// and admin and test for tag values, all security groups that have any +// combination of those values are returned. +// +// If both tag keys and values are omitted from the request, security groups are +// returned regardless of whether they have tag keys or values associated with +// them. +// +// [Amazon Redshift Cluster Security Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html func (c *Client) DescribeClusterSecurityGroups(ctx context.Context, params *DescribeClusterSecurityGroupsInput, optFns ...func(*Options)) (*DescribeClusterSecurityGroupsOutput, error) { if params == nil { params = &DescribeClusterSecurityGroupsInput{} @@ -41,22 +48,28 @@ type DescribeClusterSecurityGroupsInput struct { // The name of a cluster security group for which you are requesting details. You // must specify either the Marker parameter or a ClusterSecurityGroupName - // parameter, but not both. Example: securitygroup1 + // parameter, but not both. + // + // Example: securitygroup1 ClusterSecurityGroupName *string // 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 - // 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. + // response records. When the results of a DescribeClusterSecurityGroupsrequest 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. Marker *string // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -187,7 +200,10 @@ type DescribeClusterSecurityGroupsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeClusterSnapshots.go b/service/redshift/api_op_DescribeClusterSnapshots.go index 9d9b7b893c3..6f77babca69 100644 --- a/service/redshift/api_op_DescribeClusterSnapshots.go +++ b/service/redshift/api_op_DescribeClusterSnapshots.go @@ -18,15 +18,18 @@ import ( // Returns one or more snapshot objects, which contain metadata about your cluster // snapshots. By default, this operation returns information about all snapshots of // all clusters that are owned by your Amazon Web Services account. No information -// is returned for snapshots owned by inactive Amazon Web Services accounts. If you -// 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 +// is returned for snapshots owned by inactive Amazon Web Services accounts. +// +// If you 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 +// 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 { @@ -49,11 +52,15 @@ type DescribeClusterSnapshotsInput struct { // 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 @@ -63,22 +70,27 @@ 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) + // ISO 8601, go to the [ISO8601 Wikipedia page.] + // // Example: 2012-07-16T18:00:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 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 - // 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 DescribeClusterSnapshotsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -96,7 +108,9 @@ type DescribeClusterSnapshotsInput struct { SnapshotIdentifier *string // The type of snapshots for which you are requesting information. By default, - // snapshots of all types are returned. Valid Values: automated | manual + // snapshots of all types are returned. + // + // Valid Values: automated | manual SnapshotType *string // @@ -104,8 +118,11 @@ type DescribeClusterSnapshotsInput struct { // 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) + // 8601, go to the [ISO8601 Wikipedia page.] + // // Example: 2012-07-16T18:00:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 StartTime *time.Time // A tag key or keys for which you want to return all matching cluster snapshots @@ -239,7 +256,10 @@ type DescribeClusterSnapshotsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 @@ -353,12 +373,13 @@ type SnapshotAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterSnapshotsInput, *DescribeClusterSnapshotsOutput, error) (bool, error) } diff --git a/service/redshift/api_op_DescribeClusterSubnetGroups.go b/service/redshift/api_op_DescribeClusterSubnetGroups.go index 45f79784c7c..6f61a39ffd1 100644 --- a/service/redshift/api_op_DescribeClusterSubnetGroups.go +++ b/service/redshift/api_op_DescribeClusterSubnetGroups.go @@ -14,13 +14,16 @@ import ( // Returns one or more cluster subnet group objects, which contain metadata about // your cluster subnet groups. By default, this operation returns information about // all cluster subnet groups that are defined in your Amazon Web Services account. -// If you specify both tag keys and tag values in the same request, Amazon Redshift -// returns all subnet groups 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 subnet groups that have any combination of those -// values are returned. If both tag keys and values are omitted from the request, -// subnet groups 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 subnet groups 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 subnet groups that have any combination +// of those values are returned. +// +// If both tag keys and values are omitted from the request, subnet groups are +// returned regardless of whether they have tag keys or values associated with +// them. func (c *Client) DescribeClusterSubnetGroups(ctx context.Context, params *DescribeClusterSubnetGroupsInput, optFns ...func(*Options)) (*DescribeClusterSubnetGroupsOutput, error) { if params == nil { params = &DescribeClusterSubnetGroupsInput{} @@ -42,17 +45,19 @@ type DescribeClusterSubnetGroupsInput struct { ClusterSubnetGroupName *string // 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeClusterSubnetGroupsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -184,7 +189,10 @@ type DescribeClusterSubnetGroupsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeClusterVersions.go b/service/redshift/api_op_DescribeClusterVersions.go index a830798251a..5a37765e181 100644 --- a/service/redshift/api_op_DescribeClusterVersions.go +++ b/service/redshift/api_op_DescribeClusterVersions.go @@ -13,9 +13,12 @@ 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 versions. +// +// For more information about managing clusters, go to [Amazon Redshift Clusters] in the Amazon Redshift +// Cluster Management Guide. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html func (c *Client) DescribeClusterVersions(ctx context.Context, params *DescribeClusterVersionsInput, optFns ...func(*Options)) (*DescribeClusterVersionsOutput, error) { if params == nil { params = &DescribeClusterVersionsInput{} @@ -34,27 +37,35 @@ func (c *Client) DescribeClusterVersions(ctx context.Context, params *DescribeCl 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 ClusterParameterGroupFamily *string - // The specific cluster version to return. Example: 1.0 + // The specific cluster version to return. + // + // Example: 1.0 ClusterVersion *string // 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 - // 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 DescribeClusterVersionsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -170,7 +181,10 @@ type DescribeClusterVersionsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeClusters.go b/service/redshift/api_op_DescribeClusters.go index 73e2c40a3ab..35db5fdefeb 100644 --- a/service/redshift/api_op_DescribeClusters.go +++ b/service/redshift/api_op_DescribeClusters.go @@ -20,14 +20,19 @@ import ( // 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. +// information about managing clusters, go to [Amazon Redshift Clusters]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. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersInput, optFns ...func(*Options)) (*DescribeClustersOutput, error) { if params == nil { params = &DescribeClustersInput{} @@ -46,23 +51,28 @@ func (c *Client) DescribeClusters(ctx context.Context, params *DescribeClustersI type DescribeClustersInput struct { // The unique identifier of a cluster whose properties you are requesting. This - // parameter is case sensitive. The default is that all clusters defined for an - // account are returned. + // parameter is case sensitive. + // + // The default is that all clusters defined for an account are returned. ClusterIdentifier *string // 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 - // request. Constraints: You can specify either the ClusterIdentifier parameter or - // the Marker parameter, but not both. + // response records. When the results of a DescribeClustersrequest 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 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -192,7 +202,10 @@ type DescribeClustersPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 @@ -305,12 +318,13 @@ type ClusterAvailableWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClustersInput, *DescribeClustersOutput, error) (bool, error) } @@ -528,12 +542,13 @@ type ClusterDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClustersInput, *DescribeClustersOutput, error) (bool, error) } @@ -743,12 +758,13 @@ type ClusterRestoredWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClustersInput, *DescribeClustersOutput, error) (bool, error) } diff --git a/service/redshift/api_op_DescribeDataShares.go b/service/redshift/api_op_DescribeDataShares.go index cbd6eaaac52..08b32bd526d 100644 --- a/service/redshift/api_op_DescribeDataShares.go +++ b/service/redshift/api_op_DescribeDataShares.go @@ -34,11 +34,10 @@ type DescribeDataSharesInput struct { DataShareArn *string // 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 - // request. + // response records. When the results of a DescribeDataSharesrequest 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 @@ -56,11 +55,10 @@ type DescribeDataSharesOutput struct { DataShares []types.DataShare // 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 - // request. + // response records. When the results of a DescribeDataSharesrequest 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 // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_DescribeDataSharesForConsumer.go b/service/redshift/api_op_DescribeDataSharesForConsumer.go index b9aa38a9a60..1545d6c0f00 100644 --- a/service/redshift/api_op_DescribeDataSharesForConsumer.go +++ b/service/redshift/api_op_DescribeDataSharesForConsumer.go @@ -35,11 +35,10 @@ type DescribeDataSharesForConsumerInput struct { ConsumerArn *string // 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeDataSharesForConsumerrequest 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,11 +61,10 @@ type DescribeDataSharesForConsumerOutput struct { DataShares []types.DataShare // 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeDataSharesForConsumerrequest 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 // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_DescribeDataSharesForProducer.go b/service/redshift/api_op_DescribeDataSharesForProducer.go index d318f5fbffe..a42b535bd82 100644 --- a/service/redshift/api_op_DescribeDataSharesForProducer.go +++ b/service/redshift/api_op_DescribeDataSharesForProducer.go @@ -31,11 +31,10 @@ func (c *Client) DescribeDataSharesForProducer(ctx context.Context, params *Desc 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeDataSharesForProducerrequest 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,11 +61,10 @@ type DescribeDataSharesForProducerOutput struct { DataShares []types.DataShare // 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeDataSharesForProducerrequest 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 // Metadata pertaining to the operation's result. diff --git a/service/redshift/api_op_DescribeDefaultClusterParameters.go b/service/redshift/api_op_DescribeDefaultClusterParameters.go index 2f4030bd6c0..49cd87689cb 100644 --- a/service/redshift/api_op_DescribeDefaultClusterParameters.go +++ b/service/redshift/api_op_DescribeDefaultClusterParameters.go @@ -12,9 +12,11 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// +// For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups] in the +// Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html func (c *Client) DescribeDefaultClusterParameters(ctx context.Context, params *DescribeDefaultClusterParametersInput, optFns ...func(*Options)) (*DescribeDefaultClusterParametersOutput, error) { if params == nil { params = &DescribeDefaultClusterParametersInput{} @@ -38,17 +40,19 @@ 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 DescribeDefaultClusterParametersrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -159,7 +163,10 @@ type DescribeDefaultClusterParametersPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeEventCategories.go b/service/redshift/api_op_DescribeEventCategories.go index 7aedefb1895..b3fd15c565a 100644 --- a/service/redshift/api_op_DescribeEventCategories.go +++ b/service/redshift/api_op_DescribeEventCategories.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} @@ -33,8 +34,10 @@ func (c *Client) DescribeEventCategories(ctx context.Context, params *DescribeEv type DescribeEventCategoriesInput struct { // The source type, such as cluster or parameter group, to which the described - // event categories apply. Valid values: cluster, cluster-snapshot, - // cluster-parameter-group, cluster-security-group, and scheduled-action. + // event categories apply. + // + // Valid values: cluster, cluster-snapshot, cluster-parameter-group, + // cluster-security-group, and scheduled-action. SourceType *string noSmithyDocumentSerde diff --git a/service/redshift/api_op_DescribeEventSubscriptions.go b/service/redshift/api_op_DescribeEventSubscriptions.go index 961941244ce..a29da8e8aa3 100644 --- a/service/redshift/api_op_DescribeEventSubscriptions.go +++ b/service/redshift/api_op_DescribeEventSubscriptions.go @@ -13,14 +13,17 @@ import ( // Lists descriptions of all the Amazon Redshift event notification subscriptions // for a customer account. If you specify a subscription name, lists the -// description for that subscription. If you specify both tag keys and tag values -// in the same request, Amazon Redshift returns all event notification -// subscriptions 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 subscriptions that have any combination of those values are -// returned. If both tag keys and values are omitted from the request, -// subscriptions are returned regardless of whether they have tag keys or values -// associated with them. +// description for that subscription. +// +// If you specify both tag keys and tag values in the same request, Amazon +// Redshift returns all event notification subscriptions 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 subscriptions that have +// any combination of those values are returned. +// +// If both tag keys and values are omitted from the request, subscriptions are +// returned regardless of whether they have tag keys or values associated with +// them. func (c *Client) DescribeEventSubscriptions(ctx context.Context, params *DescribeEventSubscriptionsInput, optFns ...func(*Options)) (*DescribeEventSubscriptionsOutput, error) { if params == nil { params = &DescribeEventSubscriptionsInput{} @@ -49,7 +52,10 @@ type DescribeEventSubscriptionsInput struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -183,7 +189,10 @@ type DescribeEventSubscriptionsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeEvents.go b/service/redshift/api_op_DescribeEvents.go index 59e52c49fe8..f72a4d3973b 100644 --- a/service/redshift/api_op_DescribeEvents.go +++ b/service/redshift/api_op_DescribeEvents.go @@ -36,55 +36,78 @@ type DescribeEventsInput struct { // The number of minutes prior to the time of the request for which to retrieve // events. For example, if the request is sent at 18:00 and you specify a duration // of 60, then only events which have occurred after 17:00 will be returned. + // // 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 + // 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.] + // + // Example: 2009-07-08T18:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 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. + // response records. When the results of a DescribeEventsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 // 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. + // + // 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. + // 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. 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 + // 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.] + // + // Example: 2009-07-08T18:00Z + // + // [ISO8601 Wikipedia page.]: http://en.wikipedia.org/wiki/ISO_8601 StartTime *time.Time noSmithyDocumentSerde @@ -197,7 +220,10 @@ type DescribeEventsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeHsmClientCertificates.go b/service/redshift/api_op_DescribeHsmClientCertificates.go index 059c68adac3..c12f6f74645 100644 --- a/service/redshift/api_op_DescribeHsmClientCertificates.go +++ b/service/redshift/api_op_DescribeHsmClientCertificates.go @@ -13,11 +13,14 @@ import ( // Returns information about the specified HSM client certificate. If no // certificate ID is specified, returns information about all the HSM certificates -// 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 client certificates -// 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 -// HSM client certificates that have any combination of those values are returned. +// 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 client certificates 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 HSM client certificates that +// have any combination of those values are returned. +// // If both tag keys and values are omitted from the request, HSM client // certificates are returned regardless of whether they have tag keys or values // associated with them. @@ -44,17 +47,19 @@ type DescribeHsmClientCertificatesInput struct { HsmClientCertificateIdentifier *string // 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeHsmClientCertificatesrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -187,7 +192,10 @@ type DescribeHsmClientCertificatesPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeHsmConfigurations.go b/service/redshift/api_op_DescribeHsmConfigurations.go index 0301dc5c7a1..39a48a13b68 100644 --- a/service/redshift/api_op_DescribeHsmConfigurations.go +++ b/service/redshift/api_op_DescribeHsmConfigurations.go @@ -13,14 +13,17 @@ import ( // 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 -// example, if you have owner and environment for tag keys, and admin and test for -// tag values, all HSM connections that have any combination of those values are -// returned. If both tag keys and values are omitted from the request, HSM -// connections are returned regardless of whether they have tag keys or values -// associated with them. +// 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 example, if you have owner and environment for tag keys, +// and admin and test for tag values, all HSM connections that have any +// combination of those values are returned. +// +// If both tag keys and values are omitted from the request, HSM connections are +// returned regardless of whether they have tag keys or values associated with +// them. func (c *Client) DescribeHsmConfigurations(ctx context.Context, params *DescribeHsmConfigurationsInput, optFns ...func(*Options)) (*DescribeHsmConfigurationsOutput, error) { if params == nil { params = &DescribeHsmConfigurationsInput{} @@ -44,17 +47,19 @@ 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 DescribeHsmConfigurationsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -185,7 +190,10 @@ type DescribeHsmConfigurationsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeInboundIntegrations.go b/service/redshift/api_op_DescribeInboundIntegrations.go index c8c34e86276..b31877d0c93 100644 --- a/service/redshift/api_op_DescribeInboundIntegrations.go +++ b/service/redshift/api_op_DescribeInboundIntegrations.go @@ -33,17 +33,19 @@ type DescribeInboundIntegrationsInput struct { IntegrationArn *string // An optional parameter that specifies the starting point to return a set of - // response records. When the results of a DescribeInboundIntegrations 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 DescribeInboundIntegrationsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -161,7 +163,10 @@ type DescribeInboundIntegrationsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeLoggingStatus.go b/service/redshift/api_op_DescribeLoggingStatus.go index ad738b3b6c8..d8bf9a9fa16 100644 --- a/service/redshift/api_op_DescribeLoggingStatus.go +++ b/service/redshift/api_op_DescribeLoggingStatus.go @@ -31,8 +31,9 @@ func (c *Client) DescribeLoggingStatus(ctx context.Context, params *DescribeLogg type DescribeLoggingStatusInput struct { - // The identifier of the cluster from which to get the logging status. Example: - // examplecluster + // The identifier of the cluster from which to get the logging status. + // + // Example: examplecluster // // This member is required. ClusterIdentifier *string diff --git a/service/redshift/api_op_DescribeNodeConfigurationOptions.go b/service/redshift/api_op_DescribeNodeConfigurationOptions.go index faf4b62405e..750c9d7e217 100644 --- a/service/redshift/api_op_DescribeNodeConfigurationOptions.go +++ b/service/redshift/api_op_DescribeNodeConfigurationOptions.go @@ -46,17 +46,19 @@ 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 DescribeNodeConfigurationOptionsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 500 + // records by retrying the command with the returned marker value. + // + // Default: 500 + // // Constraints: minimum 100, maximum 500. MaxRecords *int32 @@ -186,7 +188,10 @@ type DescribeNodeConfigurationOptionsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 500 + // records by retrying the command with the returned marker value. + // + // Default: 500 + // // Constraints: minimum 100, maximum 500. Limit int32 diff --git a/service/redshift/api_op_DescribeOrderableClusterOptions.go b/service/redshift/api_op_DescribeOrderableClusterOptions.go index e1815f9d9cf..2e7cd4a0580 100644 --- a/service/redshift/api_op_DescribeOrderableClusterOptions.go +++ b/service/redshift/api_op_DescribeOrderableClusterOptions.go @@ -17,9 +17,10 @@ import ( // 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. +// creating a cluster. For more information about managing clusters, go to [Amazon Redshift Clusters]in the +// Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html func (c *Client) DescribeOrderableClusterOptions(ctx context.Context, params *DescribeOrderableClusterOptionsInput, optFns ...func(*Options)) (*DescribeOrderableClusterOptionsOutput, error) { if params == nil { params = &DescribeOrderableClusterOptionsInput{} @@ -38,22 +39,27 @@ func (c *Client) DescribeOrderableClusterOptions(ctx context.Context, params *De 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 . + // offerings matching the specified version. + // + // Default: All versions. + // + // Constraints: 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeOrderableClusterOptionsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -174,7 +180,10 @@ type DescribeOrderableClusterOptionsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeReservedNodeOfferings.go b/service/redshift/api_op_DescribeReservedNodeOfferings.go index 953eaf5af0e..622c6fa191c 100644 --- a/service/redshift/api_op_DescribeReservedNodeOfferings.go +++ b/service/redshift/api_op_DescribeReservedNodeOfferings.go @@ -15,11 +15,13 @@ import ( // their descriptions including the node type, the fixed and recurring costs of // reserving the node and duration the node will be reserved for you. These // descriptions help you determine which reserve node offering you want to -// 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) -// in the Amazon Redshift Cluster Management Guide. +// purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOfferingto reserve one or +// more nodes for your Amazon Redshift cluster. +// +// For more information about reserved node offerings, go to [Purchasing Reserved Nodes] in the Amazon +// Redshift Cluster Management Guide. +// +// [Purchasing Reserved Nodes]: https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html func (c *Client) DescribeReservedNodeOfferings(ctx context.Context, params *DescribeReservedNodeOfferingsInput, optFns ...func(*Options)) (*DescribeReservedNodeOfferingsOutput, error) { if params == nil { params = &DescribeReservedNodeOfferingsInput{} @@ -38,17 +40,19 @@ func (c *Client) DescribeReservedNodeOfferings(ctx context.Context, params *Desc 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 - // records by providing the returned marker value in the Marker parameter and - // retrying the request. + // response records. When the results of a DescribeReservedNodeOfferingsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -166,7 +170,10 @@ type DescribeReservedNodeOfferingsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeReservedNodes.go b/service/redshift/api_op_DescribeReservedNodes.go index acd44b5a214..19fa190a7ae 100644 --- a/service/redshift/api_op_DescribeReservedNodes.go +++ b/service/redshift/api_op_DescribeReservedNodes.go @@ -30,17 +30,19 @@ 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 - // request. + // response records. When the results of a DescribeReservedNodesrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -158,7 +160,10 @@ type DescribeReservedNodesPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeResize.go b/service/redshift/api_op_DescribeResize.go index 8729bd0f80a..30a85f86f18 100644 --- a/service/redshift/api_op_DescribeResize.go +++ b/service/redshift/api_op_DescribeResize.go @@ -13,9 +13,10 @@ 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. +// 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{} @@ -34,8 +35,10 @@ func (c *Client) DescribeResize(ctx context.Context, params *DescribeResizeInput type DescribeResizeInput struct { // The unique identifier of a cluster whose resize progress you are requesting. - // This parameter is case-sensitive. By default, resize operations for all clusters - // defined for an Amazon Web Services account are returned. + // This parameter is case-sensitive. + // + // By default, resize operations for all clusters defined for an Amazon Web + // Services account are returned. // // This member is required. ClusterIdentifier *string @@ -65,16 +68,19 @@ type DescribeResizeOutput struct { // complete, this value will be 0. EstimatedTimeToCompletionInSeconds *int64 - // The names of tables that have been completely imported . Valid Values: List of - // table names. + // The names of tables that have been completely imported . + // + // Valid Values: List of table names. ImportTablesCompleted []string - // The names of tables that are being currently imported. Valid Values: List of - // table names. + // The names of tables that are being currently imported. + // + // Valid Values: List of 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. @@ -91,16 +97,19 @@ type DescribeResizeOutput struct { // describe the type of resize operation being performed. ResizeType *string - // The status of the resize operation. Valid Values: NONE | IN_PROGRESS | FAILED | - // SUCCEEDED | CANCELLING + // The status of the resize operation. + // + // Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING Status *string - // The cluster type after the resize operation is complete. Valid Values: - // multi-node | single-node + // The cluster type after the resize operation is complete. + // + // Valid Values: multi-node | single-node TargetClusterType *string - // The type of encryption for the cluster after the resize is complete. Possible - // values are KMS and None . + // The type of encryption for the cluster after the resize is complete. + // + // Possible 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 8c0b2cc7826..0f5d52b48b3 100644 --- a/service/redshift/api_op_DescribeScheduledActions.go +++ b/service/redshift/api_op_DescribeScheduledActions.go @@ -42,17 +42,19 @@ type DescribeScheduledActionsInput struct { Filters []types.ScheduledActionFilter // 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 - // 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 DescribeScheduledActionsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -72,11 +74,10 @@ type DescribeScheduledActionsInput struct { 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 - // 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 DescribeScheduledActionsrequest 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 // List of retrieved scheduled actions. @@ -181,7 +182,10 @@ type DescribeScheduledActionsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeSnapshotCopyGrants.go b/service/redshift/api_op_DescribeSnapshotCopyGrants.go index bfcb879cf3a..64b4592b15c 100644 --- a/service/redshift/api_op_DescribeSnapshotCopyGrants.go +++ b/service/redshift/api_op_DescribeSnapshotCopyGrants.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// in the destination region. +// +// For more information about managing snapshot copy grants, go to [Amazon Redshift Database Encryption] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Database Encryption]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html func (c *Client) DescribeSnapshotCopyGrants(ctx context.Context, params *DescribeSnapshotCopyGrantsInput, optFns ...func(*Options)) (*DescribeSnapshotCopyGrantsOutput, error) { if params == nil { params = &DescribeSnapshotCopyGrantsInput{} @@ -38,14 +41,19 @@ type DescribeSnapshotCopyGrantsInput struct { // 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. + // 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -76,8 +84,10 @@ type DescribeSnapshotCopyGrantsOutput struct { // 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. + // 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. @@ -179,7 +189,10 @@ type DescribeSnapshotCopyGrantsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DescribeTableRestoreStatus.go b/service/redshift/api_op_DescribeTableRestoreStatus.go index a3aa80379ee..a8d9c476054 100644 --- a/service/redshift/api_op_DescribeTableRestoreStatus.go +++ b/service/redshift/api_op_DescribeTableRestoreStatus.go @@ -11,12 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the status of one or more table restore requests made using the -// RestoreTableFromClusterSnapshot API action. If you don't specify a value for the -// 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 . +// Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API +// action. If you don't specify a value for the 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 . func (c *Client) DescribeTableRestoreStatus(ctx context.Context, params *DescribeTableRestoreStatusInput, optFns ...func(*Options)) (*DescribeTableRestoreStatusOutput, error) { if params == nil { params = &DescribeTableRestoreStatusInput{} @@ -57,8 +57,7 @@ type DescribeTableRestoreStatusInput struct { type DescribeTableRestoreStatusOutput struct { - // A pagination token that can be used in a subsequent DescribeTableRestoreStatus - // request. + // A pagination token that can be used in a subsequent DescribeTableRestoreStatus request. Marker *string // A list of status details for one or more table restore requests. diff --git a/service/redshift/api_op_DescribeTags.go b/service/redshift/api_op_DescribeTags.go index ed6578a77ec..f670e410ca0 100644 --- a/service/redshift/api_op_DescribeTags.go +++ b/service/redshift/api_op_DescribeTags.go @@ -13,12 +13,16 @@ 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 : +// as clusters, snapshots, and so on. +// +// The following are limitations for 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. // @@ -26,9 +30,11 @@ import ( // 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. +// 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{} @@ -65,20 +71,31 @@ type DescribeTagsInput struct { // 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) - // in the Amazon Redshift Cluster Management Guide. + // ARNs, go to [Specifying Policy Elements: Actions, Effects, Resources, and Principals]in the Amazon Redshift Cluster Management Guide. + // + // [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 ResourceType *string // A tag key or keys for which you want to return all matching resources that are diff --git a/service/redshift/api_op_DescribeUsageLimits.go b/service/redshift/api_op_DescribeUsageLimits.go index 519bff21b8a..3e51b5b44b6 100644 --- a/service/redshift/api_op_DescribeUsageLimits.go +++ b/service/redshift/api_op_DescribeUsageLimits.go @@ -14,13 +14,17 @@ 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. func (c *Client) DescribeUsageLimits(ctx context.Context, params *DescribeUsageLimitsInput, optFns ...func(*Options)) (*DescribeUsageLimitsOutput, error) { @@ -47,17 +51,19 @@ type DescribeUsageLimitsInput struct { FeatureType types.UsageLimitFeatureType // 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 - // request. + // response records. When the results of a DescribeUsageLimitsrequest 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 // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. MaxRecords *int32 @@ -191,7 +197,10 @@ type DescribeUsageLimitsPaginatorOptions struct { // The maximum number of response records to return in each call. If the number of // remaining response records exceeds the specified MaxRecords value, a value is // returned in a marker field of the response. You can retrieve the next set of - // records by retrying the command with the returned marker value. Default: 100 + // records by retrying the command with the returned marker value. + // + // Default: 100 + // // Constraints: minimum 20, maximum 100. Limit int32 diff --git a/service/redshift/api_op_DisableLogging.go b/service/redshift/api_op_DisableLogging.go index b570ac07995..15f1f51c7e8 100644 --- a/service/redshift/api_op_DisableLogging.go +++ b/service/redshift/api_op_DisableLogging.go @@ -31,8 +31,9 @@ func (c *Client) DisableLogging(ctx context.Context, params *DisableLoggingInput type DisableLoggingInput struct { - // The identifier of the cluster on which logging is to be stopped. Example: - // examplecluster + // The identifier of the cluster on which logging is to be stopped. + // + // Example: examplecluster // // This member is required. ClusterIdentifier *string diff --git a/service/redshift/api_op_DisableSnapshotCopy.go b/service/redshift/api_op_DisableSnapshotCopy.go index 86a9f607e51..c3b41b24633 100644 --- a/service/redshift/api_op_DisableSnapshotCopy.go +++ b/service/redshift/api_op_DisableSnapshotCopy.go @@ -12,10 +12,11 @@ import ( ) // Disables the automatic copying of snapshots from one region to another region -// for a specified cluster. If your cluster and its snapshots are encrypted using -// an encrypted symmetric key from Key Management Service, use -// DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift -// permission to the key in the destination region. +// for a specified cluster. +// +// If your cluster and its snapshots are encrypted using an encrypted symmetric +// key from Key Management Service, use DeleteSnapshotCopyGrantto delete the grant that grants Amazon +// Redshift permission to the key in the destination region. func (c *Client) DisableSnapshotCopy(ctx context.Context, params *DisableSnapshotCopyInput, optFns ...func(*Options)) (*DisableSnapshotCopyOutput, error) { if params == nil { params = &DisableSnapshotCopyInput{} @@ -34,8 +35,10 @@ func (c *Client) DisableSnapshotCopy(ctx context.Context, params *DisableSnapsho type DisableSnapshotCopyInput struct { // The unique identifier of the source cluster that you want to disable copying of - // snapshots to a destination region. Constraints: Must be the valid name of an - // existing cluster that has cross-region snapshot copy enabled. + // snapshots to a destination region. + // + // Constraints: Must be the valid name of an existing cluster that has + // cross-region snapshot copy enabled. // // This member is required. ClusterIdentifier *string diff --git a/service/redshift/api_op_EnableLogging.go b/service/redshift/api_op_EnableLogging.go index e64eae82360..078dc83b310 100644 --- a/service/redshift/api_op_EnableLogging.go +++ b/service/redshift/api_op_EnableLogging.go @@ -31,15 +31,19 @@ func (c *Client) EnableLogging(ctx context.Context, params *EnableLoggingInput, type EnableLoggingInput struct { - // The identifier of the cluster on which logging is to be started. Example: - // examplecluster + // The identifier of the cluster on which logging is to be started. + // + // Example: examplecluster // // This member is required. ClusterIdentifier *string // 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 BucketName *string @@ -50,14 +54,23 @@ type EnableLoggingInput struct { // useractivitylog , and userlog . LogExports []string - // The prefix applied to the log file names. Constraints: + // 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 S3KeyPrefix *string diff --git a/service/redshift/api_op_EnableSnapshotCopy.go b/service/redshift/api_op_EnableSnapshotCopy.go index 7604c249618..07d722a73fc 100644 --- a/service/redshift/api_op_EnableSnapshotCopy.go +++ b/service/redshift/api_op_EnableSnapshotCopy.go @@ -31,29 +31,36 @@ 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. + // + // 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]in the Amazon Web Services General Reference. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region // // This member is required. DestinationRegion *string // The number of days to retain newly copied snapshots in the destination Amazon // Web Services Region after they are copied from the source Amazon Web Services - // Region. If the value is -1, the manual snapshot is retained indefinitely. The - // value must be either -1 or an integer between 1 and 3,653. + // Region. If the value is -1, the manual snapshot is retained indefinitely. + // + // The 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. + // 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 b48380170aa..336548c5ebc 100644 --- a/service/redshift/api_op_GetClusterCredentials.go +++ b/service/redshift/api_op_GetClusterCredentials.go @@ -17,19 +17,25 @@ import ( // 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) -// 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 +// minutes) and 3600 seconds (60 minutes). For more information, see [Using IAM Authentication to Generate Database User Credentials]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]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. +// +// [Using IAM Authentication to Generate Database User Credentials]: https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html +// [Resource Policies for GetClusterCredentials]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources func (c *Client) GetClusterCredentials(ctx context.Context, params *GetClusterCredentialsInput, optFns ...func(*Options)) (*GetClusterCredentialsOutput, error) { if params == nil { params = &GetClusterCredentialsInput{} @@ -54,17 +60,27 @@ type GetClusterCredentialsInput struct { // 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: + // the user doesn't exist in the database. + // + // For more information, see [CREATE USER] 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. + // + // - Cannot be a reserved word. A list of reserved words can be found in [Reserved Words]in the + // Amazon Redshift Database Developer Guide. + // + // [Reserved Words]: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html + // [CREATE USER]: https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html // // This member is required. DbUser *string @@ -82,32 +98,50 @@ type GetClusterCredentialsInput struct { // A list of the names of existing database groups that the user named in DbUser // 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 + // 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. + // + // - Cannot be a reserved word. A list of reserved words can be found in [Reserved Words]in the + // Amazon Redshift Database Developer Guide. + // + // [Reserved Words]: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html 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: + // 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. + // + // - Cannot be a reserved word. A list of reserved words can be found in [Reserved Words]in the + // Amazon Redshift Database Developer Guide. + // + // [Reserved Words]: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html DbName *string // The number of seconds until the returned temporary password expires. - // Constraint: minimum 900, maximum 3600. Default: 900 + // + // Constraint: minimum 900, maximum 3600. + // + // Default: 900 DurationSeconds *int32 noSmithyDocumentSerde diff --git a/service/redshift/api_op_GetClusterCredentialsWithIAM.go b/service/redshift/api_op_GetClusterCredentialsWithIAM.go index bdee4ce258e..4482be4bb31 100644 --- a/service/redshift/api_op_GetClusterCredentialsWithIAM.go +++ b/service/redshift/api_op_GetClusterCredentialsWithIAM.go @@ -14,13 +14,16 @@ import ( // 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) -// in the Amazon Redshift Cluster Management Guide. +// information about IAM identities, see [IAM Identities (users, user groups, and roles)]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)]in the Amazon Redshift +// Cluster Management Guide. +// +// [IAM Identities (users, user groups, and roles)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html +// [Using identity-based policies (IAM policies)]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html func (c *Client) GetClusterCredentialsWithIAM(ctx context.Context, params *GetClusterCredentialsWithIAMInput, optFns ...func(*Options)) (*GetClusterCredentialsWithIAMOutput, error) { if params == nil { params = &GetClusterCredentialsWithIAMInput{} @@ -51,8 +54,9 @@ type GetClusterCredentialsWithIAMInput struct { // access to all databases is allowed. DbName *string - // The number of seconds until the returned temporary password expires. Range: - // 900-3600. Default: 900. + // The number of seconds until the returned temporary password expires. + // + // Range: 900-3600. Default: 900. DurationSeconds *int32 noSmithyDocumentSerde diff --git a/service/redshift/api_op_ModifyCluster.go b/service/redshift/api_op_ModifyCluster.go index ead6b8c18da..ab79fa466ef 100644 --- a/service/redshift/api_op_ModifyCluster.go +++ b/service/redshift/api_op_ModifyCluster.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the settings for a cluster. You can also change node type and the -// number of nodes to scale up or down the cluster. When resizing a cluster, you -// must specify both the number of nodes and the node type even if one of the -// parameters does not change. You can add another security or parameter group, or -// 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. +// Modifies the settings for a cluster. +// +// You can also change node type and the number of nodes to scale up or down the +// cluster. When resizing a cluster, you must specify both the number of nodes and +// the node type even if one of the parameters does not change. +// +// You can add another security or parameter group, or 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]in the Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html func (c *Client) ModifyCluster(ctx context.Context, params *ModifyClusterInput, optFns ...func(*Options)) (*ModifyClusterOutput, error) { if params == nil { params = &ModifyClusterInput{} @@ -37,23 +41,33 @@ func (c *Client) ModifyCluster(ctx context.Context, params *ModifyClusterInput, type ModifyClusterInput struct { - // The unique identifier of the cluster to be modified. Example: examplecluster + // The unique identifier of the cluster to be modified. + // + // Example: examplecluster // // This member is required. ClusterIdentifier *string // If true , major version upgrades will be applied automatically to the cluster - // during the maintenance window. Default: false + // 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 - // you decrease the automated snapshot retention period from its current value, + // 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 - // types. Set the automated retention period from 1-35 days. Default: Uses existing - // setting. Constraints: Must be a value from 0 to 35. + // be immediately deleted. + // + // You can't disable automated snapshots for RA3 node types. Set the automated + // retention period from 1-35 days. + // + // Default: Uses existing setting. + // + // Constraints: Must be a value from 0 to 35. AutomatedSnapshotRetentionPeriod *int32 // The option to initiate relocation for an Amazon Redshift cluster to the target @@ -65,57 +79,81 @@ type ModifyClusterInput struct { 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 - // parameter group must be in the same parameter group family that matches the - // cluster version. + // 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 // A list of cluster security groups to be authorized on this cluster. This change - // 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: + // 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 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 - // 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 + // 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 DescribeResizeto + // 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 - // version upgrades, if a non-default cluster parameter group is currently in use, - // 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) - // in the Amazon Redshift Cluster Management Guide. Example: 1.0 + // The new version number of the Amazon Redshift engine to upgrade to. + // + // For major version upgrades, if a non-default cluster parameter group is + // currently in use, 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]in the Amazon Redshift Cluster + // Management Guide. + // + // Example: 1.0 + // + // [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html 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) - // in the Amazon Redshift Cluster Management Guide. + // 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]in the Amazon Redshift Cluster Management Guide. + // + // [Supported Platforms to Launch Your Cluster]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms 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. + // 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 + // must be in a VPC. For more information, see [Enhanced VPC Routing]in the Amazon Redshift Cluster + // Management Guide. + // + // If this option is true , enhanced VPC routing is enabled. + // + // Default: false + // + // [Enhanced VPC Routing]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html EnhancedVpcRouting *bool // Specifies the name of the HSM client certificate the Amazon Redshift cluster @@ -151,8 +189,11 @@ type ModifyClusterInput struct { // 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. + // snapshots. + // + // The value must be either -1 or an integer between 1 and 3,653. + // + // The default value is -1. ManualSnapshotRetentionPeriod *int32 // The ID of the Key Management Service (KMS) key used to encrypt and store the @@ -163,15 +204,25 @@ type ModifyClusterInput struct { // The new password for the cluster admin user. This change is asynchronously // applied as soon as possible. Between the time of the request and the completion // of the request, the MasterUserPassword element exists in the - // PendingModifiedValues element of the operation response. You can't use - // MasterUserPassword if ManageMasterPassword is true . Operations never return the - // password, so this operation provides a way to regain access to the admin user - // account for a cluster if the password is lost. Default: Uses existing setting. + // PendingModifiedValues element of the operation response. + // + // You can't use MasterUserPassword if ManageMasterPassword is true . + // + // Operations never return the password, so this operation provides a way to + // regain access to the admin user account 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 @ . MasterUserPassword *string @@ -180,46 +231,74 @@ type ModifyClusterInput struct { // Zone, the cluster will be modified to be deployed in two Availability Zones. MultiAZ *bool - // The new identifier for the cluster. Constraints: + // 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. + // // 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 | - // ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | - // ra3.4xlarge | ra3.16xlarge + // specify the number of nodes parameter. + // + // For more information about resizing clusters, go to [Resizing Clusters in Amazon Redshift] 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 + // + // [Resizing Clusters in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html 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 . + // you must also specify the node type parameter. + // + // For more information about resizing clusters, go to [Resizing Clusters in Amazon Redshift] in the Amazon Redshift + // Cluster Management Guide. + // + // Valid Values: Integer greater than 0 . + // + // [Resizing Clusters in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html NumberOfNodes *int32 - // The option to change the port of an Amazon Redshift cluster. Valid Values: + // The option to change the port of an Amazon Redshift cluster. + // + // Valid Values: + // // - For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or // 8191-8215 . (If you have an existing cluster with ra3 nodes, it isn't required // that you change the port to these ranges.) + // // - For clusters with ds2 or dc2 nodes - Select a port within the range // 1150-65535 . Port *int32 // The weekly time range (in UTC) during which system maintenance can occur, if // necessary. If system maintenance is necessary during the window, it may result - // in an outage. This maintenance window change is made immediately. If the new - // 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 - // | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes. + // in an outage. + // + // This maintenance window change is made immediately. If the new 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 | 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 diff --git a/service/redshift/api_op_ModifyClusterDbRevision.go b/service/redshift/api_op_ModifyClusterDbRevision.go index d9a293888df..d9271a708a7 100644 --- a/service/redshift/api_op_ModifyClusterDbRevision.go +++ b/service/redshift/api_op_ModifyClusterDbRevision.go @@ -31,13 +31,14 @@ func (c *Client) ModifyClusterDbRevision(ctx context.Context, params *ModifyClus type ModifyClusterDbRevisionInput struct { // The unique identifier of a cluster whose database revision you want to modify. + // // Example: examplecluster // // This member is required. ClusterIdentifier *string // The identifier of the database revision. You can retrieve this value from the - // response to the DescribeClusterDbRevisions request. + // response to the DescribeClusterDbRevisionsrequest. // // This member is required. RevisionTarget *string diff --git a/service/redshift/api_op_ModifyClusterIamRoles.go b/service/redshift/api_op_ModifyClusterIamRoles.go index aa0a073c84a..7bd766caf80 100644 --- a/service/redshift/api_op_ModifyClusterIamRoles.go +++ b/service/redshift/api_op_ModifyClusterIamRoles.go @@ -12,10 +12,12 @@ import ( ) // 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. +// 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]in the Amazon Redshift Cluster Management Guide. +// +// [Quotas and limits]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html func (c *Client) ModifyClusterIamRoles(ctx context.Context, params *ModifyClusterIamRolesInput, optFns ...func(*Options)) (*ModifyClusterIamRolesOutput, error) { if params == nil { params = &ModifyClusterIamRolesInput{} diff --git a/service/redshift/api_op_ModifyClusterParameterGroup.go b/service/redshift/api_op_ModifyClusterParameterGroup.go index 0794b80fbbd..a00d43363d5 100644 --- a/service/redshift/api_op_ModifyClusterParameterGroup.go +++ b/service/redshift/api_op_ModifyClusterParameterGroup.go @@ -12,9 +12,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// can't contain ASCII characters. +// +// For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups] in the +// Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html func (c *Client) ModifyClusterParameterGroup(ctx context.Context, params *ModifyClusterParameterGroupInput, optFns ...func(*Options)) (*ModifyClusterParameterGroupOutput, error) { if params == nil { params = &ModifyClusterParameterGroupInput{} @@ -39,10 +42,13 @@ type ModifyClusterParameterGroupInput struct { ParameterGroupName *string // An array of parameters to be modified. A maximum of 20 parameters can be - // modified in a single request. For each parameter to be modified, you must supply - // at least the parameter name and parameter value; other name-value pairs of the - // parameter are optional. For the workload management (WLM) configuration, you - // must supply all the name-value pairs in the wlm_json_configuration parameter. + // modified in a single request. + // + // For each parameter to be modified, you must supply at least the parameter name + // and parameter value; other name-value pairs of the parameter are optional. + // + // For the workload management (WLM) configuration, you must supply all the + // name-value pairs in the wlm_json_configuration parameter. // // This member is required. Parameters []types.Parameter diff --git a/service/redshift/api_op_ModifyClusterSnapshot.go b/service/redshift/api_op_ModifyClusterSnapshot.go index 04dffbe60ce..1f21766af55 100644 --- a/service/redshift/api_op_ModifyClusterSnapshot.go +++ b/service/redshift/api_op_ModifyClusterSnapshot.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Modifies the settings for a snapshot. This exanmple modifies the manual -// retention period setting for a cluster snapshot. +// Modifies the settings for a snapshot. +// +// This exanmple modifies the manual retention period setting for a cluster +// snapshot. func (c *Client) ModifyClusterSnapshot(ctx context.Context, params *ModifyClusterSnapshotInput, optFns ...func(*Options)) (*ModifyClusterSnapshotOutput, error) { if params == nil { params = &ModifyClusterSnapshotInput{} @@ -40,10 +42,12 @@ type ModifyClusterSnapshotInput struct { Force *bool // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely. If the manual snapshot falls outside - // of the new retention period, you can specify the force option to immediately - // delete the snapshot. The value must be either -1 or an integer between 1 and - // 3,653. + // manual snapshot is retained indefinitely. + // + // If the manual snapshot falls outside of the new retention period, you can + // specify the force option to immediately delete the snapshot. + // + // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 noSmithyDocumentSerde diff --git a/service/redshift/api_op_ModifyEventSubscription.go b/service/redshift/api_op_ModifyEventSubscription.go index e29d06ff23c..aa44c18cf16 100644 --- a/service/redshift/api_op_ModifyEventSubscription.go +++ b/service/redshift/api_op_ModifyEventSubscription.go @@ -39,12 +39,15 @@ type ModifyEventSubscriptionInput struct { Enabled *bool // Specifies the Amazon Redshift event categories to be published by the event - // notification subscription. Values: configuration, management, monitoring, - // security, pending + // notification subscription. + // + // Values: configuration, management, monitoring, security, pending EventCategories []string // Specifies the Amazon Redshift event severity to be published by the event - // notification subscription. Values: ERROR, INFO + // notification subscription. + // + // Values: ERROR, INFO Severity *string // The Amazon Resource Name (ARN) of the SNS topic to be used by the event @@ -55,17 +58,21 @@ type ModifyEventSubscriptionInput struct { // objects must be of the same type as was specified in the source type parameter. // The event subscription will return only events generated by the specified // objects. If not specified, then events are returned for all objects within the - // source type specified. Example: my-cluster-1, my-cluster-2 Example: - // my-snapshot-20131010 + // source type specified. + // + // Example: my-cluster-1, my-cluster-2 + // + // Example: my-snapshot-20131010 SourceIds []string // The type of source that will be generating the events. For example, if you want // to be notified of events generated by a cluster, you would set this parameter to // cluster. If this value is not specified, events are returned for all Amazon // Redshift objects in your Amazon Web Services account. You must specify a source - // type in order to specify source IDs. Valid values: cluster, - // cluster-parameter-group, cluster-security-group, cluster-snapshot, and - // scheduled-action. + // type in order to specify source IDs. + // + // Valid values: cluster, cluster-parameter-group, cluster-security-group, + // cluster-snapshot, and scheduled-action. SourceType *string noSmithyDocumentSerde diff --git a/service/redshift/api_op_ModifyScheduledAction.go b/service/redshift/api_op_ModifyScheduledAction.go index 8450fe219c5..3d04b17b81c 100644 --- a/service/redshift/api_op_ModifyScheduledAction.go +++ b/service/redshift/api_op_ModifyScheduledAction.go @@ -40,26 +40,26 @@ type ModifyScheduledActionInput struct { 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 @@ -77,22 +77,28 @@ type ModifyScheduledActionOutput struct { // The IAM role to assume to run the scheduled action. This IAM role must have // permission to run the Amazon Redshift API operation in the scheduled action. // 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) - // in the Amazon Redshift Cluster Management Guide. + // 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]in the Amazon Redshift Cluster Management Guide. + // + // [Using Identity-Based Policies for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html IamRole *string // List of times when the scheduled action will run. NextInvocations []time.Time // 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) - // in the Amazon CloudWatch Events User Guide. + // 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]in the Amazon CloudWatch Events User Guide. + // + // [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions Schedule *string // The description of the scheduled action. @@ -109,7 +115,9 @@ type ModifyScheduledActionOutput struct { State types.ScheduledActionState // A JSON format string of the Amazon Redshift API operation with input - // parameters. " + // parameters. + // + // " // {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} // ". TargetAction *types.ScheduledActionType diff --git a/service/redshift/api_op_ModifySnapshotCopyRetentionPeriod.go b/service/redshift/api_op_ModifySnapshotCopyRetentionPeriod.go index 9964f8884b1..00597cdec04 100644 --- a/service/redshift/api_op_ModifySnapshotCopyRetentionPeriod.go +++ b/service/redshift/api_op_ModifySnapshotCopyRetentionPeriod.go @@ -38,24 +38,36 @@ type ModifySnapshotCopyRetentionPeriodInput struct { // The unique identifier of the cluster for which you want to change the retention // period for either automated or manual snapshots that are copied to a destination - // Amazon Web Services Region. Constraints: Must be the valid name of an existing - // cluster that has cross-region snapshot copy enabled. + // Amazon Web Services Region. + // + // Constraints: Must be the valid name of an existing cluster that has + // cross-region snapshot copy enabled. // // This member is required. ClusterIdentifier *string // The number of days to retain automated snapshots in the destination Amazon Web // Services Region after they are copied from the source Amazon Web Services - // Region. By default, this only changes the retention period of copied automated - // snapshots. If you decrease the retention period for automated snapshots that are - // copied to a destination Amazon Web Services Region, Amazon Redshift deletes any - // existing automated snapshots that were copied to the destination Amazon Web - // Services Region and that fall outside of the new retention period. Constraints: - // Must be at least 1 and no more than 35 for automated snapshots. If you specify - // the manual option, only newly copied manual snapshots will have the new - // retention period. If you specify the value of -1 newly copied manual snapshots - // are retained indefinitely. Constraints: The number of days must be either -1 or - // an integer between 1 and 3,653 for manual snapshots. + // Region. + // + // By default, this only changes the retention period of copied automated + // snapshots. + // + // If you decrease the retention period for automated snapshots that are copied to + // a destination Amazon Web Services Region, Amazon Redshift deletes any existing + // automated snapshots that were copied to the destination Amazon Web Services + // Region and that fall outside of the new retention period. + // + // Constraints: Must be at least 1 and no more than 35 for automated snapshots. + // + // If you specify the manual option, only newly copied manual snapshots will have + // the new retention period. + // + // If you specify the value of -1 newly copied manual snapshots are retained + // indefinitely. + // + // Constraints: The number of days must be either -1 or an integer between 1 and + // 3,653 for manual snapshots. // // This member is required. RetentionPeriod *int32 diff --git a/service/redshift/api_op_ModifyUsageLimit.go b/service/redshift/api_op_ModifyUsageLimit.go index 0784ae1dd25..c6936edf83e 100644 --- a/service/redshift/api_op_ModifyUsageLimit.go +++ b/service/redshift/api_op_ModifyUsageLimit.go @@ -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 @@ -54,8 +54,11 @@ type ModifyUsageLimitOutput struct { // 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 diff --git a/service/redshift/api_op_PurchaseReservedNodeOffering.go b/service/redshift/api_op_PurchaseReservedNodeOffering.go index f93cc192427..34e2f46bfa3 100644 --- a/service/redshift/api_op_PurchaseReservedNodeOffering.go +++ b/service/redshift/api_op_PurchaseReservedNodeOffering.go @@ -13,11 +13,14 @@ import ( // Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set // of reserved node offerings. You can purchase one or more of the offerings. You -// 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) -// in the Amazon Redshift Cluster Management Guide. +// can call the DescribeReservedNodeOfferingsAPI 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] in the Amazon +// Redshift Cluster Management Guide. +// +// [Purchasing Reserved Nodes]: https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html func (c *Client) PurchaseReservedNodeOffering(ctx context.Context, params *PurchaseReservedNodeOfferingInput, optFns ...func(*Options)) (*PurchaseReservedNodeOfferingOutput, error) { if params == nil { params = &PurchaseReservedNodeOfferingInput{} @@ -40,7 +43,9 @@ type PurchaseReservedNodeOfferingInput struct { // This member is required. ReservedNodeOfferingId *string - // The number of reserved nodes that you want to purchase. Default: 1 + // The number of reserved nodes that you want to purchase. + // + // Default: 1 NodeCount *int32 noSmithyDocumentSerde @@ -48,8 +53,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 aa013e70e50..a24e32c13ef 100644 --- a/service/redshift/api_op_RebootCluster.go +++ b/service/redshift/api_op_RebootCluster.go @@ -14,9 +14,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. +// cluster modifications (see ModifyCluster) are applied at this reboot. For more information +// about managing clusters, go to [Amazon Redshift Clusters]in the Amazon Redshift Cluster Management Guide. +// +// [Amazon Redshift Clusters]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html 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 b839944c3e5..93f192e566f 100644 --- a/service/redshift/api_op_ResetClusterParameterGroup.go +++ b/service/redshift/api_op_ResetClusterParameterGroup.go @@ -38,12 +38,15 @@ type ResetClusterParameterGroupInput struct { 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. + // 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 - // default values. Default: true + // default values. + // + // Default: true ResetAllParameters *bool noSmithyDocumentSerde diff --git a/service/redshift/api_op_ResizeCluster.go b/service/redshift/api_op_ResizeCluster.go index 60c16796088..5e056606b2e 100644 --- a/service/redshift/api_op_ResizeCluster.go +++ b/service/redshift/api_op_ResizeCluster.go @@ -14,18 +14,30 @@ import ( // Changes the size of the cluster. You can change the cluster's type, or change // the number or type of nodes. The default behavior is to use the elastic resize // 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: +// 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. func (c *Client) ResizeCluster(ctx context.Context, params *ResizeClusterInput, optFns ...func(*Options)) (*ResizeClusterOutput, error) { if params == nil { diff --git a/service/redshift/api_op_RestoreFromClusterSnapshot.go b/service/redshift/api_op_RestoreFromClusterSnapshot.go index c751929f86e..2ade4f788aa 100644 --- a/service/redshift/api_op_RestoreFromClusterSnapshot.go +++ b/service/redshift/api_op_RestoreFromClusterSnapshot.go @@ -15,13 +15,18 @@ import ( // resulting cluster with the same configuration as the original cluster from which // the snapshot was created, except that the new cluster is created with the // default cluster security and parameter groups. After Amazon Redshift creates the -// cluster, you can use the ModifyCluster API to associate a different security -// group and different parameter group with the restored cluster. If you are using -// 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) -// in the Amazon Redshift Cluster Management Guide. +// cluster, you can use the ModifyClusterAPI to associate a different security group and +// different parameter group with the restored cluster. If you are using 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] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Snapshots]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html func (c *Client) RestoreFromClusterSnapshot(ctx context.Context, params *RestoreFromClusterSnapshotInput, optFns ...func(*Options)) (*RestoreFromClusterSnapshotOutput, error) { if params == nil { params = &RestoreFromClusterSnapshotInput{} @@ -40,11 +45,17 @@ func (c *Client) RestoreFromClusterSnapshot(ctx context.Context, params *Restore 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. // // This member is required. @@ -54,7 +65,9 @@ type RestoreFromClusterSnapshotInput struct { AdditionalInfo *string // 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 + // 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. @@ -64,37 +77,54 @@ type RestoreFromClusterSnapshotInput struct { // 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'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. + // 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. AutomatedSnapshotRetentionPeriod *int32 - // The Amazon EC2 Availability Zone in which to restore the cluster. Default: A - // random, system-chosen Availability Zone. Example: us-east-2a + // The Amazon EC2 Availability Zone in which to restore the cluster. + // + // Default: A random, system-chosen Availability Zone. + // + // Example: us-east-2a AvailabilityZone *string // The option to enable relocation for an Amazon Redshift cluster between // 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: + // 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]. + // + // 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. + // + // [Working with Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html ClusterParameterGroupName *string - // A list of security groups to be associated with this cluster. Default: The - // default cluster security group for Amazon Redshift. Cluster security groups only - // apply to clusters outside of VPCs. + // A list of security groups to be associated with this cluster. + // + // Default: The default cluster security group for Amazon Redshift. + // + // Cluster security groups only apply to clusters outside of VPCs. ClusterSecurityGroups []string - // The name of the subnet group where you want to cluster restored. A snapshot of - // cluster in VPC can be restored only in VPC. Therefore, you must provide subnet - // group name where you want the cluster restored. + // The name of the subnet group where you want to cluster restored. + // + // A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must + // provide subnet group name where you want the cluster restored. ClusterSubnetGroupName *string // The Amazon Resource Name (ARN) for the IAM role that was set as default for the @@ -113,9 +143,14 @@ type RestoreFromClusterSnapshotInput struct { // 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 + // must be in a VPC. For more information, see [Enhanced VPC Routing]in the Amazon Redshift Cluster + // Management Guide. + // + // If this option is true , enhanced VPC routing is enabled. + // + // Default: false + // + // [Enhanced VPC Routing]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html EnhancedVpcRouting *bool // Specifies the name of the HSM client certificate the Amazon Redshift cluster @@ -128,10 +163,12 @@ type RestoreFromClusterSnapshotInput struct { // A list of Identity and Access Management (IAM) roles that can be used by the // 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) - // in the Amazon Redshift Cluster Management Guide. + // 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]in the Amazon Redshift Cluster Management Guide. + // + // [Quotas and limits]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html IamRoles []string // The IP address type for the cluster. Possible values are ipv4 and dualstack . @@ -161,8 +198,9 @@ type RestoreFromClusterSnapshotInput struct { // 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. The value must be either -1 or an integer between - // 1 and 3,653. + // period of existing snapshots. + // + // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 // The ID of the Key Management Service (KMS) key used to encrypt and store the @@ -174,17 +212,20 @@ type RestoreFromClusterSnapshotInput struct { // Availability Zones. MultiAZ *bool - // The node type that the restored cluster will be provisioned with. Default: The - // node type of the cluster from which the snapshot was taken. You can modify this - // if you are using any DS node type. In that case, you can choose to restore into - // another DS node type of the same size. For example, you can restore ds1.8xlarge - // into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, - // you must restore into that same instance type and size. In other words, you can - // 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) - // in the Amazon Redshift Cluster Management Guide. + // The node type that the restored cluster will be provisioned with. + // + // Default: The node type of the cluster from which the snapshot was taken. You + // can modify this if you are using any DS node type. In that case, you can choose + // to restore into another DS node type of the same size. For example, you can + // restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have + // a DC instance type, you must restore into that same instance type and size. In + // other words, you can 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]in the + // Amazon Redshift Cluster Management Guide. + // + // [About Clusters and Nodes]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes NodeType *string // The number of nodes specified when provisioning the restored cluster. @@ -195,18 +236,29 @@ type RestoreFromClusterSnapshotInput struct { // snapshot. OwnerAccount *string - // The port number on which the cluster accepts connections. Default: The same - // port as the original cluster. Valid values: For clusters with ds2 or dc2 nodes, - // must be within the range 1150 - 65535 . For clusters with ra3 nodes, must be - // within the ranges 5431 - 5455 or 8191 - 8215 . + // The port number on which the cluster accepts connections. + // + // Default: The same port as the original cluster. + // + // Valid values: For clusters with ds2 or dc2 nodes, must be within the range 1150 - + // 65535 . For clusters with ra3 nodes, must be within the ranges 5431 - 5455 or + // 8191 - 8215 . 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) - // in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | - // Fri | Sat | Sun Constraints: Minimum 30-minute window. + // 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]in Amazon + // Redshift Cluster Management Guide. + // + // Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun + // + // Constraints: Minimum 30-minute window. + // + // [Maintenance Windows]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows PreferredMaintenanceWindow *string // If true , the cluster can be accessed from a public network. @@ -227,7 +279,9 @@ type RestoreFromClusterSnapshotInput struct { // 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 - // both. Example: my-snapshot-id + // both. + // + // Example: my-snapshot-id SnapshotIdentifier *string // A unique identifier for the snapshot schedule. @@ -237,7 +291,10 @@ type RestoreFromClusterSnapshotInput struct { TargetReservedNodeOfferingId *string // A list of Virtual Private Cloud (VPC) security groups to be associated with the - // cluster. Default: The default VPC security group is associated with the cluster. + // cluster. + // + // Default: The default VPC security group is associated with the cluster. + // // VPC security groups only apply to clusters in VPCs. VpcSecurityGroupIds []string diff --git a/service/redshift/api_op_RestoreTableFromClusterSnapshot.go b/service/redshift/api_op_RestoreTableFromClusterSnapshot.go index b48c231af68..9c00f733f14 100644 --- a/service/redshift/api_op_RestoreTableFromClusterSnapshot.go +++ b/service/redshift/api_op_RestoreTableFromClusterSnapshot.go @@ -13,17 +13,21 @@ import ( // Creates a new table from a table in an Amazon Redshift cluster snapshot. You // must create the new table within the Amazon Redshift cluster that the snapshot -// was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a -// table with the same name as an existing table in an Amazon Redshift cluster. -// 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) -// . +// was taken from. +// +// You cannot use RestoreTableFromClusterSnapshot to restore a table with the same +// name as an existing table in an Amazon Redshift cluster. 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]. +// +// [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{} diff --git a/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go b/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go index 7bbe9699dd6..7956227fca1 100644 --- a/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go +++ b/service/redshift/api_op_RevokeClusterSecurityGroupIngress.go @@ -12,10 +12,11 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// 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]in the Amazon Redshift +// Cluster Management Guide. +// +// [Amazon Redshift Cluster Security Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html func (c *Client) RevokeClusterSecurityGroupIngress(ctx context.Context, params *RevokeClusterSecurityGroupIngressInput, optFns ...func(*Options)) (*RevokeClusterSecurityGroupIngressOutput, error) { if params == nil { params = &RevokeClusterSecurityGroupIngressInput{} @@ -52,6 +53,7 @@ type RevokeClusterSecurityGroupIngressInput struct { // specified in the EC2SecurityGroupName parameter. The Amazon Web Services access // key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, // EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. + // // Example: 111122223333 EC2SecurityGroupOwnerId *string diff --git a/service/redshift/api_op_RevokeSnapshotAccess.go b/service/redshift/api_op_RevokeSnapshotAccess.go index e43c274495b..1fedfb07e02 100644 --- a/service/redshift/api_op_RevokeSnapshotAccess.go +++ b/service/redshift/api_op_RevokeSnapshotAccess.go @@ -13,9 +13,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// restore will run to completion. +// +// For more information about working with snapshots, go to [Amazon Redshift Snapshots] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Snapshots]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html func (c *Client) RevokeSnapshotAccess(ctx context.Context, params *RevokeSnapshotAccessInput, optFns ...func(*Options)) (*RevokeSnapshotAccessOutput, error) { if params == nil { params = &RevokeSnapshotAccessInput{} diff --git a/service/redshift/api_op_RotateEncryptionKey.go b/service/redshift/api_op_RotateEncryptionKey.go index b7c820e6c8c..abef7577256 100644 --- a/service/redshift/api_op_RotateEncryptionKey.go +++ b/service/redshift/api_op_RotateEncryptionKey.go @@ -30,8 +30,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. + // 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 4ccb74f0423..920a913ba08 100644 --- a/service/redshift/doc.go +++ b/service/redshift/doc.go @@ -3,22 +3,31 @@ // Package redshift provides the API client, operations, and parameter types for // Amazon Redshift. // -// Amazon Redshift Overview This is an interface reference for Amazon Redshift. It -// contains documentation for one of the programming or command line interfaces you -// can use to manage Amazon Redshift clusters. Note that Amazon Redshift is -// asynchronous, which means that some interfaces may require techniques, such as -// polling or asynchronous callback handlers, to determine when a command has been -// 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 +// # Amazon Redshift +// +// # Overview +// +// This is an interface reference for Amazon Redshift. It contains documentation +// for one of the programming or command line interfaces you can use to manage +// Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means +// that some interfaces may require techniques, such as polling or asynchronous +// callback handlers, to determine when a command has been 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]. +// +// 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. +// 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]. +// +// If you are a database developer, the [Amazon Redshift Database Developer Guide] explains how to design, build, query, and +// maintain the databases that make up your data warehouse. +// +// [Using the Amazon Redshift Management Interfaces]: https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html +// [Amazon Redshift Database Developer Guide]: https://docs.aws.amazon.com/redshift/latest/dg/welcome.html +// [Amazon Redshift Getting Started Guide]: https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html package redshift diff --git a/service/redshift/options.go b/service/redshift/options.go index 1131fd4e7ff..90e843566d6 100644 --- a/service/redshift/options.go +++ b/service/redshift/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/redshift/types/enums.go b/service/redshift/types/enums.go index 0487570c646..c0c3b5bebec 100644 --- a/service/redshift/types/enums.go +++ b/service/redshift/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ActionType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionType) Values() []ActionType { return []ActionType{ "restore-cluster", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for AquaConfigurationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AquaConfigurationStatus) Values() []AquaConfigurationStatus { return []AquaConfigurationStatus{ "enabled", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for AquaStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AquaStatus) Values() []AquaStatus { return []AquaStatus{ "enabled", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for AuthorizationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizationStatus) Values() []AuthorizationStatus { return []AuthorizationStatus{ "Authorized", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for DataShareStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataShareStatus) Values() []DataShareStatus { return []DataShareStatus{ "ACTIVE", @@ -116,6 +121,7 @@ const ( // Values returns all known values for DataShareStatusForConsumer. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataShareStatusForConsumer) Values() []DataShareStatusForConsumer { return []DataShareStatusForConsumer{ @@ -137,6 +143,7 @@ const ( // Values returns all known values for DataShareStatusForProducer. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataShareStatusForProducer) Values() []DataShareStatusForProducer { return []DataShareStatusForProducer{ @@ -158,8 +165,9 @@ const ( ) // Values returns all known values for ImpactRankingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImpactRankingType) Values() []ImpactRankingType { return []ImpactRankingType{ "HIGH", @@ -177,8 +185,9 @@ const ( ) // Values returns all known values for LogDestinationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogDestinationType) Values() []LogDestinationType { return []LogDestinationType{ "s3", @@ -195,8 +204,9 @@ const ( ) // Values returns all known values for Mode. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Mode) Values() []Mode { return []Mode{ "standard", @@ -216,8 +226,9 @@ const ( // Values returns all known values for NodeConfigurationOptionsFilterName. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NodeConfigurationOptionsFilterName) Values() []NodeConfigurationOptionsFilterName { return []NodeConfigurationOptionsFilterName{ "NodeType", @@ -241,8 +252,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -264,8 +276,9 @@ const ( ) // Values returns all known values for ParameterApplyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterApplyType) Values() []ParameterApplyType { return []ParameterApplyType{ "static", @@ -285,6 +298,7 @@ const ( // 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{ @@ -304,8 +318,9 @@ const ( ) // Values returns all known values for RecommendedActionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendedActionType) Values() []RecommendedActionType { return []RecommendedActionType{ "SQL", @@ -323,8 +338,9 @@ const ( // Values returns all known values for ReservedNodeExchangeActionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservedNodeExchangeActionType) Values() []ReservedNodeExchangeActionType { return []ReservedNodeExchangeActionType{ "restore-cluster", @@ -346,8 +362,9 @@ const ( // Values returns all known values for ReservedNodeExchangeStatusType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReservedNodeExchangeStatusType) Values() []ReservedNodeExchangeStatusType { return []ReservedNodeExchangeStatusType{ "REQUESTED", @@ -369,6 +386,7 @@ const ( // 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{ @@ -387,6 +405,7 @@ const ( // Values returns all known values for ScheduledActionFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledActionFilterName) Values() []ScheduledActionFilterName { return []ScheduledActionFilterName{ @@ -404,8 +423,9 @@ const ( ) // Values returns all known values for ScheduledActionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledActionState) Values() []ScheduledActionState { return []ScheduledActionState{ "ACTIVE", @@ -424,6 +444,7 @@ const ( // Values returns all known values for ScheduledActionTypeValues. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledActionTypeValues) Values() []ScheduledActionTypeValues { return []ScheduledActionTypeValues{ @@ -443,8 +464,9 @@ const ( ) // Values returns all known values for ScheduleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleState) Values() []ScheduleState { return []ScheduleState{ "MODIFYING", @@ -462,8 +484,9 @@ const ( ) // Values returns all known values for ServiceAuthorization. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceAuthorization) Values() []ServiceAuthorization { return []ServiceAuthorization{ "Enabled", @@ -482,6 +505,7 @@ const ( // Values returns all known values for SnapshotAttributeToSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotAttributeToSortBy) Values() []SnapshotAttributeToSortBy { return []SnapshotAttributeToSortBy{ @@ -500,8 +524,9 @@ const ( ) // Values returns all known values for SortByOrder. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortByOrder) Values() []SortByOrder { return []SortByOrder{ "ASC", @@ -521,8 +546,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "cluster", @@ -545,8 +571,9 @@ const ( ) // Values returns all known values for TableRestoreStatusType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableRestoreStatusType) Values() []TableRestoreStatusType { return []TableRestoreStatusType{ "PENDING", @@ -567,8 +594,9 @@ const ( ) // Values returns all known values for UsageLimitBreachAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitBreachAction) Values() []UsageLimitBreachAction { return []UsageLimitBreachAction{ "log", @@ -587,8 +615,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "spectrum", @@ -606,8 +635,9 @@ const ( ) // Values returns all known values for UsageLimitLimitType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitLimitType) Values() []UsageLimitLimitType { return []UsageLimitLimitType{ "time", @@ -625,8 +655,9 @@ const ( ) // Values returns all known values for UsageLimitPeriod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitPeriod) Values() []UsageLimitPeriod { return []UsageLimitPeriod{ "daily", @@ -650,6 +681,7 @@ const ( // Values returns all known values for ZeroETLIntegrationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ZeroETLIntegrationStatus) Values() []ZeroETLIntegrationStatus { return []ZeroETLIntegrationStatus{ diff --git a/service/redshift/types/errors.go b/service/redshift/types/errors.go index 69a055544e6..5afc5218568 100644 --- a/service/redshift/types/errors.go +++ b/service/redshift/types/errors.go @@ -444,9 +444,10 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// parameter groups. For information about increasing your quota, go to [Limits in Amazon Redshift]in the +// Amazon Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type ClusterParameterGroupQuotaExceededFault struct { Message *string @@ -475,9 +476,12 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// account. +// +// For information about increasing your quota, go to [Limits in Amazon Redshift] in the Amazon Redshift +// Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type ClusterQuotaExceededFault struct { Message *string @@ -559,9 +563,10 @@ func (e *ClusterSecurityGroupNotFoundFault) ErrorCode() string { func (e *ClusterSecurityGroupNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// in the Amazon Redshift Cluster Management Guide. +// security groups. For information about increasing your quota, go to [Limits in Amazon Redshift]in the +// Amazon Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type ClusterSecurityGroupQuotaExceededFault struct { Message *string @@ -725,9 +730,10 @@ func (e *ClusterSubnetGroupNotFoundFault) ErrorCode() string { func (e *ClusterSubnetGroupNotFoundFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// in the Amazon Redshift Cluster Management Guide. +// groups. For information about increasing your quota, go to [Limits in Amazon Redshift]in the Amazon +// Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type ClusterSubnetGroupQuotaExceededFault struct { Message *string @@ -756,9 +762,10 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// cluster subnet groups. For information about increasing your quota, go to [Limits in Amazon Redshift]in +// the Amazon Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type ClusterSubnetQuotaExceededFault struct { Message *string @@ -1168,9 +1175,10 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// account. For information about increasing your quota, go to [Limits in Amazon Redshift]in the Amazon +// Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type EventSubscriptionQuotaExceededFault struct { Message *string @@ -1255,8 +1263,9 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// increasing your quota, go to [Limits in Amazon Redshift]in the Amazon Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type HsmClientCertificateQuotaExceededFault struct { Message *string @@ -1340,8 +1349,9 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// increasing your quota, go to [Limits in Amazon Redshift]in the Amazon Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type HsmConfigurationQuotaExceededFault struct { Message *string @@ -2018,6 +2028,7 @@ func (e *InvalidRestoreFault) ErrorCode() string { func (e *InvalidRestoreFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The retention period specified is either in the past or is not a valid value. +// // The value must be either -1 or an integer between 1 and 3,653. type InvalidRetentionPeriodFault struct { Message *string @@ -2044,9 +2055,10 @@ 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) +// The S3 bucket name is invalid. For more information about naming rules, go to [Bucket Restrictions and Limitations] // in the Amazon Simple Storage Service (S3) Developer Guide. +// +// [Bucket Restrictions and Limitations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html type InvalidS3BucketNameFault struct { Message *string @@ -2421,9 +2433,12 @@ func (e *NumberOfNodesPerClusterLimitExceededFault) ErrorFault() smithy.ErrorFau return smithy.FaultClient } -// 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) -// in the Amazon Redshift Cluster Management Guide. +// The operation would exceed the number of nodes allotted to the account. +// +// For information about increasing your quota, go to [Limits in Amazon Redshift] in the Amazon Redshift +// Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type NumberOfNodesQuotaExceededFault struct { Message *string @@ -2690,8 +2705,9 @@ 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) -// in the Amazon Redshift Cluster Management Guide. +// increasing your quota, go to [Limits in Amazon Redshift]in the Amazon Redshift Cluster Management Guide. +// +// [Limits in Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html type ReservedNodeQuotaExceededFault struct { Message *string diff --git a/service/redshift/types/types.go b/service/redshift/types/types.go index b0f6b05f70b..121d9d26f17 100644 --- a/service/redshift/types/types.go +++ b/service/redshift/types/types.go @@ -150,12 +150,17 @@ 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. ClusterAvailabilityStatus *string @@ -183,36 +188,57 @@ type Cluster struct { // A list of cluster security group that are associated with the cluster. Each // security group is represented by an element that contains - // ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster - // security groups are used when the cluster is not created in an Amazon Virtual - // Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, - // which are listed by the VpcSecurityGroups parameter. + // ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. + // + // Cluster security groups are used when the cluster is not created in an Amazon + // Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security + // groups, which are listed by the VpcSecurityGroups parameter. ClusterSecurityGroups []ClusterSecurityGroupMembership // A value that returns the destination region and retention period that are // configured for cross-region snapshot copy. ClusterSnapshotCopyStatus *ClusterSnapshotCopyStatus - // The current state of the cluster. Possible values are the following: + // 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 ClusterStatus *string @@ -262,24 +288,33 @@ type Cluster struct { // 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 + // must be in a VPC. For more information, see [Enhanced VPC Routing]in the Amazon Redshift Cluster + // Management Guide. + // + // If this option is true , enhanced VPC routing is enabled. + // + // Default: false + // + // [Enhanced VPC Routing]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html EnhancedVpcRouting *bool // The date and time when the next snapshot is expected to be taken for clusters // with a valid snapshot schedule and backups enabled. ExpectedNextSnapshotScheduleTime *time.Time - // The status of next expected snapshot for clusters having a valid snapshot + // 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. ExpectedNextSnapshotScheduleTimeStatus *string // A value that reports whether the Amazon Redshift cluster has finished applying // any hardware security module (HSM) settings changes specified in a modify - // cluster command. Values: active, applying + // cluster command. + // + // Values: active, applying HsmStatus *HsmStatus // A list of Identity and Access Management (IAM) roles that can be used by the @@ -298,8 +333,9 @@ type Cluster struct { // 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. The value must be either -1 or an integer between - // 1 and 3,653. + // period of existing snapshots. + // + // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 // The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. @@ -352,8 +388,10 @@ type Cluster struct { ReservedNodeExchangeStatus *ReservedNodeExchangeStatus // Returns the following: + // // - AllowCancelResize: a boolean value indicating if the resize operation can // be cancelled. + // // - ResizeType: Returns ClassicResize ResizeInfo *ResizeInfo @@ -419,9 +457,14 @@ type ClusterDbRevision struct { 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. + // 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. ApplyStatus *string @@ -470,9 +513,12 @@ type ClusterParameterGroup struct { // Describes the status of a parameter group. 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) - // in the Amazon Redshift Cluster Management Guide. + // The list of parameter statuses. + // + // For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups] in the + // Amazon Redshift Cluster Management Guide. + // + // [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html ClusterParameterStatusList []ClusterParameterStatus // The status of parameter updates. @@ -492,17 +538,26 @@ type ClusterParameterStatus struct { // 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. + // 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 @@ -558,8 +613,9 @@ type ClusterSnapshotCopyStatus struct { // The number of days that automated snapshots are retained in the destination // region after they are copied from a source region. If the value is -1, the - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. + // manual snapshot is retained indefinitely. + // + // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 // The number of days that automated snapshots are retained in the destination @@ -717,13 +773,13 @@ type DefaultClusterParameters struct { // Describes a deferred maintenance window type DeferredMaintenanceWindow struct { - // A timestamp for the end of the time period when we defer maintenance. + // A timestamp for the end of the time period when we defer maintenance. DeferMaintenanceEndTime *time.Time // A unique identifier for the maintenance window. DeferMaintenanceIdentifier *string - // A timestamp for the beginning of the time period when we defer maintenance. + // A timestamp for the beginning of the time period when we defer maintenance. DeferMaintenanceStartTime *time.Time noSmithyDocumentSerde @@ -731,9 +787,10 @@ 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 @@ -741,6 +798,7 @@ type DeleteClusterSnapshotMessage struct { // The unique identifier of the cluster the snapshot was created from. This // parameter is required if your IAM user has a policy containing a snapshot // resource element that specifies anything other than * for the cluster name. + // // Constraints: Must be the name of valid cluster. SnapshotClusterIdentifier *string @@ -871,8 +929,9 @@ type Event struct { // The date and time of the event. Date *time.Time - // A list of the event categories. Values: Configuration, Management, Monitoring, - // Security, Pending + // A list of the event categories. + // + // Values: Configuration, Management, Monitoring, Security, Pending EventCategories []string // The identifier of the event. @@ -881,7 +940,9 @@ type Event struct { // The text of this event. Message *string - // The severity of the event. Values: ERROR, INFO + // The severity of the event. + // + // Values: ERROR, INFO Severity *string // The identifier for the source of the event. @@ -918,7 +979,9 @@ type EventInfoMap struct { // The identifier of an Amazon Redshift event. EventId *string - // The severity of the event. Values: ERROR, INFO + // The severity of the event. + // + // Values: ERROR, INFO Severity *string noSmithyDocumentSerde @@ -939,12 +1002,15 @@ type EventSubscription struct { Enabled *bool // The list of Amazon Redshift event categories specified in the event - // notification subscription. Values: Configuration, Management, Monitoring, - // Security, Pending + // notification subscription. + // + // Values: Configuration, Management, Monitoring, Security, Pending EventCategoriesList []string // The event severity specified in the Amazon Redshift event notification - // subscription. Values: ERROR, INFO + // subscription. + // + // Values: ERROR, INFO Severity *string // The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event @@ -960,8 +1026,12 @@ type EventSubscription struct { // cluster-security-group, or scheduled-action. SourceType *string - // The status of the Amazon Redshift event notification subscription. Constraints: + // 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. @@ -1031,7 +1101,9 @@ type HsmStatus struct { HsmConfigurationIdentifier *string // Reports whether the Amazon Redshift cluster has finished applying any HSM - // settings changes specified in a modify cluster command. Values: active, applying + // settings changes specified in a modify cluster command. + // + // Values: active, applying Status *string noSmithyDocumentSerde @@ -1225,8 +1297,10 @@ 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) - // in the Amazon Redshift Cluster Management Guide. + // about parameters and parameter groups, go to [Amazon Redshift Parameter Groups]in the Amazon Redshift Cluster + // Management Guide. + // + // [Amazon Redshift Parameter Groups]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html ApplyType ParameterApplyType // The data type of the parameter. @@ -1313,9 +1387,14 @@ type PendingModifiedValues struct { // 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 + // must be in a VPC. For more information, see [Enhanced VPC Routing]in the Amazon Redshift Cluster + // Management Guide. + // + // If this option is true , enhanced VPC routing is enabled. + // + // Default: false + // + // [Enhanced VPC Routing]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html EnhancedVpcRouting *bool // The name of the maintenance track that the cluster will change to during the @@ -1467,8 +1546,8 @@ type ReferenceLink 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. @@ -1506,12 +1585,19 @@ type ReservedNode struct { // duration. This is the start time of that duration. StartTime *time.Time - // The state of the reserved compute node. Possible Values: + // 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. State *string @@ -1526,8 +1612,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. @@ -1721,14 +1807,14 @@ type ResumeClusterMessage struct { 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 @@ -1736,7 +1822,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 @@ -1746,22 +1832,28 @@ type ScheduledAction struct { // The IAM role to assume to run the scheduled action. This IAM role must have // permission to run the Amazon Redshift API operation in the scheduled action. // 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) - // in the Amazon Redshift Cluster Management Guide. + // 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]in the Amazon Redshift Cluster Management Guide. + // + // [Using Identity-Based Policies for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html IamRole *string // List of times when the scheduled action will run. NextInvocations []time.Time // 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) - // in the Amazon CloudWatch Events User Guide. + // 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]in the Amazon CloudWatch Events User Guide. + // + // [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions Schedule *string // The description of the scheduled action. @@ -1778,7 +1870,9 @@ type ScheduledAction struct { State ScheduledActionState // A JSON format string of the Amazon Redshift API operation with input - // parameters. " + // parameters. + // + // " // {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} // ". TargetAction *ScheduledActionType @@ -1900,9 +1994,14 @@ type Snapshot struct { // 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 + // must be in a VPC. For more information, see [Enhanced VPC Routing]in the Amazon Redshift Cluster + // Management Guide. + // + // If this option is true , enhanced VPC routing is enabled. + // + // Default: false + // + // [Enhanced VPC Routing]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html EnhancedVpcRouting *bool // The estimate of the time remaining before the snapshot backup will complete. @@ -1920,8 +2019,9 @@ type Snapshot struct { ManualSnapshotRemainingDays *int32 // The number of days that a manual snapshot is retained. If the value is -1, the - // manual snapshot is retained indefinitely. The value must be either -1 or an - // integer between 1 and 3,653. + // manual snapshot is retained indefinitely. + // + // The value must be either -1 or an integer between 1 and 3,653. ManualSnapshotRetentionPeriod *int32 // The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. @@ -1964,18 +2064,22 @@ type Snapshot struct { // A timestamp representing the start of the retention period for the snapshot. SnapshotRetentionStartTime *time.Time - // The snapshot type. Snapshots created using CreateClusterSnapshot and - // CopyClusterSnapshot are of type "manual". + // The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual". SnapshotType *string // 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". + // + // CreateClusterSnapshot + // - and CopyClusterSnapshotreturns 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. @@ -1994,9 +2098,12 @@ type Snapshot 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) -// in the Amazon Redshift Cluster Management Guide. +// Services KMS in the destination region. +// +// For more information about managing snapshot copy grants, go to [Amazon Redshift Database Encryption] in the Amazon +// Redshift Cluster Management Guide. +// +// [Amazon Redshift Database Encryption]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html type SnapshotCopyGrant struct { // The unique identifier of the encrypted symmetric key in Amazon Web Services KMS @@ -2139,8 +2246,9 @@ type TableRestoreStatus struct { // The name of the source table being restored. SourceTableName *string - // A value that describes the current state of the table restore request. Valid - // Values: SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS + // A value that describes the current state of the table restore request. + // + // Valid Values: SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS Status TableRestoreStatusType // The unique identifier for the table restore request. @@ -2179,18 +2287,29 @@ type TaggedResource struct { // 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) - // in the Amazon Redshift Cluster Management Guide. + // ARNs, go to [Constructing an Amazon Redshift Amazon Resource Name (ARN)]in the Amazon Redshift Cluster Management Guide. + // + // [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 ResourceType *string // The tag for the resource. @@ -2223,8 +2342,11 @@ type UsageLimit struct { // 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 diff --git a/service/redshiftdata/api_op_BatchExecuteStatement.go b/service/redshiftdata/api_op_BatchExecuteStatement.go index a58ba2cf27b..ccd8e559981 100644 --- a/service/redshiftdata/api_op_BatchExecuteStatement.go +++ b/service/redshiftdata/api_op_BatchExecuteStatement.go @@ -14,6 +14,7 @@ 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. @@ -21,25 +22,30 @@ import ( // 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. +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error) { if params == nil { params = &BatchExecuteStatementInput{} @@ -63,11 +69,12 @@ type BatchExecuteStatementInput struct { // This member is required. Database *string - // One or more SQL statements to run. The SQL statements are run as a single - // transaction. They run serially in the order of the array. Subsequent SQL - // statements don't start until the previous statement in the array completes. If - // any SQL statement fails, then because they are run as one transaction, all work - // is rolled back. + // One or more SQL statements to run. + // + // The SQL statements are run as a single transaction. They run serially in the + // order of the array. Subsequent SQL statements don't start until the previous + // statement in the array completes. If any SQL statement fails, then because they + // are run as one transaction, all work is rolled back. // // This member is required. Sqls []string diff --git a/service/redshiftdata/api_op_CancelStatement.go b/service/redshiftdata/api_op_CancelStatement.go index a8477bba03d..1796ea37ed8 100644 --- a/service/redshiftdata/api_op_CancelStatement.go +++ b/service/redshiftdata/api_op_CancelStatement.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) CancelStatement(ctx context.Context, params *CancelStatementInput, optFns ...func(*Options)) (*CancelStatementOutput, error) { if params == nil { params = &CancelStatementInput{} diff --git a/service/redshiftdata/api_op_DescribeStatement.go b/service/redshiftdata/api_op_DescribeStatement.go index fec5d0096db..fe5ab75c0c9 100644 --- a/service/redshiftdata/api_op_DescribeStatement.go +++ b/service/redshiftdata/api_op_DescribeStatement.go @@ -15,9 +15,12 @@ import ( // Describes the details about a specific instance when a query was run by the // 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. +// statement. +// +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) DescribeStatement(ctx context.Context, params *DescribeStatementInput, optFns ...func(*Options)) (*DescribeStatementOutput, error) { if params == nil { params = &DescribeStatementInput{} @@ -108,13 +111,20 @@ 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. Status types.StatusString diff --git a/service/redshiftdata/api_op_DescribeTable.go b/service/redshiftdata/api_op_DescribeTable.go index 903ba86d072..a9e73118e47 100644 --- a/service/redshiftdata/api_op_DescribeTable.go +++ b/service/redshiftdata/api_op_DescribeTable.go @@ -15,6 +15,7 @@ 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. @@ -22,25 +23,30 @@ import ( // 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. +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html 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 8cea8c10dda..3858753a74b 100644 --- a/service/redshiftdata/api_op_ExecuteStatement.go +++ b/service/redshiftdata/api_op_ExecuteStatement.go @@ -16,6 +16,7 @@ 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. @@ -23,25 +24,30 @@ import ( // 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. +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error) { if params == nil { params = &ExecuteStatementInput{} diff --git a/service/redshiftdata/api_op_GetStatementResult.go b/service/redshiftdata/api_op_GetStatementResult.go index 1b4302ab114..f11c0fc773c 100644 --- a/service/redshiftdata/api_op_GetStatementResult.go +++ b/service/redshiftdata/api_op_GetStatementResult.go @@ -12,9 +12,12 @@ 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. +// 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]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) GetStatementResult(ctx context.Context, params *GetStatementResultInput, optFns ...func(*Options)) (*GetStatementResultOutput, error) { if params == nil { params = &GetStatementResultInput{} diff --git a/service/redshiftdata/api_op_ListDatabases.go b/service/redshiftdata/api_op_ListDatabases.go index ae563866940..c6f13fa0cc8 100644 --- a/service/redshiftdata/api_op_ListDatabases.go +++ b/service/redshiftdata/api_op_ListDatabases.go @@ -13,6 +13,7 @@ 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. @@ -20,25 +21,30 @@ import ( // 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. +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html 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 7a4c8723380..4d7d89bcf26 100644 --- a/service/redshiftdata/api_op_ListSchemas.go +++ b/service/redshiftdata/api_op_ListSchemas.go @@ -13,6 +13,7 @@ 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. @@ -20,25 +21,30 @@ import ( // 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. +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html 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 9be0d3fb30c..2c21636e46c 100644 --- a/service/redshiftdata/api_op_ListStatements.go +++ b/service/redshiftdata/api_op_ListStatements.go @@ -12,10 +12,12 @@ import ( ) // List of SQL statements. By default, only finished statements are shown. A token -// is returned to page through the statement list. 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. +// is returned to page through the statement list. +// +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) ListStatements(ctx context.Context, params *ListStatementsInput, optFns ...func(*Options)) (*ListStatementsOutput, error) { if params == nil { params = &ListStatementsInput{} @@ -60,13 +62,20 @@ type ListStatementsInput struct { 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. Status types.StatusString diff --git a/service/redshiftdata/api_op_ListTables.go b/service/redshiftdata/api_op_ListTables.go index 1ea50619597..02990530f29 100644 --- a/service/redshiftdata/api_op_ListTables.go +++ b/service/redshiftdata/api_op_ListTables.go @@ -15,6 +15,7 @@ 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. @@ -22,25 +23,30 @@ import ( // 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. +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error) { if params == nil { params = &ListTablesInput{} diff --git a/service/redshiftdata/doc.go b/service/redshiftdata/doc.go index f8e24602ebc..7991842f958 100644 --- a/service/redshiftdata/doc.go +++ b/service/redshiftdata/doc.go @@ -5,7 +5,10 @@ // // 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. +// succeeds. +// +// For more information about the Amazon Redshift Data API and CLI usage examples, +// see [Using the Amazon Redshift Data API]in the Amazon Redshift Management Guide. +// +// [Using the Amazon Redshift Data API]: https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html package redshiftdata diff --git a/service/redshiftdata/options.go b/service/redshiftdata/options.go index 75274d1da99..09db6e4ae63 100644 --- a/service/redshiftdata/options.go +++ b/service/redshiftdata/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/redshiftdata/types/enums.go b/service/redshiftdata/types/enums.go index de5c372c870..dce58f5a3d5 100644 --- a/service/redshiftdata/types/enums.go +++ b/service/redshiftdata/types/enums.go @@ -15,8 +15,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SUBMITTED", @@ -42,8 +43,9 @@ const ( ) // 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. +// expanded in the future, and so 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 9df5fc91636..9ffce80cf60 100644 --- a/service/redshiftdata/types/types.go +++ b/service/redshiftdata/types/types.go @@ -129,8 +129,10 @@ 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]in the Amazon Redshift Database Developer + // Guide. + // + // [Data types]: https://docs.aws.amazon.com/redshift/latest/dg/c_Supported_data_types.html // // This member is required. Value *string diff --git a/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go b/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go index 864a6e94dd5..55b12a5b36d 100644 --- a/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go +++ b/service/redshiftserverless/api_op_ConvertRecoveryPointToSnapshot.go @@ -12,8 +12,9 @@ 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]. +// +// [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 +45,9 @@ 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) - // to associate with the created snapshot. + // An array of [Tag objects] to associate with the created snapshot. + // + // [Tag objects]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/redshiftserverless/api_op_CreateNamespace.go b/service/redshiftserverless/api_op_CreateNamespace.go index 0ba789b75f7..4a9918dd5c7 100644 --- a/service/redshiftserverless/api_op_CreateNamespace.go +++ b/service/redshiftserverless/api_op_CreateNamespace.go @@ -40,7 +40,9 @@ type CreateNamespaceInput struct { AdminPasswordSecretKmsKeyId *string // The password of the administrator for the first database created in the - // namespace. You can't use adminUserPassword if manageAdminPassword is true. + // namespace. + // + // You can't use adminUserPassword if manageAdminPassword is true. AdminUserPassword *string // The username of the administrator for the first database created in the diff --git a/service/redshiftserverless/api_op_CreateScheduledAction.go b/service/redshiftserverless/api_op_CreateScheduledAction.go index 5c931ed68a9..d3aeb2cf8d6 100644 --- a/service/redshiftserverless/api_op_CreateScheduledAction.go +++ b/service/redshiftserverless/api_op_CreateScheduledAction.go @@ -42,9 +42,10 @@ type CreateScheduledActionInput struct { // scheduled action. This IAM role must allow the Amazon Redshift scheduler to // schedule creating snapshots. (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) - // in the Amazon Redshift Cluster Management Guide + // use with the Amazon Redshift scheduler, see [Using Identity-Based Policies for Amazon Redshift]in the Amazon Redshift Cluster + // Management Guide + // + // [Using Identity-Based Policies for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html // // This member is required. RoleArn *string @@ -52,12 +53,15 @@ type CreateScheduledActionInput struct { // The schedule for a one-time (at timestamp format) or recurring (cron format) // scheduled action. Schedule invocations must be separated by at least one hour. // Times are in UTC. + // // - Format of at timestamp is yyyy-mm-ddThh:mm:ss . For example, // 2016-03-04T17:27:00 . + // // - Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week - // Year) . For example, "(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. + // Year) . For example, "(0 10 ? * MON *)" . For more information, see [Cron Expressions]in the + // Amazon CloudWatch Events User Guide. + // + // [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions // // This member is required. Schedule types.Schedule @@ -68,17 +72,18 @@ type CreateScheduledActionInput struct { ScheduledActionName *string // A JSON format string of the Amazon Redshift Serverless API operation with input - // parameters. The following is an example of a target action. "{"CreateSnapshot": - // {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", - // "retentionPeriod": "1"}}" + // parameters. The following is an example of a target action. + // + // "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": + // "sampleSnapshot", "retentionPeriod": "1"}}" // // This member is required. TargetAction types.TargetAction // Indicates whether the schedule is enabled. If false, the scheduled action does - // not trigger. For more information about state of the scheduled action, see - // ScheduledAction (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html) - // . + // not trigger. For more information about state of the scheduled action, see [ScheduledAction]. + // + // [ScheduledAction]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html Enabled *bool // The end time in UTC when the schedule is no longer active. After this time, the diff --git a/service/redshiftserverless/api_op_CreateSnapshot.go b/service/redshiftserverless/api_op_CreateSnapshot.go index bb9156d4b85..0142b437b31 100644 --- a/service/redshiftserverless/api_op_CreateSnapshot.go +++ b/service/redshiftserverless/api_op_CreateSnapshot.go @@ -12,8 +12,9 @@ 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]. +// +// [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 +45,9 @@ 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) - // to associate with the snapshot. + // An array of [Tag objects] to associate with the snapshot. + // + // [Tag objects]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/redshiftserverless/api_op_CreateWorkgroup.go b/service/redshiftserverless/api_op_CreateWorkgroup.go index 5475e590806..1054de6904d 100644 --- a/service/redshiftserverless/api_op_CreateWorkgroup.go +++ b/service/redshiftserverless/api_op_CreateWorkgroup.go @@ -48,8 +48,9 @@ type CreateWorkgroupInput struct { // enable_user_activity_logging , query_group , search_path , require_ssl , // use_fips_ssl , 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]. + // + // [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 diff --git a/service/redshiftserverless/api_op_GetCredentials.go b/service/redshiftserverless/api_op_GetCredentials.go index dc0b6b688d1..3ebe36277b9 100644 --- a/service/redshiftserverless/api_op_GetCredentials.go +++ b/service/redshiftserverless/api_op_GetCredentials.go @@ -12,13 +12,18 @@ import ( ) // 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. +// 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{} @@ -41,15 +46,22 @@ type GetCredentialsInput struct { CustomDomainName *string // 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 + // + // - Cannot be a reserved word. A list of reserved words can be found in [Reserved Words]in the + // Amazon Redshift Database Developer Guide + // + // [Reserved Words]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html DbName *string // The number of seconds until the returned temporary password expires. The diff --git a/service/redshiftserverless/api_op_ListWorkgroups.go b/service/redshiftserverless/api_op_ListWorkgroups.go index 76085375287..228977f904d 100644 --- a/service/redshiftserverless/api_op_ListWorkgroups.go +++ b/service/redshiftserverless/api_op_ListWorkgroups.go @@ -52,7 +52,7 @@ type ListWorkgroupsOutput struct { // This member is required. Workgroups []types.Workgroup - // If nextToken is returned, there are more results available. The value of + // If nextToken is returned, there are more results available. The value of // nextToken is a unique pagination token for each page. To retrieve the next page, // make the call again using the returned token. NextToken *string diff --git a/service/redshiftserverless/api_op_PutResourcePolicy.go b/service/redshiftserverless/api_op_PutResourcePolicy.go index 2bd7bc5900d..587fe65b67a 100644 --- a/service/redshiftserverless/api_op_PutResourcePolicy.go +++ b/service/redshiftserverless/api_op_PutResourcePolicy.go @@ -31,10 +31,12 @@ func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolic type PutResourcePolicyInput struct { // The policy to create or update. For example, the following policy grants a user - // authorization to restore a snapshot. "{\"Version\": \"2012-10-17\", - // \"Statement\" : [{ \"Sid\": \"AllowUserRestoreFromSnapshot\", - // \"Principal\":{\"AWS\": [\"739247239426\"]}, \"Action\": - // [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": \"Allow\" }]}" + // authorization to restore a snapshot. + // + // "{\"Version\": \"2012-10-17\", \"Statement\" : [{ \"Sid\": + // \"AllowUserRestoreFromSnapshot\", \"Principal\":{\"AWS\": [\"739247239426\"]}, + // \"Action\": [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": + // \"Allow\" }]}" // // This member is required. Policy *string diff --git a/service/redshiftserverless/api_op_RestoreFromSnapshot.go b/service/redshiftserverless/api_op_RestoreFromSnapshot.go index 55db1f69b00..49a448b5b4b 100644 --- a/service/redshiftserverless/api_op_RestoreFromSnapshot.go +++ b/service/redshiftserverless/api_op_RestoreFromSnapshot.go @@ -54,7 +54,9 @@ 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 diff --git a/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go b/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go index d83660815a3..4b453f17f56 100644 --- a/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go +++ b/service/redshiftserverless/api_op_RestoreTableFromSnapshot.go @@ -12,8 +12,9 @@ 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]. +// +// [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 10f45aa82b8..b0c726ac55b 100644 --- a/service/redshiftserverless/api_op_UpdateNamespace.go +++ b/service/redshiftserverless/api_op_UpdateNamespace.go @@ -44,8 +44,9 @@ type UpdateNamespaceInput struct { AdminPasswordSecretKmsKeyId *string // The password of the administrator for the first database created in the - // namespace. This parameter must be updated together with adminUsername . You - // can't use adminUserPassword if manageAdminPassword is true. + // namespace. This parameter must be updated together with adminUsername . + // + // You can't use adminUserPassword if manageAdminPassword is true. AdminUserPassword *string // The username of the administrator for the first database created in the diff --git a/service/redshiftserverless/api_op_UpdateScheduledAction.go b/service/redshiftserverless/api_op_UpdateScheduledAction.go index e237a50273e..06cbb550ffc 100644 --- a/service/redshiftserverless/api_op_UpdateScheduledAction.go +++ b/service/redshiftserverless/api_op_UpdateScheduledAction.go @@ -46,20 +46,24 @@ type UpdateScheduledActionInput struct { // scheduled action. This IAM role must allow the Amazon Redshift scheduler to // schedule creating snapshots (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) - // in the Amazon Redshift Cluster Management Guide + // use with the Amazon Redshift scheduler, see [Using Identity-Based Policies for Amazon Redshift]in the Amazon Redshift Cluster + // Management Guide + // + // [Using Identity-Based Policies for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html RoleArn *string // The schedule for a one-time (at timestamp format) or recurring (cron format) // scheduled action. Schedule invocations must be separated by at least one hour. // Times are in UTC. + // // - Format of at timestamp is yyyy-mm-ddThh:mm:ss . For example, // 2016-03-04T17:27:00 . + // // - Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week - // Year) . For example, "(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. + // Year) . For example, "(0 10 ? * MON *)" . For more information, see [Cron Expressions]in the + // Amazon CloudWatch Events User Guide. + // + // [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions Schedule types.Schedule // The descripion of the scheduled action to update to. @@ -69,9 +73,10 @@ type UpdateScheduledActionInput struct { StartTime *time.Time // A JSON format string of the Amazon Redshift Serverless API operation with input - // parameters. The following is an example of a target action. "{"CreateSnapshot": - // {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", - // "retentionPeriod": "1"}}" + // parameters. The following is an example of a target action. + // + // "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": + // "sampleSnapshot", "retentionPeriod": "1"}}" TargetAction types.TargetAction noSmithyDocumentSerde diff --git a/service/redshiftserverless/api_op_UpdateWorkgroup.go b/service/redshiftserverless/api_op_UpdateWorkgroup.go index f1d6622cbd9..5fa86736f1f 100644 --- a/service/redshiftserverless/api_op_UpdateWorkgroup.go +++ b/service/redshiftserverless/api_op_UpdateWorkgroup.go @@ -45,8 +45,9 @@ type UpdateWorkgroupInput struct { // enable_user_activity_logging , query_group , search_path , require_ssl , // use_fips_ssl , 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]. + // + // [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 diff --git a/service/redshiftserverless/doc.go b/service/redshiftserverless/doc.go index fe864e69b59..cf606538291 100644 --- a/service/redshiftserverless/doc.go +++ b/service/redshiftserverless/doc.go @@ -5,13 +5,16 @@ // // This is an interface reference for Amazon Redshift Serverless. It contains // documentation for one of the programming or command line interfaces you can use -// to manage Amazon Redshift Serverless. Amazon Redshift Serverless automatically -// provisions data warehouse capacity and intelligently scales the underlying -// resources based on workload demands. Amazon Redshift Serverless adjusts capacity -// in seconds to deliver consistently high performance and simplified operations -// 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) -// . +// to manage Amazon Redshift Serverless. +// +// Amazon Redshift Serverless automatically provisions data warehouse capacity and +// intelligently scales the underlying resources based on workload demands. Amazon +// Redshift Serverless adjusts capacity in seconds to deliver consistently high +// performance and simplified operations 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]. +// +// [What is Amazon Redshift Serverless]: https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-whatis.html package redshiftserverless diff --git a/service/redshiftserverless/options.go b/service/redshiftserverless/options.go index 3037bef5056..3b9e9f280eb 100644 --- a/service/redshiftserverless/options.go +++ b/service/redshiftserverless/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/redshiftserverless/types/enums.go b/service/redshiftserverless/types/enums.go index 67ff9aeda43..de41a1f272f 100644 --- a/service/redshiftserverless/types/enums.go +++ b/service/redshiftserverless/types/enums.go @@ -12,8 +12,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for NamespaceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceStatus) Values() []NamespaceStatus { return []NamespaceStatus{ "AVAILABLE", @@ -55,8 +57,9 @@ const ( ) // Values returns all known values for SnapshotStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnapshotStatus) Values() []SnapshotStatus { return []SnapshotStatus{ "AVAILABLE", @@ -77,8 +80,9 @@ const ( ) // 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. +// the future, and so 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{ "ACTIVE", @@ -96,8 +100,9 @@ const ( ) // Values returns all known values for UsageLimitBreachAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitBreachAction) Values() []UsageLimitBreachAction { return []UsageLimitBreachAction{ "log", @@ -116,8 +121,9 @@ const ( ) // Values returns all known values for UsageLimitPeriod. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitPeriod) Values() []UsageLimitPeriod { return []UsageLimitPeriod{ "daily", @@ -135,8 +141,9 @@ const ( ) // Values returns all known values for UsageLimitUsageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageLimitUsageType) Values() []UsageLimitUsageType { return []UsageLimitUsageType{ "serverless-compute", @@ -155,8 +162,9 @@ const ( ) // Values returns all known values for WorkgroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkgroupStatus) Values() []WorkgroupStatus { return []WorkgroupStatus{ "CREATING", diff --git a/service/redshiftserverless/types/types.go b/service/redshiftserverless/types/types.go index 64242565d33..859dfaad59b 100644 --- a/service/redshiftserverless/types/types.go +++ b/service/redshiftserverless/types/types.go @@ -33,9 +33,9 @@ type ConfigParameter struct { // enable_case_sensitive_identifier , enable_user_activity_logging , query_group , // search_path , require_ssl , use_fips_ssl , 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) - // . + // rules and available metrics, see [Query monitoring metrics for Amazon Redshift Serverless]. + // + // [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. @@ -44,10 +44,11 @@ type ConfigParameter struct { noSmithyDocumentSerde } -// The parameters that you can use to configure a scheduled action (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html) -// to create a snapshot. For more information about creating a scheduled action, -// see CreateScheduledAction (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html) -// . +// The parameters that you can use to configure a [scheduled action] to create a snapshot. For more +// information about creating a scheduled action, see [CreateScheduledAction]. +// +// [CreateScheduledAction]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html +// [scheduled action]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html type CreateSnapshotScheduleActionParameters struct { // The name of the namespace for which you want to configure a scheduled action to @@ -66,8 +67,9 @@ type CreateSnapshotScheduleActionParameters struct { // The retention period of the snapshot created by the scheduled action. RetentionPeriod *int32 - // An array of Tag objects (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html) - // to associate with the snapshot. + // An array of [Tag objects] to associate with the snapshot. + // + // [Tag objects]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_Tag.html Tags []Tag noSmithyDocumentSerde @@ -170,8 +172,9 @@ 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]in the Amazon Redshift Database Developer Guide. + // + // [Reserved Words]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html NamespaceName *string // The status of the namespace. @@ -260,10 +263,13 @@ type ScheduleMemberAt struct { func (*ScheduleMemberAt) isSchedule() {} // The cron expression to use to schedule a recurring scheduled action. Schedule -// invocations must be separated by at least one hour. Times are in UTC. Format of -// cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year) . For -// example, "(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. +// invocations must be separated by at least one hour. Times are in UTC. +// +// Format of cron expressions is (Minutes Hours Day-of-month Month Day-of-week +// Year) . For example, "(0 10 ? * MON *)" . For more information, see [Cron Expressions] in the +// Amazon CloudWatch Events User Guide. +// +// [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions type ScheduleMemberCron struct { Value string @@ -302,20 +308,24 @@ type ScheduledActionResponse struct { // scheduled action. This IAM role must allow the Amazon Redshift scheduler to // schedule creating snapshots. (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) - // in the Amazon Redshift Cluster Management Guide + // use with the Amazon Redshift scheduler, see [Using Identity-Based Policies for Amazon Redshift]in the Amazon Redshift Cluster + // Management Guide + // + // [Using Identity-Based Policies for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html RoleArn *string // The schedule for a one-time (at timestamp format) or recurring (cron format) // scheduled action. Schedule invocations must be separated by at least one hour. // Times are in UTC. + // // - Format of at timestamp is yyyy-mm-ddThh:mm:ss . For example, // 2016-03-04T17:27:00 . + // // - Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week - // Year) . For example, "(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. + // Year) . For example, "(0 10 ? * MON *)" . For more information, see [Cron Expressions]in the + // Amazon CloudWatch Events User Guide. + // + // [Cron Expressions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions Schedule Schedule // The description of the scheduled action. @@ -335,9 +345,10 @@ type ScheduledActionResponse struct { State State // A JSON format string of the Amazon Redshift Serverless API operation with input - // parameters. The following is an example of a target action. "{"CreateSnapshot": - // {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", - // "retentionPeriod": "1"}}" + // parameters. The following is an example of a target action. + // + // "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": + // "sampleSnapshot", "retentionPeriod": "1"}}" TargetAction TargetAction noSmithyDocumentSerde @@ -521,9 +532,10 @@ type Tag struct { } // A JSON format string of the Amazon Redshift Serverless API operation with input -// parameters. The following is an example of a target action. "{"CreateSnapshot": -// {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", -// "retentionPeriod": "1"}}" +// parameters. The following is an example of a target action. +// +// "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": +// "sampleSnapshot", "retentionPeriod": "1"}}" // // The following types satisfy this interface: // @@ -532,10 +544,11 @@ type TargetAction interface { isTargetAction() } -// The parameters that you can use to configure a scheduled action (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html) -// to create a snapshot. For more information about creating a scheduled action, -// see CreateScheduledAction (https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html) -// . +// The parameters that you can use to configure a [scheduled action] to create a snapshot. For more +// information about creating a scheduled action, see [CreateScheduledAction]. +// +// [CreateScheduledAction]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html +// [scheduled action]: https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_CreateScheduledAction.html type TargetActionMemberCreateSnapshot struct { Value CreateSnapshotScheduleActionParameters @@ -616,8 +629,9 @@ type Workgroup struct { // enable_user_activity_logging , query_group , search_path , require_ssl , // use_fips_ssl , 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]. + // + // [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. @@ -653,8 +667,9 @@ type Workgroup struct { NamespaceName *string // The patch version of your Amazon Redshift Serverless workgroup. For more - // information about patch versions, see Cluster versions for Amazon Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html) - // . + // information about patch versions, see [Cluster versions for Amazon Redshift]. + // + // [Cluster versions for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html PatchVersion *string // The custom port to use when connecting to a workgroup. Valid port ranges are @@ -684,9 +699,9 @@ type Workgroup struct { WorkgroupName *string // The Amazon Redshift Serverless version of your workgroup. For more information - // about Amazon Redshift Serverless versions, see Cluster versions for Amazon - // Redshift (https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html) - // . + // about Amazon Redshift Serverless versions, see[Cluster versions for Amazon Redshift] . + // + // [Cluster versions for Amazon Redshift]: https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html WorkgroupVersion *string noSmithyDocumentSerde diff --git a/service/rekognition/api_op_AssociateFaces.go b/service/rekognition/api_op_AssociateFaces.go index a770e37891e..233d7290169 100644 --- a/service/rekognition/api_op_AssociateFaces.go +++ b/service/rekognition/api_op_AssociateFaces.go @@ -13,24 +13,30 @@ import ( // Associates one or more faces with an existing UserID. Takes an array of FaceIds // . Each FaceId that are present in the FaceIds list is associated with the -// provided UserID. The maximum number of total FaceIds per UserID is 100. The -// UserMatchThreshold parameter specifies the minimum user match confidence +// provided UserID. The maximum number of total FaceIds per UserID is 100. +// +// The UserMatchThreshold parameter specifies the minimum user match confidence // required for the face to be associated with a UserID that has at least one // FaceID already associated. This ensures that the FaceIds are associated with -// the right UserID. The value ranges from 0-100 and default value is 75. If -// successful, an array of AssociatedFace objects containing the associated FaceIds -// is returned. If a given face is already associated with the given UserID , it -// will be ignored and will not be returned in the response. If a given face is -// already associated to a different UserID , isn't found in the collection, +// the right UserID. The value ranges from 0-100 and default value is 75. +// +// If successful, an array of AssociatedFace objects containing the associated +// FaceIds is returned. If a given face is already associated with the given UserID +// , it will be ignored and will not be returned in the response. If a given face +// is already associated to a different UserID , isn't found in the collection, // doesn’t meet the UserMatchThreshold , or there are already 100 faces associated // with the UserID , it will be returned as part of an array of -// UnsuccessfulFaceAssociations. The UserStatus reflects the status of an -// operation which updates a UserID representation with a list of given faces. The -// UserStatus can be: +// UnsuccessfulFaceAssociations. +// +// The UserStatus reflects the status of an operation which updates a UserID +// representation with a list of given faces. The UserStatus can be: +// // - ACTIVE - All associations or disassociations of FaceID(s) for a UserID are // complete. +// // - CREATED - A UserID has been created, but has no FaceID(s) associated with // it. +// // - UPDATING - A UserID is being updated and there are current associations or // disassociations of FaceID(s) taking place. func (c *Client) AssociateFaces(ctx context.Context, params *AssociateFacesInput, optFns ...func(*Options)) (*AssociateFacesOutput, error) { diff --git a/service/rekognition/api_op_CompareFaces.go b/service/rekognition/api_op_CompareFaces.go index 8e3b55ac799..0773860c2c0 100644 --- a/service/rekognition/api_op_CompareFaces.go +++ b/service/rekognition/api_op_CompareFaces.go @@ -12,44 +12,62 @@ import ( ) // Compares a face in the source input image with each of the 100 largest faces -// detected in the target input image. If the source image contains multiple faces, -// the service detects the largest face and compares it with each face detected in -// the target image. CompareFaces uses machine learning algorithms, which are -// probabilistic. A false negative is an incorrect prediction that a face in the -// target image has a low similarity confidence score when compared to the face in -// the source image. To reduce the probability of false negatives, we recommend -// that you compare the target image against multiple source images. If you plan to -// use CompareFaces to make a decision that impacts an individual's rights, -// privacy, or access to services, we recommend that you pass the result to a human -// for review and further validation before taking action. You pass the input and -// target images either as base64-encoded image bytes or as references to images 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. In response, the operation returns an array of face matches -// ordered by similarity score in descending order. For each face match, the -// response provides a bounding box of the face, facial landmarks, pose details -// (pitch, roll, and yaw), quality (brightness and sharpness), and confidence value -// (indicating the level of confidence that the bounding box contains a face). The -// response also provides a similarity score, which indicates how closely the faces -// match. By default, only faces with a similarity score of greater than or equal -// to 80% are returned in the response. You can change this value by specifying the -// SimilarityThreshold parameter. CompareFaces also returns an array of faces that -// don't match the source image. For each face, it returns a bounding box, -// confidence value, landmarks, pose details, and quality. The response also -// returns information about the face in the source image, including the bounding -// 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 -// 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 -// persist. For an example, see Comparing Faces in Images in the Amazon Rekognition -// Developer Guide. This operation requires permissions to perform the -// rekognition:CompareFaces action. +// detected in the target input image. +// +// If the source image contains multiple faces, the service detects the largest +// face and compares it with each face detected in the target image. +// +// CompareFaces uses machine learning algorithms, which are probabilistic. A false +// negative is an incorrect prediction that a face in the target image has a low +// similarity confidence score when compared to the face in the source image. To +// reduce the probability of false negatives, we recommend that you compare the +// target image against multiple source images. If you plan to use CompareFaces to +// make a decision that impacts an individual's rights, privacy, or access to +// services, we recommend that you pass the result to a human for review and +// further validation before taking action. +// +// You pass the input and target images either as base64-encoded image bytes or as +// references to images 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. +// +// In response, the operation returns an array of face matches ordered by +// similarity score in descending order. For each face match, the response provides +// a bounding box of the face, facial landmarks, pose details (pitch, roll, and +// yaw), quality (brightness and sharpness), and confidence value (indicating the +// level of confidence that the bounding box contains a face). The response also +// provides a similarity score, which indicates how closely the faces match. +// +// By default, only faces with a similarity score of greater than or equal to 80% +// are returned in the response. You can change this value by specifying the +// SimilarityThreshold parameter. +// +// CompareFaces also returns an array of faces that don't match the source image. +// For each face, it returns a bounding box, confidence value, landmarks, pose +// details, and quality. The response also returns information about the face in +// the source image, including the bounding 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 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 persist. +// +// For an example, see Comparing Faces in Images in the Amazon Rekognition +// Developer Guide. +// +// This operation requires permissions to perform the rekognition:CompareFaces +// action. func (c *Client) CompareFaces(ctx context.Context, params *CompareFacesInput, optFns ...func(*Options)) (*CompareFacesOutput, error) { if params == nil { params = &CompareFacesInput{} @@ -69,18 +87,22 @@ type CompareFacesInput struct { // The input 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. + // 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. 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 - // information, see Images in the Amazon Rekognition developer guide. + // 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 @@ -92,8 +114,9 @@ type CompareFacesInput struct { // 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 + // 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 @@ -115,30 +138,34 @@ 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) - // metadata that includes the image's orientation. Amazon Rekognition uses this - // orientation information to perform image correction. The bounding box + // 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 // information in the Exif metadata is used to correct the image orientation. - // Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t - // perform image correction for images in .png format and .jpeg images without - // orientation information in the image Exif metadata. The bounding box coordinates - // aren't translated and represent the object locations before the image is - // rotated. + // Images in .png format don't contain Exif metadata. + // + // Amazon Rekognition doesn’t perform image correction for images in .png format + // and .jpeg images without orientation information in the image Exif metadata. The + // bounding box coordinates aren't translated and represent the object locations + // before the image is 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) - // metadata that includes the image's orientation. Amazon Rekognition uses this - // orientation information to perform image correction. The bounding box + // 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 // information in the Exif metadata is used to correct the image orientation. - // Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t - // perform image correction for images in .png format and .jpeg images without - // orientation information in the image Exif metadata. The bounding box coordinates - // aren't translated and represent the object locations before the image is - // rotated. + // Images in .png format don't contain Exif metadata. + // + // Amazon Rekognition doesn’t perform image correction for images in .png format + // and .jpeg images without orientation information in the image Exif metadata. The + // bounding box coordinates aren't translated and represent the object locations + // before the image is rotated. TargetImageOrientationCorrection types.OrientationCorrection // An array of faces in the target image that did not match the source image face. diff --git a/service/rekognition/api_op_CopyProjectVersion.go b/service/rekognition/api_op_CopyProjectVersion.go index 71aefccbc80..11485ca2e04 100644 --- a/service/rekognition/api_op_CopyProjectVersion.go +++ b/service/rekognition/api_op_CopyProjectVersion.go @@ -11,25 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Copies a -// version of an Amazon Rekognition Custom Labels model from a source project to a -// destination project. The source and destination projects can be in 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 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 in the same AWS -// account, you don't need to create a project policy. Copying project versions is -// supported only for Custom Labels models. To copy a model, the destination -// project, source project, and source model version must 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 . This operation requires permissions to perform -// the rekognition:CopyProjectVersion action. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Copies a version of an Amazon Rekognition Custom Labels model from a source +// project to a destination project. The source and destination projects can be in +// 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 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 in the same AWS account, you +// don't need to create a project policy. +// +// Copying project versions is supported only for Custom Labels models. +// +// To copy a model, the destination project, source project, and source model +// version must already exist. +// +// Copying a model version takes a while to complete. To get the current status, +// call DescribeProjectVersionsand check the value of Status in the ProjectVersionDescription object. The copy operation has +// finished when the value of Status is COPYING_COMPLETED . +// +// This operation requires permissions to perform the +// rekognition:CopyProjectVersion action. func (c *Client) CopyProjectVersion(ctx context.Context, params *CopyProjectVersionInput, optFns ...func(*Options)) (*CopyProjectVersionOutput, error) { if params == nil { params = &CopyProjectVersionInput{} @@ -79,12 +89,19 @@ type CopyProjectVersionInput struct { // 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 + // ). + // + // 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 diff --git a/service/rekognition/api_op_CreateCollection.go b/service/rekognition/api_op_CreateCollection.go index 915bfa5713c..a9ea4ef14da 100644 --- a/service/rekognition/api_op_CreateCollection.go +++ b/service/rekognition/api_op_CreateCollection.go @@ -11,15 +11,21 @@ import ( ) // 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. +// using the IndexFacesoperation. +// +// 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{} @@ -42,7 +48,7 @@ type CreateCollectionInput struct { // This member is required. CollectionId *string - // A set of tags (key-value pairs) that you want to attach to the collection. + // A set of tags (key-value pairs) that you want to attach to the collection. Tags map[string]string noSmithyDocumentSerde diff --git a/service/rekognition/api_op_CreateDataset.go b/service/rekognition/api_op_CreateDataset.go index 828ccbdf010..6cd64209b81 100644 --- a/service/rekognition/api_op_CreateDataset.go +++ b/service/rekognition/api_op_CreateDataset.go @@ -11,23 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 +// This operation applies only to Amazon Rekognition Custom Labels. +// +// 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 DescribeDatasetto 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 -// 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. +// 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. func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error) { if params == nil { params = &CreateDatasetInput{} @@ -45,23 +55,22 @@ func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, type CreateDatasetInput struct { - // The type of the dataset. Specify TRAIN to create a training dataset. Specify + // The type of the dataset. Specify TRAIN to create a training dataset. Specify // TEST to create a test dataset. // // This member is required. DatasetType types.DatasetType - // The ARN of the Amazon Rekognition Custom Labels project to which you want to + // The ARN of the Amazon Rekognition Custom Labels project to which you want to // asssign the dataset. // // This member is required. ProjectArn *string - // The source files for the dataset. You can specify the ARN of an existing + // 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 . + // To add labeled images to the dataset, You can use the console or call UpdateDatasetEntries. DatasetSource *types.DatasetSource noSmithyDocumentSerde @@ -69,7 +78,7 @@ type CreateDatasetInput struct { type CreateDatasetOutput struct { - // The ARN of the created Amazon Rekognition Custom Labels dataset. + // The ARN of the created Amazon Rekognition Custom Labels dataset. DatasetArn *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_CreateFaceLivenessSession.go b/service/rekognition/api_op_CreateFaceLivenessSession.go index 559745e54cc..353f2560327 100644 --- a/service/rekognition/api_op_CreateFaceLivenessSession.go +++ b/service/rekognition/api_op_CreateFaceLivenessSession.go @@ -13,13 +13,16 @@ import ( // This API operation initiates a Face Liveness session. It returns a SessionId , // which you can use to start streaming Face Liveness video and get the results for -// a Face Liveness session. You can use the OutputConfig option in the Settings -// parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores -// reference images and audit images. If no Amazon S3 bucket is defined, raw bytes -// are sent instead. You can use AuditImagesLimit to limit the number of audit -// images returned when GetFaceLivenessSessionResults is called. This number is -// between 0 and 4. By default, it is set to 0. The limit is best effort and based -// on the duration of the selfie-video. +// a Face Liveness session. +// +// You can use the OutputConfig option in the Settings parameter to provide an +// Amazon S3 bucket location. The Amazon S3 bucket stores reference images and +// audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead. +// +// You can use AuditImagesLimit to limit the number of audit images returned when +// GetFaceLivenessSessionResults is called. This number is between 0 and 4. By +// default, it is set to 0. The limit is best effort and based on the duration of +// the selfie-video. func (c *Client) CreateFaceLivenessSession(ctx context.Context, params *CreateFaceLivenessSessionInput, optFns ...func(*Options)) (*CreateFaceLivenessSessionOutput, error) { if params == nil { params = &CreateFaceLivenessSessionInput{} @@ -43,7 +46,7 @@ type CreateFaceLivenessSessionInput struct { // the same session multiple times. ClientRequestToken *string - // The identifier for your AWS Key Management Service key (AWS KMS key). Used to + // The identifier for your AWS Key Management Service key (AWS KMS key). Used to // encrypt audit images and reference images. KmsKeyId *string diff --git a/service/rekognition/api_op_CreateProjectVersion.go b/service/rekognition/api_op_CreateProjectVersion.go index 8754420aab8..5880426d9ea 100644 --- a/service/rekognition/api_op_CreateProjectVersion.go +++ b/service/rekognition/api_op_CreateProjectVersion.go @@ -14,23 +14,32 @@ import ( // Creates a new version of Amazon Rekognition project (like a Custom Labels model // or a custom adapter) and begins training. Models and adapters are managed as // part of a Rekognition project. The response from CreateProjectVersion is an -// Amazon Resource Name (ARN) for the project version. The FeatureConfig operation -// argument allows you to configure specific model or adapter settings. You can -// provide a description to the project version by using the VersionDescription -// argment. Training can take a while to complete. You can get the current status -// by calling DescribeProjectVersions . Training completed successfully if the +// Amazon Resource Name (ARN) for the project version. +// +// The FeatureConfig operation argument allows you to configure specific model or +// adapter settings. You can provide a description to the project version by using +// the VersionDescription argment. Training can take 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 . Once training has successfully -// completed, call DescribeProjectVersions to get the training results and -// evaluate the model. This operation requires permissions to perform the -// rekognition:CreateProjectVersion action. The following applies only to projects -// with Amazon Rekognition Custom Labels as the chosen feature: You can train a -// model in a project that doesn't have associated datasets by specifying manifest -// files in the TrainingData and TestingData fields. If you open the console after -// training a model with manifest files, Amazon Rekognition Custom Labels creates -// the datasets for you using the most recent manifest files. You can no longer -// train a model version for the project by specifying manifest files. Instead of -// training with a project without associated datasets, we recommend that you use -// the manifest files to create training and test datasets for the project. +// completed, call DescribeProjectVersionsto get the training results and evaluate the model. +// +// This operation requires permissions to perform the +// rekognition:CreateProjectVersion action. +// +// The following applies only to projects with Amazon Rekognition Custom Labels as +// the chosen feature: +// +// You can train a model in a project that doesn't have associated datasets by +// specifying manifest files in the TrainingData and TestingData fields. +// +// If you open the console after training a model with manifest files, Amazon +// Rekognition Custom Labels creates the datasets for you using the most recent +// manifest files. You can no longer train a model version for the project by +// specifying manifest files. +// +// Instead of training with a project without associated datasets, we recommend +// that you use the manifest files to create training and test datasets for the +// project. func (c *Client) CreateProjectVersion(ctx context.Context, params *CreateProjectVersionInput, optFns ...func(*Options)) (*CreateProjectVersionOutput, error) { if params == nil { params = &CreateProjectVersionInput{} @@ -77,17 +86,25 @@ type CreateProjectVersionInput struct { // images, test images, and manifest files copied into the service for the project // version. 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 use your own KMS key, you need the following - // permissions on the KMS key. + // 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 - // A set of tags (key-value pairs) that you want to attach to the project version. + // A set of tags (key-value pairs) that you want to attach to the project + // version. Tags map[string]string // Specifies an external manifest that the service uses to test the project diff --git a/service/rekognition/api_op_CreateStreamProcessor.go b/service/rekognition/api_op_CreateStreamProcessor.go index 910559c9553..189fd314516 100644 --- a/service/rekognition/api_op_CreateStreamProcessor.go +++ b/service/rekognition/api_op_CreateStreamProcessor.go @@ -12,16 +12,19 @@ import ( ) // Creates an Amazon Rekognition stream processor that you can use to detect and -// recognize faces or to detect labels in a streaming video. Amazon Rekognition -// 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. +// recognize faces or to detect labels in a streaming video. +// +// Amazon Rekognition 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 for receiving the output. You must use the FaceSearch option in // Settings , specifying the collection that contains the faces you want to -// recognize. After you have finished analyzing a streaming video, use -// StopStreamProcessor to stop processing. +// recognize. After you have finished analyzing a streaming video, use StopStreamProcessorto 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 @@ -29,16 +32,18 @@ import ( // you want to detect by using the ConnectedHome option in settings, and // selecting one of the following: PERSON , PET , PACKAGE , ALL 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. +// RegionsOfInterest . When you run the StartStreamProcessoroperation 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. +// video by calling StartStreamProcessorwith 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{} @@ -65,17 +70,17 @@ type CreateStreamProcessorInput struct { // 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. + // processor by calling DescribeStreamProcessor. Name is idempotent. This is required for both face + // search and label detection stream processors. // // This member is required. Name *string // 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 - // Amazon S3 bucket that you own for a label detection stream processor or a - // Kinesis data stream ARN for a face search stream processor. + // 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. // // This member is required. Output *types.StreamProcessorOutput @@ -96,13 +101,13 @@ type CreateStreamProcessorInput struct { // This member is required. Settings *types.StreamProcessorSettings - // Shows whether you are sharing data with Rekognition to improve model + // Shows whether you are sharing data with Rekognition to improve model // performance. You can choose this option at the account level or on a per-stream // basis. Note that if you opt out at the account level this setting is ignored on // individual streams. DataSharingPreference *types.StreamProcessorDataSharingPreference - // The identifier for your AWS Key Management Service key (AWS KMS key). This is + // 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 @@ -113,23 +118,27 @@ type CreateStreamProcessorInput struct { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the object detection results and completion status of a video analysis - // operation. Amazon Rekognition publishes a notification the first time an object - // of interest or a person is detected in the video stream. For example, if Amazon + // operation. + // + // Amazon Rekognition publishes a notification the first time an object of + // interest or a person is detected in the video stream. For example, if Amazon // Rekognition detects a person at second 2, a pet at second 4, and a person again // at second 5, Amazon Rekognition sends 2 object class detected notifications, one - // for a person at second 2 and one for a pet at second 4. Amazon Rekognition also - // publishes an an end-of-session notification with a summary when the stream - // processing session is complete. + // for a person at second 2 and one for a pet at second 4. + // + // Amazon Rekognition also publishes an an end-of-session notification with a + // summary when the stream processing session is complete. NotificationChannel *types.StreamProcessorNotificationChannel - // Specifies locations in the frames where Amazon Rekognition checks for objects + // 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. + // A set of tags (key-value pairs) that you want to attach to the stream + // processor. Tags map[string]string noSmithyDocumentSerde diff --git a/service/rekognition/api_op_CreateUser.go b/service/rekognition/api_op_CreateUser.go index 22911d87d48..b68a1bdbe90 100644 --- a/service/rekognition/api_op_CreateUser.go +++ b/service/rekognition/api_op_CreateUser.go @@ -13,10 +13,12 @@ import ( // Creates a new User within a collection specified by CollectionId . Takes UserId // as a parameter, which is a user provided ID which should be unique within the // collection. The provided UserId will alias the system generated UUID to make -// the UserId more user friendly. Uses a ClientToken , an idempotency token that -// ensures a call to CreateUser completes only once. If the value is not supplied, -// the AWS SDK generates an idempotency token for the requests. This prevents -// retries after a network error results from making multiple CreateUser calls. +// the UserId more user friendly. +// +// Uses a ClientToken , an idempotency token that ensures a call to CreateUser +// completes only once. If the value is not supplied, the AWS SDK generates an +// idempotency token for the requests. This prevents retries after a network error +// results from making multiple CreateUser calls. func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} diff --git a/service/rekognition/api_op_DeleteCollection.go b/service/rekognition/api_op_DeleteCollection.go index d24e3bf89a7..fad3608def7 100644 --- a/service/rekognition/api_op_DeleteCollection.go +++ b/service/rekognition/api_op_DeleteCollection.go @@ -11,9 +11,12 @@ 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]. +// +// This operation requires permissions to perform the rekognition:DeleteCollection +// action. +// +// [Deleting a collection]: https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html 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 dc92438fecd..d7e7ea791e7 100644 --- a/service/rekognition/api_op_DeleteDataset.go +++ b/service/rekognition/api_op_DeleteDataset.go @@ -10,14 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a +// dataset might take while. Use DescribeDatasetto 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. +// 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{} @@ -35,7 +39,8 @@ func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, type DeleteDatasetInput struct { - // The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete. + // The ARN of the Amazon Rekognition Custom Labels dataset that you want to + // delete. // // This member is required. DatasetArn *string diff --git a/service/rekognition/api_op_DeleteFaces.go b/service/rekognition/api_op_DeleteFaces.go index 19091b7d4dd..346e1e12209 100644 --- a/service/rekognition/api_op_DeleteFaces.go +++ b/service/rekognition/api_op_DeleteFaces.go @@ -12,8 +12,10 @@ import ( ) // Deletes faces from a collection. You specify a collection ID and an array of -// face IDs to remove from the collection. This operation requires permissions to -// perform the rekognition:DeleteFaces action. +// face IDs to remove from the collection. +// +// This operation requires permissions to perform the rekognition:DeleteFaces +// action. func (c *Client) DeleteFaces(ctx context.Context, params *DeleteFacesInput, optFns ...func(*Options)) (*DeleteFacesOutput, error) { if params == nil { params = &DeleteFacesInput{} diff --git a/service/rekognition/api_op_DeleteProject.go b/service/rekognition/api_op_DeleteProject.go index 92f43120190..2f1119a5bad 100644 --- a/service/rekognition/api_op_DeleteProject.go +++ b/service/rekognition/api_op_DeleteProject.go @@ -13,12 +13,15 @@ import ( // Deletes a Amazon Rekognition project. To delete a project you must first delete // all models or adapters associated with the project. To delete a model or -// adapter, see 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. +// adapter, see 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. func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error) { if params == nil { params = &DeleteProjectInput{} diff --git a/service/rekognition/api_op_DeleteProjectPolicy.go b/service/rekognition/api_op_DeleteProjectPolicy.go index c4878cee689..d14639bf98a 100644 --- a/service/rekognition/api_op_DeleteProjectPolicy.go +++ b/service/rekognition/api_op_DeleteProjectPolicy.go @@ -10,10 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 . This operation requires permissions to perform the +// This operation applies only to Amazon Rekognition Custom Labels. +// +// 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. +// +// This operation requires permissions to perform the // rekognition:DeleteProjectPolicy action. func (c *Client) DeleteProjectPolicy(ctx context.Context, params *DeleteProjectPolicyInput, optFns ...func(*Options)) (*DeleteProjectPolicyOutput, error) { if params == nil { diff --git a/service/rekognition/api_op_DeleteProjectVersion.go b/service/rekognition/api_op_DeleteProjectVersion.go index d00351c5160..b3cbe46efca 100644 --- a/service/rekognition/api_op_DeleteProjectVersion.go +++ b/service/rekognition/api_op_DeleteProjectVersion.go @@ -12,11 +12,14 @@ import ( ) // Deletes a Rekognition project model or project version, like a Amazon -// Rekognition Custom Labels model or a custom adapter. You can't delete a project -// version if it is running or if it is training. To check the status of a project -// version, use the Status field returned from DescribeProjectVersions . To stop a -// project version call StopProjectVersion . If the project version is training, -// wait until it finishes. This operation requires permissions to perform the +// Rekognition Custom Labels model or a custom adapter. +// +// You can't delete a project version if it is running or if it is training. To +// check the status of a project version, use the Status field returned from DescribeProjectVersions. To +// stop a project version call StopProjectVersion. If the project version 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) { if params == nil { diff --git a/service/rekognition/api_op_DeleteStreamProcessor.go b/service/rekognition/api_op_DeleteStreamProcessor.go index 00cd5da5397..11ec2449544 100644 --- a/service/rekognition/api_op_DeleteStreamProcessor.go +++ b/service/rekognition/api_op_DeleteStreamProcessor.go @@ -11,9 +11,9 @@ import ( ) // 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 . +// 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 . 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 f9117ad8d34..6ee4d7b87fa 100644 --- a/service/rekognition/api_op_DescribeCollection.go +++ b/service/rekognition/api_op_DescribeCollection.go @@ -13,9 +13,10 @@ import ( // Describes the specified collection. You can use DescribeCollection to get // information, such as the number of faces indexed into a collection and the -// version of the model used by the collection for face detection. For more -// information, see Describing a Collection in the Amazon Rekognition Developer -// Guide. +// version of the model used by the collection for face detection. +// +// For more information, see Describing a Collection in the Amazon Rekognition +// Developer Guide. func (c *Client) DescribeCollection(ctx context.Context, params *DescribeCollectionInput, optFns ...func(*Options)) (*DescribeCollectionOutput, error) { if params == nil { params = &DescribeCollectionInput{} @@ -52,10 +53,11 @@ 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. + // // For more information, see Model versioning in the Amazon Rekognition Developer // Guide. FaceModelVersion *string diff --git a/service/rekognition/api_op_DescribeDataset.go b/service/rekognition/api_op_DescribeDataset.go index 2492210f5c2..533573fe5e9 100644 --- a/service/rekognition/api_op_DescribeDataset.go +++ b/service/rekognition/api_op_DescribeDataset.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Describes an -// Amazon Rekognition Custom Labels dataset. You can get information such as the -// current status of a dataset and statistics about the images and labels in a -// dataset. This operation requires permissions to perform the -// rekognition:DescribeDataset action. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Describes an Amazon Rekognition Custom Labels dataset. You can get information +// such as the current status of a dataset and statistics about the images and +// labels in a dataset. +// +// This operation requires permissions to perform the rekognition:DescribeDataset +// action. func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) { if params == nil { params = &DescribeDatasetInput{} @@ -33,7 +36,7 @@ func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInp type DescribeDatasetInput struct { - // The Amazon Resource Name (ARN) of the dataset that you want to describe. + // The Amazon Resource Name (ARN) of the dataset that you want to describe. // // This member is required. DatasetArn *string @@ -43,7 +46,7 @@ type DescribeDatasetInput struct { type DescribeDatasetOutput struct { - // The description for the dataset. + // The description for the dataset. DatasetDescription *types.DatasetDescription // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_DescribeProjectVersions.go b/service/rekognition/api_op_DescribeProjectVersions.go index 0628afa9fa1..f01cb0a6d89 100644 --- a/service/rekognition/api_op_DescribeProjectVersions.go +++ b/service/rekognition/api_op_DescribeProjectVersions.go @@ -18,7 +18,9 @@ import ( // Lists and describes the versions of an Amazon Rekognition project. You can // specify up to 10 model or adapter versions in ProjectVersionArns . If you don't // specify a value, descriptions for all model/adapter versions in the project are -// returned. This operation requires permissions to perform the +// returned. +// +// This operation requires permissions to perform the // rekognition:DescribeProjectVersions action. func (c *Client) DescribeProjectVersions(ctx context.Context, params *DescribeProjectVersionsInput, optFns ...func(*Options)) (*DescribeProjectVersionsOutput, error) { if params == nil { @@ -289,12 +291,13 @@ type ProjectVersionRunningWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeProjectVersionsInput, *DescribeProjectVersionsOutput, error) (bool, error) } @@ -503,12 +506,13 @@ type ProjectVersionTrainingCompletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeProjectVersionsInput, *DescribeProjectVersionsOutput, error) (bool, error) } diff --git a/service/rekognition/api_op_DescribeProjects.go b/service/rekognition/api_op_DescribeProjects.go index 2ea88927119..651c5c7bf04 100644 --- a/service/rekognition/api_op_DescribeProjects.go +++ b/service/rekognition/api_op_DescribeProjects.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about your Rekognition projects. This operation requires -// permissions to perform the rekognition:DescribeProjects action. +// Gets information about your Rekognition projects. +// +// This operation requires permissions to perform the rekognition:DescribeProjects +// action. func (c *Client) DescribeProjects(ctx context.Context, params *DescribeProjectsInput, optFns ...func(*Options)) (*DescribeProjectsOutput, error) { if params == nil { params = &DescribeProjectsInput{} diff --git a/service/rekognition/api_op_DescribeStreamProcessor.go b/service/rekognition/api_op_DescribeStreamProcessor.go index 3675e8dda09..3d8e687656c 100644 --- a/service/rekognition/api_op_DescribeStreamProcessor.go +++ b/service/rekognition/api_op_DescribeStreamProcessor.go @@ -12,9 +12,9 @@ import ( "time" ) -// 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 +// 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. func (c *Client) DescribeStreamProcessor(ctx context.Context, params *DescribeStreamProcessorInput, optFns ...func(*Options)) (*DescribeStreamProcessorOutput, error) { if params == nil { @@ -46,7 +46,7 @@ type DescribeStreamProcessorOutput struct { // Date and time the stream processor was created CreationTimestamp *time.Time - // Shows whether you are sharing data with Rekognition to improve model + // Shows whether you are sharing data with Rekognition to improve model // performance. You can choose this option at the account level or on a per-stream // basis. Note that if you opt out at the account level this setting is ignored on // individual streams. @@ -55,7 +55,7 @@ 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 + // The identifier for your AWS Key Management Service key (AWS KMS key). This is // an optional parameter for label detection stream processors. KmsKeyId *string @@ -69,19 +69,22 @@ type DescribeStreamProcessorOutput struct { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the object detection results and completion status of a video analysis - // operation. Amazon Rekognition publishes a notification the first time an object - // of interest or a person is detected in the video stream. For example, if Amazon + // operation. + // + // Amazon Rekognition publishes a notification the first time an object of + // interest or a person is detected in the video stream. For example, if Amazon // Rekognition detects a person at second 2, a pet at second 4, and a person again // at second 5, Amazon Rekognition sends 2 object class detected notifications, one - // for a person at second 2 and one for a pet at second 4. Amazon Rekognition also - // publishes an an end-of-session notification with a summary when the stream - // processing session is complete. + // for a person at second 2 and one for a pet at second 4. + // + // Amazon Rekognition also publishes an an end-of-session notification with a + // summary when the stream processing session is complete. NotificationChannel *types.StreamProcessorNotificationChannel // 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 + // 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 diff --git a/service/rekognition/api_op_DetectCustomLabels.go b/service/rekognition/api_op_DetectCustomLabels.go index a80aad4d88f..057aaa54616 100644 --- a/service/rekognition/api_op_DetectCustomLabels.go +++ b/service/rekognition/api_op_DetectCustomLabels.go @@ -11,36 +11,52 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Detects custom -// labels in a supplied image by using an Amazon Rekognition Custom Labels model. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Detects custom labels in a supplied image by using an Amazon Rekognition Custom +// Labels model. +// // You specify which version of a model version to use by using the -// ProjectVersionArn input parameter. You 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, 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 ( +// ProjectVersionArn input parameter. +// +// You 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, 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 ). Note that for the // DetectCustomLabelsLabels operation, Polygons are not returned in the Geometry -// section of the response. 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 rekognition:DetectCustomLabels action. For more -// information, see Analyzing an image in the Amazon Rekognition Custom Labels +// section of the response. +// +// 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 +// rekognition:DetectCustomLabels action. +// +// For more information, see Analyzing an image in the Amazon Rekognition Custom +// Labels Developer Guide. func (c *Client) DetectCustomLabels(ctx context.Context, params *DetectCustomLabelsInput, optFns ...func(*Options)) (*DetectCustomLabelsOutput, error) { if params == nil { params = &DetectCustomLabelsInput{} @@ -58,22 +74,30 @@ 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 + // 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. // // This member is required. diff --git a/service/rekognition/api_op_DetectFaces.go b/service/rekognition/api_op_DetectFaces.go index f4b6b9da4ca..e2da8cd674e 100644 --- a/service/rekognition/api_op_DetectFaces.go +++ b/service/rekognition/api_op_DetectFaces.go @@ -11,20 +11,28 @@ 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), -// pose, presence of facial occlusion, 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), pose, presence of facial occlusion, 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{} @@ -44,9 +52,11 @@ type DetectFacesInput struct { // The input 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. + // 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. Image *types.Image @@ -56,12 +66,14 @@ type DetectFacesInput struct { // will always be returned. You can request for specific facial attributes (in // addition to the default list) - by using [ "DEFAULT", "FACE_OCCLUDED" ] or just [ // "FACE_OCCLUDED" ]. You can request for all facial attributes by using [ "ALL"] . - // Requesting more attributes may increase response time. If you provide both, - // ["ALL", "DEFAULT"] , the service uses a logical "AND" operator to determine - // which attributes to return (in this case, all attributes). Note that while the - // FaceOccluded and EyeDirection attributes are supported when using DetectFaces , - // they aren't supported when analyzing videos with StartFaceDetection and - // GetFaceDetection . + // Requesting more attributes may increase response time. + // + // If you provide both, ["ALL", "DEFAULT"] , the service uses a logical "AND" + // operator to determine which attributes to return (in this case, all attributes). + // + // Note that while the FaceOccluded and EyeDirection attributes are supported when + // using DetectFaces , they aren't supported when analyzing videos with + // StartFaceDetection and GetFaceDetection . Attributes []types.Attribute noSmithyDocumentSerde @@ -72,16 +84,19 @@ type DetectFacesOutput struct { // Details of each face found in the image. FaceDetails []types.FaceDetail - // The value of OrientationCorrection 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 information in - // the Exif metadata is used to correct the image orientation. Images in .png - // format don't contain Exif metadata. Amazon Rekognition doesn’t perform image - // correction for images in .png format and .jpeg images without orientation - // information in the image Exif metadata. The bounding box coordinates aren't - // translated and represent the object locations before the image is rotated. + // The value of OrientationCorrection 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 + // information in the Exif metadata is used to correct the image orientation. + // Images in .png format don't contain Exif metadata. + // + // Amazon Rekognition doesn’t perform image correction for images in .png format + // and .jpeg images without orientation information in the image Exif metadata. The + // bounding box coordinates aren't translated and represent the object locations + // before the image is rotated. OrientationCorrection types.OrientationCorrection // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_DetectLabels.go b/service/rekognition/api_op_DetectLabels.go index 72705dfc5c2..679fc41f4ed 100644 --- a/service/rekognition/api_op_DetectLabels.go +++ b/service/rekognition/api_op_DetectLabels.go @@ -14,31 +14,46 @@ import ( // Detects instances of real-world entities within an image (JPEG or PNG) provided // as input. This includes objects like flower, tree, and table; events like // wedding, graduation, and birthday party; and concepts like landscape, evening, -// and nature. For an example, see Analyzing images stored in an Amazon S3 bucket -// in the Amazon Rekognition Developer Guide. You 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, passing image -// bytes is not supported. The image must be either a PNG or JPEG formatted file. -// Optional Parameters You can specify one or both of the GENERAL_LABELS and -// IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including -// GENERAL_LABELS will ensure the response includes the labels detected in the -// input image, while including IMAGE_PROPERTIES will ensure the response includes -// information about the image quality and color. When using GENERAL_LABELS and/or -// IMAGE_PROPERTIES you can 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 an -// Image (https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html) -// . When getting labels, you can specify MinConfidence to control the confidence +// and nature. +// +// For an example, see Analyzing images stored in an Amazon S3 bucket in the +// Amazon Rekognition Developer Guide. +// +// You 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, passing image bytes is not supported. The image must be either a PNG +// or JPEG formatted file. +// +// # Optional Parameters +// +// You can specify one or both of the GENERAL_LABELS and IMAGE_PROPERTIES feature +// types when calling the DetectLabels API. Including GENERAL_LABELS will ensure +// the response includes the labels detected in the input image, while including +// IMAGE_PROPERTIES will ensure the response includes information about the image +// quality and color. +// +// When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can 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 an Image]. +// +// When getting labels, 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. These arguments are only valid when supplying -// GENERAL_LABELS as a feature type. Response Elements For each object, scene, and -// concept the API returns one or more labels. The API returns the following types -// of information about labels: +// GENERAL_LABELS as a feature type. +// +// # Response Elements +// +// For each object, scene, and concept the API returns one or more labels. The API +// returns the following types of information about 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 @@ -46,8 +61,11 @@ import ( // 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 @@ -56,12 +74,16 @@ import ( // // 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. // @@ -69,23 +91,36 @@ import ( // 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} +// 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: 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 doesn't return any -// data. This operation requires permissions to perform the -// rekognition:DetectLabels action. +// {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 DetectFacesoperation provides. +// +// This is a stateless API operation that doesn't return any data. +// +// This operation requires permissions to perform the rekognition:DetectLabels +// action. +// +// [Detecting Labels in an Image]: https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html func (c *Client) DetectLabels(ctx context.Context, params *DetectLabelsInput, optFns ...func(*Options)) (*DetectLabelsOutput, error) { if params == nil { params = &DetectLabelsInput{} @@ -105,10 +140,11 @@ type DetectLabelsInput struct { // The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI // to call Amazon Rekognition operations, passing image bytes is not supported. - // Images stored in an S3 Bucket do not need to be base64-encoded. 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. + // Images stored in an S3 Bucket do not need to be base64-encoded. + // + // 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. Image *types.Image @@ -127,7 +163,9 @@ type DetectLabelsInput struct { // Specifies the minimum confidence level for the labels to return. Amazon // Rekognition doesn't return any labels with confidence lower than this specified - // value. If MinConfidence is not specified, the operation returns labels with a + // value. + // + // If MinConfidence is not specified, the operation returns labels with a // confidence values greater than or equal to 55 percent. Only valid when // GENERAL_LABELS is specified as a feature type in the Feature input parameter. MinConfidence *float32 @@ -136,8 +174,9 @@ type DetectLabelsInput struct { // properties. Specified filters can be inclusive, exclusive, or a combination of // both. Filters can be used for individual labels or label categories. The exact // label names or label categories must be supplied. For a full list of labels and - // label categories, see Detecting labels (https://docs.aws.amazon.com/rekognition/latest/dg/labels.html) - // . + // label categories, see [Detecting labels]. + // + // [Detecting labels]: https://docs.aws.amazon.com/rekognition/latest/dg/labels.html Settings *types.DetectLabelsSettings noSmithyDocumentSerde @@ -155,16 +194,19 @@ type DetectLabelsOutput struct { // An array of labels for the real-world objects detected. Labels []types.Label - // The value of OrientationCorrection 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 information in - // the Exif metadata is used to correct the image orientation. Images in .png - // format don't contain Exif metadata. Amazon Rekognition doesn’t perform image - // correction for images in .png format and .jpeg images without orientation - // information in the image Exif metadata. The bounding box coordinates aren't - // translated and represent the object locations before the image is rotated. + // The value of OrientationCorrection 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 + // information in the Exif metadata is used to correct the image orientation. + // Images in .png format don't contain Exif metadata. + // + // Amazon Rekognition doesn’t perform image correction for images in .png format + // and .jpeg images without orientation information in the image Exif metadata. The + // bounding box coordinates aren't translated and represent the object locations + // before the image is rotated. OrientationCorrection types.OrientationCorrection // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_DetectModerationLabels.go b/service/rekognition/api_op_DetectModerationLabels.go index 8ddb9a77d53..973055ec030 100644 --- a/service/rekognition/api_op_DetectModerationLabels.go +++ b/service/rekognition/api_op_DetectModerationLabels.go @@ -14,15 +14,21 @@ import ( // Detects unsafe content in a specified JPEG or PNG format image. Use // DetectModerationLabels to moderate images depending on your requirements. For // example, you might want to filter images that contain nudity, but not images -// containing suggestive content. To filter images, use the labels returned by -// DetectModerationLabels to determine which types of content are appropriate. For -// information about moderation labels, see Detecting Unsafe Content in the Amazon -// Rekognition Developer Guide. 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. You can -// specify an adapter to use when retrieving label predictions by providing a -// ProjectVersionArn to the ProjectVersion argument. +// containing suggestive content. +// +// To filter images, use the labels returned by DetectModerationLabels to +// determine which types of content are appropriate. +// +// For information about moderation labels, see Detecting Unsafe Content in the +// Amazon Rekognition Developer Guide. +// +// 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. +// +// You can specify an adapter to use when retrieving label predictions by +// providing a ProjectVersionArn to the ProjectVersion argument. func (c *Client) DetectModerationLabels(ctx context.Context, params *DetectModerationLabelsInput, optFns ...func(*Options)) (*DetectModerationLabelsOutput, error) { if params == nil { params = &DetectModerationLabelsInput{} @@ -42,9 +48,11 @@ type DetectModerationLabelsInput struct { // The input 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. + // 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. Image *types.Image @@ -55,8 +63,10 @@ type DetectModerationLabelsInput struct { // 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 - // labels with confidence values greater than or equal to 50 percent. + // specified value. + // + // If you don't specify MinConfidence , the operation returns labels with + // confidence values greater than or equal to 50 percent. MinConfidence *float32 // Identifier for the custom adapter. Expects the ProjectVersionArn as a value. diff --git a/service/rekognition/api_op_DetectProtectiveEquipment.go b/service/rekognition/api_op_DetectProtectiveEquipment.go index 24121d89219..46b4a59a598 100644 --- a/service/rekognition/api_op_DetectProtectiveEquipment.go +++ b/service/rekognition/api_op_DetectProtectiveEquipment.go @@ -13,28 +13,41 @@ import ( // 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 // // 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 +// 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 +// 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 ca457ddd5d8..79c72c902ce 100644 --- a/service/rekognition/api_op_DetectText.go +++ b/service/rekognition/api_op_DetectText.go @@ -12,26 +12,37 @@ import ( ) // 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 +// +// 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 -// 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 -// 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 -// spans multiple lines, the DetectText operation returns multiple lines. To -// determine whether a TextDetection element is a line of text or a word, use the -// TextDetection object Type field. To be detected, text must be within +/- 90 -// degrees orientation of the horizontal axis. For more information, see Detecting -// text in the Amazon Rekognition Developer Guide. +// a .png or .jpeg formatted file. +// +// The DetectText operation returns text in an 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 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 spans multiple lines, the DetectText operation returns +// multiple lines. +// +// To determine whether a TextDetection element is a line of text or a word, use +// the TextDetection object Type field. +// +// To be detected, text must be within +/- 90 degrees orientation of the +// horizontal axis. +// +// For more information, see Detecting text in the Amazon Rekognition Developer +// Guide. func (c *Client) DetectText(ctx context.Context, params *DetectTextInput, optFns ...func(*Options)) (*DetectTextOutput, error) { if params == nil { params = &DetectTextInput{} @@ -50,8 +61,9 @@ func (c *Client) DetectText(ctx context.Context, params *DetectTextInput, optFns type DetectTextInput struct { // The input image as base64-encoded bytes or an Amazon S3 object. If you use the - // AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. If - // you are using an AWS SDK to call Amazon Rekognition, you might not need to + // AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. + // + // 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. // diff --git a/service/rekognition/api_op_DistributeDatasetEntries.go b/service/rekognition/api_op_DistributeDatasetEntries.go index 9e2f2fe47d3..5b437e60899 100644 --- a/service/rekognition/api_op_DistributeDatasetEntries.go +++ b/service/rekognition/api_op_DistributeDatasetEntries.go @@ -11,19 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Distributes -// the entries (images) in a training dataset across the training dataset and the -// test dataset for a project. DistributeDatasetEntries moves 20% of the training -// dataset images to the test dataset. An entry is a JSON Line that describes an -// image. You supply the Amazon Resource Names (ARN) of a project's 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. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Distributes the entries (images) in a training dataset across the training +// dataset and the test dataset for a project. DistributeDatasetEntries moves 20% +// of the training dataset images to the test dataset. An entry is a JSON Line that +// describes an image. +// +// You supply the Amazon Resource Names (ARN) of a project's 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. 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 bd5c9810866..ab617d2189a 100644 --- a/service/rekognition/api_op_GetCelebrityInfo.go +++ b/service/rekognition/api_op_GetCelebrityInfo.go @@ -14,9 +14,13 @@ import ( // 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. +// 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{} @@ -34,8 +38,8 @@ func (c *Client) GetCelebrityInfo(ctx context.Context, params *GetCelebrityInfoI type GetCelebrityInfoInput struct { - // The ID for the celebrity. You get the celebrity ID from a call to the - // RecognizeCelebrities operation, which recognizes celebrities in an image. + // The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities + // operation, which recognizes celebrities in an image. // // This member is required. Id *string diff --git a/service/rekognition/api_op_GetCelebrityRecognition.go b/service/rekognition/api_op_GetCelebrityRecognition.go index 267525099ab..87b657e9d1e 100644 --- a/service/rekognition/api_op_GetCelebrityRecognition.go +++ b/service/rekognition/api_op_GetCelebrityRecognition.go @@ -12,40 +12,51 @@ import ( ) // Gets the celebrity recognition results for a Amazon Rekognition Video analysis -// 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 -// 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 -// 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 . +// started by StartCelebrityRecognition. +// +// Celebrity recognition in a video is an asynchronous operation. Analysis is +// started by a call to StartCelebrityRecognitionwhich 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 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 -// 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 -// confidence estimate. GetCelebrityRecognition only returns the default facial -// 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 -// Developer Guide. By default, the Celebrities array is sorted by time -// (milliseconds from the start of the video). You can also sort the array by -// celebrity by specifying the value ID in the SortBy input parameter. The -// CelebrityDetail object includes the celebrity identifer and additional +// 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 CelebrityDetailobject and the time, Timestamp , +// the celebrity was detected. This CelebrityDetailobject 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 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 Developer Guide. +// +// By default, the Celebrities array is sorted by time (milliseconds from the +// start of the video). You can also sort the array by celebrity by specifying the +// value ID in the SortBy input parameter. +// +// The CelebrityDetail object includes the celebrity identifer and additional // information urls. If you don't store the additional information urls, you can -// 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 -// 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 . +// get them later by calling GetCelebrityInfowith 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 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 . func (c *Client) GetCelebrityRecognition(ctx context.Context, params *GetCelebrityRecognitionInput, optFns ...func(*Options)) (*GetCelebrityRecognitionOutput, error) { if params == nil { params = &GetCelebrityRecognitionInput{} @@ -114,8 +125,8 @@ type GetCelebrityRecognitionOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition Video analyzed. Videometadata diff --git a/service/rekognition/api_op_GetContentModeration.go b/service/rekognition/api_op_GetContentModeration.go index d7f8447e62d..448000bae82 100644 --- a/service/rekognition/api_op_GetContentModeration.go +++ b/service/rekognition/api_op_GetContentModeration.go @@ -12,33 +12,41 @@ import ( ) // Gets the inappropriate, unwanted, or offensive content analysis results for a -// 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 -// stored video is an asynchronous operation. You start analysis by calling -// 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 -// 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 -// 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 +// Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels +// in Amazon Rekognition, see [Using the image and video moderation APIs]. +// +// Amazon Rekognition Video inappropriate or offensive content detection in a +// stored video is an asynchronous operation. You start analysis by calling StartContentModerationwhich +// 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 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 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. +// value of NextToken returned from the previous call to GetContentModeration . +// +// 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 func (c *Client) GetContentModeration(ctx context.Context, params *GetContentModerationInput, optFns ...func(*Options)) (*GetContentModerationOutput, error) { if params == nil { params = &GetContentModerationInput{} @@ -124,8 +132,8 @@ type GetContentModerationOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition analyzed. Videometadata is diff --git a/service/rekognition/api_op_GetFaceDetection.go b/service/rekognition/api_op_GetFaceDetection.go index c47eae0e02b..28e0107abc0 100644 --- a/service/rekognition/api_op_GetFaceDetection.go +++ b/service/rekognition/api_op_GetFaceDetection.go @@ -11,24 +11,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets face detection results for a Amazon Rekognition Video analysis started by -// 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 -// 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 . Note that for the GetFaceDetection operation, the returned -// values for FaceOccluded and EyeDirection will always be "null". +// Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection. +// +// Face detection with Amazon Rekognition Video is an asynchronous operation. You +// start face detection by calling StartFaceDetectionwhich 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 . +// +// Note that for the GetFaceDetection operation, the returned values for +// FaceOccluded and EyeDirection will always be "null". func (c *Client) GetFaceDetection(ctx context.Context, params *GetFaceDetectionInput, optFns ...func(*Options)) (*GetFaceDetectionOutput, error) { if params == nil { params = &GetFaceDetectionInput{} @@ -92,8 +97,8 @@ type GetFaceDetectionOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition Video analyzed. Videometadata diff --git a/service/rekognition/api_op_GetFaceLivenessSessionResults.go b/service/rekognition/api_op_GetFaceLivenessSessionResults.go index f191282af35..63c91c8a24f 100644 --- a/service/rekognition/api_op_GetFaceLivenessSessionResults.go +++ b/service/rekognition/api_op_GetFaceLivenessSessionResults.go @@ -15,10 +15,11 @@ import ( // sessionId as input, which was created using CreateFaceLivenessSession . Returns // the corresponding Face Liveness confidence score, a reference image that // includes a face bounding box, and audit images that also contain face bounding -// boxes. The Face Liveness confidence score ranges from 0 to 100. The number of -// audit images returned by GetFaceLivenessSessionResults is defined by the -// AuditImagesLimit paramater when calling CreateFaceLivenessSession . Reference -// images are always returned when possible. +// boxes. The Face Liveness confidence score ranges from 0 to 100. +// +// The number of audit images returned by GetFaceLivenessSessionResults is defined +// by the AuditImagesLimit paramater when calling CreateFaceLivenessSession . +// Reference images are always returned when possible. func (c *Client) GetFaceLivenessSessionResults(ctx context.Context, params *GetFaceLivenessSessionResultsInput, optFns ...func(*Options)) (*GetFaceLivenessSessionResultsOutput, error) { if params == nil { params = &GetFaceLivenessSessionResultsInput{} diff --git a/service/rekognition/api_op_GetFaceSearch.go b/service/rekognition/api_op_GetFaceSearch.go index 70bcab0e5b6..43519ac3c84 100644 --- a/service/rekognition/api_op_GetFaceSearch.go +++ b/service/rekognition/api_op_GetFaceSearch.go @@ -12,25 +12,32 @@ import ( ) // 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. +// 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 StartFaceSearchwhich 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. @@ -94,8 +101,8 @@ type GetFaceSearchOutput struct { // results. NextToken *string - // 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 + // 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 @@ -106,8 +113,8 @@ type GetFaceSearchOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition analyzed. Videometadata is diff --git a/service/rekognition/api_op_GetLabelDetection.go b/service/rekognition/api_op_GetLabelDetection.go index 0ad98204909..7593945fa1f 100644 --- a/service/rekognition/api_op_GetLabelDetection.go +++ b/service/rekognition/api_op_GetLabelDetection.go @@ -12,24 +12,34 @@ 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 -// 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 -// 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: +// 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 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: +// // - 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 @@ -37,13 +47,17 @@ import ( // 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. @@ -52,15 +66,19 @@ import ( // // 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 . +// 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{} @@ -142,8 +160,8 @@ type GetLabelDetectionOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition Video analyzed. Videometadata diff --git a/service/rekognition/api_op_GetPersonTracking.go b/service/rekognition/api_op_GetPersonTracking.go index b1e4563b652..f566e5a67a5 100644 --- a/service/rekognition/api_op_GetPersonTracking.go +++ b/service/rekognition/api_op_GetPersonTracking.go @@ -12,27 +12,37 @@ import ( ) // 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 +// 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 . +// +// 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{} @@ -103,8 +113,8 @@ type GetPersonTrackingOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition Video analyzed. Videometadata diff --git a/service/rekognition/api_op_GetSegmentDetection.go b/service/rekognition/api_op_GetSegmentDetection.go index ba71c0c447f..479218e9c54 100644 --- a/service/rekognition/api_op_GetSegmentDetection.go +++ b/service/rekognition/api_op_GetSegmentDetection.go @@ -12,29 +12,36 @@ import ( ) // Gets the segment detection results of a Amazon Rekognition Video analysis -// 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 -// 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 +// started by StartSegmentDetection. +// +// Segment detection with Amazon Rekognition Video is an asynchronous operation. +// You start segment detection by calling StartSegmentDetectionwhich 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. +// 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{} @@ -111,8 +118,8 @@ type GetSegmentDetectionOutput struct { StatusMessage *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Currently, Amazon Rekognition Video returns a single object in the VideoMetadata diff --git a/service/rekognition/api_op_GetTextDetection.go b/service/rekognition/api_op_GetTextDetection.go index 5e1ef81c2ce..8d009afce7f 100644 --- a/service/rekognition/api_op_GetTextDetection.go +++ b/service/rekognition/api_op_GetTextDetection.go @@ -12,25 +12,31 @@ import ( ) // Gets the text detection results of a Amazon Rekognition Video analysis started -// 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 -// 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 100 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 -// 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 . +// by StartTextDetection. +// +// Text detection with Amazon Rekognition Video is an asynchronous operation. You +// start text detection by calling StartTextDetectionwhich 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 100 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 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 . func (c *Client) GetTextDetection(ctx context.Context, params *GetTextDetectionInput, optFns ...func(*Options)) (*GetTextDetectionOutput, error) { if params == nil { params = &GetTextDetectionInput{} @@ -96,8 +102,8 @@ type GetTextDetectionOutput struct { TextModelVersion *string // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. Video *types.Video // Information about a video that Amazon Rekognition analyzed. Videometadata is diff --git a/service/rekognition/api_op_IndexFaces.go b/service/rekognition/api_op_IndexFaces.go index 5b16c875869..12355a1508e 100644 --- a/service/rekognition/api_op_IndexFaces.go +++ b/service/rekognition/api_op_IndexFaces.go @@ -12,69 +12,99 @@ import ( ) // Detects faces in the input image and adds them to the specified collection. -// Amazon Rekognition doesn't save the actual faces that are detected. Instead, the -// underlying detection algorithm first detects the faces in the input image. For -// each face, the algorithm extracts facial features into a feature vector, and +// +// Amazon Rekognition doesn't save the actual faces that are detected. Instead, +// the underlying detection algorithm first detects the faces in the input image. +// For each face, the algorithm extracts facial features into a feature vector, and // stores it in the backend database. Amazon Rekognition uses feature vectors when -// 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 -// 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 -// 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 -// ID to create a client-side index to associate the faces with each image. You can -// then use the index to find all faces in an image. You can specify the maximum -// number of faces to index with the MaxFaces input parameter. This is useful when -// you want to index the largest faces in an image and don't want to index smaller -// faces, such as those belonging to people standing in the background. 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. 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: +// it performs face match and search operations using the SearchFacesand 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 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 optional ExternalImageId for the input image you provided, +// Amazon Rekognition associates this ID with all faces that it detects. When you +// call the ListFacesoperation, the response returns the external ID. You can use this +// external image ID to create a client-side index to associate the faces with each +// image. You can then use the index to find all faces in an image. +// +// You can specify the maximum number of faces to index with the MaxFaces input +// parameter. This is useful when you want to index the largest faces in an image +// and don't want to index smaller faces, such as those belonging to people +// standing in the background. +// +// 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. 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 UnindexedFaceobjects, 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. // // 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 or specific facial attributes (e.g., FACE_OCCLUDED ) by using // the detectionAttributes parameter, Amazon Rekognition returns detailed facial // attributes, such as facial landmarks (for example, location of eye and mouth), -// facial occlusion, 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. +// facial occlusion, 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{} @@ -100,9 +130,11 @@ type IndexFacesInput struct { // The input 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 isn't - // 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. + // 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. Image *types.Image @@ -112,9 +144,10 @@ type IndexFacesInput struct { // will always be returned. You can request for specific facial attributes (in // addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just // ["FACE_OCCLUDED"] . You can request for all facial attributes by using ["ALL"] . - // Requesting more attributes may increase response time. If you provide both, - // ["ALL", "DEFAULT"] , the service uses a logical AND operator to determine which - // attributes to return (in this case, all attributes). + // Requesting more attributes may increase response time. + // + // 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. @@ -122,15 +155,19 @@ type IndexFacesInput struct { // 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. + // 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 @@ -141,8 +178,10 @@ type IndexFacesInput struct { // 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. + // 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 @@ -160,8 +199,11 @@ type IndexFacesOutput struct { // If your collection is associated with a face detection model that's later than // 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: + // 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 @@ -169,13 +211,15 @@ type IndexFacesOutput struct { // 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 . + // 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 diff --git a/service/rekognition/api_op_ListCollections.go b/service/rekognition/api_op_ListCollections.go index 33ae654bde6..9eeee22d30a 100644 --- a/service/rekognition/api_op_ListCollections.go +++ b/service/rekognition/api_op_ListCollections.go @@ -12,9 +12,13 @@ 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. +// 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{} diff --git a/service/rekognition/api_op_ListDatasetEntries.go b/service/rekognition/api_op_ListDatasetEntries.go index 60880e97d81..827d5c0972b 100644 --- a/service/rekognition/api_op_ListDatasetEntries.go +++ b/service/rekognition/api_op_ListDatasetEntries.go @@ -10,19 +10,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 +// This operation applies only to Amazon Rekognition Custom Labels. +// +// 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]. +// +// 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 -// model training. You can filter the response in variety of ways, such as choosing -// which labels to return and returning JSON Lines created after a specific date. +// model training. +// +// You can filter the response in variety of ways, such as choosing which labels +// to return and returning JSON Lines created after a specific date. +// // This operation requires permissions to perform the // rekognition:ListDatasetEntries action. +// +// [Creating a manifest file]: https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html func (c *Client) ListDatasetEntries(ctx context.Context, params *ListDatasetEntriesInput, optFns ...func(*Options)) (*ListDatasetEntriesOutput, error) { if params == nil { params = &ListDatasetEntriesInput{} @@ -40,7 +46,7 @@ func (c *Client) ListDatasetEntries(ctx context.Context, params *ListDatasetEntr type ListDatasetEntriesInput struct { - // The Amazon Resource Name (ARN) for the dataset that you want to use. + // The Amazon Resource Name (ARN) for the dataset that you want to use. // // This member is required. DatasetArn *string @@ -53,7 +59,7 @@ type ListDatasetEntriesInput struct { // entries that have errors. HasErrors *bool - // Specify true to get only the JSON Lines where the image is labeled. Specify + // 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. @@ -81,7 +87,7 @@ type ListDatasetEntriesInput struct { type ListDatasetEntriesOutput struct { - // A list of entries (images) in the dataset. + // A list of entries (images) in the dataset. DatasetEntries []string // If the previous response was incomplete (because there is more results to diff --git a/service/rekognition/api_op_ListDatasetLabels.go b/service/rekognition/api_op_ListDatasetLabels.go index 305f5cd70e3..e90925c23cd 100644 --- a/service/rekognition/api_op_ListDatasetLabels.go +++ b/service/rekognition/api_op_ListDatasetLabels.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to +// describe images. For more information, see [Labeling images]. +// +// 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. +// +// [Labeling images]: https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html func (c *Client) ListDatasetLabels(ctx context.Context, params *ListDatasetLabelsInput, optFns ...func(*Options)) (*ListDatasetLabelsOutput, error) { if params == nil { params = &ListDatasetLabelsInput{} @@ -34,7 +38,7 @@ func (c *Client) ListDatasetLabels(ctx context.Context, params *ListDatasetLabel type ListDatasetLabelsInput struct { - // The Amazon Resource Name (ARN) of the dataset that you want to use. + // The Amazon Resource Name (ARN) of the dataset that you want to use. // // This member is required. DatasetArn *string @@ -54,7 +58,7 @@ type ListDatasetLabelsInput struct { type ListDatasetLabelsOutput struct { - // A list of the labels in the dataset. + // A list of the labels in the dataset. DatasetLabelDescriptions []types.DatasetLabelDescription // If the previous response was incomplete (because there is more results to diff --git a/service/rekognition/api_op_ListFaces.go b/service/rekognition/api_op_ListFaces.go index dfee31421d8..c3ec5a2068b 100644 --- a/service/rekognition/api_op_ListFaces.go +++ b/service/rekognition/api_op_ListFaces.go @@ -14,8 +14,9 @@ import ( // Returns metadata for faces in the specified collection. This metadata includes // information such as the bounding box coordinates, the confidence (that the // bounding box contains a face), and face ID. For an example, see Listing Faces in -// a Collection in the Amazon Rekognition Developer Guide. This operation requires -// permissions to perform the rekognition:ListFaces action. +// a Collection in the Amazon Rekognition Developer Guide. +// +// This operation requires permissions to perform the rekognition:ListFaces action. func (c *Client) ListFaces(ctx context.Context, params *ListFacesInput, optFns ...func(*Options)) (*ListFacesOutput, error) { if params == nil { params = &ListFacesInput{} diff --git a/service/rekognition/api_op_ListProjectPolicies.go b/service/rekognition/api_op_ListProjectPolicies.go index 02fac62c0f2..f2894c2fe2b 100644 --- a/service/rekognition/api_op_ListProjectPolicies.go +++ b/service/rekognition/api_op_ListProjectPolicies.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 . This operation requires permissions to perform the +// This operation applies only to Amazon Rekognition Custom Labels. +// +// 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. +// +// This operation requires permissions to perform the // rekognition:ListProjectPolicies action. func (c *Client) ListProjectPolicies(ctx context.Context, params *ListProjectPoliciesInput, optFns ...func(*Options)) (*ListProjectPoliciesOutput, error) { if params == nil { diff --git a/service/rekognition/api_op_ListStreamProcessors.go b/service/rekognition/api_op_ListStreamProcessors.go index db2b1c07892..777ced041b6 100644 --- a/service/rekognition/api_op_ListStreamProcessors.go +++ b/service/rekognition/api_op_ListStreamProcessors.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of stream processors that you have created with -// CreateStreamProcessor . +// Gets a list of stream processors that you have created with 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 1ee748de9de..cdbc325ba53 100644 --- a/service/rekognition/api_op_ListTagsForResource.go +++ b/service/rekognition/api_op_ListTagsForResource.go @@ -10,8 +10,11 @@ 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 { @@ -30,7 +33,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // Amazon Resource Name (ARN) of the model, collection, or stream processor that + // Amazon Resource Name (ARN) of the model, collection, or stream processor that // contains the tags that you want a list of. // // This member is required. @@ -41,7 +44,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // A list of key-value tags assigned to the resource. + // A list of key-value tags assigned to the resource. Tags map[string]string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_PutProjectPolicy.go b/service/rekognition/api_op_PutProjectPolicy.go index 836d0c813c9..9ae8466dd99 100644 --- a/service/rekognition/api_op_PutProjectPolicy.go +++ b/service/rekognition/api_op_PutProjectPolicy.go @@ -10,21 +10,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Attaches a -// project policy to a Amazon Rekognition Custom Labels project in a trusting AWS -// account. A project policy specifies that a trusted AWS account can copy a model -// version from a trusting AWS account to a project in the trusted AWS account. To -// copy a model version you use the CopyProjectVersion operation. Only applies to -// Custom Labels projects. For more information about the format of a project -// policy document, see Attaching a project policy (SDK) in the Amazon Rekognition -// Custom Labels Developer Guide. 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 . This operation requires permissions to perform the -// rekognition:PutProjectPolicy action. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Attaches a project policy to a Amazon Rekognition Custom Labels project in a +// trusting AWS account. A project policy specifies that a trusted AWS account can +// copy a model version from a trusting AWS account to a project in the trusted AWS +// account. To copy a model version you use the CopyProjectVersionoperation. Only applies to Custom +// Labels projects. +// +// For more information about the format of a project policy document, see +// Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels +// Developer Guide. +// +// 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. +// +// This operation requires permissions to perform the rekognition:PutProjectPolicy +// action. func (c *Client) PutProjectPolicy(ctx context.Context, params *PutProjectPolicyInput, optFns ...func(*Options)) (*PutProjectPolicyOutput, error) { if params == nil { params = &PutProjectPolicyInput{} @@ -45,8 +54,9 @@ 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]. + // + // [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 372c6f5533f..f4b14ad315d 100644 --- a/service/rekognition/api_op_RecognizeCelebrities.go +++ b/service/rekognition/api_op_RecognizeCelebrities.go @@ -13,25 +13,35 @@ import ( // Returns an array of celebrities recognized in the input image. For more // information, see Recognizing celebrities in the Amazon Rekognition Developer -// Guide. RecognizeCelebrities returns the 64 largest faces in the image. It lists -// the recognized celebrities in the CelebrityFaces array and any unrecognized -// faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return -// celebrities whose faces aren't among the largest 64 faces in the image. For each -// celebrity recognized, RecognizeCelebrities returns a Celebrity object. The -// Celebrity object contains the celebrity name, ID, URL links to additional +// Guide. +// +// RecognizeCelebrities returns the 64 largest faces in the image. It lists the +// recognized celebrities in the CelebrityFaces array and any unrecognized faces +// in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities +// whose faces aren't among the largest 64 faces in the image. +// +// For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. +// The Celebrity object contains the celebrity name, ID, URL links to additional // information, match confidence, and a ComparedFace object that you can use to -// locate the celebrity's face on the image. Amazon Rekognition doesn't retain -// 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 -// 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 +// locate the celebrity's face on the image. +// +// Amazon Rekognition doesn't retain 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 ID to identify the celebrity in a call +// to the GetCelebrityInfooperation. +// +// 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. For an example, see Recognizing celebrities -// in an image in the Amazon Rekognition Developer Guide. This operation requires -// permissions to perform the rekognition:RecognizeCelebrities operation. +// either a PNG or JPEG formatted file. +// +// For an example, see Recognizing celebrities in an image in the Amazon +// Rekognition Developer Guide. +// +// This operation requires permissions to perform the +// rekognition:RecognizeCelebrities operation. func (c *Client) RecognizeCelebrities(ctx context.Context, params *RecognizeCelebritiesInput, optFns ...func(*Options)) (*RecognizeCelebritiesOutput, error) { if params == nil { params = &RecognizeCelebritiesInput{} @@ -51,9 +61,11 @@ type RecognizeCelebritiesInput struct { // The input 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. + // 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. Image *types.Image @@ -71,17 +83,21 @@ type RecognizeCelebritiesOutput struct { // Support for estimating image orientation using the the OrientationCorrection // field has ceased as of August 2021. Any returned values for this field included - // in an API response will always be NULL. The orientation of the input image - // (counterclockwise direction). If your application displays the image, you can - // use this value to correct the orientation. The bounding box coordinates returned - // in CelebrityFaces and UnrecognizedFaces represent face locations before the - // image orientation is corrected. If the input image is in .jpeg format, it might - // contain exchangeable image (Exif) metadata that includes the image's - // orientation. If so, and the Exif metadata for the input image populates the - // orientation field, the value of OrientationCorrection is null. The - // CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face - // locations after Exif metadata is used to correct the image orientation. Images - // in .png format don't contain Exif metadata. + // in an API response will always be NULL. + // + // The orientation of the input image (counterclockwise direction). If your + // application displays the image, you can use this value to correct the + // orientation. The bounding box coordinates returned in CelebrityFaces and + // UnrecognizedFaces represent face locations before the image orientation is + // corrected. + // + // If the input image is in .jpeg format, it might contain exchangeable image + // (Exif) metadata that includes the image's orientation. If so, and the Exif + // metadata for the input image populates the orientation field, the value of + // OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces + // bounding box coordinates represent face locations after Exif metadata is used to + // correct the image orientation. Images in .png format don't contain Exif + // metadata. OrientationCorrection types.OrientationCorrection // Details about each unrecognized face in the image. diff --git a/service/rekognition/api_op_SearchFaces.go b/service/rekognition/api_op_SearchFaces.go index 1323a632436..127bfc20088 100644 --- a/service/rekognition/api_op_SearchFaces.go +++ b/service/rekognition/api_op_SearchFaces.go @@ -13,16 +13,23 @@ import ( // For a given input face ID, searches for matching faces in the collection the // 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 -// requires permissions to perform the rekognition:SearchFaces action. +// the IndexFacesoperation. 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 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 { params = &SearchFacesInput{} diff --git a/service/rekognition/api_op_SearchFacesByImage.go b/service/rekognition/api_op_SearchFacesByImage.go index aaeaedce818..b1d976a90c4 100644 --- a/service/rekognition/api_op_SearchFacesByImage.go +++ b/service/rekognition/api_op_SearchFacesByImage.go @@ -13,32 +13,45 @@ import ( // For a given input image, first detects the largest face in the image, and then // 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 -// 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 -// supported. The image must be either a PNG or JPEG formatted file. The 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 found. Along with the metadata, the response also includes a +// 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 SearchFacesoperation. +// +// 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 supported. The image must be +// either a PNG or JPEG formatted file. +// +// The 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 found. Along with the metadata, the response also includes a // similarity indicating how similar the face is to the input face. In the // response, the operation also returns the bounding box (and a confidence level // that the bounding box contains a face) of the face that Amazon Rekognition used -// for the input image. If no faces are detected in the input image, -// SearchFacesByImage returns an InvalidParameterException error. For an example, -// Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. +// for the input image. +// +// If no faces are detected in the input image, SearchFacesByImage returns an +// InvalidParameterException error. +// +// For an example, Searching for a Face Using an Image in the Amazon Rekognition +// Developer Guide. +// // 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 -// 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 +// 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 // rekognition:SearchFacesByImage action. func (c *Client) SearchFacesByImage(ctx context.Context, params *SearchFacesByImageInput, optFns ...func(*Options)) (*SearchFacesByImageOutput, error) { if params == nil { @@ -64,9 +77,11 @@ type SearchFacesByImageInput struct { // The input 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. + // 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. Image *types.Image @@ -88,8 +103,10 @@ type SearchFacesByImageInput struct { // 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. + // 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 diff --git a/service/rekognition/api_op_SearchUsersByImage.go b/service/rekognition/api_op_SearchUsersByImage.go index e5d77c8cf56..d45e22b489e 100644 --- a/service/rekognition/api_op_SearchUsersByImage.go +++ b/service/rekognition/api_op_SearchUsersByImage.go @@ -12,13 +12,16 @@ import ( ) // Searches for UserIDs using a supplied image. It first detects the largest face -// in the image, and then searches a specified collection for matching UserIDs. The -// operation returns an array of UserIDs that match the face in the supplied image, -// ordered by similarity score with the highest similarity first. It also returns a -// bounding box for the face found in the input image. Information about faces -// detected in the supplied image, but not used for the search, is returned in an -// array of UnsearchedFace objects. If no valid face is detected in the image, the -// response will contain an empty UserMatches list and no SearchedFace object. +// in the image, and then searches a specified collection for matching UserIDs. +// +// The operation returns an array of UserIDs that match the face in the supplied +// image, ordered by similarity score with the highest similarity first. It also +// returns a bounding box for the face found in the input image. +// +// Information about faces detected in the supplied image, but not used for the +// search, is returned in an array of UnsearchedFace objects. If no valid face is +// detected in the image, the response will contain an empty UserMatches list and +// no SearchedFace object. func (c *Client) SearchUsersByImage(ctx context.Context, params *SearchUsersByImageInput, optFns ...func(*Options)) (*SearchUsersByImageOutput, error) { if params == nil { params = &SearchUsersByImageInput{} @@ -41,22 +44,30 @@ type SearchUsersByImageInput struct { // This member is required. CollectionId *string - // 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 + // 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. // // This member is required. diff --git a/service/rekognition/api_op_StartCelebrityRecognition.go b/service/rekognition/api_op_StartCelebrityRecognition.go index 2912f993521..a215a7803ad 100644 --- a/service/rekognition/api_op_StartCelebrityRecognition.go +++ b/service/rekognition/api_op_StartCelebrityRecognition.go @@ -11,18 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 Videoto 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 -// celebrities in the Amazon Rekognition Developer Guide. +// 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 { params = &StartCelebrityRecognitionInput{} diff --git a/service/rekognition/api_op_StartContentModeration.go b/service/rekognition/api_op_StartContentModeration.go index 3f0f1a0b3d0..2db0a63dcfe 100644 --- a/service/rekognition/api_op_StartContentModeration.go +++ b/service/rekognition/api_op_StartContentModeration.go @@ -11,20 +11,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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]. +// +// Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 +// bucket. Use Videoto 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. +// 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 func (c *Client) StartContentModeration(ctx context.Context, params *StartContentModerationInput, optFns ...func(*Options)) (*StartContentModerationOutput, error) { if params == nil { params = &StartContentModerationInput{} diff --git a/service/rekognition/api_op_StartFaceDetection.go b/service/rekognition/api_op_StartFaceDetection.go index e49f3310a8b..ac87e9b234b 100644 --- a/service/rekognition/api_op_StartFaceDetection.go +++ b/service/rekognition/api_op_StartFaceDetection.go @@ -11,17 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// 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. +// 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 Videoto 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 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 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. func (c *Client) StartFaceDetection(ctx context.Context, params *StartFaceDetectionInput, optFns ...func(*Options)) (*StartFaceDetectionOutput, error) { if params == nil { params = &StartFaceDetectionInput{} @@ -51,8 +54,11 @@ type StartFaceDetectionInput struct { // than once. ClientRequestToken *string - // The face attributes you want returned. DEFAULT - The following subset of facial - // attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. + // The face attributes you want returned. + // + // DEFAULT - The following subset of facial attributes are returned: BoundingBox, + // Confidence, Pose, Quality and Landmarks. + // // ALL - All facial attributes are returned. FaceAttributes types.FaceAttributes diff --git a/service/rekognition/api_op_StartFaceSearch.go b/service/rekognition/api_op_StartFaceSearch.go index 78da14fa836..8a290ba866a 100644 --- a/service/rekognition/api_op_StartFaceSearch.go +++ b/service/rekognition/api_op_StartFaceSearch.go @@ -12,17 +12,19 @@ import ( ) // 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 -// Rekognition Video publishes a completion status to the Amazon Simple -// 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) -// . +// 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 Rekognition Video publishes a completion +// status to the Amazon Simple 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]. +// +// [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{} diff --git a/service/rekognition/api_op_StartLabelDetection.go b/service/rekognition/api_op_StartLabelDetection.go index d057723c06c..86e11da9d6d 100644 --- a/service/rekognition/api_op_StartLabelDetection.go +++ b/service/rekognition/api_op_StartLabelDetection.go @@ -11,27 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts asynchronous detection of labels in a stored video. Amazon Rekognition -// Video can detect labels in a video. Labels are instances of real-world entities. -// This includes objects like flower, tree, and table; events like wedding, -// 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 -// 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 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 -// 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 +// Starts asynchronous detection of labels in a stored video. +// +// Amazon Rekognition Video can detect labels in a video. Labels are instances of +// real-world entities. This includes objects like flower, tree, and table; events +// like wedding, 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 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 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 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]. +// +// You can specify MinConfidence to control the confidence threshold for the // labels returned. The default is 50. +// +// [Detecting labels in a video]: https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html func (c *Client) StartLabelDetection(ctx context.Context, params *StartLabelDetectionInput, optFns ...func(*Options)) (*StartLabelDetectionOutput, error) { if params == nil { params = &StartLabelDetectionInput{} @@ -75,9 +85,10 @@ type StartLabelDetectionInput struct { // order to return a detected label. Confidence represents how certain Amazon // 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 - // detected) with confidence values greater than or equal to 50 percent. + // labels with a confidence level lower than this specified value. + // + // If you don't specify MinConfidence , the operation returns labels and bounding + // boxes (if detected) with confidence values greater than or equal to 50 percent. MinConfidence *float32 // The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the diff --git a/service/rekognition/api_op_StartPersonTracking.go b/service/rekognition/api_op_StartPersonTracking.go index c5f96813bc6..c767be7dfa6 100644 --- a/service/rekognition/api_op_StartPersonTracking.go +++ b/service/rekognition/api_op_StartPersonTracking.go @@ -11,16 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 Videoto specify the bucket name and the filename of the video. // 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 -// 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 . +// 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 . func (c *Client) StartPersonTracking(ctx context.Context, params *StartPersonTrackingInput, optFns ...func(*Options)) (*StartPersonTrackingOutput, error) { if params == nil { params = &StartPersonTrackingInput{} diff --git a/service/rekognition/api_op_StartProjectVersion.go b/service/rekognition/api_op_StartProjectVersion.go index b6b9f9fcf04..e70b5af53dd 100644 --- a/service/rekognition/api_op_StartProjectVersion.go +++ b/service/rekognition/api_op_StartProjectVersion.go @@ -11,13 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. 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 . 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 . This operation -// requires permissions to perform the rekognition:StartProjectVersion action. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// 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. +// +// 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. +// +// 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,9 +42,10 @@ 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. Use a higher number to increase the TPS - // throughput of your model. You are charged for the number of inference units that - // you use. + // 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 diff --git a/service/rekognition/api_op_StartSegmentDetection.go b/service/rekognition/api_op_StartSegmentDetection.go index f6e4b3fb84f..39f7f90599b 100644 --- a/service/rekognition/api_op_StartSegmentDetection.go +++ b/service/rekognition/api_op_StartSegmentDetection.go @@ -11,22 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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 Videoto 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. +// 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{} @@ -51,8 +55,8 @@ type StartSegmentDetectionInput struct { SegmentTypes []types.SegmentType // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. // // This member is required. Video *types.Video diff --git a/service/rekognition/api_op_StartStreamProcessor.go b/service/rekognition/api_op_StartStreamProcessor.go index 654e691839e..630f9afb834 100644 --- a/service/rekognition/api_op_StartStreamProcessor.go +++ b/service/rekognition/api_op_StartStreamProcessor.go @@ -11,12 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts processing a stream processor. You create a stream processor by calling -// 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 -// detect labels, you need to provide a Start selector and a Stop selector to -// determine the length of the stream processing time. +// Starts processing a stream processor. You create a stream processor by calling 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 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) { if params == nil { params = &StartStreamProcessorInput{} @@ -39,18 +40,22 @@ type StartStreamProcessorInput struct { // This member is required. Name *string - // 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 + // 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]. + // + // This is a required parameter for label detection stream processors and should // not be used to start a face search stream processor. + // + // [Fragment]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html StartSelector *types.StreamProcessingStartSelector - // Specifies when to stop processing the stream. You can specify a maximum amount - // of time to process the video. This is a required parameter for label detection - // stream processors and should not be used to start a face search stream - // processor. + // Specifies when to stop processing the stream. You can specify a maximum amount + // of time to process the video. + // + // This is a required parameter for label detection stream processors and should + // not be used to start a face search stream processor. StopSelector *types.StreamProcessingStopSelector noSmithyDocumentSerde @@ -58,7 +63,7 @@ type StartStreamProcessorInput struct { type StartStreamProcessorOutput struct { - // A unique identifier for the stream processing session. + // A unique identifier for the stream processing session. SessionId *string // Metadata pertaining to the operation's result. diff --git a/service/rekognition/api_op_StartTextDetection.go b/service/rekognition/api_op_StartTextDetection.go index 94f36f96ed0..bbdd023131f 100644 --- a/service/rekognition/api_op_StartTextDetection.go +++ b/service/rekognition/api_op_StartTextDetection.go @@ -11,16 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// 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 . +// 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 Videoto 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 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 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 . func (c *Client) StartTextDetection(ctx context.Context, params *StartTextDetectionInput, optFns ...func(*Options)) (*StartTextDetectionOutput, error) { if params == nil { params = &StartTextDetectionInput{} @@ -39,8 +41,8 @@ func (c *Client) StartTextDetection(ctx context.Context, params *StartTextDetect type StartTextDetectionInput struct { // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start - // operations such as StartLabelDetection use Video to specify a video for - // analysis. The supported file formats are .mp4, .mov and .avi. + // operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported + // file formats are .mp4, .mov and .avi. // // This member is required. Video *types.Video @@ -62,12 +64,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]. 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]. + // + // [Calling Amazon Rekognition Video operations]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html + // [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 diff --git a/service/rekognition/api_op_StopProjectVersion.go b/service/rekognition/api_op_StopProjectVersion.go index 7a830375828..fbf261987aa 100644 --- a/service/rekognition/api_op_StopProjectVersion.go +++ b/service/rekognition/api_op_StopProjectVersion.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Stops a -// running model. The operation might take a while to complete. To check the -// current status, call DescribeProjectVersions . Only applies to Custom Labels -// projects. This operation requires permissions to perform the +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Stops a running model. The operation might take a while to complete. To check +// the current status, call DescribeProjectVersions. Only applies to Custom Labels projects. +// +// This operation requires permissions to perform the // rekognition:StopProjectVersion action. func (c *Client) StopProjectVersion(ctx context.Context, params *StopProjectVersionInput, optFns ...func(*Options)) (*StopProjectVersionOutput, error) { if params == nil { @@ -33,9 +35,10 @@ func (c *Client) StopProjectVersion(ctx context.Context, params *StopProjectVers type StopProjectVersionInput struct { - // The Amazon Resource Name (ARN) of the model version that you want to stop. This - // operation requires permissions to perform the rekognition:StopProjectVersion - // action. + // The Amazon Resource Name (ARN) of the model version that you want to stop. + // + // This operation requires permissions to perform the + // rekognition:StopProjectVersion action. // // This member is required. ProjectVersionArn *string diff --git a/service/rekognition/api_op_StopStreamProcessor.go b/service/rekognition/api_op_StopStreamProcessor.go index 50a6e990cb5..4f064451ce4 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 bb5c0933c8e..5a50c6c4895 100644 --- a/service/rekognition/api_op_TagResource.go +++ b/service/rekognition/api_op_TagResource.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) . +// 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]. +// // This operation requires permissions to perform the rekognition:TagResource // action. +// +// [Tagging AWS 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{} @@ -32,13 +35,13 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // Amazon Resource Name (ARN) of the model, collection, or stream processor that + // Amazon Resource Name (ARN) of the model, collection, or stream processor that // you want to assign the tags to. // // This member is required. ResourceArn *string - // The key-value tags to assign to the resource. + // The key-value tags to assign to the resource. // // This member is required. Tags map[string]string diff --git a/service/rekognition/api_op_UntagResource.go b/service/rekognition/api_op_UntagResource.go index 66d720bbb06..1b8fa210431 100644 --- a/service/rekognition/api_op_UntagResource.go +++ b/service/rekognition/api_op_UntagResource.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes one or more tags from an Amazon Rekognition collection, stream -// processor, or Custom Labels model. This operation requires permissions to -// perform the rekognition:UntagResource action. +// Removes one or more tags from an Amazon Rekognition collection, stream +// +// processor, or Custom Labels model. +// +// This operation requires permissions to perform the rekognition:UntagResource +// action. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -30,13 +33,13 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // Amazon Resource Name (ARN) of the model, collection, or stream processor that + // Amazon Resource Name (ARN) of the model, collection, or stream processor that // you want to remove the tags from. // // This member is required. ResourceArn *string - // A list of the tags that you want to remove. + // A list of the tags that you want to remove. // // This member is required. TagKeys []string diff --git a/service/rekognition/api_op_UpdateDatasetEntries.go b/service/rekognition/api_op_UpdateDatasetEntries.go index 71c52b32818..ec84ba60857 100644 --- a/service/rekognition/api_op_UpdateDatasetEntries.go +++ b/service/rekognition/api_op_UpdateDatasetEntries.go @@ -11,24 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation applies only to Amazon Rekognition Custom Labels. Adds or -// updates one or more entries (images) in a dataset. An entry is a JSON Line which -// contains the information for a single image, including the image location, -// assigned labels, and object location bounding boxes. For more information, see -// Image-Level labels in manifest files and Object localization in manifest files -// in the Amazon Rekognition Custom Labels Developer Guide. If the source-ref -// field in the JSON line references an existing image, the existing 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 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 Rekognition Custom Labels SDK. +// This operation applies only to Amazon Rekognition Custom Labels. +// +// Adds or updates one or more entries (images) in a dataset. An entry is a JSON +// Line which contains the information for a single image, including the image +// location, assigned labels, and object location bounding boxes. For more +// information, see Image-Level labels in manifest files and Object localization in +// manifest files in the Amazon Rekognition Custom Labels Developer Guide. +// +// If the source-ref field in the JSON line references an existing image, the +// existing 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 update might take a +// while to complete. Use DescribeDatasetto 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 +// 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) { @@ -48,12 +57,12 @@ func (c *Client) UpdateDatasetEntries(ctx context.Context, params *UpdateDataset type UpdateDatasetEntriesInput struct { - // The changes that you want to make to the dataset. + // The changes that you want to make to the dataset. // // This member is required. Changes *types.DatasetChanges - // The Amazon Resource Name (ARN) of the dataset that you want to update. + // The Amazon Resource Name (ARN) of the dataset that you want to update. // // This member is required. DatasetArn *string diff --git a/service/rekognition/api_op_UpdateStreamProcessor.go b/service/rekognition/api_op_UpdateStreamProcessor.go index 7d90b268fa5..069cc7727c2 100644 --- a/service/rekognition/api_op_UpdateStreamProcessor.go +++ b/service/rekognition/api_op_UpdateStreamProcessor.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to update a stream processor. You can change some settings and +// Allows you to update a stream processor. You can change some settings and +// // regions of interest and delete certain parameters. func (c *Client) UpdateStreamProcessor(ctx context.Context, params *UpdateStreamProcessorInput, optFns ...func(*Options)) (*UpdateStreamProcessorOutput, error) { if params == nil { @@ -30,26 +31,27 @@ func (c *Client) UpdateStreamProcessor(ctx context.Context, params *UpdateStream type UpdateStreamProcessorInput struct { - // Name of the stream processor that you want to update. + // Name of the stream processor that you want to update. // // This member is required. Name *string - // Shows whether you are sharing data with Rekognition to improve model + // Shows whether you are sharing data with Rekognition to improve model // performance. You can choose this option at the account level or on a per-stream // basis. Note that if you opt out at the account level this setting is ignored on // individual streams. DataSharingPreferenceForUpdate *types.StreamProcessorDataSharingPreference - // A list of parameters you want to delete from the stream processor. + // 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 + // 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 - // can be updated to detect different labels with a different minimum confidence. + // The stream processor settings that you want to update. Label detection + // settings can be updated to detect different labels with a different minimum + // confidence. SettingsForUpdate *types.StreamProcessorSettingsForUpdate noSmithyDocumentSerde diff --git a/service/rekognition/doc.go b/service/rekognition/doc.go index 629bf5bc509..4c90f311d26 100644 --- a/service/rekognition/doc.go +++ b/service/rekognition/doc.go @@ -3,86 +3,229 @@ // 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 -// - AssociateFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_AssociateFaces.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) -// - CreateUser (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateUser.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) -// - DeleteUser (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteUser.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) -// - DisassociateFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DisassociateFaces.html) -// - GetCelebrityInfo (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html) -// - GetMediaAnalysisJob (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.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) -// - ListMediaAnalysisJob (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html) -// - ListFaces (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html) -// - ListUsers (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) -// - SearchUsers (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsers.html) -// - SearchUsersByImage (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html) -// - StartMediaAnalysisJob (https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.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) +// This is the API Reference for [Amazon Rekognition Image], [Amazon Rekognition Custom Labels], [Amazon Rekognition Stored Video], [Amazon Rekognition Streaming Video]. It provides descriptions of actions, data +// types, common parameters, and common errors. +// +// # Amazon Rekognition Image +// +// [AssociateFaces] +// +// [CompareFaces] +// +// [CreateCollection] +// +// [CreateUser] +// +// [DeleteCollection] +// +// [DeleteFaces] +// +// [DeleteUser] +// +// [DescribeCollection] +// +// [DetectFaces] +// +// [DetectLabels] +// +// [DetectModerationLabels] +// +// [DetectProtectiveEquipment] +// +// [DetectText] +// +// [DisassociateFaces] +// +// [GetCelebrityInfo] +// +// [GetMediaAnalysisJob] +// +// [IndexFaces] +// +// [ListCollections] +// +// [ListMediaAnalysisJob] +// +// [ListFaces] +// +// [ListUsers] +// +// [RecognizeCelebrities] +// +// [SearchFaces] +// +// [SearchFacesByImage] +// +// [SearchUsers] +// +// [SearchUsersByImage] +// +// [StartMediaAnalysisJob] +// +// # Amazon Rekognition Custom Labels +// +// [CopyProjectVersion] +// +// [CreateDataset] +// +// [CreateProject] +// +// [CreateProjectVersion] +// +// [DeleteDataset] +// +// [DeleteProject] +// +// [DeleteProjectPolicy] +// +// [DeleteProjectVersion] +// +// [DescribeDataset] +// +// [DescribeProjects] +// +// [DescribeProjectVersions] +// +// [DetectCustomLabels] +// +// [DistributeDatasetEntries] +// +// [ListDatasetEntries] +// +// [ListDatasetLabels] +// +// [ListProjectPolicies] +// +// [PutProjectPolicy] +// +// [StartProjectVersion] +// +// [StopProjectVersion] +// +// [UpdateDatasetEntries] +// +// # Amazon Rekognition Video Stored Video +// +// [GetCelebrityRecognition] +// +// [GetContentModeration] +// +// [GetFaceDetection] +// +// [GetFaceSearch] +// +// [GetLabelDetection] +// +// [GetPersonTracking] +// +// [GetSegmentDetection] +// +// [GetTextDetection] +// +// [StartCelebrityRecognition] +// +// [StartContentModeration] +// +// [StartFaceDetection] +// +// [StartFaceSearch] +// +// [StartLabelDetection] +// +// [StartPersonTracking] +// +// [StartSegmentDetection] +// +// [StartTextDetection] +// +// # Amazon Rekognition Video Streaming Video +// +// [CreateStreamProcessor] +// +// [DeleteStreamProcessor] +// +// [DescribeStreamProcessor] +// +// [ListStreamProcessors] +// +// [StartStreamProcessor] +// +// [StopStreamProcessor] +// +// [UpdateStreamProcessor] +// +// [Amazon Rekognition Custom Labels]: https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html +// [DescribeCollection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html +// [ListUsers]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html +// [DeleteFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html +// [ListFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html +// [DistributeDatasetEntries]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html +// [DetectProtectiveEquipment]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html +// [DescribeProjectVersions]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html +// [GetMediaAnalysisJob]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html +// [StartTextDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html +// [SearchFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html +// [CreateCollection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html +// [GetContentModeration]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html +// [CopyProjectVersion]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html +// [StartFaceSearch]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html +// [SearchUsers]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsers.html +// [DeleteCollection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html +// [DescribeDataset]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html +// [StartCelebrityRecognition]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html +// [StartFaceDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html +// [UpdateDatasetEntries]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html +// [DetectFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html +// [ListCollections]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html +// [GetTextDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html +// [SearchUsersByImage]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html +// [DetectModerationLabels]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html +// [CreateDataset]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html +// [StartStreamProcessor]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html +// [ListMediaAnalysisJob]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html +// [DescribeStreamProcessor]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html +// [DeleteProject]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html +// [SearchFacesByImage]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html +// [DeleteStreamProcessor]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html +// [RecognizeCelebrities]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html +// [StartMediaAnalysisJob]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html +// [StartSegmentDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html +// [GetPersonTracking]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html +// [DetectCustomLabels]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html +// [StopProjectVersion]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html +// [DeleteUser]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteUser.html +// [DetectText]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html +// [PutProjectPolicy]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html +// [CreateProject]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html +// [StartPersonTracking]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html +// [GetSegmentDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html +// [GetCelebrityRecognition]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html +// [ListDatasetEntries]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html +// [IndexFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html +// [ListStreamProcessors]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html +// [DeleteProjectVersion]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html +// [Amazon Rekognition Streaming Video]: https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html +// [DeleteDataset]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html +// [StartContentModeration]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html +// [GetFaceSearch]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html +// [Amazon Rekognition Image]: https://docs.aws.amazon.com/rekognition/latest/dg/images.html +// [GetLabelDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html +// [GetCelebrityInfo]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html +// [CompareFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html +// [Amazon Rekognition Stored Video]: https://docs.aws.amazon.com/rekognition/latest/dg/video.html +// [UpdateStreamProcessor]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html +// [CreateUser]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateUser.html +// [DetectLabels]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html +// [DeleteProjectPolicy]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html +// [CreateProjectVersion]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html +// [StopStreamProcessor]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html +// [DescribeProjects]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html +// [StartLabelDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html +// [ListProjectPolicies]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html +// [DisassociateFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DisassociateFaces.html +// [CreateStreamProcessor]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html +// [AssociateFaces]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_AssociateFaces.html +// [ListDatasetLabels]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html +// [StartProjectVersion]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html +// [GetFaceDetection]: https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html package rekognition diff --git a/service/rekognition/options.go b/service/rekognition/options.go index 98ebd9c8f26..d7ec5751c9f 100644 --- a/service/rekognition/options.go +++ b/service/rekognition/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/rekognition/types/enums.go b/service/rekognition/types/enums.go index 1fccc71cbdd..c7f72c08cfa 100644 --- a/service/rekognition/types/enums.go +++ b/service/rekognition/types/enums.go @@ -23,8 +23,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -55,8 +56,9 @@ const ( ) // Values returns all known values for BodyPart. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BodyPart) Values() []BodyPart { return []BodyPart{ "FACE", @@ -76,6 +78,7 @@ const ( // Values returns all known values for CelebrityRecognitionSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CelebrityRecognitionSortBy) Values() []CelebrityRecognitionSortBy { return []CelebrityRecognitionSortBy{ @@ -93,8 +96,9 @@ const ( ) // Values returns all known values for ContentClassifier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentClassifier) Values() []ContentClassifier { return []ContentClassifier{ "FreeOfPersonallyIdentifiableInformation", @@ -112,8 +116,9 @@ const ( // Values returns all known values for ContentModerationAggregateBy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentModerationAggregateBy) Values() []ContentModerationAggregateBy { return []ContentModerationAggregateBy{ "TIMESTAMPS", @@ -130,8 +135,9 @@ const ( ) // Values returns all known values for ContentModerationSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentModerationSortBy) Values() []ContentModerationSortBy { return []ContentModerationSortBy{ "NAME", @@ -148,8 +154,9 @@ const ( ) // Values returns all known values for CustomizationFeature. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomizationFeature) Values() []CustomizationFeature { return []CustomizationFeature{ "CONTENT_MODERATION", @@ -171,8 +178,9 @@ const ( ) // Values returns all known values for DatasetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetStatus) Values() []DatasetStatus { return []DatasetStatus{ "CREATE_IN_PROGRESS", @@ -196,6 +204,7 @@ const ( // 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{ @@ -214,8 +223,9 @@ const ( ) // Values returns all known values for DatasetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatasetType) Values() []DatasetType { return []DatasetType{ "TRAIN", @@ -232,8 +242,9 @@ const ( ) // Values returns all known values for DetectLabelsFeatureName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetectLabelsFeatureName) Values() []DetectLabelsFeatureName { return []DetectLabelsFeatureName{ "GENERAL_LABELS", @@ -257,8 +268,9 @@ const ( ) // Values returns all known values for EmotionName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EmotionName) Values() []EmotionName { return []EmotionName{ "HAPPY", @@ -282,8 +294,9 @@ const ( ) // Values returns all known values for FaceAttributes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FaceAttributes) Values() []FaceAttributes { return []FaceAttributes{ "DEFAULT", @@ -300,8 +313,9 @@ const ( ) // Values returns all known values for FaceSearchSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FaceSearchSortBy) Values() []FaceSearchSortBy { return []FaceSearchSortBy{ "INDEX", @@ -318,8 +332,9 @@ const ( ) // Values returns all known values for GenderType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GenderType) Values() []GenderType { return []GenderType{ "Male", @@ -338,8 +353,9 @@ const ( ) // Values returns all known values for KnownGenderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnownGenderType) Values() []KnownGenderType { return []KnownGenderType{ "Male", @@ -359,6 +375,7 @@ const ( // Values returns all known values for LabelDetectionAggregateBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LabelDetectionAggregateBy) Values() []LabelDetectionAggregateBy { return []LabelDetectionAggregateBy{ @@ -376,6 +393,7 @@ const ( // Values returns all known values for LabelDetectionFeatureName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LabelDetectionFeatureName) Values() []LabelDetectionFeatureName { return []LabelDetectionFeatureName{ @@ -392,8 +410,9 @@ const ( ) // Values returns all known values for LabelDetectionSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LabelDetectionSortBy) Values() []LabelDetectionSortBy { return []LabelDetectionSortBy{ "NAME", @@ -438,8 +457,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -487,8 +507,9 @@ const ( ) // Values returns all known values for LivenessSessionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LivenessSessionStatus) Values() []LivenessSessionStatus { return []LivenessSessionStatus{ "CREATED", @@ -516,6 +537,7 @@ const ( // Values returns all known values for MediaAnalysisJobFailureCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MediaAnalysisJobFailureCode) Values() []MediaAnalysisJobFailureCode { return []MediaAnalysisJobFailureCode{ @@ -543,8 +565,9 @@ const ( ) // Values returns all known values for MediaAnalysisJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaAnalysisJobStatus) Values() []MediaAnalysisJobStatus { return []MediaAnalysisJobStatus{ "CREATED", @@ -566,8 +589,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ROTATE_0", @@ -586,8 +610,9 @@ const ( ) // Values returns all known values for PersonTrackingSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PersonTrackingSortBy) Values() []PersonTrackingSortBy { return []PersonTrackingSortBy{ "INDEX", @@ -604,8 +629,9 @@ const ( ) // Values returns all known values for ProjectAutoUpdate. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectAutoUpdate) Values() []ProjectAutoUpdate { return []ProjectAutoUpdate{ "ENABLED", @@ -623,8 +649,9 @@ const ( ) // Values returns all known values for ProjectStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectStatus) Values() []ProjectStatus { return []ProjectStatus{ "CREATING", @@ -654,8 +681,9 @@ const ( ) // Values returns all known values for ProjectVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectVersionStatus) Values() []ProjectVersionStatus { return []ProjectVersionStatus{ "TRAINING_IN_PROGRESS", @@ -685,8 +713,9 @@ const ( ) // Values returns all known values for ProtectiveEquipmentType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectiveEquipmentType) Values() []ProtectiveEquipmentType { return []ProtectiveEquipmentType{ "FACE_COVER", @@ -707,8 +736,9 @@ const ( ) // Values returns all known values for QualityFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QualityFilter) Values() []QualityFilter { return []QualityFilter{ "NONE", @@ -733,8 +763,9 @@ const ( ) // Values returns all known values for Reason. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Reason) Values() []Reason { return []Reason{ "EXCEEDS_MAX_FACES", @@ -756,8 +787,9 @@ const ( ) // Values returns all known values for SegmentType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SegmentType) Values() []SegmentType { return []SegmentType{ "TECHNICAL_CUE", @@ -775,8 +807,9 @@ const ( // Values returns all known values for StreamProcessorParameterToDelete. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamProcessorParameterToDelete) Values() []StreamProcessorParameterToDelete { return []StreamProcessorParameterToDelete{ "ConnectedHomeMinConfidence", @@ -797,8 +830,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "STOPPED", @@ -824,8 +858,9 @@ const ( ) // Values returns all known values for TechnicalCueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TechnicalCueType) Values() []TechnicalCueType { return []TechnicalCueType{ "ColorBars", @@ -847,8 +882,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -871,8 +907,9 @@ const ( ) // Values returns all known values for UnsearchedFaceReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnsearchedFaceReason) Values() []UnsearchedFaceReason { return []UnsearchedFaceReason{ "FACE_NOT_LARGEST", @@ -897,8 +934,9 @@ const ( // Values returns all known values for UnsuccessfulFaceAssociationReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnsuccessfulFaceAssociationReason) Values() []UnsuccessfulFaceAssociationReason { return []UnsuccessfulFaceAssociationReason{ "FACE_NOT_FOUND", @@ -917,8 +955,9 @@ const ( // Values returns all known values for UnsuccessfulFaceDeletionReason. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnsuccessfulFaceDeletionReason) Values() []UnsuccessfulFaceDeletionReason { return []UnsuccessfulFaceDeletionReason{ "ASSOCIATED_TO_AN_EXISTING_USER", @@ -936,8 +975,9 @@ const ( // Values returns all known values for UnsuccessfulFaceDisassociationReason. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnsuccessfulFaceDisassociationReason) Values() []UnsuccessfulFaceDisassociationReason { return []UnsuccessfulFaceDisassociationReason{ "FACE_NOT_FOUND", @@ -956,8 +996,9 @@ const ( ) // Values returns all known values for UserStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserStatus) Values() []UserStatus { return []UserStatus{ "ACTIVE", @@ -976,8 +1017,9 @@ const ( ) // Values returns all known values for VideoColorRange. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoColorRange) Values() []VideoColorRange { return []VideoColorRange{ "FULL", @@ -995,8 +1037,9 @@ const ( ) // Values returns all known values for VideoJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VideoJobStatus) Values() []VideoJobStatus { return []VideoJobStatus{ "IN_PROGRESS", diff --git a/service/rekognition/types/errors.go b/service/rekognition/types/errors.go index b4b9a4e8f05..f63551c88e1 100644 --- a/service/rekognition/types/errors.go +++ b/service/rekognition/types/errors.go @@ -36,7 +36,8 @@ func (e *AccessDeniedException) ErrorCode() string { } func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A User with the same Id already exists within the collection, or the update or +// A User with the same Id already exists within the collection, or the update or +// // deletion of the User caused an inconsistent state. ** type ConflictException struct { Message *string diff --git a/service/rekognition/types/types.go b/service/rekognition/types/types.go index 806742e62b5..43e53df606e 100644 --- a/service/rekognition/types/types.go +++ b/service/rekognition/types/types.go @@ -7,11 +7,12 @@ import ( "time" ) -// Structure containing the estimated age range, in years, for a face. Amazon -// Rekognition estimates an age range for faces detected in the input image. -// Estimated age ranges can overlap. A face of a 5-year-old might have an estimated -// range of 4-6, while the face of a 6-year-old might have an estimated range of -// 4-8. +// Structure containing the estimated age range, in years, for a face. +// +// Amazon Rekognition estimates an age range for faces detected in the input +// image. Estimated age ranges can overlap. A face of a 5-year-old might have an +// estimated range of 4-6, while the face of a 6-year-old might have an estimated +// range of 4-8. type AgeRange struct { // The highest estimated age. @@ -45,8 +46,7 @@ type AssociatedFace 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,29 +72,35 @@ type AuditImage struct { // 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. + // (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. BoundingBox *BoundingBox // The Base64-encoded bytes representing an image selected from the Face Liveness // video and returned for audit purposes. Bytes []byte - // Provides the S3 bucket name and object name. The region for the S3 bucket - // containing the S3 object must match the region you use for Amazon Rekognition - // operations. 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. + // Provides the S3 bucket name and object name. + // + // The region for the S3 bucket containing the S3 object must match the region you + // use for Amazon Rekognition operations. + // + // 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. S3Object *S3Object noSmithyDocumentSerde @@ -113,30 +119,35 @@ type Beard struct { noSmithyDocumentSerde } -// A filter that allows you to control the black frame detection by specifying the -// 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 . +// A filter that allows you to control the black frame detection by specifying +// +// the 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. type BlackFrame struct { - // A threshold used to determine the maximum luminance value for a pixel to be + // A threshold used to determine the maximum luminance value for a pixel to be // considered black. In a full color range video, luminance values range from // 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum // black pixel value is computed as follows: max_black_pixel_value = - // minimum_luminance + MaxPixelThreshold *luminance_range. For example, for a full - // range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * - // (255-0) = 25.5. The default value of MaxPixelThreshold is 0.2, which maps to a + // minimum_luminance + MaxPixelThreshold *luminance_range. + // + // For example, for a full range video with BlackPixelThreshold = 0.1, + // max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5. + // + // The default value of MaxPixelThreshold is 0.2, which maps to a // max_black_pixel_value of 51 for a full range video. You can lower this threshold // to be more strict on black levels. MaxPixelThreshold *float32 - // The minimum percentage of pixels in a frame that need to have a luminance below - // the max_black_pixel_value for a frame to be considered a black frame. Luminance - // is calculated using the BT.709 matrix. The default value is 99, which means at - // least 99% of all pixels in the frame are black pixels as per the - // MaxPixelThreshold set. You can reduce this value to allow more noise on the - // black frame. + // The minimum percentage of pixels in a frame that need to have a luminance + // below the max_black_pixel_value for a frame to be considered a black frame. + // Luminance is calculated using the BT.709 matrix. + // + // The default value is 99, which means at least 99% of all pixels in the frame + // are black pixels as per the MaxPixelThreshold set. You can reduce this value to + // allow more noise on the black frame. MinCoveragePercentage *float32 noSmithyDocumentSerde @@ -146,18 +157,21 @@ type BlackFrame struct { // 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. +// (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. @@ -175,8 +189,7 @@ type BoundingBox struct { noSmithyDocumentSerde } -// Provides information about a celebrity recognized by the RecognizeCelebrities -// operation. +// Provides information about a celebrity recognized by the RecognizeCelebrities operation. type Celebrity struct { // Provides information about the celebrity's face, such as its location on the @@ -258,7 +271,7 @@ type ComparedFace struct { // Level of confidence that what the bounding box contains is a face. Confidence *float32 - // The emotions that appear to be expressed on the face, and the confidence level + // The emotions that appear to be expressed on the face, and the confidence level // in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", // "Disgusted", "Surprised", "Calm", "Unknown", and "Fear". Emotions []Emotion @@ -272,7 +285,7 @@ type ComparedFace struct { // Identifies face image brightness and sharpness. Quality *ImageQuality - // Indicates whether or not the face is smiling, and the confidence level in the + // Indicates whether or not the face is smiling, and the confidence level in the // determination. Smile *Smile @@ -310,41 +323,43 @@ type CompareFacesMatch struct { noSmithyDocumentSerde } -// Label detection settings to use on a streaming video. Defining the settings is -// 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 -// started, one notification is sent for each object class specified. For example, -// if packages and pets are selected, one SNS notification is published the first -// time a package is detected and one SNS notification is published the first time -// a pet is detected, as well as an end-of-session summary. +// Label detection settings to use on a streaming video. Defining the settings is +// +// 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 started, one notification +// is sent for each object class specified. For example, if packages and pets are +// selected, one SNS notification is published the first time a package is detected +// and one SNS notification is published the first time a pet is detected, as well +// as an end-of-session summary. type ConnectedHomeSettings struct { - // Specifies what you want to detect in the video, such as people, packages, or + // Specifies what you want to detect in the video, such as people, packages, or // pets. The current valid labels you can include in this list are: "PERSON", // "PET", "PACKAGE", and "ALL". // // This member is required. Labels []string - // The minimum confidence required to label an object in the video. + // The minimum confidence required to label an object in the video. MinConfidence *float32 noSmithyDocumentSerde } -// The label detection settings you want to use in your stream processor. This +// The label detection settings you want to use in your stream processor. This +// // includes the labels you want the stream processor to detect and the minimum // confidence level allowed to label objects. type ConnectedHomeSettingsForUpdate struct { - // Specifies what you want to detect in the video, such as people, packages, or + // Specifies what you want to detect in the video, such as people, packages, or // pets. The current valid labels you can include in this list are: "PERSON", // "PET", "PACKAGE", and "ALL". Labels []string - // The minimum confidence required to label an object in the video. + // The minimum confidence required to label an object in the video. MinConfidence *float32 noSmithyDocumentSerde @@ -358,11 +373,11 @@ type ContentModerationDetection struct { // example, the image content might be from animation, sports, or a video game. ContentTypes []ContentType - // The time duration of a segment in milliseconds, I.e. time elapsed from + // The time duration of a segment in milliseconds, I.e. time elapsed from // StartTimestampMillis to EndTimestampMillis. DurationMillis *int64 - // The time in milliseconds defining the end of the timeline segment containing a + // The time in milliseconds defining the end of the timeline segment containing a // continuously detected moderation label. EndTimestampMillis *int64 @@ -395,7 +410,7 @@ type ContentType 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 . @@ -450,7 +465,7 @@ type CustomizationFeatureContentModerationConfig 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 @@ -468,7 +483,8 @@ type CustomLabel struct { noSmithyDocumentSerde } -// Describes updates or additions to a dataset. A Single update or addition is an +// Describes updates or additions to a dataset. A Single update or addition is an +// // entry (JSON Line) that provides information about a single image. To update an // existing entry, you match the source-ref field of the update entry with the // source-ref filed of the entry that you want to update. If the source-ref field @@ -477,11 +493,12 @@ 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 - // 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. + // 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. // // This member is required. GroundTruth []byte @@ -489,27 +506,28 @@ type DatasetChanges struct { noSmithyDocumentSerde } -// A description for a dataset. For more information, see DescribeDataset . The -// status fields Status , StatusMessage , and StatusMessageCode reflect the last -// operation on the dataset. +// 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 { - // The Unix timestamp for the time and date that the dataset was created. + // The Unix timestamp for the time and date that the dataset was created. CreationTimestamp *time.Time - // The status message code for the dataset. + // The status message code for the dataset. DatasetStats *DatasetStats - // The Unix timestamp for the date and time that the dataset was last updated. + // The Unix timestamp for the date and time that the dataset was last updated. LastUpdatedTimestamp *time.Time - // The status of the dataset. + // The status of the dataset. Status DatasetStatus - // The status message for the dataset. + // The status message for the dataset. StatusMessage *string - // The status message code for the dataset operation. If a service error occurs, + // The status message code for the dataset operation. If a service error occurs, // try the API call again later. If a client error occurs, check the input // parameters to the dataset API call that failed. StatusMessageCode DatasetStatusMessageCode @@ -517,51 +535,51 @@ 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. + // The name of the label. LabelName *string - // Statistics about the label. + // Statistics about the label. LabelStats *DatasetLabelStats noSmithyDocumentSerde } -// Statistics about a label used in a dataset. For more information, see -// DatasetLabelDescription . +// Statistics about a label used in a dataset. For more information, see DatasetLabelDescription. type DatasetLabelStats struct { - // The total number of images that have the label assigned to a bounding box. + // The total number of images that have the label assigned to a bounding box. BoundingBoxCount *int32 - // The total number of images that use the label. + // The total number of images that use the label. EntryCount *int32 noSmithyDocumentSerde } -// Summary information for an Amazon Rekognition Custom Labels dataset. For more -// information, see ProjectDescription . +// Summary information for an Amazon Rekognition Custom Labels dataset. For more +// +// information, see ProjectDescription. type DatasetMetadata struct { - // The Unix timestamp for the date and time that the dataset was created. + // The Unix timestamp for the date and time that the dataset was created. CreationTimestamp *time.Time - // The Amazon Resource Name (ARN) for the dataset. + // The Amazon Resource Name (ARN) for the dataset. DatasetArn *string - // The type of the dataset. + // The type of the dataset. DatasetType DatasetType - // The status for the dataset. + // The status for the dataset. Status DatasetStatus - // The status message for the dataset. + // The status message for the dataset. StatusMessage *string - // The status message code for the dataset operation. If a service error occurs, + // The status message code for the dataset operation. If a service error occurs, // try the API call again later. If a client error occurs, check the input // parameters to the dataset API call that failed. StatusMessageCode DatasetStatusMessageCode @@ -569,17 +587,21 @@ type DatasetMetadata struct { noSmithyDocumentSerde } -// The source that Amazon Rekognition Custom Labels uses to create a dataset. To +// The source that Amazon Rekognition Custom Labels uses to create a dataset. To +// // 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. + // The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy. DatasetArn *string // The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest @@ -589,19 +611,19 @@ 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. + // The total number of entries that contain at least one error. ErrorEntries *int32 - // The total number of images in the dataset that have labels. + // The total number of images in the dataset that have labels. LabeledEntries *int32 - // The total number of images in the dataset. + // The total number of images in the dataset. TotalEntries *int32 - // The total number of labels declared in the dataset. + // The total number of labels declared in the dataset. TotalLabels *int32 noSmithyDocumentSerde @@ -732,7 +754,7 @@ type DetectLabelsSettings struct { // of the image to look for text in. type DetectTextFilters struct { - // A Filter focusing on a certain area of the image. Uses a BoundingBox object to + // A Filter focusing on a certain area of the image. Uses a BoundingBox object to // set the region of the image. RegionsOfInterest []RegionOfInterest @@ -753,8 +775,9 @@ type DisassociatedFace struct { noSmithyDocumentSerde } -// A training dataset or a test dataset used in a dataset distribution operation. -// For more information, see DistributeDatasetEntries . +// A training dataset or a test dataset used in a dataset distribution operation. +// +// For more information, see DistributeDatasetEntries. type DistributeDataset struct { // The Amazon Resource Name (ARN) of the dataset that you want to use. @@ -808,8 +831,8 @@ type Emotion struct { noSmithyDocumentSerde } -// Information about an item of Personal Protective Equipment (PPE) detected by -// DetectProtectiveEquipment . For more information, see DetectProtectiveEquipment . +// Information about an item of Personal Protective Equipment (PPE) detected by DetectProtectiveEquipment. +// For more information, see DetectProtectiveEquipment. type EquipmentDetection struct { // A bounding box surrounding the item of detected PPE. @@ -905,7 +928,7 @@ 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 version of the face detect and storage model that was used when indexing // the face vector. IndexFacesModelVersion *string @@ -915,23 +938,27 @@ type Face struct { noSmithyDocumentSerde } -// Structure containing attributes of the face that the algorithm detected. A -// FaceDetail object contains either the default facial attributes or all facial +// 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: +// Pose , and Quality . +// +// GetFaceDetectionis 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 @@ -1041,9 +1068,10 @@ type FaceMatch struct { // masks, dark sunglasses, cell phones, hands, or other objects. FaceOccluded // should return "false" with a high confidence score if common occurrences that do // not impact face verification are detected, such as eye glasses, lightly tinted -// sunglasses, strands of hair, and others. You can use FaceOccluded to determine -// if an obstruction on a face negatively impacts using the image for face -// matching. +// sunglasses, strands of hair, and others. +// +// You can use FaceOccluded to determine if an obstruction on a face negatively +// impacts using the image for face matching. type FaceOccluded struct { // The confidence that the service has detected the presence of a face occlusion. @@ -1075,8 +1103,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 . +// detect. Defining the settings is required in the request parameter for CreateStreamProcessor. type FaceSearchSettings struct { // The ID of a collection that contains faces that you want to search for. @@ -1091,18 +1118,21 @@ type FaceSearchSettings struct { noSmithyDocumentSerde } -// The predicted gender of a detected face. Amazon Rekognition makes gender binary -// (male/female) predictions based on the physical appearance of a face in a -// particular image. This kind of prediction is not designed to categorize a -// person’s gender identity, and you shouldn't use Amazon Rekognition to make such -// a determination. For example, a male actor wearing a long-haired wig and -// earrings for a role might be predicted as female. Using Amazon Rekognition to -// make gender binary predictions is best suited for use cases where aggregate -// gender distribution statistics need to be analyzed without identifying specific -// users. For example, the percentage of female users compared to male users on a -// social media platform. We don't recommend using gender binary predictions to -// make decisions that impact an individual's rights, privacy, or access to -// services. +// The predicted gender of a detected face. +// +// Amazon Rekognition makes gender binary (male/female) predictions based on the +// physical appearance of a face in a particular image. This kind of prediction is +// not designed to categorize a person’s gender identity, and you shouldn't use +// Amazon Rekognition to make such a determination. For example, a male actor +// wearing a long-haired wig and earrings for a role might be predicted as female. +// +// Using Amazon Rekognition to make gender binary predictions is best suited for +// use cases where aggregate gender distribution statistics need to be analyzed +// without identifying specific users. For example, the percentage of female users +// compared to male users on a social media platform. +// +// We don't recommend using gender binary predictions to make decisions that +// impact an individual's rights, privacy, or access to services. type Gender struct { // Level of confidence in the prediction. @@ -1116,9 +1146,9 @@ type Gender struct { // Contains filters for the object labels returned by DetectLabels. Filters can be // inclusive, exclusive, or a combination of both and can be applied to individual -// labels or entire label categories. To see a list of label categories, see -// Detecting Labels (https://docs.aws.amazon.com/rekognition/latest/dg/labels.html) -// . +// labels or entire label categories. To see a list of label categories, see [Detecting Labels]. +// +// [Detecting Labels]: https://docs.aws.amazon.com/rekognition/latest/dg/labels.html type GeneralLabelsSettings struct { // The label categories that should be excluded from the return from DetectLabels. @@ -1136,8 +1166,7 @@ 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 @@ -1180,11 +1209,14 @@ type GetLabelDetectionRequestMetadata struct { // file. type GroundTruthManifest struct { - // Provides the S3 bucket name and object name. The region for the S3 bucket - // containing the S3 object must match the region you use for Amazon Rekognition - // operations. 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. + // Provides the S3 bucket name and object name. + // + // The region for the S3 bucket containing the S3 object must match the region you + // use for Amazon Rekognition operations. + // + // 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. S3Object *S3Object noSmithyDocumentSerde @@ -1214,8 +1246,9 @@ 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) - // Operation. + // definition by using the Amazon Sagemaker [CreateFlowDefinition]Operation. + // + // [CreateFlowDefinition]: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html // // This member is required. FlowDefinitionArn *string @@ -1242,22 +1275,30 @@ type HumanLoopDataAttributes struct { noSmithyDocumentSerde } -// 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 +// 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. type Image struct { @@ -1285,8 +1326,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. @@ -1327,16 +1368,17 @@ 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]. +// +// [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 - // on the ingestion order. + // The unique identifier of the fragment. This value monotonically increases + // based on the ingestion order. FragmentNumber *string - // The timestamp from the producer corresponding to the fragment, in milliseconds, - // expressed in unix time format. + // The timestamp from the producer corresponding to the fragment, in + // milliseconds, expressed in unix time format. ProducerTimestamp *int64 noSmithyDocumentSerde @@ -1430,9 +1472,9 @@ type LabelDetectionSettings struct { // Contains filters for the object labels returned by DetectLabels. Filters can be // inclusive, exclusive, or a combination of both and can be applied to individual - // labels or entire label categories. To see a list of label categories, see - // Detecting Labels (https://docs.aws.amazon.com/rekognition/latest/dg/labels.html) - // . + // labels or entire label categories. To see a list of label categories, see [Detecting Labels]. + // + // [Detecting Labels]: https://docs.aws.amazon.com/rekognition/latest/dg/labels.html GeneralLabels *GeneralLabelsSettings noSmithyDocumentSerde @@ -1507,11 +1549,14 @@ type MediaAnalysisDetectModerationLabelsConfig struct { // Contains input information for a media analysis job. type MediaAnalysisInput struct { - // Provides the S3 bucket name and object name. The region for the S3 bucket - // containing the S3 object must match the region you use for Amazon Rekognition - // operations. 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. + // Provides the S3 bucket name and object name. + // + // The region for the S3 bucket containing the S3 object must match the region you + // use for Amazon Rekognition operations. + // + // 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. S3Object *S3Object @@ -1590,11 +1635,14 @@ type MediaAnalysisJobFailureDetails struct { // input manifest. type MediaAnalysisManifestSummary struct { - // Provides the S3 bucket name and object name. The region for the S3 bucket - // containing the S3 object must match the region you use for Amazon Rekognition - // operations. 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. + // Provides the S3 bucket name and object name. + // + // The region for the S3 bucket containing the S3 object must match the region you + // use for Amazon Rekognition operations. + // + // 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. S3Object *S3Object noSmithyDocumentSerde @@ -1642,11 +1690,14 @@ type MediaAnalysisResults struct { // Information about the model versions for the features selected in a given job. ModelVersions *MediaAnalysisModelVersions - // Provides the S3 bucket name and object name. The region for the S3 bucket - // containing the S3 object must match the region you use for Amazon Rekognition - // operations. 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. + // Provides the S3 bucket name and object name. + // + // The region for the S3 bucket containing the S3 object must match the region you + // use for Amazon Rekognition operations. + // + // 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. S3Object *S3Object noSmithyDocumentSerde @@ -1659,9 +1710,11 @@ type MediaAnalysisResults struct { 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 - // value greater than or equal to 50 percent. + // correctly identified. + // + // If you don't specify the MinConfidence parameter in the 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. @@ -1705,12 +1758,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]. 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]. +// +// [Calling Amazon Rekognition Video operations]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html +// [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 @@ -1768,8 +1821,10 @@ type PersonDetail struct { // Details and path tracking information for a single time a person's path is // tracked in a video. Amazon Rekognition operations that track people's paths // return an array of PersonDetection objects with elements for each time a -// person's path is tracked in a video. For more information, see GetPersonTracking -// in the Amazon Rekognition Developer Guide. +// person's path is tracked in a video. +// +// For more information, see GetPersonTracking in the Amazon Rekognition Developer +// Guide. type PersonDetection struct { // Details about a person whose path was tracked in a video. @@ -1785,9 +1840,9 @@ type PersonDetection struct { // 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 . +// 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 @@ -1807,8 +1862,9 @@ type PersonMatch struct { // The X and Y coordinates of a point on an image or video frame. The X and Y // 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 DetectCustomLabels +// 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 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 { @@ -1838,7 +1894,7 @@ type Pose struct { } // A description of an Amazon Rekognition Custom Labels project. For more -// information, see DescribeProjects . +// information, see DescribeProjects. type ProjectDescription struct { // Indicates whether automatic retraining will be attempted for the versions of @@ -1848,7 +1904,7 @@ type ProjectDescription struct { // The Unix timestamp for the date and time that the project was created. CreationTimestamp *time.Time - // Information about the training and test datasets in the project. + // Information about the training and test datasets in the project. Datasets []DatasetMetadata // Specifies the project that is being customized. @@ -1863,7 +1919,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. @@ -1921,12 +1977,11 @@ type ProjectVersionDescription struct { ManifestSummary *GroundTruthManifest // The maximum number of inference units Amazon Rekognition uses to auto-scale the - // model. Applies only to Custom Labels projects. For more information, see - // StartProjectVersion . + // model. Applies only to Custom Labels projects. For more information, see StartProjectVersion. MaxInferenceUnits *int32 // The minimum number of inference units used by the model. Applies only to Custom - // Labels projects. For more information, see StartProjectVersion . + // Labels projects. For more information, see StartProjectVersion. MinInferenceUnits *int32 // The location where training results are saved. @@ -1960,9 +2015,9 @@ type ProjectVersionDescription struct { noSmithyDocumentSerde } -// Information about a body part detected by DetectProtectiveEquipment that -// contains PPE. An array of ProtectiveEquipmentBodyPart objects is returned for -// each person detected by DetectProtectiveEquipment . +// Information about a body part detected by DetectProtectiveEquipment that contains PPE. An array of +// ProtectiveEquipmentBodyPart objects is returned for each person detected by +// DetectProtectiveEquipment . type ProtectiveEquipmentBodyPart struct { // The confidence that Amazon Rekognition has in the detection accuracy of the @@ -1978,9 +2033,8 @@ type ProtectiveEquipmentBodyPart struct { noSmithyDocumentSerde } -// A person detected by a call to DetectProtectiveEquipment . The API returns all -// persons detected in the input image in an array of ProtectiveEquipmentPerson -// objects. +// 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 @@ -2001,22 +2055,22 @@ type ProtectiveEquipmentPerson struct { 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 -// 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 . +// 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. type ProtectiveEquipmentSummarizationAttributes struct { // The minimum confidence level for which you want summary information. The // confidence level applies to person detection, body part detection, equipment // detection, and body part coverage. Amazon Rekognition doesn't return summary // information with a confidence than this specified value. There isn't a default - // value. Specify a MinConfidence value that is between 50-100% as + // value. + // + // Specify a MinConfidence value that is between 50-100% as // DetectProtectiveEquipment returns predictions only where the detection // confidence is between 50% - 100%. If you specify a value that is less than 50%, // the results are the same specifying a value of 50%. @@ -2027,7 +2081,7 @@ 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 . + // in ProtectiveEquipmentSummaryby DetectProtectiveEquipment . // // This member is required. RequiredEquipmentTypes []ProtectiveEquipmentType @@ -2036,20 +2090,19 @@ 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 -// 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 -// 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 -// ProtectiveEquipmentPerson object returned in the Persons array by -// DetectProtectiveEquipment . +// 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 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 ProtectiveEquipmentPerson +// object returned in the Persons array by DetectProtectiveEquipment . type ProtectiveEquipmentSummary struct { // An array of IDs for persons where it was not possible to determine if they are @@ -2070,46 +2123,53 @@ 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, -// 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. +// 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 { // The box representing a region of interest on screen. BoundingBox *BoundingBox - // Specifies a shape made up of up to 10 Point objects to define a region of + // Specifies a shape made up of up to 10 Point objects to define a region of // interest. Polygon []Point noSmithyDocumentSerde } -// The Amazon S3 bucket location to which Amazon Rekognition publishes the +// 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. + // 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]. + // + // [Using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html KeyPrefix *string noSmithyDocumentSerde } -// Provides the S3 bucket name and object name. The region for the S3 bucket -// containing the S3 object must match the region you use for Amazon Rekognition -// operations. 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. +// Provides the S3 bucket name and object name. +// +// The region for the S3 bucket containing the S3 object must match the region you +// use for Amazon Rekognition operations. +// +// 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 S3Object struct { // Name of the S3 bucket. @@ -2128,7 +2188,7 @@ type S3Object struct { // face used for search. type SearchedFace struct { - // Unique identifier assigned to the face. + // Unique identifier assigned to the face. FaceId *string noSmithyDocumentSerde @@ -2137,22 +2197,27 @@ type SearchedFace struct { // Contains data regarding the input face used for a search. type SearchedFaceDetails struct { - // Structure containing attributes of the face that the algorithm detected. A - // FaceDetail object contains either the default facial attributes or all facial + // 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: + // Pose , and Quality . + // + // GetFaceDetectionis 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. FaceDetail *FaceDetail noSmithyDocumentSerde @@ -2161,7 +2226,7 @@ type SearchedFaceDetails struct { // Contains metadata about a User searched for within a collection. type SearchedUser struct { - // A provided ID for the UserID. Unique within the collection. + // A provided ID for the UserID. Unique within the collection. UserId *string noSmithyDocumentSerde @@ -2169,10 +2234,10 @@ type SearchedUser 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. + // The duration of a video segment, expressed in frames. DurationFrames *int64 // The duration of the detected segment in milliseconds. @@ -2181,8 +2246,8 @@ type SegmentDetection struct { // The duration of the timecode for the detected segment in SMPTE format. DurationSMPTE *string - // The frame number at the end of a video segment, using a frame index that starts - // with 0. + // The frame number at the end of a video segment, using a frame index that + // starts with 0. EndFrameNumber *int64 // The frame-accurate SMPTE timecode, from the start of a video, for the end of a @@ -2198,7 +2263,7 @@ type SegmentDetection struct { // detection. ShotSegment *ShotSegment - // The frame number of the start of a video segment, using a frame index that + // The frame number of the start of a video segment, using a frame index that // starts with 0. StartFrameNumber *int64 @@ -2221,9 +2286,8 @@ type SegmentDetection struct { 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 . +// 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. type SegmentTypeInfo struct { // The version of the model used to detect segments. @@ -2236,7 +2300,7 @@ 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 @@ -2263,7 +2327,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. @@ -2276,28 +2340,28 @@ type StartSegmentDetectionFilters struct { } // Filters for the shot detection segments returned by GetSegmentDetection . For -// more information, see StartSegmentDetectionFilters . +// more information, see StartSegmentDetectionFilters. type StartShotDetectionFilter struct { // Specifies the minimum confidence that Amazon Rekognition Video must have in // order to return a detected segment. Confidence represents how certain Amazon // 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 + // 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. 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 - // black levels and pixel coverage of black pixels in a frame. Videos can come from - // multiple sources, formats, and time periods, with different standards and + // A filter that allows you to control the black frame detection by specifying + // the black levels and pixel coverage of black pixels in a frame. Videos can come + // from multiple sources, formats, and time periods, with different standards and // varying noise levels for black frames that need to be accounted for. BlackFrame *BlackFrame @@ -2305,9 +2369,10 @@ type StartTechnicalCueDetectionFilter struct { // order to return a detected segment. Confidence represents how certain Amazon // 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 - // with confidence values greater than or equal to 50 percent. + // return any segments with a confidence level lower than this specified value. + // + // If you don't specify MinSegmentConfidence , GetSegmentDetection returns + // segments with confidence values greater than or equal to 50 percent. MinSegmentConfidence *float32 noSmithyDocumentSerde @@ -2333,18 +2398,19 @@ 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 + // 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 } -// Specifies when to stop processing the stream. You can specify a maximum amount +// Specifies when to stop processing the stream. You can specify a maximum amount +// // of time to process the video. type StreamProcessingStopSelector struct { - // Specifies the maximum amount of time in seconds that you want the stream to be + // Specifies the maximum amount of time in seconds that you want the stream to be // processed. The largest amount of time is 2 minutes. The default is 10 seconds. MaxDurationInSeconds *int64 @@ -2352,10 +2418,10 @@ 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 -// request parameters for CreateStreamProcessor describe the Kinesis video stream -// source for the streaming video, face recognition parameters, and where to stream -// the analysis resullts. +// 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. type StreamProcessor struct { // Name of the Amazon Rekognition stream processor. @@ -2367,13 +2433,14 @@ type StreamProcessor struct { noSmithyDocumentSerde } -// Allows you to opt in or opt out to share data with Rekognition to improve model -// performance. You can choose this option at the account level or on a per-stream -// basis. Note that if you opt out at the account level this setting is ignored on -// individual streams. +// Allows you to opt in or opt out to share data with Rekognition to improve +// +// model performance. You can choose this option at the account level or on a +// per-stream basis. Note that if you opt out at the account level this setting is +// ignored on individual streams. type StreamProcessorDataSharingPreference struct { - // If this option is set to true, you choose to share data with Rekognition to + // If this option is set to true, you choose to share data with Rekognition to // improve model performance. // // This member is required. @@ -2393,16 +2460,19 @@ type StreamProcessorInput struct { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the object detection results and completion status of a video analysis -// operation. Amazon Rekognition publishes a notification the first time an object -// of interest or a person is detected in the video stream. For example, if Amazon +// operation. +// +// Amazon Rekognition publishes a notification the first time an object of +// interest or a person is detected in the video stream. For example, if Amazon // Rekognition detects a person at second 2, a pet at second 4, and a person again // at second 5, Amazon Rekognition sends 2 object class detected notifications, one -// for a person at second 2 and one for a pet at second 4. Amazon Rekognition also -// publishes an an end-of-session notification with a summary when the stream -// processing session is complete. +// for a person at second 2 and one for a pet at second 4. +// +// Amazon Rekognition also publishes an an end-of-session notification with a +// summary when the stream processing session is complete. type StreamProcessorNotificationChannel struct { - // The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification + // The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification // Service topic to which Amazon Rekognition posts the completion status. // // This member is required. @@ -2421,7 +2491,7 @@ type StreamProcessorOutput struct { // processor streams the analysis results. KinesisDataStream *KinesisDataStream - // The Amazon S3 bucket location to which Amazon Rekognition publishes the + // The Amazon S3 bucket location to which Amazon Rekognition publishes the // detailed inference results of a video analysis operation. S3Destination *S3Destination @@ -2433,15 +2503,15 @@ type StreamProcessorOutput struct { // video, or you can use ConnectedHome to detect labels. 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 - // 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 - // started, one notification is sent for each object class specified. For example, - // if packages and pets are selected, one SNS notification is published the first - // time a package is detected and one SNS notification is published the first time - // a pet is detected, as well as an end-of-session summary. + // Label detection settings to use on a streaming video. Defining the settings is + // 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 started, one notification + // is sent for each object class specified. For example, if packages and pets are + // selected, one SNS notification is published the first time a package is detected + // and one SNS notification is published the first time a pet is detected, as well + // as an end-of-session summary. ConnectedHome *ConnectedHomeSettings // Face search settings to use on a streaming video. @@ -2450,11 +2520,12 @@ type StreamProcessorSettings struct { noSmithyDocumentSerde } -// The stream processor settings that you want to update. ConnectedHome settings +// The stream processor settings that you want to update. ConnectedHome settings +// // can be updated to detect different labels with a different minimum confidence. type StreamProcessorSettingsForUpdate struct { - // The label detection settings you want to use for your stream processor. + // The label detection settings you want to use for your stream processor. ConnectedHomeForUpdate *ConnectedHomeSettingsForUpdate noSmithyDocumentSerde @@ -2462,15 +2533,19 @@ 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 . +// each individual label. +// +// You get the training summary S3 bucket location by calling DescribeProjectVersions. type Summary struct { - // Provides the S3 bucket name and object name. The region for the S3 bucket - // containing the S3 object must match the region you use for Amazon Rekognition - // operations. 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. + // Provides the S3 bucket name and object name. + // + // The region for the S3 bucket containing the S3 object must match the region you + // use for Amazon Rekognition operations. + // + // 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. S3Object *S3Object noSmithyDocumentSerde @@ -2489,8 +2564,7 @@ type Sunglasses struct { noSmithyDocumentSerde } -// Information about a technical cue segment. For more information, see -// SegmentDetection . +// Information about a technical cue segment. For more information, see SegmentDetection. type TechnicalCueSegment struct { // The confidence that Amazon Rekognition Video has in the accuracy of the @@ -2536,13 +2610,18 @@ type TestingDataResult struct { noSmithyDocumentSerde } -// 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 -// Developer Guide. +// 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 Developer +// Guide. type TextDetection struct { // The confidence that Amazon Rekognition has in the accuracy of the detected text @@ -2615,8 +2694,8 @@ type TrainingDataResult struct { noSmithyDocumentSerde } -// A face that IndexFaces detected, but didn't index. Use the Reasons response -// attribute to determine why a face wasn't indexed. +// A face that IndexFaces detected, but didn't index. Use the Reasons response attribute to +// determine why a face wasn't indexed. type UnindexedFace struct { // The structure that contains attributes of a face that IndexFaces detected, but @@ -2624,13 +2703,19 @@ type UnindexedFace struct { 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. Reasons []Reason @@ -2641,25 +2726,30 @@ type UnindexedFace struct { // attribute contains reasons for why a face wasn't used for Search. type UnsearchedFace struct { - // Structure containing attributes of the face that the algorithm detected. A - // FaceDetail object contains either the default facial attributes or all facial + // 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: + // Pose , and Quality . + // + // GetFaceDetectionis 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. FaceDetails *FaceDetail - // Reasons why a face wasn't used for Search. + // Reasons why a face wasn't used for Search. Reasons []UnsearchedFaceReason noSmithyDocumentSerde @@ -2676,7 +2766,7 @@ type UnsuccessfulFaceAssociation struct { // A unique identifier assigned to the face. FaceId *string - // The reason why the association was unsuccessful. + // The reason why the association was unsuccessful. Reasons []UnsuccessfulFaceAssociationReason // A provided ID for the UserID. Unique within the collection. @@ -2689,13 +2779,13 @@ type UnsuccessfulFaceAssociation struct { // unsuccessfully deleted. type UnsuccessfulFaceDeletion struct { - // A unique identifier assigned to the face. + // A unique identifier assigned to the face. FaceId *string // The reason why the deletion was unsuccessful. Reasons []UnsuccessfulFaceDeletionReason - // A provided ID for the UserID. Unique within the collection. + // A provided ID for the UserID. Unique within the collection. UserId *string noSmithyDocumentSerde @@ -2720,10 +2810,10 @@ type UnsuccessfulFaceDisassociation struct { // Metadata of the user stored in a collection. type User struct { - // A provided ID for the User. Unique within the collection. + // A provided ID for the User. Unique within the collection. UserId *string - // Communicates if the UserID has been updated with latest set of faces to be + // Communicates if the UserID has been updated with latest set of faces to be // associated with the UserID. UserStatus UserStatus @@ -2734,23 +2824,27 @@ type User struct { // with the input face. type UserMatch struct { - // Describes the UserID metadata. + // Describes the UserID metadata. Similarity *float32 - // Confidence in the match of this UserID with the input face. + // Confidence in the match of this UserID with the input face. User *MatchedUser noSmithyDocumentSerde } // Contains the Amazon S3 bucket location of the validation data for a model -// 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. +// 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. type ValidationData struct { // The assets that comprise the validation data. @@ -2760,8 +2854,8 @@ type ValidationData struct { } // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start -// operations such as StartLabelDetection use Video to specify a video for -// analysis. The supported file formats are .mp4, .mov and .avi. +// operations such as StartLabelDetectionuse Video to specify a video for analysis. The supported +// file formats are .mp4, .mov and .avi. type Video struct { // The Amazon S3 bucket name and file name for the video. @@ -2778,7 +2872,7 @@ 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 + // A description of the range of luminance values in a video, either LIMITED (16 // to 235) or FULL (0 to 255). ColorRange VideoColorRange diff --git a/service/repostspace/options.go b/service/repostspace/options.go index 0370fd9d196..ab862eae22d 100644 --- a/service/repostspace/options.go +++ b/service/repostspace/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/repostspace/types/enums.go b/service/repostspace/types/enums.go index c8bf2ba0784..db4ef5558da 100644 --- a/service/repostspace/types/enums.go +++ b/service/repostspace/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ConfigurationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationStatus) Values() []ConfigurationStatus { return []ConfigurationStatus{ "CONFIGURED", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for TierLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TierLevel) Values() []TierLevel { return []TierLevel{ "BASIC", @@ -50,6 +52,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for VanityDomainStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VanityDomainStatus) Values() []VanityDomainStatus { return []VanityDomainStatus{ "PENDING", diff --git a/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go b/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go index b323db3a8df..c4bbec1cc55 100644 --- a/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go +++ b/service/resiliencehub/api_op_AddDraftAppVersionResourceMappings.go @@ -15,8 +15,9 @@ import ( // assessment, Resilience Hub will use these resource-maps to resolve the latest // physical ID for each resource in the application template. For more information // about different types of resources suported by Resilience Hub and how to add -// them in your application, see Step 2: How is your application managed? (https://docs.aws.amazon.com/resilience-hub/latest/userguide/how-app-manage.html) -// in the Resilience Hub User Guide. +// them in your application, see [Step 2: How is your application managed?]in the Resilience Hub User Guide. +// +// [Step 2: How is your application managed?]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/how-app-manage.html func (c *Client) AddDraftAppVersionResourceMappings(ctx context.Context, params *AddDraftAppVersionResourceMappingsInput, optFns ...func(*Options)) (*AddDraftAppVersionResourceMappingsOutput, error) { if params == nil { params = &AddDraftAppVersionResourceMappingsInput{} @@ -36,8 +37,10 @@ type AddDraftAppVersionResourceMappingsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -58,8 +61,10 @@ type AddDraftAppVersionResourceMappingsOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_BatchUpdateRecommendationStatus.go b/service/resiliencehub/api_op_BatchUpdateRecommendationStatus.go index e2d93390c51..70e16e6edf8 100644 --- a/service/resiliencehub/api_op_BatchUpdateRecommendationStatus.go +++ b/service/resiliencehub/api_op_BatchUpdateRecommendationStatus.go @@ -31,8 +31,10 @@ type BatchUpdateRecommendationStatusInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -50,8 +52,10 @@ type BatchUpdateRecommendationStatusOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_CreateApp.go b/service/resiliencehub/api_op_CreateApp.go index d1156dabc28..205e6373d81 100644 --- a/service/resiliencehub/api_op_CreateApp.go +++ b/service/resiliencehub/api_op_CreateApp.go @@ -19,12 +19,15 @@ import ( // applications, and an appropriate resiliency policy. In addition, you can also // add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) // clusters as optional resources. For more information about the number of -// resources supported per application, see Service quotas (https://docs.aws.amazon.com/general/latest/gr/resiliencehub.html#limits_resiliencehub) -// . After you create an Resilience Hub application, you publish it so that you can +// resources supported per application, see [Service quotas]. +// +// After you create an Resilience Hub application, you publish it so that you can // run a resiliency assessment on it. You can then use recommendations from the // assessment to improve resiliency by running another assessment, comparing // results, and then iterating the process until you achieve your goals for // recovery time objective (RTO) and recovery point objective (RPO). +// +// [Service quotas]: https://docs.aws.amazon.com/general/latest/gr/resiliencehub.html#limits_resiliencehub func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error) { if params == nil { params = &CreateAppInput{} @@ -47,7 +50,7 @@ type CreateAppInput struct { // This member is required. Name *string - // Assessment execution schedule with 'Daily' or 'Disabled' values. + // Assessment execution schedule with 'Daily' or 'Disabled' values. AssessmentSchedule types.AppAssessmentScheduleType // Used for an idempotency token. A client token is a unique, case-sensitive @@ -69,8 +72,10 @@ type CreateAppInput struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string // Tags assigned to the resource. A tag is a label that you assign to an Amazon diff --git a/service/resiliencehub/api_op_CreateAppVersionAppComponent.go b/service/resiliencehub/api_op_CreateAppVersionAppComponent.go index 39794de0a2d..dc24eefc1f6 100644 --- a/service/resiliencehub/api_op_CreateAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_CreateAppVersionAppComponent.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Application Component in 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. +// Creates a new Application Component in 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. func (c *Client) CreateAppVersionAppComponent(ctx context.Context, params *CreateAppVersionAppComponentInput, optFns ...func(*Options)) (*CreateAppVersionAppComponentOutput, error) { if params == nil { params = &CreateAppVersionAppComponentInput{} @@ -34,8 +35,10 @@ type CreateAppVersionAppComponentInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -46,8 +49,9 @@ type CreateAppVersionAppComponentInput struct { Name *string // 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]. + // + // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html // // This member is required. Type *string @@ -71,8 +75,10 @@ type CreateAppVersionAppComponentOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_CreateAppVersionResource.go b/service/resiliencehub/api_op_CreateAppVersionResource.go index a64387ac064..ff1cf120066 100644 --- a/service/resiliencehub/api_op_CreateAppVersionResource.go +++ b/service/resiliencehub/api_op_CreateAppVersionResource.go @@ -14,10 +14,13 @@ 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. func (c *Client) CreateAppVersionResource(ctx context.Context, params *CreateAppVersionResourceInput, optFns ...func(*Options)) (*CreateAppVersionResourceOutput, error) { @@ -39,8 +42,10 @@ type CreateAppVersionResourceInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -90,8 +95,10 @@ type CreateAppVersionResourceOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_CreateRecommendationTemplate.go b/service/resiliencehub/api_op_CreateRecommendationTemplate.go index cada677b8be..403d8b73a8d 100644 --- a/service/resiliencehub/api_op_CreateRecommendationTemplate.go +++ b/service/resiliencehub/api_op_CreateRecommendationTemplate.go @@ -31,8 +31,9 @@ type CreateRecommendationTemplateInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string @@ -50,16 +51,23 @@ type CreateRecommendationTemplateInput struct { // for other API requests. ClientToken *string - // The format for the recommendation template. CfnJson The template is - // CloudFormation JSON. CfnYaml The template is CloudFormation YAML. + // The format for the recommendation template. + // + // CfnJson The template is CloudFormation JSON. + // + // CfnYaml The template is CloudFormation YAML. Format types.TemplateFormat // Identifiers for the recommendations used to create a recommendation template. RecommendationIds []string // An array of strings that specify the recommendation template type or types. - // Alarm The template is an AlarmRecommendation template. Sop The template is a - // SopRecommendation template. Test The template is a TestRecommendation template. + // + // Alarm The template is an AlarmRecommendation template. + // + // Sop The template is a SopRecommendation template. + // + // Test The template is a TestRecommendation template. RecommendationTypes []types.RenderRecommendationType // Tags assigned to the resource. A tag is a label that you assign to an Amazon diff --git a/service/resiliencehub/api_op_CreateResiliencyPolicy.go b/service/resiliencehub/api_op_CreateResiliencyPolicy.go index 9fbd38ea2bb..aca7ef99e10 100644 --- a/service/resiliencehub/api_op_CreateResiliencyPolicy.go +++ b/service/resiliencehub/api_op_CreateResiliencyPolicy.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a resiliency policy for an application. Resilience Hub allows you to -// provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. -// But, while assessing your application, the lowest possible assessment result is -// near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs , the -// estimated workload RTO and estimated workload RPO result will be near zero and -// the Compliance status for your application will be set to Policy breached. +// Creates a resiliency policy for an application. +// +// Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs +// of your resiliency policy. But, while assessing your application, the lowest +// possible assessment result is near zero. Hence, if you provide value zero for +// rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO +// result will be near zero and the Compliance status for your application will be +// set to Policy breached. func (c *Client) CreateResiliencyPolicy(ctx context.Context, params *CreateResiliencyPolicyInput, optFns ...func(*Options)) (*CreateResiliencyPolicyOutput, error) { if params == nil { params = &CreateResiliencyPolicyInput{} diff --git a/service/resiliencehub/api_op_DeleteApp.go b/service/resiliencehub/api_op_DeleteApp.go index cdab750526b..6256e7fedb5 100644 --- a/service/resiliencehub/api_op_DeleteApp.go +++ b/service/resiliencehub/api_op_DeleteApp.go @@ -31,8 +31,10 @@ type DeleteAppInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -52,8 +54,10 @@ type DeleteAppOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DeleteAppAssessment.go b/service/resiliencehub/api_op_DeleteAppAssessment.go index 87e117d41cc..f0a26698447 100644 --- a/service/resiliencehub/api_op_DeleteAppAssessment.go +++ b/service/resiliencehub/api_op_DeleteAppAssessment.go @@ -32,8 +32,9 @@ type DeleteAppAssessmentInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string @@ -50,8 +51,9 @@ type DeleteAppAssessmentOutput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_DeleteAppInputSource.go b/service/resiliencehub/api_op_DeleteAppInputSource.go index dda1ef77e7a..e815c6dfac3 100644 --- a/service/resiliencehub/api_op_DeleteAppInputSource.go +++ b/service/resiliencehub/api_op_DeleteAppInputSource.go @@ -32,8 +32,10 @@ type DeleteAppInputSourceInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -48,9 +50,10 @@ type DeleteAppInputSourceInput struct { 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 Amazon Web Services General Reference guide. + // the Resilience Hub application. For more information about ARNs, see [Amazon Resource Names (ARNs)]in the + // Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html SourceArn *string // The imported Terraform s3 state file you want to remove from the Resilience Hub @@ -64,8 +67,10 @@ type DeleteAppInputSourceOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Name of the input source from where the application resource is imported from. diff --git a/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go b/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go index 89e501cf635..f20a25bbef0 100644 --- a/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_DeleteAppVersionAppComponent.go @@ -12,9 +12,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. func (c *Client) DeleteAppVersionAppComponent(ctx context.Context, params *DeleteAppVersionAppComponentInput, optFns ...func(*Options)) (*DeleteAppVersionAppComponentOutput, error) { @@ -36,8 +38,10 @@ type DeleteAppVersionAppComponentInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -59,8 +63,10 @@ type DeleteAppVersionAppComponentOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DeleteAppVersionResource.go b/service/resiliencehub/api_op_DeleteAppVersionResource.go index 7a06dbaf04a..5e5e7bb3fe1 100644 --- a/service/resiliencehub/api_op_DeleteAppVersionResource.go +++ b/service/resiliencehub/api_op_DeleteAppVersionResource.go @@ -12,9 +12,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. @@ -37,8 +40,10 @@ type DeleteAppVersionResourceInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -70,8 +75,10 @@ type DeleteAppVersionResourceOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DeleteResiliencyPolicy.go b/service/resiliencehub/api_op_DeleteResiliencyPolicy.go index 629a301ca1e..2027e813732 100644 --- a/service/resiliencehub/api_op_DeleteResiliencyPolicy.go +++ b/service/resiliencehub/api_op_DeleteResiliencyPolicy.go @@ -30,8 +30,10 @@ type DeleteResiliencyPolicyInput struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string @@ -48,8 +50,10 @@ type DeleteResiliencyPolicyOutput struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string diff --git a/service/resiliencehub/api_op_DescribeApp.go b/service/resiliencehub/api_op_DescribeApp.go index 374db0a539b..f2a7a39ba4b 100644 --- a/service/resiliencehub/api_op_DescribeApp.go +++ b/service/resiliencehub/api_op_DescribeApp.go @@ -31,8 +31,10 @@ type DescribeAppInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppAssessment.go b/service/resiliencehub/api_op_DescribeAppAssessment.go index c956ee89f54..760f0f0f554 100644 --- a/service/resiliencehub/api_op_DescribeAppAssessment.go +++ b/service/resiliencehub/api_op_DescribeAppAssessment.go @@ -31,8 +31,9 @@ type DescribeAppAssessmentInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersion.go b/service/resiliencehub/api_op_DescribeAppVersion.go index de82648fb04..dc7992dfc7f 100644 --- a/service/resiliencehub/api_op_DescribeAppVersion.go +++ b/service/resiliencehub/api_op_DescribeAppVersion.go @@ -30,8 +30,10 @@ type DescribeAppVersionInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -48,8 +50,10 @@ type DescribeAppVersionOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -61,8 +65,11 @@ 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]. + // + // Currently, this parameter supports only failover region and account. + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html 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 400f9e0c902..416cd75c8c6 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_DescribeAppVersionAppComponent.go @@ -31,8 +31,10 @@ type DescribeAppVersionAppComponentInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -54,8 +56,10 @@ type DescribeAppVersionAppComponentOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersionResource.go b/service/resiliencehub/api_op_DescribeAppVersionResource.go index d358ae60c48..1792ca0d019 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionResource.go +++ b/service/resiliencehub/api_op_DescribeAppVersionResource.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes a resource of the Resilience Hub application. This API accepts only -// one of the following parameters to descibe the resource: +// 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 ) func (c *Client) DescribeAppVersionResource(ctx context.Context, params *DescribeAppVersionResourceInput, optFns ...func(*Options)) (*DescribeAppVersionResourceOutput, error) { @@ -36,8 +40,10 @@ type DescribeAppVersionResourceInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -69,8 +75,10 @@ type DescribeAppVersionResourceOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go b/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go index 0276356c500..3045d80f81a 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go +++ b/service/resiliencehub/api_op_DescribeAppVersionResourcesResolutionStatus.go @@ -33,8 +33,10 @@ type DescribeAppVersionResourcesResolutionStatusInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -54,8 +56,10 @@ type DescribeAppVersionResourcesResolutionStatusOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeAppVersionTemplate.go b/service/resiliencehub/api_op_DescribeAppVersionTemplate.go index 352b5a5ab4a..bb1c9eca5a2 100644 --- a/service/resiliencehub/api_op_DescribeAppVersionTemplate.go +++ b/service/resiliencehub/api_op_DescribeAppVersionTemplate.go @@ -30,8 +30,10 @@ type DescribeAppVersionTemplateInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -48,84 +50,218 @@ type DescribeAppVersionTemplateOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // A JSON string that provides information about your application structure. To // 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 Logical identifier of the resource. Type: Object Each - // logicalResourceId object includes the following fields: - // - identifier 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 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 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 Name of the Application Component. Type: String - // - type 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 Logical identifier of the resource. Type: Object You can - // configure only one of the following fields: + // 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 + // + // Logical identifier of the resource. + // + // Type: Object + // + // Each logicalResourceId object includes the following fields: + // + // - identifier + // + // 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 - // - eksSourceName Each logicalResourceIds object includes the following fields: - // - identifier 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 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 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":""}]}]" + // + // The name of the Terraform S3 state file this resource belongs to. + // + // Type: String + // + // - eksSourceName + // + // 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]. + // + // 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 + // + // 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 + // + // Name of the Application Component. + // + // Type: String + // + // - type + // + // Type of Application Component. For more information about the types of + // Application Component, see [Grouping resources in an AppComponent]. + // + // 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]. + // + // 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 + // + // 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 + // + // 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 + // + // 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 + // + // 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]. + // + // 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":""}]}]" + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html + // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html // // This member is required. AppTemplateBody *string diff --git a/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go b/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go index 50e9c7cdfbb..d9a5f2247d3 100644 --- a/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go +++ b/service/resiliencehub/api_op_DescribeDraftAppVersionResourcesImportStatus.go @@ -12,10 +12,12 @@ import ( "time" ) -// Describes the status of importing resources to an application version. If you -// get a 404 error with ResourceImportStatusNotFoundAppMetadataException , you must -// call importResourcesToDraftAppVersion after creating the application and before -// calling describeDraftAppVersionResourcesImportStatus to obtain the status. +// Describes the status of importing resources to an application version. +// +// If you 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) { if params == nil { params = &DescribeDraftAppVersionResourcesImportStatusInput{} @@ -35,8 +37,10 @@ type DescribeDraftAppVersionResourcesImportStatusInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -48,8 +52,10 @@ type DescribeDraftAppVersionResourcesImportStatusOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_DescribeResiliencyPolicy.go b/service/resiliencehub/api_op_DescribeResiliencyPolicy.go index 3bdcde75c23..4643732169e 100644 --- a/service/resiliencehub/api_op_DescribeResiliencyPolicy.go +++ b/service/resiliencehub/api_op_DescribeResiliencyPolicy.go @@ -33,8 +33,10 @@ type DescribeResiliencyPolicyInput struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string diff --git a/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go b/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go index 3ed96cd1722..cc2bd721b87 100644 --- a/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go +++ b/service/resiliencehub/api_op_ImportResourcesToDraftAppVersion.go @@ -13,9 +13,9 @@ 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) -// . +// Resilience Hub, see [Discover the structure and describe your Resilience Hub application]. +// +// [Discover the structure and describe your Resilience Hub 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{} @@ -35,8 +35,10 @@ type ImportResourcesToDraftAppVersionInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -52,7 +54,7 @@ type ImportResourcesToDraftAppVersionInput struct { // The Amazon Resource Names (ARNs) for the resources. SourceArns []string - // A list of terraform file s3 URLs you need to import. + // A list of terraform file s3 URLs you need to import. TerraformSources []types.TerraformSource noSmithyDocumentSerde @@ -62,8 +64,10 @@ type ImportResourcesToDraftAppVersionOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -85,7 +89,7 @@ type ImportResourcesToDraftAppVersionOutput struct { // The Amazon Resource Names (ARNs) for the resources you have imported. SourceArns []string - // A list of terraform file s3 URLs you have imported. + // A list of terraform file s3 URLs you have imported. TerraformSources []types.TerraformSource // Metadata pertaining to the operation's result. diff --git a/service/resiliencehub/api_op_ListAlarmRecommendations.go b/service/resiliencehub/api_op_ListAlarmRecommendations.go index d815a0ae853..c253fdb3da3 100644 --- a/service/resiliencehub/api_op_ListAlarmRecommendations.go +++ b/service/resiliencehub/api_op_ListAlarmRecommendations.go @@ -31,8 +31,9 @@ type ListAlarmRecommendationsInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListAppAssessmentComplianceDrifts.go b/service/resiliencehub/api_op_ListAppAssessmentComplianceDrifts.go index 80ea72bca26..2b22eeb07b2 100644 --- a/service/resiliencehub/api_op_ListAppAssessmentComplianceDrifts.go +++ b/service/resiliencehub/api_op_ListAppAssessmentComplianceDrifts.go @@ -31,8 +31,9 @@ type ListAppAssessmentComplianceDriftsInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListAppAssessmentResourceDrifts.go b/service/resiliencehub/api_op_ListAppAssessmentResourceDrifts.go index 749b7aff679..506013c9ea1 100644 --- a/service/resiliencehub/api_op_ListAppAssessmentResourceDrifts.go +++ b/service/resiliencehub/api_op_ListAppAssessmentResourceDrifts.go @@ -32,8 +32,9 @@ type ListAppAssessmentResourceDriftsInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListAppAssessments.go b/service/resiliencehub/api_op_ListAppAssessments.go index ae5ff57b624..22395dd5d72 100644 --- a/service/resiliencehub/api_op_ListAppAssessments.go +++ b/service/resiliencehub/api_op_ListAppAssessments.go @@ -32,8 +32,10 @@ type ListAppAssessmentsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The name for the assessment. diff --git a/service/resiliencehub/api_op_ListAppComponentCompliances.go b/service/resiliencehub/api_op_ListAppComponentCompliances.go index bef5a7feb82..cd9c57eac69 100644 --- a/service/resiliencehub/api_op_ListAppComponentCompliances.go +++ b/service/resiliencehub/api_op_ListAppComponentCompliances.go @@ -31,8 +31,9 @@ type ListAppComponentCompliancesInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListAppComponentRecommendations.go b/service/resiliencehub/api_op_ListAppComponentRecommendations.go index add9f226a90..778d96b4e38 100644 --- a/service/resiliencehub/api_op_ListAppComponentRecommendations.go +++ b/service/resiliencehub/api_op_ListAppComponentRecommendations.go @@ -31,8 +31,9 @@ type ListAppComponentRecommendationsInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListAppInputSources.go b/service/resiliencehub/api_op_ListAppInputSources.go index 14ba9b564c8..993dfdb5aab 100644 --- a/service/resiliencehub/api_op_ListAppInputSources.go +++ b/service/resiliencehub/api_op_ListAppInputSources.go @@ -12,9 +12,9 @@ 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) -// . +// information about the input sources supported by Resilience Hub, see [Discover the structure and describe your Resilience Hub application]. +// +// [Discover 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{} @@ -34,8 +34,10 @@ type ListAppInputSourcesInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListAppVersionAppComponents.go b/service/resiliencehub/api_op_ListAppVersionAppComponents.go index 2eb4decb480..1d5d0cb9119 100644 --- a/service/resiliencehub/api_op_ListAppVersionAppComponents.go +++ b/service/resiliencehub/api_op_ListAppVersionAppComponents.go @@ -31,8 +31,10 @@ type ListAppVersionAppComponentsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -56,8 +58,10 @@ type ListAppVersionAppComponentsOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListAppVersionResourceMappings.go b/service/resiliencehub/api_op_ListAppVersionResourceMappings.go index 6d1fd93497b..11c0d66282f 100644 --- a/service/resiliencehub/api_op_ListAppVersionResourceMappings.go +++ b/service/resiliencehub/api_op_ListAppVersionResourceMappings.go @@ -33,8 +33,10 @@ type ListAppVersionResourceMappingsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListAppVersionResources.go b/service/resiliencehub/api_op_ListAppVersionResources.go index cadb64ea013..821860df0a7 100644 --- a/service/resiliencehub/api_op_ListAppVersionResources.go +++ b/service/resiliencehub/api_op_ListAppVersionResources.go @@ -31,8 +31,10 @@ type ListAppVersionResourcesInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListAppVersions.go b/service/resiliencehub/api_op_ListAppVersions.go index 2b985b8af42..50cdd9412a6 100644 --- a/service/resiliencehub/api_op_ListAppVersions.go +++ b/service/resiliencehub/api_op_ListAppVersions.go @@ -32,8 +32,10 @@ type ListAppVersionsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_ListApps.go b/service/resiliencehub/api_op_ListApps.go index 39fe587e5d1..5fc38aff130 100644 --- a/service/resiliencehub/api_op_ListApps.go +++ b/service/resiliencehub/api_op_ListApps.go @@ -12,11 +12,14 @@ import ( "time" ) -// Lists your Resilience Hub applications. You can filter applications using only -// one filter at a time or without using any filter. If you try to filter -// applications using multiple filters, you will get the following error: An error -// occurred (ValidationException) when calling the ListApps operation: Only one -// filter is supported for this operation. +// Lists your Resilience Hub applications. +// +// You can filter applications using only one filter at a time or without using +// any filter. If you try to filter applications using multiple filters, you will +// get the following error: +// +// An error occurred (ValidationException) when calling the ListApps operation: +// Only one filter is supported for this operation. func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error) { if params == nil { params = &ListAppsInput{} @@ -36,8 +39,10 @@ type ListAppsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Indicates the lower limit of the range that is used to filter applications diff --git a/service/resiliencehub/api_op_ListRecommendationTemplates.go b/service/resiliencehub/api_op_ListRecommendationTemplates.go index 0a58502f864..40fe70f622a 100644 --- a/service/resiliencehub/api_op_ListRecommendationTemplates.go +++ b/service/resiliencehub/api_op_ListRecommendationTemplates.go @@ -31,8 +31,9 @@ type ListRecommendationTemplatesInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AssessmentArn *string // Maximum number of results to include in the response. If more results exist diff --git a/service/resiliencehub/api_op_ListSopRecommendations.go b/service/resiliencehub/api_op_ListSopRecommendations.go index 1d5e6133e03..7978dbb855a 100644 --- a/service/resiliencehub/api_op_ListSopRecommendations.go +++ b/service/resiliencehub/api_op_ListSopRecommendations.go @@ -32,8 +32,9 @@ type ListSopRecommendationsInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListTestRecommendations.go b/service/resiliencehub/api_op_ListTestRecommendations.go index fe31a345cd5..569485e6007 100644 --- a/service/resiliencehub/api_op_ListTestRecommendations.go +++ b/service/resiliencehub/api_op_ListTestRecommendations.go @@ -31,8 +31,9 @@ type ListTestRecommendationsInput struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string diff --git a/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go b/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go index 398e62859d4..c2cc9a2baeb 100644 --- a/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go +++ b/service/resiliencehub/api_op_ListUnsupportedAppVersionResources.go @@ -33,8 +33,10 @@ type ListUnsupportedAppVersionResourcesInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_PublishAppVersion.go b/service/resiliencehub/api_op_PublishAppVersion.go index 4de2dd55559..c33d731a00e 100644 --- a/service/resiliencehub/api_op_PublishAppVersion.go +++ b/service/resiliencehub/api_op_PublishAppVersion.go @@ -30,8 +30,10 @@ type PublishAppVersionInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -46,8 +48,10 @@ type PublishAppVersionOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go b/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go index 7d32dd4f943..844b93f7e5a 100644 --- a/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go +++ b/service/resiliencehub/api_op_PutDraftAppVersionTemplate.go @@ -31,84 +31,218 @@ type PutDraftAppVersionTemplateInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string // A JSON string that provides information about your application structure. To // 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 Logical identifier of the resource. Type: Object Each - // logicalResourceId object includes the following fields: - // - identifier 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 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 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 Name of the Application Component. Type: String - // - type 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 Logical identifier of the resource. Type: Object You can - // configure only one of the following fields: + // 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 + // + // Logical identifier of the resource. + // + // Type: Object + // + // Each logicalResourceId object includes the following fields: + // + // - identifier + // + // 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 - // - eksSourceName Each logicalResourceIds object includes the following fields: - // - identifier 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 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 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":""}]}]" + // + // The name of the Terraform S3 state file this resource belongs to. + // + // Type: String + // + // - eksSourceName + // + // 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]. + // + // 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 + // + // 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 + // + // Name of the Application Component. + // + // Type: String + // + // - type + // + // Type of Application Component. For more information about the types of + // Application Component, see [Grouping resources in an AppComponent]. + // + // 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]. + // + // 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 + // + // 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 + // + // 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 + // + // 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 + // + // 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]. + // + // 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":""}]}]" + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html + // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html // // This member is required. AppTemplateBody *string @@ -120,8 +254,10 @@ type PutDraftAppVersionTemplateOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The version of the application. diff --git a/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go b/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go index dd3fb9f1c31..dd79dee6560 100644 --- a/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go +++ b/service/resiliencehub/api_op_RemoveDraftAppVersionResourceMappings.go @@ -30,8 +30,10 @@ type RemoveDraftAppVersionResourceMappingsInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -41,8 +43,9 @@ type RemoveDraftAppVersionResourceMappingsInput struct { AppRegistryAppNames []string // The names of the Amazon Elastic Kubernetes Service clusters and namespaces you - // want to remove from the resource mappings. This parameter accepts values in - // "eks-cluster/namespace" format. + // want to remove from the resource mappings. + // + // This parameter accepts values in "eks-cluster/namespace" format. EksSourceNames []string // The names of the CloudFormation stacks you want to remove from the resource @@ -66,8 +69,10 @@ type RemoveDraftAppVersionResourceMappingsOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The version of the application. diff --git a/service/resiliencehub/api_op_ResolveAppVersionResources.go b/service/resiliencehub/api_op_ResolveAppVersionResources.go index 81070fb53b2..9b3c86b2b6c 100644 --- a/service/resiliencehub/api_op_ResolveAppVersionResources.go +++ b/service/resiliencehub/api_op_ResolveAppVersionResources.go @@ -31,8 +31,10 @@ type ResolveAppVersionResourcesInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -49,8 +51,10 @@ type ResolveAppVersionResourcesOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_StartAppAssessment.go b/service/resiliencehub/api_op_StartAppAssessment.go index a39fecdc1ca..a180cfea52a 100644 --- a/service/resiliencehub/api_op_StartAppAssessment.go +++ b/service/resiliencehub/api_op_StartAppAssessment.go @@ -31,8 +31,10 @@ type StartAppAssessmentInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_UpdateApp.go b/service/resiliencehub/api_op_UpdateApp.go index 34e8560b7b0..3f5d003b9ce 100644 --- a/service/resiliencehub/api_op_UpdateApp.go +++ b/service/resiliencehub/api_op_UpdateApp.go @@ -31,13 +31,15 @@ type UpdateAppInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string - // Assessment execution schedule with 'Daily' or 'Disabled' values. + // Assessment execution schedule with 'Daily' or 'Disabled' values. AssessmentSchedule types.AppAssessmentScheduleType // Specifies if the resiliency policy ARN should be cleared. @@ -57,8 +59,10 @@ type UpdateAppInput struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string noSmithyDocumentSerde diff --git a/service/resiliencehub/api_op_UpdateAppVersion.go b/service/resiliencehub/api_op_UpdateAppVersion.go index 41949d7f7bc..78d96576134 100644 --- a/service/resiliencehub/api_op_UpdateAppVersion.go +++ b/service/resiliencehub/api_op_UpdateAppVersion.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the Resilience Hub application version. This API updates the Resilience -// Hub application draft version. To use this information for running resiliency -// assessments, you must publish the Resilience Hub application using the -// PublishAppVersion API. +// Updates the Resilience Hub application version. +// +// This API updates the Resilience Hub application draft version. To use this +// information for running resiliency assessments, you must publish the Resilience +// Hub application using the PublishAppVersion API. func (c *Client) UpdateAppVersion(ctx context.Context, params *UpdateAppVersionInput, optFns ...func(*Options)) (*UpdateAppVersionOutput, error) { if params == nil { params = &UpdateAppVersionInput{} @@ -33,18 +34,26 @@ type UpdateAppVersionInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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 - // only one failover region and one associated account. Key: "failover-regions" + // using an API call, see [Configure the application configuration parameters]. + // + // 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":""}]}]" + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html AdditionalInfo map[string][]string noSmithyDocumentSerde @@ -54,8 +63,10 @@ type UpdateAppVersionOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -67,8 +78,11 @@ 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]. + // + // Currently, this parameter supports only failover region and account. + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html 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 da00e218da6..640ef953b01 100644 --- a/service/resiliencehub/api_op_UpdateAppVersionAppComponent.go +++ b/service/resiliencehub/api_op_UpdateAppVersionAppComponent.go @@ -12,6 +12,7 @@ import ( ) // Updates an existing Application Component in 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. @@ -34,8 +35,10 @@ type UpdateAppVersionAppComponentInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -53,8 +56,9 @@ type UpdateAppVersionAppComponentInput struct { Name *string // 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]. + // + // [Grouping resources in an AppComponent]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/AppComponent.grouping.html Type *string noSmithyDocumentSerde @@ -64,8 +68,10 @@ type UpdateAppVersionAppComponentOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_UpdateAppVersionResource.go b/service/resiliencehub/api_op_UpdateAppVersionResource.go index a5f3181adc1..94d9bc724bf 100644 --- a/service/resiliencehub/api_op_UpdateAppVersionResource.go +++ b/service/resiliencehub/api_op_UpdateAppVersionResource.go @@ -12,10 +12,13 @@ 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. func (c *Client) UpdateAppVersionResource(ctx context.Context, params *UpdateAppVersionResourceInput, optFns ...func(*Options)) (*UpdateAppVersionResourceOutput, error) { @@ -37,8 +40,10 @@ type UpdateAppVersionResourceInput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -56,8 +61,9 @@ type UpdateAppVersionResourceInput struct { // Amazon Web Services region that owns the physical resource. AwsRegion *string - // Indicates if a resource is excluded from an Resilience Hub application. You can - // exclude only imported resources from an Resilience Hub application. + // Indicates if a resource is excluded from an Resilience Hub application. + // + // You can exclude only imported resources from an Resilience Hub application. Excluded *bool // Logical identifier of the resource. @@ -79,8 +85,10 @@ type UpdateAppVersionResourceOutput struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string diff --git a/service/resiliencehub/api_op_UpdateResiliencyPolicy.go b/service/resiliencehub/api_op_UpdateResiliencyPolicy.go index 31747a6020d..068954cfb96 100644 --- a/service/resiliencehub/api_op_UpdateResiliencyPolicy.go +++ b/service/resiliencehub/api_op_UpdateResiliencyPolicy.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a resiliency policy. Resilience Hub allows you to provide a value of -// zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while -// assessing your application, the lowest possible assessment result is near zero. -// Hence, if you provide value zero for rtoInSecs and rpoInSecs , the estimated -// workload RTO and estimated workload RPO result will be near zero and the -// Compliance status for your application will be set to Policy breached. +// Updates a resiliency policy. +// +// Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs +// of your resiliency policy. But, while assessing your application, the lowest +// possible assessment result is near zero. Hence, if you provide value zero for +// rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO +// result will be near zero and the Compliance status for your application will be +// set to Policy breached. func (c *Client) UpdateResiliencyPolicy(ctx context.Context, params *UpdateResiliencyPolicyInput, optFns ...func(*Options)) (*UpdateResiliencyPolicyOutput, error) { if params == nil { params = &UpdateResiliencyPolicyInput{} @@ -36,8 +38,10 @@ type UpdateResiliencyPolicyInput struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. PolicyArn *string diff --git a/service/resiliencehub/options.go b/service/resiliencehub/options.go index 0f88fcee0b4..88b86dbbb9f 100644 --- a/service/resiliencehub/options.go +++ b/service/resiliencehub/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/resiliencehub/types/enums.go b/service/resiliencehub/types/enums.go index 8e9fd725dd2..a122d8014fb 100644 --- a/service/resiliencehub/types/enums.go +++ b/service/resiliencehub/types/enums.go @@ -14,8 +14,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -36,6 +37,7 @@ const ( // Values returns all known values for AppAssessmentScheduleType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AppAssessmentScheduleType) Values() []AppAssessmentScheduleType { return []AppAssessmentScheduleType{ @@ -55,8 +57,9 @@ const ( ) // Values returns all known values for AppComplianceStatusType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppComplianceStatusType) Values() []AppComplianceStatusType { return []AppComplianceStatusType{ "PolicyBreached", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for AppDriftStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppDriftStatusType) Values() []AppDriftStatusType { return []AppDriftStatusType{ "NotChecked", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for AppStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppStatusType) Values() []AppStatusType { return []AppStatusType{ "Active", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for AssessmentInvoker. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentInvoker) Values() []AssessmentInvoker { return []AssessmentInvoker{ "User", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for AssessmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssessmentStatus) Values() []AssessmentStatus { return []AssessmentStatus{ "Pending", @@ -153,8 +160,9 @@ const ( ) // Values returns all known values for ComplianceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceStatus) Values() []ComplianceStatus { return []ComplianceStatus{ "PolicyBreached", @@ -176,8 +184,9 @@ const ( // Values returns all known values for ConfigRecommendationOptimizationType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigRecommendationOptimizationType) Values() []ConfigRecommendationOptimizationType { return []ConfigRecommendationOptimizationType{ "LeastCost", @@ -200,8 +209,9 @@ const ( ) // Values returns all known values for CostFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CostFrequency) Values() []CostFrequency { return []CostFrequency{ "Hourly", @@ -221,8 +231,9 @@ const ( ) // Values returns all known values for DataLocationConstraint. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataLocationConstraint) Values() []DataLocationConstraint { return []DataLocationConstraint{ "AnyLocation", @@ -241,8 +252,9 @@ const ( ) // Values returns all known values for DifferenceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DifferenceType) Values() []DifferenceType { return []DifferenceType{ "NotEqual", @@ -262,8 +274,9 @@ const ( ) // Values returns all known values for DisruptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DisruptionType) Values() []DisruptionType { return []DisruptionType{ "Software", @@ -283,8 +296,9 @@ const ( ) // Values returns all known values for DriftStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DriftStatus) Values() []DriftStatus { return []DriftStatus{ "NotChecked", @@ -302,8 +316,9 @@ const ( ) // Values returns all known values for DriftType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DriftType) Values() []DriftType { return []DriftType{ "ApplicationCompliance", @@ -322,8 +337,9 @@ const ( ) // Values returns all known values for EstimatedCostTier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EstimatedCostTier) Values() []EstimatedCostTier { return []EstimatedCostTier{ "L1", @@ -342,8 +358,9 @@ const ( ) // 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. +// in the future, and so 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{ "ScheduledAssessmentFailure", @@ -362,6 +379,7 @@ const ( // Values returns all known values for ExcludeRecommendationReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ExcludeRecommendationReason) Values() []ExcludeRecommendationReason { return []ExcludeRecommendationReason{ @@ -383,8 +401,9 @@ const ( ) // Values returns all known values for HaArchitecture. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HaArchitecture) Values() []HaArchitecture { return []HaArchitecture{ "MultiSite", @@ -404,8 +423,9 @@ const ( ) // Values returns all known values for PermissionModelType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionModelType) Values() []PermissionModelType { return []PermissionModelType{ "LegacyIAMUser", @@ -422,8 +442,9 @@ const ( ) // Values returns all known values for PhysicalIdentifierType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PhysicalIdentifierType) Values() []PhysicalIdentifierType { return []PhysicalIdentifierType{ "Arn", @@ -442,8 +463,9 @@ const ( // Values returns all known values for RecommendationComplianceStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationComplianceStatus) Values() []RecommendationComplianceStatus { return []RecommendationComplianceStatus{ "BreachedUnattainable", @@ -463,8 +485,9 @@ const ( ) // Values returns all known values for RecommendationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationStatus) Values() []RecommendationStatus { return []RecommendationStatus{ "Implemented", @@ -486,8 +509,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationTemplateStatus) Values() []RecommendationTemplateStatus { return []RecommendationTemplateStatus{ "Pending", @@ -508,6 +532,7 @@ const ( // 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{ @@ -530,8 +555,9 @@ const ( ) // Values returns all known values for ResiliencyPolicyTier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResiliencyPolicyTier) Values() []ResiliencyPolicyTier { return []ResiliencyPolicyTier{ "MissionCritical", @@ -554,8 +580,9 @@ const ( ) // Values returns all known values for ResiliencyScoreType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResiliencyScoreType) Values() []ResiliencyScoreType { return []ResiliencyScoreType{ "Compliance", @@ -577,6 +604,7 @@ const ( // 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{ @@ -597,6 +625,7 @@ const ( // Values returns all known values for ResourceImportStrategyType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResourceImportStrategyType) Values() []ResourceImportStrategyType { return []ResourceImportStrategyType{ @@ -618,8 +647,9 @@ const ( ) // Values returns all known values for ResourceMappingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceMappingType) Values() []ResourceMappingType { return []ResourceMappingType{ "CfnStack", @@ -643,8 +673,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceResolutionStatusType) Values() []ResourceResolutionStatusType { return []ResourceResolutionStatusType{ "Pending", @@ -663,8 +694,9 @@ const ( ) // Values returns all known values for ResourceSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSourceType) Values() []ResourceSourceType { return []ResourceSourceType{ "AppTemplate", @@ -680,8 +712,9 @@ const ( ) // Values returns all known values for SopServiceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SopServiceType) Values() []SopServiceType { return []SopServiceType{ "SSM", @@ -697,8 +730,9 @@ const ( ) // Values returns all known values for TemplateFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemplateFormat) Values() []TemplateFormat { return []TemplateFormat{ "CfnYaml", @@ -716,8 +750,9 @@ const ( ) // Values returns all known values for TestRisk. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestRisk) Values() []TestRisk { return []TestRisk{ "Small", @@ -737,8 +772,9 @@ const ( ) // Values returns all known values for TestType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestType) Values() []TestType { return []TestType{ "Software", diff --git a/service/resiliencehub/types/types.go b/service/resiliencehub/types/types.go index 3a1d8e83d31..97f1e78c45f 100644 --- a/service/resiliencehub/types/types.go +++ b/service/resiliencehub/types/types.go @@ -61,8 +61,10 @@ type App struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -110,8 +112,10 @@ type App struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string // Current resiliency score for the application. @@ -138,8 +142,9 @@ type AppAssessment struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string @@ -156,8 +161,10 @@ type AppAssessment struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Version of an application. @@ -191,8 +198,8 @@ type AppAssessment struct { // Current resiliency score for an application. ResiliencyScore *ResiliencyScore - // A resource error object containing a list of errors retrieving an application's - // resources. + // A resource error object containing a list of errors retrieving an + // application's resources. ResourceErrorsDetails *ResourceErrorsDetails // Starting time for the action. @@ -213,8 +220,9 @@ type AppAssessmentSummary struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string @@ -226,8 +234,10 @@ type AppAssessmentSummary struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Version of an application. @@ -282,10 +292,16 @@ 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 - // only one failover region and one associated account. Key: "failover-regions" + // using an API call, see [Configure the application configuration parameters]. + // + // 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":""}]}]" + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html AdditionalInfo map[string][]string // Identifier of the Application Component. @@ -334,8 +350,9 @@ 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 Amazon Web Services General Reference guide. + // ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html SourceArn *string // The name of the input source. @@ -352,8 +369,10 @@ type AppSummary struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AppArn *string @@ -368,7 +387,7 @@ type AppSummary struct { // This member is required. Name *string - // Assessment execution schedule with 'Daily' or 'Disabled' values. + // Assessment execution schedule with 'Daily' or 'Disabled' values. AssessmentSchedule AppAssessmentScheduleType // The current status of compliance for the resiliency policy. @@ -423,6 +442,7 @@ type AppVersionSummary struct { type BatchUpdateRecommendationStatusFailedEntry struct { // An identifier of an entry in this batch that is used to communicate the result. + // // The entryId s of a batch request need to be unique within a request. // // This member is required. @@ -439,8 +459,9 @@ type BatchUpdateRecommendationStatusFailedEntry struct { // List of operational recommendations that were successfully included or excluded. type BatchUpdateRecommendationStatusSuccessfulEntry struct { - // An identifier for an entry in this batch that is used to communicate the - // result. The entryId s of a batch request need to be unique within a request. + // An identifier for an entry in this batch that is used to communicate the result. + // + // The entryId s of a batch request need to be unique within a request. // // This member is required. EntryId *string @@ -643,9 +664,10 @@ type EksSource struct { // 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 Amazon Web Services General Reference guide. + // cluster-name . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services + // General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. EksClusterArn *string @@ -665,9 +687,10 @@ type EksSourceClusterNamespace struct { // 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 Amazon Web Services General Reference guide. + // cluster-name . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services + // General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. EksClusterArn *string @@ -701,8 +724,9 @@ type EventSubscription struct { // Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The // format for this ARN is: arn:partition:sns:region:account:topic-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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html SnsTopicArn *string noSmithyDocumentSerde @@ -733,8 +757,9 @@ type LogicalResourceId struct { Identifier *string // Name of the Amazon Elastic Kubernetes Service cluster and namespace this - // resource belongs to. This parameter accepts values in "eks-cluster/namespace" - // format. + // resource belongs to. + // + // This parameter accepts values in "eks-cluster/namespace" format. EksSourceName *string // The name of the CloudFormation stack this resource belongs to. @@ -743,7 +768,7 @@ type LogicalResourceId struct { // The name of the resource group that this resource belongs to. ResourceGroupName *string - // The name of the Terraform S3 state file this resource belongs to. + // The name of the Terraform S3 state file this resource belongs to. TerraformSourceName *string noSmithyDocumentSerde @@ -763,9 +788,11 @@ type PermissionModel struct { // Defines a list of role Amazon Resource Names (ARNs) to be used in other // accounts. These ARNs are used for querying purposes while importing resources // and assessing your application. + // // - These ARNs are required only when your resources are in other accounts and // you have different role name in these accounts. Else, the invoker role name will // be used in the other accounts. + // // - These roles must have a trust policy with iam:AssumeRole permission to the // invoker role in the primary account. CrossAccountRoleArns []string @@ -773,8 +800,10 @@ type PermissionModel struct { // Existing Amazon Web Services IAM role name in the primary Amazon Web Services // account that will be assumed by Resilience Hub Service Principle to obtain a // read-only access to your application resources while running an assessment. + // // - You must have iam:passRole permission for this role while creating or // updating the application. + // // - Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters. InvokerRoleName *string @@ -803,10 +832,16 @@ 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 - // only one failover region and one associated account. Key: "failover-regions" + // using an API call, see [Configure the application configuration parameters]. + // + // 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":""}]}]" + // + // [Configure the application configuration parameters]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/app-config-param.html AdditionalInfo map[string][]string // The application components that belong to this resource. @@ -835,34 +870,60 @@ type PhysicalResourceId struct { // This member is required. Identifier *string - // Specifies the type of physical resource identifier. Arn The resource identifier - // is an Amazon Resource Name (ARN) and it can identify the following list of - // resources: + // Specifies the type of physical resource identifier. + // + // Arn The resource identifier is an Amazon Resource Name (ARN) and it can + // identify the following list of resources: + // // - AWS::ECS::Service + // // - AWS::EFS::FileSystem + // // - AWS::ElasticLoadBalancingV2::LoadBalancer + // // - AWS::Lambda::Function + // // - AWS::SNS::Topic + // // Native The resource identifier is an Resilience Hub-native identifier and it // can identify the following list of resources: + // // - AWS::ApiGateway::RestApi + // // - AWS::ApiGatewayV2::Api + // // - AWS::AutoScaling::AutoScalingGroup + // // - AWS::DocDB::DBCluster + // // - AWS::DocDB::DBGlobalCluster + // // - AWS::DocDB::DBInstance + // // - AWS::DynamoDB::GlobalTable + // // - AWS::DynamoDB::Table + // // - AWS::EC2::EC2Fleet + // // - AWS::EC2::Instance + // // - AWS::EC2::NatGateway + // // - AWS::EC2::Volume + // // - AWS::ElasticLoadBalancing::LoadBalancer + // // - AWS::RDS::DBCluster + // // - AWS::RDS::DBInstance + // // - AWS::RDS::GlobalCluster + // // - AWS::Route53::RecordSet + // // - AWS::S3::Bucket + // // - AWS::SQS::Queue // // This member is required. @@ -927,20 +988,23 @@ type RecommendationItem struct { noSmithyDocumentSerde } -// Defines a recommendation template created with the CreateRecommendationTemplate -// action. +// Defines a recommendation template created with the CreateRecommendationTemplate action. type RecommendationTemplate struct { // 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 Amazon Web Services General Reference guide. + // information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. AssessmentArn *string - // Format of the recommendation template. CfnJson The template is CloudFormation - // JSON. CfnYaml The template is CloudFormation YAML. + // Format of the recommendation template. + // + // CfnJson The template is CloudFormation JSON. + // + // CfnYaml The template is CloudFormation YAML. // // This member is required. Format TemplateFormat @@ -956,8 +1020,12 @@ type RecommendationTemplate struct { RecommendationTemplateArn *string // An array of strings that specify the recommendation template type or types. - // Alarm The template is an AlarmRecommendation template. Sop The template is a - // SopRecommendation template. Test The template is a TestRecommendation template. + // + // Alarm The template is an AlarmRecommendation template. + // + // Sop The template is a SopRecommendation template. + // + // Test The template is a TestRecommendation template. // // This member is required. RecommendationTypes []RenderRecommendationType @@ -969,8 +1037,10 @@ type RecommendationTemplate struct { // 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 Amazon Web Services General Reference guide. + // more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference + // guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // The end time for the action. @@ -998,12 +1068,14 @@ type RecommendationTemplate struct { noSmithyDocumentSerde } -// Defines a resiliency policy. Resilience Hub allows you to provide a value of -// zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while -// assessing your application, the lowest possible assessment result is near zero. -// Hence, if you provide value zero for rtoInSecs and rpoInSecs , the estimated -// workload RTO and estimated workload RPO result will be near zero and the -// Compliance status for your application will be set to Policy breached. +// Defines a resiliency policy. +// +// Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs +// of your resiliency policy. But, while assessing your application, the lowest +// possible assessment result is near zero. Hence, if you provide value zero for +// rtoInSecs and rpoInSecs , the estimated workload RTO and estimated workload RPO +// result will be near zero and the Compliance status for your application will be +// set to Policy breached. type ResiliencyPolicy struct { // Date and time when the resiliency policy was created. @@ -1021,8 +1093,10 @@ type ResiliencyPolicy struct { // 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 Amazon Web Services General Reference guide. + // . For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArn *string // The description for the policy. @@ -1057,9 +1131,10 @@ type ResiliencyScore struct { Score float64 // The score generated by Resilience Hub for the scoring component after running - // an assessment. For example, if the score is 25 points, it indicates the overall - // score of your application generated by Resilience Hub after running an - // assessment. + // an assessment. + // + // For example, if the score is 25 points, it indicates the overall score of your + // application generated by Resilience Hub after running an assessment. ComponentScore map[string]ScoringComponentResiliencyScore noSmithyDocumentSerde @@ -1070,9 +1145,10 @@ type ResourceDrift struct { // Amazon Resource Name (ARN) of the application whose resources have drifted. 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 Amazon Web Services General Reference guide. + // :app-assessment/ app-id . For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon + // Web Services General Reference guide. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html AppArn *string // Version of the application whose resources have drifted. @@ -1099,7 +1175,7 @@ type ResourceError struct { // Identifier of the physical resource. PhysicalResourceId *string - // This is the error message. + // This is the error message. Reason *string noSmithyDocumentSerde @@ -1108,10 +1184,10 @@ type ResourceError struct { // A list of errors retrieving an application's resources. type ResourceErrorsDetails struct { - // This indicates if there are more errors not listed in the resourceErrors list. + // This indicates if there are more errors not listed in the resourceErrors list. HasMoreErrors *bool - // A list of errors retrieving an application's resources. + // A list of errors retrieving an application's resources. ResourceErrors []ResourceError noSmithyDocumentSerde @@ -1147,8 +1223,9 @@ type ResourceMapping struct { AppRegistryAppName *string // Name of the Amazon Elastic Kubernetes Service cluster and namespace that this - // resource is mapped to when the mappingType is EKS . This parameter accepts - // values in "eks-cluster/namespace" format. + // resource is mapped to when the mappingType is EKS . + // + // This parameter accepts values in "eks-cluster/namespace" format. EksSourceName *string // Name of the CloudFormation stack this resource is mapped to when the mappingType @@ -1183,28 +1260,33 @@ type S3Location struct { } // Resiliency score of each scoring component. For more information about scoring -// component, see Calculating resiliency score (https://docs.aws.amazon.com/resilience-hub/latest/userguide/calculate-score.html) -// . +// component, see [Calculating resiliency score]. +// +// [Calculating resiliency score]: https://docs.aws.amazon.com/resilience-hub/latest/userguide/calculate-score.html type ScoringComponentResiliencyScore struct { - // Number of recommendations that were excluded from the assessment. For example, - // if the excludedCount for Alarms coverage scoring component is 7, it indicates - // that 7 Amazon CloudWatch alarms are excluded from the assessment. + // Number of recommendations that were excluded from the assessment. + // + // For example, if the excludedCount for Alarms coverage scoring component is 7, + // it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment. ExcludedCount int64 // Number of recommendations that must be implemented to obtain the maximum // possible score for the scoring component. For SOPs, alarms, and tests, these are // the number of recommendations that must be implemented. For compliance, these // are the number of Application Components that have breached the resiliency - // policy. For example, if the outstandingCount for Alarms coverage scoring - // component is 5, it indicates that 5 Amazon CloudWatch alarms need to be - // implemented to achieve the maximum possible score. + // policy. + // + // For example, if the outstandingCount for Alarms coverage scoring component is + // 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to + // achieve the maximum possible score. OutstandingCount int64 - // Maximum possible score that can be obtained for the scoring component. For - // example, if the possibleScore is 20 points, it indicates the maximum possible - // score you can achieve for the scoring component when you run a new assessment - // after implementing all the Resilience Hub recommendations. + // Maximum possible score that can be obtained for the scoring component. + // + // For example, if the possibleScore is 20 points, it indicates the maximum + // possible score you can achieve for the scoring component when you run a new + // assessment after implementing all the Resilience Hub recommendations. PossibleScore float64 // Resiliency score points given for the scoring component. The score is always @@ -1256,7 +1338,7 @@ type SopRecommendation struct { // The Terraform s3 state file you need to import. type TerraformSource struct { - // The URL of the Terraform s3 state file you need to import. + // The URL of the Terraform s3 state file you need to import. // // This member is required. S3StateFileUrl *string @@ -1275,7 +1357,7 @@ type TestRecommendation struct { // Name of the Application Component. AppComponentName *string - // A list of recommended alarms that are used in the test and must be exported + // A list of recommended alarms that are used in the test and must be exported // before or with the test. DependsOnAlarms []string @@ -1351,8 +1433,9 @@ type UpdateRecommendationStatusItem struct { // Defines the operational recommendation item that is to be included or excluded. type UpdateRecommendationStatusRequestEntry struct { - // An identifier for an entry in this batch that is used to communicate the - // result. The entryId s of a batch request need to be unique within a request. + // An identifier for an entry in this batch that is used to communicate the result. + // + // The entryId s of a batch request need to be unique within a request. // // This member is required. EntryId *string diff --git a/service/resourceexplorer2/api_op_AssociateDefaultView.go b/service/resourceexplorer2/api_op_AssociateDefaultView.go index 1ff155c9532..dabfd7f495e 100644 --- a/service/resourceexplorer2/api_op_AssociateDefaultView.go +++ b/service/resourceexplorer2/api_op_AssociateDefaultView.go @@ -11,12 +11,14 @@ import ( ) // Sets the specified view as the default for the Amazon Web Services Region in -// which you call this operation. When a user performs a Search that doesn't -// explicitly specify which view to use, then Amazon Web Services Resource Explorer +// which you call this operation. When a user performs a Searchthat doesn't explicitly +// specify which view to use, then Amazon Web Services Resource Explorer // automatically chooses this default view for searches performed in this Amazon -// Web Services Region. 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. +// Web Services Region. +// +// 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) AssociateDefaultView(ctx context.Context, params *AssociateDefaultViewInput, optFns ...func(*Options)) (*AssociateDefaultViewOutput, error) { if params == nil { params = &AssociateDefaultViewInput{} @@ -34,10 +36,11 @@ 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 - // already exist in the called Region. + // The [Amazon resource name (ARN)] 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. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ViewArn *string @@ -47,10 +50,11 @@ 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 - // Web Services Region and Amazon Web Services account in which you called this - // operation. + // The [Amazon resource name (ARN)] 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. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ViewArn *string // Metadata pertaining to the operation's result. diff --git a/service/resourceexplorer2/api_op_BatchGetView.go b/service/resourceexplorer2/api_op_BatchGetView.go index 8787bc96ed7..98e2f639b3b 100644 --- a/service/resourceexplorer2/api_op_BatchGetView.go +++ b/service/resourceexplorer2/api_op_BatchGetView.go @@ -29,8 +29,9 @@ 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) - // that identify the views you want details for. + // A list of [Amazon resource names (ARNs)] that identify the views you want details for. + // + // [Amazon resource names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ViewArns []string noSmithyDocumentSerde diff --git a/service/resourceexplorer2/api_op_CreateIndex.go b/service/resourceexplorer2/api_op_CreateIndex.go index 6bd7c2dfae8..f0d05cc5c86 100644 --- a/service/resourceexplorer2/api_op_CreateIndex.go +++ b/service/resourceexplorer2/api_op_CreateIndex.go @@ -16,35 +16,53 @@ import ( // 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) -// 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) -// 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) -// 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. +// 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 UpdateIndexTypeoperation. For more information, see [Turning on cross-Region search by creating an aggregator index] 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]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]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]. +// Resource Explorer uses the same service-linked role for all additional indexes +// you create afterwards. +// +// [Turning on cross-Region search by creating an aggregator index]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html +// [creates a service-linked role]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/security_iam_service-linked-roles.html +// [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 +// +// [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 func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error) { if params == nil { params = &CreateIndexInput{} @@ -64,8 +82,9 @@ 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 index. + // generate a [UUID-type value]to ensure the uniqueness of your index. + // + // [UUID-type value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // The specified tags are attached only to the index created in this Amazon Web @@ -79,17 +98,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 | - // GetIndex | UpdateIndexType | CreateView + // 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. + // state for asynchronous operations by calling the GetIndexoperation. + // + // 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 b76a36718f6..e089aded290 100644 --- a/service/resourceexplorer2/api_op_CreateView.go +++ b/service/resourceexplorer2/api_op_CreateView.go @@ -14,11 +14,14 @@ 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) -// 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. +// Explorer views, see [Managing views]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)] of this view can Search using views you create +// with this operation. +// +// [Managing views]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views.html +// [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns ...func(*Options)) (*CreateViewOutput, error) { if params == nil { params = &CreateViewInput{} @@ -37,36 +40,45 @@ func (c *Client) CreateView(ctx context.Context, params *CreateViewInput, optFns type CreateViewInput struct { // The name of the new view. This name appears in the list of views in Resource - // Explorer. The name must be no more than 64 characters long, and can include - // letters, digits, and the dash (-) character. The name must be unique within its - // Amazon Web Services Region. + // Explorer. + // + // The name must be no more than 64 characters long, and can include letters, + // digits, and the dash (-) character. The name must be unique within its Amazon + // Web Services Region. // // This member is required. ViewName *string // 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]to ensure the uniqueness of your views. + // + // [UUID-type value]: https://wikipedia.org/wiki/Universally_unique_identifier 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) - // 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) + // queries made using this view. When you use this view in a Searchoperation, 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] in the Amazon Web Services + // Resource Explorer User Guide. + // + // This query string in the context of this operation supports only [filter prefixes] with optional [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 . + // + // [filter prefixes]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters + // [Search query reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html + // [operators]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators Filters *types.SearchFilter // Specifies optional fields that you want included in search results from this - // view. It is a list of objects that each describe a field to include. The default - // is an empty list, with no optional fields included in the results. + // view. It is a list of objects that each describe a field to include. + // + // The default is an empty list, with no optional fields included in the results. IncludedProperties []types.IncludedProperty // The root ARN of the account, an organizational unit (OU), or an organization diff --git a/service/resourceexplorer2/api_op_DeleteIndex.go b/service/resourceexplorer2/api_op_DeleteIndex.go index 38e78fd643a..f951d9370cb 100644 --- a/service/resourceexplorer2/api_op_DeleteIndex.go +++ b/service/resourceexplorer2/api_op_DeleteIndex.go @@ -17,12 +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 GetIndexoperation 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{} @@ -40,8 +40,9 @@ 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)] of the index that you want to delete. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string @@ -51,9 +52,11 @@ 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)] of the index that you successfully started the deletion process. + // + // This operation is asynchronous. To check its status, call the GetIndex operation. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 40c31fae4bb..f7f2e2c243c 100644 --- a/service/resourceexplorer2/api_op_DeleteView.go +++ b/service/resourceexplorer2/api_op_DeleteView.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified view. If the specified view is the default view for its -// Amazon Web Services Region, then all Search operations in that Region must -// explicitly specify the view to use until you configure a new default by calling -// the AssociateDefaultView operation. +// Deletes the specified view. +// +// If the specified view is the default view for its Amazon Web Services Region, +// then all Searchoperations in that Region must explicitly specify the view to use +// until you configure a new default by calling the AssociateDefaultViewoperation. func (c *Client) DeleteView(ctx context.Context, params *DeleteViewInput, optFns ...func(*Options)) (*DeleteViewOutput, error) { if params == nil { params = &DeleteViewInput{} @@ -31,8 +32,9 @@ 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)] of the view that you want to delete. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ViewArn *string @@ -42,8 +44,9 @@ 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)] of the view that you successfully deleted. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 8c028dbac13..552ea3700cb 100644 --- a/service/resourceexplorer2/api_op_DisassociateDefaultView.go +++ b/service/resourceexplorer2/api_op_DisassociateDefaultView.go @@ -11,11 +11,13 @@ import ( ) // 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 +// longer has a default view. All Searchoperations 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. +// calling the AssociateDefaultViewoperation. +// +// 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 492c72cbd5f..d02dc173d9a 100644 --- a/service/resourceexplorer2/api_op_GetDefaultView.go +++ b/service/resourceexplorer2/api_op_GetDefaultView.go @@ -12,7 +12,7 @@ import ( // 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. +// call GetViewto 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,9 +34,10 @@ 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)] of the view that is the current default for the Amazon Web Services Region + // in which you called this operation. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 b33a0119de4..0254c6b2184 100644 --- a/service/resourceexplorer2/api_op_GetIndex.go +++ b/service/resourceexplorer2/api_op_GetIndex.go @@ -35,8 +35,9 @@ 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)] of the index. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time when the index was originally created. @@ -45,15 +46,18 @@ 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 - // the Amazon Web Services Regions that replicate their content to the index in - // this Region. + // 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 - // 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. + // 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. ReplicatingTo []string // The current state of the index in this Amazon Web Services Region. @@ -63,9 +67,9 @@ type GetIndexOutput struct { 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) - // . + // index and how it differs from a local index, see [Turning on cross-Region search by creating an aggregator index]. + // + // [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 ded7b782edb..90107618060 100644 --- a/service/resourceexplorer2/api_op_GetView.go +++ b/service/resourceexplorer2/api_op_GetView.go @@ -29,8 +29,9 @@ 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)] of the view that you want information about. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ViewArn *string diff --git a/service/resourceexplorer2/api_op_ListIndexes.go b/service/resourceexplorer2/api_op_ListIndexes.go index 3133cee3e63..232f51b2c12 100644 --- a/service/resourceexplorer2/api_op_ListIndexes.go +++ b/service/resourceexplorer2/api_op_ListIndexes.go @@ -36,10 +36,11 @@ type ListIndexesInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // The parameter for receiving additional results if you receive a NextToken @@ -54,8 +55,9 @@ 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 - // account. + // LOCAL or AGGREGATOR . + // + // Use this option to discover the aggregator index for your account. Type types.IndexType noSmithyDocumentSerde @@ -169,10 +171,11 @@ type ListIndexesPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourceexplorer2/api_op_ListIndexesForMembers.go b/service/resourceexplorer2/api_op_ListIndexesForMembers.go index d4b87c9cf41..a22853eb10e 100644 --- a/service/resourceexplorer2/api_op_ListIndexesForMembers.go +++ b/service/resourceexplorer2/api_op_ListIndexesForMembers.go @@ -42,10 +42,11 @@ type ListIndexesForMembersInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // The parameter for receiving additional results if you receive a NextToken @@ -171,10 +172,11 @@ type ListIndexesForMembersPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go b/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go index 7dd40ec10a8..ba1b31a28ed 100644 --- a/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go +++ b/service/resourceexplorer2/api_op_ListSupportedResourceTypes.go @@ -35,10 +35,11 @@ type ListSupportedResourceTypesInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // The parameter for receiving additional results if you receive a NextToken @@ -161,10 +162,11 @@ type ListSupportedResourceTypesPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourceexplorer2/api_op_ListTagsForResource.go b/service/resourceexplorer2/api_op_ListTagsForResource.go index 50d917a2053..fe2a93f8859 100644 --- a/service/resourceexplorer2/api_op_ListTagsForResource.go +++ b/service/resourceexplorer2/api_op_ListTagsForResource.go @@ -28,8 +28,9 @@ 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)] of the view or index that you want to attach tags to. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/resourceexplorer2/api_op_ListViews.go b/service/resourceexplorer2/api_op_ListViews.go index 02bc8ced344..93c3a587cc7 100644 --- a/service/resourceexplorer2/api_op_ListViews.go +++ b/service/resourceexplorer2/api_op_ListViews.go @@ -10,12 +10,15 @@ 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 -// 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 -// response parameter value is null only when there are no more results to display. +// Lists the [Amazon resource names (ARNs)] 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 response +// parameter value is null only when there are no more results to display. +// +// [Amazon resource names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html func (c *Client) ListViews(ctx context.Context, params *ListViewsInput, optFns ...func(*Options)) (*ListViewsOutput, error) { if params == nil { params = &ListViewsInput{} @@ -38,10 +41,11 @@ type ListViewsInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // The parameter for receiving additional results if you receive a NextToken @@ -163,10 +167,11 @@ type ListViewsPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourceexplorer2/api_op_Search.go b/service/resourceexplorer2/api_op_Search.go index 6e63616c744..bda4ba1b76d 100644 --- a/service/resourceexplorer2/api_op_Search.go +++ b/service/resourceexplorer2/api_op_Search.go @@ -12,17 +12,21 @@ import ( ) // Searches for resources and displays details about all resources that match the -// specified criteria. You must specify a query string. All search queries must use -// 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 -// 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) -// . +// specified criteria. You must specify a query string. +// +// All search queries must use 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 supported by the QueryString parameter, see [Search query syntax reference for Resource Explorer]. +// +// If your search results are empty, or are missing results that you think should +// be there, see [Troubleshooting Resource Explorer search]. +// +// [Troubleshooting Resource Explorer search]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/troubleshooting_search.html +// [Search query syntax reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error) { if params == nil { params = &SearchInput{} @@ -41,12 +45,18 @@ func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func 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 - // 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. + // want to include in the results. + // + // For the complete syntax supported by the QueryString parameter, see [Search query syntax reference for Resource Explorer]. + // + // 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. + // + // [Search query syntax reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html // // This member is required. QueryString *string @@ -56,10 +66,11 @@ type SearchInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // The parameter for receiving additional results if you receive a NextToken @@ -69,12 +80,13 @@ type SearchInput struct { // tokens expire after 24 hours. 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)] 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. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ViewArn *string noSmithyDocumentSerde @@ -95,8 +107,9 @@ type SearchOutput struct { // 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)] of the view that this operation used to perform the search. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ViewArn *string // Metadata pertaining to the operation's result. @@ -198,10 +211,11 @@ type SearchPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/resourceexplorer2/api_op_UpdateIndexType.go b/service/resourceexplorer2/api_op_UpdateIndexType.go index 6361f4c3d42..7cb4e5d3828 100644 --- a/service/resourceexplorer2/api_op_UpdateIndexType.go +++ b/service/resourceexplorer2/api_op_UpdateIndexType.go @@ -14,43 +14,61 @@ 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) -// 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. +// Resource Explorer, see [Turning on cross-Region search by creating an aggregator index]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 GetIndexoperation. 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. +// +// [Turning on cross-Region search by creating an aggregator index]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html func (c *Client) UpdateIndexType(ctx context.Context, params *UpdateIndexTypeInput, optFns ...func(*Options)) (*UpdateIndexTypeOutput, error) { if params == nil { params = &UpdateIndexTypeInput{} @@ -68,15 +86,17 @@ 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)] of the index that you want to update. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // 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) - // in the Amazon Web Services Resource Explorer User Guide. + // , see [Turning on cross-Region search]in the Amazon Web Services Resource Explorer User Guide. + // + // [Turning on cross-Region search]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html // // This member is required. Type types.IndexType @@ -86,15 +106,16 @@ 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)] of the index that you updated. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and timestamp when the index was last updated. LastUpdatedAt *time.Time // Indicates the state of the request to update the index. This operation is - // asynchronous. Call the GetIndex operation to check for changes. + // asynchronous. Call the GetIndexoperation to check for changes. State types.IndexState // Specifies the type of the specified index after the operation completes. diff --git a/service/resourceexplorer2/api_op_UpdateView.go b/service/resourceexplorer2/api_op_UpdateView.go index ec34848937c..60ae9510950 100644 --- a/service/resourceexplorer2/api_op_UpdateView.go +++ b/service/resourceexplorer2/api_op_UpdateView.go @@ -30,29 +30,36 @@ 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)] of the view that you want to modify. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ViewArn *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) - // 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) + // queries made using this view. When you use this view in a Searchoperation, 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] in the Amazon Web Services + // Resource Explorer User Guide. + // + // This query string in the context of this operation supports only [filter prefixes] with optional [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 . + // + // [filter prefixes]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters + // [Search query reference for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html + // [operators]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators Filters *types.SearchFilter // Specifies optional fields that you want included in search results from this - // view. It is a list of objects that each describe a field to include. The default - // is an empty list, with no optional fields included in the results. + // view. It is a list of objects that each describe a field to include. + // + // The default is an empty list, with no optional fields included in the results. IncludedProperties []types.IncludedProperty noSmithyDocumentSerde diff --git a/service/resourceexplorer2/doc.go b/service/resourceexplorer2/doc.go index adce473916d..869bff3f18f 100644 --- a/service/resourceexplorer2/doc.go +++ b/service/resourceexplorer2/doc.go @@ -10,22 +10,26 @@ // Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your // resources using resource metadata like names, tags, and IDs. Resource Explorer // can search across all of the Amazon Web Services Regions in your account in -// 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) -// 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) -// 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/) -// . +// 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]in each Region, with the details of that Region's +// resources. +// +// You can [search across all of the indexed Regions in your account] 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], 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]. +// +// [creates and maintains an index]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/getting-started-terms-and-concepts.html#term-index +// [Amazon Web Services Resource Explorer User Guide]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/ +// [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 +// [search across all of the indexed Regions in your account]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html package resourceexplorer2 diff --git a/service/resourceexplorer2/options.go b/service/resourceexplorer2/options.go index a5bab79f58d..2ca4cfee745 100644 --- a/service/resourceexplorer2/options.go +++ b/service/resourceexplorer2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/resourceexplorer2/types/enums.go b/service/resourceexplorer2/types/enums.go index b1ffc552660..855b56ca8b7 100644 --- a/service/resourceexplorer2/types/enums.go +++ b/service/resourceexplorer2/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AWSServiceAccessStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AWSServiceAccessStatus) Values() []AWSServiceAccessStatus { return []AWSServiceAccessStatus{ "ENABLED", @@ -37,8 +38,9 @@ const ( ) // Values returns all known values for IndexState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IndexState) Values() []IndexState { return []IndexState{ "CREATING", @@ -60,8 +62,9 @@ const ( ) // 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. +// in the future, and so 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 385aca22c88..fe5dd47791d 100644 --- a/service/resourceexplorer2/types/errors.go +++ b/service/resourceexplorer2/types/errors.go @@ -37,11 +37,15 @@ func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.F // If you attempted to create a view, then 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. If you attempted to create an index, then the request failed because -// either you specified parameters that didn't match the original request, or an -// index already exists in the current Amazon Web Services Region. If you attempted -// to update an index type to AGGREGATOR , then the request failed because you -// already have an AGGREGATOR index in a different Amazon Web Services Region. +// Region. +// +// If you attempted to create an index, then the request failed because either you +// specified parameters that didn't match the original request, or an index already +// exists in the current Amazon Web Services Region. +// +// If you attempted to update an index type to AGGREGATOR , then the request failed +// because you already have an AGGREGATOR index in a different Amazon Web Services +// Region. type ConflictException struct { Message *string @@ -151,8 +155,9 @@ 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/resource-explorer/latest/userguide/quotas.html) -// . +// more information, see [Quotas for Resource Explorer]. +// +// [Quotas for Resource Explorer]: https://docs.aws.amazon.com/resource-explorer/latest/userguide/quotas.html type ThrottlingException struct { Message *string diff --git a/service/resourceexplorer2/types/types.go b/service/resourceexplorer2/types/types.go index 61d5be67cea..99ff80a62d1 100644 --- a/service/resourceexplorer2/types/types.go +++ b/service/resourceexplorer2/types/types.go @@ -17,8 +17,9 @@ 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)] of the view for which Resource Explorer failed to retrieve details. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ViewArn *string @@ -31,8 +32,10 @@ type BatchGetViewError struct { // 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: + // The name of the property that is included in this view. + // + // You can specify the following property names for this field: + // // - Tags // // This member is required. @@ -44,25 +47,29 @@ type IncludedProperty struct { // 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. +// 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 UpdateIndexTypeto 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)] of the index. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 @@ -81,16 +88,19 @@ type MemberIndex struct { // The account ID for the index. AccountId *string - // 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)] of the index. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 @@ -124,8 +134,9 @@ type OrgConfiguration struct { // 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)] of the resource. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The date and time that Resource Explorer last queried this resource and updated @@ -156,13 +167,17 @@ type Resource struct { // Information about the number of results that match the query. At this time, // Amazon Web Services Resource Explorer doesn't count more than 1,000 matches for // any query. This structure provides information about whether the query exceeded -// this limit. This field is included in every page when you paginate the results. +// this limit. +// +// This field is included in every page when you paginate the results. 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. Complete *bool @@ -198,9 +213,9 @@ type ResourceProperty struct { 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) - // . + // control the results that can be returned by a Searchoperation. For more details, see [Search query syntax]. + // + // [Search query syntax]: https://docs.aws.amazon.com/resource-explorer/latest/APIReference/about-query-syntax.html // // This member is required. FilterString *string @@ -247,8 +262,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. @@ -260,16 +275,20 @@ 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 - // 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. + // An [Amazon resource name (ARN)] 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. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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)] of the view. + // + // [Amazon resource name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ViewArn *string noSmithyDocumentSerde diff --git a/service/resourcegroups/api_op_CreateGroup.go b/service/resourcegroups/api_op_CreateGroup.go index 769ec804893..65ca6feec22 100644 --- a/service/resourcegroups/api_op_CreateGroup.go +++ b/service/resourcegroups/api_op_CreateGroup.go @@ -13,14 +13,18 @@ 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: +// information about constructing a resource query, see [Build queries and groups in Resource Groups]in the Resource Groups +// User Guide. For more information about service-linked groups and service +// configurations, see [Service configurations for Resource Groups]. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:CreateGroup +// +// [Build queries and groups in Resource Groups]: https://docs.aws.amazon.com/ARG/latest/userguide/getting_started-query.html +// [Service configurations for Resource Groups]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -50,11 +54,13 @@ type CreateGroupInput struct { // 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 - // 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. + // group. A configuration is an array of GroupConfigurationItemelements. For details about the syntax of + // service configurations, see [Service configurations for Resource Groups]. + // + // A resource group can contain either a Configuration or a ResourceQuery , but not + // both. + // + // [Service configurations for Resource Groups]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html Configuration []types.GroupConfigurationItem // The description of the resource group. Descriptions can consist of letters, @@ -62,10 +68,12 @@ 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]. + // + // A resource group can contain either a ResourceQuery or a Configuration , but not + // both. + // + // [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 to add to the group. A tag is key-value pair string. @@ -80,13 +88,15 @@ type CreateGroupOutput struct { Group *types.Group // 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) . + // the syntax of a service configuration, see [Service configurations for Resource Groups]. + // + // [Service configurations for Resource 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]. + // + // [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 91454c342b2..ce951aca0d1 100644 --- a/service/resourcegroups/api_op_DeleteGroup.go +++ b/service/resourcegroups/api_op_DeleteGroup.go @@ -13,8 +13,12 @@ import ( // Deletes the specified resource group. Deleting a resource group does not delete // 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: +// structure. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:DeleteGroup func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error) { if params == nil { diff --git a/service/resourcegroups/api_op_GetGroup.go b/service/resourcegroups/api_op_GetGroup.go index 476cd8a8993..2e7fd1b0e0e 100644 --- a/service/resourcegroups/api_op_GetGroup.go +++ b/service/resourcegroups/api_op_GetGroup.go @@ -11,8 +11,12 @@ 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: +// 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 { @@ -45,8 +49,7 @@ 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. + // group. Use GetGroupQueryand 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 0c24bd9d6b0..026454178bd 100644 --- a/service/resourcegroups/api_op_GetGroupConfiguration.go +++ b/service/resourcegroups/api_op_GetGroupConfiguration.go @@ -12,11 +12,15 @@ 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: +// group. For details about the service configuration syntax, see [Service configurations for Resource Groups]. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:GetGroupConfiguration +// +// [Service configurations for Resource Groups]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html func (c *Client) GetGroupConfiguration(ctx context.Context, params *GetGroupConfigurationInput, optFns ...func(*Options)) (*GetGroupConfigurationOutput, error) { if params == nil { params = &GetGroupConfigurationInput{} @@ -44,9 +48,9 @@ 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) - // . + // specified group. For details about the service configuration syntax, see [Service configurations for Resource Groups]. + // + // [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 7957f90e4d6..16a2b8ad4b3 100644 --- a/service/resourcegroups/api_op_GetGroupQuery.go +++ b/service/resourcegroups/api_op_GetGroupQuery.go @@ -12,11 +12,15 @@ 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 -// permissions: +// more information about resource queries, see [Create a tag-based group in Resource Groups]. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:GetGroupQuery +// +// [Create a tag-based group in Resource Groups]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag func (c *Client) GetGroupQuery(ctx context.Context, params *GetGroupQueryInput, optFns ...func(*Options)) (*GetGroupQueryOutput, error) { if params == nil { params = &GetGroupQueryInput{} @@ -48,8 +52,9 @@ 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]. + // + // [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 d10d7587222..c14695ca530 100644 --- a/service/resourcegroups/api_op_GetTags.go +++ b/service/resourcegroups/api_op_GetTags.go @@ -11,8 +11,12 @@ 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: +// an ARN. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:GetTags func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...func(*Options)) (*GetTagsOutput, error) { if params == nil { diff --git a/service/resourcegroups/api_op_GroupResources.go b/service/resourcegroups/api_op_GroupResources.go index c8d807d00dd..e4ba3dcbb04 100644 --- a/service/resourcegroups/api_op_GroupResources.go +++ b/service/resourcegroups/api_op_GroupResources.go @@ -11,14 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds the specified resources to the specified group. You can use this operation -// with only resource groups that are configured with the following types: +// 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 // // 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: +// operation. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:GroupResources func (c *Client) GroupResources(ctx context.Context, params *GroupResourcesInput, optFns ...func(*Options)) (*GroupResourcesOutput, error) { if params == nil { @@ -57,9 +65,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 ListGroupResourcesoperation, 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 bbad0a72aaa..6d9a6779bf5 100644 --- a/service/resourcegroups/api_op_ListGroupResources.go +++ b/service/resourcegroups/api_op_ListGroupResources.go @@ -12,11 +12,18 @@ import ( ) // 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 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 { @@ -35,31 +42,35 @@ func (c *Client) ListGroupResources(ctx context.Context, params *ListGroupResour 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. + // 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). + // 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 Group *string - // Deprecated - don't use this parameter. Use the Group request field instead. + // Deprecated - don't use this parameter. Use the Group request field instead. // // Deprecated: This field is deprecated, use Group instead. GroupName *string @@ -98,7 +109,8 @@ type ListGroupResourcesOutput struct { // RESOURCE_TYPE_NOT_SUPPORTED . QueryErrors []types.QueryError - // Deprecated - don't use this parameter. Use the Resources response field instead. + // Deprecated - don't use this parameter. Use the Resources response field + // instead. // // Deprecated: This field is deprecated, use Resources instead. ResourceIdentifiers []types.ResourceIdentifier diff --git a/service/resourcegroups/api_op_ListGroups.go b/service/resourcegroups/api_op_ListGroups.go index ad8d2780a5a..7ebf338e879 100644 --- a/service/resourcegroups/api_op_ListGroups.go +++ b/service/resourcegroups/api_op_ListGroups.go @@ -11,8 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of existing Resource Groups in your account. Minimum permissions +// 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 func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error) { if params == nil { @@ -31,20 +35,28 @@ func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns type ListGroupsInput struct { - // Filters, formatted as GroupFilter objects, that you want to apply to a - // ListGroups operation. + // Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups + // operation. + // // - resource-type - Filter the results to include only those resource groups // that have the specified resource type in their ResourceTypeFilter . For // example, AWS::EC2::Instance would return any resource group with a // ResourceTypeFilter that includes AWS::EC2::Instance . + // // - configuration-type - Filter the results to include only those groups that // have the specified configuration types attached. The current supported values // are: + // // - AWS::AppRegistry::Application + // // - AWS::AppRegistry::ApplicationResourceGroups + // // - AWS::CloudFormation::Stack + // // - AWS::EC2::CapacityReservationPool + // // - AWS::EC2::HostManagement + // // - AWS::NetworkFirewall::RuleGroup Filters []types.GroupFilter @@ -70,11 +82,11 @@ type ListGroupsInput struct { type ListGroupsOutput struct { - // A list of GroupIdentifier objects. Each identifier is an object that contains - // both the Name and the GroupArn . + // A list of GroupIdentifier objects. Each identifier is an object that contains both the Name + // and the GroupArn . GroupIdentifiers []types.GroupIdentifier - // Deprecated - don't use this field. Use the GroupIdentifiers response field + // Deprecated - don't use this field. Use the GroupIdentifiers response field // instead. // // Deprecated: This field is deprecated, use GroupIdentifiers instead. diff --git a/service/resourcegroups/api_op_PutGroupConfiguration.go b/service/resourcegroups/api_op_PutGroupConfiguration.go index f9fbb5fd007..202111bc986 100644 --- a/service/resourcegroups/api_op_PutGroupConfiguration.go +++ b/service/resourcegroups/api_op_PutGroupConfiguration.go @@ -12,9 +12,13 @@ import ( ) // Attaches a service configuration to the specified group. This occurs -// 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: +// asynchronously, and can take time to complete. You can use GetGroupConfigurationto check the status +// of the update. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:PutGroupConfiguration func (c *Client) PutGroupConfiguration(ctx context.Context, params *PutGroupConfigurationInput, optFns ...func(*Options)) (*PutGroupConfigurationOutput, error) { if params == nil { @@ -36,10 +40,14 @@ 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 GroupConfigurationItemelements. + // + // For information about the syntax of a service configuration, see [Service configurations for Resource Groups]. + // + // A resource group can contain either a Configuration or a ResourceQuery , but not + // both. + // + // [Service configurations for Resource Groups]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html 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 40ddc3720e9..c81ec8c0a3c 100644 --- a/service/resourcegroups/api_op_SearchResources.go +++ b/service/resourcegroups/api_op_SearchResources.go @@ -12,12 +12,19 @@ import ( ) // Returns a list of Amazon Web Services resource identifiers that matches the -// 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: +// specified query. The query uses the same format as a resource query in a CreateGroupor UpdateGroupQuery +// operation. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - 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 { @@ -37,7 +44,7 @@ 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 @@ -71,9 +78,13 @@ type SearchResourcesOutput struct { NextToken *string // A list of QueryError objects. Each error contains an ErrorCode and Message . + // // Possible values for ErrorCode : + // // - CLOUDFORMATION_STACK_INACTIVE + // // - CLOUDFORMATION_STACK_NOT_EXISTING + // // - CLOUDFORMATION_STACK_UNASSUMABLE_ROLE QueryErrors []types.QueryError diff --git a/service/resourcegroups/api_op_Tag.go b/service/resourcegroups/api_op_Tag.go index 8e64f01b417..af5aff740c6 100644 --- a/service/resourcegroups/api_op_Tag.go +++ b/service/resourcegroups/api_op_Tag.go @@ -12,11 +12,17 @@ import ( // Adds tags to a resource group with the specified ARN. Existing tags on a // resource group are not changed if they are not specified in the request -// parameters. 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 To run this command, you must -// have the following permissions: +// parameters. +// +// 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 +// +// To run this command, you must have the following permissions: +// // - resource-groups:Tag func (c *Client) Tag(ctx context.Context, params *TagInput, optFns ...func(*Options)) (*TagOutput, error) { if params == nil { diff --git a/service/resourcegroups/api_op_UngroupResources.go b/service/resourcegroups/api_op_UngroupResources.go index 68488830523..abfb7226212 100644 --- a/service/resourcegroups/api_op_UngroupResources.go +++ b/service/resourcegroups/api_op_UngroupResources.go @@ -12,10 +12,14 @@ import ( ) // Removes the specified resources from the specified group. This operation works -// only with static groups that you populated using the GroupResources operation. -// 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: +// only with static groups that you populated using the GroupResourcesoperation. 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 func (c *Client) UngroupResources(ctx context.Context, params *UngroupResourcesInput, optFns ...func(*Options)) (*UngroupResourcesOutput, error) { if params == nil { @@ -55,9 +59,8 @@ type UngroupResourcesOutput struct { // A list of any resources that are still in the process of being removed from the // group by this operation. These pending removals continue asynchronously. You can - // check the status of pending removals by using the ListGroupResources operation. - // After the resource is successfully removed, it no longer appears in the - // response. + // check the status of pending removals by using the ListGroupResourcesoperation. After the resource + // is successfully removed, it no longer appears in the response. Pending []types.PendingResource // A list of resources that were successfully removed from the group by this diff --git a/service/resourcegroups/api_op_Untag.go b/service/resourcegroups/api_op_Untag.go index 595c84ca432..8ad00ce43f1 100644 --- a/service/resourcegroups/api_op_Untag.go +++ b/service/resourcegroups/api_op_Untag.go @@ -10,8 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes tags from a specified resource group. Minimum permissions To run this -// command, you must have the following permissions: +// Deletes tags from a specified resource group. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:Untag func (c *Client) Untag(ctx context.Context, params *UntagInput, optFns ...func(*Options)) (*UntagOutput, error) { if params == nil { diff --git a/service/resourcegroups/api_op_UpdateAccountSettings.go b/service/resourcegroups/api_op_UpdateAccountSettings.go index c1afb526e48..81e1511f181 100644 --- a/service/resourcegroups/api_op_UpdateAccountSettings.go +++ b/service/resourcegroups/api_op_UpdateAccountSettings.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error) { if params == nil { params = &UpdateAccountSettingsInput{} @@ -32,8 +33,9 @@ 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] on or off. + // + // [group lifecycle events]: https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html GroupLifecycleEventsDesiredStatus types.GroupLifecycleEventsDesiredStatus noSmithyDocumentSerde diff --git a/service/resourcegroups/api_op_UpdateGroup.go b/service/resourcegroups/api_op_UpdateGroup.go index 0e84463610a..ae0b364ce97 100644 --- a/service/resourcegroups/api_op_UpdateGroup.go +++ b/service/resourcegroups/api_op_UpdateGroup.go @@ -12,8 +12,12 @@ 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 group. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:UpdateGroup func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error) { if params == nil { diff --git a/service/resourcegroups/api_op_UpdateGroupQuery.go b/service/resourcegroups/api_op_UpdateGroupQuery.go index ed5df5c1019..503bc6c8bcc 100644 --- a/service/resourcegroups/api_op_UpdateGroupQuery.go +++ b/service/resourcegroups/api_op_UpdateGroupQuery.go @@ -12,10 +12,15 @@ 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 -// permissions: +// queries, see [Create a tag-based group in Resource Groups]. +// +// # Minimum permissions +// +// To run this command, you must have the following permissions: +// // - resource-groups:UpdateGroupQuery +// +// [Create a tag-based group in Resource Groups]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag func (c *Client) UpdateGroupQuery(ctx context.Context, params *UpdateGroupQueryInput, optFns ...func(*Options)) (*UpdateGroupQueryOutput, error) { if params == nil { params = &UpdateGroupQueryInput{} @@ -34,8 +39,10 @@ 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 40cbebe4cbf..25fb389f0c9 100644 --- a/service/resourcegroups/doc.go +++ b/service/resourcegroups/doc.go @@ -15,17 +15,28 @@ // resources in Amazon Web Services Systems Manager. Groups of tagged resources // also let you quickly view a custom console in Amazon Web Services Systems // Manager that shows Config compliance and other monitoring data about member -// 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 +// 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]. +// +// 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 +// +// [Resource Groups User Guide]: https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html package resourcegroups diff --git a/service/resourcegroups/options.go b/service/resourcegroups/options.go index c941e8dd7f8..aa2831b55c5 100644 --- a/service/resourcegroups/options.go +++ b/service/resourcegroups/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/resourcegroups/types/enums.go b/service/resourcegroups/types/enums.go index 660ffc23800..eeaf6600612 100644 --- a/service/resourcegroups/types/enums.go +++ b/service/resourcegroups/types/enums.go @@ -13,6 +13,7 @@ const ( // 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{ @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for GroupFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupFilterName) Values() []GroupFilterName { return []GroupFilterName{ "resource-type", @@ -50,8 +52,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupLifecycleEventsDesiredStatus) Values() []GroupLifecycleEventsDesiredStatus { return []GroupLifecycleEventsDesiredStatus{ "ACTIVE", @@ -71,6 +74,7 @@ const ( // Values returns all known values for GroupLifecycleEventsStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (GroupLifecycleEventsStatus) Values() []GroupLifecycleEventsStatus { return []GroupLifecycleEventsStatus{ @@ -92,8 +96,9 @@ const ( ) // Values returns all known values for QueryErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryErrorCode) Values() []QueryErrorCode { return []QueryErrorCode{ "CLOUDFORMATION_STACK_INACTIVE", @@ -112,8 +117,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for ResourceFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceFilterName) Values() []ResourceFilterName { return []ResourceFilterName{ "resource-type", @@ -145,8 +152,9 @@ const ( ) // Values returns all known values for ResourceStatusValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStatusValue) Values() []ResourceStatusValue { return []ResourceStatusValue{ "PENDING", diff --git a/service/resourcegroups/types/types.go b/service/resourcegroups/types/types.go index e72655fdb6b..4318c440435 100644 --- a/service/resourcegroups/types/types.go +++ b/service/resourcegroups/types/types.go @@ -40,14 +40,17 @@ 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 PutGroupConfigurationoperation. +// +// 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,10 +72,10 @@ 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 -// 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) -// . +// service configuration when you create the group by using CreateGroup, or later by using +// the PutGroupConfigurationoperation. For details about group service configuration syntax, see [Service configurations for resource groups]. +// +// [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. @@ -92,45 +95,47 @@ 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) -// . +// more items. For details about group service configuration syntax, see [Service configurations for resource groups]. +// +// [Service 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) - // . + // item, see [Supported resource types and parameters]. + // + // [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) - // . + // parameters that you can use with each configuration item type, see [Supported resource types and parameters]. + // + // [Supported 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]. +// +// [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) - // . + // you can use with each configuration item type, see [Supported resource types and parameters]. + // + // [Supported resource types and 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) - // . + // values you can use with each parameter, see [Supported resource types and parameters]. + // + // [Supported resource types and parameters]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types Values []string noSmithyDocumentSerde @@ -185,15 +190,16 @@ type GroupQuery struct { noSmithyDocumentSerde } -// A structure returned by the ListGroupResources operation that contains identity -// and group membership status information for one of the resources in the group. +// A structure returned by the ListGroupResources operation that contains identity and group +// membership status information for one of the resources in the group. 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 + // 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 @@ -257,74 +263,105 @@ type ResourceIdentifier struct { // The query you can use to define a resource group or a search for resources. A // 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 -// 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 -// '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}' +// about creating a resource group with a resource query, see [Build queries and groups in Resource Groups]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 +// '{"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) -// 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: -// "ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"] +// double quotes. For more information, see [Quoting strings]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] in the Resource Groups User Guide. For example: +// +// "ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"] +// +// [Quoting strings]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html +// [Resources you can use with Resource Groups and Tag Editor]: https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html +// [Build queries and groups in Resource Groups]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html 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"] + // that you can use in the array value for ResourceTypeFilters , see [Resources you can use with Resource Groups and Tag Editor]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. + // string uses a syntax similar to the [GetResources]operation, but uses only the [ResourceTypeFilters]and [TagFilters]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. + // {"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. + // + // 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" ] } + // {"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. // + // [Resources you can use with Resource Groups and Tag Editor]: https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html + // [TagFilters]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-TagFiltersTagFilters + // [GetResources]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html + // [ResourceTypeFilters]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters + // // 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. // diff --git a/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go b/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go index dd581c9bcb7..35a79f8fafc 100644 --- a/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go +++ b/service/resourcegroupstaggingapi/api_op_DescribeReportCreation.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the status of the StartReportCreation operation. You can call this -// operation only from the organization's management account and from the us-east-1 -// Region. +// Describes the status of the StartReportCreation operation. +// +// You can call this operation only from the organization's management account and +// from the us-east-1 Region. func (c *Client) DescribeReportCreation(ctx context.Context, params *DescribeReportCreationInput, optFns ...func(*Options)) (*DescribeReportCreationOutput, error) { if params == nil { params = &DescribeReportCreationInput{} @@ -43,13 +44,18 @@ type DescribeReportCreationOutput struct { // The date and time that the report was started. StartDate *string - // Reports the status of the operation. The operation status can be one of the - // following: + // 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. Status *string diff --git a/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go b/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go index df40dcf2496..aa16b7bedf8 100644 --- a/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go +++ b/service/resourcegroupstaggingapi/api_op_GetComplianceSummary.go @@ -12,15 +12,21 @@ 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) -// 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 -// should check the PaginationToken response parameter to determine if there are -// additional results available to return. Repeat the query, passing the +// tag policies. +// +// For more information on tag policies, see [Tag Policies] 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 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. +// +// [Tag Policies]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html func (c *Client) GetComplianceSummary(ctx context.Context, params *GetComplianceSummaryInput, optFns ...func(*Options)) (*GetComplianceSummaryOutput, error) { if params == nil { params = &GetComplianceSummaryInput{} @@ -63,21 +69,25 @@ type GetComplianceSummaryInput struct { // of the specified types. The format 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). 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) - // . + // 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]for the following: + // + // - For a list of service name strings, see [Amazon Web Services Service Namespaces]. + // + // - For resource type strings, see [Example ARNs]. + // + // - For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]. + // // 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. + // + // [Example ARNs]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax + // [Amazon Web Services General Reference]: https://docs.aws.amazon.com/general/latest/gr/ + // [Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html ResourceTypeFilters []string // Specifies that you want the response to include information for only resources diff --git a/service/resourcegroupstaggingapi/api_op_GetResources.go b/service/resourcegroupstaggingapi/api_op_GetResources.go index 67a1cae0a7e..f8d9dd39588 100644 --- a/service/resourcegroupstaggingapi/api_op_GetResources.go +++ b/service/resourcegroupstaggingapi/api_op_GetResources.go @@ -12,13 +12,16 @@ 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: +// 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. +// more information on tag policies, see [Tag Policies]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 @@ -26,6 +29,8 @@ import ( // 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. +// +// [Tag Policies]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html func (c *Client) GetResources(ctx context.Context, params *GetResourcesInput, optFns ...func(*Options)) (*GetResourcesOutput, error) { if params == nil { params = &GetResourcesInput{} @@ -45,8 +50,10 @@ 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 . + // 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 @@ -62,27 +69,36 @@ type GetResourcesInput struct { // 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 - // 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. + // 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]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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 // 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 + // 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]. + // + // 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 + // resource: + // + // ec2:instance,s3:bucket,auditmanager + // + // [Services that support the Resource Groups Tagging API]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html ResourceTypeFilters []string // Specifies the maximum number of results to be returned in each page. A query @@ -96,42 +112,55 @@ type GetResourcesInput struct { // those resources that have tags with the specified keys and, if included, the // 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}} , + // 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 diff --git a/service/resourcegroupstaggingapi/api_op_GetTagKeys.go b/service/resourcegroupstaggingapi/api_op_GetTagKeys.go index 7e441991f42..191e88720b7 100644 --- a/service/resourcegroupstaggingapi/api_op_GetTagKeys.go +++ b/service/resourcegroupstaggingapi/api_op_GetTagKeys.go @@ -11,13 +11,14 @@ import ( ) // Returns all tag keys currently in use in the specified Amazon Web Services -// Region for the calling account. 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. +// Region for the calling account. +// +// 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) GetTagKeys(ctx context.Context, params *GetTagKeysInput, optFns ...func(*Options)) (*GetTagKeysOutput, error) { if params == nil { params = &GetTagKeysInput{} diff --git a/service/resourcegroupstaggingapi/api_op_GetTagValues.go b/service/resourcegroupstaggingapi/api_op_GetTagValues.go index 763b0e00df6..0a82cce0e65 100644 --- a/service/resourcegroupstaggingapi/api_op_GetTagValues.go +++ b/service/resourcegroupstaggingapi/api_op_GetTagValues.go @@ -11,13 +11,14 @@ import ( ) // Returns all tag values for the specified key that are used in the specified -// Amazon Web Services Region for the calling account. 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. +// Amazon Web Services Region for the calling account. +// +// 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) GetTagValues(ctx context.Context, params *GetTagValuesInput, optFns ...func(*Options)) (*GetTagValuesOutput, error) { if params == nil { params = &GetTagValuesInput{} diff --git a/service/resourcegroupstaggingapi/api_op_StartReportCreation.go b/service/resourcegroupstaggingapi/api_op_StartReportCreation.go index d8034e9589c..d93c00fc15c 100644 --- a/service/resourcegroupstaggingapi/api_op_StartReportCreation.go +++ b/service/resourcegroupstaggingapi/api_op_StartReportCreation.go @@ -13,8 +13,12 @@ import ( // Generates a report that lists all tagged resources in the accounts across your // organization and tells whether each resource is compliant with the effective tag // policy. Compliance data is refreshed daily. The report is generated -// asynchronously. The generated report is saved to the following location: -// s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv +// asynchronously. +// +// The generated report is saved to the following location: +// +// s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv +// // You can call this operation only from the organization's management account and // from the us-east-1 Region. func (c *Client) StartReportCreation(ctx context.Context, params *StartReportCreationInput, optFns ...func(*Options)) (*StartReportCreationOutput, error) { @@ -35,8 +39,11 @@ func (c *Client) StartReportCreation(ctx context.Context, params *StartReportCre type StartReportCreationInput struct { // The name of the Amazon S3 bucket where the report will be stored; for example: - // awsexamplebucket For more information on S3 bucket requirements, including an - // example bucket policy, see the example S3 bucket policy on this page. + // + // awsexamplebucket + // + // For more information on S3 bucket requirements, including an example bucket + // policy, see the example S3 bucket policy on this page. // // This member is required. S3Bucket *string diff --git a/service/resourcegroupstaggingapi/api_op_TagResources.go b/service/resourcegroupstaggingapi/api_op_TagResources.go index 513a9dedb6a..b9d792b0350 100644 --- a/service/resourcegroupstaggingapi/api_op_TagResources.go +++ b/service/resourcegroupstaggingapi/api_op_TagResources.go @@ -12,17 +12,19 @@ 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. +// support tagging using this operation, see [Services that support the Resource Groups Tagging API]. 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]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. @@ -30,13 +32,21 @@ import ( // 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: +// 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 +// +// [Services that support the Resource Groups Tagging API]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html +// [Tag Naming and Usage Conventions]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions func (c *Client) TagResources(ctx context.Context, params *TagResourcesInput, optFns ...func(*Options)) (*TagResourcesOutput, error) { if params == nil { params = &TagResourcesInput{} @@ -54,10 +64,12 @@ func (c *Client) TagResources(ctx context.Context, params *TagResourcesInput, op 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. + // 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]in the Amazon Web Services General Reference. + // + // [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. ResourceARNList []string diff --git a/service/resourcegroupstaggingapi/api_op_UntagResources.go b/service/resourcegroupstaggingapi/api_op_UntagResources.go index 53dfc8d7822..f2be3823a68 100644 --- a/service/resourcegroupstaggingapi/api_op_UntagResources.go +++ b/service/resourcegroupstaggingapi/api_op_UntagResources.go @@ -15,19 +15,25 @@ 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. // -// 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: +// # 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 { @@ -46,10 +52,12 @@ func (c *Client) UntagResources(ctx context.Context, params *UntagResourcesInput 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. + // 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]in the Amazon Web Services General Reference. + // + // [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. ResourceARNList []string diff --git a/service/resourcegroupstaggingapi/options.go b/service/resourcegroupstaggingapi/options.go index 247ed084c7c..6152fc36a0c 100644 --- a/service/resourcegroupstaggingapi/options.go +++ b/service/resourcegroupstaggingapi/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/resourcegroupstaggingapi/types/enums.go b/service/resourcegroupstaggingapi/types/enums.go index 5ae5dfdac41..3656674edce 100644 --- a/service/resourcegroupstaggingapi/types/enums.go +++ b/service/resourcegroupstaggingapi/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for GroupByAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupByAttribute) Values() []GroupByAttribute { return []GroupByAttribute{ "TARGET_ID", @@ -50,8 +52,9 @@ const ( ) // 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. +// expanded in the future, and so 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 e53cad8aa8b..145310c411e 100644 --- a/service/resourcegroupstaggingapi/types/errors.go +++ b/service/resourcegroupstaggingapi/types/errors.go @@ -35,17 +35,22 @@ func (e *ConcurrentModificationException) ErrorCode() string { func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// see [Prerequisites and Permissions for Using Tag Policies]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) -// . +// information, see [EnableAWSServiceAccess]. +// // - You must have a tag policy attached to the organization root, an OU, or an // account. +// +// [EnableAWSServiceAccess]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html +// [Prerequisites and Permissions for Using Tag Policies]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html type ConstraintViolationException struct { Message *string @@ -99,14 +104,19 @@ 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. +// information, see [Additional Requirements for Organization-wide Tag Compliance Reports]in the Organizations User Guide. +// +// [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 type InvalidParameterException struct { Message *string diff --git a/service/resourcegroupstaggingapi/types/types.go b/service/resourcegroupstaggingapi/types/types.go index cb3b81aa3ae..399a079a596 100644 --- a/service/resourcegroupstaggingapi/types/types.go +++ b/service/resourcegroupstaggingapi/types/types.go @@ -26,24 +26,29 @@ type ComplianceDetails struct { // Information about the errors that are returned for each failed resource. This // information can include InternalServiceException and InvalidParameterException // errors. It can also include any valid error code returned by the Amazon Web -// 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: +// 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. +// [GetResources]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. +// CloudWatch alarm resource, you need permission to call both [TagResources]TagResources and [TagResource] +// TagResource in the CloudWatch API. // // For more information on errors that are generated from other Amazon Web // Services services, see the documentation for that service. +// +// [TagResource]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html +// [TagResources]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html +// [GetResources]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html type FailureInfo struct { // The code of the common error. Valid values include InternalServiceException , @@ -93,8 +98,9 @@ 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) - // API. + // know the root ID, you can call the Organizations [ListRoots]API. + // + // [ListRoots]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html TargetId *string // Whether the target is an account, an OU, or the organization root. @@ -105,9 +111,10 @@ type Summary struct { // The metadata that you apply to Amazon Web Services resources to help you // categorize and organize them. Each tag consists of a key and a value, both of -// which you define. 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. +// which you define. For more information, see [Tagging Amazon Web Services Resources]in the Amazon Web Services General +// Reference. +// +// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.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/robomaker/api_op_CancelDeploymentJob.go b/service/robomaker/api_op_CancelDeploymentJob.go index 2ba76110aee..38c54797726 100644 --- a/service/robomaker/api_op_CancelDeploymentJob.go +++ b/service/robomaker/api_op_CancelDeploymentJob.go @@ -10,9 +10,10 @@ 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 -// Service. +// 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 // ended. For additional information, see diff --git a/service/robomaker/api_op_CreateDeploymentJob.go b/service/robomaker/api_op_CreateDeploymentJob.go index dc0e3b75ade..4ba70c9fa0a 100644 --- a/service/robomaker/api_op_CreateDeploymentJob.go +++ b/service/robomaker/api_op_CreateDeploymentJob.go @@ -12,17 +12,21 @@ 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]. +// +// 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 // the AWS RoboMaker application deployment feature has ended. For additional // information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html. +// +// [Creating a Robot Application Version]: https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html func (c *Client) CreateDeploymentJob(ctx context.Context, params *CreateDeploymentJobInput, optFns ...func(*Options)) (*CreateDeploymentJobOutput, error) { if params == nil { params = &CreateDeploymentJobInput{} @@ -80,26 +84,45 @@ type CreateDeploymentJobOutput struct { // The deployment configuration. DeploymentConfig *types.DeploymentConfig - // 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 - // bundle. FailureThresholdBreached The percentage of robots that could not be - // updated exceeded the percentage set for the deployment. + // 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] + // AWSGreengrassResourceAccessRolePolicy . + // + // 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 - // robot. GreengrassGroupVersionDoesNotExist The AWS Greengrass group or version - // associated with a robot is missing. InternalServerError An internal error has - // occurred. Retry your request, but if the problem persists, contact us with - // details. MissingRobotApplicationArchitecture The robot application does not have - // a source that matches the architecture of the robot. + // robot. + // + // GreengrassGroupVersionDoesNotExist The AWS Greengrass group or version + // associated with a robot is missing. + // + // InternalServerError An internal error has occurred. Retry your request, but if + // the problem persists, contact us with details. + // + // MissingRobotApplicationArchitecture The robot application does not have a + // source that matches the architecture of the robot. + // // MissingRobotDeploymentResource One or more of the resources specified for the // robot application are missing. For example, does the robot application have the - // correct launch package and launch file? PostLaunchFileFailure The post-launch - // script failed. PreLaunchFileFailure The pre-launch script failed. + // correct launch package and launch file? + // + // PostLaunchFileFailure The post-launch script failed. + // + // PreLaunchFileFailure The pre-launch script failed. + // // ResourceNotFound One or more deployment resources are missing. For example, do - // robot application source bundles still exist? RobotDeploymentNoResponse There is - // no response from the robot. It might not be powered on or connected to the - // internet. + // robot application source bundles still exist? + // + // RobotDeploymentNoResponse There is no response from the robot. It might not be + // powered on or connected to the internet. + // + // [AWSGreengrassResourceAccessRolePolicy managed policy]: https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor FailureCode types.DeploymentJobErrorCode // The failure reason of the deployment job if it failed. diff --git a/service/robomaker/api_op_CreateFleet.go b/service/robomaker/api_op_CreateFleet.go index 2fc05e8e451..7fd680c82d1 100644 --- a/service/robomaker/api_op_CreateFleet.go +++ b/service/robomaker/api_op_CreateFleet.go @@ -12,6 +12,7 @@ import ( ) // Creates a fleet, a logical group of robots running the same robot application. +// // This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is unable to process this request as the support for diff --git a/service/robomaker/api_op_CreateRobot.go b/service/robomaker/api_op_CreateRobot.go index 782765c1ff1..3bd58a506ba 100644 --- a/service/robomaker/api_op_CreateRobot.go +++ b/service/robomaker/api_op_CreateRobot.go @@ -12,8 +12,9 @@ import ( "time" ) -// Creates a robot. This API is no longer supported and will throw an error if -// used. +// Creates a robot. +// +// This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is unable to process this request as the support for // the AWS RoboMaker application deployment feature has ended. For additional diff --git a/service/robomaker/api_op_CreateSimulationJob.go b/service/robomaker/api_op_CreateSimulationJob.go index 0584709e579..a21e8984981 100644 --- a/service/robomaker/api_op_CreateSimulationJob.go +++ b/service/robomaker/api_op_CreateSimulationJob.go @@ -12,8 +12,10 @@ import ( "time" ) -// Creates a simulation job. After 90 days, simulation jobs expire and will be -// deleted. They will no longer be accessible. +// Creates a simulation job. +// +// After 90 days, simulation jobs expire and will be deleted. They will no longer +// be accessible. func (c *Client) CreateSimulationJob(ctx context.Context, params *CreateSimulationJobInput, optFns ...func(*Options)) (*CreateSimulationJobOutput, error) { if params == nil { params = &CreateSimulationJobInput{} @@ -54,13 +56,17 @@ type CreateSimulationJobInput struct { // Specify data sources to mount read-only files from S3 into your simulation. // 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 - // The failure behavior the simulation job. Continue Leaves the instance running - // for its maximum timeout duration after a 4XX error code. Fail Stop the - // simulation job and terminate the instance. + // The failure behavior the simulation job. + // + // Continue Leaves the instance running for its maximum timeout duration after a + // 4XX error code. + // + // Fail Stop the simulation job and terminate the instance. FailureBehavior types.FailureBehavior // The logging configuration. @@ -105,22 +111,41 @@ type CreateSimulationJobOutput struct { // the failure behavior for the simulation job. FailureBehavior types.FailureBehavior - // The failure code of the simulation job if it failed: InternalServiceError - // Internal service error. RobotApplicationCrash Robot application exited - // abnormally. SimulationApplicationCrash Simulation application exited abnormally. + // The failure code of the simulation job if it failed: + // + // InternalServiceError Internal service error. + // + // RobotApplicationCrash Robot application exited abnormally. + // + // SimulationApplicationCrash Simulation application exited abnormally. + // // BadPermissionsRobotApplication Robot application bundle could not be downloaded. + // // BadPermissionsSimulationApplication Simulation application bundle could not be - // downloaded. BadPermissionsS3Output Unable to publish outputs to - // customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs - // to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP - // limit exceeded. ENILimitExceeded ENI limit exceeded. + // downloaded. + // + // BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. + // + // BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided + // CloudWatch Logs resource. + // + // SubnetIpLimitExceeded Subnet IP limit exceeded. + // + // ENILimitExceeded ENI limit exceeded. + // // BadPermissionsUserCredentials Unable to use the Role provided. + // // InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, - // bundling error, or other issue). InvalidBundleSimulationApplication Simulation - // bundle cannot be extracted (invalid format, bundling error, or other issue). + // bundling error, or other issue). + // + // InvalidBundleSimulationApplication Simulation bundle cannot be extracted + // (invalid format, bundling error, or other issue). + // // RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match - // value during version creation. SimulationApplicationVersionMismatchedEtag Etag - // for SimulationApplication does not match value during version creation. + // value during version creation. + // + // SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does + // not match value during version creation. FailureCode types.SimulationJobErrorCode // The IAM role that allows the simulation job to call the AWS APIs that are diff --git a/service/robomaker/api_op_CreateWorldExportJob.go b/service/robomaker/api_op_CreateWorldExportJob.go index f60de2abd82..0f3acb73ab1 100644 --- a/service/robomaker/api_op_CreateWorldExportJob.go +++ b/service/robomaker/api_op_CreateWorldExportJob.go @@ -70,16 +70,25 @@ type CreateWorldExportJobOutput struct { // created. CreatedAt *time.Time - // The failure code of the world export job if it failed: InternalServiceError - // Internal service error. LimitExceeded The requested resource exceeds the maximum - // number allowed, or the number of concurrent stream requests exceeds the maximum - // number allowed. ResourceNotFound The specified resource could not be found. - // RequestThrottled The request was throttled. InvalidInput An input parameter in - // 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) - // . + // The failure code of the world export job if it failed: + // + // InternalServiceError Internal service error. + // + // LimitExceeded The requested resource exceeds the maximum number allowed, or the + // number of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound The specified resource could not be found. + // + // RequestThrottled The request was throttled. + // + // InvalidInput An input parameter in 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]. + // + // [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 @@ -89,11 +98,19 @@ type CreateWorldExportJobOutput struct { // The output location. OutputLocation *types.OutputLocation - // The status of the world export job. Pending The world export job request is - // pending. Running The world export job is running. Completed The world export job - // completed. Failed The world export job failed. See failureCode for more - // information. Canceled The world export job was cancelled. Canceling The world - // export job is being cancelled. + // The status of the world export job. + // + // Pending The world export job request is pending. + // + // Running The world export job is running. + // + // Completed The world export job completed. + // + // Failed The world export job failed. See failureCode for more information. + // + // Canceled The world export job was cancelled. + // + // Canceling The world export job is being cancelled. Status types.WorldExportJobStatus // A map that contains tag keys and tag values that are attached to the world diff --git a/service/robomaker/api_op_CreateWorldGenerationJob.go b/service/robomaker/api_op_CreateWorldGenerationJob.go index 6bf601d4bfe..dd4229fa17d 100644 --- a/service/robomaker/api_op_CreateWorldGenerationJob.go +++ b/service/robomaker/api_op_CreateWorldGenerationJob.go @@ -69,20 +69,35 @@ type CreateWorldGenerationJobOutput struct { // created. CreatedAt *time.Time - // The failure code of the world generator job if it failed: InternalServiceError - // Internal service error. LimitExceeded The requested resource exceeds the maximum - // number allowed, or the number of concurrent stream requests exceeds the maximum - // number allowed. ResourceNotFound The specified resource could not be found. - // RequestThrottled The request was throttled. InvalidInput An input parameter in - // the request is not valid. + // The failure code of the world generator job if it failed: + // + // InternalServiceError Internal service error. + // + // LimitExceeded The requested resource exceeds the maximum number allowed, or the + // number of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound The specified resource could not be found. + // + // RequestThrottled The request was throttled. + // + // InvalidInput An input parameter in the request is not valid. FailureCode types.WorldGenerationJobErrorCode - // The status of the world generator job. Pending The world generator job request - // is pending. Running The world generator job is running. Completed The world - // generator job completed. Failed The world generator job failed. See failureCode - // for more information. PartialFailed Some worlds did not generate. Canceled The - // world generator job was cancelled. Canceling The world generator job is being - // cancelled. + // The status of the world generator job. + // + // Pending The world generator job request is pending. + // + // Running The world generator job is running. + // + // Completed The world generator job completed. + // + // Failed The world generator job failed. See failureCode for more information. + // + // PartialFailed Some worlds did not generate. + // + // Canceled The world generator job was cancelled. + // + // Canceling The world generator job is being cancelled. Status types.WorldGenerationJobStatus // A map that contains tag keys and tag values that are attached to the world diff --git a/service/robomaker/api_op_DeleteFleet.go b/service/robomaker/api_op_DeleteFleet.go index 72336c86553..e8448776643 100644 --- a/service/robomaker/api_op_DeleteFleet.go +++ b/service/robomaker/api_op_DeleteFleet.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a fleet. This API will no longer be supported as of May 2, 2022. Use it -// to remove resources that were created for Deployment Service. +// Deletes a fleet. +// +// 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_DeleteRobot.go b/service/robomaker/api_op_DeleteRobot.go index b6fddd3abc9..b0f79923e58 100644 --- a/service/robomaker/api_op_DeleteRobot.go +++ b/service/robomaker/api_op_DeleteRobot.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes 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. +// Deletes 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_DeregisterRobot.go b/service/robomaker/api_op_DeregisterRobot.go index f9a08e07f86..9aeeaa7e891 100644 --- a/service/robomaker/api_op_DeregisterRobot.go +++ b/service/robomaker/api_op_DeregisterRobot.go @@ -10,8 +10,10 @@ 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_DescribeDeploymentJob.go b/service/robomaker/api_op_DescribeDeploymentJob.go index cc1f6449466..90375e9b743 100644 --- a/service/robomaker/api_op_DescribeDeploymentJob.go +++ b/service/robomaker/api_op_DescribeDeploymentJob.go @@ -12,8 +12,10 @@ import ( "time" ) -// Describes a 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. +// Describes a 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 // ended. For additional information, see diff --git a/service/robomaker/api_op_DescribeFleet.go b/service/robomaker/api_op_DescribeFleet.go index ad840fa6fa5..2b5c47786ea 100644 --- a/service/robomaker/api_op_DescribeFleet.go +++ b/service/robomaker/api_op_DescribeFleet.go @@ -12,8 +12,10 @@ import ( "time" ) -// Describes a fleet. This API will no longer be supported as of May 2, 2022. Use -// it to remove resources that were created for Deployment Service. +// Describes a fleet. +// +// 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_DescribeRobot.go b/service/robomaker/api_op_DescribeRobot.go index 79eaddd9e81..3d987768340 100644 --- a/service/robomaker/api_op_DescribeRobot.go +++ b/service/robomaker/api_op_DescribeRobot.go @@ -12,8 +12,10 @@ import ( "time" ) -// Describes 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. +// Describes 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 589c7f0052b..c83da4e6110 100644 --- a/service/robomaker/api_op_DescribeSimulationJob.go +++ b/service/robomaker/api_op_DescribeSimulationJob.go @@ -56,27 +56,47 @@ type DescribeSimulationJobOutput struct { // The failure behavior for the simulation job. FailureBehavior types.FailureBehavior - // The failure code of the simulation job if it failed: InternalServiceError - // Internal service error. RobotApplicationCrash Robot application exited - // abnormally. SimulationApplicationCrash Simulation application exited abnormally. + // The failure code of the simulation job if it failed: + // + // InternalServiceError Internal service error. + // + // RobotApplicationCrash Robot application exited abnormally. + // + // SimulationApplicationCrash Simulation application exited abnormally. + // // BadPermissionsRobotApplication Robot application bundle could not be downloaded. + // // BadPermissionsSimulationApplication Simulation application bundle could not be - // downloaded. BadPermissionsS3Output Unable to publish outputs to - // customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs - // to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP - // limit exceeded. ENILimitExceeded ENI limit exceeded. + // downloaded. + // + // BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. + // + // BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided + // CloudWatch Logs resource. + // + // SubnetIpLimitExceeded Subnet IP limit exceeded. + // + // ENILimitExceeded ENI limit exceeded. + // // BadPermissionsUserCredentials Unable to use the Role provided. + // // InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, - // bundling error, or other issue). InvalidBundleSimulationApplication Simulation - // bundle cannot be extracted (invalid format, bundling error, or other issue). + // bundling error, or other issue). + // + // InvalidBundleSimulationApplication Simulation bundle cannot be extracted + // (invalid format, bundling error, or other issue). + // // RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match - // value during version creation. SimulationApplicationVersionMismatchedEtag Etag - // for SimulationApplication does not match value during version creation. + // value during version creation. + // + // SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does + // not match value during version creation. 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]. + // + // [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 abd7bd98b23..c0c37bf34b7 100644 --- a/service/robomaker/api_op_DescribeSimulationJobBatch.go +++ b/service/robomaker/api_op_DescribeSimulationJobBatch.go @@ -75,21 +75,36 @@ type DescribeSimulationJobBatchOutput struct { // created into simulation jobs. PendingRequests []types.SimulationJobRequest - // 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 - // 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. - // 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. + // 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 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. + // + // 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. 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_DescribeWorldExportJob.go b/service/robomaker/api_op_DescribeWorldExportJob.go index 37badb36a7f..2871dce5d10 100644 --- a/service/robomaker/api_op_DescribeWorldExportJob.go +++ b/service/robomaker/api_op_DescribeWorldExportJob.go @@ -51,12 +51,18 @@ type DescribeWorldExportJobOutput struct { // created. CreatedAt *time.Time - // The failure code of the world export job if it failed: InternalServiceError - // Internal service error. LimitExceeded The requested resource exceeds the maximum - // number allowed, or the number of concurrent stream requests exceeds the maximum - // number allowed. ResourceNotFound The specified resource could not be found. - // RequestThrottled The request was throttled. InvalidInput An input parameter in - // the request is not valid. + // The failure code of the world export job if it failed: + // + // InternalServiceError Internal service error. + // + // LimitExceeded The requested resource exceeds the maximum number allowed, or the + // number of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound The specified resource could not be found. + // + // RequestThrottled The request was throttled. + // + // InvalidInput An input parameter in the request is not valid. FailureCode types.WorldExportJobErrorCode // The reason why the world export job failed. @@ -69,11 +75,20 @@ type DescribeWorldExportJobOutput struct { // The output location. OutputLocation *types.OutputLocation - // The status of the world export job. Pending The world export job request is - // pending. Running The world export job is running. Completed The world export job - // completed. Failed The world export job failed. See failureCode and failureReason - // for more information. Canceled The world export job was cancelled. Canceling The - // world export job is being cancelled. + // The status of the world export job. + // + // Pending The world export job request is pending. + // + // Running The world export job is running. + // + // Completed The world export job completed. + // + // Failed The world export job failed. See failureCode and failureReason for more + // information. + // + // Canceled The world export job was cancelled. + // + // Canceling The world export job is being cancelled. Status types.WorldExportJobStatus // A map that contains tag keys and tag values that are attached to the world diff --git a/service/robomaker/api_op_DescribeWorldGenerationJob.go b/service/robomaker/api_op_DescribeWorldGenerationJob.go index d351fc9929c..550cb3ba09d 100644 --- a/service/robomaker/api_op_DescribeWorldGenerationJob.go +++ b/service/robomaker/api_op_DescribeWorldGenerationJob.go @@ -51,12 +51,18 @@ type DescribeWorldGenerationJobOutput struct { // created. CreatedAt *time.Time - // The failure code of the world generation job if it failed: InternalServiceError - // Internal service error. LimitExceeded The requested resource exceeds the maximum - // number allowed, or the number of concurrent stream requests exceeds the maximum - // number allowed. ResourceNotFound The specified resource could not be found. - // RequestThrottled The request was throttled. InvalidInput An input parameter in - // the request is not valid. + // The failure code of the world generation job if it failed: + // + // InternalServiceError Internal service error. + // + // LimitExceeded The requested resource exceeds the maximum number allowed, or the + // number of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound The specified resource could not be found. + // + // RequestThrottled The request was throttled. + // + // InvalidInput An input parameter in the request is not valid. FailureCode types.WorldGenerationJobErrorCode // The reason why the world generation job failed. @@ -65,12 +71,21 @@ 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 - // 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. + // 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. Status types.WorldGenerationJobStatus // A map that contains tag keys and tag values that are attached to the world diff --git a/service/robomaker/api_op_ListDeploymentJobs.go b/service/robomaker/api_op_ListDeploymentJobs.go index 4e50349ddcc..3edbbf13d35 100644 --- a/service/robomaker/api_op_ListDeploymentJobs.go +++ b/service/robomaker/api_op_ListDeploymentJobs.go @@ -12,9 +12,10 @@ import ( ) // Returns a list of deployment jobs for a fleet. You can optionally provide -// filters to retrieve specific deployment jobs. This API will no longer be -// supported as of May 2, 2022. Use it to remove resources that were created for -// Deployment Service. +// filters to retrieve specific deployment jobs. +// +// 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 @@ -36,11 +37,12 @@ func (c *Client) ListDeploymentJobs(ctx context.Context, params *ListDeploymentJ type ListDeploymentJobsInput struct { - // Optional filters to limit results. The filter names status and fleetName 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 InProgress or the status - // Pending . + // Optional filters to limit results. + // + // The filter names status and fleetName 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 InProgress or the status Pending . Filters []types.Filter // When this parameter is used, ListDeploymentJobs only returns maxResults results diff --git a/service/robomaker/api_op_ListFleets.go b/service/robomaker/api_op_ListFleets.go index 44be89f9a32..f0f8c6b3ca8 100644 --- a/service/robomaker/api_op_ListFleets.go +++ b/service/robomaker/api_op_ListFleets.go @@ -12,8 +12,10 @@ import ( ) // Returns a list of fleets. You can optionally provide filters to retrieve -// specific fleets. This API will no longer be supported as of May 2, 2022. Use it -// to remove resources that were created for Deployment Service. +// specific fleets. +// +// 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 @@ -35,9 +37,10 @@ func (c *Client) ListFleets(ctx context.Context, params *ListFleetsInput, optFns type ListFleetsInput struct { - // Optional filters to limit results. The filter name name is supported. When - // filtering, you must use the complete value of the filtered item. You can use up - // to three filters. + // Optional filters to limit results. + // + // The filter name name is supported. When filtering, you must use the complete + // value of the filtered item. You can use up to three filters. Filters []types.Filter // When this parameter is used, ListFleets only returns maxResults results in a @@ -52,9 +55,10 @@ type ListFleetsInput struct { // the response object's nextToken parameter value is set to a token. To retrieve // the next set of results, call ListFleets 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. 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 response object's NextToken parameter is set to 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 diff --git a/service/robomaker/api_op_ListRobotApplications.go b/service/robomaker/api_op_ListRobotApplications.go index 79b4f8bb803..6ec4620b2f2 100644 --- a/service/robomaker/api_op_ListRobotApplications.go +++ b/service/robomaker/api_op_ListRobotApplications.go @@ -30,9 +30,10 @@ func (c *Client) ListRobotApplications(ctx context.Context, params *ListRobotApp type ListRobotApplicationsInput struct { - // Optional filters to limit results. The filter name name is supported. When - // filtering, you must use the complete value of the filtered item. You can use up - // to three filters. + // Optional filters to limit results. + // + // The filter name name is supported. When filtering, you must use the complete + // value of the filtered item. You can use up to three filters. Filters []types.Filter // When this parameter is used, ListRobotApplications only returns maxResults diff --git a/service/robomaker/api_op_ListRobots.go b/service/robomaker/api_op_ListRobots.go index 39c365d0df6..1491b7b19dd 100644 --- a/service/robomaker/api_op_ListRobots.go +++ b/service/robomaker/api_op_ListRobots.go @@ -12,8 +12,10 @@ import ( ) // Returns a list of robots. You can optionally provide filters to retrieve -// specific robots. This API will no longer be supported as of May 2, 2022. Use it -// to remove resources that were created for Deployment Service. +// specific robots. +// +// 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 @@ -35,11 +37,12 @@ func (c *Client) ListRobots(ctx context.Context, params *ListRobotsInput, optFns type ListRobotsInput struct { - // Optional filters to limit results. The filter names status and fleetName 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 Registered or the status - // Available . + // Optional filters to limit results. + // + // The filter names status and fleetName 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 Registered or the status Available . Filters []types.Filter // When this parameter is used, ListRobots only returns maxResults results in a diff --git a/service/robomaker/api_op_ListSimulationApplications.go b/service/robomaker/api_op_ListSimulationApplications.go index 0396dd86dd5..b550cc160d4 100644 --- a/service/robomaker/api_op_ListSimulationApplications.go +++ b/service/robomaker/api_op_ListSimulationApplications.go @@ -30,9 +30,10 @@ func (c *Client) ListSimulationApplications(ctx context.Context, params *ListSim type ListSimulationApplicationsInput struct { - // Optional list of filters to limit results. The filter name name is supported. - // When filtering, you must use the complete value of the filtered item. You can - // use up to three filters. + // Optional list of filters to limit results. + // + // The filter name name is supported. When filtering, you must use the complete + // value of the filtered item. You can use up to three filters. Filters []types.Filter // When this parameter is used, ListSimulationApplications only returns maxResults diff --git a/service/robomaker/api_op_ListSimulationJobs.go b/service/robomaker/api_op_ListSimulationJobs.go index f8166018bcb..3222edf7e34 100644 --- a/service/robomaker/api_op_ListSimulationJobs.go +++ b/service/robomaker/api_op_ListSimulationJobs.go @@ -30,11 +30,13 @@ func (c *Client) ListSimulationJobs(ctx context.Context, params *ListSimulationJ type ListSimulationJobsInput struct { - // Optional filters to limit results. The filter names status and - // 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 . + // Optional filters to limit results. + // + // The filter names status and 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 . Filters []types.Filter // When this parameter is used, ListSimulationJobs only returns maxResults results diff --git a/service/robomaker/api_op_RegisterRobot.go b/service/robomaker/api_op_RegisterRobot.go index fe697b4f645..4034b6233d6 100644 --- a/service/robomaker/api_op_RegisterRobot.go +++ b/service/robomaker/api_op_RegisterRobot.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a robot with a fleet. This API is no longer supported and will throw -// an error if used. +// Registers a robot with a fleet. +// +// This API is no longer supported and will throw an error if used. // // Deprecated: AWS RoboMaker is unable to process this request as the support for // the AWS RoboMaker application deployment feature has ended. For additional diff --git a/service/robomaker/api_op_StartSimulationJobBatch.go b/service/robomaker/api_op_StartSimulationJobBatch.go index 0719d1058aa..d9f353b5096 100644 --- a/service/robomaker/api_op_StartSimulationJobBatch.go +++ b/service/robomaker/api_op_StartSimulationJobBatch.go @@ -83,22 +83,36 @@ 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 - // 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. 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. + // 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 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. Status types.SimulationJobBatchStatus // A map that contains tag keys and tag values that are attached to the deployment diff --git a/service/robomaker/api_op_SyncDeploymentJob.go b/service/robomaker/api_op_SyncDeploymentJob.go index dd04ea78600..682a1fb23c9 100644 --- a/service/robomaker/api_op_SyncDeploymentJob.go +++ b/service/robomaker/api_op_SyncDeploymentJob.go @@ -13,9 +13,10 @@ import ( ) // Syncrhonizes robots in a fleet to the latest deployment. This is helpful if -// robots were added after a deployment. This API will no longer be supported as of -// May 2, 2022. Use it to remove resources that were created for Deployment -// Service. +// robots were added after a deployment. +// +// 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 @@ -65,22 +66,41 @@ type SyncDeploymentJobOutput struct { // Information about the deployment configuration. DeploymentConfig *types.DeploymentConfig - // The failure code if the job fails: InternalServiceError Internal service error. + // The failure code if the job fails: + // + // InternalServiceError Internal service error. + // // RobotApplicationCrash Robot application exited abnormally. - // SimulationApplicationCrash Simulation application exited abnormally. + // + // SimulationApplicationCrash Simulation application exited abnormally. + // // BadPermissionsRobotApplication Robot application bundle could not be downloaded. + // // BadPermissionsSimulationApplication Simulation application bundle could not be - // downloaded. BadPermissionsS3Output Unable to publish outputs to - // customer-provided S3 bucket. BadPermissionsCloudwatchLogs Unable to publish logs - // to customer-provided CloudWatch Logs resource. SubnetIpLimitExceeded Subnet IP - // limit exceeded. ENILimitExceeded ENI limit exceeded. + // downloaded. + // + // BadPermissionsS3Output Unable to publish outputs to customer-provided S3 bucket. + // + // BadPermissionsCloudwatchLogs Unable to publish logs to customer-provided + // CloudWatch Logs resource. + // + // SubnetIpLimitExceeded Subnet IP limit exceeded. + // + // ENILimitExceeded ENI limit exceeded. + // // BadPermissionsUserCredentials Unable to use the Role provided. + // // InvalidBundleRobotApplication Robot bundle cannot be extracted (invalid format, - // bundling error, or other issue). InvalidBundleSimulationApplication Simulation - // bundle cannot be extracted (invalid format, bundling error, or other issue). + // bundling error, or other issue). + // + // InvalidBundleSimulationApplication Simulation bundle cannot be extracted + // (invalid format, bundling error, or other issue). + // // RobotApplicationVersionMismatchedEtag Etag for RobotApplication does not match - // value during version creation. SimulationApplicationVersionMismatchedEtag Etag - // for SimulationApplication does not match value during version creation. + // value during version creation. + // + // SimulationApplicationVersionMismatchedEtag Etag for SimulationApplication does + // not match value during version creation. FailureCode types.DeploymentJobErrorCode // The failure reason if the job fails. diff --git a/service/robomaker/api_op_TagResource.go b/service/robomaker/api_op_TagResource.go index 4de2a4dd7e8..00d4b54caef 100644 --- a/service/robomaker/api_op_TagResource.go +++ b/service/robomaker/api_op_TagResource.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the AWS Billing and Cost Management User Guide. +// 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] in +// the AWS Billing and Cost Management User Guide. +// +// [User-Defined Tag Restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/robomaker/api_op_UntagResource.go b/service/robomaker/api_op_UntagResource.go index 0add0ff530f..311d1d9f196 100644 --- a/service/robomaker/api_op_UntagResource.go +++ b/service/robomaker/api_op_UntagResource.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]TagResource . +// +// [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/options.go b/service/robomaker/options.go index 929dc42ba7b..06fa16b1eb8 100644 --- a/service/robomaker/options.go +++ b/service/robomaker/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/robomaker/types/enums.go b/service/robomaker/types/enums.go index e9abc0b2a81..0669076ea3c 100644 --- a/service/robomaker/types/enums.go +++ b/service/robomaker/types/enums.go @@ -12,8 +12,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for ComputeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComputeType) Values() []ComputeType { return []ComputeType{ "CPU", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for DataSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceType) Values() []DataSourceType { return []DataSourceType{ "Prefix", @@ -91,8 +94,9 @@ const ( ) // Values returns all known values for DeploymentJobErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentJobErrorCode) Values() []DeploymentJobErrorCode { return []DeploymentJobErrorCode{ "ResourceNotFound", @@ -135,8 +139,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "Pending", @@ -157,8 +162,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -175,8 +181,9 @@ const ( ) // Values returns all known values for FailureBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureBehavior) Values() []FailureBehavior { return []FailureBehavior{ "Fail", @@ -192,8 +199,9 @@ const ( ) // Values returns all known values for RenderingEngineType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RenderingEngineType) Values() []RenderingEngineType { return []RenderingEngineType{ "OGRE", @@ -214,8 +222,9 @@ const ( ) // Values returns all known values for RobotDeploymentStep. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RobotDeploymentStep) Values() []RobotDeploymentStep { return []RobotDeploymentStep{ "Validating", @@ -238,8 +247,9 @@ const ( ) // Values returns all known values for RobotSoftwareSuiteType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RobotSoftwareSuiteType) Values() []RobotSoftwareSuiteType { return []RobotSoftwareSuiteType{ "ROS", @@ -260,8 +270,9 @@ const ( // Values returns all known values for RobotSoftwareSuiteVersionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RobotSoftwareSuiteVersionType) Values() []RobotSoftwareSuiteVersionType { return []RobotSoftwareSuiteVersionType{ "Kinetic", @@ -285,8 +296,9 @@ const ( ) // Values returns all known values for RobotStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RobotStatus) Values() []RobotStatus { return []RobotStatus{ "Available", @@ -308,6 +320,7 @@ const ( // Values returns all known values for SimulationJobBatchErrorCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SimulationJobBatchErrorCode) Values() []SimulationJobBatchErrorCode { return []SimulationJobBatchErrorCode{ @@ -332,6 +345,7 @@ const ( // 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{ @@ -385,8 +399,9 @@ const ( ) // Values returns all known values for SimulationJobErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimulationJobErrorCode) Values() []SimulationJobErrorCode { return []SimulationJobErrorCode{ "InternalServiceError", @@ -440,8 +455,9 @@ const ( ) // Values returns all known values for SimulationJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimulationJobStatus) Values() []SimulationJobStatus { return []SimulationJobStatus{ "Pending", @@ -468,6 +484,7 @@ const ( // Values returns all known values for SimulationSoftwareSuiteType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SimulationSoftwareSuiteType) Values() []SimulationSoftwareSuiteType { return []SimulationSoftwareSuiteType{ @@ -486,8 +503,9 @@ const ( ) // Values returns all known values for UploadBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UploadBehavior) Values() []UploadBehavior { return []UploadBehavior{ "UPLOAD_ON_TERMINATE", @@ -508,8 +526,9 @@ const ( ) // Values returns all known values for WorldExportJobErrorCode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorldExportJobErrorCode) Values() []WorldExportJobErrorCode { return []WorldExportJobErrorCode{ "InternalServiceError", @@ -534,8 +553,9 @@ const ( ) // Values returns all known values for WorldExportJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorldExportJobStatus) Values() []WorldExportJobStatus { return []WorldExportJobStatus{ "Pending", @@ -561,6 +581,7 @@ const ( // Values returns all known values for WorldGenerationJobErrorCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WorldGenerationJobErrorCode) Values() []WorldGenerationJobErrorCode { return []WorldGenerationJobErrorCode{ @@ -588,6 +609,7 @@ const ( // 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{ diff --git a/service/robomaker/types/types.go b/service/robomaker/types/types.go index 5a0f1f6ecea..5af623bc343 100644 --- a/service/robomaker/types/types.go +++ b/service/robomaker/types/types.go @@ -11,17 +11,19 @@ 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 - // terminal states. + // 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 - // other reason, the failed pending requests will be moved to the failed list and - // the batch status will be TimedOut . + // 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 other reason, the failed pending requests will be moved to the + // failed list and the batch status will be TimedOut . TimeoutInSeconds *int64 noSmithyDocumentSerde @@ -68,14 +70,18 @@ type ComputeResponse struct { // Information about a data source. 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 - // 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 - // 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 + // 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 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 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. Destination *string // The name of the data source. @@ -89,8 +95,9 @@ 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 . + // Archive, an Amazon S3 prefix, or a file. + // + // If you don't specify a field, the default value is File . Type DataSourceType noSmithyDocumentSerde @@ -114,20 +121,25 @@ type DataSourceConfig struct { // This member is required. 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 - // 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 - // 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 + // 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 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 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. 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 . + // Archive, an Amazon S3 prefix, or a file. + // + // If you don't specify a field, the default value is File . Type DataSourceType noSmithyDocumentSerde @@ -326,9 +338,11 @@ type Fleet struct { type LaunchConfig struct { // 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 - // can use this field to specify a list of commands for your container image. + // 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 can use this field to specify a list of commands + // for your container image. Command []string // The environment variables for the application launch. @@ -355,8 +369,9 @@ type LaunchConfig struct { // The logging configuration. type LoggingConfig struct { - // A boolean indicating whether to record all ROS topics. This API is no longer - // supported and will throw an error if used. + // A boolean indicating whether to record all ROS topics. + // + // 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 @@ -425,11 +440,19 @@ type PortMapping struct { // Information about the progress of a deployment job. type ProgressDetail struct { - // The current progress status. Validating Validating the deployment. + // The current progress status. + // + // Validating Validating the deployment. + // // DownloadingExtracting Downloading and extracting the bundle on the robot. - // ExecutingPreLaunch Executing pre-launch script(s) if provided. Launching - // Launching the robot application. ExecutingPostLaunch Executing post-launch - // script(s) if provided. Finished Deployment is complete. + // + // ExecutingPreLaunch Executing pre-launch script(s) if provided. + // + // Launching Launching the robot application. + // + // ExecutingPostLaunch Executing post-launch script(s) if provided. + // + // Finished Deployment is complete. CurrentProgress RobotDeploymentStep // Estimated amount of time in seconds remaining in the step. This currently only @@ -516,6 +539,7 @@ type RobotApplicationConfig struct { // 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 @@ -525,8 +549,11 @@ 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. + // 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. // // Deprecated: AWS RoboMaker is ending support for ROS software suite. For // additional information, see @@ -652,6 +679,7 @@ type SimulationApplicationConfig struct { // A Boolean indicating whether to use default simulation 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 @@ -661,8 +689,11 @@ 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. + // 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. // // Deprecated: AWS RoboMaker is ending support for ROS software suite. For // additional information, see @@ -715,9 +746,12 @@ type SimulationJob struct { // The data sources for the simulation job. DataSources []DataSource - // The failure behavior the simulation job. Continue Leaves the host running for - // its maximum timeout duration after a 4XX error code. Fail Stop the simulation - // job and terminate the instance. + // The failure behavior the simulation job. + // + // Continue Leaves the host running for its maximum timeout duration after a 4XX + // error code. + // + // Fail Stop the simulation job and terminate the instance. FailureBehavior FailureBehavior // The failure code of the simulation job if it failed. @@ -800,22 +834,36 @@ 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 - // 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. 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. + // 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 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. Status SimulationJobBatchStatus noSmithyDocumentSerde @@ -835,13 +883,17 @@ type SimulationJobRequest struct { // Specify data sources to mount read-only files from S3 into your simulation. // 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 - // The failure behavior the simulation job. Continue Leaves the host running for - // its maximum timeout duration after a 4XX error code. Fail Stop the simulation - // job and terminate the instance. + // The failure behavior the simulation job. + // + // Continue Leaves the host running for its maximum timeout duration after a 4XX + // error code. + // + // Fail Stop the simulation job and terminate the instance. FailureBehavior FailureBehavior // The IAM role name that allows the simulation instance to call the AWS APIs that @@ -1026,31 +1078,38 @@ type Tool struct { 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 + // 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 . // // This member is required. Name *string - // Specifies the path of the file(s) to upload. Standard Unix glob matching rules + // 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]. + // + // [Glob Library]: https://github.com/gobwas/glob // // This member is required. Path *string - // Specifies when to upload the files: UPLOAD_ON_TERMINATE Matching files are - // uploaded once the simulation enters the TERMINATING state. Matching files are - // not uploaded until all of your code (including tools) have stopped. If there is - // a problem uploading a file, the upload is retried. If problems persist, no - // further upload attempts will be made. UPLOAD_ROLLING_AUTO_REMOVE Matching files - // are uploaded as they are created. They are deleted after they are uploaded. The - // specified path is checked every 5 seconds. A final check is made when all of - // your code (including tools) have stopped. + // Specifies when to upload the files: + // + // UPLOAD_ON_TERMINATE Matching files are uploaded once the simulation enters the + // TERMINATING state. Matching files are not uploaded until all of your code + // (including tools) have stopped. + // + // If there is a problem uploading a file, the upload is retried. If problems + // persist, no further upload attempts will be made. + // + // UPLOAD_ROLLING_AUTO_REMOVE Matching files are uploaded as they are created. + // They are deleted after they are uploaded. The specified path is checked every 5 + // seconds. A final check is made when all of your code (including tools) have + // stopped. // // This member is required. UploadBehavior UploadBehavior @@ -1108,9 +1167,10 @@ type WorldConfig struct { // 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 -// plans. +// floorplanCount * interiorCountPerFloorplan) . +// +// If you set floorplanCount = 4 and interiorCountPerFloorplan = 5 , there will be +// 20 worlds with 5 unique floor plans. type WorldCount struct { // The number of unique floorplans. @@ -1135,11 +1195,19 @@ type WorldExportJobSummary struct { // The output location. OutputLocation *OutputLocation - // The status of the world export job. Pending The world export job request is - // pending. Running The world export job is running. Completed The world export job - // completed. Failed The world export job failed. See failureCode for more - // information. Canceled The world export job was cancelled. Canceling The world - // export job is being cancelled. + // The status of the world export job. + // + // Pending The world export job request is pending. + // + // Running The world export job is running. + // + // Completed The world export job completed. + // + // Failed The world export job failed. See failureCode for more information. + // + // Canceled The world export job was cancelled. + // + // Canceling The world export job is being cancelled. Status WorldExportJobStatus // A list of worlds. @@ -1151,12 +1219,18 @@ type WorldExportJobSummary struct { // Information about a failed world. type WorldFailure struct { - // The failure code of the world export job if it failed: InternalServiceError - // Internal service error. LimitExceeded The requested resource exceeds the maximum - // number allowed, or the number of concurrent stream requests exceeds the maximum - // number allowed. ResourceNotFound The specified resource could not be found. - // RequestThrottled The request was throttled. InvalidInput An input parameter in - // the request is not valid. + // The failure code of the world export job if it failed: + // + // InternalServiceError Internal service error. + // + // LimitExceeded The requested resource exceeds the maximum number allowed, or the + // number of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound The specified resource could not be found. + // + // RequestThrottled The request was throttled. + // + // InvalidInput An input parameter in the request is not valid. FailureCode WorldGenerationJobErrorCode // The number of failed worlds. @@ -1182,12 +1256,21 @@ type WorldGenerationJobSummary struct { // The number of worlds that failed. FailedWorldCount int32 - // The status of the world generator job: Pending The world generator job request - // is pending. Running The world generator job is running. Completed The world - // generator job completed. Failed The world generator job failed. See failureCode - // for more information. PartialFailed Some worlds did not generate. Canceled The - // world generator job was cancelled. Canceling The world generator job is being - // cancelled. + // The status of the world generator job: + // + // Pending The world generator job request is pending. + // + // Running The world generator job is running. + // + // Completed The world generator job completed. + // + // Failed The world generator job failed. See failureCode for more information. + // + // PartialFailed Some worlds did not generate. + // + // Canceled The world generator job was cancelled. + // + // Canceling The world generator job is being cancelled. Status WorldGenerationJobStatus // The number of worlds that were generated. diff --git a/service/rolesanywhere/api_op_CreateProfile.go b/service/rolesanywhere/api_op_CreateProfile.go index 96b0a9f2efb..c4420a56bb9 100644 --- a/service/rolesanywhere/api_op_CreateProfile.go +++ b/service/rolesanywhere/api_op_CreateProfile.go @@ -13,6 +13,7 @@ import ( // Creates a profile, a list of the roles that Roles Anywhere service is trusted // to assume. You use profiles to intersect permissions with IAM managed policies. +// // Required permissions: rolesanywhere:CreateProfile . func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, optFns ...func(*Options)) (*CreateProfileOutput, error) { if params == nil { @@ -42,10 +43,11 @@ type CreateProfileInput struct { // This member is required. RoleArns []string - // Used to determine how long sessions vended using this profile are valid for. - // See the Expiration section of the CreateSession API documentation (https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object) - // page for more details. In requests, if this value is not provided, the default - // value will be 3600. + // Used to determine how long sessions vended using this profile are valid for. + // See the Expiration section of the [CreateSession API documentation] page for more details. In requests, if this + // value is not provided, the default value will be 3600. + // + // [CreateSession API documentation]: https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object DurationSeconds *int32 // Specifies whether the profile is enabled. diff --git a/service/rolesanywhere/api_op_CreateTrustAnchor.go b/service/rolesanywhere/api_op_CreateTrustAnchor.go index 0b9b6711e37..331c082ea3a 100644 --- a/service/rolesanywhere/api_op_CreateTrustAnchor.go +++ b/service/rolesanywhere/api_op_CreateTrustAnchor.go @@ -16,7 +16,9 @@ import ( // Private Certificate Authority (Private CA) or by uploading a CA certificate. // Your Amazon Web Services workloads can authenticate with the trust anchor using // certificates issued by the CA in exchange for temporary Amazon Web Services -// 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 93c437f7b5f..92aa0d200ea 100644 --- a/service/rolesanywhere/api_op_DeleteCrl.go +++ b/service/rolesanywhere/api_op_DeleteCrl.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a certificate revocation list (CRL). Required permissions: -// rolesanywhere:DeleteCrl . +// Deletes a certificate revocation list (CRL). +// +// Required permissions: 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 addf81f3c1e..cc7d5a8e326 100644 --- a/service/rolesanywhere/api_op_DeleteProfile.go +++ b/service/rolesanywhere/api_op_DeleteProfile.go @@ -11,7 +11,9 @@ 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 7d4c69f67c9..30035087b77 100644 --- a/service/rolesanywhere/api_op_DeleteTrustAnchor.go +++ b/service/rolesanywhere/api_op_DeleteTrustAnchor.go @@ -11,7 +11,9 @@ 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 3550e5971cc..79e0b2ca2ff 100644 --- a/service/rolesanywhere/api_op_DisableCrl.go +++ b/service/rolesanywhere/api_op_DisableCrl.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disables a certificate revocation list (CRL). Required permissions: -// rolesanywhere:DisableCrl . +// Disables a certificate revocation list (CRL). +// +// Required permissions: 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 3ad35afe8ef..0cb5407751d 100644 --- a/service/rolesanywhere/api_op_DisableProfile.go +++ b/service/rolesanywhere/api_op_DisableProfile.go @@ -12,7 +12,9 @@ import ( ) // Disables a profile. When disabled, temporary credential requests with this -// profile fail. Required permissions: rolesanywhere:DisableProfile . +// profile fail. +// +// Required permissions: 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 2eb74c01bba..a268be43d86 100644 --- a/service/rolesanywhere/api_op_DisableTrustAnchor.go +++ b/service/rolesanywhere/api_op_DisableTrustAnchor.go @@ -12,8 +12,9 @@ import ( ) // Disables a trust anchor. When disabled, temporary credential requests -// specifying this trust anchor are unauthorized. Required permissions: -// rolesanywhere:DisableTrustAnchor . +// specifying this trust anchor are unauthorized. +// +// Required permissions: 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 7b4b008f03d..a3f4eb6b8bd 100644 --- a/service/rolesanywhere/api_op_EnableCrl.go +++ b/service/rolesanywhere/api_op_EnableCrl.go @@ -12,8 +12,9 @@ import ( ) // Enables a certificate revocation list (CRL). When enabled, certificates stored -// in the CRL are unauthorized to receive session credentials. Required -// permissions: rolesanywhere:EnableCrl . +// in the CRL are unauthorized to receive session credentials. +// +// Required 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 4be0e4cb522..093e07edf92 100644 --- a/service/rolesanywhere/api_op_EnableProfile.go +++ b/service/rolesanywhere/api_op_EnableProfile.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Enables temporary credential requests for a profile. Required permissions: -// rolesanywhere:EnableProfile . +// Enables temporary credential requests for a profile. +// +// 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 344f910af53..093454c9f9a 100644 --- a/service/rolesanywhere/api_op_EnableTrustAnchor.go +++ b/service/rolesanywhere/api_op_EnableTrustAnchor.go @@ -12,8 +12,9 @@ import ( ) // Enables a trust anchor. When enabled, certificates in the trust anchor chain -// are authorized for trust validation. Required permissions: -// rolesanywhere:EnableTrustAnchor . +// 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 8ec818e0d50..adf64251ab4 100644 --- a/service/rolesanywhere/api_op_GetCrl.go +++ b/service/rolesanywhere/api_op_GetCrl.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a certificate revocation list (CRL). Required permissions: -// rolesanywhere:GetCrl . +// Gets a certificate revocation list (CRL). +// +// Required permissions: 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 2dec0000526..9330899edc6 100644 --- a/service/rolesanywhere/api_op_GetProfile.go +++ b/service/rolesanywhere/api_op_GetProfile.go @@ -11,7 +11,9 @@ 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 f9d12bf9100..de619538d08 100644 --- a/service/rolesanywhere/api_op_GetSubject.go +++ b/service/rolesanywhere/api_op_GetSubject.go @@ -14,8 +14,9 @@ import ( // Gets a subject, which associates a certificate identity with authentication // attempts. The subject stores auditing information such as the 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 . +// time the associated identity attempted authentication. +// +// 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 f170d1dbc7c..6462a3df168 100644 --- a/service/rolesanywhere/api_op_GetTrustAnchor.go +++ b/service/rolesanywhere/api_op_GetTrustAnchor.go @@ -11,7 +11,9 @@ 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 b45274ce615..a865468b04a 100644 --- a/service/rolesanywhere/api_op_ImportCrl.go +++ b/service/rolesanywhere/api_op_ImportCrl.go @@ -14,8 +14,9 @@ import ( // Imports the certificate revocation list (CRL). A CRL is a list of certificates // that have been revoked by the issuing certificate Authority (CA).In order to be // properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates -// against the CRL before issuing credentials. Required permissions: -// rolesanywhere:ImportCrl . +// against the CRL before issuing credentials. +// +// Required 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 0b74ab8ea74..8f173050505 100644 --- a/service/rolesanywhere/api_op_ListCrls.go +++ b/service/rolesanywhere/api_op_ListCrls.go @@ -12,7 +12,9 @@ import ( ) // Lists all certificate revocation lists (CRL) in the authenticated account and -// Amazon Web Services Region. Required permissions: rolesanywhere:ListCrls . +// Amazon Web Services Region. +// +// 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 d93375a046f..1c6edd3d8bc 100644 --- a/service/rolesanywhere/api_op_ListProfiles.go +++ b/service/rolesanywhere/api_op_ListProfiles.go @@ -12,6 +12,7 @@ import ( ) // Lists all profiles in the authenticated account and Amazon Web Services Region. +// // Required permissions: rolesanywhere:ListProfiles . func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, optFns ...func(*Options)) (*ListProfilesOutput, error) { if params == nil { diff --git a/service/rolesanywhere/api_op_ListSubjects.go b/service/rolesanywhere/api_op_ListSubjects.go index 8a09bb3c2e8..b073e436255 100644 --- a/service/rolesanywhere/api_op_ListSubjects.go +++ b/service/rolesanywhere/api_op_ListSubjects.go @@ -12,6 +12,7 @@ import ( ) // Lists the subjects in the authenticated account and Amazon Web Services Region. +// // Required permissions: rolesanywhere:ListSubjects . func (c *Client) ListSubjects(ctx context.Context, params *ListSubjectsInput, optFns ...func(*Options)) (*ListSubjectsOutput, error) { if params == nil { diff --git a/service/rolesanywhere/api_op_ListTagsForResource.go b/service/rolesanywhere/api_op_ListTagsForResource.go index cd376dbec31..9726855d265 100644 --- a/service/rolesanywhere/api_op_ListTagsForResource.go +++ b/service/rolesanywhere/api_op_ListTagsForResource.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the tags attached to the resource. Required permissions: -// rolesanywhere:ListTagsForResource . +// Lists the tags attached to the resource. +// +// Required permissions: 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 ae5090331a7..fc9e3374062 100644 --- a/service/rolesanywhere/api_op_ListTrustAnchors.go +++ b/service/rolesanywhere/api_op_ListTrustAnchors.go @@ -12,7 +12,9 @@ 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_PutNotificationSettings.go b/service/rolesanywhere/api_op_PutNotificationSettings.go index 17b1f346911..0fc376e146b 100644 --- a/service/rolesanywhere/api_op_PutNotificationSettings.go +++ b/service/rolesanywhere/api_op_PutNotificationSettings.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches a list of notification settings to a trust anchor. A notification -// setting includes information such as event name, threshold, status of the -// notification setting, and the channel to notify. Required permissions: -// rolesanywhere:PutNotificationSettings . +// Attaches a list of notification settings to a trust anchor. +// +// A notification setting includes information such as event name, threshold, +// status of the notification setting, and the channel to notify. +// +// Required permissions: rolesanywhere:PutNotificationSettings . func (c *Client) PutNotificationSettings(ctx context.Context, params *PutNotificationSettingsInput, optFns ...func(*Options)) (*PutNotificationSettingsOutput, error) { if params == nil { params = &PutNotificationSettingsInput{} diff --git a/service/rolesanywhere/api_op_ResetNotificationSettings.go b/service/rolesanywhere/api_op_ResetNotificationSettings.go index 4867858f050..14ce4f27348 100644 --- a/service/rolesanywhere/api_op_ResetNotificationSettings.go +++ b/service/rolesanywhere/api_op_ResetNotificationSettings.go @@ -12,6 +12,7 @@ import ( ) // Resets the custom notification setting to IAM Roles Anywhere default setting. +// // Required permissions: rolesanywhere:ResetNotificationSettings . func (c *Client) ResetNotificationSettings(ctx context.Context, params *ResetNotificationSettingsInput, optFns ...func(*Options)) (*ResetNotificationSettingsOutput, error) { if params == nil { diff --git a/service/rolesanywhere/api_op_TagResource.go b/service/rolesanywhere/api_op_TagResource.go index dcafea29f82..a988597cd6a 100644 --- a/service/rolesanywhere/api_op_TagResource.go +++ b/service/rolesanywhere/api_op_TagResource.go @@ -11,7 +11,9 @@ 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 82f2f146f9a..0e6cfb6e366 100644 --- a/service/rolesanywhere/api_op_UntagResource.go +++ b/service/rolesanywhere/api_op_UntagResource.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes tags from the resource. Required permissions: -// rolesanywhere:UntagResource . +// Removes tags from the resource. +// +// Required permissions: 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 d48a0078453..270a2f575d4 100644 --- a/service/rolesanywhere/api_op_UpdateCrl.go +++ b/service/rolesanywhere/api_op_UpdateCrl.go @@ -13,8 +13,9 @@ import ( // Updates the certificate revocation list (CRL). A CRL is a list of certificates // that have been revoked by the issuing certificate authority (CA). IAM Roles -// Anywhere validates against the CRL before issuing credentials. Required -// permissions: rolesanywhere:UpdateCrl . +// Anywhere validates against the CRL before issuing credentials. +// +// Required 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 c92eba5e528..e2bc128b8df 100644 --- a/service/rolesanywhere/api_op_UpdateProfile.go +++ b/service/rolesanywhere/api_op_UpdateProfile.go @@ -13,7 +13,9 @@ import ( // Updates a profile, a list of the roles that IAM Roles Anywhere service is // trusted to assume. You use profiles to intersect permissions with IAM managed -// policies. Required permissions: rolesanywhere:UpdateProfile . +// policies. +// +// Required permissions: rolesanywhere:UpdateProfile . func (c *Client) UpdateProfile(ctx context.Context, params *UpdateProfileInput, optFns ...func(*Options)) (*UpdateProfileOutput, error) { if params == nil { params = &UpdateProfileInput{} @@ -36,10 +38,11 @@ type UpdateProfileInput struct { // This member is required. ProfileId *string - // Used to determine how long sessions vended using this profile are valid for. - // See the Expiration section of the CreateSession API documentation (https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object) - // page for more details. In requests, if this value is not provided, the default - // value will be 3600. + // Used to determine how long sessions vended using this profile are valid for. + // See the Expiration section of the [CreateSession API documentation] page for more details. In requests, if this + // value is not provided, the default value will be 3600. + // + // [CreateSession API documentation]: https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object DurationSeconds *int32 // A list of managed policy ARNs that apply to the vended session credentials. diff --git a/service/rolesanywhere/api_op_UpdateTrustAnchor.go b/service/rolesanywhere/api_op_UpdateTrustAnchor.go index 73888ffcac0..e9065b870f3 100644 --- a/service/rolesanywhere/api_op_UpdateTrustAnchor.go +++ b/service/rolesanywhere/api_op_UpdateTrustAnchor.go @@ -16,8 +16,9 @@ import ( // anchor as a reference to an Private Certificate Authority (Private CA) or by // uploading a CA certificate. Your Amazon Web Services workloads can authenticate // with the trust anchor using certificates issued by the CA in exchange for -// temporary Amazon Web Services credentials. Required permissions: -// rolesanywhere:UpdateTrustAnchor . +// temporary Amazon Web Services 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 5ee4bb2f220..3369b44814e 100644 --- a/service/rolesanywhere/doc.go +++ b/service/rolesanywhere/doc.go @@ -9,14 +9,17 @@ // workloads can use the same IAM policies and roles you have for native Amazon Web // Services applications to access Amazon Web Services resources. Using IAM Roles // Anywhere eliminates the need to manage long-term credentials for workloads -// running outside of Amazon Web Services. To use IAM Roles Anywhere, your -// workloads must use X.509 certificates issued by their certificate authority -// (CA). You register the CA with IAM Roles Anywhere as a trust anchor to establish -// trust between your public key infrastructure (PKI) and IAM Roles Anywhere. If -// you don't manage your own PKI system, you can use Private Certificate Authority -// to create a CA and then use that to establish trust with IAM Roles Anywhere. +// running outside of Amazon Web Services. +// +// To use IAM Roles Anywhere, your workloads must use X.509 certificates issued by +// their certificate authority (CA). You register the CA with IAM Roles Anywhere as +// a trust anchor to establish trust between your public key infrastructure (PKI) +// and IAM Roles Anywhere. If you don't manage your own PKI system, you can use +// Private Certificate Authority to create a CA and then use that to establish +// trust with IAM Roles Anywhere. +// // This guide describes the IAM Roles Anywhere operations that you can call -// programmatically. For more information about IAM Roles Anywhere, see the IAM -// Roles Anywhere User Guide (https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html) -// . +// programmatically. For more information about IAM Roles Anywhere, see the [IAM Roles Anywhere User Guide]. +// +// [IAM Roles Anywhere User Guide]: https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html package rolesanywhere diff --git a/service/rolesanywhere/options.go b/service/rolesanywhere/options.go index d7e99288833..3ad0934bf06 100644 --- a/service/rolesanywhere/options.go +++ b/service/rolesanywhere/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/rolesanywhere/types/enums.go b/service/rolesanywhere/types/enums.go index 1d884377ae4..1ee2ab1fd22 100644 --- a/service/rolesanywhere/types/enums.go +++ b/service/rolesanywhere/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for CertificateField. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateField) Values() []CertificateField { return []CertificateField{ "x509Subject", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for NotificationChannel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationChannel) Values() []NotificationChannel { return []NotificationChannel{ "ALL", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for NotificationEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationEvent) Values() []NotificationEvent { return []NotificationEvent{ "CA_CERTIFICATE_EXPIRY", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for TrustAnchorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustAnchorType) Values() []TrustAnchorType { return []TrustAnchorType{ "AWS_ACM_PCA", diff --git a/service/rolesanywhere/types/types.go b/service/rolesanywhere/types/types.go index e9f35ceeb3e..52a013c7d76 100644 --- a/service/rolesanywhere/types/types.go +++ b/service/rolesanywhere/types/types.go @@ -108,9 +108,10 @@ type MappingRule struct { noSmithyDocumentSerde } -// Customizable notification settings that will be applied to notification events. -// IAM Roles Anywhere consumes these settings while notifying across multiple -// channels - CloudWatch metrics, EventBridge, and Health Dashboard. +// Customizable notification settings that will be applied to notification +// +// events. IAM Roles Anywhere consumes these settings while notifying across +// multiple channels - CloudWatch metrics, EventBridge, and Health Dashboard. type NotificationSetting struct { // Indicates whether the notification setting is enabled. @@ -124,9 +125,10 @@ type NotificationSetting struct { Event NotificationEvent // The specified channel of notification. IAM Roles Anywhere uses CloudWatch - // metrics, EventBridge, and Health Dashboard to notify for an event. In the - // absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' - // channels. + // metrics, EventBridge, and Health Dashboard to notify for an event. + // + // In the absence of a specific channel, IAM Roles Anywhere applies this setting + // to 'ALL' channels. Channel NotificationChannel // The number of days before a notification event. This value is required for a @@ -136,9 +138,10 @@ type NotificationSetting struct { noSmithyDocumentSerde } -// The state of a notification setting. A notification setting includes -// information such as event name, threshold, status of the notification setting, -// and the channel to notify. +// The state of a notification setting. +// +// A notification setting includes information such as event name, threshold, +// status of the notification setting, and the channel to notify. type NotificationSettingDetail struct { // Indicates whether the notification setting is enabled. @@ -152,9 +155,10 @@ type NotificationSettingDetail struct { Event NotificationEvent // The specified channel of notification. IAM Roles Anywhere uses CloudWatch - // metrics, EventBridge, and Health Dashboard to notify for an event. In the - // absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' - // channels. + // metrics, EventBridge, and Health Dashboard to notify for an event. + // + // In the absence of a specific channel, IAM Roles Anywhere applies this setting + // to 'ALL' channels. Channel NotificationChannel // The principal that configured the notification setting. For default settings @@ -195,10 +199,11 @@ type ProfileDetail struct { // The Amazon Web Services account that created the profile. CreatedBy *string - // Used to determine how long sessions vended using this profile are valid for. - // See the Expiration section of the CreateSession API documentation (https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object) - // page for more details. In requests, if this value is not provided, the default - // value will be 3600. + // Used to determine how long sessions vended using this profile are valid for. + // See the Expiration section of the [CreateSession API documentation] page for more details. In requests, if this + // value is not provided, the default value will be 3600. + // + // [CreateSession API documentation]: https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html#credentials-object DurationSeconds *int32 // Indicates whether the profile is enabled. @@ -256,8 +261,9 @@ type SourceData interface { isSourceData() } -// The root certificate of the Private Certificate Authority specified by this ARN -// is used in trust validation for temporary credential requests. Included for +// The root certificate of the Private Certificate Authority specified by this +// +// ARN is used in trust validation for temporary credential requests. Included for // trust anchors of type AWS_ACM_PCA . type SourceDataMemberAcmPcaArn struct { Value string diff --git a/service/route53/api_op_AssociateVPCWithHostedZone.go b/service/route53/api_op_AssociateVPCWithHostedZone.go index d20fa85c76d..0c01a67d73b 100644 --- a/service/route53/api_op_AssociateVPCWithHostedZone.go +++ b/service/route53/api_op_AssociateVPCWithHostedZone.go @@ -11,23 +11,33 @@ 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 -// 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: +// 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 // -// 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] in the Amazon Web Services General Reference. +// +// [Access Management]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html func (c *Client) AssociateVPCWithHostedZone(ctx context.Context, params *AssociateVPCWithHostedZoneInput, optFns ...func(*Options)) (*AssociateVPCWithHostedZoneOutput, error) { if params == nil { params = &AssociateVPCWithHostedZoneInput{} @@ -47,9 +57,10 @@ 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 @@ -60,7 +71,7 @@ type AssociateVPCWithHostedZoneInput struct { // This member is required. VPC *types.VPC - // Optional: A comment about the association request. + // Optional: A comment about the association request. Comment *string noSmithyDocumentSerde diff --git a/service/route53/api_op_ChangeCidrCollection.go b/service/route53/api_op_ChangeCidrCollection.go index f4bdd8b3c6c..fd8bdb239ee 100644 --- a/service/route53/api_op_ChangeCidrCollection.go +++ b/service/route53/api_op_ChangeCidrCollection.go @@ -12,14 +12,23 @@ import ( ) // Creates, changes, or deletes CIDR blocks within a collection. Contains -// authoritative IP information mapping blocks to one or multiple locations. A -// change request can update multiple locations in a collection at a time, which is -// helpful if you want to move one or more CIDR blocks from one location to another -// in one transaction, without downtime. Limits The max number of CIDR blocks -// 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: +// authoritative IP information mapping blocks to one or multiple locations. +// +// A change request can update multiple locations in a collection at a time, which +// is helpful if you want to move one or more CIDR blocks from one location to +// another in one transaction, without downtime. +// +// # Limits +// +// The max number of CIDR blocks 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. func (c *Client) ChangeCidrCollection(ctx context.Context, params *ChangeCidrCollectionInput, optFns ...func(*Options)) (*ChangeCidrCollectionOutput, error) { if params == nil { @@ -38,7 +47,7 @@ func (c *Client) ChangeCidrCollection(ctx context.Context, params *ChangeCidrCol type ChangeCidrCollectionInput struct { - // Information about changes to a CIDR collection. + // Information about changes to a CIDR collection. // // This member is required. Changes []types.CidrCollectionChange @@ -49,13 +58,16 @@ type ChangeCidrCollectionInput struct { 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 + // 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 diff --git a/service/route53/api_op_ChangeResourceRecordSets.go b/service/route53/api_op_ChangeResourceRecordSets.go index 8a77d7e8ec1..21b1fab3ff0 100644 --- a/service/route53/api_op_ChangeResourceRecordSets.go +++ b/service/route53/api_op_ChangeResourceRecordSets.go @@ -16,56 +16,85 @@ import ( // 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 -// ChangeResourceRecordsSetsRequest to perform the following actions: +// 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]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 doesn't exist, Route 53 creates it. 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 -// 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 -// you submit a ChangeResourceRecordSets request, Route 53 propagates your changes -// to all of the Route 53 authoritative DNS servers managing the hosted zone. While -// your changes are propagating, GetChange returns a status of PENDING . When -// propagation is complete, GetChange returns a status of INSYNC . Changes +// # 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 you submit a ChangeResourceRecordSets request, Route 53 propagates your +// changes to all of the Route 53 authoritative DNS servers managing the hosted +// zone. 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 managing the hosted zone 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. +// 60 seconds. For more information, see [GetChange]. +// +// # Limits on ChangeResourceRecordSets Requests +// +// For information about the limits on a ChangeResourceRecordSets request, see [Limits] in +// the Amazon Route 53 Developer Guide. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [GetChange]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html +// [Using Traffic Flow to Route DNS Traffic]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html func (c *Client) ChangeResourceRecordSets(ctx context.Context, params *ChangeResourceRecordSetsInput, optFns ...func(*Options)) (*ChangeResourceRecordSetsOutput, error) { if params == nil { params = &ChangeResourceRecordSetsInput{} @@ -101,9 +130,12 @@ 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) - // action to get detailed information about the change. + // 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] action to get + // detailed information about the change. + // + // [GetChange]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html // // This member is required. ChangeInfo *types.ChangeInfo diff --git a/service/route53/api_op_ChangeTagsForResource.go b/service/route53/api_op_ChangeTagsForResource.go index ede20e11d0d..0ad1b4c3869 100644 --- a/service/route53/api_op_ChangeTagsForResource.go +++ b/service/route53/api_op_ChangeTagsForResource.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Billing and Cost Management User Guide. +// 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] in the Billing and +// Cost Management User Guide. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) ChangeTagsForResource(ctx context.Context, params *ChangeTagsForResourceInput, optFns ...func(*Options)) (*ChangeTagsForResourceOutput, error) { if params == nil { params = &ChangeTagsForResourceInput{} @@ -39,7 +42,9 @@ 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 . // // This member is required. @@ -47,7 +52,9 @@ type ChangeTagsForResourceInput struct { // A complex type that contains a list of the tags that you want to add to the // specified health check or hosted zone and/or the tags that you want to edit - // Value for. You can add a maximum of 10 tags to a health check or a hosted zone. + // 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 diff --git a/service/route53/api_op_CreateHealthCheck.go b/service/route53/api_op_CreateHealthCheck.go index 599092bb6d4..8f7716f59d2 100644 --- a/service/route53/api_op_CreateHealthCheck.go +++ b/service/route53/api_op_CreateHealthCheck.go @@ -11,29 +11,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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: +// Creates a new health check. +// +// For information about adding health checks to resource record sets, see [HealthCheckId] in [ChangeResourceRecordSets]. +// +// # 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: // // - 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) -// . +// CloudWatch metrics and alarms by using the CloudWatch console, see the [Amazon CloudWatch User Guide]. +// +// [HealthCheckId]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId +// [ChangeResourceRecordSets]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html +// [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{} @@ -55,19 +66,24 @@ 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. + // // Route 53 does not store the CallerReference for a deleted health check // indefinitely. The CallerReference for a deleted health check will be deleted // after a number of days. diff --git a/service/route53/api_op_CreateHostedZone.go b/service/route53/api_op_CreateHostedZone.go index 1de42e74241..66c55f87a59 100644 --- a/service/route53/api_op_CreateHostedZone.go +++ b/service/route53/api_op_CreateHostedZone.go @@ -16,39 +16,58 @@ import ( // domain, such as example.com, and its subdomains (apex.example.com, // acme.example.com). You create records in a private hosted zone to define how you // want to route traffic for a domain and its subdomains within one or more Amazon -// 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: +// 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]. +// +// 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. +// records, see [NS and SOA Records that Route 53 Creates for a Hosted Zone]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]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: +// 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] in the Amazon Web Services General Reference. +// +// [Access Management]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html +// [NS and SOA Records that Route 53 Creates for a Hosted Zone]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html +// [Amazon Route 53 Pricing]: http://aws.amazon.com/route53/pricing/ +// +// [Migrating DNS Service for an Existing Domain to Amazon Route 53]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html func (c *Client) CreateHostedZone(ctx context.Context, params *CreateHostedZoneInput, optFns ...func(*Options)) (*CreateHostedZoneOutput, error) { if params == nil { params = &CreateHostedZoneInput{} @@ -81,38 +100,49 @@ type CreateHostedZoneInput struct { // www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the // domain name 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. 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 . + // 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 . // // 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 - // it. For more information about reusable delegation sets, see - // CreateReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html) - // . If you are using a reusable delegation set to create a public hosted zone for - // a subdomain, make sure that the parent hosted zone doesn't use one or more of - // the same name servers. If you have overlapping nameservers, the operation will - // cause a ConflictingDomainsExist error. + // it. For more information about reusable delegation sets, see [CreateReusableDelegationSet]. + // + // If you are using a reusable delegation set to create a public hosted zone for a + // subdomain, make sure that the parent hosted zone doesn't use one or more of the + // same name servers. If you have overlapping nameservers, the operation will cause + // a ConflictingDomainsExist error. + // + // [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. 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) - // after you create a hosted zone. + // 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] after you create + // a hosted zone. + // + // [AssociateVPCWithHostedZone]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html VPC *types.VPC noSmithyDocumentSerde diff --git a/service/route53/api_op_CreateKeySigningKey.go b/service/route53/api_op_CreateKeySigningKey.go index 87527682ef3..4b3b2306c83 100644 --- a/service/route53/api_op_CreateKeySigningKey.go +++ b/service/route53/api_op_CreateKeySigningKey.go @@ -43,19 +43,32 @@ type CreateKeySigningKeyInput struct { // The Amazon resource name (ARN) for a customer managed key in Key Management // Service (KMS). The KeyManagementServiceArn must be unique for each key-signing // key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn - // that grants the correct permissions for DNSSEC, scroll down to Example. You must - // 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: + // that grants the correct permissions for DNSSEC, scroll down to Example. + // + // You must 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) - // . + // + // For more information about working with a customer managed key in KMS, see [Key Management Service concepts]. + // + // [Key Management Service concepts]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html // // This member is required. KeyManagementServiceArn *string diff --git a/service/route53/api_op_CreateQueryLoggingConfig.go b/service/route53/api_op_CreateQueryLoggingConfig.go index e7cdf88c00a..ecf2d6d6353 100644 --- a/service/route53/api_op_CreateQueryLoggingConfig.go +++ b/service/route53/api_op_CreateQueryLoggingConfig.go @@ -13,82 +13,119 @@ import ( // Creates a configuration for DNS query logging. After you create a query logging // configuration, Amazon Route 53 begins to publish log data to an Amazon -// 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: +// 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. +// 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. +// 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]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 +// 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]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]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]in the Amazon Route 53 Developer Guide. +// +// Pricing For information about charges for query logs, see [Amazon 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) -// . +// see [DeleteQueryLoggingConfig]. +// +// [The confused deputy problem]: https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html +// [DeleteQueryLoggingConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteQueryLoggingConfig.html +// [Routing Internet Traffic to Your Website or Web Application]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html +// [Route 53 Product Details]: http://aws.amazon.com/route53/details/ +// [Amazon CloudWatch Pricing]: http://aws.amazon.com/cloudwatch/pricing/ +// [Logging DNS Queries]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html func (c *Client) CreateQueryLoggingConfig(ctx context.Context, params *CreateQueryLoggingConfigInput, optFns ...func(*Options)) (*CreateQueryLoggingConfigOutput, error) { if params == nil { params = &CreateQueryLoggingConfigInput{} @@ -108,10 +145,15 @@ 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) - // command, or the applicable command in one of the Amazon Web Services SDKs. + // + // 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] API + // action, the [describe-log-groups]command, or the applicable command in one of the Amazon Web + // Services SDKs. + // + // [describe-log-groups]: https://docs.aws.amazon.com/cli/latest/reference/logs/describe-log-groups.html + // [DescribeLogGroups]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogGroups.html // // This member is required. CloudWatchLogsLogGroupArn *string diff --git a/service/route53/api_op_CreateReusableDelegationSet.go b/service/route53/api_op_CreateReusableDelegationSet.go index 090a71af7a5..d73194f5b76 100644 --- a/service/route53/api_op_CreateReusableDelegationSet.go +++ b/service/route53/api_op_CreateReusableDelegationSet.go @@ -13,21 +13,31 @@ import ( // Creates a delegation set (a group of four name servers) that can be reused by // multiple hosted zones that were created by the same Amazon Web Services account. +// // You can also create a reusable delegation set that uses the four name servers // that are associated with an existing hosted zone. Specify the hosted zone ID in -// 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 +// 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]. +// +// 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. // // If you want to migrate existing hosted zones to use a reusable delegation set, @@ -35,14 +45,19 @@ import ( // 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. +// +// [Configuring White Label Name Servers]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/white-label-name-servers.html func (c *Client) CreateReusableDelegationSet(ctx context.Context, params *CreateReusableDelegationSetInput, optFns ...func(*Options)) (*CreateReusableDelegationSetOutput, error) { if params == nil { params = &CreateReusableDelegationSetInput{} diff --git a/service/route53/api_op_CreateTrafficPolicy.go b/service/route53/api_op_CreateTrafficPolicy.go index c674720e112..a5801cbaa3f 100644 --- a/service/route53/api_op_CreateTrafficPolicy.go +++ b/service/route53/api_op_CreateTrafficPolicy.go @@ -33,10 +33,11 @@ func (c *Client) CreateTrafficPolicy(ctx context.Context, params *CreateTrafficP // to create. 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) + // The definition of this traffic policy in JSON format. For more information, see [Traffic Policy Document Format] // . // + // [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 d010db001ed..d0e5aa35367 100644 --- a/service/route53/api_op_CreateTrafficPolicyInstance.go +++ b/service/route53/api_op_CreateTrafficPolicyInstance.go @@ -16,12 +16,13 @@ import ( // 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 -// record sets that CreateTrafficPolicyInstance created. After you submit an -// CreateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 -// creates the resource record sets that are specified in the traffic policy -// definition. Use GetTrafficPolicyInstance with the id of new traffic policy -// instance to confirm that the CreateTrafficPolicyInstance request completed -// successfully. For more information, see the State response element. +// record sets that CreateTrafficPolicyInstance created. +// +// After you submit an CreateTrafficPolicyInstance request, there's a brief delay +// while Amazon Route 53 creates the resource record sets that are specified in the +// traffic policy definition. Use GetTrafficPolicyInstance with the id of new +// traffic policy instance to confirm that the CreateTrafficPolicyInstance request +// completed successfully. For more information, see the State response element. func (c *Client) CreateTrafficPolicyInstance(ctx context.Context, params *CreateTrafficPolicyInstanceInput, optFns ...func(*Options)) (*CreateTrafficPolicyInstanceOutput, error) { if params == nil { params = &CreateTrafficPolicyInstanceInput{} diff --git a/service/route53/api_op_CreateTrafficPolicyVersion.go b/service/route53/api_op_CreateTrafficPolicyVersion.go index 124c31ae2e0..80232dfe26c 100644 --- a/service/route53/api_op_CreateTrafficPolicyVersion.go +++ b/service/route53/api_op_CreateTrafficPolicyVersion.go @@ -40,8 +40,9 @@ 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]. + // + // [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_CreateVPCAssociationAuthorization.go b/service/route53/api_op_CreateVPCAssociationAuthorization.go index 7dda0a35e89..9e5da95e484 100644 --- a/service/route53/api_op_CreateVPCAssociationAuthorization.go +++ b/service/route53/api_op_CreateVPCAssociationAuthorization.go @@ -16,10 +16,11 @@ import ( // specified hosted zone that was created by a different account. To submit a // CreateVPCAssociationAuthorization request, you must use the account that created // the hosted zone. After you authorize the association, use the account that -// created the VPC to submit an AssociateVPCWithHostedZone request. If you want to -// associate multiple VPCs that you created by using one account with a hosted zone -// that you created by using a different account, you must submit one authorization -// request for each VPC. +// created the VPC to submit an AssociateVPCWithHostedZone request. +// +// If you want to associate multiple VPCs that you created by using one account +// with a hosted zone that you created by using a different account, you must +// submit one authorization request for each VPC. func (c *Client) CreateVPCAssociationAuthorization(ctx context.Context, params *CreateVPCAssociationAuthorizationInput, optFns ...func(*Options)) (*CreateVPCAssociationAuthorizationOutput, error) { if params == nil { params = &CreateVPCAssociationAuthorizationInput{} diff --git a/service/route53/api_op_DeleteHealthCheck.go b/service/route53/api_op_DeleteHealthCheck.go index 257793f8ba0..9cf550b8e25 100644 --- a/service/route53/api_op_DeleteHealthCheck.go +++ b/service/route53/api_op_DeleteHealthCheck.go @@ -10,19 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a health check. Amazon Route 53 does not prevent you from deleting a -// health check even if the health check is associated with one or more resource -// record sets. If you delete a health check and you don't update the associated -// 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) -// 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 -// health check. The health check is deleted automatically when you deregister the -// instance; there can be a delay of several hours before the health check is -// deleted from Route 53. +// Deletes a health check. +// +// Amazon Route 53 does not prevent you from deleting a health check even if the +// health check is associated with one or more resource record sets. If you delete +// a health check and you don't update the associated 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]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 health check. The health check is +// deleted automatically when you deregister the instance; there can be a delay of +// several hours before the health check is deleted from Route 53. +// +// [Replacing and Deleting Health Checks]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html#health-checks-deleting.html func (c *Client) DeleteHealthCheck(ctx context.Context, params *DeleteHealthCheckInput, optFns ...func(*Options)) (*DeleteHealthCheckOutput, error) { if params == nil { params = &DeleteHealthCheckInput{} diff --git a/service/route53/api_op_DeleteHostedZone.go b/service/route53/api_op_DeleteHostedZone.go index 6e7e05a7fa3..ee40cbfb629 100644 --- a/service/route53/api_op_DeleteHostedZone.go +++ b/service/route53/api_op_DeleteHostedZone.go @@ -11,39 +11,52 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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 -// to stop routing internet traffic to your website or web application, we -// recommend that you delete resource record sets in the hosted zone instead of -// deleting the hosted zone. If you delete a hosted zone, you can't undelete it. -// You must create a new hosted zone and update the name servers for your domain -// registration, which can require up to 48 hours to take effect. (If you delegated -// responsibility for a subdomain to a hosted zone and you delete the child hosted -// zone, you must update the name servers in the parent hosted zone.) In addition, -// if you delete a hosted zone, someone could hijack the domain and route traffic -// to their own resources using your domain name. If you want to avoid the monthly -// 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) -// 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 -// registration. For more information, perform an internet search on "free DNS -// service." You can delete a hosted zone only if it contains only the default SOA -// record and NS resource record sets. If the hosted zone contains other resource -// 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: +// 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] 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 to stop routing +// internet traffic to your website or web application, we recommend that you +// delete resource record sets in the hosted zone instead of deleting the hosted +// zone. +// +// If you delete a hosted zone, you can't undelete it. You must create a new +// hosted zone and update the name servers for your domain registration, which can +// require up to 48 hours to take effect. (If you delegated responsibility for a +// subdomain to a hosted zone and you delete the child hosted zone, you must update +// the name servers in the parent hosted zone.) In addition, if you delete a hosted +// zone, someone could hijack the domain and route traffic to their own resources +// using your domain name. +// +// If you want to avoid the monthly 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]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 registration. For more information, perform +// an internet search on "free DNS service." +// +// You can delete a hosted zone only if it contains only the default SOA record +// and NS resource record sets. If the hosted zone contains other resource 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]. +// +// 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. +// +// [ChangeResourceRecordSets]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html +// [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 +// [UpdateDomainNameservers]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainNameservers.html 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 1d928b4bd01..f2e02f4aad9 100644 --- a/service/route53/api_op_DeleteKeySigningKey.go +++ b/service/route53/api_op_DeleteKeySigningKey.go @@ -13,10 +13,14 @@ 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. +// of whether the hosted zone is enabled for DNSSEC signing. +// +// You can use [DeactivateKeySigningKey] to deactivate the key before you delete it. +// +// Use [GetDNSSEC] to verify that the KSK is in an INACTIVE status. +// +// [DeactivateKeySigningKey]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeactivateKeySigningKey.html +// [GetDNSSEC]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetDNSSEC.html 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 2eb86005f5a..17e7710b4e1 100644 --- a/service/route53/api_op_DeleteQueryLoggingConfig.go +++ b/service/route53/api_op_DeleteQueryLoggingConfig.go @@ -12,9 +12,11 @@ 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) -// . +// delete any logs that are already in CloudWatch Logs. +// +// For more information about DNS query logs, see [CreateQueryLoggingConfig]. +// +// [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 ad53991b6b7..9227feb3664 100644 --- a/service/route53/api_op_DeleteReusableDelegationSet.go +++ b/service/route53/api_op_DeleteReusableDelegationSet.go @@ -10,12 +10,16 @@ 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 -// delegation set is not associated with any hosted zones, submit a -// 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. +// 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]request and specify the ID of the reusable delegation set that +// you want to delete. +// +// [GetReusableDelegationSet]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSet.html func (c *Client) DeleteReusableDelegationSet(ctx context.Context, params *DeleteReusableDelegationSetInput, optFns ...func(*Options)) (*DeleteReusableDelegationSetOutput, error) { if params == nil { params = &DeleteReusableDelegationSetInput{} diff --git a/service/route53/api_op_DeleteTrafficPolicy.go b/service/route53/api_op_DeleteTrafficPolicy.go index 36e11f308ec..936c575526e 100644 --- a/service/route53/api_op_DeleteTrafficPolicy.go +++ b/service/route53/api_op_DeleteTrafficPolicy.go @@ -10,15 +10,21 @@ 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 -// 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) -// . +// 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]. +// // - 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) -// . +// policy, including the traffic policy document, by running [GetTrafficPolicy]. +// +// [ListTrafficPolicies]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListTrafficPolicies.html +// [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 b6a78c86019..5dae1ce710a 100644 --- a/service/route53/api_op_DeleteTrafficPolicyInstance.go +++ b/service/route53/api_op_DeleteTrafficPolicyInstance.go @@ -11,8 +11,9 @@ import ( ) // Deletes a traffic policy instance and all of the resource record sets that -// Amazon Route 53 created when you created the instance. In the Route 53 console, -// traffic policy instances are known as policy records. +// Amazon Route 53 created when you created the instance. +// +// In the Route 53 console, traffic policy instances are known as policy records. func (c *Client) DeleteTrafficPolicyInstance(ctx context.Context, params *DeleteTrafficPolicyInstanceInput, optFns ...func(*Options)) (*DeleteTrafficPolicyInstanceOutput, error) { if params == nil { params = &DeleteTrafficPolicyInstanceInput{} @@ -31,9 +32,11 @@ 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 1d010947364..95d032cde26 100644 --- a/service/route53/api_op_DeleteVPCAssociationAuthorization.go +++ b/service/route53/api_op_DeleteVPCAssociationAuthorization.go @@ -14,12 +14,14 @@ import ( // Removes authorization to submit an AssociateVPCWithHostedZone request to // associate a specified VPC with a hosted zone that was created by a different // account. You must use the account that created the hosted zone to submit a -// DeleteVPCAssociationAuthorization request. Sending this request only prevents -// the Amazon Web Services account that created the VPC from associating the VPC -// 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 . +// DeleteVPCAssociationAuthorization request. +// +// Sending this request only prevents the Amazon Web Services account that created +// the VPC from associating the VPC 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 . 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 b3d628d737f..5e1d8b6dc5d 100644 --- a/service/route53/api_op_DisassociateVPCFromHostedZone.go +++ b/service/route53/api_op_DisassociateVPCFromHostedZone.go @@ -25,21 +25,29 @@ import ( // 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 . +// hosted zone using your account. +// +// When you run [DisassociateVPCFromHostedZone], 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: +// 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] in the Amazon Web Services General Reference. +// +// [Access Management]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html +// [DisassociateVPCFromHostedZone]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListHostedZonesByVPC.html func (c *Client) DisassociateVPCFromHostedZone(ctx context.Context, params *DisassociateVPCFromHostedZoneInput, optFns ...func(*Options)) (*DisassociateVPCFromHostedZoneOutput, error) { if params == nil { params = &DisassociateVPCFromHostedZoneInput{} @@ -70,7 +78,7 @@ type DisassociateVPCFromHostedZoneInput struct { // This member is required. VPC *types.VPC - // Optional: A comment about the disassociation request. + // Optional: A comment about the disassociation request. Comment *string noSmithyDocumentSerde diff --git a/service/route53/api_op_GetAccountLimit.go b/service/route53/api_op_GetAccountLimit.go index 79166c59c3e..453ee564228 100644 --- a/service/route53/api_op_GetAccountLimit.go +++ b/service/route53/api_op_GetAccountLimit.go @@ -12,13 +12,18 @@ 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 +// number of health checks that you can create using the account. +// +// For the default limit, see [Limits] in the Amazon Route 53 Developer Guide. To request +// a higher limit, [open a case]. +// +// 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. +// console at [https://console.aws.amazon.com/trustedadvisor/]. Then choose Service limits in the navigation pane. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [https://console.aws.amazon.com/trustedadvisor/]: https://console.aws.amazon.com/trustedadvisor +// [open a case]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-route53 func (c *Client) GetAccountLimit(ctx context.Context, params *GetAccountLimitInput, optFns ...func(*Options)) (*GetAccountLimitOutput, error) { if params == nil { params = &GetAccountLimitInput{} @@ -39,14 +44,19 @@ 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 diff --git a/service/route53/api_op_GetChange.go b/service/route53/api_op_GetChange.go index bae3eac933d..4cfbe7567f6 100644 --- a/service/route53/api_op_GetChange.go +++ b/service/route53/api_op_GetChange.go @@ -17,9 +17,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 managing the hosted zone. This is the initial // status of all change batch requests. +// // - INSYNC indicates that the changes have propagated to all Route 53 DNS // servers managing the hosted zone. func (c *Client) GetChange(ctx context.Context, params *GetChangeInput, optFns ...func(*Options)) (*GetChangeOutput, error) { @@ -187,12 +189,13 @@ type ResourceRecordSetsChangedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetChangeInput, *GetChangeOutput, error) (bool, error) } diff --git a/service/route53/api_op_GetCheckerIpRanges.go b/service/route53/api_op_GetCheckerIpRanges.go index 7b7ad743de8..efc1d6bda95 100644 --- a/service/route53/api_op_GetCheckerIpRanges.go +++ b/service/route53/api_op_GetCheckerIpRanges.go @@ -11,11 +11,13 @@ import ( ) // Route 53 does not perform authorization for this API because it retrieves -// 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) -// in the Amazon Route 53 Developer Guide. +// 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]in the Amazon Route 53 Developer Guide. +// +// [IP Address Ranges of Amazon Route 53 Servers]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/route-53-ip-addresses.html func (c *Client) GetCheckerIpRanges(ctx context.Context, params *GetCheckerIpRangesInput, optFns ...func(*Options)) (*GetCheckerIpRangesOutput, error) { if params == nil { params = &GetCheckerIpRangesInput{} diff --git a/service/route53/api_op_GetGeoLocation.go b/service/route53/api_op_GetGeoLocation.go index 2b86fbe8219..6b6803a35e3 100644 --- a/service/route53/api_op_GetGeoLocation.go +++ b/service/route53/api_op_GetGeoLocation.go @@ -12,17 +12,27 @@ import ( ) // Gets information about whether a specified geographic location is supported for -// Amazon Route 53 geolocation resource record sets. Route 53 does not perform -// authorization for this API because it retrieves information that is already -// available to the public. Use the following syntax to determine whether a -// continent is supported for geolocation: GET -// /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent +// Amazon Route 53 geolocation resource record sets. +// +// Route 53 does not perform authorization for this API because it retrieves +// information that is already available to the public. +// +// Use the following syntax to determine whether a continent is supported for +// geolocation: +// +// GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a +// continent +// // Use the following syntax to determine whether a country is supported for -// geolocation: GET /2013-04-01/geolocation?countrycode=two-character country code +// 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{} @@ -44,26 +54,35 @@ 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 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) . + // Amazon Route 53 uses the two-letter country codes that are specified in [ISO standard 3166-1 alpha-2]. + // // Route 53 also supports the country code UA for Ukraine. + // + // [ISO 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) - // API. + // States. For a list of US state abbreviations, see [Appendix B: Two–Letter State and Possession Abbreviations]on the United States Postal + // Service website. For a list of all supported subdivision codes, use the [ListGeoLocations]API. + // + // [ListGeoLocations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html + // [Appendix B: Two–Letter State and Possession Abbreviations]: https://pe.usps.com/text/pub28/28apb.htm SubdivisionCode *string noSmithyDocumentSerde diff --git a/service/route53/api_op_GetHealthCheckLastFailureReason.go b/service/route53/api_op_GetHealthCheckLastFailureReason.go index fb3d482179d..0cb1a6c4471 100644 --- a/service/route53/api_op_GetHealthCheckLastFailureReason.go +++ b/service/route53/api_op_GetHealthCheckLastFailureReason.go @@ -32,10 +32,11 @@ 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 - // calculated health check. + // 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. HealthCheckId *string diff --git a/service/route53/api_op_GetHealthCheckStatus.go b/service/route53/api_op_GetHealthCheckStatus.go index 6497af94e83..deb6fc4a213 100644 --- a/service/route53/api_op_GetHealthCheckStatus.go +++ b/service/route53/api_op_GetHealthCheckStatus.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets status of a specified health check. This API is intended for use during -// development to diagnose behavior. It doesn’t support production use-cases with -// high query rates that require immediate and actionable responses. +// Gets status of a specified health check. +// +// This API is intended for use during development to diagnose behavior. It +// doesn’t support production use-cases with high query rates that require +// immediate and actionable responses. func (c *Client) GetHealthCheckStatus(ctx context.Context, params *GetHealthCheckStatusInput, optFns ...func(*Options)) (*GetHealthCheckStatusOutput, error) { if params == nil { params = &GetHealthCheckStatusInput{} @@ -34,10 +36,11 @@ type GetHealthCheckStatusInput struct { // The ID for the health check that you want the current status for. When you // created the health check, CreateHealthCheck returned the ID in the response, in - // the HealthCheckId element. If you want to check the status of a calculated - // health check, you must use the Amazon Route 53 console or the CloudWatch - // console. You can't use GetHealthCheckStatus to get the status of a calculated - // health check. + // the HealthCheckId element. + // + // If you want to check the status of a calculated health check, you must use the + // Amazon Route 53 console or the CloudWatch console. You can't use + // GetHealthCheckStatus to get the status of a calculated health check. // // This member is required. HealthCheckId *string diff --git a/service/route53/api_op_GetHostedZoneLimit.go b/service/route53/api_op_GetHostedZoneLimit.go index 6808d300234..53407c1c0d0 100644 --- a/service/route53/api_op_GetHostedZoneLimit.go +++ b/service/route53/api_op_GetHostedZoneLimit.go @@ -12,10 +12,13 @@ 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) -// . +// number of records that you can create in the hosted zone. +// +// For the default limit, see [Limits] in the Amazon Route 53 Developer Guide. To request +// a higher limit, [open a case]. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [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{} @@ -41,8 +44,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. // diff --git a/service/route53/api_op_GetQueryLoggingConfig.go b/service/route53/api_op_GetQueryLoggingConfig.go index cd4998fe40f..ffa0adab78c 100644 --- a/service/route53/api_op_GetQueryLoggingConfig.go +++ b/service/route53/api_op_GetQueryLoggingConfig.go @@ -11,10 +11,12 @@ 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] and [Logging DNS Queries]. +// +// [CreateQueryLoggingConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html +// [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{} @@ -44,8 +46,9 @@ 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) - // request. + // that you specified in a [GetQueryLoggingConfig]request. + // + // [GetQueryLoggingConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetQueryLoggingConfig.html // // This member is required. QueryLoggingConfig *types.QueryLoggingConfig diff --git a/service/route53/api_op_GetReusableDelegationSetLimit.go b/service/route53/api_op_GetReusableDelegationSetLimit.go index 6ea5e11e3a6..3e6d7e4d5ab 100644 --- a/service/route53/api_op_GetReusableDelegationSetLimit.go +++ b/service/route53/api_op_GetReusableDelegationSetLimit.go @@ -12,9 +12,13 @@ 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] in the Amazon Route 53 Developer Guide. To request +// a higher limit, [open a case]. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [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{} diff --git a/service/route53/api_op_GetTrafficPolicy.go b/service/route53/api_op_GetTrafficPolicy.go index 4dc99ed1fba..b6b2a1f657a 100644 --- a/service/route53/api_op_GetTrafficPolicy.go +++ b/service/route53/api_op_GetTrafficPolicy.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Gets information about a specific traffic policy version. +// +// For information about how of deleting a traffic policy affects the response +// from GetTrafficPolicy , see [DeleteTrafficPolicy]. +// +// [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 34f1b2cdab2..e9e6f04c1d0 100644 --- a/service/route53/api_op_GetTrafficPolicyInstance.go +++ b/service/route53/api_op_GetTrafficPolicyInstance.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about a specified traffic policy instance. Use -// GetTrafficPolicyInstance with the id of new traffic policy instance to confirm -// that the CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request -// completed successfully. For more information, see the State response element. +// Gets information about a specified traffic policy instance. +// +// Use GetTrafficPolicyInstance with the id of new traffic policy instance to +// confirm that the CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance +// request completed successfully. For more information, see the State response +// element. +// // In the Route 53 console, traffic policy instances are known as policy records. func (c *Client) GetTrafficPolicyInstance(ctx context.Context, params *GetTrafficPolicyInstanceInput, optFns ...func(*Options)) (*GetTrafficPolicyInstanceOutput, error) { if params == nil { diff --git a/service/route53/api_op_ListCidrBlocks.go b/service/route53/api_op_ListCidrBlocks.go index 7dfdd467a8d..8cb3f46c34b 100644 --- a/service/route53/api_op_ListCidrBlocks.go +++ b/service/route53/api_op_ListCidrBlocks.go @@ -53,8 +53,9 @@ type ListCidrBlocksOutput struct { 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. + // 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 268958b72b8..3070bdf939a 100644 --- a/service/route53/api_op_ListCidrCollections.go +++ b/service/route53/api_op_ListCidrCollections.go @@ -34,8 +34,9 @@ type ListCidrCollectionsInput struct { 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. + // enumerating results. + // + // If no value is provided, the listing of results starts from the beginning. NextToken *string noSmithyDocumentSerde @@ -47,8 +48,9 @@ type ListCidrCollectionsOutput struct { 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. + // 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_ListCidrLocations.go b/service/route53/api_op_ListCidrLocations.go index 4f9d09ef0a8..d0672317133 100644 --- a/service/route53/api_op_ListCidrLocations.go +++ b/service/route53/api_op_ListCidrLocations.go @@ -39,8 +39,9 @@ type ListCidrLocationsInput struct { 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. + // enumerating results. + // + // If no value is provided, the listing of results starts from the beginning. NextToken *string noSmithyDocumentSerde @@ -52,8 +53,9 @@ type ListCidrLocationsOutput struct { 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. + // 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 e5df00f0488..daec29743ce 100644 --- a/service/route53/api_op_ListGeoLocations.go +++ b/service/route53/api_op_ListGeoLocations.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of supported geographic locations. Countries are listed first, -// and continents are listed last. If Amazon Route 53 supports subdivisions for a -// country (for example, states or provinces), the subdivisions for that country -// are listed in alphabetical order immediately after the corresponding country. +// Retrieves a list of supported geographic locations. +// +// Countries are listed first, and continents are listed last. If Amazon Route 53 +// supports subdivisions for a country (for example, states or provinces), the +// subdivisions for that country 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) -// data type. +// information that is already available to the public. +// +// For a list of supported geolocation codes, see the [GeoLocation] data type. +// +// [GeoLocation]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html func (c *Client) ListGeoLocations(ctx context.Context, params *ListGeoLocationsInput, optFns ...func(*Options)) (*ListGeoLocationsOutput, error) { if params == nil { params = &ListGeoLocationsInput{} @@ -47,9 +52,11 @@ type ListGeoLocationsInput struct { // Amazon Route 53 supports for geolocation. If Route 53 has already returned a // page or more of results, if IsTruncated is true, and if NextContinentCode from // the previous response has a value, enter that value in startcontinentcode to - // return the next page of results. Include startcontinentcode only if you want to - // list continents. Don't include startcontinentcode when you're listing countries - // or countries with their subdivisions. + // return the next page of results. + // + // Include startcontinentcode only if you want to list continents. Don't include + // startcontinentcode when you're listing countries or countries with their + // subdivisions. StartContinentCode *string // The code for the country with which you want to start listing locations that @@ -63,8 +70,10 @@ type ListGeoLocationsInput struct { // 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 . + // startsubdivisioncode to return the next page of results. + // + // To list subdivisions (U.S. states), you must include both startcountrycode and + // startsubdivisioncode . StartSubdivisionCode *string noSmithyDocumentSerde diff --git a/service/route53/api_op_ListHealthChecks.go b/service/route53/api_op_ListHealthChecks.go index 6b7bf8f8b1e..0651be8148f 100644 --- a/service/route53/api_op_ListHealthChecks.go +++ b/service/route53/api_op_ListHealthChecks.go @@ -34,10 +34,13 @@ type ListHealthChecksInput struct { // 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 // 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. + // 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. Marker *string // The maximum number of health checks that you want ListHealthChecks to return in diff --git a/service/route53/api_op_ListHostedZones.go b/service/route53/api_op_ListHostedZones.go index 91eefa0f803..616ecc7c41d 100644 --- a/service/route53/api_op_ListHostedZones.go +++ b/service/route53/api_op_ListHostedZones.go @@ -13,9 +13,11 @@ import ( // 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. +// 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{} @@ -40,15 +42,18 @@ type ListHostedZonesInput struct { // reusable delegation set. DelegationSetId *string - // (Optional) Specifies if the hosted zone is private. + // (Optional) Specifies if the hosted zone is private. HostedZoneType types.HostedZoneType // 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 // 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. + // 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. Marker *string // (Optional) The maximum number of hosted zones that you want Amazon Route 53 to @@ -91,6 +96,7 @@ type ListHostedZonesOutput struct { // 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 diff --git a/service/route53/api_op_ListHostedZonesByName.go b/service/route53/api_op_ListHostedZonesByName.go index fb4e5703fc1..e86cecb01d7 100644 --- a/service/route53/api_op_ListHostedZonesByName.go +++ b/service/route53/api_op_ListHostedZonesByName.go @@ -13,38 +13,56 @@ 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 +// 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) -// 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: +// 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]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. +// 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. +// +// [DNS Domain Name Format]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html func (c *Client) ListHostedZonesByName(ctx context.Context, params *ListHostedZonesByNameInput, optFns ...func(*Options)) (*ListHostedZonesByNameOutput, error) { if params == nil { params = &ListHostedZonesByNameInput{} @@ -74,12 +92,13 @@ type ListHostedZonesByNameInput struct { 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 - // ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For - // the value of hostedzoneid , specify the value of the NextHostedZoneId element - // from the previous response. + // 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 from the previous response. HostedZoneId *string // The maximum number of hosted zones to be included in the response body for this @@ -125,15 +144,17 @@ type ListHostedZonesByNameOutput struct { // 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 . + // 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 // 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 . + // NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively. + // + // This 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 0843b085243..24f2645f724 100644 --- a/service/route53/api_op_ListHostedZonesByVPC.go +++ b/service/route53/api_op_ListHostedZonesByVPC.go @@ -15,9 +15,11 @@ 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 @@ -26,13 +28,19 @@ import ( // 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: +// 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] in the Amazon Web Services General Reference. +// +// [Access Management]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html func (c *Client) ListHostedZonesByVPC(ctx context.Context, params *ListHostedZonesByVPCInput, optFns ...func(*Options)) (*ListHostedZonesByVPCOutput, error) { if params == nil { params = &ListHostedZonesByVPCInput{} @@ -72,9 +80,13 @@ type ListHostedZonesByVPCInput struct { // 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 - // NextToken from the previous response. If the previous response didn't include a - // NextToken element, there are no more hosted zones to get. + // 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 noSmithyDocumentSerde diff --git a/service/route53/api_op_ListQueryLoggingConfigs.go b/service/route53/api_op_ListQueryLoggingConfigs.go index 6d38c3e482a..35e078d239a 100644 --- a/service/route53/api_op_ListQueryLoggingConfigs.go +++ b/service/route53/api_op_ListQueryLoggingConfigs.go @@ -13,11 +13,14 @@ 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. +// a specified hosted zone. +// +// For more information about DNS query logs, see [CreateQueryLoggingConfig]. Additional information, +// including the format of DNS query logs, appears in [Logging DNS Queries]in the Amazon Route 53 +// Developer Guide. +// +// [CreateQueryLoggingConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateQueryLoggingConfig.html +// [Logging DNS Queries]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/query-logs.html func (c *Client) ListQueryLoggingConfigs(ctx context.Context, params *ListQueryLoggingConfigsInput, optFns ...func(*Options)) (*ListQueryLoggingConfigsOutput, error) { if params == nil { params = &ListQueryLoggingConfigsInput{} @@ -36,24 +39,32 @@ 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 - // specify a hosted zone ID, ListQueryLoggingConfigs returns all of the - // configurations that are associated with the current Amazon Web Services account. + // 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 // (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) - // 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. + // value of [NextToken]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. + // + // [NextToken]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax MaxResults *int32 // (Optional) If the current Amazon Web Services account has more than MaxResults // query logging configurations, use NextToken to get the second and subsequent - // pages of results. For the first ListQueryLoggingConfigs 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. + // pages of results. + // + // For the first ListQueryLoggingConfigs 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 noSmithyDocumentSerde @@ -61,20 +72,24 @@ type ListQueryLoggingConfigsInput struct { type ListQueryLoggingConfigsOutput struct { - // 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. + // An array that contains one [QueryLoggingConfig] element for each configuration for DNS query + // logging that is associated with the current Amazon Web Services account. + // + // [QueryLoggingConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_QueryLoggingConfig.html // // This member is required. QueryLoggingConfigs []types.QueryLoggingConfig // If a response includes the last of the query logging 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 - // 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. + // appear in the response. + // + // If a response doesn't include the last of the configurations, you can get more + // configurations by submitting another [ListQueryLoggingConfigs]request. Get the value of NextToken that + // Amazon Route 53 returned in the previous response and include it in NextToken + // in the next request. + // + // [ListQueryLoggingConfigs]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html NextToken *string // Metadata pertaining to the operation's result. @@ -176,9 +191,12 @@ 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) - // 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. + // value of [NextToken]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. + // + // [NextToken]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListQueryLoggingConfigs.html#API_ListQueryLoggingConfigs_RequestSyntax 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 d0505a3a1d2..d1953f3239f 100644 --- a/service/route53/api_op_ListResourceRecordSets.go +++ b/service/route53/api_op_ListResourceRecordSets.go @@ -12,36 +12,63 @@ import ( ) // Lists the resource record sets in a specified hosted zone. -// ListResourceRecordSets returns up to 300 resource record sets at a time in ASCII -// order, beginning at a position specified by the name and type elements. Sort -// 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, -// 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. +// +// ListResourceRecordSets returns up to 300 resource record sets at a time in +// ASCII order, beginning at a position specified by the name and type elements. +// +// # Sort 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, 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 +// 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 . +// 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{} @@ -75,7 +102,7 @@ type ListResourceRecordSetsInput struct { // resource record sets. MaxItems *int32 - // Resource record sets that have a routing policy other than simple: If results + // Resource record sets that have a routing policy other than simple: If results // were truncated for a given DNS name and type, specify the value of // NextRecordIdentifier from the previous response to get the next resource record // set that has the current DNS name and type. @@ -86,19 +113,31 @@ type ListResourceRecordSetsInput struct { // 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 - // resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | - // TXT Values for alias resource record sets: + // 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 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. StartRecordType types.RRType @@ -126,19 +165,24 @@ type ListResourceRecordSetsOutput struct { // This member is required. ResourceRecordSets []types.ResourceRecordSet - // Resource record sets that have a routing policy other than simple: If results + // 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) - // in the Amazon Route 53 Developer Guide. + // the next resource record set that has the current DNS name and type. + // + // For information about routing policies, see [Choosing a Routing Policy] in the Amazon Route 53 Developer + // Guide. + // + // [Choosing a Routing Policy]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html NextRecordIdentifier *string - // If the results were truncated, the name of the next record in the list. This - // element is present only if IsTruncated is true. + // If the results were truncated, the name of the next record in the list. + // + // This element is present only if IsTruncated is true. NextRecordName *string - // If the results were truncated, the type of the next record in the list. This - // element is present only if IsTruncated is true. + // If the results were truncated, the type of the next record in the list. + // + // This element is present only if IsTruncated is true. NextRecordType types.RRType // Metadata pertaining to the operation's result. diff --git a/service/route53/api_op_ListReusableDelegationSets.go b/service/route53/api_op_ListReusableDelegationSets.go index c7bbb683d0b..2408893b857 100644 --- a/service/route53/api_op_ListReusableDelegationSets.go +++ b/service/route53/api_op_ListReusableDelegationSets.go @@ -34,9 +34,12 @@ type ListReusableDelegationSetsInput struct { // 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 - // 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. + // 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 // more reusable delegation sets to get. Marker *string diff --git a/service/route53/api_op_ListTagsForResource.go b/service/route53/api_op_ListTagsForResource.go index db421ed74d4..935a48865f6 100644 --- a/service/route53/api_op_ListTagsForResource.go +++ b/service/route53/api_op_ListTagsForResource.go @@ -11,9 +11,12 @@ 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) -// in the Billing and Cost Management User Guide. +// Lists tags for one health check or hosted zone. +// +// For information about using tags for cost allocation, see [Using Cost Allocation Tags] in the Billing and +// Cost Management User Guide. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -39,7 +42,9 @@ 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 . // // This member is required. diff --git a/service/route53/api_op_ListTagsForResources.go b/service/route53/api_op_ListTagsForResources.go index 260da1ba3a9..f6b92eac1fd 100644 --- a/service/route53/api_op_ListTagsForResources.go +++ b/service/route53/api_op_ListTagsForResources.go @@ -11,9 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Billing and Cost Management User Guide. +// Lists tags for up to 10 health checks or hosted zones. +// +// For information about using tags for cost allocation, see [Using Cost Allocation Tags] in the Billing and +// Cost Management User Guide. +// +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) ListTagsForResources(ctx context.Context, params *ListTagsForResourcesInput, optFns ...func(*Options)) (*ListTagsForResourcesOutput, error) { if params == nil { params = &ListTagsForResourcesInput{} @@ -40,7 +43,9 @@ 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 . // // This member is required. diff --git a/service/route53/api_op_ListTrafficPolicies.go b/service/route53/api_op_ListTrafficPolicies.go index 27e0e299c94..36744453a99 100644 --- a/service/route53/api_op_ListTrafficPolicies.go +++ b/service/route53/api_op_ListTrafficPolicies.go @@ -13,10 +13,12 @@ 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) -// . +// the order that they were created in. +// +// For information about how of deleting a traffic policy affects the response +// from ListTrafficPolicies , see [DeleteTrafficPolicy]. +// +// [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{} @@ -45,11 +47,13 @@ type ListTrafficPoliciesInput struct { MaxItems *int32 // (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 - // policies. To get the next group of policies, submit another request to - // ListTrafficPolicies . For the value of TrafficPolicyIdMarker , specify the value - // of TrafficPolicyIdMarker that was returned in the previous response. + // TrafficPolicyIdMarker parameter. + // + // If you have more traffic policies than the 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 of TrafficPolicyIdMarker + // that was returned in the previous response. TrafficPolicyIdMarker *string noSmithyDocumentSerde diff --git a/service/route53/api_op_ListTrafficPolicyInstances.go b/service/route53/api_op_ListTrafficPolicyInstances.go index b8f2db54aa2..a946eceb65e 100644 --- a/service/route53/api_op_ListTrafficPolicyInstances.go +++ b/service/route53/api_op_ListTrafficPolicyInstances.go @@ -12,13 +12,15 @@ import ( ) // Gets information about the traffic policy instances that you created by using -// the current Amazon Web Services account. After you submit 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. Route 53 -// returns a maximum of 100 items in each response. If you have a lot of traffic -// policy instances, you can use the MaxItems parameter to list them in groups of -// up to 100. +// the current Amazon Web Services account. +// +// After you submit 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. +// +// Route 53 returns a maximum of 100 items in each response. If you have a lot of +// traffic policy instances, you can use the MaxItems parameter to list them in +// groups of up to 100. func (c *Client) ListTrafficPolicyInstances(ctx context.Context, params *ListTrafficPolicyInstancesInput, optFns ...func(*Options)) (*ListTrafficPolicyInstancesOutput, error) { if params == nil { params = &ListTrafficPolicyInstancesInput{} @@ -43,8 +45,10 @@ type ListTrafficPolicyInstancesInput struct { // 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. + // 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 @@ -61,8 +65,10 @@ type ListTrafficPolicyInstancesInput struct { // 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. + // 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 @@ -70,8 +76,10 @@ type ListTrafficPolicyInstancesInput struct { // 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. + // 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 diff --git a/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go b/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go index 219b82b2931..d737ddcae2f 100644 --- a/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go +++ b/service/route53/api_op_ListTrafficPolicyInstancesByHostedZone.go @@ -12,13 +12,16 @@ import ( ) // Gets information about the traffic policy instances that you created in a -// specified hosted zone. 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 specified in the traffic policy -// definition. For more information, see the State response element. Route 53 -// returns a maximum of 100 items in each response. If you have a lot of traffic -// policy instances, you can use the MaxItems parameter to list them in groups of -// up to 100. +// specified hosted zone. +// +// 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 specified in the traffic policy definition. For more information, +// see the State response element. +// +// Route 53 returns a maximum of 100 items in each response. If you have a lot of +// traffic policy instances, you can use the MaxItems parameter to list them in +// groups of up to 100. func (c *Client) ListTrafficPolicyInstancesByHostedZone(ctx context.Context, params *ListTrafficPolicyInstancesByHostedZoneInput, optFns ...func(*Options)) (*ListTrafficPolicyInstancesByHostedZoneOutput, error) { if params == nil { params = &ListTrafficPolicyInstancesByHostedZoneInput{} @@ -56,8 +59,10 @@ type ListTrafficPolicyInstancesByHostedZoneInput struct { // 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. + // 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 @@ -65,8 +70,10 @@ type ListTrafficPolicyInstancesByHostedZoneInput struct { // 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. + // 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 diff --git a/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go b/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go index 38cefa34cec..68de69e11ed 100644 --- a/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go +++ b/service/route53/api_op_ListTrafficPolicyInstancesByPolicy.go @@ -12,13 +12,16 @@ import ( ) // Gets information about the traffic policy instances that you created by using a -// specify traffic policy version. 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 specified in the traffic -// policy definition. For more information, see the State response element. Route -// 53 returns a maximum of 100 items in each response. If you have a lot of traffic -// policy instances, you can use the MaxItems parameter to list them in groups of -// up to 100. +// specify traffic policy version. +// +// 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 specified in the traffic policy definition. For more information, +// see the State response element. +// +// Route 53 returns a maximum of 100 items in each response. If you have a lot of +// traffic policy instances, you can use the MaxItems parameter to list them in +// groups of up to 100. func (c *Client) ListTrafficPolicyInstancesByPolicy(ctx context.Context, params *ListTrafficPolicyInstancesByPolicyInput, optFns ...func(*Options)) (*ListTrafficPolicyInstancesByPolicyOutput, error) { if params == nil { params = &ListTrafficPolicyInstancesByPolicyInput{} @@ -53,11 +56,14 @@ type ListTrafficPolicyInstancesByPolicyInput struct { // 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 @@ -70,22 +76,28 @@ type ListTrafficPolicyInstancesByPolicyInput struct { // 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 - // 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 - // traffic policy instances to get. + // ListTrafficPolicyInstancesByPolicy 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 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. TrafficPolicyInstanceNameMarker *string // 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 - // 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 - // traffic policy instances to get. + // ListTrafficPolicyInstancesByPolicy request. + // + // For the value of 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 traffic policy instances to get. TrafficPolicyInstanceTypeMarker types.RRType noSmithyDocumentSerde diff --git a/service/route53/api_op_ListTrafficPolicyVersions.go b/service/route53/api_op_ListTrafficPolicyVersions.go index e7779ed8e48..fd6a6b8db10 100644 --- a/service/route53/api_op_ListTrafficPolicyVersions.go +++ b/service/route53/api_op_ListTrafficPolicyVersions.go @@ -12,6 +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 . func (c *Client) ListTrafficPolicyVersions(ctx context.Context, params *ListTrafficPolicyVersionsInput, optFns ...func(*Options)) (*ListTrafficPolicyVersionsOutput, error) { if params == nil { @@ -46,11 +47,13 @@ type ListTrafficPolicyVersionsInput struct { MaxItems *int32 // 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 - // group of MaxItems versions. To get more traffic policy versions, submit another - // ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker , - // specify the value of TrafficPolicyVersionMarker in the previous response. + // TrafficPolicyVersionMarker parameter. + // + // If you have more traffic policy versions 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 , specify the value of + // TrafficPolicyVersionMarker in the previous response. TrafficPolicyVersionMarker *string noSmithyDocumentSerde @@ -83,6 +86,7 @@ type ListTrafficPolicyVersionsOutput struct { // 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 member is required. diff --git a/service/route53/api_op_ListVPCAssociationAuthorizations.go b/service/route53/api_op_ListVPCAssociationAuthorizations.go index 738ec82ff67..32030fc4a09 100644 --- a/service/route53/api_op_ListVPCAssociationAuthorizations.go +++ b/service/route53/api_op_ListVPCAssociationAuthorizations.go @@ -13,9 +13,10 @@ 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{} @@ -41,12 +42,12 @@ type ListVPCAssociationAuthorizationsInput struct { // This member is required. HostedZoneId *string - // Optional: An integer that specifies the maximum number of VPCs that you want + // 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. MaxResults *int32 - // Optional: If a response includes a NextToken element, there are more VPCs that + // Optional: If a response includes a NextToken element, there are more VPCs that // can be associated with the specified hosted zone. To get the next page of // results, submit another request, and include the value of NextToken from the // response in the nexttoken parameter in another ListVPCAssociationAuthorizations diff --git a/service/route53/api_op_TestDNSAnswer.go b/service/route53/api_op_TestDNSAnswer.go index 92e58f35aeb..4e7892b0700 100644 --- a/service/route53/api_op_TestDNSAnswer.go +++ b/service/route53/api_op_TestDNSAnswer.go @@ -13,11 +13,14 @@ import ( // Gets the value that Amazon Route 53 returns in response to a DNS request for a // specified record name and type. You can optionally specify the IP address of a -// DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. This call -// only supports querying public hosted zones. The TestDnsAnswer returns -// information similar to what you would expect from the answer section of the dig -// command. Therefore, if you query for the name servers of a subdomain that point -// to the parent name servers, those will not be returned. +// DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. +// +// This call only supports querying public hosted zones. +// +// The TestDnsAnswer returns information similar to what you would expect from +// the answer section of the dig command. Therefore, if you query for the name +// servers of a subdomain that point to the parent name servers, those will not be +// returned. func (c *Client) TestDNSAnswer(ctx context.Context, params *TestDNSAnswerInput, optFns ...func(*Options)) (*TestDNSAnswerOutput, error) { if params == nil { params = &TestDNSAnswerInput{} @@ -64,9 +67,13 @@ type TestDNSAnswerInput struct { // 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: + // 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 @@ -112,8 +119,9 @@ type TestDNSAnswerOutput struct { // 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 // 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) - // on the IANA website. + // a list of possible response codes, see [DNS RCODES]on the IANA website. + // + // [DNS RCODES]: http://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-6 // // This member is required. ResponseCode *string diff --git a/service/route53/api_op_UpdateHealthCheck.go b/service/route53/api_op_UpdateHealthCheck.go index 898a221a5c1..2bf97d43f04 100644 --- a/service/route53/api_op_UpdateHealthCheck.go +++ b/service/route53/api_op_UpdateHealthCheck.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Route 53 Developer Guide. +// 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] in the Amazon Route 53 +// Developer Guide. +// +// [Creating, Updating, and Deleting Health Checks]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-deleting.html func (c *Client) UpdateHealthCheck(ctx context.Context, params *UpdateHealthCheckInput, optFns ...func(*Options)) (*UpdateHealthCheckOutput, error) { if params == nil { params = &UpdateHealthCheckInput{} @@ -52,103 +54,139 @@ 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/) - // . + // traffic to a resource, change the value of [Inverted]. + // + // Charges for a health check still apply when the health check is disabled. For + // more information, see [Amazon Route 53 Pricing]. + // + // [Inverted]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted + // [Amazon Route 53 Pricing]: http://aws.amazon.com/route53/pricing/ Disabled *bool // Specify whether you want Amazon Route 53 to send the value of // FullyQualifiedDomainName to the endpoint in the client_hello message during TLS // 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 - // 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. + // 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 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. 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) - // in the Amazon Route 53 Developer Guide. If you don't specify a value for - // FailureThreshold , the default value is three health checks. + // healthy or vice versa. For more information, see [How Amazon Route 53 Determines Whether an Endpoint Is Healthy]in the Amazon Route 53 + // Developer Guide. + // + // If you don't specify a value for FailureThreshold , the default value is three + // health checks. + // + // [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 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. // 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 - // 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: + // 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 , you can’t update the - // health check to remove the FullyQualifiedDomainName ; if you don’t specify a - // value for IPAddress on creation, a FullyQualifiedDomainName is required. 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 + // 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 , you can’t update the health check + // to remove the FullyQualifiedDomainName ; if you don’t specify a value for + // IPAddress on creation, a FullyQualifiedDomainName is required. + // + // 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. + // (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. FullyQualifiedDomainName *string // A sequential counter that Amazon Route 53 sets to 1 when you create a health - // check and increments by 1 each time you update settings for the health check. We - // recommend that you use GetHealthCheck or ListHealthChecks to get the current + // check and increments by 1 each time you update settings for the health check. + // + // We recommend that you use GetHealthCheck or ListHealthChecks to get the current // 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. @@ -158,11 +196,14 @@ type UpdateHealthCheckInput struct { // 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: + // 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 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 @@ -170,37 +211,58 @@ type UpdateHealthCheckInput struct { // sends a DNS request to resolve the domain name that you specify in // 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 : + // 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 + // + // - Linux: [Elastic IP Addresses (EIP)]in the Amazon EC2 User Guide for Linux Instances + // + // - Windows: [Elastic IP Addresses (EIP)]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 + // IPAddress . + // + // For more information, see [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] + // + // [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space] + // + // [RFC 5156, Special-Use IPv6 Addresses] + // + // [RFC 5735, Special Use IPv4 Addresses]: https://tools.ietf.org/html/rfc5735 + // [FullyQualifiedDomainName]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName + // [Elastic IP Addresses (EIP)]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-ip-addresses-eip.html + // [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 @@ -213,7 +275,9 @@ type UpdateHealthCheckInput struct { 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 + // on. + // + // Don't specify a value for Port when you specify a value for Type of // CLOUDWATCH_METRIC or CALCULATED . Port *int32 @@ -224,22 +288,28 @@ 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]to null. + // + // - FullyQualifiedDomainName : Route 53 resets [FullyQualifiedDomainName]. to null. + // + // - Regions : Route 53 resets the [Regions]list to the default set of regions. + // + // - ResourcePath : Route 53 resets [ResourcePath]to null. + // + // [ResourcePath]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ResourcePath + // [ChildHealthChecks]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-ChildHealthChecks + // [FullyQualifiedDomainName]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName + // [Regions]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions 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 // /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 - // want to change it. + // 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 diff --git a/service/route53/api_op_UpdateTrafficPolicyInstance.go b/service/route53/api_op_UpdateTrafficPolicyInstance.go index 76364536c51..98e5b19c39f 100644 --- a/service/route53/api_op_UpdateTrafficPolicyInstance.go +++ b/service/route53/api_op_UpdateTrafficPolicyInstance.go @@ -16,18 +16,23 @@ import ( // traffic policy definition. Use GetTrafficPolicyInstance with the id of updated // traffic policy instance confirm that the UpdateTrafficPolicyInstance request // completed successfully. For more information, see the State response element. +// // Updates the resource record sets in a specified hosted zone that were created -// based on the settings in a specified traffic policy version. When you update a -// traffic policy instance, Amazon Route 53 continues to respond to DNS queries for -// 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: +// based on the settings in a specified traffic policy version. +// +// When you update a traffic policy instance, Amazon Route 53 continues to respond +// to DNS queries for 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. func (c *Client) UpdateTrafficPolicyInstance(ctx context.Context, params *UpdateTrafficPolicyInstanceInput, optFns ...func(*Options)) (*UpdateTrafficPolicyInstanceOutput, error) { diff --git a/service/route53/doc.go b/service/route53/doc.go index d36233e4535..1cdd613a4aa 100644 --- a/service/route53/doc.go +++ b/service/route53/doc.go @@ -4,15 +4,23 @@ // Amazon Route 53. // // 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) -// . +// service. +// +// You can use Route 53 to: +// +// - Register domain names. +// +// For more information, see [How domain registration works]. +// +// - Route internet traffic to the resources for your domain +// +// For more information, see [How internet traffic is routed to your website or web application]. +// +// - Check the health of your resources. +// +// For more information, see [How Route 53 checks the health of your resources]. +// +// [How domain registration works]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html +// [How Route 53 checks the health of your resources]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html +// [How internet traffic is routed to your website or web application]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html package route53 diff --git a/service/route53/options.go b/service/route53/options.go index 98b428f625c..23abeee1395 100644 --- a/service/route53/options.go +++ b/service/route53/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53/types/enums.go b/service/route53/types/enums.go index 80f7a16877c..f9cfdebbc41 100644 --- a/service/route53/types/enums.go +++ b/service/route53/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AccountLimitType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountLimitType) Values() []AccountLimitType { return []AccountLimitType{ "MAX_HEALTH_CHECKS_BY_OWNER", @@ -36,8 +37,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -55,8 +57,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -74,6 +77,7 @@ const ( // Values returns all known values for CidrCollectionChangeAction. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CidrCollectionChangeAction) Values() []CidrCollectionChangeAction { return []CidrCollectionChangeAction{ @@ -125,8 +129,9 @@ const ( ) // Values returns all known values for CloudWatchRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloudWatchRegion) Values() []CloudWatchRegion { return []CloudWatchRegion{ "us-east-1", @@ -179,8 +184,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "GreaterThanOrEqualToThreshold", @@ -205,8 +211,9 @@ const ( ) // Values returns all known values for HealthCheckRegion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthCheckRegion) Values() []HealthCheckRegion { return []HealthCheckRegion{ "us-east-1", @@ -235,8 +242,9 @@ const ( ) // Values returns all known values for HealthCheckType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthCheckType) Values() []HealthCheckType { return []HealthCheckType{ "HTTP", @@ -259,8 +267,9 @@ const ( ) // Values returns all known values for HostedZoneLimitType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HostedZoneLimitType) Values() []HostedZoneLimitType { return []HostedZoneLimitType{ "MAX_RRSETS_BY_ZONE", @@ -276,8 +285,9 @@ const ( ) // Values returns all known values for HostedZoneType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HostedZoneType) Values() []HostedZoneType { return []HostedZoneType{ "PrivateHostedZone", @@ -295,8 +305,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsufficientDataHealthStatus) Values() []InsufficientDataHealthStatus { return []InsufficientDataHealthStatus{ "Healthy", @@ -316,8 +327,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "FullyQualifiedDomainName", @@ -337,6 +349,7 @@ const ( // Values returns all known values for ResourceRecordSetFailover. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResourceRecordSetFailover) Values() []ResourceRecordSetFailover { return []ResourceRecordSetFailover{ @@ -383,8 +396,9 @@ const ( ) // Values returns all known values for ResourceRecordSetRegion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceRecordSetRegion) Values() []ResourceRecordSetRegion { return []ResourceRecordSetRegion{ "us-east-1", @@ -430,8 +444,9 @@ const ( // Values returns all known values for ReusableDelegationSetLimitType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReusableDelegationSetLimitType) Values() []ReusableDelegationSetLimitType { return []ReusableDelegationSetLimitType{ "MAX_ZONES_BY_REUSABLE_DELEGATION_SET", @@ -458,8 +473,9 @@ const ( ) // Values returns all known values for RRType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RRType) Values() []RRType { return []RRType{ "SOA", @@ -490,8 +506,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -511,8 +528,9 @@ const ( ) // Values returns all known values for TagResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TagResourceType) Values() []TagResourceType { return []TagResourceType{ "healthcheck", @@ -562,8 +580,9 @@ const ( ) // 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. +// in the future, and so 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 1bb6aa02748..05f57a42772 100644 --- a/service/route53/types/errors.go +++ b/service/route53/types/errors.go @@ -145,18 +145,21 @@ 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) -// . +// name servers with the existing hosted zone. For more information, see [CreateReusableDelegationSet]. +// // - 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. +// +// [CreateReusableDelegationSet]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html type ConflictingDomainExists struct { Message *string @@ -373,11 +376,14 @@ func (e *DNSSECNotFound) ErrorCode() string { } func (e *DNSSECNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The health check you're attempting to create already exists. Amazon Route 53 +// 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. type HealthCheckAlreadyExists struct { @@ -620,14 +626,19 @@ 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. @@ -1091,9 +1102,10 @@ func (e *LastVPCAssociation) ErrorCode() string { func (e *LastVPCAssociation) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // This operation can't be completed because the current account has reached the -// limit on the resource you are trying to create. To request a higher limit, -// create a case (http://aws.amazon.com/route53-request) with the Amazon Web -// Services Support Center. +// limit on the resource you are trying to create. To request a higher limit, [create a case]with +// the Amazon Web Services Support Center. +// +// [create a case]: http://aws.amazon.com/route53-request type LimitsExceeded struct { Message *string @@ -1250,8 +1262,9 @@ 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) -// data type. +// of supported geolocation codes, see the [GeoLocation]data type. +// +// [GeoLocation]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GeoLocation.html type NoSuchGeoLocation struct { Message *string @@ -1571,15 +1584,21 @@ func (e *ThrottlingException) ErrorCode() string { func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// 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) -// 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 on the number of active health checks. +// +// For information about default limits, see [Limits] in the Amazon Route 53 Developer +// Guide. +// +// For information about how to get the current limit for an account, see [GetAccountLimit]. To +// request a higher limit, [create a case]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]with the Amazon Web Services +// Support Center. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [GetAccountLimit]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html +// [create a case]: http://aws.amazon.com/route53-request type TooManyHealthChecks struct { Message *string @@ -1608,13 +1627,23 @@ func (e *TooManyHealthChecks) ErrorFault() smithy.ErrorFault { return smithy.Fau // 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) -// with the Amazon Web Services Support Center. +// delegation set. +// +// For information about default limits, see [Limits] in the Amazon Route 53 Developer +// Guide. +// +// To get the current limit on hosted zones that can be created by an account, see [GetAccountLimit] +// . +// +// To get the current limit on hosted zones that can be associated with a reusable +// delegation set, see [GetReusableDelegationSetLimit]. +// +// To request a higher limit, [create a case] with the Amazon Web Services Support Center. +// +// [GetReusableDelegationSetLimit]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetReusableDelegationSetLimit.html +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [GetAccountLimit]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html +// [create a case]: http://aws.amazon.com/route53-request type TooManyHostedZones struct { Message *string @@ -1668,12 +1697,18 @@ 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) -// 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) -// with the Amazon Web Services Support Center. +// the limit on the number of traffic policies. +// +// For information about default limits, see [Limits] in the Amazon Route 53 Developer +// Guide. +// +// To get the current limit for an account, see [GetAccountLimit]. +// +// To request a higher limit, [create a case] with the Amazon Web Services Support Center. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [GetAccountLimit]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html +// [create a case]: http://aws.amazon.com/route53-request type TooManyTrafficPolicies struct { Message *string @@ -1700,12 +1735,18 @@ func (e *TooManyTrafficPolicies) ErrorCode() string { func (e *TooManyTrafficPolicies) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// 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) -// with the Amazon Web Services Support Center. +// reached the limit on the number of traffic policy instances. +// +// For information about default limits, see [Limits] in the Amazon Route 53 Developer +// Guide. +// +// For information about how to get the current limit for an account, see [GetAccountLimit]. +// +// To request a higher limit, [create a case] with the Amazon Web Services Support Center. +// +// [Limits]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html +// [GetAccountLimit]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetAccountLimit.html +// [create a case]: http://aws.amazon.com/route53-request type TooManyTrafficPolicyInstances struct { Message *string @@ -1733,10 +1774,14 @@ func (e *TooManyTrafficPolicyInstances) ErrorFault() smithy.ErrorFault { return // 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) -// to create a new traffic policy using the traffic policy document. +// policy. +// +// To create more traffic policy versions, you can use [GetTrafficPolicy] to get the traffic policy +// document for a specified traffic policy version, and then use [CreateTrafficPolicy]to create a new +// traffic policy using the traffic policy document. +// +// [CreateTrafficPolicy]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateTrafficPolicy.html +// [GetTrafficPolicy]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetTrafficPolicy.html type TooManyTrafficPolicyVersionsForCurrentPolicy struct { Message *string diff --git a/service/route53/types/types.go b/service/route53/types/types.go index bb5c97e00f4..3ffd60e21f5 100644 --- a/service/route53/types/types.go +++ b/service/route53/types/types.go @@ -12,14 +12,19 @@ import ( 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 @@ -28,8 +33,9 @@ type AccountLimit struct { // 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]. + // + // [Type]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AccountLimit.html#Route53-Type-AccountLimit-Type // // This member is required. Value *int64 @@ -43,22 +49,29 @@ type AccountLimit struct { 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: + // 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. + // more information, see [High-Resolution Metrics]in the Amazon CloudWatch User Guide. + // // - Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended // statistics aren't supported. // + // [High-Resolution Metrics]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics + // // This member is required. Name *string // 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. + // created in. + // + // For the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and quotas] in the Amazon Web Services + // General Reference. + // + // [Amazon CloudWatch endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/cw_region.html // // This member is required. Region CloudWatchRegion @@ -66,202 +79,289 @@ type AlarmIdentifier struct { noSmithyDocumentSerde } -// Alias resource record sets only: Information about the Amazon Web Services +// Alias resource record sets only: Information about the Amazon Web Services +// // 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: +// 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) -// . +// hosted zone, see [Configuring Failover in a Private Hosted Zone]. +// +// [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 - // 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) - // : + // 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]: + // // - 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 + // 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 - // 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) - // 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 - // primary and secondary records. A distribution must include an alternate domain - // name that matches the name of the record. However, the primary and secondary - // records have the same name, and you can't include the same alternate domain name - // in more than one distribution. Elastic Beanstalk environment If the domain name - // for your Elastic Beanstalk environment includes the region that you deployed the - // environment in, you can create an alias record that routes traffic to the - // environment. For example, the domain name - // my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name. For - // environments that were created before early 2016, the domain name doesn't + // CloudFront distribution. You can get the value of DnsName using the CLI command [describe-vpc-endpoints] + // . + // + // 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)]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 primary and secondary records. A distribution must include an alternate + // domain name that matches the name of the record. However, the primary and + // secondary records have the same name, and you can't include the same alternate + // domain name in more than one distribution. + // + // Elastic Beanstalk environment If the domain name for your Elastic Beanstalk + // environment includes the region that you deployed the environment in, you can + // create an alias record that routes traffic to the environment. For example, the + // domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized + // domain name. + // + // For environments that were created before early 2016, the domain name doesn't // include the region. To route traffic to these environments, you must create a // CNAME record instead of an alias record. Note that you can't create a CNAME // record for the root domain name. For example, if your domain name is // example.com, you can create a record that routes traffic for acme.example.com to // your Elastic Beanstalk environment, but you can't create a record that routes - // traffic for example.com to your Elastic Beanstalk environment. For Elastic - // 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: + // traffic for example.com to your Elastic Beanstalk environment. + // + // For Elastic 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. + // the value by using the console, see [Using Custom Domains with Elastic Beanstalk]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. + // of the CNAME attribute. For more information, see [DescribeEnvironments]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. + // attribute. For more information, see [describe-environments]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. + // 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) + // + // - Classic Load Balancers: [DescribeLoadBalancers] + // + // - Application and Network Load Balancers: [DescribeLoadBalancers] + // // - 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) + // + // - Classic Load Balancers: [describe-load-balancers] + // + // - Application and Network Load Balancers: [describe-load-balancers] + // // 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) - // . + // + // - Global Accelerator API: To get the DNS name, use [DescribeAccelerator]. + // + // - CLI: To get the DNS name, use [describe-accelerator]. + // // 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) - // 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 - // 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. + // see the table [Amazon S3 Website Endpoints]in the Amazon Web Services General Reference. For more + // information about using S3 buckets for websites, see [Getting Started with Amazon Route 53]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 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. + // + // [DescribeEnvironments]: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html + // [describe-environments]: https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html + // [Getting Started with Amazon Route 53]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html + // [describe-accelerator]: https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html + // [Amazon S3 Website Endpoints]: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints + // [DescribeAccelerator]: https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html + // [Using Custom Domains with Elastic Beanstalk]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html + // [describe-load-balancers]: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html + // [get-domain-names]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html + // [Using Alternate Domain Names (CNAMEs)]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html + // [describe-vpc-endpoints]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html // // This member is required. DNSName *string - // Applies only to alias, failover alias, geolocation alias, latency alias, and + // 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 - // 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: + // 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) - // 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. + // 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?]in the Amazon Route 53 Developer Guide. + // + // For more information and examples, see [Amazon Route 53 Health Checks and DNS Failover] 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 + // [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 // // This member is required. EvaluateTargetHealth bool - // 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) - // : + // 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]: + // // - 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 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 + // CLI command [describe-vpc-endpoints]. + // + // 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]in + // 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] + // - 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 . + // + // - Classic Load Balancers: Use [DescribeLoadBalancers]to get the value of CanonicalHostedZoneNameId . + // + // - Application and Network Load Balancers: Use [DescribeLoadBalancers]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 - // hosted zone.) + // + // - Classic Load Balancers: Use [describe-load-balancers]to get the value of CanonicalHostedZoneNameId . + // + // - Application and Network Load Balancers: Use [describe-load-balancers]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]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 hosted zone.) + // + // [Amazon S3 Website Endpoints]: https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints + // [describe-load-balancers]: http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html + // [DescribeLoadBalancers]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html + // [Elastic Beanstalk endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html + // [get-domain-names]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html + // [describe-vpc-endpoints]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html + // [Elastic Load Balancing endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/elb.html // // This member is required. HostedZoneId *string @@ -273,18 +373,24 @@ 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. + // + // - DELETE : Deletes a existing resource record set. + // + // To delete the resource record set that is associated with a traffic policy + // instance, use [DeleteTrafficPolicyInstance]. 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. // + // [DeleteTrafficPolicyInstance]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeleteTrafficPolicyInstance.html + // // This member is required. Action ChangeAction @@ -304,7 +410,7 @@ type ChangeBatch struct { // This member is required. Changes []Change - // Optional: Any comments you want to include about a change batch request. + // Optional: Any comments you want to include about a change batch request. Comment *string noSmithyDocumentSerde @@ -314,8 +420,10 @@ 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) - // action to get detailed information about the change. + // This element contains an ID that you use when performing a [GetChange] action to get + // detailed information about the change. + // + // [GetChange]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html // // This member is required. Id *string @@ -326,9 +434,11 @@ 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] 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. + // + // [ISO 8601 format]: https://en.wikipedia.org/wiki/ISO_8601 // // This member is required. SubmittedAt *time.Time @@ -393,9 +503,10 @@ type CidrCollectionChange struct { } // The object that is specified in resource record set object when you are linking -// a resource record set to a CIDR location. A LocationName with an asterisk “*” -// can be used to create a default CIDR record. CollectionId is still required for -// default record. +// a resource record set to a CIDR location. +// +// A LocationName with an asterisk “*” can be used to create a default CIDR +// record. CollectionId is still required for default record. type CidrRoutingConfig struct { // The CIDR collection ID. @@ -433,8 +544,9 @@ 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) - // in the Amazon CloudWatch User Guide. + // information, see [Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference]in the Amazon CloudWatch User Guide. + // + // [Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html // // This member is required. Namespace *string @@ -459,15 +571,17 @@ type CloudWatchAlarmConfiguration struct { // 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. + // see [Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference]in the Amazon CloudWatch User Guide. + // + // [Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html Dimensions []Dimension noSmithyDocumentSerde } -// A complex type that is an entry in an CidrCollection (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CidrCollection.html) -// array. +// A complex type that is an entry in an [CidrCollection] array. +// +// [CidrCollection]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CidrCollection.html type CollectionSummary struct { // The ARN of the collection summary. Can be used to reference the collection in @@ -490,13 +604,13 @@ type CollectionSummary struct { // A complex type that lists the coordinates for a geoproximity resource record. type Coordinates struct { - // Specifies a coordinate of the north–south position of a geographic point on the - // surface of the Earth (-90 - 90). + // Specifies a coordinate of the north–south position of a geographic point on + // the surface of the Earth (-90 - 90). // // This member is required. Latitude *string - // Specifies a coordinate of the east–west position of a geographic point on the + // Specifies a coordinate of the east–west position of a geographic point on the // surface of the Earth (-180 - 180). // // This member is required. @@ -547,17 +661,24 @@ type Dimension struct { // A string representing 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. + // 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 - // changed. INTERNAL_FAILURE There was an error during a request. Before you can - // continue to work with DNSSEC signing, including with key-signing keys (KSKs), - // you must correct the problem by enabling or disabling DNSSEC signing for the - // hosted zone. + // changed. + // + // INTERNAL_FAILURE There was an error during a request. Before you can continue + // to work with DNSSEC signing, including with key-signing keys (KSKs), you must + // correct the problem by enabling or disabling DNSSEC signing for the hosted zone. ServeSignature *string // The status message provided for the following DNSSEC signing status: @@ -571,31 +692,45 @@ type DNSSECStatus struct { // A complex type that contains information about a geographic location. type GeoLocation struct { - // The two-letter code for the continent. Amazon Route 53 supports the following - // continent codes: + // 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. 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) . Route 53 - // also supports the country code UA for Ukraine. + // 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]. + // + // Route 53 also supports the country code UA for Ukraine. + // + // [ISO standard 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 . - // 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 . + // For a list of state abbreviations, see [Appendix B: Two–Letter State and Possession Abbreviations]on the United States Postal Service + // website. + // + // If you specify subdivisioncode , you must also specify US for CountryCode . + // + // [Appendix B: Two–Letter State and Possession Abbreviations]: https://pe.usps.com/text/pub28/28apb.htm SubdivisionCode *string noSmithyDocumentSerde @@ -618,11 +753,11 @@ type GeoLocationDetails struct { CountryName *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) - // API. + // States. For a list of US state abbreviations, see [Appendix B: Two–Letter State and Possession Abbreviations]on the United States Postal + // Service website. For a list of all supported subdivision codes, use the [ListGeoLocations]API. + // + // [ListGeoLocations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListGeoLocations.html + // [Appendix B: Two–Letter State and Possession Abbreviations]: https://pe.usps.com/text/pub28/28apb.htm SubdivisionCode *string // The full name of the subdivision. Route 53 currently supports only states in @@ -632,39 +767,52 @@ type GeoLocationDetails struct { noSmithyDocumentSerde } -// (Resource record sets only): A complex type that lets you specify where your +// (Resource record sets only): A complex type that lets you specify where your +// // resources are located. Only one of LocalZoneGroup , Coordinates , or Amazon Web -// ServicesRegion is allowed per request at a time. For more information about -// geoproximity routing, see Geoproximity routing (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-geoproximity.html) -// in the Amazon Route 53 Developer Guide. +// ServicesRegion is allowed per request at a time. +// +// For more information about geoproximity routing, see [Geoproximity routing] in the Amazon Route 53 +// Developer Guide. +// +// [Geoproximity routing]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-geoproximity.html type GeoProximityLocation struct { - // The Amazon Web Services Region the resource you are directing DNS traffic to, + // The Amazon Web Services Region the resource you are directing DNS traffic to, // is in. AWSRegion *string - // The bias increases or decreases the size of the geographic region from which - // Route 53 routes traffic to a resource. To use Bias to change the size of the - // geographic region, specify the applicable value for the bias: + // The bias increases or decreases the size of the geographic region from which + // Route 53 routes traffic to a resource. + // + // To use Bias to change the size of the geographic region, specify the applicable + // value for the bias: + // // - To expand the size of the geographic region from which Route 53 routes // traffic to a resource, specify a positive integer from 1 to 99 for the bias. // Route 53 shrinks the size of adjacent regions. + // // - To shrink the size of the geographic region from which Route 53 routes // traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands // the size of adjacent regions. Bias *int32 - // Contains the longitude and latitude for a geographic region. + // Contains the longitude and latitude for a geographic region. Coordinates *Coordinates - // Specifies an Amazon Web Services Local Zone Group. A local Zone Group is - // usually the Local Zone code without the ending character. For example, if the - // Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1 . You can - // identify the Local Zones Group for a specific Local Zone by using the - // describe-availability-zones (https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html) - // CLI command: This command returns: "GroupName": "us-west-2-den-1" , specifying - // that the Local Zone us-west-2-den-1a belongs to the Local Zone Group - // us-west-2-den-1 . + // Specifies an Amazon Web Services Local Zone Group. + // + // A local Zone Group is usually the Local Zone code without the ending character. + // For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is + // us-east-1-bue-1 . + // + // You can identify the Local Zones Group for a specific Local Zone by using the [describe-availability-zones] + // CLI command: + // + // This command returns: "GroupName": "us-west-2-den-1" , specifying that the Local + // Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1 . + // + // [describe-availability-zones]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html LocalZoneGroup *string noSmithyDocumentSerde @@ -713,39 +861,53 @@ type HealthCheck struct { type HealthCheckConfig struct { // The type of health check that you want to create, which indicates how Amazon - // 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: + // 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. + // 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 associated 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. + // + // For more information, see [How Route 53 Determines Whether an Endpoint Is Healthy] in the Amazon Route 53 Developer Guide. + // + // [How Route 53 Determines Whether an Endpoint Is Healthy]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html // // This member is required. Type HealthCheckType @@ -762,98 +924,135 @@ 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/) - // . + // traffic to a resource, change the value of [Inverted]. + // + // Charges for a health check still apply when the health check is disabled. For + // more information, see [Amazon Route 53 Pricing]. + // + // [Inverted]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted + // [Amazon Route 53 Pricing]: http://aws.amazon.com/route53/pricing/ Disabled *bool // Specify whether you want Amazon Route 53 to send the value of // FullyQualifiedDomainName to the endpoint in the client_hello message during TLS // 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 - // 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. + // 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 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. 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) - // in the Amazon Route 53 Developer Guide. If you don't specify a value for - // FailureThreshold , the default value is three health checks. + // healthy or vice versa. For more information, see [How Amazon Route 53 Determines Whether an Endpoint Is Healthy]in the Amazon Route 53 + // Developer Guide. + // + // If you don't specify a value for FailureThreshold , the default value is three + // health checks. + // + // [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 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 - // 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 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 + // 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. + // (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. 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) - // element. Note the following: + // to associate with a CALCULATED health check, use the [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 0 , Route 53 always considers this health check to be healthy. + // + // [ChildHealthChecks]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks HealthThreshold *int32 // The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to @@ -861,31 +1060,51 @@ type HealthCheckConfig struct { // sends a DNS request to resolve the domain name that you specify in // 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 : + // 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 + // change. + // + // For more information, see [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] + // + // [RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space] + // + // [RFC 5156, Special-Use IPv6 Addresses] + // // When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress . + // + // [RFC 5735, Special Use IPv4 Addresses]: https://tools.ietf.org/html/rfc5735 + // [FullyQualifiedDomainName]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName + // [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 : 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 @@ -900,30 +1119,38 @@ type HealthCheckConfig struct { // Specify whether you want Amazon Route 53 to measure the latency between health // checkers in multiple Amazon Web Services regions and your endpoint, and to // display CloudWatch latency graphs on the Health Checks page in the Route 53 - // console. You can't change the value of MeasureLatency after you create a health - // check. + // console. + // + // You can't change the value of MeasureLatency after you create a health check. MeasureLatency *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 + // on. + // + // Don't specify a value for Port when you specify a value for Type of // CLOUDWATCH_METRIC or CALCULATED . Port *int32 // A complex type that contains one Region element for each region from which you - // want Amazon Route 53 health checkers to check the specified endpoint. If you - // don't specify any regions, Route 53 health checkers automatically performs - // checks from all of the regions that are listed under Valid Values. If you update - // a health check to remove a region that has been performing health checks, Route - // 53 will briefly continue to perform checks from that region to ensure that some - // health checkers are always checking the endpoint (for example, if you replace - // three regions with four different regions). + // want Amazon Route 53 health checkers to check the specified endpoint. + // + // If you don't specify any regions, Route 53 health checkers automatically + // performs checks from all of the regions that are listed under Valid Values. + // + // If you update a health check to remove a region that has been performing health + // checks, Route 53 will briefly continue to perform checks from that region to + // ensure that some health checkers are always checking the endpoint (for example, + // if you replace 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. + // 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 @@ -934,16 +1161,19 @@ type HealthCheckConfig struct { 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) - // . + // routing control. + // + // For more information about Route 53 Application Recovery Controller, see [Route 53 Application Recovery Controller Developer Guide.]. + // + // [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 // 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 @@ -983,10 +1213,12 @@ type HostedZone struct { Id *string // 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) - // . + // 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]. + // + // [CreateHostedZone]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html // // This member is required. Name *string @@ -1026,8 +1258,10 @@ type HostedZoneConfig struct { 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. // @@ -1109,13 +1343,15 @@ 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]. + // + // [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]. + // + // [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 @@ -1129,24 +1365,39 @@ 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]. + // + // [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 // Management Service (KMS). The KmsArn must be unique for each key-signing key - // (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: + // (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) - // . + // + // For more information about working with the customer managed key in KMS, see [Key Management Service concepts]. + // + // [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. @@ -1157,30 +1408,41 @@ type KeySigningKey struct { // the same hosted zone. Name *string - // The public key, represented as a Base64 encoding, as required by RFC-4034 Page - // 5 (https://tools.ietf.org/rfc/rfc4034.txt) . + // The public key, represented as a Base64 encoding, as required by [RFC-4034 Page 5]. + // + // [RFC-4034 Page 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]. + // + // [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]. + // + // [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 - // have one of the following values: ACTIVE The KSK is being used for signing. - // INACTIVE The KSK is not being used for signing. DELETING The KSK is in the - // process of being deleted. ACTION_NEEDED There is a problem with the KSK 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 changed. INTERNAL_FAILURE There was an error during a request. Before - // you can continue to work with DNSSEC signing, including actions that involve - // this KSK, you must correct the problem. For example, you may need to activate or - // deactivate the KSK. + // A string that represents the current key-signing key (KSK) status. + // + // Status can have one of the following values: + // + // ACTIVE The KSK is being used for signing. + // + // INACTIVE The KSK is not being used for signing. + // + // DELETING The KSK is in the process of being deleted. + // + // ACTION_NEEDED There is a problem with the KSK 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 changed. + // + // INTERNAL_FAILURE There was an error during a request. Before you can continue + // to work with DNSSEC signing, including actions that involve this KSK, you must + // correct the problem. For example, you may need to activate or deactivate the + // KSK. Status *string // The status message provided for the following key-signing key (KSK) statuses: @@ -1243,17 +1505,21 @@ type QueryLoggingConfig struct { noSmithyDocumentSerde } -// Information specific to the resource record. If you're creating an alias -// resource record set, omit ResourceRecord . +// Information specific to the resource record. +// +// If you're creating an alias 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) - // 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 . + // record types, see [Supported DNS Resource Record Types]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 . + // + // [Supported DNS Resource Record Types]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html // // This member is required. Value *string @@ -1266,127 +1532,183 @@ 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 - // 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) - // 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 - // the following: + // record in the specified hosted zone. + // + // ChangeResourceRecordSets Only + // + // Enter a fully 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]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 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. + // 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. + // + // [DNS Domain Name Format]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html // // 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) - // 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. + // is encoded for them, see [Supported DNS Resource Record Types]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: + // | 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]. + // + // 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 . + // + // - 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. + // 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. + // + // [Supported DNS Resource Record Types]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html + // [The SPF DNS Record Type]: http://tools.ietf.org/html/rfc7208#section-14.1 // // This member is required. Type RRType - // Alias resource record sets only: Information about the Amazon Web Services + // Alias resource record sets only: Information about the Amazon Web Services // 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: + // 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. + // hosted zone, see [Configuring Failover in a Private Hosted Zone]in the Amazon Route 53 Developer Guide. + // + // [Configuring Failover in a Private Hosted Zone]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html AliasTarget *AliasTarget // The object that is specified in resource record set object when you are linking - // a resource record set to a CIDR location. A LocationName with an asterisk “*” - // can be used to create a default CIDR record. CollectionId is still required for - // default record. + // a resource record set to a CIDR location. + // + // A LocationName with an asterisk “*” can be used to create a default CIDR + // record. CollectionId is still required for default record. CidrRoutingConfig *CidrRoutingConfig - // Failover resource record sets only: To configure failover, you add the Failover + // 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 // 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: + // 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) + // 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] + // + // [Configuring Failover in a Private Hosted Zone] + // + // [Configuring Failover in a Private Hosted Zone]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + // [Route 53 Health Checks and DNS Failover]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.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 . If you create separate resource record - // sets for overlapping geographic regions (for example, one resource record set - // for a continent and one for a country on the same continent), priority goes to - // the smallest geographic region. This allows you to route most queries for a - // continent to one resource and to route queries for a country on that continent - // to a different resource. 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 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 . + // + // If you create separate resource record sets for overlapping geographic regions + // (for example, one resource record set for a continent and one for a country on + // the same continent), priority goes to the smallest geographic region. This + // allows you to route most queries for a continent to one resource and to route + // queries for a country on that continent to a different resource. + // + // 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 * . @@ -1394,154 +1716,216 @@ type ResourceRecordSet struct { // 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. + // 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 - // GeoproximityLocation resource record sets only: A complex type that lets you + // GeoproximityLocation resource record sets only: A complex type that lets you // control how Route 53 responds to DNS queries based on the geographic origin of // the query and your resources. GeoProximityLocation *GeoProximityLocation // If you want Amazon Route 53 to return this resource record set in response to a // DNS query only when the status of a health check is healthy, include the - // 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: + // 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: + // 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] + // + // [Route 53 Health Checks and DNS Failover] + // + // [Configuring Failover in a Private Hosted Zone] + // + // 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. + // 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 + // + // - 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: + // + // 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 - // following: + // + // 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 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. + // + // [Configuring Failover in a Private Hosted Zone]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html + // [Route 53 Health Checks and DNS Failover]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html + // [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 HealthCheckId *string - // Multivalue answer resource record sets only: To route traffic approximately + // 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 // 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. MultiValueAnswer *bool - // Latency-based resource record sets only: The Amazon EC2 Region where you + // 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: + // 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 . + // Information about the resource records to act upon. + // + // If you're creating an alias resource record set, omit ResourceRecords . ResourceRecords []ResourceRecord - // Resource record sets that have a routing policy other than simple: An + // 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. + // unique for each resource record set. + // + // For information about routing policies, see [Choosing a Routing Policy] in the Amazon Route 53 Developer + // Guide. + // + // [Choosing a Routing Policy]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html 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 @@ -1552,39 +1936,47 @@ type ResourceRecordSet struct { // 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 + // 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 // policy instance, and you'll continue to be charged for it even though it's no // longer in use. TrafficPolicyInstanceId *string - // Weighted resource record sets only: Among resource record sets that have the + // Weighted resource record sets only: Among resource record sets that have the // same combination of DNS name and type, a value that determines the proportion of // DNS queries that Amazon Route 53 responds to using the current resource record // set. Route 53 calculates the sum of the weights for the resource record sets // 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. + // 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]in the Amazon + // Route 53 Developer Guide. + // + // [Options for Configuring Route 53 Active-Active and Active-Passive Failover]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html Weight *int64 noSmithyDocumentSerde @@ -1597,7 +1989,9 @@ 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 . ResourceType TagResourceType @@ -1630,10 +2024,11 @@ 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] 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. + // + // [ISO 8601 format]: https://en.wikipedia.org/wiki/ISO_8601 CheckedTime *time.Time // A description of the status of the health check endpoint as reported by one of @@ -1648,19 +2043,24 @@ 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. + // + // - 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. Value *string @@ -1672,8 +2072,9 @@ 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) - // . + // For more information about the JSON format, see [Traffic Policy Document Format]. + // + // [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 @@ -1732,13 +2133,18 @@ type TrafficPolicyInstance struct { // This member is required. Name *string - // 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 + // 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. + // 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 @@ -1805,9 +2211,12 @@ 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) +// Amazon VPC. +// +// If you associate a private hosted zone with an Amazon VPC when you make a [CreateHostedZone] // request, the following parameters are also required. +// +// [CreateHostedZone]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html type VPC struct { // (Private hosted zones only) The ID of an Amazon VPC. diff --git a/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go b/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go index 01b0a48a258..e54af281348 100644 --- a/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go +++ b/service/route53domains/api_op_AcceptDomainTransferFromAnotherAwsAccount.go @@ -12,15 +12,20 @@ import ( // 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) -// provides additional information, for example, Domain Transfer from Aws Account +// Web Services accounts using [TransferDomainToAnotherAwsAccount]. +// +// If you use the CLI command at [accept-domain-transfer-from-another-aws-account], 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] or [GetOperationDetail] to determine whether the operation succeeded. [GetOperationDetail] provides +// additional information, for example, Domain Transfer from Aws Account // 111122223333 has been cancelled . +// +// [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html +// [accept-domain-transfer-from-another-aws-account]: https://docs.aws.amazon.com/cli/latest/reference/route53domains/accept-domain-transfer-from-another-aws-account.html +// [ListOperations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html +// [GetOperationDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html func (c *Client) AcceptDomainTransferFromAnotherAwsAccount(ctx context.Context, params *AcceptDomainTransferFromAnotherAwsAccountInput, optFns ...func(*Options)) (*AcceptDomainTransferFromAnotherAwsAccountOutput, error) { if params == nil { params = &AcceptDomainTransferFromAnotherAwsAccountInput{} @@ -41,14 +46,16 @@ 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) - // request. + // account submitted a [TransferDomainToAnotherAwsAccount]request. + // + // [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html // // 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) - // request. + // The password that was returned by the [TransferDomainToAnotherAwsAccount] request. + // + // [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html // // This member is required. Password *string @@ -61,8 +68,9 @@ 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]. + // + // [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 6caffd33f03..ff659d973b0 100644 --- a/service/route53domains/api_op_AssociateDelegationSignerToDomain.go +++ b/service/route53domains/api_op_AssociateDelegationSignerToDomain.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a delegation signer (DS) record in the registry zone for this domain -// name. Note that creating DS record at the registry impacts DNSSEC validation of -// 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) -// in the Route 53 developer guide. +// Creates a delegation signer (DS) record in the registry zone for this domain +// +// name. +// +// Note that creating DS record at the registry impacts DNSSEC validation of 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]in the Route 53 developer guide. +// +// [Configuring DNSSEC signing]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec.html func (c *Client) AssociateDelegationSignerToDomain(ctx context.Context, params *AssociateDelegationSignerToDomainInput, optFns ...func(*Options)) (*AssociateDelegationSignerToDomainOutput, error) { if params == nil { params = &AssociateDelegationSignerToDomainInput{} @@ -52,8 +55,9 @@ 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]. + // + // [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 5dde097b4be..1286c2c37ab 100644 --- a/service/route53domains/api_op_CancelDomainTransferToAnotherAwsAccount.go +++ b/service/route53domains/api_op_CancelDomainTransferToAnotherAwsAccount.go @@ -12,14 +12,19 @@ import ( // 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 +// Web Services accounts using [TransferDomainToAnotherAwsAccount]. +// +// You must cancel the transfer before the other Amazon Web Services account +// accepts the transfer using [AcceptDomainTransferFromAnotherAwsAccount]. +// +// Use either [ListOperations] or [GetOperationDetail] to determine whether the operation succeeded. [GetOperationDetail] provides +// additional information, for example, Domain Transfer from Aws Account // 111122223333 has been cancelled . +// +// [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html +// [AcceptDomainTransferFromAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html +// [ListOperations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html +// [GetOperationDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html 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 02644e958fd..99d315e7806 100644 --- a/service/route53domains/api_op_CheckDomainAvailability.go +++ b/service/route53domains/api_op_CheckDomainAvailability.go @@ -34,19 +34,24 @@ 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) - // in the Amazon Route 53 Developer Guide. The domain name can contain only the - // following characters: + // supported TLDs, see [Domains that You Can Register with Amazon Route 53]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 - // . + // + // - 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) - // . + // names, see [Domains that You Can Register with Amazon Route 53]. For more information, see [Formatting Internationalized Domain Names]. + // + // [Formatting Internationalized Domain Names]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns + // [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 @@ -60,21 +65,36 @@ type CheckDomainAvailabilityInput struct { // The CheckDomainAvailability response includes the following elements. 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 - // 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 - // about whether the domain name is available. Route 53 can return this response - // for a variety of reasons, for example, the registry is performing maintenance. - // Try again later. INVALID_NAME_FOR_TLD The TLD isn't valid. For example, it can - // contain characters that aren't allowed. PENDING The TLD registry didn't return a - // response in the expected amount of time. When the response is delayed, it - // usually takes just a few extra seconds. You can resubmit the request - // immediately. RESERVED The domain name has been reserved for another person or - // organization. UNAVAILABLE The domain name is not available. UNAVAILABLE_PREMIUM - // The domain name is not available. UNAVAILABLE_RESTRICTED The domain name is - // forbidden. + // Whether the domain name is available for registering. + // + // You can register only 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 about whether + // the domain name is available. Route 53 can return this response for a variety of + // reasons, for example, the registry is performing maintenance. Try again later. + // + // INVALID_NAME_FOR_TLD The TLD isn't valid. For example, it can contain + // characters that aren't allowed. + // + // PENDING The TLD registry didn't return a response in the expected amount of + // time. When the response is delayed, it usually takes just a few extra seconds. + // You can resubmit the request immediately. + // + // RESERVED The domain name has been reserved for another person or organization. + // + // UNAVAILABLE The domain name is not available. + // + // UNAVAILABLE_PREMIUM The domain name is not available. + // + // UNAVAILABLE_RESTRICTED The domain name is forbidden. Availability types.DomainAvailability // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_CheckDomainTransferability.go b/service/route53domains/api_op_CheckDomainTransferability.go index 1b9933d7ec2..e6836cb081d 100644 --- a/service/route53domains/api_op_CheckDomainTransferability.go +++ b/service/route53domains/api_op_CheckDomainTransferability.go @@ -32,14 +32,19 @@ 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) - // in the Amazon Route 53 Developer Guide. The domain name can contain only the - // following characters: + // supported TLDs, see [Domains that You Can Register with Amazon Route 53]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 - // . + // + // - Period (.) to separate the labels in the name, such as the . in example.com . + // + // [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 diff --git a/service/route53domains/api_op_DeleteDomain.go b/service/route53domains/api_op_DeleteDomain.go index 16a0c712be8..a385afcc45a 100644 --- a/service/route53domains/api_op_DeleteDomain.go +++ b/service/route53domains/api_op_DeleteDomain.go @@ -11,8 +11,9 @@ 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]. +// +// 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: // @@ -24,6 +25,8 @@ import ( // - 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 . +// +// [Deleting a domain name registration]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-delete.html func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error) { if params == nil { params = &DeleteDomainInput{} @@ -52,8 +55,9 @@ 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]. + // + // [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_DeleteTagsForDomain.go b/service/route53domains/api_op_DeleteTagsForDomain.go index 82159c2ca54..0b52a5a2d04 100644 --- a/service/route53domains/api_op_DeleteTagsForDomain.go +++ b/service/route53domains/api_op_DeleteTagsForDomain.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation deletes the specified tags for a domain. All tag operations are -// eventually consistent; subsequent operations might not immediately represent all -// issued operations. +// This operation deletes the specified tags for a domain. +// +// All tag operations are eventually consistent; subsequent operations might not +// immediately represent all issued operations. func (c *Client) DeleteTagsForDomain(ctx context.Context, params *DeleteTagsForDomainInput, optFns ...func(*Options)) (*DeleteTagsForDomainOutput, error) { if params == nil { params = &DeleteTagsForDomainInput{} diff --git a/service/route53domains/api_op_DisableDomainTransferLock.go b/service/route53domains/api_op_DisableDomainTransferLock.go index e7867003001..341cf2cbe93 100644 --- a/service/route53domains/api_op_DisableDomainTransferLock.go +++ b/service/route53domains/api_op_DisableDomainTransferLock.go @@ -46,8 +46,9 @@ 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]. + // + // [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 a62494712b6..4b4a3d77260 100644 --- a/service/route53domains/api_op_DisassociateDelegationSignerFromDomain.go +++ b/service/route53domains/api_op_DisassociateDelegationSignerFromDomain.go @@ -35,9 +35,9 @@ type DisassociateDelegationSignerFromDomainInput struct { 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) - // . + // created. You can retrieve it as part of DNSSEC information returned by [GetDomainDetail]. + // + // [GetDomainDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetDomainDetail.html // // This member is required. Id *string @@ -48,8 +48,9 @@ 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]. + // + // [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 237d89c53a8..753a0813247 100644 --- a/service/route53domains/api_op_EnableDomainAutoRenew.go +++ b/service/route53domains/api_op_EnableDomainAutoRenew.go @@ -12,11 +12,14 @@ import ( // This operation configures Amazon Route 53 to automatically renew the specified // 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) -// 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. +// 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]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. +// +// [Domains That You Can Register with Amazon Route 53]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html func (c *Client) EnableDomainAutoRenew(ctx context.Context, params *EnableDomainAutoRenewInput, optFns ...func(*Options)) (*EnableDomainAutoRenewOutput, error) { if params == nil { params = &EnableDomainAutoRenewInput{} diff --git a/service/route53domains/api_op_GetContactReachabilityStatus.go b/service/route53domains/api_op_GetContactReachabilityStatus.go index 2d3b55dbf79..6d06aab0256 100644 --- a/service/route53domains/api_op_GetContactReachabilityStatus.go +++ b/service/route53domains/api_op_GetContactReachabilityStatus.go @@ -13,8 +13,10 @@ import ( // For operations that require confirmation that the email address for the // registrant contact is valid, such as registering a new domain, this operation -// returns information about whether the registrant contact has responded. If you -// want us to resend the email, use the ResendContactReachabilityEmail operation. +// returns information about whether the registrant contact has responded. +// +// If you want us to resend the email, use the ResendContactReachabilityEmail +// operation. func (c *Client) GetContactReachabilityStatus(ctx context.Context, params *GetContactReachabilityStatusInput, optFns ...func(*Options)) (*GetContactReachabilityStatusOutput, error) { if params == nil { params = &GetContactReachabilityStatusInput{} @@ -45,9 +47,12 @@ type GetContactReachabilityStatusOutput struct { DomainName *string // Whether the registrant contact has responded. Values include the following: - // PENDING We sent the confirmation email and haven't received a response yet. DONE - // We sent the email and got confirmation from the registrant contact. EXPIRED The - // time limit expired before the registrant contact responded. + // + // PENDING We sent the confirmation email and haven't received a response yet. + // + // DONE We sent the email and got confirmation from the registrant contact. + // + // EXPIRED The time limit expired before the registrant contact responded. Status types.ReachabilityStatus // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_GetDomainDetail.go b/service/route53domains/api_op_GetDomainDetail.go index dfb3036a4a1..88a4372c3f0 100644 --- a/service/route53domains/api_op_GetDomainDetail.go +++ b/service/route53domains/api_op_GetDomainDetail.go @@ -117,15 +117,19 @@ type GetDomainDetailOutput struct { Reseller *string // An array of domain name status codes, also known as Extensible Provisioning - // Protocol (EPP) status codes. ICANN, the organization that maintains a central - // database of domain names, has developed a set of domain name status codes that - // tell you the status of a variety of operations on a domain name, for example, - // 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.) + // Protocol (EPP) status codes. + // + // ICANN, the organization that maintains a central database of domain names, has + // developed a set of domain name status codes that tell you the status of a + // variety of operations on a domain name, for example, 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]and search for epp status codes . (Search on the ICANN + // website; web searches sometimes return an old version of the document.) + // + // [ICANN website]: https://www.icann.org/ StatusList []string // Provides details about the domain technical contact. diff --git a/service/route53domains/api_op_GetDomainSuggestions.go b/service/route53domains/api_op_GetDomainSuggestions.go index 1d8711e981f..5a1a25a20be 100644 --- a/service/route53domains/api_op_GetDomainSuggestions.go +++ b/service/route53domains/api_op_GetDomainSuggestions.go @@ -31,19 +31,24 @@ 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) - // in the Amazon Route 53 Developer Guide. The domain name can contain only the - // following characters: + // supports. For a list of supported TLDs, see [Domains that You Can Register with Amazon Route 53]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 - // . + // + // - 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) - // . + // names, see [Domains that You Can Register with Amazon Route 53]. + // + // [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 diff --git a/service/route53domains/api_op_GetOperationDetail.go b/service/route53domains/api_op_GetOperationDetail.go index f5828ad28b1..f54b3fe75cc 100644 --- a/service/route53domains/api_op_GetOperationDetail.go +++ b/service/route53domains/api_op_GetOperationDetail.go @@ -28,8 +28,9 @@ 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) -// request includes the following element. +// The [GetOperationDetail] request includes the following element. +// +// [GetOperationDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html type GetOperationDetailInput struct { // The identifier for the operation for which you want to get the status. Route 53 @@ -47,7 +48,7 @@ type GetOperationDetailOutput struct { // The name of a domain. DomainName *string - // The date when the operation was last updated. + // The date when the operation was last updated. LastUpdatedDate *time.Time // Detailed information on the status including possible errors. @@ -59,19 +60,25 @@ type GetOperationDetailOutput struct { // The current status of the requested operation in the system. Status types.OperationStatus - // Lists any outstanding operations that require customer action. Valid values + // 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) - // . + // authorization. For more information, see [ResendOperationAuthorization]. + // // - 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. + // + // [ResendOperationAuthorization]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ResendOperationAuthorization.html 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 22584eececc..aecbf377a64 100644 --- a/service/route53domains/api_op_ListDomains.go +++ b/service/route53domains/api_op_ListDomains.go @@ -41,11 +41,14 @@ type ListDomainsInput struct { // 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 + // Number of domains to be returned. + // + // Default: 20 MaxItems *int32 // A complex type that contains information about the requested ordering of @@ -160,7 +163,9 @@ var _ ListDomainsAPIClient = (*Client)(nil) // ListDomainsPaginatorOptions is the paginator options for ListDomains type ListDomainsPaginatorOptions struct { - // Number of domains to be returned. Default: 20 + // Number of domains to be returned. + // + // Default: 20 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53domains/api_op_ListOperations.go b/service/route53domains/api_op_ListOperations.go index 95513af9347..8d9e6c228d7 100644 --- a/service/route53domains/api_op_ListOperations.go +++ b/service/route53domains/api_op_ListOperations.go @@ -14,7 +14,9 @@ import ( // Returns information about all of the operations that return an operation ID and // that have ever been performed on domains that were registered by the current -// account. This command runs only in the us-east-1 Region. +// account. +// +// This command runs only in the us-east-1 Region. func (c *Client) ListOperations(ctx context.Context, params *ListOperationsInput, optFns ...func(*Options)) (*ListOperationsOutput, error) { if params == nil { params = &ListOperationsInput{} @@ -41,16 +43,18 @@ type ListOperationsInput struct { // element. Marker *string - // Number of domains to be returned. Default: 20 + // Number of domains to be returned. + // + // Default: 20 MaxItems *int32 - // The sort type for returned values. + // The sort type for returned values. SortBy types.ListOperationsSortAttributeName - // The sort order for returned values, either ascending or descending. + // The sort order for returned values, either ascending or descending. SortOrder types.SortOrder - // The status of the operations. + // The status of the operations. Status []types.OperationStatus // An optional parameter that lets you get information about all the operations @@ -58,7 +62,7 @@ type ListOperationsInput struct { // Unix time format and Coordinated Universal time (UTC). SubmittedSince *time.Time - // An arrays of the domains operation types. + // An arrays of the domains operation types. Type []types.OperationType noSmithyDocumentSerde @@ -167,7 +171,9 @@ var _ ListOperationsAPIClient = (*Client)(nil) // ListOperationsPaginatorOptions is the paginator options for ListOperations type ListOperationsPaginatorOptions struct { - // Number of domains to be returned. Default: 20 + // Number of domains to be returned. + // + // Default: 20 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53domains/api_op_ListPrices.go b/service/route53domains/api_op_ListPrices.go index d0be6b6a82f..bd2e4034853 100644 --- a/service/route53domains/api_op_ListPrices.go +++ b/service/route53domains/api_op_ListPrices.go @@ -13,10 +13,15 @@ import ( // 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 { @@ -39,16 +44,20 @@ type ListPricesInput struct { // 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 . + // includes the value of NextPageMarker in the Marker element. + // + // Used only for all 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 . + // Number of Prices to be returned. + // + // Used only for all TLDs. If you specify a TLD, 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 + // . + // + // If a Tld value is not provided, a list of prices for all TLDs supported by // Route 53 is returned. Tld *string @@ -59,6 +68,7 @@ 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 . NextPageMarker *string @@ -157,8 +167,9 @@ 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 . + // Number of Prices to be returned. + // + // Used only for all TLDs. If you specify a TLD, 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_ListTagsForDomain.go b/service/route53domains/api_op_ListTagsForDomain.go index 4852986b1f2..72dec634c8b 100644 --- a/service/route53domains/api_op_ListTagsForDomain.go +++ b/service/route53domains/api_op_ListTagsForDomain.go @@ -12,8 +12,10 @@ import ( ) // This operation returns all of the tags that are associated with the specified -// domain. All tag operations are eventually consistent; subsequent operations -// might not immediately represent all issued operations. +// domain. +// +// All tag operations are eventually consistent; subsequent operations might not +// immediately represent all issued operations. func (c *Client) ListTagsForDomain(ctx context.Context, params *ListTagsForDomainInput, optFns ...func(*Options)) (*ListTagsForDomainOutput, error) { if params == nil { params = &ListTagsForDomainInput{} diff --git a/service/route53domains/api_op_PushDomain.go b/service/route53domains/api_op_PushDomain.go index aae7d879ccb..820ab92514a 100644 --- a/service/route53domains/api_op_PushDomain.go +++ b/service/route53domains/api_op_PushDomain.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Moves a domain from Amazon Web Services to another registrar. Supported -// actions: +// 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. func (c *Client) PushDomain(ctx context.Context, params *PushDomainInput, optFns ...func(*Options)) (*PushDomainOutput, error) { @@ -31,12 +33,12 @@ func (c *Client) PushDomain(ctx context.Context, params *PushDomainInput, optFns type PushDomainInput struct { - // Name of the domain. + // Name of the domain. // // This member is required. DomainName *string - // New IPS tag for the domain. + // New IPS tag for the domain. // // This member is required. Target *string diff --git a/service/route53domains/api_op_RegisterDomain.go b/service/route53domains/api_op_RegisterDomain.go index e2dc227df5f..4078117938c 100644 --- a/service/route53domains/api_op_RegisterDomain.go +++ b/service/route53domains/api_op_RegisterDomain.go @@ -12,26 +12,35 @@ import ( ) // This operation registers a domain. For some top-level domains (TLDs), this -// operation requires extra parameters. When you register a domain, Amazon Route 53 -// does the following: +// operation 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. +// // - 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 for // the registrar or the phrase "REDACTED FOR PRIVACY", or "On behalf of owner." If // you don't enable privacy protection, WHOIS queries return the information that -// you entered for the administrative, registrant, and technical contacts. While -// some domains may allow different privacy settings per contact, we recommend -// specifying the same privacy setting for all 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. -// - 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/) -// . +// you entered for the administrative, registrant, and technical contacts. +// +// While some domains may allow different privacy settings per contact, we +// +// recommend specifying the same privacy setting for all 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. +// +// - Charges your Amazon Web Services account an amount based on the top-level +// domain. For more information, see [Amazon Route 53 Pricing]. +// +// [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{} @@ -51,62 +60,75 @@ func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput 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) - // . + // you specify for each element, see [ContactDetail]. + // + // [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) - // in the Amazon Route 53 Developer Guide. The domain name can contain only the - // following characters: + // .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] + // 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 - // . + // + // - 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) - // . + // names, see [Domains that You Can Register with Amazon Route 53]. For more information, see [Formatting Internationalized Domain Names]. + // + // [Formatting Internationalized Domain Names]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns + // [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 // 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) - // in the Amazon Route 53 Developer Guide. Default: 1 + // top-level domain. For the range of valid values for your domain, see [Domains that You Can Register with Amazon Route 53]in the + // Amazon Route 53 Developer Guide. + // + // Default: 1 + // + // [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. 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) - // . + // you specify for each element, see [ContactDetail]. + // + // [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) - // . + // you specify for each element, see [ContactDetail]. + // + // [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: - // true + // false ). Auto renewal only takes effect after the account is charged. + // + // Default: true AutoRenew *bool // 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) - // . + // you specify for each element, see [ContactDetail]. + // + // [ContactDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html BillingContact *types.ContactDetail // Reserved for future use. @@ -115,15 +137,19 @@ type RegisterDomainInput struct { // Whether you want to conceal contact information from WHOIS queries. If you // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. 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, billing, - // registrant, and technical contacts. Default: true + // WHOIS queries return the information that you entered for the admin contact. + // + // You must specify the same privacy setting for the administrative, billing, + // 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 // Amazon Registrar or for our registrar associate, Gandi. If you specify false , // WHOIS queries return the information that you entered for the billing contact. + // // You must specify the same privacy setting for the administrative, billing, // registrant, and technical contacts. PrivacyProtectBillingContact *bool @@ -132,16 +158,23 @@ type RegisterDomainInput struct { // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. 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, billing, registrant, and technical contacts. Default: true + // (the domain owner). + // + // You must specify the same privacy setting for the administrative, billing, + // 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 // Amazon Registrar or for our registrar associate, Gandi. 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, billing, - // registrant, and technical contacts. Default: true + // registrant, and technical contacts. + // + // Default: true PrivacyProtectTechContact *bool noSmithyDocumentSerde @@ -151,8 +184,9 @@ 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]. + // + // [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 8f420efc57f..79fd9290dd3 100644 --- a/service/route53domains/api_op_RejectDomainTransferFromAnotherAwsAccount.go +++ b/service/route53domains/api_op_RejectDomainTransferFromAnotherAwsAccount.go @@ -12,12 +12,15 @@ import ( // 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 +// Web Services accounts using [TransferDomainToAnotherAwsAccount]. +// +// Use either [ListOperations] or [GetOperationDetail] to determine whether the operation succeeded. [GetOperationDetail] provides +// additional information, for example, Domain Transfer from Aws Account // 111122223333 has been cancelled . +// +// [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html +// [ListOperations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html +// [GetOperationDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html func (c *Client) RejectDomainTransferFromAnotherAwsAccount(ctx context.Context, params *RejectDomainTransferFromAnotherAwsAccountInput, optFns ...func(*Options)) (*RejectDomainTransferFromAnotherAwsAccountOutput, error) { if params == nil { params = &RejectDomainTransferFromAnotherAwsAccountInput{} @@ -38,8 +41,9 @@ 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) - // request. + // account submitted a [TransferDomainToAnotherAwsAccount]request. + // + // [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html // // This member is required. DomainName *string diff --git a/service/route53domains/api_op_RenewDomain.go b/service/route53domains/api_op_RenewDomain.go index 2bd931e760e..56522fdfe84 100644 --- a/service/route53domains/api_op_RenewDomain.go +++ b/service/route53domains/api_op_RenewDomain.go @@ -11,12 +11,14 @@ import ( ) // This operation renews a domain for the specified number of years. The cost of -// renewing your domain is billed to your Amazon Web Services account. We recommend -// 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 your domain is billed to your Amazon Web Services account. +// +// We recommend 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]in the Amazon Route 53 Developer Guide. +// +// [Renewing Registration for a Domain]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html func (c *Client) RenewDomain(ctx context.Context, params *RenewDomainInput, optFns ...func(*Options)) (*RenewDomainOutput, error) { if params == nil { params = &RenewDomainInput{} @@ -49,8 +51,11 @@ type RenewDomainInput struct { // 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 + // domain, see [Domains that You Can Register with Amazon Route 53]in the Amazon Route 53 Developer Guide. + // + // Default: 1 + // + // [Domains that You Can Register with Amazon Route 53]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html DurationInYears *int32 noSmithyDocumentSerde @@ -59,8 +64,9 @@ 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]. + // + // [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_ResendOperationAuthorization.go b/service/route53domains/api_op_ResendOperationAuthorization.go index 6313053cd53..088a2e95edc 100644 --- a/service/route53domains/api_op_ResendOperationAuthorization.go +++ b/service/route53domains/api_op_ResendOperationAuthorization.go @@ -28,7 +28,7 @@ func (c *Client) ResendOperationAuthorization(ctx context.Context, params *Resen type ResendOperationAuthorizationInput struct { - // Operation ID. + // Operation ID. // // This member is required. OperationId *string diff --git a/service/route53domains/api_op_TransferDomain.go b/service/route53domains/api_op_TransferDomain.go index 9854fd92e4b..0119885ac4f 100644 --- a/service/route53domains/api_op_TransferDomain.go +++ b/service/route53domains/api_op_TransferDomain.go @@ -11,35 +11,45 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Transfers a domain from another registrar to Amazon Route 53. For more -// information about transferring domains, see the following topics: +// Transfers a domain from another registrar to Amazon Route 53. +// +// 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. +// viewing the status of a domain that you're transferring to Route 53, see [Transferring Registration for a Domain to Amazon Route 53]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) -// . +// account to another, see [TransferDomainToAnotherAwsAccount]. +// // - 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. +// see [Transferring a Domain from Amazon Route 53 to Another Registrar]in the Amazon Route 53 Developer Guide. // // During the transfer of any country code top-level domains (ccTLDs) to Route 53, // except for .cc and .tv, updates to the owner contact are ignored and the owner // contact data from the registry is used. You can update the owner contact after -// the transfer is complete. For more information, see UpdateDomainContact (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainContact.html) -// . If the registrar for your domain is also the DNS service provider for the +// the transfer is complete. For more information, see [UpdateDomainContact]. +// +// 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 +// 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. +// +// [Transferring a Domain from Amazon Route 53 to Another Registrar]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html +// [TransferDomainToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html +// [Transferring Registration for a Domain to Amazon Route 53]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html +// [UpdateDomainContact]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainContact.html func (c *Client) TransferDomain(ctx context.Context, params *TransferDomainInput, optFns ...func(*Options)) (*TransferDomainOutput, error) { if params == nil { params = &TransferDomainInput{} @@ -65,21 +75,28 @@ 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) - // in the Amazon Route 53 Developer Guide. The domain name can contain only the - // following characters: + // supported TLDs, see [Domains that You Can Register with Amazon Route 53]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 - // . + // + // - Period (.) to separate the labels in the name, such as the . in example.com . + // + // [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 // 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. Default: 1 + // top-level domain. + // + // Default: 1 // // This member is required. DurationInYears *int32 @@ -99,8 +116,9 @@ type TransferDomainInput struct { AuthCode *string // Indicates whether the domain will be automatically renewed (true) or not - // (false). Auto renewal only takes effect after the account is charged. Default: - // true + // (false). Auto renewal only takes effect after the account is charged. + // + // Default: true AutoRenew *bool // Provides detailed contact information. @@ -114,15 +132,19 @@ type TransferDomainInput struct { // Whether you want to conceal contact information from WHOIS queries. If you // specify true , WHOIS ("who is") queries return contact information for the - // registrar, the phrase "REDACTED FOR PRIVACY", or "On behalf of owner.". While - // some domains may allow different privacy settings per contact, we recommend - // specifying the same privacy setting for all contacts. Default: true + // registrar, the phrase "REDACTED FOR PRIVACY", or "On behalf of owner.". + // + // While some domains may allow different privacy settings per contact, we + // recommend specifying the same privacy setting for all contacts. + // + // Default: true PrivacyProtectAdminContact *bool - // Whether you want to conceal contact information from WHOIS queries. If you + // Whether you want to conceal contact information from WHOIS queries. If you // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. If you specify false , // WHOIS queries return the information that you entered for the billing contact. + // // You must specify the same privacy setting for the administrative, billing, // registrant, and technical contacts. PrivacyProtectBillingContact *bool @@ -131,16 +153,23 @@ type TransferDomainInput struct { // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. 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, billing, registrant, and technical contacts. Default: true + // (domain owner). + // + // You must specify the same privacy setting for the administrative, billing, + // 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 // Amazon Registrar or for our registrar associate, Gandi. 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, billing, - // registrant, and technical contacts. Default: true + // registrant, and technical contacts. + // + // Default: true PrivacyProtectTechContact *bool noSmithyDocumentSerde @@ -150,8 +179,9 @@ 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]. + // + // [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 7c2bf856a1f..ef8788f7c87 100644 --- a/service/route53domains/api_op_TransferDomainToAnotherAwsAccount.go +++ b/service/route53domains/api_op_TransferDomainToAnotherAwsAccount.go @@ -12,28 +12,32 @@ 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) -// . +// days, we cancel the transfer. See [AcceptDomainTransferFromAnotherAwsAccount]. +// +// - You can cancel the transfer before the other account accepts it. See [CancelDomainTransferToAnotherAwsAccount]. +// +// - The other account can reject the transfer. See [RejectDomainTransferFromAnotherAwsAccount]. // // 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) -// provides additional information, for example, Domain Transfer from Aws Account +// about transferring the hosted zone to another Amazon Web Services account, see [Migrating a Hosted Zone to a Different Amazon Web Services Account] +// in the Amazon Route 53 Developer Guide. +// +// Use either [ListOperations] or [GetOperationDetail] to determine whether the operation succeeded. [GetOperationDetail] provides +// additional information, for example, Domain Transfer from Aws Account // 111122223333 has been cancelled . +// +// [RejectDomainTransferFromAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_RejectDomainTransferFromAnotherAwsAccount.html +// [AcceptDomainTransferFromAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html +// [Migrating a Hosted Zone to a Different Amazon Web Services Account]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-migrating.html +// [CancelDomainTransferToAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_CancelDomainTransferToAnotherAwsAccount.html +// [ListOperations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html +// [GetOperationDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html func (c *Client) TransferDomainToAnotherAwsAccount(ctx context.Context, params *TransferDomainToAnotherAwsAccountInput, optFns ...func(*Options)) (*TransferDomainToAnotherAwsAccountOutput, error) { if params == nil { params = &TransferDomainToAnotherAwsAccountInput{} @@ -71,15 +75,17 @@ 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]. + // + // [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) - // request. The request must include the value of the Password element that was - // returned in the TransferDomainToAnotherAwsAccount response. + // account that the domain is being transferred to must submit an [AcceptDomainTransferFromAnotherAwsAccount]request. The + // request must include the value of the Password element that was returned in the + // TransferDomainToAnotherAwsAccount response. + // + // [AcceptDomainTransferFromAnotherAwsAccount]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html Password *string // Metadata pertaining to the operation's result. diff --git a/service/route53domains/api_op_UpdateDomainContact.go b/service/route53domains/api_op_UpdateDomainContact.go index 8cfc56f2e38..94b92900b78 100644 --- a/service/route53domains/api_op_UpdateDomainContact.go +++ b/service/route53domains/api_op_UpdateDomainContact.go @@ -13,10 +13,11 @@ import ( // 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 -// email. +// 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 email. func (c *Client) UpdateDomainContact(ctx context.Context, params *UpdateDomainContactInput, optFns ...func(*Options)) (*UpdateDomainContactOutput, error) { if params == nil { params = &UpdateDomainContactInput{} @@ -46,7 +47,7 @@ type UpdateDomainContactInput struct { // Provides detailed contact information. BillingContact *types.ContactDetail - // Customer's consent for the owner change request. Required if the domain is not + // Customer's consent for the owner change request. Required if the domain is not // free (consent price is more than $0.00). Consent *types.Consent @@ -63,8 +64,9 @@ 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]. + // + // [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 7f56a0461f4..78b4b139c81 100644 --- a/service/route53domains/api_op_UpdateDomainContactPrivacy.go +++ b/service/route53domains/api_op_UpdateDomainContactPrivacy.go @@ -13,22 +13,28 @@ import ( // This operation updates the specified domain contact's privacy setting. When // privacy protection is enabled, your contact information is replaced with contact // information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On -// behalf of owner." While some domains may allow different privacy settings per -// contact, we recommend specifying the same privacy setting for all 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) -// 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 +// behalf of owner." +// +// While some domains may allow different privacy settings per contact, we +// recommend specifying the same privacy setting for all 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]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 // contact information provided for this domain via the public WHOIS database. You // certify that you are the registrant of this domain name and have the authority // to make this decision. You may withdraw your consent at any time by enabling // 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/]: https://aws.amazon.com/privacy/ +// [GetOperationDetail]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html func (c *Client) UpdateDomainContactPrivacy(ctx context.Context, params *UpdateDomainContactPrivacyInput, optFns ...func(*Options)) (*UpdateDomainContactPrivacyOutput, error) { if params == nil { params = &UpdateDomainContactPrivacyInput{} @@ -55,15 +61,17 @@ type UpdateDomainContactPrivacyInput struct { // Whether you want to conceal contact information from WHOIS queries. If you // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. 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, billing, + // WHOIS queries return the information that you entered for the admin contact. + // + // You must specify the same privacy setting for the administrative, billing, // registrant, and technical contacts. AdminPrivacy *bool - // Whether you want to conceal contact information from WHOIS queries. If you + // Whether you want to conceal contact information from WHOIS queries. If you // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. If you specify false , // WHOIS queries return the information that you entered for the billing contact. + // // You must specify the same privacy setting for the administrative, billing, // registrant, and technical contacts. BillingPrivacy *bool @@ -72,14 +80,17 @@ type UpdateDomainContactPrivacyInput struct { // specify true , WHOIS ("who is") queries return contact information either for // Amazon Registrar or for our registrar associate, Gandi. 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, billing, registrant, and technical contacts. + // (domain owner). + // + // You must specify the same privacy setting for the administrative, billing, + // 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 // Amazon Registrar or for our registrar associate, Gandi. 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, billing, // registrant, and technical contacts. TechPrivacy *bool diff --git a/service/route53domains/api_op_UpdateDomainNameservers.go b/service/route53domains/api_op_UpdateDomainNameservers.go index 830744abbb4..cd282f0a1eb 100644 --- a/service/route53domains/api_op_UpdateDomainNameservers.go +++ b/service/route53domains/api_op_UpdateDomainNameservers.go @@ -14,9 +14,11 @@ import ( // This operation replaces the current set of name servers for the domain with the // specified set of name servers. If you use Amazon Route 53 as your DNS service, // specify the four name servers in the delegation set for the hosted zone for the -// domain. If successful, this operation 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 will be notified by email. +// domain. +// +// If successful, this operation 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 will be notified by email. func (c *Client) UpdateDomainNameservers(ctx context.Context, params *UpdateDomainNameserversInput, optFns ...func(*Options)) (*UpdateDomainNameserversOutput, error) { if params == nil { params = &UpdateDomainNameserversInput{} @@ -34,9 +36,10 @@ func (c *Client) UpdateDomainNameservers(ctx context.Context, params *UpdateDoma // Replaces the current set of name servers for the domain with the specified set // of name servers. If you use Amazon Route 53 as your DNS service, specify the -// four name servers in the delegation set for the hosted zone for the domain. If -// successful, this operation returns an operation ID that you can use to track the -// progress and completion of the action. If the request is not completed +// four name servers in the delegation set for the hosted zone for the domain. +// +// If successful, this operation 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 will be notified by email. type UpdateDomainNameserversInput struct { @@ -62,8 +65,9 @@ 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]. + // + // [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 9ef2fece29d..5f064e51b83 100644 --- a/service/route53domains/api_op_UpdateTagsForDomain.go +++ b/service/route53domains/api_op_UpdateTagsForDomain.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation adds or updates tags for a specified domain. All tag operations -// are eventually consistent; subsequent operations might not immediately represent -// all issued operations. +// This operation adds or updates tags for a specified domain. +// +// All tag operations are eventually consistent; subsequent operations might not +// immediately represent all issued operations. func (c *Client) UpdateTagsForDomain(ctx context.Context, params *UpdateTagsForDomainInput, optFns ...func(*Options)) (*UpdateTagsForDomainOutput, error) { if params == nil { params = &UpdateTagsForDomainInput{} diff --git a/service/route53domains/api_op_ViewBilling.go b/service/route53domains/api_op_ViewBilling.go index f44f619c345..b95d1c822a6 100644 --- a/service/route53domains/api_op_ViewBilling.go +++ b/service/route53domains/api_op_ViewBilling.go @@ -43,11 +43,15 @@ type ViewBillingInput struct { // 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. + // 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 + // The number of billing records to be returned. + // + // Default: 20 MaxItems *int32 // The beginning date and time for the time period for which you want a list of @@ -160,7 +164,9 @@ var _ ViewBillingAPIClient = (*Client)(nil) // ViewBillingPaginatorOptions is the paginator options for ViewBilling type ViewBillingPaginatorOptions struct { - // The number of billing records to be returned. Default: 20 + // The number of billing records to be returned. + // + // Default: 20 Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53domains/options.go b/service/route53domains/options.go index a80c0cce1f4..caa277b9fb0 100644 --- a/service/route53domains/options.go +++ b/service/route53domains/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53domains/types/enums.go b/service/route53domains/types/enums.go index ccdd18f9a89..fae9fb69355 100644 --- a/service/route53domains/types/enums.go +++ b/service/route53domains/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ContactType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactType) Values() []ContactType { return []ContactType{ "PERSON", @@ -284,8 +285,9 @@ const ( ) // Values returns all known values for CountryCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CountryCode) Values() []CountryCode { return []CountryCode{ "AC", @@ -559,8 +561,9 @@ const ( ) // Values returns all known values for DomainAvailability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DomainAvailability) Values() []DomainAvailability { return []DomainAvailability{ "AVAILABLE", @@ -614,8 +617,9 @@ const ( ) // Values returns all known values for ExtraParamName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExtraParamName) Values() []ExtraParamName { return []ExtraParamName{ "DUNS_NUMBER", @@ -662,6 +666,7 @@ const ( // 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{ @@ -679,8 +684,9 @@ const ( // Values returns all known values for ListOperationsSortAttributeName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListOperationsSortAttributeName) Values() []ListOperationsSortAttributeName { return []ListOperationsSortAttributeName{ "SubmittedDate", @@ -699,8 +705,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "SUBMITTED", @@ -738,8 +745,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "REGISTER_DOMAIN", @@ -775,8 +783,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "LE", @@ -795,8 +804,9 @@ const ( ) // Values returns all known values for ReachabilityStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReachabilityStatus) Values() []ReachabilityStatus { return []ReachabilityStatus{ "PENDING", @@ -814,8 +824,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -835,8 +846,9 @@ const ( ) // Values returns all known values for StatusFlag. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusFlag) Values() []StatusFlag { return []StatusFlag{ "PENDING_ACCEPTANCE", @@ -860,8 +872,9 @@ const ( ) // 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. +// expanded in the future, and so 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 e3065c997f3..628daba08ce 100644 --- a/service/route53domains/types/errors.go +++ b/service/route53domains/types/errors.go @@ -7,7 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// This error is returned if you call AssociateDelegationSignerToDomain when the +// This error is returned if you call AssociateDelegationSignerToDomain when the +// // specified domain has reached the maximum number of DS records. You can't add any // additional DS records unless you delete an existing one first. type DnssecLimitExceeded struct { diff --git a/service/route53domains/types/types.go b/service/route53domains/types/types.go index 46b36552d66..74bc8386f0e 100644 --- a/service/route53domains/types/types.go +++ b/service/route53domains/types/types.go @@ -16,8 +16,9 @@ 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) - // in the Amazon Route 53 Developer Guide. + // information, see [DNS Domain Name Format]in the Amazon Route 53 Developer Guide. + // + // [DNS Domain Name Format]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html DomainName *string // The ID of the invoice that is associated with the billing record. @@ -26,8 +27,9 @@ 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 @@ -36,12 +38,12 @@ 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 - // Maximum amount the customer agreed to accept. + // Maximum amount the customer agreed to accept. // // This member is required. MaxPrice float64 @@ -63,14 +65,18 @@ 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 + // TLD, see [Domains that You Can Register with Amazon Route 53]in the Amazon Route 53 Developer Guide + // // - For .es domains, the value of ContactType must be PERSON for all three // contacts. + // + // [Domains that You Can Register with Amazon Route 53]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html ContactType ContactType // Code for the country of the contact's address. @@ -82,9 +88,11 @@ type ContactDetail struct { // A list of name-value pairs for parameters required by certain top-level domains. ExtraParams []ExtraParam - // 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" . + // 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" . Fax *string // First name of contact. @@ -96,9 +104,11 @@ type ContactDetail struct { // 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" . + // 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" . PhoneNumber *string // The state or province of the contact's city. @@ -110,40 +120,54 @@ type ContactDetail struct { noSmithyDocumentSerde } -// 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. +// Information about the DNSSEC key. +// +// You get this from your DNS provider and then give it to Route 53 (by using [AssociateDelegationSignerToDomain]) to +// pass it to the registry to establish the chain of trust. +// +// [AssociateDelegationSignerToDomain]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AssociateDelegationSignerToDomain.html 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) - // 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) - // . + // The number of the public key’s cryptographic algorithm according to an [IANA] + // 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]. + // + // [Enabling DNSSEC signing and establishing a chain of trust]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec-enable-signing.html + // [IANA]: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xml Algorithm *int32 - // The delegation signer digest. Digest is calculated from the public key provided - // using specified digest algorithm and this digest is the actual value returned - // from the registry nameservers as the value of DS records. + // The delegation signer digest. + // + // Digest is calculated from the public key provided using specified digest + // algorithm and this digest is the actual value returned from the registry + // nameservers as the value of DS records. 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. + // The number of the DS digest algorithm according to an IANA assignment. + // + // For more information, see [IANA] for DNSSEC Delegation Signer (DS) Resource Record + // (RR) Type Digest Algorithms. + // + // [IANA]: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml DigestType *int32 // Defines the type of key. It can be either a KSK (key-signing-key, value 257) or // ZSK (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK - // if your DNS provider isn't Route 53 and you don’t have KSK available. If you - // have KSK and ZSK keys, always use KSK to create a delegations signer (DS) - // record. If you have ZSK keys only – use ZSK to create a DS record. + // if your DNS provider isn't Route 53 and you don’t have KSK available. + // + // If you have KSK and ZSK keys, always use KSK to create a delegations signer + // (DS) 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]. + // + // [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. + // A numeric identification of the DNSKEY record referred to by this DS record. KeyTag *int32 // The base64-encoded public key part of the key pair that is passed to the @@ -154,21 +178,23 @@ 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]. +// +// [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. + // Algorithm which was used to generate the digest from the public key. Algorithm *int32 // Defines the type of key. It can be either a KSK (key-signing-key, value 257) or // ZSK (zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK - // if your DNS provider isn't Route 53 and you don’t have KSK available. If you - // have KSK and ZSK keys, always use KSK to create a delegations signer (DS) - // record. If you have ZSK keys only – use ZSK to create a DS record. + // if your DNS provider isn't Route 53 and you don’t have KSK available. + // + // If you have KSK and ZSK keys, always use KSK to create a delegations signer + // (DS) record. If you have ZSK keys only – use ZSK to create a DS record. Flags *int32 - // The base64-encoded public key part of the key pair that is passed to the + // The base64-encoded public key part of the key pair that is passed to the // registry. PublicKey *string @@ -202,19 +228,33 @@ type DomainPrice struct { // Information about one suggested domain name. 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 - // 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 - // about whether the domain name is available. Route 53 can return this response - // for a variety of reasons, for example, the registry is performing maintenance. - // Try again later. PENDING The TLD registry didn't return a response in the - // expected amount of time. When the response is delayed, it usually takes just a - // few extra seconds. You can resubmit the request immediately. RESERVED The domain - // name has been reserved for another person or organization. UNAVAILABLE The - // domain name is not available. UNAVAILABLE_PREMIUM The domain name is not - // available. UNAVAILABLE_RESTRICTED The domain name is forbidden. + // Whether the domain name is available for registering. + // + // You can register only the 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 about whether + // the domain name is available. Route 53 can return this response for a variety of + // reasons, for example, the registry is performing maintenance. Try again later. + // + // PENDING The TLD registry didn't return a response in the expected amount of + // time. When the response is delayed, it usually takes just a few extra seconds. + // You can resubmit the request immediately. + // + // RESERVED The domain name has been reserved for another person or organization. + // + // UNAVAILABLE The domain name is not available. + // + // UNAVAILABLE_PREMIUM The domain name is not available. + // + // UNAVAILABLE_RESTRICTED The domain name is forbidden. Availability *string // A suggested domain name. @@ -247,13 +287,25 @@ type DomainSummary struct { // be transferred to Route 53. 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: - // 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. + // 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: + // + // 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 - // Services account. DOMAIN_IN_ANOTHER_ACCOUNT The domain exists in another Amazon - // Web Services account. PREMIUM_DOMAIN Premium domain transfer is not supported. + // Services account. + // + // DOMAIN_IN_ANOTHER_ACCOUNT The domain exists in another Amazon Web Services + // account. + // + // PREMIUM_DOMAIN Premium domain transfer is not supported. Transferable Transferable noSmithyDocumentSerde @@ -264,177 +316,355 @@ 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 + // of the parameters that they require: + // + // .com.au and .net.au // - AU_ID_NUMBER - // - AU_ID_TYPE Valid values include the following: + // + // - 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: + // + // - 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: + // + // - 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: + // + // - 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: + // - 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 : + // + // - 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 : + // + // - 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: + // + // - 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: + // + // - 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 + // // .fi // - BIRTH_DATE_IN_YYYY_MM_DD + // // - FI_BUSINESS_NUMBER + // // - FI_ID_NUMBER - // - FI_NATIONALITY Valid values include the following: + // + // - FI_NATIONALITY + // + // Valid values include the following: + // // - FINNISH + // // - NOT_FINNISH - // - FI_ORGANIZATION_TYPE Valid values include the following: + // + // - FI_ORGANIZATION_TYPE + // + // Valid values include the following: + // // - COMPANY + // // - CORPORATION + // // - GOVERNMENT + // // - INSTITUTION + // // - POLITICAL_PARTY + // // - PUBLIC_COMMUNITY + // // - TOWNSHIP + // // .it // - IT_NATIONALITY + // // - IT_PIN - // - IT_REGISTRANT_ENTITY_TYPE Valid values include the following: + // + // - 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 + // // .se // - BIRTH_COUNTRY + // // - SE_ID_NUMBER + // // .sg // - SG_ID_NUMBER + // // .uk, .co.uk, .me.uk, and .org.uk - // - UK_CONTACT_TYPE Valid values include the following: + // - 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. @@ -448,8 +678,9 @@ 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]. +// +// [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. @@ -458,14 +689,17 @@ 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 // // This member is required. Operator Operator - // An array of strings presenting values to compare. Only 1 item in the list is + // An array of strings presenting values to compare. Only 1 item in the list is // currently supported. // // This member is required. @@ -477,8 +711,9 @@ type FilterCondition struct { // Name server includes the following elements. type Nameserver struct { - // The fully qualified host name of the name server. Constraint: Maximum 255 - // characters + // The fully qualified host name of the name server. + // + // Constraint: Maximum 255 characters // // This member is required. Name *string @@ -486,8 +721,9 @@ type Nameserver struct { // 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. + // 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 noSmithyDocumentSerde @@ -496,14 +732,14 @@ type Nameserver struct { // OperationSummary includes the following elements. type OperationSummary struct { - // Name of the domain. + // Name of the domain. DomainName *string - // The date when the last change was made in Unix time format and Coordinated + // The date when the last change was made in Unix time format and Coordinated // Universal Time (UTC). LastUpdatedDate *time.Time - // Message about the operation. + // Message about the operation. Message *string // Identifier returned to track the requested action. @@ -512,19 +748,27 @@ 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: + // 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) - // . + // authorization. For more information, see [ResendOperationAuthorization]. + // // - 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. + // + // [ResendOperationAuthorization]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ResendOperationAuthorization.html StatusFlag StatusFlag // The date when the request was submitted. @@ -556,11 +800,12 @@ type PriceWithCurrency struct { 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) + // the expiration for a domain. Note that if filterCondition is used in the same [ListDomains] // call, the field used for sorting has to be the same as the field used for // filtering. // + // [ListDomains]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html + // // This member is required. Name ListDomainsAttributeName @@ -576,12 +821,18 @@ type SortCondition struct { // Each tag includes the following elements. type Tag struct { - // The key (name) of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" + // The key (name) of a tag. + // + // Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" + // // Constraints: Each key can be 1-128 characters long. Key *string - // The value of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints: - // Each value can be 0-256 characters long. + // The value of a tag. + // + // Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" + // + // Constraints: Each value can be 0-256 characters long. Value *string noSmithyDocumentSerde diff --git a/service/route53profiles/api_op_AssociateProfile.go b/service/route53profiles/api_op_AssociateProfile.go index a8d2478a669..b8e7eb75789 100644 --- a/service/route53profiles/api_op_AssociateProfile.go +++ b/service/route53profiles/api_op_AssociateProfile.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a Route 53 Profiles profile with a VPC. A VPC can have only one +// Associates a Route 53 Profiles profile with a VPC. A VPC can have only one +// // Profile associated with it, but a Profile can be associated with 1000 of VPCs -// (and you can request a higher quota). For more information, see -// https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities) -// . +// (and you can request a higher quota). For more information, see [https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities]. +// +// [https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities func (c *Client) AssociateProfile(ctx context.Context, params *AssociateProfileInput, optFns ...func(*Options)) (*AssociateProfileOutput, error) { if params == nil { params = &AssociateProfileInput{} @@ -33,22 +34,22 @@ func (c *Client) AssociateProfile(ctx context.Context, params *AssociateProfileI type AssociateProfileInput struct { - // A name for the association. + // A name for the association. // // This member is required. Name *string - // ID of the Profile. + // ID of the Profile. // // This member is required. ProfileId *string - // The ID of the VPC. + // The ID of the VPC. // // This member is required. ResourceId *string - // A list of the tag keys and values that you want to identify the Profile + // A list of the tag keys and values that you want to identify the Profile // association. Tags []types.Tag @@ -57,7 +58,7 @@ type AssociateProfileInput struct { type AssociateProfileOutput struct { - // The association that you just created. The association has an ID that you can + // The association that you just created. The association has an ID that you can // use to identify it in other requests, like update and delete. ProfileAssociation *types.ProfileAssociation diff --git a/service/route53profiles/api_op_AssociateResourceToProfile.go b/service/route53profiles/api_op_AssociateResourceToProfile.go index f6725caa81a..1d6b4e95276 100644 --- a/service/route53profiles/api_op_AssociateResourceToProfile.go +++ b/service/route53profiles/api_op_AssociateResourceToProfile.go @@ -29,25 +29,26 @@ func (c *Client) AssociateResourceToProfile(ctx context.Context, params *Associa type AssociateResourceToProfileInput struct { - // Name for the resource association. + // Name for the resource association. // // This member is required. Name *string - // ID of the Profile. + // ID of the Profile. // // This member is required. ProfileId *string - // Amazon resource number, ARN, of the DNS resource. + // Amazon resource number, ARN, of the DNS resource. // // This member is required. ResourceArn *string - // If you are adding a DNS Firewall rule group, include also a priority. The + // If you are adding a DNS Firewall rule group, include also a priority. The // priority indicates the processing order for the rule groups, starting with the - // priority assinged the lowest value. The allowed values for priority are between - // 100 and 9900. + // priority assinged the lowest value. + // + // The allowed values for priority are between 100 and 9900. ResourceProperties *string noSmithyDocumentSerde @@ -55,7 +56,7 @@ type AssociateResourceToProfileInput struct { type AssociateResourceToProfileOutput struct { - // Infromation about the AssociateResourceToProfile , including a status message. + // Infromation about the AssociateResourceToProfile , including a status message. ProfileResourceAssociation *types.ProfileResourceAssociation // Metadata pertaining to the operation's result. diff --git a/service/route53profiles/api_op_CreateProfile.go b/service/route53profiles/api_op_CreateProfile.go index 90aceb7283b..aea2fe7a51d 100644 --- a/service/route53profiles/api_op_CreateProfile.go +++ b/service/route53profiles/api_op_CreateProfile.go @@ -38,12 +38,12 @@ type CreateProfileInput struct { // This member is required. ClientToken *string - // A name for the Profile. + // A name for the Profile. // // This member is required. Name *string - // A list of the tag keys and values that you want to associate with the Route 53 + // A list of the tag keys and values that you want to associate with the Route 53 // Profile. Tags []types.Tag @@ -52,7 +52,7 @@ type CreateProfileInput struct { type CreateProfileOutput struct { - // The Profile that you just created. + // The Profile that you just created. Profile *types.Profile // Metadata pertaining to the operation's result. diff --git a/service/route53profiles/api_op_DeleteProfile.go b/service/route53profiles/api_op_DeleteProfile.go index aca0bf6fa77..42e62a5b084 100644 --- a/service/route53profiles/api_op_DeleteProfile.go +++ b/service/route53profiles/api_op_DeleteProfile.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified Route 53 Profile. Before you can delete a profile, you +// Deletes the specified Route 53 Profile. Before you can delete a profile, you +// // must first disassociate it from all VPCs. func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, optFns ...func(*Options)) (*DeleteProfileOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, type DeleteProfileInput struct { - // The ID of the Profile that you want to delete. + // The ID of the Profile that you want to delete. // // This member is required. ProfileId *string @@ -40,7 +41,7 @@ type DeleteProfileInput struct { type DeleteProfileOutput struct { - // Information about the DeleteProfile request, including the status of the + // Information about the DeleteProfile request, including the status of the // request. Profile *types.Profile diff --git a/service/route53profiles/api_op_DisassociateProfile.go b/service/route53profiles/api_op_DisassociateProfile.go index d2071297e36..d358e955a27 100644 --- a/service/route53profiles/api_op_DisassociateProfile.go +++ b/service/route53profiles/api_op_DisassociateProfile.go @@ -29,12 +29,12 @@ func (c *Client) DisassociateProfile(ctx context.Context, params *DisassociatePr type DisassociateProfileInput struct { - // ID of the Profile. + // ID of the Profile. // // This member is required. ProfileId *string - // The ID of the VPC. + // The ID of the VPC. // // This member is required. ResourceId *string @@ -44,7 +44,7 @@ type DisassociateProfileInput struct { type DisassociateProfileOutput struct { - // Information about the DisassociateProfile request. + // Information about the DisassociateProfile request. ProfileAssociation *types.ProfileAssociation // Metadata pertaining to the operation's result. diff --git a/service/route53profiles/api_op_DisassociateResourceFromProfile.go b/service/route53profiles/api_op_DisassociateResourceFromProfile.go index 87c20bbc75a..d478710810b 100644 --- a/service/route53profiles/api_op_DisassociateResourceFromProfile.go +++ b/service/route53profiles/api_op_DisassociateResourceFromProfile.go @@ -29,7 +29,7 @@ func (c *Client) DisassociateResourceFromProfile(ctx context.Context, params *Di type DisassociateResourceFromProfileInput struct { - // The ID of the Profile. + // The ID of the Profile. // // This member is required. ProfileId *string @@ -44,7 +44,7 @@ type DisassociateResourceFromProfileInput struct { type DisassociateResourceFromProfileOutput struct { - // Information about the DisassociateResourceFromProfile request, including the + // Information about the DisassociateResourceFromProfile request, including the // status of the request. ProfileResourceAssociation *types.ProfileResourceAssociation diff --git a/service/route53profiles/api_op_GetProfile.go b/service/route53profiles/api_op_GetProfile.go index 2be685c08d3..62132d0e977 100644 --- a/service/route53profiles/api_op_GetProfile.go +++ b/service/route53profiles/api_op_GetProfile.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about a specified Route 53 Profile, such as whether whether -// the Profile is shared, and the current status of the Profile. +// Returns information about a specified Route 53 Profile, such as whether +// +// whether the Profile is shared, and the current status of the Profile. func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error) { if params == nil { params = &GetProfileInput{} @@ -30,7 +31,7 @@ func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns type GetProfileInput struct { - // ID of the Profile. + // ID of the Profile. // // This member is required. ProfileId *string @@ -40,7 +41,7 @@ type GetProfileInput struct { type GetProfileOutput struct { - // Information about the Profile, including the status of the Profile. + // Information about the Profile, including the status of the Profile. Profile *types.Profile // Metadata pertaining to the operation's result. diff --git a/service/route53profiles/api_op_GetProfileAssociation.go b/service/route53profiles/api_op_GetProfileAssociation.go index 6adc2254efa..30b0bf12b32 100644 --- a/service/route53profiles/api_op_GetProfileAssociation.go +++ b/service/route53profiles/api_op_GetProfileAssociation.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a Route 53 Profile association for a VPC. A VPC can have only one +// Retrieves a Route 53 Profile association for a VPC. A VPC can have only one +// // Profile association, but a Profile can be associated with up to 5000 VPCs. func (c *Client) GetProfileAssociation(ctx context.Context, params *GetProfileAssociationInput, optFns ...func(*Options)) (*GetProfileAssociationOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) GetProfileAssociation(ctx context.Context, params *GetProfileAs type GetProfileAssociationInput struct { - // The identifier of the association you want to get information about. + // The identifier of the association you want to get information about. // // This member is required. ProfileAssociationId *string @@ -40,7 +41,7 @@ type GetProfileAssociationInput struct { type GetProfileAssociationOutput struct { - // Information about the Profile association that you specified in a + // Information about the Profile association that you specified in a // GetProfileAssociation request. ProfileAssociation *types.ProfileAssociation diff --git a/service/route53profiles/api_op_GetProfileResourceAssociation.go b/service/route53profiles/api_op_GetProfileResourceAssociation.go index 18a700acc98..48fe06ab6b0 100644 --- a/service/route53profiles/api_op_GetProfileResourceAssociation.go +++ b/service/route53profiles/api_op_GetProfileResourceAssociation.go @@ -40,7 +40,7 @@ type GetProfileResourceAssociationInput struct { type GetProfileResourceAssociationOutput struct { - // Information about the Profile resource association that you specified in a + // Information about the Profile resource association that you specified in a // GetProfileResourceAssociation request. ProfileResourceAssociation *types.ProfileResourceAssociation diff --git a/service/route53profiles/api_op_ListProfileAssociations.go b/service/route53profiles/api_op_ListProfileAssociations.go index e2b5f698443..df18f3339df 100644 --- a/service/route53profiles/api_op_ListProfileAssociations.go +++ b/service/route53profiles/api_op_ListProfileAssociations.go @@ -29,23 +29,25 @@ func (c *Client) ListProfileAssociations(ctx context.Context, params *ListProfil type ListProfileAssociationsInput struct { - // The maximum number of objects that you want to return for this request. If more - // objects are available, in the response, a NextToken value, which you can use in - // a subsequent call to get the next batch of objects, is provided. If you don't - // specify a value for MaxResults , up to 100 objects are returned. + // The maximum number of objects that you want to return for this request. If + // more objects are available, in the response, a NextToken value, which you can + // use in a subsequent call to get the next batch of objects, is provided. + // + // If you don't specify a value for MaxResults , up to 100 objects are returned. MaxResults *int32 - // For the first call to this list request, omit this value. When you request a - // list of objects, at most the number of objects specified by MaxResults is - // returned. If more objects are available for retrieval, a NextToken value is - // returned in the response. To retrieve the next batch of objects, use the token - // that was returned for the prior request in your next request. + // For the first call to this list request, omit this value. + // + // When you request a list of objects, at most the number of objects specified by + // MaxResults is returned. If more objects are available for retrieval, a NextToken + // value is returned 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 - // ID of the Profile. + // ID of the Profile. ProfileId *string - // ID of the VPC. + // ID of the VPC. ResourceId *string noSmithyDocumentSerde @@ -53,13 +55,13 @@ type ListProfileAssociationsInput struct { type ListProfileAssociationsOutput struct { - // If more than MaxResults profile associations match the specified criteria, you + // If more than MaxResults profile associations match the specified criteria, you // can submit another ListProfileAssociations request to get the next group of // results. In the next request, specify the value of NextToken from the previous // response. NextToken *string - // A complex type that containts settings information about the profile's VPC + // A complex type that containts settings information about the profile's VPC // associations. ProfileAssociations []types.ProfileAssociation @@ -156,10 +158,11 @@ var _ ListProfileAssociationsAPIClient = (*Client)(nil) // ListProfileAssociationsPaginatorOptions is the paginator options for // ListProfileAssociations type ListProfileAssociationsPaginatorOptions struct { - // The maximum number of objects that you want to return for this request. If more - // objects are available, in the response, a NextToken value, which you can use in - // a subsequent call to get the next batch of objects, is provided. If you don't - // specify a value for MaxResults , up to 100 objects are returned. + // The maximum number of objects that you want to return for this request. If + // more objects are available, in the response, a NextToken value, which you can + // use in a subsequent call to get the next batch of objects, is provided. + // + // If you don't specify a value for MaxResults , up to 100 objects are returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53profiles/api_op_ListProfileResourceAssociations.go b/service/route53profiles/api_op_ListProfileResourceAssociations.go index fc737352cd0..4e9af03670b 100644 --- a/service/route53profiles/api_op_ListProfileResourceAssociations.go +++ b/service/route53profiles/api_op_ListProfileResourceAssociations.go @@ -29,25 +29,27 @@ func (c *Client) ListProfileResourceAssociations(ctx context.Context, params *Li type ListProfileResourceAssociationsInput struct { - // The ID of the Profile. + // The ID of the Profile. // // This member is required. ProfileId *string - // The maximum number of objects that you want to return for this request. If more - // objects are available, in the response, a NextToken value, which you can use in - // a subsequent call to get the next batch of objects, is provided. If you don't - // specify a value for MaxResults , up to 100 objects are returned. + // The maximum number of objects that you want to return for this request. If + // more objects are available, in the response, a NextToken value, which you can + // use in a subsequent call to get the next batch of objects, is provided. + // + // If you don't specify a value for MaxResults , up to 100 objects are returned. MaxResults *int32 - // For the first call to this list request, omit this value. When you request a - // list of objects, at most the number of objects specified by MaxResults is - // returned. If more objects are available for retrieval, a NextToken value is - // returned in the response. To retrieve the next batch of objects, use the token - // that was returned for the prior request in your next request. + // For the first call to this list request, omit this value. + // + // When you request a list of objects, at most the number of objects specified by + // MaxResults is returned. If more objects are available for retrieval, a NextToken + // value is returned 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 - // ID of a resource if you want information on only one type. + // ID of a resource if you want information on only one type. ResourceType *string noSmithyDocumentSerde @@ -55,13 +57,13 @@ type ListProfileResourceAssociationsInput struct { type ListProfileResourceAssociationsOutput struct { - // If more than MaxResults resource associations match the specified criteria, you - // can submit another ListProfileResourceAssociations request to get the next + // If more than MaxResults resource associations match the specified criteria, + // you can submit another ListProfileResourceAssociations request to get the next // group of results. In the next request, specify the value of NextToken from the // previous response. NextToken *string - // Information about the profile resource association that you specified in a + // Information about the profile resource association that you specified in a // GetProfileResourceAssociation request. ProfileResourceAssociations []types.ProfileResourceAssociation @@ -161,10 +163,11 @@ var _ ListProfileResourceAssociationsAPIClient = (*Client)(nil) // ListProfileResourceAssociationsPaginatorOptions is the paginator options for // ListProfileResourceAssociations type ListProfileResourceAssociationsPaginatorOptions struct { - // The maximum number of objects that you want to return for this request. If more - // objects are available, in the response, a NextToken value, which you can use in - // a subsequent call to get the next batch of objects, is provided. If you don't - // specify a value for MaxResults , up to 100 objects are returned. + // The maximum number of objects that you want to return for this request. If + // more objects are available, in the response, a NextToken value, which you can + // use in a subsequent call to get the next batch of objects, is provided. + // + // If you don't specify a value for MaxResults , up to 100 objects are returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53profiles/api_op_ListProfiles.go b/service/route53profiles/api_op_ListProfiles.go index cf81e10a2e0..2d7bcb07a90 100644 --- a/service/route53profiles/api_op_ListProfiles.go +++ b/service/route53profiles/api_op_ListProfiles.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all the Route 53 Profiles associated with your Amazon Web Services +// Lists all the Route 53 Profiles associated with your Amazon Web Services +// // account. func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, optFns ...func(*Options)) (*ListProfilesOutput, error) { if params == nil { @@ -30,17 +31,19 @@ func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, op type ListProfilesInput struct { - // The maximum number of objects that you want to return for this request. If more - // objects are available, in the response, a NextToken value, which you can use in - // a subsequent call to get the next batch of objects, is provided. If you don't - // specify a value for MaxResults , up to 100 objects are returned. + // The maximum number of objects that you want to return for this request. If + // more objects are available, in the response, a NextToken value, which you can + // use in a subsequent call to get the next batch of objects, is provided. + // + // If you don't specify a value for MaxResults , up to 100 objects are returned. MaxResults *int32 - // For the first call to this list request, omit this value. When you request a - // list of objects, at most the number of objects specified by MaxResults is - // returned. If more objects are available for retrieval, a NextToken value is - // returned in the response. To retrieve the next batch of objects, use the token - // that was returned for the prior request in your next request. + // For the first call to this list request, omit this value. + // + // When you request a list of objects, at most the number of objects specified by + // MaxResults is returned. If more objects are available for retrieval, a NextToken + // value is returned 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 noSmithyDocumentSerde @@ -48,12 +51,12 @@ type ListProfilesInput struct { type ListProfilesOutput struct { - // If more than MaxResults resource associations match the specified criteria, you - // can submit another ListProfiles request to get the next group of results. In - // the next request, specify the value of NextToken from the previous response. + // If more than MaxResults resource associations match the specified criteria, + // you can submit another ListProfiles request to get the next group of results. + // In the next request, specify the value of NextToken from the previous response. NextToken *string - // Summary information about the Profiles. + // Summary information about the Profiles. ProfileSummaries []types.ProfileSummary // Metadata pertaining to the operation's result. @@ -147,10 +150,11 @@ var _ ListProfilesAPIClient = (*Client)(nil) // ListProfilesPaginatorOptions is the paginator options for ListProfiles type ListProfilesPaginatorOptions struct { - // The maximum number of objects that you want to return for this request. If more - // objects are available, in the response, a NextToken value, which you can use in - // a subsequent call to get the next batch of objects, is provided. If you don't - // specify a value for MaxResults , up to 100 objects are returned. + // The maximum number of objects that you want to return for this request. If + // more objects are available, in the response, a NextToken value, which you can + // use in a subsequent call to get the next batch of objects, is provided. + // + // If you don't specify a value for MaxResults , up to 100 objects are returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/route53profiles/api_op_ListTagsForResource.go b/service/route53profiles/api_op_ListTagsForResource.go index a882a3a7d52..e90d3faae61 100644 --- a/service/route53profiles/api_op_ListTagsForResource.go +++ b/service/route53profiles/api_op_ListTagsForResource.go @@ -28,7 +28,7 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Resource Name (ARN) for the resource that you want to list the tags + // The Amazon Resource Name (ARN) for the resource that you want to list the tags // for. // // This member is required. @@ -39,7 +39,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags that are associated with the resource that you specified in the + // The tags that are associated with the resource that you specified in the // ListTagsForResource request. // // This member is required. diff --git a/service/route53profiles/api_op_TagResource.go b/service/route53profiles/api_op_TagResource.go index e0b7fd7d8d0..e3ad5ee2bcf 100644 --- a/service/route53profiles/api_op_TagResource.go +++ b/service/route53profiles/api_op_TagResource.go @@ -28,12 +28,12 @@ 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. + // The Amazon Resource Name (ARN) for the resource that you want to add tags to. // // This member is required. ResourceArn *string - // The tags that you want to add to the specified resource. + // The tags that you want to add to the specified resource. // // This member is required. Tags map[string]string diff --git a/service/route53profiles/api_op_UntagResource.go b/service/route53profiles/api_op_UntagResource.go index fb93b37ccd9..1b90697ef1c 100644 --- a/service/route53profiles/api_op_UntagResource.go +++ b/service/route53profiles/api_op_UntagResource.go @@ -28,13 +28,13 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Resource Name (ARN) for the resource that you want to remove tags + // The Amazon Resource Name (ARN) for the resource that you want to remove tags // from. // // This member is required. ResourceArn *string - // The tags that you want to remove to the specified resource. + // The tags that you want to remove to the specified resource. // // This member is required. TagKeys []string diff --git a/service/route53profiles/api_op_UpdateProfileResourceAssociation.go b/service/route53profiles/api_op_UpdateProfileResourceAssociation.go index 43549128a18..3f811f9f671 100644 --- a/service/route53profiles/api_op_UpdateProfileResourceAssociation.go +++ b/service/route53profiles/api_op_UpdateProfileResourceAssociation.go @@ -29,18 +29,19 @@ func (c *Client) UpdateProfileResourceAssociation(ctx context.Context, params *U type UpdateProfileResourceAssociationInput struct { - // ID of the resource association. + // ID of the resource association. // // This member is required. ProfileResourceAssociationId *string - // Name of the resource association. + // Name of the resource association. Name *string - // If you are adding a DNS Firewall rule group, include also a priority. The + // If you are adding a DNS Firewall rule group, include also a priority. The // priority indicates the processing order for the rule groups, starting with the - // priority assinged the lowest value. The allowed values for priority are between - // 100 and 9900. + // priority assinged the lowest value. + // + // The allowed values for priority are between 100 and 9900. ResourceProperties *string noSmithyDocumentSerde @@ -48,7 +49,7 @@ type UpdateProfileResourceAssociationInput struct { type UpdateProfileResourceAssociationOutput struct { - // Information about the UpdateProfileResourceAssociation request, including a + // Information about the UpdateProfileResourceAssociation request, including a // status message. ProfileResourceAssociation *types.ProfileResourceAssociation diff --git a/service/route53profiles/doc.go b/service/route53profiles/doc.go index ef677e9e95d..b271cd87fe3 100644 --- a/service/route53profiles/doc.go +++ b/service/route53profiles/doc.go @@ -3,6 +3,7 @@ // Package route53profiles provides the API client, operations, and parameter // types for Route 53 Profiles. // -// With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs +// With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs +// // and AWS accounts package route53profiles diff --git a/service/route53profiles/options.go b/service/route53profiles/options.go index 370d8364668..ef578ea0a5e 100644 --- a/service/route53profiles/options.go +++ b/service/route53profiles/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53profiles/types/enums.go b/service/route53profiles/types/enums.go index a9758d67ba8..31d22891d98 100644 --- a/service/route53profiles/types/enums.go +++ b/service/route53profiles/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ProfileStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfileStatus) Values() []ProfileStatus { return []ProfileStatus{ "COMPLETE", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for ShareStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatus) Values() []ShareStatus { return []ShareStatus{ "NOT_SHARED", diff --git a/service/route53profiles/types/errors.go b/service/route53profiles/types/errors.go index 5d34fb59bf1..7d5980655d9 100644 --- a/service/route53profiles/types/errors.go +++ b/service/route53profiles/types/errors.go @@ -7,7 +7,8 @@ import ( smithy "github.com/aws/smithy-go" ) -// The current account doesn't have the IAM permissions required to perform the +// The current account doesn't have the IAM permissions required to perform the +// // specified operation. type AccessDeniedException struct { Message *string diff --git a/service/route53profiles/types/types.go b/service/route53profiles/types/types.go index 46e49e0fd21..6aa95e6f765 100644 --- a/service/route53profiles/types/types.go +++ b/service/route53profiles/types/types.go @@ -10,36 +10,36 @@ import ( // A complex type that includes settings for a Route 53 Profile. type Profile struct { - // The Amazon Resource Name (ARN) of the Profile. + // The Amazon Resource Name (ARN) of the Profile. Arn *string - // The ClientToken value that was assigned when the Profile was created. + // The ClientToken value that was assigned when the Profile was created. ClientToken *string - // The date and time that the Profile was created, in Unix time format and + // The date and time that the Profile was created, in Unix time format and // Coordinated Universal Time (UTC). CreationTime *time.Time - // ID of the Profile. + // ID of the Profile. Id *string - // The date and time that the Profile was modified, in Unix time format and + // The date and time that the Profile was modified, in Unix time format and // Coordinated Universal Time (UTC). ModificationTime *time.Time - // Name of the Profile. + // Name of the Profile. Name *string - // Amazon Web Services account ID of the Profile owner. + // Amazon Web Services account ID of the Profile owner. OwnerId *string - // Sharing status for the Profile. + // Sharing status for the Profile. ShareStatus ShareStatus - // The status for the Profile. + // The status for the Profile. Status ProfileStatus - // Status message that includes additiona information about the Profile. + // Status message that includes additiona information about the Profile. StatusMessage *string noSmithyDocumentSerde @@ -48,33 +48,33 @@ type Profile struct { // An association between a Route 53 Profile and a VPC. type ProfileAssociation struct { - // The date and time that the Profile association was created, in Unix time format - // and Coordinated Universal Time (UTC). + // The date and time that the Profile association was created, in Unix time + // format and Coordinated Universal Time (UTC). CreationTime *time.Time - // ID of the Profile association. + // ID of the Profile association. Id *string - // The date and time that the Profile association was modified, in Unix time + // The date and time that the Profile association was modified, in Unix time // format and Coordinated Universal Time (UTC). ModificationTime *time.Time - // Name of the Profile association. + // Name of the Profile association. Name *string - // Amazon Web Services account ID of the Profile association owner. + // Amazon Web Services account ID of the Profile association owner. OwnerId *string - // ID of the Profile. + // ID of the Profile. ProfileId *string - // The Amazon Resource Name (ARN) of the VPC. + // The Amazon Resource Name (ARN) of the VPC. ResourceId *string - // Status of the Profile association. + // Status of the Profile association. Status ProfileStatus - // Additional information about the Profile association. + // Additional information about the Profile association. StatusMessage *string noSmithyDocumentSerde @@ -83,39 +83,39 @@ type ProfileAssociation struct { // The association between a Route 53 Profile and resources. type ProfileResourceAssociation struct { - // The date and time that the Profile resource association was created, in Unix + // The date and time that the Profile resource association was created, in Unix // time format and Coordinated Universal Time (UTC). CreationTime *time.Time - // ID of the Profile resource association. + // ID of the Profile resource association. Id *string - // The date and time that the Profile resource association was modified, in Unix + // The date and time that the Profile resource association was modified, in Unix // time format and Coordinated Universal Time (UTC). ModificationTime *time.Time - // Name of the Profile resource association. + // Name of the Profile resource association. Name *string - // Amazon Web Services account ID of the Profile resource association owner. + // Amazon Web Services account ID of the Profile resource association owner. OwnerId *string - // Profile ID of the Profile that the resources are associated with. + // Profile ID of the Profile that the resources are associated with. ProfileId *string - // The Amazon Resource Name (ARN) of the resource association. + // The Amazon Resource Name (ARN) of the resource association. ResourceArn *string - // If the DNS resource is a DNS Firewall rule group, this indicates the priority. + // If the DNS resource is a DNS Firewall rule group, this indicates the priority. ResourceProperties *string - // Resource type, such as a private hosted zone, or DNS Firewall rule group. + // Resource type, such as a private hosted zone, or DNS Firewall rule group. ResourceType *string - // Status of the Profile resource association. + // Status of the Profile resource association. Status ProfileStatus - // Additional information about the Profile resource association. + // Additional information about the Profile resource association. StatusMessage *string noSmithyDocumentSerde @@ -124,16 +124,16 @@ type ProfileResourceAssociation struct { // Summary information about a Route 53 Profile. type ProfileSummary struct { - // The Amazon Resource Name (ARN) of the Profile. + // The Amazon Resource Name (ARN) of the Profile. Arn *string - // ID of the Profile. + // ID of the Profile. Id *string - // Name of the Profile. + // Name of the Profile. Name *string - // Share status of the Profile. + // Share status of the Profile. ShareStatus ShareStatus noSmithyDocumentSerde @@ -142,12 +142,12 @@ type ProfileSummary struct { // Tag for the Profile. type Tag struct { - // Key associated with the Tag . + // Key associated with the Tag . // // This member is required. Key *string - // Value for the Tag. + // Value for the Tag. // // This member is required. Value *string diff --git a/service/route53recoverycluster/api_op_GetRoutingControlState.go b/service/route53recoverycluster/api_op_GetRoutingControlState.go index 870dcd82170..e59b4184529 100644 --- a/service/route53recoverycluster/api_op_GetRoutingControlState.go +++ b/service/route53recoverycluster/api_op_GetRoutingControlState.go @@ -14,21 +14,32 @@ import ( // 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 set to ON, traffic flows to a cell. When the state is set to 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 +// 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]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) -// 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) +// 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]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] +// +// [Working with routing controls in Route 53 ARC] +// +// [API examples]: https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html +// [Working with routing controls in Route 53 ARC]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html +// [Create routing control structures]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html +// [Viewing and updating routing control states]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.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 b69b09d1484..37da25244b1 100644 --- a/service/route53recoverycluster/api_op_ListRoutingControls.go +++ b/service/route53recoverycluster/api_op_ListRoutingControls.go @@ -15,21 +15,31 @@ import ( // routing control state for each routing control, along with the control panel // name and control panel ARN for the routing controls. If you specify a control // panel ARN, this call lists the routing controls in the control panel. Otherwise, -// it lists all the routing controls in the cluster. A routing control is a simple -// on/off switch in Route 53 ARC that you can use to route traffic to cells. When a -// routing control state is set to ON, traffic flows to a cell. When the state is -// set to 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 +// it lists all the routing controls in the cluster. +// +// A routing control is a simple on/off switch in Route 53 ARC that you can use to +// route traffic to cells. When a routing control state is set to ON, traffic flows +// to a cell. When the state is set to 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]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 use this API operation to -// 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) +// state to redirect traffic for your application. +// +// You must specify Regional endpoints when you work with API cluster operations +// to use this API operation to 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] +// +// [Working with routing controls in Route 53 ARC] +// +// [Working with routing controls in Route 53 ARC]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html +// [Create routing control structures]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html +// [Viewing and updating routing control states]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html func (c *Client) ListRoutingControls(ctx context.Context, params *ListRoutingControlsInput, optFns ...func(*Options)) (*ListRoutingControlsOutput, error) { if params == nil { params = &ListRoutingControlsInput{} diff --git a/service/route53recoverycluster/api_op_UpdateRoutingControlState.go b/service/route53recoverycluster/api_op_UpdateRoutingControlState.go index f23b1df64c7..bff1a68f420 100644 --- a/service/route53recoverycluster/api_op_UpdateRoutingControlState.go +++ b/service/route53recoverycluster/api_op_UpdateRoutingControlState.go @@ -13,26 +13,37 @@ import ( // Set the state of the routing control to reroute traffic. You can set the value // to ON or OFF. When the state is ON, traffic flows to a cell. When the state is -// OFF, traffic does not flow. With Route 53 ARC, you can add safety rules for -// routing controls, which are safeguards for routing control state updates that -// help prevent unexpected outcomes, like fail open traffic routing. However, there -// are scenarios when you might want to bypass the routing control safeguards that -// are enforced with safety rules that you've configured. For example, you might -// want to fail over quickly for disaster recovery, and one or more safety rules -// 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) -// 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) -// 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) +// OFF, traffic does not flow. +// +// With Route 53 ARC, you can add safety rules for routing controls, which are +// safeguards for routing control state updates that help prevent unexpected +// outcomes, like fail open traffic routing. However, there are scenarios when you +// might want to bypass the routing control safeguards that are enforced with +// safety rules that you've configured. For example, you might want to fail over +// quickly for disaster recovery, and one or more safety rules 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]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]in the Amazon Route 53 Application +// Recovery Controller Developer Guide. +// +// [Viewing and updating routing control states] +// +// [Working with routing controls overall] +// +// [API examples]: https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html +// [Viewing and updating routing control states]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html +// [Override safety rules to reroute traffic]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.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{} @@ -64,8 +75,12 @@ 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) - // in the Amazon Route 53 Application Recovery Controller Developer Guide. + // commas. + // + // For more information, see [Override safety rules to reroute traffic] in the Amazon Route 53 Application Recovery + // Controller Developer Guide. + // + // [Override safety rules to reroute traffic]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html SafetyRulesToOverride []string noSmithyDocumentSerde diff --git a/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go b/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go index 2d5d9013e1d..b065bcd210f 100644 --- a/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go +++ b/service/route53recoverycluster/api_op_UpdateRoutingControlStates.go @@ -13,26 +13,37 @@ import ( // Set multiple routing control states. You can set the value for each state to be // ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic -// does not flow. With Route 53 ARC, you can add safety rules for routing controls, -// which are safeguards for routing control state updates that help prevent -// unexpected outcomes, like fail open traffic routing. However, there are -// scenarios when you might want to bypass the routing control safeguards that are -// enforced with safety rules that you've configured. For example, you might want -// to fail over quickly for disaster recovery, and one or more safety rules might -// be unexpectedly preventing you from updating a routing control state to reroute +// does not flow. +// +// With Route 53 ARC, you can add safety rules for routing controls, which are +// safeguards for routing control state updates that help prevent unexpected +// outcomes, like fail open traffic routing. However, there are scenarios when you +// might want to bypass the routing control safeguards that are enforced with +// safety rules that you've configured. For example, you might want to fail over +// quickly for disaster recovery, and one or more safety rules 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) -// 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) -// 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) +// rules and update routing control states. For more information, see [Override safety rules to reroute traffic]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]in the Amazon Route 53 Application +// Recovery Controller Developer Guide. +// +// [Viewing and updating routing control states] +// +// [Working with routing controls overall] +// +// [API examples]: https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html +// [Viewing and updating routing control states]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html +// [Override safety rules to reroute traffic]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.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{} @@ -57,9 +68,12 @@ 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) - // in the Amazon Route 53 Application Recovery Controller Developer Guide. + // multiple safety rules by including one or more ARNs, separated by commas. + // + // For more information, see [Override safety rules to reroute traffic] in the Amazon Route 53 Application Recovery + // Controller Developer Guide. + // + // [Override safety rules to reroute traffic]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html SafetyRulesToOverride []string noSmithyDocumentSerde diff --git a/service/route53recoverycluster/doc.go b/service/route53recoverycluster/doc.go index 9e52f5a515c..335221fbd9d 100644 --- a/service/route53recoverycluster/doc.go +++ b/service/route53recoverycluster/doc.go @@ -4,43 +4,51 @@ // 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 to ON and another -// one to 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 -// ARC, you must first create the required components (clusters, control panels, -// and routing controls) using the recovery cluster configuration API. For more -// information about working with routing control in Route 53 ARC, see the -// following: +// 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 to ON and another one to 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]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 ARC, you must first create the required components (clusters, control +// panels, 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/) -// . +// operations. For more information, see the [Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller]. +// // - 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. +// Web Services console. For more information, see [Recovery control components]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/) -// . +// see the [Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller]. +// // - 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/) -// . +// for recovery readiness with Route 53 ARC, see the [Amazon Route 53 Application Recovery Controller Developer Guide]. +// +// [Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller]: https://docs.aws.amazon.com/recovery-readiness/latest/api/ +// [Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller]: https://docs.aws.amazon.com/recovery-cluster/latest/api/ +// [Recovery control components]: https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing +// [Amazon Route 53 Application Recovery Controller Developer Guide]: https://docs.aws.amazon.com/r53recovery/latest/dg/ +// [Get and update routing control states using the API]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html package route53recoverycluster diff --git a/service/route53recoverycluster/options.go b/service/route53recoverycluster/options.go index dbb94a43fca..b969edfc2ad 100644 --- a/service/route53recoverycluster/options.go +++ b/service/route53recoverycluster/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53recoverycluster/types/enums.go b/service/route53recoverycluster/types/enums.go index d509fcfdf1e..4454858a918 100644 --- a/service/route53recoverycluster/types/enums.go +++ b/service/route53recoverycluster/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for RoutingControlState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoutingControlState) Values() []RoutingControlState { return []RoutingControlState{ "On", @@ -32,6 +33,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/route53recoverycontrolconfig/api_op_CreateRoutingControl.go b/service/route53recoverycontrolconfig/api_op_CreateRoutingControl.go index 9f6a3ba8caf..0431a24f0ab 100644 --- a/service/route53recoverycontrolconfig/api_op_CreateRoutingControl.go +++ b/service/route53recoverycontrolconfig/api_op_CreateRoutingControl.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new routing control. A routing control has one of two states: ON and -// OFF. You can map the routing control state to the state of an Amazon Route 53 -// health check, which can be used to control traffic routing. To get or update the -// routing control state, see the Recovery Cluster (data plane) API actions for -// Amazon Route 53 Application Recovery Controller. +// Creates a new routing control. +// +// A routing control has one of two states: ON and OFF. You can map the routing +// control state to the state of an Amazon Route 53 health check, which can be used +// to control traffic routing. +// +// To get or update the routing control state, see the Recovery Cluster (data +// plane) API actions for Amazon Route 53 Application Recovery Controller. func (c *Client) CreateRoutingControl(ctx context.Context, params *CreateRoutingControlInput, optFns ...func(*Options)) (*CreateRoutingControlOutput, error) { if params == nil { params = &CreateRoutingControlInput{} diff --git a/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go b/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go index 49b7234b6d2..e248266e3ae 100644 --- a/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go +++ b/service/route53recoverycontrolconfig/api_op_CreateSafetyRule.go @@ -13,17 +13,25 @@ import ( // Creates a safety rule in a control panel. Safety rules let you add safeguards // around changing routing control states, and for enabling and disabling routing -// controls, to help prevent unexpected outcomes. There are two types of safety -// rules: assertion rules and gating rules. Assertion rule: An assertion rule -// enforces that, when you change a routing control state, that a certain criteria -// is met. For example, the criteria might be that at least one routing control -// state is On after the transaction so that traffic continues to flow to at least -// one cell for the application. This ensures that you avoid a fail-open scenario. +// controls, to help prevent unexpected outcomes. +// +// There are two types of safety rules: assertion rules and gating rules. +// +// Assertion rule: An assertion rule enforces that, when you change a routing +// control state, that a certain criteria is met. For example, the criteria might +// be that at least one routing control state is On after the transaction so that +// traffic continues to flow to at least one cell for the application. This ensures +// that you avoid a fail-open scenario. +// // 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) -// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// routing controls. +// +// For more information, see [Safety rules] in the Amazon Route 53 Application Recovery +// Controller Developer Guide. +// +// [Safety rules]: https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html func (c *Client) CreateSafetyRule(ctx context.Context, params *CreateSafetyRuleInput, optFns ...func(*Options)) (*CreateSafetyRuleOutput, error) { if params == nil { params = &CreateSafetyRuleInput{} diff --git a/service/route53recoverycontrolconfig/api_op_DeleteSafetyRule.go b/service/route53recoverycontrolconfig/api_op_DeleteSafetyRule.go index 10ced639454..1832b7f5ff0 100644 --- a/service/route53recoverycontrolconfig/api_op_DeleteSafetyRule.go +++ b/service/route53recoverycontrolconfig/api_op_DeleteSafetyRule.go @@ -10,7 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a safety rule./> +// Deletes a safety rule. +// +// /> func (c *Client) DeleteSafetyRule(ctx context.Context, params *DeleteSafetyRuleInput, optFns ...func(*Options)) (*DeleteSafetyRuleOutput, error) { if params == nil { params = &DeleteSafetyRuleInput{} diff --git a/service/route53recoverycontrolconfig/api_op_DescribeCluster.go b/service/route53recoverycontrolconfig/api_op_DescribeCluster.go index 66d472fd076..7b1afae0d33 100644 --- a/service/route53recoverycontrolconfig/api_op_DescribeCluster.go +++ b/service/route53recoverycontrolconfig/api_op_DescribeCluster.go @@ -173,12 +173,13 @@ type ClusterCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) } @@ -369,12 +370,13 @@ type ClusterDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeClusterInput, *DescribeClusterOutput, error) (bool, error) } diff --git a/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go b/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go index 399e34d84ef..5c77b1af5f3 100644 --- a/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go +++ b/service/route53recoverycontrolconfig/api_op_DescribeControlPanel.go @@ -174,12 +174,13 @@ type ControlPanelCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeControlPanelInput, *DescribeControlPanelOutput, error) (bool, error) } @@ -372,12 +373,13 @@ type ControlPanelDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeControlPanelInput, *DescribeControlPanelOutput, error) (bool, error) } diff --git a/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go b/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go index c4874013531..566c0481d79 100644 --- a/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go +++ b/service/route53recoverycontrolconfig/api_op_DescribeRoutingControl.go @@ -18,9 +18,10 @@ import ( // Displays details about a routing control. A routing control has one of two // states: ON and OFF. You can map the routing control state to the state of an -// Amazon Route 53 health check, which can be used to control routing. To get or -// update the routing control state, see the Recovery Cluster (data plane) API -// actions for Amazon Route 53 Application Recovery Controller. +// Amazon Route 53 health check, which can be used to control routing. +// +// To get or update the routing control state, see the Recovery Cluster (data +// plane) API actions for Amazon Route 53 Application Recovery Controller. func (c *Client) DescribeRoutingControl(ctx context.Context, params *DescribeRoutingControlInput, optFns ...func(*Options)) (*DescribeRoutingControlOutput, error) { if params == nil { params = &DescribeRoutingControlInput{} @@ -178,12 +179,13 @@ type RoutingControlCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeRoutingControlInput, *DescribeRoutingControlOutput, error) (bool, error) } @@ -376,12 +378,13 @@ type RoutingControlDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeRoutingControlInput, *DescribeRoutingControlOutput, error) (bool, error) } diff --git a/service/route53recoverycontrolconfig/options.go b/service/route53recoverycontrolconfig/options.go index 91ab9e43013..351648445fd 100644 --- a/service/route53recoverycontrolconfig/options.go +++ b/service/route53recoverycontrolconfig/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53recoverycontrolconfig/types/enums.go b/service/route53recoverycontrolconfig/types/enums.go index bc91a005d1b..4de69302a9c 100644 --- a/service/route53recoverycontrolconfig/types/enums.go +++ b/service/route53recoverycontrolconfig/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for RuleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleType) Values() []RuleType { return []RuleType{ "ATLEAST", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "PENDING", diff --git a/service/route53recoverycontrolconfig/types/types.go b/service/route53recoverycontrolconfig/types/types.go index 7ae21a1be83..75d8cfa276b 100644 --- a/service/route53recoverycontrolconfig/types/types.go +++ b/service/route53recoverycontrolconfig/types/types.go @@ -102,9 +102,10 @@ type Cluster struct { ClusterArn *string // Endpoints for a cluster. Specify one of these endpoints when you want to set or - // retrieve a routing control state in the cluster. To get or update the routing - // control state, see the Amazon Route 53 Application Recovery Controller Routing - // Control Actions. + // retrieve a routing control state in the cluster. + // + // To get or update the routing control state, see the Amazon Route 53 Application + // Recovery Controller Routing Control Actions. ClusterEndpoints []ClusterEndpoint // The name of the cluster. @@ -125,9 +126,10 @@ type Cluster struct { type ClusterEndpoint struct { // A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you - // want to set or retrieve a routing control state in the cluster. To get or update - // the routing control state, see the Amazon Route 53 Application Recovery - // Controller Routing Control Actions. + // want to set or retrieve a routing control state in the cluster. + // + // To get or update the routing control state, see the Amazon Route 53 Application + // Recovery Controller Routing Control Actions. Endpoint *string // The Amazon Web Services Region for a cluster endpoint. @@ -172,12 +174,14 @@ type ControlPanel struct { // A gating rule verifies that a gating routing control or set of gating routing // controls, evaluates as true, based on a rule configuration that you specify, -// which allows a set of routing control state changes to complete. For example, if -// you specify one gating routing control and you set the Type in the rule -// configuration to OR, that indicates that you must set the gating routing control -// to On for the rule to evaluate as true; that is, for the gating control "switch" -// to be "On". When you do that, then you can update the routing control states for -// the target routing controls that you specify in the gating rule. +// which allows a set of routing control state changes to complete. +// +// For example, if you specify one gating routing control and you set the Type in +// the rule configuration to OR, that indicates that you must set the gating +// routing control to On for the rule to evaluate as true; that is, for the gating +// control "switch" to be "On". When you do that, then you can update the routing +// control states for the target routing controls that you specify in the gating +// rule. type GatingRule struct { // The Amazon Resource Name (ARN) of the control panel. @@ -338,9 +342,11 @@ type NewGatingRule struct { // three gating controls, one for each of three Amazon Web Services Regions. Now // you specify ATLEAST 2 as your RuleConfig. With these settings, you can only // change (set or unset) the routing controls that you have specified as - // TargetControls if that rule evaluates to true. In other words, your ability to - // change the routing controls that you have specified as TargetControls is gated - // by the rule that you set for the routing controls in GatingControls. + // TargetControls if that rule evaluates to true. + // + // In other words, your ability to change the routing controls that you have + // specified as TargetControls is gated by the rule that you set for the routing + // controls in GatingControls. // // This member is required. TargetControls []string @@ -393,12 +399,14 @@ type Rule struct { // A gating rule verifies that a gating routing control or set of gating routing // controls, evaluates as true, based on a rule configuration that you specify, - // which allows a set of routing control state changes to complete. For example, if - // you specify one gating routing control and you set the Type in the rule - // configuration to OR, that indicates that you must set the gating routing control - // to On for the rule to evaluate as true; that is, for the gating control "switch" - // to be "On". When you do that, then you can update the routing control states for - // the target routing controls that you specify in the gating rule. + // which allows a set of routing control state changes to complete. + // + // For example, if you specify one gating routing control and you set the Type in + // the rule configuration to OR, that indicates that you must set the gating + // routing control to On for the rule to evaluate as true; that is, for the gating + // control "switch" to be "On". When you do that, then you can update the routing + // control states for the target routing controls that you specify in the gating + // rule. GATING *GatingRule noSmithyDocumentSerde diff --git a/service/route53recoveryreadiness/api_op_CreateResourceSet.go b/service/route53recoveryreadiness/api_op_CreateResourceSet.go index a678006c88d..337484e02b9 100644 --- a/service/route53recoveryreadiness/api_op_CreateResourceSet.go +++ b/service/route53recoveryreadiness/api_op_CreateResourceSet.go @@ -37,10 +37,12 @@ type CreateResourceSetInput struct { ResourceSetName *string // The resource type of the resources in the resource set. Enter one of the - // following values for resource type: AWS::ApiGateway::Stage, - // AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, - // AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, - // AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, + // following values for resource type: + // + // AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, + // AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, + // AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, + // AWS::ElasticLoadBalancing::LoadBalancer, // AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, // AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, // AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, @@ -70,10 +72,12 @@ type CreateResourceSetOutput struct { ResourceSetName *string // The resource type of the resources in the resource set. Enter one of the - // following values for resource type: AWS::ApiGateway::Stage, - // AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, - // AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, - // AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, + // following values for resource type: + // + // AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, + // AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, + // AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, + // AWS::ElasticLoadBalancing::LoadBalancer, // AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, // AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, // AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, diff --git a/service/route53recoveryreadiness/api_op_GetResourceSet.go b/service/route53recoveryreadiness/api_op_GetResourceSet.go index b1b31ee046b..ece75a37e02 100644 --- a/service/route53recoveryreadiness/api_op_GetResourceSet.go +++ b/service/route53recoveryreadiness/api_op_GetResourceSet.go @@ -47,10 +47,12 @@ type GetResourceSetOutput struct { ResourceSetName *string // The resource type of the resources in the resource set. Enter one of the - // following values for resource type: AWS::ApiGateway::Stage, - // AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, - // AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, - // AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, + // following values for resource type: + // + // AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, + // AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, + // AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, + // AWS::ElasticLoadBalancing::LoadBalancer, // AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, // AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, // AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, diff --git a/service/route53recoveryreadiness/api_op_UpdateResourceSet.go b/service/route53recoveryreadiness/api_op_UpdateResourceSet.go index 127ae747a57..a1ca5a12361 100644 --- a/service/route53recoveryreadiness/api_op_UpdateResourceSet.go +++ b/service/route53recoveryreadiness/api_op_UpdateResourceSet.go @@ -36,10 +36,12 @@ type UpdateResourceSetInput struct { ResourceSetName *string // The resource type of the resources in the resource set. Enter one of the - // following values for resource type: AWS::ApiGateway::Stage, - // AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, - // AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, - // AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, + // following values for resource type: + // + // AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, + // AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, + // AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, + // AWS::ElasticLoadBalancing::LoadBalancer, // AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, // AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, // AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, @@ -66,10 +68,12 @@ type UpdateResourceSetOutput struct { ResourceSetName *string // The resource type of the resources in the resource set. Enter one of the - // following values for resource type: AWS::ApiGateway::Stage, - // AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, - // AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, - // AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, + // following values for resource type: + // + // AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, + // AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, + // AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, + // AWS::ElasticLoadBalancing::LoadBalancer, // AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, // AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, // AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, diff --git a/service/route53recoveryreadiness/options.go b/service/route53recoveryreadiness/options.go index 6c7b56f881b..5b9bf96fb6a 100644 --- a/service/route53recoveryreadiness/options.go +++ b/service/route53recoveryreadiness/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53recoveryreadiness/types/enums.go b/service/route53recoveryreadiness/types/enums.go index f80f23cd6b3..c355d5932d9 100644 --- a/service/route53recoveryreadiness/types/enums.go +++ b/service/route53recoveryreadiness/types/enums.go @@ -13,8 +13,9 @@ const ( ) // 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. +// in the future, and so 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 e48d372d632..b93e10cb6f2 100644 --- a/service/route53recoveryreadiness/types/types.go +++ b/service/route53recoveryreadiness/types/types.go @@ -244,10 +244,12 @@ type ResourceSetOutput struct { ResourceSetName *string // The resource type of the resources in the resource set. Enter one of the - // following values for resource type: AWS::ApiGateway::Stage, - // AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, - // AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, - // AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, + // following values for resource type: + // + // AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, + // AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, + // AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, + // AWS::ElasticLoadBalancing::LoadBalancer, // AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, // AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, // AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, diff --git a/service/route53resolver/api_op_AssociateFirewallRuleGroup.go b/service/route53resolver/api_op_AssociateFirewallRuleGroup.go index 3e1248cb9be..b153fcf3aa9 100644 --- a/service/route53resolver/api_op_AssociateFirewallRuleGroup.go +++ b/service/route53resolver/api_op_AssociateFirewallRuleGroup.go @@ -49,16 +49,19 @@ type AssociateFirewallRuleGroupInput struct { // The setting that determines the processing order of the rule group among the // rule groups that you associate with the specified VPC. DNS Firewall filters VPC // traffic starting from the rule group with the lowest numeric priority setting. - // You must specify a unique priority for each rule group that you associate with a - // single VPC. To make it easier to insert rule groups later, leave space between + // + // You must specify a unique priority for each rule group that you associate with + // a single VPC. To make it easier to insert rule groups later, leave space between // the numbers, for example, use 101, 200, and so on. You can change the priority - // setting for a rule group association after you create it. The allowed values for - // Priority are between 100 and 9900. + // setting for a rule group association after you create it. + // + // The allowed values for Priority are between 100 and 9900. // // This member is required. Priority *int32 - // The unique identifier of the VPC that you want to associate with the rule group. + // The unique identifier of the VPC that you want to associate with the rule + // group. // // This member is required. VpcId *string diff --git a/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go b/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go index 3288290dca0..37ed26c9cb8 100644 --- a/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go +++ b/service/route53resolver/api_op_AssociateResolverEndpointIpAddress.go @@ -13,9 +13,11 @@ import ( // 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) -// . +// request for each IP address. +// +// To remove an IP address from an endpoint, see [DisassociateResolverEndpointIpAddress]. +// +// [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 fc82eae5678..f243322c5a1 100644 --- a/service/route53resolver/api_op_AssociateResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_AssociateResolverQueryLogConfig.go @@ -15,10 +15,14 @@ import ( // 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) -// . +// 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]. +// +// [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{} @@ -42,8 +46,9 @@ type AssociateResolverQueryLogConfigInput struct { ResolverQueryLogConfigId *string // The ID of an Amazon VPC that you want this query logging configuration to log - // queries for. The VPCs and the query logging configuration must be in the same - // Region. + // queries for. + // + // The VPCs and the query logging configuration must be in the same Region. // // This member is required. ResourceId *string diff --git a/service/route53resolver/api_op_AssociateResolverRule.go b/service/route53resolver/api_op_AssociateResolverRule.go index 1dead5543e8..f47771643a5 100644 --- a/service/route53resolver/api_op_AssociateResolverRule.go +++ b/service/route53resolver/api_op_AssociateResolverRule.go @@ -15,8 +15,9 @@ 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]. +// +// [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{} @@ -35,8 +36,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 existing Resolver rules, use [ListResolverRules]. + // + // [ListResolverRules]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html // // This member is required. ResolverRuleId *string diff --git a/service/route53resolver/api_op_CreateFirewallDomainList.go b/service/route53resolver/api_op_CreateFirewallDomainList.go index e62d14f431c..56cb211220c 100644 --- a/service/route53resolver/api_op_CreateFirewallDomainList.go +++ b/service/route53resolver/api_op_CreateFirewallDomainList.go @@ -12,8 +12,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 55f7b54a7f6..4e9183cf850 100644 --- a/service/route53resolver/api_op_CreateFirewallRule.go +++ b/service/route53resolver/api_op_CreateFirewallRule.go @@ -32,8 +32,11 @@ 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 . // @@ -65,69 +68,96 @@ type CreateFirewallRuleInput struct { // The setting that determines the processing order of the rule in the rule group. // DNS Firewall processes the rules in a rule group by order of priority, starting - // from the lowest setting. You must specify a unique priority for each rule in a - // rule group. To make it easier to insert rules later, leave space between the - // numbers, for example, use 100, 200, and so on. You can change the priority - // setting for the rules in a rule group at any time. + // from the lowest setting. + // + // You must specify a unique priority for each rule in a rule group. To make it + // easier to insert rules later, leave space between the numbers, for example, use + // 100, 200, and so on. You can change the priority setting for the rules in a rule + // group at any time. // // This member is required. 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 . + // 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 . BlockResponse types.BlockResponse - // How you want the the rule to evaluate DNS redirection in the DNS redirection - // chain, such as CNAME, DNAME, ot ALIAS. Inspect_Redirection_Domain (Default) - // inspects all domains in the redirection chain. The individual domains in the - // redirection chain must be added to the allow domain list. - // Trust_Redirection_Domain inspects only the first domain in the redirection + // How you want the the rule to evaluate DNS redirection in the DNS redirection + // chain, such as CNAME, DNAME, ot ALIAS. + // + // Inspect_Redirection_Domain (Default) inspects all domains in the redirection + // chain. The individual domains in the redirection chain must be added to the + // allow domain list. + // + // Trust_Redirection_Domain inspects only the first domain in the redirection // chain. You don't need to add the subsequent domains in the redirection list to // the domain alloww list. FirewallDomainRedirectionAction types.FirewallDomainRedirectionAction - // The DNS query type you want the rule to evaluate. Allowed values are; + // The DNS query type you want the rule to evaluate. Allowed values are; + // // - A: Returns an IPv4 address. + // // - AAAA: Returns an Ipv6 address. + // // - CAA: Restricts CAs that can create SSL/TLS certifications for the domain. + // // - CNAME: Returns another domain name. + // // - DS: Record that identifies the DNSSEC signing key of a delegated zone. + // // - MX: Specifies mail servers. + // // - NAPTR: Regular-expression-based rewriting of domain names. + // // - NS: Authoritative name servers. + // // - PTR: Maps an IP address to a domain name. + // // - SOA: Start of authority record for the zone. + // // - SPF: Lists the servers authorized to send emails from a domain. + // // - SRV: Application specific values that identify servers. + // // - TXT: Verifies email senders and application-specific values. + // // - A query type you define by using the DNS type ID, for example 28 for AAAA. // The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for - // example, TYPE28. For more information, see List of DNS record types (https://en.wikipedia.org/wiki/List_of_DNS_record_types) - // . + // example, TYPE28. For more information, see [List of DNS record types]. + // + // [List of DNS record types]: https://en.wikipedia.org/wiki/List_of_DNS_record_types Qtype *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_CreateFirewallRuleGroup.go b/service/route53resolver/api_op_CreateFirewallRuleGroup.go index f84e69ac66e..f4a78a070f3 100644 --- a/service/route53resolver/api_op_CreateFirewallRuleGroup.go +++ b/service/route53resolver/api_op_CreateFirewallRuleGroup.go @@ -12,7 +12,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{} diff --git a/service/route53resolver/api_op_CreateOutpostResolver.go b/service/route53resolver/api_op_CreateOutpostResolver.go index 04161af7b7f..326b6ee03dd 100644 --- a/service/route53resolver/api_op_CreateOutpostResolver.go +++ b/service/route53resolver/api_op_CreateOutpostResolver.go @@ -30,8 +30,9 @@ func (c *Client) CreateOutpostResolver(ctx context.Context, params *CreateOutpos type CreateOutpostResolverInput 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 @@ -48,7 +49,7 @@ type CreateOutpostResolverInput struct { // This member is required. OutpostArn *string - // The Amazon EC2 instance type. If you specify this, you must also specify a + // The Amazon EC2 instance type. If you specify this, you must also specify a // value for the OutpostArn . // // This member is required. @@ -58,7 +59,7 @@ type CreateOutpostResolverInput struct { // minimal value is 4. InstanceCount *int32 - // A string that helps identify the Route 53 Resolvers on Outpost. + // A string that helps identify the Route 53 Resolvers on Outpost. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_CreateResolverEndpoint.go b/service/route53resolver/api_op_CreateResolverEndpoint.go index cd07a478846..caf8379ee73 100644 --- a/service/route53resolver/api_op_CreateResolverEndpoint.go +++ b/service/route53resolver/api_op_CreateResolverEndpoint.go @@ -13,8 +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. func (c *Client) CreateResolverEndpoint(ctx context.Context, params *CreateResolverEndpointInput, optFns ...func(*Options)) (*CreateResolverEndpointOutput, error) { @@ -42,8 +44,10 @@ type CreateResolverEndpointInput struct { 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 // @@ -52,8 +56,9 @@ type CreateResolverEndpointInput struct { // The subnets and IP addresses in your VPC that DNS queries originate from (for // outbound endpoints) or that you forward DNS queries to (for inbound endpoints). - // The subnet ID uniquely identifies a VPC. Even though the minimum is 1, Route 53 - // requires that you create at least two. + // The subnet ID uniquely identifies a VPC. + // + // Even though the minimum is 1, Route 53 requires that you create at least two. // // This member is required. IpAddresses []types.IpAddressRequest @@ -63,13 +68,16 @@ type CreateResolverEndpointInput struct { // rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver // endpoints). Inbound and outbound rules must allow TCP and UDP access. For // inbound access, open port 53. For outbound access, open the port that you're - // using for DNS queries on your network. Some security group rules will cause your - // connection to be tracked. For outbound resolver endpoint, it can potentially - // impact the maximum queries per second from outbound endpoint to your target name - // server. For inbound resolver endpoint, it can bring down the overall maximum - // queries per second per IP address to as low as 1500. To avoid connection - // tracking caused by security group, see Untracked connections (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#untracked-connectionsl) - // . + // using for DNS queries on your network. + // + // Some security group rules will cause your connection to be tracked. For + // outbound resolver endpoint, it can potentially impact the maximum queries per + // second from outbound endpoint to your target name server. For inbound resolver + // endpoint, it can bring down the overall maximum queries per second per IP + // address to as low as 1500. To avoid connection tracking caused by security + // group, see [Untracked connections]. + // + // [Untracked connections]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#untracked-connectionsl // // This member is required. SecurityGroupIds []string @@ -86,23 +94,35 @@ type CreateResolverEndpointInput struct { // OutpostArn . PreferredInstanceType *string - // The protocols you want to use for the endpoint. DoH-FIPS is applicable for - // inbound endpoints only. For an inbound endpoint you can apply the protocols as - // follows: + // The protocols you want to use for the endpoint. DoH-FIPS is applicable for + // inbound endpoints only. + // + // For an inbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 and DoH-FIPS in combination. + // // - Do53 alone. + // // - DoH alone. + // // - DoH-FIPS alone. + // // - None, which is treated as Do53. + // // For an outbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 alone. + // // - DoH alone. + // // - None, which is treated as Do53. Protocols []types.Protocol - // For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A + // For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A // dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This // endpoint type is applied to all IP addresses. ResolverEndpointType types.ResolverEndpointType diff --git a/service/route53resolver/api_op_CreateResolverQueryLogConfig.go b/service/route53resolver/api_op_CreateResolverQueryLogConfig.go index 9da9046fcb4..456ef32d37d 100644 --- a/service/route53resolver/api_op_CreateResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_CreateResolverQueryLogConfig.go @@ -14,14 +14,18 @@ import ( // Creates a Resolver query logging configuration, which defines where you want // 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 +// configuration. +// +// To specify which VPCs you want to log queries for, you use +// AssociateResolverQueryLogConfig . For more information, see [AssociateResolverQueryLogConfig]. +// +// 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 // associated with the configuration. +// +// [AssociateResolverQueryLogConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html func (c *Client) CreateResolverQueryLogConfig(ctx context.Context, params *CreateResolverQueryLogConfigInput, optFns ...func(*Options)) (*CreateResolverQueryLogConfigOutput, error) { if params == nil { params = &CreateResolverQueryLogConfigInput{} @@ -49,12 +53,22 @@ 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/ + // + // - 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:* + // + // 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 + // + // arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name // // This member is required. DestinationArn *string diff --git a/service/route53resolver/api_op_CreateResolverRule.go b/service/route53resolver/api_op_CreateResolverRule.go index c012ca94ae2..b777a611927 100644 --- a/service/route53resolver/api_op_CreateResolverRule.go +++ b/service/route53resolver/api_op_CreateResolverRule.go @@ -39,13 +39,19 @@ type CreateResolverRuleInput struct { CreatorRequestId *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 - // 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 - // 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 . + // 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 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 . // // This member is required. RuleType types.RuleTypeOption @@ -69,8 +75,9 @@ type CreateResolverRuleInput struct { // The IPs that you want Resolver to forward DNS queries to. You can specify // either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP - // addresses with a space. TargetIps is available only when the value of Rule type - // is FORWARD . + // addresses with a space. + // + // TargetIps is available only when the value of Rule type is FORWARD . TargetIps []types.TargetAddress noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_DeleteFirewallRule.go b/service/route53resolver/api_op_DeleteFirewallRule.go index aff1baa3930..b54e17a8ffd 100644 --- a/service/route53resolver/api_op_DeleteFirewallRule.go +++ b/service/route53resolver/api_op_DeleteFirewallRule.go @@ -40,25 +40,40 @@ type DeleteFirewallRuleInput struct { // This member is required. FirewallRuleGroupId *string - // The DNS query type that the rule you are deleting evaluates. Allowed values + // The DNS query type that the rule you are deleting evaluates. Allowed values // are; + // // - A: Returns an IPv4 address. + // // - AAAA: Returns an Ipv6 address. + // // - CAA: Restricts CAs that can create SSL/TLS certifications for the domain. + // // - CNAME: Returns another domain name. + // // - DS: Record that identifies the DNSSEC signing key of a delegated zone. + // // - MX: Specifies mail servers. + // // - NAPTR: Regular-expression-based rewriting of domain names. + // // - NS: Authoritative name servers. + // // - PTR: Maps an IP address to a domain name. + // // - SOA: Start of authority record for the zone. + // // - SPF: Lists the servers authorized to send emails from a domain. + // // - SRV: Application specific values that identify servers. + // // - TXT: Verifies email senders and application-specific values. + // // - A query type you define by using the DNS type ID, for example 28 for AAAA. // The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for - // example, TYPE28. For more information, see List of DNS record types (https://en.wikipedia.org/wiki/List_of_DNS_record_types) - // . + // example, TYPE28. For more information, see [List of DNS record types]. + // + // [List of DNS record types]: https://en.wikipedia.org/wiki/List_of_DNS_record_types Qtype *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_DeleteResolverEndpoint.go b/service/route53resolver/api_op_DeleteResolverEndpoint.go index d49ab036621..2d5780968ca 100644 --- a/service/route53resolver/api_op_DeleteResolverEndpoint.go +++ b/service/route53resolver/api_op_DeleteResolverEndpoint.go @@ -13,8 +13,10 @@ 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. func (c *Client) DeleteResolverEndpoint(ctx context.Context, params *DeleteResolverEndpointInput, optFns ...func(*Options)) (*DeleteResolverEndpointOutput, error) { if params == nil { diff --git a/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go b/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go index 3c766d4deb3..ab7beaad998 100644 --- a/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_DeleteResolverQueryLogConfig.go @@ -15,15 +15,19 @@ import ( // 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 +// 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]. +// +// 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. +// +// [DisassociateResolverQueryLogConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html 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 0f564dfe331..4f9fbfd8189 100644 --- a/service/route53resolver/api_op_DeleteResolverRule.go +++ b/service/route53resolver/api_op_DeleteResolverRule.go @@ -13,8 +13,9 @@ 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]. +// +// [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 4ed9d0049aa..8b1f5a6cf1a 100644 --- a/service/route53resolver/api_op_DisassociateFirewallRuleGroup.go +++ b/service/route53resolver/api_op_DisassociateFirewallRuleGroup.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the -// VPC. +// Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC. func (c *Client) DisassociateFirewallRuleGroup(ctx context.Context, params *DisassociateFirewallRuleGroupInput, optFns ...func(*Options)) (*DisassociateFirewallRuleGroupOutput, error) { if params == nil { params = &DisassociateFirewallRuleGroupInput{} @@ -30,7 +29,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 6dcc1aa1818..56e0cebe634 100644 --- a/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go +++ b/service/route53resolver/api_op_DisassociateResolverEndpointIpAddress.go @@ -13,9 +13,11 @@ 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) -// . +// DisassociateResolverEndpointIpAddress request for each IP address. +// +// To add an IP address to an endpoint, see [AssociateResolverEndpointIpAddress]. +// +// [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 d072926d67d..308fd5b1fe3 100644 --- a/service/route53resolver/api_op_DisassociateResolverQueryLogConfig.go +++ b/service/route53resolver/api_op_DisassociateResolverQueryLogConfig.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a VPC from a query logging configuration. Before you can delete a -// query logging configuration, you must first disassociate all VPCs from the -// 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: +// Disassociates a VPC from a query logging configuration. +// +// Before you can delete a query logging configuration, you must first +// disassociate all VPCs from the 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. func (c *Client) DisassociateResolverQueryLogConfig(ctx context.Context, params *DisassociateResolverQueryLogConfigInput, optFns ...func(*Options)) (*DisassociateResolverQueryLogConfigOutput, error) { if params == nil { diff --git a/service/route53resolver/api_op_DisassociateResolverRule.go b/service/route53resolver/api_op_DisassociateResolverRule.go index 419c4e68930..17733de2c07 100644 --- a/service/route53resolver/api_op_DisassociateResolverRule.go +++ b/service/route53resolver/api_op_DisassociateResolverRule.go @@ -12,6 +12,7 @@ import ( ) // Removes the association between a specified Resolver rule and a specified VPC. +// // If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS // queries for the domain name that you specified in the Resolver rule. func (c *Client) DisassociateResolverRule(ctx context.Context, params *DisassociateResolverRuleInput, optFns ...func(*Options)) (*DisassociateResolverRuleOutput, error) { diff --git a/service/route53resolver/api_op_GetFirewallRuleGroupAssociation.go b/service/route53resolver/api_op_GetFirewallRuleGroupAssociation.go index 9010e10ad4b..c873a305b18 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_GetResolverRuleAssociation.go b/service/route53resolver/api_op_GetResolverRuleAssociation.go index d9d0c975725..2d3ca318ce0 100644 --- a/service/route53resolver/api_op_GetResolverRuleAssociation.go +++ b/service/route53resolver/api_op_GetResolverRuleAssociation.go @@ -12,8 +12,9 @@ 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]. +// +// [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_ImportFirewallDomains.go b/service/route53resolver/api_op_ImportFirewallDomains.go index 6f9f3e54095..9a7e81528b2 100644 --- a/service/route53resolver/api_op_ImportFirewallDomains.go +++ b/service/route53resolver/api_op_ImportFirewallDomains.go @@ -12,11 +12,16 @@ 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: +// 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. func (c *Client) ImportFirewallDomains(ctx context.Context, params *ImportFirewallDomainsInput, optFns ...func(*Options)) (*ImportFirewallDomainsOutput, error) { if params == nil { @@ -36,9 +41,11 @@ func (c *Client) ImportFirewallDomains(ctx context.Context, params *ImportFirewa type ImportFirewallDomainsInput struct { // The fully qualified URL or URI of the file stored in Amazon Simple Storage - // Service (Amazon S3) that contains the list of domains to import. The file must - // be in an S3 bucket that's in the same Region as your DNS Firewall. The file must - // be a text file and must contain a single domain per line. + // Service (Amazon S3) that contains the list of domains to import. + // + // The file must be in an S3 bucket that's in the same Region as your DNS + // Firewall. The file must be a text file and must contain a single domain per + // line. // // This member is required. DomainFileUrl *string diff --git a/service/route53resolver/api_op_ListFirewallConfigs.go b/service/route53resolver/api_op_ListFirewallConfigs.go index 42c028c622e..7c0c71ac819 100644 --- a/service/route53resolver/api_op_ListFirewallConfigs.go +++ b/service/route53resolver/api_op_ListFirewallConfigs.go @@ -12,9 +12,10 @@ 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 . +// 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 . func (c *Client) ListFirewallConfigs(ctx context.Context, params *ListFirewallConfigsInput, optFns ...func(*Options)) (*ListFirewallConfigsOutput, error) { if params == nil { params = &ListFirewallConfigsInput{} @@ -35,15 +36,19 @@ 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. + // 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 - // 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. + // 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 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 noSmithyDocumentSerde @@ -156,8 +161,10 @@ 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. + // 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 bfec4cb222e..b828aefb9b6 100644 --- a/service/route53resolver/api_op_ListFirewallDomainLists.go +++ b/service/route53resolver/api_op_ListFirewallDomainLists.go @@ -13,8 +13,10 @@ 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{} @@ -35,15 +37,19 @@ 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. + // 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 - // 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. + // 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 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 noSmithyDocumentSerde @@ -51,8 +57,10 @@ 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 . + // 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 . FirewallDomainLists []types.FirewallDomainListMetadata // If objects are still available for retrieval, Resolver returns this token in @@ -156,8 +164,10 @@ 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. + // 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 ad196763cf4..f578740c2e8 100644 --- a/service/route53resolver/api_op_ListFirewallDomains.go +++ b/service/route53resolver/api_op_ListFirewallDomains.go @@ -11,8 +11,10 @@ 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 . +// list. +// +// A single call might return only a partial list of the domains. For information, +// see MaxResults . func (c *Client) ListFirewallDomains(ctx context.Context, params *ListFirewallDomainsInput, optFns ...func(*Options)) (*ListFirewallDomainsOutput, error) { if params == nil { params = &ListFirewallDomainsInput{} @@ -38,15 +40,19 @@ type ListFirewallDomainsInput 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. + // 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 - // 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. + // 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 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 noSmithyDocumentSerde @@ -54,9 +60,10 @@ type ListFirewallDomainsInput struct { 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 . + // 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 . Domains []string // If objects are still available for retrieval, Resolver returns this token in @@ -163,8 +170,10 @@ 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. + // 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 66bd4a122ec..177594b9abd 100644 --- a/service/route53resolver/api_op_ListFirewallRuleGroupAssociations.go +++ b/service/route53resolver/api_op_ListFirewallRuleGroupAssociations.go @@ -12,9 +12,10 @@ 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 . +// 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 . func (c *Client) ListFirewallRuleGroupAssociations(ctx context.Context, params *ListFirewallRuleGroupAssociationsInput, optFns ...func(*Options)) (*ListFirewallRuleGroupAssociationsOutput, error) { if params == nil { params = &ListFirewallRuleGroupAssociationsInput{} @@ -39,15 +40,19 @@ type ListFirewallRuleGroupAssociationsInput 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. + // 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 - // 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. + // 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 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 // The setting that determines the processing order of the rule group among the @@ -69,8 +74,10 @@ 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 @@ -174,8 +181,10 @@ 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. + // 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 4065f1fd8b2..0054d82f2d1 100644 --- a/service/route53resolver/api_op_ListFirewallRuleGroups.go +++ b/service/route53resolver/api_op_ListFirewallRuleGroups.go @@ -12,7 +12,9 @@ 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 +// defined. +// +// A single call might return only a partial list of the rule groups. For // information, see MaxResults . func (c *Client) ListFirewallRuleGroups(ctx context.Context, params *ListFirewallRuleGroupsInput, optFns ...func(*Options)) (*ListFirewallRuleGroupsOutput, error) { if params == nil { @@ -34,15 +36,19 @@ 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. + // 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 - // 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. + // 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 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 noSmithyDocumentSerde @@ -50,8 +56,10 @@ 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 . + // 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 . FirewallRuleGroups []types.FirewallRuleGroupMetadata // If objects are still available for retrieval, Resolver returns this token in @@ -155,8 +163,10 @@ 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. + // 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 2c4c4552b70..8fd8bb06869 100644 --- a/service/route53resolver/api_op_ListFirewallRules.go +++ b/service/route53resolver/api_op_ListFirewallRules.go @@ -13,8 +13,10 @@ 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 . +// traffic for a VPC. +// +// A single call might return only a partial list of the rules. For information, +// see MaxResults . func (c *Client) ListFirewallRules(ctx context.Context, params *ListFirewallRulesInput, optFns ...func(*Options)) (*ListFirewallRulesOutput, error) { if params == nil { params = &ListFirewallRulesInput{} @@ -38,11 +40,15 @@ type ListFirewallRulesInput struct { // This member is required. FirewallRuleGroupId *string - // 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: + // 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. Action types.Action @@ -50,21 +56,26 @@ type ListFirewallRulesInput 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. + // 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 - // 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. + // 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 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 - // Optional additional filter for the rules to retrieve. The setting that - // determines the processing order of the rules in a rule group. DNS Firewall - // processes the rules in a rule group by order of priority, starting from the - // lowest setting. + // Optional additional filter for the rules to retrieve. + // + // The setting that determines the processing order of the rules in a rule group. + // DNS Firewall processes the rules in a rule group by order of priority, starting + // from the lowest setting. Priority *int32 noSmithyDocumentSerde @@ -72,8 +83,10 @@ 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 . + // 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 . FirewallRules []types.FirewallRule // If objects are still available for retrieval, Resolver returns this token in @@ -179,8 +192,10 @@ 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. + // 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 7329183e700..24c3bb4e8dd 100644 --- a/service/route53resolver/api_op_ListResolverConfigs.go +++ b/service/route53resolver/api_op_ListResolverConfigs.go @@ -37,9 +37,12 @@ type ListResolverConfigsInput struct { // (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 - // second and subsequent requests, get the value of NextToken from the previous - // response and specify that value for NextToken in the request. + // 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 noSmithyDocumentSerde @@ -49,11 +52,12 @@ type ListResolverConfigsOutput struct { // If a response includes the last of the Resolver 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 - // ListResolverConfigs request. Get the value of NextToken that Amazon Route 53 - // returned in the previous response and include it in NextToken in the next - // request. + // appear in the response. + // + // If a response doesn't include the last of the configurations, you can get more + // configurations by submitting another ListResolverConfigs 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 ResolverConfigs element for each Resolver diff --git a/service/route53resolver/api_op_ListResolverDnssecConfigs.go b/service/route53resolver/api_op_ListResolverDnssecConfigs.go index 7dae775592f..2525db04c53 100644 --- a/service/route53resolver/api_op_ListResolverDnssecConfigs.go +++ b/service/route53resolver/api_op_ListResolverDnssecConfigs.go @@ -33,15 +33,18 @@ type ListResolverDnssecConfigsInput struct { // An optional specification to return a subset of objects. Filters []types.Filter - // Optional: An integer that specifies the maximum number of DNSSEC configuration + // 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. 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 + // 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. NextToken *string @@ -52,17 +55,21 @@ 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) - // request. Get the value of NextToken that Amazon Route 53 returned in the - // previous response and include it in NextToken in the next request. + // appear in the response. + // + // If a response doesn't include the last of the configurations, you can get more + // configurations by submitting another [ListResolverDnssecConfigs]request. Get the value of NextToken that + // Amazon Route 53 returned in the previous response and include it in NextToken + // in the next request. + // + // [ListResolverDnssecConfigs]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListResolverDnssecConfigs.html NextToken *string - // 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. It doesn't contain disabled DNSSEC - // configurations for the resource. + // An array that contains one [ResolverDnssecConfig] element for each configuration for DNSSEC + // validation that is associated with the current Amazon Web Services account. It + // doesn't contain disabled DNSSEC configurations for the resource. + // + // [ResolverDnssecConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResolverDnssecConfig.html ResolverDnssecConfigs []types.ResolverDnssecConfig // Metadata pertaining to the operation's result. @@ -158,7 +165,7 @@ var _ ListResolverDnssecConfigsAPIClient = (*Client)(nil) // ListResolverDnssecConfigsPaginatorOptions is the paginator options for // ListResolverDnssecConfigs type ListResolverDnssecConfigsPaginatorOptions struct { - // Optional: An integer that specifies the maximum number of DNSSEC configuration + // 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. Limit int32 diff --git a/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go b/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go index b0a6c03a0b8..3ebc2462297 100644 --- a/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go +++ b/service/route53resolver/api_op_ListResolverEndpointIpAddresses.go @@ -39,11 +39,12 @@ type ListResolverEndpointIpAddressesInput struct { // MaxResults , Resolver returns up to 100 IP addresses. MaxResults *int32 - // For the first ListResolverEndpointIpAddresses request, omit this value. If the - // specified Resolver 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. + // For the first ListResolverEndpointIpAddresses request, omit this value. + // + // If the specified Resolver 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. NextToken *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_ListResolverEndpoints.go b/service/route53resolver/api_op_ListResolverEndpoints.go index 3e325f21132..70beaa10f26 100644 --- a/service/route53resolver/api_op_ListResolverEndpoints.go +++ b/service/route53resolver/api_op_ListResolverEndpoints.go @@ -31,9 +31,11 @@ func (c *Client) ListResolverEndpoints(ctx context.Context, params *ListResolver 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. + // 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. Filters []types.Filter // The maximum number of Resolver endpoints that you want to return in the @@ -41,10 +43,11 @@ type ListResolverEndpointsInput struct { // MaxResults , Resolver returns up to 100 Resolver endpoints. MaxResults *int32 - // For the first ListResolverEndpoints request, omit this value. If you have more - // than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints - // request to get the next group of Resolver endpoints. In the next request, - // specify the value of NextToken from the previous response. + // For the first ListResolverEndpoints request, omit this value. + // + // If you have more than MaxResults Resolver endpoints, you can submit another + // ListResolverEndpoints request to get the next group of Resolver endpoints. In + // the next request, specify the value of NextToken from the previous response. NextToken *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go b/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go index 69a6504d30d..2835dc8bfd2 100644 --- a/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go +++ b/service/route53resolver/api_op_ListResolverQueryLogConfigAssociations.go @@ -30,8 +30,9 @@ 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 + // 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. Filters []types.Filter @@ -43,6 +44,7 @@ type ListResolverQueryLogConfigAssociationsInput struct { 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 // ListResolverQueryLogConfigAssociations request to get the next group of @@ -50,41 +52,59 @@ type ListResolverQueryLogConfigAssociationsInput struct { // previous response. NextToken *string - // The element that you want Resolver to sort query logging associations by. If - // you submit a second or subsequent ListResolverQueryLogConfigAssociations + // 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: + // 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. + // + // - 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 - // the previous request. + // 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 noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_ListResolverQueryLogConfigs.go b/service/route53resolver/api_op_ListResolverQueryLogConfigs.go index 8a9db420f94..7545024a383 100644 --- a/service/route53resolver/api_op_ListResolverQueryLogConfigs.go +++ b/service/route53resolver/api_op_ListResolverQueryLogConfigs.go @@ -32,6 +32,7 @@ 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 // any, as in the previous request. @@ -42,49 +43,70 @@ type ListResolverQueryLogConfigsInput struct { // 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 + // 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 + // 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: + // 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 - // or subsequent ListResolverQueryLogConfigs request and specify the NextToken - // parameter, you must use the same value for SortOrder , if any, as in the - // previous request. + // 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. SortOrder types.SortOrder noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_ListResolverRuleAssociations.go b/service/route53resolver/api_op_ListResolverRuleAssociations.go index 353ab285075..6281ff3bfcd 100644 --- a/service/route53resolver/api_op_ListResolverRuleAssociations.go +++ b/service/route53resolver/api_op_ListResolverRuleAssociations.go @@ -31,10 +31,11 @@ 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 - // request. + // 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 @@ -42,8 +43,9 @@ type ListResolverRuleAssociationsInput struct { // MaxResults , Resolver returns up to 100 rule associations. MaxResults *int32 - // For the first ListResolverRuleAssociation request, omit this value. If you have - // more than MaxResults rule associations, you can submit another + // For the first ListResolverRuleAssociation request, omit this value. + // + // If you have more than MaxResults rule associations, you can submit another // ListResolverRuleAssociation request to get the next group of rule associations. // In the next request, specify the value of NextToken from the previous response. NextToken *string diff --git a/service/route53resolver/api_op_ListResolverRules.go b/service/route53resolver/api_op_ListResolverRules.go index a45ee91a06e..60c9e41634b 100644 --- a/service/route53resolver/api_op_ListResolverRules.go +++ b/service/route53resolver/api_op_ListResolverRules.go @@ -31,8 +31,9 @@ func (c *Client) ListResolverRules(ctx context.Context, params *ListResolverRule 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 + // 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. Filters []types.Filter @@ -42,10 +43,11 @@ type ListResolverRulesInput struct { // Resolver returns up to 100 Resolver rules. MaxResults *int32 - // For the first ListResolverRules request, omit this value. If you have more than - // MaxResults Resolver rules, you can submit another ListResolverRules request to - // get the next group of Resolver rules. In the next request, specify the value of - // NextToken from the previous response. + // For the first ListResolverRules request, omit this value. + // + // If you have more than MaxResults Resolver rules, you can submit another + // ListResolverRules request to get the next group of Resolver rules. In the next + // request, specify the value of NextToken from the previous response. NextToken *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_ListTagsForResource.go b/service/route53resolver/api_op_ListTagsForResource.go index 5a39d09050a..6fe5dd5c5dd 100644 --- a/service/route53resolver/api_op_ListTagsForResource.go +++ b/service/route53resolver/api_op_ListTagsForResource.go @@ -39,10 +39,11 @@ type ListTagsForResourceInput struct { // Resolver returns up to 100 tags. MaxResults *int32 - // For the first ListTagsForResource request, omit this value. If you have more - // than MaxResults tags, you can submit another ListTagsForResource request to get - // the next group of tags for the resource. In the next request, specify the value - // of NextToken from the previous response. + // For the first ListTagsForResource request, omit this value. + // + // If you have more than MaxResults tags, you can submit another + // ListTagsForResource request to get the next group of tags for the resource. In + // the next request, specify the value of NextToken from the previous response. NextToken *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go b/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go index cf7de76c5d3..a9927b94699 100644 --- a/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go +++ b/service/route53resolver/api_op_PutResolverQueryLogConfigPolicy.go @@ -40,9 +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: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 . diff --git a/service/route53resolver/api_op_PutResolverRulePolicy.go b/service/route53resolver/api_op_PutResolverRulePolicy.go index 06048bc5572..f229dcf2aaf 100644 --- a/service/route53resolver/api_op_PutResolverRulePolicy.go +++ b/service/route53resolver/api_op_PutResolverRulePolicy.go @@ -40,11 +40,17 @@ type PutResolverRulePolicyInput struct { // 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 . diff --git a/service/route53resolver/api_op_TagResource.go b/service/route53resolver/api_op_TagResource.go index f5ea751a1ea..27efd8a9d32 100644 --- a/service/route53resolver/api_op_TagResource.go +++ b/service/route53resolver/api_op_TagResource.go @@ -31,12 +31,25 @@ 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) + // + // [GetResolverEndpoint] + // + // [GetResolverRule] + // + // [GetResolverRuleAssociation] + // + // [ListResolverEndpoints] + // + // [ListResolverRuleAssociations] + // + // [ListResolverRules] + // + // [GetResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html + // [GetResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html + // [ListResolverRules]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html + // [GetResolverRuleAssociation]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html + // [ListResolverRuleAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html + // [ListResolverEndpoints]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html // // This member is required. ResourceArn *string diff --git a/service/route53resolver/api_op_UntagResource.go b/service/route53resolver/api_op_UntagResource.go index 4db9390ba16..a50cf607bb8 100644 --- a/service/route53resolver/api_op_UntagResource.go +++ b/service/route53resolver/api_op_UntagResource.go @@ -30,12 +30,25 @@ 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] + // + // [GetResolverRule] + // + // [GetResolverRuleAssociation] + // + // [ListResolverEndpoints] + // + // [ListResolverRuleAssociations] + // + // [ListResolverRules] + // + // [GetResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html + // [GetResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html + // [ListResolverRules]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html + // [GetResolverRuleAssociation]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html + // [ListResolverRuleAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html + // [ListResolverEndpoints]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html // // This member is required. ResourceArn *string diff --git a/service/route53resolver/api_op_UpdateFirewallConfig.go b/service/route53resolver/api_op_UpdateFirewallConfig.go index 02b417ed809..14937acb706 100644 --- a/service/route53resolver/api_op_UpdateFirewallConfig.go +++ b/service/route53resolver/api_op_UpdateFirewallConfig.go @@ -32,12 +32,15 @@ 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. // diff --git a/service/route53resolver/api_op_UpdateFirewallDomains.go b/service/route53resolver/api_op_UpdateFirewallDomains.go index 41f0a0e683b..a3c90c736ae 100644 --- a/service/route53resolver/api_op_UpdateFirewallDomains.go +++ b/service/route53resolver/api_op_UpdateFirewallDomains.go @@ -29,12 +29,18 @@ func (c *Client) UpdateFirewallDomains(ctx context.Context, params *UpdateFirewa 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: + // 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. // // This member is required. @@ -46,9 +52,12 @@ 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. // diff --git a/service/route53resolver/api_op_UpdateFirewallRule.go b/service/route53resolver/api_op_UpdateFirewallRule.go index e035b2a26ab..202c8b04ef6 100644 --- a/service/route53resolver/api_op_UpdateFirewallRule.go +++ b/service/route53resolver/api_op_UpdateFirewallRule.go @@ -41,8 +41,11 @@ 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 . Action types.Action @@ -63,19 +66,25 @@ type UpdateFirewallRuleInput struct { // 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. BlockResponse types.BlockResponse - // How you want the the rule to evaluate DNS redirection in the DNS redirection - // chain, such as CNAME, DNAME, ot ALIAS. Inspect_Redirection_Domain (Default) - // inspects all domains in the redirection chain. The individual domains in the - // redirection chain must be added to the allow domain list. - // Trust_Redirection_Domain inspects only the first domain in the redirection + // How you want the the rule to evaluate DNS redirection in the DNS redirection + // chain, such as CNAME, DNAME, ot ALIAS. + // + // Inspect_Redirection_Domain (Default) inspects all domains in the redirection + // chain. The individual domains in the redirection chain must be added to the + // allow domain list. + // + // Trust_Redirection_Domain inspects only the first domain in the redirection // chain. You don't need to add the subsequent domains in the domain in the // redirection list to the domain alloww list. FirewallDomainRedirectionAction types.FirewallDomainRedirectionAction @@ -85,30 +94,47 @@ type UpdateFirewallRuleInput struct { // The setting that determines the processing order of the rule in the rule group. // DNS Firewall processes the rules in a rule group by order of priority, starting - // from the lowest setting. You must specify a unique priority for each rule in a - // rule group. To make it easier to insert rules later, leave space between the - // numbers, for example, use 100, 200, and so on. You can change the priority - // setting for the rules in a rule group at any time. + // from the lowest setting. + // + // You must specify a unique priority for each rule in a rule group. To make it + // easier to insert rules later, leave space between the numbers, for example, use + // 100, 200, and so on. You can change the priority setting for the rules in a rule + // group at any time. Priority *int32 - // The DNS query type you want the rule to evaluate. Allowed values are; + // The DNS query type you want the rule to evaluate. Allowed values are; + // // - A: Returns an IPv4 address. + // // - AAAA: Returns an Ipv6 address. + // // - CAA: Restricts CAs that can create SSL/TLS certifications for the domain. + // // - CNAME: Returns another domain name. + // // - DS: Record that identifies the DNSSEC signing key of a delegated zone. + // // - MX: Specifies mail servers. + // // - NAPTR: Regular-expression-based rewriting of domain names. + // // - NS: Authoritative name servers. + // // - PTR: Maps an IP address to a domain name. + // // - SOA: Start of authority record for the zone. + // // - SPF: Lists the servers authorized to send emails from a domain. + // // - SRV: Application specific values that identify servers. + // // - TXT: Verifies email senders and application-specific values. + // // - A query type you define by using the DNS type ID, for example 28 for AAAA. // The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for - // example, TYPE28. For more information, see List of DNS record types (https://en.wikipedia.org/wiki/List_of_DNS_record_types) - // . + // example, TYPE28. For more information, see [List of DNS record types]. + // + // [List of DNS record types]: https://en.wikipedia.org/wiki/List_of_DNS_record_types Qtype *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go b/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go index c5f028bf873..d8a02fd25db 100644 --- a/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go +++ b/service/route53resolver/api_op_UpdateFirewallRuleGroupAssociation.go @@ -11,8 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the association of a FirewallRuleGroup with a VPC. The association -// enables DNS filtering for the VPC. +// Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering +// for the VPC. func (c *Client) UpdateFirewallRuleGroupAssociation(ctx context.Context, params *UpdateFirewallRuleGroupAssociationInput, optFns ...func(*Options)) (*UpdateFirewallRuleGroupAssociationOutput, error) { if params == nil { params = &UpdateFirewallRuleGroupAssociationInput{} @@ -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 @@ -45,8 +45,9 @@ type UpdateFirewallRuleGroupAssociationInput struct { // The setting that determines the processing order of the rule group among the // rule groups that you associate with the specified VPC. DNS Firewall filters VPC // traffic starting from the rule group with the lowest numeric priority setting. - // You must specify a unique priority for each rule group that you associate with a - // single VPC. To make it easier to insert rule groups later, leave space between + // + // You must specify a unique priority for each rule group that you associate with + // a single VPC. To make it easier to insert rule groups later, leave space between // the numbers, for example, use 100, 200, and so on. You can change the priority // setting for a rule group association after you create it. Priority *int32 diff --git a/service/route53resolver/api_op_UpdateOutpostResolver.go b/service/route53resolver/api_op_UpdateOutpostResolver.go index 48c1bf63b52..c365bd26766 100644 --- a/service/route53resolver/api_op_UpdateOutpostResolver.go +++ b/service/route53resolver/api_op_UpdateOutpostResolver.go @@ -41,7 +41,7 @@ type UpdateOutpostResolverInput struct { // Name of the Resolver on the Outpost. Name *string - // Amazon EC2 instance type. + // Amazon EC2 instance type. PreferredInstanceType *string noSmithyDocumentSerde diff --git a/service/route53resolver/api_op_UpdateResolverConfig.go b/service/route53resolver/api_op_UpdateResolverConfig.go index 6ce55262c51..1e51f2be1d2 100644 --- a/service/route53resolver/api_op_UpdateResolverConfig.go +++ b/service/route53resolver/api_op_UpdateResolverConfig.go @@ -32,13 +32,18 @@ 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 - // 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. + // EC2-Classic instances using ClassicLink. For more information, see [ClassicLink]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]in the Amazon EC2 guide + // and the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare]. + // + // It can take some time for the status change to be completed. + // + // [ClassicLink]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html + // [Migrate from EC2-Classic to a VPC]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html + // [EC2-Classic Networking is Retiring – Here’s How to Prepare]: http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/ // // This member is required. AutodefinedReverseFlag types.AutodefinedReverseFlag diff --git a/service/route53resolver/api_op_UpdateResolverEndpoint.go b/service/route53resolver/api_op_UpdateResolverEndpoint.go index 61ab9798b63..3f25a5ba0a2 100644 --- a/service/route53resolver/api_op_UpdateResolverEndpoint.go +++ b/service/route53resolver/api_op_UpdateResolverEndpoint.go @@ -39,20 +39,33 @@ type UpdateResolverEndpointInput struct { // The name of the Resolver endpoint that you want to update. Name *string - // The protocols you want to use for the endpoint. DoH-FIPS is applicable for - // inbound endpoints only. For an inbound endpoint you can apply the protocols as - // follows: + // The protocols you want to use for the endpoint. DoH-FIPS is applicable for + // inbound endpoints only. + // + // For an inbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 and DoH-FIPS in combination. + // // - Do53 alone. + // // - DoH alone. + // // - DoH-FIPS alone. + // // - None, which is treated as Do53. + // // For an outbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 alone. + // // - DoH alone. + // // - None, which is treated as Do53. + // // You can't change the protocol of an inbound endpoint directly from only Do53 to // only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming // traffic that relies on Do53. To change the protocol from Do53 to DoH, or @@ -61,11 +74,13 @@ type UpdateResolverEndpointInput struct { // DoH-FIPS, and then remove the Do53. Protocols []types.Protocol - // Specifies the endpoint type for what type of IP address the endpoint uses to - // forward DNS queries. Updating to IPV6 type isn't currently supported. + // Specifies the endpoint type for what type of IP address the endpoint uses to + // forward DNS queries. + // + // Updating to IPV6 type isn't currently supported. ResolverEndpointType types.ResolverEndpointType - // Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to + // Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to // dual-stack. If you don't specify an IPv6 address, one will be automatically // chosen from your subnet. UpdateIpAddresses []types.UpdateIpAddress diff --git a/service/route53resolver/doc.go b/service/route53resolver/doc.go index 8861692b5c3..0f68883055b 100644 --- a/service/route53resolver/doc.go +++ b/service/route53resolver/doc.go @@ -7,27 +7,35 @@ // within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries // for VPC domain names such as domain names for EC2 instances or Elastic Load // Balancing load balancers. Resolver performs recursive lookups against public -// name servers for all other domain names. You can also configure DNS resolution -// between your VPC and your network over a Direct Connect or VPN connection: -// Forward DNS queries from resolvers on your network to Route 53 Resolver DNS -// 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) -// 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 -// forward selected queries, you create Resolver rules that specify the domain -// names for the DNS queries that you want to forward (such as example.com), and -// the IP addresses of the DNS resolvers on your network that you want to forward -// the queries to. If a query matches multiple rules (example.com, -// 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) -// 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 -// VPCs (inbound queries), or both. +// name servers for all other domain names. +// +// You can also configure DNS resolution between your VPC and your network over a +// Direct Connect or VPN connection: +// +// # Forward DNS queries from resolvers on your network to Route 53 Resolver +// +// DNS 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]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 forward selected +// queries, you create Resolver rules that specify the domain names for the DNS +// queries that you want to forward (such as example.com), and the IP addresses of +// the DNS resolvers on your network that you want to forward the queries to. If a +// query matches multiple rules (example.com, 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] +// 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 VPCs (inbound queries), or both. +// +// [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 +// [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 package route53resolver diff --git a/service/route53resolver/options.go b/service/route53resolver/options.go index 3b99e8080c6..bcb22c369d6 100644 --- a/service/route53resolver/options.go +++ b/service/route53resolver/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/route53resolver/types/enums.go b/service/route53resolver/types/enums.go index 29fabf0eae4..c05c14bb0de 100644 --- a/service/route53resolver/types/enums.go +++ b/service/route53resolver/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for Action. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Action) Values() []Action { return []Action{ "ALLOW", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for AutodefinedReverseFlag. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutodefinedReverseFlag) Values() []AutodefinedReverseFlag { return []AutodefinedReverseFlag{ "ENABLE", @@ -50,8 +52,9 @@ const ( ) // Values returns all known values for BlockOverrideDnsType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockOverrideDnsType) Values() []BlockOverrideDnsType { return []BlockOverrideDnsType{ "CNAME", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for BlockResponse. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BlockResponse) Values() []BlockResponse { return []BlockResponse{ "NODATA", @@ -87,8 +91,9 @@ const ( // Values returns all known values for FirewallDomainImportOperation. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallDomainImportOperation) Values() []FirewallDomainImportOperation { return []FirewallDomainImportOperation{ "REPLACE", @@ -108,6 +113,7 @@ const ( // 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{ @@ -129,8 +135,9 @@ const ( // Values returns all known values for FirewallDomainRedirectionAction. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallDomainRedirectionAction) Values() []FirewallDomainRedirectionAction { return []FirewallDomainRedirectionAction{ "INSPECT_REDIRECTION_DOMAIN", @@ -149,8 +156,9 @@ const ( // Values returns all known values for FirewallDomainUpdateOperation. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallDomainUpdateOperation) Values() []FirewallDomainUpdateOperation { return []FirewallDomainUpdateOperation{ "ADD", @@ -169,8 +177,9 @@ const ( ) // Values returns all known values for FirewallFailOpenStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallFailOpenStatus) Values() []FirewallFailOpenStatus { return []FirewallFailOpenStatus{ "ENABLED", @@ -190,8 +199,9 @@ const ( // Values returns all known values for FirewallRuleGroupAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallRuleGroupAssociationStatus) Values() []FirewallRuleGroupAssociationStatus { return []FirewallRuleGroupAssociationStatus{ "COMPLETE", @@ -210,8 +220,9 @@ const ( ) // Values returns all known values for FirewallRuleGroupStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FirewallRuleGroupStatus) Values() []FirewallRuleGroupStatus { return []FirewallRuleGroupStatus{ "COMPLETE", @@ -239,8 +250,9 @@ const ( ) // Values returns all known values for IpAddressStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressStatus) Values() []IpAddressStatus { return []IpAddressStatus{ "CREATING", @@ -268,6 +280,7 @@ const ( // 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{ @@ -290,8 +303,9 @@ const ( ) // Values returns all known values for OutpostResolverStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutpostResolverStatus) Values() []OutpostResolverStatus { return []OutpostResolverStatus{ "CREATING", @@ -314,8 +328,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "DoH", @@ -338,8 +353,9 @@ const ( // Values returns all known values for ResolverAutodefinedReverseStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverAutodefinedReverseStatus) Values() []ResolverAutodefinedReverseStatus { return []ResolverAutodefinedReverseStatus{ "ENABLING", @@ -365,8 +381,9 @@ const ( // Values returns all known values for ResolverDNSSECValidationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverDNSSECValidationStatus) Values() []ResolverDNSSECValidationStatus { return []ResolverDNSSECValidationStatus{ "ENABLING", @@ -388,6 +405,7 @@ const ( // Values returns all known values for ResolverEndpointDirection. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResolverEndpointDirection) Values() []ResolverEndpointDirection { return []ResolverEndpointDirection{ @@ -409,8 +427,9 @@ const ( ) // Values returns all known values for ResolverEndpointStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverEndpointStatus) Values() []ResolverEndpointStatus { return []ResolverEndpointStatus{ "CREATING", @@ -432,8 +451,9 @@ const ( ) // Values returns all known values for ResolverEndpointType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverEndpointType) Values() []ResolverEndpointType { return []ResolverEndpointType{ "IPV6", @@ -454,8 +474,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverQueryLogConfigAssociationError) Values() []ResolverQueryLogConfigAssociationError { return []ResolverQueryLogConfigAssociationError{ "NONE", @@ -478,8 +499,9 @@ const ( // Values returns all known values for ResolverQueryLogConfigAssociationStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverQueryLogConfigAssociationStatus) Values() []ResolverQueryLogConfigAssociationStatus { return []ResolverQueryLogConfigAssociationStatus{ "CREATING", @@ -502,8 +524,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverQueryLogConfigStatus) Values() []ResolverQueryLogConfigStatus { return []ResolverQueryLogConfigStatus{ "CREATING", @@ -526,8 +549,9 @@ const ( // Values returns all known values for ResolverRuleAssociationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverRuleAssociationStatus) Values() []ResolverRuleAssociationStatus { return []ResolverRuleAssociationStatus{ "CREATING", @@ -549,8 +573,9 @@ const ( ) // Values returns all known values for ResolverRuleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResolverRuleStatus) Values() []ResolverRuleStatus { return []ResolverRuleStatus{ "COMPLETE", @@ -570,8 +595,9 @@ const ( ) // Values returns all known values for RuleTypeOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleTypeOption) Values() []RuleTypeOption { return []RuleTypeOption{ "FORWARD", @@ -590,8 +616,9 @@ const ( ) // Values returns all known values for ShareStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatus) Values() []ShareStatus { return []ShareStatus{ "NOT_SHARED", @@ -609,8 +636,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -628,8 +656,9 @@ const ( ) // Values returns all known values for Validation. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Validation) Values() []Validation { return []Validation{ "ENABLE", diff --git a/service/route53resolver/types/errors.go b/service/route53resolver/types/errors.go index 40cb1cc194e..bfc007ac935 100644 --- a/service/route53resolver/types/errors.go +++ b/service/route53resolver/types/errors.go @@ -8,8 +8,10 @@ import ( ) // The current account doesn't have the IAM permissions required to perform the -// specified Resolver operation. This error can also be thrown when a customer has -// reached the 5120 character limit for a resource policy for CloudWatch Logs. +// specified Resolver operation. +// +// This error can also be thrown when a customer has reached the 5120 character +// limit for a resource policy for CloudWatch Logs. type AccessDeniedException struct { Message *string diff --git a/service/route53resolver/types/types.go b/service/route53resolver/types/types.go index 1f155adca9d..2b935330a83 100644 --- a/service/route53resolver/types/types.go +++ b/service/route53resolver/types/types.go @@ -6,119 +6,179 @@ 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] , [ListResolverRules], [ListResolverRuleAssociations], [ListResolverQueryLogConfigs], [ListResolverQueryLogConfigAssociations]), and [ListResolverDnssecConfigs]), 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 . +// +// [ListResolverRules]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html +// [ListResolverQueryLogConfigs]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html +// [ListResolverDnssecConfigs]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverDnssecConfigs.html +// [ListResolverRuleAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html +// [ListResolverQueryLogConfigAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html +// [ListResolverEndpoints]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html 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 + // 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], [ListResolverRules], [ListResolverRuleAssociations], [ListResolverQueryLogConfigs], or [ListResolverQueryLogConfigAssociations]. + // + // 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. - // ListResolverEndpoints Valid values for Name include the following: + // + // 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. + // pass through on the way from your VPCs to your network. In a [CreateResolverEndpoint]request, SubnetId + // indirectly identifies the VPC. In a [GetResolverEndpoint]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: + // more information, see Status in [ResolverEndpoint]. + // + // 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. + // 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 . + // 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: + // + // 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: + // + // 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: + // CREATED , DELETING , or FAILED . For more information, see [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) - // . + // , DELETING , or FAILED . For more information, see [Status]. + // + // [Status]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfigAssociation.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfigAssociation-Status + // [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 + // [ListResolverQueryLogConfigs]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html + // [CreateResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html + // [ResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverEndpoint.html + // [ListResolverRuleAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html + // [ListResolverQueryLogConfigAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html + // [ListResolverEndpoints]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html Name *string // When you're using a List operation and you want the operation to return a @@ -137,12 +197,15 @@ 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. FirewallFailOpen FirewallFailOpenStatus @@ -160,9 +223,10 @@ type FirewallConfig struct { noSmithyDocumentSerde } -// 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 . +// 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. type FirewallDomainList struct { // The Amazon Resource Name (ARN) of the firewall domain list. @@ -204,10 +268,10 @@ type FirewallDomainList struct { noSmithyDocumentSerde } -// 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 . +// 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. type FirewallDomainListMetadata struct { // The Amazon Resource Name (ARN) of the firewall domain list metadata. @@ -237,8 +301,11 @@ 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. Action Action @@ -259,10 +326,13 @@ type FirewallRule struct { // 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. BlockResponse BlockResponse @@ -279,11 +349,14 @@ type FirewallRule struct { // The ID of the domain list that's used in the rule. FirewallDomainListId *string - // How you want the the rule to evaluate DNS redirection in the DNS redirection - // chain, such as CNAME, DNAME, ot ALIAS. Inspect_Redirection_Domain (Default) - // inspects all domains in the redirection chain. The individual domains in the - // redirection chain must be added to the allow domain list. - // Trust_Redirection_Domain inspects only the first domain in the redirection + // How you want the the rule to evaluate DNS redirection in the DNS redirection + // chain, such as CNAME, DNAME, ot ALIAS. + // + // Inspect_Redirection_Domain (Default) inspects all domains in the redirection + // chain. The individual domains in the redirection chain must be added to the + // allow domain list. + // + // Trust_Redirection_Domain inspects only the first domain in the redirection // chain. You don't need to add the subsequent domains in the domain in the // redirection list to the domain alloww list. FirewallDomainRedirectionAction FirewallDomainRedirectionAction @@ -303,24 +376,39 @@ type FirewallRule struct { // priority, starting from the lowest setting. Priority *int32 - // The DNS query type you want the rule to evaluate. Allowed values are; + // The DNS query type you want the rule to evaluate. Allowed values are; + // // - A: Returns an IPv4 address. + // // - AAAA: Returns an Ipv6 address. + // // - CAA: Restricts CAs that can create SSL/TLS certifications for the domain. + // // - CNAME: Returns another domain name. + // // - DS: Record that identifies the DNSSEC signing key of a delegated zone. + // // - MX: Specifies mail servers. + // // - NAPTR: Regular-expression-based rewriting of domain names. + // // - NS: Authoritative name servers. + // // - PTR: Maps an IP address to a domain name. + // // - SOA: Start of authority record for the zone. + // // - SPF: Lists the servers authorized to send emails from a domain. + // // - SRV: Application specific values that identify servers. + // // - TXT: Verifies email senders and application-specific values. + // // - A query type you define by using the DNS type ID, for example 28 for AAAA. // The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for - // example, TYPE28. For more information, see List of DNS record types (https://en.wikipedia.org/wiki/List_of_DNS_record_types) - // . + // example, TYPE28. For more information, see [List of DNS record types]. + // + // [List of DNS record types]: https://en.wikipedia.org/wiki/List_of_DNS_record_types Qtype *string noSmithyDocumentSerde @@ -328,7 +416,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. @@ -430,10 +518,10 @@ type FirewallRuleGroupAssociation struct { noSmithyDocumentSerde } -// 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 . +// 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. type FirewallRuleGroupMetadata struct { // The ARN (Amazon Resource Name) of the rule group. @@ -463,10 +551,11 @@ type FirewallRuleGroupMetadata struct { noSmithyDocumentSerde } -// 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. +// In a [CreateResolverEndpoint] 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. +// +// [CreateResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html type IpAddressRequest struct { // The ID of the subnet that contains the IP address. @@ -477,15 +566,16 @@ type IpAddressRequest struct { // The IPv4 address that you want to use for DNS queries. Ip *string - // The IPv6 address that you want to use for DNS queries. + // The IPv6 address that you want to use for DNS queries. Ipv6 *string noSmithyDocumentSerde } -// 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. +// In the response to a [GetResolverEndpoint] request, information about the IP addresses that the +// Resolver endpoint uses for DNS queries. +// +// [GetResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html type IpAddressResponse struct { // The date and time that the IP address was created, in Unix time format and @@ -498,7 +588,7 @@ type IpAddressResponse struct { // The ID of one IP address. IpId *string - // One IPv6 address that the Resolver endpoint uses for DNS queries. + // 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 @@ -517,24 +607,27 @@ type IpAddressResponse struct { noSmithyDocumentSerde } -// In an UpdateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) -// request, information about an IP address to update. +// In an [UpdateResolverEndpoint] request, information about an IP address to update. +// +// [UpdateResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html type IpAddressUpdate struct { // The new IPv4 address. 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) - // . + // 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]. + // + // [GetResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html IpId *string - // The new IPv6 address. + // 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]. + // + // [GetResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html SubnetId *string noSmithyDocumentSerde @@ -571,7 +664,7 @@ type OutpostResolver struct { // The ARN (Amazon Resource Name) for the Outpost. OutpostArn *string - // The Amazon EC2 instance type. + // The Amazon EC2 instance type. PreferredInstanceType *string // Status of the Resolver. @@ -587,14 +680,18 @@ type OutpostResolver struct { // VPC. type ResolverConfig struct { - // The status of whether or not the Resolver will create autodefined rules for + // 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. AutodefinedReverse ResolverAutodefinedReverseStatus @@ -628,22 +725,27 @@ 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. 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) -// request, a complex type that contains settings for an existing inbound or -// outbound Resolver endpoint. +// In the response to a [CreateResolverEndpoint], [DeleteResolverEndpoint], [GetResolverEndpoint], Updates the name, or ResolverEndpointType for an +// endpoint, or [UpdateResolverEndpoint]request, a complex type that contains settings for an existing +// inbound or outbound Resolver endpoint. +// +// [UpdateResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html +// [GetResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html +// [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 type ResolverEndpoint struct { // The ARN (Amazon Resource Name) for the Resolver endpoint. @@ -659,7 +761,9 @@ type ResolverEndpoint struct { 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 Direction ResolverEndpointDirection @@ -676,33 +780,47 @@ type ResolverEndpoint struct { // Coordinated Universal Time (UTC). 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) + // The name that you assigned to the Resolver endpoint when you submitted a [CreateResolverEndpoint] // request. + // + // [CreateResolverEndpoint]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html Name *string // The ARN (Amazon Resource Name) for the Outpost. OutpostArn *string - // The Amazon EC2 instance type. + // The Amazon EC2 instance type. PreferredInstanceType *string - // Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints - // only. For an inbound endpoint you can apply the protocols as follows: + // Protocols used for the endpoint. DoH-FIPS is applicable for inbound endpoints + // only. + // + // For an inbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 and DoH-FIPS in combination. + // // - Do53 alone. + // // - DoH alone. + // // - DoH-FIPS alone. + // // - None, which is treated as Do53. + // // For an outbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 alone. + // // - DoH alone. + // // - None, which is treated as Do53. Protocols []Protocol - // The Resolver endpoint IP address type. + // The Resolver endpoint IP address type. ResolverEndpointType ResolverEndpointType // The ID of one or more security groups that control access to this VPC. The @@ -714,31 +832,40 @@ 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) - // . + // see [Limits on Route 53 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. + // + // [Limits on Route 53 Resolver]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver Status ResolverEndpointStatus // A detailed description of the status of the Resolver endpoint. @@ -747,12 +874,13 @@ 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) -// request, a complex type that contains settings for one query logging -// configuration. +// In the response to a [CreateResolverQueryLogConfig], [DeleteResolverQueryLogConfig], [GetResolverQueryLogConfig], or [ListResolverQueryLogConfigs] request, a complex type that contains settings +// for one query logging configuration. +// +// [DeleteResolverQueryLogConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverQueryLogConfig.html +// [ListResolverQueryLogConfigs]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html +// [CreateResolverQueryLogConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverQueryLogConfig.html +// [GetResolverQueryLogConfig]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfig.html type ResolverQueryLogConfig struct { // The ARN for the query logging configuration. @@ -792,25 +920,33 @@ 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. 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 -// between an Amazon VPC and a query logging configuration. +// In the response to an [AssociateResolverQueryLogConfig], [DisassociateResolverQueryLogConfig], [GetResolverQueryLogConfigAssociation], or [ListResolverQueryLogConfigAssociations], request, a complex type that contains settings +// for a specified association between an Amazon VPC and a query logging +// configuration. +// +// [GetResolverQueryLogConfigAssociation]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfigAssociation.html +// [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 +// [ListResolverQueryLogConfigAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html type ResolverQueryLogConfigAssociation struct { // The date and time that the VPC was associated with the query logging @@ -818,9 +954,12 @@ type ResolverQueryLogConfigAssociation struct { 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. Error ResolverQueryLogConfigAssociationError @@ -840,12 +979,16 @@ 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. Status ResolverQueryLogConfigAssociationStatus @@ -855,12 +998,13 @@ 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) -// request. +// parameter appears in the response to a [CreateResolverRule], [DeleteResolverRule], [GetResolverRule], [ListResolverRules], or [UpdateResolverRule] request. +// +// [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 +// [CreateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html +// [UpdateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html +// [DeleteResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html type ResolverRule struct { // The ARN (Amazon Resource Name) for the Resolver rule specified by Id . @@ -900,13 +1044,19 @@ 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 - // 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 - // 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 . + // 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 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 . RuleType RuleTypeOption // Whether the rule is shared and, if so, whether the current account is sharing @@ -928,17 +1078,19 @@ 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) -// 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. +// In the response to an [AssociateResolverRule], [DisassociateResolverRule], or [ListResolverRuleAssociations] 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. +// +// [DisassociateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html +// [ListResolverRuleAssociations]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html +// [AssociateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html 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) - // request. + // this value when you submit an [AssociateResolverRule]request. + // + // [AssociateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html Id *string // The name of an association between a Resolver rule and a VPC. @@ -962,8 +1114,9 @@ type ResolverRuleAssociation struct { noSmithyDocumentSerde } -// 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. +// In an [UpdateResolverRule] request, information about the changes that you want to make. +// +// [UpdateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html type ResolverRuleConfig struct { // The new name for the Resolver rule. The name that you specify appears in the @@ -1001,48 +1154,62 @@ type Tag struct { noSmithyDocumentSerde } -// 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. +// In a [CreateResolverRule] request, an array of the IPs that you want to forward DNS queries to. +// +// [CreateResolverRule]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html type TargetAddress struct { // One IPv4 address that you want to forward DNS queries to. Ip *string - // One IPv6 address that you want to forward DNS queries to. + // One IPv6 address that you want to forward DNS queries to. Ipv6 *string // The port at Ip that you want to forward DNS queries to. Port *int32 - // The protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound - // endpoints only. For an inbound endpoint you can apply the protocols as follows: + // The protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound + // endpoints only. + // + // For an inbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 and DoH-FIPS in combination. + // // - Do53 alone. + // // - DoH alone. + // // - DoH-FIPS alone. + // // - None, which is treated as Do53. + // // For an outbound endpoint you can apply the protocols as follows: + // // - Do53 and DoH in combination. + // // - Do53 alone. + // // - DoH alone. + // // - None, which is treated as Do53. Protocol Protocol noSmithyDocumentSerde } -// Provides information about the IP address type in response to -// UpdateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) -// . +// Provides information about the IP address type in response to [UpdateResolverEndpoint]. +// +// [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 - // The IPv6 address that you want to use for DNS queries. + // The IPv6 address that you want to use for DNS queries. // // This member is required. Ipv6 *string diff --git a/service/rum/api_op_BatchCreateRumMetricDefinitions.go b/service/rum/api_op_BatchCreateRumMetricDefinitions.go index f4f362f20c2..cfbdb3a44d1 100644 --- a/service/rum/api_op_BatchCreateRumMetricDefinitions.go +++ b/service/rum/api_op_BatchCreateRumMetricDefinitions.go @@ -13,39 +13,53 @@ import ( // 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, +// 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]. +// +// In addition to these default metrics, you can choose to send extended metrics, // custom metrics, or both. +// // - Extended metrics let you send metrics with additional dimensions that // aren't included in the default metrics. You can also send extended metrics to // both Evidently and 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) -// . +// FileType , OSName , and PageId . For more information, see [Extended metrics that you can send to CloudWatch and CloudWatch Evidently]. +// // - Custom metrics are metrics that you define. You can send custom metrics to // CloudWatch. CloudWatch Evidently, or both. With custom metrics, you can use any // metric name and namespace. 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 . +// 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 +// 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]. +// +// You must have already created a destination for the metrics before you send +// them. For more information, see [PutRumMetricsDestination]. +// +// 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. +// +// [PutRumMetricsDestination]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html +// [Extended metrics that you can send to CloudWatch and CloudWatch Evidently]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html +// [CloudWatch metrics that you can collect with CloudWatch RUM]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html +// [Amazon CloudWatch Pricing]: https://aws.amazon.com/cloudwatch/pricing/ func (c *Client) BatchCreateRumMetricDefinitions(ctx context.Context, params *BatchCreateRumMetricDefinitionsInput, optFns ...func(*Options)) (*BatchCreateRumMetricDefinitionsOutput, error) { if params == nil { params = &BatchCreateRumMetricDefinitionsInput{} @@ -82,11 +96,13 @@ type BatchCreateRumMetricDefinitionsInput struct { 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 - // 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) - // . + // 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]. + // + // [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 8bc4915b5b7..bd32908451e 100644 --- a/service/rum/api_op_BatchDeleteRumMetricDefinitions.go +++ b/service/rum/api_op_BatchDeleteRumMetricDefinitions.go @@ -12,11 +12,14 @@ import ( ) // Removes the specified metrics from being sent to an extended metrics -// destination. If some metric definition IDs specified in a -// BatchDeleteRumMetricDefinitions operations are not valid, those metric -// definitions fail and return errors, but all valid metric definition IDs in the -// same operation are still deleted. The maximum number of metric definitions that -// you can specify in one BatchDeleteRumMetricDefinitions operation is 200. +// destination. +// +// If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions +// operations are not valid, those metric definitions fail and return errors, but +// all valid metric definition IDs in the same operation are still deleted. +// +// The maximum number of metric definitions that you can specify in one +// BatchDeleteRumMetricDefinitions operation is 200. func (c *Client) BatchDeleteRumMetricDefinitions(ctx context.Context, params *BatchDeleteRumMetricDefinitionsInput, optFns ...func(*Options)) (*BatchDeleteRumMetricDefinitionsOutput, error) { if params == nil { params = &BatchDeleteRumMetricDefinitionsInput{} @@ -53,8 +56,10 @@ type BatchDeleteRumMetricDefinitionsInput struct { 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 - // Evidently experiment that was receiving the metrics that are being deleted. + // 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 noSmithyDocumentSerde diff --git a/service/rum/api_op_BatchGetRumMetricDefinitions.go b/service/rum/api_op_BatchGetRumMetricDefinitions.go index 8c7e0558a65..04b29fb8946 100644 --- a/service/rum/api_op_BatchGetRumMetricDefinitions.go +++ b/service/rum/api_op_BatchGetRumMetricDefinitions.go @@ -42,13 +42,17 @@ type BatchGetRumMetricDefinitionsInput struct { 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 - // Evidently experiment that corresponds to the destination. + // 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 - // another call with the returned NextToken value. + // The maximum that you can specify is 100. + // + // To retrieve the remaining results, make another call with the returned NextToken + // value. MaxResults *int32 // Use the token returned by the previous operation to request the next page of @@ -165,8 +169,10 @@ var _ BatchGetRumMetricDefinitionsAPIClient = (*Client)(nil) // 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 - // another call with the returned NextToken value. + // The maximum 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/rum/api_op_CreateAppMonitor.go b/service/rum/api_op_CreateAppMonitor.go index 290a1c60ecc..5aaa1536985 100644 --- a/service/rum/api_op_CreateAppMonitor.go +++ b/service/rum/api_op_CreateAppMonitor.go @@ -14,11 +14,17 @@ import ( // Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from // 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) -// 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) +// behavior. +// +// You use this operation only to create a new app monitor. To update an existing +// app monitor, use [UpdateAppMonitor]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?] +// +// [UpdateAppMonitor]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_UpdateAppMonitor.html +// [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{} @@ -52,33 +58,44 @@ type CreateAppMonitorInput struct { // 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/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html) - // . If you omit this argument, the sample rate used for RUM is set to 10% of the + // more information, see [Authorize your application to send data to Amazon Web Services]. + // + // If you omit this argument, the sample rate used for RUM is set to 10% of the // user sessions. + // + // [Authorize your application to send data to Amazon Web Services]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/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. 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]. + // + // [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 . + // more than 30 days, but it does incur Amazon CloudWatch Logs charges. + // + // If you omit 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 - // 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) - // . + // 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]. + // + // [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_ListRumMetricsDestinations.go b/service/rum/api_op_ListRumMetricsDestinations.go index 294e8481f86..d1768535575 100644 --- a/service/rum/api_op_ListRumMetricsDestinations.go +++ b/service/rum/api_op_ListRumMetricsDestinations.go @@ -12,9 +12,11 @@ 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, for the specified app monitor. +// +// For more information about extended metrics, see [AddRumMetrics]. +// +// [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 +41,10 @@ type ListRumMetricsDestinationsInput struct { 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 - // another call with the returned NextToken value. + // The maximum that you can specify is 100. + // + // To retrieve the remaining results, make another call with the returned NextToken + // value. MaxResults *int32 // Use the token returned by the previous operation to request the next page of @@ -157,8 +161,10 @@ var _ ListRumMetricsDestinationsAPIClient = (*Client)(nil) // 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 - // another call with the returned NextToken value. + // The maximum 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/rum/api_op_PutRumEvents.go b/service/rum/api_op_PutRumEvents.go index 49af8df7652..2c971bf7a7c 100644 --- a/service/rum/api_op_PutRumEvents.go +++ b/service/rum/api_op_PutRumEvents.go @@ -13,8 +13,9 @@ import ( // Sends telemetry events about your application performance and user behavior to // CloudWatch RUM. The code snippet that RUM generates for you to add to your -// application includes PutRumEvents operations to send this data to RUM. Each -// PutRumEvents operation can send a batch of events from one user session. +// application includes PutRumEvents operations to send this data to RUM. +// +// Each PutRumEvents operation can send a batch of events from one user session. func (c *Client) PutRumEvents(ctx context.Context, params *PutRumEventsInput, optFns ...func(*Options)) (*PutRumEventsOutput, error) { if params == nil { params = &PutRumEventsInput{} diff --git a/service/rum/api_op_PutRumMetricsDestination.go b/service/rum/api_op_PutRumMetricsDestination.go index 5f8d3d846c3..03af4b5798e 100644 --- a/service/rum/api_op_PutRumMetricsDestination.go +++ b/service/rum/api_op_PutRumMetricsDestination.go @@ -13,9 +13,11 @@ 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) -// . +// experiment. +// +// For more information about extended metrics, see [BatchCreateRumMetricDefinitions]. +// +// [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{} @@ -51,13 +53,18 @@ type PutRumMetricsDestinationInput struct { DestinationArn *string // This parameter is required if Destination is Evidently . If Destination is - // CloudWatch , don't 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. - // If you specify this parameter, you must be signed on to a role that has PassRole (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) - // permissions attached to it, to allow the role to be passed. The - // CloudWatchAmazonCloudWatchRUMFullAccess (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html#managed-policies-cloudwatch-RUM) - // policy doesn't include PassRole permissions. + // CloudWatch , don't 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. + // + // If you specify this parameter, you must be signed on to a role that has [PassRole] + // permissions attached to it, to allow the role to be passed. The [CloudWatchAmazonCloudWatchRUMFullAccess]policy doesn't + // include PassRole permissions. + // + // [PassRole]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html + // [CloudWatchAmazonCloudWatchRUMFullAccess]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html#managed-policies-cloudwatch-RUM IamRoleArn *string noSmithyDocumentSerde diff --git a/service/rum/api_op_TagResource.go b/service/rum/api_op_TagResource.go index 2999c1fced2..6b7e907d6d3 100644 --- a/service/rum/api_op_TagResource.go +++ b/service/rum/api_op_TagResource.go @@ -11,18 +11,26 @@ import ( ) // Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM -// resource. Currently, the only resources that can be tagged app monitors. 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 -// specify a new tag key for the resource, this tag is appended to the list of tags -// 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) -// . +// resource. Currently, the only resources that can be tagged app monitors. +// +// 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 specify a new tag key for the resource, this tag is appended to the list of +// tags 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]. +// +// [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 b0f5a1efba0..26d887f4421 100644 --- a/service/rum/api_op_UpdateAppMonitor.go +++ b/service/rum/api_op_UpdateAppMonitor.go @@ -14,12 +14,20 @@ import ( // Updates the configuration of an existing app monitor. When you use this // 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 +// 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]. +// +// To create a new app monitor, use [CreateAppMonitor]. +// +// 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?] +// +// [CreateAppMonitor]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html +// [TagResource]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html +// [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{} @@ -47,15 +55,17 @@ type UpdateAppMonitorInput struct { // 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/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html) - // . + // more information, see [Authorize your application to send data to Amazon Web Services]. + // + // [Authorize your application to send data to Amazon Web Services]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/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]. + // + // [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 diff --git a/service/rum/api_op_UpdateRumMetricDefinition.go b/service/rum/api_op_UpdateRumMetricDefinition.go index 1e45ec5cac4..75a890a8858 100644 --- a/service/rum/api_op_UpdateRumMetricDefinition.go +++ b/service/rum/api_op_UpdateRumMetricDefinition.go @@ -12,9 +12,9 @@ import ( ) // 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) -// . +// For more information about extended metrics, see [BatchCreateRumMetricsDefinitions]. +// +// [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{} @@ -57,11 +57,13 @@ type UpdateRumMetricDefinitionInput struct { 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 - // 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) - // . + // 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]. + // + // [PutRumMetricsDestination]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html DestinationArn *string noSmithyDocumentSerde diff --git a/service/rum/doc.go b/service/rum/doc.go index cdd6e30634f..589928f41e7 100644 --- a/service/rum/doc.go +++ b/service/rum/doc.go @@ -8,10 +8,11 @@ // sessions in real time. The data collected includes page load times, client-side // errors, and user behavior. When you view this data, you can see it all // aggregated together and also see breakdowns by the browsers and devices that -// your customers use. You can use the collected data to quickly identify and debug -// client-side performance issues. CloudWatch RUM helps you visualize anomalies in -// your application performance and find relevant debugging data such as error -// messages, stack traces, and user sessions. You can also use RUM to understand -// the range of end-user impact including the number of users, geolocations, and -// browsers used. +// your customers use. +// +// You can use the collected data to quickly identify and debug client-side +// performance issues. CloudWatch RUM helps you visualize anomalies in your +// application performance and find relevant debugging data such as error messages, +// stack traces, and user sessions. You can also use RUM to understand the range of +// end-user impact including the number of users, geolocations, and browsers used. package rum diff --git a/service/rum/options.go b/service/rum/options.go index 707f7f1ad3f..d4cb845f470 100644 --- a/service/rum/options.go +++ b/service/rum/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/rum/types/enums.go b/service/rum/types/enums.go index 56fc5b0676a..2bba6d486ba 100644 --- a/service/rum/types/enums.go +++ b/service/rum/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for CustomEventsStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomEventsStatus) Values() []CustomEventsStatus { return []CustomEventsStatus{ "ENABLED", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for MetricDestination. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricDestination) Values() []MetricDestination { return []MetricDestination{ "CloudWatch", @@ -48,8 +50,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -71,8 +74,9 @@ const ( ) // 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. +// in the future, and so 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 a2297f15e89..b4b67039517 100644 --- a/service/rum/types/types.go +++ b/service/rum/types/types.go @@ -19,8 +19,11 @@ 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]. + // + // [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 @@ -64,12 +67,15 @@ type AppMonitorConfiguration struct { // 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?] + // + // [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 - // collection. You can't include both ExcludedPages and IncludedPages in the same - // operation. + // collection. + // + // You can't include both ExcludedPages and IncludedPages in the same operation. ExcludedPages []string // A list of pages in your application that are to be displayed with a "favorite" @@ -77,17 +83,23 @@ type AppMonitorConfiguration struct { FavoritePages []string // The ARN of the guest IAM role that is attached to the Amazon Cognito identity - // pool that is used to authorize the sending of data to RUM. It is possible that - // an app monitor does not have a value for GuestRoleArn . For example, this can - // happen when you use the console to create an app monitor and you allow - // CloudWatch RUM to create a new identity pool for Authorization. In this case, - // GuestRoleArn is not present in the GetAppMonitor (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_GetAppMonitor.html) - // response because it is not stored by the service. If this issue affects you, you - // can take one of the following steps: + // pool that is used to authorize the sending of data to RUM. + // + // It is possible that an app monitor does not have a value for GuestRoleArn . For + // example, this can happen when you use the console to create an app monitor and + // you allow CloudWatch RUM to create a new identity pool for Authorization. In + // this case, GuestRoleArn is not present in the [GetAppMonitor] response because it is not + // stored by the service. + // + // If this issue affects you, you can take one of the following steps: + // // - Use the Cloud Development Kit (CDK) to create an identity pool and the // associated IAM role, and use that for your app monitor. - // - Make a separate GetIdentityPoolRoles (https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetIdentityPoolRoles.html) - // call to Amazon Cognito to retrieve the GuestRoleArn . + // + // - Make a separate [GetIdentityPoolRoles]call to Amazon Cognito to retrieve the GuestRoleArn . + // + // [GetIdentityPoolRoles]: https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetIdentityPoolRoles.html + // [GetAppMonitor]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_GetAppMonitor.html GuestRoleArn *string // The ID of the Amazon Cognito identity pool that is used to authorize the @@ -95,25 +107,32 @@ type AppMonitorConfiguration struct { IdentityPoolId *string // If this app monitor is to collect data from only certain pages in your - // application, this structure lists those pages. You can't include both - // ExcludedPages and IncludedPages in the same operation. + // application, this structure lists those pages. + // + // You can't include both ExcludedPages and IncludedPages in the same operation. IncludedPages []string // Specifies the portion of user sessions to use for RUM data collection. Choosing - // a higher portion gives you more data but also incurs more costs. The range for - // this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user - // sessions are sampled, and setting it to 0.1 means that 10% of user sessions are - // sampled. If you omit this parameter, the default of 0.1 is used, and 10% of - // sessions will be sampled. + // a higher portion gives you more data but also incurs more costs. + // + // The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% + // of user sessions are sampled, and setting it to 0.1 means that 10% of user + // sessions are sampled. + // + // If you omit this parameter, the default of 0.1 is used, and 10% of sessions + // will be sampled. SessionSampleRate float64 // 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. Telemetries []Telemetry @@ -158,8 +177,9 @@ 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) -// operation. +// A structure that defines one error caused by a [BatchCreateRumMetricsDefinitions] operation. +// +// [BatchCreateRumMetricsDefinitions]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html type BatchCreateRumMetricDefinitionsError struct { // The error code. @@ -180,8 +200,9 @@ 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) -// operation. +// A structure that defines one error caused by a [BatchCreateRumMetricsDefinitions] operation. +// +// [BatchCreateRumMetricsDefinitions]: https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html type BatchDeleteRumMetricDefinitionsError struct { // The error code. @@ -240,9 +261,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]. +// +// [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. @@ -263,9 +284,10 @@ type MetricDefinition struct { // 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 - // specified dimensions. + // metric destination. + // + // 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 metric definition is for a custom metric instead of an extended metric, @@ -283,160 +305,230 @@ 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 Custom -// metrics and extended metrics that you can send to CloudWatch and CloudWatch -// Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-and-extended-metrics.html) -// . This structure is validated differently for extended metrics and custom +// send to CloudWatch or CloudWatch Evidently. For more information, see [Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently]. +// +// 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 following list, 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"]} +// // - If Name is PageViewCount , then ValueKey must be null and the EventPattern // must include {"event_type":["com.amazon.rum.page_view_event"]} +// // - If Name is Http4xxCount , then ValueKey must be null and the EventPattern // must include {"event_type": // ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",400,"<",500]}]}}} // } +// // - If Name is Http5xxCount , then ValueKey must be null and the EventPattern // must include {"event_type": // ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",500,"<=",599]}]}}} // } // // 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) -// . +// event details that correspond to event types, see [RUM event details]. +// // - 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 +// +// [RUM event details]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails +// [Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-and-extended-metrics.html 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 // // 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 - // with this metric in CloudWatch. For extended metrics, valid values for the - // entries in this field are the following: + // 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 . DimensionKeys map[string]string // The pattern that defines the metric, specified as a JSON object. 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. When you define extended - // metrics, the metric definition is not valid if EventPattern is omitted. Example - // event patterns: + // 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. EventPattern *string // If this structure is for a custom metric instead of an extended metrics, use // this parameter to define the metric namespace for that custom metric. Do not - // specify this parameter if this structure is for an extended metric. You cannot - // use any string that starts with AWS/ for your namespace. + // specify this parameter if this structure is for an extended metric. + // + // You cannot use any string that starts with AWS/ for your namespace. Namespace *string // The CloudWatch metric unit to use for this metric. If you omit this field, the // metric is recorded with no unit. UnitLabel *string - // The field within the event object that the metric value is sourced from. If you - // omit this field, a hardcoded value of 1 is pushed as the metric value. This is - // useful if you want to count the number of events that the filter catches. If - // this metric is sent to CloudWatch Evidently, this field will be passed to + // The field within the event object that the metric value is sourced from. + // + // If you omit this field, a hardcoded value of 1 is pushed as the metric value. + // This is useful if you want to count the number of events that the filter + // catches. + // + // If this metric is sent to CloudWatch Evidently, this field will be passed to // Evidently raw. Evidently will handle data extraction from the event. ValueKey *string @@ -464,17 +556,21 @@ 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 - // the Name and Values that you specify. Valid values for Name are Browser | Device - // | Country | Page | OS | EventType | Invert + // the Name and Values that you specify. + // + // Valid values for Name are Browser | Device | Country | Page | OS | EventType | + // Invert Name *string // The values of the Name that are to be be included in the returned results. diff --git a/service/s3/api_op_AbortMultipartUpload.go b/service/s3/api_op_AbortMultipartUpload.go index c71060e0822..c10e4987035 100644 --- a/service/s3/api_op_AbortMultipartUpload.go +++ b/service/s3/api_op_AbortMultipartUpload.go @@ -18,22 +18,27 @@ import ( // by any previously uploaded parts will be freed. However, if any part uploads are // currently in progress, those part uploads might or might not succeed. As a // 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 and prevent getting charged for the part storage, -// you should call the ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) -// API operation and ensure that the parts list is empty. Directory buckets - For -// directory buckets, you must make requests for this API operation to the Zonal -// endpoint. These endpoints support virtual-hosted-style requests in the format +// in order to completely free all storage consumed by all parts. +// +// To verify that all parts have been removed and prevent getting charged for the +// part storage, you should call the [ListParts]API operation and ensure that the parts list +// is empty. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - 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) -// in the Amazon S3 User Guide. +// required to use the multipart upload, see [Multipart Upload and Permissions]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -41,17 +46,31 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to AbortMultipartUpload : +// +// [CreateMultipartUpload] +// +// [UploadPart] +// +// [CompleteMultipartUpload] +// +// [ListParts] // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// [ListMultipartUploads] +// +// [ListParts]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [ListMultipartUploads]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [Multipart Upload and Permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipartUploadInput, optFns ...func(*Options)) (*AbortMultipartUploadOutput, error) { if params == nil { params = &AbortMultipartUploadInput{} @@ -69,31 +88,39 @@ func (c *Client) AbortMultipartUpload(ctx context.Context, params *AbortMultipar type AbortMultipartUploadInput struct { - // The bucket name to which the upload was taking place. Directory buckets - When - // you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // The bucket name to which the upload was taking place. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -117,10 +144,12 @@ type AbortMultipartUploadInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer noSmithyDocumentSerde @@ -135,7 +164,9 @@ func (in *AbortMultipartUploadInput) bindEndpointParams(p *EndpointParameters) { type AbortMultipartUploadOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_CompleteMultipartUpload.go b/service/s3/api_op_CompleteMultipartUpload.go index 8f89d780eed..1bdf3c6ab66 100644 --- a/service/s3/api_op_CompleteMultipartUpload.go +++ b/service/s3/api_op_CompleteMultipartUpload.go @@ -13,51 +13,59 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 or the UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) -// operation. After successfully uploading all relevant parts of an upload, you -// call this CompleteMultipartUpload operation 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 CompleteMultipartUpload request, -// you must provide the parts list and ensure that the parts list is complete. The -// CompleteMultipartUpload API operation concatenates the parts that you provide in -// the list. For each part in the list, you must provide the PartNumber value and -// the ETag value that are returned after that part was uploaded. The processing -// of a CompleteMultipartUpload request could take several minutes to finalize. -// After Amazon S3 begins processing the request, it sends an HTTP response header -// that specifies a 200 OK response. While processing is in progress, Amazon S3 -// periodically sends white space characters to keep the connection from timing -// out. A request could fail after the initial 200 OK response has been sent. This -// means that a 200 OK response can contain either a success or an error. The -// error response might be embedded in the 200 OK response. If you call this API -// operation 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 throw an -// exception (or, for the SDKs that don't use exceptions, they return an error). +// Completes a multipart upload by assembling previously uploaded parts. +// +// You first initiate the multipart upload and then upload all parts using the [UploadPart] +// operation or the [UploadPartCopy]operation. After successfully uploading all relevant parts of +// an upload, you call this CompleteMultipartUpload operation 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 +// CompleteMultipartUpload request, you must provide the parts list and ensure that +// the parts list is complete. The CompleteMultipartUpload API operation +// concatenates the parts that you provide in the list. For each part in the list, +// you must provide the PartNumber value and the ETag value that are returned +// after that part was uploaded. +// +// The processing of a CompleteMultipartUpload request could take several minutes +// to finalize. After Amazon S3 begins processing the request, it sends an HTTP +// response header that specifies a 200 OK response. While processing is in +// progress, Amazon S3 periodically sends white space characters to keep the +// connection from timing out. A request could fail after the initial 200 OK +// response has been sent. This means that a 200 OK response can contain either a +// success or an error. The error response might be embedded in the 200 OK +// response. If you call this API operation 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 throw an exception (or, for the SDKs that don't use +// exceptions, they return an error). +// // Note that if CompleteMultipartUpload fails, applications should be prepared to // retry any failed requests (including 500 error responses). For more information, -// see Amazon S3 Error Best Practices (https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html) -// . You can't use Content-Type: application/x-www-form-urlencoded for the +// see [Amazon S3 Error Best Practices]. +// +// You can't use Content-Type: application/x-www-form-urlencoded for the // CompleteMultipartUpload requests. Also, if you don't provide a Content-Type -// header, CompleteMultipartUpload can still return 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) -// in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must -// make requests for this API operation to the Zonal endpoint. These endpoints -// support virtual-hosted-style requests in the format +// header, CompleteMultipartUpload can still return a 200 OK response. +// +// For more information about multipart uploads, see [Uploading Objects Using Multipart Upload] in the Amazon S3 User Guide. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - 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. +// required to use the multipart upload API, see [Multipart Upload and Permissions]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -65,36 +73,65 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // // 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. +// // - HTTP Status Code: 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 ETag might not have matched // the uploaded part's ETag. +// // - HTTP Status Code: 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. +// // - HTTP Status Code: 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. +// // - HTTP Status Code: 404 Not Found // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to CompleteMultipartUpload : +// +// [CreateMultipartUpload] +// +// [UploadPart] +// +// [AbortMultipartUpload] +// +// [ListParts] +// +// [ListMultipartUploads] +// +// [Uploading Objects Using Multipart Upload]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html +// [Amazon S3 Error Best Practices]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.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 +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [ListMultipartUploads]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [UploadPartCopy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html +// [Multipart Upload and Permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMultipartUploadInput, optFns ...func(*Options)) (*CompleteMultipartUploadOutput, error) { if params == nil { params = &CompleteMultipartUploadInput{} @@ -112,31 +149,39 @@ func (c *Client) CompleteMultipartUpload(ctx context.Context, params *CompleteMu type CompleteMultipartUploadInput struct { - // Name of the bucket to which the multipart upload was initiated. Directory - // buckets - When you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // Name of the bucket to which the multipart upload was initiated. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -153,30 +198,34 @@ 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) + // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 32-bit CRC32C checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA256 *string // The account ID of the expected bucket owner. If the account ID that you provide @@ -191,32 +240,40 @@ type CompleteMultipartUploadInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The server-side encryption (SSE) algorithm used to encrypt the object. This // parameter is required only when the object was created using a checksum // algorithm or if your bucket policy requires the use of SSE-C. For more - // information, see Protecting data using SSE-C keys (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html SSECustomerKeyMD5 *string noSmithyDocumentSerde @@ -231,13 +288,15 @@ func (in *CompleteMultipartUploadInput) bindEndpointParams(p *EndpointParameters type CompleteMultipartUploadOutput struct { // The name of the bucket that contains the newly created object. Does not return - // the access point ARN or access point alias if used. Access points are not - // supported by directory buckets. + // the access point ARN or access point alias if used. + // + // Access points are not supported by directory buckets. Bucket *string // Indicates whether the multipart upload uses an S3 Bucket Key for server-side - // encryption with Key Management Service (KMS) keys (SSE-KMS). This functionality - // is not supported for directory buckets. + // encryption with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be @@ -245,8 +304,10 @@ type CompleteMultipartUploadOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -254,8 +315,10 @@ type CompleteMultipartUploadOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -263,8 +326,10 @@ type CompleteMultipartUploadOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -272,8 +337,10 @@ type CompleteMultipartUploadOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string // Entity tag that identifies the newly created object's data. Objects with @@ -282,12 +349,14 @@ 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) - // in the Amazon S3 User Guide. + // is calculated, see [Checking object integrity]in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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. + // // This functionality is not supported for directory buckets. Expiration *string @@ -298,21 +367,28 @@ type CompleteMultipartUploadOutput struct { Location *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 - // (for example, AES256 , aws:kms ). For directory buckets, only server-side - // encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. + // (for example, AES256 , aws:kms ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. ServerSideEncryption types.ServerSideEncryption // Version ID of the newly created object, in case the bucket has versioning - // turned on. This functionality is not supported for directory buckets. + // turned on. + // + // This functionality is not supported for directory buckets. 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 c7990bab1de..bae0b7cb499 100644 --- a/service/s3/api_op_CopyObject.go +++ b/service/s3/api_op_CopyObject.go @@ -15,102 +15,134 @@ import ( "time" ) -// Creates a copy of an object that is already stored in Amazon S3. You can store -// individual objects of up to 5 TB in Amazon S3. You create a copy of your object -// 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) -// . You can copy individual objects between general purpose buckets, between +// Creates a copy of an object that is already stored in Amazon S3. +// +// You can store individual objects of up to 5 TB in Amazon S3. You create a copy +// of your object 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]. +// +// You can copy individual objects between general purpose buckets, between // directory buckets, and between general purpose buckets and directory buckets. +// // Directory buckets - For directory buckets, you must make requests for this API // operation to the Zonal endpoint. These endpoints support virtual-hosted-style // requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. 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. For more information about how to enable a Region for your account, see -// Enable or disable a Region for standalone accounts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone) -// in the Amazon Web Services Account Management Guide. 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) -// . Authentication and authorization All CopyObject requests must be -// authenticated and signed by using IAM credentials (access key ID and secret -// access key for the IAM identities). All headers with the x-amz- prefix, -// including x-amz-copy-source , must be signed. For more information, see REST -// Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) -// . Directory buckets - You must use the IAM credentials to authenticate and +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// 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. For more +// information about how to enable a Region for your account, see [Enable or disable a Region for standalone accounts]in the Amazon +// Web Services Account Management Guide. +// +// 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]. +// +// Authentication and authorization All CopyObject requests must be authenticated +// and signed by using IAM credentials (access key ID and secret access key for the +// IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source +// , must be signed. For more information, see [REST Authentication]. +// +// Directory buckets - You must use the IAM credentials to authenticate and // authorize your access to the CopyObject API operation, instead of using the -// temporary security credentials through the CreateSession API operation. Amazon -// Web Services CLI or SDKs handles authentication and authorization on your -// behalf. Permissions You must have read access to the source object and write -// access to the destination bucket. +// temporary security credentials through the CreateSession API operation. +// +// Amazon Web Services CLI or SDKs handles authentication and authorization on +// your behalf. +// +// Permissions You must have read access to the source object and write access to +// the destination bucket. +// // - General purpose bucket permissions - You must have permissions in an IAM // policy based on the source and destination bucket types in a CopyObject // operation. +// // - If the source object is in a general purpose bucket, you must have // s3:GetObject permission to read the source object that is being copied. +// // - If the destination bucket is a general purpose bucket, you must have // s3:PutObject permission to write the object copy to the destination bucket. +// // - Directory bucket permissions - You must have permissions in a bucket policy // or an IAM identity-based policy based on the source and destination bucket types // in a CopyObject operation. +// // - If the source object that you want to copy is in a directory bucket, you // must have the s3express:CreateSession permission in the Action element of a // policy to read the object. By default, the session is in the ReadWrite mode. // If you want to restrict the access, you can explicitly set the // s3express:SessionMode condition key to ReadOnly on the copy source bucket. +// // - If the copy destination is a directory bucket, you must have the // s3express:CreateSession permission in the Action element of a policy to write // the object to the destination. The s3express:SessionMode condition key can't -// be set to ReadOnly on the copy destination bucket. For example policies, see -// Example bucket policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// and Amazon Web Services Identity and Access Management (IAM) identity-based -// policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html) -// in the Amazon S3 User Guide. +// be set to ReadOnly on the copy destination bucket. +// +// For example policies, see [Example bucket policies for S3 Express One Zone]and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]in the Amazon S3 User Guide. // // Response and special errors When the request is an HTTP 1.1 request, the // response is chunk encoded. When the request is not an HTTP 1.1 request, the // response would not contain the Content-Length . You always need to read the // entire response body to check if the copy succeeds. to keep the connection alive // while we copy the data. +// // - If the copy is successful, you receive a response with information about // the copied object. +// // - A copy request might return an error when Amazon S3 receives the copy // request or while Amazon S3 is copying the files. A 200 OK response can contain // either a success or an error. +// // - 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. For example, in a cross-region copy, you may -// encounter throttling and receive a 200 OK response. For more information, see -// Resolve the Error 200 response when copying objects to Amazon S3 (https://repost.aws/knowledge-center/s3-resolve-200-internalerror) +// encounter throttling and receive a 200 OK response. For more information, see [Resolve the Error 200 response when copying objects to Amazon S3] // . The 200 OK status code means the copy was accepted, but it doesn't mean the // copy is complete. Another example is when you disconnect from Amazon S3 before // the copy is complete, Amazon S3 might cancel the copy and you may receive a // 200 OK response. You must stay connected to Amazon S3 until the entire -// response is successfully received and processed. If you call this API operation -// directly, make sure to design your application to parse the content 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 throw an exception -// (or, for the SDKs that don't use exceptions, they return an error). +// response is successfully received and processed. +// +// If you call this API operation directly, make sure to design your application +// +// to parse the content 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 throw an exception (or, for the SDKs that don't use +// exceptions, they return an error). // // Charge The copy request charge is based on the storage class and Region that // you specify for the destination object. The request can also result in a data // retrieval charge for the source if the source storage class bills for data // retrieval. If the copy source is in a different region, the data transfer is -// billed to the copy source account. For pricing information, see Amazon S3 -// pricing (http://aws.amazon.com/s3/pricing/) . HTTP Host header syntax Directory -// buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// billed to the copy source account. For pricing information, see [Amazon S3 pricing]. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to CopyObject : +// +// [PutObject] +// +// [GetObject] +// +// [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html +// [Resolve the Error 200 response when copying objects to Amazon S3]: https://repost.aws/knowledge-center/s3-resolve-200-internalerror +// [Copy Object Using the REST Multipart Upload API]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html +// [REST Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html +// [Example bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Enable or disable a Region for standalone accounts]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone +// [Transfer Acceleration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.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 +// [Amazon S3 pricing]: http://aws.amazon.com/s3/pricing/ func (c *Client) CopyObject(ctx context.Context, params *CopyObjectInput, optFns ...func(*Options)) (*CopyObjectOutput, error) { if params == nil { params = &CopyObjectInput{} @@ -128,31 +160,39 @@ func (c *Client) CopyObject(ctx context.Context, params *CopyObjectInput, optFns type CopyObjectInput struct { - // The name of the destination bucket. Directory buckets - When you use this - // operation with a directory bucket, you must use virtual-hosted-style requests in - // the format Bucket_name.s3express-az_id.region.amazonaws.com . Path-style - // requests are not supported. Directory bucket names must be unique in the chosen - // Availability Zone. Bucket names must follow the format - // bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // The name of the destination bucket. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format + // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not + // supported. Directory bucket names must be unique in the chosen Availability + // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for + // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -160,10 +200,11 @@ type CopyObjectInput struct { // Specifies the source object for the copy operation. The source object can be up // to 5 GB. If the source object is an object that was uploaded by using a // multipart upload, the object copy will be a single part object after the source - // object is copied to the destination bucket. You specify the value of the copy - // source 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) - // : + // object is copied to the destination bucket. + // + // You specify the value of the copy source in one of two formats, depending on + // whether you want to access the source object through an [access point]: + // // - 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 general purpose @@ -172,6 +213,7 @@ type CopyObjectInput struct { // bucket awsexamplebucket--use1-az5--x-s3 , use // awsexamplebucket--use1-az5--x-s3/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 @@ -179,15 +221,20 @@ type CopyObjectInput struct { // 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. - // - Access points are not supported by directory buckets. 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 + // + // - Access points are not supported by directory buckets. + // + // 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. + // // If your source bucket versioning is enabled, the x-amz-copy-source header by // default 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 @@ -195,14 +242,21 @@ type CopyObjectInput struct { // 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. If you enable versioning on the destination bucket, Amazon S3 - // generates a unique version ID for the copied object. 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 destination - // bucket, the version ID that Amazon S3 generates in the x-amz-version-id - // response header is always null. Directory buckets - S3 Versioning isn't enabled - // and supported for directory buckets. + // source object. + // + // If you enable versioning on the destination bucket, Amazon S3 generates a + // unique version ID for the copied object. 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 destination bucket, the + // version ID that Amazon S3 generates in the x-amz-version-id response header is + // always null. + // + // Directory buckets - S3 Versioning isn't enabled and supported for directory + // buckets. + // + // [access point]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html // // This member is required. CopySource *string @@ -212,51 +266,67 @@ type CopyObjectInput struct { // This member is required. Key *string - // The canned access control list (ACL) to apply to the object. When you copy an - // object, the ACL metadata is not preserved and is set to private by default. - // Only the owner has full access control. To override the default ACL setting, - // specify a new ACL when you generate a copy request. For more information, see - // Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) - // . If the destination bucket that you're copying objects to uses the bucket owner + // The canned access control list (ACL) to apply to the object. + // + // When you copy an object, the ACL metadata is not preserved and is set to private + // by default. Only the owner has full access control. To override the default ACL + // setting, specify a new ACL when you generate a copy request. For more + // information, see [Using ACLs]. + // + // If the destination 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. + // ACL expressed in the XML format. For more information, see [Controlling ownership of objects and disabling ACLs]in the Amazon S3 + // User Guide. + // // - If your destination 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. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Using ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html + // [Controlling ownership of objects and disabling ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html ACL types.ObjectCannedACL // Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption // with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). // If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. + // // Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object // encryption with SSE-KMS. Specifying this header with a COPY action doesn’t - // affect bucket-level settings for S3 Bucket Key. 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. This functionality is not supported when the - // destination bucket is a directory bucket. + // affect bucket-level settings for S3 Bucket Key. + // + // For more information, see [Amazon S3 Bucket Keys] in the Amazon S3 User Guide. + // + // This functionality is not supported when the destination bucket is a directory + // bucket. + // + // [Amazon S3 Bucket Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html BucketKeyEnabled *bool // Specifies the caching behavior along the request/reply chain. CacheControl *string // Indicates the algorithm that 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. When you copy an object, if the source object has a - // checksum, that checksum value will be copied to the new object by default. If - // the CopyObject request does not include this x-amz-checksum-algorithm header, - // the checksum algorithm will be copied from the source object to the destination - // object (if it's present on the source object). You can optionally specify a - // different checksum algorithm to use with the x-amz-checksum-algorithm header. - // Unrecognized or unsupported values will respond with the HTTP status code 400 - // Bad Request . For directory buckets, when you use Amazon Web Services SDKs, - // CRC32 is the default checksum algorithm that's used for performance. + // for the object. For more information, see [Checking object integrity]in the Amazon S3 User Guide. + // + // When you copy an object, if the source object has a checksum, that checksum + // value will be copied to the new object by default. If the CopyObject request + // does not include this x-amz-checksum-algorithm header, the checksum algorithm + // will be copied from the source object to the destination object (if it's present + // on the source object). You can optionally specify a different checksum algorithm + // to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported + // values will respond with the HTTP status code 400 Bad Request . + // + // For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the + // default checksum algorithm that's used for performance. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // Specifies presentational information for the object. Indicates whether an @@ -266,8 +336,10 @@ type CopyObjectInput struct { // 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 directory buckets, only the aws-chunked value is - // supported in this header field. + // Content-Type header field. + // + // For directory buckets, only the aws-chunked value is supported in this header + // field. ContentEncoding *string // The language the content is in. @@ -276,62 +348,85 @@ type CopyObjectInput struct { // A standard MIME type that describes the format of the object data. ContentType *string - // Copies the object if its entity tag (ETag) matches the specified tag. If both - // the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since + // Copies the object if its entity tag (ETag) matches the specified tag. + // + // 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 CopySourceIfMatch *string - // Copies the object if it has been modified since the specified time. 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: + // Copies the object if it has been modified since the specified time. + // + // 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 CopySourceIfModifiedSince *time.Time - // Copies the object if its entity tag (ETag) is different than the specified - // ETag. If both the x-amz-copy-source-if-none-match and + // Copies the object if its entity tag (ETag) is different than the specified ETag. + // + // 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 CopySourceIfNoneMatch *string - // Copies the object if it hasn't been modified since the specified time. If both - // the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since + // Copies the object if it hasn't been modified since the specified time. + // + // 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 CopySourceIfUnmodifiedSince *time.Time // Specifies the algorithm to use when decrypting the source object (for example, - // AES256 ). If the source 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. This functionality is not - // supported when the source object is in a directory bucket. + // AES256 ). + // + // If the source 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. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceSSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use to decrypt // the source object. The encryption key provided in this header must be the same - // one that was used when the source object was created. If the source 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. This functionality is not supported when the source object is in a - // directory bucket. + // one that was used when the source object was created. + // + // If the source 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. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceSSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. If the source 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. This functionality is not supported when the source object is in a - // directory bucket. + // encryption key was transmitted without error. + // + // If the source 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. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceSSECustomerKeyMD5 *string // The account ID of the expected destination bucket owner. If the account ID that @@ -348,22 +443,30 @@ type CopyObjectInput struct { Expires *time.Time // Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantFullControl *string // Allows grantee to read the object data and its metadata. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantRead *string // Allows grantee to read the object ACL. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantReadACP *string // Allows grantee to write the ACL for the applicable object. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantWriteACP *string @@ -373,26 +476,32 @@ type CopyObjectInput struct { // Specifies whether the metadata is copied from the source object or replaced // with metadata that's provided in the request. When copying an object, you can // preserve all metadata (the default) or specify new metadata. If this header - // isn’t specified, COPY is the default behavior. General purpose bucket - For - // general purpose buckets, 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 Amazon S3 condition key - // examples (https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) - // in the Amazon S3 User Guide. x-amz-website-redirect-location is unique to each - // object and is not copied when using the x-amz-metadata-directive header. To - // copy the value, you must specify x-amz-website-redirect-location in the request - // header. + // isn’t specified, COPY is the default behavior. + // + // General purpose bucket - For general purpose buckets, 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 [Amazon S3 condition key examples]in the Amazon S3 User Guide. + // + // x-amz-website-redirect-location is unique to each object and is not copied when + // using the x-amz-metadata-directive header. To copy the value, you must specify + // x-amz-website-redirect-location in the request header. + // + // [Amazon S3 condition key examples]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html MetadataDirective types.MetadataDirective - // Specifies whether you want to apply a legal hold to the object copy. This - // functionality is not supported for directory buckets. + // Specifies whether you want to apply a legal hold to the object copy. + // + // This functionality is not supported for directory buckets. ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - // The Object Lock mode that you want to apply to the object copy. This - // functionality is not supported for directory buckets. + // The Object Lock mode that you want to apply to the object copy. + // + // This functionality is not supported for directory buckets. ObjectLockMode types.ObjectLockMode // The date and time when you want the Object Lock of the object copy to expire. + // // This functionality is not supported for directory buckets. ObjectLockRetainUntilDate *time.Time @@ -400,19 +509,23 @@ type CopyObjectInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, AES256 - // ). When you perform a CopyObject operation, if you want to use a different type - // of encryption setting for the target object, you can specify appropriate + // Specifies the algorithm to use when encrypting the object (for example, AES256 ). + // + // When you perform a CopyObject operation, if you want to use a different type of + // encryption setting for the target object, you can specify appropriate // encryption-related headers to encrypt the target object with an Amazon S3 // managed key, a KMS key, or a 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. + // // This functionality is not supported when the destination bucket is a directory // bucket. SSECustomerAlgorithm *string @@ -421,38 +534,49 @@ type CopyObjectInput 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 functionality is - // not supported when the destination bucket is a directory bucket. + // x-amz-server-side-encryption-customer-algorithm header. + // + // This functionality is not supported when the destination bucket is a directory + // bucket. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported when the destination bucket is a directory bucket. + // encryption key was transmitted without error. + // + // This functionality is not supported when the destination bucket is a directory + // bucket. SSECustomerKeyMD5 *string // Specifies the Amazon Web Services KMS Encryption Context to use for object // encryption. The value of this header is a base64-encoded UTF-8 string holding // JSON with the encryption context key-value pairs. This value must be explicitly - // added to specify encryption context for CopyObject requests. This functionality - // is not supported when the destination bucket is a directory bucket. + // added to specify encryption context for CopyObject requests. + // + // This functionality is not supported when the destination bucket is a directory + // bucket. SSEKMSEncryptionContext *string // Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object // encryption. All GET and PUT requests for an object protected by KMS will fail if // they're not made via SSL or using SigV4. For information about configuring 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) - // in the Amazon S3 User Guide. This functionality is not supported when the - // destination bucket is a directory bucket. + // CLI, see [Specifying the Signature Version in Request Authentication]in the Amazon S3 User Guide. + // + // This functionality is not supported when the destination bucket is a directory + // bucket. + // + // [Specifying the Signature Version in Request Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version SSEKMSKeyId *string // The server-side encryption algorithm used when storing this object in Amazon S3 // (for example, AES256 , aws:kms , aws:kms:dsse ). Unrecognized or unsupported // values won’t write a destination object and will receive a 400 Bad Request - // response. 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 target object is set to the + // response. + // + // 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 target object is set to the // default encryption configuration of the destination bucket. By default, all // buckets have a base level of encryption configuration that uses server-side // encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a @@ -460,42 +584,55 @@ type CopyObjectInput struct { // Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with // Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with // customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS - // key, or a customer-provided key to encrypt the target object copy. When you - // perform a CopyObject operation, if you want to use a different type of + // key, or a customer-provided key to encrypt the target object copy. + // + // When you perform a CopyObject operation, if you want to use a different type of // encryption setting for the target object, you can specify appropriate // encryption-related headers to encrypt the target object with an Amazon S3 // managed key, a KMS key, or a 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. - // With server-side encryption, Amazon S3 encrypts your data as it writes your data - // to disks in its data centers and decrypts the data when you access it. For more - // information about server-side encryption, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) - // in the Amazon S3 User Guide. For directory buckets, only server-side encryption - // with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. + // + // With server-side encryption, Amazon S3 encrypts your data as it writes your + // data to disks in its data centers and decrypts the data when you access it. For + // more information about server-side encryption, see [Using Server-Side Encryption]in the Amazon S3 User Guide. + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. + // + // [Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html ServerSideEncryption types.ServerSideEncryption // If the x-amz-storage-class header is not used, the copied object will be stored // in the STANDARD Storage Class by default. The STANDARD storage class provides // high durability and high availability. Depending on performance needs, you can // specify a different Storage Class. + // // - Directory buckets - For directory buckets, only the S3 Express One Zone // storage class is supported to store newly created objects. Unsupported storage // class values won't write a destination object and will respond with the HTTP // status code 400 Bad Request . + // // - Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class. + // // You can use the CopyObject action to change the storage class of an object that // is already stored in Amazon S3 by using the x-amz-storage-class header. For - // more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) - // in the Amazon S3 User Guide. Before using an object as a source object for the - // copy operation, you must restore a copy of it if it meets any of the following - // conditions: + // more information, see [Storage Classes]in the Amazon S3 User Guide. + // + // Before using an object as a source object for the copy operation, you must + // restore a copy of it if it meets any of the following conditions: + // // - The storage class of the source object is GLACIER or DEEP_ARCHIVE . - // - The storage class of the source object is INTELLIGENT_TIERING and it's S3 - // Intelligent-Tiering access tier (https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition) - // is Archive Access or Deep Archive Access . - // For more information, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) - // and Copying Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html) - // in the Amazon S3 User Guide. + // + // - The storage class of the source object is INTELLIGENT_TIERING and it's [S3 Intelligent-Tiering access tier]is + // Archive Access or Deep Archive Access . + // + // For more information, see [RestoreObject] and [Copying Objects] in the Amazon S3 User Guide. + // + // [Storage Classes]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html + // [RestoreObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html + // [Copying Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html + // [S3 Intelligent-Tiering access tier]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition StorageClass types.StorageClass // The tag-set for the object copy in the destination bucket. This value must be @@ -503,60 +640,82 @@ type CopyObjectInput struct { // the x-amz-tagging-directive . If you choose COPY for the x-amz-tagging-directive // , you don't need to set the x-amz-tagging header, because the tag-set will be // copied from the source object directly. The tag-set must be encoded as URL Query - // parameters. The default value is the empty value. Directory buckets - For - // directory buckets in a CopyObject operation, only the empty tag-set is - // supported. Any requests that attempt to write non-empty tags into directory - // buckets will receive a 501 Not Implemented status code. When the destination - // bucket is a directory bucket, you will receive a 501 Not Implemented response - // in any of the following situations: + // parameters. + // + // The default value is the empty value. + // + // Directory buckets - For directory buckets in a CopyObject operation, only the + // empty tag-set is supported. Any requests that attempt to write non-empty tags + // into directory buckets will receive a 501 Not Implemented status code. When the + // destination bucket is a directory bucket, you will receive a 501 Not Implemented + // response in any of the following situations: + // // - When you attempt to COPY the tag-set from an S3 source object that has // non-empty tags. + // // - When you attempt to REPLACE the tag-set of a source object and set a // non-empty value to x-amz-tagging . + // // - When you don't set the x-amz-tagging-directive header and the source object // has non-empty tags. This is because the default value of // x-amz-tagging-directive is COPY . + // // Because only the empty tag-set is supported for directory buckets in a // CopyObject operation, the following situations are allowed: + // // - When you attempt to COPY the tag-set from a directory bucket source object // that has no tags to a general purpose bucket. It copies an empty tag-set to the // destination object. + // // - When you attempt to REPLACE the tag-set of a directory bucket source object // and set the x-amz-tagging value of the directory bucket destination object to // empty. + // // - When you attempt to REPLACE the tag-set of a general purpose bucket source // object that has non-empty tags and set the x-amz-tagging value of the // directory bucket destination object to empty. + // // - When you attempt to REPLACE the tag-set of a directory bucket source object // and don't set the x-amz-tagging value of the directory bucket destination // object. This is because the default value of x-amz-tagging is the empty value. Tagging *string // Specifies whether the object tag-set is copied from the source object or - // replaced with the tag-set that's provided in the request. The default value is - // COPY . Directory buckets - For directory buckets in a CopyObject operation, - // only the empty tag-set is supported. Any requests that attempt to write - // non-empty tags into directory buckets will receive a 501 Not Implemented status - // code. When the destination bucket is a directory bucket, you will receive a 501 - // Not Implemented response in any of the following situations: + // replaced with the tag-set that's provided in the request. + // + // The default value is COPY . + // + // Directory buckets - For directory buckets in a CopyObject operation, only the + // empty tag-set is supported. Any requests that attempt to write non-empty tags + // into directory buckets will receive a 501 Not Implemented status code. When the + // destination bucket is a directory bucket, you will receive a 501 Not Implemented + // response in any of the following situations: + // // - When you attempt to COPY the tag-set from an S3 source object that has // non-empty tags. + // // - When you attempt to REPLACE the tag-set of a source object and set a // non-empty value to x-amz-tagging . + // // - When you don't set the x-amz-tagging-directive header and the source object // has non-empty tags. This is because the default value of // x-amz-tagging-directive is COPY . + // // Because only the empty tag-set is supported for directory buckets in a // CopyObject operation, the following situations are allowed: + // // - When you attempt to COPY the tag-set from a directory bucket source object // that has no tags to a general purpose bucket. It copies an empty tag-set to the // destination object. + // // - When you attempt to REPLACE the tag-set of a directory bucket source object // and set the x-amz-tagging value of the directory bucket destination object to // empty. + // // - When you attempt to REPLACE the tag-set of a general purpose bucket source // object that has non-empty tags and set the x-amz-tagging value of the // directory bucket destination object to empty. + // // - When you attempt to REPLACE the tag-set of a directory bucket source object // and don't set the x-amz-tagging value of the directory bucket destination // object. This is because the default value of x-amz-tagging is the empty value. @@ -567,8 +726,9 @@ type CopyObjectInput struct { // Amazon S3 stores the value of this header in the object metadata. This value is // unique to each object and is not copied when using the x-amz-metadata-directive // header. Instead, you may opt to provide this header in combination with the - // x-amz-metadata-directive header. This functionality is not supported for - // directory buckets. + // x-amz-metadata-directive header. + // + // This functionality is not supported for directory buckets. WebsiteRedirectLocation *string noSmithyDocumentSerde @@ -582,56 +742,68 @@ func (in *CopyObjectInput) bindEndpointParams(p *EndpointParameters) { type CopyObjectOutput struct { // Indicates whether the copied object uses an S3 Bucket Key for server-side - // encryption with Key Management Service (KMS) keys (SSE-KMS). This functionality - // is not supported for directory buckets. + // encryption with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // Container for all response elements. CopyObjectResult *types.CopyObjectResult - // Version ID of the source object that was copied. This functionality is not - // supported when the source object is in a directory bucket. + // Version ID of the source object that was copied. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceVersionId *string - // If the object expiration is configured, the response includes this header. This - // functionality is not supported for directory buckets. + // If the object expiration is configured, the response includes this header. + // + // This functionality is not supported for directory buckets. Expiration *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the Amazon Web Services KMS Encryption Context to use for // object encryption. The value of this header is a base64-encoded UTF-8 string - // holding JSON with the encryption context key-value pairs. This functionality is - // not supported for directory buckets. + // holding JSON with the encryption context key-value pairs. + // + // This functionality is not supported for directory buckets. SSEKMSEncryptionContext *string // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). For directory buckets, only - // server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is - // supported. + // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. ServerSideEncryption types.ServerSideEncryption - // Version ID of the newly created copy. This functionality is not supported for - // directory buckets. + // Version ID of the newly created copy. + // + // This functionality is not supported for directory buckets. VersionId *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_CreateBucket.go b/service/s3/api_op_CreateBucket.go index b39244bcfe6..34174b23201 100644 --- a/service/s3/api_op_CreateBucket.go +++ b/service/s3/api_op_CreateBucket.go @@ -15,89 +15,116 @@ import ( ) // This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts -// bucket, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html) -// . Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 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. There are two types of buckets: general purpose -// buckets and directory buckets. For more information about these bucket types, -// see Creating, configuring, and working with Amazon S3 buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) -// in the Amazon S3 User Guide. +// bucket, see [CreateBucket]CreateBucket . +// +// Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 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. +// +// There are two types of buckets: general purpose buckets and directory buckets. +// For more information about these bucket types, see [Creating, configuring, and working with Amazon S3 buckets]in the Amazon S3 User Guide. +// // - General purpose buckets - If you send your CreateBucket request to the // s3.amazonaws.com global endpoint, the request goes to the us-east-1 Region. So // 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) -// in the Amazon S3 User Guide. +// more information, see [Virtual hosting of buckets]in the Amazon S3 User Guide. +// // - Directory buckets - For directory buckets, you must make requests for this // API operation to the Regional endpoint. These endpoints support path-style // requests in the format // https://s3express-control.region_code.amazonaws.com/bucket-name . -// Virtual-hosted-style requests aren't supported. For more information, see -// Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// Virtual-hosted-style requests aren't supported. For more information, see [Regional and Zonal endpoints]in +// the Amazon S3 User Guide. // // Permissions +// // - General purpose bucket permissions - In addition to the s3:CreateBucket // permission, the following permissions are required in a policy when your // CreateBucket request includes specific headers: +// // - Access control lists (ACLs) - In your CreateBucket request, if you specify // an access control list (ACL) and set it to public-read , public-read-write , // authenticated-read , or if you explicitly specify any other custom ACLs, both // s3:CreateBucket and s3:PutBucketAcl permissions are required. In your // CreateBucket request, if you set the ACL to private , or if you don't specify // any ACLs, only the s3:CreateBucket permission is required. +// // - Object Lock - In your CreateBucket request, if you set // x-amz-bucket-object-lock-enabled to true, the // s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are // required. +// // - S3 Object Ownership - If your CreateBucket request includes the // x-amz-object-ownership header, then the s3:PutBucketOwnershipControls -// permission is required. To set an ACL on a bucket as part of a CreateBucket -// request, you must explicitly set S3 Object Ownership for the bucket to a -// different value than the default, BucketOwnerEnforced . Additionally, if your -// desired bucket ACL grants public access, you must first create the bucket -// (without the bucket ACL) and then explicitly disable Block Public Access on the -// bucket before using PutBucketAcl to set the ACL. If you try to create a bucket -// with a public ACL, the request will fail. For the majority of modern use cases -// in S3, we recommend that you keep all Block Public Access settings enabled and -// keep ACLs disabled. If you would like to share data with users outside of your -// account, you can use bucket policies as needed. For more information, see -// Controlling ownership of objects and disabling ACLs for your bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) -// and Blocking public access to your Amazon S3 storage (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html) -// in the Amazon S3 User Guide. -// - S3 Block Public Access - If your specific use case requires granting public -// access to your S3 resources, you can disable Block Public Access. Specifically, -// you can create a new bucket with Block Public Access enabled, then separately -// call the DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) -// API. To use this operation, you must have the s3:PutBucketPublicAccessBlock -// permission. For more information about S3 Block Public Access, see Blocking -// public access to your Amazon S3 storage (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html) -// in the Amazon S3 User Guide. -// - Directory bucket permissions - You must have the s3express:CreateBucket -// permission in an IAM identity-based policy instead of a bucket policy. -// Cross-account access to this API operation isn't supported. This operation can -// only be performed by the Amazon Web Services account that owns the resource. For -// more information about directory bucket policies and permissions, see Amazon -// Web Services Identity and Access Management (IAM) for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) -// in the Amazon S3 User Guide. The permissions for ACLs, Object Lock, S3 Object -// Ownership, and S3 Block Public Access are not supported for directory buckets. -// For directory buckets, all Block Public Access settings are enabled at the -// bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs -// disabled). These settings can't be modified. For more information about -// permissions for creating and working with directory buckets, see Directory -// buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) -// in the Amazon S3 User Guide. For more information about supported S3 features -// for directory buckets, see Features of S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features) -// in the Amazon S3 User Guide. +// permission is required. +// +// To set an ACL on a bucket as part of a CreateBucket request, you must explicitly +// +// set S3 Object Ownership for the bucket to a different value than the default, +// BucketOwnerEnforced . Additionally, if your desired bucket ACL grants public +// access, you must first create the bucket (without the bucket ACL) and then +// explicitly disable Block Public Access on the bucket before using PutBucketAcl +// to set the ACL. If you try to create a bucket with a public ACL, the request +// will fail. +// +// For the majority of modern use cases in S3, we recommend that you keep all +// +// Block Public Access settings enabled and keep ACLs disabled. If you would like +// to share data with users outside of your account, you can use bucket policies as +// needed. For more information, see [Controlling ownership of objects and disabling ACLs for your bucket]and [Blocking public access to your Amazon S3 storage]in the Amazon S3 User Guide. +// +// - S3 Block Public Access - If your specific use case requires granting public +// access to your S3 resources, you can disable Block Public Access. Specifically, +// you can create a new bucket with Block Public Access enabled, then separately +// call the [DeletePublicAccessBlock]DeletePublicAccessBlock API. To use this operation, you must have the +// s3:PutBucketPublicAccessBlock permission. For more information about S3 Block +// Public Access, see [Blocking public access to your Amazon S3 storage]in the Amazon S3 User Guide. +// +// - Directory bucket permissions - You must have the s3express:CreateBucket +// permission in an IAM identity-based policy instead of a bucket policy. +// Cross-account access to this API operation isn't supported. This operation can +// only be performed by the Amazon Web Services account that owns the resource. For +// more information about directory bucket policies and permissions, see [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]in the +// Amazon S3 User Guide. +// +// The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public +// +// Access are not supported for directory buckets. For directory buckets, all Block +// Public Access settings are enabled at the bucket level and S3 Object Ownership +// is set to Bucket owner enforced (ACLs disabled). These settings can't be +// modified. +// +// For more information about permissions for creating and working with directory +// +// buckets, see [Directory buckets]in the Amazon S3 User Guide. For more information about +// supported S3 features for directory buckets, see [Features of S3 Express One Zone]in the Amazon S3 User Guide. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// s3express-control.region.amazonaws.com . +// +// The following operations are related to CreateBucket : +// +// [PutObject] +// +// [DeleteBucket] +// +// [Creating, configuring, and working with Amazon S3 buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_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 +// [Virtual hosting of buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// s3express-control.region.amazonaws.com . 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) +// [DeletePublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html +// [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html +// [Features of S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features +// [Controlling ownership of objects and disabling ACLs for your bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html +// [Blocking public access to your Amazon S3 storage]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html +// [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) { if params == nil { params = &CreateBucketInput{} @@ -115,71 +142,93 @@ func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, op type CreateBucketInput struct { - // The name of the bucket to create. General purpose buckets - For information - // about bucket naming restrictions, see Bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) - // in the Amazon S3 User Guide. Directory buckets - When you use this operation - // with a directory bucket, you must use path-style requests in the format + // The name of the bucket to create. + // + // General purpose buckets - For information about bucket naming restrictions, see [Bucket naming rules] + // in the Amazon S3 User Guide. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use path-style requests in the format // https://s3express-control.region_code.amazonaws.com/bucket-name . // Virtual-hosted-style requests aren't supported. Directory bucket names must be // unique in the chosen Availability Zone. Bucket names must also follow the format // bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide + // ). For information about bucket naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User + // Guide + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [Bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html // // This member is required. Bucket *string - // The canned ACL to apply to the bucket. This functionality is not supported for - // directory buckets. + // The canned ACL to apply to the bucket. + // + // This functionality is not supported for directory buckets. ACL types.BucketCannedACL // The configuration information for the bucket. CreateBucketConfiguration *types.CreateBucketConfiguration // Allows grantee the read, write, read ACP, and write ACP permissions on the - // bucket. This functionality is not supported for directory buckets. + // bucket. + // + // This functionality is not supported for directory buckets. GrantFullControl *string - // Allows grantee to list the objects in the bucket. This functionality is not - // supported for directory buckets. + // Allows grantee to list the objects in the bucket. + // + // This functionality is not supported for directory buckets. GrantRead *string - // Allows grantee to read the bucket ACL. This functionality is not supported for - // directory buckets. + // Allows grantee to read the bucket ACL. + // + // This functionality is not supported for directory buckets. GrantReadACP *string - // Allows grantee to create new objects in the bucket. For the bucket and object - // owners of existing objects, also allows deletions and overwrites of those - // objects. This functionality is not supported for directory buckets. + // Allows grantee to create new objects in the bucket. + // + // For the bucket and object owners of existing objects, also allows deletions and + // overwrites of those objects. + // + // This functionality is not supported for directory buckets. GrantWrite *string - // Allows grantee to write the ACL for the applicable bucket. This functionality - // is not supported for directory buckets. + // Allows grantee to write the ACL for the applicable bucket. + // + // This functionality is not supported for directory buckets. GrantWriteACP *string // Specifies whether you want S3 Object Lock to be enabled for the new bucket. + // // This functionality is not supported for directory buckets. ObjectLockEnabledForBucket *bool // The container element for object ownership for a bucket's ownership controls. + // // BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the // bucket owner if the objects are uploaded with the bucket-owner-full-control - // canned ACL. ObjectWriter - The uploading account will own the object if the - // object is uploaded with the bucket-owner-full-control canned ACL. + // canned ACL. + // + // ObjectWriter - The uploading account will own the object if the object is + // uploaded with the bucket-owner-full-control canned ACL. + // // BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer // affect permissions. The bucket owner automatically owns and has full control // over every object in the bucket. The bucket only accepts PUT requests that don't // specify an ACL or specify bucket owner full control ACLs (such as the predefined // bucket-owner-full-control canned ACL or a custom ACL in XML format that grants - // the same permissions). By default, ObjectOwnership is set to BucketOwnerEnforced - // and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon - // use cases where you must control access for each object individually. For more - // information about S3 Object Ownership, see Controlling ownership of objects and - // disabling ACLs for your bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. Directory buckets use the bucket owner enforced setting for S3 Object - // Ownership. + // the same permissions). + // + // By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are + // disabled. We recommend keeping ACLs disabled, except in uncommon use cases where + // you must control access for each object individually. For more information about + // S3 Object Ownership, see [Controlling ownership of objects and disabling ACLs for your bucket]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. Directory buckets + // use the bucket owner enforced setting for S3 Object Ownership. + // + // [Controlling ownership of objects and disabling ACLs for your bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html ObjectOwnership types.ObjectOwnership noSmithyDocumentSerde diff --git a/service/s3/api_op_CreateMultipartUpload.go b/service/s3/api_op_CreateMultipartUpload.go index c083c32d8ef..9693c4cbd84 100644 --- a/service/s3/api_op_CreateMultipartUpload.go +++ b/service/s3/api_op_CreateMultipartUpload.go @@ -16,62 +16,64 @@ 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) -// in the Amazon S3 User Guide. 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 stops charging you for storing them only after you -// either complete or abort a multipart upload. If you have configured a lifecycle -// rule to abort incomplete multipart uploads, the created multipart upload must be -// completed 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 Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) -// . +// specify this upload ID in each of your subsequent upload part requests (see [UploadPart]). +// 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] +// in the Amazon S3 User Guide. +// +// 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 +// stops charging you for storing them only after you either complete or abort a +// multipart upload. +// +// If you have configured a lifecycle rule to abort incomplete multipart uploads, +// the created multipart upload must be completed 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 Configuration]. +// // - Directory buckets - S3 Lifecycle is not supported by directory buckets. +// // - Directory buckets - For directory buckets, you must make requests for this // API operation to the Zonal endpoint. These endpoints support // virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . -// Path-style requests are not supported. For more information, see Regional and -// Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// Path-style requests are not supported. For more information, see [Regional and Zonal endpoints]in the +// Amazon S3 User Guide. // // Request signing 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) -// in the Amazon S3 User Guide. Permissions +// requests. For more information about signing, see [Authenticating Requests (Amazon Web Services Signature Version 4)]in the Amazon S3 User Guide. +// +// Permissions // - General purpose bucket permissions - 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) -// in the Amazon S3 User Guide. 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. -// - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the -// s3express:CreateSession permission to the directory bucket in a bucket policy -// or an IAM identity-based policy. Then, you make the CreateSession API call on -// the bucket to obtain a session token. With the session token in your request -// header, you can make API requests to this operation. After the session token -// expires, you make another CreateSession API call to generate a new session -// token for use. Amazon Web Services CLI or SDKs create session and refresh the -// session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// required to use the multipart upload API, see [Multipart upload and permissions]in the Amazon S3 User Guide. +// +// 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]and [Protecting data using server-side encryption with Amazon Web Services KMS]in +// the Amazon S3 User Guide. +// +// - Directory bucket permissions - To grant access to this API operation on a +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the +// s3express:CreateSession permission to the directory bucket in a bucket policy +// or an IAM identity-based policy. Then, you make the CreateSession API call on +// the bucket to obtain a session token. With the session token in your request +// header, you can make API requests to this operation. After the session token +// expires, you make another CreateSession API call to generate a new session +// token for use. Amazon Web Services CLI or SDKs create session and refresh the +// session token automatically to avoid service interruptions when a session +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Encryption +// // - General purpose buckets - 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. Amazon S3 automatically encrypts all new @@ -91,61 +93,96 @@ import ( // 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) -// requests must match the headers you used in the CreateMultipartUpload request. +// in [UploadPart]and [UploadPartCopy]requests must match the headers you used in the CreateMultipartUpload +// request. +// // - 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. +// // - 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. +// before it completes the multipart upload. For more information, see [Multipart upload API and permissions]and [Protecting data using server-side encryption with Amazon Web Services KMS]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 is in a different account from the // key, then you must have the permissions on both the key policy and your IAM user // or role. +// // - 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 information about configuring 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) -// in the Amazon S3 User Guide. 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) -// in the Amazon S3 User Guide. -// - 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) -// in the Amazon S3 User Guide. -// - Directory buckets -For directory buckets, only server-side encryption with -// Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. -// -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// supported Amazon Web Services SDKs and Amazon Web Services CLI, see [Specifying the Signature Version in Request Authentication]in the +// Amazon S3 User Guide. +// +// For more information about server-side encryption with KMS keys (SSE-KMS), see [Protecting Data Using Server-Side Encryption with KMS keys] +// +// in the Amazon S3 User Guide. +// +// - 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)]in the Amazon S3 User Guide. +// +// - Directory buckets -For directory buckets, only server-side encryption with +// Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to CreateMultipartUpload : +// +// [UploadPart] +// +// [CompleteMultipartUpload] +// +// [AbortMultipartUpload] +// +// [ListParts] +// +// [ListMultipartUploads] +// +// [ListParts]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Protecting Data Using Server-Side Encryption with KMS keys]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Specifying the Signature Version in Request Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version +// [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 +// [Multipart upload and permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html +// [Multipart upload API and permissions]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions +// [UploadPartCopy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html +// [AbortMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html +// [Multipart Upload Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html +// [Protecting data using server-side encryption with Amazon Web Services KMS]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html +// [ListMultipartUploads]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html +// +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [Protecting data using server-side encryption with customer-provided encryption keys (SSE-C)]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html func (c *Client) CreateMultipartUpload(ctx context.Context, params *CreateMultipartUploadInput, optFns ...func(*Options)) (*CreateMultipartUploadOutput, error) { if params == nil { params = &CreateMultipartUploadInput{} @@ -164,30 +201,39 @@ func (c *Client) CreateMultipartUpload(ctx context.Context, params *CreateMultip type CreateMultipartUploadInput struct { // The name of the bucket where the multipart upload is initiated and where the - // object is uploaded. Directory buckets - When you use this operation with a - // directory bucket, you must use virtual-hosted-style requests in the format + // object is uploaded. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -199,32 +245,41 @@ type CreateMultipartUploadInput struct { // The canned ACL to apply to the object. 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) - // in the Amazon S3 User Guide. By default, all objects are private. Only the owner - // has full access control. When uploading an object, you can grant access - // 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 new object. For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html) - // . One way to grant the permissions using the request headers is to specify a - // canned ACL with the x-amz-acl request header. + // permissions. For more information, see [Canned ACL]in the Amazon S3 User Guide. + // + // By default, all objects are private. Only the owner has full access control. + // When uploading an object, you can grant access 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 new object. + // For more information, see [Using ACLs]. One way to grant the permissions using the request + // headers is to specify a canned ACL with the x-amz-acl request header. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Canned ACL]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL + // [Using ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html ACL types.ObjectCannedACL // Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption // with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). // Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object - // encryption with SSE-KMS. Specifying this header with an object action doesn’t - // affect bucket-level settings for S3 Bucket Key. This functionality is not - // supported for directory buckets. + // encryption with SSE-KMS. + // + // Specifying this header with an object action doesn’t affect bucket-level + // settings for S3 Bucket Key. + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // Specifies caching behavior along the request/reply chain. CacheControl *string // Indicates the algorithm that 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. + // for the object. For more information, see [Checking object integrity]in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // Specifies presentational information for the object. @@ -232,8 +287,10 @@ type CreateMultipartUploadInput struct { // 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 directory buckets, only the aws-chunked value is - // supported in this header field. + // Content-Type header field. + // + // For directory buckets, only the aws-chunked value is supported in this header + // field. ContentEncoding *string // The language that the content is in. @@ -251,207 +308,322 @@ type CreateMultipartUploadInput struct { Expires *time.Time // Specify access permissions explicitly to give the grantee READ, READ_ACP, and - // WRITE_ACP permissions on the object. By default, all objects are private. Only - // the owner has full access control. When uploading an object, you can use this - // header to explicitly grant access permissions to specific Amazon Web Services - // accounts or groups. This 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 Amazon S3 User Guide. You specify each grantee as a type=value pair, - // where the type is one of the following: + // WRITE_ACP permissions on the object. + // + // By default, all objects are private. Only the owner has full access control. + // When uploading an object, you can use this header to explicitly grant access + // permissions to specific Amazon Web Services accounts or groups. This header maps + // to specific permissions that Amazon S3 supports in an ACL. For more information, + // see [Access Control List (ACL) Overview]in the Amazon S3 User Guide. + // + // 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: + // 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. + // + // - South America (São Paulo) + // + // For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints]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" + // its metadata: + // + // x-amz-grant-read: id="11112222333", id="444455556666" + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + // [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html GrantFullControl *string // Specify access permissions explicitly to allow grantee to read the object data - // and its metadata. By default, all objects are private. Only the owner has full - // access control. When uploading an object, you can use this header to explicitly - // grant access permissions to specific Amazon Web Services accounts or groups. - // This 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 Amazon S3 User Guide. You specify each grantee as a type=value pair, - // where the type is one of the following: + // and its metadata. + // + // By default, all objects are private. Only the owner has full access control. + // When uploading an object, you can use this header to explicitly grant access + // permissions to specific Amazon Web Services accounts or groups. This header maps + // to specific permissions that Amazon S3 supports in an ACL. For more information, + // see [Access Control List (ACL) Overview]in the Amazon S3 User Guide. + // + // 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: + // 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. + // + // - South America (São Paulo) + // + // For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints]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" + // its metadata: + // + // x-amz-grant-read: id="11112222333", id="444455556666" + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + // [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html GrantRead *string // Specify access permissions explicitly to allows grantee to read the object ACL. + // // By default, all objects are private. Only the owner has full access control. // When uploading an object, you can use this header to explicitly grant access // permissions to specific Amazon Web Services accounts or groups. This 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 Amazon S3 User Guide. You specify each grantee as a type=value pair, - // where the type is one of the following: + // see [Access Control List (ACL) Overview]in the Amazon S3 User Guide. + // + // 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: + // 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. + // + // - South America (São Paulo) + // + // For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints]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" + // its metadata: + // + // x-amz-grant-read: id="11112222333", id="444455556666" + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + // [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html GrantReadACP *string // Specify access permissions explicitly to allows grantee to allow grantee to - // write the ACL for the applicable object. By default, all objects are private. - // Only the owner has full access control. When uploading an object, you can use - // this header to explicitly grant access permissions to specific Amazon Web - // Services accounts or groups. This 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 Amazon S3 User Guide. You specify each grantee as a type=value pair, - // where the type is one of the following: + // write the ACL for the applicable object. + // + // By default, all objects are private. Only the owner has full access control. + // When uploading an object, you can use this header to explicitly grant access + // permissions to specific Amazon Web Services accounts or groups. This header maps + // to specific permissions that Amazon S3 supports in an ACL. For more information, + // see [Access Control List (ACL) Overview]in the Amazon S3 User Guide. + // + // 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: + // 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. + // + // - South America (São Paulo) + // + // For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints]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" + // its metadata: + // + // x-amz-grant-read: id="11112222333", id="444455556666" + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region + // [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html GrantWriteACP *string // A map of metadata to store with the object in S3. Metadata map[string]string - // Specifies whether you want to apply a legal hold to the uploaded object. This - // functionality is not supported for directory buckets. + // Specifies whether you want to apply a legal hold to the uploaded object. + // + // This functionality is not supported for directory buckets. ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus // Specifies the Object Lock mode that you want to apply to the uploaded object. + // // This functionality is not supported for directory buckets. ObjectLockMode types.ObjectLockMode - // Specifies the date and time when you want the Object Lock to expire. This - // functionality is not supported for directory buckets. + // Specifies the date and time when you want the Object Lock to expire. + // + // This functionality is not supported for directory buckets. ObjectLockRetainUntilDate *time.Time // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, - // AES256). This functionality is not supported for directory buckets. + // Specifies the algorithm to use when encrypting the object (for example, AES256). + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in // 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 functionality is - // not supported for directory buckets. + // x-amz-server-side-encryption-customer-algorithm header. + // + // This functionality is not supported for directory buckets. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the customer-provided encryption key // according to RFC 1321. Amazon S3 uses this header for a message integrity check - // to ensure that the encryption key was transmitted without error. This - // functionality is not supported for directory buckets. + // to ensure that the encryption key was transmitted without error. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // Specifies the Amazon Web Services KMS Encryption Context to use for object // encryption. The value of this header is a base64-encoded UTF-8 string holding - // JSON with the encryption context key-value pairs. This functionality is not - // supported for directory buckets. + // JSON with the encryption context key-value pairs. + // + // This functionality is not supported for directory buckets. SSEKMSEncryptionContext *string // Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption - // customer managed key to use for object encryption. This functionality is not - // supported for directory buckets. + // customer managed key to use for object encryption. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms ). For directory buckets, only server-side - // encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. + // S3 (for example, AES256 , aws:kms ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. 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. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) - // in the Amazon S3 User Guide. + // Storage Class. For more information, see [Storage Classes]in the Amazon S3 User Guide. + // // - For directory buckets, only the S3 Express One Zone storage class is // supported to store newly created objects. + // // - Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. + // + // [Storage Classes]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html StorageClass types.StorageClass - // The tag-set for the object. The tag-set must be encoded as URL Query - // parameters. This functionality is not supported for directory buckets. + // The tag-set for the object. The tag-set must be encoded as URL Query parameters. + // + // This functionality is not supported for directory buckets. 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. This functionality is not supported - // for directory buckets. + // value of this header in the object metadata. + // + // This functionality is not supported for directory buckets. WebsiteRedirectLocation *string noSmithyDocumentSerde @@ -469,27 +641,33 @@ type CreateMultipartUploadOutput struct { // 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 Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) - // in the Amazon S3 User Guide. The response also includes the x-amz-abort-rule-id - // header that provides the ID of the lifecycle configuration rule that defines the - // abort action. This functionality is not supported for directory buckets. + // operation. For more information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration]in the Amazon S3 User Guide. + // + // The response also includes the x-amz-abort-rule-id header that provides the ID + // of the lifecycle configuration rule that defines the abort action. + // + // This functionality is not supported for directory buckets. + // + // [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 AbortDate *time.Time // This header is returned along with the x-amz-abort-date header. It identifies // the applicable lifecycle configuration rule that defines the action to abort - // incomplete multipart uploads. This functionality is not supported for directory - // buckets. + // incomplete multipart uploads. + // + // This functionality is not supported for directory buckets. AbortRuleId *string // The name of the bucket to which the multipart upload was initiated. Does not - // return the access point ARN or access point alias if used. Access points are not - // supported by directory buckets. + // return the access point ARN or access point alias if used. + // + // Access points are not supported by directory buckets. Bucket *string // Indicates whether the multipart upload uses an S3 Bucket Key for server-side - // encryption with Key Management Service (KMS) keys (SSE-KMS). This functionality - // is not supported for directory buckets. + // encryption with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // The algorithm that was used to create a checksum of the object. @@ -499,35 +677,43 @@ type CreateMultipartUploadOutput struct { Key *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the Amazon Web Services KMS Encryption Context to use for // object encryption. The value of this header is a base64-encoded UTF-8 string - // holding JSON with the encryption context key-value pairs. This functionality is - // not supported for directory buckets. + // holding JSON with the encryption context key-value pairs. + // + // This functionality is not supported for directory buckets. SSEKMSEncryptionContext *string // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms ). For directory buckets, only server-side - // encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. + // S3 (for example, AES256 , aws:kms ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. ServerSideEncryption types.ServerSideEncryption // ID for the initiated multipart upload. diff --git a/service/s3/api_op_CreateSession.go b/service/s3/api_op_CreateSession.go index e2d5a007d16..96f821d29c4 100644 --- a/service/s3/api_op_CreateSession.go +++ b/service/s3/api_op_CreateSession.go @@ -17,62 +17,72 @@ import ( // Creates a session that establishes temporary security credentials to support // fast authentication and authorization for the Zonal endpoint APIs on directory // buckets. For more information about Zonal endpoint APIs that include the -// Availability Zone in the request endpoint, see S3 Express One Zone APIs (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html) -// in the Amazon S3 User Guide. To make Zonal endpoint API requests on a directory -// bucket, use the CreateSession API operation. Specifically, you grant -// s3express:CreateSession permission to a bucket in a bucket policy or an IAM -// identity-based policy. Then, you use IAM credentials to make the CreateSession -// API request on the bucket, which returns temporary security credentials that -// include the access key ID, secret access key, session token, and expiration. -// These credentials have associated permissions to access the Zonal endpoint APIs. -// After the session is created, you don’t need to use other policies to grant -// permissions to each Zonal endpoint API individually. Instead, in your Zonal -// endpoint API requests, you sign your requests by applying the temporary security -// credentials of the session to the request headers and following the SigV4 -// protocol for authentication. You also apply the session token to the -// x-amz-s3session-token request header for authorization. Temporary security -// credentials are scoped to the bucket and expire after 5 minutes. After the -// expiration time, any calls that you make with those credentials will fail. You -// must use IAM credentials again to make a CreateSession API request that -// generates a new set of temporary credentials for use. Temporary credentials -// cannot be extended or refreshed beyond the original specified interval. If you -// use Amazon Web Services SDKs, SDKs handle the session token refreshes +// Availability Zone in the request endpoint, see [S3 Express One Zone APIs]in the Amazon S3 User Guide. +// +// To make Zonal endpoint API requests on a directory bucket, use the CreateSession +// API operation. Specifically, you grant s3express:CreateSession permission to a +// bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM +// credentials to make the CreateSession API request on the bucket, which returns +// temporary security credentials that include the access key ID, secret access +// key, session token, and expiration. These credentials have associated +// permissions to access the Zonal endpoint APIs. After the session is created, you +// don’t need to use other policies to grant permissions to each Zonal endpoint API +// individually. Instead, in your Zonal endpoint API requests, you sign your +// requests by applying the temporary security credentials of the session to the +// request headers and following the SigV4 protocol for authentication. You also +// apply the session token to the x-amz-s3session-token request header for +// authorization. Temporary security credentials are scoped to the bucket and +// expire after 5 minutes. After the expiration time, any calls that you make with +// those credentials will fail. You must use IAM credentials again to make a +// CreateSession API request that generates a new set of temporary credentials for +// use. Temporary credentials cannot be extended or refreshed beyond the original +// specified interval. +// +// If you use Amazon Web Services SDKs, SDKs handle the session token refreshes // automatically to avoid service interruptions when a session expires. We // recommend that you use the Amazon Web Services SDKs to initiate and manage -// requests to the CreateSession API. For more information, see Performance -// guidelines and design patterns (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication) -// in the Amazon S3 User Guide. +// requests to the CreateSession API. For more information, see [Performance guidelines and design patterns]in the Amazon S3 +// User Guide. +// // - You must make requests for this API operation to the Zonal endpoint. These // endpoints support virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests -// are not supported. For more information, see Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User Guide. +// // - CopyObject API operation - Unlike other Zonal endpoint APIs, the CopyObject // API operation doesn't use the temporary security credentials returned from the // CreateSession API operation for authentication and authorization. For // information about authentication and authorization of the CopyObject API -// operation on directory buckets, see CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) -// . +// operation on directory buckets, see [CopyObject]. +// // - HeadBucket API operation - Unlike other Zonal endpoint APIs, the HeadBucket // API operation doesn't use the temporary security credentials returned from the // CreateSession API operation for authentication and authorization. For // information about authentication and authorization of the HeadBucket API -// operation on directory buckets, see HeadBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html) -// . +// operation on directory buckets, see [HeadBucket]. // // Permissions To obtain temporary security credentials, you must create a bucket // policy or an IAM identity-based policy that grants s3express:CreateSession // permission to the bucket. In a policy, you can have the s3express:SessionMode // condition key to control who can create a ReadWrite or ReadOnly session. For -// more information about ReadWrite or ReadOnly sessions, see -// x-amz-create-session-mode (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters) -// . For example policies, see Example bucket policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// and Amazon Web Services Identity and Access Management (IAM) identity-based -// policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html) -// in the Amazon S3 User Guide. To grant cross-account access to Zonal endpoint -// APIs, the bucket policy should also grant both accounts the -// s3express:CreateSession permission. HTTP Host header syntax Directory buckets - -// The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com . +// more information about ReadWrite or ReadOnly sessions, see [x-amz-create-session-mode] +// x-amz-create-session-mode . For example policies, see [Example bucket policies for S3 Express One Zone] and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone] in the Amazon S3 +// User Guide. +// +// To grant cross-account access to Zonal endpoint APIs, the bucket policy should +// also grant both accounts the s3express:CreateSession permission. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html +// [Performance guidelines and design patterns]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication +// [Example bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CopyObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html +// [x-amz-create-session-mode]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters +// [S3 Express One Zone APIs]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html +// [HeadBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html func (c *Client) CreateSession(ctx context.Context, params *CreateSessionInput, optFns ...func(*Options)) (*CreateSessionOutput, error) { if params == nil { params = &CreateSessionInput{} diff --git a/service/s3/api_op_DeleteBucket.go b/service/s3/api_op_DeleteBucket.go index 30e1381bd67..e3a25ec195f 100644 --- a/service/s3/api_op_DeleteBucket.go +++ b/service/s3/api_op_DeleteBucket.go @@ -15,33 +15,43 @@ 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. +// // - Directory buckets - If multipart uploads in a directory bucket are in // progress, you can't delete the bucket until all the in-progress multipart // uploads are aborted or completed. +// // - Directory buckets - For directory buckets, you must make requests for this // API operation to the Regional endpoint. These endpoints support path-style // requests in the format // https://s3express-control.region_code.amazonaws.com/bucket-name . -// Virtual-hosted-style requests aren't supported. For more information, see -// Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// Virtual-hosted-style requests aren't supported. For more information, see [Regional and Zonal endpoints]in +// the Amazon S3 User Guide. // // Permissions +// // - General purpose bucket permissions - You must have the s3:DeleteBucket // permission on the specified bucket in a policy. +// // - Directory bucket permissions - You must have the s3express:DeleteBucket // permission in an IAM identity-based policy instead of a bucket policy. // Cross-account access to this API operation isn't supported. This operation can // only be performed by the Amazon Web Services account that owns the resource. For -// more information about directory bucket policies and permissions, see Amazon -// Web Services Identity and Access Management (IAM) for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) -// in the Amazon S3 User Guide. +// more information about directory bucket policies and permissions, see [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]in the +// Amazon S3 User Guide. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// s3express-control.region.amazonaws.com . +// +// The following operations are related to DeleteBucket : // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// s3express-control.region.amazonaws.com . The following operations are related to -// DeleteBucket : -// - 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] +// +// [DeleteObject] +// +// [DeleteObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error) { if params == nil { params = &DeleteBucketInput{} @@ -59,24 +69,29 @@ func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, op type DeleteBucketInput struct { - // Specifies the bucket being deleted. Directory buckets - When you use this - // operation with a directory bucket, you must use path-style requests in the - // format https://s3express-control.region_code.amazonaws.com/bucket-name . + // Specifies the bucket being deleted. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use path-style requests in the format + // https://s3express-control.region_code.amazonaws.com/bucket-name . // Virtual-hosted-style requests aren't supported. Directory bucket names must be // unique in the chosen Availability Zone. Bucket names must also follow the format // bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide + // ). For information about bucket naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User + // Guide + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html // // This member is required. Bucket *string // The account ID of the expected bucket owner. If the account ID that you provide // does not match the actual owner of the bucket, the request fails with the HTTP - // status code 403 Forbidden (access denied). For directory buckets, this header - // is not supported in this API operation. If you specify this header, the request - // fails with the HTTP status code 501 Not Implemented . + // status code 403 Forbidden (access denied). + // + // For directory buckets, this header is not supported in this API operation. If + // you specify this header, the request fails with the HTTP status code 501 Not + // Implemented . ExpectedBucketOwner *string noSmithyDocumentSerde diff --git a/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go b/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go index 0033825a0ae..b486fe62cbb 100644 --- a/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_DeleteBucketAnalyticsConfiguration.go @@ -13,20 +13,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Deletes an analytics -// configuration for the bucket (specified by the analytics configuration ID). To -// use this operation, you must have permissions to perform the +// This operation is not supported by directory buckets. +// +// 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 -// 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) +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about the Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis]. +// +// The following operations are related to DeleteBucketAnalyticsConfiguration : +// +// [GetBucketAnalyticsConfiguration] +// +// [ListBucketAnalyticsConfigurations] +// +// [PutBucketAnalyticsConfiguration] +// +// [Amazon S3 Analytics – Storage Class Analysis]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.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 +// [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 +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 d465826fb4d..ef3abb12560 100644 --- a/service/s3/api_op_DeleteBucketCors.go +++ b/service/s3/api_op_DeleteBucketCors.go @@ -13,14 +13,25 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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] in the Amazon S3 User Guide. +// +// # Related Resources +// +// [PutBucketCors] +// +// [RESTOPTIONSobject] +// +// [PutBucketCors]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html +// [Enabling Cross-Origin Resource Sharing]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.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 7be8c475908..fceb944c9cd 100644 --- a/service/s3/api_op_DeleteBucketEncryption.go +++ b/service/s3/api_op_DeleteBucketEncryption.go @@ -13,20 +13,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 -// 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) -// in the Amazon S3 User Guide. The following operations are related to -// DeleteBucketEncryption : -// - PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) -// - GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) +// This operation is not supported by directory buckets. +// +// 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]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]and [Managing Access Permissions to your Amazon S3 Resources] in the Amazon S3 User Guide. +// +// The following operations are related to DeleteBucketEncryption : +// +// [PutBucketEncryption] +// +// [GetBucketEncryption] +// +// [GetBucketEncryption]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html +// [PutBucketEncryption]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.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 +// [Managing Access Permissions to your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [Amazon S3 Bucket Default Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.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 734d23b0439..b7baf48abc5 100644 --- a/service/s3/api_op_DeleteBucketIntelligentTieringConfiguration.go +++ b/service/s3/api_op_DeleteBucketIntelligentTieringConfiguration.go @@ -13,25 +13,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Deletes 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, +// This operation is not supported by directory buckets. +// +// Deletes 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 // tiers. To get the lowest storage cost on data that can be accessed in minutes to -// hours, you can choose to activate additional archiving capabilities. The S3 -// Intelligent-Tiering storage class is the ideal storage class for data with -// unknown, changing, or unpredictable access patterns, independent of object size -// or retention period. If the size of an object is less than 128 KB, it is not -// 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) +// hours, you can choose to activate additional archiving capabilities. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of object +// size or retention period. If the size of an object is less than 128 KB, it is +// not 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]. +// +// Operations related to DeleteBucketIntelligentTieringConfiguration include: +// +// [GetBucketIntelligentTieringConfiguration] +// +// [PutBucketIntelligentTieringConfiguration] +// +// [ListBucketIntelligentTieringConfigurations] +// +// [ListBucketIntelligentTieringConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html +// [GetBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html +// [PutBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html +// [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 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 3b8d81a4393..ef1d8a24bf1 100644 --- a/service/s3/api_op_DeleteBucketInventoryConfiguration.go +++ b/service/s3/api_op_DeleteBucketInventoryConfiguration.go @@ -13,18 +13,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Deletes an inventory -// configuration (identified by the inventory ID) from the bucket. To use this -// operation, you must have permissions to perform the 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) +// This operation is not supported by directory buckets. +// +// Deletes an inventory configuration (identified by the inventory ID) from the +// bucket. +// +// To use this operation, you must have permissions to perform the +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory]. +// +// Operations related to DeleteBucketInventoryConfiguration include: +// +// [GetBucketInventoryConfiguration] +// +// [PutBucketInventoryConfiguration] +// +// [ListBucketInventoryConfigurations] +// +// [Amazon S3 Inventory]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html +// [ListBucketInventoryConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.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 +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [PutBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html +// [GetBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.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 88928b284a8..ea6455f6697 100644 --- a/service/s3/api_op_DeleteBucketLifecycle.go +++ b/service/s3/api_op_DeleteBucketLifecycle.go @@ -13,20 +13,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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. +// This operation is not supported by directory buckets. +// +// 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) +// 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]. +// +// Related actions include: +// +// [PutBucketLifecycleConfiguration] +// +// [GetBucketLifecycleConfiguration] +// +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html +// [Elements to Describe Lifecycle Actions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions +// [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 21384351f5d..ca0158b6bfc 100644 --- a/service/s3/api_op_DeleteBucketMetricsConfiguration.go +++ b/service/s3/api_op_DeleteBucketMetricsConfiguration.go @@ -13,22 +13,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Deletes a metrics -// configuration for the Amazon CloudWatch request metrics (specified by the -// metrics configuration ID) from the bucket. Note that this doesn't include the -// daily storage metrics. 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 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) +// This operation is not supported by directory buckets. +// +// Deletes a metrics configuration for the Amazon CloudWatch request metrics +// (specified by the metrics configuration ID) from the bucket. Note that this +// doesn't include the daily storage metrics. +// +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch]. +// +// The following operations are related to DeleteBucketMetricsConfiguration : +// +// [GetBucketMetricsConfiguration] +// +// [PutBucketMetricsConfiguration] +// +// [ListBucketMetricsConfigurations] +// +// [Monitoring Metrics with Amazon CloudWatch] +// +// [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 +// [Monitoring Metrics with Amazon CloudWatch]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.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 +// [PutBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 4beac6b0929..a2e89e40546 100644 --- a/service/s3/api_op_DeleteBucketOwnershipControls.go +++ b/service/s3/api_op_DeleteBucketOwnershipControls.go @@ -13,14 +13,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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]. +// +// For information about Amazon S3 Object Ownership, see [Using Object Ownership]. +// +// The following operations are related to DeleteBucketOwnershipControls : +// +// # GetBucketOwnershipControls +// +// # PutBucketOwnershipControls +// +// [Using Object Ownership]: https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html 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 b8e1f56a143..745890828b1 100644 --- a/service/s3/api_op_DeleteBucketPolicy.go +++ b/service/s3/api_op_DeleteBucketPolicy.go @@ -13,44 +13,57 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the policy of a specified bucket. Directory buckets - For directory -// buckets, you must make requests for this API operation to the Regional endpoint. -// These endpoints support path-style requests in the format -// https://s3express-control.region_code.amazonaws.com/bucket-name . -// Virtual-hosted-style requests aren't supported. For more information, see -// Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions 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 both have the DeleteBucketPolicy permissions on the -// specified bucket and belong to the bucket owner's account in order to use this -// operation. 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. To ensure that bucket owners don't -// inadvertently lock themselves out of their own buckets, the root principal in a -// bucket owner's Amazon Web Services account can perform the GetBucketPolicy , -// PutBucketPolicy , and DeleteBucketPolicy API actions, even if their bucket -// policy explicitly denies the root principal's access. Bucket owner root -// principals can only be blocked from performing these API actions by VPC endpoint -// policies and Amazon Web Services Organizations policies. +// Deletes the policy of a specified bucket. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Regional endpoint. These endpoints support path-style requests +// in the format https://s3express-control.region_code.amazonaws.com/bucket-name . +// Virtual-hosted-style requests aren't supported. For more information, see [Regional and Zonal endpoints]in +// the Amazon S3 User Guide. +// +// Permissions 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 both have +// the DeleteBucketPolicy permissions on the specified bucket and belong to the +// bucket owner's account in order to use this operation. +// +// 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. +// +// To ensure that bucket owners don't inadvertently lock themselves out of their +// own buckets, the root principal in a bucket owner's Amazon Web Services account +// can perform the GetBucketPolicy , PutBucketPolicy , and DeleteBucketPolicy API +// actions, even if their bucket policy explicitly denies the root principal's +// access. Bucket owner root principals can only be blocked from performing these +// API actions by VPC endpoint policies and Amazon Web Services Organizations +// policies. +// // - General purpose bucket permissions - The s3:DeleteBucketPolicy permission is // required in a policy. For more information about general purpose buckets bucket -// policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) -// in the Amazon S3 User Guide. +// policies, see [Using Bucket Policies and User Policies]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation, you // must have the s3express:DeleteBucketPolicy permission in an IAM identity-based // policy instead of a bucket policy. Cross-account access to this API operation // isn't supported. This operation can only be performed by the Amazon Web Services // account that owns the resource. For more information about directory bucket -// policies and permissions, see Amazon Web Services Identity and Access -// Management (IAM) for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) -// in the Amazon S3 User Guide. +// policies and permissions, see [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]in the Amazon S3 User Guide. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// s3express-control.region.amazonaws.com . // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// s3express-control.region.amazonaws.com . 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) +// # The following operations are related to DeleteBucketPolicy +// +// [CreateBucket] +// +// [DeleteObject] +// +// [DeleteObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPolicyInput, optFns ...func(*Options)) (*DeleteBucketPolicyOutput, error) { if params == nil { params = &DeleteBucketPolicyInput{} @@ -68,24 +81,29 @@ func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPol type DeleteBucketPolicyInput struct { - // The bucket name. Directory buckets - When you use this operation with a - // directory bucket, you must use path-style requests in the format + // The bucket name. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use path-style requests in the format // https://s3express-control.region_code.amazonaws.com/bucket-name . // Virtual-hosted-style requests aren't supported. Directory bucket names must be // unique in the chosen Availability Zone. Bucket names must also follow the format // bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide + // ). For information about bucket naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User + // Guide + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html // // This member is required. Bucket *string // The account ID of the expected bucket owner. If the account ID that you provide // does not match the actual owner of the bucket, the request fails with the HTTP - // status code 403 Forbidden (access denied). For directory buckets, this header - // is not supported in this API operation. If you specify this header, the request - // fails with the HTTP status code 501 Not Implemented . + // status code 403 Forbidden (access denied). + // + // For directory buckets, this header is not supported in this API operation. If + // you specify this header, the request fails with the HTTP status code 501 Not + // Implemented . ExpectedBucketOwner *string noSmithyDocumentSerde diff --git a/service/s3/api_op_DeleteBucketReplication.go b/service/s3/api_op_DeleteBucketReplication.go index 9fdc6bcf323..58f91e97f60 100644 --- a/service/s3/api_op_DeleteBucketReplication.go +++ b/service/s3/api_op_DeleteBucketReplication.go @@ -13,18 +13,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Deletes the replication -// configuration from the bucket. To use this operation, 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) +// This operation is not supported by directory buckets. +// +// Deletes the replication configuration from the bucket. +// +// To use this operation, 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] +// and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// It can take a while for the deletion of a replication configuration to fully +// propagate. +// +// For information about replication configuration, see [Replication] in the Amazon S3 User +// Guide. +// +// The following operations are related to DeleteBucketReplication : +// +// [PutBucketReplication] +// +// [GetBucketReplication] +// +// [GetBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.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 +// [PutBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html +// [Replication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html func (c *Client) DeleteBucketReplication(ctx context.Context, params *DeleteBucketReplicationInput, optFns ...func(*Options)) (*DeleteBucketReplicationOutput, error) { if params == nil { params = &DeleteBucketReplicationInput{} @@ -42,7 +56,7 @@ func (c *Client) DeleteBucketReplication(ctx context.Context, params *DeleteBuck type DeleteBucketReplicationInput struct { - // The bucket name. + // The bucket name. // // This member is required. Bucket *string diff --git a/service/s3/api_op_DeleteBucketTagging.go b/service/s3/api_op_DeleteBucketTagging.go index ae737d40a3e..8f3386904f1 100644 --- a/service/s3/api_op_DeleteBucketTagging.go +++ b/service/s3/api_op_DeleteBucketTagging.go @@ -13,13 +13,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Deletes the tags from the -// bucket. To use this operation, you must have permission to perform the +// This operation is not supported by directory buckets. +// +// 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) +// can grant this permission to others. +// +// The following operations are related to DeleteBucketTagging : +// +// [GetBucketTagging] +// +// [PutBucketTagging] +// +// [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 425936dfac0..893cda50529 100644 --- a/service/s3/api_op_DeleteBucketWebsite.go +++ b/service/s3/api_op_DeleteBucketWebsite.go @@ -13,20 +13,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. This action removes the -// website configuration for a bucket. Amazon S3 returns a 200 OK response upon -// successfully deleting a website configuration on the specified bucket. You will -// get a 200 OK response if the website configuration you are trying to delete -// does not exist on the bucket. Amazon S3 returns a 404 response if the bucket -// specified in the request does not exist. This DELETE action requires the -// S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete -// the website configuration attached to a bucket. However, 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) +// This operation is not supported by directory buckets. +// +// This action removes the website configuration for a bucket. Amazon S3 returns a +// 200 OK response upon successfully deleting a website configuration on the +// specified bucket. You will get a 200 OK response if the website configuration +// you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 +// response if the bucket specified in the request does not exist. +// +// This DELETE action requires the S3:DeleteBucketWebsite permission. By default, +// only the bucket owner can delete the website configuration attached to a bucket. +// However, 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]. +// +// The following operations are related to DeleteBucketWebsite : +// +// [GetBucketWebsite] +// +// [PutBucketWebsite] +// +// [GetBucketWebsite]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html +// [PutBucketWebsite]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html +// [Hosting Websites on Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.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 c1e5ff73a93..778d02e54c2 100644 --- a/service/s3/api_op_DeleteObject.go +++ b/service/s3/api_op_DeleteObject.go @@ -22,9 +22,7 @@ import ( // - If bucket versioning is enabled, the operation inserts a delete marker, // which becomes the current version of the object. To permanently delete an object // in a versioned bucket, you must include the object’s versionId in the request. -// For more information about versioning-enabled buckets, see Deleting object -// versions from a versioning-enabled bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html) -// . +// For more information about versioning-enabled buckets, see [Deleting object versions from a versioning-enabled bucket]. // // - If bucket versioning is suspended, the operation removes the object that // has a null versionId , if there is one, and inserts a delete marker that @@ -32,9 +30,7 @@ import ( // versionId , and all versions of the object have a versionId , Amazon S3 does // not remove the object and only inserts a delete marker. To permanently delete an // object that has a versionId , you must include the object’s versionId in the -// request. For more information about versioning-suspended buckets, see -// Deleting objects from versioning-suspended buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html) -// . +// request. For more information about versioning-suspended buckets, see [Deleting objects from versioning-suspended buckets]. // // - Directory buckets - S3 Versioning isn't enabled and supported for directory // buckets. For this API operation, only the null value of the version ID is @@ -45,37 +41,43 @@ import ( // API operation to the Zonal endpoint. These endpoints support // virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . -// Path-style requests are not supported. For more information, see Regional and -// Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// Path-style requests are not supported. For more information, see [Regional and Zonal endpoints]in the +// Amazon S3 User Guide. // // To remove a specific version, you must use the versionId query parameter. Using // this query parameter 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 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) -// in the Amazon S3 User Guide. To see sample requests that use versioning, see -// Sample Request (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete) -// . Directory buckets - MFA delete is not supported by directory buckets. You can -// delete objects by explicitly calling DELETE Object or calling ( -// 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. Directory buckets - S3 Lifecycle is not supported by directory buckets. +// use HTTPS. For more information about MFA Delete, see [Using MFA Delete]in the Amazon S3 User +// Guide. To see sample requests that use versioning, see [Sample Request]. +// +// Directory buckets - MFA delete is not supported by directory buckets. +// +// You can delete objects by explicitly calling DELETE Object or calling ([PutBucketLifecycle] ) 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. +// +// Directory buckets - S3 Lifecycle is not supported by directory buckets. +// // Permissions +// // - General purpose bucket permissions - The following permissions are required // in your policies when your DeleteObjects request includes specific headers. +// // - s3:DeleteObject - To delete an object from a bucket, you must always have // the s3:DeleteObject permission. +// // - s3:DeleteObjectVersion - To delete a specific version of an object from a -// versioning-enabled bucket, you must have the s3:DeleteObjectVersion -// permission. +// versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -83,13 +85,23 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following action is related to DeleteObject : // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . The following action is -// related to DeleteObject : -// - PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) +// [PutObject] +// +// [Sample Request]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Deleting objects from versioning-suspended buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html +// [PutObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html +// [PutBucketLifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [Deleting object versions from a versioning-enabled bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html +// [Using MFA Delete]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error) { if params == nil { params = &DeleteObjectInput{} @@ -107,31 +119,39 @@ func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, op type DeleteObjectInput struct { - // The bucket name of the bucket containing the object. Directory buckets - When - // you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // The bucket name of the bucket containing the object. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -143,8 +163,9 @@ type DeleteObjectInput struct { // Indicates whether S3 Object Lock should bypass Governance-mode restrictions to // process this operation. To use this header, you must have the - // s3:BypassGovernanceRetention permission. This functionality is not supported for - // directory buckets. + // s3:BypassGovernanceRetention permission. + // + // This functionality is not supported for directory buckets. BypassGovernanceRetention *bool // The account ID of the expected bucket owner. If the account ID that you provide @@ -155,22 +176,27 @@ type DeleteObjectInput struct { // 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. This functionality is not supported for directory buckets. + // delete enabled. + // + // This functionality is not supported for directory buckets. 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. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Version ID used to reference a specific version of the object. For directory - // buckets in this API operation, only the null value of the version ID is - // supported. + // Version ID used to reference a specific version of the object. + // + // For directory buckets in this API operation, only the null value of the version + // ID is supported. VersionId *string noSmithyDocumentSerde @@ -187,16 +213,21 @@ type DeleteObjectOutput struct { // Indicates whether the specified object version that was permanently deleted was // (true) or was not (false) a delete marker before deletion. In a simple DELETE, // this header indicates whether (true) or not (false) the current version of the - // object is a delete marker. This functionality is not supported for directory - // buckets. + // object is a delete marker. + // + // This functionality is not supported for directory buckets. DeleteMarker *bool // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Returns the version ID of the delete marker created as a result of the DELETE - // operation. This functionality is not supported for directory buckets. + // operation. + // + // This functionality is not supported for directory buckets. VersionId *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_DeleteObjectTagging.go b/service/s3/api_op_DeleteObjectTagging.go index c5f31dec66a..7bb534eb1c7 100644 --- a/service/s3/api_op_DeleteObjectTagging.go +++ b/service/s3/api_op_DeleteObjectTagging.go @@ -12,16 +12,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Removes the entire tag set from the specified object. For more information +// about managing object tags, see [Object Tagging]. +// +// 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] +// +// [GetObjectTagging] +// +// [PutObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html +// [Object Tagging]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.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{} @@ -39,23 +50,27 @@ func (c *Client) DeleteObjectTagging(ctx context.Context, params *DeleteObjectTa type DeleteObjectTaggingInput struct { - // The bucket name containing the objects from which to remove the tags. Access - // points - When you use this action with an access point, you must provide the - // alias of the access point in place of the bucket name or specify the access + // The bucket name containing the objects from which to remove the tags. + // + // Access points - When you use this action with 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 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. S3 on Outposts - 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 + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string diff --git a/service/s3/api_op_DeleteObjects.go b/service/s3/api_op_DeleteObjects.go index 05f82cf7566..45b823138a7 100644 --- a/service/s3/api_op_DeleteObjects.go +++ b/service/s3/api_op_DeleteObjects.go @@ -17,47 +17,57 @@ import ( // This operation enables you to delete multiple objects from a bucket using a // single HTTP request. If you know the object keys that you want to delete, then // this operation provides a suitable alternative to sending individual delete -// requests, reducing per-request overhead. The request can contain a list of up to -// 1000 keys that you want to delete. In the XML, you provide the object key names, -// and optionally, version IDs if you want to delete a specific version of the -// object from a versioning-enabled bucket. For each key, Amazon S3 performs a -// delete operation and returns the result of that delete, success or failure, in -// the response. Note that if the object specified in the request is not found, -// Amazon S3 returns the result as deleted. +// requests, reducing per-request overhead. +// +// The request can contain a list of up to 1000 keys that you want to delete. In +// the XML, you provide the object key names, and optionally, version IDs if you +// want to delete a specific version of the object from a versioning-enabled +// bucket. For each key, Amazon S3 performs a delete operation and returns the +// result of that delete, success or failure, in the response. Note that if the +// object specified in the request is not found, Amazon S3 returns the result as +// deleted. +// // - Directory buckets - S3 Versioning isn't enabled and supported for directory // buckets. +// // - Directory buckets - For directory buckets, you must make requests for this // API operation to the Zonal endpoint. These endpoints support // virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . -// Path-style requests are not supported. For more information, see Regional and -// Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// Path-style requests are not supported. For more information, see [Regional and Zonal endpoints]in the +// Amazon S3 User Guide. // // The operation supports two modes for the response: verbose and quiet. By // default, the operation uses verbose mode in which the response includes the // result of deletion of each key in your request. In quiet mode the response // includes only keys where the delete operation encountered an error. For a // successful deletion in a quiet mode, the operation does not return any -// information about the delete in the response body. When performing this action -// on an MFA Delete enabled bucket, that attempts to delete any versioned objects, -// you must include an MFA token. If you do not provide one, the entire request -// will fail, 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) -// in the Amazon S3 User Guide. Directory buckets - MFA delete is not supported by -// directory buckets. Permissions +// information about the delete in the response body. +// +// When performing this action on an MFA Delete enabled bucket, that attempts to +// delete any versioned objects, you must include an MFA token. If you do not +// provide one, the entire request will fail, 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]in the Amazon S3 User Guide. +// +// Directory buckets - MFA delete is not supported by directory buckets. +// +// Permissions +// // - General purpose bucket permissions - The following permissions are required // in your policies when your DeleteObjects request includes specific headers. +// // - s3:DeleteObject - To delete an object from a bucket, you must always specify // the s3:DeleteObject permission. +// // - s3:DeleteObjectVersion - To delete a specific version of an object from a // versiong-enabled bucket, you must specify the s3:DeleteObjectVersion // permission. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -65,26 +75,42 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Content-MD5 request header +// // - General purpose bucket - The Content-MD5 request 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. +// // - Directory bucket - The Content-MD5 request header or a additional checksum // request header (including x-amz-checksum-crc32 , x-amz-checksum-crc32c , // x-amz-checksum-sha1 , or x-amz-checksum-sha256 ) is required for all // Multi-Object Delete requests. // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to DeleteObjects : +// +// [CreateMultipartUpload] +// +// [UploadPart] +// +// [CompleteMultipartUpload] +// +// [ListParts] +// +// [AbortMultipartUpload] +// +// [ListParts]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html +// [AbortMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [MFA Delete]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html func (c *Client) DeleteObjects(ctx context.Context, params *DeleteObjectsInput, optFns ...func(*Options)) (*DeleteObjectsOutput, error) { if params == nil { params = &DeleteObjectsInput{} @@ -102,31 +128,39 @@ func (c *Client) DeleteObjects(ctx context.Context, params *DeleteObjectsInput, type DeleteObjectsInput struct { - // The bucket name containing the objects to delete. Directory buckets - When you - // use this operation with a directory bucket, you must use virtual-hosted-style - // requests in the format Bucket_name.s3express-az_id.region.amazonaws.com . - // Path-style requests are not supported. Directory bucket names must be unique in - // the chosen Availability Zone. Bucket names must follow the format - // bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // The bucket name containing the objects to delete. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format + // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not + // supported. Directory bucket names must be unique in the chosen Availability + // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for + // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -138,28 +172,40 @@ type DeleteObjectsInput struct { // Specifies whether you want to delete this object even if it has a // Governance-type Object Lock in place. To use this header, you must have the - // s3:BypassGovernanceRetention permission. This functionality is not supported for - // directory buckets. + // s3:BypassGovernanceRetention permission. + // + // This functionality is not supported for directory buckets. BypassGovernanceRetention *bool // Indicates the algorithm used to create the checksum for the object when you use // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send this header, there must be a corresponding // x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 - // fails the request with the HTTP status code 400 Bad Request . For the - // x-amz-checksum-algorithm header, replace algorithm with the supported - // algorithm from the following list: + // fails the request with the HTTP status code 400 Bad Request . + // + // For the x-amz-checksum-algorithm header, replace algorithm with the + // supported algorithm from the following list: + // // - CRC32 + // // - CRC32C + // // - SHA1 + // // - SHA256 - // 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 the individual checksum value you provide - // through x-amz-checksum-algorithm doesn't match the checksum algorithm you set - // through x-amz-sdk-checksum-algorithm , Amazon S3 ignores any provided - // ChecksumAlgorithm parameter and uses the checksum algorithm that matches the - // provided value in x-amz-checksum-algorithm . If you provide an individual - // checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter. + // + // For more information, see [Checking object integrity] in the Amazon S3 User Guide. + // + // If the individual checksum value you provide through x-amz-checksum-algorithm + // doesn't match the checksum algorithm you set through + // x-amz-sdk-checksum-algorithm , Amazon S3 ignores any provided ChecksumAlgorithm + // parameter and uses the checksum algorithm that matches the provided value in + // x-amz-checksum-algorithm . + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // The account ID of the expected bucket owner. If the account ID that you provide @@ -170,25 +216,31 @@ type DeleteObjectsInput struct { // 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. When performing the DeleteObjects operation on an MFA delete - // enabled bucket, which attempts to delete the specified versioned objects, you - // must include an MFA token. If you don't provide an MFA token, the entire request - // will fail, even if there are non-versioned objects that you are trying to - // delete. If you provide an invalid token, whether there are versioned object 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // delete enabled. + // + // When performing the DeleteObjects operation on an MFA delete enabled bucket, + // which attempts to delete the specified versioned objects, you must include an + // MFA token. If you don't provide an MFA token, the entire request will fail, even + // if there are non-versioned objects that you are trying to delete. If you provide + // an invalid token, whether there are versioned object keys in the request or not, + // the entire Multi-Object Delete request will fail. For information about MFA + // Delete, see [MFA Delete]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [MFA Delete]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete 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. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer noSmithyDocumentSerde @@ -210,7 +262,9 @@ type DeleteObjectsOutput struct { Errors []types.Error // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_DeletePublicAccessBlock.go b/service/s3/api_op_DeletePublicAccessBlock.go index 43969e2b193..2e77386c0c0 100644 --- a/service/s3/api_op_DeletePublicAccessBlock.go +++ b/service/s3/api_op_DeletePublicAccessBlock.go @@ -13,17 +13,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// The following operations are related to DeletePublicAccessBlock : +// +// [Using Amazon S3 Block Public Access] +// +// [GetPublicAccessBlock] +// +// [PutPublicAccessBlock] +// +// [GetBucketPolicyStatus] +// +// [GetPublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html +// [PutPublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.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 +// [Using Amazon S3 Block Public Access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 4bb1ff71cf9..be91d27b9f6 100644 --- a/service/s3/api_op_GetBucketAccelerateConfiguration.go +++ b/service/s3/api_op_GetBucketAccelerateConfiguration.go @@ -14,26 +14,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 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) -// 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) -// 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. The following operations are related to -// GetBucketAccelerateConfiguration : -// - PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) +// This operation is not supported by directory buckets. +// +// 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 +// 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]and [Managing Access Permissions to your Amazon S3 Resources] in the Amazon S3 User Guide. +// +// You set the Transfer Acceleration state of an existing bucket to Enabled or +// Suspended by using the [PutBucketAccelerateConfiguration] 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] in the Amazon S3 User +// Guide. +// +// The following operations are related to GetBucketAccelerateConfiguration : +// +// [PutBucketAccelerateConfiguration] +// +// [PutBucketAccelerateConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.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 +// [Managing Access Permissions to your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [Transfer Acceleration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html func (c *Client) GetBucketAccelerateConfiguration(ctx context.Context, params *GetBucketAccelerateConfigurationInput, optFns ...func(*Options)) (*GetBucketAccelerateConfigurationOutput, error) { if params == nil { params = &GetBucketAccelerateConfigurationInput{} @@ -65,10 +75,12 @@ type GetBucketAccelerateConfigurationInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer noSmithyDocumentSerde @@ -82,7 +94,9 @@ func (in *GetBucketAccelerateConfigurationInput) bindEndpointParams(p *EndpointP type GetBucketAccelerateConfigurationOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // The accelerate configuration of the bucket. diff --git a/service/s3/api_op_GetBucketAcl.go b/service/s3/api_op_GetBucketAcl.go index bc7c4ea18b9..06e4ad39f29 100644 --- a/service/s3/api_op_GetBucketAcl.go +++ b/service/s3/api_op_GetBucketAcl.go @@ -14,26 +14,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. This implementation of -// the GET action uses the acl subresource to return the access control list (ACL) -// of a bucket. To use GET to return the ACL of the bucket, you must have the -// READ_ACP access to the bucket. If READ_ACP permission is granted to the -// anonymous user, you can return the ACL of the bucket without using an -// authorization header. When you use this API operation with an access point, -// provide the alias of the access point in place of the bucket name. When you use -// this API operation with an Object Lambda access point, provide the alias of the -// Object Lambda access point in place of the bucket name. If the Object Lambda -// access point alias in a request is not valid, the error code +// This operation is not supported by directory buckets. +// +// This implementation of the GET action uses the acl subresource to return the +// access control list (ACL) of a bucket. To use GET to return the ACL of the +// bucket, you must have the READ_ACP access to the bucket. If READ_ACP permission +// is granted to the anonymous user, you can return the ACL of the bucket without +// using an authorization header. +// +// When you use this API operation with an access point, provide the alias of the +// access point in place of the bucket name. +// +// When you use this API operation with an Object Lambda access point, provide the +// alias of the Object Lambda access point in place of the bucket name. If the +// Object Lambda access point alias in a request is not valid, the error code // InvalidAccessPointAliasError is returned. For more information about -// InvalidAccessPointAliasError , see List of Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) -// . If your bucket uses the bucket owner enforced setting for S3 Object Ownership, +// InvalidAccessPointAliasError , see [List of Error Codes]. +// +// 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) -// in the Amazon S3 User Guide. The following operations are related to -// GetBucketAcl : -// - ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) +// bucket. For more information, see [Controlling object ownership and disabling ACLs]in the Amazon S3 User Guide. +// +// The following operations are related to GetBucketAcl : +// +// [ListObjects] +// +// [ListObjects]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html +// [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList +// [Controlling object ownership and disabling ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html func (c *Client) GetBucketAcl(ctx context.Context, params *GetBucketAclInput, optFns ...func(*Options)) (*GetBucketAclOutput, error) { if params == nil { params = &GetBucketAclInput{} @@ -51,14 +60,18 @@ func (c *Client) GetBucketAcl(ctx context.Context, params *GetBucketAclInput, op type GetBucketAclInput struct { - // Specifies the S3 bucket whose ACL is being requested. When you use this API - // operation with an access point, provide the alias of the access point in place - // of the bucket name. When you use this API operation with an Object Lambda access - // point, provide the alias of the Object Lambda access point in place of the - // bucket name. If the Object Lambda access point alias in a request is not valid, - // the error code InvalidAccessPointAliasError is returned. For more information - // about InvalidAccessPointAliasError , see List of Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) - // . + // Specifies the S3 bucket whose ACL is being requested. + // + // When you use this API operation with an access point, provide the alias of the + // access point in place of the bucket name. + // + // When you use this API operation with an Object Lambda access point, provide the + // alias of the Object Lambda access point in place of the bucket name. If the + // Object Lambda access point alias in a request is not valid, the error code + // InvalidAccessPointAliasError is returned. For more information about + // InvalidAccessPointAliasError , see [List of Error Codes]. + // + // [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList // // This member is required. Bucket *string diff --git a/service/s3/api_op_GetBucketAnalyticsConfiguration.go b/service/s3/api_op_GetBucketAnalyticsConfiguration.go index 64e41d4037b..6f52c815711 100644 --- a/service/s3/api_op_GetBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_GetBucketAnalyticsConfiguration.go @@ -14,21 +14,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. This implementation of -// the GET action returns an analytics configuration (identified by the analytics -// configuration ID) from the bucket. 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) -// 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) -// in the Amazon S3 User Guide. The following operations are related to -// GetBucketAnalyticsConfiguration : -// - 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) +// This operation is not supported by directory buckets. +// +// This implementation of the GET action returns an analytics configuration +// (identified by the analytics configuration ID) from the bucket. +// +// 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]and [Managing Access Permissions to Your Amazon S3 Resources] in the Amazon S3 User Guide. +// +// For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis] in the Amazon S3 User +// Guide. +// +// The following operations are related to GetBucketAnalyticsConfiguration : +// +// [DeleteBucketAnalyticsConfiguration] +// +// [ListBucketAnalyticsConfigurations] +// +// [PutBucketAnalyticsConfiguration] +// +// [Amazon S3 Analytics – Storage Class Analysis]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html +// [DeleteBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.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 +// [ListBucketAnalyticsConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html +// [PutBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 0997225ebc4..d5db578e55d 100644 --- a/service/s3/api_op_GetBucketCors.go +++ b/service/s3/api_op_GetBucketCors.go @@ -14,21 +14,36 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns the Cross-Origin -// Resource Sharing (CORS) configuration information set for the bucket. To use -// this operation, you must have permission to perform the s3:GetBucketCORS +// This operation is not supported by directory buckets. +// +// Returns the Cross-Origin Resource Sharing (CORS) configuration information set +// for the bucket. +// +// To use this operation, you must have permission to perform the s3:GetBucketCORS // action. By default, the bucket owner has this permission and can grant it to -// others. When you use this API operation with an access point, provide the alias -// of the access point in place of the bucket name. When you use this API operation -// with an Object Lambda access point, provide the alias of the Object Lambda -// access point in place of the bucket name. If the Object Lambda access point -// alias in a request is not valid, the error code InvalidAccessPointAliasError is -// returned. For more information about InvalidAccessPointAliasError , see List of -// Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) -// . 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) +// others. +// +// When you use this API operation with an access point, provide the alias of the +// access point in place of the bucket name. +// +// When you use this API operation with an Object Lambda access point, provide the +// alias of the Object Lambda access point in place of the bucket name. If the +// Object Lambda access point alias in a request is not valid, the error code +// InvalidAccessPointAliasError is returned. For more information about +// InvalidAccessPointAliasError , see [List of Error Codes]. +// +// For more information about CORS, see [Enabling Cross-Origin Resource Sharing]. +// +// The following operations are related to GetBucketCors : +// +// [PutBucketCors] +// +// [DeleteBucketCors] +// +// [PutBucketCors]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html +// [Enabling Cross-Origin Resource Sharing]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html +// [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList +// [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{} @@ -46,14 +61,18 @@ func (c *Client) GetBucketCors(ctx context.Context, params *GetBucketCorsInput, type GetBucketCorsInput struct { - // The bucket name for which to get the cors configuration. When you use this API - // operation with an access point, provide the alias of the access point in place - // of the bucket name. When you use this API operation with an Object Lambda access - // point, provide the alias of the Object Lambda access point in place of the - // bucket name. If the Object Lambda access point alias in a request is not valid, - // the error code InvalidAccessPointAliasError is returned. For more information - // about InvalidAccessPointAliasError , see List of Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) - // . + // The bucket name for which to get the cors configuration. + // + // When you use this API operation with an access point, provide the alias of the + // access point in place of the bucket name. + // + // When you use this API operation with an Object Lambda access point, provide the + // alias of the Object Lambda access point in place of the bucket name. If the + // Object Lambda access point alias in a request is not valid, the error code + // InvalidAccessPointAliasError is returned. For more information about + // InvalidAccessPointAliasError , see [List of Error Codes]. + // + // [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList // // This member is required. Bucket *string diff --git a/service/s3/api_op_GetBucketEncryption.go b/service/s3/api_op_GetBucketEncryption.go index 22c1f9bb518..7e8d251e35c 100644 --- a/service/s3/api_op_GetBucketEncryption.go +++ b/service/s3/api_op_GetBucketEncryption.go @@ -14,20 +14,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns the default -// encryption configuration for an Amazon S3 bucket. By 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) +// This operation is not supported by directory buckets. +// +// Returns the default encryption configuration for an Amazon S3 bucket. By +// 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]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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// The following operations are related to GetBucketEncryption : +// +// [PutBucketEncryption] +// +// [DeleteBucketEncryption] +// +// [DeleteBucketEncryption]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html +// [PutBucketEncryption]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.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 +// [Amazon S3 Bucket Default Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 f3ae88a9b20..97f54f343bd 100644 --- a/service/s3/api_op_GetBucketIntelligentTieringConfiguration.go +++ b/service/s3/api_op_GetBucketIntelligentTieringConfiguration.go @@ -14,25 +14,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Gets 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, +// This operation is not supported by directory buckets. +// +// Gets 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 // tiers. To get the lowest storage cost on data that can be accessed in minutes to -// hours, you can choose to activate additional archiving capabilities. The S3 -// Intelligent-Tiering storage class is the ideal storage class for data with -// unknown, changing, or unpredictable access patterns, independent of object size -// or retention period. If the size of an object is less than 128 KB, it is not -// 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) +// hours, you can choose to activate additional archiving capabilities. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of object +// size or retention period. If the size of an object is less than 128 KB, it is +// not 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]. +// +// Operations related to GetBucketIntelligentTieringConfiguration include: +// +// [DeleteBucketIntelligentTieringConfiguration] +// +// [PutBucketIntelligentTieringConfiguration] +// +// [ListBucketIntelligentTieringConfigurations] +// +// [ListBucketIntelligentTieringConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html +// [PutBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html +// [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 +// [DeleteBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.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 123218e9760..48d361e10b7 100644 --- a/service/s3/api_op_GetBucketInventoryConfiguration.go +++ b/service/s3/api_op_GetBucketInventoryConfiguration.go @@ -14,18 +14,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns an inventory -// configuration (identified by the inventory configuration ID) from the bucket. To -// use this operation, you must have permissions to perform the +// This operation is not supported by directory buckets. +// +// 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) +// permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory]. +// +// The following operations are related to GetBucketInventoryConfiguration : +// +// [DeleteBucketInventoryConfiguration] +// +// [ListBucketInventoryConfigurations] +// +// [PutBucketInventoryConfiguration] +// +// [Amazon S3 Inventory]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html +// [ListBucketInventoryConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.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 +// [DeleteBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 ddcbbe09674..f4590e59a55 100644 --- a/service/s3/api_op_GetBucketLifecycleConfiguration.go +++ b/service/s3/api_op_GetBucketLifecycleConfiguration.go @@ -14,35 +14,51 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Bucket lifecycle -// configuration now supports specifying a lifecycle rule using an object key name -// prefix, one or more object tags, object size, or any combination of these. -// 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 -// GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html) -// . 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, 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 +// This operation is not supported by directory buckets. +// +// Bucket lifecycle configuration now supports specifying a lifecycle rule using +// an object key name prefix, one or more object tags, object size, or any +// combination of these. 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 [GetBucketLifecycle]. 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, +// +// Returns the lifecycle configuration information set on the bucket. For +// information about lifecycle configuration, see [Object Lifecycle Management]. +// +// 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: +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// 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 // // 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) +// +// [GetBucketLifecycle] +// +// [PutBucketLifecycle] +// +// [DeleteBucketLifecycle] +// +// [GetBucketLifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html +// [Object Lifecycle Management]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.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 +// [PutBucketLifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 aff5f3cd557..a6b362cbe1e 100644 --- a/service/s3/api_op_GetBucketLocation.go +++ b/service/s3/api_op_GetBucketLocation.go @@ -20,23 +20,34 @@ import ( "io" ) -// This operation is not supported by directory buckets. 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) -// . When you use this API operation with an access point, provide the alias of the -// access point in place of the bucket name. When you use this API operation with -// an Object Lambda access point, provide the alias of the Object Lambda access -// point in place of the bucket name. If the Object Lambda access point alias in a -// request is not valid, the error code InvalidAccessPointAliasError is returned. -// For more information about InvalidAccessPointAliasError , see List of Error -// Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) -// . We recommend that you use HeadBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html) -// to return the Region that a bucket resides in. For backward compatibility, -// Amazon S3 continues to support 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) +// This operation is not supported by directory buckets. +// +// 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]. +// +// When you use this API operation with an access point, provide the alias of the +// access point in place of the bucket name. +// +// When you use this API operation with an Object Lambda access point, provide the +// alias of the Object Lambda access point in place of the bucket name. If the +// Object Lambda access point alias in a request is not valid, the error code +// InvalidAccessPointAliasError is returned. For more information about +// InvalidAccessPointAliasError , see [List of Error Codes]. +// +// We recommend that you use [HeadBucket] to return the Region that a bucket resides in. For +// backward compatibility, Amazon S3 continues to support GetBucketLocation. +// +// The following operations are related to GetBucketLocation : +// +// [GetObject] +// +// [CreateBucket] +// +// [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html +// [HeadBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html func (c *Client) GetBucketLocation(ctx context.Context, params *GetBucketLocationInput, optFns ...func(*Options)) (*GetBucketLocationOutput, error) { if params == nil { params = &GetBucketLocationInput{} @@ -54,14 +65,18 @@ func (c *Client) GetBucketLocation(ctx context.Context, params *GetBucketLocatio type GetBucketLocationInput struct { - // The name of the bucket for which to get the location. When you use this API - // operation with an access point, provide the alias of the access point in place - // of the bucket name. When you use this API operation with an Object Lambda access - // point, provide the alias of the Object Lambda access point in place of the - // bucket name. If the Object Lambda access point alias in a request is not valid, - // the error code InvalidAccessPointAliasError is returned. For more information - // about InvalidAccessPointAliasError , see List of Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) - // . + // The name of the bucket for which to get the location. + // + // When you use this API operation with an access point, provide the alias of the + // access point in place of the bucket name. + // + // When you use this API operation with an Object Lambda access point, provide the + // alias of the Object Lambda access point in place of the bucket name. If the + // Object Lambda access point alias in a request is not valid, the error code + // InvalidAccessPointAliasError is returned. For more information about + // InvalidAccessPointAliasError , see [List of Error Codes]. + // + // [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList // // This member is required. Bucket *string @@ -82,8 +97,10 @@ func (in *GetBucketLocationInput) bindEndpointParams(p *EndpointParameters) { 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]. Buckets in Region us-east-1 + // have a LocationConstraint of null . + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region LocationConstraint types.BucketLocationConstraint // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetBucketLogging.go b/service/s3/api_op_GetBucketLogging.go index d1c4f8fbb99..ae6bcbe686c 100644 --- a/service/s3/api_op_GetBucketLogging.go +++ b/service/s3/api_op_GetBucketLogging.go @@ -14,11 +14,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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] +// +// [PutBucketLogging] +// +// [PutBucketLogging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html func (c *Client) GetBucketLogging(ctx context.Context, params *GetBucketLoggingInput, optFns ...func(*Options)) (*GetBucketLoggingOutput, error) { if params == nil { params = &GetBucketLoggingInput{} @@ -57,8 +65,10 @@ func (in *GetBucketLoggingInput) bindEndpointParams(p *EndpointParameters) { 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. + // log object keys for a bucket. For more information, see [PUT Bucket logging]in the Amazon S3 API + // Reference. + // + // [PUT Bucket logging]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html 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 d7499c68cf9..474eba52082 100644 --- a/service/s3/api_op_GetBucketMetricsConfiguration.go +++ b/service/s3/api_op_GetBucketMetricsConfiguration.go @@ -14,21 +14,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Gets a metrics -// configuration (specified by the metrics configuration ID) from the bucket. Note -// that this doesn't include the daily storage metrics. 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 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) +// This operation is not supported by directory buckets. +// +// Gets a metrics configuration (specified by the metrics configuration ID) from +// the bucket. Note that this doesn't include the daily storage metrics. +// +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch]. +// +// The following operations are related to GetBucketMetricsConfiguration : +// +// [PutBucketMetricsConfiguration] +// +// [DeleteBucketMetricsConfiguration] +// +// [ListBucketMetricsConfigurations] +// +// [Monitoring Metrics with Amazon CloudWatch] +// +// [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 +// [Monitoring Metrics with Amazon CloudWatch]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html +// [ListBucketMetricsConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html +// [PutBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html +// [DeleteBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 73155110d86..81c0d815ae9 100644 --- a/service/s3/api_op_GetBucketNotificationConfiguration.go +++ b/service/s3/api_op_GetBucketNotificationConfiguration.go @@ -14,24 +14,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns the notification -// configuration of a bucket. If notifications are not enabled on the bucket, the -// action returns an empty NotificationConfiguration element. By default, you must -// be the bucket owner to read the notification configuration of a bucket. However, -// the bucket owner can use a bucket policy to grant permission to other users to -// read this configuration with the s3:GetBucketNotification permission. When you -// use this API operation with an access point, provide the alias of the access -// point in place of the bucket name. When you use this API operation with an -// Object Lambda access point, provide the alias of the Object Lambda access point -// in place of the bucket name. If the Object Lambda access point alias in a -// request is not valid, the error code InvalidAccessPointAliasError is returned. -// For more information about InvalidAccessPointAliasError , see List of Error -// Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) -// . 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) +// This operation is not supported by directory buckets. +// +// Returns the notification configuration of a bucket. +// +// If notifications are not enabled on the bucket, the action returns an empty +// NotificationConfiguration element. +// +// By default, you must be the bucket owner to read the notification configuration +// of a bucket. However, the bucket owner can use a bucket policy to grant +// permission to other users to read this configuration with the +// s3:GetBucketNotification permission. +// +// When you use this API operation with an access point, provide the alias of the +// access point in place of the bucket name. +// +// When you use this API operation with an Object Lambda access point, provide the +// alias of the Object Lambda access point in place of the bucket name. If the +// Object Lambda access point alias in a request is not valid, the error code +// InvalidAccessPointAliasError is returned. For more information about +// InvalidAccessPointAliasError , see [List of Error Codes]. +// +// For more information about setting and reading the notification configuration +// on a bucket, see [Setting Up Notification of Bucket Events]. For more information about bucket policies, see [Using Bucket Policies]. +// +// The following action is related to GetBucketNotification : +// +// [PutBucketNotification] +// +// [Using Bucket Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [Setting Up Notification of Bucket Events]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html +// [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList +// [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{} @@ -49,15 +63,18 @@ func (c *Client) GetBucketNotificationConfiguration(ctx context.Context, params type GetBucketNotificationConfigurationInput struct { - // The name of the bucket for which to get the notification configuration. When - // you use this API operation with an access point, provide the alias of the access - // point in place of the bucket name. When you use this API operation with an - // Object Lambda access point, provide the alias of the Object Lambda access point - // in place of the bucket name. If the Object Lambda access point alias in a - // request is not valid, the error code InvalidAccessPointAliasError is returned. - // For more information about InvalidAccessPointAliasError , see List of Error - // Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) - // . + // The name of the bucket for which to get the notification configuration. + // + // When you use this API operation with an access point, provide the alias of the + // access point in place of the bucket name. + // + // When you use this API operation with an Object Lambda access point, provide the + // alias of the Object Lambda access point in place of the bucket name. If the + // Object Lambda access point alias in a request is not valid, the error code + // InvalidAccessPointAliasError is returned. For more information about + // InvalidAccessPointAliasError , see [List of Error Codes]. + // + // [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList // // This member is required. Bucket *string diff --git a/service/s3/api_op_GetBucketOwnershipControls.go b/service/s3/api_op_GetBucketOwnershipControls.go index cea15142869..2b601e1b6ed 100644 --- a/service/s3/api_op_GetBucketOwnershipControls.go +++ b/service/s3/api_op_GetBucketOwnershipControls.go @@ -14,14 +14,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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]. +// +// For information about Amazon S3 Object Ownership, see [Using Object Ownership]. +// +// The following operations are related to GetBucketOwnershipControls : +// +// # PutBucketOwnershipControls +// +// # DeleteBucketOwnershipControls +// +// [Using Object Ownership]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html +// [Specifying permissions in a policy]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html func (c *Client) GetBucketOwnershipControls(ctx context.Context, params *GetBucketOwnershipControlsInput, optFns ...func(*Options)) (*GetBucketOwnershipControlsOutput, error) { if params == nil { params = &GetBucketOwnershipControlsInput{} diff --git a/service/s3/api_op_GetBucketPolicy.go b/service/s3/api_op_GetBucketPolicy.go index c2f98f93695..29934518e6e 100644 --- a/service/s3/api_op_GetBucketPolicy.go +++ b/service/s3/api_op_GetBucketPolicy.go @@ -13,47 +13,61 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the policy of a specified bucket. Directory buckets - For directory -// buckets, you must make requests for this API operation to the Regional endpoint. -// These endpoints support path-style requests in the format -// https://s3express-control.region_code.amazonaws.com/bucket-name . -// Virtual-hosted-style requests aren't supported. For more information, see -// Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions 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 both have the GetBucketPolicy permissions on the -// specified bucket and belong to the bucket owner's account in order to use this -// operation. If you don't have GetBucketPolicy 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. To ensure that bucket owners don't -// inadvertently lock themselves out of their own buckets, the root principal in a -// bucket owner's Amazon Web Services account can perform the GetBucketPolicy , -// PutBucketPolicy , and DeleteBucketPolicy API actions, even if their bucket -// policy explicitly denies the root principal's access. Bucket owner root -// principals can only be blocked from performing these API actions by VPC endpoint -// policies and Amazon Web Services Organizations policies. +// Returns the policy of a specified bucket. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Regional endpoint. These endpoints support path-style requests +// in the format https://s3express-control.region_code.amazonaws.com/bucket-name . +// Virtual-hosted-style requests aren't supported. For more information, see [Regional and Zonal endpoints]in +// the Amazon S3 User Guide. +// +// Permissions 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 both have +// the GetBucketPolicy permissions on the specified bucket and belong to the +// bucket owner's account in order to use this operation. +// +// If you don't have GetBucketPolicy 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. +// +// To ensure that bucket owners don't inadvertently lock themselves out of their +// own buckets, the root principal in a bucket owner's Amazon Web Services account +// can perform the GetBucketPolicy , PutBucketPolicy , and DeleteBucketPolicy API +// actions, even if their bucket policy explicitly denies the root principal's +// access. Bucket owner root principals can only be blocked from performing these +// API actions by VPC endpoint policies and Amazon Web Services Organizations +// policies. +// // - General purpose bucket permissions - The s3:GetBucketPolicy permission is // required in a policy. For more information about general purpose buckets bucket -// policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) -// in the Amazon S3 User Guide. +// policies, see [Using Bucket Policies and User Policies]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation, you // must have the s3express:GetBucketPolicy permission in an IAM identity-based // policy instead of a bucket policy. Cross-account access to this API operation // isn't supported. This operation can only be performed by the Amazon Web Services // account that owns the resource. For more information about directory bucket -// policies and permissions, see Amazon Web Services Identity and Access -// Management (IAM) for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) -// in the Amazon S3 User Guide. +// policies and permissions, see [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]in the Amazon S3 User Guide. +// +// Example bucket policies General purpose buckets example bucket policies - See [Bucket policy examples] +// in the Amazon S3 User Guide. +// +// Directory bucket example bucket policies - See [Example bucket policies for S3 Express One Zone] in the Amazon S3 User Guide. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// s3express-control.region.amazonaws.com . // -// Example bucket policies General purpose buckets example bucket policies - See -// Bucket policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) -// in the Amazon S3 User Guide. Directory bucket example bucket policies - See -// Example bucket policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// in the Amazon S3 User Guide. HTTP Host header syntax Directory buckets - The -// HTTP Host header syntax is s3express-control.region.amazonaws.com . The -// following action is related to GetBucketPolicy : -// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// The following action is related to GetBucketPolicy : +// +// [GetObject] +// +// [Bucket policy examples]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html +// [Example bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html +// [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInput, optFns ...func(*Options)) (*GetBucketPolicyOutput, error) { if params == nil { params = &GetBucketPolicyInput{} @@ -71,33 +85,42 @@ func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInp type GetBucketPolicyInput struct { - // The bucket name to get the bucket policy for. Directory buckets - When you use - // this operation with a directory bucket, you must use path-style requests in the - // format https://s3express-control.region_code.amazonaws.com/bucket-name . + // The bucket name to get the bucket policy for. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use path-style requests in the format + // https://s3express-control.region_code.amazonaws.com/bucket-name . // Virtual-hosted-style requests aren't supported. Directory bucket names must be // unique in the chosen Availability Zone. Bucket names must also follow the format // bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide Access points - When you use this API operation with - // an access point, provide the alias of the access point in place of the bucket - // name. Object Lambda access points - When you use this API operation with an - // Object Lambda access point, provide the alias of the Object Lambda access point - // in place of the bucket name. If the Object Lambda access point alias in a - // request is not valid, the error code InvalidAccessPointAliasError is returned. - // For more information about InvalidAccessPointAliasError , see List of Error - // Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) - // . Access points and Object Lambda access points are not supported by directory + // ). For information about bucket naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User + // Guide + // + // Access points - When you use this API operation with an access point, provide + // the alias of the access point in place of the bucket name. + // + // Object Lambda access points - When you use this API operation with an Object + // Lambda access point, provide the alias of the Object Lambda access point in + // place of the bucket name. If the Object Lambda access point alias in a request + // is not valid, the error code InvalidAccessPointAliasError is returned. For more + // information about InvalidAccessPointAliasError , see [List of Error Codes]. + // + // Access points and Object Lambda access points are not supported by directory // buckets. // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList + // // This member is required. Bucket *string // The account ID of the expected bucket owner. If the account ID that you provide // does not match the actual owner of the bucket, the request fails with the HTTP - // status code 403 Forbidden (access denied). For directory buckets, this header - // is not supported in this API operation. If you specify this header, the request - // fails with the HTTP status code 501 Not Implemented . + // status code 403 Forbidden (access denied). + // + // For directory buckets, this header is not supported in this API operation. If + // you specify this header, the request fails with the HTTP status code 501 Not + // Implemented . ExpectedBucketOwner *string noSmithyDocumentSerde diff --git a/service/s3/api_op_GetBucketPolicyStatus.go b/service/s3/api_op_GetBucketPolicyStatus.go index cb36ac504af..52fa5be9dd7 100644 --- a/service/s3/api_op_GetBucketPolicyStatus.go +++ b/service/s3/api_op_GetBucketPolicyStatus.go @@ -14,18 +14,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]. +// +// For more information about when Amazon S3 considers a bucket public, see [The Meaning of "Public"]. +// +// The following operations are related to GetBucketPolicyStatus : +// +// [Using Amazon S3 Block Public Access] +// +// [GetPublicAccessBlock] +// +// [PutPublicAccessBlock] +// +// [DeletePublicAccessBlock] +// +// [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 +// [Using Amazon S3 Block Public Access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html +// [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 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 7e44d38eef4..3edb1ec2a4c 100644 --- a/service/s3/api_op_GetBucketReplication.go +++ b/service/s3/api_op_GetBucketReplication.go @@ -14,21 +14,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 -// 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) +// This operation is not supported by directory buckets. +// +// 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] 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]. +// +// 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] +// // 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) +// +// [PutBucketReplication] +// +// [DeleteBucketReplication] +// +// [PutBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [Replication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html +// [List of replication-related error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList +// [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 16cc528222f..ac546ee0b06 100644 --- a/service/s3/api_op_GetBucketRequestPayment.go +++ b/service/s3/api_op_GetBucketRequestPayment.go @@ -14,11 +14,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]. +// +// The following operations are related to GetBucketRequestPayment : +// +// [ListObjects] +// +// [ListObjects]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html +// [Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.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 69a6e490303..9dc666368ba 100644 --- a/service/s3/api_op_GetBucketTagging.go +++ b/service/s3/api_op_GetBucketTagging.go @@ -14,17 +14,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns the tag set -// associated with the bucket. To use this operation, you must 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: +// This operation is not supported by directory buckets. +// +// Returns the tag set associated with the bucket. +// +// To use this operation, you must 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. // // 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) +// +// [PutBucketTagging] +// +// [DeleteBucketTagging] +// +// [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 10540b136a3..d4d7fa261ad 100644 --- a/service/s3/api_op_GetBucketVersioning.go +++ b/service/s3/api_op_GetBucketVersioning.go @@ -14,15 +14,27 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 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) +// This operation is not supported by directory buckets. +// +// 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 bucket owner must use an +// authentication device to change the versioning state of the bucket. +// +// The following operations are related to GetBucketVersioning : +// +// [GetObject] +// +// [PutObject] +// +// [DeleteObject] +// +// [DeleteObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.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 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 c87f6ff1a46..0cb80bd61ad 100644 --- a/service/s3/api_op_GetBucketWebsite.go +++ b/service/s3/api_op_GetBucketWebsite.go @@ -14,17 +14,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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]. +// +// 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 GetBucketWebsite : -// - DeleteBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html) -// - PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) +// bucket policy granting them the S3:GetBucketWebsite permission. +// +// The following operations are related to GetBucketWebsite : +// +// [DeleteBucketWebsite] +// +// [PutBucketWebsite] +// +// [PutBucketWebsite]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html +// [Hosting Websites on Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html +// [DeleteBucketWebsite]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html func (c *Client) GetBucketWebsite(ctx context.Context, params *GetBucketWebsiteInput, optFns ...func(*Options)) (*GetBucketWebsiteOutput, error) { if params == nil { params = &GetBucketWebsiteInput{} diff --git a/service/s3/api_op_GetObject.go b/service/s3/api_op_GetObject.go index a64f5964e11..80edddd15c1 100644 --- a/service/s3/api_op_GetObject.go +++ b/service/s3/api_op_GetObject.go @@ -16,100 +16,141 @@ import ( "time" ) -// Retrieves an object from Amazon S3. In the GetObject request, specify the full -// key name for the object. General purpose buckets - Both the virtual-hosted-style -// requests and the path-style requests are supported. For a virtual hosted-style -// request example, if you have the object photos/2006/February/sample.jpg , -// specify the object key name 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 -// object key name 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) -// in the Amazon S3 User Guide. Directory buckets - Only virtual-hosted-style -// requests are supported. For a virtual hosted-style request example, if you have -// the object photos/2006/February/sample.jpg in the bucket named +// Retrieves an object from Amazon S3. +// +// In the GetObject request, specify the full key name for the object. +// +// General purpose buckets - Both the virtual-hosted-style requests and the +// path-style requests are supported. For a virtual hosted-style request example, +// if you have the object photos/2006/February/sample.jpg , specify the object key +// name 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 object key name as +// /examplebucket/photos/2006/February/sample.jpg . For more information about +// request types, see [HTTP Host Header Bucket Specification]in the Amazon S3 User Guide. +// +// Directory buckets - Only virtual-hosted-style requests are supported. For a +// virtual hosted-style request example, if you have the object +// photos/2006/February/sample.jpg in the bucket named // examplebucket--use1-az5--x-s3 , specify the object key name as // /photos/2006/February/sample.jpg . Also, when you make requests to this API // operation, your requests are sent to the Zonal endpoint. These endpoints support // virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions // - General purpose bucket permissions - You must have the required permissions // in a policy. To use GetObject , you must have the READ access to the object // (or version). If you grant READ access to the anonymous user, the GetObject // operation returns the object without using an authorization header. 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 you include a versionId in your request -// header, you must have the s3:GetObjectVersion permission to access a specific -// version of an object. The s3:GetObject permission is not required in this -// scenario. If you request the current version of an object without a specific -// versionId in the request header, only the s3:GetObject permission is required. -// The s3:GetObjectVersion permission is not required in this scenario. If the -// object that you request doesn’t exist, the error that 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 error. -// - If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP -// status code 403 Access Denied error. -// - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the -// s3express:CreateSession permission to the directory bucket in a bucket policy -// or an IAM identity-based policy. Then, you make the CreateSession API call on -// the bucket to obtain a session token. With the session token in your request -// header, you can make API requests to this operation. After the session token -// expires, you make another CreateSession API call to generate a new session -// token for use. Amazon Web Services CLI or SDKs create session and refresh the -// session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// information, see [Specifying permissions in a policy]in the Amazon S3 User Guide. +// +// If you include a versionId in your request header, you must have the +// +// s3:GetObjectVersion permission to access a specific version of an object. The +// s3:GetObject permission is not required in this scenario. +// +// If you request the current version of an object without a specific versionId in +// +// the request header, only the s3:GetObject permission is required. The +// s3:GetObjectVersion permission is not required in this scenario. +// +// If the object that you request doesn’t exist, the error that 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 error. +// +// - If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP +// status code 403 Access Denied error. +// +// - Directory bucket permissions - To grant access to this API operation on a +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the +// s3express:CreateSession permission to the directory bucket in a bucket policy +// or an IAM identity-based policy. Then, you make the CreateSession API call on +// the bucket to obtain a session token. With the session token in your request +// header, you can make API requests to this operation. After the session token +// expires, you make another CreateSession API call to generate a new session +// token for use. Amazon Web Services CLI or SDKs create session and refresh the +// session token automatically to avoid service interruptions when a session +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Storage classes If the object you are retrieving is stored in the S3 Glacier // Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the // S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep // Archive Access tier, 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 operation 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) -// in the Amazon S3 User Guide. Directory buckets - For directory buckets, only the -// S3 Express One Zone storage class is supported to store newly created objects. -// Unsupported storage class values won't write a destination object and will -// respond with the HTTP status code 400 Bad Request . Encryption Encryption -// request headers, like x-amz-server-side-encryption , should not be sent for the -// GetObject requests, if your object uses server-side encryption with Amazon S3 -// managed encryption keys (SSE-S3), server-side encryption with Key Management -// Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon -// Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject -// requests for the object that uses these types of keys, you’ll get an HTTP 400 -// Bad Request error. Overriding response header values through the request There -// are times when you want to override certain response header values of a -// GetObject response. For example, you might override the Content-Disposition -// response header value through your GetObject request. You can override values -// for a set of response headers. These modified response header values are -// included only in a successful response, that is, when the HTTP status code 200 -// OK is returned. The headers you can override using the following query -// parameters in the request are a subset of the headers that Amazon S3 accepts -// when you create an object. The response headers that you can override for the -// GetObject response are Cache-Control , Content-Disposition , Content-Encoding , -// Content-Language , Content-Type , and Expires . To override values for a set of -// response headers in the GetObject response, you can use the following query -// parameters in the request. +// copy using [RestoreObject]. Otherwise, this operation returns an InvalidObjectState error. For +// information about restoring archived objects, see [Restoring Archived Objects]in the Amazon S3 User Guide. +// +// Directory buckets - For directory buckets, only the S3 Express One Zone storage +// class is supported to store newly created objects. Unsupported storage class +// values won't write a destination object and will respond with the HTTP status +// code 400 Bad Request . +// +// Encryption Encryption request headers, like x-amz-server-side-encryption , +// should not be sent for the GetObject requests, if your object uses server-side +// encryption with Amazon S3 managed encryption keys (SSE-S3), server-side +// encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer +// server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you +// include the header in your GetObject requests for the object that uses these +// types of keys, you’ll get an HTTP 400 Bad Request error. +// +// Overriding response header values through the request There are times when you +// want to override certain response header values of a GetObject response. For +// example, you might override the Content-Disposition response header value +// through your GetObject request. +// +// You can override values for a set of response headers. These modified response +// header values are included only in a successful response, that is, when the HTTP +// status code 200 OK is returned. The headers you can override using the +// following query parameters in the request are a subset of the headers that +// Amazon S3 accepts when you create an object. +// +// The response headers that you can override for the GetObject response are +// Cache-Control , Content-Disposition , Content-Encoding , Content-Language , +// Content-Type , and Expires . +// +// To override values for a set of response headers in the GetObject response, you +// can use the following query parameters in the request. +// // - response-cache-control +// // - response-content-disposition +// // - response-content-encoding +// // - response-content-language +// // - response-content-type +// // - response-expires // // When you use these parameters, you must sign the request by using either an // Authorization header or a presigned URL. These parameters cannot be used with an -// unsigned (anonymous) request. HTTP Host header syntax Directory buckets - The -// HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com . +// unsigned (anonymous) request. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// // 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) +// +// [ListBuckets] +// +// [GetObjectAcl] +// +// [RestoreObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [ListBuckets]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html +// [HTTP Host Header Bucket Specification]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket +// [Restoring Archived Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html +// [GetObjectAcl]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html +// [Specifying permissions in a policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html +// +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*Options)) (*GetObjectOutput, error) { if params == nil { params = &GetObjectInput{} @@ -127,35 +168,44 @@ func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns . type GetObjectInput struct { - // The bucket name containing the object. Directory buckets - When you use this - // operation with a directory bucket, you must use virtual-hosted-style requests in - // the format Bucket_name.s3express-az_id.region.amazonaws.com . Path-style - // requests are not supported. Directory bucket names must be unique in the chosen - // Availability Zone. Bucket names must follow the format - // bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Object Lambda access points - When you use this - // action with an Object Lambda access point, you must direct requests to the - // Object Lambda access point hostname. The Object Lambda access point hostname - // takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. + // The bucket name containing the object. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format + // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not + // supported. Directory bucket names must be unique in the chosen Availability + // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for + // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Object Lambda access points - When you use this action with an Object Lambda + // access point, you must direct requests to the Object Lambda access point + // hostname. The Object Lambda access point hostname takes the form + // AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com. + // // Access points and Object Lambda access points are not supported by directory - // buckets. S3 on Outposts - 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 + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -174,37 +224,55 @@ type GetObjectInput struct { ExpectedBucketOwner *string // Return the object only if its entity tag (ETag) is the same as the one - // specified in this header; otherwise, return a 412 Precondition Failed error. 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. - // For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) - // . + // specified in this header; otherwise, return a 412 Precondition Failed error. + // + // 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. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfMatch *string // Return the object only if it has been modified since the specified time; - // otherwise, return a 304 Not Modified error. 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 status code. For more information - // about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) . + // otherwise, return a 304 Not Modified error. + // + // 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 status code. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfModifiedSince *time.Time // Return the object only if its entity tag (ETag) is different from the one - // specified in this header; otherwise, return a 304 Not Modified error. 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 HTTP status - // code. For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) - // . + // specified in this header; otherwise, return a 304 Not Modified error. + // + // 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 HTTP status code. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfNoneMatch *string // Return the object only if it has not been modified since the specified time; - // otherwise, return a 412 Precondition Failed error. 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. For more information - // about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) . + // otherwise, return a 412 Precondition Failed error. + // + // 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. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfUnmodifiedSince *time.Time // Part number of the object being read. This is a positive integer between 1 and @@ -213,18 +281,23 @@ type GetObjectInput struct { PartNumber *int32 // Downloads the specified byte range 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. + // HTTP Range header, see [https://www.rfc-editor.org/rfc/rfc9110.html#name-range]. + // + // Amazon S3 doesn't support retrieving multiple ranges of data per GET request. + // + // [https://www.rfc-editor.org/rfc/rfc9110.html#name-range]: https://www.rfc-editor.org/rfc/rfc9110.html#name-range 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. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // Sets the Cache-Control header of the response. @@ -245,66 +318,90 @@ type GetObjectInput struct { // Sets the Expires header of the response. ResponseExpires *time.Time - // Specifies the algorithm to use when decrypting the object (for example, AES256 - // ). 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: + // Specifies the algorithm to use when decrypting the object (for example, AES256 ). + // + // 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 - // 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. This functionality is not supported for directory - // buckets. + // + // For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Server-Side Encryption (Using Customer-Provided Encryption Keys)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html SSECustomerAlgorithm *string // Specifies the customer-provided encryption key that you originally provided for // Amazon S3 to encrypt the data before storing it. 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. 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 header. + // + // 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 - // 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. This functionality is not supported for directory - // buckets. + // + // For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Server-Side Encryption (Using Customer-Provided Encryption Keys)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html SSECustomerKey *string // Specifies the 128-bit MD5 digest of the customer-provided encryption key // according to RFC 1321. Amazon S3 uses this header for a message integrity check - // to ensure that the encryption key was transmitted without 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: + // to ensure that the encryption key was transmitted without 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 - // 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. This functionality is not supported for directory - // buckets. + // + // For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Server-Side Encryption (Using Customer-Provided Encryption Keys)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html SSECustomerKeyMD5 *string - // Version ID used to reference a specific version of the object. By default, the - // GetObject operation returns the current version of an object. To return a - // different version, use the versionId subresource. + // Version ID used to reference a specific version of the object. + // + // By default, the GetObject operation returns the current version of an object. + // To return a different version, use the versionId subresource. + // // - If you include a versionId in your request header, you must have the // s3:GetObjectVersion permission to access a specific version of an object. The // s3:GetObject permission is not required in this scenario. + // // - If you request the current version of an object without a specific versionId // in the request header, only the s3:GetObject permission is required. The // s3:GetObjectVersion permission is not required in this scenario. + // // - Directory buckets - S3 Versioning isn't enabled and supported for directory // buckets. For this API operation, only the null value of the version ID is // supported by directory buckets. You can only specify null to the versionId // query parameter in the request. - // For more information about versioning, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html) - // . + // + // For more information about versioning, see [PutBucketVersioning]. + // + // [PutBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html VersionId *string noSmithyDocumentSerde @@ -325,35 +422,40 @@ type GetObjectOutput struct { Body io.ReadCloser // Indicates whether the object uses an S3 Bucket Key for server-side encryption - // with Key Management Service (KMS) keys (SSE-KMS). This functionality is not - // supported for directory buckets. + // with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // Specifies caching behavior along the request/reply chain. CacheControl *string // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be - // present if it was uploaded with 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be - // present if it was uploaded with 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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. 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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. 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA256 *string // Specifies presentational information for the object. @@ -378,9 +480,11 @@ type GetObjectOutput struct { // Indicates whether the object retrieved was (true) or was not (false) a Delete // Marker. If false, this response header does not appear in the response. + // // - 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. + // // - If the specified version in the request is a delete marker, the response // returns a 405 Method Not Allowed error and the Last-Modified: timestamp // response header. @@ -390,20 +494,25 @@ type GetObjectOutput struct { // specific version of a resource found at a URL. ETag *string - // If the object expiration is configured (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 + // If the object expiration is configured (see [PutBucketLifecycleConfiguration]PutBucketLifecycleConfiguration ), + // the response includes this header. It includes the expiry-date and rule-id // key-value pairs providing object expiration information. The value of the - // rule-id is URL-encoded. This functionality is not supported for directory - // buckets. + // rule-id is URL-encoded. + // + // This functionality is not supported for directory buckets. + // + // [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html Expiration *string // The date and time at which the object is no longer cacheable. Expires *time.Time - // Date and time when the object was last modified. General purpose buckets - When - // you specify a versionId of the object in your request, if the specified version - // in the request is a delete marker, the response returns a 405 Method Not Allowed - // error and the Last-Modified: timestamp response header. + // Date and time when the object was last modified. + // + // General purpose buckets - When you specify a versionId of the object in your + // request, if the specified version in the request is a delete marker, the + // response returns a 405 Method Not Allowed error and the Last-Modified: timestamp + // response header. LastModified *time.Time // A map of metadata to store with the object in S3. @@ -415,20 +524,25 @@ type GetObjectOutput struct { // are prefixed with x-amz-meta- . This can happen if you create metadata using an // API like SOAP that supports more flexible metadata than the REST API. For // example, using SOAP, you can create metadata whose values are not legal HTTP - // headers. This functionality is not supported for directory buckets. + // headers. + // + // This functionality is not supported for directory buckets. MissingMeta *int32 // Indicates whether this object has an active legal hold. This field is only - // returned if you have permission to view an object's legal hold status. This - // functionality is not supported for directory buckets. + // returned if you have permission to view an object's legal hold status. + // + // This functionality is not supported for directory buckets. ObjectLockLegalHoldStatus types.ObjectLockLegalHoldStatus - // The Object Lock mode that's currently in place for this object. This - // functionality is not supported for directory buckets. + // The Object Lock mode that's currently in place for this object. + // + // This functionality is not supported for directory buckets. ObjectLockMode types.ObjectLockMode - // The date and time when this object's Object Lock will expire. This - // functionality is not supported for directory buckets. + // The date and time when this object's Object Lock will expire. + // + // This functionality is not supported for directory buckets. ObjectLockRetainUntilDate *time.Time // The count of parts this object has. This value is only returned if you specify @@ -436,63 +550,78 @@ type GetObjectOutput struct { PartsCount *int32 // Amazon S3 can return this if your request involves a bucket that is either a - // source or destination in a replication rule. This functionality is not supported - // for directory buckets. + // source or destination in a replication rule. + // + // This functionality is not supported for directory buckets. ReplicationStatus types.ReplicationStatus // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Provides information about object restoration action and expiration time of the - // restored object copy. This functionality is not supported for directory buckets. - // Only the S3 Express One Zone storage class is supported by directory buckets to - // store objects. + // restored object copy. + // + // This functionality is not supported for directory buckets. Only the S3 Express + // One Zone storage class is supported by directory buckets to store objects. Restore *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). For directory buckets, only - // server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is - // supported. + // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. 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. Directory buckets - // - Only the S3 Express One Zone storage class is supported by directory buckets - // to store objects. + // for all objects except for S3 Standard storage class objects. + // + // Directory buckets - Only the S3 Express One Zone storage class is supported by + // directory buckets to store objects. StorageClass types.StorageClass // The number of tags, if any, on the object, when you have the relevant - // permission to read object tags. You can use GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) - // to retrieve the tag set associated with an object. This functionality is not - // supported for directory buckets. + // permission to read object tags. + // + // You can use [GetObjectTagging] to retrieve the tag set associated with an object. + // + // This functionality is not supported for directory buckets. + // + // [GetObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html TagCount *int32 - // Version ID of the object. This functionality is not supported for directory - // buckets. + // Version ID of the object. + // + // This functionality is not supported for directory buckets. VersionId *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. This functionality is not supported - // for directory buckets. + // value of this header in the object metadata. + // + // This functionality is not supported for directory buckets. WebsiteRedirectLocation *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetObjectAcl.go b/service/s3/api_op_GetObjectAcl.go index fc903cb390d..9ee25c4e69f 100644 --- a/service/s3/api_op_GetObjectAcl.go +++ b/service/s3/api_op_GetObjectAcl.go @@ -13,24 +13,39 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) -// in the Amazon S3 User Guide This functionality is not supported for Amazon S3 on -// Outposts. 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 +// This operation is not supported by directory buckets. +// +// 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]in the Amazon S3 User Guide +// +// This functionality is not supported for Amazon S3 on Outposts. +// +// 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) -// 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) +// bucket. For more information, see [Controlling object ownership and disabling ACLs]in the Amazon S3 User Guide. +// +// The following operations are related to GetObjectAcl : +// +// [GetObject] +// +// [GetObjectAttributes] +// +// [DeleteObject] +// +// [PutObject] +// +// [DeleteObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html +// [Mapping of ACL permissions and access policy permissions]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping +// [GetObjectAttributes]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.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 +// [Controlling object ownership and disabling ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html func (c *Client) GetObjectAcl(ctx context.Context, params *GetObjectAclInput, optFns ...func(*Options)) (*GetObjectAclOutput, error) { if params == nil { params = &GetObjectAclInput{} @@ -49,6 +64,7 @@ func (c *Client) GetObjectAcl(ctx context.Context, params *GetObjectAclInput, op type GetObjectAclInput struct { // The bucket name that contains the object for which to get the ACL information. + // // Access points - When you use this action with 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 @@ -56,8 +72,9 @@ 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) - // in the Amazon S3 User Guide. + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -76,14 +93,17 @@ type GetObjectAclInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Version ID used to reference a specific version of the object. This - // functionality is not supported for directory buckets. + // Version ID used to reference a specific version of the object. + // + // This functionality is not supported for directory buckets. VersionId *string noSmithyDocumentSerde @@ -100,11 +120,13 @@ type GetObjectAclOutput struct { // A list of grants. Grants []types.Grant - // Container for the bucket owner's display name and ID. + // Container for the bucket owner's display name and ID. Owner *types.Owner // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetObjectAttributes.go b/service/s3/api_op_GetObjectAttributes.go index dd1b9257cdb..432b879a0b5 100644 --- a/service/s3/api_op_GetObjectAttributes.go +++ b/service/s3/api_op_GetObjectAttributes.go @@ -16,32 +16,39 @@ import ( // Retrieves all the metadata from an object without returning the object itself. // This operation is useful if you're interested only in an object's metadata. +// // 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 . Directory buckets - For directory buckets, -// you must make requests for this API operation to the Zonal endpoint. These -// endpoints support virtual-hosted-style requests in the format +// single call to GetObjectAttributes . +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - To use GetObjectAttributes , you must // have READ access to the object. The permissions that you need to use this // operation with 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. +// permissions. For more information, see [Specifying Permissions in a Policy]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. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -49,8 +56,7 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Encryption Encryption request headers, like x-amz-server-side-encryption , // should not be sent for HEAD requests if your object uses server-side encryption @@ -61,49 +67,86 @@ import ( // want to specify the encryption method. If you include this header in a GET // request for an object that uses these types of keys, you’ll get an HTTP 400 Bad // Request error. It's because the encryption method can't be changed when you -// retrieve the object. 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 to provide the encryption key for the server to be able to -// retrieve the object's metadata. The headers are: +// retrieve the object. +// +// 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 to +// provide the encryption key for the server to be able to retrieve the object's +// metadata. The headers are: +// // - 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) -// in the Amazon S3 User Guide. Directory bucket permissions - For directory -// buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) ( -// AES256 ) is supported. Versioning Directory buckets - S3 Versioning isn't -// enabled and supported for directory buckets. For this API operation, only the -// null value of the version ID is supported by directory buckets. You can only -// specify null to the versionId query parameter in the request. Conditional -// request headers Consider the following when using request headers: +// For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the Amazon S3 User Guide. +// +// Directory bucket permissions - For directory buckets, only server-side +// encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. +// +// Versioning Directory buckets - S3 Versioning isn't enabled and supported for +// directory buckets. For this API operation, only the null value of the version +// ID is supported by directory buckets. You can only specify null to the versionId +// query parameter in the request. +// +// Conditional request headers 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 . For more information -// about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) -// . +// +// - If-Unmodified-Since condition evaluates to false . +// +// For more information about conditional requests, see [RFC 7232]. +// // - 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) . -// -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// +// - If-Modified-Since condition evaluates to true . +// +// For more information about conditional requests, see [RFC 7232]. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following actions are related to GetObjectAttributes : +// +// [GetObject] +// +// [GetObjectAcl] +// +// [GetObjectLegalHold] +// +// [GetObjectLockConfiguration] +// +// [GetObjectRetention] +// +// [GetObjectTagging] +// +// [HeadObject] +// +// [ListParts] +// +// [GetObjectLegalHold]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html +// [ListParts]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html +// [Server-Side Encryption (Using Customer-Provided Encryption Keys)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [GetObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html +// [RFC 7232]: https://tools.ietf.org/html/rfc7232 +// [HeadObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html +// [GetObjectLockConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html +// [GetObjectAcl]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html +// [GetObjectRetention]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html func (c *Client) GetObjectAttributes(ctx context.Context, params *GetObjectAttributesInput, optFns ...func(*Options)) (*GetObjectAttributesOutput, error) { if params == nil { params = &GetObjectAttributesInput{} @@ -121,31 +164,39 @@ func (c *Client) GetObjectAttributes(ctx context.Context, params *GetObjectAttri type GetObjectAttributesInput struct { - // The name of the bucket that contains the object. Directory buckets - When you - // use this operation with a directory bucket, you must use virtual-hosted-style - // requests in the format Bucket_name.s3express-az_id.region.amazonaws.com . - // Path-style requests are not supported. Directory bucket names must be unique in - // the chosen Availability Zone. Bucket names must follow the format - // bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // The name of the bucket that contains the object. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format + // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not + // supported. Directory bucket names must be unique in the chosen Availability + // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for + // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -177,32 +228,38 @@ type GetObjectAttributesInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, - // AES256). This functionality is not supported for directory buckets. + // Specifies the algorithm to use when encrypting the object (for example, AES256). + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in // 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 functionality is - // not supported for directory buckets. + // x-amz-server-side-encryption-customer-algorithm header. + // + // This functionality is not supported for directory buckets. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported for directory buckets. + // encryption key was transmitted without error. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string - // The version ID used to reference a specific version of the object. S3 - // Versioning isn't enabled and supported for directory buckets. For this API + // The version ID used to reference a specific version of the object. + // + // S3 Versioning isn't enabled and supported for directory buckets. For this API // operation, only the null value of the version ID is supported by directory // buckets. You can only specify null to the versionId query parameter in the // request. @@ -223,6 +280,7 @@ type GetObjectAttributesOutput struct { // 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. + // // This functionality is not supported for directory buckets. DeleteMarker *bool @@ -240,18 +298,25 @@ type GetObjectAttributesOutput struct { ObjectSize *int64 // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // 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) - // . Directory buckets - Only the S3 Express One Zone storage class is supported by + // header for all objects except for S3 Standard storage class objects. + // + // For more information, see [Storage Classes]. + // + // Directory buckets - Only the S3 Express One Zone storage class is supported by // directory buckets to store objects. + // + // [Storage Classes]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html StorageClass types.StorageClass - // The version ID of the object. This functionality is not supported for directory - // buckets. + // The version ID of the object. + // + // This functionality is not supported for directory buckets. VersionId *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetObjectLegalHold.go b/service/s3/api_op_GetObjectLegalHold.go index 548f5e1cc68..76edc7ad29f 100644 --- a/service/s3/api_op_GetObjectLegalHold.go +++ b/service/s3/api_op_GetObjectLegalHold.go @@ -13,11 +13,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 functionality is not supported for Amazon S3 on Outposts. The following -// action is related to GetObjectLegalHold : -// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// This operation is not supported by directory buckets. +// +// Gets an object's current legal hold status. For more information, see [Locking Objects]. +// +// This functionality is not supported for Amazon S3 on Outposts. +// +// The following action is related to GetObjectLegalHold : +// +// [GetObjectAttributes] +// +// [GetObjectAttributes]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html +// [Locking Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html func (c *Client) GetObjectLegalHold(ctx context.Context, params *GetObjectLegalHoldInput, optFns ...func(*Options)) (*GetObjectLegalHoldOutput, error) { if params == nil { params = &GetObjectLegalHoldInput{} @@ -36,15 +43,18 @@ func (c *Client) GetObjectLegalHold(ctx context.Context, params *GetObjectLegalH type GetObjectLegalHoldInput struct { // The bucket name containing the object whose legal hold status you want to - // retrieve. Access points - When you use this action with 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 + // retrieve. + // + // Access points - When you use this action with 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 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. + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -63,10 +73,12 @@ type GetObjectLegalHoldInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The version ID of the object whose legal hold status you want to retrieve. diff --git a/service/s3/api_op_GetObjectLockConfiguration.go b/service/s3/api_op_GetObjectLockConfiguration.go index e8e2fbd9f34..e170ecad1d3 100644 --- a/service/s3/api_op_GetObjectLockConfiguration.go +++ b/service/s3/api_op_GetObjectLockConfiguration.go @@ -13,12 +13,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]. +// +// The following action is related to GetObjectLockConfiguration : +// +// [GetObjectAttributes] +// +// [GetObjectAttributes]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html +// [Locking Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html func (c *Client) GetObjectLockConfiguration(ctx context.Context, params *GetObjectLockConfigurationInput, optFns ...func(*Options)) (*GetObjectLockConfigurationOutput, error) { if params == nil { params = &GetObjectLockConfigurationInput{} @@ -36,16 +42,18 @@ func (c *Client) GetObjectLockConfiguration(ctx context.Context, params *GetObje type GetObjectLockConfigurationInput struct { - // The bucket whose Object Lock configuration you want to retrieve. Access points - // - When you use this action with 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 + // The bucket whose Object Lock configuration you want to retrieve. + // + // Access points - When you use this action with 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 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. + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string diff --git a/service/s3/api_op_GetObjectRetention.go b/service/s3/api_op_GetObjectRetention.go index b4daabf16fa..93b8115c2c0 100644 --- a/service/s3/api_op_GetObjectRetention.go +++ b/service/s3/api_op_GetObjectRetention.go @@ -13,11 +13,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Retrieves an object's -// retention settings. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) -// . This functionality is not supported for Amazon S3 on Outposts. The following -// action is related to GetObjectRetention : -// - GetObjectAttributes (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html) +// This operation is not supported by directory buckets. +// +// Retrieves an object's retention settings. For more information, see [Locking Objects]. +// +// This functionality is not supported for Amazon S3 on Outposts. +// +// The following action is related to GetObjectRetention : +// +// [GetObjectAttributes] +// +// [GetObjectAttributes]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html +// [Locking Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html func (c *Client) GetObjectRetention(ctx context.Context, params *GetObjectRetentionInput, optFns ...func(*Options)) (*GetObjectRetentionOutput, error) { if params == nil { params = &GetObjectRetentionInput{} @@ -36,15 +43,18 @@ func (c *Client) GetObjectRetention(ctx context.Context, params *GetObjectRetent type GetObjectRetentionInput struct { // The bucket name containing the object whose retention settings you want to - // retrieve. Access points - When you use this action with 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 + // retrieve. + // + // Access points - When you use this action with 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 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. + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -63,10 +73,12 @@ type GetObjectRetentionInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The version ID for the object whose retention settings you want to retrieve. diff --git a/service/s3/api_op_GetObjectTagging.go b/service/s3/api_op_GetObjectTagging.go index dc15914a0e4..4aa175010b4 100644 --- a/service/s3/api_op_GetObjectTagging.go +++ b/service/s3/api_op_GetObjectTagging.go @@ -13,20 +13,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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) +// 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]. +// +// The following actions are related to GetObjectTagging : +// +// [DeleteObjectTagging] +// +// [GetObjectAttributes] +// +// [PutObjectTagging] +// +// [DeleteObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html +// [PutObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html +// [GetObjectAttributes]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html +// [Object Tagging]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html func (c *Client) GetObjectTagging(ctx context.Context, params *GetObjectTaggingInput, optFns ...func(*Options)) (*GetObjectTaggingOutput, error) { if params == nil { params = &GetObjectTaggingInput{} @@ -45,6 +60,7 @@ func (c *Client) GetObjectTagging(ctx context.Context, params *GetObjectTaggingI type GetObjectTaggingInput struct { // The bucket name containing the object for which to get the tagging information. + // // Access points - When you use this action with 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 @@ -52,15 +68,18 @@ 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) - // in the Amazon S3 User Guide. S3 on Outposts - 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 + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -79,10 +98,12 @@ type GetObjectTaggingInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The versionId of the object for which to get the tagging information. diff --git a/service/s3/api_op_GetObjectTorrent.go b/service/s3/api_op_GetObjectTorrent.go index 9fc83178e66..04b1dad8d8c 100644 --- a/service/s3/api_op_GetObjectTorrent.go +++ b/service/s3/api_op_GetObjectTorrent.go @@ -14,14 +14,24 @@ import ( "io" ) -// This operation is not supported by directory buckets. Returns torrent files -// from a bucket. BitTorrent can save you bandwidth when you're distributing large -// files. You can get torrent only for objects that are 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 -// functionality is not supported for Amazon S3 on Outposts. The following action -// is related to GetObjectTorrent : -// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// This operation is not supported by directory buckets. +// +// Returns torrent files from a bucket. BitTorrent can save you bandwidth when +// you're distributing large files. +// +// You can get torrent only for objects that are 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 functionality is not supported for Amazon S3 on Outposts. +// +// The following action is related to GetObjectTorrent : +// +// [GetObject] +// +// [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{} @@ -58,10 +68,12 @@ type GetObjectTorrentInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer noSmithyDocumentSerde @@ -78,7 +90,9 @@ type GetObjectTorrentOutput struct { Body io.ReadCloser // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_GetPublicAccessBlock.go b/service/s3/api_op_GetPublicAccessBlock.go index 3689a4e1634..e09ce2792cd 100644 --- a/service/s3/api_op_GetPublicAccessBlock.go +++ b/service/s3/api_op_GetPublicAccessBlock.go @@ -14,22 +14,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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]. +// +// 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) +// account-level settings. +// +// For more information about when Amazon S3 considers a bucket or an object +// public, see [The Meaning of "Public"]. +// +// The following operations are related to GetPublicAccessBlock : +// +// [Using Amazon S3 Block Public Access] +// +// [PutPublicAccessBlock] +// +// [GetPublicAccessBlock] +// +// [DeletePublicAccessBlock] +// +// [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 +// [Using Amazon S3 Block Public Access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html +// [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 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 5f5958916a9..413e4ecaced 100644 --- a/service/s3/api_op_HeadBucket.go +++ b/service/s3/api_op_HeadBucket.go @@ -19,42 +19,54 @@ import ( // You can use this operation to determine if a bucket exists and if 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 HTTP response codes. Directory -// buckets - You must make requests for this API operation to the Zonal endpoint. -// These endpoints support virtual-hosted-style requests in the format +// 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 HTTP response codes. +// +// Directory buckets - You must make requests for this API operation to the Zonal +// endpoint. These endpoints support virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests -// are not supported. For more information, see Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Authentication and authorization All HeadBucket -// requests must be authenticated and signed by using IAM credentials (access key -// ID and secret access key for the IAM identities). All headers with the x-amz- -// prefix, including x-amz-copy-source , must be signed. For more information, see -// REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) -// . Directory bucket - You must use IAM credentials to authenticate and authorize +// are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User Guide. +// +// Authentication and authorization All HeadBucket requests must be authenticated +// and signed by using IAM credentials (access key ID and secret access key for the +// IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source +// , must be signed. For more information, see [REST Authentication]. +// +// Directory bucket - You must use IAM credentials to authenticate and authorize // your access to the HeadBucket API operation, instead of using the temporary -// security credentials through the CreateSession API operation. Amazon Web -// Services CLI or SDKs handles authentication and authorization on your behalf. +// security credentials through the CreateSession API operation. +// +// Amazon Web Services CLI or SDKs handles authentication and authorization on +// your behalf. +// // Permissions +// // - General purpose bucket permissions - 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 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. +// information about permissions, see [Managing access permissions to your Amazon S3 resources]in the Amazon S3 User Guide. +// // - Directory bucket permissions - You must have the s3express:CreateSession // permission in the Action element of a policy. By default, the session is in // the ReadWrite mode. If you want to restrict the access, you can explicitly set -// the s3express:SessionMode condition key to ReadOnly on the bucket. For more -// information about example bucket policies, see Example bucket policies for S3 -// Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// and Amazon Web Services Identity and Access Management (IAM) identity-based -// policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html) -// in the Amazon S3 User Guide. +// the s3express:SessionMode condition key to ReadOnly on the bucket. +// +// For more information about example bucket policies, see [Example bucket policies for S3 Express One Zone]and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]in the Amazon S3 +// +// User Guide. // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is // Bucket_name.s3express-az_id.region.amazonaws.com . +// +// [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html +// [REST Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html +// [Example bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Managing access permissions to your Amazon S3 resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html func (c *Client) HeadBucket(ctx context.Context, params *HeadBucketInput, optFns ...func(*Options)) (*HeadBucketOutput, error) { if params == nil { params = &HeadBucketInput{} @@ -72,36 +84,46 @@ func (c *Client) HeadBucket(ctx context.Context, params *HeadBucketInput, optFns type HeadBucketInput struct { - // The bucket name. Directory buckets - When you use this operation with a - // directory bucket, you must use virtual-hosted-style requests in the format + // The bucket name. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Object Lambda access points - When you use this API - // operation with an Object Lambda access point, provide the alias of the Object - // Lambda access point in place of the bucket name. If the Object Lambda access - // point alias in a request is not valid, the error code - // InvalidAccessPointAliasError is returned. For more information about - // InvalidAccessPointAliasError , see List of Error Codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList) - // . Access points and Object Lambda access points are not supported by directory - // buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Object Lambda access points - When you use this API operation with an Object + // Lambda access point, provide the alias of the Object Lambda access point in + // place of the bucket name. If the Object Lambda access point alias in a request + // is not valid, the error code InvalidAccessPointAliasError is returned. For more + // information about InvalidAccessPointAliasError , see [List of Error Codes]. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html + // [List of Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList // // This member is required. Bucket *string @@ -122,21 +144,26 @@ func (in *HeadBucketInput) bindEndpointParams(p *EndpointParameters) { type HeadBucketOutput struct { // Indicates whether the bucket name used in the request is an access point alias. + // // This functionality is not supported for directory buckets. AccessPointAlias *bool - // The name of the location where the bucket will be created. For directory - // buckets, the AZ ID of the Availability Zone where the bucket is created. An - // example AZ ID value is usw2-az1 . This functionality is only supported by - // directory buckets. + // The name of the location where the bucket will be created. + // + // For directory buckets, the AZ ID of the Availability Zone where the bucket is + // created. An example AZ ID value is usw2-az1 . + // + // This functionality is only supported by directory buckets. BucketLocationName *string - // The type of location where the bucket is created. This functionality is only - // supported by directory buckets. + // The type of location where the bucket is created. + // + // This functionality is only supported by directory buckets. BucketLocationType types.LocationType - // The Region that the bucket is located. This functionality is not supported for - // directory buckets. + // The Region that the bucket is located. + // + // This functionality is not supported for directory buckets. BucketRegion *string // Metadata pertaining to the operation's result. @@ -285,12 +312,13 @@ type BucketExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *HeadBucketInput, *HeadBucketOutput, error) (bool, error) } @@ -450,12 +478,13 @@ type BucketNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *HeadBucketInput, *HeadBucketOutput, error) (bool, error) } diff --git a/service/s3/api_op_HeadObject.go b/service/s3/api_op_HeadObject.go index 5b7e9b6c351..ddddfe5c161 100644 --- a/service/s3/api_op_HeadObject.go +++ b/service/s3/api_op_HeadObject.go @@ -19,43 +19,52 @@ import ( // The HEAD operation retrieves metadata from an object without returning the // object itself. This operation is useful if you're interested only in an object's -// metadata. A HEAD request has the same options as a GET operation on an object. -// The response is identical to the GET response except that there is no response +// metadata. +// +// A HEAD request has the same options as a GET operation 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 code, such as 400 Bad Request , 403 Forbidden , 404 Not Found , 405 // Method Not Allowed , 412 Precondition Failed , or 304 Not Modified . It's not -// possible to retrieve the exact exception of these error codes. 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) -// . Directory buckets - For directory buckets, you must make requests for this API +// possible to retrieve the exact exception of these error codes. +// +// Request headers are limited to 8 KB in size. For more information, see [Common Request Headers]. +// +// Directory buckets - For directory buckets, you must make requests for this API // operation to the Zonal endpoint. These endpoints support virtual-hosted-style // requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - To use HEAD , you must have the // s3:GetObject permission. You need the relevant read object (or version) -// permission for this operation. For more information, see Actions, resources, -// and condition keys for Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) -// in the Amazon S3 User Guide. If the object you request doesn't exist, the error -// that 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 error. -// - If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP -// status code 403 Forbidden error. -// - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the -// s3express:CreateSession permission to the directory bucket in a bucket policy -// or an IAM identity-based policy. Then, you make the CreateSession API call on -// the bucket to obtain a session token. With the session token in your request -// header, you can make API requests to this operation. After the session token -// expires, you make another CreateSession API call to generate a new session -// token for use. Amazon Web Services CLI or SDKs create session and refresh the -// session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// permission for this operation. For more information, see [Actions, resources, and condition keys for Amazon S3]in the Amazon S3 +// User Guide. +// +// If the object you request doesn't exist, the error that 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 error. +// +// - If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP +// status code 403 Forbidden error. +// +// - Directory bucket permissions - To grant access to this API operation on a +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the +// s3express:CreateSession permission to the directory bucket in a bucket policy +// or an IAM identity-based policy. Then, you make the CreateSession API call on +// the bucket to obtain a session token. With the session token in your request +// header, you can make API requests to this operation. After the session token +// expires, you make another CreateSession API call to generate a new session +// token for use. Amazon Web Services CLI or SDKs create session and refresh the +// session token automatically to avoid service interruptions when a session +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Encryption Encryption request headers, like x-amz-server-side-encryption , // should not be sent for HEAD requests if your object uses server-side encryption @@ -66,20 +75,26 @@ import ( // want to specify the encryption method. If you include this header in a HEAD // request for an object that uses these types of keys, you’ll get an HTTP 400 Bad // Request error. It's because the encryption method can't be changed when you -// retrieve the object. 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 to provide the encryption key for the server to be able to -// retrieve the object's metadata. The headers are: +// retrieve the object. +// +// 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 to +// provide the encryption key for the server to be able to retrieve the object's +// metadata. The headers are: +// // - 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) -// in the Amazon S3 User Guide. Directory bucket permissions - For directory -// buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) ( -// AES256 ) is supported. Versioning +// For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)] in the Amazon S3 User Guide. +// +// Directory bucket permissions - For directory buckets, only server-side +// encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. +// +// Versioning // // - 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 @@ -95,11 +110,23 @@ import ( // supported by directory buckets. You can only specify null to the versionId // query parameter in the request. // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following actions are related to HeadObject : +// +// [GetObject] +// +// [GetObjectAttributes] +// +// [Server-Side Encryption (Using Customer-Provided Encryption Keys)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [GetObjectAttributes]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html +// [Actions, resources, and condition keys for Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html +// [Common Request Headers]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html +// +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html func (c *Client) HeadObject(ctx context.Context, params *HeadObjectInput, optFns ...func(*Options)) (*HeadObjectOutput, error) { if params == nil { params = &HeadObjectInput{} @@ -117,31 +144,39 @@ func (c *Client) HeadObject(ctx context.Context, params *HeadObjectInput, optFns type HeadObjectInput struct { - // The name of the bucket that contains the object. Directory buckets - When you - // use this operation with a directory bucket, you must use virtual-hosted-style - // requests in the format Bucket_name.s3express-az_id.region.amazonaws.com . - // Path-style requests are not supported. Directory bucket names must be unique in - // the chosen Availability Zone. Bucket names must follow the format - // bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // The name of the bucket that contains the object. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format + // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not + // supported. Directory bucket names must be unique in the chosen Availability + // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for + // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -151,10 +186,11 @@ type HeadObjectInput struct { // This member is required. Key *string - // To retrieve the checksum, this parameter must be enabled. In addition, if you - // enable ChecksumMode and the object is encrypted with Amazon Web Services Key - // Management Service (Amazon Web Services KMS), you must have permission to use - // the kms:Decrypt action for the request to succeed. + // To retrieve the checksum, this parameter must be enabled. + // + // In addition, if you enable ChecksumMode and the object is encrypted with Amazon + // Web Services Key Management Service (Amazon Web Services KMS), you must have + // permission to use the kms:Decrypt action for the request to succeed. ChecksumMode types.ChecksumMode // The account ID of the expected bucket owner. If the account ID that you provide @@ -163,40 +199,71 @@ type HeadObjectInput struct { ExpectedBucketOwner *string // Return the object only if its entity tag (ETag) is the same as the one - // specified; otherwise, return a 412 (precondition failed) error. If both of the - // If-Match and If-Unmodified-Since headers are present in the request as follows: + // specified; otherwise, return a 412 (precondition failed) error. + // + // 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. For more information - // about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) . + // + // Then Amazon S3 returns 200 OK and the data requested. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfMatch *string // Return the object only if it has been modified since the specified time; - // otherwise, return a 304 (not modified) error. If both of the If-None-Match and - // If-Modified-Since headers are present in the request as follows: + // otherwise, return a 304 (not modified) error. + // + // 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) . + // + // Then Amazon S3 returns the 304 Not Modified response code. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfModifiedSince *time.Time // Return the object only if its entity tag (ETag) is different from the one - // specified; otherwise, return a 304 (not modified) error. If both of the - // If-None-Match and If-Modified-Since headers are present in the request as - // follows: + // specified; otherwise, return a 304 (not modified) error. + // + // 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) . + // + // Then Amazon S3 returns the 304 Not Modified response code. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfNoneMatch *string // Return the object only if it has not been modified since the specified time; - // otherwise, return a 412 (precondition failed) error. If both of the If-Match - // and If-Unmodified-Since headers are present in the request as follows: + // otherwise, return a 412 (precondition failed) error. + // + // 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. For more information - // about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232) . + // + // Then Amazon S3 returns 200 OK and the data requested. + // + // For more information about conditional requests, see [RFC 7232]. + // + // [RFC 7232]: https://tools.ietf.org/html/rfc7232 IfUnmodifiedSince *time.Time // Part number of the object being read. This is a positive integer between 1 and @@ -214,33 +281,39 @@ type HeadObjectInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, - // AES256). This functionality is not supported for directory buckets. + // Specifies the algorithm to use when encrypting the object (for example, AES256). + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in // 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 functionality is - // not supported for directory buckets. + // x-amz-server-side-encryption-customer-algorithm header. + // + // This functionality is not supported for directory buckets. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported for directory buckets. + // encryption key was transmitted without error. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string - // Version ID used to reference a specific version of the object. For directory - // buckets in this API operation, only the null value of the version ID is - // supported. + // Version ID used to reference a specific version of the object. + // + // For directory buckets in this API operation, only the null value of the version + // ID is supported. VersionId *string noSmithyDocumentSerde @@ -257,13 +330,15 @@ type HeadObjectOutput struct { // Indicates that a range of bytes was specified. AcceptRanges *string - // The archive state of the head object. This functionality is not supported for - // directory buckets. + // The archive state of the head object. + // + // This functionality is not supported for directory buckets. ArchiveStatus types.ArchiveStatus // Indicates whether the object uses an S3 Bucket Key for server-side encryption - // with Key Management Service (KMS) keys (SSE-KMS). This functionality is not - // supported for directory buckets. + // with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // Specifies caching behavior along the request/reply chain. @@ -274,8 +349,10 @@ type HeadObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -283,8 +360,10 @@ type HeadObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -292,8 +371,10 @@ type HeadObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -301,8 +382,10 @@ type HeadObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string // Specifies presentational information for the object. @@ -323,19 +406,23 @@ type HeadObjectOutput struct { ContentType *string // 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. This - // functionality is not supported for directory buckets. + // Marker. If false, this response header does not appear in the response. + // + // This functionality is not supported for directory buckets. DeleteMarker *bool // An entity tag (ETag) is an opaque identifier assigned by a web server to a // specific version of a resource found at a URL. ETag *string - // If the object expiration is configured (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 + // If the object expiration is configured (see [PutBucketLifecycleConfiguration]PutBucketLifecycleConfiguration ), + // the response includes this header. It includes the expiry-date and rule-id // key-value pairs providing object expiration information. The value of the - // rule-id is URL-encoded. This functionality is not supported for directory - // buckets. + // rule-id is URL-encoded. + // + // This functionality is not supported for directory buckets. + // + // [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html Expiration *string // The date and time at which the object is no longer cacheable. @@ -352,26 +439,34 @@ type HeadObjectOutput struct { // This is set to the number of metadata entries not returned in x-amz-meta // headers. This can happen if you create metadata using an API like SOAP that // supports more flexible metadata than the REST API. For example, using SOAP, you - // can create metadata whose values are not legal HTTP headers. This functionality - // is not supported for directory buckets. + // can create metadata whose values are not legal HTTP headers. + // + // This functionality is not supported for directory buckets. 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) - // . This functionality is not supported for directory buckets. + // legal hold applied. For more information about S3 Object Lock, see [Object Lock]. + // + // This functionality is not supported for directory buckets. + // + // [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) - // . This functionality is not supported for directory buckets. + // more information about S3 Object Lock, see [Object Lock]. + // + // This functionality is not supported for directory buckets. + // + // [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 - // only returned if the requester has the s3:GetObjectRetention permission. This - // functionality is not supported for directory buckets. + // only returned if the requester has the s3:GetObjectRetention permission. + // + // This functionality is not supported for directory buckets. ObjectLockRetainUntilDate *time.Time // The count of parts this object has. This value is only returned if you specify @@ -379,89 +474,121 @@ type HeadObjectOutput struct { PartsCount *int32 // 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 - // return the x-amz-replication-status header in the response as follows: + // 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 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. + // 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) - // . This functionality is not supported for directory buckets. + // + // For more information, see [Replication]. + // + // This functionality is not supported for directory buckets. + // + // [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 - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // 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) - // . This functionality is not supported for directory buckets. Only the S3 Express + // progress (see [RestoreObject]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]. + // + // This functionality is not supported for directory buckets. Only the S3 Express // One Zone storage class is supported by directory buckets to store objects. + // + // [Transitioning Objects: General Considerations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations + // [RestoreObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html Restore *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). For directory buckets, only - // server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is - // supported. + // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. 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) - // . Directory buckets - Only the S3 Express One Zone storage class is supported by + // for all objects except for S3 Standard storage class objects. + // + // For more information, see [Storage Classes]. + // + // Directory buckets - Only the S3 Express One Zone storage class is supported by // directory buckets to store objects. + // + // [Storage Classes]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html StorageClass types.StorageClass - // Version ID of the object. This functionality is not supported for directory - // buckets. + // Version ID of the object. + // + // This functionality is not supported for directory buckets. VersionId *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. This functionality is not supported - // for directory buckets. + // value of this header in the object metadata. + // + // This functionality is not supported for directory buckets. WebsiteRedirectLocation *string // Metadata pertaining to the operation's result. @@ -610,12 +737,13 @@ type ObjectExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *HeadObjectInput, *HeadObjectOutput, error) (bool, error) } @@ -775,12 +903,13 @@ type ObjectNotExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *HeadObjectInput, *HeadObjectOutput, error) (bool, error) } diff --git a/service/s3/api_op_ListBucketAnalyticsConfigurations.go b/service/s3/api_op_ListBucketAnalyticsConfigurations.go index 67b7571c111..bc31e5695a4 100644 --- a/service/s3/api_op_ListBucketAnalyticsConfigurations.go +++ b/service/s3/api_op_ListBucketAnalyticsConfigurations.go @@ -14,27 +14,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Lists the analytics -// configurations for the bucket. You can have up to 1,000 analytics configurations -// per bucket. This action supports list pagination and 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 . You use the +// This operation is not supported by directory buckets. +// +// Lists the analytics configurations for the bucket. You can have up to 1,000 +// analytics configurations per bucket. +// +// This action supports list pagination and 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 . 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 +// 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) +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about Amazon S3 analytics feature, see [Amazon S3 Analytics – Storage Class Analysis]. +// +// The following operations are related to ListBucketAnalyticsConfigurations : +// +// [GetBucketAnalyticsConfiguration] +// +// [DeleteBucketAnalyticsConfiguration] +// +// [PutBucketAnalyticsConfiguration] +// +// [Amazon S3 Analytics – Storage Class Analysis]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html +// [DeleteBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.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 +// [GetBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html +// [PutBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html func (c *Client) ListBucketAnalyticsConfigurations(ctx context.Context, params *ListBucketAnalyticsConfigurationsInput, optFns ...func(*Options)) (*ListBucketAnalyticsConfigurationsOutput, error) { if params == nil { params = &ListBucketAnalyticsConfigurationsInput{} diff --git a/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go b/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go index 729f8785676..0a6cb145fb4 100644 --- a/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go +++ b/service/s3/api_op_ListBucketIntelligentTieringConfigurations.go @@ -14,25 +14,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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, +// This operation is not supported by directory buckets. +// +// 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 // tiers. To get the lowest storage cost on data that can be accessed in minutes to -// hours, you can choose to activate additional archiving capabilities. The S3 -// Intelligent-Tiering storage class is the ideal storage class for data with -// unknown, changing, or unpredictable access patterns, independent of object size -// or retention period. If the size of an object is less than 128 KB, it is not -// 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) +// hours, you can choose to activate additional archiving capabilities. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of object +// size or retention period. If the size of an object is less than 128 KB, it is +// not 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]. +// +// Operations related to ListBucketIntelligentTieringConfigurations include: +// +// [DeleteBucketIntelligentTieringConfiguration] +// +// [PutBucketIntelligentTieringConfiguration] +// +// [GetBucketIntelligentTieringConfiguration] +// +// [GetBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html +// [PutBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html +// [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 +// [DeleteBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.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 6c879048ca3..fa760e6c579 100644 --- a/service/s3/api_op_ListBucketInventoryConfigurations.go +++ b/service/s3/api_op_ListBucketInventoryConfigurations.go @@ -14,26 +14,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns a list of -// inventory configurations for the bucket. You can have up to 1,000 analytics -// 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 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 +// This operation is not supported by directory buckets. +// +// Returns a list of inventory configurations for the bucket. You can have up to +// 1,000 analytics 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 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: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) +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about the Amazon S3 inventory feature, see [Amazon S3 Inventory] +// // 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) +// +// [GetBucketInventoryConfiguration] +// +// [DeleteBucketInventoryConfiguration] +// +// [PutBucketInventoryConfiguration] +// +// [Amazon S3 Inventory]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.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 +// [DeleteBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [PutBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html +// [GetBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html func (c *Client) ListBucketInventoryConfigurations(ctx context.Context, params *ListBucketInventoryConfigurationsInput, optFns ...func(*Options)) (*ListBucketInventoryConfigurationsOutput, error) { if params == nil { params = &ListBucketInventoryConfigurationsInput{} diff --git a/service/s3/api_op_ListBucketMetricsConfigurations.go b/service/s3/api_op_ListBucketMetricsConfigurations.go index 0b6ca94733b..efae4c5cd39 100644 --- a/service/s3/api_op_ListBucketMetricsConfigurations.go +++ b/service/s3/api_op_ListBucketMetricsConfigurations.go @@ -13,28 +13,42 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Lists the metrics -// configurations for the bucket. The metrics configurations are 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 -// 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 -// 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) +// This operation is not supported by directory buckets. +// +// Lists the metrics configurations for the bucket. The metrics configurations are +// 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 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 permission by +// default. The bucket owner can grant this permission to others. For more +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For more information about metrics configurations and CloudWatch request +// metrics, see [Monitoring Metrics with Amazon CloudWatch]. +// +// The following operations are related to ListBucketMetricsConfigurations : +// +// [PutBucketMetricsConfiguration] +// +// [GetBucketMetricsConfiguration] +// +// [DeleteBucketMetricsConfiguration] +// +// [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 +// [Monitoring Metrics with Amazon CloudWatch]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html +// [GetBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html +// [PutBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html +// [DeleteBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 086d9d29002..dd5396f13c3 100644 --- a/service/s3/api_op_ListBuckets.go +++ b/service/s3/api_op_ListBuckets.go @@ -13,11 +13,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) -// . +// This operation is not supported by directory buckets. +// +// 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]. +// +// [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_ListDirectoryBuckets.go b/service/s3/api_op_ListDirectoryBuckets.go index 3ebf78af196..16cefddd926 100644 --- a/service/s3/api_op_ListDirectoryBuckets.go +++ b/service/s3/api_op_ListDirectoryBuckets.go @@ -15,23 +15,27 @@ import ( ) // Returns a list of all Amazon S3 directory buckets owned by the authenticated -// sender of the request. For more information about directory buckets, see -// Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) -// in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must -// make requests for this API operation to the Regional endpoint. These endpoints -// support path-style requests in the format -// https://s3express-control.region_code.amazonaws.com/bucket-name . -// Virtual-hosted-style requests aren't supported. For more information, see -// Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions You must have the -// s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy -// instead of a bucket policy. Cross-account access to this API operation isn't -// supported. This operation can only be performed by the Amazon Web Services -// account that owns the resource. For more information about directory bucket -// policies and permissions, see Amazon Web Services Identity and Access -// Management (IAM) for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) -// in the Amazon S3 User Guide. HTTP Host header syntax Directory buckets - The -// HTTP Host header syntax is s3express-control.region.amazonaws.com . +// sender of the request. For more information about directory buckets, see [Directory buckets]in the +// Amazon S3 User Guide. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Regional endpoint. These endpoints support path-style requests +// in the format https://s3express-control.region_code.amazonaws.com/bucket-name . +// Virtual-hosted-style requests aren't supported. For more information, see [Regional and Zonal endpoints]in +// the Amazon S3 User Guide. +// +// Permissions You must have the s3express:ListAllMyDirectoryBuckets permission in +// an IAM identity-based policy instead of a bucket policy. Cross-account access to +// this API operation isn't supported. This operation can only be performed by the +// Amazon Web Services account that owns the resource. For more information about +// directory bucket policies and permissions, see [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]in the Amazon S3 User Guide. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// s3express-control.region.amazonaws.com . +// +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html +// [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html func (c *Client) ListDirectoryBuckets(ctx context.Context, params *ListDirectoryBucketsInput, optFns ...func(*Options)) (*ListDirectoryBucketsOutput, error) { if params == nil { params = &ListDirectoryBucketsInput{} diff --git a/service/s3/api_op_ListMultipartUploads.go b/service/s3/api_op_ListMultipartUploads.go index 183773651a0..a6c450b33cc 100644 --- a/service/s3/api_op_ListMultipartUploads.go +++ b/service/s3/api_op_ListMultipartUploads.go @@ -16,38 +16,45 @@ import ( // This operation lists in-progress multipart uploads in a bucket. An in-progress // multipart upload is a multipart upload that has been initiated by the // CreateMultipartUpload request, but has not yet been completed or aborted. +// // Directory buckets - If multipart uploads in a directory bucket are in progress, // you can't delete the bucket until all the in-progress multipart uploads are -// aborted or completed. The ListMultipartUploads operation returns a maximum of -// 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is -// also the default value. You can further limit the number of uploads in a -// response by specifying the max-uploads request parameter. If there are more -// than 1,000 multipart uploads that satisfy your ListMultipartUploads request, -// the response returns an IsTruncated element with the value of true , a -// NextKeyMarker element, and a NextUploadIdMarker element. To list the remaining -// multipart uploads, you need to make subsequent ListMultipartUploads requests. -// In these requests, include two query parameters: key-marker and upload-id-marker -// . Set the value of key-marker to the NextKeyMarker value from the previous -// response. Similarly, set the value of upload-id-marker to the NextUploadIdMarker -// value from the previous response. Directory buckets - The upload-id-marker -// element and the NextUploadIdMarker element aren't supported by directory -// buckets. To list the additional multipart uploads, you only need to set the -// value of key-marker to the NextKeyMarker value from the previous response. For -// more 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. Directory buckets - For directory buckets, you must -// make requests for this API operation to the Zonal endpoint. These endpoints -// support virtual-hosted-style requests in the format +// aborted or completed. +// +// The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads +// in the response. The limit of 1,000 multipart uploads is also the default value. +// You can further limit the number of uploads in a response by specifying the +// max-uploads request parameter. If there are more than 1,000 multipart uploads +// that satisfy your ListMultipartUploads request, the response returns an +// IsTruncated element with the value of true , a NextKeyMarker element, and a +// NextUploadIdMarker element. To list the remaining multipart uploads, you need to +// make subsequent ListMultipartUploads requests. In these requests, include two +// query parameters: key-marker and upload-id-marker . Set the value of key-marker +// to the NextKeyMarker value from the previous response. Similarly, set the value +// of upload-id-marker to the NextUploadIdMarker value from the previous response. +// +// Directory buckets - The upload-id-marker element and the NextUploadIdMarker +// element aren't supported by directory buckets. To list the additional multipart +// uploads, you only need to set the value of key-marker to the NextKeyMarker +// value from the previous response. +// +// For more information about multipart uploads, see [Uploading Objects Using Multipart Upload] in the Amazon S3 User Guide. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - 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. +// required to use the multipart upload API, see [Multipart Upload and Permissions]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -55,29 +62,48 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Sorting of multipart uploads in response +// // - General purpose bucket - In the ListMultipartUploads response, the multipart // uploads are sorted based on two criteria: +// // - Key-based sorting - Multipart uploads are initially sorted in ascending // order based on their object keys. +// // - Time-based sorting - For uploads that share the same object key, they are // further sorted in ascending order based on the upload initiation time. Among // uploads with the same key, the one that was initiated first will appear before // the ones that were initiated later. +// // - Directory bucket - In the ListMultipartUploads response, the multipart // uploads aren't sorted lexicographically based on the object keys. // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to ListMultipartUploads : +// +// [CreateMultipartUpload] +// +// [UploadPart] +// +// [CompleteMultipartUpload] +// +// [ListParts] +// +// [AbortMultipartUpload] +// +// [Uploading Objects Using Multipart Upload]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.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 +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [Multipart Upload and Permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipartUploadsInput, optFns ...func(*Options)) (*ListMultipartUploadsOutput, error) { if params == nil { params = &ListMultipartUploadsInput{} @@ -95,42 +121,52 @@ func (c *Client) ListMultipartUploads(ctx context.Context, params *ListMultipart type ListMultipartUploadsInput struct { - // The name of the bucket to which the multipart upload was initiated. Directory - // buckets - When you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // The name of the bucket to which the multipart upload was initiated. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // 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 - // 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. Directory buckets - For directory buckets, / - // is the only supported delimiter. + // 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 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. + // + // Directory buckets - For directory buckets, / is the only supported delimiter. Delimiter *string // Requests Amazon S3 to encode the object keys in the response and specifies the @@ -147,20 +183,26 @@ type ListMultipartUploadsInput struct { ExpectedBucketOwner *string // Specifies the multipart upload after which listing should begin. + // // - General purpose buckets - For general purpose buckets, key-marker is an // object key. 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 . + // 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 . + // // - Directory buckets - For directory buckets, key-marker is obfuscated and // isn't a real object key. The upload-id-marker parameter isn't supported by // directory buckets. To list the additional multipart uploads, you only need to // set the value of key-marker to the NextKeyMarker value from the previous - // response. In the ListMultipartUploads response, the multipart uploads aren't - // sorted lexicographically based on the object keys. + // response. + // + // In the ListMultipartUploads response, the multipart uploads aren't sorted + // lexicographically based on the object keys. KeyMarker *string // Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the @@ -171,26 +213,31 @@ type ListMultipartUploadsInput struct { // Lists in-progress uploads only for those keys that begin with the specified // prefix. You can use prefixes to separate a bucket into different grouping of // keys. (You can think of using prefix to make groups in the same way that you'd - // use a folder in a file system.) Directory buckets - For directory buckets, only - // prefixes that end in a delimiter ( / ) are supported. + // use a folder in a file system.) + // + // Directory buckets - For directory buckets, only prefixes that end in a + // delimiter ( / ) are supported. Prefix *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // Together with key-marker, specifies the multipart upload after which listing // 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 . This functionality is not - // supported for directory buckets. + // greater than the specified upload-id-marker . + // + // This functionality is not supported for directory buckets. UploadIdMarker *string noSmithyDocumentSerde @@ -210,20 +257,25 @@ type ListMultipartUploadsOutput struct { // 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. Directory - // buckets - For directory buckets, only prefixes that end in a delimiter ( / ) are - // supported. + // distinct key prefixes are returned in the Prefix child element. + // + // Directory buckets - For directory buckets, only prefixes that end in a + // delimiter ( / ) are supported. CommonPrefixes []types.CommonPrefix // Contains the delimiter you specified in the request. If you don't specify a - // delimiter in your request, this element is absent from the response. Directory - // buckets - For directory buckets, / is the only supported delimiter. + // delimiter in your request, this element is absent from the response. + // + // Directory buckets - For directory buckets, / is the only supported delimiter. Delimiter *string - // Encoding type used by Amazon S3 to encode object keys in the 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 , KeyMarker , Prefix , NextKeyMarker , Key . + // Encoding type used by Amazon S3 to encode object keys in the 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 , KeyMarker , Prefix , NextKeyMarker , Key . EncodingType types.EncodingType // Indicates whether the returned list of multipart uploads is truncated. A value @@ -244,26 +296,31 @@ type ListMultipartUploadsOutput struct { NextKeyMarker *string // When a list is truncated, this element specifies the value that should be used - // for the upload-id-marker request parameter in a subsequent request. This - // functionality is not supported for directory buckets. + // for the upload-id-marker request parameter in a subsequent request. + // + // This functionality is not supported for directory buckets. NextUploadIdMarker *string // When a prefix is provided in the request, this field contains the specified // prefix. The result contains only keys starting with the specified prefix. - // Directory buckets - For directory buckets, only prefixes that end in a delimiter - // ( / ) are supported. + // + // Directory buckets - For directory buckets, only prefixes that end in a + // delimiter ( / ) are supported. Prefix *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Together with key-marker, specifies the multipart upload after which listing // 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 . This functionality is not - // supported for directory buckets. + // greater than the specified upload-id-marker . + // + // This functionality is not supported for directory buckets. UploadIdMarker *string // Container for elements related to a particular multipart upload. A response can diff --git a/service/s3/api_op_ListObjectVersions.go b/service/s3/api_op_ListObjectVersions.go index bcb90eb2d14..f97d156939c 100644 --- a/service/s3/api_op_ListObjectVersions.go +++ b/service/s3/api_op_ListObjectVersions.go @@ -13,19 +13,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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. +// This operation is not supported by directory buckets. +// +// 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 permission 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. 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) +// 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. +// +// The following operations are related to ListObjectVersions : +// +// [ListObjectsV2] +// +// [GetObject] +// +// [PutObject] +// +// [DeleteObject] +// +// [DeleteObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.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 +// [ListObjectsV2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html func (c *Client) ListObjectVersions(ctx context.Context, params *ListObjectVersionsInput, optFns ...func(*Options)) (*ListObjectVersionsOutput, error) { if params == nil { params = &ListObjectVersionsInput{} @@ -93,10 +108,12 @@ type ListObjectVersionsInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // Specifies the object version you want to start listing from. @@ -127,10 +144,13 @@ type ListObjectVersionsOutput struct { // 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. + // 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: KeyMarker, NextKeyMarker, Prefix, Key , and Delimiter . + // response elements: + // + // KeyMarker, NextKeyMarker, Prefix, Key , and Delimiter . EncodingType types.EncodingType // A flag that indicates whether Amazon S3 returned all of the results that @@ -164,7 +184,9 @@ type ListObjectVersionsOutput struct { Prefix *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Marks the last version of the key returned in a truncated response. diff --git a/service/s3/api_op_ListObjects.go b/service/s3/api_op_ListObjects.go index 9a3bf3e0244..ee9fd98de5f 100644 --- a/service/s3/api_op_ListObjects.go +++ b/service/s3/api_op_ListObjects.go @@ -13,19 +13,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Returns some or all (up -// to 1,000) of the objects in a bucket. You can use the request parameters as -// selection criteria to return a subset of the objects in a 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) +// This operation is not supported by directory buckets. +// +// Returns some or all (up to 1,000) of the objects in a bucket. You can use the +// request parameters as selection criteria to return a subset of the objects in a +// 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], +// when developing applications. For backward compatibility, Amazon S3 continues to +// support ListObjects . +// +// The following operations are related to ListObjects : +// +// [ListObjectsV2] +// +// [GetObject] +// +// [PutObject] +// +// [CreateBucket] +// +// [ListBuckets] +// +// [ListBuckets]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.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 +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [ListObjectsV2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html func (c *Client) ListObjects(ctx context.Context, params *ListObjectsInput, optFns ...func(*Options)) (*ListObjectsOutput, error) { if params == nil { params = &ListObjectsInput{} @@ -43,31 +59,39 @@ func (c *Client) ListObjects(ctx context.Context, params *ListObjectsInput, optF type ListObjectsInput struct { - // The name of the bucket containing the objects. Directory buckets - When you use - // this operation with a directory bucket, you must use virtual-hosted-style - // requests in the format Bucket_name.s3express-az_id.region.amazonaws.com . - // Path-style requests are not supported. Directory bucket names must be unique in - // the chosen Availability Zone. Bucket names must follow the format - // bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // The name of the bucket containing the objects. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format + // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not + // supported. Directory bucket names must be unique in the chosen Availability + // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for + // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -121,14 +145,20 @@ func (in *ListObjectsInput) bindEndpointParams(p *EndpointParameters) { type ListObjectsOutput struct { // All of the keys (up to 1,000) rolled up in a common prefix count as a single - // 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 the 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. + // 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 the 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. @@ -163,18 +193,21 @@ type ListObjectsOutput struct { // When the response is truncated (the IsTruncated element value in the response // is true ), you can use the key name in this field as the marker parameter in // the subsequent request to get the next set of objects. Amazon S3 lists objects - // in alphabetical order. This element is returned only if you have the delimiter - // request parameter specified. If the response does not include the NextMarker - // element and it is truncated, you can use the value of the last Key element in - // the response as the marker parameter in the subsequent request to get the next - // set of object keys. + // in alphabetical order. + // + // This element is returned only if you have the delimiter request parameter + // specified. If the response does not include the NextMarker element and it is + // truncated, you can use the value of the last Key element in the response as the + // marker parameter in the subsequent request to get the next set of object keys. NextMarker *string // Keys that begin with the indicated prefix. Prefix *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_ListObjectsV2.go b/service/s3/api_op_ListObjectsV2.go index ee09d3cbde6..50e9f5fbd8c 100644 --- a/service/s3/api_op_ListObjectsV2.go +++ b/service/s3/api_op_ListObjectsV2.go @@ -17,26 +17,29 @@ import ( // You can use the request parameters as selection criteria to return a subset of // the objects in a bucket. 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. For more information about listing objects, see -// Listing object keys programmatically (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html) -// in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) -// . Directory buckets - For directory buckets, you must make requests for this API +// handle it appropriately. +// +// For more information about listing objects, see [Listing object keys programmatically] in the Amazon S3 User Guide. +// To get a list of your buckets, see [ListBuckets]. +// +// Directory buckets - For directory buckets, you must make requests for this API // operation to the Zonal endpoint. These endpoints support virtual-hosted-style // requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - To use this operation, you must have // READ access to the bucket. You must have permission 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) -// in the Amazon S3 User Guide. +// grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] +// and [Managing Access Permissions to Your Amazon S3 Resources]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -44,24 +47,42 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Sorting order of returned objects +// // - General purpose bucket - For general purpose buckets, ListObjectsV2 returns // objects in lexicographical order based on their key names. +// // - Directory bucket - For directory buckets, ListObjectsV2 does not return // objects in lexicographical order. // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . This section describes the -// latest revision of this action. We recommend that you use this revised API -// operation for application development. For backward compatibility, Amazon S3 -// continues to support the prior version of this API operation, ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// This section describes the latest revision of this action. We recommend that +// you use this revised API operation for application development. For backward +// compatibility, Amazon S3 continues to support the prior version of this API +// operation, [ListObjects]. +// +// The following operations are related to ListObjectsV2 : +// +// [GetObject] +// +// [PutObject] +// +// [CreateBucket] +// +// [ListObjects]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.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 +// [Listing object keys programmatically]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [ListBuckets]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html +// [PutObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [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) ListObjectsV2(ctx context.Context, params *ListObjectsV2Input, optFns ...func(*Options)) (*ListObjectsV2Output, error) { if params == nil { params = &ListObjectsV2Input{} @@ -79,30 +100,37 @@ func (c *Client) ListObjectsV2(ctx context.Context, params *ListObjectsV2Input, type ListObjectsV2Input struct { - // Directory buckets - When you use this operation with a directory bucket, you + // Directory buckets - When you use this operation with a directory bucket, you // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -113,13 +141,15 @@ type ListObjectsV2Input struct { ContinuationToken *string // A delimiter is a character that you use to group keys. - // - Directory buckets - For directory buckets, / is the only supported - // delimiter. + // + // - Directory buckets - For directory buckets, / is the only supported delimiter. + // // - Directory buckets - When you query ListObjectsV2 with a delimiter during // in-progress multipart uploads, the CommonPrefixes response parameter contains // the prefixes that are associated with the in-progress multipart uploads. For - // more information about multipart uploads, see Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) - // in the Amazon S3 User Guide. + // more information about multipart uploads, see [Multipart Upload Overview]in the Amazon S3 User Guide. + // + // [Multipart Upload Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html Delimiter *string // Encoding type used by Amazon S3 to encode object keys in the response. If using @@ -134,8 +164,10 @@ type ListObjectsV2Input struct { // The owner field is not present in ListObjectsV2 by default. If you want to // return the owner field with each key in the result, then set the FetchOwner - // field to true . Directory buckets - For directory buckets, the bucket owner is - // returned as the object owner for all objects. + // field to true . + // + // Directory buckets - For directory buckets, the bucket owner is returned as the + // object owner for all objects. FetchOwner *bool // Sets the maximum number of keys returned in the response. By default, the @@ -144,23 +176,28 @@ type ListObjectsV2Input struct { MaxKeys *int32 // Specifies the optional fields that you want returned in the response. Fields - // that you do not specify are not returned. This functionality is not supported - // for directory buckets. + // that you do not specify are not returned. + // + // This functionality is not supported for directory buckets. OptionalObjectAttributes []types.OptionalObjectAttributes - // Limits the response to keys that begin with the specified prefix. Directory - // buckets - For directory buckets, only prefixes that end in a delimiter ( / ) are - // supported. + // Limits the response to keys that begin with the specified prefix. + // + // Directory buckets - For directory buckets, only prefixes that end in a + // delimiter ( / ) are supported. Prefix *string // Confirms that the requester knows that she or he will be charged for the list // objects request in V2 style. Bucket owners need not specify this parameter in - // their requests. This functionality is not supported for directory buckets. + // their requests. + // + // This functionality is not supported for directory buckets. RequestPayer types.RequestPayer // StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts - // listing after this specified key. StartAfter can be any key in the bucket. This - // functionality is not supported for directory buckets. + // listing after this specified key. StartAfter can be any key in the bucket. + // + // This functionality is not supported for directory buckets. StartAfter *string noSmithyDocumentSerde @@ -176,43 +213,57 @@ type ListObjectsV2Output struct { // All of the keys (up to 1,000) that share the same prefix are grouped together. // When counting the total numbers of returns by this API operation, this group of - // keys is considered as one item. 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. + // keys is considered as one item. + // + // 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 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. + // // - Directory buckets - For directory buckets, only prefixes that end in a // delimiter ( / ) are supported. + // // - Directory buckets - When you query ListObjectsV2 with a delimiter during // in-progress multipart uploads, the CommonPrefixes response parameter contains // the prefixes that are associated with the in-progress multipart uploads. For - // more information about multipart uploads, see Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) - // in the Amazon S3 User Guide. + // more information about multipart uploads, see [Multipart Upload Overview]in the Amazon S3 User Guide. + // + // [Multipart Upload Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html CommonPrefixes []types.CommonPrefix // Metadata about each object returned. Contents []types.Object - // If ContinuationToken was sent with the request, it is included in the response. - // You can use the returned ContinuationToken for pagination of the list response. - // You can use this ContinuationToken for pagination of the list results. + // If ContinuationToken was sent with the request, it is included in the + // response. You can use the returned ContinuationToken for pagination of the list + // response. You can use this ContinuationToken for pagination of the list + // results. ContinuationToken *string // Causes keys that contain the same string between the prefix and the first // occurrence of the delimiter to be rolled up into a single result element in the // CommonPrefixes collection. These rolled-up keys are not returned elsewhere in // the response. Each rolled-up result counts as only one return against the - // MaxKeys value. Directory buckets - For directory buckets, / is the only - // supported delimiter. + // MaxKeys value. + // + // Directory buckets - For directory buckets, / is the only supported delimiter. Delimiter *string // 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 @@ -239,16 +290,21 @@ type ListObjectsV2Output struct { // obfuscated and is not a real key NextContinuationToken *string - // Keys that begin with the indicated prefix. Directory buckets - For directory - // buckets, only prefixes that end in a delimiter ( / ) are supported. + // Keys that begin with the indicated prefix. + // + // Directory buckets - For directory buckets, only prefixes that end in a + // delimiter ( / ) are supported. Prefix *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged - // If StartAfter was sent with the request, it is included in the response. This - // functionality is not supported for directory buckets. + // If StartAfter was sent with the request, it is included in the response. + // + // This functionality is not supported for directory buckets. StartAfter *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_ListParts.go b/service/s3/api_op_ListParts.go index 3f3946d935c..4e40bb5bf72 100644 --- a/service/s3/api_op_ListParts.go +++ b/service/s3/api_op_ListParts.go @@ -14,55 +14,79 @@ import ( "time" ) -// Lists the parts that have been uploaded for a specific multipart upload. To use -// this operation, you must provide the upload ID in the request. You obtain this -// uploadID by sending the initiate multipart upload request through -// CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) -// . The ListParts request returns a maximum of 1,000 uploaded parts. The limit of +// Lists the parts that have been uploaded for a specific multipart upload. +// +// To use this operation, you must provide the upload ID in the request. You +// obtain this uploadID by sending the initiate multipart upload request through [CreateMultipartUpload]. +// +// The ListParts request returns a maximum of 1,000 uploaded parts. The limit of // 1,000 parts is also the default value. You can restrict the number of parts in a // response 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. To list // remaining uploaded parts, in subsequent ListParts requests, include the // part-number-marker query string parameter and set its value to the -// NextPartNumberMarker field value from the previous response. For more -// information on multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html) -// in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must -// make requests for this API operation to the Zonal endpoint. These endpoints -// support virtual-hosted-style requests in the format +// NextPartNumberMarker field value from the previous response. +// +// For more information on multipart uploads, see [Uploading Objects Using Multipart Upload] in the Amazon S3 User Guide. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions // - General purpose bucket permissions - 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. If the upload was created using server-side -// encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer -// server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must -// have permission to the kms:Decrypt action for the ListParts request to -// succeed. -// - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the -// s3express:CreateSession permission to the directory bucket in a bucket policy -// or an IAM identity-based policy. Then, you make the CreateSession API call on -// the bucket to obtain a session token. With the session token in your request -// header, you can make API requests to this operation. After the session token -// expires, you make another CreateSession API call to generate a new session -// token for use. Amazon Web Services CLI or SDKs create session and refresh the -// session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// required to use the multipart upload API, see [Multipart Upload and Permissions]in the Amazon S3 User Guide. +// +// If the upload was created using server-side encryption with Key Management +// +// Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon +// Web Services KMS keys (DSSE-KMS), you must have permission to the kms:Decrypt +// action for the ListParts request to succeed. +// +// - Directory bucket permissions - To grant access to this API operation on a +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the +// s3express:CreateSession permission to the directory bucket in a bucket policy +// or an IAM identity-based policy. Then, you make the CreateSession API call on +// the bucket to obtain a session token. With the session token in your request +// header, you can make API requests to this operation. After the session token +// expires, you make another CreateSession API call to generate a new session +// token for use. Amazon Web Services CLI or SDKs create session and refresh the +// session token automatically to avoid service interruptions when a session +// expires. For more information about authorization, see [CreateSession]CreateSession . +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to ListParts : +// +// [CreateMultipartUpload] +// +// [UploadPart] +// +// [CompleteMultipartUpload] // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// [AbortMultipartUpload] +// +// [GetObjectAttributes] +// +// [ListMultipartUploads] +// +// [Uploading Objects Using Multipart Upload]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html +// [AbortMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.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 +// [Multipart Upload and Permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html +// +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns ...func(*Options)) (*ListPartsOutput, error) { if params == nil { params = &ListPartsInput{} @@ -80,31 +104,39 @@ func (c *Client) ListParts(ctx context.Context, params *ListPartsInput, optFns . type ListPartsInput struct { - // The name of the bucket to which the parts are being uploaded. Directory buckets - // - When you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // The name of the bucket to which the parts are being uploaded. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -135,31 +167,39 @@ type ListPartsInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // For more information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html SSECustomerKeyMD5 *string noSmithyDocumentSerde @@ -177,17 +217,21 @@ type ListPartsOutput struct { // 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 Configuration (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. + // For more information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration]. + // + // 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. + // // This functionality is not supported for directory buckets. + // + // [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 AbortDate *time.Time // This header is returned along with the x-amz-abort-date header. It identifies // applicable lifecycle configuration rule that defines the action to abort - // incomplete multipart uploads. This functionality is not supported for directory - // buckets. + // incomplete multipart uploads. + // + // This functionality is not supported for directory buckets. AbortRuleId *string // The name of the bucket to which the multipart upload was initiated. Does not @@ -203,7 +247,7 @@ type ListPartsOutput struct { // provides the user ARN and display name. Initiator *types.Initiator - // Indicates whether the returned list of parts is truncated. A true value + // Indicates whether the returned list of parts is truncated. A true value // indicates that the list was truncated. A list can be truncated if the number of // parts exceeds the limit returned in the MaxParts element. IsTruncated *bool @@ -221,8 +265,10 @@ type ListPartsOutput struct { // 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. Directory buckets - The bucket owner is - // returned as the object owner for all the parts. + // the parent account ID and display name. + // + // Directory buckets - The bucket owner is returned as the object owner for all + // the parts. Owner *types.Owner // Specifies the part after which listing should begin. Only parts with higher @@ -234,12 +280,15 @@ type ListPartsOutput struct { Parts []types.Part // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged - // The class of storage used to store the uploaded object. Directory buckets - - // Only the S3 Express One Zone storage class is supported by directory buckets to - // store objects. + // The class of storage used to store the uploaded object. + // + // Directory buckets - Only the S3 Express One Zone storage class is supported by + // directory buckets to store objects. StorageClass types.StorageClass // Upload ID identifying the multipart upload whose parts are being listed. diff --git a/service/s3/api_op_PutBucketAccelerateConfiguration.go b/service/s3/api_op_PutBucketAccelerateConfiguration.go index c15d55f1f96..a9685510246 100644 --- a/service/s3/api_op_PutBucketAccelerateConfiguration.go +++ b/service/s3/api_op_PutBucketAccelerateConfiguration.go @@ -15,30 +15,45 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Sets the accelerate -// configuration of an existing bucket. Amazon S3 Transfer Acceleration is a -// bucket-level feature that enables you to perform faster data transfers to Amazon -// S3. To use this operation, you must have permission to perform the +// This operation is not supported by directory buckets. +// +// Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer +// Acceleration is a bucket-level feature that enables you to perform faster data +// transfers to Amazon S3. +// +// To use this operation, you must have permission to 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 +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// 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. // -// 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) +// The [GetBucketAccelerateConfiguration] 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]. +// +// The following operations are related to PutBucketAccelerateConfiguration : +// +// [GetBucketAccelerateConfiguration] +// +// [CreateBucket] +// +// [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 +// [Transfer Acceleration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html +// [GetBucketAccelerateConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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{} @@ -70,10 +85,13 @@ type PutBucketAccelerateConfigurationInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketAcl.go b/service/s3/api_op_PutBucketAcl.go index f88bb4af227..d61376f0100 100644 --- a/service/s3/api_op_PutBucketAcl.go +++ b/service/s3/api_op_PutBucketAcl.go @@ -15,89 +15,159 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 the WRITE_ACP permission. You can -// use one of the following two ways to set a bucket's permissions: +// This operation is not supported by directory buckets. +// +// Sets the permissions on an existing bucket using access control lists (ACL). +// For more information, see [Using ACLs]. To set the ACL of a bucket, you must have the +// 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 +// 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. Permissions You can set access permissions by using -// one of the following methods: +// 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]in the +// Amazon S3 User Guide. +// +// Permissions You can set access permissions by 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) -// . +// control-specific headers in your request. For more information, see [Canned ACL]. +// // - 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" +// permissions that Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview]. +// +// 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]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. +// 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]in the +// +// Amazon Web Services General Reference. // // The following operations are related to PutBucketAcl : -// - 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) +// +// [CreateBucket] +// +// [DeleteBucket] +// +// [GetObjectAcl] +// +// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region +// [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html +// [Controlling object ownership]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html +// [Using ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html +// [Canned ACL]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL +// [GetObjectAcl]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html func (c *Client) PutBucketAcl(ctx context.Context, params *PutBucketAclInput, optFns ...func(*Options)) (*PutBucketAclOutput, error) { if params == nil { params = &PutBucketAclInput{} @@ -130,17 +200,23 @@ type PutBucketAclInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // transit. For more information, go to [RFC 1864.] + // // For requests made using the Amazon Web Services Command Line Interface (CLI) or // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864.]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide @@ -158,9 +234,10 @@ type PutBucketAclInput struct { // Allows grantee to read the bucket ACL. GrantReadACP *string - // Allows grantee to create new objects in the bucket. For the bucket and object - // owners of existing objects, also allows deletions and overwrites of those - // objects. + // Allows grantee to create new objects in the bucket. + // + // For the bucket and object owners of existing objects, also allows deletions and + // overwrites of those objects. GrantWrite *string // Allows grantee to write the ACL for the applicable bucket. diff --git a/service/s3/api_op_PutBucketAnalyticsConfiguration.go b/service/s3/api_op_PutBucketAnalyticsConfiguration.go index 0604fb930a4..292a04b7765 100644 --- a/service/s3/api_op_PutBucketAnalyticsConfiguration.go +++ b/service/s3/api_op_PutBucketAnalyticsConfiguration.go @@ -14,45 +14,67 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Sets an analytics -// configuration for the bucket (specified by the analytics configuration ID). You -// can have up to 1,000 analytics configurations per bucket. You can choose to have -// storage class analysis export analysis reports sent to a comma-separated values -// (CSV) flat file. See the DataExport request element. Reports are updated daily -// and are based on the object filters that you configure. When selecting data -// export, you specify a destination bucket and an optional destination prefix -// where the file is written. You can export the data 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 +// This operation is not supported by directory buckets. +// +// Sets an analytics configuration for the bucket (specified by the analytics +// configuration ID). You can have up to 1,000 analytics configurations per bucket. +// +// You can choose to have storage class analysis export analysis reports sent to a +// comma-separated values (CSV) flat file. See the DataExport request element. +// Reports are updated daily and are based on the object filters that you +// configure. When selecting data export, you specify a destination bucket and an +// optional destination prefix where the file is written. You can export the data +// 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]. +// +// 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 +// bucket. For an example policy, see [Granting Permissions for Amazon S3 Inventory and Storage Class Analysis]. +// +// 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) -// . PutBucketAnalyticsConfiguration has the following special errors: +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// PutBucketAnalyticsConfiguration has the following 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. // // The following operations are related to PutBucketAnalyticsConfiguration : -// - 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) +// +// [GetBucketAnalyticsConfiguration] +// +// [DeleteBucketAnalyticsConfiguration] +// +// [ListBucketAnalyticsConfigurations] +// +// [Amazon S3 Analytics – Storage Class Analysis]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html +// [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 +// [DeleteBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.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 +// [GetBucketAnalyticsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html +// [ListBucketAnalyticsConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.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 3e6604ef6ad..e56061b6529 100644 --- a/service/s3/api_op_PutBucketCors.go +++ b/service/s3/api_op_PutBucketCors.go @@ -15,35 +15,54 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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 +// 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 +// 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: +// 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. // -// 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. The following operations are related to -// PutBucketCors : -// - 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] in the Amazon S3 User Guide. +// +// The following operations are related to PutBucketCors : +// +// [GetBucketCors] +// +// [DeleteBucketCors] +// +// [RESTOPTIONSobject] +// +// [GetBucketCors]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html +// [Enabling Cross-Origin Resource Sharing]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html +// [RESTOPTIONSobject]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html +// [DeleteBucketCors]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html func (c *Client) PutBucketCors(ctx context.Context, params *PutBucketCorsInput, optFns ...func(*Options)) (*PutBucketCorsOutput, error) { if params == nil { params = &PutBucketCorsInput{} @@ -67,8 +86,9 @@ type PutBucketCorsInput struct { 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]in the Amazon S3 User Guide. + // + // [Enabling Cross-Origin Resource Sharing]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html // // This member is required. CORSConfiguration *types.CORSConfiguration @@ -77,17 +97,23 @@ type PutBucketCorsInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // transit. For more information, go to [RFC 1864.] + // // For requests made using the Amazon Web Services Command Line Interface (CLI) or // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864.]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketEncryption.go b/service/s3/api_op_PutBucketEncryption.go index dfc71dc5c69..01e160cdd38 100644 --- a/service/s3/api_op_PutBucketEncryption.go +++ b/service/s3/api_op_PutBucketEncryption.go @@ -15,30 +15,41 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. This action uses the -// encryption subresource to configure default encryption and Amazon S3 Bucket Keys -// for an existing bucket. By default, all buckets have a default encryption -// configuration that uses server-side encryption with Amazon S3 managed keys -// (SSE-S3). You can optionally configure default encryption for a bucket by using -// server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or -// dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). -// If you specify default encryption by using SSE-KMS, you can also configure -// Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) -// . If you use PutBucketEncryption to set your default bucket encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) -// to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does -// not validate the KMS key ID provided in PutBucketEncryption requests. 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 permission to perform the +// This operation is not supported by directory buckets. +// +// This action uses the encryption subresource to configure default encryption and +// Amazon S3 Bucket Keys for an existing bucket. +// +// By default, all buckets have a default encryption configuration that uses +// server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally +// configure default encryption for a bucket by using server-side encryption with +// Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption +// with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption +// by using SSE-KMS, you can also configure [Amazon S3 Bucket Keys]. If you use PutBucketEncryption to +// set your [default bucket encryption]to SSE-KMS, you should verify that your KMS key ID is correct. Amazon +// S3 does not validate the KMS key ID provided in PutBucketEncryption requests. +// +// This action requires Amazon Web Services Signature Version 4. For more +// information, see [Authenticating Requests (Amazon Web Services Signature Version 4)]. +// +// To use this operation, you must have permission 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) -// in the Amazon S3 User Guide. The following operations are related to -// PutBucketEncryption : -// - GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) -// - DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) +// information about permissions, see [Permissions Related to Bucket Subresource Operations]and [Managing Access Permissions to Your Amazon S3 Resources] in the Amazon S3 User Guide. +// +// The following operations are related to PutBucketEncryption : +// +// [GetBucketEncryption] +// +// [DeleteBucketEncryption] +// +// [Amazon S3 Bucket Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.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 +// [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 +// [default bucket encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html func (c *Client) PutBucketEncryption(ctx context.Context, params *PutBucketEncryptionInput, optFns ...func(*Options)) (*PutBucketEncryptionOutput, error) { if params == nil { params = &PutBucketEncryptionInput{} @@ -62,8 +73,9 @@ 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]in the Amazon S3 User Guide. + // + // [Amazon S3 Bucket Default Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html // // This member is required. Bucket *string @@ -77,16 +89,20 @@ type PutBucketEncryptionInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // The base64-encoded 128-bit MD5 digest of the server-side encryption - // configuration. For requests made using the Amazon Web Services Command Line - // Interface (CLI) or Amazon Web Services SDKs, this field is calculated - // automatically. + // configuration. + // + // 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 account ID that you provide diff --git a/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go b/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go index 61d73da5692..8aac2b98712 100644 --- a/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go +++ b/service/s3/api_op_PutBucketIntelligentTieringConfiguration.go @@ -14,37 +14,58 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Puts a S3 -// Intelligent-Tiering configuration to the specified bucket. You can have up to -// 1,000 S3 Intelligent-Tiering configurations per 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, +// This operation is not supported by directory buckets. +// +// Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can +// have up to 1,000 S3 Intelligent-Tiering configurations per 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 // tiers. To get the lowest storage cost on data that can be accessed in minutes to -// hours, you can choose to activate additional archiving capabilities. The S3 -// Intelligent-Tiering storage class is the ideal storage class for data with -// unknown, changing, or unpredictable access patterns, independent of object size -// or retention period. If the size of an object is less than 128 KB, it is not -// 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: -// - 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) +// hours, you can choose to activate additional archiving capabilities. +// +// The S3 Intelligent-Tiering storage class is the ideal storage class for data +// with unknown, changing, or unpredictable access patterns, independent of object +// size or retention period. If the size of an object is less than 128 KB, it is +// not 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]. +// +// Operations related to PutBucketIntelligentTieringConfiguration include: +// +// [DeleteBucketIntelligentTieringConfiguration] +// +// [GetBucketIntelligentTieringConfiguration] +// +// [ListBucketIntelligentTieringConfigurations] // // 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. -// PutBucketIntelligentTieringConfiguration has the following 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 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. +// +// PutBucketIntelligentTieringConfiguration has the following 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 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. +// +// [ListBucketIntelligentTieringConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html +// [GetBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html +// [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 +// [DeleteBucketIntelligentTieringConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html 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 03d79a0d8d5..5933b6480a3 100644 --- a/service/s3/api_op_PutBucketInventoryConfiguration.go +++ b/service/s3/api_op_PutBucketInventoryConfiguration.go @@ -14,48 +14,76 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. This implementation of -// the PUT action adds an inventory configuration (identified by the inventory ID) -// to the bucket. You can have up to 1,000 inventory configurations per bucket. +// This operation is not supported by directory buckets. +// +// This implementation of the PUT action adds an inventory configuration +// (identified by the inventory ID) to the bucket. You can have up to 1,000 +// inventory configurations per bucket. +// // Amazon S3 inventory generates inventories of the objects in the bucket on a // daily or weekly basis, and the results are published to a flat file. The bucket // that is inventoried is called the source bucket, and the bucket where the // inventory flat file is stored is called the destination bucket. The destination -// bucket must be in the same Amazon Web Services Region as the source bucket. When -// you configure an inventory for a source bucket, you specify the destination -// bucket where you want the inventory 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 +// bucket must be in the same Amazon Web Services Region as the source bucket. +// +// When you configure an inventory for a source bucket, you specify the +// destination bucket where you want the inventory 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]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]. +// +// 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) -// report that includes all object metadata fields available and to specify the +// default and can grant this permission to others. +// +// The s3:PutInventoryConfiguration permission allows a user to create an [S3 Inventory] 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) -// 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) -// 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) -// in the Amazon S3 User Guide. PutBucketInventoryConfiguration has the following -// 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 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. The following -// operations are related to PutBucketInventoryConfiguration : -// - 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) +// available in the inventory report. +// +// To restrict access to an inventory report, see [Restricting access to an Amazon S3 Inventory report] in the Amazon S3 User Guide. +// For more information about the metadata fields available in S3 Inventory, see [Amazon S3 Inventory lists] +// in the Amazon S3 User Guide. For more information about permissions, see [Permissions related to bucket subresource operations]and [Identity and access management in Amazon S3] +// in the Amazon S3 User Guide. +// +// PutBucketInventoryConfiguration has the following 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 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. +// +// The following operations are related to PutBucketInventoryConfiguration : +// +// [GetBucketInventoryConfiguration] +// +// [DeleteBucketInventoryConfiguration] +// +// [ListBucketInventoryConfigurations] +// +// [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 +// [Amazon S3 Inventory]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html +// [ListBucketInventoryConfigurations]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html +// [S3 Inventory]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.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 +// [DeleteBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html +// [Identity and access management in Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [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 +// [Amazon S3 Inventory lists]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents +// [GetBucketInventoryConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.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 88096fdd132..102077fc737 100644 --- a/service/s3/api_op_PutBucketLifecycleConfiguration.go +++ b/service/s3/api_op_PutBucketLifecycleConfiguration.go @@ -15,26 +15,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Creates a new lifecycle -// configuration for the bucket or replaces an existing 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 +// This operation is not supported by directory buckets. +// +// Creates a new lifecycle configuration for the bucket or replaces an existing +// 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]. +// +// Bucket lifecycle configuration now supports specifying a lifecycle rule using // an object key name prefix, one or more object tags, object size, or any // combination of these. 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 +// description, see [PutBucketLifecycle]. +// +// 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: +// // - A filter identifying a subset of objects to which the rule applies. The // filter can be based on a key name prefix, object tags, object size, or any // combination of these. +// // - A status indicating 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 @@ -42,28 +48,44 @@ import ( // 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] and [Lifecycle Configuration Elements]. +// +// 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. An 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. An 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 // -// 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 operations 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]. +// +// The following operations are related to PutBucketLifecycleConfiguration : +// +// [Examples of Lifecycle Configuration] +// +// [GetBucketLifecycleConfiguration] +// +// [DeleteBucketLifecycle] +// +// [Examples of Lifecycle Configuration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html +// [Object Lifecycle Management]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html +// [Lifecycle Configuration Elements]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html +// [GetBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html +// [PutBucketLifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [DeleteBucketLifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html +// [Managing your storage lifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html func (c *Client) PutBucketLifecycleConfiguration(ctx context.Context, params *PutBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*PutBucketLifecycleConfigurationOutput, error) { if params == nil { params = &PutBucketLifecycleConfigurationInput{} @@ -90,10 +112,13 @@ type PutBucketLifecycleConfigurationInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketLogging.go b/service/s3/api_op_PutBucketLogging.go index fb80d2ee1be..e07c43221c6 100644 --- a/service/s3/api_op_PutBucketLogging.go +++ b/service/s3/api_op_PutBucketLogging.go @@ -15,39 +15,68 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Set the logging -// parameters for a bucket and to specify permissions for who can view and modify -// the logging parameters. All logs are saved to buckets in the same Amazon Web -// Services Region as the source bucket. To set the logging status of a bucket, you -// must be the bucket owner. The bucket owner is automatically granted FULL_CONTROL -// to all logs. You use the Grantee request element to grant access to other -// people. The Permissions request element specifies the kind of access the -// grantee has to the logs. If the target bucket for log delivery uses 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) -// in the Amazon S3 User Guide. Grantee Values You can specify the person (grantee) -// to whom you're assigning access rights (by 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 GETObjectAcl request, appears as the -// CanonicalUser. -// - By URI: <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> +// This operation is not supported by directory buckets. +// +// Set the logging parameters for a bucket and to specify permissions for who can +// view and modify the logging parameters. All logs are saved to buckets in the +// same Amazon Web Services Region as the source bucket. To set the logging status +// of a bucket, you must be the bucket owner. +// +// The bucket owner is automatically granted FULL_CONTROL to all logs. You use the +// Grantee request element to grant access to other people. The Permissions +// request element specifies the kind of access the grantee has to the logs. +// +// If the target bucket for log delivery uses 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]in the Amazon S3 User Guide. +// +// Grantee Values You can specify the person (grantee) to whom you're assigning +// access rights (by 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 +// +// GETObjectAcl 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) +// disable logging, you use an empty BucketLoggingStatus request element: +// +// For more information about server access logging, see [Server Access Logging] in the Amazon S3 User +// Guide. +// +// For more information about creating a bucket, see [CreateBucket]. For more information about +// returning the logging status of a bucket, see [GetBucketLogging]. +// +// The following operations are related to PutBucketLogging : +// +// [PutObject] +// +// [DeleteBucket] +// +// [CreateBucket] +// +// [GetBucketLogging] +// +// [Permissions for server access log delivery]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html +// [GetBucketLogging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.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 +// [Server Access Logging]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html func (c *Client) PutBucketLogging(ctx context.Context, params *PutBucketLoggingInput, optFns ...func(*Options)) (*PutBucketLoggingOutput, error) { if params == nil { params = &PutBucketLoggingInput{} @@ -79,15 +108,19 @@ type PutBucketLoggingInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm - // The MD5 hash of the PutBucketLogging request body. For requests made using the - // Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, - // this field is calculated automatically. + // The MD5 hash of the PutBucketLogging request body. + // + // 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 account ID that you provide diff --git a/service/s3/api_op_PutBucketMetricsConfiguration.go b/service/s3/api_op_PutBucketMetricsConfiguration.go index bff1452b977..10b3b5978b5 100644 --- a/service/s3/api_op_PutBucketMetricsConfiguration.go +++ b/service/s3/api_op_PutBucketMetricsConfiguration.go @@ -14,29 +14,44 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// For information about CloudWatch request metrics for Amazon S3, see [Monitoring Metrics with Amazon CloudWatch]. +// +// The following operations are related to PutBucketMetricsConfiguration : +// +// [DeleteBucketMetricsConfiguration] +// +// [GetBucketMetricsConfiguration] +// +// [ListBucketMetricsConfigurations] // // PutBucketMetricsConfiguration 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 +// +// [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 +// [Monitoring Metrics with Amazon CloudWatch]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.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 +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html 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 e937b5c5946..f83abf02b0e 100644 --- a/service/s3/api_op_PutBucketNotificationConfiguration.go +++ b/service/s3/api_op_PutBucketNotificationConfiguration.go @@ -14,41 +14,59 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// Enables notifications of specified events for a bucket. For more information +// about event notifications, see [Configuring Event Notifications]. +// +// 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 -// 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 the -// required 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 -// request with this configuration, Amazon S3 sends test messages to your SNS -// topic. If the message fails, the entire PUT action will fail, and Amazon S3 will -// not add the configuration to your bucket. If the configuration in the request -// body includes only one TopicConfiguration specifying only the -// 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) +// 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 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]. +// +// 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]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 the required 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 request with this configuration, Amazon S3 +// sends test messages to your SNS topic. If the message fails, the entire PUT +// action will fail, and Amazon S3 will not add the configuration to your bucket. +// +// If the configuration in the request body includes only one TopicConfiguration +// specifying only the 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] +// +// [Configuring Notifications for Amazon S3 Events]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html +// [Amazon S3 service quotas]: https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3 +// [GetBucketNotificationConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html +// [Configuring Event Notifications]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html func (c *Client) PutBucketNotificationConfiguration(ctx context.Context, params *PutBucketNotificationConfigurationInput, optFns ...func(*Options)) (*PutBucketNotificationConfigurationOutput, error) { if params == nil { params = &PutBucketNotificationConfigurationInput{} diff --git a/service/s3/api_op_PutBucketOwnershipControls.go b/service/s3/api_op_PutBucketOwnershipControls.go index 94875b7554b..e3160fd5832 100644 --- a/service/s3/api_op_PutBucketOwnershipControls.go +++ b/service/s3/api_op_PutBucketOwnershipControls.go @@ -15,14 +15,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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]. +// +// For information about Amazon S3 Object Ownership, see [Using object ownership]. +// +// The following operations are related to PutBucketOwnershipControls : +// +// # GetBucketOwnershipControls +// +// # DeleteBucketOwnershipControls +// +// [Specifying permissions in a policy]: https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html +// [Using object ownership]: https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html func (c *Client) PutBucketOwnershipControls(ctx context.Context, params *PutBucketOwnershipControlsInput, optFns ...func(*Options)) (*PutBucketOwnershipControlsOutput, error) { if params == nil { params = &PutBucketOwnershipControlsInput{} @@ -51,9 +59,10 @@ type PutBucketOwnershipControlsInput struct { // This member is required. OwnershipControls *types.OwnershipControls - // The MD5 hash of the OwnershipControls request body. For requests made using the - // Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, - // this field is calculated automatically. + // The MD5 hash of the OwnershipControls request body. + // + // 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 account ID that you provide diff --git a/service/s3/api_op_PutBucketPolicy.go b/service/s3/api_op_PutBucketPolicy.go index 88e3f2633fe..c00676ca3a8 100644 --- a/service/s3/api_op_PutBucketPolicy.go +++ b/service/s3/api_op_PutBucketPolicy.go @@ -15,48 +15,64 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Applies an Amazon S3 bucket policy to an Amazon S3 bucket. Directory buckets - -// For directory buckets, you must make requests for this API operation to the -// Regional endpoint. These endpoints support path-style requests in the format -// https://s3express-control.region_code.amazonaws.com/bucket-name . -// Virtual-hosted-style requests aren't supported. For more information, see -// Regional and Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions 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 both 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. To ensure that bucket owners don't -// inadvertently lock themselves out of their own buckets, the root principal in a -// bucket owner's Amazon Web Services account can perform the GetBucketPolicy , -// PutBucketPolicy , and DeleteBucketPolicy API actions, even if their bucket -// policy explicitly denies the root principal's access. Bucket owner root -// principals can only be blocked from performing these API actions by VPC endpoint -// policies and Amazon Web Services Organizations policies. +// Applies an Amazon S3 bucket policy to an Amazon S3 bucket. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Regional endpoint. These endpoints support path-style requests +// in the format https://s3express-control.region_code.amazonaws.com/bucket-name . +// Virtual-hosted-style requests aren't supported. For more information, see [Regional and Zonal endpoints]in +// the Amazon S3 User Guide. +// +// Permissions 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 both 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. +// +// To ensure that bucket owners don't inadvertently lock themselves out of their +// own buckets, the root principal in a bucket owner's Amazon Web Services account +// can perform the GetBucketPolicy , PutBucketPolicy , and DeleteBucketPolicy API +// actions, even if their bucket policy explicitly denies the root principal's +// access. Bucket owner root principals can only be blocked from performing these +// API actions by VPC endpoint policies and Amazon Web Services Organizations +// policies. +// // - General purpose bucket permissions - The s3:PutBucketPolicy permission is // required in a policy. For more information about general purpose buckets bucket -// policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) -// in the Amazon S3 User Guide. +// policies, see [Using Bucket Policies and User Policies]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation, you // must have the s3express:PutBucketPolicy permission in an IAM identity-based // policy instead of a bucket policy. Cross-account access to this API operation // isn't supported. This operation can only be performed by the Amazon Web Services // account that owns the resource. For more information about directory bucket -// policies and permissions, see Amazon Web Services Identity and Access -// Management (IAM) for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html) -// in the Amazon S3 User Guide. +// policies and permissions, see [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]in the Amazon S3 User Guide. +// +// Example bucket policies General purpose buckets example bucket policies - See [Bucket policy examples] +// in the Amazon S3 User Guide. // -// Example bucket policies General purpose buckets example bucket policies - See -// Bucket policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) -// in the Amazon S3 User Guide. Directory bucket example bucket policies - See -// Example bucket policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// in the Amazon S3 User Guide. HTTP Host header syntax Directory buckets - The -// HTTP Host header syntax is s3express-control.region.amazonaws.com . 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) +// Directory bucket example bucket policies - See [Example bucket policies for S3 Express One Zone] in the Amazon S3 User Guide. +// +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// s3express-control.region.amazonaws.com . +// +// The following operations are related to PutBucketPolicy : +// +// [CreateBucket] +// +// [DeleteBucket] +// +// [Bucket policy examples]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html +// [Example bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error) { if params == nil { params = &PutBucketPolicyInput{} @@ -74,21 +90,26 @@ func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInp type PutBucketPolicyInput struct { - // The name of the bucket. Directory buckets - When you use this operation with a - // directory bucket, you must use path-style requests in the format + // The name of the bucket. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use path-style requests in the format // https://s3express-control.region_code.amazonaws.com/bucket-name . // Virtual-hosted-style requests aren't supported. Directory bucket names must be // unique in the chosen Availability Zone. Bucket names must also follow the format // bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 - // ). For information about bucket naming restrictions, see Directory bucket - // naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide + // ). For information about bucket naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User + // Guide + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html // // This member is required. Bucket *string - // The bucket policy as a JSON document. For directory buckets, the only IAM - // action supported in the bucket policy is s3express:CreateSession . + // The bucket policy as a JSON document. + // + // For directory buckets, the only IAM action supported in the bucket policy is + // s3express:CreateSession . // // This member is required. Policy *string @@ -97,39 +118,54 @@ type PutBucketPolicyInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send this header, there must be a corresponding // x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 - // fails the request with the HTTP status code 400 Bad Request . For the - // x-amz-checksum-algorithm header, replace algorithm with the supported - // algorithm from the following list: + // fails the request with the HTTP status code 400 Bad Request . + // + // For the x-amz-checksum-algorithm header, replace algorithm with the + // supported algorithm from the following list: + // // - CRC32 + // // - CRC32C + // // - SHA1 + // // - SHA256 - // 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 the individual checksum value you provide - // through x-amz-checksum-algorithm doesn't match the checksum algorithm you set - // through x-amz-sdk-checksum-algorithm , Amazon S3 ignores any provided - // ChecksumAlgorithm parameter and uses the checksum algorithm that matches the - // provided value in x-amz-checksum-algorithm . For directory buckets, when you - // use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's - // used for performance. + // + // For more information, see [Checking object integrity] in the Amazon S3 User Guide. + // + // If the individual checksum value you provide through x-amz-checksum-algorithm + // doesn't match the checksum algorithm you set through + // x-amz-sdk-checksum-algorithm , Amazon S3 ignores any provided ChecksumAlgorithm + // parameter and uses the checksum algorithm that matches the provided value in + // x-amz-checksum-algorithm . + // + // For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the + // default checksum algorithm that's used for performance. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // Set this parameter to true to confirm that you want to remove your permissions - // to change this bucket policy in the future. This functionality is not supported - // for directory buckets. + // to change this bucket policy in the future. + // + // This functionality is not supported for directory buckets. ConfirmRemoveSelfBucketAccess *bool - // The MD5 hash of the request body. For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. This functionality is not supported for directory - // buckets. + // The MD5 hash of the request body. + // + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. + // + // This functionality is not supported for directory buckets. ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide // does not match the actual owner of the bucket, the request fails with the HTTP - // status code 403 Forbidden (access denied). For directory buckets, this header - // is not supported in this API operation. If you specify this header, the request - // fails with the HTTP status code 501 Not Implemented . + // status code 403 Forbidden (access denied). + // + // For directory buckets, this header is not supported in this API operation. If + // you specify this header, the request fails with the HTTP status code 501 Not + // Implemented . ExpectedBucketOwner *string noSmithyDocumentSerde diff --git a/service/s3/api_op_PutBucketReplication.go b/service/s3/api_op_PutBucketReplication.go index bf59164c035..00182a6bfbb 100644 --- a/service/s3/api_op_PutBucketReplication.go +++ b/service/s3/api_op_PutBucketReplication.go @@ -15,47 +15,71 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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. You can invoke this request for a specific Amazon -// Web Services Region by using the aws:RequestedRegion (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion) -// condition key. 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 +// This operation is not supported by directory buckets. +// +// Creates a replication configuration or replaces an existing one. For more +// information, see [Replication]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. You can +// invoke this request for a specific Amazon Web Services Region by using the [aws:RequestedRegion] +// aws:RequestedRegion condition key. +// +// 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]. +// +// For information about enabling versioning on a bucket, see [Using Versioning]. +// +// 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) +// replication configuration, see [Replicating Objects Created with SSE Using KMS keys]. +// +// For information on PutBucketReplication errors, see [List of replication-related error codes] +// // 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) +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// To perform this operation, the user or role performing the action must have the [iam:PassRole] +// permission. +// +// The following operations are related to PutBucketReplication : +// +// [GetBucketReplication] +// +// [DeleteBucketReplication] +// +// [iam:PassRole]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html +// [GetBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html +// [aws:RequestedRegion]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion +// [Replicating Objects Created with SSE Using KMS keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html +// [Using Versioning]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html +// [Replication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html +// [List of replication-related error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList +// [Backward Compatibility]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations +// [DeleteBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html func (c *Client) PutBucketReplication(ctx context.Context, params *PutBucketReplicationInput, optFns ...func(*Options)) (*PutBucketReplicationOutput, error) { if params == nil { params = &PutBucketReplicationInput{} @@ -88,17 +112,23 @@ type PutBucketReplicationInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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]. + // + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketRequestPayment.go b/service/s3/api_op_PutBucketRequestPayment.go index 07e0f163993..57992d9d3ad 100644 --- a/service/s3/api_op_PutBucketRequestPayment.go +++ b/service/s3/api_op_PutBucketRequestPayment.go @@ -15,14 +15,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]. +// +// The following operations are related to PutBucketRequestPayment : +// +// [CreateBucket] +// +// [GetBucketRequestPayment] +// +// [GetBucketRequestPayment]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html +// [Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html func (c *Client) PutBucketRequestPayment(ctx context.Context, params *PutBucketRequestPaymentInput, optFns ...func(*Options)) (*PutBucketRequestPaymentOutput, error) { if params == nil { params = &PutBucketRequestPaymentInput{} @@ -54,17 +62,23 @@ type PutBucketRequestPaymentInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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]. + // + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketTagging.go b/service/s3/api_op_PutBucketTagging.go index 0f0a6fd4067..7a97414e5b1 100644 --- a/service/s3/api_op_PutBucketTagging.go +++ b/service/s3/api_op_PutBucketTagging.go @@ -15,39 +15,54 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Sets the tags for a -// bucket. 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) -// and Using Cost Allocation in Amazon S3 Bucket Tags (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html) -// . When this operation sets the tags for a bucket, it will overwrite any current +// This operation is not supported by directory buckets. +// +// Sets the tags for a bucket. +// +// 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]and [Using Cost Allocation in Amazon S3 Bucket Tags]. +// +// 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. For more Amazon S3 errors -// see, Error Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) -// . +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// PutBucketTagging has the following special errors. For more Amazon S3 errors +// see, [Error Responses]. +// // - InvalidTag - The tag provided was not a valid tag. This error can occur if -// the tag did not pass input validation. For more information, see Using Cost -// Allocation in Amazon S3 Bucket Tags (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html) -// . +// the tag did not pass input validation. For more information, see [Using Cost Allocation in Amazon S3 Bucket Tags]. +// // - MalformedXML - The XML provided does not match the schema. +// // - OperationAborted - A conflicting conditional action is currently in progress // against this resource. Please try again. +// // - InternalError - 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) +// +// [GetBucketTagging] +// +// [DeleteBucketTagging] +// +// [Error Responses]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html +// [GetBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html +// [Cost Allocation and Tagging]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.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 +// [DeleteBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html +// [Using Cost Allocation in Amazon S3 Bucket Tags]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error) { if params == nil { params = &PutBucketTaggingInput{} @@ -79,17 +94,23 @@ type PutBucketTaggingInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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]. + // + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketVersioning.go b/service/s3/api_op_PutBucketVersioning.go index 495725cea90..9a5d520a799 100644 --- a/service/s3/api_op_PutBucketVersioning.go +++ b/service/s3/api_op_PutBucketVersioning.go @@ -15,28 +15,47 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Sets the versioning state -// of an existing bucket. You can set the versioning state with one of the -// following values: Enabled—Enables versioning for the 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) -// 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 -// 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. (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) -// . The following operations are related to PutBucketVersioning : -// - 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) +// This operation is not supported by directory buckets. +// +// Sets the versioning state of an existing bucket. +// +// You can set the versioning state with one of the following values: +// +// Enabled—Enables versioning for the 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]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 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. (A version-enabled bucket +// maintains one current and zero or more noncurrent object versions.) For more +// information, see [Lifecycle and Versioning]. +// +// The following operations are related to PutBucketVersioning : +// +// [CreateBucket] +// +// [DeleteBucket] +// +// [GetBucketVersioning] +// +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [Lifecycle and Versioning]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config +// [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{} @@ -68,17 +87,23 @@ type PutBucketVersioningInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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]. + // + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutBucketWebsite.go b/service/s3/api_op_PutBucketWebsite.go index 08c8a582f51..85d0214ab94 100644 --- a/service/s3/api_op_PutBucketWebsite.go +++ b/service/s3/api_op_PutBucketWebsite.go @@ -15,21 +15,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Sets the configuration of -// the website that is specified in the website 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 +// This operation is not supported by directory buckets. +// +// Sets the configuration of the website that is specified in the website +// 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]. +// +// 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. +// 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 @@ -37,27 +45,47 @@ import ( // 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. The maximum request length is limited to 128 KB. +// information, see [Configuring an Object Redirect]in the Amazon S3 User Guide. +// +// The maximum request length is limited to 128 KB. +// +// [Hosting Websites on Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html +// [Configuring an Object Redirect]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html func (c *Client) PutBucketWebsite(ctx context.Context, params *PutBucketWebsiteInput, optFns ...func(*Options)) (*PutBucketWebsiteOutput, error) { if params == nil { params = &PutBucketWebsiteInput{} @@ -89,17 +117,23 @@ type PutBucketWebsiteInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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]. + // + // For requests made using the Amazon Web Services Command Line Interface (CLI) or + // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide diff --git a/service/s3/api_op_PutObject.go b/service/s3/api_op_PutObject.go index d57e0026ef7..6a479960638 100644 --- a/service/s3/api_op_PutObject.go +++ b/service/s3/api_op_PutObject.go @@ -18,51 +18,60 @@ import ( ) // Adds an object to a bucket. +// // - Amazon S3 never adds partial objects; if you receive a success response, // Amazon S3 added the entire object to the bucket. You cannot use PutObject to // only update a single piece of metadata for an existing object. You must put the // entire object with updated metadata if you want to update some values. +// // - If your bucket uses the bucket owner enforced setting for Object Ownership, // ACLs are disabled and no longer affect permissions. All objects written to the // bucket by any account will be owned by the bucket owner. +// // - Directory buckets - For directory buckets, you must make requests for this // API operation to the Zonal endpoint. These endpoints support // virtual-hosted-style requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . -// Path-style requests are not supported. For more information, see Regional and -// Zonal endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. +// Path-style requests are not supported. For more information, see [Regional and Zonal endpoints]in the +// Amazon S3 User Guide. // // 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. // However, Amazon S3 provides features that can modify this behavior: +// // - S3 Object Lock - 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) -// in the Amazon S3 User Guide. This functionality is not supported for directory -// buckets. +// can use [Amazon S3 Object Lock]in the Amazon S3 User Guide. +// +// This functionality is not supported for directory buckets. +// // - S3 Versioning - When you enable versioning for a bucket, if Amazon S3 // receives multiple write requests for the same object simultaneously, it stores // all versions of the objects. For each write request that is made to the same // object, Amazon S3 automatically generates a unique version ID of that object // being stored in Amazon S3. You can retrieve, replace, or delete any version of -// the object. For more information about versioning, see Adding Objects to -// Versioning-Enabled Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html) -// in the Amazon S3 User Guide. For information about returning the versioning -// state of a bucket, see GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) -// . This functionality is not supported for directory buckets. +// the object. For more information about versioning, see [Adding Objects to Versioning-Enabled Buckets]in the Amazon S3 User +// Guide. For information about returning the versioning state of a bucket, see [GetBucketVersioning] +// . +// +// This functionality is not supported for directory buckets. // // Permissions +// // - General purpose bucket permissions - The following permissions are required // in your policies when your PutObject request includes specific headers. +// // - s3:PutObject - To successfully complete the PutObject request, you must // always have the s3:PutObject permission on a bucket to add an object to it. +// // - s3:PutObjectAcl - To successfully change the objects ACL of your PutObject // request, you must have the s3:PutObjectAcl . +// // - s3:PutObjectTagging - To successfully set the tag-set with your PutObject // request, you must have the s3:PutObjectTagging . +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -70,24 +79,36 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // // Data integrity with Content-MD5 +// // - General purpose bucket - 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, // Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 // digest, you can calculate the MD5 while putting the object to Amazon S3 and // compare the returned ETag to the calculated MD5 value. +// // - Directory bucket - This functionality is not supported for directory // buckets. // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// For more information about related Amazon S3 APIs, see the following: +// +// [CopyObject] +// +// [DeleteObject] +// +// [Amazon S3 Object Lock]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html +// [DeleteObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [Adding Objects to Versioning-Enabled Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html +// [CopyObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [GetBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*Options)) (*PutObjectOutput, error) { if params == nil { params = &PutObjectInput{} @@ -105,31 +126,39 @@ func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns . type PutObjectInput struct { - // The bucket name to which the PUT action was initiated. Directory buckets - When - // you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // The bucket name to which the PUT action was initiated. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -139,26 +168,33 @@ 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) - // in the Amazon S3 User Guide. 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) - // in the Amazon S3 User Guide. 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) - // in the Amazon S3 User Guide. + // The canned ACL to apply to the object. For more information, see [Canned ACL] in the Amazon + // S3 User Guide. + // + // 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]and [Managing ACLs Using the REST API] in the Amazon S3 User Guide. + // + // 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]in the Amazon S3 User Guide. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. + // + // [Managing ACLs Using the REST API]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html + // [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html + // [Canned ACL]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL + // [Controlling ownership of objects and disabling ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html ACL types.ObjectCannedACL // Object data. @@ -167,102 +203,124 @@ type PutObjectInput struct { // Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption // with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). // Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object - // encryption with SSE-KMS. Specifying this header with a PUT action doesn’t affect - // bucket-level settings for S3 Bucket Key. This functionality is not supported for - // directory buckets. + // encryption with SSE-KMS. + // + // Specifying this header with a PUT action doesn’t affect bucket-level settings + // for S3 Bucket Key. + // + // This functionality is not supported for directory buckets. 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]: 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 you use // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send this header, there must be a corresponding // x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 - // fails the request with the HTTP status code 400 Bad Request . For the - // x-amz-checksum-algorithm header, replace algorithm with the supported - // algorithm from the following list: + // fails the request with the HTTP status code 400 Bad Request . + // + // For the x-amz-checksum-algorithm header, replace algorithm with the + // supported algorithm from the following list: + // // - CRC32 + // // - CRC32C + // // - SHA1 + // // - SHA256 - // 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 the individual checksum value you provide - // through x-amz-checksum-algorithm doesn't match the checksum algorithm you set - // through x-amz-sdk-checksum-algorithm , Amazon S3 ignores any provided - // ChecksumAlgorithm parameter and uses the checksum algorithm that matches the - // provided value in x-amz-checksum-algorithm . For directory buckets, when you - // use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's - // used for performance. + // + // For more information, see [Checking object integrity] in the Amazon S3 User Guide. + // + // If the individual checksum value you provide through x-amz-checksum-algorithm + // doesn't match the checksum algorithm you set through + // x-amz-sdk-checksum-algorithm , Amazon S3 ignores any provided ChecksumAlgorithm + // parameter and uses the checksum algorithm that matches the provided value in + // x-amz-checksum-algorithm . + // + // For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the + // default checksum algorithm that's used for performance. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // 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) + // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 32-bit CRC32C checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) - // . + // 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 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) - // . + // 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 ContentEncoding *string // The language the content is in. ContentLanguage *string // 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) - // . + // 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 ContentLength *int64 // The base64-encoded 128-bit MD5 digest of the message (without the headers) // according to RFC 1864. This header can be used as a message integrity check to // 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) - // . The Content-MD5 header is required for any request to upload an object with a + // integrity check. For more information about REST request authentication, see [REST Authentication]. + // + // 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. This functionality is not supported for directory - // buckets. + // about Amazon S3 Object Lock, see [Amazon S3 Object Lock Overview]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [REST Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + // [Amazon S3 Object Lock Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.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]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type ContentType *string // The account ID of the expected bucket owner. If the account ID that you provide @@ -271,27 +329,36 @@ 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]: 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 functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantFullControl *string // Allows grantee to read the object data and its metadata. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantRead *string // Allows grantee to read the object ACL. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantReadACP *string // Allows grantee to write the ACL for the applicable object. + // // - This functionality is not supported for directory buckets. + // // - This functionality is not supported for Amazon S3 on Outposts. GrantWriteACP *string @@ -299,46 +366,55 @@ 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // information about S3 Object Lock, see [Object Lock]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [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. This functionality - // is not supported for directory buckets. + // The Object Lock mode that you want to apply to this object. + // + // This functionality is not supported for directory buckets. ObjectLockMode types.ObjectLockMode // The date and time when you want this object's Object Lock to expire. Must be - // formatted as a timestamp parameter. This functionality is not supported for - // directory buckets. + // formatted as a timestamp parameter. + // + // This functionality is not supported for directory buckets. ObjectLockRetainUntilDate *time.Time // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, AES256 - // ). This functionality is not supported for directory buckets. + // Specifies the algorithm to use when encrypting the object (for example, AES256 ). + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in // 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 functionality is - // not supported for directory buckets. + // x-amz-server-side-encryption-customer-algorithm header. + // + // This functionality is not supported for directory buckets. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported for directory buckets. + // encryption key was transmitted without error. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // Specifies the Amazon Web Services KMS Encryption Context to use for object @@ -346,8 +422,9 @@ type PutObjectInput struct { // JSON with the encryption context key-value pairs. This value is stored as object // metadata and automatically gets passed on to Amazon Web Services KMS for future // GetObject or CopyObject operations on this object. This value must be - // explicitly added during CopyObject operations. This functionality is not - // supported for directory buckets. + // explicitly added during CopyObject operations. + // + // This functionality is not supported for directory buckets. SSEKMSEncryptionContext *string // If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse , @@ -358,53 +435,72 @@ type PutObjectInput struct { // x-amz-server-side-encryption-aws-kms-key-id , Amazon S3 uses the Amazon Web // Services managed key ( aws/s3 ) to protect the data. If the KMS key does not // exist in the same account that's issuing the command, you must use the full ARN - // and not just the ID. This functionality is not supported for directory buckets. + // and not just the ID. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm that was used when you store this object - // in Amazon S3 (for example, AES256 , aws:kms , aws:kms:dsse ). General purpose - // buckets - You have four 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 or DSSE-KMS), and - // customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side + // in Amazon S3 (for example, AES256 , aws:kms , aws:kms:dsse ). + // + // General purpose buckets - You have four 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 or DSSE-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 rest by 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) - // in the Amazon S3 User Guide. Directory buckets - For directory buckets, only the - // server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) value is - // supported. + // encryption with other key options. For more information, see [Using Server-Side Encryption]in the Amazon S3 + // User Guide. + // + // Directory buckets - For directory buckets, only the server-side encryption with + // Amazon S3 managed keys (SSE-S3) ( AES256 ) value is supported. + // + // [Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html 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. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) - // in the Amazon S3 User Guide. + // Storage Class. For more information, see [Storage Classes]in the Amazon S3 User Guide. + // // - For directory buckets, only the S3 Express One Zone storage class is // supported to store newly created objects. + // // - Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. + // + // [Storage Classes]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html StorageClass types.StorageClass // The tag-set for the object. The tag-set must be encoded as URL Query - // parameters. (For example, "Key1=Value1") This functionality is not supported for - // directory buckets. + // parameters. (For example, "Key1=Value1") + // + // This functionality is not supported for directory buckets. 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 Amazon S3 User Guide. 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) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // metadata, see [Object Key and Metadata]in the Amazon S3 User Guide. + // + // 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] and [How to Configure Website Page Redirects] in the + // Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. + // + // [How to Configure Website Page Redirects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html + // [Hosting Websites on Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html + // [Object Key and Metadata]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html WebsiteRedirectLocation *string noSmithyDocumentSerde @@ -419,8 +515,9 @@ func (in *PutObjectInput) bindEndpointParams(p *EndpointParameters) { type PutObjectOutput struct { // Indicates whether the uploaded object uses an S3 Bucket Key for server-side - // encryption with Key Management Service (KMS) keys (SSE-KMS). This functionality - // is not supported for directory buckets. + // encryption with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be @@ -428,8 +525,10 @@ type PutObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -437,8 +536,10 @@ type PutObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -446,8 +547,10 @@ type PutObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -455,71 +558,89 @@ type PutObjectOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string - // Entity tag for the uploaded object. General purpose buckets - To ensure that - // data is not corrupted traversing the network, for objects where the ETag is the - // MD5 digest of the object, you can calculate the MD5 while putting an object to - // Amazon S3 and compare the returned ETag to the calculated MD5 value. Directory - // buckets - The ETag for the object in a directory bucket isn't the MD5 digest of - // the object. + // Entity tag for the uploaded object. + // + // General purpose buckets - To ensure that data is not corrupted traversing the + // network, for objects where the ETag is the MD5 digest of the object, you can + // calculate the MD5 while putting an object to Amazon S3 and compare the returned + // ETag to the calculated MD5 value. + // + // Directory buckets - The ETag for the object in a directory bucket isn't the MD5 + // digest of the object. ETag *string - // If the expiration is configured for the object (see - // PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) - // ) in the Amazon S3 User Guide, 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. This functionality - // is not supported for directory buckets. + // If the expiration is configured for the object (see [PutBucketLifecycleConfiguration]) in the Amazon S3 User + // Guide, 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. + // + // This functionality is not supported for directory buckets. + // + // [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html Expiration *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the Amazon Web Services KMS Encryption Context to use for // object encryption. The value of this header is a base64-encoded UTF-8 string // holding JSON with the encryption context key-value pairs. This value is stored // as object metadata and automatically gets passed on to Amazon Web Services KMS - // for future GetObject or CopyObject operations on this object. This - // functionality is not supported for directory buckets. + // for future GetObject or CopyObject operations on this object. + // + // This functionality is not supported for directory buckets. SSEKMSEncryptionContext *string // If x-amz-server-side-encryption has a valid value of aws:kms or aws:kms:dsse , // this header indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). For directory buckets, only - // server-side encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is - // supported. + // S3 (for example, AES256 , aws:kms , aws:kms:dsse ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. ServerSideEncryption types.ServerSideEncryption - // Version ID of the object. 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) - // in the Amazon S3 User Guide. For information about returning the versioning - // state of a bucket, see GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) - // . This functionality is not supported for directory buckets. + // Version ID of the object. + // + // 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]in the Amazon S3 User + // Guide. For information about returning the versioning state of a bucket, see [GetBucketVersioning]. + // + // This functionality is not supported for directory buckets. + // + // [Adding Objects to Versioning-Enabled Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html + // [GetBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html VersionId *string // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_PutObjectAcl.go b/service/s3/api_op_PutObjectAcl.go index 08fea12c1b2..bebccdced78 100644 --- a/service/s3/api_op_PutObjectAcl.go +++ b/service/s3/api_op_PutObjectAcl.go @@ -14,87 +14,152 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 the 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) -// in the Amazon S3 User Guide. This functionality is not supported for 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) -// in the Amazon S3 User Guide. Permissions You can set access permissions using -// one of the following methods: +// This operation is not supported by directory buckets. +// +// 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 the WRITE_ACP permission +// to set the ACL of an object. For more information, see [What permissions can I grant?]in the Amazon S3 User +// Guide. +// +// This functionality is not supported for 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]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]in the +// Amazon S3 User Guide. +// +// 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) -// . +// control-specific headers in your request. For more information, see [Canned ACL]. +// // - 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" +// Amazon S3 supports in an ACL. For more information, see [Access Control List (ACL) Overview]. +// +// 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]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. +// 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]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. The following operations are -// related to PutObjectAcl : -// - CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) -// - GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) +// different version, use the versionId subresource. +// +// The following operations are related to PutObjectAcl : +// +// [CopyObject] +// +// [GetObject] +// +// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region +// [Access Control List (ACL) Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html +// [Controlling object ownership]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html +// [Canned ACL]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL +// [CopyObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html +// [What permissions can I grant?]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions +// [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{} @@ -113,6 +178,7 @@ func (c *Client) PutObjectAcl(ctx context.Context, params *PutObjectAclInput, op type PutObjectAclInput struct { // The bucket name that contains the object to which you want to attach the ACL. + // // Access points - When you use this action with 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 @@ -120,15 +186,18 @@ 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) - // in the Amazon S3 User Guide. S3 on Outposts - 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 + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -138,8 +207,9 @@ type PutObjectAclInput 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) - // . + // The canned ACL to apply to the object. For more information, see [Canned ACL]. + // + // [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. @@ -149,17 +219,23 @@ type PutObjectAclInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // transit. For more information, go to [RFC 1864.>] + // // For requests made using the Amazon Web Services Command Line Interface (CLI) or // Amazon Web Services SDKs, this field is calculated automatically. + // + // [RFC 1864.>]: http://www.ietf.org/rfc/rfc1864.txt ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide @@ -168,38 +244,47 @@ type PutObjectAclInput struct { ExpectedBucketOwner *string // Allows grantee the read, write, read ACP, and write ACP permissions on the - // bucket. This functionality is not supported for Amazon S3 on Outposts. + // bucket. + // + // This functionality is not supported for Amazon S3 on Outposts. GrantFullControl *string - // Allows grantee to list the objects in the bucket. This functionality is not - // supported for Amazon S3 on Outposts. + // Allows grantee to list the objects in the bucket. + // + // This functionality is not supported for Amazon S3 on Outposts. GrantRead *string - // Allows grantee to read the bucket ACL. This functionality is not supported for - // Amazon S3 on Outposts. + // Allows grantee to read the bucket ACL. + // + // This functionality is not supported for Amazon S3 on Outposts. GrantReadACP *string - // Allows grantee to create new objects in the bucket. For the bucket and object - // owners of existing objects, also allows deletions and overwrites of those - // objects. + // Allows grantee to create new objects in the bucket. + // + // For the bucket and object owners of existing objects, also allows deletions and + // overwrites of those objects. GrantWrite *string - // Allows grantee to write the ACL for the applicable bucket. This functionality - // is not supported for Amazon S3 on Outposts. + // Allows grantee to write the ACL for the applicable bucket. + // + // This functionality is not supported for Amazon S3 on Outposts. GrantWriteACP *string // Confirms that the requester knows that they will be charged for the request. // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Version ID used to reference a specific version of the object. This - // functionality is not supported for directory buckets. + // Version ID used to reference a specific version of the object. + // + // This functionality is not supported for directory buckets. VersionId *string noSmithyDocumentSerde @@ -214,7 +299,9 @@ func (in *PutObjectAclInput) bindEndpointParams(p *EndpointParameters) { type PutObjectAclOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_PutObjectLegalHold.go b/service/s3/api_op_PutObjectLegalHold.go index cc23509f8bb..98f3dcbf866 100644 --- a/service/s3/api_op_PutObjectLegalHold.go +++ b/service/s3/api_op_PutObjectLegalHold.go @@ -14,9 +14,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 functionality is not supported for Amazon S3 on Outposts. +// This operation is not supported by directory buckets. +// +// Applies a legal hold configuration to the specified object. For more +// information, see [Locking Objects]. +// +// This functionality is not supported for Amazon S3 on Outposts. +// +// [Locking Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html func (c *Client) PutObjectLegalHold(ctx context.Context, params *PutObjectLegalHoldInput, optFns ...func(*Options)) (*PutObjectLegalHoldOutput, error) { if params == nil { params = &PutObjectLegalHoldInput{} @@ -35,6 +40,7 @@ func (c *Client) PutObjectLegalHold(ctx context.Context, params *PutObjectLegalH type PutObjectLegalHoldInput struct { // The bucket name containing the object that you want to place a legal hold on. + // // Access points - When you use this action with 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 @@ -42,8 +48,9 @@ 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) - // in the Amazon S3 User Guide. + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -57,15 +64,19 @@ type PutObjectLegalHoldInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm - // The MD5 hash for the request body. For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The MD5 hash for the request body. + // + // 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 account ID that you provide @@ -81,10 +92,12 @@ type PutObjectLegalHoldInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The version ID of the object that you want to place a legal hold on. @@ -101,7 +114,9 @@ func (in *PutObjectLegalHoldInput) bindEndpointParams(p *EndpointParameters) { type PutObjectLegalHoldOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_PutObjectLockConfiguration.go b/service/s3/api_op_PutObjectLockConfiguration.go index 358ececc6dc..0eb948a9657 100644 --- a/service/s3/api_op_PutObjectLockConfiguration.go +++ b/service/s3/api_op_PutObjectLockConfiguration.go @@ -14,17 +14,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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) -// . +// This operation is not supported by directory buckets. +// +// 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]. +// // - 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 enable Object Lock for new or existing buckets. For more -// information, see Configuring Object Lock (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html) -// . +// information, see [Configuring Object Lock]. +// +// [Configuring Object Lock]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html +// [Locking Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html func (c *Client) PutObjectLockConfiguration(ctx context.Context, params *PutObjectLockConfigurationInput, optFns ...func(*Options)) (*PutObjectLockConfigurationOutput, error) { if params == nil { params = &PutObjectLockConfigurationInput{} @@ -51,15 +56,19 @@ type PutObjectLockConfigurationInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm - // The MD5 hash for the request body. For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The MD5 hash for the request body. + // + // 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 account ID that you provide @@ -74,10 +83,12 @@ type PutObjectLockConfigurationInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // A token to allow Object Lock to be enabled for an existing bucket. @@ -94,7 +105,9 @@ func (in *PutObjectLockConfigurationInput) bindEndpointParams(p *EndpointParamet type PutObjectLockConfigurationOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_PutObjectRetention.go b/service/s3/api_op_PutObjectRetention.go index eb787de4894..d3c6ed4f5a0 100644 --- a/service/s3/api_op_PutObjectRetention.go +++ b/service/s3/api_op_PutObjectRetention.go @@ -14,12 +14,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// Places an Object Retention configuration on an object. For more information, +// see [Locking Objects]. 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 functionality is not supported for Amazon S3 on Outposts. +// +// [Locking Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html func (c *Client) PutObjectRetention(ctx context.Context, params *PutObjectRetentionInput, optFns ...func(*Options)) (*PutObjectRetentionOutput, error) { if params == nil { params = &PutObjectRetentionInput{} @@ -38,15 +42,18 @@ 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. Access points - When you use this action with 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 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. + // Retention configuration to. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -64,15 +71,19 @@ type PutObjectRetentionInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm - // The MD5 hash for the request body. For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The MD5 hash for the request body. + // + // 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 account ID that you provide @@ -84,10 +95,12 @@ type PutObjectRetentionInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The container element for the Object Retention configuration. @@ -108,7 +121,9 @@ func (in *PutObjectRetentionInput) bindEndpointParams(p *EndpointParameters) { type PutObjectRetentionOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_PutObjectTagging.go b/service/s3/api_op_PutObjectTagging.go index 2768db5025d..6c43900c4ba 100644 --- a/service/s3/api_op_PutObjectTagging.go +++ b/service/s3/api_op_PutObjectTagging.go @@ -14,35 +14,50 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Sets the supplied tag-set -// to an object that already exists in a bucket. A tag is a key-value pair. For -// more information, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) -// . You can associate tags with an object by sending a PUT request against the +// This operation is not supported by directory buckets. +// +// Sets the supplied tag-set to an object that already exists in a bucket. A tag +// is a key-value pair. For more information, see [Object Tagging]. +// +// 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. +// sending a GET request. For more information, see [GetObjectTagging]. +// +// For tagging-related restrictions related to characters and encodings, see [Tag Restrictions]. +// 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. PutObjectTagging has the following special -// errors. For more Amazon S3 errors see, Error Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) -// . +// 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. +// +// PutObjectTagging has the following special errors. For more Amazon S3 errors +// see, [Error Responses]. +// // - InvalidTag - 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/userguide/object-tagging.html) -// . +// the tag did not pass input validation. For more information, see [Object Tagging]. +// // - MalformedXML - The XML provided does not match the schema. +// // - OperationAborted - A conflicting conditional action is currently in progress // against this resource. Please try again. +// // - InternalError - The service was unable to apply the provided tag to the // object. // // The following operations are related to PutObjectTagging : -// - GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) -// - DeleteObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) +// +// [GetObjectTagging] +// +// [DeleteObjectTagging] +// +// [Error Responses]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html +// [DeleteObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html +// [Object Tagging]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html +// [Tag Restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html +// [GetObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html func (c *Client) PutObjectTagging(ctx context.Context, params *PutObjectTaggingInput, optFns ...func(*Options)) (*PutObjectTaggingOutput, error) { if params == nil { params = &PutObjectTaggingInput{} @@ -60,23 +75,27 @@ func (c *Client) PutObjectTagging(ctx context.Context, params *PutObjectTaggingI type PutObjectTaggingInput struct { - // The bucket name containing the object. Access points - When you use this action - // with 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 + // The bucket name containing the object. + // + // Access points - When you use this action with 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 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. S3 on Outposts - 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 + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -95,15 +114,19 @@ type PutObjectTaggingInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm - // The MD5 hash for the request body. For requests made using the Amazon Web - // Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is - // calculated automatically. + // The MD5 hash for the request body. + // + // 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 account ID that you provide @@ -115,10 +138,12 @@ type PutObjectTaggingInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // The versionId of the object that the tag-set will be added to. diff --git a/service/s3/api_op_PutPublicAccessBlock.go b/service/s3/api_op_PutPublicAccessBlock.go index 7e6d0788e48..009c3a31774 100644 --- a/service/s3/api_op_PutPublicAccessBlock.go +++ b/service/s3/api_op_PutPublicAccessBlock.go @@ -15,22 +15,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. 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 +// This operation is not supported by directory buckets. +// +// 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]. +// +// 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) -// . The following operations are related to PutPublicAccessBlock : -// - 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) +// account-level settings. +// +// For more information about when Amazon S3 considers a bucket or an object +// public, see [The Meaning of "Public"]. +// +// The following operations are related to PutPublicAccessBlock : +// +// [GetPublicAccessBlock] +// +// [DeletePublicAccessBlock] +// +// [GetBucketPolicyStatus] +// +// [Using Amazon S3 Block Public Access] +// +// [GetPublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html +// [DeletePublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html +// [Using Amazon S3 Block Public Access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html +// [GetBucketPolicyStatus]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html +// [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 func (c *Client) PutPublicAccessBlock(ctx context.Context, params *PutPublicAccessBlockInput, optFns ...func(*Options)) (*PutPublicAccessBlockOutput, error) { if params == nil { params = &PutPublicAccessBlockInput{} @@ -56,9 +72,10 @@ 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) - // in the Amazon S3 User Guide. + // information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"]in + // the Amazon S3 User Guide. + // + // [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 // // This member is required. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration @@ -67,15 +84,19 @@ type PutPublicAccessBlockInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm - // The MD5 hash of the PutPublicAccessBlock request body. For requests made using - // the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services - // SDKs, this field is calculated automatically. + // The MD5 hash of the PutPublicAccessBlock request body. + // + // 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 account ID that you provide diff --git a/service/s3/api_op_RestoreObject.go b/service/s3/api_op_RestoreObject.go index 3b6aad85b8b..18bb6d03b92 100644 --- a/service/s3/api_op_RestoreObject.go +++ b/service/s3/api_op_RestoreObject.go @@ -14,40 +14,51 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// This operation is not supported by directory buckets. Restores an archived copy -// of an object back into Amazon S3 This functionality is not supported for Amazon -// S3 on Outposts. This action performs the following types of requests: +// This operation is not supported by directory buckets. +// +// # Restores an archived copy of an object back into Amazon S3 +// +// This functionality is not supported for Amazon S3 on Outposts. +// +// This action performs the following types of requests: +// // - restore an archive - Restore an archived object // // 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 +// +// [PutObject] +// +// [Managing Access with ACLs] +// - in the Amazon S3 User Guide +// +// [Protecting Data Using Server-Side Encryption] +// - in the Amazon S3 User Guide // // Permissions 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. Restoring objects Objects that you archive to the -// S3 Glacier Flexible Retrieval 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 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: +// grant this permission to others. For more information about permissions, see [Permissions Related to Bucket Subresource Operations] +// and [Managing Access Permissions to Your Amazon S3 Resources]in the Amazon S3 User Guide. +// +// Restoring objects Objects that you archive to the S3 Glacier Flexible Retrieval +// 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 +// 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 Flexible Retrieval storage class or // S3 Intelligent-Tiering Archive tier when occasional urgent requests for @@ -57,6 +68,7 @@ import ( // 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 @@ -65,6 +77,7 @@ import ( // 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 @@ -76,29 +89,33 @@ import ( // 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. +// for Expedited data access, see [Restoring Archived Objects] 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]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]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]and [Object Lifecycle Management] +// 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. @@ -128,8 +145,22 @@ import ( // - SOAP Fault Code Prefix: N/A // // The following operations are related to RestoreObject : -// - PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) -// - GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) +// +// [PutBucketLifecycleConfiguration] +// +// [GetBucketNotificationConfiguration] +// +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html +// [Object Lifecycle Management]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.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 +// [Configuring Amazon S3 Event Notifications]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html +// [Managing Access with ACLs]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html +// [Protecting Data Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html +// [GetBucketNotificationConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html +// [PutObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html +// [Restoring Archived Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [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 func (c *Client) RestoreObject(ctx context.Context, params *RestoreObjectInput, optFns ...func(*Options)) (*RestoreObjectOutput, error) { if params == nil { params = &RestoreObjectInput{} @@ -147,23 +178,27 @@ func (c *Client) RestoreObject(ctx context.Context, params *RestoreObjectInput, type RestoreObjectInput struct { - // The bucket name containing the object to restore. Access points - When you use - // this action with 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 + // The bucket name containing the object to restore. + // + // Access points - When you use this action with 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 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. S3 on Outposts - 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 + // access point ARNs, see [Using access points]in the Amazon S3 User Guide. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -177,10 +212,13 @@ type RestoreObjectInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // in the Amazon S3 User Guide. If you provide an individual checksum, Amazon S3 - // ignores any provided ChecksumAlgorithm parameter. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // in the Amazon S3 User Guide. + // + // If you provide an individual checksum, Amazon S3 ignores any provided + // ChecksumAlgorithm parameter. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // The account ID of the expected bucket owner. If the account ID that you provide @@ -192,10 +230,12 @@ type RestoreObjectInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer // Container for restore job parameters. @@ -215,7 +255,9 @@ func (in *RestoreObjectInput) bindEndpointParams(p *EndpointParameters) { type RestoreObjectOutput struct { // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Indicates the path in the provided S3 output location where Select results will diff --git a/service/s3/api_op_SelectObjectContent.go b/service/s3/api_op_SelectObjectContent.go index f69db696ac5..584aa16ab5c 100644 --- a/service/s3/api_op_SelectObjectContent.go +++ b/service/s3/api_op_SelectObjectContent.go @@ -14,67 +14,94 @@ import ( "sync" ) -// This operation is not supported by directory buckets. This action filters the -// contents of an Amazon S3 object based on a simple structured query language -// (SQL) statement. In the request, along with the SQL expression, you must also -// specify a data serialization format (JSON, CSV, or Apache Parquet) of the -// object. Amazon S3 uses this format to parse object data into records, and -// returns only records that match the specified SQL expression. You must also -// specify the data serialization format for the response. This functionality is -// not supported for 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) -// in the Amazon S3 User Guide. Permissions You must have the 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 -// query objects that have the following format properties: +// This operation is not supported by directory buckets. +// +// This action filters the contents of an Amazon S3 object based on a simple +// structured query language (SQL) statement. In the request, along with the SQL +// expression, you must also specify a data serialization format (JSON, CSV, or +// Apache Parquet) of the object. Amazon S3 uses this format to parse object data +// into records, and returns only records that match the specified SQL expression. +// You must also specify the data serialization format for the response. +// +// This functionality is not supported for Amazon S3 on Outposts. +// +// For more information about Amazon S3 Select, see [Selecting Content from Objects] and [SELECT Command] in the Amazon S3 User +// Guide. +// +// Permissions You must have the 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]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. +// 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]. +// For more information about SSE-C, see [Server-Side Encryption (Using Customer-Provided Encryption Keys)]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]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) -// . +// information, see [Appendix: SelectObjectContent Response]. +// +// GetObject Support The SelectObjectContent action does not support the following +// GetObject functionality. For more information, see [GetObject]. +// // - 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. +// request (see [SelectObjectContentRequest - ScanRange]in the request parameters), you cannot specify the range of +// bytes of an object to return. +// // - The GLACIER , DEEP_ARCHIVE , and REDUCED_REDUNDANCY storage classes, or the // ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING // storage class: You cannot query objects in the GLACIER , DEEP_ARCHIVE , or // REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or // DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For -// more information about storage classes, see Using Amazon S3 storage classes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html) -// in the Amazon S3 User Guide. +// more information about storage classes, see [Using Amazon S3 storage classes]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] // -// 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) // The following operations are related to SelectObjectContent : -// - 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] +// +// [GetBucketLifecycleConfiguration] +// +// [PutBucketLifecycleConfiguration] +// +// [Appendix: SelectObjectContent Response]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html +// [Selecting Content from Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html +// [SelectObjectContentRequest - ScanRange]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange +// [List of SELECT Object Content Error Codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList +// [GetBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html +// [Using Amazon S3 storage classes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html +// [SELECT Command]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html +// [Specifying Permissions in a Policy]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html +// +// [Server-Side Encryption (Using Customer-Provided Encryption Keys)]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html +// [Protecting Data Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html func (c *Client) SelectObjectContent(ctx context.Context, params *SelectObjectContentInput, optFns ...func(*Options)) (*SelectObjectContentOutput, error) { if params == nil { params = &SelectObjectContentInput{} @@ -95,9 +122,9 @@ func (c *Client) SelectObjectContent(ctx context.Context, params *SelectObjectCo // expression, you must specify a data serialization format (JSON or CSV) of the // 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) -// . +// serialization format for the response. For more information, see [S3Select API Documentation]. +// +// [S3Select API Documentation]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html type SelectObjectContentInput struct { // The S3 bucket. @@ -140,30 +167,37 @@ 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) - // in the Amazon S3 User Guide. + // For more information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html 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) - // in the Amazon S3 User Guide. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html 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) - // in the Amazon S3 User Guide. + // information, see [Protecting data using SSE-C keys]in the Amazon S3 User Guide. + // + // [Protecting data using SSE-C keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html 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. ScanRange may be - // used in the following ways: + // 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. ScanRange *types.ScanRange diff --git a/service/s3/api_op_UploadPart.go b/service/s3/api_op_UploadPart.go index ff731979498..e78791a8654 100644 --- a/service/s3/api_op_UploadPart.go +++ b/service/s3/api_op_UploadPart.go @@ -16,38 +16,48 @@ import ( "io" ) -// Uploads a part in a multipart upload. In this operation, you provide new data -// as a part of an object 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. +// Uploads a part in a multipart upload. +// +// In this operation, you provide new data as a part of an object 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]operation. +// +// You must initiate a multipart upload (see [CreateMultipartUpload]) 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. 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 . Directory buckets - For directory buckets, you -// must make requests for this API operation to the Zonal endpoint. These endpoints -// support virtual-hosted-style requests in the format +// specifications, see [Multipart upload limits]in the Amazon S3 User Guide. +// +// 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] in the Amazon S3 User Guide . +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Permissions +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Permissions +// // - General purpose bucket permissions - For information on the 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. +// required to use the multipart upload API, see [Multipart Upload and Permissions]in the Amazon S3 User Guide. +// // - Directory bucket permissions - To grant access to this API operation on a -// directory bucket, we recommend that you use the CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// API operation for session-based authorization. Specifically, you grant the +// directory bucket, we recommend that you use the [CreateSession]CreateSession API operation +// for session-based authorization. Specifically, you grant the // s3express:CreateSession permission to the directory bucket in a bucket policy // or an IAM identity-based policy. Then, you make the CreateSession API call on // the bucket to obtain a session token. With the session token in your request @@ -55,19 +65,19 @@ import ( // expires, you make another CreateSession API call to generate a new session // token for use. Amazon Web Services CLI or SDKs create session and refresh the // session token automatically to avoid service interruptions when a session -// expires. For more information about authorization, see CreateSession (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html) -// . +// expires. For more information about authorization, see [CreateSession]CreateSession . // -// Data integrity General purpose bucket - To ensure that data is not corrupted +// Data integrity General purpose bucket - To ensure that data is not corrupted // 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) -// . Directory buckets - MD5 is not supported by directory buckets. You can use -// checksum algorithms to check object integrity. Encryption +// header as a checksum instead of Content-MD5 . For more information see [Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)]. +// +// Directory buckets - MD5 is not supported by directory buckets. You can use +// checksum algorithms to check object integrity. +// +// Encryption // - General purpose bucket - 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 mutually exclusive options to @@ -78,37 +88,70 @@ import ( // encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally // tell Amazon S3 to encrypt data at rest 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 key (SSE-C). Server-side encryption is -// supported by the S3 Multipart Upload operations. 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 request 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 request headers. -// - x-amz-server-side-encryption-customer-algorithm -// - x-amz-server-side-encryption-customer-key -// - x-amz-server-side-encryption-customer-key-MD5 -// - Directory bucket - For directory buckets, only server-side encryption with -// Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. -// -// For more information, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) -// in the Amazon S3 User Guide. Special errors +// (SSE-KMS) or provide your own encryption key (SSE-C). +// +// Server-side encryption is supported by the S3 Multipart Upload operations. +// +// 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]. +// +// If you request 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 request headers. +// +// - x-amz-server-side-encryption-customer-algorithm +// +// - x-amz-server-side-encryption-customer-key +// +// - x-amz-server-side-encryption-customer-key-MD5 +// +// - Directory bucket - For directory buckets, only server-side encryption with +// Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. +// +// For more information, see [Using Server-Side Encryption] in the Amazon S3 User Guide. +// +// Special errors +// // - 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. +// // - HTTP Status Code: 404 Not Found +// // - SOAP Fault Code Prefix: Client // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . The following operations are -// related to UploadPart : -// - 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to UploadPart : +// +// [CreateMultipartUpload] +// +// [CompleteMultipartUpload] +// +// [AbortMultipartUpload] +// +// [ListParts] +// +// [ListMultipartUploads] +// +// [ListParts]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html +// [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 +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CreateSession]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html +// [UploadPartCopy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html +// [Using Server-Side Encryption]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html +// [Multipart upload limits]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html +// [AbortMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html +// [Multipart Upload Overview]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html +// [ListMultipartUploads]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html +// [Multipart Upload and Permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html func (c *Client) UploadPart(ctx context.Context, params *UploadPartInput, optFns ...func(*Options)) (*UploadPartOutput, error) { if params == nil { params = &UploadPartInput{} @@ -126,31 +169,39 @@ func (c *Client) UploadPart(ctx context.Context, params *UploadPartInput, optFns type UploadPartInput struct { - // The name of the bucket to which the multipart upload was initiated. Directory - // buckets - When you use this operation with a directory bucket, you must use - // virtual-hosted-style requests in the format + // The name of the bucket to which the multipart upload was initiated. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // This member is required. Bucket *string @@ -178,40 +229,48 @@ type UploadPartInput struct { // the SDK. This header will not provide any additional functionality if you don't // use the SDK. When you send 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) - // 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 - // CreateMultipartUpload request. + // request with the HTTP status code 400 Bad Request . For more information, see [Checking object integrity] + // 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 CreateMultipartUpload request. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm types.ChecksumAlgorithm // 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) + // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 32-bit CRC32C checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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) + // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA256 *string // Size of the body in bytes. This parameter is useful when the size of the body @@ -220,8 +279,9 @@ type UploadPartInput struct { // The base64-encoded 128-bit MD5 digest of the part data. This parameter is // auto-populated when using the command from the CLI. This parameter is required - // if object lock parameters are specified. This functionality is not supported for - // directory buckets. + // if object lock parameters are specified. + // + // This functionality is not supported for directory buckets. ContentMD5 *string // The account ID of the expected bucket owner. If the account ID that you provide @@ -233,14 +293,17 @@ type UploadPartInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, - // AES256). This functionality is not supported for directory buckets. + // Specifies the algorithm to use when encrypting the object (for example, AES256). + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in @@ -248,14 +311,16 @@ type UploadPartInput struct { // 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 - // encryption key specified in the initiate multipart upload request. This - // functionality is not supported for directory buckets. + // encryption key specified in the initiate multipart upload request. + // + // This functionality is not supported for directory buckets. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported for directory buckets. + // encryption key was transmitted without error. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string noSmithyDocumentSerde @@ -270,8 +335,9 @@ func (in *UploadPartInput) bindEndpointParams(p *EndpointParameters) { type UploadPartOutput struct { // Indicates whether the multipart upload uses an S3 Bucket Key for server-side - // encryption with Key Management Service (KMS) keys (SSE-KMS). This functionality - // is not supported for directory buckets. + // encryption with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // The base64-encoded, 32-bit CRC32 checksum of the object. This will only be @@ -279,8 +345,10 @@ type UploadPartOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -288,8 +356,10 @@ type UploadPartOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -297,8 +367,10 @@ type UploadPartOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -306,37 +378,46 @@ type UploadPartOutput struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string // Entity tag for the uploaded object. ETag *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms ). For directory buckets, only server-side - // encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. + // S3 (for example, AES256 , aws:kms ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. ServerSideEncryption types.ServerSideEncryption // Metadata pertaining to the operation's result. diff --git a/service/s3/api_op_UploadPartCopy.go b/service/s3/api_op_UploadPartCopy.go index d42dc60cd3d..23fb6ef516a 100644 --- a/service/s3/api_op_UploadPartCopy.go +++ b/service/s3/api_op_UploadPartCopy.go @@ -18,90 +18,134 @@ import ( // Uploads a part by copying data from an existing object as data source. To // specify the data source, you add the request header x-amz-copy-source in your // request. To specify a byte range, you add 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 copying data from an existing object as -// part data, you might use the UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) -// action to upload new data as a part of an object in your request. You must -// initiate a multipart upload before you can upload any part. In response to your -// initiate request, Amazon S3 returns the upload ID, a unique identifier that you -// must include in your upload part request. 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 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. Directory buckets - For directory buckets, you must -// make requests for this API operation to the Zonal endpoint. These endpoints -// support virtual-hosted-style requests in the format +// 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]in the Amazon S3 User Guide. +// +// Instead of copying data from an existing object as part data, you might use the [UploadPart] +// action to upload new data as a part of an object in your request. +// +// You must initiate a multipart upload before you can upload any part. In +// response to your initiate request, Amazon S3 returns the upload ID, a unique +// identifier that you must include in your upload part request. +// +// For conceptual information about multipart uploads, see [Uploading Objects Using Multipart Upload] in the Amazon S3 User +// Guide. For information about copying objects using a single atomic action vs. a +// multipart upload, see [Operations on Objects]in the Amazon S3 User Guide. +// +// Directory buckets - For directory buckets, you must make requests for this API +// operation to the Zonal endpoint. These endpoints support virtual-hosted-style +// requests in the format // https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style -// requests are not supported. For more information, see Regional and Zonal -// endpoints (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html) -// in the Amazon S3 User Guide. Authentication and authorization All UploadPartCopy -// requests must be authenticated and signed by using IAM credentials (access key -// ID and secret access key for the IAM identities). All headers with the x-amz- -// prefix, including x-amz-copy-source , must be signed. For more information, see -// REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) -// . Directory buckets - You must use IAM credentials to authenticate and authorize +// requests are not supported. For more information, see [Regional and Zonal endpoints]in the Amazon S3 User +// Guide. +// +// Authentication and authorization All UploadPartCopy requests must be +// authenticated and signed by using IAM credentials (access key ID and secret +// access key for the IAM identities). All headers with the x-amz- prefix, +// including x-amz-copy-source , must be signed. For more information, see [REST Authentication]. +// +// Directory buckets - You must use IAM credentials to authenticate and authorize // your access to the UploadPartCopy API operation, instead of using the temporary -// security credentials through the CreateSession API operation. Amazon Web -// Services CLI or SDKs handles authentication and authorization on your behalf. +// security credentials through the CreateSession API operation. +// +// Amazon Web Services CLI or SDKs handles authentication and authorization on +// your behalf. +// // Permissions You must have READ access to the source object and WRITE access to // the destination bucket. +// // - General purpose bucket permissions - You must have the permissions in a // policy based on the bucket types of your source bucket and destination bucket in // an UploadPartCopy operation. +// // - If the source object is in a general purpose bucket, you must have the // s3:GetObject permission to read the source object that is being copied. +// // - If the destination bucket is a general purpose bucket, you must have the // s3:PutObject permission to write the object copy to the destination bucket. -// 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. -// - Directory bucket permissions - You must have permissions in a bucket policy -// or an IAM identity-based policy based on the source and destination bucket types -// in an UploadPartCopy operation. -// - If the source object that you want to copy is in a directory bucket, you -// must have the s3express:CreateSession permission in the Action element of a -// policy to read the object . By default, the session is in the ReadWrite mode. -// If you want to restrict the access, you can explicitly set the -// s3express:SessionMode condition key to ReadOnly on the copy source bucket. -// - If the copy destination is a directory bucket, you must have the -// s3express:CreateSession permission in the Action element of a policy to write -// the object to the destination. The s3express:SessionMode condition key cannot -// be set to ReadOnly on the copy destination. For example policies, see Example -// bucket policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html) -// and Amazon Web Services Identity and Access Management (IAM) identity-based -// policies for S3 Express One Zone (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html) -// in the Amazon S3 User Guide. +// +// For information about permissions required to use the multipart upload API, see [Multipart Upload and Permissions] +// +// in the Amazon S3 User Guide. +// +// - Directory bucket permissions - You must have permissions in a bucket policy +// or an IAM identity-based policy based on the source and destination bucket types +// in an UploadPartCopy operation. +// +// - If the source object that you want to copy is in a directory bucket, you +// must have the s3express:CreateSession permission in the Action element of a +// policy to read the object . By default, the session is in the ReadWrite mode. +// If you want to restrict the access, you can explicitly set the +// s3express:SessionMode condition key to ReadOnly on the copy source bucket. +// +// - If the copy destination is a directory bucket, you must have the +// s3express:CreateSession permission in the Action element of a policy to write +// the object to the destination. The s3express:SessionMode condition key cannot +// be set to ReadOnly on the copy destination. +// +// For example policies, see [Example bucket policies for S3 Express One Zone]and [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]in the Amazon S3 User Guide. // // Encryption -// - General purpose buckets - 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) -// . -// - Directory buckets - For directory buckets, only server-side encryption with -// Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. +// - General purpose buckets - +// +// For information about using server-side encryption with customer-provided +// +// encryption keys with the UploadPartCopy operation, see [CopyObject]and [UploadPart]. +// +// - Directory buckets - For directory buckets, only server-side encryption with +// Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. // // Special errors +// // - 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. +// // - HTTP Status Code: 404 Not Found +// // - Error Code: InvalidRequest +// // - Description: The specified copy source is not supported as a byte-range // copy source. +// // - HTTP Status Code: 400 Bad Request // -// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is -// Bucket_name.s3express-az_id.region.amazonaws.com . The following operations are -// related to UploadPartCopy : -// - 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) +// HTTP Host header syntax Directory buckets - The HTTP Host header syntax is +// Bucket_name.s3express-az_id.region.amazonaws.com . +// +// The following operations are related to UploadPartCopy : +// +// [CreateMultipartUpload] +// +// [UploadPart] +// +// [CompleteMultipartUpload] +// +// [AbortMultipartUpload] +// +// [ListParts] +// +// [ListMultipartUploads] +// +// [Uploading Objects Using Multipart Upload]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html +// [ListParts]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html +// [UploadPart]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html +// [Regional and Zonal endpoints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html +// [CompleteMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html +// [CreateMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html +// [Multipart upload limits]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html +// [Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html +// [AbortMultipartUpload]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html +// [REST Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html +// [Example bucket policies for S3 Express One Zone]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html +// [Operations on Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html +// [ListMultipartUploads]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html +// [Multipart Upload and Permissions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html +// +// [CopyObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html func (c *Client) UploadPartCopy(ctx context.Context, params *UploadPartCopyInput, optFns ...func(*Options)) (*UploadPartCopyOutput, error) { if params == nil { params = &UploadPartCopyInput{} @@ -119,43 +163,53 @@ func (c *Client) UploadPartCopy(ctx context.Context, params *UploadPartCopyInput type UploadPartCopyInput struct { - // The bucket name. Directory buckets - When you use this operation with a - // directory bucket, you must use virtual-hosted-style requests in the format + // The bucket name. + // + // Directory buckets - When you use this operation with a directory bucket, you + // must use virtual-hosted-style requests in the format // Bucket_name.s3express-az_id.region.amazonaws.com . Path-style requests are not // supported. Directory bucket names must be unique in the chosen Availability // Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for // example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3 ). For information about bucket - // naming restrictions, see Directory bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) - // in the Amazon S3 User Guide. Access points - When you use this action with 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 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. Access points and Object Lambda access points are - // not supported by directory buckets. S3 on Outposts - 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 + // naming restrictions, see [Directory bucket naming rules]in the Amazon S3 User Guide. + // + // Access points - When you use this action with 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 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]in the Amazon S3 User Guide. + // + // Access points and Object Lambda access points are not supported by directory + // buckets. + // + // S3 on Outposts - 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 // 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?]in the Amazon S3 User Guide. + // + // [Directory bucket naming rules]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html + // [What is S3 on Outposts?]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html + // [Using access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html // // 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) - // : + // through an [access point]: + // // - 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 @@ -163,28 +217,39 @@ type UploadPartCopyInput struct { // 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. - // - Access points are not supported by directory buckets. 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 + // + // - Access points are not supported by directory buckets. + // + // 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. + // // 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 source object to copy. To copy a specific version of the source object to // copy, append ?versionId= to the x-amz-copy-source request header (for example, // x-amz-copy-source: // /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893 - // ). If the current version is a delete marker and you don't specify a versionId - // in the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found - // error, because the object does not exist. If you specify versionId in the + // ). + // + // If the current version is a delete marker and you don't specify a versionId in + // the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found 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 Bad Request error, because you are not allowed to specify a delete - // marker as a version for the x-amz-copy-source . Directory buckets - S3 - // Versioning isn't enabled and supported for directory buckets. + // marker as a version for the x-amz-copy-source . + // + // Directory buckets - S3 Versioning isn't enabled and supported for directory + // buckets. + // + // [access point]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html // // This member is required. CopySource *string @@ -205,34 +270,56 @@ type UploadPartCopyInput struct { // This member is required. UploadId *string - // Copies the object if its entity tag (ETag) matches the specified tag. 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. + // Copies the object if its entity tag (ETag) matches the specified tag. + // + // 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. CopySourceIfMatch *string - // Copies the object if it has been modified since the specified time. 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. + // Copies the object if it has been modified since the specified time. + // + // 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. CopySourceIfModifiedSince *time.Time - // Copies the object if its entity tag (ETag) is different than the specified - // ETag. If both of the x-amz-copy-source-if-none-match and + // Copies the object if its entity tag (ETag) is different than the specified ETag. + // + // 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. + // 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. CopySourceIfNoneMatch *string - // Copies the object if it hasn't been modified since the specified time. 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. + // Copies the object if it hasn't been modified since the specified time. + // + // 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. CopySourceIfUnmodifiedSince *time.Time // The range of bytes to copy from the source object. The range value must use the @@ -243,20 +330,26 @@ type UploadPartCopyInput struct { CopySourceRange *string // Specifies the algorithm to use when decrypting the source object (for example, - // AES256 ). This functionality is not supported when the source object is in a - // directory bucket. + // AES256 ). + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceSSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use to decrypt // the source object. The encryption key provided in this header must be one that - // was used when the source object was created. This functionality is not supported - // when the source object is in a directory bucket. + // was used when the source object was created. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceSSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported when the source object is in a directory bucket. + // encryption key was transmitted without error. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceSSECustomerKeyMD5 *string // The account ID of the expected destination bucket owner. If the account ID that @@ -273,15 +366,18 @@ type UploadPartCopyInput struct { // Bucket owners need not specify this parameter in their requests. If either the // source or destination S3 bucket has Requester Pays enabled, the requester will // pay for corresponding charges to copy the object. 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 the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. + // downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets]in the Amazon S3 User + // Guide. + // + // This functionality is not supported for directory buckets. + // + // [Downloading Objects in Requester Pays Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html RequestPayer types.RequestPayer - // Specifies the algorithm to use when encrypting the object (for example, - // AES256). This functionality is not supported when the destination bucket is a - // directory bucket. + // Specifies the algorithm to use when encrypting the object (for example, AES256). + // + // This functionality is not supported when the destination bucket is a directory + // bucket. SSECustomerAlgorithm *string // Specifies the customer-provided encryption key for Amazon S3 to use in @@ -289,15 +385,18 @@ type UploadPartCopyInput struct { // 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 - // encryption key specified in the initiate multipart upload request. This - // functionality is not supported when the destination bucket is a directory + // encryption key specified in the initiate multipart upload request. + // + // This functionality is not supported when the destination bucket is a directory // bucket. SSECustomerKey *string // Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. // Amazon S3 uses this header for a message integrity check to ensure that the - // encryption key was transmitted without error. This functionality is not - // supported when the destination bucket is a directory bucket. + // encryption key was transmitted without error. + // + // This functionality is not supported when the destination bucket is a directory + // bucket. SSECustomerKeyMD5 *string noSmithyDocumentSerde @@ -311,42 +410,52 @@ func (in *UploadPartCopyInput) bindEndpointParams(p *EndpointParameters) { type UploadPartCopyOutput struct { // Indicates whether the multipart upload uses an S3 Bucket Key for server-side - // encryption with Key Management Service (KMS) keys (SSE-KMS). This functionality - // is not supported for directory buckets. + // encryption with Key Management Service (KMS) keys (SSE-KMS). + // + // This functionality is not supported for directory buckets. BucketKeyEnabled *bool // 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. This functionality is not supported when the - // source object is in a directory bucket. + // versioning on the source bucket. + // + // This functionality is not supported when the source object is in a directory + // bucket. CopySourceVersionId *string // If present, indicates that the requester was successfully charged for the - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to confirm the encryption - // algorithm that's used. This functionality is not supported for directory - // buckets. + // algorithm that's used. + // + // This functionality is not supported for directory buckets. SSECustomerAlgorithm *string // If server-side encryption with a customer-provided encryption key was // requested, the response will include this header to provide the round-trip - // message integrity verification of the customer-provided encryption key. This - // functionality is not supported for directory buckets. + // message integrity verification of the customer-provided encryption key. + // + // This functionality is not supported for directory buckets. SSECustomerKeyMD5 *string // If present, indicates the ID of the Key Management Service (KMS) symmetric - // encryption customer managed key that was used for the object. This functionality - // is not supported for directory buckets. + // encryption customer managed key that was used for the object. + // + // This functionality is not supported for directory buckets. SSEKMSKeyId *string // The server-side encryption algorithm used when you store this object in Amazon - // S3 (for example, AES256 , aws:kms ). For directory buckets, only server-side - // encryption with Amazon S3 managed keys (SSE-S3) ( AES256 ) is supported. + // S3 (for example, AES256 , aws:kms ). + // + // For directory buckets, only server-side encryption with Amazon S3 managed keys + // (SSE-S3) ( AES256 ) is supported. 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 e181ab71113..4dfa64e8ddc 100644 --- a/service/s3/api_op_WriteGetObjectResponse.go +++ b/service/s3/api_op_WriteGetObjectResponse.go @@ -18,42 +18,54 @@ import ( "time" ) -// This operation is not supported by directory buckets. 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) -// 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. +// This operation is not supported by directory buckets. +// +// 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]in the +// Amazon S3 User Guide. +// +// This operation supports metadata that can be returned by [GetObject], 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 // Amazon Web Services Serverless Application Repository, and can be selected // through the Amazon Web Services Management Console when you create your Object -// Lambda access point. Example 1: PII Access Control - This Lambda function uses -// Amazon Comprehend, a natural language processing (NLP) service using machine -// learning to find insights and relationships in text. It automatically detects -// personally identifiable information (PII) such as names, addresses, dates, -// credit card numbers, and social security numbers from documents in your Amazon -// S3 bucket. Example 2: PII Redaction - This Lambda function uses Amazon -// Comprehend, a natural language processing (NLP) service using machine learning -// to find insights and relationships in text. It automatically redacts personally +// Lambda access point. +// +// Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a +// natural language processing (NLP) service using machine learning to find +// insights and relationships in text. It automatically detects personally // identifiable information (PII) such as names, addresses, dates, credit card // numbers, and social security numbers from documents in your Amazon S3 bucket. +// +// Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a +// natural language processing (NLP) service using machine learning to find +// insights and relationships in text. It automatically redacts personally +// identifiable information (PII) such as names, addresses, dates, credit card +// numbers, and social security numbers from documents in your Amazon S3 bucket. +// // Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is // 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. +// 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] in the Amazon S3 +// User Guide. +// +// [Transforming objects with Object Lambda access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html +// [Using Amazon Web Services built Lambda functions]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html func (c *Client) WriteGetObjectResponse(ctx context.Context, params *WriteGetObjectResponseInput, optFns ...func(*Options)) (*WriteGetObjectResponseOutput, error) { if params == nil { params = &WriteGetObjectResponseInput{} @@ -88,7 +100,7 @@ type WriteGetObjectResponseInput struct { // The object data. Body io.Reader - // Indicates whether the object stored in Amazon S3 uses an S3 bucket key for + // Indicates whether the object stored in Amazon S3 uses an S3 bucket key for // server-side encryption with Amazon Web Services KMS (SSE-KMS). BucketKeyEnabled *bool @@ -101,9 +113,12 @@ 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) - // 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. + // about checksums, see [Checking object integrity]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. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumCRC32 *string // This header can be used as a data integrity check to verify that the data @@ -112,9 +127,12 @@ 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) - // 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. + // about checksums, see [Checking object integrity]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. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumCRC32C *string // This header can be used as a data integrity check to verify that the data @@ -123,9 +141,12 @@ 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) - // 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. + // checksums, see [Checking object integrity]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. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA1 *string // This header can be used as a data integrity check to verify that the data @@ -134,9 +155,12 @@ 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) - // 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. + // about checksums, see [Checking object integrity]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. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA256 *string // Specifies presentational information for the object. @@ -205,8 +229,9 @@ 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]. + // + // [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. @@ -216,12 +241,15 @@ type WriteGetObjectResponseInput struct { 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) - // . + // a Replication rule. For more information about S3 Replication, see [Replication]. + // + // [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 - // request. This functionality is not supported for directory buckets. + // request. + // + // This functionality is not supported for directory buckets. RequestCharged types.RequestCharged // Provides information about object restoration operation and expiration time of @@ -232,43 +260,59 @@ type WriteGetObjectResponseInput struct { // encryption key was specified for object stored in Amazon S3. SSECustomerAlgorithm *string - // 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) - // . + // 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)]. + // + // [Protecting data using 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 (Key ID, Key ARN, or Key Alias) of the Amazon Web + // If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web // Services Key Management Service (Amazon Web Services KMS) symmetric encryption // customer managed key that was used for stored in Amazon S3 object. SSEKMSKeyId *string - // The server-side encryption algorithm used when storing requested object in + // The server-side encryption algorithm used when storing requested object in // Amazon S3 (for example, AES256, aws:kms ). ServerSideEncryption types.ServerSideEncryption // The integer status code for an HTTP response of a corresponding GetObject // request. The following is a list of 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 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) - // . + // for all objects except for S3 Standard storage class objects. + // + // For more information, see [Storage Classes]. + // + // [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/options.go b/service/s3/options.go index 064bcefb4fd..c5ab084d120 100644 --- a/service/s3/options.go +++ b/service/s3/options.go @@ -65,8 +65,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -88,17 +90,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -141,8 +146,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -193,6 +199,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/s3/types/enums.go b/service/s3/types/enums.go index ea3b9c82acc..bcb956b2618 100644 --- a/service/s3/types/enums.go +++ b/service/s3/types/enums.go @@ -11,6 +11,7 @@ const ( // Values returns all known values for AnalyticsS3ExportFileFormat. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AnalyticsS3ExportFileFormat) Values() []AnalyticsS3ExportFileFormat { return []AnalyticsS3ExportFileFormat{ @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for ArchiveStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArchiveStatus) Values() []ArchiveStatus { return []ArchiveStatus{ "ARCHIVE_ACCESS", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for BucketAccelerateStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketAccelerateStatus) Values() []BucketAccelerateStatus { return []BucketAccelerateStatus{ "Enabled", @@ -65,8 +68,9 @@ const ( ) // Values returns all known values for BucketCannedACL. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketCannedACL) Values() []BucketCannedACL { return []BucketCannedACL{ "private", @@ -112,6 +116,7 @@ const ( // 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{ @@ -156,8 +161,9 @@ const ( ) // Values returns all known values for BucketLogsPermission. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketLogsPermission) Values() []BucketLogsPermission { return []BucketLogsPermission{ "FULL_CONTROL", @@ -174,8 +180,9 @@ const ( ) // Values returns all known values for BucketType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketType) Values() []BucketType { return []BucketType{ "Directory", @@ -191,8 +198,9 @@ const ( ) // Values returns all known values for BucketVersioningStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketVersioningStatus) Values() []BucketVersioningStatus { return []BucketVersioningStatus{ "Enabled", @@ -211,8 +219,9 @@ const ( ) // Values returns all known values for ChecksumAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChecksumAlgorithm) Values() []ChecksumAlgorithm { return []ChecksumAlgorithm{ "CRC32", @@ -230,8 +239,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -248,8 +258,9 @@ const ( ) // Values returns all known values for CompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionType) Values() []CompressionType { return []CompressionType{ "NONE", @@ -266,8 +277,9 @@ const ( ) // Values returns all known values for DataRedundancy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataRedundancy) Values() []DataRedundancy { return []DataRedundancy{ "SingleAvailabilityZone", @@ -284,8 +296,9 @@ const ( // Values returns all known values for DeleteMarkerReplicationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteMarkerReplicationStatus) Values() []DeleteMarkerReplicationStatus { return []DeleteMarkerReplicationStatus{ "Enabled", @@ -301,8 +314,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -343,8 +357,9 @@ const ( ) // 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. +// the future, and so 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{ "s3:ReducedRedundancyLostObject", @@ -387,8 +402,9 @@ const ( // Values returns all known values for ExistingObjectReplicationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExistingObjectReplicationStatus) Values() []ExistingObjectReplicationStatus { return []ExistingObjectReplicationStatus{ "Enabled", @@ -405,8 +421,9 @@ const ( ) // Values returns all known values for ExpirationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpirationStatus) Values() []ExpirationStatus { return []ExpirationStatus{ "Enabled", @@ -422,8 +439,9 @@ const ( ) // Values returns all known values for ExpressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpressionType) Values() []ExpressionType { return []ExpressionType{ "SQL", @@ -440,8 +458,9 @@ const ( ) // Values returns all known values for FileHeaderInfo. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileHeaderInfo) Values() []FileHeaderInfo { return []FileHeaderInfo{ "USE", @@ -459,8 +478,9 @@ const ( ) // Values returns all known values for FilterRuleName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterRuleName) Values() []FilterRuleName { return []FilterRuleName{ "prefix", @@ -478,8 +498,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntelligentTieringAccessTier) Values() []IntelligentTieringAccessTier { return []IntelligentTieringAccessTier{ "ARCHIVE_ACCESS", @@ -497,6 +518,7 @@ const ( // 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{ @@ -515,8 +537,9 @@ const ( ) // Values returns all known values for InventoryFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InventoryFormat) Values() []InventoryFormat { return []InventoryFormat{ "CSV", @@ -534,8 +557,9 @@ const ( ) // Values returns all known values for InventoryFrequency. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InventoryFrequency) Values() []InventoryFrequency { return []InventoryFrequency{ "Daily", @@ -553,8 +577,9 @@ const ( // Values returns all known values for InventoryIncludedObjectVersions. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InventoryIncludedObjectVersions) Values() []InventoryIncludedObjectVersions { return []InventoryIncludedObjectVersions{ "All", @@ -584,8 +609,9 @@ const ( ) // Values returns all known values for InventoryOptionalField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InventoryOptionalField) Values() []InventoryOptionalField { return []InventoryOptionalField{ "Size", @@ -615,8 +641,9 @@ const ( ) // Values returns all known values for JSONType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JSONType) Values() []JSONType { return []JSONType{ "DOCUMENT", @@ -632,8 +659,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "AvailabilityZone", @@ -649,8 +677,9 @@ const ( ) // Values returns all known values for MetadataDirective. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetadataDirective) Values() []MetadataDirective { return []MetadataDirective{ "COPY", @@ -667,8 +696,9 @@ const ( ) // Values returns all known values for MetricsStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricsStatus) Values() []MetricsStatus { return []MetricsStatus{ "Enabled", @@ -685,8 +715,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -703,8 +734,9 @@ const ( ) // Values returns all known values for MFADeleteStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MFADeleteStatus) Values() []MFADeleteStatus { return []MFADeleteStatus{ "Enabled", @@ -724,8 +756,9 @@ const ( ) // Values returns all known values for ObjectAttributes. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectAttributes) Values() []ObjectAttributes { return []ObjectAttributes{ "ETag", @@ -750,8 +783,9 @@ const ( ) // Values returns all known values for ObjectCannedACL. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectCannedACL) Values() []ObjectCannedACL { return []ObjectCannedACL{ "private", @@ -772,8 +806,9 @@ const ( ) // Values returns all known values for ObjectLockEnabled. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLockEnabled) Values() []ObjectLockEnabled { return []ObjectLockEnabled{ "Enabled", @@ -790,6 +825,7 @@ const ( // Values returns all known values for ObjectLockLegalHoldStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLockLegalHoldStatus) Values() []ObjectLockLegalHoldStatus { return []ObjectLockLegalHoldStatus{ @@ -807,8 +843,9 @@ const ( ) // Values returns all known values for ObjectLockMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLockMode) Values() []ObjectLockMode { return []ObjectLockMode{ "GOVERNANCE", @@ -825,8 +862,9 @@ const ( ) // Values returns all known values for ObjectLockRetentionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLockRetentionMode) Values() []ObjectLockRetentionMode { return []ObjectLockRetentionMode{ "GOVERNANCE", @@ -844,8 +882,9 @@ const ( ) // Values returns all known values for ObjectOwnership. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectOwnership) Values() []ObjectOwnership { return []ObjectOwnership{ "BucketOwnerPreferred", @@ -872,8 +911,9 @@ const ( ) // Values returns all known values for ObjectStorageClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectStorageClass) Values() []ObjectStorageClass { return []ObjectStorageClass{ "STANDARD", @@ -899,6 +939,7 @@ const ( // Values returns all known values for ObjectVersionStorageClass. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ObjectVersionStorageClass) Values() []ObjectVersionStorageClass { return []ObjectVersionStorageClass{ @@ -915,6 +956,7 @@ const ( // Values returns all known values for OptionalObjectAttributes. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OptionalObjectAttributes) Values() []OptionalObjectAttributes { return []OptionalObjectAttributes{ @@ -930,8 +972,9 @@ const ( ) // Values returns all known values for OwnerOverride. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OwnerOverride) Values() []OwnerOverride { return []OwnerOverride{ "Destination", @@ -947,8 +990,9 @@ const ( ) // Values returns all known values for PartitionDateSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartitionDateSource) Values() []PartitionDateSource { return []PartitionDateSource{ "EventTime", @@ -965,8 +1009,9 @@ const ( ) // 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. +// the future, and so 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{ "Requester", @@ -986,8 +1031,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "FULL_CONTROL", @@ -1007,8 +1053,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "http", @@ -1025,8 +1072,9 @@ const ( ) // Values returns all known values for QuoteFields. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuoteFields) Values() []QuoteFields { return []QuoteFields{ "ALWAYS", @@ -1044,6 +1092,7 @@ const ( // Values returns all known values for ReplicaModificationsStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReplicaModificationsStatus) Values() []ReplicaModificationsStatus { return []ReplicaModificationsStatus{ @@ -1061,8 +1110,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Enabled", @@ -1082,8 +1132,9 @@ const ( ) // Values returns all known values for ReplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStatus) Values() []ReplicationStatus { return []ReplicationStatus{ "COMPLETE", @@ -1103,8 +1154,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Enabled", @@ -1120,8 +1172,9 @@ const ( ) // Values returns all known values for RequestCharged. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestCharged) Values() []RequestCharged { return []RequestCharged{ "requester", @@ -1136,8 +1189,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1152,8 +1206,9 @@ const ( ) // Values returns all known values for RestoreRequestType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RestoreRequestType) Values() []RestoreRequestType { return []RestoreRequestType{ "SELECT", @@ -1170,8 +1225,9 @@ const ( ) // Values returns all known values for ServerSideEncryption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerSideEncryption) Values() []ServerSideEncryption { return []ServerSideEncryption{ "AES256", @@ -1189,8 +1245,9 @@ const ( ) // Values returns all known values for SessionMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionMode) Values() []SessionMode { return []SessionMode{ "ReadOnly", @@ -1208,8 +1265,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SseKmsEncryptedObjectsStatus) Values() []SseKmsEncryptedObjectsStatus { return []SseKmsEncryptedObjectsStatus{ "Enabled", @@ -1235,8 +1293,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1262,8 +1321,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageClassAnalysisSchemaVersion) Values() []StorageClassAnalysisSchemaVersion { return []StorageClassAnalysisSchemaVersion{ "V_1", @@ -1279,8 +1339,9 @@ const ( ) // Values returns all known values for TaggingDirective. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaggingDirective) Values() []TaggingDirective { return []TaggingDirective{ "COPY", @@ -1298,8 +1359,9 @@ const ( ) // Values returns all known values for Tier. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tier) Values() []Tier { return []Tier{ "Standard", @@ -1321,8 +1383,9 @@ const ( ) // Values returns all known values for TransitionStorageClass. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitionStorageClass) Values() []TransitionStorageClass { return []TransitionStorageClass{ "GLACIER", @@ -1344,8 +1407,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "CanonicalUser", diff --git a/service/s3/types/errors.go b/service/s3/types/errors.go index 166484f4ec2..a01b922f73a 100644 --- a/service/s3/types/errors.go +++ b/service/s3/types/errors.go @@ -64,14 +64,17 @@ func (e *BucketAlreadyOwnedByYou) ErrorCode() string { } func (e *BucketAlreadyOwnedByYou) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Object is archived and inaccessible until restored. If the object you are -// retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 -// Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access -// tier, or the S3 Intelligent-Tiering Deep Archive Access tier, 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 operation 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) -// in the Amazon S3 User Guide. +// Object is archived and inaccessible until restored. +// +// If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval +// storage class, the S3 Glacier Deep Archive storage class, the S3 +// Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep +// Archive Access tier, before you can retrieve the object you must first restore a +// copy using [RestoreObject]. Otherwise, this operation returns an InvalidObjectState error. For +// information about restoring archived objects, see [Restoring Archived Objects]in the Amazon S3 User Guide. +// +// [RestoreObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html +// [Restoring Archived Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html type InvalidObjectState struct { Message *string diff --git a/service/s3/types/types.go b/service/s3/types/types.go index 4299b57cc68..08225e62f27 100644 --- a/service/s3/types/types.go +++ b/service/s3/types/types.go @@ -9,9 +9,9 @@ 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 Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) -// in the Amazon S3 User Guide. +// more information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration]in the Amazon S3 User Guide. +// +// [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 type AbortIncompleteMultipartUpload struct { // Specifies the number of days after which Amazon S3 aborts an incomplete @@ -22,8 +22,9 @@ 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]in the Amazon S3 User Guide. +// +// [Amazon S3 Transfer Acceleration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html type AccelerateConfiguration struct { // Specifies the transfer acceleration status of the bucket. @@ -47,9 +48,10 @@ type AccessControlPolicy struct { // A container for information about access control for replicas. 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) - // in the Amazon S3 API Reference. + // Specifies the replica ownership. For default and valid values, see [PUT bucket replication] in the + // Amazon S3 API Reference. + // + // [PUT bucket replication]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html // // This member is required. Owner OwnerOverride @@ -82,7 +84,7 @@ type AnalyticsConfiguration struct { // This member is required. Id *string - // Contains data related to access patterns to be collected and made available to + // Contains data related to access patterns to be collected and made available to // analyze the tradeoffs between different storage classes. // // This member is required. @@ -162,9 +164,10 @@ type AnalyticsS3BucketDestination struct { Format AnalyticsS3ExportFileFormat // The account ID that owns the destination S3 bucket. If no account ID is - // provided, the owner is not validated before exporting data. Although this value - // is optional, we strongly recommend that you set it to help prevent problems if - // the destination bucket ownership changes. + // provided, the owner is not validated before exporting data. + // + // Although this value is optional, we strongly recommend that you set it to help + // prevent problems if the destination bucket ownership changes. BucketAccountId *string // The prefix to use when exporting data. The prefix is prepended to all results. @@ -187,9 +190,11 @@ type Bucket struct { } // Specifies the information about the bucket that will be created. For more -// information about directory buckets, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) -// in the Amazon S3 User Guide. This functionality is only supported by directory -// buckets. +// information about directory buckets, see [Directory buckets]in the Amazon S3 User Guide. +// +// This functionality is only supported by directory buckets. +// +// [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html type BucketInfo struct { // The number of Availability Zone that's used for redundancy for the bucket. @@ -202,8 +207,9 @@ type BucketInfo 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]in the Amazon S3 User Guide. +// +// [Object Lifecycle Management]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html type BucketLifecycleConfiguration struct { // A lifecycle rule for individual objects in an Amazon S3 bucket. @@ -218,8 +224,10 @@ type BucketLifecycleConfiguration struct { 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. + // log object keys for a bucket. For more information, see [PUT Bucket logging]in the Amazon S3 API + // Reference. + // + // [PUT Bucket logging]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html LoggingEnabled *LoggingEnabled noSmithyDocumentSerde @@ -233,8 +241,10 @@ type Checksum struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -242,8 +252,10 @@ type Checksum struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -251,8 +263,10 @@ type Checksum struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -260,8 +274,10 @@ type Checksum struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string noSmithyDocumentSerde @@ -283,8 +299,10 @@ type CommonPrefix struct { // The container for the completed multipart upload details. type CompletedMultipartUpload struct { - // Array of CompletedPart data types. If you do not supply a valid Part with your - // request, the service sends back an HTTP 400 response. + // Array of CompletedPart data types. + // + // If you do not supply a valid Part with your request, the service sends back an + // HTTP 400 response. Parts []CompletedPart noSmithyDocumentSerde @@ -298,8 +316,10 @@ type CompletedPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -307,8 +327,10 @@ type CompletedPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -316,8 +338,10 @@ type CompletedPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -325,8 +349,10 @@ type CompletedPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string // Entity tag returned when the part was uploaded. @@ -334,12 +360,14 @@ type CompletedPart struct { // Part number that identifies the part. This is a positive integer between 1 and // 10,000. + // // - General purpose buckets - In CompleteMultipartUpload , when a additional // checksum (including x-amz-checksum-crc32 , x-amz-checksum-crc32c , // x-amz-checksum-sha1 , or x-amz-checksum-sha256 ) is applied to each part, the // PartNumber must start at 1 and the part numbers must be consecutive. // Otherwise, Amazon S3 generates an HTTP 400 Bad Request status code and an // InvalidPartOrder error code. + // // - Directory buckets - In CompleteMultipartUpload , the PartNumber must start // at 1 and the part numbers must be consecutive. PartNumber *int32 @@ -366,10 +394,12 @@ type Condition struct { // 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) - // . + // 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]. + // + // [XML related object key constraints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints KeyPrefixEquals *string noSmithyDocumentSerde @@ -383,27 +413,31 @@ type ContinuationEvent struct { 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. 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be - // present if it was uploaded with 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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. 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html 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. 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. + // present if it was uploaded with the object. For more information, see [Checking object integrity]in the + // Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA256 *string // Returns the ETag of the new object. The ETag reflects only changes to the @@ -424,8 +458,10 @@ type CopyPartResult struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -433,8 +469,10 @@ type CopyPartResult struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -442,8 +480,10 @@ type CopyPartResult struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -451,8 +491,10 @@ type CopyPartResult struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string // Entity tag of the object. @@ -465,8 +507,9 @@ 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]in the Amazon S3 User Guide. +// +// [Enabling Cross-Origin Resource Sharing]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html type CORSConfiguration struct { // A set of origins and methods (cross-origin access that you want to allow). You @@ -515,23 +558,30 @@ type CORSRule struct { // The configuration information for the bucket. type CreateBucketConfiguration struct { - // Specifies the information about the bucket that will be created. This - // functionality is only supported by directory buckets. + // Specifies the information about the bucket that will be created. + // + // This functionality is only supported by directory buckets. Bucket *BucketInfo - // Specifies the location where the bucket will be created. For directory buckets, - // the location type is Availability Zone. This functionality is only supported by - // directory buckets. + // Specifies the location where the bucket will be created. + // + // For directory buckets, the location type is Availability Zone. + // + // This functionality is only supported by directory buckets. Location *LocationInfo // Specifies the Region where the bucket will be created. 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) - // in the Amazon S3 User Guide. If you don't specify a Region, the bucket is - // created in the US East (N. Virginia) Region (us-east-1) by default. This - // functionality is not supported for directory buckets. + // create buckets in the Europe (Ireland) Region. For more information, see [Accessing a bucket]in the + // Amazon S3 User Guide. + // + // If you don't specify a Region, the bucket is created in the US East (N. + // Virginia) Region (us-east-1) by default. + // + // This functionality is not supported for directory buckets. + // + // [Accessing a bucket]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro LocationConstraint BucketLocationConstraint noSmithyDocumentSerde @@ -548,7 +598,9 @@ 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 @@ -556,17 +608,26 @@ 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 ). 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 + // 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 @@ -599,7 +660,9 @@ 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. QuoteFields QuoteFields @@ -612,7 +675,9 @@ 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. type DefaultRetention struct { @@ -635,10 +700,12 @@ type DefaultRetention struct { // Container for the objects to delete. type Delete struct { - // The object to delete. Directory buckets - For directory buckets, an object - // that's composed entirely of whitespace characters is not supported by the - // DeleteObjects API operation. The request will receive a 400 Bad Request error - // and none of the objects in the request will be deleted. + // The object to delete. + // + // Directory buckets - For directory buckets, an object that's composed entirely + // of whitespace characters is not supported by the DeleteObjects API operation. + // The request will receive a 400 Bad Request error and none of the objects in the + // request will be deleted. // // This member is required. Objects []ObjectIdentifier @@ -656,21 +723,24 @@ type DeletedObject struct { // Indicates whether the specified object version that was permanently deleted was // (true) or was not (false) a delete marker before deletion. In a simple DELETE, // this header indicates whether (true) or not (false) the current version of the - // object is a delete marker. This functionality is not supported for directory - // buckets. + // object is a delete marker. + // + // This functionality is not supported for directory buckets. 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. This functionality is - // not supported for directory buckets. + // header is the version ID of the object version deleted. + // + // This functionality is not supported for directory buckets. DeleteMarkerVersionId *string // The name of the deleted object. Key *string - // The version ID of the deleted object. This functionality is not supported for - // directory buckets. + // The version ID of the deleted object. + // + // This functionality is not supported for directory buckets. VersionId *string noSmithyDocumentSerde @@ -703,17 +773,20 @@ type DeleteMarkerEntry struct { // DeleteMarkerReplication element. If your Filter includes a Tag element, the // 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]. +// +// For more information about delete marker replication, see [Basic Rule Configuration]. +// +// 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]. +// +// [Basic Rule Configuration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html +// [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 - // delete markers. + // Indicates whether to replicate delete markers. + // + // Indicates whether to replicate delete markers. Status DeleteMarkerReplicationStatus noSmithyDocumentSerde @@ -723,7 +796,7 @@ type DeleteMarkerReplication struct { // for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). type Destination struct { - // The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store + // The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store // the results. // // This member is required. @@ -740,29 +813,32 @@ type Destination struct { // 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) - // in the Amazon S3 User Guide. + // information, see [Replication Additional Configuration: Changing the Replica Owner]in the Amazon S3 User Guide. + // + // [Replication Additional Configuration: Changing the Replica Owner]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html Account *string // A container that provides information about encryption. If // SourceSelectionCriteria is specified, you must specify this element. EncryptionConfiguration *EncryptionConfiguration - // A container specifying replication metrics-related settings enabling + // 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 + // A container specifying S3 Replication Time Control (S3 RTC), 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. ReplicationTime *ReplicationTime - // The storage class to use when replicating objects, such as S3 Standard or + // 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) - // action in the Amazon S3 API Reference. + // object to create the object replica. + // + // For valid values, see the StorageClass element of the [PUT Bucket replication] action in the Amazon S3 + // API Reference. + // + // [PUT Bucket replication]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html StorageClass StorageClass noSmithyDocumentSerde @@ -784,8 +860,9 @@ type Encryption struct { // 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 KMS (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) - // in the Amazon Web Services Key Management Service Developer Guide. + // [Asymmetric keys in KMS]in the Amazon Web Services Key Management Service Developer Guide. + // + // [Asymmetric keys in KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html KMSKeyId *string noSmithyDocumentSerde @@ -799,8 +876,9 @@ 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) - // in the Amazon Web Services Key Management Service Developer Guide. + // [Asymmetric keys in Amazon Web Services KMS]in the Amazon Web Services Key Management Service Developer Guide. + // + // [Asymmetric keys in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html ReplicaKmsKeyID *string noSmithyDocumentSerde @@ -819,414 +897,766 @@ 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. The following is a list of Amazon S3 error codes. For more information, - // see Error responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) - // . + // see [Error responses]. + // // - 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) - // . + // information about Regions, see [How to Select a Region for Your Buckets]. + // // - 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. + // + // - 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. + // + // - 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) + // [Amazon 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. + // signing method. For more information, see [REST Authentication]and [SOAP Authentication]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 + // + // [How to Select a Region for Your Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro + // [Error responses]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html + // [REST Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + // [Amazon S3]: http://aws.amazon.com/s3 + // [SOAP Authentication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html Code *string // The error key. @@ -1240,8 +1670,9 @@ type Error struct { // error message. Message *string - // The version ID of the error. This functionality is not supported for directory - // buckets. + // The version ID of the error. + // + // This functionality is not supported for directory buckets. VersionId *string noSmithyDocumentSerde @@ -1250,11 +1681,12 @@ type Error struct { // The error information. 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) - // . + // 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]. + // + // [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 @@ -1268,8 +1700,9 @@ 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) -// in the Amazon S3 User Guide. +// information, see [Replicating Existing Objects]in the Amazon S3 User Guide. +// +// [Replicating Existing Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication type ExistingObjectReplication struct { // Specifies whether Amazon S3 replicates existing source bucket objects. @@ -1293,9 +1726,10 @@ 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. + // prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications]in the + // Amazon S3 User Guide. + // + // [Configuring Event Notifications]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html Name FilterRuleName // The value that the filter searches for in object key names. @@ -1325,10 +1759,12 @@ type GetObjectAttributesParts struct { // A container for elements related to a particular part. A response can contain // zero or more Parts elements. + // // - General purpose buckets - For GetObjectAttributes , if a additional checksum // (including x-amz-checksum-crc32 , x-amz-checksum-crc32c , x-amz-checksum-sha1 // , or x-amz-checksum-sha256 ) isn't applied to the object specified in the // request, the response doesn't return Part . + // // - Directory buckets - For GetObjectAttributes , no matter whether a additional // checksum is applied to the object specified in the request, the response returns // Part . @@ -1374,19 +1810,31 @@ 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: + // 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. + // + // For a list of all the Amazon S3 supported Regions and endpoints, see [Regions and Endpoints] in the + // Amazon Web Services General Reference. + // + // [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region EmailAddress *string // The canonical user ID of the grantee. @@ -1405,10 +1853,12 @@ type IndexDocument struct { // endpoint (for example,if the suffix is index.html and you make a request to // samplebucket/images/ the data that is returned will be for the object with the // 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) - // . + // 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]. + // + // [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 @@ -1419,12 +1869,14 @@ type IndexDocument struct { // Container element that identifies who initiated the multipart upload. type Initiator struct { - // Name of the Principal. This functionality is not supported for directory - // buckets. + // Name of the Principal. + // + // This functionality is not supported for directory buckets. DisplayName *string // If the principal is an Amazon Web Services account, it provides the Canonical // User ID. If the principal is an IAM User, it provides a user ARN value. + // // Directory buckets - If the principal is an Amazon Web Services account, it // provides the Amazon Web Services account ID. If the principal is an IAM User, it // provides a user ARN value. @@ -1467,10 +1919,11 @@ type IntelligentTieringAndOperator struct { noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [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 type IntelligentTieringConfiguration struct { // The ID used to identify the S3 Intelligent-Tiering configuration. @@ -1505,10 +1958,12 @@ type IntelligentTieringFilter struct { 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) - // . + // 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]. + // + // [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. @@ -1518,8 +1973,9 @@ 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) -// in the Amazon S3 API Reference. +// information, see [GET Bucket inventory]in the Amazon S3 API Reference. +// +// [GET Bucket inventory]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html type InventoryConfiguration struct { // Contains information about where to publish the inventory results. @@ -1614,9 +2070,10 @@ type InventoryS3BucketDestination struct { Format InventoryFormat // The account ID that owns the destination S3 bucket. If no account ID is - // provided, the owner is not validated before exporting data. Although this value - // is optional, we strongly recommend that you set it to help prevent problems if - // the destination bucket ownership changes. + // provided, the owner is not validated before exporting data. + // + // Although this value is optional, we strongly recommend that you set it to help + // prevent problems if the destination bucket ownership changes. AccountId *string // Contains the type of server-side encryption used to encrypt the inventory @@ -1663,8 +2120,9 @@ 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]in the Amazon S3 User Guide. + // + // [Supported Event Types]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html // // This member is required. Events []Event @@ -1676,8 +2134,9 @@ type LambdaFunctionConfiguration struct { LambdaFunctionArn *string // Specifies object key name filtering rules. For information about key name - // filtering, see Configuring event notifications using object key name filtering (https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) - // in the Amazon S3 User Guide. + // filtering, see [Configuring event notifications using object key name filtering]in the Amazon S3 User Guide. + // + // [Configuring event notifications using object key name filtering]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html Filter *NotificationConfigurationFilter // An optional unique identifier for configurations in a notification @@ -1687,9 +2146,11 @@ type LambdaFunctionConfiguration struct { noSmithyDocumentSerde } -// 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) -// in the Amazon S3 User Guide. +// Container for the expiration for the lifecycle of the object. +// +// For more information see, [Managing your storage lifecycle] in the Amazon S3 User Guide. +// +// [Managing your storage lifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html type LifecycleExpiration struct { // Indicates at what date the object is to be moved or deleted. The date value @@ -1709,9 +2170,11 @@ type LifecycleExpiration struct { noSmithyDocumentSerde } -// 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) -// in the Amazon S3 User Guide. +// A lifecycle rule for individual objects in an Amazon S3 bucket. +// +// For more information see, [Managing your storage lifecycle] in the Amazon S3 User Guide. +// +// [Managing your storage lifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html type LifecycleRule struct { // If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is @@ -1722,9 +2185,9 @@ 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 Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) - // in the Amazon S3 User Guide. + // more information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration]in the Amazon S3 User Guide. + // + // [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 AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload // Specifies the expiration for the lifecycle of the object in the form of date, @@ -1746,7 +2209,7 @@ type LifecycleRule struct { // the object's lifetime. NoncurrentVersionExpiration *NoncurrentVersionExpiration - // Specifies the transition rule for the lifecycle rule that describes when + // Specifies the transition rule for the lifecycle rule that describes when // noncurrent objects transition to a specific 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 a specific @@ -1754,10 +2217,12 @@ type LifecycleRule struct { NoncurrentVersionTransitions []NoncurrentVersionTransition // 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) - // . + // 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]. + // + // [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 @@ -1834,11 +2299,12 @@ type LifecycleRuleFilterMemberObjectSizeLessThan struct { 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) -// . +// 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]. +// +// [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 @@ -1856,16 +2322,21 @@ type LifecycleRuleFilterMemberTag struct { func (*LifecycleRuleFilterMemberTag) isLifecycleRuleFilter() {} -// Specifies the location where the bucket will be created. For directory buckets, -// the location type is Availability Zone. For more information about directory -// buckets, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) -// in the Amazon S3 User Guide. This functionality is only supported by directory -// buckets. +// Specifies the location where the bucket will be created. +// +// For directory buckets, the location type is Availability Zone. For more +// information about directory buckets, see [Directory buckets]in the Amazon S3 User Guide. +// +// This functionality is only supported by directory buckets. +// +// [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html type LocationInfo struct { - // The name of the location where the bucket will be created. For directory - // buckets, the name of the location is the AZ ID of the Availability Zone where - // the bucket will be created. An example AZ ID value is usw2-az1 . + // The name of the location where the bucket will be created. + // + // For directory buckets, the name of the location is the AZ ID of the + // Availability Zone where the bucket will be created. An example AZ ID value is + // usw2-az1 . Name *string // The type of location where the bucket will be created. @@ -1875,8 +2346,10 @@ type LocationInfo 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. +// log object keys for a bucket. For more information, see [PUT Bucket logging]in the Amazon S3 API +// Reference. +// +// [PUT Bucket logging]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html type LoggingEnabled struct { // Specifies the bucket where you want Amazon S3 to store server access logs. You @@ -1896,10 +2369,12 @@ type LoggingEnabled struct { // 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) - // in the Amazon S3 User Guide. + // 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]in the Amazon S3 User Guide. + // + // [Permissions for server access log delivery]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general TargetGrants []TargetGrant // Amazon S3 key format for log objects. @@ -1920,16 +2395,17 @@ type MetadataEntry struct { noSmithyDocumentSerde } -// A container specifying replication metrics-related settings enabling +// A container specifying replication metrics-related settings enabling +// // replication metrics and events. type Metrics struct { - // Specifies whether the replication metrics are enabled. + // Specifies whether the replication metrics are enabled. // // This member is required. Status MetricsStatus - // A container specifying the time threshold for emitting the + // A container specifying the time threshold for emitting the // s3:Replication:OperationMissedThreshold event. EventThreshold *ReplicationTimeValue @@ -1957,8 +2433,9 @@ 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]. +// +// [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 @@ -1978,8 +2455,7 @@ 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]. // // The following types satisfy this interface: // @@ -1987,6 +2463,8 @@ type MetricsConfiguration struct { // MetricsFilterMemberAnd // MetricsFilterMemberPrefix // MetricsFilterMemberTag +// +// [PutBucketMetricsConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html type MetricsFilter interface { isMetricsFilter() } @@ -2045,13 +2523,15 @@ type MultipartUpload struct { Key *string // Specifies the owner of the object that is part of the multipart upload. - // Directory buckets - The bucket owner is returned as the object owner for all the - // objects. + // + // Directory buckets - The bucket owner is returned as the object owner for all + // the objects. Owner *Owner - // The class of storage used to store the object. Directory buckets - Only the S3 - // Express One Zone storage class is supported by directory buckets to store - // objects. + // The class of storage used to store the object. + // + // Directory buckets - Only the S3 Express One Zone storage class is supported by + // directory buckets to store objects. StorageClass StorageClass // Upload ID that identifies the multipart upload. @@ -2070,15 +2550,17 @@ type NoncurrentVersionExpiration struct { // Specifies how many newer noncurrent versions must exist before Amazon S3 can // perform the associated action on a given version. 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) - // in the Amazon S3 User Guide. + // information about noncurrent versions, see [Lifecycle configuration elements]in the Amazon S3 User Guide. + // + // [Lifecycle configuration elements]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html 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) - // in the Amazon S3 User Guide. + // For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent]in the Amazon S3 + // User Guide. + // + // [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 NoncurrentDays *int32 noSmithyDocumentSerde @@ -2096,15 +2578,16 @@ type NoncurrentVersionTransition struct { // Specifies how many newer noncurrent versions must exist before Amazon S3 can // perform the associated action on a given version. 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) - // in the Amazon S3 User Guide. + // information about noncurrent versions, see [Lifecycle configuration elements]in the Amazon S3 User Guide. + // + // [Lifecycle configuration elements]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html 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) - // in the Amazon S3 User Guide. + // calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent]in the Amazon S3 User Guide. + // + // [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 NoncurrentDays *int32 // The class of storage used to store the object. @@ -2136,8 +2619,9 @@ type NotificationConfiguration struct { } // Specifies object key name filtering rules. For information about key name -// filtering, see Configuring event notifications using object key name filtering (https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) -// in the Amazon S3 User Guide. +// filtering, see [Configuring event notifications using object key name filtering]in the Amazon S3 User Guide. +// +// [Configuring event notifications using object key name filtering]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html type NotificationConfigurationFilter struct { // A container for object key name prefix and suffix filtering rules. @@ -2156,17 +2640,21 @@ 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. + // // Directory buckets - MD5 is not supported by directory buckets. ETag *string @@ -2177,25 +2665,29 @@ type Object struct { // Creation date of the object. LastModified *time.Time - // The owner of the object Directory buckets - The bucket owner is returned as the - // object owner. + // The owner of the object + // + // Directory buckets - The bucket owner is returned as the object owner. Owner *Owner // Specifies the restoration status of an object. Objects in certain storage // classes must be restored before they can be retrieved. For more information - // about these storage classes and how to work with archived objects, see Working - // with archived objects (https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. Only the S3 Express One Zone storage class is supported by directory - // buckets to store objects. + // about these storage classes and how to work with archived objects, see [Working with archived objects]in the + // Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. Only the S3 Express + // One Zone storage class is supported by directory buckets to store objects. + // + // [Working with archived objects]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html RestoreStatus *RestoreStatus // Size in bytes of the object Size *int64 - // The class of storage used to store the object. Directory buckets - Only the S3 - // Express One Zone storage class is supported by directory buckets to store - // objects. + // The class of storage used to store the object. + // + // Directory buckets - Only the S3 Express One Zone storage class is supported by + // directory buckets to store objects. StorageClass ObjectStorageClass noSmithyDocumentSerde @@ -2204,16 +2696,19 @@ type Object struct { // Object Identifier is unique value to identify objects. 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) - // . + // 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]. + // + // [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 - // Version ID for the specific version of the object to delete. This functionality - // is not supported for directory buckets. + // Version ID for the specific version of the object to delete. + // + // This functionality is not supported for directory buckets. VersionId *string noSmithyDocumentSerde @@ -2273,9 +2768,10 @@ 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) + // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -2283,8 +2779,10 @@ type ObjectPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -2292,8 +2790,10 @@ type ObjectPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA1 *string // The base64-encoded, 256-bit SHA-256 digest of the object. This will only be @@ -2301,8 +2801,10 @@ type ObjectPart struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumSHA256 *string // The part number identifying the part. This value is a positive integer between @@ -2339,9 +2841,10 @@ type ObjectVersion struct { // Specifies the restoration status of an object. Objects in certain storage // classes must be restored before they can be retrieved. For more information - // about these storage classes and how to work with archived objects, see Working - // with archived objects (https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) - // in the Amazon S3 User Guide. + // about these storage classes and how to work with archived objects, see [Working with archived objects]in the + // Amazon S3 User Guide. + // + // [Working with archived objects]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html RestoreStatus *RestoreStatus // Size in bytes of the object. @@ -2382,14 +2885,23 @@ 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) + // // This functionality is not supported for directory buckets. DisplayName *string @@ -2414,23 +2926,30 @@ type OwnershipControls struct { type OwnershipControlsRule struct { // The container element for object ownership for a bucket's ownership controls. + // // BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the // bucket owner if the objects are uploaded with the bucket-owner-full-control - // canned ACL. ObjectWriter - The uploading account will own the object if the - // object is uploaded with the bucket-owner-full-control canned ACL. + // canned ACL. + // + // ObjectWriter - The uploading account will own the object if the object is + // uploaded with the bucket-owner-full-control canned ACL. + // // BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer // affect permissions. The bucket owner automatically owns and has full control // over every object in the bucket. The bucket only accepts PUT requests that don't // specify an ACL or specify bucket owner full control ACLs (such as the predefined // bucket-owner-full-control canned ACL or a custom ACL in XML format that grants - // the same permissions). By default, ObjectOwnership is set to BucketOwnerEnforced - // and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon - // use cases where you must control access for each object individually. For more - // information about S3 Object Ownership, see Controlling ownership of objects and - // disabling ACLs for your bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) - // in the Amazon S3 User Guide. This functionality is not supported for directory - // buckets. Directory buckets use the bucket owner enforced setting for S3 Object - // Ownership. + // the same permissions). + // + // By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are + // disabled. We recommend keeping ACLs disabled, except in uncommon use cases where + // you must control access for each object individually. For more information about + // S3 Object Ownership, see [Controlling ownership of objects and disabling ACLs for your bucket]in the Amazon S3 User Guide. + // + // This functionality is not supported for directory buckets. Directory buckets + // use the bucket owner enforced setting for S3 Object Ownership. + // + // [Controlling ownership of objects and disabling ACLs for your bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html // // This member is required. ObjectOwnership ObjectOwnership @@ -2448,9 +2967,10 @@ 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) + // base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumCRC32 *string // The base64-encoded, 32-bit CRC32C checksum of the object. This will only be @@ -2458,8 +2978,10 @@ type Part struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums ChecksumCRC32C *string // The base64-encoded, 160-bit SHA-1 digest of the object. This will only be @@ -2467,15 +2989,18 @@ type Part struct { // object that was uploaded using multipart uploads, this value may not be a direct // checksum value of the full object. Instead, it's a calculation based on the // checksum values of each individual part. 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) - // in the Amazon S3 User Guide. + // checksums are calculated with multipart uploads, see [Checking object integrity]in the Amazon S3 User + // Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums 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) + // base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] // in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumSHA256 *string // Entity tag returned when the part was uploaded. @@ -2495,7 +3020,9 @@ type Part struct { } // Amazon S3 keys for log objects are partitioned in the following format: -// [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString] +// +// [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString] +// // PartitionedPrefix defaults to EventTime delivery when server access logs are // delivered. type PartitionedPrefix struct { @@ -2543,41 +3070,48 @@ 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) -// in the Amazon S3 User Guide. +// information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"]in +// the Amazon S3 User Guide. +// +// [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 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 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 - // setting doesn't affect existing bucket policies. + // Bucket policy if the specified bucket policy allows public access. + // + // Enabling this setting doesn't affect existing bucket policies. BlockPublicPolicy *bool // Specifies whether Amazon S3 should ignore public ACLs for this bucket and // objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore - // all public ACLs on this bucket and objects in this bucket. Enabling this setting - // doesn't affect the persistence of any existing ACLs and doesn't prevent new - // public ACLs from being set. + // all public ACLs on this bucket and objects in this bucket. + // + // Enabling this setting doesn't affect the persistence of any existing ACLs and + // doesn't prevent new public ACLs from being set. IgnorePublicAcls *bool // Specifies whether Amazon S3 should restrict public bucket policies for this // bucket. Setting this element to TRUE restricts access to this bucket to only // Amazon Web Service principals and authorized users within this account if the - // bucket has a public policy. Enabling this setting doesn't affect previously - // stored bucket policies, except that public and cross-account access within any - // public bucket policy, including non-public delegation to specific accounts, is - // blocked. + // bucket has a public policy. + // + // Enabling this setting doesn't affect previously stored bucket policies, except + // that public and cross-account access within any public bucket policy, including + // non-public delegation to specific accounts, is blocked. RestrictPublicBuckets *bool noSmithyDocumentSerde @@ -2599,8 +3133,9 @@ type QueueConfiguration struct { QueueArn *string // Specifies object key name filtering rules. For information about key name - // filtering, see Configuring event notifications using object key name filtering (https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) - // in the Amazon S3 User Guide. + // filtering, see [Configuring event notifications using object key name filtering]in the Amazon S3 User Guide. + // + // [Configuring event notifications using object key name filtering]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html Filter *NotificationConfigurationFilter // An optional unique identifier for configurations in a notification @@ -2639,18 +3174,22 @@ type Redirect struct { // 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) - // . + // 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]. + // + // [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 - // 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) - // . + // 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]. + // + // [XML related object key constraints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints ReplaceKeyWith *string noSmithyDocumentSerde @@ -2676,9 +3215,11 @@ type RedirectAllRequestsTo struct { // 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. +// 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. @@ -2694,9 +3235,10 @@ type ReplicaModifications struct { 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. + // that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication]in + // the Amazon S3 User Guide. + // + // [How to Set Up Replication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html // // This member is required. Role *string @@ -2729,18 +3271,21 @@ type ReplicationRule struct { // DeleteMarkerReplication element. If your Filter includes a Tag element, the // 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]. + // + // For more information about delete marker replication, see [Basic Rule Configuration]. + // + // 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]. + // + // [Basic Rule Configuration]: https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html + // [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) - // in the Amazon S3 User Guide. + // information, see [Replicating Existing Objects]in the Amazon S3 User Guide. + // + // [Replicating Existing Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication ExistingObjectReplication *ExistingObjectReplication // A filter that identifies the subset of objects to which the replication rule @@ -2753,10 +3298,12 @@ type ReplicationRule struct { // An object key name prefix that identifies the object or objects to which the // 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) - // . + // 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]. + // + // [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 @@ -2766,8 +3313,10 @@ 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] in the Amazon S3 User Guide. + // + // [Replication]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html Priority *int32 // A container that describes additional filters for identifying the source @@ -2782,9 +3331,13 @@ 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: +// 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. type ReplicationRuleAndOperator struct { @@ -2815,8 +3368,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. type ReplicationRuleFilterMemberAnd struct { @@ -2828,10 +3383,12 @@ type ReplicationRuleFilterMemberAnd struct { 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) -// . +// 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]. +// +// [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 @@ -2840,8 +3397,9 @@ 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 @@ -2850,19 +3408,20 @@ type ReplicationRuleFilterMemberTag struct { func (*ReplicationRuleFilterMemberTag) isReplicationRuleFilter() {} -// A container specifying S3 Replication Time Control (S3 RTC) related +// 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. + // Specifies whether the replication time is enabled. // // This member is required. Status ReplicationTimeStatus - // A container specifying the time by which replication should be complete for all - // objects and operations on objects. + // A container specifying the time by which replication should be complete for + // all objects and operations on objects. // // This member is required. Time *ReplicationTimeValue @@ -2870,11 +3429,14 @@ type ReplicationTime struct { noSmithyDocumentSerde } -// A container specifying the time value for S3 Replication Time Control (S3 RTC) +// A container specifying the time value for S3 Replication Time Control (S3 RTC) +// // and replication metrics EventThreshold . type ReplicationTimeValue struct { - // Contains an integer specifying time in minutes. Valid value: 15 + // Contains an integer specifying time in minutes. + // + // Valid value: 15 Minutes *int32 noSmithyDocumentSerde @@ -2905,8 +3467,10 @@ 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 - // be provided for select requests. + // OutputLocation . + // + // The Days element is required for regular restores, and must not be provided for + // select requests. Days *int32 // The optional description for the job. @@ -2933,34 +3497,43 @@ type RestoreRequest struct { // Specifies the restoration status of an object. Objects in certain storage // classes must be restored before they can be retrieved. For more information -// about these storage classes and how to work with archived objects, see Working -// with archived objects (https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html) -// in the Amazon S3 User Guide. This functionality is not supported for directory -// buckets. Only the S3 Express One Zone storage class is supported by directory -// buckets to store objects. +// about these storage classes and how to work with archived objects, see [Working with archived objects]in the +// Amazon S3 User Guide. +// +// This functionality is not supported for directory buckets. Only the S3 Express +// One Zone storage class is supported by directory buckets to store objects. +// +// [Working with archived objects]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html type RestoreStatus struct { // Specifies whether the object is currently being restored. If the object // restoration is in progress, the header returns the value TRUE . For example: - // x-amz-optional-object-attributes: IsRestoreInProgress="true" If the object - // restoration has completed, the header returns the value FALSE . For example: - // x-amz-optional-object-attributes: IsRestoreInProgress="false", - // RestoreExpiryDate="2012-12-21T00:00:00.000Z" If the object hasn't been restored, - // there is no header response. + // + // x-amz-optional-object-attributes: IsRestoreInProgress="true" + // + // If the object restoration has completed, the header returns the value FALSE . + // For example: + // + // x-amz-optional-object-attributes: IsRestoreInProgress="false", + // RestoreExpiryDate="2012-12-21T00:00:00.000Z" + // + // If the object hasn't been restored, there is no header response. IsRestoreInProgress *bool // Indicates when the restored copy will expire. This value is populated only if // the object has already been restored. For example: - // x-amz-optional-object-attributes: IsRestoreInProgress="false", - // RestoreExpiryDate="2012-12-21T00:00:00.000Z" + // + // x-amz-optional-object-attributes: IsRestoreInProgress="false", + // RestoreExpiryDate="2012-12-21T00:00:00.000Z" RestoreExpiryDate *time.Time noSmithyDocumentSerde } // 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) -// in the Amazon S3 User Guide. +// information about routing rules, see [Configuring advanced conditional redirects]in the Amazon S3 User Guide. +// +// [Configuring advanced conditional redirects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects type RoutingRule struct { // Container for redirect information. You can redirect requests to another host, @@ -3135,8 +3708,9 @@ 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) -// in the Amazon S3 API Reference. +// SSE-KMS. For more information, see [PUT Bucket encryption]in the Amazon S3 API Reference. +// +// [PUT Bucket encryption]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html type ServerSideEncryptionByDefault struct { // Server-side encryption algorithm to use for the default encryption. @@ -3146,19 +3720,30 @@ 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 or aws:kms:dsse . You can specify the key - // ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + // only if SSEAlgorithm is set to aws:kms or aws:kms:dsse . + // + // You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the + // KMS key. + // // - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // // - Key ARN: // arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // // - Key Alias: alias/alias-name + // // If you use a key ID, you can run into a LogDestination undeliverable error when - // creating a VPC flow log. 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) - // . 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. + // creating a VPC flow log. + // + // 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]. + // + // Amazon S3 only supports symmetric encryption KMS keys. For more information, + // see [Asymmetric keys in Amazon Web Services KMS]in the Amazon Web Services Key Management Service Developer Guide. + // + // [Using encryption for cross-account operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy + // [Asymmetric keys in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html KMSMasterKeyID *string noSmithyDocumentSerde @@ -3187,17 +3772,20 @@ type ServerSideEncryptionRule struct { // Specifies whether Amazon S3 should use an S3 Bucket Key with server-side // 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. + // to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. + // + // For more information, see [Amazon S3 Bucket Keys] in the Amazon S3 User Guide. + // + // [Amazon S3 Bucket Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html BucketKeyEnabled *bool noSmithyDocumentSerde } -// The established temporary security credentials of the session. Directory -// buckets - These session credentials are only supported for the authentication -// and authorization of Zonal endpoint APIs on directory buckets. +// The established temporary security credentials of the session. +// +// Directory buckets - These session credentials are only supported for the +// authentication and authorization of Zonal endpoint APIs on directory buckets. type SessionCredentials struct { // A unique identifier that's associated with a secret access key. The access key @@ -3233,7 +3821,9 @@ type SessionCredentials struct { } // To use simple format for S3 keys for log objects, set SimplePrefix to an empty -// object. [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString] +// object. +// +// [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString] type SimplePrefix struct { noSmithyDocumentSerde } @@ -3249,12 +3839,14 @@ type SourceSelectionCriteria struct { // 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 + // 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 + // A container for filter information for the selection of Amazon S3 objects // encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria // in the replication configuration, this element is required. SseKmsEncryptedObjects *SseKmsEncryptedObjects @@ -3372,10 +3964,12 @@ type Tagging struct { noSmithyDocumentSerde } -// 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) -// in the Amazon S3 User Guide. +// 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]in the Amazon S3 User Guide. +// +// [Permissions server access log delivery]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general type TargetGrant struct { // Container for the person being granted permissions. @@ -3406,9 +4000,10 @@ type TargetObjectKeyFormat struct { // without additional operational overhead. 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) - // for a list of access tiers in the S3 Intelligent-Tiering storage class. + // S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects] for a list of access tiers in the S3 + // Intelligent-Tiering storage class. + // + // [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 // // This member is required. AccessTier IntelligentTieringAccessTier @@ -3431,8 +4026,9 @@ 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]in the Amazon S3 User Guide. + // + // [Supported Event Types]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html // // This member is required. Events []Event @@ -3444,8 +4040,9 @@ type TopicConfiguration struct { TopicArn *string // Specifies object key name filtering rules. For information about key name - // filtering, see Configuring event notifications using object key name filtering (https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) - // in the Amazon S3 User Guide. + // filtering, see [Configuring event notifications using object key name filtering]in the Amazon S3 User Guide. + // + // [Configuring event notifications using object key name filtering]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html Filter *NotificationConfigurationFilter // An optional unique identifier for configurations in a notification @@ -3456,9 +4053,10 @@ 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) -// in the Amazon S3 User Guide. +// information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle]in the Amazon S3 +// User Guide. +// +// [Transitioning Objects Using Amazon S3 Lifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html type Transition struct { // Indicates when objects are transitioned to the specified storage class. The @@ -3476,8 +4074,9 @@ type Transition struct { } // 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. +// see [PUT Bucket versioning]in the Amazon S3 API Reference. +// +// [PUT Bucket versioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html type VersioningConfiguration struct { // Specifies whether MFA delete is enabled in the bucket versioning configuration. @@ -3500,8 +4099,9 @@ type WebsiteConfiguration struct { // The name of the index document for the website. IndexDocument *IndexDocument - // The redirect behavior for every request to this bucket's website endpoint. If - // you specify this property, you can't specify any other property. + // The redirect behavior for every request to this bucket's website endpoint. + // + // If you specify this property, you can't specify any other property. RedirectAllRequestsTo *RedirectAllRequestsTo // Rules that define when a redirect is applied and the redirect behavior. diff --git a/service/s3control/api_op_AssociateAccessGrantsIdentityCenter.go b/service/s3control/api_op_AssociateAccessGrantsIdentityCenter.go index 2eb1d509fbc..c5313871e2a 100644 --- a/service/s3control/api_op_AssociateAccessGrantsIdentityCenter.go +++ b/service/s3control/api_op_AssociateAccessGrantsIdentityCenter.go @@ -20,8 +20,11 @@ import ( // for users or groups from your corporate identity directory. First, you must add // your corporate identity directory to Amazon Web Services IAM Identity Center. // Then, you can associate this IAM Identity Center instance with your S3 Access -// Grants instance. Permissions You must have the -// s3:AssociateAccessGrantsIdentityCenter permission to use this operation. +// Grants instance. +// +// Permissions You must have the s3:AssociateAccessGrantsIdentityCenter permission +// to use this operation. +// // Additional Permissions You must also have the following permissions: // sso:CreateApplication , sso:PutApplicationGrant , and // sso:PutApplicationAuthenticationMethod . @@ -50,9 +53,10 @@ type AssociateAccessGrantsIdentityCenterInput struct { // The Amazon Resource Name (ARN) of the Amazon Web Services IAM Identity Center // instance that you are associating with your S3 Access Grants instance. An IAM // Identity Center instance is your corporate identity directory that you added to - // the IAM Identity Center. You can use the ListInstances (https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html) - // API operation to retrieve a list of your Identity Center instances and their - // ARNs. + // the IAM Identity Center. You can use the [ListInstances]API operation to retrieve a list of + // your Identity Center instances and their ARNs. + // + // [ListInstances]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html // // This member is required. IdentityCenterArn *string diff --git a/service/s3control/api_op_CreateAccessGrant.go b/service/s3control/api_op_CreateAccessGrant.go index 805086d13fd..eb5e50d156f 100644 --- a/service/s3control/api_op_CreateAccessGrant.go +++ b/service/s3control/api_op_CreateAccessGrant.go @@ -20,14 +20,22 @@ import ( // Creates an access grant that gives a grantee access to your S3 data. The // grantee can be an IAM user or role or a directory user, or group. Before you can // create a grant, you must have an S3 Access Grants instance in the same Region as -// the S3 data. You can create an S3 Access Grants instance using the -// CreateAccessGrantsInstance (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessGrantsInstance.html) -// . You must also have registered at least one S3 data location in your S3 Access -// Grants instance using CreateAccessGrantsLocation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessGrantsLocation.html) -// . Permissions You must have the s3:CreateAccessGrant permission to use this -// operation. Additional Permissions For any directory identity - -// sso:DescribeInstance and sso:DescribeApplication For directory users - -// identitystore:DescribeUser For directory groups - identitystore:DescribeGroup +// the S3 data. You can create an S3 Access Grants instance using the [CreateAccessGrantsInstance]. You must +// also have registered at least one S3 data location in your S3 Access Grants +// instance using [CreateAccessGrantsLocation]. +// +// Permissions You must have the s3:CreateAccessGrant permission to use this +// operation. +// +// Additional Permissions For any directory identity - sso:DescribeInstance and +// sso:DescribeApplication +// +// For directory users - identitystore:DescribeUser +// +// For directory groups - identitystore:DescribeGroup +// +// [CreateAccessGrantsLocation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessGrantsLocation.html +// [CreateAccessGrantsInstance]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessGrantsInstance.html func (c *Client) CreateAccessGrant(ctx context.Context, params *CreateAccessGrantInput, optFns ...func(*Options)) (*CreateAccessGrantOutput, error) { if params == nil { params = &CreateAccessGrantInput{} @@ -48,9 +56,11 @@ type CreateAccessGrantInput struct { // The ID of the registered location to which you are granting access. S3 Access // Grants assigns this ID when you register the location. S3 Access Grants assigns // the ID default to the default location s3:// and assigns an auto-generated ID - // to other locations that you register. If you are passing the default location, - // you cannot create an access grant for the entire default location. You must also - // specify a bucket or a bucket and prefix in the Subprefix field. + // to other locations that you register. + // + // If you are passing the default location, you cannot create an access grant for + // the entire default location. You must also specify a bucket or a bucket and + // prefix in the Subprefix field. // // This member is required. AccessGrantsLocationId *string @@ -71,8 +81,11 @@ type CreateAccessGrantInput struct { // The type of access that you are granting to your S3 data, which can be set to // one of the following values: + // // - READ – Grant read-only access to the S3 data. + // // - WRITE – Grant write-only access to the S3 data. + // // - READWRITE – Grant both read and write access to the S3 data. // // This member is required. @@ -149,8 +162,11 @@ type CreateAccessGrantOutput struct { // The type of access that you are granting to your S3 data, which can be set to // one of the following values: + // // - READ – Grant read-only access to the S3 data. + // // - WRITE – Grant write-only access to the S3 data. + // // - READWRITE – Grant both read and write access to the S3 data. Permission types.Permission diff --git a/service/s3control/api_op_CreateAccessGrantsInstance.go b/service/s3control/api_op_CreateAccessGrantsInstance.go index d417bad18b6..c71a1c7553f 100644 --- a/service/s3control/api_op_CreateAccessGrantsInstance.go +++ b/service/s3control/api_op_CreateAccessGrantsInstance.go @@ -19,10 +19,14 @@ import ( // Creates an S3 Access Grants instance, which serves as a logical grouping for // access grants. You can create one S3 Access Grants instance per Region per -// account. Permissions You must have the s3:CreateAccessGrantsInstance permission -// to use this operation. Additional Permissions To associate an IAM Identity -// Center instance with your S3 Access Grants instance, you must also have the -// sso:DescribeInstance , sso:CreateApplication , sso:PutApplicationGrant , and +// account. +// +// Permissions You must have the s3:CreateAccessGrantsInstance permission to use +// this operation. +// +// Additional Permissions To associate an IAM Identity Center instance with your +// S3 Access Grants instance, you must also have the sso:DescribeInstance , +// sso:CreateApplication , sso:PutApplicationGrant , and // sso:PutApplicationAuthenticationMethod permissions. func (c *Client) CreateAccessGrantsInstance(ctx context.Context, params *CreateAccessGrantsInstanceInput, optFns ...func(*Options)) (*CreateAccessGrantsInstanceOutput, error) { if params == nil { @@ -51,9 +55,10 @@ type CreateAccessGrantsInstanceInput struct { // Resource Name (ARN) of the Amazon Web Services IAM Identity Center instance that // you are associating with your S3 Access Grants instance. An IAM Identity Center // instance is your corporate identity directory that you added to the IAM Identity - // Center. You can use the ListInstances (https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html) - // API operation to retrieve a list of your Identity Center instances and their - // ARNs. + // Center. You can use the [ListInstances]API operation to retrieve a list of your Identity + // Center instances and their ARNs. + // + // [ListInstances]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html IdentityCenterArn *string // The Amazon Web Services resource tags that you are adding to the S3 Access diff --git a/service/s3control/api_op_CreateAccessGrantsLocation.go b/service/s3control/api_op_CreateAccessGrantsLocation.go index ed94bfd5fbb..8f083dc85cd 100644 --- a/service/s3control/api_op_CreateAccessGrantsLocation.go +++ b/service/s3control/api_op_CreateAccessGrantsLocation.go @@ -20,18 +20,26 @@ import ( // The S3 data location that you would like to register in your S3 Access Grants // instance. Your S3 data must be in the same Region as your S3 Access Grants // instance. The location can be one of the following: +// // - The default S3 location s3:// +// // - A bucket - S3:// +// // - A bucket and prefix - S3:/// // // When you register a location, you must include the IAM role that has permission // to manage the S3 location that you are registering. Give S3 Access Grants -// permission to assume this role using a policy (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-location.html) -// . S3 Access Grants assumes this role to manage access to the location and to -// vend temporary credentials to grantees or client applications. Permissions You -// must have the s3:CreateAccessGrantsLocation permission to use this operation. +// permission to assume this role [using a policy]. S3 Access Grants assumes this role to manage +// access to the location and to vend temporary credentials to grantees or client +// applications. +// +// Permissions You must have the s3:CreateAccessGrantsLocation permission to use +// this operation. +// // Additional Permissions You must also have the following permission for the // specified IAM role: iam:PassRole +// +// [using a policy]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-location.html func (c *Client) CreateAccessGrantsLocation(ctx context.Context, params *CreateAccessGrantsLocationInput, optFns ...func(*Options)) (*CreateAccessGrantsLocationOutput, error) { if params == nil { params = &CreateAccessGrantsLocationInput{} diff --git a/service/s3control/api_op_CreateAccessPoint.go b/service/s3control/api_op_CreateAccessPoint.go index a1785317626..4c6de2e5d08 100644 --- a/service/s3control/api_op_CreateAccessPoint.go +++ b/service/s3control/api_op_CreateAccessPoint.go @@ -16,22 +16,36 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Creates an access point and associates it with the specified bucket. For more +// information, see [Managing Data Access with Amazon S3 Access Points]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] 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]section. +// +// The following actions are related to CreateAccessPoint : +// +// [GetAccessPoint] +// +// [DeleteAccessPoint] +// +// [ListAccessPoints] +// +// [ListAccessPoints]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html +// [Managing Data Access with Amazon S3 Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html +// [GetAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html +// [Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [DeleteAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples func (c *Client) CreateAccessPoint(ctx context.Context, params *CreateAccessPointInput, optFns ...func(*Options)) (*CreateAccessPointOutput, error) { if params == nil { params = &CreateAccessPointInput{} @@ -55,13 +69,16 @@ type CreateAccessPointInput struct { // This member is required. AccountId *string - // The name of the bucket that you want to associate this access point with. 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 + // The name of the bucket that you want to associate this access point with. + // + // 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. // @@ -74,18 +91,22 @@ type CreateAccessPointInput struct { Name *string // The Amazon Web Services account ID associated with the S3 bucket associated - // with this access point. For same account access point when your bucket and - // access point belong to the same account owner, the BucketAccountId is not - // required. For cross-account access point when your bucket and access point are - // not in the same account, the BucketAccountId is required. + // with this access point. + // + // For same account access point when your bucket and access point belong to the + // same account owner, the BucketAccountId is not required. For cross-account + // access point when your bucket and access point are not in the same account, the + // BucketAccountId is required. BucketAccountId *string - // The PublicAccessBlock configuration that you want to apply to the access point. + // The PublicAccessBlock configuration that you want to apply to the access + // point. PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // If you include this field, Amazon S3 restricts access to this access point to - // requests from the specified virtual private cloud (VPC). This is required for - // creating an access point for Amazon S3 on Outposts buckets. + // requests from the specified virtual private cloud (VPC). + // + // This is required for creating an access point for Amazon S3 on Outposts buckets. VpcConfiguration *types.VpcConfiguration noSmithyDocumentSerde @@ -99,7 +120,9 @@ func (in *CreateAccessPointInput) bindEndpointParams(p *EndpointParameters) { type CreateAccessPointOutput struct { - // The ARN of the access point. This is only supported by Amazon S3 on Outposts. + // The ARN of the access point. + // + // This is only supported by Amazon S3 on Outposts. AccessPointArn *string // The name or alias of the access point. diff --git a/service/s3control/api_op_CreateAccessPointForObjectLambda.go b/service/s3control/api_op_CreateAccessPointForObjectLambda.go index a0bc9560a1b..322385dbdc8 100644 --- a/service/s3control/api_op_CreateAccessPointForObjectLambda.go +++ b/service/s3control/api_op_CreateAccessPointForObjectLambda.go @@ -16,14 +16,23 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// 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) +// This operation is not supported by directory buckets. +// +// Creates an Object Lambda Access Point. For more information, see [Transforming objects with Object Lambda Access Points] in the Amazon +// S3 User Guide. +// +// The following actions are related to CreateAccessPointForObjectLambda : +// +// [DeleteAccessPointForObjectLambda] +// +// [GetAccessPointForObjectLambda] +// +// [ListAccessPointsForObjectLambda] +// +// [ListAccessPointsForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html +// [Transforming objects with Object Lambda Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.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) 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 97716a03099..104a50442bd 100644 --- a/service/s3control/api_op_CreateBucket.go +++ b/service/s3control/api_op_CreateBucket.go @@ -14,28 +14,50 @@ import ( ) // 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: +// see [Create Bucket]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]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]. +// +// S3 on Outposts buckets support: +// // - 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) -// 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) +// Outposts, see [Amazon S3 on Outposts Restrictions and Limitations]. +// +// 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]section. +// +// The following actions are related to CreateBucket for Amazon S3 on Outposts: +// +// [PutObject] +// +// [GetBucket] +// +// [DeleteBucket] +// +// [CreateAccessPoint] +// +// [PutAccessPointPolicy] +// +// [GetBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html +// [CreateAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html +// [Working with Amazon S3 Buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html +// [Create Bucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html +// [PutObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [PutAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples +// [Amazon S3 on Outposts Restrictions and Limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html func (c *Client) CreateBucket(ctx context.Context, params *CreateBucketInput, optFns ...func(*Options)) (*CreateBucketOutput, error) { if params == nil { params = &CreateBucketInput{} @@ -58,40 +80,50 @@ type CreateBucketInput struct { // This member is required. Bucket *string - // The canned ACL to apply to the bucket. This is not supported by Amazon S3 on - // Outposts buckets. + // The canned ACL to apply to the bucket. + // + // This is not supported by Amazon S3 on 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 - // bucket. This is not supported by Amazon S3 on Outposts buckets. + // bucket. + // + // This is not supported by Amazon S3 on Outposts buckets. GrantFullControl *string - // Allows grantee to list the objects in the bucket. This is not supported by - // Amazon S3 on Outposts buckets. + // Allows grantee to list the objects in the bucket. + // + // This is not supported by Amazon S3 on Outposts buckets. GrantRead *string - // Allows grantee to read the bucket ACL. This is not supported by Amazon S3 on - // Outposts buckets. + // Allows grantee to read the bucket ACL. + // + // This is not supported by Amazon S3 on Outposts buckets. GrantReadACP *string - // Allows grantee to create, overwrite, and delete any object in the bucket. This - // is not supported by Amazon S3 on Outposts buckets. + // Allows grantee to create, overwrite, and delete any object in the bucket. + // + // This 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. 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 @@ -105,13 +137,16 @@ func (in *CreateBucketInput) bindEndpointParams(p *EndpointParameters) { type CreateBucketOutput struct { - // The Amazon Resource Name (ARN) of the bucket. 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 + // The Amazon Resource Name (ARN) of the bucket. + // + // 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. BucketArn *string diff --git a/service/s3control/api_op_CreateJob.go b/service/s3control/api_op_CreateJob.go index 1cefeb11b72..42ebe0f1497 100644 --- a/service/s3control/api_op_CreateJob.go +++ b/service/s3control/api_op_CreateJob.go @@ -16,19 +16,34 @@ import ( "strings" ) -// This operation creates an S3 Batch Operations job. 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. Permissions For information about permissions -// required to use the Batch Operations, see Granting permissions for S3 Batch -// Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-iam-role-policies.html) -// in the Amazon S3 User Guide. 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) +// This operation creates an S3 Batch Operations job. +// +// 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]in the Amazon S3 User Guide. +// +// Permissions For information about permissions required to use the Batch +// Operations, see [Granting permissions for S3 Batch Operations]in the Amazon S3 User Guide. +// +// Related actions include: +// +// [DescribeJob] +// +// [ListJobs] +// +// [UpdateJobPriority] +// +// [UpdateJobStatus] +// +// [JobOperation] +// +// [DescribeJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html +// [S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html +// [Granting permissions for S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-iam-role-policies.html +// [JobOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.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 +// [ListJobs]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { params = &CreateJobInput{} @@ -58,8 +73,10 @@ 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]in the Amazon + // S3 User Guide. + // + // [Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html // // This member is required. Operation *types.JobOperation diff --git a/service/s3control/api_op_CreateMultiRegionAccessPoint.go b/service/s3control/api_op_CreateMultiRegionAccessPoint.go index b9e3e6903b1..370247ea6ac 100644 --- a/service/s3control/api_op_CreateMultiRegionAccessPoint.go +++ b/service/s3control/api_op_CreateMultiRegionAccessPoint.go @@ -16,23 +16,37 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// 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 working with -// Multi-Region Access Points, see Multi-Region Access Point restrictions and -// limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// This operation is not supported by directory buckets. +// +// 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]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 working with Multi-Region Access +// Points, see [Multi-Region Access Point restrictions and limitations]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] +// +// [DescribeMultiRegionAccessPointOperation] +// +// [GetMultiRegionAccessPoint] +// +// [ListMultiRegionAccessPoints] +// +// [Creating Multi-Region Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.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 +// [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) CreateMultiRegionAccessPoint(ctx context.Context, params *CreateMultiRegionAccessPointInput, optFns ...func(*Options)) (*CreateMultiRegionAccessPointOutput, error) { if params == nil { params = &CreateMultiRegionAccessPointInput{} @@ -78,9 +92,10 @@ func (in *CreateMultiRegionAccessPointInput) bindEndpointParams(p *EndpointParam 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) - // to determine the status of asynchronous requests. + // The request token associated with the request. You can use this token with [DescribeMultiRegionAccessPointOperation] to + // determine the status of asynchronous requests. + // + // [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html RequestTokenARN *string // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_CreateStorageLensGroup.go b/service/s3control/api_op_CreateStorageLensGroup.go index 0c033d58c5d..ef7ab6e743b 100644 --- a/service/s3control/api_op_CreateStorageLensGroup.go +++ b/service/s3control/api_op_CreateStorageLensGroup.go @@ -16,22 +16,25 @@ import ( "strings" ) -// Creates a new S3 Storage Lens group and associates it with the specified Amazon -// Web Services account ID. An S3 Storage Lens group is a custom grouping of +// Creates a new S3 Storage Lens group and associates it with the specified +// +// Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of // objects based on prefix, suffix, object tags, object size, object age, or a // combination of these filters. For each Storage Lens group that you’ve created, // you can also optionally add Amazon Web Services resource tags. For more -// information about S3 Storage Lens groups, see Working with S3 Storage Lens -// groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups-overview.html) -// . To use this operation, you must have the permission to perform the +// information about S3 Storage Lens groups, see [Working with S3 Storage Lens groups]. +// +// To use this operation, you must have the permission to perform the // s3:CreateStorageLensGroup action. If you’re trying to create a Storage Lens // group with Amazon Web Services resource tags, you must also have permission to // perform the s3:TagResource action. For more information about the required -// Storage Lens Groups permissions, see Setting account permissions to use S3 -// Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about Storage Lens groups errors, see List of Amazon S3 -// Storage Lens error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList) -// . +// Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [List of Amazon S3 Storage Lens error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList +// [Working with S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups-overview.html func (c *Client) CreateStorageLensGroup(ctx context.Context, params *CreateStorageLensGroupInput, optFns ...func(*Options)) (*CreateStorageLensGroupOutput, error) { if params == nil { params = &CreateStorageLensGroupInput{} @@ -49,18 +52,18 @@ func (c *Client) CreateStorageLensGroup(ctx context.Context, params *CreateStora type CreateStorageLensGroupInput struct { - // The Amazon Web Services account ID that the Storage Lens group is created from + // The Amazon Web Services account ID that the Storage Lens group is created from // and associated with. // // This member is required. AccountId *string - // The Storage Lens group configuration. + // The Storage Lens group configuration. // // This member is required. StorageLensGroup *types.StorageLensGroup - // The Amazon Web Services resource tags that you're adding to your Storage Lens + // The Amazon Web Services resource tags that you're adding to your Storage Lens // group. This parameter is optional. Tags []types.Tag diff --git a/service/s3control/api_op_DeleteAccessGrant.go b/service/s3control/api_op_DeleteAccessGrant.go index 2855bc5d45c..95072380762 100644 --- a/service/s3control/api_op_DeleteAccessGrant.go +++ b/service/s3control/api_op_DeleteAccessGrant.go @@ -17,6 +17,7 @@ import ( // Deletes the access grant from the S3 Access Grants instance. You cannot undo an // access grant deletion and the grantee will no longer have access to the S3 data. +// // Permissions You must have the s3:DeleteAccessGrant permission to use this // operation. func (c *Client) DeleteAccessGrant(ctx context.Context, params *DeleteAccessGrantInput, optFns ...func(*Options)) (*DeleteAccessGrantOutput, error) { diff --git a/service/s3control/api_op_DeleteAccessGrantsInstance.go b/service/s3control/api_op_DeleteAccessGrantsInstance.go index de4c6fffce2..7d035cf8eb0 100644 --- a/service/s3control/api_op_DeleteAccessGrantsInstance.go +++ b/service/s3control/api_op_DeleteAccessGrantsInstance.go @@ -16,16 +16,19 @@ import ( ) // Deletes your S3 Access Grants instance. You must first delete the access grants -// and locations before S3 Access Grants can delete the instance. See -// DeleteAccessGrant (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrant.html) -// and DeleteAccessGrantsLocation (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrantsLocation.html) -// . If you have associated an IAM Identity Center instance with your S3 Access -// Grants instance, you must first dissassociate the Identity Center instance from -// the S3 Access Grants instance before you can delete the S3 Access Grants -// instance. See AssociateAccessGrantsIdentityCenter (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AssociateAccessGrantsIdentityCenter.html) -// and DissociateAccessGrantsIdentityCenter (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DissociateAccessGrantsIdentityCenter.html) -// . Permissions You must have the s3:DeleteAccessGrantsInstance permission to use +// and locations before S3 Access Grants can delete the instance. See [DeleteAccessGrant]and [DeleteAccessGrantsLocation]. If you +// have associated an IAM Identity Center instance with your S3 Access Grants +// instance, you must first dissassociate the Identity Center instance from the S3 +// Access Grants instance before you can delete the S3 Access Grants instance. See [AssociateAccessGrantsIdentityCenter] +// and [DissociateAccessGrantsIdentityCenter]. +// +// Permissions You must have the s3:DeleteAccessGrantsInstance permission to use // this operation. +// +// [DeleteAccessGrant]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrant.html +// [AssociateAccessGrantsIdentityCenter]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AssociateAccessGrantsIdentityCenter.html +// [DeleteAccessGrantsLocation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrantsLocation.html +// [DissociateAccessGrantsIdentityCenter]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DissociateAccessGrantsIdentityCenter.html func (c *Client) DeleteAccessGrantsInstance(ctx context.Context, params *DeleteAccessGrantsInstanceInput, optFns ...func(*Options)) (*DeleteAccessGrantsInstanceOutput, error) { if params == nil { params = &DeleteAccessGrantsInstanceInput{} diff --git a/service/s3control/api_op_DeleteAccessGrantsInstanceResourcePolicy.go b/service/s3control/api_op_DeleteAccessGrantsInstanceResourcePolicy.go index 11381a035a5..af216c8dd2b 100644 --- a/service/s3control/api_op_DeleteAccessGrantsInstanceResourcePolicy.go +++ b/service/s3control/api_op_DeleteAccessGrantsInstanceResourcePolicy.go @@ -18,8 +18,10 @@ import ( // Deletes the resource policy of the S3 Access Grants instance. The resource // policy is used to manage cross-account access to your S3 Access Grants instance. // By deleting the resource policy, you delete any cross-account permissions to -// your S3 Access Grants instance. Permissions You must have the -// s3:DeleteAccessGrantsInstanceResourcePolicy permission to use this operation. +// your S3 Access Grants instance. +// +// Permissions You must have the s3:DeleteAccessGrantsInstanceResourcePolicy +// permission to use this operation. func (c *Client) DeleteAccessGrantsInstanceResourcePolicy(ctx context.Context, params *DeleteAccessGrantsInstanceResourcePolicyInput, optFns ...func(*Options)) (*DeleteAccessGrantsInstanceResourcePolicyOutput, error) { if params == nil { params = &DeleteAccessGrantsInstanceResourcePolicyInput{} diff --git a/service/s3control/api_op_DeleteAccessGrantsLocation.go b/service/s3control/api_op_DeleteAccessGrantsLocation.go index 1a0e5bde328..91d05b066c7 100644 --- a/service/s3control/api_op_DeleteAccessGrantsLocation.go +++ b/service/s3control/api_op_DeleteAccessGrantsLocation.go @@ -17,11 +17,14 @@ import ( // Deregisters a location from your S3 Access Grants instance. You can only delete // a location registration from an S3 Access Grants instance if there are no grants -// associated with this location. See Delete a grant (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrant.html) -// for information on how to delete grants. You need to have at least one -// registered location in your S3 Access Grants instance in order to create access -// grants. Permissions You must have the s3:DeleteAccessGrantsLocation permission -// to use this operation. +// associated with this location. See [Delete a grant]for information on how to delete grants. You +// need to have at least one registered location in your S3 Access Grants instance +// in order to create access grants. +// +// Permissions You must have the s3:DeleteAccessGrantsLocation permission to use +// this operation. +// +// [Delete a grant]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessGrant.html func (c *Client) DeleteAccessGrantsLocation(ctx context.Context, params *DeleteAccessGrantsLocationInput, optFns ...func(*Options)) (*DeleteAccessGrantsLocationOutput, error) { if params == nil { params = &DeleteAccessGrantsLocationInput{} diff --git a/service/s3control/api_op_DeleteAccessPoint.go b/service/s3control/api_op_DeleteAccessPoint.go index 38d9ddcab74..59ebbb774a6 100644 --- a/service/s3control/api_op_DeleteAccessPoint.go +++ b/service/s3control/api_op_DeleteAccessPoint.go @@ -15,17 +15,29 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]section. +// +// The following actions are related to DeleteAccessPoint : +// +// [CreateAccessPoint] +// +// [GetAccessPoint] +// +// [ListAccessPoints] +// +// [ListAccessPoints]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html +// [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 +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples func (c *Client) DeleteAccessPoint(ctx context.Context, params *DeleteAccessPointInput, optFns ...func(*Options)) (*DeleteAccessPointOutput, error) { if params == nil { params = &DeleteAccessPointInput{} @@ -49,13 +61,16 @@ type DeleteAccessPointInput struct { // This member is required. AccountId *string - // The name of the access point you want to delete. 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 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 + // The name of the access point you want to delete. + // + // 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 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. // diff --git a/service/s3control/api_op_DeleteAccessPointForObjectLambda.go b/service/s3control/api_op_DeleteAccessPointForObjectLambda.go index 05fe480b376..c7104259b80 100644 --- a/service/s3control/api_op_DeleteAccessPointForObjectLambda.go +++ b/service/s3control/api_op_DeleteAccessPointForObjectLambda.go @@ -15,12 +15,21 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Deletes the specified Object Lambda Access Point. +// +// The following actions are related to DeleteAccessPointForObjectLambda : +// +// [CreateAccessPointForObjectLambda] +// +// [GetAccessPointForObjectLambda] +// +// [ListAccessPointsForObjectLambda] +// +// [CreateAccessPointForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html +// [ListAccessPointsForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html +// [GetAccessPointForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.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 49c8f82b0a6..7796c1c9505 100644 --- a/service/s3control/api_op_DeleteAccessPointPolicy.go +++ b/service/s3control/api_op_DeleteAccessPointPolicy.go @@ -15,16 +15,26 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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 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) +// This operation is not supported by directory buckets. +// +// 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 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]section. +// +// The following actions are related to DeleteAccessPointPolicy : +// +// [PutAccessPointPolicy] +// +// [GetAccessPointPolicy] +// +// [GetAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicy.html +// [PutAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples func (c *Client) DeleteAccessPointPolicy(ctx context.Context, params *DeleteAccessPointPolicyInput, optFns ...func(*Options)) (*DeleteAccessPointPolicyOutput, error) { if params == nil { params = &DeleteAccessPointPolicyInput{} @@ -47,11 +57,13 @@ type DeleteAccessPointPolicyInput struct { // This member is required. AccountId *string - // The name of the access point whose policy you want to delete. 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 access point accessed in the format + // The name of the access point whose policy you want to delete. + // + // 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 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 diff --git a/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go b/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go index fb47122ed76..ad5e35b39c2 100644 --- a/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go +++ b/service/s3control/api_op_DeleteAccessPointPolicyForObjectLambda.go @@ -15,11 +15,18 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Removes the resource policy for an Object Lambda Access Point. +// +// The following actions are related to DeleteAccessPointPolicyForObjectLambda : +// +// [GetAccessPointPolicyForObjectLambda] +// +// [PutAccessPointPolicyForObjectLambda] +// +// [PutAccessPointPolicyForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html +// [GetAccessPointPolicyForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.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 01c625f6cbb..38917b6d84b 100644 --- a/service/s3control/api_op_DeleteBucket.go +++ b/service/s3control/api_op_DeleteBucket.go @@ -16,21 +16,33 @@ import ( ) // 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) +// see [DeleteBucket]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]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]section. +// +// # Related Resources +// +// [CreateBucket] +// +// [GetBucket] +// +// [DeleteObject] +// +// [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 +// [DeleteBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html +// [CreateBucket]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples func (c *Client) DeleteBucket(ctx context.Context, params *DeleteBucketInput, optFns ...func(*Options)) (*DeleteBucketOutput, error) { if params == nil { params = &DeleteBucketInput{} @@ -53,13 +65,16 @@ type DeleteBucketInput struct { // This member is required. AccountId *string - // Specifies the bucket being deleted. 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 + // Specifies the bucket being deleted. + // + // 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. // diff --git a/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go b/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go index badfe859cb6..4048557e1cb 100644 --- a/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_DeleteBucketLifecycleConfiguration.go @@ -16,27 +16,42 @@ 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) -// 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 operation, you must have permission to -// perform the s3-outposts:PutLifecycleConfiguration 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) -// 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) +// To delete an S3 bucket's lifecycle configuration, see [DeleteBucketLifecycle]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]in +// Amazon S3 User Guide. +// +// To use this operation, you must have permission to perform the +// s3-outposts:PutLifecycleConfiguration 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]section. +// +// For more information about object expiration, see [Elements to Describe Lifecycle Actions]. +// +// Related actions include: +// +// [PutBucketLifecycleConfiguration] +// +// [GetBucketLifecycleConfiguration] +// +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html +// [Elements to Describe Lifecycle Actions]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions +// [GetBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html +// [DeleteBucketLifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples func (c *Client) DeleteBucketLifecycleConfiguration(ctx context.Context, params *DeleteBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*DeleteBucketLifecycleConfigurationOutput, error) { if params == nil { params = &DeleteBucketLifecycleConfigurationInput{} @@ -59,10 +74,13 @@ type DeleteBucketLifecycleConfigurationInput struct { // This member is required. AccountId *string - // Specifies the bucket. 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 + // Specifies the bucket. + // + // 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 diff --git a/service/s3control/api_op_DeleteBucketPolicy.go b/service/s3control/api_op_DeleteBucketPolicy.go index 2d520ec2312..c71e4a0d745 100644 --- a/service/s3control/api_op_DeleteBucketPolicy.go +++ b/service/s3control/api_op_DeleteBucketPolicy.go @@ -16,31 +16,45 @@ 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. 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 +// bucket policy, see [DeleteBucketPolicy]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]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]. +// +// 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) +// derived by using the access point ARN, see the [Examples]section. +// +// The following actions are related to DeleteBucketPolicy : +// +// [GetBucketPolicy] +// +// [PutBucketPolicy] +// +// [PutBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html +// [DeleteBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [GetBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples func (c *Client) DeleteBucketPolicy(ctx context.Context, params *DeleteBucketPolicyInput, optFns ...func(*Options)) (*DeleteBucketPolicyOutput, error) { if params == nil { params = &DeleteBucketPolicyInput{} @@ -63,10 +77,13 @@ type DeleteBucketPolicyInput struct { // This member is required. AccountId *string - // Specifies the bucket. 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 + // Specifies the bucket. + // + // 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 diff --git a/service/s3control/api_op_DeleteBucketReplication.go b/service/s3control/api_op_DeleteBucketReplication.go index e6f7f74ff91..ab01df1bf05 100644 --- a/service/s3control/api_op_DeleteBucketReplication.go +++ b/service/s3control/api_op_DeleteBucketReplication.go @@ -16,32 +16,46 @@ 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) -// 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) -// 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. 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_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) -// 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) +// configuration. To delete an S3 bucket's replication configuration, see [DeleteBucketReplication]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]and [Managing access to S3 on Outposts buckets] 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. +// +// 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]section. +// +// For information about S3 replication on Outposts configuration, see [Replicating objects for S3 on Outposts] in the +// Amazon S3 User Guide. +// +// The following operations are related to DeleteBucketReplication : +// +// [PutBucketReplication] +// +// [GetBucketReplication] +// +// [Replicating objects for S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html +// [GetBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html +// [Setting up IAM with S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html +// [PutBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html +// [Managing access to S3 on Outposts buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html +// [DeleteBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html#API_control_DeleteBucketReplication_Examples func (c *Client) DeleteBucketReplication(ctx context.Context, params *DeleteBucketReplicationInput, optFns ...func(*Options)) (*DeleteBucketReplicationOutput, error) { if params == nil { params = &DeleteBucketReplicationInput{} @@ -65,11 +79,13 @@ 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 + // 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 diff --git a/service/s3control/api_op_DeleteBucketTagging.go b/service/s3control/api_op_DeleteBucketTagging.go index c7f8797e55f..2c9f103bff7 100644 --- a/service/s3control/api_op_DeleteBucketTagging.go +++ b/service/s3control/api_op_DeleteBucketTagging.go @@ -16,20 +16,33 @@ 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) -// 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 -// 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 -// 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) +// bucket tags, see [DeleteBucketTagging]in the Amazon S3 API Reference. +// +// Deletes the tags from the Outposts bucket. For more information, see [Using Amazon S3 on Outposts] 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 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]section. +// +// The following actions are related to DeleteBucketTagging : +// +// [GetBucketTagging] +// +// [PutBucketTagging] +// +// [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 +// [DeleteBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples func (c *Client) DeleteBucketTagging(ctx context.Context, params *DeleteBucketTaggingInput, optFns ...func(*Options)) (*DeleteBucketTaggingOutput, error) { if params == nil { params = &DeleteBucketTaggingInput{} @@ -52,13 +65,16 @@ 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 - // 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 + // 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 . // The value must be URL encoded. // diff --git a/service/s3control/api_op_DeleteJobTagging.go b/service/s3control/api_op_DeleteJobTagging.go index 7db760c8435..1ec2b864133 100644 --- a/service/s3control/api_op_DeleteJobTagging.go +++ b/service/s3control/api_op_DeleteJobTagging.go @@ -16,13 +16,23 @@ import ( ) // Removes the entire tag set from the specified S3 Batch Operations job. +// // Permissions 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) -// 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) +// perform the s3:DeleteJobTagging action. For more information, see [Controlling access and labeling jobs using tags] in the +// Amazon S3 User Guide. +// +// Related actions include: +// +// [CreateJob] +// +// [GetJobTagging] +// +// [PutJobTagging] +// +// [Controlling access and labeling jobs using tags]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags +// [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 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 2116224ddc3..c4585b4a370 100644 --- a/service/s3control/api_op_DeleteMultiRegionAccessPoint.go +++ b/service/s3control/api_op_DeleteMultiRegionAccessPoint.go @@ -16,21 +16,36 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Deletes a Multi-Region -// Access Point. This action does not delete the buckets 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 +// This operation is not supported by directory buckets. +// +// Deletes a Multi-Region Access Point. This action does not delete the buckets +// 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 working with Multi-Region Access -// Points, see Multi-Region Access Point restrictions and limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// Points, see [Multi-Region Access Point restrictions and limitations]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] +// +// [DescribeMultiRegionAccessPointOperation] +// +// [GetMultiRegionAccessPoint] +// +// [ListMultiRegionAccessPoints] +// +// [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 +// [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html +// [CreateMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) DeleteMultiRegionAccessPoint(ctx context.Context, params *DeleteMultiRegionAccessPointInput, optFns ...func(*Options)) (*DeleteMultiRegionAccessPointOutput, error) { if params == nil { params = &DeleteMultiRegionAccessPointInput{} @@ -75,9 +90,10 @@ func (in *DeleteMultiRegionAccessPointInput) bindEndpointParams(p *EndpointParam 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) - // to determine the status of asynchronous requests. + // The request token associated with the request. You can use this token with [DescribeMultiRegionAccessPointOperation] to + // determine the status of asynchronous requests. + // + // [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html RequestTokenARN *string // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_DeletePublicAccessBlock.go b/service/s3control/api_op_DeletePublicAccessBlock.go index dd09e1d5882..6d56acc1329 100644 --- a/service/s3control/api_op_DeletePublicAccessBlock.go +++ b/service/s3control/api_op_DeletePublicAccessBlock.go @@ -15,12 +15,20 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Removes the PublicAccessBlock configuration for an Amazon Web Services account. +// For more information, see [Using Amazon S3 block public access]. +// +// Related actions include: +// +// [GetPublicAccessBlock] +// +// [PutPublicAccessBlock] +// +// [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 +// [Using Amazon S3 block public access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.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 6dd4039d795..dbdb6977a4d 100644 --- a/service/s3control/api_op_DeleteStorageLensConfiguration.go +++ b/service/s3control/api_op_DeleteStorageLensConfiguration.go @@ -15,13 +15,17 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// in the Amazon S3 User Guide. +// This operation is not supported by directory buckets. +// +// 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]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] in the +// Amazon S3 User Guide. +// +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html +// [Assessing your storage activity and usage with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html func (c *Client) DeleteStorageLensConfiguration(ctx context.Context, params *DeleteStorageLensConfigurationInput, optFns ...func(*Options)) (*DeleteStorageLensConfigurationOutput, error) { if params == nil { params = &DeleteStorageLensConfigurationInput{} diff --git a/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go b/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go index c36cbcec46e..6a2547a5533 100644 --- a/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go +++ b/service/s3control/api_op_DeleteStorageLensConfigurationTagging.go @@ -15,13 +15,17 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// in the Amazon S3 User Guide. +// This operation is not supported by directory buckets. +// +// 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]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] in +// the Amazon S3 User Guide. +// +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html +// [Assessing your storage activity and usage with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html func (c *Client) DeleteStorageLensConfigurationTagging(ctx context.Context, params *DeleteStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*DeleteStorageLensConfigurationTaggingOutput, error) { if params == nil { params = &DeleteStorageLensConfigurationTaggingInput{} diff --git a/service/s3control/api_op_DeleteStorageLensGroup.go b/service/s3control/api_op_DeleteStorageLensGroup.go index 4afcee4e645..1ddab4ab52a 100644 --- a/service/s3control/api_op_DeleteStorageLensGroup.go +++ b/service/s3control/api_op_DeleteStorageLensGroup.go @@ -15,13 +15,16 @@ import ( "strings" ) -// Deletes an existing S3 Storage Lens group. To use this operation, you must have -// the permission to perform the s3:DeleteStorageLensGroup action. For more -// information about the required Storage Lens Groups permissions, see Setting -// account permissions to use S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about Storage Lens groups errors, see List of Amazon S3 -// Storage Lens error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList) -// . +// Deletes an existing S3 Storage Lens group. +// +// To use this operation, you must have the permission to perform the +// s3:DeleteStorageLensGroup action. For more information about the required +// Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [List of Amazon S3 Storage Lens error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList func (c *Client) DeleteStorageLensGroup(ctx context.Context, params *DeleteStorageLensGroupInput, optFns ...func(*Options)) (*DeleteStorageLensGroupOutput, error) { if params == nil { params = &DeleteStorageLensGroupInput{} @@ -39,13 +42,13 @@ func (c *Client) DeleteStorageLensGroup(ctx context.Context, params *DeleteStora type DeleteStorageLensGroupInput struct { - // The Amazon Web Services account ID used to create the Storage Lens group that + // The Amazon Web Services account ID used to create the Storage Lens group that // you're trying to delete. // // This member is required. AccountId *string - // The name of the Storage Lens group that you're trying to delete. + // The name of the Storage Lens group that you're trying to delete. // // This member is required. Name *string diff --git a/service/s3control/api_op_DescribeJob.go b/service/s3control/api_op_DescribeJob.go index 647cd57ff4a..ca1ba2d1f23 100644 --- a/service/s3control/api_op_DescribeJob.go +++ b/service/s3control/api_op_DescribeJob.go @@ -17,14 +17,26 @@ 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. Permissions To use the DescribeJob operation, you -// must have permission to perform the s3:DescribeJob action. 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]in the Amazon S3 User Guide. +// +// Permissions To use the DescribeJob operation, you must have permission to +// perform the s3:DescribeJob action. +// +// Related actions include: +// +// [CreateJob] +// +// [ListJobs] +// +// [UpdateJobPriority] +// +// [UpdateJobStatus] +// +// [S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html +// [UpdateJobPriority]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html +// [CreateJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html +// [UpdateJobStatus]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html +// [ListJobs]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.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 98b6a7fbd10..05b816f20ec 100644 --- a/service/s3control/api_op_DescribeMultiRegionAccessPointOperation.go +++ b/service/s3control/api_op_DescribeMultiRegionAccessPointOperation.go @@ -16,16 +16,27 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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 Using Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MrapOperations.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) +// This operation is not supported by directory buckets. +// +// 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 [Using Multi-Region Access Points]in the Amazon S3 User Guide. +// +// The following actions are related to GetMultiRegionAccessPoint : +// +// [CreateMultiRegionAccessPoint] +// +// [DeleteMultiRegionAccessPoint] +// +// [GetMultiRegionAccessPoint] +// +// [ListMultiRegionAccessPoints] +// +// [Using Multi-Region Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MrapOperations.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 +// [CreateMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.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_DissociateAccessGrantsIdentityCenter.go b/service/s3control/api_op_DissociateAccessGrantsIdentityCenter.go index 876a2d1e966..66fee10c85d 100644 --- a/service/s3control/api_op_DissociateAccessGrantsIdentityCenter.go +++ b/service/s3control/api_op_DissociateAccessGrantsIdentityCenter.go @@ -16,8 +16,11 @@ import ( ) // Dissociates the Amazon Web Services IAM Identity Center instance from the S3 -// Access Grants instance. Permissions You must have the -// s3:DissociateAccessGrantsIdentityCenter permission to use this operation. +// Access Grants instance. +// +// Permissions You must have the s3:DissociateAccessGrantsIdentityCenter +// permission to use this operation. +// // Additional Permissions You must have the sso:DeleteApplication permission to // use this operation. func (c *Client) DissociateAccessGrantsIdentityCenter(ctx context.Context, params *DissociateAccessGrantsIdentityCenterInput, optFns ...func(*Options)) (*DissociateAccessGrantsIdentityCenterOutput, error) { diff --git a/service/s3control/api_op_GetAccessGrant.go b/service/s3control/api_op_GetAccessGrant.go index b08c9f1b6be..358c98fd0e3 100644 --- a/service/s3control/api_op_GetAccessGrant.go +++ b/service/s3control/api_op_GetAccessGrant.go @@ -18,6 +18,7 @@ import ( ) // Get the details of an access grant from your S3 Access Grants instance. +// // Permissions You must have the s3:GetAccessGrant permission to use this // operation. func (c *Client) GetAccessGrant(ctx context.Context, params *GetAccessGrantInput, optFns ...func(*Options)) (*GetAccessGrantOutput, error) { @@ -97,8 +98,11 @@ type GetAccessGrantOutput struct { // The type of permission that was granted in the access grant. Can be one of the // following values: + // // - READ – Grant read-only access to the S3 data. + // // - WRITE – Grant write-only access to the S3 data. + // // - READWRITE – Grant both read and write access to the S3 data. Permission types.Permission diff --git a/service/s3control/api_op_GetAccessGrantsInstance.go b/service/s3control/api_op_GetAccessGrantsInstance.go index cde0523bdd3..ababca5991b 100644 --- a/service/s3control/api_op_GetAccessGrantsInstance.go +++ b/service/s3control/api_op_GetAccessGrantsInstance.go @@ -17,6 +17,7 @@ import ( ) // Retrieves the S3 Access Grants instance for a Region in your account. +// // Permissions You must have the s3:GetAccessGrantsInstance permission to use this // operation. func (c *Client) GetAccessGrantsInstance(ctx context.Context, params *GetAccessGrantsInstanceInput, optFns ...func(*Options)) (*GetAccessGrantsInstanceOutput, error) { diff --git a/service/s3control/api_op_GetAccessGrantsInstanceForPrefix.go b/service/s3control/api_op_GetAccessGrantsInstanceForPrefix.go index eacb9a928d5..2348d1cd495 100644 --- a/service/s3control/api_op_GetAccessGrantsInstanceForPrefix.go +++ b/service/s3control/api_op_GetAccessGrantsInstanceForPrefix.go @@ -16,10 +16,13 @@ import ( ) // Retrieve the S3 Access Grants instance that contains a particular prefix. +// // Permissions You must have the s3:GetAccessGrantsInstanceForPrefix permission -// for the caller account to use this operation. Additional Permissions The prefix -// owner account must grant you the following permissions to their S3 Access Grants -// instance: s3:GetAccessGrantsInstanceForPrefix . +// for the caller account to use this operation. +// +// Additional Permissions The prefix owner account must grant you the following +// permissions to their S3 Access Grants instance: +// s3:GetAccessGrantsInstanceForPrefix . func (c *Client) GetAccessGrantsInstanceForPrefix(ctx context.Context, params *GetAccessGrantsInstanceForPrefixInput, optFns ...func(*Options)) (*GetAccessGrantsInstanceForPrefixOutput, error) { if params == nil { params = &GetAccessGrantsInstanceForPrefixInput{} diff --git a/service/s3control/api_op_GetAccessGrantsInstanceResourcePolicy.go b/service/s3control/api_op_GetAccessGrantsInstanceResourcePolicy.go index 9f463d31579..8039bba5f43 100644 --- a/service/s3control/api_op_GetAccessGrantsInstanceResourcePolicy.go +++ b/service/s3control/api_op_GetAccessGrantsInstanceResourcePolicy.go @@ -16,9 +16,10 @@ import ( "time" ) -// Returns the resource policy of the S3 Access Grants instance. Permissions You -// must have the s3:GetAccessGrantsInstanceResourcePolicy permission to use this -// operation. +// Returns the resource policy of the S3 Access Grants instance. +// +// Permissions You must have the s3:GetAccessGrantsInstanceResourcePolicy +// permission to use this operation. func (c *Client) GetAccessGrantsInstanceResourcePolicy(ctx context.Context, params *GetAccessGrantsInstanceResourcePolicyInput, optFns ...func(*Options)) (*GetAccessGrantsInstanceResourcePolicyOutput, error) { if params == nil { params = &GetAccessGrantsInstanceResourcePolicyInput{} diff --git a/service/s3control/api_op_GetAccessGrantsLocation.go b/service/s3control/api_op_GetAccessGrantsLocation.go index 7d67ce20620..85baf8fd9f0 100644 --- a/service/s3control/api_op_GetAccessGrantsLocation.go +++ b/service/s3control/api_op_GetAccessGrantsLocation.go @@ -17,8 +17,10 @@ import ( ) // Retrieves the details of a particular location registered in your S3 Access -// Grants instance. Permissions You must have the s3:GetAccessGrantsLocation -// permission to use this operation. +// Grants instance. +// +// Permissions You must have the s3:GetAccessGrantsLocation permission to use this +// operation. func (c *Client) GetAccessGrantsLocation(ctx context.Context, params *GetAccessGrantsLocationInput, optFns ...func(*Options)) (*GetAccessGrantsLocationOutput, error) { if params == nil { params = &GetAccessGrantsLocationInput{} diff --git a/service/s3control/api_op_GetAccessPoint.go b/service/s3control/api_op_GetAccessPoint.go index 9ebb3de161a..6d9502af587 100644 --- a/service/s3control/api_op_GetAccessPoint.go +++ b/service/s3control/api_op_GetAccessPoint.go @@ -17,17 +17,29 @@ import ( "time" ) -// This operation is not supported by directory buckets. 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 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) +// This operation is not supported by directory buckets. +// +// 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 endpoint hostname prefix and the x-amz-outpost-id +// derived by using the access point ARN, see the [Examples]section. +// +// The following actions are related to GetAccessPoint : +// +// [CreateAccessPoint] +// +// [DeleteAccessPoint] +// +// [ListAccessPoints] +// +// [ListAccessPoints]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html +// [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 +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples func (c *Client) GetAccessPoint(ctx context.Context, params *GetAccessPointInput, optFns ...func(*Options)) (*GetAccessPointOutput, error) { if params == nil { params = &GetAccessPointInput{} @@ -52,10 +64,13 @@ type GetAccessPointInput struct { AccountId *string // The name of the access point whose configuration information you want to - // retrieve. 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 access point accessed in the format + // retrieve. + // + // 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 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 @@ -102,21 +117,26 @@ type GetAccessPointOutput struct { // 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 - // internet, subject to the access point and bucket access policies. This will - // always be true for an Amazon S3 on Outposts access point + // 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 // 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) - // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on - // Outposts. + // information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"]in + // the Amazon S3 User Guide. + // + // This data type is not supported for Amazon S3 on Outposts. + // + // [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 PublicAccessBlockConfiguration *types.PublicAccessBlockConfiguration // Contains the virtual private cloud (VPC) configuration for the specified access - // point. This element is empty if this access point is an Amazon S3 on Outposts - // access point that is used by other Amazon Web Services. + // point. + // + // This element is empty if this access point is an Amazon S3 on Outposts access + // point that is used by other Amazon Web Services. VpcConfiguration *types.VpcConfiguration // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go b/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go index f4413d9e5b3..077fa4d98a7 100644 --- a/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointConfigurationForObjectLambda.go @@ -16,10 +16,15 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Returns configuration for an Object Lambda Access Point. +// +// The following actions are related to GetAccessPointConfigurationForObjectLambda : +// +// [PutAccessPointConfigurationForObjectLambda] +// +// [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 46ce18919e7..2f41843b229 100644 --- a/service/s3control/api_op_GetAccessPointForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointForObjectLambda.go @@ -17,12 +17,21 @@ import ( "time" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// # Returns configuration information about the specified Object Lambda Access Point +// +// The following actions are related to GetAccessPointForObjectLambda : +// +// [CreateAccessPointForObjectLambda] +// +// [DeleteAccessPointForObjectLambda] +// +// [ListAccessPointsForObjectLambda] +// +// [CreateAccessPointForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html +// [ListAccessPointsForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html +// [DeleteAccessPointForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.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 459ffe69750..df7ea2a14a5 100644 --- a/service/s3control/api_op_GetAccessPointPolicy.go +++ b/service/s3control/api_op_GetAccessPointPolicy.go @@ -15,11 +15,18 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Returns the access point policy associated with the specified access point. +// +// The following actions are related to GetAccessPointPolicy : +// +// [PutAccessPointPolicy] +// +// [DeleteAccessPointPolicy] +// +// [DeleteAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html +// [PutAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html func (c *Client) GetAccessPointPolicy(ctx context.Context, params *GetAccessPointPolicyInput, optFns ...func(*Options)) (*GetAccessPointPolicyOutput, error) { if params == nil { params = &GetAccessPointPolicyInput{} @@ -42,11 +49,13 @@ type GetAccessPointPolicyInput struct { // This member is required. AccountId *string - // The name of the access point whose policy you want to retrieve. 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 access point accessed in the format + // The name of the access point whose policy you want to retrieve. + // + // 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 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 diff --git a/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go b/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go index 645fe178989..2447351a902 100644 --- a/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointPolicyForObjectLambda.go @@ -15,11 +15,18 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Returns the resource policy for an Object Lambda Access Point. +// +// The following actions are related to GetAccessPointPolicyForObjectLambda : +// +// [DeleteAccessPointPolicyForObjectLambda] +// +// [PutAccessPointPolicyForObjectLambda] +// +// [PutAccessPointPolicyForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html +// [DeleteAccessPointPolicyForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.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 3d1da439781..d0db30cbf37 100644 --- a/service/s3control/api_op_GetAccessPointPolicyStatus.go +++ b/service/s3control/api_op_GetAccessPointPolicyStatus.go @@ -16,11 +16,13 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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. +// This operation is not supported by directory buckets. +// +// 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]in the Amazon S3 User Guide. +// +// [Managing Data Access with Amazon S3 access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html 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 5be60d6e3f7..59837508e19 100644 --- a/service/s3control/api_op_GetAccessPointPolicyStatusForObjectLambda.go +++ b/service/s3control/api_op_GetAccessPointPolicyStatusForObjectLambda.go @@ -16,8 +16,10 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Returns the status of the -// resource policy associated with an Object Lambda Access Point. +// This operation is not supported by directory buckets. +// +// Returns the status of the resource policy associated with an Object Lambda +// Access Point. func (c *Client) GetAccessPointPolicyStatusForObjectLambda(ctx context.Context, params *GetAccessPointPolicyStatusForObjectLambdaInput, optFns ...func(*Options)) (*GetAccessPointPolicyStatusForObjectLambdaOutput, error) { if params == nil { params = &GetAccessPointPolicyStatusForObjectLambdaInput{} @@ -58,8 +60,9 @@ 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) - // in the Amazon S3 User Guide. + // [The Meaning of "Public"]in the Amazon S3 User Guide. + // + // [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 PolicyStatus *types.PolicyStatus // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_GetBucket.go b/service/s3control/api_op_GetBucket.go index a7e27d574f1..d411fa2a58b 100644 --- a/service/s3control/api_op_GetBucket.go +++ b/service/s3control/api_op_GetBucket.go @@ -16,27 +16,40 @@ 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 -// 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) -// 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) +// Gets an Amazon S3 on Outposts bucket. For more information, see [Using Amazon S3 on Outposts] 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]section. +// +// [PutObject] +// +// [CreateBucket] +// +// [DeleteBucket] +// +// [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 +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples func (c *Client) GetBucket(ctx context.Context, params *GetBucketInput, optFns ...func(*Options)) (*GetBucketOutput, error) { if params == nil { params = &GetBucketInput{} @@ -59,10 +72,13 @@ type GetBucketInput struct { // This member is required. AccountId *string - // Specifies the bucket. 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 + // Specifies the bucket. + // + // 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 diff --git a/service/s3control/api_op_GetBucketLifecycleConfiguration.go b/service/s3control/api_op_GetBucketLifecycleConfiguration.go index 22d1657ce76..a7c856dcced 100644 --- a/service/s3control/api_op_GetBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_GetBucketLifecycleConfiguration.go @@ -17,33 +17,48 @@ 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) -// 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 -// 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 +// get an S3 bucket's lifecycle configuration, see [GetBucketLifecycleConfiguration]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]and for information about lifecycle configuration, see [Object Lifecycle Management] +// 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]and [Managing Access Permissions to Your Amazon S3 Resources]. +// +// 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_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples) -// section. GetBucketLifecycleConfiguration has the following special error: +// derived by using the access point ARN, see the [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 // // 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) +// +// [PutBucketLifecycleConfiguration] +// +// [DeleteBucketLifecycleConfiguration] +// +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html +// [Object Lifecycle Management]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.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 +// [GetBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html +// [DeleteBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html +// [Managing Access Permissions to Your Amazon S3 Resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples func (c *Client) GetBucketLifecycleConfiguration(ctx context.Context, params *GetBucketLifecycleConfigurationInput, optFns ...func(*Options)) (*GetBucketLifecycleConfigurationOutput, error) { if params == nil { params = &GetBucketLifecycleConfigurationInput{} @@ -66,13 +81,16 @@ type GetBucketLifecycleConfigurationInput struct { // This member is required. AccountId *string - // The Amazon Resource Name (ARN) of the bucket. 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 + // The Amazon Resource Name (ARN) of the bucket. + // + // 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. // diff --git a/service/s3control/api_op_GetBucketPolicy.go b/service/s3control/api_op_GetBucketPolicy.go index 4c85f759c2b..a14283a95d7 100644 --- a/service/s3control/api_op_GetBucketPolicy.go +++ b/service/s3control/api_op_GetBucketPolicy.go @@ -16,31 +16,50 @@ 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 +// policy for an S3 bucket, see [GetBucketPolicy]in the Amazon S3 API Reference. +// +// Returns the policy of a specified Outposts bucket. For more information, see [Using Amazon S3 on Outposts] +// 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]. +// +// 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) +// derived by using the access point ARN, see the [Examples]section. +// +// The following actions are related to GetBucketPolicy : +// +// [GetObject] +// +// [PutBucketPolicy] +// +// [DeleteBucketPolicy] +// +// [PutBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [DeleteBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html +// [GetBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html +// [GetObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples func (c *Client) GetBucketPolicy(ctx context.Context, params *GetBucketPolicyInput, optFns ...func(*Options)) (*GetBucketPolicyOutput, error) { if params == nil { params = &GetBucketPolicyInput{} @@ -63,10 +82,13 @@ type GetBucketPolicyInput struct { // This member is required. AccountId *string - // Specifies the bucket. 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 + // Specifies the bucket. + // + // 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 diff --git a/service/s3control/api_op_GetBucketReplication.go b/service/s3control/api_op_GetBucketReplication.go index 6d0a5116993..83c829fa6f1 100644 --- a/service/s3control/api_op_GetBucketReplication.go +++ b/service/s3control/api_op_GetBucketReplication.go @@ -17,37 +17,55 @@ import ( ) // 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) -// 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) -// 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) -// section. If you include the Filter element in a replication configuration, you -// 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) -// 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) +// configuration. To get an S3 bucket's replication configuration, see [GetBucketReplication]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]in the Amazon S3 User Guide. For +// information about S3 replication on Outposts configuration, see [Replicating objects for S3 on Outposts]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]and [Managing access to S3 on Outposts bucket] 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]section. +// +// If you include the Filter element in a replication configuration, you 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] in the +// Amazon S3 User Guide. +// +// The following operations are related to GetBucketReplication : +// +// [PutBucketReplication] +// +// [DeleteBucketReplication] +// +// [Replicating objects for S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html +// [Replication failure reasons]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes +// [GetBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html +// [Setting up IAM with S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html +// [Managing access to S3 on Outposts bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html +// [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 +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html#API_control_GetBucketReplication_Examples func (c *Client) GetBucketReplication(ctx context.Context, params *GetBucketReplicationInput, optFns ...func(*Options)) (*GetBucketReplicationOutput, error) { if params == nil { params = &GetBucketReplicationInput{} @@ -70,13 +88,16 @@ type GetBucketReplicationInput struct { // This member is required. AccountId *string - // Specifies the bucket to get the replication information 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 + // Specifies the bucket to get the replication information 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. // diff --git a/service/s3control/api_op_GetBucketTagging.go b/service/s3control/api_op_GetBucketTagging.go index 44ba9311ea7..bdae9dbc9f4 100644 --- a/service/s3control/api_op_GetBucketTagging.go +++ b/service/s3control/api_op_GetBucketTagging.go @@ -17,14 +17,19 @@ 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]in the Amazon S3 API Reference. +// +// Returns the tag set associated with the Outposts bucket. For more information, +// see [Using Amazon S3 on Outposts]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. // // All Amazon S3 on Outposts REST API requests for this action require an @@ -32,10 +37,19 @@ import ( // 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) +// derived by using the access point ARN, see the [Examples]section. +// +// The following actions are related to GetBucketTagging : +// +// [PutBucketTagging] +// +// [DeleteBucketTagging] +// +// [GetBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html +// [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 +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples func (c *Client) GetBucketTagging(ctx context.Context, params *GetBucketTaggingInput, optFns ...func(*Options)) (*GetBucketTaggingOutput, error) { if params == nil { params = &GetBucketTaggingInput{} @@ -58,10 +72,13 @@ type GetBucketTaggingInput struct { // This member is required. AccountId *string - // Specifies the bucket. 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 + // Specifies the bucket. + // + // 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 diff --git a/service/s3control/api_op_GetBucketVersioning.go b/service/s3control/api_op_GetBucketVersioning.go index 09acc54ab70..3ce4d8ed3bd 100644 --- a/service/s3control/api_op_GetBucketVersioning.go +++ b/service/s3control/api_op_GetBucketVersioning.go @@ -17,24 +17,40 @@ 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) -// 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. +// return the versioning state for an S3 bucket, see [GetBucketVersioning]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) -// 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) +// value. +// +// For more information about versioning, see [Versioning] 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]section. +// +// The following operations are related to GetBucketVersioning for S3 on Outposts. +// +// [PutBucketVersioning] +// +// [PutBucketLifecycleConfiguration] +// +// [GetBucketLifecycleConfiguration] +// +// [Versioning]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html +// [PutBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html +// [GetBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples +// [GetBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.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_GetDataAccess.go b/service/s3control/api_op_GetDataAccess.go index c3814b5a0b2..340b76d762a 100644 --- a/service/s3control/api_op_GetDataAccess.go +++ b/service/s3control/api_op_GetDataAccess.go @@ -17,13 +17,18 @@ import ( ) // Returns a temporary access credential from S3 Access Grants to the grantee or -// client application. The temporary credential (https://docs.aws.amazon.com/STS/latest/APIReference/API_Credentials.html) -// is an Amazon Web Services STS token that grants them access to the S3 data. +// client application. The [temporary credential]is an Amazon Web Services STS token that grants them +// access to the S3 data. +// // Permissions You must have the s3:GetDataAccess permission to use this -// operation. Additional Permissions The IAM role that S3 Access Grants assumes -// must have the following permissions specified in the trust policy when -// registering the location: sts:AssumeRole , for directory users or groups -// sts:SetContext , and for IAM users or roles sts:SetSourceIdentity . +// operation. +// +// Additional Permissions The IAM role that S3 Access Grants assumes must have the +// following permissions specified in the trust policy when registering the +// location: sts:AssumeRole , for directory users or groups sts:SetContext , and +// for IAM users or roles sts:SetSourceIdentity . +// +// [temporary credential]: https://docs.aws.amazon.com/STS/latest/APIReference/API_Credentials.html func (c *Client) GetDataAccess(ctx context.Context, params *GetDataAccessInput, optFns ...func(*Options)) (*GetDataAccessOutput, error) { if params == nil { params = &GetDataAccessInput{} @@ -48,8 +53,11 @@ type GetDataAccessInput struct { // The type of permission granted to your S3 data, which can be set to one of the // following values: + // // - READ – Grant read-only access to the S3 data. + // // - WRITE – Grant write-only access to the S3 data. + // // - READWRITE – Grant both read and write access to the S3 data. // // This member is required. @@ -71,8 +79,10 @@ type GetDataAccessInput struct { // The scope of the temporary access credential that S3 Access Grants vends to the // grantee or client application. + // // - Default – The scope of the returned temporary access token is the scope of // the grant that is closest to the target scope. + // // - Minimal – The scope of the returned temporary access token is the same as // the requested target scope as long as the requested scope is the same as or a // subset of the grant scope. diff --git a/service/s3control/api_op_GetJobTagging.go b/service/s3control/api_op_GetJobTagging.go index 42fa86a28d7..650ad9ddb6e 100644 --- a/service/s3control/api_op_GetJobTagging.go +++ b/service/s3control/api_op_GetJobTagging.go @@ -16,14 +16,24 @@ import ( "strings" ) -// Returns the tags on an S3 Batch Operations job. Permissions 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) -// 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) +// Returns the tags on an S3 Batch Operations job. +// +// Permissions 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] in the Amazon +// S3 User Guide. +// +// Related actions include: +// +// [CreateJob] +// +// [PutJobTagging] +// +// [DeleteJobTagging] +// +// [DeleteJobTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html +// [Controlling access and labeling jobs using tags]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags +// [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 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 3538a562112..11c47c7f75b 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPoint.go +++ b/service/s3control/api_op_GetMultiRegionAccessPoint.go @@ -16,17 +16,29 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region -// Access Point restrictions and limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// This operation is not supported by directory buckets. +// +// 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 working with Multi-Region Access +// Points, see [Multi-Region Access Point restrictions and limitations]in the Amazon S3 User Guide. +// +// The following actions are related to GetMultiRegionAccessPoint : +// +// [CreateMultiRegionAccessPoint] +// +// [DeleteMultiRegionAccessPoint] +// +// [DescribeMultiRegionAccessPointOperation] +// +// [ListMultiRegionAccessPoints] +// +// [DeleteMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html +// [ListMultiRegionAccessPoints]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html +// [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html +// [CreateMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) GetMultiRegionAccessPoint(ctx context.Context, params *GetMultiRegionAccessPointInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointOutput, error) { if params == nil { params = &GetMultiRegionAccessPointInput{} @@ -53,9 +65,9 @@ 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 Rules for naming Amazon S3 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. + // of an Multi-Region Access Point, see [Rules for naming Amazon S3 Multi-Region Access Points]in the Amazon S3 User Guide. + // + // [Rules for naming Amazon S3 Multi-Region Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming // // This member is required. Name *string diff --git a/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go b/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go index 734b7720e70..2038508deaa 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go +++ b/service/s3control/api_op_GetMultiRegionAccessPointPolicy.go @@ -16,15 +16,23 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region -// Access Point restrictions and limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// This operation is not supported by directory buckets. +// +// 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 working with Multi-Region Access +// Points, see [Multi-Region Access Point restrictions and limitations]in the Amazon S3 User Guide. +// +// The following actions are related to GetMultiRegionAccessPointPolicy : +// +// [GetMultiRegionAccessPointPolicyStatus] +// +// [PutMultiRegionAccessPointPolicy] +// +// [PutMultiRegionAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html +// [GetMultiRegionAccessPointPolicyStatus]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) GetMultiRegionAccessPointPolicy(ctx context.Context, params *GetMultiRegionAccessPointPolicyInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointPolicyOutput, error) { if params == nil { params = &GetMultiRegionAccessPointPolicyInput{} @@ -50,9 +58,10 @@ 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 Rules for - // naming Amazon S3 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. + // between the name and the alias of an Multi-Region Access Point, see [Rules for naming Amazon S3 Multi-Region Access Points]in the + // Amazon S3 User Guide. + // + // [Rules for naming Amazon S3 Multi-Region Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming // // This member is required. Name *string diff --git a/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go b/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go index acd77a1d87e..77886797438 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go +++ b/service/s3control/api_op_GetMultiRegionAccessPointPolicyStatus.go @@ -16,15 +16,24 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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 working with Multi-Region -// Access Points, see Multi-Region Access Point restrictions and limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// This operation is not supported by directory buckets. +// +// 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 working with Multi-Region Access +// Points, see [Multi-Region Access Point restrictions and limitations]in the Amazon S3 User Guide. +// +// The following actions are related to GetMultiRegionAccessPointPolicyStatus : +// +// [GetMultiRegionAccessPointPolicy] +// +// [PutMultiRegionAccessPointPolicy] +// +// [PutMultiRegionAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPointPolicy.html +// [GetMultiRegionAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) GetMultiRegionAccessPointPolicyStatus(ctx context.Context, params *GetMultiRegionAccessPointPolicyStatusInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointPolicyStatusOutput, error) { if params == nil { params = &GetMultiRegionAccessPointPolicyStatusInput{} @@ -50,9 +59,10 @@ 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 Rules for - // naming Amazon S3 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. + // between the name and the alias of an Multi-Region Access Point, see [Rules for naming Amazon S3 Multi-Region Access Points]in the + // Amazon S3 User Guide. + // + // [Rules for naming Amazon S3 Multi-Region Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming // // This member is required. Name *string @@ -69,8 +79,9 @@ 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) - // in the Amazon S3 User Guide. + // [The Meaning of "Public"]in the Amazon S3 User Guide. + // + // [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 Established *types.PolicyStatus // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go b/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go index d2664d8a99d..ef1226dea0d 100644 --- a/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go +++ b/service/s3control/api_op_GetMultiRegionAccessPointRoutes.go @@ -16,15 +16,23 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Returns the routing -// configuration for a Multi-Region Access Point, indicating 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: +// This operation is not supported by directory buckets. +// +// Returns the routing configuration for a Multi-Region Access Point, indicating +// 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 func (c *Client) GetMultiRegionAccessPointRoutes(ctx context.Context, params *GetMultiRegionAccessPointRoutesInput, optFns ...func(*Options)) (*GetMultiRegionAccessPointRoutesOutput, error) { if params == nil { diff --git a/service/s3control/api_op_GetPublicAccessBlock.go b/service/s3control/api_op_GetPublicAccessBlock.go index f806493aaf1..a4b4256c1e0 100644 --- a/service/s3control/api_op_GetPublicAccessBlock.go +++ b/service/s3control/api_op_GetPublicAccessBlock.go @@ -16,12 +16,20 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Retrieves the PublicAccessBlock configuration for an Amazon Web Services +// account. For more information, see [Using Amazon S3 block public access]. +// +// Related actions include: +// +// [DeletePublicAccessBlock] +// +// [PutPublicAccessBlock] +// +// [PutPublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutPublicAccessBlock.html +// [DeletePublicAccessBlock]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeletePublicAccessBlock.html +// [Using Amazon S3 block public access]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.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 84ac96a72e0..d57a9c0d675 100644 --- a/service/s3control/api_op_GetStorageLensConfiguration.go +++ b/service/s3control/api_op_GetStorageLensConfiguration.go @@ -16,15 +16,19 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// 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) +// This operation is not supported by directory buckets. +// +// Gets the Amazon S3 Storage Lens configuration. For more information, see [Assessing your storage activity and usage with Amazon S3 Storage Lens] in +// the Amazon S3 User Guide. For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary] // 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] in the Amazon +// S3 User Guide. +// +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html +// [Assessing your storage activity and usage with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html func (c *Client) GetStorageLensConfiguration(ctx context.Context, params *GetStorageLensConfigurationInput, optFns ...func(*Options)) (*GetStorageLensConfigurationOutput, error) { if params == nil { params = &GetStorageLensConfigurationInput{} diff --git a/service/s3control/api_op_GetStorageLensConfigurationTagging.go b/service/s3control/api_op_GetStorageLensConfigurationTagging.go index 59ccb51f883..55801171da5 100644 --- a/service/s3control/api_op_GetStorageLensConfigurationTagging.go +++ b/service/s3control/api_op_GetStorageLensConfigurationTagging.go @@ -16,13 +16,17 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// in the Amazon S3 User Guide. +// This operation is not supported by directory buckets. +// +// 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]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] in the +// Amazon S3 User Guide. +// +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html +// [Assessing your storage activity and usage with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html func (c *Client) GetStorageLensConfigurationTagging(ctx context.Context, params *GetStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*GetStorageLensConfigurationTaggingOutput, error) { if params == nil { params = &GetStorageLensConfigurationTaggingInput{} diff --git a/service/s3control/api_op_GetStorageLensGroup.go b/service/s3control/api_op_GetStorageLensGroup.go index 1c287f22f6e..313ab3b6598 100644 --- a/service/s3control/api_op_GetStorageLensGroup.go +++ b/service/s3control/api_op_GetStorageLensGroup.go @@ -16,13 +16,16 @@ import ( "strings" ) -// Retrieves the Storage Lens group configuration details. To use this operation, -// you must have the permission to perform the s3:GetStorageLensGroup action. For -// more information about the required Storage Lens Groups permissions, see -// Setting account permissions to use S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about Storage Lens groups errors, see List of Amazon S3 -// Storage Lens error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList) -// . +// Retrieves the Storage Lens group configuration details. +// +// To use this operation, you must have the permission to perform the +// s3:GetStorageLensGroup action. For more information about the required Storage +// Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [List of Amazon S3 Storage Lens error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList func (c *Client) GetStorageLensGroup(ctx context.Context, params *GetStorageLensGroupInput, optFns ...func(*Options)) (*GetStorageLensGroupOutput, error) { if params == nil { params = &GetStorageLensGroupInput{} @@ -40,13 +43,13 @@ func (c *Client) GetStorageLensGroup(ctx context.Context, params *GetStorageLens type GetStorageLensGroupInput struct { - // The Amazon Web Services account ID associated with the Storage Lens group that + // The Amazon Web Services account ID associated with the Storage Lens group that // you're trying to retrieve the details for. // // This member is required. AccountId *string - // The name of the Storage Lens group that you're trying to retrieve the + // The name of the Storage Lens group that you're trying to retrieve the // configuration details for. // // This member is required. @@ -62,7 +65,7 @@ func (in *GetStorageLensGroupInput) bindEndpointParams(p *EndpointParameters) { type GetStorageLensGroupOutput struct { - // The name of the Storage Lens group that you're trying to retrieve the + // The name of the Storage Lens group that you're trying to retrieve the // configuration details for. StorageLensGroup *types.StorageLensGroup diff --git a/service/s3control/api_op_ListAccessGrants.go b/service/s3control/api_op_ListAccessGrants.go index f0afe657bcf..bd38e980066 100644 --- a/service/s3control/api_op_ListAccessGrants.go +++ b/service/s3control/api_op_ListAccessGrants.go @@ -17,6 +17,7 @@ import ( ) // Returns the list of access grants in your S3 Access Grants instance. +// // Permissions You must have the s3:ListAccessGrants permission to use this // operation. func (c *Client) ListAccessGrants(ctx context.Context, params *ListAccessGrantsInput, optFns ...func(*Options)) (*ListAccessGrantsOutput, error) { @@ -61,7 +62,9 @@ type ListAccessGrantsInput struct { // The type of the grantee to which access has been granted. It can be one of the // following values: + // // - IAM - An IAM user or role. + // // - DIRECTORY_USER - Your corporate directory user. You can use this option if // you have added your corporate identity directory to IAM Identity Center and // associated the IAM Identity Center instance with your S3 Access Grants instance. @@ -83,8 +86,11 @@ type ListAccessGrantsInput struct { // The type of permission granted to your S3 data, which can be set to one of the // following values: + // // - READ – Grant read-only access to the S3 data. + // // - WRITE – Grant write-only access to the S3 data. + // // - READWRITE – Grant both read and write access to the S3 data. Permission types.Permission diff --git a/service/s3control/api_op_ListAccessGrantsInstances.go b/service/s3control/api_op_ListAccessGrantsInstances.go index bf32d9f2f51..24f74c8f57e 100644 --- a/service/s3control/api_op_ListAccessGrantsInstances.go +++ b/service/s3control/api_op_ListAccessGrantsInstances.go @@ -18,8 +18,10 @@ import ( // Returns a list of S3 Access Grants instances. An S3 Access Grants instance // serves as a logical grouping for your individual access grants. You can only -// have one S3 Access Grants instance per Region per account. Permissions You must -// have the s3:ListAccessGrantsInstances permission to use this operation. +// have one S3 Access Grants instance per Region per account. +// +// Permissions You must have the s3:ListAccessGrantsInstances permission to use +// this operation. func (c *Client) ListAccessGrantsInstances(ctx context.Context, params *ListAccessGrantsInstancesInput, optFns ...func(*Options)) (*ListAccessGrantsInstancesOutput, error) { if params == nil { params = &ListAccessGrantsInstancesInput{} diff --git a/service/s3control/api_op_ListAccessGrantsLocations.go b/service/s3control/api_op_ListAccessGrantsLocations.go index 1a0dc16936b..c6602148b2a 100644 --- a/service/s3control/api_op_ListAccessGrantsLocations.go +++ b/service/s3control/api_op_ListAccessGrantsLocations.go @@ -17,6 +17,7 @@ import ( ) // Returns a list of the locations registered in your S3 Access Grants instance. +// // Permissions You must have the s3:ListAccessGrantsLocations permission to use // this operation. func (c *Client) ListAccessGrantsLocations(ctx context.Context, params *ListAccessGrantsLocationsInput, optFns ...func(*Options)) (*ListAccessGrantsLocationsOutput, error) { diff --git a/service/s3control/api_op_ListAccessPoints.go b/service/s3control/api_op_ListAccessPoints.go index b2c7de4c49f..0dfb6e49e8a 100644 --- a/service/s3control/api_op_ListAccessPoints.go +++ b/service/s3control/api_op_ListAccessPoints.go @@ -16,22 +16,34 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]section. +// +// The following actions are related to ListAccessPoints : +// +// [CreateAccessPoint] +// +// [DeleteAccessPoint] +// +// [GetAccessPoint] +// +// [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 +// [DeleteAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples func (c *Client) ListAccessPoints(ctx context.Context, params *ListAccessPointsInput, optFns ...func(*Options)) (*ListAccessPointsOutput, error) { if params == nil { params = &ListAccessPointsInput{} @@ -55,13 +67,16 @@ type ListAccessPointsInput struct { // This member is required. AccountId *string - // The name of the bucket whose associated access points you want to list. 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 + // The name of the bucket whose associated access points you want to list. + // + // 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. Bucket *string diff --git a/service/s3control/api_op_ListAccessPointsForObjectLambda.go b/service/s3control/api_op_ListAccessPointsForObjectLambda.go index ce00790cd3e..f01a556ccb8 100644 --- a/service/s3control/api_op_ListAccessPointsForObjectLambda.go +++ b/service/s3control/api_op_ListAccessPointsForObjectLambda.go @@ -16,15 +16,24 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Returns some or all (up -// to 1,000) access points associated with the Object 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) +// This operation is not supported by directory buckets. +// +// Returns some or all (up to 1,000) access points associated with the Object +// 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] +// +// [DeleteAccessPointForObjectLambda] +// +// [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 +// [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{} diff --git a/service/s3control/api_op_ListJobs.go b/service/s3control/api_op_ListJobs.go index a023cc451dc..04ca7f794df 100644 --- a/service/s3control/api_op_ListJobs.go +++ b/service/s3control/api_op_ListJobs.go @@ -18,14 +18,26 @@ import ( // Lists current S3 Batch Operations jobs as well as the jobs that have ended // within the last 90 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. Permissions To use the ListJobs operation, you -// must have permission to perform the s3:ListJobs action. 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) +// For more information, see [S3 Batch Operations]in the Amazon S3 User Guide. +// +// Permissions To use the ListJobs operation, you must have permission to perform +// the s3:ListJobs action. +// +// Related actions include: +// +// [CreateJob] +// +// [DescribeJob] +// +// [UpdateJobPriority] +// +// [UpdateJobStatus] +// +// [DescribeJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html +// [S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html +// [UpdateJobPriority]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html +// [CreateJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.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{} diff --git a/service/s3control/api_op_ListMultiRegionAccessPoints.go b/service/s3control/api_op_ListMultiRegionAccessPoints.go index d644775265a..30d272461d1 100644 --- a/service/s3control/api_op_ListMultiRegionAccessPoints.go +++ b/service/s3control/api_op_ListMultiRegionAccessPoints.go @@ -16,20 +16,32 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Returns a list of the -// Multi-Region Access Points currently associated with the specified Amazon Web -// Services account. Each call can return up to 100 Multi-Region Access Points, the -// maximum number of Multi-Region Access Points 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 working with -// Multi-Region Access Points, see Multi-Region Access Point restrictions and -// limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// This operation is not supported by directory buckets. +// +// Returns a list of the Multi-Region Access Points currently associated with the +// specified Amazon Web Services account. Each call can return up to 100 +// Multi-Region Access Points, the maximum number of Multi-Region Access Points +// 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 working with Multi-Region Access +// Points, see [Multi-Region Access Point restrictions and limitations]in the Amazon S3 User Guide. +// +// The following actions are related to ListMultiRegionAccessPoint : +// +// [CreateMultiRegionAccessPoint] +// +// [DeleteMultiRegionAccessPoint] +// +// [DescribeMultiRegionAccessPointOperation] +// +// [GetMultiRegionAccessPoint] +// +// [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 +// [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html +// [CreateMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) ListMultiRegionAccessPoints(ctx context.Context, params *ListMultiRegionAccessPointsInput, optFns ...func(*Options)) (*ListMultiRegionAccessPointsOutput, error) { if params == nil { params = &ListMultiRegionAccessPointsInput{} diff --git a/service/s3control/api_op_ListRegionalBuckets.go b/service/s3control/api_op_ListRegionalBuckets.go index 6546859c880..0f0e373efc2 100644 --- a/service/s3control/api_op_ListRegionalBuckets.go +++ b/service/s3control/api_op_ListRegionalBuckets.go @@ -16,13 +16,18 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// section. +// This operation is not supported by directory buckets. +// +// 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]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]section. +// +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples func (c *Client) ListRegionalBuckets(ctx context.Context, params *ListRegionalBucketsInput, optFns ...func(*Options)) (*ListRegionalBucketsOutput, error) { if params == nil { params = &ListRegionalBucketsInput{} @@ -51,8 +56,9 @@ type ListRegionalBucketsInput struct { // NextToken *string - // The ID of the Outposts resource. This ID is required by Amazon S3 on Outposts - // buckets. + // The ID of the Outposts resource. + // + // This ID is required by Amazon S3 on Outposts buckets. OutpostId *string noSmithyDocumentSerde diff --git a/service/s3control/api_op_ListStorageLensConfigurations.go b/service/s3control/api_op_ListStorageLensConfigurations.go index f27c1e9a50b..83c170bcddc 100644 --- a/service/s3control/api_op_ListStorageLensConfigurations.go +++ b/service/s3control/api_op_ListStorageLensConfigurations.go @@ -16,13 +16,17 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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. +// This operation is not supported by directory buckets. +// +// 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]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] in the +// Amazon S3 User Guide. +// +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html +// [Assessing your storage activity and usage with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html func (c *Client) ListStorageLensConfigurations(ctx context.Context, params *ListStorageLensConfigurationsInput, optFns ...func(*Options)) (*ListStorageLensConfigurationsOutput, error) { if params == nil { params = &ListStorageLensConfigurationsInput{} diff --git a/service/s3control/api_op_ListStorageLensGroups.go b/service/s3control/api_op_ListStorageLensGroups.go index b81e72af751..a8586b2f4d7 100644 --- a/service/s3control/api_op_ListStorageLensGroups.go +++ b/service/s3control/api_op_ListStorageLensGroups.go @@ -16,13 +16,16 @@ import ( "strings" ) -// Lists all the Storage Lens groups in the specified home Region. To use this -// operation, you must have the permission to perform the s3:ListStorageLensGroups -// action. For more information about the required Storage Lens Groups permissions, -// see Setting account permissions to use S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about Storage Lens groups errors, see List of Amazon S3 -// Storage Lens error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList) -// . +// Lists all the Storage Lens groups in the specified home Region. +// +// To use this operation, you must have the permission to perform the +// s3:ListStorageLensGroups action. For more information about the required Storage +// Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [List of Amazon S3 Storage Lens error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList func (c *Client) ListStorageLensGroups(ctx context.Context, params *ListStorageLensGroupsInput, optFns ...func(*Options)) (*ListStorageLensGroupsOutput, error) { if params == nil { params = &ListStorageLensGroupsInput{} @@ -40,7 +43,7 @@ func (c *Client) ListStorageLensGroups(ctx context.Context, params *ListStorageL type ListStorageLensGroupsInput struct { - // The Amazon Web Services account ID that owns the Storage Lens groups. + // The Amazon Web Services account ID that owns the Storage Lens groups. // // This member is required. AccountId *string @@ -58,13 +61,13 @@ func (in *ListStorageLensGroupsInput) bindEndpointParams(p *EndpointParameters) type ListStorageLensGroupsOutput struct { - // If NextToken is returned, there are more Storage Lens groups 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. Each pagination token expires after 24 hours. + // If NextToken is returned, there are more Storage Lens groups 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. Each pagination token expires after 24 hours. NextToken *string - // The list of Storage Lens groups that exist in the specified home Region. + // The list of Storage Lens groups that exist in the specified home Region. StorageLensGroupList []types.ListStorageLensGroupEntry // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_ListTagsForResource.go b/service/s3control/api_op_ListTagsForResource.go index b6ed1f20330..f923d27da51 100644 --- a/service/s3control/api_op_ListTagsForResource.go +++ b/service/s3control/api_op_ListTagsForResource.go @@ -19,16 +19,23 @@ import ( // This operation allows you to list all the Amazon Web Services resource tags for // a specified resource. Each tag is a label consisting of a user-defined key and // value. Tags can help you manage, identify, organize, search for, and filter -// resources. Permissions You must have the s3:ListTagsForResource permission to -// use this operation. This operation is only supported for S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html) -// and for S3 Access Grants (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html) -// . The tagged resource can be an S3 Storage Lens group or S3 Access Grants -// instance, registered location, or grant. For more information about the required -// Storage Lens Groups permissions, see Setting account permissions to use S3 -// Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about S3 Tagging errors, see List of Amazon S3 Tagging error -// codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList) -// . +// resources. +// +// Permissions You must have the s3:ListTagsForResource permission to use this +// operation. +// +// This operation is only supported for [S3 Storage Lens groups] and for [S3 Access Grants]. The tagged resource can be an +// S3 Storage Lens group or S3 Access Grants instance, registered location, or +// grant. +// +// For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about S3 Tagging errors, see [List of Amazon S3 Tagging error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [S3 Access Grants]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html +// [List of Amazon S3 Tagging error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList +// [S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} @@ -46,12 +53,12 @@ func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForRes type ListTagsForResourceInput struct { - // The Amazon Web Services account ID of the resource owner. + // The Amazon Web Services account ID of the resource owner. // // This member is required. AccountId *string - // The Amazon Resource Name (ARN) of the S3 resource that you want to list the + // The Amazon Resource Name (ARN) of the S3 resource that you want to list the // tags for. The tagged resource can be an S3 Storage Lens group or S3 Access // Grants instance, registered location, or grant. // @@ -68,7 +75,7 @@ func (in *ListTagsForResourceInput) bindEndpointParams(p *EndpointParameters) { type ListTagsForResourceOutput struct { - // The Amazon Web Services resource tags that are associated with the resource. + // The Amazon Web Services resource tags that are associated with the resource. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_PutAccessGrantsInstanceResourcePolicy.go b/service/s3control/api_op_PutAccessGrantsInstanceResourcePolicy.go index 817b82b1c80..82418823cb7 100644 --- a/service/s3control/api_op_PutAccessGrantsInstanceResourcePolicy.go +++ b/service/s3control/api_op_PutAccessGrantsInstanceResourcePolicy.go @@ -16,9 +16,10 @@ import ( "time" ) -// Updates the resource policy of the S3 Access Grants instance. Permissions You -// must have the s3:PutAccessGrantsInstanceResourcePolicy permission to use this -// operation. +// Updates the resource policy of the S3 Access Grants instance. +// +// Permissions You must have the s3:PutAccessGrantsInstanceResourcePolicy +// permission to use this operation. func (c *Client) PutAccessGrantsInstanceResourcePolicy(ctx context.Context, params *PutAccessGrantsInstanceResourcePolicyInput, optFns ...func(*Options)) (*PutAccessGrantsInstanceResourcePolicyOutput, error) { if params == nil { params = &PutAccessGrantsInstanceResourcePolicyInput{} diff --git a/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go b/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go index 77000b4c715..a1d3220ef7c 100644 --- a/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go +++ b/service/s3control/api_op_PutAccessPointConfigurationForObjectLambda.go @@ -16,10 +16,15 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// Replaces configuration for an Object Lambda Access Point. +// +// The following actions are related to PutAccessPointConfigurationForObjectLambda : +// +// [GetAccessPointConfigurationForObjectLambda] +// +// [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 779fde8035c..4d0c939d8bd 100644 --- a/service/s3control/api_op_PutAccessPointPolicy.go +++ b/service/s3control/api_op_PutAccessPointPolicy.go @@ -15,18 +15,28 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Associates an access -// policy with the specified access point. Each access point can have only one -// policy, so a request made to this API replaces any existing 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 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) +// This operation is not supported by directory buckets. +// +// Associates an access policy with the specified access point. Each access point +// can have only one policy, so a request made to this API replaces any existing +// 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 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]section. +// +// The following actions are related to PutAccessPointPolicy : +// +// [GetAccessPointPolicy] +// +// [DeleteAccessPointPolicy] +// +// [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 +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples func (c *Client) PutAccessPointPolicy(ctx context.Context, params *PutAccessPointPolicyInput, optFns ...func(*Options)) (*PutAccessPointPolicyOutput, error) { if params == nil { params = &PutAccessPointPolicyInput{} @@ -51,10 +61,13 @@ type PutAccessPointPolicyInput struct { AccountId *string // The name of the access point that you want to associate with the specified - // policy. 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 access point accessed in the format + // policy. + // + // 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 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 @@ -65,9 +78,9 @@ type PutAccessPointPolicyInput struct { 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]in the Amazon S3 User Guide. + // + // [Managing data access with Amazon S3 access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html // // This member is required. Policy *string diff --git a/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go b/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go index 8212d87016d..c02a3a9f26f 100644 --- a/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go +++ b/service/s3control/api_op_PutAccessPointPolicyForObjectLambda.go @@ -15,13 +15,20 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// 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) +// This operation is not supported by directory buckets. +// +// Creates or replaces resource policy for an Object Lambda Access Point. For an +// example policy, see [Creating Object Lambda Access Points]in the Amazon S3 User Guide. +// +// The following actions are related to PutAccessPointPolicyForObjectLambda : +// +// [DeleteAccessPointPolicyForObjectLambda] +// +// [GetAccessPointPolicyForObjectLambda] +// +// [Creating Object Lambda Access Points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli +// [GetAccessPointPolicyForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html +// [DeleteAccessPointPolicyForObjectLambda]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.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 1061b1c15a9..fb68ce6c61a 100644 --- a/service/s3control/api_op_PutBucketLifecycleConfiguration.go +++ b/service/s3control/api_op_PutBucketLifecycleConfiguration.go @@ -17,21 +17,31 @@ 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) -// 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 -// 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) +// To put a lifecycle configuration to an S3 bucket, see [PutBucketLifecycleConfiguration]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 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]section. +// +// The following actions are related to PutBucketLifecycleConfiguration : +// +// [GetBucketLifecycleConfiguration] +// +// [DeleteBucketLifecycleConfiguration] +// +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html +// [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 +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples 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 cbcb8d9dc57..a155cb20dc1 100644 --- a/service/s3control/api_op_PutBucketPolicy.go +++ b/service/s3control/api_op_PutBucketPolicy.go @@ -16,30 +16,46 @@ 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 -// 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 +// policy on an S3 bucket, see [PutBucketPolicy]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]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]. +// +// 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) +// derived by using the access point ARN, see the [Examples]section. +// +// The following actions are related to PutBucketPolicy : +// +// [GetBucketPolicy] +// +// [DeleteBucketPolicy] +// +// [PutBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html +// [Using Bucket Policies and User Policies]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html +// [DeleteBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html +// [GetBucketPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples func (c *Client) PutBucketPolicy(ctx context.Context, params *PutBucketPolicyInput, optFns ...func(*Options)) (*PutBucketPolicyOutput, error) { if params == nil { params = &PutBucketPolicyInput{} @@ -62,10 +78,13 @@ type PutBucketPolicyInput struct { // This member is required. AccountId *string - // Specifies the bucket. 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 + // Specifies the bucket. + // + // 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 @@ -81,8 +100,9 @@ type PutBucketPolicyInput struct { Policy *string // Set this parameter to true to confirm that you want to remove your permissions - // to change this bucket policy in the future. This is not supported by Amazon S3 - // on Outposts buckets. + // to change this bucket policy in the future. + // + // This is not supported by Amazon S3 on Outposts buckets. ConfirmRemoveSelfBucketAccess bool noSmithyDocumentSerde diff --git a/service/s3control/api_op_PutBucketReplication.go b/service/s3control/api_op_PutBucketReplication.go index 32e78784942..ce808344f65 100644 --- a/service/s3control/api_op_PutBucketReplication.go +++ b/service/s3control/api_op_PutBucketReplication.go @@ -17,61 +17,89 @@ import ( ) // 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) -// 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. Specify the replication -// configuration in the request body. In the replication configuration, you provide -// the following information: +// configuration. To create an S3 bucket's replication configuration, see [PutBucketReplication]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]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. +// +// 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 // // 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 -// of the objects in the source Outposts 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 . 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) -// 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 -// destination Outposts bucket are encrypted with the same encryption key as the -// objects in the source Outposts bucket. Permissions To create a -// PutBucketReplication request, you must have +// subsets of objects to replicate, add a rule for each subset. +// +// To specify a subset of the objects in the source Outposts 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 . +// +// 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]. +// +// For information about S3 on Outposts replication failure reasons, see [Replication failure reasons] 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 destination Outposts bucket are encrypted with the same encryption key as +// the objects in the source Outposts bucket. +// +// # Permissions +// +// To create a 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 -// 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 +// information about permissions, see [Setting up IAM with S3 on Outposts]and [Managing access to S3 on Outposts buckets]. +// +// 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]. +// +// 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_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]section. +// +// The following operations are related to PutBucketReplication : +// +// [GetBucketReplication] +// +// [DeleteBucketReplication] +// +// [Replicating objects for S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html +// [Replication failure reasons]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-eventbridge.html#outposts-replication-failure-codes +// [GetBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketReplication.html +// [Setting up IAM with S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsIAM.html +// [PutBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html +// [Managing access to S3 on Outposts buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html +// [Managing S3 Versioning for your S3 on Outposts bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsManagingVersioning.html +// [DeleteBucketReplication]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketReplication.html +// [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 +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketReplication.html#API_control_PutBucketReplication_Examples func (c *Client) PutBucketReplication(ctx context.Context, params *PutBucketReplicationInput, optFns ...func(*Options)) (*PutBucketReplicationOutput, error) { if params == nil { params = &PutBucketReplicationInput{} @@ -94,13 +122,16 @@ 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 - // 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 + // 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 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. // diff --git a/service/s3control/api_op_PutBucketTagging.go b/service/s3control/api_op_PutBucketTagging.go index 5882f9e2a9f..165863ea4dc 100644 --- a/service/s3control/api_op_PutBucketTagging.go +++ b/service/s3control/api_op_PutBucketTagging.go @@ -17,51 +17,72 @@ 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 -// 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 +// bucket, see [PutBucketTagging]in the Amazon S3 API Reference. +// +// Sets the tags for an S3 on Outposts bucket. For more information, see [Using Amazon S3 on Outposts] 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]. +// +// 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]. +// +// 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]and [Managing access permissions to your Amazon S3 resources]. +// +// 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) -// . +// see [User-Defined Tag Restrictions]and [Amazon Web Services-Generated Cost Allocation Tag Restrictions]. +// // - 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. +// +// - 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) +// derived by using the access point ARN, see the [Examples]section. +// +// The following actions are related to PutBucketTagging : +// +// [GetBucketTagging] +// +// [DeleteBucketTagging] +// +// [GetBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html +// [PutBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html +// [Cost allocation and tagging]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.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 +// [DeleteBucketTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html +// [Using cost allocation in Amazon S3 bucket tags]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html +// [User-Defined Tag Restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html +// [Managing access permissions to your Amazon S3 resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html +// [Using Amazon S3 on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html +// [Amazon Web Services-Generated Cost Allocation Tag Restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples func (c *Client) PutBucketTagging(ctx context.Context, params *PutBucketTaggingInput, optFns ...func(*Options)) (*PutBucketTaggingOutput, error) { if params == nil { params = &PutBucketTaggingInput{} @@ -84,13 +105,16 @@ type PutBucketTaggingInput struct { // This member is required. AccountId *string - // The Amazon Resource Name (ARN) of the bucket. 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 + // The Amazon Resource Name (ARN) of the bucket. + // + // 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. // diff --git a/service/s3control/api_op_PutBucketVersioning.go b/service/s3control/api_op_PutBucketVersioning.go index c81484c7713..8a64d6f2a95 100644 --- a/service/s3control/api_op_PutBucketVersioning.go +++ b/service/s3control/api_op_PutBucketVersioning.go @@ -17,40 +17,57 @@ import ( ) // 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: +// set the versioning state for an S3 bucket, see [PutBucketVersioning]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 . // // 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) -// 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) -// 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) +// that case, a [GetBucketVersioning]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]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]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]section. +// +// The following operations are related to PutBucketVersioning for S3 on Outposts. +// +// [GetBucketVersioning] +// +// [PutBucketLifecycleConfiguration] +// +// [GetBucketLifecycleConfiguration] +// +// [Versioning]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html +// [PutBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html +// [PutBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html +// [Creating and managing a lifecycle configuration for your S3 on Outposts bucket]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html +// [GetBucketLifecycleConfiguration]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html +// [Examples]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples +// [GetBucketVersioning]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html func (c *Client) PutBucketVersioning(ctx context.Context, params *PutBucketVersioningInput, optFns ...func(*Options)) (*PutBucketVersioningOutput, error) { if params == nil { params = &PutBucketVersioningInput{} diff --git a/service/s3control/api_op_PutJobTagging.go b/service/s3control/api_op_PutJobTagging.go index 1834950894e..7e5b718b388 100644 --- a/service/s3control/api_op_PutJobTagging.go +++ b/service/s3control/api_op_PutJobTagging.go @@ -16,39 +16,55 @@ import ( "strings" ) -// Sets the supplied tag-set on an S3 Batch Operations job. A tag is a key-value -// pair. You can associate S3 Batch Operations tags with any job by sending a PUT -// 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 operation 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. +// Sets the supplied tag-set on an S3 Batch Operations job. +// +// A tag is a key-value pair. You can associate S3 Batch Operations tags with any +// job by sending a PUT 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], modify that tag set, and use this +// operation to replace the tag set with the one you modified. For more +// information, see [Controlling access and labeling jobs using 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. +// charged for a Tier 1 Request (PUT). For more information, see [Amazon S3 pricing]. +// +// - For deleting existing tags for your Batch Operations job, a [DeleteJobTagging]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) +// +// - For tagging-related restrictions related to characters and encodings, see [User-Defined Tag Restrictions] // in the Billing and Cost Management User Guide. // // Permissions 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) +// perform the s3:PutJobTagging action. +// +// Related actions include: +// +// [CreateJob] +// +// [GetJobTagging] +// +// [DeleteJobTagging] +// +// [DeleteJobTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html +// [Controlling access and labeling jobs using tags]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags +// [User-Defined Tag Restrictions]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html +// [GetJobTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html +// [CreateJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html +// [Amazon S3 pricing]: http://aws.amazon.com/s3/pricing/ 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 e202beb4210..e45fed556b1 100644 --- a/service/s3control/api_op_PutMultiRegionAccessPointPolicy.go +++ b/service/s3control/api_op_PutMultiRegionAccessPointPolicy.go @@ -16,17 +16,26 @@ import ( "strings" ) -// This operation is not supported by directory buckets. Associates an access -// control policy with the specified Multi-Region Access Point. Each Multi-Region -// Access Point can have only one policy, so a request 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 working with Multi-Region Access -// Points, see Multi-Region Access Point restrictions and limitations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.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) +// This operation is not supported by directory buckets. +// +// Associates an access control policy with the specified Multi-Region Access +// Point. Each Multi-Region Access Point can have only one policy, so a request +// 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 working with Multi-Region Access +// Points, see [Multi-Region Access Point restrictions and limitations]in the Amazon S3 User Guide. +// +// The following actions are related to PutMultiRegionAccessPointPolicy : +// +// [GetMultiRegionAccessPointPolicy] +// +// [GetMultiRegionAccessPointPolicyStatus] +// +// [GetMultiRegionAccessPointPolicyStatus]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicyStatus.html +// [GetMultiRegionAccessPointPolicy]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetMultiRegionAccessPointPolicy.html +// [Multi-Region Access Point restrictions and limitations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html func (c *Client) PutMultiRegionAccessPointPolicy(ctx context.Context, params *PutMultiRegionAccessPointPolicyInput, optFns ...func(*Options)) (*PutMultiRegionAccessPointPolicyOutput, error) { if params == nil { params = &PutMultiRegionAccessPointPolicyInput{} @@ -72,9 +81,10 @@ func (in *PutMultiRegionAccessPointPolicyInput) bindEndpointParams(p *EndpointPa 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) - // to determine the status of asynchronous requests. + // The request token associated with the request. You can use this token with [DescribeMultiRegionAccessPointOperation] to + // determine the status of asynchronous requests. + // + // [DescribeMultiRegionAccessPointOperation]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html RequestTokenARN *string // Metadata pertaining to the operation's result. diff --git a/service/s3control/api_op_PutPublicAccessBlock.go b/service/s3control/api_op_PutPublicAccessBlock.go index cb489f18d4a..8ec4739e0d4 100644 --- a/service/s3control/api_op_PutPublicAccessBlock.go +++ b/service/s3control/api_op_PutPublicAccessBlock.go @@ -16,13 +16,21 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) +// This operation is not supported by directory buckets. +// +// 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]. +// +// Related actions include: +// +// [GetPublicAccessBlock] +// +// [DeletePublicAccessBlock] +// +// [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 +// [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{} diff --git a/service/s3control/api_op_PutStorageLensConfiguration.go b/service/s3control/api_op_PutStorageLensConfiguration.go index acc18b622f9..6256dd4015f 100644 --- a/service/s3control/api_op_PutStorageLensConfiguration.go +++ b/service/s3control/api_op_PutStorageLensConfiguration.go @@ -16,15 +16,19 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// 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) -// in the Amazon S3 User Guide. +// This operation is not supported by directory buckets. +// +// Puts an Amazon S3 Storage Lens configuration. For more information about S3 +// Storage Lens, see [Working with Amazon S3 Storage Lens]in the Amazon S3 User Guide. For a complete list of S3 +// Storage Lens metrics, see [S3 Storage Lens metrics glossary]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] in the Amazon +// S3 User Guide. +// +// [Working with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html func (c *Client) PutStorageLensConfiguration(ctx context.Context, params *PutStorageLensConfigurationInput, optFns ...func(*Options)) (*PutStorageLensConfigurationOutput, error) { if params == nil { params = &PutStorageLensConfigurationInput{} @@ -57,8 +61,9 @@ 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 900b41d4972..accdaf561f4 100644 --- a/service/s3control/api_op_PutStorageLensConfigurationTagging.go +++ b/service/s3control/api_op_PutStorageLensConfigurationTagging.go @@ -16,14 +16,17 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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) -// in the Amazon S3 User Guide. +// This operation is not supported by directory buckets. +// +// 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]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] in the +// Amazon S3 User Guide. +// +// [Setting permissions to use Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html +// [Assessing your storage activity and usage with Amazon S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html func (c *Client) PutStorageLensConfigurationTagging(ctx context.Context, params *PutStorageLensConfigurationTaggingInput, optFns ...func(*Options)) (*PutStorageLensConfigurationTaggingOutput, error) { if params == nil { params = &PutStorageLensConfigurationTaggingInput{} @@ -51,8 +54,9 @@ 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 f2df031c7ba..cc1a3cace8d 100644 --- a/service/s3control/api_op_SubmitMultiRegionAccessPointRoutes.go +++ b/service/s3control/api_op_SubmitMultiRegionAccessPointRoutes.go @@ -16,25 +16,35 @@ import ( "strings" ) -// This operation is not supported by directory buckets. 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 routing configuration is -// changed, any in-progress operations (uploads, copies, deletes, and so on) to -// formerly active Regions will continue to run to their final completion state -// (success or failure). The routing configurations of any Regions that aren’t -// specified remain unchanged. Updated routing configurations might not be -// immediately applied. It can take up to 2 minutes for your changes 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 +// This operation is not supported by directory buckets. +// +// 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 routing configuration is changed, any in-progress operations (uploads, +// copies, deletes, and so on) to formerly active Regions will continue to run to +// their final completion state (success or failure). The routing configurations of +// any Regions that aren’t specified remain unchanged. +// +// Updated routing configurations might not be immediately applied. It can take up +// to 2 minutes for your changes 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 func (c *Client) SubmitMultiRegionAccessPointRoutes(ctx context.Context, params *SubmitMultiRegionAccessPointRoutesInput, optFns ...func(*Options)) (*SubmitMultiRegionAccessPointRoutesOutput, error) { if params == nil { diff --git a/service/s3control/api_op_TagResource.go b/service/s3control/api_op_TagResource.go index acd3c515882..b35c63a025f 100644 --- a/service/s3control/api_op_TagResource.go +++ b/service/s3control/api_op_TagResource.go @@ -16,20 +16,26 @@ import ( "strings" ) -// Creates a new Amazon Web Services resource tag or updates an existing resource +// Creates a new Amazon Web Services resource tag or updates an existing resource +// // tag. Each tag is a label consisting of a user-defined key and value. Tags can // help you manage, identify, organize, search for, and filter resources. You can -// add up to 50 Amazon Web Services resource tags for each S3 resource. This -// operation is only supported for S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html) -// and for S3 Access Grants (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html) -// . The tagged resource can be an S3 Storage Lens group or S3 Access Grants -// instance, registered location, or grant. Permissions You must have the -// s3:TagResource permission to use this operation. For more information about the -// required Storage Lens Groups permissions, see Setting account permissions to -// use S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about S3 Tagging errors, see List of Amazon S3 Tagging error -// codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList) -// . +// add up to 50 Amazon Web Services resource tags for each S3 resource. +// +// This operation is only supported for [S3 Storage Lens groups] and for [S3 Access Grants]. The tagged resource can be an +// S3 Storage Lens group or S3 Access Grants instance, registered location, or +// grant. +// +// Permissions You must have the s3:TagResource permission to use this operation. +// +// For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about S3 Tagging errors, see [List of Amazon S3 Tagging error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [S3 Access Grants]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html +// [List of Amazon S3 Tagging error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList +// [S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -47,7 +53,7 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The Amazon Web Services account ID that created the S3 resource that you're + // The Amazon Web Services account ID that created the S3 resource that you're // trying to add tags to or the requester's account ID. // // This member is required. @@ -60,7 +66,7 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The Amazon Web Services resource tags that you want to add to the specified S3 + // The Amazon Web Services resource tags that you want to add to the specified S3 // resource. // // This member is required. diff --git a/service/s3control/api_op_UntagResource.go b/service/s3control/api_op_UntagResource.go index 6730c8fba30..a61b6c2f13e 100644 --- a/service/s3control/api_op_UntagResource.go +++ b/service/s3control/api_op_UntagResource.go @@ -15,19 +15,26 @@ import ( "strings" ) -// This operation removes the specified Amazon Web Services resource tags from an +// This operation removes the specified Amazon Web Services resource tags from an +// // S3 resource. Each tag is a label consisting of a user-defined key and value. // Tags can help you manage, identify, organize, search for, and filter resources. -// This operation is only supported for S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html) -// and for S3 Access Grants (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html) -// . The tagged resource can be an S3 Storage Lens group or S3 Access Grants -// instance, registered location, or grant. Permissions You must have the -// s3:UntagResource permission to use this operation. For more information about -// the required Storage Lens Groups permissions, see Setting account permissions -// to use S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about S3 Tagging errors, see List of Amazon S3 Tagging error -// codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList) -// . +// +// This operation is only supported for [S3 Storage Lens groups] and for [S3 Access Grants]. The tagged resource can be an +// S3 Storage Lens group or S3 Access Grants instance, registered location, or +// grant. +// +// Permissions You must have the s3:UntagResource permission to use this +// operation. +// +// For more information about the required Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about S3 Tagging errors, see [List of Amazon S3 Tagging error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [S3 Access Grants]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html +// [List of Amazon S3 Tagging error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList +// [S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -45,19 +52,19 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Amazon Web Services account ID that owns the resource that you're trying to - // remove the tags from. + // The Amazon Web Services account ID that owns the resource that you're trying + // to remove the tags from. // // This member is required. AccountId *string - // The Amazon Resource Name (ARN) of the S3 resource that you're trying to remove + // The Amazon Resource Name (ARN) of the S3 resource that you're trying to remove // the tags from. // // This member is required. ResourceArn *string - // The array of tag key-value pairs that you're trying to remove from of the S3 + // The array of tag key-value pairs that you're trying to remove from of the S3 // resource. // // This member is required. diff --git a/service/s3control/api_op_UpdateAccessGrantsLocation.go b/service/s3control/api_op_UpdateAccessGrantsLocation.go index 9f34dc199da..9191901094b 100644 --- a/service/s3control/api_op_UpdateAccessGrantsLocation.go +++ b/service/s3control/api_op_UpdateAccessGrantsLocation.go @@ -16,10 +16,12 @@ import ( "time" ) -// Updates the IAM role of a registered location in your S3 Access Grants -// instance. Permissions You must have the s3:UpdateAccessGrantsLocation -// permission to use this operation. Additional Permissions You must also have the -// following permission: iam:PassRole +// Updates the IAM role of a registered location in your S3 Access Grants instance. +// +// Permissions You must have the s3:UpdateAccessGrantsLocation permission to use +// this operation. +// +// Additional Permissions You must also have the following permission: iam:PassRole func (c *Client) UpdateAccessGrantsLocation(ctx context.Context, params *UpdateAccessGrantsLocationInput, optFns ...func(*Options)) (*UpdateAccessGrantsLocationOutput, error) { if params == nil { params = &UpdateAccessGrantsLocationInput{} @@ -40,13 +42,16 @@ type UpdateAccessGrantsLocationInput struct { // The ID of the registered location that you are updating. S3 Access Grants // assigns this ID when you register the location. S3 Access Grants assigns the ID // default to the default location s3:// and assigns an auto-generated ID to other - // locations that you register. The ID of the registered location to which you are - // granting access. S3 Access Grants assigned this ID when you registered the - // location. S3 Access Grants assigns the ID default to the default location s3:// - // and assigns an auto-generated ID to other locations that you register. If you - // are passing the default location, you cannot create an access grant for the - // entire default location. You must also specify a bucket or a bucket and prefix - // in the Subprefix field. + // locations that you register. + // + // The ID of the registered location to which you are granting access. S3 Access + // Grants assigned this ID when you registered the location. S3 Access Grants + // assigns the ID default to the default location s3:// and assigns an + // auto-generated ID to other locations that you register. + // + // If you are passing the default location, you cannot create an access grant for + // the entire default location. You must also specify a bucket or a bucket and + // prefix in the Subprefix field. // // This member is required. AccessGrantsLocationId *string @@ -72,7 +77,8 @@ func (in *UpdateAccessGrantsLocationInput) bindEndpointParams(p *EndpointParamet type UpdateAccessGrantsLocationOutput struct { - // The Amazon Resource Name (ARN) of the registered location that you are updating. + // The Amazon Resource Name (ARN) of the registered location that you are + // updating. AccessGrantsLocationArn *string // The ID of the registered location to which you are granting access. S3 Access diff --git a/service/s3control/api_op_UpdateJobPriority.go b/service/s3control/api_op_UpdateJobPriority.go index b9fa79b8bd6..81dcdded23c 100644 --- a/service/s3control/api_op_UpdateJobPriority.go +++ b/service/s3control/api_op_UpdateJobPriority.go @@ -16,14 +16,26 @@ 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. Permissions To use the UpdateJobPriority -// operation, you must have permission to perform the s3:UpdateJobPriority action. +// see [S3 Batch Operations]in the Amazon S3 User Guide. +// +// Permissions To use the UpdateJobPriority operation, you must have permission to +// perform the s3:UpdateJobPriority action. +// // 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) +// +// [CreateJob] +// +// [ListJobs] +// +// [DescribeJob] +// +// [UpdateJobStatus] +// +// [DescribeJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html +// [S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html +// [CreateJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html +// [UpdateJobStatus]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html +// [ListJobs]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.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 67c024fc6b8..61bc6b32d1c 100644 --- a/service/s3control/api_op_UpdateJobStatus.go +++ b/service/s3control/api_op_UpdateJobStatus.go @@ -17,15 +17,27 @@ import ( ) // Updates the status for the specified job. Use this operation 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. Permissions To use the UpdateJobStatus operation, -// you must have permission to perform the s3:UpdateJobStatus action. 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) +// you want to run a job or to cancel an existing job. For more information, see [S3 Batch Operations] +// in the Amazon S3 User Guide. +// +// Permissions To use the UpdateJobStatus operation, you must have permission to +// perform the s3:UpdateJobStatus action. +// +// Related actions include: +// +// [CreateJob] +// +// [ListJobs] +// +// [DescribeJob] +// +// [UpdateJobStatus] +// +// [DescribeJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html +// [S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html +// [CreateJob]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html +// [UpdateJobStatus]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html +// [ListJobs]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.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/api_op_UpdateStorageLensGroup.go b/service/s3control/api_op_UpdateStorageLensGroup.go index 15ef352b5f2..37183075e52 100644 --- a/service/s3control/api_op_UpdateStorageLensGroup.go +++ b/service/s3control/api_op_UpdateStorageLensGroup.go @@ -16,13 +16,16 @@ import ( "strings" ) -// Updates the existing Storage Lens group. To use this operation, you must have -// the permission to perform the s3:UpdateStorageLensGroup action. For more -// information about the required Storage Lens Groups permissions, see Setting -// account permissions to use S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions) -// . For information about Storage Lens groups errors, see List of Amazon S3 -// Storage Lens error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList) -// . +// Updates the existing Storage Lens group. +// +// To use this operation, you must have the permission to perform the +// s3:UpdateStorageLensGroup action. For more information about the required +// Storage Lens Groups permissions, see [Setting account permissions to use S3 Storage Lens groups]. +// +// For information about Storage Lens groups errors, see [List of Amazon S3 Storage Lens error codes]. +// +// [Setting account permissions to use S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions +// [List of Amazon S3 Storage Lens error codes]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList func (c *Client) UpdateStorageLensGroup(ctx context.Context, params *UpdateStorageLensGroupInput, optFns ...func(*Options)) (*UpdateStorageLensGroupOutput, error) { if params == nil { params = &UpdateStorageLensGroupInput{} @@ -40,17 +43,17 @@ func (c *Client) UpdateStorageLensGroup(ctx context.Context, params *UpdateStora type UpdateStorageLensGroupInput struct { - // The Amazon Web Services account ID of the Storage Lens group owner. + // The Amazon Web Services account ID of the Storage Lens group owner. // // This member is required. AccountId *string - // The name of the Storage Lens group that you want to update. + // The name of the Storage Lens group that you want to update. // // This member is required. Name *string - // The JSON file that contains the Storage Lens group configuration. + // The JSON file that contains the Storage Lens group configuration. // // This member is required. StorageLensGroup *types.StorageLensGroup diff --git a/service/s3control/doc.go b/service/s3control/doc.go index ca228b17626..5d985ac854f 100644 --- a/service/s3control/doc.go +++ b/service/s3control/doc.go @@ -3,6 +3,7 @@ // Package s3control provides the API client, operations, and parameter types for // AWS S3 Control. // -// Amazon Web Services S3 Control provides access to Amazon S3 control plane +// Amazon Web Services S3 Control provides access to Amazon S3 control plane +// // actions. package s3control diff --git a/service/s3control/options.go b/service/s3control/options.go index a27e36c85e4..eac49826e39 100644 --- a/service/s3control/options.go +++ b/service/s3control/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -111,8 +116,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -157,6 +163,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/s3control/types/enums.go b/service/s3control/types/enums.go index 44bcfc6a70d..f7d0a07afa5 100644 --- a/service/s3control/types/enums.go +++ b/service/s3control/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AsyncOperationName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AsyncOperationName) Values() []AsyncOperationName { return []AsyncOperationName{ "CreateMultiRegionAccessPoint", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for BucketCannedACL. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketCannedACL) Values() []BucketCannedACL { return []BucketCannedACL{ "private", @@ -63,6 +65,7 @@ const ( // 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{ @@ -89,8 +92,9 @@ const ( ) // Values returns all known values for BucketVersioningStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BucketVersioningStatus) Values() []BucketVersioningStatus { return []BucketVersioningStatus{ "Enabled", @@ -108,8 +112,9 @@ const ( // Values returns all known values for DeleteMarkerReplicationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeleteMarkerReplicationStatus) Values() []DeleteMarkerReplicationStatus { return []DeleteMarkerReplicationStatus{ "Enabled", @@ -127,8 +132,9 @@ const ( // Values returns all known values for ExistingObjectReplicationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExistingObjectReplicationStatus) Values() []ExistingObjectReplicationStatus { return []ExistingObjectReplicationStatus{ "Enabled", @@ -145,8 +151,9 @@ const ( ) // Values returns all known values for ExpirationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpirationStatus) Values() []ExpirationStatus { return []ExpirationStatus{ "Enabled", @@ -163,8 +170,9 @@ const ( ) // Values returns all known values for Format. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Format) Values() []Format { return []Format{ "CSV", @@ -180,8 +188,9 @@ const ( ) // Values returns all known values for GeneratedManifestFormat. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeneratedManifestFormat) Values() []GeneratedManifestFormat { return []GeneratedManifestFormat{ "S3InventoryReport_CSV_20211130", @@ -198,8 +207,9 @@ const ( ) // Values returns all known values for GranteeType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GranteeType) Values() []GranteeType { return []GranteeType{ "DIRECTORY_USER", @@ -219,8 +229,9 @@ const ( ) // Values returns all known values for JobManifestFieldName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobManifestFieldName) Values() []JobManifestFieldName { return []JobManifestFieldName{ "Ignore", @@ -239,8 +250,9 @@ const ( ) // Values returns all known values for JobManifestFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobManifestFormat) Values() []JobManifestFormat { return []JobManifestFormat{ "S3BatchOperations_CSV_20180820", @@ -256,8 +268,9 @@ const ( ) // Values returns all known values for JobReportFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobReportFormat) Values() []JobReportFormat { return []JobReportFormat{ "Report_CSV_20180820", @@ -273,8 +286,9 @@ const ( ) // Values returns all known values for JobReportScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobReportScope) Values() []JobReportScope { return []JobReportScope{ "AllTasks", @@ -302,8 +316,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -331,8 +346,9 @@ const ( ) // Values returns all known values for MetricsStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricsStatus) Values() []MetricsStatus { return []MetricsStatus{ "Enabled", @@ -349,8 +365,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -367,8 +384,9 @@ const ( ) // Values returns all known values for MFADeleteStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MFADeleteStatus) Values() []MFADeleteStatus { return []MFADeleteStatus{ "Enabled", @@ -390,8 +408,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MultiRegionAccessPointStatus) Values() []MultiRegionAccessPointStatus { return []MultiRegionAccessPointStatus{ "READY", @@ -412,8 +431,9 @@ const ( ) // Values returns all known values for NetworkOrigin. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkOrigin) Values() []NetworkOrigin { return []NetworkOrigin{ "Internet", @@ -431,8 +451,9 @@ const ( // Values returns all known values for ObjectLambdaAccessPointAliasStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLambdaAccessPointAliasStatus) Values() []ObjectLambdaAccessPointAliasStatus { return []ObjectLambdaAccessPointAliasStatus{ "PROVISIONING", @@ -452,6 +473,7 @@ const ( // Values returns all known values for ObjectLambdaAllowedFeature. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLambdaAllowedFeature) Values() []ObjectLambdaAllowedFeature { return []ObjectLambdaAllowedFeature{ @@ -474,8 +496,9 @@ const ( // Values returns all known values for // ObjectLambdaTransformationConfigurationAction. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectLambdaTransformationConfigurationAction) Values() []ObjectLambdaTransformationConfigurationAction { return []ObjectLambdaTransformationConfigurationAction{ "GetObject", @@ -501,8 +524,9 @@ const ( ) // Values returns all known values for OperationName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationName) Values() []OperationName { return []OperationName{ "LambdaInvoke", @@ -525,8 +549,9 @@ const ( ) // Values returns all known values for OutputSchemaVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputSchemaVersion) Values() []OutputSchemaVersion { return []OutputSchemaVersion{ "V_1", @@ -541,8 +566,9 @@ const ( ) // Values returns all known values for OwnerOverride. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OwnerOverride) Values() []OwnerOverride { return []OwnerOverride{ "Destination", @@ -559,8 +585,9 @@ const ( ) // Values returns all known values for Permission. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Permission) Values() []Permission { return []Permission{ "READ", @@ -578,8 +605,9 @@ const ( ) // Values returns all known values for Privilege. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Privilege) Values() []Privilege { return []Privilege{ "Minimal", @@ -597,6 +625,7 @@ const ( // Values returns all known values for ReplicaModificationsStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReplicaModificationsStatus) Values() []ReplicaModificationsStatus { return []ReplicaModificationsStatus{ @@ -614,8 +643,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Enabled", @@ -634,8 +664,9 @@ const ( ) // Values returns all known values for ReplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStatus) Values() []ReplicationStatus { return []ReplicationStatus{ "COMPLETED", @@ -661,8 +692,9 @@ const ( ) // Values returns all known values for ReplicationStorageClass. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationStorageClass) Values() []ReplicationStorageClass { return []ReplicationStorageClass{ "STANDARD", @@ -686,8 +718,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Enabled", @@ -704,8 +737,9 @@ const ( ) // Values returns all known values for RequestedJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestedJobStatus) Values() []RequestedJobStatus { return []RequestedJobStatus{ "Cancelled", @@ -728,6 +762,7 @@ const ( // Values returns all known values for S3CannedAccessControlList. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (S3CannedAccessControlList) Values() []S3CannedAccessControlList { return []S3CannedAccessControlList{ @@ -752,8 +787,9 @@ const ( ) // Values returns all known values for S3ChecksumAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ChecksumAlgorithm) Values() []S3ChecksumAlgorithm { return []S3ChecksumAlgorithm{ "CRC32", @@ -772,8 +808,9 @@ const ( ) // Values returns all known values for S3GlacierJobTier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3GlacierJobTier) Values() []S3GlacierJobTier { return []S3GlacierJobTier{ "BULK", @@ -791,8 +828,9 @@ const ( ) // Values returns all known values for S3GranteeTypeIdentifier. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3GranteeTypeIdentifier) Values() []S3GranteeTypeIdentifier { return []S3GranteeTypeIdentifier{ "id", @@ -810,8 +848,9 @@ const ( ) // Values returns all known values for S3MetadataDirective. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3MetadataDirective) Values() []S3MetadataDirective { return []S3MetadataDirective{ "COPY", @@ -829,6 +868,7 @@ const ( // Values returns all known values for S3ObjectLockLegalHoldStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (S3ObjectLockLegalHoldStatus) Values() []S3ObjectLockLegalHoldStatus { return []S3ObjectLockLegalHoldStatus{ @@ -846,8 +886,9 @@ const ( ) // Values returns all known values for S3ObjectLockMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ObjectLockMode) Values() []S3ObjectLockMode { return []S3ObjectLockMode{ "COMPLIANCE", @@ -865,6 +906,7 @@ const ( // Values returns all known values for S3ObjectLockRetentionMode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (S3ObjectLockRetentionMode) Values() []S3ObjectLockRetentionMode { return []S3ObjectLockRetentionMode{ @@ -885,8 +927,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -905,8 +948,9 @@ const ( ) // Values returns all known values for S3PrefixType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3PrefixType) Values() []S3PrefixType { return []S3PrefixType{ "Object", @@ -922,8 +966,9 @@ const ( ) // Values returns all known values for S3SSEAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3SSEAlgorithm) Values() []S3SSEAlgorithm { return []S3SSEAlgorithm{ "AES256", @@ -945,8 +990,9 @@ const ( ) // Values returns all known values for S3StorageClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3StorageClass) Values() []S3StorageClass { return []S3StorageClass{ "STANDARD", @@ -969,8 +1015,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SseKmsEncryptedObjectsStatus) Values() []SseKmsEncryptedObjectsStatus { return []SseKmsEncryptedObjectsStatus{ "Enabled", @@ -990,8 +1037,9 @@ const ( ) // Values returns all known values for TransitionStorageClass. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransitionStorageClass) Values() []TransitionStorageClass { return []TransitionStorageClass{ "GLACIER", diff --git a/service/s3control/types/types.go b/service/s3control/types/types.go index 2f0f1a7e685..a00d18a46c2 100644 --- a/service/s3control/types/types.go +++ b/service/s3control/types/types.go @@ -17,8 +17,9 @@ type AbortIncompleteMultipartUpload struct { noSmithyDocumentSerde } -// A container for information about access control for replicas. This is not -// supported by Amazon S3 on Outposts buckets. +// A container for information about access control for replicas. +// +// This is not supported by Amazon S3 on Outposts buckets. type AccessControlTranslation struct { // Specifies the replica ownership. @@ -42,9 +43,11 @@ type AccessGrantsLocationConfiguration struct { // narrow the scope. For example, if the location scope is the default location // s3:// , the S3SubPrefx can be a /*, so the full grant scope path would be // s3:///* . Or the S3SubPrefx can be /* , so the full grant scope path would be or - // s3:///* . If the S3SubPrefix includes a prefix, append the wildcard character * - // after the prefix to indicate that you want to include all object key names in - // the bucket that start with that prefix. + // s3:///* . + // + // If the S3SubPrefix includes a prefix, append the wildcard character * after the + // prefix to indicate that you want to include all object key names in the bucket + // that start with that prefix. S3SubPrefix *string noSmithyDocumentSerde @@ -83,19 +86,22 @@ type AccessPoint struct { BucketAccountId *string // The virtual private cloud (VPC) configuration for this access point, if one - // exists. This element is empty if this access point is an Amazon S3 on Outposts - // access point that is used by other Amazon Web Services. + // exists. + // + // This element is empty if this access point is an Amazon S3 on Outposts access + // point that is used by other Amazon Web Services. VpcConfiguration *VpcConfiguration noSmithyDocumentSerde } // A container element 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. +// +// For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens] in the Amazon S3 User Guide. +// For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary]in the Amazon S3 User Guide. +// +// [Assessing your storage activity and usage with S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html type AccountLevel struct { // A container element for the S3 Storage Lens bucket-level configuration. @@ -115,7 +121,7 @@ type AccountLevel struct { // A container element for detailed status code metrics. DetailedStatusCodesMetrics *DetailedStatusCodesMetrics - // A container element for S3 Storage Lens groups metrics. + // A container element for S3 Storage Lens groups metrics. StorageLensGroupLevel *StorageLensGroupLevel noSmithyDocumentSerde @@ -124,11 +130,13 @@ type AccountLevel struct { // The container element for Amazon S3 Storage Lens activity metrics. Activity // 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) -// in the Amazon S3 User Guide. +// downloaded, and errors. +// +// For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens] in the Amazon S3 User Guide. +// For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary]in the Amazon S3 User Guide. +// +// [Assessing your storage activity and usage with S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html type ActivityMetrics struct { // A container that indicates whether activity metrics are enabled. @@ -140,12 +148,13 @@ type ActivityMetrics struct { // The container element for Amazon S3 Storage Lens advanced cost-optimization // metrics. Advanced cost-optimization metrics provide insights that you can use to // 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) -// in the Amazon S3 User Guide. +// transitions, expirations, and incomplete multipart uploads. +// +// For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens] in the Amazon S3 User Guide. +// For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary]in the Amazon S3 User Guide. +// +// [Assessing your storage activity and usage with S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html type AdvancedCostOptimizationMetrics struct { // A container that indicates whether advanced cost-optimization metrics are @@ -158,11 +167,13 @@ type AdvancedCostOptimizationMetrics struct { // The container element for Amazon S3 Storage Lens advanced data-protection // 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) -// in the Amazon S3 User Guide. +// and across Regions. +// +// For more information about S3 Storage Lens, see [Assessing your storage activity and usage with S3 Storage Lens] in the Amazon S3 User Guide. +// For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary]in the Amazon S3 User Guide. +// +// [Assessing your storage activity and usage with S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html type AdvancedDataProtectionMetrics struct { // A container that indicates whether advanced data-protection metrics are enabled. @@ -216,16 +227,19 @@ 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) - // request. + // A container of the parameters for a [CreateMultiRegionAccessPoint] request. + // + // [CreateMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html CreateMultiRegionAccessPointRequest *CreateMultiRegionAccessPointInput - // A container of the parameters for a DeleteMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html) - // request. + // A container of the parameters for a [DeleteMultiRegionAccessPoint] request. + // + // [DeleteMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html DeleteMultiRegionAccessPointRequest *DeleteMultiRegionAccessPointInput - // A container of the parameters for a PutMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) - // request. + // A container of the parameters for a [PutMultiRegionAccessPoint] request. + // + // [PutMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html PutMultiRegionAccessPointPolicyRequest *PutMultiRegionAccessPointPolicyInput noSmithyDocumentSerde @@ -259,10 +273,11 @@ type AwsLambdaTransformation struct { noSmithyDocumentSerde } -// 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. +// 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] in the Amazon S3 User Guide. +// +// [Assessing your storage activity and usage with S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html type BucketLevel struct { // A container for the bucket-level activity metrics for S3 Storage Lens. @@ -286,9 +301,12 @@ 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) -// in the Amazon S3 User Guide. +// metrics. +// +// For more information about publishing S3 Storage Lens metrics to CloudWatch, +// see [Monitor S3 Storage Lens metrics in CloudWatch]in the Amazon S3 User Guide. +// +// [Monitor S3 Storage Lens metrics in CloudWatch]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html type CloudWatchMetrics struct { // A container that indicates whether CloudWatch publishing for S3 Storage Lens @@ -301,20 +319,24 @@ type CloudWatchMetrics struct { noSmithyDocumentSerde } -// The container for the bucket configuration. This is not supported by Amazon S3 -// on Outposts buckets. +// The container for the bucket configuration. +// +// This is not supported by Amazon S3 on Outposts buckets. type CreateBucketConfiguration struct { // Specifies the Region where the bucket will be created. If you are creating a // bucket on the US East (N. Virginia) Region (us-east-1), you do not need to - // specify the location. This is not supported by Amazon S3 on Outposts buckets. + // specify the location. + // + // This is not supported by Amazon S3 on Outposts buckets. LocationConstraint BucketLocationConstraint noSmithyDocumentSerde } -// A container for the information associated with a CreateMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html) -// request. +// A container for the information associated with a [CreateMultiRegionAccessPoint] request. +// +// [CreateMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html type CreateMultiRegionAccessPointInput struct { // The name of the Multi-Region Access Point associated with this request. @@ -330,10 +352,12 @@ 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) - // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on - // Outposts. + // information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"]in + // the Amazon S3 User Guide. + // + // This data type is not supported for Amazon S3 on Outposts. + // + // [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 PublicAccessBlock *PublicAccessBlockConfiguration noSmithyDocumentSerde @@ -367,9 +391,12 @@ type Credentials struct { // DeleteMarkerReplication element. If your Filter includes a Tag element, the // 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) -// in the Amazon S3 User Guide. +// rules. +// +// For more information about delete marker replication, see [How delete operations affect replication] in the Amazon S3 +// User Guide. +// +// [How delete operations affect replication]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated type DeleteMarkerReplication struct { // Indicates whether to replicate delete markers. @@ -380,8 +407,9 @@ 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) -// request. +// A container for the information associated with a [DeleteMultiRegionAccessPoint] request. +// +// [DeleteMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html type DeleteMultiRegionAccessPointInput struct { // The name of the Multi-Region Access Point associated with this request. @@ -406,31 +434,35 @@ type Destination struct { // destination bucket owners are not the same), and you want to change replica // ownership to the Amazon Web Services account that owns the destination bucket. // If this property is not specified in the replication configuration, the replicas - // are owned by same Amazon Web Services account that owns the source object. This - // is not supported by Amazon S3 on Outposts buckets. + // are owned by same Amazon Web Services account that owns the source object. + // + // This is not supported by Amazon S3 on Outposts buckets. AccessControlTranslation *AccessControlTranslation // The destination bucket owner's account ID. Account *string // A container that provides information about encryption. If - // SourceSelectionCriteria is specified, you must specify this element. This is not - // supported by Amazon S3 on Outposts buckets. + // SourceSelectionCriteria is specified, you must specify this element. + // + // This is not supported by Amazon S3 on Outposts buckets. EncryptionConfiguration *EncryptionConfiguration - // A container that specifies replication metrics-related settings. + // A container that specifies replication metrics-related settings. Metrics *Metrics // A container that specifies S3 Replication Time Control (S3 RTC) settings, // 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. + // // This is not supported by Amazon S3 on Outposts buckets. ReplicationTime *ReplicationTime - // The storage class to use when replicating objects. All objects stored on S3 on + // The storage class to use when replicating objects. All objects stored on S3 on // Outposts are stored in the OUTPOSTS storage class. S3 on Outposts uses the - // OUTPOSTS storage class to create the object replicas. Values other than OUTPOSTS - // aren't supported by Amazon S3 on Outposts. + // OUTPOSTS storage class to create the object replicas. + // + // Values other than OUTPOSTS aren't supported by Amazon S3 on Outposts. StorageClass ReplicationStorageClass noSmithyDocumentSerde @@ -438,12 +470,13 @@ 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) -// in the Amazon S3 User Guide. +// 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] in the Amazon S3 User Guide. +// For a complete list of S3 Storage Lens metrics, see [S3 Storage Lens metrics glossary]in the Amazon S3 User Guide. +// +// [Assessing your storage activity and usage with S3 Storage Lens]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html +// [S3 Storage Lens metrics glossary]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html type DetailedStatusCodesMetrics struct { // A container that indicates whether detailed status code metrics are enabled. @@ -453,23 +486,26 @@ type DetailedStatusCodesMetrics struct { } // Specifies encryption-related information for an Amazon S3 bucket that is a -// destination for replicated objects. This is not supported by Amazon S3 on -// Outposts buckets. +// destination for replicated objects. +// +// This is not supported by Amazon S3 on 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) - // in the Amazon Web Services Key Management Service Developer Guide. + // symmetric encryption KMS keys. For more information, see [Symmetric encryption KMS keys]in the Amazon Web + // Services Key Management Service Developer Guide. + // + // [Symmetric encryption KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks 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 @@ -494,8 +530,9 @@ type Exclude struct { noSmithyDocumentSerde } -// An optional configuration to replicate existing source bucket objects. This is -// not supported by Amazon S3 on Outposts buckets. +// An optional configuration to replicate existing source bucket objects. +// +// This is not supported by Amazon S3 on Outposts buckets. type ExistingObjectReplication struct { // Specifies whether Amazon S3 replicates existing source bucket objects. @@ -536,7 +573,9 @@ type Grantee struct { // The type of the grantee to which access has been granted. It can be one of the // following values: + // // - IAM - An IAM user or role. + // // - DIRECTORY_USER - Your corporate directory user. You can use this option if // you have added your corporate identity directory to IAM Identity Center and // associated the IAM Identity Center instance with your S3 Access Grants instance. @@ -689,9 +728,9 @@ type JobListDescriptor struct { type JobManifest struct { // Contains the information required to locate the specified job's manifest. - // Manifests can't be imported from directory buckets. For more information, see - // Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) - // . + // Manifests can't be imported from directory buckets. For more information, see [Directory buckets]. + // + // [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html // // This member is required. Location *JobManifestLocation @@ -763,8 +802,9 @@ type JobManifestGeneratorFilter struct { } // Contains the information required to locate a manifest object. Manifests can't -// be imported from directory buckets. For more information, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) -// . +// be imported from directory buckets. For more information, see [Directory buckets]. +// +// [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html type JobManifestLocation struct { // The ETag for the specified manifest object. @@ -772,11 +812,13 @@ type JobManifestLocation struct { // This member is required. ETag *string - // 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) - // in the Amazon S3 User Guide. + // 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]in the Amazon S3 User Guide. + // + // [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. ObjectArn *string @@ -804,8 +846,10 @@ 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]in the +// Amazon S3 User Guide. +// +// [Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html type JobOperation struct { // Directs the specified job to invoke an Lambda function on every object in the @@ -813,17 +857,21 @@ type JobOperation struct { LambdaInvoke *LambdaInvokeOperation // Directs the specified job to execute a DELETE Object tagging call on every - // object in the manifest. This functionality is not supported by directory - // buckets. + // object in the manifest. + // + // This functionality is not supported by directory buckets. S3DeleteObjectTagging *S3DeleteObjectTaggingOperation // Directs the specified job to initiate restore requests for every archived - // object in the manifest. This functionality is not supported by directory - // buckets. + // object in the manifest. + // + // This functionality is not supported by directory buckets. S3InitiateRestoreObject *S3InitiateRestoreObjectOperation // Directs the specified job to run a PutObjectAcl call on every object in the - // manifest. This functionality is not supported by directory buckets. + // manifest. + // + // This functionality is not supported by directory buckets. S3PutObjectAcl *S3SetObjectAclOperation // Directs the specified job to run a PUT Copy object call on every object in the @@ -832,26 +880,34 @@ type JobOperation struct { // 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. This functionality is not supported by directory - // buckets. + // PutObjectLegalHold API operation. For more information, see [Using S3 Object Lock legal hold with S3 Batch Operations] in the Amazon S3 + // User Guide. + // + // This functionality is not supported by directory buckets. + // + // [Using S3 Object Lock legal hold with S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html 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) - // in the Amazon S3 User Guide. This functionality is not supported by directory - // buckets. + // underlying PutObjectRetention API operation. For more information, see [Using S3 Object Lock retention with S3 Batch Operations] in the + // Amazon S3 User Guide. + // + // This functionality is not supported by directory buckets. + // + // [Using S3 Object Lock retention with S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html S3PutObjectRetention *S3SetObjectRetentionOperation // Directs the specified job to run a PUT Object tagging call on every object in - // the manifest. This functionality is not supported by directory buckets. + // the manifest. + // + // This functionality is not supported by directory buckets. S3PutObjectTagging *S3SetObjectTaggingOperation // Directs the specified job to invoke ReplicateObject on every object in the - // job's manifest. This functionality is not supported by directory buckets. + // job's manifest. + // + // This functionality is not supported by directory buckets. S3ReplicateObject *S3ReplicateObjectOperation noSmithyDocumentSerde @@ -885,8 +941,10 @@ type JobReport struct { Enabled bool // The Amazon Resource Name (ARN) for the bucket where specified job-completion - // report will be stored. Directory buckets - Directory buckets aren't supported as - // a location for Batch Operations to store job completion reports. + // report will be stored. + // + // Directory buckets - Directory buckets aren't supported as a location for Batch + // Operations to store job completion reports. Bucket *string // The format of the specified job-completion report. @@ -944,22 +1002,25 @@ type LambdaInvokeOperation struct { // invoking an Lambda function. Version 1.0 is the default. Version 2.0 is // required when you use Batch Operations to invoke Lambda functions that act on // directory buckets, or if you need to specify UserArguments . For more - // information, see Automate object processing in Amazon S3 directory buckets with - // S3 Batch Operations and Lambda (https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/) - // in the Amazon Web Services Storage Blog. Ensure that your Lambda function code - // expects InvocationSchemaVersion 2.0 and uses bucket name rather than bucket - // ARN. If the InvocationSchemaVersion does not match what your Lambda function - // expects, your function might not work as expected. Directory buckets - To - // initiate Amazon Web Services Lambda function to perform custom actions on - // objects in directory buckets, you must specify 2.0 . + // information, see [Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda]in the Amazon Web Services Storage Blog. + // + // Ensure that your Lambda function code expects InvocationSchemaVersion 2.0 and + // uses bucket name rather than bucket ARN. If the InvocationSchemaVersion does + // not match what your Lambda function expects, your function might not work as + // expected. + // + // Directory buckets - To initiate Amazon Web Services Lambda function to perform + // custom actions on objects in directory buckets, you must specify 2.0 . + // + // [Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda]: https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/ InvocationSchemaVersion *string // Key-value pairs that are passed in the payload that Batch Operations sends when // invoking an Lambda function. You must specify InvocationSchemaVersion 2.0 for - // LambdaInvoke operations that include UserArguments . For more information, see - // Automate object processing in Amazon S3 directory buckets with S3 Batch - // Operations and Lambda (https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/) + // LambdaInvoke operations that include UserArguments . For more information, see [Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda] // in the Amazon Web Services Storage Blog. + // + // [Automate object processing in Amazon S3 directory buckets with S3 Batch Operations and Lambda]: https://aws.amazon.com/blogs/storage/automate-object-processing-in-amazon-s3-directory-buckets-with-s3-batch-operations-and-aws-lambda/ UserArguments map[string]string noSmithyDocumentSerde @@ -1005,9 +1066,9 @@ 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) - // in the Amazon S3 User Guide. + // information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration]in the Amazon S3 User Guide. + // + // [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 AbortIncompleteMultipartUpload *AbortIncompleteMultipartUpload // Specifies the expiration for the lifecycle of the object in the form of date, @@ -1023,15 +1084,17 @@ type LifecycleRule struct { // The noncurrent version expiration of the lifecycle rule. NoncurrentVersionExpiration *NoncurrentVersionExpiration - // Specifies the transition rule for the lifecycle rule that describes when + // Specifies the transition rule for the lifecycle rule that describes when // noncurrent objects transition to a specific 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 a specific - // storage class at a set period in the object's lifetime. This is not supported by - // Amazon S3 on Outposts buckets. + // storage class at a set period in the object's lifetime. + // + // This is not supported by Amazon S3 on Outposts buckets. NoncurrentVersionTransitions []NoncurrentVersionTransition // Specifies when an Amazon S3 object transitions to a specified storage class. + // // This is not supported by Amazon S3 on Outposts buckets. Transitions []Transition @@ -1073,11 +1136,13 @@ type LifecycleRuleFilter struct { // Maximum object size to which the rule applies. ObjectSizeLessThan *int64 - // 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) - // in the Amazon S3 User Guide. + // 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]in the Amazon S3 User Guide. + // + // [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 for a key-value name pair. @@ -1128,8 +1193,11 @@ type ListAccessGrantEntry struct { // The type of access granted to your S3 data, which can be set to one of the // following values: + // // - READ – Grant read-only access to the S3 data. + // // - WRITE – Grant write-only access to the S3 data. + // // - READWRITE – Grant both read and write access to the S3 data. Permission Permission @@ -1217,23 +1285,24 @@ type ListStorageLensConfigurationEntry struct { noSmithyDocumentSerde } -// Each entry contains a Storage Lens group that exists in the specified home +// Each entry contains a Storage Lens group that exists in the specified home +// // Region. type ListStorageLensGroupEntry struct { - // Contains the Amazon Web Services Region where the Storage Lens group was + // Contains the Amazon Web Services Region where the Storage Lens group was // created. // // This member is required. HomeRegion *string - // Contains the name of the Storage Lens group that exists in the specified home + // Contains the name of the Storage Lens group that exists in the specified home // Region. // // This member is required. Name *string - // Contains the Amazon Resource Name (ARN) of the Storage Lens group. This + // Contains the Amazon Resource Name (ARN) of the Storage Lens group. This // property is read-only. // // This member is required. @@ -1242,30 +1311,32 @@ type ListStorageLensGroupEntry struct { noSmithyDocumentSerde } -// A filter condition that specifies the object age range of included objects in +// A filter condition that specifies the object age range of included objects in +// // days. Only integers are supported. type MatchObjectAge struct { - // Specifies the maximum object age in days. Must be a positive whole number, + // Specifies the maximum object age in days. Must be a positive whole number, // greater than the minimum object age and less than or equal to 2,147,483,647. DaysGreaterThan int32 - // Specifies the minimum object age in days. The value must be a positive whole + // Specifies the minimum object age in days. The value must be a positive whole // number, greater than 0 and less than or equal to 2,147,483,647. DaysLessThan int32 noSmithyDocumentSerde } -// A filter condition that specifies the object size range of included objects in +// A filter condition that specifies the object size range of included objects in +// // bytes. Only integers are supported. type MatchObjectSize struct { - // Specifies the minimum object size in Bytes. The value must be a positive + // Specifies the minimum object size in Bytes. The value must be a positive // number, greater than 0 and less than 5 TB. BytesGreaterThan int64 - // Specifies the maximum object size in Bytes. The value must be a positive + // Specifies the maximum object size in Bytes. The value must be a positive // number, greater than the minimum object size and less than 5 TB. BytesLessThan int64 @@ -1281,18 +1352,20 @@ type Metrics struct { Status MetricsStatus // A container that specifies the time threshold for emitting the - // s3:Replication:OperationMissedThreshold event. This is not supported by Amazon - // S3 on Outposts buckets. + // s3:Replication:OperationMissedThreshold event. + // + // This is not supported by Amazon S3 on Outposts buckets. EventThreshold *ReplicationTimeValue 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 -// established policy. If both policies have the same version number, the proposed -// policy is the established policy. +// 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 { // The last established policy for the Multi-Region Access Point. @@ -1321,9 +1394,10 @@ type MultiRegionAccessPointRegionalResponse struct { 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 - // Rules for naming Amazon S3 Multi-Region Access Points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) + // distinction between the name and the alias of an Multi-Region Access Point, see [Rules for naming Amazon S3 Multi-Region Access Points] // . + // + // [Rules for naming Amazon S3 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. @@ -1334,23 +1408,26 @@ 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) - // in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on - // Outposts. + // information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"]in + // the Amazon S3 User Guide. + // + // This data type is not supported for Amazon S3 on Outposts. + // + // [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 PublicAccessBlock *PublicAccessBlockConfiguration // A collection of the Regions and buckets associated with the Multi-Region Access // Point. Regions []RegionReport - // 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. + // 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. Status MultiRegionAccessPointStatus noSmithyDocumentSerde @@ -1359,21 +1436,28 @@ type MultiRegionAccessPointReport struct { // A structure for a Multi-Region Access Point that indicates where Amazon S3 // traffic can be routed. Routes can be either active or passive. Active routes can // 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 ). +// 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 ). 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 + // 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. // // This member is required. @@ -1408,15 +1492,17 @@ 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) - // in the Amazon S3 User Guide. + // associated action. For more information about noncurrent versions, see [Lifecycle configuration elements]in the + // Amazon S3 User Guide. + // + // [Lifecycle configuration elements]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html 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) - // in the Amazon S3 User Guide. + // calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent]in the Amazon S3 User Guide. + // + // [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 NoncurrentDays int32 noSmithyDocumentSerde @@ -1427,9 +1513,9 @@ 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) - // in the Amazon S3 User Guide. + // calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent]in the Amazon S3 User Guide. + // + // [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 NoncurrentDays int32 // The class of storage used to store the object. @@ -1456,9 +1542,9 @@ 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]. +// +// [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 @@ -1534,8 +1620,9 @@ type ObjectLambdaTransformationConfiguration 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) -// in the Amazon S3 User Guide. +// [The Meaning of "Public"]in the Amazon S3 User Guide. +// +// [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 type PolicyStatus struct { // @@ -1567,11 +1654,12 @@ type PrefixLevelStorageMetrics struct { noSmithyDocumentSerde } -// The proposed access control policy for the 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 proposed access control policy for the 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 ProposedMultiRegionAccessPointPolicy struct { // The details of the proposed policy. @@ -1582,51 +1670,66 @@ 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) -// in the Amazon S3 User Guide. This data type is not supported for Amazon S3 on -// Outposts. +// information about when Amazon S3 considers a bucket or object public, see [The Meaning of "Public"]in +// the Amazon S3 User Guide. +// +// This data type is not supported for Amazon S3 on Outposts. +// +// [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 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. + // + // 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 // this account. 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. This property is not - // supported for Amazon S3 on Outposts. + // PUT Bucket policy if the specified bucket policy allows public access. + // + // Enabling this setting doesn't affect existing bucket policies. + // + // This property is not supported for Amazon S3 on Outposts. 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 - // 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. + // 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. IgnorePublicAcls *bool // Specifies whether Amazon S3 should restrict public bucket policies for buckets // in this account. Setting this element to TRUE restricts access to buckets with // public policies to only Amazon Web Service principals and authorized users - // within this account. Enabling this setting doesn't affect previously stored - // bucket policies, except that public and cross-account access within any public - // bucket policy, including non-public delegation to specific accounts, is blocked. + // within this account. + // + // Enabling this setting doesn't affect previously stored bucket policies, except + // that public and cross-account access within any public bucket policy, including + // non-public delegation to specific accounts, is blocked. + // // This property is not supported for Amazon S3 on Outposts. RestrictPublicBuckets *bool noSmithyDocumentSerde } -// A container for the information associated with a PutMultiRegionAccessPoint (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html) -// request. +// A container for the information associated with a [PutMultiRegionAccessPoint] request. +// +// [PutMultiRegionAccessPoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutMultiRegionAccessPoint.html type PutMultiRegionAccessPointPolicyInput struct { // The name of the Multi-Region Access Point associated with the request. @@ -1707,10 +1810,13 @@ type RegionReport struct { // Outposts replicates metadata from the source objects to the replicas only. When // 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 -// enable replica modification sync on the source and destination buckets to -// replicate replica metadata changes between the source and the replicas. +// bidirectional. +// +// To replicate object metadata modifications on replicas, you can 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 { // Specifies whether S3 on Outposts replicates modifications to object metadata on @@ -1729,8 +1835,9 @@ 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) - // in the Amazon S3 User Guide. + // replication on Outposts configuration, see [Setting up replication]in the Amazon S3 User Guide. + // + // [Setting up replication]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/outposts-replication-how-setup.html // // This member is required. Role *string @@ -1770,13 +1877,17 @@ type ReplicationRule struct { // DeleteMarkerReplication element. If your Filter includes a Tag element, the // 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) - // in the Amazon S3 User Guide. + // rules. + // + // For more information about delete marker replication, see [How delete operations affect replication] in the Amazon S3 + // User Guide. + // + // [How delete operations affect replication]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated DeleteMarkerReplication *DeleteMarkerReplication - // An optional configuration to replicate existing source bucket objects. This is - // not supported by Amazon S3 on Outposts buckets. + // An optional configuration to replicate existing source bucket objects. + // + // This is not supported by Amazon S3 on Outposts buckets. ExistingObjectReplication *ExistingObjectReplication // A filter that identifies the subset of objects to which the replication rule @@ -1789,11 +1900,13 @@ type ReplicationRule struct { // An object key name prefix that identifies the object or objects to which the // rule applies. The maximum prefix length is 1,024 characters. To include all - // 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) - // in the Amazon S3 User Guide. + // 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]in the Amazon S3 User Guide. + // + // [XML-related object key constraints]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints // // Deprecated: Prefix has been deprecated Prefix *string @@ -1803,8 +1916,11 @@ 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) - // in the Amazon S3 User Guide. + // priority. + // + // For more information, see [Creating replication rules on Outposts] in the Amazon S3 User Guide. + // + // [Creating replication rules on Outposts]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-between-outposts.html Priority *int32 // A container that describes additional filters for identifying the source @@ -1817,9 +1933,13 @@ 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: +// 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. type ReplicationRuleAndOperator struct { @@ -1842,17 +1962,22 @@ 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. 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) - // in the Amazon S3 User Guide. + // 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]in the Amazon S3 User Guide. + // + // [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 for a key-value name pair. @@ -1863,8 +1988,9 @@ type ReplicationRuleFilter struct { // A container that specifies 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. This is not supported by Amazon S3 -// on Outposts buckets. +// and operations on objects must be replicated. +// +// This is not supported by Amazon S3 on Outposts buckets. type ReplicationTime struct { // Specifies whether S3 Replication Time Control (S3 RTC) is enabled. @@ -1883,10 +2009,14 @@ type ReplicationTime struct { // A container that specifies the time value for S3 Replication Time Control (S3 // RTC). This value is also used for the replication metrics EventThreshold -// element. This is not supported by Amazon S3 on Outposts buckets. +// element. +// +// This is not supported by Amazon S3 on Outposts buckets. type ReplicationTimeValue struct { - // Contains an integer that specifies the time period in minutes. Valid value: 15 + // Contains an integer that specifies the time period in minutes. + // + // Valid value: 15 Minutes *int32 noSmithyDocumentSerde @@ -1953,8 +2083,9 @@ 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]. +// +// [CopyObject]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html type S3CopyObjectOperation struct { // This functionality is not supported by directory buckets. @@ -1963,17 +2094,21 @@ type S3CopyObjectOperation struct { // Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption // with server-side encryption using Amazon Web Services KMS (SSE-KMS). Setting // this header to true causes Amazon S3 to use an S3 Bucket Key for object - // encryption with SSE-KMS. Specifying this header with an object action doesn’t - // affect bucket-level settings for S3 Bucket Key. This functionality is not - // supported by directory buckets. + // encryption with SSE-KMS. + // + // Specifying this header with an object action doesn’t affect bucket-level + // settings for S3 Bucket Key. + // + // This functionality is not supported by directory buckets. BucketKeyEnabled bool // This functionality is not supported by directory buckets. 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/checking-object-integrity.html) - // in the Amazon S3 User Guide. + // For more information, see [Checking object integrity]in the Amazon S3 User Guide. + // + // [Checking object integrity]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html ChecksumAlgorithm S3ChecksumAlgorithm // @@ -1989,30 +2124,36 @@ type S3CopyObjectOperation struct { // Specifies a list of tags to add to the destination objects after they are // copied. If NewObjectTagging is not specified, the tags of the source objects - // are copied to destination objects by default. Directory buckets - Tags aren't - // supported by directory buckets. If your source objects have tags and your - // destination bucket is a directory bucket, specify an empty tag set in the - // NewObjectTagging field to prevent copying the source object tags to the - // directory bucket. + // are copied to destination objects by default. + // + // Directory buckets - Tags aren't supported by directory buckets. If your source + // objects have tags and your destination bucket is a directory bucket, specify an + // empty tag set in the NewObjectTagging field to prevent copying the source + // object tags to the directory bucket. NewObjectTagging []S3Tag // The legal hold status to be applied to all objects in the Batch Operations job. + // // This functionality is not supported by directory buckets. ObjectLockLegalHoldStatus S3ObjectLockLegalHoldStatus // The retention mode to be applied to all objects in the Batch Operations job. + // // This functionality is not supported by directory buckets. ObjectLockMode S3ObjectLockMode // The date when the applied object retention configuration expires on all objects - // in the Batch Operations job. This functionality is not supported by directory - // buckets. + // in the Batch Operations job. + // + // This functionality is not supported by directory buckets. ObjectLockRetainUntilDate *time.Time // If the destination bucket is configured as a website, specifies an optional // metadata property for website redirects, x-amz-website-redirect-location . // Allows webpage redirects if the object copy is accessed through a website - // endpoint. This functionality is not supported by directory buckets. + // endpoint. + // + // This functionality is not supported by directory buckets. RedirectLocation *string // This functionality is not supported by directory buckets. @@ -2022,6 +2163,7 @@ type S3CopyObjectOperation struct { SSEAwsKmsKeyId *string // Specify the storage class for the destination objects in a Copy operation. + // // Directory buckets - This functionality is not supported by directory buckets. StorageClass S3StorageClass @@ -2032,9 +2174,11 @@ type S3CopyObjectOperation struct { // Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy // operation. + // // - General purpose buckets - For example, to copy objects to a general purpose // bucket named destinationBucket , set the TargetResource property to // arn:aws:s3:::destinationBucket . + // // - Directory buckets - For example, to copy objects to a directory bucket // named destinationBucket in the Availability Zone; identified by the AZ ID // usw2-az1 , set the TargetResource property to @@ -2064,8 +2208,9 @@ type S3GeneratedManifestDescriptor struct { Format GeneratedManifestFormat // Contains the information required to locate a manifest object. Manifests can't - // be imported from directory buckets. For more information, see Directory buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) - // . + // be imported from directory buckets. For more information, see [Directory buckets]. + // + // [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html Location *JobManifestLocation noSmithyDocumentSerde @@ -2098,22 +2243,27 @@ 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]. +// +// [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 // object remains available in Amazon S3. S3 Initiate Restore Object jobs that // target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays - // set to 1 or greater. Conversely, do not set ExpirationInDays when creating S3 - // Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access - // and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive - // access tiers are not subject to restore expiry, so specifying ExpirationInDays - // results in restore request failure. S3 Batch Operations jobs can operate either - // on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 - // Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, - // but not both types in the same job. If you need to restore objects of both types - // you must create separate Batch Operations jobs. + // set to 1 or greater. + // + // Conversely, do not set ExpirationInDays when creating S3 Initiate Restore + // Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive + // Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are + // not subject to restore expiry, so specifying ExpirationInDays results in + // restore request failure. + // + // S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep + // Archive storage class objects or on S3 Intelligent-Tiering Archive Access and + // Deep Archive Access storage tier objects, but not both types in the same job. If + // you need to restore objects of both types you must create separate Batch + // Operations jobs. ExpirationInDays *int32 // S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the @@ -2131,9 +2281,10 @@ type S3JobManifestGenerator struct { // This member is required. EnableManifestOutput bool - // The source bucket used by the ManifestGenerator. Directory buckets - Directory - // buckets aren't supported as the source buckets used by S3JobManifestGenerator - // to generate the job manifest. + // The source bucket used by the ManifestGenerator. + // + // Directory buckets - Directory buckets aren't supported as the source buckets + // used by S3JobManifestGenerator to generate the job manifest. // // This member is required. SourceBucket *string @@ -2149,9 +2300,9 @@ type S3JobManifestGenerator struct { Filter *JobManifestGeneratorFilter // Specifies the location the generated manifest will be written to. Manifests - // can't be written to directory buckets. For more information, see Directory - // buckets (https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) - // . + // can't be written to directory buckets. For more information, see [Directory buckets]. + // + // [Directory buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html ManifestOutputLocation *S3ManifestOutputLocation noSmithyDocumentSerde @@ -2160,9 +2311,10 @@ type S3JobManifestGenerator struct { // Location details for where the generated manifest should be written. type S3ManifestOutputLocation struct { - // The bucket ARN the generated manifest should be written to. Directory buckets - - // Directory buckets aren't supported as the buckets to store the generated - // manifest. + // The bucket ARN the generated manifest should be written to. + // + // Directory buckets - Directory buckets aren't supported as the buckets to store + // the generated manifest. // // This member is required. Bucket *string @@ -2212,10 +2364,10 @@ type S3ObjectMetadata struct { // ContentLanguage *string - // This member has been deprecated. + // This member has been deprecated. ContentLength *int64 - // This member has been deprecated. + // This member has been deprecated. ContentMD5 *string // @@ -2224,7 +2376,7 @@ type S3ObjectMetadata struct { // HttpExpiresDate *time.Time - // This member has been deprecated. + // This member has been deprecated. RequesterCharged bool // For directory buckets, only the server-side encryption with Amazon S3 managed @@ -2257,8 +2409,9 @@ 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) -// in the Amazon S3 User Guide. +// more information, see [Using S3 Object Lock retention with S3 Batch Operations]in the Amazon S3 User Guide. +// +// [Using S3 Object Lock retention with S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html type S3Retention struct { // The Object Lock retention mode to be applied to all objects in the Batch @@ -2274,8 +2427,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) -// . +// For more information about the parameters for this operation, see [PutObjectAcl]. +// +// [PutObjectAcl]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html type S3SetObjectAclOperation struct { // @@ -2286,10 +2440,12 @@ type S3SetObjectAclOperation struct { // 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. This functionality is not supported by directory -// buckets. +// PutObjectLegalHold API operation. For more information, see [Using S3 Object Lock legal hold with S3 Batch Operations] in the Amazon S3 +// User Guide. +// +// This functionality is not supported by directory buckets. +// +// [Using S3 Object Lock legal hold with S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html type S3SetObjectLegalHoldOperation struct { // Contains the Object Lock legal hold status to be applied to all objects in the @@ -2303,16 +2459,18 @@ 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) -// in the Amazon S3 User Guide. This functionality is not supported by directory -// buckets. +// underlying PutObjectRetention API operation. For more information, see [Using S3 Object Lock retention with S3 Batch Operations] in the +// Amazon S3 User Guide. +// +// This functionality is not supported by directory buckets. +// +// [Using S3 Object Lock retention with S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html 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) - // in the Amazon S3 User Guide. + // Batch Operations job. For more information, see [Using S3 Object Lock retention with S3 Batch Operations]in the Amazon S3 User Guide. + // + // [Using S3 Object Lock retention with S3 Batch Operations]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html // // This member is required. Retention *S3Retention @@ -2326,9 +2484,9 @@ 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) -// . +// operation. For more information about the parameters for this operation, see [PutObjectTagging]. +// +// [PutObjectTagging]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTtagging.html type S3SetObjectTaggingOperation struct { // @@ -2362,6 +2520,7 @@ 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 . MinStorageBytesPercentage *float64 @@ -2379,16 +2538,21 @@ type SourceSelectionCriteria struct { // Outposts replicates metadata from the source objects to the replicas only. When // 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 - // enable replica modification sync on the source and destination buckets to - // replicate replica metadata changes between the source and the replicas. + // bidirectional. + // + // To replicate object metadata modifications on replicas, you can 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 // A filter that you can use to select Amazon S3 objects that are encrypted with // server-side encryption by using Key Management Service (KMS) keys. If you // include SourceSelectionCriteria in the replication configuration, this element - // is required. This is not supported by Amazon S3 on Outposts buckets. + // is required. + // + // This is not supported by Amazon S3 on Outposts buckets. SseKmsEncryptedObjects *SseKmsEncryptedObjects noSmithyDocumentSerde @@ -2407,8 +2571,9 @@ type SSEKMS struct { } // A container for filter information that you can use to select S3 objects that -// are encrypted with Key Management Service (KMS). This is not supported by Amazon -// S3 on Outposts buckets. +// are encrypted with Key Management Service (KMS). +// +// This is not supported by Amazon S3 on Outposts buckets. type SseKmsEncryptedObjects struct { // Specifies whether Amazon S3 replicates objects that are created with @@ -2507,7 +2672,9 @@ type StorageLensDataExport struct { CloudWatchMetrics *CloudWatchMetrics // A container for the bucket where the S3 Storage Lens metrics export will be - // located. This bucket must be located in the same Region as the storage lens + // located. + // + // This bucket must be located in the same Region as the storage lens // configuration. S3BucketDestination *S3BucketDestination @@ -2538,39 +2705,40 @@ type StorageLensGroup struct { // This member is required. Filter *StorageLensGroupFilter - // Contains the name of the Storage Lens group. + // Contains the name of the Storage Lens group. // // This member is required. Name *string - // Contains the Amazon Resource Name (ARN) of the Storage Lens group. This + // Contains the Amazon Resource Name (ARN) of the Storage Lens group. This // property is read-only. StorageLensGroupArn *string noSmithyDocumentSerde } -// A logical operator that allows multiple filter conditions to be joined for more -// complex comparisons of Storage Lens group data. +// A logical operator that allows multiple filter conditions to be joined for +// +// more complex comparisons of Storage Lens group data. type StorageLensGroupAndOperator struct { - // Contains a list of prefixes. At least one prefix must be specified. Up to 10 + // Contains a list of prefixes. At least one prefix must be specified. Up to 10 // prefixes are allowed. MatchAnyPrefix []string - // Contains a list of suffixes. At least one suffix must be specified. Up to 10 + // Contains a list of suffixes. At least one suffix must be specified. Up to 10 // suffixes are allowed. MatchAnySuffix []string - // Contains the list of object tags. At least one object tag must be specified. Up - // to 10 object tags are allowed. + // Contains the list of object tags. At least one object tag must be specified. + // Up to 10 object tags are allowed. MatchAnyTag []S3Tag - // Contains DaysGreaterThan and DaysLessThan to define the object age range + // Contains DaysGreaterThan and DaysLessThan to define the object age range // (minimum and maximum number of days). MatchObjectAge *MatchObjectAge - // Contains BytesGreaterThan and BytesLessThan to define the object size range + // Contains BytesGreaterThan and BytesLessThan to define the object size range // (minimum and maximum number of Bytes). MatchObjectSize *MatchObjectSize @@ -2588,23 +2756,23 @@ type StorageLensGroupFilter struct { // of each filter condition is allowed. And *StorageLensGroupAndOperator - // Contains a list of prefixes. At least one prefix must be specified. Up to 10 + // Contains a list of prefixes. At least one prefix must be specified. Up to 10 // prefixes are allowed. MatchAnyPrefix []string - // Contains a list of suffixes. At least one suffix must be specified. Up to 10 + // Contains a list of suffixes. At least one suffix must be specified. Up to 10 // suffixes are allowed. MatchAnySuffix []string - // Contains the list of S3 object tags. At least one object tag must be specified. - // Up to 10 object tags are allowed. + // Contains the list of S3 object tags. At least one object tag must be + // specified. Up to 10 object tags are allowed. MatchAnyTag []S3Tag - // Contains DaysGreaterThan and DaysLessThan to define the object age range + // Contains DaysGreaterThan and DaysLessThan to define the object age range // (minimum and maximum number of days). MatchObjectAge *MatchObjectAge - // Contains BytesGreaterThan and BytesLessThan to define the object size range + // Contains BytesGreaterThan and BytesLessThan to define the object size range // (minimum and maximum number of Bytes). MatchObjectSize *MatchObjectSize @@ -2616,11 +2784,12 @@ type StorageLensGroupFilter struct { noSmithyDocumentSerde } -// Specifies the Storage Lens groups to include in the Storage Lens group +// Specifies the Storage Lens groups to include in the Storage Lens group +// // aggregation. type StorageLensGroupLevel struct { - // Indicates which Storage Lens group ARNs to include or exclude in the Storage + // Indicates which Storage Lens group ARNs to include or exclude in the Storage // Lens group aggregation. If this value is left null, then all Storage Lens groups // are selected. SelectionCriteria *StorageLensGroupLevelSelectionCriteria @@ -2628,17 +2797,18 @@ type StorageLensGroupLevel struct { noSmithyDocumentSerde } -// Indicates which Storage Lens group ARNs to include or exclude in the Storage +// Indicates which Storage Lens group ARNs to include or exclude in the Storage +// // Lens group aggregation. You can only attach Storage Lens groups to your Storage // Lens dashboard if they're included in your Storage Lens group aggregation. If // this value is left null, then all Storage Lens groups are selected. type StorageLensGroupLevelSelectionCriteria struct { - // Indicates which Storage Lens group ARNs to exclude from the Storage Lens group + // Indicates which Storage Lens group ARNs to exclude from the Storage Lens group // aggregation. Exclude []string - // Indicates which Storage Lens group ARNs to include in the Storage Lens group + // Indicates which Storage Lens group ARNs to include in the Storage Lens group // aggregation. Include []string @@ -2651,19 +2821,19 @@ type StorageLensGroupLevelSelectionCriteria struct { // operator. Only one of each filter condition is allowed. type StorageLensGroupOrOperator struct { - // Filters objects that match any of the specified prefixes. + // Filters objects that match any of the specified prefixes. MatchAnyPrefix []string - // Filters objects that match any of the specified suffixes. + // Filters objects that match any of the specified suffixes. MatchAnySuffix []string - // Filters objects that match any of the specified S3 object tags. + // Filters objects that match any of the specified S3 object tags. MatchAnyTag []S3Tag - // Filters objects that match the specified object age range. + // Filters objects that match the specified object age range. MatchObjectAge *MatchObjectAge - // Filters objects that match the specified object size range. + // Filters objects that match the specified object size range. MatchObjectSize *MatchObjectSize noSmithyDocumentSerde @@ -2684,12 +2854,17 @@ type StorageLensTag struct { noSmithyDocumentSerde } -// An Amazon Web Services resource tag that's associated with your S3 resource. +// An Amazon Web Services resource tag that's associated with your S3 resource. +// // You can add tags to new objects when you upload them, or you can add object tags -// to existing objects. This operation is only supported for S3 Storage Lens groups (https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html) -// and for S3 Access Grants (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html) -// . The tagged resource can be an S3 Storage Lens group or S3 Access Grants -// instance, registered location, or grant. +// to existing objects. +// +// This operation is only supported for [S3 Storage Lens groups] and for [S3 Access Grants]. The tagged resource can be an +// S3 Storage Lens group or S3 Access Grants instance, registered location, or +// grant. +// +// [S3 Access Grants]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-tagging.html +// [S3 Storage Lens groups]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html type Tag struct { // The key of the key-value pair of a tag added to your Amazon Web Services @@ -2699,7 +2874,7 @@ type Tag struct { // This member is required. Key *string - // The value of the key-value pair of a tag added to your Amazon Web Services + // The value of the key-value pair of a tag added to your Amazon Web Services // resource. A tag value can be up to 256 Unicode characters in length and is // case-sensitive. // @@ -2720,9 +2895,10 @@ 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) -// in the Amazon S3 User Guide. +// information about Amazon S3 Lifecycle configuration rules, see [Transitioning objects using Amazon S3 Lifecycle]in the Amazon S3 +// User Guide. +// +// [Transitioning objects using Amazon S3 Lifecycle]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html type Transition struct { // Indicates when objects are transitioned to the specified storage class. The @@ -2740,8 +2916,9 @@ 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]. +// +// [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_op_CreateEndpoint.go b/service/s3outposts/api_op_CreateEndpoint.go index 0c43b1fb488..c8fe7a8bb48 100644 --- a/service/s3outposts/api_op_CreateEndpoint.go +++ b/service/s3outposts/api_op_CreateEndpoint.go @@ -11,10 +11,18 @@ 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] +// +// [ListEndpoints] +// +// [ListEndpoints]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html +// [DeleteEndpoint]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error) { if params == nil { params = &CreateEndpointInput{} @@ -52,7 +60,9 @@ type CreateEndpointInput struct { // 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. + // pool). + // + // Private is the default access type value. AccessType types.EndpointAccessType // The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP diff --git a/service/s3outposts/api_op_DeleteEndpoint.go b/service/s3outposts/api_op_DeleteEndpoint.go index 40e647af3e8..55ec58e4d81 100644 --- a/service/s3outposts/api_op_DeleteEndpoint.go +++ b/service/s3outposts/api_op_DeleteEndpoint.go @@ -10,10 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an endpoint. It can take up to 5 minutes for this action to finish. +// 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] +// +// [ListEndpoints] +// +// [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 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 8e917318b11..aef10bb1bd7 100644 --- a/service/s3outposts/api_op_ListEndpoints.go +++ b/service/s3outposts/api_op_ListEndpoints.go @@ -11,9 +11,16 @@ 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] +// +// [DeleteEndpoint] +// +// [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{} diff --git a/service/s3outposts/api_op_ListOutpostsWithS3.go b/service/s3outposts/api_op_ListOutpostsWithS3.go index 794ae7ffaf2..7fc4f1f73bd 100644 --- a/service/s3outposts/api_op_ListOutpostsWithS3.go +++ b/service/s3outposts/api_op_ListOutpostsWithS3.go @@ -49,8 +49,11 @@ 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 []types.Outpost diff --git a/service/s3outposts/api_op_ListSharedEndpoints.go b/service/s3outposts/api_op_ListSharedEndpoints.go index ffbd3530e68..3edb48796d9 100644 --- a/service/s3outposts/api_op_ListSharedEndpoints.go +++ b/service/s3outposts/api_op_ListSharedEndpoints.go @@ -12,9 +12,16 @@ 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) +// Web Services Resource Access Manager (RAM). +// +// Related actions include: +// +// [CreateEndpoint] +// +// [DeleteEndpoint] +// +// [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{} diff --git a/service/s3outposts/options.go b/service/s3outposts/options.go index 329de7d3ebb..d026376cfbc 100644 --- a/service/s3outposts/options.go +++ b/service/s3outposts/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/s3outposts/types/enums.go b/service/s3outposts/types/enums.go index 59ace75a7f2..7ddc571e863 100644 --- a/service/s3outposts/types/enums.go +++ b/service/s3outposts/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for EndpointAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointAccessType) Values() []EndpointAccessType { return []EndpointAccessType{ "Private", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for EndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointStatus) Values() []EndpointStatus { return []EndpointStatus{ "Pending", diff --git a/service/s3outposts/types/types.go b/service/s3outposts/types/types.go index 804e002d484..1788c1715ba 100644 --- a/service/s3outposts/types/types.go +++ b/service/s3outposts/types/types.go @@ -10,9 +10,10 @@ 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) -// in the Amazon Simple Storage Service User Guide. +// cloud (VPC). For more information, see [Accessing S3 on Outposts using VPC-only access points]in the Amazon Simple Storage Service +// User Guide. +// +// [Accessing S3 on Outposts using VPC-only access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html type Endpoint struct { // The type of connectivity used to access the Amazon S3 on Outposts endpoint. diff --git a/service/sagemaker/api_op_AddAssociation.go b/service/sagemaker/api_op_AddAssociation.go index 2d05be1e644..afd6ac8bfff 100644 --- a/service/sagemaker/api_op_AddAssociation.go +++ b/service/sagemaker/api_op_AddAssociation.go @@ -14,8 +14,9 @@ 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]. +// +// [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,14 +46,18 @@ 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. AssociationType types.AssociationEdgeType diff --git a/service/sagemaker/api_op_AddTags.go b/service/sagemaker/api_op_AddTags.go index 45cec38168e..d71d3f6977e 100644 --- a/service/sagemaker/api_op_AddTags.go +++ b/service/sagemaker/api_op_AddTags.go @@ -14,26 +14,31 @@ import ( // Adds or overwrites one or more tags for the specified SageMaker resource. You // can add tags to notebook instances, training jobs, hyperparameter tuning jobs, // 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 +// 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]. +// +// 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 // a hyperparameter tuning job are also added to all training jobs that the // hyperparameter tuning job launches, add the tags when you first create the -// tuning job by specifying them in the Tags parameter of -// CreateHyperParameterTuningJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html) +// tuning job by specifying them in the Tags parameter of [CreateHyperParameterTuningJob] +// // Tags that you add to a SageMaker Domain or User Profile by calling this API are // also added to any Apps that the Domain or User Profile launches after you call // this API, but not to Apps that the Domain or User Profile launched before you // called this API. To make sure that the tags 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) -// or CreateUserProfile (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) -// . +// the Tags parameter of [CreateDomain] or [CreateUserProfile]. +// +// [CreateHyperParameterTuningJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html +// [Amazon Web Services Tagging Strategies]: https://aws.amazon.com/answers/account-management/aws-tagging-strategies/ +// [CreateUserProfile]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html +// [CreateDomain]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error) { if params == nil { params = &AddTagsInput{} @@ -58,8 +63,9 @@ 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]. + // + // [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_AssociateTrialComponent.go b/service/sagemaker/api_op_AssociateTrialComponent.go index e31225808fc..0e38f5cc136 100644 --- a/service/sagemaker/api_op_AssociateTrialComponent.go +++ b/service/sagemaker/api_op_AssociateTrialComponent.go @@ -11,9 +11,10 @@ import ( ) // Associates a trial component with a trial. A trial component can be associated -// with multiple trials. To disassociate a trial component from a trial, call the -// DisassociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) +// with multiple trials. To disassociate a trial component from a trial, call the [DisassociateTrialComponent] // API. +// +// [DisassociateTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html func (c *Client) AssociateTrialComponent(ctx context.Context, params *AssociateTrialComponentInput, optFns ...func(*Options)) (*AssociateTrialComponentOutput, error) { if params == nil { params = &AssociateTrialComponentInput{} diff --git a/service/sagemaker/api_op_CreateAction.go b/service/sagemaker/api_op_CreateAction.go index 30da31a97c5..17be081022e 100644 --- a/service/sagemaker/api_op_CreateAction.go +++ b/service/sagemaker/api_op_CreateAction.go @@ -14,8 +14,9 @@ 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]. +// +// [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{} diff --git a/service/sagemaker/api_op_CreateAlgorithm.go b/service/sagemaker/api_op_CreateAlgorithm.go index fa8314da547..c7e602e2f25 100644 --- a/service/sagemaker/api_op_CreateAlgorithm.go +++ b/service/sagemaker/api_op_CreateAlgorithm.go @@ -37,14 +37,21 @@ 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. // @@ -60,18 +67,22 @@ type CreateAlgorithmInput struct { // 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. 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]. + // + // [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 f652fe75dd1..698b021b0af 100644 --- a/service/sagemaker/api_op_CreateApp.go +++ b/service/sagemaker/api_op_CreateApp.go @@ -48,11 +48,13 @@ type CreateAppInput struct { DomainId *string // The instance type and the Amazon Resource Name (ARN) of the SageMaker image - // 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. + // 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. 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 fb23133ff6a..7ae5b80a2b9 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]. +// +// [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 b6540ecceda..726b03730f4 100644 --- a/service/sagemaker/api_op_CreateAutoMLJob.go +++ b/service/sagemaker/api_op_CreateAutoMLJob.go @@ -11,19 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an Autopilot job also referred to as Autopilot experiment or AutoML -// job. We recommend using the new versions CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) -// and DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) -// , which offer backward compatibility. CreateAutoMLJobV2 can manage tabular -// problem types identical to those of its previous version CreateAutoMLJob , as -// well as time-series forecasting, non-tabular problem types such as image or text -// classification, and text generation (LLMs fine-tuning). Find guidelines about -// how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a -// CreateAutoMLJob to CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2) -// . You can find the best-performing model after you run an AutoML job by calling -// DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) -// (recommended) or DescribeAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html) -// . +// Creates an Autopilot job also referred to as Autopilot experiment or AutoML job. +// +// We recommend using the new versions [CreateAutoMLJobV2] and [DescribeAutoMLJobV2], which offer backward compatibility. +// +// CreateAutoMLJobV2 can manage tabular problem types identical to those of its +// previous version CreateAutoMLJob , as well as time-series forecasting, +// non-tabular problem types such as image or text classification, and text +// generation (LLMs fine-tuning). +// +// Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in [Migrate a CreateAutoMLJob to CreateAutoMLJobV2]. +// +// You can find the best-performing model after you run an AutoML job by calling [DescribeAutoMLJobV2] +// (recommended) or [DescribeAutoMLJob]. +// +// [DescribeAutoMLJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html +// [DescribeAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html +// [CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html +// [Migrate a CreateAutoMLJob to CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2 func (c *Client) CreateAutoMLJob(ctx context.Context, params *CreateAutoMLJobInput, optFns ...func(*Options)) (*CreateAutoMLJobOutput, error) { if params == nil { params = &CreateAutoMLJobInput{} @@ -48,12 +53,13 @@ type CreateAutoMLJobInput struct { 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 + // Each channel is a named input source. Similar to InputDataConfig supported by [HyperParameterTrainingJobDefinition]. + // 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. // + // [HyperParameterTrainingJobDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html + // // This member is required. InputDataConfig []types.AutoMLChannel @@ -72,9 +78,10 @@ type CreateAutoMLJobInput struct { AutoMLJobConfig *types.AutoMLJobConfig // Specifies a metric to minimize or maximize as the objective of a job. If not - // specified, the default objective metric depends on the problem type. See - // AutoMLJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) - // for the default values. + // specified, the default objective metric depends on the problem type. See [AutoMLJobObjective]for + // the default values. + // + // [AutoMLJobObjective]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html AutoMLJobObjective *types.AutoMLJobObjective // Generates possible candidates without training the models. A candidate is a @@ -86,14 +93,16 @@ type CreateAutoMLJobInput struct { ModelDeployConfig *types.ModelDeployConfig // Defines the type of supervised learning problem available for the candidates. - // For more information, see SageMaker Autopilot problem types (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types) - // . + // For more information, see [SageMaker Autopilot problem types]. + // + // [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]. Tag keys must be unique per resource. + // + // [Tagging Amazon Web ServicesResources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateAutoMLJobV2.go b/service/sagemaker/api_op_CreateAutoMLJobV2.go index fcbe3ddb630..470a0297ad5 100644 --- a/service/sagemaker/api_op_CreateAutoMLJobV2.go +++ b/service/sagemaker/api_op_CreateAutoMLJobV2.go @@ -12,21 +12,28 @@ import ( ) // Creates an Autopilot job also referred to as Autopilot experiment or AutoML job -// V2. CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) -// and DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) -// are new versions of CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) -// and DescribeAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html) -// which offer backward compatibility. CreateAutoMLJobV2 can manage tabular -// problem types identical to those of its previous version CreateAutoMLJob , as -// well as time-series forecasting, non-tabular problem types such as image or text -// classification, and text generation (LLMs fine-tuning). Find guidelines about -// how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a -// CreateAutoMLJob to CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2) -// . For the list of available problem types supported by CreateAutoMLJobV2 , see -// AutoMLProblemTypeConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLProblemTypeConfig.html) -// . You can find the best-performing model after you run an AutoML job V2 by -// calling DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) -// . +// V2. +// +// [CreateAutoMLJobV2]and [DescribeAutoMLJobV2] are new versions of [CreateAutoMLJob] and [DescribeAutoMLJob] which offer backward compatibility. +// +// CreateAutoMLJobV2 can manage tabular problem types identical to those of its +// previous version CreateAutoMLJob , as well as time-series forecasting, +// non-tabular problem types such as image or text classification, and text +// generation (LLMs fine-tuning). +// +// Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in [Migrate a CreateAutoMLJob to CreateAutoMLJobV2]. +// +// For the list of available problem types supported by CreateAutoMLJobV2 , see [AutoMLProblemTypeConfig]. +// +// You can find the best-performing model after you run an AutoML job V2 by +// calling [DescribeAutoMLJobV2]. +// +// [CreateAutoMLJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html +// [DescribeAutoMLJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html +// [DescribeAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html +// [CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html +// [Migrate a CreateAutoMLJob to CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2 +// [AutoMLProblemTypeConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLProblemTypeConfig.html func (c *Client) CreateAutoMLJobV2(ctx context.Context, params *CreateAutoMLJobV2Input, optFns ...func(*Options)) (*CreateAutoMLJobV2Output, error) { if params == nil { params = &CreateAutoMLJobV2Input{} @@ -45,15 +52,21 @@ 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 the InputDataConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig) - // attribute in the CreateAutoMLJob input parameters. The supported formats depend - // on the problem type: + // channel is a named input source. Similar to the [InputDataConfig]attribute in the CreateAutoMLJob + // input parameters. The supported formats depend on the problem type: + // // - For tabular problem types: S3Prefix , ManifestFile . + // // - For image classification: S3Prefix , ManifestFile , AugmentedManifestFile . + // // - For text classification: S3Prefix . + // // - For time-series forecasting: S3Prefix . + // // - For text generation (LLMs fine-tuning): S3Prefix . // + // [InputDataConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig + // // This member is required. AutoMLJobInputDataConfig []types.AutoMLJobChannel @@ -81,11 +94,12 @@ type CreateAutoMLJobV2Input struct { // Specifies a metric to minimize or maximize as the objective of a job. If not // specified, the default objective metric depends on the problem type. For the - // list of default values per problem type, see AutoMLJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html) - // . + // list of default values per problem type, see [AutoMLJobObjective]. + // // - For tabular problem types: You must either provide both the // AutoMLJobObjective and indicate the type of supervised learning problem in // AutoMLProblemTypeConfig ( TabularJobConfig.ProblemType ), or none at all. + // // - For text generation problem types (LLMs fine-tuning): Fine-tuning language // models in Autopilot does not require setting the AutoMLJobObjective field. // Autopilot fine-tunes LLMs without requiring multiple candidates to be trained @@ -93,16 +107,22 @@ type CreateAutoMLJobV2Input struct { // target model to enhance a default objective metric, the cross-entropy loss. // After fine-tuning a language model, you can evaluate the quality of its // generated text using different metrics. For a list of the available metrics, see - // Metrics for fine-tuning LLMs in Autopilot (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html) - // . + // [Metrics for fine-tuning LLMs in Autopilot]. + // + // [Metrics for fine-tuning LLMs in Autopilot]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html + // [AutoMLJobObjective]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html AutoMLJobObjective *types.AutoMLJobObjective // This structure specifies how to split the data into train and validation - // datasets. The validation and training datasets must contain the same headers. - // For jobs created by calling CreateAutoMLJob , the validation dataset must be - // less than 2 GB in size. This attribute must not be set for the time-series - // forecasting problem type, as Autopilot automatically splits the input dataset - // into training and validation sets. + // datasets. + // + // The validation and training datasets must contain the same headers. For jobs + // created by calling CreateAutoMLJob , the validation dataset must be less than 2 + // GB in size. + // + // This attribute must not be set for the time-series forecasting problem type, as + // Autopilot automatically splits the input dataset into training and validation + // sets. DataSplitConfig *types.AutoMLDataSplitConfig // Specifies how to generate the endpoint name for an automatic one-click @@ -114,8 +134,9 @@ 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]. Tag keys must be unique per resource. + // + // [Tagging Amazon Web ServicesResources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateCluster.go b/service/sagemaker/api_op_CreateCluster.go index 34318b207f5..a714a489911 100644 --- a/service/sagemaker/api_op_CreateCluster.go +++ b/service/sagemaker/api_op_CreateCluster.go @@ -14,8 +14,9 @@ import ( // Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of // SageMaker for creating and managing persistent clusters for developing large // machine learning models, such as large language models (LLMs) and diffusion -// models. To learn more, see Amazon SageMaker HyperPod (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html) -// in the Amazon SageMaker Developer Guide. +// models. To learn more, see [Amazon SageMaker HyperPod]in the Amazon SageMaker Developer Guide. +// +// [Amazon SageMaker HyperPod]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -46,16 +47,16 @@ type CreateClusterInput struct { // Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web // Services resource. You can add tags to your cluster in the same way you add them // in other Amazon Web Services services that support tagging. To learn more about - // tagging Amazon Web Services resources in general, see Tagging Amazon Web - // Services Resources User Guide (https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html) - // . + // tagging Amazon Web Services resources in general, see [Tagging Amazon Web Services Resources User Guide]. + // + // [Tagging Amazon Web Services Resources User Guide]: https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html Tags []types.Tag // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateCodeRepository.go b/service/sagemaker/api_op_CreateCodeRepository.go index b62c680302d..6e61a9aa264 100644 --- a/service/sagemaker/api_op_CreateCodeRepository.go +++ b/service/sagemaker/api_op_CreateCodeRepository.go @@ -16,9 +16,11 @@ import ( // control for the notebooks you create. The Git repository is a resource in your // 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. +// associated with. +// +// The repository can be hosted either in [Amazon Web Services CodeCommit] or in any other Git repository. +// +// [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html func (c *Client) CreateCodeRepository(ctx context.Context, params *CreateCodeRepositoryInput, optFns ...func(*Options)) (*CreateCodeRepositoryOutput, error) { if params == nil { params = &CreateCodeRepositoryInput{} @@ -50,8 +52,9 @@ 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]. + // + // [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 880ecf322fb..e1747c5873e 100644 --- a/service/sagemaker/api_op_CreateCompilationJob.go +++ b/service/sagemaker/api_op_CreateCompilationJob.go @@ -13,26 +13,36 @@ import ( // Starts a model compilation job. After the model has been compiled, Amazon // SageMaker saves the resulting model artifacts to an Amazon Simple Storage -// Service (Amazon S3) bucket that you specify. If you choose to host your model -// using Amazon SageMaker hosting services, you can use the resulting model -// 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: +// Service (Amazon S3) bucket that you specify. +// +// If you choose to host your model using Amazon SageMaker hosting services, you +// can use the resulting model 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. // // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html) -// . To get information about a particular model compilation job, use -// DescribeCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html) -// . To get information about multiple model compilation jobs, use -// ListCompilationJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html) -// . +// 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]. +// +// [StopCompilationJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html +// [DescribeCompilationJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html +// [ListCompilationJobs]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html func (c *Client) CreateCompilationJob(ctx context.Context, params *CreateCompilationJobInput, optFns ...func(*Options)) (*CreateCompilationJobOutput, error) { if params == nil { params = &CreateCompilationJobInput{} @@ -63,15 +73,23 @@ type CreateCompilationJobInput struct { OutputConfig *types.OutputConfig // 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: + // 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) + // permission. For more information, see [Amazon SageMaker Roles.] + // + // [Amazon SageMaker Roles.]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html // // This member is required. RoleArn *string @@ -96,15 +114,17 @@ 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]. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // 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) - // . + // 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]. + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Compilation Jobs by Using an Amazon Virtual Private Cloud]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html VpcConfig *types.NeoVpcConfig noSmithyDocumentSerde @@ -114,6 +134,7 @@ 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. // // This member is required. diff --git a/service/sagemaker/api_op_CreateContext.go b/service/sagemaker/api_op_CreateContext.go index 3fe6caceb72..1e80ce0aa1b 100644 --- a/service/sagemaker/api_op_CreateContext.go +++ b/service/sagemaker/api_op_CreateContext.go @@ -13,9 +13,9 @@ 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) -// . +// endpoint and a model package. For more information, see [Amazon SageMaker ML Lineage Tracking]. +// +// [Amazon SageMaker ML 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 581066f2aca..1d469c25986 100644 --- a/service/sagemaker/api_op_CreateDataQualityJobDefinition.go +++ b/service/sagemaker/api_op_CreateDataQualityJobDefinition.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -72,9 +73,10 @@ type CreateDataQualityJobDefinitionInput struct { // A time limit for how long the monitoring job is allowed to run before stopping. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateDeviceFleet.go b/service/sagemaker/api_op_CreateDeviceFleet.go index 2fe8883cf7e..60776c2418b 100644 --- a/service/sagemaker/api_op_CreateDeviceFleet.go +++ b/service/sagemaker/api_op_CreateDeviceFleet.go @@ -44,8 +44,10 @@ type CreateDeviceFleetInput struct { // Whether to create an Amazon Web Services IoT Role Alias during device fleet // creation. The name of the role alias generated will match this pattern: - // "SageMakerEdge-{DeviceFleetName}". For example, if your device fleet is called - // "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet". + // "SageMakerEdge-{DeviceFleetName}". + // + // For example, if your device fleet is called "demo-fleet", the name of the role + // alias will be "SageMakerEdge-demo-fleet". EnableIotRoleAlias *bool // The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet diff --git a/service/sagemaker/api_op_CreateDomain.go b/service/sagemaker/api_op_CreateDomain.go index c469fb4b6e5..2ed2d41dcff 100644 --- a/service/sagemaker/api_op_CreateDomain.go +++ b/service/sagemaker/api_op_CreateDomain.go @@ -14,33 +14,47 @@ import ( // Creates a Domain . A domain consists of an associated Amazon Elastic File System // volume, a list of authorized users, and a variety of security, application, // policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a -// domain can share notebook files and other artifacts with each other. EFS storage +// domain can share notebook files and other artifacts with each other. +// +// # EFS storage +// // When a domain is created, an EFS volume is created for use by all of the users // within the domain. Each user receives a private home directory within the EFS -// volume for notebooks, Git repositories, and data files. SageMaker uses the -// Amazon Web Services Key Management Service (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 traffic between the domain and the Amazon EFS volume is -// through the specified VPC and subnets. For other traffic, you can specify the +// volume for notebooks, Git repositories, and data files. +// +// SageMaker uses the Amazon Web Services Key Management Service (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]. +// +// # VPC configuration +// +// All traffic between the domain and the Amazon EFS volume is through the +// specified VPC and subnets. For other traffic, you can specify the // AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network // access type that you choose when you onboard to the domain. 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 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 Amazon -// SageMaker 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. +// gateway. +// +// When internet access is disabled, you won't be able to run a Amazon SageMaker +// +// 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 Amazon SageMaker Studio app successfully. -// For more information, see Connect Amazon SageMaker Studio Notebooks to -// Resources in a VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) -// . +// +// For more information, see [Connect Amazon SageMaker Studio Notebooks to Resources in a VPC]. +// +// [Connect Amazon SageMaker Studio Notebooks to Resources in a VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html +// [Protect Data at Rest Using Encryption]: https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error) { if params == nil { params = &CreateDomainInput{} @@ -64,10 +78,11 @@ 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 @@ -90,8 +105,10 @@ type CreateDomainInput 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 traffic is through the specified VPC and subnets AppNetworkAccessType types.AppNetworkAccessType @@ -121,8 +138,10 @@ type CreateDomainInput struct { // Tags to associated with the Domain. Each tag consists of a key and an optional // value. Tag keys must be unique per resource. Tags are searchable using the - // Search API. Tags that you specify for the Domain are also added to all Apps that - // the Domain launches. + // Search API. + // + // Tags that you specify for the Domain are also added to all Apps that the Domain + // launches. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateEndpoint.go b/service/sagemaker/api_op_CreateEndpoint.go index bb064b26be2..d66d7260dd3 100644 --- a/service/sagemaker/api_op_CreateEndpoint.go +++ b/service/sagemaker/api_op_CreateEndpoint.go @@ -13,53 +13,75 @@ import ( // Creates an endpoint using the endpoint configuration specified in the request. // SageMaker uses the endpoint to provision resources and deploy models. You create -// the endpoint configuration with the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) -// API. Use this API to deploy models using SageMaker hosting services. 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// , 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html) -// before calling CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// 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 incoming requests for inferences. To check the status of an endpoint, -// use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) -// API. If any of the models hosted at this endpoint get model data from an Amazon -// S3 location, SageMaker uses Amazon Web Services Security Token Service to -// download model artifacts from the S3 path you provided. Amazon Web Services STS -// is activated in your Amazon Web Services account by default. If you previously +// the endpoint configuration with the [CreateEndpointConfig]API. +// +// Use this API to deploy models using SageMaker hosting services. +// +// 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] +// Eventually Consistent Reads , 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 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 Token Service to download +// model artifacts from the S3 path you provided. 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) -// 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// and CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) -// API operations, add the following policies to the role. +// Web Services STS for that region. For more information, see [Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region]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], 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) -// . +// 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]. +// +// [Eventually Consistent Reads]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html +// [IAM console]: https://console.aws.amazon.com/iam/ +// [DescribeEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html +// [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html +// [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html +// [DescribeEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html +// [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 +// [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{} @@ -77,17 +99,18 @@ func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput type CreateEndpointInput struct { - // The name of an endpoint configuration. For more information, see - // CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) - // . + // The name of an endpoint configuration. For more information, see [CreateEndpointConfig]. + // + // [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html // // 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 InvokeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html) - // . + // CreateEndpoint , but the case is preserved and must be matched in [InvokeEndpoint]. + // + // [InvokeEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html // // This member is required. EndpointName *string @@ -98,8 +121,9 @@ 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]. + // + // [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 acaa5e8fc31..26efb57810f 100644 --- a/service/sagemaker/api_op_CreateEndpointConfig.go +++ b/service/sagemaker/api_op_CreateEndpointConfig.go @@ -14,28 +14,35 @@ import ( // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// , 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html) -// before calling CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// to minimize the potential impact of a DynamoDB eventually consistent read. +// 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 is made to DynamoDB to verify that your endpoint +// configuration exists. When you read data from a DynamoDB table supporting [Eventually Consistent Reads] +// Eventually Consistent Reads , 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. +// +// [Eventually Consistent Reads]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html +// [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html +// [DescribeEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html func (c *Client) CreateEndpointConfig(ctx context.Context, params *CreateEndpointConfigInput, optFns ...func(*Options)) (*CreateEndpointConfigOutput, error) { if params == nil { params = &CreateEndpointConfigInput{} @@ -53,9 +60,9 @@ func (c *Client) CreateEndpointConfig(ctx context.Context, params *CreateEndpoin type CreateEndpointConfigInput struct { - // The name of the endpoint configuration. You specify this name in a - // CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) - // request. + // The name of the endpoint configuration. You specify this name in a [CreateEndpoint] request. + // + // [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html // // This member is required. EndpointConfigName *string @@ -67,9 +74,9 @@ type CreateEndpointConfigInput struct { ProductionVariants []types.ProductionVariant // 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) - // . + // This is a required field in order for your Endpoint to be invoked using [InvokeEndpointAsync]. + // + // [InvokeEndpointAsync]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html AsyncInferenceConfig *types.AsyncInferenceConfig // Configuration to control how SageMaker captures inference data. @@ -81,9 +88,12 @@ type CreateEndpointConfigInput struct { EnableNetworkIsolation *bool // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume - // to perform actions on your behalf. 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 Amazon SageMaker, the caller of this action + // to perform actions on your behalf. For more information, see [SageMaker Roles]. + // + // To be able to pass this role to Amazon SageMaker, the caller of this action // must have the iam:PassRole permission. + // + // [SageMaker Roles]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html ExecutionRoleArn *string // A member of CreateEndpointConfig that enables explainers. @@ -91,17 +101,23 @@ type CreateEndpointConfigInput 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 the ML - // compute instance that hosts the endpoint. The KmsKeyId can be any of the - // following formats: + // 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) + // the Amazon Web Services Key Management Service section[Using Key Policies in Amazon Web Services KMS] + // // 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 @@ -109,11 +125,15 @@ type CreateEndpointConfigInput struct { // parameter use nitro-based instances with local storage, do not specify a value // 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) - // . + // fails. + // + // For a list of instance types that support local instance storage, see [Instance Store Volumes]. + // + // For more information about local instance storage encryption, see [SSD Instance Store Volumes]. + // + // [SSD Instance Store Volumes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html + // [Using Key Policies in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html + // [Instance Store Volumes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes KmsKeyId *string // An array of ProductionVariant objects, one for each model that you want to host @@ -125,15 +145,16 @@ type CreateEndpointConfigInput 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]. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateExperiment.go b/service/sagemaker/api_op_CreateExperiment.go index 8023da0793f..a6e2163b7e1 100644 --- a/service/sagemaker/api_op_CreateExperiment.go +++ b/service/sagemaker/api_op_CreateExperiment.go @@ -13,25 +13,38 @@ import ( // 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 +// 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 -// constant. 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), you must -// use the logging APIs provided by the SDK. You can add tags to experiments, -// trials, trial components and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API to search for the tags. To add a description to an experiment, specify the -// optional Description parameter. To add a description later, or to change the -// description, call the UpdateExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html) -// API. To get a list of all your experiments, call the ListExperiments (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html) -// API. To view an experiment's properties, call the DescribeExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html) -// API. To get a list of all the trials associated with an experiment, call the -// ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) -// API. To create a trial call the CreateTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html) +// constant. +// +// 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), you must use the +// logging APIs provided by the SDK. +// +// You can add tags to experiments, trials, trial components and then use the [Search] API +// to search for the tags. +// +// To add a description to an experiment, specify the optional Description +// parameter. To add a description later, or to change the description, call the [UpdateExperiment] // API. +// +// To get a list of all your experiments, call the [ListExperiments] API. To view an experiment's +// properties, call the [DescribeExperiment]API. To get a list of all the trials associated with an +// experiment, call the [ListTrials]API. To create a trial call the [CreateTrial] API. +// +// [DescribeExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html +// [CreateTrial]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html +// [ListExperiments]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html +// [UpdateExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html +// [ListTrials]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentInput, optFns ...func(*Options)) (*CreateExperimentOutput, error) { if params == nil { params = &CreateExperimentInput{} @@ -62,8 +75,10 @@ type CreateExperimentInput struct { // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) - // API to search on the tags. + // A list of tags to associate with the experiment. You can use [Search] API to search on + // the tags. + // + // [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateFeatureGroup.go b/service/sagemaker/api_op_CreateFeatureGroup.go index ec874887d18..43652f05480 100644 --- a/service/sagemaker/api_op_CreateFeatureGroup.go +++ b/service/sagemaker/api_op_CreateFeatureGroup.go @@ -12,15 +12,21 @@ import ( ) // 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. Note that -// it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup -// with the InMemory StorageType . You must include at least one of -// OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup . +// 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] to see the FeatureGroup s quota for +// your Amazon Web Services account. +// +// Note that it can take approximately 10-15 minutes to provision an OnlineStore +// FeatureGroup with the InMemory StorageType . +// +// You must include at least one of OnlineStoreConfig and OfflineStoreConfig to +// create a FeatureGroup . +// +// [Amazon Web Services service quotas]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html func (c *Client) CreateFeatureGroup(ctx context.Context, params *CreateFeatureGroupInput, optFns ...func(*Options)) (*CreateFeatureGroupOutput, error) { if params == nil { params = &CreateFeatureGroupInput{} @@ -38,12 +44,16 @@ 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 . + // 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, @@ -54,16 +64,24 @@ type CreateFeatureGroupInput struct { EventTimeFeatureName *string // 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 + // + // 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 - // Services Region in an Amazon Web Services account. The name: + // Services Region in an Amazon Web Services account. + // + // The name: + // // - Must start with an alphanumeric character. + // // - Can only include alphanumeric characters, underscores, and hyphens. Spaces // are not allowed. // @@ -73,9 +91,14 @@ type CreateFeatureGroupInput struct { // 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: + // names. + // + // You use the RecordIdentifierFeatureName to access data in a FeatureStore . + // + // This name: + // // - Must start with an alphanumeric character. + // // - Can only contains alphanumeric characters, hyphens, underscores. Spaces are // not allowed. // @@ -87,25 +110,34 @@ type CreateFeatureGroupInput struct { // 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. + // all data at rest using Amazon Web Services KMS key. By defining your [bucket-level key]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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html) - // . + // and [Apache Iceberg]. + // + // To learn more about this parameter, see [OfflineStoreConfig]. + // + // [Apache Iceberg]: https://iceberg.apache.org/ + // [OfflineStoreConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html + // [bucket-level key]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html OfflineStoreConfig *types.OfflineStoreConfig // You can turn the OnlineStore on or off by specifying True for the - // EnableOnlineStore flag in OnlineStoreConfig . You can also include an Amazon Web - // Services KMS key ID ( KMSKeyId ) for at-rest encryption of the OnlineStore . The - // default value is False . + // EnableOnlineStore flag in OnlineStoreConfig . + // + // You can also include an Amazon Web Services KMS key ID ( KMSKeyId ) for at-rest + // encryption of the OnlineStore . + // + // The default value is False . OnlineStoreConfig *types.OnlineStoreConfig // The Amazon Resource Name (ARN) of the IAM execution role used to persist data @@ -123,9 +155,12 @@ type CreateFeatureGroupInput struct { // only once in a 24 hour period. With provisioned throughput mode, you specify the // read and write capacity per second that you expect your application to require, // and you are billed based on those limits. Exceeding provisioned throughput will - // result in your requests being throttled. Note: PROVISIONED throughput mode is - // supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) - // tier online store. + // result in your requests being throttled. + // + // Note: PROVISIONED throughput mode is supported only for feature groups that are + // offline-only, or use the [Standard]Standard tier online store. + // + // [Standard]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType ThroughputConfig *types.ThroughputConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateHub.go b/service/sagemaker/api_op_CreateHub.go index 5f6c1f7b059..45eaa6654e2 100644 --- a/service/sagemaker/api_op_CreateHub.go +++ b/service/sagemaker/api_op_CreateHub.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a hub. Hub APIs are only callable through SageMaker Studio. +// Create a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) CreateHub(ctx context.Context, params *CreateHubInput, optFns ...func(*Options)) (*CreateHubOutput, error) { if params == nil { params = &CreateHubInput{} diff --git a/service/sagemaker/api_op_CreateHyperParameterTuningJob.go b/service/sagemaker/api_op_CreateHyperParameterTuningJob.go index 74094c8a424..15028668235 100644 --- a/service/sagemaker/api_op_CreateHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_CreateHyperParameterTuningJob.go @@ -15,15 +15,18 @@ import ( // version of a model by running many training jobs on your dataset using the // algorithm you choose and values for hyperparameters within ranges that you // specify. It then chooses the hyperparameter values that result in a model that -// performs the best, as measured by an objective metric that you choose. A -// hyperparameter tuning job automatically creates Amazon SageMaker experiments, +// performs the best, as measured by an objective metric that you choose. +// +// A 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. +// these entities in Amazon SageMaker Studio. For more information, see [View Experiments, Trials, and Trial Components]. +// +// 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. +// +// [View Experiments, Trials, and Trial Components]: https://docs.aws.amazon.com/sagemaker/latest/dg/experiments-view-compare.html#experiments-view func (c *Client) CreateHyperParameterTuningJob(ctx context.Context, params *CreateHyperParameterTuningJobInput, optFns ...func(*Options)) (*CreateHyperParameterTuningJobOutput, error) { if params == nil { params = &CreateHyperParameterTuningJobInput{} @@ -41,12 +44,12 @@ func (c *Client) CreateHyperParameterTuningJob(ctx context.Context, params *Crea type CreateHyperParameterTuningJobInput struct { - // The HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) - // object that describes the tuning job, including the search strategy, the + // 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) - // . + // and resource limits for the tuning job. For more information, see [How Hyperparameter Tuning Works]. + // + // [How Hyperparameter Tuning Works]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html + // [HyperParameterTuningJobConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html // // This member is required. HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig @@ -62,55 +65,77 @@ type CreateHyperParameterTuningJobInput struct { // Configures SageMaker Automatic model tuning (AMT) to automatically find optimal // parameters for the following fields: - // - ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges) - // : The names and ranges of parameters that a hyperparameter tuning job can + // + // [ParameterRanges] + // - : The names and ranges of parameters that a hyperparameter tuning job can // optimize. - // - ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html) - // : The maximum resources that can be used for a training job. These resources - // include the maximum number of training jobs, the maximum runtime of a tuning - // job, and the maximum number of training jobs to run at the same time. - // - TrainingJobEarlyStoppingType (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType) - // : A flag that specifies whether or not to use early stopping for training jobs - // launched by a hyperparameter tuning job. - // - RetryStrategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy) - // : The number of times to retry a training job. - // - Strategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) - // : Specifies how hyperparameter tuning chooses the combinations of hyperparameter - // values to use for the training jobs that it launches. - // - ConvergenceDetected (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html) - // : A flag to indicate that Automatic model tuning (AMT) has detected model + // + // [ResourceLimits] + // - : The maximum resources that can be used for a training job. These + // resources include the maximum number of training jobs, the maximum runtime of a + // tuning job, and the maximum number of training jobs to run at the same time. + // + // [TrainingJobEarlyStoppingType] + // - : A flag that specifies whether or not to use early stopping for training + // jobs launched by a hyperparameter tuning job. + // + // [RetryStrategy] + // - : The number of times to retry a training job. + // + // [Strategy] + // - : Specifies how hyperparameter tuning chooses the combinations of + // hyperparameter values to use for the training jobs that it launches. + // + // [ConvergenceDetected] + // - : A flag to indicate that Automatic model tuning (AMT) has detected model // convergence. + // + // [TrainingJobEarlyStoppingType]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType + // [ConvergenceDetected]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html + // [ResourceLimits]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html + // [Strategy]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html + // [ParameterRanges]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges + // [RetryStrategy]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy Autotune *types.Autotune // 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 + // environment. For more information, see [Tagging Amazon Web Services Resources]. + // + // Tags that you specify for the tuning job are also added to all training jobs // that the tuning job launches. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag - // The HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) - // object that describes the training jobs that this tuning job launches, including - // static hyperparameters, input data configuration, output data configuration, - // resource configuration, and stopping condition. + // The [HyperParameterTrainingJobDefinition] object that describes the training jobs that this tuning job launches, + // including static hyperparameters, input data configuration, output data + // configuration, resource configuration, and stopping condition. + // + // [HyperParameterTrainingJobDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html TrainingJobDefinition *types.HyperParameterTrainingJobDefinition - // A list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) - // objects launched for this tuning job. + // A list of the [HyperParameterTrainingJobDefinition] objects launched for this tuning job. + // + // [HyperParameterTrainingJobDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html 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 - // 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 - // training job that performs the best as measured by the objective metric is - // returned as the overall best training job. All training jobs launched by parent - // hyperparameter tuning jobs and the new hyperparameter tuning jobs count against - // the limit of training jobs for the tuning job. + // 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 training job that performs the best + // as measured by the objective metric is returned as the overall best training + // job. + // + // All training jobs launched by parent hyperparameter tuning jobs and the new + // hyperparameter tuning jobs count against the limit of training jobs for the + // tuning job. WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateImage.go b/service/sagemaker/api_op_CreateImage.go index 13b21999e86..4a1725b0c90 100644 --- a/service/sagemaker/api_op_CreateImage.go +++ b/service/sagemaker/api_op_CreateImage.go @@ -13,8 +13,9 @@ 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 ECR. For more -// information, see Bring your own SageMaker image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) -// . +// information, see [Bring your own SageMaker image]. +// +// [Bring your own SageMaker 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 54f55eb3827..035a4bf9586 100644 --- a/service/sagemaker/api_op_CreateImageVersion.go +++ b/service/sagemaker/api_op_CreateImageVersion.go @@ -32,7 +32,8 @@ type CreateImageVersionInput struct { // The registry path of the container image to use as the starting point for this // version. The path is an Amazon ECR URI in the following format: - // .dkr.ecr..amazonaws.com/ + // + // .dkr.ecr..amazonaws.com/ // // This member is required. BaseImage *string @@ -56,8 +57,11 @@ 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. JobType types.JobType @@ -66,7 +70,9 @@ type CreateImageVersionInput struct { MLFramework *string // Indicates CPU or GPU compatibility. + // // - CPU : The image version is compatible with CPU. + // // - GPU : The image version is compatible with GPU. Processor types.Processor @@ -77,12 +83,16 @@ 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. VendorGuidance types.VendorGuidance diff --git a/service/sagemaker/api_op_CreateInferenceComponent.go b/service/sagemaker/api_op_CreateInferenceComponent.go index 768332b40ca..cb36137a664 100644 --- a/service/sagemaker/api_op_CreateInferenceComponent.go +++ b/service/sagemaker/api_op_CreateInferenceComponent.go @@ -64,9 +64,10 @@ type CreateInferenceComponentInput struct { // This member is required. VariantName *string - // 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) + // A list of key-value pairs associated with the model. For more information, see [Tagging Amazon Web Services resources] // in the Amazon Web Services General Reference. + // + // [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_CreateInferenceExperiment.go b/service/sagemaker/api_op_CreateInferenceExperiment.go index d0ac7047b8f..0a288513468 100644 --- a/service/sagemaker/api_op_CreateInferenceExperiment.go +++ b/service/sagemaker/api_op_CreateInferenceExperiment.go @@ -11,16 +11,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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]. +// +// 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) -// . +// metrics that compare your model variants. For more information, see [View, monitor, and edit shadow tests]. +// +// [Shadow tests]: https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html +// [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{} @@ -38,13 +44,13 @@ 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 + // The name of the Amazon SageMaker endpoint on which you want to run the // inference experiment. // // This member is required. EndpointName *string - // An array of ModelVariantConfig objects. There is one for each variant in the + // An array of ModelVariantConfig objects. There is one for each variant in the // inference experiment. Each ModelVariantConfig object in the array describes the // infrastructure configuration for the corresponding variant. // @@ -56,14 +62,14 @@ type CreateInferenceExperimentInput struct { // This member is required. Name *string - // The ARN of the IAM role that Amazon SageMaker can assume to access model + // The ARN of the IAM role that Amazon SageMaker can assume to access model // artifacts and container images, and manage Amazon SageMaker Inference endpoints // for model deployment. // // This member is required. RoleArn *string - // The configuration of ShadowMode inference experiment type. Use this field to + // The configuration of ShadowMode inference experiment type. Use this field to // specify a production variant which takes all the inference requests, and a // shadow variant to which Amazon SageMaker replicates a percentage of the // inference requests. For the shadow variant also specify the percentage of @@ -72,34 +78,50 @@ type CreateInferenceExperimentInput struct { // This member is required. ShadowModeConfig *types.ShadowModeConfig - // The type of the inference experiment that you want to run. The following types + // 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) - // . + // information, see [Shadow tests]. + // + // [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) - // . + // 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]. + // + // [Capture data]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html DataStorageConfig *types.InferenceExperimentDataStorageConfig // A description for the inference experiment. Description *string - // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key + // 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. The KmsKey can be any of the // following formats: - // - KMS key ID "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" - // - KMS key Alias "alias/ExampleAlias" + // + // "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" + // + // "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 @@ -107,23 +129,26 @@ type CreateInferenceExperimentInput struct { // 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. + // information, see [KMS managed Encryption Keys]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] in + // the Amazon Web Services Key Management Service Developer Guide. + // + // [Using Key Policies in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html + // [KMS managed Encryption Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html KmsKey *string - // The duration for which you want the inference experiment to run. If you don't + // The duration for which you want the inference experiment to run. If you don't // specify this field, the experiment automatically starts immediately upon // creation and concludes after 7 days. Schedule *types.InferenceExperimentSchedule - // Array of key-value pairs. You can use tags to categorize your Amazon Web + // 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) . + // environment. For more information, see [Tagging your Amazon Web Services Resources]. + // + // [Tagging your Amazon Web Services 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 849ce39b504..fcb4713efdd 100644 --- a/service/sagemaker/api_op_CreateInferenceRecommendationsJob.go +++ b/service/sagemaker/api_op_CreateInferenceRecommendationsJob.go @@ -72,9 +72,10 @@ type CreateInferenceRecommendationsJobInput struct { // The metadata that you apply to Amazon Web Services resources to help you // categorize and organize them. Each tag consists of a key and a value, both of - // which you define. 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. + // which you define. For more information, see [Tagging Amazon Web Services Resources]in the Amazon Web Services General + // Reference. + // + // [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_CreateLabelingJob.go b/service/sagemaker/api_op_CreateLabelingJob.go index 5d24156ed85..6e44de23932 100644 --- a/service/sagemaker/api_op_CreateLabelingJob.go +++ b/service/sagemaker/api_op_CreateLabelingJob.go @@ -12,13 +12,17 @@ import ( ) // 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: +// 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. @@ -26,21 +30,28 @@ import ( // 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) -// . +// sent to a human worker. For more information, see [Using Automated Data Labeling]. +// +// 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]. +// +// 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)]in +// the Amazon SageMaker Developer Guide. To learn how to create a streaming +// labeling job, see [Create a Streaming Labeling Job]. +// +// [Using Automated Data Labeling]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-automated-labeling.html +// [Create a Streaming Labeling Job]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-create-job.html +// [Create a Labeling Job (API)]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-create-labeling-job-api.html +// [Using Input and Output Data]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-data.html func (c *Client) CreateLabelingJob(ctx context.Context, params *CreateLabelingJobInput, optFns ...func(*Options)) (*CreateLabelingJobOutput, error) { if params == nil { params = &CreateLabelingJobInput{} @@ -66,14 +77,18 @@ 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 // information. Use ContentClassifiers to specify that your data is free of @@ -85,31 +100,41 @@ type CreateLabelingJobInput struct { // 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". + // + // - If you are using one of the following [built-in task types], 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) - // . + // verification labeling jobs, see [Verify and Adjust Labels]. + // + // [built-in task types]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html + // [Verify and Adjust Labels]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html // // This member is required. LabelAttributeName *string @@ -137,36 +162,55 @@ type CreateLabelingJobInput struct { 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 + // 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]. + // + // 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. { + // + // ", "fullInstruction":" Add additional instructions. + // + // "} . For details and an example, see [Create a Named Entity Recognition Labeling Job (API)]. + // + // For all other [built-in task types] and [custom tasks], 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: + // + // } + // + // 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. + // configuration. Use this parameter to enter the [LabelAttributeName]LabelAttributeName of the + // labeling job you want to adjust or verify annotations of. + // + // [built-in task types]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html + // [custom tasks]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html + // [LabelAttributeName]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName + // [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 + // [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 LabelCategoryConfigS3Uri *string // Configures the information required to perform automated data labeling. @@ -177,9 +221,10 @@ type CreateLabelingJobInput struct { // the cost of data labeling. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // An array of key/value pairs. For more information, see [Using Cost Allocation Tags] in the Amazon Web + // Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateModel.go b/service/sagemaker/api_op_CreateModel.go index 74e03e3b240..085d23aae92 100644 --- a/service/sagemaker/api_op_CreateModel.go +++ b/service/sagemaker/api_op_CreateModel.go @@ -15,19 +15,26 @@ import ( // primary container. For the primary container, you specify the Docker image that // contains inference code, artifacts (from prior training), and a custom // environment map that the inference code uses when you deploy the model for -// predictions. Use this API to create a model if you want to use SageMaker hosting -// services or run a batch transform job. To host your model, you create an -// endpoint configuration with the CreateEndpointConfig API, and then create an -// endpoint with the CreateEndpoint API. SageMaker then deploys all of the -// containers that you defined for the model in the hosting environment. 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 also provide an IAM role -// that SageMaker can assume to access model artifacts and docker image for -// deployment on ML compute hosting instances or for batch transform jobs. In -// addition, you also use the IAM role to manage permissions the inference code -// needs. For example, if the inference code access any other Amazon Web Services -// resources, you grant necessary permissions via this role. +// predictions. +// +// Use this API to create a model if you want to use SageMaker hosting services or +// run a batch transform job. +// +// To host your model, you create an endpoint configuration with the +// CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint +// API. SageMaker then deploys all of the containers that you defined for the model +// in the hosting environment. +// +// 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 also provide an IAM role that SageMaker can assume to +// access model artifacts and docker image for deployment on ML compute hosting +// instances or for batch transform jobs. In addition, you also use the IAM role to +// manage permissions the inference code needs. For example, if the inference code +// access any other Amazon Web Services resources, you grant necessary permissions +// via this role. func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error) { if params == nil { params = &CreateModelInput{} @@ -60,9 +67,12 @@ 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]. + // + // 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 ExecutionRoleArn *string // Specifies details of how containers in a multi-container endpoint are called. @@ -75,17 +85,19 @@ 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]. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // 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) . + // 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]and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud]. + // + // [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]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Endpoints by Using an Amazon Virtual Private Cloud]: https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html VpcConfig *types.VpcConfig noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateModelBiasJobDefinition.go b/service/sagemaker/api_op_CreateModelBiasJobDefinition.go index 412d3a8f20c..6a5516d97e5 100644 --- a/service/sagemaker/api_op_CreateModelBiasJobDefinition.go +++ b/service/sagemaker/api_op_CreateModelBiasJobDefinition.go @@ -70,9 +70,10 @@ type CreateModelBiasJobDefinitionInput struct { // A time limit for how long the monitoring job is allowed to run before stopping. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateModelCard.go b/service/sagemaker/api_op_CreateModelCard.go index 806b82809f4..7d7afee9578 100644 --- a/service/sagemaker/api_op_CreateModelCard.go +++ b/service/sagemaker/api_op_CreateModelCard.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// Creates an Amazon SageMaker Model Card. +// +// For information about how to use model cards, see [Amazon SageMaker Model Card]. +// +// [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 +33,9 @@ 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.html#model-cards-json-schema) - // and provided as a string. + // The content of the model card. Content must be in [model card JSON schema] and provided as a string. + // + // [model card JSON schema]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema // // This member is required. Content *string @@ -44,9 +47,13 @@ type CreateModelCardInput struct { // 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. // diff --git a/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go b/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go index b3b32ddc324..a5fd284c112 100644 --- a/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go +++ b/service/sagemaker/api_op_CreateModelExplainabilityJobDefinition.go @@ -29,7 +29,7 @@ func (c *Client) CreateModelExplainabilityJobDefinition(ctx context.Context, par type CreateModelExplainabilityJobDefinitionInput struct { - // The name of the model explainability job definition. The name must be unique + // The name of the model explainability job definition. The name must be unique // within an Amazon Web Services Region in the Amazon Web Services account. // // This member is required. @@ -71,9 +71,10 @@ type CreateModelExplainabilityJobDefinitionInput struct { // A time limit for how long the monitoring job is allowed to run before stopping. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateModelPackage.go b/service/sagemaker/api_op_CreateModelPackage.go index 724045d21f0..e89235b7bb7 100644 --- a/service/sagemaker/api_op_CreateModelPackage.go +++ b/service/sagemaker/api_op_CreateModelPackage.go @@ -14,13 +14,18 @@ import ( // Creates a model package that you can use to create SageMaker models or list on // Amazon Web Services Marketplace, or a versioned model that is part of a model // 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 . -// 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: +// 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 . 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. func (c *Client) CreateModelPackage(ctx context.Context, params *CreateModelPackageInput, optFns ...func(*Options)) (*CreateModelPackageOutput, error) { if params == nil { @@ -46,8 +51,10 @@ type CreateModelPackageInput struct { AdditionalInferenceSpecifications []types.AdditionalInferenceSpecificationDefinition // Whether to certify the model package for listing on Amazon Web Services - // Marketplace. This parameter is optional for unversioned models, and does not - // apply to versioned models. + // Marketplace. + // + // This parameter is optional for unversioned models, and does not apply to + // versioned models. CertifyForMarketplace *bool // A unique token that guarantees that the call to this API is idempotent. @@ -62,17 +69,21 @@ type CreateModelPackageInput struct { Domain *string // 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) - // in the Amazon SageMaker Developer Guide. + // set using the model package. For more information, see the topic on [Drift Detection against Previous Baselines in SageMaker Pipelines]in the + // Amazon SageMaker Developer Guide. + // + // [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 DriftCheckBaselines *types.DriftCheckBaselines // Specifies details about inference jobs that you can run with models based on // this model package, including the following information: + // // - 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 @@ -80,9 +91,13 @@ type CreateModelPackageInput struct { // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *types.MetadataProperties - // Whether the model is approved for deployment. This parameter is optional for - // versioned models, and does not apply to unversioned models. For versioned - // models, the value of this parameter must be set to Approved to deploy the model. + // Whether the model is approved for deployment. + // + // This parameter is optional for versioned models, and does not apply to + // unversioned models. + // + // For versioned models, the value of this parameter must be set to Approved to + // deploy the model. ModelApprovalStatus types.ModelApprovalStatus // A structure that contains model metrics reports. @@ -92,21 +107,26 @@ type CreateModelPackageInput struct { ModelPackageDescription *string // The name or Amazon Resource Name (ARN) of the model package group that this - // model version belongs to. This parameter is required for versioned models, and - // does not apply to unversioned models. + // model version belongs to. + // + // This parameter is required for versioned models, and does not apply to + // unversioned models. ModelPackageGroupName *string // The name of the model package. The name must have 1 to 63 characters. Valid - // characters are a-z, A-Z, 0-9, and - (hyphen). This parameter is required for - // unversioned models. It is not applicable to versioned models. + // characters are a-z, A-Z, 0-9, and - (hyphen). + // + // This parameter is required for unversioned models. It is not applicable to + // versioned models. ModelPackageName *string // The Amazon Simple Storage Service (Amazon S3) path where the sample payload is // 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) + // load test. Each file in the archive must satisfy the size constraints of the [InvokeEndpoint] // call. + // + // [InvokeEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax SamplePayloadUrl *string // Indicates if you want to skip model validation. @@ -120,20 +140,23 @@ type CreateModelPackageInput struct { // register a model, set it to the model ARN. SourceUri *string - // 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. If you supply - // ModelPackageGroupName , your model package belongs to the model group you - // specify and uses the tags associated with the model group. In this case, you - // cannot supply a tag argument. + // A list of key value pairs associated with the model. For more information, see [Tagging Amazon Web Services resources] + // in the Amazon Web Services General Reference Guide. + // + // If you supply ModelPackageGroupName , your model package belongs to the model + // group you specify and uses the tags associated with the model group. In this + // case, you cannot supply a tag argument. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html 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 - // listed fit your use case. + // "CLASSIFICATION" | "REGRESSION" | "OTHER" . + // + // Specify "OTHER" if none of the tasks listed fit your use case. Task *string // Specifies configurations for one or more transform jobs that SageMaker runs to diff --git a/service/sagemaker/api_op_CreateModelPackageGroup.go b/service/sagemaker/api_op_CreateModelPackageGroup.go index f15f2924508..635d65be5ae 100644 --- a/service/sagemaker/api_op_CreateModelPackageGroup.go +++ b/service/sagemaker/api_op_CreateModelPackageGroup.go @@ -38,8 +38,9 @@ type CreateModelPackageGroupInput struct { 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. + // information, see [Tagging Amazon Web Services resources]in the Amazon Web Services General Reference Guide. + // + // [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_CreateModelQualityJobDefinition.go b/service/sagemaker/api_op_CreateModelQualityJobDefinition.go index be736254979..d3575732d09 100644 --- a/service/sagemaker/api_op_CreateModelQualityJobDefinition.go +++ b/service/sagemaker/api_op_CreateModelQualityJobDefinition.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -71,9 +72,10 @@ type CreateModelQualityJobDefinitionInput struct { // A time limit for how long the monitoring job is allowed to run before stopping. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateMonitoringSchedule.go b/service/sagemaker/api_op_CreateMonitoringSchedule.go index 144633cb26a..7a65207efcc 100644 --- a/service/sagemaker/api_op_CreateMonitoringSchedule.go +++ b/service/sagemaker/api_op_CreateMonitoringSchedule.go @@ -42,9 +42,10 @@ type CreateMonitoringScheduleInput struct { // This member is required. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateNotebookInstance.go b/service/sagemaker/api_op_CreateNotebookInstance.go index a1b3ec18793..0d50281a082 100644 --- a/service/sagemaker/api_op_CreateNotebookInstance.go +++ b/service/sagemaker/api_op_CreateNotebookInstance.go @@ -12,20 +12,27 @@ import ( ) // Creates an SageMaker notebook instance. A notebook instance is a machine -// learning (ML) compute instance running on a Jupyter notebook. In a -// CreateNotebookInstance request, specify the type of ML compute instance that you -// want to run. SageMaker launches the instance, installs common libraries that you -// can use to explore datasets for model training, and attaches an ML storage -// volume to the notebook instance. SageMaker also provides a set of example -// 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: +// learning (ML) compute instance running on a Jupyter notebook. +// +// In a CreateNotebookInstance request, specify the type of ML compute instance +// that you want to run. SageMaker launches the instance, installs common libraries +// that you can use to explore datasets for model training, and attaches an ML +// storage volume to the notebook instance. +// +// SageMaker also provides a set of example 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 @@ -34,12 +41,16 @@ import ( // // 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) -// . +// 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]. +// +// [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{} @@ -67,50 +78,56 @@ type CreateNotebookInstanceInput struct { // This member is required. NotebookInstanceName *string - // When you send any requests to Amazon Web Services resources from the notebook + // When you send any requests to Amazon Web Services resources from the notebook // 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]. + // + // 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 // // 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]. + // + // [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) - // . + // in your account, or the URL of Git repositories in [Amazon Web Services CodeCommit]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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) - // . + // in your account, or the URL of a Git repository in [Amazon Web Services CodeCommit]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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. + // endpoint services unless you configure a NAT Gateway in your VPC. + // + // For more information, see [Notebook Instances Are Internet-Enabled by Default]. You can set the value of this parameter to Disabled + // only if you set a value for the SubnetId parameter. + // + // [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 // Information on the IMDS configuration of the notebook instance @@ -119,24 +136,26 @@ 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]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 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) - // . + // For information about lifestyle configurations, see [Step 2.1: (Optional) Customize a Notebook Instance]. + // + // [Step 2.1: (Optional) 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 - // 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. + // 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 @@ -149,8 +168,9 @@ 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]. + // + // [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 d4d3f884d11..7f933d9dc1a 100644 --- a/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_CreateNotebookInstanceLifecycleConfig.go @@ -13,17 +13,24 @@ import ( // Creates a lifecycle configuration that you can associate with a notebook // 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 . +// 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 Amazon CloudWatch Logs for notebook instance lifecycle configurations in // log group /aws/sagemaker/NotebookInstances in log 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) -// . +// [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]. +// +// [Step 2.1: (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_CreatePipeline.go b/service/sagemaker/api_op_CreatePipeline.go index e143fadf6fa..5167896332a 100644 --- a/service/sagemaker/api_op_CreatePipeline.go +++ b/service/sagemaker/api_op_CreatePipeline.go @@ -50,8 +50,9 @@ type CreatePipelineInput struct { // specified, it applies to all runs of this pipeline by default. ParallelismConfiguration *types.ParallelismConfiguration - // The JSON pipeline definition (https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/) - // of the pipeline. + // The [JSON pipeline definition] of the pipeline. + // + // [JSON pipeline definition]: https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/ PipelineDefinition *string // The location of the pipeline definition stored in Amazon S3. If specified, diff --git a/service/sagemaker/api_op_CreatePresignedDomainUrl.go b/service/sagemaker/api_op_CreatePresignedDomainUrl.go index 3239eb9259a..6b7d4ed2bf3 100644 --- a/service/sagemaker/api_op_CreatePresignedDomainUrl.go +++ b/service/sagemaker/api_op_CreatePresignedDomainUrl.go @@ -14,18 +14,23 @@ import ( // browser, the user will be automatically signed in to the domain, and granted // access to all of the Apps and files associated with the Domain's Amazon Elastic // File System volume. This operation can only be called when the authentication -// mode equals IAM. The IAM role or user passed to this API defines the permissions -// to access the app. Once the presigned URL is created, no additional permission -// is required to access this URL. IAM authorization policies for this API are also -// enforced for every HTTP request and WebSocket frame that 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 Amazon SageMaker 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 +// mode equals IAM. +// +// The IAM role or user passed to this API defines the permissions to access the +// app. Once the presigned URL is created, no additional permission is required to +// access this URL. IAM authorization policies for this API are also enforced for +// every HTTP request and WebSocket frame that 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 Amazon SageMaker Studio Through an Interface VPC Endpoint]. +// +// 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 // you try to use the URL after the timeout limit expires, you are directed to the // Amazon Web Services console sign-in page. +// +// [Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint]: https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html func (c *Client) CreatePresignedDomainUrl(ctx context.Context, params *CreatePresignedDomainUrlInput, optFns ...func(*Options)) (*CreatePresignedDomainUrlOutput, error) { if params == nil { params = &CreatePresignedDomainUrlInput{} @@ -60,15 +65,21 @@ type CreatePresignedDomainUrlInput struct { // The landing page that the user is directed to when accessing the presigned URL. // Using this value, users can access Studio or Studio Classic, even if it is not // the default experience for the domain. The supported values are: + // // - studio::relative/path : Directs users to the relative path in Studio. + // // - app:JupyterServer:relative/path : Directs users to the relative path in the // Studio Classic application. + // // - app:JupyterLab:relative/path : Directs users to the relative path in the // JupyterLab application. + // // - app:RStudioServerPro:relative/path : Directs users to the relative path in // the RStudio application. + // // - app:CodeEditor:relative/path : Directs users to the relative path in the // Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. + // // - app:Canvas:relative/path : Directs users to the relative path in the Canvas // application. LandingUri *string diff --git a/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go b/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go index 99b1aad2d44..f5cc72efe88 100644 --- a/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go +++ b/service/sagemaker/api_op_CreatePresignedNotebookInstanceUrl.go @@ -14,19 +14,25 @@ import ( // instance. In the SageMaker console, when you choose Open next to a notebook // instance, SageMaker opens a new tab showing the Jupyter server home page from // the notebook instance. The console uses this API to get the URL and show the -// page. The IAM role or user used to call this API defines the permissions to -// access the notebook instance. Once the presigned URL is created, no additional +// page. +// +// The IAM role or user used to call this API defines the permissions to access +// the notebook instance. Once the presigned URL is created, no additional // permission is required to access this URL. IAM authorization policies for this // API are also enforced for every HTTP request and WebSocket frame that attempts -// to connect to the notebook instance. You can restrict access to this API and to -// the URL that it returns to a list of IP addresses that you specify. Use the -// 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html) -// 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. +// to connect to the notebook instance. +// +// You can restrict access to this API and to the URL that it returns to a list of +// IP addresses that you specify. Use the 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]. +// +// 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. +// +// [CreatePresignedNotebookInstanceUrl]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html +// [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 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 0bf81760664..c411d751a9c 100644 --- a/service/sagemaker/api_op_CreateProcessingJob.go +++ b/service/sagemaker/api_op_CreateProcessingJob.go @@ -34,7 +34,7 @@ type CreateProcessingJobInput struct { // This member is required. AppSpecification *types.AppSpecification - // The name of the processing job. The name must be unique within an Amazon Web + // The name of the processing job. The name must be unique within an Amazon Web // Services Region in the Amazon Web Services account. // // This member is required. @@ -59,9 +59,16 @@ type CreateProcessingJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html ExperimentConfig *types.ExperimentConfig // Networking options for a processing job, such as whether to allow inbound and @@ -79,9 +86,10 @@ type CreateProcessingJobInput struct { // The time limit for how long the processing job is allowed to run. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateProject.go b/service/sagemaker/api_op_CreateProject.go index d208d92b8ed..fe1819f03b0 100644 --- a/service/sagemaker/api_op_CreateProject.go +++ b/service/sagemaker/api_op_CreateProject.go @@ -38,8 +38,9 @@ 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]. + // + // [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,9 +49,10 @@ 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]in the Amazon Web + // Services General Reference Guide. + // + // [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_CreateTrainingJob.go b/service/sagemaker/api_op_CreateTrainingJob.go index b183e314ecd..c5064705af7 100644 --- a/service/sagemaker/api_op_CreateTrainingJob.go +++ b/service/sagemaker/api_op_CreateTrainingJob.go @@ -12,44 +12,64 @@ import ( ) // Starts a model training job. After training completes, SageMaker saves the -// resulting model artifacts to an Amazon S3 location that you specify. If you -// choose to host your model using SageMaker hosting services, you can use the -// 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: +// resulting model artifacts to an Amazon S3 location that you specify. +// +// If you choose to host your model using SageMaker hosting services, you can use +// the 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 . +// algorithm provided by SageMaker, see [Algorithms]. +// +// 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]. +// +// - RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform +// tasks on your behalf during model training. // -// For more information about SageMaker, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html) -// . +// 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]. +// +// [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html +// [How It Works]: https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html +// +// [Managed Spot Training]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html func (c *Client) CreateTrainingJob(ctx context.Context, params *CreateTrainingJobInput, optFns ...func(*Options)) (*CreateTrainingJobOutput, error) { if params == nil { params = &CreateTrainingJobInput{} @@ -69,10 +89,11 @@ 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]. For information about providing + // your own algorithms, see [Using Your Own Algorithms with Amazon SageMaker]. + // + // [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html + // [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 @@ -84,24 +105,30 @@ type CreateTrainingJobInput struct { 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 - // 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 - // distributed training algorithms, specify an instance count greater than 1. + // 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 distributed + // training algorithms, specify an instance count greater than 1. // // This member is required. ResourceConfig *types.ResourceConfig // The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to - // perform tasks on your behalf. During model training, SageMaker needs your - // permission to read input data from an S3 bucket, download a Docker image that - // 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. + // perform tasks on your behalf. + // + // During model training, SageMaker needs your permission to read input data from + // an S3 bucket, download a Docker image that 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]. + // + // 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 // // This member is required. RoleArn *string @@ -109,9 +136,11 @@ type CreateTrainingJobInput struct { // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches the // time limit, SageMaker ends the training job. Use this API to cap model training - // costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts, so the results of training are not lost. + // costs. + // + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window to + // save the model artifacts, so the results of training are not lost. // // This member is required. StoppingCondition *types.StoppingCondition @@ -128,9 +157,9 @@ 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) - // . + // configure the DebugHookConfig parameter, see [Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job]. + // + // [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 DebugHookConfig *types.DebugHookConfig // Configuration information for Amazon SageMaker Debugger rules for debugging @@ -141,19 +170,21 @@ type CreateTrainingJobInput struct { // 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) - // . + // learning algorithm in distributed training. For more information, see [Protect Communications Between ML Compute Instances in a Distributed Training Job]. + // + // [Protect 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 // 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 - // intermediate results of jobs are stored in an Amazon S3 bucket, and can be used - // as a starting point to train models incrementally. Amazon SageMaker provides - // metrics and logs in CloudWatch. They can be used to see when managed spot - // training jobs are running, interrupted, resumed, or completed. + // when there is flexibility when the training job is run. + // + // The complete and intermediate results of jobs are stored in an Amazon S3 + // bucket, and can be used as a starting point to train models incrementally. + // Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to + // see when managed spot training jobs are running, interrupted, resumed, or + // completed. EnableManagedSpotTraining *bool // Isolates the training container. No inbound or outbound network calls can be @@ -169,21 +200,32 @@ type CreateTrainingJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html 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 - // pair. Each key and value is limited to 256 characters, as specified by the - // 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. + // hyperparameters for each training algorithm provided by SageMaker, see [Algorithms]. + // + // 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 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. + // + // [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html HyperParameters map[string]string // Contains information about the infrastructure health check configuration for @@ -191,18 +233,22 @@ type CreateTrainingJobInput struct { InfraCheckConfig *types.InfraCheckConfig // 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 - // 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 - // input data files from an S3 bucket to a local directory in the Docker container, - // or makes it available as input streams. For example, if you specify an EFS - // location, input data files are available as input streams. They do not need to - // be downloaded. Your input must be in the same Amazon Web Services region as your - // training job. + // 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 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 input data files from an S3 bucket to a local directory in the Docker + // container, or makes it available as input streams. For example, if you specify + // an EFS location, input data files are available as input streams. They do not + // need to be downloaded. + // + // Your input must be in the same Amazon Web Services region as your training job. InputDataConfig []types.Channel // Configuration information for Amazon SageMaker Debugger system monitoring, @@ -214,9 +260,9 @@ type CreateTrainingJobInput struct { ProfilerRuleConfigurations []types.ProfilerRuleConfiguration // Configuration for remote debugging. To learn more about the remote debugging - // functionality of SageMaker, see Access a training container through Amazon Web - // Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html) - // . + // functionality of SageMaker, see [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]. + // + // [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html RemoteDebugConfig *types.RemoteDebugConfig // The number of times to retry the job when the job fails due to an @@ -229,19 +275,21 @@ type CreateTrainingJobInput 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]. + // + // [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. TensorBoardOutputConfig *types.TensorBoardOutputConfig - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // object that specifies the VPC that you want your training job to connect to. + // 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) . + // more information, see [Protect Training Jobs by Using an Amazon Virtual Private Cloud]. + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Training Jobs by Using an Amazon 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 2e6cbbc3ced..00e2e68c1ac 100644 --- a/service/sagemaker/api_op_CreateTransformJob.go +++ b/service/sagemaker/api_op_CreateTransformJob.go @@ -13,25 +13,32 @@ 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. +// // - 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) -// . +// Amazon Web Services account. For information on creating a model, see [CreateModel]. +// // - 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]. +// +// [CreateModel]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html +// [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{} @@ -80,12 +87,16 @@ type CreateTransformJobInput struct { // 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 . + // 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. @@ -96,9 +107,9 @@ type CreateTransformJobInput struct { // results in the output. The input filter provided allows you to exclude input // 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) - // . + // predictions in the output from the job. For more information, see [Associate Prediction Results with their Corresponding Input Records]. + // + // [Associate 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 @@ -107,19 +118,26 @@ type CreateTransformJobInput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html 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]. For + // built-in algorithms, you don't need to set a value for MaxConcurrentTransforms . + // + // [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 MaxConcurrentTransforms *int32 // The maximum allowed size of the payload, in MB. A payload is the data portion @@ -127,9 +145,12 @@ type CreateTransformJobInput struct { // 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. + // 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 // algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP @@ -140,9 +161,10 @@ type CreateTransformJobInput struct { // job invocation. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // (Optional) An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the + // Amazon Web Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateTrial.go b/service/sagemaker/api_op_CreateTrial.go index 549645734fd..d923e4f0ff3 100644 --- a/service/sagemaker/api_op_CreateTrial.go +++ b/service/sagemaker/api_op_CreateTrial.go @@ -13,16 +13,22 @@ import ( // Creates an SageMaker trial. A trial is a set of steps called trial components // that produce a machine learning model. A trial is part of a single SageMaker -// experiment. 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), you must -// use the logging APIs provided by the SDK. You can add tags to a trial and then -// use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API to search for the tags. To get a list of all your trials, call the -// ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) -// API. To view a trial's properties, call the DescribeTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html) -// API. To create a trial component, call the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) -// API. +// experiment. +// +// 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), you must use the +// logging APIs provided by the SDK. +// +// You can add tags to a trial and then use the [Search] API to search for the tags. +// +// To get a list of all your trials, call the [ListTrials] API. To view a trial's properties, +// call the [DescribeTrial]API. To create a trial component, call the [CreateTrialComponent] API. +// +// [DescribeTrial]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html +// [ListTrials]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html +// [CreateTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html func (c *Client) CreateTrial(ctx context.Context, params *CreateTrialInput, optFns ...func(*Options)) (*CreateTrialOutput, error) { if params == nil { params = &CreateTrialInput{} @@ -58,8 +64,10 @@ type CreateTrialInput struct { // Metadata properties of the tracking entity, trial, or trial component. MetadataProperties *types.MetadataProperties - // A list of tags to associate with the trial. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) - // API to search on the tags. + // A list of tags to associate with the trial. You can use [Search] API to search on the + // tags. + // + // [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateTrialComponent.go b/service/sagemaker/api_op_CreateTrialComponent.go index bca121e2a21..da1fff35adc 100644 --- a/service/sagemaker/api_op_CreateTrialComponent.go +++ b/service/sagemaker/api_op_CreateTrialComponent.go @@ -14,13 +14,20 @@ import ( // 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), -// you must use the logging APIs provided by the SDK. You can add tags to a trial -// component and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API to search for the tags. +// 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), you must use the +// logging APIs provided by the SDK. +// +// You can add tags to a trial component and then use the [Search] API to search for the +// tags. +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html func (c *Client) CreateTrialComponent(ctx context.Context, params *CreateTrialComponentInput, optFns ...func(*Options)) (*CreateTrialComponentOutput, error) { if params == nil { params = &CreateTrialComponentInput{} @@ -69,13 +76,18 @@ type CreateTrialComponentInput struct { StartTime *time.Time // The status of the component. States include: + // // - InProgress + // // - Completed + // // - Failed Status *types.TrialComponentStatus - // A list of tags to associate with the component. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) - // 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. + // + // [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_CreateUserProfile.go b/service/sagemaker/api_op_CreateUserProfile.go index 767b5c78e4a..d9d4220d2b4 100644 --- a/service/sagemaker/api_op_CreateUserProfile.go +++ b/service/sagemaker/api_op_CreateUserProfile.go @@ -58,8 +58,10 @@ type CreateUserProfileInput struct { SingleSignOnUserValue *string // Each tag consists of a key and an optional value. Tag keys must be unique per - // resource. Tags that you specify for the User Profile are also added to all Apps - // that the User Profile launches. + // resource. + // + // Tags that you specify for the User Profile are also added to all Apps that the + // User Profile launches. Tags []types.Tag // A collection of settings. diff --git a/service/sagemaker/api_op_CreateWorkforce.go b/service/sagemaker/api_op_CreateWorkforce.go index 904b3975489..db13701cb49 100644 --- a/service/sagemaker/api_op_CreateWorkforce.go +++ b/service/sagemaker/api_op_CreateWorkforce.go @@ -14,19 +14,24 @@ import ( // 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 -// DeleteWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html) -// 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), +// 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 [DeleteWorkforce]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)]. +// +// 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)]. +// +// [Create a Private Workforce (Amazon Cognito)]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html +// [DeleteWorkforce]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html +// [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,20 +55,25 @@ 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]. + // + // Do not use OidcConfig if you specify values for CognitoConfig . + // + // [Amazon Cognito user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html 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 - // . + // 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] ). 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. + // + // [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html 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 7b8234e99a2..d1c36d080fa 100644 --- a/service/sagemaker/api_op_CreateWorkteam.go +++ b/service/sagemaker/api_op_CreateWorkteam.go @@ -13,8 +13,9 @@ import ( // 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. +// 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{} @@ -38,21 +39,26 @@ type CreateWorkteamInput struct { Description *string // 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 - // 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 + // 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 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]. + // + // 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 . // + // [Amazon Cognito User Pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html + // // This member is required. MemberDefinitions []types.MemberDefinition @@ -64,9 +70,13 @@ 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // An array of key-value pairs. + // + // For more information, see [Resource Tag] and [Using Cost Allocation Tags] in the Amazon Web Services Billing and Cost + // Management User Guide. + // + // [Resource Tag]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what Tags []types.Tag // The name of the workforce. diff --git a/service/sagemaker/api_op_DeleteCompilationJob.go b/service/sagemaker/api_op_DeleteCompilationJob.go index 1fcfdf48d5f..da8d5ce248a 100644 --- a/service/sagemaker/api_op_DeleteCompilationJob.go +++ b/service/sagemaker/api_op_DeleteCompilationJob.go @@ -13,10 +13,11 @@ import ( // Deletes the specified compilation job. This action deletes only the compilation // job resource in Amazon SageMaker. It doesn't delete other resources that are // related to that job, such as the model artifacts that the job creates, the -// compilation logs in CloudWatch, the compiled model, or the IAM role. You can -// delete a compilation job only if its current status is COMPLETED , FAILED , or -// STOPPED . If the job status is STARTING or INPROGRESS , stop the job, and then -// delete it after its status becomes STOPPED . +// compilation logs in CloudWatch, the compiled model, or the IAM role. +// +// You can delete a compilation job only if its current status is COMPLETED , +// FAILED , or STOPPED . If the job status is STARTING or INPROGRESS , stop the +// job, and then delete it after its status becomes STOPPED . func (c *Client) DeleteCompilationJob(ctx context.Context, params *DeleteCompilationJobInput, optFns ...func(*Options)) (*DeleteCompilationJobOutput, error) { if params == nil { params = &DeleteCompilationJobInput{} diff --git a/service/sagemaker/api_op_DeleteEndpoint.go b/service/sagemaker/api_op_DeleteEndpoint.go index 354feb637dd..650c726e71a 100644 --- a/service/sagemaker/api_op_DeleteEndpoint.go +++ b/service/sagemaker/api_op_DeleteEndpoint.go @@ -11,13 +11,19 @@ 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. +// 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]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], otherwise SageMaker cannot delete these +// resources. +// +// [ExecutionRoleArn]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn +// [RevokeGrant]: http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html 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 4329559eda3..a24b25e33a8 100644 --- a/service/sagemaker/api_op_DeleteEndpointConfig.go +++ b/service/sagemaker/api_op_DeleteEndpointConfig.go @@ -12,12 +12,14 @@ import ( // 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 -// 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. +// 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 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. func (c *Client) DeleteEndpointConfig(ctx context.Context, params *DeleteEndpointConfigInput, optFns ...func(*Options)) (*DeleteEndpointConfigOutput, error) { if params == nil { params = &DeleteEndpointConfigInput{} diff --git a/service/sagemaker/api_op_DeleteExperiment.go b/service/sagemaker/api_op_DeleteExperiment.go index f27170b9cf7..4e428efc605 100644 --- a/service/sagemaker/api_op_DeleteExperiment.go +++ b/service/sagemaker/api_op_DeleteExperiment.go @@ -11,8 +11,10 @@ import ( ) // Deletes an SageMaker experiment. All trials associated with the experiment must -// be deleted first. Use the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) -// API to get a list of the trials associated with the experiment. +// be deleted first. Use the [ListTrials]API to get a list of the trials associated with the +// experiment. +// +// [ListTrials]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html func (c *Client) DeleteExperiment(ctx context.Context, params *DeleteExperimentInput, optFns ...func(*Options)) (*DeleteExperimentOutput, error) { if params == nil { params = &DeleteExperimentInput{} diff --git a/service/sagemaker/api_op_DeleteFeatureGroup.go b/service/sagemaker/api_op_DeleteFeatureGroup.go index 5559587aff3..18686ed6796 100644 --- a/service/sagemaker/api_op_DeleteFeatureGroup.go +++ b/service/sagemaker/api_op_DeleteFeatureGroup.go @@ -12,11 +12,14 @@ 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 -// 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. Note that it can take -// approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the -// InMemory StorageType . +// 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. +// +// Note that it can take approximately 10-15 minutes to delete an OnlineStore +// FeatureGroup with the InMemory StorageType . func (c *Client) DeleteFeatureGroup(ctx context.Context, params *DeleteFeatureGroupInput, optFns ...func(*Options)) (*DeleteFeatureGroupOutput, error) { if params == nil { params = &DeleteFeatureGroupInput{} diff --git a/service/sagemaker/api_op_DeleteHub.go b/service/sagemaker/api_op_DeleteHub.go index ed4b2ffcaf9..bbfd337e576 100644 --- a/service/sagemaker/api_op_DeleteHub.go +++ b/service/sagemaker/api_op_DeleteHub.go @@ -10,7 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a hub. Hub APIs are only callable through SageMaker Studio. +// Delete a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) DeleteHub(ctx context.Context, params *DeleteHubInput, optFns ...func(*Options)) (*DeleteHubOutput, error) { if params == nil { params = &DeleteHubInput{} diff --git a/service/sagemaker/api_op_DeleteHubContent.go b/service/sagemaker/api_op_DeleteHubContent.go index 6144fdf2818..dfbd52f0d3a 100644 --- a/service/sagemaker/api_op_DeleteHubContent.go +++ b/service/sagemaker/api_op_DeleteHubContent.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete the contents of a hub. Hub APIs are only callable through SageMaker -// Studio. +// Delete the contents of a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) DeleteHubContent(ctx context.Context, params *DeleteHubContentInput, optFns ...func(*Options)) (*DeleteHubContentOutput, error) { if params == nil { params = &DeleteHubContentInput{} diff --git a/service/sagemaker/api_op_DeleteHumanTaskUi.go b/service/sagemaker/api_op_DeleteHumanTaskUi.go index bc56da7fd50..b4f00c5951e 100644 --- a/service/sagemaker/api_op_DeleteHumanTaskUi.go +++ b/service/sagemaker/api_op_DeleteHumanTaskUi.go @@ -10,11 +10,13 @@ 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 ListHumanTaskUis (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html) -// . 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 [ListHumanTaskUis]. When you delete a worker task template, it no longer appears +// when you call ListHumanTaskUis . +// +// [ListHumanTaskUis]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html 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_DeleteInferenceExperiment.go b/service/sagemaker/api_op_DeleteInferenceExperiment.go index fee0cc667ff..b2434e36b5a 100644 --- a/service/sagemaker/api_op_DeleteInferenceExperiment.go +++ b/service/sagemaker/api_op_DeleteInferenceExperiment.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an inference experiment. This operation does not delete your endpoint, -// variants, or any underlying resources. This operation only deletes the metadata -// of your experiment. +// Deletes an inference experiment. +// +// This operation does not delete your endpoint, variants, or any underlying +// resources. This operation only deletes the metadata of your experiment. func (c *Client) DeleteInferenceExperiment(ctx context.Context, params *DeleteInferenceExperimentInput, optFns ...func(*Options)) (*DeleteInferenceExperimentOutput, error) { if params == nil { params = &DeleteInferenceExperimentInput{} diff --git a/service/sagemaker/api_op_DeleteModelPackage.go b/service/sagemaker/api_op_DeleteModelPackage.go index a9d12795e23..d17f2aada33 100644 --- a/service/sagemaker/api_op_DeleteModelPackage.go +++ b/service/sagemaker/api_op_DeleteModelPackage.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a model package. A model package is used to create SageMaker models or -// list on Amazon Web Services Marketplace. Buyers can subscribe to model packages -// listed on Amazon Web Services Marketplace to create models in SageMaker. +// Deletes a model package. +// +// A model package is used to create SageMaker models or list on Amazon Web +// Services Marketplace. Buyers can subscribe to model packages listed on Amazon +// Web Services Marketplace to create models in SageMaker. func (c *Client) DeleteModelPackage(ctx context.Context, params *DeleteModelPackageInput, optFns ...func(*Options)) (*DeleteModelPackageOutput, error) { if params == nil { params = &DeleteModelPackageInput{} @@ -30,9 +32,10 @@ func (c *Client) DeleteModelPackage(ctx context.Context, params *DeleteModelPack type DeleteModelPackageInput struct { - // The name or Amazon Resource Name (ARN) of the model package to delete. When you - // specify a name, the name must have 1 to 63 characters. Valid characters are a-z, - // A-Z, 0-9, and - (hyphen). + // The name or Amazon Resource Name (ARN) of the model package to delete. + // + // When you specify a name, the name must have 1 to 63 characters. Valid + // characters are a-z, A-Z, 0-9, and - (hyphen). // // This member is required. ModelPackageName *string diff --git a/service/sagemaker/api_op_DeleteNotebookInstance.go b/service/sagemaker/api_op_DeleteNotebookInstance.go index 969193080b5..93001fce2f7 100644 --- a/service/sagemaker/api_op_DeleteNotebookInstance.go +++ b/service/sagemaker/api_op_DeleteNotebookInstance.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. 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_DeleteTags.go b/service/sagemaker/api_op_DeleteTags.go index 4c27cad437d..b1647943346 100644 --- a/service/sagemaker/api_op_DeleteTags.go +++ b/service/sagemaker/api_op_DeleteTags.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified tags from an SageMaker resource. To list a resource's -// tags, use the ListTags API. When you call this API to delete tags from a -// hyperparameter tuning job, the deleted tags are not removed from training jobs -// that the hyperparameter tuning job launched before you called this API. When you -// call this API to delete tags from a SageMaker Domain or User Profile, the -// deleted tags are not removed from Apps that the SageMaker Domain or User Profile -// launched before you called this API. +// Deletes the specified tags from an SageMaker resource. +// +// To list a resource's tags, use the ListTags API. +// +// When you call this API to delete tags from a hyperparameter tuning job, the +// deleted tags are not removed from training jobs that the hyperparameter tuning +// job launched before you called this API. +// +// When you call this API to delete tags from a SageMaker Domain or User Profile, +// the deleted tags are not removed from Apps that the SageMaker Domain or User +// Profile launched before you called this API. func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error) { if params == nil { params = &DeleteTagsInput{} diff --git a/service/sagemaker/api_op_DeleteTrial.go b/service/sagemaker/api_op_DeleteTrial.go index 9f2cc47b22f..c6ba9013818 100644 --- a/service/sagemaker/api_op_DeleteTrial.go +++ b/service/sagemaker/api_op_DeleteTrial.go @@ -11,8 +11,9 @@ import ( ) // Deletes the specified trial. All trial components that make up the trial must -// be deleted first. Use the DescribeTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html) -// API to get the list of trial components. +// be deleted first. Use the [DescribeTrialComponent]API to get the list of trial components. +// +// [DescribeTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html func (c *Client) DeleteTrial(ctx context.Context, params *DeleteTrialInput, optFns ...func(*Options)) (*DeleteTrialOutput, error) { if params == nil { params = &DeleteTrialInput{} diff --git a/service/sagemaker/api_op_DeleteTrialComponent.go b/service/sagemaker/api_op_DeleteTrialComponent.go index 69411431717..cb2b1e9e407 100644 --- a/service/sagemaker/api_op_DeleteTrialComponent.go +++ b/service/sagemaker/api_op_DeleteTrialComponent.go @@ -12,8 +12,9 @@ import ( // Deletes the specified trial component. A trial component must be disassociated // from all trials before the trial component can be deleted. To disassociate a -// trial component from a trial, call the DisassociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) -// API. +// trial component from a trial, call the [DisassociateTrialComponent]API. +// +// [DisassociateTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html func (c *Client) DeleteTrialComponent(ctx context.Context, params *DeleteTrialComponentInput, optFns ...func(*Options)) (*DeleteTrialComponentOutput, error) { if params == nil { params = &DeleteTrialComponentInput{} diff --git a/service/sagemaker/api_op_DeleteWorkforce.go b/service/sagemaker/api_op_DeleteWorkforce.go index 961b115e85a..325168c3701 100644 --- a/service/sagemaker/api_op_DeleteWorkforce.go +++ b/service/sagemaker/api_op_DeleteWorkforce.go @@ -10,14 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Use this operation to delete a workforce. If you want to create a new workforce -// in an Amazon Web Services Region where a workforce already exists, use this -// operation to delete the existing workforce and then use CreateWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html) -// to create a new workforce. If a private workforce contains one or more work -// teams, you must use the DeleteWorkteam (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) +// Use this operation to delete a workforce. +// +// If you want to create a new workforce in an Amazon Web Services Region where a +// workforce already exists, use this operation to delete the existing workforce +// and then use [CreateWorkforce]to create a new workforce. +// +// If a private workforce contains one or more work teams, you must use the [DeleteWorkteam] // operation to delete all work teams before you delete the workforce. If you try // to delete a workforce that contains one or more work teams, you will recieve a // ResourceInUse error. +// +// [CreateWorkforce]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html +// [DeleteWorkteam]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html func (c *Client) DeleteWorkforce(ctx context.Context, params *DeleteWorkforceInput, optFns ...func(*Options)) (*DeleteWorkforceOutput, error) { if params == nil { params = &DeleteWorkforceInput{} diff --git a/service/sagemaker/api_op_DescribeApp.go b/service/sagemaker/api_op_DescribeApp.go index e28d2b77b48..103135a9c00 100644 --- a/service/sagemaker/api_op_DescribeApp.go +++ b/service/sagemaker/api_op_DescribeApp.go @@ -65,12 +65,14 @@ type DescribeAppOutput struct { // The type of app. AppType types.AppType - // The creation time of the application. After an application has been shut down - // for 24 hours, SageMaker deletes all metadata for the application. To be - // considered an update and retain application metadata, applications must be - // restarted within 24 hours after the previous application has been shut down. - // After this time window, creation of an application is considered a new - // application rather than an update of the previous application. + // The creation time of the application. + // + // After an application has been shut down for 24 hours, SageMaker deletes all + // metadata for the application. To be considered an update and retain application + // metadata, applications must be restarted within 24 hours after the previous + // application has been shut down. After this time window, creation of an + // application is considered a new application rather than an update of the + // previous application. CreationTime *time.Time // The domain ID. diff --git a/service/sagemaker/api_op_DescribeAutoMLJob.go b/service/sagemaker/api_op_DescribeAutoMLJob.go index 49bc1b5ad4d..c13a9981f94 100644 --- a/service/sagemaker/api_op_DescribeAutoMLJob.go +++ b/service/sagemaker/api_op_DescribeAutoMLJob.go @@ -12,9 +12,12 @@ import ( "time" ) -// Returns information about an AutoML job created by calling CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) -// . AutoML jobs created by calling CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) -// cannot be described by DescribeAutoMLJob . +// Returns information about an AutoML job created by calling [CreateAutoMLJob]. +// +// AutoML jobs created by calling [CreateAutoMLJobV2] cannot be described by DescribeAutoMLJob . +// +// [CreateAutoMLJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html +// [CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html func (c *Client) DescribeAutoMLJob(ctx context.Context, params *DescribeAutoMLJobInput, optFns ...func(*Options)) (*DescribeAutoMLJobOutput, error) { if params == nil { params = &DescribeAutoMLJobInput{} @@ -98,8 +101,9 @@ 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) - // for an experiment. + // objective metric and lowest [InferenceLatency]for an experiment. + // + // [InferenceLatency]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html BestCandidate *types.AutoMLCandidate // Returns the end time of the AutoML job. diff --git a/service/sagemaker/api_op_DescribeAutoMLJobV2.go b/service/sagemaker/api_op_DescribeAutoMLJobV2.go index 9d4b6737a2c..d94bd907cc7 100644 --- a/service/sagemaker/api_op_DescribeAutoMLJobV2.go +++ b/service/sagemaker/api_op_DescribeAutoMLJobV2.go @@ -12,9 +12,10 @@ import ( "time" ) -// Returns information about an AutoML job created by calling CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) -// or CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) -// . +// Returns information about an AutoML job created by calling [CreateAutoMLJobV2] or [CreateAutoMLJob]. +// +// [CreateAutoMLJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html +// [CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html func (c *Client) DescribeAutoMLJobV2(ctx context.Context, params *DescribeAutoMLJobV2Input, optFns ...func(*Options)) (*DescribeAutoMLJobV2Output, error) { if params == nil { params = &DescribeAutoMLJobV2Input{} diff --git a/service/sagemaker/api_op_DescribeCluster.go b/service/sagemaker/api_op_DescribeCluster.go index 2cb046651c2..e654371e4e8 100644 --- a/service/sagemaker/api_op_DescribeCluster.go +++ b/service/sagemaker/api_op_DescribeCluster.go @@ -67,9 +67,9 @@ type DescribeClusterOutput struct { // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *types.VpcConfig // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeCompilationJob.go b/service/sagemaker/api_op_DescribeCompilationJob.go index 1c4caeb02f3..21aff643d78 100644 --- a/service/sagemaker/api_op_DescribeCompilationJob.go +++ b/service/sagemaker/api_op_DescribeCompilationJob.go @@ -12,11 +12,13 @@ import ( "time" ) -// Returns information about a model compilation job. To create a model -// compilation job, use CreateCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html) -// . To get information about multiple model compilation jobs, use -// ListCompilationJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html) -// . +// 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]. +// +// [CreateCompilationJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html +// [ListCompilationJobs]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html func (c *Client) DescribeCompilationJob(ctx context.Context, params *DescribeCompilationJobInput, optFns ...func(*Options)) (*DescribeCompilationJobOutput, error) { if params == nil { params = &DescribeCompilationJobInput{} @@ -113,6 +115,7 @@ type DescribeCompilationJobOutput struct { CompilationEndTime *time.Time // The time when the model compilation job started the CompilationJob instances. + // // You are billed for the time between this timestamp and the timestamp in the // CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be // later than this time. That's because it takes time to download the compilation @@ -134,11 +137,12 @@ type DescribeCompilationJobOutput struct { // to SageMaker Neo when you initiated a compilation job. ModelPackageVersionArn *string - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // 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) - // . + // 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]. + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Compilation Jobs by Using an Amazon Virtual Private 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 d34d5145cb9..df385d52425 100644 --- a/service/sagemaker/api_op_DescribeDomain.go +++ b/service/sagemaker/api_op_DescribeDomain.go @@ -42,8 +42,10 @@ 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 traffic is through the specified VPC and subnets AppNetworkAccessType types.AppNetworkAccessType diff --git a/service/sagemaker/api_op_DescribeEndpoint.go b/service/sagemaker/api_op_DescribeEndpoint.go index c74ed51fe84..6fc3462ec5f 100644 --- a/service/sagemaker/api_op_DescribeEndpoint.go +++ b/service/sagemaker/api_op_DescribeEndpoint.go @@ -61,36 +61,44 @@ type DescribeEndpointOutput struct { EndpointName *string // The status of the endpoint. + // // - OutOfService : Endpoint is not available to take incoming requests. - // - Creating : CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) - // is executing. - // - Updating : UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) - // or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) - // is executing. + // + // - 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) - // call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) - // operation is called explicitly. + // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) - // is executing. + // + // - Deleting : [DeleteEndpoint]is executing. + // // - Failed : Endpoint could not be created, updated, or re-scaled. Use the - // FailureReason value returned by DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) - // for information about the failure. DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) - // is the only operation that can be performed on a failed endpoint. + // FailureReason value returned by [DescribeEndpoint]for information about the failure. [DeleteEndpoint]is the + // only operation that can be performed on a failed endpoint. + // // - UpdateRollbackFailed : Both the rolling deployment and auto-rollback failed. // Your endpoint is in service with a mix of the old and new endpoint // configurations. For information about how to remedy this issue and restore the - // endpoint's status to InService , see Rolling Deployments (https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html) - // . + // endpoint's status to InService , see [Rolling Deployments]. + // + // [DescribeEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html + // [UpdateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html + // [Rolling Deployments]: https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html + // [UpdateEndpointWeightsAndCapacities]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html + // [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html + // [DeleteEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html // // This member is required. EndpointStatus types.EndpointStatus @@ -100,9 +108,10 @@ type DescribeEndpointOutput struct { // This member is required. 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) - // API. + // Returns the description of an endpoint configuration created using the [CreateEndpointConfig] + // CreateEndpointConfig API. + // + // [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html AsyncInferenceConfig *types.AsyncInferenceConfig // The currently active data capture configuration used by your Endpoint. @@ -124,14 +133,16 @@ type DescribeEndpointOutput struct { // when the endpoint is creating or updating with a new endpoint configuration. PendingDeploymentSummary *types.PendingDeploymentSummary - // An array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html) - // objects, one for each model hosted behind this endpoint. + // An array of [ProductionVariantSummary] objects, one for each model hosted behind this endpoint. + // + // [ProductionVariantSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html ProductionVariants []types.ProductionVariantSummary - // An array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html) - // 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 + // 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 . + // + // [ProductionVariantSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html ShadowProductionVariants []types.ProductionVariantSummary // Metadata pertaining to the operation's result. @@ -259,12 +270,13 @@ type EndpointDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEndpointInput, *DescribeEndpointOutput, error) (bool, error) } @@ -443,12 +455,13 @@ type EndpointInServiceWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeEndpointInput, *DescribeEndpointOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeEndpointConfig.go b/service/sagemaker/api_op_DescribeEndpointConfig.go index 37586d4a7a1..090b46ec372 100644 --- a/service/sagemaker/api_op_DescribeEndpointConfig.go +++ b/service/sagemaker/api_op_DescribeEndpointConfig.go @@ -62,9 +62,10 @@ type DescribeEndpointConfigOutput struct { // This member is required. 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) - // API. + // Returns the description of an endpoint configuration created using the [CreateEndpointConfig] + // CreateEndpointConfig API. + // + // [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html AsyncInferenceConfig *types.AsyncInferenceConfig // Configuration to control how SageMaker captures inference data. @@ -93,9 +94,9 @@ type DescribeEndpointConfigOutput struct { // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *types.VpcConfig // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeFeatureGroup.go b/service/sagemaker/api_op_DescribeFeatureGroup.go index d2edc4e7386..8af3e7cde3a 100644 --- a/service/sagemaker/api_op_DescribeFeatureGroup.go +++ b/service/sagemaker/api_op_DescribeFeatureGroup.go @@ -51,9 +51,10 @@ type DescribeFeatureGroupOutput struct { // 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 + // 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. @@ -91,7 +92,9 @@ type DescribeFeatureGroupOutput struct { // 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 . FailureReason *string @@ -106,11 +109,16 @@ 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. OfflineStoreConfig *types.OfflineStoreConfig @@ -136,9 +144,12 @@ type DescribeFeatureGroupOutput struct { // only once in a 24 hour period. With provisioned throughput mode, you specify the // read and write capacity per second that you expect your application to require, // and you are billed based on those limits. Exceeding provisioned throughput will - // result in your requests being throttled. Note: PROVISIONED throughput mode is - // supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) - // tier online store. + // result in your requests being throttled. + // + // Note: PROVISIONED throughput mode is supported only for feature groups that are + // offline-only, or use the [Standard]Standard tier online store. + // + // [Standard]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType ThroughputConfig *types.ThroughputConfigDescription // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeHub.go b/service/sagemaker/api_op_DescribeHub.go index 74b0efb98c1..c7dff34526d 100644 --- a/service/sagemaker/api_op_DescribeHub.go +++ b/service/sagemaker/api_op_DescribeHub.go @@ -12,7 +12,9 @@ import ( "time" ) -// Describe a hub. Hub APIs are only callable through SageMaker Studio. +// Describe a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) DescribeHub(ctx context.Context, params *DescribeHubInput, optFns ...func(*Options)) (*DescribeHubOutput, error) { if params == nil { params = &DescribeHubInput{} diff --git a/service/sagemaker/api_op_DescribeHubContent.go b/service/sagemaker/api_op_DescribeHubContent.go index 3552a5c81d7..5cfffa5b115 100644 --- a/service/sagemaker/api_op_DescribeHubContent.go +++ b/service/sagemaker/api_op_DescribeHubContent.go @@ -12,8 +12,9 @@ import ( "time" ) -// Describe the content of a hub. Hub APIs are only callable through SageMaker -// Studio. +// Describe the content of a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) DescribeHubContent(ctx context.Context, params *DescribeHubContentInput, optFns ...func(*Options)) (*DescribeHubContentOutput, error) { if params == nil { params = &DescribeHubContentInput{} diff --git a/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go b/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go index 2e91cadf1ea..ee61d478de7 100644 --- a/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_DescribeHyperParameterTuningJob.go @@ -52,8 +52,9 @@ type DescribeHyperParameterTuningJobOutput struct { // This member is required. HyperParameterTuningJobArn *string - // The HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) - // object that specifies the configuration of the tuning job. + // The [HyperParameterTuningJobConfig] object that specifies the configuration of the tuning job. + // + // [HyperParameterTuningJobConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html // // This member is required. HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig @@ -68,16 +69,18 @@ type DescribeHyperParameterTuningJobOutput struct { // This member is required. HyperParameterTuningJobStatus types.HyperParameterTuningJobStatus - // The ObjectiveStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html) - // object that specifies the number of training jobs, categorized by the status of - // their final objective metric, that this tuning job launched. + // The [ObjectiveStatusCounters] object that specifies the number of training jobs, categorized by the + // status of their final objective metric, that this tuning job launched. + // + // [ObjectiveStatusCounters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html // // This member is required. ObjectiveStatusCounters *types.ObjectiveStatusCounters - // The TrainingJobStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html) - // 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. + // + // [TrainingJobStatusCounters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html // // This member is required. TrainingJobStatusCounters *types.TrainingJobStatusCounters @@ -85,10 +88,10 @@ type DescribeHyperParameterTuningJobOutput struct { // A flag to indicate if autotune is enabled for the hyperparameter tuning job. Autotune *types.Autotune - // A TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) - // object that describes the training job that completed with the best current - // HyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html) - // . + // A [TrainingJobSummary] object that describes the training job that completed with the best current [HyperParameterTuningJobObjective]. + // + // [TrainingJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html + // [HyperParameterTuningJobObjective]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html BestTrainingJob *types.HyperParameterTrainingJobSummary // The total resources consumed by your hyperparameter tuning job. @@ -104,19 +107,22 @@ 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) - // 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. + // 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. + // + // [TrainingJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html OverallBestTrainingJob *types.HyperParameterTrainingJobSummary - // The HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) - // object that specifies the definition of the training jobs that this tuning job - // launches. + // The [HyperParameterTrainingJobDefinition] object that specifies the definition of the training jobs that this tuning + // job launches. + // + // [HyperParameterTrainingJobDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html TrainingJobDefinition *types.HyperParameterTrainingJobDefinition - // A list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html) - // objects launched for this tuning job. + // A list of the [HyperParameterTrainingJobDefinition] objects launched for this tuning job. + // + // [HyperParameterTrainingJobDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html TrainingJobDefinitions []types.HyperParameterTrainingJobDefinition // Tuning job completion information returned as the response from a diff --git a/service/sagemaker/api_op_DescribeImage.go b/service/sagemaker/api_op_DescribeImage.go index 7aaebb0f8c8..2afe6b115c1 100644 --- a/service/sagemaker/api_op_DescribeImage.go +++ b/service/sagemaker/api_op_DescribeImage.go @@ -197,12 +197,13 @@ type ImageCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImageInput, *DescribeImageOutput, error) (bool, error) } @@ -397,12 +398,13 @@ type ImageDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImageInput, *DescribeImageOutput, error) (bool, error) } @@ -592,12 +594,13 @@ type ImageUpdatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImageInput, *DescribeImageOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeImageVersion.go b/service/sagemaker/api_op_DescribeImageVersion.go index 32d3b350085..08488befb5e 100644 --- a/service/sagemaker/api_op_DescribeImageVersion.go +++ b/service/sagemaker/api_op_DescribeImageVersion.go @@ -76,8 +76,11 @@ 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. JobType types.JobType @@ -89,7 +92,9 @@ 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. Processor types.Processor @@ -100,12 +105,16 @@ 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. VendorGuidance types.VendorGuidance @@ -240,12 +249,13 @@ type ImageVersionCreatedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImageVersionInput, *DescribeImageVersionOutput, error) (bool, error) } @@ -443,12 +453,13 @@ type ImageVersionDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeImageVersionInput, *DescribeImageVersionOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeInferenceExperiment.go b/service/sagemaker/api_op_DescribeInferenceExperiment.go index 7aaaa989e2b..5d121f86eeb 100644 --- a/service/sagemaker/api_op_DescribeInferenceExperiment.go +++ b/service/sagemaker/api_op_DescribeInferenceExperiment.go @@ -50,8 +50,8 @@ type DescribeInferenceExperimentOutput struct { // This member is required. EndpointMetadata *types.EndpointMetadata - // An array of ModelVariantConfigSummary objects. There is one for each variant in - // the inference experiment. Each ModelVariantConfigSummary object in the array + // An array of ModelVariantConfigSummary objects. There is one for each variant + // in the inference experiment. Each ModelVariantConfigSummary object in the array // describes the infrastructure configuration for deploying the corresponding // variant. // @@ -63,20 +63,29 @@ type DescribeInferenceExperimentOutput struct { // This member is required. Name *string - // The status of the inference experiment. The following are the possible statuses - // for an inference experiment: + // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) - // API, or if any operation fails with an unexpected error, it shows as cancelled. + // + // - Cancelled - When you conclude your experiment early using the [StopInferenceExperiment]API, or if + // any operation fails with an unexpected error, it shows as cancelled. + // + // [StopInferenceExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html // // This member is required. Status types.InferenceExperimentStatus @@ -86,7 +95,7 @@ type DescribeInferenceExperimentOutput struct { // This member is required. Type types.InferenceExperimentType - // The timestamp at which the inference experiment was completed. + // The timestamp at which the inference experiment was completed. CompletionTime *time.Time // The timestamp at which you created the inference experiment. @@ -99,17 +108,17 @@ type DescribeInferenceExperimentOutput struct { // The description of the inference experiment. Description *string - // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key + // 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 - // CreateInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html) - // . + // ML compute instance that hosts the endpoint. For more information, see [CreateInferenceExperiment]. + // + // [CreateInferenceExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html KmsKey *string // The timestamp at which you last modified the inference experiment. LastModifiedTime *time.Time - // The ARN of the IAM role that Amazon SageMaker can assume to access model + // The ARN of the IAM role that Amazon SageMaker can assume to access model // artifacts and container images, and manage Amazon SageMaker Inference endpoints // for model deployment. RoleArn *string @@ -117,15 +126,17 @@ type DescribeInferenceExperimentOutput struct { // The duration for which the inference experiment ran or will run. Schedule *types.InferenceExperimentSchedule - // The configuration of ShadowMode inference experiment type, which shows the + // The configuration of ShadowMode inference experiment type, which shows the // production variant that takes all the inference requests, and the shadow variant // to which Amazon SageMaker replicates a percentage of the inference requests. For // the shadow variant it also shows the percentage of requests that Amazon // SageMaker replicates. ShadowModeConfig *types.ShadowModeConfig - // The error message or client-specified Reason from the StopInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html) - // API, that explains the status of the inference experiment. + // The error message or client-specified Reason from the [StopInferenceExperiment] API, that explains the + // status of the inference experiment. + // + // [StopInferenceExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html StatusReason *string // Metadata pertaining to the operation's result. diff --git a/service/sagemaker/api_op_DescribeLabelingJob.go b/service/sagemaker/api_op_DescribeLabelingJob.go index 65a3969d2cc..0b82d6a3aac 100644 --- a/service/sagemaker/api_op_DescribeLabelingJob.go +++ b/service/sagemaker/api_op_DescribeLabelingJob.go @@ -110,9 +110,15 @@ 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: { + // + // The file is a JSON structure in the following format: + // + // { + // // "document-version": "2018-11-28" // // "labels": [ @@ -154,8 +160,9 @@ 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]. + // + // [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 174eee4a321..2993e50fd35 100644 --- a/service/sagemaker/api_op_DescribeLineageGroup.go +++ b/service/sagemaker/api_op_DescribeLineageGroup.go @@ -13,8 +13,9 @@ 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) -// in the Amazon SageMaker Developer Guide. +// information, see [Cross-Account Lineage Tracking]in the Amazon SageMaker Developer Guide. +// +// [Cross-Account Lineage Tracking]: https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html func (c *Client) DescribeLineageGroup(ctx context.Context, params *DescribeLineageGroupInput, optFns ...func(*Options)) (*DescribeLineageGroupOutput, error) { if params == nil { params = &DescribeLineageGroupInput{} diff --git a/service/sagemaker/api_op_DescribeModel.go b/service/sagemaker/api_op_DescribeModel.go index 7ce172ede58..5cc3e9a2bed 100644 --- a/service/sagemaker/api_op_DescribeModel.go +++ b/service/sagemaker/api_op_DescribeModel.go @@ -75,9 +75,11 @@ type DescribeModelOutput struct { // environment map that the inference code uses when it is deployed in production. PrimaryContainer *types.ContainerDefinition - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // 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) + // 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] + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [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 aa2101e1202..a5fb9c3a7e7 100644 --- a/service/sagemaker/api_op_DescribeModelCard.go +++ b/service/sagemaker/api_op_DescribeModelCard.go @@ -73,9 +73,13 @@ type DescribeModelCardOutput struct { // 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. // @@ -96,11 +100,17 @@ 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. ModelCardProcessingStatus types.ModelCardProcessingStatus diff --git a/service/sagemaker/api_op_DescribeModelCardExportJob.go b/service/sagemaker/api_op_DescribeModelCardExportJob.go index 35ba2d587b6..0b2c3225140 100644 --- a/service/sagemaker/api_op_DescribeModelCardExportJob.go +++ b/service/sagemaker/api_op_DescribeModelCardExportJob.go @@ -77,8 +77,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. diff --git a/service/sagemaker/api_op_DescribeModelPackage.go b/service/sagemaker/api_op_DescribeModelPackage.go index 5168dc9efb8..bfd93ddeb06 100644 --- a/service/sagemaker/api_op_DescribeModelPackage.go +++ b/service/sagemaker/api_op_DescribeModelPackage.go @@ -13,9 +13,10 @@ import ( ) // Returns a description of the specified model package, which is used to create -// SageMaker models or list them on Amazon Web Services Marketplace. To create -// models in SageMaker, buyers can subscribe to model packages listed on Amazon Web -// Services Marketplace. +// SageMaker models or list them on Amazon Web Services Marketplace. +// +// To create models in SageMaker, buyers can subscribe to model packages listed on +// Amazon Web Services Marketplace. func (c *Client) DescribeModelPackage(ctx context.Context, params *DescribeModelPackageInput, optFns ...func(*Options)) (*DescribeModelPackageOutput, error) { if params == nil { params = &DescribeModelPackageInput{} @@ -33,9 +34,10 @@ func (c *Client) DescribeModelPackage(ctx context.Context, params *DescribeModel type DescribeModelPackageInput struct { - // The name or Amazon Resource Name (ARN) of the model package to describe. When - // you specify a name, the name must have 1 to 63 characters. Valid characters are - // a-z, A-Z, 0-9, and - (hyphen). + // The name or Amazon Resource Name (ARN) of the model package to describe. + // + // When you specify a name, the name must have 1 to 63 characters. Valid + // characters are a-z, A-Z, 0-9, and - (hyphen). // // This member is required. ModelPackageName *string @@ -95,9 +97,10 @@ type DescribeModelPackageOutput struct { Domain *string // 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) - // in the Amazon SageMaker Developer Guide. + // set using the model package. For more information, see the topic on [Drift Detection against Previous Baselines in SageMaker Pipelines]in the + // Amazon SageMaker Developer Guide. + // + // [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 DriftCheckBaselines *types.DriftCheckBaselines // Details about inference jobs that you can run with models based on this model diff --git a/service/sagemaker/api_op_DescribeMonitoringSchedule.go b/service/sagemaker/api_op_DescribeMonitoringSchedule.go index 66ae886ffee..b26944cca9b 100644 --- a/service/sagemaker/api_op_DescribeMonitoringSchedule.go +++ b/service/sagemaker/api_op_DescribeMonitoringSchedule.go @@ -71,7 +71,7 @@ type DescribeMonitoringScheduleOutput struct { // This member is required. MonitoringScheduleStatus types.ScheduleStatus - // The name of the endpoint for the monitoring job. + // The name of the endpoint for the monitoring job. EndpointName *string // A string, up to one KB in size, that contains the reason a monitoring job @@ -83,9 +83,13 @@ 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. MonitoringType types.MonitoringType diff --git a/service/sagemaker/api_op_DescribeNotebookInstance.go b/service/sagemaker/api_op_DescribeNotebookInstance.go index b4acf1e8d8b..fb187e697ab 100644 --- a/service/sagemaker/api_op_DescribeNotebookInstance.go +++ b/service/sagemaker/api_op_DescribeNotebookInstance.go @@ -47,17 +47,19 @@ 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) . + // notebook instance. For more information, see [Using Elastic Inference in Amazon SageMaker]. + // + // [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 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]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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 @@ -66,19 +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) - // . + // in your account, or the URL of a Git repository in [Amazon Web Services CodeCommit]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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) - // . + // access, and cannot connect to SageMaker training and endpoint services. + // + // For more information, see [Notebook Instances Are Internet-Enabled by Default]. + // + // [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. @@ -105,9 +109,11 @@ 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] + // + // [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. @@ -123,6 +129,7 @@ type DescribeNotebookInstanceOutput struct { RoleArn *string // Whether root access is enabled or disabled for users of the notebook instance. + // // 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. @@ -268,12 +275,13 @@ type NotebookInstanceDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNotebookInstanceInput, *DescribeNotebookInstanceOutput, error) (bool, error) } @@ -454,12 +462,13 @@ type NotebookInstanceInServiceWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNotebookInstanceInput, *DescribeNotebookInstanceOutput, error) (bool, error) } @@ -646,12 +655,13 @@ type NotebookInstanceStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeNotebookInstanceInput, *DescribeNotebookInstanceOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go index 546cbf9bc8a..e1a431689bc 100644 --- a/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_DescribeNotebookInstanceLifecycleConfig.go @@ -12,10 +12,11 @@ import ( "time" ) -// 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) -// . +// 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]. +// +// [Step 2.1: (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 800b8fa2b5c..89d1e463db7 100644 --- a/service/sagemaker/api_op_DescribeProcessingJob.go +++ b/service/sagemaker/api_op_DescribeProcessingJob.go @@ -256,12 +256,13 @@ type ProcessingJobCompletedOrStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeProcessingJobInput, *DescribeProcessingJobOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeProject.go b/service/sagemaker/api_op_DescribeProject.go index 43de84ae40a..7bb97ccb8c7 100644 --- a/service/sagemaker/api_op_DescribeProject.go +++ b/service/sagemaker/api_op_DescribeProject.go @@ -65,9 +65,9 @@ type DescribeProjectOutput struct { // This member is required. 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) - // . + // Information used to provision a service catalog product. For information, see [What is Amazon Web Services Service Catalog]. + // + // [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_DescribeSpace.go b/service/sagemaker/api_op_DescribeSpace.go index 5cb518bebba..896f9db7889 100644 --- a/service/sagemaker/api_op_DescribeSpace.go +++ b/service/sagemaker/api_op_DescribeSpace.go @@ -85,9 +85,14 @@ type DescribeSpaceOutput struct { // IAM Identity Center (Successor to Amazon Web Services Single Sign-On) // authentication, users can navigate to the URL after appending the respective // redirect parameter for the application type to be federated through Amazon Web - // Services IAM Identity Center. The following application types are supported: + // Services IAM Identity Center. + // + // The following application types are supported: + // // - Studio Classic: &redirect=JupyterServer + // // - JupyterLab: &redirect=JupyterLab + // // - Code Editor, based on Code-OSS, Visual Studio Code - Open Source: // &redirect=CodeEditor Url *string diff --git a/service/sagemaker/api_op_DescribeTrainingJob.go b/service/sagemaker/api_op_DescribeTrainingJob.go index d439c5ce895..a41fcd344d2 100644 --- a/service/sagemaker/api_op_DescribeTrainingJob.go +++ b/service/sagemaker/api_op_DescribeTrainingJob.go @@ -17,11 +17,13 @@ import ( "time" ) -// 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 -// BillableTimeInSeconds may not be present in the response. +// 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 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 { params = &DescribeTrainingJobInput{} @@ -71,48 +73,70 @@ type DescribeTrainingJobOutput struct { // This member is required. 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html) - // . SageMaker provides primary statuses and secondary statuses that apply to each - // of them: InProgress + // 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. + // // 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 . + // // 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: + // + // Valid values for SecondaryStatus are subject to change. + // + // We no longer support the following secondary statuses: + // // - LaunchingMLInstances + // // - PreparingTraining + // // - DownloadingTrainingImage // + // [SecondaryStatusTransition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html + // // This member is required. SecondaryStatus types.SecondaryStatus // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches the // time limit, SageMaker ends the training job. Use this API to cap model training - // costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts, so the results of training are not lost. + // costs. + // + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window to + // save the model artifacts, so the results of training are not lost. // // This member is required. StoppingCondition *types.StoppingCondition @@ -122,19 +146,26 @@ type DescribeTrainingJobOutput struct { // This member is required. TrainingJobArn *string - // Name of the model training job. + // Name of the model training job. // // This member is required. TrainingJobName *string - // The status of the training job. SageMaker provides the following training job - // statuses: + // 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 . // // This member is required. @@ -144,13 +175,17 @@ 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 @@ -159,9 +194,9 @@ 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) - // . + // configure the DebugHookConfig parameter, see [Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job]. + // + // [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 DebugHookConfig *types.DebugHookConfig // Configuration information for Amazon SageMaker Debugger rules for debugging @@ -195,9 +230,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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html ExperimentConfig *types.ExperimentConfig // If the training job failed, the reason it failed. @@ -245,9 +287,9 @@ type DescribeTrainingJobOutput struct { ProfilingStatus types.ProfilingStatus // Configuration for remote debugging. To learn more about the remote debugging - // functionality of SageMaker, see Access a training container through Amazon Web - // Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html) - // . + // functionality of SageMaker, see [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]. + // + // [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html RemoteDebugConfig *types.RemoteDebugConfig // The number of times to retry the job when the job fails due to an @@ -287,10 +329,11 @@ type DescribeTrainingJobOutput struct { // the training job was launched by a hyperparameter tuning job. TuningJobArn *string - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // 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) - // . + // 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]. + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Training Jobs by Using an Amazon Virtual 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. @@ -424,12 +467,13 @@ type TrainingJobCompletedOrStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTrainingJobInput, *DescribeTrainingJobOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeTransformJob.go b/service/sagemaker/api_op_DescribeTransformJob.go index 929337aeb7c..98260c42798 100644 --- a/service/sagemaker/api_op_DescribeTransformJob.go +++ b/service/sagemaker/api_op_DescribeTransformJob.go @@ -88,8 +88,10 @@ type DescribeTransformJobOutput struct { // 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 . + // 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. @@ -100,9 +102,9 @@ type DescribeTransformJobOutput struct { // results in the output. The input filter provided allows you to exclude input // 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) - // . + // predictions in the output from the job. For more information, see [Associate Prediction Results with their Corresponding Input Records]. + // + // [Associate 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 @@ -111,16 +113,23 @@ type DescribeTransformJobOutput struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html 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 S3 object. For more information, see [Log Amazon SageMaker Events with Amazon CloudWatch]. + // + // [Log Amazon SageMaker Events with 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 @@ -138,9 +147,10 @@ type DescribeTransformJobOutput struct { // invocation. ModelClientConfig *types.ModelClientConfig - // 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 . + // 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 . TransformEndTime *time.Time // Identifies the Amazon S3 location where you want Amazon SageMaker to save the @@ -279,12 +289,13 @@ type TransformJobCompletedOrStoppedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTransformJobInput, *DescribeTransformJobOutput, error) (bool, error) } diff --git a/service/sagemaker/api_op_DescribeTrialComponent.go b/service/sagemaker/api_op_DescribeTrialComponent.go index b451c0b3911..66dc4a715a8 100644 --- a/service/sagemaker/api_op_DescribeTrialComponent.go +++ b/service/sagemaker/api_op_DescribeTrialComponent.go @@ -88,8 +88,11 @@ type DescribeTrialComponentOutput struct { StartTime *time.Time // The status of the component. States include: + // // - InProgress + // // - Completed + // // - Failed Status *types.TrialComponentStatus diff --git a/service/sagemaker/api_op_DescribeWorkforce.go b/service/sagemaker/api_op_DescribeWorkforce.go index 2903be218ce..9f29992dd7b 100644 --- a/service/sagemaker/api_op_DescribeWorkforce.go +++ b/service/sagemaker/api_op_DescribeWorkforce.go @@ -12,9 +12,12 @@ 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] ). Allowable IP +// address ranges are the IP addresses that workers can use to access tasks. +// +// This operation applies only to private workforces. +// +// [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html func (c *Client) DescribeWorkforce(ctx context.Context, params *DescribeWorkforceInput, optFns ...func(*Options)) (*DescribeWorkforceOutput, error) { if params == nil { params = &DescribeWorkforceInput{} @@ -48,8 +51,9 @@ 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]. + // + // [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_DisassociateTrialComponent.go b/service/sagemaker/api_op_DisassociateTrialComponent.go index 92be5a3d8f4..552dc6175c2 100644 --- a/service/sagemaker/api_op_DisassociateTrialComponent.go +++ b/service/sagemaker/api_op_DisassociateTrialComponent.go @@ -13,10 +13,14 @@ import ( // Disassociates a trial component from a trial. This doesn't effect other trials // the component is associated with. Before you can delete a component, you must // disassociate the component from all trials it is associated with. To associate a -// trial component with a trial, call the AssociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html) -// API. To get a list of the trials a component is associated with, use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API. Specify ExperimentTrialComponent for the Resource parameter. The list -// appears in the response under Results.TrialComponent.Parents . +// 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 . +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html +// [AssociateTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html 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 9ec9a6a626e..6af650a1df3 100644 --- a/service/sagemaker/api_op_GetModelPackageGroupPolicy.go +++ b/service/sagemaker/api_op_GetModelPackageGroupPolicy.go @@ -11,8 +11,10 @@ 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) -// in the Amazon Web Services Identity and Access Management User Guide.. +// about resource policies, see [Identity-based policies and resource-based policies]in the Amazon Web Services Identity and Access +// Management User Guide.. +// +// [Identity-based policies and resource-based policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html func (c *Client) GetModelPackageGroupPolicy(ctx context.Context, params *GetModelPackageGroupPolicyInput, optFns ...func(*Options)) (*GetModelPackageGroupPolicyOutput, error) { if params == nil { params = &GetModelPackageGroupPolicyInput{} diff --git a/service/sagemaker/api_op_GetScalingConfigurationRecommendation.go b/service/sagemaker/api_op_GetScalingConfigurationRecommendation.go index e58948e64ec..3c41e40d4dc 100644 --- a/service/sagemaker/api_op_GetScalingConfigurationRecommendation.go +++ b/service/sagemaker/api_op_GetScalingConfigurationRecommendation.go @@ -39,13 +39,15 @@ type GetScalingConfigurationRecommendationInput struct { // The name of an endpoint benchmarked during a previously completed inference // recommendation job. This name should come from one of the recommendations // returned by the job specified in the InferenceRecommendationsJobName field. + // // Specify either this field or the RecommendationId field. EndpointName *string // The recommendation ID of a previously completed inference recommendation. This // ID should come from one of the recommendations returned by the job specified in - // the InferenceRecommendationsJobName field. Specify either this field or the - // EndpointName field. + // the InferenceRecommendationsJobName field. + // + // Specify either this field or the EndpointName field. RecommendationId *string // An object where you specify the anticipated traffic pattern for an endpoint. diff --git a/service/sagemaker/api_op_ImportHubContent.go b/service/sagemaker/api_op_ImportHubContent.go index dff2a9ba2fd..6ba47d1f1b6 100644 --- a/service/sagemaker/api_op_ImportHubContent.go +++ b/service/sagemaker/api_op_ImportHubContent.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Import hub content. Hub APIs are only callable through SageMaker Studio. +// Import hub content. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) ImportHubContent(ctx context.Context, params *ImportHubContentInput, optFns ...func(*Options)) (*ImportHubContentOutput, error) { if params == nil { params = &ImportHubContentInput{} diff --git a/service/sagemaker/api_op_ListClusterNodes.go b/service/sagemaker/api_op_ListClusterNodes.go index 6e3ccb04f39..5c0d8021587 100644 --- a/service/sagemaker/api_op_ListClusterNodes.go +++ b/service/sagemaker/api_op_ListClusterNodes.go @@ -39,23 +39,32 @@ type ListClusterNodesInput struct { // A filter that returns nodes in a SageMaker HyperPod cluster created after the // specified time. Timestamps are formatted according to the ISO 8601 standard. + // // Acceptable formats include: + // // - YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z + // // - YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, // 2014-10-01T12:30:00.000-08:00 + // // - YYYY-MM-DD , for example, 2014-10-01 + // // - Unix time in seconds, for example, 1412195400 . This is also referred to as // Unix Epoch time and represents the number of seconds since midnight, January 1, // 1970 UTC. - // For more information about the timestamp format, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // in the Amazon Web Services Command Line Interface User Guide. + // + // For more information about the timestamp format, see [Timestamp] in the Amazon Web + // Services Command Line Interface User Guide. + // + // [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp CreationTimeAfter *time.Time // A filter that returns nodes in a SageMaker HyperPod cluster created before the // specified time. The acceptable formats are the same as the timestamp formats for - // CreationTimeAfter . For more information about the timestamp format, see - // Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // in the Amazon Web Services Command Line Interface User Guide. + // CreationTimeAfter . For more information about the timestamp format, see [Timestamp] in + // the Amazon Web Services Command Line Interface User Guide. + // + // [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp CreationTimeBefore *time.Time // A filter that returns the instance groups whose name contain a specified string. diff --git a/service/sagemaker/api_op_ListClusters.go b/service/sagemaker/api_op_ListClusters.go index 6e3a58af7f7..134719a840d 100644 --- a/service/sagemaker/api_op_ListClusters.go +++ b/service/sagemaker/api_op_ListClusters.go @@ -32,24 +32,34 @@ type ListClustersInput struct { // Set a start time for the time range during which you want to list SageMaker // HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard. + // // Acceptable formats include: + // // - YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z + // // - YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, // 2014-10-01T12:30:00.000-08:00 + // // - YYYY-MM-DD , for example, 2014-10-01 + // // - Unix time in seconds, for example, 1412195400 . This is also referred to as // Unix Epoch time and represents the number of seconds since midnight, January 1, // 1970 UTC. - // For more information about the timestamp format, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // in the Amazon Web Services Command Line Interface User Guide. + // + // For more information about the timestamp format, see [Timestamp] in the Amazon Web + // Services Command Line Interface User Guide. + // + // [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp CreationTimeAfter *time.Time // Set an end time for the time range during which you want to list SageMaker // HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster // created before the specified time. The acceptable formats are the same as the // timestamp formats for CreationTimeAfter . For more information about the - // timestamp format, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp) - // in the Amazon Web Services Command Line Interface User Guide. + // timestamp format, see [Timestamp]in the Amazon Web Services Command Line Interface User + // Guide. + // + // [Timestamp]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp CreationTimeBefore *time.Time // Set the maximum number of SageMaker HyperPod clusters to list. diff --git a/service/sagemaker/api_op_ListCodeRepositories.go b/service/sagemaker/api_op_ListCodeRepositories.go index fc3fb2a3b3d..6166aba52fc 100644 --- a/service/sagemaker/api_op_ListCodeRepositories.go +++ b/service/sagemaker/api_op_ListCodeRepositories.go @@ -71,10 +71,15 @@ 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. diff --git a/service/sagemaker/api_op_ListCompilationJobs.go b/service/sagemaker/api_op_ListCompilationJobs.go index a81387184ca..380c17c939c 100644 --- a/service/sagemaker/api_op_ListCompilationJobs.go +++ b/service/sagemaker/api_op_ListCompilationJobs.go @@ -12,11 +12,13 @@ import ( "time" ) -// Lists model compilation jobs that satisfy various filters. To create a model -// compilation job, use CreateCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html) -// . To get information about a particular model compilation job you have created, -// use DescribeCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html) -// . +// 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]. +// +// [DescribeCompilationJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html +// [CreateCompilationJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html func (c *Client) ListCompilationJobs(ctx context.Context, params *ListCompilationJobsInput, optFns ...func(*Options)) (*ListCompilationJobsOutput, error) { if params == nil { params = &ListCompilationJobsInput{} @@ -77,8 +79,9 @@ type ListCompilationJobsInput struct { type ListCompilationJobsOutput struct { - // An array of CompilationJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html) - // objects, each describing a model compilation job. + // An array of [CompilationJobSummary] objects, each describing a model compilation job. + // + // [CompilationJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html // // This member is required. CompilationJobSummaries []types.CompilationJobSummary diff --git a/service/sagemaker/api_op_ListEndpointConfigs.go b/service/sagemaker/api_op_ListEndpointConfigs.go index 2f778ee6139..e7f46a54455 100644 --- a/service/sagemaker/api_op_ListEndpointConfigs.go +++ b/service/sagemaker/api_op_ListEndpointConfigs.go @@ -66,7 +66,7 @@ type ListEndpointConfigsOutput struct { // This member is required. EndpointConfigs []types.EndpointConfigSummary - // If the response is truncated, SageMaker returns this token. To retrieve the + // 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 diff --git a/service/sagemaker/api_op_ListEndpoints.go b/service/sagemaker/api_op_ListEndpoints.go index eb8175d7512..4be00b35de2 100644 --- a/service/sagemaker/api_op_ListEndpoints.go +++ b/service/sagemaker/api_op_ListEndpoints.go @@ -38,11 +38,11 @@ type ListEndpointsInput struct { // time (timestamp). CreationTimeBefore *time.Time - // A filter that returns only endpoints that were modified after the specified + // A filter that returns only endpoints that were modified after the specified // timestamp. LastModifiedTimeAfter *time.Time - // A filter that returns only endpoints that were modified before the specified + // A filter that returns only endpoints that were modified before the specified // timestamp. LastModifiedTimeBefore *time.Time @@ -65,7 +65,7 @@ type ListEndpointsInput struct { // The sort order for results. The default is Descending . SortOrder types.OrderKey - // A filter that returns only endpoints with the specified status. + // A filter that returns only endpoints with the specified status. StatusEquals types.EndpointStatus noSmithyDocumentSerde @@ -73,12 +73,12 @@ type ListEndpointsInput struct { type ListEndpointsOutput struct { - // An array or endpoint objects. + // An array or endpoint objects. // // This member is required. Endpoints []types.EndpointSummary - // If the response is truncated, SageMaker returns this token. To retrieve the + // 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 diff --git a/service/sagemaker/api_op_ListHubContentVersions.go b/service/sagemaker/api_op_ListHubContentVersions.go index d5aa9961e6d..0313c19bc83 100644 --- a/service/sagemaker/api_op_ListHubContentVersions.go +++ b/service/sagemaker/api_op_ListHubContentVersions.go @@ -12,7 +12,9 @@ import ( "time" ) -// List hub content versions. Hub APIs are only callable through SageMaker Studio. +// List hub content versions. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) ListHubContentVersions(ctx context.Context, params *ListHubContentVersionsInput, optFns ...func(*Options)) (*ListHubContentVersionsOutput, error) { if params == nil { params = &ListHubContentVersionsInput{} diff --git a/service/sagemaker/api_op_ListHubContents.go b/service/sagemaker/api_op_ListHubContents.go index 2f32807f1db..6f500cc82cf 100644 --- a/service/sagemaker/api_op_ListHubContents.go +++ b/service/sagemaker/api_op_ListHubContents.go @@ -12,7 +12,9 @@ import ( "time" ) -// List the contents of a hub. Hub APIs are only callable through SageMaker Studio. +// List the contents of a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) ListHubContents(ctx context.Context, params *ListHubContentsInput, optFns ...func(*Options)) (*ListHubContentsOutput, error) { if params == nil { params = &ListHubContentsInput{} diff --git a/service/sagemaker/api_op_ListHubs.go b/service/sagemaker/api_op_ListHubs.go index 6bc69f9b994..dddc0092f7c 100644 --- a/service/sagemaker/api_op_ListHubs.go +++ b/service/sagemaker/api_op_ListHubs.go @@ -12,7 +12,9 @@ import ( "time" ) -// List all existing hubs. Hub APIs are only callable through SageMaker Studio. +// List all existing hubs. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) ListHubs(ctx context.Context, params *ListHubsInput, optFns ...func(*Options)) (*ListHubsOutput, error) { if params == nil { params = &ListHubsInput{} diff --git a/service/sagemaker/api_op_ListHyperParameterTuningJobs.go b/service/sagemaker/api_op_ListHyperParameterTuningJobs.go index 1c4e7e11930..327192a42c8 100644 --- a/service/sagemaker/api_op_ListHyperParameterTuningJobs.go +++ b/service/sagemaker/api_op_ListHyperParameterTuningJobs.go @@ -12,8 +12,10 @@ import ( "time" ) -// Gets a list of HyperParameterTuningJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) -// objects that describe the hyperparameter tuning jobs launched in your account. +// Gets a list of [HyperParameterTuningJobSummary] objects that describe the hyperparameter tuning jobs launched +// in your account. +// +// [HyperParameterTuningJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html func (c *Client) ListHyperParameterTuningJobs(ctx context.Context, params *ListHyperParameterTuningJobsInput, optFns ...func(*Options)) (*ListHyperParameterTuningJobsOutput, error) { if params == nil { params = &ListHyperParameterTuningJobsInput{} @@ -73,9 +75,10 @@ type ListHyperParameterTuningJobsInput struct { type ListHyperParameterTuningJobsOutput struct { - // A list of HyperParameterTuningJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) - // objects that describe the tuning jobs that the ListHyperParameterTuningJobs - // request returned. + // A list of [HyperParameterTuningJobSummary] objects that describe the tuning jobs that the + // ListHyperParameterTuningJobs request returned. + // + // [HyperParameterTuningJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html // // This member is required. HyperParameterTuningJobSummaries []types.HyperParameterTuningJobSummary diff --git a/service/sagemaker/api_op_ListImages.go b/service/sagemaker/api_op_ListImages.go index 2bfc0233e47..607fc5ef269 100644 --- a/service/sagemaker/api_op_ListImages.go +++ b/service/sagemaker/api_op_ListImages.go @@ -44,7 +44,8 @@ type ListImagesInput struct { // A filter that returns only images modified on or before the specified time. LastModifiedTimeBefore *time.Time - // The maximum number of images to return in the response. The default value is 10. + // The maximum number of images to return in the response. The default value is + // 10. MaxResults *int32 // A filter that returns only images whose name contains the specified string. @@ -162,7 +163,8 @@ var _ ListImagesAPIClient = (*Client)(nil) // ListImagesPaginatorOptions is the paginator options for ListImages type ListImagesPaginatorOptions struct { - // The maximum number of images to return in the response. The default value is 10. + // The maximum number of images 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_ListInferenceExperiments.go b/service/sagemaker/api_op_ListInferenceExperiments.go index 2014f1c0fb3..d6098f8ed17 100644 --- a/service/sagemaker/api_op_ListInferenceExperiments.go +++ b/service/sagemaker/api_op_ListInferenceExperiments.go @@ -48,7 +48,7 @@ type ListInferenceExperimentsInput struct { // Selects inference experiments whose names contain this name. NameContains *string - // The response from the last list when returning a list large enough to need + // The response from the last list when returning a list large enough to need // tokening. NextToken *string @@ -58,14 +58,16 @@ type ListInferenceExperimentsInput struct { // The direction of sorting (ascending or descending). SortOrder types.SortOrder - // Selects inference experiments which are in this status. For the possible - // statuses, see DescribeInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html) - // . + // Selects inference experiments which are in this status. For the possible + // statuses, see [DescribeInferenceExperiment]. + // + // [DescribeInferenceExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html StatusEquals types.InferenceExperimentStatus - // Selects inference experiments of this type. For the possible types of inference - // experiments, see CreateInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html) - // . + // Selects inference experiments of this type. For the possible types of + // inference experiments, see [CreateInferenceExperiment]. + // + // [CreateInferenceExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html Type types.InferenceExperimentType noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go b/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go index e8e3c6500e1..27398608a29 100644 --- a/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go +++ b/service/sagemaker/api_op_ListInferenceRecommendationsJobSteps.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the subtasks for an Inference Recommender job. The supported -// subtasks are benchmarks, which evaluate the performance of your model on -// different instance types. +// Returns a list of the subtasks for an Inference Recommender job. +// +// The supported subtasks are benchmarks, which evaluate the performance of your +// model on different instance types. func (c *Client) ListInferenceRecommendationsJobSteps(ctx context.Context, params *ListInferenceRecommendationsJobStepsInput, optFns ...func(*Options)) (*ListInferenceRecommendationsJobStepsOutput, error) { if params == nil { params = &ListInferenceRecommendationsJobStepsInput{} @@ -47,8 +48,9 @@ type ListInferenceRecommendationsJobStepsInput struct { // empty, then all benchmarks are returned. Status types.RecommendationJobStatus - // A filter to return details about the specified type of subtask. BENCHMARK : - // Evaluate the performance of your model on different instance types. + // 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 noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_ListLineageGroups.go b/service/sagemaker/api_op_ListLineageGroups.go index 45d81210875..f742c3771ef 100644 --- a/service/sagemaker/api_op_ListLineageGroups.go +++ b/service/sagemaker/api_op_ListLineageGroups.go @@ -13,8 +13,9 @@ 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) -// in the Amazon SageMaker Developer Guide. +// information, see [Cross-Account Lineage Tracking]in the Amazon SageMaker Developer Guide. +// +// [Cross-Account Lineage Tracking]: https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html func (c *Client) ListLineageGroups(ctx context.Context, params *ListLineageGroupsInput, optFns ...func(*Options)) (*ListLineageGroupsOutput, error) { if params == nil { params = &ListLineageGroupsInput{} diff --git a/service/sagemaker/api_op_ListModelPackages.go b/service/sagemaker/api_op_ListModelPackages.go index bc69a7cf06c..1f5154c2536 100644 --- a/service/sagemaker/api_op_ListModelPackages.go +++ b/service/sagemaker/api_op_ListModelPackages.go @@ -51,9 +51,12 @@ type ListModelPackagesInput struct { // 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 diff --git a/service/sagemaker/api_op_ListModels.go b/service/sagemaker/api_op_ListModels.go index dbdf97d2417..7553f3a2e6d 100644 --- a/service/sagemaker/api_op_ListModels.go +++ b/service/sagemaker/api_op_ListModels.go @@ -65,7 +65,7 @@ type ListModelsOutput struct { // This member is required. Models []types.ModelSummary - // If the response is truncated, SageMaker returns this token. To retrieve the + // If the response is truncated, SageMaker returns this token. To retrieve the // next set of models, use it in the subsequent request. NextToken *string diff --git a/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go b/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go index a51d1711dd9..ceb556a06af 100644 --- a/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go +++ b/service/sagemaker/api_op_ListNotebookInstanceLifecycleConfigs.go @@ -12,9 +12,9 @@ import ( "time" ) -// Lists notebook instance lifestyle configurations created with the -// CreateNotebookInstanceLifecycleConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) -// API. +// Lists notebook instance lifestyle configurations created with the [CreateNotebookInstanceLifecycleConfig] API. +// +// [CreateNotebookInstanceLifecycleConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html func (c *Client) ListNotebookInstanceLifecycleConfigs(ctx context.Context, params *ListNotebookInstanceLifecycleConfigsInput, optFns ...func(*Options)) (*ListNotebookInstanceLifecycleConfigsOutput, error) { if params == nil { params = &ListNotebookInstanceLifecycleConfigsInput{} diff --git a/service/sagemaker/api_op_ListNotebookInstances.go b/service/sagemaker/api_op_ListNotebookInstances.go index 24692f13937..9c1874379ae 100644 --- a/service/sagemaker/api_op_ListNotebookInstances.go +++ b/service/sagemaker/api_op_ListNotebookInstances.go @@ -63,10 +63,11 @@ type ListNotebookInstancesInput struct { // instances whose name contains the specified string. NameContains *string - // If the previous call to the ListNotebookInstances is truncated, the response + // If the previous call to the ListNotebookInstances is truncated, the response // 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 + // 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 // request. NextToken *string diff --git a/service/sagemaker/api_op_ListResourceCatalogs.go b/service/sagemaker/api_op_ListResourceCatalogs.go index 87f7c5bb47b..d73ad9ff35f 100644 --- a/service/sagemaker/api_op_ListResourceCatalogs.go +++ b/service/sagemaker/api_op_ListResourceCatalogs.go @@ -12,7 +12,8 @@ import ( "time" ) -// Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum +// Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum +// // number of ResourceCatalog s viewable is 1000. func (c *Client) ListResourceCatalogs(ctx context.Context, params *ListResourceCatalogsInput, optFns ...func(*Options)) (*ListResourceCatalogsOutput, error) { if params == nil { @@ -31,28 +32,28 @@ func (c *Client) ListResourceCatalogs(ctx context.Context, params *ListResourceC type ListResourceCatalogsInput struct { - // Use this parameter to search for ResourceCatalog s created after a specific date - // and time. + // Use this parameter to search for ResourceCatalog s created after a specific + // date and time. CreationTimeAfter *time.Time - // Use this parameter to search for ResourceCatalog s created before a specific + // Use this parameter to search for ResourceCatalog s created before a specific // date and time. CreationTimeBefore *time.Time - // The maximum number of results returned by ListResourceCatalogs . + // The maximum number of results returned by ListResourceCatalogs . MaxResults *int32 - // A string that partially matches one or more ResourceCatalog s names. Filters + // A string that partially matches one or more ResourceCatalog s names. Filters // ResourceCatalog by name. NameContains *string - // A token to resume pagination of ListResourceCatalogs results. + // A token to resume pagination of ListResourceCatalogs results. NextToken *string - // The value on which the resource catalog list is sorted. + // The value on which the resource catalog list is sorted. SortBy types.ResourceCatalogSortBy - // The order in which the resource catalogs are listed. + // The order in which the resource catalogs are listed. SortOrder types.ResourceCatalogSortOrder noSmithyDocumentSerde @@ -60,10 +61,10 @@ type ListResourceCatalogsInput struct { type ListResourceCatalogsOutput struct { - // A token to resume pagination of ListResourceCatalogs results. + // A token to resume pagination of ListResourceCatalogs results. NextToken *string - // A list of the requested ResourceCatalog s. + // A list of the requested ResourceCatalog s. ResourceCatalogs []types.ResourceCatalog // Metadata pertaining to the operation's result. @@ -159,7 +160,7 @@ var _ ListResourceCatalogsAPIClient = (*Client)(nil) // ListResourceCatalogsPaginatorOptions is the paginator options for // ListResourceCatalogs type ListResourceCatalogsPaginatorOptions struct { - // The maximum number of results returned by ListResourceCatalogs . + // The maximum number of results returned by ListResourceCatalogs . Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sagemaker/api_op_ListTags.go b/service/sagemaker/api_op_ListTags.go index 5a69a8bfac9..9ffcae39e3f 100644 --- a/service/sagemaker/api_op_ListTags.go +++ b/service/sagemaker/api_op_ListTags.go @@ -37,7 +37,7 @@ type ListTagsInput struct { // Maximum number of tags to return. MaxResults *int32 - // If the response to the previous ListTags request is truncated, SageMaker + // 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 @@ -47,7 +47,7 @@ type ListTagsInput struct { type ListTagsOutput struct { - // If response is truncated, SageMaker includes a token in the response. You can + // If response is truncated, SageMaker includes a token in the response. You can // use this token in your subsequent request to fetch next set of tokens. NextToken *string diff --git a/service/sagemaker/api_op_ListTrainingJobs.go b/service/sagemaker/api_op_ListTrainingJobs.go index a0ec09b1879..520f17ac571 100644 --- a/service/sagemaker/api_op_ListTrainingJobs.go +++ b/service/sagemaker/api_op_ListTrainingJobs.go @@ -12,17 +12,24 @@ import ( "time" ) -// 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 +// 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 func (c *Client) ListTrainingJobs(ctx context.Context, params *ListTrainingJobsInput, optFns ...func(*Options)) (*ListTrainingJobsOutput, error) { if params == nil { params = &ListTrainingJobsInput{} diff --git a/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go b/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go index ca7e497f78d..2e9f8da075e 100644 --- a/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_ListTrainingJobsForHyperParameterTuningJob.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a list of TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) -// 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. +// +// [TrainingJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html func (c *Client) ListTrainingJobsForHyperParameterTuningJob(ctx context.Context, params *ListTrainingJobsForHyperParameterTuningJobInput, optFns ...func(*Options)) (*ListTrainingJobsForHyperParameterTuningJobOutput, error) { if params == nil { params = &ListTrainingJobsForHyperParameterTuningJobInput{} @@ -44,9 +45,10 @@ type ListTrainingJobsForHyperParameterTuningJobInput struct { // 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 . @@ -60,10 +62,11 @@ type ListTrainingJobsForHyperParameterTuningJobInput struct { type ListTrainingJobsForHyperParameterTuningJobOutput struct { - // A list of TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) - // objects that describe the training jobs that the + // A list of [TrainingJobSummary] objects that describe the training jobs that the // ListTrainingJobsForHyperParameterTuningJob request returned. // + // [TrainingJobSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html + // // This member is required. TrainingJobSummaries []types.HyperParameterTrainingJobSummary diff --git a/service/sagemaker/api_op_ListTrialComponents.go b/service/sagemaker/api_op_ListTrialComponents.go index 53fae113661..51901060f43 100644 --- a/service/sagemaker/api_op_ListTrialComponents.go +++ b/service/sagemaker/api_op_ListTrialComponents.go @@ -16,8 +16,11 @@ 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 func (c *Client) ListTrialComponents(ctx context.Context, params *ListTrialComponentsInput, optFns ...func(*Options)) (*ListTrialComponentsOutput, error) { if params == nil { diff --git a/service/sagemaker/api_op_PutModelPackageGroupPolicy.go b/service/sagemaker/api_op_PutModelPackageGroupPolicy.go index f46bc41fcd5..4e6fc6309e1 100644 --- a/service/sagemaker/api_op_PutModelPackageGroupPolicy.go +++ b/service/sagemaker/api_op_PutModelPackageGroupPolicy.go @@ -11,8 +11,10 @@ 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) -// in the Amazon Web Services Identity and Access Management User Guide.. +// resoure policies, see [Identity-based policies and resource-based policies]in the Amazon Web Services Identity and Access Management +// User Guide.. +// +// [Identity-based policies and resource-based policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html func (c *Client) PutModelPackageGroupPolicy(ctx context.Context, params *PutModelPackageGroupPolicyInput, optFns ...func(*Options)) (*PutModelPackageGroupPolicyOutput, error) { if params == nil { params = &PutModelPackageGroupPolicyInput{} diff --git a/service/sagemaker/api_op_QueryLineage.go b/service/sagemaker/api_op_QueryLineage.go index 56865e010f8..197c87cca6a 100644 --- a/service/sagemaker/api_op_QueryLineage.go +++ b/service/sagemaker/api_op_QueryLineage.go @@ -12,8 +12,9 @@ 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) -// in the Amazon SageMaker Developer Guide. +// entities. For more information, see [Querying Lineage Entities]in the Amazon SageMaker Developer Guide. +// +// [Querying Lineage Entities]: https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html func (c *Client) QueryLineage(ctx context.Context, params *QueryLineageInput, optFns ...func(*Options)) (*QueryLineageOutput, error) { if params == nil { params = &QueryLineageInput{} @@ -37,18 +38,24 @@ type QueryLineageInput struct { // 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) - // and lineage entities on the path. Set to False to only return lineage entities - // that match your query. + // Setting this value to True retrieves not only the entities of interest but + // also the [Associations]and lineage entities on the path. Set to False to only return lineage + // entities that match your query. + // + // [Associations]: https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html IncludeEdges *bool // The maximum depth in lineage relationships from the StartArns that are diff --git a/service/sagemaker/api_op_RenderUiTemplate.go b/service/sagemaker/api_op_RenderUiTemplate.go index 049a6e3dd9f..41b4930c480 100644 --- a/service/sagemaker/api_op_RenderUiTemplate.go +++ b/service/sagemaker/api_op_RenderUiTemplate.go @@ -41,9 +41,11 @@ type RenderUiTemplateInput struct { Task *types.RenderableTask // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html) - // . + // HumanTaskUiArn if you use the UiTemplate parameter. + // + // See a list of available Human Ui Amazon Resource Names (ARNs) in [UiConfig]. + // + // [UiConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html HumanTaskUiArn *string // A Template object containing the worker UI template to render. diff --git a/service/sagemaker/api_op_Search.go b/service/sagemaker/api_op_Search.go index 4736304c01d..b6a36104f91 100644 --- a/service/sagemaker/api_op_Search.go +++ b/service/sagemaker/api_op_Search.go @@ -13,11 +13,15 @@ import ( // Finds SageMaker resources that match a search query. Matching resources are // returned as a list of SearchRecord objects in the response. You can sort the -// 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) -// for more information. +// 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] for more +// information. +// +// [Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference]: https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error) { if params == nil { params = &SearchInput{} @@ -40,14 +44,14 @@ type SearchInput struct { // This member is required. Resource types.ResourceType - // A cross account filter option. When the value is "CrossAccount" the search + // A cross account filter option. When the value is "CrossAccount" the search // results will only include resources made discoverable to you from other // accounts. When the value is "SameAccount" or null the search results will only // include resources from your account. Default is null . For more information on - // searching for resources made discoverable to your account, see Search - // discoverable resources (https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html) - // in the SageMaker Developer Guide. The maximum number of ResourceCatalog s - // viewable is 1000. + // searching for resources made discoverable to your account, see [Search discoverable resources]in the SageMaker + // Developer Guide. The maximum number of ResourceCatalog s viewable is 1000. + // + // [Search discoverable resources]: https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html CrossAccountFilterOption types.CrossAccountFilterOption // The maximum number of results to return. @@ -72,7 +76,8 @@ type SearchInput struct { // default is Descending . SortOrder types.SearchSortOrder - // Limits the results of your search request to the resources that you can access. + // Limits the results of your search request to the resources that you can + // access. VisibilityConditions []types.VisibilityConditions noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_StartMonitoringSchedule.go b/service/sagemaker/api_op_StartMonitoringSchedule.go index 582211f09b1..2b77ebfb9bf 100644 --- a/service/sagemaker/api_op_StartMonitoringSchedule.go +++ b/service/sagemaker/api_op_StartMonitoringSchedule.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts a previously stopped monitoring schedule. By default, when you -// successfully create a new schedule, the status of a monitoring schedule is -// scheduled . +// Starts a previously stopped monitoring schedule. +// +// By default, when you successfully create a new schedule, the status of a +// monitoring schedule is 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_StopCompilationJob.go b/service/sagemaker/api_op_StopCompilationJob.go index d80aea5517a..7a9eeeb84d7 100644 --- a/service/sagemaker/api_op_StopCompilationJob.go +++ b/service/sagemaker/api_op_StopCompilationJob.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a model compilation job. To stop a job, Amazon SageMaker sends the -// 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 CompilationJobStatus -// of the job to Stopping . After Amazon SageMaker stops the job, it sets the -// CompilationJobStatus to Stopped . +// Stops a model compilation job. +// +// To stop a job, Amazon SageMaker sends the 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 +// CompilationJobStatus of the job to Stopping . After Amazon SageMaker stops the +// job, it sets the CompilationJobStatus 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 b6d24b146de..5bb2122686a 100644 --- a/service/sagemaker/api_op_StopHyperParameterTuningJob.go +++ b/service/sagemaker/api_op_StopHyperParameterTuningJob.go @@ -11,11 +11,12 @@ import ( ) // 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 -// for the tuning job. +// 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 for the tuning job. func (c *Client) StopHyperParameterTuningJob(ctx context.Context, params *StopHyperParameterTuningJobInput, optFns ...func(*Options)) (*StopHyperParameterTuningJobOutput, error) { if params == nil { params = &StopHyperParameterTuningJobInput{} diff --git a/service/sagemaker/api_op_StopInferenceExperiment.go b/service/sagemaker/api_op_StopInferenceExperiment.go index 2fe013294ff..8b0545cf529 100644 --- a/service/sagemaker/api_op_StopInferenceExperiment.go +++ b/service/sagemaker/api_op_StopInferenceExperiment.go @@ -29,10 +29,13 @@ 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 + // 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. @@ -43,15 +46,17 @@ type StopInferenceExperimentInput struct { // This member is required. Name *string - // An array of ModelVariantConfig objects. There is one for each variant that you + // An array of ModelVariantConfig objects. There is one for each variant that you // want to deploy after the inference experiment stops. Each ModelVariantConfig // describes the infrastructure configuration for deploying the corresponding // variant. DesiredModelVariants []types.ModelVariantConfig - // The desired state of the experiment after stopping. The possible states are the - // following: + // The desired state of the experiment after stopping. The possible states are + // the following: + // // - Completed : The experiment completed successfully + // // - Cancelled : The experiment was canceled DesiredState types.InferenceExperimentStopDesiredState diff --git a/service/sagemaker/api_op_StopNotebookInstance.go b/service/sagemaker/api_op_StopNotebookInstance.go index 4ecbebde76d..d5e4fd67b1d 100644 --- a/service/sagemaker/api_op_StopNotebookInstance.go +++ b/service/sagemaker/api_op_StopNotebookInstance.go @@ -13,10 +13,12 @@ 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 -// 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. +// 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. func (c *Client) StopNotebookInstance(ctx context.Context, params *StopNotebookInstanceInput, optFns ...func(*Options)) (*StopNotebookInstanceOutput, error) { if params == nil { params = &StopNotebookInstanceInput{} diff --git a/service/sagemaker/api_op_StopPipelineExecution.go b/service/sagemaker/api_op_StopPipelineExecution.go index b6c693875c9..36d5b57a2b0 100644 --- a/service/sagemaker/api_op_StopPipelineExecution.go +++ b/service/sagemaker/api_op_StopPipelineExecution.go @@ -10,22 +10,32 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Stops a pipeline execution. Callback Step A pipeline execution won't stop while -// a callback step is running. When you call StopPipelineExecution on a pipeline -// execution with a running callback step, SageMaker Pipelines sends an additional -// Amazon SQS message to the specified SQS queue. The body of the SQS message -// 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 -// 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 . +// Stops a pipeline execution. +// +// # Callback Step +// +// A pipeline execution won't stop while a callback step is running. When you call +// StopPipelineExecution on a pipeline execution with a running callback step, +// SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS +// queue. The body of the SQS message 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 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 . 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 13acc24279f..9ce2995f3c6 100644 --- a/service/sagemaker/api_op_StopTrainingJob.go +++ b/service/sagemaker/api_op_StopTrainingJob.go @@ -13,9 +13,10 @@ import ( // Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM // 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 . +// 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 . 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 c9f3511aab6..27955410d0e 100644 --- a/service/sagemaker/api_op_StopTransformJob.go +++ b/service/sagemaker/api_op_StopTransformJob.go @@ -10,11 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// Amazon S3. +// 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 Amazon S3. func (c *Client) StopTransformJob(ctx context.Context, params *StopTransformJobInput, optFns ...func(*Options)) (*StopTransformJobOutput, error) { if params == nil { params = &StopTransformJobInput{} diff --git a/service/sagemaker/api_op_UpdateClusterSoftware.go b/service/sagemaker/api_op_UpdateClusterSoftware.go index 45e01787ae7..135f28168ca 100644 --- a/service/sagemaker/api_op_UpdateClusterSoftware.go +++ b/service/sagemaker/api_op_UpdateClusterSoftware.go @@ -11,9 +11,9 @@ import ( ) // Updates the platform software of a SageMaker HyperPod cluster for security -// patching. To learn how to use this API, see Update the SageMaker HyperPod -// platform software of a cluster (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software) -// . +// patching. To learn how to use this API, see [Update the SageMaker HyperPod platform software of a cluster]. +// +// [Update the SageMaker HyperPod platform software of a cluster]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software func (c *Client) UpdateClusterSoftware(ctx context.Context, params *UpdateClusterSoftwareInput, optFns ...func(*Options)) (*UpdateClusterSoftwareOutput, error) { if params == nil { params = &UpdateClusterSoftwareInput{} diff --git a/service/sagemaker/api_op_UpdateCodeRepository.go b/service/sagemaker/api_op_UpdateCodeRepository.go index 2d17f02dd6d..bc072e3a29e 100644 --- a/service/sagemaker/api_op_UpdateCodeRepository.go +++ b/service/sagemaker/api_op_UpdateCodeRepository.go @@ -37,8 +37,9 @@ type UpdateCodeRepositoryInput struct { // The configuration of the git repository, including the URL and the Amazon // Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that // contains the credentials used to access the repository. The secret must have a - // staging label of AWSCURRENT and must be in the following format: {"username": - // UserName, "password": Password} + // staging label of AWSCURRENT and must be in the following format: + // + // {"username": UserName, "password": Password} GitConfig *types.GitConfigForUpdate noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_UpdateDeviceFleet.go b/service/sagemaker/api_op_UpdateDeviceFleet.go index 3d5d15600b6..02739d6ad6f 100644 --- a/service/sagemaker/api_op_UpdateDeviceFleet.go +++ b/service/sagemaker/api_op_UpdateDeviceFleet.go @@ -44,8 +44,10 @@ type UpdateDeviceFleetInput struct { // Whether to create an Amazon Web Services IoT Role Alias during device fleet // creation. The name of the role alias generated will match this pattern: - // "SageMakerEdge-{DeviceFleetName}". For example, if your device fleet is called - // "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet". + // "SageMakerEdge-{DeviceFleetName}". + // + // For example, if your device fleet is called "demo-fleet", the name of the role + // alias will be "SageMakerEdge-demo-fleet". EnableIotRoleAlias *bool // The Amazon Resource Name (ARN) of the device. diff --git a/service/sagemaker/api_op_UpdateDomain.go b/service/sagemaker/api_op_UpdateDomain.go index 3e5be6f111a..8e796839fe9 100644 --- a/service/sagemaker/api_op_UpdateDomain.go +++ b/service/sagemaker/api_op_UpdateDomain.go @@ -35,9 +35,12 @@ type UpdateDomainInput struct { DomainId *string // Specifies the VPC used for non-EFS traffic. + // // - 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. + // // This configuration can only be modified if there are no apps in the InService , // Pending , or Deleting state. The configuration cannot be updated if // DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already @@ -62,8 +65,10 @@ type UpdateDomainInput struct { // A collection of DomainSettings configuration values to update. DomainSettingsForUpdate *types.DomainSettingsForUpdate - // The VPC subnets that Studio uses for communication. If removing subnets, ensure - // there are no apps in the InService , Pending , or Deleting state. + // The VPC subnets that Studio uses for communication. + // + // If removing subnets, ensure there are no apps in the InService , Pending , or + // Deleting state. SubnetIds []string noSmithyDocumentSerde diff --git a/service/sagemaker/api_op_UpdateEndpoint.go b/service/sagemaker/api_op_UpdateEndpoint.go index ea5b9f22e9a..bf8330c85b4 100644 --- a/service/sagemaker/api_op_UpdateEndpoint.go +++ b/service/sagemaker/api_op_UpdateEndpoint.go @@ -15,17 +15,22 @@ import ( // instances. SageMaker shifts endpoint traffic to the new instances with the // updated endpoint configuration and then deletes the old instances using the // previous EndpointConfig (there is no availability loss). For more information -// about how to control the update and traffic shifting process, see Update models -// in production (https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails.html) -// . When SageMaker receives the request, it sets the endpoint status to Updating . +// about how to control the update and traffic shifting process, see [Update models in production]. +// +// 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) -// 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 that is active or being created or -// updated you may lose visibility into the instance type the endpoint is using. +// 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 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. +// +// [DescribeEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html +// [Update models in production]: https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails.html func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput, optFns ...func(*Options)) (*UpdateEndpointOutput, error) { if params == nil { params = &UpdateEndpointInput{} @@ -59,19 +64,20 @@ type UpdateEndpointInput struct { // When you are updating endpoint resources with RetainAllVariantProperties , whose // value is set to true , ExcludeRetainedVariantProperties specifies the list of - // type VariantProperty (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html) - // to override with the values provided by EndpointConfig . If you don't specify a - // value for ExcludeRetainedVariantProperties , no variant properties are + // type [VariantProperty]to override with the values provided by EndpointConfig . If you don't + // specify a value for ExcludeRetainedVariantProperties , no variant properties are // overridden. + // + // [VariantProperty]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html 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 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 . + // When updating endpoint resources, enables or disables the retention of [variant properties], 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 . + // + // [variant properties]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html 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 9be2605fa9c..c8f2ae0a4bd 100644 --- a/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go +++ b/service/sagemaker/api_op_UpdateEndpointWeightsAndCapacities.go @@ -15,8 +15,9 @@ import ( // 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 -// an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) -// API. +// an endpoint, use the [DescribeEndpoint]API. +// +// [DescribeEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html func (c *Client) UpdateEndpointWeightsAndCapacities(ctx context.Context, params *UpdateEndpointWeightsAndCapacitiesInput, optFns ...func(*Options)) (*UpdateEndpointWeightsAndCapacitiesOutput, error) { if params == nil { params = &UpdateEndpointWeightsAndCapacitiesInput{} diff --git a/service/sagemaker/api_op_UpdateFeatureGroup.go b/service/sagemaker/api_op_UpdateFeatureGroup.go index 3b4090215d6..fe66a009dc0 100644 --- a/service/sagemaker/api_op_UpdateFeatureGroup.go +++ b/service/sagemaker/api_op_UpdateFeatureGroup.go @@ -13,13 +13,16 @@ import ( // Updates the feature group by either adding features or updating the online // store configuration. Use one of the following request parameters at a time while -// using the UpdateFeatureGroup API. You can add features for your feature group -// using the FeatureAdditions request parameter. Features cannot be removed from a -// feature group. You can update the online store configuration by using the -// OnlineStoreConfig request parameter. If a TtlDuration is specified, the default -// TtlDuration applies for all records added to the feature group after the feature -// group is updated. If a record level TtlDuration exists from using the PutRecord -// API, the record level TtlDuration applies to that record instead of the default +// using the UpdateFeatureGroup API. +// +// You can add features for your feature group using the FeatureAdditions request +// parameter. Features cannot be removed from a feature group. +// +// You can update the online store configuration by using the OnlineStoreConfig +// request parameter. If a TtlDuration is specified, the default TtlDuration +// applies for all records added to the feature group after the feature group is +// updated. If a record level TtlDuration exists from using the PutRecord API, the +// record level TtlDuration applies to that record instead of the default // TtlDuration . To remove the default TtlDuration from an existing feature group, // use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null . func (c *Client) UpdateFeatureGroup(ctx context.Context, params *UpdateFeatureGroupInput, optFns ...func(*Options)) (*UpdateFeatureGroupOutput, error) { diff --git a/service/sagemaker/api_op_UpdateHub.go b/service/sagemaker/api_op_UpdateHub.go index 32c9ca529f9..b1e40f1dbbc 100644 --- a/service/sagemaker/api_op_UpdateHub.go +++ b/service/sagemaker/api_op_UpdateHub.go @@ -10,7 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a hub. Hub APIs are only callable through SageMaker Studio. +// Update a hub. +// +// Hub APIs are only callable through SageMaker Studio. func (c *Client) UpdateHub(ctx context.Context, params *UpdateHubInput, optFns ...func(*Options)) (*UpdateHubOutput, error) { if params == nil { params = &UpdateHubInput{} diff --git a/service/sagemaker/api_op_UpdateImage.go b/service/sagemaker/api_op_UpdateImage.go index 4c4435eeded..95bc64bf414 100644 --- a/service/sagemaker/api_op_UpdateImage.go +++ b/service/sagemaker/api_op_UpdateImage.go @@ -11,9 +11,10 @@ import ( ) // Updates the properties of a SageMaker image. To change the image's tags, use -// the AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html) -// and DeleteTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) -// APIs. +// the [AddTags]and [DeleteTags] APIs. +// +// [AddTags]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html +// [DeleteTags]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html 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 52d765c5ce1..c8181cf0872 100644 --- a/service/sagemaker/api_op_UpdateImageVersion.go +++ b/service/sagemaker/api_op_UpdateImageVersion.go @@ -47,8 +47,11 @@ 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. JobType types.JobType @@ -57,7 +60,9 @@ type UpdateImageVersionInput struct { MLFramework *string // Indicates CPU or GPU compatibility. + // // - CPU : The image version is compatible with CPU. + // // - GPU : The image version is compatible with GPU. Processor types.Processor @@ -68,12 +73,16 @@ 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. VendorGuidance types.VendorGuidance diff --git a/service/sagemaker/api_op_UpdateInferenceExperiment.go b/service/sagemaker/api_op_UpdateInferenceExperiment.go index 2193b72142c..b79f8feab70 100644 --- a/service/sagemaker/api_op_UpdateInferenceExperiment.go +++ b/service/sagemaker/api_op_UpdateInferenceExperiment.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates an inference experiment that you created. The status of the inference +// 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 DescribeInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html) -// . +// status of an inference experiment, see [DescribeInferenceExperiment]. +// +// [DescribeInferenceExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html func (c *Client) UpdateInferenceExperiment(ctx context.Context, params *UpdateInferenceExperimentInput, optFns ...func(*Options)) (*UpdateInferenceExperimentOutput, error) { if params == nil { params = &UpdateInferenceExperimentInput{} @@ -44,17 +46,17 @@ type UpdateInferenceExperimentInput struct { // The description of the inference experiment. Description *string - // An array of ModelVariantConfig objects. There is one for each variant, whose + // An array of ModelVariantConfig objects. There is one for each variant, whose // infrastructure configuration you want to update. ModelVariants []types.ModelVariantConfig - // The duration for which the inference experiment will run. If the status of the + // 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. Schedule *types.InferenceExperimentSchedule - // The configuration of ShadowMode inference experiment type. Use this field to + // The configuration of ShadowMode inference experiment type. Use this field to // specify a production variant which takes all the inference requests, and a // shadow variant to which Amazon SageMaker replicates a percentage of the // inference requests. For the shadow variant also specify the percentage of diff --git a/service/sagemaker/api_op_UpdateModelCard.go b/service/sagemaker/api_op_UpdateModelCard.go index e66838da8f1..46d11382365 100644 --- a/service/sagemaker/api_op_UpdateModelCard.go +++ b/service/sagemaker/api_op_UpdateModelCard.go @@ -11,8 +11,10 @@ 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,16 +37,23 @@ 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.html#model-cards-json-schema) - // and provided as a string. When updating model card content, be sure to include - // the full content and not just updated content. + // The updated model card content. Content must be in [model card JSON schema] and provided as a string. + // + // When updating model card content, be sure to include the full content and not + // just updated content. + // + // [model card JSON schema]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema 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. ModelCardStatus types.ModelCardStatus diff --git a/service/sagemaker/api_op_UpdateModelPackage.go b/service/sagemaker/api_op_UpdateModelPackage.go index 65c57764a4b..9f5d01e05fb 100644 --- a/service/sagemaker/api_op_UpdateModelPackage.go +++ b/service/sagemaker/api_op_UpdateModelPackage.go @@ -53,10 +53,13 @@ type UpdateModelPackageInput struct { // Specifies details about inference jobs that you can run with models based on // this model package, including the following information: + // // - 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 diff --git a/service/sagemaker/api_op_UpdateNotebookInstance.go b/service/sagemaker/api_op_UpdateNotebookInstance.go index 10a8f596654..be261814e8f 100644 --- a/service/sagemaker/api_op_UpdateNotebookInstance.go +++ b/service/sagemaker/api_op_UpdateNotebookInstance.go @@ -38,28 +38,29 @@ 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) . + // notebook instance. For more information, see [Using Elastic Inference in Amazon SageMaker]. + // + // [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) - // . + // in your account, or the URL of Git repositories in [Amazon Web Services CodeCommit]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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) - // . + // in your account, or the URL of a Git repository in [Amazon Web Services CodeCommit]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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 @@ -93,21 +94,25 @@ type UpdateNotebookInstanceInput struct { InstanceType types.InstanceType // 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) - // . + // For information about lifestyle configurations, see [Step 2.1: (Optional) Customize a Notebook Instance]. + // + // [Step 2.1: (Optional) 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]. + // + // 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 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_UpdateNotebookInstanceLifecycleConfig.go b/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go index b2edcc230f3..e6d1e5550cc 100644 --- a/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go +++ b/service/sagemaker/api_op_UpdateNotebookInstanceLifecycleConfig.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a notebook instance lifecycle configuration created with the -// CreateNotebookInstanceLifecycleConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) -// API. +// Updates a notebook instance lifecycle configuration created with the [CreateNotebookInstanceLifecycleConfig] API. +// +// [CreateNotebookInstanceLifecycleConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html func (c *Client) UpdateNotebookInstanceLifecycleConfig(ctx context.Context, params *UpdateNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*UpdateNotebookInstanceLifecycleConfigOutput, error) { if params == nil { params = &UpdateNotebookInstanceLifecycleConfigInput{} diff --git a/service/sagemaker/api_op_UpdateProject.go b/service/sagemaker/api_op_UpdateProject.go index ea3f125ea61..20dbcba1301 100644 --- a/service/sagemaker/api_op_UpdateProject.go +++ b/service/sagemaker/api_op_UpdateProject.go @@ -12,8 +12,9 @@ import ( ) // Updates a machine learning (ML) project that is created from a template that -// sets up an ML pipeline from training to deploying an approved model. You must -// not update a project that is in use. If you update the +// sets up an ML pipeline from training to deploying an approved model. +// +// You must not update a project that is in use. If you update the // ServiceCatalogProvisioningUpdateDetails of a project that is active or being // created, or updated, you may lose resources already created by the project. func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error) { @@ -44,17 +45,19 @@ 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]. + // + // [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]. 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]. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html + // [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 9a812e85cc4..2070e2ba17a 100644 --- a/service/sagemaker/api_op_UpdateTrainingJob.go +++ b/service/sagemaker/api_op_UpdateTrainingJob.go @@ -46,9 +46,9 @@ type UpdateTrainingJobInput struct { // Configuration for remote debugging while the training job is running. You can // update the remote debugging configuration when the SecondaryStatus of the job // is Downloading or Training .To learn more about the remote debugging - // functionality of SageMaker, see Access a training container through Amazon Web - // Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html) - // . + // functionality of SageMaker, see [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]. + // + // [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html RemoteDebugConfig *types.RemoteDebugConfigForUpdate // The training job ResourceConfig to update warm pool retention length. diff --git a/service/sagemaker/api_op_UpdateWorkforce.go b/service/sagemaker/api_op_UpdateWorkforce.go index 2b9abb3d26e..94c0f5bc64a 100644 --- a/service/sagemaker/api_op_UpdateWorkforce.go +++ b/service/sagemaker/api_op_UpdateWorkforce.go @@ -13,24 +13,38 @@ 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 +// 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]. +// 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 -// DeleteWorkteam (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) -// 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 DescribeWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html) -// operation. This operation only applies to private workforces. +// 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 [DeleteWorkteam]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 [DescribeWorkforce]operation. +// +// This operation only applies to private workforces. +// +// [DescribeWorkforce]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html +// [DeleteWorkteam]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html +// [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html func (c *Client) UpdateWorkforce(ctx context.Context, params *UpdateWorkforceInput, optFns ...func(*Options)) (*UpdateWorkforceOutput, error) { if params == nil { params = &UpdateWorkforceInput{} @@ -49,8 +63,9 @@ func (c *Client) UpdateWorkforce(ctx context.Context, params *UpdateWorkforceInp type UpdateWorkforceInput struct { // The name of the private workforce that you want to update. You can find your - // workforce name by using the ListWorkforces (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html) - // operation. + // workforce name by using the [ListWorkforces]operation. + // + // [ListWorkforces]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html // // This member is required. WorkforceName *string @@ -59,9 +74,12 @@ type UpdateWorkforceInput struct { // 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] ) that can be used to access + // tasks assigned to this workforce. + // + // Maximum: Ten CIDR values + // + // [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html SourceIpConfig *types.SourceIpConfig // Use this parameter to update your VPC configuration for a workforce. @@ -75,8 +93,9 @@ 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) - // . + // learn how to create a private workforce, see [Create a Private Workforce]. + // + // [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 f75f18c7fc6..f9b0b7503e0 100644 --- a/service/sagemaker/api_op_UpdateWorkteam.go +++ b/service/sagemaker/api_op_UpdateWorkteam.go @@ -38,23 +38,28 @@ type UpdateWorkteamInput struct { Description *string // 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 - // 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 + // 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 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]. + // + // 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. + // + // [Amazon Cognito User Pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html 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 6f24316ac0c..71b2eccbeb2 100644 --- a/service/sagemaker/doc.go +++ b/service/sagemaker/doc.go @@ -3,7 +3,14 @@ // Package sagemaker provides the API client, operations, and parameter types for // 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) +// Provides APIs for creating and managing SageMaker resources. +// +// Other Resources: +// +// [SageMaker Developer Guide] +// +// [Amazon Augmented AI Runtime API Reference] +// +// [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 package sagemaker diff --git a/service/sagemaker/options.go b/service/sagemaker/options.go index f34cfbc1e73..bb6d8a03d34 100644 --- a/service/sagemaker/options.go +++ b/service/sagemaker/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemaker/types/enums.go b/service/sagemaker/types/enums.go index 2bc0cf44070..fddd73c4358 100644 --- a/service/sagemaker/types/enums.go +++ b/service/sagemaker/types/enums.go @@ -15,8 +15,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -38,8 +39,9 @@ const ( // Values returns all known values for AdditionalS3DataSourceDataType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalS3DataSourceDataType) Values() []AdditionalS3DataSourceDataType { return []AdditionalS3DataSourceDataType{ "S3Object", @@ -60,8 +62,9 @@ const ( // Values returns all known values for AggregationTransformationValue. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AggregationTransformationValue) Values() []AggregationTransformationValue { return []AggregationTransformationValue{ "sum", @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for AlgorithmSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmSortBy) Values() []AlgorithmSortBy { return []AlgorithmSortBy{ "Name", @@ -102,8 +106,9 @@ const ( ) // Values returns all known values for AlgorithmStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmStatus) Values() []AlgorithmStatus { return []AlgorithmStatus{ "Pending", @@ -124,8 +129,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CreationTime", @@ -286,8 +292,9 @@ const ( ) // Values returns all known values for AppInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppInstanceType) Values() []AppInstanceType { return []AppInstanceType{ "system", @@ -447,8 +454,9 @@ const ( ) // Values returns all known values for AppNetworkAccessType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppNetworkAccessType) Values() []AppNetworkAccessType { return []AppNetworkAccessType{ "PublicInternetOnly", @@ -466,6 +474,7 @@ const ( // Values returns all known values for AppSecurityGroupManagement. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AppSecurityGroupManagement) Values() []AppSecurityGroupManagement { return []AppSecurityGroupManagement{ @@ -482,8 +491,9 @@ const ( ) // Values returns all known values for AppSortKey. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppSortKey) Values() []AppSortKey { return []AppSortKey{ "CreationTime", @@ -502,8 +512,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -530,8 +541,9 @@ const ( ) // Values returns all known values for AppType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppType) Values() []AppType { return []AppType{ "JupyterServer", @@ -557,8 +569,9 @@ const ( ) // Values returns all known values for ArtifactSourceIdType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ArtifactSourceIdType) Values() []ArtifactSourceIdType { return []ArtifactSourceIdType{ "MD5Hash", @@ -577,8 +590,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -598,8 +612,9 @@ const ( ) // Values returns all known values for AssociationEdgeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationEdgeType) Values() []AssociationEdgeType { return []AssociationEdgeType{ "ContributedTo", @@ -620,6 +635,7 @@ const ( // Values returns all known values for AsyncNotificationTopicTypes. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AsyncNotificationTopicTypes) Values() []AsyncNotificationTopicTypes { return []AsyncNotificationTopicTypes{ @@ -639,6 +655,7 @@ const ( // Values returns all known values for AthenaResultCompressionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AthenaResultCompressionType) Values() []AthenaResultCompressionType { return []AthenaResultCompressionType{ @@ -660,8 +677,9 @@ const ( ) // Values returns all known values for AthenaResultFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AthenaResultFormat) Values() []AthenaResultFormat { return []AthenaResultFormat{ "PARQUET", @@ -681,8 +699,9 @@ const ( ) // Values returns all known values for AuthMode. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthMode) Values() []AuthMode { return []AuthMode{ "SSO", @@ -706,8 +725,9 @@ const ( ) // Values returns all known values for AutoMLAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLAlgorithm) Values() []AutoMLAlgorithm { return []AutoMLAlgorithm{ "xgboost", @@ -731,8 +751,9 @@ const ( ) // Values returns all known values for AutoMLChannelType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLChannelType) Values() []AutoMLChannelType { return []AutoMLChannelType{ "training", @@ -749,8 +770,9 @@ const ( ) // Values returns all known values for AutoMLJobObjectiveType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLJobObjectiveType) Values() []AutoMLJobObjectiveType { return []AutoMLJobObjectiveType{ "Maximize", @@ -785,6 +807,7 @@ const ( // 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{ @@ -822,8 +845,9 @@ const ( ) // Values returns all known values for AutoMLJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLJobStatus) Values() []AutoMLJobStatus { return []AutoMLJobStatus{ "Completed", @@ -858,8 +882,9 @@ const ( ) // Values returns all known values for AutoMLMetricEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLMetricEnum) Values() []AutoMLMetricEnum { return []AutoMLMetricEnum{ "Accuracy", @@ -916,6 +941,7 @@ const ( // 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{ @@ -958,8 +984,9 @@ const ( ) // Values returns all known values for AutoMLMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLMode) Values() []AutoMLMode { return []AutoMLMode{ "AUTO", @@ -981,6 +1008,7 @@ const ( // Values returns all known values for AutoMLProblemTypeConfigName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLProblemTypeConfigName) Values() []AutoMLProblemTypeConfigName { return []AutoMLProblemTypeConfigName{ @@ -1001,8 +1029,9 @@ const ( ) // Values returns all known values for AutoMLProcessingUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLProcessingUnit) Values() []AutoMLProcessingUnit { return []AutoMLProcessingUnit{ "CPU", @@ -1020,8 +1049,9 @@ const ( ) // Values returns all known values for AutoMLS3DataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLS3DataType) Values() []AutoMLS3DataType { return []AutoMLS3DataType{ "ManifestFile", @@ -1040,8 +1070,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1059,8 +1090,9 @@ const ( ) // Values returns all known values for AutoMLSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoMLSortOrder) Values() []AutoMLSortOrder { return []AutoMLSortOrder{ "Ascending", @@ -1076,8 +1108,9 @@ const ( ) // Values returns all known values for AutotuneMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutotuneMode) Values() []AutotuneMode { return []AutotuneMode{ "Enabled", @@ -1094,8 +1127,9 @@ const ( // Values returns all known values for AwsManagedHumanLoopRequestSource. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AwsManagedHumanLoopRequestSource) Values() []AwsManagedHumanLoopRequestSource { return []AwsManagedHumanLoopRequestSource{ "AWS/Rekognition/DetectModerationLabels/Image/V3", @@ -1112,8 +1146,9 @@ const ( ) // Values returns all known values for BatchStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchStrategy) Values() []BatchStrategy { return []BatchStrategy{ "MultiRecord", @@ -1130,8 +1165,9 @@ const ( ) // Values returns all known values for BooleanOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BooleanOperator) Values() []BooleanOperator { return []BooleanOperator{ "And", @@ -1149,8 +1185,9 @@ const ( ) // Values returns all known values for CandidateSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CandidateSortBy) Values() []CandidateSortBy { return []CandidateSortBy{ "CreationTime", @@ -1171,8 +1208,9 @@ const ( ) // Values returns all known values for CandidateStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CandidateStatus) Values() []CandidateStatus { return []CandidateStatus{ "Completed", @@ -1193,8 +1231,9 @@ const ( ) // Values returns all known values for CandidateStepType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CandidateStepType) Values() []CandidateStepType { return []CandidateStepType{ "AWS::SageMaker::TrainingJob", @@ -1212,8 +1251,9 @@ const ( ) // Values returns all known values for CapacitySizeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CapacitySizeType) Values() []CapacitySizeType { return []CapacitySizeType{ "INSTANCE_COUNT", @@ -1231,8 +1271,9 @@ const ( ) // Values returns all known values for CaptureMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CaptureMode) Values() []CaptureMode { return []CaptureMode{ "Input", @@ -1250,8 +1291,9 @@ const ( ) // Values returns all known values for CaptureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CaptureStatus) Values() []CaptureStatus { return []CaptureStatus{ "Started", @@ -1269,8 +1311,9 @@ const ( ) // Values returns all known values for ClarifyFeatureType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClarifyFeatureType) Values() []ClarifyFeatureType { return []ClarifyFeatureType{ "numerical", @@ -1289,8 +1332,9 @@ const ( ) // Values returns all known values for ClarifyTextGranularity. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClarifyTextGranularity) Values() []ClarifyTextGranularity { return []ClarifyTextGranularity{ "token", @@ -1366,8 +1410,9 @@ const ( ) // Values returns all known values for ClarifyTextLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClarifyTextLanguage) Values() []ClarifyTextLanguage { return []ClarifyTextLanguage{ "af", @@ -1445,8 +1490,9 @@ const ( ) // Values returns all known values for ClusterInstanceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterInstanceStatus) Values() []ClusterInstanceStatus { return []ClusterInstanceStatus{ "Running", @@ -1502,8 +1548,9 @@ const ( ) // Values returns all known values for ClusterInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterInstanceType) Values() []ClusterInstanceType { return []ClusterInstanceType{ "ml.p4d.24xlarge", @@ -1556,8 +1603,9 @@ const ( ) // Values returns all known values for ClusterSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterSortBy) Values() []ClusterSortBy { return []ClusterSortBy{ "CREATION_TIME", @@ -1579,8 +1627,9 @@ const ( ) // Values returns all known values for ClusterStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterStatus) Values() []ClusterStatus { return []ClusterStatus{ "Creating", @@ -1603,8 +1652,9 @@ const ( ) // Values returns all known values for CodeRepositorySortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodeRepositorySortBy) Values() []CodeRepositorySortBy { return []CodeRepositorySortBy{ "Name", @@ -1622,8 +1672,9 @@ const ( ) // Values returns all known values for CodeRepositorySortOrder. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodeRepositorySortOrder) Values() []CodeRepositorySortOrder { return []CodeRepositorySortOrder{ "Ascending", @@ -1641,8 +1692,9 @@ const ( ) // Values returns all known values for CollectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CollectionType) Values() []CollectionType { return []CollectionType{ "List", @@ -1664,8 +1716,9 @@ const ( ) // Values returns all known values for CompilationJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompilationJobStatus) Values() []CompilationJobStatus { return []CompilationJobStatus{ "INPROGRESS", @@ -1686,8 +1739,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Disabled", @@ -1704,8 +1758,9 @@ const ( ) // Values returns all known values for CompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionType) Values() []CompressionType { return []CompressionType{ "None", @@ -1722,8 +1777,9 @@ const ( ) // Values returns all known values for ConditionOutcome. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConditionOutcome) Values() []ConditionOutcome { return []ConditionOutcome{ "True", @@ -1740,8 +1796,9 @@ const ( ) // Values returns all known values for ContainerMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContainerMode) Values() []ContainerMode { return []ContainerMode{ "SingleModel", @@ -1758,8 +1815,9 @@ const ( ) // Values returns all known values for ContentClassifier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentClassifier) Values() []ContentClassifier { return []ContentClassifier{ "FreeOfPersonallyIdentifiableInformation", @@ -1777,6 +1835,7 @@ const ( // Values returns all known values for CrossAccountFilterOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CrossAccountFilterOption) Values() []CrossAccountFilterOption { return []CrossAccountFilterOption{ @@ -1794,8 +1853,9 @@ const ( ) // Values returns all known values for DataDistributionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataDistributionType) Values() []DataDistributionType { return []DataDistributionType{ "FullyReplicated", @@ -1812,8 +1872,9 @@ const ( ) // Values returns all known values for DataSourceName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataSourceName) Values() []DataSourceName { return []DataSourceName{ "SalesforceGenie", @@ -1832,8 +1893,9 @@ const ( ) // Values returns all known values for DetailedAlgorithmStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DetailedAlgorithmStatus) Values() []DetailedAlgorithmStatus { return []DetailedAlgorithmStatus{ "NotStarted", @@ -1855,6 +1917,7 @@ const ( // Values returns all known values for DetailedModelPackageStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DetailedModelPackageStatus) Values() []DetailedModelPackageStatus { return []DetailedModelPackageStatus{ @@ -1878,8 +1941,9 @@ const ( ) // Values returns all known values for DeviceDeploymentStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceDeploymentStatus) Values() []DeviceDeploymentStatus { return []DeviceDeploymentStatus{ "READYTODEPLOY", @@ -1901,8 +1965,9 @@ const ( ) // Values returns all known values for DeviceSubsetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceSubsetType) Values() []DeviceSubsetType { return []DeviceSubsetType{ "PERCENTAGE", @@ -1920,8 +1985,9 @@ const ( ) // Values returns all known values for DirectInternetAccess. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectInternetAccess) Values() []DirectInternetAccess { return []DirectInternetAccess{ "Enabled", @@ -1939,8 +2005,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -1963,8 +2030,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1990,8 +2058,9 @@ const ( ) // Values returns all known values for EdgePackagingJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EdgePackagingJobStatus) Values() []EdgePackagingJobStatus { return []EdgePackagingJobStatus{ "STARTING", @@ -2013,6 +2082,7 @@ const ( // Values returns all known values for EdgePresetDeploymentStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EdgePresetDeploymentStatus) Values() []EdgePresetDeploymentStatus { return []EdgePresetDeploymentStatus{ @@ -2030,6 +2100,7 @@ const ( // 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{ @@ -2046,8 +2117,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Name", @@ -2065,8 +2137,9 @@ const ( ) // Values returns all known values for EndpointSortKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointSortKey) Values() []EndpointSortKey { return []EndpointSortKey{ "Name", @@ -2091,8 +2164,9 @@ const ( ) // Values returns all known values for EndpointStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EndpointStatus) Values() []EndpointStatus { return []EndpointStatus{ "OutOfService", @@ -2117,6 +2191,7 @@ const ( // Values returns all known values for ExecutionRoleIdentityConfig. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionRoleIdentityConfig) Values() []ExecutionRoleIdentityConfig { return []ExecutionRoleIdentityConfig{ @@ -2139,8 +2214,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "Pending", @@ -2162,8 +2238,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ROLLBACK_ON_FAILURE", @@ -2182,8 +2259,9 @@ const ( ) // Values returns all known values for FeatureGroupSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureGroupSortBy) Values() []FeatureGroupSortBy { return []FeatureGroupSortBy{ "Name", @@ -2202,8 +2280,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Ascending", @@ -2223,8 +2302,9 @@ const ( ) // Values returns all known values for FeatureGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureGroupStatus) Values() []FeatureGroupStatus { return []FeatureGroupStatus{ "Creating", @@ -2244,8 +2324,9 @@ const ( ) // Values returns all known values for FeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureStatus) Values() []FeatureStatus { return []FeatureStatus{ "ENABLED", @@ -2263,8 +2344,9 @@ const ( ) // Values returns all known values for FeatureType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureType) Values() []FeatureType { return []FeatureType{ "Integral", @@ -2282,8 +2364,9 @@ const ( ) // Values returns all known values for FileSystemAccessMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemAccessMode) Values() []FileSystemAccessMode { return []FileSystemAccessMode{ "rw", @@ -2300,8 +2383,9 @@ const ( ) // Values returns all known values for FileSystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileSystemType) Values() []FileSystemType { return []FileSystemType{ "EFS", @@ -2324,8 +2408,9 @@ const ( ) // Values returns all known values for FillingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FillingType) Values() []FillingType { return []FillingType{ "frontfill", @@ -2348,8 +2433,9 @@ const ( ) // Values returns all known values for FlatInvocations. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlatInvocations) Values() []FlatInvocations { return []FlatInvocations{ "Continue", @@ -2368,8 +2454,9 @@ const ( ) // Values returns all known values for FlowDefinitionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlowDefinitionStatus) Values() []FlowDefinitionStatus { return []FlowDefinitionStatus{ "Initializing", @@ -2395,8 +2482,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2421,8 +2509,9 @@ const ( ) // Values returns all known values for HubContentSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HubContentSortBy) Values() []HubContentSortBy { return []HubContentSortBy{ "HubContentName", @@ -2443,8 +2532,9 @@ const ( ) // Values returns all known values for HubContentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HubContentStatus) Values() []HubContentStatus { return []HubContentStatus{ "Available", @@ -2464,8 +2554,9 @@ const ( ) // Values returns all known values for HubContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HubContentType) Values() []HubContentType { return []HubContentType{ "Model", @@ -2484,8 +2575,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2509,8 +2601,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -2532,8 +2625,9 @@ const ( ) // Values returns all known values for HumanTaskUiStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HumanTaskUiStatus) Values() []HumanTaskUiStatus { return []HumanTaskUiStatus{ "Active", @@ -2553,6 +2647,7 @@ const ( // Values returns all known values for HyperParameterScalingType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterScalingType) Values() []HyperParameterScalingType { return []HyperParameterScalingType{ @@ -2572,8 +2667,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterTuningAllocationStrategy) Values() []HyperParameterTuningAllocationStrategy { return []HyperParameterTuningAllocationStrategy{ "Prioritized", @@ -2590,8 +2686,9 @@ const ( // Values returns all known values for HyperParameterTuningJobObjectiveType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterTuningJobObjectiveType) Values() []HyperParameterTuningJobObjectiveType { return []HyperParameterTuningJobObjectiveType{ "Maximize", @@ -2610,8 +2707,9 @@ const ( // Values returns all known values for HyperParameterTuningJobSortByOptions. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterTuningJobSortByOptions) Values() []HyperParameterTuningJobSortByOptions { return []HyperParameterTuningJobSortByOptions{ "Name", @@ -2635,8 +2733,9 @@ const ( // Values returns all known values for HyperParameterTuningJobStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterTuningJobStatus) Values() []HyperParameterTuningJobStatus { return []HyperParameterTuningJobStatus{ "Completed", @@ -2661,8 +2760,9 @@ const ( // Values returns all known values for HyperParameterTuningJobStrategyType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterTuningJobStrategyType) Values() []HyperParameterTuningJobStrategyType { return []HyperParameterTuningJobStrategyType{ "Bayesian", @@ -2682,8 +2782,9 @@ const ( // Values returns all known values for HyperParameterTuningJobWarmStartType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HyperParameterTuningJobWarmStartType) Values() []HyperParameterTuningJobWarmStartType { return []HyperParameterTuningJobWarmStartType{ "IdenticalDataAndAlgorithm", @@ -2701,8 +2802,9 @@ const ( ) // Values returns all known values for ImageSortBy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSortBy) Values() []ImageSortBy { return []ImageSortBy{ "CREATION_TIME", @@ -2720,8 +2822,9 @@ const ( ) // Values returns all known values for ImageSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageSortOrder) Values() []ImageSortOrder { return []ImageSortOrder{ "ASCENDING", @@ -2743,8 +2846,9 @@ const ( ) // Values returns all known values for ImageStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageStatus) Values() []ImageStatus { return []ImageStatus{ "CREATING", @@ -2767,8 +2871,9 @@ const ( ) // Values returns all known values for ImageVersionSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageVersionSortBy) Values() []ImageVersionSortBy { return []ImageVersionSortBy{ "CREATION_TIME", @@ -2786,8 +2891,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ASCENDING", @@ -2807,8 +2913,9 @@ const ( ) // Values returns all known values for ImageVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageVersionStatus) Values() []ImageVersionStatus { return []ImageVersionStatus{ "CREATING", @@ -2830,6 +2937,7 @@ const ( // Values returns all known values for InferenceComponentSortKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InferenceComponentSortKey) Values() []InferenceComponentSortKey { return []InferenceComponentSortKey{ @@ -2852,6 +2960,7 @@ const ( // Values returns all known values for InferenceComponentStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InferenceComponentStatus) Values() []InferenceComponentStatus { return []InferenceComponentStatus{ @@ -2872,8 +2981,9 @@ const ( ) // Values returns all known values for InferenceExecutionMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InferenceExecutionMode) Values() []InferenceExecutionMode { return []InferenceExecutionMode{ "Serial", @@ -2897,6 +3007,7 @@ const ( // Values returns all known values for InferenceExperimentStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InferenceExperimentStatus) Values() []InferenceExperimentStatus { return []InferenceExperimentStatus{ @@ -2921,8 +3032,9 @@ const ( // Values returns all known values for InferenceExperimentStopDesiredState. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InferenceExperimentStopDesiredState) Values() []InferenceExperimentStopDesiredState { return []InferenceExperimentStopDesiredState{ "Completed", @@ -2938,8 +3050,9 @@ const ( ) // Values returns all known values for InferenceExperimentType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InferenceExperimentType) Values() []InferenceExperimentType { return []InferenceExperimentType{ "ShadowMode", @@ -2955,8 +3068,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -3128,8 +3242,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -3302,8 +3417,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "TRAINING", @@ -3321,8 +3437,9 @@ const ( ) // Values returns all known values for JoinSource. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JoinSource) Values() []JoinSource { return []JoinSource{ "Input", @@ -3343,8 +3460,9 @@ const ( ) // Values returns all known values for LabelingJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LabelingJobStatus) Values() []LabelingJobStatus { return []LabelingJobStatus{ "Initializing", @@ -3366,8 +3484,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Successful", @@ -3387,8 +3506,9 @@ const ( ) // Values returns all known values for LineageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LineageType) Values() []LineageType { return []LineageType{ "TrialComponent", @@ -3409,6 +3529,7 @@ const ( // Values returns all known values for ListCompilationJobsSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListCompilationJobsSortBy) Values() []ListCompilationJobsSortBy { return []ListCompilationJobsSortBy{ @@ -3428,8 +3549,9 @@ const ( ) // Values returns all known values for ListDeviceFleetsSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListDeviceFleetsSortBy) Values() []ListDeviceFleetsSortBy { return []ListDeviceFleetsSortBy{ "NAME", @@ -3450,8 +3572,9 @@ const ( // Values returns all known values for ListEdgeDeploymentPlansSortBy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListEdgeDeploymentPlansSortBy) Values() []ListEdgeDeploymentPlansSortBy { return []ListEdgeDeploymentPlansSortBy{ "NAME", @@ -3474,6 +3597,7 @@ const ( // Values returns all known values for ListEdgePackagingJobsSortBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListEdgePackagingJobsSortBy) Values() []ListEdgePackagingJobsSortBy { return []ListEdgePackagingJobsSortBy{ @@ -3496,8 +3620,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListInferenceRecommendationsJobsSortBy) Values() []ListInferenceRecommendationsJobsSortBy { return []ListInferenceRecommendationsJobsSortBy{ "Name", @@ -3515,8 +3640,9 @@ const ( // Values returns all known values for ListLabelingJobsForWorkteamSortByOptions. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListLabelingJobsForWorkteamSortByOptions) Values() []ListLabelingJobsForWorkteamSortByOptions { return []ListLabelingJobsForWorkteamSortByOptions{ "CreationTime", @@ -3533,6 +3659,7 @@ const ( // Values returns all known values for ListWorkforcesSortByOptions. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListWorkforcesSortByOptions) Values() []ListWorkforcesSortByOptions { return []ListWorkforcesSortByOptions{ @@ -3551,6 +3678,7 @@ const ( // Values returns all known values for ListWorkteamsSortByOptions. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ListWorkteamsSortByOptions) Values() []ListWorkteamsSortByOptions { return []ListWorkteamsSortByOptions{ @@ -3569,8 +3697,9 @@ const ( // Values returns all known values for ManagedInstanceScalingStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ManagedInstanceScalingStatus) Values() []ManagedInstanceScalingStatus { return []ManagedInstanceScalingStatus{ "ENABLED", @@ -3588,8 +3717,9 @@ const ( ) // Values returns all known values for MetricSetSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricSetSource) Values() []MetricSetSource { return []MetricSetSource{ "Train", @@ -3608,8 +3738,9 @@ const ( ) // Values returns all known values for ModelApprovalStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelApprovalStatus) Values() []ModelApprovalStatus { return []ModelApprovalStatus{ "Approved", @@ -3627,8 +3758,9 @@ const ( ) // Values returns all known values for ModelCacheSetting. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCacheSetting) Values() []ModelCacheSetting { return []ModelCacheSetting{ "Enabled", @@ -3647,6 +3779,7 @@ const ( // 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{ @@ -3666,6 +3799,7 @@ const ( // Values returns all known values for ModelCardExportJobSortOrder. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardExportJobSortOrder) Values() []ModelCardExportJobSortOrder { return []ModelCardExportJobSortOrder{ @@ -3685,6 +3819,7 @@ const ( // 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{ @@ -3708,6 +3843,7 @@ const ( // Values returns all known values for ModelCardProcessingStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardProcessingStatus) Values() []ModelCardProcessingStatus { return []ModelCardProcessingStatus{ @@ -3729,8 +3865,9 @@ const ( ) // Values returns all known values for ModelCardSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardSortBy) Values() []ModelCardSortBy { return []ModelCardSortBy{ "Name", @@ -3747,8 +3884,9 @@ const ( ) // Values returns all known values for ModelCardSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardSortOrder) Values() []ModelCardSortOrder { return []ModelCardSortOrder{ "Ascending", @@ -3767,8 +3905,9 @@ const ( ) // Values returns all known values for ModelCardStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardStatus) Values() []ModelCardStatus { return []ModelCardStatus{ "Draft", @@ -3786,8 +3925,9 @@ const ( ) // Values returns all known values for ModelCardVersionSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCardVersionSortBy) Values() []ModelCardVersionSortBy { return []ModelCardVersionSortBy{ "Version", @@ -3803,8 +3943,9 @@ const ( ) // Values returns all known values for ModelCompressionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelCompressionType) Values() []ModelCompressionType { return []ModelCompressionType{ "None", @@ -3820,8 +3961,9 @@ const ( ) // Values returns all known values for ModelInfrastructureType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelInfrastructureType) Values() []ModelInfrastructureType { return []ModelInfrastructureType{ "RealTimeInference", @@ -3839,8 +3981,9 @@ const ( ) // Values returns all known values for ModelMetadataFilterType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelMetadataFilterType) Values() []ModelMetadataFilterType { return []ModelMetadataFilterType{ "Domain", @@ -3859,8 +4002,9 @@ const ( ) // Values returns all known values for ModelPackageGroupSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPackageGroupSortBy) Values() []ModelPackageGroupSortBy { return []ModelPackageGroupSortBy{ "Name", @@ -3881,8 +4025,9 @@ const ( ) // Values returns all known values for ModelPackageGroupStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPackageGroupStatus) Values() []ModelPackageGroupStatus { return []ModelPackageGroupStatus{ "Pending", @@ -3903,8 +4048,9 @@ const ( ) // Values returns all known values for ModelPackageSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPackageSortBy) Values() []ModelPackageSortBy { return []ModelPackageSortBy{ "Name", @@ -3924,8 +4070,9 @@ const ( ) // Values returns all known values for ModelPackageStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPackageStatus) Values() []ModelPackageStatus { return []ModelPackageStatus{ "Pending", @@ -3946,8 +4093,9 @@ const ( ) // Values returns all known values for ModelPackageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelPackageType) Values() []ModelPackageType { return []ModelPackageType{ "Versioned", @@ -3965,8 +4113,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -3984,8 +4133,9 @@ const ( ) // Values returns all known values for ModelVariantAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelVariantAction) Values() []ModelVariantAction { return []ModelVariantAction{ "Retain", @@ -4006,8 +4156,9 @@ const ( ) // Values returns all known values for ModelVariantStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelVariantStatus) Values() []ModelVariantStatus { return []ModelVariantStatus{ "Creating", @@ -4028,8 +4179,9 @@ const ( // Values returns all known values for MonitoringAlertHistorySortKey. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitoringAlertHistorySortKey) Values() []MonitoringAlertHistorySortKey { return []MonitoringAlertHistorySortKey{ "CreationTime", @@ -4046,8 +4198,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "InAlert", @@ -4066,6 +4219,7 @@ const ( // Values returns all known values for MonitoringExecutionSortKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MonitoringExecutionSortKey) Values() []MonitoringExecutionSortKey { return []MonitoringExecutionSortKey{ @@ -4085,8 +4239,9 @@ const ( // Values returns all known values for MonitoringJobDefinitionSortKey. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitoringJobDefinitionSortKey) Values() []MonitoringJobDefinitionSortKey { return []MonitoringJobDefinitionSortKey{ "Name", @@ -4104,8 +4259,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "BinaryClassification", @@ -4125,6 +4281,7 @@ const ( // Values returns all known values for MonitoringScheduleSortKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MonitoringScheduleSortKey) Values() []MonitoringScheduleSortKey { return []MonitoringScheduleSortKey{ @@ -4145,8 +4302,9 @@ const ( ) // Values returns all known values for MonitoringType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MonitoringType) Values() []MonitoringType { return []MonitoringType{ "DataQuality", @@ -4170,8 +4328,9 @@ const ( // Values returns all known values for NotebookInstanceAcceleratorType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookInstanceAcceleratorType) Values() []NotebookInstanceAcceleratorType { return []NotebookInstanceAcceleratorType{ "ml.eia1.medium", @@ -4194,8 +4353,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookInstanceLifecycleConfigSortKey) Values() []NotebookInstanceLifecycleConfigSortKey { return []NotebookInstanceLifecycleConfigSortKey{ "Name", @@ -4214,8 +4374,9 @@ const ( // Values returns all known values for NotebookInstanceLifecycleConfigSortOrder. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookInstanceLifecycleConfigSortOrder) Values() []NotebookInstanceLifecycleConfigSortOrder { return []NotebookInstanceLifecycleConfigSortOrder{ "Ascending", @@ -4233,8 +4394,9 @@ const ( ) // Values returns all known values for NotebookInstanceSortKey. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookInstanceSortKey) Values() []NotebookInstanceSortKey { return []NotebookInstanceSortKey{ "Name", @@ -4253,6 +4415,7 @@ const ( // Values returns all known values for NotebookInstanceSortOrder. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NotebookInstanceSortOrder) Values() []NotebookInstanceSortOrder { return []NotebookInstanceSortOrder{ @@ -4275,8 +4438,9 @@ const ( ) // Values returns all known values for NotebookInstanceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookInstanceStatus) Values() []NotebookInstanceStatus { return []NotebookInstanceStatus{ "Pending", @@ -4298,8 +4462,9 @@ const ( ) // Values returns all known values for NotebookOutputOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotebookOutputOption) Values() []NotebookOutputOption { return []NotebookOutputOption{ "Allowed", @@ -4317,8 +4482,9 @@ const ( ) // Values returns all known values for ObjectiveStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ObjectiveStatus) Values() []ObjectiveStatus { return []ObjectiveStatus{ "Succeeded", @@ -4337,8 +4503,9 @@ const ( ) // Values returns all known values for OfflineStoreStatusValue. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OfflineStoreStatusValue) Values() []OfflineStoreStatusValue { return []OfflineStoreStatusValue{ "Active", @@ -4364,8 +4531,9 @@ const ( ) // Values returns all known values for Operator. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Operator) Values() []Operator { return []Operator{ "Equals", @@ -4390,8 +4558,9 @@ const ( ) // Values returns all known values for OrderKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderKey) Values() []OrderKey { return []OrderKey{ "Ascending", @@ -4408,8 +4577,9 @@ const ( ) // Values returns all known values for OutputCompressionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputCompressionType) Values() []OutputCompressionType { return []OutputCompressionType{ "GZIP", @@ -4428,8 +4598,9 @@ const ( ) // Values returns all known values for ParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterType) Values() []ParameterType { return []ParameterType{ "Integer", @@ -4451,8 +4622,9 @@ const ( ) // Values returns all known values for PipelineExecutionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineExecutionStatus) Values() []PipelineExecutionStatus { return []PipelineExecutionStatus{ "Executing", @@ -4472,8 +4644,9 @@ const ( ) // Values returns all known values for PipelineStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PipelineStatus) Values() []PipelineStatus { return []PipelineStatus{ "Active", @@ -4491,8 +4664,9 @@ const ( ) // Values returns all known values for ProblemType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProblemType) Values() []ProblemType { return []ProblemType{ "BinaryClassification", @@ -4552,8 +4726,9 @@ const ( ) // Values returns all known values for ProcessingInstanceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessingInstanceType) Values() []ProcessingInstanceType { return []ProcessingInstanceType{ "ml.t3.medium", @@ -4615,8 +4790,9 @@ const ( ) // Values returns all known values for ProcessingJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessingJobStatus) Values() []ProcessingJobStatus { return []ProcessingJobStatus{ "InProgress", @@ -4637,6 +4813,7 @@ const ( // Values returns all known values for ProcessingS3CompressionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ProcessingS3CompressionType) Values() []ProcessingS3CompressionType { return []ProcessingS3CompressionType{ @@ -4655,8 +4832,9 @@ const ( // Values returns all known values for ProcessingS3DataDistributionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessingS3DataDistributionType) Values() []ProcessingS3DataDistributionType { return []ProcessingS3DataDistributionType{ "FullyReplicated", @@ -4673,8 +4851,9 @@ const ( ) // Values returns all known values for ProcessingS3DataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessingS3DataType) Values() []ProcessingS3DataType { return []ProcessingS3DataType{ "ManifestFile", @@ -4691,8 +4870,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Pipe", @@ -4709,8 +4889,9 @@ const ( ) // Values returns all known values for ProcessingS3UploadMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProcessingS3UploadMode) Values() []ProcessingS3UploadMode { return []ProcessingS3UploadMode{ "Continuous", @@ -4727,8 +4908,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -4750,8 +4932,9 @@ const ( // Values returns all known values for ProductionVariantAcceleratorType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductionVariantAcceleratorType) Values() []ProductionVariantAcceleratorType { return []ProductionVariantAcceleratorType{ "ml.eia1.medium", @@ -4956,8 +5139,9 @@ const ( // Values returns all known values for ProductionVariantInstanceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductionVariantInstanceType) Values() []ProductionVariantInstanceType { return []ProductionVariantInstanceType{ "ml.t2.medium", @@ -5157,8 +5341,9 @@ const ( ) // Values returns all known values for ProfilingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfilingStatus) Values() []ProfilingStatus { return []ProfilingStatus{ "Enabled", @@ -5175,8 +5360,9 @@ const ( ) // Values returns all known values for ProjectSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectSortBy) Values() []ProjectSortBy { return []ProjectSortBy{ "Name", @@ -5193,8 +5379,9 @@ const ( ) // Values returns all known values for ProjectSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectSortOrder) Values() []ProjectSortOrder { return []ProjectSortOrder{ "Ascending", @@ -5219,8 +5406,9 @@ const ( ) // Values returns all known values for ProjectStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProjectStatus) Values() []ProjectStatus { return []ProjectStatus{ "Pending", @@ -5251,8 +5439,9 @@ const ( ) // Values returns all known values for RecommendationJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationJobStatus) Values() []RecommendationJobStatus { return []RecommendationJobStatus{ "PENDING", @@ -5276,8 +5465,9 @@ const ( // Values returns all known values for RecommendationJobSupportedEndpointType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationJobSupportedEndpointType) Values() []RecommendationJobSupportedEndpointType { return []RecommendationJobSupportedEndpointType{ "RealTime", @@ -5294,8 +5484,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Default", @@ -5314,8 +5505,9 @@ const ( ) // Values returns all known values for RecommendationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationStatus) Values() []RecommendationStatus { return []RecommendationStatus{ "IN_PROGRESS", @@ -5333,8 +5525,9 @@ const ( ) // Values returns all known values for RecommendationStepType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationStepType) Values() []RecommendationStepType { return []RecommendationStepType{ "BENCHMARK", @@ -5350,8 +5543,9 @@ const ( ) // Values returns all known values for RecordWrapper. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordWrapper) Values() []RecordWrapper { return []RecordWrapper{ "None", @@ -5372,8 +5566,9 @@ const ( // Values returns all known values for RedshiftResultCompressionType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedshiftResultCompressionType) Values() []RedshiftResultCompressionType { return []RedshiftResultCompressionType{ "None", @@ -5393,8 +5588,9 @@ const ( ) // Values returns all known values for RedshiftResultFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedshiftResultFormat) Values() []RedshiftResultFormat { return []RedshiftResultFormat{ "PARQUET", @@ -5411,8 +5607,9 @@ const ( ) // Values returns all known values for RepositoryAccessMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RepositoryAccessMode) Values() []RepositoryAccessMode { return []RepositoryAccessMode{ "Platform", @@ -5428,8 +5625,9 @@ const ( ) // Values returns all known values for ResourceCatalogSortBy. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceCatalogSortBy) Values() []ResourceCatalogSortBy { return []ResourceCatalogSortBy{ "CreationTime", @@ -5446,6 +5644,7 @@ const ( // Values returns all known values for ResourceCatalogSortOrder. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ResourceCatalogSortOrder) Values() []ResourceCatalogSortOrder { return []ResourceCatalogSortOrder{ @@ -5478,8 +5677,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -5511,8 +5711,9 @@ const ( ) // Values returns all known values for RetentionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetentionType) Values() []RetentionType { return []RetentionType{ "Retain", @@ -5529,8 +5730,9 @@ const ( ) // Values returns all known values for RootAccess. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RootAccess) Values() []RootAccess { return []RootAccess{ "Enabled", @@ -5547,8 +5749,9 @@ const ( ) // Values returns all known values for RoutingStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoutingStrategy) Values() []RoutingStrategy { return []RoutingStrategy{ "LEAST_OUTSTANDING_REQUESTS", @@ -5566,8 +5769,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RStudioServerProAccessStatus) Values() []RStudioServerProAccessStatus { return []RStudioServerProAccessStatus{ "ENABLED", @@ -5585,6 +5789,7 @@ const ( // Values returns all known values for RStudioServerProUserGroup. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RStudioServerProUserGroup) Values() []RStudioServerProUserGroup { return []RStudioServerProUserGroup{ @@ -5606,8 +5811,9 @@ const ( ) // Values returns all known values for RuleEvaluationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleEvaluationStatus) Values() []RuleEvaluationStatus { return []RuleEvaluationStatus{ "InProgress", @@ -5628,8 +5834,9 @@ const ( ) // Values returns all known values for S3DataDistribution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3DataDistribution) Values() []S3DataDistribution { return []S3DataDistribution{ "FullyReplicated", @@ -5647,8 +5854,9 @@ const ( ) // Values returns all known values for S3DataType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3DataType) Values() []S3DataType { return []S3DataType{ "ManifestFile", @@ -5666,8 +5874,9 @@ const ( ) // Values returns all known values for S3ModelDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3ModelDataType) Values() []S3ModelDataType { return []S3ModelDataType{ "S3Prefix", @@ -5685,8 +5894,9 @@ const ( // Values returns all known values for SagemakerServicecatalogStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SagemakerServicecatalogStatus) Values() []SagemakerServicecatalogStatus { return []SagemakerServicecatalogStatus{ "Enabled", @@ -5705,8 +5915,9 @@ const ( ) // Values returns all known values for ScheduleStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleStatus) Values() []ScheduleStatus { return []ScheduleStatus{ "Pending", @@ -5725,8 +5936,9 @@ const ( ) // Values returns all known values for SearchSortOrder. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchSortOrder) Values() []SearchSortOrder { return []SearchSortOrder{ "Ascending", @@ -5758,8 +5970,9 @@ const ( ) // Values returns all known values for SecondaryStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecondaryStatus) Values() []SecondaryStatus { return []SecondaryStatus{ "Starting", @@ -5791,8 +6004,9 @@ const ( ) // Values returns all known values for SharingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SharingType) Values() []SharingType { return []SharingType{ "Private", @@ -5809,8 +6023,9 @@ const ( ) // Values returns all known values for SkipModelValidation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SkipModelValidation) Values() []SkipModelValidation { return []SkipModelValidation{ "All", @@ -5827,8 +6042,9 @@ const ( ) // Values returns all known values for SortActionsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortActionsBy) Values() []SortActionsBy { return []SortActionsBy{ "Name", @@ -5844,8 +6060,9 @@ const ( ) // Values returns all known values for SortArtifactsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortArtifactsBy) Values() []SortArtifactsBy { return []SortArtifactsBy{ "CreationTime", @@ -5864,8 +6081,9 @@ const ( ) // Values returns all known values for SortAssociationsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortAssociationsBy) Values() []SortAssociationsBy { return []SortAssociationsBy{ "SourceArn", @@ -5886,8 +6104,9 @@ const ( ) // Values returns all known values for SortBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortBy) Values() []SortBy { return []SortBy{ "Name", @@ -5905,8 +6124,9 @@ const ( ) // Values returns all known values for SortContextsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortContextsBy) Values() []SortContextsBy { return []SortContextsBy{ "Name", @@ -5923,8 +6143,9 @@ const ( ) // Values returns all known values for SortExperimentsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortExperimentsBy) Values() []SortExperimentsBy { return []SortExperimentsBy{ "Name", @@ -5943,6 +6164,7 @@ const ( // Values returns all known values for SortInferenceExperimentsBy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SortInferenceExperimentsBy) Values() []SortInferenceExperimentsBy { return []SortInferenceExperimentsBy{ @@ -5961,8 +6183,9 @@ const ( ) // Values returns all known values for SortLineageGroupsBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortLineageGroupsBy) Values() []SortLineageGroupsBy { return []SortLineageGroupsBy{ "Name", @@ -5979,8 +6202,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -5998,6 +6222,7 @@ const ( // 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{ @@ -6015,8 +6240,9 @@ const ( ) // Values returns all known values for SortPipelinesBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortPipelinesBy) Values() []SortPipelinesBy { return []SortPipelinesBy{ "Name", @@ -6033,8 +6259,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Name", @@ -6051,8 +6278,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -6069,8 +6297,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -6092,8 +6321,9 @@ const ( ) // Values returns all known values for SpaceStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpaceStatus) Values() []SpaceStatus { return []SpaceStatus{ "Deleting", @@ -6117,8 +6347,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -6143,8 +6374,9 @@ const ( ) // Values returns all known values for StageStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StageStatus) Values() []StageStatus { return []StageStatus{ "CREATING", @@ -6170,8 +6402,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -6195,8 +6428,9 @@ const ( ) // Values returns all known values for StepStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepStatus) Values() []StepStatus { return []StepStatus{ "Starting", @@ -6217,8 +6451,9 @@ const ( ) // Values returns all known values for StorageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageType) Values() []StorageType { return []StorageType{ "Standard", @@ -6238,8 +6473,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioLifecycleConfigAppType) Values() []StudioLifecycleConfigAppType { return []StudioLifecycleConfigAppType{ "JupyterServer", @@ -6260,8 +6496,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioLifecycleConfigSortKey) Values() []StudioLifecycleConfigSortKey { return []StudioLifecycleConfigSortKey{ "CreationTime", @@ -6279,8 +6516,9 @@ const ( ) // Values returns all known values for StudioWebPortal. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StudioWebPortal) Values() []StudioWebPortal { return []StudioWebPortal{ "ENABLED", @@ -6298,8 +6536,9 @@ const ( ) // Values returns all known values for TableFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableFormat) Values() []TableFormat { return []TableFormat{ "Default", @@ -6352,8 +6591,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -6408,6 +6648,7 @@ const ( // Values returns all known values for TargetPlatformAccelerator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TargetPlatformAccelerator) Values() []TargetPlatformAccelerator { return []TargetPlatformAccelerator{ @@ -6430,8 +6671,9 @@ const ( ) // Values returns all known values for TargetPlatformArch. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetPlatformArch) Values() []TargetPlatformArch { return []TargetPlatformArch{ "X86_64", @@ -6451,8 +6693,9 @@ const ( ) // Values returns all known values for TargetPlatformOs. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetPlatformOs) Values() []TargetPlatformOs { return []TargetPlatformOs{ "ANDROID", @@ -6469,8 +6712,9 @@ const ( ) // Values returns all known values for ThroughputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThroughputMode) Values() []ThroughputMode { return []ThroughputMode{ "OnDemand", @@ -6489,6 +6733,7 @@ const ( // 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{ @@ -6507,8 +6752,9 @@ const ( ) // Values returns all known values for TrafficType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrafficType) Values() []TrafficType { return []TrafficType{ "PHASES", @@ -6526,8 +6772,9 @@ const ( ) // Values returns all known values for TrainingInputMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingInputMode) Values() []TrainingInputMode { return []TrainingInputMode{ "Pipe", @@ -6612,8 +6859,9 @@ const ( ) // Values returns all known values for TrainingInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingInstanceType) Values() []TrainingInstanceType { return []TrainingInstanceType{ "ml.m4.xlarge", @@ -6698,8 +6946,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingJobEarlyStoppingType) Values() []TrainingJobEarlyStoppingType { return []TrainingJobEarlyStoppingType{ "Off", @@ -6719,6 +6968,7 @@ const ( // 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{ @@ -6741,8 +6991,9 @@ const ( ) // Values returns all known values for TrainingJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingJobStatus) Values() []TrainingJobStatus { return []TrainingJobStatus{ "InProgress", @@ -6763,8 +7014,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrainingRepositoryAccessMode) Values() []TrainingRepositoryAccessMode { return []TrainingRepositoryAccessMode{ "Platform", @@ -6873,8 +7125,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ml.m4.xlarge", @@ -6986,8 +7239,9 @@ const ( ) // Values returns all known values for TransformJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransformJobStatus) Values() []TransformJobStatus { return []TransformJobStatus{ "InProgress", @@ -7011,6 +7265,7 @@ const ( // Values returns all known values for TrialComponentPrimaryStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TrialComponentPrimaryStatus) Values() []TrialComponentPrimaryStatus { return []TrialComponentPrimaryStatus{ @@ -7034,8 +7289,9 @@ const ( ) // Values returns all known values for TtlDurationUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TtlDurationUnit) Values() []TtlDurationUnit { return []TtlDurationUnit{ "Seconds", @@ -7055,8 +7311,9 @@ const ( ) // Values returns all known values for UserProfileSortKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserProfileSortKey) Values() []UserProfileSortKey { return []UserProfileSortKey{ "CreationTime", @@ -7078,8 +7335,9 @@ const ( ) // Values returns all known values for UserProfileStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserProfileStatus) Values() []UserProfileStatus { return []UserProfileStatus{ "Deleting", @@ -7102,8 +7360,9 @@ const ( ) // Values returns all known values for VariantPropertyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VariantPropertyType) Values() []VariantPropertyType { return []VariantPropertyType{ "DesiredInstanceCount", @@ -7124,8 +7383,9 @@ const ( ) // Values returns all known values for VariantStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VariantStatus) Values() []VariantStatus { return []VariantStatus{ "Creating", @@ -7147,8 +7407,9 @@ const ( ) // Values returns all known values for VendorGuidance. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VendorGuidance) Values() []VendorGuidance { return []VendorGuidance{ "NOT_PROVIDED", @@ -7169,8 +7430,9 @@ const ( ) // Values returns all known values for WarmPoolResourceStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WarmPoolResourceStatus) Values() []WarmPoolResourceStatus { return []WarmPoolResourceStatus{ "Available", @@ -7192,8 +7454,9 @@ const ( ) // Values returns all known values for WorkforceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkforceStatus) Values() []WorkforceStatus { return []WorkforceStatus{ "Initializing", diff --git a/service/sagemaker/types/errors.go b/service/sagemaker/types/errors.go index f7941d2b6b2..8142d2f6bb2 100644 --- a/service/sagemaker/types/errors.go +++ b/service/sagemaker/types/errors.go @@ -60,7 +60,8 @@ func (e *ResourceInUse) ErrorCode() string { } func (e *ResourceInUse) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// You have exceeded an SageMaker resource limit. For example, you might have too +// You have exceeded an SageMaker resource limit. For example, you might have too +// // many training jobs created. type ResourceLimitExceeded struct { Message *string diff --git a/service/sagemaker/types/types.go b/service/sagemaker/types/types.go index 188f50aa89e..6bf9f1b6a95 100644 --- a/service/sagemaker/types/types.go +++ b/service/sagemaker/types/types.go @@ -138,73 +138,105 @@ type Alarm struct { noSmithyDocumentSerde } -// Specifies the training algorithm to use in a CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) -// 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]. For +// information about using your own algorithms, see [Using Your Own Algorithms with Amazon SageMaker]. +// +// [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html +// [Using Your Own Algorithms with Amazon SageMaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html +// [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.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 + // input modes, see [Algorithms]. + // + // 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. + // 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. + // + // [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html // // This member is required. TrainingInputMode TrainingInputMode // The name of the algorithm resource to use for the training job. This must be an // algorithm resource that you created or subscribe to on Amazon Web Services - // 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 + // 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 + // 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) - // for additional information. + // The arguments for a container used to run a training job. See [How Amazon SageMaker Runs Your Training Image] for additional + // information. + // + // [How Amazon SageMaker Runs Your Training Image]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html 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) - // for more information. + // The [entrypoint script for a Docker container] used to run a training job. This script takes precedence over the default + // train processing instructions. See [How Amazon SageMaker Runs Your Training Image]for more information. + // + // [entrypoint script for a Docker container]: https://docs.docker.com/engine/reference/builder/ + // [How Amazon SageMaker Runs Your Training Image]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo-dockerfile.html ContainerEntrypoint []string // 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) - // : + // + // - You use one of the following [Prebuilt SageMaker Docker Images]: + // // - Tensorflow (version >= 1.15) + // // - MXNet (version >= 1.6) + // // - PyTorch (version >= 1.3) - // - You specify at least one MetricDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html) + // + // - You specify at least one [MetricDefinition] + // + // [MetricDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html + // [Prebuilt SageMaker Docker Images]: https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html EnableSageMakerMetricsTimeSeries *bool // A list of metric definition objects. Each object specifies the metric name and @@ -213,15 +245,18 @@ type AlgorithmSpecification struct { MetricDefinitions []MetricDefinition // 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) + // information about docker registry paths for SageMaker built-in algorithms, see [Docker Registry Paths and Example Code] // 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. + // For more information about using your custom training container, see [Using Your Own Algorithms with Amazon SageMaker]. + // + // 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. + // + // [Using Your Own Algorithms with Amazon SageMaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html + // [Docker Registry Paths and Example Code]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html TrainingImage *string // The configuration to use an image from a private Docker registry for a training @@ -292,8 +327,10 @@ type AlgorithmSummary struct { } // 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. +// 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 @@ -338,498 +375,790 @@ type AlgorithmValidationSpecification struct { // 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) - // 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. + // The Amazon Resource Name (ARN) of a Lambda function implements the logic for [annotation consolidation] + // and to process output data. + // + // This parameter is required for all labeling jobs. For [built-in task types], use one of the + // following Amazon SageMaker Ground Truth Lambda function ARNs for + // AnnotationConsolidationLambdaArn . For custom labeling workflows, see [Post-annotation Lambda]. + // + // 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 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 // 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 // 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 - // 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 + // + // 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]. + // + // 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 // + // [built-in task types]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html + // [annotation consolidation]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html + // [Post-annotation Lambda]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-postlambda + // [Verify and Adjust Labels]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html + // // This member is required. AnnotationConsolidationLambdaArn *string @@ -1038,9 +1367,10 @@ type AsyncInferenceNotificationConfig struct { // provided, no notification is sent on failure. ErrorTopic *string - // The Amazon SNS topics where you want the inference response to be included. The - // inference response is included only if the response size is less than or equal - // to 128 KB. + // The Amazon SNS topics where you want the inference response to be included. + // + // The inference response is included only if the response size is less than or + // equal to 128 KB. IncludeInferenceResponseIn []AsyncNotificationTopicTypes // Amazon SNS topic to post a notification to when inference completes @@ -1117,23 +1447,39 @@ type AthenaDatasetDefinition struct { 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. + // an Autopilot job. + // + // Selected algorithms must belong to the list corresponding to the training mode + // set in [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" // + // [AutoMLJobConfig.Mode]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html#sagemaker-Type-AutoMLJobConfig-Mode + // // This member is required. AutoMLAlgorithms []AutoMLAlgorithm @@ -1203,38 +1549,61 @@ type AutoMLCandidate struct { 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) - // . + // train the model candidates. + // + // The list of available algorithms to choose from depends on the training mode + // set in [AutoMLJobConfig.Mode]AutoMLJobConfig.Mode . + // // - 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. + // 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. + // + // For the list of all algorithms per training mode, see [AutoMLAlgorithmConfig]. + // + // For more information on each algorithm, see the [Algorithm support] section in Autopilot developer + // guide. + // + // [AutoMLJobConfig.Mode]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html + // [Algorithm support]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support + // [AutoMLAlgorithmConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html 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 - // 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. + // (optional) in JSON format as shown below: + // + // { "FeatureAttributeNames":["col1", "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. FeatureSpecificationS3Uri *string noSmithyDocumentSerde @@ -1263,8 +1632,11 @@ 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]. +// +// A validation dataset must contain the same headers as the training dataset. +// +// [Channel]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html type AutoMLChannel struct { // The name of the target variable in supervised learning, usually represented by @@ -1276,8 +1648,9 @@ type AutoMLChannel struct { // 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) - // . + // channel types, see [How to specify training and validation datasets]. + // + // [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 . @@ -1294,39 +1667,45 @@ type AutoMLChannel struct { // If specified, this column name indicates which column of the dataset should be // treated as sample weights for use by the objective metric during the training, // evaluation, and the selection of the best model. This column is not considered - // as a predictive feature. For more information on Autopilot metrics, see Metrics - // and validation (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html) - // . Sample weights should be numeric, non-negative, with larger values indicating + // as a predictive feature. For more information on Autopilot metrics, see [Metrics and validation]. + // + // Sample weights should be numeric, non-negative, with larger values indicating // which rows are more important than others. Data points that have invalid or no - // weight value are excluded. Support for sample weights is available in Ensembling (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html) - // mode only. + // weight value are excluded. + // + // Support for sample weights is available in [Ensembling] mode only. + // + // [Ensembling]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html + // [Metrics and validation]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html SampleWeightAttributeName *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) -// . +// make up an AutoML candidate. For more information, see [ContainerDefinition]. +// +// [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]. + // + // [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) - // . + // The location of the model artifacts. For more information, see [ContainerDefinition]. + // + // [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) - // . + // The environment variables to set in the container. For more information, see [ContainerDefinition]. + // + // [ContainerDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContainerDefinition.html Environment map[string]string noSmithyDocumentSerde @@ -1344,9 +1723,11 @@ type AutoMLDataSource struct { } // This structure specifies how to split the data into train and validation -// datasets. The validation and training datasets must contain the same headers. -// For jobs created by calling CreateAutoMLJob , the validation dataset must be -// less than 2 GB in size. +// datasets. +// +// The validation and training datasets must contain the same headers. For jobs +// created by calling CreateAutoMLJob , the validation dataset must be less than 2 +// GB in size. type AutoMLDataSplitConfig struct { // The validation fraction (optional) is a float that specifies the portion of the @@ -1371,14 +1752,17 @@ type AutoMLJobArtifacts struct { } // A channel is a named input source that training algorithms can consume. This -// channel is used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) -// ). +// channel is used for AutoML jobs V2 (jobs created by calling [CreateAutoMLJobV2]). +// +// [CreateAutoMLJobV2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.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 - // must share the same ContentType The type of channel defaults to training for - // the time-series forecasting problem type. + // must share the same ContentType + // + // The type of channel defaults to training for the time-series forecasting + // problem type. ChannelType AutoMLChannelType // The allowed compression types depend on the input format and problem type. We @@ -1389,17 +1773,22 @@ type AutoMLJobChannel struct { // The content type of the data from the input source. The following are the // allowed content types for different problems: + // // - For tabular problem types: text/csv;header=present or // x-application/vnd.amazon+parquet . The default value is // text/csv;header=present . + // // - For image classification: image/png , image/jpeg , or image/* . The default // value is image/* . + // // - For text classification: text/csv;header=present or // x-application/vnd.amazon+parquet . The default value is // text/csv;header=present . + // // - For time-series forecasting: text/csv;header=present or // x-application/vnd.amazon+parquet . The default value is // text/csv;header=present . + // // - For text generation (LLMs fine-tuning): text/csv;header=present or // x-application/vnd.amazon+parquet . The default value is // text/csv;header=present . @@ -1415,27 +1804,34 @@ 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 text and - // image classification, time-series forecasting, as well as text generation (LLMs - // fine-tuning) problem types, the supported value is 1. For tabular problem types, - // the maximum value is 750. + // The maximum number of times a training job is allowed to run. + // + // For text and image classification, time-series forecasting, as well as text + // generation (LLMs fine-tuning) problem types, the supported value is 1. For + // tabular problem types, the maximum value is 750. 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 job V2s (jobs created by calling CreateAutoMLJobV2 ), this field - // controls the runtime of the job candidate. For TextGenerationJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html) - // problem types, the maximum time defaults to 72 hours (259200 seconds). + // For more information, see the [StoppingCondition]used by the [CreateHyperParameterTuningJob] action. + // + // For job V2s (jobs created by calling CreateAutoMLJobV2 ), this field controls + // the runtime of the job candidate. + // + // For [TextGenerationJobConfig] problem types, the maximum time defaults to 72 hours (259200 seconds). + // + // [CreateHyperParameterTuningJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html + // [StoppingCondition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html + // [TextGenerationJobConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html MaxRuntimePerTrainingJobInSeconds *int32 noSmithyDocumentSerde @@ -1451,26 +1847,31 @@ type AutoMLJobConfig struct { // allowed to generate. CompletionCriteria *AutoMLJobCompletionCriteria - // The configuration for splitting the input training dataset. Type: - // AutoMLDataSplitConfig + // The configuration for splitting the input training dataset. + // + // Type: AutoMLDataSplitConfig DataSplitConfig *AutoMLDataSplitConfig // 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-support) - // 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-support) - // for a list of algorithms supported by HYPERPARAMETER_TUNING mode. + // 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] + // 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]for a list of algorithms supported by + // HYPERPARAMETER_TUNING mode. + // + // [Autopilot algorithm support]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support Mode AutoMLMode // The security configuration for traffic encryption or Amazon VPC settings. @@ -1485,33 +1886,50 @@ type AutoMLJobObjective struct { // The name of the objective metric used to measure the predictive quality of a // machine learning system. During training, the model's parameters are updated // iteratively to optimize its performance based on the feedback provided by the - // objective metric when evaluating the model on the validation dataset. The list - // of available metrics supported by Autopilot and the default metric applied when - // you do not specify a metric name explicitly depend on the problem type. + // objective metric when evaluating the model on the validation dataset. + // + // The list of available metrics supported by Autopilot and the default metric + // applied when you do not specify a metric name explicitly depend on the problem + // type. + // // - For tabular problem types: + // // - List of available metrics: + // // - Regression: MAE , MSE , R2 , RMSE + // // - Binary classification: Accuracy , AUC , BalancedAccuracy , F1 , Precision , // Recall + // // - Multiclass classification: Accuracy , BalancedAccuracy , F1macro , - // PrecisionMacro , RecallMacro For a description of each metric, see Autopilot - // metrics for classification and regression (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html#autopilot-metrics) - // . + // PrecisionMacro , RecallMacro + // + // For a description of each metric, see [Autopilot metrics for classification and regression]. + // // - Default objective metrics: + // // - Regression: MSE . + // // - Binary classification: F1 . + // // - Multiclass classification: Accuracy . + // // - For image or text classification problem types: - // - List of available metrics: Accuracy For a description of each metric, see - // Autopilot metrics for text and image classification (https://docs.aws.amazon.com/sagemaker/latest/dg/text-classification-data-format-and-metric.html) - // . + // + // - List of available metrics: Accuracy + // + // For a description of each metric, see [Autopilot metrics for text and image classification]. + // // - Default objective metrics: Accuracy + // // - For time-series forecasting problem types: - // - List of available metrics: RMSE , wQL , Average wQL , MASE , MAPE , WAPE For - // a description of each metric, see Autopilot metrics for time-series - // forecasting (https://docs.aws.amazon.com/sagemaker/latest/dg/timeseries-objective-metric.html) - // . + // + // - List of available metrics: RMSE , wQL , Average wQL , MASE , MAPE , WAPE + // + // For a description of each metric, see [Autopilot metrics for time-series forecasting]. + // // - Default objective metrics: AverageWeightedQuantileLoss + // // - For text generation problem types (LLMs fine-tuning): Fine-tuning language // models in Autopilot does not require setting the AutoMLJobObjective field. // Autopilot fine-tunes LLMs without requiring multiple candidates to be trained @@ -1519,8 +1937,12 @@ type AutoMLJobObjective struct { // target model to enhance a default objective metric, the cross-entropy loss. // After fine-tuning a language model, you can evaluate the quality of its // generated text using different metrics. For a list of the available metrics, see - // Metrics for fine-tuning LLMs in Autopilot (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html) - // . + // [Metrics for fine-tuning LLMs in Autopilot]. + // + // [Metrics for fine-tuning LLMs in Autopilot]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html + // [Autopilot metrics for time-series forecasting]: https://docs.aws.amazon.com/sagemaker/latest/dg/timeseries-objective-metric.html + // [Autopilot metrics for classification and regression]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html#autopilot-metrics + // [Autopilot metrics for text and image classification]: https://docs.aws.amazon.com/sagemaker/latest/dg/text-classification-data-format-and-metric.html // // This member is required. MetricName AutoMLMetricEnum @@ -1650,10 +2072,13 @@ type AutoMLProblemTypeConfigMemberTextClassificationJobConfig struct { func (*AutoMLProblemTypeConfigMemberTextClassificationJobConfig) isAutoMLProblemTypeConfig() {} // Settings used to configure an AutoML job V2 for the text generation (LLMs -// fine-tuning) problem type. The text generation models that support fine-tuning -// in Autopilot are currently accessible exclusively in regions supported by -// Canvas. Refer to the documentation of Canvas for the full list of its supported -// Regions (https://docs.aws.amazon.com/sagemaker/latest/dg/canvas.html) . +// fine-tuning) problem type. +// +// The text generation models that support fine-tuning in Autopilot are currently +// accessible exclusively in regions supported by Canvas. Refer to the +// documentation of Canvas for the [full list of its supported Regions]. +// +// [full list of its supported Regions]: https://docs.aws.amazon.com/sagemaker/latest/dg/canvas.html type AutoMLProblemTypeConfigMemberTextGenerationJobConfig struct { Value TextGenerationJobConfig @@ -1722,27 +2147,42 @@ type AutoMLResolvedAttributes struct { 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 + // 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" ] + // 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) - // . + // 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]. + // + // [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 @@ -1803,24 +2243,37 @@ type AutoRollbackConfig struct { // A flag to indicate if you want to use Autotune to automatically find optimal // values for the following fields: -// - ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges) -// : The names and ranges of parameters that a hyperparameter tuning job can +// +// [ParameterRanges] +// - : The names and ranges of parameters that a hyperparameter tuning job can // optimize. -// - ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html) -// : The maximum resources that can be used for a training job. These resources -// include the maximum number of training jobs, the maximum runtime of a tuning -// job, and the maximum number of training jobs to run at the same time. -// - TrainingJobEarlyStoppingType (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType) -// : A flag that specifies whether or not to use early stopping for training jobs -// launched by a hyperparameter tuning job. -// - RetryStrategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy) -// : The number of times to retry a training job. -// - Strategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) -// : Specifies how hyperparameter tuning chooses the combinations of hyperparameter -// values to use for the training jobs that it launches. -// - ConvergenceDetected (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html) -// : A flag to indicate that Automatic model tuning (AMT) has detected model +// +// [ResourceLimits] +// - : The maximum resources that can be used for a training job. These +// resources include the maximum number of training jobs, the maximum runtime of a +// tuning job, and the maximum number of training jobs to run at the same time. +// +// [TrainingJobEarlyStoppingType] +// - : A flag that specifies whether or not to use early stopping for training +// jobs launched by a hyperparameter tuning job. +// +// [RetryStrategy] +// - : The number of times to retry a training job. +// +// [Strategy] +// - : Specifies how hyperparameter tuning chooses the combinations of +// hyperparameter values to use for the training jobs that it launches. +// +// [ConvergenceDetected] +// - : A flag to indicate that Automatic model tuning (AMT) has detected model // convergence. +// +// [TrainingJobEarlyStoppingType]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType +// [ConvergenceDetected]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html +// [ResourceLimits]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html +// [Strategy]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html +// [ParameterRanges]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges +// [RetryStrategy]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy type Autotune struct { // Set Mode to Enabled if you want to use Autotune. @@ -1845,12 +2298,17 @@ type BatchDataCaptureConfig 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 the ML - // compute instance that hosts the batch transform job. The KmsKeyId can be any of - // the following formats: + // 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 KmsKeyId *string @@ -1933,9 +2391,9 @@ type BatchTransformInput struct { LocalPath *string // If specified, monitoring jobs subtract 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) - // . + // information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs]. + // + // [Schedule 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 to exclude from the analysis. @@ -1964,9 +2422,9 @@ type BatchTransformInput struct { 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) - // . + // information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs]. + // + // [Schedule Model Quality Monitoring Jobs]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html StartTimeOffset *string noSmithyDocumentSerde @@ -2076,20 +2534,31 @@ type CandidateArtifactLocations struct { type CandidateGenerationConfig struct { // Stores the configuration information for the selection of algorithms used to - // train model candidates on tabular data. The list of available algorithms to - // choose from depends on the training mode set in TabularJobConfig.Mode (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TabularJobConfig.html) - // . + // train model candidates on tabular data. + // + // The list of available algorithms to choose from depends on the training mode + // set in [TabularJobConfig.Mode]TabularJobConfig.Mode . + // // - 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, CandidateGenerationConfig uses the full set of - // algorithms for the given training mode. + // set and one only. + // + // If the list of algorithms provided as values for AutoMLAlgorithms is empty, + // CandidateGenerationConfig uses the full set of algorithms for the given + // training mode. + // // - When AlgorithmsConfig is not provided, CandidateGenerationConfig uses the // full set of algorithms for the given training mode. - // For the list of all algorithms per problem type and 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. + // + // For the list of all algorithms per problem type and training mode, see [AutoMLAlgorithmConfig]. + // + // For more information on each algorithm, see the [Algorithm support] section in Autopilot developer + // guide. + // + // [TabularJobConfig.Mode]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TabularJobConfig.html + // [Algorithm support]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support + // [AutoMLAlgorithmConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html AlgorithmsConfig []AutoMLAlgorithmConfig noSmithyDocumentSerde @@ -2137,13 +2606,17 @@ type CanvasAppSettings struct { // Specifies the type and size of the endpoint capacity to activate for a // blue/green deployment, a rolling deployment, or a rollback strategy. You can // specify your batches as either instance count or the overall percentage or your -// fleet. For a rollback strategy, if you don't specify the fields in this object, -// or if you set the Value to 100%, then SageMaker uses a blue/green rollback -// strategy and rolls all traffic back to the blue fleet. +// fleet. +// +// For a rollback strategy, if you don't specify the fields in this object, or if +// you set the Value to 100%, then SageMaker uses a blue/green rollback strategy +// and rolls all traffic back to the blue fleet. 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. // @@ -2253,21 +2726,26 @@ type Channel struct { // (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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html) - // 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 + // 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. + // Amazon S3 to the container, choose Pipe input mode. + // + // To use a model for incremental training, choose File input model. + // + // [AlgorithmSpecification]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html 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]. + // + // 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 RecordWrapperType RecordWrapper // A configuration for a shuffle option for input data in a channel. If you use @@ -2275,13 +2753,14 @@ type Channel struct { // 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 - // that the content sent to a particular node on the first epoch might be sent to a - // different node on the second epoch. + // 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 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 noSmithyDocumentSerde @@ -2300,11 +2779,14 @@ type ChannelSpecification struct { // This member is required. SupportedContentTypes []string - // The allowed input mode, either FILE or PIPE. In FILE 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. + // The allowed input mode, either FILE or PIPE. + // + // In FILE 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. // // This member is required. SupportedInputModes []TrainingInputMode @@ -2339,8 +2821,9 @@ type CheckpointConfig struct { } // 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) -// in the Amazon SageMaker Developer Guide. +// see the topic on [ClarifyCheck step]in the Amazon SageMaker Developer Guide. +// +// [ClarifyCheck step]: https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check type ClarifyCheckStepMetadata struct { // The Amazon S3 URI of baseline constraints file to be used for the drift check. @@ -2386,8 +2869,10 @@ 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]EnableExplanations for additional + // information. + // + // [EnableExplanations]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable EnableExplanations *string // The inference configuration parameter for the model container. @@ -2407,17 +2892,20 @@ type ClarifyInferenceConfig struct { 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 payload to help readability of the InvokeEndpoint output. See the [Response] // section under Invoke the endpoint in the Developer Guide for more information. + // + // [Response]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response 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 // 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) - // section under Invoke the endpoint in the Developer Guide for more information. + // the endpoint response payload. For additional information see the [response]section under + // Invoke the endpoint in the Developer Guide for more information. + // + // [response]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response FeatureTypes []ClarifyFeatureType // Provides the JMESPath expression to extract the features from a model container @@ -2427,7 +2915,9 @@ type ClarifyInferenceConfig struct { 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 + // 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 // LabelAttribute to 'labels' to extract the list of label headers // ["cat","dog","fish"] @@ -2435,16 +2925,19 @@ 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) + // are used to help readability for the output of the InvokeEndpoint API. See the [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. + // + // [response]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response LabelHeaders []string // 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: + // 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'] . LabelIndex *int32 @@ -2454,18 +2947,21 @@ 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 - // request according to the model container's capacity at runtime. + // when querying the model container for the predictions of a [synthetic dataset]. 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. + // + // [synthetic dataset]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic 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 + // 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' . ProbabilityAttribute *string @@ -2473,11 +2969,13 @@ type ClarifyInferenceConfig struct { // 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 - // multiclass model: If the model container output consists of a string-formatted - // prediction label followed by its probability: + // 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] . ProbabilityIndex *int32 @@ -2485,15 +2983,18 @@ type ClarifyInferenceConfig struct { 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 configuration for the [SHAP baseline] (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) -// . +// For more information, see the Synthetic data of [Configure and create an endpoint]. +// // - ShapBaseline and ShapBaselineUri are mutually exclusive parameters. One or // the either is required to configure a SHAP baseline. +// +// [SHAP baseline]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html +// [Configure and create an endpoint]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html type ClarifyShapBaselineConfig struct { // The MIME type of the baseline data. Choose from 'text/csv' or @@ -2520,8 +3021,9 @@ 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]. + // + // [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 @@ -2535,11 +3037,13 @@ type ClarifyShapConfig struct { // This member is required. ShapBaselineConfig *ClarifyShapBaselineConfig - // 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) - // . + // 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]. + // + // [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 @@ -2571,9 +3075,13 @@ type ClarifyTextConfig struct { // 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] or [ISO 639-3] code of a supported + // language. + // + // For a mix of multiple languages, use code 'xx' . + // + // [ISO 639-1]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes + // [ISO 639-3]: https://en.wikipedia.org/wiki/ISO_639-3 // // This member is required. Language ClarifyTextLanguage @@ -2607,9 +3115,10 @@ type ClusterInstanceGroupDetails struct { // The number you specified to TreadsPerCore in CreateCluster for enabling or // disabling multithreading. For instance types that support multithreading, you // can specify 1 for disabling multithreading and 2 for enabling multithreading. - // For more information, see the reference table of CPU cores and threads per CPU - // core per instance type (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html) - // in the Amazon Elastic Compute Cloud User Guide. + // For more information, see the reference table of [CPU cores and threads per CPU core per instance type]in the Amazon Elastic Compute + // Cloud User Guide. + // + // [CPU cores and threads per CPU core per instance type]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html ThreadsPerCore *int32 noSmithyDocumentSerde @@ -2647,9 +3156,10 @@ type ClusterInstanceGroupSpecification struct { // Specifies the value for Threads per core. For instance types that support // multithreading, you can specify 1 for disabling multithreading and 2 for // enabling multithreading. For instance types that doesn't support multithreading, - // specify 1 . For more information, see the reference table of CPU cores and - // threads per CPU core per instance type (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html) - // in the Amazon Elastic Compute Cloud User Guide. + // specify 1 . For more information, see the reference table of [CPU cores and threads per CPU core per instance type] in the Amazon + // Elastic Compute Cloud User Guide. + // + // [CPU cores and threads per CPU core per instance type]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html ThreadsPerCore *int32 noSmithyDocumentSerde @@ -2678,11 +3188,14 @@ type ClusterLifeCycleConfig struct { // This member is required. OnCreate *string - // An Amazon S3 bucket path where your lifecycle scripts are stored. Make sure - // that the S3 bucket path starts with s3://sagemaker- . The IAM role for - // SageMaker HyperPod (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-iam-role-for-hyperpod) - // has the managed AmazonSageMakerClusterInstanceRolePolicy (https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-cluster.html) - // attached, which allows access to S3 buckets with the specific prefix sagemaker- . + // An Amazon S3 bucket path where your lifecycle scripts are stored. + // + // Make sure that the S3 bucket path starts with s3://sagemaker- . The [IAM role for SageMaker HyperPod] has the + // managed [AmazonSageMakerClusterInstanceRolePolicy]AmazonSageMakerClusterInstanceRolePolicy attached, which allows access + // to S3 buckets with the specific prefix sagemaker- . + // + // [AmazonSageMakerClusterInstanceRolePolicy]: https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-cluster.html + // [IAM role for SageMaker HyperPod]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-iam-role-for-hyperpod // // This member is required. SourceS3Uri *string @@ -2789,9 +3302,11 @@ type CodeEditorAppImageConfig struct { noSmithyDocumentSerde } -// The Code Editor application settings. For more information about Code Editor, -// see Get started with Code Editor in Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html) -// . +// The Code Editor application settings. +// +// For more information about Code Editor, see [Get started with Code Editor in Amazon SageMaker]. +// +// [Get started with Code Editor in Amazon SageMaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html type CodeEditorAppSettings struct { // A list of custom SageMaker images that are configured to run as a Code Editor @@ -2853,8 +3368,9 @@ 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]. +// +// [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. @@ -2862,12 +3378,13 @@ 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) - // 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 + // A [user pool] 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 // through SAML identity providers. // + // [user pool]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html + // // This member is required. UserPool *string @@ -2908,6 +3425,7 @@ type CollectionConfig interface { } // Configuration for your vector collection type. +// // - Dimension : The number of elements in your vector. type CollectionConfigMemberVectorConfig struct { Value VectorConfig @@ -3011,24 +3529,27 @@ type ContainerConfig struct { // Describes the container, as part of model definition. type ContainerDefinition struct { - // This parameter is ignored for models that contain only a PrimaryContainer . When - // a ContainerDefinition is part of an inference pipeline, the value of the + // 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. + // metrics. For information, see [Use Logs and Metrics to Monitor an Inference Pipeline]. 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. + // + // [Use Logs and Metrics to Monitor an Inference Pipeline]: https://docs.aws.amazon.com/sagemaker/latest/dg/inference-pipeline-logs-metrics.html ContainerHostname *string - // The environment variables to set in the Docker container. The maximum length of - // each key and value in the Environment map is 1024 bytes. The maximum length of - // all keys and values in the map, combined, is 32 KB. If you pass multiple - // containers to a CreateModel request, then the maximum length of all of their - // maps, combined, is also 32 KB. + // The environment variables to set in the Docker container. + // + // The maximum length of each key and value in the Environment map is 1024 bytes. + // The maximum length of all keys and values in the map, combined, is 32 KB. If you + // pass multiple containers to a CreateModel request, then the maximum length of + // all of their maps, combined, is also 32 KB. Environment map[string]string // The path where inference code is stored. This can be either in Amazon EC2 @@ -3036,20 +3557,24 @@ 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]. + // + // 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. + // + // [Using Your Own Algorithms with Amazon SageMaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html Image *string // 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 + // information about storing containers in a private Docker registry, see [Use a Private Docker Registry for Real-Time Inference Containers]. + // + // 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. + // + // [Use a Private Docker Registry for Real-Time Inference Containers]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html ImageConfig *ImageConfig // The inference specification name in the model package version. @@ -3058,28 +3583,34 @@ type ContainerDefinition struct { // Whether the container hosts a single model or multiple models. Mode ContainerMode - // Specifies the location of ML model data to deploy. Currently you cannot use - // ModelDataSource in conjunction with SageMaker batch transform, SageMaker - // serverless endpoints, SageMaker multi-model endpoints, and SageMaker - // Marketplace. + // Specifies the location of ML model data to deploy. + // + // Currently you cannot use ModelDataSource in conjunction with SageMaker batch + // transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and + // SageMaker Marketplace. ModelDataSource *ModelDataSource // The 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 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 - // 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) - // 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 . + // you use your own algorithms. For more information on built-in algorithms, see [Common Parameters]. + // + // 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]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 . + // + // [Common Parameters]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html + // [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 ModelDataUrl *string // The name or Amazon Resource Name (ARN) of the model package to use to create @@ -3155,17 +3686,27 @@ type ContinuousParameterRange struct { Name *string // 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 - // 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 - // logarithmic scale. Logarithmic scaling works only for ranges that have only - // values greater than 0. ReverseLogarithmic Hyperparameter tuning searches the - // values in the 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]. 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 logarithmic scale. + // + // Logarithmic scaling works only for ranges that have only values greater than 0. + // + // ReverseLogarithmic Hyperparameter tuning searches the values in the + // 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. + // + // [Hyperparameter Scaling]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type ScalingType HyperParameterScalingType noSmithyDocumentSerde @@ -3238,8 +3779,9 @@ type CustomFileSystemConfigMemberEFSFileSystemConfig struct { func (*CustomFileSystemConfigMemberEFSFileSystemConfig) isCustomFileSystemConfig() {} -// A custom SageMaker image. For more information, see Bring your own SageMaker -// image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) . +// A custom SageMaker image. For more information, see [Bring your own SageMaker image]. +// +// [Bring your own SageMaker image]: https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html type CustomImage struct { // The name of the AppImageConfig. @@ -3318,11 +3860,17 @@ type DataCaptureConfig struct { // The Amazon Resource Name (ARN) of an 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: + // 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 KmsKeyId *string @@ -3387,16 +3935,19 @@ type DataCatalogConfig struct { // results in the output. The input filter provided allows you to exclude input // 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) -// . +// predictions in the output from the job. For more information, see [Associate Prediction Results with their Corresponding Input Records]. +// +// [Associate 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) - // 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" + // A [JSONPath] 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" + // + // [JSONPath]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators InputFilter *string // Specifies the source of the data to join with the transformed data. The valid @@ -3404,26 +3955,34 @@ type DataProcessing struct { // 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, - // 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 - // 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) - // . + // 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 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]. + // + // [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) - // 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 - // that aren't within the dimension size of the joined dataset, you get an error. + // A [JSONPath] 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 that aren't within the dimension size of the joined dataset, you get an + // error. + // // Examples: "$" , "$[0,5:]" , "$['id','SageMakerOutput']" + // + // [JSONPath]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators OutputFilter *string noSmithyDocumentSerde @@ -3534,9 +4093,9 @@ 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) -// . +// configure the DebugHookConfig parameter, see [Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job]. +// +// [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 type DebugHookConfig struct { // Path to Amazon S3 storage location for metrics and tensors. @@ -3545,10 +4104,9 @@ 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]. + // + // [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. @@ -3562,10 +4120,9 @@ 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) -// . +// 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]. +// +// [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 type DebugRuleConfiguration struct { // The name of the rule configuration. It must be unique relative to other rule @@ -3677,14 +4234,16 @@ type DefaultSpaceStorageSettings struct { } // Gets the Amazon EC2 Container Registry path of the docker image of the model -// that is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html) -// . 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 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) -// in the Amazon ECR User Guide. +// 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 value that identifies a specific version of an image. For information +// about Amazon ECR paths, see [Pulling an Image]in the Amazon ECR User Guide. +// +// [ProductionVariant]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html +// [Pulling an Image]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html type DeployedImage struct { // The date and time when the image path for the model resolved to the @@ -3723,8 +4282,9 @@ type DeploymentConfig struct { } // A set of recommended deployment configurations for the model. To get more -// advanced recommendations, see CreateInferenceRecommendationsJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html) -// to create an inference recommendation job. +// advanced recommendations, see [CreateInferenceRecommendationsJob]to create an inference recommendation job. +// +// [CreateInferenceRecommendationsJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html type DeploymentRecommendation struct { // Status of the deployment recommendation. The status NOT_APPLICABLE means that @@ -3735,8 +4295,9 @@ type DeploymentRecommendation struct { // This member is required. RecommendationStatus RecommendationStatus - // A list of RealTimeInferenceRecommendation (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_RealTimeInferenceRecommendation.html) - // items. + // A list of [RealTimeInferenceRecommendation] items. + // + // [RealTimeInferenceRecommendation]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_RealTimeInferenceRecommendation.html RealTimeInferenceRecommendations []RealTimeInferenceRecommendation noSmithyDocumentSerde @@ -3981,9 +4542,10 @@ type DeviceSummary struct { noSmithyDocumentSerde } -// The model deployment settings for the SageMaker Canvas application. In order to -// enable model deployment for Canvas, the SageMaker Domain's or user profile's -// Amazon Web Services IAM execution role must have the +// The model deployment settings for the SageMaker Canvas application. +// +// In order to enable model deployment for Canvas, the SageMaker Domain's or user +// profile's Amazon Web Services IAM execution role must have the // AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also turn on // model deployment permissions through the SageMaker Domain's or user profile's // settings in the SageMaker console. @@ -4044,8 +4606,9 @@ type DomainSettings struct { DockerSettings *DockerSettings // 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]. + // + // [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. @@ -4065,9 +4628,10 @@ type DomainSettingsForUpdate struct { DockerSettings *DockerSettings // 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]. This configuration can only be modified if there are no apps in the + // InService or Pending state. + // + // [sts:SourceIdentity key]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html ExecutionRoleIdentityConfig ExecutionRoleIdentityConfig // A collection of RStudioServerPro Domain-level app settings to update. A single @@ -4407,20 +4971,31 @@ 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/) . + // + // - 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]. + // // - 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. + // platform. + // + // Supported architectures Windows include: Windows32_x86, Windows64_x64. + // + // Supported architectures for Linux include: Linux x86_64, Linux ARMV8. + // + // [semantic version specification]: https://semver.org/ PresetDeploymentConfig *string // The deployment type SageMaker Edge Manager will create. Currently only supports @@ -4575,8 +5150,9 @@ 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]. + // + // [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 @@ -4588,9 +5164,10 @@ type Endpoint struct { // variant. 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. + // A list of the tags associated with the endpoint. For more information, see [Tagging Amazon Web Services resources] in + // the Amazon Web Services General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []Tag noSmithyDocumentSerde @@ -4641,9 +5218,9 @@ type EndpointInput struct { LocalPath *string // 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) - // . + // information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs]. + // + // [Schedule 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 to exclude from the analysis. @@ -4672,9 +5249,9 @@ type EndpointInput struct { 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) - // . + // information about using offsets for scheduling monitoring jobs, see [Schedule Model Quality Monitoring Jobs]. + // + // [Schedule Model Quality Monitoring Jobs]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html StartTimeOffset *string noSmithyDocumentSerde @@ -4683,7 +5260,7 @@ type EndpointInput struct { // The endpoint configuration for the load test. type EndpointInputConfiguration struct { - // The parameter you want to benchmark against. + // The parameter you want to benchmark against. EnvironmentParameterRanges *EnvironmentParameterRanges // The inference specification name in the model package version. @@ -4709,13 +5286,14 @@ type EndpointMetadata struct { // The name of the endpoint configuration. EndpointConfigName *string - // The status of the endpoint. For possible values of the status of an endpoint, - // see EndpointSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_EndpointSummary.html) - // . + // The status of the endpoint. For possible values of the status of an endpoint, + // see [EndpointSummary]. + // + // [EndpointSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_EndpointSummary.html EndpointStatus EndpointStatus - // If the status of the endpoint is Failed , or the status is InService but update - // operation fails, this provides the reason why it failed. + // 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 @@ -4785,34 +5363,41 @@ type EndpointSummary struct { EndpointName *string // The status of the endpoint. + // // - OutOfService : Endpoint is not available to take incoming requests. - // - Creating : CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) - // is executing. - // - Updating : UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) - // or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) - // is executing. + // + // - 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) - // call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html) - // operation is called explicitly. + // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) - // is executing. + // + // - Deleting : [DeleteEndpoint]is executing. + // // - Failed : Endpoint could not be created, updated, or re-scaled. Use - // DescribeEndpointOutput$FailureReason for information about the failure. - // DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html) - // is the only operation that can be performed on a failed endpoint. + // 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 StatusEquals filter - // with a call to ListEndpoints (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html) - // . + // with a call to [ListEndpoints]. + // + // [UpdateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html + // [ListEndpoints]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html + // [UpdateEndpointWeightsAndCapacities]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html + // [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html + // [DeleteEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html // // This member is required. EndpointStatus EndpointStatus @@ -4856,8 +5441,9 @@ type EnvironmentParameterRanges struct { noSmithyDocumentSerde } -// The properties of an experiment as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API. +// The properties of an experiment as returned by the [Search] API. +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type Experiment struct { // Who created the experiment. @@ -4889,8 +5475,10 @@ type Experiment struct { // The source of the experiment. Source *ExperimentSource - // The list of tags that are associated with the experiment. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) - // 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. + // + // [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html Tags []Tag noSmithyDocumentSerde @@ -4898,9 +5486,16 @@ type Experiment struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: -// - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) -// - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) -// - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) +// +// [CreateProcessingJob] +// +// [CreateTrainingJob] +// +// [CreateTransformJob] +// +// [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html +// [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html +// [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html type ExperimentConfig struct { // The name of an existing experiment to associate with the trial component. @@ -4935,8 +5530,9 @@ type ExperimentSource struct { } // A summary of the properties of an experiment. To get the complete set of -// properties, call the DescribeExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html) -// API and provide the ExperimentName . +// properties, call the [DescribeExperiment]API and provide the ExperimentName . +// +// [DescribeExperiment]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html type ExperimentSummary struct { // When the experiment was created. @@ -4995,8 +5591,12 @@ type FailStepMetadata struct { 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 name: + // the following: is_deleted , write_time , api_invocation_time . + // + // The name: + // // - Must start with an alphanumeric character. + // // - Can only include alphanumeric characters, underscores, and hyphens. Spaces // are not allowed. // @@ -5013,8 +5613,11 @@ type FeatureDefinition struct { // A grouping of elements where each element within the collection must have the // same feature type ( String , Integral , or Fractional ). + // // - List : An ordered collection of elements. + // // - Set : An unordered collection of unique elements. + // // - Vector : A specialized list that represents a fixed-size array of elements. // The vector dimension is determined by you. Must have elements with fractional // feature types. @@ -5035,8 +5638,9 @@ type FeatureGroup struct { // 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 + // 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 @@ -5047,9 +5651,13 @@ type FeatureGroup struct { FailureReason *string // 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 . + // + // 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 . @@ -5067,10 +5675,13 @@ 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 . @@ -5078,8 +5689,9 @@ type FeatureGroup struct { // 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 . + // 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 @@ -5231,65 +5843,111 @@ 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// 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 +// 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", +// +// "Operator": "GreaterThan", +// +// "Value": "0.9" // -// "accuracy" metric greater than "0.9" : { -// "Name": "Metrics.accuracy", +// } // -// "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 +// "learning_rate" hyperparameter that is less than "0.5" : // -// "Value": "0.9" -// } 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 +// "Name": "HyperParameters.learning_rate", // -// "learning_rate" hyperparameter that is less than "0.5" : { -// "Name": "HyperParameters.learning_rate", +// "Operator": "LessThan", // -// "Operator": "LessThan", +// "Value": "0.5" // -// "Value": "0.5" -// } Tags To define a tag filter, enter a value with the form Tags. . +// } +// +// Tags To define a tag filter, enter a value with the form Tags. . +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type Filter struct { // A resource property name. For example, TrainingJobName . For valid property - // names, see SearchRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html) - // . You must specify a valid property for the resource. + // names, see [SearchRecord]. You must specify a valid property for the resource. + // + // [SearchRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html // // 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. + // 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 . - // 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: + // 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' @@ -5309,8 +5967,9 @@ 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]. + // + // [AutoMLJobObjective$MetricName]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html // // This member is required. MetricName AutoMLMetricEnum @@ -5320,9 +5979,10 @@ type FinalAutoMLJobObjectiveMetric struct { // This member is required. 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) + // The name of the standard metric. For a description of the standard metrics, see [Autopilot candidate 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. @@ -5333,15 +5993,17 @@ type FinalAutoMLJobObjectiveMetric struct { // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html) -// . +// HyperParameterTuningJobObjective parameter of [HyperParameterTuningJobConfig]. +// +// [HyperParameterTuningJobConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html 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) - // . + // are defined per algorithm. See the [metrics for XGBoost]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]. + // + // [metrics for XGBoost]: https://docs.aws.amazon.com/sagemaker/latest/dg/xgboost-tuning.html + // [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 @@ -5362,9 +6024,11 @@ type FinalHyperParameterTuningJobObjectiveMetric struct { 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) - // . + // available. + // + // To learn more about the format of Amazon A2I output data, see [Amazon A2I Output Data]. + // + // [Amazon A2I Output Data]: https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-output-data.html // // This member is required. S3OutputPath *string @@ -5405,10 +6069,12 @@ type FlowDefinitionSummary struct { noSmithyDocumentSerde } -// The generative AI settings for the SageMaker Canvas application. Configure -// these settings for Canvas users starting chats with generative AI foundation -// models. For more information, see Use generative AI with foundation models (https://docs.aws.amazon.com/sagemaker/latest/dg/canvas-fm-chat.html) -// . +// The generative AI settings for the SageMaker Canvas application. +// +// Configure these settings for Canvas users starting chats with generative AI +// foundation models. For more information, see [Use generative AI with foundation models]. +// +// [Use generative AI with foundation models]: https://docs.aws.amazon.com/sagemaker/latest/dg/canvas-fm-chat.html type GenerativeAiSettings struct { // The ARN of an Amazon Web Services IAM role that allows fine-tuning of large @@ -5435,7 +6101,9 @@ type GitConfig 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} + // format: + // + // {"username": UserName, "password": Password} SecretArn *string noSmithyDocumentSerde @@ -5448,7 +6116,9 @@ 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} + // format: + // + // {"username": UserName, "password": Password} SecretArn *string noSmithyDocumentSerde @@ -5459,9 +6129,12 @@ type GitConfigForUpdate struct { // model to identify patterns associated with specific holidays. type HolidayConfigAttributes struct { - // The country code for the holiday calendar. For the list of public holiday - // calendars supported by AutoML job V2, see Country Codes (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-timeseries-forecasting-holiday-calendars.html#holiday-country-codes) - // . Use the country code corresponding to the country of your choice. + // The country code for the holiday calendar. + // + // For the list of public holiday calendars supported by AutoML job V2, see [Country Codes]. Use + // the country code corresponding to the country of your choice. + // + // [Country Codes]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-timeseries-forecasting-holiday-calendars.html#holiday-country-codes CountryCode *string noSmithyDocumentSerde @@ -5579,18 +6252,19 @@ type HubS3StorageConfig struct { noSmithyDocumentSerde } -// Defines under what conditions SageMaker creates a human loop. Used within -// CreateFlowDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFlowDefinition.html) -// . See HumanLoopActivationConditionsConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HumanLoopActivationConditionsConfig.html) +// Defines under what conditions SageMaker creates a human loop. Used within [CreateFlowDefinition]. See [HumanLoopActivationConditionsConfig] // for the required format of activation conditions. +// +// [CreateFlowDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateFlowDefinition.html +// [HumanLoopActivationConditionsConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HumanLoopActivationConditionsConfig.html type HumanLoopActivationConditionsConfig struct { // JSON expressing use-case specific conditions declaratively. If any condition is // 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 the Amazon SageMaker Developer Guide. + // how to structure the JSON, see [JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI]in the Amazon SageMaker Developer Guide. + // + // [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 // // This value conforms to the media type: application/json // @@ -5617,13 +6291,18 @@ type HumanLoopActivationConfig struct { // Describes the work to be performed by human workers. 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) - // . + // 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]. + // + // 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]. + // + // [Create Custom Worker Task Template]: https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html + // [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 @@ -5647,118 +6326,217 @@ type HumanLoopConfig struct { TaskTitle *string // 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) - // . + // of workforces and work teams you can create and use with Amazon A2I, see [Create and Manage Workforces]. + // + // [Create and Manage Workforces]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-management.html // // This member is required. WorkteamArn *string // Defines the amount of money paid to an Amazon Mechanical Turk worker for each - // 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. + // 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 PublicWorkforceTaskPrice *PublicWorkforceTaskPrice @@ -5803,494 +6581,788 @@ type HumanTaskConfig struct { // 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. + // labeling job. + // + // For [built-in task types], use one of the following Amazon SageMaker Ground Truth Lambda function + // ARNs for PreHumanTaskLambdaArn . For custom labeling workflows, see [Pre-annotation Lambda]. + // + // 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. + // + // 3D Point Cloud Modalities + // + // Use the following pre-annotation lambdas for 3D point cloud labeling modality + // tasks. See [3D Point Cloud Task types]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 + // + // 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]. + // + // 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 // + // [built-in task types]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html + // [3D Point Cloud Task types]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-task-types.html + // [Pre-annotation Lambda]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-prelambda + // [Verify and Adjust Labels]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html + // // This member is required. PreHumanTaskLambdaArn *string @@ -6299,17 +7371,24 @@ type HumanTaskConfig struct { // This member is required. TaskDescription *string - // 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. + // 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] the maximum for this parameter depends on + // the task type you use: + // + // - For [image]and [text]labeling jobs, the maximum is 8 hours (28,800 seconds). + // + // - For [3D point cloud]and [video frame]labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL + // mode. For most users, the maximum is also 30 days. + // + // [built-in task type]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html + // [image]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-images.html + // [video frame]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-video.html + // [3D point cloud]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud.html + // [text]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-text.html // // This member is required. TaskTimeLimitInSeconds *int32 @@ -6343,8 +7422,10 @@ 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. TaskAvailabilityLifetimeInSeconds *int32 @@ -6389,23 +7470,29 @@ type HyperbandStrategyConfig struct { // job launched by a hyperparameter tuning job. Once a job reaches the MaxResource // value, it is stopped. If a value for MaxResource is not provided, and Hyperband // is selected as the hyperparameter tuning strategy, HyperbandTraining 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) - // : + // to infer MaxResource from the following keys (if present) in [StaticsHyperParameters]: + // // - 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 distributed (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 - // decision and stop the job prematurely. + // that correspond to an objective metric are used to derive [early stopping decisions]. For [distributed] 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 decision and stop the job + // prematurely. + // + // [StaticsHyperParameters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters + // [early stopping decisions]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html + // [distributed]: https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html MaxResource *int32 // The minimum number of resources (such as epochs) that can be used by a training @@ -6421,27 +7508,43 @@ 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 + // input modes, see [Algorithms]. + // + // 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. + // 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. + // + // [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html // // This member is required. TrainingInputMode TrainingInputMode @@ -6451,17 +7554,18 @@ type HyperParameterAlgorithmSpecification struct { // . AlgorithmName *string - // An array of MetricDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html) - // objects that specify the metrics that the algorithm emits. + // An array of [MetricDefinition] objects that specify the metrics that the algorithm emits. + // + // [MetricDefinition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html 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) - // . + // 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]. + // SageMaker supports both registry/repository[:tag] and + // registry/repository[@digest] image path formats. For more information, see [Using Your Own Algorithms with Amazon SageMaker]. + // + // [Algorithms Provided by Amazon SageMaker: Common Parameters]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html + // [Using Your Own Algorithms with Amazon SageMaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html TrainingImage *string noSmithyDocumentSerde @@ -6503,9 +7607,10 @@ type HyperParameterSpecification struct { // Defines the training jobs launched by a hyperparameter tuning job. type HyperParameterTrainingJobDefinition struct { - // The HyperParameterAlgorithmSpecification (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterAlgorithmSpecification.html) - // object that specifies the resource algorithm to use for the training jobs that - // the tuning job launches. + // The [HyperParameterAlgorithmSpecification] object that specifies the resource algorithm to use for the training jobs + // that the tuning job launches. + // + // [HyperParameterAlgorithmSpecification]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterAlgorithmSpecification.html // // This member is required. AlgorithmSpecification *HyperParameterAlgorithmSpecification @@ -6556,22 +7661,27 @@ 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) - // 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 - // itself. That is, the sum of the number of environment variables for all the - // training job definitions can't exceed the maximum number specified. + // An environment variable that you can pass into the SageMaker [CreateTrainingJob] API. You can use + // an existing [environment variable from the training container]or use your own. See [Define metrics and variables] 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 itself. That is, the sum of the number + // of environment variables for all the training job definitions can't exceed the + // maximum number specified. + // + // [Define metrics and variables]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html + // [environment variable from the training container]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-Environment + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html Environment map[string]string // Specifies ranges of integer, continuous, and categorical hyperparameters that a // hyperparameter tuning job searches. The hyperparameter tuning job launches // 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 + // 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. @@ -6584,19 +7694,23 @@ type HyperParameterTrainingJobDefinition struct { // parameter to additionally store training data in the storage volume (optional). HyperParameterTuningResourceConfig *HyperParameterTuningResourceConfig - // An array of Channel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html) - // objects that specify the input for the training jobs that the tuning job - // launches. + // An array of [Channel] objects that specify the input for the training jobs that the + // tuning job launches. + // + // [Channel]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html InputDataConfig []Channel // The resources, including the compute instances and storage volumes, to use for - // the training jobs that the tuning job launches. Storage volumes store model - // artifacts and incremental states. Training algorithms might also use storage - // volumes for scratch space. If you want SageMaker to use the storage volume to - // store the training data, choose File as the TrainingInputMode in the algorithm - // specification. For distributed training algorithms, specify an instance count - // greater than 1. If you want to use hyperparameter optimization with instance - // type flexibility, use HyperParameterTuningResourceConfig instead. + // the training jobs that the tuning job launches. + // + // Storage volumes store model artifacts and incremental states. Training + // algorithms might also use storage volumes for scratch space. If you want + // SageMaker to use the storage volume to store the training data, choose File as + // the TrainingInputMode in the algorithm specification. For distributed training + // algorithms, specify an instance count greater than 1. + // + // If you want to use hyperparameter optimization with instance type flexibility, + // use HyperParameterTuningResourceConfig instead. ResourceConfig *ResourceConfig // The number of times to retry the job when the job fails due to an @@ -6610,17 +7724,17 @@ type HyperParameterTrainingJobDefinition struct { // tuning uses the value of this metric to evaluate the training jobs it launches, // and returns the training job that results in either the highest or lowest value // for this metric, depending on the value you specify for the Type parameter. If - // you want to define a custom objective metric, see Define metrics and - // environment variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) - // . + // you want to define a custom objective metric, see [Define metrics and environment variables]. + // + // [Define metrics and environment variables]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html TuningObjective *HyperParameterTuningJobObjective - // The VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // object that specifies the VPC that you want the training jobs that this + // 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) - // . + // your training container by configuring the VPC. For more information, see [Protect Training Jobs by Using an Amazon Virtual Private Cloud]. + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Training Jobs by Using an Amazon Virtual Private Cloud]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -6657,12 +7771,14 @@ type HyperParameterTrainingJobSummary struct { // The reason that the training job failed. FailureReason *string - // The FinalHyperParameterTuningJobObjectiveMetric (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html) - // object that specifies the value of the objective metric of the tuning job that - // launched this training job. + // The [FinalHyperParameterTuningJobObjectiveMetric] object that specifies the value of the objective metric of the tuning job + // that launched this training job. + // + // [FinalHyperParameterTuningJobObjectiveMetric]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html 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. // @@ -6700,9 +7816,10 @@ type HyperParameterTrainingJobSummary struct { type HyperParameterTuningInstanceConfig struct { // The number of instances of the type specified by InstanceType . Choose an - // instance count larger than 1 for distributed training algorithms. See Step 2: - // Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK (https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html) - // for more information. + // instance count larger than 1 for distributed training algorithms. See [Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK]for more + // information. + // + // [Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK]: https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html // // This member is required. InstanceCount *int32 @@ -6710,9 +7827,9 @@ type HyperParameterTuningInstanceConfig struct { // The instance type used for processing of hyperparameter optimization jobs. // 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) - // . + // ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see [instance type descriptions]. + // + // [instance type descriptions]: https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html // // This member is required. InstanceType TrainingInstanceType @@ -6746,30 +7863,34 @@ type HyperParameterTuningJobCompletionDetails struct { // Configures a hyperparameter tuning job. type HyperParameterTuningJobConfig struct { - // The ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html) - // object that specifies the maximum number of training and parallel training jobs - // that can be used for this hyperparameter tuning job. + // The [ResourceLimits] object that specifies the maximum number of training and parallel training + // jobs that can be used for this hyperparameter tuning job. + // + // [ResourceLimits]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html // // This member is required. ResourceLimits *ResourceLimits // 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]. + // + // [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 - // The HyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html) - // specifies the objective metric used to evaluate the performance of training jobs - // launched by this tuning job. + // The [HyperParameterTuningJobObjective] specifies the objective metric used to evaluate the performance of + // training jobs launched by this tuning job. + // + // [HyperParameterTuningJobObjective]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html HyperParameterTuningJobObjective *HyperParameterTuningJobObjective - // The ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ParameterRanges.html) - // object that specifies the ranges of hyperparameters that this tuning job + // The [ParameterRanges] object that specifies the ranges of hyperparameters that this tuning job // searches over to find the optimal configuration for the highest model // performance against your chosen objective metric. + // + // [ParameterRanges]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ParameterRanges.html ParameterRanges *ParameterRanges // A value used to initialize a pseudo-random number generator. Setting a random @@ -6787,12 +7908,16 @@ type HyperParameterTuningJobConfig struct { // 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 - // 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) - // . + // 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]. + // + // [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. @@ -6814,9 +7939,9 @@ type HyperParameterTuningJobConsumedResources struct { // tuning uses the value of this metric to evaluate the training jobs it launches, // and returns the training job that results in either the highest or lowest value // for this metric, depending on the value you specify for the Type parameter. If -// you want to define a custom objective metric, see Define metrics and -// environment variables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html) -// . +// you want to define a custom objective metric, see [Define metrics and environment variables]. +// +// [Define metrics and environment variables]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html type HyperParameterTuningJobObjective struct { // The name of the metric to use for the objective metric. @@ -6832,8 +7957,10 @@ type HyperParameterTuningJobObjective struct { noSmithyDocumentSerde } -// 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. +// An entity returned by the [SearchRecord] API containing the properties of a hyperparameter +// tuning job. +// +// [SearchRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html type HyperParameterTuningJobSearchEntity struct { // The container for the summary information about a training job. @@ -6875,9 +8002,9 @@ type HyperParameterTuningJobSearchEntity struct { // The container for the summary information about a training job. 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) - // . + // The tags associated with a hyperparameter tuning job. For more information see [Tagging Amazon Web Services resources]. + // + // [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. @@ -6896,11 +8023,14 @@ type HyperParameterTuningJobSearchEntity struct { // Specifies the configuration for a hyperparameter tuning job that uses one or // more previous hyperparameter 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, and the - // training job that performs the best is compared to the best training jobs from - // the parent tuning jobs. From these, the training job that performs the best as - // measured by the objective metric is returned as the overall best training job. + // search over in the new tuning job. + // + // All training jobs launched by the new hyperparameter tuning job are evaluated + // by using the objective metric, and the training job that performs the best is + // compared to the best training jobs from the parent tuning jobs. From these, the + // training job that performs the best as measured by the objective metric is + // returned as the overall best training job. + // // All training jobs launched by parent hyperparameter tuning jobs and the new // hyperparameter tuning jobs count against the limit of training jobs for the // tuning job. @@ -6913,8 +8043,9 @@ type HyperParameterTuningJobSearchEntity struct { // Choose Bayesian for Bayesian optimization, and Random for random search // 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]. +// +// [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 @@ -6948,9 +8079,10 @@ type HyperParameterTuningJobSummary struct { // This member is required. HyperParameterTuningJobStatus HyperParameterTuningJobStatus - // The ObjectiveStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html) - // object that specifies the numbers of training jobs, categorized by objective - // metric status, that this tuning job launched. + // The [ObjectiveStatusCounters] object that specifies the numbers of training jobs, categorized by + // objective metric status, that this tuning job launched. + // + // [ObjectiveStatusCounters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html // // This member is required. ObjectiveStatusCounters *ObjectiveStatusCounters @@ -6961,9 +8093,10 @@ type HyperParameterTuningJobSummary struct { // This member is required. Strategy HyperParameterTuningJobStrategyType - // The TrainingJobStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html) - // object that specifies the numbers of training jobs, categorized by status, that - // this tuning job launched. + // The [TrainingJobStatusCounters] object that specifies the numbers of training jobs, categorized by status, + // that this tuning job launched. + // + // [TrainingJobStatusCounters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html // // This member is required. TrainingJobStatusCounters *TrainingJobStatusCounters @@ -6974,9 +8107,10 @@ type HyperParameterTuningJobSummary struct { // The date and time that the tuning job was modified. LastModifiedTime *time.Time - // The ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html) - // 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]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html ResourceLimits *ResourceLimits noSmithyDocumentSerde @@ -6985,11 +8119,14 @@ type HyperParameterTuningJobSummary struct { // Specifies the configuration for a hyperparameter tuning job that uses one or // more previous hyperparameter 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, and the -// training job that performs the best is compared to the best training jobs from -// the parent tuning jobs. From these, the training job that performs the best as -// measured by the objective metric is returned as the overall best training job. +// search over in the new tuning job. +// +// All training jobs launched by the new hyperparameter tuning job are evaluated +// by using the objective metric, and the training job that performs the best is +// compared to the best training jobs from the parent tuning jobs. From these, the +// training job that performs the best as measured by the objective metric is +// returned as the overall best training job. +// // All training jobs launched by parent hyperparameter tuning jobs and the new // hyperparameter tuning jobs count against the limit of training jobs for the // tuning job. @@ -6997,33 +8134,39 @@ 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 + // hyperparameter tuning job, see [Using a Previous Hyperparameter Tuning Job as a Starting Point]. + // + // Hyperparameter tuning jobs created before October 1, 2018 cannot be used as // parent jobs for warm start tuning jobs. // + // [Using a Previous Hyperparameter Tuning Job as a Starting Point]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-warm-start.html + // // This member is required. ParentHyperParameterTuningJobs []ParentHyperParameterTuningJob - // Specifies one of the following: IDENTICAL_DATA_AND_ALGORITHM The new - // hyperparameter tuning job uses the same input data and training image as the - // parent tuning jobs. You can change the hyperparameter ranges to search and the - // maximum number of training jobs that the hyperparameter tuning job launches. You - // cannot use a new version of the training algorithm, unless the changes in the - // new version do not affect the algorithm itself. For example, changes that - // improve logging or adding support for a different data format are allowed. You - // can also change hyperparameters from tunable to static, and from static to - // tunable, but the total number of static plus tunable hyperparameters must remain - // the same as it is in all parent jobs. The objective metric for the new tuning - // job must be the same as for all parent jobs. TRANSFER_LEARNING The new - // hyperparameter tuning job can include input data, hyperparameter ranges, maximum - // number of concurrent training jobs, and maximum number of training jobs that are - // different than those of its parent hyperparameter tuning jobs. The training - // image can also be a different version from the version used in the parent - // hyperparameter tuning job. You can also change hyperparameters from tunable to - // static, and from static to tunable, but the total number of static plus tunable - // hyperparameters must remain the same as it is in all parent jobs. The objective - // metric for the new tuning job must be the same as for all parent jobs. + // Specifies one of the following: + // + // IDENTICAL_DATA_AND_ALGORITHM The new hyperparameter tuning job uses the same + // input data and training image as the parent tuning jobs. You can change the + // hyperparameter ranges to search and the maximum number of training jobs that the + // hyperparameter tuning job launches. You cannot use a new version of the training + // algorithm, unless the changes in the new version do not affect the algorithm + // itself. For example, changes that improve logging or adding support for a + // different data format are allowed. You can also change hyperparameters from + // tunable to static, and from static to tunable, but the total number of static + // plus tunable hyperparameters must remain the same as it is in all parent jobs. + // The objective metric for the new tuning job must be the same as for all parent + // jobs. + // + // TRANSFER_LEARNING The new hyperparameter tuning job can include input data, + // hyperparameter ranges, maximum number of concurrent training jobs, and maximum + // number of training jobs that are different than those of its parent + // hyperparameter tuning jobs. The training image can also be a different version + // from the version used in the parent hyperparameter tuning job. You can also + // change hyperparameters from tunable to static, and from static to tunable, but + // the total number of static plus tunable hyperparameters must remain the same as + // it is in all parent jobs. The objective metric for the new tuning job must be + // the same as for all parent jobs. // // This member is required. WarmStartType HyperParameterTuningJobWarmStartType @@ -7036,10 +8179,11 @@ type HyperParameterTuningJobWarmStartConfig struct { // 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, -// which reuse clusters between training jobs. +// allocation strategy for instance selection. +// +// HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig +// with the exception of KeepAlivePeriodInSeconds . Hyperparameter tuning jobs use +// warm pools by default, which reuse clusters between training jobs. type HyperParameterTuningResourceConfig struct { // The strategy that determines the order of preference for resources specified in @@ -7050,47 +8194,64 @@ type HyperParameterTuningResourceConfig struct { // hyperparameter jobs. These resources include compute instances and storage // volumes to use in model training jobs launched by hyperparameter tuning jobs. // 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 . + // 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 . 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. + // The number of compute instances of type InstanceType to use. For [distributed training], select a + // value greater than 1. + // + // [distributed training]: https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html InstanceCount *int32 - // The instance type used to run hyperparameter optimization tuning jobs. See - // descriptions of instance types (https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html) - // for more information. + // The instance type used to run hyperparameter optimization tuning jobs. See [descriptions of instance types] for + // more information. + // + // [descriptions of instance types]: https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html InstanceType TrainingInstanceType // A key used by Amazon Web Services Key Management Service to encrypt data on the // storage volume attached to the compute instances used to run the training job. - // 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) - // 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) - // for more information. + // 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] 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]. For more information about Amazon + // Web Services Key Management Service, see [KMS encryption]for more information. + // + // [KMS encryption]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html + // [hardware module to encrypt]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html + // [instance store volumes]: http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/ VolumeKmsKeyId *string // The volume size in GB for the storage volume to be used in processing // hyperparameter optimization jobs (optional). These volumes store model // artifacts, incremental states and optionally, scratch space for training // algorithms. Do not provide a value for this parameter if a value for - // 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) - // storage volume type. + // 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]. + // + // SageMaker supports only the [General Purpose SSD (gp2)] storage volume type. + // + // [instance store volumes]: http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/ + // [General Purpose SSD (gp2)]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html VolumeSizeInGB *int32 noSmithyDocumentSerde @@ -7190,7 +8351,9 @@ 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. // // This member is required. @@ -7301,14 +8464,16 @@ type InferenceComponentContainerSpecificationSummary struct { ArtifactUrl *string // Gets the Amazon EC2 Container Registry path of the docker image of the model - // that is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html) - // . 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 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) - // in the Amazon ECR User Guide. + // 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 value that identifies a specific version of an image. For information + // about Amazon ECR paths, see [Pulling an Image]in the Amazon ECR User Guide. + // + // [ProductionVariant]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html + // [Pulling an Image]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html DeployedImage *DeployedImage // The environment variables to set in the Docker container. @@ -7392,9 +8557,9 @@ type InferenceComponentSpecificationSummary struct { type InferenceComponentStartupParameters struct { // The timeout value, in seconds, for your inference container to pass health - // check by Amazon S3 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) - // . + // check by Amazon S3 Hosting. For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests]. + // + // [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 // The timeout value, in seconds, to download and extract the model that you want @@ -7454,7 +8619,9 @@ type InferenceComponentSummary 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. // // This member is required. @@ -7477,15 +8644,16 @@ type InferenceExperimentDataStorageConfig struct { // data. ContentType *CaptureContentTypeHeader - // The Amazon Web Services Key Management Service key that Amazon SageMaker uses + // 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 } -// The start and end times of an inference experiment. The maximum duration that -// you can set for an inference experiment is 30 days. +// The start and end times of an inference experiment. +// +// The maximum duration that you can set for an inference experiment is 30 days. type InferenceExperimentSchedule struct { // The timestamp at which the inference experiment ended or will end. @@ -7531,13 +8699,14 @@ type InferenceExperimentSummary struct { // The description of the inference experiment. Description *string - // The ARN of the IAM role that Amazon SageMaker can assume to access model + // The ARN of the IAM role that Amazon SageMaker can assume to access model // artifacts and container images, and manage Amazon SageMaker Inference endpoints // for model deployment. RoleArn *string - // The duration for which the inference experiment ran or will run. The maximum - // duration that you can set for an inference experiment is 30 days. + // The duration for which the inference experiment ran or will run. + // + // The maximum duration that you can set for an inference experiment is 30 days. Schedule *InferenceExperimentSchedule // The error message for the inference experiment status result. @@ -7656,9 +8825,9 @@ type InferenceRecommendationsJob struct { noSmithyDocumentSerde } -// A returned array object for the Steps response field in the -// ListInferenceRecommendationsJobSteps (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListInferenceRecommendationsJobSteps.html) -// API command. +// A returned array object for the Steps response field in the [ListInferenceRecommendationsJobSteps] API command. +// +// [ListInferenceRecommendationsJobSteps]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListInferenceRecommendationsJobSteps.html type InferenceRecommendationsJobStep struct { // The name of the Inference Recommender job. @@ -7671,8 +8840,9 @@ type InferenceRecommendationsJobStep struct { // This member is required. Status RecommendationJobStatus - // The type of the subtask. BENCHMARK : Evaluate the performance of your model on - // different instance types. + // The type of the subtask. + // + // BENCHMARK : Evaluate the performance of your model on different instance types. // // This member is required. StepType RecommendationStepType @@ -7696,6 +8866,7 @@ type InferenceSpecification struct { SupportedContentTypes []string // A list of the instance types that are used to generate inferences in real-time. + // // This parameter is required for unversioned models, and optional for versioned // models. SupportedRealtimeInferenceInstanceTypes []ProductionVariantInstanceType @@ -7704,8 +8875,10 @@ type InferenceSpecification struct { SupportedResponseMIMETypes []string // A list of the instance types on which a transformation job can be run or on - // which an endpoint can be deployed. This parameter is required for unversioned - // models, and optional for versioned models. + // which an endpoint can be deployed. + // + // This parameter is required for unversioned models, and optional for versioned + // models. SupportedTransformInstanceTypes []TransformInstanceType noSmithyDocumentSerde @@ -7742,120 +8915,182 @@ 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 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 CoreML 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html) - // CompilerOptions . CoreML converter supports Tensorflow and PyTorch models. - // CoreML conversion examples: + // + // 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) - // . + // parameters for ml_eia2[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: + // Specify the signature_def_key in [OutputConfig:CompilerOptions]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: + // output_names in [OutputConfig:CompilerOptions]OutputConfig:CompilerOptions . For example: + // // - "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]} + // // - "CompilerOptions": {"output_names": ["output_tensor:0"]} + // + // [OutputConfig:CompilerOptions]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions + // [OutputConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html + // [OutputConfig:TargetDevice]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-TargetDevice DataInputConfig *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) - // . + // 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]and [Edge Supported Frameworks]. + // + // [Cloud Supported Instance Types and Frameworks]: https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html + // [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) -// API, you can configure multiple instance groups . +// training job using the [CreateTrainingJob]API, you can configure multiple instance groups . +// +// [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html type InstanceGroup struct { // Specifies the number of instances of the instance group. @@ -7910,14 +9145,21 @@ type IntegerParameterRange struct { Name *string // 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 - // 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 - // logarithmic scale. Logarithmic scaling works only for ranges that have only - // values greater than 0. + // For information about choosing a hyperparameter scale, see [Hyperparameter Scaling]. 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 logarithmic scale. + // + // Logarithmic scaling works only for ranges that have only values greater than 0. + // + // [Hyperparameter Scaling]: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type ScalingType HyperParameterScalingType noSmithyDocumentSerde @@ -7987,10 +9229,11 @@ type JupyterServerAppSettings struct { // LifecycleConfigArns parameter, then this parameter is also required. DefaultResourceSpec *ResourceSpec - // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the + // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the // JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter - // is also required. To remove a Lifecycle Config, you must set LifecycleConfigArns - // to an empty list. + // is also required. + // + // To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list. LifecycleConfigArns []string noSmithyDocumentSerde @@ -8015,15 +9258,17 @@ type KernelGatewayAppSettings struct { CustomImages []CustomImage // The default instance type and the Amazon Resource Name (ARN) of the default - // SageMaker image used by the KernelGateway app. The Amazon SageMaker Studio UI - // does not use the default instance type value set here. The default instance type - // set here is used when Apps are created using the CLI or CloudFormation and the - // instance type parameter value is not passed. + // SageMaker image used by the KernelGateway app. + // + // The Amazon SageMaker Studio UI does not use the default instance type value set + // here. The default instance type set here is used when Apps are created using the + // CLI or CloudFormation and the instance type parameter value is not passed. DefaultResourceSpec *ResourceSpec - // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the - // the user profile or domain. To remove a Lifecycle Config, you must set - // LifecycleConfigArns to an empty list. + // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the + // the user profile or domain. + // + // To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list. LifecycleConfigArns []string noSmithyDocumentSerde @@ -8101,13 +9346,21 @@ 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 // // This member is required. @@ -8137,11 +9390,15 @@ 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 +// 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 { @@ -8149,9 +9406,10 @@ 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) + // An Amazon SNS data source used for streaming labeling jobs. To learn more, see [Send Data to a Streaming Labeling Job] // . + // + // [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 @@ -8227,26 +9485,36 @@ type LabelingJobOutputConfig struct { 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 - // 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. + // 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]. + // + // 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] in + // the Amazon Simple Storage Service Developer Guide. + // + // [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 + // [KMS-Managed Encryption Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html 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 - // 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) - // . + // 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]. + // + // [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 SnsTopicArn *string noSmithyDocumentSerde @@ -8259,23 +9527,32 @@ 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 - // 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" + // 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]. + // + // 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" + // + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // + // [Output Data and Storage Volume Encryption]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security.html VolumeKmsKeyId *string // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -8285,17 +9562,22 @@ 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: + // 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. + // + // If you are a new user of Ground Truth, it is recommended you review [Use an Input Manifest File] in the + // Amazon SageMaker Developer Guide to learn how to create an input manifest file. + // + // [Use an Input Manifest File]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-input-data-input-manifest.html // // This member is required. ManifestS3Uri *string @@ -8317,8 +9599,9 @@ type LabelingJobSnsDataSource struct { // A set of conditions for stopping a labeling job. If any of the conditions are // met, the job is automatically stopped. You can use these conditions to control -// the cost of data labeling. Labeling jobs fail after 30 days with an appropriate -// client error message. +// the cost of data labeling. +// +// Labeling jobs fail after 30 days with an appropriate client error message. type LabelingJobStoppingConditions struct { // The maximum number of objects that can be labeled by human workers. @@ -8376,8 +9659,9 @@ 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]. + // + // [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 @@ -8502,9 +9786,11 @@ type MetricDatum struct { // The dataset split from which the AutoML job produced the metric. 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) - // . + // The name of the standard metric. + // + // For definitions of the standard metrics, see [Autopilot candidate metrics]Autopilot candidate 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. @@ -8517,9 +9803,10 @@ type MetricDatum struct { // 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) -// parameter in the HyperParameterTrainingJobDefinition API to evaluate job -// performance during hyperparameter tuning. +// metric using the [TuningObjective]parameter in the HyperParameterTrainingJobDefinition API to +// evaluate job performance during hyperparameter tuning. +// +// [TuningObjective]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective type MetricDefinition struct { // The name of the metric. @@ -8529,8 +9816,9 @@ 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]. + // + // [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 @@ -8585,8 +9873,9 @@ type MetricsSource struct { noSmithyDocumentSerde } -// The properties of a model as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API. +// The properties of a model as returned by the [Search] API. +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type Model struct { // The containers in the inference pipeline. @@ -8617,16 +9906,17 @@ type Model struct { // Describes the container, as part of model definition. 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) + // A list of key-value pairs associated with the model. For more information, see [Tagging Amazon Web Services resources] // in the Amazon Web Services General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []Tag // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -8635,12 +9925,15 @@ type Model struct { // The access configuration file to control access to the ML model. You can // explicitly accept the model end-user license agreement (EULA) within the // ModelAccessConfig . -// - If you are a Jumpstart user, see the End-user license agreements (https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula) -// section for more details on accepting the EULA. +// +// - If you are a Jumpstart user, see the [End-user license agreements]section for more details on accepting +// the EULA. +// // - If you are an AutoML user, see the Optional Parameters section of Create an -// AutoML job to fine-tune text generation models using the API for details on -// How to set the EULA acceptance when fine-tuning a model using the AutoML API (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params) -// . +// AutoML job to fine-tune text generation models using the API for details on [How to set the EULA acceptance when fine-tuning a model using the AutoML API]. +// +// [End-user license agreements]: https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula +// [How to set the EULA acceptance when fine-tuning a model using the AutoML API]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params type ModelAccessConfig struct { // Specifies agreement to the model end-user license agreement (EULA). The @@ -8656,12 +9949,14 @@ type ModelAccessConfig struct { } // Provides information about the location that is configured for storing model -// artifacts. Model artifacts are outputs that result from training a model. They -// typically consist of trained parameters, a model definition that describes how -// to compute inferences, and other metadata. A SageMaker container stores your -// trained model artifacts in the /opt/ml/model directory. After training has -// completed, by default, these artifacts are uploaded to your Amazon S3 bucket as -// compressed files. +// artifacts. +// +// Model artifacts are outputs that result from training a model. They typically +// consist of trained parameters, a model definition that describes how to compute +// inferences, and other metadata. A SageMaker container stores your trained model +// artifacts in the /opt/ml/model directory. After training has completed, by +// default, these artifacts are uploaded to your Amazon S3 bucket as compressed +// files. type ModelArtifacts struct { // The path of the S3 object that contains the model artifacts. For example, @@ -8677,8 +9972,9 @@ 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]. + // + // [Configure bias parameters]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-bias-parameters.html // // This member is required. ConfigUri *string @@ -8726,8 +10022,9 @@ 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.html#model-cards-json-schema) - // and provided as a string. + // The content of the model card. Content uses the [model card JSON schema] and provided as a string. + // + // [model card JSON schema]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema Content *string // Information about the user who created or modified an experiment, trial, trial @@ -8752,9 +10049,13 @@ type ModelCard struct { // 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. ModelCardStatus ModelCardStatus @@ -8770,8 +10071,9 @@ type ModelCard struct { ModelPackageGroupName *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]. + // + // [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. @@ -8849,8 +10151,9 @@ 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) - // to use for encrypting a model card. + // A Key Management Service [key ID] to use for encrypting a model card. + // + // [key ID]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id KmsKeyId *string noSmithyDocumentSerde @@ -8876,9 +10179,13 @@ type ModelCardSummary struct { // 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. // @@ -8912,9 +10219,13 @@ 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. // @@ -9011,9 +10322,9 @@ type ModelDashboardModel struct { // The endpoints that host a model. 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) - // . + // A batch transform job. For information about SageMaker batch transform, see [Use Batch Transform]. + // + // [Use Batch Transform]: https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html LastBatchTransformJob *TransformJob // A model displayed in the Model Dashboard. @@ -9144,14 +10455,16 @@ 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. 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. + // 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 @@ -9160,8 +10473,9 @@ type ModelDeployConfig struct { // Provides information about the endpoint of the model deployment. type ModelDeployResult struct { - // The name of the endpoint to which the model has been deployed. If model - // deployment fails, this field is omitted from the response. + // The name of the endpoint to which the model has been deployed. + // + // If model deployment fails, this field is omitted from the response. EndpointName *string noSmithyDocumentSerde @@ -9180,9 +10494,9 @@ type ModelDigests struct { type ModelExplainabilityAppSpecification struct { // JSON formatted Amazon 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) - // . + // information on this JSON configuration file, see [Configure model explainability parameters]. + // + // [Configure model explainability parameters]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html // // This member is required. ConfigUri *string @@ -9227,6 +10541,7 @@ type ModelInfrastructureConfig struct { // The inference option to which to deploy your model. Possible values are the // following: + // // - RealTime : Deploy to real-time inference. // // This member is required. @@ -9352,9 +10667,9 @@ type ModelPackage struct { // 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) - // . + // Services Marketplace, see [List Your Algorithm or Model Package on Amazon Web Services Marketplace]. + // + // [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 @@ -9390,8 +10705,11 @@ 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. ModelApprovalStatus ModelApprovalStatus @@ -9411,10 +10729,15 @@ 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. ModelPackageStatus ModelPackageStatus @@ -9437,9 +10760,10 @@ type ModelPackage struct { // The URI of the source for the model package. SourceUri *string - // 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) + // A list of the tags associated with the model package. For more information, see [Tagging Amazon Web Services resources] // in the Amazon Web Services General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []Tag // The machine learning task your model package accomplishes. Common machine @@ -9457,12 +10781,14 @@ type ModelPackage struct { type ModelPackageContainerDefinition struct { // The Amazon EC2 Container Registry (Amazon ECR) path where inference code is - // 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) - // . + // 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]. + // + // [Using Your Own Algorithms with Amazon SageMaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html // // This member is required. Image *string @@ -9494,8 +10820,10 @@ type ModelPackageContainerDefinition struct { // 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. + // .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. @@ -9532,17 +10860,24 @@ 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. 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) + // A list of the tags associated with the model group. For more information, see [Tagging Amazon Web Services resources] // in the Amazon Web Services General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []Tag noSmithyDocumentSerde @@ -9629,8 +10964,11 @@ 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. ModelApprovalStatus ModelApprovalStatus @@ -9651,8 +10989,10 @@ type ModelPackageSummary struct { } // Contains data, such as the inputs and targeted instance types that are used in -// the process of validating the model package. The data provided in the validation -// profile is made available to your buyers on Amazon Web Services Marketplace. +// the process of validating the model package. +// +// The data provided in the validation profile is made available to your buyers on +// Amazon Web Services Marketplace. type ModelPackageValidationProfile struct { // The name of the profile for the model package. @@ -9844,15 +11184,19 @@ type ModelVariantConfigSummary struct { // This member is required. ModelName *string - // The status of deployment for the model variant on the hosted inference - // endpoint. + // 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. // @@ -10219,9 +11563,9 @@ type MonitoringNetworkConfig struct { // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -10294,9 +11638,10 @@ type MonitoringS3Output struct { noSmithyDocumentSerde } -// 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) +// A schedule for a model monitoring job. For information about model monitor, see [Amazon SageMaker Model Monitor] // . +// +// [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. @@ -10324,9 +11669,13 @@ type MonitoringSchedule struct { 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. MonitoringScheduleStatus ScheduleStatus @@ -10334,8 +11683,9 @@ type MonitoringSchedule struct { 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]in the Amazon Web Services General Reference Guide. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []Tag noSmithyDocumentSerde @@ -10411,10 +11761,12 @@ type MonitoringStatisticsResource struct { // A time limit for how long the monitoring job is allowed to run before stopping. type MonitoringStoppingCondition struct { - // The maximum runtime allowed in seconds. The MaxRuntimeInSeconds cannot exceed - // the frequency of the job. For data quality and model explainability, this can be - // up to 3600 seconds for an hourly schedule. For model bias and model quality - // hourly schedules, this can be up to 1800 seconds. + // The maximum runtime allowed in seconds. + // + // The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data + // quality and model explainability, this can be up to 3600 seconds for an hourly + // schedule. For model bias and model quality hourly schedules, this can be up to + // 1800 seconds. // // This member is required. MaxRuntimeInSeconds *int32 @@ -10436,12 +11788,12 @@ type MultiModelConfig struct { noSmithyDocumentSerde } -// The VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) -// 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) -// . +// 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]. +// +// [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html +// [Give Amazon SageMaker 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 @@ -10459,15 +11811,20 @@ type NeoVpcConfig struct { noSmithyDocumentSerde } -// A list of nested Filter (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Filter.html) -// objects. A resource must satisfy the conditions of all filters to be included in -// the results returned from the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API. For example, to filter on a training job's InputDataConfig property with a +// 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"}' +// +// [Filter]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Filter.html +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type NestedFilters struct { // A list of filters. Each filter acts on a property. Filters must contain at @@ -10503,9 +11860,9 @@ type NetworkConfig struct { // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to - // and from your resources by configuring a VPC. For more information, see Give - // SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) - // . + // and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. + // + // [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -10533,17 +11890,24 @@ type NotebookInstanceLifecycleConfigSummary struct { noSmithyDocumentSerde } -// 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 Amazon CloudWatch Logs for notebook instance -// lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log -// 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) -// . +// 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 Amazon CloudWatch Logs for notebook instance lifecycle configurations in +// log group /aws/sagemaker/NotebookInstances in log 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]. +// +// [Step 2.1: (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 @@ -10568,11 +11932,12 @@ 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]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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. @@ -10580,12 +11945,12 @@ 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) - // . + // in your account, or the URL of a Git repository in [Amazon Web Services CodeCommit]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]. + // + // [Amazon Web Services CodeCommit]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html + // [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. @@ -10595,9 +11960,11 @@ type NotebookInstanceSummary struct { LastModifiedTime *time.Time // 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) - // . + // notebook instance. + // + // For information about notebook instance lifestyle configurations, see [Step 2.1: (Optional) Customize a Notebook Instance]. + // + // [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. @@ -10642,10 +12009,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 . @@ -10659,12 +12029,16 @@ type OfflineStoreConfig struct { // Set to True to disable the automatic creation of an Amazon Web Services Glue // table when configuring an OfflineStore . If set to False , Feature Store will - // name the OfflineStore Glue table following Athena's naming recommendations (https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html) - // . The default value is False . + // name the OfflineStore Glue table following [Athena's naming recommendations]. + // + // The default value is False . + // + // [Athena's naming recommendations]: https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html DisableGlueTableCreation *bool - // Format for the offline store table. Supported formats are Glue (Default) and - // Apache Iceberg (https://iceberg.apache.org/) . + // Format for the offline store table. Supported formats are Glue (Default) and [Apache Iceberg]. + // + // [Apache Iceberg]: https://iceberg.apache.org/ TableFormat TableFormat noSmithyDocumentSerde @@ -10775,13 +12149,15 @@ type OidcMemberDefinition struct { // 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 . +// 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 . + // OnlineStore on by specifying True for the EnableOnlineStore flag. + // + // The default value is False . EnableOnlineStore *bool // Use to specify KMS Key ID ( KMSKeyId ) for at-rest encryption of your @@ -10789,15 +12165,18 @@ type OnlineStoreConfig struct { SecurityConfig *OnlineStoreSecurityConfig // Option for different tiers of low latency storage for real-time data retrieval. + // // - Standard : A managed low latency data store for feature groups. + // // - InMemory : A managed data store for feature groups that supports very low // latency retrieval. StorageType StorageType // Time to live duration, where the record is hard deleted after the expiration // time is reached; ExpiresAt = EventTime + TtlDuration . For information on - // HardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) - // API in the Amazon SageMaker API Reference guide. + // HardDelete, see the [DeleteRecord]API in the Amazon SageMaker API Reference guide. + // + // [DeleteRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html TtlDuration *TtlDuration noSmithyDocumentSerde @@ -10808,8 +12187,9 @@ type OnlineStoreConfigUpdate struct { // Time to live duration, where the record is hard deleted after the expiration // time is reached; ExpiresAt = EventTime + TtlDuration . For information on - // HardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) - // API in the Amazon SageMaker API Reference guide. + // HardDelete, see the [DeleteRecord]API in the Amazon SageMaker API Reference guide. + // + // [DeleteRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html TtlDuration *TtlDuration noSmithyDocumentSerde @@ -10820,21 +12200,36 @@ 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 OnlineStore KmsKeyId : + // server-side encryption. + // + // The caller (either user or IAM role) of 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 @@ -10860,92 +12255,154 @@ 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"} . + // + // - 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. + // 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'} + // + // - 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 Reference Guide (https://awsdocs-neuron.readthedocs-hosted.com/en/latest/compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html) - // . - // - CoreML : Compilation for the CoreML OutputConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html) - // TargetDevice supports the following compiler options: + // --num-neuroncores 2 -O2\"" . + // + // For information about supported compiler options, see [Neuron Compiler CLI Reference Guide]. + // + // - 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"]} + // output_names . + // + // For example: {"precision_mode": "FP32", "output_names": ["output:0"]} + // + // [OutputConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html + // [Neuron Compiler CLI Reference Guide]: https://awsdocs-neuron.readthedocs-hosted.com/en/latest/compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html 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) - // in the Amazon Simple Storage Service Developer Guide. The KmsKeyId can be any of - // the following formats: + // For more information, see [KMS-Managed Encryption Keys]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 + // + // [KMS-Managed Encryption Keys]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TargetPlatform.html) - // fields. It can be used instead of TargetPlatform . Currently ml_trn1 is - // available only in US East (N. Virginia) Region, and ml_inf2 is available only - // in US East (Ohio) Region. + // specify OS, architecture, and accelerator using [TargetPlatform]fields. It can be used instead + // of TargetPlatform . + // + // Currently ml_trn1 is available only in US East (N. Virginia) Region, and ml_inf2 + // is available only in US East (Ohio) Region. + // + // [TargetPlatform]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TargetPlatform.html 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 - // 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} + // 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} TargetPlatform *TargetPlatform noSmithyDocumentSerde @@ -10968,24 +12425,40 @@ 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" + // + // - // 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: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" + // + // "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. 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. If the output data is - // stored in Amazon S3 Express One Zone, it is encrypted with server-side - // encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for - // Amazon S3 Express One Zone 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. + // account. + // + // For more information, see [KMS-Managed Encryption Keys] in the Amazon Simple Storage Service Developer + // Guide. If the output data is stored in Amazon S3 Express One Zone, it is + // encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS + // key is not supported for Amazon S3 Express One Zone + // + // 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]in the Amazon Web Services Key Management + // Service Developer Guide. + // + // [KMS-Managed Encryption Keys]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html + // [Using Key Policies in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html KmsKeyId *string noSmithyDocumentSerde @@ -11080,8 +12553,9 @@ type ParameterRange struct { // hyperparameter tuning job searches. The hyperparameter tuning job launches // 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 +// 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. @@ -11091,19 +12565,22 @@ type ParameterRanges struct { // Autotune to determine optimal ranges for your tuning job. AutoParameters []AutoParameter - // The array of CategoricalParameterRange (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CategoricalParameterRange.html) - // objects that specify ranges of categorical hyperparameters that a hyperparameter - // tuning job searches. + // The array of [CategoricalParameterRange] objects that specify ranges of categorical hyperparameters that a + // hyperparameter tuning job searches. + // + // [CategoricalParameterRange]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CategoricalParameterRange.html CategoricalParameterRanges []CategoricalParameterRange - // The array of ContinuousParameterRange (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContinuousParameterRange.html) - // objects that specify ranges of continuous hyperparameters that a hyperparameter - // tuning job searches. + // The array of [ContinuousParameterRange] objects that specify ranges of continuous hyperparameters that a + // hyperparameter tuning job searches. + // + // [ContinuousParameterRange]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContinuousParameterRange.html ContinuousParameterRanges []ContinuousParameterRange - // The array of IntegerParameterRange (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_IntegerParameterRange.html) - // objects that specify ranges of integer hyperparameters that a hyperparameter - // tuning job searches. + // The array of [IntegerParameterRange] objects that specify ranges of integer hyperparameters that a + // hyperparameter tuning job searches. + // + // [IntegerParameterRange]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_IntegerParameterRange.html IntegerParameterRanges []IntegerParameterRange noSmithyDocumentSerde @@ -11143,15 +12620,17 @@ type PendingDeploymentSummary struct { // This member is required. EndpointConfigName *string - // An array of PendingProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html) - // objects, one for each model hosted behind this endpoint for the in-progress - // deployment. + // An array of [PendingProductionVariantSummary] objects, one for each model hosted behind this endpoint for the + // in-progress deployment. + // + // [PendingProductionVariantSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html ProductionVariants []PendingProductionVariantSummary - // An array of PendingProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html) - // objects, one for each model hosted behind this endpoint in shadow mode with - // production traffic replicated from the model specified on ProductionVariants - // for the in-progress deployment. + // An array of [PendingProductionVariantSummary] objects, one for each model hosted behind this endpoint in shadow + // mode with production traffic replicated from the model specified on + // ProductionVariants for the in-progress deployment. + // + // [PendingProductionVariantSummary]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_PendingProductionVariantSummary.html ShadowProductionVariants []PendingProductionVariantSummary // The start time of the deployment. @@ -11161,10 +12640,11 @@ type PendingDeploymentSummary struct { } // The production variant summary for a deployment when an endpoint is creating or -// updating with the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) -// or UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) -// operations. Describes the VariantStatus , weight and capacity for a production -// variant associated with an endpoint. +// updating with the [CreateEndpoint]or [UpdateEndpoint] operations. Describes the VariantStatus , weight and +// capacity for a production variant associated with an endpoint. +// +// [UpdateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html +// [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html type PendingProductionVariantSummary struct { // The name of the variant. @@ -11174,8 +12654,9 @@ 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]. + // + // [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. @@ -11194,8 +12675,9 @@ type PendingProductionVariantSummary struct { // The number of instances requested in this deployment, as specified in the // endpoint configuration for the endpoint. The value is taken from the request to - // the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) - // operation. + // the [CreateEndpointConfig]operation. + // + // [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html DesiredInstanceCount *int32 // The serverless configuration requested for this deployment, as specified in the @@ -11204,8 +12686,9 @@ type PendingProductionVariantSummary struct { // The requested weight for the variant in this deployment, as specified in the // endpoint configuration for the endpoint. The value is taken from the request to - // the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) - // operation. + // the [CreateEndpointConfig]operation. + // + // [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html DesiredWeight *float32 // The type of instances associated with the variant. @@ -11364,9 +12847,9 @@ type PipelineExecution struct { // An execution of a step in a pipeline. 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) - // . + // The current attempt of the execution step. For more information, see [Retry Policy for SageMaker Pipelines steps]. + // + // [Retry 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. @@ -11416,15 +12899,23 @@ 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 . ClarifyCheck *ClarifyCheckStepMetadata @@ -11451,15 +12942,23 @@ 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 . QualityCheck *QualityCheckStepMetadata @@ -11532,7 +13031,7 @@ type PipelineSummary struct { // The time that the pipeline was last modified. LastModifiedTime *time.Time - // The Amazon Resource Name (ARN) of the pipeline. + // The Amazon Resource Name (ARN) of the pipeline. PipelineArn *string // The description of the pipeline. @@ -11576,28 +13075,37 @@ type ProcessingClusterConfig struct { 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. Certain Nitro-based - // instances include local storage with a fixed total size, dependent on the - // instance type. When using these instances for processing, Amazon SageMaker - // 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) - // . + // must specify sufficient ML storage for your scenario. + // + // Certain Nitro-based instances include local storage with a fixed total size, + // dependent on the instance type. When using these instances for processing, + // Amazon SageMaker 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]. + // + // [Instance Store Volumes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes // // This member is required. VolumeSizeInGB *int32 // 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 processing job. 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 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) - // . + // ML compute instance(s) that run the processing job. + // + // 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 VolumeKmsKeyId when using an instance type with + // local storage. + // + // For a list of instance types that support local instance storage, see [Instance Store Volumes]. + // + // For more information about local instance storage encryption, see [SSD Instance Store Volumes]. + // + // [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 VolumeKmsKeyId *string noSmithyDocumentSerde @@ -11641,8 +13149,9 @@ 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]. +// +// [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. @@ -11664,9 +13173,16 @@ type ProcessingJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html ExperimentConfig *ExperimentConfig // A string, up to one KB in size, that contains the reason a processing job @@ -11719,9 +13235,10 @@ type ProcessingJob struct { // processing job is stopped. 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) - // in the Amazon Web Services Billing and Cost Management User Guide. + // An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the Amazon Web + // Services Billing and Cost Management User Guide. + // + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL Tags []Tag // The ARN of the training job associated with this processing job. @@ -11921,11 +13438,13 @@ type ProcessingStoppingCondition struct { noSmithyDocumentSerde } -// 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 +// 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]. +// +// [Production variants]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html type ProductionVariant struct { // The name of the production variant. @@ -11935,21 +13454,22 @@ 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]. + // + // [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) - // . + // check by SageMaker Hosting. For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests]. + // + // [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 + // 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 @@ -12009,25 +13529,38 @@ type ProductionVariantCoreDumpConfig struct { // 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" + // + // - // 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: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" + // + // "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 - // 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. + // s3:x-amz-server-side-encryption to "aws:kms" . For more information, see [KMS-Managed Encryption Keys] 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] in + // the Amazon Web Services Key Management Service Developer Guide. + // + // [KMS-Managed Encryption Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html + // [Using Key Policies in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html KmsKeyId *string noSmithyDocumentSerde @@ -12056,8 +13589,10 @@ type ProductionVariantManagedInstanceScaling struct { type ProductionVariantRoutingConfig struct { // Sets how the endpoint routes incoming traffic: + // // - LEAST_OUTSTANDING_REQUESTS : The endpoint routes requests to the specific // instances that have more capacity to process them. + // // - RANDOM : The endpoint routes each request to a randomly chosen instance. // // This member is required. @@ -12082,11 +13617,13 @@ type ProductionVariantServerlessConfig struct { MemorySizeInMB *int32 // The amount of provisioned concurrency to allocate for the serverless endpoint. - // Should be less than or equal to MaxConcurrency . This field is not supported for - // serverless endpoint recommendations for Inference Recommender jobs. For more - // information about creating an Inference Recommender job, see - // CreateInferenceRecommendationsJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html) - // . + // Should be less than or equal to MaxConcurrency . + // + // This field is not supported for serverless endpoint recommendations for + // Inference Recommender jobs. For more information about creating an Inference + // Recommender job, see [CreateInferenceRecommendationsJobs]. + // + // [CreateInferenceRecommendationsJobs]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html ProvisionedConcurrency *int32 noSmithyDocumentSerde @@ -12112,10 +13649,15 @@ 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. // @@ -12199,10 +13741,9 @@ type ProfilerConfig struct { // 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) - // . + // about how to configure the ProfilingParameters parameter, see [Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job]. + // + // [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 ProfilingParameters map[string]string // Path to Amazon S3 storage location for system and framework metrics. @@ -12228,10 +13769,9 @@ type ProfilerConfigForUpdate struct { // 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) - // . + // about how to configure the ProfilingParameters parameter, see [Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job]. + // + // [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 ProfilingParameters map[string]string // Path to Amazon S3 storage location for system and framework metrics. @@ -12326,20 +13866,22 @@ 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]. + // + // [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) - // . + // information about service catalog, see [What is Amazon Web Services Service Catalog]. + // + // [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]. + // + // [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []Tag noSmithyDocumentSerde @@ -12403,8 +13945,9 @@ type PropertyNameSuggestion struct { } // 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) -// . +// product. For information, see [What is Amazon Web Services Service Catalog]. +// +// [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. @@ -12417,115 +13960,209 @@ type ProvisioningParameter struct { } // Defines the amount of money paid to an Amazon Mechanical Turk worker for each -// 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. +// 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 type PublicWorkforceTaskPrice struct { @@ -12537,8 +14174,9 @@ 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) -// in the Amazon SageMaker Developer Guide. +// the topic on [QualityCheck step]in the Amazon SageMaker Developer Guide. +// +// [QualityCheck step]: https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-quality-check type QualityCheckStepMetadata struct { // The Amazon S3 URI of the baseline constraints file used for the drift check. @@ -12664,35 +14302,41 @@ 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) -// 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. +// the [CreateInferenceRecommendationsJob]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. +// +// [CreateInferenceRecommendationsJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html 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]. + // + // [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: - // COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING + // The machine learning domain of the model and its components. + // + // Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING Domain *string - // The machine learning framework of the container image. Valid Values: TENSORFLOW - // | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN + // The machine learning framework of the container image. + // + // Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN Framework *string // 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 + // 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. @@ -12710,9 +14354,10 @@ type RecommendationJobContainerConfig struct { // The supported MIME types for the output data. SupportedResponseMIMETypes []string - // The machine learning task that the model accomplishes. Valid Values: - // IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | - // FILL_MASK | CLASSIFICATION | REGRESSION | OTHER + // The machine learning task that the model accomplishes. + // + // Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | + // IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER Task *string noSmithyDocumentSerde @@ -12782,19 +14427,36 @@ type RecommendationJobInputConfig struct { // The Amazon Resource Name (ARN) of a 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. This - // key will be passed to SageMaker Hosting for endpoint creation. The SageMaker - // execution role must have kms:CreateGrant permission in order to encrypt data on - // the storage volume of the endpoints created for inference recommendation. The - // 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) - // in the Amazon Web Services Key Management Service (Amazon Web Services KMS) - // documentation. + // key will be passed to SageMaker Hosting for endpoint creation. + // + // The SageMaker execution role must have kms:CreateGrant permission in order to + // encrypt data on the storage volume of the endpoints created for inference + // recommendation. The 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)] in the Amazon Web Services Key + // Management Service (Amazon Web Services KMS) documentation. + // + // [Key identifiers (KeyID)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id VolumeKmsKeyId *string // Inference Recommender provisions SageMaker endpoints with access to VPC in the @@ -12813,15 +14475,30 @@ type RecommendationJobOutputConfig struct { // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service // (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your 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/" - // - // 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. + // 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)] in the Amazon Web Services Key + // Management Service (Amazon Web Services KMS) documentation. + // + // [Key identifiers (KeyID)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id KmsKeyId *string noSmithyDocumentSerde @@ -12917,18 +14594,22 @@ 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 - // instance. NaN indicates that the value is not available. + // instance. + // + // NaN indicates that the value is not available. MemoryUtilization *float32 // The time it takes to launch new compute resources for a serverless endpoint. // The time can vary depending on the model size, how long it takes to download the - // model, and the start-up time of the container. NaN indicates that the value is - // not available. + // model, and the start-up time of the container. + // + // NaN indicates that the value is not available. ModelSetupTime *int32 noSmithyDocumentSerde @@ -12992,11 +14673,11 @@ type RegisterModelStepMetadata struct { noSmithyDocumentSerde } -// Configuration for remote debugging for the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) -// API. To learn more about the remote debugging functionality of SageMaker, see -// Access a training container through Amazon Web Services Systems Manager (SSM) -// for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html) -// . +// Configuration for remote debugging for the [CreateTrainingJob] API. To learn more about the remote +// debugging functionality of SageMaker, see [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]. +// +// [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html +// [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html type RemoteDebugConfig struct { // If set to True, enables remote debugging. @@ -13005,11 +14686,11 @@ type RemoteDebugConfig struct { noSmithyDocumentSerde } -// Configuration for remote debugging for the UpdateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateTrainingJob.html) -// API. To learn more about the remote debugging functionality of SageMaker, see -// Access a training container through Amazon Web Services Systems Manager (SSM) -// for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html) -// . +// Configuration for remote debugging for the [UpdateTrainingJob] API. To learn more about the remote +// debugging functionality of SageMaker, see [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]. +// +// [UpdateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateTrainingJob.html +// [Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html type RemoteDebugConfigForUpdate struct { // If set to True, enables remote debugging. @@ -13058,8 +14739,9 @@ 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) - // in the Amazon Web Services Lambda Developer Guide. + // Services Lambda function, see [Create a Lambda function with the console]in the Amazon Web Services Lambda Developer Guide. + // + // [Create a Lambda function with the console]: https://docs.aws.amazon.com/lambda/latest/dg/getting-started-create-function.html // // This member is required. RepositoryCredentialsProviderArn *string @@ -13083,29 +14765,31 @@ type ResolvedAttributes struct { noSmithyDocumentSerde } -// A resource catalog containing all of the resources of a specific resource type +// A resource catalog containing all of the resources of a specific resource type +// // within a resource owner account. For an example on sharing the Amazon SageMaker -// Feature Store DefaultFeatureGroupCatalog , see Share Amazon SageMaker Catalog -// resource type (https://docs.aws.amazon.com/sagemaker/latest/APIReference/feature-store-cross-account-discoverability-share-sagemaker-catalog.html) -// in the Amazon SageMaker Developer Guide. +// Feature Store DefaultFeatureGroupCatalog , see [Share Amazon SageMaker Catalog resource type] in the Amazon SageMaker +// Developer Guide. +// +// [Share Amazon SageMaker Catalog resource type]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/feature-store-cross-account-discoverability-share-sagemaker-catalog.html type ResourceCatalog struct { - // The time the ResourceCatalog was created. + // The time the ResourceCatalog was created. // // This member is required. CreationTime *time.Time - // A free form description of the ResourceCatalog . + // A free form description of the ResourceCatalog . // // This member is required. Description *string - // The Amazon Resource Name (ARN) of the ResourceCatalog . + // The Amazon Resource Name (ARN) of the ResourceCatalog . // // This member is required. ResourceCatalogArn *string - // The name of the ResourceCatalog . + // The name of the ResourceCatalog . // // This member is required. ResourceCatalogName *string @@ -13117,26 +14801,34 @@ type ResourceCatalog 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. - // 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 - // 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) + // 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], 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 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]. + // + // 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] // . // + // [NVMe SSD volumes]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes + // [Amazon EC2 Instance Types]: http://aws.amazon.com/ec2/instance-types/ + // [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 @@ -13147,20 +14839,27 @@ 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 + // 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](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. + // + // [Amazon EC2 P4de instances]: http://aws.amazon.com/ec2/instance-types/p4/ InstanceType TrainingInstanceType // The duration of time in seconds to retain configured resources in a warm pool @@ -13169,17 +14868,28 @@ type ResourceConfig struct { // The Amazon Web Services KMS key that SageMaker uses to encrypt data on the // storage volume attached to the ML compute instance(s) that run the training job. + // // 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 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" + // local storage. + // + // For a list of instance types that support local instance storage, see [Instance Store Volumes]. + // + // For more information about local instance storage encryption, see [SSD Instance Store Volumes]. + // + // 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" + // + // "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // + // [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 VolumeKmsKeyId *string noSmithyDocumentSerde @@ -13220,13 +14930,15 @@ type ResourceLimits struct { // instance type that the version runs on. 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. + // 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. InstanceType AppInstanceType - // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the + // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the // Resource. LifecycleConfigArn *string @@ -13247,7 +14959,9 @@ type ResourceSpec struct { type RetentionPolicy struct { // The default is Retain , which specifies to keep the data stored on the Amazon - // EFS volume. Specify Delete to delete the data stored on the Amazon EFS volume. + // EFS volume. + // + // Specify Delete to delete the data stored on the Amazon EFS volume. HomeEfsFileSystem RetentionType noSmithyDocumentSerde @@ -13369,41 +15083,69 @@ type RStudioServerProDomainSettingsForUpdate struct { noSmithyDocumentSerde } -// Describes the S3 data source. Your input bucket must be in the same Amazon Web -// Services region as your training job. +// Describes the S3 data source. +// +// Your input bucket must be in the same Amazon Web Services region as your +// training job. type S3DataSource struct { // 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 + // objects that match the specified key name prefix for model training. + // + // 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. 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 . + // 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 . // // This member is required. S3DataType S3DataType // 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-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. + // + // - 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. + // // Your input bucket must be located in same Amazon Web Services region as your // training job. // @@ -13418,19 +15160,23 @@ 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 - // 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 - // 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 - // than available S3 objects. If you do, some nodes won't get any data and you will - // 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 - // number of objects. + // 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 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 than available S3 objects. + // If you do, some nodes won't get any data and you will 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 number of objects. S3DataDistributionType S3DataDistribution noSmithyDocumentSerde @@ -13439,31 +15185,45 @@ type S3DataSource struct { // Specifies the S3 location of ML model data to deploy. type S3ModelDataSource struct { - // Specifies how the ML model data is prepared. If you choose Gzip and choose - // S3Object as the value of S3DataType , S3Uri identifies an object that is a - // gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the - // object during model deployment. If you choose None and chooose S3Object as the - // value of S3DataType , S3Uri identifies an object that represents an - // uncompressed ML model to deploy. If you choose None and choose S3Prefix as the - // value of S3DataType , S3Uri identifies a key name prefix, under which all - // objects represents the uncompressed ML model to deploy. If you choose None, then - // SageMaker will follow rules below when creating model data files under - // /opt/ml/model directory for use by your inference code: + // Specifies how the ML model data is prepared. + // + // If you choose Gzip and choose S3Object as the value of S3DataType , S3Uri + // identifies an object that is a gzip-compressed TAR archive. SageMaker will + // attempt to decompress and untar the object during model deployment. + // + // If you choose None and chooose S3Object as the value of S3DataType , S3Uri + // identifies an object that represents an uncompressed ML model to deploy. + // + // If you choose None and choose S3Prefix as the value of S3DataType , S3Uri + // identifies a key name prefix, under which all objects represents the + // uncompressed ML model to deploy. + // + // If you choose None, then SageMaker will follow rules below when creating model + // data files under /opt/ml/model directory for use by your inference code: + // // - If you choose S3Object as the value of S3DataType , then SageMaker will // split the key of the S3 object referenced by S3Uri by slash (/), and use the // last part as the filename of the file holding the content of the S3 object. + // // - If you choose S3Prefix as the value of S3DataType , then for each S3 object // under the key name pefix referenced by S3Uri , SageMaker will trim its key by // the prefix, and use the remainder as the path (relative to /opt/ml/model ) of // the file holding the content of the S3 object. SageMaker will split the // remainder by slash (/), using intermediate parts as directory names and the last // part as filename of the file holding the content of the S3 object. + // // - Do not use any of the following as file names or directory names: + // // - An empty or blank string + // // - A string which contains null bytes + // // - A string longer than 255 bytes + // // - A single dot ( . ) + // // - A double dot ( .. ) + // // - Ambiguous file names will result in model deployment failure. For example, // if your uncompressed ML model consists of two S3 objects // s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you @@ -13471,21 +15231,27 @@ type S3ModelDataSource struct { // of S3DataType , then it will result in name clash between // /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a // directory). - // - Do not organize the model artifacts in S3 console using folders (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html) - // . When you create a folder in S3 console, S3 creates a 0-byte object with a key - // set to the folder name you provide. They key of the 0-byte object ends with a - // slash (/) which violates SageMaker restrictions on model artifact file names, - // leading to model deployment failure. + // + // - Do not organize the model artifacts in [S3 console using folders]. When you create a folder in S3 + // console, S3 creates a 0-byte object with a key set to the folder name you + // provide. They key of the 0-byte object ends with a slash (/) which violates + // SageMaker restrictions on model artifact file names, leading to model deployment + // failure. + // + // [S3 console using folders]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html // // This member is required. CompressionType ModelCompressionType - // Specifies the type of ML model data to deploy. If you choose S3Prefix , S3Uri - // identifies a key name prefix. SageMaker uses all objects that match the - // specified key name prefix as part of the ML model data to deploy. A valid key - // name prefix identified by S3Uri always ends with a forward slash (/). If you - // choose S3Object , S3Uri identifies an object that is the ML model data to - // deploy. + // Specifies the type of ML model data to deploy. + // + // If you choose S3Prefix , S3Uri identifies a key name prefix. SageMaker uses all + // objects that match the specified key name prefix as part of the ML model data to + // deploy. A valid key name prefix identified by S3Uri always ends with a forward + // slash (/). + // + // If you choose S3Object , S3Uri identifies an object that is the ML model data + // to deploy. // // This member is required. S3DataType S3ModelDataType @@ -13509,16 +15275,19 @@ type S3ModelDataSource struct { // 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 // 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 : + // 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" KmsKeyId *string @@ -13580,26 +15349,45 @@ type ScalingPolicyObjective struct { // Configuration details about the monitoring schedule. type ScheduleConfig struct { - // A cron expression that describes details about the monitoring schedule. The - // supported cron expressions are: - // - If you want to set the job to start every hour, use the following: Hourly: - // cron(0 * ? * * *) - // - If you want to start the job daily: cron(0 [00-23] ? * * *) - // - If you want to run the job one time, immediately, use the following - // keyword: NOW + // A cron expression that describes details about the monitoring schedule. + // + // The supported cron expressions are: + // + // - If you want to set the job to start every hour, use the following: + // + // Hourly: cron(0 * ? * * *) + // + // - If you want to start the job daily: + // + // cron(0 [00-23] ? * * *) + // + // - If you want to run the job one time, immediately, use the following keyword: + // + // NOW + // // 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: + // + // 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. + // // You can also specify the keyword NOW to run the monitoring job immediately, one // time, without recurring. // @@ -13610,10 +15398,13 @@ type ScheduleConfig struct { // to the times that you schedule your monitoring jobs to run. You schedule // monitoring jobs with the ScheduleExpression parameter. Specify this offset in // ISO 8601 duration format. For example, if you want to end the window one hour - // before the start of each monitoring job, you would specify: "-PT1H" . The end - // time that you specify must not follow the start time that you specify by more - // than 24 hours. You specify the start time with the DataAnalysisStartTime - // parameter. If you set ScheduleExpression to NOW , this parameter is required. + // before the start of each monitoring job, you would specify: "-PT1H" . + // + // The end time that you specify must not follow the start time that you specify + // by more than 24 hours. You specify the start time with the DataAnalysisStartTime + // parameter. + // + // If you set ScheduleExpression to NOW , this parameter is required. DataAnalysisEndTime *string // Sets the start time for a monitoring job window. Express this time as an offset @@ -13621,10 +15412,13 @@ type ScheduleConfig struct { // monitoring jobs with the ScheduleExpression parameter. Specify this offset in // ISO 8601 duration format. For example, if you want to monitor the five hours of // data in your dataset that precede the start of each monitoring job, you would - // specify: "-PT5H" . The start time that you specify must not precede the end time - // that you specify by more than 24 hours. You specify the end time with the - // DataAnalysisEndTime parameter. If you set ScheduleExpression to NOW , this - // parameter is required. + // specify: "-PT5H" . + // + // The start time that you specify must not precede the end time that you specify + // by more than 24 hours. You specify the end time with the DataAnalysisEndTime + // parameter. + // + // If you set ScheduleExpression to NOW , this parameter is required. DataAnalysisStartTime *string noSmithyDocumentSerde @@ -13634,14 +15428,19 @@ type ScheduleConfig struct { // search. All resource objects that satisfy the expression's condition are // 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 . type SearchExpression struct { @@ -13664,8 +15463,9 @@ type SearchExpression struct { noSmithyDocumentSerde } -// A single resource returned as part of the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API response. +// A single resource returned as part of the [Search] API response. +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type SearchRecord struct { // A hosted endpoint for real-time inference. @@ -13720,13 +15520,15 @@ type SearchRecord struct { noSmithyDocumentSerde } -// An array element of SecondaryStatusTransitions for DescribeTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html) -// . 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 -// are a number of intermediate states. For example, within the starting state, -// SageMaker could be starting the training job or launching the ML instances. -// These transitional states are referred to as the job's secondary status. +// An array element of SecondaryStatusTransitions for [DescribeTrainingJob]. 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 are a number of +// intermediate states. For example, within the starting state, SageMaker could be +// starting the training job or launching the ML instances. These transitional +// states are referred to as the job's secondary status. +// +// [DescribeTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html type SecondaryStatusTransition struct { // A timestamp that shows when the training job transitioned to the current @@ -13735,29 +15537,44 @@ 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 + // 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. + // // Failed // - 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. + // // Stopping // - Stopping - Stopping the training job. + // // We no longer support the following secondary statuses: + // // - LaunchingMLInstances + // // - PreparingTrainingStack + // // - DownloadingTrainingImage // // This member is required. @@ -13768,25 +15585,40 @@ type SecondaryStatusTransition struct { // ended. EndTime *time.Time - // A detailed description of the progress within a secondary status. SageMaker - // provides secondary statuses and status messages that apply to each of them: + // 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. + // // Training // - 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html) - // , and StatusMessage together. For example, at the start of a training job, you - // might see the following: + // 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 + // + // [DescribeTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrainingJob.html StatusMessage *string noSmithyDocumentSerde @@ -13814,11 +15646,13 @@ type SelectiveExecutionConfig struct { // The ARN from a reference execution of the current pipeline. Used to copy input // collaterals needed for the selected steps to run. The execution status of the - // pipeline can be either Failed or Success . This field is required if the steps - // you specify for SelectedSteps depend on output collaterals from any - // non-specified pipeline steps. For more information, see Selective Execution for - // Pipeline Steps (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html) - // . + // pipeline can be either Failed or Success . + // + // This field is required if the steps you specify for SelectedSteps depend on + // output collaterals from any non-specified pipeline steps. For more information, + // see [Selective Execution for Pipeline Steps]. + // + // [Selective Execution for Pipeline Steps]: https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html SourcePipelineExecutionArn *string noSmithyDocumentSerde @@ -13834,25 +15668,31 @@ type SelectiveExecutionResult struct { } // 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]. +// +// [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 @@ -13863,9 +15703,9 @@ type ServiceCatalogProvisionedProductDetails struct { } // 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) -// . +// information about service catalog, see [What is Amazon Web Services Service Catalog]. +// +// [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. @@ -13887,9 +15727,9 @@ type ServiceCatalogProvisioningDetails struct { } // 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) -// . +// information about service catalog, see [What is Amazon Web Services Service Catalog]. +// +// [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. @@ -13904,9 +15744,9 @@ type ServiceCatalogProvisioningUpdateDetails struct { // Contains information about attribute-based access control (ABAC) for a training // job. The session chaining configuration uses Amazon Security Token Service (STS) // for your training job to request temporary, limited-privilege credentials to -// tenants. For more information, see Attribute-based access control (ABAC) for -// multi-tenancy training (https://docs.aws.amazon.com/sagemaker/latest/dg/model-access-training-data.html#model-access-training-data-abac) -// . +// tenants. For more information, see [Attribute-based access control (ABAC) for multi-tenancy training]. +// +// [Attribute-based access control (ABAC) for multi-tenancy training]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-access-training-data.html#model-access-training-data-abac type SessionChainingConfig struct { // Set to True to allow SageMaker to extract session tags from a training job @@ -13917,7 +15757,8 @@ type SessionChainingConfig struct { noSmithyDocumentSerde } -// The configuration of ShadowMode inference experiment type, which specifies a +// The configuration of ShadowMode inference experiment type, which specifies a +// // production variant to take all the inference requests, and a shadow variant to // which Amazon SageMaker replicates a percentage of the inference requests. For // the shadow variant it also specifies the percentage of requests that Amazon @@ -13929,7 +15770,7 @@ type ShadowModeConfig struct { // This member is required. ShadowModelVariants []ShadowModelVariantConfig - // The name of the production variant, which takes all the inference requests. + // The name of the production variant, which takes all the inference requests. // // This member is required. SourceModelVariantName *string @@ -13940,7 +15781,7 @@ type ShadowModeConfig struct { // The name and sampling percentage of a shadow variant. type ShadowModelVariantConfig struct { - // The percentage of inference requests that Amazon SageMaker replicates from the + // The percentage of inference requests that Amazon SageMaker replicates from the // production variant to the shadow variant. // // This member is required. @@ -13981,13 +15822,15 @@ type SharingSettings struct { // 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 , -// 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. +// 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 , 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 { // Determines the shuffling order in ShuffleConfig value. @@ -14015,8 +15858,10 @@ type SourceAlgorithm struct { // 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 - // Amazon Web Services region as the algorithm. + // .tar.gz suffix). + // + // The model artifacts must be in an S3 bucket that is in the same Amazon Web + // Services region as the algorithm. ModelDataUrl *string noSmithyDocumentSerde @@ -14033,15 +15878,22 @@ 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] ). 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. +// +// [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html 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] (CIDR) values. + // + // Maximum: Ten CIDR values + // + // The following Length Constraints apply to individual CIDR values in the CIDR + // value list. + // + // [Classless Inter-Domain Routing]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html // // This member is required. Cidrs []string @@ -14178,7 +16030,9 @@ type SpaceStorageSettings struct { // Defines the stairs traffic pattern for an Inference Recommender load test. This // pattern type consists of multiple steps where the number of users increases at -// each step. Specify either the stairs or phases traffic pattern. +// each step. +// +// Specify either the stairs or phases traffic pattern. type Stairs struct { // Defines how long each traffic step should be. @@ -14196,18 +16050,22 @@ type Stairs struct { // Specifies a limit to how long a model training job or model compilation job can // run. It also specifies how long a managed spot training job has to complete. // When the job reaches the time limit, SageMaker ends the training or compilation -// job. Use this API to cap model training costs. To stop a training job, SageMaker -// sends the algorithm the SIGTERM signal, which delays job termination for 120 -// seconds. Algorithms can use this 120-second window to save the model artifacts, -// so the results of training are not lost. The training algorithms provided by -// SageMaker automatically save the intermediate results of a model training job -// when possible. This attempt to save artifacts is only a best effort case as -// 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 -// saving intermediate model artifacts. When training NTMs, make sure that the -// maximum runtime is sufficient for the training job to complete. +// job. Use this API to cap model training costs. +// +// To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which +// delays job termination for 120 seconds. Algorithms can use this 120-second +// window to save the model artifacts, so the results of training are not lost. +// +// The training algorithms provided by SageMaker automatically save the +// intermediate results of a model training job when possible. This attempt to save +// artifacts is only a best effort case as 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 saving intermediate +// model artifacts. When training NTMs, make sure that the maximum runtime is +// sufficient for the training job to complete. type StoppingCondition struct { // The maximum length of time, in seconds, that a training or compilation job can @@ -14215,24 +16073,32 @@ type StoppingCondition struct { MaxPendingTimeInSeconds *int32 // The maximum length of time, in seconds, that a training or compilation job can - // run before it is stopped. For compilation jobs, if the job does not complete - // 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 - // archiving and uploading models after it has been stopped, is 30 days. + // run before it is stopped. + // + // For compilation jobs, if the job does not complete 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 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 - // 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. + // 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. MaxWaitTimeInSeconds *int32 noSmithyDocumentSerde @@ -14251,7 +16117,7 @@ type StudioLifecycleConfigDetails struct { // The App type to which the Lifecycle Configuration is attached. StudioLifecycleConfigAppType StudioLifecycleConfigAppType - // The Amazon Resource Name (ARN) of the Lifecycle Configuration. + // The Amazon Resource Name (ARN) of the Lifecycle Configuration. StudioLifecycleConfigArn *string // The name of the Amazon SageMaker Studio Lifecycle Configuration. @@ -14283,8 +16149,10 @@ type SubscribedWorkteam struct { noSmithyDocumentSerde } -// Specified in the GetSearchSuggestions (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_GetSearchSuggestions.html) -// request. Limits the property names that are included in the response. +// Specified in the [GetSearchSuggestions] request. Limits the property names that are included in the +// response. +// +// [GetSearchSuggestions]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_GetSearchSuggestions.html type SuggestionQuery struct { // Defines a property name hint. Only property names that begin with the specified @@ -14313,21 +16181,32 @@ type TabularJobConfig struct { // A URL to the Amazon S3 data source containing selected features from the input // data source to run an Autopilot job V2. 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 - // 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. + // (optional) in JSON format as shown below: + // + // { "FeatureAttributeNames":["col1", "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. FeatureSpecificationS3Uri *string // Generates possible candidates without training the models. A model candidate is @@ -14338,37 +16217,48 @@ type TabularJobConfig 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-support) - // 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-support) - // for a list of algorithms supported by HYPERPARAMETER_TUNING mode. + // 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] + // 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]for a list of algorithms supported by + // HYPERPARAMETER_TUNING mode. + // + // [Autopilot algorithm support]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support Mode AutoMLMode // The type of supervised learning problem available for the model candidates of - // the AutoML job V2. For more information, see SageMaker Autopilot problem types (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types) - // . You must either specify the type of supervised learning problem in ProblemType - // and provide the AutoMLJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html#sagemaker-CreateAutoMLJobV2-request-AutoMLJobObjective) - // metric, or none at all. + // the AutoML job V2. For more information, see [SageMaker Autopilot problem types]. + // + // You must either specify the type of supervised learning problem in ProblemType + // and provide the [AutoMLJobObjective]metric, or none at all. + // + // [SageMaker Autopilot problem types]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types + // [AutoMLJobObjective]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html#sagemaker-CreateAutoMLJobV2-request-AutoMLJobObjective ProblemType ProblemType // If specified, this column name indicates which column of the dataset should be // treated as sample weights for use by the objective metric during the training, // evaluation, and the selection of the best model. This column is not considered - // as a predictive feature. For more information on Autopilot metrics, see Metrics - // and validation (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html) - // . Sample weights should be numeric, non-negative, with larger values indicating + // as a predictive feature. For more information on Autopilot metrics, see [Metrics and validation]. + // + // Sample weights should be numeric, non-negative, with larger values indicating // which rows are more important than others. Data points that have invalid or no - // weight value are excluded. Support for sample weights is available in Ensembling (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html) - // mode only. + // weight value are excluded. + // + // Support for sample weights is available in [Ensembling] mode only. + // + // [Ensembling]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html + // [Metrics and validation]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html SampleWeightAttributeName *string noSmithyDocumentSerde @@ -14379,24 +16269,29 @@ type TabularResolvedAttributes struct { // The type of supervised learning problem available for the model candidates of // the AutoML job V2 (Binary Classification, Multiclass Classification, - // Regression). For more information, see SageMaker Autopilot problem types (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types) - // . + // Regression). For more information, see [SageMaker Autopilot problem types]. + // + // [SageMaker Autopilot problem types]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types ProblemType ProblemType noSmithyDocumentSerde } // A tag object that consists of a key and an optional value, used to manage -// 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html) -// . 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) -// . +// 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 more information on adding metadata to your Amazon Web Services resources +// with tagging, see [Tagging Amazon Web Services resources]. 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]. +// +// [Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy]: https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf +// [AddTags]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html +// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html type Tag struct { // The tag key. Tag keys must be unique per resource. @@ -14418,17 +16313,24 @@ type Tag struct { 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. // // 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} @@ -14437,9 +16339,12 @@ type TargetPlatform struct { 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 Accelerator TargetPlatformAccelerator @@ -14447,9 +16352,12 @@ type TargetPlatform struct { } // A target tracking scaling policy. Includes support for predefined or customized -// metrics. When using the PutScalingPolicy (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html) -// API, this parameter is required when you are creating a policy with the policy -// type TargetTrackingScaling . +// metrics. +// +// When using the [PutScalingPolicy] API, this parameter is required when you are creating a policy +// with the policy type TargetTrackingScaling . +// +// [PutScalingPolicy]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScalingPolicy.html type TargetTrackingScalingPolicyConfiguration struct { // An object containing information about a metric. @@ -14512,16 +16420,21 @@ type TextClassificationJobConfig struct { } // The collection of settings used by an AutoML job V2 for the text generation -// problem type. The text generation models that support fine-tuning in Autopilot -// are currently accessible exclusively in regions supported by Canvas. Refer to -// the documentation of Canvas for the full list of its supported Regions (https://docs.aws.amazon.com/sagemaker/latest/dg/canvas.html) -// . +// problem type. +// +// The text generation models that support fine-tuning in Autopilot are currently +// accessible exclusively in regions supported by Canvas. Refer to the +// documentation of Canvas for the [full list of its supported Regions]. +// +// [full list of its supported Regions]: https://docs.aws.amazon.com/sagemaker/latest/dg/canvas.html type TextGenerationJobConfig struct { // The name of the base model to fine-tune. Autopilot supports fine-tuning a // variety of large language models. For information on the list of supported - // models, see Text generation models supporting fine-tuning in Autopilot (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-models.html#autopilot-llms-finetuning-supported-llms) - // . If no BaseModelName is provided, the default model used is Falcon7BInstruct. + // models, see [Text generation models supporting fine-tuning in Autopilot]. If no BaseModelName is provided, the default model used is + // Falcon7BInstruct. + // + // [Text generation models supporting fine-tuning in Autopilot]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-models.html#autopilot-llms-finetuning-supported-llms BaseModelName *string // How long a fine-tuning job is allowed to run. For TextGenerationJobConfig @@ -14532,36 +16445,44 @@ type TextGenerationJobConfig struct { // The access configuration file to control access to the ML model. You can // explicitly accept the model end-user license agreement (EULA) within the // ModelAccessConfig . - // - If you are a Jumpstart user, see the End-user license agreements (https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula) - // section for more details on accepting the EULA. + // + // - If you are a Jumpstart user, see the [End-user license agreements]section for more details on accepting + // the EULA. + // // - If you are an AutoML user, see the Optional Parameters section of Create an - // AutoML job to fine-tune text generation models using the API for details on - // How to set the EULA acceptance when fine-tuning a model using the AutoML API (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params) - // . + // AutoML job to fine-tune text generation models using the API for details on [How to set the EULA acceptance when fine-tuning a model using the AutoML API]. + // + // [End-user license agreements]: https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula + // [How to set the EULA acceptance when fine-tuning a model using the AutoML API]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params ModelAccessConfig *ModelAccessConfig // The hyperparameters used to configure and optimize the learning process of the // base model. You can set any combination of the following hyperparameters for all - // base models. For more information on each supported hyperparameter, see - // Optimize the learning process of your text generation models with - // hyperparameters (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-set-hyperparameters.html) - // . + // base models. For more information on each supported hyperparameter, see [Optimize the learning process of your text generation models with hyperparameters]. + // // - "epochCount" : The number of times the model goes through the entire // training dataset. Its value should be a string containing an integer value // within the range of "1" to "10". + // // - "batchSize" : The number of data samples used in each iteration of training. // Its value should be a string containing an integer value within the range of "1" // to "64". + // // - "learningRate" : The step size at which a model's parameters are updated // during training. Its value should be a string containing a floating-point value // within the range of "0" to "1". + // // - "learningRateWarmupSteps" : The number of training steps during which the // learning rate gradually increases before reaching its target or maximum value. // Its value should be a string containing an integer value within the range of "0" // to "250". - // Here is an example where all four hyperparameters are configured. { - // "epochCount":"5", "learningRate":"0.5", "batchSize": "32", - // "learningRateWarmupSteps": "10" } + // + // Here is an example where all four hyperparameters are configured. + // + // { "epochCount":"5", "learningRate":"0.5", "batchSize": "32", + // "learningRateWarmupSteps": "10" } + // + // [Optimize the learning process of your text generation models with hyperparameters]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-set-hyperparameters.html TextGenerationHyperParameters map[string]string noSmithyDocumentSerde @@ -14584,9 +16505,12 @@ type TextGenerationResolvedAttributes struct { // only once in a 24 hour period. With provisioned throughput mode, you specify the // read and write capacity per second that you expect your application to require, // and you are billed based on those limits. Exceeding provisioned throughput will -// result in your requests being throttled. Note: PROVISIONED throughput mode is -// supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) -// tier online store. +// result in your requests being throttled. +// +// Note: PROVISIONED throughput mode is supported only for feature groups that are +// offline-only, or use the [Standard]Standard tier online store. +// +// [Standard]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType type ThroughputConfig struct { // The mode used for your feature group throughput: ON_DEMAND or PROVISIONED . @@ -14594,14 +16518,16 @@ type ThroughputConfig struct { // This member is required. ThroughputMode ThroughputMode - // For provisioned feature groups with online store enabled, this indicates the - // read throughput you are billed for and can consume without throttling. This - // field is not applicable for on-demand feature groups. + // For provisioned feature groups with online store enabled, this indicates the + // read throughput you are billed for and can consume without throttling. + // + // This field is not applicable for on-demand feature groups. ProvisionedReadCapacityUnits *int32 - // For provisioned feature groups, this indicates the write throughput you are - // billed for and can consume without throttling. This field is not applicable for - // on-demand feature groups. + // For provisioned feature groups, this indicates the write throughput you are + // billed for and can consume without throttling. + // + // This field is not applicable for on-demand feature groups. ProvisionedWriteCapacityUnits *int32 noSmithyDocumentSerde @@ -14615,9 +16541,12 @@ type ThroughputConfig struct { // only once in a 24 hour period. With provisioned throughput mode, you specify the // read and write capacity per second that you expect your application to require, // and you are billed based on those limits. Exceeding provisioned throughput will -// result in your requests being throttled. Note: PROVISIONED throughput mode is -// supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType) -// tier online store. +// result in your requests being throttled. +// +// Note: PROVISIONED throughput mode is supported only for feature groups that are +// offline-only, or use the [Standard]Standard tier online store. +// +// [Standard]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType type ThroughputConfigDescription struct { // The mode used for your feature group throughput: ON_DEMAND or PROVISIONED . @@ -14625,14 +16554,16 @@ type ThroughputConfigDescription struct { // This member is required. ThroughputMode ThroughputMode - // For provisioned feature groups with online store enabled, this indicates the - // read throughput you are billed for and can consume without throttling. This - // field is not applicable for on-demand feature groups. + // For provisioned feature groups with online store enabled, this indicates the + // read throughput you are billed for and can consume without throttling. + // + // This field is not applicable for on-demand feature groups. ProvisionedReadCapacityUnits *int32 - // For provisioned feature groups, this indicates the write throughput you are - // billed for and can consume without throttling. This field is not applicable for - // on-demand feature groups. + // For provisioned feature groups, this indicates the write throughput you are + // billed for and can consume without throttling. + // + // This field is not applicable for on-demand feature groups. ProvisionedWriteCapacityUnits *int32 noSmithyDocumentSerde @@ -14694,17 +16625,26 @@ type TimeSeriesConfig struct { // forecasting problem type. type TimeSeriesForecastingJobConfig struct { - // The frequency of predictions in a forecast. Valid intervals are an integer - // followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). - // For example, 1D indicates every day and 15min indicates every 15 minutes. The - // value of a frequency must not overlap with the next larger frequency. For - // example, you must use a frequency of 1H instead of 60min . The valid values for - // each frequency are the following: + // The frequency of predictions in a forecast. + // + // Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D + // (Day), H (Hour), and min (Minute). For example, 1D indicates every day and 15min + // indicates every 15 minutes. The value of a frequency must not overlap with the + // next larger frequency. For example, you must use a frequency of 1H instead of + // 60min . + // + // 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 // // This member is required. @@ -14731,12 +16671,20 @@ type TimeSeriesForecastingJobConfig struct { // TimeSeriesConfig . When not provided, the AutoML job V2 includes all the columns // from the original dataset that are not already declared in TimeSeriesConfig . If // provided, the AutoML job V2 only considers these additional columns as a - // complement to the ones declared in TimeSeriesConfig . 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 the format shown below: { - // "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } } Autopilot - // supports the following data types: numeric , categorical , text , and datetime . + // complement to the ones declared in TimeSeriesConfig . + // + // 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 the format + // shown below: + // + // { "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } } + // + // Autopilot supports the following data types: numeric , categorical , text , and + // datetime . + // // These column keys must not include any column set in TimeSeriesConfig . FeatureSpecificationS3Uri *string @@ -14766,9 +16714,10 @@ type TimeSeriesForecastingSettings struct { // launches the Canvas application. 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) - // policy attached and forecast.amazonaws.com added in the trust relationship as a - // service principal. + // the [AmazonSageMakerCanvasForecastAccess]policy attached and forecast.amazonaws.com added in the trust relationship + // as a service principal. + // + // [AmazonSageMakerCanvasForecastAccess]: https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess AmazonForecastRoleArn *string // Describes whether time series forecasting is enabled or disabled in the Canvas @@ -14785,19 +16734,27 @@ type TimeSeriesForecastingSettings struct { type TimeSeriesTransformations struct { // A key value pair defining the aggregation method for a column, where the key is - // the column name and the value is the aggregation method. The supported - // aggregation methods are sum (default), avg , first , min , max . Aggregation is - // only supported for the target column. + // the column name and the value is the aggregation method. + // + // The supported aggregation methods are sum (default), avg , first , min , max . + // + // Aggregation is only supported for the target column. Aggregation map[string]AggregationTransformationValue // A key value pair defining the filling method for a column, where the key is the // column name and the value is an object which defines the filling logic. You can - // specify multiple filling methods for a single column. The supported filling - // methods and their corresponding options are: + // specify multiple filling methods for a single column. + // + // The supported filling methods and their corresponding options are: + // // - frontfill : none (Supported only for target column) + // // - 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 the // chosen filling method value (for example "backfill" : "value" ), and define the // filling value in an additional parameter prefixed with "_value". For example, to @@ -14828,10 +16785,13 @@ 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. // @@ -14894,9 +16854,9 @@ 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) - // . + // configure the DebugHookConfig parameter, see [Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job]. + // + // [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 DebugHookConfig *DebugHookConfig // Information about the debug rule configuration. @@ -14913,9 +16873,9 @@ type TrainingJob struct { EnableInterContainerTrafficEncryption *bool // 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) - // . + // training jobs instead of on-demand instances. For more information, see [Managed Spot Training]. + // + // [Managed 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 @@ -14928,9 +16888,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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html ExperimentConfig *ExperimentConfig // If the training job failed, the reason it failed. @@ -14943,8 +16910,9 @@ type TrainingJob struct { // Algorithm-specific parameters. HyperParameters map[string]string - // An array of Channel objects that describes each data input channel. Your input - // must be in the same Amazon Web Services region as your training job. + // An array of Channel objects that describes each data input channel. + // + // Your input must be in the same Amazon Web Services region as your training job. InputDataConfig []Channel // The Amazon Resource Name (ARN) of the labeling job. @@ -14978,34 +16946,52 @@ type TrainingJob struct { // 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 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html) - // . SageMaker provides primary statuses and secondary statuses that apply to each - // of them: InProgress + // 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 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. + // // 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 . + // // 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: + // + // Valid values for SecondaryStatus are subject to change. + // + // We no longer support the following secondary statuses: + // // - LaunchingMLInstances + // // - PreparingTrainingStack + // // - DownloadingTrainingImage + // + // [SecondaryStatusTransition]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html SecondaryStatus SecondaryStatus // A history of all of the secondary statuses that the training job has @@ -15015,15 +17001,18 @@ type TrainingJob struct { // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches the // time limit, SageMaker ends the training job. Use this API to cap model training - // costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts, so the results of training are not lost. + // costs. + // + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window to + // save the model artifacts, so the results of training are not lost. StoppingCondition *StoppingCondition // 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]. + // + // [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 @@ -15043,13 +17032,21 @@ type TrainingJob struct { // The name of the training job. TrainingJobName *string - // The status of the training job. Training job statuses are: + // 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 . TrainingJobStatus TrainingJobStatus @@ -15067,10 +17064,11 @@ type TrainingJob struct { // the training job was launched by a hyperparameter tuning job. TuningJobArn *string - // A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html) - // 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) - // . + // 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]. + // + // [VpcConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html + // [Protect Training Jobs by Using an Amazon Virtual Private Cloud]: https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html VpcConfig *VpcConfig noSmithyDocumentSerde @@ -15099,35 +17097,53 @@ type TrainingJobDefinition struct { // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches the // time limit, SageMaker ends the training job. Use this API to cap model training - // costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts. + // costs. + // + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window to + // save the model artifacts. // // This member is required. 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 + // input modes, see [Algorithms]. + // + // 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. + // 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. + // + // [Algorithms]: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html // // This member is required. TrainingInputMode TrainingInputMode @@ -15196,7 +17212,7 @@ type TrainingJobSummary struct { // This member is required. TrainingJobStatus TrainingJobStatus - // Timestamp when the training job was last modified. + // Timestamp when the training job was last modified. LastModifiedTime *time.Time // A timestamp that shows when the training job ended. This field is set only if @@ -15309,29 +17325,35 @@ type TransformInput struct { // 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 - // TFRecord data (https://www.tensorflow.org/guide/data#consuming_tfrecord_data) in - // the TensorFlow documentation. + // 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] in the MXNet documentation. For more + // information about TFRecord , see [Consuming TFRecord data] in the TensorFlow documentation. + // + // [Create a Dataset Using RecordIO]: https://mxnet.apache.org/api/faq/recordio + // [Consuming TFRecord data]: https://www.tensorflow.org/guide/data#consuming_tfrecord_data SplitType SplitType noSmithyDocumentSerde } -// 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) -// . +// A batch transform job. For information about SageMaker batch transform, see [Use Batch Transform]. +// +// [Use 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. @@ -15354,9 +17376,9 @@ type TransformJob struct { // results in the output. The input filter provided allows you to exclude input // 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) - // . + // predictions in the output from the job. For more information, see [Associate Prediction Results with their Corresponding Input Records]. + // + // [Associate 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 @@ -15365,9 +17387,16 @@ type TransformJob struct { // Associates a SageMaker job as a trial component with an experiment and trial. // Specified when you call the following APIs: - // - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) - // - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html) - // - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html) + // + // [CreateProcessingJob] + // + // [CreateTrainingJob] + // + // [CreateTransformJob] + // + // [CreateTransformJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html + // [CreateTrainingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html + // [CreateProcessingJob]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html ExperimentConfig *ExperimentConfig // If the transform job failed, the reason it failed. @@ -15421,12 +17450,19 @@ type TransformJob struct { // The name of the transform job. TransformJobName *string - // The status of the transform job. Transform job statuses are: + // 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. TransformJobStatus TransformJobStatus @@ -15465,6 +17501,7 @@ type TransformJobDefinition struct { TransformResources *TransformResources // A string that determines the number of records included in a single mini-batch. + // // SingleRecord means only one record is used per mini-batch. MultiRecord means a // mini-batch is set to contain as many records that can fit within the // MaxPayloadInMB limit. @@ -15496,8 +17533,9 @@ type TransformJobStepMetadata struct { } // Provides a summary of a transform job. Multiple TransformJobSummary objects are -// returned as a list after in response to a ListTransformJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTransformJobs.html) -// call. +// returned as a list after in response to a [ListTransformJobs]call. +// +// [ListTransformJobs]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTransformJobs.html type TransformJobSummary struct { // A timestamp that shows when the transform Job was created. @@ -15539,9 +17577,10 @@ 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 - // object used as input for the transform job, batch transform stores the - // transformed data with an . out suffix in a corresponding subfolder in the + // 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 // 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 // the transformed data at @@ -15569,18 +17608,27 @@ type TransformOutput struct { // 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. + // for Amazon S3 for your role's account. For more information, see [KMS-Managed Encryption Keys]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]request. For more information, see [Using Key Policies in Amazon Web Services KMS] in the Amazon Web Services Key + // Management Service Developer Guide. + // + // [CreateModel]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html + // [KMS-Managed Encryption Keys]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html + // [Using Key Policies in Amazon Web Services KMS]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html KmsKeyId *string noSmithyDocumentSerde @@ -15606,20 +17654,30 @@ type TransformResources struct { // The Amazon Web Services Key Management Service (Amazon Web Services KMS) key // that Amazon SageMaker uses to encrypt model data on the storage volume attached - // to the ML compute instance(s) that run the batch transform job. 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 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: + // to the ML compute instance(s) that run the batch transform job. + // + // 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 VolumeKmsKeyId when using an instance type with + // local storage. + // + // For a list of instance types that support local instance storage, see [Instance Store Volumes]. + // + // For more information about local instance storage encryption, see [SSD Instance Store Volumes]. + // + // 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 + // + // [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 VolumeKmsKeyId *string noSmithyDocumentSerde @@ -15629,29 +17687,54 @@ type TransformResources struct { type TransformS3DataSource struct { // 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 + // 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 // containing a list of object keys that you want Amazon SageMaker to use for batch - // transform. The following values are compatible: ManifestFile , S3Prefix The - // following value is not compatible: AugmentedManifestFile + // 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 // 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-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. + // + // - 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 @@ -15659,8 +17742,9 @@ type TransformS3DataSource struct { noSmithyDocumentSerde } -// The properties of a trial as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API. +// The properties of a trial as returned by the [Search] API. +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type Trial struct { // Who created the trial. @@ -15689,8 +17773,10 @@ type Trial struct { // The source of the trial. Source *TrialSource - // The list of tags that are associated with the trial. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) - // API to search on the tags. + // The list of tags that are associated with the trial. You can use [Search] API to search + // on the tags. + // + // [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html Tags []Tag // The Amazon Resource Name (ARN) of the trial. @@ -15706,8 +17792,9 @@ type Trial struct { noSmithyDocumentSerde } -// The properties of a trial component as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) -// API. +// The properties of a trial component as returned by the [Search] API. +// +// [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html type TrialComponent struct { // Who created the trial component. @@ -15768,8 +17855,10 @@ type TrialComponent struct { // The status of the trial component. Status *TrialComponentStatus - // The list of tags that are associated with the component. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) - // API to search on the tags. + // The list of tags that are associated with the component. You can use [Search] API to + // search on the tags. + // + // [Search]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html Tags []Tag // The Amazon Resource Name (ARN) of the trial component. @@ -15783,10 +17872,13 @@ type TrialComponent struct { // Represents an input or output artifact of a trial component. You specify // TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts -// parameters in the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) -// request. Examples of input artifacts are datasets, algorithms, hyperparameters, -// source code, and instance types. Examples of output artifacts are metrics, -// snapshots, logs, and images. +// parameters in the [CreateTrialComponent]request. +// +// Examples of input artifacts are datasets, algorithms, hyperparameters, source +// code, and instance types. Examples of output artifacts are metrics, snapshots, +// logs, and images. +// +// [CreateTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html type TrialComponentArtifact struct { // The location of the artifact. @@ -15837,13 +17929,16 @@ type TrialComponentMetricSummary struct { } // The value of a hyperparameter. Only one of NumberValue or StringValue can be -// specified. This object is specified in the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) -// request. +// specified. +// +// This object is specified in the [CreateTrialComponent] request. // // The following types satisfy this interface: // // TrialComponentParameterValueMemberNumberValue // TrialComponentParameterValueMemberStringValue +// +// [CreateTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html type TrialComponentParameterValue interface { isTrialComponentParameterValue() } @@ -15936,8 +18031,9 @@ type TrialComponentStatus struct { } // A summary of the properties of a trial component. To get all the properties, -// call the DescribeTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html) -// API and provide the TrialComponentName . +// call the [DescribeTrialComponent]API and provide the TrialComponentName . +// +// [DescribeTrialComponent]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html type TrialComponentSummary struct { // Who created the trial component. @@ -15963,8 +18059,11 @@ type TrialComponentSummary struct { StartTime *time.Time // The status of the component. States include: + // // - InProgress + // // - Completed + // // - Failed Status *TrialComponentStatus @@ -15995,8 +18094,9 @@ type TrialSource struct { } // A summary of the properties of a trial. To get the complete set of properties, -// call the DescribeTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html) -// API and provide the TrialName . +// call the [DescribeTrial]API and provide the TrialName . +// +// [DescribeTrial]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html type TrialSummary struct { // When the trial was created. @@ -16023,8 +18123,9 @@ type TrialSummary struct { // Time to live duration, where the record is hard deleted after the expiration // time is reached; ExpiresAt = EventTime + TtlDuration . For information on -// HardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) -// API in the Amazon SageMaker API Reference guide. +// HardDelete, see the [DeleteRecord]API in the Amazon SageMaker API Reference guide. +// +// [DeleteRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html type TtlDuration struct { // TtlDuration time unit. @@ -16065,47 +18166,69 @@ type TuningJobStepMetaData struct { } // 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. +// 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 - // 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: - // 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. + // 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 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: + // + // 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. + // + // 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 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]. + // + // [Creating Your Custom Labeling Task Template]: https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step2.html UiTemplateS3Uri *string noSmithyDocumentSerde @@ -16192,10 +18315,11 @@ type UserProfileDetails struct { // A collection of settings that apply to users in a domain. 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 . +// 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 . type UserSettings struct { // The Canvas app settings. @@ -16213,10 +18337,11 @@ type UserSettings struct { // The default experience that the user is directed to when accessing the domain. // The supported values are: + // // - studio:: : Indicates that Studio is the default experience. This value can // only be passed if StudioWebPortal is set to ENABLED . - // - app:JupyterServer: : Indicates that Studio Classic is the default - // experience. + // + // - app:JupyterServer: : Indicates that Studio Classic is the default experience. DefaultLandingUri *string // The execution role for the user. @@ -16239,13 +18364,17 @@ type UserSettings struct { RStudioServerProAppSettings *RStudioServerProAppSettings // The security groups for the Amazon Virtual Private Cloud (VPC) that the domain - // uses for communication. Optional when the CreateDomain.AppNetworkAccessType - // parameter is set to PublicInternetOnly . Required when the - // CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified - // as part of the DefaultUserSettings for the domain. Amazon SageMaker adds a - // security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the - // number of security groups that you can specify is one less than the maximum - // number shown. + // uses for communication. + // + // Optional when the CreateDomain.AppNetworkAccessType parameter is set to + // PublicInternetOnly . + // + // Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly + // , unless specified as part of the DefaultUserSettings for the domain. + // + // Amazon SageMaker adds a security group to allow NFS traffic from Amazon + // SageMaker Studio. Therefore, the number of security groups that you can specify + // is one less than the maximum number shown. SecurityGroups []string // Specifies options for sharing Amazon SageMaker Studio notebooks. @@ -16264,24 +18393,28 @@ type UserSettings struct { noSmithyDocumentSerde } -// Specifies a production variant property type for an Endpoint. If you are -// updating an endpoint with the RetainAllVariantProperties option of -// UpdateEndpointInput (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) +// Specifies a production variant property type for an Endpoint. +// +// If you are updating an endpoint with the RetainAllVariantProperties option of [UpdateEndpointInput] // set to true , the VariantProperty objects listed in the -// ExcludeRetainedVariantProperties parameter of UpdateEndpointInput (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html) -// override the existing variant properties of the endpoint. +// ExcludeRetainedVariantProperties parameter of [UpdateEndpointInput] override the existing variant +// properties of the endpoint. +// +// [UpdateEndpointInput]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html type VariantProperty struct { // The type of variant property. The supported values are: + // // - DesiredInstanceCount : Overrides the existing variant instance counts using - // the InitialInstanceCount values in the ProductionVariants of - // CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) - // . + // the InitialInstanceCount values in the ProductionVariants of [CreateEndpointConfig]. + // // - DesiredWeight : Overrides the existing variant weights using the - // InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) - // . + // InitialVariantWeight values in the ProductionVariants of [CreateEndpointConfig]. + // // - DataCaptureConfig : (Not currently supported.) // + // [CreateEndpointConfig]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html + // // This member is required. VariantPropertyType VariantPropertyType @@ -16335,9 +18468,9 @@ type VisibilityConditions struct { // Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, // hosted models, and compute resources have access to. You can control access to -// and from your resources by configuring a VPC. For more information, see Give -// SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) -// . +// and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC]. +// +// [Give SageMaker Access to Resources in your Amazon VPC]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html type VpcConfig struct { // The VPC security group IDs, in the form sg-xxxxxxxx . Specify the security @@ -16348,8 +18481,9 @@ type VpcConfig struct { // 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]. + // + // [Supported Instance Types and Availability Zones]: https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html // // This member is required. Subnets []string @@ -16361,9 +18495,13 @@ 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 . @@ -16372,10 +18510,12 @@ type WarmPoolStatus struct { 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 - // compute time SageMaker bills you if you run warm pool training. The formula is - // as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount . + // absolute wall-clock time. + // + // Multiply ResourceRetainedBillableTimeInSeconds by the 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 . ResourceRetainedBillableTimeInSeconds *int32 // The name of the matching training job that reused the warm pool. @@ -16388,8 +18528,9 @@ 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]. +// +// [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. @@ -16403,8 +18544,9 @@ 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]. + // + // [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. @@ -16413,17 +18555,20 @@ type Workforce struct { // The reason your workforce failed. FailureReason *string - // The most recent date that UpdateWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html) - // 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. + // The most recent date that [UpdateWorkforce] was used to successfully add one or more IP address + // ranges ([CIDRs] ) to a private workforce's allow list. + // + // [UpdateWorkforce]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html + // [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html 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] ) to be added to the workforce allow + // list. By default, a workforce isn't restricted to specific IP addresses. + // + // [CIDRs]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html SourceIpConfig *SourceIpConfig // The status of your workforce. @@ -16506,10 +18651,12 @@ type Workteam struct { Description *string // 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 . + // 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 . // // This member is required. MemberDefinitions []MemberDefinition diff --git a/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go b/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go index 4408193213b..20d452ab63b 100644 --- a/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go +++ b/service/sagemakera2iruntime/api_op_DeleteHumanLoop.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified human loop for a flow definition. If the human loop was -// deleted, this operation will return a ResourceNotFoundException . +// Deletes the specified human loop for a flow definition. +// +// If the human loop was 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 7de4e931de2..c0046230882 100644 --- a/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go +++ b/service/sagemakera2iruntime/api_op_DescribeHumanLoop.go @@ -68,8 +68,9 @@ type DescribeHumanLoopOutput struct { // This member is required. HumanLoopStatus types.HumanLoopStatus - // A failure code that identifies the type of failure. Possible values: - // ValidationError , Expired , InternalError + // A failure code that identifies the type of failure. + // + // Possible values: ValidationError , Expired , InternalError FailureCode *string // The reason why a human loop failed. The failure reason is returned when the diff --git a/service/sagemakera2iruntime/doc.go b/service/sagemakera2iruntime/doc.go index 0593e05e904..f6b8730b8a9 100644 --- a/service/sagemakera2iruntime/doc.go +++ b/service/sagemakera2iruntime/doc.go @@ -8,24 +8,30 @@ // high degree of confidence, human reviewers can take over. This human review is // 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 -// about API actions and data types that you can use to interact with Amazon A2I -// programmatically. Use this guide to: +// loop. +// +// For information about these resources and prerequisites for using Amazon A2I, +// see [Get Started with Amazon Augmented AI]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. +// built-in task types, see [Use Task Types]. To learn how to start a human loop using this API, +// see [Create and Start a Human Loop for a Custom Task Type]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. +// learn more, see [Monitor and Manage Your Human Loop]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. +// see [Use APIs in Amazon A2I]in the Amazon SageMaker Developer Guide. +// +// [Use APIs in Amazon A2I]: https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html +// [Get Started with Amazon Augmented AI]: https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html +// [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 +// [Use Task Types]: https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html +// [Monitor and Manage Your Human Loop]: https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html package sagemakera2iruntime diff --git a/service/sagemakera2iruntime/options.go b/service/sagemakera2iruntime/options.go index 99b41f4717e..12d6d870d01 100644 --- a/service/sagemakera2iruntime/options.go +++ b/service/sagemakera2iruntime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemakera2iruntime/types/enums.go b/service/sagemakera2iruntime/types/enums.go index 52c0572df70..60732822c03 100644 --- a/service/sagemakera2iruntime/types/enums.go +++ b/service/sagemakera2iruntime/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ContentClassifier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentClassifier) Values() []ContentClassifier { return []ContentClassifier{ "FreeOfPersonallyIdentifiableInformation", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for HumanLoopStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HumanLoopStatus) Values() []HumanLoopStatus { return []HumanLoopStatus{ "InProgress", @@ -53,8 +55,9 @@ const ( ) // 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. +// in the future, and so 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 67ce0ce5557..9196c23eb98 100644 --- a/service/sagemakera2iruntime/types/errors.go +++ b/service/sagemakera2iruntime/types/errors.go @@ -91,11 +91,13 @@ func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smit // 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. +// For a list of Amazon A2I service quotes, see [Amazon Augmented AI Service Quotes]. 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]in the +// AWS General Reference. +// +// [Amazon Augmented AI Service Quotes]: https://docs.aws.amazon.com/general/latest/gr/a2i.html +// [AWS Service Quotas]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html type ServiceQuotaExceededException struct { Message *string diff --git a/service/sagemakera2iruntime/types/types.go b/service/sagemakera2iruntime/types/types.go index f12fdb302ad..5a637d8ddcf 100644 --- a/service/sagemakera2iruntime/types/types.go +++ b/service/sagemakera2iruntime/types/types.go @@ -12,8 +12,10 @@ import ( type HumanLoopDataAttributes struct { // Declares that your content is free of personally identifiable information or - // adult content. Amazon SageMaker can restrict the Amazon Mechanical Turk workers - // who can view your task based on this information. + // adult content. + // + // Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view + // your task based on this information. // // This member is required. ContentClassifiers []ContentClassifier diff --git a/service/sagemakeredge/options.go b/service/sagemakeredge/options.go index 91509de4fe0..eabff0c121f 100644 --- a/service/sagemakeredge/options.go +++ b/service/sagemakeredge/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemakeredge/types/enums.go b/service/sagemakeredge/types/enums.go index a9b64a6e4c0..72e7b695488 100644 --- a/service/sagemakeredge/types/enums.go +++ b/service/sagemakeredge/types/enums.go @@ -10,8 +10,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for DeploymentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentStatus) Values() []DeploymentStatus { return []DeploymentStatus{ "SUCCESS", @@ -44,8 +46,9 @@ const ( ) // Values returns all known values for DeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentType) Values() []DeploymentType { return []DeploymentType{ "Model", @@ -61,8 +64,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ROLLBACK_ON_FAILURE", @@ -79,8 +83,9 @@ const ( ) // Values returns all known values for ModelState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelState) Values() []ModelState { return []ModelState{ "DEPLOY", diff --git a/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go b/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go index 6f84c7d2050..26edb39fb6b 100644 --- a/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go +++ b/service/sagemakerfeaturestoreruntime/api_op_DeleteRecord.go @@ -19,12 +19,16 @@ import ( // the OfflineStore . The deleted record marker is a record with the same // RecordIdentifer as the original, but with is_deleted value set to True , // EventTime set to the delete input EventTime , and other feature values set to -// null . 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: +// null . +// +// 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 SoftDelete , the existing (not deleted) record remains in the // OnlineStore , though the delete record marker is still written to the // OfflineStore . +// // - HardDelete returns EventTime : 400 ValidationException to indicate that the // delete operation failed. No delete record marker is written to the // OfflineStore . @@ -33,9 +37,9 @@ import ( // appended to the OfflineStore . If you have the Iceberg table format enabled for // your OfflineStore , you can remove all history of a record from the OfflineStore // using Amazon Athena or Apache Spark. For information on how to hard delete a -// record from the OfflineStore with the Iceberg table format enabled, see Delete -// records from the offline store (https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records-offline-store.html#feature-store-delete-records-offline-store) -// . +// record from the OfflineStore with the Iceberg table format enabled, see [Delete records from the offline store]. +// +// [Delete records from the offline store]: https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-delete-records-offline-store.html#feature-store-delete-records-offline-store func (c *Client) DeleteRecord(ctx context.Context, params *DeleteRecordInput, optFns ...func(*Options)) (*DeleteRecordOutput, error) { if params == nil { params = &DeleteRecordInput{} diff --git a/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go b/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go index b63ecd2155d..5595f0bac31 100644 --- a/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go +++ b/service/sagemakerfeaturestoreruntime/api_op_PutRecord.go @@ -12,17 +12,21 @@ import ( ) // The PutRecord API is used to ingest a list of Records into your feature group. +// // If a new record’s EventTime is greater, the new record is written to both the // OnlineStore and OfflineStore . Otherwise, the record is a historic record and it -// is written only to the OfflineStore . You can specify the ingestion to be -// applied to the OnlineStore , OfflineStore , or both by using the TargetStores -// request parameter. You can set the ingested record to expire at a given time to -// live (TTL) duration after the record’s event time, ExpiresAt = EventTime + -// TtlDuration , by specifying the TtlDuration parameter. A record level -// TtlDuration is set when specifying the TtlDuration parameter using the PutRecord -// API call. If the input TtlDuration is null or unspecified, TtlDuration is set -// to the default feature group level TtlDuration . A record level TtlDuration -// supersedes the group level TtlDuration . +// is written only to the OfflineStore . +// +// You can specify the ingestion to be applied to the OnlineStore , OfflineStore , +// or both by using the TargetStores request parameter. +// +// You can set the ingested record to expire at a given time to live (TTL) +// duration after the record’s event time, ExpiresAt = EventTime + TtlDuration , by +// specifying the TtlDuration parameter. A record level TtlDuration is set when +// specifying the TtlDuration parameter using the PutRecord API call. If the input +// TtlDuration is null or unspecified, TtlDuration is set to the default feature +// group level TtlDuration . A record level TtlDuration supersedes the group level +// TtlDuration . func (c *Client) PutRecord(ctx context.Context, params *PutRecordInput, optFns ...func(*Options)) (*PutRecordOutput, error) { if params == nil { params = &PutRecordInput{} @@ -48,8 +52,11 @@ 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. // // This member is required. @@ -61,8 +68,9 @@ type PutRecordInput struct { // Time to live duration, where the record is hard deleted after the expiration // time is reached; ExpiresAt = EventTime + TtlDuration . For information on - // HardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) - // API in the Amazon SageMaker API Reference guide. + // HardDelete, see the [DeleteRecord]API in the Amazon SageMaker API Reference guide. + // + // [DeleteRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html TtlDuration *types.TtlDuration noSmithyDocumentSerde diff --git a/service/sagemakerfeaturestoreruntime/doc.go b/service/sagemakerfeaturestoreruntime/doc.go index 48a222daa95..69f4a8dbcae 100644 --- a/service/sagemakerfeaturestoreruntime/doc.go +++ b/service/sagemakerfeaturestoreruntime/doc.go @@ -5,10 +5,21 @@ // // Contains all data plane API operations and data types for the Amazon SageMaker // 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) +// feature store. +// +// Use the following operations to configure your OnlineStore and OfflineStore +// features, and to create and manage feature groups: +// +// [CreateFeatureGroup] +// +// [DeleteFeatureGroup] +// +// [DescribeFeatureGroup] +// +// [ListFeatureGroups] +// +// [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 package sagemakerfeaturestoreruntime diff --git a/service/sagemakerfeaturestoreruntime/options.go b/service/sagemakerfeaturestoreruntime/options.go index 504b6807183..72d5f72968f 100644 --- a/service/sagemakerfeaturestoreruntime/options.go +++ b/service/sagemakerfeaturestoreruntime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemakerfeaturestoreruntime/types/enums.go b/service/sagemakerfeaturestoreruntime/types/enums.go index c309591d44b..1d4fa18db90 100644 --- a/service/sagemakerfeaturestoreruntime/types/enums.go +++ b/service/sagemakerfeaturestoreruntime/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ExpirationTimeResponse. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExpirationTimeResponse) Values() []ExpirationTimeResponse { return []ExpirationTimeResponse{ "Enabled", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for TargetStore. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetStore) Values() []TargetStore { return []TargetStore{ "OnlineStore", @@ -68,8 +71,9 @@ const ( ) // Values returns all known values for TtlDurationUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TtlDurationUnit) Values() []TtlDurationUnit { return []TtlDurationUnit{ "Seconds", diff --git a/service/sagemakerfeaturestoreruntime/types/types.go b/service/sagemakerfeaturestoreruntime/types/types.go index 1a1c8f2b143..cffed1b1945 100644 --- a/service/sagemakerfeaturestoreruntime/types/types.go +++ b/service/sagemakerfeaturestoreruntime/types/types.go @@ -10,8 +10,9 @@ import ( 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) - // . + // batch of Records. For more information on errors, see [Errors]. + // + // [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 @@ -106,8 +107,9 @@ type FeatureValue struct { // Time to live duration, where the record is hard deleted after the expiration // time is reached; ExpiresAt = EventTime + TtlDuration . For information on -// HardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html) -// API in the Amazon SageMaker API Reference guide. +// HardDelete, see the [DeleteRecord]API in the Amazon SageMaker API Reference guide. +// +// [DeleteRecord]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html type TtlDuration struct { // TtlDuration time unit. diff --git a/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go b/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go index 4a132c1a10f..f6828b91263 100644 --- a/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go +++ b/service/sagemakergeospatial/api_op_SearchRasterDataCollection.go @@ -35,11 +35,12 @@ 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)], [PropertyFilters] and [TimeRangeFilterInput] used in [SearchRasterDataCollection]. + // + // [PropertyFilters]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_PropertyFilter.html + // [TimeRangeFilterInput]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_TimeRangeFilterInput.html + // [AreaOfInterest(AOI)]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_geospatial_AreaOfInterest.html + // [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/options.go b/service/sagemakergeospatial/options.go index 17a4d3a6fa5..cef440115ea 100644 --- a/service/sagemakergeospatial/options.go +++ b/service/sagemakergeospatial/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemakergeospatial/types/enums.go b/service/sagemakergeospatial/types/enums.go index b40e80ca0b9..9b31fe48933 100644 --- a/service/sagemakergeospatial/types/enums.go +++ b/service/sagemakergeospatial/types/enums.go @@ -12,6 +12,7 @@ const ( // Values returns all known values for AlgorithmNameCloudRemoval. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmNameCloudRemoval) Values() []AlgorithmNameCloudRemoval { return []AlgorithmNameCloudRemoval{ @@ -54,8 +55,9 @@ const ( ) // Values returns all known values for AlgorithmNameGeoMosaic. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmNameGeoMosaic) Values() []AlgorithmNameGeoMosaic { return []AlgorithmNameGeoMosaic{ "NEAR", @@ -110,8 +112,9 @@ const ( ) // Values returns all known values for AlgorithmNameResampling. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AlgorithmNameResampling) Values() []AlgorithmNameResampling { return []AlgorithmNameResampling{ "NEAR", @@ -144,8 +147,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQUALS", @@ -167,8 +171,9 @@ const ( ) // Values returns all known values for DataCollectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataCollectionType) Values() []DataCollectionType { return []DataCollectionType{ "PUBLIC", @@ -189,8 +194,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EarthObservationJobErrorType) Values() []EarthObservationJobErrorType { return []EarthObservationJobErrorType{ "CLIENT_ERROR", @@ -212,8 +218,9 @@ const ( // Values returns all known values for EarthObservationJobExportStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EarthObservationJobExportStatus) Values() []EarthObservationJobExportStatus { return []EarthObservationJobExportStatus{ "IN_PROGRESS", @@ -246,6 +253,7 @@ const ( // Values returns all known values for EarthObservationJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (EarthObservationJobStatus) Values() []EarthObservationJobStatus { return []EarthObservationJobStatus{ @@ -271,8 +279,9 @@ const ( ) // Values returns all known values for ExportErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportErrorType) Values() []ExportErrorType { return []ExportErrorType{ "CLIENT_ERROR", @@ -291,8 +300,9 @@ const ( ) // Values returns all known values for GroupBy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GroupBy) Values() []GroupBy { return []GroupBy{ "ALL", @@ -309,8 +319,9 @@ const ( ) // Values returns all known values for LogicalOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogicalOperator) Values() []LogicalOperator { return []LogicalOperator{ "AND", @@ -334,8 +345,9 @@ const ( ) // Values returns all known values for OutputType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputType) Values() []OutputType { return []OutputType{ "INT32", @@ -359,8 +371,9 @@ const ( ) // Values returns all known values for PredefinedResolution. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PredefinedResolution) Values() []PredefinedResolution { return []PredefinedResolution{ "HIGHEST", @@ -380,8 +393,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -400,8 +414,9 @@ const ( ) // Values returns all known values for TargetOptions. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetOptions) Values() []TargetOptions { return []TargetOptions{ "INPUT", @@ -422,8 +437,9 @@ const ( ) // Values returns all known values for TemporalStatistics. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TemporalStatistics) Values() []TemporalStatistics { return []TemporalStatistics{ "MEAN", @@ -441,8 +457,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "METERS", @@ -458,8 +475,9 @@ const ( // Values returns all known values for VectorEnrichmentJobDocumentType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VectorEnrichmentJobDocumentType) Values() []VectorEnrichmentJobDocumentType { return []VectorEnrichmentJobDocumentType{ "CSV", @@ -478,8 +496,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VectorEnrichmentJobErrorType) Values() []VectorEnrichmentJobErrorType { return []VectorEnrichmentJobErrorType{ "CLIENT_ERROR", @@ -497,8 +516,9 @@ const ( // Values returns all known values for VectorEnrichmentJobExportErrorType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VectorEnrichmentJobExportErrorType) Values() []VectorEnrichmentJobExportErrorType { return []VectorEnrichmentJobExportErrorType{ "CLIENT_ERROR", @@ -517,8 +537,9 @@ const ( // Values returns all known values for VectorEnrichmentJobExportStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VectorEnrichmentJobExportStatus) Values() []VectorEnrichmentJobExportStatus { return []VectorEnrichmentJobExportStatus{ "IN_PROGRESS", @@ -543,6 +564,7 @@ const ( // Values returns all known values for VectorEnrichmentJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VectorEnrichmentJobStatus) Values() []VectorEnrichmentJobStatus { return []VectorEnrichmentJobStatus{ @@ -566,8 +588,9 @@ const ( ) // Values returns all known values for VectorEnrichmentJobType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VectorEnrichmentJobType) Values() []VectorEnrichmentJobType { return []VectorEnrichmentJobType{ "REVERSE_GEOCODING", @@ -594,8 +617,9 @@ const ( ) // Values returns all known values for ZonalStatistics. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ZonalStatistics) Values() []ZonalStatistics { return []ZonalStatistics{ "MEAN", diff --git a/service/sagemakergeospatial/types/types.go b/service/sagemakergeospatial/types/types.go index 6eb526bd9ed..8c1735bc477 100644 --- a/service/sagemakergeospatial/types/types.go +++ b/service/sagemakergeospatial/types/types.go @@ -527,8 +527,9 @@ 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]. +// +// [GeoJson spec]: https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6 type MultiPolygonGeometryInput struct { // The coordinates of the multipolygon geometry. @@ -630,12 +631,14 @@ 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]. +// +// [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]. + // + // [GeoJson spec]: https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6 // // This member is required. Coordinates [][][]float64 @@ -668,8 +671,9 @@ type Properties struct { // 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) - // . + // was captured during [nautical twilight]. + // + // [nautical twilight]: https://www.timeanddate.com/astronomy/different-types-twilight.html ViewSunElevation *float32 noSmithyDocumentSerde @@ -1184,14 +1188,22 @@ type ZonalStatisticsConfigInput struct { // The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management // Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your // 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" + // 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) - // in the Amazon Web Services Key Management Service (Amazon Web Services KMS) - // documentation. + // + // "arn:aws:kms:::key/" + // + // For more information about key identifiers, see [Key identifiers (KeyID)] in the Amazon Web Services Key + // Management Service (Amazon Web Services KMS) documentation. + // + // [Key identifiers (KeyID)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id ZoneS3PathKmsKeyId *string noSmithyDocumentSerde diff --git a/service/sagemakermetrics/doc.go b/service/sagemakermetrics/doc.go index 348b164e6cb..45d64677749 100644 --- a/service/sagemakermetrics/doc.go +++ b/service/sagemakermetrics/doc.go @@ -6,5 +6,8 @@ // 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] +// +// [BatchPutMetrics]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_metrics_BatchPutMetrics.html package sagemakermetrics diff --git a/service/sagemakermetrics/options.go b/service/sagemakermetrics/options.go index 409ab3fa21a..07c3860da25 100644 --- a/service/sagemakermetrics/options.go +++ b/service/sagemakermetrics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemakermetrics/types/enums.go b/service/sagemakermetrics/types/enums.go index 035944b9486..475fdecd970 100644 --- a/service/sagemakermetrics/types/enums.go +++ b/service/sagemakermetrics/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for PutMetricsErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PutMetricsErrorCode) Values() []PutMetricsErrorCode { return []PutMetricsErrorCode{ "METRIC_LIMIT_EXCEEDED", diff --git a/service/sagemakermetrics/types/types.go b/service/sagemakermetrics/types/types.go index 7e29af420bf..5a97b01ce53 100644 --- a/service/sagemakermetrics/types/types.go +++ b/service/sagemakermetrics/types/types.go @@ -11,10 +11,14 @@ 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. Code PutMetricsErrorCode diff --git a/service/sagemakerruntime/api_op_InvokeEndpoint.go b/service/sagemakerruntime/api_op_InvokeEndpoint.go index 01ffd4dcc63..e761af6ba3d 100644 --- a/service/sagemakerruntime/api_op_InvokeEndpoint.go +++ b/service/sagemakerruntime/api_op_InvokeEndpoint.go @@ -12,21 +12,28 @@ 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) . +// hosted at the specified endpoint. +// +// For an overview of Amazon SageMaker, see [How It Works]. +// // 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) -// 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 -// 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 -// seconds. Endpoints are scoped to an individual account, and are not public. The -// URL does not contain the account ID, but Amazon SageMaker determines the account -// ID from the authentication token that is supplied by the caller. +// 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)]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 50-60 seconds of processing time, +// the SDK socket timeout should be set to be 70 seconds. +// +// Endpoints are scoped to an individual account, and are not public. The URL does +// not contain the account ID, but Amazon SageMaker determines the account ID from +// the authentication token that is supplied by the caller. +// +// [How It Works]: https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html func (c *Client) InvokeEndpoint(ctx context.Context, params *InvokeEndpointInput, optFns ...func(*Options)) (*InvokeEndpointOutput, error) { if params == nil { params = &InvokeEndpointInput{} @@ -45,17 +52,19 @@ func (c *Client) InvokeEndpoint(ctx context.Context, params *InvokeEndpointInput 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) - // . + // 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]. + // + // [Common Data 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]API. + // + // [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html // // This member is required. EndpointName *string @@ -71,20 +80,26 @@ 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://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. + // than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components]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. + // + // [Section 3.3.6. Field Value Components]: https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 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) - // section in the developer guide for more information. + // parameter of the ClarifyExplainerConfig API. See the [EnableExplanations] section in the developer + // guide for more information. + // + // [EnableExplanations]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable EnableExplanations *string // If the endpoint hosts one or more inference components, this parameter @@ -92,8 +107,9 @@ type InvokeEndpointInput struct { InferenceComponentName *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]. + // + // [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 @@ -106,8 +122,11 @@ type InvokeEndpointInput struct { // 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) + // 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] + // + // [Test models in production]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html TargetVariant *string noSmithyDocumentSerde @@ -115,12 +134,16 @@ 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) - // in the Developer Guide. + // Includes the inference provided by the model. + // + // For information about the format of the response body, see [Common Data Formats-Inference]. + // + // 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]in the + // Developer Guide. + // + // [Common Data Formats-Inference]: https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html + // [Invoke the Endpoint]: https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response // // This member is required. Body []byte @@ -133,16 +156,21 @@ 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 + // consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components]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 + // 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. + // 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. + // + // [Section 3.3.6. Field Value Components]: https://tools.ietf.org/html/rfc7230#section-3.2.6 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 1573daab1e5..a8e26d0dd54 100644 --- a/service/sagemakerruntime/api_op_InvokeEndpointAsync.go +++ b/service/sagemakerruntime/api_op_InvokeEndpointAsync.go @@ -12,18 +12,22 @@ 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 in an asynchronous manner. Inference requests -// sent to this API are enqueued for asynchronous processing. The processing of the -// inference request may or may not complete before you receive a response from -// this API. The response from this API will not contain the result of the -// inference request but contain information about where you can locate it. 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 -// 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) -// in the Amazon S3 API Reference. +// hosted at the specified endpoint in an asynchronous manner. +// +// Inference requests sent to this API are enqueued for asynchronous processing. +// The processing of the inference request may or may not complete before you +// receive a response from this API. The response from this API will not contain +// the result of the inference request but contain information about where you can +// locate it. +// +// 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 InvokeEndpointAsync are authenticated by using Amazon Web Services +// Signature Version 4. For information, see [Authenticating Requests (Amazon Web Services Signature Version 4)]in the Amazon S3 API Reference. +// +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html func (c *Client) InvokeEndpointAsync(ctx context.Context, params *InvokeEndpointAsyncInput, optFns ...func(*Options)) (*InvokeEndpointAsyncOutput, error) { if params == nil { params = &InvokeEndpointAsyncInput{} @@ -42,8 +46,9 @@ 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/dg/API_CreateEndpoint.html) - // API. + // the [CreateEndpoint]API. + // + // [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html // // This member is required. EndpointName *string @@ -64,15 +69,19 @@ 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. + // than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components]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. + // + // [Section 3.3.6. Field Value Components]: https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 CustomAttributes *string // The identifier for the inference request. Amazon SageMaker will generate an diff --git a/service/sagemakerruntime/api_op_InvokeEndpointWithResponseStream.go b/service/sagemakerruntime/api_op_InvokeEndpointWithResponseStream.go index b4ac7c8a254..3b34f3f23a6 100644 --- a/service/sagemakerruntime/api_op_InvokeEndpointWithResponseStream.go +++ b/service/sagemakerruntime/api_op_InvokeEndpointWithResponseStream.go @@ -16,27 +16,31 @@ import ( // stream. The inference stream provides the response payload incrementally as a // series of parts. Before you can get an inference stream, you must have access to // a model that's deployed using Amazon SageMaker hosting services, and the -// container for that model must support inference streaming. For more information -// that can help you use this API, see the following sections in the Amazon -// SageMaker Developer Guide: -// - For information about how to add streaming support to a model, see How -// Containers Serve Requests (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-code-how-containe-serves-requests) -// . -// - For information about how to process the streaming response, see Invoke -// real-time endpoints (https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-test-endpoints.html) -// . +// container for that model must support inference streaming. +// +// For more information that can help you use this API, see the following sections +// in the Amazon SageMaker Developer Guide: +// +// - For information about how to add streaming support to a model, see [How Containers Serve Requests]. +// +// - For information about how to process the streaming response, see [Invoke real-time endpoints]. // // Before you can use this operation, your IAM permissions must allow the // sagemaker:InvokeEndpoint action. For more information about Amazon SageMaker -// actions for IAM policies, see Actions, resources, and condition keys for Amazon -// SageMaker (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonsagemaker.html) -// in the IAM Service Authorization Reference. 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 InvokeEndpointWithResponseStream 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) -// in the Amazon S3 API Reference. +// actions for IAM policies, see [Actions, resources, and condition keys for Amazon SageMaker]in the IAM Service Authorization Reference. +// +// 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 InvokeEndpointWithResponseStream are authenticated by using Amazon Web +// Services Signature Version 4. For information, see [Authenticating Requests (Amazon Web Services Signature Version 4)]in the Amazon S3 API +// Reference. +// +// [How Containers Serve Requests]: https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-code-how-containe-serves-requests +// [Invoke real-time endpoints]: https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-test-endpoints.html +// [Actions, resources, and condition keys for Amazon SageMaker]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonsagemaker.html +// [Authenticating Requests (Amazon Web Services Signature Version 4)]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html func (c *Client) InvokeEndpointWithResponseStream(ctx context.Context, params *InvokeEndpointWithResponseStreamInput, optFns ...func(*Options)) (*InvokeEndpointWithResponseStreamOutput, error) { if params == nil { params = &InvokeEndpointWithResponseStreamInput{} @@ -55,17 +59,19 @@ func (c *Client) InvokeEndpointWithResponseStream(ctx context.Context, params *I type InvokeEndpointWithResponseStreamInput 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) - // . + // 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]. + // + // [Common Data 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]API. + // + // [CreateEndpoint]: https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html // // This member is required. EndpointName *string @@ -81,15 +87,19 @@ type InvokeEndpointWithResponseStreamInput 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. + // than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components]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. + // + // [Section 3.3.6. Field Value Components]: https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 CustomAttributes *string // If the endpoint hosts one or more inference components, this parameter @@ -106,8 +116,11 @@ type InvokeEndpointWithResponseStreamInput struct { // 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) + // 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] + // + // [Test models in production]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html TargetVariant *string noSmithyDocumentSerde @@ -123,16 +136,21 @@ type InvokeEndpointWithResponseStreamOutput 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 + // consist of no more than 1024 visible US-ASCII characters as specified in [Section 3.3.6. Field Value Components]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 + // 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. + // 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. + // + // [Section 3.3.6. Field Value Components]: https://tools.ietf.org/html/rfc7230#section-3.2.6 CustomAttributes *string // Identifies the production variant that was invoked. diff --git a/service/sagemakerruntime/doc.go b/service/sagemakerruntime/doc.go index 48f5c78a603..5b1577219b4 100644 --- a/service/sagemakerruntime/doc.go +++ b/service/sagemakerruntime/doc.go @@ -3,5 +3,5 @@ // Package sagemakerruntime provides the API client, operations, and parameter // types for Amazon SageMaker Runtime. // -// The Amazon SageMaker runtime API. +// The Amazon SageMaker runtime API. package sagemakerruntime diff --git a/service/sagemakerruntime/options.go b/service/sagemakerruntime/options.go index 30fab8f1581..359ff5d45d6 100644 --- a/service/sagemakerruntime/options.go +++ b/service/sagemakerruntime/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sagemakerruntime/types/errors.go b/service/sagemakerruntime/types/errors.go index f36a1b0f99a..5f9332bb925 100644 --- a/service/sagemakerruntime/types/errors.go +++ b/service/sagemakerruntime/types/errors.go @@ -145,9 +145,13 @@ func (e *ModelNotReadyException) ErrorCode() string { } func (e *ModelNotReadyException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// An error occurred while streaming the response body. This error can have the -// following error codes: ModelInvocationTimeExceeded The model failed to finish -// sending the response within the timeout period allowed by Amazon SageMaker. +// An error occurred while streaming the response body. This error can have the +// +// following error codes: +// +// ModelInvocationTimeExceeded The model failed to finish sending the response +// within the timeout period allowed by Amazon SageMaker. +// // StreamBroken The Transmission Control Protocol (TCP) connection between the // client and the model was reset or closed. type ModelStreamError struct { diff --git a/service/savingsplans/doc.go b/service/savingsplans/doc.go index 4194616649a..4de1103dd07 100644 --- a/service/savingsplans/doc.go +++ b/service/savingsplans/doc.go @@ -7,6 +7,7 @@ // Services usage (for example, on Amazon EC2 instances). You commit to a // consistent amount of usage per hour, in the specified currency, for a term of // one or three years, and receive a lower price for that usage. For more -// information, see the Amazon Web Services Savings Plans User Guide (https://docs.aws.amazon.com/savingsplans/latest/userguide/) -// . +// information, see the [Amazon Web Services Savings Plans User Guide]. +// +// [Amazon Web Services Savings Plans User Guide]: https://docs.aws.amazon.com/savingsplans/latest/userguide/ package savingsplans diff --git a/service/savingsplans/options.go b/service/savingsplans/options.go index 0b0576a38f6..42402af6979 100644 --- a/service/savingsplans/options.go +++ b/service/savingsplans/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/savingsplans/types/enums.go b/service/savingsplans/types/enums.go index 512d855c30c..fb1d41d701b 100644 --- a/service/savingsplans/types/enums.go +++ b/service/savingsplans/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -30,8 +31,9 @@ const ( // Values returns all known values for SavingsPlanOfferingFilterAttribute. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanOfferingFilterAttribute) Values() []SavingsPlanOfferingFilterAttribute { return []SavingsPlanOfferingFilterAttribute{ "region", @@ -49,8 +51,9 @@ const ( // Values returns all known values for SavingsPlanOfferingPropertyKey. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanOfferingPropertyKey) Values() []SavingsPlanOfferingPropertyKey { return []SavingsPlanOfferingPropertyKey{ "region", @@ -69,6 +72,7 @@ const ( // 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{ @@ -89,8 +93,9 @@ const ( ) // Values returns all known values for SavingsPlanProductType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanProductType) Values() []SavingsPlanProductType { return []SavingsPlanProductType{ "EC2", @@ -114,8 +119,9 @@ const ( // Values returns all known values for SavingsPlanRateFilterAttribute. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanRateFilterAttribute) Values() []SavingsPlanRateFilterAttribute { return []SavingsPlanRateFilterAttribute{ "region", @@ -143,6 +149,7 @@ const ( // Values returns all known values for SavingsPlanRateFilterName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanRateFilterName) Values() []SavingsPlanRateFilterName { return []SavingsPlanRateFilterName{ @@ -170,6 +177,7 @@ const ( // Values returns all known values for SavingsPlanRatePropertyKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanRatePropertyKey) Values() []SavingsPlanRatePropertyKey { return []SavingsPlanRatePropertyKey{ @@ -194,6 +202,7 @@ const ( // Values returns all known values for SavingsPlanRateServiceCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanRateServiceCode) Values() []SavingsPlanRateServiceCode { return []SavingsPlanRateServiceCode{ @@ -215,8 +224,9 @@ const ( ) // Values returns all known values for SavingsPlanRateUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanRateUnit) Values() []SavingsPlanRateUnit { return []SavingsPlanRateUnit{ "Hrs", @@ -241,8 +251,9 @@ const ( ) // Values returns all known values for SavingsPlansFilterName. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlansFilterName) Values() []SavingsPlansFilterName { return []SavingsPlansFilterName{ "region", @@ -272,8 +283,9 @@ const ( ) // Values returns all known values for SavingsPlanState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanState) Values() []SavingsPlanState { return []SavingsPlanState{ "payment-pending", @@ -297,8 +309,9 @@ const ( ) // Values returns all known values for SavingsPlanType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SavingsPlanType) Values() []SavingsPlanType { return []SavingsPlanType{ "Compute", diff --git a/service/scheduler/api_op_CreateSchedule.go b/service/scheduler/api_op_CreateSchedule.go index f1b0003f392..d830915cbfb 100644 --- a/service/scheduler/api_op_CreateSchedule.go +++ b/service/scheduler/api_op_CreateSchedule.go @@ -41,23 +41,33 @@ type CreateScheduleInput struct { // This member is required. Name *string - // The expression that defines when the schedule runs. The following formats are + // The expression that defines when the schedule runs. The following formats are // supported. + // // - at expression - at(yyyy-mm-ddThh:mm:ss) + // // - rate expression - rate(value unit) + // // - 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. + // 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] in the EventBridge Scheduler User + // Guide. + // + // [Schedule types on EventBridge Scheduler]: https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html // // This member is required. ScheduleExpression *string @@ -71,7 +81,7 @@ type CreateScheduleInput struct { // the schedule completes invoking the target. ActionAfterCompletion types.ActionAfterCompletion - // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, EventBridge Scheduler uses a // randomly generated token for the request to ensure idempotency. ClientToken *string diff --git a/service/scheduler/api_op_CreateScheduleGroup.go b/service/scheduler/api_op_CreateScheduleGroup.go index f1d9702c6c6..75326244996 100644 --- a/service/scheduler/api_op_CreateScheduleGroup.go +++ b/service/scheduler/api_op_CreateScheduleGroup.go @@ -34,7 +34,7 @@ type CreateScheduleGroupInput struct { // This member is required. Name *string - // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, EventBridge Scheduler uses a // randomly generated token for the request to ensure idempotency. ClientToken *string diff --git a/service/scheduler/api_op_DeleteSchedule.go b/service/scheduler/api_op_DeleteSchedule.go index 733f18c2559..03cf8ad5da4 100644 --- a/service/scheduler/api_op_DeleteSchedule.go +++ b/service/scheduler/api_op_DeleteSchedule.go @@ -33,7 +33,7 @@ type DeleteScheduleInput struct { // This member is required. Name *string - // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, EventBridge Scheduler uses a // randomly generated token for the request to ensure idempotency. ClientToken *string diff --git a/service/scheduler/api_op_DeleteScheduleGroup.go b/service/scheduler/api_op_DeleteScheduleGroup.go index 08da44ba979..2909826b70c 100644 --- a/service/scheduler/api_op_DeleteScheduleGroup.go +++ b/service/scheduler/api_op_DeleteScheduleGroup.go @@ -16,7 +16,9 @@ import ( // schedules are deleted. Schedules associated with the group that are set to run // while the schedule group is in the process of being deleted might continue to // invoke their targets until the schedule group and its associated schedules are -// deleted. This operation is eventually consistent. +// deleted. +// +// This operation is eventually consistent. func (c *Client) DeleteScheduleGroup(ctx context.Context, params *DeleteScheduleGroupInput, optFns ...func(*Options)) (*DeleteScheduleGroupOutput, error) { if params == nil { params = &DeleteScheduleGroupInput{} @@ -39,7 +41,7 @@ type DeleteScheduleGroupInput struct { // This member is required. Name *string - // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, EventBridge Scheduler uses a // randomly generated token for the request to ensure idempotency. ClientToken *string diff --git a/service/scheduler/api_op_GetSchedule.go b/service/scheduler/api_op_GetSchedule.go index 84afd565579..a001a9c2ec7 100644 --- a/service/scheduler/api_op_GetSchedule.go +++ b/service/scheduler/api_op_GetSchedule.go @@ -81,23 +81,33 @@ type GetScheduleOutput struct { // The name of the schedule. Name *string - // The expression that defines when the schedule runs. The following formats are + // The expression that defines when the schedule runs. The following formats are // supported. + // // - at expression - at(yyyy-mm-ddThh:mm:ss) + // // - rate expression - rate(value unit) + // // - 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. + // 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] in the EventBridge Scheduler User + // Guide. + // + // [Schedule types on EventBridge Scheduler]: https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html ScheduleExpression *string // The timezone in which the scheduling expression is evaluated. diff --git a/service/scheduler/api_op_UpdateSchedule.go b/service/scheduler/api_op_UpdateSchedule.go index 6628264d84d..02b0987f8ab 100644 --- a/service/scheduler/api_op_UpdateSchedule.go +++ b/service/scheduler/api_op_UpdateSchedule.go @@ -12,13 +12,16 @@ 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 -// system-default value after the update. Before calling this operation, we -// recommend that you call the GetSchedule API operation and make a note of all -// optional parameters for your UpdateSchedule call. +// system-default value after the update. +// +// Before calling this operation, we recommend that you call the GetSchedule API +// operation and make a note of all optional parameters for your UpdateSchedule +// call. func (c *Client) UpdateSchedule(ctx context.Context, params *UpdateScheduleInput, optFns ...func(*Options)) (*UpdateScheduleOutput, error) { if params == nil { params = &UpdateScheduleInput{} @@ -47,23 +50,33 @@ type UpdateScheduleInput struct { // This member is required. Name *string - // The expression that defines when the schedule runs. The following formats are + // The expression that defines when the schedule runs. The following formats are // supported. + // // - at expression - at(yyyy-mm-ddThh:mm:ss) + // // - rate expression - rate(value unit) + // // - 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. + // 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] in the EventBridge Scheduler User + // Guide. + // + // [Schedule types on EventBridge Scheduler]: https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html // // This member is required. ScheduleExpression *string @@ -78,7 +91,7 @@ type UpdateScheduleInput struct { // the schedule completes invoking the target. ActionAfterCompletion types.ActionAfterCompletion - // Unique, case-sensitive identifier you provide to ensure the idempotency of the + // Unique, case-sensitive identifier you provide to ensure the idempotency of the // request. If you do not specify a client token, EventBridge Scheduler uses a // randomly generated token for the request to ensure idempotency. ClientToken *string diff --git a/service/scheduler/doc.go b/service/scheduler/doc.go index a7217610ef5..e71bf2679de 100644 --- a/service/scheduler/doc.go +++ b/service/scheduler/doc.go @@ -3,7 +3,8 @@ // Package scheduler provides the API client, operations, and parameter types for // Amazon EventBridge Scheduler. // -// Amazon EventBridge Scheduler is a serverless scheduler that allows you to +// Amazon EventBridge Scheduler is a serverless scheduler that allows you to +// // create, run, and manage tasks from one central, managed service. EventBridge // Scheduler delivers your tasks reliably, with built-in mechanisms that adjust // your schedules based on the availability of downstream targets. The following diff --git a/service/scheduler/options.go b/service/scheduler/options.go index 5258e24cd94..55960389a5b 100644 --- a/service/scheduler/options.go +++ b/service/scheduler/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/scheduler/types/enums.go b/service/scheduler/types/enums.go index b9f1d4a19c8..d2b7f068327 100644 --- a/service/scheduler/types/enums.go +++ b/service/scheduler/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ActionAfterCompletion. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionAfterCompletion) Values() []ActionAfterCompletion { return []ActionAfterCompletion{ "NONE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AssignPublicIp. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssignPublicIp) Values() []AssignPublicIp { return []AssignPublicIp{ "ENABLED", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for FlexibleTimeWindowMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FlexibleTimeWindowMode) Values() []FlexibleTimeWindowMode { return []FlexibleTimeWindowMode{ "OFF", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for LaunchType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LaunchType) Values() []LaunchType { return []LaunchType{ "EC2", @@ -85,8 +89,9 @@ const ( ) // Values returns all known values for PlacementConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PlacementConstraintType) Values() []PlacementConstraintType { return []PlacementConstraintType{ "distinctInstance", @@ -104,8 +109,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "random", @@ -122,8 +128,9 @@ const ( ) // Values returns all known values for PropagateTags. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropagateTags) Values() []PropagateTags { return []PropagateTags{ "TASK_DEFINITION", @@ -139,8 +146,9 @@ const ( ) // Values returns all known values for ScheduleGroupState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleGroupState) Values() []ScheduleGroupState { return []ScheduleGroupState{ "ACTIVE", @@ -157,8 +165,9 @@ const ( ) // Values returns all known values for ScheduleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleState) Values() []ScheduleState { return []ScheduleState{ "ENABLED", diff --git a/service/scheduler/types/types.go b/service/scheduler/types/types.go index e9aade15cda..ddee58e3f9a 100644 --- a/service/scheduler/types/types.go +++ b/service/scheduler/types/types.go @@ -67,8 +67,9 @@ type DeadLetterConfig struct { 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]RunTask API operation. +// +// [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html type EcsParameters struct { // The Amazon Resource Name (ARN) of the task definition to use if the event @@ -81,8 +82,9 @@ 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) - // in the Amazon ECS Developer Guide. + // information, see [Tagging Your Amazon ECS Resources]in the Amazon ECS Developer Guide. + // + // [Tagging Your Amazon ECS Resources]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html EnableECSManagedTags *bool // Whether or not to enable the execute command functionality for the containers @@ -96,9 +98,10 @@ 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 AWS Fargate on Amazon - // ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) - // in the Amazon ECS Developer Guide. + // with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS]in the Amazon ECS + // Developer Guide. + // + // [AWS Fargate on Amazon ECS]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html LaunchType LaunchType // This structure specifies the network configuration for an ECS task. @@ -119,8 +122,9 @@ type EcsParameters struct { // 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. + // creation, use Amazon ECS's [TagResource]TagResource API action. + // + // [TagResource]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html PropagateTags PropagateTags // The reference ID to use for the task. @@ -128,8 +132,9 @@ 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]RunTask in the Amazon ECS API Reference. + // + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html Tags []map[string]string // The number of tasks to create based on TaskDefinition . The default is 1 . @@ -138,8 +143,9 @@ type EcsParameters struct { noSmithyDocumentSerde } -// The templated target type for the EventBridge PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) -// API operation. +// The templated target type for the EventBridge [PutEvents]PutEvents API operation. +// +// [PutEvents]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html type EventBridgeParameters struct { // A free-form string, with a maximum of 128 characters, used to decide what @@ -171,12 +177,13 @@ type FlexibleTimeWindow struct { noSmithyDocumentSerde } -// The templated target type for the Amazon Kinesis PutRecord API operation. +// The templated target type for the Amazon Kinesis PutRecordPutRecord API operation. 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]in the Amazon Kinesis Streams Developer Guide. + // + // [Amazon Kinesis Data Streams terminology and concepts]: https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html // // This member is required. PartitionKey *string @@ -200,8 +207,9 @@ 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) - // in the Amazon ECS Developer Guide. + // information, see [Cluster query language]in the Amazon ECS Developer Guide. + // + // [Cluster query language]: https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html Expression *string // The type of constraint. Use distinctInstance to ensure that each task in a @@ -269,8 +277,10 @@ type SageMakerPipelineParameter struct { noSmithyDocumentSerde } -// The templated target type for the Amazon SageMaker StartPipelineExecution (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) -// API operation. +// The templated target type for the Amazon SageMaker [StartPipelineExecution]StartPipelineExecution API +// operation. +// +// [StartPipelineExecution]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html type SageMakerPipelineParameters struct { // List of parameter names and values to use when executing the SageMaker Model @@ -328,12 +338,14 @@ type ScheduleSummary struct { noSmithyDocumentSerde } -// 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) -// in the Amazon SQS Developer Guide. +// The templated target type for the Amazon SQS [SendMessage]SendMessage 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]in the Amazon SQS Developer +// Guide. +// +// [Using the Amazon SQS message deduplication ID]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html +// [SendMessage]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html type SqsParameters struct { // The FIFO message group ID to use as the target. @@ -381,12 +393,14 @@ 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]RunTask API operation. + // + // [RunTask]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html EcsParameters *EcsParameters - // The templated target type for the EventBridge PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) - // API operation. + // The templated target type for the EventBridge [PutEvents]PutEvents API operation. + // + // [PutEvents]: https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html EventBridgeParameters *EventBridgeParameters // The text, or well-formed JSON, passed to the target. If you are configuring a @@ -396,7 +410,7 @@ type Target struct { // default notification to the target. Input *string - // The templated target type for the Amazon Kinesis PutRecord API operation. + // The templated target type for the Amazon Kinesis PutRecordPutRecord API operation. KinesisParameters *KinesisParameters // A RetryPolicy object that includes information about the retry policy settings, @@ -404,16 +418,20 @@ 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) - // API operation. + // The templated target type for the Amazon SageMaker [StartPipelineExecution]StartPipelineExecution API + // operation. + // + // [StartPipelineExecution]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html SageMakerPipelineParameters *SageMakerPipelineParameters - // 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) - // in the Amazon SQS Developer Guide. + // The templated target type for the Amazon SQS [SendMessage]SendMessage 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]in the Amazon SQS Developer + // Guide. + // + // [Using the Amazon SQS message deduplication ID]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html + // [SendMessage]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html SqsParameters *SqsParameters noSmithyDocumentSerde diff --git a/service/schemas/api_op_CreateSchema.go b/service/schemas/api_op_CreateSchema.go index bc130abb53e..1868e375425 100644 --- a/service/schemas/api_op_CreateSchema.go +++ b/service/schemas/api_op_CreateSchema.go @@ -12,7 +12,9 @@ import ( "time" ) -// Creates a schema definition. Inactive schemas will be deleted after two years. +// Creates a schema definition. +// +// Inactive schemas will be deleted after two years. func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error) { if params == nil { params = &CreateSchemaInput{} diff --git a/service/schemas/api_op_DescribeCodeBinding.go b/service/schemas/api_op_DescribeCodeBinding.go index 4e99f404044..1be8ae693f1 100644 --- a/service/schemas/api_op_DescribeCodeBinding.go +++ b/service/schemas/api_op_DescribeCodeBinding.go @@ -194,12 +194,13 @@ type CodeBindingExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeCodeBindingInput, *DescribeCodeBindingOutput, error) (bool, error) } diff --git a/service/schemas/api_op_UpdateSchema.go b/service/schemas/api_op_UpdateSchema.go index f2e3ccfd420..150022c4f28 100644 --- a/service/schemas/api_op_UpdateSchema.go +++ b/service/schemas/api_op_UpdateSchema.go @@ -12,7 +12,9 @@ import ( "time" ) -// Updates the schema definition Inactive schemas will be deleted after two years. +// Updates the schema definition +// +// Inactive schemas will be deleted after two years. func (c *Client) UpdateSchema(ctx context.Context, params *UpdateSchemaInput, optFns ...func(*Options)) (*UpdateSchemaOutput, error) { if params == nil { params = &UpdateSchemaInput{} diff --git a/service/schemas/options.go b/service/schemas/options.go index 82be4a2bb17..00c7d32829a 100644 --- a/service/schemas/options.go +++ b/service/schemas/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/schemas/types/enums.go b/service/schemas/types/enums.go index 3e5a861c178..5ba4918c8ae 100644 --- a/service/schemas/types/enums.go +++ b/service/schemas/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for CodeGenerationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CodeGenerationStatus) Values() []CodeGenerationStatus { return []CodeGenerationStatus{ "CREATE_IN_PROGRESS", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for DiscovererState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DiscovererState) Values() []DiscovererState { return []DiscovererState{ "STARTED", @@ -49,8 +51,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "OpenApi3", diff --git a/service/secretsmanager/api_op_BatchGetSecretValue.go b/service/secretsmanager/api_op_BatchGetSecretValue.go index 8aa4456d280..6aaf0d802ad 100644 --- a/service/secretsmanager/api_op_BatchGetSecretValue.go +++ b/service/secretsmanager/api_op_BatchGetSecretValue.go @@ -12,23 +12,27 @@ import ( ) // Retrieves the contents of the encrypted fields SecretString or SecretBinary for -// up to 20 secrets. To retrieve a single secret, call GetSecretValue . To choose -// which secrets to retrieve, you can specify a list of secrets by name or ARN, or -// you can use filters. If Secrets Manager encounters errors such as +// up to 20 secrets. To retrieve a single secret, call GetSecretValue. +// +// To choose which secrets to retrieve, you can specify a list of secrets by name +// or ARN, or you can use filters. If Secrets Manager encounters errors such as // AccessDeniedException while attempting to retrieve any of the secrets, you can -// see the errors in Errors in the response. Secrets Manager generates CloudTrail -// GetSecretValue log entries for each secret you request 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:BatchGetSecretValue , and you must have +// see the errors in Errors in the response. +// +// Secrets Manager generates CloudTrail GetSecretValue log entries for each secret +// you request 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]. +// +// Required permissions: secretsmanager:BatchGetSecretValue , and you must have // secretsmanager:GetSecretValue for each secret. If you use filters, you must also // have secretsmanager:ListSecrets . If the secrets are encrypted using // customer-managed keys instead of the Amazon Web Services managed key // aws/secretsmanager , then you also need kms:Decrypt permissions for the keys. -// 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 [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) BatchGetSecretValue(ctx context.Context, params *BatchGetSecretValueInput, optFns ...func(*Options)) (*BatchGetSecretValueOutput, error) { if params == nil { params = &BatchGetSecretValueInput{} @@ -50,10 +54,12 @@ type BatchGetSecretValueInput struct { // SecretIdList , but not both. Filters []types.Filter - // 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 BatchGetSecretValue again with the value from NextToken . To use - // this parameter, you must also use the Filters parameter. + // 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 BatchGetSecretValue again with the + // value from NextToken . To use this parameter, you must also use the Filters + // parameter. MaxResults *int32 // A token that indicates where the output should continue from, if a previous @@ -176,10 +182,12 @@ var _ BatchGetSecretValueAPIClient = (*Client)(nil) // BatchGetSecretValuePaginatorOptions is the paginator options for // BatchGetSecretValue type BatchGetSecretValuePaginatorOptions 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 BatchGetSecretValue again with the value from NextToken . To use - // this parameter, you must also use the Filters parameter. + // 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 BatchGetSecretValue again with the + // value from NextToken . To use this parameter, you must also use the Filters + // parameter. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/secretsmanager/api_op_CancelRotateSecret.go b/service/secretsmanager/api_op_CancelRotateSecret.go index 18edf0d2fde..42ce02ce52e 100644 --- a/service/secretsmanager/api_op_CancelRotateSecret.go +++ b/service/secretsmanager/api_op_CancelRotateSecret.go @@ -11,22 +11,29 @@ import ( ) // Turns off automatic rotation, and if a rotation is currently in progress, -// cancels the rotation. If you cancel a rotation in progress, it can leave the -// 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 -// 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) -// . +// cancels the rotation. +// +// If you cancel a rotation in progress, it can leave the 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]. +// +// 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]. +// +// Required permissions: secretsmanager:CancelRotateSecret . For more information, +// see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [How rotation works]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) CancelRotateSecret(ctx context.Context, params *CancelRotateSecretInput, optFns ...func(*Options)) (*CancelRotateSecretOutput, error) { if params == nil { params = &CancelRotateSecretInput{} @@ -44,9 +51,12 @@ 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) - // . + // 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]. + // + // [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 46d984e010b..b25d5d171d2 100644 --- a/service/secretsmanager/api_op_CreateSecret.go +++ b/service/secretsmanager/api_op_CreateSecret.go @@ -17,35 +17,49 @@ import ( // 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 +// +// 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]. +// +// For information about creating a secret in the console, see [Create a secret]. +// +// 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 -// 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 +// matches the [JSON structure of a database secret]. +// +// 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]. +// +// 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] +// and [Authentication and access control in Secrets Manager]. +// +// To encrypt the secret with a KMS key other than aws/secretsmanager , you need // kms:GenerateDataKey and kms:Decrypt permission to the key. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Secrets Manager secrets managed by other Amazon Web Services services]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html +// [Create a secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [JSON structure of a database secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html func (c *Client) CreateSecret(ctx context.Context, params *CreateSecretInput, optFns ...func(*Options)) (*CreateSecretOutput, error) { if params == nil { params = &CreateSecretInput{} @@ -63,12 +77,15 @@ func (c *Client) CreateSecret(ctx context.Context, params *CreateSecretInput, op type CreateSecretInput struct { - // The name of the new secret. The secret name can contain ASCII letters, numbers, - // and the following characters: /_+=.@- Do not end your secret name with a hyphen - // followed by six characters. If you do so, you risk confusion and unexpected - // results when searching for a secret by partial ARN. Secrets Manager - // automatically adds a hyphen and six random characters after the secret name at - // the end of the ARN. + // The name of the new secret. + // + // The secret name can contain ASCII letters, numbers, and the following + // characters: /_+=.@- + // + // Do not end your secret name with a hyphen followed by six characters. If you do + // so, you risk confusion and unexpected results when searching for a secret by + // partial ARN. Secrets Manager automatically adds a hyphen and six random + // characters after the secret name at the end of the ARN. // // This member is required. Name *string @@ -78,26 +95,36 @@ type CreateSecretInput struct { // 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 - // parameter empty. The CLI or SDK generates a random UUID for you and includes it - // as the value for this parameter in the request. If you generate a raw HTTP - // request to the Secrets Manager service endpoint, then you must generate a - // ClientRequestToken and include it 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 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. + // 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. The CLI or SDK + // generates a random UUID for you and includes it as the value for this parameter + // in the request. + // + // If you generate a raw HTTP request to the Secrets Manager service endpoint, + // then you must generate a ClientRequestToken and include it 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 a rotation. We recommend that you generate a [UUID-type]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. + // request fails because you cannot modify an existing version. Instead, use PutSecretValueto + // create a new version. + // // This value becomes the VersionId of the new version. + // + // [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier ClientRequestToken *string // The description of the secret. @@ -109,50 +136,67 @@ type CreateSecretInput struct { // 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 + // example alias/aws/secretsmanager . For more information, see [About aliases]. + // + // 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. + // 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. + // + // [About aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html KmsKeyId *string // The binary data to encrypt and store in the new version of the secret. We // recommend that you store your binary data in a file and then pass the contents - // of the file as a parameter. Either SecretString or SecretBinary must have a - // value, but not both. This parameter is not available in the Secrets Manager - // console. + // of the file as a parameter. + // + // Either SecretString or SecretBinary must have a value, but not both. + // + // This parameter is not available in the Secrets Manager console. SecretBinary []byte // The text data to encrypt and store in this new version of the secret. We // recommend you use a JSON structure of key/value pairs for your secret value. - // Either SecretString or SecretBinary must have a value, but not both. If you - // create a secret by using the Secrets Manager console then Secrets Manager puts - // the protected secret text in only the SecretString parameter. The Secrets - // Manager console stores the information as a JSON structure of key/value pairs - // that a Lambda rotation function can parse. + // + // Either SecretString or SecretBinary must have a value, but not both. + // + // If you create a secret by using the Secrets Manager console then Secrets + // Manager puts the protected secret text in only the SecretString parameter. The + // Secrets Manager console stores the information as a JSON structure of key/value + // pairs that a Lambda rotation function can parse. SecretString *string // A list of tags to attach to the secret. Each tag is a key and value pair of // strings in a JSON text string, for example: - // [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}] + // + // [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}] + // // Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a - // different tag from one with key "abc". If you check tags in permissions policies - // as part of your security strategy, then adding or removing a tag can change - // 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. For tag quotas and naming restrictions, see - // Service quotas for Tagging (https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas) - // in the Amazon Web Services General Reference guide. + // different tag from one with key "abc". + // + // If you check tags in permissions policies as part of your security strategy, + // then adding or removing a tag can change 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]and [Limit access to identities with tags that match secrets' tags]. + // + // For information about how to format a JSON parameter for the various command + // line tool environments, see [Using JSON for Parameters]. 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. + // + // For tag quotas and naming restrictions, see [Service quotas for Tagging] in the Amazon Web Services General + // Reference guide. + // + // [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 + // [Using JSON for Parameters]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json + // [Service quotas for Tagging]: https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas + // [Control access to secrets using tags]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac Tags []types.Tag noSmithyDocumentSerde @@ -170,9 +214,12 @@ 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. ReplicationStatus []types.ReplicationStatusType diff --git a/service/secretsmanager/api_op_DeleteResourcePolicy.go b/service/secretsmanager/api_op_DeleteResourcePolicy.go index 46e5b4798d5..4d8772a484d 100644 --- a/service/secretsmanager/api_op_DeleteResourcePolicy.go +++ b/service/secretsmanager/api_op_DeleteResourcePolicy.go @@ -11,14 +11,18 @@ import ( ) // 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) -// . +// 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]. +// +// Required permissions: secretsmanager:DeleteResourcePolicy . For more +// information, see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { params = &DeleteResourcePolicyInput{} @@ -37,9 +41,11 @@ func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourc 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]. + // + // [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 f34999b0681..153f42b7649 100644 --- a/service/secretsmanager/api_op_DeleteSecret.go +++ b/service/secretsmanager/api_op_DeleteSecret.go @@ -15,31 +15,41 @@ import ( // during which you can restore the secret. The minimum recovery window is 7 days. // The default recovery window is 30 days. Secrets Manager attaches a DeletionDate // 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 -// 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 -// 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 +// 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 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 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]. +// +// 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) -// . +// 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 RestoreSecretand 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]. +// +// Required permissions: secretsmanager:DeleteSecret . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Monitor secrets scheduled for deletion]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, optFns ...func(*Options)) (*DeleteSecretOutput, error) { if params == nil { params = &DeleteSecretInput{} @@ -57,10 +67,12 @@ func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, op 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) - // . + // 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]. + // + // [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 @@ -68,17 +80,20 @@ type DeleteSecretInput struct { // Specifies whether to delete the secret without any recovery window. You can't // use both this parameter and RecoveryWindowInDays in the same call. If you don't // use either, then by default Secrets Manager uses a 30 day recovery window. + // // Secrets Manager performs the actual deletion with an asynchronous background // process, so there might be a short delay before the secret is permanently // deleted. If you delete a secret and then immediately create a secret with the - // same name, use appropriate back off and retry logic. If you forcibly delete an - // already deleted or nonexistent secret, the operation does not return - // ResourceNotFoundException . Use this parameter with caution. This parameter - // causes the operation to skip the normal recovery window before the permanent - // deletion that Secrets Manager would normally impose with the - // RecoveryWindowInDays parameter. If you delete a secret with the - // ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover - // the secret. You lose the secret permanently. + // same name, use appropriate back off and retry logic. + // + // If you forcibly delete an already deleted or nonexistent secret, the operation + // does not return ResourceNotFoundException . + // + // Use this parameter with caution. This parameter causes the operation to skip + // the normal recovery window before the permanent deletion that Secrets Manager + // would normally impose with the RecoveryWindowInDays parameter. If you delete a + // secret with the ForceDeleteWithoutRecovery parameter, then you have no + // opportunity to recover the secret. You lose the secret permanently. ForceDeleteWithoutRecovery *bool // The number of days from 7 to 30 that Secrets Manager waits before permanently diff --git a/service/secretsmanager/api_op_DescribeSecret.go b/service/secretsmanager/api_op_DescribeSecret.go index 0eb7526cc4a..be73019d444 100644 --- a/service/secretsmanager/api_op_DescribeSecret.go +++ b/service/secretsmanager/api_op_DescribeSecret.go @@ -14,13 +14,17 @@ import ( // Retrieves the details of a secret. It does not include the encrypted secret // 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]. +// +// Required permissions: secretsmanager:DescribeSecret . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) DescribeSecret(ctx context.Context, params *DescribeSecretInput, optFns ...func(*Options)) (*DescribeSecretOutput, error) { if params == nil { params = &DescribeSecretInput{} @@ -38,9 +42,12 @@ 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) - // . + // 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]. + // + // [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 @@ -60,9 +67,11 @@ type DescribeSecretOutput struct { // deletion, this field is omitted. When you delete a secret, Secrets Manager // requires a recovery window of at least 7 days before deleting the secret. Some // 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 . + // 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. DeletedDate *time.Time // The description of the secret. @@ -93,15 +102,17 @@ type DescribeSecretOutput struct { // isn't configured for rotation or rotation has been disabled, Secrets Manager // returns null. If rotation fails, Secrets Manager retries the entire rotation // process multiple times. If rotation is unsuccessful, this date may be in the - // past. This date represents the latest date that rotation will occur, but it is - // not an approximate rotation date. In some cases, for example if you turn off - // automatic rotation and then turn it back on, the next rotation may occur much - // sooner than this date. + // past. + // + // This date represents the latest date that rotation will occur, but it is not an + // approximate rotation date. In some cases, for example if you turn off automatic + // rotation and then turn it back on, the next rotation may occur much sooner than + // this date. 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) - // . + // The ID of the service that created this secret. For more information, see [Secrets managed by other Amazon Web Services services]. + // + // [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 @@ -109,14 +120,18 @@ type DescribeSecretOutput struct { 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. 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 . + // Specifies whether automatic rotation is turned on for this secret. + // + // To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret. RotationEnabled *bool // The ARN of the Lambda function that Secrets Manager invokes to rotate the @@ -129,25 +144,32 @@ type DescribeSecretOutput struct { // rotation turned on, this field is omitted. RotationRules *types.RotationRulesType - // The list of tags attached to the secret. To add tags to a secret, use - // TagResource . To remove tags, use UntagResource . + // The list of tags attached to the secret. To add tags to a secret, use 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: + // 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 . + // 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) - // . + // + // For more information about rotation and staging labels, see [How rotation works]. + // + // [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 f310b6e0a7e..857fe52db99 100644 --- a/service/secretsmanager/api_op_GetRandomPassword.go +++ b/service/secretsmanager/api_op_GetRandomPassword.go @@ -14,12 +14,15 @@ import ( // and include every character type that the system you are generating a password // for can support. By default, Secrets Manager uses uppercase and lowercase // letters, numbers, and the following characters in passwords: -// !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ Secrets Manager generates a CloudTrail log -// entry when you call this action. 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) -// . +// !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ +// +// Secrets Manager generates a CloudTrail log entry when you call this action. +// +// Required permissions: secretsmanager:GetRandomPassword . For more information, +// see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) GetRandomPassword(ctx context.Context, params *GetRandomPasswordInput, optFns ...func(*Options)) (*GetRandomPasswordOutput, error) { if params == nil { params = &GetRandomPasswordInput{} diff --git a/service/secretsmanager/api_op_GetResourcePolicy.go b/service/secretsmanager/api_op_GetResourcePolicy.go index ce67c7e1dcc..3a2e6c685a2 100644 --- a/service/secretsmanager/api_op_GetResourcePolicy.go +++ b/service/secretsmanager/api_op_GetResourcePolicy.go @@ -12,14 +12,19 @@ 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]. +// +// 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]. +// +// Required permissions: secretsmanager:GetResourcePolicy . For more information, +// see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [Permissions policies attached to a secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error) { if params == nil { params = &GetResourcePolicyInput{} @@ -38,9 +43,12 @@ func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolic 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) - // . + // 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]. + // + // [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,9 +65,9 @@ type GetResourcePolicyOutput struct { Name *string // 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) - // . + // secret. For more information about permissions policies, see [Authentication and access control for Secrets Manager]. + // + // [Authentication and 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 5f099252bfc..16a7f98dea0 100644 --- a/service/secretsmanager/api_op_GetSecretValue.go +++ b/service/secretsmanager/api_op_GetSecretValue.go @@ -12,23 +12,31 @@ import ( ) // Retrieves the contents of the encrypted fields SecretString or SecretBinary -// from the specified version of a secret, whichever contains content. To retrieve -// the values for a group of secrets, call BatchGetSecretValue . 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 -// 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 +// from the specified version of a secret, whichever contains content. +// +// To retrieve the values for a group of secrets, call BatchGetSecretValue. +// +// 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]. +// +// To retrieve the previous version of a secret, use VersionStage and specify +// AWSPREVIOUS. To revert to the previous version of a secret, call [UpdateSecretVersionStage]. +// +// 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]. +// +// 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]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [UpdateSecretVersionStage]: https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [Cache secrets for your applications]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html func (c *Client) GetSecretValue(ctx context.Context, params *GetSecretValueInput, optFns ...func(*Options)) (*GetSecretValueOutput, error) { if params == nil { params = &GetSecretValueInput{} @@ -46,10 +54,12 @@ func (c *Client) GetSecretValue(ctx context.Context, params *GetSecretValueInput 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) - // . + // 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]. + // + // [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,15 +67,18 @@ type GetSecretValueInput struct { // 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 - // 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. + // Secrets Manager returns the AWSCURRENT version. + // + // This value is typically a [UUID-type] value with 32 hexadecimal digits. + // + // [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier 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 + // 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 @@ -88,16 +101,18 @@ type GetSecretValueOutput struct { // The decrypted secret value, if the secret value was originally provided as // binary data in the form of a byte array. When you retrieve a SecretBinary using // the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is - // Base64-encoded. Otherwise, it is not encoded. If the secret was created by using - // the Secrets Manager console, or if the secret value was originally provided as a - // string, then this field is omitted. The secret value appears in SecretString - // instead. + // Base64-encoded. Otherwise, it is not encoded. + // + // If the secret was created by using the Secrets Manager console, or if the + // secret value was originally provided as a string, then this field is omitted. + // The secret value appears in SecretString instead. SecretBinary []byte // The decrypted secret value, if the secret value was originally provided as a - // string or through the Secrets Manager console. If this secret was created by - // using the console, then Secrets Manager stores the information as a JSON - // structure of key/value pairs. + // string or through the Secrets Manager console. + // + // If this secret was created by using the console, then Secrets Manager stores + // the information as a JSON structure of key/value pairs. SecretString *string // The unique identifier of this version of the secret. diff --git a/service/secretsmanager/api_op_ListSecretVersionIds.go b/service/secretsmanager/api_op_ListSecretVersionIds.go index 53ff4c41456..0cb7f524be2 100644 --- a/service/secretsmanager/api_op_ListSecretVersionIds.go +++ b/service/secretsmanager/api_op_ListSecretVersionIds.go @@ -12,16 +12,21 @@ 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]. +// +// 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]. +// +// Required permissions: secretsmanager:ListSecretVersionIds . For more +// information, see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Secrets Manager concepts: Versions]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) ListSecretVersionIds(ctx context.Context, params *ListSecretVersionIdsInput, optFns ...func(*Options)) (*ListSecretVersionIdsOutput, error) { if params == nil { params = &ListSecretVersionIdsInput{} @@ -39,10 +44,12 @@ 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) - // . + // 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]. + // + // [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 +60,11 @@ type ListSecretVersionIdsInput struct { // without staging labels aren't included. 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 . + // 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 . MaxResults *int32 // A token that indicates where the output should continue from, if a previous @@ -179,9 +188,11 @@ var _ ListSecretVersionIdsAPIClient = (*Client)(nil) // ListSecretVersionIdsPaginatorOptions is the paginator options for // 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 . + // 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 . 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 318cda1be32..7ebdc309e29 100644 --- a/service/secretsmanager/api_op_ListSecrets.go +++ b/service/secretsmanager/api_op_ListSecrets.go @@ -13,20 +13,29 @@ import ( // Lists the secrets that are stored by Secrets Manager in the Amazon Web Services // account, not including secrets that are marked for deletion. To see secrets -// marked for deletion, use the Secrets Manager console. All Secrets Manager -// operations are eventually consistent. ListSecrets might not reflect changes from -// the last five minutes. You can get more recent information for a specific secret -// by calling DescribeSecret . To list the versions of a secret, use -// ListSecretVersionIds . To retrieve the values for the secrets, call -// BatchGetSecretValue or 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 +// marked for deletion, use the Secrets Manager console. +// +// All Secrets Manager operations are eventually consistent. ListSecrets might not +// reflect changes from the last five minutes. You can get more recent information +// for a specific secret by calling DescribeSecret. +// +// To list the versions of a secret, use ListSecretVersionIds. +// +// To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue. +// +// For information about finding secrets in the console, see [Find secrets in 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: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]. +// +// Required permissions: secretsmanager:ListSecrets . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [Find secrets in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html func (c *Client) ListSecrets(ctx context.Context, params *ListSecretsInput, optFns ...func(*Options)) (*ListSecretsOutput, error) { if params == nil { params = &ListSecretsInput{} @@ -51,9 +60,11 @@ type ListSecretsInput struct { // secrets scheduled for deletion aren't included. 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 . + // 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 . MaxResults *int32 // A token that indicates where the output should continue from, if a previous @@ -169,9 +180,11 @@ 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 . + // 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 . 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 37e9b5543bb..a3e366896df 100644 --- a/service/secretsmanager/api_op_PutResourcePolicy.go +++ b/service/secretsmanager/api_op_PutResourcePolicy.go @@ -11,17 +11,22 @@ import ( ) // 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 +// policy is optional. For more information, see [Authentication and access control for Secrets Manager] +// +// For information about attaching a policy in the console, see [Attach a permissions policy to a 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: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]. +// +// Required permissions: secretsmanager:PutResourcePolicy . For more information, +// see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Attach a permissions policy to a secret]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [Authentication and access control for 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{} @@ -40,34 +45,42 @@ 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]. + // + // [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) - // . + // 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]. + // + // [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 // Specifies whether to block resource-based policies that allow broad access to // the secret, for example those that use a wildcard for the principal. By default, - // public policies aren't blocked. Resource policy validation and the - // BlockPublicPolicy parameter help protect your resources by preventing public - // access from being granted through the resource policies that are directly - // attached to your secrets. In addition to using these features, carefully inspect - // the following policies to confirm that they do not grant public access: + // public policies aren't blocked. + // + // Resource policy validation and the BlockPublicPolicy parameter help protect + // your resources by preventing public access from being granted through the + // resource policies that are directly attached to your secrets. In addition to + // using these features, carefully inspect the following policies to confirm that + // they do not grant public access: + // // - Identity-based policies attached to associated Amazon Web Services // principals (for example, IAM roles) + // // - Resource-based policies attached to associated Amazon Web Services // resources (for example, Key Management Service (KMS) keys) - // To review permissions to your secrets, see Determine who has permissions to - // your secrets (https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html) - // . + // + // To review permissions to your secrets, see [Determine who has permissions to your secrets]. + // + // [Determine who has permissions to your secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html BlockPublicPolicy *bool noSmithyDocumentSerde diff --git a/service/secretsmanager/api_op_PutSecretValue.go b/service/secretsmanager/api_op_PutSecretValue.go index 0304d3bbbbc..b82eb6c1e1b 100644 --- a/service/secretsmanager/api_op_PutSecretValue.go +++ b/service/secretsmanager/api_op_PutSecretValue.go @@ -12,32 +12,41 @@ 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]. +// +// Required permissions: secretsmanager:PutSecretValue . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) PutSecretValue(ctx context.Context, params *PutSecretValueInput, optFns ...func(*Options)) (*PutSecretValueOutput, error) { if params == nil { params = &PutSecretValueInput{} @@ -55,57 +64,79 @@ func (c *Client) PutSecretValue(ctx context.Context, params *PutSecretValueInput 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. + // 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]. + // + // If the secret doesn't already exist, use CreateSecret instead. + // + // [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 - // 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. The CLI or SDK generates a random UUID - // for you and includes it as the value for this parameter in the request. If you - // generate a raw HTTP request to the Secrets Manager service endpoint, then you - // must generate a ClientRequestToken and include it 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 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. + // 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. The CLI or SDK + // generates a random UUID for you and includes it as the value for this parameter + // in the request. + // + // If you generate a raw HTTP request to the Secrets Manager service endpoint, + // then you must generate a ClientRequestToken and include it 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 a rotation. We recommend that you generate a [UUID-type]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 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. + // + // [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier 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 - // value from the Secrets Manager console. + // 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 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 // Manager uses staging labels to track versions of a secret through the rotation - // 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 - // also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was - // removed from. If you don't include VersionStages , then Secrets Manager - // automatically moves the staging label AWSCURRENT to this version. + // 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 also moves the + // staging label AWSPREVIOUS to the version that AWSCURRENT was removed from. + // + // If you don't include VersionStages , then Secrets Manager automatically moves + // the staging label AWSCURRENT to this version. VersionStages []string noSmithyDocumentSerde diff --git a/service/secretsmanager/api_op_RemoveRegionsFromReplication.go b/service/secretsmanager/api_op_RemoveRegionsFromReplication.go index 404d3e4a45c..44950e257ad 100644 --- a/service/secretsmanager/api_op_RemoveRegionsFromReplication.go +++ b/service/secretsmanager/api_op_RemoveRegionsFromReplication.go @@ -12,14 +12,18 @@ 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) -// . +// 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]. +// +// Required permissions: secretsmanager:RemoveRegionsFromReplication . For more +// information, see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions 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 896017c39f8..e6115da0f23 100644 --- a/service/secretsmanager/api_op_ReplicateSecretToRegions.go +++ b/service/secretsmanager/api_op_ReplicateSecretToRegions.go @@ -11,17 +11,22 @@ 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]. +// +// 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 . If the primary +// logged. For more information, see [Logging Secrets Manager events with CloudTrail]. +// +// Required permissions: secretsmanager:ReplicateSecretToRegions . If the primary // secret is encrypted with a KMS key other than aws/secretsmanager , you also need // kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS // key other than aws/secretsmanager , you need kms:GenerateDataKey and kms:Encrypt -// to the 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) -// . +// to the key. For more information, see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Multi-Region secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions 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 db3b6622f03..adcd8ce4ab7 100644 --- a/service/secretsmanager/api_op_RestoreSecret.go +++ b/service/secretsmanager/api_op_RestoreSecret.go @@ -11,14 +11,18 @@ import ( ) // Cancels the scheduled deletion of a secret by removing the DeletedDate time -// 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) -// . +// 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]. +// +// Required permissions: secretsmanager:RestoreSecret . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) RestoreSecret(ctx context.Context, params *RestoreSecretInput, optFns ...func(*Options)) (*RestoreSecretOutput, error) { if params == nil { params = &RestoreSecretInput{} @@ -36,10 +40,12 @@ func (c *Client) RestoreSecret(ctx context.Context, params *RestoreSecretInput, 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) - // . + // 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]. + // + // [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_RotateSecret.go b/service/secretsmanager/api_op_RotateSecret.go index f5ea3c9b804..7d11126c945 100644 --- a/service/secretsmanager/api_op_RotateSecret.go +++ b/service/secretsmanager/api_op_RotateSecret.go @@ -12,28 +12,35 @@ 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) -// 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 -// starts a rotation with the values already stored in the secret. When rotation is -// 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 -// 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) -// 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) -// . +// information about rotation, see [Rotate secrets]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 starts a rotation with the values +// already stored in the secret. +// +// When rotation is 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 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]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]. +// +// Required permissions: secretsmanager:RotateSecret . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. You also need lambda:InvokeFunction permissions on the rotation function. +// For more information, see [Permissions for rotation]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Permissions for rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html +// [Rotate secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Troubleshoot rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) RotateSecret(ctx context.Context, params *RotateSecretInput, optFns ...func(*Options)) (*RotateSecretOutput, error) { if params == nil { params = &RotateSecretInput{} @@ -51,42 +58,56 @@ func (c *Client) RotateSecret(ctx context.Context, params *RotateSecretInput, op 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) - // . + // 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]. + // + // [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 // A unique identifier for the new version of the secret. You only need to specify // this value if you implement your own retry logic and you want to ensure that - // Secrets Manager doesn't attempt to create a secret version twice. 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. The CLI or SDK generates a - // random UUID for you and includes it as the value for this parameter in the - // request. If you generate a raw HTTP request to the Secrets Manager service - // endpoint, then you must generate a ClientRequestToken and include it 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 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. + // Secrets Manager doesn't attempt to create a secret version twice. + // + // 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. The CLI or SDK + // generates a random UUID for you and includes it as the value for this parameter + // in the request. + // + // If you generate a raw HTTP request to the Secrets Manager service endpoint, + // then you must generate a ClientRequestToken and include it 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 a rotation. We recommend that you generate a [UUID-type]value to ensure uniqueness + // of your versions within the specified secret. + // + // [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier ClientRequestToken *string // 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 - // 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) - // of the Lambda rotation function. The test creates an AWSPENDING version of the - // secret and then removes it. By default, Secrets Manager rotates the secret - // immediately. + // scheduled rotation window. The rotation schedule is defined in 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]testSecret of the Lambda rotation function. The test creates an + // AWSPENDING version of the secret and then removes it. + // + // By default, Secrets Manager rotates the secret immediately. + // + // [testSecret step]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html 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) - // in the Secrets Manager User Guide. + // Lambda rotation function. + // + // For secrets that use managed rotation, omit this field. For more information, + // see [Managed rotation]in the Secrets Manager User Guide. + // + // [Managed rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html RotationLambdaARN *string // A structure that defines the rotation configuration for this secret. diff --git a/service/secretsmanager/api_op_StopReplicationToReplica.go b/service/secretsmanager/api_op_StopReplicationToReplica.go index 8f1a14f1ca6..b32fc01e0d3 100644 --- a/service/secretsmanager/api_op_StopReplicationToReplica.go +++ b/service/secretsmanager/api_op_StopReplicationToReplica.go @@ -11,16 +11,21 @@ import ( ) // Removes the link between the replica secret and the primary secret and promotes -// the replica to a primary secret in the replica Region. You must call this -// operation from the Region in which you want to promote the replica to a primary -// 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) -// . +// the replica to a primary secret in the replica Region. +// +// You must call this operation from the Region in which you want to promote the +// replica to a primary 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]. +// +// Required permissions: secretsmanager:StopReplicationToReplica . For more +// information, see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions 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 774df63f302..a59d84f2ba9 100644 --- a/service/secretsmanager/api_op_TagResource.go +++ b/service/secretsmanager/api_op_TagResource.go @@ -13,20 +13,27 @@ import ( // 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. For tag -// quotas and naming restrictions, see Service quotas for Tagging (https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas) -// in the Amazon Web Services General Reference guide. 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) -// . +// the secret. This operation appends tags to the existing list of tags. +// +// For tag quotas and naming restrictions, see [Service quotas for Tagging] in the Amazon Web Services General +// Reference guide. +// +// 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]. +// +// Required permissions: secretsmanager:TagResource . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [Service quotas for Tagging]: https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -45,20 +52,24 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF 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) - // . + // 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]. + // + // [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 - // 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. + // 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]in the Amazon + // Web Services CLI User Guide. + // + // [Specifying parameter values for the Amazon Web Services CLI]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html // // This member is required. Tags []types.Tag diff --git a/service/secretsmanager/api_op_UntagResource.go b/service/secretsmanager/api_op_UntagResource.go index faabca5ea97..f089be8e84c 100644 --- a/service/secretsmanager/api_op_UntagResource.go +++ b/service/secretsmanager/api_op_UntagResource.go @@ -10,19 +10,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes specific tags from a secret. This operation is idempotent. If a -// requested tag is not attached to the secret, no error is returned and the secret -// metadata is unchanged. If you use tags as part of your security strategy, then -// 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: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) -// . +// Removes specific tags from a secret. +// +// This operation is idempotent. If a requested tag is not attached to the secret, +// no error is returned and the secret metadata is unchanged. +// +// If you use tags as part of your security strategy, then 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]. +// +// Required permissions: secretsmanager:UntagResource . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -40,19 +47,26 @@ 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) - // . + // 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]. + // + // [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 // A list of tag key names to remove from the secret. You don't specify the value. - // 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. + // 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]in the Amazon + // Web Services CLI User Guide. + // + // [Specifying parameter values for the Amazon Web Services CLI]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html // // This member is required. TagKeys []string diff --git a/service/secretsmanager/api_op_UpdateSecret.go b/service/secretsmanager/api_op_UpdateSecret.go index a18d03351c7..336e9ab19da 100644 --- a/service/secretsmanager/api_op_UpdateSecret.go +++ b/service/secretsmanager/api_op_UpdateSecret.go @@ -11,37 +11,47 @@ 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]. +// +// 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 // created less than 24 hours ago. If you update the secret value more than once // every 10 minutes, you create more versions than Secrets Manager removes, and you -// will reach the quota for secret versions. If you include SecretString or -// 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 , -// kms:Encrypt , and kms:Decrypt permissions on the key. If you change the KMS key -// and you don't have kms:Encrypt permission to the new key, Secrets Manager does -// not re-ecrypt existing secret versions with the new key. For more information, -// see Secret encryption and decryption (https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html) -// . +// will reach the quota for secret versions. +// +// If you include SecretString or 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]. +// +// Required permissions: secretsmanager:UpdateSecret . For more information, see [IAM policy actions for Secrets Manager] +// and [Authentication and access control in Secrets Manager]. If you use a customer managed key, you must also have kms:GenerateDataKey +// , kms:Encrypt , and kms:Decrypt permissions on the key. If you change the KMS +// key and you don't have kms:Encrypt permission to the new key, Secrets Manager +// does not re-ecrypt existing secret versions with the new key. For more +// information, see [Secret encryption and decryption]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Secret encryption and decryption]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html +// [Secrets Manager secrets managed by other Amazon Web Services services]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) UpdateSecret(ctx context.Context, params *UpdateSecretInput, optFns ...func(*Options)) (*UpdateSecretOutput, error) { if params == nil { params = &UpdateSecretInput{} @@ -59,25 +69,34 @@ 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) - // . + // 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]. + // + // [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 // 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. - // The CLI or SDK generates a random UUID for you and includes it as the value for - // this parameter in the request. If you generate a raw HTTP request to the Secrets - // Manager service endpoint, then you must generate a ClientRequestToken and - // include it 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 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. + // 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. The CLI or SDK + // generates a random UUID for you and includes it as the value for this parameter + // in the request. + // + // If you generate a raw HTTP request to the Secrets Manager service endpoint, + // then you must generate a ClientRequestToken and include it 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 a rotation. We recommend that you generate a [UUID-type]value to ensure uniqueness + // of your versions within the specified secret. + // + // [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier ClientRequestToken *string // The description of the secret. @@ -88,32 +107,41 @@ type UpdateSecretInput struct { // AWSCURRENT , AWSPENDING , or AWSPREVIOUS . If you don't have kms:Encrypt // permission to the new key, Secrets Manager does not re-ecrypt existing secret // versions with the new key. 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 + // labels, see [Concepts: Version]. + // + // A key alias is always prefixed by alias/ , for example alias/aws/secretsmanager + // . For more information, see [About aliases]. + // + // 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 - // the secret is in a different account, then you must use a customer managed key - // and provide the ARN of that KMS key in this field. The user making the call must - // have permissions to both the secret and the KMS key in their respective - // accounts. + // 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 the secret is in a different account, then you must use + // a customer managed key and provide the ARN of that KMS key in this field. The + // user making the call must have permissions to both the secret and the KMS key in + // their respective accounts. + // + // [Concepts: Version]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version + // [About aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html KmsKeyId *string // The binary data to encrypt and store in the new version of the secret. We // recommend that you store your binary data in a file and then pass the contents - // of the file as a parameter. Either SecretBinary or SecretString must have a - // value, but not both. You can't access this parameter in the Secrets Manager - // console. + // of the file as a parameter. + // + // Either SecretBinary or SecretString must have a value, but not both. + // + // You can't access this parameter in the Secrets Manager console. SecretBinary []byte // The text data to encrypt and store in the new version of the secret. We // recommend you use a JSON structure of key/value pairs for your secret value. + // // Either SecretBinary or SecretString must have a value, but not both. SecretString *string diff --git a/service/secretsmanager/api_op_UpdateSecretVersionStage.go b/service/secretsmanager/api_op_UpdateSecretVersionStage.go index 922bb7fe109..cf266679102 100644 --- a/service/secretsmanager/api_op_UpdateSecretVersionStage.go +++ b/service/secretsmanager/api_op_UpdateSecretVersionStage.go @@ -16,21 +16,31 @@ 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 -// '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) -// . +// see [Concepts: 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]. +// +// Required permissions: secretsmanager:UpdateSecretVersionStage . For more +// information, see [IAM policy actions for Secrets Manager]and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [Concepts: Version]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions func (c *Client) UpdateSecretVersionStage(ctx context.Context, params *UpdateSecretVersionStageInput, optFns ...func(*Options)) (*UpdateSecretVersionStageOutput, error) { if params == nil { params = &UpdateSecretVersionStageInput{} @@ -49,9 +59,11 @@ func (c *Client) UpdateSecretVersionStage(ctx context.Context, params *UpdateSec 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]. + // + // [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 @@ -62,9 +74,10 @@ type UpdateSecretVersionStageInput struct { VersionStage *string // The ID of the version to add the staging label to. To remove a label from a - // version, then do not specify this parameter. If the staging label is already - // attached to a different version of the secret, then you must also specify the - // RemoveFromVersionId parameter. + // version, then do not specify this parameter. + // + // If the staging label is already attached to a different version of the secret, + // then you must also specify the RemoveFromVersionId parameter. MoveToVersionId *string // The ID of the version that the staging label is to be removed from. If the diff --git a/service/secretsmanager/api_op_ValidateResourcePolicy.go b/service/secretsmanager/api_op_ValidateResourcePolicy.go index ac161518371..eef801a098c 100644 --- a/service/secretsmanager/api_op_ValidateResourcePolicy.go +++ b/service/secretsmanager/api_op_ValidateResourcePolicy.go @@ -12,23 +12,29 @@ 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. +// 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], 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 and -// 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]. +// +// Required permissions: secretsmanager:ValidateResourcePolicy and +// secretsmanager:PutResourcePolicy . For more information, see [IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager]. +// +// [Authentication and access control in Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html +// [Logging Secrets Manager events with CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html +// [IAM policy actions for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions +// [Zelkova]: https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/ func (c *Client) ValidateResourcePolicy(ctx context.Context, params *ValidateResourcePolicyInput, optFns ...func(*Options)) (*ValidateResourcePolicyOutput, error) { if params == nil { params = &ValidateResourcePolicyInput{} @@ -48,8 +54,9 @@ 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]. + // + // [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 e3e68d833d0..2d0ba2e6562 100644 --- a/service/secretsmanager/doc.go +++ b/service/secretsmanager/doc.go @@ -3,29 +3,43 @@ // 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 -// 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 +// +// 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]. +// +// # 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]. +// +// # Support and Feedback for Amazon Web Services Secrets Manager +// +// We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and +// questions in the [Amazon Web Services Secrets Manager Discussion Forum]. For more information about the Amazon Web Services +// Discussion Forums, see [Forums Help]. +// +// # 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) -// . +// for Amazon Web Services CloudTrail, see [Logging Amazon Web Services Secrets Manager Events with Amazon Web Services 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]. +// +// [Forums Help]: http://forums.aws.amazon.com/help.jspa +// [Amazon Web Services CloudTrail User Guide]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html +// [Amazon Web Services Secrets Manager endpoints]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints +// [Amazon Web Services Secrets Manager User Guide]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html +// [Amazon Web Services Secrets Manager Discussion Forum]: http://forums.aws.amazon.com/forum.jspa?forumID=296 +// [Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail package secretsmanager diff --git a/service/secretsmanager/options.go b/service/secretsmanager/options.go index a8817523e98..7f022a393c6 100644 --- a/service/secretsmanager/options.go +++ b/service/secretsmanager/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/secretsmanager/types/enums.go b/service/secretsmanager/types/enums.go index 84f46d0bd5d..e458ec8fecd 100644 --- a/service/secretsmanager/types/enums.go +++ b/service/secretsmanager/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for FilterNameStringType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterNameStringType) Values() []FilterNameStringType { return []FilterNameStringType{ "description", @@ -39,8 +40,9 @@ const ( ) // Values returns all known values for SortOrderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SortOrderType) Values() []SortOrderType { return []SortOrderType{ "asc", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for StatusType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusType) Values() []StatusType { return []StatusType{ "InSync", diff --git a/service/secretsmanager/types/errors.go b/service/secretsmanager/types/errors.go index aff130bb247..09c59ed19c2 100644 --- a/service/secretsmanager/types/errors.go +++ b/service/secretsmanager/types/errors.go @@ -36,8 +36,9 @@ 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]. +// +// [Key state: Effect on your KMS key]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html type EncryptionFailure struct { Message *string @@ -141,16 +142,20 @@ func (e *InvalidParameterException) ErrorCode() string { } func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// A parameter value is not valid for the current state of the resource. Possible -// causes: +// 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) -// . +// update it. For more information, see [Secrets managed by other Amazon Web Services services]. +// +// [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 e04e17e788c..7b848975a34 100644 --- a/service/secretsmanager/types/types.go +++ b/service/secretsmanager/types/types.go @@ -8,13 +8,12 @@ import ( ) // The error Secrets Manager encountered while retrieving an individual secret as -// part of BatchGetSecretValue . +// part of BatchGetSecretValue. type APIErrorType struct { // The error Secrets Manager encountered while retrieving an individual secret as - // part of BatchGetSecretValue , for example ResourceNotFoundException , - // InvalidParameterException , InvalidRequestException , DecryptionFailure , or - // AccessDeniedException . + // part of BatchGetSecretValue, for example ResourceNotFoundException , InvalidParameterException , + // InvalidRequestException , DecryptionFailure , or AccessDeniedException . ErrorCode *string // A message describing the error. @@ -27,23 +26,33 @@ type APIErrorType struct { } // 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]. +// +// [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. Key FilterNameStringType - // The keyword to filter for. You can prefix your search value with an exclamation - // mark ( ! ) in order to perform negation filters. + // The keyword to filter for. + // + // You can prefix your search value with an exclamation mark ( ! ) in order to + // perform negation filters. Values []string noSmithyDocumentSerde @@ -56,8 +65,9 @@ type ReplicaRegionType struct { // 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]. + // + // [Name and code of Regions]: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints Region *string noSmithyDocumentSerde @@ -94,11 +104,13 @@ 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 - // 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 . + // 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 . AutomaticallyAfterDays *int64 // The length of the rotation window in hours, for example 3h for a three hour @@ -107,39 +119,44 @@ type RotationRulesType struct { // 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) + // closes at the end of the UTC day. For more information, including examples, see [Schedule expressions in Secrets Manager rotation] // in the Secrets Manager Users Guide. + // + // [Schedule expressions in Secrets Manager rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html Duration *string // A cron() or rate() expression that defines the schedule for rotating your // 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 - // 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 - // end of the day. You can set the Duration to change the rotation window. The - // 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) - // in the Secrets Manager Users Guide. For a cron expression that represents a + // 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 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 end of the day. You can set the Duration to + // change the rotation window. The 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]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 // closes at the end of the day. You can set the Duration to change the rotation // window. The rotation window must not extend into the next UTC day or into the // next rotation window. + // + // [Schedule expressions in Secrets Manager rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html ScheduleExpression *string noSmithyDocumentSerde } // 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) -// . +// encrypted SecretString and SecretBinary values. To get those values, use [GetSecretValue] . +// +// [GetSecretValue]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html type SecretListEntry struct { // The Amazon Resource Name (ARN) of the secret. @@ -150,9 +167,10 @@ 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) - // operation. + // window has passed, as specified in the RecoveryWindowInDays parameter of the [DeleteSecret] + // DeleteSecret operation. + // + // [DeleteSecret]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html DeletedDate *time.Time // The user-provided description of the secret. @@ -193,8 +211,9 @@ 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]RotateSecret . + // + // [RotateSecret]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_RotateSecret.html RotationLambdaARN *string // A structure that defines the rotation configuration for the secret. @@ -202,15 +221,17 @@ type SecretListEntry struct { // A list of all of the currently assigned SecretVersionStage staging labels and // the SecretVersionId attached to each one. Staging labels are used to keep track - // of the different versions during the rotation process. A version that does not - // have any SecretVersionStage is considered deprecated and subject to deletion. - // Such versions are not included in this list. + // of the different versions during the rotation process. + // + // A version that does not have any SecretVersionStage is considered deprecated + // and subject to deletion. Such versions are not included in this list. 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]TagResource . To remove tags, use [UntagResource]UntagResource . + // + // [TagResource]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_TagResource.html + // [UntagResource]: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_UntagResource.html Tags []Tag noSmithyDocumentSerde @@ -230,7 +251,9 @@ type SecretValueEntry struct { // The decrypted secret value, if the secret value was originally provided as // binary data in the form of a byte array. The parameter represents the binary - // data as a base64-encoded (https://tools.ietf.org/html/rfc4648#section-4) string. + // data as a [base64-encoded]string. + // + // [base64-encoded]: https://tools.ietf.org/html/rfc4648#section-4 SecretBinary []byte // The decrypted secret value, if the secret value was originally provided as a diff --git a/service/securityhub/api_op_AcceptAdministratorInvitation.go b/service/securityhub/api_op_AcceptAdministratorInvitation.go index 72a61da01c8..8f06604e819 100644 --- a/service/securityhub/api_op_AcceptAdministratorInvitation.go +++ b/service/securityhub/api_op_AcceptAdministratorInvitation.go @@ -11,9 +11,12 @@ import ( ) // 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 +// 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. func (c *Client) AcceptAdministratorInvitation(ctx context.Context, params *AcceptAdministratorInvitationInput, optFns ...func(*Options)) (*AcceptAdministratorInvitationOutput, error) { if params == nil { diff --git a/service/securityhub/api_op_AcceptInvitation.go b/service/securityhub/api_op_AcceptInvitation.go index ed198e97751..e5e09136980 100644 --- a/service/securityhub/api_op_AcceptInvitation.go +++ b/service/securityhub/api_op_AcceptInvitation.go @@ -10,18 +10,23 @@ 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 +// 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 -// through Organizations. When the member account accepts the invitation, -// permission is granted to the administrator account to view findings generated in -// the member account. +// 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. // // Deprecated: This API has been deprecated, use AcceptAdministratorInvitation API // instead. diff --git a/service/securityhub/api_op_BatchDeleteAutomationRules.go b/service/securityhub/api_op_BatchDeleteAutomationRules.go index 8958600b43e..6b21973d034 100644 --- a/service/securityhub/api_op_BatchDeleteAutomationRules.go +++ b/service/securityhub/api_op_BatchDeleteAutomationRules.go @@ -29,7 +29,7 @@ func (c *Client) BatchDeleteAutomationRules(ctx context.Context, params *BatchDe type BatchDeleteAutomationRulesInput struct { - // A list of Amazon Resource Names (ARNs) for the rules that are to be deleted. + // A list of Amazon Resource Names (ARNs) for the rules that are to be deleted. // // This member is required. AutomationRulesArns []string @@ -39,10 +39,10 @@ type BatchDeleteAutomationRulesInput struct { type BatchDeleteAutomationRulesOutput struct { - // A list of properly processed rule ARNs. + // A list of properly processed rule ARNs. ProcessedAutomationRules []string - // A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This + // A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This // parameter tells you which automation rules the request didn't delete and why. UnprocessedAutomationRules []types.UnprocessedAutomationRule diff --git a/service/securityhub/api_op_BatchDisableStandards.go b/service/securityhub/api_op_BatchDisableStandards.go index 024f98427a1..cc143e4cab5 100644 --- a/service/securityhub/api_op_BatchDisableStandards.go +++ b/service/securityhub/api_op_BatchDisableStandards.go @@ -11,9 +11,11 @@ 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) -// section of the Security Hub User Guide. +// Disables the standards specified by the provided StandardsSubscriptionArns . +// +// For more information, see [Security Standards] section of the Security Hub User Guide. +// +// [Security Standards]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html func (c *Client) BatchDisableStandards(ctx context.Context, params *BatchDisableStandardsInput, optFns ...func(*Options)) (*BatchDisableStandardsOutput, error) { if params == nil { params = &BatchDisableStandardsInput{} diff --git a/service/securityhub/api_op_BatchEnableStandards.go b/service/securityhub/api_op_BatchEnableStandards.go index 09aed8b5243..68dd3167b72 100644 --- a/service/securityhub/api_op_BatchEnableStandards.go +++ b/service/securityhub/api_op_BatchEnableStandards.go @@ -12,9 +12,11 @@ import ( ) // 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) -// section of the Security Hub User Guide. +// for a standard, use the DescribeStandards operation. +// +// For more information, see the [Security Standards] section of the Security Hub User Guide. +// +// [Security Standards]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html func (c *Client) BatchEnableStandards(ctx context.Context, params *BatchEnableStandardsInput, optFns ...func(*Options)) (*BatchEnableStandardsOutput, error) { if params == nil { params = &BatchEnableStandardsInput{} diff --git a/service/securityhub/api_op_BatchGetAutomationRules.go b/service/securityhub/api_op_BatchGetAutomationRules.go index 5e1cd2c8da2..b873596fe5f 100644 --- a/service/securityhub/api_op_BatchGetAutomationRules.go +++ b/service/securityhub/api_op_BatchGetAutomationRules.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list of details for automation rules based on rule Amazon Resource +// Retrieves a list of details for automation rules based on rule Amazon Resource +// // Names (ARNs). func (c *Client) BatchGetAutomationRules(ctx context.Context, params *BatchGetAutomationRulesInput, optFns ...func(*Options)) (*BatchGetAutomationRulesOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) BatchGetAutomationRules(ctx context.Context, params *BatchGetAu type BatchGetAutomationRulesInput struct { - // A list of rule ARNs to get details for. + // A list of rule ARNs to get details for. // // This member is required. AutomationRulesArns []string @@ -40,10 +41,10 @@ type BatchGetAutomationRulesInput struct { type BatchGetAutomationRulesOutput struct { - // A list of rule details for the provided rule ARNs. + // A list of rule details for the provided rule ARNs. Rules []types.AutomationRulesConfig - // A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This + // A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This // parameter tells you which automation rules the request didn't retrieve and why. UnprocessedAutomationRules []types.UnprocessedAutomationRule diff --git a/service/securityhub/api_op_BatchGetConfigurationPolicyAssociations.go b/service/securityhub/api_op_BatchGetConfigurationPolicyAssociations.go index d41a5b2f0b2..fa123e9a788 100644 --- a/service/securityhub/api_op_BatchGetConfigurationPolicyAssociations.go +++ b/service/securityhub/api_op_BatchGetConfigurationPolicyAssociations.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns associations between an Security Hub configuration and a batch of +// Returns associations between an Security Hub configuration and a batch of +// // target accounts, organizational units, or the root. Only the Security Hub // delegated administrator can invoke this operation from the home Region. A // configuration can refer to a configuration policy or to a self-managed @@ -33,7 +34,7 @@ func (c *Client) BatchGetConfigurationPolicyAssociations(ctx context.Context, pa type BatchGetConfigurationPolicyAssociationsInput struct { - // Specifies one or more target account IDs, organizational unit (OU) IDs, or the + // Specifies one or more target account IDs, organizational unit (OU) IDs, or the // root ID to retrieve associations for. // // This member is required. @@ -44,10 +45,10 @@ type BatchGetConfigurationPolicyAssociationsInput struct { type BatchGetConfigurationPolicyAssociationsOutput struct { - // Describes associations for the target accounts, OUs, or the root. + // Describes associations for the target accounts, OUs, or the root. ConfigurationPolicyAssociations []types.ConfigurationPolicyAssociationSummary - // An array of configuration policy associations, one for each configuration + // An array of configuration policy associations, one for each configuration // policy association identifier, that was specified in the request but couldn’t be // processed due to an error. UnprocessedConfigurationPolicyAssociations []types.UnprocessedConfigurationPolicyAssociation diff --git a/service/securityhub/api_op_BatchGetSecurityControls.go b/service/securityhub/api_op_BatchGetSecurityControls.go index 6da1c2020a8..1ee0fc3cefe 100644 --- a/service/securityhub/api_op_BatchGetSecurityControls.go +++ b/service/securityhub/api_op_BatchGetSecurityControls.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides details about a batch of security controls for the current Amazon Web +// Provides details about a batch of security controls for the current Amazon Web +// // Services account and Amazon Web Services Region. func (c *Client) BatchGetSecurityControls(ctx context.Context, params *BatchGetSecurityControlsInput, optFns ...func(*Options)) (*BatchGetSecurityControlsOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) BatchGetSecurityControls(ctx context.Context, params *BatchGetS type BatchGetSecurityControlsInput struct { - // A list of security controls (identified with SecurityControlId , + // 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. // @@ -42,14 +43,14 @@ type BatchGetSecurityControlsInput struct { type BatchGetSecurityControlsOutput struct { - // An array that returns the identifier, Amazon Resource Name (ARN), and other + // 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 . // // This member is required. SecurityControls []types.SecurityControl - // A security control (identified with SecurityControlId , SecurityControlArn , or + // A security control (identified with SecurityControlId , SecurityControlArn , or // a mix of both parameters) for which details cannot be returned. UnprocessedIds []types.UnprocessedSecurityControl diff --git a/service/securityhub/api_op_BatchGetStandardsControlAssociations.go b/service/securityhub/api_op_BatchGetStandardsControlAssociations.go index d3c6a8c6f4e..cd39bc602c5 100644 --- a/service/securityhub/api_op_BatchGetStandardsControlAssociations.go +++ b/service/securityhub/api_op_BatchGetStandardsControlAssociations.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For a batch of security controls and standards, identifies whether each control -// is currently enabled or disabled in a standard. +// For a batch of security controls and standards, identifies whether each +// +// control is currently enabled or disabled in a standard. func (c *Client) BatchGetStandardsControlAssociations(ctx context.Context, params *BatchGetStandardsControlAssociationsInput, optFns ...func(*Options)) (*BatchGetStandardsControlAssociationsOutput, error) { if params == nil { params = &BatchGetStandardsControlAssociationsInput{} @@ -30,7 +31,7 @@ func (c *Client) BatchGetStandardsControlAssociations(ctx context.Context, param type BatchGetStandardsControlAssociationsInput struct { - // An array with one or more objects that includes a security control (identified + // 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 // enablement status of a control in a specified standard. The security control ID @@ -50,7 +51,7 @@ type BatchGetStandardsControlAssociationsOutput struct { // This member is required. StandardsControlAssociationDetails []types.StandardsControlAssociationDetail - // A security control (identified with SecurityControlId , SecurityControlArn , or + // 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 53ca7075b46..21da9c692f9 100644 --- a/service/securityhub/api_op_BatchImportFindings.go +++ b/service/securityhub/api_op_BatchImportFindings.go @@ -13,37 +13,53 @@ 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: +// 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. +// are using the [default product ARN]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 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. +// 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. +// +// [default product ARN]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-custom-providers.html#securityhub-custom-providers-bfi-reqs func (c *Client) BatchImportFindings(ctx context.Context, params *BatchImportFindingsInput, optFns ...func(*Options)) (*BatchImportFindingsOutput, error) { if params == nil { params = &BatchImportFindingsInput{} @@ -62,8 +78,9 @@ 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]. Maximum of 100 findings per request. + // + // [Amazon Web Services Security Finding Format]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html // // This member is required. Findings []types.AwsSecurityFinding diff --git a/service/securityhub/api_op_BatchUpdateAutomationRules.go b/service/securityhub/api_op_BatchUpdateAutomationRules.go index e5adfecfc37..a1b4a4c9e60 100644 --- a/service/securityhub/api_op_BatchUpdateAutomationRules.go +++ b/service/securityhub/api_op_BatchUpdateAutomationRules.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates one or more automation rules based on rule Amazon Resource Names (ARNs) -// and input parameters. +// Updates one or more automation rules based on rule Amazon Resource Names +// +// (ARNs) and input parameters. func (c *Client) BatchUpdateAutomationRules(ctx context.Context, params *BatchUpdateAutomationRulesInput, optFns ...func(*Options)) (*BatchUpdateAutomationRulesOutput, error) { if params == nil { params = &BatchUpdateAutomationRulesInput{} @@ -30,8 +31,8 @@ func (c *Client) BatchUpdateAutomationRules(ctx context.Context, params *BatchUp type BatchUpdateAutomationRulesInput struct { - // An array of ARNs for the rules that are to be updated. Optionally, you can also - // include RuleStatus and RuleOrder . + // An array of ARNs for the rules that are to be updated. Optionally, you can + // also include RuleStatus and RuleOrder . // // This member is required. UpdateAutomationRulesRequestItems []types.UpdateAutomationRulesRequestItem @@ -41,10 +42,10 @@ type BatchUpdateAutomationRulesInput struct { type BatchUpdateAutomationRulesOutput struct { - // A list of properly processed rule ARNs. + // A list of properly processed rule ARNs. ProcessedAutomationRules []string - // A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This + // A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This // parameter tells you which automation rules the request didn't update and why. UnprocessedAutomationRules []types.UnprocessedAutomationRule diff --git a/service/securityhub/api_op_BatchUpdateFindings.go b/service/securityhub/api_op_BatchUpdateFindings.go index c4cfe8a7567..8651e310f82 100644 --- a/service/securityhub/api_op_BatchUpdateFindings.go +++ b/service/securityhub/api_op_BatchUpdateFindings.go @@ -14,24 +14,37 @@ import ( // Used by Security Hub customers to update information about their investigation // into a finding. Requested by administrator accounts or member accounts. // Administrator accounts can update findings for their account and their member -// accounts. Member accounts can update findings for their account. Updates from -// BatchUpdateFindings do not affect the value of UpdatedAt for a finding. +// accounts. Member accounts can update findings for their account. +// +// Updates from 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 // // 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. +// or change the finding severity. See [Configuring access to BatchUpdateFindings]in the Security Hub User Guide. +// +// [Configuring access to BatchUpdateFindings]: https://docs.aws.amazon.com/securityhub/latest/userguide/finding-update-batchupdatefindings.html#batchupdatefindings-configure-access func (c *Client) BatchUpdateFindings(ctx context.Context, params *BatchUpdateFindingsInput, optFns ...func(*Options)) (*BatchUpdateFindingsOutput, error) { if params == nil { params = &BatchUpdateFindingsInput{} @@ -50,23 +63,27 @@ func (c *Client) BatchUpdateFindings(ctx context.Context, params *BatchUpdateFin type BatchUpdateFindingsInput struct { // The list of findings to update. BatchUpdateFindings can be used to update up to - // 100 findings at a time. For each finding, the list provides the finding - // identifier and the ARN of the finding provider. + // 100 findings at a time. + // + // For each finding, the list provides the finding identifier and the ARN of the + // finding provider. // // This member is required. FindingIdentifiers []types.AwsSecurityFindingIdentifier // The updated value for the finding confidence. Confidence is defined as the // likelihood that a finding accurately identifies the behavior or issue that it - // was intended to identify. Confidence is scored on a 0-100 basis using a ratio - // scale, where 0 means zero percent confidence and 100 means 100 percent - // confidence. + // was intended to identify. + // + // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero + // percent confidence and 100 means 100 percent confidence. Confidence *int32 // The updated 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. + // 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. Criticality *int32 // The updated note. @@ -79,11 +96,18 @@ type BatchUpdateFindingsInput struct { Severity *types.SeverityUpdate // One or more finding types in the format of namespace/category/classifier that - // classify a finding. Valid namespace values are as follows. + // classify a finding. + // + // Valid namespace values are as follows. + // // - Software and Configuration Checks + // // - TTPs + // // - Effects + // // - Unusual Behaviors + // // - Sensitive Data Identifications Types []string @@ -91,17 +115,24 @@ type BatchUpdateFindingsInput struct { // 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. + // 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 VerificationState types.VerificationState - // Used to update the workflow status of a finding. The workflow status indicates - // the progress of the investigation into the finding. + // Used to update the workflow status of a finding. + // + // The workflow status indicates the progress of the investigation into the + // finding. Workflow *types.WorkflowUpdate noSmithyDocumentSerde diff --git a/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go b/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go index c77e5392f6b..4fb29d59be5 100644 --- a/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go +++ b/service/securityhub/api_op_BatchUpdateStandardsControlAssociations.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// For a batch of security controls and standards, this operation updates the +// For a batch of security controls and standards, this operation updates the +// // enablement status of a control in a standard. func (c *Client) BatchUpdateStandardsControlAssociations(ctx context.Context, params *BatchUpdateStandardsControlAssociationsInput, optFns ...func(*Options)) (*BatchUpdateStandardsControlAssociationsOutput, error) { if params == nil { @@ -30,7 +31,7 @@ func (c *Client) BatchUpdateStandardsControlAssociations(ctx context.Context, pa type BatchUpdateStandardsControlAssociationsInput struct { - // Updates the enablement status of a security control in a specified standard. + // Updates the enablement status of a security control in a specified standard. // // This member is required. StandardsControlAssociationUpdates []types.StandardsControlAssociationUpdate @@ -40,7 +41,7 @@ type BatchUpdateStandardsControlAssociationsInput struct { type BatchUpdateStandardsControlAssociationsOutput struct { - // A security control (identified with SecurityControlId , SecurityControlArn , or + // 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 diff --git a/service/securityhub/api_op_CreateActionTarget.go b/service/securityhub/api_op_CreateActionTarget.go index 67be19edddc..7398136fe1b 100644 --- a/service/securityhub/api_op_CreateActionTarget.go +++ b/service/securityhub/api_op_CreateActionTarget.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a custom action target in Security Hub. You can use custom actions on -// findings and insights in Security Hub to trigger target actions in Amazon -// CloudWatch Events. +// Creates a custom action target in Security Hub. +// +// You can use custom actions on findings and insights in Security Hub to trigger +// target actions in Amazon CloudWatch Events. func (c *Client) CreateActionTarget(ctx context.Context, params *CreateActionTargetInput, optFns ...func(*Options)) (*CreateActionTargetOutput, error) { if params == nil { params = &CreateActionTargetInput{} diff --git a/service/securityhub/api_op_CreateAutomationRule.go b/service/securityhub/api_op_CreateAutomationRule.go index bf445bde938..8c3f0b48526 100644 --- a/service/securityhub/api_op_CreateAutomationRule.go +++ b/service/securityhub/api_op_CreateAutomationRule.go @@ -29,13 +29,13 @@ func (c *Client) CreateAutomationRule(ctx context.Context, params *CreateAutomat type CreateAutomationRuleInput struct { - // One or more actions to update finding fields if a finding matches the + // One or more actions to update finding fields if a finding matches the // conditions specified in Criteria . // // This member is required. Actions []types.AutomationRulesAction - // A set of ASFF finding field attributes and corresponding expected values that + // A set of ASFF finding field attributes and corresponding expected values that // Security Hub uses to filter findings. If a rule is enabled and a finding matches // the conditions specified in this parameter, Security Hub applies the rule action // to the finding. @@ -43,12 +43,12 @@ type CreateAutomationRuleInput struct { // This member is required. Criteria *types.AutomationRulesFindingFilters - // A description of the rule. + // A description of the rule. // // This member is required. Description *string - // The name of the rule. + // The name of the rule. // // This member is required. RuleName *string @@ -68,14 +68,15 @@ type CreateAutomationRuleInput struct { // rule isn't terminal. IsTerminal *bool - // Whether the rule is active after it is created. If this parameter is equal to + // Whether the rule is active after it is created. If this parameter is equal to // ENABLED , Security Hub starts applying the rule to findings and finding updates // after the rule is created. To change the value of this parameter after creating - // a rule, use BatchUpdateAutomationRules (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html) - // . + // a rule, use [BatchUpdateAutomationRules]BatchUpdateAutomationRules . + // + // [BatchUpdateAutomationRules]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html RuleStatus types.RuleStatus - // User-defined tags associated with an automation rule. + // User-defined tags associated with an automation rule. Tags map[string]string noSmithyDocumentSerde @@ -83,7 +84,7 @@ type CreateAutomationRuleInput struct { type CreateAutomationRuleOutput struct { - // The Amazon Resource Name (ARN) of the automation rule that you created. + // The Amazon Resource Name (ARN) of the automation rule that you created. RuleArn *string // Metadata pertaining to the operation's result. diff --git a/service/securityhub/api_op_CreateConfigurationPolicy.go b/service/securityhub/api_op_CreateConfigurationPolicy.go index df0d9c2d0d1..f3c1965de3d 100644 --- a/service/securityhub/api_op_CreateConfigurationPolicy.go +++ b/service/securityhub/api_op_CreateConfigurationPolicy.go @@ -12,7 +12,8 @@ import ( "time" ) -// Creates a configuration policy with the defined configuration. Only the +// Creates a configuration policy with the defined configuration. Only the +// // Security Hub delegated administrator can invoke this operation from the home // Region. func (c *Client) CreateConfigurationPolicy(ctx context.Context, params *CreateConfigurationPolicyInput, optFns ...func(*Options)) (*CreateConfigurationPolicyOutput, error) { @@ -32,7 +33,7 @@ func (c *Client) CreateConfigurationPolicy(ctx context.Context, params *CreateCo type CreateConfigurationPolicyInput struct { - // An object that defines how Security Hub is configured. It includes whether + // An object that defines how Security Hub is configured. It includes whether // Security Hub is enabled or disabled, a list of enabled security standards, a // list of enabled or disabled security controls, and a list of custom parameter // values for specified controls. If you provide a list of security controls that @@ -44,18 +45,19 @@ type CreateConfigurationPolicyInput struct { // This member is required. ConfigurationPolicy types.Policy - // The name of the configuration policy. Alphanumeric characters and the following - // ASCII characters are permitted: -, ., !, *, / . + // The name of the configuration policy. Alphanumeric characters and the + // following ASCII characters are permitted: -, ., !, *, / . // // This member is required. Name *string - // The description of the configuration policy. + // The description of the configuration policy. Description *string - // User-defined tags associated with a configuration policy. For more information, - // see Tagging Security Hub resources (https://docs.aws.amazon.com/securityhub/latest/userguide/tagging-resources.html) - // in the Security Hub user guide. + // User-defined tags associated with a configuration policy. For more + // information, see [Tagging Security Hub resources]in the Security Hub user guide. + // + // [Tagging Security Hub resources]: https://docs.aws.amazon.com/securityhub/latest/userguide/tagging-resources.html Tags map[string]string noSmithyDocumentSerde @@ -63,10 +65,10 @@ type CreateConfigurationPolicyInput struct { type CreateConfigurationPolicyOutput struct { - // The Amazon Resource Name (ARN) of the configuration policy. + // The Amazon Resource Name (ARN) of the configuration policy. Arn *string - // An object that defines how Security Hub is configured. It includes whether + // An object that defines how Security Hub is configured. It includes whether // Security Hub is enabled or disabled, a list of enabled security standards, a // list of enabled or disabled security controls, and a list of custom parameter // values for specified controls. If the request included a list of security @@ -76,20 +78,20 @@ type CreateConfigurationPolicyOutput struct { // Security Hub enables all other controls (including newly released controls). ConfigurationPolicy types.Policy - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was created. CreatedAt *time.Time - // The description of the configuration policy. + // The description of the configuration policy. Description *string - // The universally unique identifier (UUID) of the configuration policy. + // The universally unique identifier (UUID) of the configuration policy. Id *string - // The name of the configuration policy. + // The name of the configuration policy. Name *string - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was last updated. UpdatedAt *time.Time diff --git a/service/securityhub/api_op_CreateFindingAggregator.go b/service/securityhub/api_op_CreateFindingAggregator.go index a72fb3c7f69..414d8e7f8f2 100644 --- a/service/securityhub/api_op_CreateFindingAggregator.go +++ b/service/securityhub/api_op_CreateFindingAggregator.go @@ -11,9 +11,11 @@ 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) -// in the Security Hub User Guide. +// +// For more details about cross-Region replication, see [Configuring finding aggregation] in the Security Hub User +// Guide. +// +// [Configuring finding aggregation]: https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html func (c *Client) CreateFindingAggregator(ctx context.Context, params *CreateFindingAggregatorInput, optFns ...func(*Options)) (*CreateFindingAggregatorOutput, error) { if params == nil { params = &CreateFindingAggregatorInput{} @@ -34,17 +36,23 @@ 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: + // 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. @@ -54,9 +62,10 @@ type CreateFindingAggregatorInput struct { // 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 - // space-separated list of Regions that do aggregate findings to the aggregation - // Region. + // 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 noSmithyDocumentSerde diff --git a/service/securityhub/api_op_CreateInsight.go b/service/securityhub/api_op_CreateInsight.go index d6eceb8e1a5..41fda99794a 100644 --- a/service/securityhub/api_op_CreateInsight.go +++ b/service/securityhub/api_op_CreateInsight.go @@ -13,6 +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 . func (c *Client) CreateInsight(ctx context.Context, params *CreateInsightInput, optFns ...func(*Options)) (*CreateInsightOutput, error) { if params == nil { diff --git a/service/securityhub/api_op_CreateMembers.go b/service/securityhub/api_op_CreateMembers.go index 3a48aae2f8a..80532b98e42 100644 --- a/service/securityhub/api_op_CreateMembers.go +++ b/service/securityhub/api_op_CreateMembers.go @@ -14,34 +14,44 @@ import ( // Creates a member association in Security Hub between the specified accounts and // the account used to make the request, which is the administrator account. If you // are integrated with Organizations, then the administrator account is designated -// 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: +// 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. // // 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. +// 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. +// 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_DeclineInvitations.go b/service/securityhub/api_op_DeclineInvitations.go index 5bcf816f012..4b398c4a294 100644 --- a/service/securityhub/api_op_DeclineInvitations.go +++ b/service/securityhub/api_op_DeclineInvitations.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Declines invitations to become a member account. A prospective member account -// uses this operation to decline an invitation to become a member. This operation -// is only called by member accounts that aren't part of an organization. -// Organization accounts don't receive invitations. +// Declines invitations to become a member account. +// +// A prospective member account uses this operation to decline an invitation to +// become a member. +// +// This operation is only called by member accounts that aren't part of an +// organization. Organization accounts don't receive invitations. func (c *Client) DeclineInvitations(ctx context.Context, params *DeclineInvitationsInput, optFns ...func(*Options)) (*DeclineInvitationsOutput, error) { if params == nil { params = &DeclineInvitationsInput{} diff --git a/service/securityhub/api_op_DeleteActionTarget.go b/service/securityhub/api_op_DeleteActionTarget.go index 60cc5420172..ec0d8127bcd 100644 --- a/service/securityhub/api_op_DeleteActionTarget.go +++ b/service/securityhub/api_op_DeleteActionTarget.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a custom action target from Security Hub. Deleting a custom action -// target does not affect any findings or insights that were already sent to Amazon -// CloudWatch Events using the custom action. +// Deletes a custom action target from Security Hub. +// +// Deleting a custom action target does not affect any findings or insights that +// were already sent to Amazon CloudWatch Events using the custom action. func (c *Client) DeleteActionTarget(ctx context.Context, params *DeleteActionTargetInput, optFns ...func(*Options)) (*DeleteActionTargetOutput, error) { if params == nil { params = &DeleteActionTargetInput{} diff --git a/service/securityhub/api_op_DeleteConfigurationPolicy.go b/service/securityhub/api_op_DeleteConfigurationPolicy.go index a387404c1f5..8ef636b6cfc 100644 --- a/service/securityhub/api_op_DeleteConfigurationPolicy.go +++ b/service/securityhub/api_op_DeleteConfigurationPolicy.go @@ -10,7 +10,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a configuration policy. Only the Security Hub delegated administrator +// Deletes a configuration policy. Only the Security Hub delegated administrator +// // can invoke this operation from the home Region. For the deletion to succeed, you // must first disassociate a configuration policy from target accounts, // organizational units, or the root by invoking the @@ -32,7 +33,7 @@ func (c *Client) DeleteConfigurationPolicy(ctx context.Context, params *DeleteCo type DeleteConfigurationPolicyInput struct { - // The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the + // The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the // configuration policy. // // This member is required. diff --git a/service/securityhub/api_op_DeleteFindingAggregator.go b/service/securityhub/api_op_DeleteFindingAggregator.go index 2ae5e274542..b1f0882d65e 100644 --- a/service/securityhub/api_op_DeleteFindingAggregator.go +++ b/service/securityhub/api_op_DeleteFindingAggregator.go @@ -11,9 +11,11 @@ import ( ) // Deletes a finding aggregator. When you delete the finding aggregator, you stop -// finding aggregation. When you stop finding aggregation, findings that were -// already aggregated to the aggregation Region are still visible from the -// aggregation Region. New findings and finding updates are not aggregated. +// finding aggregation. +// +// When you stop finding aggregation, findings that were already aggregated to the +// aggregation Region are still visible from the aggregation Region. New findings +// and finding updates are not aggregated. func (c *Client) DeleteFindingAggregator(ctx context.Context, params *DeleteFindingAggregatorInput, optFns ...func(*Options)) (*DeleteFindingAggregatorOutput, error) { if params == nil { params = &DeleteFindingAggregatorInput{} diff --git a/service/securityhub/api_op_DeleteInvitations.go b/service/securityhub/api_op_DeleteInvitations.go index f4a0a22d694..538c38f865a 100644 --- a/service/securityhub/api_op_DeleteInvitations.go +++ b/service/securityhub/api_op_DeleteInvitations.go @@ -12,10 +12,14 @@ import ( ) // Deletes invitations received by the Amazon Web Services account to become a -// member account. A Security Hub administrator account can use this operation to -// delete invitations sent to one or more member accounts. This operation is only -// used to delete invitations that are sent to member accounts that aren't part of -// an organization. Organization accounts don't receive invitations. +// member account. +// +// A Security Hub administrator account can use this operation to delete +// invitations sent to one or more member accounts. +// +// This operation is only used to delete invitations that are sent to member +// accounts that aren't part of an organization. Organization accounts don't +// receive invitations. func (c *Client) DeleteInvitations(ctx context.Context, params *DeleteInvitationsInput, optFns ...func(*Options)) (*DeleteInvitationsOutput, error) { if params == nil { params = &DeleteInvitationsInput{} diff --git a/service/securityhub/api_op_DeleteMembers.go b/service/securityhub/api_op_DeleteMembers.go index 9850758030b..db1cf0525d6 100644 --- a/service/securityhub/api_op_DeleteMembers.go +++ b/service/securityhub/api_op_DeleteMembers.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified member accounts from Security Hub. You can invoke this -// API only to delete accounts that became members through invitation. You can't -// invoke this API to delete accounts that belong to an Organizations organization. +// Deletes the specified member accounts from Security Hub. +// +// You can invoke this API only to delete accounts that became members through +// invitation. You can't invoke this API to delete accounts that belong to an +// Organizations organization. func (c *Client) DeleteMembers(ctx context.Context, params *DeleteMembersInput, optFns ...func(*Options)) (*DeleteMembersOutput, error) { if params == nil { params = &DeleteMembersInput{} diff --git a/service/securityhub/api_op_DescribeActionTargets.go b/service/securityhub/api_op_DescribeActionTargets.go index 052730ba6f6..f97a3f2aeb7 100644 --- a/service/securityhub/api_op_DescribeActionTargets.go +++ b/service/securityhub/api_op_DescribeActionTargets.go @@ -36,9 +36,10 @@ 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 - // subsequent calls to the operation, to continue listing data, set the value of - // this parameter to the value returned from the previous response. + // 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 noSmithyDocumentSerde diff --git a/service/securityhub/api_op_DescribeHub.go b/service/securityhub/api_op_DescribeHub.go index 187e926b449..f9484343747 100644 --- a/service/securityhub/api_op_DescribeHub.go +++ b/service/securityhub/api_op_DescribeHub.go @@ -39,19 +39,25 @@ 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 // 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. 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 or after February 23, 2023. + // 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. + // + // 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 + // or after February 23, 2023. ControlFindingGenerator types.ControlFindingGenerator // The ARN of the Hub resource that was retrieved. diff --git a/service/securityhub/api_op_DescribeOrganizationConfiguration.go b/service/securityhub/api_op_DescribeOrganizationConfiguration.go index 712119b1a57..ea0ac83aef2 100644 --- a/service/securityhub/api_op_DescribeOrganizationConfiguration.go +++ b/service/securityhub/api_op_DescribeOrganizationConfiguration.go @@ -35,33 +35,41 @@ type DescribeOrganizationConfigurationInput struct { type DescribeOrganizationConfigurationOutput struct { // Whether to automatically enable Security Hub in new member accounts when they - // join the organization. If set to true , then Security Hub is automatically - // enabled in new accounts. If set to false , then Security Hub isn't enabled in - // new accounts automatically. The default value is false . If the - // ConfigurationType of your organization is set to CENTRAL , then this field is - // set to false and can't be changed in the home Region and linked Regions. - // However, in that case, the delegated administrator can create a configuration - // policy in which Security Hub is enabled and associate the policy with new - // organization accounts. + // join the organization. + // + // If set to true , then Security Hub is automatically enabled in new accounts. If + // set to false , then Security Hub isn't enabled in new accounts automatically. + // The default value is false . + // + // If the ConfigurationType of your organization is set to CENTRAL , then this + // field is set to false and can't be changed in the home Region and linked + // Regions. However, in that case, the delegated administrator can create a + // configuration policy in which Security Hub is enabled and associate the policy + // with new organization accounts. AutoEnable *bool - // Whether to automatically enable Security Hub default standards (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html) - // in new member accounts when they join the organization. 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. The default value of this parameter is equal to - // DEFAULT . If the ConfigurationType of your organization is set to CENTRAL , then - // this field is set to NONE and can't be changed in the home Region and linked + // Whether to automatically enable Security Hub [default standards] in new member accounts when they + // join the organization. + // + // 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. The default value of this + // parameter is equal to DEFAULT . + // + // If the ConfigurationType of your organization is set to CENTRAL , then this + // field is set to NONE and can't be changed in the home Region and linked // Regions. However, in that case, the delegated administrator can create a // configuration policy in which specific security standards are enabled and // associate the policy with new organization accounts. + // + // [default standards]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html AutoEnableStandards types.AutoEnableStandards // Whether the maximum number of allowed member accounts are already associated // with the Security Hub administrator account. MemberAccountLimitReached *bool - // Provides information about the way an organization is configured in Security + // Provides information about the way an organization is configured in Security // Hub. OrganizationConfiguration *types.OrganizationConfiguration diff --git a/service/securityhub/api_op_DescribeProducts.go b/service/securityhub/api_op_DescribeProducts.go index a176a187996..93370ca4637 100644 --- a/service/securityhub/api_op_DescribeProducts.go +++ b/service/securityhub/api_op_DescribeProducts.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about product integrations in Security Hub. You can -// optionally provide an integration ARN. If you provide an integration ARN, then -// the results only include that integration. If you do not provide an integration -// ARN, then the results include all of the available product integrations. +// Returns information about product integrations in Security Hub. +// +// You can optionally provide an integration ARN. If you provide an integration +// ARN, then the results only include that integration. +// +// If you do not provide an integration ARN, then the results include all of the +// available product integrations. func (c *Client) DescribeProducts(ctx context.Context, params *DescribeProductsInput, optFns ...func(*Options)) (*DescribeProductsOutput, error) { if params == nil { params = &DescribeProductsInput{} @@ -36,9 +39,10 @@ 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 - // subsequent calls to the operation, to continue listing data, set the value of - // this parameter to the value returned from the previous response. + // 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 // The ARN of the integration to return. diff --git a/service/securityhub/api_op_DescribeStandards.go b/service/securityhub/api_op_DescribeStandards.go index 3e924f3536a..3bb9ee64106 100644 --- a/service/securityhub/api_op_DescribeStandards.go +++ b/service/securityhub/api_op_DescribeStandards.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the available standards in Security Hub. For each standard, -// the results include the standard ARN, the name, and a description. +// Returns a list of the available standards in Security Hub. +// +// For each standard, the results include the standard ARN, the name, and a +// description. func (c *Client) DescribeStandards(ctx context.Context, params *DescribeStandardsInput, optFns ...func(*Options)) (*DescribeStandardsOutput, error) { if params == nil { params = &DescribeStandardsInput{} @@ -34,9 +36,10 @@ 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 - // subsequent calls to the operation, to continue listing data, set the value of - // this parameter to the value returned from the previous response. + // 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 noSmithyDocumentSerde diff --git a/service/securityhub/api_op_DescribeStandardsControls.go b/service/securityhub/api_op_DescribeStandardsControls.go index d4727a4042f..cb9d96ecb87 100644 --- a/service/securityhub/api_op_DescribeStandardsControls.go +++ b/service/securityhub/api_op_DescribeStandardsControls.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of security standards controls. For each control, the results -// include information about whether it is currently enabled, the severity, and a -// link to remediation information. +// Returns a list of security standards controls. +// +// For each control, the results include information about whether it is currently +// enabled, the severity, and a link to remediation information. func (c *Client) DescribeStandardsControls(ctx context.Context, params *DescribeStandardsControlsInput, optFns ...func(*Options)) (*DescribeStandardsControlsOutput, error) { if params == nil { params = &DescribeStandardsControlsInput{} @@ -43,6 +44,7 @@ type DescribeStandardsControlsInput struct { // The token that is required for pagination. On your first call to the // 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_DisableSecurityHub.go b/service/securityhub/api_op_DisableSecurityHub.go index 31500d29d25..670bca75c2a 100644 --- a/service/securityhub/api_op_DisableSecurityHub.go +++ b/service/securityhub/api_op_DisableSecurityHub.go @@ -12,13 +12,18 @@ import ( // Disables Security Hub in your account only in the current Amazon Web Services // Region. To disable Security Hub in all Regions, you must submit one request per -// Region where you have enabled Security Hub. You can't disable Security Hub in an -// account that is currently the Security Hub administrator. When you disable -// Security Hub, your existing findings and insights and any Security Hub -// configuration settings are deleted after 90 days and cannot be recovered. Any -// standards that were enabled are disabled, and your administrator and member -// account associations are removed. If you want to save your existing findings, -// you must export them before you disable Security Hub. +// Region where you have enabled Security Hub. +// +// You can't disable Security Hub in an account that is currently the Security Hub +// administrator. +// +// When you disable Security Hub, your existing findings and insights and any +// Security Hub configuration settings are deleted after 90 days and cannot be +// recovered. Any standards that were enabled are disabled, and your administrator +// and member account associations are removed. +// +// If you want to save your existing findings, you must export them before you +// disable Security Hub. func (c *Client) DisableSecurityHub(ctx context.Context, params *DisableSecurityHubInput, optFns ...func(*Options)) (*DisableSecurityHubOutput, error) { if params == nil { params = &DisableSecurityHubInput{} diff --git a/service/securityhub/api_op_DisassociateFromAdministratorAccount.go b/service/securityhub/api_op_DisassociateFromAdministratorAccount.go index ec62a453c12..07f6b804081 100644 --- a/service/securityhub/api_op_DisassociateFromAdministratorAccount.go +++ b/service/securityhub/api_op_DisassociateFromAdministratorAccount.go @@ -11,9 +11,11 @@ import ( ) // 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. +// 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. func (c *Client) DisassociateFromAdministratorAccount(ctx context.Context, params *DisassociateFromAdministratorAccountInput, optFns ...func(*Options)) (*DisassociateFromAdministratorAccountOutput, error) { if params == nil { params = &DisassociateFromAdministratorAccountInput{} diff --git a/service/securityhub/api_op_DisassociateFromMasterAccount.go b/service/securityhub/api_op_DisassociateFromMasterAccount.go index b089be72318..f9adb072edd 100644 --- a/service/securityhub/api_op_DisassociateFromMasterAccount.go +++ b/service/securityhub/api_op_DisassociateFromMasterAccount.go @@ -11,16 +11,21 @@ import ( ) // 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 -// 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. +// 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. // // Deprecated: This API has been deprecated, use // DisassociateFromAdministratorAccount API instead. diff --git a/service/securityhub/api_op_DisassociateMembers.go b/service/securityhub/api_op_DisassociateMembers.go index 19430c66243..5054f72e796 100644 --- a/service/securityhub/api_op_DisassociateMembers.go +++ b/service/securityhub/api_op_DisassociateMembers.go @@ -11,8 +11,10 @@ import ( ) // Disassociates the specified member accounts from the associated administrator -// account. Can be used to disassociate both accounts that are managed using -// Organizations and accounts that were invited manually. +// account. +// +// Can be used to disassociate both accounts that are managed using Organizations +// and accounts that were invited manually. func (c *Client) DisassociateMembers(ctx context.Context, params *DisassociateMembersInput, optFns ...func(*Options)) (*DisassociateMembersOutput, error) { if params == nil { params = &DisassociateMembersInput{} diff --git a/service/securityhub/api_op_EnableImportFindingsForProduct.go b/service/securityhub/api_op_EnableImportFindingsForProduct.go index 1e825d0b95b..36529b327f8 100644 --- a/service/securityhub/api_op_EnableImportFindingsForProduct.go +++ b/service/securityhub/api_op_EnableImportFindingsForProduct.go @@ -11,9 +11,10 @@ import ( ) // Enables the integration of a partner product with Security Hub. Integrated -// products send findings to Security Hub. When you enable a product integration, a -// permissions policy that grants permission for the product to send findings to -// Security Hub is applied. +// products send findings to Security Hub. +// +// When you enable a product integration, a permissions policy that grants +// permission for the product to send findings to Security Hub is applied. func (c *Client) EnableImportFindingsForProduct(ctx context.Context, params *EnableImportFindingsForProductInput, optFns ...func(*Options)) (*EnableImportFindingsForProductOutput, error) { if params == nil { params = &EnableImportFindingsForProductInput{} diff --git a/service/securityhub/api_op_EnableSecurityHub.go b/service/securityhub/api_op_EnableSecurityHub.go index 9ee9c8e265e..96524a06198 100644 --- a/service/securityhub/api_op_EnableSecurityHub.go +++ b/service/securityhub/api_op_EnableSecurityHub.go @@ -12,20 +12,32 @@ import ( ) // Enables Security Hub for your account in the current Region or the Region you -// specify in the request. When you enable Security Hub, you grant to Security Hub -// 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: +// specify in the request. +// +// When you enable Security Hub, you grant to Security Hub 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 // -// 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. +// 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] in the Security Hub User Guide. +// +// [setup information]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html func (c *Client) EnableSecurityHub(ctx context.Context, params *EnableSecurityHubInput, optFns ...func(*Options)) (*EnableSecurityHubOutput, error) { if params == nil { params = &EnableSecurityHubInput{} @@ -46,10 +58,13 @@ 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 - // 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 + // 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. The value for this field in a member account matches the value in the + // 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 // or after February 23, 2023. diff --git a/service/securityhub/api_op_GetAdministratorAccount.go b/service/securityhub/api_op_GetAdministratorAccount.go index c34a7bfa01c..122aa1a2cdb 100644 --- a/service/securityhub/api_op_GetAdministratorAccount.go +++ b/service/securityhub/api_op_GetAdministratorAccount.go @@ -12,8 +12,10 @@ import ( ) // 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. +// member account. +// +// Can be used by both member accounts that are managed using Organizations and +// accounts that were invited manually. func (c *Client) GetAdministratorAccount(ctx context.Context, params *GetAdministratorAccountInput, optFns ...func(*Options)) (*GetAdministratorAccountOutput, error) { if params == nil { params = &GetAdministratorAccountInput{} diff --git a/service/securityhub/api_op_GetConfigurationPolicy.go b/service/securityhub/api_op_GetConfigurationPolicy.go index ac80528f146..d6f46314835 100644 --- a/service/securityhub/api_op_GetConfigurationPolicy.go +++ b/service/securityhub/api_op_GetConfigurationPolicy.go @@ -12,7 +12,8 @@ import ( "time" ) -// Provides information about a configuration policy. Only the Security Hub +// Provides information about a configuration policy. Only the Security Hub +// // delegated administrator can invoke this operation from the home Region. func (c *Client) GetConfigurationPolicy(ctx context.Context, params *GetConfigurationPolicyInput, optFns ...func(*Options)) (*GetConfigurationPolicyOutput, error) { if params == nil { @@ -31,7 +32,7 @@ func (c *Client) GetConfigurationPolicy(ctx context.Context, params *GetConfigur type GetConfigurationPolicyInput struct { - // The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the + // The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the // configuration policy. // // This member is required. @@ -42,10 +43,10 @@ type GetConfigurationPolicyInput struct { type GetConfigurationPolicyOutput struct { - // The ARN of the configuration policy. + // The ARN of the configuration policy. Arn *string - // An object that defines how Security Hub is configured. It includes whether + // An object that defines how Security Hub is configured. It includes whether // Security Hub is enabled or disabled, a list of enabled security standards, a // list of enabled or disabled security controls, and a list of custom parameter // values for specified controls. If the policy includes a list of security @@ -55,20 +56,20 @@ type GetConfigurationPolicyOutput struct { // released controls). ConfigurationPolicy types.Policy - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was created. CreatedAt *time.Time - // The description of the configuration policy. + // The description of the configuration policy. Description *string - // The UUID of the configuration policy. + // The UUID of the configuration policy. Id *string - // The name of the configuration policy. + // The name of the configuration policy. Name *string - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was last updated. UpdatedAt *time.Time diff --git a/service/securityhub/api_op_GetConfigurationPolicyAssociation.go b/service/securityhub/api_op_GetConfigurationPolicyAssociation.go index 268a6d96172..5103d5b9aa0 100644 --- a/service/securityhub/api_op_GetConfigurationPolicyAssociation.go +++ b/service/securityhub/api_op_GetConfigurationPolicyAssociation.go @@ -12,7 +12,8 @@ import ( "time" ) -// Returns the association between a configuration and a target account, +// Returns the association between a configuration and a target account, +// // organizational unit, or the root. The configuration can be a configuration // policy or self-managed behavior. Only the Security Hub delegated administrator // can invoke this operation from the home Region. @@ -33,7 +34,7 @@ func (c *Client) GetConfigurationPolicyAssociation(ctx context.Context, params * type GetConfigurationPolicyAssociationInput struct { - // The target account ID, organizational unit ID, or the root ID to retrieve the + // The target account ID, organizational unit ID, or the root ID to retrieve the // association for. // // This member is required. @@ -44,31 +45,31 @@ type GetConfigurationPolicyAssociationInput struct { type GetConfigurationPolicyAssociationOutput struct { - // The current status of the association between the specified target and the + // The current status of the association between the specified target and the // configuration. AssociationStatus types.ConfigurationPolicyAssociationStatus - // The explanation for a FAILED value for AssociationStatus . + // The explanation for a FAILED value for AssociationStatus . AssociationStatusMessage *string - // Indicates whether the association between the specified target and the + // Indicates whether the association between the specified target and the // configuration was directly applied by the Security Hub delegated administrator // or inherited from a parent. AssociationType types.AssociationType - // The universally unique identifier (UUID) of a configuration policy. For + // The universally unique identifier (UUID) of a configuration policy. For // self-managed behavior, the value is SELF_MANAGED_SECURITY_HUB . ConfigurationPolicyId *string - // The target account ID, organizational unit ID, or the root ID for which the + // The target account ID, organizational unit ID, or the root ID for which the // association is retrieved. TargetId *string - // Specifies whether the target is an Amazon Web Services account, organizational + // Specifies whether the target is an Amazon Web Services account, organizational // unit, or the organization root. TargetType types.TargetType - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // association was last updated. UpdatedAt *time.Time diff --git a/service/securityhub/api_op_GetEnabledStandards.go b/service/securityhub/api_op_GetEnabledStandards.go index 4990d4aeb29..b6affad15a8 100644 --- a/service/securityhub/api_op_GetEnabledStandards.go +++ b/service/securityhub/api_op_GetEnabledStandards.go @@ -33,9 +33,10 @@ 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 - // subsequent calls to the operation, to continue listing data, set the value of - // this parameter to the value returned from the previous response. + // 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 // The list of the standards subscription ARNs for the standards to retrieve. diff --git a/service/securityhub/api_op_GetFindingHistory.go b/service/securityhub/api_op_GetFindingHistory.go index 78bf14a86e6..d4dc219bd30 100644 --- a/service/securityhub/api_op_GetFindingHistory.go +++ b/service/securityhub/api_op_GetFindingHistory.go @@ -12,7 +12,8 @@ import ( "time" ) -// Returns history for a Security Hub finding in the last 90 days. The history +// Returns history for a Security Hub finding in the last 90 days. The history +// // includes changes made to any fields in the Amazon Web Services Security Finding // Format (ASFF). func (c *Client) GetFindingHistory(ctx context.Context, params *GetFindingHistoryInput, optFns ...func(*Options)) (*GetFindingHistoryOutput, error) { @@ -37,61 +38,79 @@ type GetFindingHistoryInput struct { // This member is required. FindingIdentifier *types.AwsSecurityFindingIdentifier - // An ISO 8601-formatted timestamp that indicates the end time of the requested - // finding history. If you provide values for both StartTime and EndTime , Security - // Hub returns finding history for the specified time period. If you provide a - // value for StartTime but not for EndTime , Security Hub returns finding history - // from the StartTime to the time at which the API is called. If you provide a - // value for EndTime but not for StartTime , Security Hub returns finding history - // from the CreatedAt (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt) + // An ISO 8601-formatted timestamp that indicates the end time of the requested + // finding history. + // + // If you provide values for both StartTime and EndTime , Security Hub returns + // finding history for the specified time period. If you provide a value for + // StartTime but not for EndTime , Security Hub returns finding history from the + // StartTime to the time at which the API is called. If you provide a value for + // EndTime but not for StartTime , Security Hub returns finding history from the [CreatedAt] // timestamp of the finding to the EndTime . If you provide neither StartTime nor // EndTime , Security Hub returns finding history from the CreatedAt timestamp of // the finding to the time at which the API is called. In all of these scenarios, // the response is limited to 100 results, and the maximum time period is limited - // to 90 days. This field accepts only the specified formats. Timestamps can end - // with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // to 90 days. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // + // [CreatedAt]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt EndTime *time.Time - // The maximum number of results to be returned. If you don’t provide it, Security - // Hub returns up to 100 results of finding history. + // The maximum number of results to be returned. If you don’t provide it, + // Security Hub returns up to 100 results of finding history. MaxResults *int32 - // A token for pagination purposes. Provide NULL as the initial value. In + // A token for pagination purposes. Provide NULL as the initial value. In // subsequent requests, provide the token included in the response to get up to an // additional 100 results of finding history. If you don’t provide NextToken , // Security Hub returns up to 100 results of finding history for each request. NextToken *string - // A timestamp that indicates the start time of the requested finding history. If - // you provide values for both StartTime and EndTime , Security Hub returns finding - // history for the specified time period. If you provide a value for StartTime but - // not for EndTime , Security Hub returns finding history from the StartTime to - // the time at which the API is called. If you provide a value for EndTime but not - // for StartTime , Security Hub returns finding history from the CreatedAt (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt) + // A timestamp that indicates the start time of the requested finding history. + // + // If you provide values for both StartTime and EndTime , Security Hub returns + // finding history for the specified time period. If you provide a value for + // StartTime but not for EndTime , Security Hub returns finding history from the + // StartTime to the time at which the API is called. If you provide a value for + // EndTime but not for StartTime , Security Hub returns finding history from the [CreatedAt] // timestamp of the finding to the EndTime . If you provide neither StartTime nor // EndTime , Security Hub returns finding history from the CreatedAt timestamp of // the finding to the time at which the API is called. In all of these scenarios, // the response is limited to 100 results, and the maximum time period is limited - // to 90 days. This field accepts only the specified formats. Timestamps can end - // with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // to 90 days. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // + // [CreatedAt]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt StartTime *time.Time noSmithyDocumentSerde @@ -99,12 +118,12 @@ type GetFindingHistoryInput struct { type GetFindingHistoryOutput struct { - // A token for pagination purposes. Provide this token in the subsequent request + // A token for pagination purposes. Provide this token in the subsequent request // to GetFindingsHistory to get up to an additional 100 results of history for the // same finding that you specified in your initial request. NextToken *string - // A list of events that altered the specified finding during the specified time + // A list of events that altered the specified finding during the specified time // period. Records []types.FindingHistoryRecord @@ -203,8 +222,8 @@ var _ GetFindingHistoryAPIClient = (*Client)(nil) // GetFindingHistoryPaginatorOptions is the paginator options for GetFindingHistory type GetFindingHistoryPaginatorOptions struct { - // The maximum number of results to be returned. If you don’t provide it, Security - // Hub returns up to 100 results of finding history. + // The maximum number of results to be returned. If you don’t provide it, + // Security Hub returns up to 100 results of finding history. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/securityhub/api_op_GetFindings.go b/service/securityhub/api_op_GetFindings.go index 9dfca396b17..bc0636ad6eb 100644 --- a/service/securityhub/api_op_GetFindings.go +++ b/service/securityhub/api_op_GetFindings.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of findings that match the specified criteria. If finding -// aggregation is enabled, then when you call GetFindings from the aggregation -// Region, the results include all of the matching findings from both the -// aggregation Region and the linked Regions. +// Returns a list of findings that match the specified criteria. +// +// If finding aggregation is enabled, then when you call GetFindings from the +// aggregation Region, the results include all of the matching findings from both +// the aggregation Region and the linked Regions. func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optFns ...func(*Options)) (*GetFindingsOutput, error) { if params == nil { params = &GetFindingsInput{} @@ -33,19 +34,23 @@ func (c *Client) GetFindings(ctx context.Context, params *GetFindingsInput, optF type GetFindingsInput struct { // The finding attributes used to define a condition to filter the returned - // 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 . + // 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 . 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, to continue listing data, set the value of this parameter to the - // value returned from the previous response. + // 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 // The finding attributes used to sort the list of returned findings. diff --git a/service/securityhub/api_op_GetInsights.go b/service/securityhub/api_op_GetInsights.go index faffb2dcb89..520b14c9779 100644 --- a/service/securityhub/api_op_GetInsights.go +++ b/service/securityhub/api_op_GetInsights.go @@ -38,9 +38,10 @@ 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, to continue listing data, set the value of this parameter to the - // value returned from the previous response. + // 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_GetMasterAccount.go b/service/securityhub/api_op_GetMasterAccount.go index edd7a3052b0..e3f1795f72c 100644 --- a/service/securityhub/api_op_GetMasterAccount.go +++ b/service/securityhub/api_op_GetMasterAccount.go @@ -11,15 +11,20 @@ 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 -// GetAdministratorAccount to your policies to ensure that the correct permissions -// 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. +// 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 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. // // Deprecated: This API has been deprecated, use GetAdministratorAccount API // instead. diff --git a/service/securityhub/api_op_GetMembers.go b/service/securityhub/api_op_GetMembers.go index 45285dcf2b5..434a00ada33 100644 --- a/service/securityhub/api_op_GetMembers.go +++ b/service/securityhub/api_op_GetMembers.go @@ -12,10 +12,14 @@ import ( ) // Returns the details for the Security Hub member accounts for the specified -// account IDs. An administrator account can be either the delegated Security Hub -// administrator account for an organization or an administrator account that -// enabled Security Hub manually. The results include both member accounts that are -// managed using Organizations and accounts that were invited manually. +// account IDs. +// +// An administrator account can be either the delegated Security Hub administrator +// account for an organization or an administrator account that enabled Security +// Hub manually. +// +// The results include both member accounts that are managed using Organizations +// and accounts that were invited manually. func (c *Client) GetMembers(ctx context.Context, params *GetMembersInput, optFns ...func(*Options)) (*GetMembersOutput, error) { if params == nil { params = &GetMembersInput{} diff --git a/service/securityhub/api_op_GetSecurityControlDefinition.go b/service/securityhub/api_op_GetSecurityControlDefinition.go index 175d077b227..9a59f394356 100644 --- a/service/securityhub/api_op_GetSecurityControlDefinition.go +++ b/service/securityhub/api_op_GetSecurityControlDefinition.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the definition of a security control. The definition includes the +// Retrieves the definition of a security control. The definition includes the +// // control title, description, Region availability, parameter definitions, and // other details. func (c *Client) GetSecurityControlDefinition(ctx context.Context, params *GetSecurityControlDefinitionInput, optFns ...func(*Options)) (*GetSecurityControlDefinitionOutput, error) { @@ -31,7 +32,7 @@ func (c *Client) GetSecurityControlDefinition(ctx context.Context, params *GetSe type GetSecurityControlDefinitionInput struct { - // The ID of the security control to retrieve the definition for. This field + // The ID of the security control to retrieve the definition for. This field // doesn’t accept an Amazon Resource Name (ARN). // // This member is required. @@ -42,7 +43,7 @@ type GetSecurityControlDefinitionInput struct { type GetSecurityControlDefinitionOutput struct { - // Provides metadata for a security control, including its unique + // 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. // diff --git a/service/securityhub/api_op_InviteMembers.go b/service/securityhub/api_op_InviteMembers.go index 4c755d86b93..2efbdb4fd7b 100644 --- a/service/securityhub/api_op_InviteMembers.go +++ b/service/securityhub/api_op_InviteMembers.go @@ -12,13 +12,17 @@ import ( ) // Invites other Amazon Web Services accounts to become member accounts for the -// Security Hub administrator account that the invitation is sent from. This -// operation is only used to invite accounts that do not belong to an organization. -// Organization accounts do not receive invitations. Before you can use this action -// to invite a member, you must first use the CreateMembers action to create the -// member account in Security Hub. When the account owner enables Security Hub and -// accepts the invitation to become a member account, the administrator account can -// view the findings generated from the member account. +// Security Hub administrator account that the invitation is sent from. +// +// This operation is only used to invite accounts that do not belong to an +// organization. Organization accounts do not receive invitations. +// +// Before you can use this action to invite a member, you must first use the +// CreateMembers action to create the member account in Security Hub. +// +// When the account owner enables Security Hub and accepts the invitation to +// become a member account, the administrator account can view the findings +// generated from the member account. func (c *Client) InviteMembers(ctx context.Context, params *InviteMembersInput, optFns ...func(*Options)) (*InviteMembersOutput, error) { if params == nil { params = &InviteMembersInput{} diff --git a/service/securityhub/api_op_ListAutomationRules.go b/service/securityhub/api_op_ListAutomationRules.go index f6c11ed78f4..60817d26089 100644 --- a/service/securityhub/api_op_ListAutomationRules.go +++ b/service/securityhub/api_op_ListAutomationRules.go @@ -29,12 +29,12 @@ func (c *Client) ListAutomationRules(ctx context.Context, params *ListAutomation type ListAutomationRulesInput struct { - // The maximum number of rules to return in the response. This currently ranges + // The maximum number of rules to return in the response. This currently ranges // from 1 to 100. MaxResults *int32 - // A token to specify where to start paginating the response. This is the NextToken - // from a previously truncated response. On your first call to the + // A token to specify where to start paginating the response. This is the + // NextToken from a previously truncated response. On your first call to the // ListAutomationRules API, set the value of this parameter to NULL . NextToken *string @@ -43,11 +43,11 @@ type ListAutomationRulesInput struct { type ListAutomationRulesOutput struct { - // Metadata for rules in the calling account. The response includes rules with a + // Metadata for rules in the calling account. The response includes rules with a // RuleStatus of ENABLED and DISABLED . AutomationRulesMetadata []types.AutomationRulesMetadata - // A pagination token for the response. + // A pagination token for the response. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/securityhub/api_op_ListConfigurationPolicies.go b/service/securityhub/api_op_ListConfigurationPolicies.go index 1d0e17c0fda..0d8f9e87b33 100644 --- a/service/securityhub/api_op_ListConfigurationPolicies.go +++ b/service/securityhub/api_op_ListConfigurationPolicies.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the configuration policies that the Security Hub delegated administrator +// Lists the configuration policies that the Security Hub delegated administrator +// // has created for your organization. Only the delegated administrator can invoke // this operation from the home Region. func (c *Client) ListConfigurationPolicies(ctx context.Context, params *ListConfigurationPoliciesInput, optFns ...func(*Options)) (*ListConfigurationPoliciesOutput, error) { @@ -31,7 +32,7 @@ func (c *Client) ListConfigurationPolicies(ctx context.Context, params *ListConf type ListConfigurationPoliciesInput struct { - // The maximum number of results that's returned by ListConfigurationPolicies in + // The maximum number of results that's returned by ListConfigurationPolicies in // each page of the response. When this parameter is used, // ListConfigurationPolicies returns the specified number of results in a single // page and a NextToken response element. You can see the remaining results of the @@ -39,7 +40,7 @@ type ListConfigurationPoliciesInput struct { // returned NextToken value. A valid range for MaxResults is between 1 and 100. MaxResults *int32 - // The NextToken value that's returned from a previous paginated + // The NextToken value that's returned from a previous paginated // ListConfigurationPolicies request where MaxResults was used but the results // exceeded the value of that parameter. Pagination continues from the MaxResults // was used but the results exceeded the value of that parameter. Pagination @@ -52,10 +53,10 @@ type ListConfigurationPoliciesInput struct { type ListConfigurationPoliciesOutput struct { - // Provides metadata for each of your configuration policies. + // Provides metadata for each of your configuration policies. ConfigurationPolicySummaries []types.ConfigurationPolicySummary - // The NextToken value to include in the next ListConfigurationPolicies request. + // The NextToken value to include in the next ListConfigurationPolicies request. // When the results of a ListConfigurationPolicies 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. @@ -154,7 +155,7 @@ var _ ListConfigurationPoliciesAPIClient = (*Client)(nil) // ListConfigurationPoliciesPaginatorOptions is the paginator options for // ListConfigurationPolicies type ListConfigurationPoliciesPaginatorOptions struct { - // The maximum number of results that's returned by ListConfigurationPolicies in + // The maximum number of results that's returned by ListConfigurationPolicies in // each page of the response. When this parameter is used, // ListConfigurationPolicies returns the specified number of results in a single // page and a NextToken response element. You can see the remaining results of the diff --git a/service/securityhub/api_op_ListConfigurationPolicyAssociations.go b/service/securityhub/api_op_ListConfigurationPolicyAssociations.go index fda560a072a..40e39791eb0 100644 --- a/service/securityhub/api_op_ListConfigurationPolicyAssociations.go +++ b/service/securityhub/api_op_ListConfigurationPolicyAssociations.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the associations for your configuration policies and -// self-managed behavior. Only the Security Hub delegated administrator can invoke -// this operation from the home Region. +// Provides information about the associations for your configuration policies +// +// and self-managed behavior. Only the Security Hub delegated administrator can +// invoke this operation from the home Region. func (c *Client) ListConfigurationPolicyAssociations(ctx context.Context, params *ListConfigurationPolicyAssociationsInput, optFns ...func(*Options)) (*ListConfigurationPolicyAssociationsOutput, error) { if params == nil { params = &ListConfigurationPolicyAssociationsInput{} @@ -31,12 +32,12 @@ func (c *Client) ListConfigurationPolicyAssociations(ctx context.Context, params type ListConfigurationPolicyAssociationsInput struct { - // Options for filtering the ListConfigurationPolicyAssociations response. You can - // filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) - // of a configuration, AssociationType , or AssociationStatus . + // Options for filtering the ListConfigurationPolicyAssociations response. You + // can filter by the Amazon Resource Name (ARN) or universally unique identifier + // (UUID) of a configuration, AssociationType , or AssociationStatus . Filters *types.AssociationFilters - // The maximum number of results that's returned by ListConfigurationPolicies in + // The maximum number of results that's returned by ListConfigurationPolicies in // each page of the response. When this parameter is used, // ListConfigurationPolicyAssociations returns the specified number of results in a // single page and a NextToken response element. You can see the remaining results @@ -45,7 +46,7 @@ type ListConfigurationPolicyAssociationsInput struct { // between 1 and 100. MaxResults *int32 - // The NextToken value that's returned from a previous paginated + // The NextToken value that's returned from a previous paginated // ListConfigurationPolicyAssociations request where MaxResults was used but the // results exceeded the value of that parameter. Pagination continues from the end // of the previous response that returned the NextToken value. This value is null @@ -57,11 +58,11 @@ type ListConfigurationPolicyAssociationsInput struct { type ListConfigurationPolicyAssociationsOutput struct { - // An object that contains the details of each configuration policy association + // An object that contains the details of each configuration policy association // that’s returned in a ListConfigurationPolicyAssociations request. ConfigurationPolicyAssociationSummaries []types.ConfigurationPolicyAssociationSummary - // The NextToken value to include in the next ListConfigurationPolicyAssociations + // The NextToken value to include in the next ListConfigurationPolicyAssociations // request. When the results of a ListConfigurationPolicyAssociations 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. @@ -160,7 +161,7 @@ var _ ListConfigurationPolicyAssociationsAPIClient = (*Client)(nil) // ListConfigurationPolicyAssociationsPaginatorOptions is the paginator options // for ListConfigurationPolicyAssociations type ListConfigurationPolicyAssociationsPaginatorOptions struct { - // The maximum number of results that's returned by ListConfigurationPolicies in + // The maximum number of results that's returned by ListConfigurationPolicies in // each page of the response. When this parameter is used, // ListConfigurationPolicyAssociations returns the specified number of results in a // single page and a NextToken response element. You can see the remaining results diff --git a/service/securityhub/api_op_ListEnabledProductsForImport.go b/service/securityhub/api_op_ListEnabledProductsForImport.go index 946c9f8c6ec..4739fcd3d8f 100644 --- a/service/securityhub/api_op_ListEnabledProductsForImport.go +++ b/service/securityhub/api_op_ListEnabledProductsForImport.go @@ -33,8 +33,9 @@ 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 1b3f15b03b1..df2b2552f56 100644 --- a/service/securityhub/api_op_ListFindingAggregators.go +++ b/service/securityhub/api_op_ListFindingAggregators.go @@ -48,7 +48,9 @@ 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. diff --git a/service/securityhub/api_op_ListInvitations.go b/service/securityhub/api_op_ListInvitations.go index 9a912fc3159..ab9311e8166 100644 --- a/service/securityhub/api_op_ListInvitations.go +++ b/service/securityhub/api_op_ListInvitations.go @@ -12,9 +12,11 @@ import ( ) // Lists all Security Hub membership invitations that were sent to the current -// Amazon Web Services account. This operation is only used by accounts that are -// managed by invitation. Accounts that are managed using the integration with -// Organizations do not receive invitations. +// Amazon Web Services account. +// +// This operation is only used by accounts that are managed by invitation. +// Accounts that are managed using the integration with Organizations do not +// receive invitations. func (c *Client) ListInvitations(ctx context.Context, params *ListInvitationsInput, optFns ...func(*Options)) (*ListInvitationsOutput, error) { if params == nil { params = &ListInvitationsInput{} @@ -36,9 +38,10 @@ 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 - // subsequent calls to the operation, to continue listing data, set the value of - // this parameter to the value returned from the previous response. + // 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 noSmithyDocumentSerde diff --git a/service/securityhub/api_op_ListMembers.go b/service/securityhub/api_op_ListMembers.go index a26c27fddbd..ab698c22f49 100644 --- a/service/securityhub/api_op_ListMembers.go +++ b/service/securityhub/api_op_ListMembers.go @@ -12,8 +12,10 @@ import ( ) // Lists details about all member accounts for the current Security Hub -// administrator account. The results include both member accounts that belong to -// an organization and member accounts that were invited manually. +// administrator account. +// +// The results include both member accounts that belong to an organization and +// member accounts that were invited manually. func (c *Client) ListMembers(ctx context.Context, params *ListMembersInput, optFns ...func(*Options)) (*ListMembersOutput, error) { if params == nil { params = &ListMembersInput{} @@ -35,16 +37,19 @@ 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, to continue listing data, set the value of this parameter to the - // value returned from the previous response. + // 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 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_ListSecurityControlDefinitions.go b/service/securityhub/api_op_ListSecurityControlDefinitions.go index 4589ef4b95e..74540b5429e 100644 --- a/service/securityhub/api_op_ListSecurityControlDefinitions.go +++ b/service/securityhub/api_op_ListSecurityControlDefinitions.go @@ -29,7 +29,7 @@ func (c *Client) ListSecurityControlDefinitions(ctx context.Context, params *Lis type ListSecurityControlDefinitionsInput struct { - // An optional parameter that limits the total results of the API response to the + // An optional parameter that limits the total results of the API response to the // specified number. If this parameter isn't provided in the request, the results // include the first 25 security controls that apply to the specified standard. The // results also include a NextToken parameter that you can use in a subsequent API @@ -37,10 +37,10 @@ type ListSecurityControlDefinitionsInput struct { // standard are returned. MaxResults *int32 - // Optional pagination parameter. + // Optional pagination parameter. NextToken *string - // The Amazon Resource Name (ARN) of the standard that you want to view controls + // The Amazon Resource Name (ARN) of the standard that you want to view controls // for. StandardsArn *string @@ -49,12 +49,12 @@ type ListSecurityControlDefinitionsInput struct { type ListSecurityControlDefinitionsOutput struct { - // An array of controls that apply to the specified standard. + // An array of controls that apply to the specified standard. // // This member is required. SecurityControlDefinitions []types.SecurityControlDefinition - // A pagination parameter that's included in the response only if it was included + // A pagination parameter that's included in the response only if it was included // in the request. NextToken *string @@ -151,7 +151,7 @@ var _ ListSecurityControlDefinitionsAPIClient = (*Client)(nil) // ListSecurityControlDefinitionsPaginatorOptions is the paginator options for // ListSecurityControlDefinitions type ListSecurityControlDefinitionsPaginatorOptions struct { - // An optional parameter that limits the total results of the API response to the + // An optional parameter that limits the total results of the API response to the // specified number. If this parameter isn't provided in the request, the results // include the first 25 security controls that apply to the specified standard. The // results also include a NextToken parameter that you can use in a subsequent API diff --git a/service/securityhub/api_op_ListStandardsControlAssociations.go b/service/securityhub/api_op_ListStandardsControlAssociations.go index 5f422e8003f..14bf49e403b 100644 --- a/service/securityhub/api_op_ListStandardsControlAssociations.go +++ b/service/securityhub/api_op_ListStandardsControlAssociations.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Specifies whether a control is currently enabled or disabled in each enabled +// Specifies whether a control is currently enabled or disabled in each enabled +// // standard in the calling account. func (c *Client) ListStandardsControlAssociations(ctx context.Context, params *ListStandardsControlAssociationsInput, optFns ...func(*Options)) (*ListStandardsControlAssociationsOutput, error) { if params == nil { @@ -30,14 +31,14 @@ func (c *Client) ListStandardsControlAssociations(ctx context.Context, params *L type ListStandardsControlAssociationsInput struct { - // The identifier of the control (identified with SecurityControlId , + // 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. SecurityControlId *string - // An optional parameter that limits the total results of the API response to the + // An optional parameter that limits the total results of the API response to the // specified number. If this parameter isn't provided in the request, the results // include the first 25 standard and control associations. The results also include // a NextToken parameter that you can use in a subsequent API call to get the next @@ -46,7 +47,7 @@ type ListStandardsControlAssociationsInput struct { // Security Hub standards that you've enabled in the calling account. MaxResults *int32 - // Optional pagination parameter. + // Optional pagination parameter. NextToken *string noSmithyDocumentSerde @@ -54,13 +55,13 @@ type ListStandardsControlAssociationsInput struct { type ListStandardsControlAssociationsOutput struct { - // An array that provides the enablement status and other details for each + // 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 - // A pagination parameter that's included in the response only if it was included + // A pagination parameter that's included in the response only if it was included // in the request. NextToken *string @@ -160,7 +161,7 @@ var _ ListStandardsControlAssociationsAPIClient = (*Client)(nil) // ListStandardsControlAssociationsPaginatorOptions is the paginator options for // ListStandardsControlAssociations type ListStandardsControlAssociationsPaginatorOptions struct { - // An optional parameter that limits the total results of the API response to the + // An optional parameter that limits the total results of the API response to the // specified number. If this parameter isn't provided in the request, the results // include the first 25 standard and control associations. The results also include // a NextToken parameter that you can use in a subsequent API call to get the next diff --git a/service/securityhub/api_op_StartConfigurationPolicyAssociation.go b/service/securityhub/api_op_StartConfigurationPolicyAssociation.go index 46b180f1c67..08bd4cdbc56 100644 --- a/service/securityhub/api_op_StartConfigurationPolicyAssociation.go +++ b/service/securityhub/api_op_StartConfigurationPolicyAssociation.go @@ -12,7 +12,8 @@ import ( "time" ) -// Associates a target account, organizational unit, or the root with a specified +// Associates a target account, organizational unit, or the root with a specified +// // configuration. The target can be associated with a configuration policy or // self-managed behavior. Only the Security Hub delegated administrator can invoke // this operation from the home Region. @@ -33,14 +34,14 @@ func (c *Client) StartConfigurationPolicyAssociation(ctx context.Context, params type StartConfigurationPolicyAssociationInput struct { - // The Amazon Resource Name (ARN) of a configuration policy, the universally + // The Amazon Resource Name (ARN) of a configuration policy, the universally // unique identifier (UUID) of a configuration policy, or a value of // SELF_MANAGED_SECURITY_HUB for a self-managed configuration. // // This member is required. ConfigurationPolicyIdentifier *string - // The identifier of the target account, organizational unit, or the root to + // The identifier of the target account, organizational unit, or the root to // associate with the specified configuration. // // This member is required. @@ -51,30 +52,30 @@ type StartConfigurationPolicyAssociationInput struct { type StartConfigurationPolicyAssociationOutput struct { - // The current status of the association between the specified target and the + // The current status of the association between the specified target and the // configuration. AssociationStatus types.ConfigurationPolicyAssociationStatus - // An explanation for a FAILED value for AssociationStatus . + // An explanation for a FAILED value for AssociationStatus . AssociationStatusMessage *string - // Indicates whether the association between the specified target and the + // Indicates whether the association between the specified target and the // configuration was directly applied by the Security Hub delegated administrator // or inherited from a parent. AssociationType types.AssociationType - // The UUID of the configuration policy. + // The UUID of the configuration policy. ConfigurationPolicyId *string - // The identifier of the target account, organizational unit, or the organization + // The identifier of the target account, organizational unit, or the organization // root with which the configuration is associated. TargetId *string - // Indicates whether the target is an Amazon Web Services account, organizational + // Indicates whether the target is an Amazon Web Services account, organizational // unit, or the organization root. TargetType types.TargetType - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // association was last updated. UpdatedAt *time.Time diff --git a/service/securityhub/api_op_StartConfigurationPolicyDisassociation.go b/service/securityhub/api_op_StartConfigurationPolicyDisassociation.go index 8ba76664d1d..aa1775a9a45 100644 --- a/service/securityhub/api_op_StartConfigurationPolicyDisassociation.go +++ b/service/securityhub/api_op_StartConfigurationPolicyDisassociation.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates a target account, organizational unit, or the root from a +// Disassociates a target account, organizational unit, or the root from a +// // specified configuration. When you disassociate a configuration from its target, // the target inherits the configuration of the closest parent. If there’s no // configuration to inherit, the target retains its settings but becomes a @@ -35,14 +36,14 @@ func (c *Client) StartConfigurationPolicyDisassociation(ctx context.Context, par type StartConfigurationPolicyDisassociationInput struct { - // The Amazon Resource Name (ARN) of a configuration policy, the universally + // The Amazon Resource Name (ARN) of a configuration policy, the universally // unique identifier (UUID) of a configuration policy, or a value of // SELF_MANAGED_SECURITY_HUB for a self-managed configuration. // // This member is required. ConfigurationPolicyIdentifier *string - // The identifier of the target account, organizational unit, or the root to + // The identifier of the target account, organizational unit, or the root to // disassociate from the specified configuration. Target types.Target diff --git a/service/securityhub/api_op_UpdateConfigurationPolicy.go b/service/securityhub/api_op_UpdateConfigurationPolicy.go index f8b46946e2d..f0cb762f6a1 100644 --- a/service/securityhub/api_op_UpdateConfigurationPolicy.go +++ b/service/securityhub/api_op_UpdateConfigurationPolicy.go @@ -12,7 +12,8 @@ import ( "time" ) -// Updates a configuration policy. Only the Security Hub delegated administrator +// Updates a configuration policy. Only the Security Hub delegated administrator +// // can invoke this operation from the home Region. func (c *Client) UpdateConfigurationPolicy(ctx context.Context, params *UpdateConfigurationPolicyInput, optFns ...func(*Options)) (*UpdateConfigurationPolicyOutput, error) { if params == nil { @@ -31,33 +32,34 @@ func (c *Client) UpdateConfigurationPolicy(ctx context.Context, params *UpdateCo type UpdateConfigurationPolicyInput struct { - // The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the + // The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the // configuration policy. // // This member is required. Identifier *string - // An object that defines how Security Hub is configured. It includes whether + // An object that defines how Security Hub is configured. It includes whether // Security Hub is enabled or disabled, a list of enabled security standards, a // list of enabled or disabled security controls, and a list of custom parameter // values for specified controls. If you provide a list of security controls that // are enabled in the configuration policy, Security Hub disables all other // controls (including newly released controls). If you provide a list of security // controls that are disabled in the configuration policy, Security Hub enables all - // other controls (including newly released controls). When updating a - // configuration policy, provide a complete list of standards that you want to - // enable and a complete list of controls that you want to enable or disable. The - // updated configuration replaces the current configuration. + // other controls (including newly released controls). + // + // When updating a configuration policy, provide a complete list of standards that + // you want to enable and a complete list of controls that you want to enable or + // disable. The updated configuration replaces the current configuration. ConfigurationPolicy types.Policy - // The description of the configuration policy. + // The description of the configuration policy. Description *string - // The name of the configuration policy. Alphanumeric characters and the following - // ASCII characters are permitted: -, ., !, *, / . + // The name of the configuration policy. Alphanumeric characters and the + // following ASCII characters are permitted: -, ., !, *, / . Name *string - // The reason for updating the configuration policy. + // The reason for updating the configuration policy. UpdatedReason *string noSmithyDocumentSerde @@ -65,10 +67,10 @@ type UpdateConfigurationPolicyInput struct { type UpdateConfigurationPolicyOutput struct { - // The ARN of the configuration policy. + // The ARN of the configuration policy. Arn *string - // An object that defines how Security Hub is configured. It includes whether + // An object that defines how Security Hub is configured. It includes whether // Security Hub is enabled or disabled, a list of enabled security standards, a // list of enabled or disabled security controls, and a list of custom parameter // values for specified controls. If the request included a list of security @@ -78,20 +80,20 @@ type UpdateConfigurationPolicyOutput struct { // Security Hub enables all other controls (including newly released controls). ConfigurationPolicy types.Policy - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was created. CreatedAt *time.Time - // The description of the configuration policy. + // The description of the configuration policy. Description *string - // The UUID of the configuration policy. + // The UUID of the configuration policy. Id *string - // The name of the configuration policy. + // The name of the configuration policy. Name *string - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was last updated. UpdatedAt *time.Time diff --git a/service/securityhub/api_op_UpdateFindingAggregator.go b/service/securityhub/api_op_UpdateFindingAggregator.go index 794438f786b..247e69f83f9 100644 --- a/service/securityhub/api_op_UpdateFindingAggregator.go +++ b/service/securityhub/api_op_UpdateFindingAggregator.go @@ -12,8 +12,9 @@ import ( // 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. +// 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) { if params == nil { params = &UpdateFindingAggregatorInput{} @@ -40,17 +41,23 @@ type UpdateFindingAggregatorInput 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: + // 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. @@ -60,9 +67,10 @@ type UpdateFindingAggregatorInput struct { // 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 - // space-separated list of Regions that do aggregate findings to the aggregation - // Region. + // 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 noSmithyDocumentSerde diff --git a/service/securityhub/api_op_UpdateFindings.go b/service/securityhub/api_op_UpdateFindings.go index 7f1db3db477..85a939e874c 100644 --- a/service/securityhub/api_op_UpdateFindings.go +++ b/service/securityhub/api_op_UpdateFindings.go @@ -12,11 +12,15 @@ import ( ) // UpdateFindings is a deprecated operation. Instead of UpdateFindings , use the -// BatchUpdateFindings operation. 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. Finding updates -// made with UpdateFindings might not be persisted if the same finding is later -// updated by the finding provider through the BatchImportFindings operation. +// BatchUpdateFindings operation. +// +// 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. +// +// Finding updates made with UpdateFindings might not be persisted if the same +// finding is later updated by the finding provider through the BatchImportFindings +// operation. func (c *Client) UpdateFindings(ctx context.Context, params *UpdateFindingsInput, optFns ...func(*Options)) (*UpdateFindingsOutput, error) { if params == nil { params = &UpdateFindingsInput{} diff --git a/service/securityhub/api_op_UpdateOrganizationConfiguration.go b/service/securityhub/api_op_UpdateOrganizationConfiguration.go index d3f7b8e358a..3fea73876a6 100644 --- a/service/securityhub/api_op_UpdateOrganizationConfiguration.go +++ b/service/securityhub/api_op_UpdateOrganizationConfiguration.go @@ -31,31 +31,40 @@ func (c *Client) UpdateOrganizationConfiguration(ctx context.Context, params *Up type UpdateOrganizationConfigurationInput struct { // Whether to automatically enable Security Hub in new member accounts when they - // join the organization. If set to true , then Security Hub is automatically - // enabled in new accounts. If set to false , then Security Hub isn't enabled in - // new accounts automatically. The default value is false . If the - // ConfigurationType of your organization is set to CENTRAL , then this field is - // set to false and can't be changed in the home Region and linked Regions. - // However, in that case, the delegated administrator can create a configuration - // policy in which Security Hub is enabled and associate the policy with new - // organization accounts. + // join the organization. + // + // If set to true , then Security Hub is automatically enabled in new accounts. If + // set to false , then Security Hub isn't enabled in new accounts automatically. + // The default value is false . + // + // If the ConfigurationType of your organization is set to CENTRAL , then this + // field is set to false and can't be changed in the home Region and linked + // Regions. However, in that case, the delegated administrator can create a + // configuration policy in which Security Hub is enabled and associate the policy + // with new organization accounts. // // 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) - // in new member accounts when they join 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 default standards are not automatically enabled for new member - // accounts. If the ConfigurationType of your organization is set to CENTRAL , then - // this field is set to NONE and can't be changed in the home Region and linked + // Whether to automatically enable Security Hub [default standards] in new member accounts when they + // join 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 default standards are + // not automatically enabled for new member accounts. + // + // If the ConfigurationType of your organization is set to CENTRAL , then this + // field is set to NONE and can't be changed in the home Region and linked // Regions. However, in that case, the delegated administrator can create a // configuration policy in which specific security standards are enabled and // associate the policy with new organization accounts. + // + // [default standards]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html AutoEnableStandards types.AutoEnableStandards - // Provides information about the way an organization is configured in Security + // Provides information about the way an organization is configured in Security // Hub. OrganizationConfiguration *types.OrganizationConfiguration diff --git a/service/securityhub/api_op_UpdateSecurityControl.go b/service/securityhub/api_op_UpdateSecurityControl.go index a0e79cf2dd6..a933afd4424 100644 --- a/service/securityhub/api_op_UpdateSecurityControl.go +++ b/service/securityhub/api_op_UpdateSecurityControl.go @@ -29,17 +29,17 @@ func (c *Client) UpdateSecurityControl(ctx context.Context, params *UpdateSecuri type UpdateSecurityControlInput struct { - // An object that specifies which security control parameters to update. + // An object that specifies which security control parameters to update. // // This member is required. Parameters map[string]types.ParameterConfiguration - // The Amazon Resource Name (ARN) or ID of the control to update. + // The Amazon Resource Name (ARN) or ID of the control to update. // // This member is required. SecurityControlId *string - // The most recent reason for updating the properties of the security control. + // The most recent reason for updating the properties of the security control. // This field accepts alphanumeric characters in addition to white spaces, dashes, // and underscores. LastUpdateReason *string diff --git a/service/securityhub/api_op_UpdateSecurityHubConfiguration.go b/service/securityhub/api_op_UpdateSecurityHubConfiguration.go index 6ecca1e3db4..151321a0b54 100644 --- a/service/securityhub/api_op_UpdateSecurityHubConfiguration.go +++ b/service/securityhub/api_op_UpdateSecurityHubConfiguration.go @@ -30,17 +30,23 @@ 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. + // 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 7ffe804cca8..e6e23ffe149 100644 --- a/service/securityhub/doc.go +++ b/service/securityhub/doc.go @@ -5,45 +5,53 @@ // // Security Hub provides you with a comprehensive view of your security state in // Amazon Web Services and helps you assess your Amazon Web Services environment -// against security industry standards and best practices. Security Hub collects -// security data across Amazon Web Services accounts, Amazon Web Services, and -// supported third-party products and helps you analyze your security trends and -// identify the highest priority security issues. To help you manage the security -// state of your organization, Security Hub supports multiple security standards. -// These include the Amazon Web Services Foundational Security Best Practices -// (FSBP) standard developed by Amazon Web Services, and external compliance -// frameworks such as the Center for Internet Security (CIS), the Payment Card -// Industry Data Security Standard (PCI DSS), and the National Institute of -// Standards and Technology (NIST). Each standard includes several security -// controls, each of which represents a security best practice. Security Hub runs -// checks against security controls and generates control findings to help you -// assess your compliance against security best practices. In addition to -// generating control findings, Security Hub also receives findings from other -// Amazon Web Services, such as Amazon GuardDuty and Amazon Inspector, and -// supported third-party products. This gives you a single pane of glass into a +// against security industry standards and best practices. +// +// Security Hub collects security data across Amazon Web Services accounts, Amazon +// Web Services, and supported third-party products and helps you analyze your +// security trends and identify the highest priority security issues. +// +// To help you manage the security state of your organization, Security Hub +// supports multiple security standards. These include the Amazon Web Services +// Foundational Security Best Practices (FSBP) standard developed by Amazon Web +// Services, and external compliance frameworks such as the Center for Internet +// Security (CIS), the Payment Card Industry Data Security Standard (PCI DSS), and +// the National Institute of Standards and Technology (NIST). Each standard +// includes several security controls, each of which represents a security best +// practice. Security Hub runs checks against security controls and generates +// control findings to help you assess your compliance against security best +// practices. +// +// In addition to generating control findings, Security Hub also receives findings +// from other Amazon Web Services, such as Amazon GuardDuty and Amazon Inspector, +// and supported third-party products. This gives you a single pane of glass into a // variety of security-related issues. You can also send Security Hub findings to -// other Amazon Web Services and supported third-party products. Security Hub -// offers automation features that help you triage and remediate security issues. -// For example, you can use automation rules to automatically update critical -// findings when a security check fails. You can also leverage the integration with -// Amazon EventBridge to trigger automatic responses to specific findings. This -// guide, the Security Hub API Reference, provides information about the Security -// Hub API. This includes supported resources, HTTP methods, parameters, and -// schemas. If you're new to Security Hub, you might find it helpful to also review -// the Security Hub User Guide (https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) -// . The user guide explains key concepts and provides procedures that demonstrate -// how to use Security Hub features. It also provides information about topics such -// as integrating Security Hub with other Amazon Web Services. In addition to -// interacting with Security Hub by making calls to the Security Hub API, you can -// use a current version of an Amazon Web Services command line tool or SDK. Amazon -// Web Services provides tools and SDKs that consist of libraries and sample code -// for various languages and platforms, such as PowerShell, Java, Go, Python, C++, -// and .NET. These tools and SDKs provide convenient, programmatic access to -// Security Hub and other Amazon Web Services . They also handle tasks such as -// signing requests, managing errors, and retrying requests automatically. For -// information about installing and using the Amazon Web Services tools and SDKs, -// see Tools to Build on Amazon Web Services (http://aws.amazon.com/developer/tools/) -// . With the exception of operations that are related to central configuration, +// other Amazon Web Services and supported third-party products. +// +// Security Hub offers automation features that help you triage and remediate +// security issues. For example, you can use automation rules to automatically +// update critical findings when a security check fails. You can also leverage the +// integration with Amazon EventBridge to trigger automatic responses to specific +// findings. +// +// This guide, the Security Hub API Reference, provides information about the +// Security Hub API. This includes supported resources, HTTP methods, parameters, +// and schemas. If you're new to Security Hub, you might find it helpful to also +// review the [Security Hub User Guide]. The user guide explains key concepts and provides procedures that +// demonstrate how to use Security Hub features. It also provides information about +// topics such as integrating Security Hub with other Amazon Web Services. +// +// In addition to interacting with Security Hub by making calls to the Security +// Hub API, you can use a current version of an Amazon Web Services command line +// tool or SDK. Amazon Web Services provides tools and SDKs that consist of +// libraries and sample code for various languages and platforms, such as +// PowerShell, Java, Go, Python, C++, and .NET. These tools and SDKs provide +// convenient, programmatic access to Security Hub and other Amazon Web Services . +// They also handle tasks such as signing requests, managing errors, and retrying +// requests automatically. For information about installing and using the Amazon +// Web Services tools and SDKs, see [Tools to Build on Amazon Web Services]. +// +// With the exception of operations that are related to central configuration, // Security Hub API 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 @@ -51,20 +59,30 @@ // Regions, call the same API operation in each Region in which you want to apply // the change. When you use central configuration, API requests for enabling // Security Hub, standards, and controls are executed in the home Region and all -// linked Regions. For a list of central configuration operations, see the Central -// configuration terms and concepts (https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts) -// section of the Security Hub User Guide. The following throttling limits apply to -// Security Hub API operations. +// linked Regions. For a list of central configuration operations, see the [Central configuration terms and concepts]section +// of the Security Hub User Guide. +// +// The following throttling limits apply to 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. +// +// [Security Hub User Guide]: https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html +// [Tools to Build on Amazon Web Services]: http://aws.amazon.com/developer/tools/ +// [Central configuration terms and concepts]: https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts package securityhub diff --git a/service/securityhub/options.go b/service/securityhub/options.go index ac4e7ec6d08..39e84cb3350 100644 --- a/service/securityhub/options.go +++ b/service/securityhub/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/securityhub/types/enums.go b/service/securityhub/types/enums.go index f963ce16845..16c422a042a 100644 --- a/service/securityhub/types/enums.go +++ b/service/securityhub/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AdminStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdminStatus) Values() []AdminStatus { return []AdminStatus{ "ENABLED", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AssociationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationStatus) Values() []AssociationStatus { return []AssociationStatus{ "ENABLED", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for AssociationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationType) Values() []AssociationType { return []AssociationType{ "INHERITED", @@ -65,8 +68,9 @@ const ( ) // Values returns all known values for AutoEnableStandards. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoEnableStandards) Values() []AutoEnableStandards { return []AutoEnableStandards{ "NONE", @@ -83,6 +87,7 @@ const ( // Values returns all known values for AutomationRulesActionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AutomationRulesActionType) Values() []AutomationRulesActionType { return []AutomationRulesActionType{ @@ -99,8 +104,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Active", @@ -118,8 +124,9 @@ const ( // Values returns all known values for // AwsS3BucketNotificationConfigurationS3KeyFilterRuleName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AwsS3BucketNotificationConfigurationS3KeyFilterRuleName) Values() []AwsS3BucketNotificationConfigurationS3KeyFilterRuleName { return []AwsS3BucketNotificationConfigurationS3KeyFilterRuleName{ "Prefix", @@ -138,8 +145,9 @@ const ( ) // Values returns all known values for ComplianceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceStatus) Values() []ComplianceStatus { return []ComplianceStatus{ "PASSED", @@ -160,8 +168,9 @@ const ( // Values returns all known values for ConfigurationPolicyAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationPolicyAssociationStatus) Values() []ConfigurationPolicyAssociationStatus { return []ConfigurationPolicyAssociationStatus{ "PENDING", @@ -179,8 +188,9 @@ const ( ) // Values returns all known values for ControlFindingGenerator. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlFindingGenerator) Values() []ControlFindingGenerator { return []ControlFindingGenerator{ "STANDARD_CONTROL", @@ -197,8 +207,9 @@ const ( ) // Values returns all known values for ControlStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ControlStatus) Values() []ControlStatus { return []ControlStatus{ "ENABLED", @@ -214,8 +225,9 @@ const ( ) // Values returns all known values for DateRangeUnit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DateRangeUnit) Values() []DateRangeUnit { return []DateRangeUnit{ "DAYS", @@ -232,8 +244,9 @@ const ( // Values returns all known values for FindingHistoryUpdateSourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FindingHistoryUpdateSourceType) Values() []FindingHistoryUpdateSourceType { return []FindingHistoryUpdateSourceType{ "BATCH_UPDATE_FINDINGS", @@ -251,8 +264,9 @@ const ( ) // Values returns all known values for IntegrationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationType) Values() []IntegrationType { return []IntegrationType{ "SEND_FINDINGS_TO_SECURITY_HUB", @@ -271,8 +285,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -303,8 +318,9 @@ const ( ) // Values returns all known values for MalwareType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MalwareType) Values() []MalwareType { return []MalwareType{ "ADWARE", @@ -336,8 +352,9 @@ const ( ) // Values returns all known values for MapFilterComparison. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MapFilterComparison) Values() []MapFilterComparison { return []MapFilterComparison{ "EQUALS", @@ -356,8 +373,9 @@ const ( ) // Values returns all known values for NetworkDirection. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NetworkDirection) Values() []NetworkDirection { return []NetworkDirection{ "IN", @@ -375,8 +393,9 @@ const ( // Values returns all known values for OrganizationConfigurationConfigurationType. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationConfigurationConfigurationType) Values() []OrganizationConfigurationConfigurationType { return []OrganizationConfigurationConfigurationType{ "CENTRAL", @@ -395,8 +414,9 @@ const ( // Values returns all known values for OrganizationConfigurationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationConfigurationStatus) Values() []OrganizationConfigurationStatus { return []OrganizationConfigurationStatus{ "PENDING", @@ -414,8 +434,9 @@ const ( ) // Values returns all known values for ParameterValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterValueType) Values() []ParameterValueType { return []ParameterValueType{ "DEFAULT", @@ -433,8 +454,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -452,8 +474,9 @@ const ( ) // Values returns all known values for RecordState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordState) Values() []RecordState { return []RecordState{ "ACTIVE", @@ -471,6 +494,7 @@ const ( // 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{ @@ -488,8 +512,9 @@ const ( ) // Values returns all known values for RuleStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RuleStatus) Values() []RuleStatus { return []RuleStatus{ "ENABLED", @@ -505,8 +530,9 @@ const ( ) // Values returns all known values for SecurityControlProperty. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityControlProperty) Values() []SecurityControlProperty { return []SecurityControlProperty{ "Parameters", @@ -525,8 +551,9 @@ const ( ) // Values returns all known values for SeverityLabel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SeverityLabel) Values() []SeverityLabel { return []SeverityLabel{ "INFORMATIONAL", @@ -548,8 +575,9 @@ const ( ) // Values returns all known values for SeverityRating. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SeverityRating) Values() []SeverityRating { return []SeverityRating{ "LOW", @@ -568,8 +596,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -589,8 +618,9 @@ const ( ) // Values returns all known values for StandardsStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StandardsStatus) Values() []StandardsStatus { return []StandardsStatus{ "PENDING", @@ -610,8 +640,9 @@ const ( ) // Values returns all known values for StatusReasonCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StatusReasonCode) Values() []StatusReasonCode { return []StatusReasonCode{ "NO_AVAILABLE_CONFIGURATION_RECORDER", @@ -632,8 +663,9 @@ const ( ) // Values returns all known values for StringFilterComparison. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StringFilterComparison) Values() []StringFilterComparison { return []StringFilterComparison{ "EQUALS", @@ -654,8 +686,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "ACCOUNT", @@ -677,8 +710,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ThreatIntelIndicatorCategory) Values() []ThreatIntelIndicatorCategory { return []ThreatIntelIndicatorCategory{ "BACKDOOR", @@ -709,6 +743,7 @@ const ( // 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{ @@ -737,8 +772,9 @@ const ( ) // Values returns all known values for UnprocessedErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnprocessedErrorCode) Values() []UnprocessedErrorCode { return []UnprocessedErrorCode{ "INVALID_INPUT", @@ -757,8 +793,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "READY", @@ -777,8 +814,9 @@ const ( ) // Values returns all known values for VerificationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationState) Values() []VerificationState { return []VerificationState{ "UNKNOWN", @@ -798,8 +836,9 @@ const ( // Values returns all known values for VulnerabilityExploitAvailable. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VulnerabilityExploitAvailable) Values() []VulnerabilityExploitAvailable { return []VulnerabilityExploitAvailable{ "YES", @@ -818,6 +857,7 @@ const ( // Values returns all known values for VulnerabilityFixAvailable. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (VulnerabilityFixAvailable) Values() []VulnerabilityFixAvailable { return []VulnerabilityFixAvailable{ @@ -839,8 +879,9 @@ const ( ) // Values returns all known values for WorkflowState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowState) Values() []WorkflowState { return []WorkflowState{ "NEW", @@ -862,8 +903,9 @@ const ( ) // Values returns all known values for WorkflowStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStatus) Values() []WorkflowStatus { return []WorkflowStatus{ "NEW", diff --git a/service/securityhub/types/errors.go b/service/securityhub/types/errors.go index 5429c33f73d..9ec6248f092 100644 --- a/service/securityhub/types/errors.go +++ b/service/securityhub/types/errors.go @@ -178,9 +178,10 @@ func (e *ResourceConflictException) ErrorCode() string { } func (e *ResourceConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was rejected because it conflicts with the resource's availability. -// For example, you tried to update a security control that's currently in the -// UPDATING state. +// The request was rejected because it conflicts with the resource's +// +// availability. For example, you tried to update a security control that's +// currently in the UPDATING state. type ResourceInUseException struct { Message *string diff --git a/service/securityhub/types/types.go b/service/securityhub/types/types.go index 6b4ea6170ee..41a1cb78691 100644 --- a/service/securityhub/types/types.go +++ b/service/securityhub/types/types.go @@ -23,16 +23,24 @@ 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 type Action struct { // The type of action that was detected. The possible action types are: + // // - NETWORK_CONNECTION + // // - AWS_API_CALL + // // - DNS_REQUEST + // // - PORT_PROBE ActionType *string @@ -162,34 +170,37 @@ type AdminAccount struct { noSmithyDocumentSerde } -// Information about an enabled security standard in which a security control is +// Information about an enabled security standard in which a security control is +// // enabled. 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) - // API response. + // a standard in the [DescribeStandards]API response. + // + // [DescribeStandards]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html StandardsId *string noSmithyDocumentSerde } -// Options for filtering the ListConfigurationPolicyAssociations response. You can -// filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) -// of a configuration policy, AssociationType , or AssociationStatus . +// Options for filtering the ListConfigurationPolicyAssociations response. You +// +// can filter by the Amazon Resource Name (ARN) or universally unique identifier +// (UUID) of a configuration policy, AssociationType , or AssociationStatus . type AssociationFilters struct { - // The current status of the association between a target and a configuration + // The current status of the association between a target and a configuration // policy. AssociationStatus ConfigurationPolicyAssociationStatus - // Indicates whether the association between a target and a configuration was + // Indicates whether the association between a target and a configuration was // directly applied by the Security Hub delegated administrator or inherited from a // parent. AssociationType AssociationType - // The ARN or UUID of the configuration policy. + // The ARN or UUID of the configuration policy. ConfigurationPolicyId *string noSmithyDocumentSerde @@ -198,51 +209,55 @@ type AssociationFilters struct { // The associations between a route table and one or more subnets or a gateway. type AssociationSetDetails struct { - // The state of the association between a route table and a subnet or gateway. + // The state of the association between a route table and a subnet or gateway. AssociationState *AssociationStateDetails - // The ID of the internet gateway or virtual private gateway. + // The ID of the internet gateway or virtual private gateway. GatewayId *string - // Indicates whether this is the main route table. + // Indicates whether this is the main route table. Main *bool - // The ID of the association. + // The ID of the association. RouteTableAssociationId *string - // The ID of the route table. + // The ID of the route table. RouteTableId *string - // The ID of the subnet. A subnet ID is not returned for an implicit association. + // The ID of the subnet. A subnet ID is not returned for an implicit association. SubnetId *string noSmithyDocumentSerde } -// Describes the state of an association between a route table and a subnet or +// Describes the state of an association between a route table and a subnet or +// // gateway. type AssociationStateDetails struct { - // The state of the association. + // The state of the association. State *string - // The status message, if applicable. + // The status message, if applicable. StatusMessage *string noSmithyDocumentSerde } -// One or more actions to update finding fields if a finding matches the defined +// One or more actions to update finding fields if a finding matches the defined +// // criteria of the rule. type AutomationRulesAction struct { - // Specifies that the automation rule action is an update to a finding field. + // Specifies that the automation rule action is an update to a finding field. FindingFieldsUpdate *AutomationRulesFindingFieldsUpdate - // Specifies that the rule action should update the Types finding field. The Types + // Specifies that the rule action should update the Types finding field. The Types // finding field classifies findings in the format of - // namespace/category/classifier. For more information, see Types taxonomy for ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) - // in the Security Hub User Guide. + // namespace/category/classifier. For more information, see [Types taxonomy for ASFF]in the Security Hub + // User Guide. + // + // [Types taxonomy for ASFF]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html Type AutomationRulesActionType noSmithyDocumentSerde @@ -251,35 +266,41 @@ type AutomationRulesAction struct { // Defines the configuration of an automation rule. type AutomationRulesConfig struct { - // One or more actions to update finding fields if a finding matches the defined + // One or more actions to update finding fields if a finding matches the defined // criteria of the rule. Actions []AutomationRulesAction - // A timestamp that indicates when the rule was created. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that indicates when the rule was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedAt *time.Time - // The principal that created a rule. + // The principal that created a rule. CreatedBy *string - // A set of Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) - // finding field attributes and corresponding expected values that Security Hub - // uses to filter findings. If a rule is enabled and a finding matches the - // conditions specified in this parameter, Security Hub applies the rule action to - // the finding. + // A set of [Amazon Web Services Security Finding Format] finding field attributes and corresponding expected values that + // Security Hub uses to filter findings. If a rule is enabled and a finding matches + // the conditions specified in this parameter, Security Hub applies the rule action + // to the finding. + // + // [Amazon Web Services Security Finding Format]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html Criteria *AutomationRulesFindingFilters - // A description of the rule. + // A description of the rule. Description *string // Specifies whether a rule is the last to be applied with respect to a finding @@ -290,32 +311,37 @@ type AutomationRulesConfig struct { // rule isn't terminal. IsTerminal *bool - // The Amazon Resource Name (ARN) of a rule. + // The Amazon Resource Name (ARN) of a rule. RuleArn *string - // The name of the rule. + // The name of the rule. RuleName *string - // An integer ranging from 1 to 1000 that represents the order in which the rule + // An integer ranging from 1 to 1000 that represents the order in which the rule // action is applied to findings. Security Hub applies rules with lower values for // this parameter first. RuleOrder *int32 - // Whether the rule is active after it is created. If this parameter is equal to + // Whether the rule is active after it is created. If this parameter is equal to // ENABLED , Security Hub starts applying the rule to findings and finding updates // after the rule is created. RuleStatus RuleStatus - // A timestamp that indicates when the rule was most recently updated. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // A timestamp that indicates when the rule was most recently updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) UpdatedAt *time.Time @@ -323,32 +349,33 @@ type AutomationRulesConfig struct { noSmithyDocumentSerde } -// Identifies the finding fields that the automation rule action updates when a +// Identifies the finding fields that the automation rule action updates when a +// // finding matches the defined criteria. type AutomationRulesFindingFieldsUpdate struct { - // The rule action updates the Confidence field of a finding. + // The rule action updates the Confidence field of a finding. Confidence *int32 - // The rule action updates the Criticality field of a finding. + // The rule action updates the Criticality field of a finding. Criticality *int32 // The updated note. Note *NoteUpdate - // The rule action updates the RelatedFindings field of a finding. + // The rule action updates the RelatedFindings field of a finding. RelatedFindings []RelatedFinding // Updates to the severity information for a finding. Severity *SeverityUpdate - // The rule action updates the Types field of a finding. + // The rule action updates the Types field of a finding. Types []string - // The rule action updates the UserDefinedFields field of a finding. + // The rule action updates the UserDefinedFields field of a finding. UserDefinedFields map[string]string - // The rule action updates the VerificationState field of a finding. + // The rule action updates the VerificationState field of a finding. VerificationState VerificationState // Used to update information about the investigation into the finding. @@ -360,34 +387,41 @@ type AutomationRulesFindingFieldsUpdate struct { // The criteria that determine which findings a rule applies to. type AutomationRulesFindingFilters struct { - // The Amazon Web Services account ID in which a finding was generated. Array - // Members: Minimum number of 1 item. Maximum number of 100 items. + // The Amazon Web Services account ID in which a finding was generated. + // + // Array Members: Minimum number of 1 item. Maximum number of 100 items. AwsAccountId []StringFilter // The name of the Amazon Web Services account in which a finding was generated. + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. AwsAccountName []StringFilter - // The name of the company for the product that generated the finding. For - // control-based findings, the company is Amazon Web Services. Array Members: - // Minimum number of 1 item. Maximum number of 20 items. + // The name of the company for the product that generated the finding. For + // control-based findings, the company is Amazon Web Services. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. CompanyName []StringFilter // 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) - // API response. Array Members: Minimum number of 1 item. Maximum number of 20 - // items. + // a standard in the [DescribeStandards]API response. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. + // + // [DescribeStandards]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html ComplianceAssociatedStandardsId []StringFilter - // The security control ID for which a finding was generated. Security control IDs - // are the same across standards. Array Members: Minimum number of 1 item. Maximum - // number of 20 items. + // The security control ID for which a finding was generated. Security control + // IDs are the same across standards. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ComplianceSecurityControlId []StringFilter - // The result of a security check. This field is only used for findings generated - // from controls. Array Members: Minimum number of 1 item. Maximum number of 20 - // items. + // The result of a security check. This field is only used for findings generated + // from controls. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ComplianceStatus []StringFilter // The likelihood that a finding accurately identifies the behavior or issue that @@ -395,234 +429,304 @@ type AutomationRulesFindingFilters struct { // ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means // 100 percent confidence. For example, a data exfiltration detection based on a // statistical deviation of network traffic has low confidence because an actual - // exfiltration hasn't been verified. For more information, see Confidence (https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence) - // in the Security Hub User Guide. Array Members: Minimum number of 1 item. Maximum - // number of 20 items. + // exfiltration hasn't been verified. For more information, see [Confidence]in the Security + // Hub User Guide. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. + // + // [Confidence]: https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-confidence Confidence []NumberFilter - // A timestamp that indicates when this finding record was created. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // A timestamp that indicates when this finding record was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. CreatedAt []DateFilter - // The level of importance that is assigned to the resources that are associated + // The level of importance that is assigned to the resources that are associated // with a finding. Criticality is scored on a 0–100 basis, using a ratio scale // that supports only full integers. A score of 0 means that the underlying // resources have no criticality, and a score of 100 is reserved for the most - // critical resources. For more information, see Criticality (https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality) - // in the Security Hub User Guide. Array Members: Minimum number of 1 item. Maximum - // number of 20 items. + // critical resources. For more information, see [Criticality]in the Security Hub User Guide. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. + // + // [Criticality]: https://docs.aws.amazon.com/securityhub/latest/userguide/asff-top-level-attributes.html#asff-criticality Criticality []NumberFilter - // A finding's description. Array Members: Minimum number of 1 item. Maximum - // number of 20 items. + // A finding's description. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. Description []StringFilter - // A timestamp that indicates when the potential security issue captured by a - // finding was first observed by the security findings product. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that indicates when the potential security issue captured by a + // finding was first observed by the security findings product. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. FirstObservedAt []DateFilter - // The identifier for the solution-specific component that generated a finding. + // The identifier for the solution-specific component that generated a finding. + // // Array Members: Minimum number of 1 item. Maximum number of 100 items. GeneratorId []StringFilter - // The product-specific identifier for a finding. Array Members: Minimum number of - // 1 item. Maximum number of 20 items. + // The product-specific identifier for a finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. Id []StringFilter - // A timestamp that indicates when the potential security issue captured by a - // finding was most recently observed by the security findings product. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // A timestamp that indicates when the potential security issue captured by a + // finding was most recently observed by the security findings product. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. LastObservedAt []DateFilter - // The text of a user-defined note that's added to a finding. Array Members: - // Minimum number of 1 item. Maximum number of 20 items. + // The text of a user-defined note that's added to a finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. NoteText []StringFilter - // The timestamp of when the note was updated. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The timestamp of when the note was updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. NoteUpdatedAt []DateFilter - // The principal that created a note. Array Members: Minimum number of 1 item. - // Maximum number of 20 items. + // The principal that created a note. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. NoteUpdatedBy []StringFilter - // The Amazon Resource Name (ARN) for a third-party product that generated a - // finding in Security Hub. Array Members: Minimum number of 1 item. Maximum number - // of 20 items. + // The Amazon Resource Name (ARN) for a third-party product that generated a + // finding in Security Hub. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ProductArn []StringFilter - // Provides the name of the product that generated the finding. For control-based - // findings, the product name is Security Hub. Array Members: Minimum number of 1 - // item. Maximum number of 20 items. + // Provides the name of the product that generated the finding. For control-based + // findings, the product name is Security Hub. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ProductName []StringFilter - // Provides the current state of a finding. Array Members: Minimum number of 1 - // item. Maximum number of 20 items. + // Provides the current state of a finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. RecordState []StringFilter - // The product-generated identifier for a related finding. Array Members: Minimum - // number of 1 item. Maximum number of 20 items. + // The product-generated identifier for a related finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. RelatedFindingsId []StringFilter - // The ARN for the product that generated a related finding. Array Members: - // Minimum number of 1 item. Maximum number of 20 items. + // The ARN for the product that generated a related finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. RelatedFindingsProductArn []StringFilter - // The Amazon Resource Name (ARN) of the application that is related to a finding. + // The Amazon Resource Name (ARN) of the application that is related to a + // finding. + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourceApplicationArn []StringFilter - // The name of the application that is related to a finding. Array Members: - // Minimum number of 1 item. Maximum number of 20 items. + // The name of the application that is related to a finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourceApplicationName []StringFilter - // Custom fields and values about the resource that a finding pertains to. Array - // Members: Minimum number of 1 item. Maximum number of 20 items. + // Custom fields and values about the resource that a finding pertains to. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourceDetailsOther []MapFilter - // The identifier for the given resource type. For Amazon Web Services resources + // The identifier for the given resource type. For Amazon Web Services resources // that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon // Web Services resources that lack ARNs, this is the identifier as defined by the // Amazon Web Service that created the resource. For non-Amazon Web Services // resources, this is a unique identifier that is associated with the resource. + // // Array Members: Minimum number of 1 item. Maximum number of 100 items. ResourceId []StringFilter - // The partition in which the resource that the finding pertains to is located. A + // The partition in which the resource that the finding pertains to is located. A // partition is a group of Amazon Web Services Regions. Each Amazon Web Services - // account is scoped to one partition. Array Members: Minimum number of 1 item. - // Maximum number of 20 items. + // account is scoped to one partition. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourcePartition []StringFilter - // The Amazon Web Services Region where the resource that a finding pertains to is - // located. Array Members: Minimum number of 1 item. Maximum number of 20 items. + // The Amazon Web Services Region where the resource that a finding pertains to + // is located. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourceRegion []StringFilter - // A list of Amazon Web Services tags associated with a resource at the time the - // finding was processed. Array Members: Minimum number of 1 item. Maximum number - // of 20 items. + // A list of Amazon Web Services tags associated with a resource at the time the + // finding was processed. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourceTags []MapFilter - // The type of resource that the finding pertains to. Array Members: Minimum - // number of 1 item. Maximum number of 20 items. + // The type of resource that the finding pertains to. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. ResourceType []StringFilter - // The severity value of the finding. Array Members: Minimum number of 1 item. - // Maximum number of 20 items. + // The severity value of the finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. SeverityLabel []StringFilter - // Provides a URL that links to a page about the current finding in the finding - // product. Array Members: Minimum number of 1 item. Maximum number of 20 items. + // Provides a URL that links to a page about the current finding in the finding + // product. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. SourceUrl []StringFilter - // A finding's title. Array Members: Minimum number of 1 item. Maximum number of - // 100 items. + // A finding's title. + // + // Array Members: Minimum number of 1 item. Maximum number of 100 items. Title []StringFilter - // One or more finding types in the format of namespace/category/classifier that - // classify a finding. For a list of namespaces, classifiers, and categories, see - // Types taxonomy for ASFF (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html) - // in the Security Hub User Guide. Array Members: Minimum number of 1 item. Maximum - // number of 20 items. + // One or more finding types in the format of namespace/category/classifier that + // classify a finding. For a list of namespaces, classifiers, and categories, see [Types taxonomy for ASFF] + // in the Security Hub User Guide. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. + // + // [Types taxonomy for ASFF]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format-type-taxonomy.html Type []StringFilter - // A timestamp that indicates when the finding record was most recently updated. + // A timestamp that indicates when the finding record was most recently updated. + // // This field accepts only the specified formats. Timestamps can end with Z or // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. UpdatedAt []DateFilter - // A list of user-defined name and value string pairs added to a finding. Array - // Members: Minimum number of 1 item. Maximum number of 20 items. + // A list of user-defined name and value string pairs added to a finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. UserDefinedFields []MapFilter - // Provides the veracity of a finding. Array Members: Minimum number of 1 item. - // Maximum number of 20 items. + // Provides the veracity of a finding. + // + // Array Members: Minimum number of 1 item. Maximum number of 20 items. VerificationState []StringFilter - // Provides information about the status of the investigation into a finding. + // Provides information about the status of the investigation into a finding. + // // Array Members: Minimum number of 1 item. Maximum number of 20 items. WorkflowStatus []StringFilter noSmithyDocumentSerde } -// Metadata for automation rules in the calling account. The response includes +// Metadata for automation rules in the calling account. The response includes +// // rules with a RuleStatus of ENABLED and DISABLED . type AutomationRulesMetadata struct { - // A timestamp that indicates when the rule was created. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that indicates when the rule was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedAt *time.Time - // The principal that created a rule. + // The principal that created a rule. CreatedBy *string - // A description of the rule. + // A description of the rule. Description *string // Specifies whether a rule is the last to be applied with respect to a finding @@ -633,10 +737,10 @@ type AutomationRulesMetadata struct { // rule isn't terminal. IsTerminal *bool - // The Amazon Resource Name (ARN) for the rule. + // The Amazon Resource Name (ARN) for the rule. RuleArn *string - // The name of the rule. + // The name of the rule. RuleName *string // An integer ranging from 1 to 1000 that represents the order in which the rule @@ -644,23 +748,29 @@ type AutomationRulesMetadata struct { // this parameter first. RuleOrder *int32 - // Whether the rule is active after it is created. If this parameter is equal to + // Whether the rule is active after it is created. If this parameter is equal to // ENABLED , Security Hub starts applying the rule to findings and finding updates // after the rule is created. To change the value of this parameter after creating - // a rule, use BatchUpdateAutomationRules (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html) - // . + // a rule, use [BatchUpdateAutomationRules]BatchUpdateAutomationRules . + // + // [BatchUpdateAutomationRules]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html RuleStatus RuleStatus - // A timestamp that indicates when the rule was most recently updated. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // A timestamp that indicates when the rule was most recently updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) UpdatedAt *time.Time @@ -680,71 +790,72 @@ type AvailabilityZone struct { noSmithyDocumentSerde } -// Provides details about an Amazon MQ message broker. A message broker allows +// Provides details about an Amazon MQ message broker. A message broker allows +// // software applications and components to communicate using various programming // languages, operating systems, and formal messaging protocols. type AwsAmazonMqBrokerDetails struct { - // The authentication strategy used to secure the broker. The default is SIMPLE . + // The authentication strategy used to secure the broker. The default is SIMPLE . AuthenticationStrategy *string - // Whether automatically upgrade new minor versions for brokers, as new versions + // Whether automatically upgrade new minor versions for brokers, as new versions // are released and supported by Amazon MQ. Automatic upgrades occur during the // scheduled maintenance window of the broker or after a manual broker reboot. AutoMinorVersionUpgrade *bool - // The Amazon Resource Name (ARN) of the broker. + // The Amazon Resource Name (ARN) of the broker. BrokerArn *string - // The unique ID that Amazon MQ generates for the broker. + // The unique ID that Amazon MQ generates for the broker. BrokerId *string // The broker's name. BrokerName *string - // The broker's deployment mode. + // The broker's deployment mode. DeploymentMode *string - // Encryption options for the broker. Doesn’t apply to RabbitMQ brokers. + // Encryption options for the broker. Doesn’t apply to RabbitMQ brokers. EncryptionOptions *AwsAmazonMqBrokerEncryptionOptionsDetails - // The type of broker engine. + // The type of broker engine. EngineType *string - // The version of the broker engine. + // The version of the broker engine. EngineVersion *string - // The broker's instance type. + // The broker's instance type. HostInstanceType *string - // The metadata of the Lightweight Directory Access Protocol (LDAP) server used to - // authenticate and authorize connections to the broker. This is an optional + // The metadata of the Lightweight Directory Access Protocol (LDAP) server used + // to authenticate and authorize connections to the broker. This is an optional // failover server. LdapServerMetadata *AwsAmazonMqBrokerLdapServerMetadataDetails - // Turns on Amazon CloudWatch logging for brokers. + // Turns on Amazon CloudWatch logging for brokers. Logs *AwsAmazonMqBrokerLogsDetails - // The scheduled time period (UTC) during which Amazon MQ begins to apply pending + // The scheduled time period (UTC) during which Amazon MQ begins to apply pending // updates or patches to the broker. MaintenanceWindowStartTime *AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails - // Permits connections from applications outside of the VPC that hosts the + // Permits connections from applications outside of the VPC that hosts the // broker's subnets. PubliclyAccessible *bool - // The list of rules (one minimum, 125 maximum) that authorize connections to + // The list of rules (one minimum, 125 maximum) that authorize connections to // brokers. SecurityGroups []string - // The broker's storage type. + // The broker's storage type. StorageType *string - // The list of groups that define which subnets and IP ranges the broker can use + // The list of groups that define which subnets and IP ranges the broker can use // from different Availability Zones. SubnetIds []string - // The list of all broker usernames for the specified broker. Doesn't apply to + // The list of all broker usernames for the specified broker. Doesn't apply to // RabbitMQ brokers. Users []AwsAmazonMqBrokerUsersDetails @@ -754,57 +865,58 @@ type AwsAmazonMqBrokerDetails struct { // Provides details about broker encryption options. type AwsAmazonMqBrokerEncryptionOptionsDetails struct { - // The KMS key that’s used to encrypt your data at rest. If not provided, Amazon + // The KMS key that’s used to encrypt your data at rest. If not provided, Amazon // MQ will use a default KMS key to encrypt your data. KmsKeyId *string - // Specifies that an KMS key should be used for at-rest encryption. Set to true by - // default if no value is provided (for example, for RabbitMQ brokers). + // Specifies that an KMS key should be used for at-rest encryption. Set to true + // by default if no value is provided (for example, for RabbitMQ brokers). UseAwsOwnedKey *bool noSmithyDocumentSerde } -// The metadata of the Lightweight Directory Access Protocol (LDAP) server used to -// authenticate and authorize connections to the broker. This is an optional +// The metadata of the Lightweight Directory Access Protocol (LDAP) server used +// +// to authenticate and authorize connections to the broker. This is an optional // failover server. type AwsAmazonMqBrokerLdapServerMetadataDetails struct { - // Specifies the location of the LDAP server, such as Amazon Web Services + // Specifies the location of the LDAP server, such as Amazon Web Services // Directory Service for Microsoft Active Directory. Hosts []string - // The distinguished name of the node in the directory information tree (DIT) to + // The distinguished name of the node in the directory information tree (DIT) to // search for roles or groups. RoleBase *string - // The group name attribute in a role entry whose value is the name of that role. + // The group name attribute in a role entry whose value is the name of that role. RoleName *string - // The LDAP search filter used to find roles within the roleBase . + // The LDAP search filter used to find roles within the roleBase . RoleSearchMatching *string - // The directory search scope for the role. If set to true , the scope is to search - // the entire subtree. + // The directory search scope for the role. If set to true , the scope is to + // search the entire subtree. RoleSearchSubtree *bool - // A username for the service account, which is an account in your LDAP server + // A username for the service account, which is an account in your LDAP server // that has access to initiate a connection. ServiceAccountUsername *string - // Selects a particular subtree of the directory information tree (DIT) to search + // Selects a particular subtree of the directory information tree (DIT) to search // for user entries. UserBase *string - // The name of the LDAP attribute in the user's directory entry for the user's + // The name of the LDAP attribute in the user's directory entry for the user's // group membership. UserRoleName *string - // The LDAP search filter used to find users within the userBase . + // The LDAP search filter used to find users within the userBase . UserSearchMatching *string - // The directory search scope for the user. If set to true, the scope is to search - // the entire subtree. + // The directory search scope for the user. If set to true, the scope is to + // search the entire subtree. UserSearchSubtree *bool noSmithyDocumentSerde @@ -813,20 +925,20 @@ type AwsAmazonMqBrokerLdapServerMetadataDetails struct { // Provides information about logs to be activated for the specified broker. type AwsAmazonMqBrokerLogsDetails struct { - // Activates audit logging. Every user management action made using JMX or the + // Activates audit logging. Every user management action made using JMX or the // ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers. Audit *bool - // The location of the CloudWatch Logs log group where audit logs are sent. + // The location of the CloudWatch Logs log group where audit logs are sent. AuditLogGroup *string - // Activates general logging. + // Activates general logging. General *bool - // The location of the CloudWatch Logs log group where general logs are sent. + // The location of the CloudWatch Logs log group where general logs are sent. GeneralLogGroup *string - // The list of information about logs that are to be turned on for the specified + // The list of information about logs that are to be turned on for the specified // broker. Pending *AwsAmazonMqBrokerLogsPendingDetails @@ -836,41 +948,43 @@ type AwsAmazonMqBrokerLogsDetails struct { // Provides information about logs to be activated for the specified broker. type AwsAmazonMqBrokerLogsPendingDetails struct { - // Activates audit logging. Every user management action made using JMX or the + // Activates audit logging. Every user management action made using JMX or the // ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers. Audit *bool - // Activates general logging. + // Activates general logging. General *bool noSmithyDocumentSerde } -// The scheduled time period (UTC) during which Amazon MQ begins to apply pending +// The scheduled time period (UTC) during which Amazon MQ begins to apply pending +// // updates or patches to the broker. type AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails struct { - // The day of the week on which the maintenance window falls. + // The day of the week on which the maintenance window falls. DayOfWeek *string - // The time, in 24-hour format, on which the maintenance window falls. + // The time, in 24-hour format, on which the maintenance window falls. TimeOfDay *string - // The time zone in either the Country/City format or the UTC offset format. UTC + // The time zone in either the Country/City format or the UTC offset format. UTC // is the default format. TimeZone *string noSmithyDocumentSerde } -// Provides details about the broker usernames for the specified broker. Doesn't +// Provides details about the broker usernames for the specified broker. Doesn't +// // apply to RabbitMQ brokers. type AwsAmazonMqBrokerUsersDetails struct { - // The type of change pending for the broker user. + // The type of change pending for the broker user. PendingChange *string - // The username of the broker user. + // The username of the broker user. Username *string noSmithyDocumentSerde @@ -894,30 +1008,40 @@ type AwsApiCallAction struct { // that the API call originated from. DomainDetails *AwsApiCallActionDomainDetails - // A timestamp that indicates when the API call was first observed. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // A timestamp that indicates when the API call was first observed. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) FirstSeen *string - // A timestamp that indicates when the API call was most recently observed. This - // field accepts only the specified formats. Timestamps can end with Z or ("+" / - // "-") time-hour [":" time-minute] . The time-secfrac after seconds is limited to - // a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid - // timestamp formats with examples: + // A timestamp that indicates when the API call was most recently observed. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastSeen *string @@ -965,9 +1089,10 @@ type AwsApiGatewayCanarySettings struct { PercentTraffic *float64 // Stage variables that are overridden in the canary release deployment. The - // variables include new stage variables that are introduced in the canary. Each - // variable is represented as a string-to-string map between the stage variable - // name and the variable value. + // variables include new stage variables that are introduced in the canary. + // + // Each variable is represented as a string-to-string map between the stage + // variable name and the variable value. StageVariableOverrides map[string]string // Indicates whether the canary deployment uses the stage cache. @@ -979,9 +1104,10 @@ type AwsApiGatewayCanarySettings struct { // Contains information about the endpoints for the API. 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 . + // 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 . Types []string noSmithyDocumentSerde @@ -1010,10 +1136,14 @@ 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. @@ -1023,10 +1153,13 @@ type AwsApiGatewayMethodSettings struct { RequireAuthorizationForCacheControl *bool // 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 - // the root path, use only a slash (/). You can use an asterisk (*) as a wildcard - // to apply method settings to multiple methods. + // initial slash must include a forward slash. + // + // For example, the path value /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 // The throttling burst limit for the method. @@ -1035,8 +1168,9 @@ type AwsApiGatewayMethodSettings struct { // The throttling rate limit for the method. ThrottlingRateLimit *float64 - // Indicates how to handle unauthorized requests for cache invalidation. Valid - // values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | + // Indicates how to handle unauthorized requests for cache invalidation. + // + // Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | // SUCCEED_WITHOUT_RESPONSE_HEADER UnauthorizedCacheControlHeaderStrategy *string @@ -1047,23 +1181,32 @@ type AwsApiGatewayMethodSettings struct { type AwsApiGatewayRestApiDetails struct { // The source of the API key for metering requests according to a usage plan. + // // HEADER indicates whether to read the API key from the X-API-Key header of a - // request. AUTHORIZER indicates whether to read the API key from the - // UsageIdentifierKey from a custom authorizer. + // request. + // + // AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey + // from a custom authorizer. ApiKeySource *string // The list of binary media types supported by the REST API. BinaryMediaTypes []string - // Indicates when the API was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the API was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedDate *string @@ -1077,8 +1220,11 @@ 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 , - // then compression is disabled. If 0, then all payloads are compressed. + // 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 // The name of the REST API. @@ -1111,15 +1257,21 @@ type AwsApiGatewayStageDetails struct { // The identifier of the client certificate for the stage. ClientCertificateId *string - // Indicates when the stage was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the stage was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedDate *string @@ -1133,16 +1285,21 @@ type AwsApiGatewayStageDetails struct { // The version of the API documentation that is associated with the stage. DocumentationVersion *string - // Indicates when the stage was most recently updated. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the stage was most recently updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastUpdatedDate *string @@ -1156,11 +1313,16 @@ type AwsApiGatewayStageDetails struct { // Indicates whether active tracing with X-Ray is enabled for the stage. TracingEnabled *bool - // 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: + // 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 -._~:/?#&=, Variables map[string]string @@ -1173,9 +1335,12 @@ type AwsApiGatewayStageDetails struct { // Contains information about a version 2 API in Amazon API Gateway. type AwsApiGatewayV2ApiDetails struct { - // The URI of the API. Uses the format .execute-api..amazonaws.com The stage name - // is typically appended to the URI to form a complete path to a deployed API - // stage. + // The URI of the API. + // + // Uses the format .execute-api..amazonaws.com + // + // The stage name is typically appended to the URI to form a complete path to a + // deployed API stage. ApiEndpoint *string // The identifier of the API. @@ -1188,15 +1353,21 @@ type AwsApiGatewayV2ApiDetails struct { // APIs. CorsConfiguration *AwsCorsConfiguration - // Indicates when the API was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the API was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedDate *string @@ -1207,12 +1378,17 @@ type AwsApiGatewayV2ApiDetails struct { // The name of the API. Name *string - // The API protocol for the API. Valid values: WEBSOCKET | HTTP + // The API protocol for the API. + // + // Valid values: WEBSOCKET | HTTP 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 - // WebSocket APIs, there is no default value. + // 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 WebSocket APIs, there is no default value. RouteSelectionExpression *string // The version identifier for the API. @@ -1233,9 +1409,13 @@ type AwsApiGatewayV2RouteSettings struct { DetailedMetricsEnabled *bool // 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. + // 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. + // // Valid values: OFF | ERROR | INFO LoggingLevel *string @@ -1264,15 +1444,21 @@ type AwsApiGatewayV2StageDetails struct { // WebSocket API calls. ClientCertificateId *string - // Indicates when the stage was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the stage was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedDate *string @@ -1290,16 +1476,21 @@ type AwsApiGatewayV2StageDetails struct { // automatic deployment enabled. LastDeploymentStatusMessage *string - // Indicates when the stage was most recently updated. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the stage was most recently updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastUpdatedDate *string @@ -1310,11 +1501,16 @@ type AwsApiGatewayV2StageDetails struct { // The name of the stage. StageName *string - // 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: + // 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 -._~:/?#&=, StageVariables map[string]string @@ -1324,37 +1520,38 @@ type AwsApiGatewayV2StageDetails struct { // A list of additional authentication providers for the GraphqlApi API. type AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails struct { - // The type of security configuration for your GraphQL API: API key, Identity and + // The type of security configuration for your GraphQL API: API key, Identity and // Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or // Lambda. AuthenticationType *string - // The configuration for Lambda function authorization. + // The configuration for Lambda function authorization. LambdaAuthorizerConfig *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails - // The OpenID Connect configuration. + // The OpenID Connect configuration. OpenIdConnectConfig *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails - // The Amazon Cognito user pools configuration. + // The Amazon Cognito user pools configuration. UserPoolConfig *AwsAppSyncGraphQlApiUserPoolConfigDetails noSmithyDocumentSerde } -// Provides details about an AppSync Graph QL API, which lets you query multiple +// Provides details about an AppSync Graph QL API, which lets you query multiple +// // databases, microservices, and APIs from a single GraphQL endpoint. type AwsAppSyncGraphQlApiDetails struct { - // A list of additional authentication providers for the GraphQL API. + // A list of additional authentication providers for the GraphQL API. AdditionalAuthenticationProviders []AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails - // The unique identifier for the API. + // The unique identifier for the API. ApiId *string - // The Amazon Resource Name (ARN) of the API. + // The Amazon Resource Name (ARN) of the API. Arn *string - // The type of security configuration for your GraphQL API: API key, Identity and + // The type of security configuration for your GraphQL API: API key, Identity and // Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or // Lambda. AuthenticationType *string @@ -1362,123 +1559,128 @@ type AwsAppSyncGraphQlApiDetails struct { // The unique identifier for the API. Id *string - // Specifies the configuration for Lambda function authorization. + // Specifies the configuration for Lambda function authorization. LambdaAuthorizerConfig *AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails - // The Amazon CloudWatch Logs configuration. + // The Amazon CloudWatch Logs configuration. LogConfig *AwsAppSyncGraphQlApiLogConfigDetails - // The API name. + // The API name. Name *string - // Specifies the authorization configuration for using an OpenID Connect compliant - // service with an AppSync GraphQL API endpoint. + // Specifies the authorization configuration for using an OpenID Connect + // compliant service with an AppSync GraphQL API endpoint. OpenIdConnectConfig *AwsAppSyncGraphQlApiOpenIdConnectConfigDetails - // The Amazon Cognito user pools configuration. + // The Amazon Cognito user pools configuration. UserPoolConfig *AwsAppSyncGraphQlApiUserPoolConfigDetails - // The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) + // The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) // associated with this GraphQL API, if one exists. WafWebAclArn *string - // Indicates whether to use X-Ray tracing for the GraphQL API. + // Indicates whether to use X-Ray tracing for the GraphQL API. XrayEnabled *bool noSmithyDocumentSerde } -// Specifies the authorization configuration for using an Lambda function with +// Specifies the authorization configuration for using an Lambda function with +// // your AppSync GraphQL API endpoint. type AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails struct { - // The number of seconds a response should be cached for. The default is 5 minutes - // (300 seconds). + // The number of seconds a response should be cached for. The default is 5 + // minutes (300 seconds). AuthorizerResultTtlInSeconds *int32 - // The Amazon Resource Name (ARN) of the Lambda function to be called for + // 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. AuthorizerUri *string - // A regular expression for validation of tokens before the Lambda function is + // A regular expression for validation of tokens before the Lambda function is // called. IdentityValidationExpression *string noSmithyDocumentSerde } -// Specifies the logging configuration when writing GraphQL operations and tracing -// to Amazon CloudWatch for an AppSync GraphQL API. +// Specifies the logging configuration when writing GraphQL operations and +// +// tracing to Amazon CloudWatch for an AppSync GraphQL API. type AwsAppSyncGraphQlApiLogConfigDetails struct { - // The Amazon Resource Name (ARN) of the service role that AppSync assumes to + // The Amazon Resource Name (ARN) of the service role that AppSync assumes to // publish to CloudWatch Logs in your account. CloudWatchLogsRoleArn *string - // Set to TRUE to exclude sections that contain information such as headers, + // Set to TRUE to exclude sections that contain information such as headers, // context, and evaluated mapping templates, regardless of logging level. ExcludeVerboseContent *bool - // The field logging level. + // The field logging level. FieldLogLevel *string noSmithyDocumentSerde } -// Specifies the authorization configuration for using an OpenID Connect compliant -// service with your AppSync GraphQL API endpoint. +// Specifies the authorization configuration for using an OpenID Connect +// +// compliant service with your AppSync GraphQL API endpoint. type AwsAppSyncGraphQlApiOpenIdConnectConfigDetails struct { - // The number of milliseconds that a token is valid after being authenticated. + // 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. + // 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. + // The number of milliseconds that a token is valid after it's issued to a user. IatTtL *int64 - // The issuer for the OIDC configuration. The issuer returned by discovery must + // The issuer for the OIDC configuration. The issuer returned by discovery must // exactly match the value of iss in the ID token. Issuer *string noSmithyDocumentSerde } -// Specifies the authorization configuration for using Amazon Cognito user pools +// Specifies the authorization configuration for using Amazon Cognito user pools +// // with your AppSync GraphQL API endpoint. type AwsAppSyncGraphQlApiUserPoolConfigDetails struct { - // A regular expression for validating the incoming Amazon Cognito user pools app + // A regular expression for validating the incoming Amazon Cognito user pools app // client ID. If this value isn't set, no filtering is applied. AppIdClientRegex *string - // The Amazon Web Services Region in which the user pool was created. + // The Amazon Web Services Region in which the user pool was created. AwsRegion *string - // The action that you want your GraphQL API to take when a request that uses + // The action that you want your GraphQL API to take when a request that uses // Amazon Cognito user pools authentication doesn't match the Amazon Cognito user // pools configuration. DefaultAction *string - // The user pool ID. + // The user pool ID. UserPoolId *string noSmithyDocumentSerde } -// The configuration of the workgroup, which includes the location in Amazon +// The configuration of the workgroup, which includes the location in Amazon +// // Simple Storage Service (Amazon S3) where query results are stored, the // encryption option, if any, used for query results, whether Amazon CloudWatch // metrics are enabled for the workgroup, and the limit for the amount of bytes // scanned (cutoff) per query, if it is specified. type AwsAthenaWorkGroupConfigurationDetails struct { - // The location in Amazon S3 where query and calculation results are stored and + // 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. @@ -1487,31 +1689,33 @@ type AwsAthenaWorkGroupConfigurationDetails struct { noSmithyDocumentSerde } -// The location in Amazon Simple Storage Service (Amazon S3) where query and +// The location in Amazon Simple Storage Service (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 AwsAthenaWorkGroupConfigurationResultConfigurationDetails struct { - // Specifies the method used to encrypt the user’s data stores in the Athena + // Specifies the method used to encrypt the user’s data stores in the Athena // workgroup. EncryptionConfiguration *AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails noSmithyDocumentSerde } -// Specifies the method used to encrypt the user’s data stores in the Athena +// Specifies the method used to encrypt the user’s data stores in the Athena +// // workgroup. type AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails struct { - // Indicates whether Amazon Simple Storage Service (Amazon S3) server-side + // Indicates whether Amazon Simple Storage Service (Amazon S3) server-side // encryption with Amazon S3 managed keys (SSE_S3), server-side encryption with KMS // keys (SSE_KMS), or client-side encryption with KMS customer managed keys // (CSE_KMS) is used. EncryptionOption *string - // For SSE_KMS and CSE_KMS , this is the KMS key Amazon Resource Name (ARN) or ID. + // For SSE_KMS and CSE_KMS , this is the KMS key Amazon Resource Name (ARN) or ID. KmsKey *string noSmithyDocumentSerde @@ -1520,20 +1724,20 @@ type AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDe // Provides information about an Amazon Athena workgroup. type AwsAthenaWorkGroupDetails struct { - // The configuration of the workgroup, which includes the location in Amazon + // The configuration of the workgroup, which includes the location in Amazon // Simple Storage Service (Amazon S3) where query results are stored, the // encryption option, if any, used for query results, whether Amazon CloudWatch // metrics are enabled for the workgroup, and the limit for the amount of bytes // scanned (cutoff) per query, if it is specified. Configuration *AwsAthenaWorkGroupConfigurationDetails - // The workgroup description. + // The workgroup description. Description *string - // The workgroup name. + // The workgroup name. Name *string - // Whether the workgroup is enabled or disabled. + // Whether the workgroup is enabled or disabled. State *string noSmithyDocumentSerde @@ -1557,16 +1761,21 @@ type AwsAutoScalingAutoScalingGroupDetails struct { // Indicates whether capacity rebalancing is enabled. CapacityRebalance *bool - // Indicates when the auto scaling group was created. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the auto scaling group was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedTime *string @@ -1644,8 +1853,11 @@ type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDeta // How to allocate instances across Spot Instance pools. Valid values are as // follows: + // // - lowest-price + // // - capacity-optimized + // // - capacity-optimized-prioritized SpotAllocationStrategy *string @@ -1714,12 +1926,14 @@ 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 @@ -1736,31 +1950,45 @@ 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 . + // The snapshot ID of the volume to use. + // + // You must specify either VolumeSize or 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. VolumeSize *int32 // The volume type. Valid values are as follows: + // // - gp2 + // // - gp3 + // // - io1 + // // - sc1 + // // - st1 + // // - standard VolumeType *string @@ -1785,16 +2013,21 @@ type AwsAutoScalingLaunchConfigurationDetails struct { // ClassicLinkVPCId . ClassicLinkVpcSecurityGroups []string - // The creation date and time for the launch configuration. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The creation date and time for the launch configuration. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedTime *string @@ -1852,8 +2085,9 @@ 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 @@ -1883,14 +2117,18 @@ 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. 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 @@ -1960,9 +2198,10 @@ type AwsBackupBackupPlanRuleCopyActionsDetails struct { // Defines when a protected resource is transitioned to cold storage and when it // expires. Backup transitions and expires backups automatically according to the // lifecycle that you define. If you do not specify a lifecycle, Backup applies the - // lifecycle policy of the source backup to the destination backup. Backups - // transitioned to cold storage must be stored in cold storage for a minimum of 90 - // days. + // lifecycle policy of the source backup to the destination backup. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Lifecycle *AwsBackupBackupPlanLifecycleDetails noSmithyDocumentSerde @@ -1987,9 +2226,10 @@ type AwsBackupBackupPlanRuleDetails struct { // Defines when a protected resource is transitioned to cold storage and when it // expires. Backup transitions and expires backups automatically according to the // lifecycle that you define. If you do not specify a lifecycle, Backup applies the - // lifecycle policy of the source backup to the destination backup. Backups - // transitioned to cold storage must be stored in cold storage for a minimum of 90 - // days. + // lifecycle policy of the source backup to the destination backup. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. Lifecycle *AwsBackupBackupPlanLifecycleDetails // Uniquely identifies a rule that is used to schedule the backup of a selection @@ -2050,9 +2290,13 @@ 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 BackupVaultEvents []string @@ -2136,7 +2380,8 @@ type AwsBackupRecoveryPointDetails struct { // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. CreationDate *string - // The ARN for the server-side encryption key that is used to protect your backups. + // The ARN for the server-side encryption key that is used to protect your + // backups. EncryptionKeyArn *string // Specifies the IAM role ARN used to create the target recovery point @@ -2174,9 +2419,13 @@ type AwsBackupRecoveryPointDetails struct { // A status code specifying the state of the recovery point. Valid values are as // follows: + // // - COMPLETED + // // - DELETING + // // - EXPIRED + // // - PARTIAL Status *string @@ -2184,8 +2433,11 @@ type AwsBackupRecoveryPointDetails struct { StatusMessage *string // Specifies the storage class of the recovery point. Valid values are as follows: + // // - COLD + // // - DELETED + // // - WARM StorageClass *string @@ -2214,16 +2466,21 @@ type AwsCertificateManagerCertificateDetails struct { // the certificate. CertificateAuthorityArn *string - // Indicates when the certificate was requested. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the certificate was requested. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedAt *string @@ -2233,8 +2490,9 @@ type AwsCertificateManagerCertificateDetails struct { 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 . + // occurs as a result of the RequestCertificate request. + // + // Only provided if the certificate type is AMAZON_ISSUED . DomainValidationOptions []AwsCertificateManagerCertificateDomainValidationOption // Contains a list of Extended Key Usage X.509 v3 extension objects. Each object @@ -2242,24 +2500,32 @@ type AwsCertificateManagerCertificateDetails struct { // consists of a name and an object identifier (OID). ExtendedKeyUsages []AwsCertificateManagerCertificateExtendedKeyUsage - // For a failed certificate request, the reason for the failure. 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 | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | - // PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER + // For a failed certificate request, the reason for the failure. + // + // 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 | PCA_RESOURCE_NOT_FOUND | + // PCA_INVALID_ARGS | 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 . This field accepts only the specified formats. Timestamps can end - // with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // is IMPORTED . + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ImportedAt *string @@ -2268,15 +2534,21 @@ type AwsCertificateManagerCertificateDetails struct { InUseBy []string // Indicates when the certificate was issued. Provided if the certificate type is - // AMAZON_ISSUED . This field accepts only the specified formats. Timestamps can - // end with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // AMAZON_ISSUED . + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) IssuedAt *string @@ -2284,38 +2556,49 @@ type AwsCertificateManagerCertificateDetails struct { // The name of the certificate authority that issued and signed the certificate. Issuer *string - // The algorithm that was used to generate the public-private key pair. Valid - // values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | + // The algorithm that was used to generate the public-private key pair. + // + // Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | // EC_secp521r1 KeyAlgorithm *string // A list of key usage X.509 v3 extension objects. KeyUsages []AwsCertificateManagerCertificateKeyUsage - // The time after which the certificate becomes invalid. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The time after which the certificate becomes invalid. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) NotAfter *string - // The time before which the certificate is not valid. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The time before which the certificate is not valid. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) NotBefore *string @@ -2324,8 +2607,9 @@ type AwsCertificateManagerCertificateDetails struct { // transparency log. Options *AwsCertificateManagerCertificateOptions - // Whether the certificate is eligible for renewal. Valid values: ELIGIBLE | - // INELIGIBLE + // Whether the certificate is eligible for renewal. + // + // Valid values: ELIGIBLE | INELIGIBLE RenewalEligibility *string // Information about the status of the Certificate Manager managed renewal for the @@ -2338,8 +2622,10 @@ type AwsCertificateManagerCertificateDetails struct { // The algorithm that was used to sign the certificate. SignatureAlgorithm *string - // The status of the certificate. Valid values: PENDING_VALIDATION | ISSUED | - // INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED + // The status of the certificate. + // + // Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | + // VALIDATION_TIMED_OUT | REVOKED | FAILED Status *string // The name of the entity that is associated with the public key contained in the @@ -2348,23 +2634,28 @@ type AwsCertificateManagerCertificateDetails struct { // 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. + // 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. 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 | - // PRIVATE + // ImportCertificate , Type is IMPORTED . + // + // Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE Type *string noSmithyDocumentSerde } // 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 type AwsCertificateManagerCertificateDomainValidationOption struct { @@ -2398,8 +2689,9 @@ type AwsCertificateManagerCertificateExtendedKeyUsage struct { // public key can be used. Name *string - // An object identifier (OID) for the extension value. The format is numbers - // separated by periods. + // An object identifier (OID) for the extension value. + // + // The format is numbers separated by periods. OId *string noSmithyDocumentSerde @@ -2417,8 +2709,9 @@ type AwsCertificateManagerCertificateKeyUsage struct { // Contains other options for the certificate. type AwsCertificateManagerCertificateOptions struct { - // Whether to add the certificate to a transparency log. Valid values: DISABLED | - // ENABLED + // Whether to add the certificate to a transparency log. + // + // Valid values: DISABLED | ENABLED CertificateTransparencyLoggingPreference *string noSmithyDocumentSerde @@ -2433,29 +2726,37 @@ type AwsCertificateManagerCertificateRenewalSummary struct { // certificate type is AMAZON_ISSUED . DomainValidationOptions []AwsCertificateManagerCertificateDomainValidationOption - // The status of the Certificate Manager managed renewal of the certificate. Valid - // values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED + // The status of the Certificate Manager managed renewal of the certificate. + // + // Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED RenewalStatus *string // The reason that a renewal request was unsuccessful. This attribute is used only - // 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 | - // PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | - // PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER + // 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 | PCA_RESOURCE_NOT_FOUND | + // PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | + // OTHER RenewalStatusReason *string - // Indicates when the renewal summary was last updated. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the renewal summary was last updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) UpdatedAt *string @@ -2567,10 +2868,13 @@ 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). ViewerProtocolPolicy *string @@ -2593,10 +2897,13 @@ 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). ViewerProtocolPolicy *string @@ -2625,16 +2932,21 @@ type AwsCloudFrontDistributionDetails struct { // The entity tag is a hash of the object. ETag *string - // Indicates when that the distribution was last modified. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when that the distribution was last modified. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastModifiedTime *string @@ -2684,9 +2996,9 @@ type AwsCloudFrontDistributionLogging struct { } // A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, -// with one exception. An Amazon S3 bucket that is configured with static website -// hosting (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) is -// a custom origin. +// with one exception. An Amazon S3 bucket that is [configured with static website hosting]is a custom origin. +// +// [configured with static website hosting]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html type AwsCloudFrontDistributionOriginCustomOriginConfig struct { // The HTTP port that CloudFront uses to connect to the origin. @@ -2703,7 +3015,8 @@ type AwsCloudFrontDistributionOriginCustomOriginConfig struct { // origin. OriginProtocolPolicy *string - // Specifies how long, in seconds, CloudFront waits for a response from the origin. + // Specifies how long, in seconds, CloudFront waits for a response from the + // origin. OriginReadTimeout *int32 // Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to @@ -2979,8 +3292,11 @@ 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 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 @@ -3057,9 +3373,10 @@ type AwsCodeBuildProjectDetails struct { // Information about the build artifacts for the CodeBuild project. Artifacts []AwsCodeBuildProjectArtifactsDetails - // The KMS key used to encrypt the build output artifacts. You can specify either - // the ARN of the KMS key or, if available, the KMS key alias (using the format - // alias/alias-name). + // The KMS key used to encrypt the build output artifacts. + // + // You can specify either the ARN of the KMS key or, if available, the KMS key + // alias (using the format alias/alias-name). EncryptionKey *string // Information about the build environment for this build project. @@ -3097,13 +3414,16 @@ type AwsCodeBuildProjectEnvironment struct { // project. EnvironmentVariables []AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails - // The type of credentials CodeBuild uses to pull images in your build. Valid - // values: + // 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. + // + // - 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. @@ -3116,20 +3436,25 @@ type AwsCodeBuildProjectEnvironment struct { // The credentials for access to a private registry. RegistryCredential *AwsCodeBuildProjectEnvironmentRegistryCredential - // 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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific - // (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt). The environment type - // LINUX_CONTAINER with compute type build.general1.2xlarge is available only in - // Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada - // (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific - // (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), - // China (Beijing), and China (Ningxia). The environment type LINUX_GPU_CONTAINER + // 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), Europe (Ireland), Asia Pacific + // (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt). + // + // The environment type LINUX_CONTAINER with compute type build.general1.2xlarge // is available only in Regions US East (N. Virginia), US East (N. Virginia), US // West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe // (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific - // (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). Valid - // values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | + // (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 (N. Virginia), US West (Oregon), Canada (Central), Europe + // (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia + // Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China + // (Beijing), and China (Ningxia). + // + // Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | // ARM_CONTAINER Type *string @@ -3155,12 +3480,14 @@ 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. CredentialProvider *string @@ -3218,35 +3545,50 @@ type AwsCodeBuildProjectSource struct { // Whether to ignore SSL warnings while connecting to the project source code. InsecureSsl *bool - // Information about the location of the source code to be built. Valid values - // include: + // 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. 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. Type *string @@ -3293,114 +3635,116 @@ type AwsCorsConfiguration struct { noSmithyDocumentSerde } -// Provides details about an Database Migration Service (DMS) endpoint. An +// Provides details about an Database Migration Service (DMS) endpoint. An +// // endpoint provides connection, data store type, and location information about // your data store. type AwsDmsEndpointDetails struct { - // The Amazon Resource Name (ARN) for the SSL certificate that encrypts + // The Amazon Resource Name (ARN) for the SSL certificate that encrypts // connections between the DMS endpoint and the replication instance. CertificateArn *string - // The name of the endpoint database. + // The name of the endpoint database. DatabaseName *string - // The Amazon Resource Name (ARN) of the endpoint. + // The Amazon Resource Name (ARN) of the endpoint. EndpointArn *string - // The database endpoint identifier. + // The database endpoint identifier. EndpointIdentifier *string - // The type of endpoint. Valid values are source and target. + // The type of endpoint. Valid values are source and target. EndpointType *string - // The type of engine for the endpoint, depending on the EndpointType value. + // The type of engine for the endpoint, depending on the EndpointType value. EngineName *string - // A value that can be used for cross-account validation. + // A value that can be used for cross-account validation. ExternalId *string - // Additional attributes associated with the connection. + // Additional attributes associated with the connection. ExtraConnectionAttributes *string - // An DMS 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 + // An DMS 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. KmsKeyId *string - // The port used to access the endpoint. + // The port used to access the endpoint. Port *int32 - // The name of the server where the endpoint database resides. + // The name of the server where the endpoint database resides. ServerName *string - // The SSL mode used to connect to the endpoint. The default is none. + // The SSL mode used to connect to the endpoint. The default is none. SslMode *string - // The user name to be used to log in to the endpoint database. + // The user name to be used to log in to the endpoint database. Username *string noSmithyDocumentSerde } -// Provides details about an Database Migration Service (DMS) replication +// Provides details about an Database Migration Service (DMS) replication +// // instance. DMS uses a replication instance to connect to your source data store, // read the source data, and format the data for consumption by the target data // store. type AwsDmsReplicationInstanceDetails struct { - // The amount of storage (in gigabytes) that is allocated for the replication + // The amount of storage (in gigabytes) that is allocated for the replication // instance. AllocatedStorage *int32 - // Indicates whether minor engine upgrades are applied automatically to the + // Indicates whether minor engine upgrades are applied automatically to the // replication instance during the maintenance window. AutoMinorVersionUpgrade *bool - // The Availability Zone that the replication instance is created in. The default + // The Availability Zone that the replication instance is created in. The default // value is a random, system-chosen Availability Zone in the endpoint's Amazon Web // Services Region, such as us-east-1d . AvailabilityZone *string - // The engine version number of the replication instance. If an engine version + // 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. EngineVersion *string - // An KMS key identifier that is used to encrypt the data on the replication + // 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, 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 deployed across multiple + // Specifies whether the replication instance is deployed across multiple // Availability Zones (AZs). You can't set the AvailabilityZone parameter if the // MultiAZ parameter is set to true . MultiAZ *bool - // The maintenance window times for the replication instance. Upgrades to the + // The maintenance window times for the replication instance. Upgrades to the // replication instance are performed during this time. PreferredMaintenanceWindow *string - // Specifies the accessibility options for the replication instance. A value of + // 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 . PubliclyAccessible *bool - // The compute and memory capacity of the replication instance as defined for the + // The compute and memory capacity of the replication instance as defined for the // specified replication instance class. ReplicationInstanceClass *string - // The replication instance identifier. + // The replication instance identifier. ReplicationInstanceIdentifier *string - // The subnet group for the replication instance. + // The subnet group for the replication instance. ReplicationSubnetGroup *AwsDmsReplicationInstanceReplicationSubnetGroupDetails - // The virtual private cloud (VPC) security group for the replication instance. + // The virtual private cloud (VPC) security group for the replication instance. VpcSecurityGroups []AwsDmsReplicationInstanceVpcSecurityGroupsDetails noSmithyDocumentSerde @@ -3409,73 +3753,75 @@ type AwsDmsReplicationInstanceDetails struct { // Provides details about the replication subnet group. type AwsDmsReplicationInstanceReplicationSubnetGroupDetails struct { - // The identifier of the replication subnet group. + // The identifier of the replication subnet group. ReplicationSubnetGroupIdentifier *string noSmithyDocumentSerde } -// Provides details about the virtual private cloud (VPC) security group that’s +// Provides details about the virtual private cloud (VPC) security group that’s +// // associated with the replication instance. type AwsDmsReplicationInstanceVpcSecurityGroupsDetails struct { - // The identifier of the VPC security group that’s associated with the replication - // instance. + // The identifier of the VPC security group that’s associated with the + // replication instance. VpcSecurityGroupId *string noSmithyDocumentSerde } -// Provides details about an Database Migration Service (DMS) replication task. A +// Provides details about an Database Migration Service (DMS) replication task. A +// // replication task moves a set of data from the source endpoint to the target // endpoint. type AwsDmsReplicationTaskDetails struct { - // Indicates when you want a change data capture (CDC) operation to start. + // Indicates when you want a change data capture (CDC) operation to start. // CCdcStartPosition or CCdcStartTime specifies when you want a CDC operation to // start. Only a value for one of these fields is included. CdcStartPosition *string - // Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime + // Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime // specifies when you want a CDC operation to start. Only a value for one of these // fields is included. CdcStartTime *string - // Indicates when you want a CDC operation to stop. The value can be either server - // time or commit time. + // Indicates when you want a CDC operation to stop. The value can be either + // server time or commit time. CdcStopPosition *string - // The identifier of the replication task. + // The identifier of the replication task. Id *string - // The migration type. + // The migration type. MigrationType *string - // The Amazon Resource Name (ARN) of a replication instance. + // The Amazon Resource Name (ARN) of a replication instance. ReplicationInstanceArn *string - // The user-defined replication task identifier or name. + // The user-defined replication task identifier or name. ReplicationTaskIdentifier *string - // The settings for the replication task. + // The settings for the replication task. ReplicationTaskSettings *string - // A display name for the resource identifier at the end of the EndpointArn + // A display name for the resource identifier at the end of the EndpointArn // response parameter. If you don't specify a ResourceIdentifier value, DMS // generates a default identifier value for the end of EndpointArn . ResourceIdentifier *string - // The ARN of the source endpoint. + // The ARN of the source endpoint. SourceEndpointArn *string - // The table mappings for the replication task, in JSON format. + // The table mappings for the replication task, in JSON format. TableMappings *string - // The ARN of the target endpoint. + // The ARN of the target endpoint. TargetEndpointArn *string - // Supplemental information that the task requires to migrate the data for certain - // source and target endpoints. + // Supplemental information that the task requires to migrate the data for + // certain source and target endpoints. TaskData *string noSmithyDocumentSerde @@ -3500,15 +3846,21 @@ type AwsDynamoDbTableBillingModeSummary struct { BillingMode *string // If the billing mode is PAY_PER_REQUEST , indicates when the billing mode was set - // to that value. This field accepts only the specified formats. Timestamps can end - // with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // to that value. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastUpdateToPayPerRequestDateTime *string @@ -3525,20 +3877,26 @@ type AwsDynamoDbTableDetails struct { // Information about the billing for read/write capacity on the table. BillingModeSummary *AwsDynamoDbTableBillingModeSummary - // Indicates when the table was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the table was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreationDateTime *string - // Indicates whether deletion protection is to be enabled (true) or disabled + // Indicates whether deletion protection is to be enabled (true) or disabled // (false) on the table. DeletionProtectionEnabled *bool @@ -3588,12 +3946,19 @@ 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 TableStatus *string @@ -3616,9 +3981,13 @@ type AwsDynamoDbTableGlobalSecondaryIndex struct { IndexSizeBytes *int64 // The current status of the index. + // // - ACTIVE + // // - CREATING + // // - DELETING + // // - UPDATING IndexStatus *string @@ -3681,8 +4050,11 @@ type AwsDynamoDbTableProjection struct { // The types of attributes that are projected into the index. Valid values are as // follows: + // // - ALL + // // - INCLUDE + // // - KEYS_ONLY ProjectionType *string @@ -3693,30 +4065,40 @@ type AwsDynamoDbTableProjection struct { // secondary index. type AwsDynamoDbTableProvisionedThroughput struct { - // Indicates when the provisioned throughput was last decreased. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // Indicates when the provisioned throughput was last decreased. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastDecreaseDateTime *string - // Indicates when the provisioned throughput was last increased. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // Indicates when the provisioned throughput was last increased. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastIncreaseDateTime *string @@ -3762,10 +4144,15 @@ type AwsDynamoDbTableReplica struct { RegionName *string // The current status of the replica. Valid values are as follows: + // // - ACTIVE + // // - CREATING + // // - CREATION_FAILED + // // - DELETING + // // - UPDATING ReplicaStatus *string @@ -3790,16 +4177,21 @@ type AwsDynamoDbTableReplicaGlobalSecondaryIndex struct { // Information about the restore for the table. type AwsDynamoDbTableRestoreSummary struct { - // Indicates the point in time that the table was restored to. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates the point in time that the table was restored to. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) RestoreDateTime *string @@ -3820,15 +4212,21 @@ type AwsDynamoDbTableRestoreSummary struct { type AwsDynamoDbTableSseDescription struct { // If the key is inaccessible, the date and time when DynamoDB detected that the - // key was inaccessible. This field accepts only the specified formats. Timestamps - // can end with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac - // after seconds is limited to a maximum of 9 digits. The offset is bounded by - // +/-18:00. Here are valid timestamp formats with examples: + // key was inaccessible. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) InaccessibleEncryptionDateTime *string @@ -3857,11 +4255,12 @@ type AwsDynamoDbTableStreamSpecification struct { noSmithyDocumentSerde } -// Provides details about an Active Directory that’s used to authenticate an +// Provides details about an Active Directory that’s used to authenticate an +// // Client VPN endpoint. type AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails struct { - // The ID of the Active Directory used for authentication. + // The ID of the Active Directory used for authentication. DirectoryId *string noSmithyDocumentSerde @@ -3870,18 +4269,18 @@ type AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails struct { // Information about the authentication method used by the Client VPN endpoint. type AwsEc2ClientVpnEndpointAuthenticationOptionsDetails struct { - // Information about the Active Directory, if applicable. With Active Directory + // Information about the Active Directory, if applicable. With Active Directory // authentication, clients are authenticated against existing Active Directory // groups. ActiveDirectory *AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails - // Information about the IAM SAML identity provider, if applicable. + // Information about the IAM SAML identity provider, if applicable. FederatedAuthentication *AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails - // Information about the authentication certificates, if applicable. + // Information about the authentication certificates, if applicable. MutualAuthentication *AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails - // The authentication type used. + // The authentication type used. Type *string noSmithyDocumentSerde @@ -3890,10 +4289,10 @@ type AwsEc2ClientVpnEndpointAuthenticationOptionsDetails struct { // Describes the IAM SAML identity providers used for federated authentication. type AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails struct { - // The Amazon Resource Name (ARN) of the IAM SAML identity provider. + // The Amazon Resource Name (ARN) of the IAM SAML identity provider. SamlProviderArn *string - // The Amazon Resource Name (ARN) of the IAM SAML identity provider for the + // The Amazon Resource Name (ARN) of the IAM SAML identity provider for the // self-service portal. SelfServiceSamlProviderArn *string @@ -3903,7 +4302,7 @@ type AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails // Information about the client certificate used for authentication. type AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails struct { - // The Amazon Resource Name (ARN) of the client certificate. + // The Amazon Resource Name (ARN) of the client certificate. ClientRootCertificateChain *string noSmithyDocumentSerde @@ -3912,14 +4311,14 @@ type AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails str // The options for managing connection authorization for new client connections. type AwsEc2ClientVpnEndpointClientConnectOptionsDetails struct { - // Indicates whether client connect options are enabled. + // Indicates whether client connect options are enabled. Enabled *bool - // The Amazon Resource Name (ARN) of the Lambda function used for connection + // The Amazon Resource Name (ARN) of the Lambda function used for connection // authorization. LambdaFunctionArn *string - // The status of any updates to the client connect options. + // The status of any updates to the client connect options. Status *AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails noSmithyDocumentSerde @@ -3928,102 +4327,105 @@ type AwsEc2ClientVpnEndpointClientConnectOptionsDetails struct { // Describes the status of the Client VPN endpoint attribute. type AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails struct { - // The status code. + // The status code. Code *string - // The status message. + // The status message. Message *string noSmithyDocumentSerde } -// Options for enabling a customizable text banner that will be displayed on +// Options for enabling a customizable text banner that will be displayed on +// // Amazon Web Services provided clients when a VPN session is established. type AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails struct { - // Customizable text that will be displayed in a banner on Amazon Web Services + // Customizable text that will be displayed in a banner on Amazon Web Services // provided clients when a VPN session is established. BannerText *string - // Current state of text banner feature. + // Current state of text banner feature. Enabled *bool noSmithyDocumentSerde } -// Information about the client connection logging options for the Client VPN +// Information about the client connection logging options for the Client VPN +// // endpoint. type AwsEc2ClientVpnEndpointConnectionLogOptionsDetails struct { - // The name of the Amazon CloudWatch Logs log group to which connection logging + // The name of the Amazon CloudWatch Logs log group to which connection logging // data is published. CloudwatchLogGroup *string - // The name of the Amazon CloudWatch Logs log stream to which connection logging + // The name of the Amazon CloudWatch Logs log stream to which connection logging // data is published. CloudwatchLogStream *string - // Indicates whether client connection logging is enabled for the Client VPN + // Indicates whether client connection logging is enabled for the Client VPN // endpoint. Enabled *bool noSmithyDocumentSerde } -// Describes an Client VPN endpoint. A Client VPN endpoint is the resource that +// Describes an Client VPN endpoint. A Client VPN endpoint is the resource that +// // you create and configure to enable and manage client VPN sessions. It's the // termination point for all client VPN sessions. type AwsEc2ClientVpnEndpointDetails struct { - // Information about the authentication method used by the Client VPN endpoint. + // Information about the authentication method used by the Client VPN endpoint. AuthenticationOptions []AwsEc2ClientVpnEndpointAuthenticationOptionsDetails - // The IPv4 address range, in CIDR notation, from which client IP addresses are + // The IPv4 address range, in CIDR notation, from which client IP addresses are // assigned. ClientCidrBlock *string - // The options for managing connection authorization for new client connections. + // The options for managing connection authorization for new client connections. ClientConnectOptions *AwsEc2ClientVpnEndpointClientConnectOptionsDetails - // Options for enabling a customizable text banner that will be displayed on + // Options for enabling a customizable text banner that will be displayed on // Amazon Web Services provided clients when a VPN session is established. ClientLoginBannerOptions *AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails - // The ID of the Client VPN endpoint. + // The ID of the Client VPN endpoint. ClientVpnEndpointId *string - // Information about the client connection logging options for the Client VPN + // Information about the client connection logging options for the Client VPN // endpoint. ConnectionLogOptions *AwsEc2ClientVpnEndpointConnectionLogOptionsDetails - // A brief description of the endpoint. + // A brief description of the endpoint. Description *string - // Information about the DNS servers to be used for DNS resolution. + // Information about the DNS servers to be used for DNS resolution. DnsServer []string - // The IDs of the security groups for the target network. + // The IDs of the security groups for the target network. SecurityGroupIdSet []string - // The URL of the self-service portal. + // The URL of the self-service portal. SelfServicePortalUrl *string - // The Amazon Resource Name (ARN) of the server certificate. + // The Amazon Resource Name (ARN) of the server certificate. ServerCertificateArn *string - // The maximum VPN session duration time in hours. + // The maximum VPN session duration time in hours. SessionTimeoutHours *int32 - // Indicates whether split-tunnel is enabled in the Client VPN endpoint. + // Indicates whether split-tunnel is enabled in the Client VPN endpoint. SplitTunnel *bool - // The transport protocol used by the Client VPN endpoint. + // The transport protocol used by the Client VPN endpoint. TransportProtocol *string - // The ID of the VPC. + // The ID of the VPC. VpcId *string - // The port number for the Client VPN endpoint. + // The port number for the Client VPN endpoint. VpnPort *int32 noSmithyDocumentSerde @@ -4040,8 +4442,10 @@ type AwsEc2EipDetails struct { // 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 . + // 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 . Domain *string // The identifier of the EC2 instance. @@ -4087,15 +4491,21 @@ type AwsEc2InstanceDetails struct { // The key name associated with the instance. KeyName *string - // Indicates when the instance was launched. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the instance was launched. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LaunchedAt *string @@ -4103,7 +4513,7 @@ type AwsEc2InstanceDetails struct { // Details about the metadata options for the Amazon EC2 instance. MetadataOptions *AwsEc2InstanceMetadataOptions - // Describes the type of monitoring that’s turned on for an instance. + // Describes the type of monitoring that’s turned on for an instance. Monitoring *AwsEc2InstanceMonitoringDetails // The identifiers of the network interfaces for the EC2 instance. The details for @@ -4152,8 +4562,8 @@ type AwsEc2InstanceMetadataOptions struct { // The type of monitoring that’s turned on for an Amazon EC2 instance. type AwsEc2InstanceMonitoringDetails struct { - // Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring - // is turned on. + // Indicates whether detailed monitoring is turned on. Otherwise, basic + // monitoring is turned on. State *string noSmithyDocumentSerde @@ -4169,22 +4579,23 @@ type AwsEc2InstanceNetworkInterfacesDetails struct { noSmithyDocumentSerde } -// Information about a block device mapping for an Amazon Elastic Compute Cloud +// Information about a block device mapping for an Amazon Elastic Compute Cloud +// // (Amazon EC2) launch template. type AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails struct { - // The device name. + // The device name. DeviceName *string - // Parameters used to automatically set up Amazon EBS volumes when the instance is - // launched. + // Parameters used to automatically set up Amazon EBS volumes when the instance + // is launched. Ebs *AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails - // Omits the device from the block device mapping when an empty string is + // Omits the device from the block device mapping when an empty string is // specified. NoDevice *string - // The virtual device name (ephemeralN). Instance store volumes are numbered + // 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. @@ -4193,49 +4604,51 @@ type AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails struct { noSmithyDocumentSerde } -// Parameters for a block device for an Amazon Elastic Block Store (Amazon EBS) +// Parameters for a block device for an Amazon Elastic Block Store (Amazon EBS) +// // volume in an Amazon EC2 launch template. type AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails struct { - // Indicates whether the EBS volume is deleted on instance termination. + // Indicates whether the EBS volume is deleted on instance termination. DeleteOnTermination *bool - // Indicates whether the EBS volume is encrypted. Encrypted volumes can only be + // Indicates whether the EBS volume is encrypted. Encrypted volumes can only be // attached to instances that support Amazon EBS encryption. If you're creating a // volume from a snapshot, you can't specify an encryption value. Encrypted *bool - // The number of I/O operations per second (IOPS). + // The number of I/O operations per second (IOPS). Iops *int32 - // The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) + // The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) // customer managed key used for encryption. KmsKeyId *string - // The ID of the EBS snapshot. + // The ID of the EBS snapshot. SnapshotId *string - // The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. + // The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. Throughput *int32 - // The size of the volume, in GiBs. You must specify either a snapshot ID or a + // The size of the volume, in GiBs. You must specify either a snapshot ID or a // volume size. VolumeSize *int32 - // The volume type. + // The volume type. VolumeType *string noSmithyDocumentSerde } -// Information about the target Capacity Reservation or Capacity Reservation group -// in which to run an Amazon EC2 instance. +// Information about the target Capacity Reservation or Capacity Reservation +// +// group in which to run an Amazon EC2 instance. type AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails struct { - // The ID of the Capacity Reservation in which to run the instance. + // The ID of the Capacity Reservation in which to run the instance. CapacityReservationId *string - // The Amazon Resource Name (ARN) of the Capacity Reservation resource group in + // The Amazon Resource Name (ARN) of the Capacity Reservation resource group in // which to run the instance. CapacityReservationResourceGroupArn *string @@ -4245,163 +4658,172 @@ 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 , + // 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. + // Specifies a target Capacity Reservation. CapacityReservationTarget *AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails noSmithyDocumentSerde } -// 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) -// in the Amazon Elastic Compute Cloud User Guide. +// Specifies the CPU options for an Amazon EC2 instance. For more information, +// +// see [Optimize CPU options]in the Amazon Elastic Compute Cloud User Guide. +// +// [Optimize CPU options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html type AwsEc2LaunchTemplateDataCpuOptionsDetails struct { - // The number of CPU cores for the instance. + // 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 number of threads per CPU core. A value of 1 disables multithreading for // the instance, The default value is 2 . ThreadsPerCore *int32 noSmithyDocumentSerde } -// Specifies the credit option for CPU usage of a T2, T3, or T3a Amazon EC2 +// Specifies the credit option for CPU usage of a T2, T3, or T3a Amazon EC2 +// // instance. type AwsEc2LaunchTemplateDataCreditSpecificationDetails struct { - // The credit option for CPU usage of a T instance. + // The credit option for CPU usage of a T instance. CpuCredits *string noSmithyDocumentSerde } -// The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) +// The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) +// // launch template. type AwsEc2LaunchTemplateDataDetails struct { - // Information about a block device mapping for an Amazon EC2 launch template. + // Information about a block device mapping for an Amazon EC2 launch template. BlockDeviceMappingSet []AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails - // Specifies an instance's Capacity Reservation targeting option. You can specify + // Specifies an instance's Capacity Reservation targeting option. You can specify // only one option at a time. 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) - // in the Amazon Elastic Compute Cloud User Guide. + // Specifies the CPU options for an instance. For more information, see [Optimize CPU options] in the + // Amazon Elastic Compute Cloud User Guide. + // + // [Optimize CPU options]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html CpuOptions *AwsEc2LaunchTemplateDataCpuOptionsDetails - // Specifies the credit option for CPU usage of a T2, T3, or T3a instance. + // Specifies the credit option for CPU usage of a T2, T3, or T3a instance. 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) - // in the Amazon EC2 User Guide. + // Indicates whether to enable the instance for stop protection. For more + // information, see [Enable stop protection]in the Amazon EC2 User Guide. + // + // [Enable 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. If set to true , you can. DisableApiTermination *bool - // Indicates whether the instance is optimized for Amazon EBS I/O. + // Indicates whether the instance is optimized for Amazon EBS I/O. EbsOptimized *bool - // Provides details about Elastic Graphics accelerators to associate with the + // Provides details about Elastic Graphics accelerators to associate with the // instance. ElasticGpuSpecificationSet []AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails - // The Amazon Elastic Inference accelerator for the instance. + // The Amazon Elastic Inference accelerator for the instance. ElasticInferenceAcceleratorSet []AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails - // Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services + // Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services // Nitro Enclaves. EnclaveOptions *AwsEc2LaunchTemplateDataEnclaveOptionsDetails - // Specifies whether your Amazon EC2 instance is configured for hibernation. + // Specifies whether your Amazon EC2 instance is configured for hibernation. HibernationOptions *AwsEc2LaunchTemplateDataHibernationOptionsDetails - // The name or Amazon Resource Name (ARN) of an IAM instance profile. + // The name or Amazon Resource Name (ARN) of an IAM instance profile. IamInstanceProfile *AwsEc2LaunchTemplateDataIamInstanceProfileDetails - // The ID of the Amazon Machine Image (AMI). + // The ID of the Amazon Machine Image (AMI). ImageId *string - // Provides the options for specifying the instance initiated shutdown behavior. + // Provides the options for specifying the instance initiated shutdown behavior. InstanceInitiatedShutdownBehavior *string - // Specifies the market (purchasing) option for an instance. + // Specifies the market (purchasing) option for an instance. InstanceMarketOptions *AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails - // The attributes for the instance types. When you specify instance attributes, + // 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 *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] in the Amazon EC2 User Guide. If + // you specify InstanceType , you can't specify InstanceRequirements . + // + // [Instance types]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html InstanceType *string - // The ID of the kernel. + // The ID of the kernel. KernelId *string - // The name of the key pair that allows users to connect to the instance. + // The name of the key pair that allows users to connect to the instance. KeyName *string - // Specifies a license configuration for an instance. + // Specifies a license configuration for an instance. LicenseSet []AwsEc2LaunchTemplateDataLicenseSetDetails - // The maintenance options of your instance. + // The maintenance options of your instance. 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) - // in the Amazon EC2 User Guide. + // The metadata options for the instance. For more information, see [Instance metadata and user data] in the + // Amazon EC2 User Guide. + // + // [Instance metadata and user data]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html MetadataOptions *AwsEc2LaunchTemplateDataMetadataOptionsDetails - // The monitoring for the instance. + // The monitoring for the instance. Monitoring *AwsEc2LaunchTemplateDataMonitoringDetails - // Specifies the parameters for a network interface that is attached to the + // Specifies the parameters for a network interface that is attached to the // instance. NetworkInterfaceSet []AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails - // Specifies the placement of an instance. + // Specifies the placement of an instance. Placement *AwsEc2LaunchTemplateDataPlacementDetails - // The options for the instance hostname. + // The options for the instance hostname. PrivateDnsNameOptions *AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails - // The ID of the RAM disk. + // The ID of the RAM disk. RamDiskId *string - // One or more security group IDs. + // One or more security group IDs. SecurityGroupIdSet []string - // One or more security group names. For a nondefault VPC, you must use security + // One or more security group names. For a nondefault VPC, you must use security // group IDs instead. You cannot specify both a security group ID and security name // in the same request. SecurityGroupSet []string - // The user data to make available to the instance. + // The user data to make available to the instance. UserData *string noSmithyDocumentSerde } -// Provides details about an Elastic Graphics specification for an Amazon EC2 +// Provides details about an Elastic Graphics specification for an Amazon EC2 +// // launch template. type AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails struct { - // The type of Elastic Graphics accelerator. + // The type of Elastic Graphics accelerator. Type *string noSmithyDocumentSerde @@ -4410,20 +4832,21 @@ type AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails struct { // Provides details for an Amazon Elastic Inference accelerator. type AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails struct { - // The number of Elastic Inference accelerators to attach to the instance. + // The number of Elastic Inference accelerators to attach to the instance. Count *int32 - // The type of Elastic Inference accelerator. + // The type of Elastic Inference accelerator. Type *string noSmithyDocumentSerde } -// Indicates whether the instance is enabled for Amazon Web Services Nitro +// Indicates whether the instance is enabled for Amazon Web Services Nitro +// // 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 @@ -4433,33 +4856,35 @@ 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 } -// Provides details for an Identity and Access Management (IAM) instance profile, +// Provides details for an Identity and Access Management (IAM) instance profile, +// // which is a container for an IAM role for your instance. type AwsEc2LaunchTemplateDataIamInstanceProfileDetails struct { - // The Amazon Resource Name (ARN) of the instance profile. + // The Amazon Resource Name (ARN) of the instance profile. Arn *string - // The name of the instance profile. + // The name of the instance profile. Name *string noSmithyDocumentSerde } -// Provides details about the market (purchasing) option for an Amazon EC2 +// Provides details about the market (purchasing) option for an Amazon EC2 +// // instance. type AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails struct { - // The market type. + // The market type. MarketType *string - // The options for Spot Instances. + // The options for Spot Instances. SpotOptions *AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails noSmithyDocumentSerde @@ -4468,65 +4893,69 @@ type AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails struct { // Provides details about the market (purchasing) options for Spot Instances. type AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails struct { - // Deprecated. + // Deprecated. BlockDurationMinutes *int32 - // The behavior when a Spot Instance is interrupted. + // The behavior when a Spot Instance is interrupted. InstanceInterruptionBehavior *string - // The maximum hourly price you're willing to pay for the Spot Instances. + // The maximum hourly price you're willing to pay for the Spot Instances. MaxPrice *string - // The Spot Instance request type. + // The Spot Instance request type. SpotInstanceType *string - // The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for + // The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for // persistent requests. ValidUntil *string noSmithyDocumentSerde } -// The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web +// The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web +// // Services Inferentia chips) on an Amazon EC2 instance. type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails struct { - // The maximum number of accelerators. If this parameter isn't specified, there's + // 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 . Max *int32 - // The minimum number of accelerators. If this parameter isn't specified, there's + // The minimum number of accelerators. If this parameter isn't specified, there's // no minimum limit. Min *int32 noSmithyDocumentSerde } -// The minimum and maximum amount of memory, in MiB, for the accelerators on an +// The minimum and maximum amount of memory, in MiB, for the accelerators on an +// // Amazon EC2 instance. type AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails struct { - // The maximum amount of memory, in MiB. If this parameter isn't specified, + // 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 + // The minimum amount of memory, in MiB. If 0 is specified, there's no maximum // limit. Min *int32 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]in the Amazon EC2 User Guide. +// +// [Amazon EBS–optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html type AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails struct { - // The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's + // The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's // no maximum limit. Max *int32 - // The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's + // The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's // no minimum limit. Min *int32 @@ -4536,7 +4965,7 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails // The attributes for the Amazon EC2 instance types. type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { - // The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web + // The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web // Services Inferentia chips) on an instance. AcceleratorCount *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails @@ -4544,10 +4973,10 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { // manufacturers. AcceleratorManufacturers []string - // The accelerators that must be on the instance type. + // The accelerators that must be on the instance type. AcceleratorNames []string - // The minimum and maximum amount of total accelerator memory, in MiB. + // The minimum and maximum amount of total accelerator memory, in MiB. AcceleratorTotalMemoryMiB *AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails // The accelerator types that must be on the instance type. @@ -4557,68 +4986,75 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { // required. 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. + // The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more + // information, see [Amazon EBS optimized instances]in the Amazon EC2 User Guide. + // + // [Amazon EBS optimized instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html 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) - // in the Amazon EC2 User Guide. + // Indicates whether burstable performance T instance types are included, + // excluded, or required. For more information, [Burstable performance instances]in the Amazon EC2 User Guide. + // + // [Burstable performance instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html BurstablePerformance *string - // The CPU manufacturers to include. + // The CPU manufacturers to include. CpuManufacturers []string - // The instance types to exclude. + // The instance types to exclude. ExcludedInstanceTypes []string - // Indicates whether current or previous generation instance types are included. + // Indicates whether current or previous generation instance types are included. 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. + // Indicates whether instance types with instance store volumes are included, + // excluded, or required. For more information, see [Amazon EC2 instance store]in the Amazon EC2 User Guide. + // + // [Amazon EC2 instance store]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html LocalStorage *string - // The type of local storage that is required. + // The type of local storage that is required. LocalStorageTypes []string - // The minimum and maximum amount of memory per vCPU, in GiB. + // The minimum and maximum amount of memory per vCPU, in GiB. MemoryGiBPerVCpu *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails - // The minimum and maximum amount of memory, in MiB. + // The minimum and maximum amount of memory, in MiB. MemoryMiB *AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails - // The minimum and maximum number of network interfaces. + // The minimum and maximum number of network interfaces. NetworkInterfaceCount *AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails - // The price protection threshold for On-Demand Instances. This is the maximum + // The price protection threshold for On-Demand Instances. This is the maximum // you'll pay for an On-Demand 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. A high value, such as - // 999999 , turns off price protection. + // 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. OnDemandMaxPricePercentageOverLowestPrice *int32 - // Indicates whether instance types must support hibernation for On-Demand + // Indicates whether instance types must support hibernation for On-Demand // Instances. RequireHibernateSupport *bool - // The price protection threshold for Spot Instances. This is the maximum you'll + // The price protection threshold for Spot Instances. This is the maximum you'll // pay for a 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. A high value, such as 999999 , turns off - // price protection. + // 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. SpotMaxPricePercentageOverLowestPrice *int32 - // The minimum and maximum amount of total local storage, in GB. + // The minimum and maximum amount of total local storage, in GB. TotalLocalStorageGB *AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails - // The minimum and maximum number of vCPUs. + // The minimum and maximum number of vCPUs. VCpuCount *AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails noSmithyDocumentSerde @@ -4627,11 +5063,11 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsDetails struct { // The minimum and maximum amount of memory per vCPU, in GiB. type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails struct { - // The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, + // The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, // there's no maximum limit. Max *float64 - // The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, + // The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, // there's no maximum limit. Min *float64 @@ -4641,36 +5077,38 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails struct // The minimum and maximum amount of memory, in MiB, for an Amazon EC2 instance. type AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails struct { - // The maximum amount of memory, in MiB. + // The maximum amount of memory, in MiB. Max *int32 - // The minimum amount of memory, in MiB. + // The minimum amount of memory, in MiB. Min *int32 noSmithyDocumentSerde } -// The minimum and maximum number of network interfaces to be attached to an +// 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. + // The maximum number of network interfaces. Max *int32 - // The minimum number of network interfaces. + // The minimum number of network interfaces. Min *int32 noSmithyDocumentSerde } -// The minimum and maximum amount of total local storage, in GB, that an Amazon +// 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. + // The maximum amount of total local storage, in GB. Max *float64 - // The minimum amount of total local storage, in GB. + // The minimum amount of total local storage, in GB. Min *float64 noSmithyDocumentSerde @@ -4679,10 +5117,10 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails stru // The minimum and maximum number of vCPUs for an Amazon EC2 instance. type AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails struct { - // The maximum number of vCPUs. + // The maximum number of vCPUs. Max *int32 - // The minimum number of vCPUs. + // The minimum number of vCPUs. Min *int32 noSmithyDocumentSerde @@ -4691,7 +5129,7 @@ type AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails struct { // Provides details about the license configuration for an Amazon EC2 instance. type AwsEc2LaunchTemplateDataLicenseSetDetails struct { - // The Amazon Resource Name (ARN) of the license configuration. + // The Amazon Resource Name (ARN) of the license configuration. LicenseConfigurationArn *string noSmithyDocumentSerde @@ -4700,7 +5138,8 @@ type AwsEc2LaunchTemplateDataLicenseSetDetails struct { // The maintenance options of an Amazon EC2 instance. type AwsEc2LaunchTemplateDataMaintenanceOptionsDetails struct { - // Disables the automatic recovery behavior of your instance or sets it to default. + // Disables the automatic recovery behavior of your instance or sets it to + // default. AutoRecovery *string noSmithyDocumentSerde @@ -4709,26 +5148,27 @@ type AwsEc2LaunchTemplateDataMaintenanceOptionsDetails struct { // Specifies the metadata options for an Amazon EC2 instance. type AwsEc2LaunchTemplateDataMetadataOptionsDetails struct { - // Enables or disables the HTTP metadata endpoint on your instances. If the + // Enables or disables the HTTP metadata endpoint on your instances. If the // parameter is not specified, the default state is enabled, and you won't be able // to access your instance metadata. HttpEndpoint *string - // Enables or disables the IPv6 endpoint for the instance metadata service. + // Enables or disables the IPv6 endpoint for the instance metadata service. HttpProtocolIpv6 *string - // The desired HTTP PUT response hop limit for instance metadata requests. The + // The desired HTTP PUT response hop limit for instance metadata requests. The // larger the number, the further instance metadata requests can travel. HttpPutResponseHopLimit *int32 - // The state of token usage for your instance metadata requests. + // 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 + // 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. + // from the instance metadata. For more information, see [Work with instance tags in instance metadata]in the Amazon EC2 User + // Guide. + // + // [Work with instance tags in instance metadata]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS InstanceMetadataTags *string noSmithyDocumentSerde @@ -4737,89 +5177,93 @@ type AwsEc2LaunchTemplateDataMetadataOptionsDetails struct { // The monitoring for an Amazon EC2 instance. 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) - // in the Amazon EC2 User Guide. + // 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]in + // the Amazon EC2 User Guide. + // + // [Enable or turn off detailed monitoring for your instances]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html Enabled *bool noSmithyDocumentSerde } -// One or more network interfaces to attach to an Amazon EC2 instance. If you +// One or more network interfaces to attach to an Amazon EC2 instance. If you +// // specify a network interface, you must specify security groups and subnets as // part of the network interface. 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) - // in the Wavelength Developer Guide. + // 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]in the Wavelength Developer Guide. + // + // [Carrier IP address]: https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip AssociateCarrierIpAddress *bool - // Associates a public IPv4 address with eth0 for a new network interface. + // Associates a public IPv4 address with eth0 for a new network interface. AssociatePublicIpAddress *bool - // Indicates whether the network interface is deleted when the instance is + // Indicates whether the network interface is deleted when the instance is // terminated. DeleteOnTermination *bool - // A description for the network interface. + // A description for the network interface. Description *string - // The device index for the network interface attachment. + // The device index for the network interface attachment. DeviceIndex *int32 - // The IDs of one or more security groups. + // The IDs of one or more security groups. Groups []string - // The type of network interface. + // The type of network interface. InterfaceType *string - // The number of IPv4 prefixes to be automatically assigned to the network + // The number of IPv4 prefixes to be automatically assigned to the network // interface. You cannot use this option if you use the Ipv4Prefixes option. Ipv4PrefixCount *int32 - // One or more IPv4 prefixes to be assigned to the network interface. You cannot + // One or more IPv4 prefixes to be assigned to the network interface. You cannot // use this option if you use the Ipv4PrefixCount option. Ipv4Prefixes []AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails - // The number of IPv6 addresses to assign to a network interface. Amazon EC2 + // 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 . Ipv6AddressCount *int32 - // One or more specific IPv6 addresses from the IPv6 CIDR block range of your + // 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 . Ipv6Addresses []AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails - // The number of IPv6 prefixes to be automatically assigned to the network + // The number of IPv6 prefixes to be automatically assigned to the network // interface. You cannot use this option if you use the Ipv6Prefix option. Ipv6PrefixCount *int32 - // One or more IPv6 prefixes to be assigned to the network interface. You cannot + // One or more IPv6 prefixes to be assigned to the network interface. You cannot // use this option if you use the Ipv6PrefixCount option. Ipv6Prefixes []AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails - // The index of the network card. Some instance types support multiple network + // 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 . NetworkCardIndex *int32 - // The ID of the network interface. + // The ID of the network interface. NetworkInterfaceId *string - // The primary private IPv4 address of the network interface. + // The primary private IPv4 address of the network interface. PrivateIpAddress *string - // One or more private IPv4 addresses. + // One or more private IPv4 addresses. PrivateIpAddresses []AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails - // The number of secondary private IPv4 addresses to assign to a network interface. + // The number of secondary private IPv4 addresses to assign to a network + // interface. SecondaryPrivateIpAddressCount *int32 - // The ID of the subnet for the network interface. + // The ID of the subnet for the network interface. SubnetId *string noSmithyDocumentSerde @@ -4828,9 +5272,10 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails struct { // Provides details on one or more IPv4 prefixes for a network interface. 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. + // The IPv4 prefix. For more information, see [Assigning prefixes to Amazon EC2 network interfaces] in the Amazon Elastic Compute + // Cloud User Guide. + // + // [Assigning prefixes to Amazon EC2 network interfaces]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html Ipv4Prefix *string noSmithyDocumentSerde @@ -4839,18 +5284,19 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails struct { // Specifies an IPv6 address in an Amazon EC2 launch template. type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails struct { - // One or more specific IPv6 addresses from the IPv6 CIDR block range of your + // One or more specific IPv6 addresses from the IPv6 CIDR block range of your // subnet. Ipv6Address *string noSmithyDocumentSerde } -// Provides details on one or more IPv6 prefixes to be assigned to the network +// Provides details on one or more IPv6 prefixes to be assigned to the network +// // interface. type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails struct { - // The IPv6 prefix. + // The IPv6 prefix. Ipv6Prefix *string noSmithyDocumentSerde @@ -4859,11 +5305,11 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails struct { // One or more private IPv4 addresses. type AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails struct { - // Indicates whether the private IPv4 address is the primary private IPv4 address. - // Only one IPv4 address can be designated as primary. + // Indicates whether the private IPv4 address is the primary private IPv4 + // address. Only one IPv4 address can be designated as primary. Primary *bool - // The private IPv4 address. + // The private IPv4 address. PrivateIpAddress *string noSmithyDocumentSerde @@ -4872,29 +5318,29 @@ type AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails struct // Provides details about the placement of an Amazon EC2 instance. type AwsEc2LaunchTemplateDataPlacementDetails struct { - // The affinity setting for an instance on an EC2 Dedicated Host. + // The affinity setting for an instance on an EC2 Dedicated Host. Affinity *string - // The Availability Zone for the instance. + // The Availability Zone for the instance. AvailabilityZone *string - // The name of the placement group for the instance. + // The name of the placement group for the instance. GroupName *string - // The ID of the Dedicated Host for the instance. + // 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 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. + // The number of the partition the instance should launch in. PartitionNumber *int32 - // Reserved for future use. + // Reserved for future use. SpreadDomain *string - // The tenancy of the instance (if the instance is running in a VPC). An instance + // 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. Tenancy *string @@ -4904,37 +5350,38 @@ 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 + // 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 + // Indicates whether to respond to DNS queries for instance hostnames with DNS A // records. EnableResourceNameDnsARecord *bool - // The type of hostname for EC2 instances. + // The type of hostname for EC2 instances. HostnameType *string noSmithyDocumentSerde } -// Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon +// Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon +// // EC2) launch template. type AwsEc2LaunchTemplateDetails struct { - // The default version of the launch template. + // The default version of the launch template. DefaultVersionNumber *int64 - // An ID for the launch template. + // An ID for the launch template. Id *string - // The latest version of the launch template. + // The latest version of the launch template. LatestVersionNumber *int64 - // The information to include in the launch template. + // The information to include in the launch template. LaunchTemplateData *AwsEc2LaunchTemplateDataDetails - // A name for the launch template. + // A name for the launch template. LaunchTemplateName *string noSmithyDocumentSerde @@ -5016,15 +5463,21 @@ type AwsEc2NetworkAclEntry struct { // Information about the network interface attachment. type AwsEc2NetworkInterfaceAttachment struct { - // Indicates when the attachment initiated. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the attachment initiated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) AttachTime *string @@ -5045,7 +5498,9 @@ type AwsEc2NetworkInterfaceAttachment struct { // The Amazon Web Services account ID of the owner of the instance. InstanceOwnerId *string - // The attachment state. Valid values: attaching | attached | detaching | detached + // The attachment state. + // + // Valid values: attaching | attached | detaching | detached Status *string noSmithyDocumentSerde @@ -5119,22 +5574,22 @@ type AwsEc2NetworkInterfaceSecurityGroup struct { // Provides details about a route table for the specified VPC. type AwsEc2RouteTableDetails struct { - // The associations between a route table and one or more subnets or a gateway. + // The associations between a route table and one or more subnets or a gateway. AssociationSet []AssociationSetDetails - // The ID of the Amazon Web Services account that owns the route table. + // The ID of the Amazon Web Services account that owns the route table. OwnerId *string - // Describes a virtual private gateway propagating route. + // Describes a virtual private gateway propagating route. PropagatingVgwSet []PropagatingVgwSetDetails - // The routes in the route table. + // The routes in the route table. RouteSet []RouteSetDetails - // The ID of the route table. + // The ID of the route table. RouteTableId *string - // The ID of the virtual private cloud (VPC). + // The ID of the virtual private cloud (VPC). VpcId *string noSmithyDocumentSerde @@ -5168,16 +5623,24 @@ type AwsEc2SecurityGroupDetails struct { type AwsEc2SecurityGroupIpPermission struct { // The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 - // type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all - // ICMP/ICMPv6 types, you must specify all codes. + // type number. + // + // A value of -1 indicates all ICMP/ICMPv6 types. If you specify all 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. @@ -5191,9 +5654,10 @@ type AwsEc2SecurityGroupIpPermission struct { // 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. @@ -5245,11 +5709,14 @@ type AwsEc2SecurityGroupUserIdGroupPair struct { // The status of a VPC peering connection, if applicable. PeeringStatus *string - // The ID of an Amazon Web Services account. For a referenced security group in - // another VPC, the account ID of the referenced security group is returned in the - // response. If the referenced security group is deleted, this value is not - // returned. [EC2-Classic] Required when adding or removing rules that reference a - // security group in another VPC. + // The ID of an Amazon Web Services account. + // + // For a referenced security group in another VPC, the account ID of the + // referenced security group is returned in the response. If the referenced + // security group is deleted, this value is not returned. + // + // [EC2-Classic] Required when adding or removing rules that reference a security + // group in another VPC. UserId *string // The ID of the VPC for the referenced security group, if applicable. @@ -5366,10 +5833,15 @@ type AwsEc2VolumeAttachment struct { InstanceId *string // The attachment state of the volume. Valid values are as follows: + // // - attaching + // // - attached + // // - busy + // // - detaching + // // - detached Status *string @@ -5382,15 +5854,21 @@ type AwsEc2VolumeDetails struct { // The volume attachments. Attachments []AwsEc2VolumeAttachment - // Indicates when the volume was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the volume was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateTime *string @@ -5412,11 +5890,17 @@ type AwsEc2VolumeDetails struct { SnapshotId *string // The volume state. Valid values are as follows: + // // - available + // // - creating + // // - deleted + // // - deleting + // // - error + // // - in-use Status *string @@ -5484,10 +5968,15 @@ type AwsEc2VpcEndpointServiceDetails struct { ServiceName *string // The current state of the service. Valid values are as follows: + // // - Available + // // - Deleted + // // - Deleting + // // - Failed + // // - Pending ServiceState *string @@ -5591,9 +6080,13 @@ type AwsEc2VpnConnectionDetails struct { Routes []AwsEc2VpnConnectionRoutesDetails // The current state of the VPN connection. Valid values are as follows: + // // - available + // // - deleted + // // - deleting + // // - pending State *string @@ -5713,16 +6206,21 @@ type AwsEc2VpnConnectionVgwTelemetryDetails struct { // The ARN of the VPN tunnel endpoint certificate. CertificateArn *string - // The date and time of the last change in status. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The date and time of the last change in status. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastStatusChange *string @@ -5744,24 +6242,32 @@ type AwsEc2VpnConnectionVgwTelemetryDetails struct { type AwsEcrContainerImageDetails struct { // The architecture of the image. Valid values are as follows: + // // - 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. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // The date and time when the image was pushed to the repository. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ImagePublishedAt *string @@ -5907,8 +6413,9 @@ 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) - // API operation. + // can view these services with the Amazon ECS [ListServices]ListServices API operation. + // + // [ListServices]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html ActiveServicesCount *int32 // The short name of one or more capacity providers to associate with the cluster. @@ -5968,16 +6475,21 @@ 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. CapacityProvider *string // The relative percentage of the total number of tasks that should use the - // capacity provider. If no weight is specified, the default value is 0. At least - // one capacity provider must have a weight greater than 0. The value can be - // between 0 and 1000. + // capacity provider. + // + // If no weight is specified, the default value is 0. At least one capacity + // provider must have a weight greater than 0. + // + // The value can be between 0 and 1000. Weight *int32 noSmithyDocumentSerde @@ -6009,21 +6521,27 @@ type AwsEcsServiceDeploymentConfigurationDetails struct { // 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 - // 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. + // 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 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 // 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. + // 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. MinimumHealthyPercent *int32 @@ -6034,13 +6552,17 @@ type AwsEcsServiceDeploymentConfigurationDetails struct { 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 + // 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 @@ -6075,7 +6597,9 @@ type AwsEcsServiceDetails struct { // scheduler ignores unhealthy Elastic Load Balancing target health checks. HealthCheckGracePeriodSeconds *int32 - // The launch type that the service uses. Valid values: EC2 | FARGATE | EXTERNAL + // The launch type that the service uses. + // + // Valid values: EC2 | FARGATE | EXTERNAL LaunchType *string // Information about the load balancers that the service uses. @@ -6101,7 +6625,9 @@ type AwsEcsServiceDetails struct { // Indicates whether to propagate the tags from the task definition to the task or // from the service to the task. If no value is provided, then tags are not - // propagated. Valid values: TASK_DEFINITION | SERVICE + // propagated. + // + // Valid values: TASK_DEFINITION | SERVICE PropagateTags *string // The ARN of the IAM role that is associated with the service. The role allows @@ -6109,22 +6635,29 @@ type AwsEcsServiceDetails struct { // Load Balancing load balancer. Role *string - // The scheduling strategy to use for the service. The REPLICA scheduling strategy - // places and maintains the desired number of tasks across the cluster. By default, - // the service scheduler spreads tasks across Availability Zones. Task placement - // strategies and constraints are used to customize task placement decisions. The - // DAEMON scheduling strategy deploys exactly one task on each active container - // instance that meets all of the task placement constraints that are specified in - // the cluster. The service scheduler also evaluates the task placement constraints - // for running tasks and stops tasks that do not meet the placement constraints. + // The scheduling strategy to use for the service. + // + // The REPLICA scheduling strategy places and maintains the desired number of + // tasks across the cluster. By default, the service scheduler spreads tasks across + // Availability Zones. Task placement strategies and constraints are used to + // customize task placement decisions. + // + // The DAEMON scheduling strategy deploys exactly one task on each active + // container instance that meets all of the task placement constraints that are + // specified in the cluster. The service scheduler also evaluates the task + // placement constraints for running tasks and stops tasks that do not meet the + // placement constraints. + // // Valid values: REPLICA | DAEMON SchedulingStrategy *string // The ARN of the service. ServiceArn *string - // The name of the service. The name can contain up to 255 characters. It can use - // letters, numbers, underscores, and hyphens. + // The name of the service. + // + // The name can contain up to 255 characters. It can use letters, numbers, + // underscores, and hyphens. ServiceName *string // Information about the service discovery registries to assign to the service. @@ -6149,14 +6682,17 @@ type AwsEcsServiceLoadBalancersDetails struct { ContainerPort *int32 // The name of the load balancer to associate with the Amazon ECS service or task - // set. Only specified when using a Classic Load Balancer. For an Application Load + // set. + // + // Only specified when using a Classic Load Balancer. For an Application Load // Balancer or a Network Load Balancer, the load balancer name is omitted. LoadBalancerName *string // The ARN of the Elastic Load Balancing target group or groups associated with a - // service or task set. Only specified when using an Application Load Balancer or a - // Network Load Balancer. For a Classic Load Balancer, the target group ARN is - // omitted. + // service or task set. + // + // Only specified when using an Application Load Balancer or a Network Load + // Balancer. For a Classic Load Balancer, the target group ARN is omitted. TargetGroupArn *string noSmithyDocumentSerde @@ -6167,15 +6703,19 @@ type AwsEcsServiceLoadBalancersDetails struct { 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 - // provide up to five security groups. + // The IDs of the security groups associated with the task or service. + // + // You can provide up to five security groups. SecurityGroups []string - // The IDs of the subnets associated with the task or service. You can provide up - // to 16 subnets. + // The IDs of the subnets associated with the task or service. + // + // You can provide up to 16 subnets. Subnets []string noSmithyDocumentSerde @@ -6200,7 +6740,9 @@ type AwsEcsServicePlacementConstraintsDetails struct { // The type of constraint. Use distinctInstance to run each task in a particular // group on a different container instance. Use memberOf to restrict the selection - // to a group of valid candidates. Valid values: distinctInstance | memberOf + // to a group of valid candidates. + // + // Valid values: distinctInstance | memberOf Type *string noSmithyDocumentSerde @@ -6209,20 +6751,28 @@ type AwsEcsServicePlacementConstraintsDetails struct { // A placement strategy that determines how to place the tasks for the service. 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 - // 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. + // 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 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. 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 - // 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 + // 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 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 Type *string noSmithyDocumentSerde @@ -6231,18 +6781,24 @@ type AwsEcsServicePlacementStrategiesDetails struct { // Information about a service discovery registry to assign to the service. 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. + // 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. 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. + // 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 *int32 // The port value to use for a service discovery service that specifies an SRV @@ -6262,9 +6818,13 @@ 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 Condition *string @@ -6400,13 +6960,20 @@ type AwsEcsTaskDefinitionContainerDefinitionsDetails struct { // A list of ulimits to set in the container. Ulimits []AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails - // The user to use inside the container. The value can use one of the following - // formats. + // 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 *string @@ -6460,10 +7027,14 @@ type AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails struct { // configures a log router for container logs. type AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails struct { - // The options to use to configure the log router. The valid option keys are as - // follows: + // 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. Options map[string]string @@ -6504,10 +7075,11 @@ type AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails struct { type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails struct { // The Linux capabilities for the container that are added to the default - // configuration provided by Docker. Valid values are as follows: 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" | + // configuration provided by Docker. Valid values are as follows: + // + // 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" | @@ -6516,14 +7088,16 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails Add []string // 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" | - // "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" + // 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" | "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" Drop []string noSmithyDocumentSerde @@ -6584,13 +7158,14 @@ 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" | - // "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 // The maximum size (in MiB) of the tmpfs volume. @@ -6602,20 +7177,34 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails struct // The log configuration specification for the container. type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails struct { - // The log driver to use for the container. Valid values on Fargate are as - // follows: + // 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 LogDriver *string @@ -6635,9 +7224,10 @@ type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetail // The name of the secret. Name *string - // The secret to expose to the container. The value is either the full ARN of the - // Secrets Manager secret or the full ARN of the parameter in the Systems Manager - // Parameter Store. + // The secret to expose to the container. + // + // The value is either the full ARN of the Secrets Manager secret or the full ARN + // of the parameter in the Systems Manager Parameter Store. ValueFrom *string noSmithyDocumentSerde @@ -6691,10 +7281,13 @@ type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails struct // InferenceAccelerator . Type *string - // 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 . + // 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 . Value *string noSmithyDocumentSerde @@ -6733,20 +7326,35 @@ 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 Name *string @@ -6777,10 +7385,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) Cpu *string @@ -6796,24 +7409,34 @@ 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 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) - // in the Amazon Elastic Container Service Developer Guide , which determines your - // range of supported values for the Cpu and Memory parameters. + // 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]in the Amazon Elastic Container Service Developer Guide + // , which determines your range of supported values for the Cpu and Memory + // parameters. + // + // [specified values]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size Memory *string // The Docker networking mode to use for the containers in the task. Valid values // are as follows: + // // - awsvpc + // // - bridge + // // - host + // // - none NetworkMode *string @@ -6830,7 +7453,7 @@ type AwsEcsTaskDefinitionDetails struct { // The task launch types that the task definition was validated against. RequiresCompatibilities []string - // The status of the task definition. + // The status of the task definition. Status *string // The short name or ARN of the IAM role that grants containers in the task @@ -7137,11 +7760,17 @@ type AwsEksClusterDetails struct { CertificateAuthorityData *string // The status of the cluster. Valid values are as follows: + // // - ACTIVE + // // - CREATING + // // - DELETING + // // - FAILED + // // - PENDING + // // - UPDATING ClusterStatus *string @@ -7174,10 +7803,15 @@ type AwsEksClusterLoggingClusterLoggingDetails struct { Enabled *bool // A list of logging types. Valid values are as follows: + // // - api + // // - audit + // // - authenticator + // // - controllerManager + // // - scheduler Types []string @@ -7196,7 +7830,7 @@ 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 + // 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. @@ -7257,13 +7891,21 @@ type AwsElasticBeanstalkEnvironmentDetails struct { SolutionStackName *string // The current operational status of the environment. Valid values are as follows: + // // - Aborting + // // - Launching + // // - LinkingFrom + // // - LinkingTo + // // - Ready + // // - Terminated + // // - Terminating + // // - Updating Status *string @@ -7335,9 +7977,14 @@ type AwsElasticsearchDomainDetails struct { // Unique identifier for an Elasticsearch domain. DomainId *string - // Name of an Elasticsearch domain. Domain names are unique across all domains - // owned by the same account within an Amazon Web Services Region. Domain names - // must start with a lowercase letter and must be between 3 and 28 characters. + // Name of an Elasticsearch domain. + // + // Domain names are unique across all domains owned by the same account within an + // Amazon Web Services Region. + // + // Domain names must start with a lowercase letter and must be between 3 and 28 + // characters. + // // Valid characters are a-z (lowercase only), 0-9, and – (hyphen). DomainName *string @@ -7351,7 +7998,9 @@ type AwsElasticsearchDomainDetails struct { EncryptionAtRestOptions *AwsElasticsearchDomainEncryptionAtRestOptions // Domain-specific endpoint used to submit index, search, and data upload requests - // to an Elasticsearch domain. The endpoint is a service URL. + // to an Elasticsearch domain. + // + // The endpoint is a service URL. Endpoint *string // The key-value pair that exists if the Elasticsearch domain uses VPC endpoints. @@ -7380,9 +8029,12 @@ 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: + // 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 @@ -7403,18 +8055,23 @@ type AwsElasticsearchDomainElasticsearchClusterConfigDetails struct { // 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. + // specified, then DedicatedMasterEnabled must be true . + // + // For a list of valid values, see [Supported instance types in Amazon OpenSearch Service] in the Amazon OpenSearch Service Developer + // Guide. + // + // [Supported instance types in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html 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) - // in the Amazon OpenSearch Service Developer Guide. + // + // For a list of valid values, see [Supported instance types in Amazon OpenSearch Service] in the Amazon OpenSearch Service Developer + // Guide. + // + // [Supported instance types in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html InstanceType *string // Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is @@ -7513,10 +8170,15 @@ 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 UpdateStatus *string @@ -7574,8 +8236,9 @@ type AwsElbLbCookieStickinessPolicy struct { // Contains information about the access log configuration for the load balancer. type AwsElbLoadBalancerAccessLog struct { - // The interval in minutes for publishing the access logs. You can publish access - // logs either every 5 minutes or every 60 minutes. + // The interval in minutes for publishing the access logs. + // + // You can publish access logs either every 5 minutes or every 60 minutes. EmitInterval *int32 // Indicates whether access logs are enabled for the load balancer. @@ -7584,8 +8247,9 @@ type AwsElbLoadBalancerAccessLog struct { // The name of the S3 bucket where the access logs are stored. S3BucketName *string - // The logical hierarchy that was created for the S3 bucket. If a prefix is not - // provided, the log is placed at the root level of the bucket. + // The logical hierarchy that was created for the S3 bucket. + // + // If a prefix is not provided, the log is placed at the root level of the bucket. S3BucketPrefix *string noSmithyDocumentSerde @@ -7606,28 +8270,33 @@ type AwsElbLoadBalancerAdditionalAttribute struct { // Contains attributes for the load balancer. type AwsElbLoadBalancerAttributes struct { - // Information about the access log configuration for the load balancer. If the - // access log is enabled, the load balancer captures detailed information about all - // requests. It delivers the information to a specified S3 bucket. + // Information about the access log configuration for the load balancer. + // + // If the access log is enabled, the load balancer captures detailed information + // about all requests. It delivers the information to a specified S3 bucket. AccessLog *AwsElbLoadBalancerAccessLog // Any additional attributes for a load balancer. AdditionalAttributes []AwsElbLoadBalancerAdditionalAttribute // Information about the connection draining configuration for the load balancer. - // If connection draining is enabled, the load balancer allows existing requests to - // complete before it shifts traffic away from a deregistered or unhealthy + // + // If connection draining is enabled, the load balancer allows existing requests + // to complete before it shifts traffic away from a deregistered or unhealthy // 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 - // balancing is enabled, the load balancer routes the request traffic evenly across - // all instances regardless of the Availability Zones. + // Cross-zone load balancing settings for the load balancer. + // + // If cross-zone load balancing is enabled, the load balancer routes the request + // traffic evenly across all instances regardless of the Availability Zones. CrossZoneLoadBalancing *AwsElbLoadBalancerCrossZoneLoadBalancing noSmithyDocumentSerde @@ -7694,16 +8363,21 @@ type AwsElbLoadBalancerDetails struct { // The ID of the Amazon Route 53 hosted zone for the load balancer. CanonicalHostedZoneNameID *string - // Indicates when the load balancer was created. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the load balancer was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedTime *string @@ -7729,10 +8403,13 @@ type AwsElbLoadBalancerDetails struct { // The policies for a load balancer. 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. + // 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 *string // The security groups for the load balancer. Only provided if the load balancer @@ -7766,10 +8443,15 @@ type AwsElbLoadBalancerHealthCheck struct { // The instance that is being checked. The target specifies the protocol and port. // The available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports - // 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 :/ . + // 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 :/ . Target *string // The amount of time, in seconds, during which no response means a failed health @@ -7798,17 +8480,22 @@ type AwsElbLoadBalancerListener struct { // The port on which the instance is listening. InstancePort *int32 - // The protocol to use to route traffic to instances. Valid values: HTTP | HTTPS | - // TCP | SSL + // The protocol to use to route traffic to instances. + // + // Valid values: HTTP | HTTPS | TCP | SSL InstanceProtocol *string - // The port on which the load balancer is listening. On EC2-VPC, you can specify - // any port from the range 1-65535. On EC2-Classic, you can specify any port from - // the following list: 25, 80, 443, 465, 587, 1024-65535. + // The port on which the load balancer is listening. + // + // On EC2-VPC, you can specify any port from the range 1-65535. + // + // On EC2-Classic, you can specify any port from the following list: 25, 80, 443, + // 465, 587, 1024-65535. LoadBalancerPort *int32 - // The load balancer transport protocol to use for routing. Valid values: HTTP | - // HTTPS | TCP | SSL + // The load balancer transport protocol to use for routing. + // + // Valid values: HTTP | HTTPS | TCP | SSL Protocol *string // The ARN of the server certificate. @@ -7877,16 +8564,21 @@ type AwsElbv2LoadBalancerDetails struct { // The ID of the Amazon Route 53 hosted zone associated with the load balancer. CanonicalHostedZoneId *string - // Indicates when the load balancer was created. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the load balancer was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedTime *string @@ -7920,85 +8612,89 @@ type AwsElbv2LoadBalancerDetails struct { noSmithyDocumentSerde } -// A schema defines the structure of events that are sent to Amazon EventBridge. +// A schema defines the structure of events that are sent to Amazon EventBridge. +// // Schema registries are containers for schemas. They collect and organize schemas // so that your schemas are in logical groups. type AwsEventSchemasRegistryDetails struct { - // A description of the registry to be created. + // A description of the registry to be created. Description *string - // The Amazon Resource Name (ARN) of the registry. + // The Amazon Resource Name (ARN) of the registry. RegistryArn *string - // The name of the schema registry. + // The name of the schema registry. RegistryName *string noSmithyDocumentSerde } -// Provides details about an Amazon EventBridge global endpoint. The endpoint can +// Provides details about an Amazon EventBridge global endpoint. The endpoint can +// // improve your application’s availability by making it Regional-fault tolerant. type AwsEventsEndpointDetails struct { - // The Amazon Resource Name (ARN) of the endpoint. + // The Amazon Resource Name (ARN) of the endpoint. Arn *string - // A description of the endpoint. + // A description of the endpoint. Description *string - // The URL subdomain of the endpoint. For example, if EndpointUrl is + // The URL subdomain of the endpoint. For example, if EndpointUrl is // https://abcde.veo.endpoints.event.amazonaws.com , then the EndpointId is // abcde.veo . EndpointId *string - // The URL of the endpoint. + // The URL of the endpoint. EndpointUrl *string - // The event buses being used by the endpoint. + // The event buses being used by the endpoint. EventBuses []AwsEventsEndpointEventBusesDetails - // The name of the endpoint. + // The name of the endpoint. Name *string - // Whether event replication was enabled or disabled for this endpoint. The + // 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 *AwsEventsEndpointReplicationConfigDetails - // The ARN of the role used by event replication for the endpoint. + // The ARN of the role used by event replication for the endpoint. RoleArn *string - // The routing configuration of the endpoint. + // The routing configuration of the endpoint. RoutingConfig *AwsEventsEndpointRoutingConfigDetails - // The current state of the endpoint. + // The current state of the endpoint. State *string - // The reason the endpoint is in its current state. + // The reason the endpoint is in its current state. StateReason *string noSmithyDocumentSerde } -// Provides details about the Amazon EventBridge event buses that the endpoint is +// Provides details about the Amazon EventBridge event buses that the endpoint is +// // associated with. type AwsEventsEndpointEventBusesDetails struct { - // The Amazon Resource Name (ARN) of the event bus that the endpoint is associated - // with. + // The Amazon Resource Name (ARN) of the event bus that the endpoint is + // associated with. EventBusArn *string noSmithyDocumentSerde } -// Indicates whether replication is enabled or disabled for the endpoint. If +// Indicates whether replication is enabled or disabled for the endpoint. If +// // enabled, the endpoint can replicate all events to a secondary Amazon Web // Services Region. type AwsEventsEndpointReplicationConfigDetails struct { - // The state of event replication. + // The state of event replication. State *string noSmithyDocumentSerde @@ -8007,21 +8703,22 @@ type AwsEventsEndpointReplicationConfigDetails struct { // Provides details about the routing configuration of the endpoint. type AwsEventsEndpointRoutingConfigDetails struct { - // The failover configuration for an endpoint. This includes what triggers + // The failover configuration for an endpoint. This includes what triggers // failover and what happens when it's triggered. FailoverConfig *AwsEventsEndpointRoutingConfigFailoverConfigDetails noSmithyDocumentSerde } -// The failover configuration for an endpoint. This includes what triggers +// The failover configuration for an endpoint. This includes what triggers +// // failover and what happens when it's triggered. type AwsEventsEndpointRoutingConfigFailoverConfigDetails struct { - // The main Region of the endpoint. + // The main Region of the endpoint. Primary *AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails - // The Region that events are routed to when failover is triggered or event + // The Region that events are routed to when failover is triggered or event // replication is enabled. Secondary *AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails @@ -8031,48 +8728,51 @@ type AwsEventsEndpointRoutingConfigFailoverConfigDetails struct { // Provides details about the primary Amazon Web Services Region of the endpoint. type AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails struct { - // The Amazon Resource Name (ARN) of the health check used by the endpoint to + // The Amazon Resource Name (ARN) of the health check used by the endpoint to // determine whether failover is triggered. HealthCheck *string noSmithyDocumentSerde } -// The Amazon Web Services Region that events are routed to when failover is +// The Amazon Web Services Region that events are routed to when failover is +// // triggered or event replication is enabled. type AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails struct { - // Defines the secondary Region. + // Defines the secondary Region. Route *string noSmithyDocumentSerde } -// Provides details about Amazon EventBridge event bus. An event bus is a router +// Provides details about Amazon EventBridge event bus. An event bus is a router +// // that receives events and delivers them to zero or more destinations, or targets. // This can be a custom event bus which you can use to receive events from your // custom applications and services, or it can be a partner event bus which can be // matched to a partner event source. type AwsEventsEventbusDetails struct { - // The Amazon Resource Name (ARN) of the account permitted to write events to the + // The Amazon Resource Name (ARN) of the account permitted to write events to the // current account. Arn *string - // The name of the event bus. + // The name of the event bus. Name *string - // The policy that enables the external account to send events to your account. + // The policy that enables the external account to send events to your account. Policy *string noSmithyDocumentSerde } -// An object that contains information on the status of CloudTrail as a data +// An object that contains information on the status of CloudTrail as a data +// // source for the detector. type AwsGuardDutyDetectorDataSourcesCloudTrailDetails struct { - // Specifies whether CloudTrail is activated as a data source for the detector. + // Specifies whether CloudTrail is activated as a data source for the detector. Status *string noSmithyDocumentSerde @@ -8081,144 +8781,154 @@ type AwsGuardDutyDetectorDataSourcesCloudTrailDetails struct { // Describes which data sources are activated for the detector. type AwsGuardDutyDetectorDataSourcesDetails struct { - // An object that contains information on the status of CloudTrail as a data + // An object that contains information on the status of CloudTrail as a data // source for the detector. CloudTrail *AwsGuardDutyDetectorDataSourcesCloudTrailDetails - // An object that contains information on the status of DNS logs as a data source + // An object that contains information on the status of DNS logs as a data source // for the detector. DnsLogs *AwsGuardDutyDetectorDataSourcesDnsLogsDetails - // An object that contains information on the status of VPC Flow Logs as a data + // An object that contains information on the status of VPC Flow Logs as a data // source for the detector. FlowLogs *AwsGuardDutyDetectorDataSourcesFlowLogsDetails - // An object that contains information on the status of Kubernetes data sources + // An object that contains information on the status of Kubernetes data sources // for the detector. Kubernetes *AwsGuardDutyDetectorDataSourcesKubernetesDetails - // An object that contains information on the status of Malware Protection as a + // An object that contains information on the status of Malware Protection as a // data source for the detector. MalwareProtection *AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails - // An object that contains information on the status of S3 Data event logs as a + // An object that contains information on the status of S3 Data event logs as a // data source for the detector. S3Logs *AwsGuardDutyDetectorDataSourcesS3LogsDetails noSmithyDocumentSerde } -// An object that contains information on the status of DNS logs as a data source +// An object that contains information on the status of DNS logs as a data source +// // for the detector. type AwsGuardDutyDetectorDataSourcesDnsLogsDetails struct { - // Describes whether DNS logs is enabled as a data source for the detector. + // Describes whether DNS logs is enabled as a data source for the detector. Status *string noSmithyDocumentSerde } -// An object that contains information on the status of VPC Flow Logs as a data +// An object that contains information on the status of VPC Flow Logs as a data +// // source for the detector. type AwsGuardDutyDetectorDataSourcesFlowLogsDetails struct { - // Describes whether VPC Flow Logs are activated as a data source for the detector. + // Describes whether VPC Flow Logs are activated as a data source for the + // detector. Status *string noSmithyDocumentSerde } -// An object that contains information on the status of Kubernetes audit logs as a -// data source for the detector. +// An object that contains information on the status of Kubernetes audit logs as +// +// a data source for the detector. type AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails struct { - // Describes whether Kubernetes audit logs are activated as a data source for the + // Describes whether Kubernetes audit logs are activated as a data source for the // detector. Status *string noSmithyDocumentSerde } -// An object that contains information on the status of Kubernetes data sources +// An object that contains information on the status of Kubernetes data sources +// // for the detector. type AwsGuardDutyDetectorDataSourcesKubernetesDetails struct { - // Describes whether Kubernetes audit logs are activated as a data source for the + // Describes whether Kubernetes audit logs are activated as a data source for the // detector. AuditLogs *AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails noSmithyDocumentSerde } -// An object that contains information on the status of Malware Protection as a +// An object that contains information on the status of Malware Protection as a +// // data source for the detector. type AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails struct { - // Describes the configuration of Malware Protection for EC2 instances with + // Describes the configuration of Malware Protection for EC2 instances with // findings. ScanEc2InstanceWithFindings *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails - // The GuardDuty Malware Protection service role. + // The GuardDuty Malware Protection service role. ServiceRole *string noSmithyDocumentSerde } -// Describes the configuration of Malware Protection for EC2 instances with +// Describes the configuration of Malware Protection for EC2 instances with +// // findings. type AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails struct { - // Describes the configuration of scanning EBS volumes (Malware Protection) as a + // Describes the configuration of scanning EBS volumes (Malware Protection) as a // data source. EbsVolumes *AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails noSmithyDocumentSerde } -// Describes the configuration of scanning EBS volumes (Malware Protection) as a +// Describes the configuration of scanning EBS volumes (Malware Protection) as a +// // data source. type AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails struct { - // Specifies the reason why scanning EBS volumes (Malware Protection) isn’t + // Specifies the reason why scanning EBS volumes (Malware Protection) isn’t // activated as a data source. Reason *string - // Describes whether scanning EBS volumes is activated as a data source for the + // Describes whether scanning EBS volumes is activated as a data source for the // detector. Status *string noSmithyDocumentSerde } -// An object that contains information on the status of S3 data event logs as a +// An object that contains information on the status of S3 data event logs as a +// // data source for the detector. type AwsGuardDutyDetectorDataSourcesS3LogsDetails struct { - // A value that describes whether S3 data event logs are automatically enabled for - // new members of an organization. + // A value that describes whether S3 data event logs are automatically enabled + // for new members of an organization. Status *string noSmithyDocumentSerde } -// Provides details about an Amazon GuardDuty detector. A detector is an object +// Provides details about an Amazon GuardDuty detector. A detector is an object +// // that represents the GuardDuty service. A detector is required for GuardDuty to // become operational. type AwsGuardDutyDetectorDetails struct { - // Describes which data sources are activated for the detector. + // Describes which data sources are activated for the detector. DataSources *AwsGuardDutyDetectorDataSourcesDetails - // Describes which features are activated for the detector. + // Describes which features are activated for the detector. Features []AwsGuardDutyDetectorFeaturesDetails - // The publishing frequency of the finding. + // The publishing frequency of the finding. FindingPublishingFrequency *string - // The GuardDuty service role. + // The GuardDuty service role. ServiceRole *string - // The activation status of the detector. + // The activation status of the detector. Status *string noSmithyDocumentSerde @@ -8227,10 +8937,10 @@ type AwsGuardDutyDetectorDetails struct { // Describes which features are activated for the detector. type AwsGuardDutyDetectorFeaturesDetails struct { - // Indicates the name of the feature that is activated for the detector. + // Indicates the name of the feature that is activated for the detector. Name *string - // Indicates the status of the feature that is activated for the detector. + // Indicates the status of the feature that is activated for the detector. Status *string noSmithyDocumentSerde @@ -8245,16 +8955,21 @@ type AwsIamAccessKeyDetails struct { // The Amazon Web Services account ID of the account for the key. AccountId *string - // Indicates when the IAM access key was created. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the IAM access key was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedAt *string @@ -8274,9 +8989,10 @@ type AwsIamAccessKeyDetails struct { // The status of the IAM access key related to a finding. 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. + // 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. // // Deprecated: This filter is deprecated. Instead, use PrincipalName. UserName *string @@ -8299,15 +9015,21 @@ type AwsIamAccessKeySessionContext struct { // Attributes of the session that the key was used for. type AwsIamAccessKeySessionContextAttributes struct { - // Indicates when the session was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the session was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreationDate *string @@ -8358,15 +9080,21 @@ 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. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the IAM group was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8401,16 +9129,21 @@ type AwsIamInstanceProfile struct { // The ARN of the instance profile. Arn *string - // Indicates when the instance profile was created. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the instance profile was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8439,15 +9172,21 @@ type AwsIamInstanceProfileRole struct { // The policy that grants an entity permission to assume the role. AssumeRolePolicyDocument *string - // Indicates when the role was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the role was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8483,15 +9222,21 @@ type AwsIamPolicyDetails struct { // The number of users, groups, and roles that the policy is attached to. AttachmentCount *int32 - // When the policy was created. This field accepts only the specified formats. - // Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . The - // time-secfrac after seconds is limited to a maximum of 9 digits. The offset is - // bounded by +/-18:00. Here are valid timestamp formats with examples: + // When the policy was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8521,16 +9266,21 @@ type AwsIamPolicyDetails struct { // List of versions of the policy. PolicyVersionList []AwsIamPolicyVersion - // When the policy was most recently updated. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // When the policy was most recently updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) UpdateDate *string @@ -8541,15 +9291,21 @@ type AwsIamPolicyDetails struct { // A version of an IAM policy. type AwsIamPolicyVersion struct { - // Indicates when the version was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the version was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8572,15 +9328,21 @@ type AwsIamRoleDetails struct { // The list of the managed policies that are attached to the role. AttachedManagedPolicies []AwsIamAttachedManagedPolicy - // Indicates when the role was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the role was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8626,15 +9388,21 @@ type AwsIamUserDetails struct { // A list of the managed policies that are attached to the user. AttachedManagedPolicies []AwsIamAttachedManagedPolicy - // Indicates when the user was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the user was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreateDate *string @@ -8714,15 +9482,21 @@ type AwsKmsKeyDetails struct { // KMS key. AWSAccountId *string - // Indicates when the KMS key was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the KMS key was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreationDate *float64 @@ -8741,16 +9515,25 @@ type AwsKmsKeyDetails struct { KeyRotationStatus *bool // The state of the KMS key. Valid values are as follows: + // // - 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 - // your existing key management infrastructure or the KMS key lacks key material. + // 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 // cluster associated with a custom key store. Origin *string @@ -8818,16 +9601,21 @@ type AwsLambdaFunctionDetails struct { // key. KmsKeyArn *string - // Indicates when the function was last updated. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the function was last updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastModified *string @@ -8932,27 +9720,39 @@ type AwsLambdaFunctionVpcConfig struct { // Details about a Lambda layer version. type AwsLambdaLayerVersionDetails struct { - // The layer's compatible function runtimes (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) - // . 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) - // in the Lambda Developer Guide. Array Members: Maximum number of 5 items. Valid - // Values: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x - // | nodejs14.x | nodejs16.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | - // python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | + // The layer's compatible [function runtimes]. + // + // The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy] in + // the Lambda Developer Guide. + // + // Array Members: Maximum number of 5 items. + // + // Valid Values: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | + // nodejs12.x | nodejs14.x | nodejs16.x | java8 | java8.al2 | java11 | python2.7 | + // python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | // dotnetcore2.1 | dotnetcore3.1 | dotnet6 | nodejs4.3-edge | go1.x | ruby2.5 | // ruby2.7 | provided | provided.al2 | nodejs18.x | python3.10 | java17 | ruby3.2 | // python3.11 | nodejs20.x | provided.al2023 | python3.12 | java21 + // + // [function runtimes]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html + // [Runtime deprecation policy]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy CompatibleRuntimes []string - // Indicates when the version was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the version was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedDate *string @@ -8979,13 +9779,13 @@ type AwsMountPoint struct { // Provides details about different modes of client authentication. type AwsMskClusterClusterInfoClientAuthenticationDetails struct { - // Provides details for client authentication using SASL. + // Provides details for client authentication using SASL. Sasl *AwsMskClusterClusterInfoClientAuthenticationSaslDetails - // Provides details for client authentication using TLS. + // Provides details for client authentication using TLS. Tls *AwsMskClusterClusterInfoClientAuthenticationTlsDetails - // Provides details for allowing no client authentication. + // Provides details for allowing no client authentication. Unauthenticated *AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails noSmithyDocumentSerde @@ -8994,10 +9794,10 @@ type AwsMskClusterClusterInfoClientAuthenticationDetails struct { // Provides details for client authentication using SASL. type AwsMskClusterClusterInfoClientAuthenticationSaslDetails struct { - // Provides details for SASL client authentication using IAM. + // Provides details for SASL client authentication using IAM. Iam *AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails - // Details for SASL client authentication using SCRAM. + // Details for SASL client authentication using SCRAM. Scram *AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails noSmithyDocumentSerde @@ -9006,7 +9806,7 @@ type AwsMskClusterClusterInfoClientAuthenticationSaslDetails struct { // Details for SASL/IAM client authentication. type AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails struct { - // Indicates whether SASL/IAM authentication is enabled or not. + // Indicates whether SASL/IAM authentication is enabled or not. Enabled *bool noSmithyDocumentSerde @@ -9015,7 +9815,7 @@ type AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails struct { // Details for SASL/SCRAM client authentication. type AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails struct { - // Indicates whether SASL/SCRAM authentication is enabled or not. + // Indicates whether SASL/SCRAM authentication is enabled or not. Enabled *bool noSmithyDocumentSerde @@ -9024,13 +9824,13 @@ type AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails struct { // Provides details for client authentication using TLS. type AwsMskClusterClusterInfoClientAuthenticationTlsDetails struct { - // List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon Web - // Services Private CA enables creation of private certificate authority (CA) + // List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon + // Web Services Private CA enables creation of private certificate authority (CA) // hierarchies, including root and subordinate CAs, without the investment and // maintenance costs of operating an on-premises CA. CertificateAuthorityArnList []string - // Indicates whether TLS authentication is enabled or not. + // Indicates whether TLS authentication is enabled or not. Enabled *bool noSmithyDocumentSerde @@ -9039,59 +9839,62 @@ type AwsMskClusterClusterInfoClientAuthenticationTlsDetails struct { // Provides details for allowing no client authentication. type AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails struct { - // Indicates whether unauthenticated is allowed or not. + // Indicates whether unauthenticated is allowed or not. Enabled *bool noSmithyDocumentSerde } -// Provide details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) -// cluster. +// Provide details about an Amazon Managed Streaming for Apache Kafka (Amazon +// +// MSK) cluster. type AwsMskClusterClusterInfoDetails struct { - // Provides information for different modes of client authentication. + // Provides information for different modes of client authentication. ClientAuthentication *AwsMskClusterClusterInfoClientAuthenticationDetails - // The name of the cluster. + // The name of the cluster. ClusterName *string - // The current version of the cluster. + // The current version of the cluster. CurrentVersion *string - // Includes encryption-related information, such as the KMS key used for + // Includes encryption-related information, such as the KMS key used for // encrypting data at rest and whether you want Amazon MSK to encrypt your data in // transit. EncryptionInfo *AwsMskClusterClusterInfoEncryptionInfoDetails - // Specifies the level of monitoring for the cluster. + // Specifies the level of monitoring for the cluster. EnhancedMonitoring *string - // The number of broker nodes in the cluster. + // The number of broker nodes in the cluster. NumberOfBrokerNodes *int32 noSmithyDocumentSerde } -// Includes encryption-related information, such as the KMS key used for +// Includes encryption-related information, such as the KMS key used for +// // encrypting data at rest and whether you want MSK to encrypt your data in // transit. type AwsMskClusterClusterInfoEncryptionInfoDetails struct { - // The data-volume encryption details. You can't update encryption at rest + // The data-volume encryption details. You can't update encryption at rest // settings for existing clusters. EncryptionAtRest *AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails - // The settings for encrypting data in transit. + // The settings for encrypting data in transit. EncryptionInTransit *AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails noSmithyDocumentSerde } -// The data-volume encryption details. You can't update encryption at rest +// The data-volume encryption details. You can't update encryption at rest +// // settings for existing clusters. type AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails struct { - // The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If + // The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If // you don't specify a KMS key, MSK creates one for you and uses it. DataVolumeKMSKeyId *string @@ -9101,11 +9904,11 @@ type AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails struct { // The settings for encrypting data in transit. type AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails struct { - // Indicates the encryption setting for data in transit between clients and + // Indicates the encryption setting for data in transit between clients and // brokers. ClientBroker *string - // When set to true , it indicates that data communication among the broker nodes + // 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 // plain text. The default value is true . InCluster *bool @@ -9113,11 +9916,12 @@ type AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails struct { noSmithyDocumentSerde } -// Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon +// Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon +// // MSK) cluster. type AwsMskClusterDetails struct { - // Provides information about a cluster. + // Provides information about a cluster. ClusterInfo *AwsMskClusterClusterInfoDetails noSmithyDocumentSerde @@ -9196,8 +10000,9 @@ type AwsNetworkFirewallFirewallSubnetMappingsDetails struct { // Details about an Network Firewall rule group. Rule groups are used to inspect // and control network traffic. Stateless rule groups apply to individual packets. -// Stateful rule groups apply to packets in the context of their traffic flow. Rule -// groups are referenced in firewall policies. +// Stateful rule groups apply to packets in the context of their traffic flow. +// +// Rule groups are referenced in firewall policies. type AwsNetworkFirewallRuleGroupDetails struct { // The maximum number of operating resources that this rule group can use. @@ -9251,16 +10056,20 @@ 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) - // in the Amazon OpenSearch Service Developer Guide. + // The instance type for your data nodes. + // + // For a list of valid values, see [Supported instance types in Amazon OpenSearch Service] in the Amazon OpenSearch Service Developer + // Guide. + // + // [Supported instance types in Amazon OpenSearch Service]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html InstanceType *string // The number of UltraWarm instances. @@ -9317,8 +10126,10 @@ type AwsOpenSearchServiceDomainDetails struct { // Additional options for the domain endpoint. 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. + // 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. DomainEndpoints map[string]string // The name of the endpoint. @@ -9461,10 +10272,15 @@ 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 UpdateStatus *string @@ -9493,8 +10309,11 @@ type AwsRdsDbClusterAssociatedRole struct { // The status of the association between the IAM role and the DB cluster. Valid // values are as follows: + // // - ACTIVE + // // - INVALID + // // - PENDING Status *string @@ -9505,9 +10324,13 @@ type AwsRdsDbClusterAssociatedRole struct { type AwsRdsDbClusterDetails struct { // The status of the database activity stream. Valid values are as follows: + // // - started + // // - starting + // // - stopped + // // - stopping ActivityStreamStatus *string @@ -9518,7 +10341,7 @@ type AwsRdsDbClusterDetails struct { // A list of the IAM roles that are associated with the DB cluster. AssociatedRoles []AwsRdsDbClusterAssociatedRole - // Indicates if minor version upgrades are automatically applied to the cluster. + // Indicates if minor version upgrades are automatically applied to the cluster. AutoMinorVersionUpgrade *bool // A list of Availability Zones (AZs) where instances in the DB cluster can be @@ -9529,15 +10352,20 @@ type AwsRdsDbClusterDetails struct { BackupRetentionPeriod *int32 // Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). + // // This field accepts only the specified formats. Timestamps can end with Z or // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ClusterCreateTime *string @@ -9592,16 +10420,24 @@ 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 Engine *string // The database engine mode of the DB cluster.Valid values are as follows: + // // - global + // // - multimaster + // // - parallelquery + // // - provisioned + // // - serverless EngineMode *string @@ -9632,12 +10468,19 @@ 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. @@ -9689,16 +10532,17 @@ type AwsRdsDbClusterOptionGroupMembership struct { noSmithyDocumentSerde } -// Contains the name and values of a manual Amazon Relational Database Service +// Contains the name and values of a manual Amazon Relational Database Service +// // (RDS) DB cluster snapshot attribute. type AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute struct { - // The name of the manual DB cluster snapshot attribute. The attribute named + // The name of the manual DB cluster 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. AttributeName *string - // The value(s) for the manual DB cluster snapshot attribute. If the AttributeName + // 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 // 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 @@ -9719,15 +10563,20 @@ type AwsRdsDbClusterSnapshotDetails struct { AvailabilityZones []string // Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). + // // This field accepts only the specified formats. Timestamps can end with Z or // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ClusterCreateTime *string @@ -9735,7 +10584,7 @@ type AwsRdsDbClusterSnapshotDetails struct { // The DB cluster identifier. DbClusterIdentifier *string - // Contains the name and values of a manual DB cluster snapshot attribute. + // Contains the name and values of a manual DB cluster snapshot attribute. DbClusterSnapshotAttributes []AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute // The identifier of the DB cluster snapshot. @@ -9766,15 +10615,21 @@ type AwsRdsDbClusterSnapshotDetails struct { // The port number on which the DB instances in the DB cluster accept connections. Port *int32 - // Indicates when the snapshot was taken. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the snapshot was taken. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) SnapshotCreateTime *string @@ -9824,9 +10679,12 @@ type AwsRdsDbInstanceAssociatedRole struct { // 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. @@ -9874,11 +10732,17 @@ type AwsRdsDbInstanceDetails struct { DBInstanceIdentifier *string // The meaning of this parameter differs according to the database engine you use. - // MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database - // of this instance that was provided at create time, if one was specified when the - // DB instance was created. This same name is returned for the life of the DB - // instance. Oracle Contains the Oracle System ID (SID) of the created DB instance. - // Not shown when the returned parameters do not apply to an Oracle DB instance. + // + // MySQL, MariaDB, SQL Server, PostgreSQL + // + // Contains the name of the initial database of this instance that was provided at + // create time, if one was specified when the DB instance was created. This same + // name is returned for the life of the DB instance. + // + // Oracle + // + // Contains the Oracle System ID (SID) of the created DB instance. Not shown when + // the returned parameters do not apply to an Oracle DB instance. DBName *string // Specifies the port that the DB instance listens on. If the DB instance is part @@ -9902,8 +10766,9 @@ type AwsRdsDbInstanceDetails struct { // 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. @@ -9927,23 +10792,32 @@ type AwsRdsDbInstanceDetails struct { EnhancedMonitoringResourceArn *string // 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. + // 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 IAMDatabaseAuthenticationEnabled *bool - // Indicates when the DB instance was created. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the DB instance was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) InstanceCreateTime *string @@ -9956,15 +10830,21 @@ type AwsRdsDbInstanceDetails struct { KmsKeyId *string // Specifies the latest time to which a database can be restored with - // point-in-time restore. This field accepts only the specified formats. Timestamps - // can end with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac - // after seconds is limited to a maximum of 9 digits. The offset is bounded by - // +/-18:00. Here are valid timestamp formats with examples: + // point-in-time restore. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LatestRestorableTime *string @@ -10009,12 +10889,19 @@ 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 @@ -10025,10 +10912,13 @@ type AwsRdsDbInstanceDetails struct { // failure of the existing primary instance. PromotionTier *int32 - // Specifies the accessibility options for the DB instance. A value of true - // specifies an Internet-facing instance with a publicly resolvable DNS name, which - // resolves to a public IP address. A value of false specifies an internal instance - // with a DNS name that resolves to a private IP address. + // Specifies the accessibility options for the DB instance. + // + // A value of true specifies an Internet-facing instance with a publicly + // resolvable DNS name, which resolves to a public IP address. + // + // A value of false specifies an internal instance with a DNS name that resolves + // to a private IP address. PubliclyAccessible *bool // List of identifiers of Aurora DB clusters to which the RDS DB instance is @@ -10267,19 +11157,33 @@ type AwsRdsDbSnapshotDetails struct { // 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 @@ -10336,8 +11240,11 @@ type AwsRdsDbSnapshotDetails struct { Status *string // The storage type associated with the DB snapshot. Valid values are as follows: + // // - gp2 + // // - io1 + // // - standard StorageType *string @@ -10449,20 +11356,27 @@ type AwsRdsEventSubscriptionDetails struct { // The source type for the event notification subscription. SourceType *string - // The status of the event notification subscription. Valid values: creating | - // modifying | deleting | active | no-permission | topic-not-exist + // The status of the event notification subscription. + // + // Valid values: creating | modifying | deleting | active | no-permission | + // topic-not-exist Status *string - // The datetime when the event notification subscription was created. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // The datetime when the event notification subscription was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) SubscriptionCreationTime *string @@ -10521,8 +11435,10 @@ type AwsRedshiftClusterClusterParameterStatus struct { // 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 + // applied. + // + // Valid values: in-sync | pending-reboot | applying | invalid-parameter | + // apply-deferred | apply-error | unknown-error ParameterApplyStatus *string // The name of the parameter. @@ -10553,9 +11469,11 @@ 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 @@ -10572,16 +11490,21 @@ type AwsRedshiftClusterClusterSnapshotCopyStatus struct { // cluster. type AwsRedshiftClusterDeferredMaintenanceWindow struct { - // The end of the time window for which maintenance was deferred. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // The end of the time window for which maintenance was deferred. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) DeferMaintenanceEndTime *string @@ -10589,16 +11512,21 @@ type AwsRedshiftClusterDeferredMaintenanceWindow struct { // The identifier of the maintenance window. DeferMaintenanceIdentifier *string - // The start of the time window for which maintenance was deferred. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // The start of the time window for which maintenance was deferred. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) DeferMaintenanceStartTime *string @@ -10621,24 +11549,35 @@ 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. ClusterAvailabilityStatus *string - // Indicates when the cluster was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the cluster was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ClusterCreateTime *string @@ -10665,12 +11604,13 @@ type AwsRedshiftClusterDetails struct { // cross-Region snapshot copy. ClusterSnapshotCopyStatus *AwsRedshiftClusterClusterSnapshotCopyStatus - // The current status of the cluster. Valid values: 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 + // The current status of the cluster. + // + // Valid values: 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 @@ -10681,8 +11621,11 @@ type AwsRedshiftClusterDetails struct { ClusterVersion *string // The name of the initial database that was created when the cluster was created. - // The same name is returned for the life of the cluster. If an initial database is - // not specified, a database named devdev is created by default. + // + // The same name is returned for the life of the cluster. + // + // If an initial database is not specified, a database named devdev is created by + // default. DBName *string // List of time windows during which maintenance was deferred. @@ -10705,21 +11648,28 @@ type AwsRedshiftClusterDetails struct { EnhancedVpcRouting *bool // Indicates when the next snapshot is expected to be taken. The cluster must have - // a valid snapshot schedule and have backups enabled. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // a valid snapshot schedule and have backups enabled. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ExpectedNextSnapshotScheduleTime *string - // The status of the next expected snapshot. Valid values: OnTrack | Pending + // The status of the next expected snapshot. + // + // Valid values: OnTrack | Pending ExpectedNextSnapshotScheduleTimeStatus *string // Information about whether the Amazon Redshift cluster finished applying any @@ -10741,26 +11691,34 @@ 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 - // 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 + // 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 . MasterUsername *string - // Indicates the start of the next maintenance window. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates the start of the next maintenance window. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) NextMaintenanceWindowStartTime *string @@ -10778,8 +11736,13 @@ 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 - // | wed | thu | fri | sat | sun For example, sun:09:32-sun:10:02 + // 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 // Whether the cluster can be accessed from a public network. @@ -10795,8 +11758,9 @@ type AwsRedshiftClusterDetails struct { // A unique identifier for the cluster snapshot schedule. SnapshotScheduleIdentifier *string - // The current state of the cluster snapshot schedule. Valid values: MODIFYING | - // ACTIVE | FAILED + // The current state of the cluster snapshot schedule. + // + // Valid values: MODIFYING | ACTIVE | FAILED SnapshotScheduleState *string // The identifier of the VPC that the cluster is in, if the cluster is in a VPC. @@ -10847,8 +11811,11 @@ type AwsRedshiftClusterHsmStatus struct { HsmConfigurationIdentifier *string // Indicates whether the Amazon Redshift cluster has finished applying any HSM - // settings changes specified in a modify cluster command. Type: String Valid - // values: active | applying + // settings changes specified in a modify cluster command. + // + // Type: String + // + // Valid values: active | applying Status *string noSmithyDocumentSerde @@ -10858,8 +11825,9 @@ type AwsRedshiftClusterHsmStatus struct { // services. type AwsRedshiftClusterIamRole struct { - // The status of the IAM role's association with the cluster. Valid values: in-sync - // | adding | removing + // The status of the IAM role's association with the cluster. + // + // Valid values: in-sync | adding | removing ApplyStatus *string // The ARN of the IAM role. @@ -10877,30 +11845,40 @@ type AwsRedshiftClusterLoggingStatus struct { // The message indicating that the logs failed to be delivered. LastFailureMessage *string - // The last time when logs failed to be delivered. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The last time when logs failed to be delivered. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastFailureTime *string - // The last time that logs were delivered successfully. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The last time that logs were delivered successfully. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastSuccessfulDeliveryTime *string @@ -10961,7 +11939,9 @@ type AwsRedshiftClusterResizeInfo struct { // Indicates whether the resize operation can be canceled. AllowCancelResize *bool - // The type of resize operation. Valid values: ClassicResize + // The type of resize operation. + // + // Valid values: ClassicResize ResizeType *string noSmithyDocumentSerde @@ -10972,30 +11952,36 @@ type AwsRedshiftClusterResizeInfo struct { type AwsRedshiftClusterRestoreStatus struct { // The number of megabytes per second being transferred from the backup storage. - // Returns the average rate for a completed backup. This field is only updated when - // you restore to DC2 and DS2 node types. + // Returns the average rate for a completed backup. + // + // This field is only updated when you restore to DC2 and DS2 node types. CurrentRestoreRateInMegaBytesPerSecond *float64 // The amount of time an in-progress restore has been running, or the amount of - // time it took a completed restore to finish. This field is only updated when you - // restore to DC2 and DS2 node types. + // time it took a completed restore to finish. + // + // This field is only updated when you 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. + // 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 - // is only updated when you restore to DC2 and DS2 node types. + // The number of megabytes that were transferred from snapshot storage. + // + // This field is only updated when you restore to DC2 and DS2 node types. ProgressInMegaBytes *int64 - // The size of the set of snapshot data that was used to restore the cluster. This - // field is only updated when you restore to DC2 and DS2 node types. + // The size of the set of snapshot data that was used to restore the cluster. + // + // This field is only updated when you restore to DC2 and DS2 node types. SnapshotSizeInMegaBytes *int64 - // The status of the restore action. Valid values: starting | restoring | completed - // | failed + // The status of the restore action. + // + // Valid values: starting | restoring | completed | failed Status *string noSmithyDocumentSerde @@ -11013,35 +11999,37 @@ type AwsRedshiftClusterVpcSecurityGroup struct { noSmithyDocumentSerde } -// An object that contains an optional comment about your Amazon Route 53 hosted +// An object that contains an optional comment about your Amazon Route 53 hosted +// // zone. type AwsRoute53HostedZoneConfigDetails struct { - // Any comments that you include about the hosted zone. + // Any comments that you include about the hosted zone. Comment *string noSmithyDocumentSerde } -// Provides details about a specified Amazon Route 53 hosted zone, including the +// Provides details about a specified Amazon Route 53 hosted zone, including the +// // four name servers assigned to the hosted zone. A hosted zone represents a // collection of records that can be managed together, belonging to a single parent // domain name. type AwsRoute53HostedZoneDetails struct { - // An object that contains information about the specified hosted zone. + // An object that contains information about the specified hosted zone. HostedZone *AwsRoute53HostedZoneObjectDetails - // An object that contains a list of the authoritative name servers for a hosted + // An object that contains a list of the authoritative name servers for a hosted // zone or for a reusable delegation set. NameServers []string - // An array that contains one QueryLoggingConfig element for each DNS query + // An array that contains one QueryLoggingConfig element for each DNS query // logging configuration that is associated with the current Amazon Web Services // account. QueryLoggingConfig *AwsRoute53QueryLoggingConfigDetails - // An object that contains information about the Amazon Virtual Private Clouds + // An object that contains information about the Amazon Virtual Private Clouds // (Amazon VPCs) that are associated with the specified hosted zone. Vpcs []AwsRoute53HostedZoneVpcDetails @@ -11051,73 +12039,76 @@ type AwsRoute53HostedZoneDetails struct { // An object that contains information about an Amazon Route 53 hosted zone. type AwsRoute53HostedZoneObjectDetails struct { - // An object that includes the Comment element. + // An object that includes the Comment element. Config *AwsRoute53HostedZoneConfigDetails - // The ID that Route 53 assigns to the hosted zone when you create it. + // The ID that Route 53 assigns to the hosted zone when you create it. Id *string - // The name of the domain. For public hosted zones, this is the name that you have - // registered with your DNS registrar. + // The name of the domain. For public hosted zones, this is the name that you + // have registered with your DNS registrar. Name *string noSmithyDocumentSerde } -// For private hosted zones, this is a complex type that contains information +// For private hosted zones, this is a complex type that contains information +// // about an Amazon VPC. type AwsRoute53HostedZoneVpcDetails struct { - // The identifier of an Amazon VPC. + // The identifier of an Amazon VPC. Id *string - // The Amazon Web Services Region that an Amazon VPC was created in. + // The Amazon Web Services Region that an Amazon VPC was created in. Region *string noSmithyDocumentSerde } -// Provides details about a specified Amazon Route 53 configuration for DNS query +// Provides details about a specified Amazon Route 53 configuration for DNS query +// // logging. type AwsRoute53QueryLoggingConfigDetails struct { - // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that + // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that // Route 53 is publishing logs to. CloudWatchLogsLogGroupArn *CloudWatchLogsLogGroupArnConfigDetails noSmithyDocumentSerde } -// Returns configuration information about the specified Amazon S3 access point. +// Returns configuration information about the specified Amazon S3 access point. +// // S3 access points are named network endpoints that are attached to buckets that // you can use to perform S3 object operations. type AwsS3AccessPointDetails struct { - // The Amazon Resource Name (ARN) of the access point. + // The Amazon Resource Name (ARN) of the access point. AccessPointArn *string - // The name or alias of the access point. + // The name or alias of the access point. Alias *string - // The name of the S3 bucket associated with the specified access point. + // The name of the S3 bucket associated with the specified access point. Bucket *string - // The Amazon Web Services account ID associated with the S3 bucket associated + // The Amazon Web Services account ID associated with the S3 bucket associated // with this access point. BucketAccountId *string - // The name of the specified access point. + // The name of the specified access point. Name *string - // Indicates whether this access point allows access from the public internet. + // Indicates whether this access point allows access from the public internet. NetworkOrigin *string // provides information about the Amazon S3 Public Access Block configuration for // accounts. PublicAccessBlockConfiguration *AwsS3AccountPublicAccessBlockDetails - // Contains the virtual private cloud (VPC) configuration for the specified access - // point. + // Contains the virtual private cloud (VPC) configuration for the specified + // access point. VpcConfiguration *AwsS3AccessPointVpcConfigurationDetails noSmithyDocumentSerde @@ -11126,7 +12117,7 @@ type AwsS3AccessPointDetails struct { // The virtual private cloud (VPC) configuration for an Amazon S3 access point. type AwsS3AccessPointVpcConfigurationDetails struct { - // If this field is specified, this access point will only allow connections from + // If this field is specified, this access point will only allow connections from // the specified VPC ID. VpcId *string @@ -11182,16 +12173,21 @@ type AwsS3BucketBucketLifecycleConfigurationRulesDetails struct { // provides a number of days before Amazon S3 cancels the entire upload. AbortIncompleteMultipartUpload *AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails - // The date when objects are moved or deleted. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // The date when objects are moved or deleted. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ExpirationDate *string @@ -11201,8 +12197,10 @@ type AwsS3BucketBucketLifecycleConfigurationRulesDetails struct { // 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 . + // no action. + // + // If you provide ExpiredObjectDeleteMarker , you cannot provide ExpirationInDays + // or ExpirationDate . ExpiredObjectDeleteMarker *bool // Identifies the objects that a rule applies to. @@ -11320,15 +12318,21 @@ 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 . This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // provide Date , you cannot provide Days . + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) Date *string @@ -11338,10 +12342,15 @@ type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails struct { Days *int32 // The storage class to transition the object to. Valid values are as follows: + // // - DEEP_ARCHIVE + // // - GLACIER + // // - INTELLIGENT_TIERING + // // - ONEZONE_IA + // // - STANDARD_IA StorageClass *string @@ -11383,24 +12392,30 @@ type AwsS3BucketDetails struct { // The website configuration parameters for the S3 bucket. BucketWebsiteConfiguration *AwsS3BucketWebsiteConfiguration - // Indicates when the S3 bucket was created. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the S3 bucket was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) CreatedAt *string - // The name of the bucket. + // The name of the bucket. Name *string - // Specifies which rule Amazon S3 applies by default to every new object placed in - // the bucket. + // Specifies which rule Amazon S3 applies by default to every new object placed + // in the bucket. ObjectLockConfiguration *AwsS3BucketObjectLockConfiguration // The Amazon Web Services account identifier of the account that owns the S3 @@ -11460,8 +12475,11 @@ 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 Type *string @@ -11500,44 +12518,47 @@ type AwsS3BucketNotificationConfigurationS3KeyFilterRule struct { noSmithyDocumentSerde } -// The container element for S3 Object Lock configuration parameters. In Amazon +// 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 { - // Indicates whether the bucket has an Object Lock configuration enabled. + // Indicates whether the bucket has an Object Lock configuration enabled. ObjectLockEnabled *string - // Specifies the Object Lock rule for the specified object. + // Specifies the Object Lock rule for the specified object. Rule *AwsS3BucketObjectLockConfigurationRuleDetails noSmithyDocumentSerde } -// The default S3 Object Lock retention mode and period that you want to apply to +// The default S3 Object Lock retention mode and period that you want to apply to +// // new objects placed in the specified Amazon S3 bucket. type AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails struct { - // The number of days that you want to specify for the default retention period. + // The number of days that you want to specify for the default retention period. Days *int32 - // The default Object Lock retention mode you want to apply to new objects placed + // The default Object Lock retention mode you want to apply to new objects placed // in the specified bucket. Mode *string - // The number of years that you want to specify for the default retention period. + // The number of years that you want to specify for the default retention period. Years *int32 noSmithyDocumentSerde } -// Specifies the S3 Object Lock rule for the specified object. In Amazon S3, +// 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 - // objects placed in the specified bucket. + // The default Object Lock retention mode and period that you want to apply to + // new objects placed in the specified bucket. DefaultRetention *AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails noSmithyDocumentSerde @@ -11645,12 +12666,14 @@ type AwsS3BucketWebsiteConfigurationRoutingRuleRedirect struct { // the original request. Protocol *string - // The object key prefix to use in the redirect request. Cannot be provided if - // ReplaceKeyWith is present. + // The object key prefix to use in the redirect request. + // + // Cannot be provided if ReplaceKeyWith is present. ReplaceKeyPrefixWith *string - // The specific object key to use in the redirect request. Cannot be provided if - // ReplaceKeyPrefixWith is present. + // The specific object key to use in the redirect request. + // + // Cannot be provided if ReplaceKeyPrefixWith is present. ReplaceKeyWith *string noSmithyDocumentSerde @@ -11666,16 +12689,21 @@ type AwsS3ObjectDetails struct { // resource found at a URL. ETag *string - // Indicates when the object was last modified. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the object was last modified. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastModified *string @@ -11697,99 +12725,105 @@ 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 + // 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. + // 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]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]in the Amazon + // SageMaker Developer Guide. + // + // [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 AdditionalCodeRepositories []string - // The Git repository associated with the notebook instance as its default code + // 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]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]in the Amazon SageMaker + // Developer Guide. + // + // [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 DefaultCodeRepository *string - // Sets whether SageMaker provides internet access to the notebook instance. If + // 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. + // Information on the IMDS configuration of the notebook instance. InstanceMetadataServiceConfiguration *AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails - // The type of machine learning (ML) compute instance to launch for the notebook + // The type of machine learning (ML) compute instance to launch for the notebook // instance. InstanceType *string - // The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that + // 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]in the + // Key Management Service Developer Guide. + // + // [Enabling and disabling keys]: https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html KmsKeyId *string - // The network interface ID that SageMaker created when the instance was created. + // The network interface ID that SageMaker created when the instance was created. NetworkInterfaceId *string - // The Amazon Resource Name (ARN) of the notebook instance. + // The Amazon Resource Name (ARN) of the notebook instance. NotebookInstanceArn *string - // The name of a notebook instance lifecycle configuration. + // The name of a notebook instance lifecycle configuration. NotebookInstanceLifecycleConfigName *string - // The name of the new notebook instance. + // The name of the new notebook instance. NotebookInstanceName *string - // The status of the notebook instance. + // The status of the notebook instance. NotebookInstanceStatus *string - // The platform identifier of the notebook instance runtime environment. + // The platform identifier of the notebook instance runtime environment. PlatformIdentifier *string - // The Amazon Resource Name (ARN) of the IAM role associated with the instance. + // The Amazon Resource Name (ARN) of the IAM role associated with the instance. RoleArn *string - // Whether root access is enabled or disabled for users of the notebook instance. + // Whether root access is enabled or disabled for users of the notebook instance. RootAccess *string - // The VPC security group IDs. + // The VPC security group IDs. SecurityGroups []string - // The ID of the VPC subnet to which you have a connectivity from your ML compute + // The ID of the VPC subnet to which you have a connectivity from your ML compute // instance. SubnetId *string - // The URL that you use to connect to the Jupyter notebook that is running in your - // notebook instance. + // The URL that you use to connect to the Jupyter notebook that is running in + // your notebook instance. Url *string - // The size, in GB, of the ML storage volume to attach to the notebook instance. + // The size, in GB, of the ML storage volume to attach to the notebook instance. VolumeSizeInGB *int32 noSmithyDocumentSerde } -// Information on the instance metadata service (IMDS) configuration of the +// Information on the instance metadata service (IMDS) configuration of the +// // notebook instance. type AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails struct { - // Indicates the minimum IMDS version that the notebook instance supports. + // Indicates the minimum IMDS version that the notebook instance supports. MinimumInstanceMetadataServiceVersion *string noSmithyDocumentSerde @@ -11837,9 +12871,10 @@ type AwsSecretsManagerSecretRotationRules struct { // Provides a consistent format for Security Hub findings. AwsSecurityFinding // format allows you to share findings between Amazon Web Services security -// services and third-party solutions. A finding is a potential security issue -// generated either by Amazon Web Services services or by the integrated -// third-party solutions and standards checks. +// services and third-party solutions. +// +// A finding is a potential security issue generated either by Amazon Web Services +// services or by the integrated third-party solutions and standards checks. type AwsSecurityFinding struct { // The Amazon Web Services account ID that a finding is generated in. @@ -11848,22 +12883,30 @@ type AwsSecurityFinding struct { AwsAccountId *string // Indicates when the security findings provider created the potential security - // issue that a finding captured. This field accepts only the specified formats. - // Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . The - // time-secfrac after seconds is limited to a maximum of 9 digits. The offset is - // bounded by +/-18:00. Here are valid timestamp formats with examples: + // issue that a finding captured. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) // // This member is required. CreatedAt *string - // A finding's description. In this release, Description is a required property. + // A finding's description. + // + // In this release, Description is a required property. // // This member is required. Description *string @@ -11898,21 +12941,28 @@ type AwsSecurityFinding struct { // This member is required. SchemaVersion *string - // A finding's title. In this release, Title is a required property. + // A finding's title. + // + // In this release, Title is a required property. // // This member is required. Title *string // Indicates when the security findings provider last updated the finding record. + // // This field accepts only the specified formats. Timestamps can end with Z or // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) // @@ -11925,11 +12975,14 @@ type AwsSecurityFinding struct { // The name of the Amazon Web Services account from which a finding was generated. AwsAccountName *string - // 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 @@ -11940,11 +12993,13 @@ type AwsSecurityFinding struct { // A finding's confidence. Confidence is defined as the likelihood that a finding // accurately identifies the behavior or issue that it was intended to identify. + // // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero // 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. Criticality *int32 @@ -11955,15 +13010,21 @@ type AwsSecurityFinding struct { FindingProviderFields *FindingProviderFields // Indicates when the security findings provider first observed the potential - // security issue that a finding captured. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // security issue that a finding captured. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) FirstObservedAt *string @@ -11976,16 +13037,21 @@ type AwsSecurityFinding struct { GeneratorDetails *GeneratorDetails // Indicates when the security findings provider most recently observed the - // potential security issue that a finding captured. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // potential security issue that a finding captured. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastObservedAt *string @@ -12011,39 +13077,50 @@ type AwsSecurityFinding struct { Process *ProcessDetails // A imestamp that indicates when Security Hub received a finding and begins to - // process it. This field accepts only the specified formats. Timestamps can end - // with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // process it. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ProcessedAt *string // A data type where security findings providers can include additional // solution-specific details that aren't part of the defined AwsSecurityFinding - // format. Can contain up to 50 key-value pairs. For each key-value pair, the key - // can contain up to 128 characters, and the value can contain up to 2048 - // characters. + // format. + // + // Can contain up to 50 key-value pairs. For each key-value pair, the key can + // contain up to 128 characters, and the value can contain up to 2048 characters. ProductFields map[string]string - // 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 - // integration. When you use the Security Hub console or API to filter findings by - // product name, you use this attribute. + // 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 integration. + // + // When you use the Security Hub console or API to filter findings by product + // name, you use this attribute. ProductName *string // The record state of a finding. RecordState RecordState - // 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 . + // 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 . Region *string // A list of related findings. @@ -12070,8 +13147,10 @@ type AwsSecurityFinding struct { Threats []Threat // One or more finding types in the format of namespace/category/classifier that - // classify a finding. Valid namespace values are: Software and Configuration - // Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications + // classify a finding. + // + // Valid namespace values are: 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 @@ -12097,8 +13176,10 @@ type AwsSecurityFinding struct { } // A collection of filters that are applied to all active findings aggregated by -// Security Hub. You can filter by up to ten finding attributes. For each -// attribute, you can provide up to 20 filter values. +// Security Hub. +// +// You can filter by up to ten finding attributes. For each attribute, you can +// provide up to 20 filter values. type AwsSecurityFindingFilters struct { // The Amazon Web Services account ID in which a finding is generated. @@ -12111,20 +13192,21 @@ type AwsSecurityFindingFilters struct { // that generates findings. CompanyName []StringFilter - // The unique identifier of a standard in which a control is enabled. This field + // 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) - // API response. + // a standard in the [DescribeStandards]API response. + // + // [DescribeStandards]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html ComplianceAssociatedStandardsId []StringFilter - // The unique identifier of a control across standards. Values for this field + // The unique identifier of a control across standards. Values for this field // typically consist of an Amazon Web Service and a number, such as APIGateway.5. ComplianceSecurityControlId []StringFilter - // The name of a security control parameter. + // The name of a security control parameter. ComplianceSecurityControlParametersName []StringFilter - // The current value of a security control parameter. + // The current value of a security control parameter. ComplianceSecurityControlParametersValue []StringFilter // Exclusive to findings that are generated as the result of a check run against a @@ -12134,26 +13216,33 @@ type AwsSecurityFindingFilters struct { // A finding's confidence. Confidence is defined as the likelihood that a finding // accurately identifies the behavior or issue that it was intended to identify. + // // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero // percent confidence and 100 means 100 percent confidence. Confidence []NumberFilter // A timestamp that indicates when the security findings provider created the - // potential security issue that a finding reflects. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // potential security issue that a finding reflects. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) 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. Criticality []NumberFilter @@ -12163,15 +13252,17 @@ type AwsSecurityFindingFilters struct { // The finding provider value for the finding confidence. Confidence is defined as // the likelihood that a finding accurately identifies the behavior or issue that - // it was intended to identify. Confidence is scored on a 0-100 basis using a ratio - // scale, where 0 means zero percent confidence and 100 means 100 percent - // confidence. + // it was intended to identify. + // + // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero + // percent confidence and 100 means 100 percent 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. + // 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 @@ -12189,22 +13280,28 @@ type AwsSecurityFindingFilters struct { FindingProviderFieldsSeverityOriginal []StringFilter // One or more finding types that the finding provider assigned to the finding. - // Uses the format of namespace/category/classifier that classify a finding. Valid - // namespace values are: Software and Configuration Checks | TTPs | Effects | - // Unusual Behaviors | Sensitive Data Identifications + // Uses the format of namespace/category/classifier that classify a finding. + // + // Valid namespace values are: Software and Configuration Checks | TTPs | Effects + // | Unusual Behaviors | Sensitive Data Identifications FindingProviderFieldsTypes []StringFilter // A timestamp that indicates when the security findings provider first observed - // the potential security issue that a finding captured. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // the potential security issue that a finding captured. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) FirstObservedAt []DateFilter @@ -12223,16 +13320,21 @@ type AwsSecurityFindingFilters struct { Keyword []KeywordFilter // A timestamp that indicates when the security findings provider most recently - // observed the potential security issue that a finding captured. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // observed the potential security issue that a finding captured. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastObservedAt []DateFilter @@ -12292,16 +13394,21 @@ type AwsSecurityFindingFilters struct { // The principal that created a note. NoteUpdatedBy []StringFilter - // A timestamp that identifies when the process was launched. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that identifies when the process was launched. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ProcessLaunchedAt []DateFilter @@ -12319,16 +13426,21 @@ type AwsSecurityFindingFilters struct { // The process ID. ProcessPid []NumberFilter - // A timestamp that identifies when the process was terminated. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that identifies when the process was terminated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ProcessTerminatedAt []DateFilter @@ -12361,10 +13473,10 @@ type AwsSecurityFindingFilters struct { // The ARN of the solution that generated a related finding. RelatedFindingsProductArn []StringFilter - // The ARN of the application that is related to a finding. + // The ARN of the application that is related to a finding. ResourceApplicationArn []StringFilter - // The name of the application that is related to a finding. + // The name of the application that is related to a finding. ResourceApplicationName []StringFilter // The IAM profile ARN of the instance. @@ -12424,16 +13536,21 @@ type AwsSecurityFindingFilters struct { // The name of the image related to a finding. ResourceContainerImageName []StringFilter - // A timestamp that identifies when the container was started. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that identifies when the container was started. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) ResourceContainerLaunchedAt []DateFilter @@ -12512,15 +13629,21 @@ type AwsSecurityFindingFilters struct { Type []StringFilter // A timestamp that indicates when the security findings provider last updated the - // finding record. This field accepts only the specified formats. Timestamps can - // end with Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after - // seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. - // Here are valid timestamp formats with examples: + // finding record. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) UpdatedAt []DateFilter @@ -12532,44 +13655,66 @@ type AwsSecurityFindingFilters struct { // The veracity of a finding. VerificationState []StringFilter - // Indicates whether a software vulnerability in your environment has a known + // Indicates whether a software vulnerability in your environment has a known // exploit. You can filter findings by this field only if you use Security Hub and // Amazon Inspector. VulnerabilitiesExploitAvailable []StringFilter - // Indicates whether a vulnerability is fixed in a newer version of the affected + // Indicates whether a vulnerability is fixed in a newer version of the affected // software packages. You can filter findings by this field only if you use // Security Hub and Amazon Inspector. VulnerabilitiesFixAvailable []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 . + // The workflow state of a finding. + // + // Note that this field is deprecated. To search 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: + // + // - 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 : + // 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 . + // 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: + // 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 + // . + // + // 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 @@ -12728,11 +13873,17 @@ type AwsSsmComplianceSummary struct { NonCompliantUnspecifiedCount *int32 // The highest severity for the patches. Valid values are as follows: + // // - CRITICAL + // // - HIGH + // // - MEDIUM + // // - LOW + // // - INFORMATIONAL + // // - UNSPECIFIED OverallSeverity *string @@ -12746,8 +13897,11 @@ type AwsSsmComplianceSummary struct { PatchGroup *string // The current patch compliance status. Valid values are as follows: + // // - COMPLIANT + // // - NON_COMPLIANT + // // - UNSPECIFIED_DATA Status *string @@ -12773,43 +13927,46 @@ type AwsSsmPatchComplianceDetails struct { noSmithyDocumentSerde } -// Provides details about an Step Functions state machine, which is a workflow +// Provides details about an Step Functions state machine, which is a workflow +// // consisting of a series of event- driven steps. type AwsStepFunctionStateMachineDetails struct { - // A user-defined or an auto-generated string that identifies a Map state. This + // A user-defined or an auto-generated string that identifies a Map state. This // parameter is present only if the stateMachineArn specified in input is a // qualified state machine ARN. Label *string - // Used to set CloudWatch Logs options. + // Used to set CloudWatch Logs options. LoggingConfiguration *AwsStepFunctionStateMachineLoggingConfigurationDetails - // The name of the state machine. + // The name of the state machine. Name *string - // The Amazon Resource Name (ARN) of the IAM role used when creating this state + // The Amazon Resource Name (ARN) of the IAM role used when creating this state // machine. RoleArn *string - // The ARN that identifies the state machine. + // The ARN that identifies the state machine. StateMachineArn *string - // The current status of the state machine. + // The current status of the state machine. Status *string - // Specifies whether X-Ray tracing is enabled. + // Specifies whether X-Ray tracing is enabled. TracingConfiguration *AwsStepFunctionStateMachineTracingConfigurationDetails - // The type of the state machine (STANDARD or EXPRESS). + // The type of the state machine (STANDARD or EXPRESS). Type *string noSmithyDocumentSerde } -// An object describing a CloudWatch log group. For more information, see Amazon -// Web Services::Logs::LogGroup (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) -// in the CloudFormation User Guide. +// An object describing a CloudWatch log group. For more information, see [Amazon Web Services::Logs::LogGroup] in the +// +// CloudFormation User Guide. +// +// [Amazon Web Services::Logs::LogGroup]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html type AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails struct { // The ARN (ends with :* ) of the CloudWatch Logs log group to which you want your @@ -12819,13 +13976,15 @@ type AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLo noSmithyDocumentSerde } -// An array of objects that describes where your execution history events will be +// An array of objects that describes where your execution history events will be +// // logged. type AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails struct { - // An object describing a CloudWatch Logs log group. For more information, see - // Amazon Web Services::Logs::LogGroup (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html) + // An object describing a CloudWatch Logs log group. For more information, see [Amazon Web Services::Logs::LogGroup] // in the CloudFormation User Guide. + // + // [Amazon Web Services::Logs::LogGroup]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html CloudWatchLogsLogGroup *AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails noSmithyDocumentSerde @@ -12834,15 +13993,15 @@ type AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails struct { // The LoggingConfiguration data type is used to set CloudWatch Logs options. type AwsStepFunctionStateMachineLoggingConfigurationDetails struct { - // An array of objects that describes where your execution history events will be + // An array of objects that describes where your execution history events will be // logged. Destinations []AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails - // 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 - // Defines which category of execution history events are logged. + // Defines which category of execution history events are logged. Level *string noSmithyDocumentSerde @@ -12851,7 +14010,7 @@ type AwsStepFunctionStateMachineLoggingConfigurationDetails struct { // Specifies whether X-Ray tracing is enabled. type AwsStepFunctionStateMachineTracingConfigurationDetails struct { - // When set to true, X-Ray tracing is enabled. + // When set to true, X-Ray tracing is enabled. Enabled *bool noSmithyDocumentSerde @@ -12896,17 +14055,26 @@ type AwsWafRateBasedRuleMatchPredicate struct { 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 - // requests except those that match the predicate settings. + // 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 Type *string @@ -12952,17 +14120,26 @@ type AwsWafRegionalRateBasedRuleMatchPredicate struct { 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 - // requests except those that match the predicate settings. + // 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 Type *string @@ -13229,25 +14406,29 @@ type AwsWafRulePredicateListDetails struct { noSmithyDocumentSerde } -// Specifies that WAF should allow the request and optionally defines additional +// Specifies that WAF should allow the request and optionally defines additional +// // custom handling for the request. 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) - // in the WAF Developer Guide.. + // Defines custom handling for the web request. For information about customizing + // web requests and responses, see [Customizing web requests and responses in WAF]in the WAF Developer Guide.. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails noSmithyDocumentSerde } -// Specifies that WAF should block the request and optionally defines additional +// Specifies that WAF should block the request and optionally defines additional +// // custom handling for the response to the web request. 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) - // in the WAF Developer Guide.. + // Defines a custom response for the web request. For information, see [Customizing web requests and responses in WAF] in the + // WAF Developer Guide.. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponse *AwsWafv2CustomResponseDetails noSmithyDocumentSerde @@ -13256,42 +14437,44 @@ type AwsWafv2ActionBlockDetails struct { // A custom header for custom request and response handling. type AwsWafv2CustomHttpHeader struct { - // The name of the custom header. + // The name of the custom header. Name *string - // The value of the custom header. + // The value of the custom header. Value *string noSmithyDocumentSerde } -// Custom request handling behavior that inserts custom headers into a web +// 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. + // The HTTP headers to insert into the request. InsertHeaders []AwsWafv2CustomHttpHeader noSmithyDocumentSerde } -// A custom response to send to the client. You can define a custom response for +// 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 block. type AwsWafv2CustomResponseDetails struct { - // References the response body that you want WAF to return to the web request + // References the response body that you want WAF to return to the web request // client. You can define a custom response for a rule action or a default web ACL // action that is set to block. CustomResponseBodyKey *string - // 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. + // 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]in the WAF Developer Guide. + // + // [Supported status codes for custom response]: https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html ResponseCode *int32 - // The HTTP headers to use in the response. + // The HTTP headers to use in the response. ResponseHeaders []AwsWafv2CustomHttpHeader noSmithyDocumentSerde @@ -13300,34 +14483,35 @@ type AwsWafv2CustomResponseDetails struct { // Details about an WAFv2 rule group. type AwsWafv2RuleGroupDetails struct { - // The Amazon Resource Name (ARN) of the entity. + // The Amazon Resource Name (ARN) of the entity. Arn *string - // The web ACL capacity units (WCUs) required for this rule group. + // The web ACL capacity units (WCUs) required for this rule group. Capacity *int64 - // A description of the rule group that helps with identification. + // A description of the rule group that helps with identification. Description *string - // A unique identifier for the rule group. + // 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 + // 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, + // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that WAF uses to // 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 + // 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 - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. VisibilityConfig *AwsWafv2VisibilityConfigDetails noSmithyDocumentSerde @@ -13336,10 +14520,11 @@ type AwsWafv2RuleGroupDetails struct { // Specifies that WAF should run a CAPTCHA check against the request. type AwsWafv2RulesActionCaptchaDetails struct { - // Defines custom handling for the web request, used when the CAPTCHA inspection + // 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) - // in the WAF Developer Guide.. + // information, see [Customizing web requests and responses in WAF]in the WAF Developer Guide.. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails noSmithyDocumentSerde @@ -13348,111 +14533,121 @@ type AwsWafv2RulesActionCaptchaDetails struct { // Specifies that WAF should count the request. 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) - // in the WAF Developer Guide.. + // Defines custom handling for the web request. For more information, see [Customizing web requests and responses in WAF] in the + // WAF Developer Guide.. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *AwsWafv2CustomRequestHandlingDetails noSmithyDocumentSerde } -// The action that WAF should take on a web request when it matches a rule's +// The action that WAF should take on a web request when it matches a rule's +// // statement. Settings at the web ACL level can override the rule action setting. type AwsWafv2RulesActionDetails struct { - // Instructs WAF to allow the web request. + // Instructs WAF to allow the web request. Allow *AwsWafv2ActionAllowDetails - // Instructs WAF to block the web request. + // Instructs WAF to block the web request. Block *AwsWafv2ActionBlockDetails - // Instructs WAF to run a CAPTCHA check against the web request. + // Instructs WAF to run a CAPTCHA check against the web request. Captcha *AwsWafv2RulesActionCaptchaDetails - // Instructs WAF to count the web request and then continue evaluating the request - // using the remaining rules in the web ACL. + // Instructs WAF to count the web request and then continue evaluating the + // request using the remaining rules in the web ACL. Count *AwsWafv2RulesActionCountDetails noSmithyDocumentSerde } -// Provides details about rules in a rule group. A rule identifies web requests +// Provides details about rules in a rule group. A rule identifies web requests +// // that you want to allow, block, or count. Each rule includes one top-level // Statement that WAF uses to identify matching web requests, and parameters that // govern how WAF handles them. type AwsWafv2RulesDetails struct { - // The action that WAF should take on a web request when it matches the rule + // The action that WAF should take on a web request when it matches the rule // statement. Settings at the web ACL level can override the rule action setting. Action *AwsWafv2RulesActionDetails - // The name of the rule. + // The name of the rule. Name *string - // The action to use in the place of the action that results from the rule group + // The action to use in the place of the action that results from the rule group // evaluation. OverrideAction *string - // If you define more than one Rule in a WebACL, WAF evaluates each request + // 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. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. VisibilityConfig *AwsWafv2VisibilityConfigDetails noSmithyDocumentSerde } -// Defines and enables Amazon CloudWatch metrics and web request sample collection. +// Defines and enables Amazon CloudWatch metrics and web request sample +// +// collection. 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) - // in the WAF Developer Guide. + // A boolean indicating whether the associated resource sends metrics to Amazon + // CloudWatch. For the list of available metrics, see [WAF metrics and dimensions]in the WAF Developer Guide. + // + // [WAF metrics and dimensions]: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics CloudWatchMetricsEnabled *bool - // A name of the Amazon CloudWatch metric. + // A name of the Amazon CloudWatch metric. MetricName *string - // A boolean indicating whether WAF should store a sampling of the web requests + // A boolean indicating whether WAF should store a sampling of the web requests // that match the rules. You can view the sampled requests through the WAF console. SampledRequestsEnabled *bool noSmithyDocumentSerde } -// Specifies the action that Amazon CloudFront or WAF takes when a web request +// Specifies the action that Amazon CloudFront or WAF takes when a web request +// // matches the conditions in the rule. type AwsWafv2WebAclActionDetails struct { - // Specifies that WAF should allow requests by default. + // Specifies that WAF should allow requests by default. Allow *AwsWafv2ActionAllowDetails - // Specifies that WAF should block requests by default. + // Specifies that WAF should block requests by default. Block *AwsWafv2ActionBlockDetails noSmithyDocumentSerde } -// Specifies how WAF should handle CAPTCHA evaluations for rules that don't have +// Specifies how WAF should handle CAPTCHA evaluations for rules that don't have +// // their own CaptchaConfig settings. type AwsWafv2WebAclCaptchaConfigDetails struct { - // Determines how long a CAPTCHA timestamp in the token remains valid after the + // Determines how long a CAPTCHA timestamp in the token remains valid after the // client successfully solves a CAPTCHA puzzle. ImmunityTimeProperty *AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails noSmithyDocumentSerde } -// Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or -// challenge timestamp remains valid after WAF updates it for a successful CAPTCHA -// or challenge response. +// Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA +// +// or challenge timestamp remains valid after WAF updates it for a successful +// CAPTCHA or challenge response. type AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails struct { - // The amount of time, in seconds, that a CAPTCHA or challenge timestamp is + // The amount of time, in seconds, that a CAPTCHA or challenge timestamp is // considered valid by WAF. ImmunityTime *int64 @@ -13462,38 +14657,39 @@ type AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails struct { // Details about an WAFv2 web Access Control List (ACL). type AwsWafv2WebAclDetails struct { - // The Amazon Resource Name (ARN) of the web ACL that you want to associate with + // The Amazon Resource Name (ARN) of the web ACL that you want to associate with // the resource. Arn *string - // The web ACL capacity units (WCUs) currently being used by this web ACL. + // The web ACL capacity units (WCUs) currently being used by this web ACL. Capacity *int64 - // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have + // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have // their own CaptchaConfig settings. CaptchaConfig *AwsWafv2WebAclCaptchaConfigDetails - // The action to perform if none of the Rules contained in the web ACL match. + // The action to perform if none of the Rules contained in the web ACL match. DefaultAction *AwsWafv2WebAclActionDetails - // A description of the web ACL that helps with identification. + // A description of the web ACL that helps with identification. Description *string - // A unique identifier for the web ACL. + // A unique identifier for the web ACL. Id *string - // Indicates whether this web ACL is managed by Firewall Manager. + // Indicates whether this web ACL is managed by Firewall Manager. ManagedbyFirewallManager *bool - // The name of the web ACL. + // The name of the web ACL. Name *string - // The Rule statements used to identify the web requests that you want to allow, + // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that WAF uses to // identify matching web requests, and parameters that govern how WAF handles them. Rules []AwsWafv2RulesDetails - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. VisibilityConfig *AwsWafv2VisibilityConfigDetails noSmithyDocumentSerde @@ -13529,13 +14725,17 @@ type AwsWafWebAclRule struct { // 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 - // 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 - // overrides any block action specified by individual rules contained within the - // group. Instead of blocking matching requests, those requests are counted. + // 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 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 ActivatedRule Action . For all other // update requests, ActivatedRule Action is used instead of ActivatedRule @@ -13551,8 +14751,11 @@ 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 @@ -13566,8 +14769,10 @@ type AwsXrayEncryptionConfigDetails struct { 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 @@ -13582,32 +14787,45 @@ 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. + // while this request was being processed. This error may also occur if you call [BatchUpdateFindings] + // BatchUpdateFindings and [BatchImportFindings]BatchImportFindings 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. + // satisfy the [Amazon Web Services Security Finding Format]syntax. + // + // [Amazon Web Services Security Finding Format]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html + // [BatchUpdateFindings]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html + // [BatchImportFindings]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html // // 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 // // This member is required. @@ -13621,11 +14839,12 @@ type BatchUpdateFindingsUnprocessedFinding struct { noSmithyDocumentSerde } -// The options for customizing a security control parameter with a boolean. For a +// The options for customizing a security control parameter with a boolean. For a +// // boolean parameter, the options are true and false . type BooleanConfigurationOptions struct { - // The Security Hub default value for a boolean parameter. + // The Security Hub default value for a boolean parameter. DefaultValue *bool noSmithyDocumentSerde @@ -13728,36 +14947,40 @@ type ClassificationStatus struct { noSmithyDocumentSerde } -// The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs +// The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs +// // log group that Amazon Route 53 is publishing logs to. type CloudWatchLogsLogGroupArnConfigDetails struct { - // The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to. + // The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to. CloudWatchLogsLogGroupArn *string - // The ID of the hosted zone that CloudWatch Logs is logging queries for. + // The ID of the hosted zone that CloudWatch Logs is logging queries for. HostedZoneId *string - // The ID for a DNS query logging configuration. + // The ID for a DNS query logging configuration. Id *string noSmithyDocumentSerde } -// Provides details about where a code vulnerability is located in your Lambda +// Provides details about where a code vulnerability is located in your Lambda +// // function. type CodeVulnerabilitiesFilePath struct { - // The line number of the last line of code in which the vulnerability is located. + // The line number of the last line of code in which the vulnerability is + // located. EndLine *int32 - // The name of the file in which the code vulnerability is located. + // The name of the file in which the code vulnerability is located. FileName *string - // The file path to the code in which the vulnerability is located. + // The file path to the code in which the vulnerability is located. FilePath *string - // The line number of the first line of code in which the vulnerability is located. + // The line number of the first line of code in which the vulnerability is + // located. StartLine *int32 noSmithyDocumentSerde @@ -13767,7 +14990,8 @@ type CodeVulnerabilitiesFilePath struct { // returned for findings generated from controls. type Compliance struct { - // The enabled security standards in which a security control is currently enabled. + // The enabled security standards in which a security control is currently + // enabled. AssociatedStandards []AssociatedStandard // For a control, the industry or regulatory framework requirements that are @@ -13775,18 +14999,24 @@ type Compliance struct { // requirements. RelatedRequirements []string - // The unique identifier of a control across standards. Values for this field + // The unique identifier of a control across standards. Values for this field // typically consist of an Amazon Web Service and a number, such as APIGateway.5. SecurityControlId *string - // An object that includes security control parameter names and values. + // An object that includes security control parameter names and values. SecurityControlParameters []SecurityControlParameter - // The result of a standards check. The valid values for Status are as follows. + // 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 @@ -13794,15 +15024,16 @@ type Compliance struct { 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) - // in the Security Hub User Guide. + // Status . For the list of status reason codes and their meanings, see [Standards-related information in the ASFF] in the + // Security Hub User Guide. + // + // [Standards-related information in the ASFF]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff StatusReasons []StatusReason noSmithyDocumentSerde } -// The options for customizing a security control parameter. +// The options for customizing a security control parameter. // // The following types satisfy this interface: // @@ -13818,8 +15049,9 @@ type ConfigurationOptions interface { isConfigurationOptions() } -// The options for customizing a security control parameter that is a boolean. For -// a boolean parameter, the options are true and false . +// The options for customizing a security control parameter that is a boolean. +// +// For a boolean parameter, the options are true and false . type ConfigurationOptionsMemberBoolean struct { Value BooleanConfigurationOptions @@ -13846,7 +15078,8 @@ type ConfigurationOptionsMemberEnum struct { func (*ConfigurationOptionsMemberEnum) isConfigurationOptions() {} -// The options for customizing a security control parameter that is a list of +// The options for customizing a security control parameter that is a list of +// // enums. type ConfigurationOptionsMemberEnumList struct { Value EnumListConfigurationOptions @@ -13865,7 +15098,8 @@ type ConfigurationOptionsMemberInteger struct { func (*ConfigurationOptionsMemberInteger) isConfigurationOptions() {} -// The options for customizing a security control parameter that is a list of +// The options for customizing a security control parameter that is a list of +// // integers. type ConfigurationOptionsMemberIntegerList struct { Value IntegerListConfigurationOptions @@ -13875,7 +15109,8 @@ type ConfigurationOptionsMemberIntegerList struct { func (*ConfigurationOptionsMemberIntegerList) isConfigurationOptions() {} -// The options for customizing a security control parameter that is a string data +// The options for customizing a security control parameter that is a string data +// // type. type ConfigurationOptionsMemberString struct { Value StringConfigurationOptions @@ -13885,7 +15120,8 @@ type ConfigurationOptionsMemberString struct { func (*ConfigurationOptionsMemberString) isConfigurationOptions() {} -// The options for customizing a security control parameter that is a list of +// The options for customizing a security control parameter that is a list of +// // strings. type ConfigurationOptionsMemberStringList struct { Value StringListConfigurationOptions @@ -13895,73 +15131,76 @@ type ConfigurationOptionsMemberStringList struct { func (*ConfigurationOptionsMemberStringList) isConfigurationOptions() {} -// Provides details about the association between an Security Hub configuration +// Provides details about the association between an Security Hub configuration +// // and a target account, organizational unit, or the root. An association can exist // between a target and a configuration policy, or between a target and // self-managed behavior. type ConfigurationPolicyAssociation struct { - // The target account, organizational unit, or the root. + // The target account, organizational unit, or the root. Target Target noSmithyDocumentSerde } -// An object that contains the details of a configuration policy association +// An object that contains the details of a configuration policy association +// // that’s returned in a ListConfigurationPolicyAssociations request. type ConfigurationPolicyAssociationSummary struct { - // The current status of the association between the specified target and the + // The current status of the association between the specified target and the // configuration. AssociationStatus ConfigurationPolicyAssociationStatus - // The explanation for a FAILED value for AssociationStatus . + // The explanation for a FAILED value for AssociationStatus . AssociationStatusMessage *string - // Indicates whether the association between the specified target and the + // Indicates whether the association between the specified target and the // configuration was directly applied by the Security Hub delegated administrator // or inherited from a parent. AssociationType AssociationType - // The universally unique identifier (UUID) of the configuration policy. + // The universally unique identifier (UUID) of the configuration policy. ConfigurationPolicyId *string - // The identifier of the target account, organizational unit, or the root. + // The identifier of the target account, organizational unit, or the root. TargetId *string - // Specifies whether the target is an Amazon Web Services account, organizational + // Specifies whether the target is an Amazon Web Services account, organizational // unit, or the root. TargetType TargetType - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // association was last updated. UpdatedAt *time.Time noSmithyDocumentSerde } -// An object that contains the details of an Security Hub configuration policy +// An object that contains the details of an Security Hub configuration policy +// // that’s returned in a ListConfigurationPolicies request. type ConfigurationPolicySummary struct { - // The Amazon Resource Name (ARN) of the configuration policy. + // The Amazon Resource Name (ARN) of the configuration policy. Arn *string - // The description of the configuration policy. + // The description of the configuration policy. Description *string - // The universally unique identifier (UUID) of the configuration policy. + // The universally unique identifier (UUID) of the configuration policy. Id *string - // The name of the configuration policy. Alphanumeric characters and the following - // ASCII characters are permitted: -, ., !, *, / . + // The name of the configuration policy. Alphanumeric characters and the + // following ASCII characters are permitted: -, ., !, *, / . Name *string - // Indicates whether the service that the configuration policy applies to is + // Indicates whether the service that the configuration policy applies to is // enabled in the policy. ServiceEnabled *bool - // The date and time, in UTC and ISO 8601 format, that the configuration policy + // The date and time, in UTC and ISO 8601 format, that the configuration policy // was last updated. UpdatedAt *time.Time @@ -13980,15 +15219,21 @@ type ContainerDetails struct { // The name of the container image related to a finding. ImageName *string - // Indicates when the container started. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the container started. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LaunchedAt *string @@ -14088,30 +15333,40 @@ type DateFilter struct { // A date range for the date filter. DateRange *DateRange - // A timestamp that provides the end date for the date filter. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that provides the end date for the date filter. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) End *string - // A timestamp that provides the start date for the date filter. This field - // accepts only the specified formats. Timestamps can end with Z or ("+" / "-") - // time-hour [":" time-minute] . The time-secfrac after seconds is limited to a - // maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp - // formats with examples: + // A timestamp that provides the start date for the date filter. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) Start *string @@ -14150,13 +15405,13 @@ type DnsRequestAction struct { // The options for customizing a security control parameter that is a double. type DoubleConfigurationOptions struct { - // The Security Hub default value for a control parameter that is a double. + // The Security Hub default value for a control parameter that is a double. DefaultValue *float64 - // The maximum valid value for a control parameter that is a double. + // The maximum valid value for a control parameter that is a double. Max *float64 - // The minimum valid value for a control parameter that is a double. + // The minimum valid value for a control parameter that is a double. Min *float64 noSmithyDocumentSerde @@ -14165,26 +15420,29 @@ type DoubleConfigurationOptions struct { // The options for customizing a security control parameter that is an enum. type EnumConfigurationOptions struct { - // The valid values for a control parameter that is an enum. + // The valid values for a control parameter that is an enum. AllowedValues []string - // The Security Hub default value for a control parameter that is an enum. + // The Security Hub default value for a control parameter that is an enum. DefaultValue *string noSmithyDocumentSerde } -// The options for customizing a security control parameter that is a list of +// The options for customizing a security control parameter that is a list of +// // enums. type EnumListConfigurationOptions struct { - // The valid values for a control parameter that is a list of enums. + // The valid values for a control parameter that is a list of enums. AllowedValues []string - // The Security Hub default value for a control parameter that is a list of enums. + // The Security Hub default value for a control parameter that is a list of + // enums. DefaultValue []string - // The maximum number of list items that an enum list control parameter can accept. + // The maximum number of list items that an enum list control parameter can + // accept. MaxItems *int32 noSmithyDocumentSerde @@ -14202,7 +15460,8 @@ type FilePaths struct { // The hash value for the infected or suspicious file. Hash *string - // The Amazon Resource Name (ARN) of the resource on which the threat was detected. + // The Amazon Resource Name (ARN) of the resource on which the threat was + // detected. ResourceId *string noSmithyDocumentSerde @@ -14219,11 +15478,12 @@ type FindingAggregator struct { noSmithyDocumentSerde } -// A list of events that changed the specified finding during the specified time +// A list of events that changed the specified finding during the specified time +// // period. Each record represents a single finding change event. type FindingHistoryRecord struct { - // Identifies whether the event marks the creation of a new finding. A value of + // Identifies whether the event marks the creation of a new finding. A value of // True means that the finding is newly created. A value of False means that the // finding isn’t newly created. FindingCreated *bool @@ -14231,34 +15491,42 @@ type FindingHistoryRecord struct { // Identifies which finding to get the finding history for. FindingIdentifier *AwsSecurityFindingIdentifier - // A token for pagination purposes. Provide this token in the subsequent request - // to GetFindingsHistory (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html) - // to get up to an additional 100 results of history for the same finding that you - // specified in your initial request. + // A token for pagination purposes. Provide this token in the subsequent request + // to [GetFindingsHistory]GetFindingsHistory to get up to an additional 100 results of history for the + // same finding that you specified in your initial request. + // + // [GetFindingsHistory]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html NextToken *string - // Identifies the source of the event that changed the finding. For example, an - // integrated Amazon Web Service or third-party partner integration may call - // BatchImportFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html) - // , or an Security Hub customer may call BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html) - // . + // Identifies the source of the event that changed the finding. For example, an + // integrated Amazon Web Service or third-party partner integration may call [BatchImportFindings] + // BatchImportFindings , or an Security Hub customer may call [BatchUpdateFindings]BatchUpdateFindings . + // + // [BatchUpdateFindings]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html + // [BatchImportFindings]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html UpdateSource *FindingHistoryUpdateSource - // A timestamp that indicates when Security Hub processed the updated finding - // record. This field accepts only the specified formats. Timestamps can end with Z - // or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // A timestamp that indicates when Security Hub processed the updated finding + // record. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) UpdateTime *time.Time - // An array of objects that provides details about the finding change event, + // An array of objects that provides details about the finding change event, // including the Amazon Web Services Security Finding Format (ASFF) field that // changed, the value of the field before the change, and the value of the field // after the change. @@ -14267,21 +15535,24 @@ type FindingHistoryRecord struct { noSmithyDocumentSerde } -// An array of objects that provides details about a change to a finding, +// An array of objects that provides details about a change to a finding, +// // including the Amazon Web Services Security Finding Format (ASFF) field that // changed, the value of the field before the change, and the value of the field // after the change. type FindingHistoryUpdate struct { - // The value of the ASFF field after the finding change event. To preserve storage - // and readability, Security Hub omits this value if FindingHistoryRecord (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord.html) + // The value of the ASFF field after the finding change event. To preserve + // storage and readability, Security Hub omits this value if [FindingHistoryRecord]FindingHistoryRecord // exceeds database limits. + // + // [FindingHistoryRecord]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord.html NewValue *string - // The value of the ASFF field before the finding change event. + // The value of the ASFF field before the finding change event. OldValue *string - // The ASFF field that changed during the finding change event. + // The ASFF field that changed during the finding change event. UpdatedField *string noSmithyDocumentSerde @@ -14290,16 +15561,17 @@ type FindingHistoryUpdate struct { // Identifies the source of the finding change event. type FindingHistoryUpdateSource struct { - // The identity of the source that initiated the finding change event. For + // The identity of the source that initiated the finding change event. For // example, the Amazon Resource Name (ARN) of a partner that calls // BatchImportFindings or of a customer that calls BatchUpdateFindings. Identity *string - // Describes the type of finding change event, such as a call to - // BatchImportFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html) - // (by an integrated Amazon Web Service or third party partner integration) or - // BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html) - // (by a Security Hub customer). + // Describes the type of finding change event, such as a call to [BatchImportFindings] + // BatchImportFindings (by an integrated Amazon Web Service or third party partner + // integration) or [BatchUpdateFindings]BatchUpdateFindings (by a Security Hub customer). + // + // [BatchUpdateFindings]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html + // [BatchImportFindings]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html Type FindingHistoryUpdateSourceType noSmithyDocumentSerde @@ -14312,11 +15584,13 @@ type FindingProviderFields struct { // A finding's confidence. Confidence is defined as the likelihood that a finding // accurately identifies the behavior or issue that it was intended to identify. + // // Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero // 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. Criticality *int32 @@ -14328,8 +15602,10 @@ type FindingProviderFields struct { Severity *FindingProviderSeverity // One or more finding types in the format of namespace/category/classifier that - // classify a finding. Valid namespace values are: Software and Configuration - // Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications + // classify a finding. + // + // Valid namespace values are: Software and Configuration Checks | TTPs | Effects + // | Unusual Behaviors | Sensitive Data Identifications Types []string noSmithyDocumentSerde @@ -14358,15 +15634,17 @@ type FirewallPolicyDetails struct { 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. @@ -14408,20 +15686,21 @@ type FirewallPolicyStatelessRuleGroupReferencesDetails struct { noSmithyDocumentSerde } -// Provides metadata for the Amazon CodeGuru detector associated with a finding. +// Provides metadata for the Amazon CodeGuru detector associated with a finding. +// // This field pertains to findings that relate to Lambda functions. Amazon // Inspector identifies policy violations and vulnerabilities in Lambda function // code based on internal detectors developed in collaboration with Amazon // CodeGuru. Security Hub receives those findings. type GeneratorDetails struct { - // The description of the detector used to identify the code vulnerability. + // The description of the detector used to identify the code vulnerability. Description *string - // An array of tags used to identify the detector associated with the finding. + // An array of tags used to identify the detector associated with the finding. Labels []string - // The name of the detector used to identify the code vulnerability. + // The name of the detector used to identify the code vulnerability. Name *string noSmithyDocumentSerde @@ -14550,34 +15829,35 @@ type InsightResultValue struct { // The options for customizing a security control parameter that is an integer. type IntegerConfigurationOptions struct { - // The Security Hub default value for a control parameter that is an integer. + // The Security Hub default value for a control parameter that is an integer. DefaultValue *int32 - // The maximum valid value for a control parameter that is an integer. + // The maximum valid value for a control parameter that is an integer. Max *int32 - // The minimum valid value for a control parameter that is an integer. + // The minimum valid value for a control parameter that is an integer. Min *int32 noSmithyDocumentSerde } -// The options for customizing a security control parameter that is a list of +// The options for customizing a security control parameter that is a list of +// // integers. type IntegerListConfigurationOptions struct { - // The Security Hub default value for a control parameter that is a list of + // The Security Hub default value for a control parameter that is a list of // integers. DefaultValue []int32 - // The maximum valid value for a control parameter that is a list of integers. + // The maximum valid value for a control parameter that is a list of integers. Max *int32 - // The maximum number of list items that an interger list control parameter can + // The maximum number of list items that an interger list control parameter can // accept. MaxItems *int32 - // The minimum valid value for a control parameter that is a list of integers. + // The minimum valid value for a control parameter that is a list of integers. Min *int32 noSmithyDocumentSerde @@ -14637,11 +15917,17 @@ type Ipv6CidrBlockAssociation struct { AssociationId *string // Information about the state of the CIDR block. Valid values are as follows: + // // - associating + // // - associated + // // - disassociating + // // - disassociated + // // - failed + // // - failing CidrBlockState *string @@ -14663,9 +15949,12 @@ type KeywordFilter 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 load balancer is fully set up and ready to route traffic, its state is - // active. If the load balancer could not be set up, its state is failed. + // 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 the load balancer could not be set up, its state is failed. Code *string // A description of the state. @@ -14699,39 +15988,53 @@ type Malware struct { type MapFilter struct { // The condition to apply to the key value when filtering Security Hub findings - // with a map filter. To search for values that have the filter value, use one of - // the following comparison operators: + // with a map filter. + // + // To search for values that have the filter value, use one of the following + // comparison operators: + // // - To search for values that include the filter value, use CONTAINS . For // example, for the ResourceTags field, the filter Department CONTAINS Security // matches findings that include the value Security for the Department tag. In // the same example, a finding with a value of Security team for the Department // tag is a match. + // // - 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 Department tag. + // // CONTAINS and EQUALS filters on the same field are joined by OR . A finding // matches if it matches any one of those filters. For example, the filters // Department CONTAINS Security OR Department CONTAINS Finance match a finding that - // includes either Security , Finance , or both values. To search for values that - // don't have the filter value, use one of the following comparison operators: + // includes either Security , Finance , or both values. + // + // To search for values that don't have the filter value, use one of the following + // comparison operators: + // // - To search for values that exclude the filter value, use NOT_CONTAINS . For // example, for the ResourceTags field, the filter Department NOT_CONTAINS - // Finance matches findings that exclude the value Finance for the Department - // tag. + // Finance matches findings that exclude the value Finance for the Department tag. + // // - 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 don’t have the value Finance for the Department tag. + // // NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND . A // finding matches only if it matches all of those filters. For example, the // filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance - // match a finding that excludes both the Security and Finance values. CONTAINS - // filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can - // only be used with other NOT_CONTAINS filters. You can’t have both a CONTAINS - // filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have - // both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining - // filters in this way returns an error. CONTAINS and NOT_CONTAINS operators can - // be used only with automation rules. For more information, see Automation rules (https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) - // in the Security Hub User Guide. + // match a finding that excludes both the Security and Finance values. + // + // CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS + // filters can only be used with other NOT_CONTAINS filters. + // + // You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same + // field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter + // on the same field. Combining filters in this way returns an error. + // + // CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For + // more information, see [Automation rules]in the Security Hub User Guide. + // + // [Automation rules]: https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html Comparison MapFilterComparison // The key of the map filter. For example, for ResourceTags , Key identifies the @@ -14763,27 +16066,38 @@ type Member struct { // account. InvitedAt *time.Time - // This is replaced by AdministratorID . The Amazon Web Services account ID of the - // Security Hub administrator account associated with this member account. + // 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. MasterId *string // The status of the relationship between the member account and its administrator - // account. The status can have one of the following values: + // 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. @@ -14920,16 +16234,21 @@ type Note struct { // This member is required. Text *string - // A timestamp that indicates when the note was updated. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // A timestamp that indicates when the note was updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) // @@ -14967,7 +16286,7 @@ type NumberFilter struct { // findings. Eq *float64 - // The greater-than condition to be applied to a single field when querying for + // The greater-than condition to be applied to a single field when querying for // findings. Gt *float64 @@ -14975,7 +16294,7 @@ type NumberFilter struct { // for findings. Gte *float64 - // The less-than condition to be applied to a single field when querying for + // The less-than condition to be applied to a single field when querying for // findings. Lt *float64 @@ -15011,31 +16330,34 @@ type Occurrences struct { noSmithyDocumentSerde } -// Provides information about the way an organization is configured in Security +// Provides information about the way an organization is configured in Security +// // Hub. type OrganizationConfiguration struct { - // Indicates whether the organization uses local or central configuration. If you - // use local configuration, the Security Hub delegated administrator can set - // AutoEnable to true and AutoEnableStandards to DEFAULT . This automatically + // Indicates whether the organization uses local or central configuration. + // + // If you use local configuration, the Security Hub delegated administrator can + // set AutoEnable to true and AutoEnableStandards to DEFAULT . This automatically // enables Security Hub and default security standards in new organization // accounts. These new account settings must be set separately in each Amazon Web - // Services Region, and settings may be different in each Region. If you use - // central configuration, the delegated administrator can create configuration - // policies. Configuration policies can be used to configure Security Hub, security - // standards, and security controls in multiple accounts and Regions. If you want - // new organization accounts to use a specific configuration, you can create a - // configuration policy and associate it with the root or specific organizational - // units (OUs). New accounts will inherit the policy from the root or their - // assigned OU. + // Services Region, and settings may be different in each Region. + // + // If you use central configuration, the delegated administrator can create + // configuration policies. Configuration policies can be used to configure Security + // Hub, security standards, and security controls in multiple accounts and Regions. + // If you want new organization accounts to use a specific configuration, you can + // create a configuration policy and associate it with the root or specific + // organizational units (OUs). New accounts will inherit the policy from the root + // or their assigned OU. ConfigurationType OrganizationConfigurationConfigurationType - // Describes whether central configuration could be enabled as the + // Describes whether central configuration could be enabled as the // ConfigurationType for the organization. If your ConfigurationType is local // configuration, then the value of Status is always ENABLED . Status OrganizationConfigurationStatus - // Provides an explanation if the value of Status is equal to FAILED when + // Provides an explanation if the value of Status is equal to FAILED when // ConfigurationType is equal to CENTRAL . StatusMessage *string @@ -15059,37 +16381,42 @@ type Page struct { noSmithyDocumentSerde } -// An object that provides the current value of a security control parameter and +// An object that provides the current value of a security control parameter and +// // identifies whether it has been customized. type ParameterConfiguration struct { - // Identifies whether a control parameter uses a custom user-defined value or - // subscribes to the default Security Hub behavior. When ValueType is set equal to - // DEFAULT , the default behavior can be a specific Security Hub default value, or - // the default behavior can be to ignore a specific parameter. When ValueType is - // set equal to DEFAULT , Security Hub ignores user-provided input for the Value - // field. When ValueType is set equal to CUSTOM , the Value field can't be empty. + // Identifies whether a control parameter uses a custom user-defined value or + // subscribes to the default Security Hub behavior. + // + // When ValueType is set equal to DEFAULT , the default behavior can be a specific + // Security Hub default value, or the default behavior can be to ignore a specific + // parameter. When ValueType is set equal to DEFAULT , Security Hub ignores + // user-provided input for the Value field. + // + // When ValueType is set equal to CUSTOM , the Value field can't be empty. // // This member is required. ValueType ParameterValueType - // The current value of a control parameter. + // The current value of a control parameter. Value ParameterValue noSmithyDocumentSerde } -// An object that describes a security control parameter and the options for +// An object that describes a security control parameter and the options for +// // customizing it. type ParameterDefinition struct { - // The options for customizing a control parameter. Customization options vary + // The options for customizing a control parameter. Customization options vary // based on the data type of the parameter. // // This member is required. ConfigurationOptions ConfigurationOptions - // Description of a control parameter. + // Description of a control parameter. // // This member is required. Description *string @@ -15097,7 +16424,8 @@ type ParameterDefinition struct { noSmithyDocumentSerde } -// An object that includes the data type of a security control parameter and its +// An object that includes the data type of a security control parameter and its +// // current value. // // The following types satisfy this interface: @@ -15222,28 +16550,40 @@ type PatchSummary struct { // and INSTALL . Operation *string - // Indicates when the operation completed. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the operation completed. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) OperationEndTime *string - // Indicates when the operation started. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the operation started. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) OperationStartTime *string @@ -15254,7 +16594,8 @@ type PatchSummary struct { noSmithyDocumentSerde } -// An object that defines how Security Hub is configured. It includes whether +// An object that defines how Security Hub is configured. It includes whether +// // Security Hub is enabled or disabled, a list of enabled security standards, a // list of enabled or disabled security controls, and a list of custom parameter // values for specified controls. If you provide a list of security controls that @@ -15336,15 +16677,21 @@ type PortRangeFromTo struct { // The details of process-related information about a finding. type ProcessDetails struct { - // Indicates when the process was launched. This field accepts only the specified - // formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute] . - // The time-secfrac after seconds is limited to a maximum of 9 digits. The offset - // is bounded by +/-18:00. Here are valid timestamp formats with examples: + // Indicates when the process was launched. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LaunchedAt *string @@ -15362,16 +16709,21 @@ type ProcessDetails struct { // The process ID. Pid *int32 - // Indicates when the process was terminated. This field accepts only the - // specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the process was terminated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) TerminatedAt *string @@ -15402,19 +16754,23 @@ 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. IntegrationTypes []IntegrationType // For integrations with Amazon Web Services services, the Amazon Web Services - // Console URL from which to activate the service. For integrations with - // third-party products, the Amazon Web Services Marketplace URL from which to - // subscribe to or purchase the product. + // Console URL from which to activate the service. + // + // For integrations with third-party products, the Amazon Web Services Marketplace + // URL from which to subscribe to or purchase the product. MarketplaceUrl *string // The name of the product. @@ -15429,7 +16785,7 @@ type Product struct { // Describes a virtual private gateway propagating route. type PropagatingVgwSetDetails struct { - // The ID of the virtual private gateway. + // The ID of the virtual private gateway. GatewayId *string noSmithyDocumentSerde @@ -15518,16 +16874,19 @@ type Resource struct { // 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 . + // 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 - // The Amazon Resource Name (ARN) of the application that is related to a finding. + // The Amazon Resource Name (ARN) of the application that is related to a + // finding. ApplicationArn *string - // The name of the application that is related to a finding. + // The name of the application that is related to a finding. ApplicationName *string // Contains information about sensitive data that was detected on the resource. @@ -15554,18 +16913,22 @@ type Resource struct { noSmithyDocumentSerde } -// 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 -// 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 -// the selected type does not have a corresponding object. +// 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 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 the selected type +// does not have a corresponding object. type ResourceDetails struct { - // Provides details about AppSync message broker. A message broker allows software - // applications and components to communicate using various programming languages, - // operating systems, and formal messaging protocols. + // Provides details about AppSync message broker. A message broker allows + // software applications and components to communicate using various programming + // languages, operating systems, and formal messaging protocols. AwsAmazonMqBroker *AwsAmazonMqBrokerDetails // Provides information about a REST API in version 1 of Amazon API Gateway. @@ -15580,11 +16943,11 @@ type ResourceDetails struct { // Provides information about a version 2 stage for Amazon API Gateway. AwsApiGatewayV2Stage *AwsApiGatewayV2StageDetails - // Provides details about an AppSync Graph QL API, which lets you query multiple + // Provides details about an AppSync Graph QL API, which lets you query multiple // databases, microservices, and APIs from a single GraphQL endpoint. AwsAppSyncGraphQlApi *AwsAppSyncGraphQlApiDetails - // Provides information about an Amazon Athena workgroup. A workgroup helps you + // Provides information about an Amazon Athena workgroup. A workgroup helps you // separate users, teams, applications, or workloads. It also helps you set limits // on data processing and track costs. AwsAthenaWorkGroup *AwsAthenaWorkGroupDetails @@ -15625,24 +16988,24 @@ type ResourceDetails struct { // Details for an CodeBuild project. AwsCodeBuildProject *AwsCodeBuildProjectDetails - // Provides details about an Database Migration Service (DMS) endpoint. An + // Provides details about an Database Migration Service (DMS) endpoint. An // endpoint provides connection, data store type, and location information about // your data store. AwsDmsEndpoint *AwsDmsEndpointDetails - // Provides details about an DMS replication instance. DMS uses a replication + // Provides details about an DMS replication instance. DMS uses a replication // instance to connect to your source data store, read the source data, and format // the data for consumption by the target data store. AwsDmsReplicationInstance *AwsDmsReplicationInstanceDetails - // Provides details about an DMS replication task. A replication task moves a set + // Provides details about an DMS replication task. A replication task moves a set // of data from the source endpoint to the target endpoint. AwsDmsReplicationTask *AwsDmsReplicationTaskDetails // Details about a DynamoDB table. AwsDynamoDbTable *AwsDynamoDbTableDetails - // Provides details about an Client VPN endpoint. A Client VPN endpoint is the + // Provides details about an Client VPN endpoint. A Client VPN endpoint is the // resource that you create and configure to enable and manage client VPN sessions. // It's the termination point for all client VPN sessions. AwsEc2ClientVpnEndpoint *AwsEc2ClientVpnEndpointDetails @@ -15653,7 +17016,7 @@ type ResourceDetails struct { // Details about an EC2 instance related to a finding. AwsEc2Instance *AwsEc2InstanceDetails - // Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon + // Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon // EC2) launch template. AwsEc2LaunchTemplate *AwsEc2LaunchTemplateDetails @@ -15663,7 +17026,7 @@ type ResourceDetails struct { // Details for an EC2 network interface. AwsEc2NetworkInterface *AwsEc2NetworkInterfaceDetails - // Provides details about a route table. A route table contains a set of rules, + // Provides details about a route table. A route table contains a set of rules, // called routes, that determine where to direct network traffic from your subnet // or gateway. AwsEc2RouteTable *AwsEc2RouteTableDetails @@ -15738,21 +17101,21 @@ type ResourceDetails struct { // Details about a load balancer. AwsElbv2LoadBalancer *AwsElbv2LoadBalancerDetails - // A schema defines the structure of events that are sent to Amazon EventBridge. + // A schema defines the structure of events that are sent to Amazon EventBridge. // Schema registries are containers for schemas. They collect and organize schemas // so that your schemas are in logical groups. AwsEventSchemasRegistry *AwsEventSchemasRegistryDetails - // Provides details about an Amazon EventBridge global endpoint. The endpoint can + // Provides details about an Amazon EventBridge global endpoint. The endpoint can // improve your application’s availability by making it Regional-fault tolerant. AwsEventsEndpoint *AwsEventsEndpointDetails - // Provides details about Amazon EventBridge event bus for an endpoint. An event + // Provides details about Amazon EventBridge event bus for an endpoint. An event // bus is a router that receives events and delivers them to zero or more // destinations, or targets. AwsEventsEventbus *AwsEventsEventbusDetails - // Provides details about an Amazon GuardDuty detector. A detector is an object + // Provides details about an Amazon GuardDuty detector. A detector is an object // that represents the GuardDuty service. A detector is required for GuardDuty to // become operational. AwsGuardDutyDetector *AwsGuardDutyDetectorDetails @@ -15784,7 +17147,7 @@ type ResourceDetails struct { // Details for a Lambda layer version. AwsLambdaLayerVersion *AwsLambdaLayerVersionDetails - // Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon + // Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon // MSK) cluster. AwsMskCluster *AwsMskClusterDetails @@ -15821,12 +17184,12 @@ type ResourceDetails struct { // Contains details about an Amazon Redshift cluster. AwsRedshiftCluster *AwsRedshiftClusterDetails - // Provides details about an Amazon Route 53 hosted zone, including the four name + // Provides details about an Amazon Route 53 hosted zone, including the four name // servers assigned to the hosted zone. A hosted zone represents a collection of // records that can be managed together, belonging to a single parent domain name. AwsRoute53HostedZone *AwsRoute53HostedZoneDetails - // Provides details about an Amazon Simple Storage Service (Amazon S3) access + // Provides details about an Amazon Simple Storage Service (Amazon S3) access // point. S3 access points are named network endpoints that are attached to S3 // buckets that you can use to perform S3 object operations. AwsS3AccessPoint *AwsS3AccessPointDetails @@ -15840,7 +17203,7 @@ type ResourceDetails struct { // Details about an S3 object related to a finding. AwsS3Object *AwsS3ObjectDetails - // Provides details about an Amazon SageMaker notebook instance. + // Provides details about an Amazon SageMaker notebook instance. AwsSageMakerNotebookInstance *AwsSageMakerNotebookInstanceDetails // Details about a Secrets Manager secret. @@ -15856,7 +17219,7 @@ type ResourceDetails struct { // patch baseline that was used to patch the instance. AwsSsmPatchCompliance *AwsSsmPatchComplianceDetails - // Provides details about an Step Functions state machine, which is a workflow + // Provides details about an Step Functions state machine, which is a workflow // consisting of a series of event-driven steps. AwsStepFunctionStateMachine *AwsStepFunctionStateMachineDetails @@ -15884,10 +17247,10 @@ type ResourceDetails struct { // Details for an WAF web ACL. AwsWafWebAcl *AwsWafWebAclDetails - // Details about an WAFv2 rule group. + // Details about an WAFv2 rule group. AwsWafv2RuleGroup *AwsWafv2RuleGroupDetails - // Details about an WAFv2 web Access Control List (ACL). + // Details about an WAFv2 web Access Control List (ACL). AwsWafv2WebAcl *AwsWafv2WebAclDetails // Information about the encryption configuration for X-Ray. @@ -15898,10 +17261,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 . Other map[string]string @@ -15924,52 +17289,52 @@ type Result struct { // Provides details about the routes in the route table. type RouteSetDetails struct { - // The ID of the carrier gateway. + // The ID of the carrier gateway. CarrierGatewayId *string - // The Amazon Resource Name (ARN) of the core network. + // The Amazon Resource Name (ARN) of the core network. CoreNetworkArn *string - // The IPv4 CIDR block used for the destination match. + // The IPv4 CIDR block used for the destination match. DestinationCidrBlock *string - // The IPv6 CIDR block used for the destination match. + // The IPv6 CIDR block used for the destination match. DestinationIpv6CidrBlock *string - // The prefix of the destination Amazon Web Service. + // The prefix of the destination Amazon Web Service. DestinationPrefixListId *string - // The ID of the egress-only internet gateway. + // The ID of the egress-only internet gateway. EgressOnlyInternetGatewayId *string - // The ID of a gateway attached to your VPC. + // The ID of a gateway attached to your VPC. GatewayId *string - // The ID of a NAT instance in your VPC. + // The ID of a NAT instance in your VPC. InstanceId *string - // The ID of the Amazon Web Services account that owns the instance. + // The ID of the Amazon Web Services account that owns the instance. InstanceOwnerId *string - // The ID of the local gateway. + // The ID of the local gateway. LocalGatewayId *string - // The ID of a NAT gateway. + // The ID of a NAT gateway. NatGatewayId *string - // The ID of the network interface. + // The ID of the network interface. NetworkInterfaceId *string - // Describes how the route was created. + // Describes how the route was created. Origin *string - // The state of the route. + // The state of the route. State *string - // The ID of a transit gateway. + // The ID of a transit gateway. TransitGatewayId *string - // The ID of a VPC peering connection. + // The ID of a VPC peering connection. VpcPeeringConnectionId *string noSmithyDocumentSerde @@ -15981,9 +17346,12 @@ type RuleGroupDetails struct { // Additional settings to use in the specified rules. 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 . + // The rules and actions for the rule group. + // + // For stateful rule groups, can contain RulesString , RulesSourceList , or + // StatefulRules . + // + // For stateless rule groups, contains StatelessRulesAndCustomActions . RulesSource *RuleGroupSource noSmithyDocumentSerde @@ -16253,11 +17621,12 @@ type RuleGroupVariablesPortSetsDetails struct { noSmithyDocumentSerde } -// A security control in Security Hub describes a security best practice related +// 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 + // The description of a security control across standards. This typically // summarizes how Security Hub evaluates the control and the conditions under which // it produces a failed finding. This parameter doesn't reference a specific // standard. @@ -16265,34 +17634,35 @@ type SecurityControl struct { // This member is required. Description *string - // A link to Security Hub documentation that explains how to remediate a failed + // A link to Security Hub documentation that explains how to remediate a failed // finding for a security control. // // This member is required. 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 + // 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 // parameter doesn't mention a specific standard. // // This member is required. SecurityControlArn *string - // The unique identifier of a security control across standards. Values for this + // The unique identifier of a security control across standards. Values for this // field typically consist of an Amazon Web Service name and a number, such as // APIGateway.3. // // This member is required. SecurityControlId *string - // The enablement status of a security control in a specific standard. + // The enablement status of a security control in a specific standard. // // 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) - // in the Security Hub User Guide. + // The severity of a security control. For more information about how Security + // Hub determines control severity, see [Assigning severity to control findings]in the Security Hub User Guide. + // + // [Assigning severity to control findings]: https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity // // This member is required. SeverityRating SeverityRating @@ -16302,19 +17672,20 @@ type SecurityControl struct { // This member is required. Title *string - // The most recent reason for updating the customizable properties of a security - // control. This differs from the UpdateReason field of the - // BatchUpdateStandardsControlAssociations (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html) - // API, which tracks the reason for updating the enablement status of a control. - // This field accepts alphanumeric characters in addition to white spaces, dashes, - // and underscores. + // The most recent reason for updating the customizable properties of a security + // control. This differs from the UpdateReason field of the [BatchUpdateStandardsControlAssociations] + // BatchUpdateStandardsControlAssociations API, which tracks the reason for + // updating the enablement status of a control. This field accepts alphanumeric + // characters in addition to white spaces, dashes, and underscores. + // + // [BatchUpdateStandardsControlAssociations]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html LastUpdateReason *string - // An object that identifies the name of a control parameter, its current value, + // An object that identifies the name of a control parameter, its current value, // and whether it has been customized. Parameters map[string]ParameterConfiguration - // Identifies whether customizable properties of a security control are reflected + // Identifies whether customizable properties of a security control are reflected // in Security Hub findings. A status of READY indicates findings include the // current parameter values. A status of UPDATING indicates that all findings may // not include the current parameter values. @@ -16323,32 +17694,34 @@ type SecurityControl struct { noSmithyDocumentSerde } -// A list of security controls and control parameter values that are included in a -// configuration policy. +// A list of security controls and control parameter values that are included in +// +// a configuration policy. type SecurityControlCustomParameter struct { - // An object that specifies parameter values for a control in a configuration + // An object that specifies parameter values for a control in a configuration // policy. Parameters map[string]ParameterConfiguration - // The ID of the security control. + // The ID of the security control. SecurityControlId *string noSmithyDocumentSerde } -// Provides metadata for a security control, including its unique +// 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 + // Specifies whether a security control is available in the current Amazon Web // Services Region. // // This member is required. CurrentRegionAvailability RegionAvailabilityStatus - // The description of a security control across standards. This typically + // The description of a security control across standards. This typically // summarizes how Security Hub evaluates the control and the conditions under which // it produces a failed finding. This parameter doesn't reference a specific // standard. @@ -16356,13 +17729,13 @@ type SecurityControlDefinition struct { // This member is required. Description *string - // A link to Security Hub documentation that explains how to remediate a failed + // A link to Security Hub documentation that explains how to remediate a failed // finding for a security control. // // This member is required. RemediationUrl *string - // The unique identifier of a security control across standards. Values for this + // 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 @@ -16372,26 +17745,27 @@ type SecurityControlDefinition struct { // This member is required. 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) - // in the Security Hub User Guide. + // The severity of a security control. For more information about how Security + // Hub determines control severity, see [Assigning severity to control findings]in the Security Hub User Guide. + // + // [Assigning severity to control findings]: https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity // // This member is required. SeverityRating SeverityRating - // The title of a security control. + // The title of a security control. // // This member is required. Title *string - // Security control properties that you can customize. Currently, only parameter + // Security control properties that you can customize. Currently, only parameter // customization is supported for select controls. An empty array is returned for // controls that don’t support custom properties. CustomizableProperties []SecurityControlProperty - // An object that provides a security control parameter name, description, and the - // options for customizing it. This object is excluded for a control that doesn't - // support custom parameters. + // An object that provides a security control parameter name, description, and + // the options for customizing it. This object is excluded for a control that + // doesn't support custom parameters. ParameterDefinitions map[string]ParameterDefinition noSmithyDocumentSerde @@ -16400,57 +17774,59 @@ type SecurityControlDefinition struct { // A parameter that a security control accepts. type SecurityControlParameter struct { - // The name of a + // The name of a Name *string - // The current value of a control parameter. + // The current value of a control parameter. Value []string noSmithyDocumentSerde } -// An object that defines which security controls are enabled in an Security Hub +// An object that defines which security controls are enabled in an Security Hub +// // configuration policy. The enablement status of a control is aligned across all // of the enabled standards in an account. type SecurityControlsConfiguration struct { - // A list of security controls that are disabled in the configuration policy. + // A list of security controls that are disabled in the configuration policy. // Security Hub enables all other controls (including newly released controls) // other than the listed controls. DisabledSecurityControlIdentifiers []string - // A list of security controls that are enabled in the configuration policy. + // A list of security controls that are enabled in the configuration policy. // Security Hub disables all other controls (including newly released controls) // other than the listed controls. EnabledSecurityControlIdentifiers []string - // A list of security controls and control parameter values that are included in a - // configuration policy. + // A list of security controls and control parameter values that are included in + // a configuration policy. SecurityControlCustomParameters []SecurityControlCustomParameter noSmithyDocumentSerde } -// An object that defines how Security Hub is configured. The configuration policy -// includes whether Security Hub is enabled or disabled, a list of enabled security -// standards, a list of enabled or disabled security controls, and a list of custom -// parameter values for specified controls. If you provide a list of security -// controls that are enabled in the configuration policy, Security Hub disables all -// other controls (including newly released controls). If you provide a list of -// security controls that are disabled in the configuration policy, Security Hub -// enables all other controls (including newly released controls). +// An object that defines how Security Hub is configured. The configuration +// +// policy includes whether Security Hub is enabled or disabled, a list of enabled +// security standards, a list of enabled or disabled security controls, and a list +// of custom parameter values for specified controls. If you provide a list of +// security controls that are enabled in the configuration policy, Security Hub +// disables all other controls (including newly released controls). If you provide +// a list of security controls that are disabled in the configuration policy, +// Security Hub enables all other controls (including newly released controls). type SecurityHubPolicy struct { - // A list that defines which security standards are enabled in the configuration + // A list that defines which security standards are enabled in the configuration // policy. EnabledStandardIdentifiers []string - // An object that defines which security controls are enabled in the configuration - // policy. The enablement status of a control is aligned across all of the enabled - // standards in an account. + // An object that defines which security controls are enabled in the + // configuration policy. The enablement status of a control is aligned across all + // of the enabled standards in an account. SecurityControlsConfiguration *SecurityControlsConfiguration - // Indicates whether Security Hub is enabled in the policy. + // Indicates whether Security Hub is enabled in the policy. ServiceEnabled *bool noSmithyDocumentSerde @@ -16490,36 +17866,57 @@ type SensitiveDataResult struct { noSmithyDocumentSerde } -// 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 -// 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. +// 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 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 Label SeverityLabel // Deprecated. The normalized severity of a finding. Instead of providing - // Normalized , provide Label . If you provide Label and do not provide Normalized - // , then Normalized is set automatically as follows. + // 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 Normalized *int32 @@ -16527,8 +17924,10 @@ type Severity struct { Original *string // Deprecated. This attribute isn't included in findings. 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 , provide Original . + // + // The native severity as defined by the Amazon Web Services service or integrated + // partner product that generated the finding. Product *float64 noSmithyDocumentSerde @@ -16538,20 +17937,32 @@ 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. 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. + // 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 @@ -16623,9 +18034,10 @@ type Standard struct { // Whether the standard is enabled by default. When Security Hub is enabled from // 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 . + // 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 . EnabledByDefault *bool // The name of the standard. @@ -16669,9 +18081,10 @@ type StandardsControl struct { // documentation. RemediationUrl *string - // The severity of findings generated from this security standard control. The - // finding severity is based on an assessment of how easy it would be to compromise - // Amazon Web Services resources if the issue is detected. + // The severity of findings generated from this security standard control. + // + // The finding severity is based on an assessment of how easy it would be to + // compromise Amazon Web Services resources if the issue is detected. SeverityRating SeverityRating // The ARN of the security standard control. @@ -16686,72 +18099,73 @@ type StandardsControl struct { // Provides details about a control's enablement status in a specified standard. type StandardsControlAssociationDetail struct { - // Specifies whether a control is enabled or disabled in a specified standard. + // Specifies whether a control is enabled or disabled in a specified standard. // // This member is required. AssociationStatus AssociationStatus - // The ARN of a security control across standards, such as + // The ARN of a security control across standards, such as // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1 . This // parameter doesn't mention a specific standard. // // This member is required. SecurityControlArn *string - // The unique identifier of a security control across standards. Values for this + // The unique identifier of a security control across standards. Values for this // field typically consist of an Amazon Web Service name and a number, such as // APIGateway.3. // // This member is required. SecurityControlId *string - // The Amazon Resource Name (ARN) of a security standard. + // The Amazon Resource Name (ARN) of a security standard. // // This member is required. StandardsArn *string - // The requirement that underlies a control in the compliance framework related to - // the standard. + // The requirement that underlies a control in the compliance framework related + // to the standard. 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) - // API. This API can be used to enable or disable a control in a specified - // standard. + // Provides the input parameter that Security Hub uses to call the [UpdateStandardsControl] API. This API + // can be used to enable or disable a control in a specified standard. + // + // [UpdateStandardsControl]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_UpdateStandardsControl.html StandardsControlArns []string - // The description of a control. This typically summarizes how Security Hub + // The description of a control. This typically summarizes how Security Hub // evaluates the control and the conditions under which it produces a failed // finding. This parameter may reference a specific standard. StandardsControlDescription *string - // The title of a control. This field may reference a specific standard. + // 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 + // 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 + // The reason for updating the enablement status of a control in a specified // standard. UpdatedReason *string noSmithyDocumentSerde } -// An array with one or more objects that includes a security control (identified +// 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. type StandardsControlAssociationId struct { - // The unique identifier (identified with SecurityControlId , SecurityControlArn , + // 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 - // The ARN of a standard. + // The ARN of a standard. // // This member is required. StandardsArn *string @@ -16759,44 +18173,45 @@ type StandardsControlAssociationId struct { noSmithyDocumentSerde } -// An array that provides the enablement status and other details for each control -// that applies to each enabled standard. +// An array that provides the enablement status and other details for each +// +// control that applies to each enabled standard. type StandardsControlAssociationSummary struct { - // The enablement status of a control in a specific standard. + // The enablement status of a control in a specific standard. // // This member is required. AssociationStatus AssociationStatus - // The ARN of a control, such as + // The ARN of a control, such as // arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1 . This // parameter doesn't mention a specific standard. // // This member is required. SecurityControlArn *string - // A unique standard-agnostic identifier for a control. Values for this field + // A unique standard-agnostic identifier for a control. Values for this field // typically consist of an Amazon Web Service and a number, such as APIGateway.5. // This field doesn't reference a specific standard. // // This member is required. SecurityControlId *string - // The Amazon Resource Name (ARN) of a standard. + // The Amazon Resource Name (ARN) of a standard. // // This member is required. StandardsArn *string - // The requirement that underlies this control in the compliance framework related - // to the standard. + // The requirement that underlies this control in the compliance framework + // related to the standard. RelatedRequirements []string - // The description of a control. This typically summarizes how Security Hub + // The description of a control. This typically summarizes how Security Hub // evaluates the control and the conditions under which it produces a failed // finding. The parameter may reference a specific standard. StandardsControlDescription *string - // The title of a control. + // The title of a control. StandardsControlTitle *string // The last time that a control's enablement status in a specified standard was @@ -16878,12 +18293,19 @@ type StandardsSubscription struct { // This member is required. StandardsInput map[string]string - // The status of the standard subscription. The status values are as follows: + // 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. // // This member is required. @@ -16947,8 +18369,9 @@ type StatelessCustomPublishMetricActionDimension struct { 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) - // in the Security Hub User Guide. + // reason codes and their meanings, see [Standards-related information in the ASFF]in the Security Hub User Guide. + // + // [Standards-related information in the ASFF]: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff // // This member is required. ReasonCode *string @@ -16962,13 +18385,13 @@ type StatusReason struct { // The options for customizing a security control parameter that is a string. type StringConfigurationOptions struct { - // The Security Hub default value for a control parameter that is a string. + // The Security Hub default value for a control parameter that is a string. DefaultValue *string - // The description of the RE2 regular expression. + // The description of the RE2 regular expression. ExpressionDescription *string - // An RE2 regular expression that Security Hub uses to validate a user-provided + // An RE2 regular expression that Security Hub uses to validate a user-provided // control parameter string. Re2Expression *string @@ -16979,57 +18402,77 @@ type StringConfigurationOptions struct { type StringFilter struct { // The condition to apply to a string value when filtering Security Hub findings. + // // To search for values that have the filter value, use one of the following // comparison operators: + // // - To search for values that include the filter value, use CONTAINS . For // example, the filter Title CONTAINS CloudFront matches findings that have a // Title that includes the string CloudFront. + // // - To search for values that exactly match the filter value, use EQUALS . For // example, the filter AwsAccountId EQUALS 123456789012 only matches findings // that have an account ID of 123456789012 . + // // - To search for values that start with the filter value, use PREFIX . For // example, the filter ResourceRegion PREFIX us matches findings that have a // ResourceRegion that starts with us . A ResourceRegion that starts with a // different value, such as af , ap , or ca , doesn't match. + // // CONTAINS , EQUALS , and PREFIX filters on the same field are joined by OR . A // finding matches if it matches any one of those filters. For example, the filters // Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that - // includes either CloudFront , CloudWatch , or both strings in the title. To - // search for values that don’t have the filter value, use one of the following + // includes either CloudFront , CloudWatch , or both strings in the title. + // + // To search for values that don’t have the filter value, use one of the following // comparison operators: + // // - To search for values that exclude the filter value, use NOT_CONTAINS . For // example, the filter Title NOT_CONTAINS CloudFront matches findings that have a // Title that excludes the string CloudFront. + // // - To search for values other than the filter value, use NOT_EQUALS . For // example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings // that have an account ID other than 123456789012 . + // // - To search for values that don't start with the filter value, use // PREFIX_NOT_EQUALS . For example, the filter ResourceRegion PREFIX_NOT_EQUALS // us matches findings with a ResourceRegion that starts with a value other than // us . + // // NOT_CONTAINS , 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 // example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS // CloudWatch match a finding that excludes both CloudFront and CloudWatch in the - // title. You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the - // same field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS - // or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way + // title. + // + // You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same + // field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS or + // PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way // returns an error. CONTAINS filters can only be used with other CONTAINS // filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters. + // // You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for // the same field. Security Hub first processes the PREFIX filters, and then the - // NOT_EQUALS or PREFIX_NOT_EQUALS filters. For example, for the following - // filters, 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 . + // NOT_EQUALS or PREFIX_NOT_EQUALS filters. + // + // For example, for the following filters, 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 + // // CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For - // more information, see Automation rules (https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) - // in the Security Hub User Guide. + // more information, see [Automation rules]in the Security Hub User Guide. + // + // [Automation rules]: https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html Comparison StringFilterComparison // The string filter value. Filter values are case sensitive. For example, the @@ -17040,31 +18483,33 @@ type StringFilter struct { noSmithyDocumentSerde } -// The options for customizing a security control parameter that is a list of +// The options for customizing a security control parameter that is a list of +// // strings. type StringListConfigurationOptions struct { - // The Security Hub default value for a control parameter that is a list of + // The Security Hub default value for a control parameter that is a list of // strings. DefaultValue []string - // The description of the RE2 regular expression. + // The description of the RE2 regular expression. ExpressionDescription *string - // The maximum number of list items that a string list control parameter can + // The maximum number of list items that a string list control parameter can // accept. MaxItems *int32 - // An RE2 regular expression that Security Hub uses to validate a user-provided + // An RE2 regular expression that Security Hub uses to validate a user-provided // list of strings for a control parameter. Re2Expression *string noSmithyDocumentSerde } -// The target account, organizational unit, or the root that is associated with an -// Security Hub configuration. The configuration can be a configuration policy or -// self-managed behavior. +// The target account, organizational unit, or the root that is associated with +// +// an Security Hub configuration. The configuration can be a configuration policy +// or self-managed behavior. // // The following types satisfy this interface: // @@ -17128,15 +18573,21 @@ type ThreatIntelIndicator struct { Category ThreatIntelIndicatorCategory // Indicates when the most recent instance of a threat intelligence indicator was - // observed. This field accepts only the specified formats. Timestamps can end with - // Z or ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // observed. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) LastObservedAt *string @@ -17157,67 +18608,73 @@ type ThreatIntelIndicator struct { noSmithyDocumentSerde } -// A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This +// A list of objects containing RuleArn , ErrorCode , and ErrorMessage . This +// // parameter tells you which automation rules the request didn't process and why. type UnprocessedAutomationRule struct { - // The error code associated with the unprocessed automation rule. + // The error code associated with the unprocessed automation rule. ErrorCode *int32 - // An error message describing why a request didn't process a specific rule. + // An error message describing why a request didn't process a specific rule. ErrorMessage *string - // The Amazon Resource Name (ARN) for the unprocessed automation rule. + // The Amazon Resource Name (ARN) for the unprocessed automation rule. RuleArn *string noSmithyDocumentSerde } -// An array of configuration policy associations, one for each configuration +// An array of configuration policy associations, one for each configuration +// // policy association identifier, that was specified in a // BatchGetConfigurationPolicyAssociations request but couldn’t be processed due to // an error. type UnprocessedConfigurationPolicyAssociation struct { - // Configuration policy association identifiers that were specified in a + // Configuration policy association identifiers that were specified in a // BatchGetConfigurationPolicyAssociations request but couldn’t be processed due to // an error. ConfigurationPolicyAssociationIdentifiers *ConfigurationPolicyAssociation - // An HTTP status code that identifies why the configuration policy association + // An HTTP status code that identifies why the configuration policy association // failed. ErrorCode *string - // A string that identifies why the configuration policy association failed. + // A string that identifies why the configuration policy association failed. ErrorReason *string noSmithyDocumentSerde } -// Provides details about a security control for which a response couldn't be +// Provides details about a security control for which a response couldn't be +// // returned. type UnprocessedSecurityControl struct { - // The error code for the unprocessed security control. + // The error code for the unprocessed security control. // // This member is required. ErrorCode UnprocessedErrorCode - // The control (identified with SecurityControlId , SecurityControlArn , or a mix + // 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 - // The reason why the security control was unprocessed. + // The reason why the security control was unprocessed. ErrorReason *string noSmithyDocumentSerde } -// 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. +// Provides details about which control's enablement status couldn't be retrieved +// +// in a specified standard when calling [BatchUpdateStandardsControlAssociations]. This parameter also provides details +// about why the request was unprocessed. +// +// [BatchUpdateStandardsControlAssociations]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html type UnprocessedStandardsControlAssociation struct { // The error code for the unprocessed standard and control association. @@ -17225,12 +18682,13 @@ type UnprocessedStandardsControlAssociation struct { // This member is required. ErrorCode UnprocessedErrorCode - // An array with one or more objects that includes a security control (identified + // 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 // 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]. + // + // [BatchUpdateStandardsControlAssociations]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html // // This member is required. StandardsControlAssociationId *StandardsControlAssociationId @@ -17242,8 +18700,10 @@ type UnprocessedStandardsControlAssociation struct { } // 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. +// in a specified standard when calling the [BatchUpdateStandardsControlAssociations]API. This parameter also provides +// details about why the request was unprocessed. +// +// [BatchUpdateStandardsControlAssociations]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html type UnprocessedStandardsControlAssociationUpdate struct { // The error code for the unprocessed update of the control's enablement status in @@ -17253,8 +18713,9 @@ 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]. + // + // [BatchUpdateStandardsControlAssociations]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateStandardsControlAssociations.html // // This member is required. StandardsControlAssociationUpdate *StandardsControlAssociationUpdate @@ -17269,22 +18730,22 @@ type UnprocessedStandardsControlAssociationUpdate struct { // Specifies the parameters to update in an existing automation rule. type UpdateAutomationRulesRequestItem struct { - // The Amazon Resource Name (ARN) for the rule. + // The Amazon Resource Name (ARN) for the rule. // // This member is required. RuleArn *string - // One or more actions to update finding fields if a finding matches the + // One or more actions to update finding fields if a finding matches the // conditions specified in Criteria . Actions []AutomationRulesAction - // A set of ASFF finding field attributes and corresponding expected values that + // A set of ASFF finding field attributes and corresponding expected values that // Security Hub uses to filter findings. If a rule is enabled and a finding matches // the conditions specified in this parameter, Security Hub applies the rule action // to the finding. Criteria *AutomationRulesFindingFilters - // A description of the rule. + // A description of the rule. Description *string // Specifies whether a rule is the last to be applied with respect to a finding @@ -17295,19 +18756,20 @@ type UpdateAutomationRulesRequestItem struct { // rule isn't terminal. IsTerminal *bool - // The name of the rule. + // The name of the rule. RuleName *string - // An integer ranging from 1 to 1000 that represents the order in which the rule + // An integer ranging from 1 to 1000 that represents the order in which the rule // action is applied to findings. Security Hub applies rules with lower values for // this parameter first. RuleOrder *int32 - // Whether the rule is active after it is created. If this parameter is equal to + // Whether the rule is active after it is created. If this parameter is equal to // ENABLED , Security Hub starts applying the rule to findings and finding updates // after the rule is created. To change the value of this parameter after creating - // a rule, use BatchUpdateAutomationRules (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html) - // . + // a rule, use [BatchUpdateAutomationRules]BatchUpdateAutomationRules . + // + // [BatchUpdateAutomationRules]: https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateAutomationRules.html RuleStatus RuleStatus noSmithyDocumentSerde @@ -17387,13 +18849,16 @@ type Vulnerability struct { // 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 FixAvailable VulnerabilityFixAvailable - // The date and time of the last exploit associated with a finding discovered in + // The date and time of the last exploit associated with a finding discovered in // your environment. LastKnownExploitAt *string @@ -17417,15 +18882,15 @@ type Vulnerability struct { // Inspector. type VulnerabilityCodeVulnerabilities struct { - // The Common Weakness Enumeration (CWE) item associated with the detected code + // The Common Weakness Enumeration (CWE) item associated with the detected code // vulnerability. Cwes []string - // Provides details about where a code vulnerability is located in your Lambda + // Provides details about where a code vulnerability is located in your Lambda // function. FilePath *CodeVulnerabilitiesFilePath - // The Amazon Resource Name (ARN) of the Lambda layer in which the code + // The Amazon Resource Name (ARN) of the Lambda layer in which the code // vulnerability is located. SourceArn *string @@ -17443,16 +18908,21 @@ type VulnerabilityVendor struct { // The URL of the vulnerability advisory. Url *string - // Indicates when the vulnerability advisory was created. This field accepts only - // the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" - // time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the vulnerability advisory was created. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) VendorCreatedAt *string @@ -17460,16 +18930,21 @@ type VulnerabilityVendor struct { // The severity that the vendor assigned to the vulnerability. VendorSeverity *string - // Indicates when the vulnerability advisory was last updated. This field accepts - // only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour - // [":" time-minute] . The time-secfrac after seconds is limited to a maximum of 9 - // digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with - // examples: + // Indicates when the vulnerability advisory was last updated. + // + // This field accepts only the specified formats. Timestamps can end with Z or + // ("+" / "-") time-hour [":" time-minute] . The time-secfrac after seconds is + // limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are + // valid timestamp formats with examples: + // // - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z ) - // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z - // ) + // + // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z ) + // // - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59 ) + // // - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759 ) + // // - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, // 2024-01-04T15:25:10.123456789+17:59 ) VendorUpdatedAt *string @@ -17482,9 +18957,14 @@ type VulnerabilityVendor struct { type WafAction struct { // Specifies how you want WAF to respond to requests that match the settings in a - // rule. Valid settings include the following: + // 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 @@ -17506,8 +18986,9 @@ 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 @@ -17519,19 +19000,27 @@ type Workflow struct { // The status of the investigation into the finding. The workflow status is // specific to an individual finding. It does not affect the generation of new // 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: + // 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. Status WorkflowStatus @@ -17545,19 +19034,27 @@ type WorkflowUpdate struct { // The status of the investigation into the finding. The workflow status is // specific to an individual finding. It does not affect the generation of new // 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: + // 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. Status WorkflowStatus diff --git a/service/securitylake/api_op_CreateAwsLogSource.go b/service/securitylake/api_op_CreateAwsLogSource.go index 651d811b6ab..2343898e899 100644 --- a/service/securitylake/api_op_CreateAwsLogSource.go +++ b/service/securitylake/api_op_CreateAwsLogSource.go @@ -16,9 +16,11 @@ import ( // Regions, based on the parameters you specify. You can choose any source type in // any Region for either accounts that are part of a trusted organization or // standalone accounts. Once you add an Amazon Web Service as a source, Security -// Lake starts collecting logs and events from it. 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. +// Lake starts collecting logs and events from it. +// +// 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. 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 ac0e2f957a6..a56e4e9da48 100644 --- a/service/securitylake/api_op_CreateCustomLogSource.go +++ b/service/securitylake/api_op_CreateCustomLogSource.go @@ -50,34 +50,63 @@ type CreateCustomLogSourceInput struct { // The Open Cybersecurity Schema Framework (OCSF) event classes which describes // the type of data that the custom source will send to Security Lake. The // supported event classes are: + // // - ACCESS_ACTIVITY + // // - FILE_ACTIVITY + // // - KERNEL_ACTIVITY + // // - KERNEL_EXTENSION + // // - MEMORY_ACTIVITY + // // - MODULE_ACTIVITY + // // - PROCESS_ACTIVITY + // // - REGISTRY_KEY_ACTIVITY + // // - REGISTRY_VALUE_ACTIVITY + // // - RESOURCE_ACTIVITY + // // - SCHEDULED_JOB_ACTIVITY + // // - SECURITY_FINDING + // // - ACCOUNT_CHANGE + // // - AUTHENTICATION + // // - AUTHORIZATION + // // - ENTITY_MANAGEMENT_AUDIT + // // - DHCP_ACTIVITY + // // - NETWORK_ACTIVITY + // // - DNS_ACTIVITY + // // - FTP_ACTIVITY + // // - HTTP_ACTIVITY + // // - RDP_ACTIVITY + // // - SMB_ACTIVITY + // // - SSH_ACTIVITY + // // - CONFIG_STATE + // // - INVENTORY_INFO + // // - EMAIL_ACTIVITY + // // - API_ACTIVITY + // // - CLOUD_API EventClasses []string diff --git a/service/securitylake/api_op_CreateDataLake.go b/service/securitylake/api_op_CreateDataLake.go index 6c1444a41fd..0ceebd7b383 100644 --- a/service/securitylake/api_op_CreateDataLake.go +++ b/service/securitylake/api_op_CreateDataLake.go @@ -19,14 +19,16 @@ import ( // command, the command will update the Region if you provide new configuration // parameters. If you have not already enabled Security Lake in the Region when you // call this API, it will set up the data lake in the Region with the specified -// configurations. When you enable Security Lake, it starts ingesting security data -// after the CreateAwsLogSource call. This includes ingesting security data from -// sources, storing data, and making data accessible to subscribers. Security Lake -// 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) -// . +// configurations. +// +// When you enable Security Lake, it starts ingesting security data after the +// CreateAwsLogSource call. This includes ingesting security data from sources, +// storing data, and making data accessible to subscribers. Security Lake 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]. +// +// [Amazon Security Lake User 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_DeleteAwsLogSource.go b/service/securitylake/api_op_DeleteAwsLogSource.go index 684c63ef54d..4387edc136c 100644 --- a/service/securitylake/api_op_DeleteAwsLogSource.go +++ b/service/securitylake/api_op_DeleteAwsLogSource.go @@ -16,9 +16,10 @@ import ( // source, Security Lake stops collecting data from that source in the specified // Regions and accounts, and subscribers can no longer consume new data from the // source. However, subscribers can still consume data that Security Lake collected -// from the source before removal. You can choose any source type in any Amazon Web -// Services Region for either accounts that are part of a trusted organization or -// standalone accounts. +// from the source before removal. +// +// You can choose any source type in any Amazon Web Services Region for either +// accounts that are part of a trusted organization or standalone accounts. func (c *Client) DeleteAwsLogSource(ctx context.Context, params *DeleteAwsLogSourceInput, optFns ...func(*Options)) (*DeleteAwsLogSourceOutput, error) { if params == nil { params = &DeleteAwsLogSourceInput{} diff --git a/service/securitylake/api_op_DeleteDataLake.go b/service/securitylake/api_op_DeleteDataLake.go index 9b508a92059..0c9ade040ed 100644 --- a/service/securitylake/api_op_DeleteDataLake.go +++ b/service/securitylake/api_op_DeleteDataLake.go @@ -15,11 +15,13 @@ import ( // your sources. Also, this API automatically takes steps to remove the account // from Security Lake. However, Security Lake retains all of your existing settings // and the resources that it created in your Amazon Web Services account in the -// current Amazon Web Services Region. The DeleteDataLake operation does not -// delete the data that is stored in your 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) -// . +// current Amazon Web Services Region. +// +// The DeleteDataLake operation does not delete the data that is stored in your +// Amazon S3 bucket, which is owned by your Amazon Web Services account. For more +// information, see the [Amazon Security Lake User Guide]. +// +// [Amazon Security 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_GetDataLakeSources.go b/service/securitylake/api_op_GetDataLakeSources.go index 8849cad6a7f..236a4602778 100644 --- a/service/securitylake/api_op_GetDataLakeSources.go +++ b/service/securitylake/api_op_GetDataLakeSources.go @@ -42,9 +42,10 @@ type GetDataLakeSourcesInput struct { // Lists if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return an - // HTTP 400 InvalidToken error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return an HTTP 400 InvalidToken error. NextToken *string noSmithyDocumentSerde @@ -53,9 +54,9 @@ type GetDataLakeSourcesInput struct { type GetDataLakeSourcesOutput struct { // 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 the 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 the [Amazon Security Lake User Guide]. + // + // [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-management.html DataLakeArn *string // The list of enabled accounts and enabled sources. @@ -63,9 +64,10 @@ type GetDataLakeSourcesOutput struct { // Lists if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return an - // HTTP 400 InvalidToken error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return an HTTP 400 InvalidToken error. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_ListDataLakeExceptions.go b/service/securitylake/api_op_ListDataLakeExceptions.go index 2266b5573dd..bc823e47a30 100644 --- a/service/securitylake/api_op_ListDataLakeExceptions.go +++ b/service/securitylake/api_op_ListDataLakeExceptions.go @@ -35,9 +35,10 @@ type ListDataLakeExceptionsInput struct { // List if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return an - // HTTP 400 InvalidToken error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return an HTTP 400 InvalidToken error. NextToken *string // The Amazon Web Services Regions from which exceptions are retrieved. @@ -53,9 +54,10 @@ type ListDataLakeExceptionsOutput struct { // List if there are more results available. The value of nextToken is a unique // pagination token for each page. Repeat the call using the returned token to - // retrieve the next page. Keep all other arguments unchanged. Each pagination - // token expires after 24 hours. Using an expired pagination token will return an - // HTTP 400 InvalidToken error. + // retrieve the next page. Keep all other arguments unchanged. + // + // Each pagination token expires after 24 hours. Using an expired pagination token + // will return an HTTP 400 InvalidToken error. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/securitylake/api_op_TagResource.go b/service/securitylake/api_op_TagResource.go index 54f30b3e176..5ce3788c4c7 100644 --- a/service/securitylake/api_op_TagResource.go +++ b/service/securitylake/api_op_TagResource.go @@ -19,8 +19,9 @@ import ( // general label that acts as a category for a more specific tag value. A tag value // acts as a descriptor for a tag key. Tags can help you identify, categorize, and // manage resources in different ways, such as by owner, environment, or other -// criteria. For more information, see Tagging Amazon Security Lake resources (https://docs.aws.amazon.com/security-lake/latest/userguide/tagging-resources.html) -// in the Amazon Security Lake User Guide. +// criteria. For more information, see [Tagging Amazon Security Lake resources]in the Amazon Security Lake User Guide. +// +// [Tagging Amazon Security Lake resources]: https://docs.aws.amazon.com/security-lake/latest/userguide/tagging-resources.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/securitylake/api_op_UpdateSubscriber.go b/service/securitylake/api_op_UpdateSubscriber.go index 71187a7e504..d9f9c29bbf6 100644 --- a/service/securitylake/api_op_UpdateSubscriber.go +++ b/service/securitylake/api_op_UpdateSubscriber.go @@ -37,9 +37,9 @@ type UpdateSubscriberInput struct { SubscriberId *string // 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) - // . + // the list of supported Amazon Web Services, see the [Amazon Security Lake User Guide]. + // + // [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html Sources []types.LogSourceResource // The description of the Security Lake account subscriber. diff --git a/service/securitylake/doc.go b/service/securitylake/doc.go index 601b3cf8b69..e59d9cdb126 100644 --- a/service/securitylake/doc.go +++ b/service/securitylake/doc.go @@ -12,27 +12,34 @@ // 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 +// 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]. +// +// 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 // standard open-source schema called the Open Cybersecurity Schema Framework -// (OCSF). Other Amazon Web Services and third-party services can subscribe to the -// data that's stored in Security Lake for incident response and security data +// (OCSF). +// +// Other Amazon Web Services and third-party services can subscribe to the data +// that's stored in Security Lake for incident response and security data // analytics. +// +// [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html package securitylake diff --git a/service/securitylake/options.go b/service/securitylake/options.go index 0e1d88c8a88..90f09a00b36 100644 --- a/service/securitylake/options.go +++ b/service/securitylake/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/securitylake/types/enums.go b/service/securitylake/types/enums.go index 16ac9d01795..2eba998fcf8 100644 --- a/service/securitylake/types/enums.go +++ b/service/securitylake/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessType) Values() []AccessType { return []AccessType{ "LAKEFORMATION", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AwsLogSourceName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AwsLogSourceName) Values() []AwsLogSourceName { return []AwsLogSourceName{ "ROUTE53", @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for DataLakeStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataLakeStatus) Values() []DataLakeStatus { return []DataLakeStatus{ "INITIALIZED", @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for HttpMethod. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HttpMethod) Values() []HttpMethod { return []HttpMethod{ "POST", @@ -100,8 +104,9 @@ const ( ) // Values returns all known values for SourceCollectionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceCollectionStatus) Values() []SourceCollectionStatus { return []SourceCollectionStatus{ "COLLECTING", @@ -121,8 +126,9 @@ const ( ) // Values returns all known values for SubscriberStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriberStatus) Values() []SubscriberStatus { return []SubscriberStatus{ "ACTIVE", diff --git a/service/securitylake/types/types.go b/service/securitylake/types/types.go index e637ada6f4e..d7438e7085b 100644 --- a/service/securitylake/types/types.go +++ b/service/securitylake/types/types.go @@ -101,7 +101,9 @@ type CustomLogSourceCrawlerConfiguration 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 // // This member is required. @@ -253,15 +255,19 @@ type DataLakeLifecycleTransition struct { type DataLakeReplicationConfiguration struct { // Specifies one or more centralized rollup Regions. The Amazon Web Services - // Region specified in the region parameter of the CreateDataLake (https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html) - // or UpdateDataLake (https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html) + // Region specified in the region parameter of the [CreateDataLake]CreateDataLake or [UpdateDataLake]UpdateDataLake // operations contributes data to the rollup Region or Regions specified in this - // parameter. Replication enables automatic, asynchronous copying of objects across - // Amazon S3 buckets. S3 buckets that are configured for object replication can be - // owned by the same Amazon Web Services account or by different accounts. You can - // replicate objects to a single destination bucket or to multiple destination - // buckets. The destination buckets can be in different Regions or within the same - // Region as the source bucket. + // parameter. + // + // Replication enables automatic, asynchronous copying of objects across Amazon S3 + // buckets. S3 buckets that are configured for object replication can be owned by + // the same Amazon Web Services account or by different accounts. You can replicate + // objects to a single destination bucket or to multiple destination buckets. The + // destination buckets can be in different Regions or within the same Region as the + // source bucket. + // + // [UpdateDataLake]: https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html + // [CreateDataLake]: https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html Regions []string // Replication settings for the Amazon S3 buckets. This parameter uses the @@ -276,9 +282,9 @@ type DataLakeReplicationConfiguration struct { type DataLakeResource struct { // 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 the 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 the [Amazon Security Lake User Guide]. + // + // [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/subscriber-management.html // // This member is required. DataLakeArn *string @@ -312,8 +318,9 @@ type DataLakeResource struct { // 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) -// . +// the [Amazon Security Lake User Guide]. +// +// [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html type DataLakeSource struct { // The ID of the Security Lake account for which logs are collected. @@ -322,34 +329,63 @@ type DataLakeSource struct { // The Open Cybersecurity Schema Framework (OCSF) event classes which describes // the type of data that the custom source will send to Security Lake. The // supported event classes are: + // // - ACCESS_ACTIVITY + // // - FILE_ACTIVITY + // // - KERNEL_ACTIVITY + // // - KERNEL_EXTENSION + // // - MEMORY_ACTIVITY + // // - MODULE_ACTIVITY + // // - PROCESS_ACTIVITY + // // - REGISTRY_KEY_ACTIVITY + // // - REGISTRY_VALUE_ACTIVITY + // // - RESOURCE_ACTIVITY + // // - SCHEDULED_JOB_ACTIVITY + // // - SECURITY_FINDING + // // - ACCOUNT_CHANGE + // // - AUTHENTICATION + // // - AUTHORIZATION + // // - ENTITY_MANAGEMENT_AUDIT + // // - DHCP_ACTIVITY + // // - NETWORK_ACTIVITY + // // - DNS_ACTIVITY + // // - FTP_ACTIVITY + // // - HTTP_ACTIVITY + // // - RDP_ACTIVITY + // // - SMB_ACTIVITY + // // - SSH_ACTIVITY + // // - CONFIG_STATE + // // - INVENTORY_INFO + // // - EMAIL_ACTIVITY + // // - API_ACTIVITY + // // - CLOUD_API EventClasses []string @@ -422,9 +458,10 @@ type HttpsNotificationConfiguration struct { // 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. + // policies, see [Managing data access]and [Amazon Web Services Managed Policies] in the Amazon Security Lake User Guide. + // + // [Managing data access]: https://docs.aws.amazon.com//security-lake/latest/userguide/subscriber-data-access.html + // [Amazon Web Services Managed Policies]: https://docs.aws.amazon.com/security-lake/latest/userguide/security-iam-awsmanpol.html // // This member is required. TargetRoleArn *string @@ -458,22 +495,22 @@ type LogSource struct { } // The supported source types from which logs and events are collected in Amazon -// Security Lake. For a 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. For a list of supported Amazon Web Services, see the [Amazon Security Lake User Guide]. // // The following types satisfy this interface: // // LogSourceResourceMemberAwsLogSource // LogSourceResourceMemberCustomLogSource +// +// [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html type LogSourceResource interface { isLogSourceResource() } // Amazon Security Lake supports log and event collection for natively supported -// Amazon Web Services. For more information, see the Amazon Security Lake User -// Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html) -// . +// Amazon Web Services. For more information, see the [Amazon Security Lake User Guide]. +// +// [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html type LogSourceResourceMemberAwsLogSource struct { Value AwsLogSourceResource @@ -483,8 +520,9 @@ type LogSourceResourceMemberAwsLogSource struct { func (*LogSourceResourceMemberAwsLogSource) isLogSourceResource() {} // Amazon Security Lake supports custom source types. For more information, see -// the Amazon Security Lake User Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/custom-sources.html) -// . +// the [Amazon Security Lake User Guide]. +// +// [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/custom-sources.html type LogSourceResourceMemberCustomLogSource struct { Value CustomLogSourceResource @@ -534,9 +572,9 @@ type SqsNotificationConfiguration struct { type SubscriberResource struct { // Amazon Security Lake supports log and event collection for natively supported - // Amazon Web Services. For more information, see the Amazon Security Lake User - // Guide (https://docs.aws.amazon.com/security-lake/latest/userguide/source-management.html) - // . + // Amazon Web Services. For more information, see the [Amazon Security Lake User Guide]. + // + // [Amazon Security Lake User Guide]: https://docs.aws.amazon.com/security-lake/latest/userguide/source-management.html // // This member is required. Sources []LogSourceResource @@ -563,9 +601,11 @@ type SubscriberResource struct { // You can choose to notify subscribers of new objects with an Amazon Simple Queue // 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 . + // 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 . AccessTypes []AccessType // The date and time when the subscriber was created. @@ -573,8 +613,10 @@ type SubscriberResource struct { // The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource // share. Before accepting the RAM resource share invitation, you can view details - // related to the RAM resource share. This field is available only for Lake - // Formation subscribers created after March 8, 2023. + // related to the RAM resource share. + // + // This field is available only for Lake Formation subscribers created after March + // 8, 2023. ResourceShareArn *string // The name of the resource share. @@ -608,14 +650,18 @@ type SubscriberResource struct { // by owner, environment, or other criteria. You can associate tags with the // following types of Security Lake resources: subscribers, and the data lake // configuration for your Amazon Web Services account in individual Amazon Web -// Services Regions. A resource can have up to 50 tags. Each tag consists of a -// required tag key and an associated tag value. A tag key is a general label that -// acts as a category for a more specific tag value. Each tag key must be unique -// and it can have only one tag value. A tag value acts as a descriptor for a tag -// key. Tag keys and values are case sensitive. They can contain letters, numbers, -// spaces, or the following symbols: _ . : / = + @ - For more information, see -// Tagging Amazon Security Lake resources (https://docs.aws.amazon.com/security-lake/latest/userguide/tagging-resources.html) -// in the Amazon Security Lake User Guide. +// Services Regions. +// +// A resource can have up to 50 tags. Each tag consists of a required tag key and +// an associated tag value. A tag key is a general label that acts as a category +// for a more specific tag value. Each tag key must be unique and it can have only +// one tag value. A tag value acts as a descriptor for a tag key. Tag keys and +// values are case sensitive. They can contain letters, numbers, spaces, or the +// following symbols: _ . : / = + @ - +// +// For more information, see [Tagging Amazon Security Lake resources] in the Amazon Security Lake User Guide. +// +// [Tagging Amazon Security Lake resources]: https://docs.aws.amazon.com/security-lake/latest/userguide/tagging-resources.html type Tag struct { // The name of the tag. This is a general label that acts as a category for a more diff --git a/service/serverlessapplicationrepository/api_op_CreateApplication.go b/service/serverlessapplicationrepository/api_op_CreateApplication.go index 7d9ab21a3d0..9cd74971b16 100644 --- a/service/serverlessapplicationrepository/api_op_CreateApplication.go +++ b/service/serverlessapplicationrepository/api_op_CreateApplication.go @@ -30,19 +30,27 @@ func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicatio type CreateApplicationInput struct { - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the author publishing the app. + // + // Minimum length=1. Maximum length=127. + // + // Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; // // This member is required. Author *string - // The description of the application.Minimum length=1. Maximum length=256 + // The description of the application. + // + // Minimum length=1. Maximum length=256 // // This member is required. Description *string - // The name of the application that you want to publish.Minimum length=1. Maximum - // length=140Pattern: "[a-zA-Z0-9\\-]+"; + // The name of the application that you want to publish. + // + // Minimum length=1. Maximum length=140 + // + // Pattern: "[a-zA-Z0-9\\-]+"; // // This member is required. Name *string @@ -51,54 +59,85 @@ type CreateApplicationInput struct { // your GitHub repository for the application. HomePageUrl *string - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + // Labels to improve discovery of apps in search results. + // + // Minimum length=1. Maximum length=127. Maximum number of labels: 10 + // + // Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []string // A local text file that contains the license of the app that matches the // spdxLicenseID value of your application. The file has the format - // file:///.Maximum size 5 MBYou can specify only one of - // licenseBody and licenseUrl; otherwise, an error results. + // file:///. + // + // Maximum size 5 MB + // + // You can specify only one of licenseBody and licenseUrl; otherwise, an error + // results. LicenseBody *string // A link to the S3 object that contains the license of the app that matches the - // spdxLicenseID value of your application.Maximum size 5 MBYou can specify only - // one of licenseBody and licenseUrl; otherwise, an error results. + // spdxLicenseID value of your application. + // + // Maximum size 5 MB + // + // You can specify only one of licenseBody and licenseUrl; otherwise, an error + // results. LicenseUrl *string // A local text readme file in Markdown language that contains a more detailed // description of the application and how it works. The file has the format - // file:///.Maximum size 5 MBYou can specify only one of readmeBody - // and readmeUrl; otherwise, an error results. + // file:///. + // + // Maximum size 5 MB + // + // You can specify only one of readmeBody and readmeUrl; otherwise, an error + // results. ReadmeBody *string // A link to the S3 object in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MBYou can specify - // only one of readmeBody and readmeUrl; otherwise, an error results. + // description of the application and how it works. + // + // Maximum size 5 MB + // + // You can specify 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/]: https://semver.org/ SemanticVersion *string // A link to the S3 object that contains the ZIP archive of the source code for - // this version of your application.Maximum size 50 MB + // this version of your application. + // + // Maximum size 50 MB SourceCodeArchiveUrl *string // A link to a public repository for the source code of your application, for // 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/]: https://spdx.org/licenses/ SpdxLicenseId *string // The local raw packaged AWS SAM template file of your application. The file has - // the format file:///.You can specify only one of templateBody and - // templateUrl; otherwise an error results. + // the format file:///. + // + // You can specify only one of templateBody and templateUrl; otherwise an error + // results. TemplateBody *string // A link to the S3 object containing the packaged AWS SAM template of your - // application.You can specify only one of templateBody and templateUrl; otherwise - // an error results. + // application. + // + // You can specify only one of templateBody and templateUrl; otherwise an error + // results. TemplateUrl *string noSmithyDocumentSerde @@ -109,14 +148,19 @@ type CreateApplicationOutput struct { // The application Amazon Resource Name (ARN). ApplicationId *string - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the author publishing the app. + // + // Minimum length=1. Maximum length=127. + // + // Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; Author *string // The date and time this resource was created. CreationTime *string - // The description of the application.Minimum length=1. Maximum length=256 + // The description of the application. + // + // Minimum length=1. Maximum length=256 Description *string // A URL with more information about the application, for example the location of @@ -129,20 +173,30 @@ type CreateApplicationOutput struct { // requester's identity is as claimed. IsVerifiedAuthor *bool - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + // Labels to improve discovery of apps in search results. + // + // Minimum length=1. Maximum length=127. Maximum number of labels: 10 + // + // Pattern: "^[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 + // your application. + // + // Maximum size 5 MB LicenseUrl *string - // The name of the application.Minimum length=1. Maximum length=140Pattern: - // "[a-zA-Z0-9\\-]+"; + // The name of the application. + // + // Minimum length=1. Maximum length=140 + // + // Pattern: "[a-zA-Z0-9\\-]+"; Name *string // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB + // description of the application and how it works. + // + // Maximum size 5 MB ReadmeUrl *string // A valid identifier from https://spdx.org/licenses/. diff --git a/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go b/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go index a8a36d8e036..c4cfc31f1c5 100644 --- a/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go +++ b/service/serverlessapplicationrepository/api_op_CreateApplicationVersion.go @@ -40,7 +40,9 @@ type CreateApplicationVersionInput struct { SemanticVersion *string // A link to the S3 object that contains the ZIP archive of the source code for - // this version of your application.Maximum size 50 MB + // this version of your application. + // + // Maximum size 50 MB SourceCodeArchiveUrl *string // A link to a public repository for the source code of your application, for @@ -71,39 +73,55 @@ type CreateApplicationVersionOutput struct { // applications. Some applications might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity and // Access Management (IAM) users. For those applications, you must explicitly - // 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 - // application that requires capabilities, the call will fail. + // 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], [AWS::IAM::InstanceProfile], [AWS::IAM::Policy], and [AWS::IAM::Role]. 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], [AWS::IAM:Policy], [AWS::ApplicationAutoScaling::ScalingPolicy] + // , [AWS::S3::BucketPolicy], [AWS::SQS::QueuePolicy], and [AWS::SNS::TopicPolicy]. + // + // 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. + // + // [AWS::SQS::QueuePolicy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html + // [AWS::SNS::TopicPolicy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-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::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 + // [AWS::IAM::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [AWS::IAM:Policy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html + // [AWS::Lambda::Permission]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html RequiredCapabilities []types.Capability // Whether all of the AWS resources contained in this application are supported in // 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/]: https://semver.org/ SemanticVersion *string // A link to the S3 object that contains the ZIP archive of the source code for - // this version of your application.Maximum size 50 MB + // this version of your application. + // + // Maximum size 50 MB SourceCodeArchiveUrl *string // A link to a public repository for the source code of your application, for diff --git a/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go b/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go index 8ee6f03a2a3..01991ee3d32 100644 --- a/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go +++ b/service/serverlessapplicationrepository/api_op_CreateCloudFormationChangeSet.go @@ -35,8 +35,9 @@ 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet // // This member is required. StackName *string @@ -45,72 +46,95 @@ type CreateCloudFormationChangeSetInput struct { // applications. Some applications might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity and // Access Management (IAM) users. For those applications, you must explicitly - // 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 - // application that requires capabilities, the call will fail. + // 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], [AWS::IAM::InstanceProfile], [AWS::IAM::Policy], and [AWS::IAM::Role]. 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], [AWS::IAM:Policy], [AWS::ApplicationAutoScaling::ScalingPolicy] + // , [AWS::S3::BucketPolicy], [AWS::SQS::QueuePolicy], and [AWS::SNS:TopicPolicy]. + // + // 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. + // + // [AWS::SQS::QueuePolicy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-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::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 + // [AWS::IAM::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [AWS::IAM:Policy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html + // [AWS::SNS:TopicPolicy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html + // [AWS::Lambda::Permission]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet NotificationArns []string // A list of parameter values for the parameters of the application. 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet 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/]: 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) - // API. + // CloudFormation [CreateChangeSet]API. + // + // [CreateChangeSet]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet Tags []types.Tag - // The UUID returned by CreateCloudFormationTemplate.Pattern: + // The UUID returned by CreateCloudFormationTemplate. + // + // Pattern: // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} TemplateId *string @@ -122,11 +146,18 @@ type CreateCloudFormationChangeSetOutput struct { // The application Amazon Resource Name (ARN). ApplicationId *string - // The Amazon Resource Name (ARN) of the change set.Length constraints: Minimum - // length of 1.Pattern: ARN:[-a-zA-Z0-9:/]* + // The Amazon Resource Name (ARN) of the change set. + // + // Length constraints: Minimum 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/]: 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 5eda009836f..68c4ddd361e 100644 --- a/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go +++ b/service/serverlessapplicationrepository/api_op_CreateCloudFormationTemplate.go @@ -34,7 +34,11 @@ 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/]: https://semver.org/ SemanticVersion *string noSmithyDocumentSerde @@ -51,14 +55,21 @@ 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/]: https://semver.org/ SemanticVersion *string - // Status of the template creation workflow.Possible values: PREPARING | ACTIVE | - // EXPIRED + // Status of the template creation workflow. + // + // Possible values: PREPARING | ACTIVE | EXPIRED Status types.Status - // The UUID returned by CreateCloudFormationTemplate.Pattern: + // The UUID returned by CreateCloudFormationTemplate. + // + // Pattern: // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} TemplateId *string diff --git a/service/serverlessapplicationrepository/api_op_GetApplication.go b/service/serverlessapplicationrepository/api_op_GetApplication.go index 51185cb974e..74035897157 100644 --- a/service/serverlessapplicationrepository/api_op_GetApplication.go +++ b/service/serverlessapplicationrepository/api_op_GetApplication.go @@ -45,14 +45,19 @@ type GetApplicationOutput struct { // The application Amazon Resource Name (ARN). ApplicationId *string - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the author publishing the app. + // + // Minimum length=1. Maximum length=127. + // + // Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; Author *string // The date and time this resource was created. CreationTime *string - // The description of the application.Minimum length=1. Maximum length=256 + // The description of the application. + // + // Minimum length=1. Maximum length=256 Description *string // A URL with more information about the application, for example the location of @@ -65,20 +70,30 @@ type GetApplicationOutput struct { // requester's identity is as claimed. IsVerifiedAuthor *bool - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + // Labels to improve discovery of apps in search results. + // + // Minimum length=1. Maximum length=127. Maximum number of labels: 10 + // + // Pattern: "^[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 + // your application. + // + // Maximum size 5 MB LicenseUrl *string - // The name of the application.Minimum length=1. Maximum length=140Pattern: - // "[a-zA-Z0-9\\-]+"; + // The name of the application. + // + // Minimum length=1. Maximum length=140 + // + // Pattern: "[a-zA-Z0-9\\-]+"; Name *string // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB + // description of the application and how it works. + // + // Maximum size 5 MB ReadmeUrl *string // A valid identifier from https://spdx.org/licenses/. diff --git a/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go b/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go index d2fd0d10a58..0d7cdbba773 100644 --- a/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go +++ b/service/serverlessapplicationrepository/api_op_GetCloudFormationTemplate.go @@ -34,7 +34,9 @@ type GetCloudFormationTemplateInput struct { // This member is required. ApplicationId *string - // The UUID returned by CreateCloudFormationTemplate.Pattern: + // The UUID returned by CreateCloudFormationTemplate. + // + // Pattern: // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} // // This member is required. @@ -54,14 +56,21 @@ 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/]: https://semver.org/ SemanticVersion *string - // Status of the template creation workflow.Possible values: PREPARING | ACTIVE | - // EXPIRED + // Status of the template creation workflow. + // + // Possible values: PREPARING | ACTIVE | EXPIRED Status types.Status - // The UUID returned by CreateCloudFormationTemplate.Pattern: + // The UUID returned by CreateCloudFormationTemplate. + // + // Pattern: // [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12} TemplateId *string diff --git a/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go b/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go index 2ff96e59e48..bee77cc9604 100644 --- a/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go +++ b/service/serverlessapplicationrepository/api_op_PutApplicationPolicy.go @@ -12,8 +12,9 @@ import ( ) // 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) -// . +// supported for this operation, see [Application Permissions]. +// +// [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 { params = &PutApplicationPolicyInput{} diff --git a/service/serverlessapplicationrepository/api_op_UnshareApplication.go b/service/serverlessapplicationrepository/api_op_UnshareApplication.go index eb4afd9b0bc..ae90812f59d 100644 --- a/service/serverlessapplicationrepository/api_op_UnshareApplication.go +++ b/service/serverlessapplicationrepository/api_op_UnshareApplication.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Unshares an application from an AWS Organization.This operation can be called -// only from the organization's master account. +// Unshares an application from an AWS Organization. +// +// This operation can be called only from the organization's master account. func (c *Client) UnshareApplication(ctx context.Context, params *UnshareApplicationInput, optFns ...func(*Options)) (*UnshareApplicationOutput, error) { if params == nil { params = &UnshareApplicationInput{} diff --git a/service/serverlessapplicationrepository/api_op_UpdateApplication.go b/service/serverlessapplicationrepository/api_op_UpdateApplication.go index 1651117f609..2d98c0f8e7c 100644 --- a/service/serverlessapplicationrepository/api_op_UpdateApplication.go +++ b/service/serverlessapplicationrepository/api_op_UpdateApplication.go @@ -34,27 +34,39 @@ type UpdateApplicationInput struct { // This member is required. ApplicationId *string - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the author publishing the app. + // + // Minimum length=1. Maximum length=127. + // + // Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; Author *string - // The description of the application.Minimum length=1. Maximum length=256 + // The description of the application. + // + // Minimum length=1. Maximum length=256 Description *string // A URL with more information about the application, for example the location of // your GitHub repository for the application. HomePageUrl *string - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + // Labels to improve discovery of apps in search results. + // + // Minimum length=1. Maximum length=127. Maximum number of labels: 10 + // + // Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; Labels []string // A text readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB + // description of the application and how it works. + // + // Maximum size 5 MB ReadmeBody *string // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB + // description of the application and how it works. + // + // Maximum size 5 MB ReadmeUrl *string noSmithyDocumentSerde @@ -65,14 +77,19 @@ type UpdateApplicationOutput struct { // The application Amazon Resource Name (ARN). ApplicationId *string - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the author publishing the app. + // + // Minimum length=1. Maximum length=127. + // + // Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; Author *string // The date and time this resource was created. CreationTime *string - // The description of the application.Minimum length=1. Maximum length=256 + // The description of the application. + // + // Minimum length=1. Maximum length=256 Description *string // A URL with more information about the application, for example the location of @@ -85,20 +102,30 @@ type UpdateApplicationOutput struct { // requester's identity is as claimed. IsVerifiedAuthor *bool - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + // Labels to improve discovery of apps in search results. + // + // Minimum length=1. Maximum length=127. Maximum number of labels: 10 + // + // Pattern: "^[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 + // your application. + // + // Maximum size 5 MB LicenseUrl *string - // The name of the application.Minimum length=1. Maximum length=140Pattern: - // "[a-zA-Z0-9\\-]+"; + // The name of the application. + // + // Minimum length=1. Maximum length=140 + // + // Pattern: "[a-zA-Z0-9\\-]+"; Name *string // A link to the readme file in Markdown language that contains a more detailed - // description of the application and how it works.Maximum size 5 MB + // description of the application and how it works. + // + // Maximum size 5 MB ReadmeUrl *string // A valid identifier from https://spdx.org/licenses/. diff --git a/service/serverlessapplicationrepository/doc.go b/service/serverlessapplicationrepository/doc.go index 9bbf1734f82..eb830a6e999 100644 --- a/service/serverlessapplicationrepository/doc.go +++ b/service/serverlessapplicationrepository/doc.go @@ -6,25 +6,33 @@ // The AWS Serverless Application Repository makes it easy for developers and // enterprises to quickly find and deploy serverless applications in the AWS Cloud. // For more information about serverless applications, see Serverless Computing and -// Applications on the AWS website.The AWS Serverless Application Repository is -// deeply integrated with the AWS Lambda console, so that developers of all levels -// can get started with serverless computing without needing to learn anything new. -// You can use category keywords to browse for applications such as web and mobile -// backends, data processing applications, or chatbots. You can also search for -// applications by name, publisher, or event source. To use an application, you -// simply choose it, configure any required fields, and deploy it with a few -// clicks. You can also easily publish applications, sharing them publicly with the +// Applications on the AWS website. +// +// The AWS Serverless Application Repository is deeply integrated with the AWS +// Lambda console, so that developers of all levels can get started with serverless +// computing without needing to learn anything new. You can use category keywords +// to browse for applications such as web and mobile backends, data processing +// applications, or chatbots. You can also search for applications by name, +// publisher, or event source. To use an application, you simply choose it, +// configure any required fields, and deploy it with a few clicks. +// +// You can also easily publish applications, sharing them publicly with the // community at large, or privately within your team or across your organization. // To publish a serverless application (or app), you can use the AWS Management // Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. // Along with the code, you upload a simple manifest file, also known as the AWS // Serverless Application Model (AWS SAM) template. For more information about AWS // 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: +// 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. +// 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/options.go b/service/serverlessapplicationrepository/options.go index be06d23b895..9ec27a32992 100644 --- a/service/serverlessapplicationrepository/options.go +++ b/service/serverlessapplicationrepository/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/serverlessapplicationrepository/types/enums.go b/service/serverlessapplicationrepository/types/enums.go index 9723fa30ccd..aa77c253928 100644 --- a/service/serverlessapplicationrepository/types/enums.go +++ b/service/serverlessapplicationrepository/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for Capability. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Capability) Values() []Capability { return []Capability{ "CAPABILITY_IAM", @@ -34,8 +35,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "PREPARING", diff --git a/service/serverlessapplicationrepository/types/types.go b/service/serverlessapplicationrepository/types/types.go index 41a4f1d2dc1..620a4b2d7d5 100644 --- a/service/serverlessapplicationrepository/types/types.go +++ b/service/serverlessapplicationrepository/types/types.go @@ -25,9 +25,9 @@ type ApplicationDependencySummary struct { // Policy statement applied to the application. 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) - // . + // For the list of actions supported for this operation, see [Application Permissions]. + // + // [Application 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,10 @@ 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) - // global condition key. + // An array of PrinciplalOrgIDs, which corresponds to AWS IAM [aws:PrincipalOrgID] global condition + // key. + // + // [aws:PrincipalOrgID]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id PrincipalOrgIDs []string // A unique ID for the statement. @@ -55,19 +57,27 @@ type ApplicationSummary struct { // This member is required. ApplicationId *string - // The name of the author publishing the app.Minimum length=1. Maximum - // length=127.Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; + // The name of the author publishing the app. + // + // Minimum length=1. Maximum length=127. + // + // Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$"; // // This member is required. Author *string - // The description of the application.Minimum length=1. Maximum length=256 + // The description of the application. + // + // Minimum length=1. Maximum length=256 // // This member is required. Description *string - // The name of the application.Minimum length=1. Maximum length=140Pattern: - // "[a-zA-Z0-9\\-]+"; + // The name of the application. + // + // Minimum length=1. Maximum length=140 + // + // Pattern: "[a-zA-Z0-9\\-]+"; // // This member is required. Name *string @@ -79,11 +89,16 @@ type ApplicationSummary struct { // your GitHub repository for the application. HomePageUrl *string - // Labels to improve discovery of apps in search results.Minimum length=1. Maximum - // length=127. Maximum number of labels: 10Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$"; + // Labels to improve discovery of apps in search results. + // + // Minimum length=1. Maximum length=127. Maximum number of labels: 10 + // + // Pattern: "^[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/]: https://spdx.org/licenses/ SpdxLicenseId *string noSmithyDocumentSerde @@ -111,11 +126,16 @@ type ParameterDefinition struct { // A string that explains a constraint when the constraint is violated. For // example, without a constraint description, a parameter that has an allowed // pattern of [A-Za-z0-9]+ displays the following error message when the user - // specifies an invalid value: Malformed input-Parameter MyParameter must match - // pattern [A-Za-z0-9]+ By adding a constraint description, such as "must contain - // only uppercase and lowercase letters and numbers," you can display the following - // customized error message: Malformed input-Parameter MyParameter must contain - // only uppercase and lowercase letters and numbers. + // specifies an invalid value: + // + // Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+ + // + // By adding a constraint description, such as "must contain only uppercase and + // lowercase letters and numbers," you can display the following customized error + // message: + // + // Malformed input-Parameter MyParameter must contain only uppercase and lowercase + // letters and numbers. ConstraintDescription *string // A value of the appropriate type for the template to use if no value is @@ -147,21 +167,34 @@ type ParameterDefinition struct { // asterisks (*****). NoEcho *bool - // The type of the parameter.Valid values: String | Number | List | - // CommaDelimitedList String: A literal string.For example, users can specify - // "MyUserName". Number: An integer or float. AWS CloudFormation validates the - // parameter value as a number. However, when you use the parameter elsewhere in - // your template (for example, by using the Ref intrinsic function), the parameter - // value becomes a string.For example, users might specify "8888". List: An - // array of integers or floats that are separated by commas. AWS CloudFormation - // validates the parameter value as numbers. However, when you use the parameter - // elsewhere in your template (for example, by using the Ref intrinsic function), - // the parameter value becomes a list of strings.For example, users might specify - // "80,20", and then Ref results in ["80","20"]. CommaDelimitedList: An array of - // literal strings that are separated by commas. The total number of strings should - // be one more than the total number of commas. Also, each member string is - // space-trimmed.For example, users might specify "test,dev,prod", and then Ref - // results in ["test","dev","prod"]. + // The type of the parameter. + // + // Valid values: String | Number | List | CommaDelimitedList + // + // String: A literal string. + // + // For example, users can specify "MyUserName". + // + // Number: An integer or float. AWS CloudFormation validates the parameter value + // as a number. However, when you use the parameter elsewhere in your template (for + // example, by using the Ref intrinsic function), the parameter value becomes a + // string. + // + // For example, users might specify "8888". + // + // List: An array of integers or floats that are separated by commas. AWS + // CloudFormation validates the parameter value as numbers. However, when you use + // the parameter elsewhere in your template (for example, by using the Ref + // intrinsic function), the parameter value becomes a list of strings. + // + // For example, users might specify "80,20", and then Ref results in ["80","20"]. + // + // CommaDelimitedList: An array of literal strings that are separated by commas. + // The total number of strings should be one more than the total number of commas. + // Also, each member string is space-trimmed. + // + // For example, users might specify "test,dev,prod", and then Ref results in + // ["test","dev","prod"]. Type *string noSmithyDocumentSerde @@ -185,37 +218,43 @@ type ParameterValue struct { noSmithyDocumentSerde } -// This property corresponds to the AWS CloudFormation RollbackConfiguration (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration) -// Data Type. +// This property corresponds to the AWS CloudFormation [RollbackConfiguration] Data Type. +// +// [RollbackConfiguration]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration 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) - // Data Type. + // CloudFormation [RollbackConfiguration]Data Type. + // + // [RollbackConfiguration]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration 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) - // Data Type. + // CloudFormation [RollbackConfiguration]Data Type. + // + // [RollbackConfiguration]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration RollbackTriggers []RollbackTrigger noSmithyDocumentSerde } -// This property corresponds to the AWS CloudFormation RollbackTrigger (https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger) -// Data Type. +// This property corresponds to the AWS CloudFormation [RollbackTrigger] Data Type. +// +// [RollbackTrigger]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger 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) - // Data Type. + // CloudFormation [RollbackTrigger]Data Type. + // + // [RollbackTrigger]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger // // 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) - // Data Type. + // CloudFormation [RollbackTrigger]Data Type. + // + // [RollbackTrigger]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger // // This member is required. Type *string @@ -223,20 +262,23 @@ 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] Data Type. +// +// [Tag]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag 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]Data Type. + // + // [Tag]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag // // 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]Data Type. + // + // [Tag]: https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Tag // // This member is required. Value *string @@ -266,28 +308,38 @@ type Version struct { // applications. Some applications might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity and // Access Management (IAM) users. For those applications, you must explicitly - // 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 - // application that requires capabilities, the call will fail. + // 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], [AWS::IAM::InstanceProfile], [AWS::IAM::Policy], and [AWS::IAM::Role]. 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], [AWS::IAM:Policy], [AWS::ApplicationAutoScaling::ScalingPolicy] + // , [AWS::S3::BucketPolicy], [AWS::SQS::QueuePolicy], and [AWS::SNS::TopicPolicy]. + // + // 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. + // + // [AWS::SQS::QueuePolicy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html + // [AWS::SNS::TopicPolicy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-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::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 + // [AWS::IAM::Group]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html + // [AWS::IAM::Role]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html + // [AWS::IAM:Policy]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html + // [AWS::Lambda::Permission]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html // // This member is required. RequiredCapabilities []Capability @@ -298,7 +350,11 @@ 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/]: https://semver.org/ // // This member is required. SemanticVersion *string @@ -309,7 +365,9 @@ type Version struct { TemplateUrl *string // A link to the S3 object that contains the ZIP archive of the source code for - // this version of your application.Maximum size 50 MB + // this version of your application. + // + // Maximum size 50 MB SourceCodeArchiveUrl *string // A link to a public repository for the source code of your application, for @@ -332,7 +390,11 @@ 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/]: https://semver.org/ // // This member is required. SemanticVersion *string diff --git a/service/servicecatalog/api_op_AcceptPortfolioShare.go b/service/servicecatalog/api_op_AcceptPortfolioShare.go index db2e1c94bd3..816d037c71f 100644 --- a/service/servicecatalog/api_op_AcceptPortfolioShare.go +++ b/service/servicecatalog/api_op_AcceptPortfolioShare.go @@ -35,16 +35,22 @@ type AcceptPortfolioShareInput struct { PortfolioId *string // The language code. + // // - 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 // "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS PortfolioShareType types.PortfolioShareType diff --git a/service/servicecatalog/api_op_AssociateBudgetWithResource.go b/service/servicecatalog/api_op_AssociateBudgetWithResource.go index 540894ee010..e6a161ba4e0 100644 --- a/service/servicecatalog/api_op_AssociateBudgetWithResource.go +++ b/service/servicecatalog/api_op_AssociateBudgetWithResource.go @@ -33,7 +33,7 @@ type AssociateBudgetWithResourceInput struct { // This member is required. BudgetName *string - // The resource identifier. Either a portfolio-id or a product-id. + // The resource identifier. Either a portfolio-id or a product-id. // // This member is required. ResourceId *string diff --git a/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go b/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go index 87c71bf24c1..78e594df7da 100644 --- a/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go +++ b/service/servicecatalog/api_op_AssociatePrincipalWithPortfolio.go @@ -11,21 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// 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 PrincipalARN must already exist in the recipient account before it can be -// associated. +// 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 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 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 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) { if params == nil { params = &AssociatePrincipalWithPortfolioInput{} @@ -49,38 +54,54 @@ type AssociatePrincipalWithPortfolioInput struct { PortfolioId *string // The ARN of the principal (user, role, or group). If the PrincipalType is IAM , - // the supported value is a fully defined IAM Amazon Resource Name (ARN) (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) - // . If the PrincipalType is IAM_PATTERN , the supported value is an IAM ARN - // without an AccountID in the following format: - // arn:partition:iam:::resource-type/resource-id The ARN resource-id can be either: + // the supported value is a fully defined [IAM Amazon Resource Name (ARN)]. If the PrincipalType is IAM_PATTERN , + // the supported value is an IAM ARN without an AccountID in the following format: + // + // arn:partition:iam:::resource-type/resource-id + // + // The ARN resource-id can be either: // // - A fully formed resource-id. For example, arn:aws:iam:::role/resource-name // or arn:aws:iam:::role/resource-path/resource-name + // // - A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "*" or // "?" in the resource-id segment of the ARN. For example // arn:partition:service:::resource-type/resource-path/resource-name. The new // symbols are exclusive to the resource-path and resource-name and cannot replace - // the resource-type or other ARN values. The ARN path and principal name allow - // unlimited wildcard characters. + // the resource-type or other ARN values. + // + // The ARN path and principal name allow unlimited wildcard characters. + // // Examples of an acceptable wildcard ARN: + // // - arn:aws:iam:::role/ResourceName_* + // // - arn:aws:iam:::role/*/ResourceName_? + // // Examples of an unacceptable wildcard ARN: + // // - arn:aws:iam:::*/ResourceName + // // You can associate multiple IAM_PATTERN s even if the account has no principal - // with that name. The "?" wildcard character matches zero or one of any character. - // This is similar to ".?" in regular regex context. The "*" wildcard character - // matches any number of any characters. This is similar to ".*" in regular regex - // context. In the IAM Principal ARN format + // with that name. + // + // The "?" wildcard character matches zero or one of any character. This is + // similar to ".?" in regular regex context. The "*" wildcard character matches any + // number of any characters. This is similar to ".*" in regular regex context. + // + // In the IAM Principal ARN format // (arn:partition:iam:::resource-type/resource-path/resource-name), valid // resource-type values include user/, group/, or role/. The "?" and "*" characters // are allowed only after the resource-type in the resource-id segment. You can use - // special characters anywhere within the resource-id. The "*" character also - // matches the "/" character, allowing paths to be formed within the resource-id. - // For example, arn:aws:iam:::role/*/ResourceName_? matches both - // arn:aws:iam:::role/pathA/pathB/ResourceName_1 and + // special characters anywhere within the resource-id. + // + // The "*" character also matches the "/" character, allowing paths to be formed + // within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches + // both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and // arn:aws:iam:::role/pathA/ResourceName_1. // + // [IAM Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns + // // This member is required. PrincipalARN *string @@ -92,7 +113,9 @@ type AssociatePrincipalWithPortfolioInput struct { PrincipalType types.PrincipalType // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_AssociateProductWithPortfolio.go b/service/servicecatalog/api_op_AssociateProductWithPortfolio.go index c006eb3b546..3ada9508796 100644 --- a/service/servicecatalog/api_op_AssociateProductWithPortfolio.go +++ b/service/servicecatalog/api_op_AssociateProductWithPortfolio.go @@ -10,8 +10,9 @@ 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,7 +41,9 @@ type AssociateProductWithPortfolioInput struct { ProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go b/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go index 940278521e0..d6c2921bb2d 100644 --- a/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go +++ b/service/servicecatalog/api_op_AssociateServiceActionWithProvisioningArtifact.go @@ -44,7 +44,9 @@ type AssociateServiceActionWithProvisioningArtifactInput struct { ServiceActionId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go b/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go index 378325568be..85ac51a2e06 100644 --- a/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go +++ b/service/servicecatalog/api_op_BatchAssociateServiceActionWithProvisioningArtifact.go @@ -36,7 +36,9 @@ type BatchAssociateServiceActionWithProvisioningArtifactInput struct { ServiceActionAssociations []types.ServiceActionAssociation // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go b/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go index ec14fb27911..8694766d9f4 100644 --- a/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go +++ b/service/servicecatalog/api_op_BatchDisassociateServiceActionFromProvisioningArtifact.go @@ -37,7 +37,9 @@ type BatchDisassociateServiceActionFromProvisioningArtifactInput struct { ServiceActionAssociations []types.ServiceActionAssociation // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_CopyProduct.go b/service/servicecatalog/api_op_CopyProduct.go index 6ce0bb8f1d2..670ffa78dd7 100644 --- a/service/servicecatalog/api_op_CopyProduct.go +++ b/service/servicecatalog/api_op_CopyProduct.go @@ -12,11 +12,14 @@ import ( ) // Copies the specified source product to the specified target product or a new -// 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 . +// 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. func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optFns ...func(*Options)) (*CopyProductOutput, error) { if params == nil { params = &CopyProductInput{} @@ -34,7 +37,7 @@ func (c *Client) CopyProduct(ctx context.Context, params *CopyProductInput, optF type CopyProductInput struct { - // A unique identifier that you provide to ensure idempotency. If multiple + // 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. // @@ -47,7 +50,9 @@ type CopyProductInput struct { SourceProductArn *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_CreateConstraint.go b/service/servicecatalog/api_op_CreateConstraint.go index 43ab8442369..cc644792474 100644 --- a/service/servicecatalog/api_op_CreateConstraint.go +++ b/service/servicecatalog/api_op_CreateConstraint.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a constraint. A delegated admin is authorized to invoke this command. +// Creates a constraint. +// +// A delegated admin is authorized to invoke this command. func (c *Client) CreateConstraint(ctx context.Context, params *CreateConstraintInput, optFns ...func(*Options)) (*CreateConstraintOutput, error) { if params == nil { params = &CreateConstraintInput{} @@ -37,30 +39,58 @@ type CreateConstraintInput struct { IdempotencyToken *string // The constraint parameters, in JSON format. The syntax depends on the constraint - // 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 + // 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"]} + // 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": - // "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) - // . + // + // {"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": "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]. + // + // [Template Constraint Rules]: http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html // // This member is required. Parameters *string @@ -76,17 +106,24 @@ type CreateConstraintInput struct { ProductId *string // The type of constraint. + // // - LAUNCH + // // - NOTIFICATION + // // - RESOURCE_UPDATE + // // - STACKSET + // // - TEMPLATE // // This member is required. Type *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_CreatePortfolio.go b/service/servicecatalog/api_op_CreatePortfolio.go index c060a4101fe..6a08771a877 100644 --- a/service/servicecatalog/api_op_CreatePortfolio.go +++ b/service/servicecatalog/api_op_CreatePortfolio.go @@ -11,7 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a portfolio. A delegated admin is authorized to invoke this command. +// Creates a portfolio. +// +// A delegated admin is authorized to invoke this command. func (c *Client) CreatePortfolio(ctx context.Context, params *CreatePortfolioInput, optFns ...func(*Options)) (*CreatePortfolioOutput, error) { if params == nil { params = &CreatePortfolioInput{} @@ -47,7 +49,9 @@ type CreatePortfolioInput struct { ProviderName *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_CreatePortfolioShare.go b/service/servicecatalog/api_op_CreatePortfolioShare.go index 27f5cc84860..a04baaa97be 100644 --- a/service/servicecatalog/api_op_CreatePortfolioShare.go +++ b/service/servicecatalog/api_op_CreatePortfolioShare.go @@ -14,24 +14,31 @@ import ( // Shares the specified portfolio with the specified account or organization node. // Shares to an organization node can only be created by the management account of // an organization or by a delegated administrator. You can share portfolios to an -// organization, an organizational unit, or a specific account. Note that if a -// delegated admin is de-registered, they can no longer create portfolio shares. +// organization, an organizational unit, or a specific account. +// +// Note that if a delegated admin is de-registered, they can no longer create +// portfolio shares. +// // AWSOrganizationsAccess must be enabled in order to create a portfolio share to -// an organization node. You can't share a shared resource, including portfolios -// that contain a shared product. If the portfolio share with the specified account -// or organization node already exists, this action will have no effect and will -// not return an error. To update an existing share, you must use the -// UpdatePortfolioShare API instead. 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 -// PrincipalARN must already exist in the recipient account before it can be -// associated. +// an organization node. +// +// You can't share a shared resource, including portfolios that contain a shared +// product. +// +// If the portfolio share with the specified account or organization node already +// exists, this action will have no effect and will not return an error. To update +// an existing share, you must use the UpdatePortfolioShare API instead. +// +// 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 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) { if params == nil { params = &CreatePortfolioShareInput{} @@ -55,7 +62,9 @@ type CreatePortfolioShareInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -70,14 +79,17 @@ type CreatePortfolioShareInput struct { OrganizationNode *types.OrganizationNode // This parameter is only supported for portfolios with an OrganizationalNode Type - // of ORGANIZATION or ORGANIZATIONAL_UNIT . Enables or disables Principal sharing - // when creating the portfolio share. If you do not provide this flag, 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. + // of ORGANIZATION or ORGANIZATIONAL_UNIT . + // + // Enables or disables Principal sharing when creating the portfolio share. If you + // do not provide this flag, 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 17382845e4e..a97bfb1b72a 100644 --- a/service/servicecatalog/api_op_CreateProduct.go +++ b/service/servicecatalog/api_op_CreateProduct.go @@ -11,8 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a product. A delegated admin is authorized to invoke this command. The -// user or role that performs this operation must have the +// Creates a product. +// +// A delegated admin is authorized to invoke this command. +// +// The user or role that performs this operation must have the // cloudformation:GetTemplate IAM policy permission. This policy permission is // required when using the ImportFromPhysicalId template source in the information // data section. @@ -56,7 +59,9 @@ type CreateProductInput struct { ProductType types.ProductType // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -73,7 +78,9 @@ 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 SourceConnection *types.SourceConnection @@ -83,8 +90,9 @@ type CreateProductInput struct { // The contact email for product support. SupportEmail *string - // The contact URL for product support. ^https?:\/\// / is the pattern used to - // validate SupportUrl. + // The contact URL for product support. + // + // ^https?:\/\// / is the pattern used to validate SupportUrl. SupportUrl *string // One or more tags. diff --git a/service/servicecatalog/api_op_CreateProvisionedProductPlan.go b/service/servicecatalog/api_op_CreateProvisionedProductPlan.go index 5139e1c91a4..6481dda23cb 100644 --- a/service/servicecatalog/api_op_CreateProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_CreateProvisionedProductPlan.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a plan. A plan includes the list of resources to be created (when -// provisioning a new product) or modified (when updating a provisioned product) -// 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 . +// Creates a plan. +// +// A plan includes the list of resources to be created (when provisioning a new +// product) or modified (when updating a provisioned product) 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. func (c *Client) CreateProvisionedProductPlan(ctx context.Context, params *CreateProvisionedProductPlanInput, optFns ...func(*Options)) (*CreateProvisionedProductPlanOutput, error) { if params == nil { params = &CreateProvisionedProductPlanInput{} @@ -70,7 +74,9 @@ type CreateProvisionedProductPlanInput struct { ProvisioningArtifactId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -80,16 +86,18 @@ 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. ProvisioningParameters []types.UpdateProvisioningParameter - // One or more tags. If the plan is for an existing provisioned product, the - // product must have a RESOURCE_UPDATE constraint with - // TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. + // One or more tags. + // + // If the plan is for an existing provisioned product, the product must have a + // RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED + // to allow tag updates. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_CreateProvisioningArtifact.go b/service/servicecatalog/api_op_CreateProvisioningArtifact.go index ecd4a009237..f6d9dae50bd 100644 --- a/service/servicecatalog/api_op_CreateProvisioningArtifact.go +++ b/service/servicecatalog/api_op_CreateProvisioningArtifact.go @@ -12,8 +12,12 @@ import ( ) // Creates a provisioning artifact (also known as a version) for the specified -// product. You cannot create a provisioning artifact for a product that was shared -// with you. The user or role that performs this operation must have the +// product. +// +// You cannot create a provisioning artifact for a product that was shared with +// you. +// +// The user or role that performs this operation must have the // cloudformation:GetTemplate IAM policy permission. This policy permission is // required when using the ImportFromPhysicalId template source in the information // data section. @@ -52,7 +56,9 @@ type CreateProvisioningArtifactInput struct { ProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -62,11 +68,20 @@ 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. - // 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. + // 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. Info map[string]string // Information about the provisioning artifact. diff --git a/service/servicecatalog/api_op_CreateServiceAction.go b/service/servicecatalog/api_op_CreateServiceAction.go index d38b9ee1b0e..9534b6f07e3 100644 --- a/service/servicecatalog/api_op_CreateServiceAction.go +++ b/service/servicecatalog/api_op_CreateServiceAction.go @@ -29,17 +29,27 @@ func (c *Client) CreateServiceAction(ctx context.Context, params *CreateServiceA 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: - // [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or + // 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: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or // [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}] . // // This member is required. @@ -63,7 +73,9 @@ type CreateServiceActionInput struct { Name *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeleteConstraint.go b/service/servicecatalog/api_op_DeleteConstraint.go index 1add0e2d37c..a434f0749d3 100644 --- a/service/servicecatalog/api_op_DeleteConstraint.go +++ b/service/servicecatalog/api_op_DeleteConstraint.go @@ -10,8 +10,9 @@ 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,7 +36,9 @@ type DeleteConstraintInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeletePortfolio.go b/service/servicecatalog/api_op_DeletePortfolio.go index 082c5814d46..d450dfdb6b4 100644 --- a/service/servicecatalog/api_op_DeletePortfolio.go +++ b/service/servicecatalog/api_op_DeletePortfolio.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified portfolio. You cannot delete a portfolio if it was shared -// with you or if it has associated products, users, constraints, or shared -// accounts. A delegated admin is authorized to invoke this command. +// Deletes the specified portfolio. +// +// You cannot delete a portfolio if it was shared with you or if it has associated +// products, users, constraints, or shared accounts. +// +// A delegated admin is authorized to invoke this command. func (c *Client) DeletePortfolio(ctx context.Context, params *DeletePortfolioInput, optFns ...func(*Options)) (*DeletePortfolioOutput, error) { if params == nil { params = &DeletePortfolioInput{} @@ -36,7 +39,9 @@ type DeletePortfolioInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeletePortfolioShare.go b/service/servicecatalog/api_op_DeletePortfolioShare.go index 5ba469dbe40..e5a1d9f33b7 100644 --- a/service/servicecatalog/api_op_DeletePortfolioShare.go +++ b/service/servicecatalog/api_op_DeletePortfolioShare.go @@ -13,9 +13,10 @@ import ( // 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. +// 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,7 +40,9 @@ type DeletePortfolioShareInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeleteProduct.go b/service/servicecatalog/api_op_DeleteProduct.go index c96d110ffcc..cdee90d86b2 100644 --- a/service/servicecatalog/api_op_DeleteProduct.go +++ b/service/servicecatalog/api_op_DeleteProduct.go @@ -10,9 +10,12 @@ 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,7 +39,9 @@ type DeleteProductInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go b/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go index 830d344f27a..be0129f32b9 100644 --- a/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_DeleteProvisionedProductPlan.go @@ -34,7 +34,9 @@ type DeleteProvisionedProductPlanInput struct { PlanId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeleteProvisioningArtifact.go b/service/servicecatalog/api_op_DeleteProvisioningArtifact.go index eeec5af72a5..3386f9a742a 100644 --- a/service/servicecatalog/api_op_DeleteProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DeleteProvisioningArtifact.go @@ -11,10 +11,11 @@ import ( ) // Deletes the specified provisioning artifact (also known as a version) for the -// specified product. You cannot delete a provisioning artifact associated with a -// product that was shared with you. You cannot delete the last provisioning -// artifact for a product, because a product must have at least one provisioning -// artifact. +// specified product. +// +// You cannot delete a provisioning artifact associated with a product that was +// shared with you. You cannot delete the last provisioning artifact for a product, +// because a product must have at least one provisioning artifact. func (c *Client) DeleteProvisioningArtifact(ctx context.Context, params *DeleteProvisioningArtifactInput, optFns ...func(*Options)) (*DeleteProvisioningArtifactOutput, error) { if params == nil { params = &DeleteProvisioningArtifactInput{} @@ -43,7 +44,9 @@ type DeleteProvisioningArtifactInput struct { ProvisioningArtifactId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeleteServiceAction.go b/service/servicecatalog/api_op_DeleteServiceAction.go index 9aafa18ffde..5d911f92b23 100644 --- a/service/servicecatalog/api_op_DeleteServiceAction.go +++ b/service/servicecatalog/api_op_DeleteServiceAction.go @@ -34,7 +34,9 @@ type DeleteServiceActionInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DeleteTagOption.go b/service/servicecatalog/api_op_DeleteTagOption.go index 241f395990e..aafb3022f09 100644 --- a/service/servicecatalog/api_op_DeleteTagOption.go +++ b/service/servicecatalog/api_op_DeleteTagOption.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified TagOption. You cannot delete a TagOption if it is -// associated with a product or portfolio. +// Deletes the specified TagOption. +// +// You cannot delete a TagOption if it is associated with a product or portfolio. func (c *Client) DeleteTagOption(ctx context.Context, params *DeleteTagOptionInput, optFns ...func(*Options)) (*DeleteTagOptionOutput, error) { if params == nil { params = &DeleteTagOptionInput{} diff --git a/service/servicecatalog/api_op_DescribeConstraint.go b/service/servicecatalog/api_op_DescribeConstraint.go index 5c81f386d4d..ddd8887dbd0 100644 --- a/service/servicecatalog/api_op_DescribeConstraint.go +++ b/service/servicecatalog/api_op_DescribeConstraint.go @@ -35,7 +35,9 @@ type DescribeConstraintInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeCopyProductStatus.go b/service/servicecatalog/api_op_DescribeCopyProductStatus.go index 9d9af508402..dbaac5f5c6f 100644 --- a/service/servicecatalog/api_op_DescribeCopyProductStatus.go +++ b/service/servicecatalog/api_op_DescribeCopyProductStatus.go @@ -29,13 +29,15 @@ 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 AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribePortfolio.go b/service/servicecatalog/api_op_DescribePortfolio.go index 98969ce7656..7e4a0b419d2 100644 --- a/service/servicecatalog/api_op_DescribePortfolio.go +++ b/service/servicecatalog/api_op_DescribePortfolio.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the specified portfolio. A delegated admin is authorized -// to invoke this command. +// Gets information about the specified portfolio. +// +// A delegated admin is authorized to invoke this command. func (c *Client) DescribePortfolio(ctx context.Context, params *DescribePortfolioInput, optFns ...func(*Options)) (*DescribePortfolioOutput, error) { if params == nil { params = &DescribePortfolioInput{} @@ -36,7 +37,9 @@ type DescribePortfolioInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribePortfolioShares.go b/service/servicecatalog/api_op_DescribePortfolioShares.go index 7001a94a476..bb14b127158 100644 --- a/service/servicecatalog/api_op_DescribePortfolioShares.go +++ b/service/servicecatalog/api_op_DescribePortfolioShares.go @@ -12,10 +12,13 @@ import ( ) // Returns a summary of each of the portfolio shares that were created for the -// specified portfolio. You can use this API to determine which accounts or -// organizational nodes this portfolio have been shared, whether the recipient -// entity has imported the share, and whether TagOptions are included with the -// share. The PortfolioId and Type parameters are both required. +// specified portfolio. +// +// You can use this API to determine which accounts or organizational nodes this +// portfolio have been shared, whether the recipient entity has imported the share, +// and whether TagOptions are included with the share. +// +// The PortfolioId and Type parameters are both required. func (c *Client) DescribePortfolioShares(ctx context.Context, params *DescribePortfolioSharesInput, optFns ...func(*Options)) (*DescribePortfolioSharesOutput, error) { if params == nil { params = &DescribePortfolioSharesInput{} @@ -39,11 +42,16 @@ type DescribePortfolioSharesInput struct { PortfolioId *string // The type of portfolio share to summarize. This field acts as a filter on the - // type of portfolio share, which can be one of the following: 1. ACCOUNT - - // Represents an external account to account share. 2. ORGANIZATION - Represents a - // share to an organization. This share is available to every account in the - // organization. 3. ORGANIZATIONAL_UNIT - Represents a share to an organizational - // unit. 4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the + // type of portfolio share, which can be one of the following: + // + // 1. ACCOUNT - Represents an external account to account share. + // + // 2. ORGANIZATION - Represents a share to an organization. This share is + // available to every account in the organization. + // + // 3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit. + // + // 4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the // organization. // // This member is required. diff --git a/service/servicecatalog/api_op_DescribeProduct.go b/service/servicecatalog/api_op_DescribeProduct.go index cbfb330b826..753fca76e9c 100644 --- a/service/servicecatalog/api_op_DescribeProduct.go +++ b/service/servicecatalog/api_op_DescribeProduct.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets information about the specified product. Running this operation with -// administrator access results in a failure. DescribeProductAsAdmin should be -// used instead. +// Gets information about the specified product. +// +// Running this operation with 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,7 +33,9 @@ func (c *Client) DescribeProduct(ctx context.Context, params *DescribeProductInp type DescribeProductInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeProductAsAdmin.go b/service/servicecatalog/api_op_DescribeProductAsAdmin.go index 86370e88068..7a07823ef55 100644 --- a/service/servicecatalog/api_op_DescribeProductAsAdmin.go +++ b/service/servicecatalog/api_op_DescribeProductAsAdmin.go @@ -31,7 +31,9 @@ func (c *Client) DescribeProductAsAdmin(ctx context.Context, params *DescribePro type DescribeProductAsAdminInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -42,11 +44,12 @@ type DescribeProductAsAdminInput struct { Name *string // The unique identifier of the shared portfolio that the specified product is - // associated with. You can provide this parameter to retrieve the shared - // TagOptions associated with the product. If this parameter is provided and if - // TagOptions sharing is enabled in the portfolio share, the API returns both local - // and shared TagOptions associated with the product. Otherwise only local - // TagOptions will be returned. + // associated with. + // + // You can provide this parameter to retrieve the shared TagOptions associated + // with the product. If this parameter is provided and if TagOptions sharing is + // enabled in the portfolio share, the API returns both local and shared TagOptions + // associated with the product. Otherwise only local TagOptions will be returned. SourcePortfolioId *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_DescribeProductView.go b/service/servicecatalog/api_op_DescribeProductView.go index 5ef6f74d51d..533c201bcb1 100644 --- a/service/servicecatalog/api_op_DescribeProductView.go +++ b/service/servicecatalog/api_op_DescribeProductView.go @@ -35,7 +35,9 @@ type DescribeProductViewInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeProvisionedProduct.go b/service/servicecatalog/api_op_DescribeProvisionedProduct.go index e52740f4ede..f3777de5a42 100644 --- a/service/servicecatalog/api_op_DescribeProvisionedProduct.go +++ b/service/servicecatalog/api_op_DescribeProvisionedProduct.go @@ -27,24 +27,34 @@ func (c *Client) DescribeProvisionedProduct(ctx context.Context, params *Describ return out, nil } -// DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The -// language code for localization. Id - [Optional] The provisioned product -// identifier. Name - [Optional] Another provisioned product identifier. Customers -// must provide either Id or Name. +// DescribeProvisionedProductAPI input structure. +// +// AcceptLanguage - [Optional] The language code for localization. +// +// Id - [Optional] The provisioned product identifier. +// +// Name - [Optional] Another provisioned product identifier. Customers must +// provide either Id or Name. type DescribeProvisionedProductInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string // The provisioned product identifier. You must provide the name or ID, but not - // both. If you do not provide a name or ID, or you provide both name and ID, an + // both. + // + // If you do not provide a name or ID, or you provide both name and ID, an // InvalidParametersException will occur. Id *string // The name of the provisioned product. You must provide the name or ID, but not - // both. If you do not provide a name or ID, or you provide both name and ID, an + // both. + // + // If you do not provide a name or ID, or you provide both name and ID, an // InvalidParametersException will occur. Name *string diff --git a/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go b/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go index a417d0c98b9..94849183962 100644 --- a/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_DescribeProvisionedProductPlan.go @@ -35,7 +35,9 @@ type DescribeProvisionedProductPlanInput struct { PlanId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeProvisioningArtifact.go b/service/servicecatalog/api_op_DescribeProvisioningArtifact.go index f03848b3fa7..12bd21b366b 100644 --- a/service/servicecatalog/api_op_DescribeProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DescribeProvisioningArtifact.go @@ -31,7 +31,9 @@ func (c *Client) DescribeProvisioningArtifact(ctx context.Context, params *Descr type DescribeProvisioningArtifactInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeProvisioningParameters.go b/service/servicecatalog/api_op_DescribeProvisioningParameters.go index 9371bc6c717..a1ec1524957 100644 --- a/service/servicecatalog/api_op_DescribeProvisioningParameters.go +++ b/service/servicecatalog/api_op_DescribeProvisioningParameters.go @@ -12,13 +12,14 @@ import ( ) // Gets information about the configuration required to provision the specified -// 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 -// 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 . +// 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 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 . func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *DescribeProvisioningParametersInput, optFns ...func(*Options)) (*DescribeProvisioningParametersOutput, error) { if params == nil { params = &DescribeProvisioningParametersInput{} @@ -37,14 +38,15 @@ func (c *Client) DescribeProvisioningParameters(ctx context.Context, params *Des type DescribeProvisioningParametersInput struct { // The language code. + // // - 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 - // not both. + // paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both. PathId *string // The name of the path. You must provide the name or ID, but not both. diff --git a/service/servicecatalog/api_op_DescribeRecord.go b/service/servicecatalog/api_op_DescribeRecord.go index e7d37b5f125..24a2c25ccaa 100644 --- a/service/servicecatalog/api_op_DescribeRecord.go +++ b/service/servicecatalog/api_op_DescribeRecord.go @@ -11,14 +11,14 @@ 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 -// 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. +// 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 ListRecordHistoryto see +// the product's history from when he was the owner. func (c *Client) DescribeRecord(ctx context.Context, params *DescribeRecordInput, optFns ...func(*Options)) (*DescribeRecordOutput, error) { if params == nil { params = &DescribeRecordInput{} @@ -43,7 +43,9 @@ type DescribeRecordInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeServiceAction.go b/service/servicecatalog/api_op_DescribeServiceAction.go index 1a7854d8441..c2d73c76b90 100644 --- a/service/servicecatalog/api_op_DescribeServiceAction.go +++ b/service/servicecatalog/api_op_DescribeServiceAction.go @@ -35,7 +35,9 @@ type DescribeServiceActionInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go b/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go index bba930fc272..58029dc1f83 100644 --- a/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go +++ b/service/servicecatalog/api_op_DescribeServiceActionExecutionParameters.go @@ -41,7 +41,9 @@ type DescribeServiceActionExecutionParametersInput struct { ServiceActionId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go b/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go index e6c97a33493..1f009e41b7a 100644 --- a/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go +++ b/service/servicecatalog/api_op_DisableAWSOrganizationsAccess.go @@ -14,15 +14,20 @@ import ( // not delete your current shares, but prevents you from creating new shares // throughout your organization. Current shares are not kept in sync with your // organization structure if the structure changes after calling this API. Only the -// 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 -// 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 -// from the organization after disabling Service Catalog access will retain access -// to the previously shared portfolio. +// 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 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 from the +// organization after disabling Service Catalog access will retain access to the +// previously shared portfolio. func (c *Client) DisableAWSOrganizationsAccess(ctx context.Context, params *DisableAWSOrganizationsAccessInput, optFns ...func(*Options)) (*DisableAWSOrganizationsAccessOutput, error) { if params == nil { params = &DisableAWSOrganizationsAccessInput{} diff --git a/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go b/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go index 4deaf1bdce4..2afb8efac24 100644 --- a/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go +++ b/service/servicecatalog/api_op_DisassociatePrincipalFromPortfolio.go @@ -12,22 +12,28 @@ 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. For more -// information, review associate-principal-with-portfolio (https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options) -// in the Amazon Web Services CLI Command Reference. If you disassociate a -// principal from a portfolio, with PrincipalType as IAM , the same principal will -// still have access to the portfolio if it matches one of the associated -// principals of type IAM_PATTERN . To fully remove access for a principal, verify -// all the associated Principals of type IAM_PATTERN , and then ensure you -// disassociate any IAM_PATTERN principals that match the principal whose access -// you are removing. +// 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. +// +// For more information, review [associate-principal-with-portfolio] in the Amazon Web Services CLI Command Reference. +// +// If you disassociate a principal from a portfolio, with PrincipalType as IAM , +// the same principal will still have access to the portfolio if it matches one of +// the associated principals of type IAM_PATTERN . To fully remove access for a +// principal, verify all the associated Principals of type IAM_PATTERN , and then +// ensure you disassociate any IAM_PATTERN principals that match the principal +// whose access you are removing. +// +// [associate-principal-with-portfolio]: https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options func (c *Client) DisassociatePrincipalFromPortfolio(ctx context.Context, params *DisassociatePrincipalFromPortfolioInput, optFns ...func(*Options)) (*DisassociatePrincipalFromPortfolioOutput, error) { if params == nil { params = &DisassociatePrincipalFromPortfolioInput{} @@ -58,7 +64,9 @@ type DisassociatePrincipalFromPortfolioInput struct { PrincipalARN *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go b/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go index c73acd2bb13..93f2424be38 100644 --- a/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go +++ b/service/servicecatalog/api_op_DisassociateProductFromPortfolio.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates the specified product from the specified portfolio. A delegated -// admin is authorized to invoke this command. +// Disassociates the specified product from the specified portfolio. +// +// A delegated admin is authorized to invoke this command. func (c *Client) DisassociateProductFromPortfolio(ctx context.Context, params *DisassociateProductFromPortfolioInput, optFns ...func(*Options)) (*DisassociateProductFromPortfolioOutput, error) { if params == nil { params = &DisassociateProductFromPortfolioInput{} @@ -40,7 +41,9 @@ type DisassociateProductFromPortfolioInput struct { ProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go b/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go index a877d249cf2..faa53db6ab4 100644 --- a/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go +++ b/service/servicecatalog/api_op_DisassociateServiceActionFromProvisioningArtifact.go @@ -45,7 +45,9 @@ type DisassociateServiceActionFromProvisioningArtifactInput struct { ServiceActionId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go b/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go index 6b8ad7a4bec..fa077581e16 100644 --- a/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go +++ b/service/servicecatalog/api_op_EnableAWSOrganizationsAccess.go @@ -13,18 +13,24 @@ import ( // Enable portfolio sharing feature through Organizations. This API will allow // Service Catalog to receive updates on your organization in order to sync your // shares with the current structure. This API can only be called by the management -// account in the organization. When you call this API, Service Catalog calls +// 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 -// 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 -// removed from the organization after disabling Service Catalog access, and before -// you enabled access again, can retain access to the previously shared portfolio. -// As a result, an account that has been removed from the organization might still -// be able to create or manage Amazon Web Services resources when it is no longer -// authorized to do so. Amazon Web Services is working to resolve this issue. +// sync with any changes in your Organizations structure. +// +// Note that a delegated 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 removed from the organization after disabling Service Catalog access, and +// before you enabled access again, can retain access to the previously shared +// portfolio. As a result, an account that has been removed from the organization +// might still be able to create or manage Amazon Web Services resources when it is +// no longer authorized to do so. Amazon Web Services is working to resolve this +// issue. func (c *Client) EnableAWSOrganizationsAccess(ctx context.Context, params *EnableAWSOrganizationsAccessInput, optFns ...func(*Options)) (*EnableAWSOrganizationsAccessOutput, error) { if params == nil { params = &EnableAWSOrganizationsAccessInput{} diff --git a/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go b/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go index 9b27486df40..815cd1ad2c9 100644 --- a/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go +++ b/service/servicecatalog/api_op_ExecuteProvisionedProductPlan.go @@ -43,7 +43,9 @@ type ExecuteProvisionedProductPlanInput struct { PlanId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go b/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go index 31b443c0437..f48d8a84e19 100644 --- a/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go +++ b/service/servicecatalog/api_op_ExecuteProvisionedProductServiceAction.go @@ -45,7 +45,9 @@ type ExecuteProvisionedProductServiceActionInput struct { ServiceActionId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_GetProvisionedProductOutputs.go b/service/servicecatalog/api_op_GetProvisionedProductOutputs.go index fd67d77ddbd..dd5c56d2378 100644 --- a/service/servicecatalog/api_op_GetProvisionedProductOutputs.go +++ b/service/servicecatalog/api_op_GetProvisionedProductOutputs.go @@ -32,7 +32,9 @@ func (c *Client) GetProvisionedProductOutputs(ctx context.Context, params *GetPr type GetProvisionedProductOutputsInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ImportAsProvisionedProduct.go b/service/servicecatalog/api_op_ImportAsProvisionedProduct.go index e3f96befa07..fb9b8799f1b 100644 --- a/service/servicecatalog/api_op_ImportAsProvisionedProduct.go +++ b/service/servicecatalog/api_op_ImportAsProvisionedProduct.go @@ -11,23 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests the import of a resource as an Service Catalog provisioned product +// 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 -// CloudFormation stack template matches the associated Service Catalog product -// provisioning artifact. When you import an existing CloudFormation stack into a -// portfolio, Service Catalog does not apply the product's associated constraints -// during the import process. Service Catalog applies the constraints after you -// call UpdateProvisionedProduct for the provisioned product. The user or role -// that performs this operation must have the cloudformation:GetTemplate and -// cloudformation:DescribeStacks IAM policy permissions. You can only import one -// provisioned product at a time. The product's CloudFormation stack must have the -// IMPORT_COMPLETE status before you import another. +// 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 CloudFormation stack template matches +// the associated Service Catalog product provisioning artifact. +// +// When you import an existing CloudFormation stack into a portfolio, Service +// Catalog does not apply the product's associated constraints during the import +// process. Service Catalog applies the constraints after you call +// UpdateProvisionedProduct for the provisioned product. +// +// The user or role that performs this operation must have the +// cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy +// permissions. +// +// You can only import one provisioned product at a time. The product's +// CloudFormation stack must have the IMPORT_COMPLETE status before you import +// another. func (c *Client) ImportAsProvisionedProduct(ctx context.Context, params *ImportAsProvisionedProductInput, optFns ...func(*Options)) (*ImportAsProvisionedProductOutput, error) { if params == nil { params = &ImportAsProvisionedProductInput{} @@ -76,7 +87,9 @@ type ImportAsProvisionedProductInput struct { ProvisioningArtifactId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go b/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go index 651f956852c..11c4c078389 100644 --- a/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go +++ b/service/servicecatalog/api_op_ListAcceptedPortfolioShares.go @@ -32,7 +32,9 @@ func (c *Client) ListAcceptedPortfolioShares(ctx context.Context, params *ListAc type ListAcceptedPortfolioSharesInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -45,10 +47,13 @@ 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. PortfolioShareType types.PortfolioShareType diff --git a/service/servicecatalog/api_op_ListBudgetsForResource.go b/service/servicecatalog/api_op_ListBudgetsForResource.go index 7d3c26808ef..a1fc3cd3567 100644 --- a/service/servicecatalog/api_op_ListBudgetsForResource.go +++ b/service/servicecatalog/api_op_ListBudgetsForResource.go @@ -35,7 +35,9 @@ type ListBudgetsForResourceInput struct { ResourceId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListConstraintsForPortfolio.go b/service/servicecatalog/api_op_ListConstraintsForPortfolio.go index d9e24687ce2..47a6da2eded 100644 --- a/service/servicecatalog/api_op_ListConstraintsForPortfolio.go +++ b/service/servicecatalog/api_op_ListConstraintsForPortfolio.go @@ -35,7 +35,9 @@ type ListConstraintsForPortfolioInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListLaunchPaths.go b/service/servicecatalog/api_op_ListLaunchPaths.go index c4c41674c17..68466a6f8f4 100644 --- a/service/servicecatalog/api_op_ListLaunchPaths.go +++ b/service/servicecatalog/api_op_ListLaunchPaths.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the paths to the specified product. A path describes how the user gets +// Lists the paths to the specified product. A path describes how the user gets +// // access to a specified product and is necessary when provisioning a product. A // 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) -// in the Service Catalog User Guide. +// 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]in +// the Service Catalog User Guide. +// +// [Granting users access]: https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html func (c *Client) ListLaunchPaths(ctx context.Context, params *ListLaunchPathsInput, optFns ...func(*Options)) (*ListLaunchPathsOutput, error) { if params == nil { params = &ListLaunchPathsInput{} @@ -41,7 +45,9 @@ type ListLaunchPathsInput struct { ProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go b/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go index be0b7b7eb75..bd404e78986 100644 --- a/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go +++ b/service/servicecatalog/api_op_ListOrganizationPortfolioAccess.go @@ -13,8 +13,10 @@ import ( // Lists the organization nodes that have access to the specified portfolio. This // API can only be called by the management account in the organization or by a -// delegated admin. If a delegated admin is de-registered, they can no longer -// perform this operation. +// delegated admin. +// +// If a delegated admin is de-registered, they can no longer perform this +// operation. func (c *Client) ListOrganizationPortfolioAccess(ctx context.Context, params *ListOrganizationPortfolioAccessInput, optFns ...func(*Options)) (*ListOrganizationPortfolioAccessOutput, error) { if params == nil { params = &ListOrganizationPortfolioAccessInput{} @@ -33,9 +35,12 @@ 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. // // This member is required. @@ -47,7 +52,9 @@ type ListOrganizationPortfolioAccessInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListPortfolioAccess.go b/service/servicecatalog/api_op_ListPortfolioAccess.go index 1d9d8b7f7f9..f509161a94f 100644 --- a/service/servicecatalog/api_op_ListPortfolioAccess.go +++ b/service/servicecatalog/api_op_ListPortfolioAccess.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the account IDs that have access to the specified portfolio. A delegated -// admin can list the accounts that have access to the shared portfolio. Note that -// if a delegated admin is de-registered, they can no longer perform this -// operation. +// Lists the account IDs that have access to the specified portfolio. +// +// A delegated admin can list the accounts that have access to the shared +// portfolio. Note that if a delegated admin is de-registered, they can no longer +// perform this operation. func (c *Client) ListPortfolioAccess(ctx context.Context, params *ListPortfolioAccessInput, optFns ...func(*Options)) (*ListPortfolioAccessOutput, error) { if params == nil { params = &ListPortfolioAccessInput{} @@ -37,7 +38,9 @@ type ListPortfolioAccessInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListPortfolios.go b/service/servicecatalog/api_op_ListPortfolios.go index 3daa7329f2b..d88cf767f2d 100644 --- a/service/servicecatalog/api_op_ListPortfolios.go +++ b/service/servicecatalog/api_op_ListPortfolios.go @@ -30,7 +30,9 @@ func (c *Client) ListPortfolios(ctx context.Context, params *ListPortfoliosInput type ListPortfoliosInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListPortfoliosForProduct.go b/service/servicecatalog/api_op_ListPortfoliosForProduct.go index 4d8e3b9466a..fd07975cbf8 100644 --- a/service/servicecatalog/api_op_ListPortfoliosForProduct.go +++ b/service/servicecatalog/api_op_ListPortfoliosForProduct.go @@ -35,7 +35,9 @@ type ListPortfoliosForProductInput struct { ProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go b/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go index aadcfe81c3b..8d8c6e19316 100644 --- a/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go +++ b/service/servicecatalog/api_op_ListPrincipalsForPortfolio.go @@ -36,7 +36,9 @@ type ListPrincipalsForPortfolioInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListProvisionedProductPlans.go b/service/servicecatalog/api_op_ListProvisionedProductPlans.go index 2c571565e28..680bc16e91d 100644 --- a/service/servicecatalog/api_op_ListProvisionedProductPlans.go +++ b/service/servicecatalog/api_op_ListProvisionedProductPlans.go @@ -31,7 +31,9 @@ func (c *Client) ListProvisionedProductPlans(ctx context.Context, params *ListPr type ListProvisionedProductPlansInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListProvisioningArtifacts.go b/service/servicecatalog/api_op_ListProvisioningArtifacts.go index 97390605896..686c78732f8 100644 --- a/service/servicecatalog/api_op_ListProvisioningArtifacts.go +++ b/service/servicecatalog/api_op_ListProvisioningArtifacts.go @@ -36,7 +36,9 @@ type ListProvisioningArtifactsInput struct { ProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go b/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go index 8c29756e1e1..92c707c06a0 100644 --- a/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go +++ b/service/servicecatalog/api_op_ListProvisioningArtifactsForServiceAction.go @@ -36,7 +36,9 @@ type ListProvisioningArtifactsForServiceActionInput struct { ServiceActionId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListRecordHistory.go b/service/servicecatalog/api_op_ListRecordHistory.go index fce610a5c25..c774c06e07d 100644 --- a/service/servicecatalog/api_op_ListRecordHistory.go +++ b/service/servicecatalog/api_op_ListRecordHistory.go @@ -30,7 +30,9 @@ func (c *Client) ListRecordHistory(ctx context.Context, params *ListRecordHistor type ListRecordHistoryInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListResourcesForTagOption.go b/service/servicecatalog/api_op_ListResourcesForTagOption.go index 313901362ca..ef8c6f3eadb 100644 --- a/service/servicecatalog/api_op_ListResourcesForTagOption.go +++ b/service/servicecatalog/api_op_ListResourcesForTagOption.go @@ -42,7 +42,9 @@ type ListResourcesForTagOptionInput struct { PageToken *string // The resource type. + // // - Portfolio + // // - Product ResourceType *string diff --git a/service/servicecatalog/api_op_ListServiceActions.go b/service/servicecatalog/api_op_ListServiceActions.go index 232eee20c56..6857dd4dcb0 100644 --- a/service/servicecatalog/api_op_ListServiceActions.go +++ b/service/servicecatalog/api_op_ListServiceActions.go @@ -30,7 +30,9 @@ func (c *Client) ListServiceActions(ctx context.Context, params *ListServiceActi type ListServiceActionsInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go b/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go index 8ec633fe036..a1a46bd6489 100644 --- a/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go +++ b/service/servicecatalog/api_op_ListServiceActionsForProvisioningArtifact.go @@ -41,7 +41,9 @@ type ListServiceActionsForProvisioningArtifactInput struct { ProvisioningArtifactId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go b/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go index c17682da65c..25c4049710f 100644 --- a/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go +++ b/service/servicecatalog/api_op_ListStackInstancesForProvisionedProduct.go @@ -38,7 +38,9 @@ type ListStackInstancesForProvisionedProductInput struct { ProvisionedProductId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go b/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go index f78f9deb6d8..0a96f64631a 100644 --- a/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go +++ b/service/servicecatalog/api_op_NotifyProvisionProductEngineWorkflowResult.go @@ -29,34 +29,35 @@ func (c *Client) NotifyProvisionProductEngineWorkflowResult(ctx context.Context, type NotifyProvisionProductEngineWorkflowResultInput struct { - // The idempotency token that identifies the provisioning engine execution. + // The idempotency token that identifies the provisioning engine execution. // // This member is required. IdempotencyToken *string - // The identifier of the record. + // The identifier of the record. // // This member is required. RecordId *string - // The status of the provisioning engine execution. + // The status of the provisioning engine execution. // // This member is required. Status types.EngineWorkflowStatus - // The encrypted contents of the provisioning engine execution payload that + // 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 - // The reason why the provisioning engine execution failed. + // The reason why the provisioning engine execution failed. FailureReason *string - // The output of the provisioning engine execution. + // The output of the provisioning engine execution. Outputs []types.RecordOutput - // The ID for the provisioned product resources that are part of a resource group. + // The ID for the provisioned product resources that are part of a resource + // group. ResourceIdentifier *types.EngineWorkflowResourceIdentifier noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_NotifyTerminateProvisionedProductEngineWorkflowResult.go b/service/servicecatalog/api_op_NotifyTerminateProvisionedProductEngineWorkflowResult.go index fc942a2ccd6..8ac9046c841 100644 --- a/service/servicecatalog/api_op_NotifyTerminateProvisionedProductEngineWorkflowResult.go +++ b/service/servicecatalog/api_op_NotifyTerminateProvisionedProductEngineWorkflowResult.go @@ -29,28 +29,28 @@ func (c *Client) NotifyTerminateProvisionedProductEngineWorkflowResult(ctx conte type NotifyTerminateProvisionedProductEngineWorkflowResultInput struct { - // The idempotency token that identifies the terminate engine execution. + // The idempotency token that identifies the terminate engine execution. // // This member is required. IdempotencyToken *string - // The identifier of the record. + // The identifier of the record. // // This member is required. RecordId *string - // The status of the terminate engine execution. + // The status of the terminate engine execution. // // This member is required. Status types.EngineWorkflowStatus - // The encrypted contents of the terminate engine execution payload that Service + // The encrypted contents of the terminate engine execution payload that Service // Catalog sends after the Terraform product terminate workflow starts. // // This member is required. WorkflowToken *string - // The reason why the terminate engine execution failed. + // The reason why the terminate engine execution failed. FailureReason *string noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_NotifyUpdateProvisionedProductEngineWorkflowResult.go b/service/servicecatalog/api_op_NotifyUpdateProvisionedProductEngineWorkflowResult.go index df1f8f908e2..0591ad62a44 100644 --- a/service/servicecatalog/api_op_NotifyUpdateProvisionedProductEngineWorkflowResult.go +++ b/service/servicecatalog/api_op_NotifyUpdateProvisionedProductEngineWorkflowResult.go @@ -29,31 +29,31 @@ func (c *Client) NotifyUpdateProvisionedProductEngineWorkflowResult(ctx context. type NotifyUpdateProvisionedProductEngineWorkflowResultInput struct { - // The idempotency token that identifies the update engine execution. + // The idempotency token that identifies the update engine execution. // // This member is required. IdempotencyToken *string - // The identifier of the record. + // The identifier of the record. // // This member is required. RecordId *string - // The status of the update engine execution. + // The status of the update engine execution. // // This member is required. Status types.EngineWorkflowStatus - // The encrypted contents of the update engine execution payload that Service + // The encrypted contents of the update engine execution payload that Service // Catalog sends after the Terraform product update workflow starts. // // This member is required. WorkflowToken *string - // The reason why the update engine execution failed. + // The reason why the update engine execution failed. FailureReason *string - // The output of the update engine execution. + // The output of the update engine execution. Outputs []types.RecordOutput noSmithyDocumentSerde diff --git a/service/servicecatalog/api_op_ProvisionProduct.go b/service/servicecatalog/api_op_ProvisionProduct.go index 18a0f1a770b..2839cd5c5e7 100644 --- a/service/servicecatalog/api_op_ProvisionProduct.go +++ b/service/servicecatalog/api_op_ProvisionProduct.go @@ -11,17 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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 -// 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) -// in the Service Catalog User Guide. +// 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]in +// the Service Catalog User Guide. +// +// [Granting users access]: https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html func (c *Client) ProvisionProduct(ctx context.Context, params *ProvisionProductInput, optFns ...func(*Options)) (*ProvisionProductOutput, error) { if params == nil { params = &ProvisionProductInput{} @@ -52,7 +58,9 @@ type ProvisionProductInput struct { ProvisionedProductName *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -62,8 +70,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 - // not both. + // paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both. PathId *string // The name of the path. You must provide the name or ID, but not both. diff --git a/service/servicecatalog/api_op_RejectPortfolioShare.go b/service/servicecatalog/api_op_RejectPortfolioShare.go index 346e8d30693..65a4f5eb65f 100644 --- a/service/servicecatalog/api_op_RejectPortfolioShare.go +++ b/service/servicecatalog/api_op_RejectPortfolioShare.go @@ -35,16 +35,22 @@ type RejectPortfolioShareInput struct { PortfolioId *string // The language code. + // // - 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 // "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 f46d7ac9864..459813a493d 100644 --- a/service/servicecatalog/api_op_ScanProvisionedProducts.go +++ b/service/servicecatalog/api_op_ScanProvisionedProducts.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the provisioned products that are available (not terminated). To use -// additional filtering, see SearchProvisionedProducts . +// Lists the provisioned products that are available (not terminated). +// +// To use additional filtering, see SearchProvisionedProducts. func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvisionedProductsInput, optFns ...func(*Options)) (*ScanProvisionedProductsOutput, error) { if params == nil { params = &ScanProvisionedProductsInput{} @@ -31,7 +32,9 @@ func (c *Client) ScanProvisionedProducts(ctx context.Context, params *ScanProvis type ScanProvisionedProductsInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_SearchProducts.go b/service/servicecatalog/api_op_SearchProducts.go index 01d99c0e18d..31cdae9181a 100644 --- a/service/servicecatalog/api_op_SearchProducts.go +++ b/service/servicecatalog/api_op_SearchProducts.go @@ -30,7 +30,9 @@ func (c *Client) SearchProducts(ctx context.Context, params *SearchProductsInput type SearchProductsInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_SearchProductsAsAdmin.go b/service/servicecatalog/api_op_SearchProductsAsAdmin.go index 98a364411a8..ac3ad6a7f8a 100644 --- a/service/servicecatalog/api_op_SearchProductsAsAdmin.go +++ b/service/servicecatalog/api_op_SearchProductsAsAdmin.go @@ -30,7 +30,9 @@ func (c *Client) SearchProductsAsAdmin(ctx context.Context, params *SearchProduc type SearchProductsAsAdminInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_SearchProvisionedProducts.go b/service/servicecatalog/api_op_SearchProvisionedProducts.go index cfee6606c88..be562b136e4 100644 --- a/service/servicecatalog/api_op_SearchProvisionedProducts.go +++ b/service/servicecatalog/api_op_SearchProvisionedProducts.go @@ -31,19 +31,24 @@ func (c *Client) SearchProvisionedProducts(ctx context.Context, params *SearchPr type SearchProvisionedProductsInput struct { // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string // 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 , provisioningArtifactId , 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 , + // provisioningArtifactId , 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. diff --git a/service/servicecatalog/api_op_TerminateProvisionedProduct.go b/service/servicecatalog/api_op_TerminateProvisionedProduct.go index eb78acad8ec..225fcbed38c 100644 --- a/service/servicecatalog/api_op_TerminateProvisionedProduct.go +++ b/service/servicecatalog/api_op_TerminateProvisionedProduct.go @@ -11,9 +11,12 @@ 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{} @@ -40,7 +43,9 @@ type TerminateProvisionedProductInput struct { TerminateToken *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_UpdateConstraint.go b/service/servicecatalog/api_op_UpdateConstraint.go index 8038aa77f1f..5af6da6e875 100644 --- a/service/servicecatalog/api_op_UpdateConstraint.go +++ b/service/servicecatalog/api_op_UpdateConstraint.go @@ -35,7 +35,9 @@ type UpdateConstraintInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -43,30 +45,58 @@ type UpdateConstraintInput struct { Description *string // The constraint parameters, in JSON format. The syntax depends on the constraint - // 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 + // 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"]} + // 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": - // "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) - // . + // + // {"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": "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]. + // + // [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 b95709b8690..f7b2c42b9ae 100644 --- a/service/servicecatalog/api_op_UpdatePortfolio.go +++ b/service/servicecatalog/api_op_UpdatePortfolio.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the specified portfolio. You cannot update a product that was shared -// with you. +// Updates the specified portfolio. +// +// You cannot update a product that was shared with you. func (c *Client) UpdatePortfolio(ctx context.Context, params *UpdatePortfolioInput, optFns ...func(*Options)) (*UpdatePortfolioOutput, error) { if params == nil { params = &UpdatePortfolioInput{} @@ -36,7 +37,9 @@ type UpdatePortfolioInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_UpdatePortfolioShare.go b/service/servicecatalog/api_op_UpdatePortfolioShare.go index 7e5f22877c4..a3e273e732f 100644 --- a/service/servicecatalog/api_op_UpdatePortfolioShare.go +++ b/service/servicecatalog/api_op_UpdatePortfolioShare.go @@ -13,24 +13,31 @@ import ( // 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 -// PrincipalARN must already exist in the recipient account before it can be -// associated. +// 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 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) { if params == nil { params = &UpdatePortfolioShareInput{} @@ -54,7 +61,9 @@ type UpdatePortfolioShareInput struct { PortfolioId *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_UpdateProduct.go b/service/servicecatalog/api_op_UpdateProduct.go index 6a7ccec08c8..39cbbe37058 100644 --- a/service/servicecatalog/api_op_UpdateProduct.go +++ b/service/servicecatalog/api_op_UpdateProduct.go @@ -35,7 +35,9 @@ type UpdateProductInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string @@ -61,7 +63,9 @@ 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 SourceConnection *types.SourceConnection diff --git a/service/servicecatalog/api_op_UpdateProvisionedProduct.go b/service/servicecatalog/api_op_UpdateProvisionedProduct.go index 039bcd42b34..71887ca0808 100644 --- a/service/servicecatalog/api_op_UpdateProvisionedProduct.go +++ b/service/servicecatalog/api_op_UpdateProvisionedProduct.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Requests updates to the configuration of the specified provisioned product. If -// there are tags associated with the object, they cannot be updated or added. +// Requests updates to the configuration of the specified provisioned product. +// +// If 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{} @@ -39,7 +42,9 @@ type UpdateProvisionedProductInput struct { UpdateToken *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go b/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go index 98e0125794e..d1350d3176f 100644 --- a/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go +++ b/service/servicecatalog/api_op_UpdateProvisionedProductProperties.go @@ -40,33 +40,41 @@ type UpdateProvisionedProductPropertiesInput struct { // This member is required. ProvisionedProductId *string - // A map that contains the provisioned product properties to be updated. The - // LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call + // A map that contains the provisioned product properties to be updated. + // + // The 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 - // 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 - // product. The administrator can change the owner of a provisioned product to - // another IAM or STS entity within the same account. Both end user owners and - // 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 - // 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, - // they will no longer be able to see or perform any actions through API or the - // Service Catalog console on that provisioned product. + // 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 product. + // + // The administrator can change the owner of a provisioned product to another IAM + // or STS entity within the same account. Both end user owners and 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 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, they will no longer be able to see or + // perform any actions through API or the Service Catalog console on that + // provisioned product. // // This member is required. ProvisionedProductProperties map[string]string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/api_op_UpdateProvisioningArtifact.go b/service/servicecatalog/api_op_UpdateProvisioningArtifact.go index d6b9fc05dff..3262c8c1d24 100644 --- a/service/servicecatalog/api_op_UpdateProvisioningArtifact.go +++ b/service/servicecatalog/api_op_UpdateProvisioningArtifact.go @@ -12,8 +12,10 @@ import ( ) // Updates the specified provisioning artifact (also known as a version) for the -// specified product. You cannot update a provisioning artifact for a product that -// was shared with you. +// specified product. +// +// You cannot update a provisioning artifact for a product that was shared with +// you. func (c *Client) UpdateProvisioningArtifact(ctx context.Context, params *UpdateProvisioningArtifactInput, optFns ...func(*Options)) (*UpdateProvisioningArtifactOutput, error) { if params == nil { params = &UpdateProvisioningArtifactInput{} @@ -42,24 +44,30 @@ type UpdateProvisioningArtifactInput struct { ProvisioningArtifactId *string // The language code. + // // - 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. Description *string // Information set by the administrator to provide guidance to end users about - // which provisioning artifacts to use. The DEFAULT value indicates that the - // product version is active. The administrator can set the guidance to DEPRECATED - // to inform users that the product version is deprecated. Users are able to make - // updates to a provisioned product of a deprecated version but cannot launch new - // provisioned products using a deprecated version. + // which provisioning artifacts to use. + // + // The DEFAULT value indicates that the product version is active. + // + // The administrator can set the guidance to DEPRECATED to inform users that the + // product version is deprecated. Users are able to make updates to a provisioned + // product of a deprecated version but cannot launch new provisioned products using + // a deprecated version. Guidance types.ProvisioningArtifactGuidance // The updated name of the provisioning artifact. diff --git a/service/servicecatalog/api_op_UpdateServiceAction.go b/service/servicecatalog/api_op_UpdateServiceAction.go index 297fe89b258..8667e768064 100644 --- a/service/servicecatalog/api_op_UpdateServiceAction.go +++ b/service/servicecatalog/api_op_UpdateServiceAction.go @@ -35,7 +35,9 @@ type UpdateServiceActionInput struct { Id *string // The language code. + // // - jp - Japanese + // // - zh - Chinese AcceptLanguage *string diff --git a/service/servicecatalog/doc.go b/service/servicecatalog/doc.go index 399b3f6d081..092bb07ddff 100644 --- a/service/servicecatalog/doc.go +++ b/service/servicecatalog/doc.go @@ -3,9 +3,12 @@ // Package servicecatalog provides the API client, operations, and parameter types // for AWS Service Catalog. // -// 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) -// . +// # Service Catalog +// +// [Service Catalog]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]. +// +// [Service Catalog Concepts]: http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html +// [Service Catalog]: http://aws.amazon.com/servicecatalog package servicecatalog diff --git a/service/servicecatalog/options.go b/service/servicecatalog/options.go index a7ded309f4c..b5bbd0c0c23 100644 --- a/service/servicecatalog/options.go +++ b/service/servicecatalog/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/servicecatalog/types/enums.go b/service/servicecatalog/types/enums.go index 6e232db3901..2659642f53a 100644 --- a/service/servicecatalog/types/enums.go +++ b/service/servicecatalog/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AccessLevelFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessLevelFilterKey) Values() []AccessLevelFilterKey { return []AccessLevelFilterKey{ "Account", @@ -32,8 +33,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -52,8 +54,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -70,8 +73,9 @@ const ( ) // Values returns all known values for CopyOption. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CopyOption) Values() []CopyOption { return []CopyOption{ "CopyTags", @@ -88,8 +92,9 @@ const ( ) // Values returns all known values for CopyProductStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CopyProductStatus) Values() []CopyProductStatus { return []CopyProductStatus{ "SUCCEEDED", @@ -110,6 +115,7 @@ const ( // Values returns all known values for DescribePortfolioShareType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DescribePortfolioShareType) Values() []DescribePortfolioShareType { return []DescribePortfolioShareType{ @@ -129,8 +135,9 @@ const ( ) // Values returns all known values for EngineWorkflowStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EngineWorkflowStatus) Values() []EngineWorkflowStatus { return []EngineWorkflowStatus{ "SUCCEEDED", @@ -147,8 +154,9 @@ const ( ) // Values returns all known values for EvaluationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EvaluationType) Values() []EvaluationType { return []EvaluationType{ "STATIC", @@ -165,8 +173,9 @@ const ( ) // Values returns all known values for LastSyncStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LastSyncStatus) Values() []LastSyncStatus { return []LastSyncStatus{ "SUCCEEDED", @@ -184,8 +193,9 @@ const ( ) // Values returns all known values for OrganizationNodeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationNodeType) Values() []OrganizationNodeType { return []OrganizationNodeType{ "ORGANIZATION", @@ -204,8 +214,9 @@ const ( ) // Values returns all known values for PortfolioShareType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PortfolioShareType) Values() []PortfolioShareType { return []PortfolioShareType{ "IMPORTED", @@ -223,8 +234,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "IAM", @@ -240,8 +252,9 @@ const ( ) // Values returns all known values for ProductSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductSource) Values() []ProductSource { return []ProductSource{ "ACCOUNT", @@ -260,8 +273,9 @@ const ( ) // Values returns all known values for ProductType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductType) Values() []ProductType { return []ProductType{ "CLOUD_FORMATION_TEMPLATE", @@ -283,8 +297,9 @@ const ( ) // Values returns all known values for ProductViewFilterBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductViewFilterBy) Values() []ProductViewFilterBy { return []ProductViewFilterBy{ "FullTextSearch", @@ -304,8 +319,9 @@ const ( ) // Values returns all known values for ProductViewSortBy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProductViewSortBy) Values() []ProductViewSortBy { return []ProductViewSortBy{ "Title", @@ -323,8 +339,9 @@ const ( ) // Values returns all known values for PropertyKey. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PropertyKey) Values() []PropertyKey { return []PropertyKey{ "OWNER", @@ -346,8 +363,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedProductPlanStatus) Values() []ProvisionedProductPlanStatus { return []ProvisionedProductPlanStatus{ "CREATE_IN_PROGRESS", @@ -368,6 +386,7 @@ const ( // Values returns all known values for ProvisionedProductPlanType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedProductPlanType) Values() []ProvisionedProductPlanType { return []ProvisionedProductPlanType{ @@ -388,6 +407,7 @@ const ( // 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{ @@ -408,8 +428,9 @@ const ( // Values returns all known values for ProvisionedProductViewFilterBy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionedProductViewFilterBy) Values() []ProvisionedProductViewFilterBy { return []ProvisionedProductViewFilterBy{ "SearchQuery", @@ -426,8 +447,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisioningArtifactGuidance) Values() []ProvisioningArtifactGuidance { return []ProvisioningArtifactGuidance{ "DEFAULT", @@ -444,8 +466,9 @@ const ( // Values returns all known values for ProvisioningArtifactPropertyName. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisioningArtifactPropertyName) Values() []ProvisioningArtifactPropertyName { return []ProvisioningArtifactPropertyName{ "Id", @@ -466,6 +489,7 @@ const ( // 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{ @@ -490,8 +514,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -512,8 +537,9 @@ const ( ) // Values returns all known values for Replacement. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Replacement) Values() []Replacement { return []Replacement{ "TRUE", @@ -532,8 +558,9 @@ const ( ) // Values returns all known values for RequiresRecreation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequiresRecreation) Values() []RequiresRecreation { return []RequiresRecreation{ "NEVER", @@ -555,8 +582,9 @@ const ( ) // Values returns all known values for ResourceAttribute. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceAttribute) Values() []ResourceAttribute { return []ResourceAttribute{ "PROPERTIES", @@ -582,8 +610,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceActionAssociationErrorCode) Values() []ServiceActionAssociationErrorCode { return []ServiceActionAssociationErrorCode{ "DUPLICATE_RESOURCE", @@ -607,6 +636,7 @@ const ( // Values returns all known values for ServiceActionDefinitionKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServiceActionDefinitionKey) Values() []ServiceActionDefinitionKey { return []ServiceActionDefinitionKey{ @@ -626,6 +656,7 @@ const ( // Values returns all known values for ServiceActionDefinitionType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ServiceActionDefinitionType) Values() []ServiceActionDefinitionType { return []ServiceActionDefinitionType{ @@ -645,8 +676,9 @@ const ( ) // Values returns all known values for ShareStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatus) Values() []ShareStatus { return []ShareStatus{ "NOT_STARTED", @@ -666,8 +698,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -683,8 +716,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "CODESTAR", @@ -701,8 +735,9 @@ const ( ) // Values returns all known values for StackInstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StackInstanceStatus) Values() []StackInstanceStatus { return []StackInstanceStatus{ "CURRENT", @@ -721,8 +756,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CREATE", @@ -741,8 +777,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "AVAILABLE", diff --git a/service/servicecatalog/types/types.go b/service/servicecatalog/types/types.go index 9f726b5710c..b17d52a0df0 100644 --- a/service/servicecatalog/types/types.go +++ b/service/servicecatalog/types/types.go @@ -11,8 +11,11 @@ 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. Key AccessLevelFilterKey @@ -90,9 +93,13 @@ type ConstraintDetail struct { ProductId *string // The type of constraint. + // // - LAUNCH + // // - NOTIFICATION + // // - STACKSET + // // - TEMPLATE Type *string @@ -106,19 +113,25 @@ type ConstraintSummary struct { Description *string // The type of constraint. + // // - LAUNCH + // // - NOTIFICATION + // // - STACKSET + // // - TEMPLATE Type *string noSmithyDocumentSerde } -// The ID for the provisioned product resources that are part of a resource group. +// The ID for the provisioned product resources that are part of a resource +// +// group. type EngineWorkflowResourceIdentifier struct { - // The unique key-value pair for a tag that identifies provisioned product + // The unique key-value pair for a tag that identifies provisioned product // resources. UniqueTag *UniqueTagResourceIdentifier @@ -165,10 +178,15 @@ type FailedServiceActionAssociation struct { // Provides details about the product's connection sync and contains the following // sub-fields. +// // - LastSyncTime +// // - LastSyncStatus +// // - LastSyncStatusMessage +// // - LastSuccessfulSyncTime +// // - LastSuccessfulSyncProvisioningArtifactID type LastSync struct { @@ -227,7 +245,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. Key *string @@ -278,11 +298,16 @@ type ParameterConstraints struct { // A string that explains a constraint when the constraint is violated. For // example, without a constraint description, a parameter that has an allowed // pattern of [A-Za-z0-9]+ displays the following error message when the user - // specifies an invalid value: Malformed input-Parameter MyParameter must match - // pattern [A-Za-z0-9]+ By adding a constraint description, such as must only - // contain letters (uppercase and lowercase) and numbers, you can display the - // following customized error message: Malformed input-Parameter MyParameter must - // only contain uppercase and lowercase letters and numbers. + // specifies an invalid value: + // + // Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+ + // + // By adding a constraint description, such as must only contain letters + // (uppercase and lowercase) and numbers, you can display the following customized + // error message: + // + // Malformed input-Parameter MyParameter must only contain uppercase and lowercase + // letters and numbers. ConstraintDescription *string // An integer value that determines the largest number of characters you want to @@ -337,9 +362,16 @@ type PortfolioShareDetail struct { Accepted bool // The identifier of the recipient entity that received the portfolio share. The - // recipient entity can be one of the following: 1. An external account. 2. An - // organziation member account. 3. An organzational unit (OU). 4. The organization - // itself. (This shares with every account in the organization). + // recipient entity can be one of the following: + // + // 1. An external account. + // + // 2. An organziation member account. + // + // 3. An organzational unit (OU). + // + // 4. The organization itself. (This shares with every account in the + // organization). PrincipalId *string // Indicates if Principal sharing is enabled or disabled for the portfolio share. @@ -360,8 +392,11 @@ type Principal struct { // The ARN of the principal (user, role, or group). This field allows for an ARN // with no accountID , with or without wildcard characters if the PrincipalType is - // an IAM_PATTERN . For more information, review associate-principal-with-portfolio (https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options) - // in the Amazon Web Services CLI Command Reference. + // an IAM_PATTERN . + // + // For more information, review [associate-principal-with-portfolio] in the Amazon Web Services CLI Command Reference. + // + // [associate-principal-with-portfolio]: https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options PrincipalARN *string // The principal type. The supported value is IAM if you use a fully defined ARN, @@ -405,8 +440,11 @@ type ProductViewDetail struct { 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. Status Status @@ -421,9 +459,8 @@ type ProductViewSummary struct { 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, - // ListLaunchPaths is not required, and the output of ProductViewSummary can be - // used directly with DescribeProvisioningParameters . + // a default path, call ListLaunchPathsto disambiguate between paths. Otherwise, ListLaunchPaths is not + // required, and the output of ProductViewSummarycan be used directly with DescribeProvisioningParameters. HasDefaultPath bool // The product view identifier. @@ -478,9 +515,13 @@ type ProvisionedProductAttribute struct { // The record identifier of the last request performed on this provisioned product // of the following types: + // // - ProvisionProduct + // // - UpdateProvisionedProduct + // // - ExecuteProvisionedProductPlan + // // - TerminateProvisionedProduct LastProvisioningRecordId *string @@ -489,9 +530,13 @@ type ProvisionedProductAttribute struct { // The record identifier of the last successful request performed on this // provisioned product of the following types: + // // - ProvisionProduct + // // - UpdateProvisionedProduct + // // - ExecuteProvisionedProductPlan + // // - TerminateProvisionedProduct LastSuccessfulProvisioningRecordId *string @@ -515,17 +560,22 @@ 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 @@ -570,9 +620,13 @@ type ProvisionedProductDetail struct { // The record identifier of the last request performed on this provisioned product // of the following types: + // // - ProvisionProduct + // // - UpdateProvisionedProduct + // // - ExecuteProvisionedProductPlan + // // - TerminateProvisionedProduct LastProvisioningRecordId *string @@ -581,9 +635,13 @@ type ProvisionedProductDetail struct { // The record identifier of the last successful request performed on this // provisioned product of the following types: + // // - ProvisionProduct + // // - UpdateProvisionedProduct + // // - ExecuteProvisionedProductPlan + // // - TerminateProvisionedProduct LastSuccessfulProvisioningRecordId *string @@ -600,17 +658,22 @@ type ProvisionedProductDetail struct { 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 @@ -639,7 +702,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. @@ -758,13 +821,19 @@ type ProvisioningArtifactDetail struct { // ProvisioningArtifactDetail type, which is returned as part of the response for // CreateProduct , UpdateProduct , DescribeProductAsAdmin , // DescribeProvisioningArtifact , ListProvisioningArtifact , and - // UpdateProvisioningArticat APIs. This field only exists for Repo-Synced products. + // UpdateProvisioningArticat APIs. + // + // This field only exists for Repo-Synced products. SourceRevision *string // The type of provisioning artifact. + // // - CLOUD_FORMATION_TEMPLATE - CloudFormation template + // // - TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file + // // - TERRAFORM_CLOUD - Terraform Cloud configuration file + // // - EXTERNAL - External configuration file Type ProvisioningArtifactType @@ -811,23 +880,27 @@ type ProvisioningArtifactParameter struct { // The user-defined preferences that will be applied during product provisioning, // 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) +// +// For more information on maximum concurrent accounts and failure tolerance, see [Stack set operation options] // in the CloudFormation User Guide. +// +// [Stack set operation options]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options 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 // ProvisioningPreferences$StackSetAccounts and - // UpdateProvisioningPreferences$StackSetAccounts . Applicable only to a - // CFN_STACKSET provisioned product type. + // 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 @@ -842,15 +915,21 @@ type ProvisioningArtifactProperties struct { Description *string // If set to true, Service Catalog stops validating the specified provisioning - // artifact even if it is invalid. Service Catalog does not support template - // validation for the TERRAFORM_OS product type. + // artifact even if it is invalid. + // + // Service Catalog does not support template validation for the TERRAFORM_OS + // product type. DisableTemplateValidation bool // Specify the template source with one of the following options, but not both. - // 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/..." + // 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: @@ -862,9 +941,13 @@ type ProvisioningArtifactProperties struct { Name *string // The type of provisioning artifact. + // // - CLOUD_FORMATION_TEMPLATE - CloudFormation template + // // - TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file + // // - TERRAFORM_CLOUD - Terraform Cloud configuration file + // // - EXTERNAL - External configuration file Type ProvisioningArtifactType @@ -921,71 +1004,105 @@ type ProvisioningParameter struct { } // The user-defined preferences that will be applied when updating a provisioned -// product. Not all preferences are applicable to all provisioned product type 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 constraint, -// use the DescribeProvisioningParameters operation. If no values are specified, -// the default value is all accounts from the STACKSET constraint. +// product. Not all preferences are applicable to all provisioned product type +// +// 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 +// 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 - // available. Applicable only to a CFN_STACKSET provisioned product type. The - // specified accounts should be within the list of accounts from the STACKSET + // available. + // + // Applicable only to a CFN_STACKSET provisioned product type. + // + // The specified accounts should be within the list of accounts from 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 acounts from the STACKSET constraint. + // DescribeProvisioningParameters operation. + // + // If no values are specified, the default value is all acounts from the STACKSET + // constraint. StackSetAccounts []string // The number of accounts, per Region, for which this operation can fail before // Service Catalog stops the operation in that Region. If the operation is stopped // in a Region, Service Catalog doesn't attempt the operation in any subsequent - // Regions. Applicable only to a CFN_STACKSET provisioned product type. + // 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 - // value is specified. + // StackSetFailureTolerancePercentage , but not both. + // + // The default value is 0 if no value is specified. StackSetFailureToleranceCount *int32 // The percentage of accounts, per Region, for which this stack operation can fail // before Service Catalog stops the operation in that Region. If the operation is // stopped in a Region, Service Catalog doesn't attempt the operation in any - // subsequent Regions. When calculating the number of accounts based on the - // 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 + // subsequent Regions. + // + // When calculating the number of accounts based on the 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 *int32 // The maximum number of accounts in which to perform this operation at one time. // 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 - // 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. + // 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. StackSetMaxConcurrencyCount *int32 // The maximum percentage of accounts in which to perform this operation at one - // time. When calculating the number of accounts based on the specified percentage, + // time. + // + // When calculating the number of accounts based on the specified percentage, // Service Catalog rounds down to the next whole number. This is true except in // cases where rounding down would result is zero. In this case, Service Catalog - // sets the number as 1 instead. 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. + // sets the number as 1 instead. + // + // 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. StackSetMaxConcurrencyPercentage *int32 // One or more Amazon Web Services Regions where the provisioned product will be - // available. Applicable only to a CFN_STACKSET provisioned product type. The - // specified Regions should be within the list of Regions from the STACKSET + // available. + // + // Applicable only to a CFN_STACKSET provisioned product type. + // + // The specified Regions should be within the list of Regions from the STACKSET // constraint. To get the list of Regions in the STACKSET constraint, use the - // DescribeProvisioningParameters operation. If no values are specified, the - // default value is all Regions from the STACKSET constraint. + // DescribeProvisioningParameters operation. + // + // If no values are specified, the default value is all Regions from the STACKSET + // constraint. StackSetRegions []string noSmithyDocumentSerde @@ -1029,18 +1146,26 @@ type RecordDetail struct { RecordTags []RecordTag // The record type. + // // - 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. Status RecordStatus @@ -1280,10 +1405,15 @@ type SourceConnectionDetail struct { // Provides details about the product's connection sync and contains the following // sub-fields. + // // - LastSyncTime + // // - LastSyncStatus + // // - LastSyncStatusMessage + // // - LastSuccessfulSyncTime + // // - LastSuccessfulSyncProvisioningArtifactID LastSync *LastSync @@ -1321,15 +1451,18 @@ 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 // 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 @@ -1387,14 +1520,15 @@ type TagOptionSummary struct { noSmithyDocumentSerde } -// The unique key-value pair for a tag that identifies provisioned product +// The unique key-value pair for a tag that identifies provisioned product +// // resources. type UniqueTagResourceIdentifier struct { - // A unique key that's attached to a resource. + // A unique key that's attached to a resource. Key *string - // A unique value that's attached to a resource. + // A unique value that's attached to a resource. Value *string noSmithyDocumentSerde @@ -1420,72 +1554,107 @@ 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 + // 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. + // constraint, use the DescribeProvisioningParameters operation. + // + // If no values are specified, the default value is all accounts from the STACKSET + // constraint. StackSetAccounts []string // The number of accounts, per Region, for which this operation can fail before // Service Catalog stops the operation in that Region. If the operation is stopped // in a Region, Service Catalog doesn't attempt the operation in any subsequent - // Regions. Applicable only to a CFN_STACKSET provisioned product type. + // 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 - // value is specified. + // StackSetFailureTolerancePercentage , but not both. + // + // The default value is 0 if no value is specified. StackSetFailureToleranceCount *int32 // The percentage of accounts, per Region, for which this stack operation can fail // before Service Catalog stops the operation in that Region. If the operation is // stopped in a Region, Service Catalog doesn't attempt the operation in any - // subsequent Regions. When calculating the number of accounts based on the - // 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 + // subsequent Regions. + // + // When calculating the number of accounts based on the 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 *int32 // The maximum number of accounts in which to perform this operation at one time. // 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 - // 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. + // 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. StackSetMaxConcurrencyCount *int32 // The maximum percentage of accounts in which to perform this operation at one - // time. When calculating the number of accounts based on the specified percentage, + // time. + // + // When calculating the number of accounts based on the specified percentage, // Service Catalog rounds down to the next whole number. This is true except in // cases where rounding down would result is zero. In this case, Service Catalog - // sets the number as 1 instead. 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. + // sets the number as 1 instead. + // + // 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. StackSetMaxConcurrencyPercentage *int32 // Determines what action Service Catalog performs to a stack set or a stack // instance represented by the provisioned product. The default value is UPDATE if - // nothing is specified. Applicable only to a CFN_STACKSET provisioned product - // type. CREATE Creates a new stack instance in the stack set represented by the + // nothing is specified. + // + // Applicable only to a CFN_STACKSET provisioned product type. + // + // CREATE Creates a new stack instance in the stack set represented by the // provisioned product. In this case, only new stack instances are created based on // accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, - // they will be ignored. UPDATE Updates the stack set represented by the - // provisioned product and also its stack instances. DELETE Deletes a stack - // instance in the stack set represented by the provisioned product. + // they will be ignored. + // + // UPDATE Updates the stack set represented by the provisioned product and also + // its stack instances. + // + // DELETE Deletes a stack instance in the stack set represented by the provisioned + // product. StackSetOperationType StackSetOperationType // One or more Amazon Web Services Regions where the provisioned product will be - // available. Applicable only to a CFN_STACKSET provisioned product type. The - // specified Regions should be within the list of Regions from the STACKSET + // available. + // + // Applicable only to a CFN_STACKSET provisioned product type. + // + // The specified Regions should be within the list of Regions from the STACKSET // constraint. To get the list of Regions in the STACKSET constraint, use the - // DescribeProvisioningParameters operation. If no values are specified, the - // default value is all Regions from the STACKSET constraint. + // DescribeProvisioningParameters operation. + // + // If no values are specified, the default value is all Regions from the STACKSET + // constraint. StackSetRegions []string noSmithyDocumentSerde diff --git a/service/servicecatalogappregistry/api_op_AssociateAttributeGroup.go b/service/servicecatalogappregistry/api_op_AssociateAttributeGroup.go index baaff3958f7..038de391c20 100644 --- a/service/servicecatalogappregistry/api_op_AssociateAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_AssociateAttributeGroup.go @@ -31,12 +31,12 @@ func (c *Client) AssociateAttributeGroup(ctx context.Context, params *AssociateA type AssociateAttributeGroupInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string - // The name, ID, or ARN of the attribute group that holds the attributes to + // The name, ID, or ARN of the attribute group that holds the attributes to // describe the application. // // This member is required. diff --git a/service/servicecatalogappregistry/api_op_AssociateResource.go b/service/servicecatalogappregistry/api_op_AssociateResource.go index 41696e63a75..a75acc81e18 100644 --- a/service/servicecatalogappregistry/api_op_AssociateResource.go +++ b/service/servicecatalogappregistry/api_op_AssociateResource.go @@ -11,25 +11,35 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a resource with an application. The resource can be specified by its -// ARN or name. The application can be specified by ARN, ID, or name. Minimum -// permissions You must have the following permissions to associate a resource -// using the OPTIONS parameter set to APPLY_APPLICATION_TAG . +// Associates a resource with an application. The resource can be specified by +// +// its ARN or name. The application can be specified by ARN, ID, or name. +// +// # Minimum permissions +// +// You must have the following permissions to associate a resource using the +// OPTIONS parameter set to APPLY_APPLICATION_TAG . +// // - tag:GetResources +// // - tag:TagResources // // You must also have these additional permissions if you don't use the -// AWSServiceCatalogAppRegistryFullAccess policy. For more information, see -// AWSServiceCatalogAppRegistryFullAccess (https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html) -// in the AppRegistry Administrator Guide. +// AWSServiceCatalogAppRegistryFullAccess policy. For more information, see [AWSServiceCatalogAppRegistryFullAccess] in +// the AppRegistry Administrator Guide. +// // - resource-groups:AssociateResource +// // - cloudformation:UpdateStack +// // - cloudformation:DescribeStacks // // In addition, you must have the tagging permission defined by the Amazon Web -// Services service that creates the resource. For more information, see -// TagResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html) -// in the Resource Groups Tagging API Reference. +// Services service that creates the resource. For more information, see [TagResources]in the +// Resource Groups Tagging API Reference. +// +// [TagResources]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html +// [AWSServiceCatalogAppRegistryFullAccess]: https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html func (c *Client) AssociateResource(ctx context.Context, params *AssociateResourceInput, optFns ...func(*Options)) (*AssociateResourceOutput, error) { if params == nil { params = &AssociateResourceInput{} @@ -47,7 +57,7 @@ func (c *Client) AssociateResource(ctx context.Context, params *AssociateResourc type AssociateResourceInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string @@ -62,7 +72,7 @@ type AssociateResourceInput struct { // This member is required. ResourceType types.ResourceType - // Determines whether an application tag is applied or skipped. + // Determines whether an application tag is applied or skipped. Options []types.AssociationOption noSmithyDocumentSerde @@ -74,7 +84,7 @@ type AssociateResourceOutput struct { // attributes. ApplicationArn *string - // Determines whether an application tag is applied or skipped. + // Determines whether an application tag is applied or skipped. Options []types.AssociationOption // The Amazon resource name (ARN) that specifies the resource. diff --git a/service/servicecatalogappregistry/api_op_DeleteApplication.go b/service/servicecatalogappregistry/api_op_DeleteApplication.go index c866500652b..b21d444b4b6 100644 --- a/service/servicecatalogappregistry/api_op_DeleteApplication.go +++ b/service/servicecatalogappregistry/api_op_DeleteApplication.go @@ -31,7 +31,7 @@ func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicatio type DeleteApplicationInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string diff --git a/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go b/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go index 17808921d98..78695183a41 100644 --- a/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_DeleteAttributeGroup.go @@ -30,7 +30,7 @@ func (c *Client) DeleteAttributeGroup(ctx context.Context, params *DeleteAttribu type DeleteAttributeGroupInput struct { - // The name, ID, or ARN of the attribute group that holds the attributes to + // The name, ID, or ARN of the attribute group that holds the attributes to // describe the application. // // This member is required. diff --git a/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go b/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go index e743b2cf6ee..77465aad2df 100644 --- a/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_DisassociateAttributeGroup.go @@ -30,12 +30,12 @@ func (c *Client) DisassociateAttributeGroup(ctx context.Context, params *Disasso type DisassociateAttributeGroupInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string - // The name, ID, or ARN of the attribute group that holds the attributes to + // The name, ID, or ARN of the attribute group that holds the attributes to // describe the application. // // This member is required. diff --git a/service/servicecatalogappregistry/api_op_DisassociateResource.go b/service/servicecatalogappregistry/api_op_DisassociateResource.go index b3fbc2b40d9..f833b350698 100644 --- a/service/servicecatalogappregistry/api_op_DisassociateResource.go +++ b/service/servicecatalogappregistry/api_op_DisassociateResource.go @@ -11,26 +11,36 @@ 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. Minimum permissions You must -// have the following permissions to remove a resource that's been associated with -// an application using the APPLY_APPLICATION_TAG option for AssociateResource (https://docs.aws.amazon.com/servicecatalog/latest/dg/API_app-registry_AssociateResource.html) -// . +// Disassociates a resource from application. Both the resource and the +// +// application can be specified either by ID or name. +// +// # Minimum permissions +// +// You must have the following permissions to remove a resource that's been +// associated with an application using the APPLY_APPLICATION_TAG option for [AssociateResource]. +// // - tag:GetResources +// // - tag:UntagResources // // You must also have the following permissions if you don't use the -// AWSServiceCatalogAppRegistryFullAccess policy. For more information, see -// AWSServiceCatalogAppRegistryFullAccess (https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html) -// in the AppRegistry Administrator Guide. +// AWSServiceCatalogAppRegistryFullAccess policy. For more information, see [AWSServiceCatalogAppRegistryFullAccess] in +// the AppRegistry Administrator Guide. +// // - resource-groups:DisassociateResource +// // - cloudformation:UpdateStack +// // - cloudformation:DescribeStacks // // In addition, you must have the tagging permission defined by the Amazon Web -// Services service that creates the resource. For more information, see -// UntagResources (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntTagResources.html) -// in the Resource Groups Tagging API Reference. +// Services service that creates the resource. For more information, see [UntagResources]in the +// Resource Groups Tagging API Reference. +// +// [UntagResources]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntTagResources.html +// [AWSServiceCatalogAppRegistryFullAccess]: https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html +// [AssociateResource]: https://docs.aws.amazon.com/servicecatalog/latest/dg/API_app-registry_AssociateResource.html 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_GetApplication.go b/service/servicecatalogappregistry/api_op_GetApplication.go index a2ec443442b..03375c05e00 100644 --- a/service/servicecatalogappregistry/api_op_GetApplication.go +++ b/service/servicecatalogappregistry/api_op_GetApplication.go @@ -12,7 +12,8 @@ import ( "time" ) -// Retrieves metadata information about one of your applications. The application +// Retrieves metadata information about one of your applications. The application +// // can be specified by its ARN, ID, or name (which is unique within one account in // one region at a given point in time). Specify by ARN or ID in automated // workflows if you want to make sure that the exact same application is returned @@ -34,7 +35,7 @@ func (c *Client) GetApplication(ctx context.Context, params *GetApplicationInput type GetApplicationInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string @@ -44,7 +45,7 @@ type GetApplicationInput struct { type GetApplicationOutput struct { - // A key-value pair that identifies an associated resource. + // A key-value pair that identifies an associated resource. ApplicationTag map[string]string // The Amazon resource name (ARN) that specifies the application across services. @@ -63,7 +64,7 @@ type GetApplicationOutput struct { // The identifier of the application. Id *string - // The information about the integration of the application with other services, + // The information about the integration of the application with other services, // such as Resource Groups. Integrations *types.Integrations diff --git a/service/servicecatalogappregistry/api_op_GetAssociatedResource.go b/service/servicecatalogappregistry/api_op_GetAssociatedResource.go index 7949bac909b..71a79e6ce99 100644 --- a/service/servicecatalogappregistry/api_op_GetAssociatedResource.go +++ b/service/servicecatalogappregistry/api_op_GetAssociatedResource.go @@ -29,7 +29,7 @@ func (c *Client) GetAssociatedResource(ctx context.Context, params *GetAssociate type GetAssociatedResourceInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string @@ -44,15 +44,15 @@ type GetAssociatedResourceInput struct { // This member is required. ResourceType types.ResourceType - // The maximum number of results to return. If the parameter is omitted, it + // The maximum number of results to return. If the parameter is omitted, it // defaults to 25. The value is optional. MaxResults *int32 - // A unique pagination token for each page of results. Make the call again with + // A unique pagination token for each page of results. Make the call again with // the returned token to retrieve the next page of results. NextToken *string - // States whether an application tag is applied, not applied, in the process of + // States whether an application tag is applied, not applied, in the process of // being applied, or skipped. ResourceTagStatus []types.ResourceItemStatus @@ -61,10 +61,10 @@ type GetAssociatedResourceInput struct { type GetAssociatedResourceOutput struct { - // The result of the application that's tag applied to a resource. + // The result of the application that's tag applied to a resource. ApplicationTagResult *types.ApplicationTagResult - // Determines whether an application tag is applied or skipped. + // Determines whether an application tag is applied or skipped. Options []types.AssociationOption // The resource associated with the application. diff --git a/service/servicecatalogappregistry/api_op_GetAttributeGroup.go b/service/servicecatalogappregistry/api_op_GetAttributeGroup.go index 278099f8dbe..2d31d9dcf90 100644 --- a/service/servicecatalogappregistry/api_op_GetAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_GetAttributeGroup.go @@ -11,7 +11,8 @@ import ( "time" ) -// Retrieves an attribute group by its ARN, ID, or name. The attribute group can +// 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 { @@ -30,7 +31,7 @@ func (c *Client) GetAttributeGroup(ctx context.Context, params *GetAttributeGrou type GetAttributeGroupInput struct { - // The name, ID, or ARN of the attribute group that holds the attributes to + // The name, ID, or ARN of the attribute group that holds the attributes to // describe the application. // // This member is required. diff --git a/service/servicecatalogappregistry/api_op_GetConfiguration.go b/service/servicecatalogappregistry/api_op_GetConfiguration.go index 87d6267b746..de0119ac227 100644 --- a/service/servicecatalogappregistry/api_op_GetConfiguration.go +++ b/service/servicecatalogappregistry/api_op_GetConfiguration.go @@ -33,7 +33,7 @@ type GetConfigurationInput struct { type GetConfigurationOutput struct { - // Retrieves TagKey configuration from an account. + // Retrieves TagKey configuration from an account. Configuration *types.AppRegistryConfiguration // Metadata pertaining to the operation's result. diff --git a/service/servicecatalogappregistry/api_op_ListAssociatedResources.go b/service/servicecatalogappregistry/api_op_ListAssociatedResources.go index e0709639c45..af44142a3f3 100644 --- a/service/servicecatalogappregistry/api_op_ListAssociatedResources.go +++ b/service/servicecatalogappregistry/api_op_ListAssociatedResources.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all of the resources that are associated with the specified application. -// Results are paginated. If you share an application, and a consumer account -// associates a tag query to the application, all of the users who can access the -// application can also view the tag values in all accounts that are associated -// with it using this API. +// Lists all of the resources that are associated with the specified application. +// +// Results are paginated. +// +// If you share an application, and a consumer account associates a tag query to +// the application, all of the users who can access the application can also view +// the tag values in all accounts that are associated with it using this API. func (c *Client) ListAssociatedResources(ctx context.Context, params *ListAssociatedResourcesInput, optFns ...func(*Options)) (*ListAssociatedResourcesOutput, error) { if params == nil { params = &ListAssociatedResourcesInput{} @@ -33,7 +35,7 @@ func (c *Client) ListAssociatedResources(ctx context.Context, params *ListAssoci type ListAssociatedResourcesInput struct { - // The name, ID, or ARN of the application. + // The name, ID, or ARN of the application. // // This member is required. Application *string diff --git a/service/servicecatalogappregistry/api_op_ListAttributeGroupsForApplication.go b/service/servicecatalogappregistry/api_op_ListAttributeGroupsForApplication.go index 539910ee1c4..ec482e374ec 100644 --- a/service/servicecatalogappregistry/api_op_ListAttributeGroupsForApplication.go +++ b/service/servicecatalogappregistry/api_op_ListAttributeGroupsForApplication.go @@ -47,7 +47,7 @@ type ListAttributeGroupsForApplicationInput struct { type ListAttributeGroupsForApplicationOutput struct { - // The details related to a specific attribute group. + // The details related to a specific attribute group. AttributeGroupsDetails []types.AttributeGroupDetails // The token to use to get the next page of results after a previous API call. diff --git a/service/servicecatalogappregistry/api_op_PutConfiguration.go b/service/servicecatalogappregistry/api_op_PutConfiguration.go index 4ab34df61ed..5e65fdd2f4e 100644 --- a/service/servicecatalogappregistry/api_op_PutConfiguration.go +++ b/service/servicecatalogappregistry/api_op_PutConfiguration.go @@ -29,7 +29,7 @@ func (c *Client) PutConfiguration(ctx context.Context, params *PutConfigurationI type PutConfigurationInput struct { - // Associates a TagKey configuration to an account. + // Associates a TagKey configuration to an account. // // This member is required. Configuration *types.AppRegistryConfiguration diff --git a/service/servicecatalogappregistry/api_op_SyncResource.go b/service/servicecatalogappregistry/api_op_SyncResource.go index e62b28b4d0a..91db15fca70 100644 --- a/service/servicecatalogappregistry/api_op_SyncResource.go +++ b/service/servicecatalogappregistry/api_op_SyncResource.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Syncs the resource with current AppRegistry records. Specifically, the -// resource’s AppRegistry system tags sync with its associated application. We -// remove the resource's AppRegistry system tags if it does not associate with the -// application. The caller must have permissions to read and update the resource. +// Syncs the resource with current AppRegistry records. +// +// Specifically, the resource’s AppRegistry system tags sync with its associated +// application. We remove the resource's AppRegistry system tags if it does not +// associate with the application. The caller must have permissions to read and +// update the resource. func (c *Client) SyncResource(ctx context.Context, params *SyncResourceInput, optFns ...func(*Options)) (*SyncResourceOutput, error) { if params == nil { params = &SyncResourceInput{} diff --git a/service/servicecatalogappregistry/api_op_TagResource.go b/service/servicecatalogappregistry/api_op_TagResource.go index 838b53018b5..3f6d41da6dc 100644 --- a/service/servicecatalogappregistry/api_op_TagResource.go +++ b/service/servicecatalogappregistry/api_op_TagResource.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Assigns one or more tags (key-value pairs) to the specified resource. Each tag -// consists of a key and an optional value. If a tag with the same key is already -// associated with the resource, this action updates its value. This operation -// returns an empty response if the call was successful. +// Assigns one or more tags (key-value pairs) to the specified resource. +// +// Each tag consists of a key and an optional value. If a tag with the same key is +// already associated with the resource, this action updates its value. +// +// This operation returns an empty response if the call was successful. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/servicecatalogappregistry/api_op_UntagResource.go b/service/servicecatalogappregistry/api_op_UntagResource.go index e2b51ce9c17..0aa2d83d2da 100644 --- a/service/servicecatalogappregistry/api_op_UntagResource.go +++ b/service/servicecatalogappregistry/api_op_UntagResource.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Removes tags from a resource. This operation returns an empty response if the -// call was successful. +// Removes tags from a resource. +// +// This operation returns an empty response if the call was successful. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/servicecatalogappregistry/api_op_UpdateApplication.go b/service/servicecatalogappregistry/api_op_UpdateApplication.go index cd91d69e5ac..6eb180adaee 100644 --- a/service/servicecatalogappregistry/api_op_UpdateApplication.go +++ b/service/servicecatalogappregistry/api_op_UpdateApplication.go @@ -29,7 +29,7 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio type UpdateApplicationInput struct { - // The name, ID, or ARN of the application that will be updated. + // The name, ID, or ARN of the application that will be updated. // // This member is required. Application *string diff --git a/service/servicecatalogappregistry/api_op_UpdateAttributeGroup.go b/service/servicecatalogappregistry/api_op_UpdateAttributeGroup.go index 883ffa2220b..a0bb936c520 100644 --- a/service/servicecatalogappregistry/api_op_UpdateAttributeGroup.go +++ b/service/servicecatalogappregistry/api_op_UpdateAttributeGroup.go @@ -29,7 +29,7 @@ func (c *Client) UpdateAttributeGroup(ctx context.Context, params *UpdateAttribu type UpdateAttributeGroupInput struct { - // The name, ID, or ARN of the attribute group that holds the attributes to + // The name, ID, or ARN of the attribute group that holds the attributes to // describe the application. // // This member is required. diff --git a/service/servicecatalogappregistry/doc.go b/service/servicecatalogappregistry/doc.go index 2138ae675cd..4eae063cd05 100644 --- a/service/servicecatalogappregistry/doc.go +++ b/service/servicecatalogappregistry/doc.go @@ -3,7 +3,8 @@ // Package servicecatalogappregistry provides the API client, operations, and // parameter types for AWS Service Catalog App Registry. // -// Amazon Web Services Service Catalog AppRegistry enables organizations to +// Amazon Web Services Service Catalog AppRegistry enables organizations to +// // understand the application context of their Amazon Web Services resources. // AppRegistry provides a repository of your applications, their resources, and the // application metadata that you use within your enterprise. diff --git a/service/servicecatalogappregistry/options.go b/service/servicecatalogappregistry/options.go index 73733a6f550..36aa8f0658a 100644 --- a/service/servicecatalogappregistry/options.go +++ b/service/servicecatalogappregistry/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/servicecatalogappregistry/types/enums.go b/service/servicecatalogappregistry/types/enums.go index a1c07328114..7e861616a9f 100644 --- a/service/servicecatalogappregistry/types/enums.go +++ b/service/servicecatalogappregistry/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for ApplicationTagStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationTagStatus) Values() []ApplicationTagStatus { return []ApplicationTagStatus{ "IN_PROGRESS", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for AssociationOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationOption) Values() []AssociationOption { return []AssociationOption{ "APPLY_APPLICATION_TAG", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for ResourceGroupState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceGroupState) Values() []ResourceGroupState { return []ResourceGroupState{ "CREATING", @@ -77,8 +80,9 @@ const ( ) // Values returns all known values for ResourceItemStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceItemStatus) Values() []ResourceItemStatus { return []ResourceItemStatus{ "SUCCESS", @@ -97,8 +101,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -115,8 +120,9 @@ const ( ) // Values returns all known values for SyncAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncAction) Values() []SyncAction { return []SyncAction{ "START_SYNC", diff --git a/service/servicecatalogappregistry/types/types.go b/service/servicecatalogappregistry/types/types.go index 25646ffb600..3100dc4d7b9 100644 --- a/service/servicecatalogappregistry/types/types.go +++ b/service/servicecatalogappregistry/types/types.go @@ -11,7 +11,7 @@ import ( // is the top-level node in a hierarchy of related cloud resource abstractions. type Application struct { - // A key-value pair that identifies an associated resource. + // A key-value pair that identifies an associated resource. ApplicationTag map[string]string // The Amazon resource name (ARN) that specifies the application across services. @@ -26,7 +26,7 @@ type Application struct { // The identifier of the application. Id *string - // The ISO-8601 formatted timestamp of the moment when the application was last + // The ISO-8601 formatted timestamp of the moment when the application was last // updated. LastUpdateTime *time.Time @@ -55,7 +55,7 @@ type ApplicationSummary struct { // The identifier of the application. Id *string - // The ISO-8601 formatted timestamp of the moment when the application was last + // The ISO-8601 formatted timestamp of the moment when the application was last // updated. LastUpdateTime *time.Time @@ -69,18 +69,18 @@ type ApplicationSummary struct { // The result of the application tag that's applied to a resource. type ApplicationTagResult struct { - // The application tag is in the process of being applied to a resource, was + // The application tag is in the process of being applied to a resource, was // successfully applied to a resource, or failed to apply to a resource. ApplicationTagStatus ApplicationTagStatus - // The message returned if the call fails. + // The message returned if the call fails. ErrorMessage *string - // A unique pagination token for each page of results. Make the call again with + // A unique pagination token for each page of results. Make the call again with // the returned token to retrieve the next page of results. NextToken *string - // The resources associated with an application + // The resources associated with an application Resources []ResourcesListItem noSmithyDocumentSerde @@ -89,7 +89,7 @@ type ApplicationTagResult 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 @@ -138,8 +138,10 @@ type AttributeGroupDetails struct { // The unique identifier of the attribute group. 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. + // This field is no longer supported. We recommend you don't use the field when + // using ListAttributeGroupsForApplication . + // + // The name of the attribute group. Name *string noSmithyDocumentSerde @@ -181,7 +183,7 @@ type Integrations struct { // The information about the resource group integration. ApplicationTagResourceGroup *ResourceGroup - // The information about the resource group integration. + // The information about the resource group integration. ResourceGroup *ResourceGroup noSmithyDocumentSerde @@ -225,11 +227,19 @@ type ResourceGroup struct { ErrorMessage *string // 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 - // successfully. UPDATE_FAILED if the resource group could not update successfully. + // 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 successfully. + // + // UPDATE_FAILED if the resource group could not update successfully. State ResourceGroupState noSmithyDocumentSerde @@ -244,13 +254,13 @@ type ResourceInfo struct { // The name of the resource. Name *string - // Determines whether an application tag is applied or skipped. + // Determines whether an application tag is applied or skipped. Options []AssociationOption - // The details related to the resource. + // The details related to the resource. ResourceDetails *ResourceDetails - // Provides information about the Service Catalog App Registry resource type. + // Provides information about the Service Catalog App Registry resource type. ResourceType ResourceType noSmithyDocumentSerde @@ -268,26 +278,27 @@ type ResourceIntegrations struct { // The resource in a list of resources. type ResourcesListItem struct { - // The message returned if the call fails. + // The message returned if the call fails. ErrorMessage *string - // The Amazon resource name (ARN) of the resource. + // The Amazon resource name (ARN) of the resource. ResourceArn *string - // Provides information about the AppRegistry resource type. + // Provides information about the AppRegistry resource type. ResourceType *string - // The status of the list item. + // The status of the list item. Status *string 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 { - // Condition in the IAM policy that associates resources to an application. + // Condition in the IAM policy that associates resources to an application. TagKey *string noSmithyDocumentSerde diff --git a/service/servicediscovery/api_op_CreateHttpNamespace.go b/service/servicediscovery/api_op_CreateHttpNamespace.go index 62276d7b510..59996fb1a19 100644 --- a/service/servicediscovery/api_op_CreateHttpNamespace.go +++ b/service/servicediscovery/api_op_CreateHttpNamespace.go @@ -13,9 +13,12 @@ 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 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]in the Cloud Map Developer Guide. +// +// [Cloud Map quotas]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html func (c *Client) CreateHttpNamespace(ctx context.Context, params *CreateHttpNamespaceInput, optFns ...func(*Options)) (*CreateHttpNamespaceOutput, error) { if params == nil { params = &CreateHttpNamespaceInput{} @@ -58,8 +61,9 @@ 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]. + // + // [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 2a858752f30..ca39b1d8dbf 100644 --- a/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go +++ b/service/servicediscovery/api_op_CreatePrivateDnsNamespace.go @@ -18,8 +18,9 @@ import ( // 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. +// account, see [Cloud Map quotas]in the Cloud Map Developer Guide. +// +// [Cloud Map quotas]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html func (c *Client) CreatePrivateDnsNamespace(ctx context.Context, params *CreatePrivateDnsNamespaceInput, optFns ...func(*Options)) (*CreatePrivateDnsNamespaceOutput, error) { if params == nil { params = &CreatePrivateDnsNamespaceInput{} @@ -72,8 +73,9 @@ 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]. + // + // [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 1b51cc4bc23..514cf522602 100644 --- a/service/servicediscovery/api_op_CreatePublicDnsNamespace.go +++ b/service/servicediscovery/api_op_CreatePublicDnsNamespace.go @@ -17,9 +17,13 @@ import ( // 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]in the Cloud Map +// Developer Guide. +// +// The CreatePublicDnsNamespace API operation is not supported in the Amazon Web +// Services GovCloud (US) Regions. +// +// [Cloud Map quotas]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html func (c *Client) CreatePublicDnsNamespace(ctx context.Context, params *CreatePublicDnsNamespaceInput, optFns ...func(*Options)) (*CreatePublicDnsNamespaceOutput, error) { if params == nil { params = &CreatePublicDnsNamespaceInput{} @@ -37,8 +41,10 @@ func (c *Client) CreatePublicDnsNamespace(ctx context.Context, params *CreatePub type CreatePublicDnsNamespaceInput struct { - // The name that you want to assign to this namespace. Do not include sensitive - // information in the name. The name is publicly available using DNS queries. + // The name that you want to assign to this namespace. + // + // Do not include sensitive information in the name. The name is publicly + // available using DNS queries. // // This member is required. Name *string @@ -66,8 +72,9 @@ 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]. + // + // [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 eb69502e50f..64dbe623e6a 100644 --- a/service/servicediscovery/api_op_CreateService.go +++ b/service/servicediscovery/api_op_CreateService.go @@ -13,21 +13,31 @@ 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 // -// 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 -// quotas (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) -// in the Cloud Map Developer Guide. +// After you create the service, you can submit a [RegisterInstance] 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 quotas]in the Cloud Map Developer +// Guide. +// +// [Cloud Map quotas]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html +// [RegisterInstance]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -45,21 +55,32 @@ func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, 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. + // 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 : + // you're using a system that requires a specific SRV format, such as [HAProxy], 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. + // 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. + // + // [HAProxy]: http://www.haproxy.org/ // // This member is required. Name *string @@ -76,20 +97,26 @@ type CreateServiceInput struct { // you want Cloud Map to create when you register an instance. DnsConfig *types.DnsConfig - // Public DNS and HTTP namespaces only. A complex type that contains settings for + // 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 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/) - // . + // 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]. + // + // [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. + // // If you specify a health check configuration, you can specify either - // HealthCheckCustomConfig or HealthCheckConfig but not both. You can't add, - // update, or delete a HealthCheckCustomConfig configuration from an existing - // service. + // HealthCheckCustomConfig or HealthCheckConfig but not both. + // + // You can't add, update, or delete a HealthCheckCustomConfig configuration from + // an existing service. HealthCheckCustomConfig *types.HealthCheckCustomConfig // The ID of the namespace that you want to use to create the service. The diff --git a/service/servicediscovery/api_op_DeleteNamespace.go b/service/servicediscovery/api_op_DeleteNamespace.go index 4b4b04cef08..d2a3116ed2d 100644 --- a/service/servicediscovery/api_op_DeleteNamespace.go +++ b/service/servicediscovery/api_op_DeleteNamespace.go @@ -40,8 +40,9 @@ 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]. + // + // [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 9eb27dce562..9154926bba8 100644 --- a/service/servicediscovery/api_op_DeregisterInstance.go +++ b/service/servicediscovery/api_op_DeregisterInstance.go @@ -29,8 +29,9 @@ 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) - // request. + // The value that you specified for Id in the [RegisterInstance] request. + // + // [RegisterInstance]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html // // This member is required. InstanceId *string @@ -46,8 +47,9 @@ 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]. + // + // [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 d5f33c63c76..d0e3d91ef06 100644 --- a/service/servicediscovery/api_op_DiscoverInstances.go +++ b/service/servicediscovery/api_op_DiscoverInstances.go @@ -48,10 +48,17 @@ type DiscoverInstancesInput struct { // The health status of the instances that you want to discover. This parameter is // ignored for services that don't have a health check configured, and all - // instances are returned. HEALTHY Returns healthy instances. UNHEALTHY Returns - // unhealthy instances. ALL Returns all instances. HEALTHY_OR_ELSE_ALL Returns - // healthy instances, unless none are reporting a healthy state. In that case, - // return all instances. This is also called failing open. + // instances are returned. + // + // HEALTHY Returns healthy instances. + // + // UNHEALTHY Returns unhealthy instances. + // + // ALL Returns all instances. + // + // HEALTHY_OR_ELSE_ALL Returns healthy instances, unless none are reporting a + // healthy state. In that case, return all instances. This is also called failing + // open. HealthStatus types.HealthStatusFilter // The maximum number of instances that you want Cloud Map to return in the diff --git a/service/servicediscovery/api_op_GetInstancesHealthStatus.go b/service/servicediscovery/api_op_GetInstancesHealthStatus.go index 4a81953f8a5..d6f116cd569 100644 --- a/service/servicediscovery/api_op_GetInstancesHealthStatus.go +++ b/service/servicediscovery/api_op_GetInstancesHealthStatus.go @@ -12,9 +12,10 @@ import ( ) // 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. +// 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 { params = &GetInstancesHealthStatusInput{} @@ -38,11 +39,15 @@ 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 - // 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) - // request. + // 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]request. + // + // [ListInstances]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html Instances []string // The maximum number of instances that you want Cloud Map to return in the @@ -50,10 +55,11 @@ type GetInstancesHealthStatusInput struct { // for MaxResults , Cloud Map returns up to 100 instances. MaxResults *int32 - // For the first GetInstancesHealthStatus request, omit this value. If more than - // MaxResults instances match the specified criteria, you can submit another - // GetInstancesHealthStatus request to get the next group of results. Specify the - // value of NextToken from the previous response in the next request. + // For the first GetInstancesHealthStatus request, omit this value. + // + // If more than MaxResults instances match the specified criteria, you can submit + // another GetInstancesHealthStatus request to get the next group of results. + // Specify the value of NextToken from the previous response in the next request. NextToken *string noSmithyDocumentSerde diff --git a/service/servicediscovery/api_op_GetOperation.go b/service/servicediscovery/api_op_GetOperation.go index 1ad47e19f92..f72ef2a8140 100644 --- a/service/servicediscovery/api_op_GetOperation.go +++ b/service/servicediscovery/api_op_GetOperation.go @@ -12,9 +12,11 @@ import ( ) // Gets information about any operation that returns an operation ID in the -// response, such as a CreateHttpNamespace 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) -// . +// response, such as a CreateHttpNamespace request. +// +// To get a list of operations that match specified criteria, see [ListOperations]. +// +// [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 9b84c1b45bb..70655b88d42 100644 --- a/service/servicediscovery/api_op_ListInstances.go +++ b/service/servicediscovery/api_op_ListInstances.go @@ -40,10 +40,11 @@ type ListInstancesInput struct { // , Cloud Map returns up to 100 instances. MaxResults *int32 - // For the first ListInstances request, omit this value. If more than MaxResults - // instances match the specified criteria, you can submit another ListInstances - // request to get the next group of results. Specify the value of NextToken from - // the previous response in the next request. + // For the first ListInstances request, omit this value. + // + // If more than MaxResults instances match the specified criteria, you can submit + // another ListInstances request to get the next group of results. Specify the + // value of NextToken from the previous response in the next request. NextToken *string noSmithyDocumentSerde diff --git a/service/servicediscovery/api_op_ListNamespaces.go b/service/servicediscovery/api_op_ListNamespaces.go index 69b1650bff3..e62e03f69b3 100644 --- a/service/servicediscovery/api_op_ListNamespaces.go +++ b/service/servicediscovery/api_op_ListNamespaces.go @@ -31,8 +31,10 @@ func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput 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 . + // list. + // + // If you specify more than one filter, a namespace must match all filters to be + // returned by ListNamespaces . Filters []types.NamespaceFilter // The maximum number of namespaces that you want Cloud Map to return in the @@ -40,11 +42,14 @@ type ListNamespacesInput struct { // 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 - // 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 + // For the first ListNamespaces request, omit this value. + // + // 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 subsequent groups of // MaxResults namespaces do contain namespaces that match the criteria. NextToken *string @@ -60,11 +65,12 @@ type ListNamespacesOutput struct { // 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 - // subsequent groups of MaxResults namespaces do contain namespaces that match the - // criteria. + // 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 subsequent groups of + // MaxResults namespaces do contain namespaces that match the criteria. NextToken *string // Metadata pertaining to the operation's result. diff --git a/service/servicediscovery/api_op_ListOperations.go b/service/servicediscovery/api_op_ListOperations.go index d915bacff8a..6a153bb61e9 100644 --- a/service/servicediscovery/api_op_ListOperations.go +++ b/service/servicediscovery/api_op_ListOperations.go @@ -31,8 +31,10 @@ 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 . + // and end date. + // + // If you specify more than one filter, an operation must match all filters to be + // returned by ListOperations . Filters []types.OperationFilter // The maximum number of items that you want Cloud Map to return in the response @@ -40,11 +42,14 @@ type ListOperationsInput struct { // 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 - // 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 + // For the first ListOperations request, omit this value. + // + // 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 subsequent groups of // MaxResults operations do contain operations that match the criteria. NextToken *string @@ -56,11 +61,12 @@ 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 - // 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 - // subsequent groups of MaxResults operations do contain operations that match the - // criteria. + // 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 subsequent groups of + // MaxResults operations do contain operations that match the criteria. NextToken *string // Summary information about the operations that match the specified criteria. diff --git a/service/servicediscovery/api_op_ListServices.go b/service/servicediscovery/api_op_ListServices.go index cadbcbba551..b84322ec90f 100644 --- a/service/servicediscovery/api_op_ListServices.go +++ b/service/servicediscovery/api_op_ListServices.go @@ -31,8 +31,10 @@ func (c *Client) ListServices(ctx context.Context, params *ListServicesInput, op 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 . + // list services for. + // + // If you specify more than one filter, an operation must match all filters to be + // returned by ListServices . Filters []types.ServiceFilter // The maximum number of services that you want Cloud Map to return in the @@ -40,12 +42,15 @@ type ListServicesInput struct { // , 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 + // 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 *string @@ -56,11 +61,12 @@ type ListServicesOutput struct { // 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. + // 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 // An array that contains one ServiceSummary object for each service that matches diff --git a/service/servicediscovery/api_op_RegisterInstance.go b/service/servicediscovery/api_op_RegisterInstance.go index 1f9cb09c396..4b049b7a16b 100644 --- a/service/servicediscovery/api_op_RegisterInstance.go +++ b/service/servicediscovery/api_op_RegisterInstance.go @@ -13,27 +13,38 @@ 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. // // 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 +// request and specify the same service ID and instance ID. +// +// For more information, see [CreateService]. +// +// 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 // // 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. +// the same namespace and using the same service, see [Cloud Map quotas]in the Cloud Map Developer +// Guide. +// +// [CreateService]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html +// [Cloud Map quotas]: https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html func (c *Client) RegisterInstance(ctx context.Context, params *RegisterInstanceInput, optFns ...func(*Options)) (*RegisterInstanceOutput, error) { if params == nil { params = &RegisterInstanceInput{} @@ -53,83 +64,122 @@ 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. The following are the supported attribute - // keys. 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: + // discoverable by public DNS queries. + // + // The following are the supported attribute keys. + // + // 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]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. + // // - Cloud Map 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. + // // - The AWS_ALIAS_DNS_NAME is not supported in the GovCloud (US) Regions. - // AWS_EC2_INSTANCE_ID HTTP namespaces only. The Amazon EC2 instance ID for the + // + // 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 ). + // 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 ). 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. + // 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. + // + // [AliasTarget]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html // // 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) - // . + // for the SRV record. For more information, see [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. + // 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. // + // [DnsRecord > Type]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type + // // This member is required. InstanceId *string @@ -152,8 +202,9 @@ 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]. + // + // [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 47979754e07..2e6d7cb8f46 100644 --- a/service/servicediscovery/api_op_UpdateHttpNamespace.go +++ b/service/servicediscovery/api_op_UpdateHttpNamespace.go @@ -51,8 +51,9 @@ 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]. + // + // [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 95d5391bb10..8ed4b2440cc 100644 --- a/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go +++ b/service/servicediscovery/api_op_UpdateInstanceCustomHealthStatus.go @@ -12,12 +12,16 @@ 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 -// 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) -// . +// 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]. +// +// [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{} diff --git a/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go b/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go index a0da7e9f056..050873a4038 100644 --- a/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go +++ b/service/servicediscovery/api_op_UpdatePrivateDnsNamespace.go @@ -51,8 +51,9 @@ 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]. + // + // [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 d40dc8099c2..ed31c9c9610 100644 --- a/service/servicediscovery/api_op_UpdatePublicDnsNamespace.go +++ b/service/servicediscovery/api_op_UpdatePublicDnsNamespace.go @@ -51,8 +51,9 @@ 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]. + // + // [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 355c3738750..f5dcaf0fb0c 100644 --- a/service/servicediscovery/api_op_UpdateService.go +++ b/service/servicediscovery/api_op_UpdateService.go @@ -12,13 +12,18 @@ 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. +// +// - 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. // @@ -58,8 +63,9 @@ 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]. + // + // [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/doc.go b/service/servicediscovery/doc.go index c9fede00800..ed0353ce705 100644 --- a/service/servicediscovery/doc.go +++ b/service/servicediscovery/doc.go @@ -3,11 +3,13 @@ // Package servicediscovery provides the API client, operations, and parameter // types for AWS Cloud Map. // -// Cloud Map With Cloud Map, you can configure public DNS, private DNS, or HTTP -// namespaces that your microservice applications run in. When an instance becomes -// available, you can call the Cloud Map API to register the instance with Cloud -// Map. For public or private DNS namespaces, Cloud Map automatically creates DNS -// records and an optional health check. Clients that submit public or private DNS -// queries, or HTTP requests, for the service receive an answer that contains up to -// eight healthy records. +// # Cloud Map +// +// With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces +// that your microservice applications run in. When an instance becomes available, +// you can call the Cloud Map API to register the instance with Cloud Map. For +// public or private DNS namespaces, Cloud Map automatically creates DNS records +// and an optional health check. Clients that submit public or private DNS queries, +// or HTTP requests, for the service receive an answer that contains up to eight +// healthy records. package servicediscovery diff --git a/service/servicediscovery/options.go b/service/servicediscovery/options.go index 340a4980aa2..ec6b1919dc9 100644 --- a/service/servicediscovery/options.go +++ b/service/servicediscovery/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/servicediscovery/types/enums.go b/service/servicediscovery/types/enums.go index b121366530d..f59925e2a22 100644 --- a/service/servicediscovery/types/enums.go +++ b/service/servicediscovery/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for CustomHealthStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomHealthStatus) Values() []CustomHealthStatus { return []CustomHealthStatus{ "HEALTHY", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for FilterCondition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterCondition) Values() []FilterCondition { return []FilterCondition{ "EQ", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for HealthCheckType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthCheckType) Values() []HealthCheckType { return []HealthCheckType{ "HTTP", @@ -72,8 +75,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for HealthStatusFilter. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HealthStatusFilter) Values() []HealthStatusFilter { return []HealthStatusFilter{ "HEALTHY", @@ -114,8 +119,9 @@ const ( ) // Values returns all known values for NamespaceFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceFilterName) Values() []NamespaceFilterName { return []NamespaceFilterName{ "TYPE", @@ -134,8 +140,9 @@ const ( ) // Values returns all known values for NamespaceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NamespaceType) Values() []NamespaceType { return []NamespaceType{ "DNS_PUBLIC", @@ -156,8 +163,9 @@ const ( ) // Values returns all known values for OperationFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationFilterName) Values() []OperationFilterName { return []OperationFilterName{ "NAMESPACE_ID", @@ -179,8 +187,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "SUBMITTED", @@ -200,8 +209,9 @@ const ( ) // Values returns all known values for OperationTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationTargetType) Values() []OperationTargetType { return []OperationTargetType{ "NAMESPACE", @@ -223,8 +233,9 @@ const ( ) // Values returns all known values for OperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationType) Values() []OperationType { return []OperationType{ "CREATE_NAMESPACE", @@ -247,8 +258,9 @@ const ( ) // Values returns all known values for RecordType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordType) Values() []RecordType { return []RecordType{ "SRV", @@ -267,8 +279,9 @@ const ( ) // Values returns all known values for RoutingPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoutingPolicy) Values() []RoutingPolicy { return []RoutingPolicy{ "MULTIVALUE", @@ -284,8 +297,9 @@ const ( ) // Values returns all known values for ServiceFilterName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceFilterName) Values() []ServiceFilterName { return []ServiceFilterName{ "NAMESPACE_ID", @@ -302,8 +316,9 @@ const ( ) // Values returns all known values for ServiceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceType) Values() []ServiceType { return []ServiceType{ "HTTP", @@ -320,8 +335,9 @@ const ( ) // Values returns all known values for ServiceTypeOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceTypeOption) Values() []ServiceTypeOption { return []ServiceTypeOption{ "HTTP", diff --git a/service/servicediscovery/types/errors.go b/service/servicediscovery/types/errors.go index a7a922266c4..faeb64dd981 100644 --- a/service/servicediscovery/types/errors.go +++ b/service/servicediscovery/types/errors.go @@ -199,9 +199,9 @@ 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. +// number of requests. For more information, see [Cloud Map API request throttling quota]in the Cloud Map Developer Guide. +// +// [Cloud Map API request throttling quota]: https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html type RequestLimitExceeded struct { Message *string diff --git a/service/servicediscovery/types/types.go b/service/servicediscovery/types/types.go index 018f7fefa74..f0921d6ceee 100644 --- a/service/servicediscovery/types/types.go +++ b/service/servicediscovery/types/types.go @@ -8,9 +8,10 @@ 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 . +// 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 . type DnsConfig struct { // An array that contains one DnsRecord object for each Route 53 DNS record that @@ -19,40 +20,59 @@ 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] instead. + // + // The ID of the namespace to use for DNS configuration. + // + // [Service]: https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html // // 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: + // 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) - // 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 - // 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) - // in the Route 53 Developer Guide. + // 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] 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 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] in the Route 53 + // Developer Guide. + // + // [Weighted Routing]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted + // [Multivalue Answer Routing]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue RoutingPolicy RoutingPolicy noSmithyDocumentSerde @@ -90,13 +110,15 @@ type DnsProperties struct { 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 - // records. + // 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] 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. + // + // [RegisterInstance]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html // // This member is required. TTL *int64 @@ -104,50 +126,82 @@ 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 - // 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: + // 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]. + // + // 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) - // . + // register an instance. For more information, see [Attributes]in the topic [RegisterInstance]. + // // - 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: + // 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. + // AWS_INSTANCE_PORT attribute when you submit a [RegisterInstance]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 + // + // - 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. + // HAProxy, see the [Name]element in the documentation about CreateService for + // information about how to specify the correct name format. + // + // [Attributes]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes + // [RegisterInstance]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html + // [Name]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name // // This member is required. Type RecordType @@ -155,69 +209,95 @@ type DnsRecord struct { noSmithyDocumentSerde } -// Public DNS and HTTP namespaces only. A complex type that contains settings for +// 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 -// 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 +// 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]. +// +// 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]. +// +// 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) -// . +// information, see [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/) -// . +// health checks, see [Amazon Route 53 Pricing]. +// +// [Regions]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions +// [Amazon Route 53 Pricing]: http://aws.amazon.com/route53/pricing/ +// [EvaluateTargetHealth]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth 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: + // 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) - // in the Route 53 Developer Guide. + // 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] in the Route 53 Developer Guide. + // + // [How Route 53 Determines Whether an Endpoint Is Healthy]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html // // This member is required. Type HealthCheckType // 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) - // in the Route 53 Developer Guide. + // or the other way around. For more information, see [How Route 53 Determines Whether an Endpoint Is Healthy]in the Route 53 Developer + // Guide. + // + // [How Route 53 Determines Whether an Endpoint Is Healthy]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html FailureThreshold *int32 // The path that you want Route 53 to request when performing health checks. The @@ -225,8 +305,9 @@ type HealthCheckConfig struct { // 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 . + // is / . + // + // If you specify TCP for Type , you must not specify a value for ResourcePath . ResourcePath *string noSmithyDocumentSerde @@ -236,28 +317,41 @@ 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. // // 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: +// 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. +// 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. @@ -265,13 +359,15 @@ type HealthCheckCustomConfig struct { // This parameter is no longer supported and is always set to 1. Cloud Map waits // for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus - // request before changing the status of the service instance. The number of - // 30-second intervals that you want Cloud Map to wait after receiving an - // 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. + // request before changing the status of the service instance. + // + // The number of 30-second intervals that you want Cloud Map to wait after + // receiving an 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. // // Deprecated: Configurable FailureThreshold of HealthCheckCustomConfig is // deprecated. It will always have value 1. @@ -280,9 +376,10 @@ type HealthCheckCustomConfig struct { noSmithyDocumentSerde } -// 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. +// In a response to a [DiscoverInstances] request, HttpInstanceSummary contains information about one +// instance that matches the values that you specified in the request. +// +// [DiscoverInstances]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html type HttpInstanceSummary struct { // If you included any attributes when you registered the instance, the values of @@ -331,70 +428,106 @@ type HttpProperties struct { 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) - // . + // for the SRV record. For more information, see [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. + // 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. + // + // [DnsRecord > Type]: https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type // // 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) - // in the Route 53 API Reference. Note the following: + // 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]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 + // + // 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 + // 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 ). + // 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 ). 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. + // 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. + // + // [AliasTarget->DNSName]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName Attributes map[string]string // A unique string that identifies the request and that allows failed @@ -413,27 +546,38 @@ type Instance struct { 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 - // 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. + // + // 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. Attributes map[string]string // The ID for an instance that you created by using a specified service. @@ -476,9 +620,14 @@ type Namespace struct { ServiceCount *int32 // The type of the namespace. The methods for discovering instances depends on the - // value that you specify: HTTP Instances can be discovered only programmatically, - // using the Cloud Map DiscoverInstances API. DNS_PUBLIC Instances can be - // discovered using public DNS queries and using the DiscoverInstances API. + // value that you specify: + // + // HTTP Instances can be discovered only programmatically, using the Cloud Map + // DiscoverInstances API. + // + // DNS_PUBLIC Instances can be discovered using public DNS queries and using the + // DiscoverInstances API. + // // DNS_PRIVATE Instances can be discovered using DNS queries in VPCs and using the // DiscoverInstances API. Type NamespaceType @@ -491,16 +640,22 @@ 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. // // 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 . // @@ -510,9 +665,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 . Condition FilterCondition @@ -576,12 +733,19 @@ type Operation struct { // 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 ErrorCode *string @@ -591,16 +755,25 @@ type Operation struct { // 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 - // The namespace ID is returned in the ResourceId property. SERVICE The service ID - // is returned in the ResourceId property. INSTANCE The instance ID is returned in - // the ResourceId property. + // The name of the target entity that's associated with the operation: + // + // NAMESPACE The namespace ID is returned in the ResourceId property. + // + // SERVICE The service ID is returned in the ResourceId property. + // + // INSTANCE The instance ID is returned in the ResourceId property. Targets map[string]string // The name of the operation that's associated with the specified ID. @@ -619,11 +792,16 @@ 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. // @@ -631,13 +809,18 @@ type OperationFilter struct { 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. // @@ -646,12 +829,15 @@ type OperationFilter struct { // 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 . @@ -661,18 +847,22 @@ type OperationFilter struct { } // 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) -// request. +// criteria that you specified in a [ListOperations]request. +// +// [ListOperations]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html type OperationSummary struct { // The ID for an operation. Id *string // The status of the operation. Values include the following: - // - SUBMITTED: This is the initial state immediately after you submit a - // request. + // + // - 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 @@ -817,19 +1007,23 @@ type Service struct { 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 . + // 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 + // 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]. + // + // [Amazon Route 53 Pricing]: http://aws.amazon.com/route53/pricing/ HealthCheckConfig *HealthCheckConfig // A complex type that contains information about an optional custom health check. + // // If you specify a health check configuration, you can specify either // HealthCheckCustomConfig or HealthCheckConfig but not both. HealthCheckCustomConfig *HealthCheckCustomConfig @@ -850,9 +1044,14 @@ type Service struct { NamespaceId *string // Describes the systems that can be used to discover the service instances. - // DNS_HTTP The service instances can be discovered using either DNS queries or the - // DiscoverInstances API operation. HTTP The service instances can only be - // discovered using the DiscoverInstances API operation. DNS Reserved. + // + // DNS_HTTP The service instances can be discovered using either DNS queries or + // the DiscoverInstances API operation. + // + // HTTP The service instances can only be discovered using the DiscoverInstances + // API operation. + // + // DNS Reserved. Type ServiceType noSmithyDocumentSerde @@ -868,7 +1067,7 @@ type ServiceChange struct { // when you register an instance. DnsConfig *DnsConfigChange - // Public DNS and HTTP namespaces only. Settings for an optional health check. If + // 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 . HealthCheckConfig *HealthCheckConfig @@ -893,6 +1092,7 @@ type ServiceFilter struct { // 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. Condition FilterCondition @@ -917,7 +1117,7 @@ type ServiceSummary struct { // when you register an instance. DnsConfig *DnsConfig - // Public DNS and HTTP namespaces only. Settings for an optional health check. If + // 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 . HealthCheckConfig *HealthCheckConfig @@ -925,12 +1125,15 @@ type ServiceSummary struct { // 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. HealthCheckCustomConfig *HealthCheckCustomConfig @@ -948,9 +1151,14 @@ type ServiceSummary struct { Name *string // Describes the systems that can be used to discover the service instances. - // DNS_HTTP The service instances can be discovered using either DNS queries or the - // DiscoverInstances API operation. HTTP The service instances can only be - // discovered using the DiscoverInstances API operation. DNS Reserved. + // + // DNS_HTTP The service instances can be discovered using either DNS queries or + // the DiscoverInstances API operation. + // + // HTTP The service instances can only be discovered using the DiscoverInstances + // API operation. + // + // DNS Reserved. Type ServiceType noSmithyDocumentSerde diff --git a/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go b/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go index 2fa335d1228..4bc4f93068f 100644 --- a/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go +++ b/service/servicequotas/api_op_DeleteServiceQuotaIncreaseRequestFromTemplate.go @@ -35,14 +35,14 @@ type DeleteServiceQuotaIncreaseRequestFromTemplateInput struct { AwsRegion *string // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string diff --git a/service/servicequotas/api_op_GetAWSDefaultServiceQuota.go b/service/servicequotas/api_op_GetAWSDefaultServiceQuota.go index 9ab690de987..7a7f17dadab 100644 --- a/service/servicequotas/api_op_GetAWSDefaultServiceQuota.go +++ b/service/servicequotas/api_op_GetAWSDefaultServiceQuota.go @@ -31,14 +31,14 @@ func (c *Client) GetAWSDefaultServiceQuota(ctx context.Context, params *GetAWSDe type GetAWSDefaultServiceQuotaInput struct { // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string diff --git a/service/servicequotas/api_op_GetServiceQuota.go b/service/servicequotas/api_op_GetServiceQuota.go index c81b03f5fa7..bdde93bde81 100644 --- a/service/servicequotas/api_op_GetServiceQuota.go +++ b/service/servicequotas/api_op_GetServiceQuota.go @@ -32,14 +32,14 @@ func (c *Client) GetServiceQuota(ctx context.Context, params *GetServiceQuotaInp type GetServiceQuotaInput struct { // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string diff --git a/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go b/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go index 01acce5364e..f3f0a3fc71a 100644 --- a/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go +++ b/service/servicequotas/api_op_GetServiceQuotaIncreaseRequestFromTemplate.go @@ -36,14 +36,14 @@ type GetServiceQuotaIncreaseRequestFromTemplateInput struct { AwsRegion *string // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string diff --git a/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go b/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go index baae5b989a1..6ac5fe6800a 100644 --- a/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go +++ b/service/servicequotas/api_op_ListAWSDefaultServiceQuotas.go @@ -31,7 +31,7 @@ func (c *Client) ListAWSDefaultServiceQuotas(ctx context.Context, params *ListAW type ListAWSDefaultServiceQuotasInput struct { // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string @@ -41,10 +41,11 @@ type ListAWSDefaultServiceQuotasInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Specifies a value for receiving additional results after you receive a NextToken @@ -168,10 +169,11 @@ type ListAWSDefaultServiceQuotasPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go index 66765759c87..3c9cfb36056 100644 --- a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go +++ b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistory.go @@ -34,10 +34,11 @@ type ListRequestedServiceQuotaChangeHistoryInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Specifies a value for receiving additional results after you receive a NextToken @@ -51,7 +52,7 @@ type ListRequestedServiceQuotaChangeHistoryInput struct { QuotaRequestedAtLevel types.AppliedLevelEnum // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. ServiceCode *string // Specifies that you want to filter the results to only the requests with the @@ -170,10 +171,11 @@ type ListRequestedServiceQuotaChangeHistoryPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go index bb0cfe2236c..86e6c752986 100644 --- a/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go +++ b/service/servicequotas/api_op_ListRequestedServiceQuotaChangeHistoryByQuota.go @@ -30,14 +30,14 @@ func (c *Client) ListRequestedServiceQuotaChangeHistoryByQuota(ctx context.Conte type ListRequestedServiceQuotaChangeHistoryByQuotaInput struct { // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string @@ -47,10 +47,11 @@ type ListRequestedServiceQuotaChangeHistoryByQuotaInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Specifies a value for receiving additional results after you receive a NextToken @@ -182,10 +183,11 @@ type ListRequestedServiceQuotaChangeHistoryByQuotaPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go b/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go index 03c3c097339..3f46cfe784e 100644 --- a/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go +++ b/service/servicequotas/api_op_ListServiceQuotaIncreaseRequestsInTemplate.go @@ -37,10 +37,11 @@ type ListServiceQuotaIncreaseRequestsInTemplateInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Specifies a value for receiving additional results after you receive a NextToken @@ -50,7 +51,7 @@ type ListServiceQuotaIncreaseRequestsInTemplateInput struct { NextToken *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. ServiceCode *string noSmithyDocumentSerde @@ -165,10 +166,11 @@ type ListServiceQuotaIncreaseRequestsInTemplatePaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicequotas/api_op_ListServiceQuotas.go b/service/servicequotas/api_op_ListServiceQuotas.go index 7f0f003df01..bafed03ce1f 100644 --- a/service/servicequotas/api_op_ListServiceQuotas.go +++ b/service/servicequotas/api_op_ListServiceQuotas.go @@ -32,7 +32,7 @@ func (c *Client) ListServiceQuotas(ctx context.Context, params *ListServiceQuota type ListServiceQuotasInput struct { // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string @@ -42,10 +42,11 @@ type ListServiceQuotasInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Specifies a value for receiving additional results after you receive a NextToken @@ -58,8 +59,8 @@ type ListServiceQuotasInput struct { QuotaAppliedAtLevel types.AppliedLevelEnum // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. QuotaCode *string noSmithyDocumentSerde @@ -176,10 +177,11 @@ type ListServiceQuotasPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicequotas/api_op_ListServices.go b/service/servicequotas/api_op_ListServices.go index f9372531b5b..3cfdda7003e 100644 --- a/service/servicequotas/api_op_ListServices.go +++ b/service/servicequotas/api_op_ListServices.go @@ -35,10 +35,11 @@ type ListServicesInput struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Specifies a value for receiving additional results after you receive a NextToken @@ -157,10 +158,11 @@ type ListServicesPaginatorOptions struct { // 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 - // available. You should check NextToken after every operation to ensure that you - // receive all of the results. + // 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 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/servicequotas/api_op_ListTagsForResource.go b/service/servicequotas/api_op_ListTagsForResource.go index f34a3d1ebf2..1fa2dd5ab60 100644 --- a/service/servicequotas/api_op_ListTagsForResource.go +++ b/service/servicequotas/api_op_ListTagsForResource.go @@ -31,9 +31,11 @@ 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) - // CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) - // Amazon Web Services API operation. + // listing the quotas using the [list-service-quotas]CLI command or the [ListServiceQuotas] Amazon Web Services API + // operation. + // + // [list-service-quotas]: https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html + // [ListServiceQuotas]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html // // This member is required. ResourceARN *string diff --git a/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go b/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go index ea31967a49a..96990643bdc 100644 --- a/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go +++ b/service/servicequotas/api_op_PutServiceQuotaIncreaseRequestIntoTemplate.go @@ -40,14 +40,14 @@ type PutServiceQuotaIncreaseRequestIntoTemplateInput struct { DesiredValue *float64 // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string diff --git a/service/servicequotas/api_op_RequestServiceQuotaIncrease.go b/service/servicequotas/api_op_RequestServiceQuotaIncrease.go index 60356dacd6b..bcfc1b0faeb 100644 --- a/service/servicequotas/api_op_RequestServiceQuotaIncrease.go +++ b/service/servicequotas/api_op_RequestServiceQuotaIncrease.go @@ -35,14 +35,14 @@ type RequestServiceQuotaIncreaseInput struct { DesiredValue *float64 // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. // // This member is required. QuotaCode *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. // // This member is required. ServiceCode *string diff --git a/service/servicequotas/api_op_TagResource.go b/service/servicequotas/api_op_TagResource.go index a6e76fa6d59..674052fa359 100644 --- a/service/servicequotas/api_op_TagResource.go +++ b/service/servicequotas/api_op_TagResource.go @@ -32,9 +32,10 @@ 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) - // CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) - // Amazon Web Services API operation. + // the [list-service-quotas]CLI command or the [ListServiceQuotas] Amazon Web Services API operation. + // + // [list-service-quotas]: https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html + // [ListServiceQuotas]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html // // This member is required. ResourceARN *string diff --git a/service/servicequotas/api_op_UntagResource.go b/service/servicequotas/api_op_UntagResource.go index 4deba13d338..61caa083f90 100644 --- a/service/servicequotas/api_op_UntagResource.go +++ b/service/servicequotas/api_op_UntagResource.go @@ -31,9 +31,10 @@ 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) - // CLI command or the ListServiceQuotas (https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html) - // Amazon Web Services API operation. + // the quotas using the [list-service-quotas]CLI command or the [ListServiceQuotas] Amazon Web Services API operation. + // + // [list-service-quotas]: https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html + // [ListServiceQuotas]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html // // This member is required. ResourceARN *string diff --git a/service/servicequotas/doc.go b/service/servicequotas/doc.go index c9eab45a7c2..4af72d35d6a 100644 --- a/service/servicequotas/doc.go +++ b/service/servicequotas/doc.go @@ -6,6 +6,7 @@ // With Service Quotas, you can view and manage your quotas easily as your Amazon // Web Services workloads grow. Quotas, also referred to as limits, are the maximum // number of resources that you can create in your Amazon Web Services account. For -// more information, see the Service Quotas User Guide (https://docs.aws.amazon.com/servicequotas/latest/userguide/) -// . +// more information, see the [Service Quotas User Guide]. +// +// [Service Quotas User Guide]: https://docs.aws.amazon.com/servicequotas/latest/userguide/ package servicequotas diff --git a/service/servicequotas/options.go b/service/servicequotas/options.go index fb84fcd2073..962566ea6a7 100644 --- a/service/servicequotas/options.go +++ b/service/servicequotas/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/servicequotas/types/enums.go b/service/servicequotas/types/enums.go index 08a2e3905ec..acfc00e3757 100644 --- a/service/servicequotas/types/enums.go +++ b/service/servicequotas/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for AppliedLevelEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppliedLevelEnum) Values() []AppliedLevelEnum { return []AppliedLevelEnum{ "ACCOUNT", @@ -33,8 +34,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for PeriodUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PeriodUnit) Values() []PeriodUnit { return []PeriodUnit{ "MICROSECOND", @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for QuotaContextScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuotaContextScope) Values() []QuotaContextScope { return []QuotaContextScope{ "RESOURCE", @@ -104,8 +108,9 @@ const ( ) // Values returns all known values for RequestStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestStatus) Values() []RequestStatus { return []RequestStatus{ "PENDING", @@ -128,8 +133,9 @@ const ( // Values returns all known values for ServiceQuotaTemplateAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceQuotaTemplateAssociationStatus) Values() []ServiceQuotaTemplateAssociationStatus { return []ServiceQuotaTemplateAssociationStatus{ "ASSOCIATED", diff --git a/service/servicequotas/types/errors.go b/service/servicequotas/types/errors.go index 7994122d532..a344bd118d0 100644 --- a/service/servicequotas/types/errors.go +++ b/service/servicequotas/types/errors.go @@ -438,8 +438,9 @@ 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) -// in the Service Quotas User Guide. +// information, see [Tag restrictions]in the Service Quotas User Guide. +// +// [Tag restrictions]: https://docs.aws.amazon.com/servicequotas/latest/userguide/sq-tagging.html#sq-tagging-restrictions type TooManyTagsException struct { Message *string diff --git a/service/servicequotas/types/types.go b/service/servicequotas/types/types.go index a8ef242f761..95d06cf923e 100644 --- a/service/servicequotas/types/types.go +++ b/service/servicequotas/types/types.go @@ -11,12 +11,16 @@ 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 Amazon Web Service or quota. + // // - DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service // Quotas. + // // - DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available. + // // - SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas. ErrorCode ErrorCode @@ -103,8 +107,8 @@ type RequestedServiceQuotaChange struct { QuotaArn *string // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. QuotaCode *string // The context for this service quota. @@ -121,7 +125,7 @@ type RequestedServiceQuotaChange struct { Requester *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. ServiceCode *string // Specifies the service name. @@ -140,7 +144,7 @@ type RequestedServiceQuotaChange struct { type ServiceInfo struct { // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. ServiceCode *string // Specifies the service name. @@ -171,8 +175,8 @@ type ServiceQuota struct { QuotaArn *string // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. QuotaCode *string // The context for this service quota. @@ -182,7 +186,7 @@ type ServiceQuota struct { QuotaName *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. ServiceCode *string // Specifies the service name. @@ -213,15 +217,15 @@ type ServiceQuotaIncreaseRequestInTemplate struct { GlobalQuota bool // Specifies the quota identifier. To find the quota code for a specific quota, - // use the ListServiceQuotas operation, and look for the QuotaCode response in the - // output for the quota you want. + // use the ListServiceQuotasoperation, and look for the QuotaCode response in the output for the + // quota you want. QuotaCode *string // Specifies the quota name. QuotaName *string // Specifies the service identifier. To find the service code value for an Amazon - // Web Services service, use the ListServices operation. + // Web Services service, use the ListServicesoperation. ServiceCode *string // Specifies the service name. diff --git a/service/ses/api_op_CloneReceiptRuleSet.go b/service/ses/api_op_CloneReceiptRuleSet.go index e98b38c571b..0c1b681d4e6 100644 --- a/service/ses/api_op_CloneReceiptRuleSet.go +++ b/service/ses/api_op_CloneReceiptRuleSet.go @@ -12,9 +12,13 @@ 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/dg/receiving-email-concepts.html#receiving-email-concepts-rules) -// . You can execute this operation no more than once per second. +// independent of the source rule set. +// +// For information about setting up rule sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules func (c *Client) CloneReceiptRuleSet(ctx context.Context, params *CloneReceiptRuleSetInput, optFns ...func(*Options)) (*CloneReceiptRuleSetOutput, error) { if params == nil { params = &CloneReceiptRuleSetInput{} @@ -32,8 +36,9 @@ 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/dg/receiving-email-concepts.html) -// . +// information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type CloneReceiptRuleSetInput struct { // The name of the rule set to clone. @@ -43,9 +48,12 @@ type CloneReceiptRuleSetInput struct { // The name of the rule set to create. The name must meet the following // requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Start and end with a letter or number. + // // - Contain 64 characters or fewer. // // This member is required. diff --git a/service/ses/api_op_CreateConfigurationSet.go b/service/ses/api_op_CreateConfigurationSet.go index 77e4fcc5089..9add9298b72 100644 --- a/service/ses/api_op_CreateConfigurationSet.go +++ b/service/ses/api_op_CreateConfigurationSet.go @@ -11,10 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/dg/monitor-sending-activity.html) -// . You can execute this operation no more than once per second. +// 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) CreateConfigurationSet(ctx context.Context, params *CreateConfigurationSetInput, optFns ...func(*Options)) (*CreateConfigurationSetOutput, error) { if params == nil { params = &CreateConfigurationSetInput{} @@ -32,8 +36,9 @@ 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/dg/monitor-sending-activity.html) -// . +// sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 28f6c8d776d..d375800e161 100644 --- a/service/ses/api_op_CreateConfigurationSetEventDestination.go +++ b/service/ses/api_op_CreateConfigurationSetEventDestination.go @@ -11,14 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a configuration set event destination. When you create or update an -// event destination, you must provide one, and only one, destination. The -// destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple -// Notification Service (Amazon SNS). An event destination is the Amazon Web -// Services 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/dg/monitor-sending-activity.html) -// . You can execute this operation no more than once per second. +// Creates a configuration set event destination. +// +// When you create or update an event destination, you must provide one, and only +// one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or +// Amazon Simple Notification Service (Amazon SNS). +// +// An event destination is the Amazon Web Services 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, params *CreateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*CreateConfigurationSetEventDestinationOutput, error) { if params == nil { params = &CreateConfigurationSetEventDestinationInput{} @@ -38,9 +43,9 @@ func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, par // configuration set event destination, which can be either Amazon CloudWatch or // Amazon Kinesis Firehose, describes an Amazon Web Services 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/dg/monitor-sending-activity.html) -// . +// set. For information about using configuration sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 18696d28d13..dc7a51daaf7 100644 --- a/service/ses/api_op_CreateConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_CreateConfigurationSetTrackingOptions.go @@ -12,11 +12,13 @@ import ( ) // Creates 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/dg/configure-custom-open-click-domains.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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{} @@ -44,9 +46,11 @@ 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/dg/configure-custom-open-click-domains.html) - // in the Amazon SES Developer Guide. + // emails. + // + // For more information, see [Configuring Custom Domains to Handle Open and Click Tracking] in the Amazon SES Developer Guide. + // + // [Configuring Custom Domains to Handle Open and Click Tracking]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html // // This member is required. TrackingOptions *types.TrackingOptions diff --git a/service/ses/api_op_CreateCustomVerificationEmailTemplate.go b/service/ses/api_op_CreateCustomVerificationEmailTemplate.go index 126a6956932..e0b366dbe0e 100644 --- a/service/ses/api_op_CreateCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_CreateCustomVerificationEmailTemplate.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// Creates a new custom verification email template. +// +// For more information about custom verification email templates, see [Using Custom Verification Email Templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, params *CreateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*CreateCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &CreateCustomVerificationEmailTemplateInput{} @@ -52,8 +55,9 @@ 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) - // in the Amazon SES Developer Guide. + // For more information, see [Custom Verification Email Frequently Asked Questions]in the Amazon SES Developer Guide. + // + // [Custom Verification Email Frequently Asked Questions]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom // // This member is required. TemplateContent *string diff --git a/service/ses/api_op_CreateReceiptFilter.go b/service/ses/api_op_CreateReceiptFilter.go index 9cfa1cb6271..b46dbe5a7b3 100644 --- a/service/ses/api_op_CreateReceiptFilter.go +++ b/service/ses/api_op_CreateReceiptFilter.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/dg/receiving-email-ip-filtering-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// Creates a new IP address filter. +// +// For information about setting up IP address filters, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html func (c *Client) CreateReceiptFilter(ctx context.Context, params *CreateReceiptFilterInput, optFns ...func(*Options)) (*CreateReceiptFilterOutput, error) { if params == nil { params = &CreateReceiptFilterInput{} @@ -30,9 +34,9 @@ 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/dg/receiving-email-concepts.html) -// . +// filters when you receive email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 cd721688219..baba7102547 100644 --- a/service/ses/api_op_CreateReceiptRule.go +++ b/service/ses/api_op_CreateReceiptRule.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a receipt rule. For information about setting up receipt rules, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// Creates a receipt rule. +// +// For information about setting up receipt rules, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) CreateReceiptRule(ctx context.Context, params *CreateReceiptRuleInput, optFns ...func(*Options)) (*CreateReceiptRuleOutput, error) { if params == nil { params = &CreateReceiptRuleInput{} @@ -30,8 +34,9 @@ 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/dg/receiving-email-concepts.html) -// . +// email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 4aab32d76a9..e7ee77882d5 100644 --- a/service/ses/api_op_CreateReceiptRuleSet.go +++ b/service/ses/api_op_CreateReceiptRuleSet.go @@ -10,9 +10,13 @@ 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/dg/receiving-email-concepts.html#receiving-email-concepts-rules) -// . 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules func (c *Client) CreateReceiptRuleSet(ctx context.Context, params *CreateReceiptRuleSetInput, optFns ...func(*Options)) (*CreateReceiptRuleSetOutput, error) { if params == nil { params = &CreateReceiptRuleSetInput{} @@ -29,16 +33,19 @@ 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/dg/receiving-email-concepts.html) -// . +// sets to receive email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type CreateReceiptRuleSetInput struct { // The name of the rule set to create. The name must meet the following // requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Start and end with a letter or number. + // // - Contain 64 characters or fewer. // // This member is required. diff --git a/service/ses/api_op_CreateTemplate.go b/service/ses/api_op_CreateTemplate.go index 34a4e4548fd..dae94783fd5 100644 --- a/service/ses/api_op_CreateTemplate.go +++ b/service/ses/api_op_CreateTemplate.go @@ -13,8 +13,11 @@ import ( // Creates an email template. Email templates enable you to send personalized // email to one or more destinations in a single operation. For more information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html) -// . You can execute this operation no more than once per second. +// see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error) { if params == nil { params = &CreateTemplateInput{} @@ -30,9 +33,10 @@ func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput return out, nil } -// Represents a request to create an email template. For more information, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html) +// Represents a request to create an email template. For more information, see the [Amazon SES Developer Guide] // . +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html type CreateTemplateInput struct { // The content of the email, composed of a subject line and either an HTML part or diff --git a/service/ses/api_op_DeleteConfigurationSet.go b/service/ses/api_op_DeleteConfigurationSet.go index d591d5c42da..e809dd1e341 100644 --- a/service/ses/api_op_DeleteConfigurationSet.go +++ b/service/ses/api_op_DeleteConfigurationSet.go @@ -11,9 +11,11 @@ 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/dg/monitor-sending-activity.html) -// . You can execute this operation no more than once per second. +// sending events. For information about using configuration sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error) { if params == nil { params = &DeleteConfigurationSetInput{} @@ -31,8 +33,9 @@ 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/dg/monitor-sending-activity.html) -// . +// sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 696b0f5a10a..ac6a32330bb 100644 --- a/service/ses/api_op_DeleteConfigurationSetEventDestination.go +++ b/service/ses/api_op_DeleteConfigurationSetEventDestination.go @@ -12,9 +12,11 @@ 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/dg/monitor-sending-activity.html) -// . You can execute this operation no more than once per second. +// email sending events. For information about using configuration sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) DeleteConfigurationSetEventDestination(ctx context.Context, params *DeleteConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*DeleteConfigurationSetEventDestinationOutput, error) { if params == nil { params = &DeleteConfigurationSetEventDestinationInput{} @@ -33,8 +35,9 @@ 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/dg/monitor-sending-activity.html) -// . +// configuration sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 e65374c3218..48626a87969 100644 --- a/service/ses/api_op_DeleteConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_DeleteConfigurationSetTrackingOptions.go @@ -11,13 +11,17 @@ import ( ) // Deletes 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/dg/configure-custom-open-click-domains.html) -// . Deleting this kind of association results in emails sent using the specified +// 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]. +// +// Deleting this kind of association results in emails sent using the specified // configuration set to capture open and click events using the standard, Amazon // SES-operated domains. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html 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 aee3ff7b149..cd4ca9a2344 100644 --- a/service/ses/api_op_DeleteCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_DeleteCustomVerificationEmailTemplate.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// Deletes an existing custom verification email template. +// +// For more information about custom verification email templates, see [Using Custom Verification Email Templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) DeleteCustomVerificationEmailTemplate(ctx context.Context, params *DeleteCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*DeleteCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &DeleteCustomVerificationEmailTemplateInput{} diff --git a/service/ses/api_op_DeleteIdentity.go b/service/ses/api_op_DeleteIdentity.go index 00e59fc7f7a..5e26a1136c0 100644 --- a/service/ses/api_op_DeleteIdentity.go +++ b/service/ses/api_op_DeleteIdentity.go @@ -11,8 +11,9 @@ import ( ) // Deletes the specified identity (an email address or a domain) from the list of -// verified identities. You can execute this operation no more than once per -// second. +// verified identities. +// +// You can execute this operation no more than once per second. func (c *Client) DeleteIdentity(ctx context.Context, params *DeleteIdentityInput, optFns ...func(*Options)) (*DeleteIdentityOutput, error) { if params == nil { params = &DeleteIdentityInput{} diff --git a/service/ses/api_op_DeleteIdentityPolicy.go b/service/ses/api_op_DeleteIdentityPolicy.go index c290fab72a6..1fd783d5a78 100644 --- a/service/ses/api_op_DeleteIdentityPolicy.go +++ b/service/ses/api_op_DeleteIdentityPolicy.go @@ -12,12 +12,18 @@ import ( // Deletes the specified sending authorization policy for the given identity (an // email address or a domain). This operation returns successfully even if a policy -// with the specified name does not exist. This operation is for the identity owner -// only. If you have not verified the identity, it returns 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/dg/sending-authorization.html) -// . You can execute this operation no more than once per second. +// with the specified name does not exist. +// +// This operation is for the identity owner only. If you have not verified the +// identity, it returns 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html func (c *Client) DeleteIdentityPolicy(ctx context.Context, params *DeleteIdentityPolicyInput, optFns ...func(*Options)) (*DeleteIdentityPolicyOutput, error) { if params == nil { params = &DeleteIdentityPolicyInput{} @@ -35,16 +41,17 @@ 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/dg/sending-authorization.html) -// . +// other senders to use your identities. For information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html type DeleteIdentityPolicyInput struct { // The identity that is associated with the policy 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 operation, you must own the identity. + // arn:aws:ses:us-east-1:123456789012:identity/example.com . + // + // To successfully call this operation, you must own the identity. // // This member is required. Identity *string diff --git a/service/ses/api_op_DeleteReceiptFilter.go b/service/ses/api_op_DeleteReceiptFilter.go index 2619d322ea4..1a3a641bc1f 100644 --- a/service/ses/api_op_DeleteReceiptFilter.go +++ b/service/ses/api_op_DeleteReceiptFilter.go @@ -10,9 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/dg/receiving-email-ip-filtering-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// Deletes the specified IP address filter. +// +// For information about managing IP address filters, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html func (c *Client) DeleteReceiptFilter(ctx context.Context, params *DeleteReceiptFilterInput, optFns ...func(*Options)) (*DeleteReceiptFilterOutput, error) { if params == nil { params = &DeleteReceiptFilterInput{} @@ -29,9 +33,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/dg/receiving-email-concepts.html) -// . +// when you receive email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 85266cd4dd2..bb341ebeecf 100644 --- a/service/ses/api_op_DeleteReceiptRule.go +++ b/service/ses/api_op_DeleteReceiptRule.go @@ -10,9 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified receipt rule. For information about managing receipt -// rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// Deletes the specified receipt rule. +// +// For information about managing receipt rules, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) DeleteReceiptRule(ctx context.Context, params *DeleteReceiptRuleInput, optFns ...func(*Options)) (*DeleteReceiptRuleOutput, error) { if params == nil { params = &DeleteReceiptRuleInput{} @@ -29,8 +33,9 @@ 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/dg/receiving-email-concepts.html) -// . +// email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 a0501a10321..f7ce7d9bcd4 100644 --- a/service/ses/api_op_DeleteReceiptRuleSet.go +++ b/service/ses/api_op_DeleteReceiptRuleSet.go @@ -10,10 +10,15 @@ 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/dg/receiving-email-receipt-rules-console-walkthrough.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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) DeleteReceiptRuleSet(ctx context.Context, params *DeleteReceiptRuleSetInput, optFns ...func(*Options)) (*DeleteReceiptRuleSetOutput, error) { if params == nil { params = &DeleteReceiptRuleSetInput{} @@ -31,8 +36,9 @@ 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/dg/receiving-email-concepts.html) -// . +// more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 7db3f3785dc..434ed7088dc 100644 --- a/service/ses/api_op_DeleteTemplate.go +++ b/service/ses/api_op_DeleteTemplate.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an email template. You can execute this operation no more than once per -// second. +// Deletes an email template. +// +// You can execute this operation no more than once per second. func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error) { if params == nil { params = &DeleteTemplateInput{} @@ -27,9 +28,10 @@ func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput return out, nil } -// Represents a request to delete an email template. For more information, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html) +// Represents a request to delete an email template. For more information, see the [Amazon SES Developer Guide] // . +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html type DeleteTemplateInput struct { // The name of the template to be deleted. diff --git a/service/ses/api_op_DescribeActiveReceiptRuleSet.go b/service/ses/api_op_DescribeActiveReceiptRuleSet.go index 80d4d438ce5..27626d2a4ad 100644 --- a/service/ses/api_op_DescribeActiveReceiptRuleSet.go +++ b/service/ses/api_op_DescribeActiveReceiptRuleSet.go @@ -12,9 +12,13 @@ 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/dg/receiving-email-concepts.html#receiving-email-concepts-rules) -// . You can execute this operation no more than once per second. +// currently active. +// +// For information about setting up receipt rule sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules func (c *Client) DescribeActiveReceiptRuleSet(ctx context.Context, params *DescribeActiveReceiptRuleSetInput, optFns ...func(*Options)) (*DescribeActiveReceiptRuleSetOutput, error) { if params == nil { params = &DescribeActiveReceiptRuleSetInput{} @@ -32,8 +36,9 @@ 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/dg/receiving-email-concepts.html) -// . +// with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type DescribeActiveReceiptRuleSetInput struct { noSmithyDocumentSerde } diff --git a/service/ses/api_op_DescribeConfigurationSet.go b/service/ses/api_op_DescribeConfigurationSet.go index 10abab34f9d..15f95a9173d 100644 --- a/service/ses/api_op_DescribeConfigurationSet.go +++ b/service/ses/api_op_DescribeConfigurationSet.go @@ -12,8 +12,11 @@ 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/dg/monitor-sending-activity.html) -// . You can execute this operation no more than once per second. +// using configuration sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) DescribeConfigurationSet(ctx context.Context, params *DescribeConfigurationSetInput, optFns ...func(*Options)) (*DescribeConfigurationSetOutput, error) { if params == nil { params = &DescribeConfigurationSetInput{} @@ -31,8 +34,9 @@ func (c *Client) DescribeConfigurationSet(ctx context.Context, params *DescribeC // 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/dg/monitor-sending-activity.html) -// . +// about using configuration sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type DescribeConfigurationSetInput struct { // The name of the configuration set to describe. @@ -48,8 +52,9 @@ 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/dg/monitor-sending-activity.html) -// . +// see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 3fa3e0a8272..f66eb180bf6 100644 --- a/service/ses/api_op_DescribeReceiptRule.go +++ b/service/ses/api_op_DescribeReceiptRule.go @@ -11,9 +11,13 @@ 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/dg/receiving-email-receipt-rules-console-walkthrough.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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) DescribeReceiptRule(ctx context.Context, params *DescribeReceiptRuleInput, optFns ...func(*Options)) (*DescribeReceiptRuleOutput, error) { if params == nil { params = &DescribeReceiptRuleInput{} @@ -30,9 +34,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/dg/receiving-email-concepts.html) -// . +// rules to receive email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 d66bb438f8c..139d46776c5 100644 --- a/service/ses/api_op_DescribeReceiptRuleSet.go +++ b/service/ses/api_op_DescribeReceiptRuleSet.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// Returns the details of the specified receipt rule set. +// +// For information about managing receipt rule sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) DescribeReceiptRuleSet(ctx context.Context, params *DescribeReceiptRuleSetInput, optFns ...func(*Options)) (*DescribeReceiptRuleSetOutput, error) { if params == nil { params = &DescribeReceiptRuleSetInput{} @@ -31,8 +35,9 @@ 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/dg/receiving-email-concepts.html) -// . +// the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type DescribeReceiptRuleSetInput struct { // The name of the receipt rule set to describe. diff --git a/service/ses/api_op_GetAccountSendingEnabled.go b/service/ses/api_op_GetAccountSendingEnabled.go index c9e8c3cb211..6a330df85b0 100644 --- a/service/ses/api_op_GetAccountSendingEnabled.go +++ b/service/ses/api_op_GetAccountSendingEnabled.go @@ -11,7 +11,9 @@ import ( ) // Returns the email sending status of the Amazon SES account for the current -// Region. You can execute this operation no more than once per second. +// Region. +// +// You can execute this operation no more than once per second. func (c *Client) GetAccountSendingEnabled(ctx context.Context, params *GetAccountSendingEnabledInput, optFns ...func(*Options)) (*GetAccountSendingEnabledOutput, error) { if params == nil { params = &GetAccountSendingEnabledInput{} diff --git a/service/ses/api_op_GetCustomVerificationEmailTemplate.go b/service/ses/api_op_GetCustomVerificationEmailTemplate.go index 719693a36b5..5841db43cd7 100644 --- a/service/ses/api_op_GetCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_GetCustomVerificationEmailTemplate.go @@ -11,10 +11,14 @@ 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// specify. +// +// For more information about custom verification email templates, see [Using Custom Verification Email Templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) GetCustomVerificationEmailTemplate(ctx context.Context, params *GetCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*GetCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &GetCustomVerificationEmailTemplateInput{} diff --git a/service/ses/api_op_GetIdentityDkimAttributes.go b/service/ses/api_op_GetIdentityDkimAttributes.go index fdf7c7bebce..0ff8b77f65c 100644 --- a/service/ses/api_op_GetIdentityDkimAttributes.go +++ b/service/ses/api_op_GetIdentityDkimAttributes.go @@ -14,19 +14,26 @@ import ( // Returns the current status of Easy DKIM signing for an entity. For domain name // identities, this operation also returns the DKIM tokens that are required for // 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: +// 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. // // 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/dg/send-email-authentication-dkim-easy-managing.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy-managing.html func (c *Client) GetIdentityDkimAttributes(ctx context.Context, params *GetIdentityDkimAttributesInput, optFns ...func(*Options)) (*GetIdentityDkimAttributesOutput, error) { if params == nil { params = &GetIdentityDkimAttributesInput{} @@ -45,9 +52,10 @@ func (c *Client) GetIdentityDkimAttributes(ctx context.Context, params *GetIdent // Represents a request for the status of Amazon SES Easy DKIM signing for an // 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/dg/send-email-authentication-dkim-easy.html) +// that these tokens were published. For more information about Easy DKIM, see the [Amazon SES Developer Guide] // . +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.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 9df799c0c3f..9811f3b0f2c 100644 --- a/service/ses/api_op_GetIdentityMailFromDomainAttributes.go +++ b/service/ses/api_op_GetIdentityMailFromDomainAttributes.go @@ -12,8 +12,10 @@ import ( ) // Returns the custom MAIL FROM attributes for a list of identities (email -// addresses : domains). This operation is throttled at one request per second and -// can only get custom MAIL FROM attributes for up to 100 identities at a time. +// addresses : domains). +// +// This operation is throttled at one request per second and can only get custom +// MAIL FROM attributes for up to 100 identities at a time. func (c *Client) GetIdentityMailFromDomainAttributes(ctx context.Context, params *GetIdentityMailFromDomainAttributesInput, optFns ...func(*Options)) (*GetIdentityMailFromDomainAttributesOutput, error) { if params == nil { params = &GetIdentityMailFromDomainAttributesInput{} @@ -31,8 +33,9 @@ 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/dg/mail-from.html) -// . +// the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 01adf7a7eb7..826ffda93e6 100644 --- a/service/ses/api_op_GetIdentityNotificationAttributes.go +++ b/service/ses/api_op_GetIdentityNotificationAttributes.go @@ -12,11 +12,14 @@ import ( ) // Given a list of verified identities (email addresses and/or domains), returns a -// 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/dg/monitor-sending-activity-using-notifications.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html func (c *Client) GetIdentityNotificationAttributes(ctx context.Context, params *GetIdentityNotificationAttributesInput, optFns ...func(*Options)) (*GetIdentityNotificationAttributesOutput, error) { if params == nil { params = &GetIdentityNotificationAttributesInput{} @@ -34,8 +37,9 @@ 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/dg/monitor-sending-activity-using-notifications.html) -// . +// notifications, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html type GetIdentityNotificationAttributesInput struct { // A list of one or more identities. You can specify an identity by using its name diff --git a/service/ses/api_op_GetIdentityPolicies.go b/service/ses/api_op_GetIdentityPolicies.go index 90b2f45e776..0213f820f6f 100644 --- a/service/ses/api_op_GetIdentityPolicies.go +++ b/service/ses/api_op_GetIdentityPolicies.go @@ -12,12 +12,18 @@ import ( // Returns the requested sending authorization policies for the given identity (an // email address or a domain). The policies are returned as a map of policy names -// to policy contents. You can retrieve a maximum of 20 policies at a time. This -// operation is for the identity owner only. If you have not verified the identity, -// it returns 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/dg/sending-authorization.html) -// . You can execute this operation no more than once per second. +// to policy contents. You can retrieve a maximum of 20 policies at a time. +// +// This operation is for the identity owner only. If you have not verified the +// identity, it returns 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html func (c *Client) GetIdentityPolicies(ctx context.Context, params *GetIdentityPoliciesInput, optFns ...func(*Options)) (*GetIdentityPoliciesOutput, error) { if params == nil { params = &GetIdentityPoliciesInput{} @@ -35,16 +41,17 @@ 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/dg/sending-authorization.html) -// . +// authorize other senders to use your identities. For information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html type GetIdentityPoliciesInput struct { // The identity for which the policies are 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 - // this operation, you must own the identity. + // arn:aws:ses:us-east-1:123456789012:identity/example.com . + // + // To successfully call this operation, you must own the identity. // // This member is required. Identity *string diff --git a/service/ses/api_op_GetIdentityVerificationAttributes.go b/service/ses/api_op_GetIdentityVerificationAttributes.go index c9f9a9d6653..11813dedaaf 100644 --- a/service/ses/api_op_GetIdentityVerificationAttributes.go +++ b/service/ses/api_op_GetIdentityVerificationAttributes.go @@ -17,21 +17,25 @@ import ( // Given a list of identities (email addresses and/or domains), returns the // verification status and (for domain identities) the verification token for each -// identity. The verification status of an email address is "Pending" until the -// email address owner clicks the link within the verification email that Amazon -// SES sent to that address. If the email address owner clicks the link within 24 -// hours, the verification status of the email address changes to "Success". If the -// link is not clicked within 24 hours, the verification status changes to -// "Failed." In that case, to verify the email address, you must restart the -// verification process from the beginning. For domain identities, the domain's -// verification status is "Pending" as Amazon SES searches for the required TXT -// record in the DNS settings of the domain. When Amazon SES detects the record, -// the domain's verification status changes to "Success". If Amazon SES is unable -// to detect the record within 72 hours, the domain's verification status changes -// to "Failed." In that case, to verify the domain, you must restart the -// verification process from the beginning. This operation is throttled at one -// request per second and can only get verification attributes for up to 100 -// identities at a time. +// identity. +// +// The verification status of an email address is "Pending" until the email +// address owner clicks the link within the verification email that Amazon SES sent +// to that address. If the email address owner clicks the link within 24 hours, the +// verification status of the email address changes to "Success". If the link is +// not clicked within 24 hours, the verification status changes to "Failed." In +// that case, to verify the email address, you must restart the verification +// process from the beginning. +// +// For domain identities, the domain's verification status is "Pending" as Amazon +// SES searches for the required TXT record in the DNS settings of the domain. When +// Amazon SES detects the record, the domain's verification status changes to +// "Success". If Amazon SES is unable to detect the record within 72 hours, the +// domain's verification status changes to "Failed." In that case, to verify the +// domain, you must restart the verification process from the beginning. +// +// This operation is throttled at one request per second and can only get +// verification attributes for up to 100 identities at a time. func (c *Client) GetIdentityVerificationAttributes(ctx context.Context, params *GetIdentityVerificationAttributesInput, optFns ...func(*Options)) (*GetIdentityVerificationAttributesOutput, error) { if params == nil { params = &GetIdentityVerificationAttributesInput{} @@ -49,9 +53,9 @@ 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/dg/creating-identities.html) -// . +// token. For information about verifying identities with Amazon SES, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html type GetIdentityVerificationAttributesInput struct { // A list of identities. @@ -196,12 +200,13 @@ type IdentityExistsWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetIdentityVerificationAttributesInput, *GetIdentityVerificationAttributesOutput, error) (bool, error) } diff --git a/service/ses/api_op_GetSendQuota.go b/service/ses/api_op_GetSendQuota.go index 8b3148676a9..4145c114ac8 100644 --- a/service/ses/api_op_GetSendQuota.go +++ b/service/ses/api_op_GetSendQuota.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides the sending limits for the Amazon SES account. You can execute this -// operation no more than once per second. +// Provides the sending limits for the Amazon SES account. +// +// You can execute this operation no more than once per second. func (c *Client) GetSendQuota(ctx context.Context, params *GetSendQuotaInput, optFns ...func(*Options)) (*GetSendQuotaOutput, error) { if params == nil { params = &GetSendQuotaInput{} @@ -40,8 +41,10 @@ type GetSendQuotaOutput struct { Max24HourSend float64 // The maximum number of emails that Amazon SES can accept from the user's account - // per second. The rate at which Amazon SES accepts the user's messages might be - // less than the maximum send rate. + // per second. + // + // The rate at which Amazon SES accepts the user's messages might be less than the + // maximum send rate. MaxSendRate float64 // The number of emails sent during the previous 24 hours. diff --git a/service/ses/api_op_GetSendStatistics.go b/service/ses/api_op_GetSendStatistics.go index 9ee6da9f9bb..68d6b46c3f1 100644 --- a/service/ses/api_op_GetSendStatistics.go +++ b/service/ses/api_op_GetSendStatistics.go @@ -14,7 +14,9 @@ import ( // Provides sending statistics for the current Amazon Web Services Region. The // result is a list of data points, representing the last two weeks of sending // activity. Each data point in the list contains statistics for a 15-minute period -// of time. You can execute this operation no more than once per second. +// of time. +// +// You can execute this operation no more than once per second. func (c *Client) GetSendStatistics(ctx context.Context, params *GetSendStatisticsInput, optFns ...func(*Options)) (*GetSendStatisticsOutput, error) { if params == nil { params = &GetSendStatisticsInput{} diff --git a/service/ses/api_op_GetTemplate.go b/service/ses/api_op_GetTemplate.go index 3230148c42c..f3a50af1543 100644 --- a/service/ses/api_op_GetTemplate.go +++ b/service/ses/api_op_GetTemplate.go @@ -12,8 +12,9 @@ import ( ) // Displays the template object (which includes the Subject line, HTML part and -// text part) for the template you specify. You can execute this operation no more -// than once per second. +// text part) for the template you specify. +// +// You can execute this operation no more than once per second. func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error) { if params == nil { params = &GetTemplateInput{} diff --git a/service/ses/api_op_ListConfigurationSets.go b/service/ses/api_op_ListConfigurationSets.go index 993856d3c10..0991c3a3178 100644 --- a/service/ses/api_op_ListConfigurationSets.go +++ b/service/ses/api_op_ListConfigurationSets.go @@ -13,13 +13,16 @@ import ( // Provides a list of the configuration sets associated with your Amazon SES // account in the current Amazon Web Services Region. For information about using -// configuration sets, see Monitoring Your Amazon SES Sending Activity (https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. This operation returns up to 1,000 configuration sets each time -// it is run. If your Amazon SES account has more than 1,000 configuration sets, -// this operation also returns NextToken . You can then execute the -// ListConfigurationSets operation again, passing the NextToken parameter and the -// value of the NextToken element to retrieve additional results. +// configuration sets, see [Monitoring Your Amazon SES Sending Activity]in the Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. This operation +// returns up to 1,000 configuration sets each time it is run. If your Amazon SES +// account has more than 1,000 configuration sets, this operation also returns +// NextToken . You can then execute the ListConfigurationSets operation again, +// passing the NextToken parameter and the value of the NextToken element to +// retrieve additional results. +// +// [Monitoring Your Amazon SES Sending Activity]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigurationSetsInput, optFns ...func(*Options)) (*ListConfigurationSetsOutput, error) { if params == nil { params = &ListConfigurationSetsInput{} @@ -37,9 +40,9 @@ func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigur // Represents a request to list the configuration sets associated with your Amazon // Web Services 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/dg/monitor-sending-activity.html) -// . +// events. For information about using configuration sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type ListConfigurationSetsInput struct { // The number of configuration sets to return. @@ -54,8 +57,9 @@ type ListConfigurationSetsInput struct { // A list of configuration sets associated with your Amazon Web Services 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/dg/monitor-sending-activity.html) -// . +// about using configuration sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type ListConfigurationSetsOutput struct { // A list of configuration sets. diff --git a/service/ses/api_op_ListCustomVerificationEmailTemplates.go b/service/ses/api_op_ListCustomVerificationEmailTemplates.go index 2ef885311eb..a0ebde7da57 100644 --- a/service/ses/api_op_ListCustomVerificationEmailTemplates.go +++ b/service/ses/api_op_ListCustomVerificationEmailTemplates.go @@ -12,10 +12,14 @@ 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// current Amazon Web Services Region. +// +// For more information about custom verification email templates, see [Using Custom Verification Email Templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, params *ListCustomVerificationEmailTemplatesInput, optFns ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error) { if params == nil { params = &ListCustomVerificationEmailTemplatesInput{} @@ -32,9 +36,12 @@ 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/dg/creating-identities.html#send-email-verify-address-custom) -// in the Amazon SES Developer Guide. +// for your account. +// +// For more information about custom verification email templates, see [Using Custom Verification Email Templates] in the +// Amazon SES Developer Guide. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom type ListCustomVerificationEmailTemplatesInput struct { // The maximum number of custom verification email templates to return. This value diff --git a/service/ses/api_op_ListIdentities.go b/service/ses/api_op_ListIdentities.go index 9375331787d..78e3694b17f 100644 --- a/service/ses/api_op_ListIdentities.go +++ b/service/ses/api_op_ListIdentities.go @@ -13,15 +13,17 @@ import ( // Returns a list containing all of the identities (email addresses and domains) // for your Amazon Web Services account in the current Amazon Web Services Region, -// regardless of verification status. You can execute this operation no more than -// once per second. It's recommended that for successive pagination calls of this -// API, you continue to the use the same parameter/value pairs as used in the -// original call, e.g., if you used IdentityType=Domain in the the original call -// and received a NextToken in the response, you should continue providing the -// IdentityType=Domain parameter for further NextToken calls; however, if you -// didn't provide the IdentityType parameter in the original call, then continue -// to not provide it for successive pagination calls. Using this protocol will -// ensure consistent results. +// regardless of verification status. +// +// You can execute this operation no more than once per second. +// +// It's recommended that for successive pagination calls of this API, you continue +// to the use the same parameter/value pairs as used in the original call, e.g., if +// you used IdentityType=Domain in the the original call and received a NextToken +// in the response, you should continue providing the IdentityType=Domain +// parameter for further NextToken calls; however, if you didn't provide the +// IdentityType parameter in the original call, then continue to not provide it for +// successive pagination calls. Using this protocol will ensure consistent results. func (c *Client) ListIdentities(ctx context.Context, params *ListIdentitiesInput, optFns ...func(*Options)) (*ListIdentitiesOutput, error) { if params == nil { params = &ListIdentitiesInput{} diff --git a/service/ses/api_op_ListIdentityPolicies.go b/service/ses/api_op_ListIdentityPolicies.go index 18b0a1e881e..e3129ec603e 100644 --- a/service/ses/api_op_ListIdentityPolicies.go +++ b/service/ses/api_op_ListIdentityPolicies.go @@ -12,12 +12,18 @@ import ( // Returns a list of sending authorization policies that are attached to the given // identity (an email address or a domain). This operation returns only a list. To -// get the actual policy content, use GetIdentityPolicies . This operation is for -// the identity owner only. If you have not verified the identity, it returns 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/dg/sending-authorization.html) -// . You can execute this operation no more than once per second. +// get the actual policy content, use GetIdentityPolicies . +// +// This operation is for the identity owner only. If you have not verified the +// identity, it returns 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html func (c *Client) ListIdentityPolicies(ctx context.Context, params *ListIdentityPoliciesInput, optFns ...func(*Options)) (*ListIdentityPoliciesOutput, error) { if params == nil { params = &ListIdentityPoliciesInput{} @@ -36,15 +42,17 @@ func (c *Client) ListIdentityPolicies(ctx context.Context, params *ListIdentityP // 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/dg/sending-authorization.html) -// . +// see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html type ListIdentityPoliciesInput struct { // The identity that is associated with the policy for which the policies are // 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 - // this operation, you must own the identity. + // arn:aws:ses:us-east-1:123456789012:identity/example.com . + // + // To successfully call this operation, you must own the identity. // // This member is required. Identity *string diff --git a/service/ses/api_op_ListReceiptFilters.go b/service/ses/api_op_ListReceiptFilters.go index 427f26ae1b1..18a56372330 100644 --- a/service/ses/api_op_ListReceiptFilters.go +++ b/service/ses/api_op_ListReceiptFilters.go @@ -12,9 +12,13 @@ import ( ) // Lists the IP address filters associated with your Amazon Web Services account -// in the current Amazon Web Services Region. For information about managing IP -// address filters, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// in the current Amazon Web Services Region. +// +// For information about managing IP address filters, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html func (c *Client) ListReceiptFilters(ctx context.Context, params *ListReceiptFiltersInput, optFns ...func(*Options)) (*ListReceiptFiltersOutput, error) { if params == nil { params = &ListReceiptFiltersInput{} @@ -32,8 +36,9 @@ func (c *Client) ListReceiptFilters(ctx context.Context, params *ListReceiptFilt // Represents a request to list the IP address filters that exist under your // Amazon Web Services 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/dg/receiving-email-concepts.html) -// . +// with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type ListReceiptFiltersInput struct { noSmithyDocumentSerde } diff --git a/service/ses/api_op_ListReceiptRuleSets.go b/service/ses/api_op_ListReceiptRuleSets.go index 387979f864c..62f8e7c6321 100644 --- a/service/ses/api_op_ListReceiptRuleSets.go +++ b/service/ses/api_op_ListReceiptRuleSets.go @@ -14,9 +14,13 @@ import ( // Lists the receipt rule sets that exist under your Amazon Web Services account // in the current Amazon Web Services Region. If there are additional receipt rule // sets to be retrieved, you 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// call to ListReceiptRuleSets to retrieve the additional entries. +// +// For information about managing receipt rule sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) ListReceiptRuleSets(ctx context.Context, params *ListReceiptRuleSetsInput, optFns ...func(*Options)) (*ListReceiptRuleSetsOutput, error) { if params == nil { params = &ListReceiptRuleSetsInput{} @@ -34,8 +38,9 @@ func (c *Client) ListReceiptRuleSets(ctx context.Context, params *ListReceiptRul // Represents a request to list the receipt rule sets that exist under your Amazon // Web Services 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/dg/receiving-email-concepts.html) -// . +// SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type ListReceiptRuleSetsInput struct { // A token returned from a previous call to ListReceiptRuleSets to indicate the diff --git a/service/ses/api_op_ListTemplates.go b/service/ses/api_op_ListTemplates.go index 4990cfd950b..0172139e3c2 100644 --- a/service/ses/api_op_ListTemplates.go +++ b/service/ses/api_op_ListTemplates.go @@ -12,8 +12,9 @@ import ( ) // Lists the email templates present in your Amazon SES account in the current -// Amazon Web Services Region. You can execute this operation no more than once per -// second. +// Amazon Web Services Region. +// +// You can execute this operation no more than once per second. func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error) { if params == nil { params = &ListTemplatesInput{} diff --git a/service/ses/api_op_PutIdentityPolicy.go b/service/ses/api_op_PutIdentityPolicy.go index 62c9c3abb2e..fcfa5a56c03 100644 --- a/service/ses/api_op_PutIdentityPolicy.go +++ b/service/ses/api_op_PutIdentityPolicy.go @@ -11,12 +11,18 @@ import ( ) // Adds or updates a sending authorization policy for the specified identity (an -// email address or a domain). This operation is for the identity owner only. If -// you have not verified the identity, it returns 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/dg/sending-authorization.html) -// . You can execute this operation no more than once per second. +// email address or a domain). +// +// This operation is for the identity owner only. If you have not verified the +// identity, it returns 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html func (c *Client) PutIdentityPolicy(ctx context.Context, params *PutIdentityPolicyInput, optFns ...func(*Options)) (*PutIdentityPolicyOutput, error) { if params == nil { params = &PutIdentityPolicyInput{} @@ -34,30 +40,34 @@ 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/dg/sending-authorization.html) -// . +// authorize other senders to use your identities. For information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html type PutIdentityPolicyInput struct { // The identity to which that the policy applies. 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 operation, you must own the identity. + // arn:aws:ses:us-east-1:123456789012:identity/example.com . + // + // To successfully call this operation, 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/dg/sending-authorization-policies.html) - // . + // 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]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 44251c31386..dc6f5b19270 100644 --- a/service/ses/api_op_ReorderReceiptRuleSet.go +++ b/service/ses/api_op_ReorderReceiptRuleSet.go @@ -10,11 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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, it is 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// 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, +// it is 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) ReorderReceiptRuleSet(ctx context.Context, params *ReorderReceiptRuleSetInput, optFns ...func(*Options)) (*ReorderReceiptRuleSetOutput, error) { if params == nil { params = &ReorderReceiptRuleSetInput{} @@ -32,8 +37,9 @@ func (c *Client) ReorderReceiptRuleSet(ctx context.Context, params *ReorderRecei // 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/dg/receiving-email-concepts.html) -// . +// information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type ReorderReceiptRuleSetInput struct { // The specified receipt rule set's receipt rules, in order. diff --git a/service/ses/api_op_SendBounce.go b/service/ses/api_op_SendBounce.go index f4e388fd931..a37bf308f24 100644 --- a/service/ses/api_op_SendBounce.go +++ b/service/ses/api_op_SendBounce.go @@ -13,10 +13,16 @@ import ( // Generates and sends a bounce message to the sender of an email you received // through Amazon SES. You can only use this operation on an email up to 24 hours -// after you receive it. You cannot use this operation 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/dg/receiving-email.html) -// . You can execute this operation no more than once per second. +// after you receive it. +// +// You cannot use this operation 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html func (c *Client) SendBounce(ctx context.Context, params *SendBounceInput, optFns ...func(*Options)) (*SendBounceOutput, error) { if params == nil { params = &SendBounceInput{} @@ -57,8 +63,9 @@ 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/dg/sending-authorization.html) - // . + // about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 3492a19231c..f5110c636d4 100644 --- a/service/ses/api_op_SendBulkTemplatedEmail.go +++ b/service/ses/api_op_SendBulkTemplatedEmail.go @@ -12,29 +12,39 @@ import ( ) // Composes an email message to multiple destinations. The message body is created -// using an email template. To send email using this operation, your call must meet -// the following requirements: +// using an email template. +// +// To send email using this operation, your call must meet the following +// requirements: +// // - The call must refer to an existing email template. You can create email -// templates using CreateTemplate . +// templates using CreateTemplate. +// // - The message must be sent from a verified email address or domain. +// // - If your account is still in the Amazon SES sandbox, you may send only 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/dg/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. +// SES Mailbox Simulator. For more information, see [Verifying Email Addresses and Domains]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 is // 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 can be limited // by your account's maximum sending rate. +// +// [Verifying Email Addresses and Domains]: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html func (c *Client) SendBulkTemplatedEmail(ctx context.Context, params *SendBulkTemplatedEmailInput, optFns ...func(*Options)) (*SendBulkTemplatedEmailOutput, error) { if params == nil { params = &SendBulkTemplatedEmailInput{} @@ -51,8 +61,9 @@ 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/dg/send-personalized-email-api.html) -// . +// Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html type SendBulkTemplatedEmailInput struct { // One or more Destination objects. All of the recipients in a Destination receive @@ -64,22 +75,25 @@ 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/dg/creating-identities.html) - // . If you are sending on behalf of another user and have been permitted to do so + // with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide]. + // + // 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/dg/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 email address string must be 7-bit ASCII. If you want to - // send to or from email addresses that contain Unicode characters in the domain - // part of an address, you must encode the domain using Punycode. Punycode is not - // permitted in the local part of the email address (the part before the @ sign) - // nor in the "friendly from" name. If you want to use Unicode characters in the - // "friendly from" name, you must encode the "friendly from" name using MIME - // encoded-word syntax, as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) - // . For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492) - // . + // parameter. For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this + // reason, the email address string must be 7-bit ASCII. If you want to send to or + // from email addresses that contain Unicode characters in the domain part of an + // address, you must encode the domain using Punycode. Punycode is not permitted in + // the local part of the email address (the part before the @ sign) nor in the + // "friendly from" name. If you want to use Unicode characters in the "friendly + // from" name, you must encode the "friendly from" name using MIME encoded-word + // syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492]. + // + // [RFC6531]: https://tools.ietf.org/html/rfc6531 + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html + // [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html + // [RFC 3492]: http://tools.ietf.org/html/rfc3492 // // This member is required. Source *string @@ -99,9 +113,10 @@ type SendBulkTemplatedEmailInput struct { // A list of replacement values to apply to the template when replacement data is // not specified in a Destination object. These values act as a default or fallback - // option when no other data is available. The template data is a JSON object, - // typically consisting of key-value pairs in which the keys correspond to - // replacement tags in the email template. + // option when no other data is available. + // + // The template data is a JSON object, typically consisting of key-value pairs in + // which the keys correspond to replacement tags in the email template. DefaultTemplateData *string // The reply-to email address(es) for the message. If the recipient replies to the @@ -119,26 +134,32 @@ type SendBulkTemplatedEmailInput 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 email address specified in the ReturnPath parameter. For - // example, if the owner of example.com (which has ARN + // 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/dg/sending-authorization.html) - // . + // and the ReturnPath to be feedback@example.com . + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 + // 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/dg/sending-authorization.html) - // . + // and the Source to be user@example.com . + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 31b5d6ad512..4ee8b7ec239 100644 --- a/service/ses/api_op_SendCustomVerificationEmail.go +++ b/service/ses/api_op_SendCustomVerificationEmail.go @@ -13,12 +13,15 @@ import ( // Adds an email address to the list of identities for your Amazon SES account in // the current Amazon Web Services Region and attempts to verify it. As a result of // executing this 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/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. +// 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]in the Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) SendCustomVerificationEmail(ctx context.Context, params *SendCustomVerificationEmailInput, optFns ...func(*Options)) (*SendCustomVerificationEmailOutput, error) { if params == nil { params = &SendCustomVerificationEmailInput{} diff --git a/service/ses/api_op_SendEmail.go b/service/ses/api_op_SendEmail.go index 2b63fa77e88..e9b588c5c53 100644 --- a/service/ses/api_op_SendEmail.go +++ b/service/ses/api_op_SendEmail.go @@ -13,20 +13,24 @@ import ( // Composes an email message and immediately queues it for sending. To send email // using this 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 // results 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/dg/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. +// SES Mailbox Simulator. For more information, see [Verifying Email Addresses and Domains]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 is 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 @@ -35,9 +39,11 @@ import ( // 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/dg/manage-sending-quotas.html) -// in the Amazon SES Developer Guide. +// information about sending quotas in Amazon SES, see [Managing Your Amazon SES Sending Limits]in the Amazon SES Developer +// Guide. +// +// [Verifying Email Addresses and Domains]: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html +// [Managing Your Amazon SES Sending Limits]: https://docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns ...func(*Options)) (*SendEmailOutput, error) { if params == nil { params = &SendEmailInput{} @@ -54,8 +60,9 @@ func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns . } // 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/dg/send-email-formatted.html) -// . +// more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-formatted.html type SendEmailInput struct { // The destination for this email, composed of To:, CC:, and BCC: fields. @@ -70,22 +77,25 @@ 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/dg/creating-identities.html) - // . If you are sending on behalf of another user and have been permitted to do so + // with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide]. + // + // 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/dg/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 email address string must be 7-bit ASCII. If you want to - // send to or from email addresses that contain Unicode characters in the domain - // part of an address, you must encode the domain using Punycode. Punycode is not - // permitted in the local part of the email address (the part before the @ sign) - // nor in the "friendly from" name. If you want to use Unicode characters in the - // "friendly from" name, you must encode the "friendly from" name using MIME - // encoded-word syntax, as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) - // . For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492) - // . + // parameter. For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this + // reason, the email address string must be 7-bit ASCII. If you want to send to or + // from email addresses that contain Unicode characters in the domain part of an + // address, you must encode the domain using Punycode. Punycode is not permitted in + // the local part of the email address (the part before the @ sign) nor in the + // "friendly from" name. If you want to use Unicode characters in the "friendly + // from" name, you must encode the "friendly from" name using MIME encoded-word + // syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492]. + // + // [RFC6531]: https://tools.ietf.org/html/rfc6531 + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html + // [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html + // [RFC 3492]: http://tools.ietf.org/html/rfc3492 // // This member is required. Source *string @@ -108,26 +118,32 @@ type SendEmailInput 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 email address specified in the ReturnPath parameter. For - // example, if the owner of example.com (which has ARN + // 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/dg/sending-authorization.html) - // . + // and the ReturnPath to be feedback@example.com . + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 + // 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/dg/sending-authorization.html) - // . + // and the Source to be user@example.com . + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html SourceArn *string // A list of tags, in the form of name/value pairs, to apply to an email that you diff --git a/service/ses/api_op_SendRawEmail.go b/service/ses/api_op_SendRawEmail.go index ffdd530a191..96f70a3d234 100644 --- a/service/ses/api_op_SendRawEmail.go +++ b/service/ses/api_op_SendRawEmail.go @@ -11,63 +11,91 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Composes an email message and immediately queues it for sending. This operation -// is more flexible than the SendEmail operation. When you use the SendRawEmail -// operation, you can specify the headers of the message as well as its content. -// This flexibility is useful, for example, when you need to send a multipart MIME -// 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/dg/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/dg/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/dg/send-an-email-from-console.html) -// . +// Composes an email message and immediately queues it for sending. +// +// This operation is more flexible than the SendEmail operation. When you use the +// SendRawEmail operation, you can specify the headers of the message as well as +// its content. This flexibility is useful, for example, when you need to send a +// multipart MIME 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]. 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], you can only send email to other verified +// addresses in your account, or to addresses that are associated with the [Amazon SES mailbox simulator]. +// // - 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/dg/send-email-raw.html#send-email-mime-encoding) -// in the Amazon SES Developer Guide. +// isn't 7-bit ASCII. For more information, see [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 automatically applies its own Message-ID and Date // headers; if you passed these headers when creating the message, they are // 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 , 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/dg/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/dg/manage-sending-quotas.html) -// in the Amazon SES Developer Guide. +// +// - 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]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]in the Amazon SES +// Developer Guide. +// +// [Using Sending Authorization with Amazon SES]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html +// [MIME Encoding]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html#send-email-mime-encoding +// [Amazon SES mailbox simulator]: https://docs.aws.amazon.com/ses/latest/dg/send-an-email-from-console.html +// [Amazon SES sandbox]: https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html +// [verified email addresses or domains]: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html +// +// [Managing Your Amazon SES Sending Limits]: https://docs.aws.amazon.com/ses/latest/dg/manage-sending-quotas.html func (c *Client) SendRawEmail(ctx context.Context, params *SendRawEmailInput, optFns ...func(*Options)) (*SendRawEmailOutput, error) { if params == nil { params = &SendRawEmailInput{} @@ -84,25 +112,34 @@ 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/dg/send-email-raw.html) -// . +// information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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/dg/mime-types.html) - // in the Amazon SES Developer Guide. + // on unsupported content types, see [Unsupported Attachment Types]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/dg/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. + // content. For more information, see [Sending Raw Email]in the Amazon SES Developer Guide. + // + // - Per [RFC 5321], the maximum length of each line of text, including the , must not + // exceed 1,000 characters. + // + // [Sending Raw Email]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html + // [Unsupported Attachment Types]: https://docs.aws.amazon.com/ses/latest/dg/mime-types.html + // [RFC 5321]: https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6 // // This member is required. RawMessage *types.RawMessage @@ -118,62 +155,79 @@ type SendRawEmailInput 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 specify a particular "From" address in the header of the raw email. + // // Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the // 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/dg/sending-authorization-delegate-sender-tasks-email.html) - // . + // 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]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 + // 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/dg/sending-authorization-delegate-sender-tasks-email.html) - // . + // 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]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 - // in RFC6531 (https://tools.ietf.org/html/rfc6531) . For this reason, the email - // address string must be 7-bit ASCII. If you want to send to or from email - // addresses that contain Unicode characters in the domain part of an address, you - // must encode the domain using Punycode. Punycode is not permitted in the local - // part of the email address (the part before the @ sign) nor in the "friendly - // from" name. If you want to use Unicode characters in the "friendly from" name, - // you must encode the "friendly from" name using MIME encoded-word syntax, as - // described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) - // . For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492) - // . If you specify the Source parameter and have feedback forwarding enabled, - // then bounces and complaints are sent to this email address. This takes - // precedence over any Return-Path header that you might include in the raw text of - // the message. + // specify both.) + // + // Amazon SES does not support the SMTPUTF8 extension, as described in[RFC6531] . For this + // reason, the email address string must be 7-bit ASCII. If you want to send to or + // from email addresses that contain Unicode characters in the domain part of an + // address, you must encode the domain using Punycode. Punycode is not permitted in + // the local part of the email address (the part before the @ sign) nor in the + // "friendly from" name. If you want to use Unicode characters in the "friendly + // from" name, you must encode the "friendly from" name using MIME encoded-word + // syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492]. + // + // If you specify the Source parameter and have feedback forwarding enabled, then + // bounces and complaints are sent to this email address. This takes precedence + // over any Return-Path header that you might include in the raw text of the + // message. + // + // [RFC6531]: https://tools.ietf.org/html/rfc6531 + // [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html + // [RFC 3492]: http://tools.ietf.org/html/rfc3492 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 + // 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/dg/sending-authorization-delegate-sender-tasks-email.html) - // . + // 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]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 diff --git a/service/ses/api_op_SendTemplatedEmail.go b/service/ses/api_op_SendTemplatedEmail.go index 2601b91e0f6..5290db59003 100644 --- a/service/ses/api_op_SendTemplatedEmail.go +++ b/service/ses/api_op_SendTemplatedEmail.go @@ -12,21 +12,28 @@ import ( ) // Composes an email message using an email template and immediately queues it for -// sending. To send email using this operation, your call must meet the following +// sending. +// +// To send email using this operation, your call must meet the following // requirements: +// // - The call must refer to an existing email template. You can create email -// templates using the CreateTemplate operation. +// templates using the CreateTemplateoperation. +// // - 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/dg/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. +// SES Mailbox Simulator. For more information, see [Verifying Email Addresses and Domains]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 that receives 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 @@ -37,11 +44,14 @@ import ( // 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/dg/send-personalized-email-api.html) -// in the Amazon Simple Email Service Developer Guide. +// 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]in +// the Amazon Simple Email Service Developer Guide. +// +// [Sending Personalized Email Using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html +// [Verifying Email Addresses and Domains]: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html func (c *Client) SendTemplatedEmail(ctx context.Context, params *SendTemplatedEmailInput, optFns ...func(*Options)) (*SendTemplatedEmailOutput, error) { if params == nil { params = &SendTemplatedEmailInput{} @@ -58,8 +68,9 @@ 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/dg/send-personalized-email-api.html) -// . +// information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html type SendTemplatedEmailInput struct { // The destination for this email, composed of To:, CC:, and BCC: fields. A @@ -70,22 +81,25 @@ 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/dg/creating-identities.html) - // . If you are sending on behalf of another user and have been permitted to do so + // with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide]. + // + // 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/dg/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 email address string must be 7-bit ASCII. If you want to - // send to or from email addresses that contain Unicode characters in the domain - // part of an address, you must encode the domain using Punycode. Punycode is not - // permitted in the local part of the email address (the part before the @ sign) - // nor in the "friendly from" name. If you want to use Unicode characters in the - // "friendly from" name, you must encode the "friendly from" name using MIME - // encoded-word syntax, as described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) - // . For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492) - // . + // parameter. For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. for this + // reason, The email address string must be 7-bit ASCII. If you want to send to or + // from email addresses that contain Unicode characters in the domain part of an + // address, you must encode the domain using Punycode. Punycode is not permitted in + // the local part of the email address (the part before the @ sign) nor in the + // "friendly from" name. If you want to use Unicode characters in the "friendly + // from" name, you must encode the "friendly from" name using MIME encoded-word + // syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492]. + // + // [RFC6531]: https://tools.ietf.org/html/rfc6531 + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html + // [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html + // [RFC 3492]: http://tools.ietf.org/html/rfc3492 // // This member is required. Source *string @@ -121,26 +135,32 @@ type SendTemplatedEmailInput 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 email address specified in the ReturnPath parameter. For - // example, if the owner of example.com (which has ARN + // 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/dg/sending-authorization.html) - // . + // and the ReturnPath to be feedback@example.com . + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 + // 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/dg/sending-authorization.html) - // . + // and the Source to be user@example.com . + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html SourceArn *string // A list of tags, in the form of name/value pairs, to apply to an email that you diff --git a/service/ses/api_op_SetActiveReceiptRuleSet.go b/service/ses/api_op_SetActiveReceiptRuleSet.go index 8f757c6f779..580093d9f10 100644 --- a/service/ses/api_op_SetActiveReceiptRuleSet.go +++ b/service/ses/api_op_SetActiveReceiptRuleSet.go @@ -10,11 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 operation -// 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// 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 operation with RuleSetName set to null. +// +// For information about managing receipt rule sets, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) SetActiveReceiptRuleSet(ctx context.Context, params *SetActiveReceiptRuleSetInput, optFns ...func(*Options)) (*SetActiveReceiptRuleSetOutput, error) { if params == nil { params = &SetActiveReceiptRuleSetInput{} @@ -32,8 +37,9 @@ 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/dg/receiving-email-concepts.html) -// . +// information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 d136c92f9f7..1b71a0642ec 100644 --- a/service/ses/api_op_SetIdentityDkimEnabled.go +++ b/service/ses/api_op_SetIdentityDkimEnabled.go @@ -14,14 +14,21 @@ 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 ), -// 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 -// 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/dg/send-email-authentication-dkim-easy.html) -// . +// 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 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html func (c *Client) SetIdentityDkimEnabled(ctx context.Context, params *SetIdentityDkimEnabledInput, optFns ...func(*Options)) (*SetIdentityDkimEnabledOutput, error) { if params == nil { params = &SetIdentityDkimEnabledInput{} @@ -38,9 +45,9 @@ 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/dg/send-email-authentication-dkim-easy.html) -// . +// identity. For more information about setting up Easy DKIM, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html type SetIdentityDkimEnabledInput struct { // Sets whether DKIM signing is enabled for an identity. Set to true to enable diff --git a/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go b/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go index 5a55750ac04..4369e1524c0 100644 --- a/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go +++ b/service/ses/api_op_SetIdentityFeedbackForwardingEnabled.go @@ -13,12 +13,16 @@ import ( // Given an identity (an email address or a domain), enables or disables whether // Amazon SES forwards bounce and complaint notifications as email. Feedback // forwarding can only be disabled when Amazon Simple Notification Service (Amazon -// SNS) topics are specified for both bounces and complaints. Feedback forwarding -// 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/dg/monitor-sending-activity-using-notifications.html) -// . +// SNS) topics are specified for both bounces and complaints. +// +// Feedback forwarding 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html func (c *Client) SetIdentityFeedbackForwardingEnabled(ctx context.Context, params *SetIdentityFeedbackForwardingEnabledInput, optFns ...func(*Options)) (*SetIdentityFeedbackForwardingEnabledOutput, error) { if params == nil { params = &SetIdentityFeedbackForwardingEnabledInput{} @@ -36,8 +40,9 @@ func (c *Client) SetIdentityFeedbackForwardingEnabled(ctx context.Context, param // 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/dg/monitor-sending-activity-using-notifications-email.html) -// . +// feedback forwarding, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-email.html type SetIdentityFeedbackForwardingEnabledInput struct { // Sets whether Amazon SES forwards bounce and complaint notifications as email. diff --git a/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go b/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go index d86e2301b32..e3bb1213247 100644 --- a/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go +++ b/service/ses/api_op_SetIdentityHeadersInNotificationsEnabled.go @@ -13,10 +13,13 @@ import ( // Given an identity (an email address or a domain), sets whether Amazon SES // 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/dg/monitor-sending-activity-using-notifications.html) -// . +// (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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html func (c *Client) SetIdentityHeadersInNotificationsEnabled(ctx context.Context, params *SetIdentityHeadersInNotificationsEnabledInput, optFns ...func(*Options)) (*SetIdentityHeadersInNotificationsEnabledOutput, error) { if params == nil { params = &SetIdentityHeadersInNotificationsEnabledInput{} @@ -34,16 +37,18 @@ 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/dg/monitor-sending-activity-using-notifications-sns.html) -// . +// about notifications, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-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 includes headers in notifications, and a value of false - // specifies that Amazon SES does not include headers in notifications. This value - // can only be set when NotificationType is already set to use a particular Amazon - // SNS topic. + // specifies that Amazon SES does 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 diff --git a/service/ses/api_op_SetIdentityMailFromDomain.go b/service/ses/api_op_SetIdentityMailFromDomain.go index f007bfc1e20..1e4740c9b0c 100644 --- a/service/ses/api_op_SetIdentityMailFromDomain.go +++ b/service/ses/api_op_SetIdentityMailFromDomain.go @@ -12,12 +12,16 @@ import ( ) // Enables or disables the custom MAIL FROM domain setup for a verified identity -// (an email address or a domain). To send emails using the specified MAIL FROM -// domain, you must add an MX record to your MAIL FROM domain's DNS settings. To -// ensure that your emails 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/dg/mail-from.html) . You can -// execute this operation no more than once per second. +// (an email address or a domain). +// +// To send emails using the specified MAIL FROM domain, you must add an MX record +// to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender +// Policy Framework (SPF) checks, you must also add or update an SPF record. For +// more information, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html func (c *Client) SetIdentityMailFromDomain(ctx context.Context, params *SetIdentityMailFromDomainInput, optFns ...func(*Options)) (*SetIdentityMailFromDomainOutput, error) { if params == nil { params = &SetIdentityMailFromDomainInput{} @@ -35,8 +39,9 @@ func (c *Client) SetIdentityMailFromDomain(ctx context.Context, params *SetIdent // 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/dg/mail-from.html) -// . +// FROM domain, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html type SetIdentityMailFromDomainInput struct { // The verified identity. @@ -48,17 +53,19 @@ type SetIdentityMailFromDomainInput struct { // MX record when you send an email. If you choose UseDefaultValue , Amazon SES // uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you // choose RejectMessage , Amazon SES returns 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. + // 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 for 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/dg/mail-from.html) - // ), and 3) not be used to receive emails. A value of null disables the custom - // MAIL FROM setting for the identity. + // forwarding (for more information, see the [Amazon SES Developer Guide]), and 3) not be used to receive + // emails. A value of null disables the custom MAIL FROM setting for the identity. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/mail-from.html MailFromDomain *string noSmithyDocumentSerde diff --git a/service/ses/api_op_SetIdentityNotificationTopic.go b/service/ses/api_op_SetIdentityNotificationTopic.go index 5704310a4da..5a54a4d0ae3 100644 --- a/service/ses/api_op_SetIdentityNotificationTopic.go +++ b/service/ses/api_op_SetIdentityNotificationTopic.go @@ -16,10 +16,13 @@ import ( // identity, such as an email address or domain. When you send an email that uses // the chosen identity in the Source field, Amazon SES sends notifications to the // 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/dg/monitor-sending-activity-using-notifications.html) -// . +// (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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html func (c *Client) SetIdentityNotificationTopic(ctx context.Context, params *SetIdentityNotificationTopicInput, optFns ...func(*Options)) (*SetIdentityNotificationTopicOutput, error) { if params == nil { params = &SetIdentityNotificationTopicInput{} @@ -37,16 +40,19 @@ func (c *Client) SetIdentityNotificationTopic(ctx context.Context, params *SetId // Represents a request to specify the Amazon SNS topic to which Amazon SES // publishes 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/dg/monitor-sending-activity-using-notifications-sns.html) +// identity as the source. For information about Amazon SES notifications, see the [Amazon SES Developer Guide] // . +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications-sns.html type SetIdentityNotificationTopicInput struct { - // The identity (email address or domain) for the Amazon SNS topic. 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 . + // The identity (email address or domain) for the Amazon SNS topic. + // + // 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 . // // This member is required. Identity *string diff --git a/service/ses/api_op_SetReceiptRulePosition.go b/service/ses/api_op_SetReceiptRulePosition.go index 9b8c01dd258..72bef36da88 100644 --- a/service/ses/api_op_SetReceiptRulePosition.go +++ b/service/ses/api_op_SetReceiptRulePosition.go @@ -10,9 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// 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]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) SetReceiptRulePosition(ctx context.Context, params *SetReceiptRulePositionInput, optFns ...func(*Options)) (*SetReceiptRulePositionOutput, error) { if params == nil { params = &SetReceiptRulePositionInput{} @@ -30,8 +34,9 @@ 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/dg/receiving-email-concepts.html) -// . +// information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html type SetReceiptRulePositionInput struct { // The name of the receipt rule to reposition. diff --git a/service/ses/api_op_TestRenderTemplate.go b/service/ses/api_op_TestRenderTemplate.go index 29ae72f6206..44aa9d0c3fc 100644 --- a/service/ses/api_op_TestRenderTemplate.go +++ b/service/ses/api_op_TestRenderTemplate.go @@ -11,8 +11,9 @@ import ( ) // Creates a preview of the MIME content of an email when provided with a template -// and a set of replacement data. You can execute this operation no more than once -// per second. +// and a set of replacement data. +// +// You can execute this operation no more than once per second. func (c *Client) TestRenderTemplate(ctx context.Context, params *TestRenderTemplateInput, optFns ...func(*Options)) (*TestRenderTemplateOutput, error) { if params == nil { params = &TestRenderTemplateInput{} diff --git a/service/ses/api_op_UpdateAccountSendingEnabled.go b/service/ses/api_op_UpdateAccountSendingEnabled.go index 61959ebd9ae..2f6b86768e0 100644 --- a/service/ses/api_op_UpdateAccountSendingEnabled.go +++ b/service/ses/api_op_UpdateAccountSendingEnabled.go @@ -14,8 +14,9 @@ import ( // current Amazon Web Services Region. You can use this operation in conjunction // with Amazon CloudWatch alarms to temporarily pause email sending across your // Amazon SES account in a given Amazon Web Services Region when reputation metrics -// (such as your bounce or complaint rates) reach certain thresholds. You can -// execute this operation no more than once per second. +// (such as your bounce or complaint rates) reach certain thresholds. +// +// You can execute this operation no more than once per second. func (c *Client) UpdateAccountSendingEnabled(ctx context.Context, params *UpdateAccountSendingEnabledInput, optFns ...func(*Options)) (*UpdateAccountSendingEnabledOutput, error) { if params == nil { params = &UpdateAccountSendingEnabledInput{} diff --git a/service/ses/api_op_UpdateConfigurationSetEventDestination.go b/service/ses/api_op_UpdateConfigurationSetEventDestination.go index bd15a55c836..226502b41e0 100644 --- a/service/ses/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/ses/api_op_UpdateConfigurationSetEventDestination.go @@ -15,12 +15,15 @@ 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/dg/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 -// Service (Amazon SNS). You can execute this operation no more than once per -// second. +// sets, see [Monitoring Your Amazon SES Sending Activity]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 Service (Amazon SNS). +// +// You can execute this operation no more than once per second. +// +// [Monitoring Your Amazon SES Sending Activity]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html func (c *Client) UpdateConfigurationSetEventDestination(ctx context.Context, params *UpdateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*UpdateConfigurationSetEventDestinationOutput, error) { if params == nil { params = &UpdateConfigurationSetEventDestinationInput{} @@ -38,8 +41,9 @@ 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/dg/monitor-sending-activity.html) -// . +// about using configuration sets, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type UpdateConfigurationSetEventDestinationInput struct { // The name of the configuration set that contains the event destination. diff --git a/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go b/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go index b6a80c5ee27..82e97e15eb0 100644 --- a/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go +++ b/service/ses/api_op_UpdateConfigurationSetReputationMetricsEnabled.go @@ -14,8 +14,9 @@ import ( // a specific configuration set in a given Amazon Web Services 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. +// complaint rates exceed certain thresholds. +// +// You can execute this operation no more than once per second. func (c *Client) UpdateConfigurationSetReputationMetricsEnabled(ctx context.Context, params *UpdateConfigurationSetReputationMetricsEnabledInput, optFns ...func(*Options)) (*UpdateConfigurationSetReputationMetricsEnabledOutput, error) { if params == nil { params = &UpdateConfigurationSetReputationMetricsEnabledInput{} diff --git a/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go b/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go index 522cd56af75..0cab1527ec5 100644 --- a/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go +++ b/service/ses/api_op_UpdateConfigurationSetSendingEnabled.go @@ -15,7 +15,9 @@ import ( // operation in conjunction with Amazon CloudWatch alarms to temporarily pause // email sending for a configuration set when the reputation metrics for that // configuration set (such as your bounce on complaint rate) exceed certain -// thresholds. You can execute this operation no more than once per second. +// thresholds. +// +// You can execute this operation no more than once per second. func (c *Client) UpdateConfigurationSetSendingEnabled(ctx context.Context, params *UpdateConfigurationSetSendingEnabledInput, optFns ...func(*Options)) (*UpdateConfigurationSetSendingEnabledOutput, error) { if params == nil { params = &UpdateConfigurationSetSendingEnabledInput{} diff --git a/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go b/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go index 5bb99a2324b..2d1c66f654d 100644 --- a/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go +++ b/service/ses/api_op_UpdateConfigurationSetTrackingOptions.go @@ -12,11 +12,13 @@ import ( ) // 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/dg/configure-custom-open-click-domains.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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{} @@ -42,9 +44,11 @@ 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/dg/configure-custom-open-click-domains.html) - // in the Amazon SES Developer Guide. + // emails. + // + // For more information, see [Configuring Custom Domains to Handle Open and Click Tracking] in the Amazon SES Developer Guide. + // + // [Configuring Custom Domains to Handle Open and Click Tracking]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html // // This member is required. TrackingOptions *types.TrackingOptions diff --git a/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go b/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go index 14ccc51a123..641cde2df1a 100644 --- a/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go +++ b/service/ses/api_op_UpdateCustomVerificationEmailTemplate.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// Updates an existing custom verification email template. +// +// For more information about custom verification email templates, see [Using Custom Verification Email Templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using Custom Verification Email Templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, params *UpdateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*UpdateCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &UpdateCustomVerificationEmailTemplateInput{} @@ -51,8 +54,9 @@ 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) - // in the Amazon SES Developer Guide. + // For more information, see [Custom Verification Email Frequently Asked Questions]in the Amazon SES Developer Guide. + // + // [Custom Verification Email Frequently Asked Questions]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom TemplateContent *string // The subject line of the custom verification email. diff --git a/service/ses/api_op_UpdateReceiptRule.go b/service/ses/api_op_UpdateReceiptRule.go index c69f0b9b850..079650f2531 100644 --- a/service/ses/api_op_UpdateReceiptRule.go +++ b/service/ses/api_op_UpdateReceiptRule.go @@ -11,9 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a receipt rule. For information about managing receipt rules, see the -// Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . You can execute this operation no more than once per second. +// Updates a receipt rule. +// +// For information about managing receipt rules, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html func (c *Client) UpdateReceiptRule(ctx context.Context, params *UpdateReceiptRuleInput, optFns ...func(*Options)) (*UpdateReceiptRuleOutput, error) { if params == nil { params = &UpdateReceiptRuleInput{} @@ -30,8 +34,9 @@ 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/dg/receiving-email-concepts.html) -// . +// email with Amazon SES. For more information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 c222f602367..78b7efec104 100644 --- a/service/ses/api_op_UpdateTemplate.go +++ b/service/ses/api_op_UpdateTemplate.go @@ -13,8 +13,11 @@ import ( // Updates an email template. Email templates enable you to send personalized // email to one or more destinations in a single operation. For more information, -// see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html) -// . You can execute this operation no more than once per second. +// see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html 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 7992f258716..a202c19106d 100644 --- a/service/ses/api_op_VerifyDomainDkim.go +++ b/service/ses/api_op_VerifyDomainDkim.go @@ -10,28 +10,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a set of DKIM tokens for a domain identity. When you execute the -// VerifyDomainDkim operation, the domain that you specify is added to the list of -// 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/dg/creating-identities.html#verify-domain-procedure) -// or you successfully set up DKIM for it (https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html) -// . You use the tokens that are generated by this operation to create CNAME +// Returns a set of DKIM tokens for a domain identity. +// +// When you execute the VerifyDomainDkim operation, the domain that you specify is +// added to the list of 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]or you successfully [set up DKIM for it]. +// +// 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: +// 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 // // 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. +// Repeat this process for each token that's generated by this operation. +// +// You can execute this operation no more than once per second. +// +// [verify it]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure +// [set up DKIM for it]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html func (c *Client) VerifyDomainDkim(ctx context.Context, params *VerifyDomainDkimInput, optFns ...func(*Options)) (*VerifyDomainDkimOutput, error) { if params == nil { params = &VerifyDomainDkimInput{} @@ -48,9 +57,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/dg/send-email-authentication-dkim-easy.html) -// . +// with Amazon SES. For more information about setting up Easy DKIM, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html type VerifyDomainDkimInput struct { // The name of the domain to be verified for Easy DKIM signing. @@ -67,14 +76,17 @@ 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/dg/send-email-authentication-dkim-easy.html) - // . + // email address identities.) + // + // For more information about creating DNS records using DKIM tokens, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html // // This member is required. DkimTokens []string diff --git a/service/ses/api_op_VerifyDomainIdentity.go b/service/ses/api_op_VerifyDomainIdentity.go index eba064d9f83..77d4d85c441 100644 --- a/service/ses/api_op_VerifyDomainIdentity.go +++ b/service/ses/api_op_VerifyDomainIdentity.go @@ -12,9 +12,11 @@ import ( // Adds a domain to the list of identities for your Amazon SES account in the // current Amazon Web Services 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/dg/verify-addresses-and-domains.html) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// information about verifying domains, see [Verifying Email Addresses and Domains]in the Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Verifying Email Addresses and Domains]: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html func (c *Client) VerifyDomainIdentity(ctx context.Context, params *VerifyDomainIdentityInput, optFns ...func(*Options)) (*VerifyDomainIdentityOutput, error) { if params == nil { params = &VerifyDomainIdentityInput{} @@ -32,9 +34,9 @@ func (c *Client) VerifyDomainIdentity(ctx context.Context, params *VerifyDomainI // 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/dg/creating-identities.html#verify-domain-procedure) -// . +// complete the verification. For information about domain verification, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-domain-procedure type VerifyDomainIdentityInput struct { // The domain to be verified. @@ -50,13 +52,15 @@ type VerifyDomainIdentityInput struct { type VerifyDomainIdentityOutput struct { // A TXT record that you must place in the DNS settings of the domain to complete - // domain verification with Amazon SES. As Amazon SES searches for the TXT record, - // the domain's verification status is "Pending". When Amazon SES detects the - // record, the domain's verification status changes to "Success". If Amazon SES is - // unable to detect the record within 72 hours, the domain's verification status - // changes to "Failed." In that case, to verify the domain, you must restart the - // verification process from the beginning. The domain's verification status also - // changes to "Success" when it is DKIM verified. + // domain verification with Amazon SES. + // + // As Amazon SES searches for the TXT record, the domain's verification status is + // "Pending". When Amazon SES detects the record, the domain's verification status + // changes to "Success". If Amazon SES is unable to detect the record within 72 + // hours, the domain's verification status changes to "Failed." In that case, to + // verify the domain, you must restart the verification process from the beginning. + // The domain's verification status also changes to "Success" when it is DKIM + // verified. // // This member is required. VerificationToken *string diff --git a/service/ses/api_op_VerifyEmailAddress.go b/service/ses/api_op_VerifyEmailAddress.go index 8af3c6d791b..5a1f80bcaf0 100644 --- a/service/ses/api_op_VerifyEmailAddress.go +++ b/service/ses/api_op_VerifyEmailAddress.go @@ -27,8 +27,9 @@ 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/dg/creating-identities.html#verify-email-addresses-procedure) -// . +// information about email address verification, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure 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 7d991d4a27d..188f1dd8230 100644 --- a/service/ses/api_op_VerifyEmailIdentity.go +++ b/service/ses/api_op_VerifyEmailIdentity.go @@ -13,6 +13,7 @@ import ( // Adds an email address to the list of identities for your Amazon SES account in // the current Amazon Web Services Region and attempts to verify it. As a result of // executing this operation, a verification email is sent to the specified address. +// // You can execute this operation no more than once per second. func (c *Client) VerifyEmailIdentity(ctx context.Context, params *VerifyEmailIdentityInput, optFns ...func(*Options)) (*VerifyEmailIdentityOutput, error) { if params == nil { @@ -30,8 +31,9 @@ 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/dg/creating-identities.html#verify-email-addresses-procedure) -// . +// information about email address verification, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#verify-email-addresses-procedure type VerifyEmailIdentityInput struct { // The email address to be verified. diff --git a/service/ses/doc.go b/service/ses/doc.go index 9c58986b8f1..6ac45a57c5f 100644 --- a/service/ses/doc.go +++ b/service/ses/doc.go @@ -3,16 +3,28 @@ // 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, -// 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) -// . This documentation contains reference information related to the following: -// - Amazon SES API Actions (https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html) -// - Amazon SES API Data Types (https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html) -// - Common Parameters (https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html) -// - Common Errors (https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html) +// # Amazon Simple Email Service +// +// This document contains reference information for the [Amazon Simple Email Service] (Amazon SES) API, version +// 2010-12-01. This document is best used in conjunction with the [Amazon SES Developer Guide]. +// +// For a list of Amazon SES endpoints to use in service requests, see [Regions and Amazon SES] in the [Amazon SES Developer Guide]. +// +// This documentation contains reference information related to the following: +// +// [Amazon SES API Actions] +// +// [Amazon SES API Data Types] +// +// [Common Parameters] +// +// [Common Errors] +// +// [Regions and Amazon SES]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html +// [Common Errors]: https://docs.aws.amazon.com/ses/latest/APIReference/CommonErrors.html +// [Amazon SES API Data Types]: https://docs.aws.amazon.com/ses/latest/APIReference/API_Types.html +// [Amazon Simple Email Service]: https://aws.amazon.com/ses/ +// [Amazon SES API Actions]: https://docs.aws.amazon.com/ses/latest/APIReference/API_Operations.html +// [Common Parameters]: https://docs.aws.amazon.com/ses/latest/APIReference/CommonParameters.html +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html package ses diff --git a/service/ses/options.go b/service/ses/options.go index 4228f8c9284..a641f33debe 100644 --- a/service/ses/options.go +++ b/service/ses/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ses/types/enums.go b/service/ses/types/enums.go index c1eee5e3078..f3e62226475 100644 --- a/service/ses/types/enums.go +++ b/service/ses/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BehaviorOnMXFailure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BehaviorOnMXFailure) Values() []BehaviorOnMXFailure { return []BehaviorOnMXFailure{ "UseDefaultValue", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for BounceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BounceType) Values() []BounceType { return []BounceType{ "DoesNotExist", @@ -67,8 +69,9 @@ const ( ) // Values returns all known values for BulkEmailStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BulkEmailStatus) Values() []BulkEmailStatus { return []BulkEmailStatus{ "Success", @@ -100,6 +103,7 @@ const ( // Values returns all known values for ConfigurationSetAttribute. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationSetAttribute) Values() []ConfigurationSetAttribute { return []ConfigurationSetAttribute{ @@ -121,8 +125,9 @@ const ( ) // Values returns all known values for CustomMailFromStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomMailFromStatus) Values() []CustomMailFromStatus { return []CustomMailFromStatus{ "Pending", @@ -142,8 +147,9 @@ const ( ) // Values returns all known values for DimensionValueSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionValueSource) Values() []DimensionValueSource { return []DimensionValueSource{ "messageTag", @@ -164,8 +170,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -191,8 +198,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -215,8 +223,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -233,8 +242,9 @@ const ( ) // Values returns all known values for InvocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InvocationType) Values() []InvocationType { return []InvocationType{ "Event", @@ -252,8 +262,9 @@ const ( ) // Values returns all known values for NotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationType) Values() []NotificationType { return []NotificationType{ "Bounce", @@ -271,8 +282,9 @@ const ( ) // Values returns all known values for ReceiptFilterPolicy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReceiptFilterPolicy) Values() []ReceiptFilterPolicy { return []ReceiptFilterPolicy{ "Block", @@ -289,8 +301,9 @@ const ( ) // Values returns all known values for SNSActionEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SNSActionEncoding) Values() []SNSActionEncoding { return []SNSActionEncoding{ "UTF-8", @@ -306,8 +319,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -323,8 +337,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -344,8 +359,9 @@ const ( ) // Values returns all known values for VerificationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationStatus) Values() []VerificationStatus { return []VerificationStatus{ "Pending", diff --git a/service/ses/types/errors.go b/service/ses/types/errors.go index f3158800915..e807173ffdb 100644 --- a/service/ses/types/errors.go +++ b/service/ses/types/errors.go @@ -8,8 +8,8 @@ import ( ) // 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 . +// +// You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled. type AccountSendingPausedException struct { Message *string @@ -152,9 +152,9 @@ func (e *ConfigurationSetDoesNotExistException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that email sending is disabled for the configuration set. You can -// enable or disable email sending for a configuration set using -// UpdateConfigurationSetSendingEnabled . +// Indicates that email sending is disabled for the configuration set. +// +// You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled. type ConfigurationSetSendingPausedException struct { Message *string @@ -488,9 +488,9 @@ func (e *InvalidFirehoseDestinationException) ErrorFault() smithy.ErrorFault { // Indicates that the provided Amazon Web Services 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) -// . +// permissions issues. For information about giving permissions, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html type InvalidLambdaFunctionException struct { Message *string @@ -579,8 +579,9 @@ func (e *InvalidRenderingParameterException) ErrorFault() smithy.ErrorFault { // Indicates that the provided Amazon S3 bucket or Amazon Web Services 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) -// . +// see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html type InvalidS3ConfigurationException struct { Message *string @@ -640,8 +641,9 @@ 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html type InvalidSnsTopicException struct { Message *string @@ -702,6 +704,7 @@ func (e *InvalidTemplateException) ErrorFault() smithy.ErrorFault { return smith // redirects is invalid. This error appears most often in the following situations: // // - 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 @@ -729,8 +732,9 @@ 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html type LimitExceededException struct { Message *string @@ -756,11 +760,12 @@ func (e *LimitExceededException) ErrorCode() string { } func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates that the message could not be sent because Amazon SES could not read +// 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) -// . +// about editing the custom MAIL FROM domain settings for an identity, see the [Amazon SES Developer Guide]. +// +// [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 f500a9ce833..33c7a3b5783 100644 --- a/service/ses/types/types.go +++ b/service/ses/types/types.go @@ -8,9 +8,11 @@ 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/dg/receiving-email-action-add-header.html) -// . +// email. +// +// For information about adding a header using a receipt rule, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-add-header.html type AddHeaderAction struct { // The name of the header to add to the incoming message. The name must contain at @@ -48,10 +50,12 @@ type Body struct { // When included in a receipt rule, this action rejects the received email by // 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/dg/receiving-email-action-bounce.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-bounce.html type BounceAction struct { // Human-readable text to include in the bounce message. @@ -65,31 +69,37 @@ 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]. + // + // [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]. + // + // [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. You can find the ARN of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // operation in Amazon SNS. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // bounce action is taken. You can find the ARN of a topic by using the [ListTopics]operation + // in Amazon SNS. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html TopicArn *string noSmithyDocumentSerde } // 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/dg/receiving-email.html) -// . +// (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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html type BouncedRecipientInfo struct { // The email address of the recipient of the bounced email. @@ -104,8 +114,9 @@ type BouncedRecipientInfo 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 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/dg/sending-authorization.html) - // . + // information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/sending-authorization.html RecipientArn *string // Recipient-related DSN fields, most of which would normally be filled in @@ -121,17 +132,20 @@ type BouncedRecipientInfo struct { 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 email - // address string must be 7-bit ASCII. If you want to send to or from email - // addresses that contain Unicode characters in the domain part of an address, you - // must encode the domain using Punycode. Punycode is not permitted in the local - // part of the email address (the part before the @ sign) nor in the "friendly - // from" name. If you want to use Unicode characters in the "friendly from" name, - // you must encode the "friendly from" name using MIME encoded-word syntax, as - // described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) - // . For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492) - // . + // fields. + // + // Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this + // reason, the email address string must be 7-bit ASCII. If you want to send to or + // from email addresses that contain Unicode characters in the domain part of an + // address, you must encode the domain using Punycode. Punycode is not permitted in + // the local part of the email address (the part before the @ sign) nor in the + // "friendly from" name. If you want to use Unicode characters in the "friendly + // from" name, you must encode the "friendly from" name using MIME encoded-word + // syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492]. + // + // [RFC6531]: https://tools.ietf.org/html/rfc6531 + // [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html + // [RFC 3492]: http://tools.ietf.org/html/rfc3492 // // This member is required. Destination *Destination @@ -161,32 +175,47 @@ type BulkEmailDestinationStatus struct { MessageId *string // The status of a message sent using the SendBulkTemplatedEmail operation. + // // Possible values for this parameter include: + // // - Success : Amazon SES accepted the message, and attempts 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. + // using the UpdateAccountSendingEnabledoperation. + // // - ConfigurationSetSendingPaused : Email sending for this configuration set was - // disabled using the UpdateConfigurationSetSendingEnabled operation. + // disabled using the UpdateConfigurationSetSendingEnabledoperation. + // // - 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 @@ -195,11 +224,13 @@ type BulkEmailDestinationStatus struct { } // Contains information associated with an Amazon CloudWatch event destination to -// 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/dg/monitor-sending-activity.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type CloudWatchDestination struct { // A list of dimensions upon which to categorize your emails when you publish @@ -212,16 +243,21 @@ 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/dg/monitor-sending-activity.html) -// . +// events to Amazon CloudWatch. +// +// For information about publishing email sending events to Amazon CloudWatch, see +// the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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 meet the following requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), // dashes (-), at signs (@), or periods (.). + // // - Contain 256 characters or fewer. // // This member is required. @@ -229,8 +265,10 @@ type CloudWatchDimensionConfiguration struct { // The name of an Amazon CloudWatch dimension associated with an email sending // metric. The name must meet the following requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), // dashes (-), or colons (:). + // // - Contain 256 characters or fewer. // // This member is required. @@ -248,17 +286,22 @@ type CloudWatchDimensionConfiguration struct { noSmithyDocumentSerde } -// 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/dg/using-configuration-sets.html) -// in the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/) . +// 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]in the [Amazon SES Developer Guide]. +// +// [Using Amazon SES Configuration Sets]: https://docs.aws.amazon.com/ses/latest/dg/using-configuration-sets.html +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/ 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. // // This member is required. @@ -267,8 +310,9 @@ type ConfigurationSet struct { noSmithyDocumentSerde } -// Represents textual data, plus an optional character set specification. By -// default, the text must be 7-bit ASCII, due to the constraints of the SMTP +// Represents textual data, plus an optional character set specification. +// +// By default, the text must be 7-bit ASCII, due to the constraints of the SMTP // protocol. If the text must contain any other characters, then you must also // specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS. type Content struct { @@ -322,17 +366,20 @@ 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 email -// address string must be 7-bit ASCII. If you want to send to or from email -// addresses that contain Unicode characters in the domain part of an address, you -// must encode the domain using Punycode. Punycode is not permitted in the local -// part of the email address (the part before the @ sign) nor in the "friendly -// from" name. If you want to use Unicode characters in the "friendly from" name, -// you must encode the "friendly from" name using MIME encoded-word syntax, as -// described in Sending raw email using the Amazon SES API (https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html) -// . For more information about Punycode, see RFC 3492 (http://tools.ietf.org/html/rfc3492) -// . +// fields. +// +// Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this +// reason, the email address string must be 7-bit ASCII. If you want to send to or +// from email addresses that contain Unicode characters in the domain part of an +// address, you must encode the domain using Punycode. Punycode is not permitted in +// the local part of the email address (the part before the @ sign) nor in the +// "friendly from" name. If you want to use Unicode characters in the "friendly +// from" name, you must encode the "friendly from" name using MIME encoded-word +// syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492]. +// +// [RFC6531]: https://tools.ietf.org/html/rfc6531 +// [Sending raw email using the Amazon SES API]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html +// [RFC 3492]: http://tools.ietf.org/html/rfc3492 type Destination struct { // The recipients to place on the BCC: line of the message. @@ -347,29 +394,40 @@ type Destination struct { noSmithyDocumentSerde } -// Contains information about an event destination. 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 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/dg/monitor-sending-activity.html) -// . +// Contains information about an event destination. +// +// 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 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type EventDestination struct { // The type of email sending events to publish to the event destination. + // // - send - The call was successful and Amazon SES is attempting to deliver the // email. + // // - reject - Amazon SES determined that the email contained a virus and rejected // it. + // // - bounce - The recipient's mail server permanently rejected the email. This // corresponds to a hard bounce. + // // - complaint - The recipient marked the email as spam. + // // - delivery - Amazon SES successfully delivered the email to the recipient's // mail server. + // // - open - The recipient received the email and opened it in their email client. + // // - click - The recipient clicked one or more links in the email. + // // - renderingFailure - Amazon SES did not send the email because of a template // rendering issue. // @@ -378,8 +436,10 @@ type EventDestination struct { // The name of the event destination. The name must meet the following // requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Contain 64 characters or fewer. // // This member is required. @@ -407,9 +467,11 @@ 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/dg/receiving-email.html) -// . +// an email that Amazon SES receives on your behalf bounces. +// +// For information about receiving email through Amazon SES, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email.html type ExtensionField struct { // The name of the header to add. Must be between 1 and 50 characters, inclusive, @@ -449,9 +511,11 @@ type IdentityDkimAttributes struct { // 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/dg/send-email-authentication-dkim-easy.html) - // . + // identities.) + // + // For more information about creating DNS records using DKIM tokens, see the [Amazon SES Developer Guide]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html DkimTokens []string noSmithyDocumentSerde @@ -466,9 +530,10 @@ type IdentityMailFromDomainAttributes struct { // Amazon SES cannot read the required MX record, it uses amazonses.com (or a // 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 . + // MailFromDomainNotVerified error and does not send the email. + // + // The custom MAIL FROM setup states that result in this behavior are Pending , + // Failed , and TemporaryFailure . // // This member is required. BehaviorOnMXFailure BehaviorOnMXFailure @@ -560,11 +625,13 @@ type IdentityVerificationAttributes struct { } // Contains the delivery stream ARN and the IAM role ARN associated with an Amazon -// 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/dg/monitor-sending-activity.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type KinesisFirehoseDestination struct { // The ARN of the Amazon Kinesis Firehose stream that email sending events should @@ -584,20 +651,25 @@ type KinesisFirehoseDestination struct { // When included in a receipt rule, this action calls an Amazon Web Services // Lambda function and, optionally, publishes a notification to Amazon Simple -// Notification Service (Amazon SNS). To enable Amazon SES to call your Amazon Web -// Services 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/dg/receiving-email-permissions.html) -// . For information about using Amazon Web Services Lambda actions in receipt -// rules, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html) -// . +// Notification Service (Amazon SNS). +// +// To enable Amazon SES to call your Amazon Web Services 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]. +// +// For information about using Amazon Web Services Lambda actions in receipt +// rules, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-lambda.html type LambdaAction struct { // The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An // example of an Amazon Web Services Lambda function ARN is // arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information - // about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer - // Guide (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) . + // about Amazon Web Services Lambda, see the [Amazon Web Services Lambda Developer Guide]. + // + // [Amazon Web Services Lambda Developer Guide]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html // // This member is required. FunctionArn *string @@ -606,19 +678,23 @@ type LambdaAction struct { // type of RequestResponse means that the execution of the function immediately // results in a response, and a value of Event means that the function is invoked // asynchronously. The default value is Event . For information about Amazon Web - // Services Lambda invocation types, see the Amazon Web Services 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 to make a mail flow + // Services Lambda invocation types, see the [Amazon Web Services Lambda Developer Guide]. + // + // There is a 30-second timeout on RequestResponse invocations. You should use + // Event invocation in most cases. Use RequestResponse only to make a mail flow // decision, such as whether to stop the receipt rule or the receipt rule set. + // + // [Amazon Web Services Lambda Developer Guide]: https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html InvocationType InvocationType // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the - // Lambda action is executed. You can find the ARN of a topic by using the - // ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // operation in Amazon SNS. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // Lambda action is executed. You can find the ARN of a topic by using the [ListTopics] + // operation in Amazon SNS. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html TopicArn *string noSmithyDocumentSerde @@ -642,21 +718,26 @@ type Message struct { } // 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/dg/receiving-email.html) -// . +// (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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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]( mta-name-type; mta-name ). The default value is dns; + // inbound-smtp.[region].amazonaws.com . + // + // [RFC 3464]: https://tools.ietf.org/html/rfc3464 // // 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] + // date-time format. + // + // [RFC 822]: https://www.ietf.org/rfc/rfc0822.txt ArrivalDate *time.Time // Additional X-headers to include in the DSN. @@ -666,23 +747,29 @@ 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/dg/monitor-sending-activity.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type MessageTag struct { // The name of the tag. The name must meet the following requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Contain 256 characters or fewer. // // This member is required. Name *string // The value of the tag. The value must meet the following requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Contain 256 characters or fewer. // // This member is required. @@ -699,14 +786,20 @@ type RawMessage struct { // Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base // 64-encoding for you. In all cases, the client must ensure that the message // format complies with Internet email standards regarding email header fields, - // MIME types, and MIME 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 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/dg/send-email-raw.html) - // . + // MIME types, and MIME 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 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]. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html // // This member is required. Data []byte @@ -716,9 +809,11 @@ type RawMessage struct { // 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . +// can represent only one action. +// +// For information about setting up receipt rules, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html type ReceiptAction struct { // Adds a header to the received email. @@ -752,9 +847,11 @@ 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/dg/receiving-email-ip-filtering-console-walkthrough.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html type ReceiptFilter struct { // A structure that provides the IP addresses to block or allow, and whether to @@ -765,9 +862,12 @@ type ReceiptFilter struct { // The name of the IP address filter. The name must meet the following // requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Start and end with a letter or number. + // // - Contain 64 characters or fewer. // // This member is required. @@ -777,16 +877,19 @@ 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/dg/receiving-email-ip-filtering-console-walkthrough.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-ip-filtering-console-walkthrough.html type ReceiptIpFilter struct { // A single IP address or a range of IP addresses 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) - // . + // more information about CIDR notation, see [RFC 2317]. + // + // [RFC 2317]: https://tools.ietf.org/html/rfc2317 // // This member is required. Cidr *string @@ -802,18 +905,25 @@ type ReceiptIpFilter struct { // 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/dg/receiving-email-receipt-rules-console-walkthrough.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html type ReceiptRule struct { // The name of the receipt rule. The name must meet the following requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), // dashes (-), or periods (.). + // // - Start and end with a letter or number. + // // - Contain 64 characters or fewer. // // This member is required. @@ -844,21 +954,26 @@ type ReceiptRule struct { noSmithyDocumentSerde } -// 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/dg/receiving-email-concepts.html#receiving-email-concepts-rules) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-concepts.html#receiving-email-concepts-rules 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 meet the following - // requirements: + // The name of the receipt rule set. The name must meet the following requirements: + // // - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or // dashes (-). + // // - Start and end with a letter or number. + // // - Contain 64 characters or fewer. Name *string @@ -866,28 +981,33 @@ 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/dg/receiving-email.html) -// . +// (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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/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]. + // + // [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]. + // + // [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]for the correct formatting of this parameter. + // + // [RFC 3463]: https://tools.ietf.org/html/rfc3463 DiagnosticCode *string // Additional X-headers to include in the DSN. @@ -897,18 +1017,24 @@ type RecipientDsnFields struct { // corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient // is 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 original bounced message. + // + // Do not prepend the FinalRecipient email address with rfc 822; , as described in [RFC 3798] + // . + // + // [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] date-time format. + // + // [RFC 822]: https://www.ietf.org/rfc/rfc0822.txt 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 - // bounces. + // specified in [RFC 3464]( mta-name-type; mta-name ). This parameter typically applies only + // to propagating synchronous bounces. + // + // [RFC 3464]: https://tools.ietf.org/html/rfc3464 RemoteMta *string noSmithyDocumentSerde @@ -918,17 +1044,20 @@ type RecipientDsnFields struct { 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 . + // 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 , + // 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 . ReputationMetricsEnabled bool @@ -936,7 +1065,7 @@ type ReputationOptions struct { // set. If the value is true , then Amazon SES sends emails that use the // configuration set. If the value is false , Amazon SES does not send emails that // use the configuration set. The default value is true . You can change this - // setting using UpdateConfigurationSetSendingEnabled . + // setting using UpdateConfigurationSetSendingEnabled. SendingEnabled bool noSmithyDocumentSerde @@ -944,16 +1073,19 @@ type ReputationOptions struct { // When included in a receipt rule, this action saves the received message to an // Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a -// notification to Amazon Simple Notification Service (Amazon SNS). To enable -// Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services -// 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 granting permissions, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html) -// . When you save your emails to an Amazon S3 bucket, the maximum email size -// (including headers) is 40 MB. Emails larger than that bounces. For information -// about specifying Amazon S3 actions in receipt rules, see the Amazon SES -// Developer Guide (https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html) -// . +// notification to Amazon Simple Notification Service (Amazon SNS). +// +// To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon +// Web Services 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 granting permissions, see the [Amazon SES Developer Guide]. +// +// When you save your emails to an Amazon S3 bucket, the maximum email size +// (including headers) is 40 MB. Emails larger than that bounces. +// +// For information about specifying Amazon S3 actions in receipt rules, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html type S3Action struct { // The name of the Amazon S3 bucket for incoming email. @@ -964,6 +1096,7 @@ type S3Action struct { // 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 that you created in Amazon Web Services 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 Amazon Web Services account ID is 123456789012 and you want to use the @@ -971,25 +1104,29 @@ type S3Action struct { // 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 that you created in Amazon Web Services 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/dg/receiving-email-permissions.html) - // . - // For more information about key policies, see the Amazon Web Services KMS - // Developer Guide (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) - // . If you do not specify a master key, Amazon SES does not encrypt your emails. + // giving permissions, see the [Amazon SES Developer Guide]. + // + // For more information about key policies, see the [Amazon Web Services KMS Developer Guide]. If you do not specify a + // master key, Amazon SES does 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 Amazon Web Services KMS keys for - // decryption. This encryption client is currently available with the Amazon Web - // Services SDK for Java (http://aws.amazon.com/sdk-for-java/) and Amazon Web - // Services SDK for Ruby (http://aws.amazon.com/sdk-for-ruby/) only. For more - // information about client-side encryption using Amazon Web Services KMS master - // keys, see the Amazon S3 Developer Guide (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) - // . + // decryption. This encryption client is currently available with the [Amazon Web Services SDK for Java]and [Amazon Web Services SDK for Ruby] only. + // For more information about client-side encryption using Amazon Web Services KMS + // master keys, see the [Amazon S3 Developer Guide]. + // + // [Amazon Web Services KMS Developer Guide]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html + // [Amazon Web Services SDK for Ruby]: http://aws.amazon.com/sdk-for-ruby/ + // [Amazon S3 Developer Guide]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html + // [Amazon Web Services SDK for Java]: http://aws.amazon.com/sdk-for-java/ KmsKeyArn *string // The key prefix of the Amazon S3 bucket. The key prefix is similar to a @@ -998,10 +1135,13 @@ type S3Action struct { ObjectKeyPrefix *string // The ARN of the Amazon SNS topic to notify when the message is saved to the - // Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // operation in Amazon SNS. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // Amazon S3 bucket. You can find the ARN of a topic by using the [ListTopics]operation in + // Amazon SNS. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html TopicArn *string noSmithyDocumentSerde @@ -1033,23 +1173,30 @@ type SendDataPoint struct { // Simple Notification Service (Amazon SNS). This action includes a complete copy // of the email content in the Amazon SNS notifications. Amazon SNS notifications // for all other actions simply provide information about the email. They do not -// include the email content itself. If you own the Amazon SNS topic, you don't -// 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/dg/receiving-email-permissions.html) -// . You can only publish emails that are 150 KB or less (including the header) to +// include the email content itself. +// +// If you own the Amazon SNS topic, you don't 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]. +// +// You can only publish emails that are 150 KB or less (including the header) to // Amazon SNS. Larger emails 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/dg/receiving-email-action-sns.html) -// . +// use the S3 action instead. +// +// For information about using a receipt rule to publish an Amazon SNS +// notification, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-sns.html type SNSAction struct { // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find - // the ARN of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // operation in Amazon SNS. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // the ARN of a topic by using the [ListTopics]operation in Amazon SNS. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html // // This member is required. TopicArn *string @@ -1064,18 +1211,22 @@ type SNSAction struct { } // Contains the topic ARN associated with an Amazon Simple Notification Service -// (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/dg/monitor-sending-activity.html) -// . +// (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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity.html type SNSDestination struct { // The ARN of the Amazon SNS topic for email sending events. You can find the ARN - // of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // Amazon SNS operation. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // of a topic by using the [ListTopics]Amazon SNS operation. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html // // This member is required. TopicARN *string @@ -1085,9 +1236,11 @@ 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/dg/receiving-email-action-stop.html) -// . +// Notification Service (Amazon SNS). +// +// For information about setting a stop action in a receipt rule, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-stop.html type StopAction struct { // The scope of the StopAction. The only acceptable value is RuleSet . @@ -1096,10 +1249,13 @@ type StopAction struct { Scope StopScope // The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop - // action is taken. You can find the ARN of a topic by using the ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // Amazon SNS operation. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // action is taken. You can find the ARN of a topic by using the [ListTopics]Amazon SNS + // operation. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html TopicArn *string noSmithyDocumentSerde @@ -1142,9 +1298,11 @@ 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/dg/configure-custom-open-click-domains.html) -// in the Amazon SES Developer Guide. +// emails. +// +// For more information, see [Configuring Custom Domains to Handle Open and Click Tracking] in the Amazon SES Developer Guide. +// +// [Configuring Custom Domains to Handle Open and Click Tracking]: https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html type TrackingOptions struct { // The custom subdomain that is used to redirect email recipients to the Amazon @@ -1157,28 +1315,38 @@ type TrackingOptions struct { // When included in a receipt rule, this action calls Amazon WorkMail and, // optionally, publishes a notification to Amazon Simple Notification Service // (Amazon SNS). It usually isn't necessary to set this up manually, 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/dg/receiving-email-action-workmail.html) -// . +// 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]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html type WorkmailAction struct { // The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon - // WorkMail ARNs use the following format: arn:aws:workmail:::organization/ You - // can find the ID of your organization by using the ListOrganizations (https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html) - // operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with " m- - // ", followed by a string of alphanumeric characters. For information about Amazon - // WorkMail organizations, see the Amazon WorkMail Administrator Guide (https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html) - // . + // WorkMail ARNs use the following format: + // + // arn:aws:workmail:::organization/ + // + // You can find the ID of your organization by using the [ListOrganizations] operation in Amazon + // WorkMail. Amazon WorkMail organization IDs begin with " m- ", followed by a + // string of alphanumeric characters. + // + // For information about Amazon WorkMail organizations, see the [Amazon WorkMail Administrator Guide]. + // + // [ListOrganizations]: https://docs.aws.amazon.com/workmail/latest/APIReference/API_ListOrganizations.html + // [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. You can find the ARN of a topic by using the - // ListTopics (https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) - // operation in Amazon SNS. For more information about Amazon SNS topics, see the - // Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) - // . + // WorkMail action is called. You can find the ARN of a topic by using the [ListTopics] + // operation in Amazon SNS. + // + // For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [ListTopics]: https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html TopicArn *string noSmithyDocumentSerde diff --git a/service/sesv2/api_op_BatchGetMetricData.go b/service/sesv2/api_op_BatchGetMetricData.go index 7a8b9539f1c..fccb5718d4d 100644 --- a/service/sesv2/api_op_BatchGetMetricData.go +++ b/service/sesv2/api_op_BatchGetMetricData.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves batches of metric data collected based on your sending activity. You -// can execute this operation no more than 16 times per second, and with at most -// 160 queries from the batches per second (cumulative). +// Retrieves batches of metric data collected based on your sending activity. +// +// You can execute this operation no more than 16 times per second, and with at +// most 160 queries from the batches per second (cumulative). func (c *Client) BatchGetMetricData(ctx context.Context, params *BatchGetMetricDataInput, optFns ...func(*Options)) (*BatchGetMetricDataOutput, error) { if params == nil { params = &BatchGetMetricDataInput{} diff --git a/service/sesv2/api_op_CreateConfigurationSetEventDestination.go b/service/sesv2/api_op_CreateConfigurationSetEventDestination.go index 4eb6bfa43c0..6a0a96ea018 100644 --- a/service/sesv2/api_op_CreateConfigurationSetEventDestination.go +++ b/service/sesv2/api_op_CreateConfigurationSetEventDestination.go @@ -16,8 +16,9 @@ import ( // 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. A single configuration set can include more than one event -// destination. +// long-term storage. +// +// A single configuration set can include more than one event destination. func (c *Client) CreateConfigurationSetEventDestination(ctx context.Context, params *CreateConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*CreateConfigurationSetEventDestinationOutput, error) { if params == nil { params = &CreateConfigurationSetEventDestinationInput{} diff --git a/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go b/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go index b68d5ea6fcc..d643547c4ac 100644 --- a/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_CreateCustomVerificationEmailTemplate.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// Creates a new custom verification email template. +// +// For more information about custom verification email templates, see [Using custom verification email templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using custom verification email templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) CreateCustomVerificationEmailTemplate(ctx context.Context, params *CreateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*CreateCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &CreateCustomVerificationEmailTemplateInput{} @@ -52,8 +55,9 @@ 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) - // in the Amazon SES Developer Guide. + // For more information, see [Custom verification email frequently asked questions]in the Amazon SES Developer Guide. + // + // [Custom verification email frequently asked questions]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq // // This member is required. TemplateContent *string diff --git a/service/sesv2/api_op_CreateEmailIdentity.go b/service/sesv2/api_op_CreateEmailIdentity.go index e7a7bb02995..8227b66e826 100644 --- a/service/sesv2/api_op_CreateEmailIdentity.go +++ b/service/sesv2/api_op_CreateEmailIdentity.go @@ -15,27 +15,35 @@ import ( // address or domain that you use when you send email. Before you can use an // identity to send email, you first have to verify it. By verifying an identity, // you demonstrate that you're the owner of the identity, and that you've given -// Amazon SES API v2 permission to send email from the identity. When you verify an -// email address, Amazon SES sends an email to the address. Your email address is -// verified as soon as you follow the link in the verification email. When you -// verify a domain without specifying the DkimSigningAttributes object, this -// 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 +// Amazon SES API v2 permission to send email from the identity. +// +// When you verify an email address, Amazon SES sends an email to the address. +// Your email address is verified as soon as you follow the link in the +// verification email. +// +// When you verify a domain without specifying the DkimSigningAttributes object, +// this 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]. +// +// 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, // you provide a selector (a component of the DNS record name that identifies the -// public key to use for DKIM authentication) and a private key. When you verify a -// domain, this operation provides a set of DKIM tokens, which you can convert into -// CNAME tokens. You add these CNAME tokens to the DNS configuration for your -// domain. Your domain is verified when Amazon SES detects these records in the DNS -// configuration for your domain. For some DNS providers, it can take 72 hours or -// more to complete the domain verification process. Additionally, you can -// associate an existing configuration set with the email identity that you're -// verifying. +// public key to use for DKIM authentication) and a private key. +// +// When you verify a domain, this operation provides a set of DKIM tokens, which +// you can convert into CNAME tokens. You add these CNAME tokens to the DNS +// configuration for your domain. Your domain is verified when Amazon SES detects +// these records in the DNS configuration for your domain. For some DNS providers, +// it can take 72 hours or more to complete the domain verification process. +// +// Additionally, you can associate an existing configuration set with the email +// identity that you're verifying. +// +// [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html func (c *Client) CreateEmailIdentity(ctx context.Context, params *CreateEmailIdentityInput, optFns ...func(*Options)) (*CreateEmailIdentityOutput, error) { if params == nil { params = &CreateEmailIdentityInput{} @@ -67,9 +75,12 @@ 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 + // the key length to be used for [Easy DKIM]. + // + // You can only specify this object if the email identity is a domain, as opposed // to an address. + // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html DkimSigningAttributes *types.DkimSigningAttributes // An array of objects that define the tags (keys and values) to associate with @@ -80,8 +91,9 @@ type CreateEmailIdentityInput struct { } // If the email identity is a domain, this object contains information about the -// DKIM verification status for the domain. If the email identity is an email -// address, this object is empty. +// DKIM verification status for the domain. +// +// If the email identity is an email address, this object is empty. type CreateEmailIdentityOutput struct { // An object that contains information about the DKIM attributes for the identity. @@ -93,8 +105,9 @@ 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]. + // + // [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 301c627ebb9..1ce44058d1d 100644 --- a/service/sesv2/api_op_CreateEmailIdentityPolicy.go +++ b/service/sesv2/api_op_CreateEmailIdentityPolicy.go @@ -11,12 +11,18 @@ import ( ) // Creates the specified sending authorization policy for the given identity (an -// email address or a domain). 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. +// email address or a domain). +// +// 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]. +// +// 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 func (c *Client) CreateEmailIdentityPolicy(ctx context.Context, params *CreateEmailIdentityPolicyInput, optFns ...func(*Options)) (*CreateEmailIdentityPolicyOutput, error) { if params == nil { params = &CreateEmailIdentityPolicyInput{} @@ -34,9 +40,9 @@ 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) -// . +// other senders to use your identities. For information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html type CreateEmailIdentityPolicyInput struct { // The email identity. @@ -44,16 +50,19 @@ type CreateEmailIdentityPolicyInput struct { // This member is required. EmailIdentity *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) - // . + // 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]. + // + // [Amazon 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/sesv2/api_op_CreateEmailTemplate.go b/service/sesv2/api_op_CreateEmailTemplate.go index 2491f30e8d3..8ca06752805 100644 --- a/service/sesv2/api_op_CreateEmailTemplate.go +++ b/service/sesv2/api_op_CreateEmailTemplate.go @@ -13,8 +13,11 @@ import ( // 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. +// information, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html func (c *Client) CreateEmailTemplate(ctx context.Context, params *CreateEmailTemplateInput, optFns ...func(*Options)) (*CreateEmailTemplateOutput, error) { if params == nil { params = &CreateEmailTemplateInput{} @@ -30,9 +33,10 @@ func (c *Client) CreateEmailTemplate(ctx context.Context, params *CreateEmailTem return out, nil } -// 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) +// Represents a request to create an email template. For more information, see the [Amazon SES Developer Guide] // . +// +// [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, diff --git a/service/sesv2/api_op_CreateExportJob.go b/service/sesv2/api_op_CreateExportJob.go index 920c5416551..63f7303145e 100644 --- a/service/sesv2/api_op_CreateExportJob.go +++ b/service/sesv2/api_op_CreateExportJob.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an export job for a data source and destination. You can execute this -// operation no more than once per second. +// Creates an export job for a data source and destination. +// +// You can execute this operation no more than once per second. func (c *Client) CreateExportJob(ctx context.Context, params *CreateExportJobInput, optFns ...func(*Options)) (*CreateExportJobOutput, error) { if params == nil { params = &CreateExportJobInput{} diff --git a/service/sesv2/api_op_DeleteConfigurationSet.go b/service/sesv2/api_op_DeleteConfigurationSet.go index 9bf5b85e25b..5743df5cf93 100644 --- a/service/sesv2/api_op_DeleteConfigurationSet.go +++ b/service/sesv2/api_op_DeleteConfigurationSet.go @@ -10,11 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an existing configuration set. 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. +// Delete an existing configuration set. +// +// 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. func (c *Client) DeleteConfigurationSet(ctx context.Context, params *DeleteConfigurationSetInput, optFns ...func(*Options)) (*DeleteConfigurationSetOutput, error) { if params == nil { params = &DeleteConfigurationSetInput{} diff --git a/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go b/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go index 643d6667fc6..b02fed4f0eb 100644 --- a/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go +++ b/service/sesv2/api_op_DeleteConfigurationSetEventDestination.go @@ -10,12 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an event destination. 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. +// Delete an event destination. +// +// 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) DeleteConfigurationSetEventDestination(ctx context.Context, params *DeleteConfigurationSetEventDestinationInput, optFns ...func(*Options)) (*DeleteConfigurationSetEventDestinationOutput, error) { if params == nil { params = &DeleteConfigurationSetEventDestinationInput{} diff --git a/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go b/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go index 9797feb2937..52633e18c72 100644 --- a/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_DeleteCustomVerificationEmailTemplate.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// Deletes an existing custom verification email template. +// +// For more information about custom verification email templates, see [Using custom verification email templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using custom verification email templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) DeleteCustomVerificationEmailTemplate(ctx context.Context, params *DeleteCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*DeleteCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &DeleteCustomVerificationEmailTemplateInput{} diff --git a/service/sesv2/api_op_DeleteEmailIdentityPolicy.go b/service/sesv2/api_op_DeleteEmailIdentityPolicy.go index bfcde4a242c..ace6dd261f8 100644 --- a/service/sesv2/api_op_DeleteEmailIdentityPolicy.go +++ b/service/sesv2/api_op_DeleteEmailIdentityPolicy.go @@ -12,12 +12,18 @@ import ( // Deletes the specified sending authorization policy for the given identity (an // email address or a domain). This API returns successfully even if a policy with -// the specified name does not exist. 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. +// the specified name does not exist. +// +// 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]. +// +// 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 func (c *Client) DeleteEmailIdentityPolicy(ctx context.Context, params *DeleteEmailIdentityPolicyInput, optFns ...func(*Options)) (*DeleteEmailIdentityPolicyOutput, error) { if params == nil { params = &DeleteEmailIdentityPolicyInput{} @@ -35,9 +41,9 @@ 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) -// . +// other senders to use your identities. For information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html type DeleteEmailIdentityPolicyInput struct { // The email identity. @@ -45,8 +51,10 @@ 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 diff --git a/service/sesv2/api_op_DeleteEmailTemplate.go b/service/sesv2/api_op_DeleteEmailTemplate.go index cc300b12a87..de728e29fbe 100644 --- a/service/sesv2/api_op_DeleteEmailTemplate.go +++ b/service/sesv2/api_op_DeleteEmailTemplate.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes an email template. You can execute this operation no more than once per -// second. +// Deletes an email template. +// +// You can execute this operation no more than once per second. func (c *Client) DeleteEmailTemplate(ctx context.Context, params *DeleteEmailTemplateInput, optFns ...func(*Options)) (*DeleteEmailTemplateOutput, error) { if params == nil { params = &DeleteEmailTemplateInput{} @@ -27,9 +28,10 @@ func (c *Client) DeleteEmailTemplate(ctx context.Context, params *DeleteEmailTem return out, nil } -// 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) +// Represents a request to delete an email template. For more information, see the [Amazon SES Developer Guide] // . +// +// [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. diff --git a/service/sesv2/api_op_GetAccount.go b/service/sesv2/api_op_GetAccount.go index 7cfe7c3a08f..c13c828c158 100644 --- a/service/sesv2/api_op_GetAccount.go +++ b/service/sesv2/api_op_GetAccount.go @@ -47,11 +47,14 @@ 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 @@ -59,12 +62,15 @@ type GetAccountOutput struct { 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 - // sandbox. When your account is in the sandbox, you can only send email to - // verified identities. 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. + // 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. + // + // 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 // An object that contains information about the per-day and per-second sending diff --git a/service/sesv2/api_op_GetConfigurationSet.go b/service/sesv2/api_op_GetConfigurationSet.go index ee1fb55c8c0..9fe05ca509a 100644 --- a/service/sesv2/api_op_GetConfigurationSet.go +++ b/service/sesv2/api_op_GetConfigurationSet.go @@ -13,11 +13,13 @@ import ( // Get information about an existing configuration set, including the dedicated IP // pool that it's associated with, whether or not it's enabled for sending email, -// and more. 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. +// and more. +// +// 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. func (c *Client) GetConfigurationSet(ctx context.Context, params *GetConfigurationSetInput, optFns ...func(*Options)) (*GetConfigurationSetOutput, error) { if params == nil { params = &GetConfigurationSetInput{} diff --git a/service/sesv2/api_op_GetConfigurationSetEventDestinations.go b/service/sesv2/api_op_GetConfigurationSetEventDestinations.go index f5b1aff0b68..516ad64c081 100644 --- a/service/sesv2/api_op_GetConfigurationSetEventDestinations.go +++ b/service/sesv2/api_op_GetConfigurationSetEventDestinations.go @@ -12,7 +12,9 @@ import ( ) // Retrieve a list of event destinations that are associated with a configuration -// set. Events include message sends, deliveries, opens, clicks, bounces, and +// 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 diff --git a/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go b/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go index 2a4d9e40350..079b4f6716f 100644 --- a/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_GetCustomVerificationEmailTemplate.go @@ -11,10 +11,14 @@ 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// specify. +// +// For more information about custom verification email templates, see [Using custom verification email templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using custom verification email templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) GetCustomVerificationEmailTemplate(ctx context.Context, params *GetCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*GetCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &GetCustomVerificationEmailTemplateInput{} diff --git a/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go b/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go index c12c8e19268..b5be1abbe88 100644 --- a/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go +++ b/service/sesv2/api_op_GetDeliverabilityDashboardOptions.go @@ -16,11 +16,14 @@ import ( // account. When the Deliverability dashboard is enabled, you gain access to // reputation, deliverability, and other metrics for the domains that you use to // send email. You also gain the ability to perform predictive inbox placement -// tests. When you use the Deliverability dashboard, you pay a monthly subscription +// 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]. +// +// [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{} @@ -39,12 +42,14 @@ func (c *Client) GetDeliverabilityDashboardOptions(ctx context.Context, params * // Retrieve information about the status of the Deliverability dashboard for your // Amazon Web Services account. When the Deliverability dashboard is enabled, you // gain access to reputation, deliverability, and other metrics for your domains. -// 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 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/) -// . +// 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 SES and +// other Amazon Web Services services. For more information about the features and +// cost of a Deliverability dashboard subscription, see [Amazon Pinpoint Pricing]. +// +// [Amazon Pinpoint Pricing]: http://aws.amazon.com/pinpoint/pricing/ type GetDeliverabilityDashboardOptionsInput struct { noSmithyDocumentSerde } diff --git a/service/sesv2/api_op_GetEmailIdentity.go b/service/sesv2/api_op_GetEmailIdentity.go index 7078d71ae0a..15b85ed7b38 100644 --- a/service/sesv2/api_op_GetEmailIdentity.go +++ b/service/sesv2/api_op_GetEmailIdentity.go @@ -49,14 +49,16 @@ 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 , - // 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). + // 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 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). FeedbackForwardingStatus bool // The email identity type. Note: the MANAGED_DOMAIN identity type is not @@ -78,22 +80,27 @@ type GetEmailIdentityOutput struct { // for the identity. VerificationInfo *types.VerificationInfo - // The verification status of the identity. The status can be one of the - // following: + // 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. 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]. + // + // [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 6f873cfeb3e..56988f7e9d3 100644 --- a/service/sesv2/api_op_GetEmailIdentityPolicies.go +++ b/service/sesv2/api_op_GetEmailIdentityPolicies.go @@ -12,12 +12,18 @@ import ( // Returns the requested sending authorization policies for the given identity (an // email address or a domain). The policies are returned as a map of policy names -// to policy contents. You can retrieve a maximum of 20 policies at a time. 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. +// to policy contents. You can retrieve a maximum of 20 policies at a time. +// +// 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]. +// +// 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 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 9ee7f8d02e7..fc72cd1cf50 100644 --- a/service/sesv2/api_op_GetEmailTemplate.go +++ b/service/sesv2/api_op_GetEmailTemplate.go @@ -12,8 +12,9 @@ import ( ) // Displays the template object (which includes the subject line, HTML part and -// text part) for the template you specify. You can execute this operation no more -// than once per second. +// text part) for the template you specify. +// +// You can execute this operation no more than once per second. func (c *Client) GetEmailTemplate(ctx context.Context, params *GetEmailTemplateInput, optFns ...func(*Options)) (*GetEmailTemplateOutput, error) { if params == nil { params = &GetEmailTemplateInput{} diff --git a/service/sesv2/api_op_GetMessageInsights.go b/service/sesv2/api_op_GetMessageInsights.go index 742b367567c..e3af3cbe999 100644 --- a/service/sesv2/api_op_GetMessageInsights.go +++ b/service/sesv2/api_op_GetMessageInsights.go @@ -13,7 +13,9 @@ import ( // Provides information about a specific message, including the from address, the // subject, the recipient address, email tags, as well as events associated with -// the message. You can execute this operation no more than once per second. +// the message. +// +// You can execute this operation no more than once per second. func (c *Client) GetMessageInsights(ctx context.Context, params *GetMessageInsightsInput, optFns ...func(*Options)) (*GetMessageInsightsOutput, error) { if params == nil { params = &GetMessageInsightsInput{} @@ -32,7 +34,7 @@ func (c *Client) GetMessageInsights(ctx context.Context, params *GetMessageInsig // A request to return information about a message. type GetMessageInsightsInput struct { - // A MessageId is a unique identifier for a message, and is returned when sending + // A MessageId is a unique identifier for a message, and is returned when sending // emails through Amazon SES. // // This member is required. @@ -44,9 +46,10 @@ type GetMessageInsightsInput struct { // Information about a message. type GetMessageInsightsOutput struct { - // A list of tags, in the form of name/value pairs, that were applied to the email - // you sent, along with Amazon SES Auto-Tags (https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html) - // . + // A list of tags, in the form of name/value pairs, that were applied to the + // email you sent, along with Amazon SES [Auto-Tags]. + // + // [Auto-Tags]: https://docs.aws.amazon.com/ses/latest/dg/monitor-using-event-publishing.html EmailTags []types.MessageTag // The from address used to send the message. diff --git a/service/sesv2/api_op_ListConfigurationSets.go b/service/sesv2/api_op_ListConfigurationSets.go index 64cc9ecd2d7..0a40b5698ac 100644 --- a/service/sesv2/api_op_ListConfigurationSets.go +++ b/service/sesv2/api_op_ListConfigurationSets.go @@ -11,11 +11,13 @@ import ( ) // List all of the configuration sets associated with your account in the current -// region. 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. +// region. +// +// 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. func (c *Client) ListConfigurationSets(ctx context.Context, params *ListConfigurationSetsInput, optFns ...func(*Options)) (*ListConfigurationSetsOutput, error) { if params == nil { params = &ListConfigurationSetsInput{} diff --git a/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go b/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go index 8975712126b..c8914db7d8c 100644 --- a/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go +++ b/service/sesv2/api_op_ListCustomVerificationEmailTemplates.go @@ -12,10 +12,14 @@ 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// current Amazon Web Services Region. +// +// For more information about custom verification email templates, see [Using custom verification email templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using custom verification email templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) ListCustomVerificationEmailTemplates(ctx context.Context, params *ListCustomVerificationEmailTemplatesInput, optFns ...func(*Options)) (*ListCustomVerificationEmailTemplatesOutput, error) { if params == nil { params = &ListCustomVerificationEmailTemplatesInput{} @@ -42,8 +46,9 @@ type ListCustomVerificationEmailTemplatesInput struct { // The number of results to show in a single call to // 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. + // 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. PageSize *int32 noSmithyDocumentSerde @@ -157,8 +162,9 @@ type ListCustomVerificationEmailTemplatesPaginatorOptions struct { // The number of results to show in a single call to // 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. + // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_ListDeliverabilityTestReports.go b/service/sesv2/api_op_ListDeliverabilityTestReports.go index dc1b0e2c713..9083119ebeb 100644 --- a/service/sesv2/api_op_ListDeliverabilityTestReports.go +++ b/service/sesv2/api_op_ListDeliverabilityTestReports.go @@ -41,8 +41,9 @@ type ListDeliverabilityTestReportsInput 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 // 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. + // obtain additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. PageSize *int32 noSmithyDocumentSerde @@ -160,8 +161,9 @@ 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 // 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. + // obtain additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_ListEmailIdentities.go b/service/sesv2/api_op_ListEmailIdentities.go index a8ce871c3b0..d468b46f678 100644 --- a/service/sesv2/api_op_ListEmailIdentities.go +++ b/service/sesv2/api_op_ListEmailIdentities.go @@ -44,8 +44,9 @@ type ListEmailIdentitiesInput struct { // 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 - // more than 1000. + // additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. PageSize *int32 noSmithyDocumentSerde @@ -160,8 +161,9 @@ type ListEmailIdentitiesPaginatorOptions struct { // 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 - // more than 1000. + // additional results. + // + // The value you specify has to be at least 0, and can be no more than 1000. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_ListEmailTemplates.go b/service/sesv2/api_op_ListEmailTemplates.go index ba9caa67db7..3c448227417 100644 --- a/service/sesv2/api_op_ListEmailTemplates.go +++ b/service/sesv2/api_op_ListEmailTemplates.go @@ -12,8 +12,9 @@ import ( ) // Lists the email templates present in your Amazon SES account in the current -// Amazon Web Services Region. You can execute this operation no more than once per -// second. +// Amazon Web Services Region. +// +// You can execute this operation no more than once per second. func (c *Client) ListEmailTemplates(ctx context.Context, params *ListEmailTemplatesInput, optFns ...func(*Options)) (*ListEmailTemplatesOutput, error) { if params == nil { params = &ListEmailTemplatesInput{} @@ -31,8 +32,9 @@ 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]. +// +// [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 @@ -42,8 +44,9 @@ type ListEmailTemplatesInput struct { // 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 - // more than 100. + // additional results. + // + // The value you specify has to be at least 1, and can be no more than 100. PageSize *int32 noSmithyDocumentSerde @@ -157,8 +160,9 @@ type ListEmailTemplatesPaginatorOptions struct { // 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 - // more than 100. + // additional results. + // + // The value you specify has to be at least 1, and can be no more than 100. 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 c41d252e326..3b181376dde 100644 --- a/service/sesv2/api_op_ListRecommendations.go +++ b/service/sesv2/api_op_ListRecommendations.go @@ -12,8 +12,9 @@ import ( ) // Lists the recommendations present in your Amazon SES account in the current -// Amazon Web Services Region. You can execute this operation no more than once per -// second. +// Amazon Web Services Region. +// +// You can execute this operation no more than once per second. func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error) { if params == nil { params = &ListRecommendationsInput{} @@ -43,8 +44,9 @@ type ListRecommendationsInput struct { // 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 - // more than 100. + // additional results. + // + // The value you specify has to be at least 1, and can be no more than 100. PageSize *int32 noSmithyDocumentSerde @@ -159,8 +161,9 @@ type ListRecommendationsPaginatorOptions struct { // 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 - // more than 100. + // additional results. + // + // The value you specify has to be at least 1, and can be no more than 100. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sesv2/api_op_PutAccountDetails.go b/service/sesv2/api_op_PutAccountDetails.go index 843198e8447..b210f9fb8ce 100644 --- a/service/sesv2/api_op_PutAccountDetails.go +++ b/service/sesv2/api_op_PutAccountDetails.go @@ -54,12 +54,15 @@ 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 - // in the sandbox. When your account is in the sandbox, you can only send email to - // verified identities. 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. + // 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. + // + // 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 noSmithyDocumentSerde diff --git a/service/sesv2/api_op_PutAccountSendingAttributes.go b/service/sesv2/api_op_PutAccountSendingAttributes.go index af29c60152b..a5bed44c017 100644 --- a/service/sesv2/api_op_PutAccountSendingAttributes.go +++ b/service/sesv2/api_op_PutAccountSendingAttributes.go @@ -30,9 +30,10 @@ func (c *Client) PutAccountSendingAttributes(ctx context.Context, params *PutAcc type PutAccountSendingAttributesInput struct { // Enables or disables your account's ability to send email. Set to true to enable - // email sending, or set to false to disable email sending. If Amazon Web Services - // paused your account's ability to send email, you can't use this operation to - // resume your account's ability to send email. + // email sending, or set to false to disable email sending. + // + // If Amazon Web Services paused your account's ability to send email, you can't + // use this operation to resume your account's ability to send email. SendingEnabled bool noSmithyDocumentSerde diff --git a/service/sesv2/api_op_PutAccountSuppressionAttributes.go b/service/sesv2/api_op_PutAccountSuppressionAttributes.go index 54837512716..3820edee030 100644 --- a/service/sesv2/api_op_PutAccountSuppressionAttributes.go +++ b/service/sesv2/api_op_PutAccountSuppressionAttributes.go @@ -33,8 +33,10 @@ 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. SuppressedReasons []types.SuppressionListReason diff --git a/service/sesv2/api_op_PutAccountVdmAttributes.go b/service/sesv2/api_op_PutAccountVdmAttributes.go index 1eb272f1c10..488276198dd 100644 --- a/service/sesv2/api_op_PutAccountVdmAttributes.go +++ b/service/sesv2/api_op_PutAccountVdmAttributes.go @@ -11,8 +11,9 @@ 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_PutConfigurationSetSuppressionOptions.go b/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go index adbba3f6db5..5835f197371 100644 --- a/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetSuppressionOptions.go @@ -40,8 +40,10 @@ type PutConfigurationSetSuppressionOptionsInput 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. SuppressedReasons []types.SuppressionListReason diff --git a/service/sesv2/api_op_PutConfigurationSetVdmOptions.go b/service/sesv2/api_op_PutConfigurationSetVdmOptions.go index 306df266a6e..6040c401375 100644 --- a/service/sesv2/api_op_PutConfigurationSetVdmOptions.go +++ b/service/sesv2/api_op_PutConfigurationSetVdmOptions.go @@ -12,6 +12,7 @@ import ( ) // 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 { diff --git a/service/sesv2/api_op_PutDedicatedIpInPool.go b/service/sesv2/api_op_PutDedicatedIpInPool.go index 6c831f62e71..a7f6804514e 100644 --- a/service/sesv2/api_op_PutDedicatedIpInPool.go +++ b/service/sesv2/api_op_PutDedicatedIpInPool.go @@ -10,10 +10,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP -// address that you specify must already exist, and must be associated with your -// Amazon Web Services account. The dedicated IP pool you specify must already -// exist. You can create a new pool by using the CreateDedicatedIpPool operation. +// Move a dedicated IP address to an existing dedicated IP pool. +// +// The dedicated IP address that you specify must already exist, and must be +// associated with your Amazon Web Services account. +// +// The dedicated IP pool you specify must already exist. You can create a new pool +// by using the CreateDedicatedIpPool operation. func (c *Client) PutDedicatedIpInPool(ctx context.Context, params *PutDedicatedIpInPoolInput, optFns ...func(*Options)) (*PutDedicatedIpInPoolOutput, error) { if params == nil { params = &PutDedicatedIpInPoolInput{} diff --git a/service/sesv2/api_op_PutDedicatedIpPoolScalingAttributes.go b/service/sesv2/api_op_PutDedicatedIpPoolScalingAttributes.go index bdba4ef2606..e8e1d63ef8b 100644 --- a/service/sesv2/api_op_PutDedicatedIpPoolScalingAttributes.go +++ b/service/sesv2/api_op_PutDedicatedIpPoolScalingAttributes.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used to convert a dedicated IP pool to a different scaling mode. MANAGED pools -// cannot be converted to STANDARD scaling mode. +// Used to convert a dedicated IP pool to a different scaling mode. +// +// MANAGED pools cannot be converted to STANDARD scaling mode. func (c *Client) PutDedicatedIpPoolScalingAttributes(ctx context.Context, params *PutDedicatedIpPoolScalingAttributesInput, optFns ...func(*Options)) (*PutDedicatedIpPoolScalingAttributesOutput, error) { if params == nil { params = &PutDedicatedIpPoolScalingAttributesInput{} @@ -36,8 +37,9 @@ type PutDedicatedIpPoolScalingAttributesInput struct { // This member is required. PoolName *string - // The scaling mode to apply to the dedicated IP pool. Changing the scaling mode - // from MANAGED to STANDARD is not supported. + // The scaling mode to apply to the dedicated IP pool. + // + // Changing the scaling mode from MANAGED to STANDARD is not supported. // // This member is required. ScalingMode types.ScalingMode diff --git a/service/sesv2/api_op_PutDeliverabilityDashboardOption.go b/service/sesv2/api_op_PutDeliverabilityDashboardOption.go index e844dfcbe62..a2ebfbf7667 100644 --- a/service/sesv2/api_op_PutDeliverabilityDashboardOption.go +++ b/service/sesv2/api_op_PutDeliverabilityDashboardOption.go @@ -14,12 +14,14 @@ import ( // Enable or disable the Deliverability dashboard. When you enable the // Deliverability dashboard, you gain access to reputation, deliverability, and // other metrics for the domains that you use to send email. 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 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/) -// . +// 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 SES and +// other Amazon Web Services services. For more information about the features and +// cost of a Deliverability dashboard subscription, see [Amazon SES Pricing]. +// +// [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{} @@ -38,12 +40,14 @@ func (c *Client) PutDeliverabilityDashboardOption(ctx context.Context, params *P // Enable or disable the Deliverability dashboard. 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 SES API -// v2. 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 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/) -// . +// v2. 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 SES and +// other Amazon Web Services services. For more information about the features and +// cost of a Deliverability dashboard subscription, see [Amazon Pinpoint Pricing]. +// +// [Amazon Pinpoint Pricing]: http://aws.amazon.com/pinpoint/pricing/ type PutDeliverabilityDashboardOptionInput struct { // Specifies whether to enable the Deliverability dashboard. To enable the diff --git a/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go b/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go index 49492a61f60..4d124d4707e 100644 --- a/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityDkimAttributes.go @@ -35,9 +35,11 @@ type PutEmailIdentityDkimAttributesInput struct { // This member is required. 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. + // 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. SigningEnabled bool noSmithyDocumentSerde diff --git a/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go b/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go index 8810926fcae..fe903023d06 100644 --- a/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityDkimSigningAttributes.go @@ -13,12 +13,18 @@ import ( // 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 { @@ -45,57 +51,76 @@ 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) - // . + // + // - AWS_SES – Configure DKIM for the identity by using [Easy DKIM]. + // // - EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM // (BYODKIM). // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html + // // 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]. + // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html SigningAttributes *types.DkimSigningAttributes noSmithyDocumentSerde } -// If the action is successful, the service sends back an HTTP 200 response. The -// following data is returned in JSON format by the service. +// If the action is successful, the service sends back an HTTP 200 response. +// +// The following data is returned in JSON format by the service. 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: + // for your domain. If you used [Easy DKIM]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. + // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html 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 - // 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. + // If you used [Easy DKIM] 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. + // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html DkimTokens []string // Metadata pertaining to the operation's result. diff --git a/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go b/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go index 752c652fa2c..1a0d2643ca2 100644 --- a/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityFeedbackAttributes.go @@ -12,14 +12,16 @@ 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 -// 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). +// 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). func (c *Client) PutEmailIdentityFeedbackAttributes(ctx context.Context, params *PutEmailIdentityFeedbackAttributesInput, optFns ...func(*Options)) (*PutEmailIdentityFeedbackAttributesOutput, error) { if params == nil { params = &PutEmailIdentityFeedbackAttributesInput{} @@ -44,14 +46,16 @@ type PutEmailIdentityFeedbackAttributesInput struct { // This member is required. 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. - // 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). + // Sets 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 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). EmailForwardingEnabled bool noSmithyDocumentSerde diff --git a/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go b/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go index 050b4483bbe..869d8bea015 100644 --- a/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go +++ b/service/sesv2/api_op_PutEmailIdentityMailFromAttributes.go @@ -40,15 +40,19 @@ type PutEmailIdentityMailFromAttributesInput struct { // 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. + // 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 + // 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 diff --git a/service/sesv2/api_op_SendBulkEmail.go b/service/sesv2/api_op_SendBulkEmail.go index 6de8870f1e9..b8ecbb77e55 100644 --- a/service/sesv2/api_op_SendBulkEmail.go +++ b/service/sesv2/api_op_SendBulkEmail.go @@ -28,8 +28,9 @@ 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]. +// +// [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. @@ -57,14 +58,18 @@ type SendBulkEmailInput 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 email address specified in the FeedbackForwardingEmailAddress - // parameter. For example, if the owner of example.com (which has ARN + // 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 // 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) - // . + // FeedbackForwardingEmailAddress to be feedback@example.com. + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [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 @@ -73,15 +78,18 @@ type SendBulkEmailInput 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 email address specified in the FromEmailAddress parameter. For - // example, if the owner of example.com (which has ARN + // you to use the email address specified in the FromEmailAddress 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 sender@example.com, then you would specify the // 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) - // . + // FromEmailAddress to be sender@example.com. + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [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 d1b3acbacea..b028a84467f 100644 --- a/service/sesv2/api_op_SendCustomVerificationEmail.go +++ b/service/sesv2/api_op_SendCustomVerificationEmail.go @@ -13,12 +13,15 @@ import ( // Adds an email address to the list of identities for your Amazon SES account in // the current Amazon Web Services Region and attempts to verify it. As a result of // executing this 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/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. +// 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]in the Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using custom verification email templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) SendCustomVerificationEmail(ctx context.Context, params *SendCustomVerificationEmailInput, optFns ...func(*Options)) (*SendCustomVerificationEmailOutput, error) { if params == nil { params = &SendCustomVerificationEmailInput{} diff --git a/service/sesv2/api_op_SendEmail.go b/service/sesv2/api_op_SendEmail.go index 8207b8f6525..b2de48dd37b 100644 --- a/service/sesv2/api_op_SendEmail.go +++ b/service/sesv2/api_op_SendEmail.go @@ -13,13 +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. @@ -39,8 +42,9 @@ func (c *Client) SendEmail(ctx context.Context, params *SendEmailInput, optFns . } // 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) -// . +// more information, see the [Amazon SES Developer Guide]. +// +// [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 @@ -66,14 +70,18 @@ type SendEmailInput 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 email address specified in the FeedbackForwardingEmailAddress - // parameter. For example, if the owner of example.com (which has ARN + // 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 // 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) - // . + // FeedbackForwardingEmailAddress to be feedback@example.com. + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // [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 @@ -82,17 +90,22 @@ type SendEmailInput 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 email address specified in the FromEmailAddress parameter. For - // example, if the owner of example.com (which has ARN + // you to use the email address specified in the FromEmailAddress 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 sender@example.com, then you would specify the // 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 + // FromEmailAddress to be sender@example.com. + // + // For more information about sending authorization, see the [Amazon SES Developer Guide]. + // + // For Raw emails, the FromEmailAddressIdentityArn value overrides the // X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message // content. + // + // [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html FromEmailAddressIdentityArn *string // An object used to specify a list or topic to which an email belongs, which will @@ -110,8 +123,10 @@ type SendEmailInput struct { type SendEmailOutput struct { // A unique identifier for the message that is generated when the message is - // accepted. It's possible for Amazon SES to accept a message without sending it. - // For example, this can happen when the message that you're trying to send has an + // accepted. + // + // It's possible for Amazon SES to accept a message without sending it. For + // example, this can happen when the message that you're trying to send has an // attachment that contains a virus, or when you send a templated email that // contains invalid personalization content. MessageId *string diff --git a/service/sesv2/api_op_TagResource.go b/service/sesv2/api_op_TagResource.go index ee09c2cf2b2..0b84eaf325f 100644 --- a/service/sesv2/api_op_TagResource.go +++ b/service/sesv2/api_op_TagResource.go @@ -15,6 +15,7 @@ import ( // 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. diff --git a/service/sesv2/api_op_TestRenderEmailTemplate.go b/service/sesv2/api_op_TestRenderEmailTemplate.go index b8928465933..1c1b6c68c1d 100644 --- a/service/sesv2/api_op_TestRenderEmailTemplate.go +++ b/service/sesv2/api_op_TestRenderEmailTemplate.go @@ -11,8 +11,9 @@ import ( ) // Creates a preview of the MIME content of an email when provided with a template -// and a set of replacement data. You can execute this operation no more than once -// per second. +// and a set of replacement data. +// +// You can execute this operation no more than once per second. func (c *Client) TestRenderEmailTemplate(ctx context.Context, params *TestRenderEmailTemplateInput, optFns ...func(*Options)) (*TestRenderEmailTemplateOutput, error) { if params == nil { params = &TestRenderEmailTemplateInput{} diff --git a/service/sesv2/api_op_UntagResource.go b/service/sesv2/api_op_UntagResource.go index 1d11b53927a..02dfe994c15 100644 --- a/service/sesv2/api_op_UntagResource.go +++ b/service/sesv2/api_op_UntagResource.go @@ -35,8 +35,9 @@ type UntagResourceInput struct { ResourceArn *string // The tags (tag keys) that you want to remove from the resource. When you specify - // a tag key, the action removes both that key and its associated tag value. To - // remove more than one tag from the resource, append the TagKeys parameter and + // a tag key, the action removes both that key and its associated tag value. + // + // To remove more than one tag from the resource, append the TagKeys parameter and // argument for each additional tag to remove, separated by an ampersand. For // example: /v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2 // diff --git a/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go b/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go index 7787dbea60a..189b0eee2d7 100644 --- a/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go +++ b/service/sesv2/api_op_UpdateConfigurationSetEventDestination.go @@ -12,6 +12,7 @@ import ( ) // 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 diff --git a/service/sesv2/api_op_UpdateContact.go b/service/sesv2/api_op_UpdateContact.go index d393fba43b0..7b55a4cce5c 100644 --- a/service/sesv2/api_op_UpdateContact.go +++ b/service/sesv2/api_op_UpdateContact.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates a contact's preferences for a list. You must specify all existing topic -// preferences in the TopicPreferences object, not just the ones that need -// updating; otherwise, all your existing preferences will be removed. +// Updates a contact's preferences for a list. +// +// You must specify all existing topic preferences in the TopicPreferences object, +// not just the ones that need updating; otherwise, all your existing preferences +// will be removed. func (c *Client) UpdateContact(ctx context.Context, params *UpdateContactInput, optFns ...func(*Options)) (*UpdateContactOutput, error) { if params == nil { params = &UpdateContactInput{} diff --git a/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go b/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go index 067f9d2c15c..fad42a506ac 100644 --- a/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go +++ b/service/sesv2/api_op_UpdateCustomVerificationEmailTemplate.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SES Developer Guide. You can execute this operation no more than -// once per second. +// Updates an existing custom verification email template. +// +// For more information about custom verification email templates, see [Using custom verification email templates] in the +// Amazon SES Developer Guide. +// +// You can execute this operation no more than once per second. +// +// [Using custom verification email templates]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom func (c *Client) UpdateCustomVerificationEmailTemplate(ctx context.Context, params *UpdateCustomVerificationEmailTemplateInput, optFns ...func(*Options)) (*UpdateCustomVerificationEmailTemplateOutput, error) { if params == nil { params = &UpdateCustomVerificationEmailTemplateInput{} @@ -52,8 +55,9 @@ 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) - // in the Amazon SES Developer Guide. + // For more information, see [Custom verification email frequently asked questions]in the Amazon SES Developer Guide. + // + // [Custom verification email frequently asked questions]: https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#send-email-verify-address-custom-faq // // This member is required. TemplateContent *string diff --git a/service/sesv2/api_op_UpdateEmailIdentityPolicy.go b/service/sesv2/api_op_UpdateEmailIdentityPolicy.go index c50d93bb45d..4abcc5b7c55 100644 --- a/service/sesv2/api_op_UpdateEmailIdentityPolicy.go +++ b/service/sesv2/api_op_UpdateEmailIdentityPolicy.go @@ -12,12 +12,18 @@ import ( // Updates the specified sending authorization policy for the given identity (an // email address or a domain). This API returns successfully even if a policy with -// the specified name does not exist. 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. +// the specified name does not exist. +// +// 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]. +// +// 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 func (c *Client) UpdateEmailIdentityPolicy(ctx context.Context, params *UpdateEmailIdentityPolicyInput, optFns ...func(*Options)) (*UpdateEmailIdentityPolicyOutput, error) { if params == nil { params = &UpdateEmailIdentityPolicyInput{} @@ -35,9 +41,9 @@ 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) -// . +// other senders to use your identities. For information, see the [Amazon SES Developer Guide]. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-identity-owner-tasks-management.html type UpdateEmailIdentityPolicyInput struct { // The email identity. @@ -45,16 +51,19 @@ type UpdateEmailIdentityPolicyInput struct { // This member is required. EmailIdentity *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) - // . + // 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]. + // + // [Amazon 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/sesv2/api_op_UpdateEmailTemplate.go b/service/sesv2/api_op_UpdateEmailTemplate.go index ca88c0ec485..d68aec8457f 100644 --- a/service/sesv2/api_op_UpdateEmailTemplate.go +++ b/service/sesv2/api_op_UpdateEmailTemplate.go @@ -13,8 +13,11 @@ import ( // 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. +// information, see the [Amazon SES Developer Guide]. +// +// You can execute this operation no more than once per second. +// +// [Amazon SES Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html func (c *Client) UpdateEmailTemplate(ctx context.Context, params *UpdateEmailTemplateInput, optFns ...func(*Options)) (*UpdateEmailTemplateOutput, error) { if params == nil { params = &UpdateEmailTemplateInput{} @@ -30,9 +33,10 @@ func (c *Client) UpdateEmailTemplate(ctx context.Context, params *UpdateEmailTem return out, nil } -// 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) +// Represents a request to update an email template. For more information, see the [Amazon SES Developer Guide] // . +// +// [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, diff --git a/service/sesv2/doc.go b/service/sesv2/doc.go index bded1d8b0a0..ffcf4496dbf 100644 --- a/service/sesv2/doc.go +++ b/service/sesv2/doc.go @@ -3,10 +3,15 @@ // Package sesv2 provides the API client, operations, and parameter types for // Amazon Simple Email Service. // -// 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 +// # Amazon SES API v2 +// +// [Amazon 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]. +// The Amazon SES Developer Guide provides information and code samples that // demonstrate how to use Amazon SES API v2 features programmatically. +// +// [Amazon Simple Email Service Developer Guide]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/ +// [Amazon SES]: http://aws.amazon.com/ses package sesv2 diff --git a/service/sesv2/options.go b/service/sesv2/options.go index 8c495a0a7bc..8176eed6bed 100644 --- a/service/sesv2/options.go +++ b/service/sesv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sesv2/types/enums.go b/service/sesv2/types/enums.go index 58bb8e91abe..126e5dc84ca 100644 --- a/service/sesv2/types/enums.go +++ b/service/sesv2/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BehaviorOnMxFailure. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BehaviorOnMxFailure) Values() []BehaviorOnMxFailure { return []BehaviorOnMxFailure{ "USE_DEFAULT_VALUE", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for BounceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BounceType) Values() []BounceType { return []BounceType{ "UNDETERMINED", @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for BulkEmailStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BulkEmailStatus) Values() []BulkEmailStatus { return []BulkEmailStatus{ "SUCCESS", @@ -91,8 +94,9 @@ const ( ) // Values returns all known values for ContactLanguage. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactLanguage) Values() []ContactLanguage { return []ContactLanguage{ "EN", @@ -109,8 +113,9 @@ const ( ) // Values returns all known values for ContactListImportAction. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactListImportAction) Values() []ContactListImportAction { return []ContactListImportAction{ "DELETE", @@ -127,8 +132,9 @@ const ( ) // Values returns all known values for DataFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataFormat) Values() []DataFormat { return []DataFormat{ "CSV", @@ -147,8 +153,9 @@ const ( // Values returns all known values for DeliverabilityDashboardAccountStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliverabilityDashboardAccountStatus) Values() []DeliverabilityDashboardAccountStatus { return []DeliverabilityDashboardAccountStatus{ "ACTIVE", @@ -167,6 +174,7 @@ const ( // 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{ @@ -188,8 +196,9 @@ const ( ) // Values returns all known values for DeliveryEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeliveryEventType) Values() []DeliveryEventType { return []DeliveryEventType{ "SEND", @@ -211,8 +220,9 @@ const ( ) // Values returns all known values for DimensionValueSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionValueSource) Values() []DimensionValueSource { return []DimensionValueSource{ "MESSAGE_TAG", @@ -231,6 +241,7 @@ const ( // Values returns all known values for DkimSigningAttributesOrigin. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DkimSigningAttributesOrigin) Values() []DkimSigningAttributesOrigin { return []DkimSigningAttributesOrigin{ @@ -248,8 +259,9 @@ const ( ) // Values returns all known values for DkimSigningKeyLength. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DkimSigningKeyLength) Values() []DkimSigningKeyLength { return []DkimSigningKeyLength{ "RSA_1024_BIT", @@ -269,8 +281,9 @@ const ( ) // Values returns all known values for DkimStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DkimStatus) Values() []DkimStatus { return []DkimStatus{ "PENDING", @@ -290,8 +303,9 @@ const ( ) // Values returns all known values for EngagementEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EngagementEventType) Values() []EngagementEventType { return []EngagementEventType{ "OPEN", @@ -316,8 +330,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -342,8 +357,9 @@ const ( ) // Values returns all known values for ExportSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExportSourceType) Values() []ExportSourceType { return []ExportSourceType{ "METRICS_DATA", @@ -360,8 +376,9 @@ const ( ) // Values returns all known values for FeatureStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureStatus) Values() []FeatureStatus { return []FeatureStatus{ "ENABLED", @@ -379,8 +396,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -398,8 +416,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SUPPRESSION_LIST", @@ -419,8 +438,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -443,8 +463,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListRecommendationsFilterKey) Values() []ListRecommendationsFilterKey { return []ListRecommendationsFilterKey{ "TYPE", @@ -465,8 +486,9 @@ const ( ) // Values returns all known values for MailFromDomainStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MailFromDomainStatus) Values() []MailFromDomainStatus { return []MailFromDomainStatus{ "PENDING", @@ -485,8 +507,9 @@ const ( ) // Values returns all known values for MailType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MailType) Values() []MailType { return []MailType{ "MARKETING", @@ -511,8 +534,9 @@ const ( ) // Values returns all known values for Metric. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Metric) Values() []Metric { return []Metric{ "SEND", @@ -537,8 +561,9 @@ const ( ) // Values returns all known values for MetricAggregation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricAggregation) Values() []MetricAggregation { return []MetricAggregation{ "RATE", @@ -556,8 +581,9 @@ const ( ) // Values returns all known values for MetricDimensionName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricDimensionName) Values() []MetricDimensionName { return []MetricDimensionName{ "EMAIL_IDENTITY", @@ -574,8 +600,9 @@ const ( ) // Values returns all known values for MetricNamespace. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricNamespace) Values() []MetricNamespace { return []MetricNamespace{ "VDM", @@ -591,8 +618,9 @@ const ( ) // Values returns all known values for QueryErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryErrorCode) Values() []QueryErrorCode { return []QueryErrorCode{ "INTERNAL_FAILURE", @@ -609,8 +637,9 @@ const ( ) // Values returns all known values for RecommendationImpact. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationImpact) Values() []RecommendationImpact { return []RecommendationImpact{ "LOW", @@ -627,8 +656,9 @@ const ( ) // Values returns all known values for RecommendationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationStatus) Values() []RecommendationStatus { return []RecommendationStatus{ "OPEN", @@ -647,8 +677,9 @@ const ( ) // Values returns all known values for RecommendationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationType) Values() []RecommendationType { return []RecommendationType{ "DKIM", @@ -669,8 +700,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -689,8 +721,9 @@ const ( ) // Values returns all known values for ScalingMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalingMode) Values() []ScalingMode { return []ScalingMode{ "STANDARD", @@ -707,8 +740,9 @@ const ( ) // Values returns all known values for SubscriptionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionStatus) Values() []SubscriptionStatus { return []SubscriptionStatus{ "OPT_IN", @@ -726,6 +760,7 @@ const ( // Values returns all known values for SuppressionListImportAction. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SuppressionListImportAction) Values() []SuppressionListImportAction { return []SuppressionListImportAction{ @@ -743,8 +778,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "BOUNCE", @@ -761,8 +797,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -782,8 +819,9 @@ const ( ) // Values returns all known values for VerificationError. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationError) Values() []VerificationError { return []VerificationError{ "SERVICE_ERROR", @@ -806,8 +844,9 @@ const ( ) // Values returns all known values for VerificationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VerificationStatus) Values() []VerificationStatus { return []VerificationStatus{ "PENDING", @@ -827,8 +866,9 @@ const ( ) // 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. +// expanded in the future, and so 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 e5bc5564ad0..377185cc3a9 100644 --- a/service/sesv2/types/types.go +++ b/service/sesv2/types/types.go @@ -20,8 +20,10 @@ type AccountDetails struct { // 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. MailType MailType @@ -53,33 +55,43 @@ 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 @@ -169,13 +181,17 @@ type BulkEmailContent struct { 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 - // 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) . + // fields. + // + // Amazon SES does not support the SMTPUTF8 extension, as described in [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]. 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]. + // + // [RFC3492]: https://tools.ietf.org/html/rfc3492.html + // [RFC6531]: https://tools.ietf.org/html/rfc6531 + // [7-bit ASCII characters]: https://en.wikipedia.org/wiki/Email_address#Local-part // // This member is required. Destination *Destination @@ -184,17 +200,22 @@ type BulkEmailEntry struct { ReplacementEmailContent *ReplacementEmailContent // The list of message headers associated with the BulkEmailEntry data type. - // - Headers Not Present in BulkEmailEntry : If a header is specified in Template (https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html) + // + // - Headers Not Present in BulkEmailEntry : If a header is specified in [Template]Template // but not in BulkEmailEntry , the header from Template will be added to the // outgoing email. + // // - Headers Present in BulkEmailEntry : If a header is specified in // BulkEmailEntry , it takes precedence over any header of the same name - // specified in Template (https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html) - // : + // specified in [Template]Template : + // // - If the header is also defined within Template , the value from // BulkEmailEntry will replace the header's value in the email. + // // - If the header is not defined within Template , it will simply be added to // the email as specified in BulkEmailEntry . + // + // [Template]: https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html ReplacementHeaders []MessageHeader // A list of tags, in the form of name/value pairs, to apply to an email that you @@ -218,36 +239,52 @@ type BulkEmailEntryResult struct { MessageId *string // 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. + // disabled using the [UpdateAccountSendingEnabled]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. + // was disabled using the [UpdateConfigurationSetSendingEnabled]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. + // + // [UpdateAccountSendingEnabled]: https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html + // [UpdateConfigurationSetSendingEnabled]: https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html Status BulkEmailStatus noSmithyDocumentSerde @@ -274,8 +311,10 @@ 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. // // This member is required. @@ -283,8 +322,10 @@ type CloudWatchDimensionConfiguration struct { // 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. // // This member is required. @@ -305,11 +346,11 @@ type CloudWatchDimensionConfiguration struct { // Information about a Complaint event. type Complaint struct { - // The value of the Feedback-Type field from the feedback report received from the - // ISP. + // The value of the Feedback-Type field from the feedback report received from + // the ISP. ComplaintFeedbackType *string - // Can either be null or OnAccountSuppressionList . If the value is + // Can either be null or OnAccountSuppressionList . If the value is // OnAccountSuppressionList , SES accepted the message, but didn't attempt to send // it because it was on the account-level suppression list. ComplaintSubType *string @@ -357,8 +398,10 @@ 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. // // This member is required. @@ -437,7 +480,9 @@ 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. EngagementMetrics FeatureStatus @@ -450,7 +495,9 @@ 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. EngagementMetrics FeatureStatus @@ -458,9 +505,12 @@ 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) -// in the Amazon SES Developer Guide. +// Amazon SES account. +// +// To learn more about requesting dedicated IP addresses, see [Requesting and Relinquishing Dedicated IP Addresses] in the Amazon SES +// Developer Guide. +// +// [Requesting and Relinquishing Dedicated IP Addresses]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html type DedicatedIp struct { // An IPv4 address. @@ -476,8 +526,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. // @@ -499,8 +551,10 @@ type DedicatedIpPool struct { PoolName *string // The type of the dedicated IP pool. + // // - STANDARD – A dedicated IP pool where you can control which IPs are part of // the pool. + // // - MANAGED – A dedicated IP pool where the reputation and number of IPs are // automatically managed by Amazon SES. // @@ -555,14 +609,17 @@ type DeliveryOptions struct { noSmithyDocumentSerde } -// 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) -// . +// An object that describes the recipients for an email. +// +// Amazon SES does not support the SMTPUTF8 extension, as described in [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]. 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]. +// +// [RFC3492]: https://tools.ietf.org/html/rfc3492.html +// [RFC6531]: https://tools.ietf.org/html/rfc6531 +// [7-bit ASCII characters]: https://en.wikipedia.org/wiki/Email_address#Local-part type Destination struct { // An array that contains the email addresses of the "BCC" (blind carbon copy) @@ -580,14 +637,18 @@ 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 +// 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]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 +// +// [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html type DkimAttributes struct { // [Easy DKIM] The key length of the DKIM key pair in use. @@ -602,10 +663,13 @@ type DkimAttributes struct { // 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) . + // + // - AWS_SES – Indicates that DKIM was configured for the identity by using [Easy DKIM]. + // // - EXTERNAL – Indicates that DKIM was configured for the identity by using // Bring Your Own DKIM (BYODKIM). + // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html SigningAttributesOrigin DkimSigningAttributesOrigin // If the value is true , then the messages that you send from the identity are @@ -615,27 +679,37 @@ type DkimAttributes struct { // 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] 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. + // + // [Easy DKIM]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html Tokens []string noSmithyDocumentSerde @@ -646,6 +720,7 @@ type DkimAttributes struct { type DkimSigningAttributes struct { // [Bring Your Own DKIM] A private key that's used to generate a DKIM signature. + // // The private key must use 1024 or 2048-bit RSA encryption, and must be encoded // using base64 encoding. DomainSigningPrivateKey *string @@ -779,22 +854,29 @@ 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. + // + // - 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 raw data of the message needs to base64-encoded if you are accessing // Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES // using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for // you. + // // - 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) - // . + // characters. This restriction is defined in [RFC 5321]. + // + // [RFC 5321]: https://tools.ietf.org/html/rfc5321 Raw *RawMessage // The simple email message. The message consists of a subject and a message body. @@ -860,35 +942,47 @@ type EmailTemplateMetadata struct { 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.) + // when you send email using the [SendTemplatedEmail]SendTemplatedEmail or [SendBulkTemplatedEmail]SendBulkTemplatedEmail 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) - // . + // part of your [subscription management]. + // + // [SendTemplatedEmail]: https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html + // [subscription management]: https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html + // [SendBulkTemplatedEmail]: https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html // // This member is required. MatchingEventTypes []EventType @@ -905,9 +999,10 @@ type EventDestination struct { // 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 - // the event destination is disabled, events aren't sent to the specified - // destinations. + // EventDestinationDefinition . + // + // If false , the event destination is disabled. When the event destination is + // disabled, events aren't sent to the specified destinations. Enabled bool // An object that defines an Amazon Kinesis Data Firehose destination for email @@ -918,8 +1013,9 @@ 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) - // in the Amazon Pinpoint User Guide. + // more information, see [Transactional Messaging Charts]in the Amazon Pinpoint User Guide. + // + // [Transactional Messaging Charts]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html PinpointDestination *PinpointDestination // An object that defines an Amazon SNS destination for email events. You can use @@ -942,9 +1038,10 @@ type EventDestinationDefinition struct { // 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 - // the event destination is disabled, events aren't sent to the specified - // destinations. + // EventDestinationDefinition . + // + // If false , the event destination is disabled. When the event destination is + // disabled, events aren't sent to the specified destinations. Enabled bool // An object that defines an Amazon Kinesis Data Firehose destination for email @@ -959,8 +1056,9 @@ type EventDestinationDefinition 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) - // in the Amazon Pinpoint User Guide. + // more information, see [Transactional Messaging Charts]in the Amazon Pinpoint User Guide. + // + // [Transactional Messaging Charts]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html PinpointDestination *PinpointDestination // An object that defines an Amazon SNS destination for email events. You can use @@ -970,7 +1068,8 @@ type EventDestinationDefinition struct { noSmithyDocumentSerde } -// Contains a Bounce object if the event type is BOUNCE . Contains a Complaint +// Contains a Bounce object if the event type is BOUNCE . Contains a Complaint +// // object if the event type is COMPLAINT . type EventDetails struct { @@ -1001,7 +1100,9 @@ type ExportDataSource struct { type ExportDestination struct { // The data format of the final export job file, can be one of the following: + // // - CSV - A comma-separated values file. + // // - JSON - A Json file. // // This member is required. @@ -1038,38 +1139,50 @@ type ExportJobSummary struct { type ExportMetric struct { // The aggregation to apply to a metric, can be one of the following: + // // - VOLUME - The volume of events for this metric. + // // - RATE - The rate for this metric relative to the SEND metric volume. Aggregation MetricAggregation // The metric to export, 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 @@ -1082,8 +1195,9 @@ type ExportMetric struct { // Statistics about the execution of an export job. type ExportStatistics struct { - // The number of records that were exported to the final export file. This value - // might not be available for all export source types + // The number of records that were exported to the final export file. + // + // This value might not be available for all export source types ExportedRecordsCount *int32 // The number of records that were processed to generate the final export file. @@ -1111,7 +1225,9 @@ 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. OptimizedSharedDelivery FeatureStatus @@ -1124,8 +1240,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. OptimizedSharedDelivery FeatureStatus @@ -1143,20 +1261,25 @@ 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 - // authorize Amazon SES to send email from that identity. + // 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: + // 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. VerificationStatus VerificationStatus @@ -1211,9 +1334,13 @@ type ImportJobSummary struct { JobId *string // The status of a job. + // // - CREATED – Job has just been created. + // // - PROCESSING – Job is processing. + // // - ERROR – An error occurred during processing. + // // - COMPLETED – Job has completed processing successfully. JobStatus JobStatus @@ -1249,21 +1376,27 @@ type InsightsEvent struct { Timestamp *time.Time // The type of event: + // // - 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.) + // // - DELIVERY - SES successfully delivered the email to the recipient's mail // server. Excludes deliveries to the mailbox simulator, and those from emails // addressed to more than one recipient. + // // - BOUNCE - Feedback received for delivery failures. Additional details about // the bounce are provided in the Details object. Excludes bounces from the // mailbox simulator, and those from emails addressed to more than one recipient. + // // - COMPLAINT - Complaint received for the email. Additional details about the // complaint are provided in the Details object. This excludes complaints from // the mailbox simulator, those originating from your account-level suppression // list (if enabled), and those from emails addressed to more than one recipient. + // // - OPEN - Open event for emails including open trackers. Excludes opens for // emails addressed to more than one recipient. + // // - CLICK - Click event for emails including wrapped links. Excludes clicks for // emails addressed to more than one recipient. Type EventType @@ -1338,9 +1471,10 @@ type MailFromAttributes struct { // 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. + // 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 @@ -1351,11 +1485,15 @@ type MailFromAttributes struct { 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. // @@ -1377,8 +1515,9 @@ 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]. + // + // [RFC 2047]: https://tools.ietf.org/html/rfc2047 // // This member is required. Subject *Content @@ -1394,7 +1533,9 @@ type MessageHeader struct { // The name of the message header. The message header name has to meet the // following criteria: + // // - Can contain any printable ASCII character (33 - 126) except for colon (:). + // // - Can contain no more than 126 characters. // // This member is required. @@ -1402,7 +1543,9 @@ type MessageHeader struct { // The value of the message header. The message header value has to meet the // following criteria: + // // - Can contain any printable ASCII character. + // // - Can contain no more than 870 characters. // // This member is required. @@ -1439,14 +1582,19 @@ type MessageInsightsDataSource struct { noSmithyDocumentSerde } -// An object containing Message Insights filters. If you specify multiple filters, -// the filters are joined by AND. If you specify multiple values for a filter, the -// values are joined by OR. Filter values are case-sensitive. FromEmailAddress , -// Destination , and Subject filters support partial match. A partial match is -// performed by using the * wildcard character placed at the beginning (suffix -// match), the end (prefix match) or both ends of the string (contains match). In -// order to match the literal characters * or \ , they must be escaped using the \ -// character. If no wildcard character is present, an exact match is performed. +// An object containing Message Insights filters. +// +// If you specify multiple filters, the filters are joined by AND. +// +// If you specify multiple values for a filter, the values are joined by OR. +// Filter values are case-sensitive. +// +// FromEmailAddress , Destination , and Subject filters support partial match. A +// partial match is performed by using the * wildcard character placed at the +// beginning (suffix match), the end (prefix match) or both ends of the string +// (contains match). In order to match the literal characters * or \ , they must be +// escaped using the \ character. If no wildcard character is present, an exact +// match is performed. type MessageInsightsFilters struct { // The recipient's email address. @@ -1458,14 +1606,16 @@ type MessageInsightsFilters struct { // The recipient's ISP (e.g., Gmail , Yahoo , etc.). Isp []string - // The last delivery-related event for the email, where the ordering is as + // The last delivery-related event for the email, where the ordering is as // follows: SEND < BOUNCE < DELIVERY < COMPLAINT . LastDeliveryEvent []DeliveryEventType - // The last engagement-related event for the email, where the ordering is as - // follows: OPEN < CLICK . Engagement events are only available if Engagement - // tracking (https://docs.aws.amazon.com/ses/latest/dg/vdm-settings.html) is - // enabled. + // The last engagement-related event for the email, where the ordering is as + // follows: OPEN < CLICK . + // + // Engagement events are only available if [Engagement tracking] is enabled. + // + // [Engagement tracking]: https://docs.aws.amazon.com/ses/latest/dg/vdm-settings.html LastEngagementEvent []EngagementEventType // The subject line of the message. @@ -1480,8 +1630,10 @@ 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. // // This member is required. @@ -1489,8 +1641,10 @@ type MessageTag struct { // 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. // // This member is required. @@ -1504,7 +1658,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. Code QueryErrorCode @@ -1588,8 +1744,9 @@ 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) -// in the Amazon Pinpoint User Guide. +// more information, see [Transactional Messaging Charts]in the Amazon Pinpoint User Guide. +// +// [Transactional Messaging Charts]: https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html type PinpointDestination struct { // The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email @@ -1629,21 +1786,28 @@ 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. + // + // - 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 raw data of the message needs to base64-encoded if you are accessing // Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES // using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for // you. + // // - 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) - // . + // characters. This restriction is defined in [RFC 5321]. + // + // [RFC 5321]: https://tools.ietf.org/html/rfc5321 // // This member is required. Data []byte @@ -1726,12 +1890,16 @@ 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. Status ReviewStatus @@ -1776,8 +1944,9 @@ type SendQuota struct { 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) . + // to. For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide]. + // + // [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html // // This member is required. TopicArn *string @@ -1872,8 +2041,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. SuppressedReasons []SuppressionListReason @@ -1884,10 +2055,11 @@ type SuppressionAttributes struct { // An object that contains details about the action of suppression list. type SuppressionListDestination struct { - // The type of action to perform on the address. The following are possible - // values: + // 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. // // This member is required. @@ -1903,8 +2075,10 @@ 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. SuppressedReasons []SuppressionListReason @@ -1916,6 +2090,7 @@ type SuppressionOptions struct { // 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 a // more specific tag value. A tag value acts as a descriptor within a tag key. A @@ -1923,13 +2098,17 @@ 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 @@ -2039,9 +2218,11 @@ type TopicPreference struct { // use the Amazon SES API v2 to send an email, it contains an invisible image // that's used to track when recipients open your email. If your email contains // links, those links are changed slightly in order to track when recipients click -// them. These images and links include references to a domain operated by Amazon -// Web Services. You can optionally configure the Amazon SES to use a domain that -// you operate for these images and links. +// them. +// +// These images and links include references to a domain operated by Amazon Web +// Services. You can optionally configure the Amazon SES to use a domain that you +// operate for these images and links. type TrackingOptions struct { // The domain to use for tracking open and click events. @@ -2056,7 +2237,9 @@ 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. // // This member is required. @@ -2094,17 +2277,22 @@ type VerificationInfo struct { // Provides the reason for the failure describing why Amazon SES was not able to // successfully verify the identity. Below are the possible values: + // // - INVALID_VALUE – Amazon SES was able to find the record, but the value // contained within the record was invalid. Ensure you have published the correct // values for the record. + // // - TYPE_NOT_FOUND – The queried hostname exists but does not have the requested // type of DNS record. Ensure that you have published the correct type of DNS // record. + // // - HOST_NOT_FOUND – The queried hostname does not exist or was not reachable at // the time of the request. Ensure that you have published the required DNS // record(s). + // // - SERVICE_ERROR – A temporary issue is preventing Amazon SES from determining // the verification status of the domain. + // // - DNS_SERVER_ERROR – The DNS server encountered an issue and was unable to // complete the request. ErrorType VerificationError diff --git a/service/sfn/api_op_CreateActivity.go b/service/sfn/api_op_CreateActivity.go index 954f68fcef0..8ccf89d712e 100644 --- a/service/sfn/api_op_CreateActivity.go +++ b/service/sfn/api_op_CreateActivity.go @@ -17,8 +17,11 @@ import ( // must poll Step Functions using the GetActivityTask API action and respond using // SendTask* API actions. This function lets Step Functions know the existence of // your activity and returns an identifier for use in a state machine and when -// polling from the activity. This operation is eventually consistent. The results -// are best effort and may not reflect very recent updates and changes. +// 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 @@ -43,26 +46,39 @@ 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) - // in the Step Functions Developer Guide. A name must not contain: + // Web Services account and region for 90 days. For more information, see [Limits Related to 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 _. // + // [Limits Related to State Machine Executions]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions + // // 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) - // 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: - // _ . : / = + - @ . + // The list of tags to add to a resource. + // + // An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the Amazon Web + // Services Billing and Cost Management User Guide, and [Controlling Access Using IAM Tags]. + // + // 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 + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sfn/api_op_CreateStateMachine.go b/service/sfn/api_op_CreateStateMachine.go index 5f0fc36698f..3689d4af3e4 100644 --- a/service/sfn/api_op_CreateStateMachine.go +++ b/service/sfn/api_op_CreateStateMachine.go @@ -16,19 +16,24 @@ import ( // 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. If you set the publish parameter of this API -// action to true , it publishes version 1 as the first revision of the state -// machine. 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 . The check is also based on the publish and -// versionDescription parameters. 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. +// information, see [Amazon States Language]in the Step Functions User Guide. +// +// If you set the publish parameter of this API action to true , it publishes +// version 1 as the first revision of the state machine. +// +// 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 . The check is also based on the +// publish and versionDescription parameters. 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. +// +// [Amazon States Language]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html func (c *Client) CreateStateMachine(ctx context.Context, params *CreateStateMachineInput, optFns ...func(*Options)) (*CreateStateMachineOutput, error) { if params == nil { params = &CreateStateMachineInput{} @@ -46,19 +51,27 @@ 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) - // . + // The Amazon States Language definition of the state machine. See [Amazon States Language]. + // + // [Amazon States 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: + // 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 _. // @@ -70,21 +83,28 @@ type CreateStateMachineInput struct { // This member is required. 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) - // in the Step Functions User Guide. + // 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] in the Step + // Functions User Guide. + // + // [Log Levels]: https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html LoggingConfiguration *types.LoggingConfiguration // Set to true to publish the first version of the state machine during creation. // The default is false . Publish bool - // 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: - // _ . : / = + - @ . + // Tags to be added when creating a state machine. + // + // An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the Amazon Web + // Services Billing and Cost Management User Guide, and [Controlling Access Using IAM Tags]. + // + // 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 + // [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html Tags []types.Tag // Selects whether X-Ray tracing is enabled. diff --git a/service/sfn/api_op_CreateStateMachineAlias.go b/service/sfn/api_op_CreateStateMachineAlias.go index d05e94ae411..ca89fc466e2 100644 --- a/service/sfn/api_op_CreateStateMachineAlias.go +++ b/service/sfn/api_op_CreateStateMachineAlias.go @@ -12,28 +12,41 @@ import ( "time" ) -// Creates an alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// for a state machine that points to one or two versions (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// of the same state machine. You can set your application to call StartExecution -// with an alias and update the version the alias uses without changing the -// client's code. You can also map an alias to split StartExecution requests -// between two versions of a state machine. To do this, add a second RoutingConfig -// object in the routingConfiguration parameter. You must also specify the -// percentage of execution run requests each version should receive in both -// RoutingConfig objects. Step Functions randomly chooses which version runs a -// given execution based on the percentage you specify. To create an alias that -// points to a single version, specify a single RoutingConfig object with a weight -// set to 100. You can create up to 100 aliases for each state machine. You must -// delete unused aliases using the DeleteStateMachineAlias API action. +// Creates an [alias] for a state machine that points to one or two [versions] of the same state +// machine. You can set your application to call StartExecutionwith an alias and update the +// version the alias uses without changing the client's code. +// +// You can also map an alias to split StartExecution requests between two versions of a state +// machine. To do this, add a second RoutingConfig object in the +// routingConfiguration parameter. You must also specify the percentage of +// execution run requests each version should receive in both RoutingConfig +// objects. Step Functions randomly chooses which version runs a given execution +// based on the percentage you specify. +// +// To create an alias that points to a single version, specify a single +// RoutingConfig object with a weight set to 100. +// +// You can create up to 100 aliases for each state machine. You must delete unused +// aliases using the DeleteStateMachineAliasAPI action. +// // CreateStateMachineAlias is an idempotent API. Step Functions bases the // idempotency check on the stateMachineArn , description , name , and // routingConfiguration parameters. Requests that contain the same values for these // parameters return a successful idempotent response without creating a duplicate -// resource. Related operations: -// - DescribeStateMachineAlias -// - ListStateMachineAliases -// - UpdateStateMachineAlias -// - DeleteStateMachineAlias +// resource. +// +// Related operations: +// +// # DescribeStateMachineAlias +// +// # ListStateMachineAliases +// +// # UpdateStateMachineAlias +// +// # DeleteStateMachineAlias +// +// [versions]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html func (c *Client) CreateStateMachineAlias(ctx context.Context, params *CreateStateMachineAliasInput, optFns ...func(*Options)) (*CreateStateMachineAliasOutput, error) { if params == nil { params = &CreateStateMachineAliasInput{} @@ -51,8 +64,10 @@ func (c *Client) CreateStateMachineAlias(ctx context.Context, params *CreateStat type CreateStateMachineAliasInput struct { - // The name of the state machine alias. To avoid conflict with version ARNs, don't - // use an integer in the name of the alias. + // The name of the state machine alias. + // + // To avoid conflict with version ARNs, don't use an integer in the name of the + // alias. // // This member is required. Name *string diff --git a/service/sfn/api_op_DeleteStateMachine.go b/service/sfn/api_op_DeleteStateMachine.go index 534f36b37e1..82c920892d7 100644 --- a/service/sfn/api_op_DeleteStateMachine.go +++ b/service/sfn/api_op_DeleteStateMachine.go @@ -13,24 +13,35 @@ import ( // Deletes a state machine. This is an asynchronous operation. It sets the state // machine's status to DELETING and begins the deletion process. A state machine // is deleted only when all its executions are completed. On the next state -// transition, the state machine's executions are terminated. A qualified state -// machine ARN can either refer to a Distributed Map state defined within a state -// machine, a version ARN, or an alias ARN. The following are some examples of -// qualified and unqualified state machine ARNs: +// transition, the state machine's executions are terminated. +// +// A qualified state machine ARN can either refer to a Distributed Map state +// defined within a state machine, a version ARN, or an alias ARN. +// +// The following are some examples of qualified and unqualified state machine ARNs: +// // - The following qualified state machine ARN refers to a Distributed Map state // with a label mapStateLabel in a state machine named myStateMachine . -// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel -// If you provide a qualified state machine ARN that refers to a Distributed Map -// state, the request fails with ValidationException . -// - The following unqualified state machine ARN refers to a state machine named -// myStateMachine . -// arn:partition:states:region:account-id:stateMachine:myStateMachine // -// This API action also deletes all versions (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// and aliases (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// associated with a state machine. For EXPRESS state machines, the deletion -// happens eventually (usually in less than a minute). Running executions may emit -// logs after DeleteStateMachine API is called. +// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel +// +// If you provide a qualified state machine ARN that refers to a Distributed Map +// +// state, the request fails with ValidationException . +// +// - The following unqualified state machine ARN refers to a state machine named +// myStateMachine . +// +// arn:partition:states:region:account-id:stateMachine:myStateMachine +// +// This API action also deletes all [versions] and [aliases] associated with a state machine. +// +// For EXPRESS state machines, the deletion happens eventually (usually in less +// than a minute). Running executions may emit logs after DeleteStateMachine API +// is called. +// +// [aliases]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html +// [versions]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) DeleteStateMachine(ctx context.Context, params *DeleteStateMachineInput, optFns ...func(*Options)) (*DeleteStateMachineOutput, error) { if params == nil { params = &DeleteStateMachineInput{} diff --git a/service/sfn/api_op_DeleteStateMachineAlias.go b/service/sfn/api_op_DeleteStateMachineAlias.go index 42b4b534618..718528f49b0 100644 --- a/service/sfn/api_op_DeleteStateMachineAlias.go +++ b/service/sfn/api_op_DeleteStateMachineAlias.go @@ -10,14 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// . After you delete a state machine alias, you can't use it to start executions. +// Deletes a state machine [alias]. +// +// After you delete a state machine alias, you can't use it to start executions. // When you delete a state machine alias, Step Functions doesn't delete the state -// machine versions that alias references. Related operations: -// - CreateStateMachineAlias -// - DescribeStateMachineAlias -// - ListStateMachineAliases -// - UpdateStateMachineAlias +// machine versions that alias references. +// +// Related operations: +// +// # CreateStateMachineAlias +// +// # DescribeStateMachineAlias +// +// # ListStateMachineAliases +// +// # UpdateStateMachineAlias +// +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html func (c *Client) DeleteStateMachineAlias(ctx context.Context, params *DeleteStateMachineAliasInput, optFns ...func(*Options)) (*DeleteStateMachineAliasOutput, error) { if params == nil { params = &DeleteStateMachineAliasInput{} diff --git a/service/sfn/api_op_DeleteStateMachineVersion.go b/service/sfn/api_op_DeleteStateMachineVersion.go index e608b403e32..ee0dd0fada6 100644 --- a/service/sfn/api_op_DeleteStateMachineVersion.go +++ b/service/sfn/api_op_DeleteStateMachineVersion.go @@ -10,15 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes a state machine version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// . After you delete a version, you can't call StartExecution using that -// version's ARN or use the version with a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// . Deleting a state machine version won't terminate its in-progress executions. +// Deletes a state machine [version]. After you delete a version, you can't call StartExecution using +// that version's ARN or use the version with a state machine [alias]. +// +// Deleting a state machine version won't terminate its in-progress executions. +// // You can't delete a state machine version currently referenced by one or more // aliases. Before you delete a version, you must either delete the aliases or -// update them to point to another state machine version. Related operations: -// - PublishStateMachineVersion -// - ListStateMachineVersions +// update them to point to another state machine version. +// +// Related operations: +// +// # PublishStateMachineVersion +// +// # ListStateMachineVersions +// +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html +// [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) DeleteStateMachineVersion(ctx context.Context, params *DeleteStateMachineVersionInput, optFns ...func(*Options)) (*DeleteStateMachineVersionOutput, error) { if params == nil { params = &DeleteStateMachineVersionInput{} diff --git a/service/sfn/api_op_DescribeActivity.go b/service/sfn/api_op_DescribeActivity.go index 4a7493050b5..5dbc71838a8 100644 --- a/service/sfn/api_op_DescribeActivity.go +++ b/service/sfn/api_op_DescribeActivity.go @@ -11,8 +11,10 @@ import ( "time" ) -// Describes an activity. This operation is eventually consistent. The results are -// best effort and may not reflect very recent updates and changes. +// Describes an activity. +// +// This operation is eventually consistent. The results are best effort and may +// not reflect very recent updates and changes. func (c *Client) DescribeActivity(ctx context.Context, params *DescribeActivityInput, optFns ...func(*Options)) (*DescribeActivityOutput, error) { if params == nil { params = &DescribeActivityInput{} @@ -50,12 +52,20 @@ type DescribeActivityOutput struct { // This member is required. CreationDate *time.Time - // The name of the activity. A name must not contain: + // 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 _. // diff --git a/service/sfn/api_op_DescribeExecution.go b/service/sfn/api_op_DescribeExecution.go index 45a3cfaec87..e0e3422f49f 100644 --- a/service/sfn/api_op_DescribeExecution.go +++ b/service/sfn/api_op_DescribeExecution.go @@ -14,15 +14,21 @@ import ( // Provides information about a state machine execution, such as the state machine // associated with the execution, the execution input and output, and relevant -// execution metadata. If you've redriven (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html) -// an execution, you can use this API action to return information about the -// redrives of that execution. In addition, you can use this API action to return -// the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map -// Run. If you specify a version or alias ARN when you call the StartExecution API -// action, DescribeExecution returns that ARN. This operation is eventually -// consistent. The results are best effort and may not reflect very recent updates -// and changes. Executions of an EXPRESS state machine aren't supported by -// DescribeExecution unless a Map Run dispatched them. +// execution metadata. If you've [redriven]an execution, you can use this API action to +// return information about the redrives of that execution. In addition, you can +// use this API action to return the Map Run Amazon Resource Name (ARN) if the +// execution was dispatched by a Map Run. +// +// If you specify a version or alias ARN when you call the StartExecution API action, +// DescribeExecution returns that ARN. +// +// This operation is eventually consistent. The results are best effort and may +// not reflect very recent updates and changes. +// +// Executions of an EXPRESS state machine aren't supported by DescribeExecution +// unless a Map Run dispatched them. +// +// [redriven]: https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html func (c *Client) DescribeExecution(ctx context.Context, params *DescribeExecutionInput, optFns ...func(*Options)) (*DescribeExecutionOutput, error) { if params == nil { params = &DescribeExecutionInput{} @@ -88,19 +94,29 @@ type DescribeExecutionOutput struct { // execution. MapRunArn *string - // The name of the execution. A name must not contain: + // 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 _. Name *string // The JSON output data of the execution. Length constraints apply to the payload - // size, and are expressed as bytes in UTF-8 encoding. This field is set only if - // the execution succeeds. If the execution fails, this field is null. + // size, and are expressed as bytes in UTF-8 encoding. + // + // This field is set only if the execution succeeds. If the execution fails, this + // field is null. Output *string // Provides details about execution input or output. @@ -112,36 +128,53 @@ type DescribeExecutionOutput struct { RedriveCount *int32 // The date the execution was last redriven. If you have not yet redriven an - // execution, the redriveDate is null. The redriveDate is unavailable if you - // redrive a Map Run that starts child workflow executions of type EXPRESS . + // execution, the redriveDate is null. + // + // The redriveDate is unavailable if you redrive a Map Run that starts child + // workflow executions of type EXPRESS . RedriveDate *time.Time // Indicates whether or not an execution can be redriven at a given point in time. + // // - For executions of type STANDARD , redriveStatus is NOT_REDRIVABLE if calling - // the RedriveExecution API action would return the ExecutionNotRedrivable error. + // the RedriveExecutionAPI action would return the ExecutionNotRedrivable error. + // // - For a Distributed Map that includes child workflows of type STANDARD , // redriveStatus indicates whether or not the Map Run can redrive child workflow // executions. + // // - For a Distributed Map that includes child workflows of type EXPRESS , // redriveStatus indicates whether or not the Map Run can redrive child workflow - // executions. You can redrive failed or timed out EXPRESS workflows only if - // they're a part of a Map Run. When you redrive (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html) - // the Map Run, these workflows are restarted using the StartExecution API + // executions. + // + // You can redrive failed or timed out EXPRESS workflows only if they're a part of + // a Map Run. When you [redrive]the Map Run, these workflows are restarted using the StartExecutionAPI // action. + // + // [redrive]: https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html RedriveStatus types.ExecutionRedriveStatus // When redriveStatus is NOT_REDRIVABLE , redriveStatusReason specifies the reason // why an execution cannot be redriven. + // // - For executions of type STANDARD , or for a Distributed Map that includes // child workflows of type STANDARD , redriveStatusReason can include one of the // following reasons: + // // - State machine is in DELETING status . + // // - Execution is RUNNING and cannot be redriven . + // // - Execution is SUCCEEDED and cannot be redriven . + // // - Execution was started before the launch of RedriveExecution . + // // - Execution history event limit exceeded . + // // - Execution has exceeded the max execution time . + // // - Execution redrivable period exceeded . + // // - For a Distributed Map that includes child workflows of type EXPRESS , // redriveStatusReason is only returned if the child workflows are not // redrivable. This happens when the child workflow executions have completed @@ -150,16 +183,18 @@ type DescribeExecutionOutput struct { // The Amazon Resource Name (ARN) of the state machine alias associated with the // execution. The alias ARN is a combination of state machine ARN and the alias - // name separated by a colon (:). For example, stateMachineARN:PROD . If you start - // an execution from a StartExecution request with a state machine version ARN, - // this field will be null. + // name separated by a colon (:). For example, stateMachineARN:PROD . + // + // If you start an execution from a StartExecution request with a state machine + // version ARN, this field will be null. StateMachineAliasArn *string // The Amazon Resource Name (ARN) of the state machine version associated with the // execution. The version ARN is a combination of state machine ARN and the version - // number separated by a colon (:). For example, stateMachineARN:1 . If you start - // an execution from a StartExecution request without specifying a state machine - // version or alias ARN, Step Functions returns a null value. + // number separated by a colon (:). For example, stateMachineARN:1 . + // + // If you start an execution from a StartExecution request without specifying a + // state machine version or alias ARN, Step Functions returns a null value. StateMachineVersionArn *string // If the execution ended, the date the execution stopped. diff --git a/service/sfn/api_op_DescribeMapRun.go b/service/sfn/api_op_DescribeMapRun.go index 7e22adc7a03..7f8ce485e23 100644 --- a/service/sfn/api_op_DescribeMapRun.go +++ b/service/sfn/api_op_DescribeMapRun.go @@ -13,10 +13,12 @@ import ( ) // Provides information about a Map Run's configuration, progress, and results. If -// you've redriven (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html) -// a Map Run, this API action also returns information about the redrives of that -// Map Run. 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. +// you've [redriven]a Map Run, this API action also returns information about the redrives +// of that Map Run. For more information, see [Examining Map Run]in the Step Functions Developer +// Guide. +// +// [redriven]: https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html +// [Examining Map Run]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html func (c *Client) DescribeMapRun(ctx context.Context, params *DescribeMapRunInput, optFns ...func(*Options)) (*DescribeMapRunOutput, error) { if params == nil { params = &DescribeMapRunInput{} diff --git a/service/sfn/api_op_DescribeStateMachine.go b/service/sfn/api_op_DescribeStateMachine.go index 3e2ab496b37..58eeca1d69f 100644 --- a/service/sfn/api_op_DescribeStateMachine.go +++ b/service/sfn/api_op_DescribeStateMachine.go @@ -13,26 +13,40 @@ import ( ) // Provides information about a state machine's definition, its IAM role Amazon -// Resource Name (ARN), and configuration. A qualified state machine ARN can either -// refer to a Distributed Map state defined within a state machine, a version ARN, -// or an alias ARN. The following are some examples of qualified and unqualified -// state machine ARNs: +// Resource Name (ARN), and configuration. +// +// A qualified state machine ARN can either refer to a Distributed Map state +// defined within a state machine, a version ARN, or an alias ARN. +// +// The following are some examples of qualified and unqualified state machine ARNs: +// // - The following qualified state machine ARN refers to a Distributed Map state // with a label mapStateLabel in a state machine named myStateMachine . -// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel -// If you provide a qualified state machine ARN that refers to a Distributed Map -// state, the request fails with ValidationException . -// - The following qualified state machine ARN refers to an alias named PROD . -// arn::states:::stateMachine: If you provide a qualified state machine ARN that -// refers to a version ARN or an alias ARN, the request starts execution for that -// version or alias. -// - The following unqualified state machine ARN refers to a state machine named -// myStateMachine . arn::states:::stateMachine: +// +// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel +// +// If you provide a qualified state machine ARN that refers to a Distributed Map +// +// state, the request fails with ValidationException . +// +// - The following qualified state machine ARN refers to an alias named PROD . +// +// arn::states:::stateMachine: +// +// If you provide a qualified state machine ARN that refers to a version ARN or an +// +// alias ARN, the request starts execution for that version or alias. +// +// - The following unqualified state machine ARN refers to a state machine named +// myStateMachine . +// +// arn::states:::stateMachine: // // This API action returns the details for a state machine version if the -// stateMachineArn you specify is a state machine version ARN. This operation is -// eventually consistent. The results are best effort and may not reflect very -// recent updates and changes. +// stateMachineArn you specify is a state machine version ARN. +// +// 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 { params = &DescribeStateMachineInput{} @@ -51,10 +65,11 @@ func (c *Client) DescribeStateMachine(ctx context.Context, params *DescribeState type DescribeStateMachineInput struct { // The Amazon Resource Name (ARN) of the state machine for which you want the - // information. If you specify a state machine version ARN, this API returns - // details about that version. The version ARN is a combination of state machine - // ARN and the version number separated by a colon (:). For example, - // stateMachineARN:1 . + // information. + // + // If you specify a state machine version ARN, this API returns details about that + // version. The version ARN is a combination of state machine ARN and the version + // number separated by a colon (:). For example, stateMachineARN:1 . // // This member is required. StateMachineArn *string @@ -64,25 +79,34 @@ type DescribeStateMachineInput struct { type DescribeStateMachineOutput struct { - // The date the state machine is created. For a state machine version, creationDate - // is the date the version was created. + // The date the state machine is created. + // + // For a state machine version, creationDate is the date the version was created. // // This member is required. 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) - // . + // The Amazon States Language definition of the state machine. See [Amazon States Language]. + // + // [Amazon States 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: + // 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 _. // @@ -96,9 +120,10 @@ type DescribeStateMachineOutput struct { // This member is required. RoleArn *string - // The Amazon Resource Name (ARN) that identifies the state machine. If you - // specified a state machine version ARN in your request, the API returns the - // version ARN. The version ARN is a combination of state machine ARN and the + // The Amazon Resource Name (ARN) that identifies the state machine. + // + // If you specified a state machine version ARN in your request, the API returns + // the version ARN. The version ARN is a combination of state machine ARN and the // version number separated by a colon (:). For example, stateMachineARN:1 . // // This member is required. @@ -120,9 +145,11 @@ type DescribeStateMachineOutput struct { // The LoggingConfiguration data type is used to set CloudWatch Logs options. LoggingConfiguration *types.LoggingConfiguration - // The revision identifier for the state machine. Use the revisionId parameter to - // compare between versions of a state machine configuration used for executions - // without performing a diff of the properties, such as definition and roleArn . + // The revision identifier for the state machine. + // + // Use the revisionId parameter to compare between versions of a state machine + // configuration used for executions without performing a diff of the properties, + // such as definition and roleArn . RevisionId *string // The current status of the state machine. diff --git a/service/sfn/api_op_DescribeStateMachineAlias.go b/service/sfn/api_op_DescribeStateMachineAlias.go index e488941271e..90fe738256f 100644 --- a/service/sfn/api_op_DescribeStateMachineAlias.go +++ b/service/sfn/api_op_DescribeStateMachineAlias.go @@ -12,12 +12,19 @@ import ( "time" ) -// Returns details about a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// . Related operations: -// - CreateStateMachineAlias -// - ListStateMachineAliases -// - UpdateStateMachineAlias -// - DeleteStateMachineAlias +// Returns details about a state machine [alias]. +// +// Related operations: +// +// # CreateStateMachineAlias +// +// # ListStateMachineAliases +// +// # UpdateStateMachineAlias +// +// # DeleteStateMachineAlias +// +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html func (c *Client) DescribeStateMachineAlias(ctx context.Context, params *DescribeStateMachineAliasInput, optFns ...func(*Options)) (*DescribeStateMachineAliasOutput, error) { if params == nil { params = &DescribeStateMachineAliasInput{} @@ -60,8 +67,9 @@ type DescribeStateMachineAliasOutput struct { // The Amazon Resource Name (ARN) of the state machine alias. StateMachineAliasArn *string - // The date the state machine alias was last updated. For a newly created state - // machine, this is the same as the creation date. + // The date the state machine alias was last updated. + // + // For a newly created state machine, this is the same as the creation date. UpdateDate *time.Time // Metadata pertaining to the operation's result. diff --git a/service/sfn/api_op_DescribeStateMachineForExecution.go b/service/sfn/api_op_DescribeStateMachineForExecution.go index f509826d3f1..cd05a2516df 100644 --- a/service/sfn/api_op_DescribeStateMachineForExecution.go +++ b/service/sfn/api_op_DescribeStateMachineForExecution.go @@ -15,10 +15,12 @@ import ( // Provides information about a state machine's definition, its execution role // ARN, and configuration. If a Map Run dispatched the execution, this action // returns the Map Run Amazon Resource Name (ARN) in the response. The state -// machine returned is 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. +// machine returned is 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) { if params == nil { params = &DescribeStateMachineForExecutionInput{} @@ -47,9 +49,9 @@ 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) - // . + // The Amazon States Language definition of the state machine. See [Amazon States Language]. + // + // [Amazon States Language]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html // // This member is required. Definition *string @@ -91,10 +93,11 @@ type DescribeStateMachineForExecutionOutput struct { MapRunArn *string // The revision identifier for the state machine. The first revision ID when you - // create the state machine is null. Use the state machine revisionId parameter to - // compare the revision of a state machine with the configuration of the state - // machine used for executions without performing a diff of the properties, such as - // definition and roleArn . + // create the state machine is null. + // + // Use the state machine revisionId parameter to compare the revision of a state + // machine with the configuration of the state machine used for executions without + // performing a diff of the properties, such as definition and roleArn . RevisionId *string // Selects whether X-Ray tracing is enabled. diff --git a/service/sfn/api_op_GetActivityTask.go b/service/sfn/api_op_GetActivityTask.go index cf460b28ac9..c967c6471d1 100644 --- a/service/sfn/api_op_GetActivityTask.go +++ b/service/sfn/api_op_GetActivityTask.go @@ -16,12 +16,17 @@ import ( // task becomes available (i.e. an execution of a task of this type is needed.) The // maximum time the service holds on to the request before responding is 60 // seconds. If no task is available within 60 seconds, the poll returns a taskToken -// with a null string. This API action isn't logged in CloudTrail. Workers should -// 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) -// in the Step Functions Developer Guide. +// with a null string. +// +// This API action isn't logged in CloudTrail. +// +// Workers should 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] in +// the Step Functions Developer Guide. +// +// [Avoid Latency When Polling for Activity Tasks]: https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html func (c *Client) GetActivityTask(ctx context.Context, params *GetActivityTaskInput, optFns ...func(*Options)) (*GetActivityTaskOutput, error) { if params == nil { params = &GetActivityTaskInput{} @@ -40,7 +45,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 @@ -59,8 +64,8 @@ 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 - // SendTaskFailure in order to report the progress or completion of the task. + // included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or + // completion of the task. TaskToken *string // Metadata pertaining to the operation's result. diff --git a/service/sfn/api_op_GetExecutionHistory.go b/service/sfn/api_op_GetExecutionHistory.go index ea816f9e65b..c67336a6d7d 100644 --- a/service/sfn/api_op_GetExecutionHistory.go +++ b/service/sfn/api_op_GetExecutionHistory.go @@ -13,13 +13,15 @@ import ( // Returns the history of the specified execution as a list of events. By default, // the results are returned in ascending order of the timeStamp of the events. Use -// the reverseOrder parameter to get the latest events first. If nextToken is -// returned, 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. Each pagination -// token expires after 24 hours. Using an expired pagination token will return an -// HTTP 400 InvalidToken error. This API action is not supported by EXPRESS state -// machines. +// the reverseOrder parameter to get the latest events first. +// +// If nextToken is returned, 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. Each pagination token expires after 24 hours. Using an expired +// pagination token will return an HTTP 400 InvalidToken error. +// +// This API action is not supported by EXPRESS state machines. func (c *Client) GetExecutionHistory(ctx context.Context, params *GetExecutionHistoryInput, optFns ...func(*Options)) (*GetExecutionHistoryOutput, error) { if params == nil { params = &GetExecutionHistoryInput{} @@ -48,9 +50,10 @@ type GetExecutionHistoryInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of @@ -178,9 +181,10 @@ var _ GetExecutionHistoryAPIClient = (*Client)(nil) type GetExecutionHistoryPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sfn/api_op_ListActivities.go b/service/sfn/api_op_ListActivities.go index 5979ff281b1..ed8ac4e0717 100644 --- a/service/sfn/api_op_ListActivities.go +++ b/service/sfn/api_op_ListActivities.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the existing activities. If nextToken is returned, 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. Each pagination token expires after 24 hours. Using -// an expired pagination token will return an HTTP 400 InvalidToken error. This -// operation is eventually consistent. The results are best effort and may not -// reflect very recent updates and changes. +// Lists the existing activities. +// +// If nextToken is returned, 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. Each pagination token expires after 24 hours. Using an expired +// pagination token will return an HTTP 400 InvalidToken error. +// +// This operation is eventually consistent. The results are best effort and may +// not reflect very recent updates and changes. func (c *Client) ListActivities(ctx context.Context, params *ListActivitiesInput, optFns ...func(*Options)) (*ListActivitiesOutput, error) { if params == nil { params = &ListActivitiesInput{} @@ -37,9 +40,10 @@ type ListActivitiesInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of @@ -160,9 +164,10 @@ var _ ListActivitiesAPIClient = (*Client)(nil) type ListActivitiesPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sfn/api_op_ListExecutions.go b/service/sfn/api_op_ListExecutions.go index 9904e72c655..6b9450209ab 100644 --- a/service/sfn/api_op_ListExecutions.go +++ b/service/sfn/api_op_ListExecutions.go @@ -14,18 +14,27 @@ import ( // Lists all executions of a state machine or a Map Run. You can list all // executions related to a state machine by specifying a state machine Amazon // Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. -// Using this API action, you can also list all redriven (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html) -// executions. You can also provide a state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// ARN or version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// ARN to list the executions associated with a specific alias or version. Results -// are sorted by time, with the most recent execution first. If nextToken is -// returned, 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. Each pagination -// token expires after 24 hours. Using an expired pagination token will return an -// HTTP 400 InvalidToken error. This operation is eventually consistent. The -// results are best effort and may not reflect very recent updates and changes. +// Using this API action, you can also list all [redriven]executions. +// +// You can also provide a state machine [alias] ARN or [version] ARN to list the executions +// associated with a specific alias or version. +// +// Results are sorted by time, with the most recent execution first. +// +// If nextToken is returned, 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. Each pagination token expires after 24 hours. Using an expired +// pagination token will return an HTTP 400 InvalidToken error. +// +// 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. +// +// [redriven]: https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html +// [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) ListExecutions(ctx context.Context, params *ListExecutionsInput, optFns ...func(*Options)) (*ListExecutionsOutput, error) { if params == nil { params = &ListExecutionsInput{} @@ -45,17 +54,20 @@ 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) - // in the Step Functions Developer Guide. You can specify either a mapRunArn or a - // stateMachineArn , but not both. + // workflow executions started by a Map Run is returned. For more information, see [Examining Map Run] + // in the Step Functions Developer Guide. + // + // You can specify either a mapRunArn or a stateMachineArn , but not both. + // + // [Examining Map Run]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html MapRunArn *string // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of @@ -66,18 +78,27 @@ type ListExecutionsInput struct { NextToken *string // Sets a filter to list executions based on whether or not they have been - // redriven. For a Distributed Map, redriveFilter sets a filter to list child - // workflow executions based on whether or not they have been redriven. If you do - // not provide a redriveFilter , Step Functions returns a list of both redriven and - // non-redriven executions. If you provide a state machine ARN in redriveFilter , - // the API returns a validation exception. + // redriven. + // + // For a Distributed Map, redriveFilter sets a filter to list child workflow + // executions based on whether or not they have been redriven. + // + // If you do not provide a redriveFilter , Step Functions returns a list of both + // redriven and non-redriven executions. + // + // If you provide a state machine ARN in redriveFilter , the API returns a + // validation exception. RedriveFilter types.ExecutionRedriveFilter // 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 - // also return a list of executions associated with a specific alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) - // or version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) - // , by specifying an alias ARN or a version ARN in the stateMachineArn parameter. + // + // You can specify either a mapRunArn or a stateMachineArn , but not both. + // + // You can also return a list of executions associated with a specific [alias] or [version], by + // specifying an alias ARN or a version ARN in the stateMachineArn parameter. + // + // [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html + // [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html StateMachineArn *string // If specified, only list the executions whose current execution status matches @@ -195,9 +216,10 @@ var _ ListExecutionsAPIClient = (*Client)(nil) type ListExecutionsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sfn/api_op_ListMapRuns.go b/service/sfn/api_op_ListMapRuns.go index 45378d6eaf7..60c1b30a46d 100644 --- a/service/sfn/api_op_ListMapRuns.go +++ b/service/sfn/api_op_ListMapRuns.go @@ -39,9 +39,10 @@ type ListMapRunsInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of @@ -166,9 +167,10 @@ var _ ListMapRunsAPIClient = (*Client)(nil) type ListMapRunsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sfn/api_op_ListStateMachineAliases.go b/service/sfn/api_op_ListStateMachineAliases.go index c11b96ce1cd..24cf0ab0593 100644 --- a/service/sfn/api_op_ListStateMachineAliases.go +++ b/service/sfn/api_op_ListStateMachineAliases.go @@ -11,20 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists aliases (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// for a specified state machine ARN. Results are sorted by time, with the most -// recently created aliases listed first. To list aliases that reference a state -// machine version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// , you can specify the version ARN in the stateMachineArn parameter. If nextToken -// is returned, 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. Each -// pagination token expires after 24 hours. Using an expired pagination token will -// return an HTTP 400 InvalidToken error. Related operations: -// - CreateStateMachineAlias -// - DescribeStateMachineAlias -// - UpdateStateMachineAlias -// - DeleteStateMachineAlias +// Lists [aliases] for a specified state machine ARN. Results are sorted by time, with the +// most recently created aliases listed first. +// +// To list aliases that reference a state machine [version], you can specify the version +// ARN in the stateMachineArn parameter. +// +// If nextToken is returned, 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. Each pagination token expires after 24 hours. Using an expired +// pagination token will return an HTTP 400 InvalidToken error. +// +// Related operations: +// +// # CreateStateMachineAlias +// +// # DescribeStateMachineAlias +// +// # UpdateStateMachineAlias +// +// # DeleteStateMachineAlias +// +// [aliases]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html +// [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) ListStateMachineAliases(ctx context.Context, params *ListStateMachineAliasesInput, optFns ...func(*Options)) (*ListStateMachineAliasesOutput, error) { if params == nil { params = &ListStateMachineAliasesInput{} @@ -43,17 +53,20 @@ func (c *Client) ListStateMachineAliases(ctx context.Context, params *ListStateM type ListStateMachineAliasesInput struct { // The Amazon Resource Name (ARN) of the state machine for which you want to list - // aliases. If you specify a state machine version ARN, this API returns a list of - // aliases for that version. + // aliases. + // + // If you specify a state machine version ARN, this API returns a list of aliases + // for that version. // // This member is required. StateMachineArn *string // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of diff --git a/service/sfn/api_op_ListStateMachineVersions.go b/service/sfn/api_op_ListStateMachineVersions.go index 0af44198c45..c16b8ebdbdb 100644 --- a/service/sfn/api_op_ListStateMachineVersions.go +++ b/service/sfn/api_op_ListStateMachineVersions.go @@ -11,16 +11,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists versions (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// for the specified state machine Amazon Resource Name (ARN). The results are -// sorted in descending order of the version creation time. If nextToken is -// returned, 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. Each pagination -// token expires after 24 hours. Using an expired pagination token will return an -// HTTP 400 InvalidToken error. Related operations: -// - PublishStateMachineVersion -// - DeleteStateMachineVersion +// Lists [versions] for the specified state machine Amazon Resource Name (ARN). +// +// The results are sorted in descending order of the version creation time. +// +// If nextToken is returned, 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. Each pagination token expires after 24 hours. Using an expired +// pagination token will return an HTTP 400 InvalidToken error. +// +// Related operations: +// +// # PublishStateMachineVersion +// +// # DeleteStateMachineVersion +// +// [versions]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) ListStateMachineVersions(ctx context.Context, params *ListStateMachineVersionsInput, optFns ...func(*Options)) (*ListStateMachineVersionsOutput, error) { if params == nil { params = &ListStateMachineVersionsInput{} @@ -45,9 +52,10 @@ type ListStateMachineVersionsInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of diff --git a/service/sfn/api_op_ListStateMachines.go b/service/sfn/api_op_ListStateMachines.go index b37d2be2a04..c2d17506c43 100644 --- a/service/sfn/api_op_ListStateMachines.go +++ b/service/sfn/api_op_ListStateMachines.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the existing state machines. If nextToken is returned, 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. Each pagination token expires after 24 -// hours. Using an expired pagination token will return an HTTP 400 InvalidToken -// error. This operation is eventually consistent. The results are best effort and -// may not reflect very recent updates and changes. +// Lists the existing state machines. +// +// If nextToken is returned, 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. Each pagination token expires after 24 hours. Using an expired +// pagination token will return an HTTP 400 InvalidToken error. +// +// This operation is eventually consistent. The results are best effort and may +// not reflect very recent updates and changes. func (c *Client) ListStateMachines(ctx context.Context, params *ListStateMachinesInput, optFns ...func(*Options)) (*ListStateMachinesOutput, error) { if params == nil { params = &ListStateMachinesInput{} @@ -37,9 +40,10 @@ type ListStateMachinesInput struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults int32 // If nextToken is returned, there are more results available. The value of @@ -158,9 +162,10 @@ var _ ListStateMachinesAPIClient = (*Client)(nil) type ListStateMachinesPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken // to obtain further pages of results. The default is 100 and the maximum allowed - // page size is 1000. A value of 0 uses the default. This is only an upper limit. - // The actual number of results returned per call might be fewer than the specified - // maximum. + // page size is 1000. A value of 0 uses the default. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/sfn/api_op_ListTagsForResource.go b/service/sfn/api_op_ListTagsForResource.go index fd1281f7ed9..e46ae1bd914 100644 --- a/service/sfn/api_op_ListTagsForResource.go +++ b/service/sfn/api_op_ListTagsForResource.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List tags for a given resource. Tags may only contain Unicode letters, digits, -// white space, or these symbols: _ . : / = + - @ . +// List tags for a given resource. +// +// Tags may only contain Unicode letters, digits, 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_PublishStateMachineVersion.go b/service/sfn/api_op_PublishStateMachineVersion.go index 1cbcb992fe7..88b5d382421 100644 --- a/service/sfn/api_op_PublishStateMachineVersion.go +++ b/service/sfn/api_op_PublishStateMachineVersion.go @@ -11,21 +11,28 @@ import ( "time" ) -// Creates a version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// from the current revision of a state machine. Use versions to create immutable -// snapshots of your state machine. You can start executions from versions either -// directly or with an alias. To create an alias, use CreateStateMachineAlias . You -// can publish up to 1000 versions for each state machine. You must manually delete -// unused versions using the DeleteStateMachineVersion API action. +// Creates a [version] from the current revision of a state machine. Use versions to create +// immutable snapshots of your state machine. You can start executions from +// versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. +// +// You can publish up to 1000 versions for each state machine. You must manually +// delete unused versions using the DeleteStateMachineVersionAPI action. +// // PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate // state machine version if it already exists for the current revision. Step // Functions bases PublishStateMachineVersion 's idempotency check on the // stateMachineArn , name , and revisionId parameters. Requests with the same // parameters return a successful idempotent response. If you don't specify a // revisionId , Step Functions checks for a previously published version of the -// state machine's current revision. Related operations: -// - DeleteStateMachineVersion -// - ListStateMachineVersions +// state machine's current revision. +// +// Related operations: +// +// # DeleteStateMachineVersion +// +// # ListStateMachineVersions +// +// [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) PublishStateMachineVersion(ctx context.Context, params *PublishStateMachineVersionInput, optFns ...func(*Options)) (*PublishStateMachineVersionOutput, error) { if params == nil { params = &PublishStateMachineVersionInput{} @@ -52,13 +59,16 @@ type PublishStateMachineVersionInput struct { Description *string // Only publish the state machine version if the current state machine's revision - // ID matches the specified ID. Use this option to avoid publishing a version if - // the state machine changed since you last updated it. If the specified revision - // ID doesn't match the state machine's current revision ID, the API returns - // ConflictException . To specify an initial revision ID for a state machine with - // no revision ID assigned, specify the string INITIAL for the revisionId - // parameter. For example, you can specify a revisionID of INITIAL when you create - // a state machine using the CreateStateMachine API action. + // ID matches the specified ID. + // + // Use this option to avoid publishing a version if the state machine changed + // since you last updated it. If the specified revision ID doesn't match the state + // machine's current revision ID, the API returns ConflictException . + // + // To specify an initial revision ID for a state machine with no revision ID + // assigned, specify the string INITIAL for the revisionId parameter. For example, + // you can specify a revisionID of INITIAL when you create a state machine using + // the CreateStateMachineAPI action. RevisionId *string noSmithyDocumentSerde diff --git a/service/sfn/api_op_RedriveExecution.go b/service/sfn/api_op_RedriveExecution.go index ce12597b332..06bb8d93cdd 100644 --- a/service/sfn/api_op_RedriveExecution.go +++ b/service/sfn/api_op_RedriveExecution.go @@ -13,39 +13,52 @@ import ( // Restarts unsuccessful executions of Standard workflows that didn't complete // successfully in the last 14 days. These include failed, aborted, or timed out -// executions. When you redrive (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html) -// an execution, it continues the failed execution from the unsuccessful step and -// uses the same input. Step Functions preserves the results and execution history -// of the successful steps, and doesn't rerun these steps when you redrive an -// execution. Redriven executions use the same state machine definition and -// execution ARN as the original execution attempt. For workflows that include an -// Inline Map (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html) -// or Parallel (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html) -// state, RedriveExecution API action reschedules and redrives only the iterations -// and branches that failed or aborted. To redrive a workflow that includes a -// Distributed Map state whose Map Run failed, you must redrive the parent workflow (https://docs.aws.amazon.com/step-functions/latest/dg/use-dist-map-orchestrate-large-scale-parallel-workloads.html#dist-map-orchestrate-parallel-workloads-key-terms) -// . The parent workflow redrives all the unsuccessful states, including a failed -// Map Run. If a Map Run was not started in the original execution attempt, the -// redriven parent workflow starts the Map Run. This API action is not supported by -// EXPRESS state machines. However, you can restart the unsuccessful executions of -// Express child workflows in a Distributed Map by redriving its Map Run. When you -// redrive a Map Run, the Express child workflows are rerun using the -// StartExecution API action. For more information, see Redriving Map Runs (https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html) -// . You can redrive executions if your original execution meets the following +// executions. When you [redrive]an execution, it continues the failed execution from the +// unsuccessful step and uses the same input. Step Functions preserves the results +// and execution history of the successful steps, and doesn't rerun these steps +// when you redrive an execution. Redriven executions use the same state machine +// definition and execution ARN as the original execution attempt. +// +// For workflows that include an [Inline Map] or [Parallel] state, RedriveExecution API action +// reschedules and redrives only the iterations and branches that failed or +// aborted. +// +// To redrive a workflow that includes a Distributed Map state whose Map Run +// failed, you must redrive the [parent workflow]. The parent workflow redrives all the +// unsuccessful states, including a failed Map Run. If a Map Run was not started in +// the original execution attempt, the redriven parent workflow starts the Map Run. +// +// This API action is not supported by EXPRESS state machines. +// +// However, you can restart the unsuccessful executions of Express child workflows +// in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the +// Express child workflows are rerun using the StartExecutionAPI action. For more information, +// see [Redriving Map Runs]. +// +// You can redrive executions if your original execution meets the following // conditions: +// // - The execution status isn't SUCCEEDED . +// // - Your workflow execution has not exceeded the redrivable period of 14 days. // Redrivable period refers to the time during which you can redrive a given // execution. This period starts from the day a state machine completes its // execution. +// // - The workflow execution has not exceeded the maximum open time of one year. -// For more information about state machine quotas, see Quotas related to state -// machine executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits-overview.html#service-limits-state-machine-executions) -// . +// For more information about state machine quotas, see [Quotas related to state machine executions]. +// // - The execution event history count is less than 24,999. Redriven executions // append their event history to the existing event history. Make sure your // workflow execution contains less than 24,999 events to accommodate the // ExecutionRedriven history event and at least one other history event. +// +// [redrive]: https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html +// [parent workflow]: https://docs.aws.amazon.com/step-functions/latest/dg/use-dist-map-orchestrate-large-scale-parallel-workloads.html#dist-map-orchestrate-parallel-workloads-key-terms +// [Quotas related to state machine executions]: https://docs.aws.amazon.com/step-functions/latest/dg/limits-overview.html#service-limits-state-machine-executions +// [Parallel]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html +// [Inline Map]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html +// [Redriving Map Runs]: https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html func (c *Client) RedriveExecution(ctx context.Context, params *RedriveExecutionInput, optFns ...func(*Options)) (*RedriveExecutionOutput, error) { if params == nil { params = &RedriveExecutionInput{} diff --git a/service/sfn/api_op_SendTaskFailure.go b/service/sfn/api_op_SendTaskFailure.go index 09285a9fa43..785e94e00d3 100644 --- a/service/sfn/api_op_SendTaskFailure.go +++ b/service/sfn/api_op_SendTaskFailure.go @@ -10,9 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by activity workers, Task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) -// pattern, and optionally Task states using the job run (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) -// pattern to report that the task identified by the taskToken failed. +// Used by activity workers, Task states using the [callback] pattern, and optionally Task +// states using the [job run]pattern to report that the task identified by the taskToken +// failed. +// +// [callback]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token +// [job run]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync func (c *Client) SendTaskFailure(ctx context.Context, params *SendTaskFailureInput, optFns ...func(*Options)) (*SendTaskFailureOutput, error) { if params == nil { params = &SendTaskFailureInput{} @@ -31,8 +34,10 @@ 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 . + // Functions when tasks are assigned to a worker, or in the [context object]when a workflow enters + // a task state. See GetActivityTaskOutput$taskToken. + // + // [context object]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html // // This member is required. TaskToken *string diff --git a/service/sfn/api_op_SendTaskHeartbeat.go b/service/sfn/api_op_SendTaskHeartbeat.go index 0f8fe160d67..57752b2ab80 100644 --- a/service/sfn/api_op_SendTaskHeartbeat.go +++ b/service/sfn/api_op_SendTaskHeartbeat.go @@ -10,20 +10,22 @@ 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) -// pattern, and optionally Task states using the job run (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) -// 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 -// contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry 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 -// timeout interval for heartbeats. +// Used by activity workers and Task states using the [callback] pattern, and optionally +// Task states using the [job run]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 contains an ActivityTimedOut entry for +// activities, or a TaskTimedOut entry for tasks using the [job run] or [callback] 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 timeout interval for +// heartbeats. +// +// [callback]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token +// [job run]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync func (c *Client) SendTaskHeartbeat(ctx context.Context, params *SendTaskHeartbeatInput, optFns ...func(*Options)) (*SendTaskHeartbeatOutput, error) { if params == nil { params = &SendTaskHeartbeatInput{} @@ -42,8 +44,10 @@ 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 . + // Functions when tasks are assigned to a worker, or in the [context object]when a workflow enters + // a task state. See GetActivityTaskOutput$taskToken. + // + // [context object]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html // // This member is required. TaskToken *string diff --git a/service/sfn/api_op_SendTaskSuccess.go b/service/sfn/api_op_SendTaskSuccess.go index 0d13a7aec9e..42b74c0221b 100644 --- a/service/sfn/api_op_SendTaskSuccess.go +++ b/service/sfn/api_op_SendTaskSuccess.go @@ -10,10 +10,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by activity workers, Task states using the callback (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token) -// pattern, and optionally Task states using the job run (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync) -// pattern to report that the task identified by the taskToken completed -// successfully. +// Used by activity workers, Task states using the [callback] pattern, and optionally Task +// states using the [job run]pattern to report that the task identified by the taskToken +// completed successfully. +// +// [callback]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token +// [job run]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync func (c *Client) SendTaskSuccess(ctx context.Context, params *SendTaskSuccessInput, optFns ...func(*Options)) (*SendTaskSuccessOutput, error) { if params == nil { params = &SendTaskSuccessInput{} @@ -38,8 +40,10 @@ type SendTaskSuccessInput struct { 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 . + // Functions when tasks are assigned to a worker, or in the [context object]when a workflow enters + // a task state. See GetActivityTaskOutput$taskToken. + // + // [context object]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html // // This member is required. TaskToken *string diff --git a/service/sfn/api_op_StartExecution.go b/service/sfn/api_op_StartExecution.go index fcf8401be1c..b77f7d04524 100644 --- a/service/sfn/api_op_StartExecution.go +++ b/service/sfn/api_op_StartExecution.go @@ -11,32 +11,51 @@ import ( "time" ) -// Starts a state machine execution. A qualified state machine ARN can either -// refer to a Distributed Map state defined within a state machine, a version ARN, -// or an alias ARN. The following are some examples of qualified and unqualified -// state machine ARNs: +// Starts a state machine execution. +// +// A qualified state machine ARN can either refer to a Distributed Map state +// defined within a state machine, a version ARN, or an alias ARN. +// +// The following are some examples of qualified and unqualified state machine ARNs: +// // - The following qualified state machine ARN refers to a Distributed Map state // with a label mapStateLabel in a state machine named myStateMachine . -// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel -// If you provide a qualified state machine ARN that refers to a Distributed Map -// state, the request fails with ValidationException . -// - The following qualified state machine ARN refers to an alias named PROD . -// arn::states:::stateMachine: If you provide a qualified state machine ARN that -// refers to a version ARN or an alias ARN, the request starts execution for that -// version or alias. -// - The following unqualified state machine ARN refers to a state machine named -// myStateMachine . arn::states:::stateMachine: +// +// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel +// +// If you provide a qualified state machine ARN that refers to a Distributed Map +// +// state, the request fails with ValidationException . +// +// - The following qualified state machine ARN refers to an alias named PROD . +// +// arn::states:::stateMachine: +// +// If you provide a qualified state machine ARN that refers to a version ARN or an +// +// alias ARN, the request starts execution for that version or alias. +// +// - The following unqualified state machine ARN refers to a state machine named +// myStateMachine . +// +// arn::states:::stateMachine: // // If you start an execution with an unqualified state machine ARN, Step Functions -// uses the latest revision of the state machine for the execution. To start -// executions of a state machine version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// , call StartExecution and provide the version ARN or the ARN of an alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// that points to the version. StartExecution is idempotent for STANDARD -// workflows. For a STANDARD workflow, if you call StartExecution with the same -// name and input as a running execution, the call succeeds and return the same -// response as the original request. If the execution is closed or if the input is -// different, it returns a 400 ExecutionAlreadyExists error. You can reuse names -// after 90 days. StartExecution isn't idempotent for EXPRESS workflows. +// uses the latest revision of the state machine for the execution. +// +// To start executions of a state machine [version], call StartExecution and provide the +// version ARN or the ARN of an [alias]that points to the version. +// +// StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, +// if you call StartExecution with the same name and input as a running execution, +// the call succeeds and return the same response as the original request. If the +// execution is closed or if the input is different, it returns a 400 +// ExecutionAlreadyExists error. You can reuse names after 90 days. +// +// StartExecution isn't idempotent for EXPRESS workflows. +// +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html +// [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) StartExecution(ctx context.Context, params *StartExecutionInput, optFns ...func(*Options)) (*StartExecutionOutput, error) { if params == nil { params = &StartExecutionInput{} @@ -54,48 +73,75 @@ func (c *Client) StartExecution(ctx context.Context, params *StartExecutionInput type StartExecutionInput struct { - // The Amazon Resource Name (ARN) of the state machine to execute. The - // stateMachineArn parameter accepts one of the following inputs: + // The Amazon Resource Name (ARN) of the state machine to execute. + // + // The stateMachineArn parameter accepts one of the following inputs: + // // - An unqualified state machine ARN – Refers to a state machine ARN that isn't // qualified with a version or alias ARN. The following is an example of an - // unqualified state machine ARN. arn::states:::stateMachine: Step Functions - // doesn't associate state machine executions that you start with an unqualified - // ARN with a version. This is true even if that version uses the same revision - // that the execution used. + // unqualified state machine ARN. + // + // arn::states:::stateMachine: + // + // Step Functions doesn't associate state machine executions that you start with + // an unqualified ARN with a version. This is true even if that version uses the + // same revision that the execution used. + // // - A state machine version ARN – Refers to a version ARN, which is a // combination of state machine ARN and the version number separated by a colon // (:). The following is an example of the ARN for version 10. - // arn::states:::stateMachine::10 Step Functions doesn't associate executions - // that you start with a version ARN with any aliases that point to that version. + // + // arn::states:::stateMachine::10 + // + // Step Functions doesn't associate executions that you start with a version ARN + // with any aliases that point to that version. + // // - A state machine alias ARN – Refers to an alias ARN, which is a combination // of state machine ARN and the alias name separated by a colon (:). The following - // is an example of the ARN for an alias named PROD . arn::states:::stateMachine: - // Step Functions associates executions that you start with an alias ARN with that + // is an example of the ARN for an alias named PROD . + // + // arn::states:::stateMachine: + // + // Step Functions associates executions that you start with an alias ARN with that // alias and the state machine version used for that execution. // // This member is required. StateMachineArn *string // The string that contains the JSON input data for the execution, for example: - // "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, - // you still must include the two braces, for example: "input": "{}" Length - // constraints apply to the payload size, and are expressed as bytes in UTF-8 - // encoding. + // + // "input": "{\"first_name\" : \"test\"}" + // + // If you don't include any JSON input data, you still must include the two + // braces, for example: "input": "{}" + // + // Length constraints apply to the payload size, and are expressed as bytes in + // UTF-8 encoding. Input *string // Optional 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. If you don't provide a name for the - // execution, Step Functions automatically generates a universally unique - // identifier (UUID) as the execution name. A name must not contain: + // see [Limits Related to State Machine Executions]in the Step Functions Developer Guide. + // + // If you don't provide a name for the execution, Step Functions automatically + // generates a universally unique identifier (UUID) as the execution name. + // + // 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 _. + // + // [Limits Related to State Machine Executions]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions 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 19f8b97cf8e..a81739d8b52 100644 --- a/service/sfn/api_op_StartSyncExecution.go +++ b/service/sfn/api_op_StartSyncExecution.go @@ -13,12 +13,15 @@ import ( ) // Starts a Synchronous Express state machine execution. StartSyncExecution is not -// available for STANDARD workflows. StartSyncExecution will return a 200 OK -// response, even if your execution fails, because the status code in the API -// response doesn't reflect function errors. Error codes are reserved for errors -// that prevent your execution from running, such as permissions errors, limit -// errors, or issues with your state machine code and configuration. This API -// action isn't logged in CloudTrail. +// available for STANDARD workflows. +// +// StartSyncExecution will return a 200 OK response, even if your execution fails, +// because the status code in the API response doesn't reflect function errors. +// Error codes are reserved for errors that prevent your execution from running, +// such as permissions errors, limit errors, or issues with your state machine code +// and configuration. +// +// This API action isn't logged in CloudTrail. func (c *Client) StartSyncExecution(ctx context.Context, params *StartSyncExecutionInput, optFns ...func(*Options)) (*StartSyncExecutionOutput, error) { if params == nil { params = &StartSyncExecutionInput{} @@ -42,10 +45,14 @@ type StartSyncExecutionInput struct { StateMachineArn *string // The string that contains the JSON input data for the execution, for example: - // "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, - // you still must include the two braces, for example: "input": "{}" Length - // constraints apply to the payload size, and are expressed as bytes in UTF-8 - // encoding. + // + // "input": "{\"first_name\" : \"test\"}" + // + // If you don't include any JSON input data, you still must include the two + // braces, for example: "input": "{}" + // + // Length constraints apply to the payload size, and are expressed as bytes in + // UTF-8 encoding. Input *string // The name of the execution. @@ -102,8 +109,10 @@ type StartSyncExecutionOutput struct { Name *string // The JSON output data of the execution. Length constraints apply to the payload - // size, and are expressed as bytes in UTF-8 encoding. This field is set only if - // the execution succeeds. If the execution fails, this field is null. + // size, and are expressed as bytes in UTF-8 encoding. + // + // This field is set only if the execution succeeds. If the execution fails, this + // field is null. Output *string // Provides details about execution input or output. diff --git a/service/sfn/api_op_StopExecution.go b/service/sfn/api_op_StopExecution.go index 5e83e1550fa..c753a9d920e 100644 --- a/service/sfn/api_op_StopExecution.go +++ b/service/sfn/api_op_StopExecution.go @@ -11,7 +11,9 @@ import ( "time" ) -// Stops an execution. This API action is not supported by EXPRESS state machines. +// Stops an execution. +// +// This API action is not supported by EXPRESS state machines. func (c *Client) StopExecution(ctx context.Context, params *StopExecutionInput, optFns ...func(*Options)) (*StopExecutionOutput, error) { if params == nil { params = &StopExecutionInput{} diff --git a/service/sfn/api_op_TagResource.go b/service/sfn/api_op_TagResource.go index ec649f24cae..7ebf438d9b2 100644 --- a/service/sfn/api_op_TagResource.go +++ b/service/sfn/api_op_TagResource.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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: -// _ . : / = + - @ . +// Add a tag to a Step Functions resource. +// +// An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the Amazon Web +// Services Billing and Cost Management User Guide, and [Controlling Access Using IAM Tags]. +// +// 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 +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -39,8 +43,10 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The list of tags to add to a resource. Tags may only contain Unicode letters, - // digits, white space, or these symbols: _ . : / = + - @ . + // The list of tags to add to a resource. + // + // Tags may only contain Unicode letters, digits, white space, or these symbols: _ + // . : / = + - @ . // // This member is required. Tags []types.Tag diff --git a/service/sfn/api_op_TestState.go b/service/sfn/api_op_TestState.go index f479a617946..088c823ca09 100644 --- a/service/sfn/api_op_TestState.go +++ b/service/sfn/api_op_TestState.go @@ -14,33 +14,53 @@ import ( // Accepts the definition of a single state and executes it. You can test a state // without creating a state machine or updating an existing state machine. Using // this API, you can test the following: -// - A state's input and output processing (https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-input-output-dataflow) -// data flow -// - An Amazon Web Services service integration (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-services.html) -// request and response -// - An HTTP Task (https://docs.aws.amazon.com/step-functions/latest/dg/connect-third-party-apis.html) -// request and response +// +// - A state's [input and output processing]data flow +// +// - An [Amazon Web Services service integration]request and response +// +// - An [HTTP Task]request and response // // You can call this API on only one state at a time. The states that you can test // include the following: -// - All Task types (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-task-state.html#task-types) -// except Activity (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html) -// - Pass (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-pass-state.html) -// - Wait (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-wait-state.html) -// - Choice (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html) -// - Succeed (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-succeed-state.html) -// - Fail (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-fail-state.html) +// +// [All Task types] +// - except [Activity] +// +// [Pass] +// +// [Wait] +// +// [Choice] +// +// [Succeed] +// +// [Fail] // // The TestState API assumes an IAM role which must contain the required IAM // permissions for the resources your state is accessing. For information about the -// permissions a state might need, see IAM permissions to test a state (https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions) -// . The TestState API can run for up to five minutes. If the execution of a state -// exceeds this duration, it fails with the States.Timeout error. TestState -// doesn't support Activity tasks (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html) -// , .sync or .waitForTaskToken service integration patterns (https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html) -// , Parallel (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html) -// , or Map (https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html) -// states. +// permissions a state might need, see [IAM permissions to test a state]. +// +// The TestState API can run for up to five minutes. If the execution of a state +// exceeds this duration, it fails with the States.Timeout error. +// +// TestState doesn't support [Activity tasks], .sync or .waitForTaskToken[service integration patterns] , [Parallel], or [Map] states. +// +// [Amazon Web Services service integration]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-services.html +// [All Task types]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-task-state.html#task-types +// [Choice]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html +// [Activity tasks]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html +// [HTTP Task]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-third-party-apis.html +// [input and output processing]: https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-input-output-dataflow +// [Activity]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html +// [Parallel]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html +// [Succeed]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-succeed-state.html +// [service integration patterns]: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html +// [Pass]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-pass-state.html +// [IAM permissions to test a state]: https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions +// [Wait]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-wait-state.html +// [Map]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html +// [Fail]: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-fail-state.html func (c *Client) TestState(ctx context.Context, params *TestStateInput, optFns ...func(*Options)) (*TestStateOutput, error) { if params == nil { params = &TestStateInput{} @@ -58,8 +78,9 @@ func (c *Client) TestState(ctx context.Context, params *TestStateInput, optFns . type TestStateInput struct { - // The Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) - // (ASL) definition of the state. + // The [Amazon States Language] (ASL) definition of the state. + // + // [Amazon States Language]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html // // This member is required. Definition *string @@ -75,13 +96,17 @@ type TestStateInput struct { // Determines the values to return when a state is tested. You can specify one of // the following types: + // // - INFO : Shows the final state output. By default, Step Functions sets // inspectionLevel to INFO if you don't specify a level. + // // - DEBUG : Shows the final state output along with the input and output data // processing result. + // // - TRACE : Shows the HTTP request and response for an HTTP Task. This level // also shows the final state output along with the input and output data // processing result. + // // Each of these levels also provide information about the status of the state // execution and the next state to transition to. InspectionLevel types.InspectionLevel @@ -90,12 +115,16 @@ type TestStateInput struct { // HTTP Tasks, a secret includes the data that an EventBridge connection adds to // modify the HTTP request headers, query parameters, and body. Step Functions // doesn't omit any information included in the state definition or the HTTP - // response. If you set revealSecrets to true , you must make sure that the IAM - // user that calls the TestState API has permission for the states:RevealSecrets - // action. For an example of IAM policy that sets the states:RevealSecrets - // permission, see IAM permissions to test a state (https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions) - // . Without this permission, Step Functions throws an access denied error. By - // default, revealSecrets is set to false . + // response. + // + // If you set revealSecrets to true , you must make sure that the IAM user that + // calls the TestState API has permission for the states:RevealSecrets action. For + // an example of IAM policy that sets the states:RevealSecrets permission, see [IAM permissions to test a state]. + // Without this permission, Step Functions throws an access denied error. + // + // By default, revealSecrets is set to false . + // + // [IAM permissions to test a state]: https://docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions RevealSecrets bool noSmithyDocumentSerde diff --git a/service/sfn/api_op_UpdateStateMachine.go b/service/sfn/api_op_UpdateStateMachine.go index 7dd664714a5..f873eb5deef 100644 --- a/service/sfn/api_op_UpdateStateMachine.go +++ b/service/sfn/api_op_UpdateStateMachine.go @@ -15,35 +15,53 @@ import ( // 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. A qualified state machine -// ARN refers to a Distributed Map state defined within a state machine. For -// example, the qualified state machine ARN +// or you will receive a MissingRequiredParameter error. +// +// 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 . A qualified state machine ARN can either refer -// to a Distributed Map state defined within a state machine, a version ARN, or an -// alias ARN. The following are some examples of qualified and unqualified state -// machine ARNs: +// machine named stateMachineName . +// +// A qualified state machine ARN can either refer to a Distributed Map state +// defined within a state machine, a version ARN, or an alias ARN. +// +// The following are some examples of qualified and unqualified state machine ARNs: +// // - The following qualified state machine ARN refers to a Distributed Map state // with a label mapStateLabel in a state machine named myStateMachine . -// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel -// If you provide a qualified state machine ARN that refers to a Distributed Map -// state, the request fails with ValidationException . -// - The following qualified state machine ARN refers to an alias named PROD . -// arn::states:::stateMachine: If you provide a qualified state machine ARN that -// refers to a version ARN or an alias ARN, the request starts execution for that -// version or alias. -// - The following unqualified state machine ARN refers to a state machine named -// myStateMachine . arn::states:::stateMachine: +// +// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel +// +// If you provide a qualified state machine ARN that refers to a Distributed Map +// +// state, the request fails with ValidationException . +// +// - The following qualified state machine ARN refers to an alias named PROD . +// +// arn::states:::stateMachine: +// +// If you provide a qualified state machine ARN that refers to a version ARN or an +// +// alias ARN, the request starts execution for that version or alias. +// +// - The following unqualified state machine ARN refers to a state machine named +// myStateMachine . +// +// arn::states:::stateMachine: // // After you update your state machine, you can set the publish parameter to true -// in the same action to publish a new version (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html) -// . This way, you can opt-in to strict versioning of your state machine. Step -// Functions assigns monotonically increasing integers for state machine versions, -// starting at version number 1. All StartExecution calls within a few seconds use -// the updated definition and roleArn . Executions started immediately after you -// call UpdateStateMachine may use the previous state machine definition and -// roleArn . +// in the same action to publish a new [version]. This way, you can opt-in to strict +// versioning of your state machine. +// +// Step Functions assigns monotonically increasing integers for state machine +// versions, starting at version number 1. +// +// All StartExecution calls within a few seconds use the updated definition and +// roleArn . Executions started immediately after you call UpdateStateMachine may +// use the previous state machine definition and roleArn . +// +// [version]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html func (c *Client) UpdateStateMachine(ctx context.Context, params *UpdateStateMachineInput, optFns ...func(*Options)) (*UpdateStateMachineOutput, error) { if params == nil { params = &UpdateStateMachineInput{} @@ -66,9 +84,9 @@ type UpdateStateMachineInput struct { // This member is required. 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) - // . + // The Amazon States Language definition of the state machine. See [Amazon States Language]. + // + // [Amazon States Language]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html Definition *string // Use the LoggingConfiguration data type to set CloudWatch Logs options. @@ -84,8 +102,10 @@ type UpdateStateMachineInput struct { // Selects whether X-Ray tracing is enabled. TracingConfiguration *types.TracingConfiguration - // An optional description of the state machine version to publish. You can only - // specify the versionDescription parameter if you've set publish to true . + // An optional description of the state machine version to publish. + // + // You can only specify the versionDescription parameter if you've set publish to + // true . VersionDescription *string noSmithyDocumentSerde @@ -101,8 +121,9 @@ type UpdateStateMachineOutput struct { // The revision identifier for the updated state machine. RevisionId *string - // The Amazon Resource Name (ARN) of the published state machine version. If the - // publish parameter isn't set to true , this field returns null. + // The Amazon Resource Name (ARN) of the published state machine version. + // + // If the publish parameter isn't set to true , this field returns null. StateMachineVersionArn *string // Metadata pertaining to the operation's result. diff --git a/service/sfn/api_op_UpdateStateMachineAlias.go b/service/sfn/api_op_UpdateStateMachineAlias.go index c1230a8a508..d23246fde16 100644 --- a/service/sfn/api_op_UpdateStateMachineAlias.go +++ b/service/sfn/api_op_UpdateStateMachineAlias.go @@ -12,20 +12,32 @@ import ( "time" ) -// Updates the configuration of an existing state machine alias (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html) -// by modifying its description or routingConfiguration . You must specify at least -// one of the description or routingConfiguration parameters to update a state -// machine alias. UpdateStateMachineAlias is an idempotent API. Step Functions -// bases the idempotency check on the stateMachineAliasArn , description , and +// Updates the configuration of an existing state machine [alias] by modifying its +// description or routingConfiguration . +// +// You must specify at least one of the description or routingConfiguration +// parameters to update a state machine alias. +// +// UpdateStateMachineAlias is an idempotent API. Step Functions bases the +// idempotency check on the stateMachineAliasArn , description , and // routingConfiguration parameters. Requests with the same parameters return an -// idempotent response. This operation is eventually consistent. All StartExecution -// requests made within a few seconds use the latest alias configuration. -// Executions started immediately after calling UpdateStateMachineAlias may use -// the previous routing configuration. Related operations: -// - CreateStateMachineAlias -// - DescribeStateMachineAlias -// - ListStateMachineAliases -// - DeleteStateMachineAlias +// idempotent response. +// +// This operation is eventually consistent. All StartExecution requests made within a few +// seconds use the latest alias configuration. Executions started immediately after +// calling UpdateStateMachineAlias may use the previous routing configuration. +// +// Related operations: +// +// # CreateStateMachineAlias +// +// # DescribeStateMachineAlias +// +// # ListStateMachineAliases +// +// # DeleteStateMachineAlias +// +// [alias]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html func (c *Client) UpdateStateMachineAlias(ctx context.Context, params *UpdateStateMachineAliasInput, optFns ...func(*Options)) (*UpdateStateMachineAliasOutput, error) { if params == nil { params = &UpdateStateMachineAliasInput{} @@ -51,9 +63,10 @@ type UpdateStateMachineAliasInput struct { // A description of the state machine alias. Description *string - // The routing configuration of the state machine alias. An array of RoutingConfig - // objects that specifies up to two state machine versions that the alias starts - // executions for. + // The routing configuration of the state machine alias. + // + // An array of RoutingConfig objects that specifies up to two state machine + // versions that the alias starts executions for. RoutingConfiguration []types.RoutingConfigurationListItem noSmithyDocumentSerde diff --git a/service/sfn/api_op_ValidateStateMachineDefinition.go b/service/sfn/api_op_ValidateStateMachineDefinition.go index 7017016ed18..cc0494eef2f 100644 --- a/service/sfn/api_op_ValidateStateMachineDefinition.go +++ b/service/sfn/api_op_ValidateStateMachineDefinition.go @@ -11,20 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Validates the syntax of a state machine definition. You can validate that a -// state machine definition is correct without creating a state machine resource. -// Step Functions will implicitly perform the same syntax check when you invoke -// CreateStateMachine and UpdateStateMachine . State machine definitions are -// specified using a JSON-based, structured language. For more information on -// Amazon States Language see Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) -// (ASL). Suggested uses for ValidateStateMachineDefinition : +// Validates the syntax of a state machine definition. +// +// You can validate that a state machine definition is correct without creating a +// state machine resource. Step Functions will implicitly perform the same syntax +// check when you invoke CreateStateMachine and UpdateStateMachine . State machine +// definitions are specified using a JSON-based, structured language. For more +// information on Amazon States Language see [Amazon States Language](ASL). +// +// Suggested uses for ValidateStateMachineDefinition : +// // - Integrate automated checks into your code review or Continuous Integration // (CI) process to validate state machine definitions before starting deployments. +// // - Run the validation from a Git pre-commit hook to check your state machine // definitions before committing them to your source repository. // // Errors found in the state machine definition will be returned in the response // as a list of diagnostic elements, rather than raise an exception. +// +// [Amazon States Language]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html func (c *Client) ValidateStateMachineDefinition(ctx context.Context, params *ValidateStateMachineDefinitionInput, optFns ...func(*Options)) (*ValidateStateMachineDefinitionOutput, error) { if params == nil { params = &ValidateStateMachineDefinitionInput{} @@ -43,8 +49,9 @@ func (c *Client) ValidateStateMachineDefinition(ctx context.Context, params *Val type ValidateStateMachineDefinitionInput struct { // The Amazon States Language definition of the state machine. For more - // information, see Amazon States Language (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) - // (ASL). + // information, see [Amazon States Language](ASL). + // + // [Amazon States Language]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html // // This member is required. Definition *string diff --git a/service/sfn/doc.go b/service/sfn/doc.go index 4137caf570a..813fb6efd06 100644 --- a/service/sfn/doc.go +++ b/service/sfn/doc.go @@ -3,8 +3,11 @@ // Package sfn provides the API client, operations, and parameter types for AWS // Step Functions. // -// Step Functions Step Functions is a service that lets you coordinate the -// components of distributed applications and microservices using visual workflows. +// # Step Functions +// +// Step Functions is a service that lets you coordinate the components of +// distributed applications and microservices using visual workflows. +// // You can use Step Functions to build applications from individual components, // each of which performs a discrete function, or task, allowing you to scale and // change applications quickly. Step Functions provides a console that helps @@ -12,14 +15,18 @@ // Functions automatically triggers and tracks each step, and retries steps when // there are errors, so your application executes predictably and in the right // order every time. Step Functions logs the state of each step, so you can quickly -// diagnose and debug any issues. Step Functions manages operations and underlying -// infrastructure to ensure your application is available at any scale. You can run -// 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) -// . If you use the Step Functions API actions using Amazon Web Services SDK +// diagnose and debug any issues. +// +// Step Functions manages operations and underlying infrastructure to ensure your +// application is available at any scale. You can run 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]. +// +// If you use the Step Functions API actions using Amazon Web Services SDK // integrations, make sure the API actions are in camel case and parameter names // are in Pascal case. For example, you could use Step Functions API action // startSyncExecution and specify its parameter as StateMachineArn . +// +// [Step Functions Developer Guide]: https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html package sfn diff --git a/service/sfn/options.go b/service/sfn/options.go index dd620811879..f0819f84293 100644 --- a/service/sfn/options.go +++ b/service/sfn/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sfn/types/enums.go b/service/sfn/types/enums.go index 08f1a385dc1..800f92380da 100644 --- a/service/sfn/types/enums.go +++ b/service/sfn/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ExecutionRedriveFilter. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionRedriveFilter) Values() []ExecutionRedriveFilter { return []ExecutionRedriveFilter{ "REDRIVEN", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ExecutionRedriveStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionRedriveStatus) Values() []ExecutionRedriveStatus { return []ExecutionRedriveStatus{ "REDRIVABLE", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "RUNNING", @@ -134,8 +137,9 @@ const ( ) // Values returns all known values for HistoryEventType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HistoryEventType) Values() []HistoryEventType { return []HistoryEventType{ "ActivityFailed", @@ -212,8 +216,9 @@ const ( ) // Values returns all known values for InspectionLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InspectionLevel) Values() []InspectionLevel { return []InspectionLevel{ "INFO", @@ -233,8 +238,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "ALL", @@ -255,8 +261,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -275,8 +282,9 @@ const ( ) // Values returns all known values for StateMachineStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StateMachineStatus) Values() []StateMachineStatus { return []StateMachineStatus{ "ACTIVE", @@ -293,8 +301,9 @@ const ( ) // Values returns all known values for StateMachineType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StateMachineType) Values() []StateMachineType { return []StateMachineType{ "STANDARD", @@ -312,8 +321,9 @@ const ( ) // Values returns all known values for SyncExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SyncExecutionStatus) Values() []SyncExecutionStatus { return []SyncExecutionStatus{ "SUCCEEDED", @@ -333,8 +343,9 @@ const ( ) // Values returns all known values for TestExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TestExecutionStatus) Values() []TestExecutionStatus { return []TestExecutionStatus{ "SUCCEEDED", @@ -354,8 +365,9 @@ const ( // Values returns all known values for ValidateStateMachineDefinitionResultCode. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidateStateMachineDefinitionResultCode) Values() []ValidateStateMachineDefinitionResultCode { return []ValidateStateMachineDefinitionResultCode{ "OK", @@ -372,8 +384,9 @@ const ( // Values returns all known values for ValidateStateMachineDefinitionSeverity. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidateStateMachineDefinitionSeverity) Values() []ValidateStateMachineDefinitionSeverity { return []ValidateStateMachineDefinitionSeverity{ "ERROR", @@ -392,6 +405,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/sfn/types/errors.go b/service/sfn/types/errors.go index 914917fec34..871515f4640 100644 --- a/service/sfn/types/errors.go +++ b/service/sfn/types/errors.go @@ -88,9 +88,10 @@ func (e *ActivityWorkerLimitExceeded) ErrorCode() string { func (e *ActivityWorkerLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Updating or deleting a resource can cause an inconsistent state. This error -// occurs when there're concurrent requests for DeleteStateMachineVersion , -// PublishStateMachineVersion , or UpdateStateMachine with the publish parameter -// set to true . HTTP Status Code: 409 +// occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter +// set to true . +// +// HTTP Status Code: 409 type ConflictException struct { Message *string @@ -117,6 +118,7 @@ func (e *ConflictException) ErrorCode() string { func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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 @@ -486,7 +488,9 @@ func (e *ResourceNotFound) ErrorCode() string { } func (e *ResourceNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request would cause a service quota to be exceeded. HTTP Status Code: 402 +// The request would cause a service quota to be exceeded. +// +// HTTP Status Code: 402 type ServiceQuotaExceededException struct { Message *string @@ -696,8 +700,10 @@ 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] in the Step +// Functions Developer Guide. +// +// [Limits Topic]: https://docs.aws.amazon.com/step-functions/latest/dg/limits.html type TooManyTags struct { Message *string diff --git a/service/sfn/types/types.go b/service/sfn/types/types.go index d7e864292d1..8dd31c927a1 100644 --- a/service/sfn/types/types.go +++ b/service/sfn/types/types.go @@ -32,12 +32,20 @@ type ActivityListItem struct { // This member is required. CreationDate *time.Time - // The name of the activity. A name must not contain: + // 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 _. // @@ -88,7 +96,7 @@ type ActivityScheduleFailedEventDetails struct { type ActivityStartedEventDetails struct { // The name of the worker that the task is assigned to. These names are provided - // by the workers when calling GetActivityTask . + // by the workers when calling GetActivityTask. WorkerName *string noSmithyDocumentSerde @@ -183,12 +191,20 @@ type ExecutionListItem struct { // This member is required. ExecutionArn *string - // The name of the execution. A name must not contain: + // 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 _. // @@ -230,14 +246,20 @@ type ExecutionListItem struct { RedriveDate *time.Time // The Amazon Resource Name (ARN) of the state machine alias used to start an - // execution. If the state machine execution was started with an unqualified ARN or - // a version ARN, it returns null. + // execution. + // + // If the state machine execution was started with an unqualified ARN or a version + // ARN, it returns null. StateMachineAliasArn *string // The Amazon Resource Name (ARN) of the state machine version associated with the - // execution. If the state machine execution was started with an unqualified ARN, - // it returns null. If the execution was started using a stateMachineAliasArn , - // both the stateMachineAliasArn and stateMachineVersionArn parameters contain the + // execution. + // + // If the state machine execution was started with an unqualified ARN, it returns + // null. + // + // If the execution was started using a stateMachineAliasArn , both the + // stateMachineAliasArn and stateMachineVersionArn parameters contain the // respective values. StateMachineVersionArn *string @@ -460,21 +482,25 @@ type HistoryEventExecutionDataDetails struct { // and output data processing flow, and HTTP request and response information. type InspectionData struct { - // The input after Step Functions applies the InputPath (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-inputpath) - // filter. + // The input after Step Functions applies the [InputPath] filter. + // + // [InputPath]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-inputpath AfterInputPath *string - // The effective input after Step Functions applies the Parameters (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters) - // filter. + // The effective input after Step Functions applies the [Parameters] filter. + // + // [Parameters]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters AfterParameters *string // The effective result combined with the raw state input after Step Functions - // applies the ResultPath (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultpath.html) - // filter. + // applies the [ResultPath]filter. + // + // [ResultPath]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultpath.html AfterResultPath *string - // The effective result after Step Functions applies the ResultSelector (https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector) - // filter. + // The effective result after Step Functions applies the [ResultSelector] filter. + // + // [ResultSelector]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector AfterResultSelector *string // The raw state input. @@ -628,9 +654,10 @@ 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) - // in the CloudFormation User Guide. + // An object describing a CloudWatch log group. For more information, see [AWS::Logs::LogGroup] in the + // CloudFormation User Guide. + // + // [AWS::Logs::LogGroup]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html CloudWatchLogsLogGroup *CloudWatchLogsLogGroup noSmithyDocumentSerde @@ -689,8 +716,9 @@ 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) - // in the Step Functions Developer Guide. + // ResultWriter . For more information, see [ResultWriter] in the Step Functions Developer Guide. + // + // [ResultWriter]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html // // This member is required. ResultsWritten int64 @@ -769,8 +797,9 @@ type MapRunItemCounts struct { 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) - // in the Step Functions Developer Guide. + // information, see [ResultWriter]in the Step Functions Developer Guide. + // + // [ResultWriter]: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html // // This member is required. ResultsWritten int64 @@ -881,8 +910,10 @@ type MapStateStartedEventDetails struct { type RoutingConfigurationListItem struct { // The Amazon Resource Name (ARN) that identifies one or two state machine - // versions defined in the routing configuration. If you specify the ARN of a - // second version, it must belong to the same state machine as the first version. + // versions defined in the routing configuration. + // + // If you specify the ARN of a second version, it must belong to the same state + // machine as the first version. // // This member is required. StateMachineVersionArn *string @@ -917,12 +948,20 @@ type StateEnteredEventDetails struct { // Contains details about an exit from a state during an execution. type StateExitedEventDetails struct { - // The name of the state. A name must not contain: + // 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 _. // @@ -965,12 +1004,20 @@ type StateMachineListItem struct { // This member is required. CreationDate *time.Time - // The name of the state machine. A name must not contain: + // 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 _. // @@ -1009,12 +1056,16 @@ type StateMachineVersionListItem 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) -// 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: -// _ . : / = + - @ . +// machines and activities. +// +// An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the Amazon Web +// Services Billing and Cost Management User Guide, and [Controlling Access Using IAM Tags]. +// +// 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 +// [Using Cost Allocation Tags]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html type Tag struct { // The key of a tag. @@ -1255,9 +1306,10 @@ type ValidateStateMachineDefinitionDiagnostic struct { // This member is required. Severity ValidateStateMachineDefinitionSeverity - // Location of the issue in the state machine, if available. For errors specific - // to a field, the location could be in the format: /States// , for example: - // /States/FailState/ErrorPath . + // Location of the issue in the state machine, if available. + // + // For errors specific to a field, the location could be in the format: /States// , + // for example: /States/FailState/ErrorPath . Location *string noSmithyDocumentSerde diff --git a/service/shield/api_op_AssociateDRTLogBucket.go b/service/shield/api_op_AssociateDRTLogBucket.go index a03e150b222..5210eaf3498 100644 --- a/service/shield/api_op_AssociateDRTLogBucket.go +++ b/service/shield/api_op_AssociateDRTLogBucket.go @@ -13,11 +13,13 @@ import ( // Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 // bucket containing log data such as Application Load Balancer access logs, // CloudFront logs, or logs from third party sources. You can associate up to 10 -// 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/) -// . +// 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]or the [Enterprise Support plan]. +// +// [Enterprise Support plan]: http://aws.amazon.com/premiumsupport/enterprise-support/ +// [Business Support plan]: http://aws.amazon.com/premiumsupport/business-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 e66e4a185d0..41d5d4015fa 100644 --- a/service/shield/api_op_AssociateDRTRole.go +++ b/service/shield/api_op_AssociateDRTRole.go @@ -13,26 +13,35 @@ 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]. For more +// information see [Adding and removing IAM identity permissions]. The role must also trust the service principal +// drt.shield.amazonaws.com . For more information, see [IAM JSON policy elements: Principal]. +// +// 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/) -// . +// 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]. +// +// To use the services of the SRT and make an AssociateDRTRole request, you must +// be subscribed to the [Business Support plan]or the [Enterprise Support plan]. +// +// [Adding and removing IAM identity permissions]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html +// [Enterprise Support plan]: http://aws.amazon.com/premiumsupport/enterprise-support/ +// [AWSShieldDRTAccessPolicy]: https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy +// [IAM JSON policy elements: Principal]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html +// [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 +// [Business Support plan]: http://aws.amazon.com/premiumsupport/business-support/ func (c *Client) AssociateDRTRole(ctx context.Context, params *AssociateDRTRoleInput, optFns ...func(*Options)) (*AssociateDRTRoleOutput, error) { if params == nil { params = &AssociateDRTRoleInput{} @@ -51,11 +60,13 @@ func (c *Client) AssociateDRTRole(ctx context.Context, params *AssociateDRTRoleI 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) - // 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) - // . + // Amazon Web Services account. + // + // Prior to making the AssociateDRTRole request, you must attach the [AWSShieldDRTAccessPolicy] managed + // policy to this role. For more information see [Attaching and Detaching IAM Policies]. + // + // [AWSShieldDRTAccessPolicy]: https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy + // [Attaching and Detaching 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 f478bd04fa1..2c3a208272b 100644 --- a/service/shield/api_op_AssociateHealthCheck.go +++ b/service/shield/api_op_AssociateHealthCheck.go @@ -13,10 +13,12 @@ import ( // Adds health-based detection to the Shield Advanced protection for a resource. // Shield Advanced health-based detection uses the health of your Amazon Web // 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) -// in the WAF Developer Guide. +// 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]in the WAF Developer Guide. +// +// [Shield Advanced Health-Based Detection]: https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option func (c *Client) AssociateHealthCheck(ctx context.Context, params *AssociateHealthCheckInput, optFns ...func(*Options)) (*AssociateHealthCheckOutput, error) { if params == nil { params = &AssociateHealthCheckInput{} @@ -40,8 +42,8 @@ type AssociateHealthCheckInput struct { // This member is required. HealthCheckArn *string - // The unique identifier (ID) for the Protection object to add the health check - // association to. + // The unique identifier (ID) for the Protection object to add the health check association + // to. // // This member is required. ProtectionId *string diff --git a/service/shield/api_op_AssociateProactiveEngagementDetails.go b/service/shield/api_op_AssociateProactiveEngagementDetails.go index acb4bb69be0..780093e088f 100644 --- a/service/shield/api_op_AssociateProactiveEngagementDetails.go +++ b/service/shield/api_op_AssociateProactiveEngagementDetails.go @@ -13,14 +13,20 @@ import ( // Initializes proactive engagement and sets the list of contacts for the Shield // 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 -// 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 -// defined. If you already have contacts defined and want to use them, retrieve the -// list using DescribeEmergencyContactSettings and then provide it to this call. +// 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 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 defined. If you already have contacts defined and want to use them, +// retrieve the list using DescribeEmergencyContactSettings and then provide it to +// this call. func (c *Client) AssociateProactiveEngagementDetails(ctx context.Context, params *AssociateProactiveEngagementDetailsInput, optFns ...func(*Options)) (*AssociateProactiveEngagementDetailsOutput, error) { if params == nil { params = &AssociateProactiveEngagementDetailsInput{} @@ -40,11 +46,14 @@ type AssociateProactiveEngagementDetailsInput struct { // A list of email addresses and phone numbers that the Shield Response Team (SRT) // can use to contact you for escalations to the SRT and to initiate proactive - // customer support. To enable proactive engagement, the contact list must include - // at least one phone number. The contacts that you provide here replace any - // contacts that were already defined. If you already have contacts defined and - // want to use them, retrieve the list using DescribeEmergencyContactSettings and - // then provide it here. + // customer support. + // + // To enable proactive engagement, the contact list must include at least one + // phone number. + // + // The contacts that you provide here replace any contacts that were already + // defined. If you already have contacts defined and want to use them, retrieve the + // list using DescribeEmergencyContactSettings and then provide it here. // // This member is required. EmergencyContactList []types.EmergencyContact diff --git a/service/shield/api_op_CreateProtection.go b/service/shield/api_op_CreateProtection.go index 90e9b48858a..51dece820a3 100644 --- a/service/shield/api_op_CreateProtection.go +++ b/service/shield/api_op_CreateProtection.go @@ -16,13 +16,15 @@ import ( // Global Accelerator standard accelerator, Elastic IP Address, Application Load // Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and // Network Load Balancers by association with protected Amazon EC2 Elastic IP -// 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) -// . +// 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#/]. For more information see [Getting Started with Shield Advanced] and [Adding Shield Advanced protection to Amazon Web Services resources]. +// +// [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#/ +// [Getting Started with Shield Advanced]: https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html func (c *Client) CreateProtection(ctx context.Context, params *CreateProtectionInput, optFns ...func(*Options)) (*CreateProtectionOutput, error) { if params == nil { params = &CreateProtectionInput{} @@ -45,18 +47,24 @@ type CreateProtectionInput struct { // This member is required. Name *string - // The ARN (Amazon Resource Name) of the resource to be protected. The ARN should - // be in one of the following formats: + // 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 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 // diff --git a/service/shield/api_op_CreateProtectionGroup.go b/service/shield/api_op_CreateProtectionGroup.go index b51e086fa2a..9b321e19f04 100644 --- a/service/shield/api_op_CreateProtectionGroup.go +++ b/service/shield/api_op_CreateProtectionGroup.go @@ -33,12 +33,15 @@ 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 diff --git a/service/shield/api_op_CreateSubscription.go b/service/shield/api_op_CreateSubscription.go index 34f1d241fd8..55edce3106a 100644 --- a/service/shield/api_op_CreateSubscription.go +++ b/service/shield/api_op_CreateSubscription.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Activates Shield Advanced for an account. For accounts that are members of an -// Organizations organization, Shield Advanced subscriptions are billed against the -// organization's payer account, regardless of whether the payer account itself is -// subscribed. When you initially create a subscription, your subscription is set -// to be automatically renewed at the end of the existing subscription period. You -// can change this by submitting an UpdateSubscription request. +// Activates Shield Advanced for an account. +// +// For accounts that are members of an Organizations organization, Shield Advanced +// subscriptions are billed against the organization's payer account, regardless of +// whether the payer account itself is subscribed. +// +// When you initially create a subscription, your subscription is set to be +// automatically renewed at the end of the existing subscription period. You can +// change this by submitting an UpdateSubscription request. func (c *Client) CreateSubscription(ctx context.Context, params *CreateSubscriptionInput, optFns ...func(*Options)) (*CreateSubscriptionOutput, error) { if params == nil { params = &CreateSubscriptionInput{} diff --git a/service/shield/api_op_DeleteProtection.go b/service/shield/api_op_DeleteProtection.go index 8526eac30cd..b018f48fa0f 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 3665c75c8eb..c3073e31420 100644 --- a/service/shield/api_op_DescribeAttackStatistics.go +++ b/service/shield/api_op_DescribeAttackStatistics.go @@ -14,12 +14,14 @@ import ( // 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 -// indicates the period covered by the attack statistics data items. +// 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 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 { params = &DescribeAttackStatisticsInput{} diff --git a/service/shield/api_op_DescribeProtection.go b/service/shield/api_op_DescribeProtection.go index 697f4b45731..457d0adc2c5 100644 --- a/service/shield/api_op_DescribeProtection.go +++ b/service/shield/api_op_DescribeProtection.go @@ -29,9 +29,9 @@ func (c *Client) DescribeProtection(ctx context.Context, params *DescribeProtect type DescribeProtectionInput struct { - // The unique identifier (ID) for the Protection object to describe. You must - // provide either the ResourceArn of the protected resource or the ProtectionID of - // the protection, but not both. + // The unique identifier (ID) for the Protection object to describe. You must provide either + // the ResourceArn of the protected resource or the ProtectionID of the + // protection, but not both. ProtectionId *string // The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. diff --git a/service/shield/api_op_DisassociateHealthCheck.go b/service/shield/api_op_DisassociateHealthCheck.go index d1b48d65b84..8d4ecedb235 100644 --- a/service/shield/api_op_DisassociateHealthCheck.go +++ b/service/shield/api_op_DisassociateHealthCheck.go @@ -13,10 +13,13 @@ import ( // Removes health-based detection from the Shield Advanced protection for a // resource. Shield Advanced health-based detection uses the health of your Amazon // 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) -// in the WAF Developer Guide. +// 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]in the WAF +// Developer Guide. +// +// [Shield Advanced Health-Based Detection]: https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option func (c *Client) DisassociateHealthCheck(ctx context.Context, params *DisassociateHealthCheckInput, optFns ...func(*Options)) (*DisassociateHealthCheckOutput, error) { if params == nil { params = &DisassociateHealthCheckInput{} diff --git a/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go b/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go index a8fac55e3e6..a62d2785682 100644 --- a/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go +++ b/service/shield/api_op_EnableApplicationLayerAutomaticResponse.go @@ -12,24 +12,31 @@ import ( ) // Enable the Shield Advanced automatic application layer DDoS mitigation for the -// protected resource. This feature is available for Amazon CloudFront -// distributions and Application Load Balancers only. This causes Shield Advanced -// to create, verify, and apply WAF rules for DDoS attacks that it detects for the -// 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 -// 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/) -// . +// protected resource. +// +// This feature is available for Amazon CloudFront distributions and Application +// Load Balancers only. +// +// This causes Shield Advanced to create, verify, and apply WAF rules for DDoS +// attacks that it detects for the 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]. +// +// 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#/]. For more +// information, see [Getting Started with Shield Advanced]. 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://console.aws.amazon.com/wafv2/shieldv2#/]: https://console.aws.amazon.com/wafv2/shieldv2#/ +// [Getting Started with Shield Advanced]: https://docs.aws.amazon.com/waf/latest/developerguide/getting-started-ddos.html +// [WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/ +// [Shield Advanced automatic application layer DDoS mitigation]: https://docs.aws.amazon.com/waf/latest/developerguide/ddos-advanced-automatic-app-layer-response.html 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_ListAttacks.go b/service/shield/api_op_ListAttacks.go index 8409a3776e0..e6c2be9d18f 100644 --- a/service/shield/api_op_ListAttacks.go +++ b/service/shield/api_op_ListAttacks.go @@ -32,28 +32,35 @@ 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) - // setting. + // provide the time in any valid [timestamp format]setting. + // + // [timestamp format]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp EndTime *types.TimeRange // The greatest number of objects that you want Shield Advanced to return to the // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. MaxResults *int32 // When you request a list of objects from Shield Advanced, if the response does // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. On your first call to a list operation, leave this setting - // empty. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string // The ARNs (Amazon Resource Names) of the resources that were attacked. If you @@ -62,8 +69,9 @@ 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) - // setting. + // provide the time in any valid [timestamp format]setting. + // + // [timestamp format]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp StartTime *types.TimeRange noSmithyDocumentSerde @@ -78,12 +86,15 @@ type ListAttacksOutput struct { // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. NextToken *string // Metadata pertaining to the operation's result. @@ -181,7 +192,9 @@ type ListAttacksPaginatorOptions struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/shield/api_op_ListProtectionGroups.go b/service/shield/api_op_ListProtectionGroups.go index 14dae26b2e1..3eb4fc342ac 100644 --- a/service/shield/api_op_ListProtectionGroups.go +++ b/service/shield/api_op_ListProtectionGroups.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves ProtectionGroup objects for the account. You can retrieve all -// protection groups or you can provide filtering criteria and retrieve just the -// subset of protection groups that match the criteria. +// Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or +// you can provide filtering criteria and retrieve just the subset of protection +// groups that match the criteria. func (c *Client) ListProtectionGroups(ctx context.Context, params *ListProtectionGroupsInput, optFns ...func(*Options)) (*ListProtectionGroupsOutput, error) { if params == nil { params = &ListProtectionGroupsInput{} @@ -43,20 +43,26 @@ type ListProtectionGroupsInput struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. MaxResults *int32 // When you request a list of objects from Shield Advanced, if the response does // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. On your first call to a list operation, leave this setting - // empty. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string noSmithyDocumentSerde @@ -73,12 +79,15 @@ type ListProtectionGroupsOutput struct { // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. NextToken *string // Metadata pertaining to the operation's result. @@ -178,7 +187,9 @@ type ListProtectionGroupsPaginatorOptions struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/shield/api_op_ListProtections.go b/service/shield/api_op_ListProtections.go index 7b52a36e833..3c4ef1ef0fc 100644 --- a/service/shield/api_op_ListProtections.go +++ b/service/shield/api_op_ListProtections.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves Protection objects for the account. You can retrieve all protections -// or you can provide filtering criteria and retrieve just the subset of -// protections that match the criteria. +// Retrieves Protection objects for the account. You can retrieve all protections or you can +// provide filtering criteria and retrieve just the subset of protections that +// match the criteria. func (c *Client) ListProtections(ctx context.Context, params *ListProtectionsInput, optFns ...func(*Options)) (*ListProtectionsOutput, error) { if params == nil { params = &ListProtectionsInput{} @@ -43,20 +43,26 @@ type ListProtectionsInput struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. MaxResults *int32 // When you request a list of objects from Shield Advanced, if the response does // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. On your first call to a list operation, leave this setting - // empty. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string noSmithyDocumentSerde @@ -68,12 +74,15 @@ type ListProtectionsOutput struct { // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. NextToken *string // The array of enabled Protection objects. @@ -175,7 +184,9 @@ type ListProtectionsPaginatorOptions struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/shield/api_op_ListResourcesInProtectionGroup.go b/service/shield/api_op_ListResourcesInProtectionGroup.go index 77671ae38ca..e89db99ff89 100644 --- a/service/shield/api_op_ListResourcesInProtectionGroup.go +++ b/service/shield/api_op_ListResourcesInProtectionGroup.go @@ -39,20 +39,26 @@ type ListResourcesInProtectionGroupInput struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. MaxResults *int32 // When you request a list of objects from Shield Advanced, if the response does // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. On your first call to a list operation, leave this setting - // empty. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. + // + // On your first call to a list operation, leave this setting empty. NextToken *string noSmithyDocumentSerde @@ -70,12 +76,15 @@ type ListResourcesInProtectionGroupOutput struct { // not include all of the remaining available objects, Shield Advanced includes a // NextToken value in the response. You can retrieve the next batch of objects by // requesting the list again and providing the token that was returned by the prior - // call in your request. You can indicate the maximum number of objects that you - // want Shield Advanced to return for a single call with the MaxResults setting. - // Shield Advanced will not return more than MaxResults objects, but may return - // fewer, even if more objects are still available. Whenever more objects remain - // that Shield Advanced has not yet returned to you, the response will include a - // NextToken value. + // call in your request. + // + // You can indicate the maximum number of objects that you want Shield Advanced to + // return for a single call with the MaxResults setting. Shield Advanced will not + // return more than MaxResults objects, but may return fewer, even if more objects + // are still available. + // + // Whenever more objects remain that Shield Advanced has not yet returned to you, + // the response will include a NextToken value. NextToken *string // Metadata pertaining to the operation's result. @@ -178,7 +187,9 @@ type ListResourcesInProtectionGroupPaginatorOptions struct { // list request. Shield Advanced might return fewer objects than you indicate in // this setting, even if more objects are available. If there are more objects // remaining, Shield Advanced will always also return a NextToken value in the - // response. The default setting is 20. + // response. + // + // The default setting is 20. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/shield/api_op_UpdateEmergencyContactSettings.go b/service/shield/api_op_UpdateEmergencyContactSettings.go index 0d1ae83d21f..3f0bc86c952 100644 --- a/service/shield/api_op_UpdateEmergencyContactSettings.go +++ b/service/shield/api_op_UpdateEmergencyContactSettings.go @@ -34,8 +34,10 @@ type UpdateEmergencyContactSettingsInput struct { // A list of email addresses and phone numbers that the Shield Response Team (SRT) // can use to contact you if you have proactive engagement enabled, for escalations - // to the SRT and to initiate proactive customer support. If you have proactive - // engagement enabled, the contact list must include at least one phone number. + // to the SRT and to initiate proactive customer support. + // + // If you have proactive engagement enabled, the contact list must include at + // least one phone number. EmergencyContactList []types.EmergencyContact noSmithyDocumentSerde diff --git a/service/shield/api_op_UpdateProtectionGroup.go b/service/shield/api_op_UpdateProtectionGroup.go index 60cddb7fa61..2f66bd106d9 100644 --- a/service/shield/api_op_UpdateProtectionGroup.go +++ b/service/shield/api_op_UpdateProtectionGroup.go @@ -33,12 +33,15 @@ 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 diff --git a/service/shield/api_op_UpdateSubscription.go b/service/shield/api_op_UpdateSubscription.go index ea7eaba8bad..407a4a766c8 100644 --- a/service/shield/api_op_UpdateSubscription.go +++ b/service/shield/api_op_UpdateSubscription.go @@ -12,10 +12,11 @@ import ( ) // Updates the details of an existing subscription. Only enter values for -// parameters you want to change. Empty parameters are not updated. For accounts -// that are members of an Organizations organization, Shield Advanced subscriptions -// are billed against the organization's payer account, regardless of whether the -// payer account itself is subscribed. +// parameters you want to change. Empty parameters are not updated. +// +// For accounts that are members of an Organizations organization, Shield Advanced +// subscriptions are billed against the organization's payer account, regardless of +// whether the payer account itself is subscribed. func (c *Client) UpdateSubscription(ctx context.Context, params *UpdateSubscriptionInput, optFns ...func(*Options)) (*UpdateSubscriptionOutput, error) { if params == nil { params = &UpdateSubscriptionInput{} diff --git a/service/shield/doc.go b/service/shield/doc.go index 9e110fcdaa4..a430afa67a8 100644 --- a/service/shield/doc.go +++ b/service/shield/doc.go @@ -3,10 +3,12 @@ // Package shield provides the API client, operations, and parameter types for AWS // Shield. // -// Shield Advanced This is the Shield Advanced API Reference. This guide is for -// 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/) -// . +// # Shield Advanced +// +// This is the Shield Advanced API Reference. This guide is for 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]. +// +// [WAF and Shield Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/ package shield diff --git a/service/shield/options.go b/service/shield/options.go index 7bcfe299f36..b54e13f3b5f 100644 --- a/service/shield/options.go +++ b/service/shield/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/shield/types/enums.go b/service/shield/types/enums.go index d0bd71e9a55..b1024e14130 100644 --- a/service/shield/types/enums.go +++ b/service/shield/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for ApplicationLayerAutomaticResponseStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationLayerAutomaticResponseStatus) Values() []ApplicationLayerAutomaticResponseStatus { return []ApplicationLayerAutomaticResponseStatus{ "ENABLED", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AttackLayer. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttackLayer) Values() []AttackLayer { return []AttackLayer{ "NETWORK", @@ -55,6 +57,7 @@ const ( // 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{ @@ -78,8 +81,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -98,6 +102,7 @@ const ( // Values returns all known values for ProactiveEngagementStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ProactiveEngagementStatus) Values() []ProactiveEngagementStatus { return []ProactiveEngagementStatus{ @@ -120,8 +125,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "CLOUDFRONT_DISTRIBUTION", @@ -144,6 +150,7 @@ const ( // Values returns all known values for ProtectionGroupAggregation. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ProtectionGroupAggregation) Values() []ProtectionGroupAggregation { return []ProtectionGroupAggregation{ @@ -163,8 +170,9 @@ const ( ) // Values returns all known values for ProtectionGroupPattern. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProtectionGroupPattern) Values() []ProtectionGroupPattern { return []ProtectionGroupPattern{ "ALL", @@ -182,8 +190,9 @@ const ( ) // Values returns all known values for SubResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubResourceType) Values() []SubResourceType { return []SubResourceType{ "IP", @@ -200,8 +209,9 @@ const ( ) // Values returns all known values for SubscriptionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionState) Values() []SubscriptionState { return []SubscriptionState{ "ACTIVE", @@ -220,8 +230,9 @@ const ( ) // Values returns all known values for Unit. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Unit) Values() []Unit { return []Unit{ "BITS", @@ -241,6 +252,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/shield/types/errors.go b/service/shield/types/errors.go index 99a2eb18a47..fc1c17389e1 100644 --- a/service/shield/types/errors.go +++ b/service/shield/types/errors.go @@ -37,9 +37,9 @@ func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.F // In order to grant the necessary access to the Shield Response Team (SRT) the // 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) -// . +// information, see [Granting a User Permissions to Pass a Role to an Amazon Web Services Service]. +// +// [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 type AccessDeniedForDependencyException struct { Message *string diff --git a/service/shield/types/types.go b/service/shield/types/types.go index 5b7782e78c4..99a4b72920c 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. @@ -41,11 +41,13 @@ type AttackDetail struct { // The unique identifier (ID) of the attack. AttackId *string - // 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) - // in the WAF Developer Guide. + // 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]in the + // WAF Developer Guide. + // + // [Shield metrics and alarms]: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms AttackProperties []AttackProperty // The time the attack ended, in Unix time in seconds. @@ -67,14 +69,17 @@ type AttackDetail struct { 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) - // in the WAF Developer Guide. + // 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]in the + // WAF Developer Guide. + // + // [Shield metrics and alarms]: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms AttackLayer AttackLayer // Defines the Shield event property information that is provided. The @@ -96,9 +101,8 @@ type AttackProperty struct { noSmithyDocumentSerde } -// A single attack statistics data record. This is returned by -// DescribeAttackStatistics along with a time range indicating the time period that -// the attack statistics apply to. +// A single attack statistics data record. This is returned by DescribeAttackStatistics along with a time +// range indicating the time period that the attack statistics apply to. type AttackStatisticsDataItem struct { // The number of attacks detected during the time period. This is always present, @@ -139,23 +143,41 @@ 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 // // This member is required. @@ -164,9 +186,9 @@ type AttackVectorDescription struct { noSmithyDocumentSerde } -// Information about the volume of attacks during the time period, included in an -// AttackStatisticsDataItem . If the accompanying AttackCount in the statistics -// object is zero, this setting might be empty. +// Information about the volume of attacks during the time period, included in an AttackStatisticsDataItem +// . If the accompanying AttackCount in the statistics object is zero, this +// setting might be empty. type AttackVolume struct { // A statistics object that uses bits per second as the unit. This is included for @@ -185,7 +207,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. @@ -197,8 +219,11 @@ type AttackVolumeStatistics struct { } // Specifies that Shield Advanced should configure its WAF rules with the WAF Block -// action. This is only used in the context of the ResponseAction setting. JSON -// specification: "Block": {} +// action. +// +// This is only used in the context of the ResponseAction setting. +// +// JSON specification: "Block": {} type BlockAction struct { noSmithyDocumentSerde } @@ -212,16 +237,18 @@ type Contributor struct { // SOURCE_COUNTRY , the Name could be United States . Name *string - // The contribution of this contributor expressed in Protection units. For example - // 10,000 . + // The contribution of this contributor expressed in Protection units. For example 10,000 . Value int64 noSmithyDocumentSerde } // Specifies that Shield Advanced should configure its WAF rules with the WAF Count -// action. This is only used in the context of the ResponseAction setting. JSON -// specification: "Count": {} +// action. +// +// This is only used in the context of the ResponseAction setting. +// +// JSON specification: "Count": {} type CountAction struct { noSmithyDocumentSerde } @@ -348,12 +375,15 @@ 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 @@ -455,11 +485,15 @@ 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 @@ -492,10 +526,12 @@ type Subscription struct { SubscriptionLimits *SubscriptionLimits // 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 - // request. If the UpdateSubscription request does not included a value for - // AutoRenew , the existing value for AutoRenew remains unchanged. + // existing subscription period. + // + // When you initally create a subscription, AutoRenew 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 AutoRenew // The date and time your subscription will end. @@ -506,10 +542,13 @@ type Subscription struct { // 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 - // 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 - // initiate proactive customer support. + // 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 initiate proactive customer support. ProactiveEngagementStatus ProactiveEngagementStatus // The start time of the subscription, in Unix time in seconds. diff --git a/service/signer/api_op_AddProfilePermission.go b/service/signer/api_op_AddProfilePermission.go index 2290398815d..9452ea7cd1f 100644 --- a/service/signer/api_op_AddProfilePermission.go +++ b/service/signer/api_op_AddProfilePermission.go @@ -30,16 +30,22 @@ type AddProfilePermissionInput struct { // For cross-account signing. Grant a designated account permission to perform one // or more of the following actions. Each action is associated with a specific - // API's operations. For more information about cross-account signing, see Using - // cross-account signing with signing profiles (https://docs.aws.amazon.com/signer/latest/developerguide/signing-profile-cross-account.html) - // in the AWS Signer Developer Guide. You can designate the following actions to an - // account. + // API's operations. For more information about cross-account signing, see [Using cross-account signing with signing profiles]in the + // AWS Signer Developer Guide. + // + // You can designate the following actions to an account. + // // - signer:StartSigningJob . This action isn't supported for container image - // workflows. For details, see StartSigningJob . + // workflows. For details, see StartSigningJob. + // // - signer:SignPayload . This action isn't supported for AWS Lambda workflows. // For details, see SignPayload - // - signer:GetSigningProfile . For details, see GetSigningProfile . - // - signer:RevokeSignature . For details, see RevokeSignature . + // + // - signer:GetSigningProfile . For details, see GetSigningProfile. + // + // - signer:RevokeSignature . For details, see RevokeSignature. + // + // [Using cross-account signing with signing profiles]: https://docs.aws.amazon.com/signer/latest/developerguide/signing-profile-cross-account.html // // This member is required. Action *string diff --git a/service/signer/api_op_DescribeSigningJob.go b/service/signer/api_op_DescribeSigningJob.go index ded0e3623db..3f773b0c837 100644 --- a/service/signer/api_op_DescribeSigningJob.go +++ b/service/signer/api_op_DescribeSigningJob.go @@ -233,12 +233,13 @@ type SuccessfulSigningJobWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeSigningJobInput, *DescribeSigningJobOutput, error) (bool, error) } diff --git a/service/signer/api_op_GetRevocationStatus.go b/service/signer/api_op_GetRevocationStatus.go index b6dc384c238..f18bb068cdc 100644 --- a/service/signer/api_op_GetRevocationStatus.go +++ b/service/signer/api_op_GetRevocationStatus.go @@ -30,12 +30,17 @@ func (c *Client) GetRevocationStatus(ctx context.Context, params *GetRevocationS type GetRevocationStatusInput struct { - // A list of composite signed hashes that identify certificates. A certificate - // identifier consists of a subject certificate TBS hash (signed by the parent CA) - // combined with a parent CA TBS hash (signed by the parent CA’s CA). Root - // certificates are defined as their own CA. The following example shows how to - // calculate a hash for this parameter using OpenSSL commands: openssl asn1parse - // -in childCert.pem -strparse 4 -out childCert.tbs + // A list of composite signed hashes that identify certificates. + // + // A certificate identifier consists of a subject certificate TBS hash (signed by + // the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s + // CA). Root certificates are defined as their own CA. + // + // The following example shows how to calculate a hash for this parameter using + // OpenSSL commands: + // + // openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs + // // openssl sha384 < childCert.tbs -binary > childCertTbsHash // // openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs diff --git a/service/signer/api_op_StartSigningJob.go b/service/signer/api_op_StartSigningJob.go index 3c24b5c43df..d2742933a1c 100644 --- a/service/signer/api_op_StartSigningJob.go +++ b/service/signer/api_op_StartSigningJob.go @@ -14,23 +14,30 @@ 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 -// Creating a Bucket (http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) -// in the Amazon S3 Getting Started Guide. +// +// - You must create an Amazon S3 source bucket. For more information, see [Creating a Bucket]in +// the Amazon S3 Getting Started Guide. +// // - Your S3 source bucket must be version enabled. +// // - You must create an S3 destination bucket. AWS Signer 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 ensure the S3 buckets are from the same Region as the signing // profile. Cross-Region signing isn't supported. +// // - You must also specify a request token that identifies your request to // Signer. // -// 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 -// StartSigningJob (https://docs.aws.amazon.com/signer/latest/developerguide/api-startsigningjob.html) -// . +// 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 [StartSigningJob]. +// +// [Creating a Bucket]: http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html +// [StartSigningJob]: https://docs.aws.amazon.com/signer/latest/developerguide/api-startsigningjob.html 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 03f7cc7f48e..463c15440f2 100644 --- a/service/signer/doc.go +++ b/service/signer/doc.go @@ -4,23 +4,34 @@ // Signer. // // AWS Signer is a fully managed code-signing service to help you ensure the trust -// and integrity of your code. Signer supports the following applications: With -// code signing for AWS Lambda, you can sign AWS Lambda (http://docs.aws.amazon.com/lambda/latest/dg/) -// deployment packages. Integrated support is provided for Amazon S3 (http://docs.aws.amazon.com/AmazonS3/latest/gsg/) -// , Amazon CloudWatch (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/) -// , and AWS CloudTrail (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/) -// . In order to sign code, you create a signing profile and then use 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. With Signer and the Notation CLI from the Notary
 Project (https://notaryproject.dev/) -// , you can sign container images stored in a container registry such as Amazon -// Elastic Container Registry (ECR). The signatures are stored in the registry -// alongside the images, where they are available for verifying image authenticity -// and integrity. For more information about Signer, see the AWS Signer Developer -// Guide (https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html) . +// and integrity of your code. +// +// Signer supports the following applications: +// +// With code signing for AWS Lambda, you can sign [AWS Lambda] deployment packages. Integrated +// support is provided for [Amazon S3], [Amazon CloudWatch], and [AWS CloudTrail]. In order to sign code, you create a signing +// profile and then use 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]and [AWS IoT Device Management], and is integrated +// with [AWS Certificate Manager (ACM)]. 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. +// +// With Signer and the Notation CLI from the [Notary
 Project], you can sign container images +// stored in a container registry such as Amazon Elastic Container Registry (ECR). +// The signatures are stored in the registry alongside the images, where they are +// available for verifying image authenticity and integrity. +// +// For more information about Signer, see the [AWS Signer Developer Guide]. +// +// [AWS Lambda]: http://docs.aws.amazon.com/lambda/latest/dg/ +// [AWS IoT Device Management]: http://docs.aws.amazon.com/iot/latest/developerguide/ +// [AWS Signer Developer Guide]: https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html +// [Amazon S3]: http://docs.aws.amazon.com/AmazonS3/latest/gsg/ +// [AWS CloudTrail]: http://docs.aws.amazon.com/awscloudtrail/latest/userguide/ +// [AWS Certificate Manager (ACM)]: http://docs.aws.amazon.com/acm/latest/userguide/ +// [Amazon CloudWatch]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ +// [Notary
 Project]: https://notaryproject.dev/ +// [Amazon FreeRTOS]: http://docs.aws.amazon.com/freertos/latest/userguide/ package signer diff --git a/service/signer/options.go b/service/signer/options.go index 5b89a761c1f..5412b3e43a0 100644 --- a/service/signer/options.go +++ b/service/signer/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/signer/types/enums.go b/service/signer/types/enums.go index 6478368a501..1cc8cec7a0d 100644 --- a/service/signer/types/enums.go +++ b/service/signer/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for Category. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Category) Values() []Category { return []Category{ "AWSIoT", @@ -27,8 +28,9 @@ const ( ) // Values returns all known values for EncryptionAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionAlgorithm) Values() []EncryptionAlgorithm { return []EncryptionAlgorithm{ "RSA", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for HashAlgorithm. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HashAlgorithm) Values() []HashAlgorithm { return []HashAlgorithm{ "SHA1", @@ -64,8 +67,9 @@ const ( ) // Values returns all known values for ImageFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImageFormat) Values() []ImageFormat { return []ImageFormat{ "JSON", @@ -84,8 +88,9 @@ const ( ) // Values returns all known values for SigningProfileStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SigningProfileStatus) Values() []SigningProfileStatus { return []SigningProfileStatus{ "Active", @@ -104,8 +109,9 @@ const ( ) // Values returns all known values for SigningStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SigningStatus) Values() []SigningStatus { return []SigningStatus{ "InProgress", @@ -124,8 +130,9 @@ const ( ) // 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. +// expanded in the future, and so 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 68d483d3950..f2b9bbebe30 100644 --- a/service/signer/types/errors.go +++ b/service/signer/types/errors.go @@ -204,8 +204,9 @@ func (e *ServiceLimitExceededException) ErrorCode() string { } func (e *ServiceLimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The request was denied due to request throttling. Instead of this error, -// TooManyRequestsException should be used. +// The request was denied due to request throttling. +// +// Instead of this error, TooManyRequestsException should be used. type ThrottlingException struct { Message *string @@ -233,8 +234,9 @@ 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 . +// The allowed number of job-signing requests has been exceeded. +// +// This error supersedes the error ThrottlingException . type TooManyRequestsException struct { Message *string diff --git a/service/simspaceweaver/api_op_CreateSnapshot.go b/service/simspaceweaver/api_op_CreateSnapshot.go index 721a7b09f2b..67cd3345fd0 100644 --- a/service/simspaceweaver/api_op_CreateSnapshot.go +++ b/service/simspaceweaver/api_op_CreateSnapshot.go @@ -16,20 +16,30 @@ import ( // snapshot includes entity data from the State Fabric, the simulation // configuration specified in the schema, and the clock tick number. You can use // the snapshot to initialize a new simulation. For more information about -// snapshots, see Snapshots (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html) -// in the SimSpace Weaver User Guide. You specify a Destination when you create a -// snapshot. The Destination is the name of an Amazon S3 bucket and an optional -// ObjectKeyPrefix . The ObjectKeyPrefix is usually the name of a folder in the -// bucket. SimSpace Weaver creates a snapshot folder inside the Destination and -// places the snapshot file there. The snapshot file is an Amazon S3 object. It has -// an object key with the form: +// snapshots, see [Snapshots]in the SimSpace Weaver User Guide. +// +// You specify a Destination when you create a snapshot. The Destination is the +// name of an Amazon S3 bucket and an optional ObjectKeyPrefix . The +// ObjectKeyPrefix is usually the name of a folder in the bucket. SimSpace Weaver +// creates a snapshot folder inside the Destination and places the snapshot file +// there. +// +// The snapshot file is an Amazon S3 object. It has an object key with the form: // object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip , where: +// // - YY is the 2-digit year +// // - MM is the 2-digit month +// // - dd is the 2-digit day of the month +// // - HH is the 2-digit hour (24-hour clock) +// // - mm is the 2-digit minutes +// // - ss is the 2-digit seconds +// +// [Snapshots]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} @@ -48,8 +58,10 @@ func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput type CreateSnapshotInput struct { // The Amazon S3 bucket and optional folder (object key prefix) where SimSpace - // Weaver creates the snapshot file. The Amazon S3 bucket must be in the same - // Amazon Web Services Region as the simulation. + // Weaver creates the snapshot file. + // + // The Amazon S3 bucket must be in the same Amazon Web Services Region as the + // simulation. // // This member is required. Destination *types.S3Destination diff --git a/service/simspaceweaver/api_op_DeleteSimulation.go b/service/simspaceweaver/api_op_DeleteSimulation.go index eb1196ff168..cb4bee68849 100644 --- a/service/simspaceweaver/api_op_DeleteSimulation.go +++ b/service/simspaceweaver/api_op_DeleteSimulation.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes all SimSpace Weaver resources assigned to the given simulation. Your -// simulation uses resources in other Amazon Web Services. This API operation +// Deletes all SimSpace Weaver resources assigned to the given simulation. +// +// Your simulation uses resources in other Amazon Web Services. This API operation // doesn't delete resources in other Amazon Web Services. func (c *Client) DeleteSimulation(ctx context.Context, params *DeleteSimulationInput, optFns ...func(*Options)) (*DeleteSimulationOutput, error) { if params == nil { diff --git a/service/simspaceweaver/api_op_DescribeSimulation.go b/service/simspaceweaver/api_op_DescribeSimulation.go index 4fe1a95e83c..2ad43870bd0 100644 --- a/service/simspaceweaver/api_op_DescribeSimulation.go +++ b/service/simspaceweaver/api_op_DescribeSimulation.go @@ -41,8 +41,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The time when the simulation was created, expressed as the number of seconds @@ -74,10 +75,11 @@ 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) - // in the Identity and Access Management User Guide. + // see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference. For more information about + // IAM roles, see [IAM roles]in the Identity and Access Management User Guide. + // + // [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html RoleArn *string // An error message that SimSpace Weaver returns only if there is a problem with @@ -87,15 +89,16 @@ 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]. + // + // [Amazon Simple Storage Service User Guide]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html SchemaS3Location *types.S3Location // 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]. + // + // [Amazon Simple Storage Service User Guide]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html SnapshotS3Location *types.S3Location // An error message that SimSpace Weaver returns only if a problem occurs when the diff --git a/service/simspaceweaver/api_op_ListTagsForResource.go b/service/simspaceweaver/api_op_ListTagsForResource.go index eb02533158b..370f336314f 100644 --- a/service/simspaceweaver/api_op_ListTagsForResource.go +++ b/service/simspaceweaver/api_op_ListTagsForResource.go @@ -29,8 +29,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. + // ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/simspaceweaver/api_op_StartSimulation.go b/service/simspaceweaver/api_op_StartSimulation.go index 4daf83f0757..11b2702d4e0 100644 --- a/service/simspaceweaver/api_op_StartSimulation.go +++ b/service/simspaceweaver/api_op_StartSimulation.go @@ -14,10 +14,11 @@ import ( // Starts a simulation with the given name. You must choose to start your // simulation from a schema or from a snapshot. For more information about the -// schema, see the schema reference (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html) -// in the SimSpace Weaver User Guide. For more information about snapshots, see -// Snapshots (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html) -// in the SimSpace Weaver User Guide. +// schema, see the [schema reference]in the SimSpace Weaver User Guide. For more information about +// snapshots, see [Snapshots]in the SimSpace Weaver User Guide. +// +// [schema reference]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html +// [Snapshots]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html func (c *Client) StartSimulation(ctx context.Context, params *StartSimulationInput, optFns ...func(*Options)) (*StartSimulationOutput, error) { if params == nil { params = &StartSimulationInput{} @@ -42,10 +43,11 @@ 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) - // in the Identity and Access Management User Guide. + // see [Amazon Resource Names (ARNs)]in the Amazon Web Services General Reference. For more information about + // IAM roles, see [IAM roles]in the Identity and Access Management User Guide. + // + // [IAM roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. RoleArn *string @@ -66,24 +68,32 @@ type StartSimulationInput struct { MaximumDuration *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) - // . Provide a SchemaS3Location to start your simulation from a schema. If you - // provide a SchemaS3Location then you can't provide a SnapshotS3Location . + // S3). For more information about Amazon S3, see the [Amazon Simple Storage Service User Guide]. + // + // Provide a SchemaS3Location to start your simulation from a schema. + // + // If you provide a SchemaS3Location then you can't provide a SnapshotS3Location . + // + // [Amazon Simple Storage Service User Guide]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html SchemaS3Location *types.S3Location // The location of the snapshot .zip file 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) - // . Provide a SnapshotS3Location to start your simulation from a snapshot. The - // Amazon S3 bucket must be in the same Amazon Web Services Region as the - // simulation. If you provide a SnapshotS3Location then you can't provide a - // SchemaS3Location . + // S3). For more information about Amazon S3, see the [Amazon Simple Storage Service User Guide]. + // + // Provide a SnapshotS3Location to start your simulation from a snapshot. + // + // The Amazon S3 bucket must be in the same Amazon Web Services Region as the + // simulation. + // + // If you provide a SnapshotS3Location then you can't provide a SchemaS3Location . + // + // [Amazon Simple Storage Service User Guide]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html SnapshotS3Location *types.S3Location - // 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. + // A list of tags for the simulation. For more information about tags, see [Tagging Amazon Web Services resources] in the + // Amazon Web Services General Reference. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags map[string]string noSmithyDocumentSerde @@ -92,8 +102,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The time when the simulation was created, expressed as the number of seconds diff --git a/service/simspaceweaver/api_op_StopSimulation.go b/service/simspaceweaver/api_op_StopSimulation.go index c11fa4870f5..059014ea96d 100644 --- a/service/simspaceweaver/api_op_StopSimulation.go +++ b/service/simspaceweaver/api_op_StopSimulation.go @@ -10,9 +10,10 @@ 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 want to restart a simulation, then 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 want to restart a +// simulation, then 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 68d9e844929..a94993dae49 100644 --- a/service/simspaceweaver/api_op_TagResource.go +++ b/service/simspaceweaver/api_op_TagResource.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Adds tags to a SimSpace Weaver resource. For more information about tags, see [Tagging Amazon Web Services resources] // in the Amazon Web Services General Reference. +// +// [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{} @@ -31,8 +32,10 @@ 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. + // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/simspaceweaver/api_op_UntagResource.go b/service/simspaceweaver/api_op_UntagResource.go index 2e723808b8c..fda4b1b4571 100644 --- a/service/simspaceweaver/api_op_UntagResource.go +++ b/service/simspaceweaver/api_op_UntagResource.go @@ -11,8 +11,9 @@ 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]in the Amazon Web Services General Reference. +// +// [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} @@ -31,8 +32,10 @@ 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)]in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/simspaceweaver/doc.go b/service/simspaceweaver/doc.go index 6c7827782e0..2cd0d2bb7a6 100644 --- a/service/simspaceweaver/doc.go +++ b/service/simspaceweaver/doc.go @@ -7,11 +7,15 @@ // run large-scale spatial simulations in the Amazon Web Services Cloud. For // example, you can create crowd simulations, large real-world environments, and // immersive and interactive experiences. For more information about SimSpace -// Weaver, see the 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. This documentation is part of the SimSpace Weaver app SDK -// distributable package. +// Weaver, see the [SimSpace Weaver User Guide]. +// +// 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. This documentation is part of the +// SimSpace Weaver app SDK distributable package. +// +// [SimSpace Weaver User Guide]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/ package simspaceweaver diff --git a/service/simspaceweaver/options.go b/service/simspaceweaver/options.go index 658f08ee598..8ea32911297 100644 --- a/service/simspaceweaver/options.go +++ b/service/simspaceweaver/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/simspaceweaver/types/enums.go b/service/simspaceweaver/types/enums.go index 70be99e67e8..2e5b09b3f5a 100644 --- a/service/simspaceweaver/types/enums.go +++ b/service/simspaceweaver/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ClockStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClockStatus) Values() []ClockStatus { return []ClockStatus{ "UNKNOWN", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for ClockTargetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClockTargetStatus) Values() []ClockTargetStatus { return []ClockTargetStatus{ "UNKNOWN", @@ -58,6 +60,7 @@ const ( // Values returns all known values for LifecycleManagementStrategy. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LifecycleManagementStrategy) Values() []LifecycleManagementStrategy { return []LifecycleManagementStrategy{ @@ -81,8 +84,9 @@ const ( ) // Values returns all known values for SimulationAppStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimulationAppStatus) Values() []SimulationAppStatus { return []SimulationAppStatus{ "STARTING", @@ -105,6 +109,7 @@ const ( // Values returns all known values for SimulationAppTargetStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SimulationAppTargetStatus) Values() []SimulationAppTargetStatus { return []SimulationAppTargetStatus{ @@ -130,8 +135,9 @@ const ( ) // Values returns all known values for SimulationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimulationStatus) Values() []SimulationStatus { return []SimulationStatus{ "UNKNOWN", @@ -157,8 +163,9 @@ const ( ) // Values returns all known values for SimulationTargetStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SimulationTargetStatus) Values() []SimulationTargetStatus { return []SimulationTargetStatus{ "UNKNOWN", diff --git a/service/simspaceweaver/types/types.go b/service/simspaceweaver/types/types.go index 1751a6f2402..a7d927ae438 100644 --- a/service/simspaceweaver/types/types.go +++ b/service/simspaceweaver/types/types.go @@ -8,32 +8,42 @@ 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) -// in the Amazon CloudWatch Logs User Guide. +// about log groups, see [Working with log groups and log streams]in the Amazon CloudWatch Logs User Guide. +// +// [Working with log groups and log streams]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html 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) - // in the Amazon CloudWatch Logs User Guide. + // simulation. For more information about ARNs, see [Amazon Resource Names (ARNs)]in the Amazon Web Services + // General Reference. For more information about log groups, see [Working with log groups and log streams]in the Amazon + // CloudWatch Logs User Guide. + // + // [Working with log groups and log streams]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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: Domains (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains) -// in the SimSpace Weaver User Guide. +// the same launch options and commands. +// +// For more information about domains, see [Key concepts: Domains] in the SimSpace Weaver User Guide. +// +// [Key concepts: Domains]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains type Domain struct { // The type of lifecycle management for apps in the domain. 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 + // unmanaged (you must start and stop the apps). + // + // Lifecycle types + // // - PerWorker – Managed: SimSpace Weaver starts one app on each worker. + // // - BySpatialSubdivision – Managed: SimSpace Weaver starts one 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. Lifecycle LifecycleManagementStrategy @@ -58,12 +68,15 @@ type LaunchOverrides struct { // configuration. type LiveSimulationState struct { - // A list of simulation clocks. At this time, a simulation has only one clock. + // A list of simulation clocks. + // + // At this time, a simulation has only one clock. Clocks []SimulationClock - // A list of domains for the simulation. For more information about domains, see - // Key concepts: Domains (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains) + // A list of domains for the simulation. For more information about domains, see [Key concepts: Domains] // in the SimSpace Weaver User Guide. + // + // [Key concepts: Domains]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains Domains []Domain noSmithyDocumentSerde @@ -73,8 +86,9 @@ 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) - // in the Amazon CloudWatch Logs User Guide. + // information about log groups, see [Working with log groups and log streams]in the Amazon CloudWatch Logs User Guide. + // + // [Working with log groups and log streams]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html CloudWatchLogsLogGroup *CloudWatchLogsLogGroup noSmithyDocumentSerde @@ -93,17 +107,19 @@ type LoggingConfiguration struct { // Weaver creates a file. type S3Destination 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) - // in the Amazon Simple Storage Service User Guide. + // The name of an Amazon S3 bucket. For more information about buckets, see [Creating, configuring, and working with Amazon S3 buckets] in + // the Amazon Simple Storage Service User Guide. + // + // [Creating, configuring, and working with Amazon S3 buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html // // This member is required. BucketName *string // A string prefix for an Amazon S3 object key. It's usually a folder name. For - // more information about folders in Amazon S3, see Organizing objects in the - // Amazon S3 console using folders (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html) - // in the Amazon Simple Storage Service User Guide. + // more information about folders in Amazon S3, see [Organizing objects in the Amazon S3 console using folders]in the Amazon Simple Storage + // Service User Guide. + // + // [Organizing objects in the Amazon S3 console using folders]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html ObjectKeyPrefix *string noSmithyDocumentSerde @@ -111,21 +127,23 @@ type S3Destination 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]. +// +// [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) - // in the Amazon Simple Storage Service User Guide. + // The name of an Amazon S3 bucket. For more information about buckets, see [Creating, configuring, and working with Amazon S3 buckets] in + // the Amazon Simple Storage Service User Guide. + // + // [Creating, configuring, and working with Amazon S3 buckets]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html // // This member is required. 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) - // in the Amazon Simple Storage Service User Guide. + // objects and object keys, see [Uploading, downloading, and working with objects in Amazon S3]in the Amazon Simple Storage Service User Guide. + // + // [Uploading, downloading, and working with objects in Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html // // This member is required. ObjectKey *string @@ -134,9 +152,10 @@ type S3Location struct { } // Information about the network endpoint that you can use to connect to your -// custom or service app. For more information about SimSpace Weaver apps, see Key -// concepts: Apps (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_apps) -// in the SimSpace Weaver User Guide.. +// custom or service app. For more information about SimSpace Weaver apps, see [Key concepts: Apps]in +// the SimSpace Weaver User Guide.. +// +// [Key concepts: Apps]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_apps type SimulationAppEndpointInfo struct { // The IP address of the app. SimSpace Weaver dynamically assigns this IP address @@ -153,9 +172,10 @@ type SimulationAppEndpointInfo struct { // A collection of metadata about the app. type SimulationAppMetadata struct { - // The domain of the app. For more information about domains, see Key concepts: - // Domains (https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains) - // in the SimSpace Weaver User Guide. + // The domain of the app. For more information about domains, see [Key concepts: Domains] in the SimSpace + // Weaver User Guide. + // + // [Key concepts: Domains]: https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains Domain *string // The name of the app. @@ -206,8 +226,9 @@ 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)]in the Amazon Web Services General Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string // The time when the simulation was created, expressed as the number of seconds diff --git a/service/sms/api_op_CreateReplicationJob.go b/service/sms/api_op_CreateReplicationJob.go index 7af0a55df21..daf1328c193 100644 --- a/service/sms/api_op_CreateReplicationJob.go +++ b/service/sms/api_op_CreateReplicationJob.go @@ -53,10 +53,15 @@ 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. KmsKeyId *string diff --git a/service/sms/api_op_DeleteReplicationJob.go b/service/sms/api_op_DeleteReplicationJob.go index e6b614257e8..d5ea18f140f 100644 --- a/service/sms/api_op_DeleteReplicationJob.go +++ b/service/sms/api_op_DeleteReplicationJob.go @@ -10,10 +10,12 @@ 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_DisassociateConnector.go b/service/sms/api_op_DisassociateConnector.go index 86fc2e4db19..f61c52aad1a 100644 --- a/service/sms/api_op_DisassociateConnector.go +++ b/service/sms/api_op_DisassociateConnector.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Disassociates the specified connector from Server Migration Service. After you -// disassociate a connector, it is no longer available to support replication jobs. +// Disassociates the specified connector from Server Migration Service. +// +// After you disassociate a connector, it is no longer available to support +// replication jobs. func (c *Client) DisassociateConnector(ctx context.Context, params *DisassociateConnectorInput, optFns ...func(*Options)) (*DisassociateConnectorOutput, error) { if params == nil { params = &DisassociateConnectorInput{} diff --git a/service/sms/api_op_GetServers.go b/service/sms/api_op_GetServers.go index 833675d3a84..0f0cbac750c 100644 --- a/service/sms/api_op_GetServers.go +++ b/service/sms/api_op_GetServers.go @@ -12,8 +12,9 @@ import ( "time" ) -// Describes the servers in your server catalog. Before you can describe your -// servers, you must import them using ImportServerCatalog . +// Describes the servers in your server catalog. +// +// Before you can describe your 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 a8345385342..7f33ceb15c9 100644 --- a/service/sms/api_op_ImportAppCatalog.go +++ b/service/sms/api_op_ImportAppCatalog.go @@ -30,8 +30,9 @@ 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) - // described in the Migration Hub User Guide. + // you provide must have the [policy and trust policy]described in the Migration Hub User Guide. + // + // [policy and trust policy]: https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed RoleName *string noSmithyDocumentSerde diff --git a/service/sms/api_op_ImportServerCatalog.go b/service/sms/api_op_ImportServerCatalog.go index 06d44df7710..8d39759d2c9 100644 --- a/service/sms/api_op_ImportServerCatalog.go +++ b/service/sms/api_op_ImportServerCatalog.go @@ -11,8 +11,10 @@ import ( ) // 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. +// 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_StartOnDemandReplicationRun.go b/service/sms/api_op_StartOnDemandReplicationRun.go index 0ef24c210bc..1d2726d01cc 100644 --- a/service/sms/api_op_StartOnDemandReplicationRun.go +++ b/service/sms/api_op_StartOnDemandReplicationRun.go @@ -12,8 +12,10 @@ import ( // Starts an on-demand replication run for the specified replication job. This // replication run starts immediately. This replication run is in addition to the -// ones already scheduled. There is a limit on the number of on-demand replications -// runs that you can request in a 24-hour period. +// ones already scheduled. +// +// There is a limit on the number of on-demand replications runs that you can +// request in a 24-hour period. func (c *Client) StartOnDemandReplicationRun(ctx context.Context, params *StartOnDemandReplicationRunInput, optFns ...func(*Options)) (*StartOnDemandReplicationRunOutput, error) { if params == nil { params = &StartOnDemandReplicationRunInput{} diff --git a/service/sms/api_op_UpdateReplicationJob.go b/service/sms/api_op_UpdateReplicationJob.go index 9696b12bd91..827e5eed2cd 100644 --- a/service/sms/api_op_UpdateReplicationJob.go +++ b/service/sms/api_op_UpdateReplicationJob.go @@ -47,10 +47,15 @@ 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. KmsKeyId *string diff --git a/service/sms/doc.go b/service/sms/doc.go index a3e8a64a7f1..d3a780c62d1 100644 --- a/service/sms/doc.go +++ b/service/sms/doc.go @@ -3,13 +3,22 @@ // 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] (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] +// +// [Server Migration Service User Guide] +// +// [Server Migration Service User Guide]: https://docs.aws.amazon.com/server-migration-service/latest/userguide/ +// [Amazon Web Services Application Migration Service]: http://aws.amazon.com/application-migration-service +// [Server Migration Service product page]: http://aws.amazon.com/server-migration-service/ package sms diff --git a/service/sms/options.go b/service/sms/options.go index e664fe1ab67..8a68a14a9f4 100644 --- a/service/sms/options.go +++ b/service/sms/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sms/types/enums.go b/service/sms/types/enums.go index c5b0bc0c64a..a306af1fd7d 100644 --- a/service/sms/types/enums.go +++ b/service/sms/types/enums.go @@ -12,8 +12,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppLaunchConfigurationStatus) Values() []AppLaunchConfigurationStatus { return []AppLaunchConfigurationStatus{ "NOT_CONFIGURED", @@ -43,8 +44,9 @@ const ( ) // Values returns all known values for AppLaunchStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppLaunchStatus) Values() []AppLaunchStatus { return []AppLaunchStatus{ "READY_FOR_CONFIGURATION", @@ -75,8 +77,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppReplicationConfigurationStatus) Values() []AppReplicationConfigurationStatus { return []AppReplicationConfigurationStatus{ "NOT_CONFIGURED", @@ -107,8 +110,9 @@ const ( ) // Values returns all known values for AppReplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AppReplicationStatus) Values() []AppReplicationStatus { return []AppReplicationStatus{ "READY_FOR_CONFIGURATION", @@ -143,8 +147,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -164,8 +169,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SSM", @@ -184,8 +190,9 @@ const ( ) // Values returns all known values for ConnectorCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorCapability) Values() []ConnectorCapability { return []ConnectorCapability{ "VSPHERE", @@ -205,8 +212,9 @@ const ( ) // Values returns all known values for ConnectorStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectorStatus) Values() []ConnectorStatus { return []ConnectorStatus{ "HEALTHY", @@ -223,8 +231,9 @@ const ( ) // Values returns all known values for LicenseType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LicenseType) Values() []LicenseType { return []LicenseType{ "AWS", @@ -241,8 +250,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -265,8 +275,9 @@ const ( ) // Values returns all known values for ReplicationJobState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationJobState) Values() []ReplicationJobState { return []ReplicationJobState{ "PENDING", @@ -294,8 +305,9 @@ const ( ) // Values returns all known values for ReplicationRunState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationRunState) Values() []ReplicationRunState { return []ReplicationRunState{ "PENDING", @@ -317,8 +329,9 @@ const ( ) // Values returns all known values for ReplicationRunType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationRunType) Values() []ReplicationRunType { return []ReplicationRunType{ "ON_DEMAND", @@ -335,8 +348,9 @@ const ( ) // Values returns all known values for ScriptType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScriptType) Values() []ScriptType { return []ScriptType{ "SHELL_SCRIPT", @@ -356,8 +370,9 @@ const ( ) // Values returns all known values for ServerCatalogStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerCatalogStatus) Values() []ServerCatalogStatus { return []ServerCatalogStatus{ "NOT_IMPORTED", @@ -376,8 +391,9 @@ const ( ) // Values returns all known values for ServerType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerType) Values() []ServerType { return []ServerType{ "VIRTUAL_MACHINE", @@ -393,6 +409,7 @@ const ( // 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{ @@ -412,8 +429,9 @@ const ( ) // Values returns all known values for ValidationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationStatus) Values() []ValidationStatus { return []ValidationStatus{ "READY_FOR_VALIDATION", @@ -434,8 +452,9 @@ const ( ) // Values returns all known values for VmManagerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VmManagerType) Values() []VmManagerType { return []VmManagerType{ "VSPHERE", diff --git a/service/sms/types/types.go b/service/sms/types/types.go index 7fe99b360a5..7ad10c49bf5 100644 --- a/service/sms/types/types.go +++ b/service/sms/types/types.go @@ -178,10 +178,15 @@ 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. KmsKeyId *string @@ -249,10 +254,15 @@ 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. KmsKeyId *string @@ -445,10 +455,15 @@ 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. KmsKeyId *string diff --git a/service/snowball/api_op_CreateCluster.go b/service/snowball/api_op_CreateCluster.go index 2c156aceed0..736e6134d26 100644 --- a/service/snowball/api_op_CreateCluster.go +++ b/service/snowball/api_op_CreateCluster.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an empty cluster. Each cluster supports five nodes. You use the -// CreateJob action separately to create the jobs for each of these nodes. The -// cluster does not ship until these five node jobs have been created. +// Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action +// separately to create the jobs for each of these nodes. The cluster does not ship +// until these five node jobs have been created. func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error) { if params == nil { params = &CreateClusterInput{} @@ -37,7 +37,9 @@ 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" @@ -50,30 +52,40 @@ type CreateClusterInput struct { // 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, 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 - // The type of Snow Family devices to use for this cluster. For cluster jobs, - // Amazon Web Services Snow Family currently supports only the EDGE device type. + // The type of Snow Family devices to use for this cluster. + // + // For cluster jobs, Amazon Web Services Snow Family currently supports only the + // EDGE device type. + // // 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 @@ -102,8 +114,9 @@ type CreateClusterInput struct { InitialClusterSize *int32 // 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]API action in Key Management Service (KMS). + // + // [CreateKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html KmsKeyARN *string // Lists long-term pricing id that will be used to associate with jobs @@ -130,13 +143,16 @@ type CreateClusterInput struct { 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]API action in Identity and Access Management (IAM). + // + // [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html RoleARN *string // If your job is being created in one of the US regions, you have the option of // specifying what size Snow device you'd like for this job. In all other regions, - // Snowballs come with 80 TB in storage capacity. For more information, see + // Snowballs come with 80 TB in storage capacity. + // + // 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" @@ -154,9 +170,9 @@ type CreateClusterOutput struct { // The automatically generated ID for a cluster. ClusterId *string - // List of jobs created for this cluster. For syntax, see - // ListJobsResult$JobListEntries (http://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax) - // in this guide. + // List of jobs created for this cluster. For syntax, see [ListJobsResult$JobListEntries] in this guide. + // + // [ListJobsResult$JobListEntries]: http://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax JobListEntries []types.JobListEntry // Metadata pertaining to the operation's result. diff --git a/service/snowball/api_op_CreateJob.go b/service/snowball/api_op_CreateJob.go index 03f2f31b2ea..cae83403ebb 100644 --- a/service/snowball/api_op_CreateJob.go +++ b/service/snowball/api_op_CreateJob.go @@ -15,45 +15,88 @@ import ( // data center. Your Amazon Web Services account must have the right trust policies // and permissions in place to create a job for a Snow device. If you're creating a // job for a node in a cluster, you only need to provide the clusterId value; the -// other job attributes are inherited from the cluster. Only the Snowball; Edge -// 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. +// other job attributes are inherited from the cluster. +// +// Only the Snowball; Edge 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]. +// +// Snow Family devices and their capacities. +// // - Device type: SNC1_SSD +// // - Capacity: T14 +// // - Description: Snowcone +// // - 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 This device -// is replaced with T98. +// +// - Description: Snowball Edge Storage Optimized with EC2 Compute +// +// This device is replaced with T98. +// // - 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. -// - Snow Family device type: RACK_5U_C -// - Capacity: T13 -// - Description: Snowblade. -// - Device type: V3_5S -// - Capacity: T240 -// - Description: Snowball Edge Storage Optimized 210TB +// +// - 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. +// +// - Snow Family device type: RACK_5U_C +// +// - Capacity: T13 +// +// - Description: Snowblade. +// +// - Device type: V3_5S +// +// - Capacity: T240 +// +// - Description: Snowball Edge Storage Optimized 210TB +// +// [Amazon Web Services Regional Services]: https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ngi&loc=4 func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error) { if params == nil { params = &CreateJobInput{} @@ -83,7 +126,9 @@ type CreateJobInput struct { // Photos 2016-08-11 . Description *string - // Defines the device configuration for an Snowcone job. For more information, see + // Defines the device configuration for an Snowcone job. + // + // 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" @@ -102,8 +147,9 @@ type CreateJobInput struct { JobType types.JobType // 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. + // using the [CreateKey]Key Management Service (KMS) API action. + // + // [CreateKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html KmsKeyARN *string // The ID of the long-term pricing type for the device. @@ -130,8 +176,11 @@ type CreateJobInput struct { // 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. + // 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 @@ -140,42 +189,56 @@ type CreateJobInput struct { Resources *types.JobResource // 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. + // using the [CreateRole]Identity and Access Management (IAM) API action. + // + // [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html 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. ShippingOption types.ShippingOption // If your job is being created in one of the US regions, you have the option of // specifying what size Snow device you'd like for this job. In all other regions, - // Snowballs come with 80 TB in storage capacity. For more information, see + // Snowballs come with 80 TB in storage capacity. + // + // 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" // (Snow Family Devices and Capacity) in the Snowcone User Guide. SnowballCapacityPreference types.SnowballCapacity - // 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) - // in the Snowball Edge Developer Guide. For more information, see + // 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] 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 // "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" // (Snow Family Devices and Capacity) in the Snowcone User Guide. + // + // [Snowball Edge Device Options]: https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html SnowballType types.SnowballType // The tax documents required in your Amazon Web Services Region. diff --git a/service/snowball/api_op_GetJobManifest.go b/service/snowball/api_op_GetJobManifest.go index db8479c61a7..eb1d48c994e 100644 --- a/service/snowball/api_op_GetJobManifest.go +++ b/service/snowball/api_op_GetJobManifest.go @@ -14,17 +14,22 @@ import ( // with the specified JobId value. You can access the manifest file for up to 60 // minutes after this request has been made. To access the manifest file after 60 // minutes have passed, you'll have to make another call to the GetJobManifest -// action. The manifest is an encrypted file that you can download after your job -// enters the WithCustomer status. This is the only valid status for calling this -// API as the manifest and UnlockCode code value are used for securing your device -// 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 -// 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. +// action. +// +// The manifest is an encrypted file that you can download after your job enters +// the WithCustomer status. This is the only valid status for calling this API as +// the manifest and UnlockCode code value are used for securing your device 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 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. func (c *Client) GetJobManifest(ctx context.Context, params *GetJobManifestInput, optFns ...func(*Options)) (*GetJobManifestOutput, error) { if params == nil { params = &GetJobManifestInput{} diff --git a/service/snowball/api_op_GetJobUnlockCode.go b/service/snowball/api_op_GetJobUnlockCode.go index 9d9db55f90c..04e187d2cad 100644 --- a/service/snowball/api_op_GetJobUnlockCode.go +++ b/service/snowball/api_op_GetJobUnlockCode.go @@ -12,16 +12,19 @@ import ( // Returns the UnlockCode code value for the specified job. A particular UnlockCode // value can be accessed for up to 360 days after the associated job has been -// created. The UnlockCode value is a 29-character code with 25 alphanumeric -// characters and 4 hyphens. This code is used to decrypt the manifest file when it -// is passed along with the manifest to the Snow device through the Snowball client -// when the client is started for the first time. The only valid status for calling -// this API is WithCustomer as the manifest and Unlock code values are used for -// securing your device and should only be used when you have the device. As a best -// practice, we recommend that you don't save a copy of the UnlockCode 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. +// created. +// +// The UnlockCode value is a 29-character code with 25 alphanumeric characters and +// 4 hyphens. This code is used to decrypt the manifest file when it is passed +// along with the manifest to the Snow device through the Snowball client when the +// client is started for the first time. The only valid status for calling this API +// is WithCustomer as the manifest and Unlock code values are used for securing +// your device and should only be used when you have the device. +// +// As a best practice, we recommend that you don't save a copy of the UnlockCode +// 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. func (c *Client) GetJobUnlockCode(ctx context.Context, params *GetJobUnlockCodeInput, optFns ...func(*Options)) (*GetJobUnlockCodeOutput, error) { if params == nil { params = &GetJobUnlockCodeInput{} diff --git a/service/snowball/api_op_GetSnowballUsage.go b/service/snowball/api_op_GetSnowballUsage.go index 55b1226592e..3c98cf5b07a 100644 --- a/service/snowball/api_op_GetSnowballUsage.go +++ b/service/snowball/api_op_GetSnowballUsage.go @@ -11,9 +11,11 @@ import ( ) // Returns information about the Snow Family service limit for your account, and -// also the number of Snow devices your account has in use. The default service -// limit for the number of Snow devices that you can have at one time is 1. If you -// want to increase your service limit, contact Amazon Web Services Support. +// also the number of Snow devices your account has in use. +// +// The default service limit for the number of Snow devices that you can have at +// one time is 1. If you want to increase your service limit, contact Amazon Web +// Services Support. func (c *Client) GetSnowballUsage(ctx context.Context, params *GetSnowballUsageInput, optFns ...func(*Options)) (*GetSnowballUsageOutput, error) { if params == nil { params = &GetSnowballUsageInput{} diff --git a/service/snowball/api_op_UpdateCluster.go b/service/snowball/api_op_UpdateCluster.go index 6caea57a0bb..81a34ac885a 100644 --- a/service/snowball/api_op_UpdateCluster.go +++ b/service/snowball/api_op_UpdateCluster.go @@ -56,13 +56,14 @@ type UpdateClusterInput struct { // Snow Family device clusters support Amazon S3 and NFS (Network File System). OnDeviceServiceConfiguration *types.OnDeviceServiceConfiguration - // The updated arrays of JobResource objects that can include updated S3Resource - // objects or LambdaResource objects. + // The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. 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]API action in Identity and Access + // Management (IAM). + // + // [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html 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 ab7bdf7321c..caf38c9de4c 100644 --- a/service/snowball/api_op_UpdateJob.go +++ b/service/snowball/api_op_UpdateJob.go @@ -63,15 +63,19 @@ 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]Identity and Access Management (IAM) API + // action. + // + // [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html RoleARN *string // The updated shipping option value of this job's ShippingDetails object. ShippingOption types.ShippingOption - // The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 - // TB Snowballs are only available in the US regions. For more information, see + // The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB + // Snowballs are only available in the US regions. + // + // 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" diff --git a/service/snowball/api_op_UpdateJobShipmentState.go b/service/snowball/api_op_UpdateJobShipmentState.go index 26bc12210c6..5eb50cf1121 100644 --- a/service/snowball/api_op_UpdateJobShipmentState.go +++ b/service/snowball/api_op_UpdateJobShipmentState.go @@ -35,9 +35,11 @@ type UpdateJobShipmentStateInput struct { // This member is required. JobId *string - // The state of a device when it is being shipped. Set to RECEIVED when the device - // arrives at your location. Set to RETURNED when you have returned the device to - // Amazon Web Services. + // The state of a device when it is being shipped. + // + // Set to RECEIVED when the device arrives at your location. + // + // Set to RETURNED when you have returned the device to Amazon Web Services. // // This member is required. ShipmentState types.ShipmentState diff --git a/service/snowball/doc.go b/service/snowball/doc.go index fa513418660..5aae4bfceb8 100644 --- a/service/snowball/doc.go +++ b/service/snowball/doc.go @@ -11,6 +11,7 @@ // 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]. +// +// [User Guide]: https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html package snowball diff --git a/service/snowball/options.go b/service/snowball/options.go index 6a2215c6ee6..a66ad261364 100644 --- a/service/snowball/options.go +++ b/service/snowball/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/snowball/types/enums.go b/service/snowball/types/enums.go index 40a66568cc5..1a10d19bb55 100644 --- a/service/snowball/types/enums.go +++ b/service/snowball/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AddressType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AddressType) Values() []AddressType { return []AddressType{ "CUST_PICKUP", @@ -32,8 +33,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for DeviceServiceName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceServiceName) Values() []DeviceServiceName { return []DeviceServiceName{ "NFS_ON_DEVICE_SERVICE", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for ImpactLevel. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImpactLevel) Values() []ImpactLevel { return []ImpactLevel{ "IL2", @@ -106,8 +110,9 @@ const ( ) // Values returns all known values for JobState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobState) Values() []JobState { return []JobState{ "New", @@ -136,8 +141,9 @@ const ( ) // Values returns all known values for JobType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JobType) Values() []JobType { return []JobType{ "IMPORT", @@ -156,8 +162,9 @@ const ( ) // Values returns all known values for LongTermPricingType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LongTermPricingType) Values() []LongTermPricingType { return []LongTermPricingType{ "OneYear", @@ -176,8 +183,9 @@ const ( ) // Values returns all known values for RemoteManagement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RemoteManagement) Values() []RemoteManagement { return []RemoteManagement{ "INSTALLED_ONLY", @@ -195,8 +203,9 @@ const ( ) // Values returns all known values for ServiceName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceName) Values() []ServiceName { return []ServiceName{ "KUBERNETES", @@ -213,8 +222,9 @@ const ( ) // Values returns all known values for ShipmentState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShipmentState) Values() []ShipmentState { return []ShipmentState{ "RECEIVED", @@ -233,8 +243,9 @@ const ( ) // Values returns all known values for ShippingLabelStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShippingLabelStatus) Values() []ShippingLabelStatus { return []ShippingLabelStatus{ "InProgress", @@ -255,8 +266,9 @@ const ( ) // Values returns all known values for ShippingOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShippingOption) Values() []ShippingOption { return []ShippingOption{ "SECOND_DAY", @@ -284,8 +296,9 @@ const ( ) // Values returns all known values for SnowballCapacity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SnowballCapacity) Values() []SnowballCapacity { return []SnowballCapacity{ "T50", @@ -319,8 +332,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -344,8 +358,9 @@ const ( ) // Values returns all known values for StorageUnit. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageUnit) Values() []StorageUnit { return []StorageUnit{ "TB", @@ -362,8 +377,9 @@ const ( ) // Values returns all known values for TransferOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TransferOption) Values() []TransferOption { return []TransferOption{ "IMPORT", diff --git a/service/snowball/types/errors.go b/service/snowball/types/errors.go index bbff415187f..585f3f81a3f 100644 --- a/service/snowball/types/errors.go +++ b/service/snowball/types/errors.go @@ -119,8 +119,7 @@ func (e *InvalidAddressException) ErrorCode() string { func (e *InvalidAddressException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Job or cluster creation failed. One or more inputs were invalid. Confirm that -// the CreateClusterRequest$SnowballType value supports your -// CreateJobRequest$JobType , and try again. +// the CreateClusterRequest$SnowballTypevalue supports your CreateJobRequest$JobType, and try again. type InvalidInputCombinationException struct { Message *string @@ -230,7 +229,7 @@ func (e *InvalidResourceException) ErrorCode() string { func (e *InvalidResourceException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The provided Key Management Service key lacks the permissions to perform the -// specified CreateJob or UpdateJob action. +// specified CreateJobor UpdateJob action. type KMSRequestFailedException struct { Message *string diff --git a/service/snowball/types/types.go b/service/snowball/types/types.go index b85df66746b..1e494949797 100644 --- a/service/snowball/types/types.go +++ b/service/snowball/types/types.go @@ -73,7 +73,7 @@ type ClusterListEntry struct { ClusterId *string // The current state of this cluster. For information about the state of a - // specific node, see JobListEntry$JobState . + // specific node, see JobListEntry$JobState. ClusterState ClusterState // The creation date for this cluster. @@ -113,8 +113,9 @@ type ClusterMetadata struct { 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]API action in Key Management Service (KMS. + // + // [CreateKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html KmsKeyARN *string // The Amazon Simple Notification Service (Amazon SNS) notification settings for @@ -125,31 +126,37 @@ 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). + // The role ARN associated with this cluster. This ARN was created using the [CreateRole] API + // action in Identity and Access Management (IAM). + // + // [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html 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. ShippingOption ShippingOption - // The type of Snowcone device to use for this cluster. For cluster jobs, Amazon - // Web Services Snow Family currently supports only the EDGE device type. + // The type of Snowcone device to use for this cluster. + // + // For cluster jobs, Amazon Web Services Snow Family currently supports only the + // EDGE device type. SnowballType SnowballType // The tax documents required in your Amazon Web Services Region. @@ -248,7 +255,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 @@ -308,16 +315,20 @@ type JobListEntry struct { // 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. +// 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. @@ -383,8 +394,9 @@ 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]API action in KMS. + // + // [CreateKey]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html KmsKeyARN *string // The ID of the long-term pricing type for the device. @@ -412,8 +424,10 @@ type JobMetadata struct { // 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] API + // action in Identity and Access Management. + // + // [CreateRole]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html RoleARN *string // A job's shipping information, including inbound and outbound tracking numbers @@ -422,7 +436,9 @@ type JobMetadata struct { // The Snow device capacity preference for this job, specified at job creation. In // US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions - // use 80 TB capacity Snowballs. For more information, see + // use 80 TB capacity Snowballs. + // + // 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" @@ -479,8 +495,7 @@ type KeyRange struct { // Identifies type LambdaResource struct { - // The array of ARNs for S3Resource objects to trigger the LambdaResource objects - // associated with this job. + // The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job. EventTriggers []EventTriggerDefinition // An Amazon Resource Name (ARN) that represents an Lambda function to be @@ -536,7 +551,9 @@ type NFSOnDeviceServiceConfiguration struct { // The maximum NFS storage for one Snow Family device. StorageLimit int32 - // The scale unit of the NFS storage on the device. Valid values: TB. + // The scale unit of the NFS storage on the device. + // + // Valid values: TB. StorageUnit StorageUnit noSmithyDocumentSerde @@ -545,6 +562,7 @@ 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 @@ -562,10 +580,14 @@ 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]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]Amazon Simple Notification Service + // (Amazon SNS) API action. + // + // [CreateTopic]: https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html + // [Subscribe]: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html SnsTopicARN *string noSmithyDocumentSerde @@ -686,8 +708,9 @@ type Shipment struct { Status *string // The tracking number for this job. Using this tracking number with your region's - // carrier's website, you can track a Snow device as the carrier transports it. For - // India, the carrier is Amazon Logistics. For all other regions, UPS is the + // carrier's website, you can track a Snow device as the carrier transports it. + // + // For India, the carrier is Amazon Logistics. For all other regions, UPS is the // carrier. TrackingNumber *string @@ -710,13 +733,17 @@ 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. ShippingOption ShippingOption diff --git a/service/snowdevicemanagement/api_op_CancelTask.go b/service/snowdevicemanagement/api_op_CancelTask.go index 08a62ac8613..654329d6bdf 100644 --- a/service/snowdevicemanagement/api_op_CancelTask.go +++ b/service/snowdevicemanagement/api_op_CancelTask.go @@ -11,8 +11,9 @@ import ( ) // Sends a cancel request for a specified task. You can cancel a task only if it's -// still in a QUEUED state. Tasks that are already running can't be cancelled. A -// task might still run if it's processed from the queue before the CancelTask +// still in a QUEUED state. Tasks that are already running can't be cancelled. +// +// A task might still run if it's processed from the queue before the CancelTask // operation changes the task's state. func (c *Client) CancelTask(ctx context.Context, params *CancelTaskInput, optFns ...func(*Options)) (*CancelTaskOutput, error) { if params == nil { diff --git a/service/snowdevicemanagement/options.go b/service/snowdevicemanagement/options.go index a23aaa58de7..0b53483ebdc 100644 --- a/service/snowdevicemanagement/options.go +++ b/service/snowdevicemanagement/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/snowdevicemanagement/types/enums.go b/service/snowdevicemanagement/types/enums.go index 5ca65fcb467..f24ddc6c36e 100644 --- a/service/snowdevicemanagement/types/enums.go +++ b/service/snowdevicemanagement/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AttachmentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentStatus) Values() []AttachmentStatus { return []AttachmentStatus{ "ATTACHING", @@ -38,8 +39,9 @@ const ( ) // Values returns all known values for ExecutionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionState) Values() []ExecutionState { return []ExecutionState{ "QUEUED", @@ -65,8 +67,9 @@ const ( ) // Values returns all known values for InstanceStateName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStateName) Values() []InstanceStateName { return []InstanceStateName{ "PENDING", @@ -87,8 +90,9 @@ const ( ) // Values returns all known values for IpAddressAssignment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressAssignment) Values() []IpAddressAssignment { return []IpAddressAssignment{ "DHCP", @@ -108,8 +112,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RJ45", @@ -130,8 +135,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -150,8 +156,9 @@ const ( ) // Values returns all known values for UnlockState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UnlockState) Values() []UnlockState { return []UnlockState{ "UNLOCKED", diff --git a/service/snowdevicemanagement/types/types.go b/service/snowdevicemanagement/types/types.go index 843066cbf4d..691ba5f9456 100644 --- a/service/snowdevicemanagement/types/types.go +++ b/service/snowdevicemanagement/types/types.go @@ -187,18 +187,30 @@ type InstanceBlockDeviceMapping struct { // The description of the current state of an instance. type InstanceState struct { - // The state of the instance as a 16-bit unsigned integer. The high byte is all of - // the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and - // 65,535. These numerical values are used for internal purposes and should be - // 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: + // The state of the instance as a 16-bit unsigned integer. + // + // The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal + // values between 256 and 65,535. These numerical values are used for internal + // purposes and should be 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. Code *int32 diff --git a/service/sns/api_op_AddPermission.go b/service/sns/api_op_AddPermission.go index a752589cca8..75f1f8d36ff 100644 --- a/service/sns/api_op_AddPermission.go +++ b/service/sns/api_op_AddPermission.go @@ -11,10 +11,11 @@ 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 -// policy. +// 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 policy. func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error) { if params == nil { params = &AddPermissionInput{} @@ -39,8 +40,9 @@ type AddPermissionInput struct { // This member is required. AWSAccountId []string - // The action you want to allow for the specified principal(s). Valid values: Any - // Amazon SNS action name, for example Publish . + // The action you want to allow for the specified principal(s). + // + // Valid values: Any 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 9ee13cb631e..8dd121b829c 100644 --- a/service/sns/api_op_CheckIfPhoneNumberIsOptedOut.go +++ b/service/sns/api_op_CheckIfPhoneNumberIsOptedOut.go @@ -12,8 +12,10 @@ import ( // Accepts a phone number and indicates whether the phone holder has opted out of // receiving SMS messages from your Amazon Web Services account. You cannot send -// SMS messages to a number that is opted out. To resume sending messages, you can -// opt in the number by using the OptInPhoneNumber action. +// SMS messages to a number that is opted out. +// +// To resume sending messages, you can opt in the number by using the +// OptInPhoneNumber action. func (c *Client) CheckIfPhoneNumberIsOptedOut(ctx context.Context, params *CheckIfPhoneNumberIsOptedOutInput, optFns ...func(*Options)) (*CheckIfPhoneNumberIsOptedOutOutput, error) { if params == nil { params = &CheckIfPhoneNumberIsOptedOutInput{} @@ -44,8 +46,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. IsOptedOut bool diff --git a/service/sns/api_op_CreatePlatformApplication.go b/service/sns/api_op_CreatePlatformApplication.go index 6735d42b69e..bdbba887ba7 100644 --- a/service/sns/api_op_CreatePlatformApplication.go +++ b/service/sns/api_op_CreatePlatformApplication.go @@ -14,26 +14,35 @@ import ( // 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) using key credentials, there is no // PlatformPrincipal . The PlatformCredential is API key . +// // - For GCM (Firebase Cloud Messaging) using token credentials, there is no // PlatformPrincipal . The PlatformCredential is a JSON formatted private key // file. When using the Amazon Web Services CLI, the file must be in string format // and special characters must be ignored. To format the file correctly, Amazon SNS // recommends using the following command: SERVICE_JSON=`jq @json <<< cat // service.json` . +// // - For MPNS , PlatformPrincipal is TLS certificate and PlatformCredential is // private key . +// // - For WNS , PlatformPrincipal is Package Security Identifier and // PlatformCredential is secret key . // @@ -57,8 +66,9 @@ 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]SetPlatformApplicationAttributes . + // + // [SetPlatformApplicationAttributes]: https://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html // // This member is required. Attributes map[string]string diff --git a/service/sns/api_op_CreatePlatformEndpoint.go b/service/sns/api_op_CreatePlatformEndpoint.go index 78d0e3895e5..37b24c5a103 100644 --- a/service/sns/api_op_CreatePlatformEndpoint.go +++ b/service/sns/api_op_CreatePlatformEndpoint.go @@ -17,12 +17,14 @@ import ( // 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) -// . +// is returned without creating a new endpoint. For more information, see [Using Amazon SNS Mobile Push Notifications]. +// +// 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]. +// +// [Creating an Amazon SNS Endpoint for Baidu]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html +// [Using Amazon SNS Mobile Push Notifications]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html func (c *Client) CreatePlatformEndpoint(ctx context.Context, params *CreatePlatformEndpointInput, optFns ...func(*Options)) (*CreatePlatformEndpointOutput, error) { if params == nil { params = &CreatePlatformEndpointInput{} @@ -56,8 +58,9 @@ 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]SetEndpointAttributes . + // + // [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 diff --git a/service/sns/api_op_CreateSMSSandboxPhoneNumber.go b/service/sns/api_op_CreateSMSSandboxPhoneNumber.go index 195b8a83baf..940a859d780 100644 --- a/service/sns/api_op_CreateSMSSandboxPhoneNumber.go +++ b/service/sns/api_op_CreateSMSSandboxPhoneNumber.go @@ -12,15 +12,18 @@ import ( ) // Adds a destination phone number to an Amazon Web Services account in the SMS -// sandbox and sends a one-time password (OTP) to that phone number. When you start -// using Amazon SNS to send SMS messages, your Amazon Web Services account is in -// the SMS sandbox. The SMS sandbox provides a safe environment for you to try -// Amazon SNS features without risking your reputation as an SMS sender. While your -// 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 +// sandbox and sends a one-time password (OTP) to that phone number. +// +// When you start using Amazon SNS to send SMS messages, your Amazon Web Services +// account is in the SMS sandbox. The SMS sandbox provides a safe environment for +// you to try Amazon SNS features without risking your reputation as an SMS sender. +// While your 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]in the Amazon SNS +// Developer Guide. +// +// [SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html func (c *Client) CreateSMSSandboxPhoneNumber(ctx context.Context, params *CreateSMSSandboxPhoneNumberInput, optFns ...func(*Options)) (*CreateSMSSandboxPhoneNumberOutput, error) { if params == nil { params = &CreateSMSSandboxPhoneNumberInput{} diff --git a/service/sns/api_op_CreateTopic.go b/service/sns/api_op_CreateTopic.go index 4062665950a..8a6ad90d958 100644 --- a/service/sns/api_op_CreateTopic.go +++ b/service/sns/api_op_CreateTopic.go @@ -13,10 +13,11 @@ 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 +// see [Creating an Amazon SNS topic]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. +// +// [Creating an Amazon SNS topic]: https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optFns ...func(*Options)) (*CreateTopicOutput, error) { if params == nil { params = &CreateTopicInput{} @@ -35,67 +36,93 @@ func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optF // Input for CreateTopic action. type CreateTopicInput struct { - // The name of the topic you want to create. Constraints: Topic names must be made - // up of only uppercase and lowercase ASCII letters, numbers, underscores, and - // hyphens, and must be between 1 and 256 characters long. For a FIFO - // (first-in-first-out) topic, the name must end with the .fifo suffix. + // The name of the topic you want to create. + // + // Constraints: Topic names must be made up of only uppercase and lowercase ASCII + // letters, numbers, underscores, and hyphens, and must be between 1 and 256 + // characters long. + // + // For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. // // This member is required. Name *string - // 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: + // 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) - // : + // + // The following attribute applies only to [server-side encryption]: + // // - 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) - // : + // key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key Terms]. For + // more examples, see [KeyId]in the Key Management Service API Reference. + // + // The following attributes apply only to [FIFO topics]: + // // - ArchivePolicy – Adds or updates an inline policy document to archive // messages stored in the specified Amazon SNS topic. + // // - BeginningArchiveTime – The earliest starting point at which a message in the // topic’s archive can be replayed from. This point in time is based on the // configured message retention period set by the topic’s message archiving policy. // // - 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. + // MessageDeduplicationId parameter for the [Publish]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. + // 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. + // + // [server-side encryption]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html + // [Key Terms]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms + // [KeyId]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters + // [Publish]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html + // [FIFO topics]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html 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 - // Constraints: Maximum length of 30,720. + // 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 - // The list of tags to add to a new topic. To be able to tag a topic on creation, - // you must have the sns:CreateTopic and sns:TagResource permissions. + // The list of tags to add to a new topic. + // + // To be able to tag a topic on creation, you must have the sns:CreateTopic and + // sns:TagResource permissions. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/sns/api_op_DeleteEndpoint.go b/service/sns/api_op_DeleteEndpoint.go index 4d2ac2e3d8c..08ae1bd2039 100644 --- a/service/sns/api_op_DeleteEndpoint.go +++ b/service/sns/api_op_DeleteEndpoint.go @@ -11,10 +11,12 @@ import ( ) // 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) . +// is idempotent. For more information, see [Using Amazon SNS Mobile Push Notifications]. +// // When you delete an endpoint that is also subscribed to a topic, then you must // also unsubscribe the endpoint from the topic. +// +// [Using Amazon SNS Mobile Push Notifications]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html 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 03e024dcd4c..85f4128c6d2 100644 --- a/service/sns/api_op_DeletePlatformApplication.go +++ b/service/sns/api_op_DeletePlatformApplication.go @@ -12,8 +12,9 @@ import ( // 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) -// . +// information, see [Using Amazon SNS Mobile Push Notifications]. +// +// [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 485c13bd4a2..2585a6172c5 100644 --- a/service/sns/api_op_DeleteSMSSandboxPhoneNumber.go +++ b/service/sns/api_op_DeleteSMSSandboxPhoneNumber.go @@ -11,15 +11,18 @@ import ( ) // Deletes an Amazon Web Services account's verified or pending phone number from -// the SMS sandbox. When you start using Amazon SNS to send SMS messages, your -// Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a -// safe environment for you to try Amazon SNS features without risking your -// reputation as an SMS sender. While your 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 SMS sandbox. +// +// When you start using Amazon SNS to send SMS messages, your Amazon Web Services +// account is in the SMS sandbox. The SMS sandbox provides a safe environment for +// you to try Amazon SNS features without risking your reputation as an SMS sender. +// While your 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]in the Amazon SNS +// Developer Guide. +// +// [SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html 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 06f948c7485..52a9d313cc0 100644 --- a/service/sns/api_op_GetDataProtectionPolicy.go +++ b/service/sns/api_op_GetDataProtectionPolicy.go @@ -29,9 +29,12 @@ 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. + // The ARN of the topic whose DataProtectionPolicy you want to get. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/sns/api_op_GetEndpointAttributes.go b/service/sns/api_op_GetEndpointAttributes.go index 4e314d25fd9..f8f0a941177 100644 --- a/service/sns/api_op_GetEndpointAttributes.go +++ b/service/sns/api_op_GetEndpointAttributes.go @@ -12,8 +12,9 @@ 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]. +// +// [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,16 +45,20 @@ 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. + // 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 fc5d7ab9e86..7c36f3db20b 100644 --- a/service/sns/api_op_GetPlatformApplicationAttributes.go +++ b/service/sns/api_op_GetPlatformApplicationAttributes.go @@ -12,8 +12,9 @@ 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]. +// +// [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,22 +45,32 @@ 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. + // // - AuthenticationMethod – Returns the credential type used when sending push // notifications from application to APNS/APNS_Sandbox, or application to GCM. + // // - APNS – Returns the token or certificate. + // // - GCM – Returns the token or key. + // // - 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. diff --git a/service/sns/api_op_GetSMSAttributes.go b/service/sns/api_op_GetSMSAttributes.go index 8befb6dda3e..7ce36c94894 100644 --- a/service/sns/api_op_GetSMSAttributes.go +++ b/service/sns/api_op_GetSMSAttributes.go @@ -11,7 +11,9 @@ import ( ) // Returns the settings for sending SMS messages from your Amazon Web Services -// account. These settings are set with the SetSMSAttributes action. +// account. +// +// These settings are set with the SetSMSAttributes action. func (c *Client) GetSMSAttributes(ctx context.Context, params *GetSMSAttributesInput, optFns ...func(*Options)) (*GetSMSAttributesOutput, error) { if params == nil { params = &GetSMSAttributesInput{} @@ -31,8 +33,13 @@ func (c *Client) GetSMSAttributes(ctx context.Context, params *GetSMSAttributesI 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. + // you want values. + // + // For all attribute names, see [SetSMSAttributes]. + // + // If you don't use this parameter, Amazon SNS returns all SMS attributes. + // + // [SetSMSAttributes]: https://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html Attributes []string noSmithyDocumentSerde diff --git a/service/sns/api_op_GetSMSSandboxAccountStatus.go b/service/sns/api_op_GetSMSSandboxAccountStatus.go index 4139d36b156..861e04c555e 100644 --- a/service/sns/api_op_GetSMSSandboxAccountStatus.go +++ b/service/sns/api_op_GetSMSSandboxAccountStatus.go @@ -11,15 +11,18 @@ import ( ) // Retrieves the SMS sandbox status for the calling Amazon Web Services account in -// the target Amazon Web Services Region. When you start using Amazon SNS to send -// SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS -// sandbox provides a safe environment for you to try Amazon SNS features without -// risking your reputation as an SMS sender. While your 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 target Amazon Web Services Region. +// +// When you start using Amazon SNS to send SMS messages, your Amazon Web Services +// account is in the SMS sandbox. The SMS sandbox provides a safe environment for +// you to try Amazon SNS features without risking your reputation as an SMS sender. +// While your 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]in the Amazon SNS +// Developer Guide. +// +// [SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html 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 e4bbe31373c..05a9dc7d4c8 100644 --- a/service/sns/api_op_GetSubscriptionAttributes.go +++ b/service/sns/api_op_GetSubscriptionAttributes.go @@ -42,44 +42,64 @@ 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. + // For more information, see [Amazon SNS Message Filtering]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. + // + // - 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]in the Amazon SNS + // Developer Guide. + // + // [Fanout to Kinesis Data Firehose delivery streams]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html + // [Amazon SNS Message Filtering]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html 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 8975612ed54..be94e53f705 100644 --- a/service/sns/api_op_GetTopicAttributes.go +++ b/service/sns/api_op_GetTopicAttributes.go @@ -42,54 +42,77 @@ type GetTopicAttributesInput struct { 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. + // 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) - // : + // + // The following attribute applies only to [server-side-encryption]: + // // - 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) - // : + // key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key Terms]. For + // more examples, see [KeyId]in the Key Management Service API Reference. + // + // The following attributes apply only to [FIFO topics]: + // // - 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. + // MessageDeduplicationId parameter for the [Publish]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. + // 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. + // + // [Key Terms]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms + // [KeyId]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters + // [server-side-encryption]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html + // [Publish]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html + // [FIFO topics]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html 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 c3d195397f4..2dbf2a32e0d 100644 --- a/service/sns/api_op_ListEndpointsByPlatformApplication.go +++ b/service/sns/api_op_ListEndpointsByPlatformApplication.go @@ -18,9 +18,11 @@ import ( // 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). +// to return, NextToken will be null. For more information, see [Using Amazon SNS Mobile Push Notifications]. +// +// This action is throttled at 30 transactions per second (TPS). +// +// [Using Amazon SNS Mobile Push Notifications]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html 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 7537f275b99..2525a26be55 100644 --- a/service/sns/api_op_ListOriginationNumbers.go +++ b/service/sns/api_op_ListOriginationNumbers.go @@ -12,9 +12,10 @@ 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) -// in the Amazon SNS Developer Guide. +// and their metadata. For more information about origination numbers, see [Origination numbers]in the +// Amazon SNS Developer Guide. +// +// [Origination numbers]: https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html func (c *Client) ListOriginationNumbers(ctx context.Context, params *ListOriginationNumbersInput, optFns ...func(*Options)) (*ListOriginationNumbersOutput, error) { if params == nil { params = &ListOriginationNumbersInput{} diff --git a/service/sns/api_op_ListPhoneNumbersOptedOut.go b/service/sns/api_op_ListPhoneNumbersOptedOut.go index 28d40fb2339..324315ccf64 100644 --- a/service/sns/api_op_ListPhoneNumbersOptedOut.go +++ b/service/sns/api_op_ListPhoneNumbersOptedOut.go @@ -11,12 +11,14 @@ import ( ) // Returns a list of phone numbers that are opted out, meaning you cannot send SMS -// messages to them. The results for ListPhoneNumbersOptedOut are paginated, and -// each page returns up to 100 phone numbers. If additional phone numbers are -// available after the first page of results, then a NextToken string will be -// returned. To receive the next page, you call ListPhoneNumbersOptedOut again -// using the NextToken string received from the previous call. When there are no -// more records to return, NextToken will be null. +// messages to them. +// +// The results for ListPhoneNumbersOptedOut are paginated, and each page returns +// up to 100 phone numbers. If additional phone numbers are available after the +// first page of results, then a NextToken string will be returned. To receive the +// next page, you call ListPhoneNumbersOptedOut again using the NextToken string +// received from the previous call. When there are no more records to return, +// NextToken will be null. func (c *Client) ListPhoneNumbersOptedOut(ctx context.Context, params *ListPhoneNumbersOptedOutInput, optFns ...func(*Options)) (*ListPhoneNumbersOptedOutOutput, error) { if params == nil { params = &ListPhoneNumbersOptedOutInput{} diff --git a/service/sns/api_op_ListPlatformApplications.go b/service/sns/api_op_ListPlatformApplications.go index 9f7f1678035..88abfd66719 100644 --- a/service/sns/api_op_ListPlatformApplications.go +++ b/service/sns/api_op_ListPlatformApplications.go @@ -18,9 +18,11 @@ import ( // 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) . +// will be null. For more information, see [Using Amazon SNS Mobile Push Notifications]. +// // This action is throttled at 15 transactions per second (TPS). +// +// [Using Amazon SNS Mobile Push Notifications]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html 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 a81574e0634..dbc5f2bbb36 100644 --- a/service/sns/api_op_ListSMSSandboxPhoneNumbers.go +++ b/service/sns/api_op_ListSMSSandboxPhoneNumbers.go @@ -12,15 +12,18 @@ import ( ) // Lists the calling Amazon Web Services account's current verified and pending -// destination phone numbers in the SMS sandbox. When you start using Amazon SNS to -// send SMS messages, your Amazon Web Services account is in the SMS sandbox. The -// SMS sandbox provides a safe environment for you to try Amazon SNS features -// without risking your reputation as an SMS sender. While your 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. +// destination phone numbers in the SMS sandbox. +// +// When you start using Amazon SNS to send SMS messages, your Amazon Web Services +// account is in the SMS sandbox. The SMS sandbox provides a safe environment for +// you to try Amazon SNS features without risking your reputation as an SMS sender. +// While your 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]in the Amazon SNS +// Developer Guide. +// +// [SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html 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 597a865c1f5..8c7a6a263eb 100644 --- a/service/sns/api_op_ListSubscriptions.go +++ b/service/sns/api_op_ListSubscriptions.go @@ -14,8 +14,9 @@ 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 -// (TPS). +// 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 { params = &ListSubscriptionsInput{} diff --git a/service/sns/api_op_ListSubscriptionsByTopic.go b/service/sns/api_op_ListSubscriptionsByTopic.go index 2288eb1b155..5e62195f42f 100644 --- a/service/sns/api_op_ListSubscriptionsByTopic.go +++ b/service/sns/api_op_ListSubscriptionsByTopic.go @@ -14,8 +14,9 @@ import ( // Returns a list of the subscriptions to a specific topic. 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 -// ListSubscriptionsByTopic call to get further results. This action is throttled -// at 30 transactions per second (TPS). +// ListSubscriptionsByTopic call to get further results. +// +// This action is throttled at 30 transactions per second (TPS). func (c *Client) ListSubscriptionsByTopic(ctx context.Context, params *ListSubscriptionsByTopicInput, optFns ...func(*Options)) (*ListSubscriptionsByTopicOutput, error) { if params == nil { params = &ListSubscriptionsByTopicInput{} diff --git a/service/sns/api_op_ListTagsForResource.go b/service/sns/api_op_ListTagsForResource.go index 4282f1974a9..bd40f1bd071 100644 --- a/service/sns/api_op_ListTagsForResource.go +++ b/service/sns/api_op_ListTagsForResource.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List all tags added 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 Simple Notification Service Developer Guide. +// List all tags added to the specified Amazon SNS topic. For an overview, see [Amazon SNS Tags] in +// the Amazon Simple Notification Service Developer Guide. +// +// [Amazon SNS Tags]: https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/sns/api_op_ListTopics.go b/service/sns/api_op_ListTopics.go index b0409e872ee..4e12e9a394c 100644 --- a/service/sns/api_op_ListTopics.go +++ b/service/sns/api_op_ListTopics.go @@ -13,8 +13,9 @@ import ( // Returns a list of the requester's topics. Each call returns a limited list of // topics, up to 100. If there are more topics, a NextToken is also returned. Use -// the NextToken parameter in a new ListTopics call to get further results. This -// action is throttled at 30 transactions per second (TPS). +// the NextToken parameter in a new ListTopics call to get further results. +// +// This action is throttled at 30 transactions per second (TPS). func (c *Client) ListTopics(ctx context.Context, params *ListTopicsInput, optFns ...func(*Options)) (*ListTopicsOutput, error) { if params == nil { params = &ListTopicsInput{} diff --git a/service/sns/api_op_OptInPhoneNumber.go b/service/sns/api_op_OptInPhoneNumber.go index 1a63cdcfaff..9c1242e71e7 100644 --- a/service/sns/api_op_OptInPhoneNumber.go +++ b/service/sns/api_op_OptInPhoneNumber.go @@ -11,8 +11,9 @@ import ( ) // Use this request to opt in a phone number that is opted out, which enables you -// to resume sending SMS messages to the number. You can opt in a phone number only -// once every 30 days. +// to resume sending SMS messages to the number. +// +// You can opt in a phone number only once every 30 days. func (c *Client) OptInPhoneNumber(ctx context.Context, params *OptInPhoneNumberInput, optFns ...func(*Options)) (*OptInPhoneNumberOutput, error) { if params == nil { params = &OptInPhoneNumberInput{} diff --git a/service/sns/api_op_Publish.go b/service/sns/api_op_Publish.go index 1fb05196920..8250033f0b4 100644 --- a/service/sns/api_op_Publish.go +++ b/service/sns/api_op_Publish.go @@ -13,18 +13,26 @@ import ( // 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 +// 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]. +// +// You can publish messages only to topics and endpoints in the same Amazon Web // Services Region. +// +// [Send Custom Platform-Specific Payloads in Messages to Mobile Devices]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...func(*Options)) (*PublishOutput, error) { if params == nil { params = &PublishInput{} @@ -43,33 +51,51 @@ func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...fu // Input for Publish action. type PublishInput struct { - // The message you want to send. If you are publishing to a topic and you want to - // send the same message to all transport protocols, include the text of the - // 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: + // The message you want to send. + // + // If you are publishing to a topic and you want to send the same message to all + // transport protocols, include the text of the 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. + // 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). // @@ -81,55 +107,68 @@ 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 - // 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 - // based on the contents of the message. Your MessageDeduplicationId overrides the - // generated one. + // 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 based on the contents of the message. Your + // MessageDeduplicationId overrides the generated one. 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, - // messages in different message groups might be processed out of order). Every - // message must include a MessageGroupId . + // 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 . 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 + // 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. + // // If you don't specify a value for the PhoneNumber parameter, you must specify a // value for the TargetArn or TopicArn parameters. PhoneNumber *string // Optional parameter to be used as the "Subject" line when the message is // delivered to email endpoints. This field will also be included, if present, in - // the standard JSON messages delivered to other endpoints. Constraints: Subjects - // must be ASCII text that begins with a letter, number, or punctuation mark; must - // not include line breaks or control characters; and must be less than 100 - // characters long. + // the standard JSON messages delivered to other endpoints. + // + // Constraints: Subjects must be ASCII text that begins with a letter, number, or + // punctuation mark; must not include line breaks or control characters; and must + // be less than 100 characters long. Subject *string // If you don't specify a value for the TargetArn parameter, you must specify a // value for the PhoneNumber or TopicArn parameters. TargetArn *string - // The topic you want to publish to. If you don't specify a value for the TopicArn - // parameter, you must specify a value for the PhoneNumber or TargetArn parameters. + // The topic you want to publish to. + // + // If you don't specify a value for the TopicArn parameter, you must specify a + // value for the PhoneNumber or TargetArn parameters. TopicArn *string noSmithyDocumentSerde @@ -138,13 +177,15 @@ type PublishInput struct { // Response for Publish action. type PublishOutput struct { - // Unique identifier assigned to the published message. Length Constraint: Maximum - // 100 characters + // Unique identifier assigned to the published message. + // + // Length Constraint: Maximum 100 characters MessageId *string - // 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 + // 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 . SequenceNumber *string diff --git a/service/sns/api_op_PublishBatch.go b/service/sns/api_op_PublishBatch.go index a82c762f87b..8f6a5def263 100644 --- a/service/sns/api_op_PublishBatch.go +++ b/service/sns/api_op_PublishBatch.go @@ -14,20 +14,31 @@ 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 // 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 -// 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 -// 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 If you send a batch message to a topic, Amazon SNS -// publishes the batch message to each endpoint that is subscribed to the topic. -// The format of the batch message depends on the notification protocol for each -// subscribed endpoint. When a messageId is returned, the batch message is saved -// and Amazon SNS immediately delivers the message to subscribers. +// 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 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 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 +// +// If you send a batch message to a topic, Amazon SNS publishes the batch message +// to each endpoint that is subscribed to the topic. The format of the batch +// message depends on the notification protocol for each subscribed endpoint. +// +// When a messageId is returned, the batch message is saved and Amazon SNS +// immediately delivers the message to subscribers. func (c *Client) PublishBatch(ctx context.Context, params *PublishBatchInput, optFns ...func(*Options)) (*PublishBatchOutput, error) { if params == nil { params = &PublishBatchInput{} diff --git a/service/sns/api_op_PutDataProtectionPolicy.go b/service/sns/api_op_PutDataProtectionPolicy.go index 121d2e153e8..081fd2f7749 100644 --- a/service/sns/api_op_PutDataProtectionPolicy.go +++ b/service/sns/api_op_PutDataProtectionPolicy.go @@ -29,16 +29,21 @@ func (c *Client) PutDataProtectionPolicy(ctx context.Context, params *PutDataPro type PutDataProtectionPolicyInput struct { - // The JSON serialization of the topic's DataProtectionPolicy . The - // DataProtectionPolicy must be in JSON string format. Length Constraints: Maximum - // length of 30,720. + // The JSON serialization of the topic's DataProtectionPolicy . + // + // The DataProtectionPolicy must be in JSON string format. + // + // Length Constraints: Maximum length of 30,720. // // This member is required. 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. + // The ARN of the topic whose DataProtectionPolicy you want to add or update. + // + // For more information about ARNs, see [Amazon Resource Names (ARNs)] in the Amazon Web Services General + // Reference. + // + // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. ResourceArn *string diff --git a/service/sns/api_op_RemovePermission.go b/service/sns/api_op_RemovePermission.go index 9dd11af08e2..31dc2498450 100644 --- a/service/sns/api_op_RemovePermission.go +++ b/service/sns/api_op_RemovePermission.go @@ -10,9 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. 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 28319af14e2..d1221243ff7 100644 --- a/service/sns/api_op_SetEndpointAttributes.go +++ b/service/sns/api_op_SetEndpointAttributes.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -33,12 +34,15 @@ func (c *Client) SetEndpointAttributes(ctx context.Context, params *SetEndpointA 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. diff --git a/service/sns/api_op_SetPlatformApplicationAttributes.go b/service/sns/api_op_SetPlatformApplicationAttributes.go index 2cfe786a340..31e33bdcde7 100644 --- a/service/sns/api_op_SetPlatformApplicationAttributes.go +++ b/service/sns/api_op_SetPlatformApplicationAttributes.go @@ -12,10 +12,11 @@ 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]. For information on configuring attributes for message +// delivery status, see [Using Amazon SNS Application Attributes for Message Delivery Status]. +// +// [Using Amazon SNS Application Attributes for Message Delivery Status]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html +// [Using Amazon SNS Mobile Push Notifications]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html func (c *Client) SetPlatformApplicationAttributes(ctx context.Context, params *SetPlatformApplicationAttributesInput, optFns ...func(*Options)) (*SetPlatformApplicationAttributesOutput, error) { if params == nil { params = &SetPlatformApplicationAttributesInput{} @@ -36,14 +37,20 @@ 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, 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) using key credentials, there is no // PlatformPrincipal . The PlatformCredential is API key . + // // - For GCM (Firebase Cloud Messaging) using token credentials, there is no // PlatformPrincipal . The PlatformCredential is a JSON formatted private key // file. When using the Amazon Web Services CLI, the file must be in string format @@ -52,31 +59,44 @@ type SetPlatformApplicationAttributesInput struct { // service.json` . // // - 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. // diff --git a/service/sns/api_op_SetSMSAttributes.go b/service/sns/api_op_SetSMSAttributes.go index e9df65a641d..16ba8f277dd 100644 --- a/service/sns/api_op_SetSMSAttributes.go +++ b/service/sns/api_op_SetSMSAttributes.go @@ -11,13 +11,16 @@ import ( ) // Use this request to set the default settings for sending SMS messages and -// 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. +// 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]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. +// +// [Publishing to a mobile phone]: https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html func (c *Client) SetSMSAttributes(ctx context.Context, params *SetSMSAttributesInput, optFns ...func(*Options)) (*SetSMSAttributesOutput, error) { if params == nil { params = &SetSMSAttributesInput{} @@ -37,54 +40,80 @@ func (c *Client) SetSMSAttributes(ctx context.Context, params *SetSMSAttributesI type SetSMSAttributesInput struct { // The default settings for sending SMS messages from your Amazon Web Services - // account. You can set values for the following attribute names: MonthlySpendLimit - // – The maximum amount in USD that you are willing to spend each month to send SMS - // messages. When Amazon SNS determines that sending an SMS message would incur a - // cost that exceeds this limit, it stops sending SMS messages within minutes. - // Amazon SNS stops sending SMS messages within minutes of the limit being crossed. - // 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 - // 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 - // 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: + // account. You can set values for the following attribute names: + // + // MonthlySpendLimit – The maximum amount in USD that you are willing to spend + // each month to send SMS messages. When Amazon SNS determines that sending an SMS + // message would incur a cost that exceeds this limit, it stops sending SMS + // messages within minutes. + // + // Amazon SNS stops sending SMS messages within minutes of the limit being + // crossed. 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]. 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 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. + // + // For an example bucket policy and usage report, see [Monitoring SMS Activity] in the Amazon SNS Developer + // Guide. + // + // [Monitoring SMS Activity]: https://docs.aws.amazon.com/sns/latest/dg/sms_stats.html + // [SNS Limit Increase case]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns // // 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 3b35569104c..4353060811d 100644 --- a/service/sns/api_op_SetSubscriptionAttributes.go +++ b/service/sns/api_op_SetSubscriptionAttributes.go @@ -30,36 +30,51 @@ func (c *Client) SetSubscriptionAttributes(ctx context.Context, params *SetSubsc // Input for SetSubscriptionAttributes action. 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: + // 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. + // + // - 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]in the Amazon SNS + // Developer Guide. + // + // [Fanout to Kinesis Data Firehose delivery streams]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html // // This member is required. AttributeName *string diff --git a/service/sns/api_op_SetTopicAttributes.go b/service/sns/api_op_SetTopicAttributes.go index 96aca7256f5..89bf5da5519 100644 --- a/service/sns/api_op_SetTopicAttributes.go +++ b/service/sns/api_op_SetTopicAttributes.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// policy. +// 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 policy. func (c *Client) SetTopicAttributes(ctx context.Context, params *SetTopicAttributesInput, optFns ...func(*Options)) (*SetTopicAttributesOutput, error) { if params == nil { params = &SetTopicAttributesInput{} @@ -32,98 +33,138 @@ func (c *Client) SetTopicAttributes(ctx context.Context, params *SetTopicAttribu // Input for SetTopicAttributes action. 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: + // 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) - // . + // 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]. + // // - 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) - // : + // CloudWatch Logs. + // + // The following attribute applies only to [server-side-encryption]: + // // - 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. + // key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key Terms]. For + // more examples, see [KeyId]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) - // : + // + // The following attribute applies only to [FIFO topics]: + // // - 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. + // MessageDeduplicationId parameter for the [Publish]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. + // 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. + // + // [Using Amazon SNS Application Attributes for Message Delivery Status]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html + // [Key Terms]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms + // [KeyId]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters + // [server-side-encryption]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html + // [Publish]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html + // [FIFO topics]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html // // This member is required. AttributeName *string diff --git a/service/sns/api_op_Subscribe.go b/service/sns/api_op_Subscribe.go index 3c856c84fd1..d82e9455502 100644 --- a/service/sns/api_op_Subscribe.go +++ b/service/sns/api_op_Subscribe.go @@ -13,9 +13,12 @@ import ( // 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 two -// days. This action is throttled at 100 transactions per second (TPS). +// confirm the subscription. +// +// You call the ConfirmSubscription action with the token from the subscription +// response. Confirmation tokens are valid for two 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,15 +38,24 @@ 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. // @@ -55,77 +67,110 @@ type SubscribeInput struct { // This member is required. TopicArn *string - // 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: + // 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. - // The following attributes apply only to FIFO topics (https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html) - // : + // + // - 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]in the Amazon SNS + // Developer Guide. + // + // The following attributes apply only to [FIFO topics]: + // // - ReplayPolicy – Adds or updates an inline policy document for a subscription // to replay messages stored in the specified Amazon SNS topic. + // // - ReplayStatus – Retrieves the status of the subscription message replay, // which can be one of the following: + // // - Completed – The replay has successfully redelivered all messages, and is now // delivering newly published messages. If an ending point was specified in the // ReplayPolicy then the subscription will no longer receive newly published // messages. + // // - In progress – The replay is currently replaying the selected messages. + // // - Failed – The replay was unable to complete. + // // - Pending – The default state while the replay initiates. + // + // [Fanout to Kinesis Data Firehose delivery streams]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html + // [FIFO topics]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html Attributes map[string]string - // The endpoint that you want to receive notifications. Endpoints vary by - // protocol: + // 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. 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 - // 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 . + // 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 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 . ReturnSubscriptionArn bool noSmithyDocumentSerde diff --git a/service/sns/api_op_TagResource.go b/service/sns/api_op_TagResource.go index 3e2c15acba3..ddcca142e70 100644 --- a/service/sns/api_op_TagResource.go +++ b/service/sns/api_op_TagResource.go @@ -11,19 +11,27 @@ 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: +// Add tags to the specified Amazon SNS topic. For an overview, see [Amazon SNS Tags] 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) -// . +// file a [technical support request]. +// +// [Amazon SNS Tags]: https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html +// [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_Unsubscribe.go b/service/sns/api_op_Unsubscribe.go index 0181a2882ae..e05eab2fa86 100644 --- a/service/sns/api_op_Unsubscribe.go +++ b/service/sns/api_op_Unsubscribe.go @@ -16,10 +16,13 @@ import ( // Unsubscribe call does not require authentication and the requester is not the // subscription owner, a final cancellation message is delivered to the endpoint, // so that the endpoint owner can easily resubscribe to the topic if the -// Unsubscribe request was unintended. Amazon SQS queue subscriptions require -// authentication for deletion. Only the owner of the subscription, or the owner of -// the topic can unsubscribe using the required Amazon Web Services signature. This -// action is throttled at 100 transactions per second (TPS). +// Unsubscribe request was unintended. +// +// Amazon SQS queue subscriptions require authentication for deletion. Only the +// owner of the subscription, or the owner of the topic can unsubscribe using the +// required Amazon Web Services signature. +// +// This action is throttled at 100 transactions per second (TPS). func (c *Client) Unsubscribe(ctx context.Context, params *UnsubscribeInput, optFns ...func(*Options)) (*UnsubscribeOutput, error) { if params == nil { params = &UnsubscribeInput{} diff --git a/service/sns/api_op_UntagResource.go b/service/sns/api_op_UntagResource.go index 64f8a07f56e..e33d266699b 100644 --- a/service/sns/api_op_UntagResource.go +++ b/service/sns/api_op_UntagResource.go @@ -10,9 +10,10 @@ 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] in the +// Amazon SNS Developer Guide. +// +// [Amazon SNS Tags]: https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html 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 dd5efff494f..52453381ef3 100644 --- a/service/sns/api_op_VerifySMSSandboxPhoneNumber.go +++ b/service/sns/api_op_VerifySMSSandboxPhoneNumber.go @@ -11,15 +11,18 @@ import ( ) // Verifies a destination phone number with a one-time password (OTP) for the -// calling Amazon Web Services account. When you start using Amazon SNS to send SMS -// messages, your Amazon Web Services account is in the SMS sandbox. The SMS -// sandbox provides a safe environment for you to try Amazon SNS features without -// risking your reputation as an SMS sender. While your 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. +// calling Amazon Web Services account. +// +// When you start using Amazon SNS to send SMS messages, your Amazon Web Services +// account is in the SMS sandbox. The SMS sandbox provides a safe environment for +// you to try Amazon SNS features without risking your reputation as an SMS sender. +// While your 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]in the Amazon SNS +// Developer Guide. +// +// [SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html 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 387ca7c0018..7117a684506 100644 --- a/service/sns/doc.go +++ b/service/sns/doc.go @@ -3,19 +3,25 @@ // Package sns provides the API client, operations, and parameter types for Amazon // Simple Notification Service. // -// Amazon Simple Notification Service Amazon Simple Notification Service (Amazon -// SNS) is a web service that enables you to build distributed web-enabled -// 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) -// 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/) -// . +// # Amazon Simple Notification Service +// +// Amazon Simple Notification Service (Amazon SNS) is a web service that enables +// you to build distributed web-enabled 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]. For detailed information about Amazon SNS features and their associated +// API calls, see the [Amazon SNS Developer Guide]. +// +// For information on the permissions you need to use this API, see [Identity and access management in Amazon SNS] 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]. +// +// [Amazon SNS product page]: http://aws.amazon.com/sns/ +// [Identity and access management in Amazon SNS]: https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [Amazon SNS Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/ package sns diff --git a/service/sns/options.go b/service/sns/options.go index 164bc9fd80b..c4945e9ce40 100644 --- a/service/sns/options.go +++ b/service/sns/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sns/types/enums.go b/service/sns/types/enums.go index 45639544b4b..3217ed720b8 100644 --- a/service/sns/types/enums.go +++ b/service/sns/types/enums.go @@ -22,8 +22,9 @@ const ( ) // Values returns all known values for LanguageCodeString. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LanguageCodeString) Values() []LanguageCodeString { return []LanguageCodeString{ "en-US", @@ -52,8 +53,9 @@ const ( ) // Values returns all known values for NumberCapability. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NumberCapability) Values() []NumberCapability { return []NumberCapability{ "SMS", @@ -72,8 +74,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -92,8 +95,9 @@ const ( // Values returns all known values for SMSSandboxPhoneNumberVerificationStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SMSSandboxPhoneNumberVerificationStatus) Values() []SMSSandboxPhoneNumberVerificationStatus { return []SMSSandboxPhoneNumberVerificationStatus{ "Pending", diff --git a/service/sns/types/errors.go b/service/sns/types/errors.go index cadbd8dbfc4..c9cb05c7757 100644 --- a/service/sns/types/errors.go +++ b/service/sns/types/errors.go @@ -408,9 +408,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 Key states of Amazon Web -// Services KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) -// in the Key Management Service Developer Guide. +// valid for this request. For more information, see [Key states of Amazon Web Services KMS keys]in the Key Management Service +// Developer Guide. +// +// [Key states of Amazon Web Services KMS keys]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html type KMSInvalidStateException struct { Message *string @@ -490,8 +491,9 @@ 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) -// in the Key Management Service Developer Guide. +// throttling, see [Limits]in the Key Management Service Developer Guide. +// +// [Limits]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second type KMSThrottlingException struct { Message *string diff --git a/service/sns/types/types.go b/service/sns/types/types.go index 0e8c617897a..d7c5eb7dc20 100644 --- a/service/sns/types/types.go +++ b/service/sns/types/types.go @@ -45,19 +45,23 @@ 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 +// information, see [Publish]. +// +// 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. +// currently 256 KB (262,144 bytes). For more information, see [Amazon SNS message attributes]and [Publishing to a mobile phone] in the Amazon +// SNS Developer Guide. +// +// [Publishing to a mobile phone]: https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html +// [Amazon SNS message attributes]: https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html +// [Publish]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html 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]. + // + // [Message Attribute Data Types]: https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes // // This member is required. DataType *string @@ -66,9 +70,9 @@ type MessageAttributeValue struct { // encrypted data, or images. 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) - // . + // Strings are Unicode with UTF8 binary encoding. For a list of code values, see [ASCII Printable Characters]. + // + // [ASCII Printable Characters]: https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters StringValue *string noSmithyDocumentSerde @@ -114,10 +118,12 @@ type PlatformApplication struct { // identifies a message within the batch. type PublishBatchRequestEntry struct { - // An identifier for the message in this batch. The Ids of a batch request must be - // unique within a request. This identifier can have up to 80 characters. The - // following characters are accepted: alphanumeric characters, hyphens(-), and - // underscores (_). + // An identifier for the message in this batch. + // + // The Ids of a batch request must 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. Id *string @@ -128,64 +134,90 @@ type PublishBatchRequestEntry struct { 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. + // information, see [Amazon SNS message attributes]in the Amazon SNS Developer Guide. + // + // [Amazon SNS message attributes]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html MessageAttributes map[string]MessageAttributeValue - // This parameter applies only to FIFO (first-in-first-out) topics. The token used - // 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. + // This parameter applies only to FIFO (first-in-first-out) topics. + // + // The token used 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. + // // - 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 - // (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . + // 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 - // 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). To - // interleave multiple ordered streams within a single topic, use MessageGroupId + // This parameter applies only to FIFO (first-in-first-out) topics. + // + // The 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). + // To interleave multiple ordered streams within a single topic, use MessageGroupId // 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 - // 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. + // 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 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. 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 *string @@ -205,24 +237,29 @@ type PublishBatchResultEntry struct { // An identifier for the message. MessageId *string - // 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 . + // 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 . SequenceNumber *string noSmithyDocumentSerde } -// A verified or pending destination phone number in the SMS sandbox. When you -// start using Amazon SNS to send SMS messages, your Amazon Web Services account is -// in the SMS sandbox. The SMS sandbox provides a safe environment for you to try -// Amazon SNS features without risking your reputation as an SMS sender. While your -// 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 +// A verified or pending destination phone number in the SMS sandbox. +// +// When you start using Amazon SNS to send SMS messages, your Amazon Web Services +// account is in the SMS sandbox. The SMS sandbox provides a safe environment for +// you to try Amazon SNS features without risking your reputation as an SMS sender. +// While your 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]in the Amazon SNS +// Developer Guide. +// +// [SMS sandbox]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html type SMSSandboxPhoneNumber struct { // The destination phone number. diff --git a/service/sqs/api_op_AddPermission.go b/service/sqs/api_op_AddPermission.go index 52e7b957680..b06cc591afc 100644 --- a/service/sqs/api_op_AddPermission.go +++ b/service/sqs/api_op_AddPermission.go @@ -10,25 +10,32 @@ 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) -// 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. +// Adds a permission to a queue for a specific [principal]. 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]in the Amazon SQS Developer +// Guide. +// +// - AddPermission generates a policy for you. You can use SetQueueAttributesto upload your +// policy. For more information, see [Using Custom Policies with the Amazon SQS Access Policy Language]in the Amazon SQS Developer Guide. +// // - An Amazon SQS policy can have a maximum of seven actions per statement. +// // - To remove the ability to change queue permissions, you must deny permission // to the AddPermission , RemovePermission , and SetQueueAttributes actions in // your IAM policy. +// // - Amazon SQS AddPermission does not support adding a non-account principal. // -// Cross-account permissions don't apply to this action. For more information, see -// Grant cross-account permissions to a role and a username (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 don't apply to this action. For more information, see [Grant cross-account permissions to a role and a username] // in the Amazon SQS Developer Guide. +// +// [principal]: https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P +// [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 +// [Using Custom Policies with the Amazon SQS Access Policy Language]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) AddPermission(ctx context.Context, params *AddPermissionInput, optFns ...func(*Options)) (*AddPermissionOutput, error) { if params == nil { params = &AddPermissionInput{} @@ -46,22 +53,28 @@ 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) - // in the Amazon SQS Developer Guide. + // The Amazon Web Services account numbers of the [principals] who are to receive permission. + // For information about locating the Amazon Web Services account identification, + // see [Your Amazon Web Services Identifiers]in the Amazon SQS Developer Guide. + // + // [Your Amazon Web Services Identifiers]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication + // [principals]: https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P // // 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 - // 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 - // ChangeMessageVisibility for ActionName.n also grants permissions for the - // corresponding batch versions of those actions: SendMessageBatch , - // DeleteMessageBatch , and ChangeMessageVisibilityBatch . + // 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] 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 . + // + // [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 // // This member is required. Actions []string @@ -73,8 +86,9 @@ type AddPermissionInput struct { // This member is required. Label *string - // The URL of the Amazon SQS queue to which permissions are added. Queue URLs and - // names are case-sensitive. + // The URL of the Amazon SQS queue to which permissions are added. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_CancelMessageMoveTask.go b/service/sqs/api_op_CancelMessageMoveTask.go index 783b7a8f395..9093f1e4cda 100644 --- a/service/sqs/api_op_CancelMessageMoveTask.go +++ b/service/sqs/api_op_CancelMessageMoveTask.go @@ -14,14 +14,18 @@ import ( // cancelled when the current status is RUNNING. Cancelling a message movement task // does not revert the messages that have already been moved. It can only stop the // messages that have not been moved yet. -// - This action is currently limited to supporting message redrive from -// dead-letter queues (DLQs) (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) -// only. In this context, the source queue is the dead-letter queue (DLQ), while -// the destination queue can be the original source queue (from which the messages -// were driven to the dead-letter-queue), or a custom destination queue. +// +// - This action is currently limited to supporting message redrive from [dead-letter queues (DLQs)]only. +// In this context, the source queue is the dead-letter queue (DLQ), while the +// destination queue can be the original source queue (from which the messages were +// driven to the dead-letter-queue), or a custom destination queue. +// // - Currently, only standard queues are supported. +// // - Only one active message movement task is supported per queue at any given // time. +// +// [dead-letter queues (DLQs)]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html func (c *Client) CancelMessageMoveTask(ctx context.Context, params *CancelMessageMoveTaskInput, optFns ...func(*Options)) (*CancelMessageMoveTaskOutput, error) { if params == nil { params = &CancelMessageMoveTaskInput{} diff --git a/service/sqs/api_op_ChangeMessageVisibility.go b/service/sqs/api_op_ChangeMessageVisibility.go index d7339c67d00..af7d164e0dd 100644 --- a/service/sqs/api_op_ChangeMessageVisibility.go +++ b/service/sqs/api_op_ChangeMessageVisibility.go @@ -12,18 +12,23 @@ import ( // 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, if the default timeout for a -// queue is 60 seconds, 15 seconds have elapsed since you received the message, and -// you send a ChangeMessageVisibility call with VisibilityTimeout set to 10 -// seconds, the 10 seconds begin to count from the time that you make the -// ChangeMessageVisibility call. Thus, any attempt to change the visibility timeout -// or to delete that message 10 seconds after you initially change the visibility -// timeout (a total of 25 seconds) might result in an error. An Amazon SQS message -// has three basic states: +// is 0 seconds. The maximum is 12 hours. For more information, see [Visibility Timeout]in the Amazon +// SQS Developer Guide. +// +// For example, if the default timeout for a queue is 60 seconds, 15 seconds have +// elapsed since you received the message, and you send a ChangeMessageVisibility +// call with VisibilityTimeout set to 10 seconds, the 10 seconds begin to count +// from the time that you make the ChangeMessageVisibility call. Thus, any attempt +// to change the visibility timeout or to delete that message 10 seconds after you +// initially change the visibility timeout (a total of 25 seconds) might result in +// an error. +// +// 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. // // A message is considered to be stored after it is sent to a queue by a producer, @@ -31,26 +36,36 @@ import ( // 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 in flight messages. Limits that apply to in flight 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 in flight 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 in flight messages (received +// the number of in flight messages. +// +// Limits that apply to in flight 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 in flight 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 -// returns an error. Amazon SQS doesn't automatically recalculate and increase the -// timeout to the maximum remaining time. Unlike with a queue, when you change the -// visibility timeout for a specific message the timeout value is applied -// immediately but isn't saved in memory for that message. If you don't delete a -// message after it is received, the visibility timeout for the message reverts to -// the original timeout value (not to the value you set using the -// ChangeMessageVisibility action) the next time the message is received. +// 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]. +// +// For FIFO queues, there can be a maximum of 20,000 in flight 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 returns an error. Amazon SQS doesn't automatically +// recalculate and increase the timeout to the maximum remaining time. +// +// Unlike with a queue, when you change the visibility timeout for a specific +// message the timeout value is applied immediately but isn't saved in memory for +// that message. If you don't delete a message after it is received, the visibility +// timeout for the message reverts to the original timeout value (not to the value +// you set using the ChangeMessageVisibility action) the next time the message is +// received. +// +// [Visibility Timeout]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html +// [file a support request]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs func (c *Client) ChangeMessageVisibility(ctx context.Context, params *ChangeMessageVisibilityInput, optFns ...func(*Options)) (*ChangeMessageVisibilityOutput, error) { if params == nil { params = &ChangeMessageVisibilityInput{} @@ -68,14 +83,15 @@ func (c *Client) ChangeMessageVisibility(ctx context.Context, params *ChangeMess type ChangeMessageVisibilityInput struct { - // The URL of the Amazon SQS queue whose message's visibility is changed. Queue - // URLs and names are case-sensitive. + // The URL of the Amazon SQS queue whose message's visibility is changed. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string // The receipt handle associated with the message, whose visibility timeout is - // changed. This parameter is returned by the ReceiveMessage action. + // changed. This parameter is returned by the ReceiveMessageaction. // // This member is required. ReceiptHandle *string diff --git a/service/sqs/api_op_ChangeMessageVisibilityBatch.go b/service/sqs/api_op_ChangeMessageVisibilityBatch.go index ac359caf156..968ba4c5a05 100644 --- a/service/sqs/api_op_ChangeMessageVisibilityBatch.go +++ b/service/sqs/api_op_ChangeMessageVisibilityBatch.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Changes the visibility timeout of multiple messages. This is a batch version of -// 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 . +// Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility +// . The result of the action on each message is reported individually in the +// response. You can send up to 10 ChangeMessageVisibilityrequests 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 . func (c *Client) ChangeMessageVisibilityBatch(ctx context.Context, params *ChangeMessageVisibilityBatchInput, optFns ...func(*Options)) (*ChangeMessageVisibilityBatchOutput, error) { if params == nil { params = &ChangeMessageVisibilityBatchInput{} @@ -41,8 +42,9 @@ type ChangeMessageVisibilityBatchInput struct { // This member is required. Entries []types.ChangeMessageVisibilityBatchRequestEntry - // The URL of the Amazon SQS queue whose messages' visibility is changed. Queue - // URLs and names are case-sensitive. + // The URL of the Amazon SQS queue whose messages' visibility is changed. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string @@ -50,9 +52,8 @@ type ChangeMessageVisibilityBatchInput struct { noSmithyDocumentSerde } -// For each message in the batch, the response contains a -// ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a -// BatchResultErrorEntry tag if the message fails. +// For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message +// succeeds or a BatchResultErrorEntrytag if the message fails. type ChangeMessageVisibilityBatchOutput struct { // A list of BatchResultErrorEntry items. diff --git a/service/sqs/api_op_CreateQueue.go b/service/sqs/api_op_CreateQueue.go index 35e691ff5b3..9043fca954b 100644 --- a/service/sqs/api_op_CreateQueue.go +++ b/service/sqs/api_op_CreateQueue.go @@ -12,33 +12,46 @@ import ( // 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. +// 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]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) -// 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: +// to the [limits related to queues]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. // -// Cross-account permissions don't apply to this action. For more information, see -// Grant cross-account permissions to a role and a username (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 don't apply to this action. For more information, see [Grant cross-account permissions to a role and a username] // in the Amazon SQS Developer Guide. +// +// [limits related to queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name +// +// [Moving From a Standard Queue to a FIFO Queue]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error) { if params == nil { params = &CreateQueueInput{} @@ -57,23 +70,31 @@ 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. + // // Queue URLs and names are case-sensitive. // // This member is required. QueueName *string - // 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: + // 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). When you change a @@ -83,129 +104,181 @@ type CreateQueueInput struct { // existing messages in the queue potentially causing them to be expired and // deleted if the MessageRetentionPeriod is reduced below the age of existing // messages. + // // - 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 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. + // information about policy structure, see [Overview of Amazon Web Services IAM Policies]in the 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. + // // - 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 dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // information about the visibility timeout, see [Visibility Timeout]in the Amazon SQS Developer + // Guide. + // + // The following attributes apply only to [dead-letter queues:] + // // - RedrivePolicy – The string that includes the parameters for the dead-letter // queue functionality of the source queue as a JSON object. The parameters are as // follows: + // // - 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. Default: 10. When the // ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS // moves the message to the dead-letter-queue. + // // - RedriveAllowPolicy – The string that includes the parameters for the // permissions for the dead-letter queue redrive permission and which source queues // can specify dead-letter queues as a JSON object. The parameters are as follows: + // // - redrivePermission – The permission type that defines which source queues can // specify the current queue as the dead-letter queue. Valid values are: + // // - allowAll – (Default) Any source queues in this Amazon Web Services account // in the same Region can specify this queue as the dead-letter queue. + // // - denyAll – No source queues can specify this queue as the dead-letter queue. + // // - byQueue – Only queues specified by the sourceQueueArns parameter can specify // this queue as the dead-letter queue. + // // - sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that // can specify this queue as the dead-letter queue and redrive messages. You can // specify this parameter only when the redrivePermission parameter is set to // byQueue . You can specify up to 10 source queue ARNs. To allow more than 10 // source queues to specify dead-letter queues, set the redrivePermission // parameter to allowAll . + // // 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. The - // following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) - // : + // dead-letter queue of a standard queue must also be a standard queue. + // + // The following attributes apply only to [server-side-encryption]: + // // - 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. + // key (CMK) for Amazon SQS or a custom CMK. For more information, see [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]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) + // Amazon SQS can reuse a [data key]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?] + // // - SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned // encryption keys. Only one server-side encryption option is supported per queue - // (for example, 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) - // : + // (for example, [SSE-KMS]or [SSE-SQS]). + // + // The following attributes apply only to [FIFO (first-in-first-out) queues]: + // // - 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. + // provide the MessageGroupId for your messages explicitly. + // + // For more information, see [FIFO queue logic]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: + // values are true and false . For more information, see [Exactly-once processing]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) - // : + // + // The following attributes apply only to [high throughput for FIFO queues]: + // // - 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. + // occurs as specified. + // + // For information on throughput quotas, see [Quotas related to messages] in the Amazon SQS Developer Guide. + // + // [SSE-KMS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html + // [data key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys + // [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 + // [SSE-SQS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html + // [high throughput for FIFO queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html + // [Overview of Amazon Web Services IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html + // [dead-letter queues:]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html + // [Exactly-once processing]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html + // [KeyId]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters + // [Quotas related to messages]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html + // [Visibility Timeout]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html + // [Key Terms]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms + // [server-side-encryption]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html + // [FIFO queue logic]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html + // [FIFO (first-in-first-out) queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html 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) - // in the Amazon SQS Developer Guide. When you use queue tags, keep the following - // guidelines in mind: + // see [Tagging Your Amazon SQS Queues]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) - // 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 username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) + // + // For a full list of tag restrictions, see [Quotas related to 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 username] // in the Amazon SQS Developer Guide. + // + // [Tagging Your Amazon SQS Queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html + // [Quotas related to queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues + // [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name Tags map[string]string noSmithyDocumentSerde diff --git a/service/sqs/api_op_DeleteMessage.go b/service/sqs/api_op_DeleteMessage.go index 2e3011be79d..8d9175a5541 100644 --- a/service/sqs/api_op_DeleteMessage.go +++ b/service/sqs/api_op_DeleteMessage.go @@ -15,18 +15,20 @@ import ( // 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 -// the retention period configured for the queue. The ReceiptHandle is associated -// with a specific instance of receiving a message. If you receive a message more -// than once, the ReceiptHandle is different each time you receive a message. When -// you use the DeleteMessage action, you must provide the most recently received -// ReceiptHandle for the message (otherwise, the request succeeds, but the message -// will not be deleted). For standard queues, it is possible to receive a message -// even after you delete it. This might happen on rare occasions if one of the -// servers which stores a copy of the message is unavailable when you send the -// request to delete the message. The copy remains on the server and might be -// returned to you during a subsequent receive request. You should ensure that your -// application is idempotent, so that receiving a message more than once does not -// cause issues. +// the retention period configured for the queue. +// +// The ReceiptHandle is associated with a specific instance of receiving a +// message. If you receive a message more than once, the ReceiptHandle is +// different each time you receive a message. When you use the DeleteMessage +// action, you must provide the most recently received ReceiptHandle for the +// message (otherwise, the request succeeds, but the message will not be deleted). +// +// For standard queues, it is possible to receive a message even after you delete +// it. This might happen on rare occasions if one of the servers which stores a +// copy of the message is unavailable when you send the request to delete the +// message. The copy remains on the server and might be returned to you during a +// subsequent receive request. You should ensure that your application is +// idempotent, so that receiving a message more than once does not cause issues. func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, optFns ...func(*Options)) (*DeleteMessageOutput, error) { if params == nil { params = &DeleteMessageInput{} @@ -44,8 +46,9 @@ func (c *Client) DeleteMessage(ctx context.Context, params *DeleteMessageInput, type DeleteMessageInput struct { - // The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and - // names are case-sensitive. + // The URL of the Amazon SQS queue from which messages are deleted. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_DeleteMessageBatch.go b/service/sqs/api_op_DeleteMessageBatch.go index 36834805d0a..00821de6cb9 100644 --- a/service/sqs/api_op_DeleteMessageBatch.go +++ b/service/sqs/api_op_DeleteMessageBatch.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . func (c *Client) DeleteMessageBatch(ctx context.Context, params *DeleteMessageBatchInput, optFns ...func(*Options)) (*DeleteMessageBatchOutput, error) { if params == nil { params = &DeleteMessageBatchInput{} @@ -38,8 +40,9 @@ type DeleteMessageBatchInput struct { // This member is required. Entries []types.DeleteMessageBatchRequestEntry - // The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and - // names are case-sensitive. + // The URL of the Amazon SQS queue from which messages are deleted. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string @@ -47,9 +50,8 @@ type DeleteMessageBatchInput struct { noSmithyDocumentSerde } -// For each message in the batch, the response contains a -// DeleteMessageBatchResultEntry tag if the message is deleted or a -// BatchResultErrorEntry tag if the message can't be deleted. +// For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is +// deleted or a BatchResultErrorEntrytag if the message can't be deleted. type DeleteMessageBatchOutput struct { // A list of BatchResultErrorEntry items. diff --git a/service/sqs/api_op_DeleteQueue.go b/service/sqs/api_op_DeleteQueue.go index 2fa662b83f0..32e3cb1006d 100644 --- a/service/sqs/api_op_DeleteQueue.go +++ b/service/sqs/api_op_DeleteQueue.go @@ -10,17 +10,25 @@ 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 username (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. The delete operation uses the HTTP GET verb. +// 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 SendMessagerequest 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 username] +// in the Amazon SQS Developer Guide. +// +// The delete operation uses the HTTP GET verb. +// +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optFns ...func(*Options)) (*DeleteQueueOutput, error) { if params == nil { params = &DeleteQueueInput{} @@ -38,8 +46,9 @@ func (c *Client) DeleteQueue(ctx context.Context, params *DeleteQueueInput, optF type DeleteQueueInput struct { - // The URL of the Amazon SQS queue to delete. Queue URLs and names are - // case-sensitive. + // The URL of the Amazon SQS queue to delete. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_GetQueueAttributes.go b/service/sqs/api_op_GetQueueAttributes.go index 6f90d7352f5..c89466629fd 100644 --- a/service/sqs/api_op_GetQueueAttributes.go +++ b/service/sqs/api_op_GetQueueAttributes.go @@ -11,8 +11,12 @@ 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], you can check whether QueueName ends with the +// .fifo suffix. +// +// [FIFO]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html func (c *Client) GetQueueAttributes(ctx context.Context, params *GetQueueAttributesInput, optFns ...func(*Options)) (*GetQueueAttributesOutput, error) { if params == nil { params = &GetQueueAttributesInput{} @@ -30,40 +34,55 @@ func (c *Client) GetQueueAttributes(ctx context.Context, params *GetQueueAttribu type GetQueueAttributesInput struct { - // The URL of the Amazon SQS queue whose attribute information is retrieved. Queue - // URLs and names are case-sensitive. + // The URL of the Amazon SQS queue whose attribute information is retrieved. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string - // A list of attributes for which to retrieve information. The AttributeNames - // parameter is optional, but if you don't specify values for this parameter, the - // 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 ApproximateNumberOfMessages 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. + // A list of attributes for which to retrieve information. + // + // The AttributeNames parameter is optional, but if you don't specify values for + // this parameter, the 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 ApproximateNumberOfMessages 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) ). + // + // - CreatedTimestamp – Returns the time when the queue was created in seconds ([epoch 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) ). + // seconds ([epoch 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. When you change a queue's attributes, the change // can take up to 60 seconds for most of the attributes to propagate throughout the @@ -71,83 +90,119 @@ type GetQueueAttributesInput struct { // take up to 15 minutes and will impact existing messages in the queue potentially // causing them to be expired and deleted if the MessageRetentionPeriod is // reduced below the age of existing messages. + // // - 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. + // // - 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 dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // information about the visibility timeout, see [Visibility Timeout]in the Amazon SQS Developer + // Guide. + // + // The following attributes apply only to [dead-letter queues:] + // // - RedrivePolicy – The string that includes the parameters for the dead-letter // queue functionality of the source queue as a JSON object. The parameters are as // follows: + // // - 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. Default: 10. When the // ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS // moves the message to the dead-letter-queue. + // // - RedriveAllowPolicy – The string that includes the parameters for the // permissions for the dead-letter queue redrive permission and which source queues // can specify dead-letter queues as a JSON object. The parameters are as follows: + // // - redrivePermission – The permission type that defines which source queues can // specify the current queue as the dead-letter queue. Valid values are: + // // - allowAll – (Default) Any source queues in this Amazon Web Services account // in the same Region can specify this queue as the dead-letter queue. + // // - denyAll – No source queues can specify this queue as the dead-letter queue. + // // - byQueue – Only queues specified by the sourceQueueArns parameter can specify // this queue as the dead-letter queue. + // // - sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that // can specify this queue as the dead-letter queue and redrive messages. You can // specify this parameter only when the redrivePermission parameter is set to // byQueue . You can specify up to 10 source queue ARNs. To allow more than 10 // source queues to specify dead-letter queues, set the redrivePermission // parameter to allowAll . + // // 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. The - // following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) - // : + // dead-letter queue of a standard queue must also be a standard queue. + // + // The following attributes apply only to [server-side-encryption]: + // // - 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) - // . + // master key (CMK) for Amazon SQS or a custom CMK. For more information, see [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) - // . + // calling KMS again. For more information, see [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 (for example, 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) - // : + // encryption option is supported per queue (for example, [SSE-KMS]or [SSE-SQS]). + // + // The following attributes apply only to [FIFO (first-in-first-out) queues]: + // // - 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. + // information, see [FIFO queue logic]in the Amazon SQS Developer Guide. + // + // To determine whether a queue is [FIFO], 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) - // : + // enabled for the queue. For more information, see [Exactly-once processing]in the Amazon SQS Developer + // Guide. + // + // The following attributes apply only to [high throughput for FIFO queues]: + // // - 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. + // occurs as specified. + // + // For information on throughput quotas, see [Quotas related to messages] in the Amazon SQS Developer Guide. + // + // [SSE-KMS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html + // [epoch time]: http://en.wikipedia.org/wiki/Unix_time + // [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 + // [SSE-SQS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html + // [high throughput for FIFO queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html + // [dead-letter queues:]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html + // [Exactly-once processing]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html + // [FIFO]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html + // [Quotas related to messages]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html + // [Visibility Timeout]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html + // [Key Terms]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms + // [server-side-encryption]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html + // [FIFO queue logic]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html + // [FIFO (first-in-first-out) queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html AttributeNames []types.QueueAttributeName noSmithyDocumentSerde diff --git a/service/sqs/api_op_GetQueueUrl.go b/service/sqs/api_op_GetQueueUrl.go index 5e89c73b062..e2151d3d6f9 100644 --- a/service/sqs/api_op_GetQueueUrl.go +++ b/service/sqs/api_op_GetQueueUrl.go @@ -10,12 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns the URL of an existing Amazon SQS queue. To access a queue that belongs -// 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) -// in the Amazon SQS Developer Guide. +// Returns the URL of an existing Amazon SQS queue. +// +// To access a queue that belongs 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 AddPermissionor see [Allow Developers to Write Messages to a Shared Queue] in the Amazon SQS Developer +// Guide. +// +// [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 func (c *Client) GetQueueUrl(ctx context.Context, params *GetQueueUrlInput, optFns ...func(*Options)) (*GetQueueUrlOutput, error) { if params == nil { params = &GetQueueUrlInput{} @@ -34,8 +37,9 @@ 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 @@ -46,8 +50,9 @@ type GetQueueUrlInput struct { noSmithyDocumentSerde } -// For more information, see Interpreting Responses (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html) -// in the Amazon SQS Developer Guide. +// For more information, see [Interpreting Responses] in the Amazon SQS Developer Guide. +// +// [Interpreting Responses]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html type GetQueueUrlOutput struct { // The URL of the queue. diff --git a/service/sqs/api_op_ListDeadLetterSourceQueues.go b/service/sqs/api_op_ListDeadLetterSourceQueues.go index c877ac29dc5..e90edca438f 100644 --- a/service/sqs/api_op_ListDeadLetterSourceQueues.go +++ b/service/sqs/api_op_ListDeadLetterSourceQueues.go @@ -11,16 +11,20 @@ import ( ) // Returns a list of your queues that have the RedrivePolicy queue attribute -// 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 and there are additional results to display, the response includes a -// 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) -// in the Amazon SQS Developer Guide. +// 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 and there are additional +// results to display, the response includes a 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] in the Amazon SQS +// Developer Guide. +// +// [Using Amazon SQS Dead-Letter Queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html func (c *Client) ListDeadLetterSourceQueues(ctx context.Context, params *ListDeadLetterSourceQueuesInput, optFns ...func(*Options)) (*ListDeadLetterSourceQueuesOutput, error) { if params == nil { params = &ListDeadLetterSourceQueuesInput{} @@ -38,7 +42,9 @@ func (c *Client) ListDeadLetterSourceQueues(ctx context.Context, params *ListDea type ListDeadLetterSourceQueuesInput struct { - // The URL of a dead-letter queue. Queue URLs and names are case-sensitive. + // The URL of a dead-letter queue. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_ListMessageMoveTasks.go b/service/sqs/api_op_ListMessageMoveTasks.go index 6187d4070a3..ed689ef13d1 100644 --- a/service/sqs/api_op_ListMessageMoveTasks.go +++ b/service/sqs/api_op_ListMessageMoveTasks.go @@ -13,14 +13,18 @@ import ( // Gets the most recent message movement tasks (up to 10) under a specific source // queue. -// - This action is currently limited to supporting message redrive from -// dead-letter queues (DLQs) (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) -// only. In this context, the source queue is the dead-letter queue (DLQ), while -// the destination queue can be the original source queue (from which the messages -// were driven to the dead-letter-queue), or a custom destination queue. +// +// - This action is currently limited to supporting message redrive from [dead-letter queues (DLQs)]only. +// In this context, the source queue is the dead-letter queue (DLQ), while the +// destination queue can be the original source queue (from which the messages were +// driven to the dead-letter-queue), or a custom destination queue. +// // - Currently, only standard queues are supported. +// // - Only one active message movement task is supported per queue at any given // time. +// +// [dead-letter queues (DLQs)]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html func (c *Client) ListMessageMoveTasks(ctx context.Context, params *ListMessageMoveTasksInput, optFns ...func(*Options)) (*ListMessageMoveTasksOutput, error) { if params == nil { params = &ListMessageMoveTasksInput{} diff --git a/service/sqs/api_op_ListQueueTags.go b/service/sqs/api_op_ListQueueTags.go index 226fb297dd4..aaaa51a7326 100644 --- a/service/sqs/api_op_ListQueueTags.go +++ b/service/sqs/api_op_ListQueueTags.go @@ -11,11 +11,13 @@ 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) -// 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 username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// overview, see [Tagging Your Amazon SQS 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 username] // in the Amazon SQS Developer Guide. +// +// [Tagging Your Amazon SQS Queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) ListQueueTags(ctx context.Context, params *ListQueueTagsInput, optFns ...func(*Options)) (*ListQueueTagsOutput, error) { if params == nil { params = &ListQueueTagsInput{} diff --git a/service/sqs/api_op_ListQueues.go b/service/sqs/api_op_ListQueues.go index 5f580999a2e..8ad852a2bc3 100644 --- a/service/sqs/api_op_ListQueues.go +++ b/service/sqs/api_op_ListQueues.go @@ -13,15 +13,19 @@ import ( // Returns a list of your queues in the current region. The response includes a // maximum of 1,000 results. If you specify a value for the optional // 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 username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// 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 username] // in the Amazon SQS Developer Guide. +// +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) ListQueues(ctx context.Context, params *ListQueuesInput, optFns ...func(*Options)) (*ListQueuesOutput, error) { if params == nil { params = &ListQueuesInput{} @@ -47,8 +51,9 @@ type ListQueuesInput struct { NextToken *string // A string to use for filtering the list results. Only those queues whose name - // begins with the specified string are returned. Queue URLs and names are - // case-sensitive. + // begins with the specified string are returned. + // + // Queue URLs and names are case-sensitive. QueueNamePrefix *string noSmithyDocumentSerde diff --git a/service/sqs/api_op_PurgeQueue.go b/service/sqs/api_op_PurgeQueue.go index aafbf945604..cce93f42c40 100644 --- a/service/sqs/api_op_PurgeQueue.go +++ b/service/sqs/api_op_PurgeQueue.go @@ -11,12 +11,19 @@ import ( ) // Deletes available messages in a queue (including in-flight messages) 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. +// 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. func (c *Client) PurgeQueue(ctx context.Context, params *PurgeQueueInput, optFns ...func(*Options)) (*PurgeQueueOutput, error) { if params == nil { params = &PurgeQueueInput{} @@ -34,8 +41,9 @@ func (c *Client) PurgeQueue(ctx context.Context, params *PurgeQueueInput, optFns type PurgeQueueInput struct { - // The URL of the queue from which the PurgeQueue action deletes messages. Queue - // URLs and names are case-sensitive. + // The URL of the queue from which the PurgeQueue action deletes messages. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_ReceiveMessage.go b/service/sqs/api_op_ReceiveMessage.go index 6c27d6a7c18..c0f04d29fbf 100644 --- a/service/sqs/api_op_ReceiveMessage.go +++ b/service/sqs/api_op_ReceiveMessage.go @@ -12,37 +12,53 @@ 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) -// 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 -// ReceiveMessage response. If this happens, repeat the request. For each message -// returned, the response includes the following: +// WaitTimeSeconds parameter enables long-poll support. For more information, see [Amazon SQS Long Polling] +// 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 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) -// . +// +// - An MD5 digest of the message body. For information about MD5, see [RFC1321]. +// // - 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) -// 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) -// 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 -// be sent to the dead-letter queue. 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. +// message. For more information, see [Queue and Message Identifiers]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]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 be sent to the dead-letter +// queue. +// +// 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. +// +// [Queue and Message Identifiers]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html +// [Visibility Timeout]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html +// [Amazon SQS Long Polling]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html +// [RFC1321]: https://www.ietf.org/rfc/rfc1321.txt func (c *Client) ReceiveMessage(ctx context.Context, params *ReceiveMessageInput, optFns ...func(*Options)) (*ReceiveMessageOutput, error) { if params == nil { params = &ReceiveMessageInput{} @@ -60,38 +76,51 @@ 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). + // received from the queue ([epoch 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 a user, returns the 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). + // + // - SentTimestamp – Returns the time the message was sent to the queue ([epoch time] in + // milliseconds). + // // - SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned // encryption keys. Only one server-side encryption option is supported per queue - // (for example, 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) - // ). + // (for example, [SSE-KMS]or [SSE-SQS]). + // // - 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. + // calls the SendMessageaction. + // + // - 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. + // + // [SSE-KMS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html + // [epoch time]: http://en.wikipedia.org/wiki/Unix_time + // [SSE-SQS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html AttributeNames []types.QueueAttributeName // The maximum number of messages to return. Amazon SQS never returns more @@ -100,61 +129,82 @@ type ReceiveMessageInput struct { 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.* . MessageAttributeNames []string - // This parameter applies only to FIFO (first-in-first-out) queues. The token used - // for deduplication of ReceiveMessage calls. If a networking issue occurs after a - // ReceiveMessage action, and instead of a response you receive a generic error, it - // 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. + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The token used for deduplication of ReceiveMessage calls. If a networking issue + // occurs after a ReceiveMessage action, and instead of a response you receive a + // generic error, it 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. + // timeout. For more information, see [Visibility Timeout]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. + // and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ). + // + // For best practices of using ReceiveRequestAttemptId , see [Using the ReceiveRequestAttemptId Request Parameter] in the Amazon SQS + // Developer Guide. + // + // [Using the ReceiveRequestAttemptId Request Parameter]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html + // [Visibility Timeout]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html ReceiveRequestAttemptId *string // The duration (in seconds) that the received messages are hidden from subsequent @@ -164,12 +214,15 @@ 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, - // 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) - // for synchronous clients. + // 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]for asynchronous + // clients, or the [ApacheHttpClient]for synchronous clients. + // + // [NettyNioAsyncHttpClient]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html + // [ApacheHttpClient]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html WaitTimeSeconds int32 noSmithyDocumentSerde diff --git a/service/sqs/api_op_RemovePermission.go b/service/sqs/api_op_RemovePermission.go index 8bf0fe6a7ef..b8d55c2dd29 100644 --- a/service/sqs/api_op_RemovePermission.go +++ b/service/sqs/api_op_RemovePermission.go @@ -12,13 +12,17 @@ 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 username (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. +// see [Grant cross-account permissions to a role and a username]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. +// +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error) { if params == nil { params = &RemovePermissionInput{} @@ -37,13 +41,14 @@ func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionI type RemovePermissionInput struct { // The identification of the permission to remove. This is the label added using - // the AddPermission action. + // the AddPermissionaction. // // This member is required. Label *string - // The URL of the Amazon SQS queue from which permissions are removed. Queue URLs - // and names are case-sensitive. + // The URL of the Amazon SQS queue from which permissions are removed. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_SendMessage.go b/service/sqs/api_op_SendMessage.go index 4dffc5017d4..63742e0e423 100644 --- a/service/sqs/api_op_SendMessage.go +++ b/service/sqs/api_op_SendMessage.go @@ -11,11 +11,17 @@ 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]. +// +// [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{} @@ -34,96 +40,132 @@ func (c *Client) SendMessage(ctx context.Context, params *SendMessageInput, optF type SendMessageInput struct { // The message to send. The minimum size is one character. The maximum size is 256 - // KiB. 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) - // . + // KiB. + // + // 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]. + // + // [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 - // The length of time, in seconds, for which to delay a specific message. Valid + // The length of time, in seconds, for which to delay a specific message. Valid // 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 - // only on a queue level. + // 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 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) - // in the Amazon SQS Developer Guide. + // information, see [Amazon SQS message attributes]in the Amazon SQS Developer Guide. + // + // [Amazon SQS message attributes]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes MessageAttributes map[string]types.MessageAttributeValue - // This parameter applies only to FIFO (first-in-first-out) queues. The token used - // 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) - // in the Amazon SQS Developer Guide. + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The token used 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]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) - // in the Amazon SQS Developer Guide. + // 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] in the Amazon SQS + // Developer Guide. + // + // [Using the MessageDeduplicationId Property]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html + // [Exactly-once processing]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html MessageDeduplicationId *string - // This parameter applies only to FIFO (first-in-first-out) queues. The 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). To - // interleave multiple ordered streams within a single queue, use MessageGroupId + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The 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). + // To interleave multiple ordered streams within a single queue, use MessageGroupId // 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) - // in the Amazon SQS Developer Guide. MessageGroupId is required for FIFO queues. - // You can't use it for Standard queues. + // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . + // + // For best practices of using MessageGroupId , see [Using the MessageGroupId Property] in the Amazon SQS Developer + // Guide. + // + // MessageGroupId is required for FIFO queues. You can't use it for Standard + // queues. + // + // [Using the MessageGroupId Property]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html 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. MessageSystemAttributes map[string]types.MessageSystemAttributeValue @@ -137,13 +179,17 @@ 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]. + // + // [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]. + // + // [RFC1321]: https://www.ietf.org/rfc/rfc1321.txt MD5OfMessageBody *string // An MD5 digest of the non-URL-encoded message system attribute string. You can @@ -152,14 +198,17 @@ type SendMessageOutput struct { 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) - // in the Amazon SQS Developer Guide. + // more information, see [Queue and Message Identifiers]in the Amazon SQS Developer Guide. + // + // [Queue and Message Identifiers]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html 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 . + // 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 . 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 3323bfe0911..6cd3311910c 100644 --- a/service/sqs/api_op_SendMessageBatch.go +++ b/service/sqs/api_op_SendMessageBatch.go @@ -13,20 +13,30 @@ import ( // You can use SendMessageBatch to send up to 10 messages to the specified queue // by assigning either identical or different values to each message (or by not -// assigning values at all). This is a batch version of 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 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 KiB (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 +// assigning values at all). This is a batch version of 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 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 +// KiB (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]. +// +// If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses // the default value for the queue. +// +// [W3C specification for characters]: http://www.w3.org/TR/REC-xml/#charsets func (c *Client) SendMessageBatch(ctx context.Context, params *SendMessageBatchInput, optFns ...func(*Options)) (*SendMessageBatchOutput, error) { if params == nil { params = &SendMessageBatchInput{} @@ -49,8 +59,9 @@ type SendMessageBatchInput struct { // This member is required. Entries []types.SendMessageBatchRequestEntry - // The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs - // and names are case-sensitive. + // The URL of the Amazon SQS queue to which batched messages are sent. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string @@ -58,13 +69,11 @@ type SendMessageBatchInput struct { noSmithyDocumentSerde } -// For each message in the batch, the response contains a -// SendMessageBatchResultEntry tag if the message succeeds or a -// BatchResultErrorEntry tag if the message fails. +// For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message +// succeeds or a BatchResultErrorEntrytag 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 7700ca729ec..4b0740733a4 100644 --- a/service/sqs/api_op_SetQueueAttributes.go +++ b/service/sqs/api_op_SetQueueAttributes.go @@ -17,15 +17,19 @@ import ( // existing messages in the queue potentially causing them to be expired and // deleted if the MessageRetentionPeriod is reduced below the age of existing // messages. +// // - 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 username (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. +// see [Grant cross-account permissions to a role and a username]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. +// +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) SetQueueAttributes(ctx context.Context, params *SetQueueAttributesInput, optFns ...func(*Options)) (*SetQueueAttributesOutput, error) { if params == nil { params = &SetQueueAttributesInput{} @@ -43,15 +47,19 @@ func (c *Client) SetQueueAttributes(ctx context.Context, params *SetQueueAttribu 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: + // 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). When you change a @@ -61,111 +69,151 @@ type SetQueueAttributesInput struct { // existing messages in the queue potentially causing them to be expired and // deleted if the MessageRetentionPeriod is reduced below the age of existing // messages. + // // - 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. + // information about policy structure, see [Overview of Amazon Web Services IAM Policies]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. + // // - 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 dead-letter queues: (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) + // information about the visibility timeout, see [Visibility Timeout]in the Amazon SQS Developer + // Guide. + // + // The following attributes apply only to [dead-letter queues:] + // // - RedrivePolicy – The string that includes the parameters for the dead-letter // queue functionality of the source queue as a JSON object. The parameters are as // follows: + // // - 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. Default: 10. When the // ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS // moves the message to the dead-letter-queue. + // // - RedriveAllowPolicy – The string that includes the parameters for the // permissions for the dead-letter queue redrive permission and which source queues // can specify dead-letter queues as a JSON object. The parameters are as follows: + // // - redrivePermission – The permission type that defines which source queues can // specify the current queue as the dead-letter queue. Valid values are: + // // - allowAll – (Default) Any source queues in this Amazon Web Services account // in the same Region can specify this queue as the dead-letter queue. + // // - denyAll – No source queues can specify this queue as the dead-letter queue. + // // - byQueue – Only queues specified by the sourceQueueArns parameter can specify // this queue as the dead-letter queue. + // // - sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that // can specify this queue as the dead-letter queue and redrive messages. You can // specify this parameter only when the redrivePermission parameter is set to // byQueue . You can specify up to 10 source queue ARNs. To allow more than 10 // source queues to specify dead-letter queues, set the redrivePermission // parameter to allowAll . + // // 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. The - // following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) - // : + // dead-letter queue of a standard queue must also be a standard queue. + // + // The following attributes apply only to [server-side-encryption]: + // // - 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. + // key (CMK) for Amazon SQS or a custom CMK. For more information, see [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]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) - // . + // Amazon SQS can reuse a [data key]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?]. + // // - SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned // encryption keys. Only one server-side encryption option is supported per queue - // (for example, 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) - // : + // (for example, [SSE-KMS]or [SSE-SQS]). + // + // The following attribute applies only to [FIFO (first-in-first-out) queues]: + // // - 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: + // information, see [Exactly-once processing]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) - // : + // + // The following attributes apply only to [high throughput for FIFO queues]: + // // - 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. + // occurs as specified. + // + // For information on throughput quotas, see [Quotas related to messages] in the Amazon SQS Developer Guide. + // + // [SSE-KMS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html + // [data key]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys + // [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 + // [SSE-SQS]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html + // [high throughput for FIFO queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html + // [Overview of Amazon Web Services IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html + // [dead-letter queues:]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html + // [Exactly-once processing]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html + // [KeyId]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters + // [Quotas related to messages]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html + // [Visibility Timeout]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html + // [Key Terms]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms + // [server-side-encryption]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html + // [FIFO (first-in-first-out) queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html // // This member is required. Attributes map[string]string - // The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names - // are case-sensitive. + // The URL of the Amazon SQS queue whose attributes are set. + // + // Queue URLs and names are case-sensitive. // // This member is required. QueueUrl *string diff --git a/service/sqs/api_op_StartMessageMoveTask.go b/service/sqs/api_op_StartMessageMoveTask.go index 9acd845740a..c279d24e730 100644 --- a/service/sqs/api_op_StartMessageMoveTask.go +++ b/service/sqs/api_op_StartMessageMoveTask.go @@ -12,18 +12,24 @@ import ( // Starts an asynchronous task to move messages from a specified source queue to a // specified destination queue. +// // - This action is currently limited to supporting message redrive from queues -// that are configured as dead-letter queues (DLQs) (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) -// of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, -// such as Lambda or Amazon SNS topics, are currently not supported. +// that are configured as [dead-letter queues (DLQs)]of other Amazon SQS queues only. Non-SQS queue sources +// of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not +// supported. +// // - In dead-letter queues redrive context, the StartMessageMoveTask the source // queue is the DLQ, while the destination queue can be the original source queue // (from which the messages were driven to the dead-letter-queue), or a custom // destination queue. +// // - Currently, only standard queues support redrive. FIFO queues don't support // redrive. +// // - Only one active message movement task is supported per queue at any given // time. +// +// [dead-letter queues (DLQs)]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html func (c *Client) StartMessageMoveTask(ctx context.Context, params *StartMessageMoveTaskInput, optFns ...func(*Options)) (*StartMessageMoveTaskOutput, error) { if params == nil { params = &StartMessageMoveTaskInput{} diff --git a/service/sqs/api_op_TagQueue.go b/service/sqs/api_op_TagQueue.go index 3f07bf4b07c..351a0a1992c 100644 --- a/service/sqs/api_op_TagQueue.go +++ b/service/sqs/api_op_TagQueue.go @@ -11,21 +11,28 @@ import ( ) // 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: +// see [Tagging Your Amazon SQS Queues]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) -// 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 username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// For a full list of tag restrictions, see [Quotas related to 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 username] // in the Amazon SQS Developer Guide. +// +// [Tagging Your Amazon SQS Queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html +// [Quotas related to queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) TagQueue(ctx context.Context, params *TagQueueInput, optFns ...func(*Options)) (*TagQueueOutput, error) { if params == nil { params = &TagQueueInput{} diff --git a/service/sqs/api_op_UntagQueue.go b/service/sqs/api_op_UntagQueue.go index 563d8ac898d..71f6f9fc1f1 100644 --- a/service/sqs/api_op_UntagQueue.go +++ b/service/sqs/api_op_UntagQueue.go @@ -11,11 +11,13 @@ 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) -// 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 username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) +// overview, see [Tagging Your Amazon SQS 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 username] // in the Amazon SQS Developer Guide. +// +// [Tagging Your Amazon SQS Queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html +// [Grant cross-account permissions to a role and a username]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name func (c *Client) UntagQueue(ctx context.Context, params *UntagQueueInput, optFns ...func(*Options)) (*UntagQueueOutput, error) { if params == nil { params = &UntagQueueInput{} diff --git a/service/sqs/doc.go b/service/sqs/doc.go index e3bfe76da32..a6517de380a 100644 --- a/service/sqs/doc.go +++ b/service/sqs/doc.go @@ -3,25 +3,48 @@ // Package sqs provides the API client, operations, and parameter types for Amazon // Simple Queue Service. // -// Welcome to the Amazon SQS API Reference. Amazon SQS is a reliable, -// 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: +// Welcome to the Amazon SQS API Reference. +// +// Amazon SQS is a reliable, 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] in the Amazon +// SQS Developer Guide. +// +// You can use [Amazon Web Services SDKs] 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/) +// # Additional information +// +// [Amazon SQS Product Page] +// // - 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) +// +// [Making API Requests] +// +// [Amazon SQS Message Attributes] +// +// [Amazon SQS Dead-Letter Queues] +// +// [Amazon SQS in the Command Line Interface] +// // - Amazon Web Services General Reference -// - Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region) +// +// [Regions and Endpoints] +// +// [Identity and access management]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html +// [Amazon SQS Product Page]: http://aws.amazon.com/sqs/ +// [Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region +// [Amazon SQS Dead-Letter Queues]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html +// [Amazon Web Services SDKs]: http://aws.amazon.com/tools/#sdk +// [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 in the Command Line Interface]: http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html package sqs diff --git a/service/sqs/options.go b/service/sqs/options.go index ce3b7c08a4f..69d7573fdba 100644 --- a/service/sqs/options.go +++ b/service/sqs/options.go @@ -54,8 +54,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sqs/types/enums.go b/service/sqs/types/enums.go index dbdc81c1e2e..9982d1e56bc 100644 --- a/service/sqs/types/enums.go +++ b/service/sqs/types/enums.go @@ -19,6 +19,7 @@ const ( // Values returns all known values for MessageSystemAttributeName. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MessageSystemAttributeName) Values() []MessageSystemAttributeName { return []MessageSystemAttributeName{ @@ -43,8 +44,9 @@ const ( // Values returns all known values for MessageSystemAttributeNameForSends. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MessageSystemAttributeNameForSends) Values() []MessageSystemAttributeNameForSends { return []MessageSystemAttributeNameForSends{ "AWSTraceHeader", @@ -80,8 +82,9 @@ const ( ) // Values returns all known values for QueueAttributeName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueueAttributeName) Values() []QueueAttributeName { return []QueueAttributeName{ "All", diff --git a/service/sqs/types/errors.go b/service/sqs/types/errors.go index 436fae9cd0f..7bbe0e5a878 100644 --- a/service/sqs/types/errors.go +++ b/service/sqs/types/errors.go @@ -320,7 +320,9 @@ func (e *KmsDisabled) ErrorCode() string { func (e *KmsDisabled) 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). type KmsInvalidKeyUsage struct { @@ -646,10 +648,13 @@ func (e *ReceiptHandleIsInvalid) ErrorCode() string { func (e *ReceiptHandleIsInvalid) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The request was denied due to request throttling. +// // - The rate of requests per second exceeds the Amazon Web Services KMS request // quota for an account and Region. +// // - A burst or sustained high rate of requests to change the state of the same // KMS key. This condition is often known as a "hot key." +// // - Requests for operations on KMS keys in a Amazon Web Services CloudHSM key // store might be throttled at a lower-than-expected rate when the Amazon Web // Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key diff --git a/service/sqs/types/types.go b/service/sqs/types/types.go index 7bda19bc050..6aa87d5d0c1 100644 --- a/service/sqs/types/types.go +++ b/service/sqs/types/types.go @@ -31,14 +31,15 @@ type BatchResultErrorEntry struct { noSmithyDocumentSerde } -// Encloses a receipt handle and an entry ID for each message in -// ChangeMessageVisibilityBatch . +// Encloses a receipt handle and an entry ID for each message in ChangeMessageVisibilityBatch. type ChangeMessageVisibilityBatchRequestEntry struct { - // 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 (_). + // 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. Id *string @@ -54,7 +55,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. @@ -69,9 +70,12 @@ type ChangeMessageVisibilityBatchResultEntry struct { type DeleteMessageBatchRequestEntry struct { // The identifier for this particular receipt handle. This is 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 (_). + // 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. Id *string @@ -84,7 +88,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. @@ -140,18 +144,27 @@ type ListMessageMoveTasksResultEntry struct { // An Amazon SQS message. type Message struct { - // A map of the attributes requested in ReceiveMessage to their respective values. - // Supported attributes: + // 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. + // integer representing the [epoch time]in milliseconds. + // + // [epoch time]: http://en.wikipedia.org/wiki/Unix_time Attributes map[string]string // The message's contents (not URL-encoded). @@ -163,12 +176,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]. + // + // [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) - // in the Amazon SQS Developer Guide. + // information, see [Amazon SQS message attributes]in the Amazon SQS Developer Guide. + // + // [Amazon SQS message attributes]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes MessageAttributes map[string]MessageAttributeValue // A unique identifier for the message. A MessageId is considered unique across all @@ -185,16 +201,20 @@ 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 KiB 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 KiB 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) - // in the Amazon SQS Developer Guide. + // Binary . For the Number data type, you must use StringValue . + // + // You can also append custom labels. For more information, see [Amazon SQS Message Attributes] in the Amazon SQS + // Developer Guide. + // + // [Amazon SQS Message Attributes]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes // // This member is required. DataType *string @@ -209,9 +229,9 @@ type MessageAttributeValue struct { // Not implemented. Reserved for future use. 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) - // . + // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see [ASCII Printable Characters]. + // + // [ASCII Printable Characters]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters StringValue *string noSmithyDocumentSerde @@ -219,14 +239,18 @@ 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) - // in the Amazon SQS Developer Guide. + // Binary . For the Number data type, you must use StringValue . + // + // You can also append custom labels. For more information, see [Amazon SQS Message Attributes] in the Amazon SQS + // Developer Guide. + // + // [Amazon SQS Message Attributes]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes // // This member is required. DataType *string @@ -241,9 +265,9 @@ type MessageSystemAttributeValue struct { // Not implemented. Reserved for future use. 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) - // . + // Strings are Unicode with UTF-8 binary encoding. For a list of code values, see [ASCII Printable Characters]. + // + // [ASCII Printable Characters]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters StringValue *string noSmithyDocumentSerde @@ -252,10 +276,12 @@ type MessageSystemAttributeValue struct { // 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 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 (_). + // 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 (_). // // This member is required. Id *string @@ -268,78 +294,107 @@ type SendMessageBatchRequestEntry struct { // The length of time, in seconds, for which a specific message is delayed. Valid // 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 - // only on a queue level. + // 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 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) - // in the Amazon SQS Developer Guide. + // information, see [Amazon SQS message attributes]in the Amazon SQS Developer Guide. + // + // [Amazon SQS message attributes]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes MessageAttributes map[string]MessageAttributeValue - // This parameter applies only to FIFO (first-in-first-out) queues. The token used - // 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) - // in the Amazon SQS Developer Guide. + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The token used 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]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) - // in the Amazon SQS Developer Guide. + // 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] in the Amazon SQS + // Developer Guide. + // + // [Using the MessageDeduplicationId Property]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html + // [Exactly-once processing]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html MessageDeduplicationId *string - // This parameter applies only to FIFO (first-in-first-out) queues. The 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). To - // interleave multiple ordered streams within a single queue, use MessageGroupId + // This parameter applies only to FIFO (first-in-first-out) queues. + // + // The 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). + // To interleave multiple ordered streams within a single queue, use MessageGroupId // 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) - // in the Amazon SQS Developer Guide. MessageGroupId is required for FIFO queues. - // You can't use it for Standard queues. + // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) . + // + // For best practices of using MessageGroupId , see [Using the MessageGroupId Property] in the Amazon SQS Developer + // Guide. + // + // MessageGroupId is required for FIFO queues. You can't use it for Standard + // queues. + // + // [Using the MessageGroupId Property]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html 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. MessageSystemAttributes map[string]MessageSystemAttributeValue @@ -347,7 +402,7 @@ type SendMessageBatchRequestEntry struct { 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. @@ -358,7 +413,9 @@ 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]. + // + // [RFC1321]: https://www.ietf.org/rfc/rfc1321.txt // // This member is required. MD5OfMessageBody *string @@ -371,19 +428,25 @@ 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]. + // + // [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]. + // + // [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 . + // 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 . SequenceNumber *string noSmithyDocumentSerde diff --git a/service/ssm/api_op_AddTagsToResource.go b/service/ssm/api_op_AddTagsToResource.go index b9359d505b0..3736335d997 100644 --- a/service/ssm/api_op_AddTagsToResource.go +++ b/service/ssm/api_op_AddTagsToResource.go @@ -19,22 +19,32 @@ 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 // // 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 Tag your Amazon EC2 -// resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) -// in the Amazon EC2 User Guide. +// 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 [Tag your Amazon EC2 resources]in the Amazon EC2 User Guide. +// +// [Tag your Amazon EC2 resources]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error) { if params == nil { params = &AddTagsToResourceInput{} @@ -52,34 +62,47 @@ 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-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 + // The resource ID you want to tag. + // + // Use the ID of the resource. Here are some 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 . + // // For the Document and Parameter values, use the name of the resource. If you're // tagging a shared document, you must use the full ARN of the document. - // 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 - // 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 . + // 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 . // // This member is required. ResourceType types.ResourceTypeForTagging - // One or more tags. The value parameter is required. Don't enter personally - // identifiable information in this field. + // One or more tags. The value parameter is required. + // + // Don't enter personally identifiable information in this field. // // This member is required. Tags []types.Tag diff --git a/service/ssm/api_op_AssociateOpsItemRelatedItem.go b/service/ssm/api_op_AssociateOpsItemRelatedItem.go index f35a5a6e362..b317755068d 100644 --- a/service/ssm/api_op_AssociateOpsItemRelatedItem.go +++ b/service/ssm/api_op_AssociateOpsItemRelatedItem.go @@ -44,8 +44,11 @@ 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 diff --git a/service/ssm/api_op_CreateActivation.go b/service/ssm/api_op_CreateActivation.go index bce2357a773..792e57b085b 100644 --- a/service/ssm/api_op_CreateActivation.go +++ b/service/ssm/api_op_CreateActivation.go @@ -18,11 +18,14 @@ import ( // it possible to manage them using Systems Manager capabilities. You use the // 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 and multicloud 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. +// machines using Systems Manager, see [Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments]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. +// +// [Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html func (c *Client) CreateActivation(ctx context.Context, params *CreateActivationInput, optFns ...func(*Options)) (*CreateActivationOutput, error) { if params == nil { params = &CreateActivationInput{} @@ -43,22 +46,28 @@ 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 and - // multicloud 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. + // . For more information, see [Create an IAM service role for a hybrid and multicloud environment]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. + // + // [Create an IAM service role for a hybrid and multicloud environment]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html // // This member is required. IamRole *string // The name of the registered, managed node as it will appear in the Amazon Web // Services Systems Manager console or when you use the Amazon Web Services command - // line tools to list Systems Manager resources. Don't enter personally - // identifiable information in this field. + // line tools to list Systems Manager resources. + // + // Don't enter personally identifiable information in this field. DefaultInstanceName *string // A user-defined description of the resource that you want to register with - // Systems Manager. Don't enter personally identifiable information in this field. + // Systems Manager. + // + // Don't enter personally identifiable information in this field. Description *string // The date by which this activation request should expire, in timestamp format, @@ -79,18 +88,23 @@ type CreateActivationInput struct { // 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 . + // 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 7bd236d2796..f4128785f10 100644 --- a/service/ssm/api_op_CreateAssociation.go +++ b/service/ssm/api_op_CreateAssociation.go @@ -41,15 +41,24 @@ func (c *Client) CreateAssociation(ctx context.Context, params *CreateAssociatio type CreateAssociationInput struct { // The name of the SSM Command document or Automation runbook that contains the - // configuration information for the managed node. You can specify Amazon Web - // Services-predefined documents, documents you created, or a document that is - // shared with you from another Amazon Web Services account. For Systems Manager - // documents (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:partition: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, + // configuration information for the managed node. + // + // You can specify Amazon Web Services-predefined documents, documents you + // created, or a document that is shared with you from another Amazon Web Services + // account. + // + // For Systems Manager documents (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:partition: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 . // // This member is required. @@ -76,54 +85,63 @@ 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) - // . + // change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar]. + // + // [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 to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity // The document version you want to associate with the targets. 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 . + // 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 . DocumentVersion *string // The number of hours the association can run before it is canceled. Duration // applies to associations that are currently running, and any pending and in // progress commands on all targets. If a target was taken offline for the // association to run, it is made available again immediately, without a reboot. + // // The Duration parameter applies only when both these conditions are true: + // // - The association for which you specify a duration is cancelable according to // the parameters of the SSM command document or Automation runbook associated with // this execution. - // - The command specifies the ApplyOnlyAtCronInterval (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval) - // parameter, which means that the association doesn't run immediately after it is - // created, but only according to the specified schedule. + // + // - The command specifies the [ApplyOnlyAtCronInterval]parameter, which means that the association + // doesn't run immediately after it is created, but only according to the specified + // schedule. + // + // [ApplyOnlyAtCronInterval]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociation.html#systemsmanager-CreateAssociation-request-ApplyOnlyAtCronInterval Duration *int32 - // 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. + // 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 *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 - // managed node will process its association within the limit specified for - // MaxConcurrency . + // 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 managed node will process its + // association within the limit specified for MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -133,11 +151,12 @@ type CreateAssociationInput struct { // 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. + // 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 @@ -154,21 +173,26 @@ type CreateAssociationInput struct { // 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) - // 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. + // associations, see [Reference: Cron and rate expressions for Systems Manager]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. + // + // [Reference: Cron and rate expressions for Systems Manager]: https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html ScheduleOffset *int32 // 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 + // 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. + // managed by your direct call to the PutComplianceItemsAPI 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 @@ -191,9 +215,10 @@ type CreateAssociationInput struct { // 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 About - // targets and rate controls in 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. + // . For more information about choosing targets for an association, see [About targets and rate controls in State Manager associations]in the + // Amazon Web Services Systems Manager User Guide. + // + // [About targets and rate controls in State Manager associations]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html Targets []types.Target noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateAssociationBatch.go b/service/ssm/api_op_CreateAssociationBatch.go index 0b698b18ca3..6c166fbb7e7 100644 --- a/service/ssm/api_op_CreateAssociationBatch.go +++ b/service/ssm/api_op_CreateAssociationBatch.go @@ -12,12 +12,14 @@ import ( ) // Associates the specified Amazon Web Services Systems Manager document (SSM -// document) with the specified managed nodes or targets. When you associate a -// document with one or more managed nodes using IDs or tags, Amazon Web Services -// Systems Manager Agent (SSM Agent) running on the managed node processes the -// document and configures the node as specified. If you associate a document with -// a managed node that already has an associated document, the system returns the -// AssociationAlreadyExists exception. +// document) with the specified managed nodes or targets. +// +// When you associate a document with one or more managed nodes using IDs or tags, +// Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed +// node processes the document and configures the node as specified. +// +// If you associate a document with a managed node that already has an associated +// document, the system returns the AssociationAlreadyExists exception. func (c *Client) CreateAssociationBatch(ctx context.Context, params *CreateAssociationBatchInput, optFns ...func(*Options)) (*CreateAssociationBatchOutput, error) { if params == nil { params = &CreateAssociationBatchInput{} diff --git a/service/ssm/api_op_CreateDocument.go b/service/ssm/api_op_CreateDocument.go index 52b4fe48e86..76d9b3b1fa8 100644 --- a/service/ssm/api_op_CreateDocument.go +++ b/service/ssm/api_op_CreateDocument.go @@ -14,8 +14,10 @@ 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) -// in the Amazon Web Services Systems Manager User Guide. +// schemas, features, and syntax, see [Amazon Web Services Systems Manager Documents]in the Amazon Web Services Systems Manager +// User Guide. +// +// [Amazon Web Services Systems Manager Documents]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html func (c *Client) CreateDocument(ctx context.Context, params *CreateDocumentInput, optFns ...func(*Options)) (*CreateDocumentOutput, error) { if params == nil { params = &CreateDocumentInput{} @@ -37,23 +39,38 @@ type CreateDocumentInput struct { // document must not exceed 64KB. This quota also includes the content specified // for input parameters at runtime. We recommend storing the contents for your new // 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 (console) (https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-console) - // - Create an SSM document (command line) (https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-cli) - // - Create an SSM document (API) (https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-api) + // + // [Create an SSM document (console)] + // + // [Create an SSM document (command line)] + // + // [Create an SSM document (API)] + // + // [Create an SSM document (console)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-console + // [Create an SSM document (command line)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-cli + // [Create an SSM document (API)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-using.html#create-ssm-document-api // // This member is required. Content *string - // 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: + // 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 + // // - AWSEC2 + // // - AWSConfigRemediation + // // - AWSSupport // // This member is required. @@ -64,15 +81,17 @@ type CreateDocumentInput 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. You can update this - // value at a later time using the UpdateDocument operation. + // value at a later time using the UpdateDocumentoperation. DisplayName *string // Specify the document format for the request. The document format can be JSON, // YAML, or TEXT. JSON is the default format. DocumentFormat types.DocumentFormat - // The type of document to create. The DeploymentStrategy document type is an - // internal-use-only document type reserved for AppConfig. + // The type of document to create. + // + // The DeploymentStrategy document type is an internal-use-only document type + // reserved for AppConfig. DocumentType types.DocumentType // A list of SSM documents required by a document. This parameter is used @@ -80,8 +99,9 @@ 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) - // in the AppConfig User Guide. + // information, see [What is AppConfig?]in the AppConfig User Guide. + // + // [What is AppConfig?]: https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html Requires []types.DocumentRequires // Optional metadata that you assign to a resource. Tags enable you to categorize @@ -89,8 +109,11 @@ type CreateDocumentInput struct { // 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. Tags []types.Tag @@ -98,9 +121,10 @@ type CreateDocumentInput struct { // 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 // 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) - // in the CloudFormation User Guide. + // resources. For a list of valid resource types, see [Amazon Web Services resource and property types reference]in the CloudFormation User + // Guide. + // + // [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html TargetType *string // An optional field specifying the version of the artifact you are creating with diff --git a/service/ssm/api_op_CreateMaintenanceWindow.go b/service/ssm/api_op_CreateMaintenanceWindow.go index 35d92c6f155..c020351fbf7 100644 --- a/service/ssm/api_op_CreateMaintenanceWindow.go +++ b/service/ssm/api_op_CreateMaintenanceWindow.go @@ -11,13 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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. +// 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 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) CreateMaintenanceWindow(ctx context.Context, params *CreateMaintenanceWindowInput, optFns ...func(*Options)) (*CreateMaintenanceWindowOutput, error) { if params == nil { params = &CreateMaintenanceWindowInput{} @@ -38,9 +39,10 @@ type CreateMaintenanceWindowInput struct { // Enables a maintenance window task to run on managed nodes, even if you haven't // registered those nodes as targets. If enabled, then you must specify the // unregistered managed nodes (by node ID) when you register a task with the - // maintenance window. If you don't enable this option, then you must specify - // previously-registered targets when you register a task with the maintenance - // window. + // maintenance window. + // + // If you don't enable this option, then you must specify previously-registered + // targets when you register a task with the maintenance window. // // This member is required. AllowUnassociatedTargets bool @@ -79,23 +81,31 @@ type CreateMaintenanceWindowInput struct { 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 , - // the maintenance window won't run until two days later. + // 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 , the maintenance window won't run until two days + // later. ScheduleOffset *int32 // The time zone that the scheduled maintenance window executions are based 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. + // "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database]on + // the IANA website. + // + // [Time Zone Database]: https://www.iana.org/time-zones 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. When using a rate - // schedule, if you provide a start date that occurs in the past, the current date - // and time are used as the start date. + // of the maintenance window until the specified future date. + // + // When using a rate schedule, if you provide a start date that occurs in the + // past, the current date and time are used as the start date. StartDate *string // Optional metadata that you assign to a resource. Tags enable you to categorize @@ -103,11 +113,14 @@ type CreateMaintenanceWindowInput struct { // 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. + // + // 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 0e14797ffef..d060f169373 100644 --- a/service/ssm/api_op_CreateOpsItem.go +++ b/service/ssm/api_op_CreateOpsItem.go @@ -13,14 +13,16 @@ import ( ) // Creates a new OpsItem. You must have permission in Identity and Access -// Management (IAM) to create a new OpsItem. For more information, see Set up -// OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.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. +// Management (IAM) to create a new OpsItem. For more information, see [Set up OpsCenter]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]in the Amazon Web Services Systems Manager User Guide. +// +// [Amazon Web Services Systems Manager OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html +// [Set up OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html func (c *Client) CreateOpsItem(ctx context.Context, params *CreateOpsItemInput, optFns ...func(*Options)) (*CreateOpsItemOutput, error) { if params == nil { params = &CreateOpsItemInput{} @@ -39,14 +41,17 @@ func (c *Client) CreateOpsItem(ctx context.Context, params *CreateOpsItemInput, type CreateOpsItemInput struct { // User-defined text that contains information about the OpsItem, in Markdown - // format. Provide enough information so that users viewing this OpsItem for the - // first time understand the issue. + // format. + // + // Provide enough information so that users viewing this OpsItem for the first + // time understand the issue. // // This member is required. 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 . + // 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 . // // This member is required. Source *string @@ -59,8 +64,10 @@ 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 Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html) - // in the Amazon Web Services Systems Manager User Guide. + // accounts. For more information, see [Set up OpsCenter]in the Amazon Web Services Systems Manager + // User Guide. + // + // [Set up OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html AccountId *string // The time a runbook workflow ended. Currently reported only for the OpsItem type @@ -82,29 +89,43 @@ type CreateOpsItemInput struct { // 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 Create - // OpsItems manually (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html) - // in the Amazon Web Services Systems Manager User Guide. + // 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 DescribeOpsItemsAPI 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 GetOpsItemAPI + // 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 [Create OpsItems manually]in the Amazon Web Services Systems Manager + // User Guide. + // + // [Create OpsItems manually]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html 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/insight 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/insight + // + // 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 @@ -126,11 +147,15 @@ type CreateOpsItemInput struct { // Specify a severity to assign to an OpsItem. Severity *string - // Optional metadata that you assign to a resource. 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. + // Optional metadata that you assign to a resource. + // + // 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 AddTagsToResourceoperation. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssm/api_op_CreateOpsMetadata.go b/service/ssm/api_op_CreateOpsMetadata.go index c251c01d59d..b06d8418e6e 100644 --- a/service/ssm/api_op_CreateOpsMetadata.go +++ b/service/ssm/api_op_CreateOpsMetadata.go @@ -45,7 +45,9 @@ 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 Tags []types.Tag diff --git a/service/ssm/api_op_CreatePatchBaseline.go b/service/ssm/api_op_CreatePatchBaseline.go index 18a5fa8a39c..872645f877d 100644 --- a/service/ssm/api_op_CreatePatchBaseline.go +++ b/service/ssm/api_op_CreatePatchBaseline.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a patch baseline. For information about valid key-value pairs in -// PatchFilters for each supported operating system type, see PatchFilter . +// Creates a patch baseline. +// +// For information about valid key-value pairs in 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{} @@ -38,10 +40,12 @@ type CreatePatchBaselineInput struct { // A set of rules used to include patches in the baseline. ApprovalRules *types.PatchRuleGroup - // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [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 ApprovedPatches []string // Defines the compliance level for approved patches. When an approved patch is @@ -67,18 +71,22 @@ type CreatePatchBaselineInput struct { // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [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 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 Rejected patches list, and packages that include // them as dependencies, aren't installed by Patch Manager under any circumstances. // If a package was installed before it was added to the Rejected patches list, or @@ -96,8 +104,11 @@ type CreatePatchBaselineInput struct { // 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. Tags []types.Tag diff --git a/service/ssm/api_op_CreateResourceDataSync.go b/service/ssm/api_op_CreateResourceDataSync.go index 5d31533c946..9cffb5238c4 100644 --- a/service/ssm/api_op_CreateResourceDataSync.go +++ b/service/ssm/api_op_CreateResourceDataSync.go @@ -13,26 +13,32 @@ 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 -// 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) -// 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 -// Services Regions to a single Amazon S3 bucket. This type can synchronize -// 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) -// 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 -// 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. +// 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]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 Services Regions to a single Amazon S3 bucket. This +// type can synchronize 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]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 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. +// +// [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 +// [Configuring resource data sync for Inventory]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html func (c *Client) CreateResourceDataSync(ctx context.Context, params *CreateResourceDataSyncInput, optFns ...func(*Options)) (*CreateResourceDataSyncOutput, error) { if params == nil { params = &CreateResourceDataSyncInput{} diff --git a/service/ssm/api_op_DeleteAssociation.go b/service/ssm/api_op_DeleteAssociation.go index f14c23b1f77..43b96363dbc 100644 --- a/service/ssm/api_op_DeleteAssociation.go +++ b/service/ssm/api_op_DeleteAssociation.go @@ -13,10 +13,12 @@ import ( // Disassociates the specified Amazon Web Services Systems Manager document (SSM // document) from the specified managed node. If you created the association by // using the Targets parameter, then you must delete the association by using the -// association ID. When you disassociate a document from a managed node, it doesn't -// change the configuration of the node. To change the configuration state of a -// managed node after you disassociate a document, you must create a new document -// with the desired configuration and associate it with the node. +// association ID. +// +// When you disassociate a document from a managed node, it doesn't change the +// configuration of the node. To change the configuration state of a managed node +// after you disassociate a document, you must create a new document with the +// desired configuration and associate it with the node. func (c *Client) DeleteAssociation(ctx context.Context, params *DeleteAssociationInput, optFns ...func(*Options)) (*DeleteAssociationOutput, error) { if params == nil { params = &DeleteAssociationInput{} @@ -37,13 +39,15 @@ type DeleteAssociationInput struct { // The association ID that you want to delete. AssociationId *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. + // 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 *string // The name of the SSM document. diff --git a/service/ssm/api_op_DeleteDocument.go b/service/ssm/api_op_DeleteDocument.go index e1c9eddb03f..24d424dafd0 100644 --- a/service/ssm/api_op_DeleteDocument.go +++ b/service/ssm/api_op_DeleteDocument.go @@ -11,9 +11,10 @@ import ( ) // Deletes the Amazon Web Services Systems Manager document (SSM document) and all -// managed node associations to the document. Before you delete the document, we -// recommend that you use DeleteAssociation to disassociate all managed nodes that -// are associated with the document. +// managed node associations to the document. +// +// Before you delete the document, we recommend that you use DeleteAssociation to disassociate all +// managed nodes that are associated with the document. func (c *Client) DeleteDocument(ctx context.Context, params *DeleteDocumentInput, optFns ...func(*Options)) (*DeleteDocumentOutput, error) { if params == nil { params = &DeleteDocumentInput{} diff --git a/service/ssm/api_op_DeleteInventory.go b/service/ssm/api_op_DeleteInventory.go index 34738162e79..1b35f6d8935 100644 --- a/service/ssm/api_op_DeleteInventory.go +++ b/service/ssm/api_op_DeleteInventory.go @@ -50,11 +50,14 @@ type DeleteInventoryInput struct { // Use the SchemaDeleteOption to delete a custom inventory type (schema). If you // don't choose this option, the system only deletes existing inventory data // associated with the custom inventory type. Choose one of the following options: + // // DisableSchema: If you choose this option, the system ignores all inventory data // for the specified version, and any earlier versions. To enable this schema // again, you must call the PutInventory operation for a version greater than the - // disabled version. DeleteSchema: This option deletes the specified custom type - // from the Inventory service. You can recreate the schema later, if you want. + // disabled version. + // + // DeleteSchema: This option deletes the specified custom type from the Inventory + // service. You can recreate the schema later, if you want. SchemaDeleteOption types.InventorySchemaDeleteOption noSmithyDocumentSerde @@ -68,9 +71,10 @@ type DeleteInventoryOutput struct { // begin other operations. DeletionId *string - // A summary of 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-summary) + // A summary of the delete operation. For more information about this summary, see [Understanding the delete inventory summary] // in the Amazon Web Services Systems Manager User Guide. + // + // [Understanding the delete inventory summary]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete-summary DeletionSummary *types.InventoryDeletionSummary // The name of the inventory data type specified in the request. diff --git a/service/ssm/api_op_DeleteOpsItem.go b/service/ssm/api_op_DeleteOpsItem.go index 8e2cde2a183..288e8faa9a9 100644 --- a/service/ssm/api_op_DeleteOpsItem.go +++ b/service/ssm/api_op_DeleteOpsItem.go @@ -11,23 +11,29 @@ import ( ) // Delete an OpsItem. You must have permission in Identity and Access Management -// (IAM) to delete an OpsItem. Note the following important information about this -// operation. +// (IAM) to delete an OpsItem. +// +// Note the following important information about this operation. +// // - Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem. +// // - This operation uses an eventual consistency model, which means the system // can take a few minutes to complete this operation. If you delete an OpsItem and -// immediately call, for example, GetOpsItem , the deleted OpsItem might still -// appear in the response. +// immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in +// the response. +// // - This operation is idempotent. The system doesn't throw an exception if you // repeatedly call this operation for the same OpsItem. If the first call is // successful, all additional calls return the same successful response as the // first call. +// // - This operation doesn't support cross-account calls. A delegated // administrator or management account can't delete OpsItems in other accounts, // even if OpsCenter has been set up for cross-account administration. For more -// information about cross-account administration, see Setting up OpsCenter to -// centrally manage OpsItems across accounts (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setting-up-cross-account.html) -// in the Systems Manager User Guide. +// information about cross-account administration, see [Setting up OpsCenter to centrally manage OpsItems across accounts]in the Systems Manager +// User Guide. +// +// [Setting up OpsCenter to centrally manage OpsItems across accounts]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setting-up-cross-account.html func (c *Client) DeleteOpsItem(ctx context.Context, params *DeleteOpsItemInput, optFns ...func(*Options)) (*DeleteOpsItemOutput, error) { if params == nil { params = &DeleteOpsItemInput{} diff --git a/service/ssm/api_op_DeleteParameter.go b/service/ssm/api_op_DeleteParameter.go index 6b60183c428..46a9fd2d433 100644 --- a/service/ssm/api_op_DeleteParameter.go +++ b/service/ssm/api_op_DeleteParameter.go @@ -29,8 +29,10 @@ func (c *Client) DeleteParameter(ctx context.Context, params *DeleteParameterInp type DeleteParameterInput struct { - // The name of the parameter to delete. You can't enter the Amazon Resource Name - // (ARN) for a parameter, only the parameter name itself. + // The name of the parameter to delete. + // + // You can't enter the Amazon Resource Name (ARN) for a parameter, only the + // parameter name itself. // // This member is required. Name *string diff --git a/service/ssm/api_op_DeleteParameters.go b/service/ssm/api_op_DeleteParameters.go index c1ff3ceac06..63407438610 100644 --- a/service/ssm/api_op_DeleteParameters.go +++ b/service/ssm/api_op_DeleteParameters.go @@ -30,8 +30,10 @@ func (c *Client) DeleteParameters(ctx context.Context, params *DeleteParametersI type DeleteParametersInput struct { // The names of the parameters to delete. After deleting a parameter, wait for at - // least 30 seconds to create a parameter with the same name. You can't enter the - // Amazon Resource Name (ARN) for a parameter, only the parameter name itself. + // least 30 seconds to create a parameter with the same name. + // + // You can't enter the Amazon Resource Name (ARN) for a parameter, only the + // parameter name itself. // // This member is required. Names []string diff --git a/service/ssm/api_op_DeleteResourcePolicy.go b/service/ssm/api_op_DeleteResourcePolicy.go index 6ea0cd9ba83..71e824e6bf1 100644 --- a/service/ssm/api_op_DeleteResourcePolicy.go +++ b/service/ssm/api_op_DeleteResourcePolicy.go @@ -14,13 +14,17 @@ import ( // define the IAM entity (for example, an Amazon Web Services account) that can // manage your Systems Manager resources. The following resources support Systems // Manager resource policies. +// // - OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web // Services accounts to view and interact with OpsCenter operational work items // (OpsItems). +// // - Parameter - The resource policy is used to share a parameter with other // accounts using Resource Access Manager (RAM). For more information about -// cross-account sharing of parameters, see Working with shared parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) -// in the Amazon Web Services Systems Manager User Guide. +// cross-account sharing of parameters, see [Working with shared parameters]in the Amazon Web Services Systems +// Manager User Guide. +// +// [Working with shared parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error) { if params == nil { params = &DeleteResourcePolicyInput{} diff --git a/service/ssm/api_op_DescribeAssociation.go b/service/ssm/api_op_DescribeAssociation.go index 55a1216a23b..99da5b5fa33 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 3d9d2ed07ab..03880079753 100644 --- a/service/ssm/api_op_DescribeAssociationExecutionTargets.go +++ b/service/ssm/api_op_DescribeAssociationExecutionTargets.go @@ -41,7 +41,12 @@ type DescribeAssociationExecutionTargetsInput struct { ExecutionId *string // Filters for the request. You can specify the following filters and values. - // Status (EQUAL) ResourceId (EQUAL) ResourceType (EQUAL) + // + // Status (EQUAL) + // + // ResourceId (EQUAL) + // + // ResourceType (EQUAL) Filters []types.AssociationExecutionTargetsFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeAssociationExecutions.go b/service/ssm/api_op_DescribeAssociationExecutions.go index 4f33c080a28..58d37d425f5 100644 --- a/service/ssm/api_op_DescribeAssociationExecutions.go +++ b/service/ssm/api_op_DescribeAssociationExecutions.go @@ -35,7 +35,12 @@ type DescribeAssociationExecutionsInput struct { AssociationId *string // Filters for the request. You can specify the following filters and values. - // ExecutionId (EQUAL) Status (EQUAL) CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) + // + // ExecutionId (EQUAL) + // + // Status (EQUAL) + // + // CreatedTime (EQUAL, GREATER_THAN, LESS_THAN) Filters []types.AssociationExecutionFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeAvailablePatches.go b/service/ssm/api_op_DescribeAvailablePatches.go index 95036eaceee..d6a2ca6aed3 100644 --- a/service/ssm/api_op_DescribeAvailablePatches.go +++ b/service/ssm/api_op_DescribeAvailablePatches.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all patches eligible to be included in a patch baseline. Currently, -// DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and -// Windows Server operating systems. +// Lists all patches eligible to be included in a patch baseline. +// +// Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon +// Linux 2, and Windows Server operating systems. func (c *Client) DescribeAvailablePatches(ctx context.Context, params *DescribeAvailablePatchesInput, optFns ...func(*Options)) (*DescribeAvailablePatchesOutput, error) { if params == nil { params = &DescribeAvailablePatchesInput{} @@ -31,35 +32,94 @@ func (c *Client) DescribeAvailablePatches(ctx context.Context, params *DescribeA 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 - // 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 + // 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 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 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 1628eea6b37..072e2d695b6 100644 --- a/service/ssm/api_op_DescribeInstanceInformation.go +++ b/service/ssm/api_op_DescribeInstanceInformation.go @@ -14,13 +14,16 @@ import ( // Provides information about one or more of your managed nodes, including the // operating system platform, SSM Agent version, association status, and IP // address. This operation does not return information for nodes that are either -// Stopped or Terminated. If you specify one or more node IDs, the operation -// returns information for those managed nodes. If you don't specify node IDs, it -// returns information for all your managed nodes. If you specify a node ID that -// isn't valid or a node that you don't own, you receive an error. The IamRole -// field returned for this API operation is the Identity and Access Management -// (IAM) role assigned to on-premises managed nodes. This operation does not return -// the IAM role for EC2 instances. +// Stopped or Terminated. +// +// If you specify one or more node IDs, the operation returns information for +// those managed nodes. If you don't specify node IDs, it returns information for +// all your managed nodes. If you specify a node ID that isn't valid or a node that +// you don't own, you receive an error. +// +// The IamRole field returned for this API operation is the Identity and Access +// Management (IAM) role assigned to on-premises managed nodes. This operation does +// not return the IAM role for EC2 instances. func (c *Client) DescribeInstanceInformation(ctx context.Context, params *DescribeInstanceInformationInput, optFns ...func(*Options)) (*DescribeInstanceInformationOutput, error) { if params == nil { params = &DescribeInstanceInformationInput{} @@ -46,8 +49,10 @@ type DescribeInstanceInformationInput struct { // This is a legacy method. We recommend that you don't use this method. Instead, // use the Filters data type. Filters enables you to return node information by - // filtering based on tags applied to managed nodes. Attempting to use - // InstanceInformationFilterList and Filters leads to an exception error. + // filtering based on tags applied to managed nodes. + // + // Attempting to use InstanceInformationFilterList and Filters leads to an + // exception error. InstanceInformationFilterList []types.InstanceInformationFilter // The maximum number of items to return for this call. The call also returns a diff --git a/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go b/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go index 70ec951ef51..b88d9c18c12 100644 --- a/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go +++ b/service/ssm/api_op_DescribeInstancePatchStatesForPatchGroup.go @@ -37,8 +37,11 @@ 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") Filters []types.InstancePatchStateFilter diff --git a/service/ssm/api_op_DescribeInstancePatches.go b/service/ssm/api_op_DescribeInstancePatches.go index 74cad63579a..143b2a14dbc 100644 --- a/service/ssm/api_op_DescribeInstancePatches.go +++ b/service/ssm/api_op_DescribeInstancePatches.go @@ -35,14 +35,30 @@ type DescribeInstancePatchesInput struct { // This member is required. InstanceId *string - // Each element in the array is a structure containing a key-value pair. Supported - // 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 For - // lists of all State values, see Understanding patch compliance state values (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-compliance-states.html) - // in the Amazon Web Services Systems Manager User Guide. + // Each element in the array is a structure containing a key-value pair. + // + // Supported 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 + // + // For lists of all State values, see [Understanding patch compliance state values]in the Amazon Web Services Systems Manager + // User Guide. + // + // [Understanding patch compliance state values]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-compliance-states.html Filters []types.PatchOrchestratorFilter // The maximum number of patches to return (per page). @@ -62,12 +78,19 @@ 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) Patches []types.PatchComplianceData diff --git a/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go b/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go index 6badfbe331e..659015a66bc 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowExecutions.go @@ -37,8 +37,10 @@ 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 . diff --git a/service/ssm/api_op_DescribeMaintenanceWindowTasks.go b/service/ssm/api_op_DescribeMaintenanceWindowTasks.go index b4b36a177bd..c04f57101ae 100644 --- a/service/ssm/api_op_DescribeMaintenanceWindowTasks.go +++ b/service/ssm/api_op_DescribeMaintenanceWindowTasks.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) DescribeMaintenanceWindowTasks(ctx context.Context, params *DescribeMaintenanceWindowTasksInput, optFns ...func(*Options)) (*DescribeMaintenanceWindowTasksOutput, error) { if params == nil { params = &DescribeMaintenanceWindowTasksInput{} diff --git a/service/ssm/api_op_DescribeOpsItems.go b/service/ssm/api_op_DescribeOpsItems.go index f23b6a9c891..9ebbb0b4fb2 100644 --- a/service/ssm/api_op_DescribeOpsItems.go +++ b/service/ssm/api_op_DescribeOpsItems.go @@ -12,14 +12,16 @@ 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 Set up -// OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.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. +// Management (IAM) to query a list of OpsItems. For more information, see [Set up OpsCenter]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]in the Amazon Web Services Systems Manager User Guide. +// +// [Amazon Web Services Systems Manager OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html +// [Set up OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html func (c *Client) DescribeOpsItems(ctx context.Context, params *DescribeOpsItemsInput, optFns ...func(*Options)) (*DescribeOpsItemsOutput, error) { if params == nil { params = &DescribeOpsItemsInput{} @@ -45,25 +47,70 @@ 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 - // - Key: AccountId Operations: Equals + // + // - 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 + // + // - Key: AccountId + // + // 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"} + // 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 ca23fe16d1d..884320480e5 100644 --- a/service/ssm/api_op_DescribeParameters.go +++ b/service/ssm/api_op_DescribeParameters.go @@ -12,17 +12,22 @@ import ( ) // Lists the parameters in your Amazon Web Services account or the parameters -// shared with you when you enable the Shared (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html#systemsmanager-DescribeParameters-request-Shared) -// option. 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. +// shared with you when you enable the [Shared]option. +// +// 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. +// +// [Shared]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html#systemsmanager-DescribeParameters-request-Shared func (c *Client) DescribeParameters(ctx context.Context, params *DescribeParametersInput, optFns ...func(*Options)) (*DescribeParametersOutput, error) { if params == nil { params = &DescribeParametersInput{} @@ -54,15 +59,19 @@ type DescribeParametersInput struct { // Filters to limit the request results. ParameterFilters []types.ParameterStringFilter - // Lists parameters that are shared with you. By default when using this option, - // the command returns parameters that have been shared using a standard Resource - // Access Manager Resource Share. In order for a parameter that was shared using - // the PutResourcePolicy command to be returned, the associated RAM Resource Share - // Created From Policy must have been promoted to a standard Resource Share using - // the RAM PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) - // API operation. For more information about sharing parameters, see Working with - // shared parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) - // in the Amazon Web Services Systems Manager User Guide. + // Lists parameters that are shared with you. + // + // By default when using this option, the command returns parameters that have + // been shared using a standard Resource Access Manager Resource Share. In order + // for a parameter that was shared using the PutResourcePolicycommand to be returned, the + // associated RAM Resource Share Created From Policy must have been promoted to a + // standard Resource Share using the RAM [PromoteResourceShareCreatedFromPolicy]API operation. + // + // For more information about sharing parameters, see [Working with shared parameters] in the Amazon Web Services + // Systems Manager User Guide. + // + // [PromoteResourceShareCreatedFromPolicy]: https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html + // [Working with shared parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html Shared *bool noSmithyDocumentSerde diff --git a/service/ssm/api_op_DescribePatchBaselines.go b/service/ssm/api_op_DescribePatchBaselines.go index 3742eaab0d4..a39df48df5e 100644 --- a/service/ssm/api_op_DescribePatchBaselines.go +++ b/service/ssm/api_op_DescribePatchBaselines.go @@ -29,11 +29,21 @@ func (c *Client) DescribePatchBaselines(ctx context.Context, params *DescribePat 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 + // 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 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 5c340afffb9..848d09e0ea5 100644 --- a/service/ssm/api_op_DescribePatchGroupState.go +++ b/service/ssm/api_op_DescribePatchGroupState.go @@ -67,8 +67,9 @@ type DescribePatchGroupStateOutput struct { // 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 + // 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 diff --git a/service/ssm/api_op_DescribePatchGroups.go b/service/ssm/api_op_DescribePatchGroups.go index fb0157ff559..bee43b5e6af 100644 --- a/service/ssm/api_op_DescribePatchGroups.go +++ b/service/ssm/api_op_DescribePatchGroups.go @@ -29,10 +29,17 @@ func (c *Client) DescribePatchGroups(ctx context.Context, params *DescribePatchG 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 + // 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 Filters []types.PatchOrchestratorFilter // The maximum number of patch groups to return (per page). @@ -48,8 +55,10 @@ 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. Mappings []types.PatchGroupPatchBaselineMapping diff --git a/service/ssm/api_op_DescribePatchProperties.go b/service/ssm/api_op_DescribePatchProperties.go index 6071e9e79cb..56135595a41 100644 --- a/service/ssm/api_op_DescribePatchProperties.go +++ b/service/ssm/api_op_DescribePatchProperties.go @@ -14,17 +14,31 @@ 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 -// Valid properties: PRODUCT | CLASSIFICATION ORACLE_LINUX Valid properties: -// PRODUCT | CLASSIFICATION | SEVERITY REDHAT_ENTERPRISE_LINUX Valid properties: -// PRODUCT | CLASSIFICATION | SEVERITY SUSE Valid properties: PRODUCT | -// CLASSIFICATION | SEVERITY UBUNTU Valid properties: PRODUCT | PRIORITY WINDOWS -// Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY +// 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 | CLASSIFICATION | SEVERITY +// +// UBUNTU Valid properties: PRODUCT | PRIORITY +// +// WINDOWS Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | +// MSRC_SEVERITY func (c *Client) DescribePatchProperties(ctx context.Context, params *DescribePatchPropertiesInput, optFns ...func(*Options)) (*DescribePatchPropertiesOutput, error) { if params == nil { params = &DescribePatchPropertiesInput{} diff --git a/service/ssm/api_op_GetCalendarState.go b/service/ssm/api_op_GetCalendarState.go index fd0823b6f33..d2848ffe47f 100644 --- a/service/ssm/api_op_GetCalendarState.go +++ b/service/ssm/api_op_GetCalendarState.go @@ -16,13 +16,16 @@ 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 -// 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 -// 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) -// in the Amazon Web Services Systems Manager User Guide. +// 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 Amazon Web Services +// Systems Manager, see [Amazon Web Services Systems Manager Change Calendar]in the Amazon Web Services Systems Manager User Guide. +// +// [Amazon Web Services Systems Manager Change Calendar]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html func (c *Client) GetCalendarState(ctx context.Context, params *GetCalendarStateInput, optFns ...func(*Options)) (*GetCalendarStateOutput, error) { if params == nil { params = &GetCalendarStateInput{} @@ -48,8 +51,10 @@ 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]format. If you don't specify a value or AtTime , the current + // time is used. + // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601 AtTime *string noSmithyDocumentSerde @@ -57,15 +62,17 @@ type GetCalendarStateInput struct { type GetCalendarStateOutput struct { - // The time, as an ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601) string, that - // you specified in your command. If you don't specify a time, GetCalendarState - // uses the current time. + // The time, as an [ISO 8601] string, that you specified in your command. If you don't + // specify a time, GetCalendarState uses the current time. + // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601 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 - // vice-versa. + // The time, as an [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 vice-versa. + // + // [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601 NextTransitionTime *string // The state of the calendar. An OPEN calendar indicates that actions are allowed diff --git a/service/ssm/api_op_GetCommandInvocation.go b/service/ssm/api_op_GetCommandInvocation.go index 0a3bf7a2012..438b4b8a356 100644 --- a/service/ssm/api_op_GetCommandInvocation.go +++ b/service/ssm/api_op_GetCommandInvocation.go @@ -17,10 +17,11 @@ 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 . +// 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. func (c *Client) GetCommandInvocation(ctx context.Context, params *GetCommandInvocationInput, optFns ...func(*Options)) (*GetCommandInvocationOutput, error) { if params == nil { params = &GetCommandInvocationInput{} @@ -55,9 +56,10 @@ 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 - // document content and find the name of the step you want details for. - // Alternatively, use ListCommandInvocations with the CommandId and Details + // 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 ListCommandInvocationswith the CommandId and Details // parameters. The PluginName is the Name attribute of the CommandPlugin object in // the CommandPlugins list. PluginName *string @@ -89,15 +91,19 @@ type GetCommandInvocationOutput struct { // The date and time the plugin finished running. Date and time are written in ISO // 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The // following sample Amazon Web Services CLI command uses the InvokedAfter filter. - // aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z If - // the plugin hasn't started to run, the string is empty. + // + // aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z + // + // If the plugin hasn't started to run, the string is empty. ExecutionEndDateTime *string // The date and time the plugin started running. Date and time are written in ISO // 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The // following sample Amazon Web Services CLI command uses the InvokedBefore filter. - // aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z If - // the plugin hasn't started to run, the string is empty. + // + // aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z + // + // If the plugin hasn't started to run, the string is empty. ExecutionStartDateTime *string // The ID of the managed node targeted by the command. A managed node can be an @@ -140,40 +146,51 @@ type GetCommandInvocationOutput struct { // 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) - // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one - // of the following values: + // results than Status . For more information about these statuses, see [Understanding command statuses] 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. + // + // [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html StatusDetails *string // Metadata pertaining to the operation's result. @@ -301,12 +318,13 @@ type CommandExecutedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetCommandInvocationInput, *GetCommandInvocationOutput, error) (bool, error) } diff --git a/service/ssm/api_op_GetDefaultPatchBaseline.go b/service/ssm/api_op_GetDefaultPatchBaseline.go index 0a242dc023f..57ce367dc44 100644 --- a/service/ssm/api_op_GetDefaultPatchBaseline.go +++ b/service/ssm/api_op_GetDefaultPatchBaseline.go @@ -13,8 +13,10 @@ import ( // Retrieves the default patch baseline. Amazon Web Services Systems Manager // supports creating multiple default patch baselines. For example, you can create -// a default patch baseline for each operating system. If you don't specify an -// operating system value, the default patch baseline for Windows is returned. +// a default patch baseline for each operating system. +// +// If you don't specify an operating system value, the default patch baseline for +// Windows is returned. func (c *Client) GetDefaultPatchBaseline(ctx context.Context, params *GetDefaultPatchBaselineInput, optFns ...func(*Options)) (*GetDefaultPatchBaselineOutput, error) { if params == nil { params = &GetDefaultPatchBaselineInput{} diff --git a/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go b/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go index d9146c4bb72..78d4b208e7a 100644 --- a/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go +++ b/service/ssm/api_op_GetDeployablePatchSnapshotForInstance.go @@ -13,13 +13,15 @@ import ( // Retrieves the current snapshot for the patch baseline the managed node uses. // This API is primarily used by the AWS-RunPatchBaseline Systems Manager document -// (SSM document). If you run the command locally, such as with the Command Line -// Interface (CLI), the system attempts to use your local Amazon Web Services -// credentials and the operation fails. To avoid this, you can run the command in -// the Amazon Web Services Systems Manager console. Use Run Command, a capability -// of Amazon Web Services Systems Manager, with an SSM document that enables you to -// target a managed node with a script or command. For example, run the command -// using the AWS-RunShellScript document or the AWS-RunPowerShellScript document. +// (SSM document). +// +// If you run the command locally, such as with the Command Line Interface (CLI), +// the system attempts to use your local Amazon Web Services credentials and the +// operation fails. To avoid this, you can run the command in the Amazon Web +// Services Systems Manager console. Use Run Command, a capability of Amazon Web +// Services Systems Manager, with an SSM document that enables you to target a +// managed node with a script or command. For example, run the command using the +// AWS-RunShellScript document or the AWS-RunPowerShellScript document. func (c *Client) GetDeployablePatchSnapshotForInstance(ctx context.Context, params *GetDeployablePatchSnapshotForInstanceInput, optFns ...func(*Options)) (*GetDeployablePatchSnapshotForInstanceOutput, error) { if params == nil { params = &GetDeployablePatchSnapshotForInstanceInput{} diff --git a/service/ssm/api_op_GetDocument.go b/service/ssm/api_op_GetDocument.go index 11f920c3ed5..9cad3e6244c 100644 --- a/service/ssm/api_op_GetDocument.go +++ b/service/ssm/api_op_GetDocument.go @@ -64,7 +64,7 @@ type GetDocumentOutput struct { 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 . + // of the document. If you want to update this value, see UpdateDocument. DisplayName *string // The document format, either JSON or YAML. @@ -86,10 +86,13 @@ type GetDocumentOutput struct { // The current review status of a new custom Systems Manager document (SSM // document) created by a member of your organization, or of the latest version of - // an existing SSM document. Only one version of an SSM document can be in the - // APPROVED state at a time. When a new version is approved, the status of the - // previous version changes to REJECTED. Only one version of an SSM document can be - // in review, or PENDING, at a time. + // an existing SSM document. + // + // Only one version of an SSM document can be in the APPROVED state at a time. + // When a new version is approved, the status of the previous version changes to + // REJECTED. + // + // Only one version of an SSM document can be in review, or PENDING, at a time. ReviewStatus types.ReviewStatus // The status of the SSM document, such as Creating , Active , Updating , Failed , diff --git a/service/ssm/api_op_GetInventory.go b/service/ssm/api_op_GetInventory.go index 25f94410396..92db61b1321 100644 --- a/service/ssm/api_op_GetInventory.go +++ b/service/ssm/api_op_GetInventory.go @@ -55,7 +55,8 @@ type GetInventoryInput struct { type GetInventoryOutput struct { - // Collection of inventory entities such as a collection of managed node inventory. + // Collection of inventory entities such as a collection of managed node + // inventory. Entities []types.InventoryResultEntity // The token to use when requesting the next set of items. If there are no diff --git a/service/ssm/api_op_GetMaintenanceWindow.go b/service/ssm/api_op_GetMaintenanceWindow.go index ca7d3c9a51a..38c149dea5e 100644 --- a/service/ssm/api_op_GetMaintenanceWindow.go +++ b/service/ssm/api_op_GetMaintenanceWindow.go @@ -83,8 +83,10 @@ type GetMaintenanceWindowOutput struct { // The time zone that the scheduled maintenance window executions are based 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. + // "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database]on + // the IANA website. + // + // [Time Zone Database]: https://www.iana.org/time-zones ScheduleTimezone *string // The date and time, in ISO-8601 Extended format, for when the maintenance window diff --git a/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go b/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go index da11c872869..8d8cad606ef 100644 --- a/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go +++ b/service/ssm/api_op_GetMaintenanceWindowExecutionTask.go @@ -83,13 +83,17 @@ type GetMaintenanceWindowExecutionTaskOutput struct { // retrieved. TaskExecutionId *string - // 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 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 TaskParameters []map[string]types.MaintenanceWindowTaskParameterValueExpression diff --git a/service/ssm/api_op_GetMaintenanceWindowTask.go b/service/ssm/api_op_GetMaintenanceWindowTask.go index 68ba769138b..bf274e4b11b 100644 --- a/service/ssm/api_op_GetMaintenanceWindowTask.go +++ b/service/ssm/api_op_GetMaintenanceWindowTask.go @@ -11,12 +11,14 @@ 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 -// 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. +// 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. func (c *Client) GetMaintenanceWindowTask(ctx context.Context, params *GetMaintenanceWindowTaskInput, optFns ...func(*Options)) (*GetMaintenanceWindowTaskOutput, error) { if params == nil { params = &GetMaintenanceWindowTaskInput{} @@ -65,26 +67,29 @@ type GetMaintenanceWindowTaskOutput struct { 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 . + // 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 - // running of your task and can be ignored. + // 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 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 - // running of your task and can be ignored. + // 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 running of your task and can be ignored. MaxErrors *string // The retrieved task name. @@ -111,11 +116,12 @@ type GetMaintenanceWindowTaskOutput struct { // The parameters to pass to the task when it runs. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters - // 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 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. 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 7cb8f33d293..ecc86cddcc4 100644 --- a/service/ssm/api_op_GetOpsItem.go +++ b/service/ssm/api_op_GetOpsItem.go @@ -13,13 +13,15 @@ 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 Set up OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.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. +// more information, see [Set up OpsCenter]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]in the Amazon Web Services Systems Manager User Guide. +// +// [Amazon Web Services Systems Manager OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html +// [Set up OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html 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 6355c801092..5f594a80968 100644 --- a/service/ssm/api_op_GetParameter.go +++ b/service/ssm/api_op_GetParameter.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get information about a single parameter by specifying the parameter name. To -// get information about more than one parameter at a time, use the GetParameters -// operation. +// Get information about a single parameter by specifying the parameter name. +// +// To get information about more than one parameter at a time, use the GetParameters operation. func (c *Client) GetParameter(ctx context.Context, params *GetParameterInput, optFns ...func(*Options)) (*GetParameterOutput, error) { if params == nil { params = &GetParameterInput{} @@ -33,10 +33,14 @@ type GetParameterInput struct { // The name or Amazon Resource Name (ARN) of the parameter that you want to query. // For parameters shared with you from another account, you must use the full ARN. + // // To query by parameter label, use "Name": "name:label" . To query by parameter - // version, use "Name": "name:version" . For more information about shared - // parameters, see Working with shared parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/sharing.html) - // in the Amazon Web Services Systems Manager User Guide. + // version, use "Name": "name:version" . + // + // For more information about shared parameters, see [Working with shared parameters] in the Amazon Web Services + // Systems Manager User Guide. + // + // [Working with shared parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sharing.html // // This member is required. Name *string diff --git a/service/ssm/api_op_GetParameterHistory.go b/service/ssm/api_op_GetParameterHistory.go index 8c64cdd7b5c..97c56161a76 100644 --- a/service/ssm/api_op_GetParameterHistory.go +++ b/service/ssm/api_op_GetParameterHistory.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the history of all changes to a parameter. 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, GetParameterHistory -// retrieves whatever the original key alias was referencing. +// Retrieves the history of all changes to a parameter. +// +// 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, GetParameterHistory retrieves whatever the original key alias was +// referencing. func (c *Client) GetParameterHistory(ctx context.Context, params *GetParameterHistoryInput, optFns ...func(*Options)) (*GetParameterHistoryOutput, error) { if params == nil { params = &GetParameterHistoryInput{} diff --git a/service/ssm/api_op_GetParameters.go b/service/ssm/api_op_GetParameters.go index d8178aadbc1..6ac8527f92e 100644 --- a/service/ssm/api_op_GetParameters.go +++ b/service/ssm/api_op_GetParameters.go @@ -12,8 +12,9 @@ import ( ) // Get information about one or more parameters by specifying multiple parameter -// names. To get information about a single parameter, you can use the GetParameter -// operation instead. +// names. +// +// To get information about a single parameter, you can use the GetParameter operation instead. func (c *Client) GetParameters(ctx context.Context, params *GetParametersInput, optFns ...func(*Options)) (*GetParametersOutput, error) { if params == nil { params = &GetParametersInput{} @@ -33,11 +34,18 @@ type GetParametersInput struct { // The names or Amazon Resource Names (ARNs) of the parameters that you want to // query. For parameters shared with you from another account, you must use the - // full ARNs. To query by parameter label, use "Name": "name:label" . To query by - // parameter version, use "Name": "name:version" . The results for GetParameters - // requests are listed in alphabetical order in query responses. For information - // about shared parameters, see Working with shared parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html) - // in the Amazon Web Services Systems Manager User Guide. + // full ARNs. + // + // To query by parameter label, use "Name": "name:label" . To query by parameter + // version, use "Name": "name:version" . + // + // The results for GetParameters requests are listed in alphabetical order in + // query responses. + // + // For information about shared parameters, see [Working with shared parameters] in the Amazon Web Services + // Systems Manager User Guide. + // + // [Working with shared parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html // // This member is required. Names []string diff --git a/service/ssm/api_op_GetParametersByPath.go b/service/ssm/api_op_GetParametersByPath.go index 5ebac528989..73e11ae6e4e 100644 --- a/service/ssm/api_op_GetParametersByPath.go +++ b/service/ssm/api_op_GetParametersByPath.go @@ -12,6 +12,7 @@ import ( ) // Retrieve information about one or more parameters in a specific hierarchy. +// // 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 @@ -52,18 +53,22 @@ 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. diff --git a/service/ssm/api_op_GetPatchBaseline.go b/service/ssm/api_op_GetPatchBaseline.go index fef6fcf7f8f..1f8b7bd7df1 100644 --- a/service/ssm/api_op_GetPatchBaseline.go +++ b/service/ssm/api_op_GetPatchBaseline.go @@ -30,10 +30,11 @@ func (c *Client) GetPatchBaseline(ctx context.Context, params *GetPatchBaselineI 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 + // 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 // arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of // pb-0e392de35e7c563b7 . // diff --git a/service/ssm/api_op_GetServiceSetting.go b/service/ssm/api_op_GetServiceSetting.go index f56183193c8..c16bcf0ab46 100644 --- a/service/ssm/api_op_GetServiceSetting.go +++ b/service/ssm/api_op_GetServiceSetting.go @@ -17,14 +17,16 @@ import ( // 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 -// 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. Query the current service setting for the -// Amazon Web Services account. +// 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 ResetServiceSettingto change the value back to the original +// value defined by the Amazon Web Services service team. +// +// Query the current service setting for the Amazon Web Services account. func (c *Client) GetServiceSetting(ctx context.Context, params *GetServiceSettingInput, optFns ...func(*Options)) (*GetServiceSettingOutput, error) { if params == nil { params = &GetServiceSettingInput{} @@ -45,13 +47,21 @@ 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 // // This member is required. diff --git a/service/ssm/api_op_LabelParameterVersion.go b/service/ssm/api_op_LabelParameterVersion.go index 60969ad0e4b..7dcb257ea2c 100644 --- a/service/ssm/api_op_LabelParameterVersion.go +++ b/service/ssm/api_op_LabelParameterVersion.go @@ -14,19 +14,29 @@ import ( // of a parameter. When you modify a parameter, Amazon Web Services Systems Manager // 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. +// 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. @@ -52,9 +62,10 @@ type LabelParameterVersionInput struct { // This member is required. Labels []string - // The parameter name on which you want to attach one or more labels. You can't - // enter the Amazon Resource Name (ARN) for a parameter, only the parameter name - // itself. + // The parameter name on which you want to attach one or more labels. + // + // You can't enter the Amazon Resource Name (ARN) for a parameter, only the + // parameter name itself. // // This member is required. Name *string @@ -70,8 +81,9 @@ type LabelParameterVersionInput struct { type LabelParameterVersionOutput struct { // The label doesn't meet the requirements. For information about parameter label - // requirements, see Working with parameter labels (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html) - // in the Amazon Web Services Systems Manager User Guide. + // requirements, see [Working with parameter labels]in the Amazon Web Services Systems Manager User Guide. + // + // [Working with parameter labels]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html InvalidLabels []string // The version of the parameter that has been labeled. diff --git a/service/ssm/api_op_ListAssociations.go b/service/ssm/api_op_ListAssociations.go index 02a5a8a958b..960fcc9040e 100644 --- a/service/ssm/api_op_ListAssociations.go +++ b/service/ssm/api_op_ListAssociations.go @@ -33,6 +33,7 @@ func (c *Client) ListAssociations(ctx context.Context, params *ListAssociationsI 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 diff --git a/service/ssm/api_op_ListCommands.go b/service/ssm/api_op_ListCommands.go index 643b23fe243..7e1c8059879 100644 --- a/service/ssm/api_op_ListCommands.go +++ b/service/ssm/api_op_ListCommands.go @@ -36,9 +36,10 @@ 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_ListDocuments.go b/service/ssm/api_op_ListDocuments.go index 68ccaea1a45..a5aba3f611a 100644 --- a/service/ssm/api_op_ListDocuments.go +++ b/service/ssm/api_op_ListDocuments.go @@ -39,9 +39,11 @@ type ListDocumentsInput struct { // 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 + // 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_ListResourceDataSync.go b/service/ssm/api_op_ListResourceDataSync.go index 04e81ba1368..c42c761be06 100644 --- a/service/ssm/api_op_ListResourceDataSync.go +++ b/service/ssm/api_op_ListResourceDataSync.go @@ -13,13 +13,14 @@ 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 -// 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 -// request them by specifying the NextToken returned in the call to the parameter -// of a subsequent call. +// sync successfully completed. +// +// The number of sync configurations might be too 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 request them by specifying +// the NextToken returned in the call to the parameter of a subsequent call. func (c *Client) ListResourceDataSync(ctx context.Context, params *ListResourceDataSyncInput, optFns ...func(*Options)) (*ListResourceDataSyncOutput, error) { if params == nil { params = &ListResourceDataSyncInput{} diff --git a/service/ssm/api_op_ListTagsForResource.go b/service/ssm/api_op_ListTagsForResource.go index 6fb1a507024..6e9cf4ce9d8 100644 --- a/service/ssm/api_op_ListTagsForResource.go +++ b/service/ssm/api_op_ListTagsForResource.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns a list of the tags assigned to the specified resource. For information -// about the ID format for each supported resource type, see AddTagsToResource . +// Returns a list of the tags assigned to the specified resource. +// +// For information 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_PutComplianceItems.go b/service/ssm/api_op_PutComplianceItems.go index 5c147823b53..d6f204f8727 100644 --- a/service/ssm/api_op_PutComplianceItems.go +++ b/service/ssm/api_op_PutComplianceItems.go @@ -15,24 +15,41 @@ import ( // resource. This operation lets you register custom compliance details with a // 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: +// 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' @@ -92,10 +109,13 @@ type PutComplianceItemsInput struct { // 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. + // 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 18142b0387a..9d7fdaf3939 100644 --- a/service/ssm/api_op_PutParameter.go +++ b/service/ssm/api_op_PutParameter.go @@ -30,35 +30,51 @@ func (c *Client) PutParameter(ctx context.Context, params *PutParameterInput, op type PutParameterInput struct { // The fully qualified name of the parameter that you want to add to the system. + // // You can't enter the Amazon Resource Name (ARN) for a parameter, only the - // parameter name itself. The fully qualified name includes the complete hierarchy - // of the parameter path 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 name itself. + // + // The fully qualified name includes the complete hierarchy of the parameter path + // 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-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 + // + // For additional information about valid values for parameter names, see [Creating Systems Manager parameters] 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/ . // + // [Creating Systems Manager parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html + // // 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. + // // 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. // @@ -71,39 +87,50 @@ type PutParameterInput struct { AllowedPattern *string // 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. + // 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 IDs (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html) - // . + // 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]. For more information about AMI format validation , + // see [Native parameter support for Amazon Machine Image IDs]. + // + // [Setting up notifications or trigger actions based on Parameter Store events]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html + // [Native parameter support for Amazon Machine Image 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. + // 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 - // secure as using a custom key. + // 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. KeyId *string @@ -113,21 +140,28 @@ type PutParameterInput struct { // 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. + // 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) - // . + // 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]. + // + // [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 @@ -136,66 +170,93 @@ type PutParameterInput struct { // 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. + // + // 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 - // tier and an advanced tier for parameters. Standard parameters have a content - // size limit of 4 KB and can't be configured to use parameter policies. You can - // create a maximum of 10,000 standard parameters for each Region in an Amazon Web - // Services account. Standard parameters are offered at no additional cost. + // The parameter tier to assign to a parameter. + // + // Parameter Store offers a standard tier and an advanced tier for parameters. + // Standard parameters have a content size limit of 4 KB and can't be configured to + // use parameter policies. You can create a maximum of 10,000 standard parameters + // for each Region in an Amazon Web Services account. Standard parameters are + // offered at no additional cost. + // // 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 Managing 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 - // parameter would result in data loss because the system would truncate the size - // of the parameter from 8 KB to 4 KB. Reverting would also remove any policies - // attached to the parameter. Lastly, advanced parameters use a different form of - // 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 + // charge. For more information, see [Managing parameter tiers]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 parameter would result in data loss because the + // system would truncate the size of the parameter from 8 KB to 4 KB. Reverting + // would also remove any policies attached to the parameter. Lastly, advanced + // parameters use a different form of 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. + // 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/parameter-store-advanced-parameters.html#ps-default-tier) - // in the Amazon Web Services Systems Manager User Guide. + // + // For more information about configuring the default tier option, see [Specifying a default parameter tier] in the + // Amazon Web Services Systems Manager User Guide. + // + // [Specifying a default parameter tier]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier + // [Managing parameter tiers]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html Tier types.ParameterTier - // The type of parameter that you want to add to the system. SecureString isn't - // 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. + // The type of parameter that you want to add to the system. + // + // SecureString isn't 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. Type types.ParameterType noSmithyDocumentSerde diff --git a/service/ssm/api_op_PutResourcePolicy.go b/service/ssm/api_op_PutResourcePolicy.go index f1b1807158b..d8eab0100f1 100644 --- a/service/ssm/api_op_PutResourcePolicy.go +++ b/service/ssm/api_op_PutResourcePolicy.go @@ -14,30 +14,44 @@ import ( // you to define the IAM entity (for example, an Amazon Web Services account) that // can manage your Systems Manager resources. The following resources support // Systems Manager resource policies. +// // - OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web // Services accounts to view and interact with OpsCenter operational work items // (OpsItems). +// // - Parameter - The resource policy is used to share a parameter with other -// accounts using Resource Access Manager (RAM). To share a parameter, it must be -// in the advanced parameter tier. For information about parameter tiers, see -// Managing parameter tiers (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html) -// . For information about changing an existing standard parameter to an advanced -// parameter, see Changing a standard parameter to an advanced parameter (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#parameter-store-advanced-parameters-enabling) -// . To share a SecureString parameter, it must be encrypted with a customer -// managed key, and you must share the key separately through Key Management -// Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted -// with the default Amazon Web Services managed key can be updated to use a -// customer managed key instead. For KMS key definitions, see KMS concepts (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) -// in the Key Management Service Developer Guide. While you can share a parameter -// using the Systems Manager PutResourcePolicy operation, we recommend using -// Resource Access Manager (RAM) instead. This is because using PutResourcePolicy -// requires the extra step of promoting the parameter to a standard RAM Resource -// Share using the RAM PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) -// API operation. Otherwise, the parameter won't be returned by the Systems Manager -// DescribeParameters (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html) -// API operation using the --shared option. For more information, see Sharing a -// parameter (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html#share) -// in the Amazon Web Services Systems Manager User Guide +// accounts using Resource Access Manager (RAM). +// +// To share a parameter, it must be in the advanced parameter tier. For +// +// information about parameter tiers, see [Managing parameter tiers]. For information about changing an +// existing standard parameter to an advanced parameter, see [Changing a standard parameter to an advanced parameter]. +// +// To share a SecureString parameter, it must be encrypted with a customer managed +// +// key, and you must share the key separately through Key Management Service. +// Amazon Web Services managed keys cannot be shared. Parameters encrypted with the +// default Amazon Web Services managed key can be updated to use a customer managed +// key instead. For KMS key definitions, see [KMS concepts]in the Key Management Service +// Developer Guide. +// +// While you can share a parameter using the Systems Manager PutResourcePolicy +// +// operation, we recommend using Resource Access Manager (RAM) instead. This is +// because using PutResourcePolicy requires the extra step of promoting the +// parameter to a standard RAM Resource Share using the RAM [PromoteResourceShareCreatedFromPolicy]API operation. +// Otherwise, the parameter won't be returned by the Systems Manager [DescribeParameters]API +// operation using the --shared option. +// +// For more information, see [Sharing a parameter]in the Amazon Web Services Systems Manager User Guide +// +// [Sharing a parameter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html#share +// +// [Managing parameter tiers]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html +// [Changing a standard parameter to an advanced parameter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#parameter-store-advanced-parameters-enabling +// [PromoteResourceShareCreatedFromPolicy]: https://docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html +// [KMS concepts]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html +// [DescribeParameters]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribeParameters.html func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error) { if params == nil { params = &PutResourcePolicyInput{} diff --git a/service/ssm/api_op_RegisterDefaultPatchBaseline.go b/service/ssm/api_op_RegisterDefaultPatchBaseline.go index 67535a2b8f6..d6962659412 100644 --- a/service/ssm/api_op_RegisterDefaultPatchBaseline.go +++ b/service/ssm/api_op_RegisterDefaultPatchBaseline.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Defines the default patch baseline for the relevant operating system. To reset -// the Amazon Web Services-predefined patch baseline as the default, specify the -// full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For -// example, for CentOS, specify +// Defines the default patch baseline for the relevant operating system. +// +// To reset the Amazon Web Services-predefined patch baseline as the default, +// specify the 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 . func (c *Client) RegisterDefaultPatchBaseline(ctx context.Context, params *RegisterDefaultPatchBaselineInput, optFns ...func(*Options)) (*RegisterDefaultPatchBaselineOutput, error) { diff --git a/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go b/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go index 17966e8358c..1d5e52b70b5 100644 --- a/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go +++ b/service/ssm/api_op_RegisterTargetWithMaintenanceWindow.go @@ -35,23 +35,45 @@ type RegisterTargetWithMaintenanceWindowInput struct { 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 - // 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 - // and assign each task the same priority level. You can specify targets using - // managed node IDs, resource group names, or tags that have been applied to - // 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 + // 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 and assign each task the same priority level. + // + // You can specify targets using managed node IDs, resource group names, or tags + // that have been applied to 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 - // Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC + // + // 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) - // in the Amazon Web Services Systems Manager User Guide. + // for each one, see [Examples: Register targets with a maintenance window]in the Amazon Web Services Systems Manager User Guide. + // + // [Examples: Register targets with a maintenance window]: https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html // // This member is required. Targets []types.Target diff --git a/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go b/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go index c528f1d171e..1916950cdab 100644 --- a/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go +++ b/service/ssm/api_op_RegisterTaskWithMaintenanceWindow.go @@ -52,47 +52,61 @@ 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 . + // + // - 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. Description *string // A structure containing information about an Amazon Simple Storage Service - // (Amazon S3) bucket to write managed node-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 . + // (Amazon S3) bucket to write managed node-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 *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) - // 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 - // running of your task. + // 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]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 running of your task. + // + // [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html 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) - // 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 - // running of your task. + // when you are registering or updating a [targetless task]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 running of your task. + // + // [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html MaxErrors *string // An optional name for the task. @@ -108,35 +122,45 @@ type RegisterTaskWithMaintenanceWindowInput struct { // specify a service role ARN, Systems Manager uses a service-linked role in your // account. If no appropriate service-linked role for Systems Manager exists in // your account, it is created when you run RegisterTaskWithMaintenanceWindow . + // // However, for an improved security posture, we strongly recommend creating a // custom policy and custom service role for running your maintenance window tasks. // The policy can be crafted to provide only the permissions needed for your - // particular maintenance window tasks. For more information, see Setting up - // maintenance windows (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) - // in the in the Amazon Web Services Systems Manager User Guide. + // particular maintenance window tasks. For more information, see [Setting up maintenance windows]in the in the + // Amazon Web Services Systems Manager User Guide. + // + // [Setting up maintenance windows]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html ServiceRoleArn *string - // The targets (either managed nodes or maintenance window targets). 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. Specify managed nodes - // using the following format: Key=InstanceIds,Values=, Specify maintenance window - // targets using the following format: Key=WindowTargetIds,Values=, + // The targets (either managed nodes or maintenance window targets). + // + // 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]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=, + // + // [Registering maintenance window tasks without targets]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html Targets []types.Target // The parameters that the task should use during execution. Populate only the // fields that match the task type. All other fields should be empty. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters - // 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 . + // 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. TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression noSmithyDocumentSerde diff --git a/service/ssm/api_op_RemoveTagsFromResource.go b/service/ssm/api_op_RemoveTagsFromResource.go index 479215e893f..7dc11ddd57e 100644 --- a/service/ssm/api_op_RemoveTagsFromResource.go +++ b/service/ssm/api_op_RemoveTagsFromResource.go @@ -30,26 +30,36 @@ 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 : - // 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 + // + // 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 . - // 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 + // + // 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: // mi-ID_number. For example, mi-1a2b3c4d5e6f. // // This member is required. ResourceId *string - // 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 . + // 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 . // // This member is required. ResourceType types.ResourceTypeForTagging diff --git a/service/ssm/api_op_ResetServiceSetting.go b/service/ssm/api_op_ResetServiceSetting.go index 48cad2abaea..838b32424d7 100644 --- a/service/ssm/api_op_ResetServiceSetting.go +++ b/service/ssm/api_op_ResetServiceSetting.go @@ -17,14 +17,16 @@ import ( // 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 -// 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 -// account to the default value as provisioned by the Amazon Web Services service -// team. +// 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 GetServiceSetting API operation to +// view the current value. Use the UpdateServiceSettingAPI operation to change the default setting. +// +// Reset the service setting for the account to the default value as provisioned +// by the Amazon Web Services service team. func (c *Client) ResetServiceSetting(ctx context.Context, params *ResetServiceSettingInput, optFns ...func(*Options)) (*ResetServiceSettingOutput, error) { if params == nil { params = &ResetServiceSettingInput{} @@ -45,13 +47,21 @@ 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 // // This member is required. diff --git a/service/ssm/api_op_ResumeSession.go b/service/ssm/api_op_ResumeSession.go index 8a534e53e5a..3a018907768 100644 --- a/service/ssm/api_op_ResumeSession.go +++ b/service/ssm/api_op_ResumeSession.go @@ -12,9 +12,10 @@ import ( // Reconnects a session to a managed node after it has been disconnected. // Connections can be resumed for disconnected sessions, but not terminated -// sessions. This command is primarily for use by client machines to automatically -// reconnect during intermittent network issues. It isn't intended for any other -// use. +// sessions. +// +// This command is primarily for use by client machines to automatically reconnect +// during intermittent network issues. It isn't intended for any other use. func (c *Client) ResumeSession(ctx context.Context, params *ResumeSessionInput, optFns ...func(*Options)) (*ResumeSessionOutput, error) { if params == nil { params = &ResumeSessionInput{} @@ -48,12 +49,17 @@ type ResumeSessionOutput struct { // 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 + // . + // + // 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]in the Amazon Web Services General Reference. + // + // session-id represents the ID of a Session Manager session, such as + // 1a2b3c4dEXAMPLE . + // + // [Systems Manager service endpoints]: https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region 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 a389f7c7c93..3ef3c5bb17d 100644 --- a/service/ssm/api_op_SendAutomationSignal.go +++ b/service/ssm/api_op_SendAutomationSignal.go @@ -42,13 +42,22 @@ type SendAutomationSignalInput struct { SignalType types.SignalType // The data sent with the signal. The data schema depends on the type of signal - // used in the request. For Approve and Reject signal types, the payload is an - // optional comment that you can send with the signal type. For example: - // Comment="Looks good" For StartStep and Resume signal types, you must send the - // name of the Automation step to start or resume as the payload. For example: - // StepName="step1" For the StopStep signal type, you must send the step execution - // ID as the payload. For example: - // StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab" + // used in the request. + // + // For Approve and Reject signal types, the payload is an optional comment that + // you can send with the signal type. For example: + // + // Comment="Looks good" + // + // For StartStep and Resume signal types, you must send the name of the Automation + // step to start or resume as the payload. For example: + // + // StepName="step1" + // + // For the StopStep signal type, you must send the step execution ID as the + // payload. For example: + // + // StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab" Payload map[string][]string noSmithyDocumentSerde diff --git a/service/ssm/api_op_SendCommand.go b/service/ssm/api_op_SendCommand.go index 01a6221852a..72dbf40c9bc 100644 --- a/service/ssm/api_op_SendCommand.go +++ b/service/ssm/api_op_SendCommand.go @@ -32,11 +32,13 @@ type SendCommandInput struct { // The name of the Amazon Web Services Systems Manager document (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 Amazon Resource Name - // (ARN). For more information about how to use shared documents, see Sharing 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. + // (ARN). For more information about how to use shared documents, see [Sharing SSM documents]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. + // + // [Sharing SSM documents]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html // // This member is required. DocumentName *string @@ -54,44 +56,59 @@ type SendCommandInput struct { Comment *string // The Sha256 or Sha1 hash created by the system when the document was created. + // // Sha1 hashes have been deprecated. DocumentHash *string - // Sha256 or Sha1. Sha1 hashes have been deprecated. + // Sha256 or Sha1. + // + // Sha1 hashes have been deprecated. DocumentHashType types.DocumentHashType // The 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 Command // Line Interface (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" + // need to use the backslash. For example: + // + // --document-version "\$DEFAULT" + // + // --document-version "\$LATEST" + // + // --document-version "3" DocumentVersion *string // The IDs of the managed nodes where the command should run. Specifying managed // 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 - // 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 Run commands at scale (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) - // in the Amazon Web Services Systems Manager User Guide. + // 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 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 [Run commands at scale] in the Amazon Web Services + // Systems Manager User Guide. + // + // [Run commands at scale]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html 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) - // in the Amazon Web Services Systems Manager User Guide. + // MaxConcurrency , see [Using concurrency controls] in the Amazon Web Services Systems Manager User Guide. + // + // [Using concurrency controls]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity 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 // 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) - // in the Amazon Web Services Systems Manager User Guide. + // use MaxErrors , see [Using error controls] in the Amazon Web Services Systems Manager User Guide. + // + // [Using error controls]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors MaxErrors *string // Configurations for sending notifications. @@ -114,20 +131,28 @@ type SendCommandInput struct { // The ARN of the Identity and Access Management (IAM) service role to use to // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon + // Web Services Systems Manager User Guide. + // + // [Monitoring Systems Manager status changes using Amazon SNS notifications]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html 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 // 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 Run commands at scale (https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html) - // in the Amazon Web Services Systems Manager User Guide. + // 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 [Run commands at scale] in the Amazon Web Services + // Systems Manager User Guide. + // + // [Run commands at scale]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html Targets []types.Target // If this time is reached and the command hasn't already started running, it diff --git a/service/ssm/api_op_StartAutomationExecution.go b/service/ssm/api_op_StartAutomationExecution.go index 1de608636d2..772c23c79f6 100644 --- a/service/ssm/api_op_StartAutomationExecution.go +++ b/service/ssm/api_op_StartAutomationExecution.go @@ -31,9 +31,10 @@ 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 - // Sharing SSM documents (https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html) - // in the Amazon Web Services Systems Manager User Guide. + // document ARN. For more information about how to use shared documents, see [Sharing SSM documents]in + // the Amazon Web Services Systems Manager User Guide. + // + // [Sharing SSM documents]: https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html // // This member is required. DocumentName *string @@ -61,10 +62,12 @@ type StartAutomationExecutionInput struct { // automation on additional targets after the first error result is returned. If // you run an automation on 50 resources and set max-errors to 10%, then the system // stops running the automation on additional targets when the sixth error is - // received. Executions that are already running an automation when max-errors 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 max-concurrency to 1 so the executions proceed one at a time. + // received. + // + // Executions that are already running an automation when max-errors 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 + // max-concurrency to 1 so the executions proceed one at a time. MaxErrors *string // The execution mode of the automation. Valid modes include the following: Auto @@ -80,17 +83,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. 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) - // in the Amazon Web Services Systems Manager User Guide. + // Web Services accounts. For more information, see [Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts]in the Amazon Web Services + // Systems Manager User Guide. + // + // [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 TargetLocations []types.TargetLocation // A key-value mapping of document parameters to target resources. Both Targets diff --git a/service/ssm/api_op_StartChangeRequestExecution.go b/service/ssm/api_op_StartChangeRequestExecution.go index a9a7715b7f5..b75a7cd0081 100644 --- a/service/ssm/api_op_StartChangeRequestExecution.go +++ b/service/ssm/api_op_StartChangeRequestExecution.go @@ -38,20 +38,25 @@ type StartChangeRequestExecutionInput struct { DocumentName *string // Information about the Automation runbooks that are run during the runbook - // workflow. The Automation runbooks specified for the runbook workflow can't run - // until all required approvals for the change request have been received. + // workflow. + // + // The Automation runbooks specified for the runbook workflow can't run until all + // required approvals for the change request have been received. // // This member is required. Runbooks []types.Runbook // 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 - // run. If they don't, the change won't be processed until the calendar state is - // again OPEN . + // 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 run. If they don't, the change won't be + // processed until the calendar state is again OPEN . AutoApprove bool // User-provided details about the change. If no details are provided, content @@ -79,8 +84,10 @@ type StartChangeRequestExecutionInput struct { ScheduledEndTime *time.Time // The date and time specified in the change request to run the Automation - // runbooks. The Automation runbooks specified for the runbook workflow can't run - // until all required approvals for the change request have been received. + // runbooks. + // + // The Automation runbooks specified for the runbook workflow can't run until all + // required approvals for the change request have been received. ScheduledTime *time.Time // Optional metadata that you assign to a resource. You can specify a maximum of @@ -89,7 +96,9 @@ 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 Tags []types.Tag diff --git a/service/ssm/api_op_StartSession.go b/service/ssm/api_op_StartSession.go index b4b6e65be55..97b0abe38d5 100644 --- a/service/ssm/api_op_StartSession.go +++ b/service/ssm/api_op_StartSession.go @@ -12,14 +12,18 @@ 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) -// 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. +// 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]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. +// +// [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 func (c *Client) StartSession(ctx context.Context, params *StartSessionInput, optFns ...func(*Options)) (*StartSessionOutput, error) { if params == nil { params = &StartSessionInput{} @@ -44,11 +48,12 @@ 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 - // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in + // the Amazon Web Services Systems Manager User Guide. + // + // [Start a session]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html DocumentName *string // The values you want to specify for the parameters defined in the Session @@ -71,12 +76,16 @@ type StartSessionOutput struct { // 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]in the Amazon Web Services General Reference. + // + // session-id represents the ID of a Session Manager session, such as + // 1a2b3c4dEXAMPLE . + // + // [Systems Manager service endpoints]: https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region StreamUrl *string // An encrypted token value containing session and caller information. This token diff --git a/service/ssm/api_op_UnlabelParameterVersion.go b/service/ssm/api_op_UnlabelParameterVersion.go index 12c7c6f0c33..0e90e58dcec 100644 --- a/service/ssm/api_op_UnlabelParameterVersion.go +++ b/service/ssm/api_op_UnlabelParameterVersion.go @@ -33,9 +33,10 @@ type UnlabelParameterVersionInput struct { // This member is required. Labels []string - // The name of the parameter from which you want to delete one or more labels. You - // can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter - // name itself. + // The name of the parameter from which you want to delete one or more labels. + // + // You can't enter the Amazon Resource Name (ARN) for a parameter, only the + // parameter name itself. // // This member is required. Name *string diff --git a/service/ssm/api_op_UpdateAssociation.go b/service/ssm/api_op_UpdateAssociation.go index 0ff8a988dd5..2d15edf1dab 100644 --- a/service/ssm/api_op_UpdateAssociation.go +++ b/service/ssm/api_op_UpdateAssociation.go @@ -18,15 +18,17 @@ import ( // 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 // includes the Name parameter. Before calling this API action, we recommend that -// you call the DescribeAssociation API operation and make a note of all optional -// 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 +// you call the DescribeAssociationAPI operation and make a note of all optional 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 DescribeAssociationAPI operation. If you don't have permission to call // 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 -// update an association, the association immediately runs against the specified -// targets. You can add the ApplyOnlyAtCronInterval parameter to run the +// 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. func (c *Client) UpdateAssociation(ctx context.Context, params *UpdateAssociationInput, optFns ...func(*Options)) (*UpdateAssociationOutput, error) { if params == nil { @@ -57,19 +59,22 @@ type UpdateAssociationInput struct { // 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. + // 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. @@ -88,44 +93,51 @@ 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) - // . + // change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar]. + // + // [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 to assign to the association. ComplianceSeverity types.AssociationComplianceSeverity - // The document version you want update for the association. 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 . + // The document version you want update for the association. + // + // 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 . DocumentVersion *string // The number of hours the association can run before it is canceled. Duration // applies to associations that are currently running, and any pending and in // progress commands on all targets. If a target was taken offline for the // association to run, it is made available again immediately, without a reboot. + // // The Duration parameter applies only when both these conditions are true: + // // - The association for which you specify a duration is cancelable according to // the parameters of the SSM command document or Automation runbook associated with // this execution. - // - The command specifies the ApplyOnlyAtCronInterval (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval) - // parameter, which means that the association doesn't run immediately after it is - // updated, but only according to the specified schedule. + // + // - The command specifies the [ApplyOnlyAtCronInterval]parameter, which means that the association + // doesn't run immediately after it is updated, but only according to the specified + // schedule. + // + // [ApplyOnlyAtCronInterval]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_UpdateAssociation.html#systemsmanager-UpdateAssociation-request-ApplyOnlyAtCronInterval Duration *int32 // 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 - // managed node will process its association within the limit specified for - // MaxConcurrency . + // 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 managed node will process its + // association within the limit specified for MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -135,24 +147,33 @@ type UpdateAssociationInput struct { // 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. + // 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 - // configuration information for the managed node. You can specify Amazon Web - // Services-predefined documents, documents you created, or a document that is - // 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: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 . + // configuration information for the managed node. + // + // You can specify Amazon Web Services-predefined documents, documents you + // created, or a document that is 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: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 . Name *string // An S3 bucket where you want to store the results of this request. @@ -170,22 +191,27 @@ type UpdateAssociationInput struct { // 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) - // 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. + // associations, see [Reference: Cron and rate expressions for Systems Manager]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. + // + // [Reference: Cron and rate expressions for Systems Manager]: https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html ScheduleOffset *int32 // 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 + // 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. + // call to the PutComplianceItemsAPI operation. + // + // By default, all associations use AUTO mode. SyncCompliance types.AssociationSyncCompliance // A location is a combination of Amazon Web Services Regions and Amazon Web diff --git a/service/ssm/api_op_UpdateAssociationStatus.go b/service/ssm/api_op_UpdateAssociationStatus.go index 4afd097061c..c4c1ecceb24 100644 --- a/service/ssm/api_op_UpdateAssociationStatus.go +++ b/service/ssm/api_op_UpdateAssociationStatus.go @@ -12,10 +12,11 @@ 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_UpdateDocument.go b/service/ssm/api_op_UpdateDocument.go index f208b4e2b88..96779599990 100644 --- a/service/ssm/api_op_UpdateDocument.go +++ b/service/ssm/api_op_UpdateDocument.go @@ -54,9 +54,10 @@ type UpdateDocumentInput struct { // The version of the document that you want to update. Currently, Systems Manager // supports updating only the latest version of the document. You can specify the - // version number of the latest version or use the $LATEST variable. If you change - // a document version for a State Manager association, Systems Manager immediately - // runs the association unless you previously specifed the + // version number of the latest version or use the $LATEST variable. + // + // If you change a document version for a State Manager association, Systems + // Manager immediately runs the association unless you previously specifed the // apply-only-at-cron-interval parameter. DocumentVersion *string diff --git a/service/ssm/api_op_UpdateDocumentDefaultVersion.go b/service/ssm/api_op_UpdateDocumentDefaultVersion.go index 615a9052273..9e5fb78040b 100644 --- a/service/ssm/api_op_UpdateDocumentDefaultVersion.go +++ b/service/ssm/api_op_UpdateDocumentDefaultVersion.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Set the default version of a document. If you change a document version for a -// State Manager association, Systems Manager immediately runs the association -// unless you previously specifed the apply-only-at-cron-interval parameter. +// Set the default version of a document. +// +// If you change a document version for a State Manager association, Systems +// Manager immediately runs the association unless you previously specifed the +// apply-only-at-cron-interval parameter. func (c *Client) UpdateDocumentDefaultVersion(ctx context.Context, params *UpdateDocumentDefaultVersionInput, optFns ...func(*Options)) (*UpdateDocumentDefaultVersionOutput, error) { if params == nil { params = &UpdateDocumentDefaultVersionInput{} diff --git a/service/ssm/api_op_UpdateMaintenanceWindow.go b/service/ssm/api_op_UpdateMaintenanceWindow.go index 98d6af463d8..5c55927c490 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindow.go +++ b/service/ssm/api_op_UpdateMaintenanceWindow.go @@ -11,6 +11,7 @@ import ( ) // Updates an existing maintenance window. Only specified parameters are modified. +// // 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 @@ -64,32 +65,39 @@ type UpdateMaintenanceWindowInput struct { // The name of the maintenance window. Name *string - // 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. + // 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 // The schedule of the maintenance window in the form of a cron or rate expression. Schedule *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 the third Tuesday of 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. + // 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 maintenance window won't run until two days + // later. ScheduleOffset *int32 // The time zone that the scheduled maintenance window executions are based 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. + // "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database]on + // the IANA website. + // + // [Time Zone Database]: https://www.iana.org/time-zones 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. When using a rate - // schedule, if you provide a start date that occurs in the past, the current date - // and time are used as the start date. + // of the maintenance window until the specified future date. + // + // When using a rate schedule, if you provide a start date that occurs in the + // past, the current date and time are used as the start date. StartDate *string noSmithyDocumentSerde @@ -131,8 +139,10 @@ type UpdateMaintenanceWindowOutput struct { // The time zone that the scheduled maintenance window executions are based 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. + // "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database]on + // the IANA website. + // + // [Time Zone Database]: https://www.iana.org/time-zones ScheduleTimezone *string // The date and time, in ISO-8601 Extended format, for when the maintenance window diff --git a/service/ssm/api_op_UpdateMaintenanceWindowTarget.go b/service/ssm/api_op_UpdateMaintenanceWindowTarget.go index a9db3c3ea86..c9eed72b0ce 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindowTarget.go +++ b/service/ssm/api_op_UpdateMaintenanceWindowTarget.go @@ -13,13 +13,19 @@ 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 . +// 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) { @@ -59,9 +65,8 @@ type UpdateMaintenanceWindowTargetInput struct { // events raised while running tasks for these targets in this maintenance window. OwnerInformation *string - // 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. + // 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 // The targets to add or replace. diff --git a/service/ssm/api_op_UpdateMaintenanceWindowTask.go b/service/ssm/api_op_UpdateMaintenanceWindowTask.go index 764d88425e4..f830b67cc07 100644 --- a/service/ssm/api_op_UpdateMaintenanceWindowTask.go +++ b/service/ssm/api_op_UpdateMaintenanceWindowTask.go @@ -13,32 +13,41 @@ 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 // // 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 , -// 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. +// running tasks that don't specify targets, see [Registering maintenance window tasks without targets]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 RegisterTaskWithMaintenanceWindowoperation 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 , 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. +// +// [Registering maintenance window tasks without targets]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html func (c *Client) UpdateMaintenanceWindowTask(ctx context.Context, params *UpdateMaintenanceWindowTaskInput, optFns ...func(*Options)) (*UpdateMaintenanceWindowTaskOutput, error) { if params == nil { params = &UpdateMaintenanceWindowTaskInput{} @@ -71,48 +80,62 @@ 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 . + // + // - 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. Description *string - // The new logging location in Amazon S3 to specify. 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 new logging location in Amazon S3 to specify. + // + // 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 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) - // 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 - // running of your task. + // 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]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 running of your task. + // + // [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html 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) - // 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 - // running of your task. + // 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]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 running of your task. + // + // [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html MaxErrors *string // The new task name to specify. @@ -122,9 +145,8 @@ type UpdateMaintenanceWindowTaskInput struct { // priority. Tasks that have the same priority are scheduled in parallel. Priority *int32 - // If True, then all fields that are required by the - // RegisterTaskWithMaintenanceWindow operation are also required for this API - // request. Optional fields that aren't specified are set to null. + // If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required + // for this API request. Optional fields that aren't specified are set to null. Replace *bool // The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services @@ -132,31 +154,36 @@ type UpdateMaintenanceWindowTaskInput struct { // specify a service role ARN, Systems Manager uses a service-linked role in your // account. If no appropriate service-linked role for Systems Manager exists in // your account, it is created when you run RegisterTaskWithMaintenanceWindow . + // // However, for an improved security posture, we strongly recommend creating a // custom policy and custom service role for running your maintenance window tasks. // The policy can be crafted to provide only the permissions needed for your - // particular maintenance window tasks. For more information, see Setting up - // maintenance windows (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html) - // in the in the Amazon Web Services Systems Manager User Guide. + // particular maintenance window tasks. For more information, see [Setting up maintenance windows]in the in the + // Amazon Web Services Systems Manager User Guide. + // + // [Setting up maintenance windows]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html 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 - // 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. + // 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]in the Amazon Web Services + // Systems Manager User Guide. + // + // [Registering maintenance window tasks without targets]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html Targets []types.Target // The task ARN to modify. TaskArn *string // 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 + // 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 values that you want to retain. The values you don't // specify again are removed. For example, suppose that when you registered a Run @@ -166,13 +193,18 @@ type UpdateMaintenanceWindowTaskInput struct { // 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 + // 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 TaskParameters map[string]types.MaintenanceWindowTaskParameterValueExpression noSmithyDocumentSerde @@ -191,12 +223,13 @@ type UpdateMaintenanceWindowTaskOutput struct { // The updated task description. Description *string - // The updated logging information in Amazon S3. 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 updated logging information in Amazon S3. + // + // 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 updated MaxConcurrency value. @@ -225,11 +258,12 @@ type UpdateMaintenanceWindowTaskOutput struct { // The updated parameter values. TaskInvocationParameters *types.MaintenanceWindowTaskInvocationParameters - // The updated parameter values. 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 updated parameter values. + // + // 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. 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 db27b3dcea1..b6566abf1bc 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{} @@ -34,10 +34,13 @@ 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 and - // multicloud 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. + // . For more information, see [Create an IAM service role for a hybrid and multicloud environment]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. + // + // [Create an IAM service role for a hybrid and multicloud environment]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html // // This member is required. IamRole *string diff --git a/service/ssm/api_op_UpdateOpsItem.go b/service/ssm/api_op_UpdateOpsItem.go index 4c985ea3c97..b65f279a3d6 100644 --- a/service/ssm/api_op_UpdateOpsItem.go +++ b/service/ssm/api_op_UpdateOpsItem.go @@ -13,14 +13,16 @@ import ( ) // Edit or change an OpsItem. You must have permission in Identity and Access -// Management (IAM) to update an OpsItem. For more information, see Set up -// OpsCenter (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.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. +// Management (IAM) to update an OpsItem. For more information, see [Set up OpsCenter]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]in the Amazon Web Services Systems Manager User Guide. +// +// [Amazon Web Services Systems Manager OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html +// [Set up OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html func (c *Client) UpdateOpsItem(ctx context.Context, params *UpdateOpsItemInput, optFns ...func(*Options)) (*UpdateOpsItemOutput, error) { if params == nil { params = &UpdateOpsItemInput{} @@ -63,23 +65,31 @@ type UpdateOpsItemInput struct { Notifications []types.OpsItemNotification // Add new keys or edit existing key-value pairs of the OperationalData map in the - // OpsItem object. 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-manually-create-OpsItems.html) - // in the Amazon Web Services Systems Manager User Guide. + // OpsItem object. + // + // 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 DescribeOpsItemsAPI 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 GetOpsItemAPI + // 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]in the Amazon Web Services Systems Manager + // User Guide. + // + // [Creating OpsItems manually]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html OperationalData map[string]types.OpsItemDataValue // Keys that you want to remove from the OperationalData map. @@ -108,8 +118,9 @@ type UpdateOpsItemInput struct { 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-editing-details.html) - // in the Amazon Web Services Systems Manager User Guide. + // information, see [Editing OpsItem details]in the Amazon Web Services Systems Manager User Guide. + // + // [Editing OpsItem details]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html Status types.OpsItemStatus // A short heading that describes the nature of the OpsItem and the impacted diff --git a/service/ssm/api_op_UpdatePatchBaseline.go b/service/ssm/api_op_UpdatePatchBaseline.go index 86da96ed11c..e2fe0ac4fb4 100644 --- a/service/ssm/api_op_UpdatePatchBaseline.go +++ b/service/ssm/api_op_UpdatePatchBaseline.go @@ -13,8 +13,10 @@ 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 . +// left unchanged. +// +// For information about valid key-value pairs in PatchFilters for 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{} @@ -40,10 +42,12 @@ type UpdatePatchBaselineInput struct { // A set of rules used to include patches in the baseline. ApprovalRules *types.PatchRuleGroup - // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [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 ApprovedPatches []string // Assigns a new compliance severity level to an existing patch baseline. @@ -63,18 +67,22 @@ type UpdatePatchBaselineInput struct { // The name of the patch baseline. Name *string - // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [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 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 Rejected patches list, and packages that include // them as dependencies, aren't installed by Patch Manager under any circumstances. // If a package was installed before it was added to the Rejected patches list, or @@ -82,9 +90,8 @@ type UpdatePatchBaselineInput struct { // 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 - // are also required for this API request. Optional fields that aren't specified - // are set to null. + // If True, then all fields that are required by the CreatePatchBaseline operation are also required + // for this API request. Optional fields that aren't specified are set to null. Replace *bool // Information about the patches to use to update the managed nodes, including diff --git a/service/ssm/api_op_UpdateResourceDataSync.go b/service/ssm/api_op_UpdateResourceDataSync.go index 51cd80d9592..995aa8f0739 100644 --- a/service/ssm/api_op_UpdateResourceDataSync.go +++ b/service/ssm/api_op_UpdateResourceDataSync.go @@ -16,8 +16,9 @@ import ( // 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 +// 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 { diff --git a/service/ssm/api_op_UpdateServiceSetting.go b/service/ssm/api_op_UpdateServiceSetting.go index 5e344ddc124..ef802804a20 100644 --- a/service/ssm/api_op_UpdateServiceSetting.go +++ b/service/ssm/api_op_UpdateServiceSetting.go @@ -16,13 +16,16 @@ import ( // 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 -// 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 -// service team. Update the service setting for the account. +// 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 GetServiceSetting API operation to +// view the current value. Or, use the ResetServiceSettingto change the value back to the original +// value defined by the Amazon Web Services service team. +// +// Update the service setting for the account. func (c *Client) UpdateServiceSetting(ctx context.Context, params *UpdateServiceSettingInput, optFns ...func(*Options)) (*UpdateServiceSettingOutput, error) { if params == nil { params = &UpdateServiceSettingInput{} @@ -44,14 +47,23 @@ 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 + // // 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 @@ -62,17 +74,25 @@ type UpdateServiceSettingInput struct { // The new value to specify for the service setting. The following list specifies // the available values for each setting. + // // - For /ssm/managed-instance/default-ec2-instance-management-role , enter the // name of an IAM role. + // // - For /ssm/automation/customer-script-log-destination , enter CloudWatch . + // // - For /ssm/automation/customer-script-log-group-name , enter the name of an // Amazon CloudWatch Logs log group. + // // - For /ssm/documents/console/public-sharing-permission , enter Enable or // Disable . + // // - For /ssm/managed-instance/activation-tier , enter standard or advanced . + // // - For /ssm/opsinsights/opscenter , enter Enabled or Disabled . + // // - For /ssm/parameter-store/default-parameter-tier , enter Standard , Advanced // , or Intelligent-Tiering + // // - For /ssm/parameter-store/high-throughput-enabled , enter true or false . // // This member is required. diff --git a/service/ssm/doc.go b/service/ssm/doc.go index e546b70849f..02f238c371f 100644 --- a/service/ssm/doc.go +++ b/service/ssm/doc.go @@ -6,23 +6,29 @@ // Amazon Web Services Systems Manager is the operations hub for your Amazon Web // 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 +// +// This reference is intended to be used with the [Amazon Web Services Systems Manager User Guide]. To get started, see [Setting up Amazon Web Services Systems Manager]. +// +// Related resources +// // - For information about each of the capabilities that comprise Systems -// Manager, see Systems Manager capabilities (https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities) -// in the Amazon Web Services Systems Manager User Guide. +// Manager, see [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/) -// . +// Amazon Web Services Systems Manager, see the [Systems Manager Automation runbook reference]. +// +// - For information about AppConfig, a capability of Systems Manager, see the [AppConfig User Guide] +// and the [AppConfig API Reference]. +// // - 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/) -// . +// see the [Systems Manager Incident Manager User Guide]and the [Systems Manager Incident Manager API Reference]. +// +// [Amazon Web Services Systems Manager User Guide]: https://docs.aws.amazon.com/systems-manager/latest/userguide/ +// [AppConfig User Guide]: https://docs.aws.amazon.com/appconfig/latest/userguide/ +// [Systems Manager Automation runbook reference]: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html +// [AppConfig API Reference]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/ +// [Systems Manager Incident Manager API Reference]: https://docs.aws.amazon.com/incident-manager/latest/APIReference/ +// [Setting up Amazon Web Services Systems Manager]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html +// [Systems Manager Incident Manager User Guide]: https://docs.aws.amazon.com/incident-manager/latest/userguide/ +// [Systems Manager capabilities]: https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities package ssm diff --git a/service/ssm/options.go b/service/ssm/options.go index 197dfd32601..2ee31aad666 100644 --- a/service/ssm/options.go +++ b/service/ssm/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ssm/types/enums.go b/service/ssm/types/enums.go index 5b42c1e18f3..50f86176097 100644 --- a/service/ssm/types/enums.go +++ b/service/ssm/types/enums.go @@ -15,8 +15,9 @@ const ( // Values returns all known values for AssociationComplianceSeverity. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationComplianceSeverity) Values() []AssociationComplianceSeverity { return []AssociationComplianceSeverity{ "CRITICAL", @@ -38,8 +39,9 @@ const ( // Values returns all known values for AssociationExecutionFilterKey. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationExecutionFilterKey) Values() []AssociationExecutionFilterKey { return []AssociationExecutionFilterKey{ "ExecutionId", @@ -59,8 +61,9 @@ const ( // Values returns all known values for AssociationExecutionTargetsFilterKey. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationExecutionTargetsFilterKey) Values() []AssociationExecutionTargetsFilterKey { return []AssociationExecutionTargetsFilterKey{ "Status", @@ -84,8 +87,9 @@ const ( ) // Values returns all known values for AssociationFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationFilterKey) Values() []AssociationFilterKey { return []AssociationFilterKey{ "InstanceId", @@ -110,8 +114,9 @@ const ( // Values returns all known values for AssociationFilterOperatorType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationFilterOperatorType) Values() []AssociationFilterOperatorType { return []AssociationFilterOperatorType{ "EQUAL", @@ -130,8 +135,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Pending", @@ -150,6 +156,7 @@ const ( // Values returns all known values for AssociationSyncCompliance. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AssociationSyncCompliance) Values() []AssociationSyncCompliance { return []AssociationSyncCompliance{ @@ -166,8 +173,9 @@ const ( ) // Values returns all known values for AttachmentHashType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentHashType) Values() []AttachmentHashType { return []AttachmentHashType{ "Sha256", @@ -184,8 +192,9 @@ const ( ) // Values returns all known values for AttachmentsSourceKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AttachmentsSourceKey) Values() []AttachmentsSourceKey { return []AttachmentsSourceKey{ "SourceUrl", @@ -214,8 +223,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomationExecutionFilterKey) Values() []AutomationExecutionFilterKey { return []AutomationExecutionFilterKey{ "DocumentNamePrefix", @@ -260,6 +270,7 @@ const ( // Values returns all known values for AutomationExecutionStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AutomationExecutionStatus) Values() []AutomationExecutionStatus { return []AutomationExecutionStatus{ @@ -293,8 +304,9 @@ const ( ) // Values returns all known values for AutomationSubtype. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomationSubtype) Values() []AutomationSubtype { return []AutomationSubtype{ "ChangeRequest", @@ -310,8 +322,9 @@ const ( ) // Values returns all known values for AutomationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutomationType) Values() []AutomationType { return []AutomationType{ "CrossAccount", @@ -328,8 +341,9 @@ const ( ) // Values returns all known values for CalendarState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CalendarState) Values() []CalendarState { return []CalendarState{ "OPEN", @@ -349,8 +363,9 @@ const ( ) // Values returns all known values for CommandFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommandFilterKey) Values() []CommandFilterKey { return []CommandFilterKey{ "InvokedAfter", @@ -376,8 +391,9 @@ const ( ) // Values returns all known values for CommandInvocationStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommandInvocationStatus) Values() []CommandInvocationStatus { return []CommandInvocationStatus{ "Pending", @@ -404,8 +420,9 @@ const ( ) // Values returns all known values for CommandPluginStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommandPluginStatus) Values() []CommandPluginStatus { return []CommandPluginStatus{ "Pending", @@ -431,8 +448,9 @@ const ( ) // Values returns all known values for CommandStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommandStatus) Values() []CommandStatus { return []CommandStatus{ "Pending", @@ -458,6 +476,7 @@ const ( // Values returns all known values for ComplianceQueryOperatorType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceQueryOperatorType) Values() []ComplianceQueryOperatorType { return []ComplianceQueryOperatorType{ @@ -482,8 +501,9 @@ const ( ) // Values returns all known values for ComplianceSeverity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceSeverity) Values() []ComplianceSeverity { return []ComplianceSeverity{ "CRITICAL", @@ -504,8 +524,9 @@ const ( ) // Values returns all known values for ComplianceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceStatus) Values() []ComplianceStatus { return []ComplianceStatus{ "COMPLIANT", @@ -522,8 +543,9 @@ const ( ) // Values returns all known values for ComplianceUploadType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComplianceUploadType) Values() []ComplianceUploadType { return []ComplianceUploadType{ "COMPLETE", @@ -540,8 +562,9 @@ const ( ) // Values returns all known values for ConnectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionStatus) Values() []ConnectionStatus { return []ConnectionStatus{ "connected", @@ -560,8 +583,9 @@ const ( // Values returns all known values for DescribeActivationsFilterKeys. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DescribeActivationsFilterKeys) Values() []DescribeActivationsFilterKeys { return []DescribeActivationsFilterKeys{ "ActivationIds", @@ -581,8 +605,9 @@ const ( ) // Values returns all known values for DocumentFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentFilterKey) Values() []DocumentFilterKey { return []DocumentFilterKey{ "Name", @@ -602,8 +627,9 @@ const ( ) // Values returns all known values for DocumentFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentFormat) Values() []DocumentFormat { return []DocumentFormat{ "YAML", @@ -621,8 +647,9 @@ const ( ) // Values returns all known values for DocumentHashType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentHashType) Values() []DocumentHashType { return []DocumentHashType{ "Sha256", @@ -638,8 +665,9 @@ const ( ) // Values returns all known values for DocumentMetadataEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentMetadataEnum) Values() []DocumentMetadataEnum { return []DocumentMetadataEnum{ "DocumentReviews", @@ -655,8 +683,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "String", @@ -672,8 +701,9 @@ const ( ) // Values returns all known values for DocumentPermissionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentPermissionType) Values() []DocumentPermissionType { return []DocumentPermissionType{ "Share", @@ -691,8 +721,9 @@ const ( ) // Values returns all known values for DocumentReviewAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentReviewAction) Values() []DocumentReviewAction { return []DocumentReviewAction{ "SendForReview", @@ -711,6 +742,7 @@ const ( // Values returns all known values for DocumentReviewCommentType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DocumentReviewCommentType) Values() []DocumentReviewCommentType { return []DocumentReviewCommentType{ @@ -730,8 +762,9 @@ const ( ) // Values returns all known values for DocumentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentStatus) Values() []DocumentStatus { return []DocumentStatus{ "Creating", @@ -764,8 +797,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -795,8 +829,9 @@ const ( ) // Values returns all known values for ExecutionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionMode) Values() []ExecutionMode { return []ExecutionMode{ "Auto", @@ -813,8 +848,9 @@ const ( ) // Values returns all known values for ExternalAlarmState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExternalAlarmState) Values() []ExternalAlarmState { return []ExternalAlarmState{ "UNKNOWN", @@ -832,8 +868,9 @@ const ( ) // 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. +// the future, and so 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{ "Client", @@ -858,8 +895,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceInformationFilterKey) Values() []InstanceInformationFilterKey { return []InstanceInformationFilterKey{ "InstanceIds", @@ -885,8 +923,9 @@ const ( // Values returns all known values for InstancePatchStateOperatorType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstancePatchStateOperatorType) Values() []InstancePatchStateOperatorType { return []InstancePatchStateOperatorType{ "Equal", @@ -913,6 +952,7 @@ const ( // Values returns all known values for InstancePropertyFilterKey. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InstancePropertyFilterKey) Values() []InstancePropertyFilterKey { return []InstancePropertyFilterKey{ @@ -941,8 +981,9 @@ const ( // Values returns all known values for InstancePropertyFilterOperator. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstancePropertyFilterOperator) Values() []InstancePropertyFilterOperator { return []InstancePropertyFilterOperator{ "Equal", @@ -963,6 +1004,7 @@ const ( // Values returns all known values for InventoryAttributeDataType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InventoryAttributeDataType) Values() []InventoryAttributeDataType { return []InventoryAttributeDataType{ @@ -980,8 +1022,9 @@ const ( ) // Values returns all known values for InventoryDeletionStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InventoryDeletionStatus) Values() []InventoryDeletionStatus { return []InventoryDeletionStatus{ "InProgress", @@ -1003,6 +1046,7 @@ const ( // Values returns all known values for InventoryQueryOperatorType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InventoryQueryOperatorType) Values() []InventoryQueryOperatorType { return []InventoryQueryOperatorType{ @@ -1025,6 +1069,7 @@ const ( // Values returns all known values for InventorySchemaDeleteOption. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (InventorySchemaDeleteOption) Values() []InventorySchemaDeleteOption { return []InventorySchemaDeleteOption{ @@ -1044,6 +1089,7 @@ const ( // Values returns all known values for LastResourceDataSyncStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LastResourceDataSyncStatus) Values() []LastResourceDataSyncStatus { return []LastResourceDataSyncStatus{ @@ -1069,8 +1115,9 @@ const ( // Values returns all known values for MaintenanceWindowExecutionStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceWindowExecutionStatus) Values() []MaintenanceWindowExecutionStatus { return []MaintenanceWindowExecutionStatus{ "PENDING", @@ -1094,8 +1141,9 @@ const ( // Values returns all known values for MaintenanceWindowResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceWindowResourceType) Values() []MaintenanceWindowResourceType { return []MaintenanceWindowResourceType{ "INSTANCE", @@ -1113,8 +1161,9 @@ const ( // Values returns all known values for MaintenanceWindowTaskCutoffBehavior. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceWindowTaskCutoffBehavior) Values() []MaintenanceWindowTaskCutoffBehavior { return []MaintenanceWindowTaskCutoffBehavior{ "CONTINUE_TASK", @@ -1134,6 +1183,7 @@ const ( // Values returns all known values for MaintenanceWindowTaskType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceWindowTaskType) Values() []MaintenanceWindowTaskType { return []MaintenanceWindowTaskType{ @@ -1157,8 +1207,9 @@ const ( ) // Values returns all known values for NotificationEvent. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationEvent) Values() []NotificationEvent { return []NotificationEvent{ "All", @@ -1179,8 +1230,9 @@ const ( ) // Values returns all known values for NotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationType) Values() []NotificationType { return []NotificationType{ "Command", @@ -1210,8 +1262,9 @@ const ( ) // Values returns all known values for OperatingSystem. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperatingSystem) Values() []OperatingSystem { return []OperatingSystem{ "WINDOWS", @@ -1245,8 +1298,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Equal", @@ -1267,8 +1321,9 @@ const ( ) // Values returns all known values for OpsItemDataType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpsItemDataType) Values() []OpsItemDataType { return []OpsItemDataType{ "SearchableString", @@ -1284,8 +1339,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "OpsItemId", @@ -1301,6 +1357,7 @@ const ( // Values returns all known values for OpsItemEventFilterOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OpsItemEventFilterOperator) Values() []OpsItemEventFilterOperator { return []OpsItemEventFilterOperator{ @@ -1343,8 +1400,9 @@ const ( ) // Values returns all known values for OpsItemFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpsItemFilterKey) Values() []OpsItemFilterKey { return []OpsItemFilterKey{ "Status", @@ -1389,8 +1447,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "Equal", @@ -1411,8 +1470,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpsItemRelatedItemsFilterKey) Values() []OpsItemRelatedItemsFilterKey { return []OpsItemRelatedItemsFilterKey{ "ResourceType", @@ -1430,8 +1490,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpsItemRelatedItemsFilterOperator) Values() []OpsItemRelatedItemsFilterOperator { return []OpsItemRelatedItemsFilterOperator{ "Equal", @@ -1464,8 +1525,9 @@ const ( ) // Values returns all known values for OpsItemStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpsItemStatus) Values() []OpsItemStatus { return []OpsItemStatus{ "Open", @@ -1500,8 +1562,9 @@ const ( ) // Values returns all known values for ParametersFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParametersFilterKey) Values() []ParametersFilterKey { return []ParametersFilterKey{ "Name", @@ -1520,8 +1583,9 @@ const ( ) // Values returns all known values for ParameterTier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterTier) Values() []ParameterTier { return []ParameterTier{ "Standard", @@ -1540,8 +1604,9 @@ const ( ) // Values returns all known values for ParameterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterType) Values() []ParameterType { return []ParameterType{ "String", @@ -1559,8 +1624,9 @@ const ( ) // Values returns all known values for PatchAction. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchAction) Values() []PatchAction { return []PatchAction{ "ALLOW_AS_DEPENDENCY", @@ -1583,6 +1649,7 @@ const ( // 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{ @@ -1609,8 +1676,9 @@ const ( ) // Values returns all known values for PatchComplianceLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchComplianceLevel) Values() []PatchComplianceLevel { return []PatchComplianceLevel{ "CRITICAL", @@ -1633,8 +1701,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "APPROVED", @@ -1670,8 +1739,9 @@ const ( ) // Values returns all known values for PatchFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchFilterKey) Values() []PatchFilterKey { return []PatchFilterKey{ "ARCH", @@ -1705,8 +1775,9 @@ const ( ) // Values returns all known values for PatchOperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchOperationType) Values() []PatchOperationType { return []PatchOperationType{ "Scan", @@ -1727,8 +1798,9 @@ const ( ) // Values returns all known values for PatchProperty. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchProperty) Values() []PatchProperty { return []PatchProperty{ "PRODUCT", @@ -1749,8 +1821,9 @@ const ( ) // Values returns all known values for PatchSet. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PatchSet) Values() []PatchSet { return []PatchSet{ "OS", @@ -1768,8 +1841,9 @@ const ( ) // Values returns all known values for PingStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PingStatus) Values() []PingStatus { return []PingStatus{ "Online", @@ -1788,8 +1862,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1807,8 +1882,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1825,6 +1901,7 @@ const ( // 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{ @@ -1841,8 +1918,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1866,8 +1944,9 @@ const ( ) // Values returns all known values for ResourceTypeForTagging. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceTypeForTagging) Values() []ResourceTypeForTagging { return []ResourceTypeForTagging{ "Document", @@ -1893,8 +1972,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1917,8 +1997,9 @@ const ( ) // Values returns all known values for SessionFilterKey. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionFilterKey) Values() []SessionFilterKey { return []SessionFilterKey{ "InvokedAfter", @@ -1939,8 +2020,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1961,8 +2043,9 @@ const ( ) // Values returns all known values for SessionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SessionStatus) Values() []SessionStatus { return []SessionStatus{ "Connected", @@ -1986,8 +2069,9 @@ const ( ) // Values returns all known values for SignalType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignalType) Values() []SignalType { return []SignalType{ "Approve", @@ -2008,8 +2092,9 @@ const ( ) // Values returns all known values for SourceType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SourceType) Values() []SourceType { return []SourceType{ "AWS::EC2::Instance", @@ -2034,8 +2119,9 @@ const ( ) // Values returns all known values for StepExecutionFilterKey. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StepExecutionFilterKey) Values() []StepExecutionFilterKey { return []StepExecutionFilterKey{ "StartTimeBefore", @@ -2059,8 +2145,9 @@ const ( ) // Values returns all known values for StopType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StopType) Values() []StopType { return []StopType{ "Complete", diff --git a/service/ssm/types/errors.go b/service/ssm/types/errors.go index f290d400854..f7d8d80fa09 100644 --- a/service/ssm/types/errors.go +++ b/service/ssm/types/errors.go @@ -474,10 +474,12 @@ func (e *DocumentLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy.F // The document can't be shared with more Amazon Web Services accounts. You can // specify a maximum of 20 accounts per API operation to share a private document. +// // By default, you can share a private document with a maximum of 1,000 accounts -// and publicly share up to five documents. If you need to increase the quota for -// privately or publicly shared Systems Manager documents, contact Amazon Web -// Services Support. +// and publicly share up to five documents. +// +// If you need to increase the quota for privately or publicly shared Systems +// Manager documents, contact Amazon Web Services Support. type DocumentPermissionLimit struct { Message *string @@ -531,9 +533,12 @@ func (e *DocumentVersionLimitExceeded) ErrorCode() string { func (e *DocumentVersionLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// window or patch baseline, doesn't exist. +// +// For information about resource quotas in Amazon Web Services Systems Manager, +// see [Systems Manager service quotas]in the Amazon Web Services General Reference. +// +// [Systems Manager service quotas]: https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm type DoesNotExistException struct { Message *string @@ -666,9 +671,10 @@ 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) -// in the Amazon Web Services Systems Manager User Guide. +// A hierarchy can have a maximum of 15 levels. For more information, see [Requirements and constraints for parameter names] in the +// Amazon Web Services Systems Manager User Guide. +// +// [Requirements and constraints for parameter names]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html type HierarchyLevelLimitExceededException struct { Message *string @@ -1398,11 +1404,15 @@ 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 a valid state. Valid states are: Running , Pending // , Stopped , and Stopping . Invalid states are: Shutting-down and Terminated . type InvalidInstanceId struct { @@ -1970,9 +1980,10 @@ 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 -// Monitoring Systems Manager status changes using Amazon SNS notifications (https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html) +// information about configuring the IAM role for Run Command notifications, see [Monitoring Systems Manager status changes using Amazon SNS notifications] // in the Amazon Web Services Systems Manager User Guide. +// +// [Monitoring Systems Manager status changes using Amazon SNS notifications]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html type InvalidRole struct { Message *string @@ -2743,18 +2754,22 @@ func (e *ParameterLimitExceeded) ErrorFault() smithy.ErrorFault { return smithy. // After this number of versions has been created, Parameter Store deletes the // oldest version when a new one is created. However, if the oldest version has a // label attached to it, Parameter Store won't delete the version and instead -// presents this error message: An error occurred -// (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You -// attempted to create a new version of parameter-name by calling the PutParameter -// API with the overwrite flag. Version version-number, the oldest version, can't -// be deleted because it has a label associated with it. Move the label to another -// version of the parameter, and try again. This safeguard is to prevent parameter -// 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) -// in the Amazon Web Services Systems Manager User Guide. +// presents this error message: +// +// An error occurred (ParameterMaxVersionLimitExceeded) when calling the +// PutParameter operation: You attempted to create a new version of parameter-name +// by calling the PutParameter API with the overwrite flag. Version version-number, +// the oldest version, can't be deleted because it has a label associated with it. +// Move the label to another version of the parameter, and try again. +// +// This safeguard is to prevent parameter 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)]or [Move a parameter label (CLI)] in +// the Amazon Web Services Systems Manager User Guide. +// +// [Move a parameter label (CLI)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-cli-move +// [Move a parameter label (console)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html#sysman-paramstore-labels-console-move type ParameterMaxVersionLimitExceeded struct { Message *string @@ -3084,10 +3099,12 @@ func (e *ResourceInUseException) ErrorCode() string { func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// example, too many maintenance windows or patch baselines have been created. +// +// For information about resource quotas in Systems Manager, see [Systems Manager service quotas] in the Amazon +// Web Services General Reference. +// +// [Systems Manager service quotas]: https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm type ResourceLimitExceededException struct { Message *string @@ -3198,9 +3215,9 @@ func (e *ResourcePolicyInvalidParameterException) ErrorFault() smithy.ErrorFault return smithy.FaultClient } -// 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 . -// Verify these limits and try again. +// 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 . Verify these +// limits and try again. type ResourcePolicyLimitExceededException struct { Message *string @@ -3366,11 +3383,11 @@ 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) -// 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 +// use with Session Manager. For more information, see [Getting started with Session Manager]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 +// +// [Getting started with Session Manager]: https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html type TargetNotConnected struct { Message *string @@ -3504,8 +3521,9 @@ 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 Turning on 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. +// information, see [Turning on the advanced-instances tier]in the Amazon Web Services Systems Manager User Guide. +// +// [Turning on the advanced-instances tier]: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html type UnsupportedFeatureRequiredException struct { Message *string diff --git a/service/ssm/types/types.go b/service/ssm/types/types.go index d0ea4da9473..4bc962a92fe 100644 --- a/service/ssm/types/types.go +++ b/service/ssm/types/types.go @@ -123,12 +123,14 @@ type Association struct { // The version of the document used in the association. If you change a document // version for a State Manager association, Systems Manager immediately runs the // association unless you previously specifed the apply-only-at-cron-interval - // parameter. 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 . + // parameter. + // + // 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 . DocumentVersion *string // The number of hours that an association can run on specified targets. After the @@ -197,9 +199,9 @@ 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) - // . + // calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar]. + // + // [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. @@ -231,11 +233,12 @@ type AssociationDescription struct { // 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 - // managed node will process its association within the limit specified for - // MaxConcurrency . + // 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 managed node will process its + // association within the limit specified for MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -245,11 +248,12 @@ type AssociationDescription struct { // 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. + // 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. @@ -277,12 +281,14 @@ type AssociationDescription struct { // 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 + // 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. + // call to the PutComplianceItemsAPI operation. + // + // By default, all associations use AUTO mode. SyncCompliance AssociationSyncCompliance // The combination of Amazon Web Services Regions and Amazon Web Services accounts @@ -412,7 +418,9 @@ type AssociationExecutionTargetsFilter struct { // Describes a filter. type AssociationFilter struct { - // The name of the filter. InstanceId has been deprecated. + // The name of the filter. + // + // InstanceId has been deprecated. // // This member is required. Key AssociationFilterKey @@ -487,9 +495,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]. + // + // [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. @@ -510,11 +518,12 @@ type AssociationVersionInfo struct { // 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 - // managed node will process its association within the limit specified for - // MaxConcurrency . + // 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 managed node will process its + // association within the limit specified for MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -524,11 +533,12 @@ type AssociationVersionInfo struct { // 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. + // 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. @@ -552,12 +562,14 @@ type AssociationVersionInfo struct { // 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 + // 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. + // call to the PutComplianceItemsAPI operation. + // + // By default, all associations use AUTO mode. SyncCompliance AssociationSyncCompliance // The combination of Amazon Web Services Regions and Amazon Web Services accounts @@ -620,16 +632,26 @@ type AttachmentsSource struct { // 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" ] + // + // "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" ] + // + // "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": [ + // + // "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 @@ -701,8 +723,7 @@ type AutomationExecution struct { // The list of execution outputs as defined in the Automation runbook. Outputs map[string][]string - // The key-value map of execution parameters, which were supplied when calling - // StartAutomationExecution . + // The key-value map of execution parameters, which were supplied when calling StartAutomationExecution. Parameters map[string][]string // The AutomationExecutionId of the parent automation. @@ -717,8 +738,10 @@ type AutomationExecution struct { ResolvedTargets *ResolvedTargets // Information about the Automation runbooks that are run as part of a runbook - // workflow. The Automation runbooks specified for the runbook workflow can't run - // until all required approvals for the change request have been received. + // workflow. + // + // The Automation runbooks specified for the runbook workflow can't run until all + // required approvals for the change request have been received. Runbooks []Runbook // The date and time the Automation operation is scheduled to start. @@ -795,12 +818,12 @@ type AutomationExecutionMetadata struct { // ChangeRequest . AutomationSubtype AutomationSubtype - // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems + // Manager User Guide. + // + // [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 AutomationType AutomationType // The name of the Change Manager change request. @@ -857,9 +880,10 @@ type AutomationExecutionMetadata struct { 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 - // received. + // 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 // The date and time the Automation operation is scheduled to start. @@ -889,10 +913,12 @@ type BaselineOverride struct { // A set of rules defining the approval rules for a patch baseline. ApprovalRules *PatchRuleGroup - // 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [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 ApprovedPatches []string // Defines the compliance level for approved patches. When an approved patch is @@ -911,10 +937,12 @@ type BaselineOverride struct { // The operating system rule used by the patch baseline override. OperatingSystem 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [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 RejectedPatches []string // The action for Patch Manager to take on patches included in the RejectedPackages @@ -936,7 +964,9 @@ 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 // automatically creates a log group for you. The log group uses the following - // naming format: aws/ssm/SystemsManagerDocumentName + // naming format: + // + // aws/ssm/SystemsManagerDocumentName CloudWatchLogGroupName *string // Enables Systems Manager to send command output to CloudWatch Logs. @@ -982,8 +1012,9 @@ type Command struct { // 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) - // in the Amazon Web Services Systems Manager User Guide. + // information, see [Understanding command timeout values]in the Amazon Web Services Systems Manager User Guide. + // + // [Understanding command timeout values]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html?icmpid=docs_ec2_console#monitor-about-status-timeouts ExpiresAfter *time.Time // The managed node IDs against which this command was requested. @@ -992,17 +1023,19 @@ 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 Amazon Web Services 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. + // about how to use MaxConcurrency , see [Amazon Web Services Systems Manager Run Command] in the Amazon Web Services Systems + // Manager User Guide. + // + // [Amazon Web Services Systems Manager Run Command]: https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html 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 Amazon Web Services 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. + // information about how to use MaxErrors , see [Amazon Web Services Systems Manager Run Command] in the Amazon Web Services + // Systems Manager User Guide. + // + // [Amazon Web Services Systems Manager Run Command]: https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html MaxErrors *string // Configurations for sending notifications about command status changes. @@ -1038,31 +1071,42 @@ type Command struct { // A detailed status of the command execution. 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) - // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one - // of the following values: + // Status. For more information about these statuses, see [Understanding command statuses]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. + // + // [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html StatusDetails *string // The number of targets for the command. @@ -1082,60 +1126,98 @@ type Command struct { noSmithyDocumentSerde } -// Describes a command filter. A managed node ID can't be specified when a command -// status is Pending because the command hasn't run on the node yet. +// Describes a command filter. +// +// A managed node ID can't be specified when a command status is Pending because +// the command hasn't run on the node yet. type CommandFilter struct { - // The name of the filter. The ExecutionStage filter can't be used with the - // ListCommandInvocations operation, only with ListCommands . + // The name of the filter. + // + // The ExecutionStage filter can't be used with the 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: + // 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: + // + // - 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. @@ -1210,41 +1292,52 @@ 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) - // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one - // of the following values: + // information about these statuses, see [Understanding command statuses]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. + // + // [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html StatusDetails *string - // Gets the trace output sent by the agent. + // Gets the trace output sent by the agent. TraceOutput *string noSmithyDocumentSerde @@ -1264,21 +1357,31 @@ 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/awsrunShellScript + // + // 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. + // + // 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/awsrunShellScript + // + // 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. + // + // 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. @@ -1310,37 +1413,47 @@ type CommandPlugin struct { // A detailed status of the plugin execution. 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) - // in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one - // of the following values: + // Status. For more information about these statuses, see [Understanding command statuses]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. + // + // [Understanding command statuses]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html StatusDetails *string noSmithyDocumentSerde @@ -1489,16 +1602,24 @@ type CompliantSummary struct { 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: - // 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 . + // 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 . // // This member is required. Name *string @@ -1523,9 +1644,9 @@ type CreateAssociationBatchRequestEntry 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) - // . + // Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar]. + // + // [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 to assign to the association. @@ -1538,32 +1659,40 @@ type CreateAssociationBatchRequestEntry struct { // applies to associations that are currently running, and any pending and in // progress commands on all targets. If a target was taken offline for the // association to run, it is made available again immediately, without a reboot. + // // The Duration parameter applies only when both these conditions are true: + // // - The association for which you specify a duration is cancelable according to // the parameters of the SSM command document or Automation runbook associated with // this execution. - // - The command specifies the ApplyOnlyAtCronInterval (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval) - // parameter, which means that the association doesn't run immediately after it is - // created, but only according to the specified schedule. + // + // - The command specifies the [ApplyOnlyAtCronInterval]parameter, which means that the association + // doesn't run immediately after it is created, but only according to the specified + // schedule. + // + // [ApplyOnlyAtCronInterval]: https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateAssociationBatchRequestEntry.html#systemsmanager-Type-CreateAssociationBatchRequestEntry-ApplyOnlyAtCronInterval Duration *int32 - // 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. + // 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 *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 - // managed node will process its association within the limit specified for - // MaxConcurrency . + // 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 managed node will process its + // association within the limit specified for MaxConcurrency . MaxConcurrency *string // The number of errors that are allowed before the system stops sending requests @@ -1573,11 +1702,12 @@ type CreateAssociationBatchRequestEntry struct { // 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. + // 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. @@ -1596,12 +1726,14 @@ type CreateAssociationBatchRequestEntry struct { // 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 + // 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. + // call to the PutComplianceItemsAPI operation. + // + // By default, all associations use AUTO mode. SyncCompliance AssociationSyncCompliance // Use this action to create an association in multiple Regions and multiple @@ -1674,7 +1806,7 @@ type DocumentDescription struct { 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 . + // of the document. If you want to update this value, see UpdateDocument. DisplayName *string // The document format, either JSON or YAML. @@ -1687,11 +1819,13 @@ type DocumentDescription struct { DocumentVersion *string // The Sha256 or Sha1 hash created by the system when the document was created. + // // Sha1 hashes have been deprecated. Hash *string - // The hash type of the document. Valid values include Sha256 or Sha1 . Sha1 hashes - // have been deprecated. + // The hash type of the document. Valid values include Sha256 or Sha1 . + // + // Sha1 hashes have been deprecated. HashType DocumentHashType // The latest version of the document. @@ -1742,9 +1876,10 @@ 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) - // in the CloudFormation User Guide. + // For example, /AWS::EC2::Instance . For a list of valid resource types, see [Amazon Web Services resource and property types reference] in + // the CloudFormation User Guide. + // + // [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html TargetType *string // The version of the artifact associated with the document. @@ -1753,7 +1888,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. @@ -1780,7 +1915,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. @@ -1816,9 +1951,10 @@ 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) - // in the CloudFormation User Guide. + // For example, /AWS::EC2::Instance . For a list of valid resource types, see [Amazon Web Services resource and property types reference] in + // the CloudFormation User Guide. + // + // [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html TargetType *string // An optional field specifying the version of the artifact associated with the @@ -1830,46 +1966,76 @@ type DocumentIdentifier struct { } // One or more filters. Use a filter to return a more specific list of documents. -// For keys, you can specify one or more tags that have been applied to a document. +// +// For keys, you can specify one or more tags that have been applied to a +// document. +// // 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 // // Owner Note that only one Owner can be specified in a request. For example: // Key=Owner,Values=Self . +// // - Amazon +// // - Private +// // - 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) -// 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 -// 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 +// 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]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 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 +// +// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html type DocumentKeyValuesFilter struct { // The name of the filter key. @@ -1959,9 +2125,11 @@ type DocumentReviewerResponseSource struct { CreateTime *time.Time // The current review status of a new custom SSM document created by a member of - // your organization, or of the latest version of an existing SSM document. Only - // one version of a document can be in the APPROVED state at a time. When a new - // version is approved, the status of the previous version changes to REJECTED. + // your organization, or of the latest version of an existing SSM document. + // + // Only one version of a document can be in the APPROVED state at a time. When a + // new version is approved, the status of the previous version changes to REJECTED. + // // Only one version of a document can be in review, or PENDING, at a time. ReviewStatus ReviewStatus @@ -1997,7 +2165,7 @@ type DocumentVersionInfo struct { 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 . + // of the document. If you want to update this value, see UpdateDocument. DisplayName *string // The document format, either JSON or YAML. @@ -2142,10 +2310,12 @@ type InstanceAssociation struct { noSmithyDocumentSerde } -// 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 -// Create an association (console) (https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-associations-creating.html#state-manager-associations-console) -// in the Systems Manager User Guide. +// 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 [Create an association (console)]in the Systems Manager User Guide. +// +// [Create an association (console)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-associations-creating.html#state-manager-associations-console type InstanceAssociationOutputLocation struct { // An S3 bucket where you want to store the results of this request. @@ -2231,9 +2401,11 @@ 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/reference/ec2/describe-instances.html) - // in the Amazon Web Services CLI Command Reference. + // see [DescribeInstances]in the Amazon EC2 API Reference or [describe-instances] in the Amazon Web Services CLI Command + // Reference. + // + // [DescribeInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html + // [describe-instances]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html IamRole *string // The managed node ID. @@ -2256,19 +2428,22 @@ type InstanceInformation struct { // 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 and multicloud environment (Linux) (https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html) - // and Install SSM Agent for a hybrid and multicloud 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/reference/ec2/describe-instances.html) - // in the Amazon Web Services CLI Command Reference. + // 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 and multicloud environment (Linux)]and [Install SSM Agent for a hybrid and multicloud environment (Windows)]. To retrieve the Name tag + // of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For + // information, see [DescribeInstances]in the Amazon EC2 API Reference or [describe-instances] in the Amazon Web Services + // CLI Command Reference. + // + // [Install SSM Agent for a hybrid and multicloud environment (Windows)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html + // [Install SSM Agent for a hybrid and multicloud environment (Linux)]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html + // [DescribeInstances]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html + // [describe-instances]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html Name *string - // Connection status of SSM Agent. The status Inactive has been deprecated and is - // no longer in use. + // Connection status of SSM Agent. + // + // The status Inactive has been deprecated and is no longer in use. PingStatus PingStatus // The name of the operating system platform running on your managed node. @@ -2299,10 +2474,10 @@ type InstanceInformation struct { } // Describes a filter for a specific list of managed nodes. You can filter node -// 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. +// 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. type InstanceInformationFilter struct { // The name of the filter. @@ -2321,18 +2496,24 @@ type InstanceInformationFilter struct { // The filters to describe or get information about your managed nodes. 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 + // 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 // . // @@ -2365,7 +2546,9 @@ type InstancePatchState struct { InstanceId *string // The type of patching operation that was performed: or + // // - SCAN assesses the patch compliance state. + // // - INSTALL installs missing patches. // // This member is required. @@ -2401,9 +2584,13 @@ type InstancePatchState struct { // 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 - // baseline. For more information about the InstallOverrideList parameter, see - // About the AWS-RunPatchBaseline SSM document (https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html) - // in the Amazon Web Services Systems Manager User Guide. + // baseline. + // + // For more information about the InstallOverrideList parameter, see [About the AWS-RunPatchBaseline SSM document] + // AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager + // User Guide. + // + // [About the AWS-RunPatchBaseline SSM document]: https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html InstallOverrideList *string // The number of patches from the patch baseline that are installed on the managed @@ -2420,8 +2607,9 @@ type InstancePatchState struct { // 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 + // 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). InstalledRejectedCount *int32 @@ -2448,12 +2636,15 @@ type InstancePatchState struct { // of the service. OwnerInformation *string - // 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. + // 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 @@ -2478,23 +2669,34 @@ type InstancePatchState struct { noSmithyDocumentSerde } -// Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down -// 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: +// Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down 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 type InstancePatchStateFilter struct { // The key for the filter. Supported values include the following: + // // - InstalledCount + // // - InstalledOtherCount + // // - InstalledPendingRebootCount + // // - InstalledRejectedCount + // // - MissingCount + // // - FailedCount + // // - UnreportedNotApplicableCount + // // - NotApplicableCount // // This member is required. @@ -2666,8 +2868,9 @@ type InventoryDeletionStatusItem struct { 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) - // in the Amazon Web Services Systems Manager User Guide. + // summary, see [Understanding the delete inventory summary]in the Amazon Web Services Systems Manager User Guide. + // + // [Understanding the delete inventory summary]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-custom.html#sysman-inventory-delete DeletionSummary *InventoryDeletionSummary // The status of the operation. Possible values are InProgress and Complete. @@ -2732,9 +2935,12 @@ type InventoryFilter struct { // 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) - // in the Amazon Web Services Systems Manager User Guide. + // The type of filter. + // + // The Exists filter must be used with aggregators. For more information, see [Aggregating inventory data] in + // the Amazon Web Services Systems Manager User Guide. + // + // [Aggregating inventory data]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html Type InventoryQueryOperatorType noSmithyDocumentSerde @@ -2888,12 +3094,13 @@ type InventoryResultItem struct { } // Information about an Amazon Simple Storage Service (Amazon S3) bucket to write -// managed node-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 . +// managed node-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. type LoggingInfo struct { // The name of an S3 bucket where execution logs are stored. @@ -2918,20 +3125,23 @@ type MaintenanceWindowAutomationParameters struct { // The version of an Automation runbook to use during task execution. DocumentVersion *string - // 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 - // 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 + // 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 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. + // 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 @@ -3050,12 +3260,18 @@ 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. @@ -3127,20 +3343,23 @@ type MaintenanceWindowIdentityForTarget struct { noSmithyDocumentSerde } -// 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 -// 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 +// 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 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. +// 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. @@ -3161,21 +3380,23 @@ 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 -// 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 +// 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 . +// 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. @@ -3196,7 +3417,9 @@ type MaintenanceWindowRunCommandParameters struct { // 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 "\$DEFAULT" + // // --document-version "\$LATEST" // // --document-version "3" @@ -3227,20 +3450,23 @@ type MaintenanceWindowRunCommandParameters struct { noSmithyDocumentSerde } -// 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 -// 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 +// 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 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 . +// 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. @@ -3269,9 +3495,15 @@ type MaintenanceWindowTarget struct { // The type of target that is being registered with the maintenance window. ResourceType MaintenanceWindowResourceType - // 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= . + // 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= . Targets []Target // The ID of the maintenance window to register the target with. @@ -3296,30 +3528,39 @@ type MaintenanceWindowTask struct { // 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) - // 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 - // running of your task. + // 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]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 running of your task. + // + // [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html 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) - // 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 - // running of your task. + // when you are registering or updating a [targetless task]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 running of your task. + // + // [targetless task]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html MaxErrors *string // The task name. @@ -3345,12 +3586,12 @@ type MaintenanceWindowTask struct { // tasks, it's the state machine ARN. TaskArn *string - // 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 . + // 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. TaskParameters map[string]MaintenanceWindowTaskParameterValueExpression // The type of task. @@ -3424,13 +3665,15 @@ type NotificationConfig struct { NotificationArn *string // 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) - // in the Amazon Web Services Systems Manager User Guide. + // about these events, see [Monitoring Systems Manager status changes using Amazon SNS notifications]in the Amazon Web Services Systems Manager User Guide. + // + // [Monitoring Systems Manager status changes using Amazon SNS notifications]: https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html 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. NotificationType NotificationType @@ -3516,15 +3759,17 @@ type OpsFilter struct { // EventBridge processes an event from any Amazon Web Services service that // publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to // automatically create OpsItems allows you to quickly diagnose and remediate -// issues with Amazon Web Services resources from a single console. To help you -// diagnose issues, each OpsItem includes contextually relevant information such as -// the name and ID of the Amazon Web Services resource that generated the OpsItem, -// 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 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. +// issues with Amazon Web Services resources from a single console. +// +// To help you diagnose issues, each OpsItem includes contextually relevant +// information such as the name and ID of the Amazon Web Services resource that +// generated the OpsItem, 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 [Amazon Web Services Systems Manager OpsCenter]in the Amazon Web Services Systems Manager User Guide. +// +// [Amazon Web Services Systems Manager OpsCenter]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html type OpsItem struct { // The time a runbook workflow ended. Currently reported only for the OpsItem type @@ -3562,19 +3807,25 @@ type OpsItem struct { // 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-manually-create-OpsItems.html) - // in the Amazon Web Services Systems Manager User Guide. + // 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 DescribeOpsItemsAPI 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 GetOpsItemAPI + // 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]in the Amazon Web Services Systems Manager + // User Guide. + // + // [Creating OpsItems manually]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html OperationalData map[string]OpsItemDataValue // The OpsItem Amazon Resource Name (ARN). @@ -3584,12 +3835,20 @@ type OpsItem struct { 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/insight 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/insight + // + // 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 @@ -3616,8 +3875,9 @@ type OpsItem struct { 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) - // in the Amazon Web Services Systems Manager User Guide. + // information, see [Editing OpsItem details]in the Amazon Web Services Systems Manager User Guide. + // + // [Editing OpsItem details]: https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html Status OpsItemStatus // A short heading that describes the nature of the OpsItem and the impacted @@ -3824,12 +4084,20 @@ type OpsItemSummary struct { 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/insight 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/insight + // + // 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 @@ -3939,7 +4207,10 @@ type Parameter struct { Name *string // Either the version number or the label used to retrieve the parameter value. - // Specify selectors by using one of the following formats: parameter_name:version + // Specify selectors by using one of the following formats: + // + // parameter_name:version + // // parameter_name:label Selector *string @@ -3948,12 +4219,16 @@ type Parameter struct { 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 - // string with no spaces between commas in the Value field. + // 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. @@ -3965,7 +4240,9 @@ type Parameter struct { // Information about parameter usage. type ParameterHistory struct { - // Parameter names can include the following letters and symbols. a-zA-Z0-9_.- + // 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 @@ -3992,9 +4269,11 @@ type ParameterHistory struct { // The name of the parameter. 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) - // in the Amazon Web Services Systems Manager User Guide. + // Information about the policies assigned to a parameter. + // + // [Assigning parameter policies]in the Amazon Web Services Systems Manager User Guide. + // + // [Assigning parameter policies]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html Policies []ParameterInlinePolicy // The parameter tier. @@ -4040,6 +4319,7 @@ type ParameterMetadata struct { ARN *string // A parameter name can include only the following letters and symbols. + // // a-zA-Z0-9_.- AllowedPattern *string @@ -4080,7 +4360,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. @@ -4099,25 +4379,31 @@ type ParametersFilter struct { // One or more filters. Use a filter to return a more specific list of results. 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) - // in the Amazon Web Services Systems Manager User Guide. + // 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]in the Amazon Web Services Systems Manager User Guide. + // + // [Searching for Systems Manager parameters]: https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html // // 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. @@ -4181,8 +4467,9 @@ type Patch struct { // , 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 - // the Microsoft Knowledge Base ID. + // The ID of the patch. Applies to Windows patches only. + // + // This ID isn't the same as the Microsoft Knowledge Base ID. Id *string // The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only. @@ -4290,9 +4577,12 @@ type PatchComplianceData struct { // 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) - // in the Amazon Web Services Systems Manager User Guide. + // The state of the patch on the managed node, such as INSTALLED or FAILED. + // + // For descriptions of each patch state, see [About patch compliance] in the Amazon Web Services Systems + // Manager User Guide. + // + // [About patch compliance]: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-compliance-about.html#sysman-compliance-monitor-patch // // This member is required. State PatchComplianceDataState @@ -4303,35 +4593,44 @@ type PatchComplianceData struct { Title *string // The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that - // are resolved by the patch. Currently, CVE ID values are reported only for - // patches with a status of Missing or Failed . + // are resolved by the patch. + // + // Currently, CVE ID values are reported only for patches with a status of Missing + // or Failed . CVEIds *string noSmithyDocumentSerde } -// 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 -// 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 +// 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 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 // 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 - // The value for the filter key. Run the DescribePatchProperties command to view - // lists of valid values for each key based on operating system type. + // The value for the filter key. + // + // Run the DescribePatchProperties command to view lists of valid values for each key based on operating + // system type. // // This member is required. Values []string @@ -4366,10 +4665,14 @@ type PatchGroupPatchBaselineMapping struct { // 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 +// +// # DescribeAvailablePatches +// +// # DescribeInstancePatches +// +// # DescribePatchBaselines +// +// DescribePatchGroups type PatchOrchestratorFilter struct { // The key for the filter. @@ -4397,8 +4700,9 @@ type PatchRule struct { // 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. @@ -4428,13 +4732,20 @@ type PatchRuleGroup struct { // only. type PatchSource struct { - // The value of the yum repo configuration. For example: [main] + // The value of the yum repo configuration. For example: + // + // [main] + // // 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)]. + // + // [dnf.conf(5)]: https://man7.org/linux/man-pages/man5/dnf.conf.5.html // // This member is required. Configuration *string @@ -4446,7 +4757,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 @@ -4709,9 +5020,9 @@ 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 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) - // in the Amazon Web Services Systems Manager User Guide. + // see [Setting up Systems Manager Explorer to display data from multiple accounts and Regions]in the Amazon Web Services Systems Manager User Guide. + // + // [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 EnableAllOpsDataSources bool // Whether to automatically synchronize and aggregate data from new Amazon Web @@ -4722,12 +5033,19 @@ type ResourceDataSyncSource struct { } // The data type name for including resource data sync state. There are four sync -// 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 Amazon Web Services Systems -// Manager Explorer.) 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.) +// 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 Amazon Web +// Services Systems Manager Explorer.) +// +// 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.) type ResourceDataSyncSourceWithState struct { // The field name in SyncSource for the ResourceDataSyncAwsOrganizationsSource @@ -4738,9 +5056,9 @@ 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 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) - // in the Amazon Web Services Systems Manager User Guide. + // see [Setting up Systems Manager Explorer to display data from multiple accounts and Regions]in the Amazon Web Services Systems Manager User Guide. + // + // [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 EnableAllOpsDataSources bool // Whether to automatically synchronize and aggregate data from new Amazon Web @@ -4756,12 +5074,18 @@ type ResourceDataSyncSourceWithState struct { SourceType *string // The data type name for including resource data sync state. There are four sync - // 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. + // 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 - // Manager access in the organization in Organizations. + // resource data sync configuration. + // + // TrustedAccessDisabled : You disabled Systems Manager access in the organization + // in Organizations. State *string noSmithyDocumentSerde @@ -4795,8 +5119,10 @@ type ReviewInformation struct { } // Information about an Automation runbook used in 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. +// Manager. +// +// The Automation runbooks specified for the runbook workflow can't run until all +// required approvals for the change request have been received. type Runbook struct { // The name of the Automation runbook used in a runbook workflow. @@ -4881,19 +5207,22 @@ type ScheduledWindowExecution struct { noSmithyDocumentSerde } -// The service setting data structure. ServiceSetting is an account-level setting -// for an Amazon Web Services service. 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 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 service setting data structure. +// +// ServiceSetting is an account-level setting for an Amazon Web Services service. +// 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 +// ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to +// change the default setting. Or, use the ResetServiceSettingto 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. @@ -4914,10 +5243,13 @@ 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. Status *string @@ -4974,23 +5306,35 @@ 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. // // This member is required. @@ -5172,40 +5516,63 @@ type Tag struct { } // An array of search criteria that targets managed nodes using a key-value pair -// that you specify. 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. Supported formats include -// the following. For all Systems Manager capabilities: +// that you specify. +// +// 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]in the Amazon Web Services +// Systems Manager User Guide. +// +// Supported formats include the following. +// +// For all Systems Manager capabilities: +// // - Key=tag-key,Values=tag-value-1,tag-value-2 // // For Automation and Change Manager: +// // - Key=tag:tag-key,Values=tag-value +// // - Key=ResourceGroup,Values=resource-group-name +// // - Key=ParameterValues,Values=value-1,value-2,value-3 +// // - To target all instances in the Amazon Web Services Region: +// // - Key=AWS::EC2::Instance,Values=* +// // - Key=InstanceIds,Values=* // // For Run Command and Maintenance Windows: +// // - Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 +// // - Key=tag:tag-key,Values=tag-value-1,tag-value-2 +// // - Key=resource-groups:Name,Values=resource-group-name +// // - Additionally, Maintenance Windows support targeting resource types: +// // - // Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2 // // For State Manager: +// // - Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3 +// // - Key=tag:tag-key,Values=tag-value-1,tag-value-2 +// // - To target all instances in the Amazon Web Services Region: +// // - Key=InstanceIds,Values=* // // For more information about how to send commands that target managed nodes using -// Key,Value parameters, see Targeting multiple managed nodes (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. +// Key,Value parameters, see [Targeting multiple managed nodes] in the Amazon Web Services Systems Manager User +// Guide. +// +// [Targeting multiple managed nodes]: https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting +// [Registering maintenance window tasks without targets]: https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html type Target struct { // User-defined criteria for sending commands that target managed nodes that meet @@ -5214,9 +5581,10 @@ type Target struct { // 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. + // 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 diff --git a/service/ssmcontacts/api_op_AcceptPage.go b/service/ssmcontacts/api_op_AcceptPage.go index 135ae868050..50cc363d541 100644 --- a/service/ssmcontacts/api_op_AcceptPage.go +++ b/service/ssmcontacts/api_op_AcceptPage.go @@ -48,9 +48,11 @@ type AcceptPageInput struct { // 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 IGNORE - // AcceptCode 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_CreateContactChannel.go b/service/ssmcontacts/api_op_CreateContactChannel.go index e07a743e19d..d44949e5eb0 100644 --- a/service/ssmcontacts/api_op_CreateContactChannel.go +++ b/service/ssmcontacts/api_op_CreateContactChannel.go @@ -39,8 +39,11 @@ 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 // // This member is required. @@ -52,8 +55,11 @@ type CreateContactChannelInput struct { Name *string // Incident Manager supports three types of contact channels: + // // - SMS + // // - VOICE + // // - EMAIL // // This member is required. diff --git a/service/ssmcontacts/api_op_CreateRotation.go b/service/ssmcontacts/api_op_CreateRotation.go index 3cc94cca3e8..dbff054bcf9 100644 --- a/service/ssmcontacts/api_op_CreateRotation.go +++ b/service/ssmcontacts/api_op_CreateRotation.go @@ -30,10 +30,10 @@ func (c *Client) CreateRotation(ctx context.Context, params *CreateRotationInput type CreateRotationInput struct { - // The Amazon Resource Names (ARNs) of the contacts to add to the rotation. The - // order that you list the contacts in is their shift order in the rotation - // schedule. To change the order of the contact's shifts, use the UpdateRotation - // operation. + // The Amazon Resource Names (ARNs) of the contacts to add to the rotation. + // + // The order that you list the contacts in is their shift order in the rotation + // schedule. To change the order of the contact's shifts, use the UpdateRotationoperation. // // This member is required. ContactIds []string @@ -50,10 +50,13 @@ 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]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. + // + // [Time Zone Database]: https://www.iana.org/time-zones // // This member is required. TimeZoneId *string @@ -67,8 +70,9 @@ 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]in the Incident Manager User Guide. + // + // [Tagging Incident Manager resources]: https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/ssmcontacts/api_op_CreateRotationOverride.go b/service/ssmcontacts/api_op_CreateRotationOverride.go index acdf59edfbc..d11ad769ff3 100644 --- a/service/ssmcontacts/api_op_CreateRotationOverride.go +++ b/service/ssmcontacts/api_op_CreateRotationOverride.go @@ -35,8 +35,10 @@ type CreateRotationOverrideInput struct { 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. + // 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_ListPreviewRotationShifts.go b/service/ssmcontacts/api_op_ListPreviewRotationShifts.go index 8bd0ac989f2..aaf55fbaa61 100644 --- a/service/ssmcontacts/api_op_ListPreviewRotationShifts.go +++ b/service/ssmcontacts/api_op_ListPreviewRotationShifts.go @@ -12,9 +12,10 @@ import ( "time" ) -// Returns a list of shifts based on rotation configuration parameters. The -// Incident Manager primarily uses this operation to populate the Preview calendar. -// It is not typically run by end users. +// Returns a list of shifts based on rotation configuration parameters. +// +// The Incident Manager primarily uses this operation to populate the Preview +// calendar. It is not typically run by end users. func (c *Client) ListPreviewRotationShifts(ctx context.Context, params *ListPreviewRotationShiftsInput, optFns ...func(*Options)) (*ListPreviewRotationShiftsOutput, error) { if params == nil { params = &ListPreviewRotationShiftsInput{} diff --git a/service/ssmcontacts/api_op_PutContactPolicy.go b/service/ssmcontacts/api_op_PutContactPolicy.go index 73c11553b4e..ada66b8c35a 100644 --- a/service/ssmcontacts/api_op_PutContactPolicy.go +++ b/service/ssmcontacts/api_op_PutContactPolicy.go @@ -12,9 +12,9 @@ import ( // 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) -// . +// Access Manager (RAM). For more information about cross-account sharing, see [Setting up cross-account functionality]. +// +// [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_UpdateRotation.go b/service/ssmcontacts/api_op_UpdateRotation.go index ffee31b2a7c..a40be057346 100644 --- a/service/ssmcontacts/api_op_UpdateRotation.go +++ b/service/ssmcontacts/api_op_UpdateRotation.go @@ -42,8 +42,10 @@ type UpdateRotationInput struct { RotationId *string // The Amazon Resource Names (ARNs) of the contacts to include in the updated - // rotation. The order in which you list the contacts is their shift order in the - // rotation schedule. + // rotation. + // + // The order in which you list the contacts is their shift order in the rotation + // schedule. ContactIds []string // The date and time the rotation goes into effect. @@ -51,10 +53,13 @@ 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]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. + // + // [Time Zone Database]: https://www.iana.org/time-zones TimeZoneId *string noSmithyDocumentSerde diff --git a/service/ssmcontacts/doc.go b/service/ssmcontacts/doc.go index 023c1fcb1b9..f7d0f277c53 100644 --- a/service/ssmcontacts/doc.go +++ b/service/ssmcontacts/doc.go @@ -6,10 +6,11 @@ // Systems Manager Incident Manager is an incident management console designed to // help users mitigate and recover from incidents affecting their Amazon Web // Services-hosted applications. An incident is any unplanned interruption or -// reduction in quality of services. Incident Manager increases incident resolution -// by notifying responders of impact, highlighting relevant troubleshooting data, -// and providing collaboration tools to get services back up and running. To -// achieve the primary goal of reducing the time-to-resolution of critical -// incidents, Incident Manager automates response plans and enables responder team -// escalation. +// reduction in quality of services. +// +// Incident Manager increases incident resolution by notifying responders of +// impact, highlighting relevant troubleshooting data, and providing collaboration +// tools to get services back up and running. To achieve the primary goal of +// reducing the time-to-resolution of critical incidents, Incident Manager +// automates response plans and enables responder team escalation. package ssmcontacts diff --git a/service/ssmcontacts/options.go b/service/ssmcontacts/options.go index 33962843fa0..67ce3d14987 100644 --- a/service/ssmcontacts/options.go +++ b/service/ssmcontacts/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ssmcontacts/types/enums.go b/service/ssmcontacts/types/enums.go index bab001774b0..55faeeb2fe5 100644 --- a/service/ssmcontacts/types/enums.go +++ b/service/ssmcontacts/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AcceptCodeValidation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceptCodeValidation) Values() []AcceptCodeValidation { return []AcceptCodeValidation{ "IGNORE", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AcceptType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AcceptType) Values() []AcceptType { return []AcceptType{ "DELIVERED", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for ActivationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActivationStatus) Values() []ActivationStatus { return []ActivationStatus{ "ACTIVATED", @@ -66,8 +69,9 @@ const ( ) // Values returns all known values for ChannelType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChannelType) Values() []ChannelType { return []ChannelType{ "SMS", @@ -86,8 +90,9 @@ const ( ) // Values returns all known values for ContactType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContactType) Values() []ContactType { return []ContactType{ "PERSONAL", @@ -110,8 +115,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -136,8 +142,9 @@ const ( ) // Values returns all known values for ReceiptType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReceiptType) Values() []ReceiptType { return []ReceiptType{ "DELIVERED", @@ -157,8 +164,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -178,6 +186,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/ssmcontacts/types/types.go b/service/ssmcontacts/types/types.go index 92acfd68b21..f9e2e68fcba 100644 --- a/service/ssmcontacts/types/types.go +++ b/service/ssmcontacts/types/types.go @@ -82,8 +82,11 @@ type ContactChannel struct { // The type of the contact channel. Incident Manager supports three contact // methods: + // // - SMS + // // - VOICE + // // - EMAIL Type ChannelType @@ -96,8 +99,11 @@ 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 SimpleAddress *string @@ -132,8 +138,9 @@ type CoverageTime struct { } // Information about a resource that another resource is related to or depends on. -// For example, if a contact is a member of a rotation, the rotation is a dependent -// entity of the contact. +// +// For example, if a contact is a member of a rotation, the rotation is a +// dependent entity of the contact. type DependentEntity struct { // The Amazon Resource Names (ARNs) of the dependent resources. @@ -337,10 +344,11 @@ type RecurrenceSettings struct { // Information about the engagement resolution steps. The resolution starts from // the first contact, which can be an escalation plan, then resolves to an on-call -// rotation, and finally to a personal contact. The ResolutionContact structure -// describes the information for each node or step in that process. It contains -// information about different contact types, such as the escalation, rotation, and -// personal contacts. +// rotation, and finally to a personal contact. +// +// The ResolutionContact structure describes the information for each node or step +// in that process. It contains information about different contact types, such as +// the escalation, rotation, and personal contacts. type ResolutionContact struct { // The Amazon Resource Name (ARN) of a contact in the engagement resolution diff --git a/service/ssmincidents/api_op_CreateTimelineEvent.go b/service/ssmincidents/api_op_CreateTimelineEvent.go index c40b55c2a6f..ed6676b0736 100644 --- a/service/ssmincidents/api_op_CreateTimelineEvent.go +++ b/service/ssmincidents/api_op_CreateTimelineEvent.go @@ -43,8 +43,9 @@ type CreateTimelineEventInput struct { // This member is required. EventTime *time.Time - // The type of event. You can create timeline events of type Custom Event and Note - // . To make a Note-type event appear on the Incident notes panel in the console, + // The type of event. You can create timeline events of type Custom Event and Note . + // + // To make a Note-type event appear on the Incident notes panel in the console, // specify eventType as Note and enter the Amazon Resource Name (ARN) of the // incident as the value for eventReference . // diff --git a/service/ssmincidents/api_op_GetReplicationSet.go b/service/ssmincidents/api_op_GetReplicationSet.go index 485ae2b1d75..b3e24eaa973 100644 --- a/service/ssmincidents/api_op_GetReplicationSet.go +++ b/service/ssmincidents/api_op_GetReplicationSet.go @@ -176,12 +176,13 @@ type WaitForReplicationSetActiveWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReplicationSetInput, *GetReplicationSetOutput, error) (bool, error) } @@ -403,12 +404,13 @@ type WaitForReplicationSetDeletedWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetReplicationSetInput, *GetReplicationSetOutput, error) (bool, error) } diff --git a/service/ssmincidents/api_op_ListIncidentRecords.go b/service/ssmincidents/api_op_ListIncidentRecords.go index beb6634a78c..8bf92feb61b 100644 --- a/service/ssmincidents/api_op_ListIncidentRecords.go +++ b/service/ssmincidents/api_op_ListIncidentRecords.go @@ -32,14 +32,22 @@ 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. Filters []types.Filter diff --git a/service/ssmincidents/api_op_ListTimelineEvents.go b/service/ssmincidents/api_op_ListTimelineEvents.go index b405ca484d4..a69efa9088d 100644 --- a/service/ssmincidents/api_op_ListTimelineEvents.go +++ b/service/ssmincidents/api_op_ListTimelineEvents.go @@ -36,13 +36,20 @@ type ListTimelineEventsInput struct { // Filters the timeline events based on the provided conditional values. You can // filter timeline events with the following keys: + // // - eventReference + // // - 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 diff --git a/service/ssmincidents/api_op_PutResourcePolicy.go b/service/ssmincidents/api_op_PutResourcePolicy.go index 1f15ce43bdf..07c0a21eabb 100644 --- a/service/ssmincidents/api_op_PutResourcePolicy.go +++ b/service/ssmincidents/api_op_PutResourcePolicy.go @@ -12,9 +12,9 @@ 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) -// . +// information about cross-account sharing, see [Cross-Region and cross-account incident management]. +// +// [Cross-Region and cross-account 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 4e9984cff3d..3658b8588cd 100644 --- a/service/ssmincidents/api_op_StartIncident.go +++ b/service/ssmincidents/api_op_StartIncident.go @@ -41,11 +41,18 @@ type StartIncidentInput struct { ClientToken *string // Defines the impact to the customers. Providing an impact overwrites the impact - // provided by a response plan. Supported impact codes + // provided by a response plan. + // + // Supported impact codes + // // - 1 - Critical + // // - 2 - High + // // - 3 - Medium + // // - 4 - Low + // // - 5 - No Impact Impact *int32 diff --git a/service/ssmincidents/api_op_UpdateIncidentRecord.go b/service/ssmincidents/api_op_UpdateIncidentRecord.go index 3638717e4e9..e9ebae618a6 100644 --- a/service/ssmincidents/api_op_UpdateIncidentRecord.go +++ b/service/ssmincidents/api_op_UpdateIncidentRecord.go @@ -13,8 +13,9 @@ 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]. +// +// [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{} @@ -46,17 +47,26 @@ type UpdateIncidentRecordInput struct { // 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. Supported impact codes + // response plan. + // + // Supported impact codes + // // - 1 - Critical + // // - 2 - High + // // - 3 - Medium + // // - 4 - Low + // // - 5 - No Impact Impact *int32 // The Amazon SNS targets that Incident Manager notifies when a client updates an - // incident. Using multiple SNS topics creates redundancy in the event that a - // Region is down during the incident. + // incident. + // + // Using multiple SNS topics creates redundancy in the event that a Region is down + // during the incident. NotificationTargets []types.NotificationTargetItem // The status of the incident. Possible statuses are Open or Resolved . diff --git a/service/ssmincidents/api_op_UpdateResponsePlan.go b/service/ssmincidents/api_op_UpdateResponsePlan.go index 918f15634d5..ca262119dac 100644 --- a/service/ssmincidents/api_op_UpdateResponsePlan.go +++ b/service/ssmincidents/api_op_UpdateResponsePlan.go @@ -37,8 +37,9 @@ type UpdateResponsePlanInput struct { // The actions that this response plan takes at the beginning of an incident. Actions []types.Action - // The Chatbot chat channel used for collaboration during an incident. Use the - // empty structure to remove the chat channel from the response plan. + // The Chatbot chat channel used for collaboration during an incident. + // + // Use the empty structure to remove the chat channel from the response plan. ChatChannel types.ChatChannel // A token ensuring that the operation is called only once with the specified @@ -58,11 +59,18 @@ type UpdateResponsePlanInput struct { IncidentTemplateDedupeString *string // Defines the impact to the customers. Providing an impact overwrites the impact - // provided by a response plan. Supported impact codes + // provided by a response plan. + // + // Supported impact codes + // // - 1 - Critical + // // - 2 - High + // // - 3 - Medium + // // - 4 - Low + // // - 5 - No Impact IncidentTemplateImpact *int32 diff --git a/service/ssmincidents/api_op_UpdateTimelineEvent.go b/service/ssmincidents/api_op_UpdateTimelineEvent.go index 41c6faaa811..72724dc5927 100644 --- a/service/ssmincidents/api_op_UpdateTimelineEvent.go +++ b/service/ssmincidents/api_op_UpdateTimelineEvent.go @@ -53,10 +53,11 @@ type UpdateTimelineEventInput struct { // 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 - // CloudWatch metric associated with the DynamoDB table as a related item. This - // update action overrides all existing references. If you want to keep existing - // references, you must specify them in the call. If you don't, this action removes - // any existing references and enters only new references. + // CloudWatch metric associated with the DynamoDB table as a related item. + // + // This update action overrides all existing references. If you want to keep + // existing references, you must specify them in the call. If you don't, this + // action removes any existing references and enters only new references. EventReferences []types.EventReference // The timestamp for when the event occurred. diff --git a/service/ssmincidents/doc.go b/service/ssmincidents/doc.go index 30c8dc28dfa..4d1b4979956 100644 --- a/service/ssmincidents/doc.go +++ b/service/ssmincidents/doc.go @@ -6,10 +6,11 @@ // Systems Manager Incident Manager is an incident management console designed to // help users mitigate and recover from incidents affecting their Amazon Web // Services-hosted applications. An incident is any unplanned interruption or -// reduction in quality of services. Incident Manager increases incident resolution -// by notifying responders of impact, highlighting relevant troubleshooting data, -// and providing collaboration tools to get services back up and running. To -// achieve the primary goal of reducing the time-to-resolution of critical -// incidents, Incident Manager automates response plans and enables responder team -// escalation. +// reduction in quality of services. +// +// Incident Manager increases incident resolution by notifying responders of +// impact, highlighting relevant troubleshooting data, and providing collaboration +// tools to get services back up and running. To achieve the primary goal of +// reducing the time-to-resolution of critical incidents, Incident Manager +// automates response plans and enables responder team escalation. package ssmincidents diff --git a/service/ssmincidents/options.go b/service/ssmincidents/options.go index 4e460d6bae7..ca534636209 100644 --- a/service/ssmincidents/options.go +++ b/service/ssmincidents/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ssmincidents/types/enums.go b/service/ssmincidents/types/enums.go index 9073d03323b..bd60a0d0f22 100644 --- a/service/ssmincidents/types/enums.go +++ b/service/ssmincidents/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for IncidentRecordStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IncidentRecordStatus) Values() []IncidentRecordStatus { return []IncidentRecordStatus{ "OPEN", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for ItemType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ItemType) Values() []ItemType { return []ItemType{ "ANALYSIS", @@ -67,8 +69,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -96,8 +99,9 @@ const ( ) // Values returns all known values for ReplicationSetStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationSetStatus) Values() []ReplicationSetStatus { return []ReplicationSetStatus{ "ACTIVE", @@ -120,8 +124,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -140,8 +145,9 @@ const ( ) // Values returns all known values for ServiceCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceCode) Values() []ServiceCode { return []ServiceCode{ "ssm-incidents", @@ -157,8 +163,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -175,8 +182,9 @@ const ( ) // Values returns all known values for SsmTargetAccount. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SsmTargetAccount) Values() []SsmTargetAccount { return []SsmTargetAccount{ "RESPONSE_PLAN_OWNER_ACCOUNT", @@ -192,8 +200,9 @@ const ( ) // Values returns all known values for TimelineEventSort. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimelineEventSort) Values() []TimelineEventSort { return []TimelineEventSort{ "EVENT_TIME", @@ -209,8 +218,9 @@ const ( ) // 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. +// expanded in the future, and so 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 ff115640fec..23a7122bfbf 100644 --- a/service/ssmincidents/types/types.go +++ b/service/ssmincidents/types/types.go @@ -443,12 +443,18 @@ type IncidentRecord struct { // This member is required. DedupeString *string - // The impact of the incident on customers and applications. Supported impact - // codes + // The impact of the incident on customers and applications. + // + // Supported impact codes + // // - 1 - Critical + // // - 2 - High + // // - 3 - Medium + // // - 4 - Low + // // - 5 - No Impact // // This member is required. @@ -569,12 +575,18 @@ type IncidentRecordSummary struct { // to create an incident record. type IncidentTemplate struct { - // The impact of the incident on your customers and applications. Supported impact - // codes + // The impact of the incident on your customers and applications. + // + // Supported impact codes + // // - 1 - Critical + // // - 2 - High + // // - 3 - Medium + // // - 4 - Low + // // - 5 - No Impact // // This member is required. @@ -586,15 +598,18 @@ type IncidentTemplate struct { Title *string // The string Incident Manager uses to prevent the same root cause from creating - // multiple incidents in the same account. A deduplication string is a term or - // phrase the system uses to check for duplicate incidents. If you specify a - // deduplication string, Incident Manager searches for open incidents that contain - // the same string in the dedupeString field when it creates the incident. If a - // duplicate is detected, Incident Manager deduplicates the newer incident into the - // existing incident. By default, Incident Manager automatically deduplicates - // multiple incidents created by the same Amazon CloudWatch alarm or Amazon - // EventBridge event. You don't have to enter your own deduplication string to - // prevent duplication for these resource types. + // multiple incidents in the same account. + // + // A deduplication string is a term or phrase the system uses to check for + // duplicate incidents. If you specify a deduplication string, Incident Manager + // searches for open incidents that contain the same string in the dedupeString + // field when it creates the incident. If a duplicate is detected, Incident Manager + // deduplicates the newer incident into the existing incident. + // + // By default, Incident Manager automatically deduplicates multiple incidents + // created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You + // don't have to enter your own deduplication string to prevent duplication for + // these resource types. DedupeString *string // Tags to assign to the template. When the StartIncident API action is called, @@ -812,8 +827,10 @@ type RelatedItem struct { // This member is required. Identifier *ItemIdentifier - // A unique ID for a RelatedItem . Don't specify this parameter when you add a - // RelatedItem by using the UpdateRelatedItems API action. + // A unique ID for a RelatedItem . + // + // Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API + // action. GeneratedId *string // The title of the related item. diff --git a/service/ssmsap/api_op_ListComponents.go b/service/ssmsap/api_op_ListComponents.go index 23a6a95726f..31c2e738e42 100644 --- a/service/ssmsap/api_op_ListComponents.go +++ b/service/ssmsap/api_op_ListComponents.go @@ -33,9 +33,10 @@ type ListComponentsInput struct { ApplicationId *string // The maximum number of results to return with a single call. To retrieve the - // remaining results, make another call with the returned nextToken value. If you - // do not specify a value for MaxResults, the request returns 50 items per page by - // default. + // remaining results, make another call with the returned nextToken value. + // + // If you do not specify a value for MaxResults, the request returns 50 items per + // page by default. MaxResults *int32 // The token for the next page of results. @@ -146,9 +147,10 @@ var _ ListComponentsAPIClient = (*Client)(nil) // ListComponentsPaginatorOptions is the paginator options for ListComponents type ListComponentsPaginatorOptions 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. If you - // do not specify a value for MaxResults, the request returns 50 items per page by - // default. + // remaining results, make another call with the returned nextToken value. + // + // If you do not specify a value for MaxResults, the request returns 50 items per + // page by default. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/ssmsap/api_op_RegisterApplication.go b/service/ssmsap/api_op_RegisterApplication.go index f278f5bf1e7..66d847cac70 100644 --- a/service/ssmsap/api_op_RegisterApplication.go +++ b/service/ssmsap/api_op_RegisterApplication.go @@ -12,11 +12,16 @@ import ( ) // Register an SAP application with AWS Systems Manager for SAP. You must meet the -// following requirements before registering. The SAP application you want to -// register with AWS Systems Manager for SAP is running on Amazon EC2. AWS Systems -// Manager Agent must be setup on an Amazon EC2 instance along with the required -// IAM permissions. Amazon EC2 instance(s) must have access to the secrets created -// in AWS Secrets Manager to manage SAP applications and components. +// following requirements before registering. +// +// The SAP application you want to register with AWS Systems Manager for SAP is +// running on Amazon EC2. +// +// AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with +// the required IAM permissions. +// +// Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets +// Manager to manage SAP applications and components. func (c *Client) RegisterApplication(ctx context.Context, params *RegisterApplicationInput, optFns ...func(*Options)) (*RegisterApplicationOutput, error) { if params == nil { params = &RegisterApplicationInput{} diff --git a/service/ssmsap/options.go b/service/ssmsap/options.go index 5d87320d021..498ec6d220c 100644 --- a/service/ssmsap/options.go +++ b/service/ssmsap/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ssmsap/types/enums.go b/service/ssmsap/types/enums.go index 143aa340fde..79606d8f156 100644 --- a/service/ssmsap/types/enums.go +++ b/service/ssmsap/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for AllocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AllocationType) Values() []AllocationType { return []AllocationType{ "VPC_SUBNET", @@ -37,6 +38,7 @@ const ( // Values returns all known values for ApplicationDiscoveryStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationDiscoveryStatus) Values() []ApplicationDiscoveryStatus { return []ApplicationDiscoveryStatus{ @@ -63,8 +65,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "ACTIVATED", @@ -87,8 +90,9 @@ const ( ) // Values returns all known values for ApplicationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationType) Values() []ApplicationType { return []ApplicationType{ "HANA", @@ -104,8 +108,9 @@ const ( ) // Values returns all known values for BackintMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BackintMode) Values() []BackintMode { return []BackintMode{ "AWSBackup", @@ -124,8 +129,9 @@ const ( ) // Values returns all known values for ClusterStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClusterStatus) Values() []ClusterStatus { return []ClusterStatus{ "ONLINE", @@ -150,8 +156,9 @@ const ( ) // Values returns all known values for ComponentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentStatus) Values() []ComponentStatus { return []ComponentStatus{ "ACTIVATED", @@ -179,8 +186,9 @@ const ( ) // Values returns all known values for ComponentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComponentType) Values() []ComponentType { return []ComponentType{ "HANA", @@ -202,8 +210,9 @@ const ( ) // Values returns all known values for CredentialType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CredentialType) Values() []CredentialType { return []CredentialType{ "ADMIN", @@ -220,6 +229,7 @@ const ( // Values returns all known values for DatabaseConnectionMethod. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseConnectionMethod) Values() []DatabaseConnectionMethod { return []DatabaseConnectionMethod{ @@ -241,8 +251,9 @@ const ( ) // Values returns all known values for DatabaseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DatabaseStatus) Values() []DatabaseStatus { return []DatabaseStatus{ "RUNNING", @@ -263,8 +274,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -282,8 +294,9 @@ const ( ) // Values returns all known values for FilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperator) Values() []FilterOperator { return []FilterOperator{ "Equals", @@ -303,8 +316,9 @@ const ( ) // Values returns all known values for HostRole. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HostRole) Values() []HostRole { return []HostRole{ "LEADER", @@ -326,8 +340,9 @@ const ( ) // Values returns all known values for OperationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationMode) Values() []OperationMode { return []OperationMode{ "PRIMARY", @@ -348,8 +363,9 @@ const ( ) // Values returns all known values for OperationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationStatus) Values() []OperationStatus { return []OperationStatus{ "INPROGRESS", @@ -366,8 +382,9 @@ const ( ) // Values returns all known values for PermissionActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionActionType) Values() []PermissionActionType { return []PermissionActionType{ "RESTORE", @@ -386,8 +403,9 @@ const ( ) // Values returns all known values for ReplicationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReplicationMode) Values() []ReplicationMode { return []ReplicationMode{ "PRIMARY", diff --git a/service/ssmsap/types/types.go b/service/ssmsap/types/types.go index 27fba160862..5954a997018 100644 --- a/service/ssmsap/types/types.go +++ b/service/ssmsap/types/types.go @@ -184,16 +184,24 @@ type Component struct { Sid *string // The status of the component. + // // - ACTIVATED - this status has been deprecated. + // // - STARTING - the component is in the process of being started. + // // - STOPPED - the component is not running. + // // - STOPPING - the component is in the process of being stopped. + // // - RUNNING - the component is running. + // // - RUNNING_WITH_ERROR - one or more child component(s) of the parent component - // is not running. Call GetComponent (https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetComponent.html) - // to review the status of each child component. + // is not running. Call [GetComponent]GetComponent to review the status of each child component. + // // - UNDEFINED - AWS Systems Manager for SAP cannot provide the component status // based on the discovered information. Verify your SAP application. + // + // [GetComponent]: https://docs.aws.amazon.com/ssmsap/latest/APIReference/API_GetComponent.html Status ComponentStatus // The SAP system number of the application component. diff --git a/service/sso/api_op_GetRoleCredentials.go b/service/sso/api_op_GetRoleCredentials.go index 4b21e8b00a9..44ad9ff1d23 100644 --- a/service/sso/api_op_GetRoleCredentials.go +++ b/service/sso/api_op_GetRoleCredentials.go @@ -30,9 +30,10 @@ 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) - // in the IAM Identity Center OIDC API Reference Guide. + // The token issued by the CreateToken API call. For more information, see [CreateToken] in the + // IAM Identity Center OIDC API Reference Guide. + // + // [CreateToken]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html // // This member is required. AccessToken *string diff --git a/service/sso/api_op_ListAccountRoles.go b/service/sso/api_op_ListAccountRoles.go index e44da697c55..5861c9bbccb 100644 --- a/service/sso/api_op_ListAccountRoles.go +++ b/service/sso/api_op_ListAccountRoles.go @@ -29,9 +29,10 @@ 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) - // in the IAM Identity Center OIDC API Reference Guide. + // The token issued by the CreateToken API call. For more information, see [CreateToken] in the + // IAM Identity Center OIDC API Reference Guide. + // + // [CreateToken]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html // // This member is required. AccessToken *string diff --git a/service/sso/api_op_ListAccounts.go b/service/sso/api_op_ListAccounts.go index 2d7add067fa..7f2b2397879 100644 --- a/service/sso/api_op_ListAccounts.go +++ b/service/sso/api_op_ListAccounts.go @@ -12,9 +12,10 @@ 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) -// in the IAM Identity Center User Guide. This operation returns a paginated -// response. +// the administrator of the account. For more information, see [Assign User Access]in the IAM Identity +// Center User Guide. This operation returns a paginated response. +// +// [Assign User Access]: https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error) { if params == nil { params = &ListAccountsInput{} @@ -32,9 +33,10 @@ 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) - // in the IAM Identity Center OIDC API Reference Guide. + // The token issued by the CreateToken API call. For more information, see [CreateToken] in the + // IAM Identity Center OIDC API Reference Guide. + // + // [CreateToken]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html // // This member is required. AccessToken *string diff --git a/service/sso/api_op_Logout.go b/service/sso/api_op_Logout.go index 3ee682d19e0..65f582a8747 100644 --- a/service/sso/api_op_Logout.go +++ b/service/sso/api_op_Logout.go @@ -12,16 +12,20 @@ import ( // Removes the locally stored SSO tokens from the client-side cache and sends an // API call to the IAM Identity Center service to invalidate the corresponding -// server-side IAM Identity Center sign in session. If a user uses IAM Identity -// Center to access the AWS CLI, the user’s IAM Identity Center sign in session is -// used to obtain an IAM session, as specified in the corresponding IAM Identity -// Center permission set. More specifically, IAM Identity Center assumes an IAM -// role in the target account on behalf of the user, and the corresponding -// 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. +// server-side IAM Identity Center sign in session. +// +// If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM +// Identity Center sign in session is used to obtain an IAM session, as specified +// in the corresponding IAM Identity Center permission set. More specifically, IAM +// Identity Center assumes an IAM role in the target account on behalf of the user, +// and the corresponding 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]in the IAM Identity Center User +// Guide. +// +// [User authentications]: https://docs.aws.amazon.com/singlesignon/latest/userguide/authconcept.html func (c *Client) Logout(ctx context.Context, params *LogoutInput, optFns ...func(*Options)) (*LogoutOutput, error) { if params == nil { params = &LogoutInput{} @@ -39,9 +43,10 @@ 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) - // in the IAM Identity Center OIDC API Reference Guide. + // The token issued by the CreateToken API call. For more information, see [CreateToken] in the + // IAM Identity Center OIDC API Reference Guide. + // + // [CreateToken]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html // // This member is required. AccessToken *string diff --git a/service/sso/doc.go b/service/sso/doc.go index 59456d5dc27..7f6e429fda8 100644 --- a/service/sso/doc.go +++ b/service/sso/doc.go @@ -6,16 +6,22 @@ // AWS IAM Identity Center (successor to AWS Single Sign-On) Portal is a web // service that makes it easy for you to assign user access to IAM Identity Center // resources such as the AWS access portal. Users can get AWS account applications -// 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 +// 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]. +// +// 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 +// 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]. +// +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [IAM Identity Center rename]: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed package sso diff --git a/service/sso/options.go b/service/sso/options.go index 5dee7e53f47..3561c443086 100644 --- a/service/sso/options.go +++ b/service/sso/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sso/types/types.go b/service/sso/types/types.go index 8dc02296b11..07ac468e318 100644 --- a/service/sso/types/types.go +++ b/service/sso/types/types.go @@ -25,22 +25,24 @@ type AccountInfo struct { 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) - // in the AWS IAM User Guide. + // information, see [Using Temporary Security Credentials to Request Access to AWS Resources]in the AWS IAM User Guide. + // + // [Using Temporary Security Credentials to Request Access to AWS Resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html AccessKeyId *string // The date on which temporary security credentials expire. 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) - // in the AWS IAM User Guide. + // The key that is used to sign the request. For more information, see [Using Temporary Security Credentials to Request Access to AWS Resources] in the AWS + // IAM User Guide. + // + // [Using Temporary Security Credentials to Request Access to AWS Resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html 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) - // in the AWS IAM User Guide. + // The token used for temporary credentials. For more information, see [Using Temporary Security Credentials to Request Access to AWS Resources] in the AWS + // IAM User Guide. + // + // [Using Temporary Security Credentials to Request Access to AWS Resources]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html SessionToken *string noSmithyDocumentSerde diff --git a/service/ssoadmin/api_op_AttachCustomerManagedPolicyReferenceToPermissionSet.go b/service/ssoadmin/api_op_AttachCustomerManagedPolicyReferenceToPermissionSet.go index 7cfe2b8c347..ebafb92a33c 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{} diff --git a/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go b/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go index 00f0ee9238a..16f99d67f48 100644 --- a/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go +++ b/service/ssoadmin/api_op_AttachManagedPolicyToPermissionSet.go @@ -10,11 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches an Amazon Web Services 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. +// Attaches an Amazon Web Services 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 ProvisionPermissionSetafter 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) { if params == nil { params = &AttachManagedPolicyToPermissionSetInput{} @@ -33,9 +33,8 @@ func (c *Client) AttachManagedPolicyToPermissionSet(ctx context.Context, params type AttachManagedPolicyToPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_CreateAccountAssignment.go b/service/ssoadmin/api_op_CreateAccountAssignment.go index 38b08764b7c..f3620dc9c25 100644 --- a/service/ssoadmin/api_op_CreateAccountAssignment.go +++ b/service/ssoadmin/api_op_CreateAccountAssignment.go @@ -12,16 +12,20 @@ import ( ) // Assigns access to a principal for a specified Amazon Web Services account using -// a specified permission set. The term principal here refers to a user or group -// that is defined in IAM Identity Center. As part of a successful -// CreateAccountAssignment call, the specified permission set will automatically be -// provisioned to the account in the form of an IAM policy. That policy is attached -// to the IAM role created in IAM Identity Center. If the permission set is -// subsequently updated, the corresponding IAM policies attached to roles in your -// accounts will not be updated automatically. In this case, you must call -// ProvisionPermissionSet to make these updates. After a successful response, call -// DescribeAccountAssignmentCreationStatus to describe the status of an assignment -// creation request. +// a specified permission set. +// +// The term principal here refers to a user or group that is defined in IAM +// Identity Center. +// +// As part of a successful CreateAccountAssignment call, the specified permission +// set will automatically be provisioned to the account in the form of an IAM +// policy. That policy is attached to the IAM role created in IAM Identity Center. +// If the permission set is subsequently updated, the corresponding IAM policies +// attached to roles in your accounts will not be updated automatically. In this +// case, you must call ProvisionPermissionSetto make these updates. +// +// After a successful response, call DescribeAccountAssignmentCreationStatus to +// describe the status of an assignment creation request. func (c *Client) CreateAccountAssignment(ctx context.Context, params *CreateAccountAssignmentInput, optFns ...func(*Options)) (*CreateAccountAssignmentOutput, error) { if params == nil { params = &CreateAccountAssignmentInput{} @@ -40,9 +44,8 @@ func (c *Client) CreateAccountAssignment(ctx context.Context, params *CreateAcco type CreateAccountAssignmentInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string @@ -55,8 +58,7 @@ type CreateAccountAssignmentInput 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_CreateApplication.go b/service/ssoadmin/api_op_CreateApplication.go index 0949815ce52..c008d9f3cde 100644 --- a/service/ssoadmin/api_op_CreateApplication.go +++ b/service/ssoadmin/api_op_CreateApplication.go @@ -36,8 +36,7 @@ type CreateApplicationInput struct { ApplicationProviderArn *string // The ARN of the instance of IAM Identity Center under which the operation will - // run. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General + // run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General // Reference. // // This member is required. @@ -52,10 +51,15 @@ type CreateApplicationInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // The description of the . diff --git a/service/ssoadmin/api_op_CreateApplicationAssignment.go b/service/ssoadmin/api_op_CreateApplicationAssignment.go index d73728a41bc..00ec0eeca1f 100644 --- a/service/ssoadmin/api_op_CreateApplicationAssignment.go +++ b/service/ssoadmin/api_op_CreateApplicationAssignment.go @@ -36,8 +36,7 @@ type CreateApplicationAssignmentInput 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_CreateInstance.go b/service/ssoadmin/api_op_CreateInstance.go index 418391dc6c1..b75717f11de 100644 --- a/service/ssoadmin/api_op_CreateInstance.go +++ b/service/ssoadmin/api_op_CreateInstance.go @@ -14,9 +14,12 @@ import ( // Creates an instance of IAM Identity Center for a standalone Amazon Web Services // account that is not managed by Organizations or a member Amazon Web Services // account in an organization. You can create only one instance per account and -// across all Amazon Web Services Regions. The CreateInstance request is rejected -// if the following apply: +// across all Amazon Web Services Regions. +// +// The CreateInstance request is rejected if the following apply: +// // - The instance is created within the organization management account. +// // - An instance already exists in the same account. func (c *Client) CreateInstance(ctx context.Context, params *CreateInstanceInput, optFns ...func(*Options)) (*CreateInstanceOutput, error) { if params == nil { @@ -39,10 +42,15 @@ type CreateInstanceInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // The name of the instance of IAM Identity Center. @@ -57,8 +65,9 @@ type CreateInstanceInput struct { type CreateInstanceOutput struct { // The ARN of the instance of IAM Identity Center under which the operation will - // run. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General + // run. + // + // For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General // Reference. InstanceArn *string diff --git a/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go b/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go index 11a2089a23b..7da0c0217e0 100644 --- a/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go +++ b/service/ssoadmin/api_op_CreateInstanceAccessControlAttributeConfiguration.go @@ -14,9 +14,11 @@ import ( // 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 -// to validate that InstanceAccessControlAttributeConfiguration was created. +// see Attribute-Based Access Controlin the IAM Identity Center User Guide. +// +// After a successful response, call +// DescribeInstanceAccessControlAttributeConfiguration to validate that +// InstanceAccessControlAttributeConfiguration was created. func (c *Client) CreateInstanceAccessControlAttributeConfiguration(ctx context.Context, params *CreateInstanceAccessControlAttributeConfigurationInput, optFns ...func(*Options)) (*CreateInstanceAccessControlAttributeConfigurationOutput, error) { if params == nil { params = &CreateInstanceAccessControlAttributeConfigurationInput{} diff --git a/service/ssoadmin/api_op_CreatePermissionSet.go b/service/ssoadmin/api_op_CreatePermissionSet.go index 163f377e1fc..55ef6044433 100644 --- a/service/ssoadmin/api_op_CreatePermissionSet.go +++ b/service/ssoadmin/api_op_CreatePermissionSet.go @@ -11,9 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a permission set within a specified IAM Identity Center instance. To -// grant users and groups access to Amazon Web Services account resources, use -// CreateAccountAssignment . +// Creates a permission set within a specified IAM Identity Center instance. +// +// To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment. func (c *Client) CreatePermissionSet(ctx context.Context, params *CreatePermissionSetInput, optFns ...func(*Options)) (*CreatePermissionSetOutput, error) { if params == nil { params = &CreatePermissionSetInput{} @@ -32,19 +32,18 @@ func (c *Client) CreatePermissionSet(ctx context.Context, params *CreatePermissi type CreatePermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // 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 @@ -55,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_CreateTrustedTokenIssuer.go b/service/ssoadmin/api_op_CreateTrustedTokenIssuer.go index c85e92e2c26..1a1374dcb4d 100644 --- a/service/ssoadmin/api_op_CreateTrustedTokenIssuer.go +++ b/service/ssoadmin/api_op_CreateTrustedTokenIssuer.go @@ -13,10 +13,12 @@ import ( // Creates a connection to a trusted token issuer in an instance of IAM Identity // Center. A trusted token issuer enables trusted identity propagation to be used -// with applications that authenticate outside of Amazon Web Services. This trusted -// token issuer describes an external identity provider (IdP) that can generate -// claims or assertions in the form of access tokens for a user. Applications -// enabled for IAM Identity Center can use these tokens for authentication. +// with applications that authenticate outside of Amazon Web Services. +// +// This trusted token issuer describes an external identity provider (IdP) that +// can generate claims or assertions in the form of access tokens for a user. +// Applications enabled for IAM Identity Center can use these tokens for +// authentication. func (c *Client) CreateTrustedTokenIssuer(ctx context.Context, params *CreateTrustedTokenIssuerInput, optFns ...func(*Options)) (*CreateTrustedTokenIssuerOutput, error) { if params == nil { params = &CreateTrustedTokenIssuerInput{} @@ -61,10 +63,15 @@ type CreateTrustedTokenIssuerInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies tags to be attached to the new trusted token issuer configuration. diff --git a/service/ssoadmin/api_op_DeleteAccountAssignment.go b/service/ssoadmin/api_op_DeleteAccountAssignment.go index 26521e1d1fb..74199af3ce7 100644 --- a/service/ssoadmin/api_op_DeleteAccountAssignment.go +++ b/service/ssoadmin/api_op_DeleteAccountAssignment.go @@ -12,9 +12,10 @@ import ( ) // Deletes a principal's access from a specified Amazon Web Services account using -// a specified permission set. After a successful response, call -// DescribeAccountAssignmentDeletionStatus to describe the status of an assignment -// deletion request. +// a specified permission set. +// +// After a successful response, call DescribeAccountAssignmentDeletionStatus to +// describe the status of an assignment deletion request. func (c *Client) DeleteAccountAssignment(ctx context.Context, params *DeleteAccountAssignmentInput, optFns ...func(*Options)) (*DeleteAccountAssignmentOutput, error) { if params == nil { params = &DeleteAccountAssignmentInput{} @@ -33,9 +34,8 @@ func (c *Client) DeleteAccountAssignment(ctx context.Context, params *DeleteAcco type DeleteAccountAssignmentInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string @@ -47,8 +47,7 @@ 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_DeleteApplication.go b/service/ssoadmin/api_op_DeleteApplication.go index 6e5f356a7f2..737951f0177 100644 --- a/service/ssoadmin/api_op_DeleteApplication.go +++ b/service/ssoadmin/api_op_DeleteApplication.go @@ -29,9 +29,8 @@ func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicatio type DeleteApplicationInput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. // // This member is required. ApplicationArn *string diff --git a/service/ssoadmin/api_op_DeleteApplicationAssignment.go b/service/ssoadmin/api_op_DeleteApplicationAssignment.go index e8e6cf17691..09e82a128a2 100644 --- a/service/ssoadmin/api_op_DeleteApplicationAssignment.go +++ b/service/ssoadmin/api_op_DeleteApplicationAssignment.go @@ -37,8 +37,7 @@ type DeleteApplicationAssignmentInput 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_DeleteInlinePolicyFromPermissionSet.go b/service/ssoadmin/api_op_DeleteInlinePolicyFromPermissionSet.go index 762716b990f..2c706993456 100644 --- a/service/ssoadmin/api_op_DeleteInlinePolicyFromPermissionSet.go +++ b/service/ssoadmin/api_op_DeleteInlinePolicyFromPermissionSet.go @@ -29,9 +29,8 @@ func (c *Client) DeleteInlinePolicyFromPermissionSet(ctx context.Context, params type DeleteInlinePolicyFromPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_DeleteInstanceAccessControlAttributeConfiguration.go b/service/ssoadmin/api_op_DeleteInstanceAccessControlAttributeConfiguration.go index af342255600..f959278c6c2 100644 --- a/service/ssoadmin/api_op_DeleteInstanceAccessControlAttributeConfiguration.go +++ b/service/ssoadmin/api_op_DeleteInstanceAccessControlAttributeConfiguration.go @@ -14,8 +14,8 @@ import ( // IAM Identity Center instance and deletes all of the attribute mappings that have // been configured. Once deleted, any attributes that are received from an identity // source and any custom attributes you have previously configured will not be -// passed. For more information about ABAC, see Attribute-Based Access Control in -// the IAM Identity Center User Guide. +// passed. For more information about ABAC, see Attribute-Based Access Controlin the IAM Identity Center User +// Guide. func (c *Client) DeleteInstanceAccessControlAttributeConfiguration(ctx context.Context, params *DeleteInstanceAccessControlAttributeConfigurationInput, optFns ...func(*Options)) (*DeleteInstanceAccessControlAttributeConfigurationOutput, error) { if params == nil { params = &DeleteInstanceAccessControlAttributeConfigurationInput{} diff --git a/service/ssoadmin/api_op_DeletePermissionSet.go b/service/ssoadmin/api_op_DeletePermissionSet.go index 9e2411bbf2d..c49a6b92e2a 100644 --- a/service/ssoadmin/api_op_DeletePermissionSet.go +++ b/service/ssoadmin/api_op_DeletePermissionSet.go @@ -29,9 +29,8 @@ func (c *Client) DeletePermissionSet(ctx context.Context, params *DeletePermissi type DeletePermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_DeletePermissionsBoundaryFromPermissionSet.go b/service/ssoadmin/api_op_DeletePermissionsBoundaryFromPermissionSet.go index 7ac506e3fa7..95c4fa18a49 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{} diff --git a/service/ssoadmin/api_op_DeleteTrustedTokenIssuer.go b/service/ssoadmin/api_op_DeleteTrustedTokenIssuer.go index de80dfb618b..fa8fca8d958 100644 --- a/service/ssoadmin/api_op_DeleteTrustedTokenIssuer.go +++ b/service/ssoadmin/api_op_DeleteTrustedTokenIssuer.go @@ -11,9 +11,10 @@ import ( ) // Deletes a trusted token issuer configuration from an instance of IAM Identity -// Center. Deleting this trusted token issuer configuration will cause users to -// lose access to any applications that are configured to use the trusted token -// issuer. +// Center. +// +// Deleting this trusted token issuer configuration will cause users to lose +// access to any applications that are configured to use the trusted token issuer. func (c *Client) DeleteTrustedTokenIssuer(ctx context.Context, params *DeleteTrustedTokenIssuerInput, optFns ...func(*Options)) (*DeleteTrustedTokenIssuerOutput, error) { if params == nil { params = &DeleteTrustedTokenIssuerInput{} diff --git a/service/ssoadmin/api_op_DescribeAccountAssignmentCreationStatus.go b/service/ssoadmin/api_op_DescribeAccountAssignmentCreationStatus.go index 0c60336ac14..91696e4c20e 100644 --- a/service/ssoadmin/api_op_DescribeAccountAssignmentCreationStatus.go +++ b/service/ssoadmin/api_op_DescribeAccountAssignmentCreationStatus.go @@ -35,9 +35,8 @@ type DescribeAccountAssignmentCreationStatusInput struct { AccountAssignmentCreationRequestId *string // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_DescribeAccountAssignmentDeletionStatus.go b/service/ssoadmin/api_op_DescribeAccountAssignmentDeletionStatus.go index 7876c4d787b..dd3148eff38 100644 --- a/service/ssoadmin/api_op_DescribeAccountAssignmentDeletionStatus.go +++ b/service/ssoadmin/api_op_DescribeAccountAssignmentDeletionStatus.go @@ -35,9 +35,8 @@ type DescribeAccountAssignmentDeletionStatusInput struct { AccountAssignmentDeletionRequestId *string // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_DescribeApplication.go b/service/ssoadmin/api_op_DescribeApplication.go index 1af491ac8d3..548c2d51a12 100644 --- a/service/ssoadmin/api_op_DescribeApplication.go +++ b/service/ssoadmin/api_op_DescribeApplication.go @@ -31,9 +31,8 @@ func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplic type DescribeApplicationInput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. // // This member is required. ApplicationArn *string @@ -59,8 +58,7 @@ type DescribeApplicationOutput struct { Description *string // The ARN of the IAM Identity Center application under which the operation will - // run. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General + // run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General // Reference. InstanceArn *string diff --git a/service/ssoadmin/api_op_DescribeApplicationAssignment.go b/service/ssoadmin/api_op_DescribeApplicationAssignment.go index 3148ef3cd4f..82dcb7561e3 100644 --- a/service/ssoadmin/api_op_DescribeApplicationAssignment.go +++ b/service/ssoadmin/api_op_DescribeApplicationAssignment.go @@ -14,8 +14,7 @@ import ( // Retrieves a direct assignment of a user or group to an application. If the user // doesn’t have a direct assignment to the application, the user may still have // access to the application through a group. Therefore, don’t use this API to test -// access to an application for a user. Instead use -// ListApplicationAssignmentsForPrincipal . +// access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal. func (c *Client) DescribeApplicationAssignment(ctx context.Context, params *DescribeApplicationAssignmentInput, optFns ...func(*Options)) (*DescribeApplicationAssignmentOutput, error) { if params == nil { params = &DescribeApplicationAssignmentInput{} @@ -33,17 +32,15 @@ func (c *Client) DescribeApplicationAssignment(ctx context.Context, params *Desc type DescribeApplicationAssignmentInput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. // // This member is required. ApplicationArn *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 @@ -58,15 +55,13 @@ type DescribeApplicationAssignmentInput struct { type DescribeApplicationAssignmentOutput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. ApplicationArn *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. PrincipalId *string // The entity type for which the assignment will be created. diff --git a/service/ssoadmin/api_op_DescribeInstance.go b/service/ssoadmin/api_op_DescribeInstance.go index b0e7699f93b..3ee6cd31188 100644 --- a/service/ssoadmin/api_op_DescribeInstance.go +++ b/service/ssoadmin/api_op_DescribeInstance.go @@ -14,12 +14,15 @@ import ( // Returns the details of an instance of IAM Identity Center. The status can be // one of the following: +// // - CREATE_IN_PROGRESS - The instance is in the process of being created. When // the instance is ready for use, DescribeInstance returns the status of ACTIVE . // While the instance is in the CREATE_IN_PROGRESS state, you can call only // DescribeInstance and DeleteInstance operations. +// // - DELETE_IN_PROGRESS - The instance is being deleted. Returns // AccessDeniedException after the delete operation completes. +// // - ACTIVE - The instance is active. func (c *Client) DescribeInstance(ctx context.Context, params *DescribeInstanceInput, optFns ...func(*Options)) (*DescribeInstanceOutput, error) { if params == nil { @@ -57,8 +60,7 @@ type DescribeInstanceOutput struct { IdentityStoreId *string // The ARN of the instance of IAM Identity Center under which the operation will - // run. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General + // run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General // Reference. InstanceArn *string diff --git a/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go b/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go index 3690463a9d4..8795961cab4 100644 --- a/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go +++ b/service/ssoadmin/api_op_DescribeInstanceAccessControlAttributeConfiguration.go @@ -15,7 +15,7 @@ import ( // 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. +// ABAC, see Attribute-Based Access Controlin 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_DescribePermissionSet.go b/service/ssoadmin/api_op_DescribePermissionSet.go index 9c609f24aa0..2dcd90eb6dc 100644 --- a/service/ssoadmin/api_op_DescribePermissionSet.go +++ b/service/ssoadmin/api_op_DescribePermissionSet.go @@ -30,9 +30,8 @@ func (c *Client) DescribePermissionSet(ctx context.Context, params *DescribePerm type DescribePermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_DescribePermissionSetProvisioningStatus.go b/service/ssoadmin/api_op_DescribePermissionSetProvisioningStatus.go index 9466473d6ee..9d19af76fbb 100644 --- a/service/ssoadmin/api_op_DescribePermissionSetProvisioningStatus.go +++ b/service/ssoadmin/api_op_DescribePermissionSetProvisioningStatus.go @@ -30,15 +30,14 @@ func (c *Client) DescribePermissionSetProvisioningStatus(ctx context.Context, pa type DescribePermissionSetProvisioningStatusInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string - // The identifier that is provided by the ProvisionPermissionSet call to retrieve - // the current status of the provisioning workflow. + // The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of + // the provisioning workflow. // // This member is required. ProvisionPermissionSetRequestId *string diff --git a/service/ssoadmin/api_op_DetachCustomerManagedPolicyReferenceFromPermissionSet.go b/service/ssoadmin/api_op_DetachCustomerManagedPolicyReferenceFromPermissionSet.go index 5cd85f5458f..6083c6069da 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{} diff --git a/service/ssoadmin/api_op_DetachManagedPolicyFromPermissionSet.go b/service/ssoadmin/api_op_DetachManagedPolicyFromPermissionSet.go index 429beecb3ac..dc184826188 100644 --- a/service/ssoadmin/api_op_DetachManagedPolicyFromPermissionSet.go +++ b/service/ssoadmin/api_op_DetachManagedPolicyFromPermissionSet.go @@ -30,9 +30,8 @@ func (c *Client) DetachManagedPolicyFromPermissionSet(ctx context.Context, param type DetachManagedPolicyFromPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_GetApplicationAssignmentConfiguration.go b/service/ssoadmin/api_op_GetApplicationAssignmentConfiguration.go index 32dc4838d6a..b04ed2cc491 100644 --- a/service/ssoadmin/api_op_GetApplicationAssignmentConfiguration.go +++ b/service/ssoadmin/api_op_GetApplicationAssignmentConfiguration.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the configuration of PutApplicationAssignmentConfiguration . +// Retrieves the configuration of PutApplicationAssignmentConfiguration. func (c *Client) GetApplicationAssignmentConfiguration(ctx context.Context, params *GetApplicationAssignmentConfigurationInput, optFns ...func(*Options)) (*GetApplicationAssignmentConfigurationOutput, error) { if params == nil { params = &GetApplicationAssignmentConfigurationInput{} @@ -28,9 +28,8 @@ func (c *Client) GetApplicationAssignmentConfiguration(ctx context.Context, para type GetApplicationAssignmentConfigurationInput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. // // This member is required. ApplicationArn *string @@ -41,9 +40,10 @@ type GetApplicationAssignmentConfigurationInput struct { type GetApplicationAssignmentConfigurationOutput struct { // If AssignmentsRequired is true (default value), users don’t have access to the - // application unless an assignment is created using the - // CreateApplicationAssignment API (https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html) - // . If false , all users have access to the application. + // application unless an assignment is created using the [CreateApplicationAssignment API]. If false , all users + // have access to the application. + // + // [CreateApplicationAssignment API]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html // // This member is required. AssignmentRequired *bool diff --git a/service/ssoadmin/api_op_GetInlinePolicyForPermissionSet.go b/service/ssoadmin/api_op_GetInlinePolicyForPermissionSet.go index 64856c763b6..95f6f2ffeba 100644 --- a/service/ssoadmin/api_op_GetInlinePolicyForPermissionSet.go +++ b/service/ssoadmin/api_op_GetInlinePolicyForPermissionSet.go @@ -29,9 +29,8 @@ func (c *Client) GetInlinePolicyForPermissionSet(ctx context.Context, params *Ge type GetInlinePolicyForPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string @@ -46,9 +45,10 @@ type GetInlinePolicyForPermissionSetInput struct { type GetInlinePolicyForPermissionSetOutput struct { - // The inline policy that is attached to the permission set. For Length Constraints - // , if a valid ARN is provided for a permission set, it is possible for an empty - // inline policy to be returned. + // The inline policy that is attached to the permission set. + // + // For Length Constraints , if a valid ARN is provided for a permission set, it is + // possible for an empty inline policy to be returned. InlinePolicy *string // Metadata pertaining to the operation's result. diff --git a/service/ssoadmin/api_op_GetPermissionsBoundaryForPermissionSet.go b/service/ssoadmin/api_op_GetPermissionsBoundaryForPermissionSet.go index 0e501f4df5a..4744f0cf806 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{} diff --git a/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go b/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go index 12f022a54d5..fbe7e86745e 100644 --- a/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go +++ b/service/ssoadmin/api_op_ListAccountAssignmentCreationStatus.go @@ -31,9 +31,8 @@ func (c *Client) ListAccountAssignmentCreationStatus(ctx context.Context, params type ListAccountAssignmentCreationStatusInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go b/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go index ae4e4f9e922..0ea131f9d5a 100644 --- a/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go +++ b/service/ssoadmin/api_op_ListAccountAssignmentDeletionStatus.go @@ -31,9 +31,8 @@ func (c *Client) ListAccountAssignmentDeletionStatus(ctx context.Context, params type ListAccountAssignmentDeletionStatusInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_ListAccountAssignments.go b/service/ssoadmin/api_op_ListAccountAssignments.go index f1715e549ec..68b7e001f21 100644 --- a/service/ssoadmin/api_op_ListAccountAssignments.go +++ b/service/ssoadmin/api_op_ListAccountAssignments.go @@ -37,9 +37,8 @@ type ListAccountAssignmentsInput struct { AccountId *string // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go b/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go index b03e5e69932..ae5f6ff90b0 100644 --- a/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go +++ b/service/ssoadmin/api_op_ListAccountsForProvisionedPermissionSet.go @@ -31,20 +31,19 @@ func (c *Client) ListAccountsForProvisionedPermissionSet(ctx context.Context, pa type ListAccountsForProvisionedPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string - // The ARN of the PermissionSet from which the associated Amazon Web Services - // accounts will be listed. + // The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be + // listed. // // 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 @@ -162,7 +161,7 @@ var _ ListAccountsForProvisionedPermissionSetAPIClient = (*Client)(nil) // 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_ListApplications.go b/service/ssoadmin/api_op_ListApplications.go index f692a459015..74ce2226132 100644 --- a/service/ssoadmin/api_op_ListApplications.go +++ b/service/ssoadmin/api_op_ListApplications.go @@ -33,8 +33,7 @@ func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsI type ListApplicationsInput struct { // The ARN of the IAM Identity Center application under which the operation will - // run. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General + // run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General // Reference. // // This member is required. diff --git a/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go b/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go index d7795fea217..b734d824e59 100644 --- a/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go +++ b/service/ssoadmin/api_op_ListCustomerManagedPolicyReferencesInPermissionSet.go @@ -11,7 +11,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{} diff --git a/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go b/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go index b1b4981d5c7..608952e72ca 100644 --- a/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go +++ b/service/ssoadmin/api_op_ListManagedPoliciesInPermissionSet.go @@ -31,9 +31,8 @@ func (c *Client) ListManagedPoliciesInPermissionSet(ctx context.Context, params type ListManagedPoliciesInPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string @@ -43,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 @@ -158,7 +157,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 8f1316cea6b..c2feebe434d 100644 --- a/service/ssoadmin/api_op_ListPermissionSetProvisioningStatus.go +++ b/service/ssoadmin/api_op_ListPermissionSetProvisioningStatus.go @@ -31,9 +31,8 @@ func (c *Client) ListPermissionSetProvisioningStatus(ctx context.Context, params type ListPermissionSetProvisioningStatusInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_ListPermissionSets.go b/service/ssoadmin/api_op_ListPermissionSets.go index c29d1d913b1..d34137e0a72 100644 --- a/service/ssoadmin/api_op_ListPermissionSets.go +++ b/service/ssoadmin/api_op_ListPermissionSets.go @@ -10,7 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists the PermissionSet s in an IAM Identity Center instance. +// Lists the PermissionSets 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{} @@ -29,9 +29,8 @@ func (c *Client) ListPermissionSets(ctx context.Context, params *ListPermissionS type ListPermissionSetsInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_ListPermissionSetsProvisionedToAccount.go b/service/ssoadmin/api_op_ListPermissionSetsProvisionedToAccount.go index de2f63cb86c..3ae5d9342c1 100644 --- a/service/ssoadmin/api_op_ListPermissionSetsProvisionedToAccount.go +++ b/service/ssoadmin/api_op_ListPermissionSetsProvisionedToAccount.go @@ -37,9 +37,8 @@ type ListPermissionSetsProvisionedToAccountInput struct { AccountId *string // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_ListTagsForResource.go b/service/ssoadmin/api_op_ListTagsForResource.go index 07ad3638dc9..4d18781b232 100644 --- a/service/ssoadmin/api_op_ListTagsForResource.go +++ b/service/ssoadmin/api_op_ListTagsForResource.go @@ -35,9 +35,8 @@ type ListTagsForResourceInput struct { ResourceArn *string // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. InstanceArn *string // The pagination token for the list API. Initially the value is null. Use the diff --git a/service/ssoadmin/api_op_ProvisionPermissionSet.go b/service/ssoadmin/api_op_ProvisionPermissionSet.go index 18826b41a36..2e44d384d56 100644 --- a/service/ssoadmin/api_op_ProvisionPermissionSet.go +++ b/service/ssoadmin/api_op_ProvisionPermissionSet.go @@ -31,9 +31,8 @@ func (c *Client) ProvisionPermissionSet(ctx context.Context, params *ProvisionPe type ProvisionPermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_PutApplicationAssignmentConfiguration.go b/service/ssoadmin/api_op_PutApplicationAssignmentConfiguration.go index a134c075d59..4b60e2ffd44 100644 --- a/service/ssoadmin/api_op_PutApplicationAssignmentConfiguration.go +++ b/service/ssoadmin/api_op_PutApplicationAssignmentConfiguration.go @@ -12,10 +12,12 @@ import ( // Configure how users gain access to an application. If AssignmentsRequired is // true (default value), users don’t have access to the application unless an -// assignment is created using the CreateApplicationAssignment API (https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html) -// . If false , all users have access to the application. If an assignment is -// created using CreateApplicationAssignment (https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html) -// ., the user retains access if AssignmentsRequired is set to true . +// assignment is created using the [CreateApplicationAssignment API]. If false , all users have access to the +// application. If an assignment is created using [CreateApplicationAssignment]., the user retains access if +// AssignmentsRequired is set to true . +// +// [CreateApplicationAssignment API]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html +// [CreateApplicationAssignment]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html func (c *Client) PutApplicationAssignmentConfiguration(ctx context.Context, params *PutApplicationAssignmentConfigurationInput, optFns ...func(*Options)) (*PutApplicationAssignmentConfigurationOutput, error) { if params == nil { params = &PutApplicationAssignmentConfigurationInput{} @@ -33,17 +35,17 @@ func (c *Client) PutApplicationAssignmentConfiguration(ctx context.Context, para type PutApplicationAssignmentConfigurationInput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. // // This member is required. ApplicationArn *string // If AssignmentsRequired is true (default value), users don’t have access to the - // application unless an assignment is created using the - // CreateApplicationAssignment API (https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html) - // . If false , all users have access to the application. + // application unless an assignment is created using the [CreateApplicationAssignment API]. If false , all users + // have access to the application. + // + // [CreateApplicationAssignment API]: https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_CreateApplicationAssignment.html // // This member is required. AssignmentRequired *bool diff --git a/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go b/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go index 7ba6a360367..536c4c29d59 100644 --- a/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go +++ b/service/ssoadmin/api_op_PutInlinePolicyToPermissionSet.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Attaches an inline policy 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 action to apply the corresponding IAM policy +// Attaches an inline policy to a permission set. +// +// If the permission set is already referenced by one or more account assignments, +// you will need to call ProvisionPermissionSetafter this action to apply the corresponding IAM policy // updates to all assigned accounts. func (c *Client) PutInlinePolicyToPermissionSet(ctx context.Context, params *PutInlinePolicyToPermissionSetInput, optFns ...func(*Options)) (*PutInlinePolicyToPermissionSetOutput, error) { if params == nil { @@ -31,15 +32,14 @@ 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 // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string diff --git a/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go b/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go index 13133b96ea5..400dc3e08bb 100644 --- a/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go +++ b/service/ssoadmin/api_op_PutPermissionsBoundaryToPermissionSet.go @@ -12,7 +12,7 @@ import ( ) // Attaches an Amazon Web Services managed or customer managed policy to the -// specified PermissionSet as a permissions boundary. +// specified PermissionSetas a permissions boundary. func (c *Client) PutPermissionsBoundaryToPermissionSet(ctx context.Context, params *PutPermissionsBoundaryToPermissionSetInput, optFns ...func(*Options)) (*PutPermissionsBoundaryToPermissionSetOutput, error) { if params == nil { params = &PutPermissionsBoundaryToPermissionSetInput{} diff --git a/service/ssoadmin/api_op_TagResource.go b/service/ssoadmin/api_op_TagResource.go index 77a5ea47537..ecfa86e3c0a 100644 --- a/service/ssoadmin/api_op_TagResource.go +++ b/service/ssoadmin/api_op_TagResource.go @@ -40,9 +40,8 @@ type TagResourceInput struct { Tags []types.Tag // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. InstanceArn *string noSmithyDocumentSerde diff --git a/service/ssoadmin/api_op_UntagResource.go b/service/ssoadmin/api_op_UntagResource.go index fcd2aba1ca8..b4f72b15843 100644 --- a/service/ssoadmin/api_op_UntagResource.go +++ b/service/ssoadmin/api_op_UntagResource.go @@ -39,9 +39,8 @@ type UntagResourceInput struct { TagKeys []string // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. InstanceArn *string noSmithyDocumentSerde diff --git a/service/ssoadmin/api_op_UpdateApplication.go b/service/ssoadmin/api_op_UpdateApplication.go index 915ab018d54..42e6478eff8 100644 --- a/service/ssoadmin/api_op_UpdateApplication.go +++ b/service/ssoadmin/api_op_UpdateApplication.go @@ -29,9 +29,8 @@ func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicatio type UpdateApplicationInput struct { - // Specifies the ARN of the application. For more information about ARNs, see - // Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the - // Amazon Web Services General Reference. + // Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in + // the Amazon Web Services General Reference. // // This member is required. ApplicationArn *string diff --git a/service/ssoadmin/api_op_UpdateInstance.go b/service/ssoadmin/api_op_UpdateInstance.go index 1ddd8fb7912..bf1888b2263 100644 --- a/service/ssoadmin/api_op_UpdateInstance.go +++ b/service/ssoadmin/api_op_UpdateInstance.go @@ -30,8 +30,7 @@ func (c *Client) UpdateInstance(ctx context.Context, params *UpdateInstanceInput type UpdateInstanceInput struct { // The ARN of the instance of IAM Identity Center under which the operation will - // run. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General + // run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General // Reference. // // This member is required. diff --git a/service/ssoadmin/api_op_UpdateInstanceAccessControlAttributeConfiguration.go b/service/ssoadmin/api_op_UpdateInstanceAccessControlAttributeConfiguration.go index d7a2c1d3e3f..dce8981df40 100644 --- a/service/ssoadmin/api_op_UpdateInstanceAccessControlAttributeConfiguration.go +++ b/service/ssoadmin/api_op_UpdateInstanceAccessControlAttributeConfiguration.go @@ -18,8 +18,7 @@ import ( // attributes from the IAM Identity Center identity store. If a SAML assertion // passes any of these attributes, IAM Identity Center replaces the attribute value // with the value from the IAM Identity Center identity store. For more information -// about ABAC, see Attribute-Based Access Control in the IAM Identity Center User -// Guide. +// about ABAC, see Attribute-Based Access Controlin the IAM Identity Center User Guide. func (c *Client) UpdateInstanceAccessControlAttributeConfiguration(ctx context.Context, params *UpdateInstanceAccessControlAttributeConfigurationInput, optFns ...func(*Options)) (*UpdateInstanceAccessControlAttributeConfigurationOutput, error) { if params == nil { params = &UpdateInstanceAccessControlAttributeConfigurationInput{} diff --git a/service/ssoadmin/api_op_UpdatePermissionSet.go b/service/ssoadmin/api_op_UpdatePermissionSet.go index 2bc60c1b0c3..74d7a6d56b6 100644 --- a/service/ssoadmin/api_op_UpdatePermissionSet.go +++ b/service/ssoadmin/api_op_UpdatePermissionSet.go @@ -29,9 +29,8 @@ func (c *Client) UpdatePermissionSet(ctx context.Context, params *UpdatePermissi type UpdatePermissionSetInput struct { // The ARN of the IAM Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. // // This member is required. InstanceArn *string @@ -41,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/api_op_UpdateTrustedTokenIssuer.go b/service/ssoadmin/api_op_UpdateTrustedTokenIssuer.go index 4f957bb47ce..a015a109e82 100644 --- a/service/ssoadmin/api_op_UpdateTrustedTokenIssuer.go +++ b/service/ssoadmin/api_op_UpdateTrustedTokenIssuer.go @@ -12,9 +12,10 @@ import ( ) // Updates the name of the trusted token issuer, or the path of a source attribute -// or destination attribute for a trusted token issuer configuration. Updating this -// trusted token issuer configuration might cause users to lose access to any -// applications that are configured to use the trusted token issuer. +// or destination attribute for a trusted token issuer configuration. +// +// Updating this trusted token issuer configuration might cause users to lose +// access to any applications that are configured to use the trusted token issuer. func (c *Client) UpdateTrustedTokenIssuer(ctx context.Context, params *UpdateTrustedTokenIssuerInput, optFns ...func(*Options)) (*UpdateTrustedTokenIssuerOutput, error) { if params == nil { params = &UpdateTrustedTokenIssuerInput{} diff --git a/service/ssoadmin/doc.go b/service/ssoadmin/doc.go index 84afe08f7a7..c978c7a8463 100644 --- a/service/ssoadmin/doc.go +++ b/service/ssoadmin/doc.go @@ -7,19 +7,26 @@ // connect, your workforce identities and manage their access centrally across // Amazon Web Services accounts and applications. IAM Identity Center is the // recommended approach for workforce authentication and authorization in Amazon -// Web Services, for organizations of any size and type. IAM Identity Center uses -// the sso and identitystore API namespaces. This reference guide provides -// information on single sign-on operations which could be used for access -// management of Amazon Web Services 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 +// Web Services, for organizations of any size and type. +// +// IAM Identity Center uses the sso and identitystore API namespaces. +// +// This reference guide provides information on single sign-on operations which +// could be used for access management of Amazon Web Services accounts. For +// information about IAM Identity Center features, see the [IAM Identity Center User Guide]. +// +// 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) -// . Amazon Web Services 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 Amazon Web Services services. For more information +// principals and principal IDs in IAM Identity Center, see the [Identity Store API Reference]. +// +// Amazon Web Services 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 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]. +// +// [IAM Identity Center User Guide]: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html +// [Tools for Amazon Web Services]: http://aws.amazon.com/tools/ +// [Identity Store API Reference]: https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/welcome.html package ssoadmin diff --git a/service/ssoadmin/options.go b/service/ssoadmin/options.go index 19a73da494a..f4a4e5abe1e 100644 --- a/service/ssoadmin/options.go +++ b/service/ssoadmin/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ssoadmin/types/enums.go b/service/ssoadmin/types/enums.go index a6477501c2a..e1f90f8e709 100644 --- a/service/ssoadmin/types/enums.go +++ b/service/ssoadmin/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApplicationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationStatus) Values() []ApplicationStatus { return []ApplicationStatus{ "ENABLED", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for ApplicationVisibility. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationVisibility) Values() []ApplicationVisibility { return []ApplicationVisibility{ "ENABLED", @@ -47,6 +49,7 @@ const ( // Values returns all known values for AuthenticationMethodType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationMethodType) Values() []AuthenticationMethodType { return []AuthenticationMethodType{ @@ -63,8 +66,9 @@ const ( ) // Values returns all known values for FederationProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FederationProtocol) Values() []FederationProtocol { return []FederationProtocol{ "SAML", @@ -83,8 +87,9 @@ const ( ) // Values returns all known values for GrantType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GrantType) Values() []GrantType { return []GrantType{ "authorization_code", @@ -105,8 +110,9 @@ const ( // Values returns all known values for // InstanceAccessControlAttributeConfigurationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceAccessControlAttributeConfigurationStatus) Values() []InstanceAccessControlAttributeConfigurationStatus { return []InstanceAccessControlAttributeConfigurationStatus{ "ENABLED", @@ -125,8 +131,9 @@ const ( ) // Values returns all known values for InstanceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InstanceStatus) Values() []InstanceStatus { return []InstanceStatus{ "CREATE_IN_PROGRESS", @@ -143,8 +150,9 @@ const ( ) // Values returns all known values for JwksRetrievalOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JwksRetrievalOption) Values() []JwksRetrievalOption { return []JwksRetrievalOption{ "OPEN_ID_DISCOVERY", @@ -160,8 +168,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "USER", @@ -178,8 +187,9 @@ const ( ) // Values returns all known values for ProvisioningStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisioningStatus) Values() []ProvisioningStatus { return []ProvisioningStatus{ "LATEST_PERMISSION_SET_PROVISIONED", @@ -196,8 +206,9 @@ const ( ) // Values returns all known values for ProvisionTargetType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProvisionTargetType) Values() []ProvisionTargetType { return []ProvisionTargetType{ "AWS_ACCOUNT", @@ -214,8 +225,9 @@ const ( ) // Values returns all known values for SignInOrigin. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignInOrigin) Values() []SignInOrigin { return []SignInOrigin{ "IDENTITY_CENTER", @@ -233,8 +245,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -251,8 +264,9 @@ const ( ) // Values returns all known values for TargetType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetType) Values() []TargetType { return []TargetType{ "AWS_ACCOUNT", @@ -267,8 +281,9 @@ const ( ) // Values returns all known values for TrustedTokenIssuerType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustedTokenIssuerType) Values() []TrustedTokenIssuerType { return []TrustedTokenIssuerType{ "OIDC_JWT", diff --git a/service/ssoadmin/types/types.go b/service/ssoadmin/types/types.go index b62f438b281..dd38d65f22a 100644 --- a/service/ssoadmin/types/types.go +++ b/service/ssoadmin/types/types.go @@ -32,8 +32,9 @@ type AccessControlAttribute struct { } // 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. +// more information, see [Attribute mappings]in the IAM Identity Center User Guide. +// +// [Attribute mappings]: https://docs.aws.amazon.com/singlesignon/latest/userguide/attributemappingsconcept.html type AccessControlAttributeValue struct { // The identity source to use when mapping a specified attribute to IAM Identity @@ -46,22 +47,22 @@ type AccessControlAttributeValue struct { } // The assignment that indicates a principal's limited access to a specified -// Amazon Web Services account with a specified permission set. The term principal -// here refers to a user or group that is defined in IAM Identity Center. +// Amazon Web Services account with a specified permission set. +// +// The term principal here refers to a user or group that is defined in IAM +// Identity Center. type AccountAssignment struct { // The identifier of the Amazon Web Services account. AccountId *string - // The ARN of the permission set. For more information about ARNs, see Amazon - // Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon - // Web Services General Reference. + // The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the + // Amazon Web Services General Reference. 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. PrincipalId *string // The entity type for which the assignment will be created. @@ -100,15 +101,13 @@ type AccountAssignmentOperationStatus struct { // The message that contains an error or exception in case of an operation failure. FailureReason *string - // The ARN of the permission set. For more information about ARNs, see Amazon - // Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon - // Web Services General Reference. + // The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the + // Amazon Web Services General Reference. 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. PrincipalId *string // The entity type for which the assignment will be created. @@ -246,8 +245,7 @@ type ApplicationProvider struct { type AttachedManagedPolicy struct { // The ARN of the Amazon Web Services managed policy. For more information about - // ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces in the Amazon Web Services General Reference. + // ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General Reference. Arn *string // The name of the Amazon Web Services managed policy. @@ -325,9 +323,10 @@ 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] // in the IAM User Guide. + // + // [Friendly names and paths]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names Path *string noSmithyDocumentSerde @@ -451,9 +450,8 @@ type InstanceMetadata struct { IdentityStoreId *string // The ARN of the Identity Center instance under which the operation will be - // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and - // Amazon Web Services Service Namespaces in the Amazon Web Services General - // Reference. + // executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services + // General Reference. InstanceArn *string // The name of the Identity Center instance. @@ -585,13 +583,14 @@ type OperationStatusFilter struct { // CustomerManagedPolicyReference to use the name and path of a customer managed // policy, or ManagedPolicyArn to use the ARN of an Amazon Web Services 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) -// 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) -// in the IAM User Guide. +// policy can grant your role. For more information, see [Permissions boundaries for IAM entities]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]in the IAM User Guide. +// +// [Permissions boundaries for IAM entities]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html +// [IAM JSON policy evaluation logic]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html type PermissionsBoundary struct { // Specifies the name and path of a customer managed policy. You must have an IAM @@ -612,15 +611,14 @@ 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. Name *string - // The ARN of the permission set. For more information about ARNs, see Amazon - // Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon - // Web Services General Reference. + // The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the + // Amazon Web Services General Reference. PermissionSetArn *string // Used to redirect users within the application during the federation @@ -649,8 +647,7 @@ type PermissionSetProvisioningStatus struct { FailureReason *string // The ARN of the permission set that is being provisioned. For more information - // about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service - // Namespaces in the Amazon Web Services General Reference. + // about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespacesin the Amazon Web Services General Reference. PermissionSetArn *string // The identifier for tracking the request operation that is generated by the @@ -741,8 +738,10 @@ type SignInOptions struct { // This determines how IAM Identity Center navigates the user to the target // application. It can be one of the following values: + // // - APPLICATION : IAM Identity Center redirects the customer to the configured // ApplicationUrl . + // // - IDENTITY_CENTER : IAM Identity Center uses SAML identity-provider initiated // authentication to sign the customer directly into a SAML-based application. // diff --git a/service/ssooidc/api_op_CreateToken.go b/service/ssooidc/api_op_CreateToken.go index 63f1eeb1312..40d44ebd86e 100644 --- a/service/ssooidc/api_op_CreateToken.go +++ b/service/ssooidc/api_op_CreateToken.go @@ -32,34 +32,38 @@ func (c *Client) CreateToken(ctx context.Context, params *CreateTokenInput, optF type CreateTokenInput struct { // The unique identifier string for the client or application. This value comes - // from the result of the RegisterClient API. + // from the result of the RegisterClientAPI. // // This member is required. ClientId *string // A secret string generated for the client. This value should come from the - // persisted result of the RegisterClient API. + // persisted result of the RegisterClientAPI. // // This member is required. ClientSecret *string // Supports the following OAuth grant types: Device Code and Refresh Token. // Specify either of the following values, depending on the grant type that you - // want: * Device Code - urn:ietf:params:oauth:grant-type:device_code * Refresh - // Token - refresh_token For information about how to obtain the device code, see - // the StartDeviceAuthorization topic. + // want: + // + // * Device Code - urn:ietf:params:oauth:grant-type:device_code + // + // * Refresh Token - refresh_token + // + // For information about how to obtain the device code, see the StartDeviceAuthorization topic. // // This member is required. GrantType *string // Used only when calling this API for the Authorization Code grant type. The // short-term code is used to identify this authorization request. This grant type - // is currently unsupported for the CreateToken API. + // is currently unsupported for the CreateTokenAPI. Code *string // Used only when calling this API for the Device Code grant type. This short-term // code is used to identify this authorization request. This comes from the result - // of the StartDeviceAuthorization API. + // of the StartDeviceAuthorizationAPI. DeviceCode *string // Used only when calling this API for the Authorization Code grant type. This @@ -69,16 +73,18 @@ type CreateTokenInput struct { // Used only when calling this API for the Refresh Token grant type. This token is // used to refresh short-term tokens, such as the access token, that might expire. + // // 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 [IAM Identity Center OIDC API Reference]. + // + // [IAM Identity Center OIDC API Reference]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html RefreshToken *string // The list of scopes for which authorization is requested. The access token that // is issued is limited to the scopes that are granted. If this value is not // specified, IAM Identity Center authorizes all scopes that are configured for the - // client during the call to RegisterClient . + // client during the call to RegisterClient. Scope []string noSmithyDocumentSerde @@ -94,18 +100,22 @@ type CreateTokenOutput struct { // The idToken is not implemented or 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 JSON Web Token (JWT) that identifies who is associated with the issued - // access token. + // see Considerations for Using this Guide in the [IAM Identity Center OIDC API Reference]. + // + // A JSON Web Token (JWT) that identifies who is associated with the issued access + // token. + // + // [IAM Identity Center OIDC API Reference]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html IdToken *string // A token that, if present, can be used to refresh a previously issued access - // token that might have expired. 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) - // . + // token that might have expired. + // + // 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]. + // + // [IAM Identity Center OIDC API Reference]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html RefreshToken *string // Used to notify the client that the returned token is an access token. The diff --git a/service/ssooidc/api_op_CreateTokenWithIAM.go b/service/ssooidc/api_op_CreateTokenWithIAM.go index 63409538940..df87ed5a5e2 100644 --- a/service/ssooidc/api_op_CreateTokenWithIAM.go +++ b/service/ssooidc/api_op_CreateTokenWithIAM.go @@ -39,10 +39,15 @@ type CreateTokenWithIAMInput struct { // Supports the following OAuth grant types: Authorization Code, Refresh Token, // JWT Bearer, and Token Exchange. Specify one of the following values, depending - // on the grant type that you want: * Authorization Code - authorization_code * - // Refresh Token - refresh_token * JWT Bearer - - // urn:ietf:params:oauth:grant-type:jwt-bearer * Token Exchange - - // urn:ietf:params:oauth:grant-type:token-exchange + // on the grant type that you want: + // + // * Authorization Code - authorization_code + // + // * Refresh Token - refresh_token + // + // * JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer + // + // * Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange // // This member is required. GrantType *string @@ -66,16 +71,21 @@ type CreateTokenWithIAMInput struct { // Used only when calling this API for the Refresh Token grant type. This token is // used to refresh short-term tokens, such as the access token, that might expire. + // // 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 [IAM Identity Center OIDC API Reference]. + // + // [IAM Identity Center OIDC API Reference]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html RefreshToken *string // Used only when calling this API for the Token Exchange grant type. This value // specifies the type of token that the requester can receive. The following values - // are supported: * Access Token - urn:ietf:params:oauth:token-type:access_token * - // Refresh Token - urn:ietf:params:oauth:token-type:refresh_token + // are supported: + // + // * Access Token - urn:ietf:params:oauth:token-type:access_token + // + // * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token RequestedTokenType *string // The list of scopes for which authorization is requested. The access token that @@ -94,8 +104,9 @@ type CreateTokenWithIAMInput struct { // Used only when calling this API for the Token Exchange grant type. This value // specifies the type of token that is passed as the subject of the exchange. The - // following value is supported: * Access Token - - // urn:ietf:params:oauth:token-type:access_token + // following value is supported: + // + // * Access Token - urn:ietf:params:oauth:token-type:access_token SubjectTokenType *string noSmithyDocumentSerde @@ -114,17 +125,21 @@ type CreateTokenWithIAMOutput struct { IdToken *string // Indicates the type of tokens that are issued by IAM Identity Center. The - // following values are supported: * Access Token - - // urn:ietf:params:oauth:token-type:access_token * Refresh Token - - // urn:ietf:params:oauth:token-type:refresh_token + // following values are supported: + // + // * Access Token - urn:ietf:params:oauth:token-type:access_token + // + // * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token IssuedTokenType *string // A token that, if present, can be used to refresh a previously issued access - // token that might have expired. 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) - // . + // token that might have expired. + // + // 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]. + // + // [IAM Identity Center OIDC API Reference]: https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html RefreshToken *string // The list of scopes for which authorization is granted. The access token that is diff --git a/service/ssooidc/api_op_StartDeviceAuthorization.go b/service/ssooidc/api_op_StartDeviceAuthorization.go index c568805b226..0b727e38b96 100644 --- a/service/ssooidc/api_op_StartDeviceAuthorization.go +++ b/service/ssooidc/api_op_StartDeviceAuthorization.go @@ -30,22 +30,23 @@ 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. + // Identity Center. This value should come from the persisted result of the RegisterClientAPI + // operation. // // This member is required. ClientId *string // A secret string that is generated for the client. This value should come from - // the persisted result of the RegisterClient API operation. + // the persisted result of the RegisterClientAPI operation. // // This member is required. ClientSecret *string - // The URL for the Amazon Web Services access portal. For more information, see - // Using the Amazon Web Services access portal (https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html) + // The URL for the Amazon Web Services access portal. For more information, see [Using the Amazon Web Services access portal] // in the IAM Identity Center User Guide. // + // [Using the Amazon Web Services access portal]: https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html + // // This member is required. StartUrl *string diff --git a/service/ssooidc/doc.go b/service/ssooidc/doc.go index 53cd4f55a03..1d258e5677b 100644 --- a/service/ssooidc/doc.go +++ b/service/ssooidc/doc.go @@ -6,33 +6,41 @@ // IAM Identity Center OpenID Connect (OIDC) is a web service that enables a // client (such as CLI or a native application) to register with IAM Identity // Center. The service also enables the client to fetch the user’s access token -// upon successful authentication and authorization with IAM Identity Center. IAM -// Identity Center uses the sso and identitystore API namespaces. 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. +// upon successful authentication and authorization with IAM Identity Center. +// +// IAM Identity Center uses the sso and identitystore API namespaces. +// +// # 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 CLI. +// of the OAuth 2.0 Device Authorization Grant standard ([https://tools.ietf.org/html/rfc8628] ) that are necessary to +// enable single sign-on authentication with the CLI. +// // - With older versions of the CLI, the service only emits OIDC access tokens, // so to obtain a new token, users must explicitly re-authenticate. To access the // OIDC flow that supports token refresh and doesn’t require re-authentication, // update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with // support for OIDC token refresh and configurable IAM Identity Center session -// durations. For more information, see Configure Amazon Web Services access -// portal session duration (https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html) -// . +// durations. For more information, see [Configure Amazon Web Services access portal session duration]. +// // - The access tokens provided by this service grant access to all Amazon Web // Services 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 Amazon Web Services Auth (“sigv4”) credentials for use // with IAM-protected Amazon Web Services 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. +// see [GetRoleCredentials]in the IAM Identity Center Portal API Reference Guide. +// +// For general information about IAM Identity Center, see [What is IAM Identity Center?] 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. +// [Configure Amazon Web Services access portal session duration]: https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html +// [GetRoleCredentials]: https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html +// [https://tools.ietf.org/html/rfc8628]: https://tools.ietf.org/html/rfc8628 +// [What is IAM Identity Center?]: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html package ssooidc diff --git a/service/ssooidc/options.go b/service/ssooidc/options.go index b964e7e1090..69ded47c74c 100644 --- a/service/ssooidc/options.go +++ b/service/ssooidc/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/ssooidc/types/errors.go b/service/ssooidc/types/errors.go index 86b62049fd9..54faa9c52fd 100644 --- a/service/ssooidc/types/errors.go +++ b/service/ssooidc/types/errors.go @@ -188,7 +188,7 @@ func (e *InvalidClientMetadataException) ErrorCode() string { func (e *InvalidClientMetadataException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // Indicates that a request contains an invalid grant. This can occur if a client -// makes a CreateToken request with an invalid grant type. +// makes a CreateTokenrequest with an invalid grant type. type InvalidGrantException struct { Message *string diff --git a/service/storagegateway/api_op_ActivateGateway.go b/service/storagegateway/api_op_ActivateGateway.go index 042473e6410..7f24f487932 100644 --- a/service/storagegateway/api_op_ActivateGateway.go +++ b/service/storagegateway/api_op_ActivateGateway.go @@ -16,8 +16,9 @@ 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 -// the gateway VM before you can activate your gateway. +// 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 { params = &ActivateGatewayInput{} @@ -34,13 +35,20 @@ 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 @@ -49,8 +57,11 @@ type ActivateGatewayInput struct { // 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) - // in the Storage Gateway User Guide. + // configuration of your gateway. + // + // For more information, see [Getting activation key] in the Storage Gateway User Guide. + // + // [Getting activation key]: https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html // // This member is required. ActivationKey *string @@ -64,11 +75,12 @@ type ActivateGatewayInput struct { // 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 - // quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the Amazon Web - // Services General Reference. + // Regions and endpoints for Storage Gateway, see [Storage Gateway endpoints and quotas]in the Amazon Web Services + // General Reference. + // + // Valid Values: See [Storage Gateway endpoints and quotas] in the Amazon Web Services General Reference. + // + // [Storage Gateway endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/sg.html // // This member is required. GatewayRegion *string @@ -84,24 +96,30 @@ 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 | - // VTL_SNOW | FILE_S3 | FILE_FSX_SMB + // activation. The default value is CACHED . + // + // Valid Values: STORED | CACHED | VTL | VTL_SNOW | FILE_S3 | FILE_FSX_SMB GatewayType *string // The value that indicates the type of medium changer to use for tape gateway. - // This field is optional. Valid Values: STK-L700 | AWS-Gateway-VTL | - // IBM-03584L32-0402 + // This field is optional. + // + // Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402 MediumChangerType *string // A list of up to 50 tags that you can assign to the gateway. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers that can be represented in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256 characters. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers that can be + // represented in UTF-8 format, and the following special characters: + - = . _ : / + // @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256 characters. Tags []types.Tag // The value that indicates the type of tape drive to use for tape gateway. This - // field is optional. Valid Values: IBM-ULT3580-TD5 + // field is optional. + // + // Valid Values: IBM-ULT3580-TD5 TapeDriveType *string noSmithyDocumentSerde @@ -110,14 +128,15 @@ type ActivateGatewayInput struct { // 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. +// 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 345cd24811c..dd13aed01b5 100644 --- a/service/storagegateway/api_op_AddCache.go +++ b/service/storagegateway/api_op_AddCache.go @@ -12,10 +12,12 @@ 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)]. +// +// 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. +// +// [How Storage Gateway works (architecture)]: https://docs.aws.amazon.com/storagegateway/latest/userguide/StorageGatewayConcepts.html func (c *Client) AddCache(ctx context.Context, params *AddCacheInput, optFns ...func(*Options)) (*AddCacheOutput, error) { if params == nil { params = &AddCacheInput{} @@ -35,13 +37,13 @@ type AddCacheInput struct { // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You - // can get the disk IDs from the ListLocalDisks API. + // can get the disk IDs from the ListLocalDisksAPI. // // 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 +53,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 1408ca498d7..f2d064224db 100644 --- a/service/storagegateway/api_op_AddTagsToResource.go +++ b/service/storagegateway/api_op_AddTagsToResource.go @@ -16,10 +16,15 @@ import ( // 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 // // You can create a maximum of 50 tags for each resource. Virtual tapes and @@ -48,10 +53,12 @@ type AddTagsToResourceInput struct { ResourceARN *string // The key-value pair that represents the tag you want to add to the resource. The - // value can be an empty string. Valid characters for key and value are letters, - // spaces, and numbers representable in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256. + // value can be an empty string. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. // // This member is required. Tags []types.Tag diff --git a/service/storagegateway/api_op_AddUploadBuffer.go b/service/storagegateway/api_op_AddUploadBuffer.go index 4ac1dbea1fe..25f1feeb398 100644 --- a/service/storagegateway/api_op_AddUploadBuffer.go +++ b/service/storagegateway/api_op_AddUploadBuffer.go @@ -12,9 +12,11 @@ import ( // Configures one or more gateway local disks as upload buffer for a specified // gateway. This operation is supported for the stored volume, cached volume, and -// tape gateway types. In the request, you specify the gateway Amazon Resource Name -// (ARN) to which you want to add upload buffer, and one or more disk IDs that you -// want to configure as upload buffer. +// tape gateway types. +// +// In the request, you specify the gateway Amazon Resource Name (ARN) to which you +// want to add upload buffer, and one or more disk IDs that you want to configure +// as upload buffer. func (c *Client) AddUploadBuffer(ctx context.Context, params *AddUploadBufferInput, optFns ...func(*Options)) (*AddUploadBufferOutput, error) { if params == nil { params = &AddUploadBufferInput{} @@ -34,13 +36,13 @@ type AddUploadBufferInput struct { // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You - // can get the disk IDs from the ListLocalDisks API. + // can get the disk IDs from the ListLocalDisksAPI. // // 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 +52,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 6a3b905cc64..2738cc1917f 100644 --- a/service/storagegateway/api_op_AddWorkingStorage.go +++ b/service/storagegateway/api_op_AddWorkingStorage.go @@ -12,12 +12,14 @@ import ( // Configures one or more gateway local disks as working storage for a gateway. // This operation is only supported in the stored volume gateway type. This -// operation is deprecated in cached volume API version 20120630. Use -// AddUploadBuffer instead. Working storage is also referred to as upload buffer. -// You can also use the AddUploadBuffer operation to add upload buffer to a stored -// volume gateway. In the request, you specify the gateway Amazon Resource Name -// (ARN) to which you want to add working storage, and one or more disk IDs that -// you want to configure as working storage. +// operation is deprecated in cached volume API version 20120630. Use AddUploadBufferinstead. +// +// Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer +// operation to add upload buffer to a stored volume gateway. +// +// In the request, you specify the gateway Amazon Resource Name (ARN) to which you +// want to add working storage, and one or more disk IDs that you want to configure +// as working storage. func (c *Client) AddWorkingStorage(ctx context.Context, params *AddWorkingStorageInput, optFns ...func(*Options)) (*AddWorkingStorageOutput, error) { if params == nil { params = &AddWorkingStorageInput{} @@ -34,18 +36,19 @@ 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 // storage. Each string has a minimum length of 1 and maximum length of 300. You - // can get the disk IDs from the ListLocalDisks API. + // can get the disk IDs from the ListLocalDisksAPI. // // 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 @@ -57,8 +60,8 @@ type AddWorkingStorageInput struct { // 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 228af2d2100..8c249f4af29 100644 --- a/service/storagegateway/api_op_AssignTapePool.go +++ b/service/storagegateway/api_op_AssignTapePool.go @@ -52,7 +52,9 @@ type AssignTapePoolInput struct { // 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 + // console. + // + // Valid values: TRUE | FALSE BypassGovernanceRetention bool noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_AssociateFileSystem.go b/service/storagegateway/api_op_AssociateFileSystem.go index 6e458586dea..6b5a63615d8 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 @@ -69,8 +69,10 @@ type AssociateFileSystemInput struct { CacheAttributes *types.CacheAttributes // Specifies the network configuration information for the gateway associated with - // the Amazon FSx file system. If multiple file systems are associated with this - // gateway, this parameter's IpAddresses field is required. + // the Amazon FSx file system. + // + // If multiple file systems are associated with this gateway, this parameter's + // IpAddresses field is required. EndpointNetworkConfiguration *types.EndpointNetworkConfiguration // A list of up to 50 tags that can be assigned to the file system association. diff --git a/service/storagegateway/api_op_AttachVolume.go b/service/storagegateway/api_op_AttachVolume.go index 5a3d859a0d9..6a4165da6f2 100644 --- a/service/storagegateway/api_op_AttachVolume.go +++ b/service/storagegateway/api_op_AttachVolume.go @@ -40,8 +40,10 @@ type AttachVolumeInput struct { 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 DescribeGatewayInformationto get a list of the network interfaces + // available on a gateway. + // + // Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string @@ -60,9 +62,10 @@ type AttachVolumeInput struct { // 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 - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name. + // . 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 noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_CancelArchival.go b/service/storagegateway/api_op_CancelArchival.go index ee316ed38e4..a2eb2b29d22 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 b8c05092361..b4d0f71e931 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 867a92778ca..52ae99e9974 100644 --- a/service/storagegateway/api_op_CreateCachediSCSIVolume.go +++ b/service/storagegateway/api_op_CreateCachediSCSIVolume.go @@ -12,18 +12,22 @@ import ( ) // Creates a cached volume on a specified cached volume gateway. This operation is -// only supported in the cached volume gateway type. Cache storage must be -// allocated to the gateway before you can create a cached volume. Use the AddCache -// operation to add cache storage to a gateway. In the request, you must specify -// the gateway, size of the volume in bytes, the iSCSI target name, an IP address -// on which to expose the target, and a unique client token. In response, the -// gateway creates the volume and returns information about it. This information -// includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target -// ARN that initiators can use to connect to the volume target. Optionally, you can -// provide the ARN for an existing volume as the SourceVolumeARN for this cached -// volume, which creates an exact copy of the existing volume’s latest recovery -// point. The VolumeSizeInBytes value must be equal to or larger than the size of -// the copied volume, in bytes. +// only supported in the cached volume gateway type. +// +// Cache storage must be allocated to the gateway before you can create a cached +// volume. Use the AddCacheoperation to add cache storage to a gateway. +// +// In the request, you must specify the gateway, size of the volume in bytes, the +// iSCSI target name, an IP address on which to expose the target, and a unique +// client token. In response, the gateway creates the volume and returns +// information about it. This information includes the volume Amazon Resource Name +// (ARN), its size, and the iSCSI target ARN that initiators can use to connect to +// the volume target. +// +// Optionally, you can provide the ARN for an existing volume as the +// SourceVolumeARN for this cached volume, which creates an exact copy of the +// existing volume’s latest recovery point. The VolumeSizeInBytes value must be +// equal to or larger than the size of the copied volume, in bytes. func (c *Client) CreateCachediSCSIVolume(ctx context.Context, params *CreateCachediSCSIVolumeInput, optFns ...func(*Options)) (*CreateCachediSCSIVolumeOutput, error) { if params == nil { params = &CreateCachediSCSIVolumeInput{} @@ -47,15 +51,17 @@ type CreateCachediSCSIVolumeInput 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 // 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 DescribeGatewayInformationto get a list of the network interfaces + // available on a gateway. + // + // Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string @@ -64,9 +70,10 @@ type CreateCachediSCSIVolumeInput struct { // 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 - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name. + // . 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. // // This member is required. TargetName *string @@ -77,7 +84,9 @@ type CreateCachediSCSIVolumeInput struct { VolumeSizeInBytes int64 // 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 + // 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 @@ -88,8 +97,9 @@ type CreateCachediSCSIVolumeInput struct { // 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) - // in the Amazon Elastic Compute Cloud API Reference. + // your account use [DescribeSnapshots]in the Amazon Elastic Compute Cloud API Reference. + // + // [DescribeSnapshots]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html SnapshotId *string // The ARN for an existing volume. Specifying this ARN makes the new volume into @@ -99,10 +109,12 @@ type CreateCachediSCSIVolumeInput struct { SourceVolumeARN *string // A list of up to 50 tags that you can assign to a cached volume. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers that you can represent in UTF-8 format, and the following special - // characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256 characters. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers that you + // can represent in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256 characters. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_CreateNFSFileShare.go b/service/storagegateway/api_op_CreateNFSFileShare.go index a2a6b072917..82358623ff0 100644 --- a/service/storagegateway/api_op_CreateNFSFileShare.go +++ b/service/storagegateway/api_op_CreateNFSFileShare.go @@ -14,16 +14,18 @@ import ( // Creates a Network File System (NFS) file share on an existing S3 File Gateway. // In Storage Gateway, a file share is a file system mount point backed by Amazon // S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. -// This operation is only supported for S3 File Gateways. S3 File gateway requires -// Security Token Service (Amazon Web Services STS) to be activated to enable you -// to create a file share. Make sure Amazon Web Services STS is activated in the -// Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon -// 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) -// in the Identity and Access Management User Guide. S3 File Gateways do not -// support creating hard or symbolic links on a file share. +// This operation is only supported for S3 File Gateways. +// +// S3 File gateway requires Security Token Service (Amazon Web Services STS) to be +// activated to enable you to create a file share. Make sure Amazon Web Services +// STS is activated in the Amazon Web Services Region you are creating your S3 File +// Gateway in. If Amazon 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]in the Identity and Access Management User Guide. +// +// S3 File Gateways do not support creating hard or symbolic links on a file share. +// +// [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 func (c *Client) CreateNFSFileShare(ctx context.Context, params *CreateNFSFileShareInput, optFns ...func(*Options)) (*CreateNFSFileShareOutput, error) { if params == nil { params = &CreateNFSFileShareInput{} @@ -56,15 +58,28 @@ type CreateNFSFileShareInput struct { // A custom ARN for the backend storage used for storing data for file shares. It // includes a resource ARN with an optional prefix concatenation. The prefix must - // end with a forward slash (/). You can specify LocationARN as a bucket ARN, - // access point ARN or access point alias, as shown in the following examples. - // Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: - // 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) - // in the Amazon S3 User Guide. Access point alias: - // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // end with a forward slash (/). + // + // You can specify LocationARN as a bucket ARN, access point ARN or access point + // alias, as shown in the following examples. + // + // Bucket ARN: + // + // arn:aws:s3:::my-bucket/prefix/ + // + // Access point ARN: + // + // 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]in the Amazon + // S3 User Guide. + // + // Access point alias: + // + // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // + // [Delegating access control to access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control // // This member is required. LocationARN *string @@ -79,9 +94,10 @@ type CreateNFSFileShareInput struct { AuditDestinationARN *string // Specifies the Region of the S3 bucket where the NFS file share stores files. - // This parameter is required for NFS file shares that connect to Amazon S3 through - // a VPC endpoint, a VPC access point, or an access point alias that points to a - // VPC access point. + // + // This parameter is required for NFS file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access point alias that points + // to a VPC access point. BucketRegion *string // Specifies refresh cache information for the file share. @@ -92,21 +108,29 @@ 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: - // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA + // 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. + // 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. 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 + // 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 @@ -122,11 +146,19 @@ type CreateNFSFileShareInput struct { // before generating an ObjectUploaded notification. Because clients can make many // small writes to files, it's best to set this parameter for as long as possible // to avoid generating multiple notifications for the same file in a small time - // period. SettlingTimeInSeconds has no effect on the timing of the object - // uploading to Amazon S3, only the timing of the notification. The following - // example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. - // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets - // NotificationPolicy off. {} + // period. + // + // SettlingTimeInSeconds has no effect on the timing of the object uploading to + // Amazon S3, only the timing of the notification. + // + // The following example sets NotificationPolicy on with SettlingTimeInSeconds set + // to 60. + // + // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} + // + // The following example sets NotificationPolicy off. + // + // {} NotificationPolicy *string // A value that sets the access control list (ACL) permission for objects in the @@ -135,36 +167,49 @@ type CreateNFSFileShareInput struct { 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 // 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: + // 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. Squash *string // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is - // a key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // a key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag // Specifies the DNS name for the VPC endpoint that the NFS file share uses to - // connect to Amazon S3. This parameter is required for NFS file shares that - // connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access - // point alias that points to a VPC access point. + // connect to Amazon S3. + // + // This parameter is required for NFS file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access point alias that points + // to a VPC access point. VPCEndpointDNSName *string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_CreateSMBFileShare.go b/service/storagegateway/api_op_CreateSMBFileShare.go index 29cf17e1a1e..5337d755024 100644 --- a/service/storagegateway/api_op_CreateSMBFileShare.go +++ b/service/storagegateway/api_op_CreateSMBFileShare.go @@ -14,16 +14,18 @@ import ( // Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. // In Storage Gateway, a file share is a file system mount point backed by Amazon // S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. -// This operation is only supported for S3 File Gateways. S3 File Gateways require -// Security Token Service (Amazon Web Services STS) to be activated to enable you -// to create a file share. Make sure that Amazon Web Services STS is activated in -// the Amazon Web Services Region you are creating your S3 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) -// in the Identity and Access Management User Guide. File gateways don't support -// creating hard or symbolic links on a file share. +// This operation is only supported for S3 File Gateways. +// +// S3 File Gateways require Security Token Service (Amazon Web Services STS) to be +// activated to enable you to create a file share. Make sure that Amazon Web +// Services STS is activated in the Amazon Web Services Region you are creating +// your S3 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]in the Identity and Access Management User Guide. +// +// File gateways don't support creating hard or symbolic links on a file share. +// +// [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 func (c *Client) CreateSMBFileShare(ctx context.Context, params *CreateSMBFileShareInput, optFns ...func(*Options)) (*CreateSMBFileShareOutput, error) { if params == nil { params = &CreateSMBFileShareInput{} @@ -55,15 +57,28 @@ type CreateSMBFileShareInput struct { // A custom ARN for the backend storage used for storing data for file shares. It // includes a resource ARN with an optional prefix concatenation. The prefix must - // end with a forward slash (/). You can specify LocationARN as a bucket ARN, - // access point ARN or access point alias, as shown in the following examples. - // Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: - // 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) - // in the Amazon S3 User Guide. Access point alias: - // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // end with a forward slash (/). + // + // You can specify LocationARN as a bucket ARN, access point ARN or access point + // alias, as shown in the following examples. + // + // Bucket ARN: + // + // arn:aws:s3:::my-bucket/prefix/ + // + // Access point ARN: + // + // 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]in the Amazon + // S3 User Guide. + // + // Access point alias: + // + // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // + // [Delegating access control to access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control // // This member is required. LocationARN *string @@ -81,22 +96,26 @@ 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 - // permissions. + // @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 // The Amazon Resource Name (ARN) of the storage used for audit logs. 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. - // This parameter is required for SMB file shares that connect to Amazon S3 through - // a VPC endpoint, a VPC access point, or an access point alias that points to a - // VPC access point. + // + // This parameter is required for SMB file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access point alias that points + // to a VPC access point. BucketRegion *string // Specifies refresh cache information for the file share. @@ -108,17 +127,23 @@ type CreateSMBFileShareInput struct { 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: - // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA + // 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. + // 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. 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 @@ -128,7 +153,9 @@ type CreateSMBFileShareInput struct { 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 + // 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 @@ -141,11 +168,19 @@ type CreateSMBFileShareInput struct { // before generating an ObjectUploaded notification. Because clients can make many // small writes to files, it's best to set this parameter for as long as possible // to avoid generating multiple notifications for the same file in a small time - // period. SettlingTimeInSeconds has no effect on the timing of the object - // uploading to Amazon S3, only the timing of the notification. The following - // example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. - // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets - // NotificationPolicy off. {} + // period. + // + // SettlingTimeInSeconds has no effect on the timing of the object uploading to + // Amazon S3, only the timing of the notification. + // + // The following example sets NotificationPolicy on with SettlingTimeInSeconds set + // to 60. + // + // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} + // + // The following example sets NotificationPolicy off. + // + // {} NotificationPolicy *string // A value that sets the access control list (ACL) permission for objects in the @@ -154,43 +189,57 @@ type CreateSMBFileShareInput struct { ObjectACL types.ObjectACL // Specifies whether opportunistic locking is enabled for the SMB file share. + // // Enabling opportunistic locking on case-sensitive shares is not recommended for // workloads that involve access to files with the same name in different case. + // // Valid Values: true | false 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 // 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 + // permissions. + // + // For more information, see [Using Microsoft Windows ACLs to control access to an SMB file share] in the Storage Gateway User Guide. + // + // Valid Values: true | false + // + // [Using Microsoft Windows ACLs to control access to an SMB file share]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html SMBACLEnabled *bool // A list of up to 50 tags that can be assigned to the NFS file share. Each tag is - // a key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // a key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag // Specifies the DNS name for the VPC endpoint that the SMB file share uses to - // connect to Amazon S3. This parameter is required for SMB file shares that - // connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access - // point alias that points to a VPC access point. + // connect to Amazon S3. + // + // This parameter is required for SMB file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access 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 diff --git a/service/storagegateway/api_op_CreateSnapshot.go b/service/storagegateway/api_op_CreateSnapshot.go index 06d7404ea3a..b4e734618a1 100644 --- a/service/storagegateway/api_op_CreateSnapshot.go +++ b/service/storagegateway/api_op_CreateSnapshot.go @@ -11,26 +11,33 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Initiates a snapshot of a volume. Storage Gateway provides the ability to back -// up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for -// 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 +// Initiates a snapshot of a volume. +// +// Storage Gateway provides the ability to back up point-in-time snapshots of your +// data to Amazon Simple Storage (Amazon S3) for 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]. +// +// 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) -// 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) -// page. +// 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]or [DeleteSnapshot] 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]page. +// +// [Editing a snapshot schedule]: https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot +// [Welcome]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html +// [DescribeSnapshots]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html +// [DeleteSnapshot]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html func (c *Client) CreateSnapshot(ctx context.Context, params *CreateSnapshotInput, optFns ...func(*Options)) (*CreateSnapshotOutput, error) { if params == nil { params = &CreateSnapshotInput{} @@ -47,8 +54,10 @@ 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, @@ -58,17 +67,19 @@ type CreateSnapshotInput struct { // This member is required. SnapshotDescription *string - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to - // return a list of gateway volumes. + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a + // list of gateway volumes. // // This member is required. VolumeARN *string // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag noSmithyDocumentSerde @@ -79,7 +90,7 @@ 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 ). + // 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 8545fa4be03..a52649b6611 100644 --- a/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go +++ b/service/storagegateway/api_op_CreateSnapshotFromVolumeRecoveryPoint.go @@ -12,20 +12,25 @@ import ( ) // Initiates a snapshot of a gateway from a volume recovery point. This operation -// 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 -// CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by -// providing its Amazon Resource Name (ARN). You must also provide a description +// 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 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 // snapshot and its description appear in the Storage Gateway console. In response, // 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) -// in the Amazon Elastic Compute Cloud API Reference. +// snapshot. +// +// To list or delete a snapshot, you must use the Amazon EC2 API. For more +// information, see [DescribeSnapshots]or [DeleteSnapshot] in the Amazon Elastic Compute Cloud API Reference. +// +// [DescribeSnapshots]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html +// [DeleteSnapshot]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html func (c *Client) CreateSnapshotFromVolumeRecoveryPoint(ctx context.Context, params *CreateSnapshotFromVolumeRecoveryPointInput, optFns ...func(*Options)) (*CreateSnapshotFromVolumeRecoveryPointOutput, error) { if params == nil { params = &CreateSnapshotFromVolumeRecoveryPointInput{} @@ -50,18 +55,19 @@ type CreateSnapshotFromVolumeRecoveryPointInput struct { // This member is required. SnapshotDescription *string - // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the - // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for - // specified VolumeARN. + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation + // to return to retrieve the TargetARN for specified VolumeARN. // // This member is required. VolumeARN *string // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag noSmithyDocumentSerde @@ -72,9 +78,8 @@ type CreateSnapshotFromVolumeRecoveryPointOutput struct { // The ID of the snapshot. SnapshotId *string - // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the - // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for - // specified VolumeARN. + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation + // to return to retrieve the TargetARN for specified VolumeARN. VolumeARN *string // The time the volume was created from the recovery point. diff --git a/service/storagegateway/api_op_CreateStorediSCSIVolume.go b/service/storagegateway/api_op_CreateStorediSCSIVolume.go index 91939ae03c1..dca4521c60a 100644 --- a/service/storagegateway/api_op_CreateStorediSCSIVolume.go +++ b/service/storagegateway/api_op_CreateStorediSCSIVolume.go @@ -12,14 +12,18 @@ import ( ) // 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 -// are creating the volume. In response, the gateway creates the volume and returns -// volume information such as the volume Amazon Resource Name (ARN), its size, and -// the iSCSI target ARN that initiators can use to connect to the volume target. +// 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 are creating the volume. In response, the gateway creates the volume and +// returns volume information such as the volume Amazon Resource Name (ARN), its +// size, and the iSCSI target ARN that initiators can use to connect to the volume +// target. func (c *Client) CreateStorediSCSIVolume(ctx context.Context, params *CreateStorediSCSIVolumeInput, optFns ...func(*Options)) (*CreateStorediSCSIVolumeOutput, error) { if params == nil { params = &CreateStorediSCSIVolumeInput{} @@ -36,35 +40,45 @@ 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) - // to list disk IDs for a gateway. + // volume. Use [ListLocalDisks]to list disk IDs for a gateway. + // + // [ListLocalDisks]: https://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html // // 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 DescribeGatewayInformationto get a list of the network interfaces + // available on a gateway. + // + // Valid Values: A valid IP address. // // This member is required. NetworkInterfaceId *string // Set to true if you want to preserve the data on the local disk. Otherwise, set - // to false to create an empty volume. Valid Values: true | false + // to false to create an empty volume. + // + // Valid Values: true | false // // This member is required. PreserveExistingData bool @@ -73,15 +87,18 @@ type CreateStorediSCSIVolumeInput struct { // 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 - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name. + // . 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. // // This member is required. TargetName *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 + // 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 @@ -92,15 +109,18 @@ type CreateStorediSCSIVolumeInput struct { // 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) - // in the Amazon Elastic Compute Cloud API Reference. + // your account use [DescribeSnapshots]in the Amazon Elastic Compute Cloud API Reference. + // + // [DescribeSnapshots]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html SnapshotId *string // A list of up to 50 tags that can be assigned to a stored volume. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_CreateTapePool.go b/service/storagegateway/api_op_CreateTapePool.go index 3f799a5b104..a13b6e70d48 100644 --- a/service/storagegateway/api_op_CreateTapePool.go +++ b/service/storagegateway/api_op_CreateTapePool.go @@ -55,10 +55,12 @@ type CreateTapePoolInput struct { RetentionLockType types.RetentionLockType // A list of up to 50 tags that can be assigned to tape pool. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag noSmithyDocumentSerde @@ -67,8 +69,8 @@ type CreateTapePoolInput struct { type CreateTapePoolOutput struct { // The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use - // the ListTapePools operation to return a list of tape pools for your account and - // Amazon Web Services Region. + // the ListTapePoolsoperation to return a list of tape pools for your account and Amazon Web + // Services Region. PoolARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_CreateTapeWithBarcode.go b/service/storagegateway/api_op_CreateTapeWithBarcode.go index dd420a90205..1c798c1df30 100644 --- a/service/storagegateway/api_op_CreateTapeWithBarcode.go +++ b/service/storagegateway/api_op_CreateTapeWithBarcode.go @@ -14,9 +14,10 @@ import ( // Creates a virtual tape by using your own barcode. You write data to the virtual // tape and then archive the tape. A barcode is unique and cannot be reused if it // has already been used on a tape. This applies to barcodes used on deleted tapes. -// This operation is only supported in the tape gateway type. Cache storage must be -// allocated to the gateway before you can create a virtual tape. Use the AddCache -// operation to add cache storage to a gateway. +// This operation is only supported in the tape gateway type. +// +// Cache storage must be allocated to the gateway before you can create a virtual +// tape. Use the AddCacheoperation to add cache storage to a gateway. func (c *Client) CreateTapeWithBarcode(ctx context.Context, params *CreateTapeWithBarcodeInput, optFns ...func(*Options)) (*CreateTapeWithBarcodeOutput, error) { if params == nil { params = &CreateTapeWithBarcodeInput{} @@ -36,26 +37,31 @@ func (c *Client) CreateTapeWithBarcode(ctx context.Context, params *CreateTapeWi type CreateTapeWithBarcodeInput struct { // The unique Amazon Resource Name (ARN) that represents the gateway to associate - // the virtual tape with. Use the ListGateways operation to return a list of - // gateways for your account and Amazon Web Services Region. + // the virtual tape with. Use the ListGatewaysoperation to return a list of gateways for your + // account and Amazon Web Services Region. // // 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 - // The size, in bytes, of the virtual tape that you want to create. The size must - // be aligned by gigabyte (1024*1024*1024 bytes). + // The size, in bytes, of the virtual tape that you want to create. + // + // The size must be aligned by gigabyte (1024*1024*1024 bytes). // // This member is required. TapeSizeInBytes *int64 // 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 + // 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 @@ -71,10 +77,12 @@ type CreateTapeWithBarcodeInput struct { PoolId *string // A list of up to 50 tags that can be assigned to a virtual tape that has a - // barcode. Each tag is a key-value pair. Valid characters for key and value are - // letters, spaces, and numbers representable in UTF-8 format, and the following - // special characters: + - = . _ : / @. The maximum length of a tag's key is 128 - // characters, and the maximum length for a tag's value is 256. + // barcode. Each tag is a key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag // Set to TRUE if the tape you are creating is to be configured as a diff --git a/service/storagegateway/api_op_CreateTapes.go b/service/storagegateway/api_op_CreateTapes.go index e67a5e72401..51130395791 100644 --- a/service/storagegateway/api_op_CreateTapes.go +++ b/service/storagegateway/api_op_CreateTapes.go @@ -13,8 +13,9 @@ import ( // Creates one or more virtual tapes. You write data to the virtual tapes and then // archive the tapes. This operation is only supported in the tape gateway type. +// // Cache storage must be allocated to the gateway before you can create virtual -// tapes. Use the AddCache operation to add cache storage to a gateway. +// tapes. Use the AddCacheoperation to add cache storage to a gateway. func (c *Client) CreateTapes(ctx context.Context, params *CreateTapesInput, optFns ...func(*Options)) (*CreateTapesOutput, error) { if params == nil { params = &CreateTapesInput{} @@ -34,15 +35,16 @@ func (c *Client) CreateTapes(ctx context.Context, params *CreateTapesInput, optF 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 - // ClientToken prevents creating the tape multiple times. + // use the same ClientToken you specified in the initial request. + // + // Using the same ClientToken prevents creating the tape multiple times. // // This member is required. ClientToken *string // The unique Amazon Resource Name (ARN) that represents the gateway to associate - // the virtual tapes with. Use the ListGateways operation to return a list of - // gateways for your account and Amazon Web Services Region. + // the virtual tapes with. Use the ListGatewaysoperation to return a list of gateways for your + // account and Amazon Web Services Region. // // This member is required. GatewayARN *string @@ -53,20 +55,25 @@ type CreateTapesInput struct { NumTapesToCreate *int32 // A prefix that you append to the barcode of the virtual tape you are creating. - // This prefix makes the barcode unique. The prefix must be 1-4 characters in - // length and must be one of the uppercase letters from A to Z. + // This prefix makes the barcode unique. + // + // The prefix must be 1-4 characters in length and must be one of the uppercase + // letters from A to Z. // // This member is required. TapeBarcodePrefix *string - // The size, in bytes, of the virtual tapes that you want to create. The size must - // be aligned by gigabyte (1024*1024*1024 bytes). + // The size, in bytes, of the virtual tapes that you want to create. + // + // The size must be aligned by gigabyte (1024*1024*1024 bytes). // // This member is required. TapeSizeInBytes *int64 // 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 + // 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 @@ -82,10 +89,12 @@ type CreateTapesInput struct { PoolId *string // A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag // Set to TRUE if the tape you are creating is to be configured as a diff --git a/service/storagegateway/api_op_DeleteAutomaticTapeCreationPolicy.go b/service/storagegateway/api_op_DeleteAutomaticTapeCreationPolicy.go index 4d8ab219d2a..cbc40226f6d 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 1c624145cb2..ec1c7ccae64 100644 --- a/service/storagegateway/api_op_DeleteBandwidthRateLimit.go +++ b/service/storagegateway/api_op_DeleteBandwidthRateLimit.go @@ -32,17 +32,20 @@ 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 - // to delete. Valid Values: UPLOAD | DOWNLOAD | ALL + // to delete. + // + // Valid Values: UPLOAD | DOWNLOAD | ALL // // 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 @@ -54,8 +57,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 5839b1f8a5e..86928413540 100644 --- a/service/storagegateway/api_op_DeleteChapCredentials.go +++ b/service/storagegateway/api_op_DeleteChapCredentials.go @@ -29,8 +29,10 @@ 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. @@ -38,9 +40,8 @@ type DeleteChapCredentialsInput struct { // This member is required. InitiatorName *string - // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the - // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for - // specified VolumeARN. + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation + // to return to retrieve the TargetARN for specified VolumeARN. // // This member is required. TargetARN *string diff --git a/service/storagegateway/api_op_DeleteFileShare.go b/service/storagegateway/api_op_DeleteFileShare.go index a086bb450b6..5202ee65c96 100644 --- a/service/storagegateway/api_op_DeleteFileShare.go +++ b/service/storagegateway/api_op_DeleteFileShare.go @@ -39,7 +39,9 @@ type DeleteFileShareInput struct { // 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 + // 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 45e87962bdf..e73e367b762 100644 --- a/service/storagegateway/api_op_DeleteGateway.go +++ b/service/storagegateway/api_op_DeleteGateway.go @@ -13,16 +13,21 @@ import ( // Deletes a gateway. To specify which gateway to delete, use the Amazon Resource // Name (ARN) of the gateway in your request. The operation deletes the gateway; // however, it does not delete the gateway virtual machine (VM) from your host -// computer. After you delete a gateway, you cannot reactivate it. Completed -// snapshots of the gateway volumes are not deleted upon deleting the gateway, -// however, pending snapshots will not complete. After you delete a gateway, your -// next step is to remove it from your environment. You no longer pay software -// charges after the gateway is deleted; however, your existing Amazon EBS -// snapshots persist and you will continue to be billed for these snapshots. You -// 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) . +// computer. +// +// After you delete a gateway, you cannot reactivate it. Completed snapshots of +// the gateway volumes are not deleted upon deleting the gateway, however, pending +// snapshots will not complete. After you delete a gateway, your next step is to +// remove it from your environment. +// +// You no longer pay software charges after the gateway is deleted; however, your +// existing Amazon EBS snapshots persist and you will continue to be billed for +// these snapshots. You 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]. +// +// [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 +46,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 +58,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 ce9c47b2996..c3e98b3cf93 100644 --- a/service/storagegateway/api_op_DeleteSnapshotSchedule.go +++ b/service/storagegateway/api_op_DeleteSnapshotSchedule.go @@ -10,14 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon Elastic Compute Cloud API Reference. +// 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]. 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]in the Amazon Elastic Compute Cloud API Reference. +// +// [Backing up your volumes]: https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html +// [DescribeSnapshots]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html func (c *Client) DeleteSnapshotSchedule(ctx context.Context, params *DeleteSnapshotScheduleInput, optFns ...func(*Options)) (*DeleteSnapshotScheduleOutput, error) { if params == nil { params = &DeleteSnapshotScheduleInput{} diff --git a/service/storagegateway/api_op_DeleteTape.go b/service/storagegateway/api_op_DeleteTape.go index 0a43b139f14..ebaf593da9b 100644 --- a/service/storagegateway/api_op_DeleteTape.go +++ b/service/storagegateway/api_op_DeleteTape.go @@ -31,8 +31,8 @@ func (c *Client) DeleteTape(ctx context.Context, params *DeleteTapeInput, optFns type DeleteTapeInput struct { // The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to - // delete is associated with. Use the ListGateways operation to return a list of - // gateways for your account and Amazon Web Services Region. + // delete is associated with. Use the ListGatewaysoperation 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_DeleteVolume.go b/service/storagegateway/api_op_DeleteVolume.go index 35d0a267024..4db5bde2f30 100644 --- a/service/storagegateway/api_op_DeleteVolume.go +++ b/service/storagegateway/api_op_DeleteVolume.go @@ -10,18 +10,22 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified storage volume that you previously created using the -// CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only -// supported in the cached volume and stored volume types. For stored volume -// gateways, the local disk that was configured as the storage volume is not -// deleted. You can reuse the local disk to create another storage volume. Before -// you delete a volume, make sure there are no iSCSI connections to the volume you -// 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) -// 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. +// Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume +// API. This operation is only supported in the cached volume and stored volume +// types. For stored volume gateways, the local disk that was configured as the +// storage volume is not deleted. You can reuse the local disk to create another +// storage volume. +// +// Before you delete a volume, make sure there are no iSCSI connections to the +// volume you 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]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. +// +// [DescribeSnapshots]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, optFns ...func(*Options)) (*DeleteVolumeOutput, error) { if params == nil { params = &DeleteVolumeInput{} @@ -40,8 +44,8 @@ func (c *Client) DeleteVolume(ctx context.Context, params *DeleteVolumeInput, op // A JSON object containing the DeleteVolumeInput$VolumeARN to delete. type DeleteVolumeInput struct { - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to - // return a list of gateway volumes. + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a + // list of gateway volumes. // // This member is required. VolumeARN *string diff --git a/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go b/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go index cb36e2bf350..0ea43a5f6bd 100644 --- a/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go +++ b/service/storagegateway/api_op_DescribeAvailabilityMonitorTest.go @@ -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 2e32f1b939b..e41a0dd98c5 100644 --- a/service/storagegateway/api_op_DescribeBandwidthRateLimit.go +++ b/service/storagegateway/api_op_DescribeBandwidthRateLimit.go @@ -13,12 +13,12 @@ import ( // 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 -// 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 -// gateway in your request. +// describe bandwidth rate limits for S3 file gateways, use 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 gateway in your request. func (c *Client) DescribeBandwidthRateLimit(ctx context.Context, params *DescribeBandwidthRateLimitInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitOutput, error) { if params == nil { params = &DescribeBandwidthRateLimitInput{} @@ -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 4b75dc4d05e..b03852cf684 100644 --- a/service/storagegateway/api_op_DescribeBandwidthRateLimitSchedule.go +++ b/service/storagegateway/api_op_DescribeBandwidthRateLimitSchedule.go @@ -11,20 +11,26 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Returns information about the bandwidth rate limit schedule of a gateway. By +// Returns information about the bandwidth rate limit schedule of a gateway. By +// // default, gateways do not have bandwidth rate limit schedules, which means no // bandwidth rate limiting is in effect. This operation is supported only for // volume, tape and S3 file gateways. FSx file gateways do not support bandwidth -// rate limits. This operation returns information about a gateway's bandwidth rate -// limit schedule. A bandwidth rate limit schedule consists of one or more -// bandwidth rate limit intervals. A bandwidth rate limit interval defines a period -// of time on one or more days of the week, during which bandwidth rate limits are -// specified for uploading, downloading, or both. A bandwidth rate limit interval -// consists of one or more days of the week, a start hour and minute, an ending -// hour and minute, and bandwidth rate limits for uploading and downloading If no -// bandwidth rate limit schedule intervals are set for the gateway, this operation -// returns an empty response. To specify which gateway to describe, use the Amazon -// Resource Name (ARN) of the gateway in your request. +// rate limits. +// +// This operation returns information about a gateway's bandwidth rate limit +// schedule. A bandwidth rate limit schedule consists of one or more bandwidth rate +// limit intervals. A bandwidth rate limit interval defines a period of time on one +// or more days of the week, during which bandwidth rate limits are specified for +// uploading, downloading, or both. +// +// A bandwidth rate limit interval consists of one or more days of the week, a +// start hour and minute, an ending hour and minute, and bandwidth rate limits for +// uploading and downloading +// +// If no bandwidth rate limit schedule intervals are set for the gateway, this +// operation returns an empty response. To specify which gateway to describe, use +// the Amazon Resource Name (ARN) of the gateway in your request. func (c *Client) DescribeBandwidthRateLimitSchedule(ctx context.Context, params *DescribeBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitScheduleOutput, error) { if params == nil { params = &DescribeBandwidthRateLimitScheduleInput{} @@ -42,8 +48,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 @@ -53,12 +59,12 @@ type DescribeBandwidthRateLimitScheduleInput struct { type DescribeBandwidthRateLimitScheduleOutput struct { - // An array that contains the bandwidth rate limit intervals for a tape or volume + // An array that contains the bandwidth rate limit intervals for a tape or volume // 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 2ec75f64565..946eeab35fc 100644 --- a/service/storagegateway/api_op_DescribeCache.go +++ b/service/storagegateway/api_op_DescribeCache.go @@ -11,9 +11,10 @@ import ( ) // Returns information about the cache of a gateway. This operation is only -// supported in the cached volume, tape, and file gateway types. The response -// includes disk IDs that are configured as cache, and it includes the amount of -// cache allocated and used. +// supported in the cached volume, tape, and file gateway types. +// +// The response includes disk IDs that are configured as cache, and it includes +// the amount of cache allocated and used. func (c *Client) DescribeCache(ctx context.Context, params *DescribeCacheInput, optFns ...func(*Options)) (*DescribeCacheOutput, error) { if params == nil { params = &DescribeCacheInput{} @@ -31,8 +32,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 @@ -65,11 +66,11 @@ type DescribeCacheOutput struct { // An array of strings that identify disks that are to be configured as working // storage. Each string has a minimum length of 1 and maximum length of 300. You - // can get the disk IDs from the ListLocalDisks API. + // can get the disk IDs from the ListLocalDisksAPI. 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_DescribeCachediSCSIVolumes.go b/service/storagegateway/api_op_DescribeCachediSCSIVolumes.go index d1e91eb3c59..e63c8c7c940 100644 --- a/service/storagegateway/api_op_DescribeCachediSCSIVolumes.go +++ b/service/storagegateway/api_op_DescribeCachediSCSIVolumes.go @@ -12,10 +12,11 @@ import ( ) // Returns a description of the gateway volumes specified in the request. This -// operation is only supported in the cached volume gateway types. The list of -// gateway volumes in the request must be from one gateway. In the response, -// Storage Gateway returns volume information sorted by volume Amazon Resource Name -// (ARN). +// operation is only supported in the cached volume gateway types. +// +// The list of gateway volumes in the request must be from one gateway. In the +// response, Storage Gateway returns volume information sorted by volume Amazon +// Resource Name (ARN). func (c *Client) DescribeCachediSCSIVolumes(ctx context.Context, params *DescribeCachediSCSIVolumesInput, optFns ...func(*Options)) (*DescribeCachediSCSIVolumesOutput, error) { if params == nil { params = &DescribeCachediSCSIVolumesInput{} @@ -35,7 +36,7 @@ type DescribeCachediSCSIVolumesInput struct { // An array of strings where each string represents the Amazon Resource Name (ARN) // of a cached volume. All of the specified cached volumes must be from the same - // gateway. Use ListVolumes to get volume ARNs for a gateway. + // gateway. Use ListVolumesto get volume ARNs for a gateway. // // This member is required. VolumeARNs []string diff --git a/service/storagegateway/api_op_DescribeChapCredentials.go b/service/storagegateway/api_op_DescribeChapCredentials.go index e975e55067e..fcfbe8ef828 100644 --- a/service/storagegateway/api_op_DescribeChapCredentials.go +++ b/service/storagegateway/api_op_DescribeChapCredentials.go @@ -34,9 +34,8 @@ func (c *Client) DescribeChapCredentials(ctx context.Context, params *DescribeCh // target. type DescribeChapCredentialsInput struct { - // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the - // DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for - // specified VolumeARN. + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation + // to return to retrieve the TargetARN for specified VolumeARN. // // This member is required. TargetARN *string @@ -47,16 +46,20 @@ 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 - // information is provided in a JSON object with the following fields: + // 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. ChapCredentials []types.ChapInfo diff --git a/service/storagegateway/api_op_DescribeGatewayInformation.go b/service/storagegateway/api_op_DescribeGatewayInformation.go index 2733b370a00..426cfaadeaf 100644 --- a/service/storagegateway/api_op_DescribeGatewayInformation.go +++ b/service/storagegateway/api_op_DescribeGatewayInformation.go @@ -32,8 +32,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 @@ -60,11 +60,13 @@ type DescribeGatewayInformationOutput struct { // The Amazon Web Services Region where the Amazon EC2 instance is located. Ec2InstanceRegion *string - // The type of endpoint for your gateway. Valid Values: STANDARD | FIPS + // 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. @@ -78,8 +80,7 @@ type DescribeGatewayInformationOutput struct { // The name you configured for your gateway. GatewayName *string - // A NetworkInterface array that contains descriptions of the gateway network - // interfaces. + // A NetworkInterface array that contains descriptions of the gateway network interfaces. GatewayNetworkInterfaces []types.NetworkInterface // A value that indicates the operating state of the gateway. diff --git a/service/storagegateway/api_op_DescribeMaintenanceStartTime.go b/service/storagegateway/api_op_DescribeMaintenanceStartTime.go index 4d927e65e8c..460e27b1477 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,11 +40,16 @@ 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 @@ -57,8 +62,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 diff --git a/service/storagegateway/api_op_DescribeSMBSettings.go b/service/storagegateway/api_op_DescribeSMBSettings.go index b2168691eba..969f6e3ed15 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,15 +43,22 @@ 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. ActiveDirectoryStatus types.ActiveDirectoryStatus @@ -63,12 +70,14 @@ 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 @@ -76,10 +85,12 @@ 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. diff --git a/service/storagegateway/api_op_DescribeSnapshotSchedule.go b/service/storagegateway/api_op_DescribeSnapshotSchedule.go index 7f3fa36ab60..61534d667b0 100644 --- a/service/storagegateway/api_op_DescribeSnapshotSchedule.go +++ b/service/storagegateway/api_op_DescribeSnapshotSchedule.go @@ -30,12 +30,11 @@ func (c *Client) DescribeSnapshotSchedule(ctx context.Context, params *DescribeS return out, nil } -// A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the -// volume. +// A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume. type DescribeSnapshotScheduleInput struct { - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to - // return a list of gateway volumes. + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a + // list of gateway volumes. // // This member is required. VolumeARN *string diff --git a/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go b/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go index ba46a7359fe..37485059801 100644 --- a/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go +++ b/service/storagegateway/api_op_DescribeStorediSCSIVolumes.go @@ -30,12 +30,12 @@ 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) // of a stored volume. All of the specified stored volumes must be from the same - // gateway. Use ListVolumes to get volume ARNs for a gateway. + // gateway. Use ListVolumesto get volume ARNs for a gateway. // // This member is required. VolumeARNs []string @@ -45,34 +45,49 @@ type DescribeStorediSCSIVolumesInput struct { type DescribeStorediSCSIVolumesOutput struct { - // Describes a single unit of output from DescribeStorediSCSIVolumes . The - // following fields are returned: + // 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. + // + // - 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. + // + // - VolumeiSCSIAttributes : An VolumeiSCSIAttributesobject 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 diff --git a/service/storagegateway/api_op_DescribeTapeArchives.go b/service/storagegateway/api_op_DescribeTapeArchives.go index 3ba1befae4d..e7afbf3df5b 100644 --- a/service/storagegateway/api_op_DescribeTapeArchives.go +++ b/service/storagegateway/api_op_DescribeTapeArchives.go @@ -12,9 +12,10 @@ import ( ) // Returns a description of specified virtual tapes in the virtual tape shelf -// (VTS). This operation is only supported in the tape gateway type. If a specific -// TapeARN is not specified, Storage Gateway returns a description of all virtual -// tapes found in the VTS associated with your account. +// (VTS). This operation is only supported in the tape gateway type. +// +// If a specific TapeARN is not specified, Storage Gateway returns a description +// of all virtual tapes found in the VTS associated with your account. func (c *Client) DescribeTapeArchives(ctx context.Context, params *DescribeTapeArchivesInput, optFns ...func(*Options)) (*DescribeTapeArchivesOutput, error) { if params == nil { params = &DescribeTapeArchivesInput{} diff --git a/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go b/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go index 0fe3077e422..85f5c8daceb 100644 --- a/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go +++ b/service/storagegateway/api_op_DescribeTapeRecoveryPoints.go @@ -12,10 +12,12 @@ import ( ) // Returns a list of virtual tape recovery points that are available for the -// specified tape gateway. A recovery point is a point-in-time view of a virtual -// tape at which all the data on the virtual tape is consistent. If your gateway -// crashes, virtual tapes that have recovery points can be recovered to a new -// gateway. This operation is only supported in the tape gateway type. +// specified tape gateway. +// +// A recovery point is a point-in-time view of a virtual tape at which all the +// data on the virtual tape is consistent. If your gateway crashes, virtual tapes +// that have recovery points can be recovered to a new gateway. This operation is +// only supported in the tape gateway type. func (c *Client) DescribeTapeRecoveryPoints(ctx context.Context, params *DescribeTapeRecoveryPointsInput, optFns ...func(*Options)) (*DescribeTapeRecoveryPointsOutput, error) { if params == nil { params = &DescribeTapeRecoveryPointsInput{} @@ -34,8 +36,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 @@ -54,15 +56,16 @@ 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 - // points that were listed for description ended. Use this marker in your next - // request to list the next set of virtual tape recovery points in the list. If - // there are no more recovery points to describe, this field does not appear in the - // response. + // points that were listed for description ended. + // + // Use this marker in your next request to list the next set of virtual tape + // recovery points in the list. If there are no more recovery points to describe, + // this field does not appear in the response. Marker *string // An array of TapeRecoveryPointInfos that are available for the specified gateway. diff --git a/service/storagegateway/api_op_DescribeTapes.go b/service/storagegateway/api_op_DescribeTapes.go index 00c76b3fd10..980173f80e5 100644 --- a/service/storagegateway/api_op_DescribeTapes.go +++ b/service/storagegateway/api_op_DescribeTapes.go @@ -14,12 +14,13 @@ import ( // Returns a description of virtual tapes that correspond to the specified Amazon // Resource Names (ARNs). If TapeARN is not specified, returns a description of // the virtual tapes associated with the specified gateway. This operation is only -// supported for the tape gateway type. The operation supports pagination. By -// default, the operation returns a maximum of up to 100 tapes. You can optionally -// specify the Limit field in the body to limit the number of tapes in the -// response. If the number of tapes returned in the response is truncated, the -// response includes a Marker field. You can use this Marker value in your -// subsequent request to retrieve the next set of tapes. +// supported for the tape gateway type. +// +// The operation supports pagination. By default, the operation returns a maximum +// of up to 100 tapes. You can optionally specify the Limit field in the body to +// limit the number of tapes in the response. If the number of tapes returned in +// the response is truncated, the response includes a Marker field. You can use +// this Marker value in your subsequent request to retrieve the next set of tapes. func (c *Client) DescribeTapes(ctx context.Context, params *DescribeTapesInput, optFns ...func(*Options)) (*DescribeTapesOutput, error) { if params == nil { params = &DescribeTapesInput{} @@ -38,20 +39,22 @@ 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. + // 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 - // indicates which page of results to retrieve. If not specified, the first page of - // results is retrieved. + // indicates which page of results to retrieve. + // + // If not specified, the first page of results is retrieved. Marker *string // Specifies one or more unique Amazon Resource Names (ARNs) that represent the @@ -67,8 +70,10 @@ type DescribeTapesInput struct { type DescribeTapesOutput struct { // An opaque string that can be used as part of a subsequent DescribeTapes call to - // retrieve the next page of results. If a response does not contain a marker, then - // there are no more results to be retrieved. + // retrieve the next page of results. + // + // If a response does not contain a marker, then there are no more results to be + // retrieved. Marker *string // An array of virtual tape descriptions. @@ -169,8 +174,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. + // 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 196fb02b17d..482ab6a148f 100644 --- a/service/storagegateway/api_op_DescribeUploadBuffer.go +++ b/service/storagegateway/api_op_DescribeUploadBuffer.go @@ -11,9 +11,10 @@ import ( ) // Returns information about the upload buffer of a gateway. This operation is -// supported for the stored volume, cached volume, and tape gateway types. The -// response includes disk IDs that are configured as upload buffer space, and it -// includes the amount of upload buffer space allocated and used. +// supported for the stored volume, cached volume, and tape gateway types. +// +// The response includes disk IDs that are configured as upload buffer space, and +// it includes the amount of upload buffer space allocated and used. func (c *Client) DescribeUploadBuffer(ctx context.Context, params *DescribeUploadBufferInput, optFns ...func(*Options)) (*DescribeUploadBufferOutput, error) { if params == nil { params = &DescribeUploadBufferInput{} @@ -31,8 +32,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 @@ -48,8 +49,8 @@ type DescribeUploadBufferOutput struct { // 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 ea7f13dc7d1..b02ba565c4e 100644 --- a/service/storagegateway/api_op_DescribeVTLDevices.go +++ b/service/storagegateway/api_op_DescribeVTLDevices.go @@ -13,6 +13,7 @@ import ( // Returns a description of virtual tape library (VTL) devices for the specified // tape gateway. In the response, Storage Gateway returns VTL device information. +// // This operation is only supported in the tape gateway type. func (c *Client) DescribeVTLDevices(ctx context.Context, params *DescribeVTLDevicesInput, optFns ...func(*Options)) (*DescribeVTLDevicesOutput, error) { if params == nil { @@ -32,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,9 +48,11 @@ type DescribeVTLDevicesInput struct { 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. + // (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 @@ -58,8 +61,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 diff --git a/service/storagegateway/api_op_DescribeWorkingStorage.go b/service/storagegateway/api_op_DescribeWorkingStorage.go index 4a4abe7de53..a0acc637f32 100644 --- a/service/storagegateway/api_op_DescribeWorkingStorage.go +++ b/service/storagegateway/api_op_DescribeWorkingStorage.go @@ -13,8 +13,10 @@ import ( // Returns information about the working storage of a gateway. This operation is // only supported in the stored volumes gateway type. This operation is deprecated // in cached volumes API version (20120630). Use DescribeUploadBuffer instead. +// // Working storage is also referred to as upload buffer. You can also use the // DescribeUploadBuffer operation to add upload buffer to a stored volume gateway. +// // The response includes disk IDs that are configured as working storage, and it // includes the amount of working storage allocated and used. func (c *Client) DescribeWorkingStorage(ctx context.Context, params *DescribeWorkingStorageInput, optFns ...func(*Options)) (*DescribeWorkingStorageOutput, error) { @@ -35,8 +37,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 @@ -53,8 +55,8 @@ type DescribeWorkingStorageOutput struct { // 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 435c756d423..c58ba67e876 100644 --- a/service/storagegateway/api_op_DetachVolume.go +++ b/service/storagegateway/api_op_DetachVolume.go @@ -41,8 +41,9 @@ type DetachVolumeInput struct { // 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 + // 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 d3bdcca0dad..b40690ef5ed 100644 --- a/service/storagegateway/api_op_DisableGateway.go +++ b/service/storagegateway/api_op_DisableGateway.go @@ -12,8 +12,11 @@ import ( // Disables a tape gateway when the gateway is no longer functioning. For example, // if your gateway VM is damaged, you can disable the gateway so you can recover -// virtual tapes. Use this operation for a tape gateway that is not reachable or -// not functioning. This operation is only supported in the tape gateway type. +// virtual tapes. +// +// Use this operation for a tape gateway that is not reachable or not functioning. +// This operation is only supported in the tape gateway type. +// // After a gateway is disabled, it cannot be enabled. func (c *Client) DisableGateway(ctx context.Context, params *DisableGatewayInput, optFns ...func(*Options)) (*DisableGatewayOutput, error) { if params == nil { @@ -33,8 +36,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 b4313b75149..7eb32c64827 100644 --- a/service/storagegateway/api_op_JoinDomain.go +++ b/service/storagegateway/api_op_JoinDomain.go @@ -12,14 +12,16 @@ import ( ) // Adds a file gateway to an Active Directory domain. This operation is only -// supported for file gateways that support the SMB file protocol. Joining a domain -// creates an Active Directory computer account in the default organizational unit, -// using the gateway's Gateway ID as the account name (for example, SGW-1234ADE). -// If your Active Directory environment requires that you pre-stage accounts to -// facilitate the join domain process, you will need to create this account ahead -// of time. To create the gateway's computer account in an organizational unit -// other than the default, you must specify the organizational unit when joining -// the domain. +// supported for file gateways that support the SMB file protocol. +// +// Joining a domain creates an Active Directory computer account in the default +// organizational unit, using the gateway's Gateway ID as the account name (for +// example, SGW-1234ADE). If your Active Directory environment requires that you +// pre-stage accounts to facilitate the join domain process, you will need to +// create this account ahead of time. +// +// To create the gateway's computer account in an organizational unit other than +// the default, you must specify the organizational unit when joining the domain. func (c *Client) JoinDomain(ctx context.Context, params *JoinDomainInput, optFns ...func(*Options)) (*JoinDomainOutput, error) { if params == nil { params = &JoinDomainInput{} @@ -84,15 +86,22 @@ type JoinDomainInput struct { 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. ActiveDirectoryStatus types.ActiveDirectoryStatus diff --git a/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go b/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go index 06d0465b627..11188727748 100644 --- a/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go +++ b/service/storagegateway/api_op_ListAutomaticTapeCreationPolicies.go @@ -12,8 +12,9 @@ import ( ) // Lists the automatic tape creation policies for a gateway. If there are no -// automatic tape creation policies for the gateway, it returns an empty list. This -// operation is only supported for tape gateways. +// automatic tape creation policies for the gateway, it returns an empty list. +// +// This operation is only supported for tape gateways. func (c *Client) ListAutomaticTapeCreationPolicies(ctx context.Context, params *ListAutomaticTapeCreationPoliciesInput, optFns ...func(*Options)) (*ListAutomaticTapeCreationPoliciesOutput, error) { if params == nil { params = &ListAutomaticTapeCreationPoliciesInput{} @@ -31,8 +32,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_ListFileSystemAssociations.go b/service/storagegateway/api_op_ListFileSystemAssociations.go index bb0405e8b18..850b47d8643 100644 --- a/service/storagegateway/api_op_ListFileSystemAssociations.go +++ b/service/storagegateway/api_op_ListFileSystemAssociations.go @@ -31,8 +31,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 diff --git a/service/storagegateway/api_op_ListGateways.go b/service/storagegateway/api_op_ListGateways.go index 11e1f75bc9a..c6df8fc240c 100644 --- a/service/storagegateway/api_op_ListGateways.go +++ b/service/storagegateway/api_op_ListGateways.go @@ -13,12 +13,16 @@ import ( // 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. +// 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{} @@ -35,8 +39,10 @@ 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 diff --git a/service/storagegateway/api_op_ListLocalDisks.go b/service/storagegateway/api_op_ListLocalDisks.go index 69712a028c6..d05c2b62a24 100644 --- a/service/storagegateway/api_op_ListLocalDisks.go +++ b/service/storagegateway/api_op_ListLocalDisks.go @@ -13,12 +13,14 @@ import ( // Returns a list of the gateway's local disks. To specify which gateway to // 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). +// 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). func (c *Client) ListLocalDisks(ctx context.Context, params *ListLocalDisksInput, optFns ...func(*Options)) (*ListLocalDisksOutput, error) { if params == nil { params = &ListLocalDisksInput{} @@ -37,8 +39,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,11 +51,12 @@ 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_ListTapePools.go b/service/storagegateway/api_op_ListTapePools.go index 692f53cb30e..370a80bcaaa 100644 --- a/service/storagegateway/api_op_ListTapePools.go +++ b/service/storagegateway/api_op_ListTapePools.go @@ -13,12 +13,13 @@ import ( // 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. +// 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{} diff --git a/service/storagegateway/api_op_ListTapes.go b/service/storagegateway/api_op_ListTapes.go index 3ae0a4be9b7..b452cd478e5 100644 --- a/service/storagegateway/api_op_ListTapes.go +++ b/service/storagegateway/api_op_ListTapes.go @@ -14,13 +14,14 @@ import ( // Lists virtual tapes in your virtual tape library (VTL) and your virtual tape // shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon // Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all -// virtual tapes in both your VTL and VTS. This operation supports pagination. By -// default, the operation returns a maximum of up to 100 tapes. You can optionally -// specify the Limit parameter in the body to limit the number of tapes in the -// response. If the number of tapes 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 tapes. This operation is only supported in the tape -// gateway type. +// virtual tapes in both your VTL and VTS. +// +// This operation supports pagination. By default, the operation returns a maximum +// of up to 100 tapes. You can optionally specify the Limit parameter in the body +// to limit the number of tapes in the response. If the number of tapes 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 tapes. This operation +// is only supported in the tape gateway type. func (c *Client) ListTapes(ctx context.Context, params *ListTapesInput, optFns ...func(*Options)) (*ListTapesOutput, error) { if params == nil { params = &ListTapesInput{} @@ -37,9 +38,12 @@ 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. @@ -57,8 +61,10 @@ 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 @@ -67,9 +73,8 @@ type ListTapesOutput struct { // body. Marker *string - // An array of TapeInfo objects, where each object describes a single tape. If - // there are no tapes in the tape library or VTS, then the TapeInfos is an empty - // array. + // An array of TapeInfo objects, where each object describes a single tape. If there are + // no tapes in the tape library or VTS, then the TapeInfos is an empty array. TapeInfos []types.TapeInfo // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_ListVolumeInitiators.go b/service/storagegateway/api_op_ListVolumeInitiators.go index 569424fb25c..db790e2ee4c 100644 --- a/service/storagegateway/api_op_ListVolumeInitiators.go +++ b/service/storagegateway/api_op_ListVolumeInitiators.go @@ -31,8 +31,8 @@ func (c *Client) ListVolumeInitiators(ctx context.Context, params *ListVolumeIni // ListVolumeInitiatorsInput type ListVolumeInitiatorsInput struct { - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to - // return a list of gateway volumes for the gateway. + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a + // list of gateway volumes for the gateway. // // This member is required. VolumeARN *string diff --git a/service/storagegateway/api_op_ListVolumeRecoveryPoints.go b/service/storagegateway/api_op_ListVolumeRecoveryPoints.go index 8db1236c209..8cde10e42b3 100644 --- a/service/storagegateway/api_op_ListVolumeRecoveryPoints.go +++ b/service/storagegateway/api_op_ListVolumeRecoveryPoints.go @@ -12,11 +12,12 @@ import ( ) // Lists the recovery points for a specified gateway. This operation is only -// supported in the cached volume gateway type. Each cache volume has one recovery -// point. 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 or clone a new -// cached volume from a source volume. To create a snapshot from a volume recovery -// point use the CreateSnapshotFromVolumeRecoveryPoint operation. +// supported in the cached volume gateway type. +// +// Each cache volume has one recovery point. 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 or clone a new cached volume from a source volume. To create a +// snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPointoperation. func (c *Client) ListVolumeRecoveryPoints(ctx context.Context, params *ListVolumeRecoveryPointsInput, optFns ...func(*Options)) (*ListVolumeRecoveryPointsOutput, error) { if params == nil { params = &ListVolumeRecoveryPointsInput{} @@ -34,8 +35,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 +46,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 1672ccf6c9f..3d556b0ba02 100644 --- a/service/storagegateway/api_op_ListVolumes.go +++ b/service/storagegateway/api_op_ListVolumes.go @@ -13,14 +13,15 @@ import ( // Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. // The response includes only the volume ARNs. If you want additional volume -// information, use the DescribeStorediSCSIVolumes or the -// DescribeCachediSCSIVolumes API. The operation supports pagination. By default, -// the operation returns a maximum of up to 100 volumes. You can optionally specify -// the Limit field in the body to limit the number of volumes in the response. If -// the number of volumes returned in the response is truncated, the response -// includes a Marker field. You can use this Marker value in your subsequent -// request to retrieve the next set of volumes. This operation is only supported in -// the cached volume and stored volume gateway types. +// information, use the DescribeStorediSCSIVolumesor the DescribeCachediSCSIVolumes API. +// +// The operation supports pagination. By default, the operation returns a maximum +// of up to 100 volumes. You can optionally specify the Limit field in the body to +// limit the number of volumes in the response. If the number of volumes returned +// in the response is truncated, the response includes a Marker field. You can use +// this Marker value in your subsequent request to retrieve the next set of +// volumes. This operation is only supported in the cached volume and stored volume +// gateway types. func (c *Client) ListVolumes(ctx context.Context, params *ListVolumesInput, optFns ...func(*Options)) (*ListVolumesOutput, error) { if params == nil { params = &ListVolumesInput{} @@ -37,12 +38,14 @@ 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 @@ -58,12 +61,14 @@ 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 @@ -71,8 +76,8 @@ type ListVolumesOutput struct { // body. Marker *string - // An array of VolumeInfo objects, where each object describes an iSCSI volume. If - // no volumes are defined for the gateway, then VolumeInfos is an empty array "[]". + // An array of VolumeInfo objects, where each object describes an iSCSI volume. If no + // volumes are defined for the gateway, then VolumeInfos is an empty array "[]". VolumeInfos []types.VolumeInfo // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_NotifyWhenUploaded.go b/service/storagegateway/api_op_NotifyWhenUploaded.go index bb8e83d0aea..7d6e5758050 100644 --- a/service/storagegateway/api_op_NotifyWhenUploaded.go +++ b/service/storagegateway/api_op_NotifyWhenUploaded.go @@ -11,16 +11,20 @@ import ( ) // Sends you notification through CloudWatch Events when all files written to your -// file share have been uploaded to Amazon S3. Storage Gateway can send a -// notification through Amazon CloudWatch Events when all files written to your -// file share up to that point in time have been uploaded to Amazon S3. These files -// include files written to the file share up to the time that you make a request -// for notification. When the upload is done, Storage Gateway sends you -// 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/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) -// in the Amazon S3 File Gateway User Guide. +// file share have been uploaded to Amazon S3. +// +// Storage Gateway can send a notification through Amazon CloudWatch Events when +// all files written to your file share up to that point in time have been uploaded +// to Amazon S3. These files include files written to the file share up to the time +// that you make a request for notification. When the upload is done, Storage +// Gateway sends you 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] in the Amazon S3 File Gateway User Guide. +// +// [Getting file upload notification]: https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification func (c *Client) NotifyWhenUploaded(ctx context.Context, params *NotifyWhenUploadedInput, optFns ...func(*Options)) (*NotifyWhenUploadedOutput, error) { if params == nil { params = &NotifyWhenUploadedInput{} diff --git a/service/storagegateway/api_op_RefreshCache.go b/service/storagegateway/api_op_RefreshCache.go index 96cc541908c..689aa70f5df 100644 --- a/service/storagegateway/api_op_RefreshCache.go +++ b/service/storagegateway/api_op_RefreshCache.go @@ -16,30 +16,36 @@ import ( // results. This operation does not import files into the S3 File Gateway cache // storage. It only updates the cached inventory to reflect changes in the // 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/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) -// in the Amazon S3 File 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 that the file refresh has completed. You should use the -// refresh-complete notification to determine that the operation has completed -// before you check for new files on the gateway file share. You can subscribe to -// be notified through a CloudWatch event when your RefreshCache operation -// completes. Throttle limit: This API is asynchronous, so the gateway will accept -// no more than two refreshes at any time. We recommend using the refresh-complete +// 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] in the Amazon S3 +// File 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 that the +// file refresh has completed. You should use the refresh-complete notification to +// determine that the operation has completed before you check for new files on the +// gateway file share. You can subscribe to be notified through a CloudWatch event +// when your RefreshCache operation completes. +// +// Throttle limit: 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/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) -// in the Amazon S3 File Gateway User Guide. +// information, see [Getting notified about file operations]in the Amazon S3 File Gateway User Guide. +// // - Wait at least 60 seconds between consecutive RefreshCache API requests. +// // - 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/filegateway/latest/files3/monitoring-file-gateway.html#get-notification) -// in the Amazon S3 File Gateway User Guide. +// folders in the FolderList parameter. +// +// For more information, see [Getting notified about file operations] in the Amazon S3 File Gateway User Guide. +// +// [Getting notified about file operations]: https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification func (c *Client) RefreshCache(ctx context.Context, params *RefreshCacheInput, optFns ...func(*Options)) (*RefreshCacheOutput, error) { if params == nil { params = &RefreshCacheInput{} @@ -74,8 +80,9 @@ type RefreshCacheInput struct { // 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 96629d11f0e..e9da73564ff 100644 --- a/service/storagegateway/api_op_ResetCache.go +++ b/service/storagegateway/api_op_ResetCache.go @@ -16,11 +16,12 @@ import ( // gateway. For example, an error can occur when a disk is corrupted or removed // from the gateway. When a cache is reset, the gateway loses its cache storage. At // this point, you can reconfigure the disks as cache disks. This operation is only -// supported in the cached volume and tape types. If the cache disk you are -// resetting contains data that has not been uploaded to Amazon S3 yet, that data -// can be lost. After you reset cache disks, there will be no configured cache -// disks left in the gateway, so you must configure at least one new cache disk for -// your gateway to function properly. +// supported in the cached volume and tape types. +// +// If the cache disk you are resetting contains data that has not been uploaded to +// Amazon S3 yet, that data can be lost. After you reset cache disks, there will be +// no configured cache disks left in the gateway, so you must configure at least +// one new cache disk for your gateway to function properly. func (c *Client) ResetCache(ctx context.Context, params *ResetCacheInput, optFns ...func(*Options)) (*ResetCacheOutput, error) { if params == nil { params = &ResetCacheInput{} @@ -38,8 +39,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 +50,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 9cc6a45a834..67bd838c211 100644 --- a/service/storagegateway/api_op_RetrieveTapeArchive.go +++ b/service/storagegateway/api_op_RetrieveTapeArchive.go @@ -14,10 +14,12 @@ import ( // gateway. Virtual tapes archived in the VTS are not associated with any gateway. // However after a tape is retrieved, it is associated with a gateway, even though // it is also listed in the VTS, that is, archive. This operation is only supported -// in the tape gateway type. Once a tape is successfully retrieved to a gateway, it -// cannot be retrieved again to another gateway. You must archive the tape again -// before you can retrieve it to another gateway. This operation is only supported // in the tape gateway type. +// +// Once a tape is successfully retrieved to a gateway, it cannot be retrieved +// again to another gateway. You must archive the tape again before you can +// retrieve it to another gateway. This operation is only supported in the tape +// gateway type. func (c *Client) RetrieveTapeArchive(ctx context.Context, params *RetrieveTapeArchiveInput, optFns ...func(*Options)) (*RetrieveTapeArchiveOutput, error) { if params == nil { params = &RetrieveTapeArchiveInput{} @@ -37,9 +39,11 @@ func (c *Client) RetrieveTapeArchive(ctx context.Context, params *RetrieveTapeAr type RetrieveTapeArchiveInput struct { // The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual - // tape to. Use the ListGateways operation to return a list of gateways for your - // account and Amazon Web Services Region. You retrieve archived virtual tapes to - // only one gateway and the gateway must be a tape gateway. + // tape to. Use the ListGatewaysoperation to return a list of gateways for your account and + // Amazon Web Services Region. + // + // You retrieve archived virtual tapes to only one gateway and the gateway must be + // a tape gateway. // // This member is required. GatewayARN *string diff --git a/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go b/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go index 4dcb820c743..cca283971dc 100644 --- a/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go +++ b/service/storagegateway/api_op_RetrieveTapeRecoveryPoint.go @@ -11,12 +11,15 @@ import ( ) // Retrieves the recovery point for the specified virtual tape. This operation is -// only supported in the tape gateway type. A recovery point is a point in time -// view of a virtual tape at which all the data on the tape is consistent. If your -// gateway crashes, virtual tapes that have recovery points can be recovered to a -// new gateway. The virtual tape can be retrieved to only one gateway. The -// retrieved tape is read-only. The virtual tape can be retrieved to only a tape -// gateway. There is no charge for retrieving recovery points. +// only supported in the tape gateway type. +// +// A recovery point is a point in time view of a virtual tape at which all the +// data on the tape is consistent. If your gateway crashes, virtual tapes that have +// recovery points can be recovered to a new gateway. +// +// The virtual tape can be retrieved to only one gateway. The retrieved tape is +// read-only. The virtual tape can be retrieved to only a tape gateway. There is no +// charge for retrieving recovery points. func (c *Client) RetrieveTapeRecoveryPoint(ctx context.Context, params *RetrieveTapeRecoveryPointInput, optFns ...func(*Options)) (*RetrieveTapeRecoveryPointOutput, error) { if params == nil { params = &RetrieveTapeRecoveryPointInput{} @@ -35,8 +38,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 9a35994ceea..a56d5ba136f 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 3567f742f46..52121860c66 100644 --- a/service/storagegateway/api_op_SetSMBGuestPassword.go +++ b/service/storagegateway/api_op_SetSMBGuestPassword.go @@ -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 11071551b9e..5b2491c9158 100644 --- a/service/storagegateway/api_op_ShutdownGateway.go +++ b/service/storagegateway/api_op_ShutdownGateway.go @@ -12,20 +12,26 @@ import ( // Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut // down, use the Amazon Resource Name (ARN) of the gateway in the body of your -// request. This API action cannot be used to shut down S3 File Gateway or FSx File -// Gateway. The operation shuts down the gateway service component running in the -// gateway's virtual 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. +// request. +// +// This API action cannot be used to shut down S3 File Gateway or FSx File Gateway. +// +// The operation shuts down the gateway service component running in the gateway's +// virtual 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 DescribeGatewayInformationAPI 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{} @@ -45,8 +51,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 @@ -58,8 +64,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 64cca90f17a..28509380d3b 100644 --- a/service/storagegateway/api_op_StartAvailabilityMonitorTest.go +++ b/service/storagegateway/api_op_StartAvailabilityMonitorTest.go @@ -14,8 +14,9 @@ import ( // Availability monitoring in your host environment. This request only initiates // the test and that a successful response only indicates that the test was // started. It doesn't indicate that the test passed. For the status of the test, -// invoke the DescribeAvailabilityMonitorTest API. Starting this test will cause -// your gateway to go offline for a brief period. +// invoke the DescribeAvailabilityMonitorTest API. +// +// Starting this test will cause your gateway to go offline for a brief period. func (c *Client) StartAvailabilityMonitorTest(ctx context.Context, params *StartAvailabilityMonitorTestInput, optFns ...func(*Options)) (*StartAvailabilityMonitorTestOutput, error) { if params == nil { params = &StartAvailabilityMonitorTestInput{} @@ -33,8 +34,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 +45,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 13d4f9af9da..fbf3b4ce79e 100644 --- a/service/storagegateway/api_op_StartGateway.go +++ b/service/storagegateway/api_op_StartGateway.go @@ -10,14 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// specify which gateway to start, use the Amazon Resource Name (ARN) of 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 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) { if params == nil { @@ -37,8 +40,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 +53,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 f16e48ef968..93bb92013d8 100644 --- a/service/storagegateway/api_op_UpdateAutomaticTapeCreationPolicy.go +++ b/service/storagegateway/api_op_UpdateAutomaticTapeCreationPolicy.go @@ -13,8 +13,11 @@ import ( // Updates the automatic tape creation policy of a gateway. Use this to update the // policy with a new set of automatic tape creation rules. This is only supported -// for tape gateways. By default, there is no automatic tape creation policy. A -// gateway can have only one automatic tape creation policy. +// for tape gateways. +// +// By default, there is no automatic tape creation policy. +// +// A gateway can have only one automatic tape creation policy. func (c *Client) UpdateAutomaticTapeCreationPolicy(ctx context.Context, params *UpdateAutomaticTapeCreationPolicyInput, optFns ...func(*Options)) (*UpdateAutomaticTapeCreationPolicyOutput, error) { if params == nil { params = &UpdateAutomaticTapeCreationPolicyInput{} @@ -38,8 +41,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 +52,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 689dd324004..2f60c991d3d 100644 --- a/service/storagegateway/api_op_UpdateBandwidthRateLimit.go +++ b/service/storagegateway/api_op_UpdateBandwidthRateLimit.go @@ -14,12 +14,14 @@ import ( // and download bandwidth rate limit or specify only one of the two. If you don't // 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 -// 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 -// Name (ARN) of the gateway in your request. +// update bandwidth rate limits for S3 file gateways, use 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 Name (ARN) of the +// gateway in your request. func (c *Client) UpdateBandwidthRateLimit(ctx context.Context, params *UpdateBandwidthRateLimitInput, optFns ...func(*Options)) (*UpdateBandwidthRateLimitOutput, error) { if params == nil { params = &UpdateBandwidthRateLimitInput{} @@ -36,12 +38,14 @@ 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 @@ -59,8 +63,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 d39c3daeeb7..b7afea33527 100644 --- a/service/storagegateway/api_op_UpdateBandwidthRateLimitSchedule.go +++ b/service/storagegateway/api_op_UpdateBandwidthRateLimitSchedule.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the bandwidth rate limit schedule for a specified gateway. By default, +// Updates 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 initiate or update a gateway's bandwidth // rate limit schedule. This operation is supported for volume, tape, and S3 file @@ -34,14 +35,14 @@ func (c *Client) UpdateBandwidthRateLimitSchedule(ctx context.Context, params *U type UpdateBandwidthRateLimitScheduleInput struct { - // An array containing bandwidth rate limit schedule intervals for a gateway. When - // no bandwidth rate limit intervals have been scheduled, the array is empty. + // An array containing bandwidth rate limit schedule intervals for a gateway. + // When no bandwidth rate limit intervals have been scheduled, the array is empty. // // 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 @@ -51,8 +52,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 3a0580768ec..431c7a1a8c2 100644 --- a/service/storagegateway/api_op_UpdateChapCredentials.go +++ b/service/storagegateway/api_op_UpdateChapCredentials.go @@ -13,9 +13,10 @@ import ( // 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 -// the new credentials. +// the volume and tape gateway types. +// +// When you update CHAP credentials, all existing connections on the target are +// closed and initiators must reconnect with the new credentials. func (c *Client) UpdateChapCredentials(ctx context.Context, params *UpdateChapCredentialsInput, optFns ...func(*Options)) (*UpdateChapCredentialsOutput, error) { if params == nil { params = &UpdateChapCredentialsInput{} @@ -32,10 +33,14 @@ 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. @@ -44,23 +49,25 @@ type UpdateChapCredentialsInput struct { 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. + // 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 - // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the - // DescribeStorediSCSIVolumes operation to return the TargetARN for specified - // VolumeARN. + // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation + // to return the TargetARN for specified VolumeARN. // // This member is required. TargetARN *string // The secret key that the target must provide to participate in mutual CHAP with - // the initiator (e.g. Windows client). Byte constraints: Minimum bytes of 12. - // Maximum bytes of 16. The secret key must be between 12 and 16 bytes when encoded - // in UTF-8. + // the initiator (e.g. Windows client). + // + // Byte constraints: Minimum bytes of 12. Maximum bytes of 16. + // + // The secret key must be between 12 and 16 bytes when encoded in UTF-8. SecretToAuthenticateTarget *string noSmithyDocumentSerde diff --git a/service/storagegateway/api_op_UpdateGatewayInformation.go b/service/storagegateway/api_op_UpdateGatewayInformation.go index 4084e742951..43b641c8ab2 100644 --- a/service/storagegateway/api_op_UpdateGatewayInformation.go +++ b/service/storagegateway/api_op_UpdateGatewayInformation.go @@ -13,9 +13,11 @@ import ( // Updates a gateway's metadata, which includes the gateway's name and time zone. // To specify which gateway to update, use the Amazon Resource Name (ARN) of the -// gateway in your request. For gateways activated after September 2, 2015, the -// gateway's ARN contains the gateway ID rather than the gateway name. However, -// changing the name of the gateway has no effect on the gateway's ARN. +// gateway in your request. +// +// For gateways activated after September 2, 2015, the gateway's ARN contains the +// gateway ID rather than the gateway name. However, changing the name of the +// gateway has no effect on the gateway's ARN. func (c *Client) UpdateGatewayInformation(ctx context.Context, params *UpdateGatewayInformationInput, optFns ...func(*Options)) (*UpdateGatewayInformationOutput, error) { if params == nil { params = &UpdateGatewayInformationInput{} @@ -33,15 +35,18 @@ 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) + // to use to monitor and log events in the gateway. + // + // For more information, see [What is Amazon CloudWatch Logs?] + // + // [What 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. @@ -60,8 +65,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 9b95fc56c7b..083bfca9a81 100644 --- a/service/storagegateway/api_op_UpdateGatewaySoftwareNow.go +++ b/service/storagegateway/api_op_UpdateGatewaySoftwareNow.go @@ -11,16 +11,19 @@ import ( ) // Updates the gateway virtual machine (VM) software. The request immediately -// triggers the software update. When you make this request, you get a 200 OK -// success response immediately. However, it might take some time for the update to -// complete. You can call DescribeGatewayInformation to verify the gateway is in -// the STATE_RUNNING state. A software update forces a system restart of your -// 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. +// triggers the software update. +// +// When you make this request, you get a 200 OK success response immediately. +// However, it might take some time for the update to complete. You can call DescribeGatewayInformationto +// verify the gateway is in the STATE_RUNNING state. +// +// A software update forces a system restart of your 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]and [Customizing your Linux iSCSI settings], respectively. +// +// [Customizing your Linux iSCSI settings]: https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorRedHatClient.html#CustomizeLinuxiSCSISettings +// [Customizing your Windows iSCSI settings]: https://docs.aws.amazon.com/storagegateway/latest/userguide/ConfiguringiSCSIClientInitiatorWindowsClient.html#CustomizeWindowsiSCSISettings func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGatewaySoftwareNowInput, optFns ...func(*Options)) (*UpdateGatewaySoftwareNowOutput, error) { if params == nil { params = &UpdateGatewaySoftwareNowInput{} @@ -40,8 +43,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 @@ -53,8 +56,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 e9e0c36d4ce..6b4bb6f399f 100644 --- a/service/storagegateway/api_op_UpdateMaintenanceStartTime.go +++ b/service/storagegateway/api_op_UpdateMaintenanceStartTime.go @@ -29,14 +29,18 @@ 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 @@ -70,8 +74,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 4dfeb9cd0f0..f060d24320a 100644 --- a/service/storagegateway/api_op_UpdateNFSFileShare.go +++ b/service/storagegateway/api_op_UpdateNFSFileShare.go @@ -12,12 +12,21 @@ import ( ) // 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: +// 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 func (c *Client) UpdateNFSFileShare(ctx context.Context, params *UpdateNFSFileShareInput, optFns ...func(*Options)) (*UpdateNFSFileShareOutput, error) { if params == nil { @@ -53,21 +62,29 @@ 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: - // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA + // 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. + // 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. 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 + // 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 @@ -83,11 +100,19 @@ type UpdateNFSFileShareInput struct { // before generating an ObjectUploaded notification. Because clients can make many // small writes to files, it's best to set this parameter for as long as possible // to avoid generating multiple notifications for the same file in a small time - // period. SettlingTimeInSeconds has no effect on the timing of the object - // uploading to Amazon S3, only the timing of the notification. The following - // example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. - // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets - // NotificationPolicy off. {} + // period. + // + // SettlingTimeInSeconds has no effect on the timing of the object uploading to + // Amazon S3, only the timing of the notification. + // + // The following example sets NotificationPolicy on with SettlingTimeInSeconds set + // to 60. + // + // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} + // + // The following example sets NotificationPolicy off. + // + // {} NotificationPolicy *string // A value that sets the access control list (ACL) permission for objects in the @@ -96,22 +121,31 @@ type UpdateNFSFileShareInput struct { 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 // 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: + // 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. Squash *string diff --git a/service/storagegateway/api_op_UpdateSMBFileShare.go b/service/storagegateway/api_op_UpdateSMBFileShare.go index ae16f8e168f..324d84306a4 100644 --- a/service/storagegateway/api_op_UpdateSMBFileShare.go +++ b/service/storagegateway/api_op_UpdateSMBFileShare.go @@ -12,16 +12,21 @@ import ( ) // Updates a Server Message Block (SMB) file share. This operation is only -// supported for S3 File Gateways. To leave a file share field unchanged, set the -// corresponding input field to null. File gateways require Security Token Service -// (Amazon Web Services STS) to be activated to enable you to create a file share. -// Make sure that Amazon Web Services STS is activated in the Amazon Web Services -// 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) -// in the Identity and Access Management User Guide. File gateways don't support -// creating hard or symbolic links on a file share. +// supported for S3 File Gateways. +// +// To leave a file share field unchanged, set the corresponding input field to +// null. +// +// File gateways require Security Token Service (Amazon Web Services STS) to be +// activated to enable you to create a file share. Make sure that Amazon Web +// Services STS is activated in the Amazon Web Services 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]in the Identity and Access Management User Guide. +// +// File gateways don't support creating hard or symbolic links on a file share. +// +// [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 func (c *Client) UpdateSMBFileShare(ctx context.Context, params *UpdateSMBFileShareInput, optFns ...func(*Options)) (*UpdateSMBFileShareOutput, error) { if params == nil { params = &UpdateSMBFileShareInput{} @@ -67,17 +72,23 @@ type UpdateSMBFileShareInput struct { 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: - // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA + // 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. + // 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. 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 @@ -87,7 +98,9 @@ type UpdateSMBFileShareInput struct { 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 + // 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 @@ -100,11 +113,19 @@ type UpdateSMBFileShareInput struct { // before generating an ObjectUploaded notification. Because clients can make many // small writes to files, it's best to set this parameter for as long as possible // to avoid generating multiple notifications for the same file in a small time - // period. SettlingTimeInSeconds has no effect on the timing of the object - // uploading to Amazon S3, only the timing of the notification. The following - // example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. - // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets - // NotificationPolicy off. {} + // period. + // + // SettlingTimeInSeconds has no effect on the timing of the object uploading to + // Amazon S3, only the timing of the notification. + // + // The following example sets NotificationPolicy on with SettlingTimeInSeconds set + // to 60. + // + // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} + // + // The following example sets NotificationPolicy off. + // + // {} NotificationPolicy *string // A value that sets the access control list (ACL) permission for objects in the @@ -113,30 +134,40 @@ type UpdateSMBFileShareInput struct { ObjectACL types.ObjectACL // Specifies whether opportunistic locking is enabled for the SMB file share. + // // Enabling opportunistic locking on case-sensitive shares is not recommended for // workloads that involve access to files with the same name in different case. + // // Valid Values: true | false 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 | - // false + // 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 // 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 + // permissions. + // + // For more information, see [Using Microsoft Windows ACLs to control access to an SMB file share] in the Storage Gateway User Guide. + // + // Valid Values: true | false + // + // [Using Microsoft Windows ACLs to control access to an SMB file share]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html SMBACLEnabled *bool // A list of users or groups in the Active Directory that are allowed to access diff --git a/service/storagegateway/api_op_UpdateSMBFileShareVisibility.go b/service/storagegateway/api_op_UpdateSMBFileShareVisibility.go index e86274b3436..5e4eea9e108 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 5723a790ad3..cfa2ae417d7 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 7a3fb5536ab..0e24262a876 100644 --- a/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go +++ b/service/storagegateway/api_op_UpdateSMBSecurityStrategy.go @@ -12,7 +12,10 @@ import ( ) // Updates the SMB security strategy on a file gateway. This action is only -// supported in file gateways. This API is called Security level in the User Guide. +// supported in file gateways. +// +// This API is called Security level in the User Guide. +// // A higher security level can affect performance of the gateway. func (c *Client) UpdateSMBSecurityStrategy(ctx context.Context, params *UpdateSMBSecurityStrategyInput, optFns ...func(*Options)) (*UpdateSMBSecurityStrategyOutput, error) { if params == nil { @@ -31,19 +34,23 @@ 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 - // Specifies the type of security strategy. 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. Supported only in S3 File Gateway. + // Specifies the type of security strategy. + // + // 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. Supported + // only in S3 File Gateway. + // // 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 @@ -57,8 +64,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 2e5e5ce7475..f9d8b8b4120 100644 --- a/service/storagegateway/api_op_UpdateSnapshotSchedule.go +++ b/service/storagegateway/api_op_UpdateSnapshotSchedule.go @@ -12,13 +12,15 @@ import ( ) // Updates a snapshot schedule configured for a gateway volume. This operation is -// only supported in the cached volume and stored volume gateway types. The default -// snapshot schedule for volume is once every 24 hours, starting at the creation -// time of the volume. You can use this API to change the snapshot schedule -// configured for the volume. In the request you must identify the gateway volume -// whose snapshot schedule you want to update, and the schedule information, -// including when you want the snapshot to begin on a day and the frequency (in -// hours) of snapshots. +// only supported in the cached volume and stored volume gateway types. +// +// The default snapshot schedule for volume is once every 24 hours, starting at +// the creation time of the volume. You can use this API to change the snapshot +// schedule configured for the volume. +// +// In the request you must identify the gateway volume whose snapshot schedule you +// want to update, and the schedule information, including when you want the +// snapshot to begin on a day and the frequency (in hours) of snapshots. func (c *Client) UpdateSnapshotSchedule(ctx context.Context, params *UpdateSnapshotScheduleInput, optFns ...func(*Options)) (*UpdateSnapshotScheduleOutput, error) { if params == nil { params = &UpdateSnapshotScheduleInput{} @@ -35,10 +37,14 @@ 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. @@ -53,8 +59,8 @@ type UpdateSnapshotScheduleInput struct { // This member is required. StartAt *int32 - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to - // return a list of gateway volumes. + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a + // list of gateway volumes. // // This member is required. VolumeARN *string @@ -63,10 +69,12 @@ type UpdateSnapshotScheduleInput struct { Description *string // A list of up to 50 tags that can be assigned to a snapshot. Each tag is a - // key-value pair. Valid characters for key and value are letters, spaces, and - // numbers representable in UTF-8 format, and the following special characters: + - - // = . _ : / @. The maximum length of a tag's key is 128 characters, and the - // maximum length for a tag's value is 256. + // key-value pair. + // + // Valid characters for key and value are letters, spaces, and numbers + // representable in UTF-8 format, and the following special characters: + - = . _ : + // / @. The maximum length of a tag's key is 128 characters, and the maximum length + // for a tag's value is 256. Tags []types.Tag noSmithyDocumentSerde @@ -76,8 +84,8 @@ type UpdateSnapshotScheduleInput struct { // volume. type UpdateSnapshotScheduleOutput struct { - // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to - // return a list of gateway volumes. + // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a + // list of gateway volumes. VolumeARN *string // Metadata pertaining to the operation's result. diff --git a/service/storagegateway/api_op_UpdateVTLDeviceType.go b/service/storagegateway/api_op_UpdateVTLDeviceType.go index c13fa36a517..cc269e752e0 100644 --- a/service/storagegateway/api_op_UpdateVTLDeviceType.go +++ b/service/storagegateway/api_op_UpdateVTLDeviceType.go @@ -31,8 +31,9 @@ func (c *Client) UpdateVTLDeviceType(ctx context.Context, params *UpdateVTLDevic type UpdateVTLDeviceTypeInput struct { - // The type of medium changer you want to select. Valid Values: STK-L700 | - // AWS-Gateway-VTL | IBM-03584L32-0402 + // The type of medium changer you want to select. + // + // Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402 // // This member is required. DeviceType *string diff --git a/service/storagegateway/doc.go b/service/storagegateway/doc.go index bd1a7484769..a79abef3116 100644 --- a/service/storagegateway/doc.go +++ b/service/storagegateway/doc.go @@ -3,45 +3,66 @@ // Package storagegateway provides the API client, operations, and parameter types // for AWS Storage Gateway. // -// Storage Gateway Service Storage Gateway is the service that connects an -// on-premises software appliance with cloud-based storage to provide seamless and -// secure integration between an organization's on-premises IT environment and the -// Amazon Web Services storage infrastructure. The service enables you to securely -// 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 +// # Storage Gateway Service +// +// Storage Gateway is the service that connects an on-premises software appliance +// with cloud-based storage to provide seamless and secure integration between an +// organization's on-premises IT environment and the Amazon Web Services storage +// infrastructure. The service enables you to securely 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] +// - : Describes the required headers that you must send with every POST request +// to Storage Gateway. +// +// [Signing requests] +// - : Storage Gateway requires that you authenticate every request you send; +// this topic describes how sign such a request. +// +// [Error responses] +// - : Provides reference information about Storage Gateway errors. +// +// [Operations in Storage Gateway] +// - : 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 endpoints and quotas] +// - : 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 +// 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]. +// +// 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) // . +// +// 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]. +// +// [Storage Gateway required request headers]: https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders +// [Storage Gateway endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/sg.html +// [Signing requests]: https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests +// [Error responses]: https://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses +// [Operations in Storage Gateway]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html +// [Announcement: Heads-up – Longer Storage Gateway volume and snapshot IDs coming in 2016]: http://forums.aws.amazon.com/ann.jspa?annID=3557 +// [Longer EC2 and EBS resource IDs]: http://aws.amazon.com/ec2/faqs/#longer-ids package storagegateway diff --git a/service/storagegateway/options.go b/service/storagegateway/options.go index 56242643334..369281d885a 100644 --- a/service/storagegateway/options.go +++ b/service/storagegateway/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/storagegateway/types/enums.go b/service/storagegateway/types/enums.go index a5c91efce72..f1271c43514 100644 --- a/service/storagegateway/types/enums.go +++ b/service/storagegateway/types/enums.go @@ -16,8 +16,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACCESS_DENIED", @@ -41,8 +42,9 @@ const ( // Values returns all known values for AvailabilityMonitorTestStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AvailabilityMonitorTestStatus) Values() []AvailabilityMonitorTestStatus { return []AvailabilityMonitorTestStatus{ "COMPLETE", @@ -60,8 +62,9 @@ const ( ) // Values returns all known values for CaseSensitivity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CaseSensitivity) Values() []CaseSensitivity { return []CaseSensitivity{ "ClientSpecified", @@ -138,8 +141,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -216,8 +220,9 @@ const ( ) // Values returns all known values for FileShareType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FileShareType) Values() []FileShareType { return []FileShareType{ "NFS", @@ -235,8 +240,9 @@ const ( ) // Values returns all known values for GatewayCapacity. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GatewayCapacity) Values() []GatewayCapacity { return []GatewayCapacity{ "Small", @@ -258,8 +264,9 @@ const ( ) // Values returns all known values for HostEnvironment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HostEnvironment) Values() []HostEnvironment { return []HostEnvironment{ "VMWARE", @@ -285,8 +292,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -308,8 +316,9 @@ const ( ) // Values returns all known values for PoolStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PoolStatus) Values() []PoolStatus { return []PoolStatus{ "ACTIVE", @@ -327,8 +336,9 @@ const ( ) // Values returns all known values for RetentionLockType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetentionLockType) Values() []RetentionLockType { return []RetentionLockType{ "COMPLIANCE", @@ -347,8 +357,9 @@ const ( ) // Values returns all known values for SMBSecurityStrategy. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SMBSecurityStrategy) Values() []SMBSecurityStrategy { return []SMBSecurityStrategy{ "ClientSpecified", @@ -366,8 +377,9 @@ const ( ) // Values returns all known values for TapeStorageClass. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TapeStorageClass) Values() []TapeStorageClass { return []TapeStorageClass{ "DEEP_ARCHIVE", diff --git a/service/storagegateway/types/types.go b/service/storagegateway/types/types.go index 4152a7f7353..fa30e71d98e 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,17 @@ 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]. +// +// [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) - // . + // For more information about automatic tape creation, see [Creating Tapes Automatically]. + // + // [Creating Tapes Automatically]: https://docs.aws.amazon.com/storagegateway/latest/userguide/GettingStartedCreateTapes.html#CreateTapesAutomatically // // This member is required. MinimumNumTapes *int32 @@ -49,8 +50,10 @@ type AutomaticTapeCreationRule struct { PoolId *string // A prefix that you append to the barcode of the virtual tape that you are - // creating. This prefix makes the barcode unique. The prefix must be 1-4 - // characters in length and must be one of the uppercase letters from A to Z. + // creating. This prefix makes the barcode unique. + // + // The prefix must be 1-4 characters in length and must be one of the uppercase + // letters from A to Z. // // This member is required. TapeBarcodePrefix *string @@ -67,54 +70,58 @@ type AutomaticTapeCreationRule struct { noSmithyDocumentSerde } -// Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit -// schedule consists of one or more bandwidth rate limit intervals. A bandwidth -// rate limit interval defines a period of time on one or more days of the week, -// during which bandwidth rate limits are specified for uploading, downloading, or -// both. +// Describes a bandwidth rate limit interval for a gateway. A bandwidth rate +// +// limit schedule consists of one or more bandwidth rate limit intervals. A +// bandwidth rate limit interval defines a period of time on one or more days of +// the week, during which bandwidth rate limits are specified for uploading, +// downloading, or both. type BandwidthRateLimitInterval struct { - // The days of the week component of the bandwidth rate limit interval, + // 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 - // The hour of the day to end the bandwidth rate limit interval. + // The hour of the day to end the bandwidth rate limit interval. // // This member is required. EndHourOfDay *int32 - // 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 . + // 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 . // // This member is required. EndMinuteOfHour *int32 - // The hour of the day to start the bandwidth rate limit interval. + // The hour of the day to start the bandwidth rate limit interval. // // This member is required. StartHourOfDay *int32 - // 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 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 . // // This member is required. StartMinuteOfHour *int32 - // The average download rate limit component of the bandwidth rate limit interval, - // in bits per second. This field does not appear in the response if the download - // rate limit is not set. + // The average download rate limit component of the bandwidth rate limit + // interval, in bits per second. This field does not appear in the response if the + // download rate limit is not set. AverageDownloadRateLimitInBitsPerSec *int64 - // The average upload rate limit component of the bandwidth rate limit interval, + // 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 Tape Gateway and Volume Gateway, the minimum value is - // 51200 . For S3 File Gateway and FSx File Gateway, the minimum value is 104857600 - // . + // rate limit is not set. + // + // For Tape Gateway and Volume Gateway, the minimum value is 51200 . + // + // For S3 File Gateway and FSx File Gateway, the minimum value is 104857600 . AverageUploadRateLimitInBitsPerSec *int64 noSmithyDocumentSerde @@ -126,8 +133,9 @@ 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 - // 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) + // 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 noSmithyDocumentSerde @@ -153,17 +161,19 @@ type CachediSCSIVolume struct { // 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 - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name. + // . 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 // The Amazon Resource Name (ARN) of the storage volume. 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]. + // + // [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. @@ -188,16 +198,20 @@ type CachediSCSIVolume struct { // data written. This value can be useful for sequential write patterns but less // accurate for random write patterns. VolumeUsedInBytes is different from the // compressed size of the volume, which is the value that is used to calculate your - // bill. This value is not available for volumes created prior to May 13, 2015, - // until you store data on the volume. If you use a delete tool that overwrites the - // data on your volume with random data, your usage will not be reduced. This is - // because the random data is not compressible. If you want to reduce the amount of - // billed storage on your volume, we recommend overwriting your files with zeros to - // compress the data to a negligible amount of actual storage. + // bill. + // + // This value is not available for volumes created prior to May 13, 2015, until + // you store data on the volume. + // + // If you use a delete tool that overwrites the data on your volume with random + // data, your usage will not be reduced. This is because the random data is not + // compressible. If you want to reduce the amount of billed storage on your volume, + // we recommend overwriting your files with zeros to 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 @@ -218,8 +232,10 @@ type ChapInfo struct { // the initiator (e.g., Windows client). SecretToAuthenticateTarget *string - // The Amazon Resource Name (ARN) of the volume. Valid Values: 50 to 500 lowercase - // letters, numbers, periods (.), and hyphens (-). + // The Amazon Resource Name (ARN) of the volume. + // + // Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens + // (-). TargetARN *string noSmithyDocumentSerde @@ -253,7 +269,9 @@ type Disk struct { DiskAllocationResource *string // One of the DiskAllocationType enumeration values that identifies how a local - // disk is used. Valid Values: UPLOAD_BUFFER | CACHE_STORAGE + // disk is used. + // + // Valid Values: UPLOAD_BUFFER | CACHE_STORAGE DiskAllocationType *string // A list of values that represents attributes of a local disk. @@ -282,8 +300,10 @@ type Disk struct { 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. + // is available. + // + // If multiple file systems are associated with this gateway, this field is + // required. IpAddresses []string noSmithyDocumentSerde @@ -298,15 +318,16 @@ type FileShareInfo struct { // The ID of the file share. FileShareId *string - // The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | - // DELETING + // The status of the file share. + // + // Valid Values: CREATING | UPDATING | AVAILABLE | DELETING FileShareStatus *string // 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 @@ -323,8 +344,10 @@ type FileSystemAssociationInfo struct { CacheAttributes *CacheAttributes // Specifies network configuration information for the gateway associated with the - // Amazon FSx file system. If multiple file systems are associated with this - // gateway, this parameter's IpAddresses field is required. + // Amazon FSx file system. + // + // If multiple file systems are associated with this gateway, this parameter's + // IpAddresses field is required. EndpointNetworkConfiguration *EndpointNetworkConfiguration // The Amazon Resource Name (ARN) of the file system association. @@ -338,13 +361,14 @@ 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]in the Amazon FSx API Reference. + // + // [FileSystem]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html LocationARN *string // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically @@ -377,8 +401,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 @@ -397,8 +421,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 @@ -409,7 +433,9 @@ type GatewayInfo struct { // The name of the gateway. GatewayName *string - // The state of the gateway. Valid Values: DISABLED | ACTIVE + // The state of the gateway. + // + // Valid Values: DISABLED | ACTIVE GatewayOperationalState *string // The type of the gateway. @@ -439,8 +465,9 @@ type NetworkInterface struct { // supported. Ipv6Address *string - // The Media Access Control (MAC) address of the interface. This is currently - // unsupported and will not be returned in output. + // The Media Access Control (MAC) address of the interface. + // + // This is currently unsupported and will not be returned in output. MacAddress *string noSmithyDocumentSerde @@ -482,9 +509,10 @@ type NFSFileShareInfo struct { AuditDestinationARN *string // Specifies the Region of the S3 bucket where the NFS file share stores files. - // This parameter is required for NFS file shares that connect to Amazon S3 through - // a VPC endpoint, a VPC access point, or an access point alias that points to a - // VPC access point. + // + // This parameter is required for NFS file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access point alias that points + // to a VPC access point. BucketRegion *string // Refresh cache information for the file share. @@ -495,8 +523,10 @@ 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: - // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA + // 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 Amazon Resource Name (ARN) of the file share. @@ -505,25 +535,32 @@ type NFSFileShareInfo struct { // The ID of the file share. 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. + // 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. FileShareName *string - // The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | - // DELETING + // 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 + // 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 @@ -533,15 +570,28 @@ type NFSFileShareInfo struct { // A custom ARN for the backend storage used for storing data for file shares. It // includes a resource ARN with an optional prefix concatenation. The prefix must - // end with a forward slash (/). You can specify LocationARN as a bucket ARN, - // access point ARN or access point alias, as shown in the following examples. - // Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: - // 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) - // in the Amazon S3 User Guide. Access point alias: - // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // end with a forward slash (/). + // + // You can specify LocationARN as a bucket ARN, access point ARN or access point + // alias, as shown in the following examples. + // + // Bucket ARN: + // + // arn:aws:s3:::my-bucket/prefix/ + // + // Access point ARN: + // + // 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]in the Amazon + // S3 User Guide. + // + // Access point alias: + // + // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // + // [Delegating access control to access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control LocationARN *string // Describes Network File System (NFS) file share default values. Files and @@ -556,11 +606,19 @@ type NFSFileShareInfo struct { // before generating an ObjectUploaded notification. Because clients can make many // small writes to files, it's best to set this parameter for as long as possible // to avoid generating multiple notifications for the same file in a small time - // period. SettlingTimeInSeconds has no effect on the timing of the object - // uploading to Amazon S3, only the timing of the notification. The following - // example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. - // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets - // NotificationPolicy off. {} + // period. + // + // SettlingTimeInSeconds has no effect on the timing of the object uploading to + // Amazon S3, only the timing of the notification. + // + // The following example sets NotificationPolicy on with SettlingTimeInSeconds set + // to 60. + // + // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} + // + // The following example sets NotificationPolicy off. + // + // {} NotificationPolicy *string // A value that sets the access control list (ACL) permission for objects in the @@ -572,17 +630,21 @@ type NFSFileShareInfo 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 // 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 @@ -590,8 +652,11 @@ 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. Squash *string @@ -601,9 +666,11 @@ type NFSFileShareInfo struct { Tags []Tag // Specifies the DNS name for the VPC endpoint that the NFS file share uses to - // connect to Amazon S3. This parameter is required for NFS file shares that - // connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access - // point alias that points to a VPC access point. + // connect to Amazon S3. + // + // This parameter is required for NFS file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access point alias that points + // to a VPC access point. VPCEndpointDNSName *string noSmithyDocumentSerde @@ -612,9 +679,9 @@ type NFSFileShareInfo struct { // Describes a custom tape pool. type PoolInfo struct { - // The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools - // operation to return a list of custom tape pools for your account and Amazon Web - // Services Region. + // The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to + // return a list of custom tape pools for your account and Amazon Web Services + // Region. PoolARN *string // The name of the custom tape pool. PoolName can use all ASCII characters, except @@ -662,13 +729,15 @@ type SMBFileShareInfo struct { AuditDestinationARN *string // The authentication method of the file share. The default is ActiveDirectory . + // // Valid Values: ActiveDirectory | GuestAccess Authentication *string // Specifies the Region of the S3 bucket where the SMB file share stores files. - // This parameter is required for SMB file shares that connect to Amazon S3 through - // a VPC endpoint, a VPC access point, or an access point alias that points to a - // VPC access point. + // + // This parameter is required for SMB file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access point alias that points + // to a VPC access point. BucketRegion *string // Refresh cache information for the file share. @@ -680,8 +749,10 @@ type SMBFileShareInfo struct { 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: - // S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA + // 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 Amazon Resource Name (ARN) of the file share. @@ -690,21 +761,26 @@ type SMBFileShareInfo struct { // The ID of the file share. 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. + // 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. FileShareName *string - // The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | - // DELETING + // 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 @@ -714,7 +790,9 @@ type SMBFileShareInfo struct { 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 + // 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 @@ -724,15 +802,28 @@ type SMBFileShareInfo struct { // A custom ARN for the backend storage used for storing data for file shares. It // includes a resource ARN with an optional prefix concatenation. The prefix must - // end with a forward slash (/). You can specify LocationARN as a bucket ARN, - // access point ARN or access point alias, as shown in the following examples. - // Bucket ARN: arn:aws:s3:::my-bucket/prefix/ Access point ARN: - // 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) - // in the Amazon S3 User Guide. Access point alias: - // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // end with a forward slash (/). + // + // You can specify LocationARN as a bucket ARN, access point ARN or access point + // alias, as shown in the following examples. + // + // Bucket ARN: + // + // arn:aws:s3:::my-bucket/prefix/ + // + // Access point ARN: + // + // 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]in the Amazon + // S3 User Guide. + // + // Access point alias: + // + // test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias + // + // [Delegating access control to access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control LocationARN *string // The notification policy of the file share. SettlingTimeInSeconds controls the @@ -740,11 +831,19 @@ type SMBFileShareInfo struct { // before generating an ObjectUploaded notification. Because clients can make many // small writes to files, it's best to set this parameter for as long as possible // to avoid generating multiple notifications for the same file in a small time - // period. SettlingTimeInSeconds has no effect on the timing of the object - // uploading to Amazon S3, only the timing of the notification. The following - // example sets NotificationPolicy on with SettlingTimeInSeconds set to 60. - // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} The following example sets - // NotificationPolicy off. {} + // period. + // + // SettlingTimeInSeconds has no effect on the timing of the object uploading to + // Amazon S3, only the timing of the notification. + // + // The following example sets NotificationPolicy on with SettlingTimeInSeconds set + // to 60. + // + // {\"Upload\": {\"SettlingTimeInSeconds\": 60}} + // + // The following example sets NotificationPolicy off. + // + // {} NotificationPolicy *string // A value that sets the access control list (ACL) permission for objects in the @@ -753,8 +852,10 @@ type SMBFileShareInfo struct { ObjectACL ObjectACL // Specifies whether opportunistic locking is enabled for the SMB file share. + // // Enabling opportunistic locking on case-sensitive shares is not recommended for // workloads that involve access to files with the same name in different case. + // // Valid Values: true | false OplocksEnabled *bool @@ -762,17 +863,21 @@ 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 // 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 @@ -781,10 +886,11 @@ type SMBFileShareInfo struct { // 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. + // 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] in the Storage Gateway User Guide. + // + // [Using Microsoft Windows ACLs to control access to an SMB file share]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html SMBACLEnabled *bool // A list of up to 50 tags assigned to the SMB file share, sorted alphabetically @@ -793,9 +899,11 @@ type SMBFileShareInfo struct { Tags []Tag // Specifies the DNS name for the VPC endpoint that the SMB file share uses to - // connect to Amazon S3. This parameter is required for SMB file shares that - // connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access - // point alias that points to a VPC access point. + // connect to Amazon S3. + // + // This parameter is required for SMB file shares that connect to Amazon S3 + // through a VPC endpoint, a VPC access point, or an access 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 @@ -813,8 +921,10 @@ 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. + // 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 @@ -847,7 +957,9 @@ type StorediSCSIVolume struct { KMSKey *string // Indicates if when the stored volume was created, existing data on the - // underlying local disk was preserved. Valid Values: true | false + // underlying local disk was preserved. + // + // Valid Values: true | false PreservedExistingData bool // If the stored volume was created from a snapshot, this field contains the @@ -858,22 +970,22 @@ type StorediSCSIVolume struct { // 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 - // specify a value, Storage Gateway uses the value that was previously used for - // this volume as the new target name. + // . 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 // The Amazon Resource Name (ARN) of the storage volume. VolumeARN *string // 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) - // . + // or is in the process of detaching from a gateway. For more information, see [Moving your volumes to a different gateway]. + // + // [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 - // operation. + // The ID of the local disk that was specified in the CreateStorediSCSIVolume operation. VolumeDiskId *string // The unique identifier of the volume, e.g., vol-AE4B946D. @@ -898,12 +1010,14 @@ type StorediSCSIVolume struct { // data written. This value can be useful for sequential write patterns but less // accurate for random write patterns. VolumeUsedInBytes is different from the // compressed size of the volume, which is the value that is used to calculate your - // bill. This value is not available for volumes created prior to May 13, 2015, - // until you store data on the volume. + // bill. + // + // This value is not available for volumes created prior to May 13, 2015, 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 @@ -946,7 +1060,9 @@ type Tape struct { PoolId *string // For archiving virtual tapes, indicates how much data remains to be uploaded - // before archiving is complete. Range: 0 (not started) to 100 (complete). + // before archiving is complete. + // + // Range: 0 (not started) to 100 (complete). Progress *float64 // The date that the tape is first archived with tape retention lock enabled. @@ -967,8 +1083,9 @@ type Tape struct { // The current state of the virtual tape. TapeStatus *string - // The size, in bytes, of data stored on the virtual tape. This value is not - // available for tapes created prior to May 13, 2015. + // The size, in bytes, of data stored on the virtual tape. + // + // This value is not available for tapes created prior to May 13, 2015. TapeUsedInBytes *int64 // The virtual tape library (VTL) device that the virtual tape is associated with. @@ -983,8 +1100,10 @@ type Tape struct { // Represents a virtual tape that is archived in the virtual tape shelf (VTS). type TapeArchive struct { - // The time that the archiving of the virtual tape was completed. The default - // timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. + // The time that the archiving of the virtual tape was completed. + // + // The default 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 @@ -992,8 +1111,10 @@ type TapeArchive struct { // 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. + // 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 @@ -1005,8 +1126,9 @@ type TapeArchive struct { RetentionStartDate *time.Time // The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is - // being retrieved to. The virtual tape is retrieved from the virtual tape shelf - // (VTS). + // being retrieved to. + // + // The virtual tape is retrieved from the virtual tape shelf (VTS). RetrievedTo *string // The Amazon Resource Name (ARN) of an archived virtual tape. @@ -1024,8 +1146,9 @@ type TapeArchive struct { // The current state of the archived virtual tape. TapeStatus *string - // The size, in bytes, of data stored on the virtual tape. This value is not - // available for tapes created prior to May 13, 2015. + // The size, in bytes, of data stored on the virtual tape. + // + // This value is not available for tapes created prior to May 13, 2015. TapeUsedInBytes *int64 // Set to true if the archived tape is stored as write-once-read-many (WORM). @@ -1037,8 +1160,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 @@ -1077,8 +1200,10 @@ type TapeRecoveryPointInfo struct { TapeARN *string // The time when the point-in-time view of the virtual tape was replicated for - // later recovery. The default timestamp format of the tape recovery point time is - // in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format. + // later recovery. + // + // The default timestamp format of the tape recovery point time is in the ISO8601 + // extended YYYY-MM-DD'T'HH:MM:SS'Z' format. TapeRecoveryPointTime *time.Time // The size, in bytes, of the virtual tapes to recover. @@ -1093,19 +1218,23 @@ 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 // becomes part of the gateway Amazon Resource Name (ARN), which you use as input - // for other operations. Valid Values: 50 to 500 lowercase letters, numbers, - // periods (.), and hyphens (-). + // for other operations. + // + // Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens + // (-). GatewayId *string // The Amazon Resource Name (ARN) for the storage volume. For example, the // following is a valid ARN: - // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB + // + // arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB + // // Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens // (-). VolumeARN *string @@ -1115,12 +1244,15 @@ type VolumeInfo struct { // 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, - // numbers, periods (.), and hyphens (-). + // The size of the volume in bytes. + // + // Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens + // (-). VolumeSizeInBytes int64 // One of the VolumeType enumeration values describing the type of the volume. @@ -1162,8 +1294,10 @@ type VolumeRecoveryPointInfo struct { // The size of the volume in bytes. VolumeSizeInBytes int64 - // The size of the data stored on the volume in bytes. This value is not available - // for volumes created prior to May 13, 2015, until you store data on the volume. + // The size of the data stored on the volume in bytes. + // + // This value is not available for volumes created prior to May 13, 2015, until + // you store data on the volume. VolumeUsageInBytes int64 noSmithyDocumentSerde diff --git a/service/sts/api_op_AssumeRole.go b/service/sts/api_op_AssumeRole.go index e0e2c9c2e8d..936f917bfd2 100644 --- a/service/sts/api_op_AssumeRole.go +++ b/service/sts/api_op_AssumeRole.go @@ -16,69 +16,99 @@ import ( // Amazon Web Services resources. These temporary credentials consist of an access // 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) -// 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 -// 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) -// 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. -// Passing policies to this operation returns new temporary credentials. The -// resulting session's permissions are the intersection of the role's -// identity-based policy and the session policies. You can use the role's temporary -// 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) -// 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 -// that is allowed to assume the role in the role trust policy. To assume a role -// from a different account, your Amazon Web Services account must be trusted by -// the role. The trust relationship is defined in the role's trust policy when the -// role is created. That trust policy states which accounts are allowed to delegate -// 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 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: +// with other API operations that produce temporary credentials, see [Requesting Temporary Security Credentials]and [Comparing the Amazon Web Services STS API operations] 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 GetFederationToken or GetSessionToken +// API operations. +// +// (Optional) You can pass inline or managed [session policies] 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. Passing policies to this operation +// returns new temporary credentials. The resulting session's permissions are the +// intersection of the role's identity-based policy and the session policies. You +// can use the role's temporary 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]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 that is allowed to +// assume the role in the role trust policy. +// +// To assume a role from a different account, your Amazon Web Services account +// must be trusted by the role. The trust relationship is defined in the role's +// trust policy when the role is created. That trust policy states which accounts +// are allowed to delegate 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 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: +// // - 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. // // 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 -// 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) -// 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) -// in the IAM User Guide. Using MFA with AssumeRole (Optional) You can include -// 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 -// MFA authentication. If the caller does not include valid MFA information, the -// 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. +// about trust policies and resource-based policies, see [IAM Policies]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]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]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]in the IAM User Guide. +// +// # Using MFA with AssumeRole +// +// (Optional) You can include 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 MFA authentication. If the caller +// does not include valid MFA information, the 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] 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 +// [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Passing Session Tags in STS]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html +// [Chaining Roles with Session Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining +// [Comparing the Amazon Web Services STS API operations]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison +// [session policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html +// [Requesting Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html +// [Tutorial: Using Tags for Attribute-Based Access Control]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html func (c *Client) AssumeRole(ctx context.Context, params *AssumeRoleInput, optFns ...func(*Options)) (*AssumeRoleOutput, error) { if params == nil { params = &AssumeRoleInput{} @@ -101,17 +131,19 @@ type AssumeRoleInput struct { // This member is required. RoleArn *string - // An identifier for the assumed role session. Use the role session name to - // uniquely identify a session when the same role is assumed by different - // principals or for different reasons. In cross-account scenarios, the role - // session name is visible to, and can be logged by the account that owns the role. - // The role session name is also used in the ARN of the assumed role principal. - // This means that subsequent cross-account API requests that use the temporary - // security credentials will expose the role session name to the external account - // in their CloudTrail logs. 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: - // =,.@- + // An identifier for the assumed role session. + // + // Use the role session name to uniquely identify a session when the same role is + // assumed by different principals or for different reasons. In cross-account + // scenarios, the role session name is visible to, and can be logged by the account + // that owns the role. The role session name is also used in the ARN of the assumed + // role principal. This means that subsequent cross-account API requests that use + // the temporary security credentials will expose the role session name to the + // external account in their CloudTrail logs. + // + // 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. RoleSessionName *string @@ -122,23 +154,27 @@ type AssumeRoleInput struct { // hours. If you specify a value higher than this setting or the administrator // setting (whichever is lower), 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. Role chaining limits your Amazon Web - // Services 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. You can - // specify a parameter value of up to 43200 seconds (12 hours), depending on the - // 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) - // 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 + // duration to 6 hours, your operation fails. + // + // Role chaining limits your Amazon Web Services 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. You can specify a parameter value of up to + // 43200 seconds (12 hours), depending on the 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]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) - // in the IAM User Guide. + // information, see [Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console]in the IAM User Guide. + // + // [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 + // [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 DurationSeconds *int32 // A unique identifier that might be required when you assume a role in another @@ -149,63 +185,79 @@ type AssumeRoleInput struct { // the administrator of the trusting account might send an external ID to the // 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) - // 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: - // =,.@:/- + // the external ID, see [How to Use an External ID When Granting Access to Your Amazon Web Services Resources to a Third Party]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: =,.@:/- + // + // [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 // An IAM policy in JSON format that you want to use as an inline session policy. + // // This parameter is optional. Passing policies to this operation returns new // temporary credentials. The resulting session's permissions are the intersection // of the role's identity-based policy and the session policies. You can use the // role's temporary 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) - // 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 - // character list (\u0020 through \u00FF). It can also include the tab (\u0009), - // linefeed (\u000A), and carriage return (\u000D) characters. 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 size limit. + // policy of the role that is being assumed. For more information, see [Session Policies]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 character list (\u0020 through + // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage + // return (\u000D) characters. + // + // 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 + // size limit. + // + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Policy *string // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as managed session policies. The policies must exist in the same account as - // 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 - // 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 size limit. Passing policies to this - // operation returns new temporary credentials. The resulting session's permissions - // are the intersection of the role's identity-based policy and the session - // policies. You can use the role's temporary 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) - // in the IAM User Guide. + // 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]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 PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the upper + // size limit. + // + // Passing policies to this operation returns new temporary credentials. The + // resulting session's permissions are the intersection of the role's + // identity-based policy and the session policies. You can use the role's temporary + // 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]in the IAM User Guide. + // + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArns []types.PolicyDescriptorType // A list of previously acquired trusted context assertions in the format of a // JSON array. The trusted context assertion is signed and encrypted by Amazon Web - // Services STS. The following is an example of a ProvidedContext value that - // includes a single trusted context assertion and the ARN of the context provider - // from which the trusted context assertion was generated. - // [{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}] + // Services STS. + // + // The following is an example of a ProvidedContext value that includes a single + // trusted context assertion and the ARN of the context provider from which the + // trusted context assertion was generated. + // + // [{"ProviderArn":"arn:aws:iam::aws:contextProvider/IdentityCenter","ContextAssertion":"trusted-context-assertion"}] ProvidedContexts []types.ProvidedContext // The identification number of the MFA device that is associated with the user @@ -213,79 +265,97 @@ type AssumeRoleInput struct { // 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: =,.@- + // 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: =,.@- SerialNumber *string // The source identity specified by the principal that is calling the AssumeRole - // operation. You can require users to specify a source identity when they assume a - // role. You do this by using the sts:SourceIdentity condition key in a role trust - // policy. You can use source identity information in CloudTrail logs to determine - // 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) - // 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 - // reserved for Amazon Web Services internal use. + // operation. + // + // You can require users to specify a source identity when they assume a role. You + // do this by using the sts:SourceIdentity condition key in a role trust policy. + // You can use source identity information in CloudTrail logs to determine 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]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 reserved for Amazon Web + // Services internal use. + // + // [Monitor and control actions taken with assumed roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html 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) - // 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 - // 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 size limit. You can pass a session tag with the - // 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) + // key name and an associated value. For more information about session tags, see [Tagging Amazon Web Services STS Sessions] // 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]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 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 + // size limit. + // + // You can pass a session tag with the 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]in the IAM User Guide. + // + // [Tagging Amazon Web Services STS Sessions]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html + // [IAM and STS Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length + // [Viewing Session Tags in CloudTrail]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_ctlogs Tags []types.Tag // The value provided by the MFA device, if the trust policy of the role being // assumed requires MFA. (In other words, if the policy includes a condition that // tests for MFA). If the role being assumed requires MFA and if the TokenCode // value is missing or expired, the AssumeRole call returns an "access denied" - // error. The format for this parameter, as described by its regex pattern, is a - // sequence of six numeric digits. + // error. + // + // The format for this parameter, as described by its regex pattern, is a 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 - // 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) - // 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 - // passed from this session to any subsequent sessions. + // sessions in a role chain. For more information, see [Chaining Roles with Session Tags]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 passed from + // this session to any subsequent sessions. + // + // [Chaining Roles with Session Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining TransitiveTagKeys []string noSmithyDocumentSerde } -// Contains the response to a successful AssumeRole request, including temporary -// Amazon Web Services credentials that can be used to make Amazon Web Services -// requests. +// Contains the response to a successful AssumeRole request, including temporary Amazon Web +// Services credentials that can be used to make Amazon Web Services requests. type AssumeRoleOutput struct { // The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers @@ -296,9 +366,10 @@ type AssumeRoleOutput struct { AssumedRoleUser *types.AssumedRoleUser // The temporary security credentials, which include an access key ID, a secret - // access key, and a security (or session) token. The size of the security token - // that STS API operations return is not fixed. We strongly recommend that you make - // no assumptions about the maximum size. + // access key, and a security (or session) token. + // + // The size of the security token that STS API operations return is not fixed. We + // strongly recommend that you make no assumptions about the maximum size. Credentials *types.Credentials // A percentage value that indicates the packed size of the session policies and @@ -308,17 +379,21 @@ type AssumeRoleOutput struct { PackedPolicySize *int32 // The source identity specified by the principal that is calling the AssumeRole - // operation. You can require users to specify a source identity when they assume a - // role. You do this by using the sts:SourceIdentity condition key in a role trust - // policy. You can use source identity information in CloudTrail logs to determine - // 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) - // 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: - // =,.@- + // operation. + // + // You can require users to specify a source identity when they assume a role. You + // do this by using the sts:SourceIdentity condition key in a role trust policy. + // You can use source identity information in CloudTrail logs to determine 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]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: =,.@- + // + // [Monitor and control actions taken with assumed roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html SourceIdentity *string // Metadata pertaining to the operation's result. diff --git a/service/sts/api_op_AssumeRoleWithSAML.go b/service/sts/api_op_AssumeRoleWithSAML.go index 2a57b72ac99..f88ab4a22b4 100644 --- a/service/sts/api_op_AssumeRoleWithSAML.go +++ b/service/sts/api_op_AssumeRoleWithSAML.go @@ -16,92 +16,132 @@ 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) -// 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 -// to Amazon Web Services services. Session Duration By default, the temporary -// security credentials created by AssumeRoleWithSAML last for one hour. However, -// you can use the optional DurationSeconds parameter to specify the duration of -// your session. Your role session lasts for the duration that you specify, or -// until the time specified in the SAML authentication response's -// SessionNotOnOrAfter value, whichever is shorter. You can provide a -// 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) -// 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) -// limits your CLI or Amazon Web Services API role session to a maximum of one +// produce temporary credentials, see [Requesting Temporary Security Credentials]and [Comparing the Amazon Web Services STS API operations] 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 to Amazon Web Services +// services. +// +// # Session Duration +// +// By default, the temporary security credentials created by AssumeRoleWithSAML +// last for one hour. However, you can use the optional DurationSeconds parameter +// to specify the duration of your session. Your role session lasts for the +// duration that you specify, or until the time specified in the SAML +// authentication response's SessionNotOnOrAfter value, whichever is shorter. You +// can provide a 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]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]in the IAM User Guide. +// +// [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. // You can specify a parameter value of up to 43200 seconds (12 hours), depending // on the 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. Permissions The temporary security -// 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) -// 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. -// Passing policies to this operation returns new temporary credentials. The -// resulting session's permissions are the intersection of the role's -// identity-based policy and the session policies. You can use the role's temporary -// 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) -// 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 -// provider entity for your identity provider. Calling AssumeRoleWithSAML can -// 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 -// 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) -// 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 -// 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 size limit. You can pass a session tag with the -// same key as a tag that is attached to the role. When you do, session tags -// 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) -// 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) -// in the IAM User Guide. SAML Configuration Before your application can call -// 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. +// than one hour, the operation fails. +// +// # Permissions +// +// The temporary security 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] 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. Passing policies to this operation +// returns new temporary credentials. The resulting session's permissions are the +// intersection of the role's identity-based policy and the session policies. You +// can use the role's temporary 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]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 provider entity for your +// identity provider. +// +// Calling AssumeRoleWithSAML can 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 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]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]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 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 +// size limit. +// +// You can pass a session tag with the same key as a tag that is attached to the +// role. When you do, session tags 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]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]in the IAM User Guide. +// +// # SAML Configuration +// +// Before your application can call 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] +// - in the IAM User Guide. +// +// [Creating SAML Identity Providers] +// - in the IAM User Guide. +// +// [Configuring a Relying Party and Claims] +// - in the IAM User Guide. +// +// [Creating a Role for SAML 2.0 Federation] +// - in the IAM User Guide. +// +// [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 +// [Creating a Role for SAML 2.0 Federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html +// [IAM and STS Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length +// [Comparing the Amazon Web Services STS API operations]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison +// [Creating SAML Identity Providers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html +// [session policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Requesting Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html +// [Tutorial: Using Tags for Attribute-Based Access Control]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html +// [Configuring a Relying Party and Claims]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html +// [Role chaining]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining +// [Using IAM Roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html +// [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Passing Session Tags in STS]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html +// [About SAML 2.0-based Federation]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html +// [Chaining Roles with Session Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining func (c *Client) AssumeRoleWithSAML(ctx context.Context, params *AssumeRoleWithSAMLInput, optFns ...func(*Options)) (*AssumeRoleWithSAMLOutput, error) { if params == nil { params = &AssumeRoleWithSAMLInput{} @@ -130,9 +170,11 @@ type AssumeRoleWithSAMLInput struct { // This member is required. 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) - // in the IAM User Guide. + // The base64 encoded SAML authentication response provided by the IdP. + // + // For more information, see [Configuring a Relying Party and Adding Claims] in the IAM User Guide. + // + // [Configuring a Relying Party and Adding Claims]: https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html // // This member is required. SAMLAssertion *string @@ -146,92 +188,114 @@ 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) - // 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 + // role, see [View the Maximum Session Duration Setting for a Role]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) - // in the IAM User Guide. + // information, see [Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console]in the IAM User Guide. + // + // [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 + // [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 DurationSeconds *int32 // An IAM policy in JSON format that you want to use as an inline session policy. + // // This parameter is optional. Passing policies to this operation returns new // temporary credentials. The resulting session's permissions are the intersection // of the role's identity-based policy and the session policies. You can use the // role's temporary 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) - // 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 - // character list (\u0020 through \u00FF). It can also include the tab (\u0009), - // linefeed (\u000A), and carriage return (\u000D) characters. 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 size limit. + // policy of the role that is being assumed. For more information, see [Session Policies]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 character list (\u0020 through + // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage + // return (\u000D) characters. + // + // 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 + // size limit. + // + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Policy *string // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as managed session policies. The policies must exist in the same account as - // 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 - // 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 size limit. Passing policies to this - // operation returns new temporary credentials. The resulting session's permissions - // are the intersection of the role's identity-based policy and the session - // policies. You can use the role's temporary 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) - // in the IAM User Guide. + // 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]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 PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the upper + // size limit. + // + // Passing policies to this operation returns new temporary credentials. The + // resulting session's permissions are the intersection of the role's + // identity-based policy and the session policies. You can use the role's temporary + // 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]in the IAM User Guide. + // + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArns []types.PolicyDescriptorType noSmithyDocumentSerde } -// Contains the response to a successful AssumeRoleWithSAML request, including -// temporary Amazon Web Services credentials that can be used to make Amazon Web -// Services requests. +// Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web +// Services credentials that can be used to make Amazon Web Services requests. type AssumeRoleWithSAMLOutput struct { // The identifiers for the temporary security credentials that the operation // returns. AssumedRoleUser *types.AssumedRoleUser - // The value of the Recipient attribute of the SubjectConfirmationData element of + // The value of the Recipient attribute of the SubjectConfirmationData element of // the SAML assertion. Audience *string // The temporary security credentials, which include an access key ID, a secret - // access key, and a security (or session) token. The size of the security token - // that STS API operations return is not fixed. We strongly recommend that you make - // no assumptions about the maximum size. + // access key, and a security (or session) token. + // + // The size of the security token that STS API operations return is not fixed. We + // strongly recommend that you make no assumptions about the maximum size. Credentials *types.Credentials // The value of the Issuer element of the SAML assertion. 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 - // user. The following pseudocode shows how the hash value is calculated: BASE64 ( - // SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) ) + // 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 @@ -240,31 +304,36 @@ 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 - // 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) - // 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 - // 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) - // 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: - // =,.@- + // 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]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 assertion. For more information about using source identity, see [Monitor and control actions taken with assumed roles]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: =,.@- + // + // [chained role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining + // [Monitor and control actions taken with assumed roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html SourceIdentity *string // The value of the NameID element in the Subject element of the SAML assertion. Subject *string - // The format of the name ID, as defined by the Format attribute in the NameID + // 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, + // 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. diff --git a/service/sts/api_op_AssumeRoleWithWebIdentity.go b/service/sts/api_op_AssumeRoleWithWebIdentity.go index 98108ce6af0..6c8cf43e534 100644 --- a/service/sts/api_op_AssumeRoleWithWebIdentity.go +++ b/service/sts/api_op_AssumeRoleWithWebIdentity.go @@ -14,105 +14,143 @@ import ( // Returns a set of temporary security credentials for users who have been // 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 identity pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html) -// in Amazon Cognito Developer Guide. Calling AssumeRoleWithWebIdentity does not -// require the use of Amazon Web Services security credentials. Therefore, you can -// distribute an application (for example, on mobile devices) that requests -// temporary security credentials without including long-term Amazon Web Services -// credentials in the application. You also don't need to deploy server-based proxy -// services that use long-term Amazon Web 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) -// 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) -// 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 -// 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) -// 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. -// Passing policies to this operation returns new temporary credentials. The -// resulting session's permissions are the intersection of the role's -// identity-based policy and the session policies. You can use the role's temporary -// 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) -// 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) -// 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 -// 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 size limit. You can pass a session tag with the -// same key as a tag that is attached to the role. When you do, the session tag -// 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) -// 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) -// in the IAM User Guide. Identities Before your application can call -// 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 +// Facebook, or any OpenID Connect-compatible identity provider such as Google or [Amazon Cognito federated identities]. +// +// 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]and the [Amazon Web Services SDK for Android Developer Guide] 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 identity pools] in Amazon Cognito Developer Guide. +// +// Calling AssumeRoleWithWebIdentity does not require the use of Amazon Web +// Services security credentials. Therefore, you can distribute an application (for +// example, on mobile devices) that requests temporary security credentials without +// including long-term Amazon Web Services credentials in the application. You also +// don't need to deploy server-based proxy services that use long-term Amazon Web +// 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]and [Comparing the Amazon Web Services STS API operations] 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]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]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] 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. Passing policies to this operation +// returns new temporary credentials. The resulting session's permissions are the +// intersection of the role's identity-based policy and the session policies. You +// can use the role's temporary 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]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]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]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 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 +// size limit. +// +// You can pass a session tag with the same key as a tag that is attached to the +// role. When you do, the session tag 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]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]in the IAM User Guide. +// +// # Identities +// +// Before your application can call 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]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]. +// +// 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, +// +// [Using Web Identity Federation API Operations for Mobile Apps] +// - and [Federation Through a Web-based Identity Provider]. +// +// [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 +// +// [Amazon Web Services SDK for iOS Developer Guide] +// - and [Amazon Web Services SDK for Android Developer Guide]. 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. +// +// [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. +// +// [Amazon Web Services SDK for iOS Developer Guide]: http://aws.amazon.com/sdkforios/ +// [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 +// [Web Identity Federation Playground]: https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/ +// [Amazon Web Services SDK for Android Developer Guide]: http://aws.amazon.com/sdkforandroid/ +// [IAM and STS Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length +// [Comparing the Amazon Web Services STS API operations]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison +// [session policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Requesting Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html +// [Subject]: http://openid.net/specs/openid-connect-core-1_0.html#Claims +// [Tutorial: Using Tags for Attribute-Based Access Control]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html +// [Amazon Cognito identity pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html +// [Federation Through a Web-based Identity Provider]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity +// [Using IAM Roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html +// [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Amazon Cognito federated identities]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html +// [Passing Session Tags in STS]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html +// [Chaining Roles with Session Tags]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining +// [Web Identity Federation with Mobile Applications]: http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications +// [Using Web Identity Federation API Operations for Mobile Apps]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html +// [suggested in the OIDC specification]: http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes func (c *Client) AssumeRoleWithWebIdentity(ctx context.Context, params *AssumeRoleWithWebIdentityInput, optFns ...func(*Options)) (*AssumeRoleWithWebIdentityOutput, error) { if params == nil { params = &AssumeRoleWithWebIdentityInput{} @@ -139,10 +177,11 @@ type AssumeRoleWithWebIdentityInput struct { // identifier that is associated with the user who is using your application. That // way, the temporary security credentials that your application will use are // associated with that user. This session name is included as part of the ARN and - // assumed role ID in the AssumedRoleUser response element. 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: =,.@- + // assumed role ID in the AssumedRoleUser response element. + // + // 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. RoleSessionName *string @@ -162,73 +201,90 @@ 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) - // 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 + // value for your role, see [View the Maximum Session Duration Setting for a Role]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) - // in the IAM User Guide. + // information, see [Creating a URL that Enables Federated Users to Access the Amazon Web Services Management Console]in the IAM User Guide. + // + // [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 + // [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 DurationSeconds *int32 // An IAM policy in JSON format that you want to use as an inline session policy. + // // This parameter is optional. Passing policies to this operation returns new // temporary credentials. The resulting session's permissions are the intersection // of the role's identity-based policy and the session policies. You can use the // role's temporary 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) - // 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 - // character list (\u0020 through \u00FF). It can also include the tab (\u0009), - // linefeed (\u000A), and carriage return (\u000D) characters. 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 size limit. + // policy of the role that is being assumed. For more information, see [Session Policies]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 character list (\u0020 through + // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage + // return (\u000D) characters. + // + // 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 + // size limit. + // + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Policy *string // The Amazon Resource Names (ARNs) of the IAM managed policies that you want to // use as managed session policies. The policies must exist in the same account as - // 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 - // 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 size limit. Passing policies to this - // operation returns new temporary credentials. The resulting session's permissions - // are the intersection of the role's identity-based policy and the session - // policies. You can use the role's temporary 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) - // in the IAM User Guide. + // 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]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 PackedPolicySize response element indicates + // by percentage how close the policies and tags for your request are to the upper + // size limit. + // + // Passing policies to this operation returns new temporary credentials. The + // resulting session's permissions are the intersection of the role's + // identity-based policy and the session policies. You can use the role's temporary + // 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]in the IAM User Guide. + // + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html PolicyArns []types.PolicyDescriptorType // The fully qualified host component of the domain name of the OAuth 2.0 identity // provider. Do not specify this value for an OpenID Connect identity provider. + // // Currently www.amazon.com and graph.facebook.com are the only supported identity // providers for OAuth 2.0 access tokens. Do not include URL schemes and port - // numbers. Do not specify this value for OpenID Connect ID tokens. + // numbers. + // + // Do not specify this value for OpenID Connect ID tokens. ProviderId *string noSmithyDocumentSerde } -// Contains the response to a successful AssumeRoleWithWebIdentity request, -// including temporary Amazon Web Services credentials that can be used to make -// Amazon Web Services requests. +// Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary Amazon Web +// Services credentials that can be used to make Amazon Web Services requests. type AssumeRoleWithWebIdentityOutput struct { // The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers @@ -244,9 +300,10 @@ type AssumeRoleWithWebIdentityOutput struct { Audience *string // The temporary security credentials, which include an access key ID, a secret - // access key, and a security token. The size of the security token that STS API - // operations return is not fixed. We strongly recommend that you make no - // assumptions about the maximum size. + // access key, and a security token. + // + // The size of the security token that STS API operations return is not fixed. We + // strongly recommend that you make no assumptions about the maximum size. Credentials *types.Credentials // A percentage value that indicates the packed size of the session policies and @@ -255,30 +312,34 @@ type AssumeRoleWithWebIdentityOutput struct { // allowed space. PackedPolicySize *int32 - // The issuing authority of the web identity token presented. For OpenID Connect + // 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) - // from the identity provider. 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) - // sessions. You can configure your identity provider to use an attribute + // from the identity provider. + // + // 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]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) - // 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) - // 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: - // =,.@- + // web token. To learn more about OIDC tokens and claims, see [Using Tokens with User Pools]in the Amazon + // Cognito Developer Guide. For more information about using source identity, see [Monitor and control actions taken with assumed roles] + // 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: =,.@- + // + // [chained role]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining + // [Monitor and control actions taken with assumed roles]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html + // [Using Tokens with User Pools]: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html SourceIdentity *string // The unique user identifier that is returned by the identity provider. This diff --git a/service/sts/api_op_DecodeAuthorizationMessage.go b/service/sts/api_op_DecodeAuthorizationMessage.go index b4ad54ab2fa..186a8cb5838 100644 --- a/service/sts/api_op_DecodeAuthorizationMessage.go +++ b/service/sts/api_op_DecodeAuthorizationMessage.go @@ -11,28 +11,39 @@ import ( ) // Decodes additional information about the authorization status of a request from -// an encoded message returned in response to an Amazon Web Services request. For -// example, if a user is not authorized to perform an operation that he or she has -// requested, the request returns a Client.UnauthorizedOperation response (an HTTP -// 403 response). Some Amazon Web Services operations additionally return an -// encoded message that can provide details about this authorization failure. Only -// certain Amazon Web Services operations return an encoded authorization message. -// The documentation for an individual operation indicates whether that operation -// returns an encoded message in addition to returning an HTTP code. The message is -// 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: +// an encoded message returned in response to an Amazon Web Services request. +// +// For example, if a user is not authorized to perform an operation that he or she +// has requested, the request returns a Client.UnauthorizedOperation response (an +// HTTP 403 response). Some Amazon Web Services operations additionally return an +// encoded message that can provide details about this authorization failure. +// +// Only certain Amazon Web Services operations return an encoded authorization +// message. The documentation for an individual operation indicates whether that +// operation returns an encoded message in addition to returning an HTTP code. +// +// The message is 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]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. +// absence of an explicit allow. For more information, see [Determining Whether a Request is Allowed or Denied]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. +// +// [Determining Whether a Request is Allowed or Denied]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow +// [policy]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html 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 1f7cbcc2bbb..b6eb6401af0 100644 --- a/service/sts/api_op_GetAccessKeyInfo.go +++ b/service/sts/api_op_GetAccessKeyInfo.go @@ -10,23 +10,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// 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) -// 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 -// an error that the key doesn't exist. +// 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]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]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]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 an error that the key +// doesn't exist. +// +// [credentials report]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html +// [CloudTrail logs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html +// [Managing Access Keys for IAM Users]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html func (c *Client) GetAccessKeyInfo(ctx context.Context, params *GetAccessKeyInfoInput, optFns ...func(*Options)) (*GetAccessKeyInfoOutput, error) { if params == nil { params = &GetAccessKeyInfoInput{} @@ -44,9 +52,10 @@ func (c *Client) GetAccessKeyInfo(ctx context.Context, params *GetAccessKeyInfoI type GetAccessKeyInfoInput struct { - // The identifier of an access key. This parameter allows (through its regex - // pattern) a string of characters that can consist of any upper- or lowercase - // letter or digit. + // The identifier of an access key. + // + // This parameter allows (through its regex pattern) a string of characters that + // can consist of any upper- or lowercase letter or digit. // // This member is required. AccessKeyId *string diff --git a/service/sts/api_op_GetCallerIdentity.go b/service/sts/api_op_GetCallerIdentity.go index acb7ede44fd..ed4c82832a3 100644 --- a/service/sts/api_op_GetCallerIdentity.go +++ b/service/sts/api_op_GetCallerIdentity.go @@ -12,13 +12,15 @@ import ( ) // Returns details about the IAM user or role whose credentials are used to call -// the operation. No permissions are required to perform this operation. If an -// administrator attaches a policy to your identity 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 -// access is denied. 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. +// the operation. +// +// No permissions are required to perform this operation. If an administrator +// attaches a policy to your identity 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 access is denied. +// To view an example response, see [I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice]in the IAM User Guide. +// +// [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 func (c *Client) GetCallerIdentity(ctx context.Context, params *GetCallerIdentityInput, optFns ...func(*Options)) (*GetCallerIdentityOutput, error) { if params == nil { params = &GetCallerIdentityInput{} @@ -38,8 +40,8 @@ type GetCallerIdentityInput struct { noSmithyDocumentSerde } -// Contains the response to a successful GetCallerIdentity request, including -// information about the entity making the request. +// Contains the response to a successful GetCallerIdentity request, including information about the +// entity making the request. type GetCallerIdentityOutput struct { // The Amazon Web Services account ID number of the account that owns or contains @@ -51,8 +53,10 @@ type GetCallerIdentityOutput struct { // 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. + // the aws:userid column in the [Principal table]found on the Policy Variables reference page in + // the IAM User Guide. + // + // [Principal table]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable UserId *string // Metadata pertaining to the operation's result. diff --git a/service/sts/api_op_GetFederationToken.go b/service/sts/api_op_GetFederationToken.go index 3679618cb5a..37bde0cce6b 100644 --- a/service/sts/api_op_GetFederationToken.go +++ b/service/sts/api_op_GetFederationToken.go @@ -14,74 +14,100 @@ import ( // Returns a set of temporary security credentials (consisting of an access key // ID, a secret access key, and a security token) for a 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 safeguarded, 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) -// in the IAM User Guide. Although it is possible to call GetFederationToken using -// the security credentials of an Amazon Web Services account root user rather than -// an IAM user that you create for the purpose of a proxy application, we do not -// recommend it. For more information, see Safeguard your root user credentials -// and don't use them for everyday tasks (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials) -// 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) -// 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 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: +// 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 safeguarded, 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]and [Comparing the Amazon Web Services STS API operations] in the IAM User Guide. +// +// Although it is possible to call GetFederationToken using the security +// credentials of an Amazon Web Services account root user rather than an IAM user +// that you create for the purpose of a proxy application, we do not recommend it. +// For more information, see [Safeguard your root user credentials and don't use them for everyday tasks]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]or AssumeRoleWithWebIdentity . For more information, see [Federation Through a Web-based Identity Provider] 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 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 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 -// use for both inline and managed session policies can't exceed 2,048 characters. +// You can use temporary credentials for single sign-on (SSO) to the console. +// +// You must pass an inline or managed [session policy] 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. +// // Though the session policy parameters are optional, if you do not pass a policy, // 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) -// 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 +// of the IAM user. For more information, see [Session Policies]in the IAM User Guide. For +// information about using GetFederationToken to create temporary security +// credentials, see [GetFederationToken—Federation Through a Custom Identity Broker]. +// +// 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, -// 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) -// 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) -// 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. +// 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]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]or AssumeRoleWithWebIdentity . For more information, see [Federation Through a Web-based Identity Provider] 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]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. +// +// [Federation Through a Web-based Identity Provider]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity +// [session policy]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Amazon Cognito]: http://aws.amazon.com/cognito/ +// [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session +// [Passing Session Tags in STS]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html +// [GetFederationToken—Federation Through a Custom Identity Broker]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken +// [Comparing the Amazon Web Services STS API operations]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison +// [Safeguard your root user credentials and don't use them for everyday tasks]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials +// [Requesting Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html +// [Tutorial: Using Tags for Attribute-Based Access Control]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html func (c *Client) GetFederationToken(ctx context.Context, params *GetFederationTokenInput, optFns ...func(*Options)) (*GetFederationTokenOutput, error) { if params == nil { params = &GetFederationTokenInput{} @@ -102,10 +128,11 @@ 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: - // =,.@- + // 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 @@ -119,99 +146,127 @@ type GetFederationTokenInput struct { 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) - // 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 - // 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) - // 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, - // the session has the permissions allowed by the policy. These permissions are - // granted in addition to the permissions that are granted by the session policies. + // + // You must pass an inline or managed [session policy] 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 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]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, the session has the permissions + // allowed by the policy. These permissions are granted in addition to the + // permissions that are granted by the session policies. + // // 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 character list (\u0020 through // \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage - // return (\u000D) characters. 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 size limit. + // return (\u000D) characters. + // + // 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 + // size limit. + // + // [session policy]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session Policy *string // 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) - // 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 - // 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) - // 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, - // the session has the permissions allowed by the policy. These permissions are - // granted in addition to the permissions that are granted by the session policies. + // the IAM user that is requesting federated access. + // + // You must pass an inline or managed [session policy] 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]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]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, the session has the permissions + // allowed by the policy. These permissions are granted in addition to the + // permissions that are granted by the session policies. + // // 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 // size limit. + // + // [session policy]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session + // [Session Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html 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) - // 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 - // 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 size limit. You can pass a session tag with the - // same key as a tag that is already attached to the user you are federating. When - // 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. + // associated value. For more information about session tags, see [Passing Session Tags in STS]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]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 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 + // size limit. + // + // You can pass a session tag with the same key as a tag that is already attached + // to the user you are federating. When 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. + // + // [Passing Session Tags in STS]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html + // [IAM and STS Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length Tags []types.Tag noSmithyDocumentSerde } -// Contains the response to a successful GetFederationToken request, including -// temporary Amazon Web Services credentials that can be used to make Amazon Web -// Services requests. +// Contains the response to a successful GetFederationToken request, including temporary Amazon Web +// Services credentials that can be used to make Amazon Web Services requests. type GetFederationTokenOutput struct { // The temporary security credentials, which include an access key ID, a secret - // access key, and a security (or session) token. The size of the security token - // that STS API operations return is not fixed. We strongly recommend that you make - // no assumptions about the maximum size. + // access key, and a security (or session) token. + // + // The size of the security token that STS API operations return is not fixed. We + // strongly recommend that you make no assumptions about the maximum size. Credentials *types.Credentials // Identifiers for the federated user associated with the credentials (such as diff --git a/service/sts/api_op_GetSessionToken.go b/service/sts/api_op_GetSessionToken.go index 751fb147d4b..097ccd84480 100644 --- a/service/sts/api_op_GetSessionToken.go +++ b/service/sts/api_op_GetSessionToken.go @@ -15,43 +15,58 @@ import ( // 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 must call GetSessionToken and -// submit an MFA code that is associated with their MFA device. Using the temporary -// security credentials that the call returns, IAM users can then make programmatic -// calls to API operations that require MFA authentication. An incorrect MFA code -// causes the API to return 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) -// 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) -// in the IAM User Guide. Session Duration The GetSessionToken operation must be -// called by using the long-term Amazon Web Services security credentials of an IAM -// user. Credentials that are created by IAM users are valid for the duration that -// you specify. This duration can range from 900 seconds (15 minutes) up to a -// maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 -// hours). Credentials based on account credentials can range from 900 seconds (15 -// minutes) up to 3,600 seconds (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: +// Amazon EC2 StopInstances . +// +// MFA-enabled IAM users must call GetSessionToken and submit an MFA code that is +// associated with their MFA device. Using the temporary security credentials that +// the call returns, IAM users can then make programmatic calls to API operations +// that require MFA authentication. An incorrect MFA code causes the API to return +// an access denied error. For a comparison of GetSessionToken with the other API +// operations that produce temporary credentials, see [Requesting Temporary Security Credentials]and [Comparing the Amazon Web Services STS API operations] 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]in the IAM User Guide. +// +// # Session Duration +// +// The GetSessionToken operation must be called by using the long-term Amazon Web +// Services security credentials of an IAM user. Credentials that are created by +// IAM users are valid for the duration that you specify. This duration can range +// from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), +// with a default of 43,200 seconds (12 hours). Credentials based on account +// credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (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 . // // The credentials that GetSessionToken returns are based on permissions // associated with the IAM user whose credentials were used to call the operation. -// The temporary credentials have the same permissions as the IAM user. Although it -// is possible to call GetSessionToken using the security credentials of an Amazon -// Web Services account root user rather than an IAM user, we do not recommend it. -// If GetSessionToken is called using root user credentials, the temporary -// credentials have root user permissions. For more information, see Safeguard -// your root user credentials and don't use them for everyday tasks (https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials) -// in the IAM User Guide For more information about using GetSessionToken to -// create temporary credentials, see Temporary 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. +// The temporary credentials have the same permissions as the IAM user. +// +// Although it is possible to call GetSessionToken using the security credentials +// of an Amazon Web Services account root user rather than an IAM user, we do not +// recommend it. If GetSessionToken is called using root user credentials, the +// temporary credentials have root user permissions. For more information, see [Safeguard your root user credentials and don't use them for everyday tasks]in +// the IAM User Guide +// +// For more information about using GetSessionToken to create temporary +// credentials, see [Temporary Credentials for Users in Untrusted Environments]in the IAM User Guide. +// +// [Permissions for GetSessionToken]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getsessiontoken.html +// [Comparing the Amazon Web Services STS API operations]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison +// [Temporary Credentials for Users in Untrusted Environments]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken +// [Safeguard your root user credentials and don't use them for everyday tasks]: https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials +// [Requesting Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html func (c *Client) GetSessionToken(ctx context.Context, params *GetSessionTokenInput, optFns ...func(*Options)) (*GetSessionTokenOutput, error) { if params == nil { params = &GetSessionTokenInput{} @@ -83,10 +98,11 @@ type GetSessionTokenInput struct { // 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: =,.@:/- + // 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 @@ -94,22 +110,24 @@ type GetSessionTokenInput struct { // 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. + // authentication. + // + // The format for this parameter, as described by its regex pattern, is a sequence + // of six numeric digits. TokenCode *string noSmithyDocumentSerde } -// Contains the response to a successful GetSessionToken request, including -// temporary Amazon Web Services credentials that can be used to make Amazon Web -// Services requests. +// Contains the response to a successful GetSessionToken request, including temporary Amazon Web +// Services credentials that can be used to make Amazon Web Services requests. type GetSessionTokenOutput struct { // The temporary security credentials, which include an access key ID, a secret - // access key, and a security (or session) token. The size of the security token - // that STS API operations return is not fixed. We strongly recommend that you make - // no assumptions about the maximum size. + // access key, and a security (or session) token. + // + // The size of the security token that STS API operations return is not fixed. We + // strongly recommend that you make no assumptions about the maximum size. Credentials *types.Credentials // Metadata pertaining to the operation's result. diff --git a/service/sts/doc.go b/service/sts/doc.go index d963fd8d19a..cbb19c7f668 100644 --- a/service/sts/doc.go +++ b/service/sts/doc.go @@ -3,9 +3,11 @@ // Package sts provides the API client, operations, and parameter types for AWS // Security Token Service. // -// Security Token Service Security Token Service (STS) enables you to request -// temporary, limited-privilege credentials for 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) -// . +// # Security Token Service +// +// Security Token Service (STS) enables you to request temporary, +// limited-privilege credentials for users. This guide provides descriptions of the +// STS API. For more information about using this service, see [Temporary Security Credentials]. +// +// [Temporary Security Credentials]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html package sts diff --git a/service/sts/options.go b/service/sts/options.go index 5c1be79f8c0..bb291161aa9 100644 --- a/service/sts/options.go +++ b/service/sts/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/sts/types/errors.go b/service/sts/types/errors.go index 097875b279b..9573a4b6461 100644 --- a/service/sts/types/errors.go +++ b/service/sts/types/errors.go @@ -65,9 +65,10 @@ func (e *IDPCommunicationErrorException) ErrorCode() string { func (e *IDPCommunicationErrorException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The identity provider (IdP) reported that authentication failed. This might be -// because the claim is invalid. If this error is returned for the -// AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired -// or has been explicitly revoked. +// because the claim is invalid. +// +// If this error is returned for the AssumeRoleWithWebIdentity operation, it can +// also mean that the claim has expired or has been explicitly revoked. type IDPRejectedClaimException struct { Message *string @@ -183,11 +184,13 @@ 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) -// in the IAM User Guide. +// limit. For more information, see [Passing Session Tags in STS]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]in the IAM User Guide. +// +// [Passing Session Tags in STS]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html +// [IAM and STS Entity Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-limits-entity-length type PackedPolicyTooLargeException struct { Message *string @@ -215,9 +218,10 @@ func (e *PackedPolicyTooLargeException) ErrorFault() smithy.ErrorFault { return // 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. +// console to activate STS in that region. For more information, see [Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region]in the IAM +// User Guide. +// +// [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 type RegionDisabledException struct { Message *string diff --git a/service/sts/types/types.go b/service/sts/types/types.go index e3701d11d15..dff7a3c2e76 100644 --- a/service/sts/types/types.go +++ b/service/sts/types/types.go @@ -11,10 +11,11 @@ import ( // returns. 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. + // 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]in + // the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. Arn *string @@ -61,8 +62,9 @@ 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]in the IAM User Guide. + // + // [IAM Identifiers]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html // // This member is required. Arn *string @@ -81,9 +83,10 @@ type FederatedUser struct { 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. + // policy for the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]in the Amazon Web + // Services General Reference. + // + // [Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Arn *string noSmithyDocumentSerde @@ -107,23 +110,30 @@ type ProvidedContext struct { // 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. +// tags to control access to resources. For more information, see [Tagging Amazon Web Services STS Sessions]in the IAM User +// Guide. +// +// [Tagging Amazon Web Services STS Sessions]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html 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) - // in the IAM User Guide. + // 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]in the IAM User + // Guide. + // + // [IAM and STS Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length // // This member is required. Key *string - // 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) - // in the IAM User Guide. + // 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]in the IAM User + // Guide. + // + // [IAM and STS Character Limits]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length // // This member is required. Value *string diff --git a/service/supplychain/api_op_CreateBillOfMaterialsImportJob.go b/service/supplychain/api_op_CreateBillOfMaterialsImportJob.go index 5f439f4057e..88a71ef8e9f 100644 --- a/service/supplychain/api_op_CreateBillOfMaterialsImportJob.go +++ b/service/supplychain/api_op_CreateBillOfMaterialsImportJob.go @@ -12,9 +12,11 @@ import ( // CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of // Materials (BOM) entity. For information on the product_bom entity, see the AWS -// Supply Chain User Guide. The CSV file must be located in an Amazon S3 location -// accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 -// bucket created during your AWS Supply Chain instance creation. +// Supply Chain User Guide. +// +// The CSV file must be located in an Amazon S3 location accessible to AWS Supply +// Chain. It is recommended to use the same Amazon S3 bucket created during your +// AWS Supply Chain instance creation. func (c *Client) CreateBillOfMaterialsImportJob(ctx context.Context, params *CreateBillOfMaterialsImportJobInput, optFns ...func(*Options)) (*CreateBillOfMaterialsImportJobOutput, error) { if params == nil { params = &CreateBillOfMaterialsImportJobInput{} diff --git a/service/supplychain/doc.go b/service/supplychain/doc.go index f8f06d87c60..3385f36c5df 100644 --- a/service/supplychain/doc.go +++ b/service/supplychain/doc.go @@ -3,13 +3,16 @@ // Package supplychain provides the API client, operations, and parameter types // for AWS Supply Chain. // -// AWS Supply Chain is a cloud-based application that works with your enterprise +// AWS Supply Chain is a cloud-based application that works with your enterprise +// // resource planning (ERP) and supply chain management systems. Using AWS Supply // Chain, you can connect and extract your inventory, supply, and demand related -// data from existing ERP or supply chain systems into a single data model. The AWS -// Supply Chain API supports configuration data import for Supply Planning. All AWS -// Supply chain 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. +// data from existing ERP or supply chain systems into a single data model. +// +// The AWS Supply Chain API supports configuration data import for Supply Planning. +// +// All AWS Supply chain 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. package supplychain diff --git a/service/supplychain/options.go b/service/supplychain/options.go index 197e9c8a081..af9419bf09b 100644 --- a/service/supplychain/options.go +++ b/service/supplychain/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/supplychain/types/enums.go b/service/supplychain/types/enums.go index a44b560a34e..f99c5adb17f 100644 --- a/service/supplychain/types/enums.go +++ b/service/supplychain/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for ConfigurationJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConfigurationJobStatus) Values() []ConfigurationJobStatus { return []ConfigurationJobStatus{ "NEW", @@ -49,6 +50,7 @@ const ( // Values returns all known values for DataIntegrationEventType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DataIntegrationEventType) Values() []DataIntegrationEventType { return []DataIntegrationEventType{ diff --git a/service/support/api_op_AddAttachmentsToSet.go b/service/support/api_op_AddAttachmentsToSet.go index 5e7494b35d3..bff7115970b 100644 --- a/service/support/api_op_AddAttachmentsToSet.go +++ b/service/support/api_op_AddAttachmentsToSet.go @@ -11,17 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more attachments to an attachment set. An attachment set is a -// 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. +// Adds one or more attachments to an attachment set. +// +// An attachment set is a 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [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{} @@ -40,11 +44,12 @@ func (c *Client) AddAttachmentsToSet(ctx context.Context, params *AddAttachments 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 . + // 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 . // // This member is required. Attachments []types.Attachment @@ -58,8 +63,7 @@ type AddAttachmentsToSetInput struct { noSmithyDocumentSerde } -// The ID and expiry time of the attachment set returned by the AddAttachmentsToSet -// operation. +// The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation. type AddAttachmentsToSetOutput struct { // The ID of the attachment set. If an attachmentSetId was not specified, a new diff --git a/service/support/api_op_AddCommunicationToCase.go b/service/support/api_op_AddCommunicationToCase.go index e826f29bb3c..b547f51b48b 100644 --- a/service/support/api_op_AddCommunicationToCase.go +++ b/service/support/api_op_AddCommunicationToCase.go @@ -15,13 +15,16 @@ import ( // 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [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 f4c59609414..5d6a8263a7f 100644 --- a/service/support/api_op_CreateCase.go +++ b/service/support/api_op_CreateCase.go @@ -11,29 +11,35 @@ import ( ) // Creates a case in the Amazon Web Services Support Center. This operation is -// similar to how you create a case in the Amazon Web Services Support Center -// Create Case (https://console.aws.amazon.com/support/home#/case/create) page. The -// Amazon Web Services Support API doesn't support requesting service limit +// similar to how you create a case in the Amazon Web Services Support Center [Create Case]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]page. +// +// - Use the Service Quotas [RequestServiceQuotaIncrease]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 . +// number. You can use the DescribeCasesoperation and specify the case number to get existing +// Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCaseoperation +// 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]. 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [Create Case]: https://console.aws.amazon.com/support/home#/case/create +// [RequestServiceQuotaIncrease]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html +// [Amazon Web Services Support Center]: https://console.aws.amazon.com/support func (c *Client) CreateCase(ctx context.Context, params *CreateCaseInput, optFns ...func(*Options)) (*CreateCaseOutput, error) { if params == nil { params = &CreateCaseInput{} @@ -52,32 +58,36 @@ 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]page. + // + // [Create Case]: https://console.aws.amazon.com/support/home#/case/create // // 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]page. + // + // [Create Case]: https://console.aws.amazon.com/support/home#/case/create // // 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. + // using the AddAttachmentsToSetoperation. AttachmentSetId *string - // The category of problem for the support case. You also use the DescribeServices - // operation to get the category code for a service. Each Amazon Web Services - // service defines its own set of category codes. + // The category of problem for the support case. You also use the DescribeServices operation to + // get the category code for a service. Each Amazon Web Services service defines + // its own set of category codes. CategoryCode *string // 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]. + // + // [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 . @@ -90,24 +100,26 @@ type CreateCaseInput struct { // parameter if you want support in that language. Language *string - // The code for the Amazon Web Services service. You can use the DescribeServices - // operation to get the possible serviceCode values. + // The code for the Amazon Web Services service. You can use the DescribeServices operation to get + // the possible serviceCode values. ServiceCode *string // 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) - // in the Amazon Web Services Support User Guide. The availability of severity - // levels depends on the support plan for the Amazon Web Services account. + // Support. You can use the DescribeSeverityLevelsoperation to get the possible values for severityCode . + // + // For more information, see SeverityLevel and [Choosing a 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. + // + // [Choosing a Severity]: https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity SeverityCode *string noSmithyDocumentSerde } -// The support case ID returned by a successful completion of the CreateCase -// operation. +// The support case ID returned by a successful completion of the CreateCase operation. type CreateCaseOutput struct { // The support case ID requested or returned in the call. The case ID is an diff --git a/service/support/api_op_DescribeAttachment.go b/service/support/api_op_DescribeAttachment.go index ebe9c4c249e..fa23726b6cf 100644 --- a/service/support/api_op_DescribeAttachment.go +++ b/service/support/api_op_DescribeAttachment.go @@ -14,15 +14,18 @@ import ( // Returns the attachment that has the specified ID. Attachments can include // screenshots, error logs, or other files that describe your issue. Attachment IDs // 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. +// or case communication. Attachment IDs are returned in the AttachmentDetailsobjects that are +// returned by the DescribeCommunicationsoperation. +// // - 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [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{} @@ -40,8 +43,8 @@ func (c *Client) DescribeAttachment(ctx context.Context, params *DescribeAttachm type DescribeAttachmentInput struct { - // The ID of the attachment to return. Attachment IDs are returned by the - // DescribeCommunications operation. + // The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications + // operation. // // This member is required. AttachmentId *string @@ -49,14 +52,14 @@ type DescribeAttachmentInput struct { noSmithyDocumentSerde } -// The content and file name of the attachment returned by the DescribeAttachment -// operation. +// The content and file name of the attachment returned by the DescribeAttachment operation. 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 - // represented as a base64-encoded string. The value for fileName is the name of - // the attachment, such as troubleshoot-screenshot.png . + // 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 represented as a base64-encoded string. The value for fileName + // is the name of 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 1a2eca2e77f..5a295ac97b8 100644 --- a/service/support/api_op_DescribeCases.go +++ b/service/support/api_op_DescribeCases.go @@ -14,22 +14,28 @@ 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: -// - One or more CaseDetails (https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) -// data types. +// parameters to specify how much information to return. +// +// The response returns the following in JSON format: +// +// - One or more [CaseDetails]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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [CaseDetails]: https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html func (c *Client) DescribeCases(ctx context.Context, params *DescribeCasesInput, optFns ...func(*Options)) (*DescribeCasesOutput, error) { if params == nil { params = &DescribeCasesInput{} @@ -86,8 +92,10 @@ type DescribeCasesInput struct { noSmithyDocumentSerde } -// 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. +// Returns an array of [CaseDetails] objects and a nextToken that defines a point for +// pagination in the result set. +// +// [CaseDetails]: https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html type DescribeCasesOutput struct { // The details for the cases that match the request. diff --git a/service/support/api_op_DescribeCommunications.go b/service/support/api_op_DescribeCommunications.go index ab7c8b3dc1c..2392e8a9421 100644 --- a/service/support/api_op_DescribeCommunications.go +++ b/service/support/api_op_DescribeCommunications.go @@ -13,19 +13,24 @@ import ( // Returns communications and attachments for one or more support cases. Use the // afterTime and beforeTime parameters to filter by date. You can use the caseId -// parameter to restrict the results to a specific case. Case data is available for -// 12 months after creation. If a case was created more than 12 months ago, a -// request for data might cause an error. You can use the maxResults and nextToken -// 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. +// parameter to restrict the results to a specific case. +// +// Case data is available for 12 months after creation. If a case was created more +// than 12 months ago, a request for data might cause an error. +// +// You can use the maxResults and nextToken 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [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_DescribeCreateCaseOptions.go b/service/support/api_op_DescribeCreateCaseOptions.go index 42d5ca1c27e..5d495fc932a 100644 --- a/service/support/api_op_DescribeCreateCaseOptions.go +++ b/service/support/api_op_DescribeCreateCaseOptions.go @@ -14,13 +14,16 @@ import ( // Returns a list of CreateCaseOption types along with the corresponding supported // hours and language availability. You can specify the language categoryCode , // issueType and serviceCode used to retrieve the CreateCaseOptions. +// // - 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ func (c *Client) DescribeCreateCaseOptions(ctx context.Context, params *DescribeCreateCaseOptionsInput, optFns ...func(*Options)) (*DescribeCreateCaseOptionsOutput, error) { if params == nil { params = &DescribeCreateCaseOptionsInput{} @@ -38,9 +41,9 @@ func (c *Client) DescribeCreateCaseOptions(ctx context.Context, params *Describe type DescribeCreateCaseOptionsInput struct { - // The category of problem for the support case. You also use the DescribeServices - // operation to get the category code for a service. Each Amazon Web Services - // service defines its own set of category codes. + // The category of problem for the support case. You also use the DescribeServices operation to + // get the category code for a service. Each Amazon Web Services service defines + // its own set of category codes. // // This member is required. CategoryCode *string @@ -59,8 +62,8 @@ type DescribeCreateCaseOptionsInput struct { // This member is required. Language *string - // The code for the Amazon Web Services service. You can use the DescribeServices - // operation to get the possible serviceCode values. + // The code for the Amazon Web Services service. You can use the DescribeServices operation to get + // the possible serviceCode values. // // This member is required. ServiceCode *string @@ -70,13 +73,16 @@ type DescribeCreateCaseOptionsInput struct { type DescribeCreateCaseOptionsOutput struct { - // A JSON-formatted array that contains the available communication type options, + // A JSON-formatted array that contains the available communication type options, // along with the available support timeframes for the given inputs. CommunicationTypes []types.CommunicationTypeOptions // Language availability can be any of the following: + // // - available + // // - best_effort + // // - unavailable LanguageAvailability *string diff --git a/service/support/api_op_DescribeServices.go b/service/support/api_op_DescribeServices.go index 4f405a46acd..4458e809354 100644 --- a/service/support/api_op_DescribeServices.go +++ b/service/support/api_op_DescribeServices.go @@ -12,22 +12,26 @@ import ( ) // Returns the current list of Amazon Web Services services and a list of service -// categories for each service. You then use service names and categories in your -// CreateCase requests. Each Amazon Web Services service has its own set of -// categories. The service codes and category codes correspond to the values that -// appear in the Service and Category lists on the Amazon Web Services Support -// Center Create Case (https://console.aws.amazon.com/support/home#/case/create) -// page. The values in those fields don't necessarily match the service codes and +// categories for each service. You then use service names and categories in your CreateCase +// requests. Each Amazon Web Services service has its own set of categories. +// +// The service codes and category codes correspond to the values that appear in +// the Service and Category lists on the Amazon Web Services Support Center [Create Case]page. +// The values in those fields don't necessarily match the service codes and // 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [Create Case]: https://console.aws.amazon.com/support/home#/case/create func (c *Client) DescribeServices(ctx context.Context, params *DescribeServicesInput, optFns ...func(*Options)) (*DescribeServicesOutput, error) { if params == nil { params = &DescribeServicesInput{} @@ -58,8 +62,7 @@ type DescribeServicesInput struct { noSmithyDocumentSerde } -// The list of Amazon Web Services services returned by the DescribeServices -// operation. +// The list of Amazon Web Services services returned by the DescribeServices operation. type DescribeServicesOutput struct { // A JSON-formatted list of Amazon Web Services services. diff --git a/service/support/api_op_DescribeSeverityLevels.go b/service/support/api_op_DescribeSeverityLevels.go index 059c1db75fb..dd6aa1bcc96 100644 --- a/service/support/api_op_DescribeSeverityLevels.go +++ b/service/support/api_op_DescribeSeverityLevels.go @@ -12,15 +12,18 @@ 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. +// severity level for a case is also a field in the CaseDetailsdata type that you include for +// a CreateCaserequest. +// // - 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [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_DescribeSupportedLanguages.go b/service/support/api_op_DescribeSupportedLanguages.go index 1dedb7878b8..e981660bdb0 100644 --- a/service/support/api_op_DescribeSupportedLanguages.go +++ b/service/support/api_op_DescribeSupportedLanguages.go @@ -14,13 +14,16 @@ import ( // Returns a list of supported languages for a specified categoryCode , issueType // and serviceCode . The returned supported languages will include a ISO 639-1 code // for the language , and the language display name. +// // - 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ func (c *Client) DescribeSupportedLanguages(ctx context.Context, params *DescribeSupportedLanguagesInput, optFns ...func(*Options)) (*DescribeSupportedLanguagesOutput, error) { if params == nil { params = &DescribeSupportedLanguagesInput{} @@ -38,9 +41,9 @@ func (c *Client) DescribeSupportedLanguages(ctx context.Context, params *Describ type DescribeSupportedLanguagesInput struct { - // The category of problem for the support case. You also use the DescribeServices - // operation to get the category code for a service. Each Amazon Web Services - // service defines its own set of category codes. + // The category of problem for the support case. You also use the DescribeServices operation to + // get the category code for a service. Each Amazon Web Services service defines + // its own set of category codes. // // This member is required. CategoryCode *string @@ -50,8 +53,8 @@ type DescribeSupportedLanguagesInput struct { // This member is required. IssueType *string - // The code for the Amazon Web Services service. You can use the DescribeServices - // operation to get the possible serviceCode values. + // The code for the Amazon Web Services service. You can use the DescribeServices operation to get + // the possible serviceCode values. // // This member is required. ServiceCode *string @@ -61,7 +64,7 @@ type DescribeSupportedLanguagesInput struct { type DescribeSupportedLanguagesOutput struct { - // A JSON-formatted array that contains the available ISO 639-1 language codes. + // A JSON-formatted array that contains the available ISO 639-1 language codes. SupportedLanguages []types.SupportedLanguage // Metadata pertaining to the operation's result. diff --git a/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go b/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go index 8b36fe66736..f6b392171ca 100644 --- a/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go +++ b/service/support/api_op_DescribeTrustedAdvisorCheckRefreshStatuses.go @@ -12,24 +12,28 @@ import ( ) // 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. +// specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation. +// +// 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. // // 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. +// more information, see [About the Amazon Web Services Support API]in the Amazon Web Services Support User Guide. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [About the Amazon Web Services Support API]: https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint func (c *Client) DescribeTrustedAdvisorCheckRefreshStatuses(ctx context.Context, params *DescribeTrustedAdvisorCheckRefreshStatusesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckRefreshStatusesOutput, error) { if params == nil { params = &DescribeTrustedAdvisorCheckRefreshStatusesInput{} @@ -47,9 +51,10 @@ func (c *Client) DescribeTrustedAdvisorCheckRefreshStatuses(ctx context.Context, type DescribeTrustedAdvisorCheckRefreshStatusesInput struct { - // The IDs of the Trusted Advisor checks to get the status. If you specify the - // check ID of a check that is automatically refreshed, you might see an - // InvalidParameterValue error. + // The IDs of the Trusted Advisor checks to get the status. + // + // If you specify the check ID of a check that is automatically refreshed, you + // might see an InvalidParameterValue error. // // This member is required. CheckIds []*string @@ -57,8 +62,7 @@ type DescribeTrustedAdvisorCheckRefreshStatusesInput struct { noSmithyDocumentSerde } -// The statuses of the Trusted Advisor checks returned by the -// DescribeTrustedAdvisorCheckRefreshStatuses operation. +// The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation. type DescribeTrustedAdvisorCheckRefreshStatusesOutput struct { // The refresh status of the specified Trusted Advisor checks. diff --git a/service/support/api_op_DescribeTrustedAdvisorCheckResult.go b/service/support/api_op_DescribeTrustedAdvisorCheckResult.go index 2ffc4463b3a..055b7b35517 100644 --- a/service/support/api_op_DescribeTrustedAdvisorCheckResult.go +++ b/service/support/api_op_DescribeTrustedAdvisorCheckResult.go @@ -12,12 +12,15 @@ import ( ) // Returns the results of the Trusted Advisor check that has the specified check -// 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 +// ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation. +// +// The response contains a TrustedAdvisorCheckResult object, which contains these three objects: +// +// # TrustedAdvisorCategorySpecificSummary +// +// # TrustedAdvisorResourceDetail +// +// # TrustedAdvisorResourcesSummary // // In addition, the response contains these fields: // @@ -34,14 +37,15 @@ import ( // - 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. // // 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. +// more information, see [About the Amazon Web Services Support API]in the Amazon Web Services Support User Guide. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [About the Amazon Web Services Support API]: https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint func (c *Client) DescribeTrustedAdvisorCheckResult(ctx context.Context, params *DescribeTrustedAdvisorCheckResultInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckResultOutput, error) { if params == nil { params = &DescribeTrustedAdvisorCheckResultInput{} @@ -65,26 +69,38 @@ type DescribeTrustedAdvisorCheckResultInput struct { CheckId *string // 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: + // 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 Language *string noSmithyDocumentSerde } -// The result of the Trusted Advisor check returned by the -// DescribeTrustedAdvisorCheckResult operation. +// The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation. type DescribeTrustedAdvisorCheckResultOutput struct { // The detailed results of the Trusted Advisor check. diff --git a/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go b/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go index 195cf48ffc2..15532b7e073 100644 --- a/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go +++ b/service/support/api_op_DescribeTrustedAdvisorCheckSummaries.go @@ -12,22 +12,25 @@ import ( ) // Returns the results for the Trusted Advisor check summaries for the check IDs -// that you specified. You can get the check IDs by calling the -// DescribeTrustedAdvisorChecks operation. The response contains an array of -// TrustedAdvisorCheckSummary objects. +// that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation. +// +// 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. // // 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. +// more information, see [About the Amazon Web Services Support API]in the Amazon Web Services Support User Guide. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [About the Amazon Web Services Support API]: https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint func (c *Client) DescribeTrustedAdvisorCheckSummaries(ctx context.Context, params *DescribeTrustedAdvisorCheckSummariesInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorCheckSummariesOutput, error) { if params == nil { params = &DescribeTrustedAdvisorCheckSummariesInput{} @@ -53,8 +56,7 @@ type DescribeTrustedAdvisorCheckSummariesInput struct { noSmithyDocumentSerde } -// The summaries of the Trusted Advisor checks returned by the -// DescribeTrustedAdvisorCheckSummaries operation. +// The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation. type DescribeTrustedAdvisorCheckSummariesOutput struct { // The summary information for the requested Trusted Advisor checks. diff --git a/service/support/api_op_DescribeTrustedAdvisorChecks.go b/service/support/api_op_DescribeTrustedAdvisorChecks.go index f9a0ba818e9..cbe5a51f480 100644 --- a/service/support/api_op_DescribeTrustedAdvisorChecks.go +++ b/service/support/api_op_DescribeTrustedAdvisorChecks.go @@ -13,15 +13,18 @@ import ( // Returns information about all available Trusted Advisor checks, including the // 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. +// +// 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// // - 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. @@ -29,8 +32,10 @@ import ( // 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. +// more information, see [About the Amazon Web Services Support API]in the Amazon Web Services Support User Guide. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [About the Amazon Web Services Support API]: https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint func (c *Client) DescribeTrustedAdvisorChecks(ctx context.Context, params *DescribeTrustedAdvisorChecksInput, optFns ...func(*Options)) (*DescribeTrustedAdvisorChecksOutput, error) { if params == nil { params = &DescribeTrustedAdvisorChecksInput{} @@ -48,19 +53,31 @@ func (c *Client) DescribeTrustedAdvisorChecks(ctx context.Context, params *Descr 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: + // 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 // // This member is required. @@ -69,8 +86,7 @@ type DescribeTrustedAdvisorChecksInput struct { noSmithyDocumentSerde } -// Information about the Trusted Advisor checks returned by the -// DescribeTrustedAdvisorChecks operation. +// Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation. type DescribeTrustedAdvisorChecksOutput struct { // Information about all available Trusted Advisor checks. diff --git a/service/support/api_op_RefreshTrustedAdvisorCheck.go b/service/support/api_op_RefreshTrustedAdvisorCheck.go index dd6eeb3e330..e94535cd2a9 100644 --- a/service/support/api_op_RefreshTrustedAdvisorCheck.go +++ b/service/support/api_op_RefreshTrustedAdvisorCheck.go @@ -12,24 +12,29 @@ import ( ) // Refreshes the Trusted Advisor check that you specify using the check ID. You -// can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. +// can get the check IDs by calling the DescribeTrustedAdvisorChecksoperation. +// // 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. +// 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. // // 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. +// more information, see [About the Amazon Web Services Support API]in the Amazon Web Services Support User Guide. +// +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [About the Amazon Web Services Support API]: https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint func (c *Client) RefreshTrustedAdvisorCheck(ctx context.Context, params *RefreshTrustedAdvisorCheckInput, optFns ...func(*Options)) (*RefreshTrustedAdvisorCheckOutput, error) { if params == nil { params = &RefreshTrustedAdvisorCheckInput{} @@ -47,8 +52,9 @@ func (c *Client) RefreshTrustedAdvisorCheck(ctx context.Context, params *Refresh type RefreshTrustedAdvisorCheckInput struct { - // The unique identifier for the Trusted Advisor check to refresh. Specifying the - // check ID of a check that is automatically refreshed causes an + // The unique identifier for the Trusted Advisor check to refresh. + // + // Specifying the check ID of a check that is automatically refreshed causes an // InvalidParameterValue error. // // This member is required. diff --git a/service/support/api_op_ResolveCase.go b/service/support/api_op_ResolveCase.go index 8bbc9bf400e..8e6cb0f53a3 100644 --- a/service/support/api_op_ResolveCase.go +++ b/service/support/api_op_ResolveCase.go @@ -12,13 +12,16 @@ 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/) -// . +// changing your support plan, see [Amazon Web Services Support]. +// +// [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 703888aad62..27564777a48 100644 --- a/service/support/doc.go +++ b/service/support/doc.go @@ -3,39 +3,50 @@ // 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. +// # 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. +// changing your support plan, see [Amazon Web Services Support]. +// +// You can also use the Amazon Web Services Support API to access features for [Trusted Advisor]. +// 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 ResolveCaseoperations create Amazon Web Services Support cases, retrieve +// information about cases, and resolve cases. +// +// - The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSetoperations retrieve and add communications and attachments to +// Amazon Web Services Support cases. +// +// - The DescribeServicesand DescribeSeverityLevelsoperations 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. +// Advisor operations. For more information, see [Trusted Advisor]in the Amazon Web Services +// Support User Guide. +// +// For authentication of requests, Amazon Web Services Support uses [Signature Version 4 Signing Process]. +// +// For more information about this service and the endpoints to use, see [About the Amazon Web Services Support API] in the +// Amazon Web Services Support User Guide. +// +// [Trusted Advisor]: https://docs.aws.amazon.com/ +// [Amazon Web Services Support]: http://aws.amazon.com/premiumsupport/ +// [About the Amazon Web Services Support API]: https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html +// [Signature Version 4 Signing Process]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html package support diff --git a/service/support/options.go b/service/support/options.go index 69b1659dd46..c83264ac43a 100644 --- a/service/support/options.go +++ b/service/support/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/support/types/errors.go b/service/support/types/errors.go index e8cb52ae5df..55beedbfeb8 100644 --- a/service/support/types/errors.go +++ b/service/support/types/errors.go @@ -192,8 +192,8 @@ func (e *CaseIdNotFound) ErrorCode() string { } func (e *CaseIdNotFound) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The limit for the number of DescribeAttachment requests in a short period of -// time has been exceeded. +// The limit for the number of DescribeAttachment requests in a short period of time has been +// exceeded. type DescribeAttachmentLimitExceeded struct { Message *string @@ -245,7 +245,8 @@ func (e *InternalServerError) ErrorCode() string { } func (e *InternalServerError) ErrorFault() smithy.ErrorFault { return smithy.FaultServer } -// You have exceeded the maximum allowed TPS (Transactions Per Second) for the +// You have exceeded the maximum allowed TPS (Transactions Per Second) for the +// // operations. type ThrottlingException struct { Message *string diff --git a/service/support/types/types.go b/service/support/types/types.go index fa01d844d61..c3e3c0264be 100644 --- a/service/support/types/types.go +++ b/service/support/types/types.go @@ -20,7 +20,7 @@ type Attachment struct { } // The file name and ID of an attachment to a case communication. You can use the -// ID to retrieve the attachment with the DescribeAttachment operation. +// ID to retrieve the attachment with the DescribeAttachmentoperation. type AttachmentDetails struct { // The ID of the attachment. @@ -33,37 +33,55 @@ 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: +// contained in the response from a DescribeCasesrequest. 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 . +// 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 Chinese (“zh”), English // ("en"), Japanese ("ja") and Korean (“ko”). 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 . +// +// - recentCommunications - One or more Communicationobjects. 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 . +// 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 . +// 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 { @@ -94,18 +112,26 @@ 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: + // The status of the case. + // + // Valid values: + // // - opened + // // - pending-customer-action + // // - reopened + // // - resolved + // // - unassigned + // // - work-in-progress Status *string @@ -122,8 +148,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 DescribeServicesresponse for each Amazon Web Services +// service. type Category struct { // The category code for the support case. @@ -166,26 +192,28 @@ type Communication struct { // A JSON-formatted object that contains the CommunicationTypeOptions for creating // a case for a certain communication channel. It is contained in the response from -// a DescribeCreateCaseOptions request. CommunicationTypeOptions contains the -// following fields: +// a DescribeCreateCaseOptionsrequest. CommunicationTypeOptions contains the following fields: +// // - datesWithoutSupport - A JSON-formatted list containing date and time ranges // for periods without support in UTC time. Date and time format is RFC 3339 : // 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. +// // - supportedHours - A JSON-formatted list containing time ranges when support // are available. Time format is RFC 3339 : 'HH:mm:ss.SSS'. +// // - type - A string value indicating the communication type that the // aforementioned rules apply to. At the moment the type value can assume one of 3 // values at the moment chat , web and call . type CommunicationTypeOptions struct { - // A JSON-formatted list containing date and time ranges for periods without + // A JSON-formatted list containing date and time ranges for periods without // support DatesWithoutSupport []DateInterval - // A JSON-formatted list containing time ranges when support is available. + // A JSON-formatted list containing time ranges when support is available. SupportedHours []SupportedHour - // A string value indicating the communication type. At the moment the type value + // A string value indicating the communication type. At the moment the type value // can assume one of 3 values at the moment chat, web and call. Type *string @@ -195,11 +223,11 @@ type CommunicationTypeOptions struct { // Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. type DateInterval struct { - // End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. + // End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. EndDateTime *string - // A JSON object containing start and date time (UTC). Date and time format is RFC - // 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. + // A JSON object containing start and date time (UTC). Date and time format is + // RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'. StartDateTime *string noSmithyDocumentSerde @@ -217,17 +245,16 @@ type RecentCaseCommunications struct { noSmithyDocumentSerde } -// Information about an Amazon Web Services service returned by the -// DescribeServices operation. +// Information about an Amazon Web Services service returned by the DescribeServices operation. 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 - // response. The name element contains the corresponding friendly name. + // The code for an Amazon Web Services service returned by the DescribeServices response. The name + // element contains the corresponding friendly name. Code *string // The friendly name for an Amazon Web Services service. The code element contains @@ -239,26 +266,37 @@ 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) -// in the Amazon Web Services Support User Guide. +// information, see [Choosing a severity]in the Amazon Web Services Support User Guide. +// +// [Choosing a severity]: https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity type SeverityLevel struct { - // The code for case severity level. Valid values: low | normal | high | urgent | - // critical + // The code for case severity level. + // + // Valid values: low | normal | high | urgent | critical Code *string - // 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 + // 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 - // the name appears as General guidance in Support Center. The following are the - // API code names and how they appear in the console: + // 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) - // in the Amazon Web Services Support User Guide. + // + // For more information, see [Choosing a severity] in the Amazon Web Services Support User Guide. + // + // [Choosing a severity]: https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity Name *string noSmithyDocumentSerde @@ -268,27 +306,28 @@ type SeverityLevel struct { // 'HH:mm:ss.SSS' . type SupportedHour struct { - // End Time. RFC 3339 format 'HH:mm:ss.SSS' . + // End Time. RFC 3339 format 'HH:mm:ss.SSS' . EndTime *string - // Start Time. RFC 3339 format 'HH:mm:ss.SSS' . + // Start Time. RFC 3339 format 'HH:mm:ss.SSS' . StartTime *string noSmithyDocumentSerde } -// A JSON-formatted object that contains the available ISO 639-1 language code , +// A JSON-formatted object that contains the available ISO 639-1 language code , +// // language name and langauge display value. The language code is what should be -// used in the CreateCase call. +// used in the CreateCasecall. type SupportedLanguage struct { - // 2 digit ISO 639-1 code. e.g. en + // 2 digit ISO 639-1 code. e.g. en Code *string - // Language display value e.g. ENGLISH + // Language display value e.g. ENGLISH Display *string - // Full language description e.g. ENGLISH + // Full language description e.g. ENGLISH Language *string noSmithyDocumentSerde @@ -326,9 +365,8 @@ 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 TrustedAdvisorResourceDetailfor 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 @@ -356,12 +394,17 @@ type TrustedAdvisorCheckRefreshStatus struct { 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 // // This member is required. @@ -370,8 +413,7 @@ type TrustedAdvisorCheckRefreshStatus struct { noSmithyDocumentSerde } -// The results of a Trusted Advisor check returned by -// DescribeTrustedAdvisorCheckResult . +// The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult. type TrustedAdvisorCheckResult struct { // Summary information that relates to the category of the check. Cost Optimizing @@ -391,7 +433,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 @@ -426,7 +468,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 @@ -471,10 +513,9 @@ type TrustedAdvisorCostOptimizingSummary struct { 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. + // its order can be obtained by inspecting the TrustedAdvisorCheckDescriptionobject 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 @@ -500,7 +541,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_op_CreateSlackChannelConfiguration.go b/service/supportapp/api_op_CreateSlackChannelConfiguration.go index e19421cdb44..46fa8916efc 100644 --- a/service/supportapp/api_op_CreateSlackChannelConfiguration.go +++ b/service/supportapp/api_op_CreateSlackChannelConfiguration.go @@ -12,18 +12,21 @@ 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. // // 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. +// 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{} @@ -47,23 +50,33 @@ type CreateSlackChannelConfigurationInput struct { ChannelId *string // 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) - // in the Amazon Web Services Support User Guide. + // operations on Amazon Web Services. For more information, see [Managing access to the Amazon Web Services Support App]in the Amazon Web + // Services Support User Guide. + // + // [Managing access to the Amazon Web Services Support App]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html // // 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 + // 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 . // // This member is required. diff --git a/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go b/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go index 174140e1ca4..245460982b6 100644 --- a/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go +++ b/service/supportapp/api_op_RegisterSlackWorkspaceForOrganization.go @@ -12,30 +12,36 @@ import ( ) // Registers a Slack workspace for your Amazon Web Services account. To call this -// 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. +// 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]and authorize the Slack workspaces where you want your +// organization to have access to. See [Authorize a Slack workspace]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: +// through the [Amazon Web Services Support Center]. +// +// 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) -// . +// permission. For more information, see [Managing access to the Amazon Web Services Support App]. +// // - 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) -// . +// support cases for that account. For more information, see [Configuring a Slack channel]. +// +// [Authorize a Slack workspace]: https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html +// [Managing access to the Amazon Web Services Support App]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html +// [Amazon Web Services Support Center]: https://console.aws.amazon.com/support/app +// [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{} diff --git a/service/supportapp/api_op_UpdateSlackChannelConfiguration.go b/service/supportapp/api_op_UpdateSlackChannelConfiguration.go index d22513c88f5..4afcdecfb66 100644 --- a/service/supportapp/api_op_UpdateSlackChannelConfiguration.go +++ b/service/supportapp/api_op_UpdateSlackChannelConfiguration.go @@ -45,25 +45,35 @@ type UpdateSlackChannelConfigurationInput struct { ChannelName *string // 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) - // in the Amazon Web Services Support User Guide. + // operations on Amazon Web Services. For more information, see [Managing access to the Amazon Web Services Support App]in the Amazon Web + // Services Support User Guide. + // + // [Managing access to the Amazon Web Services Support App]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html ChannelRoleArn *string // Whether you want to get notified when a support case has a new correspondence. 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 - // : + // 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. NotifyOnCaseSeverity types.NotificationSeverityLevel @@ -87,9 +97,10 @@ type UpdateSlackChannelConfigurationOutput struct { ChannelName *string // 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) - // in the Amazon Web Services Support User Guide. + // operations on Amazon Web Services. For more information, see [Managing access to the Amazon Web Services Support App]in the Amazon Web + // Services Support User Guide. + // + // [Managing access to the Amazon Web Services Support App]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html ChannelRoleArn *string // Whether you want to get notified when a support case has a new correspondence. diff --git a/service/supportapp/doc.go b/service/supportapp/doc.go index cbb96157c56..929e9412db1 100644 --- a/service/supportapp/doc.go +++ b/service/supportapp/doc.go @@ -3,31 +3,45 @@ // Package supportapp provides the API client, operations, and parameter types for // AWS Support App. // -// Amazon Web Services Support App in Slack You can use the Amazon Web Services -// Support App in Slack API to manage your support cases in Slack for your Amazon -// 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: +// # Amazon Web Services Support App in Slack +// +// You can use the Amazon Web Services Support App in Slack API to manage your +// support cases in Slack for your Amazon 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) +// +// [Amazon Web Services Support App in Slack] +// +// [Joining a live chat session with Amazon Web Services Support] +// +// [Requesting service quota increases] +// +// [Amazon Web Services Support App commands in Slack] // // 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) -// . +// more information, see [Authorize a Slack workspace to enable the Amazon Web Services Support App]. +// // - 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. +// see the [Amazon Web Services Support App in Slack endpoints]in the Amazon Web Services General Reference. +// +// [Requesting service quota increases]: https://docs.aws.amazon.com/awssupport/latest/user/service-quota-increase.html +// [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 +// [Amazon Web Services Support App in Slack endpoints]: https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region +// [Amazon Web Services Support App commands in Slack]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-commands.html +// [Authorize a Slack workspace to enable the Amazon Web Services Support App]: https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html package supportapp diff --git a/service/supportapp/options.go b/service/supportapp/options.go index 673b81f421e..6765d831065 100644 --- a/service/supportapp/options.go +++ b/service/supportapp/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/supportapp/types/enums.go b/service/supportapp/types/enums.go index bfafb4e23b7..e92bd3e30a0 100644 --- a/service/supportapp/types/enums.go +++ b/service/supportapp/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccountType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountType) Values() []AccountType { return []AccountType{ "management", @@ -31,6 +32,7 @@ const ( // Values returns all known values for NotificationSeverityLevel. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (NotificationSeverityLevel) Values() []NotificationSeverityLevel { return []NotificationSeverityLevel{ diff --git a/service/supportapp/types/errors.go b/service/supportapp/types/errors.go index c081e40de69..f83403d914b 100644 --- a/service/supportapp/types/errors.go +++ b/service/supportapp/types/errors.go @@ -35,15 +35,21 @@ 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. diff --git a/service/supportapp/types/types.go b/service/supportapp/types/types.go index 7f18fd92095..368b74f453b 100644 --- a/service/supportapp/types/types.go +++ b/service/supportapp/types/types.go @@ -26,9 +26,10 @@ type SlackChannelConfiguration struct { ChannelName *string // 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) - // in the Amazon Web Services Support User Guide. + // operations on Amazon Web Services. For more information, see [Managing access to the Amazon Web Services Support App]in the Amazon Web + // Services Support User Guide. + // + // [Managing access to the Amazon Web Services Support App]: https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html ChannelRoleArn *string // Whether you want to get notified when a support case has a new correspondence. diff --git a/service/swf/api_op_CountClosedWorkflowExecutions.go b/service/swf/api_op_CountClosedWorkflowExecutions.go index 9a65762db66..ffb30b46e7b 100644 --- a/service/swf/api_op_CountClosedWorkflowExecutions.go +++ b/service/swf/api_op_CountClosedWorkflowExecutions.go @@ -12,25 +12,36 @@ import ( ) // Returns the number of closed 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: +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) CountClosedWorkflowExecutions(ctx context.Context, params *CountClosedWorkflowExecutionsInput, optFns ...func(*Options)) (*CountClosedWorkflowExecutionsOutput, error) { if params == nil { params = &CountClosedWorkflowExecutionsInput{} @@ -55,31 +66,42 @@ type CountClosedWorkflowExecutionsInput struct { // 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. + // 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 - // filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. - // You must specify one of these in a request but not both. + // filter are counted. + // + // 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 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. + // are counted. + // + // closeStatusFilter , executionFilter , typeFilter and tagFilter are mutually + // exclusive. You can specify at most one of these in a request. ExecutionFilter *types.WorkflowExecutionFilter // If specified, only workflow executions that meet the start time criteria of the - // filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. - // You must specify one of these in a request but not both. + // filter are counted. + // + // 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 a tag that matches the filter are - // counted. closeStatusFilter , executionFilter , typeFilter and tagFilter are - // mutually exclusive. You can specify at most one of these in a request. + // 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 // exclusive. You can specify at most one of these in a request. TypeFilter *types.WorkflowTypeFilter @@ -87,8 +109,7 @@ type CountClosedWorkflowExecutionsInput struct { noSmithyDocumentSerde } -// Contains the count of workflow executions returned from -// CountOpenWorkflowExecutions or CountClosedWorkflowExecutions +// Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions type CountClosedWorkflowExecutionsOutput struct { // The number of workflow executions. diff --git a/service/swf/api_op_CountOpenWorkflowExecutions.go b/service/swf/api_op_CountOpenWorkflowExecutions.go index 89620ccd972..eadef499848 100644 --- a/service/swf/api_op_CountOpenWorkflowExecutions.go +++ b/service/swf/api_op_CountOpenWorkflowExecutions.go @@ -12,25 +12,36 @@ import ( ) // 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: +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) CountOpenWorkflowExecutions(ctx context.Context, params *CountOpenWorkflowExecutionsInput, optFns ...func(*Options)) (*CountOpenWorkflowExecutionsOutput, error) { if params == nil { params = &CountOpenWorkflowExecutionsInput{} @@ -60,25 +71,29 @@ type CountOpenWorkflowExecutionsInput struct { 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. + // 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 - // can specify at most one of these in a request. + // 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 , - // typeFilter and tagFilter are mutually exclusive. You can specify at most one of - // these in a request. + // 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 noSmithyDocumentSerde } -// Contains the count of workflow executions returned from -// CountOpenWorkflowExecutions or CountClosedWorkflowExecutions +// Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions type CountOpenWorkflowExecutionsOutput struct { // The number of workflow executions. diff --git a/service/swf/api_op_CountPendingActivityTasks.go b/service/swf/api_op_CountPendingActivityTasks.go index e709f8ce085..63b7f9fe1a2 100644 --- a/service/swf/api_op_CountPendingActivityTasks.go +++ b/service/swf/api_op_CountPendingActivityTasks.go @@ -14,20 +14,27 @@ import ( // Returns the estimated number of activity tasks in the specified task list. The // count returned is an approximation and isn't guaranteed to be exact. If you // 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) CountPendingActivityTasks(ctx context.Context, params *CountPendingActivityTasksInput, optFns ...func(*Options)) (*CountPendingActivityTasksOutput, error) { if params == nil { params = &CountPendingActivityTasksInput{} diff --git a/service/swf/api_op_CountPendingDecisionTasks.go b/service/swf/api_op_CountPendingDecisionTasks.go index 19fc0fa67df..f39f2c87598 100644 --- a/service/swf/api_op_CountPendingDecisionTasks.go +++ b/service/swf/api_op_CountPendingDecisionTasks.go @@ -14,20 +14,27 @@ import ( // Returns the estimated number of decision tasks in the specified task list. The // count returned is an approximation and isn't guaranteed to be exact. If you // 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) CountPendingDecisionTasks(ctx context.Context, params *CountPendingDecisionTasksInput, optFns ...func(*Options)) (*CountPendingDecisionTasksOutput, error) { if params == nil { params = &CountPendingDecisionTasksInput{} diff --git a/service/swf/api_op_DeprecateActivityType.go b/service/swf/api_op_DeprecateActivityType.go index 57114422756..de1d9dc4bbf 100644 --- a/service/swf/api_op_DeprecateActivityType.go +++ b/service/swf/api_op_DeprecateActivityType.go @@ -13,25 +13,35 @@ import ( // Deprecates the specified activity type. After an activity type has been // deprecated, you cannot create new tasks of that activity type. Tasks of this -// type that were scheduled before the type was deprecated continue 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: +// type that were scheduled before the type was deprecated continue 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. +// // - 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DeprecateActivityType(ctx context.Context, params *DeprecateActivityTypeInput, optFns ...func(*Options)) (*DeprecateActivityTypeOutput, error) { if params == nil { params = &DeprecateActivityTypeInput{} diff --git a/service/swf/api_op_DeprecateDomain.go b/service/swf/api_op_DeprecateDomain.go index 27d21657cbf..63748166fcd 100644 --- a/service/swf/api_op_DeprecateDomain.go +++ b/service/swf/api_op_DeprecateDomain.go @@ -14,21 +14,29 @@ import ( // 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DeprecateDomain(ctx context.Context, params *DeprecateDomainInput, optFns ...func(*Options)) (*DeprecateDomainOutput, error) { if params == nil { params = &DeprecateDomainInput{} diff --git a/service/swf/api_op_DeprecateWorkflowType.go b/service/swf/api_op_DeprecateWorkflowType.go index 6281311ed5e..fb5dd295145 100644 --- a/service/swf/api_op_DeprecateWorkflowType.go +++ b/service/swf/api_op_DeprecateWorkflowType.go @@ -14,25 +14,35 @@ import ( // Deprecates the specified workflow type. After a workflow type has been // deprecated, you cannot create new executions of that type. Executions that were // started before the type was deprecated continues to run. A deprecated workflow -// type may still be used when calling visibility actions. 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: +// type may still be used when calling visibility actions. +// +// 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. +// // - 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DeprecateWorkflowType(ctx context.Context, params *DeprecateWorkflowTypeInput, optFns ...func(*Options)) (*DeprecateWorkflowTypeOutput, error) { if params == nil { params = &DeprecateWorkflowTypeInput{} diff --git a/service/swf/api_op_DescribeActivityType.go b/service/swf/api_op_DescribeActivityType.go index 718e80bc3b0..1295e26e002 100644 --- a/service/swf/api_op_DescribeActivityType.go +++ b/service/swf/api_op_DescribeActivityType.go @@ -13,23 +13,32 @@ import ( // Returns information about the specified activity type. This includes // 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: +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DescribeActivityType(ctx context.Context, params *DescribeActivityTypeInput, optFns ...func(*Options)) (*DescribeActivityTypeOutput, error) { if params == nil { params = &DescribeActivityTypeInput{} @@ -69,13 +78,17 @@ type DescribeActivityTypeOutput struct { // This member is required. Configuration *types.ActivityTypeConfiguration - // General information about the activity type. The status of activity type - // (returned in the ActivityTypeInfo structure) can be one of the following. + // 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. + // + // - 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 cedaf87de7f..e3c6ddd9941 100644 --- a/service/swf/api_op_DescribeDomain.go +++ b/service/swf/api_op_DescribeDomain.go @@ -12,19 +12,26 @@ 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error) { if params == nil { params = &DescribeDomainInput{} diff --git a/service/swf/api_op_DescribeWorkflowExecution.go b/service/swf/api_op_DescribeWorkflowExecution.go index acf836b55de..f5defb5c77a 100644 --- a/service/swf/api_op_DescribeWorkflowExecution.go +++ b/service/swf/api_op_DescribeWorkflowExecution.go @@ -13,21 +13,29 @@ import ( ) // Returns information about the specified workflow execution including its type -// and some statistics. 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 +// and some statistics. +// +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DescribeWorkflowExecution(ctx context.Context, params *DescribeWorkflowExecutionInput, optFns ...func(*Options)) (*DescribeWorkflowExecutionOutput, error) { if params == nil { params = &DescribeWorkflowExecutionInput{} @@ -85,7 +93,7 @@ type DescribeWorkflowExecutionOutput struct { // 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 . + // 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 61af3d6afe7..c87cc3aaa4b 100644 --- a/service/swf/api_op_DescribeWorkflowType.go +++ b/service/swf/api_op_DescribeWorkflowType.go @@ -13,24 +13,32 @@ import ( // Returns information about the specified workflow type. This includes // configuration settings specified when the type was registered and other -// 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: +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) DescribeWorkflowType(ctx context.Context, params *DescribeWorkflowTypeInput, optFns ...func(*Options)) (*DescribeWorkflowTypeOutput, error) { if params == nil { params = &DescribeWorkflowTypeInput{} @@ -64,19 +72,22 @@ type DescribeWorkflowTypeInput struct { // Contains details about a workflow type. type DescribeWorkflowTypeOutput struct { - // Configuration settings of the workflow type registered through - // RegisterWorkflowType + // Configuration settings of the workflow type registered through RegisterWorkflowType // // This member is required. Configuration *types.WorkflowTypeConfiguration - // General information about the workflow type. The status of the workflow type - // (returned in the WorkflowTypeInfo structure) can be one of the following. + // 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. + // + // - 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 7c58cc61337..108e7e30640 100644 --- a/service/swf/api_op_GetWorkflowExecutionHistory.go +++ b/service/swf/api_op_GetWorkflowExecutionHistory.go @@ -13,21 +13,29 @@ import ( // Returns the history of the specified workflow execution. 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: +// 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. +// // - 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) GetWorkflowExecutionHistory(ctx context.Context, params *GetWorkflowExecutionHistoryInput, optFns ...func(*Options)) (*GetWorkflowExecutionHistoryOutput, error) { if params == nil { params = &GetWorkflowExecutionHistoryInput{} @@ -64,8 +72,10 @@ type GetWorkflowExecutionHistoryInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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. + // 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 @@ -87,8 +97,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 464d86b44b5..fd9b1413f4d 100644 --- a/service/swf/api_op_ListActivityTypes.go +++ b/service/swf/api_op_ListActivityTypes.go @@ -15,20 +15,26 @@ import ( // 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) ListActivityTypes(ctx context.Context, params *ListActivityTypesInput, optFns ...func(*Options)) (*ListActivityTypesOutput, error) { if params == nil { params = &ListActivityTypesInput{} @@ -68,8 +74,10 @@ type ListActivityTypesInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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. + // 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 @@ -89,8 +97,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 df4a42da379..1820e5c9aee 100644 --- a/service/swf/api_op_ListClosedWorkflowExecutions.go +++ b/service/swf/api_op_ListClosedWorkflowExecutions.go @@ -14,25 +14,36 @@ import ( // Returns a list of closed 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 +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) ListClosedWorkflowExecutions(ctx context.Context, params *ListClosedWorkflowExecutionsInput, optFns ...func(*Options)) (*ListClosedWorkflowExecutionsOutput, error) { if params == nil { params = &ListClosedWorkflowExecutionsInput{} @@ -57,22 +68,26 @@ 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 - // tagFilter are mutually exclusive. You can specify at most one of these in a - // request. + // 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. + // 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 - // tagFilter are mutually exclusive. You can specify at most one of these in a - // request. + // 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 // The maximum number of results that are returned per call. Use nextPageToken to @@ -84,8 +99,10 @@ type ListClosedWorkflowExecutionsInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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. + // 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 @@ -96,16 +113,20 @@ type ListClosedWorkflowExecutionsInput struct { // 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. + // 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 // 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 // exclusive. You can specify at most one of these in a request. TypeFilter *types.WorkflowTypeFilter @@ -123,8 +144,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 47f6906ef97..400faaa43df 100644 --- a/service/swf/api_op_ListDomains.go +++ b/service/swf/api_op_ListDomains.go @@ -13,22 +13,30 @@ import ( // Returns the list of domains registered in the account. 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: +// 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. 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error) { if params == nil { params = &ListDomainsInput{} @@ -60,8 +68,10 @@ type ListDomainsInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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. + // 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 @@ -81,8 +91,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 d5c59740da5..6625ddc44de 100644 --- a/service/swf/api_op_ListOpenWorkflowExecutions.go +++ b/service/swf/api_op_ListOpenWorkflowExecutions.go @@ -14,25 +14,36 @@ import ( // 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 +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) ListOpenWorkflowExecutions(ctx context.Context, params *ListOpenWorkflowExecutionsInput, optFns ...func(*Options)) (*ListOpenWorkflowExecutionsOutput, error) { if params == nil { params = &ListOpenWorkflowExecutionsInput{} @@ -62,8 +73,10 @@ type ListOpenWorkflowExecutionsInput struct { 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. + // 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 @@ -75,8 +88,10 @@ type ListOpenWorkflowExecutionsInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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. + // 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 @@ -84,11 +99,13 @@ type ListOpenWorkflowExecutionsInput struct { ReverseOrder bool // If specified, only executions that have the matching tag are listed. + // // 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 // specify at most one of these in a request. TypeFilter *types.WorkflowTypeFilter @@ -106,8 +123,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 afbb9c2cd9a..f8ee79bd748 100644 --- a/service/swf/api_op_ListWorkflowTypes.go +++ b/service/swf/api_op_ListWorkflowTypes.go @@ -13,19 +13,26 @@ import ( // Returns information about workflow types in the specified domain. The results // 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) ListWorkflowTypes(ctx context.Context, params *ListWorkflowTypesInput, optFns ...func(*Options)) (*ListWorkflowTypesOutput, error) { if params == nil { params = &ListWorkflowTypesInput{} @@ -65,8 +72,10 @@ type ListWorkflowTypesInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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. + // 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 @@ -86,8 +95,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 747c715209d..73994296b67 100644 --- a/service/swf/api_op_PollForActivityTask.go +++ b/service/swf/api_op_PollForActivityTask.go @@ -11,29 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// within 60 seconds, the poll returns an empty result. An empty result, in this -// context, means that an ActivityTask is returned, but that the value of taskToken -// is an empty string. If a task is returned, the worker should use its type to -// identify and process it correctly. Workers should set their client side socket -// 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: +// 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 within 60 +// seconds, the poll returns an empty result. An empty result, in this context, +// means that an ActivityTask is returned, but that the value of taskToken is an +// empty string. If a task is returned, the worker should use its type to identify +// and process it correctly. +// +// Workers should set their client side socket 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) PollForActivityTask(ctx context.Context, params *PollForActivityTaskInput, optFns ...func(*Options)) (*PollForActivityTaskOutput, error) { if params == nil { params = &PollForActivityTaskInput{} @@ -56,10 +64,11 @@ type PollForActivityTaskInput struct { // This member is required. Domain *string - // 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 . + // 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 . // // This member is required. TaskList *types.TaskList diff --git a/service/swf/api_op_PollForDecisionTask.go b/service/swf/api_op_PollForDecisionTask.go index 000eb701cdc..199bb7f8966 100644 --- a/service/swf/api_op_PollForDecisionTask.go +++ b/service/swf/api_op_PollForDecisionTask.go @@ -11,36 +11,47 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// determine how to properly handle the task. This action initiates a long poll, -// where the service holds the HTTP connection open and responds as soon a task -// becomes available. If no decision task is available in the specified task list -// before the timeout of 60 seconds expires, an empty result is returned. An empty -// result, in this context, means that a DecisionTask is returned, but that the -// value of taskToken is an empty string. Deciders should set their client side -// socket timeout to at least 70 seconds (10 seconds higher than the timeout). +// 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 determine +// how to properly handle the task. +// +// This action initiates a long poll, where the service holds the HTTP connection +// open and responds as soon a task becomes available. If no decision task is +// available in the specified task list before the timeout of 60 seconds expires, +// an empty result is returned. An empty result, in this context, means that a +// DecisionTask is returned, but that the value of taskToken is an empty string. +// +// Deciders should set their client side socket timeout to at least 70 seconds (10 +// seconds higher than the timeout). +// // Because the number of workflow history events for a single workflow execution // 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: +// 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) PollForDecisionTask(ctx context.Context, params *PollForDecisionTaskInput, optFns ...func(*Options)) (*PollForDecisionTaskOutput, error) { if params == nil { params = &PollForDecisionTaskInput{} @@ -63,9 +74,11 @@ type PollForDecisionTaskInput struct { // This member is required. Domain *string - // Specifies the task list to poll for decision tasks. The specified string 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 . + // Specifies the task list to poll for decision tasks. + // + // The specified string 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. TaskList *types.TaskList @@ -76,8 +89,10 @@ type PollForDecisionTaskInput struct { Identity *string // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. This is an upper limit only; the actual number - // of results returned per call may be fewer than the specified maximum. + // obtain further pages of results. + // + // This is an upper limit only; the actual number of results returned per call may + // be fewer than the specified maximum. MaximumPageSize int32 // If NextPageToken is returned there are more results available. The value of @@ -85,12 +100,15 @@ type PollForDecisionTaskInput struct { // using the returned token to retrieve the next page. Keep all other arguments // unchanged. Each pagination token expires after 24 hours. Using an expired // 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 - // page of history records. Calling PollForDecisionTask with a nextPageToken - // doesn't return a new decision task. + // 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 PollForDecisionTaskagain (with the nextPageToken ) to retrieve the next page of + // history records. Calling PollForDecisionTaskwith 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 @@ -139,8 +157,9 @@ 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 - // configured maximumPageSize determines how many results can be returned in a + // 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 @@ -247,8 +266,10 @@ var _ PollForDecisionTaskAPIClient = (*Client)(nil) // PollForDecisionTask type PollForDecisionTaskPaginatorOptions struct { // The maximum number of results that are returned per call. Use nextPageToken to - // obtain further pages of results. This is an upper limit only; the actual number - // of results returned per call may be fewer than the specified maximum. + // obtain further pages of results. + // + // This is an upper limit only; the actual number of results returned per call may + // be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/swf/api_op_RecordActivityTaskHeartbeat.go b/service/swf/api_op_RecordActivityTaskHeartbeat.go index 1cd7847147d..b9e971f1f52 100644 --- a/service/swf/api_op_RecordActivityTaskHeartbeat.go +++ b/service/swf/api_op_RecordActivityTaskHeartbeat.go @@ -10,39 +10,51 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by activity workers to report to the service that the ActivityTask -// represented by the specified taskToken is still making progress. The worker can -// also specify details of the progress, for example percent complete, using the -// 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 -// the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in -// 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 -// worker can cancel the activity, it should respond with -// 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: +// Used by activity workers to report to the service that the ActivityTask represented by the +// specified taskToken is still making progress. The worker can also specify +// details of the progress, for example percent complete, using the 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 the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is +// specified in 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 RecordActivityTaskHeartbeatrequests 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 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RecordActivityTaskHeartbeat(ctx context.Context, params *RecordActivityTaskHeartbeatInput, optFns ...func(*Options)) (*RecordActivityTaskHeartbeatOutput, error) { if params == nil { params = &RecordActivityTaskHeartbeatInput{} @@ -60,10 +72,11 @@ func (c *Client) RecordActivityTaskHeartbeat(ctx context.Context, params *Record type RecordActivityTaskHeartbeatInput struct { - // 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. + // 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. // // This member is required. TaskToken *string diff --git a/service/swf/api_op_RegisterActivityType.go b/service/swf/api_op_RegisterActivityType.go index b98c71be21c..ce62b48a8d7 100644 --- a/service/swf/api_op_RegisterActivityType.go +++ b/service/swf/api_op_RegisterActivityType.go @@ -12,27 +12,38 @@ import ( ) // Registers a new activity type along with its configuration settings in the -// specified domain. A TypeAlreadyExists fault is returned if the type already -// exists in the domain. You cannot change any configuration settings of the type -// 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 +// specified domain. +// +// A TypeAlreadyExists fault is returned if the type already exists in the domain. +// You cannot change any configuration settings of the type 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RegisterActivityType(ctx context.Context, params *RegisterActivityTypeInput, optFns ...func(*Options)) (*RegisterActivityTypeOutput, error) { if params == nil { params = &RegisterActivityTypeInput{} @@ -55,65 +66,78 @@ type RegisterActivityTypeInput struct { // This member is required. Domain *string - // The name of the activity type within the domain. The specified string 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 . + // The name of the activity type within the domain. + // + // The specified string 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 - // 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 contain a : (colon), / (slash), | (vertical bar), or - // any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not be - // the literal string arn . + // 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 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 // If set, specifies the default maximum time before which a worker processing a - // 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 - // 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. + // 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 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 // 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 ScheduleActivityTask Decision . + // a task is scheduled through the ScheduleActivityTaskDecision . 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) - // in the in the Amazon SWF Developer Guide.. + // priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the in the Amazon SWF + // Developer Guide.. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 - // ScheduleActivityTask Decision . The duration is specified in seconds, an integer - // greater than or equal to 0 . You can use NONE to specify unlimited duration. + // ScheduleActivityTaskDecision . + // + // 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 ScheduleActivityTask Decision . The - // duration is specified in seconds, an integer greater than or equal to 0 . You - // can use NONE to specify unlimited duration. + // 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. 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 ScheduleActivityTask Decision . The - // duration is specified in seconds, an integer greater than or equal to 0 . You - // can use NONE to specify unlimited duration. + // 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. 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 ff7b84d9d71..6c89f4fd37b 100644 --- a/service/swf/api_op_RegisterDomain.go +++ b/service/swf/api_op_RegisterDomain.go @@ -11,8 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Registers a new domain. Access Control You can use IAM policies to control this -// action's access to Amazon SWF resources as follows: +// 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. @@ -24,9 +28,9 @@ import ( // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput, optFns ...func(*Options)) (*RegisterDomainOutput, error) { if params == nil { params = &RegisterDomainInput{} @@ -45,22 +49,28 @@ func (c *Client) RegisterDomain(ctx context.Context, params *RegisterDomainInput 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 . + // 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 . // // This member is required. Name *string // The duration (in days) that records and histories of workflow executions on the // domain should be kept by the service. After the retention period, the workflow - // execution isn't available in the results of visibility calls. If you pass the - // 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) - // in the Amazon SWF Developer Guide. + // execution isn't available in the results of visibility calls. + // + // If you pass the 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]in the Amazon SWF Developer + // Guide. + // + // [Amazon SWF Service Limits]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html // // This member is required. WorkflowExecutionRetentionPeriodInDays *string @@ -68,8 +78,10 @@ type RegisterDomainInput struct { // A text description of the domain. Description *string - // Tags to be added when registering a domain. Tags may only contain unicode - // letters, digits, whitespace, or these symbols: _ . : / = + - @ . + // Tags to be added when registering a domain. + // + // Tags may only contain unicode 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 312a91a5501..ce5aefb0e2b 100644 --- a/service/swf/api_op_RegisterWorkflowType.go +++ b/service/swf/api_op_RegisterWorkflowType.go @@ -12,28 +12,40 @@ import ( ) // Registers a new workflow type and its configuration settings in the specified -// domain. The retention period for the workflow history is set by the -// RegisterDomain action. If the type already exists, then a TypeAlreadyExists -// fault is returned. You cannot change the configuration settings of a workflow -// 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 +// domain. +// +// The retention period for the workflow history is set by the RegisterDomain action. +// +// If the type already exists, then a TypeAlreadyExists fault is returned. You +// cannot change the configuration settings of a workflow 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RegisterWorkflowType(ctx context.Context, params *RegisterWorkflowTypeInput, optFns ...func(*Options)) (*RegisterWorkflowTypeOutput, error) { if params == nil { params = &RegisterWorkflowTypeInput{} @@ -56,74 +68,90 @@ type RegisterWorkflowTypeInput struct { // This member is required. Domain *string - // The name of the workflow type. The specified string 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 . + // The name of the workflow type. + // + // The specified string 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 - // The version of the workflow type. The workflow type consists of the name and - // 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 contain a : (colon), / (slash), | - // (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). - // Also, it must not be the literal string arn . + // The version of the workflow type. + // + // The workflow type consists of the name and version, the combination of which + // must be unique within the domain. To get a list of all currently registered + // workflow types, use the ListWorkflowTypesaction. + // + // The specified string 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. Version *string // If set, specifies the default policy to use for the child workflow executions - // 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 StartChildWorkflowExecution Decision . The - // supported child policies are: + // when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecutionaction + // explicitly or due to an expired timeout. This default can be overridden when + // starting a workflow execution using the StartWorkflowExecutionaction 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. 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 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 - // causes the workflow execution to time out. + // type. You can override this default when starting an execution through the StartWorkflowExecution + // Action or StartChildWorkflowExecutionDecision . + // + // 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 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html 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 StartChildWorkflowExecution Decision . + // isn't provided when starting the execution through the StartWorkflowExecutionAction or + // StartChildWorkflowExecutionDecision . 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) - // in the Amazon SWF Developer Guide. + // priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 StartChildWorkflowExecution - // Decision . The duration is specified in seconds, an integer greater than or - // equal to 0 . You can use NONE to specify unlimited duration. + // using the StartWorkflowExecutionaction 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. 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 22a8e075bb6..58cf2260085 100644 --- a/service/swf/api_op_RequestCancelWorkflowExecution.go +++ b/service/swf/api_op_RequestCancelWorkflowExecution.go @@ -14,24 +14,33 @@ import ( // workflow execution identified by the given domain, workflowId, and runId. This // logically requests the cancellation of the workflow execution as a whole. It is // up to the decider to take appropriate actions when it receives an execution -// history with this event. If the runId isn't specified, the -// WorkflowExecutionCancelRequested event is recorded in the history of the current -// open workflow execution with the specified workflowId in the domain. Because -// this action allows the workflow to properly clean up and gracefully close, it -// should be used instead of TerminateWorkflowExecution when possible. Access -// Control You can use IAM policies to control this action's access to Amazon SWF +// history with this event. +// +// If the runId isn't specified, the WorkflowExecutionCancelRequested event is +// recorded in the history of the current open workflow execution with the +// specified workflowId in the domain. +// +// Because this action allows the workflow to properly clean up and gracefully +// close, it should be used instead of TerminateWorkflowExecutionwhen 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RequestCancelWorkflowExecution(ctx context.Context, params *RequestCancelWorkflowExecutionInput, optFns ...func(*Options)) (*RequestCancelWorkflowExecutionOutput, error) { if params == nil { params = &RequestCancelWorkflowExecutionInput{} diff --git a/service/swf/api_op_RespondActivityTaskCanceled.go b/service/swf/api_op_RespondActivityTaskCanceled.go index 46d967b6511..9ba8d76aad0 100644 --- a/service/swf/api_op_RespondActivityTaskCanceled.go +++ b/service/swf/api_op_RespondActivityTaskCanceled.go @@ -10,30 +10,40 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by workers to tell the service that the ActivityTask identified by the -// taskToken was successfully canceled. Additional details can be provided using -// the details argument. These details (if provided) appear in the -// ActivityTaskCanceled event added to the workflow history. Only use this -// operation if the canceled flag of a RecordActivityTaskHeartbeat request returns -// 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 -// Amazon SWF resources as follows: +// Used by workers to tell the service that the ActivityTask identified by the taskToken was +// successfully canceled. Additional details can be provided using the details +// argument. +// +// These details (if provided) appear in the ActivityTaskCanceled event added to +// the workflow history. +// +// Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns 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]. +// +// # 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [timed out]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RespondActivityTaskCanceled(ctx context.Context, params *RespondActivityTaskCanceledInput, optFns ...func(*Options)) (*RespondActivityTaskCanceledOutput, error) { if params == nil { params = &RespondActivityTaskCanceledInput{} @@ -51,15 +61,16 @@ func (c *Client) RespondActivityTaskCanceled(ctx context.Context, params *Respon type RespondActivityTaskCanceledInput struct { - // 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. + // 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. // // This member is required. TaskToken *string - // Information about the cancellation. + // Information about the cancellation. Details *string noSmithyDocumentSerde diff --git a/service/swf/api_op_RespondActivityTaskCompleted.go b/service/swf/api_op_RespondActivityTaskCompleted.go index 7d058a3d9d2..1f7e9a52f5b 100644 --- a/service/swf/api_op_RespondActivityTaskCompleted.go +++ b/service/swf/api_op_RespondActivityTaskCompleted.go @@ -10,30 +10,38 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// Amazon SWF resources as follows: +// 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]. +// +// # 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [timed out]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RespondActivityTaskCompleted(ctx context.Context, params *RespondActivityTaskCompletedInput, optFns ...func(*Options)) (*RespondActivityTaskCompletedOutput, error) { if params == nil { params = &RespondActivityTaskCompletedInput{} @@ -51,10 +59,11 @@ func (c *Client) RespondActivityTaskCompleted(ctx context.Context, params *Respo type RespondActivityTaskCompletedInput struct { - // 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. + // 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. // // This member is required. TaskToken *string diff --git a/service/swf/api_op_RespondActivityTaskFailed.go b/service/swf/api_op_RespondActivityTaskFailed.go index c0463b893f3..e752e15b887 100644 --- a/service/swf/api_op_RespondActivityTaskFailed.go +++ b/service/swf/api_op_RespondActivityTaskFailed.go @@ -10,27 +10,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Used by workers to tell the service that the ActivityTask identified by the -// taskToken has failed with reason (if specified). The reason and details appear -// 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 -// Amazon SWF resources as follows: +// Used by workers to tell the service that the ActivityTask identified by the taskToken has +// failed with reason (if specified). The reason and details appear 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]. +// +// # 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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [timed out]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RespondActivityTaskFailed(ctx context.Context, params *RespondActivityTaskFailedInput, optFns ...func(*Options)) (*RespondActivityTaskFailedOutput, error) { if params == nil { params = &RespondActivityTaskFailedInput{} @@ -48,15 +55,16 @@ func (c *Client) RespondActivityTaskFailed(ctx context.Context, params *RespondA type RespondActivityTaskFailedInput struct { - // 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. + // 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. // // This member is required. TaskToken *string - // Detailed information about the failure. + // Detailed information about the failure. Details *string // Description of the error that may assist in diagnostics. diff --git a/service/swf/api_op_RespondDecisionTaskCompleted.go b/service/swf/api_op_RespondDecisionTaskCompleted.go index a8dfc3ffbcb..95424971c42 100644 --- a/service/swf/api_op_RespondDecisionTaskCompleted.go +++ b/service/swf/api_op_RespondDecisionTaskCompleted.go @@ -11,19 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the Amazon SWF Developer Guide. +// 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]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) RespondDecisionTaskCompleted(ctx context.Context, params *RespondDecisionTaskCompletedInput, optFns ...func(*Options)) (*RespondDecisionTaskCompletedOutput, error) { if params == nil { params = &RespondDecisionTaskCompletedInput{} @@ -42,16 +47,17 @@ 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 - // 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. + // 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. // // 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. + // this decision task. See the docs for the Decisionstructure for details. Decisions []types.Decision // User defined context to add to workflow execution. @@ -67,10 +73,12 @@ type RespondDecisionTaskCompletedInput struct { // it possible to temporarily override the task list. If a decision task scheduled // on the override task list is not started within the timeout, the decision task // will time out. Amazon SWF will revert the override and schedule a new decision - // task to the original task list. If a decision task scheduled on the override - // task list is started within the timeout, but not completed within the - // start-to-close timeout, Amazon SWF will also revert the override and schedule a - // new decision task to the original task list. + // task to the original task list. + // + // If a decision task scheduled on the override task list is started within the + // timeout, but not completed within the start-to-close timeout, Amazon SWF will + // also revert the override and schedule a new decision task to the original task + // list. TaskListScheduleToStartTimeout *string noSmithyDocumentSerde diff --git a/service/swf/api_op_SignalWorkflowExecution.go b/service/swf/api_op_SignalWorkflowExecution.go index a4bd9774680..2e75a33308e 100644 --- a/service/swf/api_op_SignalWorkflowExecution.go +++ b/service/swf/api_op_SignalWorkflowExecution.go @@ -13,23 +13,33 @@ import ( // Records a WorkflowExecutionSignaled event in the workflow execution history and // creates a decision task for the workflow execution identified by the given // domain, workflowId and runId. The event is recorded with the specified user -// 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: +// 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: +// // - 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) SignalWorkflowExecution(ctx context.Context, params *SignalWorkflowExecutionInput, optFns ...func(*Options)) (*SignalWorkflowExecutionOutput, error) { if params == nil { params = &SignalWorkflowExecutionInput{} diff --git a/service/swf/api_op_StartWorkflowExecution.go b/service/swf/api_op_StartWorkflowExecution.go index 239b33e2377..287e2b0a456 100644 --- a/service/swf/api_op_StartWorkflowExecution.go +++ b/service/swf/api_op_StartWorkflowExecution.go @@ -12,30 +12,46 @@ import ( ) // Starts an execution of the workflow type in the specified domain using the -// 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: +// 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 . // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) StartWorkflowExecution(ctx context.Context, params *StartWorkflowExecutionInput, optFns ...func(*Options)) (*StartWorkflowExecutionOutput, error) { if params == nil { params = &StartWorkflowExecutionInput{} @@ -53,10 +69,11 @@ func (c *Client) StartWorkflowExecution(ctx context.Context, params *StartWorkfl type StartWorkflowExecutionInput struct { - // The name of the domain in which the workflow execution is created. The - // specified string 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 . + // The name of the domain in which the workflow execution is created. + // + // The specified string 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. Domain *string @@ -65,9 +82,11 @@ type StartWorkflowExecutionInput struct { // this to associate a custom identifier with the workflow execution. You may // specify the same identifier if a workflow execution is logically a restart of a // 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 contain a : (colon), / (slash), | (vertical bar), or any control characters - // ( \u0000-\u001f | \u007f-\u009f ). Also, it must not be the literal string arn . + // workflowId at the same time within the same domain. + // + // The specified string 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. WorkflowId *string @@ -78,16 +97,21 @@ type StartWorkflowExecutionInput struct { WorkflowType *types.WorkflowType // If set, specifies the policy to use for the child workflow executions of this - // 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: + // workflow execution if it is terminated, by calling the TerminateWorkflowExecutionaction 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 @@ -96,14 +120,18 @@ type StartWorkflowExecutionInput 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 . 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 - // specified either through this parameter or as a default when the workflow type - // is registered. If neither this parameter nor a default execution start-to-close - // timeout is specified, a fault is returned. + // 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 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 specified either through this + // parameter or as a default when the workflow type is registered. If neither this + // parameter nor a default execution start-to-close timeout is specified, a fault + // is returned. ExecutionStartToCloseTimeout *string // The input for the workflow execution. This is a free form string which should @@ -111,48 +139,58 @@ type StartWorkflowExecutionInput struct { // 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) - // in the Amazon SWF Developer Guide. + // 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]in the Amazon SWF Developer Guide. + // + // [https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html 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 . + // calling ListOpenWorkflowExecutionsor ListClosedWorkflowExecutions and specifying a TagFilter. TagList []string // The task list to use for the decision tasks generated for this workflow // execution. This overrides the defaultTaskList specified when registering the - // workflow type. A task list 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 list was specified at registration time then - // a fault is returned. The specified string 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 . + // workflow type. + // + // A task list 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 list was specified at registration time then a fault is + // returned. + // + // The specified string 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 . 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 - // 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. + // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 - // 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. + // 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 returned. TaskStartToCloseTimeout *string noSmithyDocumentSerde diff --git a/service/swf/api_op_TagResource.go b/service/swf/api_op_TagResource.go index 2b6b960e606..ff37ef6f109 100644 --- a/service/swf/api_op_TagResource.go +++ b/service/swf/api_op_TagResource.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Add a tag to a Amazon SWF domain. Amazon SWF supports a maximum of 50 tags per -// resource. +// Add a tag to a Amazon SWF domain. +// +// Amazon SWF supports a maximum of 50 tags per resource. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -35,8 +36,10 @@ type TagResourceInput struct { // This member is required. ResourceArn *string - // The list of tags to add to a domain. Tags may only contain unicode letters, - // digits, whitespace, or these symbols: _ . : / = + - @ . + // The list of tags to add to a domain. + // + // Tags may only contain unicode letters, 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 6f10f257634..35a737a6689 100644 --- a/service/swf/api_op_TerminateWorkflowExecution.go +++ b/service/swf/api_op_TerminateWorkflowExecution.go @@ -15,25 +15,36 @@ import ( // execution identified by the given domain, runId, and workflowId. The child // policy, registered with the workflow type or specified when starting this // execution, is applied to any open child workflow executions of this workflow -// execution. If the identified workflow execution was in progress, it is -// terminated immediately. If a runId isn't specified, then the -// WorkflowExecutionTerminated event is recorded in the history of the current open -// workflow with the matching workflowId in the domain. You should consider using -// RequestCancelWorkflowExecution action instead because it allows the workflow to -// 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: +// execution. +// +// If the identified workflow execution was in progress, it is terminated +// immediately. +// +// If a runId isn't specified, then the WorkflowExecutionTerminated event is +// recorded in the history of the current open workflow with the matching +// workflowId in the domain. +// +// You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to +// gracefully close while TerminateWorkflowExecutiondoesn'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. // // 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) TerminateWorkflowExecution(ctx context.Context, params *TerminateWorkflowExecutionInput, optFns ...func(*Options)) (*TerminateWorkflowExecutionOutput, error) { if params == nil { params = &TerminateWorkflowExecutionInput{} @@ -64,23 +75,29 @@ type TerminateWorkflowExecutionInput struct { // If set, specifies the policy to use for the child workflow executions of the // 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: + // 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. ChildPolicy types.ChildPolicy - // Details for terminating the workflow execution. + // Details for terminating the workflow execution. Details *string - // A descriptive reason for terminating the workflow execution. + // A descriptive reason for terminating the workflow execution. Reason *string // The runId of the workflow execution to terminate. diff --git a/service/swf/api_op_UndeprecateActivityType.go b/service/swf/api_op_UndeprecateActivityType.go index 147aa0de2b2..e48bf4d7580 100644 --- a/service/swf/api_op_UndeprecateActivityType.go +++ b/service/swf/api_op_UndeprecateActivityType.go @@ -12,25 +12,35 @@ import ( ) // Undeprecates a previously deprecated activity type. After an activity type has -// been undeprecated, you can create new tasks of that activity type. 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: +// been undeprecated, you can create new tasks of that activity type. +// +// 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. +// // - 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) UndeprecateActivityType(ctx context.Context, params *UndeprecateActivityTypeInput, optFns ...func(*Options)) (*UndeprecateActivityTypeOutput, error) { if params == nil { params = &UndeprecateActivityTypeInput{} diff --git a/service/swf/api_op_UndeprecateDomain.go b/service/swf/api_op_UndeprecateDomain.go index 09f652b586b..fded4c2545b 100644 --- a/service/swf/api_op_UndeprecateDomain.go +++ b/service/swf/api_op_UndeprecateDomain.go @@ -12,21 +12,29 @@ import ( // Undeprecates a previously deprecated domain. After a domain has been // 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: +// 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: // // - 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) UndeprecateDomain(ctx context.Context, params *UndeprecateDomainInput, optFns ...func(*Options)) (*UndeprecateDomainOutput, error) { if params == nil { params = &UndeprecateDomainInput{} diff --git a/service/swf/api_op_UndeprecateWorkflowType.go b/service/swf/api_op_UndeprecateWorkflowType.go index 46d05317c7b..4b6d86b9953 100644 --- a/service/swf/api_op_UndeprecateWorkflowType.go +++ b/service/swf/api_op_UndeprecateWorkflowType.go @@ -12,25 +12,35 @@ import ( ) // Undeprecates a previously deprecated workflow type. After a workflow type has -// been undeprecated, you can create new executions of that type. 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: +// been undeprecated, you can create new executions of that type. +// +// 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. +// // - 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html func (c *Client) UndeprecateWorkflowType(ctx context.Context, params *UndeprecateWorkflowTypeInput, optFns ...func(*Options)) (*UndeprecateWorkflowTypeOutput, error) { if params == nil { params = &UndeprecateWorkflowTypeInput{} diff --git a/service/swf/doc.go b/service/swf/doc.go index 1b27b35e856..57a74e0ae72 100644 --- a/service/swf/doc.go +++ b/service/swf/doc.go @@ -3,15 +3,21 @@ // Package swf provides the API client, operations, and parameter types for Amazon // Simple Workflow Service. // -// Amazon Simple Workflow Service The Amazon Simple Workflow Service (Amazon SWF) -// makes it easy to build applications that use Amazon's cloud to coordinate work -// across distributed components. In Amazon SWF, a task represents a logical unit -// of work that is performed by a component of your workflow. Coordinating tasks in -// a workflow involves managing intertask dependencies, scheduling, and concurrency -// in accordance with the logical flow of the application. Amazon SWF gives you -// 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/) -// . +// # Amazon Simple Workflow Service +// +// The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build +// applications that use Amazon's cloud to coordinate work across distributed +// components. In Amazon SWF, a task represents a logical unit of work that is +// performed by a component of your workflow. Coordinating tasks in a workflow +// involves managing intertask dependencies, scheduling, and concurrency in +// accordance with the logical flow of the application. +// +// Amazon SWF gives you 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]. +// +// [Amazon SWF Developer Guide]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/ package swf diff --git a/service/swf/options.go b/service/swf/options.go index bdd7ae4f100..ca3b8f811ca 100644 --- a/service/swf/options.go +++ b/service/swf/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/swf/types/enums.go b/service/swf/types/enums.go index 700494d446c..add86f8df06 100644 --- a/service/swf/types/enums.go +++ b/service/swf/types/enums.go @@ -13,8 +13,9 @@ const ( ) // Values returns all known values for ActivityTaskTimeoutType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActivityTaskTimeoutType) Values() []ActivityTaskTimeoutType { return []ActivityTaskTimeoutType{ "START_TO_CLOSE", @@ -33,8 +34,9 @@ const ( ) // Values returns all known values for CancelTimerFailedCause. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CancelTimerFailedCause) Values() []CancelTimerFailedCause { return []CancelTimerFailedCause{ "TIMER_ID_UNKNOWN", @@ -52,8 +54,9 @@ const ( // Values returns all known values for CancelWorkflowExecutionFailedCause. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CancelWorkflowExecutionFailedCause) Values() []CancelWorkflowExecutionFailedCause { return []CancelWorkflowExecutionFailedCause{ "UNHANDLED_DECISION", @@ -71,8 +74,9 @@ const ( ) // Values returns all known values for ChildPolicy. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChildPolicy) Values() []ChildPolicy { return []ChildPolicy{ "TERMINATE", @@ -94,8 +98,9 @@ const ( ) // Values returns all known values for CloseStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CloseStatus) Values() []CloseStatus { return []CloseStatus{ "COMPLETED", @@ -117,8 +122,9 @@ const ( // Values returns all known values for CompleteWorkflowExecutionFailedCause. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompleteWorkflowExecutionFailedCause) Values() []CompleteWorkflowExecutionFailedCause { return []CompleteWorkflowExecutionFailedCause{ "UNHANDLED_DECISION", @@ -143,8 +149,9 @@ const ( // Values returns all known values for ContinueAsNewWorkflowExecutionFailedCause. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContinueAsNewWorkflowExecutionFailedCause) Values() []ContinueAsNewWorkflowExecutionFailedCause { return []ContinueAsNewWorkflowExecutionFailedCause{ "UNHANDLED_DECISION", @@ -168,8 +175,9 @@ const ( ) // Values returns all known values for DecisionTaskTimeoutType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DecisionTaskTimeoutType) Values() []DecisionTaskTimeoutType { return []DecisionTaskTimeoutType{ "START_TO_CLOSE", @@ -197,8 +205,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -278,8 +287,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -348,8 +358,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "OPEN", @@ -367,8 +378,9 @@ const ( // Values returns all known values for FailWorkflowExecutionFailedCause. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailWorkflowExecutionFailedCause) Values() []FailWorkflowExecutionFailedCause { return []FailWorkflowExecutionFailedCause{ "UNHANDLED_DECISION", @@ -385,6 +397,7 @@ const ( // Values returns all known values for LambdaFunctionTimeoutType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LambdaFunctionTimeoutType) Values() []LambdaFunctionTimeoutType { return []LambdaFunctionTimeoutType{ @@ -400,8 +413,9 @@ const ( ) // Values returns all known values for RecordMarkerFailedCause. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecordMarkerFailedCause) Values() []RecordMarkerFailedCause { return []RecordMarkerFailedCause{ "OPERATION_NOT_PERMITTED", @@ -417,8 +431,9 @@ const ( ) // Values returns all known values for RegistrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RegistrationStatus) Values() []RegistrationStatus { return []RegistrationStatus{ "REGISTERED", @@ -436,8 +451,9 @@ const ( // Values returns all known values for RequestCancelActivityTaskFailedCause. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestCancelActivityTaskFailedCause) Values() []RequestCancelActivityTaskFailedCause { return []RequestCancelActivityTaskFailedCause{ "ACTIVITY_ID_UNKNOWN", @@ -456,8 +472,9 @@ const ( // Values returns all known values for // RequestCancelExternalWorkflowExecutionFailedCause. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RequestCancelExternalWorkflowExecutionFailedCause) Values() []RequestCancelExternalWorkflowExecutionFailedCause { return []RequestCancelExternalWorkflowExecutionFailedCause{ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", @@ -485,8 +502,9 @@ const ( // Values returns all known values for ScheduleActivityTaskFailedCause. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleActivityTaskFailedCause) Values() []ScheduleActivityTaskFailedCause { return []ScheduleActivityTaskFailedCause{ "ACTIVITY_TYPE_DEPRECATED", @@ -515,8 +533,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduleLambdaFunctionFailedCause) Values() []ScheduleLambdaFunctionFailedCause { return []ScheduleLambdaFunctionFailedCause{ "ID_ALREADY_IN_USE", @@ -537,8 +556,9 @@ const ( // Values returns all known values for SignalExternalWorkflowExecutionFailedCause. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SignalExternalWorkflowExecutionFailedCause) Values() []SignalExternalWorkflowExecutionFailedCause { return []SignalExternalWorkflowExecutionFailedCause{ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", @@ -566,8 +586,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StartChildWorkflowExecutionFailedCause) Values() []StartChildWorkflowExecutionFailedCause { return []StartChildWorkflowExecutionFailedCause{ "WORKFLOW_TYPE_DOES_NOT_EXIST", @@ -593,8 +614,9 @@ const ( // Values returns all known values for StartLambdaFunctionFailedCause. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StartLambdaFunctionFailedCause) Values() []StartLambdaFunctionFailedCause { return []StartLambdaFunctionFailedCause{ "ASSUME_ROLE_FAILED", @@ -612,8 +634,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "TIMER_ID_ALREADY_IN_USE", @@ -632,8 +655,9 @@ const ( // Values returns all known values for WorkflowExecutionCancelRequestedCause. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowExecutionCancelRequestedCause) Values() []WorkflowExecutionCancelRequestedCause { return []WorkflowExecutionCancelRequestedCause{ "CHILD_POLICY_APPLIED", @@ -651,8 +675,9 @@ const ( // Values returns all known values for WorkflowExecutionTerminatedCause. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowExecutionTerminatedCause) Values() []WorkflowExecutionTerminatedCause { return []WorkflowExecutionTerminatedCause{ "CHILD_POLICY_APPLIED", @@ -670,8 +695,9 @@ const ( // 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. +// 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 8a642543c64..baa01397328 100644 --- a/service/swf/types/errors.go +++ b/service/swf/types/errors.go @@ -8,13 +8,16 @@ import ( ) // 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. +// 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 @@ -257,8 +260,8 @@ func (e *UnknownResourceFault) ErrorCode() string { } func (e *UnknownResourceFault) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Returned by StartWorkflowExecution when an open execution with the same -// workflowId is already running in the specified domain. +// Returned by StartWorkflowExecution when an open execution with the same workflowId is already running +// in the specified domain. type WorkflowExecutionAlreadyStartedFault struct { Message *string diff --git a/service/swf/types/types.go b/service/swf/types/types.go index f3a7020c97c..b2a3cb7453f 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. @@ -152,13 +152,18 @@ type ActivityTaskScheduledEventAttributes struct { // The maximum amount of time a worker may take to process the activity task. StartToCloseTimeout *string - // The priority to assign to the scheduled activity task. If set, this overrides + // The priority to assign to the scheduled activity task. If set, this overrides // any default priority value that was assigned when the activity type was - // registered. Valid values are integers that range from Java's Integer.MIN_VALUE + // 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) - // in the Amazon SWF Developer Guide. + // priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html TaskPriority *string noSmithyDocumentSerde @@ -213,14 +218,18 @@ type ActivityTaskTimedOutEventAttributes struct { // Represents an activity type. type ActivityType struct { - // The name of this activity. The combination of activity type name and version - // must be unique within a domain. + // The name of this activity. + // + // The combination of activity type name and version must be unique within a + // domain. // // This member is required. Name *string - // The version of this activity. The combination of activity type name and version - // must be unique with in a domain. + // The version of this activity. + // + // The combination of activity type name and version must be unique with in a + // domain. // // This member is required. Version *string @@ -231,52 +240,63 @@ type ActivityType struct { // Configuration settings registered with the activity type. 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 - // this value only when registering an activity type. The registered default value - // 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. + // The default maximum time, in seconds, before which a worker processing a task + // 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. DefaultTaskHeartbeatTimeout *string - // The default task list specified for this activity type at registration. This + // 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 ScheduleActivityTask Decision . You can override the default registered task - // list when scheduling a task through the ScheduleActivityTask Decision . + // the ScheduleActivityTaskDecision . You can override the default registered task list + // when scheduling a task through the ScheduleActivityTaskDecision . DefaultTaskList *TaskList - // The default task priority for tasks of this activity type, specified at + // The default task priority for tasks of this activity type, specified at // registration. If not set, then 0 is used as the default priority. This default - // 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) - // in the Amazon SWF Developer Guide. + // 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] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 ScheduleActivityTask Decision . 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, + // 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 unlimited duration. DefaultTaskScheduleToCloseTimeout *string - // The default maximum duration, specified when registering the activity type, + // 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. + // ScheduleActivityTaskDecision . + // + // 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 + // 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 ScheduleActivityTask Decision . The duration is specified in - // seconds, an integer greater than or equal to 0 . You can use NONE to specify - // unlimited duration. + // 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. DefaultTaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -290,7 +310,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 @@ -303,29 +323,35 @@ 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 -// follows: +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type CancelTimerDecisionAttributes struct { - // The unique ID of the timer to cancel. + // The unique ID of the timer to cancel. // // This member is required. TimerId *string @@ -337,10 +363,13 @@ type CancelTimerDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause CancelTimerFailedCause @@ -361,23 +390,29 @@ type CancelTimerFailedEventAttributes struct { noSmithyDocumentSerde } -// Provides the details of the CancelWorkflowExecution decision. Access Control +// 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type CancelWorkflowExecutionDecisionAttributes struct { - // Details of the cancellation. + // Details of the cancellation. Details *string noSmithyDocumentSerde @@ -387,10 +422,13 @@ type CancelWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause CancelWorkflowExecutionFailedCause @@ -410,9 +448,9 @@ type CancelWorkflowExecutionFailedEventAttributes struct { type ChildWorkflowExecutionCanceledEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. // // This member is required. InitiatedEventId int64 @@ -444,9 +482,9 @@ type ChildWorkflowExecutionCanceledEventAttributes struct { type ChildWorkflowExecutionCompletedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. // // This member is required. InitiatedEventId int64 @@ -478,9 +516,9 @@ type ChildWorkflowExecutionCompletedEventAttributes struct { type ChildWorkflowExecutionFailedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. // // This member is required. InitiatedEventId int64 @@ -515,9 +553,9 @@ type ChildWorkflowExecutionFailedEventAttributes struct { type ChildWorkflowExecutionStartedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. // // This member is required. InitiatedEventId int64 @@ -539,9 +577,9 @@ type ChildWorkflowExecutionStartedEventAttributes struct { type ChildWorkflowExecutionTerminatedEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. // // This member is required. InitiatedEventId int64 @@ -570,9 +608,9 @@ type ChildWorkflowExecutionTerminatedEventAttributes struct { type ChildWorkflowExecutionTimedOutEventAttributes struct { // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. // // This member is required. InitiatedEventId int64 @@ -606,7 +644,7 @@ type ChildWorkflowExecutionTimedOutEventAttributes struct { // status. type CloseStatusFilter struct { - // The close status that must match the close status of an execution for it to + // 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. @@ -615,20 +653,26 @@ type CloseStatusFilter struct { noSmithyDocumentSerde } -// Provides the details of the CompleteWorkflowExecution decision. Access Control +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type CompleteWorkflowExecutionDecisionAttributes struct { // The result of the workflow execution. The form of the result is implementation @@ -642,10 +686,13 @@ type CompleteWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause CompleteWorkflowExecutionFailedCause @@ -661,38 +708,52 @@ type CompleteWorkflowExecutionFailedEventAttributes struct { noSmithyDocumentSerde } -// Provides the details of the ContinueAsNewWorkflowExecution decision. Access -// Control You can use IAM policies to control this decision's access to Amazon SWF +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html 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: + // new execution if it is terminated by calling the TerminateWorkflowExecutionaction 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 @@ -701,12 +762,15 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { // 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. + // 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. @@ -717,32 +781,36 @@ 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 . + // calling ListOpenWorkflowExecutionsor ListClosedWorkflowExecutions and specifying a TagFilter. TagList []string // The task list to use for the decisions of the new (continued) workflow // execution. TaskList *TaskList - // The task priority that, if set, specifies the priority for the decision tasks + // 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) - // in the Amazon SWF Developer Guide. + // Higher numbers indicate higher priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 - // start-to-close timeout was specified at registration time then a fault is - // returned. + // 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 // The version of the workflow to start. @@ -755,10 +823,13 @@ type ContinueAsNewWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause ContinueAsNewWorkflowExecutionFailedCause @@ -775,97 +846,126 @@ type ContinueAsNewWorkflowExecutionFailedEventAttributes struct { } // 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 . +// 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 +// # 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]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) -// in the Amazon SWF Developer Guide. +// permissions. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]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 +// 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 @@ -873,24 +973,41 @@ type ContinueAsNewWorkflowExecutionFailedEventAttributes struct { // 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 // possible because of race conditions in a distributed system. The right action -// here is to call RespondDecisionTaskCompleted without any decisions. This would -// result in another decision task with these new events included in the history. -// The decider should handle the new events and may decide to close the workflow -// 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 +// here is to call RespondDecisionTaskCompletedwithout any decisions. This would result in another decision +// task with these new events included in the history. The decider should handle +// the new events and may decide to close the workflow 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 +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type Decision struct { // Specifies the type of the decision. @@ -996,17 +1113,21 @@ type DecisionTaskScheduledEventAttributes struct { ScheduleToStartTimeout *string // 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. + // 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. + // 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) - // in the Amazon SWF Developer Guide. + // priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html TaskPriority *string noSmithyDocumentSerde @@ -1074,10 +1195,12 @@ 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. + // + // - 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 @@ -1085,7 +1208,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 @@ -1093,8 +1216,10 @@ 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]. For example: +// "oldestDate": 1325376070. +// +// [Unix Time format]: https://en.wikipedia.org/wiki/Unix_time type ExecutionTimeFilter struct { // Specifies the oldest start or close date and time to return. @@ -1146,23 +1271,29 @@ type ExternalWorkflowExecutionSignaledEventAttributes struct { noSmithyDocumentSerde } -// 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: +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type FailWorkflowExecutionDecisionAttributes struct { - // Details of the failure. + // Details of the failure. Details *string // A descriptive reason for the failure that may help in diagnostics. @@ -1175,10 +1306,13 @@ type FailWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause FailWorkflowExecutionFailedCause @@ -1202,15 +1336,13 @@ type FailWorkflowExecutionFailedEventAttributes struct { // - ActivityTaskCanceled – The activity task was successfully canceled. // // - ActivityTaskCompleted – An activity worker successfully completed an -// activity task by calling RespondActivityTaskCompleted . +// 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. // -// - 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. // @@ -1245,7 +1377,7 @@ type FailWorkflowExecutionFailedEventAttributes struct { // complete after being continued as a new workflow execution. // // - DecisionTaskCompleted – The decider successfully completed a decision task -// by calling RespondDecisionTaskCompleted . +// by calling RespondDecisionTaskCompleted. // // - DecisionTaskScheduled – A decision task was scheduled for the workflow // execution. @@ -1752,28 +1884,34 @@ type MarkerRecordedEventAttributes struct { noSmithyDocumentSerde } -// 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: +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type RecordMarkerDecisionAttributes struct { - // The name of the marker. + // The name of the marker. // // This member is required. MarkerName *string - // The details of the marker. + // The details of the marker. Details *string noSmithyDocumentSerde @@ -1783,10 +1921,13 @@ type RecordMarkerDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause RecordMarkerFailedCause @@ -1807,20 +1948,26 @@ type RecordMarkerFailedEventAttributes struct { noSmithyDocumentSerde } -// Provides the details of the RequestCancelActivityTask decision. Access Control +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type RequestCancelActivityTaskDecisionAttributes struct { // The activityId of the activity task to be canceled. @@ -1840,10 +1987,13 @@ type RequestCancelActivityTaskFailedEventAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause RequestCancelActivityTaskFailedCause @@ -1860,22 +2010,28 @@ 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: +// +// # 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. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type RequestCancelExternalWorkflowExecutionDecisionAttributes struct { - // The workflowId of the external workflow execution to cancel. + // The workflowId of the external workflow execution to cancel. // // This member is required. WorkflowId *string @@ -1894,10 +2050,13 @@ type RequestCancelExternalWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause RequestCancelExternalWorkflowExecutionFailedCause @@ -1962,8 +2121,10 @@ 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: _ . : / = + - @ . +// and activities. +// +// Tags may only contain unicode letters, digits, whitespace, or these symbols: _ +// . : / = + - @ . type ResourceTag struct { // The key of a tag. @@ -1977,35 +2138,46 @@ type ResourceTag struct { noSmithyDocumentSerde } -// 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: +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type ScheduleActivityTaskDecisionAttributes struct { - // The activityId of the activity task. The specified string 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 . + // The activityId of the activity task. + // + // The specified string 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. ActivityId *string - // The type of the activity task to schedule. + // The type of the activity task to schedule. // // This member is required. ActivityType *ActivityType @@ -2015,64 +2187,78 @@ 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 - // 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 - // duration. + // 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 duration. HeartbeatTimeout *string // The input provided to the activity task. 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 - // 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. + // 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 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 + // 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. + // 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 contain a : (colon), / (slash), | - // (vertical bar), or any control characters ( \u0000-\u001f | \u007f-\u009f ). - // Also, it must not be the literal string arn . + // 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 contain a : (colon), / (slash), | (vertical bar), + // or any control characters ( \u0000-\u001f | \u007f-\u009f ). Also, it must not + // be the literal string arn . TaskList *TaskList - // If set, specifies the priority with which the activity task is to be assigned + // 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. + // 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] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html TaskPriority *string noSmithyDocumentSerde @@ -2092,10 +2278,13 @@ type ScheduleActivityTaskFailedEventAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause ScheduleActivityTaskFailedCause @@ -2112,7 +2301,7 @@ type ScheduleActivityTaskFailedEventAttributes struct { } // Decision attributes specified in scheduleLambdaFunctionDecisionAttributes -// within the list of decisions decisions passed to RespondDecisionTaskCompleted . +// within the list of decisions decisions passed to RespondDecisionTaskCompleted. type ScheduleLambdaFunctionDecisionAttributes struct { // A string that identifies the Lambda function execution in the event history. @@ -2133,8 +2322,9 @@ type ScheduleLambdaFunctionDecisionAttributes struct { Input *string // The timeout value, in seconds, after which the Lambda function is considered to - // be failed once it has started. This can be any integer from 1-900 (1s-15m). If - // no value is supplied, then a default value of 900s is assumed. + // be failed once it has started. This can be any integer from 1-900 (1s-15m). + // + // If no value is supplied, then a default value of 900s is assumed. StartToCloseTimeout *string noSmithyDocumentSerde @@ -2145,11 +2335,13 @@ type ScheduleLambdaFunctionDecisionAttributes struct { 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 - // 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. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause ScheduleLambdaFunctionFailedCause @@ -2174,29 +2366,35 @@ type ScheduleLambdaFunctionFailedEventAttributes struct { noSmithyDocumentSerde } -// Provides the details of the SignalExternalWorkflowExecution decision. Access -// Control You can use IAM policies to control this decision's access to Amazon SWF +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type SignalExternalWorkflowExecutionDecisionAttributes struct { - // The name of the signal.The target workflow execution uses the signal name and + // The name of the signal.The target workflow execution uses the signal name and // input to process the signal. // // This member is required. SignalName *string - // The workflowId of the workflow execution to be signaled. + // The workflowId of the workflow execution to be signaled. // // This member is required. WorkflowId *string @@ -2205,7 +2403,7 @@ type SignalExternalWorkflowExecutionDecisionAttributes struct { // decision tasks. Control *string - // The input data to be provided with the signal. The target workflow execution + // The input data to be provided with the signal. The target workflow execution // uses the signal name and input data to process the signal. Input *string @@ -2219,10 +2417,13 @@ type SignalExternalWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause SignalExternalWorkflowExecutionFailedCause @@ -2294,52 +2495,69 @@ 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html type StartChildWorkflowExecutionDecisionAttributes struct { - // The workflowId of the workflow execution. The specified string 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 . + // The workflowId of the workflow execution. + // + // The specified string 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. WorkflowId *string - // The type of the workflow execution to be started. + // The type of the workflow execution to be started. // // This member is required. WorkflowType *WorkflowType - // If set, specifies the policy to use for the child workflow executions if the - // 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: + // If set, specifies the policy to use for the child workflow executions if the + // workflow execution being started is terminated by calling the TerminateWorkflowExecutionaction 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 @@ -2352,12 +2570,15 @@ 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 - // 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 - // time then a fault is returned. + // 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 parameter. + // If neither this parameter is set nor a default execution start-to-close timeout + // was specified at registration time then a fault is returned. ExecutionStartToCloseTimeout *string // The input to be provided to the workflow execution. @@ -2368,38 +2589,45 @@ 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 . + // calling ListOpenWorkflowExecutionsor ListClosedWorkflowExecutions and specifying a TagFilter. TagList []string // The name of the task list to be used for decision tasks of the child workflow - // execution. A task list 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 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 . + // execution. + // + // A task list 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 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 . TaskList *TaskList - // A task priority that, if set, specifies the priority for a decision task of + // 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) - // in the Amazon SWF Developer Guide. + // numbers indicate higher priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 - // 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. + // 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 returned. TaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -2409,29 +2637,33 @@ type StartChildWorkflowExecutionDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause StartChildWorkflowExecutionFailedCause // The ID of the DecisionTaskCompleted event corresponding to the decision task - // 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. + // that resulted in the StartChildWorkflowExecutionDecision 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 // StartChildWorkflowExecutionInitiated event that corresponds to the - // 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. + // 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 , initiatedEventId is set to 0 + // because the StartChildWorkflowExecutionInitiated event doesn't exist. // // This member is required. InitiatedEventId int64 @@ -2441,8 +2673,7 @@ type StartChildWorkflowExecutionFailedEventAttributes struct { // This member is required. WorkflowId *string - // The workflow type provided in the StartChildWorkflowExecution Decision that - // failed. + // The workflow type provided in the StartChildWorkflowExecutionDecision that failed. // // This member is required. WorkflowType *WorkflowType @@ -2458,22 +2689,26 @@ 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: + // terminated by explicitly calling the TerminateWorkflowExecutionaction 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 StartChildWorkflowExecution Decision to request this child - // workflow execution. This information can be useful for diagnosing problems by - // tracing back the cause of events. + // that resulted in the StartChildWorkflowExecutionDecision to request this child workflow + // execution. This information can be useful for diagnosing problems by tracing + // back the cause of events. // // This member is required. DecisionTaskCompletedEventId int64 @@ -2500,8 +2735,10 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // 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. + // 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. @@ -2513,16 +2750,21 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { // The list of tags to associated with the child workflow execution. TagList []string - // 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) - // in the Amazon SWF Developer Guide. + // 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] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html 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 @@ -2533,11 +2775,13 @@ type StartChildWorkflowExecutionInitiatedEventAttributes struct { 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 execution lacked sufficient permissions. For details and example IAM - // policies, see Lambda Tasks (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) - // in the Amazon SWF Developer Guide. + // 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]in the Amazon SWF Developer Guide. + // + // [Lambda Tasks]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html Cause StartLambdaFunctionFailedCause // A description that can help diagnose the cause of the fault. @@ -2551,30 +2795,40 @@ type StartLambdaFunctionFailedEventAttributes struct { noSmithyDocumentSerde } -// 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: +// 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) -// in the Amazon SWF Developer Guide. +// For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows]in the Amazon SWF Developer Guide. +// +// [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html 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 . + // The duration to wait before firing the timer. + // + // The duration is specified in 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 contain a : (colon), / - // (slash), | (vertical bar), or any control characters ( \u0000-\u001f | - // \u007f-\u009f ). Also, it must not be the literal string arn . + // The unique ID of the timer. + // + // The specified string 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. TimerId *string @@ -2590,10 +2844,13 @@ type StartTimerDecisionAttributes struct { 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [Using IAM to Manage Access to Amazon SWF Workflows]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html // // This member is required. Cause StartTimerFailedCause @@ -2617,9 +2874,11 @@ type StartTimerFailedEventAttributes struct { // Used to filter the workflow executions in visibility APIs based on a tag. 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: _ . : / = + - @ . + // 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: _ + // . : / = + - @ . // // This member is required. Tag *string @@ -2693,8 +2952,9 @@ type TimerStartedEventAttributes struct { // This member is required. 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 . + // The duration of time after which the timer fires. + // + // The duration is specified in seconds, an integer greater than or equal to 0 . // // This member is required. StartToFireTimeout *string @@ -2791,21 +3051,26 @@ type WorkflowExecutionCompletedEventAttributes struct { 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: + // is terminated, by calling the TerminateWorkflowExecutionaction 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 - // 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 - // unlimited duration. + // 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 unlimited duration. // // This member is required. ExecutionStartToCloseTimeout *string @@ -2816,6 +3081,7 @@ type WorkflowExecutionConfiguration struct { 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. // @@ -2827,9 +3093,12 @@ 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) - // in the Amazon SWF Developer Guide. + // Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority. + // + // For more information about setting task priority, see [Setting Task Priority] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html TaskPriority *string noSmithyDocumentSerde @@ -2839,13 +3108,17 @@ 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: + // is terminated by calling the TerminateWorkflowExecutionaction 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. @@ -2875,9 +3148,10 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { // This member is required. 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. + // 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. ExecutionStartToCloseTimeout *string // The input provided to the new workflow execution. @@ -2893,9 +3167,10 @@ type WorkflowExecutionContinuedAsNewEventAttributes struct { // workflow execution. 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. + // 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. TaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -2960,13 +3235,19 @@ 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. @@ -3051,13 +3332,17 @@ type WorkflowExecutionSignaledEventAttributes struct { 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: + // is terminated, by calling the TerminateWorkflowExecutionaction 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. @@ -3079,9 +3364,10 @@ type WorkflowExecutionStartedEventAttributes struct { // 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 - // unlimited duration. + // 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 unlimited duration. ExecutionStartToCloseTimeout *string // The input provided to the workflow execution. @@ -3091,10 +3377,10 @@ type WorkflowExecutionStartedEventAttributes struct { LambdaRole *string // The ID of the StartChildWorkflowExecutionInitiated event corresponding to the - // 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. + // 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. ParentInitiatedEventId int64 // The source workflow execution that started this workflow execution. The member @@ -3108,9 +3394,10 @@ type WorkflowExecutionStartedEventAttributes struct { // The priority of the decision tasks in the workflow execution. 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. + // 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. TaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -3120,12 +3407,16 @@ type WorkflowExecutionStartedEventAttributes struct { 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. // // This member is required. @@ -3149,12 +3440,16 @@ type WorkflowExecutionTerminatedEventAttributes struct { 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. // // This member is required. @@ -3171,14 +3466,18 @@ 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 - // The version of the workflow type. The combination of workflow type name and - // version must be unique with in a domain. + // The version of the workflow type. + // + // The combination of workflow type name and version must be unique with in a + // domain. // // This member is required. Version *string @@ -3189,60 +3488,73 @@ type WorkflowType struct { // The configuration settings of a workflow type. type WorkflowTypeConfiguration struct { - // The default policy to use for the child workflow executions 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 StartChildWorkflowExecution Decision . The supported child policies are: + // The default policy to use for the child workflow executions when a workflow + // execution of this type is terminated, by calling the TerminateWorkflowExecutionaction explicitly or due + // to an expired timeout. This default can be overridden when starting a workflow + // execution using the StartWorkflowExecutionaction 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. 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 - // StartChildWorkflowExecution Decision . 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, + // for executions of this workflow type. This default can be overridden when + // starting a workflow execution using the StartWorkflowExecutionaction 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. 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) - // in the Amazon SWF Developer Guide. + // 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]in the + // Amazon SWF Developer Guide. + // + // [https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html DefaultLambdaRole *string - // The default task list, specified when registering the workflow type, for + // 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 StartChildWorkflowExecution Decision . + // be overridden when starting a workflow execution using the StartWorkflowExecutionaction or the + // StartChildWorkflowExecutionDecision . DefaultTaskList *TaskList - // The default task priority, specified when registering the workflow type, for + // 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) - // in the Amazon SWF Developer Guide. + // starting a workflow execution using the StartWorkflowExecutionaction 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] in the Amazon SWF + // Developer Guide. + // + // [Setting Task Priority]: https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html DefaultTaskPriority *string - // The default maximum duration, specified when registering the workflow type, + // 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. + // overridden when starting a workflow execution using the StartWorkflowExecutionaction 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. DefaultTaskStartToCloseTimeout *string noSmithyDocumentSerde @@ -3252,7 +3564,7 @@ type WorkflowTypeConfiguration struct { // specified, defines a rule that must be satisfied by each returned result. type WorkflowTypeFilter struct { - // Name of the workflow type. + // Name of the workflow type. // // This member is required. Name *string @@ -3285,7 +3597,7 @@ type WorkflowTypeInfo struct { // 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_op_AssociateResource.go b/service/synthetics/api_op_AssociateResource.go index 8456ce79630..38c470d0760 100644 --- a/service/synthetics/api_op_AssociateResource.go +++ b/service/synthetics/api_op_AssociateResource.go @@ -12,8 +12,9 @@ import ( // Associates a canary with a group. Using groups can help you with managing and // automating your canaries, and you can also view aggregated run results and -// statistics for all canaries in a group. You must run this operation in the -// Region where the canary exists. +// statistics for all canaries in a group. +// +// You must run this operation in the Region where the canary exists. func (c *Client) AssociateResource(ctx context.Context, params *AssociateResourceInput, optFns ...func(*Options)) (*AssociateResourceOutput, error) { if params == nil { params = &AssociateResourceInput{} diff --git a/service/synthetics/api_op_CreateCanary.go b/service/synthetics/api_op_CreateCanary.go index 330be97f319..69c27c5bdc8 100644 --- a/service/synthetics/api_op_CreateCanary.go +++ b/service/synthetics/api_op_CreateCanary.go @@ -15,17 +15,23 @@ import ( // 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 +// continuously or just once. +// +// Do not use CreateCanary to modify an existing canary. Use [UpdateCanary] 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]. +// +// 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]. +// +// [UpdateCanary]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_UpdateCanary.html +// [Necessary Roles and Permissions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Roles +// [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,31 +66,40 @@ type CreateCanaryInput struct { // 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 // // This member is required. ExecutionRoleArn *string // The name for this canary. Be sure to give it a descriptive name that - // 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) - // . + // 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]. + // + // [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) - // . + // runtime versions and more information about runtime versions, see [Canary Runtime Versions]. + // + // [Canary Runtime Versions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html // // This member is required. RuntimeVersion *string @@ -104,8 +119,10 @@ type CreateCanaryInput struct { FailureRetentionPeriodInDays *int32 // A structure that contains the configuration for individual canary runs, such as - // timeout value and environment variables. The environment variables keys and - // values are not encrypted. Do not store sensitive information in this field. + // timeout value and environment variables. + // + // The environment variables keys and values are not encrypted. Do not store + // sensitive information in this field. RunConfig *types.CanaryRunConfigInput // The number of days to retain data about successful runs of this canary. If you @@ -114,15 +131,18 @@ type CreateCanaryInput struct { SuccessRetentionPeriodInDays *int32 // A list of key-value pairs to associate with the canary. You can associate as - // many as 50 tags with a canary. 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. + // many as 50 tags with a canary. + // + // 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 // 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]. + // + // [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 2f318c6bafe..d5e1d7276b6 100644 --- a/service/synthetics/api_op_CreateGroup.go +++ b/service/synthetics/api_op_CreateGroup.go @@ -14,17 +14,22 @@ import ( // Creates a group which you can use to associate canaries with each other, // including cross-Region canaries. Using groups can help you with managing and // automating your canaries, and you can also view aggregated run results and -// statistics for all canaries in a group. Groups are global resources. When you -// create a group, it is replicated across Amazon Web Services Regions, and you can -// view it and add canaries to it from any Region. Although the group ARN format -// reflects the Region name where it was created, a group is not constrained to any -// Region. This means that you can put canaries from multiple Regions into the same -// 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 +// statistics for all canaries in a group. +// +// Groups are global resources. When you create a group, it is replicated across +// Amazon Web Services Regions, and you can view it and add canaries to it from any +// Region. Although the group ARN format reflects the Region name where it was +// created, a group is not constrained to any Region. This means that you can put +// canaries from multiple Regions into the same 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]. +// +// 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. +// +// [Enabling a Region]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} @@ -42,16 +47,19 @@ 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 - // 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. + // 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 noSmithyDocumentSerde diff --git a/service/synthetics/api_op_DeleteCanary.go b/service/synthetics/api_op_DeleteCanary.go index bc99fdd543a..9ccd5849eaa 100644 --- a/service/synthetics/api_op_DeleteCanary.go +++ b/service/synthetics/api_op_DeleteCanary.go @@ -10,17 +10,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 . // @@ -45,14 +52,17 @@ 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]. + // + // [DescribeCanaries]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html // // This member is required. Name *string // Specifies whether to also delete the Lambda functions and layers used by this - // canary. The default is false. Type: Boolean + // canary. The default is false. + // + // Type: Boolean DeleteLambda bool noSmithyDocumentSerde diff --git a/service/synthetics/api_op_DeleteGroup.go b/service/synthetics/api_op_DeleteGroup.go index 46b4592b5ed..064ee8a9091 100644 --- a/service/synthetics/api_op_DeleteGroup.go +++ b/service/synthetics/api_op_DeleteGroup.go @@ -11,10 +11,11 @@ import ( ) // Deletes a group. The group doesn't need to be empty to be deleted. If there are -// canaries in the group, they are not deleted when you delete the group. Groups -// are a global resource that appear in all Regions, but the request to delete a -// group must be made from its home Region. You can find the home Region of a group -// within its ARN. +// canaries in the group, they are not deleted when you delete the group. +// +// Groups are a global resource that appear in all Regions, but the request to +// delete a group must be made from its home Region. You can find the home Region +// of a group within its ARN. func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error) { if params == nil { params = &DeleteGroupInput{} diff --git a/service/synthetics/api_op_DescribeCanaries.go b/service/synthetics/api_op_DescribeCanaries.go index 01ca64a8030..762bfa0424a 100644 --- a/service/synthetics/api_op_DescribeCanaries.go +++ b/service/synthetics/api_op_DescribeCanaries.go @@ -12,15 +12,19 @@ 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) -// . +// 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]. +// +// [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{} @@ -44,14 +48,18 @@ type DescribeCanariesInput struct { 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 - // 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) - // . + // 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]. + // + // [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 diff --git a/service/synthetics/api_op_DescribeCanariesLastRun.go b/service/synthetics/api_op_DescribeCanariesLastRun.go index 95b93c069fd..ce85c0f4553 100644 --- a/service/synthetics/api_op_DescribeCanariesLastRun.go +++ b/service/synthetics/api_op_DescribeCanariesLastRun.go @@ -12,15 +12,19 @@ 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) -// . +// 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]. +// +// [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{} @@ -44,14 +48,18 @@ type DescribeCanariesLastRunInput struct { 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 - // 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) - // . + // 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]. + // + // [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 diff --git a/service/synthetics/api_op_DescribeRuntimeVersions.go b/service/synthetics/api_op_DescribeRuntimeVersions.go index bec2f3bbc9a..214f834f1ce 100644 --- a/service/synthetics/api_op_DescribeRuntimeVersions.go +++ b/service/synthetics/api_op_DescribeRuntimeVersions.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) +// Returns a list of Synthetics canary runtime versions. For more information, see [Canary Runtime Versions] // . +// +// [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{} diff --git a/service/synthetics/api_op_GetCanary.go b/service/synthetics/api_op_GetCanary.go index d8548d23494..7a52458792f 100644 --- a/service/synthetics/api_op_GetCanary.go +++ b/service/synthetics/api_op_GetCanary.go @@ -12,9 +12,9 @@ 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) -// . +// the canary that you want. To get a list of canaries and their names, use [DescribeCanaries]. +// +// [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_ListTagsForResource.go b/service/synthetics/api_op_ListTagsForResource.go index 82bbf5cb5af..ed7163efabd 100644 --- a/service/synthetics/api_op_ListTagsForResource.go +++ b/service/synthetics/api_op_ListTagsForResource.go @@ -28,9 +28,13 @@ 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 c970ef76e88..fb686cf5c79 100644 --- a/service/synthetics/api_op_StartCanary.go +++ b/service/synthetics/api_op_StartCanary.go @@ -12,8 +12,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) -// . +// a canary's schedule, use [GetCanary]. +// +// [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{} @@ -31,9 +32,9 @@ 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) - // . + // The name of the canary that you want to run. To find canary names, use [DescribeCanaries]. + // + // [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 2d0d33d765a..9101d88f733 100644 --- a/service/synthetics/api_op_StopCanary.go +++ b/service/synthetics/api_op_StopCanary.go @@ -12,8 +12,9 @@ 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 +// 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. func (c *Client) StopCanary(ctx context.Context, params *StopCanaryInput, optFns ...func(*Options)) (*StopCanaryOutput, error) { if params == nil { @@ -33,8 +34,9 @@ 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]. + // + // [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_TagResource.go b/service/synthetics/api_op_TagResource.go index 055341e130f..fe02f34cc71 100644 --- a/service/synthetics/api_op_TagResource.go +++ b/service/synthetics/api_op_TagResource.go @@ -11,16 +11,21 @@ import ( ) // Assigns one or more tags (key-value pairs) to the specified canary or 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 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 -// specify a new tag key for the resource, this tag is appended to the list of tags -// associated with the resource. If you specify a tag key that is already +// 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 specify a new tag key for the resource, this tag is appended to the list of +// tags associated with the resource. 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 canary -// or group. +// previous value for that tag. +// +// You can associate as many as 50 tags with a canary or group. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} @@ -38,9 +43,13 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // The ARN of the canary or group that you're adding tags to. 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 adding tags to. + // + // 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_UntagResource.go b/service/synthetics/api_op_UntagResource.go index 3185fe6a9c9..5586a3db830 100644 --- a/service/synthetics/api_op_UntagResource.go +++ b/service/synthetics/api_op_UntagResource.go @@ -28,9 +28,13 @@ 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 203eae48b89..145b246aa5f 100644 --- a/service/synthetics/api_op_UpdateCanary.go +++ b/service/synthetics/api_op_UpdateCanary.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]. +// +// [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,8 +35,11 @@ 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]. + // + // You cannot change the name of a canary that has already been created. + // + // [DescribeCanaries]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html // // This member is required. Name *string @@ -56,12 +61,19 @@ type UpdateCanaryInput struct { // 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 ExecutionRoleArn *string @@ -69,14 +81,16 @@ type UpdateCanaryInput struct { 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. + // 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) - // . + // runtime versions and for more information about runtime versions, see [Canary Runtime Versions]. + // + // [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 @@ -89,16 +103,20 @@ type UpdateCanaryInput struct { // Defines the screenshots to use as the baseline for comparisons during visual // 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) + // 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]and [Visual monitoring blueprint] + // + // [Visual monitoring]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html + // [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]. + // + // [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 a00f1ee7aca..4f77a64c3ba 100644 --- a/service/synthetics/doc.go +++ b/service/synthetics/doc.go @@ -3,18 +3,21 @@ // Package synthetics provides the API client, operations, and parameter types for // Synthetics. // -// Amazon CloudWatch Synthetics You can use Amazon CloudWatch Synthetics to -// continually monitor your services. You can create and manage canaries, which are -// modular, lightweight scripts that monitor your endpoints and APIs from the -// outside-in. You can set up your canaries to run 24 hours a day, once per minute. -// The 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. 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) -// 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) -// . +// # Amazon CloudWatch Synthetics +// +// You can use Amazon CloudWatch Synthetics to continually monitor your services. +// You can create and manage canaries, which are modular, lightweight scripts that +// monitor your endpoints and APIs from the outside-in. You can set up your +// canaries to run 24 hours a day, once per minute. The 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. 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]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]. +// +// [Using ServiceLens to Monitor the Health of Your Applications]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ServiceLens.html +// [Security Considerations for Synthetics Canaries]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html package synthetics diff --git a/service/synthetics/options.go b/service/synthetics/options.go index 58706c4623f..fc605dea474 100644 --- a/service/synthetics/options.go +++ b/service/synthetics/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/synthetics/types/enums.go b/service/synthetics/types/enums.go index 938c00904c6..104ec7fcd5a 100644 --- a/service/synthetics/types/enums.go +++ b/service/synthetics/types/enums.go @@ -12,8 +12,9 @@ const ( ) // Values returns all known values for CanaryRunState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CanaryRunState) Values() []CanaryRunState { return []CanaryRunState{ "RUNNING", @@ -32,6 +33,7 @@ const ( // 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{ @@ -56,8 +58,9 @@ const ( ) // Values returns all known values for CanaryState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CanaryState) Values() []CanaryState { return []CanaryState{ "CREATING", @@ -91,8 +94,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INVALID_PERMISSIONS", @@ -119,8 +123,9 @@ const ( ) // Values returns all known values for EncryptionMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionMode) Values() []EncryptionMode { return []EncryptionMode{ "SSE_S3", diff --git a/service/synthetics/types/types.go b/service/synthetics/types/types.go index 83737e714d9..e958ee79311 100644 --- a/service/synthetics/types/types.go +++ b/service/synthetics/types/types.go @@ -14,8 +14,9 @@ type ArtifactConfigInput struct { // A structure that contains the configuration of the encryption-at-rest settings // 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) + // syn-nodejs-puppeteer-3.3 or later. For more information, see [Encrypting canary artifacts] + // + // [Encrypting canary artifacts]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_artifact_encryption.html S3Encryption *S3EncryptionConfig noSmithyDocumentSerde @@ -45,8 +46,9 @@ 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] + // + // [Editing or deleting a canary]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html IgnoreCoordinates []string noSmithyDocumentSerde @@ -68,9 +70,9 @@ type Canary struct { Code *CanaryCodeOutput // 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) - // . + // information about Lambda ARN format, see [Resources and Conditions for Lambda Actions]. + // + // [Resources and Conditions for Lambda 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 @@ -90,8 +92,9 @@ 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]. + // + // [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 @@ -119,8 +122,9 @@ 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]. + // + // [Running a Canary in a VPC]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html VpcConfig *VpcConfigOutput noSmithyDocumentSerde @@ -148,8 +152,9 @@ type CanaryCodeInput struct { // include s3:// as the start of the bucket name. 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) . + // The S3 key of your script. For more information, see [Working with Amazon S3 Objects]. + // + // [Working with Amazon S3 Objects]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html S3Key *string // The S3 version ID of your script. @@ -157,8 +162,9 @@ type CanaryCodeInput struct { // 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 + // 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. ZipFile []byte @@ -219,21 +225,28 @@ type CanaryRunConfigInput struct { // Specifies whether this canary is to use active X-Ray tracing when it runs. // 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. + // tracing enabled. Using X-Ray tracing incurs charges. For more information, see [Canaries and X-Ray tracing]. + // + // 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 ActiveTracing *bool // Specifies the keys and values to use for any environment variables used in the - // canary script. Use the following format: { "key1" : "value1", "key2" : "value2", - // ...} 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 + // canary script. Use the following format: + // + // { "key1" : "value1", "key2" : "value2", ...} + // + // 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]. + // + // The environment variables keys and values are not encrypted. Do not store // sensitive information in this field. + // + // [Runtime environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime EnvironmentVariables map[string]string // The maximum amount of memory available to the canary while it is running, in @@ -241,9 +254,10 @@ type CanaryRunConfigInput struct { MemoryInMB *int32 // How long the canary is allowed to run before it must stop. You can't set this - // time to be longer than the frequency of the runs of this canary. If you omit - // this field, the frequency of the canary is used as this value, up to a maximum - // of 14 minutes. + // time to be longer than the frequency of the runs of this canary. + // + // If you omit this field, the frequency of the canary is used as this value, up + // to a maximum of 14 minutes. TimeoutInSeconds *int32 noSmithyDocumentSerde @@ -298,16 +312,23 @@ 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]. + // + // [Scheduling canary runs using cron]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html // // This member is required. Expression *string @@ -330,15 +351,22 @@ 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]. + // + // [Scheduling canary runs using cron]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html Expression *string noSmithyDocumentSerde @@ -419,8 +447,9 @@ 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]. +// +// [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. @@ -432,22 +461,26 @@ type RuntimeVersion struct { // The date that the runtime version was released. 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) - // . + // The name of the runtime version. For a list of valid runtime versions, see [Canary Runtime Versions]. + // + // [Canary Runtime Versions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html VersionName *string noSmithyDocumentSerde } // 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) +// canary artifacts that the canary uploads to Amazon S3. +// +// For more information, see [Encrypting canary artifacts] +// +// [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 + // The encryption method to use for artifacts created by this canary. Specify // SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. // Specify SSE-KMS to use server-side encryption with a customer-managed KMS key. + // // If you omit this parameter, an Amazon Web Services-managed KMS key is used. EncryptionMode EncryptionMode @@ -460,18 +493,22 @@ type S3EncryptionConfig struct { // An object that specifies what screenshots to use as a baseline for visual // 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) +// 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]and [Visual monitoring blueprint] +// +// [Visual monitoring]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html +// [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) - // from any past run of this canary. + // of Id in the [CanaryRun] from any past run of this canary. + // + // [CanaryRun]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html // // This member is required. BaseCanaryRunId *string @@ -487,8 +524,10 @@ type VisualReferenceInput struct { // If this canary performs visual monitoring by comparing screenshots, this // structure contains the ID of the canary run that is used as the baseline for // screenshots, and the coordinates of any parts of those screenshots that are -// ignored during visual monitoring comparison. Visual monitoring is supported only -// on canaries running the syn-puppeteer-node-3.2 runtime or later. +// ignored during visual monitoring comparison. +// +// Visual monitoring is supported only on canaries running the +// syn-puppeteer-node-3.2 runtime or later. type VisualReferenceOutput struct { // The ID of the canary run that produced the baseline screenshots that are used @@ -504,8 +543,9 @@ 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]. +// +// [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. @@ -519,8 +559,9 @@ 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]. +// +// [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_op_AnalyzeDocument.go b/service/textract/api_op_AnalyzeDocument.go index b742fddb0d9..cb7a7078831 100644 --- a/service/textract/api_op_AnalyzeDocument.go +++ b/service/textract/api_op_AnalyzeDocument.go @@ -11,24 +11,31 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. @@ -36,11 +43,18 @@ import ( // 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) -// . +// 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]. +// +// [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{} @@ -60,9 +74,10 @@ type AnalyzeDocumentInput struct { // The input document as base64-encoded bytes or an Amazon S3 object. If you use // the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The - // document must be an image in JPEG, PNG, PDF, or TIFF format. If you're using an - // AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes - // that are passed using the Bytes field. + // document must be an image in JPEG, PNG, PDF, or TIFF format. + // + // If you're using an AWS SDK to call Amazon Textract, you might not need to + // base64-encode image bytes that are passed using the Bytes field. // // This member is required. Document *types.Document diff --git a/service/textract/api_op_AnalyzeExpense.go b/service/textract/api_op_AnalyzeExpense.go index 87fc05ab153..e02d0acb644 100644 --- a/service/textract/api_op_AnalyzeExpense.go +++ b/service/textract/api_op_AnalyzeExpense.go @@ -12,10 +12,13 @@ import ( ) // AnalyzeExpense synchronously analyzes an input document for financially related -// relationships between text. Information is returned as ExpenseDocuments and -// seperated as follows: +// 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. func (c *Client) AnalyzeExpense(ctx context.Context, params *AnalyzeExpenseInput, optFns ...func(*Options)) (*AnalyzeExpenseOutput, error) { @@ -35,20 +38,27 @@ func (c *Client) AnalyzeExpense(ctx context.Context, params *AnalyzeExpenseInput 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. + // 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. // // This member is required. Document *types.Document diff --git a/service/textract/api_op_CreateAdapterVersion.go b/service/textract/api_op_CreateAdapterVersion.go index e7735e09ab3..7f66914abb5 100644 --- a/service/textract/api_op_CreateAdapterVersion.go +++ b/service/textract/api_op_CreateAdapterVersion.go @@ -44,22 +44,28 @@ type CreateAdapterVersionInput struct { DatasetConfig *types.AdapterVersionDatasetConfig // Sets whether or not your output will go to a user created bucket. Used to set - // the name of the bucket, and the prefix on the output file. OutputConfig is an - // optional parameter which lets you adjust where your output will be placed. By - // default, Amazon Textract will store the results internally and can only be - // accessed by the Get API operations. With OutputConfig enabled, you can set the - // name of the bucket the output will be sent to the file prefix of the results - // where you can download your results. Additionally, you can set the KMSKeyID - // parameter to a customer master key (CMK) to encrypt your output. Without this - // parameter set Amazon Textract will encrypt server-side using the AWS managed CMK - // for Amazon S3. Decryption of Customer Content is necessary for processing of the - // documents by Amazon Textract. If your account is opted out under an AI services - // 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/) - // . + // the name of the bucket, and the prefix on the output file. + // + // OutputConfig is an optional parameter which lets you adjust where your output + // will be placed. By default, Amazon Textract will store the results internally + // and can only be accessed by the Get API operations. With OutputConfig enabled, + // you can set the name of the bucket the output will be sent to the file prefix of + // the results where you can download your results. Additionally, you can set the + // KMSKeyID parameter to a customer master key (CMK) to encrypt your output. + // Without this parameter set Amazon Textract will encrypt server-side using the + // AWS managed CMK for Amazon S3. + // + // Decryption of Customer Content is necessary for processing of the documents by + // Amazon Textract. If your account is opted out under an AI services 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.] + // + // For more information on data privacy, see the [Data Privacy FAQ]. + // + // [Managing AI services opt-out policy.]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html + // [Data Privacy FAQ]: https://aws.amazon.com/compliance/data-privacy-faq/ // // This member is required. OutputConfig *types.OutputConfig diff --git a/service/textract/api_op_DetectDocumentText.go b/service/textract/api_op_DetectDocumentText.go index 2faa2f347a2..eb03056633e 100644 --- a/service/textract/api_op_DetectDocumentText.go +++ b/service/textract/api_op_DetectDocumentText.go @@ -14,14 +14,19 @@ import ( // 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) -// . +// returns the detected text in an array of Blockobjects. +// +// 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]. +// +// [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{} @@ -41,9 +46,10 @@ type DetectDocumentTextInput struct { // The input document as base64-encoded bytes or an Amazon S3 object. If you use // the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The - // document must be an image in JPEG or PNG format. If you're using an AWS SDK to - // call Amazon Textract, you might not need to base64-encode image bytes that are - // passed using the Bytes field. + // document must be an image in JPEG or PNG format. + // + // If you're using an AWS SDK to call Amazon Textract, you might not need to + // base64-encode image bytes that are passed using the Bytes field. // // This member is required. Document *types.Document diff --git a/service/textract/api_op_GetAdapterVersion.go b/service/textract/api_op_GetAdapterVersion.go index c3c8b199985..d806ac766c9 100644 --- a/service/textract/api_op_GetAdapterVersion.go +++ b/service/textract/api_op_GetAdapterVersion.go @@ -73,22 +73,28 @@ type GetAdapterVersionOutput struct { KMSKeyId *string // Sets whether or not your output will go to a user created bucket. Used to set - // the name of the bucket, and the prefix on the output file. OutputConfig is an - // optional parameter which lets you adjust where your output will be placed. By - // default, Amazon Textract will store the results internally and can only be - // accessed by the Get API operations. With OutputConfig enabled, you can set the - // name of the bucket the output will be sent to the file prefix of the results - // where you can download your results. Additionally, you can set the KMSKeyID - // parameter to a customer master key (CMK) to encrypt your output. Without this - // parameter set Amazon Textract will encrypt server-side using the AWS managed CMK - // for Amazon S3. Decryption of Customer Content is necessary for processing of the - // documents by Amazon Textract. If your account is opted out under an AI services - // 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/) - // . + // the name of the bucket, and the prefix on the output file. + // + // OutputConfig is an optional parameter which lets you adjust where your output + // will be placed. By default, Amazon Textract will store the results internally + // and can only be accessed by the Get API operations. With OutputConfig enabled, + // you can set the name of the bucket the output will be sent to the file prefix of + // the results where you can download your results. Additionally, you can set the + // KMSKeyID parameter to a customer master key (CMK) to encrypt your output. + // Without this parameter set Amazon Textract will encrypt server-side using the + // AWS managed CMK for Amazon S3. + // + // Decryption of Customer Content is necessary for processing of the documents by + // Amazon Textract. If your account is opted out under an AI services 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.] + // + // For more information on data privacy, see the [Data Privacy FAQ]. + // + // [Managing AI services opt-out policy.]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html + // [Data Privacy FAQ]: https://aws.amazon.com/compliance/data-privacy-faq/ OutputConfig *types.OutputConfig // The status of the adapter version that has been requested. diff --git a/service/textract/api_op_GetDocumentAnalysis.go b/service/textract/api_op_GetDocumentAnalysis.go index ad5c064fe47..4527f922d1c 100644 --- a/service/textract/api_op_GetDocumentAnalysis.go +++ b/service/textract/api_op_GetDocumentAnalysis.go @@ -12,28 +12,36 @@ 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 -// 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 -// 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 . +// text in a document. +// +// You start asynchronous text analysis by calling 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 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 . +// // 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. +// +// - 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. @@ -41,17 +49,22 @@ import ( // 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 -// 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) -// . +// 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 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]. +// +// [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{} diff --git a/service/textract/api_op_GetDocumentTextDetection.go b/service/textract/api_op_GetDocumentTextDetection.go index 66b5be5a5af..51110994409 100644 --- a/service/textract/api_op_GetDocumentTextDetection.go +++ b/service/textract/api_op_GetDocumentTextDetection.go @@ -13,27 +13,34 @@ import ( // 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 -// 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) -// . +// 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 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]. +// +// [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{} diff --git a/service/textract/api_op_GetExpenseAnalysis.go b/service/textract/api_op_GetExpenseAnalysis.go index a891b2285d6..689bc9a9012 100644 --- a/service/textract/api_op_GetExpenseAnalysis.go +++ b/service/textract/api_op_GetExpenseAnalysis.go @@ -13,23 +13,27 @@ 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 -// analysis, Amazon Textract publishes the completion status to the Amazon Simple +// 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 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 // 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 -// 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 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) -// . +// 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 operation response contains a pagination token for getting the next set +// of 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]. +// +// [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{} diff --git a/service/textract/api_op_GetLendingAnalysis.go b/service/textract/api_op_GetLendingAnalysis.go index 84b8ce1d85f..b187d8c630a 100644 --- a/service/textract/api_op_GetLendingAnalysis.go +++ b/service/textract/api_op_GetLendingAnalysis.go @@ -12,14 +12,18 @@ 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 -// 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 -// 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 . +// text in a lending document. +// +// You start asynchronous text analysis by calling 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 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 . func (c *Client) GetLendingAnalysis(ctx context.Context, params *GetLendingAnalysisInput, optFns ...func(*Options)) (*GetLendingAnalysisOutput, error) { if params == nil { params = &GetLendingAnalysisInput{} @@ -58,13 +62,13 @@ type GetLendingAnalysisInput struct { type GetLendingAnalysisOutput struct { - // The current model version of the Analyze Lending API. + // The current model version of the Analyze Lending API. AnalyzeLendingModelVersion *string // Information about the input document. DocumentMetadata *types.DocumentMetadata - // The current status of the lending analysis job. + // The current status of the lending analysis job. JobStatus types.JobStatus // If the response is truncated, Amazon Textract returns this token. You can use @@ -72,15 +76,15 @@ type GetLendingAnalysisOutput struct { // results. NextToken *string - // Holds the information returned by one of AmazonTextract's document analysis + // Holds the information returned by one of AmazonTextract's document analysis // operations for the pinstripe. Results []types.LendingResult - // Returns if the lending analysis job could not be completed. Contains + // 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. + // A list of warnings that occurred during the lending analysis operation. Warnings []types.Warning // Metadata pertaining to the operation's result. diff --git a/service/textract/api_op_GetLendingAnalysisSummary.go b/service/textract/api_op_GetLendingAnalysisSummary.go index e977a83e00f..450181dd6f8 100644 --- a/service/textract/api_op_GetLendingAnalysisSummary.go +++ b/service/textract/api_op_GetLendingAnalysisSummary.go @@ -15,14 +15,18 @@ import ( // text in a lending document. The returned summary consists of information about // 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 -// 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 -// 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 . +// type of grouped document. +// +// You start asynchronous text analysis by calling 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 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 . func (c *Client) GetLendingAnalysisSummary(ctx context.Context, params *GetLendingAnalysisSummaryInput, optFns ...func(*Options)) (*GetLendingAnalysisSummaryOutput, error) { if params == nil { params = &GetLendingAnalysisSummaryInput{} @@ -40,7 +44,7 @@ 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 + // 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. @@ -57,14 +61,14 @@ type GetLendingAnalysisSummaryOutput struct { // Information about the input document. DocumentMetadata *types.DocumentMetadata - // The current status of the lending analysis job. + // 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. StatusMessage *string - // Contains summary information for documents grouped by type. + // Contains summary information for documents grouped by type. Summary *types.LendingSummary // A list of warnings that occurred during the lending analysis operation. diff --git a/service/textract/api_op_StartDocumentAnalysis.go b/service/textract/api_op_StartDocumentAnalysis.go index 45d23b8cbbe..f7584a1c3cd 100644 --- a/service/textract/api_op_StartDocumentAnalysis.go +++ b/service/textract/api_op_StartDocumentAnalysis.go @@ -13,18 +13,22 @@ import ( // Starts the asynchronous analysis of an input document for relationships between // detected items such as key-value pairs, tables, and selection elements. -// 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 can analyze text in documents that are in JPEG, PNG, +// TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocationto +// specify the bucket name and file name of the document. +// // 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 // 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]. +// +// [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{} @@ -63,9 +67,9 @@ type StartDocumentAnalysisInput struct { // 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) - // . + // accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations]. + // + // [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 diff --git a/service/textract/api_op_StartDocumentTextDetection.go b/service/textract/api_op_StartDocumentTextDetection.go index 56b7e107ad4..7063cfc04d8 100644 --- a/service/textract/api_op_StartDocumentTextDetection.go +++ b/service/textract/api_op_StartDocumentTextDetection.go @@ -13,18 +13,22 @@ import ( // Starts the asynchronous detection of text in a document. Amazon Textract can // detect lines of text and the words that make up a line of text. +// // 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. +// TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocationto +// specify the bucket name and file name of the document. +// // 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 // 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]. +// +// [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{} @@ -50,9 +54,9 @@ 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) - // . + // accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations]. + // + // [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 diff --git a/service/textract/api_op_StartExpenseAnalysis.go b/service/textract/api_op_StartExpenseAnalysis.go index b6640a4b1df..0bae0712611 100644 --- a/service/textract/api_op_StartExpenseAnalysis.go +++ b/service/textract/api_op_StartExpenseAnalysis.go @@ -12,20 +12,25 @@ 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. +// 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 // 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]. +// +// [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{} @@ -51,8 +56,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) + // accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations] + // + // [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 diff --git a/service/textract/api_op_StartLendingAnalysis.go b/service/textract/api_op_StartLendingAnalysis.go index 1bbe48c8422..055cbf7856d 100644 --- a/service/textract/api_op_StartLendingAnalysis.go +++ b/service/textract/api_op_StartLendingAnalysis.go @@ -14,9 +14,12 @@ 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. +// 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 @@ -24,11 +27,16 @@ import ( // 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: +// 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 { @@ -48,8 +56,10 @@ func (c *Client) StartLendingAnalysis(ctx context.Context, params *StartLendingA type StartLendingAnalysisInput struct { // The Amazon S3 bucket that contains the document to be processed. It's used by - // asynchronous operations. The input document can be an image file in JPEG or PNG - // format. It can also be a file in PDF format. + // asynchronous operations. + // + // The input document can be an image file in JPEG or PNG format. It can also be a + // file in PDF format. // // This member is required. DocumentLocation *types.DocumentLocation @@ -57,9 +67,9 @@ 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) - // . + // accidentally started more than once. For more information, see [Calling Amazon Textract Asynchronous Operations]. + // + // [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 @@ -80,22 +90,28 @@ type StartLendingAnalysisInput struct { NotificationChannel *types.NotificationChannel // Sets whether or not your output will go to a user created bucket. Used to set - // the name of the bucket, and the prefix on the output file. OutputConfig is an - // optional parameter which lets you adjust where your output will be placed. By - // default, Amazon Textract will store the results internally and can only be - // accessed by the Get API operations. With OutputConfig enabled, you can set the - // name of the bucket the output will be sent to the file prefix of the results - // where you can download your results. Additionally, you can set the KMSKeyID - // parameter to a customer master key (CMK) to encrypt your output. Without this - // parameter set Amazon Textract will encrypt server-side using the AWS managed CMK - // for Amazon S3. Decryption of Customer Content is necessary for processing of the - // documents by Amazon Textract. If your account is opted out under an AI services - // 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/) - // . + // the name of the bucket, and the prefix on the output file. + // + // OutputConfig is an optional parameter which lets you adjust where your output + // will be placed. By default, Amazon Textract will store the results internally + // and can only be accessed by the Get API operations. With OutputConfig enabled, + // you can set the name of the bucket the output will be sent to the file prefix of + // the results where you can download your results. Additionally, you can set the + // KMSKeyID parameter to a customer master key (CMK) to encrypt your output. + // Without this parameter set Amazon Textract will encrypt server-side using the + // AWS managed CMK for Amazon S3. + // + // Decryption of Customer Content is necessary for processing of the documents by + // Amazon Textract. If your account is opted out under an AI services 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.] + // + // For more information on data privacy, see the [Data Privacy FAQ]. + // + // [Managing AI services opt-out policy.]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html + // [Data Privacy FAQ]: https://aws.amazon.com/compliance/data-privacy-faq/ OutputConfig *types.OutputConfig noSmithyDocumentSerde diff --git a/service/textract/options.go b/service/textract/options.go index 3196d15dc46..ff06073450a 100644 --- a/service/textract/options.go +++ b/service/textract/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/textract/types/enums.go b/service/textract/types/enums.go index 513ba340f9d..cc7b3090b07 100644 --- a/service/textract/types/enums.go +++ b/service/textract/types/enums.go @@ -14,8 +14,9 @@ const ( ) // Values returns all known values for AdapterVersionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdapterVersionStatus) Values() []AdapterVersionStatus { return []AdapterVersionStatus{ "ACTIVE", @@ -35,8 +36,9 @@ const ( ) // Values returns all known values for AutoUpdate. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AutoUpdate) Values() []AutoUpdate { return []AutoUpdate{ "ENABLED", @@ -75,8 +77,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -115,8 +118,9 @@ const ( ) // Values returns all known values for ContentClassifier. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentClassifier) Values() []ContentClassifier { return []ContentClassifier{ "FreeOfPersonallyIdentifiableInformation", @@ -140,8 +144,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "KEY", @@ -168,8 +173,9 @@ const ( ) // Values returns all known values for FeatureType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FeatureType) Values() []FeatureType { return []FeatureType{ "TABLES", @@ -191,8 +197,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -218,8 +225,9 @@ const ( ) // Values returns all known values for RelationshipType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelationshipType) Values() []RelationshipType { return []RelationshipType{ "VALUE", @@ -243,8 +251,9 @@ const ( ) // Values returns all known values for SelectionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SelectionStatus) Values() []SelectionStatus { return []SelectionStatus{ "SELECTED", @@ -261,8 +270,9 @@ const ( ) // Values returns all known values for TextType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextType) Values() []TextType { return []TextType{ "HANDWRITING", @@ -278,8 +288,9 @@ const ( ) // 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. +// in the future, and so 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 6f500a2dba6..96c16b537d3 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 @@ -243,7 +243,8 @@ func (e *InvalidJobIdException) ErrorCode() string { } func (e *InvalidJobIdException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Indicates you do not have decrypt permissions with the KMS key entered, or the +// Indicates you do not have decrypt permissions with the KMS key entered, or the +// // KMS key was entered incorrectly. type InvalidKMSKeyException struct { Message *string @@ -304,8 +305,10 @@ 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]For troubleshooting information, see [Troubleshooting Amazon S3] +// +// [Troubleshooting Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html +// [Configure Access to Amazon S3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html type InvalidS3ObjectException struct { Message *string diff --git a/service/textract/types/types.go b/service/textract/types/types.go index 768424dc934..1b77c5a681c 100644 --- a/service/textract/types/types.go +++ b/service/textract/types/types.go @@ -24,13 +24,17 @@ type Adapter struct { // Pages is a parameter that the user inputs to specify which pages to apply an // adapter 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. + // + // - 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 @@ -73,10 +77,13 @@ type AdaptersConfig struct { // include an Amazon S3 bucket if specified. type AdapterVersionDatasetConfig struct { - // The S3 bucket name and file name that identifies the document. The AWS Region - // for the S3 bucket that contains the document must match the Region that you use - // for Amazon Textract operations. For Amazon Textract to process a file in an S3 - // bucket, the user must have permission to access the S3 bucket and file. + // The S3 bucket name and file name that identifies the document. + // + // The AWS Region for the S3 bucket that contains the document must match the + // Region that you use for Amazon Textract operations. + // + // For Amazon Textract to process a file in an S3 bucket, the user must have + // permission to access the S3 bucket and file. ManifestS3Object *S3Object noSmithyDocumentSerde @@ -144,68 +151,99 @@ 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 -// 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 , -// 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) -// . +// 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 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, 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]. +// +// [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 confidence 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. + // // The following BlockTypes are only returned for Amazon Textract Layout. + // // - LAYOUT_TITLE - The main title of the document. + // // - LAYOUT_HEADER - Text located in the top margin of the document. + // // - LAYOUT_FOOTER - Text located in the bottom margin of the document. + // // - LAYOUT_SECTION_HEADER - The titles of sections within a document. + // // - LAYOUT_PAGE_NUMBER - The page number of the documents. + // // - LAYOUT_LIST - Any information grouped together in list form. + // // - LAYOUT_FIGURE - Indicates the location of an image in a document. + // // - LAYOUT_TABLE - Indicates the location of a table in the document. + // // - LAYOUT_KEY_VALUE - Indicates the location of form key-values in a document. + // // - LAYOUT_TEXT - Text that is present typically as a part of paragraphs in // documents. BlockType BlockType @@ -222,23 +260,35 @@ type Block struct { // text and the accuracy of the geometry points around the recognized text. Confidence *float32 - // The type of entity. The following entity types can be returned by FORMS - // analysis: + // 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. + // // 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 . EntityTypes []EntityType @@ -295,13 +345,16 @@ type Block struct { // cell, or selection element on a document 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). +// // The top and left values returned are ratios of the overall document page size. // For example, if the input image is 700 x 200 pixels, and the top-left coordinate // of the bounding box is 350 x 50 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 document -// page dimension. For example, if the document page size is 700 x 200 pixels, and -// the bounding box width is 70 pixels, the width returned is 0.1. +// (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 document page dimension. For example, if the document page +// size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width +// returned is 0.1. type BoundingBox struct { // The height of the bounding box as a ratio of the overall document page height. @@ -330,26 +383,35 @@ type DetectedSignature struct { noSmithyDocumentSerde } -// 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. +// 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. type Document struct { // A blob of base64-encoded document bytes. The maximum size of a document that's // provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG - // format. If you're using an AWS SDK to call Amazon Textract, you might not need - // to base64-encode image bytes passed using the Bytes field. + // format. + // + // If you're using an AWS SDK to call Amazon Textract, you might not need to + // base64-encode image bytes passed using the Bytes field. Bytes []byte // Identifies an S3 object as the document source. The maximum size of a document @@ -369,9 +431,10 @@ type DocumentGroup struct { // logical boundary. 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) - // for a list of all types returned by Textract. + // The type of document that Amazon Textract has detected. See [Analyze Lending Response Objects] for a list of all + // types returned by Textract. + // + // [Analyze Lending Response Objects]: https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html Type *string // A list of any expected signatures not found in a document group. @@ -381,8 +444,10 @@ type DocumentGroup struct { } // The Amazon S3 bucket that contains the document to be processed. It's used by -// asynchronous operations. The input document can be an image file in JPEG or PNG -// format. It can also be a file in PDF format. +// asynchronous operations. +// +// The input document can be an image file in JPEG or PNG format. It can also be a +// file in PDF format. type DocumentLocation struct { // The Amazon S3 bucket that contains the input document. @@ -419,17 +484,29 @@ type EvaluationMetric 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 Code *string @@ -777,22 +854,28 @@ type NotificationChannel struct { } // Sets whether or not your output will go to a user created bucket. Used to set -// the name of the bucket, and the prefix on the output file. OutputConfig is an -// optional parameter which lets you adjust where your output will be placed. By -// default, Amazon Textract will store the results internally and can only be -// accessed by the Get API operations. With OutputConfig enabled, you can set the -// name of the bucket the output will be sent to the file prefix of the results -// where you can download your results. Additionally, you can set the KMSKeyID -// parameter to a customer master key (CMK) to encrypt your output. Without this -// parameter set Amazon Textract will encrypt server-side using the AWS managed CMK -// for Amazon S3. Decryption of Customer Content is necessary for processing of the -// documents by Amazon Textract. If your account is opted out under an AI services -// 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/) -// . +// the name of the bucket, and the prefix on the output file. +// +// OutputConfig is an optional parameter which lets you adjust where your output +// will be placed. By default, Amazon Textract will store the results internally +// and can only be accessed by the Get API operations. With OutputConfig enabled, +// you can set the name of the bucket the output will be sent to the file prefix of +// the results where you can download your results. Additionally, you can set the +// KMSKeyID parameter to a customer master key (CMK) to encrypt your output. +// Without this parameter set Amazon Textract will encrypt server-side using the +// AWS managed CMK for Amazon S3. +// +// Decryption of Customer Content is necessary for processing of the documents by +// Amazon Textract. If your account is opted out under an AI services 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.] +// +// For more information on data privacy, see the [Data Privacy FAQ]. +// +// [Managing AI services opt-out policy.]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html +// [Data Privacy FAQ]: https://aws.amazon.com/compliance/data-privacy-faq/ type OutputConfig struct { // The name of the bucket your output will go to. @@ -812,7 +895,7 @@ type OutputConfig struct { // number that the Page object was detected on. type PageClassification struct { - // The page number the value was detected on, relative to Amazon Textract's + // The page number the value was detected on, relative to Amazon Textract's // starting position. // // This member is required. @@ -830,10 +913,11 @@ type PageClassification struct { // The X and Y coordinates of a point on a document page. The X and Y values that // 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 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. type Point struct { // The value of the X coordinate for a point on a Polygon . @@ -884,13 +968,17 @@ 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. + // + // - 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 @@ -899,9 +987,11 @@ type Query struct { } // 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 @@ -913,16 +1003,22 @@ type Relationship struct { // // - 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 @@ -930,10 +1026,13 @@ type Relationship struct { noSmithyDocumentSerde } -// The S3 bucket name and file name that identifies the document. The AWS Region -// for the S3 bucket that contains the document must match the Region that you use -// for Amazon Textract operations. For Amazon Textract to process a file in an S3 -// bucket, the user must have permission to access the S3 bucket and file. +// The S3 bucket name and file name that identifies the document. +// +// The AWS Region for the S3 bucket that contains the document must match the +// Region that you use for Amazon Textract operations. +// +// For Amazon Textract to process a file in an S3 bucket, the user must have +// permission to access the S3 bucket and file. type S3Object struct { // The name of the S3 bucket. Note that the # character is not valid in the file @@ -988,9 +1087,8 @@ 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/timestreaminfluxdb/api_op_CreateDbInstance.go b/service/timestreaminfluxdb/api_op_CreateDbInstance.go index 165e43682dc..59d3505ff40 100644 --- a/service/timestreaminfluxdb/api_op_CreateDbInstance.go +++ b/service/timestreaminfluxdb/api_op_CreateDbInstance.go @@ -79,10 +79,14 @@ type CreateDbInstanceInput struct { DbParameterGroupIdentifier *string // The Timestream for InfluxDB DB storage type to read and write InfluxDB data. + // // You can choose between 3 different types of provisioned Influx IOPS included // storage according to your workloads requirements: + // // - Influx IO Included 3000 IOPS + // // - Influx IO Included 12000 IOPS + // // - Influx IO Included 16000 IOPS DbStorageType types.DbStorageType diff --git a/service/timestreaminfluxdb/options.go b/service/timestreaminfluxdb/options.go index 4d418f0df61..0444badf2ec 100644 --- a/service/timestreaminfluxdb/options.go +++ b/service/timestreaminfluxdb/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/timestreaminfluxdb/types/enums.go b/service/timestreaminfluxdb/types/enums.go index 33ad7287bf2..dddc214d3a4 100644 --- a/service/timestreaminfluxdb/types/enums.go +++ b/service/timestreaminfluxdb/types/enums.go @@ -17,8 +17,9 @@ const ( ) // Values returns all known values for DbInstanceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DbInstanceType) Values() []DbInstanceType { return []DbInstanceType{ "db.influx.medium", @@ -42,8 +43,9 @@ const ( ) // Values returns all known values for DbStorageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DbStorageType) Values() []DbStorageType { return []DbStorageType{ "InfluxIOIncludedT1", @@ -61,8 +63,9 @@ const ( ) // Values returns all known values for DeploymentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeploymentType) Values() []DeploymentType { return []DeploymentType{ "SINGLE_AZ", @@ -80,8 +83,9 @@ const ( ) // Values returns all known values for LogLevel. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogLevel) Values() []LogLevel { return []LogLevel{ "debug", @@ -104,8 +108,9 @@ const ( ) // Values returns all known values for Status. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Status) Values() []Status { return []Status{ "CREATING", @@ -127,8 +132,9 @@ const ( ) // Values returns all known values for TracingType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TracingType) Values() []TracingType { return []TracingType{ "log", @@ -146,6 +152,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/timestreaminfluxdb/types/types.go b/service/timestreaminfluxdb/types/types.go index 15a77b296c7..e95fc9539e8 100644 --- a/service/timestreaminfluxdb/types/types.go +++ b/service/timestreaminfluxdb/types/types.go @@ -73,29 +73,42 @@ type DbParameterGroupSummary struct { // All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB. type InfluxDBv2Parameters struct { - // Include option to show detailed logs for Flux queries. Default: false + // Include option to show detailed logs for Flux queries. + // + // Default: false FluxLogEnabled *bool // Log output level. InfluxDB outputs log entries with severity levels greater - // than or equal to the level specified. Default: info + // than or equal to the level specified. + // + // Default: info LogLevel LogLevel - // Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics (https://docs.influxdata.com/influxdb/v2/reference/internals/metrics/) - // . Default: false + // Disable the HTTP /metrics endpoint which exposes [internal InfluxDB metrics]. + // + // Default: false + // + // [internal InfluxDB metrics]: https://docs.influxdata.com/influxdb/v2/reference/internals/metrics/ MetricsDisabled *bool // Disable the task scheduler. If problematic tasks prevent InfluxDB from // starting, use this option to start InfluxDB without scheduling or executing - // tasks. Default: false + // tasks. + // + // Default: false NoTasks *bool // Number of queries allowed to execute concurrently. Setting to 0 allows an - // unlimited number of concurrent queries. Default: 0 + // unlimited number of concurrent queries. + // + // Default: 0 QueryConcurrency *int32 // Maximum number of queries allowed in execution queue. When queue limit is // reached, new queries are rejected. Setting to 0 allows an unlimited number of - // queries in the queue. Default: 0 + // queries in the queue. + // + // Default: 0 QueryQueueSize *int32 // Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled diff --git a/service/timestreamquery/api_op_CancelQuery.go b/service/timestreamquery/api_op_CancelQuery.go index 61a0b9fd51b..d99f783aca2 100644 --- a/service/timestreamquery/api_op_CancelQuery.go +++ b/service/timestreamquery/api_op_CancelQuery.go @@ -11,12 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a query that has been issued. Cancellation is provided only if the +// 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. +// already been canceled. See [code sample]for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optFns ...func(*Options)) (*CancelQueryOutput, error) { if params == nil { params = &CancelQueryInput{} @@ -34,7 +36,7 @@ func (c *Client) CancelQuery(ctx context.Context, params *CancelQueryInput, optF type CancelQueryInput struct { - // The ID of the query that needs to be cancelled. QueryID is returned as part of + // The ID of the query that needs to be cancelled. QueryID is returned as part of // the query result. // // This member is required. @@ -45,7 +47,7 @@ type CancelQueryInput struct { type CancelQueryOutput struct { - // A CancellationMessage is returned when a CancelQuery request for the query + // A CancellationMessage is returned when a CancelQuery request for the query // specified by QueryId has already been issued. CancellationMessage *string diff --git a/service/timestreamquery/api_op_CreateScheduledQuery.go b/service/timestreamquery/api_op_CreateScheduledQuery.go index 84eb7cebb1c..4ee8858ce33 100644 --- a/service/timestreamquery/api_op_CreateScheduledQuery.go +++ b/service/timestreamquery/api_op_CreateScheduledQuery.go @@ -12,7 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a scheduled query that will be run on your behalf at the configured +// Create a scheduled query that will be run on your behalf at the configured +// // schedule. Timestream assumes the execution role provided as part of the // ScheduledQueryExecutionRoleArn parameter to run the query. You can use the // NotificationConfiguration parameter to configure notification for your scheduled @@ -55,12 +56,13 @@ type CreateScheduledQueryInput struct { // The query string to run. Parameter names can be specified in the query string @ // character followed by an identifier. The named Parameter @scheduled_runtime is // reserved and can be used in the query to get the time at which the query is - // scheduled to run. The timestamp calculated according to the - // ScheduleConfiguration parameter, will be the value of @scheduled_runtime - // paramater for each query run. For example, consider an instance of a scheduled - // query executing on 2021-12-01 00:00:00. For this instance, the - // @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 - // when invoking the query. + // scheduled to run. + // + // The timestamp calculated according to the ScheduleConfiguration parameter, will + // be the value of @scheduled_runtime paramater for each query run. For example, + // consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For + // this instance, the @scheduled_runtime parameter is initialized to the timestamp + // 2021-12-01 00:00:00 when invoking the query. // // This member is required. QueryString *string @@ -80,8 +82,10 @@ 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. ClientToken *string @@ -90,8 +94,10 @@ type CreateScheduledQueryInput struct { // 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. + // 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_DescribeAccountSettings.go b/service/timestreamquery/api_op_DescribeAccountSettings.go index 4b03b5061f0..410cebd50f6 100644 --- a/service/timestreamquery/api_op_DescribeAccountSettings.go +++ b/service/timestreamquery/api_op_DescribeAccountSettings.go @@ -14,6 +14,7 @@ import ( // Describes the settings for your account that include the query pricing model // and the configured maximum TCUs the service can use for your query workload. +// // You're charged only for the duration of compute units used for your workloads. func (c *Client) DescribeAccountSettings(ctx context.Context, params *DescribeAccountSettingsInput, optFns ...func(*Options)) (*DescribeAccountSettingsOutput, error) { if params == nil { @@ -36,8 +37,10 @@ type DescribeAccountSettingsInput struct { type DescribeAccountSettingsOutput struct { - // The maximum number of Timestream compute units (https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html) - // (TCUs) the service will use at any point in time to serve your queries. + // The maximum number of [Timestream compute units] (TCUs) the service will use at any point in time to + // serve your queries. + // + // [Timestream compute units]: https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html MaxQueryTCU *int32 // The pricing model for queries in your account. diff --git a/service/timestreamquery/api_op_DescribeEndpoints.go b/service/timestreamquery/api_op_DescribeEndpoints.go index 40bb47125e7..28e3e0dae1d 100644 --- a/service/timestreamquery/api_op_DescribeEndpoints.go +++ b/service/timestreamquery/api_op_DescribeEndpoints.go @@ -12,19 +12,24 @@ import ( ) // DescribeEndpoints returns a list of available endpoints to make Timestream API -// calls against. This API is available through both Write and Query. Because the -// 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) +// calls against. This API is available through both Write and Query. +// +// Because the 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] +// // - 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) -// . +// DescribeEndpoints, see [The Endpoint Discovery Pattern]. +// +// [The Endpoint Discovery Pattern]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery +// [VPC endpoints (Amazon Web Services PrivateLink) with Timestream]: https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints 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 27aadeb3c20..e09f770689c 100644 --- a/service/timestreamquery/api_op_ListScheduledQueries.go +++ b/service/timestreamquery/api_op_ListScheduledQueries.go @@ -37,7 +37,7 @@ type ListScheduledQueriesInput struct { // to the subsequent call to ListScheduledQueriesRequest . MaxResults *int32 - // A pagination token to resume pagination. + // A pagination token to resume pagination. NextToken *string noSmithyDocumentSerde diff --git a/service/timestreamquery/api_op_Query.go b/service/timestreamquery/api_op_Query.go index 8ac507f7ed1..c6d7c0cdbf3 100644 --- a/service/timestreamquery/api_op_Query.go +++ b/service/timestreamquery/api_op_Query.go @@ -14,20 +14,30 @@ 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) -// for details. Your query request will fail in the following cases: +// the default timeout in the SDK to support a timeout of 60 seconds. See the [code sample]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. +// 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. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error) { if params == nil { params = &QueryInput{} @@ -45,58 +55,74 @@ func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(* type QueryInput struct { - // The query to be run by Timestream. + // The query to be run by Timestream. // // This member is required. QueryString *string - // Unique, case-sensitive string of up to 64 ASCII characters specified when a + // Unique, case-sensitive string of up to 64 ASCII characters specified when a // Query request is made. Providing a ClientToken makes the call to Query // idempotent. This means that running the same query repeatedly will produce the // 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. 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 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. + // 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 + // 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 - // of Query is assumed to be a new query run. Note the following when using - // NextToken in a query: + // 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 @@ -108,22 +134,22 @@ type QueryInput struct { type QueryOutput struct { - // The column data types of the returned result set. + // The column data types of the returned result set. // // This member is required. ColumnInfo []types.ColumnInfo - // A unique ID for the given query. + // A unique ID for the given query. // // This member is required. QueryId *string - // The result set rows returned by the query. + // The result set rows returned by the query. // // This member is required. Rows []types.Row - // A pagination token that can be used again on a Query call to get the next set + // A pagination token that can be used again on a Query call to get the next set // of results. NextToken *string @@ -282,17 +308,22 @@ var _ QueryAPIClient = (*Client)(nil) // QueryPaginatorOptions is the paginator options for Query 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 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. + // 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/api_op_UpdateAccountSettings.go b/service/timestreamquery/api_op_UpdateAccountSettings.go index 63b261a4f1f..d9d5681e8b0 100644 --- a/service/timestreamquery/api_op_UpdateAccountSettings.go +++ b/service/timestreamquery/api_op_UpdateAccountSettings.go @@ -15,8 +15,10 @@ import ( // Transitions your account to use TCUs for query pricing and modifies the maximum // query compute units that you've configured. If you reduce the value of // MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to -// be effective. After you've transitioned your account to use TCUs for query -// pricing, you can't transition to using bytes scanned for query pricing. +// be effective. +// +// After you've transitioned your account to use TCUs for query pricing, you can't +// transition to using bytes scanned for query pricing. func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error) { if params == nil { params = &UpdateAccountSettingsInput{} @@ -37,10 +39,13 @@ type UpdateAccountSettingsInput struct { // The maximum number of compute units the service will use at any point in time // to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. // You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, - // 32, and so on. The maximum value supported for MaxQueryTCU is 1000. To request - // an increase to this soft limit, contact Amazon Web Services Support. For - // information about the default quota for maxQueryTCU, see Default quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default) - // . + // 32, and so on. + // + // The maximum value supported for MaxQueryTCU is 1000. To request an increase to + // this soft limit, contact Amazon Web Services Support. For information about the + // default quota for maxQueryTCU, see [Default quotas]. + // + // [Default quotas]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default MaxQueryTCU *int32 // The pricing model for queries in an account. diff --git a/service/timestreamquery/options.go b/service/timestreamquery/options.go index 63731806d26..61fa9ff55f2 100644 --- a/service/timestreamquery/options.go +++ b/service/timestreamquery/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -77,17 +79,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -104,8 +109,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -150,6 +156,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/timestreamquery/types/enums.go b/service/timestreamquery/types/enums.go index 798bbe16ba6..8e7f544c2b0 100644 --- a/service/timestreamquery/types/enums.go +++ b/service/timestreamquery/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for DimensionValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionValueType) Values() []DimensionValueType { return []DimensionValueType{ "VARCHAR", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for MeasureValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MeasureValueType) Values() []MeasureValueType { return []MeasureValueType{ "BIGINT", @@ -51,8 +53,9 @@ const ( ) // Values returns all known values for QueryPricingModel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QueryPricingModel) Values() []QueryPricingModel { return []QueryPricingModel{ "BYTES_SCANNED", @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for S3EncryptionOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3EncryptionOption) Values() []S3EncryptionOption { return []S3EncryptionOption{ "SSE_S3", @@ -90,8 +94,9 @@ const ( ) // Values returns all known values for ScalarMeasureValueType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalarMeasureValueType) Values() []ScalarMeasureValueType { return []ScalarMeasureValueType{ "BIGINT", @@ -120,8 +125,9 @@ const ( ) // Values returns all known values for ScalarType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalarType) Values() []ScalarType { return []ScalarType{ "VARCHAR", @@ -149,8 +155,9 @@ const ( ) // Values returns all known values for ScheduledQueryRunStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledQueryRunStatus) Values() []ScheduledQueryRunStatus { return []ScheduledQueryRunStatus{ "AUTO_TRIGGER_SUCCESS", @@ -169,8 +176,9 @@ const ( ) // Values returns all known values for ScheduledQueryState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScheduledQueryState) Values() []ScheduledQueryState { return []ScheduledQueryState{ "ENABLED", diff --git a/service/timestreamquery/types/errors.go b/service/timestreamquery/types/errors.go index b8c85bac063..97b321faead 100644 --- a/service/timestreamquery/types/errors.go +++ b/service/timestreamquery/types/errors.go @@ -59,7 +59,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// The service was unable to fully process this request because of an internal +// The service was unable to fully process this request because of an internal +// // server error. type InternalServerException struct { Message *string diff --git a/service/timestreamquery/types/types.go b/service/timestreamquery/types/types.go index 74cb0392e9e..ccb674a5ded 100644 --- a/service/timestreamquery/types/types.go +++ b/service/timestreamquery/types/types.go @@ -7,7 +7,8 @@ import ( "time" ) -// Contains the metadata for query results such as the column names, data types, +// Contains the metadata for query results such as the column names, data types, +// // and other attributes. type ColumnInfo struct { @@ -18,7 +19,7 @@ type ColumnInfo struct { // This member is required. Type *Type - // The name of the result set column. The name of the result set is available for + // The name of the result set column. The name of the result set is available for // columns of all data types except for arrays. Name *string @@ -28,20 +29,20 @@ type ColumnInfo struct { // Datum represents a single data point in a query result. type Datum struct { - // Indicates if the data point is an array. + // Indicates if the data point is an array. ArrayValue []Datum - // Indicates if the data point is null. + // Indicates if the data point is null. NullValue *bool - // Indicates if the data point is a row. + // Indicates if the data point is a row. RowValue *Row - // Indicates if the data point is a scalar value such as integer, string, double, + // Indicates if the data point is a scalar value such as integer, string, double, // or Boolean. ScalarValue *string - // Indicates if the data point is a timeseries data type. + // Indicates if the data point is a timeseries data type. TimeSeriesValue []TimeSeriesDataPoint noSmithyDocumentSerde @@ -262,16 +263,16 @@ type Row struct { // Details on S3 location for error reports that result from running a query. type S3Configuration struct { - // Name of the S3 bucket under which error reports will be created. + // Name of the S3 bucket under which error reports will be created. // // This member is required. BucketName *string - // Encryption at rest options for the error reports. If no encryption option is + // Encryption at rest options for the error reports. If no encryption option is // specified, Timestream will choose SSE_S3 as default. EncryptionOption S3EncryptionOption - // Prefix for the error report key. Timestream by default adds the following + // Prefix for the error report key. Timestream by default adds the following // prefix to the error report path. ObjectKeyPrefix *string @@ -281,7 +282,7 @@ type S3Configuration struct { // S3 report location for the scheduled query run. type S3ReportLocation struct { - // S3 bucket name. + // S3 bucket name. BucketName *string // S3 key. @@ -436,7 +437,7 @@ type SelectColumn struct { // True, if the column name was aliased by the query. False otherwise. Aliased *bool - // Database that has this column. + // Database that has this column. DatabaseName *string // Name of the column. @@ -524,7 +525,8 @@ type TimeSeriesDataPoint struct { noSmithyDocumentSerde } -// Configuration to write data into Timestream database and table. This +// Configuration to write data into Timestream database and table. This +// // configuration allows the user to map the query result select columns into the // destination table columns. type TimestreamConfiguration struct { @@ -534,7 +536,7 @@ type TimestreamConfiguration struct { // This member is required. DatabaseName *string - // This is to allow mapping column(s) from the query result to the dimension in + // This is to allow mapping column(s) from the query result to the dimension in // the destination table. // // This member is required. @@ -589,8 +591,9 @@ type Type struct { RowColumnInfo []ColumnInfo // Indicates if the column is of type string, integer, Boolean, double, timestamp, - // date, time. For more information, see Supported data types (https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html) - // . + // date, time. For more information, see [Supported data types]. + // + // [Supported data types]: https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html ScalarType ScalarType // Indicates if the column is a timeseries data type. diff --git a/service/timestreamwrite/api_op_CreateBatchLoadTask.go b/service/timestreamwrite/api_op_CreateBatchLoadTask.go index dbbf95c5497..bb127860d04 100644 --- a/service/timestreamwrite/api_op_CreateBatchLoadTask.go +++ b/service/timestreamwrite/api_op_CreateBatchLoadTask.go @@ -17,11 +17,11 @@ 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 report will be encrypted with an S3 managed key when SSE_S3 is the option. -// Otherwise an error is thrown. 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) -// . +// Otherwise an error is thrown. For more information, see [Amazon Web Services managed keys]. [Service quotas apply]. For details, see [code sample]. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html +// [Amazon Web Services managed keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk 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 359db6591cb..6bc559385dc 100644 --- a/service/timestreamwrite/api_op_CreateDatabase.go +++ b/service/timestreamwrite/api_op_CreateDatabase.go @@ -14,10 +14,11 @@ import ( // 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) -// . +// account. For more information, see [Amazon Web Services managed keys]. [Service quotas apply]. For details, see [code sample]. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html +// [Amazon Web Services managed keys]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk func (c *Client) CreateDatabase(ctx context.Context, params *CreateDatabaseInput, optFns ...func(*Options)) (*CreateDatabaseOutput, error) { if params == nil { params = &CreateDatabaseInput{} @@ -42,11 +43,12 @@ type CreateDatabaseInput struct { // 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) - // . + // more information, see [Amazon Web Services managed keys]. + // + // [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. + // A list of key-value pairs to label the table. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/timestreamwrite/api_op_CreateTable.go b/service/timestreamwrite/api_op_CreateTable.go index f78494f3e45..a25a65f14d2 100644 --- a/service/timestreamwrite/api_op_CreateTable.go +++ b/service/timestreamwrite/api_op_CreateTable.go @@ -16,10 +16,11 @@ import ( // Services account, table names must be at least unique within each Region if they // 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) +// must specify the table name, database name, and the retention properties. [Service quotas apply]. See [code sample] // for details. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html func (c *Client) CreateTable(ctx context.Context, params *CreateTableInput, optFns ...func(*Options)) (*CreateTableOutput, error) { if params == nil { params = &CreateTableInput{} @@ -54,10 +55,10 @@ type CreateTableInput struct { // and the magnetic store. RetentionProperties *types.RetentionProperties - // The schema of the table. + // The schema of the table. Schema *types.Schema - // A list of key-value pairs to label the table. + // A list of key-value pairs to label the table. Tags []types.Tag noSmithyDocumentSerde diff --git a/service/timestreamwrite/api_op_DeleteDatabase.go b/service/timestreamwrite/api_op_DeleteDatabase.go index e6ffc073784..f4e84ace432 100644 --- a/service/timestreamwrite/api_op_DeleteDatabase.go +++ b/service/timestreamwrite/api_op_DeleteDatabase.go @@ -13,11 +13,16 @@ import ( // Deletes a given Timestream database. This is an irreversible operation. After a // database is deleted, the time-series data from its tables cannot be recovered. -// 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) -// for details. +// +// 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] for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html func (c *Client) DeleteDatabase(ctx context.Context, params *DeleteDatabaseInput, optFns ...func(*Options)) (*DeleteDatabaseOutput, error) { if params == nil { params = &DeleteDatabaseInput{} diff --git a/service/timestreamwrite/api_op_DeleteTable.go b/service/timestreamwrite/api_op_DeleteTable.go index e5de8e4c928..3357588d183 100644 --- a/service/timestreamwrite/api_op_DeleteTable.go +++ b/service/timestreamwrite/api_op_DeleteTable.go @@ -13,10 +13,14 @@ import ( // Deletes a given Timestream table. This is an irreversible operation. After a // 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) -// for details. +// 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] for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html func (c *Client) DeleteTable(ctx context.Context, params *DeleteTableInput, optFns ...func(*Options)) (*DeleteTableOutput, error) { if params == nil { params = &DeleteTableInput{} diff --git a/service/timestreamwrite/api_op_DescribeBatchLoadTask.go b/service/timestreamwrite/api_op_DescribeBatchLoadTask.go index 31babbd2746..9ecb16adaad 100644 --- a/service/timestreamwrite/api_op_DescribeBatchLoadTask.go +++ b/service/timestreamwrite/api_op_DescribeBatchLoadTask.go @@ -13,9 +13,10 @@ 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) -// for details. +// mappings, progress, and other details. [Service quotas apply]. See [code sample] for details. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html func (c *Client) DescribeBatchLoadTask(ctx context.Context, params *DescribeBatchLoadTaskInput, optFns ...func(*Options)) (*DescribeBatchLoadTaskOutput, error) { if params == nil { params = &DescribeBatchLoadTaskInput{} diff --git a/service/timestreamwrite/api_op_DescribeDatabase.go b/service/timestreamwrite/api_op_DescribeDatabase.go index f772bcd75e6..23ce8c4e505 100644 --- a/service/timestreamwrite/api_op_DescribeDatabase.go +++ b/service/timestreamwrite/api_op_DescribeDatabase.go @@ -14,9 +14,10 @@ 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) -// for details. +// database. [Service quotas apply]. See [code sample] for details. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html func (c *Client) DescribeDatabase(ctx context.Context, params *DescribeDatabaseInput, optFns ...func(*Options)) (*DescribeDatabaseOutput, error) { if params == nil { params = &DescribeDatabaseInput{} diff --git a/service/timestreamwrite/api_op_DescribeEndpoints.go b/service/timestreamwrite/api_op_DescribeEndpoints.go index 23a7a2b0ea7..a42d4555922 100644 --- a/service/timestreamwrite/api_op_DescribeEndpoints.go +++ b/service/timestreamwrite/api_op_DescribeEndpoints.go @@ -12,19 +12,24 @@ import ( ) // 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) +// 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] +// // - 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) -// . +// DescribeEndpoints, see [The Endpoint Discovery Pattern]. +// +// [The Endpoint Discovery Pattern]: https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery +// [VPC endpoints (Amazon Web Services PrivateLink) with Timestream]: https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints 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 2b6f78da182..17194e66fe4 100644 --- a/service/timestreamwrite/api_op_DescribeTable.go +++ b/service/timestreamwrite/api_op_DescribeTable.go @@ -13,10 +13,11 @@ 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) -// for details. +// retention duration of the memory store and the magnetic store. [Service quotas apply]. See [code sample] for +// details. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html func (c *Client) DescribeTable(ctx context.Context, params *DescribeTableInput, optFns ...func(*Options)) (*DescribeTableOutput, error) { if params == nil { params = &DescribeTableInput{} diff --git a/service/timestreamwrite/api_op_ListBatchLoadTasks.go b/service/timestreamwrite/api_op_ListBatchLoadTasks.go index 24389a8bad3..54fe8bb887e 100644 --- a/service/timestreamwrite/api_op_ListBatchLoadTasks.go +++ b/service/timestreamwrite/api_op_ListBatchLoadTasks.go @@ -13,8 +13,9 @@ 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) -// for details. +// is resumable until, and other details. See [code sample]for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html func (c *Client) ListBatchLoadTasks(ctx context.Context, params *ListBatchLoadTasksInput, optFns ...func(*Options)) (*ListBatchLoadTasksOutput, error) { if params == nil { params = &ListBatchLoadTasksInput{} diff --git a/service/timestreamwrite/api_op_ListDatabases.go b/service/timestreamwrite/api_op_ListDatabases.go index 96a0f94c5b3..50b99a218af 100644 --- a/service/timestreamwrite/api_op_ListDatabases.go +++ b/service/timestreamwrite/api_op_ListDatabases.go @@ -12,9 +12,10 @@ 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) -// for details. +// Returns a list of your Timestream databases. [Service quotas apply]. See [code sample] for details. +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html func (c *Client) ListDatabases(ctx context.Context, params *ListDatabasesInput, optFns ...func(*Options)) (*ListDatabasesOutput, error) { if params == nil { params = &ListDatabasesInput{} diff --git a/service/timestreamwrite/api_op_ListTables.go b/service/timestreamwrite/api_op_ListTables.go index 09da90ebcd2..09c16d90f9b 100644 --- a/service/timestreamwrite/api_op_ListTables.go +++ b/service/timestreamwrite/api_op_ListTables.go @@ -13,8 +13,9 @@ import ( ) // 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. +// properties of each table. See [code sample]for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html func (c *Client) ListTables(ctx context.Context, params *ListTablesInput, optFns ...func(*Options)) (*ListTablesOutput, error) { if params == nil { params = &ListTablesInput{} diff --git a/service/timestreamwrite/api_op_ListTagsForResource.go b/service/timestreamwrite/api_op_ListTagsForResource.go index cfe2fbcecbb..087f31ed2b4 100644 --- a/service/timestreamwrite/api_op_ListTagsForResource.go +++ b/service/timestreamwrite/api_op_ListTagsForResource.go @@ -30,7 +30,7 @@ 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 + // The Timestream resource with tags to be listed. This value is an Amazon // Resource Name (ARN). // // This member is required. @@ -41,7 +41,7 @@ type ListTagsForResourceInput struct { type ListTagsForResourceOutput struct { - // The tags currently associated with the Timestream resource. + // The tags currently associated with the Timestream resource. Tags []types.Tag // Metadata pertaining to the operation's result. diff --git a/service/timestreamwrite/api_op_TagResource.go b/service/timestreamwrite/api_op_TagResource.go index 3713fadb87c..8566783ba31 100644 --- a/service/timestreamwrite/api_op_TagResource.go +++ b/service/timestreamwrite/api_op_TagResource.go @@ -12,7 +12,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associates a set of tags with a Timestream resource. You can then activate +// 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) { @@ -32,13 +33,13 @@ func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optF type TagResourceInput struct { - // Identifies the Timestream resource to which tags should be added. This value is - // an Amazon Resource Name (ARN). + // Identifies the Timestream resource to which tags should be added. This value + // is an Amazon Resource Name (ARN). // // This member is required. ResourceARN *string - // The tags to be assigned to the Timestream resource. + // The tags to be assigned to the Timestream resource. // // This member is required. Tags []types.Tag diff --git a/service/timestreamwrite/api_op_UntagResource.go b/service/timestreamwrite/api_op_UntagResource.go index 7b0ddb15a1c..9b93241e181 100644 --- a/service/timestreamwrite/api_op_UntagResource.go +++ b/service/timestreamwrite/api_op_UntagResource.go @@ -29,13 +29,13 @@ func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, type UntagResourceInput struct { - // The Timestream resource that the tags will be removed from. This value is an + // The Timestream resource that the tags will be removed from. This value is an // Amazon Resource Name (ARN). // // This member is required. ResourceARN *string - // A list of tags keys. Existing tags of the resource whose keys are members of + // A list of tags keys. Existing tags of the resource whose keys are members of // this list will be removed from the Timestream resource. // // This member is required. diff --git a/service/timestreamwrite/api_op_UpdateDatabase.go b/service/timestreamwrite/api_op_UpdateDatabase.go index a9789032d27..6e728a9ec88 100644 --- a/service/timestreamwrite/api_op_UpdateDatabase.go +++ b/service/timestreamwrite/api_op_UpdateDatabase.go @@ -12,11 +12,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// for details. +// 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] for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html func (c *Client) UpdateDatabase(ctx context.Context, params *UpdateDatabaseInput, optFns ...func(*Options)) (*UpdateDatabaseOutput, error) { if params == nil { params = &UpdateDatabaseInput{} @@ -34,19 +38,24 @@ func (c *Client) UpdateDatabase(ctx context.Context, params *UpdateDatabaseInput type UpdateDatabaseInput struct { - // The name of the database. + // The name of the database. // // 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: + // 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 // // This member is required. diff --git a/service/timestreamwrite/api_op_UpdateTable.go b/service/timestreamwrite/api_op_UpdateTable.go index 5444a776399..d2a36d288ea 100644 --- a/service/timestreamwrite/api_op_UpdateTable.go +++ b/service/timestreamwrite/api_op_UpdateTable.go @@ -18,8 +18,11 @@ 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) -// for details. +// magnetic store to populate the memory store. +// +// See [code sample] for details. +// +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html func (c *Client) UpdateTable(ctx context.Context, params *UpdateTableInput, optFns ...func(*Options)) (*UpdateTableOutput, error) { if params == nil { params = &UpdateTableInput{} @@ -53,7 +56,7 @@ type UpdateTableInput struct { // The retention duration of the memory store and the magnetic store. RetentionProperties *types.RetentionProperties - // The schema of the table. + // The schema of the table. Schema *types.Schema noSmithyDocumentSerde diff --git a/service/timestreamwrite/api_op_WriteRecords.go b/service/timestreamwrite/api_op_WriteRecords.go index e330df10d51..40ff418ebcf 100644 --- a/service/timestreamwrite/api_op_WriteRecords.go +++ b/service/timestreamwrite/api_op_WriteRecords.go @@ -17,28 +17,34 @@ import ( // Timestream offers you a flexible schema that auto detects the column names and // data types for your Timestream tables based on the dimension names and data // types of the data points you specify when invoking writes into the database. +// // Timestream supports eventual consistency read semantics. This means that when // you query data immediately after writing a batch of data into Timestream, the // 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 after a short time, the results should return the latest data. [Service quotas apply]. +// +// See [code sample] 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 , // 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 @@ -46,6 +52,9 @@ import ( // 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 . +// +// [Service quotas apply]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html +// [code sample]: https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html 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 a1c121d349a..b1eaedfe0ea 100644 --- a/service/timestreamwrite/doc.go +++ b/service/timestreamwrite/doc.go @@ -3,17 +3,20 @@ // 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 -// of time-series data points per day. With Timestream, you can easily store and -// analyze IoT sensor data to derive insights from your IoT applications. You can -// analyze industrial telemetry to streamline equipment management and maintenance. -// You can also store and analyze log data and metrics to improve the performance -// and availability of your applications. Timestream is built from the ground up to -// effectively ingest, process, and store time-series data. It organizes data to -// optimize query processing. It automatically scales based on the volume of data -// ingested and on the query volume to ensure you receive optimal performance while -// inserting and querying data. As your data grows over time, Timestream’s adaptive -// query processing engine spans across storage tiers to provide fast analysis -// while reducing costs. +// # Amazon Timestream Write +// +// Amazon Timestream is a fast, scalable, fully managed time-series database +// service that makes it easy to store and analyze trillions of time-series data +// points per day. With Timestream, you can easily store and analyze IoT sensor +// data to derive insights from your IoT applications. You can analyze industrial +// telemetry to streamline equipment management and maintenance. You can also store +// and analyze log data and metrics to improve the performance and availability of +// your applications. +// +// Timestream is built from the ground up to effectively ingest, process, and +// store time-series data. It organizes data to optimize query processing. It +// automatically scales based on the volume of data ingested and on the query +// volume to ensure you receive optimal performance while inserting and querying +// data. As your data grows over time, Timestream’s adaptive query processing +// engine spans across storage tiers to provide fast analysis while reducing costs. package timestreamwrite diff --git a/service/timestreamwrite/options.go b/service/timestreamwrite/options.go index d5fe7e8d723..8a9f733c8e1 100644 --- a/service/timestreamwrite/options.go +++ b/service/timestreamwrite/options.go @@ -53,8 +53,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -77,17 +79,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -104,8 +109,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -150,6 +156,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/timestreamwrite/types/enums.go b/service/timestreamwrite/types/enums.go index b6dfe303162..b20ab710dec 100644 --- a/service/timestreamwrite/types/enums.go +++ b/service/timestreamwrite/types/enums.go @@ -10,8 +10,9 @@ const ( ) // Values returns all known values for BatchLoadDataFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchLoadDataFormat) Values() []BatchLoadDataFormat { return []BatchLoadDataFormat{ "CSV", @@ -31,8 +32,9 @@ const ( ) // Values returns all known values for BatchLoadStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BatchLoadStatus) Values() []BatchLoadStatus { return []BatchLoadStatus{ "CREATED", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for DimensionValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DimensionValueType) Values() []DimensionValueType { return []DimensionValueType{ "VARCHAR", @@ -73,8 +76,9 @@ const ( ) // Values returns all known values for MeasureValueType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MeasureValueType) Values() []MeasureValueType { return []MeasureValueType{ "DOUBLE", @@ -96,8 +100,9 @@ const ( // Values returns all known values for PartitionKeyEnforcementLevel. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartitionKeyEnforcementLevel) Values() []PartitionKeyEnforcementLevel { return []PartitionKeyEnforcementLevel{ "REQUIRED", @@ -114,8 +119,9 @@ const ( ) // Values returns all known values for PartitionKeyType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartitionKeyType) Values() []PartitionKeyType { return []PartitionKeyType{ "DIMENSION", @@ -132,8 +138,9 @@ const ( ) // Values returns all known values for S3EncryptionOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (S3EncryptionOption) Values() []S3EncryptionOption { return []S3EncryptionOption{ "SSE_S3", @@ -153,8 +160,9 @@ const ( ) // Values returns all known values for ScalarMeasureValueType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ScalarMeasureValueType) Values() []ScalarMeasureValueType { return []ScalarMeasureValueType{ "DOUBLE", @@ -175,8 +183,9 @@ const ( ) // Values returns all known values for TableStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TableStatus) Values() []TableStatus { return []TableStatus{ "ACTIVE", @@ -196,8 +205,9 @@ const ( ) // Values returns all known values for TimeUnit. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeUnit) Values() []TimeUnit { return []TimeUnit{ "MILLISECONDS", diff --git a/service/timestreamwrite/types/errors.go b/service/timestreamwrite/types/errors.go index cf746a06085..0acd4597921 100644 --- a/service/timestreamwrite/types/errors.go +++ b/service/timestreamwrite/types/errors.go @@ -60,7 +60,8 @@ func (e *ConflictException) ErrorCode() string { } func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Timestream was unable to fully process this request because of an internal +// Timestream was unable to fully process this request because of an internal +// // server error. type InternalServerException struct { Message *string @@ -113,23 +114,31 @@ 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. +// 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 // -// For more information, see Quotas (https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) -// in the Amazon Timestream Developer Guide. +// 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] in the Amazon Timestream Developer Guide. +// +// [Quotas]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html type RejectedRecordsException struct { Message *string @@ -210,8 +219,9 @@ func (e *ServiceQuotaExceededException) ErrorCode() string { } func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } -// Too many requests were made by a user and they exceeded the service quotas. The -// request was throttled. +// Too many requests were made by a user and they exceeded the service quotas. +// +// The request was throttled. type ThrottlingException struct { Message *string diff --git a/service/timestreamwrite/types/types.go b/service/timestreamwrite/types/types.go index b84480aa40e..dd7f6f5e9b0 100644 --- a/service/timestreamwrite/types/types.go +++ b/service/timestreamwrite/types/types.go @@ -145,7 +145,7 @@ type Database struct { // The identifier of the KMS key used to encrypt the data stored in the database. KmsKeyId *string - // The last time that this database was updated. + // The last time that this database was updated. LastUpdatedTime *time.Time // The total number of tables found within a Timestream database. @@ -174,7 +174,7 @@ type DataModel struct { // Source column to be mapped to time. TimeColumn *string - // The granularity of the timestamp unit. It indicates if the time value is in + // The granularity of the timestamp unit. It indicates if the time value is in // seconds, milliseconds, nanoseconds, or other supported values. Default is // MILLISECONDS . TimeUnit TimeUnit @@ -242,11 +242,13 @@ type DataSourceS3Configuration struct { // wind turbine are dimensions. type Dimension struct { - // Dimension represents the metadata attributes of the time series. For example, + // 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) - // . + // manufacturer of a wind turbine are dimensions. + // + // For constraints on dimension names, see [Naming Constraints]. + // + // [Naming Constraints]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming // // This member is required. Name *string @@ -316,16 +318,21 @@ type MagneticStoreWriteProperties struct { noSmithyDocumentSerde } -// Represents the data attribute of the time series. For example, the CPU +// 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 -// the same time series in a single record +// MeasureValue has both name and value. +// +// MeasureValue is only allowed for type 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) - // in the Amazon Timestream Developer Guide. + // The name of the MeasureValue. + // + // For constraints on MeasureValue names, see [Naming Constraints] in the Amazon Timestream Developer + // Guide. + // + // [Naming Constraints]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming // // This member is required. Name *string @@ -335,8 +342,9 @@ type MeasureValue struct { // This member is required. Type MeasureValueType - // The value for the MeasureValue. For information, see Data types (https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types) - // . + // The value for the MeasureValue. For information, see [Data types]. + // + // [Data types]: https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types // // This member is required. Value *string @@ -395,24 +403,25 @@ type MultiMeasureMappings struct { noSmithyDocumentSerde } -// An attribute used in partitioning data in a table. A dimension key partitions +// An attribute used in partitioning data in a table. A dimension key partitions +// // data using the values of the dimension specified by the dimension-name as // partition key, while a measure key partitions data using measure names (values // of the 'measure_name' column). type PartitionKey struct { - // The type of the partition key. Options are DIMENSION (dimension key) and + // The type of the partition key. Options are DIMENSION (dimension key) and // MEASURE (measure key). // // This member is required. Type PartitionKeyType - // The level of enforcement for the specification of a dimension key in ingested + // The level of enforcement for the specification of a dimension key in ingested // records. Options are REQUIRED (dimension key must be specified) and OPTIONAL // (dimension key does not have to be specified). EnforcementInRecord PartitionKeyEnforcementLevel - // The name of the attribute used for a dimension key. + // The name of the attribute used for a dimension key. Name *string noSmithyDocumentSerde @@ -426,12 +435,14 @@ type PartitionKey struct { // Additionally, a record contains the measure value and the value type, which is // the data type of the measure value. Also, the record contains the timestamp of // when the measure was collected and the timestamp unit, which represents the -// 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. +// 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. type Record struct { // Contains the list of dimensions for time-series data points. @@ -441,26 +452,28 @@ type Record struct { // utilization of an EC2 instance or the RPM of a wind turbine are measures. MeasureName *string - // Contains the measure value for the time-series data point. + // Contains the measure value for the time-series data point. MeasureValue *string - // Contains the data type of the measure value for the time-series data point. - // Default type is DOUBLE . For more information, see Data types (https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types) - // . + // Contains the data type of the measure value for the time-series data point. + // Default type is DOUBLE . For more information, see [Data types]. + // + // [Data types]: https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types 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 - // record directly. + // 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 record directly. MeasureValues []MeasureValue - // Contains the time at which the measure value for the data point was collected. + // 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 // elapsed since the epoch. Time *string - // The granularity of the timestamp unit. It indicates if the time value is in + // The granularity of the timestamp unit. It indicates if the time value is in // seconds, milliseconds, nanoseconds, or other supported values. Default is // MILLISECONDS . TimeUnit TimeUnit @@ -468,8 +481,9 @@ type Record struct { // 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. + // Default value is 1 . + // + // Version must be 1 or greater, or you will receive a ValidationException error. Version *int64 noSmithyDocumentSerde @@ -490,7 +504,8 @@ type RecordsIngested struct { noSmithyDocumentSerde } -// Represents records that were not successfully inserted into Timestream due to +// Represents records that were not successfully inserted into Timestream due to +// // data validation issues that must be resolved before reinserting time-series data // into the system. type RejectedRecord struct { @@ -500,32 +515,41 @@ type RejectedRecord struct { // request. ExistingVersion *int64 - // The reason why a record was not successfully inserted into Timestream. Possible - // causes of failure include: + // 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 . + // 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) - // . + // 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]and [the explanation of how storage works in Timestream]. + // // - 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. + // + // For more information, see [Access Management] in the Timestream Developer Guide. + // + // [Access Management]: https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html + // [Best Practices for Configuring Timestream]: https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration + // [the explanation of how storage works in Timestream]: https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html Reason *string - // The index of the record in the input request for WriteRecords. Indexes begin + // The index of the record in the input request for WriteRecords. Indexes begin // with 0. RecordIndex int32 @@ -635,32 +659,35 @@ type Table struct { // The retention duration for the memory store and magnetic store. RetentionProperties *RetentionProperties - // The schema of the table. + // The schema of the table. Schema *Schema // The name of the Timestream table. TableName *string // The current state of the table: + // // - 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 +// 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. + // The key of the tag. Tag keys are case sensitive. // // This member is required. Key *string - // The value of the tag. Tag values are case-sensitive and can be null. + // The value of the tag. Tag values are case-sensitive and can be null. // // This member is required. Value *string diff --git a/service/tnb/api_op_CancelSolNetworkOperation.go b/service/tnb/api_op_CancelSolNetworkOperation.go index a00d354f5d9..cafcec17dde 100644 --- a/service/tnb/api_op_CancelSolNetworkOperation.go +++ b/service/tnb/api_op_CancelSolNetworkOperation.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a network operation. A network operation is any operation that is done -// to your network, such as network instance instantiation or termination. +// Cancels a network operation. +// +// A network operation is any operation that is done to your network, such as +// network instance instantiation or termination. func (c *Client) CancelSolNetworkOperation(ctx context.Context, params *CancelSolNetworkOperationInput, optFns ...func(*Options)) (*CancelSolNetworkOperationOutput, error) { if params == nil { params = &CancelSolNetworkOperationInput{} diff --git a/service/tnb/api_op_CreateSolFunctionPackage.go b/service/tnb/api_op_CreateSolFunctionPackage.go index a0ef194caa9..4e7bd610212 100644 --- a/service/tnb/api_op_CreateSolFunctionPackage.go +++ b/service/tnb/api_op_CreateSolFunctionPackage.go @@ -11,17 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates 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. -// 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) -// . +// Creates 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. For more information, see [Function packages]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]. +// +// [Function packages]: https://docs.aws.amazon.com/tnb/latest/ug/function-packages.html +// [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 11b7b4213c4..5ef19a741f5 100644 --- a/service/tnb/api_op_CreateSolNetworkInstance.go +++ b/service/tnb/api_op_CreateSolNetworkInstance.go @@ -10,15 +10,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates 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. 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) -// . +// Creates 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. Creating a network instance is the third step after +// creating a network package. For more information about network instances, [Network instances]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]. +// +// [InstantiateSolNetworkInstance]: https://docs.aws.amazon.com/tnb/latest/APIReference/API_InstantiateSolNetworkInstance.html +// [Network instances]: https://docs.aws.amazon.com/tnb/latest/ug/network-instances.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 9d00585633e..197b72345c6 100644 --- a/service/tnb/api_op_CreateSolNetworkPackage.go +++ b/service/tnb/api_op_CreateSolNetworkPackage.go @@ -11,19 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// . +// 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]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]. +// +// [Network instances]: https://docs.aws.amazon.com/tnb/latest/ug/network-instances.html +// [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 62c5aa0ad53..6b039d6548e 100644 --- a/service/tnb/api_op_DeleteSolFunctionPackage.go +++ b/service/tnb/api_op_DeleteSolFunctionPackage.go @@ -10,13 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes 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. +// Deletes 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. +// // 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]. +// +// [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 664ecdaa3b1..4de740acdb7 100644 --- a/service/tnb/api_op_DeleteSolNetworkInstance.go +++ b/service/tnb/api_op_DeleteSolNetworkInstance.go @@ -10,12 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes 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. 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) -// . +// Deletes 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. +// +// To delete a network instance, the instance must be in a stopped or terminated +// state. To terminate a network instance, see [TerminateSolNetworkInstance]. +// +// [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 dd5e1989631..8f019b9218e 100644 --- a/service/tnb/api_op_DeleteSolNetworkPackage.go +++ b/service/tnb/api_op_DeleteSolNetworkPackage.go @@ -10,12 +10,16 @@ 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]. +// +// [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_GetSolFunctionInstance.go b/service/tnb/api_op_GetSolFunctionInstance.go index 5def4cee965..6ccc9b269a4 100644 --- a/service/tnb/api_op_GetSolFunctionInstance.go +++ b/service/tnb/api_op_GetSolFunctionInstance.go @@ -13,7 +13,9 @@ import ( // Gets the details of a network function instance, including the instantation // state and metadata from the function package descriptor in the network function -// package. A network function instance is a function in a function package . +// package. +// +// A network function instance is a function in a function package . func (c *Client) GetSolFunctionInstance(ctx context.Context, params *GetSolFunctionInstanceInput, optFns ...func(*Options)) (*GetSolFunctionInstanceOutput, error) { if params == nil { params = &GetSolFunctionInstanceInput{} @@ -56,8 +58,9 @@ type GetSolFunctionInstanceOutput struct { // This member is required. InstantiationState types.VnfInstantiationState - // The metadata of a network function instance. A network function instance is a - // function in a function package . + // The metadata of a network function instance. + // + // A network function instance is a function in a function package . // // This member is required. Metadata *types.GetSolFunctionInstanceMetadata @@ -77,8 +80,9 @@ type GetSolFunctionInstanceOutput struct { // This member is required. VnfdId *string - // Information about the network function. A network function instance is a - // function in a function package . + // Information about the network function. + // + // A network function instance is a function in a function package . InstantiatedVnfInfo *types.GetSolVnfInfo // A tag is a label that you assign to an Amazon Web Services resource. Each tag diff --git a/service/tnb/api_op_GetSolFunctionPackage.go b/service/tnb/api_op_GetSolFunctionPackage.go index f66d3d39841..e60bd49315a 100644 --- a/service/tnb/api_op_GetSolFunctionPackage.go +++ b/service/tnb/api_op_GetSolFunctionPackage.go @@ -12,11 +12,12 @@ import ( ) // Gets the details of an individual function package, such as the operational -// state and whether the package is in use. 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.. +// state and whether the package is in use. +// +// 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.. func (c *Client) GetSolFunctionPackage(ctx context.Context, params *GetSolFunctionPackageInput, optFns ...func(*Options)) (*GetSolFunctionPackageOutput, error) { if params == nil { params = &GetSolFunctionPackageInput{} @@ -69,11 +70,12 @@ type GetSolFunctionPackageOutput struct { // This member is required. UsageState types.UsageState - // Metadata related to the 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. + // Metadata related to the 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. Metadata *types.GetSolFunctionPackageMetadata // A tag is a label that you assign to an Amazon Web Services resource. Each tag diff --git a/service/tnb/api_op_GetSolFunctionPackageContent.go b/service/tnb/api_op_GetSolFunctionPackageContent.go index c8293c46545..e3f18965058 100644 --- a/service/tnb/api_op_GetSolFunctionPackageContent.go +++ b/service/tnb/api_op_GetSolFunctionPackageContent.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets 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. +// Gets 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. func (c *Client) GetSolFunctionPackageContent(ctx context.Context, params *GetSolFunctionPackageContentInput, optFns ...func(*Options)) (*GetSolFunctionPackageContentOutput, error) { if params == nil { params = &GetSolFunctionPackageContentInput{} diff --git a/service/tnb/api_op_GetSolFunctionPackageDescriptor.go b/service/tnb/api_op_GetSolFunctionPackageDescriptor.go index ad0e76ec5f7..79ecc1e91f3 100644 --- a/service/tnb/api_op_GetSolFunctionPackageDescriptor.go +++ b/service/tnb/api_op_GetSolFunctionPackageDescriptor.go @@ -11,13 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets a function package descriptor in a function package. A function package -// descriptor is a .yaml file in a function package that uses the TOSCA standard to -// describe how the network function in the function package should run on your -// network. 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. +// Gets a function package descriptor in a function package. +// +// A function package descriptor is a .yaml file in a function package that uses +// the TOSCA standard to describe how the network function in the function package +// should run on your network. +// +// 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. func (c *Client) GetSolFunctionPackageDescriptor(ctx context.Context, params *GetSolFunctionPackageDescriptorInput, optFns ...func(*Options)) (*GetSolFunctionPackageDescriptorOutput, error) { if params == nil { params = &GetSolFunctionPackageDescriptorInput{} diff --git a/service/tnb/api_op_GetSolNetworkInstance.go b/service/tnb/api_op_GetSolNetworkInstance.go index 2b80f1cc5fc..cffef04aa64 100644 --- a/service/tnb/api_op_GetSolNetworkInstance.go +++ b/service/tnb/api_op_GetSolNetworkInstance.go @@ -11,9 +11,11 @@ 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{} @@ -51,9 +53,11 @@ type GetSolNetworkInstanceOutput struct { // This member is required. Id *string - // The metadata of 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. + // The metadata of 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. // // This member is required. Metadata *types.GetSolNetworkInstanceMetadata @@ -78,8 +82,9 @@ type GetSolNetworkInstanceOutput struct { // This member is required. NsdInfoId *string - // Lifecycle management operation details on the network instance. Lifecycle - // management operations are deploy, update, or delete operations. + // Lifecycle management operation details on the network instance. + // + // Lifecycle management operations are deploy, update, or delete operations. LcmOpInfo *types.LcmOperationInfo // Network instance state. diff --git a/service/tnb/api_op_GetSolNetworkOperation.go b/service/tnb/api_op_GetSolNetworkOperation.go index f00e1dc9e4f..bbedb50669b 100644 --- a/service/tnb/api_op_GetSolNetworkOperation.go +++ b/service/tnb/api_op_GetSolNetworkOperation.go @@ -12,9 +12,10 @@ import ( ) // Gets the details of a network operation, including the tasks involved in the -// network operation and the status of the tasks. A network operation is any -// operation that is done to your network, such as network instance instantiation -// or termination. +// network operation and the status of the tasks. +// +// A network operation is any operation that is done to your network, such as +// network instance instantiation or termination. func (c *Client) GetSolNetworkOperation(ctx context.Context, params *GetSolNetworkOperationInput, optFns ...func(*Options)) (*GetSolNetworkOperationOutput, error) { if params == nil { params = &GetSolNetworkOperationInput{} diff --git a/service/tnb/api_op_GetSolNetworkPackage.go b/service/tnb/api_op_GetSolNetworkPackage.go index 74a17b6ec47..1241d123634 100644 --- a/service/tnb/api_op_GetSolNetworkPackage.go +++ b/service/tnb/api_op_GetSolNetworkPackage.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Gets the details 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 details 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) GetSolNetworkPackage(ctx context.Context, params *GetSolNetworkPackageInput, optFns ...func(*Options)) (*GetSolNetworkPackageOutput, error) { if params == nil { params = &GetSolNetworkPackageInput{} @@ -51,9 +53,11 @@ type GetSolNetworkPackageOutput struct { // This member is required. Id *string - // Metadata associated with 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. + // Metadata associated with 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. // // This member is required. Metadata *types.GetSolNetworkPackageMetadata diff --git a/service/tnb/api_op_GetSolNetworkPackageContent.go b/service/tnb/api_op_GetSolNetworkPackageContent.go index c033c2dc85e..50e7fce511a 100644 --- a/service/tnb/api_op_GetSolNetworkPackageContent.go +++ b/service/tnb/api_op_GetSolNetworkPackageContent.go @@ -11,9 +11,11 @@ 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 fad5d488076..5109ff540eb 100644 --- a/service/tnb/api_op_GetSolNetworkPackageDescriptor.go +++ b/service/tnb/api_op_GetSolNetworkPackageDescriptor.go @@ -11,10 +11,11 @@ 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 -// infrastructure you want to deploy the network functions on. +// 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 { params = &GetSolNetworkPackageDescriptorInput{} diff --git a/service/tnb/api_op_InstantiateSolNetworkInstance.go b/service/tnb/api_op_InstantiateSolNetworkInstance.go index ff5b812fab0..f62c6ac02eb 100644 --- a/service/tnb/api_op_InstantiateSolNetworkInstance.go +++ b/service/tnb/api_op_InstantiateSolNetworkInstance.go @@ -11,12 +11,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Instantiates 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. 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) -// . +// Instantiates 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. +// +// Before you can instantiate a network instance, you have to create a network +// instance. For more information, see [CreateSolNetworkInstance]. +// +// [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{} diff --git a/service/tnb/api_op_ListSolFunctionInstances.go b/service/tnb/api_op_ListSolFunctionInstances.go index 4f584f7f186..36139fa0f6a 100644 --- a/service/tnb/api_op_ListSolFunctionInstances.go +++ b/service/tnb/api_op_ListSolFunctionInstances.go @@ -11,8 +11,9 @@ 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_ListSolFunctionPackages.go b/service/tnb/api_op_ListSolFunctionPackages.go index bc6001c8092..7481dd0ef0d 100644 --- a/service/tnb/api_op_ListSolFunctionPackages.go +++ b/service/tnb/api_op_ListSolFunctionPackages.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists information about function packages. 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. +// Lists information about function packages. +// +// 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. func (c *Client) ListSolFunctionPackages(ctx context.Context, params *ListSolFunctionPackagesInput, optFns ...func(*Options)) (*ListSolFunctionPackagesOutput, error) { if params == nil { params = &ListSolFunctionPackagesInput{} diff --git a/service/tnb/api_op_ListSolNetworkInstances.go b/service/tnb/api_op_ListSolNetworkInstances.go index b8433940a73..0ee30cf446f 100644 --- a/service/tnb/api_op_ListSolNetworkInstances.go +++ b/service/tnb/api_op_ListSolNetworkInstances.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists your network instances. 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. +// Lists your network instances. +// +// 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) ListSolNetworkInstances(ctx context.Context, params *ListSolNetworkInstancesInput, optFns ...func(*Options)) (*ListSolNetworkInstancesOutput, error) { if params == nil { params = &ListSolNetworkInstancesInput{} diff --git a/service/tnb/api_op_ListSolNetworkOperations.go b/service/tnb/api_op_ListSolNetworkOperations.go index 5258c130cbf..02ca350b02a 100644 --- a/service/tnb/api_op_ListSolNetworkOperations.go +++ b/service/tnb/api_op_ListSolNetworkOperations.go @@ -12,8 +12,10 @@ import ( ) // Lists details for a network operation, including when the operation started and -// the status of the operation. A network operation is any operation that is done -// to your network, such as network instance instantiation or termination. +// the status of the operation. +// +// A network operation is any operation that is done to your network, such as +// network instance instantiation or termination. func (c *Client) ListSolNetworkOperations(ctx context.Context, params *ListSolNetworkOperationsInput, optFns ...func(*Options)) (*ListSolNetworkOperationsOutput, error) { if params == nil { params = &ListSolNetworkOperationsInput{} diff --git a/service/tnb/api_op_ListSolNetworkPackages.go b/service/tnb/api_op_ListSolNetworkPackages.go index a3575c97e7c..3ff59ae3331 100644 --- a/service/tnb/api_op_ListSolNetworkPackages.go +++ b/service/tnb/api_op_ListSolNetworkPackages.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists network packages. 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. +// Lists network packages. +// +// 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) ListSolNetworkPackages(ctx context.Context, params *ListSolNetworkPackagesInput, optFns ...func(*Options)) (*ListSolNetworkPackagesOutput, error) { if params == nil { params = &ListSolNetworkPackagesInput{} diff --git a/service/tnb/api_op_PutSolFunctionPackageContent.go b/service/tnb/api_op_PutSolFunctionPackageContent.go index db9604e1a56..64a2e4bcf84 100644 --- a/service/tnb/api_op_PutSolFunctionPackageContent.go +++ b/service/tnb/api_op_PutSolFunctionPackageContent.go @@ -11,11 +11,12 @@ 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 -// standard telecommunication application) and function package descriptor that -// uses the TOSCA standard to describe how the network functions should run on your -// network. +// 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. func (c *Client) PutSolFunctionPackageContent(ctx context.Context, params *PutSolFunctionPackageContentInput, optFns ...func(*Options)) (*PutSolFunctionPackageContentOutput, error) { if params == nil { params = &PutSolFunctionPackageContentInput{} diff --git a/service/tnb/api_op_PutSolNetworkPackageContent.go b/service/tnb/api_op_PutSolNetworkPackageContent.go index 0cceb88e8bb..0c896ee3486 100644 --- a/service/tnb/api_op_PutSolNetworkPackageContent.go +++ b/service/tnb/api_op_PutSolNetworkPackageContent.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Uploads 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. +// Uploads 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) PutSolNetworkPackageContent(ctx context.Context, params *PutSolNetworkPackageContentInput, optFns ...func(*Options)) (*PutSolNetworkPackageContentOutput, error) { if params == nil { params = &PutSolNetworkPackageContentInput{} diff --git a/service/tnb/api_op_TagResource.go b/service/tnb/api_op_TagResource.go index e598188e01f..33828ade4f6 100644 --- a/service/tnb/api_op_TagResource.go +++ b/service/tnb/api_op_TagResource.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Tags an AWS TNB resource. A tag is a label that you assign to an Amazon Web -// Services resource. Each tag consists of a key and an optional value. You can use -// tags to search and filter your resources or track your Amazon Web Services -// costs. +// Tags an AWS TNB resource. +// +// A tag is a label that you assign to an Amazon Web Services resource. Each tag +// consists of a key and an optional value. You can use tags to search and filter +// your resources or track your Amazon Web Services costs. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/tnb/api_op_TerminateSolNetworkInstance.go b/service/tnb/api_op_TerminateSolNetworkInstance.go index ceaccf40d6a..2f8ce09d3a5 100644 --- a/service/tnb/api_op_TerminateSolNetworkInstance.go +++ b/service/tnb/api_op_TerminateSolNetworkInstance.go @@ -10,10 +10,13 @@ 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_UntagResource.go b/service/tnb/api_op_UntagResource.go index 6a70c99e3ea..671c53c49f2 100644 --- a/service/tnb/api_op_UntagResource.go +++ b/service/tnb/api_op_UntagResource.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Untags an AWS TNB resource. A tag is a label that you assign to an Amazon Web -// Services resource. Each tag consists of a key and an optional value. You can use -// tags to search and filter your resources or track your Amazon Web Services -// costs. +// Untags an AWS TNB resource. +// +// A tag is a label that you assign to an Amazon Web Services resource. Each tag +// consists of a key and an optional value. You can use tags to search and filter +// your resources or track your Amazon Web Services costs. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/tnb/api_op_UpdateSolFunctionPackage.go b/service/tnb/api_op_UpdateSolFunctionPackage.go index ab00f318301..73fa3c91926 100644 --- a/service/tnb/api_op_UpdateSolFunctionPackage.go +++ b/service/tnb/api_op_UpdateSolFunctionPackage.go @@ -11,11 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the operational state of 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. +// Updates the operational state of 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. func (c *Client) UpdateSolFunctionPackage(ctx context.Context, params *UpdateSolFunctionPackageInput, optFns ...func(*Options)) (*UpdateSolFunctionPackageOutput, error) { if params == nil { params = &UpdateSolFunctionPackageInput{} diff --git a/service/tnb/api_op_UpdateSolNetworkInstance.go b/service/tnb/api_op_UpdateSolNetworkInstance.go index e908d2874dc..a979ab5d213 100644 --- a/service/tnb/api_op_UpdateSolNetworkInstance.go +++ b/service/tnb/api_op_UpdateSolNetworkInstance.go @@ -11,9 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update 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. +// Update 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. func (c *Client) UpdateSolNetworkInstance(ctx context.Context, params *UpdateSolNetworkInstanceInput, optFns ...func(*Options)) (*UpdateSolNetworkInstanceOutput, error) { if params == nil { params = &UpdateSolNetworkInstanceInput{} diff --git a/service/tnb/api_op_UpdateSolNetworkPackage.go b/service/tnb/api_op_UpdateSolNetworkPackage.go index dd010f161a6..0c7a47ded33 100644 --- a/service/tnb/api_op_UpdateSolNetworkPackage.go +++ b/service/tnb/api_op_UpdateSolNetworkPackage.go @@ -11,13 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Updates the operational state 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. 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. +// Updates the operational state 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. +// +// 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) UpdateSolNetworkPackage(ctx context.Context, params *UpdateSolNetworkPackageInput, optFns ...func(*Options)) (*UpdateSolNetworkPackageOutput, error) { if params == nil { params = &UpdateSolNetworkPackageInput{} diff --git a/service/tnb/api_op_ValidateSolFunctionPackageContent.go b/service/tnb/api_op_ValidateSolFunctionPackageContent.go index 602256cfb70..aef63facd27 100644 --- a/service/tnb/api_op_ValidateSolFunctionPackageContent.go +++ b/service/tnb/api_op_ValidateSolFunctionPackageContent.go @@ -12,11 +12,14 @@ 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]. +// +// 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. +// +// [PutSolFunctionPackageContent]: https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolFunctionPackageContent.html func (c *Client) ValidateSolFunctionPackageContent(ctx context.Context, params *ValidateSolFunctionPackageContentInput, optFns ...func(*Options)) (*ValidateSolFunctionPackageContentOutput, error) { if params == nil { params = &ValidateSolFunctionPackageContentInput{} diff --git a/service/tnb/api_op_ValidateSolNetworkPackageContent.go b/service/tnb/api_op_ValidateSolNetworkPackageContent.go index d7d43fbdf6d..e6f33bc60b3 100644 --- a/service/tnb/api_op_ValidateSolNetworkPackageContent.go +++ b/service/tnb/api_op_ValidateSolNetworkPackageContent.go @@ -12,10 +12,13 @@ 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]. +// +// 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. +// +// [PutSolNetworkPackageContent]: https://docs.aws.amazon.com/tnb/latest/APIReference/API_PutSolNetworkPackageContent.html func (c *Client) ValidateSolNetworkPackageContent(ctx context.Context, params *ValidateSolNetworkPackageContentInput, optFns ...func(*Options)) (*ValidateSolNetworkPackageContentOutput, error) { if params == nil { params = &ValidateSolNetworkPackageContentInput{} diff --git a/service/tnb/doc.go b/service/tnb/doc.go index 393bfa96c0e..121f43a27ba 100644 --- a/service/tnb/doc.go +++ b/service/tnb/doc.go @@ -3,8 +3,9 @@ // Package tnb provides the API client, operations, and parameter types for AWS // Telco Network Builder. // -// Amazon Web Services Telco Network Builder (TNB) is a network automation service -// that helps you deploy and manage telecom networks. AWS TNB helps you with the -// lifecycle management of your telecommunication network functions throughout -// planning, deployment, and post-deployment activities. +// Amazon Web Services Telco Network Builder (TNB) is a network automation +// +// service that helps you deploy and manage telecom networks. AWS TNB helps you +// with the lifecycle management of your telecommunication network functions +// throughout planning, deployment, and post-deployment activities. package tnb diff --git a/service/tnb/options.go b/service/tnb/options.go index 8c585deba7a..dd8f211af64 100644 --- a/service/tnb/options.go +++ b/service/tnb/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/tnb/types/enums.go b/service/tnb/types/enums.go index 4f5af13b0ed..da60e5bdc7a 100644 --- a/service/tnb/types/enums.go +++ b/service/tnb/types/enums.go @@ -10,8 +10,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "text/plain", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for LcmOperationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LcmOperationType) Values() []LcmOperationType { return []LcmOperationType{ "INSTANTIATE", @@ -48,8 +50,9 @@ const ( ) // Values returns all known values for NsdOnboardingState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NsdOnboardingState) Values() []NsdOnboardingState { return []NsdOnboardingState{ "CREATED", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for NsdOperationalState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NsdOperationalState) Values() []NsdOperationalState { return []NsdOperationalState{ "ENABLED", @@ -85,8 +89,9 @@ const ( ) // Values returns all known values for NsdUsageState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NsdUsageState) Values() []NsdUsageState { return []NsdUsageState{ "IN_USE", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for NsLcmOperationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NsLcmOperationState) Values() []NsLcmOperationState { return []NsLcmOperationState{ "PROCESSING", @@ -133,8 +139,9 @@ const ( ) // Values returns all known values for NsState. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NsState) Values() []NsState { return []NsState{ "INSTANTIATED", @@ -158,8 +165,9 @@ const ( ) // Values returns all known values for OnboardingState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OnboardingState) Values() []OnboardingState { return []OnboardingState{ "CREATED", @@ -177,8 +185,9 @@ const ( ) // Values returns all known values for OperationalState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperationalState) Values() []OperationalState { return []OperationalState{ "ENABLED", @@ -194,8 +203,9 @@ const ( ) // Values returns all known values for PackageContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PackageContentType) Values() []PackageContentType { return []PackageContentType{ "application/zip", @@ -216,8 +226,9 @@ const ( ) // Values returns all known values for TaskStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TaskStatus) Values() []TaskStatus { return []TaskStatus{ "SCHEDULED", @@ -238,8 +249,9 @@ const ( ) // Values returns all known values for UpdateSolNetworkType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UpdateSolNetworkType) Values() []UpdateSolNetworkType { return []UpdateSolNetworkType{ "MODIFY_VNF_INFORMATION", @@ -255,8 +267,9 @@ const ( ) // Values returns all known values for UsageState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UsageState) Values() []UsageState { return []UsageState{ "IN_USE", @@ -273,8 +286,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "INSTANTIATED", @@ -291,8 +305,9 @@ const ( ) // Values returns all known values for VnfOperationalState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VnfOperationalState) Values() []VnfOperationalState { return []VnfOperationalState{ "STARTED", diff --git a/service/tnb/types/types.go b/service/tnb/types/types.go index 0fb5113dbc6..cfe438c5554 100644 --- a/service/tnb/types/types.go +++ b/service/tnb/types/types.go @@ -20,8 +20,10 @@ type ErrorInfo struct { noSmithyDocumentSerde } -// Metadata for function package artifacts. Artifacts are the contents of the -// package descriptor file and the state of the package. +// Metadata for function package artifacts. +// +// Artifacts are the contents of the package descriptor file and the state of the +// package. type FunctionArtifactMeta struct { // Lists of function package overrides. @@ -30,8 +32,9 @@ type FunctionArtifactMeta struct { noSmithyDocumentSerde } -// The metadata of a network function instance. A network function instance is a -// function in a function package . +// The metadata of a network function instance. +// +// A network function instance is a function in a function package . type GetSolFunctionInstanceMetadata struct { // The date that the resource was created. @@ -47,11 +50,12 @@ type GetSolFunctionInstanceMetadata struct { noSmithyDocumentSerde } -// Metadata related to the 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. +// Metadata related to the 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. type GetSolFunctionPackageMetadata struct { // The date that the resource was created. @@ -70,9 +74,11 @@ type GetSolFunctionPackageMetadata struct { noSmithyDocumentSerde } -// Information about a network function. 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. +// Information about a network function. +// +// 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 GetSolInstantiatedVnfInfo struct { // State of the network function. @@ -81,9 +87,11 @@ type GetSolInstantiatedVnfInfo struct { noSmithyDocumentSerde } -// The metadata of 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. +// The metadata of 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. type GetSolNetworkInstanceMetadata struct { // The date that the resource was created. @@ -99,9 +107,10 @@ type GetSolNetworkInstanceMetadata struct { noSmithyDocumentSerde } -// Metadata related to a network operation occurrence. A network operation is any -// operation that is done to your network, such as network instance instantiation -// or termination. +// Metadata related to a network operation occurrence. +// +// A network operation is any operation that is done to your network, such as +// network instance instantiation or termination. type GetSolNetworkOperationMetadata struct { // The date that the resource was created. @@ -117,9 +126,10 @@ type GetSolNetworkOperationMetadata struct { noSmithyDocumentSerde } -// Gets the details of a network operation. A network operation is any operation -// that is done to your network, such as network instance instantiation or -// termination. +// Gets the details of a network operation. +// +// A network operation is any operation that is done to your network, such as +// network instance instantiation or termination. type GetSolNetworkOperationTaskDetails struct { // Context for the network operation task. @@ -143,9 +153,11 @@ type GetSolNetworkOperationTaskDetails struct { noSmithyDocumentSerde } -// Metadata associated with 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. +// Metadata associated with 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. type GetSolNetworkPackageMetadata struct { // The date that the resource was created. @@ -165,10 +177,11 @@ type GetSolNetworkPackageMetadata struct { noSmithyDocumentSerde } -// Details of resource associated with a network function. 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. +// Details of resource associated with a network function. +// +// 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 GetSolVnfcResourceInfo struct { // The metadata of the network function compute. @@ -177,9 +190,11 @@ type GetSolVnfcResourceInfo struct { noSmithyDocumentSerde } -// The metadata of a network function. 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. +// The metadata of a network function. +// +// 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 GetSolVnfcResourceInfoMetadata struct { // Information about the cluster. @@ -194,8 +209,9 @@ type GetSolVnfcResourceInfoMetadata struct { noSmithyDocumentSerde } -// Information about the network function. A network function instance is a -// function in a function package . +// Information about the network function. +// +// A network function instance is a function in a function package . type GetSolVnfInfo struct { // State of the network function instance. @@ -207,8 +223,9 @@ type GetSolVnfInfo struct { noSmithyDocumentSerde } -// Lifecycle management operation details on the network instance. Lifecycle -// management operations are deploy, update, or delete operations. +// Lifecycle management operation details on the network instance. +// +// Lifecycle management operations are deploy, update, or delete operations. type LcmOperationInfo struct { // The identifier of the network operation. @@ -219,8 +236,9 @@ 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. @@ -253,9 +271,11 @@ type ListSolFunctionInstanceInfo struct { // This member is required. VnfPkgId *string - // Information about a network function. 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. + // Information about a network function. + // + // 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. InstantiatedVnfInfo *GetSolInstantiatedVnfInfo // Function package name. @@ -264,8 +284,9 @@ type ListSolFunctionInstanceInfo struct { noSmithyDocumentSerde } -// Lists network function instance metadata. A network function instance is a -// function in a function package . +// Lists network function instance metadata. +// +// A network function instance is a function in a function package . type ListSolFunctionInstanceMetadata struct { // When the network function instance was created. @@ -281,11 +302,12 @@ type ListSolFunctionInstanceMetadata struct { noSmithyDocumentSerde } -// Information about 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. +// Information about 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. type ListSolFunctionPackageInfo struct { // Function package ARN. @@ -331,11 +353,12 @@ type ListSolFunctionPackageInfo struct { noSmithyDocumentSerde } -// Details for the function package metadata. 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. +// Details for the function package metadata. +// +// 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. type ListSolFunctionPackageMetadata struct { // The date that the resource was created. @@ -351,9 +374,11 @@ 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. @@ -399,9 +424,11 @@ type ListSolNetworkInstanceInfo struct { noSmithyDocumentSerde } -// Metadata details for 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. +// Metadata details for 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. type ListSolNetworkInstanceMetadata struct { // The date that the resource was created. @@ -454,9 +481,10 @@ type ListSolNetworkOperationsInfo struct { noSmithyDocumentSerde } -// Metadata related to a network operation. A network operation is any operation -// that is done to your network, such as network instance instantiation or -// termination. +// Metadata related to a network operation. +// +// A network operation is any operation that is done to your network, such as +// network instance instantiation or termination. type ListSolNetworkOperationsMetadata struct { // The date that the resource was created. @@ -472,9 +500,11 @@ type ListSolNetworkOperationsMetadata struct { noSmithyDocumentSerde } -// Details 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. +// Details 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. type ListSolNetworkPackageInfo struct { // Network package ARN. @@ -529,9 +559,11 @@ type ListSolNetworkPackageInfo struct { noSmithyDocumentSerde } -// Metadata related to 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. +// Metadata related to 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. type ListSolNetworkPackageMetadata struct { // The date that the resource was created. @@ -547,8 +579,10 @@ type ListSolNetworkPackageMetadata struct { noSmithyDocumentSerde } -// Metadata for network package artifacts. Artifacts are the contents of the -// package descriptor file and the state of the package. +// Metadata for network package artifacts. +// +// Artifacts are the contents of the package descriptor file and the state of the +// package. type NetworkArtifactMeta struct { // Lists network package overrides. @@ -571,27 +605,34 @@ 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 -// standard telecommunication application) and function package descriptor that -// uses the TOSCA standard to describe how the network functions should run on your -// network. +// 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. type PutSolFunctionPackageContentMetadata struct { - // Metadata for function package artifacts. Artifacts are the contents of the - // package descriptor file and the state of the package. + // Metadata for function package artifacts. + // + // Artifacts are the contents of the package descriptor file and the state of the + // package. Vnfd *FunctionArtifactMeta noSmithyDocumentSerde } -// Update metadata in 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. +// Update metadata in 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. type PutSolNetworkPackageContentMetadata struct { - // Metadata for network package artifacts. Artifacts are the contents of the - // package descriptor file and the state of the package. + // Metadata for network package artifacts. + // + // Artifacts are the contents of the package descriptor file and the state of the + // package. Nsd *NetworkArtifactMeta noSmithyDocumentSerde @@ -610,7 +651,9 @@ type ToscaOverride struct { } // Information parameters and/or the configurable properties for a network -// function. A network function instance is a function in a function package . +// 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 @@ -619,8 +662,9 @@ type UpdateSolNetworkModify struct { // This member is required. VnfConfigurableProperties document.Interface - // ID of the network function instance. A network function instance is a function - // in a function package . + // ID of the network function instance. + // + // A network function instance is a function in a function package . // // This member is required. VnfInstanceId *string @@ -628,27 +672,34 @@ type UpdateSolNetworkModify struct { noSmithyDocumentSerde } -// Validates function package content metadata. 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. +// Validates function package content metadata. +// +// 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. type ValidateSolFunctionPackageContentMetadata struct { - // Metadata for function package artifacts. Artifacts are the contents of the - // package descriptor file and the state of the package. + // Metadata for function package artifacts. + // + // Artifacts are the contents of the package descriptor file and the state of the + // package. Vnfd *FunctionArtifactMeta noSmithyDocumentSerde } -// Validates network package content metadata. 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. +// Validates network package content metadata. +// +// 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. type ValidateSolNetworkPackageContentMetadata struct { - // Metadata for network package artifacts. Artifacts are the contents of the - // package descriptor file and the state of the package. + // Metadata for network package artifacts. + // + // Artifacts are the contents of the package descriptor file and the state of the + // package. Nsd *NetworkArtifactMeta noSmithyDocumentSerde diff --git a/service/transcribe/api_op_CreateCallAnalyticsCategory.go b/service/transcribe/api_op_CreateCallAnalyticsCategory.go index c2940f822d7..d8f90a6ac70 100644 --- a/service/transcribe/api_op_CreateCallAnalyticsCategory.go +++ b/service/transcribe/api_op_CreateCallAnalyticsCategory.go @@ -11,21 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new Call Analytics category. All categories are automatically applied -// to your Call Analytics transcriptions. Note that in order to apply categories to -// your transcriptions, you must create them before submitting your transcription -// request, as categories cannot be applied retroactively. When creating a new -// 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 -// 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) -// . +// Creates a new Call Analytics category. +// +// All categories are automatically applied to your Call Analytics transcriptions. +// Note that in order to apply categories to your transcriptions, you must create +// them before submitting your transcription request, as categories cannot be +// applied retroactively. +// +// When creating a new 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 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] and [Creating categories for real-time transcriptions]. +// +// [Creating categories for post-call transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html +// [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,7 +53,9 @@ 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. + // over a generic name like test-category . + // + // Category names are case sensitive. // // This member is required. CategoryName *string @@ -61,12 +70,17 @@ type CreateCallAnalyticsCategoryInput struct { Rules []types.Rule // 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. + // 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. InputType types.InputType noSmithyDocumentSerde diff --git a/service/transcribe/api_op_CreateLanguageModel.go b/service/transcribe/api_op_CreateLanguageModel.go index bbe90f8e948..9a15bb6be84 100644 --- a/service/transcribe/api_op_CreateLanguageModel.go +++ b/service/transcribe/api_op_CreateLanguageModel.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a new custom language model. When creating a new custom language model, -// you must specify: +// 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 func (c *Client) CreateLanguageModel(ctx context.Context, params *CreateLanguageModelInput, optFns ...func(*Options)) (*CreateLanguageModelOutput, error) { if params == nil { @@ -38,22 +43,25 @@ 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 . + // 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 . // // 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 - // Amazon Resource Name (ARN) of the role that has permission to access your - // 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. + // 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 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. // // This member is required. InputDataConfig *types.InputDataConfig @@ -61,29 +69,38 @@ type CreateLanguageModelInput struct { // The language code that represents the language of your model. Each custom // 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 - // 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 - // contain English audio. + // and tuning data. + // + // For a list of supported languages and their associated language codes, refer to + // the [Supported languages]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 contain + // English audio. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html // // This member is required. LanguageCode types.CLMLanguageCode - // A unique name, chosen by you, for your custom language model. This name is case - // sensitive, cannot contain spaces, and must be unique within an Amazon Web - // Services account. If you try to create a new custom language model with the same - // name as an existing custom language model, you get a ConflictException error. + // A unique name, chosen by you, for your custom language model. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new custom language model + // with the same name as an existing custom language model, you get a + // ConflictException error. // // This member is required. ModelName *string // 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) - // . + // custom language model at the time you create this new model. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [Tagging resources]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/transcribe/api_op_CreateMedicalVocabulary.go b/service/transcribe/api_op_CreateMedicalVocabulary.go index 7af1abb1397..1aa2f5ebbfa 100644 --- a/service/transcribe/api_op_CreateMedicalVocabulary.go +++ b/service/transcribe/api_op_CreateMedicalVocabulary.go @@ -12,18 +12,22 @@ import ( "time" ) -// Creates a new custom medical vocabulary. Before creating a new custom medical -// vocabulary, you must first upload a text file that contains your vocabulary -// table into an Amazon S3 bucket. Note that this differs from , where you can -// include a list of terms within your request using the Phrases flag; -// CreateMedicalVocabulary does not support the Phrases flag and only accepts -// 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) -// . +// Creates a new custom medical vocabulary. +// +// Before creating a new custom medical vocabulary, you must first upload a text +// file that contains your vocabulary table into an Amazon S3 bucket. Note that +// this differs from , where you can include a list of terms within your request +// using the Phrases flag; CreateMedicalVocabulary does not support the Phrases +// flag and only accepts 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]to get the character set for your language. +// +// For more information, see [Custom vocabularies]. +// +// [Custom vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html +// [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html func (c *Client) CreateMedicalVocabulary(ctx context.Context, params *CreateMedicalVocabularyInput, optFns ...func(*Options)) (*CreateMedicalVocabularyOutput, error) { if params == nil { params = &CreateMedicalVocabularyInput{} @@ -50,25 +54,29 @@ type CreateMedicalVocabularyInput struct { // The Amazon S3 location (URI) of the text file that contains your custom medical // vocabulary. The URI must be 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-file.txt + // resource you're calling. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt // // This member is required. VocabularyFileUri *string - // A unique name, chosen by you, for your new custom medical vocabulary. This name - // is case sensitive, cannot contain spaces, and must be unique within an Amazon - // Web Services account. If you try to create a new custom medical vocabulary with - // the same name as an existing custom medical vocabulary, you get a - // ConflictException error. + // A unique name, chosen by you, for your new custom medical vocabulary. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new custom medical + // vocabulary with the same name as an existing custom medical vocabulary, you get + // a ConflictException error. // // This member is required. VocabularyName *string // 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) - // . + // 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]. + // + // [Tagging resources]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html Tags []types.Tag noSmithyDocumentSerde @@ -77,16 +85,18 @@ 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) - // . + // medical transcription job request failed. See also: [Common Errors]. + // + // [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. 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 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, // 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_CreateVocabulary.go b/service/transcribe/api_op_CreateVocabulary.go index 064399b179d..fb931e0db74 100644 --- a/service/transcribe/api_op_CreateVocabulary.go +++ b/service/transcribe/api_op_CreateVocabulary.go @@ -12,16 +12,21 @@ import ( "time" ) -// Creates a new custom vocabulary. When creating a new custom vocabulary, you can -// either upload a text file that contains your new entries, phrases, and terms -// into an Amazon S3 bucket and include the URI in your request. Or you can include -// 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) -// . +// Creates a new custom vocabulary. +// +// When creating a new custom vocabulary, you can either upload a text file that +// contains your new entries, phrases, and terms into an Amazon S3 bucket and +// include the URI in your request. Or you can include 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]to get the character set for your language. +// +// For more information, see [Custom vocabularies]. +// +// [Custom vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html +// [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html func (c *Client) CreateVocabulary(ctx context.Context, params *CreateVocabularyInput, optFns ...func(*Options)) (*CreateVocabularyOutput, error) { if params == nil { params = &CreateVocabularyInput{} @@ -40,21 +45,27 @@ func (c *Client) CreateVocabulary(ctx context.Context, params *CreateVocabularyI type CreateVocabularyInput struct { // The language code that represents the language of the entries in 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. 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. + // 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]table. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html // // This member is required. LanguageCode types.LanguageCode - // A unique name, chosen by you, for your new custom vocabulary. This name is case - // sensitive, cannot contain spaces, and must be unique within an Amazon Web - // Services account. If you try to create a new custom vocabulary with the same - // name as an existing custom vocabulary, you get a ConflictException error. + // A unique name, chosen by you, for your new custom vocabulary. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new custom vocabulary + // with the same name as an existing custom vocabulary, you get a ConflictException + // error. // // This member is required. VocabularyName *string @@ -62,37 +73,49 @@ type CreateVocabularyInput struct { // 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) - // . + // 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]. + // + // [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. + // 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]to get the character set for your language. + // + // [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html 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) - // . + // custom vocabulary at the time you create this new custom vocabulary. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [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. // 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-file.txt Note that if you include - // VocabularyFileUri in your request, you cannot use the Phrases flag; you must - // choose one or the other. + // you're calling. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt + // + // Note that if you include VocabularyFileUri in your request, you cannot use the + // Phrases flag; you must choose one or the other. VocabularyFileUri *string noSmithyDocumentSerde @@ -101,15 +124,17 @@ 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) - // . + // custom vocabulary request failed. See also: [Common Errors]. + // + // [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, + // 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, // 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_CreateVocabularyFilter.go b/service/transcribe/api_op_CreateVocabularyFilter.go index 5aae6d107df..9f2541fe999 100644 --- a/service/transcribe/api_op_CreateVocabularyFilter.go +++ b/service/transcribe/api_op_CreateVocabularyFilter.go @@ -12,15 +12,20 @@ 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 -// 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) -// . +// 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]to get the character set for your language. +// +// For more information, see [Vocabulary filtering]. +// +// [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html +// [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{} @@ -40,20 +45,26 @@ 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) - // table. + // 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]table. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html // // This member is required. LanguageCode types.LanguageCode - // A unique name, chosen by you, for your new custom vocabulary filter. This name - // is case sensitive, cannot contain spaces, and must be unique within an Amazon - // Web Services account. If you try to create a new custom vocabulary filter with - // the same name as an existing custom vocabulary filter, you get a + // A unique name, chosen by you, for your new custom vocabulary filter. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new custom vocabulary + // filter with the same name as an existing custom vocabulary filter, you get a // ConflictException error. // // This member is required. @@ -62,38 +73,49 @@ type CreateVocabularyFilterInput struct { // 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) - // . + // 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]. + // + // [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) - // . + // 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]. + // + // [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 - // one or the other. + // 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 one or the other. VocabularyFilterFileUri *string // Use this parameter if you want to create your custom vocabulary filter by // including all desired terms, as comma-separated values, within your request. The // 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 - // 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. + // your file using the VocabularyFilterFileUri parameter. + // + // Note that if you include 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 Vocabularies]to get the character set for your language. + // + // [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html Words []string noSmithyDocumentSerde @@ -104,8 +126,9 @@ type CreateVocabularyFilterOutput struct { // The language code you selected for your custom vocabulary filter. 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 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, // 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_DescribeLanguageModel.go b/service/transcribe/api_op_DescribeLanguageModel.go index 97fe31ab38d..f2203850ceb 100644 --- a/service/transcribe/api_op_DescribeLanguageModel.go +++ b/service/transcribe/api_op_DescribeLanguageModel.go @@ -11,10 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the specified custom language model. This operation -// also shows if the base language model that you used to create your custom -// language model has been updated. If Amazon Transcribe has updated the base -// model, you can create a new custom language model using the updated base model. +// Provides information about the specified custom language model. +// +// This operation also shows if the base language model that you used to create +// your custom language model has been updated. If Amazon Transcribe has updated +// the base model, you can create a new custom language model using the updated +// base model. +// // If you tried to create a new custom language model and the request wasn't // successful, you can use DescribeLanguageModel to help identify the reason for // this failure. @@ -46,12 +49,16 @@ type DescribeLanguageModelInput struct { type DescribeLanguageModelOutput struct { - // Provides information about the specified custom language model. This parameter - // also shows if the base language model you used to create your custom language - // model has been updated. If Amazon Transcribe has updated the base model, you can - // create a new custom language model using the updated base model. If you tried to - // create a new custom language model and the request wasn't successful, you can - // use this DescribeLanguageModel to help identify the reason for this failure. + // Provides information about the specified custom language model. + // + // This parameter also shows if the base language model you used to create your + // custom language model has been updated. If Amazon Transcribe has updated the + // base model, you can create a new custom language model using the updated base + // model. + // + // If you tried to create a new custom language model and the request wasn't + // successful, you can use this DescribeLanguageModel to help identify the reason + // for this failure. LanguageModel *types.LanguageModel // Metadata pertaining to the operation's result. diff --git a/service/transcribe/api_op_GetCallAnalyticsCategory.go b/service/transcribe/api_op_GetCallAnalyticsCategory.go index 4bc500f1e5e..8813ae7b21e 100644 --- a/service/transcribe/api_op_GetCallAnalyticsCategory.go +++ b/service/transcribe/api_op_GetCallAnalyticsCategory.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the specified Call Analytics category. To get a list -// of your Call Analytics categories, use the operation. +// Provides information about the specified Call Analytics category. +// +// To get a list of your Call Analytics categories, use the operation. func (c *Client) GetCallAnalyticsCategory(ctx context.Context, params *GetCallAnalyticsCategoryInput, optFns ...func(*Options)) (*GetCallAnalyticsCategoryOutput, error) { if params == nil { params = &GetCallAnalyticsCategoryInput{} diff --git a/service/transcribe/api_op_GetCallAnalyticsJob.go b/service/transcribe/api_op_GetCallAnalyticsJob.go index f6e78480efe..ea4d5c51b48 100644 --- a/service/transcribe/api_op_GetCallAnalyticsJob.go +++ b/service/transcribe/api_op_GetCallAnalyticsJob.go @@ -11,16 +11,21 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 -// 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 -// operation. +// 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 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 operation. func (c *Client) GetCallAnalyticsJob(ctx context.Context, params *GetCallAnalyticsJobInput, optFns ...func(*Options)) (*GetCallAnalyticsJobOutput, error) { if params == nil { params = &GetCallAnalyticsJobInput{} diff --git a/service/transcribe/api_op_GetMedicalScribeJob.go b/service/transcribe/api_op_GetMedicalScribeJob.go index 85a285ac0c5..016e5b35534 100644 --- a/service/transcribe/api_op_GetMedicalScribeJob.go +++ b/service/transcribe/api_op_GetMedicalScribeJob.go @@ -11,11 +11,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the specified Medical Scribe job. To view the status -// of the specified medical transcription job, check the MedicalScribeJobStatus -// field. If the status is COMPLETED , the job is finished. You can find the -// results at the location specified in MedicalScribeOutput . If the status is -// FAILED , FailureReason provides details on why your Medical Scribe job failed. +// Provides information about the specified Medical Scribe job. +// +// To view the status of the specified medical transcription job, check the +// MedicalScribeJobStatus field. If the status is COMPLETED , the job is finished. +// You can find the results at the location specified in MedicalScribeOutput . If +// the status is FAILED , FailureReason provides details on why your Medical +// Scribe job failed. +// // To get a list of your Medical Scribe jobs, use the operation. func (c *Client) GetMedicalScribeJob(ctx context.Context, params *GetMedicalScribeJobInput, optFns ...func(*Options)) (*GetMedicalScribeJobOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_GetMedicalTranscriptionJob.go b/service/transcribe/api_op_GetMedicalTranscriptionJob.go index f8dfdc3c592..82f36d3d98f 100644 --- a/service/transcribe/api_op_GetMedicalTranscriptionJob.go +++ b/service/transcribe/api_op_GetMedicalTranscriptionJob.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Provides information about the specified medical transcription job. To view the -// status of the specified medical transcription job, check the +// 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 -// failed. To get a list of your medical transcription jobs, use the operation. +// 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 { params = &GetMedicalTranscriptionJobInput{} diff --git a/service/transcribe/api_op_GetMedicalVocabulary.go b/service/transcribe/api_op_GetMedicalVocabulary.go index 1391cc80458..cea5ad546ba 100644 --- a/service/transcribe/api_op_GetMedicalVocabulary.go +++ b/service/transcribe/api_op_GetMedicalVocabulary.go @@ -12,11 +12,14 @@ import ( "time" ) -// 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 -// failed. To get a list of your custom medical vocabularies, use the operation. +// 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 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 { params = &GetMedicalVocabularyInput{} @@ -50,8 +53,9 @@ type GetMedicalVocabularyOutput struct { 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) - // . + // custom medical vocabulary request failed. See also: [Common Errors]. + // + // [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 ( @@ -59,6 +63,7 @@ type GetMedicalVocabularyOutput struct { 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, // 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_GetTranscriptionJob.go b/service/transcribe/api_op_GetTranscriptionJob.go index 4849324cd81..2ea334c3339 100644 --- a/service/transcribe/api_op_GetTranscriptionJob.go +++ b/service/transcribe/api_op_GetTranscriptionJob.go @@ -11,14 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) GetTranscriptionJob(ctx context.Context, params *GetTranscriptionJobInput, optFns ...func(*Options)) (*GetTranscriptionJobOutput, error) { if params == nil { params = &GetTranscriptionJobInput{} diff --git a/service/transcribe/api_op_GetVocabulary.go b/service/transcribe/api_op_GetVocabulary.go index 2d166f60152..7735e4a6af5 100644 --- a/service/transcribe/api_op_GetVocabulary.go +++ b/service/transcribe/api_op_GetVocabulary.go @@ -12,10 +12,13 @@ import ( "time" ) -// 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. +// 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. func (c *Client) GetVocabulary(ctx context.Context, params *GetVocabularyInput, optFns ...func(*Options)) (*GetVocabularyOutput, error) { if params == nil { @@ -50,15 +53,17 @@ type GetVocabularyOutput struct { 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) - // . + // custom vocabulary request failed. See also: [Common Errors]. + // + // [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, + // 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, // 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_GetVocabularyFilter.go b/service/transcribe/api_op_GetVocabularyFilter.go index 02ff09bd2f1..bb93f769e74 100644 --- a/service/transcribe/api_op_GetVocabularyFilter.go +++ b/service/transcribe/api_op_GetVocabularyFilter.go @@ -12,8 +12,9 @@ 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,6 +51,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, // 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_ListCallAnalyticsCategories.go b/service/transcribe/api_op_ListCallAnalyticsCategories.go index d541b1db386..ac983e505a7 100644 --- a/service/transcribe/api_op_ListCallAnalyticsCategories.go +++ b/service/transcribe/api_op_ListCallAnalyticsCategories.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of Call Analytics categories, including all rules that make up -// each category. To get detailed information about a specific Call Analytics -// category, use the operation. +// each category. +// +// To get detailed information about a specific Call Analytics category, use the +// operation. func (c *Client) ListCallAnalyticsCategories(ctx context.Context, params *ListCallAnalyticsCategoriesInput, optFns ...func(*Options)) (*ListCallAnalyticsCategoriesOutput, error) { if params == nil { params = &ListCallAnalyticsCategoriesInput{} diff --git a/service/transcribe/api_op_ListCallAnalyticsJobs.go b/service/transcribe/api_op_ListCallAnalyticsJobs.go index 15e1e084d26..2f1d54d97d7 100644 --- a/service/transcribe/api_op_ListCallAnalyticsJobs.go +++ b/service/transcribe/api_op_ListCallAnalyticsJobs.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of Call Analytics jobs that match the specified criteria. If no -// criteria are specified, all Call Analytics jobs are returned. To get detailed -// information about a specific Call Analytics job, use the operation. +// criteria are specified, all Call Analytics jobs are returned. +// +// To get detailed information about a specific Call Analytics job, use the +// operation. func (c *Client) ListCallAnalyticsJobs(ctx context.Context, params *ListCallAnalyticsJobsInput, optFns ...func(*Options)) (*ListCallAnalyticsJobsOutput, error) { if params == nil { params = &ListCallAnalyticsJobsInput{} diff --git a/service/transcribe/api_op_ListLanguageModels.go b/service/transcribe/api_op_ListLanguageModels.go index 04ce3297fd0..91305ee3dc3 100644 --- a/service/transcribe/api_op_ListLanguageModels.go +++ b/service/transcribe/api_op_ListLanguageModels.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of custom language models that match the specified criteria. If -// no criteria are specified, all custom language models are returned. To get -// detailed information about a specific custom language model, use the operation. +// no criteria are specified, all custom language models are returned. +// +// To get detailed information about a specific custom language model, use the +// operation. func (c *Client) ListLanguageModels(ctx context.Context, params *ListLanguageModelsInput, optFns ...func(*Options)) (*ListLanguageModelsOutput, error) { if params == nil { params = &ListLanguageModelsInput{} diff --git a/service/transcribe/api_op_ListMedicalScribeJobs.go b/service/transcribe/api_op_ListMedicalScribeJobs.go index 2ffa6e156b1..1422bf0cf65 100644 --- a/service/transcribe/api_op_ListMedicalScribeJobs.go +++ b/service/transcribe/api_op_ListMedicalScribeJobs.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of Medical Scribe jobs that match the specified criteria. If no -// criteria are specified, all Medical Scribe jobs are returned. To get detailed -// information about a specific Medical Scribe job, use the operation. +// criteria are specified, all Medical Scribe jobs are returned. +// +// To get detailed information about a specific Medical Scribe job, use the +// operation. func (c *Client) ListMedicalScribeJobs(ctx context.Context, params *ListMedicalScribeJobsInput, optFns ...func(*Options)) (*ListMedicalScribeJobsOutput, error) { if params == nil { params = &ListMedicalScribeJobsInput{} diff --git a/service/transcribe/api_op_ListMedicalTranscriptionJobs.go b/service/transcribe/api_op_ListMedicalTranscriptionJobs.go index bd886e7351d..f4c2792193c 100644 --- a/service/transcribe/api_op_ListMedicalTranscriptionJobs.go +++ b/service/transcribe/api_op_ListMedicalTranscriptionJobs.go @@ -13,8 +13,10 @@ import ( // 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. +// 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{} diff --git a/service/transcribe/api_op_ListMedicalVocabularies.go b/service/transcribe/api_op_ListMedicalVocabularies.go index 7c7a6502820..d78d13b064d 100644 --- a/service/transcribe/api_op_ListMedicalVocabularies.go +++ b/service/transcribe/api_op_ListMedicalVocabularies.go @@ -13,8 +13,10 @@ import ( // Provides a list of custom medical vocabularies that match the specified // criteria. If no criteria are specified, all custom medical vocabularies are -// returned. To get detailed information about a specific custom medical -// vocabulary, use the operation. +// returned. +// +// To get detailed information about a specific custom medical vocabulary, use the +// operation. func (c *Client) ListMedicalVocabularies(ctx context.Context, params *ListMedicalVocabulariesInput, optFns ...func(*Options)) (*ListMedicalVocabulariesOutput, error) { if params == nil { params = &ListMedicalVocabulariesInput{} diff --git a/service/transcribe/api_op_ListTagsForResource.go b/service/transcribe/api_op_ListTagsForResource.go index 1313bfd84c0..4653c782ba4 100644 --- a/service/transcribe/api_op_ListTagsForResource.go +++ b/service/transcribe/api_op_ListTagsForResource.go @@ -12,9 +12,11 @@ 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) -// . +// model, or resource. +// +// To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. +// +// [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,9 +36,13 @@ 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: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 , + // . + // + // Valid values for resource-type are: transcription-job , // medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter // , and language-model . // diff --git a/service/transcribe/api_op_ListTranscriptionJobs.go b/service/transcribe/api_op_ListTranscriptionJobs.go index d37d6c2f2c7..c2582afbb35 100644 --- a/service/transcribe/api_op_ListTranscriptionJobs.go +++ b/service/transcribe/api_op_ListTranscriptionJobs.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of transcription jobs that match the specified criteria. If no -// criteria are specified, all transcription jobs are returned. To get detailed -// information about a specific transcription job, use the operation. +// criteria are specified, all transcription jobs are returned. +// +// To get detailed information about a specific transcription job, use the +// operation. func (c *Client) ListTranscriptionJobs(ctx context.Context, params *ListTranscriptionJobsInput, optFns ...func(*Options)) (*ListTranscriptionJobsOutput, error) { if params == nil { params = &ListTranscriptionJobsInput{} diff --git a/service/transcribe/api_op_ListVocabularies.go b/service/transcribe/api_op_ListVocabularies.go index 3f0d5cad7e7..bdd5d8ea855 100644 --- a/service/transcribe/api_op_ListVocabularies.go +++ b/service/transcribe/api_op_ListVocabularies.go @@ -12,8 +12,10 @@ import ( ) // Provides a list of custom vocabularies that match the specified criteria. If no -// criteria are specified, all custom vocabularies are returned. To get detailed -// information about a specific custom vocabulary, use the operation. +// criteria are specified, all custom vocabularies are returned. +// +// To get detailed information about a specific custom vocabulary, use the +// operation. func (c *Client) ListVocabularies(ctx context.Context, params *ListVocabulariesInput, optFns ...func(*Options)) (*ListVocabulariesOutput, error) { if params == nil { params = &ListVocabulariesInput{} diff --git a/service/transcribe/api_op_ListVocabularyFilters.go b/service/transcribe/api_op_ListVocabularyFilters.go index 4dd0652ec78..d540fbb6a17 100644 --- a/service/transcribe/api_op_ListVocabularyFilters.go +++ b/service/transcribe/api_op_ListVocabularyFilters.go @@ -12,8 +12,9 @@ import ( ) // Provides a list of custom vocabulary filters that match the specified criteria. -// If no criteria are specified, all custom vocabularies are returned. To get -// detailed information about a specific custom vocabulary filter, use the +// If no criteria are specified, all custom vocabularies are returned. +// +// To get detailed information about a specific custom vocabulary filter, use the // operation. func (c *Client) ListVocabularyFilters(ctx context.Context, params *ListVocabularyFiltersInput, optFns ...func(*Options)) (*ListVocabularyFiltersOutput, error) { if params == nil { diff --git a/service/transcribe/api_op_StartCallAnalyticsJob.go b/service/transcribe/api_op_StartCallAnalyticsJob.go index f4b6fee2de3..347bc419aeb 100644 --- a/service/transcribe/api_op_StartCallAnalyticsJob.go +++ b/service/transcribe/api_op_StartCallAnalyticsJob.go @@ -12,31 +12,37 @@ import ( ) // Transcribes the audio from a customer service call and applies any additional -// Request Parameters you choose to include in your request. In addition to many -// standard transcription features, Call Analytics provides you with call -// 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 +// Request Parameters you choose to include in your request. +// +// In addition to many standard transcription features, Call Analytics provides +// you with call 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]. +// +// 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: +// about Call Analytics categories, see [Creating categories for post-call transcriptions]and [Creating categories for real-time transcriptions]. +// +// 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) -// . +// refer to [Amazon Transcribe endpoints and quotas]. +// // - 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. // @@ -45,6 +51,11 @@ import ( // 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. +// +// [Amazon Transcribe endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html +// [Analyzing call center audio with Call Analytics]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html +// [Creating categories for post-call transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html +// [Creating categories for real-time transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html func (c *Client) StartCallAnalyticsJob(ctx context.Context, params *StartCallAnalyticsJobInput, optFns ...func(*Options)) (*StartCallAnalyticsJobOutput, error) { if params == nil { params = &StartCallAnalyticsJobInput{} @@ -62,10 +73,11 @@ func (c *Client) StartCallAnalyticsJob(ctx context.Context, params *StartCallAna type StartCallAnalyticsJobInput struct { - // A unique name, chosen by you, for your Call Analytics job. This name is case - // sensitive, cannot contain spaces, and must be unique within an Amazon Web - // Services account. If you try to create a new job with the same name as an - // existing job, you get a ConflictException error. + // A unique name, chosen by you, for your Call Analytics job. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // This member is required. CallAnalyticsJobName *string @@ -85,32 +97,49 @@ type StartCallAnalyticsJobInput 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 + // 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) - // . + // arn:aws:iam::111122223333:role/Admin . + // + // For more information, see [IAM ARNs]. + // + // [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: + // 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 do not 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. + // 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 @@ -119,16 +148,22 @@ type StartCallAnalyticsJobInput struct { // 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 + // // 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 do not specify - // a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side - // encryption. If you do not specify OutputLocation , your transcript is placed in - // a service-managed Amazon S3 bucket and you are provided with a URI to access - // your transcript. + // using the CallAnalyticsJobName parameter. + // + // You can specify a KMS key to encrypt your output using the + // OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon + // Transcribe uses the default Amazon S3 key for server-side encryption. + // + // If you do not 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_StartMedicalScribeJob.go b/service/transcribe/api_op_StartMedicalScribeJob.go index e50a4c97e48..12f9582df06 100644 --- a/service/transcribe/api_op_StartMedicalScribeJob.go +++ b/service/transcribe/api_op_StartMedicalScribeJob.go @@ -12,29 +12,41 @@ import ( ) // Transcribes patient-clinician conversations and generates clinical notes. +// // Amazon Web Services HealthScribe automatically provides rich conversation // transcripts, identifies speaker roles, classifies dialogues, extracts medical // terms, and generates preliminary clinical notes. To learn more about these -// features, refer to Amazon Web Services HealthScribe (https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html) -// . To make a StartMedicalScribeJob 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. You must include the following parameters -// in your StartMedicalTranscriptionJob request: +// features, refer to [Amazon Web Services HealthScribe]. +// +// To make a StartMedicalScribeJob 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. +// +// You must include the following parameters in your StartMedicalTranscriptionJob +// request: +// // - DataAccessRoleArn : The ARN of an IAM role with the these minimum // permissions: read permission on input file Amazon S3 bucket specified in Media // , write permission on the Amazon S3 bucket specified in OutputBucketName , and // full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if // set). The role should also allow transcribe.amazonaws.com to assume it. +// // - Media ( MediaFileUri ): The Amazon S3 location of your media file. +// // - MedicalScribeJobName : A custom name you create for your MedicalScribe job // that is unique within your Amazon Web Services account. +// // - OutputBucketName : The Amazon S3 bucket where you want your output files // stored. +// // - Settings : A MedicalScribeSettings obect that must set exactly one of // ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is // true, MaxSpeakerLabels must also be set. +// // - ChannelDefinitions : A MedicalScribeChannelDefinitions array should be set // if and only if the ChannelIdentification value of Settings is set to true. +// +// [Amazon Web Services HealthScribe]: https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html func (c *Client) StartMedicalScribeJob(ctx context.Context, params *StartMedicalScribeJobInput, optFns ...func(*Options)) (*StartMedicalScribeJobOutput, error) { if params == nil { params = &StartMedicalScribeJobInput{} @@ -55,37 +67,48 @@ type StartMedicalScribeJobInput struct { // The Amazon Resource Name (ARN) of an IAM role that has permissions to access // the Amazon S3 bucket that contains your input files, write to the output bucket, // and use your KMS key if supplied. If the role that you specify doesn’t have the - // appropriate permissions your request fails. IAM role ARNs have the format + // appropriate permissions 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) - // . + // arn:aws:iam::111122223333:role/Admin . + // + // For more information, see [IAM ARNs]. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns // // This member is required. DataAccessRoleArn *string // 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 - // 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. + // request. + // + // For information on supported media formats, refer to the MediaFormat parameter + // or the [Media formats]section in the Amazon S3 Developer Guide. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio // // This member is required. Media *types.Media - // A unique name, chosen by you, for your Medical Scribe job. This name is case - // sensitive, cannot contain spaces, and must be unique within an Amazon Web - // Services account. If you try to create a new job with the same name as an - // existing job, you get a ConflictException error. + // A unique name, chosen by you, for your Medical Scribe job. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // This member is required. MedicalScribeJobName *string // The name of the Amazon S3 bucket where you want your Medical Scribe output - // stored. Do not include the S3:// prefix of the specified bucket. Note that the - // role specified in the DataAccessRoleArn request parameter 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) - // . + // stored. Do not include the S3:// prefix of the specified bucket. + // + // Note that the role specified in the DataAccessRoleArn request parameter must + // have permission to use the specified location. You can change Amazon S3 + // permissions using the [Amazon Web Services Management Console]. See also [Permissions Required for IAM User Roles]. + // + // [Amazon Web Services Management Console]: https://console.aws.amazon.com/s3 + // [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 @@ -113,38 +136,51 @@ type StartMedicalScribeJobInput struct { // 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]and [Asymmetric keys in KMS]. + // + // [Asymmetric keys in KMS]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html + // [KMS encryption context]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context KMSEncryptionContext map[string]string - // The KMS key you want to use to encrypt your Medical Scribe output. If using a - // key located in the current Amazon Web Services account, you can specify your KMS - // key in one of four ways: + // The KMS key you want to use to encrypt your Medical Scribe 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 do not specify an encryption key, your output is encrypted with the - // default Amazon S3 key (SSE-S3). Note that the role specified in the - // DataAccessRoleArn request parameter must have permission to use the specified - // KMS key. + // default Amazon S3 key (SSE-S3). + // + // Note that the role specified in the DataAccessRoleArn request parameter must + // have permission to use the specified KMS key. OutputEncryptionKMSKeyId *string // Adds one or more custom tags, each in the form of a key:value pair, to the - // Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer - // to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) - // . + // Medica Scribe job. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [Tagging resources]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/transcribe/api_op_StartMedicalTranscriptionJob.go b/service/transcribe/api_op_StartMedicalTranscriptionJob.go index 328396e067a..901af6ef0b9 100644 --- a/service/transcribe/api_op_StartMedicalTranscriptionJob.go +++ b/service/transcribe/api_op_StartMedicalTranscriptionJob.go @@ -12,28 +12,41 @@ import ( ) // Transcribes the audio from a medical dictation or conversation and applies any -// additional Request Parameters you choose to include in your request. In addition -// 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 +// additional Request Parameters you choose to include in your request. +// +// In addition 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]. +// +// To make a StartMedicalTranscriptionJob 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. You must include the following -// parameters in your StartMedicalTranscriptionJob request: +// 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) -// . +// refer to [Amazon Transcribe endpoints and quotas]. +// // - 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. +// +// [How Amazon Transcribe Medical works]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html +// [Amazon Transcribe endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html func (c *Client) StartMedicalTranscriptionJob(ctx context.Context, params *StartMedicalTranscriptionJobInput, optFns ...func(*Options)) (*StartMedicalTranscriptionJobOutput, error) { if params == nil { params = &StartMedicalTranscriptionJobInput{} @@ -59,9 +72,12 @@ type StartMedicalTranscriptionJobInput struct { 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 - // 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. + // request. + // + // For information on supported media formats, refer to the MediaFormat parameter + // or the [Media formats]section in the Amazon S3 Developer Guide. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio // // This member is required. Media *types.Media @@ -69,25 +85,31 @@ type StartMedicalTranscriptionJobInput struct { // A unique name, chosen by you, for your medical transcription job. The name that // you specify is also used as the default name of your transcription output file. // If you want to specify a different name for your transcription output, use the - // OutputKey parameter. This name is case sensitive, cannot contain spaces, and - // must be unique within an Amazon Web Services account. If you try to create a new - // job with the same name as an existing job, you get a ConflictException error. + // OutputKey parameter. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // This member is required. MedicalTranscriptionJobName *string // The name of the Amazon S3 bucket where you want your medical 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 + // 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 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) - // . + // 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]. See also [Permissions Required for IAM User Roles]. + // + // [Amazon Web Services Management Console]: https://console.aws.amazon.com/s3 + // [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 @@ -100,58 +122,74 @@ type StartMedicalTranscriptionJobInput struct { Specialty types.Specialty // 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. + // 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. // // This member is required. Type types.Type // 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) . + // more information, see [Identifying personal health information (PHI) in a transcription]. + // + // [Identifying personal health information (PHI) in a 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]and [Asymmetric keys in KMS]. + // + // [Asymmetric keys in KMS]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html + // [KMS encryption context]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context KMSEncryptionContext map[string]string // Specify the format of your input media file. MediaFormat types.MediaFormat - // The sample rate, in hertz, of the audio track in your input media file. If you - // do not specify the media sample rate, Amazon Transcribe Medical determines it - // for 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. + // The sample rate, in hertz, of the audio track in your input media file. + // + // If you do not specify the media sample rate, Amazon Transcribe Medical + // determines it for 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. 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: + // 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 do not 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. + // 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 @@ -159,22 +197,28 @@ type StartMedicalTranscriptionJobInput struct { // 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 : + // 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 @@ -185,9 +229,11 @@ type StartMedicalTranscriptionJobInput struct { Settings *types.MedicalTranscriptionSetting // 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) - // . + // medical transcription job at the time you start this new job. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [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 26e663ea389..e81e7c5b004 100644 --- a/service/transcribe/api_op_StartTranscriptionJob.go +++ b/service/transcribe/api_op_StartTranscriptionJob.go @@ -12,24 +12,32 @@ import ( ) // Transcribes the audio from a media file and applies any additional Request -// Parameters you choose to include in your request. To make a -// StartTranscriptionJob 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. You must include the following parameters in your -// StartTranscriptionJob request: +// Parameters you choose to include in your request. +// +// To make a StartTranscriptionJob 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. +// +// 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) -// . +// refer to [Amazon Transcribe endpoints and quotas]. +// // - 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 do not know the languages spoken in your media, use either -// IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe -// identify the languages for you. +// parameter; you can find all valid language codes in the [Supported languages]table. If you do not +// know the languages spoken in your media, use either IdentifyLanguage or +// IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for +// you. +// +// [Amazon Transcribe endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html +// [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html func (c *Client) StartTranscriptionJob(ctx context.Context, params *StartTranscriptionJobInput, optFns ...func(*Options)) (*StartTranscriptionJobOutput, error) { if params == nil { params = &StartTranscriptionJobInput{} @@ -56,9 +64,11 @@ type StartTranscriptionJobInput struct { // A unique name, chosen by you, for your transcription job. The name that you // specify is also used as the default name of your transcription output file. If // you want to specify a different name for your transcription output, use the - // OutputKey parameter. This name is case sensitive, cannot contain spaces, and - // must be unique within an Amazon Web Services account. If you try to create a new - // job with the same name as an existing job, you get a ConflictException error. + // OutputKey parameter. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // This member is required. TranscriptionJobName *string @@ -73,61 +83,76 @@ type StartTranscriptionJobInput struct { // 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. + // 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. // 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 + // 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 , 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 + // 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 + // 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 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 + // 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]and [Asymmetric keys in KMS]. + // + // [Asymmetric keys in KMS]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html + // [KMS encryption context]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context 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 - // 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 - // must be encoded at a sample rate of 16,000 Hz or higher. + // 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]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. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageCode types.LanguageCode // If using automatic language identification in your request and you want to @@ -135,88 +160,120 @@ type StartTranscriptionJobInput struct { // 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 - // with the VocabularyName or VocabularyFilterName (or both) sub-parameter. + // 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 with the + // VocabularyName or VocabularyFilterName (or both) sub-parameter. LanguageIdSettings map[string]types.LanguageIdSettings // You can 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. 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 + // 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]. + // + // 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. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageOptions []types.LanguageCode // Specify the format of your input media file. MediaFormat types.MediaFormat - // The sample rate, in hertz, of the audio track in your input media file. If you - // do not specify the media sample rate, Amazon Transcribe determines it for you. - // If you specify the sample rate, it must match the rate detected by Amazon - // Transcribe. If there's a mismatch between the value that you specify and the - // value detected, your job fails. In most cases, you can omit MediaSampleRateHertz - // and let Amazon Transcribe determine the sample rate. + // The sample rate, in hertz, of the audio track in your input media file. + // + // If you do not specify the media sample rate, Amazon Transcribe determines it + // for you. If you specify the sample rate, it must match the rate detected by + // Amazon Transcribe. If there's a mismatch between the value that you specify and + // the value detected, your job fails. In most cases, you can omit + // MediaSampleRateHertz and let Amazon Transcribe determine the sample rate. MediaSampleRateHertz *int32 // 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) - // . + // LanguageModelName sub-parameter. + // + // For more information, see [Custom language models]. + // + // [Custom language 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 - // 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 do not specify OutputBucketName , your transcript is placed in a + // 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 to use the specified location. + // You can change Amazon S3 permissions using the [Amazon Web Services Management Console]. See also [Permissions Required for IAM User Roles]. + // + // If you do not specify OutputBucketName , your transcript is placed in a // service-managed Amazon S3 bucket and you are provided with a URI to access your // transcript. + // + // [Amazon Web Services Management Console]: https://console.aws.amazon.com/s3 + // [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 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: + // 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 do not 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. + // 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 @@ -224,36 +281,45 @@ type StartTranscriptionJobInput struct { // 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 : + // 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 // identification, alternative transcriptions, speaker partitioning. You can use - // that to apply custom vocabularies and vocabulary filters. 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 Settings with the - // 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 - // VocabularyFilterName sub-parameters. + // that to apply custom vocabularies and vocabulary filters. + // + // 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 Settings with the 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 VocabularyFilterName sub-parameters. Settings *types.Settings // Produces subtitle files for your input media. You can specify WebVTT (*.vtt) @@ -261,16 +327,19 @@ type StartTranscriptionJobInput struct { 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) - // . + // transcription job at the time you start this new job. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [Tagging resources]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html Tags []types.Tag // Enables toxic speech detection in your transcript. If you include // ToxicityDetection in your request, you must also include ToxicityCategories . - // For information on the types of toxic speech Amazon Transcribe can detect, see - // Detecting toxic speech (https://docs.aws.amazon.com/transcribe/latest/dg/toxic-language.html) - // . + // + // For information on the types of toxic speech Amazon Transcribe can detect, see [Detecting toxic speech]. + // + // [Detecting toxic speech]: https://docs.aws.amazon.com/transcribe/latest/dg/toxic-language.html ToxicityDetection []types.ToxicityDetectionSettings noSmithyDocumentSerde diff --git a/service/transcribe/api_op_TagResource.go b/service/transcribe/api_op_TagResource.go index 5bfe0dbeb62..c339de87034 100644 --- a/service/transcribe/api_op_TagResource.go +++ b/service/transcribe/api_op_TagResource.go @@ -12,9 +12,11 @@ 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) -// . +// specified resource. +// +// To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. +// +// [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,10 +35,13 @@ 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 - // example, + // 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 , + // . + // + // Valid values for resource-type are: transcription-job , // medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter // , and language-model . // @@ -44,9 +49,11 @@ type TagResourceInput struct { 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) - // . + // specified resource. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [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 c60bffd70be..b32f8aeaf1e 100644 --- a/service/transcribe/api_op_UntagResource.go +++ b/service/transcribe/api_op_UntagResource.go @@ -10,8 +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 +// 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 { @@ -32,9 +33,13 @@ 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: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 , + // . + // + // Valid values for resource-type are: transcription-job , // medical-transcription-job , vocabulary , medical-vocabulary , vocabulary-filter // , and language-model . // diff --git a/service/transcribe/api_op_UpdateCallAnalyticsCategory.go b/service/transcribe/api_op_UpdateCallAnalyticsCategory.go index 19eeb0d6c94..06c784ebd6a 100644 --- a/service/transcribe/api_op_UpdateCallAnalyticsCategory.go +++ b/service/transcribe/api_op_UpdateCallAnalyticsCategory.go @@ -14,7 +14,9 @@ import ( // Updates the specified Call Analytics category with new rules. Note that the // UpdateCallAnalyticsCategory operation overwrites all existing rules contained in // the specified category. You cannot append additional rules onto an existing -// category. To create a new category, see . +// category. +// +// To create a new category, see . func (c *Client) UpdateCallAnalyticsCategory(ctx context.Context, params *UpdateCallAnalyticsCategoryInput, optFns ...func(*Options)) (*UpdateCallAnalyticsCategoryOutput, error) { if params == nil { params = &UpdateCallAnalyticsCategoryInput{} diff --git a/service/transcribe/api_op_UpdateMedicalVocabulary.go b/service/transcribe/api_op_UpdateMedicalVocabulary.go index fe349b84433..a4b3f8605e3 100644 --- a/service/transcribe/api_op_UpdateMedicalVocabulary.go +++ b/service/transcribe/api_op_UpdateMedicalVocabulary.go @@ -41,8 +41,9 @@ type UpdateMedicalVocabularyInput struct { // The Amazon S3 location of the text file that contains your custom medical // vocabulary. 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-file.txt + // the resource you're calling. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt // // This member is required. VocabularyFileUri *string @@ -63,6 +64,7 @@ type UpdateMedicalVocabularyOutput struct { 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, // 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_UpdateVocabulary.go b/service/transcribe/api_op_UpdateVocabulary.go index dc2f3e11c17..ed1b672381b 100644 --- a/service/transcribe/api_op_UpdateVocabulary.go +++ b/service/transcribe/api_op_UpdateVocabulary.go @@ -34,12 +34,17 @@ type UpdateVocabularyInput struct { // The language code that represents the language of the entries in the custom // 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 - // 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. + // 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]table. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html // // This member is required. LanguageCode types.LanguageCode @@ -53,31 +58,41 @@ type UpdateVocabularyInput struct { // 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) - // . + // 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]. + // + // [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. + // 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]to get the character set for your language. + // + // [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html Phrases []string // The Amazon S3 location of the text file that contains your custom vocabulary. // 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-file.txt Note that if you include - // VocabularyFileUri in your request, you cannot use the Phrases flag; you must - // choose one or the other. + // you're calling. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt + // + // Note that if you include VocabularyFileUri in your request, you cannot use the + // Phrases flag; you must choose one or the other. VocabularyFileUri *string noSmithyDocumentSerde @@ -88,8 +103,9 @@ type UpdateVocabularyOutput struct { // The language code you selected for your custom vocabulary. 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, + // 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, // 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_UpdateVocabularyFilter.go b/service/transcribe/api_op_UpdateVocabularyFilter.go index 07418d6fcc1..58ec93169ee 100644 --- a/service/transcribe/api_op_UpdateVocabularyFilter.go +++ b/service/transcribe/api_op_UpdateVocabularyFilter.go @@ -41,32 +41,41 @@ type UpdateVocabularyFilterInput struct { // 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) - // . + // 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]. + // + // [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 - // one or the other. + // 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 one or the other. VocabularyFilterFileUri *string // Use this parameter if you want to update your custom vocabulary filter by // including all desired terms, as comma-separated values, within your request. The // 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 - // 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. + // your file using the VocabularyFilterFileUri parameter. + // + // Note that if you include 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 Vocabularies]to get the character set for your language. + // + // [Character Sets for Custom Vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html Words []string noSmithyDocumentSerde @@ -78,6 +87,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, // 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 dd56b20a148..4f140fa7e72 100644 --- a/service/transcribe/doc.go +++ b/service/transcribe/doc.go @@ -5,10 +5,13 @@ // // 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. diff --git a/service/transcribe/options.go b/service/transcribe/options.go index 6960421abe6..51647c25492 100644 --- a/service/transcribe/options.go +++ b/service/transcribe/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/transcribe/types/enums.go b/service/transcribe/types/enums.go index e02326995c8..dcd98bca2a4 100644 --- a/service/transcribe/types/enums.go +++ b/service/transcribe/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for BaseModelName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BaseModelName) Values() []BaseModelName { return []BaseModelName{ "NarrowBand", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for CallAnalyticsFeature. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallAnalyticsFeature) Values() []CallAnalyticsFeature { return []CallAnalyticsFeature{ "GENERATIVE_SUMMARIZATION", @@ -47,8 +49,9 @@ const ( ) // Values returns all known values for CallAnalyticsJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallAnalyticsJobStatus) Values() []CallAnalyticsJobStatus { return []CallAnalyticsJobStatus{ "QUEUED", @@ -68,8 +71,9 @@ const ( // Values returns all known values for CallAnalyticsSkippedReasonCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CallAnalyticsSkippedReasonCode) Values() []CallAnalyticsSkippedReasonCode { return []CallAnalyticsSkippedReasonCode{ "INSUFFICIENT_CONVERSATION_CONTENT", @@ -91,8 +95,9 @@ const ( ) // Values returns all known values for CLMLanguageCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CLMLanguageCode) Values() []CLMLanguageCode { return []CLMLanguageCode{ "en-US", @@ -114,8 +119,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -233,8 +239,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -358,8 +365,9 @@ const ( ) // Values returns all known values for MediaFormat. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaFormat) Values() []MediaFormat { return []MediaFormat{ "mp3", @@ -382,8 +390,9 @@ const ( // Values returns all known values for MedicalContentIdentificationType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MedicalContentIdentificationType) Values() []MedicalContentIdentificationType { return []MedicalContentIdentificationType{ "PHI", @@ -401,8 +410,9 @@ const ( ) // Values returns all known values for MedicalScribeJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MedicalScribeJobStatus) Values() []MedicalScribeJobStatus { return []MedicalScribeJobStatus{ "QUEUED", @@ -421,6 +431,7 @@ const ( // Values returns all known values for MedicalScribeLanguageCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (MedicalScribeLanguageCode) Values() []MedicalScribeLanguageCode { return []MedicalScribeLanguageCode{ @@ -438,8 +449,9 @@ const ( // Values returns all known values for MedicalScribeParticipantRole. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MedicalScribeParticipantRole) Values() []MedicalScribeParticipantRole { return []MedicalScribeParticipantRole{ "PATIENT", @@ -457,8 +469,9 @@ const ( ) // Values returns all known values for ModelStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ModelStatus) Values() []ModelStatus { return []ModelStatus{ "IN_PROGRESS", @@ -476,8 +489,9 @@ const ( ) // Values returns all known values for OutputLocationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OutputLocationType) Values() []OutputLocationType { return []OutputLocationType{ "CUSTOMER_BUCKET", @@ -494,8 +508,9 @@ const ( ) // Values returns all known values for ParticipantRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantRole) Values() []ParticipantRole { return []ParticipantRole{ "AGENT", @@ -522,8 +537,9 @@ const ( ) // Values returns all known values for PiiEntityType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PiiEntityType) Values() []PiiEntityType { return []PiiEntityType{ "BANK_ACCOUNT_NUMBER", @@ -550,8 +566,9 @@ const ( ) // Values returns all known values for RedactionOutput. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedactionOutput) Values() []RedactionOutput { return []RedactionOutput{ "redacted", @@ -567,8 +584,9 @@ const ( ) // Values returns all known values for RedactionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RedactionType) Values() []RedactionType { return []RedactionType{ "PII", @@ -586,8 +604,9 @@ const ( ) // Values returns all known values for SentimentValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SentimentValue) Values() []SentimentValue { return []SentimentValue{ "POSITIVE", @@ -605,8 +624,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -622,8 +642,9 @@ const ( ) // Values returns all known values for SubtitleFormat. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubtitleFormat) Values() []SubtitleFormat { return []SubtitleFormat{ "vtt", @@ -639,8 +660,9 @@ const ( ) // Values returns all known values for ToxicityCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ToxicityCategory) Values() []ToxicityCategory { return []ToxicityCategory{ "ALL", @@ -655,8 +677,9 @@ const ( ) // Values returns all known values for TranscriptFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscriptFilterType) Values() []TranscriptFilterType { return []TranscriptFilterType{ "EXACT", @@ -674,8 +697,9 @@ const ( ) // Values returns all known values for TranscriptionJobStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TranscriptionJobStatus) Values() []TranscriptionJobStatus { return []TranscriptionJobStatus{ "QUEUED", @@ -694,8 +718,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "CONVERSATION", @@ -713,8 +738,9 @@ const ( ) // Values returns all known values for VocabularyFilterMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VocabularyFilterMethod) Values() []VocabularyFilterMethod { return []VocabularyFilterMethod{ "remove", @@ -733,8 +759,9 @@ const ( ) // Values returns all known values for VocabularyState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VocabularyState) Values() []VocabularyState { return []VocabularyState{ "PENDING", diff --git a/service/transcribe/types/types.go b/service/transcribe/types/types.go index ece133feb10..629aabd81fe 100644 --- a/service/transcribe/types/types.go +++ b/service/transcribe/types/types.go @@ -7,18 +7,22 @@ import ( "time" ) -// A time range, in milliseconds, between two points in your media file. You can -// use StartTime and EndTime to search a custom segment. For example, setting -// StartTime to 10000 and EndTime to 50000 only searches for your specified -// criteria in the audio contained between the 10,000 millisecond mark and the -// 50,000 millisecond mark of your media file. You must use StartTime and EndTime -// 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 . +// A time range, in milliseconds, between two points in your media file. +// +// You can use StartTime and EndTime to search a custom segment. For example, +// setting StartTime to 10000 and EndTime to 50000 only searches for your +// specified criteria in the audio contained between the 10,000 millisecond mark +// and the 50,000 millisecond mark of your media file. You must use StartTime and +// EndTime 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 . type AbsoluteTimeRange struct { // The time, in milliseconds, when Amazon Transcribe stops searching for the @@ -44,15 +48,20 @@ type AbsoluteTimeRange struct { 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 -// 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. +// 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 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. type CallAnalyticsJob struct { // Provides detailed information about a call analytics job, including information @@ -63,24 +72,27 @@ type CallAnalyticsJob struct { // unique within an Amazon Web Services account. 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 - // on why your transcription job failed. + // 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 on why your transcription job failed. CallAnalyticsJobStatus CallAnalyticsJobStatus // Indicates which speaker is on which channel. 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, // 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, + // 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, // 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 @@ -89,46 +101,61 @@ type CallAnalyticsJob struct { DataAccessRoleArn *string // 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 refer to the MediaFormat parameter 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 + // 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 refer to the + // MediaFormat parameter 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 + // - 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 - // Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe) - // . - // - 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 Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe) - // . + // + // - 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 [Service quotas]. + // + // - 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 [Service quotas]. + // + // [Service quotas]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe 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) - // table. If you do not know the language spoken in your media file, you can omit - // this field and let Amazon Transcribe automatically identify the language of your + // supported languages and their associated language codes, refer to the [Supported languages]table. + // + // If you do not 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 // several language codes and Amazon Transcribe chooses the closest match for your // transcription. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageCode LanguageCode // Provides the Amazon S3 location of the media file you used in your Call @@ -146,8 +173,9 @@ type CallAnalyticsJob struct { // identification settings. 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, + // 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, // 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 @@ -163,8 +191,10 @@ type CallAnalyticsJob struct { type CallAnalyticsJobDetails struct { // Contains information about any skipped analytics features during the analysis - // of a call analytics job. This array lists all the analytics features that were - // skipped, along with their corresponding reason code and message. + // of a call analytics job. + // + // This array lists all the analytics features that were skipped, along with their + // corresponding reason code and message. Skipped []CallAnalyticsSkippedFeature noSmithyDocumentSerde @@ -186,41 +216,52 @@ type CallAnalyticsJobSettings struct { // 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) - // . + // 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]. + // + // [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 - // Analytics job. Note that custom language model names are case sensitive. The - // language of the specified custom language model must match the language code - // that you specify in your transcription request. If the languages do not match, - // the custom language model isn't applied. There are no errors or warnings + // Analytics job. Note that custom language model names are case sensitive. + // + // The language of the specified custom language model must match the language + // code that you specify in your transcription request. If the languages do not + // match, the custom language model isn't applied. There are no errors or warnings // associated with a language mismatch. LanguageModelName *string // You can 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. - // 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 - // must be encoded at a sample rate of 16,000 Hz or higher. + // + // For a list of languages supported with Call Analytics, refer to the [Supported languages] 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. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageOptions []LanguageCode // Contains GenerateAbstractiveSummary , which is a required parameter if you want @@ -228,14 +269,20 @@ type CallAnalyticsJobSettings struct { Summarization *Summarization // 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 . + // sensitive. + // + // Note that if you include VocabularyFilterName in your request, you must also + // include VocabularyFilterMethod . VocabularyFilterName *string // The name of the custom vocabulary you want to include in your Call Analytics @@ -256,35 +303,40 @@ 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 - // 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. + // 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. 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, // 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, + // 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, // 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) - // . + // why the Call Analytics job failed. See also: [Common Errors]. + // + // [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 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, // 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 @@ -293,10 +345,15 @@ type CallAnalyticsJobSummary struct { } // Represents a skipped analytics feature during the analysis of a call analytics -// job. The Feature field indicates the type of analytics feature that was -// skipped. The Message field contains additional information or a message -// explaining why the analytics feature was skipped. The ReasonCode field provides -// a code indicating the reason why the analytics feature was skipped. +// job. +// +// The Feature field indicates the type of analytics feature that was skipped. +// +// The Message field contains additional information or a message explaining why +// the analytics feature was skipped. +// +// The ReasonCode field provides a code indicating the reason why the analytics +// feature was skipped. type CallAnalyticsSkippedFeature struct { // Indicates the type of analytics feature that was skipped during the analysis of @@ -323,8 +380,9 @@ type CategoryProperties struct { // must be unique within an Amazon Web Services account. 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, + // 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, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. CreateTime *time.Time @@ -334,6 +392,7 @@ type CategoryProperties struct { 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, // 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022. LastUpdateTime *time.Time @@ -369,10 +428,12 @@ type ChannelDefinition struct { 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). + // 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 @@ -395,46 +456,61 @@ type ContentRedaction struct { } // 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 +// 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 + // 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) - // . + // arn:aws:iam::111122223333:role/Admin . + // + // For more information, see [IAM ARNs]. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns // // This member is required. DataAccessRoleArn *string // The Amazon S3 location (URI) of the text files you want to use to train your - // custom language model. Here's an example URI path: - // s3://DOC-EXAMPLE-BUCKET/my-model-training-data/ + // custom language model. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/ // // This member is required. S3Uri *string // The Amazon S3 location (URI) of the text files you want to use to tune your - // custom language model. Here's an example URI path: - // s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/ + // custom language model. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/ TuningDataS3Uri *string noSmithyDocumentSerde } // Flag the presence or absence of interruptions in your Call Analytics -// transcription output. Rules using InterruptionFilter are designed to match: +// 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 // -// 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. +// See [Rule criteria for post-call categories] for usage examples. +// +// [Rule criteria for post-call categories]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch type InterruptionFilter struct { // Makes it possible to specify a time range (in milliseconds) in your audio, @@ -462,8 +538,9 @@ type InterruptionFilter struct { // 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 +// 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 { @@ -472,18 +549,25 @@ type JobExecutionSettings struct { // 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 . + // 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 + // 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 + // arn:aws:iam::111122223333:role/Admin . For more information, see [IAM ARNs]. + // + // Note that if you include DataAccessRoleArn in your request, you must also // include AllowDeferredExecution . + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns DataAccessRoleArn *string noSmithyDocumentSerde @@ -510,62 +594,79 @@ type LanguageCodeItem struct { // 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 -// with the VocabularyName or VocabularyFilterName (or both) sub-parameter. +// 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 with the +// VocabularyName or VocabularyFilterName (or both) sub-parameter. type LanguageIdSettings struct { // The name of the custom language model you want to use when processing your - // transcription job. Note that custom language model names are case sensitive. The - // language of the specified custom language model must match the language code - // that you specify in your transcription request. If the languages do not match, - // the custom language model isn't applied. There are no errors or warnings + // transcription job. Note that custom language model names are case sensitive. + // + // The language of the specified custom language model must match the language + // code that you specify in your transcription request. If the languages do not + // match, the custom language model isn't applied. There are no errors or warnings // associated with a language mismatch. LanguageModelName *string // The name of the custom vocabulary filter you want to use when processing your - // transcription job. Custom vocabulary filter names are case sensitive. The - // language of the specified custom vocabulary filter must match the language code - // that you specify in your transcription request. If the languages do not match, - // 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 . + // transcription job. Custom vocabulary filter names are case sensitive. + // + // The language of the specified custom vocabulary filter must match the language + // code that you specify in your transcription request. If the languages do not + // match, 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 . VocabularyFilterName *string // The name of the custom vocabulary you want to use when processing your - // transcription job. Custom vocabulary names are case sensitive. The language of - // the specified custom vocabulary must match the language code that you specify in - // your transcription request. If the languages do not match, the custom vocabulary - // isn't applied. There are no errors or warnings associated with a language - // mismatch. + // transcription job. Custom vocabulary names are case sensitive. + // + // The language of the specified custom vocabulary must match the language code + // that you specify in your transcription request. If the languages do not match, + // the custom vocabulary isn't applied. There are no errors or warnings associated + // with a language mismatch. VocabularyName *string noSmithyDocumentSerde } // 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 type LanguageModel struct { @@ -573,14 +674,16 @@ type LanguageModel struct { // your custom language model. 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, + // 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, // 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) - // . + // custom language model request failed. See also: [Common Errors]. + // + // [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 @@ -591,20 +694,25 @@ type LanguageModel struct { // The language code used to create your custom language model. Each custom // 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 - // Transcribe Medical. + // and tuning data. + // + // For a list of supported languages and their associated language codes, refer to + // the [Supported languages]table. Note that US English ( en-US ) is the only language supported with + // Amazon Transcribe Medical. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html 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, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time - // A unique name, chosen by you, for your custom language model. This name is case - // sensitive, cannot contain spaces, and must be unique within an Amazon Web - // Services account. + // A unique name, chosen by you, for your custom language model. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. ModelName *string // The status of the specified custom language model. When the status displays as @@ -612,38 +720,54 @@ 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 - // 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. + // 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. UpgradeAvailability *bool noSmithyDocumentSerde } // 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 -// 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. +// request. +// +// For information on supported media formats, refer to the MediaFormat parameter +// or the [Media formats]section in the Amazon S3 Developer Guide. +// +// [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio 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. 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. + // 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 @@ -667,11 +791,13 @@ type MedicalScribeChannelDefinition struct { noSmithyDocumentSerde } -// Provides detailed information about a Medical Scribe job. To view the status of -// the specified Medical Scribe job, check the MedicalScribeJobStatus field. If -// the status is COMPLETED , the job is finished and you can find the results at -// the locations specified in MedicalScribeOutput . If the status is FAILED , -// FailureReason provides details on why your Medical Scribe job failed. +// Provides detailed information about a Medical Scribe job. +// +// To view the status of the specified Medical Scribe job, check the +// MedicalScribeJobStatus field. If the status is COMPLETED , the job is finished +// and you can find the results at the locations specified in MedicalScribeOutput . +// If the status is FAILED , FailureReason provides details on why your Medical +// Scribe job failed. type MedicalScribeJob struct { // Makes it possible to specify which speaker is on which channel. For example, if @@ -684,13 +810,15 @@ type MedicalScribeJob struct { ChannelDefinitions []MedicalScribeChannelDefinition // The date and time the specified Medical Scribe job finished processing. + // // 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 Medical Scribe job that finished // processing at 12:32 PM UTC-7 on May 4, 2022. CompletionTime *time.Time - // The date and time the specified Medical Scribe job request was made. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, + // The date and time the specified Medical Scribe job request was made. + // + // 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 Medical Scribe job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time @@ -698,15 +826,21 @@ type MedicalScribeJob struct { // The Amazon Resource Name (ARN) of an IAM role that has permissions to access // the Amazon S3 bucket that contains your input files, write to the output bucket, // and use your KMS key if supplied. If the role that you specify doesn’t have the - // appropriate permissions your request fails. IAM role ARNs have the format + // appropriate permissions 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) - // . + // arn:aws:iam::111122223333:role/Admin . + // + // For more information, see [IAM ARNs]. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns DataAccessRoleArn *string // If MedicalScribeJobStatus 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) - // . + // why the transcription job failed. See also: [Common Errors]. + // + // [Common Errors]: https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html FailureReason *string // The language code used to create your Medical Scribe job. US English ( en-US ) @@ -714,19 +848,23 @@ type MedicalScribeJob struct { LanguageCode MedicalScribeLanguageCode // 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 - // 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. + // request. + // + // For information on supported media formats, refer to the MediaFormat parameter + // or the [Media formats]section in the Amazon S3 Developer Guide. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio Media *Media // The name of the Medical Scribe job. Job names are case sensitive and must be // unique within an Amazon Web Services account. MedicalScribeJobName *string - // Provides the status of the specified Medical Scribe job. If the status is - // COMPLETED , the job is finished and you can find the results at the location - // specified in MedicalScribeOutput If the status is FAILED , FailureReason - // provides details on why your Medical Scribe job failed. + // Provides the status of the specified Medical Scribe job. + // + // If the status is COMPLETED , the job is finished and you can find the results at + // the location specified in MedicalScribeOutput If the status is FAILED , + // FailureReason provides details on why your Medical Scribe job failed. MedicalScribeJobStatus MedicalScribeJobStatus // The location of the output of your Medical Scribe job. ClinicalDocumentUri @@ -744,16 +882,19 @@ type MedicalScribeJob struct { // be specified if VocabularyFilterName is set. Settings *MedicalScribeSettings - // The date and time your Medical Scribe job began processing. Timestamps are in - // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, + // The date and time your Medical Scribe 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 Medical Scribe job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time // Adds one or more custom tags, each in the form of a key:value pair, to the - // Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer - // to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html) - // . + // Medica Scribe job. + // + // To learn more about using tags with Amazon Transcribe, refer to [Tagging resources]. + // + // [Tagging resources]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html Tags []Tag noSmithyDocumentSerde @@ -763,20 +904,23 @@ type MedicalScribeJob struct { type MedicalScribeJobSummary struct { // The date and time the specified Medical Scribe job finished processing. + // // 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 Medical Scribe job that finished // processing at 12:32 PM UTC-7 on May 4, 2022. CompletionTime *time.Time - // The date and time the specified Medical Scribe job request was made. Timestamps - // are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, + // The date and time the specified Medical Scribe job request was made. + // + // 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 Medical Scribe job that started // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time // If MedicalScribeJobStatus 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) - // . + // why the transcription job failed. See also: [Common Errors]. + // + // [Common Errors]: https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html FailureReason *string // The language code used to create your Medical Scribe job. US English ( en-US ) @@ -787,14 +931,16 @@ type MedicalScribeJobSummary struct { // unique within an Amazon Web Services account. MedicalScribeJobName *string - // Provides the status of the specified Medical Scribe job. If the status is - // COMPLETED , the job is finished and you can find the results at the location - // specified in MedicalScribeOutput If the status is FAILED , FailureReason - // provides details on why your Medical Scribe job failed. + // Provides the status of the specified Medical Scribe job. + // + // If the status is COMPLETED , the job is finished and you can find the results at + // the location specified in MedicalScribeOutput If the status is FAILED , + // FailureReason provides details on why your Medical Scribe job failed. MedicalScribeJobStatus MedicalScribeJobStatus - // The date and time your Medical Scribe job began processing. Timestamps are in - // the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example, + // The date and time your Medical Scribe 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 Medical Scribe job that started // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time @@ -830,35 +976,51 @@ type MedicalScribeOutput struct { // be specified if VocabularyFilterName is set. type MedicalScribeSettings struct { - // Enables channel identification in multi-channel audio. Channel identification - // transcribes the audio on each channel independently, then appends the output for - // each channel into one transcript. For more information, see Transcribing - // multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) - // . + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for each channel into one transcript. + // + // For more information, see [Transcribing multi-channel audio]. + // + // [Transcribing multi-channel audio]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html ChannelIdentification *bool // 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. + // multiple speakers are treated as a single speaker. + // + // If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels + // field to true. MaxSpeakerLabels *int32 // Enables speaker partitioning (diarization) in your Medical Scribe 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 . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) - // . + // file. + // + // If you enable ShowSpeakerLabels in your request, you must also include + // MaxSpeakerLabels . + // + // For more information, see [Partitioning speakers (diarization)]. + // + // [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 include in your Medical - // Scribe request. Custom vocabulary filter names are case sensitive. Note that if - // you include VocabularyFilterName in your request, you must also include - // VocabularyFilterMethod . + // Scribe request. Custom vocabulary filter names are case sensitive. + // + // Note that if you include VocabularyFilterName in your request, you must also + // include VocabularyFilterMethod . VocabularyFilterName *string // The name of the custom vocabulary you want to include in your Medical Scribe @@ -872,15 +1034,18 @@ type MedicalScribeSettings struct { type MedicalTranscript struct { // The Amazon S3 location of your transcript. You can use this URI to access or - // download your transcript. Note that this is the Amazon S3 location you specified - // in your request using the OutputBucketName parameter. + // download your transcript. + // + // Note that this is the Amazon S3 location you specified in your request using + // the OutputBucketName parameter. TranscriptFileUri *string noSmithyDocumentSerde } -// Provides detailed information about a medical transcription job. To view the -// status of the specified medical transcription job, check the +// 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 @@ -888,6 +1053,7 @@ type MedicalTranscript struct { 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, // 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. @@ -898,36 +1064,49 @@ 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, // 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 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 refer to the MediaFormat parameter 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 + // 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 refer to the + // MediaFormat parameter 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 + // - 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 - // Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe) - // . - // - 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 Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe) - // . + // + // - 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 [Service quotas]. + // + // - 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 [Service quotas]. + // + // [Service quotas]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe FailureReason *string // The language code used to create your medical transcription job. US English ( @@ -935,9 +1114,12 @@ type MedicalTranscriptionJob struct { 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 - // 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. + // request. + // + // For information on supported media formats, refer to the MediaFormat parameter + // or the [Media formats]section in the Amazon S3 Developer Guide. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio Media *Media // The format of the input media file. @@ -960,6 +1142,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, // 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. @@ -972,10 +1155,11 @@ 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 @@ -989,25 +1173,29 @@ 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, // 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) . + // more information, see [Identifying personal health information (PHI) in a transcription]. + // + // [Identifying personal health information (PHI) in a 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, // 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) - // . + // why the transcription job failed. See also: [Common Errors]. + // + // [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 @@ -1018,28 +1206,33 @@ type MedicalTranscriptionJobSummary struct { // 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 - // 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 bucket. To access a transcript stored in a service-managed bucket, use - // the URI shown in the TranscriptFileUri field. + // Indicates where the specified medical transcription output is stored. + // + // If the 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 Amazon S3 + // bucket. To access a transcript stored in a service-managed bucket, use the URI + // shown in the TranscriptFileUri field. OutputLocationType OutputLocationType // Provides the medical specialty represented in your media. 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, + // 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, // 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. + // 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. TranscriptionJobStatus TranscriptionJobStatus // Indicates whether the input media is a dictation or a conversation, as @@ -1054,70 +1247,95 @@ type MedicalTranscriptionJobSummary struct { // use that to apply custom vocabularies to your medical transcription job. type MedicalTranscriptionSetting struct { - // Enables channel identification in multi-channel audio. Channel identification - // transcribes the audio on each channel independently, then appends the output for - // 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 does not separate the speech by channel. For more - // information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) - // . + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for 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 does not + // separate the speech by channel. + // + // For more information, see [Transcribing multi-channel audio]. + // + // [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 - // Transcribe Medical to include in your transcript. If you select a number greater - // 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) - // . + // Transcribe Medical to include in your transcript. + // + // If you select a number greater 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]. + // + // [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. + // 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 - // 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) - // . + // 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]. + // + // [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 . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) - // . + // file. + // + // If you enable ShowSpeakerLabels in your request, you must also include + // MaxSpeakerLabels . + // + // For more information, see [Partitioning speakers (diarization)]. + // + // [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 - // transcription job. Custom vocabulary names are case sensitive. The language of - // the specified custom vocabulary must match the language code that you specify in - // your transcription request. If the languages do not 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 - // Medical. + // transcription job. Custom vocabulary names are case sensitive. + // + // The language of the specified custom vocabulary must match the language code + // that you specify in your transcription request. If the languages do not 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 Medical. VocabularyName *string noSmithyDocumentSerde } // 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. +// 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. type ModelSettings struct { // The name of the custom language model you want to use when processing your - // transcription job. Note that custom language model names are case sensitive. The - // language of the specified custom language model must match the language code - // that you specify in your transcription request. If the languages do not match, - // the custom language model isn't applied. There are no errors or warnings + // transcription job. Note that custom language model names are case sensitive. + // + // The language of the specified custom language model must match the language + // code that you specify in your transcription request. If the languages do not + // match, the custom language model isn't applied. There are no errors or warnings // associated with a language mismatch. LanguageModelName *string @@ -1125,12 +1343,17 @@ 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: +// 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 // -// 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. +// See [Rule criteria for post-call categories] for usage examples. +// +// [Rule criteria for post-call categories]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch type NonTalkTimeFilter struct { // Makes it possible to specify a time range (in milliseconds) in your audio, @@ -1152,16 +1375,20 @@ type NonTalkTimeFilter struct { noSmithyDocumentSerde } -// A time range, in percentage, between two points in your media file. You can use -// 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 . +// A time range, in percentage, between two points in your media file. +// +// You can use 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 . type RelativeTimeRange struct { // The time, in percentage, when Amazon Transcribe stops searching for the @@ -1188,13 +1415,13 @@ 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) -// . +// 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] and [Creating categories for real-time transcriptions]. +// +// To learn more about Call Analytics, see [Analyzing call center audio with Call Analytics]. // // The following types satisfy this interface: // @@ -1202,6 +1429,10 @@ type RelativeTimeRange struct { // RuleMemberNonTalkTimeFilter // RuleMemberSentimentFilter // RuleMemberTranscriptFilter +// +// [Analyzing call center audio with Call Analytics]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html +// [Creating categories for post-call transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html +// [Creating categories for real-time transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html type Rule interface { isRule() } @@ -1247,19 +1478,25 @@ type RuleMemberTranscriptFilter struct { 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: +// 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 // -// 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. +// See [Rule criteria for post-call categories] for usage examples. +// +// [Rule criteria for post-call categories]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch type SentimentFilter struct { // Specify the sentiments that you want to flag. @@ -1293,55 +1530,83 @@ type SentimentFilter struct { // use that to apply custom vocabularies to your transcription job. type Settings struct { - // Enables channel identification in multi-channel audio. Channel identification - // transcribes the audio on each channel independently, then appends the output for - // each channel into one transcript. For more information, see Transcribing - // multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) - // . + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for each channel into one transcript. + // + // For more information, see [Transcribing multi-channel audio]. + // + // [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 - // Transcribe to include in your transcript. If you select a number greater than - // 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) - // . + // Transcribe to include in your transcript. + // + // If you select a number greater than 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]. + // + // [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. + // 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. + // 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) - // . + // to generate. + // + // For more information, see [Alternative transcriptions]. + // + // [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 . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) - // . + // file. + // + // If you enable ShowSpeakerLabels in your request, you must also include + // MaxSpeakerLabels . + // + // For more information, see [Partitioning speakers (diarization)]. + // + // [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 . + // unique within an Amazon Web Services account. + // + // Note that if you include VocabularyFilterName in your request, you must also + // include VocabularyFilterMethod . VocabularyFilterName *string // The name of the custom vocabulary you want to use in your transcription job @@ -1352,18 +1617,22 @@ type Settings struct { noSmithyDocumentSerde } -// Generate subtitles for your media file with your transcription request. You can -// choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or -// both) as your output format. Note that your subtitle files are placed in the -// same location as your transcription output. +// Generate subtitles for your media file with your transcription request. +// +// You can choose a start index of 0 or 1, and you can specify either WebVTT or +// SubRip (or both) as your output format. +// +// Note that your subtitle files are placed in the 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. 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 + // 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. OutputStartIndex *int32 @@ -1386,13 +1655,18 @@ type SubtitlesOutput struct { // The Amazon S3 location of your transcript. You can use this URI to access or // download your subtitle file. Your subtitle file is stored in the same location // as your transcript. If you specified both WebVTT and SubRip subtitle formats, - // two URIs are provided. 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. + // two URIs are provided. + // + // 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 // subtitle file is stored in a service-managed bucket, and TranscriptFileUri // provides you with a temporary URI you can use for secure access to your subtitle - // file. Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 + // file. + // + // 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. SubtitleFileUris []string @@ -1404,11 +1678,14 @@ type SubtitlesOutput struct { // to enable Generative call summarization in your Call Analytics request. type Summarization struct { - // Enables Generative call summarization in your Call Analytics request Generative - // call summarization provides a summary of the transcript including important - // components discussed in the conversation. For more information, see Enabling - // generative call summarization (https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html) - // . + // Enables Generative call summarization in your Call Analytics request + // + // Generative call summarization provides a summary of the transcript including + // important components discussed in the conversation. + // + // For more information, see [Enabling generative call summarization]. + // + // [Enabling generative call summarization]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html // // This member is required. GenerateAbstractiveSummary *bool @@ -1416,11 +1693,15 @@ type Summarization struct { noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [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 @@ -1430,9 +1711,10 @@ type Tag struct { 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 - // 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 + // 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. // // This member is required. @@ -1445,7 +1727,7 @@ type Tag struct { // enable toxicity detection ( ToxicityDetection ) in your transcription request. type ToxicityDetectionSettings struct { - // If you include ToxicityDetection in your transcription request, you must also + // If you include ToxicityDetection in your transcription request, you must also // include ToxicityCategories . The only accepted value for this parameter is ALL . // // This member is required. @@ -1458,44 +1740,57 @@ type ToxicityDetectionSettings struct { type Transcript struct { // The Amazon S3 location of your redacted 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 - // RedactedTranscriptFileUri 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. + // 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 RedactedTranscriptFileUri + // 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. 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 } // Flag the presence or absence of specific words or phrases detected in your Call -// Analytics transcription output. Rules using TranscriptFilter are designed to -// match: +// 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 // -// 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. +// See [Rule criteria for post-call categories] and [Rule criteria for streaming categories] for usage examples. +// +// [Rule criteria for streaming categories]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream +// [Rule criteria for post-call categories]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch type TranscriptFilter struct { // Specify the phrases that you want to flag. @@ -1505,9 +1800,11 @@ type TranscriptFilter struct { // Flag the presence or absence of an exact match to the phrases that you specify. // For example, if you specify the phrase "speak to a manager" as your Targets - // value, only that exact phrase is flagged. Note that semantic matching is not - // supported. For example, if your customer says "speak to the manager", instead of - // "speak to a manager", your content is not flagged. + // value, only that exact phrase is flagged. + // + // Note that semantic matching is not supported. For example, if your customer + // says "speak to the manager", instead of "speak to a manager", your content is + // not flagged. // // This member is required. TranscriptFilterType TranscriptFilterType @@ -1534,16 +1831,20 @@ type TranscriptFilter struct { noSmithyDocumentSerde } -// 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 . +// 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 . 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, // 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. @@ -1552,43 +1853,57 @@ type TranscriptionJob struct { // Indicates whether redaction was enabled in your transcript. 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, + // 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, // 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 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 refer to the MediaFormat parameter 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 + // 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 refer to the + // MediaFormat parameter 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 + // - 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 - // Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe) - // . - // - 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 Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe) - // . + // + // - 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 [Service quotas]. + // + // - 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 [Service quotas]. + // + // [Service quotas]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe 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 @@ -1638,8 +1953,9 @@ type TranscriptionJob struct { // filters. 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, + // 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, // 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 @@ -1662,11 +1978,12 @@ type TranscriptionJob struct { // unique within an Amazon Web Services account. 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 - // on why your transcription job failed. + // 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 on why your transcription job failed. TranscriptionJobStatus TranscriptionJobStatus noSmithyDocumentSerde @@ -1676,6 +1993,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, // 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. @@ -1684,21 +2002,24 @@ type TranscriptionJobSummary struct { // The content redaction settings of the transcription job. 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, + // 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, // 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) - // . + // why the transcription job failed. See also: [Common Errors]. + // + // [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 @@ -1718,23 +2039,28 @@ type TranscriptionJobSummary struct { 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. + // 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. 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 - // 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. + // 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 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 // 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 @@ -1747,11 +2073,12 @@ 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 - // 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. + // 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. TranscriptionJobStatus TranscriptionJobStatus noSmithyDocumentSerde @@ -1763,15 +2090,21 @@ 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) - // table. + // 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]table. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html 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, // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time @@ -1790,14 +2123,17 @@ type VocabularyFilterInfo struct { 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. + // 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. 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, + // 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, // 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/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go b/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go index a26eefebe29..efd1886dc7d 100644 --- a/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go +++ b/service/transcribestreaming/api_op_StartCallAnalyticsStreamTranscription.go @@ -17,15 +17,20 @@ 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) -// transcriptions. The following parameters are required: +// application. Use this operation for [Call Analytics]transcriptions. +// +// The following parameters are required: +// // - 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]. +// +// [Call Analytics]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html +// [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{} @@ -43,23 +48,31 @@ func (c *Client) StartCallAnalyticsStreamTranscription(ctx context.Context, para type StartCallAnalyticsStreamTranscriptionInput struct { - // 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 streaming Call Analytics, refer to the Supported - // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // 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 streaming Call Analytics, refer to the [Supported languages] // table. // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html + // // 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) - // . + // + // For more information, see [Media formats]. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio // // This member is required. MediaEncoding types.MediaEncoding @@ -73,51 +86,72 @@ type StartCallAnalyticsStreamTranscriptionInput struct { MediaSampleRateHertz *int32 // 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) - // . + // 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]. + // + // [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. + // 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]. + // + // [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]. + // + // [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 // processing your transcription. Note that language model names are case - // sensitive. The language 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) - // . + // sensitive. + // + // The language 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]. + // + // [Custom language 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 - // 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) - // . + // stabilization ( EnablePartialResultsStabilization ). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. + // + // For more information, see [Partial-result stabilization]. + // + // [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 . + // 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 . @@ -125,30 +159,43 @@ type StartCallAnalyticsStreamTranscriptionInput struct { // Specify a name for your Call Analytics transcription session. If you don't // include this parameter in your request, Amazon Transcribe generates an ID and - // returns it in the response. You can use a session ID to retry a streaming - // session. + // returns it in the response. + // + // You can use a session ID to retry a streaming session. 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 . + // 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 . VocabularyFilterMethod types.VocabularyFilterMethod // Specify the name of the custom vocabulary filter that you want to use when // processing your transcription. Note that vocabulary filter names are case - // 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) - // . + // 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]. + // + // [Using vocabulary 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 + // 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]. + // + // [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 47ebc3ef181..911d41582ec 100644 --- a/service/transcribestreaming/api_op_StartMedicalStreamTranscription.go +++ b/service/transcribestreaming/api_op_StartMedicalStreamTranscription.go @@ -17,14 +17,19 @@ 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: +// application. +// +// The following parameters are required: +// // - 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]. +// +// [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{} @@ -43,18 +48,24 @@ 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 ). // // 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) - // . + // + // For more information, see [Media formats]. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio // // This member is required. MediaEncoding types.MediaEncoding @@ -79,19 +90,27 @@ type StartMedicalStreamTranscriptionInput struct { Type types.Type // 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) - // . + // complete transcription of an audio segment. + // + // For more information, see [Identifying personal health information (PHI) in a transcription]. + // + // [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 - // transcribes the audio on each channel independently, then appends the output for - // 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) - // . + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for 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]. + // + // [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 @@ -100,13 +119,18 @@ type StartMedicalStreamTranscriptionInput struct { // Specify a name for your transcription session. If you don't include this // parameter in your request, Amazon Transcribe Medical generates an ID and returns - // it in the response. You can use a session ID to retry a streaming session. + // 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) - // . + // file. + // + // For more information, see [Partitioning speakers (diarization)]. + // + // [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 diff --git a/service/transcribestreaming/api_op_StartStreamTranscription.go b/service/transcribestreaming/api_op_StartStreamTranscription.go index 20e58b79aee..e78d4218cbc 100644 --- a/service/transcribestreaming/api_op_StartStreamTranscription.go +++ b/service/transcribestreaming/api_op_StartStreamTranscription.go @@ -17,14 +17,19 @@ 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: +// application. +// +// The following parameters are required: +// // - language-code or identify-language or identify-multiple-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]. +// +// [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{} @@ -43,12 +48,17 @@ 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) - // . + // + // For more information, see [Media formats]. + // + // [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio // // This member is required. MediaEncoding types.MediaEncoding @@ -62,95 +72,135 @@ type StartStreamTranscriptionInput struct { MediaSampleRateHertz *int32 // 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) - // . + // 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]. + // + // [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. + // 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]. + // + // [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 - // transcribes the audio on each channel independently, then appends the output for - // 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) - // . + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for 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]. + // + // [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]. + // + // [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. + // 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 or // IdentifyMultipleLanguages in your request. If you include more than one of these - // parameters, your transcription job fails. Streaming language identification - // can't be combined with custom language models or redaction. + // parameters, your transcription job fails. + // + // Streaming language identification can't be combined with custom language models + // or redaction. IdentifyLanguage bool // Enables automatic multi-language identification in your transcription job // request. Use this parameter if your stream contains more than one language. If - // your stream contains only one language, use IdentifyLanguage instead. If you - // include IdentifyMultipleLanguages , you can optionally include a list of + // your stream 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 // stream. Including LanguageOptions restricts IdentifyMultipleLanguages 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 multiple language identification request, include VocabularyNames or - // VocabularyFilterNames . 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. + // VocabularyFilterNames . + // + // 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 - // 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) - // table. + // 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]table. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageCode types.LanguageCode // Specify the name of the custom language model that you want to use when // processing your transcription. Note that language model names are case - // sensitive. The language 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) - // . + // sensitive. + // + // The language 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]. + // + // [Custom language 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 - // 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) - // 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. + // 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]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. + // + // [Supported languages]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html LanguageOptions *string // Specify the number of channels in your audio stream. Up to two channels are @@ -158,85 +208,125 @@ type StartStreamTranscriptionInput struct { NumberOfChannels *int32 // Specify 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) - // . + // stabilization ( EnablePartialResultsStabilization ). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. + // + // For more information, see [Partial-result stabilization]. + // + // [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 - // IdentifyLanguage and LanguageOptions in your request. + // in LanguageOptions . + // + // You can only use this parameter if you've included IdentifyLanguage and + // LanguageOptions in your request. PreferredLanguage types.LanguageCode // Specify a name for your transcription session. If you don't include this // parameter in your request, Amazon Transcribe generates an ID and returns it in - // the response. You can use a session ID to retry a streaming session. + // 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) - // . + // file. + // + // For more information, see [Partitioning speakers (diarization)]. + // + // [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 . + // 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 . VocabularyFilterMethod types.VocabularyFilterMethod // Specify the name of the custom vocabulary filter that you want to use when // processing your transcription. Note that vocabulary filter names are case - // 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) - // . + // 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]. + // + // [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 // processing your transcription. Note that vocabulary filter names are case - // sensitive. If none of the languages of the specified custom vocabulary filters - // match the language identified in your media, your job fails. This parameter is - // 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) - // . + // sensitive. + // + // If none of the languages of the specified custom vocabulary filters match the + // language identified in your media, your job fails. + // + // This parameter is 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]. + // + // [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 - // your transcription. Note that vocabulary names are case sensitive. If the - // language of the specified custom vocabulary doesn't match the language + // 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. 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) - // . + // 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]. + // + // [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 - // processing your transcription. Note that vocabulary names are case sensitive. If - // none of the languages of the specified custom vocabularies match the language - // identified in your media, your job fails. This parameter is only intended for - // 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) - // . + // processing your transcription. Note that vocabulary names are case sensitive. + // + // If none of the languages of the specified custom vocabularies match the + // language identified in your media, your job fails. + // + // This parameter is only intended for 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]. + // + // [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 51d89cf428d..b6306a812e3 100644 --- a/service/transcribestreaming/doc.go +++ b/service/transcribestreaming/doc.go @@ -5,11 +5,14 @@ // // 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. diff --git a/service/transcribestreaming/options.go b/service/transcribestreaming/options.go index 29197d36f90..05a8f9c39f7 100644 --- a/service/transcribestreaming/options.go +++ b/service/transcribestreaming/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/transcribestreaming/types/enums.go b/service/transcribestreaming/types/enums.go index 7126e5b9436..1b1fdf7b680 100644 --- a/service/transcribestreaming/types/enums.go +++ b/service/transcribestreaming/types/enums.go @@ -19,6 +19,7 @@ const ( // Values returns all known values for CallAnalyticsLanguageCode. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (CallAnalyticsLanguageCode) Values() []CallAnalyticsLanguageCode { return []CallAnalyticsLanguageCode{ @@ -43,6 +44,7 @@ const ( // Values returns all known values for ContentIdentificationType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ContentIdentificationType) Values() []ContentIdentificationType { return []ContentIdentificationType{ @@ -59,8 +61,9 @@ const ( ) // Values returns all known values for ContentRedactionOutput. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentRedactionOutput) Values() []ContentRedactionOutput { return []ContentRedactionOutput{ "redacted", @@ -76,8 +79,9 @@ const ( ) // Values returns all known values for ContentRedactionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentRedactionType) Values() []ContentRedactionType { return []ContentRedactionType{ "PII", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for ItemType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ItemType) Values() []ItemType { return []ItemType{ "pronunciation", @@ -123,8 +128,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -154,8 +160,9 @@ const ( ) // Values returns all known values for MediaEncoding. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MediaEncoding) Values() []MediaEncoding { return []MediaEncoding{ "pcm", @@ -173,8 +180,9 @@ const ( // Values returns all known values for MedicalContentIdentificationType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MedicalContentIdentificationType) Values() []MedicalContentIdentificationType { return []MedicalContentIdentificationType{ "PHI", @@ -191,8 +199,9 @@ const ( ) // Values returns all known values for PartialResultsStability. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PartialResultsStability) Values() []PartialResultsStability { return []PartialResultsStability{ "high", @@ -210,8 +219,9 @@ const ( ) // Values returns all known values for ParticipantRole. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParticipantRole) Values() []ParticipantRole { return []ParticipantRole{ "AGENT", @@ -230,8 +240,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -254,8 +265,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -276,8 +288,9 @@ const ( ) // Values returns all known values for Type. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Type) Values() []Type { return []Type{ "CONVERSATION", @@ -295,8 +308,9 @@ const ( ) // Values returns all known values for VocabularyFilterMethod. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (VocabularyFilterMethod) Values() []VocabularyFilterMethod { return []VocabularyFilterMethod{ "remove", diff --git a/service/transcribestreaming/types/types.go b/service/transcribestreaming/types/types.go index d07821f2b7a..b5ac98e6a62 100644 --- a/service/transcribestreaming/types/types.go +++ b/service/transcribestreaming/types/types.go @@ -24,9 +24,11 @@ type Alternative struct { } // 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) -// . +// audio events, which consist of one or more audio chunks. +// +// For more information, see [Event stream encoding]. +// +// [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,20 +39,26 @@ 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]. // // The following types satisfy this interface: // // AudioStreamMemberAudioEvent // AudioStreamMemberConfigurationEvent +// +// [Transcribing streaming audio]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html 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) -// . +// more audio events. +// +// For more information, see [Event stream encoding]. +// +// [Event stream encoding]: https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html type AudioStreamMemberAudioEvent struct { Value AudioEvent @@ -81,9 +89,11 @@ type CallAnalyticsEntity struct { Category *string // The confidence score associated with the identification of an entity in your - // transcript. Confidence scores are values between 0 and 1. A larger value - // indicates a higher probability that the identified entity correctly matches the - // entity spoken in your media. + // transcript. + // + // Confidence scores are values between 0 and 1. A larger value indicates a higher + // probability that the identified entity correctly matches the entity spoken in + // your media. Confidence *float64 // The word or words that represent the identified entity. @@ -109,6 +119,7 @@ type CallAnalyticsItem struct { BeginOffsetMillis *int64 // The confidence score associated with a word or phrase in your transcript. + // // Confidence scores are values between 0 and 1. A larger value indicates a higher // probability that the identified item correctly matches the item spoken in your // media. @@ -250,6 +261,7 @@ type Entity struct { Category *string // The confidence score associated with the identified PII entity in your audio. + // // Confidence scores are values between 0 and 1. A larger value indicates a higher // probability that the identified entity correctly matches the entity spoken in // your media. @@ -286,6 +298,7 @@ type IssueDetected struct { type Item struct { // The confidence score associated with a word or phrase in your transcript. + // // Confidence scores are values between 0 and 1. A larger value indicates a higher // probability that the identified item correctly matches the item spoken in your // media. @@ -363,6 +376,7 @@ type MedicalEntity struct { Category *string // The confidence score associated with the identified PHI entity in your audio. + // // Confidence scores are values between 0 and 1. A larger value indicates a higher // probability that the identified entity correctly matches the entity spoken in // your media. @@ -386,6 +400,7 @@ type MedicalEntity struct { type MedicalItem struct { // The confidence score associated with a word or phrase in your transcript. + // // Confidence scores are values between 0 and 1. A larger value indicates a higher // probability that the identified item correctly matches the item spoken in your // media. @@ -411,11 +426,13 @@ type MedicalItem struct { noSmithyDocumentSerde } -// The Result associated with a . 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. +// The Result associated with a . +// +// 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. type MedicalResult struct { // A list of possible alternative transcriptions for the input audio. Each @@ -428,8 +445,10 @@ type MedicalResult struct { // 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 . @@ -441,9 +460,11 @@ type MedicalResult struct { noSmithyDocumentSerde } -// 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. +// 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 { // Contains a set of transcription results from one or more audio segments, along @@ -457,6 +478,7 @@ type MedicalTranscript struct { } // 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 { @@ -481,6 +503,7 @@ type MedicalTranscriptResultStream interface { } // 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,6 +530,7 @@ 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 // fields. type PostCallAnalyticsSettings struct { @@ -514,10 +538,13 @@ 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 + // 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) - // . + // arn:aws:iam::111122223333:role/Admin . For more information, see [IAM ARNs]. + // + // [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns // // This member is required. DataAccessRoleArn *string @@ -525,8 +552,11 @@ 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 // // This member is required. @@ -534,28 +564,38 @@ type PostCallAnalyticsSettings struct { // Specify whether you want only a redacted transcript or both a redacted and an // 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 ). + // 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 ). 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: + // 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. OutputEncryptionKMSKeyId *string @@ -563,11 +603,13 @@ type PostCallAnalyticsSettings struct { noSmithyDocumentSerde } -// The Result associated with a . 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. +// The Result associated with a . +// +// 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. type Result struct { // A list of possible alternative transcriptions for the input audio. Each @@ -580,15 +622,18 @@ type Result struct { // 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. LanguageCode LanguageCode - // The language code of the dominant language identified in your stream. If you - // enabled channel identification and each channel of your audio contains a + // The language code of the dominant language identified in your stream. + // + // If you enabled channel identification and each channel of your audio contains a // different language, you may have more than one result. LanguageIdentification []LanguageWithScore @@ -616,9 +661,11 @@ 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 -// additional information per your request parameters. +// 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 { // Contains a set of transcription results from one or more audio segments, along @@ -631,9 +678,10 @@ type Transcript struct { noSmithyDocumentSerde } -// 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. +// 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 diff --git a/service/transfer/api_op_CreateAccess.go b/service/transfer/api_op_CreateAccess.go index ce83ccd11d0..98862708f04 100644 --- a/service/transfer/api_op_CreateAccess.go +++ b/service/transfer/api_op_CreateAccess.go @@ -38,12 +38,18 @@ type CreateAccessInput struct { // directory. The users of the group that you associate have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If // you know the group name, you can view the SID values by running the following - // command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like - // "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that - // command, replace YourGroupName with the name of your Active Directory group. The - // regular expression used to validate this parameter is a string of characters - // consisting of uppercase and lowercase alphanumeric characters with no spaces. - // You can also include underscores or any of the following characters: =,.@:/- + // command using Windows PowerShell. + // + // Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | + // Select SamAccountName,ObjectSid + // + // In that command, replace YourGroupName with the name of your Active Directory + // group. + // + // The regular expression used to validate this parameter is a string of + // characters consisting of uppercase and lowercase alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@:/- // // This member is required. ExternalId *string @@ -66,8 +72,11 @@ 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -76,14 +85,19 @@ type CreateAccessInput struct { // 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. 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" } ] + // 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" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory @@ -91,24 +105,33 @@ type CreateAccessInput struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType types.HomeDirectoryType // 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, - // 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. + // ${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]. + // + // For more information, see [AssumeRole] in the Security Token Service API Reference. + // + // [Example session policy]: https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html + // [AssumeRole]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html Policy *string // The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any diff --git a/service/transfer/api_op_CreateAgreement.go b/service/transfer/api_op_CreateAgreement.go index d474b5647cc..a9183478750 100644 --- a/service/transfer/api_op_CreateAgreement.go +++ b/service/transfer/api_op_CreateAgreement.go @@ -15,9 +15,10 @@ import ( // partnership, between an Transfer Family server and an AS2 process. The agreement // 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 . +// profile, partner profile, certificate, and other attributes. +// +// The partner is 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{} @@ -37,29 +38,39 @@ type CreateAgreementInput struct { // Connectors are used to send files using either the AS2 or SFTP protocol. For // the access role, provide the Amazon Resource Name (ARN) of the Identity and - // Access Management role to use. For AS2 connectors 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, 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 . If you - // are using Basic authentication for your AS2 connector, the access role requires - // the secretsmanager:GetSecretValue permission for the secret. If the secret is - // encrypted using a customer-managed key instead of the Amazon Web Services - // managed key in Secrets Manager, then the role also needs the kms:Decrypt - // permission for that key. For SFTP connectors Make sure that the access role - // provides read and write access to the parent directory of the file location - // that's used in the StartFileTransfer request. Additionally, make sure that the - // role provides secretsmanager:GetSecretValue permission to Secrets Manager. + // Access Management role to use. + // + // For AS2 connectors + // + // 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, + // 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 . + // + // If you are using Basic authentication for your AS2 connector, the access role + // requires the secretsmanager:GetSecretValue permission for the secret. If the + // secret is encrypted using a customer-managed key instead of the Amazon Web + // Services managed key in Secrets Manager, then the role also needs the + // kms:Decrypt permission for that key. + // + // For SFTP connectors + // + // Make sure that the access role provides read and write access to the parent + // directory of the file location that's used in the StartFileTransfer request. + // Additionally, make sure that the role provides secretsmanager:GetSecretValue + // permission to Secrets Manager. // // 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 . // // This member is required. diff --git a/service/transfer/api_op_CreateConnector.go b/service/transfer/api_op_CreateConnector.go index c00777e73cd..3230baa2aa4 100644 --- a/service/transfer/api_op_CreateConnector.go +++ b/service/transfer/api_op_CreateConnector.go @@ -15,10 +15,13 @@ import ( // AS2 or SFTP protocol. For AS2, the connector is required for sending files to an // externally hosted AS2 server. For SFTP, the connector is required when sending // files to an SFTP server or receiving files from an SFTP server. For more details -// about connectors, see Configure AS2 connectors (https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html) -// and Create SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html) -// . You must specify exactly one configuration object: either for AS2 ( As2Config -// ) or SFTP ( SftpConfig ). +// about connectors, see [Configure AS2 connectors]and [Create SFTP connectors]. +// +// You must specify exactly one configuration object: either for AS2 ( As2Config ) +// or SFTP ( SftpConfig ). +// +// [Configure AS2 connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/configure-as2-connector.html +// [Create SFTP connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html func (c *Client) CreateConnector(ctx context.Context, params *CreateConnectorInput, optFns ...func(*Options)) (*CreateConnectorOutput, error) { if params == nil { params = &CreateConnectorInput{} @@ -38,24 +41,33 @@ type CreateConnectorInput struct { // Connectors are used to send files using either the AS2 or SFTP protocol. For // the access role, provide the Amazon Resource Name (ARN) of the Identity and - // Access Management role to use. For AS2 connectors 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, 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 . If you - // are using Basic authentication for your AS2 connector, the access role requires - // the secretsmanager:GetSecretValue permission for the secret. If the secret is - // encrypted using a customer-managed key instead of the Amazon Web Services - // managed key in Secrets Manager, then the role also needs the kms:Decrypt - // permission for that key. For SFTP connectors Make sure that the access role - // provides read and write access to the parent directory of the file location - // that's used in the StartFileTransfer request. Additionally, make sure that the - // role provides secretsmanager:GetSecretValue permission to Secrets Manager. + // Access Management role to use. + // + // For AS2 connectors + // + // 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, + // 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 . + // + // If you are using Basic authentication for your AS2 connector, the access role + // requires the secretsmanager:GetSecretValue permission for the secret. If the + // secret is encrypted using a customer-managed key instead of the Amazon Web + // Services managed key in Secrets Manager, then the role also needs the + // kms:Decrypt permission for that key. + // + // For SFTP connectors + // + // Make sure that the access role provides read and write access to the parent + // directory of the file location that's used in the StartFileTransfer request. + // Additionally, make sure that the role provides secretsmanager:GetSecretValue + // permission to Secrets Manager. // // This member is required. AccessRole *string diff --git a/service/transfer/api_op_CreateProfile.go b/service/transfer/api_op_CreateProfile.go index b9ec3eb9b4f..dd65ce7555f 100644 --- a/service/transfer/api_op_CreateProfile.go +++ b/service/transfer/api_op_CreateProfile.go @@ -29,18 +29,21 @@ 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]. 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. + // + // [RFC 4130]: https://datatracker.ietf.org/doc/html/rfc4130 // // 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. // diff --git a/service/transfer/api_op_CreateServer.go b/service/transfer/api_op_CreateServer.go index 27bf493c6cf..5c31ffc93c6 100644 --- a/service/transfer/api_op_CreateServer.go +++ b/service/transfer/api_op_CreateServer.go @@ -33,27 +33,42 @@ 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) - // in the Certificate Manager User Guide. Certificates with the following - // cryptographic algorithms and key sizes are supported: + // Required when Protocols is set to FTPS . + // + // To request a new public certificate, see [Request a public certificate] in the Certificate Manager User Guide. + // + // To import an existing certificate into ACM, see [Importing certificates into ACM] in the Certificate Manager + // User Guide. + // + // To request a private certificate to use FTPS through private IP addresses, see [Request a private certificate] + // 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. + // + // [Request a public certificate]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html + // [Request a private certificate]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html + // [Importing certificates into ACM]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html Certificate *string // The domain of the storage system that is used for file transfers. There are two // domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic - // File System (Amazon EFS). The default value is S3. After the server is created, - // the domain cannot be changed. + // File System (Amazon EFS). The default value is S3. + // + // After the server is created, the domain cannot be changed. Domain types.Domain // The virtual private cloud (VPC) endpoint settings that are configured for your @@ -67,13 +82,17 @@ type CreateServerInput struct { // your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. // With an endpoint that is hosted in a VPC, you can restrict access to your server // and resources only within your VPC or choose to make it internet facing by - // attaching Elastic IP addresses directly to it. After May 19, 2021, you won't be - // able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web - // 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 + // attaching Elastic IP addresses directly to it. + // + // After May 19, 2021, you won't be able to create a server using + // EndpointType=VPC_ENDPOINT in your Amazon Web 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 // 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 @@ -83,20 +102,35 @@ type CreateServerInput struct { // 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 - // 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 - // 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 - // 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) - // in the Transfer Family User Guide. + // 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 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 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 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] in the Transfer Family User Guide. + // + // [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 HostKey *string // Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , Amazon Web @@ -108,17 +142,22 @@ type CreateServerInput struct { // 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 - // Directory in your on-premises environment or in Amazon Web Services using AD - // Connector. This option also requires you to provide a Directory ID by using the - // IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with - // an identity provider of your choosing. The API_GATEWAY setting requires you to - // provide an Amazon API Gateway endpoint URL to call for authentication by using - // the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use - // an Lambda function as your identity provider. If you choose this value, you must - // specify the ARN for the Lambda function in the Function parameter for the - // IdentityProviderDetails data type. + // service. + // + // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in + // Directory Service for Microsoft Active Directory or Microsoft Active Directory + // in your on-premises environment or in Amazon Web Services using AD Connector. + // This option also requires you to provide a Directory ID by using the + // IdentityProviderDetails parameter. + // + // Use the API_GATEWAY value to integrate with an identity provider of your + // choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway + // endpoint URL to call for authentication by using the IdentityProviderDetails + // parameter. + // + // Use the AWS_LAMBDA value to directly use an Lambda function as your identity + // provider. If you choose this value, you must specify the ARN for the Lambda + // function in the Function parameter for the IdentityProviderDetails data type. IdentityProviderType types.IdentityProviderType // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -127,22 +166,27 @@ type CreateServerInput struct { LoggingRole *string // Specifies a string to display when users connect to a server. This string is - // displayed after the user authenticates. The SFTP protocol does not support - // post-authentication display banners. + // displayed after the user authenticates. + // + // The SFTP protocol does not support post-authentication display banners. PostAuthenticationLoginBanner *string // Specifies a string to display when users connect to a server. This string is // displayed before the user authenticates. For example, the following banner - // displays details about using the system: This system is for the use of - // authorized users only. Individuals using this computer system without authority, - // or in excess of their authority, are subject to having all of their activities - // on this system monitored and recorded by system personnel. + // displays details about using the system: + // + // This system is for the use of authorized users only. Individuals using this + // computer system without authority, or in excess of their authority, are subject + // to having all of their activities on this system monitored and recorded by + // system personnel. 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 @@ -151,9 +195,11 @@ type CreateServerInput struct { // 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 @@ -161,56 +207,71 @@ type CreateServerInput struct { // 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. Protocols []types.Protocol // Specifies whether or not performance for your Amazon S3 directories is - // optimized. This is disabled by default. By default, home directory mappings have - // a TYPE of DIRECTORY . If you enable this option, you would then need to - // explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to - // have a file target. + // optimized. This is disabled by default. + // + // By default, home directory mappings have a TYPE of DIRECTORY . If you enable + // this option, you would then need to explicitly set the HomeDirectoryMapEntry Type + // to FILE if you want a mapping to have a file target. S3StorageOptions *types.S3StorageOptions // Specifies the name of the security policy for the server. SecurityPolicyName *string - // Specifies the log groups to which your server logs are sent. To specify a log - // group, you must provide the ARN for an existing log group. In this case, the - // format of the log group is as follows: - // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For - // example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you - // have previously specified a log group for a server, you can clear it, and in - // effect turn off structured logging, by providing an empty value for this - // parameter in an update-server call. For example: update-server --server-id - // s-1234567890abcdef0 --structured-log-destinations + // Specifies the log groups to which your server logs are sent. + // + // To specify a log group, you must provide the ARN for an existing log group. In + // this case, the format of the log group is as follows: + // + // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* + // + // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* + // + // If you have previously specified a log group for a server, you can clear it, + // and in effect turn off structured logging, by providing an empty value for this + // parameter in an update-server call. For example: + // + // update-server --server-id s-1234567890abcdef0 --structured-log-destinations StructuredLogDestinations []string // Key-value pairs that can be used to group and search for servers. Tags []types.Tag // Specifies the workflow ID for the workflow to assign and the execution role - // that's used for executing the workflow. In addition to a workflow to execute - // when a file is uploaded completely, WorkflowDetails can also contain a workflow - // ID (and execution role) for a workflow to execute on partial upload. A partial - // upload occurs when the server session disconnects while the file is still being - // uploaded. + // that's used for executing the workflow. + // + // In addition to a workflow to execute when a file is uploaded completely, + // WorkflowDetails can also contain a workflow ID (and execution role) for a + // workflow to execute on partial upload. A partial upload occurs when the server + // session disconnects while the file is still being uploaded. WorkflowDetails *types.WorkflowDetails noSmithyDocumentSerde diff --git a/service/transfer/api_op_CreateUser.go b/service/transfer/api_op_CreateUser.go index c9deadc622b..6cb1c494189 100644 --- a/service/transfer/api_op_CreateUser.go +++ b/service/transfer/api_op_CreateUser.go @@ -62,8 +62,11 @@ 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -72,14 +75,20 @@ type CreateUserInput struct { // 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. 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 value the user should see for their home directory when they log in. The - // following is an Entry and Target pair example for chroot . [ { "Entry": "/", - // "Target": "/bucket_name/home/mydirectory" } ] + // 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 value the user should see for their + // home directory when they log in. + // + // 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 @@ -87,24 +96,34 @@ type CreateUserInput struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType types.HomeDirectoryType // 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, - // 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. + // ${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]. + // + // For more information, see [AssumeRole] in the Amazon Web Services Security Token Service + // API Reference. + // + // [Example session policy]: https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html + // [AssumeRole]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html Policy *string // Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), @@ -115,11 +134,17 @@ type CreateUserInput struct { 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. + // 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. diff --git a/service/transfer/api_op_CreateWorkflow.go b/service/transfer/api_op_CreateWorkflow.go index a52b416daae..439e82285aa 100644 --- a/service/transfer/api_op_CreateWorkflow.go +++ b/service/transfer/api_op_CreateWorkflow.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Allows you to create a workflow with specified steps and step details the +// Allows you to create a workflow with specified steps and step details the +// // workflow invokes after file transfer completes. After creating a workflow, you // can associate the workflow created with any transfer servers by specifying the // workflow-details field in CreateServer and UpdateServer operations. @@ -32,16 +33,24 @@ func (c *Client) CreateWorkflow(ctx context.Context, params *CreateWorkflowInput 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. + // 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. + // + // 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 @@ -50,10 +59,11 @@ type CreateWorkflowInput struct { 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. + // 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_DeleteAccess.go b/service/transfer/api_op_DeleteAccess.go index b0eede6d46a..a8f8c4f8d00 100644 --- a/service/transfer/api_op_DeleteAccess.go +++ b/service/transfer/api_op_DeleteAccess.go @@ -33,12 +33,18 @@ type DeleteAccessInput struct { // directory. The users of the group that you associate have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If // you know the group name, you can view the SID values by running the following - // command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like - // "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that - // command, replace YourGroupName with the name of your Active Directory group. The - // regular expression used to validate this parameter is a string of characters - // consisting of uppercase and lowercase alphanumeric characters with no spaces. - // You can also include underscores or any of the following characters: =,.@:/- + // command using Windows PowerShell. + // + // Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | + // Select SamAccountName,ObjectSid + // + // In that command, replace YourGroupName with the name of your Active Directory + // group. + // + // The regular expression used to validate this parameter is a string of + // characters consisting of uppercase and lowercase alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@:/- // // This member is required. ExternalId *string diff --git a/service/transfer/api_op_DeleteServer.go b/service/transfer/api_op_DeleteServer.go index 64a1d1e0016..826c8ad86a2 100644 --- a/service/transfer/api_op_DeleteServer.go +++ b/service/transfer/api_op_DeleteServer.go @@ -10,8 +10,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the file transfer protocol-enabled server that you specify. No response -// returns from this operation. +// Deletes the file transfer protocol-enabled server that you specify. +// +// No response returns from this operation. func (c *Client) DeleteServer(ctx context.Context, params *DeleteServerInput, optFns ...func(*Options)) (*DeleteServerOutput, error) { if params == nil { params = &DeleteServerInput{} diff --git a/service/transfer/api_op_DeleteUser.go b/service/transfer/api_op_DeleteUser.go index c3420917b52..d5c9b52a967 100644 --- a/service/transfer/api_op_DeleteUser.go +++ b/service/transfer/api_op_DeleteUser.go @@ -11,8 +11,11 @@ import ( ) // Deletes the user belonging to a file transfer protocol-enabled server you -// specify. No response returns from this operation. When you delete a user from a -// server, the user's information is lost. +// specify. +// +// No response returns from this operation. +// +// When you delete a user from a server, the user's information is lost. func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} diff --git a/service/transfer/api_op_DescribeAccess.go b/service/transfer/api_op_DescribeAccess.go index f73d3ff54ad..ab0d8bb4f5f 100644 --- a/service/transfer/api_op_DescribeAccess.go +++ b/service/transfer/api_op_DescribeAccess.go @@ -13,8 +13,10 @@ 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 -// that is associated with the ServerId value that was specified. +// 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 { params = &DescribeAccessInput{} @@ -36,12 +38,18 @@ type DescribeAccessInput struct { // directory. The users of the group that you associate have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If // you know the group name, you can view the SID values by running the following - // command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like - // "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that - // command, replace YourGroupName with the name of your Active Directory group. The - // regular expression used to validate this parameter is a string of characters - // consisting of uppercase and lowercase alphanumeric characters with no spaces. - // You can also include underscores or any of the following characters: =,.@:/- + // command using Windows PowerShell. + // + // Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | + // Select SamAccountName,ObjectSid + // + // In that command, replace YourGroupName with the name of your Active Directory + // group. + // + // The regular expression used to validate this parameter is a string of + // characters consisting of uppercase and lowercase alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@:/- // // This member is required. ExternalId *string diff --git a/service/transfer/api_op_DescribeExecution.go b/service/transfer/api_op_DescribeExecution.go index e4d69a97c48..2868a94a10a 100644 --- a/service/transfer/api_op_DescribeExecution.go +++ b/service/transfer/api_op_DescribeExecution.go @@ -12,9 +12,12 @@ import ( ) // You can use DescribeExecution to check the details of the execution of the -// specified workflow. This API call only returns details for in-progress -// workflows. If you provide an ID for an execution that is not in progress, or if -// the execution doesn't match the specified workflow ID, you receive a +// specified workflow. +// +// This API call only returns details for in-progress workflows. +// +// If you provide an ID for an execution that is not in progress, or if the +// execution doesn't match the specified workflow ID, you receive a // ResourceNotFound exception. func (c *Client) DescribeExecution(ctx context.Context, params *DescribeExecutionInput, optFns ...func(*Options)) (*DescribeExecutionOutput, error) { if params == nil { diff --git a/service/transfer/api_op_DescribeSecurityPolicy.go b/service/transfer/api_op_DescribeSecurityPolicy.go index 7462bc588f0..5dd8f3320e6 100644 --- a/service/transfer/api_op_DescribeSecurityPolicy.go +++ b/service/transfer/api_op_DescribeSecurityPolicy.go @@ -13,10 +13,10 @@ import ( // Describes the security policy that is attached to your server or SFTP // connector. The response contains a description of the security policy's -// properties. For more information about security policies, see Working with -// security policies for servers (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) -// or Working with security policies for SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html) -// . +// properties. For more information about security policies, see [Working with security policies for servers]or [Working with security policies for SFTP connectors]. +// +// [Working with security policies for SFTP connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html +// [Working with security policies for servers]: 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 2386793f102..969d645247e 100644 --- a/service/transfer/api_op_DescribeServer.go +++ b/service/transfer/api_op_DescribeServer.go @@ -16,9 +16,10 @@ 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 . +// 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 . func (c *Client) DescribeServer(ctx context.Context, params *DescribeServerInput, optFns ...func(*Options)) (*DescribeServerOutput, error) { if params == nil { params = &DescribeServerInput{} @@ -176,12 +177,13 @@ type ServerOfflineWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeServerInput, *DescribeServerOutput, error) (bool, error) } @@ -365,12 +367,13 @@ type ServerOnlineWaiterOptions struct { // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is - // used by the waiter to decide if a state is retryable or a terminal state. By - // default service-modeled logic will populate this option. This option can thus be - // used to define a custom waiter state with fall-back to service-modeled waiter - // state mutators.The function returns an error in case of a failure state. In case - // of retry state, this function returns a bool value of true and nil error, while - // in case of success it returns a bool value of false and nil error. + // used by the waiter to decide if a state is retryable or a terminal state. + // + // By default service-modeled logic will populate this option. This option can + // thus be used to define a custom waiter state with fall-back to service-modeled + // waiter state mutators.The function returns an error in case of a failure state. + // In case of retry state, this function returns a bool value of true and nil + // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeServerInput, *DescribeServerOutput, error) (bool, error) } diff --git a/service/transfer/api_op_DescribeUser.go b/service/transfer/api_op_DescribeUser.go index a1dfd509b65..57897a87b8d 100644 --- a/service/transfer/api_op_DescribeUser.go +++ b/service/transfer/api_op_DescribeUser.go @@ -12,9 +12,10 @@ import ( ) // Describes the user assigned to the specific file transfer protocol-enabled -// server, as identified by its ServerId property. The response from this call -// returns the properties of the user associated with the ServerId value that was -// specified. +// server, as identified by its ServerId property. +// +// The response from this call returns the properties of the user associated with +// the ServerId value that was specified. func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error) { if params == nil { params = &DescribeUserInput{} diff --git a/service/transfer/api_op_ImportCertificate.go b/service/transfer/api_op_ImportCertificate.go index a31fd1cb235..1fb1c21d94a 100644 --- a/service/transfer/api_op_ImportCertificate.go +++ b/service/transfer/api_op_ImportCertificate.go @@ -34,6 +34,7 @@ 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`" . // @@ -61,6 +62,7 @@ type ImportCertificateInput struct { // - 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 diff --git a/service/transfer/api_op_ImportHostKey.go b/service/transfer/api_op_ImportHostKey.go index 605aa87c2e8..c25123c42bb 100644 --- a/service/transfer/api_op_ImportHostKey.go +++ b/service/transfer/api_op_ImportHostKey.go @@ -29,8 +29,9 @@ func (c *Client) ImportHostKey(ctx context.Context, params *ImportHostKeyInput, type ImportHostKeyInput struct { - // The private key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, - // and ED25519 keys. + // The private key portion of an SSH key pair. + // + // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // This member is required. HostKeyBody *string diff --git a/service/transfer/api_op_ImportSshPublicKey.go b/service/transfer/api_op_ImportSshPublicKey.go index e36a77ea283..0da990cf765 100644 --- a/service/transfer/api_op_ImportSshPublicKey.go +++ b/service/transfer/api_op_ImportSshPublicKey.go @@ -12,8 +12,10 @@ import ( // Adds a Secure Shell (SSH) public key to a Transfer Family user 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 . +// identified 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{} @@ -36,8 +38,9 @@ type ImportSshPublicKeyInput struct { // This member is required. ServerId *string - // The public key portion of an SSH key pair. Transfer Family accepts RSA, ECDSA, - // and ED25519 keys. + // The public key portion of an SSH key pair. + // + // Transfer Family accepts RSA, ECDSA, and ED25519 keys. // // This member is required. SshPublicKeyBody *string diff --git a/service/transfer/api_op_ListExecutions.go b/service/transfer/api_op_ListExecutions.go index 9a8318458b1..9b586636426 100644 --- a/service/transfer/api_op_ListExecutions.go +++ b/service/transfer/api_op_ListExecutions.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Lists all in-progress executions for the specified workflow. If the specified -// workflow ID cannot be found, ListExecutions returns a ResourceNotFound -// exception. +// Lists all in-progress executions for the specified workflow. +// +// If the specified workflow ID cannot be found, ListExecutions returns a +// ResourceNotFound exception. func (c *Client) ListExecutions(ctx context.Context, params *ListExecutionsInput, optFns ...func(*Options)) (*ListExecutionsOutput, error) { if params == nil { params = &ListExecutionsInput{} @@ -41,15 +42,24 @@ type ListExecutionsInput struct { // ListExecutions returns the NextToken parameter in the output. You can then pass // 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 ( + // 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 - // 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 - // until the details for all 100 executions have been returned. + // 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 until the details for all 100 executions have been + // returned. NextToken *string noSmithyDocumentSerde diff --git a/service/transfer/api_op_ListSecurityPolicies.go b/service/transfer/api_op_ListSecurityPolicies.go index 42445741bd6..253572da9d5 100644 --- a/service/transfer/api_op_ListSecurityPolicies.go +++ b/service/transfer/api_op_ListSecurityPolicies.go @@ -11,10 +11,10 @@ import ( ) // Lists the security policies that are attached to your servers and SFTP -// connectors. For more information about security policies, see Working with -// security policies for servers (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) -// or Working with security policies for SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html) -// . +// connectors. For more information about security policies, see [Working with security policies for servers]or [Working with security policies for SFTP connectors]. +// +// [Working with security policies for SFTP connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html +// [Working with security policies for servers]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html func (c *Client) ListSecurityPolicies(ctx context.Context, params *ListSecurityPoliciesInput, optFns ...func(*Options)) (*ListSecurityPoliciesOutput, error) { if params == nil { params = &ListSecurityPoliciesInput{} diff --git a/service/transfer/api_op_SendWorkflowStepState.go b/service/transfer/api_op_SendWorkflowStepState.go index c45e8a24898..c2f66f3b160 100644 --- a/service/transfer/api_op_SendWorkflowStepState.go +++ b/service/transfer/api_op_SendWorkflowStepState.go @@ -11,10 +11,11 @@ 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 -// status. +// 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 { params = &SendWorkflowStepStateInput{} diff --git a/service/transfer/api_op_StartDirectoryListing.go b/service/transfer/api_op_StartDirectoryListing.go index 1e7dbadd56d..da0806ae645 100644 --- a/service/transfer/api_op_StartDirectoryListing.go +++ b/service/transfer/api_op_StartDirectoryListing.go @@ -16,20 +16,27 @@ import ( // items that are listed from the remote directory. This API returns a list of all // files and directories in the remote directory (up to the maximum value), but // does not return files or folders in sub-directories. That is, it only returns a -// list of files and directories one-level deep. After you receive the listing -// file, you can provide the files that you want to transfer to the -// RetrieveFilePaths parameter of the StartFileTransfer API call. The naming -// convention for the output file is connector-ID-listing-ID.json . The output file -// contains the following information: +// list of files and directories one-level deep. +// +// After you receive the listing file, you can provide the files that you want to +// transfer to the RetrieveFilePaths parameter of the StartFileTransfer API call. +// +// The naming convention for the output file is connector-ID-listing-ID.json . The +// output file contains the following information: +// // - filePath : the complete path of a remote file, relative to the directory of // the listing request for your SFTP connector on the remote server. +// // - modifiedTimestamp : the last time the file was modified, in UTC time format. // This field is optional. If the remote file attributes don't contain a timestamp, // it is omitted from the file listing. +// // - size : the size of the file, in bytes. This field is optional. If the remote // file attributes don't contain a file size, it is omitted from the file listing. +// // - path : the complete path of a remote directory, relative to the directory of // the listing request for your SFTP connector on the remote server. +// // - truncated : a flag indicating whether the list output contains all of the // items contained in the remote directory or not. If your Truncated output value // is true, you can increase the value provided in the optional max-items input diff --git a/service/transfer/api_op_StartFileTransfer.go b/service/transfer/api_op_StartFileTransfer.go index 761b3957ea2..3638181a9eb 100644 --- a/service/transfer/api_op_StartFileTransfer.go +++ b/service/transfer/api_op_StartFileTransfer.go @@ -12,15 +12,19 @@ import ( // Begins a file transfer between local Amazon Web Services storage and a remote // AS2 or SFTP server. +// // - For an AS2 connector, you specify the ConnectorId and one or more // SendFilePaths to identify the files you want to transfer. +// // - For an SFTP connector, the file transfer can be either outbound or inbound. // In both cases, you specify the ConnectorId . Depending on the direction of the // transfer, you also specify the following items: +// // - If you are transferring file from a partner's SFTP server to Amazon Web // Services storage, you specify one or more RetrieveFilePaths to identify the // files you want to transfer, and a LocalDirectoryPath to specify the // destination folder. +// // - If you are transferring file to a partner's SFTP server from Amazon Web // Services storage, you specify one or more SendFilePaths to identify the files // you want to transfer, and a RemoteDirectoryPath to specify the destination @@ -63,8 +67,9 @@ type StartFileTransferInput struct { // One or more source paths for the Amazon S3 storage. Each string represents a // source file path for one outbound file transfer. For example, - // DOC-EXAMPLE-BUCKET/myfile.txt . Replace DOC-EXAMPLE-BUCKET with one of your - // actual buckets. + // DOC-EXAMPLE-BUCKET/myfile.txt . + // + // Replace DOC-EXAMPLE-BUCKET with one of your actual buckets. SendFilePaths []string noSmithyDocumentSerde diff --git a/service/transfer/api_op_StartServer.go b/service/transfer/api_op_StartServer.go index d60682147ce..b737d29ddae 100644 --- a/service/transfer/api_op_StartServer.go +++ b/service/transfer/api_op_StartServer.go @@ -12,10 +12,13 @@ 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 -// 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 -// response is returned from this call. +// 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 response is returned from this call. func (c *Client) StartServer(ctx context.Context, params *StartServerInput, optFns ...func(*Options)) (*StartServerOutput, error) { if params == nil { params = &StartServerInput{} diff --git a/service/transfer/api_op_StopServer.go b/service/transfer/api_op_StopServer.go index f8767b3cb8a..bb40de62204 100644 --- a/service/transfer/api_op_StopServer.go +++ b/service/transfer/api_op_StopServer.go @@ -13,12 +13,16 @@ 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. // 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 -// being billed. The state of STOPPING indicates that the server is in an -// intermediate state, either not fully able to respond, or not fully offline. The -// values of STOP_FAILED can indicate an error condition. No response is returned -// from this call. +// 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 being billed. +// +// The state of STOPPING indicates that the server is in an intermediate state, +// either not fully able to respond, or not fully offline. The values of +// STOP_FAILED can indicate an error condition. +// +// No response is returned from this call. func (c *Client) StopServer(ctx context.Context, params *StopServerInput, optFns ...func(*Options)) (*StopServerOutput, error) { if params == nil { params = &StopServerInput{} diff --git a/service/transfer/api_op_TagResource.go b/service/transfer/api_op_TagResource.go index 79a66bd70eb..ccbe783e009 100644 --- a/service/transfer/api_op_TagResource.go +++ b/service/transfer/api_op_TagResource.go @@ -12,8 +12,9 @@ import ( ) // Attaches a key-value pair to a resource, as identified by its Amazon Resource -// Name (ARN). Resources are users, servers, roles, and other entities. There is no -// response returned from this call. +// Name (ARN). Resources are users, servers, roles, and other entities. +// +// There is no response returned from this call. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/transfer/api_op_TestConnection.go b/service/transfer/api_op_TestConnection.go index 19b24d0d933..c638d3f5cb1 100644 --- a/service/transfer/api_op_TestConnection.go +++ b/service/transfer/api_op_TestConnection.go @@ -49,11 +49,15 @@ type TestConnectionOutput struct { // Returns Connection succeeded if the test is successful. Or, returns a // descriptive error message if the test fails. The following list provides // troubleshooting details, depending on the error message that you receive. + // // - Verify that your secret name aligns with the one in Transfer Role // permissions. + // // - Verify the server URL in the connector configuration , and verify that the // login credentials work successfully outside of the connector. + // // - Verify that the secret exists and is formatted correctly. + // // - Verify that the trusted host key in the connector configuration matches the // ssh-keyscan output. StatusMessage *string diff --git a/service/transfer/api_op_TestIdentityProvider.go b/service/transfer/api_op_TestIdentityProvider.go index e213788e0fa..7c137b15737 100644 --- a/service/transfer/api_op_TestIdentityProvider.go +++ b/service/transfer/api_op_TestIdentityProvider.go @@ -16,9 +16,12 @@ import ( // 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. Note the following: +// your users can successfully use the service. +// +// The ServerId and UserName parameters are required. The ServerProtocol , SourceIp +// , and UserPassword are all optional. +// +// Note the following: // // - You cannot use TestIdentityProvider if the IdentityProviderType of your // server is SERVICE_MANAGED . @@ -32,15 +35,23 @@ import ( // 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 +// 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 . It is possible your sever is in a different -// region. You can specify a region by adding the following: --region region-code -// , such as --region us-east-2 to specify a server in US East (Ohio). +// It is possible your sever is in a different region. You can specify a region by +// +// adding the following: --region region-code , such as --region us-east-2 to +// specify a server in US East (Ohio). func (c *Client) TestIdentityProvider(ctx context.Context, params *TestIdentityProviderInput, optFns ...func(*Options)) (*TestIdentityProviderOutput, error) { if params == nil { params = &TestIdentityProviderInput{} @@ -69,10 +80,16 @@ type TestIdentityProviderInput struct { // This member is required. UserName *string - // The type of file transfer protocol to be tested. The available protocols are: + // 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) + // // - Applicability Statement 2 (AS2) ServerProtocol types.Protocol @@ -98,9 +115,10 @@ type TestIdentityProviderOutput struct { // This member is required. Url *string - // A message that indicates whether the test was successful or not. If an empty - // string is returned, the most likely cause is that the authentication failed due - // to an incorrect username or password. + // A message that indicates whether the test was successful or not. + // + // If an empty string is returned, the most likely cause is that the + // authentication failed due to an incorrect username or password. Message *string // The response that is returned from your API Gateway or your Lambda function. diff --git a/service/transfer/api_op_UntagResource.go b/service/transfer/api_op_UntagResource.go index ab38f8f909c..4b44fd578d7 100644 --- a/service/transfer/api_op_UntagResource.go +++ b/service/transfer/api_op_UntagResource.go @@ -11,8 +11,9 @@ import ( ) // Detaches a key-value pair from a resource, as identified by its Amazon Resource -// Name (ARN). Resources are users, servers, roles, and other entities. No response -// is returned from this call. +// Name (ARN). Resources are users, servers, roles, and other entities. +// +// No response is returned from this call. func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/transfer/api_op_UpdateAccess.go b/service/transfer/api_op_UpdateAccess.go index 65725321265..4f882d6f34c 100644 --- a/service/transfer/api_op_UpdateAccess.go +++ b/service/transfer/api_op_UpdateAccess.go @@ -34,12 +34,18 @@ type UpdateAccessInput struct { // directory. The users of the group that you associate have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If // you know the group name, you can view the SID values by running the following - // command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like - // "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that - // command, replace YourGroupName with the name of your Active Directory group. The - // regular expression used to validate this parameter is a string of characters - // consisting of uppercase and lowercase alphanumeric characters with no spaces. - // You can also include underscores or any of the following characters: =,.@:/- + // command using Windows PowerShell. + // + // Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | + // Select SamAccountName,ObjectSid + // + // In that command, replace YourGroupName with the name of your Active Directory + // group. + // + // The regular expression used to validate this parameter is a string of + // characters consisting of uppercase and lowercase alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@:/- // // This member is required. ExternalId *string @@ -51,8 +57,11 @@ 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -61,14 +70,19 @@ type UpdateAccessInput struct { // 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. 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" } ] + // 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" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory @@ -76,24 +90,34 @@ type UpdateAccessInput struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType types.HomeDirectoryType // 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, - // 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. + // ${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]. + // + // For more information, see [AssumeRole] in the Amazon Web ServicesSecurity Token Service API + // Reference. + // + // [Example session policy]: https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html + // [AssumeRole]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html Policy *string // The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any diff --git a/service/transfer/api_op_UpdateAgreement.go b/service/transfer/api_op_UpdateAgreement.go index 31260e6ec41..b545e619c4d 100644 --- a/service/transfer/api_op_UpdateAgreement.go +++ b/service/transfer/api_op_UpdateAgreement.go @@ -45,24 +45,33 @@ type UpdateAgreementInput struct { // Connectors are used to send files using either the AS2 or SFTP protocol. For // the access role, provide the Amazon Resource Name (ARN) of the Identity and - // Access Management role to use. For AS2 connectors 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, 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 . If you - // are using Basic authentication for your AS2 connector, the access role requires - // the secretsmanager:GetSecretValue permission for the secret. If the secret is - // encrypted using a customer-managed key instead of the Amazon Web Services - // managed key in Secrets Manager, then the role also needs the kms:Decrypt - // permission for that key. For SFTP connectors Make sure that the access role - // provides read and write access to the parent directory of the file location - // that's used in the StartFileTransfer request. Additionally, make sure that the - // role provides secretsmanager:GetSecretValue permission to Secrets Manager. + // Access Management role to use. + // + // For AS2 connectors + // + // 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, + // 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 . + // + // If you are using Basic authentication for your AS2 connector, the access role + // requires the secretsmanager:GetSecretValue permission for the secret. If the + // secret is encrypted using a customer-managed key instead of the Amazon Web + // Services managed key in Secrets Manager, then the role also needs the + // kms:Decrypt permission for that key. + // + // For SFTP connectors + // + // Make sure that the access role provides read and write access to the parent + // directory of the file location that's used in the StartFileTransfer request. + // Additionally, make sure that the role provides secretsmanager:GetSecretValue + // permission to Secrets Manager. AccessRole *string // To change the landing directory (folder) for files that are transferred, @@ -74,8 +83,9 @@ type UpdateAgreementInput struct { // agreement. Description *string - // A unique identifier for the AS2 local profile. To change the local profile - // identifier, provide a new value here. + // A unique identifier for the AS2 local profile. + // + // To change the local profile identifier, provide a new value here. LocalProfileId *string // A unique identifier for the partner profile. To change the partner profile diff --git a/service/transfer/api_op_UpdateConnector.go b/service/transfer/api_op_UpdateConnector.go index 2bc729e0cd1..4885cd6436c 100644 --- a/service/transfer/api_op_UpdateConnector.go +++ b/service/transfer/api_op_UpdateConnector.go @@ -38,24 +38,33 @@ type UpdateConnectorInput struct { // Connectors are used to send files using either the AS2 or SFTP protocol. For // the access role, provide the Amazon Resource Name (ARN) of the Identity and - // Access Management role to use. For AS2 connectors 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, 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 . If you - // are using Basic authentication for your AS2 connector, the access role requires - // the secretsmanager:GetSecretValue permission for the secret. If the secret is - // encrypted using a customer-managed key instead of the Amazon Web Services - // managed key in Secrets Manager, then the role also needs the kms:Decrypt - // permission for that key. For SFTP connectors Make sure that the access role - // provides read and write access to the parent directory of the file location - // that's used in the StartFileTransfer request. Additionally, make sure that the - // role provides secretsmanager:GetSecretValue permission to Secrets Manager. + // Access Management role to use. + // + // For AS2 connectors + // + // 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, + // 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 . + // + // If you are using Basic authentication for your AS2 connector, the access role + // requires the secretsmanager:GetSecretValue permission for the secret. If the + // secret is encrypted using a customer-managed key instead of the Amazon Web + // Services managed key in Secrets Manager, then the role also needs the + // kms:Decrypt permission for that key. + // + // For SFTP connectors + // + // Make sure that the access role provides read and write access to the parent + // directory of the file location that's used in the StartFileTransfer request. + // Additionally, make sure that the role provides secretsmanager:GetSecretValue + // permission to Secrets Manager. AccessRole *string // A structure that contains the parameters for an AS2 connector object. diff --git a/service/transfer/api_op_UpdateServer.go b/service/transfer/api_op_UpdateServer.go index d74647ed9c8..f4d2d0b0ac6 100644 --- a/service/transfer/api_op_UpdateServer.go +++ b/service/transfer/api_op_UpdateServer.go @@ -12,8 +12,9 @@ import ( ) // 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. +// 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,22 +39,36 @@ 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 - // 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 Amazon Web ServicesCertificate Manager User Guide. Certificates with the - // following cryptographic algorithms and key sizes are supported: + // (ACM) certificate. Required when Protocols is set to FTPS . + // + // To request a new public certificate, see [Request a public certificate] in the Amazon Web ServicesCertificate + // Manager User Guide. + // + // To import an existing certificate into ACM, see [Importing certificates into ACM] 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] + // 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. + // + // [Request a public certificate]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html + // [Request a private certificate]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html + // [Importing certificates into ACM]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html Certificate *string // The virtual private cloud (VPC) endpoint settings that are configured for your @@ -67,13 +82,17 @@ type UpdateServerInput struct { // your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. // With an endpoint that is hosted in a VPC, you can restrict access to your server // and resources only within your VPC or choose to make it internet facing by - // attaching Elastic IP addresses directly to it. After May 19, 2021, you won't be - // able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web - // 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 + // attaching Elastic IP addresses directly to it. + // + // After May 19, 2021, you won't be able to create a server using + // EndpointType=VPC_ENDPOINT in your Amazon Web 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 // 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 @@ -83,20 +102,35 @@ type UpdateServerInput struct { // 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 - // 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 - // 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 - // 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) - // in the Transfer Family User Guide. + // 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 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 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 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] in the Transfer Family User Guide. + // + // [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 HostKey *string // An array containing all of the information required to call a customer's @@ -109,22 +143,27 @@ type UpdateServerInput struct { LoggingRole *string // Specifies a string to display when users connect to a server. This string is - // displayed after the user authenticates. The SFTP protocol does not support - // post-authentication display banners. + // displayed after the user authenticates. + // + // The SFTP protocol does not support post-authentication display banners. PostAuthenticationLoginBanner *string // Specifies a string to display when users connect to a server. This string is // displayed before the user authenticates. For example, the following banner - // displays details about using the system: This system is for the use of - // authorized users only. Individuals using this computer system without authority, - // or in excess of their authority, are subject to having all of their activities - // on this system monitored and recorded by system personnel. + // displays details about using the system: + // + // This system is for the use of authorized users only. Individuals using this + // computer system without authority, or in excess of their authority, are subject + // to having all of their activities on this system monitored and recorded by + // system personnel. 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 @@ -133,9 +172,11 @@ type UpdateServerInput struct { // 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 @@ -143,55 +184,74 @@ type UpdateServerInput struct { // 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. Protocols []types.Protocol // Specifies whether or not performance for your Amazon S3 directories is - // optimized. This is disabled by default. By default, home directory mappings have - // a TYPE of DIRECTORY . If you enable this option, you would then need to - // explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to - // have a file target. + // optimized. This is disabled by default. + // + // By default, home directory mappings have a TYPE of DIRECTORY . If you enable + // this option, you would then need to explicitly set the HomeDirectoryMapEntry Type + // to FILE if you want a mapping to have a file target. S3StorageOptions *types.S3StorageOptions // Specifies the name of the security policy for the server. SecurityPolicyName *string - // Specifies the log groups to which your server logs are sent. To specify a log - // group, you must provide the ARN for an existing log group. In this case, the - // format of the log group is as follows: - // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For - // example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you - // have previously specified a log group for a server, you can clear it, and in - // effect turn off structured logging, by providing an empty value for this - // parameter in an update-server call. For example: update-server --server-id - // s-1234567890abcdef0 --structured-log-destinations + // Specifies the log groups to which your server logs are sent. + // + // To specify a log group, you must provide the ARN for an existing log group. In + // this case, the format of the log group is as follows: + // + // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* + // + // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* + // + // If you have previously specified a log group for a server, you can clear it, + // and in effect turn off structured logging, by providing an empty value for this + // parameter in an update-server call. For example: + // + // update-server --server-id s-1234567890abcdef0 --structured-log-destinations StructuredLogDestinations []string // Specifies the workflow ID for the workflow to assign and the execution role - // that's used for executing the workflow. In addition to a workflow to execute - // when a file is uploaded completely, WorkflowDetails can also contain a workflow - // ID (and execution role) for a workflow to execute on partial upload. A partial - // upload occurs when the server session disconnects while the file is still being - // 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":[]}' + // that's used for executing the workflow. + // + // In addition to a workflow to execute when a file is uploaded completely, + // WorkflowDetails can also contain a workflow ID (and execution role) for a + // workflow to execute on partial upload. A partial upload occurs when the server + // session disconnects while the file is still being 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":[]}' WorkflowDetails *types.WorkflowDetails noSmithyDocumentSerde diff --git a/service/transfer/api_op_UpdateUser.go b/service/transfer/api_op_UpdateUser.go index 2efb5d927a3..55978b892fe 100644 --- a/service/transfer/api_op_UpdateUser.go +++ b/service/transfer/api_op_UpdateUser.go @@ -13,17 +13,23 @@ import ( // Assigns new properties to a user. Parameters you pass modify any or all of the // following: the home directory, role, and policy for the UserName and ServerId -// you specify. The response returns the ServerId and the UserName for the updated -// user. In the console, you can select Restricted when you create or update a -// user. This ensures that the user can't access anything outside of their home +// you specify. +// +// The response returns the ServerId and the UserName for the updated user. +// +// In the console, you can select Restricted when you create or update a user. +// This ensures that the user can't access anything outside of their home // directory. The programmatic way to configure this behavior is to update the // user. Set their HomeDirectoryType to LOGICAL , and specify HomeDirectoryMappings -// with Entry as root ( / ) and Target as their home directory. For example, if -// the user's home directory is /test/admin-user , the following command updates -// the user so that their configuration in the console shows the Restricted flag as -// selected. aws transfer update-user --server-id --user-name -// admin-user --home-directory-type LOGICAL --home-directory-mappings -// "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]" +// with Entry as root ( / ) and Target as their home directory. +// +// For example, if the user's home directory is /test/admin-user , the following +// command updates the user so that their configuration in the console shows the +// Restricted flag as selected. +// +// aws transfer update-user --server-id --user-name admin-user +// --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", +// \"Target\":\"/test/admin-user\"}]" func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error) { if params == nil { params = &UpdateUserInput{} @@ -57,8 +63,11 @@ 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -67,14 +76,19 @@ type UpdateUserInput struct { // 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. 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" } ] + // 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" } ] HomeDirectoryMappings []types.HomeDirectoryMapEntry // The type of landing directory (folder) that you want your users' home directory @@ -82,25 +96,34 @@ type UpdateUserInput struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType types.HomeDirectoryType // 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, - // 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. + // ${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]. + // + // For more information, see [AssumeRole] in the Amazon Web Services Security Token Service + // API Reference. + // + // [Creating a session policy]: https://docs.aws.amazon.com/transfer/latest/userguide/session-policy + // [AssumeRole]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html Policy *string // Specifies the full POSIX identity, including user ID ( Uid ), group ID ( Gid ), diff --git a/service/transfer/options.go b/service/transfer/options.go index d78c3b1b72c..7469d8b9ca8 100644 --- a/service/transfer/options.go +++ b/service/transfer/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/transfer/types/enums.go b/service/transfer/types/enums.go index c1f9a2a8f03..0ac2442a9a5 100644 --- a/service/transfer/types/enums.go +++ b/service/transfer/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AgreementStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AgreementStatusType) Values() []AgreementStatusType { return []AgreementStatusType{ "ACTIVE", @@ -28,8 +29,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -46,8 +48,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -65,8 +68,9 @@ const ( ) // Values returns all known values for CertificateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateType) Values() []CertificateType { return []CertificateType{ "CERTIFICATE", @@ -84,8 +88,9 @@ const ( ) // Values returns all known values for CertificateUsageType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateUsageType) Values() []CertificateUsageType { return []CertificateUsageType{ "SIGNING", @@ -103,8 +108,9 @@ const ( ) // Values returns all known values for CompressionEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CompressionEnum) Values() []CompressionEnum { return []CompressionEnum{ "ZLIB", @@ -121,8 +127,9 @@ const ( ) // Values returns all known values for CustomStepStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CustomStepStatus) Values() []CustomStepStatus { return []CustomStepStatus{ "SUCCESS", @@ -140,8 +147,9 @@ const ( // Values returns all known values for DirectoryListingOptimization. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DirectoryListingOptimization) Values() []DirectoryListingOptimization { return []DirectoryListingOptimization{ "ENABLED", @@ -158,8 +166,9 @@ const ( ) // Values returns all known values for Domain. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Domain) Values() []Domain { return []Domain{ "S3", @@ -179,8 +188,9 @@ const ( ) // Values returns all known values for EncryptionAlg. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionAlg) Values() []EncryptionAlg { return []EncryptionAlg{ "AES128_CBC", @@ -199,8 +209,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "PGP", @@ -217,8 +228,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -242,8 +254,9 @@ const ( ) // Values returns all known values for ExecutionErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionErrorType) Values() []ExecutionErrorType { return []ExecutionErrorType{ "PERMISSION_DENIED", @@ -268,8 +281,9 @@ const ( ) // Values returns all known values for ExecutionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExecutionStatus) Values() []ExecutionStatus { return []ExecutionStatus{ "IN_PROGRESS", @@ -288,8 +302,9 @@ const ( ) // Values returns all known values for HomeDirectoryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (HomeDirectoryType) Values() []HomeDirectoryType { return []HomeDirectoryType{ "PATH", @@ -308,8 +323,9 @@ const ( ) // Values returns all known values for IdentityProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentityProviderType) Values() []IdentityProviderType { return []IdentityProviderType{ "SERVICE_MANAGED", @@ -328,8 +344,9 @@ const ( ) // Values returns all known values for MapType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MapType) Values() []MapType { return []MapType{ "FILE", @@ -346,8 +363,9 @@ const ( ) // Values returns all known values for MdnResponse. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MdnResponse) Values() []MdnResponse { return []MdnResponse{ "SYNC", @@ -368,8 +386,9 @@ const ( ) // Values returns all known values for MdnSigningAlg. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MdnSigningAlg) Values() []MdnSigningAlg { return []MdnSigningAlg{ "SHA256", @@ -390,8 +409,9 @@ const ( ) // Values returns all known values for OverwriteExisting. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OverwriteExisting) Values() []OverwriteExisting { return []OverwriteExisting{ "TRUE", @@ -408,8 +428,9 @@ const ( ) // Values returns all known values for ProfileType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfileType) Values() []ProfileType { return []ProfileType{ "LOCAL", @@ -428,8 +449,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "SFTP", @@ -448,8 +470,9 @@ const ( ) // Values returns all known values for SecurityPolicyProtocol. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SecurityPolicyProtocol) Values() []SecurityPolicyProtocol { return []SecurityPolicyProtocol{ "SFTP", @@ -467,6 +490,7 @@ const ( // Values returns all known values for SecurityPolicyResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SecurityPolicyResourceType) Values() []SecurityPolicyResourceType { return []SecurityPolicyResourceType{ @@ -484,8 +508,9 @@ const ( ) // Values returns all known values for SetStatOption. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SetStatOption) Values() []SetStatOption { return []SetStatOption{ "DEFAULT", @@ -505,6 +530,7 @@ const ( // Values returns all known values for SftpAuthenticationMethods. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SftpAuthenticationMethods) Values() []SftpAuthenticationMethods { return []SftpAuthenticationMethods{ @@ -527,8 +553,9 @@ const ( ) // Values returns all known values for SigningAlg. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SigningAlg) Values() []SigningAlg { return []SigningAlg{ "SHA256", @@ -552,8 +579,9 @@ const ( ) // 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. +// the future, and so 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{ "OFFLINE", @@ -576,6 +604,7 @@ const ( // 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{ @@ -597,8 +626,9 @@ const ( ) // Values returns all known values for WorkflowStepType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkflowStepType) Values() []WorkflowStepType { return []WorkflowStepType{ "COPY", diff --git a/service/transfer/types/types.go b/service/transfer/types/types.go index be8c50ed2f2..e0f2737a725 100644 --- a/service/transfer/types/types.go +++ b/service/transfer/types/types.go @@ -14,31 +14,47 @@ type As2ConnectorConfig struct { // Provides Basic authentication support to the AS2 Connectors API. To use Basic // authentication, you must provide the name or Amazon Resource Name (ARN) of a - // secret in Secrets Manager. The default value for this parameter is null , which - // indicates that Basic authentication is not enabled for the connector. If the - // connector should use Basic authentication, the secret needs to be in the - // following format: { "Username": "user-name", "Password": "user-password" } + // secret in Secrets Manager. + // + // The default value for this parameter is null , which indicates that Basic + // authentication is not enabled for the connector. + // + // If the connector should use Basic authentication, the secret needs to be in the + // following format: + // + // { "Username": "user-name", "Password": "user-password" } + // // Replace user-name and user-password with the credentials for the actual user - // that is being authenticated. Note the following: + // that is being authenticated. + // + // Note the following: + // // - You are storing these credentials in Secrets Manager, not passing them // directly into this API. + // // - If you are using the API, SDKs, or CloudFormation to configure your // connector, then you must create the secret before you can enable Basic // authentication. However, if you are using the Amazon Web Services management // console, you can have the system create the secret for you. + // // If you have previously enabled Basic authentication for a connector, you can // disable it by using the UpdateConnector API call. For example, if you are using // the CLI, you can run the following command to remove Basic authentication: - // update-connector --connector-id my-connector-id --as2-config - // 'BasicAuthSecretId=""' + // + // update-connector --connector-id my-connector-id --as2-config + // 'BasicAuthSecretId=""' BasicAuthSecretId *string // Specifies whether the AS2 file is compressed. Compression CompressionEnum - // The algorithm that is used to encrypt the file. Note the following: + // The algorithm that is used to encrypt the file. + // + // Note the following: + // // - Do not use the DES_EDE3_CBC algorithm unless you must support a legacy // client that requires it, as it is a weak encryption algorithm. + // // - You can only specify NONE if the URL for your connector uses HTTPS. Using // HTTPS ensures that no traffic is sent in clear text. EncryptionAlgorithm EncryptionAlg @@ -49,13 +65,16 @@ 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. MdnResponse MdnResponse - // The signing algorithm for the MDN response. If set to DEFAULT (or not set at - // all), the value for SigningAlgorithm is used. + // The signing algorithm for the MDN response. + // + // If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used. MdnSigningAlgorithm MdnSigningAlg // Used as the Subject HTTP header attribute in AS2 messages that are being sent @@ -77,32 +96,42 @@ 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 in UTC. + // upload. + // + // The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date + // the file is uploaded in UTC. 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 . If the workflow is processing a file that has the same - // name as an existing file, the behavior is as follows: + // The default is FALSE . + // + // If the workflow is processing a file that has the same name as an existing + // file, the behavior is as follows: + // // - If OverwriteExisting is TRUE , the existing file is replaced with the file // being processed. + // // - If OverwriteExisting is FALSE , nothing happens, and the workflow processing // stops. 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} . SourceFileLocation *string @@ -118,9 +147,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} . SourceFileLocation *string @@ -140,13 +171,17 @@ type DecryptStepDetails struct { // Specifies the location for the file being decrypted. 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 decrypt // 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 // decrypt 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 in UTC. + // the upload. + // + // The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date + // the file is uploaded in UTC. // // This member is required. DestinationFileLocation *InputFileLocation @@ -160,19 +195,25 @@ type DecryptStepDetails struct { Name *string // A flag that indicates whether to overwrite an existing file of the same name. - // The default is FALSE . If the workflow is processing a file that has the same - // name as an existing file, the behavior is as follows: + // The default is FALSE . + // + // If the workflow is processing a file that has the same name as an existing + // file, the behavior is as follows: + // // - If OverwriteExisting is TRUE , the existing file is replaced with the file // being processed. + // // - If OverwriteExisting is FALSE , nothing happens, and the workflow processing // stops. 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} . SourceFileLocation *string @@ -188,9 +229,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} . SourceFileLocation *string @@ -205,17 +248,26 @@ type DescribedAccess struct { // directory. The users of the group that you associate have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If // you know the group name, you can view the SID values by running the following - // command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like - // "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that - // command, replace YourGroupName with the name of your Active Directory group. The - // regular expression used to validate this parameter is a string of characters - // consisting of uppercase and lowercase alphanumeric characters with no spaces. - // You can also include underscores or any of the following characters: =,.@:/- + // command using Windows PowerShell. + // + // Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | + // Select SamAccountName,ObjectSid + // + // In that command, replace YourGroupName with the name of your Active Directory + // group. + // + // The regular expression used to validate this parameter is a string of + // characters consisting of uppercase and lowercase alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@:/- 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -224,10 +276,12 @@ type DescribedAccess struct { // 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. + // 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 @@ -235,11 +289,12 @@ type DescribedAccess struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType HomeDirectoryType // A session policy for your user so that you can use the same Identity and Access @@ -278,24 +333,33 @@ type DescribedAgreement struct { // Connectors are used to send files using either the AS2 or SFTP protocol. For // the access role, provide the Amazon Resource Name (ARN) of the Identity and - // Access Management role to use. For AS2 connectors 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, 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 . If you - // are using Basic authentication for your AS2 connector, the access role requires - // the secretsmanager:GetSecretValue permission for the secret. If the secret is - // encrypted using a customer-managed key instead of the Amazon Web Services - // managed key in Secrets Manager, then the role also needs the kms:Decrypt - // permission for that key. For SFTP connectors Make sure that the access role - // provides read and write access to the parent directory of the file location - // that's used in the StartFileTransfer request. Additionally, make sure that the - // role provides secretsmanager:GetSecretValue permission to Secrets Manager. + // Access Management role to use. + // + // For AS2 connectors + // + // 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, + // 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 . + // + // If you are using Basic authentication for your AS2 connector, the access role + // requires the secretsmanager:GetSecretValue permission for the secret. If the + // secret is encrypted using a customer-managed key instead of the Amazon Web + // Services managed key in Secrets Manager, then the role also needs the + // kms:Decrypt permission for that key. + // + // For SFTP connectors + // + // Make sure that the access role provides read and write access to the parent + // directory of the file location that's used in the StartFileTransfer request. + // Additionally, make sure that the role provides secretsmanager:GetSecretValue + // permission to Secrets Manager. AccessRole *string // A unique identifier for the agreement. This identifier is returned when you @@ -393,24 +457,33 @@ type DescribedConnector struct { // Connectors are used to send files using either the AS2 or SFTP protocol. For // the access role, provide the Amazon Resource Name (ARN) of the Identity and - // Access Management role to use. For AS2 connectors 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, 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 . If you - // are using Basic authentication for your AS2 connector, the access role requires - // the secretsmanager:GetSecretValue permission for the secret. If the secret is - // encrypted using a customer-managed key instead of the Amazon Web Services - // managed key in Secrets Manager, then the role also needs the kms:Decrypt - // permission for that key. For SFTP connectors Make sure that the access role - // provides read and write access to the parent directory of the file location - // that's used in the StartFileTransfer request. Additionally, make sure that the - // role provides secretsmanager:GetSecretValue permission to Secrets Manager. + // Access Management role to use. + // + // For AS2 connectors + // + // 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, + // 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 . + // + // If you are using Basic authentication for your AS2 connector, the access role + // requires the secretsmanager:GetSecretValue permission for the secret. If the + // secret is encrypted using a customer-managed key instead of the Amazon Web + // Services managed key in Secrets Manager, then the role also needs the + // kms:Decrypt permission for that key. + // + // For SFTP connectors + // + // Make sure that the access role provides read and write access to the parent + // directory of the file location that's used in the StartFileTransfer request. + // Additionally, make sure that the role provides secretsmanager:GetSecretValue + // permission to Secrets Manager. AccessRole *string // A structure that contains the parameters for an AS2 connector object. @@ -508,10 +581,15 @@ 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 Type *string @@ -526,11 +604,12 @@ 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]. 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. + // + // [RFC 4130]: https://datatracker.ietf.org/doc/html/rfc4130 As2Id *string // An array of identifiers for the imported certificates. You use this identifier @@ -552,10 +631,10 @@ type DescribedProfile struct { } // Describes the properties of a security policy that you specify. For more -// information about security policies, see Working with security policies for -// servers (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html) -// or Working with security policies for SFTP connectors (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html) -// . +// information about security policies, see [Working with security policies for servers]or [Working with security policies for SFTP connectors]. +// +// [Working with security policies for SFTP connectors]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html +// [Working with security policies for servers]: https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html type DescribedSecurityPolicy struct { // The text name of the specified security policy. @@ -575,8 +654,9 @@ type DescribedSecurityPolicy struct { // applies to both server and connector security policies. SshCiphers []string - // Lists the host key algorithms for the security policy. This parameter only - // applies to security policies for connectors. + // Lists the host key algorithms for the security policy. + // + // This parameter only applies to security policies for connectors. SshHostKeyAlgorithms []string // Lists the enabled SSH key exchange (KEX) encryption algorithms in the security @@ -590,8 +670,9 @@ type DescribedSecurityPolicy struct { SshMacs []string // Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms - // in the security policy that is attached to the server. This parameter only - // applies to security policies for servers. + // in the security policy that is attached to the server. + // + // This parameter only applies to security policies for servers. TlsCiphers []string // The resource type to which the security policy applies, either server or @@ -612,9 +693,11 @@ type DescribedServer struct { // The list of egress IP addresses of this server. These IP addresses are only // relevant for servers that use the AS2 protocol. They are used for sending - // asynchronous MDNs. These IP addresses are assigned automatically when you create - // an AS2 server. Additionally, if you update an existing server and add the AS2 - // protocol, static IP addresses are assigned as well. + // asynchronous MDNs. + // + // These IP addresses are assigned automatically when you create an AS2 server. + // Additionally, if you update an existing server and add the AS2 protocol, static + // IP addresses are assigned as well. As2ServiceManagedEgressIpAddresses []string // Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) @@ -648,17 +731,22 @@ type DescribedServer struct { // 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 - // Directory in your on-premises environment or in Amazon Web Services using AD - // Connector. This option also requires you to provide a Directory ID by using the - // IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with - // an identity provider of your choosing. The API_GATEWAY setting requires you to - // provide an Amazon API Gateway endpoint URL to call for authentication by using - // the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use - // an Lambda function as your identity provider. If you choose this value, you must - // specify the ARN for the Lambda function in the Function parameter for the - // IdentityProviderDetails data type. + // service. + // + // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in + // Directory Service for Microsoft Active Directory or Microsoft Active Directory + // in your on-premises environment or in Amazon Web Services using AD Connector. + // This option also requires you to provide a Directory ID by using the + // IdentityProviderDetails parameter. + // + // Use the API_GATEWAY value to integrate with an identity provider of your + // choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway + // endpoint URL to call for authentication by using the IdentityProviderDetails + // parameter. + // + // Use the AWS_LAMBDA value to directly use an Lambda function as your identity + // provider. If you choose this value, you must specify the ARN for the Lambda + // function in the Function parameter for the IdentityProviderDetails data type. IdentityProviderType IdentityProviderType // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -667,22 +755,27 @@ type DescribedServer struct { LoggingRole *string // Specifies a string to display when users connect to a server. This string is - // displayed after the user authenticates. The SFTP protocol does not support - // post-authentication display banners. + // displayed after the user authenticates. + // + // The SFTP protocol does not support post-authentication display banners. PostAuthenticationLoginBanner *string // Specifies a string to display when users connect to a server. This string is // displayed before the user authenticates. For example, the following banner - // displays details about using the system: This system is for the use of - // authorized users only. Individuals using this computer system without authority, - // or in excess of their authority, are subject to having all of their activities - // on this system monitored and recorded by system personnel. + // displays details about using the system: + // + // This system is for the use of authorized users only. Individuals using this + // computer system without authority, or in excess of their authority, are subject + // to having all of their activities on this system monitored and recorded by + // system personnel. 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 @@ -691,9 +784,11 @@ type DescribedServer struct { // 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 @@ -701,31 +796,40 @@ type DescribedServer struct { // 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. Protocols []Protocol // Specifies whether or not performance for your Amazon S3 directories is - // optimized. This is disabled by default. By default, home directory mappings have - // a TYPE of DIRECTORY . If you enable this option, you would then need to - // explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to - // have a file target. + // optimized. This is disabled by default. + // + // By default, home directory mappings have a TYPE of DIRECTORY . If you enable + // this option, you would then need to explicitly set the HomeDirectoryMapEntry Type + // to FILE if you want a mapping to have a file target. S3StorageOptions *S3StorageOptions // Specifies the name of the security policy for the server. @@ -737,21 +841,27 @@ type DescribedServer struct { // 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. + // 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 log groups to which your server logs are sent. To specify a log - // group, you must provide the ARN for an existing log group. In this case, the - // format of the log group is as follows: - // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* For - // example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* If you - // have previously specified a log group for a server, you can clear it, and in - // effect turn off structured logging, by providing an empty value for this - // parameter in an update-server call. For example: update-server --server-id - // s-1234567890abcdef0 --structured-log-destinations + // Specifies the log groups to which your server logs are sent. + // + // To specify a log group, you must provide the ARN for an existing log group. In + // this case, the format of the log group is as follows: + // + // arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:* + // + // For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:* + // + // If you have previously specified a log group for a server, you can clear it, + // and in effect turn off structured logging, by providing an empty value for this + // parameter in an update-server call. For example: + // + // update-server --server-id s-1234567890abcdef0 --structured-log-destinations StructuredLogDestinations []string // Specifies the key-value pairs that you can use to search for and group servers @@ -763,11 +873,12 @@ type DescribedServer struct { UserCount *int32 // Specifies the workflow ID for the workflow to assign and the execution role - // that's used for executing the workflow. In addition to a workflow to execute - // when a file is uploaded completely, WorkflowDetails can also contain a workflow - // ID (and execution role) for a workflow to execute on partial upload. A partial - // upload occurs when the server session disconnects while the file is still being - // uploaded. + // that's used for executing the workflow. + // + // In addition to a workflow to execute when a file is uploaded completely, + // WorkflowDetails can also contain a workflow ID (and execution role) for a + // workflow to execute on partial upload. A partial upload occurs when the server + // session disconnects while the file is still being uploaded. WorkflowDetails *WorkflowDetails noSmithyDocumentSerde @@ -783,8 +894,11 @@ 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and @@ -793,10 +907,11 @@ type DescribedUser struct { // 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. + // 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 @@ -804,11 +919,12 @@ type DescribedUser struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType HomeDirectoryType // A session policy for your user so that you can use the same Identity and Access @@ -897,57 +1013,81 @@ type EfsFileLocation struct { // file transfer protocol-enabled server. With a VPC endpoint, you can restrict // access to your server and resources only within your VPC. To control incoming // internet traffic, invoke the UpdateServer API and attach an Elastic IP address -// to your server's endpoint. After May 19, 2021, you won't be able to create a -// server using EndpointType=VPC_ENDPOINT in your Amazon Web 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 +// to your server's endpoint. +// +// After May 19, 2021, you won't be able to create a server using +// EndpointType=VPC_ENDPOINT in your Amazon Web 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 // https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. type EndpointDetails struct { // A list of address allocation IDs that are required to attach an Elastic IP - // address to your server's endpoint. An address allocation ID corresponds to the - // allocation ID of an Elastic IP address. This value can be retrieved from the - // allocationId field from the Amazon EC2 Address (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html) - // data type. One way to retrieve this value is by calling the EC2 - // DescribeAddresses (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html) - // API. This parameter is optional. Set this parameter if you want to make your VPC - // endpoint public-facing. For details, see Create an internet-facing endpoint for - // your server (https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint) - // . This property can only be set as follows: + // address to your server's endpoint. + // + // An address allocation ID corresponds to the allocation ID of an Elastic IP + // address. This value can be retrieved from the allocationId field from the + // Amazon EC2 [Address]data type. One way to retrieve this value is by calling the EC2 [DescribeAddresses] API. + // + // This parameter is optional. Set this parameter if you want to make your VPC + // endpoint public-facing. For details, see [Create an internet-facing endpoint for your server]. + // + // This property can only be set as follows: + // // - EndpointType must be set to VPC + // // - The Transfer Family server must be offline. + // // - You cannot set this parameter for Transfer Family servers that use the FTP // protocol. + // // - The server must already have SubnetIds populated ( SubnetIds and // AddressAllocationIds cannot be updated simultaneously). + // // - AddressAllocationIds can't contain duplicates, and must be equal in length // to SubnetIds . For example, if you have three subnet IDs, you must also // specify three address allocation IDs. + // // - Call the UpdateServer API to set or change this parameter. + // + // [Address]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Address.html + // [Create an internet-facing endpoint for your server]: https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#create-internet-facing-endpoint + // [DescribeAddresses]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html 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] 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] // API. + // + // [UpdateServer]: https://docs.aws.amazon.com/transfer/latest/userguide/API_UpdateServer.html + // [ModifyVpcEndpoint]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyVpcEndpoint.html 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 + // The identifier of the VPC endpoint. + // + // This property can only be set when 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 . + // 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 . VpcId *string noSmithyDocumentSerde @@ -963,21 +1103,30 @@ type ExecutionError struct { 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). + // + // - 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. // @@ -1014,10 +1163,15 @@ type ExecutionStepResult struct { 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. StepType WorkflowStepType @@ -1038,8 +1192,11 @@ type FileLocation struct { } // 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" } ] +// . +// +// 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 . @@ -1053,8 +1210,9 @@ type HomeDirectoryMapEntry struct { Target *string // Specifies the type of mapping. Set the type to FILE if you want the mapping to - // point to a file, or DIRECTORY for the directory to point to a directory. By - // default, home directory mappings have a Type of DIRECTORY when you create a + // point to a file, or DIRECTORY for the directory to point to a directory. + // + // By default, home directory mappings have a Type of DIRECTORY when you create a // Transfer Family server. You would need to explicitly set Type to FILE if you // want a mapping to have a file target. Type MapType @@ -1080,10 +1238,14 @@ type IdentityProviderDetails struct { // For SFTP-enabled servers, and for custom identity providers only, you can // specify whether to authenticate using a password, SSH key pair, or both. + // // - PASSWORD - users must provide their password to connect. + // // - PUBLIC_KEY - users must provide their private key to connect. + // // - PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password // or their key. This is the default value. + // // - PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and // their password to connect. The server checks the key first, and then if the key // is valid, the system prompts for a password. If the private key provided does @@ -1116,17 +1278,26 @@ type ListedAccess struct { // directory. The users of the group that you associate have access to your Amazon // S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If // you know the group name, you can view the SID values by running the following - // command using Windows PowerShell. Get-ADGroup -Filter {samAccountName -like - // "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid In that - // command, replace YourGroupName with the name of your Active Directory group. The - // regular expression used to validate this parameter is a string of characters - // consisting of uppercase and lowercase alphanumeric characters with no spaces. - // You can also include underscores or any of the following characters: =,.@:/- + // command using Windows PowerShell. + // + // Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | + // Select SamAccountName,ObjectSid + // + // In that command, replace YourGroupName with the name of your Active Directory + // group. + // + // The regular expression used to validate this parameter is a string of + // characters consisting of uppercase and lowercase alphanumeric characters with no + // spaces. You can also include underscores or any of the following characters: + // =,.@:/- 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // The type of landing directory (folder) that you want your users' home directory @@ -1134,11 +1305,12 @@ type ListedAccess struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType HomeDirectoryType // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -1277,10 +1449,15 @@ 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 Type *string @@ -1293,11 +1470,12 @@ 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]. 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. + // + // [RFC 4130]: https://datatracker.ietf.org/doc/html/rfc4130 As2Id *string // A unique identifier for the local or partner AS2 profile. @@ -1330,17 +1508,22 @@ type ListedServer struct { // 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 - // Directory in your on-premises environment or in Amazon Web Services using AD - // Connector. This option also requires you to provide a Directory ID by using the - // IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with - // an identity provider of your choosing. The API_GATEWAY setting requires you to - // provide an Amazon API Gateway endpoint URL to call for authentication by using - // the IdentityProviderDetails parameter. Use the AWS_LAMBDA value to directly use - // an Lambda function as your identity provider. If you choose this value, you must - // specify the ARN for the Lambda function in the Function parameter for the - // IdentityProviderDetails data type. + // service. + // + // Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in + // Directory Service for Microsoft Active Directory or Microsoft Active Directory + // in your on-premises environment or in Amazon Web Services using AD Connector. + // This option also requires you to provide a Directory ID by using the + // IdentityProviderDetails parameter. + // + // Use the API_GATEWAY value to integrate with an identity provider of your + // choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway + // endpoint URL to call for authentication by using the IdentityProviderDetails + // parameter. + // + // Use the AWS_LAMBDA value to directly use an Lambda function as your identity + // provider. If you choose this value, you must specify the ARN for the Lambda + // function in the Function parameter for the IdentityProviderDetails data type. IdentityProviderType IdentityProviderType // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -1354,10 +1537,11 @@ type ListedServer struct { // 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. + // 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 @@ -1377,8 +1561,11 @@ 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 - // HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . + // the client. + // + // A HomeDirectory example is /bucket_name/home/mydirectory . + // + // The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH . HomeDirectory *string // The type of landing directory (folder) that you want your users' home directory @@ -1386,11 +1573,12 @@ type ListedUser struct { // the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer // protocol clients. If you set it to 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. If HomeDirectoryType is LOGICAL , you must provide - // mappings, using the HomeDirectoryMappings parameter. If, on the other hand, - // HomeDirectoryType is PATH , you provide an absolute path using the HomeDirectory - // parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your - // template. + // visible to your users. + // + // If HomeDirectoryType is LOGICAL , you must provide mappings, using the + // HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is + // PATH , you provide an absolute path using the HomeDirectory parameter. You + // cannot have both HomeDirectory and HomeDirectoryMappings in your template. HomeDirectoryType HomeDirectoryType // The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role @@ -1399,11 +1587,14 @@ type ListedUser struct { // you want to provide your users when transferring files into and out of your // 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. + // 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. Role *string // Specifies the number of SSH public keys stored for the user you specified. @@ -1477,43 +1668,55 @@ type ProtocolDetails struct { // supported. As2Transports []As2Transport - // Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 + // 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 - // application for its usage. For example, if you have a High Availability (HA) - // 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 - // 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 - // client supports the PassiveIp=0.0.0.0 response. + // 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]. + // + // 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 application for its usage. + // For example, if you have a High Availability (HA) 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 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 client supports the PassiveIp=0.0.0.0 + // response. + // + // [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/ PassiveIp *string // Use the SetStatOption to ignore the error that is generated when the client - // attempts to use SETSTAT on a file you are uploading to an S3 bucket. Some SFTP - // file transfer clients can attempt to change the attributes of remote files, - // including timestamp and permissions, using commands, such as SETSTAT when - // uploading the file. However, these commands are not compatible with object + // attempts to use SETSTAT on a file you are uploading to an S3 bucket. + // + // Some SFTP file transfer clients can attempt to change the attributes of remote + // files, including timestamp and permissions, using commands, such as SETSTAT + // when 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 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 + // 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 @@ -1524,19 +1727,23 @@ type ProtocolDetails struct { // 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. + // 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 @@ -1565,14 +1772,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. -// 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 +// +// 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 +// 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 // overwrites the previous version of the bob file. type S3InputFileLocation struct { @@ -1591,10 +1800,11 @@ type S3InputFileLocation struct { type S3StorageOptions struct { // Specifies whether or not performance for your Amazon S3 directories is - // optimized. This is disabled by default. By default, home directory mappings have - // a TYPE of DIRECTORY . If you enable this option, you would then need to - // explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to - // have a file target. + // optimized. This is disabled by default. + // + // By default, home directory mappings have a TYPE of DIRECTORY . If you enable + // this option, you would then need to explicitly set the HomeDirectoryMapEntry Type + // to FILE if you want a mapping to have a file target. DirectoryListingOptimization DirectoryListingOptimization noSmithyDocumentSerde @@ -1630,28 +1840,40 @@ type ServiceMetadata struct { } // Contains the details for an SFTP connector object. The connector object is used -// for transferring files to and from a partner's SFTP server. Because the -// SftpConnectorConfig data type is used for both creating and updating SFTP -// connectors, its parameters, TrustedHostKeys and UserSecretId are marked as not -// required. This is a bit misleading, as they are not required when you are -// updating an existing SFTP connector, but are required when you are creating a -// new SFTP connector. +// for transferring files to and from a partner's SFTP server. +// +// Because the SftpConnectorConfig data type is used for both creating and +// updating SFTP connectors, its parameters, TrustedHostKeys and UserSecretId are +// marked as not required. This is a bit misleading, as they are not required when +// you are updating an existing SFTP connector, but are required when you are +// creating a new SFTP connector. type SftpConnectorConfig struct { // The public portion of the host key, or keys, that are used to identify the // external server to which you are connecting. You can use the ssh-keyscan - // command against the SFTP server to retrieve the necessary key. The three - // standard SSH public key format elements are , , and an - // optional , with spaces between each element. Specify only the and : do not enter the portion of the key. For - // the trusted host key, Transfer Family accepts RSA and ECDSA keys. + // command against the SFTP server to retrieve the necessary key. + // + // The three standard SSH public key format elements are , + // , and an optional , with spaces between each element. Specify only the + // and : do not enter the portion of the key. + // + // For the trusted host key, Transfer Family accepts RSA and ECDSA keys. + // // - For RSA keys, the string is ssh-rsa . + // // - For ECDSA keys, the string is either ecdsa-sha2-nistp256 , // ecdsa-sha2-nistp384 , or ecdsa-sha2-nistp521 , depending on the size of the // key you generated. + // // Run this command to retrieve the SFTP server host key, where your SFTP server - // name is ftp.host.com . ssh-keyscan ftp.host.com This prints the public host key - // to standard output. ftp.host.com ssh-rsa AAAAB3Nza...| Where IdentityType -// is the string that you provide to the PrincipalEntityType parameter for this -// operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon -// Cognito user pool. Verified Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// attributes are available to access when evaluating Cedar policies. +// +// If you delete a Amazon Cognito user pool or user, tokens from that deleted pool +// or that deleted user continue to be usable until they expire. +// +// To reference a user from this identity source in your Cedar policies, use the +// following syntax. +// +// IdentityType::"| +// +// Where IdentityType is the string that you provide to the PrincipalEntityType +// parameter for this operation. The CognitoUserPoolId and CognitoClientId are +// defined by the Amazon Cognito user pool. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency func (c *Client) CreateIdentitySource(ctx context.Context, params *CreateIdentitySourceInput, optFns ...func(*Options)) (*CreateIdentitySourceOutput, error) { if params == nil { params = &CreateIdentitySourceInput{} @@ -53,9 +63,12 @@ func (c *Client) CreateIdentitySource(ctx context.Context, params *CreateIdentit type CreateIdentitySourceInput struct { // Specifies the details required to communicate with the identity provider (IdP) - // associated with this identity source. At this time, the only valid member of - // this structure is a Amazon Cognito user pool configuration. You must specify a - // UserPoolArn , and optionally, a ClientId . + // associated with this identity source. + // + // At this time, the only valid member of this structure is a Amazon Cognito user + // pool configuration. + // + // You must specify a UserPoolArn , and optionally, a ClientId . // // This member is required. Configuration types.Configuration @@ -71,13 +84,19 @@ type CreateIdentitySourceInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an ConflictException error. Verified - // Permissions recognizes a ClientToken for eight hours. After eight hours, the - // next request with the same parameters performs the operation again regardless of - // the value of ClientToken . + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an ConflictException error. + // + // Verified Permissions recognizes a ClientToken for eight hours. After eight + // hours, the next request with the same parameters performs the operation again + // regardless of the value of ClientToken . + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies the namespace and data type of the principals generated for diff --git a/service/verifiedpermissions/api_op_CreatePolicy.go b/service/verifiedpermissions/api_op_CreatePolicy.go index 30b58e58d9e..938618ccb7d 100644 --- a/service/verifiedpermissions/api_op_CreatePolicy.go +++ b/service/verifiedpermissions/api_op_CreatePolicy.go @@ -14,8 +14,10 @@ import ( // Creates a Cedar policy and saves it in the specified policy store. You can // create either a static policy or a policy linked to a policy template. +// // - To create a static policy, provide the Cedar policy text in the StaticPolicy // section of the PolicyDefinition . +// // - To create a policy that is dynamically linked to a policy template, specify // the policy template ID and the principal and resource to associate with this // policy in the templateLinked section of the PolicyDefinition . If the policy @@ -24,10 +26,13 @@ import ( // // Creating a policy causes it to be validated against the schema in the policy // store. If the policy doesn't pass validation, the operation fails and the policy -// isn't stored. Verified Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// isn't stored. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency func (c *Client) CreatePolicy(ctx context.Context, params *CreatePolicyInput, optFns ...func(*Options)) (*CreatePolicyOutput, error) { if params == nil { params = &CreatePolicyInput{} @@ -61,13 +66,19 @@ type CreatePolicyInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an ConflictException error. Verified - // Permissions recognizes a ClientToken for eight hours. After eight hours, the - // next request with the same parameters performs the operation again regardless of - // the value of ClientToken . + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an ConflictException error. + // + // Verified Permissions recognizes a ClientToken for eight hours. After eight + // hours, the next request with the same parameters performs the operation again + // regardless of the value of ClientToken . + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/verifiedpermissions/api_op_CreatePolicyStore.go b/service/verifiedpermissions/api_op_CreatePolicyStore.go index 5ed2c2d1622..f60341c9c61 100644 --- a/service/verifiedpermissions/api_op_CreatePolicyStore.go +++ b/service/verifiedpermissions/api_op_CreatePolicyStore.go @@ -13,12 +13,16 @@ import ( ) // Creates a policy store. A policy store is a container for policy resources. -// Although Cedar supports multiple namespaces (https://docs.cedarpolicy.com/schema/schema.html#namespace) -// , Verified Permissions currently supports only one namespace per policy store. -// Verified Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// +// Although [Cedar supports multiple namespaces], Verified Permissions currently supports only one namespace per +// policy store. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency +// [Cedar supports multiple namespaces]: https://docs.cedarpolicy.com/schema/schema.html#namespace func (c *Client) CreatePolicyStore(ctx context.Context, params *CreatePolicyStoreInput, optFns ...func(*Options)) (*CreatePolicyStoreOutput, error) { if params == nil { params = &CreatePolicyStoreInput{} @@ -36,13 +40,17 @@ func (c *Client) CreatePolicyStore(ctx context.Context, params *CreatePolicyStor type CreatePolicyStoreInput struct { - // Specifies the validation setting for this policy store. Currently, the only - // valid and required value is Mode . We recommend that you turn on STRICT mode - // only after you define a schema. If a schema doesn't exist, then STRICT mode - // causes any policy to fail validation, and Verified Permissions rejects the - // policy. You can turn off validation by using the UpdatePolicyStore (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore) - // . Then, when you have a schema defined, use UpdatePolicyStore (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore) - // again to turn validation back on. + // Specifies the validation setting for this policy store. + // + // Currently, the only valid and required value is Mode . + // + // We recommend that you turn on STRICT mode only after you define a schema. If a + // schema doesn't exist, then STRICT mode causes any policy to fail validation, + // and Verified Permissions rejects the policy. You can turn off validation by + // using the [UpdatePolicyStore]. Then, when you have a schema defined, use [UpdatePolicyStore] again to turn validation + // back on. + // + // [UpdatePolicyStore]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore // // This member is required. ValidationSettings *types.ValidationSettings @@ -51,13 +59,19 @@ type CreatePolicyStoreInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an ConflictException error. Verified - // Permissions recognizes a ClientToken for eight hours. After eight hours, the - // next request with the same parameters performs the operation again regardless of - // the value of ClientToken . + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an ConflictException error. + // + // Verified Permissions recognizes a ClientToken for eight hours. After eight + // hours, the next request with the same parameters performs the operation again + // regardless of the value of ClientToken . + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Descriptive text that you can provide to help with identification of the diff --git a/service/verifiedpermissions/api_op_CreatePolicyTemplate.go b/service/verifiedpermissions/api_op_CreatePolicyTemplate.go index b8cb1344f46..0a18a990a80 100644 --- a/service/verifiedpermissions/api_op_CreatePolicyTemplate.go +++ b/service/verifiedpermissions/api_op_CreatePolicyTemplate.go @@ -17,11 +17,13 @@ import ( // instantiated policy can then be considered in authorization decisions. The // instantiated policy works identically to any other policy, except that it is // dynamically linked to the template. If the template changes, then any policies -// that are linked to that template are immediately updated as well. Verified -// Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// that are linked to that template are immediately updated as well. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency func (c *Client) CreatePolicyTemplate(ctx context.Context, params *CreatePolicyTemplateInput, optFns ...func(*Options)) (*CreatePolicyTemplateOutput, error) { if params == nil { params = &CreatePolicyTemplateInput{} @@ -54,13 +56,19 @@ type CreatePolicyTemplateInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an ConflictException error. Verified - // Permissions recognizes a ClientToken for eight hours. After eight hours, the - // next request with the same parameters performs the operation again regardless of - // the value of ClientToken . + // all other parameters. We recommend that you use a [UUID type of value.]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an ConflictException error. + // + // Verified Permissions recognizes a ClientToken for eight hours. After eight + // hours, the next request with the same parameters performs the operation again + // regardless of the value of ClientToken . + // + // [UUID type of value.]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // Specifies a description for the policy template. diff --git a/service/verifiedpermissions/api_op_DeleteIdentitySource.go b/service/verifiedpermissions/api_op_DeleteIdentitySource.go index 28f26cfbeef..e8770dc62b5 100644 --- a/service/verifiedpermissions/api_op_DeleteIdentitySource.go +++ b/service/verifiedpermissions/api_op_DeleteIdentitySource.go @@ -13,8 +13,9 @@ import ( // Deletes an identity source that references an identity provider (IdP) such as // Amazon Cognito. After you delete the identity source, you can no longer use // tokens for identities from that identity source to represent principals in -// authorization queries made using IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) -// . operations. +// authorization queries made using [IsAuthorizedWithToken]. operations. +// +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html func (c *Client) DeleteIdentitySource(ctx context.Context, params *DeleteIdentitySourceInput, optFns ...func(*Options)) (*DeleteIdentitySourceOutput, error) { if params == nil { params = &DeleteIdentitySourceInput{} diff --git a/service/verifiedpermissions/api_op_DeletePolicy.go b/service/verifiedpermissions/api_op_DeletePolicy.go index ce99552f0cc..ded42977ae2 100644 --- a/service/verifiedpermissions/api_op_DeletePolicy.go +++ b/service/verifiedpermissions/api_op_DeletePolicy.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified policy from the policy store. This operation is -// idempotent; if you specify a policy that doesn't exist, the request response -// returns a successful HTTP 200 status code. +// Deletes the specified policy from the policy store. +// +// This operation is idempotent; if you specify a policy that doesn't exist, the +// request response returns a successful HTTP 200 status code. func (c *Client) DeletePolicy(ctx context.Context, params *DeletePolicyInput, optFns ...func(*Options)) (*DeletePolicyOutput, error) { if params == nil { params = &DeletePolicyInput{} diff --git a/service/verifiedpermissions/api_op_DeletePolicyStore.go b/service/verifiedpermissions/api_op_DeletePolicyStore.go index 64adb132a05..59181f8b2c1 100644 --- a/service/verifiedpermissions/api_op_DeletePolicyStore.go +++ b/service/verifiedpermissions/api_op_DeletePolicyStore.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified policy store. This operation is idempotent. If you -// specify a policy store that does not exist, the request response will still -// return a successful HTTP 200 status code. +// Deletes the specified policy store. +// +// This operation is idempotent. If you specify a policy store that does not +// exist, the request response will still return a successful HTTP 200 status code. func (c *Client) DeletePolicyStore(ctx context.Context, params *DeletePolicyStoreInput, optFns ...func(*Options)) (*DeletePolicyStoreOutput, error) { if params == nil { params = &DeletePolicyStoreInput{} diff --git a/service/verifiedpermissions/api_op_DeletePolicyTemplate.go b/service/verifiedpermissions/api_op_DeletePolicyTemplate.go index b26c349e944..96091ff27f2 100644 --- a/service/verifiedpermissions/api_op_DeletePolicyTemplate.go +++ b/service/verifiedpermissions/api_op_DeletePolicyTemplate.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified policy template from the policy store. This operation -// also deletes any policies that were created from the specified policy template. -// Those policies are immediately removed from all future API responses, and are -// asynchronously deleted from the policy store. +// Deletes the specified policy template from the policy store. +// +// This operation also deletes any policies that were created from the specified +// policy template. Those policies are immediately removed from all future API +// responses, and are asynchronously deleted from the policy store. func (c *Client) DeletePolicyTemplate(ctx context.Context, params *DeletePolicyTemplateInput, optFns ...func(*Options)) (*DeletePolicyTemplateOutput, error) { if params == nil { params = &DeletePolicyTemplateInput{} diff --git a/service/verifiedpermissions/api_op_IsAuthorized.go b/service/verifiedpermissions/api_op_IsAuthorized.go index ec1f84d812e..5a2c7e1abaa 100644 --- a/service/verifiedpermissions/api_op_IsAuthorized.go +++ b/service/verifiedpermissions/api_op_IsAuthorized.go @@ -49,9 +49,10 @@ type IsAuthorizedInput struct { Context types.ContextDefinition // Specifies the list of resources and principals and their associated attributes - // that Verified Permissions can examine when evaluating the policies. You can - // include only principal and resource entities in this parameter; you can't - // include actions. You must specify actions in the schema. + // that Verified Permissions can examine when evaluating the policies. + // + // You can include only principal and resource entities in this parameter; you + // can't include actions. You must specify actions in the schema. Entities types.EntitiesDefinition // Specifies the principal for which the authorization decision is to be made. diff --git a/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go b/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go index 55987d52417..d63b68983fa 100644 --- a/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go +++ b/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go @@ -13,16 +13,21 @@ import ( // Makes an authorization decision about a service request described in the // parameters. The principal in this request comes from an external identity source -// in the form of an identity token formatted as a JSON web token (JWT) (https://wikipedia.org/wiki/JSON_Web_Token) -// . The information in the parameters can also define additional context that -// Verified Permissions can include in the evaluation. The request is evaluated -// against all matching policies in the specified policy store. The result of the -// decision is either Allow or Deny , along with a list of the policies that -// resulted in the decision. At this time, Verified Permissions accepts tokens from -// only Amazon Cognito. Verified Permissions validates each token that is specified -// in a request by checking its expiration date and its signature. If you delete a -// Amazon Cognito user pool or user, tokens from that deleted pool or that deleted -// user continue to be usable until they expire. +// in the form of an identity token formatted as a [JSON web token (JWT)]. The information in the +// parameters can also define additional context that Verified Permissions can +// include in the evaluation. The request is evaluated against all matching +// policies in the specified policy store. The result of the decision is either +// Allow or Deny , along with a list of the policies that resulted in the decision. +// +// At this time, Verified Permissions accepts tokens from only Amazon Cognito. +// +// Verified Permissions validates each token that is specified in a request by +// checking its expiration date and its signature. +// +// If you delete a Amazon Cognito user pool or user, tokens from that deleted pool +// or that deleted user continue to be usable until they expire. +// +// [JSON web token (JWT)]: https://wikipedia.org/wiki/JSON_Web_Token func (c *Client) IsAuthorizedWithToken(ctx context.Context, params *IsAuthorizedWithTokenInput, optFns ...func(*Options)) (*IsAuthorizedWithTokenOutput, error) { if params == nil { params = &IsAuthorizedWithTokenInput{} @@ -49,8 +54,10 @@ type IsAuthorizedWithTokenInput struct { // Specifies an access token for the principal to be authorized. This token is // provided to you by the identity provider (IdP) associated with the specified // identity source. You must specify either an accessToken , an identityToken , or - // both. Must be an access token. Verified Permissions returns an error if the - // token_use claim in the submitted token isn't access . + // both. + // + // Must be an access token. Verified Permissions returns an error if the token_use + // claim in the submitted token isn't access . AccessToken *string // Specifies the requested action to be authorized. Is the specified principal @@ -62,20 +69,25 @@ type IsAuthorizedWithTokenInput struct { Context types.ContextDefinition // Specifies the list of resources and their associated attributes that Verified - // Permissions can examine when evaluating the policies. You can't include - // principals in this parameter, only resource and action entities. This parameter - // can't include any entities of a type that matches the user or group entity types - // that you defined in your identity source. + // Permissions can examine when evaluating the policies. + // + // You can't include principals in this parameter, only resource and action + // entities. This parameter can't include any entities of a type that matches the + // user or group entity types that you defined in your identity source. + // // - The IsAuthorizedWithToken operation takes principal attributes from only the // identityToken or accessToken passed to the operation. + // // - For action entities, you can include only their Identifier and EntityType . Entities types.EntitiesDefinition // Specifies an identity token for the principal to be authorized. This token is // provided to you by the identity provider (IdP) associated with the specified // identity source. You must specify either an accessToken , an identityToken , or - // both. Must be an ID token. Verified Permissions returns an error if the - // token_use claim in the submitted token isn't id . + // both. + // + // Must be an ID token. Verified Permissions returns an error if the token_use + // claim in the submitted token isn't id . IdentityToken *string // Specifies the resource for which the authorization decision is made. For diff --git a/service/verifiedpermissions/api_op_ListIdentitySources.go b/service/verifiedpermissions/api_op_ListIdentitySources.go index a2572447707..796d7b28838 100644 --- a/service/verifiedpermissions/api_op_ListIdentitySources.go +++ b/service/verifiedpermissions/api_op_ListIdentitySources.go @@ -46,9 +46,11 @@ type ListIdentitySourcesInput struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 identity sources per - // response. You can specify a maximum of 200 identity sources per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 identity + // sources per response. You can specify a maximum of 200 identity sources per + // response. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you @@ -176,9 +178,11 @@ type ListIdentitySourcesPaginatorOptions struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 identity sources per - // response. You can specify a maximum of 200 identity sources per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 identity + // sources per response. You can specify a maximum of 200 identity sources per + // response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/verifiedpermissions/api_op_ListPolicies.go b/service/verifiedpermissions/api_op_ListPolicies.go index 66ffd253393..371274820e8 100644 --- a/service/verifiedpermissions/api_op_ListPolicies.go +++ b/service/verifiedpermissions/api_op_ListPolicies.go @@ -45,9 +45,10 @@ type ListPoliciesInput struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 policies per response. - // You can specify a maximum of 50 policies per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 policies per + // response. You can specify a maximum of 50 policies per response. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you @@ -173,9 +174,10 @@ type ListPoliciesPaginatorOptions struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 policies per response. - // You can specify a maximum of 50 policies per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 policies per + // response. You can specify a maximum of 50 policies per response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/verifiedpermissions/api_op_ListPolicyStores.go b/service/verifiedpermissions/api_op_ListPolicyStores.go index 4a0bca57bd6..6fc49ece0d9 100644 --- a/service/verifiedpermissions/api_op_ListPolicyStores.go +++ b/service/verifiedpermissions/api_op_ListPolicyStores.go @@ -36,9 +36,10 @@ type ListPolicyStoresInput struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 policy stores per - // response. You can specify a maximum of 50 policy stores per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 policy + // stores per response. You can specify a maximum of 50 policy stores per response. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you @@ -162,9 +163,10 @@ type ListPolicyStoresPaginatorOptions struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 policy stores per - // response. You can specify a maximum of 50 policy stores per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 policy + // stores per response. You can specify a maximum of 50 policy stores per response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/verifiedpermissions/api_op_ListPolicyTemplates.go b/service/verifiedpermissions/api_op_ListPolicyTemplates.go index 8d195f2983c..87f5c2cb8a4 100644 --- a/service/verifiedpermissions/api_op_ListPolicyTemplates.go +++ b/service/verifiedpermissions/api_op_ListPolicyTemplates.go @@ -41,9 +41,11 @@ type ListPolicyTemplatesInput struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 policy templates per - // response. You can specify a maximum of 50 policy templates per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 policy + // templates per response. You can specify a maximum of 50 policy templates per + // response. MaxResults *int32 // Specifies that you want to receive the next page of results. Valid only if you @@ -171,9 +173,11 @@ type ListPolicyTemplatesPaginatorOptions struct { // NextToken request parameter in the next call to the operation to get the next // set of 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. If you do - // not specify this parameter, the operation defaults to 10 policy templates per - // response. You can specify a maximum of 50 policy templates per response. + // after every operation to ensure that you receive all of the results. + // + // If you do not specify this parameter, the operation defaults to 10 policy + // templates per response. You can specify a maximum of 50 policy templates per + // response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/verifiedpermissions/api_op_PutSchema.go b/service/verifiedpermissions/api_op_PutSchema.go index 02679e7c9e2..5c3c3a27e22 100644 --- a/service/verifiedpermissions/api_op_PutSchema.go +++ b/service/verifiedpermissions/api_op_PutSchema.go @@ -17,10 +17,13 @@ import ( // policy store. Any changes to the schema validate only policies and templates // submitted after the schema change. Existing policies and templates are not // re-evaluated against the changed schema. If you later update a policy, then it -// is evaluated against the new schema at that time. Verified Permissions is -// eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) . It can -// take a few seconds for a new or changed element to propagate through the service -// and be visible in the results of other Verified Permissions operations. +// is evaluated against the new schema at that time. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency func (c *Client) PutSchema(ctx context.Context, params *PutSchemaInput, optFns ...func(*Options)) (*PutSchemaOutput, error) { if params == nil { params = &PutSchemaInput{} diff --git a/service/verifiedpermissions/api_op_UpdateIdentitySource.go b/service/verifiedpermissions/api_op_UpdateIdentitySource.go index 08c713daaf7..89f0cd5074f 100644 --- a/service/verifiedpermissions/api_op_UpdateIdentitySource.go +++ b/service/verifiedpermissions/api_op_UpdateIdentitySource.go @@ -14,10 +14,13 @@ import ( // Updates the specified identity source to use a new identity provider (IdP) // source, or to change the mapping of identities from the IdP to a different -// principal entity type. Verified Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// principal entity type. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency func (c *Client) UpdateIdentitySource(ctx context.Context, params *UpdateIdentitySourceInput, optFns ...func(*Options)) (*UpdateIdentitySourceOutput, error) { if params == nil { params = &UpdateIdentitySourceInput{} @@ -47,9 +50,12 @@ type UpdateIdentitySourceInput struct { PolicyStoreId *string // Specifies the details required to communicate with the identity provider (IdP) - // associated with this identity source. At this time, the only valid member of - // this structure is a Amazon Cognito user pool configuration. You must specify a - // userPoolArn , and optionally, a ClientId . + // associated with this identity source. + // + // At this time, the only valid member of this structure is a Amazon Cognito user + // pool configuration. + // + // You must specify a userPoolArn , and optionally, a ClientId . // // This member is required. UpdateConfiguration types.UpdateConfiguration diff --git a/service/verifiedpermissions/api_op_UpdatePolicy.go b/service/verifiedpermissions/api_op_UpdatePolicy.go index 45010f3e9a5..6f417888875 100644 --- a/service/verifiedpermissions/api_op_UpdatePolicy.go +++ b/service/verifiedpermissions/api_op_UpdatePolicy.go @@ -13,30 +13,41 @@ import ( ) // Modifies a Cedar static policy in the specified policy store. You can change -// only certain elements of the UpdatePolicyDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyInput.html#amazonverifiedpermissions-UpdatePolicy-request-UpdatePolicyDefinition) -// parameter. You can directly update only static policies. To change a -// template-linked policy, you must update the template instead, using -// UpdatePolicyTemplate (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html) -// . +// only certain elements of the [UpdatePolicyDefinition]parameter. You can directly update only static +// policies. To change a template-linked policy, you must update the template +// instead, using [UpdatePolicyTemplate]. +// // - If policy validation is enabled in the policy store, then updating a static // policy causes Verified Permissions to validate the policy against the schema in // the policy store. If the updated static policy doesn't pass validation, the // operation fails and the update isn't stored. +// // - When you edit a static policy, you can change only certain elements of a // static policy: +// // - The action referenced by the policy. -// - A condition clause, such as when and unless. You can't change these -// elements of a static policy: +// +// - A condition clause, such as when and unless. +// +// You can't change these elements of a static policy: +// // - Changing a policy from a static policy to a template-linked policy. +// // - Changing the effect of a static policy from permit or forbid. +// // - The principal referenced by a static policy. +// // - The resource referenced by a static policy. +// // - To update a template-linked policy, you must update the template instead. // -// Verified Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency +// [UpdatePolicyTemplate]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html +// [UpdatePolicyDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyInput.html#amazonverifiedpermissions-UpdatePolicy-request-UpdatePolicyDefinition func (c *Client) UpdatePolicy(ctx context.Context, params *UpdatePolicyInput, optFns ...func(*Options)) (*UpdatePolicyOutput, error) { if params == nil { params = &UpdatePolicyInput{} @@ -55,22 +66,31 @@ func (c *Client) UpdatePolicy(ctx context.Context, params *UpdatePolicyInput, op type UpdatePolicyInput struct { // Specifies the updated policy content that you want to replace on the specified - // policy. The content must be valid Cedar policy language text. You can change - // only the following elements from the policy definition: + // policy. The content must be valid Cedar policy language text. + // + // You can change only the following elements from the policy definition: + // // - The action referenced by the policy. + // // - Any conditional clauses, such as when or unless clauses. + // // You can't change the following elements: + // // - Changing from static to templateLinked . + // // - Changing the effect of the policy from permit or forbid . + // // - The principal referenced by the policy. + // // - The resource referenced by the policy. // // This member is required. Definition types.UpdatePolicyDefinition // Specifies the ID of the policy that you want to update. To find this value, you - // can use ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html) - // . + // can use [ListPolicies]. + // + // [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html // // This member is required. PolicyId *string diff --git a/service/verifiedpermissions/api_op_UpdatePolicyStore.go b/service/verifiedpermissions/api_op_UpdatePolicyStore.go index 78474ee7c60..d523155cd2e 100644 --- a/service/verifiedpermissions/api_op_UpdatePolicyStore.go +++ b/service/verifiedpermissions/api_op_UpdatePolicyStore.go @@ -12,10 +12,13 @@ import ( "time" ) -// Modifies the validation setting for a policy store. Verified Permissions is -// eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) . It can -// take a few seconds for a new or changed element to propagate through the service -// and be visible in the results of other Verified Permissions operations. +// Modifies the validation setting for a policy store. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency func (c *Client) UpdatePolicyStore(ctx context.Context, params *UpdatePolicyStoreInput, optFns ...func(*Options)) (*UpdatePolicyStoreOutput, error) { if params == nil { params = &UpdatePolicyStoreInput{} @@ -53,8 +56,9 @@ type UpdatePolicyStoreInput struct { type UpdatePolicyStoreOutput struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the updated policy store. + // The [Amazon Resource Name (ARN)] of the updated policy store. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. Arn *string diff --git a/service/verifiedpermissions/api_op_UpdatePolicyTemplate.go b/service/verifiedpermissions/api_op_UpdatePolicyTemplate.go index 8f93703850b..f8105335c33 100644 --- a/service/verifiedpermissions/api_op_UpdatePolicyTemplate.go +++ b/service/verifiedpermissions/api_op_UpdatePolicyTemplate.go @@ -12,14 +12,18 @@ import ( ) // Updates the specified policy template. You can update only the description and -// the some elements of the policyBody (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html#amazonverifiedpermissions-UpdatePolicyTemplate-request-policyBody) -// . Changes you make to the policy template content are immediately (within the +// the some elements of the [policyBody]. +// +// Changes you make to the policy template content are immediately (within the // constraints of eventual consistency) reflected in authorization decisions that -// involve all template-linked policies instantiated from this template. Verified -// Permissions is eventually consistent (https://wikipedia.org/wiki/Eventual_consistency) -// . It can take a few seconds for a new or changed element to propagate through -// the service and be visible in the results of other Verified Permissions -// operations. +// involve all template-linked policies instantiated from this template. +// +// Verified Permissions is [eventually consistent] . It can take a few seconds for a new or changed +// element to propagate through the service and be visible in the results of other +// Verified Permissions operations. +// +// [eventually consistent]: https://wikipedia.org/wiki/Eventual_consistency +// [policyBody]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html#amazonverifiedpermissions-UpdatePolicyTemplate-request-policyBody func (c *Client) UpdatePolicyTemplate(ctx context.Context, params *UpdatePolicyTemplateInput, optFns ...func(*Options)) (*UpdatePolicyTemplateOutput, error) { if params == nil { params = &UpdatePolicyTemplateInput{} @@ -49,13 +53,20 @@ type UpdatePolicyTemplateInput struct { PolicyTemplateId *string // Specifies new statement content written in Cedar policy language to replace the - // current body of the policy template. You can change only the following elements - // of the policy body: + // current body of the policy template. + // + // You can change only the following elements of the policy body: + // // - The action referenced by the policy template. + // // - Any conditional clauses, such as when or unless clauses. + // // You can't change the following elements: + // // - The effect ( permit or forbid ) of the policy template. + // // - The principal referenced by the policy template. + // // - The resource referenced by the policy template. // // This member is required. diff --git a/service/verifiedpermissions/doc.go b/service/verifiedpermissions/doc.go index a5fa7270e9d..3b90c24c0e1 100644 --- a/service/verifiedpermissions/doc.go +++ b/service/verifiedpermissions/doc.go @@ -12,32 +12,42 @@ // resources, and session context, such as time of request and IP addresses. // Verified Permissions manages these permissions by letting you create and store // authorization policies for your applications, such as consumer-facing web sites -// and enterprise business systems. Verified Permissions uses Cedar as the policy -// language to express your permission requirements. Cedar supports both role-based -// access control (RBAC) and attribute-based access control (ABAC) authorization -// models. For more information about configuring, administering, and using Amazon -// Verified Permissions in your applications, see the Amazon Verified Permissions -// User Guide (https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/) . -// For more information about the Cedar policy language, see the Cedar Policy -// Language Guide (https://docs.cedarpolicy.com/) . When you write Cedar policies -// that reference principals, resources and actions, you can define the unique -// identifiers used for each of those elements. We strongly recommend that you -// follow these best practices: +// and enterprise business systems. +// +// Verified Permissions uses Cedar as the policy language to express your +// permission requirements. Cedar supports both role-based access control (RBAC) +// and attribute-based access control (ABAC) authorization models. +// +// For more information about configuring, administering, and using Amazon +// Verified Permissions in your applications, see the [Amazon Verified Permissions User Guide]. +// +// For more information about the Cedar policy language, see the [Cedar Policy Language Guide]. +// +// When you write Cedar policies that reference principals, resources and actions, +// you can define the unique identifiers used for each of those elements. We +// strongly recommend that you follow these best practices: +// // - Use values like universally unique identifiers (UUIDs) for all principal -// and resource identifiers. For example, if user jane leaves the company, and -// you later let someone else use the name jane , then that new user -// automatically gets access to everything granted by policies that still reference -// User::"jane" . Cedar can’t distinguish between the new user and the old. This -// applies to both principal and resource identifiers. Always use identifiers that -// are guaranteed unique and never reused to ensure that you don’t unintentionally -// grant access because of the presence of an old identifier in a policy. Where you -// use a UUID for an entity, we recommend that you follow it with the // comment -// specifier and the ‘friendly’ name of your entity. This helps to make your -// policies easier to understand. For example: principal == -// User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice -// - Do not include personally identifying, confidential, or sensitive -// information as part of the unique identifier for your principals or resources. -// These identifiers are included in log entries shared in CloudTrail trails. +// and resource identifiers. +// +// For example, if user jane leaves the company, and you later let someone else use +// +// the name jane , then that new user automatically gets access to everything +// granted by policies that still reference User::"jane" . Cedar can’t +// distinguish between the new user and the old. This applies to both principal and +// resource identifiers. Always use identifiers that are guaranteed unique and +// never reused to ensure that you don’t unintentionally grant access because of +// the presence of an old identifier in a policy. +// +// Where you use a UUID for an entity, we recommend that you follow it with the // +// +// comment specifier and the ‘friendly’ name of your entity. This helps to make +// your policies easier to understand. For example: principal == +// User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice +// +// - Do not include personally identifying, confidential, or sensitive +// information as part of the unique identifier for your principals or resources. +// These identifiers are included in log entries shared in CloudTrail trails. // // Several operations return structures that appear similar, but have different // purposes. As new functionality is added to the product, the structure used in a @@ -46,7 +56,12 @@ // the purpose of each, the following naming convention is used for the structures: // // - Parameter type structures that end in Detail are used in Get operations. +// // - Parameter type structures that end in Item are used in List operations. +// // - Parameter type structures that use neither suffix are used in the mutating // (create and update) operations. +// +// [Cedar Policy Language Guide]: https://docs.cedarpolicy.com/ +// [Amazon Verified Permissions User Guide]: https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/ package verifiedpermissions diff --git a/service/verifiedpermissions/options.go b/service/verifiedpermissions/options.go index d31ad4c9c98..77231bfb25c 100644 --- a/service/verifiedpermissions/options.go +++ b/service/verifiedpermissions/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/verifiedpermissions/types/enums.go b/service/verifiedpermissions/types/enums.go index dded1fcebca..4b8b2057d51 100644 --- a/service/verifiedpermissions/types/enums.go +++ b/service/verifiedpermissions/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for Decision. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Decision) Values() []Decision { return []Decision{ "ALLOW", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for OpenIdIssuer. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OpenIdIssuer) Values() []OpenIdIssuer { return []OpenIdIssuer{ "COGNITO", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for PolicyType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PolicyType) Values() []PolicyType { return []PolicyType{ "STATIC", @@ -66,8 +69,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "IDENTITY_SOURCE", @@ -87,8 +91,9 @@ const ( ) // Values returns all known values for ValidationMode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ValidationMode) Values() []ValidationMode { return []ValidationMode{ "OFF", diff --git a/service/verifiedpermissions/types/errors.go b/service/verifiedpermissions/types/errors.go index a2699fd7393..45b8d4abb5c 100644 --- a/service/verifiedpermissions/types/errors.go +++ b/service/verifiedpermissions/types/errors.go @@ -179,36 +179,71 @@ func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.Fau // The request failed because one or more input parameters don't satisfy their // constraint requirements. The output is provided as a list of fields and a reason -// for each field that isn't valid. The possible reasons include the following: -// - UnrecognizedEntityType The policy includes an entity type that isn't found -// in the schema. -// - UnrecognizedActionId The policy includes an action id that isn't found in -// the schema. -// - InvalidActionApplication The policy includes an action that, according to -// the schema, doesn't support the specified principal and resource. -// - UnexpectedType The policy included an operand that isn't a valid type for -// the specified operation. -// - IncompatibleTypes The types of elements included in a set , or the types of -// expressions used in an if...then...else clause aren't compatible in this -// context. -// - MissingAttribute The policy attempts to access a record or entity attribute -// that isn't specified in the schema. Test for the existence of the attribute -// first before attempting to access its value. For more information, see the -// has (presence of attribute test) operator (https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test) -// in the Cedar Policy Language Guide. -// - UnsafeOptionalAttributeAccess The policy attempts to access a record or -// entity attribute that is optional and isn't guaranteed to be present. Test for -// the existence of the attribute first before attempting to access its value. For -// more information, see the has (presence of attribute test) operator (https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test) -// in the Cedar Policy Language Guide. -// - ImpossiblePolicy Cedar has determined that a policy condition always -// evaluates to false. If the policy is always false, it can never apply to any -// query, and so it can never affect an authorization decision. -// - WrongNumberArguments The policy references an extension type with the wrong -// number of arguments. -// - FunctionArgumentValidationError Cedar couldn't parse the argument passed to -// an extension type. For example, a string that is to be parsed as an IPv4 address -// can contain only digits and the period character. +// for each field that isn't valid. +// +// The possible reasons include the following: +// +// - UnrecognizedEntityType +// +// The policy includes an entity type that isn't found in the schema. +// +// - UnrecognizedActionId +// +// The policy includes an action id that isn't found in the schema. +// +// - InvalidActionApplication +// +// The policy includes an action that, according to the schema, doesn't support +// +// the specified principal and resource. +// +// - UnexpectedType +// +// The policy included an operand that isn't a valid type for the specified +// +// operation. +// +// - IncompatibleTypes +// +// The types of elements included in a set , or the types of expressions used in an +// +// if...then...else clause aren't compatible in this context. +// +// - MissingAttribute +// +// The policy attempts to access a record or entity attribute that isn't specified +// +// in the schema. Test for the existence of the attribute first before attempting +// to access its value. For more information, see the [has (presence of attribute test) operator]in the Cedar Policy +// Language Guide. +// +// - UnsafeOptionalAttributeAccess +// +// The policy attempts to access a record or entity attribute that is optional and +// +// isn't guaranteed to be present. Test for the existence of the attribute first +// before attempting to access its value. For more information, see the [has (presence of attribute test) operator]in the +// Cedar Policy Language Guide. +// +// - ImpossiblePolicy +// +// Cedar has determined that a policy condition always evaluates to false. If the +// +// policy is always false, it can never apply to any query, and so it can never +// affect an authorization decision. +// +// - WrongNumberArguments +// +// The policy references an extension type with the wrong number of arguments. +// +// - FunctionArgumentValidationError +// +// Cedar couldn't parse the argument passed to an extension type. For example, a +// +// string that is to be parsed as an IPv4 address can contain only digits and the +// period character. +// +// [has (presence of attribute test) operator]: https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test type ValidationException struct { Message *string diff --git a/service/verifiedpermissions/types/types.go b/service/verifiedpermissions/types/types.go index 546f488a1dd..5be9c18b2f4 100644 --- a/service/verifiedpermissions/types/types.go +++ b/service/verifiedpermissions/types/types.go @@ -8,11 +8,15 @@ import ( ) // Contains information about an action for a request for which an authorization -// decision is made. This data type is used as a request parameter to the -// IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html) -// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) -// operations. Example: { "actionId": "", "actionType": "Action" } +// decision is made. +// +// This data type is used as a request parameter to the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations. +// +// Example: { "actionId": "", "actionType": "Action" } +// +// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html type ActionIdentifier struct { // The ID of an action. @@ -28,13 +32,13 @@ type ActionIdentifier struct { noSmithyDocumentSerde } -// The value of an attribute. Contains information about the runtime context for a -// request for which an authorization decision is made. This data type is used as a -// member of the ContextDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html) -// structure which is uses as a request parameter for the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html) -// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) -// operations. +// The value of an attribute. +// +// Contains information about the runtime context for a request for which an +// authorization decision is made. +// +// This data type is used as a member of the [ContextDefinition] structure which is uses as a request +// parameter for the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations. // // The following types satisfy this interface: // @@ -44,12 +48,20 @@ type ActionIdentifier struct { // AttributeValueMemberRecord // AttributeValueMemberSet // AttributeValueMemberString +// +// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html +// [ContextDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html type AttributeValue interface { isAttributeValue() } -// An attribute value of Boolean (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#boolean) -// type. Example: {"boolean": true} +// An attribute value of [Boolean] type. +// +// Example: {"boolean": true} +// +// [Boolean]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#boolean type AttributeValueMemberBoolean struct { Value bool @@ -58,9 +70,12 @@ type AttributeValueMemberBoolean struct { func (*AttributeValueMemberBoolean) isAttributeValue() {} -// An attribute value of type EntityIdentifier (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html) -// . Example: "entityIdentifier": { "entityId": "", "entityType": "", "entityType": ""} +// +// [EntityIdentifier]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html type AttributeValueMemberEntityIdentifier struct { Value EntityIdentifier @@ -69,8 +84,11 @@ type AttributeValueMemberEntityIdentifier struct { func (*AttributeValueMemberEntityIdentifier) isAttributeValue() {} -// An attribute value of Long (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#long) -// type. Example: {"long": 0} +// An attribute value of [Long] type. +// +// Example: {"long": 0} +// +// [Long]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#long type AttributeValueMemberLong struct { Value int64 @@ -79,8 +97,11 @@ type AttributeValueMemberLong struct { func (*AttributeValueMemberLong) isAttributeValue() {} -// An attribute value of Record (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record) -// type. Example: {"record": { "keyName": {} } } +// An attribute value of [Record] type. +// +// Example: {"record": { "keyName": {} } } +// +// [Record]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record type AttributeValueMemberRecord struct { Value map[string]AttributeValue @@ -89,8 +110,11 @@ type AttributeValueMemberRecord struct { func (*AttributeValueMemberRecord) isAttributeValue() {} -// An attribute value of Set (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#set) -// type. Example: {"set": [ {} ] } +// An attribute value of [Set] type. +// +// Example: {"set": [ {} ] } +// +// [Set]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#set type AttributeValueMemberSet struct { Value []AttributeValue @@ -99,8 +123,11 @@ type AttributeValueMemberSet struct { func (*AttributeValueMemberSet) isAttributeValue() {} -// An attribute value of String (https://docs.cedarpolicy.com/policies/syntax-datatypes.html#string) -// type. Example: {"string": "abc"} +// An attribute value of [String] type. +// +// Example: {"string": "abc"} +// +// [String]: https://docs.cedarpolicy.com/policies/syntax-datatypes.html#string type AttributeValueMemberString struct { Value string @@ -218,9 +245,12 @@ type BatchIsAuthorizedWithTokenOutputItem struct { } // A list of user groups and entities from an Amazon Cognito user pool identity -// source. This data type is part of a CognitoUserPoolConfiguration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfiguration.html) -// structure and is a request parameter in CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html) -// . +// source. +// +// This data type is part of a [CognitoUserPoolConfiguration] structure and is a request parameter in [CreateIdentitySource]. +// +// [CognitoUserPoolConfiguration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfiguration.html +// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html type CognitoGroupConfiguration struct { // The name of the schema entity type that's mapped to the user pool group. @@ -233,9 +263,12 @@ type CognitoGroupConfiguration struct { } // A list of user groups and entities from an Amazon Cognito user pool identity -// source. This data type is part of an CognitoUserPoolConfigurationDetail (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationItem.html) -// structure and is a response parameter to GetIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html) -// . +// source. +// +// This data type is part of an [CognitoUserPoolConfigurationDetail] structure and is a response parameter to [GetIdentitySource]. +// +// [CognitoUserPoolConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationItem.html +// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html type CognitoGroupConfigurationDetail struct { // The name of the schema entity type that's mapped to the user pool group. @@ -246,9 +279,12 @@ type CognitoGroupConfigurationDetail struct { } // A list of user groups and entities from an Amazon Cognito user pool identity -// source. This data type is part of an CognitoUserPoolConfigurationItem (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationDetail.html) -// structure and is a response parameter to ListIdentitySources (http://forums.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html) -// . +// source. +// +// This data type is part of an [CognitoUserPoolConfigurationItem] structure and is a response parameter to [ListIdentitySources]. +// +// [CognitoUserPoolConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationDetail.html +// [ListIdentitySources]: http://forums.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html type CognitoGroupConfigurationItem struct { // The name of the schema entity type that's mapped to the user pool group. @@ -260,23 +296,33 @@ type CognitoGroupConfigurationItem struct { // The configuration for an identity source that represents a connection to an // Amazon Cognito user pool used as an identity provider for Verified Permissions. -// This data type is used as a field that is part of an Configuration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html) -// structure that is used as a parameter to CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html) -// . Example: +// +// This data type is used as a field that is part of an [Configuration] structure that is used as +// a parameter to [CreateIdentitySource]. +// +// Example: // "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} +// +// [Configuration]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html +// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html type CognitoUserPoolConfiguration struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the Amazon Cognito user pool that contains the identities to be authorized. + // The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be + // authorized. + // // Example: "UserPoolArn": // "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5" // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // // This member is required. UserPoolArn *string // The unique application client IDs that are associated with the specified Amazon - // Cognito user pool. Example: "ClientIds": ["&ExampleCogClientId;"] + // Cognito user pool. + // + // Example: "ClientIds": ["&ExampleCogClientId;"] ClientIds []string // The configuration of the user groups from an Amazon Cognito user pool identity @@ -288,31 +334,43 @@ type CognitoUserPoolConfiguration struct { // The configuration for an identity source that represents a connection to an // Amazon Cognito user pool used as an identity provider for Verified Permissions. -// This data type is used as a field that is part of an ConfigurationDetail (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html) -// structure that is part of the response to GetIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html) -// . Example: +// +// This data type is used as a field that is part of an [ConfigurationDetail] structure that is part of +// the response to [GetIdentitySource]. +// +// Example: // "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} +// +// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html +// [ConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html type CognitoUserPoolConfigurationDetail struct { // The unique application client IDs that are associated with the specified Amazon - // Cognito user pool. Example: "clientIds": ["&ExampleCogClientId;"] + // Cognito user pool. + // + // Example: "clientIds": ["&ExampleCogClientId;"] // // This member is required. ClientIds []string // The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that - // contains the identities to be authorized. Example: "issuer": + // contains the identities to be authorized. + // + // Example: "issuer": // "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5" // // This member is required. Issuer *string - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the Amazon Cognito user pool that contains the identities to be authorized. + // The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be + // authorized. + // // Example: "userPoolArn": // "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5" // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // // This member is required. UserPoolArn *string @@ -325,31 +383,43 @@ type CognitoUserPoolConfigurationDetail struct { // The configuration for an identity source that represents a connection to an // Amazon Cognito user pool used as an identity provider for Verified Permissions. -// This data type is used as a field that is part of the ConfigurationItem (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html) -// structure that is part of the response to ListIdentitySources (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html) -// . Example: +// +// This data type is used as a field that is part of the [ConfigurationItem] structure that is part +// of the response to [ListIdentitySources]. +// +// Example: // "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} +// +// [ConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html +// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html type CognitoUserPoolConfigurationItem struct { // The unique application client IDs that are associated with the specified Amazon - // Cognito user pool. Example: "clientIds": ["&ExampleCogClientId;"] + // Cognito user pool. + // + // Example: "clientIds": ["&ExampleCogClientId;"] // // This member is required. ClientIds []string // The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that - // contains the identities to be authorized. Example: "issuer": + // contains the identities to be authorized. + // + // Example: "issuer": // "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5" // // This member is required. Issuer *string - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the Amazon Cognito user pool that contains the identities to be authorized. + // The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool that contains the identities to be + // authorized. + // // Example: "userPoolArn": // "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5" // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + // // This member is required. UserPoolArn *string @@ -360,26 +430,35 @@ type CognitoUserPoolConfigurationItem struct { noSmithyDocumentSerde } -// Contains configuration information used when creating a new identity source. At -// this time, the only valid member of this structure is a Amazon Cognito user pool -// configuration. You must specify a userPoolArn , and optionally, a ClientId . -// This data type is used as a request parameter for the CreateIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html) -// operation. +// Contains configuration information used when creating a new identity source. +// +// At this time, the only valid member of this structure is a Amazon Cognito user +// pool configuration. +// +// You must specify a userPoolArn , and optionally, a ClientId . +// +// This data type is used as a request parameter for the [CreateIdentitySource] operation. // // The following types satisfy this interface: // // ConfigurationMemberCognitoUserPoolConfiguration +// +// [CreateIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html type Configuration interface { isConfiguration() } // Contains configuration details of a Amazon Cognito user pool that Verified // Permissions can use as a source of authenticated identities as entities. It -// specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) -// of a Amazon Cognito user pool and one or more application client IDs. Example: +// specifies the [Amazon Resource Name (ARN)]of a Amazon Cognito user pool and one or more application client +// IDs. +// +// Example: // "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": // "MyCorp::Group"}}} +// +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html type ConfigurationMemberCognitoUserPoolConfiguration struct { Value CognitoUserPoolConfiguration @@ -388,24 +467,30 @@ type ConfigurationMemberCognitoUserPoolConfiguration struct { func (*ConfigurationMemberCognitoUserPoolConfiguration) isConfiguration() {} -// Contains configuration information about an identity source. This data type is -// a response parameter to the GetIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html) -// operation. +// Contains configuration information about an identity source. +// +// This data type is a response parameter to the [GetIdentitySource] operation. // // The following types satisfy this interface: // // ConfigurationDetailMemberCognitoUserPoolConfiguration +// +// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html type ConfigurationDetail interface { isConfigurationDetail() } // Contains configuration details of a Amazon Cognito user pool that Verified // Permissions can use as a source of authenticated identities as entities. It -// specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) -// of a Amazon Cognito user pool and one or more application client IDs. Example: +// specifies the [Amazon Resource Name (ARN)]of a Amazon Cognito user pool and one or more application client +// IDs. +// +// Example: // "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": // "MyCorp::Group"}}} +// +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html type ConfigurationDetailMemberCognitoUserPoolConfiguration struct { Value CognitoUserPoolConfigurationDetail @@ -414,24 +499,30 @@ type ConfigurationDetailMemberCognitoUserPoolConfiguration struct { func (*ConfigurationDetailMemberCognitoUserPoolConfiguration) isConfigurationDetail() {} -// Contains configuration information about an identity source. This data type is -// a response parameter to the ListIdentitySources (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html) -// operation. +// Contains configuration information about an identity source. +// +// This data type is a response parameter to the [ListIdentitySources] operation. // // The following types satisfy this interface: // // ConfigurationItemMemberCognitoUserPoolConfiguration +// +// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html type ConfigurationItem interface { isConfigurationItem() } // Contains configuration details of a Amazon Cognito user pool that Verified // Permissions can use as a source of authenticated identities as entities. It -// specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) -// of a Amazon Cognito user pool and one or more application client IDs. Example: +// specifies the [Amazon Resource Name (ARN)]of a Amazon Cognito user pool and one or more application client +// IDs. +// +// Example: // "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": // "MyCorp::Group"}}} +// +// [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html type ConfigurationItemMemberCognitoUserPoolConfiguration struct { Value CognitoUserPoolConfigurationItem @@ -442,24 +533,29 @@ func (*ConfigurationItemMemberCognitoUserPoolConfiguration) isConfigurationItem( // Contains additional details about the context of the request. Verified // Permissions evaluates this information in an authorization request as part of -// the when and unless clauses in a policy. This data type is used as a request -// parameter for the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html) -// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) -// operations. Example: +// the when and unless clauses in a policy. +// +// This data type is used as a request parameter for the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations. +// +// Example: // "context":{"contextMap":{"":{"boolean":true},"":{"long":1234}}} // // The following types satisfy this interface: // // ContextDefinitionMemberContextMap +// +// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html type ContextDefinition interface { isContextDefinition() } // An list of attributes that are needed to successfully evaluate an authorization // request. Each attribute in this array must include a map of a data type and its -// value. Example: -// "contextMap":{"":{"boolean":true},"":{"long":1234}} +// value. +// +// Example: "contextMap":{"":{"boolean":true},"":{"long":1234}} type ContextDefinitionMemberContextMap struct { Value map[string]AttributeValue @@ -469,16 +565,21 @@ type ContextDefinitionMemberContextMap struct { func (*ContextDefinitionMemberContextMap) isContextDefinition() {} // Contains information about one of the policies that determined an authorization -// decision. This data type is used as an element in a response parameter for the -// IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html) -// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) -// operations. Example: -// "determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}] +// decision. +// +// This data type is used as an element in a response parameter for the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] +// operations. +// +// Example: "determiningPolicies":[{"policyId":"SPEXAMPLEabcdefg111111"}] +// +// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html type DeterminingPolicyItem struct { - // The Id of a policy that determined to an authorization decision. Example: - // "policyId":"SPEXAMPLEabcdefg111111" + // The Id of a policy that determined to an authorization decision. + // + // Example: "policyId":"SPEXAMPLEabcdefg111111" // // This member is required. PolicyId *string @@ -488,14 +589,17 @@ type DeterminingPolicyItem struct { // Contains the list of entities to be considered during an authorization request. // This includes all principals, resources, and actions required to successfully -// evaluate the request. This data type is used as a field in the response -// parameter for the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) +// evaluate the request. +// +// This data type is used as a field in the response parameter for the [IsAuthorized] and [IsAuthorizedWithToken] // operations. // // The following types satisfy this interface: // // EntitiesDefinitionMemberEntityList +// +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html type EntitiesDefinition interface { isEntitiesDefinition() } @@ -511,20 +615,29 @@ type EntitiesDefinitionMemberEntityList struct { func (*EntitiesDefinitionMemberEntityList) isEntitiesDefinition() {} -// Contains the identifier of an entity, including its ID and type. This data type -// is used as a request parameter for IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// operation, and as a response parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) -// , GetPolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html) -// , and UpdatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html) -// operations. Example: {"entityId":"string","entityType":"string"} +// Contains the identifier of an entity, including its ID and type. +// +// This data type is used as a request parameter for [IsAuthorized] operation, and as a response +// parameter for the [CreatePolicy], [GetPolicy], and [UpdatePolicy] operations. +// +// Example: {"entityId":"string","entityType":"string"} +// +// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html +// [UpdatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html +// [GetPolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html type EntityIdentifier struct { - // The identifier of an entity. "entityId":"identifier" + // The identifier of an entity. + // + // "entityId":"identifier" // // This member is required. EntityId *string - // The type of an entity. Example: "entityType":"typeName" + // The type of an entity. + // + // Example: "entityType":"typeName" // // This member is required. EntityType *string @@ -533,10 +646,14 @@ type EntityIdentifier struct { } // Contains information about an entity that can be referenced in a Cedar policy. -// This data type is used as one of the fields in the EntitiesDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html) -// structure. { "identifier": { "entityType": "Photo", "entityId": -// "VacationPhoto94.jpg" }, "attributes": {}, "parents": [ { "entityType": "Album", -// "entityId": "alice_folder" } ] } +// +// This data type is used as one of the fields in the [EntitiesDefinition] structure. +// +// { "identifier": { "entityType": "Photo", "entityId": "VacationPhoto94.jpg" }, +// "attributes": {}, "parents": [ { "entityType": "Album", "entityId": +// "alice_folder" } ] } +// +// [EntitiesDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html type EntityItem struct { // The identifier of the entity. @@ -554,14 +671,18 @@ type EntityItem struct { } // Contains information about a principal or resource that can be referenced in a -// Cedar policy. This data type is used as part of the PolicyFilter (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html) -// structure that is used as a request parameter for the ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html) -// operation.. +// Cedar policy. +// +// This data type is used as part of the [PolicyFilter] structure that is used as a request +// parameter for the [ListPolicies]operation.. // // The following types satisfy this interface: // // EntityReferenceMemberIdentifier // EntityReferenceMemberUnspecified +// +// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html +// [PolicyFilter]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html type EntityReference interface { isEntityReference() } @@ -587,11 +708,13 @@ type EntityReferenceMemberUnspecified struct { func (*EntityReferenceMemberUnspecified) isEntityReference() {} -// Contains a description of an evaluation error. This data type is a response -// parameter of the IsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) -// , BatchIsAuthorized (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html) -// , and IsAuthorizedWithToken (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) -// operations. +// Contains a description of an evaluation error. +// +// This data type is a response parameter of the [IsAuthorized], [BatchIsAuthorized], and [IsAuthorizedWithToken] operations. +// +// [BatchIsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html +// [IsAuthorizedWithToken]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html +// [IsAuthorized]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html type EvaluationErrorItem struct { // The error description. @@ -602,10 +725,12 @@ type EvaluationErrorItem struct { noSmithyDocumentSerde } -// A structure that contains configuration of the identity source. This data type -// was a response parameter for the GetIdentitySource (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html) -// operation. Replaced by ConfigurationDetail (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html) -// . +// A structure that contains configuration of the identity source. +// +// This data type was a response parameter for the [GetIdentitySource] operation. Replaced by [ConfigurationDetail]. +// +// [GetIdentitySource]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html +// [ConfigurationDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html type IdentitySourceDetails struct { // The application client IDs associated with the specified Amazon Cognito user @@ -619,21 +744,25 @@ type IdentitySourceDetails struct { // This is a URL string in the following format. This URL replaces the placeholders // for both the Amazon Web Services Region and the user pool identifier with those // appropriate for this user pool. - // https://cognito-idp..amazonaws.com//.well-known/openid-configuration + // + // https://cognito-idp..amazonaws.com//.well-known/openid-configuration // // Deprecated: This attribute has been replaced by // configuration.cognitoUserPoolConfiguration.issuer DiscoveryUrl *string // A string that identifies the type of OIDC service represented by this identity - // source. At this time, the only valid value is cognito . + // source. + // + // At this time, the only valid value is cognito . // // Deprecated: This attribute has been replaced by configuration OpenIdIssuer OpenIdIssuer - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the Amazon Cognito user pool whose identities are accessible to this Verified - // Permissions policy store. + // The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool whose identities are accessible to this + // Verified Permissions policy store. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // Deprecated: This attribute has been replaced by // configuration.cognitoUserPoolConfiguration.userPoolArn @@ -643,8 +772,11 @@ type IdentitySourceDetails struct { } // A structure that defines characteristics of an identity source that you can use -// to filter. This data type is a request parameter for the ListIdentityStores (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html) -// operation. +// to filter. +// +// This data type is a request parameter for the [ListIdentityStores] operation. +// +// [ListIdentityStores]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html type IdentitySourceFilter struct { // The Cedar entity type of the principals returned by the identity provider (IdP) @@ -654,9 +786,11 @@ type IdentitySourceFilter struct { noSmithyDocumentSerde } -// A structure that defines an identity source. This data type is a response -// parameter to the ListIdentitySources (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html) -// operation. +// A structure that defines an identity source. +// +// This data type is a response parameter to the [ListIdentitySources] operation. +// +// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html type IdentitySourceItem struct { // The date and time the identity source was originally created. @@ -697,10 +831,12 @@ type IdentitySourceItem struct { noSmithyDocumentSerde } -// A structure that contains configuration of the identity source. This data type -// was a response parameter for the ListIdentitySources (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html) -// operation. Replaced by ConfigurationItem (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html) -// . +// A structure that contains configuration of the identity source. +// +// This data type was a response parameter for the [ListIdentitySources] operation. Replaced by [ConfigurationItem]. +// +// [ConfigurationItem]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html +// [ListIdentitySources]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html type IdentitySourceItemDetails struct { // The application client IDs associated with the specified Amazon Cognito user @@ -714,14 +850,17 @@ type IdentitySourceItemDetails struct { // This is a URL string in the following format. This URL replaces the placeholders // for both the Amazon Web Services Region and the user pool identifier with those // appropriate for this user pool. - // https://cognito-idp..amazonaws.com//.well-known/openid-configuration + // + // https://cognito-idp..amazonaws.com//.well-known/openid-configuration // // Deprecated: This attribute has been replaced by // configuration.cognitoUserPoolConfiguration.issuer DiscoveryUrl *string // A string that identifies the type of OIDC service represented by this identity - // source. At this time, the only valid value is cognito . + // source. + // + // At this time, the only valid value is cognito . // // Deprecated: This attribute has been replaced by configuration OpenIdIssuer OpenIdIssuer @@ -738,15 +877,17 @@ type IdentitySourceItemDetails struct { // A structure that contains the details for a Cedar policy definition. It // includes the policy type, a description, and a policy body. This is a top level -// data type used to create a policy. This data type is used as a request parameter -// for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) -// operation. This structure must always have either an static or a templateLinked -// element. +// data type used to create a policy. +// +// This data type is used as a request parameter for the [CreatePolicy] operation. This +// structure must always have either an static or a templateLinked element. // // The following types satisfy this interface: // // PolicyDefinitionMemberStatic // PolicyDefinitionMemberTemplateLinked +// +// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html type PolicyDefinition interface { isPolicyDefinition() } @@ -762,10 +903,11 @@ type PolicyDefinitionMemberStatic struct { func (*PolicyDefinitionMemberStatic) isPolicyDefinition() {} // A structure that describes a policy that was instantiated from a template. The -// template can specify placeholders for principal and resource . When you use -// CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) -// to create a policy from a template, you specify the exact principal and resource -// to use for the instantiated policy. +// template can specify placeholders for principal and resource . When you use [CreatePolicy] to +// create a policy from a template, you specify the exact principal and resource to +// use for the instantiated policy. +// +// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html type PolicyDefinitionMemberTemplateLinked struct { Value TemplateLinkedPolicyDefinition @@ -775,14 +917,16 @@ type PolicyDefinitionMemberTemplateLinked struct { func (*PolicyDefinitionMemberTemplateLinked) isPolicyDefinition() {} // A structure that describes a policy definition. It must always have either an -// static or a templateLinked element. This data type is used as a response -// parameter for the GetPolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html) -// operation. +// static or a templateLinked element. +// +// This data type is used as a response parameter for the [GetPolicy] operation. // // The following types satisfy this interface: // // PolicyDefinitionDetailMemberStatic // PolicyDefinitionDetailMemberTemplateLinked +// +// [GetPolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html type PolicyDefinitionDetail interface { isPolicyDefinitionDetail() } @@ -806,16 +950,19 @@ type PolicyDefinitionDetailMemberTemplateLinked struct { func (*PolicyDefinitionDetailMemberTemplateLinked) isPolicyDefinitionDetail() {} -// A structure that describes a PolicyDefinintion (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html) -// . It will always have either an StaticPolicy or a TemplateLinkedPolicy element. -// This data type is used as a response parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) -// and ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html) -// operations. +// A structure that describes a [PolicyDefinintion]. It will always have either an StaticPolicy or a +// TemplateLinkedPolicy element. +// +// This data type is used as a response parameter for the [CreatePolicy] and [ListPolicies] operations. // // The following types satisfy this interface: // // PolicyDefinitionItemMemberStatic // PolicyDefinitionItemMemberTemplateLinked +// +// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html +// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html +// [PolicyDefinintion]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html type PolicyDefinitionItem interface { isPolicyDefinitionItem() } @@ -840,8 +987,10 @@ type PolicyDefinitionItemMemberTemplateLinked struct { func (*PolicyDefinitionItemMemberTemplateLinked) isPolicyDefinitionItem() {} // Contains information about a filter to refine policies returned in a query. -// This data type is used as a response parameter for the ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html) -// operation. +// +// This data type is used as a response parameter for the [ListPolicies] operation. +// +// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html type PolicyFilter struct { // Filters the output to only template-linked policies that were instantiated from @@ -860,9 +1009,11 @@ type PolicyFilter struct { noSmithyDocumentSerde } -// Contains information about a policy. This data type is used as a response -// parameter for the ListPolicies (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html) -// operation. +// Contains information about a policy. +// +// This data type is used as a response parameter for the [ListPolicies] operation. +// +// [ListPolicies]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html type PolicyItem struct { // The date and time the policy was created. @@ -892,7 +1043,9 @@ type PolicyItem struct { PolicyStoreId *string // The type of the policy. This is one of the following values: + // // - static + // // - templateLinked // // This member is required. @@ -907,9 +1060,11 @@ type PolicyItem struct { noSmithyDocumentSerde } -// Contains information about a policy store. This data type is used as a response -// parameter for the ListPolicyStores (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html) -// operation. +// Contains information about a policy store. +// +// This data type is used as a response parameter for the [ListPolicyStores] operation. +// +// [ListPolicyStores]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html type PolicyStoreItem struct { // The Amazon Resource Name (ARN) of the policy store. @@ -937,9 +1092,11 @@ type PolicyStoreItem struct { noSmithyDocumentSerde } -// Contains details about a policy template This data type is used as a response -// parameter for the ListPolicyTemplates (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html) -// operation. +// Contains details about a policy template +// +// This data type is used as a response parameter for the [ListPolicyTemplates] operation. +// +// [ListPolicyTemplates]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html type PolicyTemplateItem struct { // The date and time that the policy template was created. @@ -998,8 +1155,10 @@ type SchemaDefinition interface { } // A JSON string representation of the schema supported by applications that use -// this policy store. For more information, see Policy store schema (https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html) -// in the Amazon Verified Permissions User Guide. +// this policy store. For more information, see [Policy store schema]in the Amazon Verified Permissions +// User Guide. +// +// [Policy store schema]: https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html type SchemaDefinitionMemberCedarJson struct { Value string @@ -1008,9 +1167,11 @@ type SchemaDefinitionMemberCedarJson struct { func (*SchemaDefinitionMemberCedarJson) isSchemaDefinition() {} -// Contains information about a static policy. This data type is used as a field -// that is part of the PolicyDefinitionDetail (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html) -// type. +// Contains information about a static policy. +// +// This data type is used as a field that is part of the [PolicyDefinitionDetail] type. +// +// [PolicyDefinitionDetail]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html type StaticPolicyDefinition struct { // The policy content of the static policy, written in the Cedar policy language. @@ -1025,9 +1186,13 @@ type StaticPolicyDefinition struct { } // A structure that contains details about a static policy. It includes the -// description and policy body. This data type is used within a PolicyDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html) -// structure as part of a request parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) -// operation. +// description and policy body. +// +// This data type is used within a [PolicyDefinition] structure as part of a request parameter for +// the [CreatePolicy]operation. +// +// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html +// [PolicyDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html type StaticPolicyDefinitionDetail struct { // The content of the static policy written in the Cedar policy language. @@ -1042,10 +1207,13 @@ type StaticPolicyDefinitionDetail struct { } // A structure that contains details about a static policy. It includes the -// description and policy statement. This data type is used within a -// PolicyDefinition (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html) -// structure as part of a request parameter for the CreatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html) -// operation. +// description and policy statement. +// +// This data type is used within a [PolicyDefinition] structure as part of a request parameter for +// the [CreatePolicy]operation. +// +// [CreatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html +// [PolicyDefinition]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html type StaticPolicyDefinitionItem struct { // A description of the static policy. @@ -1098,6 +1266,7 @@ type TemplateLinkedPolicyDefinitionDetail struct { } // Contains information about a policy created by instantiating a policy template. +// // This type TemplateLinkedPolicyDefinitionItem struct { @@ -1136,8 +1305,9 @@ type UpdateCognitoGroupConfiguration struct { // identity source. type UpdateCognitoUserPoolConfiguration struct { - // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) - // of the Amazon Cognito user pool associated with this identity source. + // The [Amazon Resource Name (ARN)] of the Amazon Cognito user pool associated with this identity source. + // + // [Amazon Resource Name (ARN)]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html // // This member is required. UserPoolArn *string @@ -1154,9 +1324,12 @@ type UpdateCognitoUserPoolConfiguration struct { } // Contains an updated configuration to replace the configuration in an existing -// identity source. At this time, the only valid member of this structure is a -// Amazon Cognito user pool configuration. You must specify a userPoolArn , and -// optionally, a ClientId . +// identity source. +// +// At this time, the only valid member of this structure is a Amazon Cognito user +// pool configuration. +// +// You must specify a userPoolArn , and optionally, a ClientId . // // The following types satisfy this interface: // @@ -1174,13 +1347,15 @@ type UpdateConfigurationMemberCognitoUserPoolConfiguration struct { func (*UpdateConfigurationMemberCognitoUserPoolConfiguration) isUpdateConfiguration() {} -// Contains information about updates to be applied to a policy. This data type is -// used as a request parameter in the UpdatePolicy (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html) -// operation. +// Contains information about updates to be applied to a policy. +// +// This data type is used as a request parameter in the [UpdatePolicy] operation. // // The following types satisfy this interface: // // UpdatePolicyDefinitionMemberStatic +// +// [UpdatePolicy]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html type UpdatePolicyDefinition interface { isUpdatePolicyDefinition() } @@ -1198,14 +1373,22 @@ func (*UpdatePolicyDefinitionMemberStatic) isUpdatePolicyDefinition() {} type UpdateStaticPolicyDefinition struct { // Specifies the Cedar policy language text to be added to or replaced on the - // static policy. You can change only the following elements from the original - // content: + // static policy. + // + // You can change only the following elements from the original content: + // // - The action referenced by the policy. + // // - Any conditional clauses, such as when or unless clauses. + // // You can't change the following elements: + // // - Changing from StaticPolicy to TemplateLinkedPolicy . + // // - The effect ( permit or forbid ) of the policy. + // // - The principal referenced by the policy. + // // - The resource referenced by the policy. // // This member is required. @@ -1237,24 +1420,31 @@ type ValidationExceptionField struct { // A structure that contains Cedar policy validation settings for the policy // store. The validation mode determines which validation failures that Cedar // considers serious enough to block acceptance of a new or edited static policy or -// policy template. This data type is used as a request parameter in the -// CreatePolicyStore (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html) -// and UpdatePolicyStore (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html) -// operations. +// policy template. +// +// This data type is used as a request parameter in the [CreatePolicyStore] and [UpdatePolicyStore] operations. +// +// [UpdatePolicyStore]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html +// [CreatePolicyStore]: https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html type ValidationSettings struct { // The validation mode currently configured for this policy store. The valid // values are: + // // - OFF – Neither Verified Permissions nor Cedar perform any validation on // policies. No validation errors are reported by either service. + // // - STRICT – Requires a schema to be present in the policy store. Cedar // performs validation on all submitted new or updated static policies and policy // templates. Any that fail validation are rejected and Cedar doesn't store them in // the policy store. + // // If Mode=STRICT and the policy store doesn't contain a schema, Verified // Permissions rejects all static policies and policy templates because there is no - // schema to validate against. To submit a static policy or policy template without - // a schema, you must turn off validation. + // schema to validate against. + // + // To submit a static policy or policy template without a schema, you must turn + // off validation. // // This member is required. Mode ValidationMode diff --git a/service/voiceid/api_op_CreateDomain.go b/service/voiceid/api_op_CreateDomain.go index cbcf1214c00..99725ed6a9b 100644 --- a/service/voiceid/api_op_CreateDomain.go +++ b/service/voiceid/api_op_CreateDomain.go @@ -37,18 +37,19 @@ type CreateDomainInput struct { 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) - // for more details on how the KMS key is used. + // for the server-side encryption of your data. Refer to [Amazon Connect Voice ID encryption at rest]for more details on how + // the KMS key is used. + // + // [Amazon Connect Voice ID encryption at rest]: https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid // // This member is required. ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A brief description of this domain. diff --git a/service/voiceid/api_op_CreateWatchlist.go b/service/voiceid/api_op_CreateWatchlist.go index cfe61f2cb33..5d7edd29260 100644 --- a/service/voiceid/api_op_CreateWatchlist.go +++ b/service/voiceid/api_op_CreateWatchlist.go @@ -41,9 +41,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // A brief description of this watchlist. diff --git a/service/voiceid/api_op_ListSpeakers.go b/service/voiceid/api_op_ListSpeakers.go index 3eb703ffeab..f5f46a3733c 100644 --- a/service/voiceid/api_op_ListSpeakers.go +++ b/service/voiceid/api_op_ListSpeakers.go @@ -56,7 +56,8 @@ type ListSpeakersOutput struct { // unchanged. Each pagination token expires after 24 hours. NextToken *string - // A list containing details about each speaker in the Amazon Web Services account. + // A list containing details about each speaker in the Amazon Web Services + // account. SpeakerSummaries []types.SpeakerSummary // Metadata pertaining to the operation's result. diff --git a/service/voiceid/api_op_StartFraudsterRegistrationJob.go b/service/voiceid/api_op_StartFraudsterRegistrationJob.go index 5cc25c951af..5a7bf1e4b53 100644 --- a/service/voiceid/api_op_StartFraudsterRegistrationJob.go +++ b/service/voiceid/api_op_StartFraudsterRegistrationJob.go @@ -31,8 +31,9 @@ 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) - // documentation for the permissions needed in this role. + // output file. Refer to the [Create and edit a fraudster watchlist]documentation for the permissions needed in this role. + // + // [Create and edit a fraudster watchlist]: https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html // // This member is required. DataAccessRoleArn *string @@ -57,9 +58,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // 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 62c0d929934..658dfdaa8f6 100644 --- a/service/voiceid/api_op_StartSpeakerEnrollmentJob.go +++ b/service/voiceid/api_op_StartSpeakerEnrollmentJob.go @@ -31,8 +31,9 @@ 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) - // for the permissions needed in this role. + // output file. Refer to [Batch enrollment using audio data from prior calls]for the permissions needed in this role. + // + // [Batch enrollment using audio data from prior calls]: https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html // // This member is required. DataAccessRoleArn *string @@ -57,9 +58,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The enrollment config that contains details such as the action to take when a diff --git a/service/voiceid/options.go b/service/voiceid/options.go index cb30aaf68fc..8fa4b1a745d 100644 --- a/service/voiceid/options.go +++ b/service/voiceid/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/voiceid/types/enums.go b/service/voiceid/types/enums.go index f9c70beb036..a6abbf9658f 100644 --- a/service/voiceid/types/enums.go +++ b/service/voiceid/types/enums.go @@ -16,8 +16,9 @@ const ( ) // Values returns all known values for AuthenticationDecision. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationDecision) Values() []AuthenticationDecision { return []AuthenticationDecision{ "ACCEPT", @@ -47,8 +48,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -74,8 +76,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -94,6 +97,7 @@ const ( // Values returns all known values for DuplicateRegistrationAction. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DuplicateRegistrationAction) Values() []DuplicateRegistrationAction { return []DuplicateRegistrationAction{ @@ -112,6 +116,7 @@ const ( // 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{ @@ -129,8 +134,9 @@ const ( ) // Values returns all known values for FraudDetectionAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FraudDetectionAction) Values() []FraudDetectionAction { return []FraudDetectionAction{ "IGNORE", @@ -148,8 +154,9 @@ const ( ) // Values returns all known values for FraudDetectionDecision. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FraudDetectionDecision) Values() []FraudDetectionDecision { return []FraudDetectionDecision{ "HIGH_RISK", @@ -167,8 +174,9 @@ const ( ) // Values returns all known values for FraudDetectionReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FraudDetectionReason) Values() []FraudDetectionReason { return []FraudDetectionReason{ "KNOWN_FRAUDSTER", @@ -189,8 +197,9 @@ const ( // Values returns all known values for FraudsterRegistrationJobStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FraudsterRegistrationJobStatus) Values() []FraudsterRegistrationJobStatus { return []FraudsterRegistrationJobStatus{ "SUBMITTED", @@ -215,8 +224,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -240,8 +250,9 @@ const ( // Values returns all known values for ServerSideEncryptionUpdateStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServerSideEncryptionUpdateStatus) Values() []ServerSideEncryptionUpdateStatus { return []ServerSideEncryptionUpdateStatus{ "IN_PROGRESS", @@ -263,6 +274,7 @@ const ( // Values returns all known values for SpeakerEnrollmentJobStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SpeakerEnrollmentJobStatus) Values() []SpeakerEnrollmentJobStatus { return []SpeakerEnrollmentJobStatus{ @@ -285,8 +297,9 @@ const ( ) // Values returns all known values for SpeakerStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SpeakerStatus) Values() []SpeakerStatus { return []SpeakerStatus{ "ENROLLED", @@ -306,8 +319,9 @@ const ( ) // Values returns all known values for StreamingStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StreamingStatus) Values() []StreamingStatus { return []StreamingStatus{ "PENDING_CONFIGURATION", diff --git a/service/voiceid/types/errors.go b/service/voiceid/types/errors.go index 1f66bae05c4..0b1a5d5b0f4 100644 --- a/service/voiceid/types/errors.go +++ b/service/voiceid/types/errors.go @@ -118,8 +118,9 @@ 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) -// and try your request again. +// The request exceeded the service quota. Refer to [Voice ID Service Quotas] and try your request again. +// +// [Voice ID Service Quotas]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas type ServiceQuotaExceededException struct { Message *string @@ -146,8 +147,9 @@ 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) -// and try your request again. +// rate. Refer to [Amazon Connect Voice ID Service API throttling quotas]and try your request again. +// +// [Amazon Connect Voice ID Service API throttling quotas]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas type ThrottlingException struct { Message *string diff --git a/service/voiceid/types/types.go b/service/voiceid/types/types.go index 1d956018331..479f8411bcc 100644 --- a/service/voiceid/types/types.go +++ b/service/voiceid/types/types.go @@ -143,7 +143,7 @@ type DomainSummary struct { // Contains configurations defining enrollment behavior for the batch job. type EnrollmentConfig struct { - // The action to take when the specified speaker is already enrolled in the + // 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 // existing speaker. Setting the value to OVERWRITE replaces the existing voice // prints and enrollment audio stored for that speaker with new data generated from diff --git a/service/vpclattice/api_op_CreateAccessLogSubscription.go b/service/vpclattice/api_op_CreateAccessLogSubscription.go index 4a5236c67d1..6f7ce600ff0 100644 --- a/service/vpclattice/api_op_CreateAccessLogSubscription.go +++ b/service/vpclattice/api_op_CreateAccessLogSubscription.go @@ -15,8 +15,10 @@ 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) -// in the Amazon VPC Lattice User Guide. +// with that network. For more information, see [Access logs]in the Amazon VPC Lattice User +// Guide. +// +// [Access logs]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/monitoring-access-logs.html func (c *Client) CreateAccessLogSubscription(ctx context.Context, params *CreateAccessLogSubscriptionInput, optFns ...func(*Options)) (*CreateAccessLogSubscriptionOutput, error) { if params == nil { params = &CreateAccessLogSubscriptionInput{} diff --git a/service/vpclattice/api_op_CreateListener.go b/service/vpclattice/api_op_CreateListener.go index f66b6bfef35..451c8a2b059 100644 --- a/service/vpclattice/api_op_CreateListener.go +++ b/service/vpclattice/api_op_CreateListener.go @@ -13,9 +13,10 @@ import ( // 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. +// that checks for connection requests to your services. For more information, see [Listeners] +// in the Amazon VPC Lattice User Guide. +// +// [Listeners]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput, optFns ...func(*Options)) (*CreateListenerOutput, error) { if params == nil { params = &CreateListenerInput{} diff --git a/service/vpclattice/api_op_CreateRule.go b/service/vpclattice/api_op_CreateRule.go index 4d67f5fb439..99445972517 100644 --- a/service/vpclattice/api_op_CreateRule.go +++ b/service/vpclattice/api_op_CreateRule.go @@ -14,8 +14,9 @@ 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) -// in the Amazon VPC Lattice User Guide. +// information, see [Listener rules]in the Amazon VPC Lattice User Guide. +// +// [Listener rules]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error) { if params == nil { params = &CreateRuleInput{} diff --git a/service/vpclattice/api_op_CreateService.go b/service/vpclattice/api_op_CreateService.go index 3e7f0ebb2e5..05be5d4768c 100644 --- a/service/vpclattice/api_op_CreateService.go +++ b/service/vpclattice/api_op_CreateService.go @@ -13,8 +13,11 @@ 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] in the Amazon VPC Lattice User Guide. +// +// [Services]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html func (c *Client) CreateService(ctx context.Context, params *CreateServiceInput, optFns ...func(*Options)) (*CreateServiceOutput, error) { if params == nil { params = &CreateServiceInput{} @@ -40,7 +43,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. AuthType types.AuthType diff --git a/service/vpclattice/api_op_CreateServiceNetwork.go b/service/vpclattice/api_op_CreateServiceNetwork.go index b7f983ae868..c9670f1ff4a 100644 --- a/service/vpclattice/api_op_CreateServiceNetwork.go +++ b/service/vpclattice/api_op_CreateServiceNetwork.go @@ -13,8 +13,11 @@ 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] in the Amazon VPC Lattice User Guide. +// +// [Service networks]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html func (c *Client) CreateServiceNetwork(ctx context.Context, params *CreateServiceNetworkInput, optFns ...func(*Options)) (*CreateServiceNetworkOutput, error) { if params == nil { params = &CreateServiceNetworkInput{} @@ -40,7 +43,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. AuthType types.AuthType diff --git a/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go b/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go index de6d048fe84..33c1284b13c 100644 --- a/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go +++ b/service/vpclattice/api_op_CreateServiceNetworkServiceAssociation.go @@ -11,14 +11,18 @@ 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 -// 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 -// caller must own either the service or the service network. As a result of this -// operation, the association is created in the service network account and the -// association owner account. +// 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 caller must own either the service or the service network. +// +// As a result of this operation, the association is created in the service +// network account and the association owner account. func (c *Client) CreateServiceNetworkServiceAssociation(ctx context.Context, params *CreateServiceNetworkServiceAssociationInput, optFns ...func(*Options)) (*CreateServiceNetworkServiceAssociationOutput, error) { if params == nil { params = &CreateServiceNetworkServiceAssociationInput{} diff --git a/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go b/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go index 2534f20f3ce..ad9e1710d9a 100644 --- a/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go +++ b/service/vpclattice/api_op_CreateServiceNetworkVpcAssociation.go @@ -14,14 +14,20 @@ 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) -// 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 -// gets created in the service network account and the VPC owner account. Once a -// security group is added to the VPC association it cannot be removed. You can add -// or update the security groups being used for the VPC association once a security -// group is attached. To remove all security groups you must reassociate the VPC. +// see [Manage 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 gets created in the service +// network account and the VPC owner account. +// +// Once a security group is added to the VPC association it cannot be removed. You +// can add or update the security groups being used for the VPC association once a +// security group is attached. To remove all security groups you must reassociate +// the VPC. +// +// [Manage VPC associations]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-network-associations.html#service-network-vpc-associations func (c *Client) CreateServiceNetworkVpcAssociation(ctx context.Context, params *CreateServiceNetworkVpcAssociationInput, optFns ...func(*Options)) (*CreateServiceNetworkVpcAssociationOutput, error) { if params == nil { params = &CreateServiceNetworkVpcAssociationInput{} @@ -59,8 +65,9 @@ type CreateServiceNetworkVpcAssociationInput struct { // 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. + // For more information, see [Control traffic to resources using security groups]in the Amazon VPC User Guide. + // + // [Control traffic to resources using security groups]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html SecurityGroupIds []string // The tags for the association. diff --git a/service/vpclattice/api_op_CreateTargetGroup.go b/service/vpclattice/api_op_CreateTargetGroup.go index 3da9da689d9..64274bfe90d 100644 --- a/service/vpclattice/api_op_CreateTargetGroup.go +++ b/service/vpclattice/api_op_CreateTargetGroup.go @@ -13,8 +13,11 @@ 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] in the Amazon VPC Lattice User Guide. +// +// [Target groups]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html func (c *Client) CreateTargetGroup(ctx context.Context, params *CreateTargetGroupInput, optFns ...func(*Options)) (*CreateTargetGroupOutput, error) { if params == nil { params = &CreateTargetGroupInput{} diff --git a/service/vpclattice/api_op_DeleteRule.go b/service/vpclattice/api_op_DeleteRule.go index da80750ff30..9512f38d729 100644 --- a/service/vpclattice/api_op_DeleteRule.go +++ b/service/vpclattice/api_op_DeleteRule.go @@ -13,9 +13,11 @@ import ( // Deletes 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. 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) -// in the Amazon VPC Lattice User Guide. +// additional listener rules, but you cannot delete the default rule. +// +// For more information, see [Listener rules] in the Amazon VPC Lattice User Guide. +// +// [Listener rules]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} diff --git a/service/vpclattice/api_op_DeleteService.go b/service/vpclattice/api_op_DeleteService.go index 7a50c1a82c2..563fb5f1b89 100644 --- a/service/vpclattice/api_op_DeleteService.go +++ b/service/vpclattice/api_op_DeleteService.go @@ -14,8 +14,10 @@ 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) -// in the Amazon VPC Lattice User Guide. +// subscriptions, are also deleted. For more information, see [Delete a service]in the Amazon VPC +// Lattice User Guide. +// +// [Delete a service]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html#delete-service func (c *Client) DeleteService(ctx context.Context, params *DeleteServiceInput, optFns ...func(*Options)) (*DeleteServiceOutput, error) { if params == nil { params = &DeleteServiceInput{} diff --git a/service/vpclattice/api_op_DeleteServiceNetwork.go b/service/vpclattice/api_op_DeleteServiceNetwork.go index 7df55f6fc05..7293bf404e5 100644 --- a/service/vpclattice/api_op_DeleteServiceNetwork.go +++ b/service/vpclattice/api_op_DeleteServiceNetwork.go @@ -14,8 +14,9 @@ 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) -// in the Amazon VPC Lattice User Guide. +// see [Delete a service network]in the Amazon VPC Lattice User Guide. +// +// [Delete a service network]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#delete-service-network func (c *Client) DeleteServiceNetwork(ctx context.Context, params *DeleteServiceNetworkInput, optFns ...func(*Options)) (*DeleteServiceNetworkOutput, error) { if params == nil { params = &DeleteServiceNetworkInput{} diff --git a/service/vpclattice/api_op_GetAuthPolicy.go b/service/vpclattice/api_op_GetAuthPolicy.go index bc3f97176b1..9136dea6056 100644 --- a/service/vpclattice/api_op_GetAuthPolicy.go +++ b/service/vpclattice/api_op_GetAuthPolicy.go @@ -56,8 +56,9 @@ type GetAuthPolicyOutput struct { // is set to Amazon Web Services_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) - // in the Amazon VPC Lattice User Guide. + // inactive. For more information, see [Create a service network]in the Amazon VPC Lattice User Guide. + // + // [Create a service network]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network State types.AuthPolicyState // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/api_op_GetRule.go b/service/vpclattice/api_op_GetRule.go index 2fc1b2c4a99..750824e0e73 100644 --- a/service/vpclattice/api_op_GetRule.go +++ b/service/vpclattice/api_op_GetRule.go @@ -13,8 +13,10 @@ 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) -// in the Amazon VPC Lattice User Guide. +// about the default listener rule. For more information, see [Listener rules]in the Amazon VPC +// Lattice User Guide. +// +// [Listener rules]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/listeners.html#listener-rules func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...func(*Options)) (*GetRuleOutput, error) { if params == nil { params = &GetRuleInput{} diff --git a/service/vpclattice/api_op_ListServiceNetworkServiceAssociations.go b/service/vpclattice/api_op_ListServiceNetworkServiceAssociations.go index c6a2a62080f..0d29261b9ba 100644 --- a/service/vpclattice/api_op_ListServiceNetworkServiceAssociations.go +++ b/service/vpclattice/api_op_ListServiceNetworkServiceAssociations.go @@ -13,12 +13,13 @@ import ( // Lists the associations between the service network and the service. You can // filter the list either by service or service network. You must provide either -// the service network identifier or the service identifier. Every association in -// Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a -// service network is associated with a VPC or when a service is associated with a -// service network. If the association is for a resource that is shared with -// another account, the association will include the local account ID as the prefix -// in the ARN for each account the resource is shared with. +// the service network identifier or the service identifier. +// +// Every association in Amazon VPC Lattice is given a unique Amazon Resource Name +// (ARN), such as when a service network is associated with a VPC or when a service +// is associated with a service network. If the association is for a resource that +// is shared with another account, the association will include the local account +// ID as the prefix in the ARN for each account the resource is shared with. func (c *Client) ListServiceNetworkServiceAssociations(ctx context.Context, params *ListServiceNetworkServiceAssociationsInput, optFns ...func(*Options)) (*ListServiceNetworkServiceAssociationsOutput, error) { if params == nil { params = &ListServiceNetworkServiceAssociationsInput{} diff --git a/service/vpclattice/api_op_PutAuthPolicy.go b/service/vpclattice/api_op_PutAuthPolicy.go index 744f829d1b5..0be03b1d0cc 100644 --- a/service/vpclattice/api_op_PutAuthPolicy.go +++ b/service/vpclattice/api_op_PutAuthPolicy.go @@ -52,8 +52,9 @@ type PutAuthPolicyOutput struct { // is set to Amazon Web Services_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) - // in the Amazon VPC Lattice User Guide. + // inactive. For more information, see [Create a service network]in the Amazon VPC Lattice User Guide. + // + // [Create a service network]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network State types.AuthPolicyState // Metadata pertaining to the operation's result. diff --git a/service/vpclattice/api_op_UpdateService.go b/service/vpclattice/api_op_UpdateService.go index d047f1c26f5..225c474885d 100644 --- a/service/vpclattice/api_op_UpdateService.go +++ b/service/vpclattice/api_op_UpdateService.go @@ -35,7 +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. AuthType types.AuthType diff --git a/service/vpclattice/api_op_UpdateServiceNetwork.go b/service/vpclattice/api_op_UpdateServiceNetwork.go index 5c27299bed0..3759677b36e 100644 --- a/service/vpclattice/api_op_UpdateServiceNetwork.go +++ b/service/vpclattice/api_op_UpdateServiceNetwork.go @@ -30,7 +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. // diff --git a/service/vpclattice/doc.go b/service/vpclattice/doc.go index 45d8ef681d0..ea051d62c00 100644 --- a/service/vpclattice/doc.go +++ b/service/vpclattice/doc.go @@ -7,6 +7,7 @@ // use to connect, secure, and monitor all of your services across multiple // 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/) +// can discover and manage them more efficiently. For more information, see the [Amazon VPC Lattice User Guide] +// +// [Amazon VPC Lattice User Guide]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/ package vpclattice diff --git a/service/vpclattice/options.go b/service/vpclattice/options.go index 791d3a84876..d630f02d562 100644 --- a/service/vpclattice/options.go +++ b/service/vpclattice/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/vpclattice/types/enums.go b/service/vpclattice/types/enums.go index b0b63243336..3bc61c5cd18 100644 --- a/service/vpclattice/types/enums.go +++ b/service/vpclattice/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AuthPolicyState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthPolicyState) Values() []AuthPolicyState { return []AuthPolicyState{ "Active", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for AuthType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthType) Values() []AuthType { return []AuthType{ "NONE", @@ -50,6 +52,7 @@ const ( // Values returns all known values for HealthCheckProtocolVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (HealthCheckProtocolVersion) Values() []HealthCheckProtocolVersion { return []HealthCheckProtocolVersion{ @@ -69,8 +72,9 @@ const ( ) // Values returns all known values for IpAddressType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IpAddressType) Values() []IpAddressType { return []IpAddressType{ "IPV4", @@ -90,6 +94,7 @@ const ( // Values returns all known values for LambdaEventStructureVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (LambdaEventStructureVersion) Values() []LambdaEventStructureVersion { return []LambdaEventStructureVersion{ @@ -109,8 +114,9 @@ const ( ) // Values returns all known values for ListenerProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ListenerProtocol) Values() []ListenerProtocol { return []ListenerProtocol{ "HTTP", @@ -136,8 +142,9 @@ const ( // 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. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNetworkServiceAssociationStatus) Values() []ServiceNetworkServiceAssociationStatus { return []ServiceNetworkServiceAssociationStatus{ "CREATE_IN_PROGRESS", @@ -170,8 +177,9 @@ const ( // Values returns all known values for ServiceNetworkVpcAssociationStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceNetworkVpcAssociationStatus) Values() []ServiceNetworkVpcAssociationStatus { return []ServiceNetworkVpcAssociationStatus{ "CREATE_IN_PROGRESS", @@ -201,8 +209,9 @@ const ( ) // Values returns all known values for ServiceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ServiceStatus) Values() []ServiceStatus { return []ServiceStatus{ "ACTIVE", @@ -224,8 +233,9 @@ const ( ) // Values returns all known values for TargetGroupProtocol. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetGroupProtocol) Values() []TargetGroupProtocol { return []TargetGroupProtocol{ "HTTP", @@ -247,6 +257,7 @@ const ( // Values returns all known values for TargetGroupProtocolVersion. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (TargetGroupProtocolVersion) Values() []TargetGroupProtocolVersion { return []TargetGroupProtocolVersion{ @@ -273,8 +284,9 @@ const ( ) // Values returns all known values for TargetGroupStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetGroupStatus) Values() []TargetGroupStatus { return []TargetGroupStatus{ "CREATE_IN_PROGRESS", @@ -300,8 +312,9 @@ const ( ) // Values returns all known values for TargetGroupType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetGroupType) Values() []TargetGroupType { return []TargetGroupType{ "IP", @@ -330,8 +343,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -355,6 +369,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/vpclattice/types/types.go b/service/vpclattice/types/types.go index d9b690c00fa..5785b30fa8a 100644 --- a/service/vpclattice/types/types.go +++ b/service/vpclattice/types/types.go @@ -82,9 +82,11 @@ type ForwardAction struct { // prioritization and selection of each target group. This means that requests are // distributed to individual target groups based on their weights. For example, if // two target groups have the same weight, each target group receives half of the - // traffic. The default value is 1. This means that if only one target group is - // provided, there is no need to set the weight; 100% of traffic will go to that - // target group. + // traffic. + // + // The default value is 1. This means that if only one target group is provided, + // there is no need to set the weight; 100% of traffic will go to that target + // group. // // This member is required. TargetGroups []WeightedTargetGroup @@ -379,7 +381,7 @@ type RuleSummary struct { // The name of the rule. Name *string - // The priority of the rule. + // The priority of the rule. Priority *int32 noSmithyDocumentSerde @@ -461,7 +463,7 @@ type ServiceNetworkServiceAssociationSummary struct { // The account that created the association. CreatedBy *string - // The custom domain name of the service. + // The custom domain name of the service. CustomDomainName *string // DNS information about the service. @@ -570,7 +572,7 @@ type ServiceSummary struct { // The date and time that the service was created, specified in ISO-8601 format. CreatedAt *time.Time - // The custom domain name of the service. + // The custom domain name of the service. CustomDomainName *string // DNS information about the service. @@ -728,13 +730,19 @@ 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. Status TargetStatus diff --git a/service/waf/api_op_CreateByteMatchSet.go b/service/waf/api_op_CreateByteMatchSet.go index 7a44fef8f5f..9e87e080705 100644 --- a/service/waf/api_op_CreateByteMatchSet.go +++ b/service/waf/api_op_CreateByteMatchSet.go @@ -11,28 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// +// - Submit an UpdateByteMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -50,13 +60,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 @@ -71,7 +81,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 1b22f94c0f6..3162bf3fde4 100644 --- a/service/waf/api_op_CreateGeoMatchSet.go +++ b/service/waf/api_op_CreateGeoMatchSet.go @@ -11,27 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateGeoMatchSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -49,13 +59,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 @@ -67,11 +77,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 . + // The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet 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 e6fd0c3923a..72265e8d4e9 100644 --- a/service/waf/api_op_CreateIPSet.go +++ b/service/waf/api_op_CreateIPSet.go @@ -11,28 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// ChangeToken parameter of an UpdateIPSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -50,13 +60,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 @@ -67,8 +77,7 @@ type CreateIPSetInput struct { 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 . + // use this value to query the status of the request. For more information, see 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 2e906507595..71fd26b08c3 100644 --- a/service/waf/api_op_CreateRateBasedRule.go +++ b/service/waf/api_op_CreateRateBasedRule.go @@ -11,56 +11,76 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 : +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 : +// // - An IPSet that matches the IP address 192.0.2.44/32 +// // - 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 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 : +// 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: +// 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. +// more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateRulerequest. +// // - 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 . +// 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -80,7 +100,7 @@ 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 . + // information, see GetChangeTokenStatus. // // This member is required. ChangeToken *string @@ -94,8 +114,8 @@ type CreateRateBasedRuleInput struct { // This member is required. MetricName *string - // A friendly name or description of the RateBasedRule . You can't change the name - // of a RateBasedRule after you create it. + // 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. Name *string @@ -126,7 +146,7 @@ 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 . + // 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 ce6e4cac69f..bb0549e885d 100644 --- a/service/waf/api_op_CreateRegexMatchSet.go +++ b/service/waf/api_op_CreateRegexMatchSet.go @@ -11,29 +11,39 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: -// - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateRegexMatchSet request. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: +// +// - Use GetChangeTokento 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. +// +// - Submit an UpdateRegexMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -51,13 +61,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 @@ -69,7 +79,7 @@ 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 . + // 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 16be8b447d8..f278ebb1f56 100644 --- a/service/waf/api_op_CreateRegexPatternSet.go +++ b/service/waf/api_op_CreateRegexPatternSet.go @@ -11,26 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// +// - Submit an UpdateRegexPatternSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -48,13 +56,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 @@ -66,7 +74,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 4b192a02e80..001fbb0d556 100644 --- a/service/waf/api_op_CreateRule.go +++ b/service/waf/api_op_CreateRule.go @@ -11,38 +11,52 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 // specifications to be allowed or blocked. For example, suppose that you add the // 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 // // 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: +// 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. +// more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateRulerequest. +// // - 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 . +// 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -60,7 +74,7 @@ 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 @@ -74,7 +88,7 @@ type CreateRuleInput struct { // 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. @@ -89,8 +103,7 @@ 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 . + // 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 28c1aa38261..1f55676256a 100644 --- a/service/waf/api_op_CreateRuleGroup.go +++ b/service/waf/api_op_CreateRuleGroup.go @@ -11,21 +11,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 UpdateRuleGroupto 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. // // 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -43,7 +52,7 @@ 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 @@ -57,8 +66,8 @@ type CreateRuleGroupInput struct { // 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 @@ -73,10 +82,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 b7469540054..2d8f7c353a2 100644 --- a/service/waf/api_op_CreateSizeConstraintSet.go +++ b/service/waf/api_op_CreateSizeConstraintSet.go @@ -11,29 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// +// - Submit an UpdateSizeConstraintSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -51,13 +60,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 @@ -69,7 +78,7 @@ 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 . + // 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 ea96236ca53..7a28c848ea2 100644 --- a/service/waf/api_op_CreateSqlInjectionMatchSet.go +++ b/service/waf/api_op_CreateSqlInjectionMatchSet.go @@ -11,26 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// following steps: -// - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateSqlInjectionMatchSet request. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 following steps: +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateSqlInjectionMatchSetrequest. +// +// - Submit an UpdateSqlInjectionMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -46,16 +55,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 . + // A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change + // Name after you create the SqlInjectionMatchSet . // // This member is required. Name *string @@ -68,10 +77,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 6c3aff6cad7..e008d389a69 100644 --- a/service/waf/api_op_CreateWebACL.go +++ b/service/waf/api_op_CreateWebACL.go @@ -11,33 +11,45 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: +// // - 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 . +// 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. +// more information, see CreateRuleand UpdateRule. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateWebACLrequest. +// +// - Submit an UpdateWebACLrequest 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]. // -// 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/) . +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -55,7 +67,7 @@ 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 @@ -76,8 +88,8 @@ type CreateWebACLInput struct { // 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 @@ -91,8 +103,7 @@ type CreateWebACLInput struct { 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 . + // use this value to query the status of the request. For more information, see 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 19193566740..3ebb8580c0a 100644 --- a/service/waf/api_op_CreateWebACLMigrationStack.go +++ b/service/waf/api_op_CreateWebACLMigrationStack.go @@ -13,13 +13,15 @@ import ( // Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the // specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the // template, to create the web ACL and its resources in AWS WAFV2. Use this to -// migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. This is -// 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) -// . +// migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. +// +// This is 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] +// in the [AWS WAF Developer Guide]. +// +// [Migrating your AWS WAF Classic resources to AWS WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html +// [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{} @@ -47,11 +49,14 @@ type CreateWebACLMigrationStackInput struct { // 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. // diff --git a/service/waf/api_op_CreateXssMatchSet.go b/service/waf/api_op_CreateXssMatchSet.go index 3e50a0210e4..87a5bda7afe 100644 --- a/service/waf/api_op_CreateXssMatchSet.go +++ b/service/waf/api_op_CreateXssMatchSet.go @@ -11,26 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: -// - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateXssMatchSet request. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateXssMatchSetrequest. +// +// - Submit an UpdateXssMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -46,16 +55,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 . + // A friendly name or description for the XssMatchSet that you're creating. You can't change + // Name after you create the XssMatchSet . // // This member is required. Name *string @@ -68,10 +77,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 aab2d43a228..2659da8a563 100644 --- a/service/waf/api_op_DeleteByteMatchSet.go +++ b/service/waf/api_op_DeleteByteMatchSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteByteMatchSet request. +// // - Submit a DeleteByteMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteByteMatchSet(ctx context.Context, params *DeleteByteMatchSetInput, optFns ...func(*Options)) (*DeleteByteMatchSetOutput, error) { if params == nil { params = &DeleteByteMatchSetInput{} @@ -41,13 +51,13 @@ 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 . + // The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned + // by CreateByteMatchSetand 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 @@ -59,7 +69,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 a3c2e00b289..ba557b7e048 100644 --- a/service/waf/api_op_DeleteGeoMatchSet.go +++ b/service/waf/api_op_DeleteGeoMatchSet.go @@ -10,20 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteGeoMatchSet request. +// // - Submit a DeleteGeoMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteGeoMatchSet(ctx context.Context, params *DeleteGeoMatchSetInput, optFns ...func(*Options)) (*DeleteGeoMatchSetOutput, error) { if params == nil { params = &DeleteGeoMatchSetInput{} @@ -41,13 +50,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 . + // The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet + // and by ListGeoMatchSets. // // This member is required. GeoMatchSetId *string @@ -59,7 +68,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 fcc37495f07..20ad246e35a 100644 --- a/service/waf/api_op_DeleteIPSet.go +++ b/service/waf/api_op_DeleteIPSet.go @@ -10,19 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// see UpdateIPSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteIPSet request. +// // - Submit a DeleteIPSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error) { if params == nil { params = &DeleteIPSetInput{} @@ -40,13 +51,12 @@ 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 . + // The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets. // // This member is required. IPSetId *string @@ -57,8 +67,7 @@ type DeleteIPSetInput struct { 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 . + // 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_DeleteLoggingConfiguration.go b/service/waf/api_op_DeleteLoggingConfiguration.go index 498222b8b3c..d42fef80f4e 100644 --- a/service/waf/api_op_DeleteLoggingConfiguration.go +++ b/service/waf/api_op_DeleteLoggingConfiguration.go @@ -10,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error) { if params == nil { params = &DeleteLoggingConfigurationInput{} @@ -33,8 +38,8 @@ 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 . + // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration + // . // // This member is required. ResourceArn *string diff --git a/service/waf/api_op_DeletePermissionPolicy.go b/service/waf/api_op_DeletePermissionPolicy.go index 4fb6f6c62e2..34fdbd9b5e6 100644 --- a/service/waf/api_op_DeletePermissionPolicy.go +++ b/service/waf/api_op_DeletePermissionPolicy.go @@ -10,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error) { if params == nil { params = &DeletePermissionPolicyInput{} @@ -34,7 +41,9 @@ func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermi type DeletePermissionPolicyInput struct { // The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete - // the policy. The user making the request must be the owner of the RuleGroup. + // the policy. + // + // The user making the request must be the owner of the RuleGroup. // // This member is required. ResourceArn *string diff --git a/service/waf/api_op_DeleteRateBasedRule.go b/service/waf/api_op_DeleteRateBasedRule.go index 36a694ca99d..794dad7b1c6 100644 --- a/service/waf/api_op_DeleteRateBasedRule.go +++ b/service/waf/api_op_DeleteRateBasedRule.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// see UpdateRateBasedRule. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRateBasedRule request. +// // - Submit a DeleteRateBasedRule request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBasedRuleInput, optFns ...func(*Options)) (*DeleteRateBasedRuleOutput, error) { if params == nil { params = &DeleteRateBasedRuleInput{} @@ -41,13 +51,12 @@ 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 . + // The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. // // This member is required. RuleId *string @@ -59,7 +68,7 @@ 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 . + // 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 135ea205c30..ee31b4659d9 100644 --- a/service/waf/api_op_DeleteRegexMatchSet.go +++ b/service/waf/api_op_DeleteRegexMatchSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// see UpdateRegexMatchSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRegexMatchSet request. +// // - Submit a DeleteRegexMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMatchSetInput, optFns ...func(*Options)) (*DeleteRegexMatchSetOutput, error) { if params == nil { params = &DeleteRegexMatchSetInput{} @@ -41,13 +51,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 . + // The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is + // returned by CreateRegexMatchSetand by ListRegexMatchSets. // // This member is required. RegexMatchSetId *string @@ -59,7 +69,7 @@ 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 . + // 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 6a574dd49e6..a71157b898c 100644 --- a/service/waf/api_op_DeleteRegexPatternSet.go +++ b/service/waf/api_op_DeleteRegexPatternSet.go @@ -10,13 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error) { if params == nil { params = &DeleteRegexPatternSetInput{} @@ -34,14 +39,13 @@ 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 . + // The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is + // returned by CreateRegexPatternSetand by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -53,7 +57,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 a469d5e320a..eff35f8e2fa 100644 --- a/service/waf/api_op_DeleteRule.go +++ b/service/waf/api_op_DeleteRule.go @@ -10,20 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRule request. +// // - Submit a DeleteRule request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} @@ -41,13 +50,12 @@ 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 . + // The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules. // // This member is required. RuleId *string @@ -58,8 +66,7 @@ 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 . + // 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 e8b3bcb15a8..fa1df3ccfb0 100644 --- a/service/waf/api_op_DeleteRuleGroup.go +++ b/service/waf/api_op_DeleteRuleGroup.go @@ -10,19 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRuleGroup request. +// // - Submit a DeleteRuleGroup request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error) { if params == nil { params = &DeleteRuleGroupInput{} @@ -40,13 +50,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 . + // The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup + // and by ListRuleGroups. // // This member is required. RuleGroupId *string @@ -58,7 +68,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 7efaf088ed2..fbe524aff51 100644 --- a/service/waf/api_op_DeleteSizeConstraintSet.go +++ b/service/waf/api_op_DeleteSizeConstraintSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// information, see UpdateSizeConstraintSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteSizeConstraintSet request. +// // - Submit a DeleteSizeConstraintSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSizeConstraintSetInput, optFns ...func(*Options)) (*DeleteSizeConstraintSetOutput, error) { if params == nil { params = &DeleteSizeConstraintSetInput{} @@ -41,14 +51,13 @@ 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 . + // The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is + // returned by CreateSizeConstraintSetand by ListSizeConstraintSets. // // This member is required. SizeConstraintSetId *string @@ -60,7 +69,7 @@ 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 . + // 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 916eaf54557..dccca8fa0e0 100644 --- a/service/waf/api_op_DeleteSqlInjectionMatchSet.go +++ b/service/waf/api_op_DeleteSqlInjectionMatchSet.go @@ -10,20 +10,31 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// information, see UpdateSqlInjectionMatchSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteSqlInjectionMatchSet request. +// // - Submit a DeleteSqlInjectionMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteSqlInjectionMatchSetInput, optFns ...func(*Options)) (*DeleteSqlInjectionMatchSetOutput, error) { if params == nil { params = &DeleteSqlInjectionMatchSetInput{} @@ -42,14 +53,13 @@ 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 . + // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. // // This member is required. SqlInjectionMatchSetId *string @@ -62,7 +72,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 49991d211ed..905975e0f62 100644 --- a/service/waf/api_op_DeleteWebACL.go +++ b/service/waf/api_op_DeleteWebACL.go @@ -10,17 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteWebACL request. +// // - Submit a DeleteWebACL request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error) { if params == nil { params = &DeleteWebACLInput{} @@ -38,13 +48,12 @@ 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 . + // The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs. // // This member is required. WebACLId *string @@ -55,8 +64,7 @@ type DeleteWebACLInput struct { 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 . + // 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_DeleteXssMatchSet.go b/service/waf/api_op_DeleteXssMatchSet.go index 425a972c7b2..dd18eebe75f 100644 --- a/service/waf/api_op_DeleteXssMatchSet.go +++ b/service/waf/api_op_DeleteXssMatchSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteXssMatchSet request. +// // - Submit a DeleteXssMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteXssMatchSet(ctx context.Context, params *DeleteXssMatchSetInput, optFns ...func(*Options)) (*DeleteXssMatchSetOutput, error) { if params == nil { params = &DeleteXssMatchSetInput{} @@ -42,13 +52,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 . + // The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet + // and by ListXssMatchSets. // // This member is required. XssMatchSetId *string @@ -61,7 +71,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 df334aa244f..2bb494af51a 100644 --- a/service/waf/api_op_GetByteMatchSet.go +++ b/service/waf/api_op_GetByteMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the ByteMatchSet specified by ByteMatchSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetByteMatchSet(ctx context.Context, params *GetByteMatchSetInput, optFns ...func(*Options)) (*GetByteMatchSetOutput, error) { if params == nil { params = &GetByteMatchSetInput{} @@ -33,8 +39,8 @@ 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 . + // The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet + // and by ListByteMatchSets. // // This member is required. ByteMatchSetId *string @@ -44,13 +50,17 @@ type GetByteMatchSetInput struct { 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 + // 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 ByteMatchTupleobjects. 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 74a2a3174bd..6ae5f327e8d 100644 --- a/service/waf/api_op_GetChangeToken.go +++ b/service/waf/api_op_GetChangeToken.go @@ -10,21 +10,31 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// indicates that AWS WAF is propagating the change to all AWS WAF servers. Use -// GetChangeTokenStatus to determine the status of your change token. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 indicates that AWS WAF is +// propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to +// determine the status of your change token. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetChangeToken(ctx context.Context, params *GetChangeTokenInput, optFns ...func(*Options)) (*GetChangeTokenOutput, error) { if params == nil { params = &GetChangeTokenInput{} diff --git a/service/waf/api_op_GetChangeTokenStatus.go b/service/waf/api_op_GetChangeTokenStatus.go index 56a475af6dc..586d73a6f2d 100644 --- a/service/waf/api_op_GetChangeTokenStatus.go +++ b/service/waf/api_op_GetChangeTokenStatus.go @@ -11,18 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 6325593159d..33ff00339e7 100644 --- a/service/waf/api_op_GetGeoMatchSet.go +++ b/service/waf/api_op_GetGeoMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetGeoMatchSet(ctx context.Context, params *GetGeoMatchSetInput, optFns ...func(*Options)) (*GetGeoMatchSetOutput, error) { if params == nil { params = &GetGeoMatchSetInput{} @@ -33,8 +39,8 @@ 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 . + // The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet + // and by ListGeoMatchSets. // // This member is required. GeoMatchSetId *string @@ -44,9 +50,9 @@ 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. + // 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. 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 8d04fb59c7e..19e821b5d19 100644 --- a/service/waf/api_op_GetIPSet.go +++ b/service/waf/api_op_GetIPSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error) { if params == nil { params = &GetIPSetInput{} @@ -33,8 +39,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 . + // The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets. // // This member is required. IPSetId *string @@ -44,11 +49,14 @@ 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 IPSetDescriptorobjects. 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 0333e35984e..8f5fbb75e9f 100644 --- a/service/waf/api_op_GetLoggingConfiguration.go +++ b/service/waf/api_op_GetLoggingConfiguration.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLoggingConfigurationInput, optFns ...func(*Options)) (*GetLoggingConfigurationOutput, error) { if params == nil { params = &GetLoggingConfigurationInput{} @@ -33,8 +39,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 . + // The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. // // This member is required. ResourceArn *string diff --git a/service/waf/api_op_GetPermissionPolicy.go b/service/waf/api_op_GetPermissionPolicy.go index 848d47a279b..2e242e0fa66 100644 --- a/service/waf/api_op_GetPermissionPolicy.go +++ b/service/waf/api_op_GetPermissionPolicy.go @@ -10,11 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 17af77f1dff..215db7586d5 100644 --- a/service/waf/api_op_GetRateBasedRule.go +++ b/service/waf/api_op_GetRateBasedRule.go @@ -11,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRateBasedRule(ctx context.Context, params *GetRateBasedRuleInput, optFns ...func(*Options)) (*GetRateBasedRuleOutput, error) { if params == nil { params = &GetRateBasedRuleInput{} @@ -34,8 +40,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 . + // The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. // // This member is required. RuleId *string @@ -45,8 +50,7 @@ type GetRateBasedRuleInput struct { type GetRateBasedRuleOutput struct { - // Information about the RateBasedRule that you specified in the GetRateBasedRule - // request. + // Information about the RateBasedRule that you specified in the GetRateBasedRule request. Rule *types.RateBasedRule // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetRateBasedRuleManagedKeys.go b/service/waf/api_op_GetRateBasedRuleManagedKeys.go index 34fb848d211..56cf4616713 100644 --- a/service/waf/api_op_GetRateBasedRuleManagedKeys.go +++ b/service/waf/api_op_GetRateBasedRuleManagedKeys.go @@ -10,14 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRateBasedRuleManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedRuleManagedKeysOutput, error) { if params == nil { params = &GetRateBasedRuleManagedKeysInput{} @@ -35,8 +41,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 CreateRateBasedRuleand by ListRateBasedRules. // // This member is required. RuleId *string @@ -49,8 +55,7 @@ type GetRateBasedRuleManagedKeysInput struct { type GetRateBasedRuleManagedKeysOutput struct { - // An array of IP addresses that currently are blocked by the specified - // RateBasedRule . + // An array of IP addresses that currently are blocked by the specified 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 909390260b7..8d8a35b8674 100644 --- a/service/waf/api_op_GetRegexMatchSet.go +++ b/service/waf/api_op_GetRegexMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the RegexMatchSet specified by RegexMatchSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRegexMatchSet(ctx context.Context, params *GetRegexMatchSetInput, optFns ...func(*Options)) (*GetRegexMatchSetOutput, error) { if params == nil { params = &GetRegexMatchSetInput{} @@ -33,8 +39,8 @@ 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 . + // The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned + // by CreateRegexMatchSetand by ListRegexMatchSets. // // This member is required. RegexMatchSetId *string @@ -44,8 +50,8 @@ type GetRegexMatchSetInput struct { type GetRegexMatchSetOutput struct { - // Information about the RegexMatchSet that you specified in the GetRegexMatchSet - // request. For more information, see RegexMatchTuple . + // Information about the RegexMatchSet that you specified in the GetRegexMatchSet 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 d95dfea2ca1..f18db1d1a63 100644 --- a/service/waf/api_op_GetRegexPatternSet.go +++ b/service/waf/api_op_GetRegexPatternSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the RegexPatternSet specified by RegexPatternSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error) { if params == nil { params = &GetRegexPatternSetInput{} @@ -33,9 +39,8 @@ func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPattern type GetRegexPatternSetInput struct { - // The RegexPatternSetId of the RegexPatternSet that you want to get. - // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets . + // The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is + // returned by CreateRegexPatternSetand by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -45,9 +50,9 @@ type GetRegexPatternSetInput struct { type GetRegexPatternSetOutput struct { - // Information about the RegexPatternSet that you specified in the - // GetRegexPatternSet request, including the identifier of the pattern set and the - // regular expression patterns you want AWS WAF to search for. + // Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, + // including the identifier of the pattern set and the regular expression patterns + // you want AWS WAF to search for. RegexPatternSet *types.RegexPatternSet // Metadata pertaining to the operation's result. diff --git a/service/waf/api_op_GetRule.go b/service/waf/api_op_GetRule.go index f110a6a44a1..ffd38591cc2 100644 --- a/service/waf/api_op_GetRule.go +++ b/service/waf/api_op_GetRule.go @@ -11,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...func(*Options)) (*GetRuleOutput, error) { if params == nil { params = &GetRuleInput{} @@ -34,8 +40,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 . + // The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules. // // This member is required. RuleId *string @@ -47,9 +52,12 @@ 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 375a1f13dec..b9bb0e5be19 100644 --- a/service/waf/api_op_GetRuleGroup.go +++ b/service/waf/api_op_GetRuleGroup.go @@ -11,13 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error) { if params == nil { params = &GetRuleGroupInput{} @@ -35,8 +42,8 @@ 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 . + // The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned 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 355e58a4583..b881b1de751 100644 --- a/service/waf/api_op_GetSampledRequests.go +++ b/service/waf/api_op_GetSampledRequests.go @@ -11,20 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledRequestsInput, optFns ...func(*Options)) (*GetSampledRequestsOutput, error) { if params == nil { params = &GetSampledRequestsInput{} @@ -51,8 +58,10 @@ type GetSampledRequestsInput struct { 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 . // diff --git a/service/waf/api_op_GetSizeConstraintSet.go b/service/waf/api_op_GetSizeConstraintSet.go index 0c90ecc65a6..2620bd5e4a3 100644 --- a/service/waf/api_op_GetSizeConstraintSet.go +++ b/service/waf/api_op_GetSizeConstraintSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the SizeConstraintSet specified by SizeConstraintSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetSizeConstraintSet(ctx context.Context, params *GetSizeConstraintSetInput, optFns ...func(*Options)) (*GetSizeConstraintSetOutput, error) { if params == nil { params = &GetSizeConstraintSetInput{} @@ -33,9 +39,8 @@ func (c *Client) GetSizeConstraintSet(ctx context.Context, params *GetSizeConstr type GetSizeConstraintSetInput struct { - // The SizeConstraintSetId of the SizeConstraintSet that you want to get. - // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets . + // The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is + // returned by CreateSizeConstraintSetand by ListSizeConstraintSets. // // This member is required. SizeConstraintSetId *string @@ -45,14 +50,17 @@ type GetSizeConstraintSetInput struct { 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 + // 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 SizeConstraintobjects. 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 20110d415a2..1079a1e2c3f 100644 --- a/service/waf/api_op_GetSqlInjectionMatchSet.go +++ b/service/waf/api_op_GetSqlInjectionMatchSet.go @@ -11,12 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetSqlInjectionMatchSet(ctx context.Context, params *GetSqlInjectionMatchSetInput, optFns ...func(*Options)) (*GetSqlInjectionMatchSetOutput, error) { if params == nil { params = &GetSqlInjectionMatchSetInput{} @@ -32,12 +37,11 @@ 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 . + // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId + // is returned by CreateSqlInjectionMatchSetand by ListSqlInjectionMatchSets. // // This member is required. SqlInjectionMatchSetId *string @@ -48,13 +52,19 @@ type GetSqlInjectionMatchSetInput struct { // The response to a GetSqlInjectionMatchSet request. 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 + // 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 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 c99784df908..a2cb9657ae2 100644 --- a/service/waf/api_op_GetWebACL.go +++ b/service/waf/api_op_GetWebACL.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error) { if params == nil { params = &GetWebACLInput{} @@ -33,8 +39,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 . + // The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs. // // This member is required. WebACLId *string @@ -44,13 +49,18 @@ type GetWebACLInput struct { 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 + // 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 *types.WebACL diff --git a/service/waf/api_op_GetXssMatchSet.go b/service/waf/api_op_GetXssMatchSet.go index a77bf0b08ac..bac430775cc 100644 --- a/service/waf/api_op_GetXssMatchSet.go +++ b/service/waf/api_op_GetXssMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetXssMatchSet(ctx context.Context, params *GetXssMatchSetInput, optFns ...func(*Options)) (*GetXssMatchSetOutput, error) { if params == nil { params = &GetXssMatchSetInput{} @@ -31,11 +37,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 . + // The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet + // and by ListXssMatchSets. // // This member is required. XssMatchSetId *string @@ -46,13 +52,17 @@ type GetXssMatchSetInput struct { // The response to a GetXssMatchSet request. 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 + // 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 *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 ad2a571e5a3..12f33295a5c 100644 --- a/service/waf/api_op_ListActivatedRulesInRuleGroup.go +++ b/service/waf/api_op_ListActivatedRulesInRuleGroup.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of ActivatedRule objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListActivatedRulesInRuleGroup(ctx context.Context, params *ListActivatedRulesInRuleGroupInput, optFns ...func(*Options)) (*ListActivatedRulesInRuleGroupOutput, error) { if params == nil { params = &ListActivatedRulesInRuleGroupInput{} @@ -46,8 +52,7 @@ type ListActivatedRulesInRuleGroupInput struct { // 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 - // ActivatedRule objects. + // The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects. RuleGroupId *string noSmithyDocumentSerde diff --git a/service/waf/api_op_ListByteMatchSets.go b/service/waf/api_op_ListByteMatchSets.go index 6d2d81ff0d6..631ac790bc7 100644 --- a/service/waf/api_op_ListByteMatchSets.go +++ b/service/waf/api_op_ListByteMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of ByteMatchSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSetsInput, optFns ...func(*Options)) (*ListByteMatchSetsOutput, error) { if params == nil { params = &ListByteMatchSetsInput{} diff --git a/service/waf/api_op_ListGeoMatchSets.go b/service/waf/api_op_ListGeoMatchSets.go index 13a07b7c239..df5251df0da 100644 --- a/service/waf/api_op_ListGeoMatchSets.go +++ b/service/waf/api_op_ListGeoMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListGeoMatchSets(ctx context.Context, params *ListGeoMatchSetsInput, optFns ...func(*Options)) (*ListGeoMatchSetsOutput, error) { if params == nil { params = &ListGeoMatchSetsInput{} diff --git a/service/waf/api_op_ListIPSets.go b/service/waf/api_op_ListIPSets.go index ca65e0b39ca..cb3d7998af4 100644 --- a/service/waf/api_op_ListIPSets.go +++ b/service/waf/api_op_ListIPSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns ...func(*Options)) (*ListIPSetsOutput, error) { if params == nil { params = &ListIPSetsInput{} diff --git a/service/waf/api_op_ListLoggingConfigurations.go b/service/waf/api_op_ListLoggingConfigurations.go index 9805d3c765b..5079a91e30f 100644 --- a/service/waf/api_op_ListLoggingConfigurations.go +++ b/service/waf/api_op_ListLoggingConfigurations.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of LoggingConfiguration objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error) { if params == nil { params = &ListLoggingConfigurationsInput{} diff --git a/service/waf/api_op_ListRateBasedRules.go b/service/waf/api_op_ListRateBasedRules.go index 89ee1a5a77d..249e98b3180 100644 --- a/service/waf/api_op_ListRateBasedRules.go +++ b/service/waf/api_op_ListRateBasedRules.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RuleSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRateBasedRules(ctx context.Context, params *ListRateBasedRulesInput, optFns ...func(*Options)) (*ListRateBasedRulesOutput, error) { if params == nil { params = &ListRateBasedRulesInput{} diff --git a/service/waf/api_op_ListRegexMatchSets.go b/service/waf/api_op_ListRegexMatchSets.go index 6a5401d2bfb..85ec8513472 100644 --- a/service/waf/api_op_ListRegexMatchSets.go +++ b/service/waf/api_op_ListRegexMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RegexMatchSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRegexMatchSets(ctx context.Context, params *ListRegexMatchSetsInput, optFns ...func(*Options)) (*ListRegexMatchSetsOutput, error) { if params == nil { params = &ListRegexMatchSetsInput{} diff --git a/service/waf/api_op_ListRegexPatternSets.go b/service/waf/api_op_ListRegexPatternSets.go index 6c702606a38..27474fa46af 100644 --- a/service/waf/api_op_ListRegexPatternSets.go +++ b/service/waf/api_op_ListRegexPatternSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RegexPatternSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error) { if params == nil { params = &ListRegexPatternSetsInput{} diff --git a/service/waf/api_op_ListRuleGroups.go b/service/waf/api_op_ListRuleGroups.go index 334b685e397..bc8b6e1c3b9 100644 --- a/service/waf/api_op_ListRuleGroups.go +++ b/service/waf/api_op_ListRuleGroups.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RuleGroup objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error) { if params == nil { params = &ListRuleGroupsInput{} diff --git a/service/waf/api_op_ListRules.go b/service/waf/api_op_ListRules.go index 86016ca4494..8671c61d16a 100644 --- a/service/waf/api_op_ListRules.go +++ b/service/waf/api_op_ListRules.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RuleSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error) { if params == nil { params = &ListRulesInput{} diff --git a/service/waf/api_op_ListSizeConstraintSets.go b/service/waf/api_op_ListSizeConstraintSets.go index 2e8aa47b4cf..0d051ca58c9 100644 --- a/service/waf/api_op_ListSizeConstraintSets.go +++ b/service/waf/api_op_ListSizeConstraintSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of SizeConstraintSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListSizeConstraintSets(ctx context.Context, params *ListSizeConstraintSetsInput, optFns ...func(*Options)) (*ListSizeConstraintSetsOutput, error) { if params == nil { params = &ListSizeConstraintSetsInput{} diff --git a/service/waf/api_op_ListSqlInjectionMatchSets.go b/service/waf/api_op_ListSqlInjectionMatchSets.go index 5bd2ed9b610..25e644d6ab8 100644 --- a/service/waf/api_op_ListSqlInjectionMatchSets.go +++ b/service/waf/api_op_ListSqlInjectionMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of SqlInjectionMatchSet objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlInjectionMatchSetsInput, optFns ...func(*Options)) (*ListSqlInjectionMatchSetsOutput, error) { if params == nil { params = &ListSqlInjectionMatchSetsInput{} @@ -31,21 +37,20 @@ func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlI return out, nil } -// A request to list the SqlInjectionMatchSet objects created by the current AWS -// account. +// A request to list the SqlInjectionMatchSet objects created by the current AWS account. 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 . + // 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 . 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 + // 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 . NextMarker *string @@ -55,11 +60,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 99d4764549f..a26d34c54dc 100644 --- a/service/waf/api_op_ListSubscribedRuleGroups.go +++ b/service/waf/api_op_ListSubscribedRuleGroups.go @@ -11,12 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListSubscribedRuleGroups(ctx context.Context, params *ListSubscribedRuleGroupsInput, optFns ...func(*Options)) (*ListSubscribedRuleGroupsOutput, error) { if params == nil { params = &ListSubscribedRuleGroupsInput{} diff --git a/service/waf/api_op_ListTagsForResource.go b/service/waf/api_op_ListTagsForResource.go index 90bd6481835..8631c7aebbc 100644 --- a/service/waf/api_op_ListTagsForResource.go +++ b/service/waf/api_op_ListTagsForResource.go @@ -11,18 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/waf/api_op_ListWebACLs.go b/service/waf/api_op_ListWebACLs.go index b6dffeda724..3519a5e21eb 100644 --- a/service/waf/api_op_ListWebACLs.go +++ b/service/waf/api_op_ListWebACLs.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optFns ...func(*Options)) (*ListWebACLsOutput, error) { if params == nil { params = &ListWebACLsInput{} diff --git a/service/waf/api_op_ListXssMatchSets.go b/service/waf/api_op_ListXssMatchSets.go index 9c319dc97a2..97e9933ec2f 100644 --- a/service/waf/api_op_ListXssMatchSets.go +++ b/service/waf/api_op_ListXssMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of XssMatchSet objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsInput, optFns ...func(*Options)) (*ListXssMatchSetsOutput, error) { if params == nil { params = &ListXssMatchSetsInput{} @@ -34,15 +40,15 @@ func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsI // A request to list the XssMatchSet objects created by the current AWS account. 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 + // 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 . 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 + // 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 // ListXssMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of XssMatchSets . NextMarker *string @@ -53,10 +59,10 @@ type ListXssMatchSetsInput struct { // The response to a ListXssMatchSets request. type ListXssMatchSetsOutput struct { - // If you have more XssMatchSet objects than the number that you specified for - // Limit in the request, the response includes a NextMarker value. To list more - // XssMatchSet objects, submit another ListXssMatchSets request, and specify the - // NextMarker value from the response in the NextMarker value in the next request. + // If you have more XssMatchSet objects than the number that you specified for Limit in the + // request, the response includes a NextMarker value. To list more XssMatchSet + // objects, submit another ListXssMatchSets request, and specify the NextMarker + // value from the response in the NextMarker value in the next request. NextMarker *string // An array of XssMatchSetSummary objects. diff --git a/service/waf/api_op_PutLoggingConfiguration.go b/service/waf/api_op_PutLoggingConfiguration.go index 8b6935adb82..79438c725ff 100644 --- a/service/waf/api_op_PutLoggingConfiguration.go +++ b/service/waf/api_op_PutLoggingConfiguration.go @@ -11,25 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// - 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. +// write logs to the Amazon Kinesis Data Firehose. For more information, see [Logging Web ACL Traffic Information]in +// the AWS WAF Developer Guide. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [Logging Web ACL Traffic Information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error) { if params == nil { params = &PutLoggingConfigurationInput{} @@ -49,8 +62,10 @@ 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 fecb88d2625..4b7ecd49d77 100644 --- a/service/waf/api_op_PutPermissionPolicy.go +++ b/service/waf/api_op_PutPermissionPolicy.go @@ -10,27 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. // -// 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]. +// +// An example of a valid policy parameter is shown in the Examples section below. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html 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 0d5e7a116fa..7b502571b99 100644 --- a/service/waf/api_op_TagResource.go +++ b/service/waf/api_op_TagResource.go @@ -11,18 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 5cfa85631d6..6a34bf21db0 100644 --- a/service/waf/api_op_UntagResource.go +++ b/service/waf/api_op_UntagResource.go @@ -10,11 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 eae289c7878..ff217ce1442 100644 --- a/service/waf/api_op_UpdateByteMatchSet.go +++ b/service/waf/api_op_UpdateByteMatchSet.go @@ -11,40 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// the ByteMatchTupledata 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. +// 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 GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -62,23 +75,29 @@ 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 . + // The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned + // by CreateByteMatchSetand 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 @@ -90,7 +109,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 66f660532f1..4419709213b 100644 --- a/service/waf/api_op_UpdateGeoMatchSet.go +++ b/service/waf/api_op_UpdateGeoMatchSet.go @@ -11,32 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 -// . +// 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 a CreateGeoMatchSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateGeoMatchSetrequest. +// // - 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/) . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -54,23 +66,28 @@ 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 . + // The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is 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 @@ -82,7 +99,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 5b13efd9e1b..47b94d86522 100644 --- a/service/waf/api_op_UpdateIPSet.go +++ b/service/waf/api_op_UpdateIPSet.go @@ -11,48 +11,68 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 ). // // 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: +// more information about CIDR notation, see the Wikipedia entry [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. +// addresses, and then configure AWS WAF to block the requests. +// +// To create and configure an IPSet , perform the following steps: +// +// - Submit a CreateIPSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateIPSetrequest. +// // - 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/) . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/ +// [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error) { if params == nil { params = &UpdateIPSetInput{} @@ -70,21 +90,25 @@ 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 . + // The IPSetId of the IPSet that you want to update. IPSetId is returned by 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 + // 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 + // // You can insert a maximum of 1000 addresses in a single request. // // This member is required. @@ -96,8 +120,7 @@ type UpdateIPSetInput struct { 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 . + // 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_UpdateRateBasedRule.go b/service/waf/api_op_UpdateRateBasedRule.go index c7069eed84d..c2243828fa7 100644 --- a/service/waf/api_op_UpdateRateBasedRule.go +++ b/service/waf/api_op_UpdateRateBasedRule.go @@ -11,37 +11,52 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 : +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 : +// // - An IPSet that matches the IP address 192.0.2.44/32 +// // - 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 : +// 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBasedRuleInput, optFns ...func(*Options)) (*UpdateRateBasedRuleOutput, error) { if params == nil { params = &UpdateRateBasedRuleInput{} @@ -59,7 +74,7 @@ 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 @@ -73,13 +88,12 @@ 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 . + // An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule. // // This member is required. Updates []types.RuleUpdate @@ -91,7 +105,7 @@ 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 . + // 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 a80240ca118..cbafa90ee04 100644 --- a/service/waf/api_op_UpdateRegexMatchSet.go +++ b/service/waf/api_op_UpdateRegexMatchSet.go @@ -11,38 +11,50 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// 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. +// 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 GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -60,19 +72,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 . + // The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is + // returned by CreateRegexMatchSetand 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 @@ -84,7 +96,7 @@ 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 . + // 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 44cfc7c43d2..82964b0b811 100644 --- a/service/waf/api_op_UpdateRegexPatternSet.go +++ b/service/waf/api_op_UpdateRegexPatternSet.go @@ -11,34 +11,47 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// information, see RegexPatternSet. // // 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. +// +// - Create a RegexPatternSet. For more information, see CreateRegexPatternSet. +// +// - Use GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -56,20 +69,19 @@ 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 . + // The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is + // returned by CreateRegexPatternSetand by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string // An array of RegexPatternSetUpdate objects that you want to insert into or - // delete from a RegexPatternSet . + // delete from a RegexPatternSet. // // This member is required. Updates []types.RegexPatternSetUpdate @@ -81,7 +93,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 ac3ce776b41..4ac1fda887c 100644 --- a/service/waf/api_op_UpdateRule.go +++ b/service/waf/api_op_UpdateRule.go @@ -11,35 +11,49 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// specifications to be allowed, blocked, or counted. For example, suppose that you -// add the following to a Rule : +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 ByteMatchSetor 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 specifications to be allowed, blocked, or counted. For +// example, suppose that you 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 // // 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: +// 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 . +// +// - Create the Rule . See CreateRule. +// // - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateRule request. +// ChangeToken parameter of an UpdateRulerequest. +// // - Submit an UpdateRule request to add predicates to the Rule . -// - Create and update a WebACL that contains the Rule . See CreateWebACL . +// +// - 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/) -// . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -57,22 +71,28 @@ 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 + // 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 // // This member is required. Updates []types.RuleUpdate @@ -83,8 +103,7 @@ 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 . + // 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 35919c529b7..b88b60ad1a6 100644 --- a/service/waf/api_op_UpdateRuleGroup.go +++ b/service/waf/api_op_UpdateRuleGroup.go @@ -11,25 +11,39 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// ChangeToken parameter of an UpdateRuleGrouprequest. +// // - Submit an UpdateRuleGroup request to add Rules to the RuleGroup . -// - Create and update a WebACL that contains the RuleGroup . See CreateWebACL . +// +// - 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/) -// . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -47,19 +61,22 @@ 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 . + // The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is 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. + // 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 @@ -75,7 +92,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 136605ac177..f7d09ef041f 100644 --- a/service/waf/api_op_UpdateSizeConstraintSet.go +++ b/service/waf/api_op_UpdateSizeConstraintSet.go @@ -11,44 +11,57 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// 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. +// 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 GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -66,25 +79,28 @@ 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 . + // The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is + // returned by CreateSizeConstraintSetand by 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 - // types: - // - SizeConstraintSetUpdate : Contains Action and SizeConstraint - // - SizeConstraint : Contains FieldToMatch , TextTransformation , - // ComparisonOperator , and Size - // - FieldToMatch : Contains Data and Type + // 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 // // This member is required. Updates []types.SizeConstraintSetUpdate @@ -96,7 +112,7 @@ 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 . + // 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 adb2b3424f6..422d4336388 100644 --- a/service/waf/api_op_UpdateSqlInjectionMatchSet.go +++ b/service/waf/api_op_UpdateSqlInjectionMatchSet.go @@ -11,38 +11,50 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// 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 // 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. +// and then configure AWS WAF to block the requests. +// +// To create and configure a SqlInjectionMatchSet , perform the following steps: +// +// - Submit a CreateSqlInjectionMatchSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateIPSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -58,27 +70,31 @@ 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 . + // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by 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 - // data types: - // - SqlInjectionMatchSetUpdate : Contains Action and SqlInjectionMatchTuple - // - SqlInjectionMatchTuple : Contains FieldToMatch and TextTransformation - // - FieldToMatch : Contains Data and Type + // 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 // // This member is required. Updates []types.SqlInjectionMatchSetUpdate @@ -91,7 +107,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 21f4eac428e..8c5e6d9b85d 100644 --- a/service/waf/api_op_UpdateWebACL.go +++ b/service/waf/api_op_UpdateWebACL.go @@ -11,20 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 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 @@ -34,30 +41,42 @@ import ( // 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 . +// 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 . +// more information, see CreateRuleand UpdateRule. +// +// - Create a WebACL . See CreateWebACL. +// // - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateWebACL request. +// ChangeToken parameter of an UpdateWebACLrequest. +// // - 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 . +// 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 -// 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/) -// . +// the rule type when first creating the rule, the UpdateWebACLrequest 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -75,13 +94,12 @@ 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 . + // The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs. // // This member is required. WebACLId *string @@ -91,16 +109,23 @@ 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 + // 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 + // + // WafAction + // - : Contains Type Updates []types.WebACLUpdate noSmithyDocumentSerde @@ -109,8 +134,7 @@ type UpdateWebACLInput struct { 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 . + // 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_UpdateXssMatchSet.go b/service/waf/api_op_UpdateXssMatchSet.go index 9cadb79dee2..4b5645c7858 100644 --- a/service/waf/api_op_UpdateXssMatchSet.go +++ b/service/waf/api_op_UpdateXssMatchSet.go @@ -11,37 +11,50 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// 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. +// then configure AWS WAF to block the requests. +// +// To create and configure an XssMatchSet , perform the following steps: +// +// - Submit a CreateXssMatchSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateIPSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -57,25 +70,31 @@ 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 CreateXssMatchSetand by ListXssMatchSets. // // This member is required. XssMatchSetId *string @@ -88,7 +107,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 ed019f995be..1074c446bb3 100644 --- a/service/waf/doc.go +++ b/service/waf/doc.go @@ -3,17 +3,22 @@ // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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]in the developer +// guide. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html package waf diff --git a/service/waf/options.go b/service/waf/options.go index 759f9257429..c9486b5de86 100644 --- a/service/waf/options.go +++ b/service/waf/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/waf/types/enums.go b/service/waf/types/enums.go index 42c45e0ef18..65fea6183b6 100644 --- a/service/waf/types/enums.go +++ b/service/waf/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ChangeTokenStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeTokenStatus) Values() []ChangeTokenStatus { return []ChangeTokenStatus{ "PROVISIONED", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQ", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for GeoMatchConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoMatchConstraintType) Values() []GeoMatchConstraintType { return []GeoMatchConstraintType{ "Country", @@ -338,8 +342,9 @@ const ( ) // Values returns all known values for GeoMatchConstraintValue. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoMatchConstraintValue) Values() []GeoMatchConstraintValue { return []GeoMatchConstraintValue{ "AF", @@ -603,8 +608,9 @@ const ( ) // Values returns all known values for IPSetDescriptorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IPSetDescriptorType) Values() []IPSetDescriptorType { return []IPSetDescriptorType{ "IPV4", @@ -626,8 +632,9 @@ const ( ) // Values returns all known values for MatchFieldType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchFieldType) Values() []MatchFieldType { return []MatchFieldType{ "URI", @@ -654,8 +661,9 @@ const ( ) // Values returns all known values for MigrationErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationErrorType) Values() []MigrationErrorType { return []MigrationErrorType{ "ENTITY_NOT_SUPPORTED", @@ -693,8 +701,9 @@ const ( ) // Values returns all known values for ParameterExceptionField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterExceptionField) Values() []ParameterExceptionField { return []ParameterExceptionField{ "CHANGE_ACTION", @@ -730,6 +739,7 @@ const ( // 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{ @@ -752,8 +762,9 @@ const ( ) // Values returns all known values for PositionalConstraint. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionalConstraint) Values() []PositionalConstraint { return []PositionalConstraint{ "EXACTLY", @@ -778,8 +789,9 @@ const ( ) // Values returns all known values for PredicateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PredicateType) Values() []PredicateType { return []PredicateType{ "IPMatch", @@ -800,8 +812,9 @@ const ( ) // Values returns all known values for RateKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RateKey) Values() []RateKey { return []RateKey{ "IP", @@ -821,8 +834,9 @@ const ( ) // Values returns all known values for TextTransformation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextTransformation) Values() []TextTransformation { return []TextTransformation{ "NONE", @@ -844,8 +858,9 @@ const ( ) // Values returns all known values for WafActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WafActionType) Values() []WafActionType { return []WafActionType{ "BLOCK", @@ -863,8 +878,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NONE", @@ -882,8 +898,9 @@ const ( ) // Values returns all known values for WafRuleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WafRuleType) Values() []WafRuleType { return []WafRuleType{ "REGULAR", diff --git a/service/waf/types/errors.go b/service/waf/types/errors.go index 898ad54504a..6c67a89aff2 100644 --- a/service/waf/types/errors.go +++ b/service/waf/types/errors.go @@ -60,16 +60,23 @@ func (e *WAFDisallowedNameException) ErrorFault() smithy.ErrorFault { return smi // 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. type WAFEntityMigrationException struct { @@ -155,14 +162,19 @@ 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 . type WAFInvalidOperationException struct { @@ -192,19 +204,28 @@ 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 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 { @@ -237,17 +258,26 @@ func (e *WAFInvalidParameterException) ErrorCode() string { func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. type WAFInvalidPermissionPolicyException struct { Message *string @@ -303,9 +333,10 @@ func (e *WAFInvalidRegexPatternException) ErrorCode() string { func (e *WAFInvalidRegexPatternException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation exceeds a resource limit, for example, the maximum number of -// WebACL objects that you can create for an AWS account. For more information, see -// Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in -// the AWS WAF Developer Guide. +// WebACL objects that you can create for an AWS account. For more information, see [Limits] +// in the AWS WAF Developer Guide. +// +// [Limits]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html type WAFLimitsExceededException struct { Message *string @@ -333,11 +364,15 @@ func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault { return smi // 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 @@ -366,12 +401,15 @@ 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 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 { @@ -427,7 +465,9 @@ func (e *WAFNonexistentItemException) ErrorFault() smithy.ErrorFault { return sm // 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 diff --git a/service/waf/types/types.go b/service/waf/types/types.go index 97a4cc26a2b..404978cab0e 100644 --- a/service/waf/types/types.go +++ b/service/waf/types/types.go @@ -7,15 +7,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type ActivatedRule struct { // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a @@ -27,9 +35,10 @@ type ActivatedRule struct { 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 . + // (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 @@ -37,11 +46,15 @@ type ActivatedRule struct { // 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 @@ -49,77 +62,95 @@ type ActivatedRule struct { 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. + // 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: + // 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: + // exclude. For more information about the logs, see [Logging Web ACL Traffic Information]. + // + // - Submit an UpdateWebACLrequest 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 + // in the UpdateWebACLrequest, 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. + // + // [Logging Web ACL Traffic Information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html 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 - // 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 . + // 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 . 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. - // 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 - // does not exist. + // 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 UpdateWebACLrequest will fail because the request tries to add a + // REGULAR rule with the specified ID, which does not exist. Type WafRuleType 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -131,31 +162,38 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -163,16 +201,21 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -188,83 +231,128 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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. - // CONTAINS_WORD The specified part of the web request must include the value of - // 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: + // 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 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. + // + // 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 : + // . 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. + // 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 . + // 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. + // 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 @@ -272,38 +360,75 @@ type ByteMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -311,13 +436,19 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type ExcludedRule struct { // The unique identifier for the rule to exclude from the rule group. @@ -328,34 +459,47 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 . @@ -365,21 +509,30 @@ type FieldToMatch struct { // 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 . + // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type GeoMatchConstraint struct { // The type of geographical area you want AWS WAF to search for. Currently Country @@ -396,50 +549,63 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type GeoMatchSet struct { - // An array of GeoMatchConstraint objects, which contain the country that you want - // AWS WAF to search for. + // An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search + // for. // // 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 . + // 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 - // an GeoMatchSet after you create it. + // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 - // an GeoMatchSet after you create it. + // 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. Name *string @@ -447,15 +613,20 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -469,14 +640,20 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type HTTPHeader struct { // The name of one of the headers in the sampled web request. @@ -488,28 +665,36 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 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]. + // + // [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 . @@ -530,20 +715,27 @@ type HTTPRequest 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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) -// . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [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) @@ -555,26 +747,33 @@ type IPSet struct { 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 . + // (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 - // IPSet after you create it. + // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type IPSetDescriptor struct { // Specify IPV4 or IPV6 . @@ -583,42 +782,55 @@ type IPSetDescriptor struct { 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: + // + // For more information about CIDR notation, see the Wikipedia entry [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 . // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing + // // This member is required. Value *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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 - // IPSet after you create it. + // 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. Name *string @@ -626,15 +838,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -648,12 +865,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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). +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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). +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type LoggingConfiguration struct { // An array of Amazon Kinesis Data Firehose ARNs. @@ -674,15 +897,19 @@ type LoggingConfiguration 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type Predicate struct { // A unique identifier for a predicate in a Rule , such as ByteMatchSetId or @@ -692,13 +919,12 @@ type Predicate struct { 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 - // 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 + // 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 . // @@ -713,26 +939,35 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -754,10 +989,9 @@ type RateBasedRule struct { 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 ). + // 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 @@ -776,37 +1010,47 @@ type RateBasedRule 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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: + // 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 . + // 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 @@ -814,16 +1058,22 @@ type RegexMatchSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -831,7 +1081,8 @@ type RegexMatchSetSummary struct { // 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 . + // + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. // // This member is required. RegexMatchSetId *string @@ -839,16 +1090,21 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -865,19 +1121,28 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RegexMatchTuple struct { // Specifies where in a web request to look for the RegexPatternSet . @@ -886,12 +1151,11 @@ type RegexMatchTuple struct { 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 ). - // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets . + // 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. // // This member is required. RegexPatternSetId *string @@ -899,38 +1163,75 @@ type RegexMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -938,20 +1239,27 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // WAF. + // + // RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -962,23 +1270,29 @@ type RegexPatternSet struct { // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -986,8 +1300,9 @@ type RegexPatternSetSummary struct { // 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 . + // WAF. + // + // RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -995,13 +1310,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RegexPatternSetUpdate struct { // Specifies whether to insert or delete a RegexPatternString . @@ -1018,33 +1338,41 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . // // 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1063,24 +1391,34 @@ type Rule 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1099,25 +1437,31 @@ type RuleGroup 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RuleGroupSummary struct { - // A friendly name or description of the RuleGroup . You can't change the name of a - // RuleGroup after you create it. + // 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 . + // 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 @@ -1125,12 +1469,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RuleGroupUpdate struct { // Specify INSERT to add an ActivatedRule to a RuleGroup . Use DELETE to remove an @@ -1149,24 +1499,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1174,12 +1530,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RuleUpdate struct { // Specify INSERT to add a Predicate to a Rule . Use DELETE to remove a Predicate @@ -1196,14 +1558,20 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SampledHTTPRequest struct { // A complex type that contains detailed information about the request. @@ -1235,27 +1603,41 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 " 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 - // is less than or equal to the size of the FieldToMatch LT: Used to test if the - // Size is strictly less than the size of the FieldToMatch GE: Used to test if the - // Size is greater than or equal to the size of the FieldToMatch GT: Used to test - // if the Size is strictly greater than the size of the FieldToMatch + // 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 is less than or equal to the size of the + // FieldToMatch + // + // LT: Used to test if the Size is strictly less than the size of the FieldToMatch + // + // GE: Used to test if the Size is greater than or equal to the size of the + // FieldToMatch + // + // GT: Used to test if the Size is strictly greater than the size of the + // FieldToMatch // // This member is required. ComparisonOperator ComparisonOperator @@ -1269,10 +1651,12 @@ type SizeConstraint struct { // 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. + // 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 @@ -1280,40 +1664,79 @@ type SizeConstraint struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -1321,23 +1744,28 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 ). - // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets . + // 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. // // This member is required. SizeConstraintSetId *string @@ -1353,11 +1781,17 @@ type SizeConstraintSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// The Id and Name of a SizeConstraintSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SizeConstraintSetSummary struct { // The name of the SizeConstraintSet , if any. @@ -1366,12 +1800,11 @@ type SizeConstraintSetSummary struct { 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 ). - // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets . + // 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. // // This member is required. SizeConstraintSetId *string @@ -1379,17 +1812,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 SizeConstraintSetor delete it from a +// SizeConstraintSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1405,25 +1844,31 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1440,11 +1885,17 @@ type SqlInjectionMatchSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// The Id and Name of a SqlInjectionMatchSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SqlInjectionMatchSetSummary struct { // The name of the SqlInjectionMatchSet , if any, specified by Id . @@ -1453,12 +1904,12 @@ type SqlInjectionMatchSetSummary struct { 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 . + // 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 @@ -1466,18 +1917,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1492,13 +1948,19 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SqlInjectionMatchTuple struct { // Specifies where in a web request to look for snippets of malicious SQL code. @@ -1509,38 +1971,75 @@ type SqlInjectionMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -1548,11 +2047,17 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SubscribedRuleGroupSummary struct { // A friendly name or description for the metrics for this RuleGroup . The name can @@ -1578,18 +2083,25 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: -// web ACLs, rule groups, and rules. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: web ACLs, rule groups, and rules. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type Tag struct { // @@ -1605,18 +2117,25 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// 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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type TagInfoForResource struct { // @@ -1628,21 +2147,29 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type TimeWindow struct { // The end of the time range from which you want GetSampledRequests to return a @@ -1666,21 +2193,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1692,12 +2228,17 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WafOverrideAction struct { // COUNT overrides the action specified by the individual rule within a RuleGroup @@ -1709,22 +2250,28 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WebACL struct { // The action to perform if none of the Rules contained in the WebACL match. The - // action is specified by the WafAction object. + // action is specified by the WafActionobject. // // This member is required. DefaultAction *WafAction @@ -1736,9 +2283,9 @@ type WebACL struct { 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 . + // 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 @@ -1760,24 +2307,29 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WebACLSummary struct { - // A friendly name or description of the WebACL . You can't change the name of a - // WebACL after you create it. + // 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 . + // 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 @@ -1785,12 +2337,17 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WebACLUpdate struct { // Specifies whether to insert a Rule into or delete a Rule from a WebACL . @@ -1798,10 +2355,10 @@ type WebACLUpdate struct { // 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 ). + // 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 ). // // This member is required. ActivatedRule *ActivatedRule @@ -1809,24 +2366,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1843,11 +2406,17 @@ type XssMatchSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// The Id and Name of an XssMatchSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type XssMatchSetSummary struct { // The name of the XssMatchSet , if any, specified by Id . @@ -1856,11 +2425,11 @@ type XssMatchSetSummary struct { 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 . + // 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 @@ -1868,17 +2437,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1893,13 +2468,19 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type XssMatchTuple struct { // Specifies where in a web request to look for cross-site scripting attacks. @@ -1910,38 +2491,75 @@ type XssMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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_op_AssociateWebACL.go b/service/wafregional/api_op_AssociateWebACL.go index f8f5c6eeb7b..79110f820b4 100644 --- a/service/wafregional/api_op_AssociateWebACL.go +++ b/service/wafregional/api_op_AssociateWebACL.go @@ -10,13 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic Regional documentation. For more information, see [AWS WAF Classic] in +// the developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInput, optFns ...func(*Options)) (*AssociateWebACLOutput, error) { if params == nil { params = &AssociateWebACLInput{} @@ -35,8 +40,10 @@ func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInp 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: + // 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 // diff --git a/service/wafregional/api_op_CreateByteMatchSet.go b/service/wafregional/api_op_CreateByteMatchSet.go index 2565d1098c3..a5d220dda46 100644 --- a/service/wafregional/api_op_CreateByteMatchSet.go +++ b/service/wafregional/api_op_CreateByteMatchSet.go @@ -11,28 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// +// - Submit an UpdateByteMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -50,13 +60,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 @@ -71,7 +81,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 9e1e397b992..f0ca65f864e 100644 --- a/service/wafregional/api_op_CreateGeoMatchSet.go +++ b/service/wafregional/api_op_CreateGeoMatchSet.go @@ -11,27 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateGeoMatchSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -49,13 +59,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 @@ -67,11 +77,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 . + // The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet 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 c0730155ca4..682c1b8fd6e 100644 --- a/service/wafregional/api_op_CreateIPSet.go +++ b/service/wafregional/api_op_CreateIPSet.go @@ -11,28 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// ChangeToken parameter of an UpdateIPSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -50,13 +60,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 @@ -67,8 +77,7 @@ type CreateIPSetInput struct { 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 . + // use this value to query the status of the request. For more information, see 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 a5621d7f56c..ebf12e7daa4 100644 --- a/service/wafregional/api_op_CreateRateBasedRule.go +++ b/service/wafregional/api_op_CreateRateBasedRule.go @@ -11,56 +11,76 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 : +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 : +// // - An IPSet that matches the IP address 192.0.2.44/32 +// // - 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 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 : +// 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: +// 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. +// more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateRulerequest. +// // - 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 . +// 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -80,7 +100,7 @@ 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 . + // information, see GetChangeTokenStatus. // // This member is required. ChangeToken *string @@ -94,8 +114,8 @@ type CreateRateBasedRuleInput struct { // This member is required. MetricName *string - // A friendly name or description of the RateBasedRule . You can't change the name - // of a RateBasedRule after you create it. + // 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. Name *string @@ -126,7 +146,7 @@ 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 . + // 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 31d3b45b414..1b3ae6f1310 100644 --- a/service/wafregional/api_op_CreateRegexMatchSet.go +++ b/service/wafregional/api_op_CreateRegexMatchSet.go @@ -11,29 +11,39 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: -// - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateRegexMatchSet request. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: +// +// - Use GetChangeTokento 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. +// +// - Submit an UpdateRegexMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -51,13 +61,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 @@ -69,7 +79,7 @@ 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 . + // 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 3dc962a0d43..d5c4acf267b 100644 --- a/service/wafregional/api_op_CreateRegexPatternSet.go +++ b/service/wafregional/api_op_CreateRegexPatternSet.go @@ -11,26 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// +// - Submit an UpdateRegexPatternSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -48,13 +56,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 @@ -66,7 +74,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 4ce3a086a35..48e38d3b5c7 100644 --- a/service/wafregional/api_op_CreateRule.go +++ b/service/wafregional/api_op_CreateRule.go @@ -11,38 +11,52 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 // specifications to be allowed or blocked. For example, suppose that you add the // 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 // // 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: +// 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. +// more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateRulerequest. +// // - 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 . +// 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -60,7 +74,7 @@ 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 @@ -74,7 +88,7 @@ type CreateRuleInput struct { // 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. @@ -89,8 +103,7 @@ 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 . + // 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 3b91c115d44..a6a73b6ec5d 100644 --- a/service/wafregional/api_op_CreateRuleGroup.go +++ b/service/wafregional/api_op_CreateRuleGroup.go @@ -11,21 +11,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 UpdateRuleGroupto 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. // // 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -43,7 +52,7 @@ 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 @@ -57,8 +66,8 @@ type CreateRuleGroupInput struct { // 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 @@ -73,10 +82,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 86e1ec3d065..82e269ed675 100644 --- a/service/wafregional/api_op_CreateSizeConstraintSet.go +++ b/service/wafregional/api_op_CreateSizeConstraintSet.go @@ -11,29 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento 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. +// +// - Submit an UpdateSizeConstraintSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -51,13 +60,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 @@ -69,7 +78,7 @@ 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 . + // 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 ae88ada08ab..ed766475506 100644 --- a/service/wafregional/api_op_CreateSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_CreateSqlInjectionMatchSet.go @@ -11,26 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// following steps: -// - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateSqlInjectionMatchSet request. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 following steps: +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateSqlInjectionMatchSetrequest. +// +// - Submit an UpdateSqlInjectionMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -46,16 +55,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 . + // A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change + // Name after you create the SqlInjectionMatchSet . // // This member is required. Name *string @@ -68,10 +77,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 7bb3588dd1b..cb026d264cb 100644 --- a/service/wafregional/api_op_CreateWebACL.go +++ b/service/wafregional/api_op_CreateWebACL.go @@ -11,33 +11,45 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: +// // - 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 . +// 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. +// more information, see CreateRuleand UpdateRule. +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateWebACLrequest. +// +// - Submit an UpdateWebACLrequest 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]. // -// 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/) . +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -55,7 +67,7 @@ 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 @@ -76,8 +88,8 @@ type CreateWebACLInput struct { // 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 @@ -91,8 +103,7 @@ type CreateWebACLInput struct { 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 . + // use this value to query the status of the request. For more information, see 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 17bd9dbf652..845804c31ae 100644 --- a/service/wafregional/api_op_CreateWebACLMigrationStack.go +++ b/service/wafregional/api_op_CreateWebACLMigrationStack.go @@ -13,13 +13,15 @@ import ( // Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the // specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the // template, to create the web ACL and its resources in AWS WAFV2. Use this to -// migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. This is -// 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) -// . +// migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. +// +// This is 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] +// in the [AWS WAF Developer Guide]. +// +// [Migrating your AWS WAF Classic resources to AWS WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html +// [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{} @@ -47,11 +49,14 @@ type CreateWebACLMigrationStackInput struct { // 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. // diff --git a/service/wafregional/api_op_CreateXssMatchSet.go b/service/wafregional/api_op_CreateXssMatchSet.go index ee7be69950c..9e278924bb8 100644 --- a/service/wafregional/api_op_CreateXssMatchSet.go +++ b/service/wafregional/api_op_CreateXssMatchSet.go @@ -11,26 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: -// - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of a CreateXssMatchSet request. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: +// +// - Use GetChangeTokento 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. +// ChangeToken parameter of an UpdateXssMatchSetrequest. +// +// - Submit an UpdateXssMatchSetrequest 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -46,16 +55,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 . + // A friendly name or description for the XssMatchSet that you're creating. You can't change + // Name after you create the XssMatchSet . // // This member is required. Name *string @@ -68,10 +77,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 b4664781d1a..93693f6016b 100644 --- a/service/wafregional/api_op_DeleteByteMatchSet.go +++ b/service/wafregional/api_op_DeleteByteMatchSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteByteMatchSet request. +// // - Submit a DeleteByteMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteByteMatchSet(ctx context.Context, params *DeleteByteMatchSetInput, optFns ...func(*Options)) (*DeleteByteMatchSetOutput, error) { if params == nil { params = &DeleteByteMatchSetInput{} @@ -41,13 +51,13 @@ 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 . + // The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned + // by CreateByteMatchSetand 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 @@ -59,7 +69,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 aa70c777f65..c7e60a8936d 100644 --- a/service/wafregional/api_op_DeleteGeoMatchSet.go +++ b/service/wafregional/api_op_DeleteGeoMatchSet.go @@ -10,20 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteGeoMatchSet request. +// // - Submit a DeleteGeoMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteGeoMatchSet(ctx context.Context, params *DeleteGeoMatchSetInput, optFns ...func(*Options)) (*DeleteGeoMatchSetOutput, error) { if params == nil { params = &DeleteGeoMatchSetInput{} @@ -41,13 +50,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 . + // The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet + // and by ListGeoMatchSets. // // This member is required. GeoMatchSetId *string @@ -59,7 +68,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 cd9095a8356..bea3ec271cd 100644 --- a/service/wafregional/api_op_DeleteIPSet.go +++ b/service/wafregional/api_op_DeleteIPSet.go @@ -10,19 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// see UpdateIPSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteIPSet request. +// // - Submit a DeleteIPSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error) { if params == nil { params = &DeleteIPSetInput{} @@ -40,13 +51,12 @@ 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 . + // The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets. // // This member is required. IPSetId *string @@ -57,8 +67,7 @@ type DeleteIPSetInput struct { 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 . + // 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_DeleteLoggingConfiguration.go b/service/wafregional/api_op_DeleteLoggingConfiguration.go index 418f6f1ecc4..37b65afeeff 100644 --- a/service/wafregional/api_op_DeleteLoggingConfiguration.go +++ b/service/wafregional/api_op_DeleteLoggingConfiguration.go @@ -10,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error) { if params == nil { params = &DeleteLoggingConfigurationInput{} @@ -33,8 +38,8 @@ 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 . + // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration + // . // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_DeletePermissionPolicy.go b/service/wafregional/api_op_DeletePermissionPolicy.go index 7358d75de8c..4679b70a87b 100644 --- a/service/wafregional/api_op_DeletePermissionPolicy.go +++ b/service/wafregional/api_op_DeletePermissionPolicy.go @@ -10,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error) { if params == nil { params = &DeletePermissionPolicyInput{} @@ -34,7 +41,9 @@ func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermi type DeletePermissionPolicyInput struct { // The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete - // the policy. The user making the request must be the owner of the RuleGroup. + // the policy. + // + // The user making the request must be the owner of the RuleGroup. // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_DeleteRateBasedRule.go b/service/wafregional/api_op_DeleteRateBasedRule.go index 5e30fa48f52..e8dc851a2a8 100644 --- a/service/wafregional/api_op_DeleteRateBasedRule.go +++ b/service/wafregional/api_op_DeleteRateBasedRule.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// see UpdateRateBasedRule. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRateBasedRule request. +// // - Submit a DeleteRateBasedRule request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRateBasedRule(ctx context.Context, params *DeleteRateBasedRuleInput, optFns ...func(*Options)) (*DeleteRateBasedRuleOutput, error) { if params == nil { params = &DeleteRateBasedRuleInput{} @@ -41,13 +51,12 @@ 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 . + // The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. // // This member is required. RuleId *string @@ -59,7 +68,7 @@ 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 . + // 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 c7948e26501..9e3cac8b7ea 100644 --- a/service/wafregional/api_op_DeleteRegexMatchSet.go +++ b/service/wafregional/api_op_DeleteRegexMatchSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// see UpdateRegexMatchSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRegexMatchSet request. +// // - Submit a DeleteRegexMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRegexMatchSet(ctx context.Context, params *DeleteRegexMatchSetInput, optFns ...func(*Options)) (*DeleteRegexMatchSetOutput, error) { if params == nil { params = &DeleteRegexMatchSetInput{} @@ -41,13 +51,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 . + // The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is + // returned by CreateRegexMatchSetand by ListRegexMatchSets. // // This member is required. RegexMatchSetId *string @@ -59,7 +69,7 @@ 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 . + // 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 27ecadd173c..fb3217907eb 100644 --- a/service/wafregional/api_op_DeleteRegexPatternSet.go +++ b/service/wafregional/api_op_DeleteRegexPatternSet.go @@ -10,13 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error) { if params == nil { params = &DeleteRegexPatternSetInput{} @@ -34,14 +39,13 @@ 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 . + // The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is + // returned by CreateRegexPatternSetand by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -53,7 +57,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 ce3101db724..070432ccff9 100644 --- a/service/wafregional/api_op_DeleteRule.go +++ b/service/wafregional/api_op_DeleteRule.go @@ -10,20 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRule request. +// // - Submit a DeleteRule request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error) { if params == nil { params = &DeleteRuleInput{} @@ -41,13 +50,12 @@ 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 . + // The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules. // // This member is required. RuleId *string @@ -58,8 +66,7 @@ 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 . + // 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 0b371971a4f..97110e08538 100644 --- a/service/wafregional/api_op_DeleteRuleGroup.go +++ b/service/wafregional/api_op_DeleteRuleGroup.go @@ -10,19 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteRuleGroup request. +// // - Submit a DeleteRuleGroup request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error) { if params == nil { params = &DeleteRuleGroupInput{} @@ -40,13 +50,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 . + // The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup + // and by ListRuleGroups. // // This member is required. RuleGroupId *string @@ -58,7 +68,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 a6f8a38ee8a..1e10eb98e5e 100644 --- a/service/wafregional/api_op_DeleteSizeConstraintSet.go +++ b/service/wafregional/api_op_DeleteSizeConstraintSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// information, see UpdateSizeConstraintSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteSizeConstraintSet request. +// // - Submit a DeleteSizeConstraintSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteSizeConstraintSet(ctx context.Context, params *DeleteSizeConstraintSetInput, optFns ...func(*Options)) (*DeleteSizeConstraintSetOutput, error) { if params == nil { params = &DeleteSizeConstraintSetInput{} @@ -41,14 +51,13 @@ 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 . + // The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is + // returned by CreateSizeConstraintSetand by ListSizeConstraintSets. // // This member is required. SizeConstraintSetId *string @@ -60,7 +69,7 @@ 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 . + // 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 6966fbcb3f9..745956690ae 100644 --- a/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_DeleteSqlInjectionMatchSet.go @@ -10,20 +10,31 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// information, see UpdateSqlInjectionMatchSet. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteSqlInjectionMatchSet request. +// // - Submit a DeleteSqlInjectionMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteSqlInjectionMatchSet(ctx context.Context, params *DeleteSqlInjectionMatchSetInput, optFns ...func(*Options)) (*DeleteSqlInjectionMatchSetOutput, error) { if params == nil { params = &DeleteSqlInjectionMatchSetInput{} @@ -42,14 +53,13 @@ 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 . + // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. // // This member is required. SqlInjectionMatchSetId *string @@ -62,7 +72,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 3f1603789d6..d22cd7cd55c 100644 --- a/service/wafregional/api_op_DeleteWebACL.go +++ b/service/wafregional/api_op_DeleteWebACL.go @@ -10,17 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteWebACL request. +// // - Submit a DeleteWebACL request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error) { if params == nil { params = &DeleteWebACLInput{} @@ -38,13 +48,12 @@ 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 . + // The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs. // // This member is required. WebACLId *string @@ -55,8 +64,7 @@ type DeleteWebACLInput struct { 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 . + // 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_DeleteXssMatchSet.go b/service/wafregional/api_op_DeleteXssMatchSet.go index 356411f2278..9ba4c3010eb 100644 --- a/service/wafregional/api_op_DeleteXssMatchSet.go +++ b/service/wafregional/api_op_DeleteXssMatchSet.go @@ -10,20 +10,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// a DeleteXssMatchSet request. +// // - Submit a DeleteXssMatchSet request. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DeleteXssMatchSet(ctx context.Context, params *DeleteXssMatchSetInput, optFns ...func(*Options)) (*DeleteXssMatchSetOutput, error) { if params == nil { params = &DeleteXssMatchSetInput{} @@ -42,13 +52,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 . + // The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet + // and by ListXssMatchSets. // // This member is required. XssMatchSetId *string @@ -61,7 +71,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 274350951f6..320d6e6e117 100644 --- a/service/wafregional/api_op_DisassociateWebACL.go +++ b/service/wafregional/api_op_DisassociateWebACL.go @@ -10,13 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic Regional documentation. For more information, see [AWS WAF Classic] in +// the developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWebACLInput, optFns ...func(*Options)) (*DisassociateWebACLOutput, error) { if params == nil { params = &DisassociateWebACLInput{} @@ -35,8 +40,10 @@ func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWeb 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: + // 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 // diff --git a/service/wafregional/api_op_GetByteMatchSet.go b/service/wafregional/api_op_GetByteMatchSet.go index 4f8e587f646..8d436ed71f7 100644 --- a/service/wafregional/api_op_GetByteMatchSet.go +++ b/service/wafregional/api_op_GetByteMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the ByteMatchSet specified by ByteMatchSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetByteMatchSet(ctx context.Context, params *GetByteMatchSetInput, optFns ...func(*Options)) (*GetByteMatchSetOutput, error) { if params == nil { params = &GetByteMatchSetInput{} @@ -33,8 +39,8 @@ 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 . + // The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet + // and by ListByteMatchSets. // // This member is required. ByteMatchSetId *string @@ -44,13 +50,17 @@ type GetByteMatchSetInput struct { 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 + // 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 ByteMatchTupleobjects. 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 23aea3a3e12..f1dc2204373 100644 --- a/service/wafregional/api_op_GetChangeToken.go +++ b/service/wafregional/api_op_GetChangeToken.go @@ -10,21 +10,31 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// indicates that AWS WAF is propagating the change to all AWS WAF servers. Use -// GetChangeTokenStatus to determine the status of your change token. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 indicates that AWS WAF is +// propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to +// determine the status of your change token. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetChangeToken(ctx context.Context, params *GetChangeTokenInput, optFns ...func(*Options)) (*GetChangeTokenOutput, error) { if params == nil { params = &GetChangeTokenInput{} diff --git a/service/wafregional/api_op_GetChangeTokenStatus.go b/service/wafregional/api_op_GetChangeTokenStatus.go index d287eaae33c..2fc004347d8 100644 --- a/service/wafregional/api_op_GetChangeTokenStatus.go +++ b/service/wafregional/api_op_GetChangeTokenStatus.go @@ -11,18 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 b53d1551a5e..a75801287b1 100644 --- a/service/wafregional/api_op_GetGeoMatchSet.go +++ b/service/wafregional/api_op_GetGeoMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetGeoMatchSet(ctx context.Context, params *GetGeoMatchSetInput, optFns ...func(*Options)) (*GetGeoMatchSetOutput, error) { if params == nil { params = &GetGeoMatchSetInput{} @@ -33,8 +39,8 @@ 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 . + // The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet + // and by ListGeoMatchSets. // // This member is required. GeoMatchSetId *string @@ -44,9 +50,9 @@ 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. + // 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. 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 f7c2ea2a677..003f65bdbc5 100644 --- a/service/wafregional/api_op_GetIPSet.go +++ b/service/wafregional/api_op_GetIPSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error) { if params == nil { params = &GetIPSetInput{} @@ -33,8 +39,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 . + // The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets. // // This member is required. IPSetId *string @@ -44,11 +49,14 @@ 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 IPSetDescriptorobjects. 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 71fc0a5a17f..9ab64998483 100644 --- a/service/wafregional/api_op_GetLoggingConfiguration.go +++ b/service/wafregional/api_op_GetLoggingConfiguration.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLoggingConfigurationInput, optFns ...func(*Options)) (*GetLoggingConfigurationOutput, error) { if params == nil { params = &GetLoggingConfigurationInput{} @@ -33,8 +39,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 . + // The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. // // This member is required. ResourceArn *string diff --git a/service/wafregional/api_op_GetPermissionPolicy.go b/service/wafregional/api_op_GetPermissionPolicy.go index 2b7df45e3be..e289eadd1b5 100644 --- a/service/wafregional/api_op_GetPermissionPolicy.go +++ b/service/wafregional/api_op_GetPermissionPolicy.go @@ -10,11 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 c9f7420853a..e864580064c 100644 --- a/service/wafregional/api_op_GetRateBasedRule.go +++ b/service/wafregional/api_op_GetRateBasedRule.go @@ -11,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRateBasedRule(ctx context.Context, params *GetRateBasedRuleInput, optFns ...func(*Options)) (*GetRateBasedRuleOutput, error) { if params == nil { params = &GetRateBasedRuleInput{} @@ -34,8 +40,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 . + // The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. // // This member is required. RuleId *string @@ -45,8 +50,7 @@ type GetRateBasedRuleInput struct { type GetRateBasedRuleOutput struct { - // Information about the RateBasedRule that you specified in the GetRateBasedRule - // request. + // Information about the RateBasedRule that you specified in the GetRateBasedRule request. Rule *types.RateBasedRule // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go b/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go index 7b68db2c495..4d745a98ba0 100644 --- a/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go +++ b/service/wafregional/api_op_GetRateBasedRuleManagedKeys.go @@ -10,14 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRateBasedRuleManagedKeys(ctx context.Context, params *GetRateBasedRuleManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedRuleManagedKeysOutput, error) { if params == nil { params = &GetRateBasedRuleManagedKeysInput{} @@ -35,8 +41,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 CreateRateBasedRuleand by ListRateBasedRules. // // This member is required. RuleId *string @@ -49,8 +55,7 @@ type GetRateBasedRuleManagedKeysInput struct { type GetRateBasedRuleManagedKeysOutput struct { - // An array of IP addresses that currently are blocked by the specified - // RateBasedRule . + // An array of IP addresses that currently are blocked by the specified 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 07d7a6a60a2..0beb1f26e31 100644 --- a/service/wafregional/api_op_GetRegexMatchSet.go +++ b/service/wafregional/api_op_GetRegexMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the RegexMatchSet specified by RegexMatchSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRegexMatchSet(ctx context.Context, params *GetRegexMatchSetInput, optFns ...func(*Options)) (*GetRegexMatchSetOutput, error) { if params == nil { params = &GetRegexMatchSetInput{} @@ -33,8 +39,8 @@ 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 . + // The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned + // by CreateRegexMatchSetand by ListRegexMatchSets. // // This member is required. RegexMatchSetId *string @@ -44,8 +50,8 @@ type GetRegexMatchSetInput struct { type GetRegexMatchSetOutput struct { - // Information about the RegexMatchSet that you specified in the GetRegexMatchSet - // request. For more information, see RegexMatchTuple . + // Information about the RegexMatchSet that you specified in the GetRegexMatchSet 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 22f612bfedb..ded37b30f5d 100644 --- a/service/wafregional/api_op_GetRegexPatternSet.go +++ b/service/wafregional/api_op_GetRegexPatternSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the RegexPatternSet specified by RegexPatternSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error) { if params == nil { params = &GetRegexPatternSetInput{} @@ -33,9 +39,8 @@ func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPattern type GetRegexPatternSetInput struct { - // The RegexPatternSetId of the RegexPatternSet that you want to get. - // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets . + // The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is + // returned by CreateRegexPatternSetand by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -45,9 +50,9 @@ type GetRegexPatternSetInput struct { type GetRegexPatternSetOutput struct { - // Information about the RegexPatternSet that you specified in the - // GetRegexPatternSet request, including the identifier of the pattern set and the - // regular expression patterns you want AWS WAF to search for. + // Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, + // including the identifier of the pattern set and the regular expression patterns + // you want AWS WAF to search for. RegexPatternSet *types.RegexPatternSet // Metadata pertaining to the operation's result. diff --git a/service/wafregional/api_op_GetRule.go b/service/wafregional/api_op_GetRule.go index 01e980f10b6..60d48119667 100644 --- a/service/wafregional/api_op_GetRule.go +++ b/service/wafregional/api_op_GetRule.go @@ -11,12 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRule(ctx context.Context, params *GetRuleInput, optFns ...func(*Options)) (*GetRuleOutput, error) { if params == nil { params = &GetRuleInput{} @@ -34,8 +40,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 . + // The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules. // // This member is required. RuleId *string @@ -47,9 +52,12 @@ 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 8a91271f74e..6bee6f72951 100644 --- a/service/wafregional/api_op_GetRuleGroup.go +++ b/service/wafregional/api_op_GetRuleGroup.go @@ -11,13 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error) { if params == nil { params = &GetRuleGroupInput{} @@ -35,8 +42,8 @@ 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 . + // The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned 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 0cf1c5dbcb0..784972c8c09 100644 --- a/service/wafregional/api_op_GetSampledRequests.go +++ b/service/wafregional/api_op_GetSampledRequests.go @@ -11,20 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledRequestsInput, optFns ...func(*Options)) (*GetSampledRequestsOutput, error) { if params == nil { params = &GetSampledRequestsInput{} @@ -51,8 +58,10 @@ type GetSampledRequestsInput struct { 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 . // diff --git a/service/wafregional/api_op_GetSizeConstraintSet.go b/service/wafregional/api_op_GetSizeConstraintSet.go index 88f28a09d13..484bd22ef52 100644 --- a/service/wafregional/api_op_GetSizeConstraintSet.go +++ b/service/wafregional/api_op_GetSizeConstraintSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns the SizeConstraintSet specified by SizeConstraintSetId . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetSizeConstraintSet(ctx context.Context, params *GetSizeConstraintSetInput, optFns ...func(*Options)) (*GetSizeConstraintSetOutput, error) { if params == nil { params = &GetSizeConstraintSetInput{} @@ -33,9 +39,8 @@ func (c *Client) GetSizeConstraintSet(ctx context.Context, params *GetSizeConstr type GetSizeConstraintSetInput struct { - // The SizeConstraintSetId of the SizeConstraintSet that you want to get. - // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets . + // The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is + // returned by CreateSizeConstraintSetand by ListSizeConstraintSets. // // This member is required. SizeConstraintSetId *string @@ -45,14 +50,17 @@ type GetSizeConstraintSetInput struct { 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 + // 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 SizeConstraintobjects. 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 fe364a166da..00577a6dc07 100644 --- a/service/wafregional/api_op_GetSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_GetSqlInjectionMatchSet.go @@ -11,12 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetSqlInjectionMatchSet(ctx context.Context, params *GetSqlInjectionMatchSetInput, optFns ...func(*Options)) (*GetSqlInjectionMatchSetOutput, error) { if params == nil { params = &GetSqlInjectionMatchSetInput{} @@ -32,12 +37,11 @@ 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 . + // The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId + // is returned by CreateSqlInjectionMatchSetand by ListSqlInjectionMatchSets. // // This member is required. SqlInjectionMatchSetId *string @@ -48,13 +52,19 @@ type GetSqlInjectionMatchSetInput struct { // The response to a GetSqlInjectionMatchSet request. 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 + // 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 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 d7dcd952947..8799ad71726 100644 --- a/service/wafregional/api_op_GetWebACL.go +++ b/service/wafregional/api_op_GetWebACL.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error) { if params == nil { params = &GetWebACLInput{} @@ -33,8 +39,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 . + // The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs. // // This member is required. WebACLId *string @@ -44,13 +49,18 @@ type GetWebACLInput struct { 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 + // 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 *types.WebACL diff --git a/service/wafregional/api_op_GetWebACLForResource.go b/service/wafregional/api_op_GetWebACLForResource.go index 8bf9413686d..4e9b2035030 100644 --- a/service/wafregional/api_op_GetWebACLForResource.go +++ b/service/wafregional/api_op_GetWebACLForResource.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic Regional documentation. For more information, see [AWS WAF Classic] in +// the developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForResourceInput, optFns ...func(*Options)) (*GetWebACLForResourceOutput, error) { if params == nil { params = &GetWebACLForResourceInput{} @@ -36,8 +41,10 @@ func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForR 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: + // 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 // diff --git a/service/wafregional/api_op_GetXssMatchSet.go b/service/wafregional/api_op_GetXssMatchSet.go index 0890183f10f..128ca7eefe2 100644 --- a/service/wafregional/api_op_GetXssMatchSet.go +++ b/service/wafregional/api_op_GetXssMatchSet.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) GetXssMatchSet(ctx context.Context, params *GetXssMatchSetInput, optFns ...func(*Options)) (*GetXssMatchSetOutput, error) { if params == nil { params = &GetXssMatchSetInput{} @@ -31,11 +37,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 . + // The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet + // and by ListXssMatchSets. // // This member is required. XssMatchSetId *string @@ -46,13 +52,17 @@ type GetXssMatchSetInput struct { // The response to a GetXssMatchSet request. 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 + // 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 *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 ae6b90ab9c6..b3f3d915e51 100644 --- a/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go +++ b/service/wafregional/api_op_ListActivatedRulesInRuleGroup.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of ActivatedRule objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListActivatedRulesInRuleGroup(ctx context.Context, params *ListActivatedRulesInRuleGroupInput, optFns ...func(*Options)) (*ListActivatedRulesInRuleGroupOutput, error) { if params == nil { params = &ListActivatedRulesInRuleGroupInput{} @@ -46,8 +52,7 @@ type ListActivatedRulesInRuleGroupInput struct { // 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 - // ActivatedRule objects. + // The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects. RuleGroupId *string noSmithyDocumentSerde diff --git a/service/wafregional/api_op_ListByteMatchSets.go b/service/wafregional/api_op_ListByteMatchSets.go index a01f3b7c8d3..a650ff528b6 100644 --- a/service/wafregional/api_op_ListByteMatchSets.go +++ b/service/wafregional/api_op_ListByteMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of ByteMatchSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListByteMatchSets(ctx context.Context, params *ListByteMatchSetsInput, optFns ...func(*Options)) (*ListByteMatchSetsOutput, error) { if params == nil { params = &ListByteMatchSetsInput{} diff --git a/service/wafregional/api_op_ListGeoMatchSets.go b/service/wafregional/api_op_ListGeoMatchSets.go index d15426c3a42..d740bdfdb5e 100644 --- a/service/wafregional/api_op_ListGeoMatchSets.go +++ b/service/wafregional/api_op_ListGeoMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListGeoMatchSets(ctx context.Context, params *ListGeoMatchSetsInput, optFns ...func(*Options)) (*ListGeoMatchSetsOutput, error) { if params == nil { params = &ListGeoMatchSetsInput{} diff --git a/service/wafregional/api_op_ListIPSets.go b/service/wafregional/api_op_ListIPSets.go index c164534df49..1c20942e094 100644 --- a/service/wafregional/api_op_ListIPSets.go +++ b/service/wafregional/api_op_ListIPSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns ...func(*Options)) (*ListIPSetsOutput, error) { if params == nil { params = &ListIPSetsInput{} diff --git a/service/wafregional/api_op_ListLoggingConfigurations.go b/service/wafregional/api_op_ListLoggingConfigurations.go index 1e42ca618e6..6b32621066b 100644 --- a/service/wafregional/api_op_ListLoggingConfigurations.go +++ b/service/wafregional/api_op_ListLoggingConfigurations.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of LoggingConfiguration objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error) { if params == nil { params = &ListLoggingConfigurationsInput{} diff --git a/service/wafregional/api_op_ListRateBasedRules.go b/service/wafregional/api_op_ListRateBasedRules.go index b9c065143fe..9ea3d5b5753 100644 --- a/service/wafregional/api_op_ListRateBasedRules.go +++ b/service/wafregional/api_op_ListRateBasedRules.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RuleSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRateBasedRules(ctx context.Context, params *ListRateBasedRulesInput, optFns ...func(*Options)) (*ListRateBasedRulesOutput, error) { if params == nil { params = &ListRateBasedRulesInput{} diff --git a/service/wafregional/api_op_ListRegexMatchSets.go b/service/wafregional/api_op_ListRegexMatchSets.go index 3d946ac2ac6..5094af30fc2 100644 --- a/service/wafregional/api_op_ListRegexMatchSets.go +++ b/service/wafregional/api_op_ListRegexMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RegexMatchSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRegexMatchSets(ctx context.Context, params *ListRegexMatchSetsInput, optFns ...func(*Options)) (*ListRegexMatchSetsOutput, error) { if params == nil { params = &ListRegexMatchSetsInput{} diff --git a/service/wafregional/api_op_ListRegexPatternSets.go b/service/wafregional/api_op_ListRegexPatternSets.go index 6e79d832729..b01e60c39d9 100644 --- a/service/wafregional/api_op_ListRegexPatternSets.go +++ b/service/wafregional/api_op_ListRegexPatternSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RegexPatternSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error) { if params == nil { params = &ListRegexPatternSetsInput{} diff --git a/service/wafregional/api_op_ListResourcesForWebACL.go b/service/wafregional/api_op_ListResourcesForWebACL.go index 7e34dd55e07..e7a8c62404e 100644 --- a/service/wafregional/api_op_ListResourcesForWebACL.go +++ b/service/wafregional/api_op_ListResourcesForWebACL.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic Regional documentation. For more information, see [AWS WAF Classic] in +// the developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 b2113287a3c..9b575e97e6a 100644 --- a/service/wafregional/api_op_ListRuleGroups.go +++ b/service/wafregional/api_op_ListRuleGroups.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RuleGroup objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error) { if params == nil { params = &ListRuleGroupsInput{} diff --git a/service/wafregional/api_op_ListRules.go b/service/wafregional/api_op_ListRules.go index 4cae981579d..b8a369347f9 100644 --- a/service/wafregional/api_op_ListRules.go +++ b/service/wafregional/api_op_ListRules.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of RuleSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error) { if params == nil { params = &ListRulesInput{} diff --git a/service/wafregional/api_op_ListSizeConstraintSets.go b/service/wafregional/api_op_ListSizeConstraintSets.go index 22a6f43fa46..8c4bcdcf68b 100644 --- a/service/wafregional/api_op_ListSizeConstraintSets.go +++ b/service/wafregional/api_op_ListSizeConstraintSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of SizeConstraintSetSummary objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListSizeConstraintSets(ctx context.Context, params *ListSizeConstraintSetsInput, optFns ...func(*Options)) (*ListSizeConstraintSetsOutput, error) { if params == nil { params = &ListSizeConstraintSetsInput{} diff --git a/service/wafregional/api_op_ListSqlInjectionMatchSets.go b/service/wafregional/api_op_ListSqlInjectionMatchSets.go index 471f4d6ecbf..8f055ad857e 100644 --- a/service/wafregional/api_op_ListSqlInjectionMatchSets.go +++ b/service/wafregional/api_op_ListSqlInjectionMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of SqlInjectionMatchSet objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlInjectionMatchSetsInput, optFns ...func(*Options)) (*ListSqlInjectionMatchSetsOutput, error) { if params == nil { params = &ListSqlInjectionMatchSetsInput{} @@ -31,21 +37,20 @@ func (c *Client) ListSqlInjectionMatchSets(ctx context.Context, params *ListSqlI return out, nil } -// A request to list the SqlInjectionMatchSet objects created by the current AWS -// account. +// A request to list the SqlInjectionMatchSet objects created by the current AWS account. 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 . + // 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 . 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 + // 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 . NextMarker *string @@ -55,11 +60,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 144fbf71b40..b7428f23d94 100644 --- a/service/wafregional/api_op_ListSubscribedRuleGroups.go +++ b/service/wafregional/api_op_ListSubscribedRuleGroups.go @@ -11,12 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListSubscribedRuleGroups(ctx context.Context, params *ListSubscribedRuleGroupsInput, optFns ...func(*Options)) (*ListSubscribedRuleGroupsOutput, error) { if params == nil { params = &ListSubscribedRuleGroupsInput{} diff --git a/service/wafregional/api_op_ListTagsForResource.go b/service/wafregional/api_op_ListTagsForResource.go index 1fe7892aa88..a40b16f69ac 100644 --- a/service/wafregional/api_op_ListTagsForResource.go +++ b/service/wafregional/api_op_ListTagsForResource.go @@ -11,18 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/wafregional/api_op_ListWebACLs.go b/service/wafregional/api_op_ListWebACLs.go index 1e3666bd937..8dba3bc926c 100644 --- a/service/wafregional/api_op_ListWebACLs.go +++ b/service/wafregional/api_op_ListWebACLs.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optFns ...func(*Options)) (*ListWebACLsOutput, error) { if params == nil { params = &ListWebACLsInput{} diff --git a/service/wafregional/api_op_ListXssMatchSets.go b/service/wafregional/api_op_ListXssMatchSets.go index f4c24712a04..16e2aafefc6 100644 --- a/service/wafregional/api_op_ListXssMatchSets.go +++ b/service/wafregional/api_op_ListXssMatchSets.go @@ -11,11 +11,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// Returns an array of XssMatchSet objects. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsInput, optFns ...func(*Options)) (*ListXssMatchSetsOutput, error) { if params == nil { params = &ListXssMatchSetsInput{} @@ -34,15 +40,15 @@ func (c *Client) ListXssMatchSets(ctx context.Context, params *ListXssMatchSetsI // A request to list the XssMatchSet objects created by the current AWS account. 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 + // 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 . 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 + // 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 // ListXssMatchSets requests, specify the value of NextMarker from the previous // response to get information about another batch of XssMatchSets . NextMarker *string @@ -53,10 +59,10 @@ type ListXssMatchSetsInput struct { // The response to a ListXssMatchSets request. type ListXssMatchSetsOutput struct { - // If you have more XssMatchSet objects than the number that you specified for - // Limit in the request, the response includes a NextMarker value. To list more - // XssMatchSet objects, submit another ListXssMatchSets request, and specify the - // NextMarker value from the response in the NextMarker value in the next request. + // If you have more XssMatchSet objects than the number that you specified for Limit in the + // request, the response includes a NextMarker value. To list more XssMatchSet + // objects, submit another ListXssMatchSets request, and specify the NextMarker + // value from the response in the NextMarker value in the next request. NextMarker *string // An array of XssMatchSetSummary objects. diff --git a/service/wafregional/api_op_PutLoggingConfiguration.go b/service/wafregional/api_op_PutLoggingConfiguration.go index 595db05791c..989496b2014 100644 --- a/service/wafregional/api_op_PutLoggingConfiguration.go +++ b/service/wafregional/api_op_PutLoggingConfiguration.go @@ -11,25 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// - 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. +// write logs to the Amazon Kinesis Data Firehose. For more information, see [Logging Web ACL Traffic Information]in +// the AWS WAF Developer Guide. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [Logging Web ACL Traffic Information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error) { if params == nil { params = &PutLoggingConfigurationInput{} @@ -49,8 +62,10 @@ 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 b207180b3bf..a8775b293bc 100644 --- a/service/wafregional/api_op_PutPermissionPolicy.go +++ b/service/wafregional/api_op_PutPermissionPolicy.go @@ -10,27 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. // -// 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]. +// +// An example of a valid policy parameter is shown in the Examples section below. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html 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 237f16cd58a..e17a9e94ff1 100644 --- a/service/wafregional/api_op_TagResource.go +++ b/service/wafregional/api_op_TagResource.go @@ -11,18 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 79d0580d4f7..653851d4c46 100644 --- a/service/wafregional/api_op_UntagResource.go +++ b/service/wafregional/api_op_UntagResource.go @@ -10,11 +10,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 54af2d83551..e64bc3ae4a4 100644 --- a/service/wafregional/api_op_UpdateByteMatchSet.go +++ b/service/wafregional/api_op_UpdateByteMatchSet.go @@ -11,40 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// the ByteMatchTupledata 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. +// 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 GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -62,23 +75,29 @@ 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 . + // The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned + // by CreateByteMatchSetand 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 @@ -90,7 +109,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 bf035b0be8f..23f0380f11d 100644 --- a/service/wafregional/api_op_UpdateGeoMatchSet.go +++ b/service/wafregional/api_op_UpdateGeoMatchSet.go @@ -11,32 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 -// . +// 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 a CreateGeoMatchSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateGeoMatchSetrequest. +// // - 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/) . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -54,23 +66,28 @@ 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 . + // The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is 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 @@ -82,7 +99,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 5083e9ea017..7803cdb573d 100644 --- a/service/wafregional/api_op_UpdateIPSet.go +++ b/service/wafregional/api_op_UpdateIPSet.go @@ -11,48 +11,68 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 ). // // 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: +// more information about CIDR notation, see the Wikipedia entry [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. +// addresses, and then configure AWS WAF to block the requests. +// +// To create and configure an IPSet , perform the following steps: +// +// - Submit a CreateIPSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateIPSetrequest. +// // - 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/) . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/ +// [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error) { if params == nil { params = &UpdateIPSetInput{} @@ -70,21 +90,25 @@ 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 . + // The IPSetId of the IPSet that you want to update. IPSetId is returned by 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 + // 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 + // // You can insert a maximum of 1000 addresses in a single request. // // This member is required. @@ -96,8 +120,7 @@ type UpdateIPSetInput struct { 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 . + // 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_UpdateRateBasedRule.go b/service/wafregional/api_op_UpdateRateBasedRule.go index 216355aacd6..fa63e1e92dc 100644 --- a/service/wafregional/api_op_UpdateRateBasedRule.go +++ b/service/wafregional/api_op_UpdateRateBasedRule.go @@ -11,37 +11,52 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 : +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 : +// // - An IPSet that matches the IP address 192.0.2.44/32 +// // - 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 : +// 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html func (c *Client) UpdateRateBasedRule(ctx context.Context, params *UpdateRateBasedRuleInput, optFns ...func(*Options)) (*UpdateRateBasedRuleOutput, error) { if params == nil { params = &UpdateRateBasedRuleInput{} @@ -59,7 +74,7 @@ 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 @@ -73,13 +88,12 @@ 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 . + // An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule. // // This member is required. Updates []types.RuleUpdate @@ -91,7 +105,7 @@ 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 . + // 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 7bf3d4967fd..d544457f3e1 100644 --- a/service/wafregional/api_op_UpdateRegexMatchSet.go +++ b/service/wafregional/api_op_UpdateRegexMatchSet.go @@ -11,38 +11,50 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// 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. +// 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 GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -60,19 +72,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 . + // The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is + // returned by CreateRegexMatchSetand 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 @@ -84,7 +96,7 @@ 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 . + // 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 d212455d524..2942c94c08c 100644 --- a/service/wafregional/api_op_UpdateRegexPatternSet.go +++ b/service/wafregional/api_op_UpdateRegexPatternSet.go @@ -11,34 +11,47 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// information, see RegexPatternSet. // // 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. +// +// - Create a RegexPatternSet. For more information, see CreateRegexPatternSet. +// +// - Use GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -56,20 +69,19 @@ 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 . + // The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is + // returned by CreateRegexPatternSetand by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string // An array of RegexPatternSetUpdate objects that you want to insert into or - // delete from a RegexPatternSet . + // delete from a RegexPatternSet. // // This member is required. Updates []types.RegexPatternSetUpdate @@ -81,7 +93,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 aae8d6fb1d3..df7fd3a4e99 100644 --- a/service/wafregional/api_op_UpdateRule.go +++ b/service/wafregional/api_op_UpdateRule.go @@ -11,35 +11,49 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// specifications to be allowed, blocked, or counted. For example, suppose that you -// add the following to a Rule : +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 ByteMatchSetor 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 specifications to be allowed, blocked, or counted. For +// example, suppose that you 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 // // 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: +// 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 . +// +// - Create the Rule . See CreateRule. +// // - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateRule request. +// ChangeToken parameter of an UpdateRulerequest. +// // - Submit an UpdateRule request to add predicates to the Rule . -// - Create and update a WebACL that contains the Rule . See CreateWebACL . +// +// - 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/) -// . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -57,22 +71,28 @@ 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 + // 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 // // This member is required. Updates []types.RuleUpdate @@ -83,8 +103,7 @@ 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 . + // 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 13cd97e1797..a409c538a56 100644 --- a/service/wafregional/api_op_UpdateRuleGroup.go +++ b/service/wafregional/api_op_UpdateRuleGroup.go @@ -11,25 +11,39 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// ChangeToken parameter of an UpdateRuleGrouprequest. +// // - Submit an UpdateRuleGroup request to add Rules to the RuleGroup . -// - Create and update a WebACL that contains the RuleGroup . See CreateWebACL . +// +// - 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/) -// . +// 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -47,19 +61,22 @@ 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 . + // The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is 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. + // 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 @@ -75,7 +92,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 01cf16777b8..4639ff92bd7 100644 --- a/service/wafregional/api_op_UpdateSizeConstraintSet.go +++ b/service/wafregional/api_op_UpdateSizeConstraintSet.go @@ -11,44 +11,57 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// 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. +// 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 GetChangeTokento 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -66,25 +79,28 @@ 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 . + // The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is + // returned by CreateSizeConstraintSetand by 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 - // types: - // - SizeConstraintSetUpdate : Contains Action and SizeConstraint - // - SizeConstraint : Contains FieldToMatch , TextTransformation , - // ComparisonOperator , and Size - // - FieldToMatch : Contains Data and Type + // 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 // // This member is required. Updates []types.SizeConstraintSetUpdate @@ -96,7 +112,7 @@ 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 . + // 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 f873302f853..045385c88f2 100644 --- a/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go +++ b/service/wafregional/api_op_UpdateSqlInjectionMatchSet.go @@ -11,38 +11,50 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// 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 // 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. +// and then configure AWS WAF to block the requests. +// +// To create and configure a SqlInjectionMatchSet , perform the following steps: +// +// - Submit a CreateSqlInjectionMatchSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateIPSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -58,27 +70,31 @@ 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 . + // SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by 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 - // data types: - // - SqlInjectionMatchSetUpdate : Contains Action and SqlInjectionMatchTuple - // - SqlInjectionMatchTuple : Contains FieldToMatch and TextTransformation - // - FieldToMatch : Contains Data and Type + // 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 // // This member is required. Updates []types.SqlInjectionMatchSetUpdate @@ -91,7 +107,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 40a92bce27c..02eeefed962 100644 --- a/service/wafregional/api_op_UpdateWebACL.go +++ b/service/wafregional/api_op_UpdateWebACL.go @@ -11,20 +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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 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 @@ -34,30 +41,42 @@ import ( // 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 . +// 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 . +// more information, see CreateRuleand UpdateRule. +// +// - Create a WebACL . See CreateWebACL. +// // - Use GetChangeToken to get the change token that you provide in the -// ChangeToken parameter of an UpdateWebACL request. +// ChangeToken parameter of an UpdateWebACLrequest. +// // - 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 . +// 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 -// 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/) -// . +// the rule type when first creating the rule, the UpdateWebACLrequest 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -75,13 +94,12 @@ 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 . + // The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs. // // This member is required. WebACLId *string @@ -91,16 +109,23 @@ 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 + // 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 + // + // WafAction + // - : Contains Type Updates []types.WebACLUpdate noSmithyDocumentSerde @@ -109,8 +134,7 @@ type UpdateWebACLInput struct { 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 . + // 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_UpdateXssMatchSet.go b/service/wafregional/api_op_UpdateXssMatchSet.go index e744e7dcad9..56c54a7009e 100644 --- a/service/wafregional/api_op_UpdateXssMatchSet.go +++ b/service/wafregional/api_op_UpdateXssMatchSet.go @@ -11,37 +11,50 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// 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. +// then configure AWS WAF to block the requests. +// +// To create and configure an XssMatchSet , perform the following steps: +// +// - Submit a CreateXssMatchSetrequest. +// +// - Use GetChangeTokento get the change token that you provide in the ChangeToken parameter of +// an UpdateIPSetrequest. +// // - 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/) -// . +// requests, see the [AWS WAF Developer Guide]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [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{} @@ -57,25 +70,31 @@ 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 CreateXssMatchSetand by ListXssMatchSets. // // This member is required. XssMatchSetId *string @@ -88,7 +107,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 6e574a74bf6..e872479450a 100644 --- a/service/wafregional/doc.go +++ b/service/wafregional/doc.go @@ -3,20 +3,24 @@ // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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) -// in the developer guide. +// This is AWS WAF Classic Regional documentation. For more information, see [AWS WAF Classic] in +// the developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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]. 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]in the developer guide. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [AWS Regions and Endpoints]: https://docs.aws.amazon.com/general/latest/gr/rande.html#waf_region package wafregional diff --git a/service/wafregional/options.go b/service/wafregional/options.go index 8139ebd1ed6..1101ed7fdf6 100644 --- a/service/wafregional/options.go +++ b/service/wafregional/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/wafregional/types/enums.go b/service/wafregional/types/enums.go index 00c6dc5b5ef..2e27ccb2f8c 100644 --- a/service/wafregional/types/enums.go +++ b/service/wafregional/types/enums.go @@ -11,8 +11,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for ChangeTokenStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ChangeTokenStatus) Values() []ChangeTokenStatus { return []ChangeTokenStatus{ "PROVISIONED", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQ", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for GeoMatchConstraintType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoMatchConstraintType) Values() []GeoMatchConstraintType { return []GeoMatchConstraintType{ "Country", @@ -338,8 +342,9 @@ const ( ) // Values returns all known values for GeoMatchConstraintValue. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (GeoMatchConstraintValue) Values() []GeoMatchConstraintValue { return []GeoMatchConstraintValue{ "AF", @@ -603,8 +608,9 @@ const ( ) // Values returns all known values for IPSetDescriptorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IPSetDescriptorType) Values() []IPSetDescriptorType { return []IPSetDescriptorType{ "IPV4", @@ -626,8 +632,9 @@ const ( ) // Values returns all known values for MatchFieldType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MatchFieldType) Values() []MatchFieldType { return []MatchFieldType{ "URI", @@ -654,8 +661,9 @@ const ( ) // Values returns all known values for MigrationErrorType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MigrationErrorType) Values() []MigrationErrorType { return []MigrationErrorType{ "ENTITY_NOT_SUPPORTED", @@ -693,8 +701,9 @@ const ( ) // Values returns all known values for ParameterExceptionField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterExceptionField) Values() []ParameterExceptionField { return []ParameterExceptionField{ "CHANGE_ACTION", @@ -730,6 +739,7 @@ const ( // 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{ @@ -752,8 +762,9 @@ const ( ) // Values returns all known values for PositionalConstraint. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionalConstraint) Values() []PositionalConstraint { return []PositionalConstraint{ "EXACTLY", @@ -778,8 +789,9 @@ const ( ) // Values returns all known values for PredicateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PredicateType) Values() []PredicateType { return []PredicateType{ "IPMatch", @@ -800,8 +812,9 @@ const ( ) // Values returns all known values for RateKey. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RateKey) Values() []RateKey { return []RateKey{ "IP", @@ -817,8 +830,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -839,8 +853,9 @@ const ( ) // Values returns all known values for TextTransformation. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextTransformation) Values() []TextTransformation { return []TextTransformation{ "NONE", @@ -862,8 +877,9 @@ const ( ) // Values returns all known values for WafActionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WafActionType) Values() []WafActionType { return []WafActionType{ "BLOCK", @@ -881,8 +897,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "NONE", @@ -900,8 +917,9 @@ const ( ) // Values returns all known values for WafRuleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WafRuleType) Values() []WafRuleType { return []WafRuleType{ "REGULAR", diff --git a/service/wafregional/types/errors.go b/service/wafregional/types/errors.go index de06e1620d2..243ff691f04 100644 --- a/service/wafregional/types/errors.go +++ b/service/wafregional/types/errors.go @@ -60,16 +60,23 @@ func (e *WAFDisallowedNameException) ErrorFault() smithy.ErrorFault { return smi // 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. type WAFEntityMigrationException struct { @@ -155,14 +162,19 @@ 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 . type WAFInvalidOperationException struct { @@ -192,19 +204,28 @@ 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 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 { @@ -237,17 +258,26 @@ func (e *WAFInvalidParameterException) ErrorCode() string { func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. type WAFInvalidPermissionPolicyException struct { Message *string @@ -303,9 +333,10 @@ func (e *WAFInvalidRegexPatternException) ErrorCode() string { func (e *WAFInvalidRegexPatternException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // The operation exceeds a resource limit, for example, the maximum number of -// WebACL objects that you can create for an AWS account. For more information, see -// Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in -// the AWS WAF Developer Guide. +// WebACL objects that you can create for an AWS account. For more information, see [Limits] +// in the AWS WAF Developer Guide. +// +// [Limits]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html type WAFLimitsExceededException struct { Message *string @@ -333,11 +364,15 @@ func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault { return smi // 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 @@ -366,12 +401,15 @@ 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 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 { @@ -427,7 +465,9 @@ func (e *WAFNonexistentItemException) ErrorFault() smithy.ErrorFault { return sm // 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 diff --git a/service/wafregional/types/types.go b/service/wafregional/types/types.go index 97a4cc26a2b..404978cab0e 100644 --- a/service/wafregional/types/types.go +++ b/service/wafregional/types/types.go @@ -7,15 +7,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type ActivatedRule struct { // Specifies the order in which the Rules in a WebACL are evaluated. Rules with a @@ -27,9 +35,10 @@ type ActivatedRule struct { 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 . + // (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 @@ -37,11 +46,15 @@ type ActivatedRule struct { // 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 @@ -49,77 +62,95 @@ type ActivatedRule struct { 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. + // 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: + // 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: + // exclude. For more information about the logs, see [Logging Web ACL Traffic Information]. + // + // - Submit an UpdateWebACLrequest 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 + // in the UpdateWebACLrequest, 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. + // + // [Logging Web ACL Traffic Information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html 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 - // 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 . + // 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 . 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. - // 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 - // does not exist. + // 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 UpdateWebACLrequest will fail because the request tries to add a + // REGULAR rule with the specified ID, which does not exist. Type WafRuleType 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -131,31 +162,38 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -163,16 +201,21 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -188,83 +231,128 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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. - // CONTAINS_WORD The specified part of the web request must include the value of - // 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: + // 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 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. + // + // 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 : + // . 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. + // 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 . + // 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. + // 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 @@ -272,38 +360,75 @@ type ByteMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -311,13 +436,19 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type ExcludedRule struct { // The unique identifier for the rule to exclude from the rule group. @@ -328,34 +459,47 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 . @@ -365,21 +509,30 @@ type FieldToMatch struct { // 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 . + // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type GeoMatchConstraint struct { // The type of geographical area you want AWS WAF to search for. Currently Country @@ -396,50 +549,63 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type GeoMatchSet struct { - // An array of GeoMatchConstraint objects, which contain the country that you want - // AWS WAF to search for. + // An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search + // for. // // 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 . + // 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 - // an GeoMatchSet after you create it. + // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 - // an GeoMatchSet after you create it. + // 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. Name *string @@ -447,15 +613,20 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -469,14 +640,20 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type HTTPHeader struct { // The name of one of the headers in the sampled web request. @@ -488,28 +665,36 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 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]. + // + // [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 . @@ -530,20 +715,27 @@ type HTTPRequest 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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) -// . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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]. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html +// [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) @@ -555,26 +747,33 @@ type IPSet struct { 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 . + // (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 - // IPSet after you create it. + // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type IPSetDescriptor struct { // Specify IPV4 or IPV6 . @@ -583,42 +782,55 @@ type IPSetDescriptor struct { 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: + // + // For more information about CIDR notation, see the Wikipedia entry [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 . // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing + // // This member is required. Value *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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 - // IPSet after you create it. + // 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. Name *string @@ -626,15 +838,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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -648,12 +865,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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). +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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). +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type LoggingConfiguration struct { // An array of Amazon Kinesis Data Firehose ARNs. @@ -674,15 +897,19 @@ type LoggingConfiguration 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type Predicate struct { // A unique identifier for a predicate in a Rule , such as ByteMatchSetId or @@ -692,13 +919,12 @@ type Predicate struct { 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 - // 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 + // 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 . // @@ -713,26 +939,35 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -754,10 +989,9 @@ type RateBasedRule struct { 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 ). + // 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 @@ -776,37 +1010,47 @@ type RateBasedRule 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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: + // 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 . + // 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 @@ -814,16 +1058,22 @@ type RegexMatchSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -831,7 +1081,8 @@ type RegexMatchSetSummary struct { // 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 . + // + // RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. // // This member is required. RegexMatchSetId *string @@ -839,16 +1090,21 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -865,19 +1121,28 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RegexMatchTuple struct { // Specifies where in a web request to look for the RegexPatternSet . @@ -886,12 +1151,11 @@ type RegexMatchTuple struct { 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 ). - // RegexPatternSetId is returned by CreateRegexPatternSet and by - // ListRegexPatternSets . + // 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. // // This member is required. RegexPatternSetId *string @@ -899,38 +1163,75 @@ type RegexMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -938,20 +1239,27 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // WAF. + // + // RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -962,23 +1270,29 @@ type RegexPatternSet struct { // 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -986,8 +1300,9 @@ type RegexPatternSetSummary struct { // 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 . + // WAF. + // + // RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. // // This member is required. RegexPatternSetId *string @@ -995,13 +1310,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RegexPatternSetUpdate struct { // Specifies whether to insert or delete a RegexPatternString . @@ -1018,33 +1338,41 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . // // 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1063,24 +1391,34 @@ type Rule 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1099,25 +1437,31 @@ type RuleGroup 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RuleGroupSummary struct { - // A friendly name or description of the RuleGroup . You can't change the name of a - // RuleGroup after you create it. + // 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 . + // 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 @@ -1125,12 +1469,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RuleGroupUpdate struct { // Specify INSERT to add an ActivatedRule to a RuleGroup . Use DELETE to remove an @@ -1149,24 +1499,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1174,12 +1530,18 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type RuleUpdate struct { // Specify INSERT to add a Predicate to a Rule . Use DELETE to remove a Predicate @@ -1196,14 +1558,20 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SampledHTTPRequest struct { // A complex type that contains detailed information about the request. @@ -1235,27 +1603,41 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 " 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 - // is less than or equal to the size of the FieldToMatch LT: Used to test if the - // Size is strictly less than the size of the FieldToMatch GE: Used to test if the - // Size is greater than or equal to the size of the FieldToMatch GT: Used to test - // if the Size is strictly greater than the size of the FieldToMatch + // 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 is less than or equal to the size of the + // FieldToMatch + // + // LT: Used to test if the Size is strictly less than the size of the FieldToMatch + // + // GE: Used to test if the Size is greater than or equal to the size of the + // FieldToMatch + // + // GT: Used to test if the Size is strictly greater than the size of the + // FieldToMatch // // This member is required. ComparisonOperator ComparisonOperator @@ -1269,10 +1651,12 @@ type SizeConstraint struct { // 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. + // 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 @@ -1280,40 +1664,79 @@ type SizeConstraint struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -1321,23 +1744,28 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 ). - // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets . + // 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. // // This member is required. SizeConstraintSetId *string @@ -1353,11 +1781,17 @@ type SizeConstraintSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// The Id and Name of a SizeConstraintSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SizeConstraintSetSummary struct { // The name of the SizeConstraintSet , if any. @@ -1366,12 +1800,11 @@ type SizeConstraintSetSummary struct { 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 ). - // SizeConstraintSetId is returned by CreateSizeConstraintSet and by - // ListSizeConstraintSets . + // 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. // // This member is required. SizeConstraintSetId *string @@ -1379,17 +1812,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 SizeConstraintSetor delete it from a +// SizeConstraintSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1405,25 +1844,31 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1440,11 +1885,17 @@ type SqlInjectionMatchSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// The Id and Name of a SqlInjectionMatchSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SqlInjectionMatchSetSummary struct { // The name of the SqlInjectionMatchSet , if any, specified by Id . @@ -1453,12 +1904,12 @@ type SqlInjectionMatchSetSummary struct { 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 . + // 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 @@ -1466,18 +1917,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1492,13 +1948,19 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SqlInjectionMatchTuple struct { // Specifies where in a web request to look for snippets of malicious SQL code. @@ -1509,38 +1971,75 @@ type SqlInjectionMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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 @@ -1548,11 +2047,17 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type SubscribedRuleGroupSummary struct { // A friendly name or description for the metrics for this RuleGroup . The name can @@ -1578,18 +2083,25 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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: -// web ACLs, rule groups, and rules. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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: web ACLs, rule groups, and rules. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type Tag struct { // @@ -1605,18 +2117,25 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 -// 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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type TagInfoForResource struct { // @@ -1628,21 +2147,29 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type TimeWindow struct { // The end of the time range from which you want GetSampledRequests to return a @@ -1666,21 +2193,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1692,12 +2228,17 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WafOverrideAction struct { // COUNT overrides the action specified by the individual rule within a RuleGroup @@ -1709,22 +2250,28 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WebACL struct { // The action to perform if none of the Rules contained in the WebACL match. The - // action is specified by the WafAction object. + // action is specified by the WafActionobject. // // This member is required. DefaultAction *WafAction @@ -1736,9 +2283,9 @@ type WebACL struct { 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 . + // 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 @@ -1760,24 +2307,29 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WebACLSummary struct { - // A friendly name or description of the WebACL . You can't change the name of a - // WebACL after you create it. + // 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 . + // 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 @@ -1785,12 +2337,17 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type WebACLUpdate struct { // Specifies whether to insert a Rule into or delete a Rule from a WebACL . @@ -1798,10 +2355,10 @@ type WebACLUpdate struct { // 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 ). + // 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 ). // // This member is required. ActivatedRule *ActivatedRule @@ -1809,24 +2366,30 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 . + // 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 @@ -1843,11 +2406,17 @@ type XssMatchSet 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. With the +// latest version, AWS WAF has a single set of endpoints for regional and global +// use. +// +// The Id and Name of an XssMatchSet . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type XssMatchSetSummary struct { // The name of the XssMatchSet , if any, specified by Id . @@ -1856,11 +2425,11 @@ type XssMatchSetSummary struct { 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 . + // 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 @@ -1868,17 +2437,23 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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 . +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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 . +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html 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 @@ -1893,13 +2468,19 @@ 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) -// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API -// and see the AWS WAF Developer Guide (https://docs.aws.amazon.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. +// This is AWS WAF Classic documentation. For more information, see [AWS WAF Classic] in the +// developer guide. +// +// For the latest version of AWS WAF, use the AWS WAFV2 API and see the [AWS WAF Developer Guide]. 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. +// +// [AWS WAF Classic]: https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html +// [AWS WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html type XssMatchTuple struct { // Specifies where in a web request to look for cross-site scripting attacks. @@ -1910,38 +2491,75 @@ type XssMatchTuple struct { // 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: + // 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): + // + // 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: + // + // 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. + // + // 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_op_AssociateWebACL.go b/service/wafv2/api_op_AssociateWebACL.go index 7f6eef300eb..8c913e7e180 100644 --- a/service/wafv2/api_op_AssociateWebACL.go +++ b/service/wafv2/api_op_AssociateWebACL.go @@ -14,27 +14,40 @@ import ( // resource. A regional application can be an Application Load Balancer (ALB), an // Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user // pool, an App Runner service, or an Amazon Web Services Verified Access instance. +// // 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) -// in the Amazon CloudFront Developer Guide. Required permissions for -// customer-managed IAM policies This call requires permissions that are specific -// to the protected resource type. For details, see Permissions for AssociateWebACL (https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL) -// in the WAF Developer Guide. Temporary inconsistencies during updates When you -// create or change a web ACL or other WAF resources, the changes take a small -// amount of time to propagate to all areas where the resources are stored. The -// propagation time can be from a few seconds to a number of minutes. The following -// are examples of the temporary inconsistencies that you might notice during -// change propagation: +// web ACL. For information, see [UpdateDistribution]in the Amazon CloudFront Developer Guide. +// +// # Required permissions for customer-managed IAM policies +// +// This call requires permissions that are specific to the protected resource +// type. For details, see [Permissions for AssociateWebACL]in the WAF Developer Guide. +// +// # Temporary inconsistencies during updates +// +// When you create or change a web ACL or other WAF resources, the changes take a +// small amount of time to propagate to all areas where the resources are stored. +// The propagation time can be from a few seconds to a number of minutes. +// +// The following are examples of the temporary inconsistencies that you might +// notice during change propagation: +// // - After you create a web ACL, if you try to associate it with a resource, you // might get an exception indicating that the web ACL is unavailable. +// // - After you add a rule group to a web ACL, the new rule group rules might be // in effect in one area where the web ACL is used and not in another. +// // - After you change a rule action setting, you might see the old action in // some places and the new action in others. +// // - After you add an IP address to an IP set that is in use in a blocking rule, // the new address might be blocked in one area while still allowed in another. +// +// [UpdateDistribution]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html +// [Permissions for AssociateWebACL]: https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInput, optFns ...func(*Options)) (*AssociateWebACLOutput, error) { if params == nil { params = &AssociateWebACLInput{} @@ -53,16 +66,21 @@ func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInp 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:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // // - For an Amazon API Gateway REST API: // arn:partition:apigateway:region::/restapis/api-id/stages/stage-name + // // - For an AppSync GraphQL API: // arn:partition:appsync:region:account-id:apis/GraphQLApiId + // // - For an Amazon Cognito user pool: // arn:partition:cognito-idp:region:account-id:userpool/user-pool-id + // // - For an App Runner service: // arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id // diff --git a/service/wafv2/api_op_CheckCapacity.go b/service/wafv2/api_op_CheckCapacity.go index 7442a88ab33..d310b8e7cea 100644 --- a/service/wafv2/api_op_CheckCapacity.go +++ b/service/wafv2/api_op_CheckCapacity.go @@ -13,14 +13,17 @@ 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. For more information, see WAF web ACL capacity units (WCU) (https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) -// in the WAF Developer Guide. +// you want to use in a RuleGroupor 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. For more information, +// see [WAF web ACL capacity units (WCU)]in the WAF Developer Guide. +// +// [WAF web ACL capacity units (WCU)]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html func (c *Client) CheckCapacity(ctx context.Context, params *CheckCapacityInput, optFns ...func(*Options)) (*CheckCapacityOutput, error) { if params == nil { params = &CheckCapacityInput{} @@ -47,10 +50,14 @@ type CheckCapacityInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_CreateAPIKey.go b/service/wafv2/api_op_CreateAPIKey.go index 6608f9ac2e8..2a3f025570a 100644 --- a/service/wafv2/api_op_CreateAPIKey.go +++ b/service/wafv2/api_op_CreateAPIKey.go @@ -11,13 +11,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an API key that contains a set of token domains. API keys are required -// for the integration of the CAPTCHA API in your JavaScript client applications. -// The API lets you customize the placement and characteristics of the CAPTCHA -// puzzle for your end users. For more information about the CAPTCHA JavaScript -// integration, see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) -// in the WAF Developer Guide. You can use a single key for up to 5 domains. After -// you generate a key, you can copy it for use in your JavaScript integration. +// Creates an API key that contains a set of token domains. +// +// API keys are required for the integration of the CAPTCHA API in your JavaScript +// client applications. The API lets you customize the placement and +// characteristics of the CAPTCHA puzzle for your end users. For more information +// about the CAPTCHA JavaScript integration, see [WAF client application integration]in the WAF Developer Guide. +// +// You can use a single key for up to 5 domains. After you generate a key, you can +// copy it for use in your JavaScript integration. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html func (c *Client) CreateAPIKey(ctx context.Context, params *CreateAPIKeyInput, optFns ...func(*Options)) (*CreateAPIKeyOutput, error) { if params == nil { params = &CreateAPIKeyInput{} @@ -39,18 +43,25 @@ type CreateAPIKeyInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. Scope types.Scope - // The client application domains that you want to use this API key for. Example - // JSON: "TokenDomains": ["abc.com", "store.abc.com"] Public suffixes aren't - // allowed. For example, you can't use gov.au or co.uk as token domains. + // The client application domains that you want to use this API key for. + // + // Example JSON: "TokenDomains": ["abc.com", "store.abc.com"] + // + // Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as + // token domains. // // This member is required. TokenDomains []string diff --git a/service/wafv2/api_op_CreateIPSet.go b/service/wafv2/api_op_CreateIPSet.go index 6ccfaa4bede..c502c01d84b 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,28 +35,40 @@ type CreateIPSetInput struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses that you want WAF to inspect for in incoming requests. 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: + // notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0 . + // + // Example address strings: + // // - For requests that originated from the IP address 192.0.2.44, specify // 192.0.2.44/32 . + // // - For requests that originated from IP addresses from 192.0.2.0 to // 192.0.2.255, specify 192.0.2.0/24 . + // // - For 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 . + // // - For 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: + // + // For more information about CIDR notation, see the Wikipedia entry [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 // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing + // // This member is required. Addresses []string @@ -75,10 +87,14 @@ type CreateIPSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. @@ -95,10 +111,9 @@ type CreateIPSetInput struct { type CreateIPSetOutput struct { - // 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 . + // 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. 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 a4c5174b43c..07e5f27b5c4 100644 --- a/service/wafv2/api_op_CreateRegexPatternSet.go +++ b/service/wafv2/api_op_CreateRegexPatternSet.go @@ -11,9 +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 -// for the specified patterns. +// 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 { params = &CreateRegexPatternSetInput{} @@ -45,10 +44,14 @@ type CreateRegexPatternSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. @@ -65,10 +68,10 @@ type CreateRegexPatternSetInput struct { type CreateRegexPatternSetOutput struct { - // 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 . + // 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. 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 125e3b52aea..951d5818c23 100644 --- a/service/wafv2/api_op_CreateRuleGroup.go +++ b/service/wafv2/api_op_CreateRuleGroup.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. +// 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. func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error) { if params == nil { params = &CreateRuleGroupInput{} @@ -33,18 +35,21 @@ func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInp 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 - // 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. For more information, see WAF web ACL - // capacity units (WCU) (https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) - // in the WAF Developer Guide. + // 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 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. For more information, + // see [WAF web ACL capacity units (WCU)]in the WAF Developer Guide. + // + // [WAF web ACL capacity units (WCU)]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html // // This member is required. Capacity *int64 @@ -59,16 +64,21 @@ type CreateRuleGroupInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. Scope types.Scope - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. VisibilityConfig *types.VisibilityConfig @@ -76,19 +86,24 @@ type CreateRuleGroupInput struct { // 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 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. 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. + // rule group. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponseBodies map[string]types.CustomResponseBody // A description of the rule group that helps with identification. Description *string - // The Rule statements used to identify the web requests that you want to manage. - // Each rule includes one top-level statement that WAF uses to identify matching - // web requests, and parameters that govern how WAF handles them. + // The Rule statements used to identify the web requests that you want to manage. Each + // rule includes one top-level statement that WAF uses to identify matching web + // requests, and parameters that govern how WAF handles them. Rules []types.Rule // An array of key:value pairs to associate with the resource. @@ -99,10 +114,9 @@ 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 c9b8cf4ad34..4b24b9e8a85 100644 --- a/service/wafv2/api_op_CreateWebACL.go +++ b/service/wafv2/api_op_CreateWebACL.go @@ -11,17 +11,18 @@ 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 a -// statement that defines what to look for in web requests and an action that WAF -// applies to requests that match the statement. 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, an Amazon Cognito user pool, an App Runner -// service, or an Amazon Web Services Verified Access instance. +// 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 a statement that defines what to look for in web +// requests and an action that WAF applies to requests that match the statement. 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, an Amazon Cognito user pool, +// an App Runner service, or an Amazon Web Services Verified Access instance. func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, optFns ...func(*Options)) (*CreateWebACLOutput, error) { if params == nil { params = &CreateWebACLInput{} @@ -54,29 +55,40 @@ type CreateWebACLInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. Scope types.Scope - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. VisibilityConfig *types.VisibilityConfig // Specifies custom configurations for the associations between the web ACL and - // protected resources. Use this to customize the maximum size of the request body - // that your protected resources forward to WAF for inspection. You can customize - // this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or - // Verified Access resources. The default setting is 16 KB (16,384 bytes). You are - // charged additional fees when your protected resources forward body sizes that - // are larger than the default. For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) - // . For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 + // protected resources. + // + // Use this to customize the maximum size of the request body that your protected + // resources forward to WAF for inspection. You can customize this setting for + // CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access + // resources. The default setting is 16 KB (16,384 bytes). + // + // You are charged additional fees when your protected resources forward body + // sizes that are larger than the default. For more information, see [WAF Pricing]. + // + // For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 // bytes). + // + // [WAF Pricing]: http://aws.amazon.com/waf/pricing/ AssociationConfig *types.AssociationConfig // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have @@ -92,19 +104,24 @@ type CreateWebACLInput struct { // 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. 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. + // you define in the web ACL. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponseBodies map[string]types.CustomResponseBody // A description of the web ACL that helps with identification. Description *string - // The Rule statements used to identify the web requests that you want to manage. - // Each rule includes one top-level statement that WAF uses to identify matching - // web requests, and parameters that govern how WAF handles them. + // The Rule statements used to identify the web requests that you want to manage. Each + // rule includes one top-level statement that WAF uses to identify matching web + // requests, and parameters that govern how WAF handles them. Rules []types.Rule // An array of key:value pairs to associate with the resource. @@ -116,9 +133,12 @@ type CreateWebACLInput struct { // is protecting. If you don't specify a list of token domains, WAF accepts tokens // only for the domain of the protected resource. With a token domain list, WAF // accepts the resource's host domain plus all domains in the token domain list, - // including their prefixed subdomains. Example JSON: "TokenDomains": { - // "mywebsite.com", "myotherwebsite.com" } Public suffixes aren't allowed. For - // example, you can't use gov.au or co.uk as token domains. + // including their prefixed subdomains. + // + // Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" } + // + // Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as + // token domains. TokenDomains []string noSmithyDocumentSerde @@ -126,10 +146,9 @@ type CreateWebACLInput struct { type CreateWebACLOutput struct { - // 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 . + // 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. Summary *types.WebACLSummary // Metadata pertaining to the operation's result. diff --git a/service/wafv2/api_op_DeleteAPIKey.go b/service/wafv2/api_op_DeleteAPIKey.go index 4c0877b1abf..2f28f5eb553 100644 --- a/service/wafv2/api_op_DeleteAPIKey.go +++ b/service/wafv2/api_op_DeleteAPIKey.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified API key. After you delete a key, it can take up to 24 -// hours for WAF to disallow use of the key in all regions. +// Deletes the specified API key. +// +// After you delete a key, it can take up to 24 hours for WAF to disallow use of +// the key in all regions. func (c *Client) DeleteAPIKey(ctx context.Context, params *DeleteAPIKeyInput, optFns ...func(*Options)) (*DeleteAPIKeyOutput, error) { if params == nil { params = &DeleteAPIKeyInput{} @@ -39,10 +41,14 @@ type DeleteAPIKeyInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go b/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go index 3e3ac1c2802..90ad32718b3 100644 --- a/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go +++ b/service/wafv2/api_op_DeleteFirewallManagerRuleGroups.go @@ -11,8 +11,9 @@ 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 . +// web ACL. +// +// You can only use this if ManagedByFirewallManager is false in the specified WebACL. func (c *Client) DeleteFirewallManagerRuleGroups(ctx context.Context, params *DeleteFirewallManagerRuleGroupsInput, optFns ...func(*Options)) (*DeleteFirewallManagerRuleGroupsOutput, error) { if params == nil { params = &DeleteFirewallManagerRuleGroupsInput{} diff --git a/service/wafv2/api_op_DeleteIPSet.go b/service/wafv2/api_op_DeleteIPSet.go index 6e5a036f04b..7fc541e42ee 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{} @@ -56,10 +56,14 @@ type DeleteIPSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DeleteLoggingConfiguration.go b/service/wafv2/api_op_DeleteLoggingConfiguration.go index 2c88e9127d2..1efcb2af861 100644 --- a/service/wafv2/api_op_DeleteLoggingConfiguration.go +++ b/service/wafv2/api_op_DeleteLoggingConfiguration.go @@ -28,8 +28,8 @@ 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 . + // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration + // . // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_DeletePermissionPolicy.go b/service/wafv2/api_op_DeletePermissionPolicy.go index 9ec51423421..5ed60c43c4f 100644 --- a/service/wafv2/api_op_DeletePermissionPolicy.go +++ b/service/wafv2/api_op_DeletePermissionPolicy.go @@ -10,8 +10,9 @@ 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{} @@ -30,7 +31,9 @@ func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermi type DeletePermissionPolicyInput struct { // The Amazon Resource Name (ARN) of the rule group from which you want to delete - // the policy. You must be the owner of the rule group to perform this operation. + // the policy. + // + // You must be the owner of the rule group to perform this operation. // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_DeleteRegexPatternSet.go b/service/wafv2/api_op_DeleteRegexPatternSet.go index f4a5fc1fbfb..67436aed93c 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{} @@ -55,10 +55,14 @@ type DeleteRegexPatternSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DeleteRuleGroup.go b/service/wafv2/api_op_DeleteRuleGroup.go index 383c8500c57..3e9827457ca 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{} @@ -56,10 +56,14 @@ type DeleteRuleGroupInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DeleteWebACL.go b/service/wafv2/api_op_DeleteWebACL.go index 569bac2da92..f5d5b2133c9 100644 --- a/service/wafv2/api_op_DeleteWebACL.go +++ b/service/wafv2/api_op_DeleteWebACL.go @@ -11,20 +11,31 @@ 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 -// disassociate it from all resources. +// 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 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) -// in the Amazon CloudFront API Reference. +// ListDistributionsByWebACLId . For information, see [ListDistributionsByWebACLId]in the Amazon CloudFront +// API Reference. +// // - To disassociate a resource from a web ACL, use the following calls: -// - For regional resources, call DisassociateWebACL . +// +// - 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) -// in the Amazon CloudFront API Reference. +// CloudFront call UpdateDistribution . For information, see [UpdateDistribution]in the Amazon +// CloudFront API Reference. +// +// [ListDistributionsByWebACLId]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html +// [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{} @@ -69,10 +80,14 @@ type DeleteWebACLInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DescribeAllManagedProducts.go b/service/wafv2/api_op_DescribeAllManagedProducts.go index 4a1b6b98f9b..fa2410f1f68 100644 --- a/service/wafv2/api_op_DescribeAllManagedProducts.go +++ b/service/wafv2/api_op_DescribeAllManagedProducts.go @@ -34,10 +34,14 @@ type DescribeAllManagedProductsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DescribeManagedProductsByVendor.go b/service/wafv2/api_op_DescribeManagedProductsByVendor.go index 89af7134916..18dc6167d50 100644 --- a/service/wafv2/api_op_DescribeManagedProductsByVendor.go +++ b/service/wafv2/api_op_DescribeManagedProductsByVendor.go @@ -34,10 +34,14 @@ type DescribeManagedProductsByVendorInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_DescribeManagedRuleGroup.go b/service/wafv2/api_op_DescribeManagedRuleGroup.go index 90ff985c5ea..ea7a3ea5bb9 100644 --- a/service/wafv2/api_op_DescribeManagedRuleGroup.go +++ b/service/wafv2/api_op_DescribeManagedRuleGroup.go @@ -40,10 +40,14 @@ type DescribeManagedRuleGroupInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. @@ -66,33 +70,41 @@ 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 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. For more information, see WAF web - // ACL capacity units (WCU) (https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) - // in the WAF Developer Guide. + // 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. For more information, + // see [WAF web ACL capacity units (WCU)]in the WAF Developer Guide. + // + // [WAF web ACL capacity units (WCU)]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html Capacity *int64 // The labels that one or more rules in this rule group match against in label // match statements. These labels are defined in a LabelMatchStatement - // specification, in the Statement definition of a rule. + // specification, in the Statementdefinition of a rule. ConsumedLabels []types.LabelSummary // 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:: : + // 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: : + // from the rule, separated by a colon: + // + // : LabelNamespace *string // @@ -102,8 +114,9 @@ type DescribeManagedRuleGroupOutput struct { // topic that's used to provide notification of 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) - // . + // more information, see the [Amazon Simple Notification Service Developer Guide]. + // + // [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 bf3729c0c1a..bfcf7637f26 100644 --- a/service/wafv2/api_op_DisassociateWebACL.go +++ b/service/wafv2/api_op_DisassociateWebACL.go @@ -14,15 +14,20 @@ import ( // ACL association. A resource can have at most one web ACL association. A regional // application can be an Application Load Balancer (ALB), an Amazon API Gateway // REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner -// service, or an Amazon Web Services Verified Access instance. 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) -// in the Amazon CloudFront API Reference. Required permissions for -// customer-managed IAM policies This call requires permissions that are specific -// to the protected resource type. For details, see Permissions for -// DisassociateWebACL (https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-DisassociateWebACL) -// in the WAF Developer Guide. +// service, or an Amazon Web Services Verified Access instance. +// +// 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] in the +// Amazon CloudFront API Reference. +// +// # Required permissions for customer-managed IAM policies +// +// This call requires permissions that are specific to the protected resource +// type. For details, see [Permissions for DisassociateWebACL]in the WAF Developer Guide. +// +// [Permissions for DisassociateWebACL]: https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-DisassociateWebACL +// [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{} @@ -41,16 +46,22 @@ 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: + // ACL. + // + // The ARN must be in one of the following formats: + // // - For an Application Load Balancer: // arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // // - For an Amazon API Gateway REST API: // arn:partition:apigateway:region::/restapis/api-id/stages/stage-name + // // - For an AppSync GraphQL API: // arn:partition:appsync:region:account-id:apis/GraphQLApiId + // // - For an Amazon Cognito user pool: // arn:partition:cognito-idp:region:account-id:userpool/user-pool-id + // // - For an App Runner service: // arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id // diff --git a/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go b/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go index bcc4def75d8..d98c0ab76ed 100644 --- a/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go +++ b/service/wafv2/api_op_GenerateMobileSdkReleaseUrl.go @@ -12,11 +12,13 @@ import ( ) // Generates a presigned download URL for the specified release of the mobile SDK. +// // 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) -// in the WAF Developer Guide. +// requests from a mobile device to WAF. For more information, see [WAF client application integration]in the WAF +// Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html func (c *Client) GenerateMobileSdkReleaseUrl(ctx context.Context, params *GenerateMobileSdkReleaseUrlInput, optFns ...func(*Options)) (*GenerateMobileSdkReleaseUrlOutput, error) { if params == nil { params = &GenerateMobileSdkReleaseUrlInput{} diff --git a/service/wafv2/api_op_GetDecryptedAPIKey.go b/service/wafv2/api_op_GetDecryptedAPIKey.go index 43016d16bd5..d98541e7517 100644 --- a/service/wafv2/api_op_GetDecryptedAPIKey.go +++ b/service/wafv2/api_op_GetDecryptedAPIKey.go @@ -13,12 +13,14 @@ import ( ) // Returns your API key in decrypted form. Use this to check the token domains -// that you have defined for the key. API keys are required for the integration of -// the CAPTCHA API in your JavaScript client applications. The API lets you -// customize the placement and characteristics of the CAPTCHA puzzle for your end -// users. For more information about the CAPTCHA JavaScript integration, see WAF -// client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) -// in the WAF Developer Guide. +// that you have defined for the key. +// +// API keys are required for the integration of the CAPTCHA API in your JavaScript +// client applications. The API lets you customize the placement and +// characteristics of the CAPTCHA puzzle for your end users. For more information +// about the CAPTCHA JavaScript integration, see [WAF client application integration]in the WAF Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html func (c *Client) GetDecryptedAPIKey(ctx context.Context, params *GetDecryptedAPIKeyInput, optFns ...func(*Options)) (*GetDecryptedAPIKeyOutput, error) { if params == nil { params = &GetDecryptedAPIKeyInput{} @@ -45,10 +47,14 @@ type GetDecryptedAPIKeyInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_GetIPSet.go b/service/wafv2/api_op_GetIPSet.go index 5d69981531e..2d4c0ded78d 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{} @@ -45,10 +45,14 @@ type GetIPSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_GetLoggingConfiguration.go b/service/wafv2/api_op_GetLoggingConfiguration.go index 1b5a2e953f6..a883aca9122 100644 --- a/service/wafv2/api_op_GetLoggingConfiguration.go +++ b/service/wafv2/api_op_GetLoggingConfiguration.go @@ -29,8 +29,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 . + // The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_GetManagedRuleSet.go b/service/wafv2/api_op_GetManagedRuleSet.go index c4625641688..5dbd7c2b3bd 100644 --- a/service/wafv2/api_op_GetManagedRuleSet.go +++ b/service/wafv2/api_op_GetManagedRuleSet.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the specified 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 . +// Retrieves the specified 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 . func (c *Client) GetManagedRuleSet(ctx context.Context, params *GetManagedRuleSetInput, optFns ...func(*Options)) (*GetManagedRuleSetOutput, error) { if params == nil { params = &GetManagedRuleSetInput{} @@ -42,8 +45,10 @@ type GetManagedRuleSetInput struct { Id *string // The name of the managed rule set. You use this, along with the rule set ID, to - // identify the rule set. This name is assigned to the corresponding managed rule - // group, which your customers can access and use. + // identify the rule set. + // + // This name is assigned to the corresponding managed rule group, which your + // customers can access and use. // // This member is required. Name *string @@ -52,10 +57,14 @@ type GetManagedRuleSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_GetMobileSdkRelease.go b/service/wafv2/api_op_GetMobileSdkRelease.go index f1c86bc8867..ae56a2fd1cf 100644 --- a/service/wafv2/api_op_GetMobileSdkRelease.go +++ b/service/wafv2/api_op_GetMobileSdkRelease.go @@ -12,11 +12,14 @@ import ( ) // Retrieves information for the specified mobile SDK release, including release -// 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) -// in the WAF Developer Guide. +// 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]in the WAF +// Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html func (c *Client) GetMobileSdkRelease(ctx context.Context, params *GetMobileSdkReleaseInput, optFns ...func(*Options)) (*GetMobileSdkReleaseOutput, error) { if params == nil { params = &GetMobileSdkReleaseInput{} diff --git a/service/wafv2/api_op_GetPermissionPolicy.go b/service/wafv2/api_op_GetPermissionPolicy.go index b2594949801..53d8e3e523b 100644 --- a/service/wafv2/api_op_GetPermissionPolicy.go +++ b/service/wafv2/api_op_GetPermissionPolicy.go @@ -10,8 +10,9 @@ 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 026b7c5343b..9c7b3e41e01 100644 --- a/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go +++ b/service/wafv2/api_op_GetRateBasedStatementManagedKeys.go @@ -13,19 +13,23 @@ import ( // Retrieves the IP addresses that are currently blocked by a rate-based rule // instance. This is only available for rate-based rules that aggregate solely on -// the IP address or on the forwarded IP address. The maximum number of addresses -// 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. +// the IP address or on the forwarded IP address. +// +// The maximum number of addresses 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{} @@ -55,10 +59,14 @@ type GetRateBasedStatementManagedKeysInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_GetRegexPatternSet.go b/service/wafv2/api_op_GetRegexPatternSet.go index c4377ea01a1..ee2eb27c770 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{} @@ -44,10 +44,14 @@ type GetRegexPatternSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_GetRuleGroup.go b/service/wafv2/api_op_GetRuleGroup.go index b59ef62208b..a688db14a16 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{} @@ -44,10 +44,14 @@ type GetRuleGroupInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. Scope types.Scope diff --git a/service/wafv2/api_op_GetSampledRequests.go b/service/wafv2/api_op_GetSampledRequests.go index cc3e335be1e..73032a274f4 100644 --- a/service/wafv2/api_op_GetSampledRequests.go +++ b/service/wafv2/api_op_GetSampledRequests.go @@ -15,12 +15,13 @@ import ( // WAF randomly selects from among the first 5,000 requests that your Amazon Web // Services 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 WAF selected the requests in the -// sample. +// 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 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{} @@ -56,10 +57,14 @@ type GetSampledRequestsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_GetWebACL.go b/service/wafv2/api_op_GetWebACL.go index fe16fe61803..ef973a5666b 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{} @@ -45,10 +45,14 @@ type GetWebACLInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. @@ -64,9 +68,10 @@ type GetWebACLOutput struct { // prevention managed rule group AWSManagedRulesATPRuleSet and the account // creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet . 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) - // in the WAF Developer Guide. + // with your applications in this way. For more information, see [WAF client application integration]in the WAF + // Developer Guide. + // + // [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html ApplicationIntegrationURL *string // A token used for optimistic locking. WAF returns a token to your get and list diff --git a/service/wafv2/api_op_GetWebACLForResource.go b/service/wafv2/api_op_GetWebACLForResource.go index 6253813acbc..06624f1e031 100644 --- a/service/wafv2/api_op_GetWebACLForResource.go +++ b/service/wafv2/api_op_GetWebACLForResource.go @@ -11,18 +11,24 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the WebACL for the specified resource. This call uses GetWebACL , to -// verify that your account has permission to access the retrieved web ACL. If you -// get an error that indicates that your account isn't authorized to perform -// wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail -// event history. For Amazon CloudFront, don't use this call. Instead, call the -// CloudFront action GetDistributionConfig . For information, see -// GetDistributionConfig (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html) -// in the Amazon CloudFront API Reference. Required permissions for -// customer-managed IAM policies This call requires permissions that are specific -// to the protected resource type. For details, see Permissions for -// GetWebACLForResource (https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-GetWebACLForResource) -// in the WAF Developer Guide. +// Retrieves the WebACL for the specified resource. +// +// This call uses GetWebACL , to verify that your account has permission to access +// the retrieved web ACL. If you get an error that indicates that your account +// isn't authorized to perform wafv2:GetWebACL on the resource, that error won't +// be included in your CloudTrail event history. +// +// For Amazon CloudFront, don't use this call. Instead, call the CloudFront action +// GetDistributionConfig . For information, see [GetDistributionConfig] in the Amazon CloudFront API +// Reference. +// +// # Required permissions for customer-managed IAM policies +// +// This call requires permissions that are specific to the protected resource +// type. For details, see [Permissions for GetWebACLForResource]in the WAF Developer Guide. +// +// [GetDistributionConfig]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html +// [Permissions for GetWebACLForResource]: https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-GetWebACLForResource func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForResourceInput, optFns ...func(*Options)) (*GetWebACLForResourceOutput, error) { if params == nil { params = &GetWebACLForResourceInput{} @@ -41,16 +47,22 @@ func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForR 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: + // retrieve. + // + // The ARN must be in one of the following formats: + // // - For an Application Load Balancer: // arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // // - For an Amazon API Gateway REST API: // arn:partition:apigateway:region::/restapis/api-id/stages/stage-name + // // - For an AppSync GraphQL API: // arn:partition:appsync:region:account-id:apis/GraphQLApiId + // // - For an Amazon Cognito user pool: // arn:partition:cognito-idp:region:account-id:userpool/user-pool-id + // // - For an App Runner service: // arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id // diff --git a/service/wafv2/api_op_ListAPIKeys.go b/service/wafv2/api_op_ListAPIKeys.go index 4cfbbd95035..ccb461c0cb1 100644 --- a/service/wafv2/api_op_ListAPIKeys.go +++ b/service/wafv2/api_op_ListAPIKeys.go @@ -12,11 +12,13 @@ import ( ) // Retrieves a list of the API keys that you've defined for the specified scope. +// // API keys are required for the integration of the CAPTCHA API in your JavaScript // client applications. The API lets you customize the placement and // characteristics of the CAPTCHA puzzle for your end users. For more information -// about the CAPTCHA JavaScript integration, see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) -// in the WAF Developer Guide. +// about the CAPTCHA JavaScript integration, see [WAF client application integration]in the WAF Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html func (c *Client) ListAPIKeys(ctx context.Context, params *ListAPIKeysInput, optFns ...func(*Options)) (*ListAPIKeysOutput, error) { if params == nil { params = &ListAPIKeysInput{} @@ -38,10 +40,14 @@ type ListAPIKeysInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go b/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go index 43229743d50..7c5ba451168 100644 --- a/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go +++ b/service/wafv2/api_op_ListAvailableManagedRuleGroupVersions.go @@ -39,10 +39,14 @@ type ListAvailableManagedRuleGroupVersionsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListAvailableManagedRuleGroups.go b/service/wafv2/api_op_ListAvailableManagedRuleGroups.go index 7c88b4f7063..b9031b3d107 100644 --- a/service/wafv2/api_op_ListAvailableManagedRuleGroups.go +++ b/service/wafv2/api_op_ListAvailableManagedRuleGroups.go @@ -36,10 +36,14 @@ type ListAvailableManagedRuleGroupsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListIPSets.go b/service/wafv2/api_op_ListIPSets.go index de2a3c5406c..7ce4ff23584 100644 --- a/service/wafv2/api_op_ListIPSets.go +++ b/service/wafv2/api_op_ListIPSets.go @@ -33,10 +33,14 @@ type ListIPSetsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListLoggingConfigurations.go b/service/wafv2/api_op_ListLoggingConfigurations.go index 3490cc2a203..dedb0662044 100644 --- a/service/wafv2/api_op_ListLoggingConfigurations.go +++ b/service/wafv2/api_op_ListLoggingConfigurations.go @@ -33,10 +33,14 @@ type ListLoggingConfigurationsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListManagedRuleSets.go b/service/wafv2/api_op_ListManagedRuleSets.go index 66831830df4..0e270179d71 100644 --- a/service/wafv2/api_op_ListManagedRuleSets.go +++ b/service/wafv2/api_op_ListManagedRuleSets.go @@ -11,12 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the managed rule sets that you own. 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 . +// Retrieves the managed rule sets that you own. +// +// 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 . func (c *Client) ListManagedRuleSets(ctx context.Context, params *ListManagedRuleSetsInput, optFns ...func(*Options)) (*ListManagedRuleSetsOutput, error) { if params == nil { params = &ListManagedRuleSetsInput{} @@ -38,10 +41,14 @@ type ListManagedRuleSetsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListMobileSdkReleases.go b/service/wafv2/api_op_ListMobileSdkReleases.go index 1f8a1c2a4c9..ab196b7ff26 100644 --- a/service/wafv2/api_op_ListMobileSdkReleases.go +++ b/service/wafv2/api_op_ListMobileSdkReleases.go @@ -12,11 +12,14 @@ import ( ) // Retrieves a list of the available releases for the mobile SDK and the specified -// 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) -// in the WAF Developer Guide. +// 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]in the WAF +// Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html func (c *Client) ListMobileSdkReleases(ctx context.Context, params *ListMobileSdkReleasesInput, optFns ...func(*Options)) (*ListMobileSdkReleasesOutput, error) { if params == nil { params = &ListMobileSdkReleasesInput{} diff --git a/service/wafv2/api_op_ListRegexPatternSets.go b/service/wafv2/api_op_ListRegexPatternSets.go index 515ff390ca6..a6950f28414 100644 --- a/service/wafv2/api_op_ListRegexPatternSets.go +++ b/service/wafv2/api_op_ListRegexPatternSets.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets -// that you manage. +// Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage. func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error) { if params == nil { params = &ListRegexPatternSetsInput{} @@ -34,10 +33,14 @@ type ListRegexPatternSetsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListResourcesForWebACL.go b/service/wafv2/api_op_ListResourcesForWebACL.go index 1bcf8886edb..46563206174 100644 --- a/service/wafv2/api_op_ListResourcesForWebACL.go +++ b/service/wafv2/api_op_ListResourcesForWebACL.go @@ -12,14 +12,19 @@ import ( ) // Retrieves an array of the Amazon Resource Names (ARNs) for the regional -// resources that are associated with the specified web ACL. For Amazon CloudFront, -// don't use this call. Instead, use the CloudFront call -// ListDistributionsByWebACLId . For information, see ListDistributionsByWebACLId (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html) -// in the Amazon CloudFront API Reference. Required permissions for -// customer-managed IAM policies This call requires permissions that are specific -// to the protected resource type. For details, see Permissions for -// ListResourcesForWebACL (https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-ListResourcesForWebACL) -// in the WAF Developer Guide. +// resources that are associated with the specified web ACL. +// +// For Amazon CloudFront, don't use this call. Instead, use the CloudFront call +// ListDistributionsByWebACLId . For information, see [ListDistributionsByWebACLId] in the Amazon CloudFront +// API Reference. +// +// # Required permissions for customer-managed IAM policies +// +// This call requires permissions that are specific to the protected resource +// type. For details, see [Permissions for ListResourcesForWebACL]in the WAF Developer Guide. +// +// [Permissions for ListResourcesForWebACL]: https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-ListResourcesForWebACL +// [ListDistributionsByWebACLId]: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html func (c *Client) ListResourcesForWebACL(ctx context.Context, params *ListResourcesForWebACLInput, optFns ...func(*Options)) (*ListResourcesForWebACLOutput, error) { if params == nil { params = &ListResourcesForWebACLInput{} @@ -45,9 +50,12 @@ type ListResourcesForWebACLInput struct { // Used for web ACLs that are scoped for regional applications. A regional // application can be an Application Load Balancer (ALB), an Amazon API Gateway // REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner - // service, or an Amazon Web Services Verified Access instance. If you don't - // provide a resource type, the call uses the resource type - // APPLICATION_LOAD_BALANCER . Default: APPLICATION_LOAD_BALANCER + // service, or an Amazon Web Services Verified Access instance. + // + // If you don't provide a resource type, the call uses the resource type + // 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 856d74cb501..68df439d998 100644 --- a/service/wafv2/api_op_ListRuleGroups.go +++ b/service/wafv2/api_op_ListRuleGroups.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves an array of RuleGroupSummary objects for the rule groups that you -// manage. +// Retrieves an array of RuleGroupSummary objects for the rule groups that you manage. func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error) { if params == nil { params = &ListRuleGroupsInput{} @@ -34,10 +33,14 @@ type ListRuleGroupsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_ListTagsForResource.go b/service/wafv2/api_op_ListTagsForResource.go index 9622412f302..262ab73df85 100644 --- a/service/wafv2/api_op_ListTagsForResource.go +++ b/service/wafv2/api_op_ListTagsForResource.go @@ -11,14 +11,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the TagInfoForResource for 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 WAF: web ACLs, rule -// groups, IP sets, and regex pattern sets. You can't manage or view tags through -// the WAF console. +// Retrieves the TagInfoForResource for 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 WAF: web +// ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view +// tags through the WAF console. func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) { if params == nil { params = &ListTagsForResourceInput{} diff --git a/service/wafv2/api_op_ListWebACLs.go b/service/wafv2/api_op_ListWebACLs.go index 78000abd0ad..f2e56f7bc74 100644 --- a/service/wafv2/api_op_ListWebACLs.go +++ b/service/wafv2/api_op_ListWebACLs.go @@ -33,10 +33,14 @@ type ListWebACLsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_PutLoggingConfiguration.go b/service/wafv2/api_op_PutLoggingConfiguration.go index 6e308e43539..220d090bb73 100644 --- a/service/wafv2/api_op_PutLoggingConfiguration.go +++ b/service/wafv2/api_op_PutLoggingConfiguration.go @@ -11,35 +11,53 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // -// You can define one logging destination per web ACL. You can access information -// about the traffic that WAF inspects using the following steps: +// 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. +// 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]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. +// +// For additional information about web ACL logging, see [Logging web ACL traffic information] in the WAF Developer +// Guide. +// +// [Logging web ACL traffic information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html +// +// [Logging web ACL traffic]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html 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 cba788464c6..0c54572840f 100644 --- a/service/wafv2/api_op_PutManagedRuleSetVersions.go +++ b/service/wafv2/api_op_PutManagedRuleSetVersions.go @@ -13,19 +13,23 @@ import ( // Defines the versions of your managed rule set that you are offering to the // customers. Customers see your offerings as managed rule groups with versioning. +// // 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 +// 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 -// here for your managed rule set is the name the customer sees for the +// 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 -// 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 . +// 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. func (c *Client) PutManagedRuleSetVersions(ctx context.Context, params *PutManagedRuleSetVersionsInput, optFns ...func(*Options)) (*PutManagedRuleSetVersionsOutput, error) { if params == nil { params = &PutManagedRuleSetVersionsInput{} @@ -62,8 +66,10 @@ type PutManagedRuleSetVersionsInput struct { LockToken *string // The name of the managed rule set. You use this, along with the rule set ID, to - // identify the rule set. This name is assigned to the corresponding managed rule - // group, which your customers can access and use. + // identify the rule set. + // + // This name is assigned to the corresponding managed rule group, which your + // customers can access and use. // // This member is required. Name *string @@ -72,10 +78,14 @@ type PutManagedRuleSetVersionsInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_PutPermissionPolicy.go b/service/wafv2/api_op_PutPermissionPolicy.go index e790f194222..2545ea18c11 100644 --- a/service/wafv2/api_op_PutPermissionPolicy.go +++ b/service/wafv2/api_op_PutPermissionPolicy.go @@ -11,11 +11,17 @@ import ( ) // 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: +// 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 ARN in the request must be a valid WAF RuleGroupARN 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 { @@ -34,24 +40,31 @@ 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 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. + // // - 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]. + // + // [IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html // // This member is required. Policy *string - // The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the - // policy. + // The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. // // This member is required. ResourceArn *string diff --git a/service/wafv2/api_op_TagResource.go b/service/wafv2/api_op_TagResource.go index 72a4001a537..8e31ce42325 100644 --- a/service/wafv2/api_op_TagResource.go +++ b/service/wafv2/api_op_TagResource.go @@ -15,10 +15,11 @@ import ( // 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 WAF: web ACLs, rule -// groups, IP sets, and regex pattern sets. You can't manage or view tags through -// the WAF console. +// each Amazon Web Services resource, up to 50 tags for a resource. +// +// You can tag the Amazon Web Services resources that you manage through WAF: web +// ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view +// tags through the WAF console. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/wafv2/api_op_UpdateIPSet.go b/service/wafv2/api_op_UpdateIPSet.go index 40fb47753b7..6c23d6e3b97 100644 --- a/service/wafv2/api_op_UpdateIPSet.go +++ b/service/wafv2/api_op_UpdateIPSet.go @@ -11,24 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // -// Temporary inconsistencies during updates When you create or change a web ACL or -// other WAF resources, the changes take a small amount of time to propagate to all -// areas where the resources are stored. The propagation time can be from a few -// seconds to a number of minutes. The following are examples of the temporary -// inconsistencies that you might notice during change propagation: +// # Temporary inconsistencies during updates +// +// When you create or change a web ACL or other WAF resources, the changes take a +// small amount of time to propagate to all areas where the resources are stored. +// The propagation time can be from a few seconds to a number of minutes. +// +// The following are examples of the temporary inconsistencies that you might +// notice during change propagation: +// // - After you create a web ACL, if you try to associate it with a resource, you // might get an exception indicating that the web ACL is unavailable. +// // - After you add a rule group to a web ACL, the new rule group rules might be // in effect in one area where the web ACL is used and not in another. +// // - After you change a rule action setting, you might see the old action in // some places and the new action in others. +// // - After you add an IP address to an IP set that is in use in a blocking rule, // the new address might be blocked in one area while still allowed in another. func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error) { @@ -51,28 +64,40 @@ type UpdateIPSetInput struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses that you want WAF to inspect for in incoming requests. 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: + // notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0 . + // + // Example address strings: + // // - For requests that originated from the IP address 192.0.2.44, specify // 192.0.2.44/32 . + // // - For requests that originated from IP addresses from 192.0.2.0 to // 192.0.2.255, specify 192.0.2.0/24 . + // // - For 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 . + // // - For 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: + // + // For more information about CIDR notation, see the Wikipedia entry [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 // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing + // // This member is required. Addresses []string @@ -103,10 +128,14 @@ type UpdateIPSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go b/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go index e41c856176e..41dafda56a6 100644 --- a/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go +++ b/service/wafv2/api_op_UpdateManagedRuleSetVersionExpiryDate.go @@ -14,13 +14,15 @@ import ( // Updates the expiration information for your managed rule set. Use this to // initiate the expiration of a managed rule group version. After you initiate -// expiration for a version, WAF excludes it from the response to -// ListAvailableManagedRuleGroupVersions for the managed rule group. 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 +// expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersionsfor the managed +// rule group. +// +// 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 . func (c *Client) UpdateManagedRuleSetVersionExpiryDate(ctx context.Context, params *UpdateManagedRuleSetVersionExpiryDateInput, optFns ...func(*Options)) (*UpdateManagedRuleSetVersionExpiryDateOutput, error) { if params == nil { @@ -39,9 +41,10 @@ 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 @@ -65,8 +68,10 @@ type UpdateManagedRuleSetVersionExpiryDateInput struct { LockToken *string // The name of the managed rule set. You use this, along with the rule set ID, to - // identify the rule set. This name is assigned to the corresponding managed rule - // group, which your customers can access and use. + // identify the rule set. + // + // This name is assigned to the corresponding managed rule group, which your + // customers can access and use. // // This member is required. Name *string @@ -75,10 +80,14 @@ type UpdateManagedRuleSetVersionExpiryDateInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. @@ -98,9 +107,10 @@ type UpdateManagedRuleSetVersionExpiryDateOutput struct { // The version that is set to expire. ExpiringVersion *string - // The time that the version will 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 the version will expire. + // + // Times are in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". ExpiryTimestamp *time.Time // A token used for optimistic locking. WAF returns a token to your get and list diff --git a/service/wafv2/api_op_UpdateRegexPatternSet.go b/service/wafv2/api_op_UpdateRegexPatternSet.go index 3de2ceb51a9..9fa491049b6 100644 --- a/service/wafv2/api_op_UpdateRegexPatternSet.go +++ b/service/wafv2/api_op_UpdateRegexPatternSet.go @@ -11,25 +11,37 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // -// Temporary inconsistencies during updates When you create or change a web ACL or -// other WAF resources, the changes take a small amount of time to propagate to all -// areas where the resources are stored. The propagation time can be from a few -// seconds to a number of minutes. The following are examples of the temporary -// inconsistencies that you might notice during change propagation: +// # Temporary inconsistencies during updates +// +// When you create or change a web ACL or other WAF resources, the changes take a +// small amount of time to propagate to all areas where the resources are stored. +// The propagation time can be from a few seconds to a number of minutes. +// +// The following are examples of the temporary inconsistencies that you might +// notice during change propagation: +// // - After you create a web ACL, if you try to associate it with a resource, you // might get an exception indicating that the web ACL is unavailable. +// // - After you add a rule group to a web ACL, the new rule group rules might be // in effect in one area where the web ACL is used and not in another. +// // - After you change a rule action setting, you might see the old action in // some places and the new action in others. +// // - After you add an IP address to an IP set that is in use in a blocking rule, // the new address might be blocked in one area while still allowed in another. func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexPatternSetInput, optFns ...func(*Options)) (*UpdateRegexPatternSetOutput, error) { @@ -80,10 +92,14 @@ type UpdateRegexPatternSetInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. diff --git a/service/wafv2/api_op_UpdateRuleGroup.go b/service/wafv2/api_op_UpdateRuleGroup.go index 8208647ee35..e151e692bdc 100644 --- a/service/wafv2/api_op_UpdateRuleGroup.go +++ b/service/wafv2/api_op_UpdateRuleGroup.go @@ -11,29 +11,43 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // // 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. Temporary inconsistencies during updates When you create -// or change a web ACL or other WAF resources, the changes take a small amount of -// time to propagate to all areas where the resources are stored. The propagation -// time can be from a few seconds to a number of minutes. The following are -// examples of the temporary inconsistencies that you might notice during change -// propagation: +// 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. +// +// # Temporary inconsistencies during updates +// +// When you create or change a web ACL or other WAF resources, the changes take a +// small amount of time to propagate to all areas where the resources are stored. +// The propagation time can be from a few seconds to a number of minutes. +// +// The following are examples of the temporary inconsistencies that you might +// notice during change propagation: +// // - After you create a web ACL, if you try to associate it with a resource, you // might get an exception indicating that the web ACL is unavailable. +// // - After you add a rule group to a web ACL, the new rule group rules might be // in effect in one area where the web ACL is used and not in another. +// // - After you change a rule action setting, you might see the old action in // some places and the new action in others. +// // - After you add an IP address to an IP set that is in use in a blocking rule, // the new address might be blocked in one area while still allowed in another. func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error) { @@ -80,16 +94,21 @@ type UpdateRuleGroupInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. Scope types.Scope - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. VisibilityConfig *types.VisibilityConfig @@ -97,19 +116,24 @@ type UpdateRuleGroupInput struct { // 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 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. 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. + // rule group. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponseBodies map[string]types.CustomResponseBody // A description of the rule group that helps with identification. Description *string - // The Rule statements used to identify the web requests that you want to manage. - // Each rule includes one top-level statement that WAF uses to identify matching - // web requests, and parameters that govern how WAF handles them. + // The Rule statements used to identify the web requests that you want to manage. Each + // rule includes one top-level statement that WAF uses to identify matching web + // requests, and parameters that govern how WAF handles them. Rules []types.Rule noSmithyDocumentSerde diff --git a/service/wafv2/api_op_UpdateWebACL.go b/service/wafv2/api_op_UpdateWebACL.go index 99d1c575d6f..17104df3261 100644 --- a/service/wafv2/api_op_UpdateWebACL.go +++ b/service/wafv2/api_op_UpdateWebACL.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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: +// 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 // // A web ACL defines a collection of rules to use to inspect and control web @@ -25,22 +30,30 @@ import ( // requests and an action that WAF applies to requests that match the statement. 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, an Amazon -// Cognito user pool, an App Runner service, or an Amazon Web Services Verified -// Access instance. Temporary inconsistencies during updates When you create or -// change a web ACL or other WAF resources, the changes take a small amount of time -// to propagate to all areas where the resources are stored. The propagation time -// can be from a few seconds to a number of minutes. The following are examples of -// the temporary inconsistencies that you might notice during change propagation: +// 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, an Amazon Cognito user pool, +// an App Runner service, or an Amazon Web Services Verified Access instance. +// +// # Temporary inconsistencies during updates +// +// When you create or change a web ACL or other WAF resources, the changes take a +// small amount of time to propagate to all areas where the resources are stored. +// The propagation time can be from a few seconds to a number of minutes. +// +// The following are examples of the temporary inconsistencies that you might +// notice during change propagation: +// // - After you create a web ACL, if you try to associate it with a resource, you // might get an exception indicating that the web ACL is unavailable. +// // - After you add a rule group to a web ACL, the new rule group rules might be // in effect in one area where the web ACL is used and not in another. +// // - After you change a rule action setting, you might see the old action in // some places and the new action in others. +// // - After you add an IP address to an IP set that is in use in a blocking rule, // the new address might be blocked in one area while still allowed in another. func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, optFns ...func(*Options)) (*UpdateWebACLOutput, error) { @@ -92,29 +105,40 @@ type UpdateWebACLInput struct { // regional application. A regional application can be an Application Load Balancer // (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito // user pool, an App Runner service, or an Amazon Web Services Verified Access - // instance. To work with CloudFront, you must also specify the Region US East (N. - // Virginia) as follows: + // instance. + // + // 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. // // This member is required. Scope types.Scope - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. VisibilityConfig *types.VisibilityConfig // Specifies custom configurations for the associations between the web ACL and - // protected resources. Use this to customize the maximum size of the request body - // that your protected resources forward to WAF for inspection. You can customize - // this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or - // Verified Access resources. The default setting is 16 KB (16,384 bytes). You are - // charged additional fees when your protected resources forward body sizes that - // are larger than the default. For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) - // . For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 + // protected resources. + // + // Use this to customize the maximum size of the request body that your protected + // resources forward to WAF for inspection. You can customize this setting for + // CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access + // resources. The default setting is 16 KB (16,384 bytes). + // + // You are charged additional fees when your protected resources forward body + // sizes that are larger than the default. For more information, see [WAF Pricing]. + // + // For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 // bytes). + // + // [WAF Pricing]: http://aws.amazon.com/waf/pricing/ AssociationConfig *types.AssociationConfig // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have @@ -130,19 +154,24 @@ type UpdateWebACLInput struct { // 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. 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. + // you define in the web ACL. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponseBodies map[string]types.CustomResponseBody // A description of the web ACL that helps with identification. Description *string - // The Rule statements used to identify the web requests that you want to manage. - // Each rule includes one top-level statement that WAF uses to identify matching - // web requests, and parameters that govern how WAF handles them. + // The Rule statements used to identify the web requests that you want to manage. Each + // rule includes one top-level statement that WAF uses to identify matching web + // requests, and parameters that govern how WAF handles them. Rules []types.Rule // Specifies the domains that WAF should accept in a web request token. This @@ -151,9 +180,12 @@ type UpdateWebACLInput struct { // is protecting. If you don't specify a list of token domains, WAF accepts tokens // only for the domain of the protected resource. With a token domain list, WAF // accepts the resource's host domain plus all domains in the token domain list, - // including their prefixed subdomains. Example JSON: "TokenDomains": { - // "mywebsite.com", "myotherwebsite.com" } Public suffixes aren't allowed. For - // example, you can't use gov.au or co.uk as token domains. + // including their prefixed subdomains. + // + // Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" } + // + // Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as + // token domains. TokenDomains []string noSmithyDocumentSerde diff --git a/service/wafv2/doc.go b/service/wafv2/doc.go index 2268e76dd46..3b8ba513677 100644 --- a/service/wafv2/doc.go +++ b/service/wafv2/doc.go @@ -3,17 +3,23 @@ // Package wafv2 provides the API client, operations, and parameter types for AWS // WAFV2. // -// WAF This is the latest version of the WAF API, released in November, 2019. The +// # WAF +// +// This is the latest version of the WAF API, released in November, 2019. The // names of the entities that you use to access this API, like endpoints and // namespaces, all have the versioning information added, like "V2" or "v2", to // distinguish from the prior version. We recommend migrating your resources to -// this version, because it has a number of significant improvements. If you used -// WAF prior to this release, you can't use this WAFV2 API to access any WAF -// 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 +// this version, because it has a number of significant improvements. +// +// If you used WAF prior to this release, you can't use this WAFV2 API to access +// any WAF 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]. +// +// 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, App Runner service, or Amazon Web Services Verified Access instance. @@ -21,32 +27,43 @@ // 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) -// . +// 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]. +// +// You can make calls using the endpoints listed in [WAF endpoints and quotas]. +// // - 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, an Amazon Cognito user pool, an App // Runner service, or an Amazon Web Services Verified Access instance. +// // - 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 +// more information, see [Amazon Web Services 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. +// +// [WAF endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/waf.html +// [Amazon Web Services SDKs]: http://aws.amazon.com/tools/#SDKs +// [WAF Developer Guide]: https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html package wafv2 diff --git a/service/wafv2/options.go b/service/wafv2/options.go index 90a71b90531..8180c0b0913 100644 --- a/service/wafv2/options.go +++ b/service/wafv2/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/wafv2/types/enums.go b/service/wafv2/types/enums.go index ce8a4b76d14..c74f5c8f67a 100644 --- a/service/wafv2/types/enums.go +++ b/service/wafv2/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for ActionValue. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ActionValue) Values() []ActionValue { return []ActionValue{ "ALLOW", @@ -40,8 +41,9 @@ const ( ) // Values returns all known values for AssociatedResourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociatedResourceType) Values() []AssociatedResourceType { return []AssociatedResourceType{ "CLOUDFRONT", @@ -63,6 +65,7 @@ const ( // Values returns all known values for BodyParsingFallbackBehavior. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (BodyParsingFallbackBehavior) Values() []BodyParsingFallbackBehavior { return []BodyParsingFallbackBehavior{ @@ -85,8 +88,9 @@ const ( ) // Values returns all known values for ComparisonOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ComparisonOperator) Values() []ComparisonOperator { return []ComparisonOperator{ "EQ", @@ -355,8 +359,9 @@ const ( ) // Values returns all known values for CountryCode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CountryCode) Values() []CountryCode { return []CountryCode{ "AF", @@ -623,8 +628,9 @@ const ( ) // Values returns all known values for FailureReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FailureReason) Values() []FailureReason { return []FailureReason{ "TOKEN_MISSING", @@ -643,8 +649,9 @@ const ( ) // Values returns all known values for FallbackBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FallbackBehavior) Values() []FallbackBehavior { return []FallbackBehavior{ "MATCH", @@ -661,8 +668,9 @@ const ( ) // Values returns all known values for FilterBehavior. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterBehavior) Values() []FilterBehavior { return []FilterBehavior{ "KEEP", @@ -679,8 +687,9 @@ const ( ) // Values returns all known values for FilterRequirement. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterRequirement) Values() []FilterRequirement { return []FilterRequirement{ "MEETS_ALL", @@ -698,8 +707,9 @@ const ( ) // Values returns all known values for ForwardedIPPosition. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ForwardedIPPosition) Values() []ForwardedIPPosition { return []ForwardedIPPosition{ "FIRST", @@ -717,8 +727,9 @@ const ( ) // Values returns all known values for InspectionLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InspectionLevel) Values() []InspectionLevel { return []InspectionLevel{ "COMMON", @@ -735,8 +746,9 @@ const ( ) // Values returns all known values for IPAddressVersion. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IPAddressVersion) Values() []IPAddressVersion { return []IPAddressVersion{ "IPV4", @@ -754,8 +766,9 @@ const ( ) // Values returns all known values for JsonMatchScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (JsonMatchScope) Values() []JsonMatchScope { return []JsonMatchScope{ "ALL", @@ -773,8 +786,9 @@ const ( ) // Values returns all known values for LabelMatchScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LabelMatchScope) Values() []LabelMatchScope { return []LabelMatchScope{ "LABEL", @@ -792,8 +806,9 @@ const ( ) // Values returns all known values for MapMatchScope. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MapMatchScope) Values() []MapMatchScope { return []MapMatchScope{ "ALL", @@ -812,8 +827,9 @@ const ( ) // Values returns all known values for OversizeHandling. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OversizeHandling) Values() []OversizeHandling { return []OversizeHandling{ "CONTINUE", @@ -899,8 +915,9 @@ const ( ) // Values returns all known values for ParameterExceptionField. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ParameterExceptionField) Values() []ParameterExceptionField { return []ParameterExceptionField{ "WEB_ACL", @@ -985,8 +1002,9 @@ const ( ) // Values returns all known values for PayloadType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PayloadType) Values() []PayloadType { return []PayloadType{ "JSON", @@ -1003,8 +1021,9 @@ const ( ) // Values returns all known values for Platform. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Platform) Values() []Platform { return []Platform{ "IOS", @@ -1024,8 +1043,9 @@ const ( ) // Values returns all known values for PositionalConstraint. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PositionalConstraint) Values() []PositionalConstraint { return []PositionalConstraint{ "EXACTLY", @@ -1048,8 +1068,9 @@ const ( // Values returns all known values for RateBasedStatementAggregateKeyType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RateBasedStatementAggregateKeyType) Values() []RateBasedStatementAggregateKeyType { return []RateBasedStatementAggregateKeyType{ "IP", @@ -1072,8 +1093,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -1095,8 +1117,9 @@ const ( ) // Values returns all known values for ResponseContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResponseContentType) Values() []ResponseContentType { return []ResponseContentType{ "TEXT_PLAIN", @@ -1114,8 +1137,9 @@ const ( ) // 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. +// the future, and so 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{ "CLOUDFRONT", @@ -1132,8 +1156,9 @@ const ( ) // Values returns all known values for SensitivityLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SensitivityLevel) Values() []SensitivityLevel { return []SensitivityLevel{ "LOW", @@ -1152,8 +1177,9 @@ const ( ) // Values returns all known values for SizeInspectionLimit. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SizeInspectionLimit) Values() []SizeInspectionLimit { return []SizeInspectionLimit{ "KB_16", @@ -1191,8 +1217,9 @@ const ( ) // Values returns all known values for TextTransformationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TextTransformationType) Values() []TextTransformationType { return []TextTransformationType{ "NONE", diff --git a/service/wafv2/types/errors.go b/service/wafv2/types/errors.go index 7ded895103d..27e1968e2fe 100644 --- a/service/wafv2/types/errors.go +++ b/service/wafv2/types/errors.go @@ -39,9 +39,12 @@ func (e *WAFAssociatedItemException) ErrorFault() smithy.ErrorFault { return smi // inspect the body must either provide an OversizeHandling configuration or they // must be preceded by a SizeConstraintStatement that blocks the body content from // 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: +// 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 ). type WAFConfigurationWarningException struct { Message *string @@ -97,7 +100,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,11 +183,15 @@ 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 . +// 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 { @@ -217,18 +224,25 @@ func (e *WAFInvalidParameterException) ErrorCode() string { func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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. +// // - 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]. +// +// [IAM Policies]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html type WAFInvalidPermissionPolicyException struct { Message *string @@ -285,8 +299,10 @@ func (e *WAFInvalidResourceException) ErrorFault() smithy.ErrorFault { return sm // 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. +// Amazon Web Services account. For more information, see [WAF quotas]in the WAF Developer +// Guide. +// +// [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html type WAFLimitsExceededException struct { Message *string @@ -315,8 +331,9 @@ 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]in the WAF Developer Guide. +// +// [Logging web ACL traffic information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html type WAFLogDestinationPermissionIssueException struct { Message *string diff --git a/service/wafv2/types/types.go b/service/wafv2/types/types.go index e10433d8bb1..54ed7aa9d3d 100644 --- a/service/wafv2/types/types.go +++ b/service/wafv2/types/types.go @@ -11,11 +11,12 @@ import ( type ActionCondition struct { // The action setting that a log record must contain in order to meet the - // condition. This is the action that WAF applied to the web request. For rule - // groups, this is either the configured rule action setting, or if you've applied - // a rule action override to the rule, it's the override action. The value - // EXCLUDED_AS_COUNT matches on excluded rules and also on rules that have a rule - // action override of Count. + // condition. This is the action that WAF applied to the web request. + // + // For rule groups, this is either the configured rule action setting, or if + // you've applied a rule action override to the rule, it's the override action. The + // value EXCLUDED_AS_COUNT matches on excluded rules and also on rules that have a + // rule action override of Count. // // This member is required. Action ActionValue @@ -24,24 +25,33 @@ type ActionCondition struct { } // The name of a field in the request payload that contains part or all of your -// customer's primary physical address. This data type is used in the -// RequestInspectionACFP data type. +// customer's primary physical address. +// +// This data type is used in the RequestInspectionACFP data type. type AddressField struct { - // The name of a single primary address field. How you specify the address fields - // depends on the request inspection payload type. + // The name of a single primary address field. + // + // How you specify the address fields depends on the request inspection payload + // type. + // // - For JSON payloads, specify the field identifiers 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 { "form": { "primaryaddressline1": + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "primaryaddressline1": // "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": // "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1 // , /form/primaryaddressline2 , and /form/primaryaddressline3 . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with input elements named primaryaddressline1 , + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with input elements named primaryaddressline1 , // primaryaddressline2 , and primaryaddressline3 , the address fields identifiers // are primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 . // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 + // // This member is required. Identifier *string @@ -49,35 +59,44 @@ type AddressField struct { } // Inspect all of the elements that WAF has parsed and extracted from the web -// request component that you've identified in your FieldToMatch specifications. -// This is used in the FieldToMatch specification for some web request component -// types. JSON specification: "All": {} +// request component that you've identified in your FieldToMatchspecifications. +// +// This is used in the FieldToMatch specification for some web request component types. +// +// JSON specification: "All": {} type All struct { noSmithyDocumentSerde } // 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 . +// custom handling for the request. +// +// This is used in the context of other settings, for example to specify values +// for RuleActionand 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. + // Defines custom handling for the web request. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde } -// Inspect all query arguments of the web request. This is used in the FieldToMatch -// specification for some web request component types. JSON specification: -// "AllQueryArguments": {} +// Inspect all query arguments of the web request. +// +// This is used in the FieldToMatch specification for some web request component types. +// +// JSON specification: "AllQueryArguments": {} type AllQueryArguments struct { noSmithyDocumentSerde } // 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 Statementwithin the AndStatement . type AndStatement struct { // The statements to combine with AND logic. You can use any statements that can @@ -89,12 +108,14 @@ type AndStatement struct { noSmithyDocumentSerde } -// Information for a single API key. API keys are required for the integration of -// the CAPTCHA API in your JavaScript client applications. The API lets you -// customize the placement and characteristics of the CAPTCHA puzzle for your end -// users. For more information about the CAPTCHA JavaScript integration, see WAF -// client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) -// in the WAF Developer Guide. +// Information for a single API key. +// +// API keys are required for the integration of the CAPTCHA API in your JavaScript +// client applications. The API lets you customize the placement and +// characteristics of the CAPTCHA puzzle for your end users. For more information +// about the CAPTCHA JavaScript integration, see [WAF client application integration]in the WAF Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html type APIKeySummary struct { // The generated, encrypted API key. You can copy this for use in your JavaScript @@ -114,24 +135,36 @@ type APIKeySummary struct { } // Specifies custom configurations for the associations between the web ACL and -// protected resources. Use this to customize the maximum size of the request body -// that your protected resources forward to WAF for inspection. You can customize -// this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or -// Verified Access resources. The default setting is 16 KB (16,384 bytes). You are -// charged additional fees when your protected resources forward body sizes that -// are larger than the default. For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) -// . For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 +// protected resources. +// +// Use this to customize the maximum size of the request body that your protected +// resources forward to WAF for inspection. You can customize this setting for +// CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access +// resources. The default setting is 16 KB (16,384 bytes). +// +// You are charged additional fees when your protected resources forward body +// sizes that are larger than the default. For more information, see [WAF Pricing]. +// +// For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 // bytes). +// +// [WAF Pricing]: http://aws.amazon.com/waf/pricing/ type AssociationConfig struct { // Customizes the maximum size of the request body that your protected CloudFront, // API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward // to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change - // the setting for any of the available resource types. You are charged additional - // fees when your protected resources forward body sizes that are larger than the - // default. For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) - // . Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" } For - // Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). + // the setting for any of the available resource types. + // + // You are charged additional fees when your protected resources forward body + // sizes that are larger than the default. For more information, see [WAF Pricing]. + // + // Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" } + // + // For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 + // bytes). + // + // [WAF Pricing]: http://aws.amazon.com/waf/pricing/ RequestBody map[string]RequestBodyAssociatedResourceTypeConfig noSmithyDocumentSerde @@ -144,24 +177,27 @@ type AWSManagedRulesACFPRuleSet struct { // The path of the account creation endpoint for your application. This is the // page on your website that accepts the completed registration form for a new - // user. This page must accept POST requests. For example, for the URL - // https://example.com/web/newaccount , you would provide the path /web/newaccount - // . Account creation page paths that start with the path that you provide are - // considered a match. For example /web/newaccount matches the account creation - // paths /web/newaccount , /web/newaccount/ , /web/newaccountPage , and - // /web/newaccount/thisPage , but doesn't match the path /home/web/newaccount or - // /website/newaccount . + // user. This page must accept POST requests. + // + // For example, for the URL https://example.com/web/newaccount , you would provide + // the path /web/newaccount . Account creation page paths that start with the path + // that you provide are considered a match. For example /web/newaccount matches + // the account creation paths /web/newaccount , /web/newaccount/ , + // /web/newaccountPage , and /web/newaccount/thisPage , but doesn't match the path + // /home/web/newaccount or /website/newaccount . // // This member is required. CreationPath *string // The path of the account registration endpoint for your application. This is the - // page on your website that presents the registration form to new users. This page - // must accept GET text/html requests. For example, for the URL - // https://example.com/web/registration , you would provide the path - // /web/registration . Registration page paths that start with the path that you - // provide are considered a match. For example /web/registration matches the - // registration paths /web/registration , /web/registration/ , + // page on your website that presents the registration form to new users. + // + // This page must accept GET text/html requests. + // + // For example, for the URL https://example.com/web/registration , you would + // provide the path /web/registration . Registration page paths that start with the + // path that you provide are considered a match. For example /web/registration + // matches the registration paths /web/registration , /web/registration/ , // /web/registrationPage , and /web/registration/thisPage , but doesn't match the // path /home/web/registration or /website/registration . // @@ -179,10 +215,13 @@ type AWSManagedRulesACFPRuleSet struct { EnableRegexInPath bool // The criteria for inspecting responses to account creation requests, used by the - // ACFP rule group to track account creation success rates. Response inspection is - // available only in web ACLs that protect Amazon CloudFront distributions. The - // ACFP rule group evaluates the responses that your protected resources send back - // to client account creation attempts, keeping count of successful and failed + // ACFP rule group to track account creation success rates. + // + // Response inspection is available only in web ACLs that protect Amazon + // CloudFront distributions. + // + // The ACFP rule group evaluates the responses that your protected resources send + // back to client account creation attempts, keeping count of successful and failed // attempts from each IP address and client session. Using this information, the // rule group labels and mitigates requests from client sessions and IP addresses // that have had too many successful account creation attempts in a short amount of @@ -202,8 +241,10 @@ type AWSManagedRulesATPRuleSet struct { // paths that start with the path that you provide are considered a match. For // example /web/login matches the login paths /web/login , /web/login/ , // /web/loginPage , and /web/login/thisPage , but doesn't match the login path - // /home/web/login or /website/login . The rule group inspects only HTTP POST - // requests to your specified login endpoint. + // /home/web/login or /website/login . + // + // The rule group inspects only HTTP POST requests to your specified login + // endpoint. // // This member is required. LoginPath *string @@ -216,13 +257,16 @@ type AWSManagedRulesATPRuleSet struct { RequestInspection *RequestInspection // The criteria for inspecting responses to login requests, used by the ATP rule - // group to track login failure rates. Response inspection is available only in web - // ACLs that protect Amazon CloudFront distributions. The ATP rule group evaluates - // the responses that your protected resources send back to client login attempts, - // keeping count of successful and failed attempts for each IP address and client - // session. Using this information, the rule group labels and mitigates requests - // from client sessions and IP addresses that have had too many failed login - // attempts in a short amount of time. + // group to track login failure rates. + // + // Response inspection is available only in web ACLs that protect Amazon + // CloudFront distributions. + // + // The ATP rule group evaluates the responses that your protected resources send + // back to client login attempts, keeping count of successful and failed attempts + // for each IP address and client session. Using this information, the rule group + // labels and mitigates requests from client sessions and IP addresses that have + // had too many failed login attempts in a short amount of time. ResponseInspection *ResponseInspection noSmithyDocumentSerde @@ -235,66 +279,88 @@ 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) - // in the WAF Developer Guide. + // rules with more advanced inspection criteria. For details, see [WAF Bot Control rule group]in the WAF + // Developer Guide. + // + // [WAF Bot Control rule group]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html // // This member is required. InspectionLevel InspectionLevel - // Applies only to the targeted inspection level. Determines whether to use - // machine learning (ML) to analyze your web traffic for bot-related activity. - // Machine learning is required for the Bot Control rules + // Applies only to the targeted inspection level. + // + // Determines whether to use machine learning (ML) to analyze your web traffic for + // bot-related activity. Machine learning is required for the Bot Control rules // TGT_ML_CoordinatedActivityLow and TGT_ML_CoordinatedActivityMedium , which // inspect for anomalous behavior that might indicate distributed, coordinated bot - // activity. For more information about this choice, see the listing for these - // rules in the table at Bot Control rules listing (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html#aws-managed-rule-groups-bot-rules) - // in the WAF Developer Guide. Default: TRUE + // activity. + // + // For more information about this choice, see the listing for these rules in the + // table at [Bot Control rules listing]in the WAF Developer Guide. + // + // Default: TRUE + // + // [Bot Control rules listing]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html#aws-managed-rule-groups-bot-rules EnableMachineLearning *bool noSmithyDocumentSerde } // 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 . +// custom handling for the response to the web request. +// +// This is used in the context of other settings, for example to specify values +// for RuleActionand web ACL 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. + // Defines a custom response for the web request. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponse *CustomResponse noSmithyDocumentSerde } // Inspect the body of the web request. The body immediately follows the request -// headers. This is used to indicate the web request component to inspect, in the -// FieldToMatch specification. +// headers. +// +// This is used to indicate the web request component to inspect, in the FieldToMatch +// specification. type Body struct { - // What WAF should do if the body is larger than WAF can inspect. WAF does not - // support inspecting the entire contents of the web request body if the body - // exceeds the limit for the resource type. When a web request body is larger than - // the limit, the underlying host service only forwards the contents that are - // within the limit to WAF for inspection. + // What WAF should do if the body is larger than WAF can inspect. + // + // WAF does not support inspecting the entire contents of the web request body if + // the body exceeds the limit for the resource type. When a web request body is + // larger than the limit, the underlying host service only forwards the contents + // that are within the limit to WAF for inspection. + // // - For Application Load Balancer and AppSync, the limit is fixed at 8 KB // (8,192 bytes). + // // - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified // Access, the default limit is 16 KB (16,384 bytes), and you can increase the // limit for each resource type in the web ACL AssociationConfig , for additional // processing fees. + // // The options for oversize handling are the following: + // // - CONTINUE - Inspect the available body contents 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 the limit. Default: CONTINUE + // over the limit. + // + // Default: CONTINUE OversizeHandling OversizeHandling noSmithyDocumentSerde @@ -314,55 +380,92 @@ 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 - // 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 . 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. + // + // 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 - // length of the value is 200 bytes. Valid values depend on the component that you - // specify for inspection in FieldToMatch : + // 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 . + // // - JA3Fingerprint : Match against the request's JA3 fingerprint. The JA3 // fingerprint is a 32-character hash derived from the TLS Client Hello of an // incoming request. This fingerprint serves as a unique identifier for the // client's TLS configuration. You can use this choice only with a string match - // ByteMatchStatement with the PositionalConstraint set to EXACTLY . You can - // obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is - // able to calculate the fingerprint, it includes it in the logs. For information - // about the logging fields, see Log fields (https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) - // in the WAF Developer Guide. + // ByteMatchStatement with the PositionalConstraint set to EXACTLY . + // + // You can obtain the JA3 fingerprint for client requests from the web ACL logs. + // If WAF is able to calculate the fingerprint, it includes it in the logs. For + // information about the logging fields, see [Log fields]in the WAF Developer Guide. + // // - HeaderOrder : The list of header names to match for. WAF creates a string // that contains the ordered list of header names, from the headers in the web // request, and then matches against that string. + // // 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. + // 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. + // + // [Log fields]: https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html // // This member is required. SearchString []byte @@ -383,29 +486,41 @@ 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. +// 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 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. +// 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. + // 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] in the WAF + // Developer Guide. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde @@ -441,36 +556,56 @@ 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. +// 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 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. +// 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. + // 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] in the WAF + // Developer Guide. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde @@ -504,7 +639,7 @@ 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 @@ -521,9 +656,13 @@ type Condition 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": [ -// "session-id-time", "session-id" ] } +// request. +// +// You must specify exactly one setting: either All , IncludedCookies , or +// ExcludedCookies . +// +// Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", +// "session-id" ] } type CookieMatchPattern struct { // Inspect all cookies. @@ -542,26 +681,35 @@ type CookieMatchPattern struct { // 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" -// } +// 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": [ - // "session-id-time", "session-id" ] } + // request. + // + // You must specify exactly one setting: either All , IncludedCookies , or + // ExcludedCookies . + // + // Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", + // "session-id" ] } // // 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. All does not require a match - // to be found in the keys and a match to be found in the values. It requires a - // match to be found in the keys or the values or both. To require a match in the - // keys and in the values, use a logical AND statement to combine two match rules, - // one that inspects the keys and another that inspects the values. + // specify ALL , WAF inspects both keys and values. + // + // All does not require a match to be found in the keys and a match to be found in + // the values. It requires a match to be found in the keys or the values or both. + // To require a match in the keys and in the values, use a logical AND statement + // to combine two match rules, one that inspects the keys and another that inspects + // the values. // // This member is required. MatchScope MapMatchScope @@ -570,11 +718,16 @@ type Cookies struct { // than WAF can inspect. WAF does not support inspecting the entire contents of // request cookies 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: + // cookie contents to WAF. + // + // The options for oversize handling are the following: + // // - CONTINUE - Inspect the available 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. @@ -584,26 +737,32 @@ 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 . +// custom handling for the request. +// +// This is used in the context of other settings, for example to specify values +// for RuleActionand 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. + // Defines custom handling for the web request. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomRequestHandling *CustomRequestHandling noSmithyDocumentSerde } -// A custom header for custom request and response handling. This is used in -// CustomResponse and CustomRequestHandling . +// A custom header for custom request and response handling. This is used in 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 . + // 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 . // // This member is required. Name *string @@ -619,15 +778,21 @@ type CustomHTTPHeader struct { // 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. +// okens, and AllowAction . +// +// For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF +// Developer Guide. +// +// [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.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. + // allowed. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html // // This member is required. InsertHeaders []CustomHTTPHeader @@ -636,16 +801,20 @@ 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 -// 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. +// 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] in the WAF +// Developer Guide. +// +// [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.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. + // 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] in + // the WAF Developer Guide. + // + // [Supported status codes for custom response]: https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html // // This member is required. ResponseCode *int32 @@ -653,30 +822,36 @@ type CustomResponse struct { // References the response body that you want WAF to return to the web request // client. You can define a custom response for a rule action or a default web ACL // action that is set to block. To do this, you first define the response body key - // and value in the CustomResponseBodies setting for the WebACL or RuleGroup where - // you want to use it. Then, in the rule action or web ACL default action - // BlockAction setting, you reference the response body using this key. + // and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to + // use it. Then, in the rule action or web ACL default action BlockAction setting, + // you reference the response body using this key. CustomResponseBodyKey *string // The HTTP headers to use in the response. You can specify any header name except - // for content-type . 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. + // for content-type . Duplicate header names are not allowed. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html ResponseHeaders []CustomHTTPHeader noSmithyDocumentSerde } // The response body to use in a custom response to a web request. This is -// referenced by key from CustomResponse CustomResponseBodyKey . +// referenced by key from CustomResponseCustomResponseBodyKey . 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. + // 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. + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html // // This member is required. Content *string @@ -689,7 +864,7 @@ type CustomResponseBody struct { noSmithyDocumentSerde } -// In a WebACL , this is the action that you want WAF to perform when a web request +// 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 { @@ -704,19 +879,28 @@ type DefaultAction struct { } // The name of the field in the request payload that contains your customer's -// email. This data type is used in the RequestInspectionACFP data type. +// email. +// +// This data type is used in the RequestInspectionACFP data type. type EmailField struct { - // The name of the email field. How you specify this depends on the request - // inspection payload type. + // The name of the email field. + // + // How you specify this depends on the request inspection 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 { "form": { "email": "THE_EMAIL" } } , the + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "email": "THE_EMAIL" } } , the // email field specification is /form/email . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named email1 , the email field - // specification is email1 . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named email1 , the email + // field specification is email1 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 // // This member is required. Identifier *string @@ -725,8 +909,10 @@ type EmailField 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 . @@ -739,19 +925,29 @@ type ExcludedRule struct { // Specifies a web request component to be used in a rule match statement or in a // logging configuration. +// // - In a rule statement, this is the part of the web request that you want WAF // to inspect. Include the single FieldToMatch type that you want to inspect, // with additional specifications as needed, according to the type. You specify a // single request component in FieldToMatch for each rule statement that requires // it. To inspect more than one component of the web request, create a separate -// rule statement for each component. Example JSON for a QueryString field to -// match: "FieldToMatch": { "QueryString": {} } Example JSON for a Method field -// to match specification: "FieldToMatch": { "Method": { "Name": "DELETE" } } +// rule statement for each component. +// +// Example JSON for a QueryString field to match: +// +// "FieldToMatch": { "QueryString": {} } +// +// Example JSON for a Method field to match specification: +// +// "FieldToMatch": { "Method": { "Name": "DELETE" } } +// // - In a logging configuration, this is used in the RedactedFields property to // specify a field to redact from the logging records. For this use case, note the // following: +// // - Even though all FieldToMatch settings are available, the only valid settings // for field redaction are UriPath , QueryString , SingleHeader , and Method . +// // - In this documentation, the descriptions of the individual fields talk about // specifying the web request component to inspect, but for field redaction, you // are specifying the component type to redact from the logs. @@ -763,27 +959,34 @@ type FieldToMatch struct { // 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. WAF does not support inspecting the entire contents of the web - // request body if the body exceeds the limit for the resource type. When a web - // request body is larger than the limit, the underlying host service only forwards - // the contents that are within the limit to WAF for inspection. + // data from a form. + // + // WAF does not support inspecting the entire contents of the web request body if + // the body exceeds the limit for the resource type. When a web request body is + // larger than the limit, the underlying host service only forwards the contents + // that are within the limit to WAF for inspection. + // // - For Application Load Balancer and AppSync, the limit is fixed at 8 KB // (8,192 bytes). + // // - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified // Access, the default limit is 16 KB (16,384 bytes), and you can increase the // limit for each resource type in the web ACL AssociationConfig , for additional // processing fees. + // // 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 - // 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 - // to the cookies that it receives from the underlying host service. + // 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 to the cookies that it receives from + // the underlying host service. Cookies *Cookies // Inspect a string containing the list of the request's header names, ordered as @@ -795,11 +998,13 @@ type FieldToMatch struct { // Inspect the request headers. You must configure scope and pattern matching // filters in the Headers object, to define the set of headers to and the parts of - // the headers that WAF inspects. Only the first 8 KB (8192 bytes) of a request's - // headers and only the first 200 headers are forwarded to WAF for inspection by - // the underlying host service. You must configure how to handle any oversize - // header content in the Headers object. WAF applies the pattern matching filters - // to the headers that it receives from the underlying host service. + // the headers that WAF inspects. + // + // Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 + // headers are forwarded to WAF for inspection by the underlying host service. You + // must configure how to handle any oversize header content in the Headers object. + // WAF applies the pattern matching filters to the headers that it receives from + // the underlying host service. Headers *Headers // Match against the request's JA3 fingerprint. The JA3 fingerprint is a @@ -807,29 +1012,40 @@ type FieldToMatch struct { // fingerprint serves as a unique identifier for the client's TLS configuration. // WAF calculates and logs this fingerprint for each request that has enough TLS // Client Hello information for the calculation. Almost all web requests include - // this information. You can use this choice only with a string match - // ByteMatchStatement with the PositionalConstraint set to EXACTLY . You can obtain - // the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to - // calculate the fingerprint, it includes it in the logs. For information about the - // logging fields, see Log fields (https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) - // in the WAF Developer Guide. Provide the JA3 fingerprint string from the logs in - // your string match statement specification, to match with any future requests - // that have the same TLS configuration. + // this information. + // + // You can use this choice only with a string match ByteMatchStatement with the + // PositionalConstraint set to EXACTLY . + // + // You can obtain the JA3 fingerprint for client requests from the web ACL logs. + // If WAF is able to calculate the fingerprint, it includes it in the logs. For + // information about the logging fields, see [Log fields]in the WAF Developer Guide. + // + // Provide the JA3 fingerprint string from the logs in your string match statement + // specification, to match with any future requests that have the same TLS + // configuration. + // + // [Log fields]: https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html JA3Fingerprint *JA3Fingerprint // Inspect the request body as JSON. 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. WAF does not support inspecting the entire contents of the web - // request body if the body exceeds the limit for the resource type. When a web - // request body is larger than the limit, the underlying host service only forwards - // the contents that are within the limit to WAF for inspection. + // from a form. + // + // WAF does not support inspecting the entire contents of the web request body if + // the body exceeds the limit for the resource type. When a web request body is + // larger than the limit, the underlying host service only forwards the contents + // that are within the limit to WAF for inspection. + // // - For Application Load Balancer and AppSync, the limit is fixed at 8 KB // (8,192 bytes). + // // - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified // Access, the default limit is 16 KB (16,384 bytes), and you can increase the // limit for each resource type in the web ACL AssociationConfig , for additional // processing fees. + // // For information about how to handle oversized request bodies, see the JsonBody // object configuration. JsonBody *JsonBody @@ -843,15 +1059,19 @@ type FieldToMatch struct { 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 Headers FieldToMatch setting. + // 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 // inspect, such as UserName or SalesRegion. The name can be up to 30 characters - // long and isn't case sensitive. Example JSON: "SingleQueryArgument": { "Name": - // "myArgument" } + // long and isn't case sensitive. + // + // Example JSON: "SingleQueryArgument": { "Name": "myArgument" } SingleQueryArgument *SingleQueryArgument // Inspect the request URI path. This is the part of the web request that @@ -861,7 +1081,7 @@ type FieldToMatch struct { 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. @@ -888,7 +1108,7 @@ 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 @@ -901,13 +1121,15 @@ type FirewallManagerRuleGroup struct { // The action to use in the place of the action that results from the rule group // 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 - // 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. + // 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 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. // // This member is required. OverrideAction *OverrideAction @@ -920,7 +1142,8 @@ type FirewallManagerRuleGroup struct { // This member is required. Priority int32 - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. VisibilityConfig *VisibilityConfig @@ -929,7 +1152,7 @@ type FirewallManagerRuleGroup struct { } // The processing guidance for an Firewall Manager rule. This is like a regular -// rule Statement , but it can only contain a single rule group reference. +// rule Statement, but it can only contain a single rule group reference. type FirewallManagerStatement struct { // A statement used by Firewall Manager to run the rules that are defined in a @@ -948,28 +1171,37 @@ type FirewallManagerStatement struct { // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // 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 -// IPSetForwardedIPConfig instead. WAF only evaluates the first IP address found in -// the specified HTTP header. +// 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 IPSetForwardedIPConfig instead. +// +// WAF only evaluates the first IP address found in the specified HTTP header. type ForwardedIPConfig 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. + // 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. // // 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 - // header isn't present in the request, WAF doesn't apply the rule to the web - // request at all. + // 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. // // This member is required. HeaderName *string @@ -980,9 +1212,11 @@ type ForwardedIPConfig struct { // 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 @@ -991,39 +1225,52 @@ type ForwardedIPConfig struct { // 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) -// . +// 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] in the [WAF Developer Guide]. +// +// [Geographic match rule statement]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html +// [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 - // 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 - // count matching requests, but it will still generate logging and count metrics - // for any matches. You can reduce the logging and metrics that the rule produces - // by specifying a country that's unlikely to be a source of traffic to your site. + // 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 count matching requests, + // but it will still generate logging and count metrics for any matches. You can + // reduce the logging and metrics that the rule produces by specifying a country + // that's unlikely to be a source of traffic to your site. CountryCodes []CountryCode // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // 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. + // 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. ForwardedIPConfig *ForwardedIPConfig 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": [ -// "KeyToExclude1", "KeyToExclude2" ] } +// request. +// +// You must specify exactly one setting: either All , IncludedHeaders , or +// ExcludedHeaders . +// +// Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", +// "KeyToExclude2" ] } type HeaderMatchPattern struct { // Inspect all headers. @@ -1051,11 +1298,16 @@ type HeaderOrder struct { // than WAF can inspect. WAF does not support inspecting the entire contents of // request headers 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: + // header contents to WAF. + // + // The options for oversize handling are the following: + // // - CONTINUE - Inspect the available 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. @@ -1066,27 +1318,38 @@ type HeaderOrder struct { // 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. +// 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": [ - // "KeyToExclude1", "KeyToExclude2" ] } + // 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. All does not require a match - // to be found in the keys and a match to be found in the values. It requires a - // match to be found in the keys or the values or both. To require a match in the - // keys and in the values, use a logical AND statement to combine two match rules, - // one that inspects the keys and another that inspects the values. + // specify ALL , WAF inspects both keys and values. + // + // All does not require a match to be found in the keys and a match to be found in + // the values. It requires a match to be found in the keys or the values or both. + // To require a match in the keys and in the values, use a logical AND statement + // to combine two match rules, one that inspects the keys and another that inspects + // the values. // // This member is required. MatchScope MapMatchScope @@ -1095,11 +1358,16 @@ type Headers struct { // than WAF can inspect. WAF does not support inspecting the entire contents of // request headers 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: + // header contents to WAF. + // + // The options for oversize handling are the following: + // // - CONTINUE - Inspect the available 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. @@ -1108,9 +1376,9 @@ type Headers struct { noSmithyDocumentSerde } -// 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. +// 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 { // The name of the HTTP header. @@ -1122,23 +1390,26 @@ type HTTPHeader struct { noSmithyDocumentSerde } -// 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. +// 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 { // 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 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]. + // + // [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 . @@ -1164,8 +1435,9 @@ type HTTPRequest struct { type ImmunityTimeProperty struct { // The amount of time, in seconds, that a CAPTCHA or challenge timestamp is - // considered valid by WAF. The default setting is 300. For the Challenge action, - // the minimum setting is 300. + // considered valid by WAF. The default setting is 300. + // + // For the Challenge action, the minimum setting is 300. // // This member is required. ImmunityTime *int64 @@ -1176,9 +1448,12 @@ 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]. +// +// WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, +// you provide the ARN to the Rulestatement IPSetReferenceStatement. +// +// [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing type IPSet struct { // The Amazon Resource Name (ARN) of the entity. @@ -1189,28 +1464,40 @@ type IPSet struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses that you want WAF to inspect for in incoming requests. 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: + // notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0 . + // + // Example address strings: + // // - For requests that originated from the IP address 192.0.2.44, specify // 192.0.2.44/32 . + // // - For requests that originated from IP addresses from 192.0.2.0 to // 192.0.2.255, specify 192.0.2.0/24 . + // // - For 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 . + // // - For 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: + // + // For more information about CIDR notation, see the Wikipedia entry [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 // + // [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing + // // This member is required. Addresses []string @@ -1240,27 +1527,35 @@ type IPSet struct { // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // 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. +// 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. 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. + // 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. // // 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 - // header isn't present in the request, WAF doesn't apply the rule to the web - // request at all. + // 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. // // This member is required. HeaderName *string @@ -1269,11 +1564,16 @@ type IPSetForwardedIPConfig struct { // IP addresses of the original client and also of proxies. For example, the header // 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: + // 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. // @@ -1284,12 +1584,14 @@ type IPSetForwardedIPConfig struct { } // 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 or address ranges. To use this, create an IPSetthat 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. +// 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 { // The Amazon Resource Name (ARN) of the IPSet that this statement references. @@ -1300,17 +1602,18 @@ type IPSetReferenceStatement struct { // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // 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. + // 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. IPSetForwardedIPConfig *IPSetForwardedIPConfig noSmithyDocumentSerde } -// 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 . +// 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. type IPSetSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -1344,20 +1647,30 @@ type IPSetSummary struct { // fingerprint serves as a unique identifier for the client's TLS configuration. // WAF calculates and logs this fingerprint for each request that has enough TLS // Client Hello information for the calculation. Almost all web requests include -// this information. You can use this choice only with a string match -// ByteMatchStatement with the PositionalConstraint set to EXACTLY . You can obtain -// the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to -// calculate the fingerprint, it includes it in the logs. For information about the -// logging fields, see Log fields (https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) -// in the WAF Developer Guide. Provide the JA3 fingerprint string from the logs in -// your string match statement specification, to match with any future requests -// that have the same TLS configuration. +// this information. +// +// You can use this choice only with a string match ByteMatchStatement with the +// PositionalConstraint set to EXACTLY . +// +// You can obtain the JA3 fingerprint for client requests from the web ACL logs. +// If WAF is able to calculate the fingerprint, it includes it in the logs. For +// information about the logging fields, see [Log fields]in the WAF Developer Guide. +// +// Provide the JA3 fingerprint string from the logs in your string match statement +// specification, to match with any future requests that have the same TLS +// configuration. +// +// [Log fields]: https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html type JA3Fingerprint struct { // The match status to assign to the web request if the request doesn't have a JA3 - // fingerprint. You can specify the following fallback behaviors: + // fingerprint. + // + // 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. // // This member is required. @@ -1367,12 +1680,16 @@ type JA3Fingerprint struct { } // Inspect the body of the web request as JSON. The body immediately follows the -// request headers. This is used to indicate the web request component to inspect, -// in the FieldToMatch specification. Use the specifications in this object to -// indicate which parts of the JSON body to inspect using the rule's inspection -// criteria. WAF inspects only the parts of the JSON that result from the matches -// that you indicate. Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, -// "MatchScope": "ALL" } +// request headers. +// +// This is used to indicate the web request component to inspect, in the FieldToMatch +// specification. +// +// Use the specifications in this object to indicate which parts of the JSON body +// to inspect using the rule's inspection criteria. WAF inspects only the parts of +// the JSON that result from the matches that you indicate. +// +// Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" } type JsonBody struct { // The patterns to look for in the JSON body. WAF inspects the results of these @@ -1382,83 +1699,109 @@ type JsonBody struct { MatchPattern *JsonMatchPattern // The parts of the JSON to match against using the MatchPattern . If you specify - // ALL , WAF matches against keys and values. All does not require a match to be - // found in the keys and a match to be found in the values. It requires a match to - // be found in the keys or the values or both. To require a match in the keys and - // in the values, use a logical AND statement to combine two match rules, one that - // inspects the keys and another that inspects the values. + // ALL , WAF matches against keys and values. + // + // All does not require a match to be found in the keys and a match to be found in + // the values. It requires a match to be found in the keys or the values or both. + // To require a match in the keys and in the values, use a logical AND statement + // to combine two match rules, one that inspects the keys and another that inspects + // the 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: + // 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 - // support inspecting the entire contents of the web request body if the body - // exceeds the limit for the resource type. When a web request body is larger than - // the limit, the underlying host service only forwards the contents that are - // within the limit to WAF for inspection. + // What WAF should do if the body is larger than WAF can inspect. + // + // WAF does not support inspecting the entire contents of the web request body if + // the body exceeds the limit for the resource type. When a web request body is + // larger than the limit, the underlying host service only forwards the contents + // that are within the limit to WAF for inspection. + // // - For Application Load Balancer and AppSync, the limit is fixed at 8 KB // (8,192 bytes). + // // - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified // Access, the default limit is 16 KB (16,384 bytes), and you can increase the // limit for each resource type in the web ACL AssociationConfig , for additional // processing fees. + // // The options for oversize handling are the following: + // // - CONTINUE - Inspect the available body contents 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 the limit. Default: CONTINUE + // over the limit. + // + // Default: CONTINUE OversizeHandling OversizeHandling noSmithyDocumentSerde } // 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 . +// pattern matches against the rule inspection criteria. This is used with the FieldToMatch +// option JsonBody . type JsonMatchPattern struct { - // Match all of the elements. See also MatchScope in JsonBody . You must specify - // either this setting or the IncludedPaths setting, but not both. + // 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 . + // 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. + // syntax, see the Internet Engineering Task Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // 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. + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 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. @@ -1470,24 +1813,28 @@ type Label struct { } // 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 -// label name. The prefix identifies the rule group or web ACL context of the rule -// that added the label. If you do not provide the fully qualified name in your -// label match string, WAF performs the search for labels that were added in the -// same context as the label match statement. +// 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 label name. The prefix identifies the rule group or web +// ACL context of the rule that added the label. If you do not provide the fully +// qualified name in your label match string, WAF performs the search for labels +// that were added in the same context as the label match statement. 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 . // @@ -1516,12 +1863,14 @@ type LabelNameCondition struct { noSmithyDocumentSerde } -// 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: +// 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 . +// 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. +// in a LabelMatchStatement specification, in the Statementdefinition of a rule. type LabelSummary struct { // An individual label specification. @@ -1533,31 +1882,47 @@ type LabelSummary struct { // Defines an association between logging destinations and a web ACL resource, for // logging from WAF. As part of the association, you can specify parts of the // standard logging fields to keep out of the logs and you can specify filters so -// 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: +// 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. +// 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]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. +// +// For additional information about web ACL logging, see [Logging web ACL traffic information] in the WAF Developer +// Guide. +// +// [Logging web ACL traffic information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html +// +// [Logging web ACL traffic]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html type LoggingConfiguration struct { // The logging destination configuration that you want to associate with the web - // ACL. You can associate one logging destination to a web ACL. + // ACL. + // + // You can associate one logging destination to a web ACL. // // This member is required. LogDestinationConfigs []string @@ -1578,22 +1943,27 @@ type LoggingConfiguration struct { // or delete the configuration. 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 - // for all rules that use the SingleHeader FieldToMatch setting. Redaction applies - // only to the component that's specified in the rule's FieldToMatch setting, so - // the SingleHeader redaction doesn't apply to rules that use the Headers - // FieldToMatch . You can specify only the following fields for redaction: UriPath - // , QueryString , SingleHeader , and Method . + // 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 for all rules that use the SingleHeader FieldToMatch setting. + // + // Redaction applies only to the component that's specified in the rule's + // FieldToMatch setting, so the SingleHeader redaction doesn't apply to rules that + // use the Headers FieldToMatch . + // + // You can specify only the following fields for redaction: UriPath , QueryString , + // SingleHeader , and Method . 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 -// rule action and on the web request labels that were applied by matching rules -// during web ACL evaluation. +// 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 { // Default handling for logs that don't match any of the specified filtering @@ -1645,8 +2015,9 @@ type ManagedProductDescriptor struct { // topic that's used to provide notification of 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) - // . + // more information, see the [Amazon Simple Notification Service Developer Guide]. + // + // [Amazon Simple Notification Service Developer Guide]: https://docs.aws.amazon.com/sns/latest/dg/welcome.html SnsTopicArn *string // The name of the managed rule group vendor. You use this, along with the rule @@ -1657,51 +2028,63 @@ type ManagedProductDescriptor struct { } // Additional information that's used by a managed rule group. Many managed rule -// groups don't require this. The rule groups used for intelligent threat -// mitigation require additional configuration: +// groups don't require this. +// +// The rule groups used for intelligent threat mitigation require additional +// configuration: +// // - Use the AWSManagedRulesACFPRuleSet configuration object to configure the // account creation fraud prevention managed rule group. The configuration includes // the registration and sign-up pages of your application and the locations in the // account creation request payload of data, such as the user email and phone // number fields. +// // - Use the AWSManagedRulesATPRuleSet configuration object to configure the // account takeover prevention managed rule group. The configuration includes the // sign-in page of your application and the locations in the login request payload // of data such as the username and password. +// // - 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 . +// For example specifications, see the examples section of CreateWebACL. type ManagedRuleGroupConfig struct { // Additional configuration for using the account creation fraud prevention (ACFP) // managed rule group, AWSManagedRulesACFPRuleSet . Use this to provide account // creation 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 account creation requests. For information about - // using the ACFP managed rule group, see WAF Fraud Control account creation fraud - // prevention (ACFP) rule group (https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-acfp.html) - // and WAF Fraud Control account creation fraud prevention (ACFP) (https://docs.aws.amazon.com/waf/latest/developerguide/waf-acfp.html) - // in the WAF Developer Guide. + // your distribution responds to account creation requests. + // + // For information about using the ACFP managed rule group, see [WAF Fraud Control account creation fraud prevention (ACFP) rule group] and [WAF Fraud Control account creation fraud prevention (ACFP)] in the WAF + // Developer Guide. + // + // [WAF Fraud Control account creation fraud prevention (ACFP) rule group]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-acfp.html + // [WAF Fraud Control account creation fraud prevention (ACFP)]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-acfp.html AWSManagedRulesACFPRuleSet *AWSManagedRulesACFPRuleSet // 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. + // 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] and [WAF Fraud Control account takeover prevention (ATP)] in the WAF + // Developer Guide. + // + // [WAF Fraud Control account takeover prevention (ATP) rule group]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html + // [WAF Fraud Control account takeover prevention (ATP)]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html 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]and [WAF Bot Control] in the WAF Developer Guide. + // + // [WAF Bot Control rule group]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html + // [WAF Bot Control]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html AWSManagedRulesBotControlRuleSet *AWSManagedRulesBotControlRuleSet // Instead of this setting, provide your configuration under @@ -1739,17 +2122,20 @@ type ManagedRuleGroupConfig 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 . You cannot use a -// managed rule group inside another rule group. You can only reference a managed -// rule group as a top-level statement within a rule that you define in a web ACL. +// 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 . You cannot use a managed rule group inside another +// rule group. You can only reference a managed rule group as a top-level statement +// within a rule that you define in a web ACL. +// // You are charged additional fees when you use the WAF Bot Control managed rule // group AWSManagedRulesBotControlRuleSet , the WAF Fraud Control account takeover // prevention (ATP) managed rule group AWSManagedRulesATPRuleSet , or the WAF Fraud // Control account creation fraud prevention (ACFP) managed rule group -// AWSManagedRulesACFPRuleSet . For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) -// . +// AWSManagedRulesACFPRuleSet . For more information, see [WAF Pricing]. +// +// [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, @@ -1764,41 +2150,48 @@ 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 - // groups don't require this. The rule groups used for intelligent threat - // mitigation require additional configuration: + // groups don't require this. + // + // The rule groups used for intelligent threat mitigation require additional + // configuration: + // // - Use the AWSManagedRulesACFPRuleSet configuration object to configure the // account creation fraud prevention managed rule group. The configuration includes // the registration and sign-up pages of your application and the locations in the // account creation request payload of data, such as the user email and phone // number fields. + // // - Use the AWSManagedRulesATPRuleSet configuration object to configure the // account takeover prevention managed rule group. The configuration includes the // sign-in page of your application and the locations in the login request payload // of data such as the username and password. + // // - Use the AWSManagedRulesBotControlRuleSet configuration object to configure // the protection level that you want the Bot Control rule group to use. ManagedRuleGroupConfigs []ManagedRuleGroupConfig // Action settings to use in the place of the rule actions that are 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. + // 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. 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 - // 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. + // group if they match the scope-down statement. You can use any nestable Statementin the + // scope-down statement, and you can nest statements at any level, the same as you + // can for a rule statement. ScopeDownStatement *Statement // The version of the managed rule group to use. If you specify this, the version @@ -1810,13 +2203,12 @@ type ManagedRuleGroupStatement struct { noSmithyDocumentSerde } -// High-level information about a managed rule group, returned by -// 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 -// and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web -// Services Marketplace managed rule group, first subscribe to the rule group -// through Amazon Web Services Marketplace. +// High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides +// information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatementto a +// web ACL. Managed rule groups include Amazon Web Services Managed Rules rule +// groups and Amazon Web Services Marketplace managed rule groups. To use any +// Amazon Web Services Marketplace managed rule group, first subscribe to the rule +// group through Amazon Web Services Marketplace. type ManagedRuleGroupSummary struct { // The description of the managed rule group, provided by Amazon Web Services @@ -1832,7 +2224,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 @@ -1853,10 +2245,13 @@ type ManagedRuleGroupVersion struct { // A set of rules that is managed by Amazon Web Services and Amazon Web Services // Marketplace sellers to provide versioned managed rule groups for customers of -// WAF. 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 +// WAF. +// +// 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 ManagedRuleSet struct { @@ -1874,8 +2269,10 @@ type ManagedRuleSet struct { Id *string // The name of the managed rule set. You use this, along with the rule set ID, to - // identify the rule set. This name is assigned to the corresponding managed rule - // group, which your customers can access and use. + // identify the rule set. + // + // This name is assigned to the corresponding managed rule group, which your + // customers can access and use. // // This member is required. Name *string @@ -1886,12 +2283,18 @@ 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:: : + // 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: : + // from the rule, separated by a colon: + // + // : LabelNamespace *string // The versions of this managed rule set that are available for use by customers. @@ -1903,12 +2306,15 @@ type ManagedRuleSet struct { noSmithyDocumentSerde } -// High-level information for 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 . +// High-level information for 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 ManagedRuleSetSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -1925,12 +2331,18 @@ type ManagedRuleSetSummary 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:: : + // 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: : + // from the rule, separated by a colon: + // + // : LabelNamespace *string // A token used for optimistic locking. WAF returns a token to your get and list @@ -1943,19 +2355,23 @@ type ManagedRuleSetSummary struct { LockToken *string // The name of the managed rule set. You use this, along with the rule set ID, to - // identify the rule set. This name is assigned to the corresponding managed rule - // group, which your customers can access and use. + // identify the rule set. + // + // This name is assigned to the corresponding managed rule group, which your + // customers can access and use. Name *string 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 +// 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 { @@ -1963,53 +2379,62 @@ type ManagedRuleSetVersion struct { // 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. For more information, see WAF web - // ACL capacity units (WCU) (https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) - // in the WAF Developer Guide. + // 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. For more information, + // see [WAF web ACL capacity units (WCU)]in the WAF Developer Guide. + // + // [WAF web ACL capacity units (WCU)]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html Capacity *int64 - // The time that this version is set 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 this version is set to expire. + // + // Times are in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". ExpiryTimestamp *time.Time // The amount of time you expect this version of your managed rule group to last, // in days. ForecastedLifetime *int32 - // The last time that you updated this version. Times are in Coordinated Universal - // Time (UTC) format. UTC format includes the special designator, Z. For example, - // "2016-09-27T14:50Z". + // The last time that you updated this version. + // + // Times are in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". LastUpdateTimestamp *time.Time - // The time that you first published this version. 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 first published this version. + // + // Times are in Coordinated Universal Time (UTC) format. UTC format includes the + // special designator, Z. For example, "2016-09-27T14:50Z". PublishTimestamp *time.Time noSmithyDocumentSerde } // Inspect the HTTP method of the web request. The method indicates the type of -// operation that the request is asking the origin to perform. This is used in the -// FieldToMatch specification for some web request component types. JSON -// specification: "Method": {} +// operation that the request is asking the origin to perform. +// +// This is used in the FieldToMatch specification for some web request component types. +// +// JSON specification: "Method": {} type Method struct { noSmithyDocumentSerde } // Information for a release of the mobile SDK, including release 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) -// in the WAF Developer Guide. +// requests from a mobile device to WAF. For more information, see [WAF client application integration]in the WAF +// Developer Guide. +// +// [WAF client application integration]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html type MobileSdkRelease struct { // Notes describing the release. @@ -2028,15 +2453,18 @@ 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": {} +// setting on a Rulewhen the rule uses a rule group reference statement. +// +// This is used in the context of other settings, for example to specify values +// for RuleActionand 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 Statementwithin the NotStatement . type NotStatement struct { // The statement to negate. You can use any statement that can be nested. @@ -2048,7 +2476,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 Statementwithin the OrStatement . type OrStatement struct { // The statements to combine with OR logic. You can use any statements that can be @@ -2062,20 +2490,23 @@ type OrStatement struct { // The action to use in the place of the action that results from the rule group // 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 -// 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. +// 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 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. 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. + // 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. Count *CountAction // Don't override the rule group evaluation result. This is the most common @@ -2086,20 +2517,29 @@ type OverrideAction struct { } // The name of the field in the request payload that contains your customer's -// password. This data type is used in the RequestInspection and -// RequestInspectionACFP data types. +// password. +// +// This data type is used in the RequestInspection and RequestInspectionACFP data +// types. type PasswordField struct { - // The name of the password field. How you specify this depends on the request - // inspection payload type. + // The name of the password field. + // + // How you specify this depends on the request inspection 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 { "form": { "password": "THE_PASSWORD" } } - // , the password field specification is /form/password . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named password1 , the password field - // specification is password1 . + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } } , + // the password field specification is /form/password . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named password1 , the + // password field specification is password1 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 // // This member is required. Identifier *string @@ -2108,24 +2548,33 @@ type PasswordField struct { } // The name of a field in the request payload that contains part or all of your -// customer's primary phone number. This data type is used in the -// RequestInspectionACFP data type. +// customer's primary phone number. +// +// This data type is used in the RequestInspectionACFP data type. type PhoneNumberField struct { - // The name of a single primary phone number field. How you specify the phone - // number fields depends on the request inspection payload type. + // The name of a single primary phone number field. + // + // How you specify the phone number fields depends on the request inspection + // payload type. + // // - For JSON payloads, specify the field identifiers 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 { "form": { "primaryphoneline1": + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "primaryphoneline1": // "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": // "THE_PHONE3" } } , the phone number field identifiers are // /form/primaryphoneline1 , /form/primaryphoneline2 , and // /form/primaryphoneline3 . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with input elements named primaryphoneline1 , primaryphoneline2 , - // and primaryphoneline3 , the phone number field identifiers are - // primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with input elements named primaryphoneline1 , + // primaryphoneline2 , and primaryphoneline3 , the phone number field identifiers + // are primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 // // This member is required. Identifier *string @@ -2134,9 +2583,11 @@ type PhoneNumberField struct { } // Inspect the query string of the web request. This is the part of a URL that -// appears after a ? character, if any. This is used in the FieldToMatch -// specification for some web request component types. JSON specification: -// "QueryString": {} +// appears after a ? character, if any. +// +// This is used in the FieldToMatch specification for some web request component types. +// +// JSON specification: "QueryString": {} type QueryString struct { noSmithyDocumentSerde } @@ -2144,101 +2595,146 @@ type QueryString struct { // A rate-based rule counts incoming requests and rate limits requests when they // are coming at too fast a rate. The rule categorizes requests according to your // aggregation criteria, collects them into aggregation instances, and counts and -// rate limits the requests for each instance. If you change any of these settings -// in a rule that's currently in use, the change resets the rule's rate limiting -// counts. This can pause the rule's rate limiting activities for up to a minute. -// You can specify individual aggregation keys, like IP address or HTTP method. You -// can also specify aggregation key combinations, like IP address and HTTP method, -// or HTTP method, query argument, and cookie. Each unique set of values for the -// aggregation keys that you specify is a separate aggregation instance, with the -// value from each key contributing to the aggregation instance definition. For -// example, assume the rule evaluates web requests with the following IP address -// and HTTP method values: +// rate limits the requests for each instance. +// +// If you change any of these settings in a rule that's currently in use, the +// change resets the rule's rate limiting counts. This can pause the rule's rate +// limiting activities for up to a minute. +// +// You can specify individual aggregation keys, like IP address or HTTP method. +// You can also specify aggregation key combinations, like IP address and HTTP +// method, or HTTP method, query argument, and cookie. +// +// Each unique set of values for the aggregation keys that you specify is a +// separate aggregation instance, with the value from each key contributing to the +// aggregation instance definition. +// +// For example, assume the rule evaluates web requests with the following IP +// address and HTTP method values: +// // - IP address 10.1.1.1, HTTP method POST +// // - IP address 10.1.1.1, HTTP method GET +// // - IP address 127.0.0.0, HTTP method POST +// // - IP address 10.1.1.1, HTTP method GET // // The rule would create different aggregation instances according to your // aggregation criteria, for example: +// // - If the aggregation criteria is just the IP address, then each individual // address is an aggregation instance, and WAF counts requests separately for each. // The aggregation instances and request counts for our example would be the // following: +// // - IP address 10.1.1.1: count 3 +// // - IP address 127.0.0.0: count 1 +// // - If the aggregation criteria is HTTP method, then each individual HTTP // method is an aggregation instance. The aggregation instances and request counts // for our example would be the following: +// // - HTTP method POST: count 2 +// // - HTTP method GET: count 2 +// // - If the aggregation criteria is IP address and HTTP method, then each IP // address and each HTTP method would contribute to the combined aggregation // instance. The aggregation instances and request counts for our example would be // the following: +// // - IP address 10.1.1.1, HTTP method POST: count 1 +// // - IP address 10.1.1.1, HTTP method GET: count 2 +// // - IP address 127.0.0.0, HTTP method POST: count 1 // -// For any n-tuple of aggregation keys, each unique combination of values for the -// keys defines a separate aggregation instance, which WAF counts and rate-limits -// individually. You can optionally nest another statement inside the rate-based -// statement, to narrow the scope of the rule so that it only counts and rate -// limits requests that match the nested statement. You can use this nested -// scope-down statement in conjunction with your aggregation key specifications or -// you can just count and rate limit all requests that match the scope-down -// statement, without additional aggregation. When you choose to just manage all -// requests that match a scope-down statement, the aggregation instance is singular -// for the 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. For additional -// information about the options, see Rate limiting web requests using rate-based -// rules (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html) -// in the WAF Developer Guide. If you only aggregate on the individual IP address -// or forwarded IP address, you can retrieve the list of IP addresses that WAF is -// currently rate limiting for a rule through the API call -// GetRateBasedStatementManagedKeys . This option is not available for other -// aggregation configurations. WAF tracks and manages web requests separately for -// each instance of a rate-based rule that you use. For example, if you provide the -// same rate-based rule settings in two web ACLs, each of the two rule statements -// represents a separate instance of the rate-based rule and gets its own tracking -// and management by WAF. If you define a rate-based rule inside a rule group, and -// then use that rule group in multiple places, each use creates a separate -// instance of the rate-based rule that gets its own tracking and management by -// WAF. +// For any n-tuple of aggregation keys, each unique combination of values for the +// keys defines a separate aggregation instance, which WAF counts and rate-limits +// individually. +// +// You can optionally nest another statement inside the rate-based statement, to +// narrow the scope of the rule so that it only counts and rate limits requests +// that match the nested statement. You can use this nested scope-down statement in +// conjunction with your aggregation key specifications or you can just count and +// rate limit all requests that match the scope-down statement, without additional +// aggregation. When you choose to just manage all requests that match a scope-down +// statement, the aggregation instance is singular for the 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. +// +// For additional information about the options, see [Rate limiting web requests using rate-based rules] in the WAF Developer Guide. +// +// If you only aggregate on the individual IP address or forwarded IP address, you +// can retrieve the list of IP addresses that WAF is currently rate limiting for a +// rule through the API call GetRateBasedStatementManagedKeys . This option is not +// available for other aggregation configurations. +// +// WAF tracks and manages web requests separately for each instance of a +// rate-based rule that you use. For example, if you provide the same rate-based +// rule settings in two web ACLs, each of the two rule statements represents a +// separate instance of the rate-based rule and gets its own tracking and +// management by WAF. If you define a rate-based rule inside a rule group, and then +// use that rule group in multiple places, each use creates a separate instance of +// the rate-based rule that gets its own tracking and management by WAF. +// +// [Rate limiting web requests using rate-based rules]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html type RateBasedStatement struct { - // Setting that indicates how to aggregate the request counts. Web requests that - // are missing any of the components specified in the aggregation keys are omitted - // from the rate-based rule evaluation and handling. + // Setting that indicates how to aggregate the request counts. + // + // Web requests that are missing any of the components specified in the + // aggregation keys are omitted from the rate-based rule evaluation and handling. + // // - CONSTANT - Count and limit the requests that match the rate-based rule's // scope-down statement. With this option, the counted requests aren't further // aggregated. The scope-down statement is the only specification used. When the // count of all requests that satisfy the scope-down statement goes over the limit, // WAF applies the rule action to all requests that satisfy the scope-down - // statement. With this option, you must configure the ScopeDownStatement - // property. + // statement. + // + // With this option, you must configure the ScopeDownStatement property. + // // - CUSTOM_KEYS - Aggregate the request counts using one or more web request - // components as the aggregate keys. With this option, you must specify the - // aggregate keys in the CustomKeys property. To aggregate on only the IP address - // or only the forwarded IP address, don't use custom keys. Instead, set the - // aggregate key type to IP or FORWARDED_IP . + // components as the aggregate keys. + // + // With this option, you must specify the aggregate keys in the CustomKeys + // property. + // + // To aggregate on only the IP address or only the forwarded IP address, don't use + // custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP . + // // - FORWARDED_IP - Aggregate the request counts on the first IP address in an - // HTTP header. With this option, you must specify the header to use in the - // ForwardedIPConfig property. To aggregate on a combination of the forwarded IP - // address with other aggregate keys, use CUSTOM_KEYS . - // - IP - Aggregate the request counts on the IP address from the web request - // origin. To aggregate on a combination of the IP address with other aggregate + // HTTP header. + // + // With this option, you must specify the header to use in the ForwardedIPConfig + // property. + // + // To aggregate on a combination of the forwarded IP address with other aggregate // keys, use CUSTOM_KEYS . // + // - IP - Aggregate the request counts on the IP address from the web request + // origin. + // + // To aggregate on a combination of the IP address with other aggregate keys, use + // CUSTOM_KEYS . + // // This member is required. AggregateKeyType RateBasedStatementAggregateKeyType // The limit on requests per 5-minute period for a single aggregation instance for // the rate-based rule. If the rate-based statement includes a ScopeDownStatement , - // this limit is applied only to the requests that match the statement. Examples: + // this limit is applied only to the requests that match the statement. + // + // Examples: + // // - If you aggregate on just the IP address, this is the limit on requests from // any single IP address. + // // - If you aggregate on the HTTP method and the query argument name "city", // then this is the limit on requests for any single method, city pair. // @@ -2251,33 +2747,41 @@ type RateBasedStatement struct { // The amount of time, in seconds, that WAF should include in its request counts, // looking back from the current time. For example, for a setting of 120, when WAF // checks the rate, it counts the requests for the 2 minutes immediately preceding - // the current time. Valid settings are 60, 120, 300, and 600. This setting doesn't - // determine how often WAF checks the rate, but how far back it looks each time it - // checks. WAF checks the rate about every 10 seconds. Default: 300 (5 minutes) + // the current time. Valid settings are 60, 120, 300, and 600. + // + // This setting doesn't determine how often WAF checks the rate, but how far back + // it looks each time it checks. WAF checks the rate about every 10 seconds. + // + // Default: 300 (5 minutes) EvaluationWindowSec int64 // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // 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 you - // specify a forwarded IP in the rule's aggregate key settings. + // 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 you specify a forwarded IP in the rule's aggregate key + // settings. ForwardedIPConfig *ForwardedIPConfig // An optional nested statement that narrows the scope of the web requests that // are evaluated and managed by the rate-based statement. When you use a scope-down // statement, the rate-based rule only tracks and rate limits requests that 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. + // the scope-down statement. You can use any nestable Statementin the scope-down statement, + // and you can nest statements at any level, the same as you can for a rule + // statement. ScopeDownStatement *Statement noSmithyDocumentSerde } -// Specifies a single custom aggregate key for a rate-base rule. Web requests that -// are missing any of the components specified in the aggregation keys are omitted -// from the rate-based rule evaluation and handling. +// Specifies a single custom aggregate key for a rate-base rule. +// +// Web requests that are missing any of the components specified in the +// aggregation keys are omitted from the rate-based rule evaluation and handling. type RateBasedStatementCustomKey struct { // Use the value of a cookie in the request as an aggregate key. Each distinct @@ -2287,11 +2791,14 @@ type RateBasedStatementCustomKey struct { Cookie *RateLimitCookie // Use the first IP address in an HTTP header as an aggregate key. Each distinct - // forwarded IP address contributes to the aggregation instance. When you specify - // an IP or forwarded IP in the custom key settings, you must also specify at least - // one other key to use. You can aggregate on only the forwarded IP address by - // specifying FORWARDED_IP in your rate-based statement's AggregateKeyType . With - // this option, you must specify the header to use in the rate-based rule's + // forwarded IP address contributes to the aggregation instance. + // + // When you specify an IP or forwarded IP in the custom key settings, you must + // also specify at least one other key to use. You can aggregate on only the + // forwarded IP address by specifying FORWARDED_IP in your rate-based statement's + // AggregateKeyType . + // + // With this option, you must specify the header to use in the rate-based rule's // ForwardedIPConfig property. ForwardedIP *RateLimitForwardedIP @@ -2307,20 +2814,25 @@ type RateBasedStatementCustomKey struct { Header *RateLimitHeader // Use the request's originating IP address as an aggregate key. Each distinct IP - // address contributes to the aggregation instance. When you specify an IP or - // forwarded IP in the custom key settings, you must also specify at least one - // other key to use. You can aggregate on only the IP address by specifying IP in - // your rate-based statement's AggregateKeyType . + // address contributes to the aggregation instance. + // + // When you specify an IP or forwarded IP in the custom key settings, you must + // also specify at least one other key to use. You can aggregate on only the IP + // address by specifying IP in your rate-based statement's AggregateKeyType . IP *RateLimitIP // Use the specified label namespace as an aggregate key. Each distinct fully // qualified label name that has the specified label namespace contributes to the // aggregation instance. If you use just one label namespace as your custom key, - // then each label name fully defines an aggregation instance. This uses only - // labels that have been added to the request by rules that are evaluated before - // this rate-based rule in the web ACL. For information about label namespaces and - // names, see Label syntax and naming requirements (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) - // in the WAF Developer Guide. + // then each label name fully defines an aggregation instance. + // + // This uses only labels that have been added to the request by rules that are + // evaluated before this rate-based rule in the web ACL. + // + // For information about label namespaces and names, see [Label syntax and naming requirements] in the WAF Developer + // Guide. + // + // [Label syntax and naming requirements]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html LabelNamespace *RateLimitLabelNamespace // Use the specified query argument as an aggregate key. Each distinct value for @@ -2342,17 +2854,20 @@ type RateBasedStatementCustomKey struct { noSmithyDocumentSerde } -// The set of IP addresses that are currently blocked for a RateBasedStatement . -// This is only available for rate-based rules that aggregate on just the IP -// address, with the AggregateKeyType set to IP or FORWARDED_IP . A rate-based rule -// applies its rule action to requests from IP addresses that are in the rule's -// managed keys list and that match the rule's scope-down statement. When a rule -// has no scope-down statement, it applies the action to all requests from the IP -// addresses that are in the list. The rule applies its rule action to rate limit -// the matching requests. The action is usually Block but it can be any valid rule -// action except for Allow. The maximum number of IP addresses that can be rate -// limited by a single rate-based rule instance is 10,000. If more than 10,000 -// addresses exceed the rate limit, WAF limits those with the highest rates. +// The set of IP addresses that are currently blocked for a RateBasedStatement. This is only +// available for rate-based rules that aggregate on just the IP address, with the +// AggregateKeyType set to IP or FORWARDED_IP . +// +// A rate-based rule applies its rule action to requests from IP addresses that +// are in the rule's managed keys list and that match the rule's scope-down +// statement. When a rule has no scope-down statement, it applies the action to all +// requests from the IP addresses that are in the list. The rule applies its rule +// action to rate limit the matching requests. The action is usually Block but it +// can be any valid rule action except for Allow. +// +// The maximum number of IP addresses that can be rate limited by a single +// rate-based rule instance is 10,000. If more than 10,000 addresses exceed the +// rate limit, WAF limits those with the highest rates. type RateBasedStatementManagedKeysIPSet struct { // The IP addresses that are currently blocked. @@ -2392,17 +2907,23 @@ type RateLimitCookie struct { // Specifies the first IP address in an HTTP header as an aggregate key for a // rate-based rule. Each distinct forwarded IP address contributes to the -// aggregation instance. This setting is used only in the -// RateBasedStatementCustomKey specification of a rate-based rule statement. When -// you specify an IP or forwarded IP in the custom key settings, you must also -// specify at least one other key to use. You can aggregate on only the forwarded -// IP address by specifying FORWARDED_IP in your rate-based statement's -// AggregateKeyType . This data type supports using the forwarded IP address in the -// web request aggregation for a rate-based rule, in RateBasedStatementCustomKey . -// The JSON specification for using the forwarded IP address doesn't explicitly use -// this data type. JSON specification: "ForwardedIP": {} When you use this -// specification, you must also configure the forwarded IP address in the -// rate-based statement's ForwardedIPConfig . +// aggregation instance. +// +// This setting is used only in the RateBasedStatementCustomKey specification of a +// rate-based rule statement. When you specify an IP or forwarded IP in the custom +// key settings, you must also specify at least one other key to use. You can +// aggregate on only the forwarded IP address by specifying FORWARDED_IP in your +// rate-based statement's AggregateKeyType . +// +// This data type supports using the forwarded IP address in the web request +// aggregation for a rate-based rule, in RateBasedStatementCustomKey . The JSON +// specification for using the forwarded IP address doesn't explicitly use this +// data type. +// +// JSON specification: "ForwardedIP": {} +// +// When you use this specification, you must also configure the forwarded IP +// address in the rate-based statement's ForwardedIPConfig . type RateLimitForwardedIP struct { noSmithyDocumentSerde } @@ -2436,18 +2957,24 @@ type RateLimitHeader struct { // Specifies the request's HTTP method as an aggregate key for a rate-based rule. // Each distinct HTTP method contributes to the aggregation instance. If you use // just the HTTP method as your custom key, then each method fully defines an -// aggregation instance. JSON specification: "RateLimitHTTPMethod": {} +// aggregation instance. +// +// JSON specification: "RateLimitHTTPMethod": {} type RateLimitHTTPMethod struct { noSmithyDocumentSerde } // Specifies the IP address in the web request as an aggregate key for a // rate-based rule. Each distinct IP address contributes to the aggregation -// instance. This setting is used only in the RateBasedStatementCustomKey -// specification of a rate-based rule statement. To use this in the custom key -// settings, you must specify at least one other key to use, along with the IP -// address. To aggregate on only the IP address, in your rate-based statement's -// AggregateKeyType , specify IP . JSON specification: "RateLimitIP": {} +// instance. +// +// This setting is used only in the RateBasedStatementCustomKey specification of a +// rate-based rule statement. To use this in the custom key settings, you must +// specify at least one other key to use, along with the IP address. To aggregate +// on only the IP address, in your rate-based statement's AggregateKeyType , +// specify IP . +// +// JSON specification: "RateLimitIP": {} type RateLimitIP struct { noSmithyDocumentSerde } @@ -2456,10 +2983,14 @@ type RateLimitIP struct { // Each distinct fully qualified label name that has the specified label namespace // contributes to the aggregation instance. If you use just one label namespace as // your custom key, then each label name fully defines an aggregation instance. +// // This uses only labels that have been added to the request by rules that are -// evaluated before this rate-based rule in the web ACL. For information about -// label namespaces and names, see Label syntax and naming requirements (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) -// in the WAF Developer Guide. +// evaluated before this rate-based rule in the web ACL. +// +// For information about label namespaces and names, see [Label syntax and naming requirements] in the WAF Developer +// Guide. +// +// [Label syntax and naming requirements]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html type RateLimitLabelNamespace struct { // The namespace to use for aggregation. @@ -2538,7 +3069,7 @@ type RateLimitUriPath struct { 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. @@ -2576,9 +3107,10 @@ type RegexMatchStatement struct { noSmithyDocumentSerde } -// 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 . +// 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 Rulestatement RegexPatternSetReferenceStatement. type RegexPatternSet struct { // The Amazon Resource Name (ARN) of the entity. @@ -2601,18 +3133,18 @@ type RegexPatternSet struct { } // A rule statement used to search web request components for matches with regular -// expressions. To use this, create a RegexPatternSet that specifies the -// 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 -// 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. +// expressions. To use this, create a RegexPatternSetthat specifies the 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 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. type RegexPatternSetReferenceStatement struct { - // The Amazon Resource Name (ARN) of the RegexPatternSet that this statement - // references. + // The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references. // // This member is required. ARN *string @@ -2637,10 +3169,10 @@ type RegexPatternSetReferenceStatement struct { noSmithyDocumentSerde } -// 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 . +// 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. type RegexPatternSetSummary struct { // The Amazon Resource Name (ARN) of the entity. @@ -2684,18 +3216,27 @@ type ReleaseSummary struct { // Customizes the maximum size of the request body that your protected CloudFront, // API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward // to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change -// the setting for any of the available resource types. You are charged additional -// fees when your protected resources forward body sizes that are larger than the -// default. For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) -// . Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" } For -// Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes). +// the setting for any of the available resource types. +// +// You are charged additional fees when your protected resources forward body +// sizes that are larger than the default. For more information, see [WAF Pricing]. +// +// Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" } +// +// For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 +// bytes). +// // This is used in the AssociationConfig of the web ACL. +// +// [WAF Pricing]: http://aws.amazon.com/waf/pricing/ type RequestBodyAssociatedResourceTypeConfig struct { // Specifies the maximum size of the web request body component that an associated // CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource // should send to WAF for inspection. This applies to statements in the web ACL - // that inspect the body or JSON body. Default: 16 KB (16,384 bytes) + // that inspect the body or JSON body. + // + // Default: 16 KB (16,384 bytes) // // This member is required. DefaultSizeInspectionLimit SizeInspectionLimit @@ -2704,23 +3245,34 @@ type RequestBodyAssociatedResourceTypeConfig 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. +// 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. type RequestInspection struct { // The name of the field in the request payload that contains your customer's - // password. How you specify this depends on the request inspection payload type. + // password. + // + // How you specify this depends on the request inspection 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 { "form": { "password": "THE_PASSWORD" } } - // , the password field specification is /form/password . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named password1 , the password field - // specification is password1 . + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } } , + // the password field specification is /form/password . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named password1 , the + // password field specification is password1 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 // // This member is required. PasswordField *PasswordField @@ -2731,15 +3283,23 @@ type RequestInspection struct { PayloadType PayloadType // The name of the field in the request payload that contains your customer's - // username. How you specify this depends on the request inspection payload type. + // username. + // + // How you specify this depends on the request inspection 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 { "form": { "username": "THE_USERNAME" } } - // , the username field specification is /form/username . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named username1 , the username field - // specification is username1 + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "username": "THE_USERNAME" } } , + // the username field specification is /form/username . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named username1 , the + // username field specification is username1 + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 // // This member is required. UsernameField *UsernameField @@ -2748,12 +3308,15 @@ type RequestInspection struct { } // The criteria for inspecting account creation requests, used by the ACFP rule -// group to validate and track account creation attempts. This is part of the -// AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig . In these -// settings, you specify how your application accepts account creation attempts by -// providing the request payload type and the names of the fields within the -// request body where the username, password, email, and primary address and phone -// number fields are provided. +// group to validate and track account creation attempts. +// +// This is part of the AWSManagedRulesACFPRuleSet configuration in +// ManagedRuleGroupConfig . +// +// In these settings, you specify how your application accepts account creation +// attempts by providing the request payload type and the names of the fields +// within the request body where the username, password, email, and primary address +// and phone number fields are provided. type RequestInspectionACFP struct { // The payload type for your account creation endpoint, either JSON or form @@ -2763,74 +3326,118 @@ type RequestInspectionACFP struct { PayloadType PayloadType // The names of the fields in the request payload that contain your customer's - // primary physical address. Order the address fields in the array exactly as they - // are ordered in the request payload. How you specify the address fields depends - // on the request inspection payload type. + // primary physical address. + // + // Order the address fields in the array exactly as they are ordered in the + // request payload. + // + // How you specify the address fields depends on the request inspection payload + // type. + // // - For JSON payloads, specify the field identifiers 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 { "form": { "primaryaddressline1": + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "primaryaddressline1": // "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": // "THE_ADDRESS3" } } , the address field idenfiers are /form/primaryaddressline1 // , /form/primaryaddressline2 , and /form/primaryaddressline3 . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with input elements named primaryaddressline1 , + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with input elements named primaryaddressline1 , // primaryaddressline2 , and primaryaddressline3 , the address fields identifiers // are primaryaddressline1 , primaryaddressline2 , and primaryaddressline3 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 AddressFields []AddressField // The name of the field in the request payload that contains your customer's - // email. How you specify this depends on the request inspection payload type. + // email. + // + // How you specify this depends on the request inspection 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 { "form": { "email": "THE_EMAIL" } } , the + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "email": "THE_EMAIL" } } , the // email field specification is /form/email . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named email1 , the email field - // specification is email1 . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named email1 , the email + // field specification is email1 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 EmailField *EmailField // The name of the field in the request payload that contains your customer's - // password. How you specify this depends on the request inspection payload type. + // password. + // + // How you specify this depends on the request inspection 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 { "form": { "password": "THE_PASSWORD" } } - // , the password field specification is /form/password . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named password1 , the password field - // specification is password1 . + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } } , + // the password field specification is /form/password . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named password1 , the + // password field specification is password1 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 PasswordField *PasswordField // The names of the fields in the request payload that contain your customer's - // primary phone number. Order the phone number fields in the array exactly as they - // are ordered in the request payload. How you specify the phone number fields - // depends on the request inspection payload type. + // primary phone number. + // + // Order the phone number fields in the array exactly as they are ordered in the + // request payload. + // + // How you specify the phone number fields depends on the request inspection + // payload type. + // // - For JSON payloads, specify the field identifiers 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 { "form": { "primaryphoneline1": + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "primaryphoneline1": // "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": // "THE_PHONE3" } } , the phone number field identifiers are // /form/primaryphoneline1 , /form/primaryphoneline2 , and // /form/primaryphoneline3 . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with input elements named primaryphoneline1 , primaryphoneline2 , - // and primaryphoneline3 , the phone number field identifiers are - // primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with input elements named primaryphoneline1 , + // primaryphoneline2 , and primaryphoneline3 , the phone number field identifiers + // are primaryphoneline1 , primaryphoneline2 , and primaryphoneline3 . + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 PhoneNumberFields []PhoneNumberField // The name of the field in the request payload that contains your customer's - // username. How you specify this depends on the request inspection payload type. + // username. + // + // How you specify this depends on the request inspection 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 { "form": { "username": "THE_USERNAME" } } - // , the username field specification is /form/username . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named username1 , the username field - // specification is username1 + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "username": "THE_USERNAME" } } , + // the username field specification is /form/username . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named username1 , the + // username field specification is username1 + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 UsernameField *UsernameField noSmithyDocumentSerde @@ -2838,25 +3445,32 @@ type RequestInspectionACFP struct { // The criteria for inspecting responses to login requests and account creation // requests, used by the ATP and ACFP rule groups to track login and account -// creation success and failure rates. Response inspection is available only in web -// ACLs that protect Amazon CloudFront distributions. The rule groups evaluates the -// responses that your protected resources send back to client login and account -// creation attempts, keeping count of successful and failed attempts from each IP -// address and client session. Using this information, the rule group labels and -// mitigates requests from client sessions and IP addresses with too much -// suspicious activity in a short amount of time. This is part of the -// AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in -// ManagedRuleGroupConfig . Enable response inspection by configuring exactly one -// component of the response to inspect, for example, Header or StatusCode . You -// can't configure more than one component for inspection. If you don't configure -// any of the response inspection options, response inspection is disabled. +// creation success and failure rates. +// +// Response inspection is available only in web ACLs that protect Amazon +// CloudFront distributions. +// +// The rule groups evaluates the responses that your protected resources send back +// to client login and account creation attempts, keeping count of successful and +// failed attempts from each IP address and client session. Using this information, +// the rule group labels and mitigates requests from client sessions and IP +// addresses with too much suspicious activity in a short amount of time. +// +// This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet +// configurations in ManagedRuleGroupConfig . +// +// Enable response inspection by configuring exactly one component of the response +// to inspect, for example, Header or StatusCode . You can't configure more than +// one component for inspection. If you don't configure any of the response +// inspection options, response inspection is disabled. type ResponseInspection struct { // Configures inspection of the response body for success and failure indicators. // WAF can inspect the first 65,536 bytes (64 KB) of the response body. BodyContains *ResponseInspectionBodyContains - // Configures inspection of the response header for success and failure indicators. + // Configures inspection of the response header for success and failure + // indicators. Header *ResponseInspectionHeader // Configures inspection of the response JSON for success and failure indicators. @@ -2873,15 +3487,17 @@ 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 and AWSManagedRulesACFPRuleSet . -// Response inspection is available only in web ACLs that protect Amazon CloudFront -// distributions. +// +// Response inspection is available only in web ACLs that protect Amazon +// CloudFront distributions. type ResponseInspectionBodyContains struct { // Strings in the body of the response that indicate a failed login or account // creation attempt. To be counted as a failure, 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: "FailureStrings": [ - // "Request failed" ] + // among the success and failure strings. + // + // JSON example: "FailureStrings": [ "Request failed" ] // // This member is required. FailureStrings []string @@ -2889,9 +3505,10 @@ type ResponseInspectionBodyContains struct { // Strings in the body of the response that indicate a successful login or account // creation attempt. To be counted as a success, 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 examples: "SuccessStrings": [ - // "Login successful" ] and "SuccessStrings": [ "Account creation successful", - // "Welcome to our site!" ] + // among the success and failure strings. + // + // JSON examples: "SuccessStrings": [ "Login successful" ] and "SuccessStrings": [ + // "Account creation successful", "Welcome to our site!" ] // // This member is required. SuccessStrings []string @@ -2901,21 +3518,27 @@ type ResponseInspectionBodyContains struct { // Configures inspection of the response header. This is part of the // ResponseInspection configuration for AWSManagedRulesATPRuleSet and -// AWSManagedRulesACFPRuleSet . Response inspection is available only in web ACLs -// that protect Amazon CloudFront distributions. +// AWSManagedRulesACFPRuleSet . +// +// Response inspection is available only in web ACLs that protect Amazon +// CloudFront distributions. type ResponseInspectionHeader struct { // Values in the response header with the specified name that indicate a failed // login or account creation attempt. To be counted as a failure, the value must be // an exact match, including case. Each value must be unique among the success and - // failure values. JSON examples: "FailureValues": [ "LoginFailed", "Failed login" - // ] and "FailureValues": [ "AccountCreationFailed" ] + // failure values. + // + // JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and + // "FailureValues": [ "AccountCreationFailed" ] // // This member is required. FailureValues []string // The name of the header to match against. The name must be an exact match, - // including case. JSON example: "Name": [ "RequestResult" ] + // including case. + // + // JSON example: "Name": [ "RequestResult" ] // // This member is required. Name *string @@ -2923,9 +3546,10 @@ type ResponseInspectionHeader struct { // Values in the response header with the specified name that indicate a // successful login or account creation attempt. To be counted as a success, the // value must be an exact match, including case. Each value must be unique among - // the success and failure values. JSON examples: "SuccessValues": [ - // "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", - // "Successful account creation" ] + // the success and failure values. + // + // JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and + // "SuccessValues": [ "AccountCreated", "Successful account creation" ] // // This member is required. SuccessValues []string @@ -2936,21 +3560,26 @@ 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 and AWSManagedRulesACFPRuleSet . -// Response inspection is available only in web ACLs that protect Amazon CloudFront -// distributions. +// +// Response inspection is available only in web ACLs that protect Amazon +// CloudFront distributions. type ResponseInspectionJson struct { // Values for the specified identifier in the response JSON that indicate a failed // login or account creation attempt. To be counted as a failure, the value must be // an exact match, including case. Each value must be unique among the success and - // failure values. JSON example: "FailureValues": [ "False", "Failed" ] + // failure values. + // + // JSON example: "FailureValues": [ "False", "Failed" ] // // This member is required. FailureValues []string // The identifier for the value to match against in the JSON. The identifier must - // be an exact match, including case. JSON examples: "Identifier": [ - // "/login/success" ] and "Identifier": [ "/sign-up/success" ] + // be an exact match, including case. + // + // JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ + // "/sign-up/success" ] // // This member is required. Identifier *string @@ -2958,8 +3587,9 @@ type ResponseInspectionJson struct { // Values for the specified identifier in the response JSON that indicate a // successful login or account creation attempt. To be counted as a success, the // value must be an exact match, including case. Each value must be unique among - // the success and failure values. JSON example: "SuccessValues": [ "True", - // "Succeeded" ] + // the success and failure values. + // + // JSON example: "SuccessValues": [ "True", "Succeeded" ] // // This member is required. SuccessValues []string @@ -2969,14 +3599,17 @@ type ResponseInspectionJson struct { // Configures inspection of the response status code. This is part of the // ResponseInspection configuration for AWSManagedRulesATPRuleSet and -// AWSManagedRulesACFPRuleSet . Response inspection is available only in web ACLs -// that protect Amazon CloudFront distributions. +// AWSManagedRulesACFPRuleSet . +// +// 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 or account creation // attempt. To be counted as a failure, 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 ] + // these. Each code must be unique among the success and failure status codes. + // + // JSON example: "FailureCodes": [ 400, 404 ] // // This member is required. FailureCodes []int32 @@ -2984,7 +3617,9 @@ type ResponseInspectionStatusCode struct { // Status codes in the response that indicate a successful login or account // creation attempt. To be counted as a success, the response status code must // match one of these. Each code must be unique among the success and failure - // status codes. JSON example: "SuccessCodes": [ 200, 201 ] + // status codes. + // + // JSON example: "SuccessCodes": [ 200, 201 ] // // This member is required. SuccessCodes []int32 @@ -2992,16 +3627,17 @@ type ResponseInspectionStatusCode struct { noSmithyDocumentSerde } -// A single rule, which you can use in a WebACL or RuleGroup to identify web -// requests that you want to manage in some way. Each rule includes one top-level -// Statement that WAF uses to identify matching web requests, and parameters that -// govern how WAF handles them. +// A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you +// want to manage in some way. Each rule includes one top-level Statementthat WAF uses to +// identify matching web requests, and parameters that govern how WAF handles them. type Rule struct { - // The name of the rule. If you change the name of a Rule after you create it and - // you want the rule's metric name to reflect the change, update the metric name in - // the rule's VisibilityConfig settings. WAF doesn't automatically update the - // metric name when you update the rule name. + // The name of the rule. + // + // If you change the name of a Rule after you create it and you want the rule's + // metric name to reflect the change, update the metric name in the rule's + // VisibilityConfig settings. WAF doesn't automatically update the metric name when + // you update the rule name. // // This member is required. Name *string @@ -3014,28 +3650,34 @@ type Rule struct { // This member is required. Priority int32 - // The WAF processing statement for the rule, for example ByteMatchStatement or - // SizeConstraintStatement . + // The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. // // This member is required. Statement *Statement // Defines and enables Amazon CloudWatch metrics and web request sample - // collection. If you change the name of a Rule after you create it and you want - // the rule's metric name to reflect the change, update the metric name as well. - // WAF doesn't automatically update the metric name. + // collection. + // + // If you change the name of a Rule after you create it and you want the rule's + // metric name to reflect the change, update the metric name as well. WAF doesn't + // automatically update the metric name. // // This member is required. VisibilityConfig *VisibilityConfig // The action that WAF should take on a web request when it matches the rule // 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 - // rule OverrideAction setting, but not both: + // + // 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 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. Action *RuleAction @@ -3050,27 +3692,37 @@ type Rule struct { // The action to use in the place of the action that results from the rule group // 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 - // 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. + // 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 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: + // 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 @@ -3102,11 +3754,12 @@ 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. +// 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. type RuleActionOverride struct { // The override action to use, in place of the configured action of the rule in @@ -3123,11 +3776,12 @@ type RuleActionOverride struct { noSmithyDocumentSerde } -// 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. +// 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. type RuleGroup struct { // The Amazon Resource Name (ARN) of the entity. @@ -3135,18 +3789,21 @@ type RuleGroup struct { // This member is required. ARN *string - // 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 - // 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. For more information, see WAF web ACL - // capacity units (WCU) (https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) - // in the WAF Developer Guide. + // 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 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. For more information, + // see [WAF web ACL capacity units (WCU)]in the WAF Developer Guide. + // + // [WAF web ACL capacity units (WCU)]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html // // This member is required. Capacity *int64 @@ -3163,28 +3820,34 @@ type RuleGroup struct { // This member is required. Name *string - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. 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 // match statements. These labels are defined in a LabelMatchStatement - // specification, in the Statement definition of a rule. + // specification, in the Statementdefinition of a rule. ConsumedLabels []LabelSummary // 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 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. 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. + // rule group. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponseBodies map[string]CustomResponseBody // A description of the rule group that helps with identification. @@ -3192,28 +3855,36 @@ 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:: + // 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: : + // from the rule, separated by a colon: + // + // : LabelNamespace *string - // The Rule statements used to identify the web requests that you want to manage. - // Each rule includes one top-level statement that WAF uses to identify matching - // web requests, and parameters that govern how WAF handles them. + // The Rule statements used to identify the web requests that you want to manage. Each + // rule includes one top-level statement that WAF uses to identify matching web + // requests, and parameters that govern how WAF handles them. Rules []Rule noSmithyDocumentSerde } -// 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 cannot use a rule -// group reference statement inside another rule group. You can only reference a -// rule group as a top-level statement within a rule that you define in a web ACL. +// 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 cannot use a rule group reference statement +// inside another rule group. You can only reference a rule group as a top-level +// statement within a rule that you define in a web ACL. type RuleGroupReferenceStatement struct { // The Amazon Resource Name (ARN) of the entity. @@ -3221,27 +3892,28 @@ 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 // 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. + // 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. RuleActionOverrides []RuleActionOverride 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. @@ -3270,10 +3942,9 @@ 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 RuleGroupReferenceStatementto 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 @@ -3286,9 +3957,9 @@ type RuleSummary struct { noSmithyDocumentSerde } -// Represents a single sampled web request. The response from GetSampledRequests -// includes a SampledHTTPRequests complex type that appears as SampledRequests in -// the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest +// Represents a single sampled web request. The response from GetSampledRequests includes a +// SampledHTTPRequests complex type that appears as SampledRequests in the +// response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest // objects. type SampledHTTPRequest struct { @@ -3317,7 +3988,9 @@ type SampledHTTPRequest struct { // 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, + // 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 . Labels []Label @@ -3348,10 +4021,14 @@ 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. @@ -3363,8 +4040,11 @@ 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. +// 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" } type SingleQueryArgument struct { @@ -3379,15 +4059,19 @@ type SingleQueryArgument struct { // A rule statement that compares a number of bytes against the size of a request // component, using a comparison operator, such as greater than (>) or less than // (<). For example, you can use a size constraint statement to look for query -// strings that are longer than 100 bytes. If you configure WAF to inspect the -// request body, WAF inspects only the number of bytes in the body up to the limit -// for the web ACL and protected resource type. If you know that the request body -// for your web requests should never exceed the inspection limit, you can use a -// size constraint statement to block requests that have a larger request body -// size. For more information about the inspection limits, see Body and JsonBody -// settings for the FieldToMatch data type. If you choose URI for the value of -// Part of the request to filter on, the slash (/) in the URI counts as one -// character. For example, the URI /logo.jpg is nine characters long. +// strings that are longer than 100 bytes. +// +// If you configure WAF to inspect the request body, WAF inspects only the number +// of bytes in the body up to the limit for the web ACL and protected resource +// type. If you know that the request body for your web requests should never +// exceed the inspection limit, you can use a size constraint statement to block +// requests that have a larger request body size. For more information about the +// inspection limits, see Body and JsonBody settings for the FieldToMatch data +// type. +// +// If you choose URI for the value of Part of the request to filter on, the slash +// (/) in the URI counts as one character. For example, the URI /logo.jpg is nine +// characters long. type SizeConstraintStatement struct { // The operator to use to compare the request part to the size setting. @@ -3443,24 +4127,31 @@ type SqliMatchStatement struct { TextTransformations []TextTransformation // 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 - // already have other protections against SQL injection attacks or that have a low - // tolerance for false positives. Default: LOW + // identifying and mitigating false positives, see [Testing and tuning]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 + // + // [Testing and tuning]: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html SensitivityLevel SensitivityLevel noSmithyDocumentSerde } -// 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 . +// 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. 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 Statementwithin the AndStatement . AndStatement *AndStatement // A rule statement that defines a string match search for WAF to apply to web @@ -3474,131 +4165,173 @@ type Statement struct { // 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) - // . + // 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] in the [WAF Developer Guide]. + // + // [Geographic match rule statement]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html + // [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 or address ranges. To use this, create an IPSetthat 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. + // 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 - // 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 - // label name. The prefix identifies the rule group or web ACL context of the rule - // that added the label. If you do not provide the fully qualified name in your - // label match string, WAF performs the search for labels that were added in the - // same context as the label match statement. + // 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 label name. The prefix identifies the rule group or web + // ACL context of the rule that added the label. If you do not provide the fully + // qualified name in your label match string, WAF performs the search for labels + // that were added in the 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 . You cannot use a - // managed rule group inside another rule group. You can only reference a managed - // rule group as a top-level statement within a rule that you define in a web ACL. + // 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 . You cannot use a managed rule group inside another + // rule group. You can only reference a managed rule group as a top-level statement + // within a rule that you define in a web ACL. + // // You are charged additional fees when you use the WAF Bot Control managed rule // group AWSManagedRulesBotControlRuleSet , the WAF Fraud Control account takeover // prevention (ATP) managed rule group AWSManagedRulesATPRuleSet , or the WAF Fraud // Control account creation fraud prevention (ACFP) managed rule group - // AWSManagedRulesACFPRuleSet . For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) - // . + // AWSManagedRulesACFPRuleSet . For more information, see [WAF Pricing]. + // + // [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 Statementwithin 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 Statementwithin the OrStatement . OrStatement *OrStatement // A rate-based rule counts incoming requests and rate limits requests when they // are coming at too fast a rate. The rule categorizes requests according to your // aggregation criteria, collects them into aggregation instances, and counts and - // rate limits the requests for each instance. If you change any of these settings - // in a rule that's currently in use, the change resets the rule's rate limiting - // counts. This can pause the rule's rate limiting activities for up to a minute. - // You can specify individual aggregation keys, like IP address or HTTP method. You - // can also specify aggregation key combinations, like IP address and HTTP method, - // or HTTP method, query argument, and cookie. Each unique set of values for the - // aggregation keys that you specify is a separate aggregation instance, with the - // value from each key contributing to the aggregation instance definition. For - // example, assume the rule evaluates web requests with the following IP address - // and HTTP method values: + // rate limits the requests for each instance. + // + // If you change any of these settings in a rule that's currently in use, the + // change resets the rule's rate limiting counts. This can pause the rule's rate + // limiting activities for up to a minute. + // + // You can specify individual aggregation keys, like IP address or HTTP method. + // You can also specify aggregation key combinations, like IP address and HTTP + // method, or HTTP method, query argument, and cookie. + // + // Each unique set of values for the aggregation keys that you specify is a + // separate aggregation instance, with the value from each key contributing to the + // aggregation instance definition. + // + // For example, assume the rule evaluates web requests with the following IP + // address and HTTP method values: + // // - IP address 10.1.1.1, HTTP method POST + // // - IP address 10.1.1.1, HTTP method GET + // // - IP address 127.0.0.0, HTTP method POST + // // - IP address 10.1.1.1, HTTP method GET + // // The rule would create different aggregation instances according to your // aggregation criteria, for example: + // // - If the aggregation criteria is just the IP address, then each individual // address is an aggregation instance, and WAF counts requests separately for each. // The aggregation instances and request counts for our example would be the // following: + // // - IP address 10.1.1.1: count 3 + // // - IP address 127.0.0.0: count 1 + // // - If the aggregation criteria is HTTP method, then each individual HTTP // method is an aggregation instance. The aggregation instances and request counts // for our example would be the following: + // // - HTTP method POST: count 2 + // // - HTTP method GET: count 2 + // // - If the aggregation criteria is IP address and HTTP method, then each IP // address and each HTTP method would contribute to the combined aggregation // instance. The aggregation instances and request counts for our example would be // the following: + // // - IP address 10.1.1.1, HTTP method POST: count 1 + // // - IP address 10.1.1.1, HTTP method GET: count 2 + // // - IP address 127.0.0.0, HTTP method POST: count 1 + // // For any n-tuple of aggregation keys, each unique combination of values for the // keys defines a separate aggregation instance, which WAF counts and rate-limits - // individually. You can optionally nest another statement inside the rate-based - // statement, to narrow the scope of the rule so that it only counts and rate - // limits requests that match the nested statement. You can use this nested - // scope-down statement in conjunction with your aggregation key specifications or - // you can just count and rate limit all requests that match the scope-down - // statement, without additional aggregation. When you choose to just manage all - // requests that match a scope-down statement, the aggregation instance is singular - // for the 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. For additional - // information about the options, see Rate limiting web requests using rate-based - // rules (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html) - // in the WAF Developer Guide. If you only aggregate on the individual IP address - // or forwarded IP address, you can retrieve the list of IP addresses that WAF is - // currently rate limiting for a rule through the API call - // GetRateBasedStatementManagedKeys . This option is not available for other - // aggregation configurations. WAF tracks and manages web requests separately for - // each instance of a rate-based rule that you use. For example, if you provide the - // same rate-based rule settings in two web ACLs, each of the two rule statements - // represents a separate instance of the rate-based rule and gets its own tracking - // and management by WAF. If you define a rate-based rule inside a rule group, and - // then use that rule group in multiple places, each use creates a separate - // instance of the rate-based rule that gets its own tracking and management by - // WAF. + // individually. + // + // You can optionally nest another statement inside the rate-based statement, to + // narrow the scope of the rule so that it only counts and rate limits requests + // that match the nested statement. You can use this nested scope-down statement in + // conjunction with your aggregation key specifications or you can just count and + // rate limit all requests that match the scope-down statement, without additional + // aggregation. When you choose to just manage all requests that match a scope-down + // statement, the aggregation instance is singular for the 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. + // + // For additional information about the options, see [Rate limiting web requests using rate-based rules] in the WAF Developer Guide. + // + // If you only aggregate on the individual IP address or forwarded IP address, you + // can retrieve the list of IP addresses that WAF is currently rate limiting for a + // rule through the API call GetRateBasedStatementManagedKeys . This option is not + // available for other aggregation configurations. + // + // WAF tracks and manages web requests separately for each instance of a + // rate-based rule that you use. For example, if you provide the same rate-based + // rule settings in two web ACLs, each of the two rule statements represents a + // separate instance of the rate-based rule and gets its own tracking and + // management by WAF. If you define a rate-based rule inside a rule group, and then + // use that rule group in multiple places, each use creates a separate instance of + // the rate-based rule that gets its own tracking and management by WAF. + // + // [Rate limiting web requests using rate-based rules]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html RateBasedStatement *RateBasedStatement // A rule statement used to search web request components for a match against a @@ -3606,36 +4339,43 @@ type Statement struct { RegexMatchStatement *RegexMatchStatement // A rule statement used to search web request components for matches with regular - // expressions. To use this, create a RegexPatternSet that specifies the - // 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 - // 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. + // expressions. To use this, create a RegexPatternSetthat specifies the 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 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 - // 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 cannot use a rule - // group reference statement inside another rule group. You can only reference a - // rule group as a top-level statement within a rule that you define in a web ACL. + // 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 cannot use a rule group reference statement + // inside another rule group. You can only reference a rule group as a top-level + // statement within a rule that you define in a web ACL. RuleGroupReferenceStatement *RuleGroupReferenceStatement // A rule statement that compares a number of bytes against the size of a request // component, using a comparison operator, such as greater than (>) or less than // (<). For example, you can use a size constraint statement to look for query - // strings that are longer than 100 bytes. If you configure WAF to inspect the - // request body, WAF inspects only the number of bytes in the body up to the limit - // for the web ACL and protected resource type. If you know that the request body - // for your web requests should never exceed the inspection limit, you can use a - // size constraint statement to block requests that have a larger request body - // size. For more information about the inspection limits, see Body and JsonBody - // settings for the FieldToMatch data type. If you choose URI for the value of - // Part of the request to filter on, the slash (/) in the URI counts as one - // character. For example, the URI /logo.jpg is nine characters long. + // strings that are longer than 100 bytes. + // + // If you configure WAF to inspect the request body, WAF inspects only the number + // of bytes in the body up to the limit for the web ACL and protected resource + // type. If you know that the request body for your web requests should never + // exceed the inspection limit, you can use a size constraint statement to block + // requests that have a larger request body size. For more information about the + // inspection limits, see Body and JsonBody settings for the FieldToMatch data + // type. + // + // If you choose URI for the value of Part of the request to filter on, the slash + // (/) in the URI counts as one character. For example, the URI /logo.jpg is nine + // characters long. SizeConstraintStatement *SizeConstraintStatement // A rule statement that inspects for malicious SQL code. Attackers insert @@ -3658,9 +4398,11 @@ type Statement struct { // category, such as "test," "development," or "production". Or 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 WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't -// manage or view tags through the WAF console. +// a resource. +// +// You can tag the Amazon Web Services resources that you manage through WAF: web +// ACLs, rule groups, IP sets, and regex pattern sets. You can't 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 @@ -3687,9 +4429,11 @@ type Tag struct { // within that category, such as "test," "development," or "production". Or 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 WAF: web ACLs, rule groups, IP sets, and regex pattern sets. -// You can't manage or view tags through the WAF console. +// to 50 tags for a resource. +// +// You can tag the Amazon Web Services resources that you manage through WAF: web +// ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view +// tags through the WAF console. type TagInfoForResource struct { // The Amazon Resource Name (ARN) of the resource. @@ -3713,9 +4457,10 @@ type TextTransformation struct { // This member is required. Priority int32 - // For detailed descriptions of each of the transformation types, see Text - // transformations (https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-transformation.html) - // in the WAF Developer Guide. + // For detailed descriptions of each of the transformation types, see [Text transformations] in the WAF + // Developer Guide. + // + // [Text transformations]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-transformation.html // // This member is required. Type TextTransformationType @@ -3723,17 +4468,19 @@ type TextTransformation struct { noSmithyDocumentSerde } -// 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 -// 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 -// 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 +// 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 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 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. type TimeWindow struct { @@ -3760,27 +4507,38 @@ 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 . -// This is used in the FieldToMatch specification for some web request component -// types. JSON specification: "UriPath": {} +// +// This is used in the FieldToMatch specification for some web request component types. +// +// JSON specification: "UriPath": {} type UriPath struct { noSmithyDocumentSerde } // The name of the field in the request payload that contains your customer's -// username. This data type is used in the RequestInspection and -// RequestInspectionACFP data types. +// username. +// +// This data type is used in the RequestInspection and RequestInspectionACFP data +// types. type UsernameField struct { - // The name of the username field. How you specify this depends on the request - // inspection payload type. + // The name of the username field. + // + // How you specify this depends on the request inspection 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 { "form": { "username": "THE_USERNAME" } } - // , the username field specification is /form/username . - // - For form encoded payload types, use the HTML form names. For example, for - // an HTML form with the input element named username1 , the username field - // specification is username1 + // Force (IETF) documentation [JavaScript Object Notation (JSON) Pointer]. + // + // For example, for the JSON payload { "form": { "username": "THE_USERNAME" } } , + // the username field specification is /form/username . + // + // - For form encoded payload types, use the HTML form names. + // + // For example, for an HTML form with the input element named username1 , the + // username field specification is username1 + // + // [JavaScript Object Notation (JSON) Pointer]: https://tools.ietf.org/html/rfc6901 // // This member is required. Identifier *string @@ -3789,12 +4547,15 @@ type UsernameField struct { } // A version of the named managed rule group, that the rule group's vendor -// publishes for use by customers. 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 . +// publishes for use by customers. +// +// 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 VersionToPublish struct { // The Amazon Resource Name (ARN) of the vendor's rule group that's used in the @@ -3808,16 +4569,20 @@ type VersionToPublish struct { noSmithyDocumentSerde } -// Defines and enables Amazon CloudWatch metrics and web request sample collection. +// Defines and enables Amazon CloudWatch metrics and web request sample +// collection. type VisibilityConfig struct { // Indicates 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) - // in the WAF Developer Guide. For web ACLs, the metrics are for web requests that - // have the web ACL default action applied. WAF applies the default action to web - // requests that pass the inspection of all rules in the web ACL without being - // either allowed or blocked. For more information, see The web ACL default action (https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html) - // in the WAF Developer Guide. + // For the list of available metrics, see [WAF Metrics]in the WAF Developer Guide. + // + // For web ACLs, the metrics are for web requests that have the web ACL default + // action applied. WAF applies the default action to web requests that pass the + // inspection of all rules in the web ACL without being either allowed or blocked. + // For more information, see [The web ACL default action]in the WAF Developer Guide. + // + // [WAF Metrics]: https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics + // [The web ACL default action]: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html // // This member is required. CloudWatchMetricsEnabled bool @@ -3839,17 +4604,17 @@ type VisibilityConfig struct { noSmithyDocumentSerde } -// A web ACL defines a collection of rules to use to inspect and control web +// A web ACL defines a collection of rules to use to inspect and control web +// // requests. Each rule has a statement that defines what to look for in web // requests and an action that WAF applies to requests that match the statement. 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, an Amazon -// Cognito user pool, an App Runner service, or an Amazon Web Services Verified -// Access instance. +// 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, an Amazon Cognito user pool, +// an App Runner service, or an Amazon Web Services Verified Access instance. type WebACL struct { // The Amazon Resource Name (ARN) of the web ACL that you want to associate with @@ -3876,31 +4641,40 @@ type WebACL struct { // This member is required. Name *string - // Defines and enables Amazon CloudWatch metrics and web request sample collection. + // Defines and enables Amazon CloudWatch metrics and web request sample + // collection. // // This member is required. VisibilityConfig *VisibilityConfig // Specifies custom configurations for the associations between the web ACL and - // protected resources. Use this to customize the maximum size of the request body - // that your protected resources forward to WAF for inspection. You can customize - // this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or - // Verified Access resources. The default setting is 16 KB (16,384 bytes). You are - // charged additional fees when your protected resources forward body sizes that - // are larger than the default. For more information, see WAF Pricing (http://aws.amazon.com/waf/pricing/) - // . For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 + // protected resources. + // + // Use this to customize the maximum size of the request body that your protected + // resources forward to WAF for inspection. You can customize this setting for + // CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access + // resources. The default setting is 16 KB (16,384 bytes). + // + // You are charged additional fees when your protected resources forward body + // sizes that are larger than the default. For more information, see [WAF Pricing]. + // + // For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 // bytes). + // + // [WAF Pricing]: http://aws.amazon.com/waf/pricing/ AssociationConfig *AssociationConfig - // 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 + // 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. For more information, - // see WAF web ACL capacity units (WCU) (https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) - // in the WAF Developer Guide. + // see [WAF web ACL capacity units (WCU)]in the WAF Developer Guide. + // + // [WAF web ACL capacity units (WCU)]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html Capacity int64 // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have @@ -3916,11 +4690,16 @@ type WebACL struct { // 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. 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. + // you define in the web ACL. + // + // For information about customizing web requests and responses, see [Customizing web requests and responses in WAF] in the WAF + // Developer Guide. + // + // For information about the limits on count and size for custom request and + // response settings, see [WAF quotas]in the WAF Developer Guide. + // + // [WAF quotas]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html + // [Customizing web requests and responses in WAF]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html CustomResponseBodies map[string]CustomResponseBody // A description of the web ACL that helps with identification. @@ -3928,12 +4707,17 @@ 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:: + // + // 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: : + // from the rule, separated by a colon: + // + // : LabelNamespace *string // Indicates whether this web ACL is managed by Firewall Manager. If true, then @@ -3944,24 +4728,28 @@ type WebACL struct { // The last set of rules for WAF to process in the web ACL. This is defined in an // Firewall Manager WAF policy and contains only rule group references. You can't // alter these. Any rules and rule groups that you define for the web ACL are - // prioritized before these. In the Firewall Manager WAF policy, the Firewall - // Manager administrator can define a set of rule groups to run first in the web - // ACL and a set of rule groups to run last. Within each set, the administrator - // prioritizes the rule groups, to determine their relative processing order. + // prioritized before these. + // + // In the Firewall Manager WAF policy, the Firewall Manager administrator can + // define a set of rule groups to run first in the web ACL and a set of rule groups + // to run last. Within each set, the administrator prioritizes the rule groups, to + // determine their relative processing order. PostProcessFirewallManagerRuleGroups []FirewallManagerRuleGroup // The first set of rules for WAF to process in the web ACL. This is defined in an // Firewall Manager WAF policy and contains only rule group references. You can't // alter these. Any rules and rule groups that you define for the web ACL are - // prioritized after these. In the Firewall Manager WAF policy, the Firewall - // Manager administrator can define a set of rule groups to run first in the web - // ACL and a set of rule groups to run last. Within each set, the administrator - // prioritizes the rule groups, to determine their relative processing order. + // prioritized after these. + // + // In the Firewall Manager WAF policy, the Firewall Manager administrator can + // define a set of rule groups to run first in the web ACL and a set of rule groups + // to run last. Within each set, the administrator prioritizes the rule groups, to + // determine their relative processing order. PreProcessFirewallManagerRuleGroups []FirewallManagerRuleGroup - // The Rule statements used to identify the web requests that you want to manage. - // Each rule includes one top-level statement that WAF uses to identify matching - // web requests, and parameters that govern how WAF handles them. + // The Rule statements used to identify the web requests that you want to manage. Each + // rule includes one top-level statement that WAF uses to identify matching web + // requests, and parameters that govern how WAF handles them. Rules []Rule // Specifies the domains that WAF should accept in a web request token. This @@ -3976,10 +4764,9 @@ type WebACL struct { noSmithyDocumentSerde } -// 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 . +// 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. type WebACLSummary struct { // The Amazon Resource Name (ARN) of the entity. diff --git a/service/wellarchitected/api_op_AssociateLenses.go b/service/wellarchitected/api_op_AssociateLenses.go index 40a872ca46a..b92e9f130ce 100644 --- a/service/wellarchitected/api_op_AssociateLenses.go +++ b/service/wellarchitected/api_op_AssociateLenses.go @@ -10,12 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Associate a lens to a workload. Up to 10 lenses can be associated with a -// workload in a single API operation. A maximum of 20 lenses can be associated -// with a workload. Disclaimer By accessing and/or applying custom lenses created -// by another Amazon Web Services user or account, you acknowledge that custom -// lenses created by other users and shared with you are Third Party Content as -// defined in the Amazon Web Services Customer Agreement. +// Associate a lens to a workload. +// +// Up to 10 lenses can be associated with a workload in a single API operation. A +// maximum of 20 lenses can be associated with a workload. +// +// # Disclaimer +// +// By accessing and/or applying custom lenses created by another Amazon Web +// Services user or account, you acknowledge that custom lenses created by other +// users and shared with you are Third Party Content as defined in the Amazon Web +// Services Customer Agreement. func (c *Client) AssociateLenses(ctx context.Context, params *AssociateLensesInput, optFns ...func(*Options)) (*AssociateLensesOutput, error) { if params == nil { params = &AssociateLensesInput{} @@ -35,7 +40,9 @@ 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 diff --git a/service/wellarchitected/api_op_CreateLensShare.go b/service/wellarchitected/api_op_CreateLensShare.go index 625f9f1956a..84d498a6ba7 100644 --- a/service/wellarchitected/api_op_CreateLensShare.go +++ b/service/wellarchitected/api_op_CreateLensShare.go @@ -10,19 +10,29 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a lens share. The owner of a lens can share it with other Amazon Web -// Services accounts, users, an organization, and organizational units (OUs) in the -// same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon -// 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) -// 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 -// other accounts may continue to access and use your shared custom lenses even if -// you delete the custom lenses from your own Amazon Web Services account or -// terminate your Amazon Web Services account. +// Create a lens share. +// +// The owner of a lens can share it with other Amazon Web Services accounts, +// users, an organization, and organizational units (OUs) in the same Amazon Web +// Services Region. Lenses provided by Amazon Web Services (Amazon 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] 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 other accounts may continue to access and use your +// shared custom lenses even if you delete the custom lenses from your own Amazon +// Web Services account or terminate your Amazon Web Services account. +// +// [Sharing a custom lens]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html func (c *Client) CreateLensShare(ctx context.Context, params *CreateLensShareInput, optFns ...func(*Options)) (*CreateLensShareOutput, error) { if params == nil { params = &CreateLensShareInput{} @@ -41,24 +51,34 @@ func (c *Client) CreateLensShare(ctx context.Context, params *CreateLensShareInp type CreateLensShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_CreateLensVersion.go b/service/wellarchitected/api_op_CreateLensVersion.go index cf902b7cc07..7948f18c254 100644 --- a/service/wellarchitected/api_op_CreateLensVersion.go +++ b/service/wellarchitected/api_op_CreateLensVersion.go @@ -10,11 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a new lens version. A lens can have up to 100 versions. Use this -// operation to publish a new lens version after you have imported a lens. The -// LensAlias is used to identify the lens to be published. The owner of a lens can -// share the lens with other Amazon Web Services accounts and users in the same -// Amazon Web Services Region. Only the owner of a lens can delete it. +// Create a new lens version. +// +// A lens can have up to 100 versions. +// +// Use this operation to publish a new lens version after you have imported a +// lens. The LensAlias is used to identify the lens to be published. The owner of +// a lens can share the lens with other Amazon Web Services accounts and users in +// the same Amazon Web Services Region. Only the owner of a lens can delete it. func (c *Client) CreateLensVersion(ctx context.Context, params *CreateLensVersionInput, optFns ...func(*Options)) (*CreateLensVersionOutput, error) { if params == nil { params = &CreateLensVersionInput{} @@ -33,24 +36,34 @@ func (c *Client) CreateLensVersion(ctx context.Context, params *CreateLensVersio type CreateLensVersionInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 82b7f6ff727..fa80945a323 100644 --- a/service/wellarchitected/api_op_CreateMilestone.go +++ b/service/wellarchitected/api_op_CreateMilestone.go @@ -30,19 +30,24 @@ func (c *Client) CreateMilestone(ctx context.Context, params *CreateMilestoneInp type CreateMilestoneInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // 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 @@ -59,7 +64,9 @@ type CreateMilestoneInput struct { // Output of a create milestone call. type CreateMilestoneOutput struct { - // The milestone number. A workload can have a maximum of 100 milestones. + // 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 diff --git a/service/wellarchitected/api_op_CreateProfile.go b/service/wellarchitected/api_op_CreateProfile.go index 2290535760b..3a2ba0adf3e 100644 --- a/service/wellarchitected/api_op_CreateProfile.go +++ b/service/wellarchitected/api_op_CreateProfile.go @@ -30,13 +30,17 @@ func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, type CreateProfileInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_CreateProfileShare.go b/service/wellarchitected/api_op_CreateProfileShare.go index 8ac370f9227..66dc44038d2 100644 --- a/service/wellarchitected/api_op_CreateProfileShare.go +++ b/service/wellarchitected/api_op_CreateProfileShare.go @@ -29,13 +29,17 @@ func (c *Client) CreateProfileShare(ctx context.Context, params *CreateProfileSh type CreateProfileShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_CreateReviewTemplate.go b/service/wellarchitected/api_op_CreateReviewTemplate.go index 615ebc15656..95665ef54a7 100644 --- a/service/wellarchitected/api_op_CreateReviewTemplate.go +++ b/service/wellarchitected/api_op_CreateReviewTemplate.go @@ -10,13 +10,16 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a review template. Disclaimer Do not include or gather personal -// identifiable information (PII) of end users or other identifiable individuals in -// or via your review templates. If your review template or those shared with you -// and used in your account do include or collect PII you are responsible for: -// ensuring that the included PII is processed in accordance with applicable law, -// providing adequate privacy notices, and obtaining necessary consents for -// processing such data. +// Create a review template. +// +// # Disclaimer +// +// Do not include or gather personal identifiable information (PII) of end users +// or other identifiable individuals in or via your review templates. If your +// review template or those shared with you and used in your account do include or +// collect PII you are responsible for: ensuring that the included PII is processed +// in accordance with applicable law, providing adequate privacy notices, and +// obtaining necessary consents for processing such data. func (c *Client) CreateReviewTemplate(ctx context.Context, params *CreateReviewTemplateInput, optFns ...func(*Options)) (*CreateReviewTemplateOutput, error) { if params == nil { params = &CreateReviewTemplateInput{} @@ -35,13 +38,17 @@ func (c *Client) CreateReviewTemplate(ctx context.Context, params *CreateReviewT type CreateReviewTemplateInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string @@ -61,8 +68,10 @@ type CreateReviewTemplateInput struct { // This member is required. TemplateName *string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // The tags assigned to the review template. diff --git a/service/wellarchitected/api_op_CreateTemplateShare.go b/service/wellarchitected/api_op_CreateTemplateShare.go index 8536a4fd361..8d6efa85485 100644 --- a/service/wellarchitected/api_op_CreateTemplateShare.go +++ b/service/wellarchitected/api_op_CreateTemplateShare.go @@ -10,15 +10,23 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a review template share. The owner of a review template can share it -// with other Amazon Web Services accounts, users, an organization, and -// organizational units (OUs) in the same Amazon Web Services Region. Shared access -// to a review template is not removed until the review template share invitation -// is deleted. If you share a review template with an organization or OU, all -// accounts in the organization or OU are granted access to the review template. -// Disclaimer By sharing your review template with other Amazon Web Services -// accounts, you acknowledge that Amazon Web Services will make your review -// template available to those other accounts. +// Create a review template share. +// +// The owner of a review template can share it with other Amazon Web Services +// accounts, users, an organization, and organizational units (OUs) in the same +// Amazon Web Services Region. +// +// Shared access to a review template is not removed until the review template +// share invitation is deleted. +// +// If you share a review template with an organization or OU, all accounts in the +// organization or OU are granted access to the review template. +// +// # Disclaimer +// +// By sharing your review template with other Amazon Web Services accounts, you +// acknowledge that Amazon Web Services will make your review template available to +// those other accounts. func (c *Client) CreateTemplateShare(ctx context.Context, params *CreateTemplateShareInput, optFns ...func(*Options)) (*CreateTemplateShareOutput, error) { if params == nil { params = &CreateTemplateShareInput{} @@ -37,13 +45,17 @@ func (c *Client) CreateTemplateShare(ctx context.Context, params *CreateTemplate type CreateTemplateShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_CreateWorkload.go b/service/wellarchitected/api_op_CreateWorkload.go index 26f4019c554..5bcbf6a6440 100644 --- a/service/wellarchitected/api_op_CreateWorkload.go +++ b/service/wellarchitected/api_op_CreateWorkload.go @@ -11,19 +11,32 @@ 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 -// 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 -// following section. When creating a workload using a review template, you must -// have the following IAM permissions: +// 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] 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 following section. +// +// When creating a workload using a review template, you must have the following +// IAM permissions: +// // - wellarchitected:GetReviewTemplate +// // - wellarchitected:GetReviewTemplateAnswer +// // - wellarchitected:ListReviewTemplateAnswers +// // - wellarchitected:GetReviewTemplateLensReview +// +// [Defining a Workload]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html func (c *Client) CreateWorkload(ctx context.Context, params *CreateWorkloadInput, optFns ...func(*Options)) (*CreateWorkloadOutput, error) { if params == nil { params = &CreateWorkloadInput{} @@ -43,13 +56,17 @@ func (c *Client) CreateWorkload(ctx context.Context, params *CreateWorkloadInput type CreateWorkloadInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string @@ -64,17 +81,19 @@ type CreateWorkloadInput struct { // This member is required. Environment types.WorkloadEnvironment - // The list of lenses associated with the workload. Each lens is identified by its - // LensSummary$LensAlias . If a review template that specifies lenses is applied to - // the workload, those lenses are applied to the workload in addition to these - // lenses. + // The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias + // . + // + // If a review template that specifies lenses is applied to the workload, those + // lenses are applied to the workload in addition to these lenses. // // This member is required. Lenses []string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. // // This member is required. WorkloadName *string @@ -98,48 +117,79 @@ type CreateWorkloadInput struct { // The industry for the workload. Industry *string - // The industry type for the workload. If specified, must be one of the following: + // 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 // Jira configuration settings when creating a workload. JiraConfiguration *types.WorkloadJiraConfigurationInput - // The list of non-Amazon Web Services Regions associated with the workload. + // The list of non-Amazon Web Services Regions associated with the workload. NonAwsRegions []string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. 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 list of profile ARNs associated with the workload. diff --git a/service/wellarchitected/api_op_CreateWorkloadShare.go b/service/wellarchitected/api_op_CreateWorkloadShare.go index 1989beebe60..d1ba8e9ebe7 100644 --- a/service/wellarchitected/api_op_CreateWorkloadShare.go +++ b/service/wellarchitected/api_op_CreateWorkloadShare.go @@ -11,13 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Create a workload share. The owner of a workload can share it with other Amazon -// Web Services accounts and users in the same Amazon Web Services Region. Shared -// 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) -// in the Well-Architected Tool User Guide. +// Create a workload share. +// +// The owner of a workload can share it with other Amazon Web Services accounts +// and users in the same Amazon Web Services Region. Shared 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] in the Well-Architected Tool User Guide. +// +// [Sharing a workload]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html func (c *Client) CreateWorkloadShare(ctx context.Context, params *CreateWorkloadShareInput, optFns ...func(*Options)) (*CreateWorkloadShareOutput, error) { if params == nil { params = &CreateWorkloadShareInput{} @@ -37,13 +42,17 @@ func (c *Client) CreateWorkloadShare(ctx context.Context, params *CreateWorkload type CreateWorkloadShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DeleteLens.go b/service/wellarchitected/api_op_DeleteLens.go index 61ae429ba6d..ce008b77426 100644 --- a/service/wellarchitected/api_op_DeleteLens.go +++ b/service/wellarchitected/api_op_DeleteLens.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete an existing lens. Only the owner of a lens can delete it. After the lens -// is deleted, Amazon Web Services accounts and users that you shared the lens with -// can continue to use it, but they will no longer be able to apply it to new -// workloads. 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 other accounts may -// continue to access and use your shared custom lenses even if you delete the -// custom lenses from your own Amazon Web Services account or terminate your Amazon -// Web Services account. +// Delete an existing lens. +// +// Only the owner of a lens can delete it. After the lens is deleted, Amazon Web +// Services accounts and users that you shared the lens with can continue to use +// it, but they will no longer be able to apply it to new workloads. +// +// # 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 other accounts may continue to access and use your +// shared custom lenses even if you delete the custom lenses from your own Amazon +// Web Services account or terminate your Amazon Web Services account. func (c *Client) DeleteLens(ctx context.Context, params *DeleteLensInput, optFns ...func(*Options)) (*DeleteLensOutput, error) { if params == nil { params = &DeleteLensInput{} @@ -38,24 +42,34 @@ func (c *Client) DeleteLens(ctx context.Context, params *DeleteLensInput, optFns type DeleteLensInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 b9239c3e11b..349cf9bbef2 100644 --- a/service/wellarchitected/api_op_DeleteLensShare.go +++ b/service/wellarchitected/api_op_DeleteLensShare.go @@ -10,15 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a lens share. After the lens share is deleted, Amazon Web Services -// accounts, users, organizations, and organizational units (OUs) that you shared -// the lens with can continue to use it, but they will no longer be able to apply -// it to new workloads. 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 other accounts may -// continue to access and use your shared custom lenses even if you delete the -// custom lenses from your own Amazon Web Services account or terminate your Amazon -// Web Services account. +// Delete a lens share. +// +// After the lens share is deleted, Amazon Web Services accounts, users, +// organizations, and organizational units (OUs) that you shared the lens with can +// continue to use it, but they will no longer be able to apply it to new +// workloads. +// +// # 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 other accounts may continue to access and use your +// shared custom lenses even if you delete the custom lenses from your own Amazon +// Web Services account or terminate your Amazon Web Services account. func (c *Client) DeleteLensShare(ctx context.Context, params *DeleteLensShareInput, optFns ...func(*Options)) (*DeleteLensShareOutput, error) { if params == nil { params = &DeleteLensShareInput{} @@ -37,24 +42,34 @@ func (c *Client) DeleteLensShare(ctx context.Context, params *DeleteLensShareInp type DeleteLensShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_DeleteProfile.go b/service/wellarchitected/api_op_DeleteProfile.go index 53574362907..ebac0b0dd92 100644 --- a/service/wellarchitected/api_op_DeleteProfile.go +++ b/service/wellarchitected/api_op_DeleteProfile.go @@ -10,11 +10,15 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a profile. Disclaimer By sharing your profile with other Amazon Web -// Services accounts, you acknowledge that Amazon Web Services will make your -// profile available to those other accounts. Those other accounts may continue to -// access and use your shared profile even if you delete the profile from your own -// Amazon Web Services account or terminate your Amazon Web Services account. +// Delete a profile. +// +// # Disclaimer +// +// By sharing your profile with other Amazon Web Services accounts, you +// acknowledge that Amazon Web Services will make your profile available to those +// other accounts. Those other accounts may continue to access and use your shared +// profile even if you delete the profile from your own Amazon Web Services account +// or terminate your Amazon Web Services account. func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, optFns ...func(*Options)) (*DeleteProfileOutput, error) { if params == nil { params = &DeleteProfileInput{} @@ -33,13 +37,17 @@ func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, type DeleteProfileInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DeleteProfileShare.go b/service/wellarchitected/api_op_DeleteProfileShare.go index cb8d765e0a6..8695f5f18ec 100644 --- a/service/wellarchitected/api_op_DeleteProfileShare.go +++ b/service/wellarchitected/api_op_DeleteProfileShare.go @@ -29,13 +29,17 @@ func (c *Client) DeleteProfileShare(ctx context.Context, params *DeleteProfileSh type DeleteProfileShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DeleteReviewTemplate.go b/service/wellarchitected/api_op_DeleteReviewTemplate.go index 2a45dc08ad5..6342e1c77bc 100644 --- a/service/wellarchitected/api_op_DeleteReviewTemplate.go +++ b/service/wellarchitected/api_op_DeleteReviewTemplate.go @@ -10,7 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a review template. Only the owner of a review template can delete it. +// Delete a review template. +// +// Only the owner of a review template can delete it. +// // After the review template is deleted, Amazon Web Services accounts, users, // organizations, and organizational units (OUs) that you shared the review // template with will no longer be able to apply it to new workloads. @@ -32,13 +35,17 @@ func (c *Client) DeleteReviewTemplate(ctx context.Context, params *DeleteReviewT type DeleteReviewTemplateInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DeleteTemplateShare.go b/service/wellarchitected/api_op_DeleteTemplateShare.go index c89cddf0dbf..b564f2fad47 100644 --- a/service/wellarchitected/api_op_DeleteTemplateShare.go +++ b/service/wellarchitected/api_op_DeleteTemplateShare.go @@ -10,10 +10,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Delete a review template share. After the review template share is deleted, -// Amazon Web Services accounts, users, organizations, and organizational units -// (OUs) that you shared the review template with will no longer be able to apply -// it to new workloads. +// Delete a review template share. +// +// After the review template share is deleted, Amazon Web Services accounts, +// users, organizations, and organizational units (OUs) that you shared the review +// template with will no longer be able to apply it to new workloads. func (c *Client) DeleteTemplateShare(ctx context.Context, params *DeleteTemplateShareInput, optFns ...func(*Options)) (*DeleteTemplateShareOutput, error) { if params == nil { params = &DeleteTemplateShareInput{} @@ -32,13 +33,17 @@ func (c *Client) DeleteTemplateShare(ctx context.Context, params *DeleteTemplate type DeleteTemplateShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DeleteWorkload.go b/service/wellarchitected/api_op_DeleteWorkload.go index 48b1dda4025..9e4f55d4a3f 100644 --- a/service/wellarchitected/api_op_DeleteWorkload.go +++ b/service/wellarchitected/api_op_DeleteWorkload.go @@ -30,13 +30,17 @@ func (c *Client) DeleteWorkload(ctx context.Context, params *DeleteWorkloadInput type DeleteWorkloadInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DeleteWorkloadShare.go b/service/wellarchitected/api_op_DeleteWorkloadShare.go index 08519fcc4cd..9438ac331a8 100644 --- a/service/wellarchitected/api_op_DeleteWorkloadShare.go +++ b/service/wellarchitected/api_op_DeleteWorkloadShare.go @@ -30,13 +30,17 @@ func (c *Client) DeleteWorkloadShare(ctx context.Context, params *DeleteWorkload type DeleteWorkloadShareInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_DisassociateLenses.go b/service/wellarchitected/api_op_DisassociateLenses.go index 9f317d47808..fdba6a4c162 100644 --- a/service/wellarchitected/api_op_DisassociateLenses.go +++ b/service/wellarchitected/api_op_DisassociateLenses.go @@ -10,9 +10,12 @@ 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,7 +35,9 @@ 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 diff --git a/service/wellarchitected/api_op_ExportLens.go b/service/wellarchitected/api_op_ExportLens.go index 01e4c32bb12..4faa6503f01 100644 --- a/service/wellarchitected/api_op_ExportLens.go +++ b/service/wellarchitected/api_op_ExportLens.go @@ -10,17 +10,24 @@ 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 -// 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) -// 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 -// with you and used in your account do include or collect PII you are responsible -// for: ensuring that the included PII is processed in accordance with applicable -// law, providing adequate privacy notices, and obtaining necessary consents for -// processing such data. +// 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] 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 with you and used in your account do include or collect PII +// you are responsible for: ensuring that the included PII is processed in +// accordance with applicable law, providing adequate privacy notices, and +// obtaining necessary consents for processing such data. +// +// [JSON format specification]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html func (c *Client) ExportLens(ctx context.Context, params *ExportLensInput, optFns ...func(*Options)) (*ExportLensOutput, error) { if params == nil { params = &ExportLensInput{} @@ -38,13 +45,19 @@ 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 ad99af228fb..8056c76347d 100644 --- a/service/wellarchitected/api_op_GetAnswer.go +++ b/service/wellarchitected/api_op_GetAnswer.go @@ -30,13 +30,19 @@ func (c *Client) GetAnswer(ctx context.Context, params *GetAnswerInput, optFns . // Input to get answer. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -52,7 +58,9 @@ type GetAnswerInput struct { // This member is required. WorkloadId *string - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 noSmithyDocumentSerde @@ -64,19 +72,27 @@ type GetAnswerOutput struct { // An answer of the question. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. LensArn *string - // The milestone number. A workload can have a maximum of 100 milestones. + // 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 diff --git a/service/wellarchitected/api_op_GetConsolidatedReport.go b/service/wellarchitected/api_op_GetConsolidatedReport.go index a664f87c1f6..70365718ff5 100644 --- a/service/wellarchitected/api_op_GetConsolidatedReport.go +++ b/service/wellarchitected/api_op_GetConsolidatedReport.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Get a consolidated report of your workloads. You can optionally choose to -// include workloads that have been shared with you. +// Get a consolidated report of your workloads. +// +// You can optionally choose to include workloads that have been shared with you. func (c *Client) GetConsolidatedReport(ctx context.Context, params *GetConsolidatedReportInput, optFns ...func(*Options)) (*GetConsolidatedReportOutput, error) { if params == nil { params = &GetConsolidatedReportInput{} @@ -30,8 +31,9 @@ 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 @@ -50,13 +52,16 @@ type GetConsolidatedReportInput struct { type GetConsolidatedReportOutput struct { - // The Base64-encoded string representation of a lens review report. This data can - // be used to create a PDF file. Only returned by GetConsolidatedReport when PDF - // format is requested. + // The Base64-encoded string representation of a lens review report. + // + // This data can be used to create a PDF file. + // + // Only returned by GetConsolidatedReport when PDF 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 edb4bfa9d6c..7d85bc8af8f 100644 --- a/service/wellarchitected/api_op_GetLens.go +++ b/service/wellarchitected/api_op_GetLens.go @@ -29,13 +29,19 @@ 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 9501de116f5..57e9ec5caf4 100644 --- a/service/wellarchitected/api_op_GetLensReview.go +++ b/service/wellarchitected/api_op_GetLensReview.go @@ -30,13 +30,19 @@ func (c *Client) GetLensReview(ctx context.Context, params *GetLensReviewInput, // Input to get lens review. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -47,7 +53,9 @@ type GetLensReviewInput struct { // This member is required. WorkloadId *string - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 noSmithyDocumentSerde @@ -59,7 +67,9 @@ type GetLensReviewOutput struct { // A lens review of a question. LensReview *types.LensReview - // The milestone number. A workload can have a maximum of 100 milestones. + // 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 diff --git a/service/wellarchitected/api_op_GetLensReviewReport.go b/service/wellarchitected/api_op_GetLensReviewReport.go index 5bd837d535b..07056da6bf2 100644 --- a/service/wellarchitected/api_op_GetLensReviewReport.go +++ b/service/wellarchitected/api_op_GetLensReviewReport.go @@ -30,13 +30,19 @@ func (c *Client) GetLensReviewReport(ctx context.Context, params *GetLensReviewR // Input to get lens review report. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -47,7 +53,9 @@ type GetLensReviewReportInput struct { // This member is required. WorkloadId *string - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 noSmithyDocumentSerde @@ -59,7 +67,9 @@ type GetLensReviewReportOutput struct { // A report of a lens review. LensReviewReport *types.LensReviewReport - // The milestone number. A workload can have a maximum of 100 milestones. + // 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 diff --git a/service/wellarchitected/api_op_GetLensVersionDifference.go b/service/wellarchitected/api_op_GetLensVersionDifference.go index 6da44288b1e..c56991d7afb 100644 --- a/service/wellarchitected/api_op_GetLensVersionDifference.go +++ b/service/wellarchitected/api_op_GetLensVersionDifference.go @@ -29,13 +29,19 @@ 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -57,13 +63,19 @@ type GetLensVersionDifferenceOutput struct { // The latest version of the lens. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 096fdd7e6db..ebe174a1528 100644 --- a/service/wellarchitected/api_op_GetMilestone.go +++ b/service/wellarchitected/api_op_GetMilestone.go @@ -30,7 +30,9 @@ func (c *Client) GetMilestone(ctx context.Context, params *GetMilestoneInput, op // Input to get a milestone. type GetMilestoneInput struct { - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. // // This member is required. MilestoneNumber *int32 diff --git a/service/wellarchitected/api_op_GetReviewTemplateAnswer.go b/service/wellarchitected/api_op_GetReviewTemplateAnswer.go index b894f564d89..55da9ece9a6 100644 --- a/service/wellarchitected/api_op_GetReviewTemplateAnswer.go +++ b/service/wellarchitected/api_op_GetReviewTemplateAnswer.go @@ -29,13 +29,19 @@ func (c *Client) GetReviewTemplateAnswer(ctx context.Context, params *GetReviewT type GetReviewTemplateAnswerInput 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -58,13 +64,19 @@ type GetReviewTemplateAnswerOutput struct { // An answer of the question. Answer *types.ReviewTemplateAnswer - // 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The review template ARN. diff --git a/service/wellarchitected/api_op_GetReviewTemplateLensReview.go b/service/wellarchitected/api_op_GetReviewTemplateLensReview.go index 5ec3c6ccff5..354cc651fbb 100644 --- a/service/wellarchitected/api_op_GetReviewTemplateLensReview.go +++ b/service/wellarchitected/api_op_GetReviewTemplateLensReview.go @@ -29,13 +29,19 @@ func (c *Client) GetReviewTemplateLensReview(ctx context.Context, params *GetRev type GetReviewTemplateLensReviewInput 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_ImportLens.go b/service/wellarchitected/api_op_ImportLens.go index 695e5d5806b..d214b794ea8 100644 --- a/service/wellarchitected/api_op_ImportLens.go +++ b/service/wellarchitected/api_op_ImportLens.go @@ -11,19 +11,30 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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, -// 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) -// 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 -// lenses. If your custom lens or those shared with you and used in your account do -// include or collect PII you are responsible for: ensuring that the included PII -// is processed in accordance with applicable law, providing adequate privacy -// notices, and obtaining necessary consents for processing such data. +// 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, 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] 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 lenses. If your custom +// lens or those shared with you and used in your account do include or collect PII +// you are responsible for: ensuring that the included PII is processed in +// accordance with applicable law, providing adequate privacy notices, and +// obtaining necessary consents for processing such data. +// +// [JSON format specification]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html func (c *Client) ImportLens(ctx context.Context, params *ImportLensInput, optFns ...func(*Options)) (*ImportLensOutput, error) { if params == nil { params = &ImportLensInput{} @@ -42,13 +53,17 @@ func (c *Client) ImportLens(ctx context.Context, params *ImportLensInput, optFns type ImportLensInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string @@ -58,13 +73,19 @@ type ImportLensInput struct { // This member is required. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 df40b03df30..4ddb40df15a 100644 --- a/service/wellarchitected/api_op_ListAnswers.go +++ b/service/wellarchitected/api_op_ListAnswers.go @@ -30,13 +30,19 @@ func (c *Client) ListAnswers(ctx context.Context, params *ListAnswersInput, optF // Input to list answers. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -50,14 +56,17 @@ type ListAnswersInput struct { // The maximum number of results to return for this request. MaxResults *int32 - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // 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 // The priority of the question. @@ -72,19 +81,27 @@ type ListAnswersOutput struct { // List of answer summaries of lens review in a workload. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. LensArn *string - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // The token to use to retrieve the next set of results. diff --git a/service/wellarchitected/api_op_ListCheckDetails.go b/service/wellarchitected/api_op_ListCheckDetails.go index 2c645b3ba5a..af14cb05d34 100644 --- a/service/wellarchitected/api_op_ListCheckDetails.go +++ b/service/wellarchitected/api_op_ListCheckDetails.go @@ -39,8 +39,9 @@ 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 diff --git a/service/wellarchitected/api_op_ListCheckSummaries.go b/service/wellarchitected/api_op_ListCheckSummaries.go index 1c3910a23d4..4dd47a298eb 100644 --- a/service/wellarchitected/api_op_ListCheckSummaries.go +++ b/service/wellarchitected/api_op_ListCheckSummaries.go @@ -40,8 +40,9 @@ 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 diff --git a/service/wellarchitected/api_op_ListLensReviewImprovements.go b/service/wellarchitected/api_op_ListLensReviewImprovements.go index e53589519dd..ffbde00206c 100644 --- a/service/wellarchitected/api_op_ListLensReviewImprovements.go +++ b/service/wellarchitected/api_op_ListLensReviewImprovements.go @@ -30,13 +30,19 @@ func (c *Client) ListLensReviewImprovements(ctx context.Context, params *ListLen // Input to list lens review improvements. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -50,14 +56,17 @@ type ListLensReviewImprovementsInput struct { // The maximum number of results to return for this request. MaxResults *int32 - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // 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 // The priority of the question. @@ -72,19 +81,27 @@ type ListLensReviewImprovementsOutput struct { // List of improvement summaries of lens review in a workload. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. LensArn *string - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // The token to use to retrieve the next set of results. diff --git a/service/wellarchitected/api_op_ListLensReviews.go b/service/wellarchitected/api_op_ListLensReviews.go index 8d843fefe04..14d997def99 100644 --- a/service/wellarchitected/api_op_ListLensReviews.go +++ b/service/wellarchitected/api_op_ListLensReviews.go @@ -39,7 +39,9 @@ type ListLensReviewsInput struct { // The maximum number of results to return for this request. MaxResults *int32 - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // The token to use to retrieve the next set of results. @@ -54,7 +56,9 @@ type ListLensReviewsOutput struct { // List of lens summaries of lens reviews of a workload. LensReviewSummaries []types.LensReviewSummary - // The milestone number. A workload can have a maximum of 100 milestones. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // The token to use to retrieve the next set of results. diff --git a/service/wellarchitected/api_op_ListLensShares.go b/service/wellarchitected/api_op_ListLensShares.go index 6da6b216355..cdf58a8d243 100644 --- a/service/wellarchitected/api_op_ListLensShares.go +++ b/service/wellarchitected/api_op_ListLensShares.go @@ -29,13 +29,19 @@ 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string diff --git a/service/wellarchitected/api_op_ListNotifications.go b/service/wellarchitected/api_op_ListNotifications.go index 97b885d08e2..e28bc8b75a7 100644 --- a/service/wellarchitected/api_op_ListNotifications.go +++ b/service/wellarchitected/api_op_ListNotifications.go @@ -35,8 +35,9 @@ type ListNotificationsInput struct { // The token to use to retrieve the next set of results. NextToken *string - // The ARN for the related resource for the notification. Only one of WorkloadID - // or ResourceARN should be specified. + // The ARN for the related resource for the notification. + // + // Only one of WorkloadID or ResourceARN should be specified. ResourceArn *string // The ID assigned to the workload. This ID is unique within an Amazon Web diff --git a/service/wellarchitected/api_op_ListReviewTemplateAnswers.go b/service/wellarchitected/api_op_ListReviewTemplateAnswers.go index 04e5df4efe6..a90f4ed6a42 100644 --- a/service/wellarchitected/api_op_ListReviewTemplateAnswers.go +++ b/service/wellarchitected/api_op_ListReviewTemplateAnswers.go @@ -29,13 +29,19 @@ func (c *Client) ListReviewTemplateAnswers(ctx context.Context, params *ListRevi type ListReviewTemplateAnswersInput 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -51,8 +57,9 @@ type ListReviewTemplateAnswersInput 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 @@ -63,13 +70,19 @@ type ListReviewTemplateAnswersOutput struct { // List of answer summaries of a lens review in a review template. AnswerSummaries []types.ReviewTemplateAnswerSummary - // 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The token to use to retrieve the next set of results. diff --git a/service/wellarchitected/api_op_ListShareInvitations.go b/service/wellarchitected/api_op_ListShareInvitations.go index cbb203ad9a7..331f7a4b76a 100644 --- a/service/wellarchitected/api_op_ListShareInvitations.go +++ b/service/wellarchitected/api_op_ListShareInvitations.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the share invitations. WorkloadNamePrefix , LensNamePrefix , -// ProfileNamePrefix , and TemplateNamePrefix are mutually exclusive. Use the -// parameter that matches your ShareResourceType . +// List the share invitations. +// +// WorkloadNamePrefix , LensNamePrefix , ProfileNamePrefix , and TemplateNamePrefix +// are mutually exclusive. Use the parameter that matches your ShareResourceType . func (c *Client) ListShareInvitations(ctx context.Context, params *ListShareInvitationsInput, optFns ...func(*Options)) (*ListShareInvitationsOutput, error) { if params == nil { params = &ListShareInvitationsInput{} diff --git a/service/wellarchitected/api_op_ListTagsForResource.go b/service/wellarchitected/api_op_ListTagsForResource.go index c92f77d275a..8227a55fcff 100644 --- a/service/wellarchitected/api_op_ListTagsForResource.go +++ b/service/wellarchitected/api_op_ListTagsForResource.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// List the tags for a resource. The WorkloadArn parameter can be a workload ARN, -// a custom lens ARN, a profile ARN, or review template ARN. +// List the tags for a resource. +// +// The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile +// ARN, or review template 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_TagResource.go b/service/wellarchitected/api_op_TagResource.go index 11e3622bc23..97f46e1379b 100644 --- a/service/wellarchitected/api_op_TagResource.go +++ b/service/wellarchitected/api_op_TagResource.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more tags to the specified resource. The WorkloadArn parameter can -// be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. +// Adds one or more tags to the specified resource. +// +// The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile +// ARN, or review template ARN. func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) { if params == nil { params = &TagResourceInput{} diff --git a/service/wellarchitected/api_op_UntagResource.go b/service/wellarchitected/api_op_UntagResource.go index 23c92c3840a..b82b934417c 100644 --- a/service/wellarchitected/api_op_UntagResource.go +++ b/service/wellarchitected/api_op_UntagResource.go @@ -10,10 +10,14 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes specified tags from a resource. The WorkloadArn parameter can be a -// workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To -// specify multiple tags, use separate tagKeys parameters, for example: DELETE -// /tags/WorkloadArn?tagKeys=key1&tagKeys=key2 +// Deletes specified tags from a resource. +// +// The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile +// ARN, or review template ARN. +// +// To specify multiple tags, use separate tagKeys parameters, for example: +// +// DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2 func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) { if params == nil { params = &UntagResourceInput{} diff --git a/service/wellarchitected/api_op_UpdateAnswer.go b/service/wellarchitected/api_op_UpdateAnswer.go index d938f01187d..ae3c758d905 100644 --- a/service/wellarchitected/api_op_UpdateAnswer.go +++ b/service/wellarchitected/api_op_UpdateAnswer.go @@ -30,13 +30,19 @@ func (c *Client) UpdateAnswer(ctx context.Context, params *UpdateAnswerInput, op // Input to update answer. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -59,15 +65,18 @@ type UpdateAnswerInput struct { // Defines whether this question is applicable to a lens review. IsApplicable *bool - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // 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,13 +88,19 @@ type UpdateAnswerOutput struct { // An answer of the question. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. diff --git a/service/wellarchitected/api_op_UpdateIntegration.go b/service/wellarchitected/api_op_UpdateIntegration.go index 3c3b17fd6e8..356df4ee980 100644 --- a/service/wellarchitected/api_op_UpdateIntegration.go +++ b/service/wellarchitected/api_op_UpdateIntegration.go @@ -30,13 +30,17 @@ func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegratio type UpdateIntegrationInput struct { // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. // // This member is required. ClientRequestToken *string diff --git a/service/wellarchitected/api_op_UpdateLensReview.go b/service/wellarchitected/api_op_UpdateLensReview.go index 89b08996616..d6d5cb7dd57 100644 --- a/service/wellarchitected/api_op_UpdateLensReview.go +++ b/service/wellarchitected/api_op_UpdateLensReview.go @@ -30,13 +30,19 @@ func (c *Client) UpdateLensReview(ctx context.Context, params *UpdateLensReviewI // Input for update lens review. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -50,13 +56,16 @@ type UpdateLensReviewInput struct { // Configuration of the Jira integration. JiraConfiguration *types.JiraSelectedQuestionConfiguration - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. LensNotes *string - // List of pillar notes of a lens review in a workload. For a review template, - // these are the notes that will be associated with the workload when the template - // is applied. + // List of pillar notes of a lens review in a workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. PillarNotes map[string]string noSmithyDocumentSerde diff --git a/service/wellarchitected/api_op_UpdateReviewTemplate.go b/service/wellarchitected/api_op_UpdateReviewTemplate.go index 49d9f61207e..c81494effb4 100644 --- a/service/wellarchitected/api_op_UpdateReviewTemplate.go +++ b/service/wellarchitected/api_op_UpdateReviewTemplate.go @@ -44,8 +44,10 @@ type UpdateReviewTemplateInput struct { // wellarchitected lens cannot be unapplied. LensesToDisassociate []string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // The review template name. diff --git a/service/wellarchitected/api_op_UpdateReviewTemplateAnswer.go b/service/wellarchitected/api_op_UpdateReviewTemplateAnswer.go index 75a5001fc33..7f01f56fa4e 100644 --- a/service/wellarchitected/api_op_UpdateReviewTemplateAnswer.go +++ b/service/wellarchitected/api_op_UpdateReviewTemplateAnswer.go @@ -29,13 +29,19 @@ func (c *Client) UpdateReviewTemplateAnswer(ctx context.Context, params *UpdateR type UpdateReviewTemplateAnswerInput 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -56,15 +62,18 @@ type UpdateReviewTemplateAnswerInput struct { // Defines whether this question is applicable to a lens review. IsApplicable *bool - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // The update reason. 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 @@ -75,13 +84,19 @@ type UpdateReviewTemplateAnswerOutput struct { // An answer of the question. Answer *types.ReviewTemplateAnswer - // 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The review template ARN. diff --git a/service/wellarchitected/api_op_UpdateReviewTemplateLensReview.go b/service/wellarchitected/api_op_UpdateReviewTemplateLensReview.go index 504b65ed675..bdb37ea6adb 100644 --- a/service/wellarchitected/api_op_UpdateReviewTemplateLensReview.go +++ b/service/wellarchitected/api_op_UpdateReviewTemplateLensReview.go @@ -29,13 +29,19 @@ func (c *Client) UpdateReviewTemplateLensReview(ctx context.Context, params *Upd type UpdateReviewTemplateLensReviewInput 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -45,13 +51,16 @@ type UpdateReviewTemplateLensReviewInput struct { // This member is required. TemplateArn *string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. LensNotes *string - // List of pillar notes of a lens review in a workload. For a review template, - // these are the notes that will be associated with the workload when the template - // is applied. + // List of pillar notes of a lens review in a workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. PillarNotes map[string]string noSmithyDocumentSerde diff --git a/service/wellarchitected/api_op_UpdateShareInvitation.go b/service/wellarchitected/api_op_UpdateShareInvitation.go index 83a3516322c..d151771abe1 100644 --- a/service/wellarchitected/api_op_UpdateShareInvitation.go +++ b/service/wellarchitected/api_op_UpdateShareInvitation.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Update a workload or custom lens share invitation. This API operation can be -// called independently of any resource. Previous documentation implied that a -// workload ARN must be specified. +// Update a workload or custom lens share invitation. +// +// This API operation can be called independently of any resource. Previous +// documentation implied that a workload ARN must be specified. func (c *Client) UpdateShareInvitation(ctx context.Context, params *UpdateShareInvitationInput, optFns ...func(*Options)) (*UpdateShareInvitationOutput, error) { if params == nil { params = &UpdateShareInvitationInput{} diff --git a/service/wellarchitected/api_op_UpdateWorkload.go b/service/wellarchitected/api_op_UpdateWorkload.go index a7a3c90ce6d..af7b3fb6e15 100644 --- a/service/wellarchitected/api_op_UpdateWorkload.go +++ b/service/wellarchitected/api_op_UpdateWorkload.go @@ -64,63 +64,96 @@ type UpdateWorkloadInput struct { // The industry for the workload. Industry *string - // The industry type for the workload. If specified, must be one of the following: + // 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 - // owner field is required. If a Review owner is not added to the workload within - // 60 days of acknowledgement, access to the workload is restricted until an owner - // is added. + // owner field is required. + // + // If a Review owner is not added to the workload within 60 days of + // acknowledgement, access to the workload is restricted until an owner is added. IsReviewOwnerUpdateAcknowledged *bool // Configuration of the Jira integration. JiraConfiguration *types.WorkloadJiraConfigurationInput - // The list of non-Amazon Web Services Regions associated with the workload. + // The list of non-Amazon Web Services Regions associated with the workload. NonAwsRegions []string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. 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. ReviewOwner *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde diff --git a/service/wellarchitected/api_op_UpgradeLensReview.go b/service/wellarchitected/api_op_UpgradeLensReview.go index d3603864d66..43311d69ba9 100644 --- a/service/wellarchitected/api_op_UpgradeLensReview.go +++ b/service/wellarchitected/api_op_UpgradeLensReview.go @@ -28,19 +28,26 @@ 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // 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 @@ -52,13 +59,17 @@ type UpgradeLensReviewInput struct { WorkloadId *string // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/wellarchitected/api_op_UpgradeProfileVersion.go b/service/wellarchitected/api_op_UpgradeProfileVersion.go index 2496af9608d..957eb252965 100644 --- a/service/wellarchitected/api_op_UpgradeProfileVersion.go +++ b/service/wellarchitected/api_op_UpgradeProfileVersion.go @@ -40,17 +40,22 @@ type UpgradeProfileVersionInput struct { WorkloadId *string // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. 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. MilestoneName *string noSmithyDocumentSerde diff --git a/service/wellarchitected/api_op_UpgradeReviewTemplateLensReview.go b/service/wellarchitected/api_op_UpgradeReviewTemplateLensReview.go index 0357344e2c7..34ba4630c57 100644 --- a/service/wellarchitected/api_op_UpgradeReviewTemplateLensReview.go +++ b/service/wellarchitected/api_op_UpgradeReviewTemplateLensReview.go @@ -28,13 +28,19 @@ func (c *Client) UpgradeReviewTemplateLensReview(ctx context.Context, params *Up type UpgradeReviewTemplateLensReviewInput 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. // // This member is required. LensAlias *string @@ -45,13 +51,17 @@ type UpgradeReviewTemplateLensReviewInput struct { TemplateArn *string // A unique case-sensitive string used to ensure that this request is idempotent - // (executes only once). You should not reuse the same token for other requests. If - // you retry a request with the same client request token and the same parameters - // after the original request has completed successfully, the result of the - // original request is returned. This token is listed as required, however, if you - // do not specify it, the Amazon Web Services SDKs automatically generate one for - // you. If you are not using the Amazon Web Services SDK or the CLI, you must - // provide this token or the request will fail. + // (executes only once). + // + // You should not reuse the same token for other requests. If you retry a request + // with the same client request token and the same parameters after the original + // request has completed successfully, the result of the original request is + // returned. + // + // This token is listed as required, however, if you do not specify it, the Amazon + // Web Services SDKs automatically generate one for you. If you are not using the + // Amazon Web Services SDK or the CLI, you must provide this token or the request + // will fail. ClientRequestToken *string noSmithyDocumentSerde diff --git a/service/wellarchitected/doc.go b/service/wellarchitected/doc.go index 715e986249b..c41541da3a4 100644 --- a/service/wellarchitected/doc.go +++ b/service/wellarchitected/doc.go @@ -3,10 +3,13 @@ // 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) -// . +// # Well-Architected Tool +// +// This is the Well-Architected Tool API Reference. The WA Tool API provides +// programmatic access to the [Well-Architected Tool]in the [Amazon Web Services Management Console]. For information about the Well-Architected +// Tool, see the [Well-Architected Tool User Guide]. +// +// [Well-Architected Tool User Guide]: https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html +// [Well-Architected Tool]: http://aws.amazon.com/well-architected-tool +// [Amazon Web Services Management Console]: https://console.aws.amazon.com/wellarchitected package wellarchitected diff --git a/service/wellarchitected/options.go b/service/wellarchitected/options.go index 5b2102017ec..5d59b74a20c 100644 --- a/service/wellarchitected/options.go +++ b/service/wellarchitected/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/wellarchitected/types/enums.go b/service/wellarchitected/types/enums.go index 3c2882da244..d04fbc12ee9 100644 --- a/service/wellarchitected/types/enums.go +++ b/service/wellarchitected/types/enums.go @@ -12,8 +12,9 @@ const ( // Values returns all known values for AccountJiraIssueManagementStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountJiraIssueManagementStatus) Values() []AccountJiraIssueManagementStatus { return []AccountJiraIssueManagementStatus{ "ENABLED", @@ -30,8 +31,9 @@ const ( ) // Values returns all known values for AdditionalResourceType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalResourceType) Values() []AdditionalResourceType { return []AdditionalResourceType{ "HELPFUL_RESOURCE", @@ -51,8 +53,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for CheckFailureReason. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CheckFailureReason) Values() []CheckFailureReason { return []CheckFailureReason{ "ASSUME_ROLE_ERROR", @@ -93,8 +97,9 @@ const ( ) // Values returns all known values for CheckProvider. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CheckProvider) Values() []CheckProvider { return []CheckProvider{ "TRUSTED_ADVISOR", @@ -113,8 +118,9 @@ const ( ) // Values returns all known values for CheckStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CheckStatus) Values() []CheckStatus { return []CheckStatus{ "OKAY", @@ -137,8 +143,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -159,8 +166,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -178,8 +186,9 @@ const ( ) // Values returns all known values for DefinitionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DefinitionType) Values() []DefinitionType { return []DefinitionType{ "WORKLOAD_METADATA", @@ -197,8 +206,9 @@ const ( ) // Values returns all known values for DifferenceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DifferenceStatus) Values() []DifferenceStatus { return []DifferenceStatus{ "UPDATED", @@ -217,6 +227,7 @@ const ( // Values returns all known values for DiscoveryIntegrationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DiscoveryIntegrationStatus) Values() []DiscoveryIntegrationStatus { return []DiscoveryIntegrationStatus{ @@ -235,8 +246,9 @@ const ( ) // Values returns all known values for ImportLensStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportLensStatus) Values() []ImportLensStatus { return []ImportLensStatus{ "IN_PROGRESS", @@ -253,8 +265,9 @@ const ( ) // Values returns all known values for IntegratingService. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegratingService) Values() []IntegratingService { return []IntegratingService{ "JIRA", @@ -270,8 +283,9 @@ const ( ) // Values returns all known values for IntegrationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationStatus) Values() []IntegrationStatus { return []IntegrationStatus{ "CONFIGURED", @@ -287,8 +301,9 @@ const ( ) // Values returns all known values for IntegrationStatusInput. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IntegrationStatusInput) Values() []IntegrationStatusInput { return []IntegrationStatusInput{ "NOT_CONFIGURED", @@ -304,8 +319,9 @@ const ( ) // Values returns all known values for IssueManagementType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IssueManagementType) Values() []IssueManagementType { return []IssueManagementType{ "AUTO", @@ -325,8 +341,9 @@ const ( ) // Values returns all known values for LensStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LensStatus) Values() []LensStatus { return []LensStatus{ "CURRENT", @@ -347,8 +364,9 @@ const ( ) // Values returns all known values for LensStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LensStatusType) Values() []LensStatusType { return []LensStatusType{ "ALL", @@ -367,8 +385,9 @@ const ( ) // Values returns all known values for LensType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LensType) Values() []LensType { return []LensType{ "AWS_OFFICIAL", @@ -385,8 +404,9 @@ const ( ) // Values returns all known values for MetricType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MetricType) Values() []MetricType { return []MetricType{ "WORKLOAD", @@ -402,8 +422,9 @@ const ( ) // Values returns all known values for NotificationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (NotificationType) Values() []NotificationType { return []NotificationType{ "LENS_VERSION_UPGRADED", @@ -421,6 +442,7 @@ const ( // Values returns all known values for OrganizationSharingStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (OrganizationSharingStatus) Values() []OrganizationSharingStatus { return []OrganizationSharingStatus{ @@ -438,8 +460,9 @@ const ( ) // Values returns all known values for PermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionType) Values() []PermissionType { return []PermissionType{ "READONLY", @@ -456,8 +479,9 @@ const ( ) // Values returns all known values for ProfileNotificationType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfileNotificationType) Values() []ProfileNotificationType { return []ProfileNotificationType{ "PROFILE_ANSWERS_UPDATED", @@ -474,8 +498,9 @@ const ( ) // Values returns all known values for ProfileOwnerType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ProfileOwnerType) Values() []ProfileOwnerType { return []ProfileOwnerType{ "SELF", @@ -492,8 +517,9 @@ const ( ) // Values returns all known values for Question. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Question) Values() []Question { return []Question{ "UNANSWERED", @@ -510,8 +536,9 @@ const ( ) // Values returns all known values for QuestionPriority. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuestionPriority) Values() []QuestionPriority { return []QuestionPriority{ "PRIORITIZED", @@ -528,8 +555,9 @@ const ( ) // Values returns all known values for QuestionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuestionType) Values() []QuestionType { return []QuestionType{ "PRIORITIZED", @@ -546,8 +574,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -565,6 +594,7 @@ const ( // Values returns all known values for ReviewTemplateAnswerStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReviewTemplateAnswerStatus) Values() []ReviewTemplateAnswerStatus { return []ReviewTemplateAnswerStatus{ @@ -583,6 +613,7 @@ const ( // Values returns all known values for ReviewTemplateUpdateStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ReviewTemplateUpdateStatus) Values() []ReviewTemplateUpdateStatus { return []ReviewTemplateUpdateStatus{ @@ -603,8 +634,9 @@ const ( ) // Values returns all known values for Risk. Note that this can be expanded in the -// future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Risk) Values() []Risk { return []Risk{ "UNANSWERED", @@ -624,8 +656,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACCEPT", @@ -644,8 +677,9 @@ const ( ) // Values returns all known values for ShareResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareResourceType) Values() []ShareResourceType { return []ShareResourceType{ "WORKLOAD", @@ -670,8 +704,9 @@ const ( ) // Values returns all known values for ShareStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatus) Values() []ShareStatus { return []ShareStatus{ "ACCEPTED", @@ -695,8 +730,9 @@ const ( // Values returns all known values for TrustedAdvisorIntegrationStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TrustedAdvisorIntegrationStatus) Values() []TrustedAdvisorIntegrationStatus { return []TrustedAdvisorIntegrationStatus{ "ENABLED", @@ -716,6 +752,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ @@ -735,8 +772,9 @@ const ( ) // Values returns all known values for WorkloadEnvironment. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkloadEnvironment) Values() []WorkloadEnvironment { return []WorkloadEnvironment{ "PRODUCTION", @@ -757,6 +795,7 @@ const ( // Values returns all known values for WorkloadImprovementStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WorkloadImprovementStatus) Values() []WorkloadImprovementStatus { return []WorkloadImprovementStatus{ @@ -779,8 +818,9 @@ const ( // Values returns all known values for WorkloadIssueManagementStatus. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkloadIssueManagementStatus) Values() []WorkloadIssueManagementStatus { return []WorkloadIssueManagementStatus{ "ENABLED", diff --git a/service/wellarchitected/types/types.go b/service/wellarchitected/types/types.go index 1231eb5f497..5269455cfbc 100644 --- a/service/wellarchitected/types/types.go +++ b/service/wellarchitected/types/types.go @@ -49,8 +49,9 @@ type AccountJiraConfigurationOutput struct { noSmithyDocumentSerde } -// The choice level additional resources for a custom lens. This field does not -// apply to Amazon Web Services official lenses. +// The choice level additional resources for a custom lens. +// +// This field does not apply to Amazon Web Services official lenses. type AdditionalResources struct { // The URLs for additional resources, either helpful resources or improvement @@ -72,19 +73,26 @@ 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 - // helpful resource URL for a question or choice. For custom lenses, this is the - // helpful resource URL for a question and is only provided if - // HelpfulResourceDisplayText was specified for the question. + // The helpful resource URL. + // + // For Amazon Web Services official lenses, this is the helpful resource URL for a + // question or choice. + // + // For custom lenses, this is the helpful resource URL for a question and is only + // provided if HelpfulResourceDisplayText was specified for the question. HelpfulResourceUrl *string // The improvement plan URL for a question in an Amazon Web Services official - // lenses. This value is only available if the question has been answered. This - // value does not apply to custom lenses. + // lenses. + // + // This value is only available if the question has been answered. + // + // This value does not apply to custom lenses. ImprovementPlanUrl *string // Defines whether this question is applicable to a lens review. @@ -93,12 +101,15 @@ type Answer struct { // Configuration of the Jira integration. JiraConfiguration *JiraConfiguration - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. 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. @@ -116,8 +127,9 @@ 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 @@ -138,8 +150,9 @@ type AnswerSummary struct { // Configuration of the Jira integration. JiraConfiguration *JiraConfiguration - // 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. @@ -157,8 +170,9 @@ 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 @@ -202,8 +216,9 @@ 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. @@ -245,8 +260,9 @@ 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. @@ -267,9 +283,10 @@ type CheckSummary struct { // A choice available to answer question. 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. + // 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. AdditionalResources []AdditionalResources // The ID of a choice. @@ -278,12 +295,16 @@ type Choice struct { // The description of a choice. Description *string - // The helpful resource (both text and URL) for a particular choice. This field - // only applies to custom lenses. Each choice can have only one helpful resource. + // The helpful resource (both text and URL) for a particular choice. + // + // This field only applies to custom lenses. Each choice can have only one helpful + // resource. HelpfulResource *ChoiceContent - // The improvement plan (both text and URL) for a particular choice. This field - // only applies to custom lenses. Each choice can have only one improvement plan. + // The improvement plan (both text and URL) for a particular choice. + // + // This field only applies to custom lenses. Each choice can have only one + // improvement plan. ImprovementPlan *ChoiceContent // The title of a choice. @@ -347,8 +368,11 @@ type ChoiceImprovementPlan struct { DisplayText *string // The improvement plan URL for a question in an Amazon Web Services official - // lenses. This value is only available if the question has been answered. This - // value does not apply to custom lenses. + // lenses. + // + // This value is only available if the question has been answered. + // + // This value does not apply to custom lenses. ImprovementPlanUrl *string noSmithyDocumentSerde @@ -397,9 +421,10 @@ type ConsolidatedReportMetric struct { // Services Region. WorkloadId *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde @@ -409,8 +434,11 @@ type ConsolidatedReportMetric struct { type ImprovementSummary struct { // The improvement plan URL for a question in an Amazon Web Services official - // lenses. This value is only available if the question has been answered. This - // value does not apply to custom lenses. + // lenses. + // + // This value is only available if the question has been answered. + // + // This value does not apply to custom lenses. ImprovementPlanUrl *string // The improvement plan details. @@ -419,8 +447,9 @@ type ImprovementSummary struct { // Configuration of the Jira integration. JiraConfiguration *JiraConfiguration - // 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. @@ -504,13 +533,19 @@ type LensReview struct { // Jira configuration status of the Lens review. JiraConfiguration *JiraSelectedQuestionConfiguration - // 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. @@ -528,8 +563,10 @@ type LensReview struct { // The token to use to retrieve the next set of results. NextToken *string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // List of pillar review summaries of lens review in a workload. @@ -553,18 +590,26 @@ type LensReview struct { // A report of a lens review. type LensReviewReport struct { - // The Base64-encoded string representation of a lens review report. This data can - // be used to create a PDF file. Only returned by GetConsolidatedReport when PDF - // format is requested. + // The Base64-encoded string representation of a lens review report. + // + // This data can be used to create a PDF file. + // + // Only returned by GetConsolidatedReport when PDF format is requested. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. @@ -576,13 +621,19 @@ type LensReviewReport struct { // A lens review summary of a workload. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. @@ -640,13 +691,19 @@ type LensSummary struct { // The description of the lens. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN of the lens. @@ -682,13 +739,19 @@ type LensUpgradeSummary struct { // The latest version of the lens. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. @@ -697,18 +760,20 @@ type LensUpgradeSummary struct { // ResourceArn of the lens being upgraded ResourceArn *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. ResourceName *string // 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 - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde @@ -717,11 +782,14 @@ 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. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // The date and time recorded. @@ -736,11 +804,14 @@ 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. + // The milestone number. + // + // A workload can have a maximum of 100 milestones. MilestoneNumber *int32 // The date and time recorded. @@ -770,8 +841,9 @@ 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. @@ -786,8 +858,9 @@ 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. @@ -802,12 +875,15 @@ type PillarMetric struct { // A pillar review summary of a lens review. type PillarReviewSummary struct { - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. 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. @@ -895,9 +971,10 @@ type ProfileNotificationSummary struct { // Services Region. WorkloadId *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde @@ -1085,8 +1162,10 @@ type ReviewTemplate struct { // The lenses applied to the review template. Lenses []string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // An Amazon Web Services account ID. @@ -1129,30 +1208,40 @@ type ReviewTemplateAnswer 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 - // helpful resource URL for a question or choice. For custom lenses, this is the - // helpful resource URL for a question and is only provided if - // HelpfulResourceDisplayText was specified for the question. + // The helpful resource URL. + // + // For Amazon Web Services official lenses, this is the helpful resource URL for a + // question or choice. + // + // For custom lenses, this is the helpful resource URL for a question and is only + // provided if HelpfulResourceDisplayText was specified for the question. HelpfulResourceUrl *string // The improvement plan URL for a question in an Amazon Web Services official - // lenses. This value is only available if the question has been answered. This - // value does not apply to custom lenses. + // lenses. + // + // This value is only available if the question has been answered. + // + // This value does not apply to custom lenses. ImprovementPlanUrl *string // Defines whether this question is applicable to a lens review. IsApplicable *bool - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. 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. @@ -1167,8 +1256,9 @@ type ReviewTemplateAnswer struct { // The reason why the question is not applicable to your review template. Reason 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 @@ -1189,8 +1279,9 @@ type ReviewTemplateAnswerSummary 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. @@ -1205,8 +1296,9 @@ type ReviewTemplateAnswerSummary struct { // The reason why a choice is not-applicable to a question in the review template. Reason 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 @@ -1215,13 +1307,19 @@ type ReviewTemplateAnswerSummary struct { // The lens review of a review template. type ReviewTemplateLensReview 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The lens ARN. @@ -1239,8 +1337,10 @@ type ReviewTemplateLensReview struct { // The token to use to retrieve the next set of results. NextToken *string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // Pillar review summaries of a lens review. @@ -1258,12 +1358,15 @@ type ReviewTemplateLensReview struct { // Summary of a review template. type ReviewTemplatePillarReviewSummary struct { - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. 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. @@ -1306,8 +1409,9 @@ type ReviewTemplateSummary struct { // The selected pillar. type SelectedPillar 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 // Selected question IDs in the selected pillar. @@ -1319,13 +1423,19 @@ type SelectedPillar struct { // The share invitation. 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 + // 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 // (such as ExportLens and CreateLensShare) are not permitted on Amazon Web - // Services official lenses. For custom lenses, this is the lens ARN, such as + // 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 . + // . + // + // Each lens is identified by its LensSummary$LensAlias. LensAlias *string // The ARN for the lens. @@ -1391,9 +1501,10 @@ type ShareInvitationSummary struct { // Services Region. WorkloadId *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde @@ -1475,63 +1586,96 @@ type Workload struct { // The industry for the workload. Industry *string - // The industry type for the workload. If specified, must be one of the following: + // 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 - // owner field is required. If a Review owner is not added to the workload within - // 60 days of acknowledgement, access to the workload is restricted until an owner - // is added. + // owner field is required. + // + // If a Review owner is not added to the workload within 60 days of + // acknowledgement, access to the workload is restricted until an owner is added. IsReviewOwnerUpdateAcknowledged *bool // Jira configuration for a specific workload. JiraConfiguration *WorkloadJiraConfigurationOutput - // The list of lenses associated with the workload. Each lens is identified by its - // LensSummary$LensAlias . If a review template that specifies lenses is applied to - // the workload, those lenses are applied to the workload in addition to these - // lenses. + // The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias + // . + // + // If a review template that specifies lenses is applied to the workload, those + // lenses are applied to the workload in addition to these lenses. Lenses []string - // The list of non-Amazon Web Services Regions associated with the workload. + // The list of non-Amazon Web Services Regions associated with the workload. NonAwsRegions []string - // The notes associated with the workload. For a review template, these are the - // notes that will be associated with the workload when the template is applied. + // The notes associated with the workload. + // + // For a review template, these are the notes that will be associated with the + // workload when the template is applied. Notes *string // An Amazon Web Services account ID. 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 // A map from risk names to the count of how many questions have that rating. @@ -1566,9 +1710,10 @@ type Workload struct { // Services Region. WorkloadId *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde @@ -1580,8 +1725,9 @@ type WorkloadDiscoveryConfig struct { // Discovery integration status in respect to Trusted Advisor for the workload. TrustedAdvisorIntegrationStatus TrustedAdvisorIntegrationStatus - // The mode to use for identifying resources associated with the workload. You can - // specify WORKLOAD_METADATA , APP_REGISTRY , or both. + // The mode to use for identifying resources associated with the workload. + // + // You can specify WORKLOAD_METADATA , APP_REGISTRY , or both. WorkloadResourceDefinition []DefinitionType noSmithyDocumentSerde @@ -1655,9 +1801,10 @@ type WorkloadShare struct { // Services Region. WorkloadId *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde @@ -1691,10 +1838,11 @@ type WorkloadSummary struct { // The improvement status for a workload. ImprovementStatus WorkloadImprovementStatus - // The list of lenses associated with the workload. Each lens is identified by its - // LensSummary$LensAlias . If a review template that specifies lenses is applied to - // the workload, those lenses are applied to the workload in addition to these - // lenses. + // The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias + // . + // + // If a review template that specifies lenses is applied to the workload, those + // lenses are applied to the workload in addition to these lenses. Lenses []string // An Amazon Web Services account ID. @@ -1719,9 +1867,10 @@ type WorkloadSummary struct { // Services Region. WorkloadId *string - // The name of the workload. The name must be unique within an account within an - // Amazon Web Services Region. Spaces and capitalization are ignored when checking - // for uniqueness. + // The name of the workload. + // + // The name must be unique within an account within an Amazon Web Services Region. + // Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string noSmithyDocumentSerde diff --git a/service/wisdom/api_op_CreateAssistant.go b/service/wisdom/api_op_CreateAssistant.go index acc8630a4bd..50008033f61 100644 --- a/service/wisdom/api_op_CreateAssistant.go +++ b/service/wisdom/api_op_CreateAssistant.go @@ -41,23 +41,25 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description of the assistant. Description *string // The configuration information for the customer managed key used for encryption. + // // The customer managed key must have a policy that allows kms:CreateGrant , // kms:DescribeKey , and kms:Decrypt/kms:GenerateDataKey permissions to the IAM // identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy // must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey - // permissions to the connect.amazonaws.com service principal. For more - // information about setting up a customer managed key for Wisdom, see Enable - // Amazon Connect Wisdom for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . + // permissions to the connect.amazonaws.com service principal. + // + // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. + // + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. diff --git a/service/wisdom/api_op_CreateAssistantAssociation.go b/service/wisdom/api_op_CreateAssistantAssociation.go index 212a51baa0c..7ade8697e40 100644 --- a/service/wisdom/api_op_CreateAssistantAssociation.go +++ b/service/wisdom/api_op_CreateAssistantAssociation.go @@ -49,9 +49,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // 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 fe5cb990e5a..caff2223129 100644 --- a/service/wisdom/api_op_CreateContent.go +++ b/service/wisdom/api_op_CreateContent.go @@ -11,8 +11,9 @@ 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) -// to upload an asset. +// Creates Wisdom content. Before to calling this API, use [StartContentUpload] to upload an asset. +// +// [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html func (c *Client) CreateContent(ctx context.Context, params *CreateContentInput, optFns ...func(*Options)) (*CreateContentOutput, error) { if params == nil { params = &CreateContentInput{} @@ -39,23 +40,25 @@ 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) - // API. + // and its name with the [SearchContent]API. + // + // [SearchContent]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html // // 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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. If not provided, the Amazon Web Services SDK populates this - // field. For more information about idempotency, see Making retries safe with - // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // 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 06ba95d62cf..4d5c263c2e0 100644 --- a/service/wisdom/api_op_CreateKnowledgeBase.go +++ b/service/wisdom/api_op_CreateKnowledgeBase.go @@ -11,20 +11,28 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a knowledge base. When using this API, you cannot reuse Amazon -// 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. +// Creates a knowledge base. +// +// When using this API, you cannot reuse [Amazon AppIntegrations] 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]. +// +// - Call [DeleteDataIntegration]. +// +// - Call [CreateDataIntegration]to recreate the DataIntegration or a create different one. +// // - Call CreateKnowledgeBase. +// +// [Amazon AppIntegrations]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html +// [DeleteKnowledgeBase]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html +// [DeleteDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error) { if params == nil { params = &CreateKnowledgeBaseInput{} @@ -56,9 +64,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description. @@ -68,11 +76,14 @@ type CreateKnowledgeBaseInput struct { RenderingConfiguration *types.RenderingConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the - // key to invoke Wisdom. For more information about setting up a customer managed - // key for Wisdom, see Enable Amazon Connect Wisdom for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . + // key to invoke Wisdom. + // + // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. + // + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration // The source of the knowledge base content. Only set this argument for EXTERNAL diff --git a/service/wisdom/api_op_CreateQuickResponse.go b/service/wisdom/api_op_CreateQuickResponse.go index 26a8ae64ded..e2687ba770d 100644 --- a/service/wisdom/api_op_CreateQuickResponse.go +++ b/service/wisdom/api_op_CreateQuickResponse.go @@ -51,14 +51,16 @@ type CreateQuickResponseInput 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for a quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for a quick response written // in richtext. ContentType *string diff --git a/service/wisdom/api_op_CreateSession.go b/service/wisdom/api_op_CreateSession.go index 1d5a7a225cf..73bcf1c328c 100644 --- a/service/wisdom/api_op_CreateSession.go +++ b/service/wisdom/api_op_CreateSession.go @@ -44,9 +44,9 @@ 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/) - // . + // field. For more information about idempotency, see [Making retries safe with idempotent APIs]. + // + // [Making retries safe with idempotent APIs]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ ClientToken *string // The description. diff --git a/service/wisdom/api_op_DeleteKnowledgeBase.go b/service/wisdom/api_op_DeleteKnowledgeBase.go index 367e11cc400..ead80e1a81d 100644 --- a/service/wisdom/api_op_DeleteKnowledgeBase.go +++ b/service/wisdom/api_op_DeleteKnowledgeBase.go @@ -10,14 +10,17 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// in the Amazon AppIntegrations API Reference. +// 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]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]and [CreateDataIntegration] in the Amazon +// AppIntegrations API Reference. +// +// [Amazon AppIntegrations]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html +// [DeleteDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html +// [CreateDataIntegration]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error) { if params == nil { params = &DeleteKnowledgeBaseInput{} diff --git a/service/wisdom/api_op_GetRecommendations.go b/service/wisdom/api_op_GetRecommendations.go index ecb47057f67..f6b676ba89d 100644 --- a/service/wisdom/api_op_GetRecommendations.go +++ b/service/wisdom/api_op_GetRecommendations.go @@ -12,16 +12,18 @@ 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. -// 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) -// . +// same recommendations in subsequent calls, use [NotifyRecommendationsReceived]. 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]. // // Deprecated: GetRecommendations API will be discontinued starting June 1, 2024. // To receive generative responses after March 1, 2024 you will need to create a // new Assistant in the Connect console and integrate the Amazon Q in Connect // JavaScript library (amazon-q-connectjs) into your applications. +// +// [QueryAssistant]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html +// [NotifyRecommendationsReceived]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html func (c *Client) GetRecommendations(ctx context.Context, params *GetRecommendationsInput, optFns ...func(*Options)) (*GetRecommendationsOutput, error) { if params == nil { params = &GetRecommendationsInput{} diff --git a/service/wisdom/api_op_NotifyRecommendationsReceived.go b/service/wisdom/api_op_NotifyRecommendationsReceived.go index 520a285b774..a1a3a0d093a 100644 --- a/service/wisdom/api_op_NotifyRecommendationsReceived.go +++ b/service/wisdom/api_op_NotifyRecommendationsReceived.go @@ -12,10 +12,11 @@ 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) -// and a waitTimeSeconds input for long-polling behavior and avoiding duplicate +// newly available recommendations. You can use this API in conjunction with [GetRecommendations]and a +// waitTimeSeconds input for long-polling behavior and avoiding duplicate // recommendations. +// +// [GetRecommendations]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html func (c *Client) NotifyRecommendationsReceived(ctx context.Context, params *NotifyRecommendationsReceivedInput, optFns ...func(*Options)) (*NotifyRecommendationsReceivedOutput, error) { if params == nil { params = &NotifyRecommendationsReceivedInput{} diff --git a/service/wisdom/api_op_QueryAssistant.go b/service/wisdom/api_op_QueryAssistant.go index 149c04942d1..9e7732e850f 100644 --- a/service/wisdom/api_op_QueryAssistant.go +++ b/service/wisdom/api_op_QueryAssistant.go @@ -12,13 +12,14 @@ 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]. // // Deprecated: QueryAssistant API will be discontinued starting June 1, 2024. To // receive generative responses after March 1, 2024 you will need to create a new // Assistant in the Connect console and integrate the Amazon Q in Connect // JavaScript library (amazon-q-connectjs) into your applications. +// +// [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_SearchQuickResponses.go b/service/wisdom/api_op_SearchQuickResponses.go index 6345e49053f..56ade5a400f 100644 --- a/service/wisdom/api_op_SearchQuickResponses.go +++ b/service/wisdom/api_op_SearchQuickResponses.go @@ -40,8 +40,9 @@ type SearchQuickResponsesInput struct { // This member is required. SearchExpression *types.QuickResponseSearchExpression - // The user-defined Amazon Connect contact attributes (https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes) - // to be resolved when search results are returned. + // The [user-defined Amazon Connect contact attributes] to be resolved when search results are returned. + // + // [user-defined Amazon Connect contact attributes]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes Attributes map[string]string // The maximum number of results to return per page. diff --git a/service/wisdom/api_op_StartContentUpload.go b/service/wisdom/api_op_StartContentUpload.go index 590e330bf45..fce7e86d24c 100644 --- a/service/wisdom/api_op_StartContentUpload.go +++ b/service/wisdom/api_op_StartContentUpload.go @@ -13,10 +13,12 @@ import ( // 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. +// required headers. Then use [CreateContent]to finalize the content creation process or [UpdateContent] to +// modify an existing resource. You can only upload content to a knowledge base of +// type CUSTOM. +// +// [CreateContent]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html +// [UpdateContent]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html func (c *Client) StartContentUpload(ctx context.Context, params *StartContentUploadInput, optFns ...func(*Options)) (*StartContentUploadOutput, error) { if params == nil { params = &StartContentUploadInput{} diff --git a/service/wisdom/api_op_StartImportJob.go b/service/wisdom/api_op_StartImportJob.go index 4a7c68f1f50..336ed226e2e 100644 --- a/service/wisdom/api_op_StartImportJob.go +++ b/service/wisdom/api_op_StartImportJob.go @@ -12,12 +12,15 @@ import ( ) // Start an asynchronous job to import Wisdom resources from an uploaded source -// file. Before calling this API, use StartContentUpload (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) -// to upload an asset that contains the resource data. +// file. Before calling this API, use [StartContentUpload]to upload an asset that contains the +// resource data. +// // - For importing Wisdom quick responses, you need to upload a csv file // including the quick responses. For information about how to format the csv file -// for importing quick responses, see Import quick responses (https://docs.aws.amazon.com/console/connect/quick-responses/add-data) -// . +// for importing quick responses, see [Import quick responses]. +// +// [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html +// [Import quick responses]: https://docs.aws.amazon.com/console/connect/quick-responses/add-data func (c *Client) StartImportJob(ctx context.Context, params *StartImportJobInput, optFns ...func(*Options)) (*StartImportJobOutput, error) { if params == nil { params = &StartImportJobInput{} @@ -36,6 +39,7 @@ func (c *Client) StartImportJob(ctx context.Context, params *StartImportJobInput type StartImportJobInput struct { // The type of the import job. + // // - For importing quick response resource, set the value to QUICK_RESPONSES . // // This member is required. @@ -44,14 +48,16 @@ type StartImportJobInput struct { // The identifier of the knowledge base. This should not be a QUICK_RESPONSES type // knowledge base if you're storing Wisdom Content resource to it. Can be either // the ID or the ARN. URLs cannot contain the ARN. + // // - For importing Wisdom quick responses, this should be a QUICK_RESPONSES type // knowledge base. // // This member is required. KnowledgeBaseId *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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string diff --git a/service/wisdom/api_op_UpdateContent.go b/service/wisdom/api_op_UpdateContent.go index ccbdca97056..03c9c297701 100644 --- a/service/wisdom/api_op_UpdateContent.go +++ b/service/wisdom/api_op_UpdateContent.go @@ -67,8 +67,9 @@ type UpdateContentInput struct { // 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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html UploadId *string noSmithyDocumentSerde diff --git a/service/wisdom/api_op_UpdateQuickResponse.go b/service/wisdom/api_op_UpdateQuickResponse.go index d41afd43b80..5b4209ae911 100644 --- a/service/wisdom/api_op_UpdateQuickResponse.go +++ b/service/wisdom/api_op_UpdateQuickResponse.go @@ -49,8 +49,10 @@ type UpdateQuickResponseInput struct { Content types.QuickResponseDataProvider // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. ContentType *string diff --git a/service/wisdom/options.go b/service/wisdom/options.go index 5dcadba3b04..3a9b7e2decf 100644 --- a/service/wisdom/options.go +++ b/service/wisdom/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/wisdom/types/enums.go b/service/wisdom/types/enums.go index 02f507cdb60..1c79245a4a6 100644 --- a/service/wisdom/types/enums.go +++ b/service/wisdom/types/enums.go @@ -15,8 +15,9 @@ const ( ) // Values returns all known values for AssistantStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssistantStatus) Values() []AssistantStatus { return []AssistantStatus{ "CREATE_IN_PROGRESS", @@ -36,8 +37,9 @@ const ( ) // Values returns all known values for AssistantType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssistantType) Values() []AssistantType { return []AssistantType{ "AGENT", @@ -52,8 +54,9 @@ const ( ) // Values returns all known values for AssociationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationType) Values() []AssociationType { return []AssociationType{ "KNOWLEDGE_BASE", @@ -74,8 +77,9 @@ const ( ) // Values returns all known values for ContentStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentStatus) Values() []ContentStatus { return []ContentStatus{ "CREATE_IN_PROGRESS", @@ -96,8 +100,9 @@ const ( ) // Values returns all known values for ExternalSource. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ExternalSource) Values() []ExternalSource { return []ExternalSource{ "AMAZON_CONNECT", @@ -112,8 +117,9 @@ const ( ) // Values returns all known values for FilterField. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterField) Values() []FilterField { return []FilterField{ "NAME", @@ -128,8 +134,9 @@ const ( ) // Values returns all known values for FilterOperator. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FilterOperator) Values() []FilterOperator { return []FilterOperator{ "EQUALS", @@ -149,8 +156,9 @@ const ( ) // Values returns all known values for ImportJobStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportJobStatus) Values() []ImportJobStatus { return []ImportJobStatus{ "START_IN_PROGRESS", @@ -170,8 +178,9 @@ const ( ) // Values returns all known values for ImportJobType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ImportJobType) Values() []ImportJobType { return []ImportJobType{ "QUICK_RESPONSES", @@ -191,8 +200,9 @@ const ( ) // Values returns all known values for KnowledgeBaseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseStatus) Values() []KnowledgeBaseStatus { return []KnowledgeBaseStatus{ "CREATE_IN_PROGRESS", @@ -214,8 +224,9 @@ const ( ) // Values returns all known values for KnowledgeBaseType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (KnowledgeBaseType) Values() []KnowledgeBaseType { return []KnowledgeBaseType{ "EXTERNAL", @@ -233,8 +244,9 @@ const ( ) // 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. +// the future, and so 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{ "ASC", @@ -252,8 +264,9 @@ const ( ) // Values returns all known values for Priority. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Priority) Values() []Priority { return []Priority{ "HIGH", @@ -272,6 +285,7 @@ const ( // Values returns all known values for QuickResponseFilterOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (QuickResponseFilterOperator) Values() []QuickResponseFilterOperator { return []QuickResponseFilterOperator{ @@ -290,6 +304,7 @@ const ( // Values returns all known values for QuickResponseQueryOperator. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (QuickResponseQueryOperator) Values() []QuickResponseQueryOperator { return []QuickResponseQueryOperator{ @@ -313,8 +328,9 @@ const ( ) // Values returns all known values for QuickResponseStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (QuickResponseStatus) Values() []QuickResponseStatus { return []QuickResponseStatus{ "CREATE_IN_PROGRESS", @@ -339,6 +355,7 @@ const ( // 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{ @@ -357,6 +374,7 @@ const ( // Values returns all known values for RecommendationTriggerType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationTriggerType) Values() []RecommendationTriggerType { return []RecommendationTriggerType{ @@ -372,8 +390,9 @@ const ( ) // Values returns all known values for RecommendationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RecommendationType) Values() []RecommendationType { return []RecommendationType{ "KNOWLEDGE_CONTENT", @@ -390,8 +409,9 @@ const ( ) // Values returns all known values for RelevanceLevel. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RelevanceLevel) Values() []RelevanceLevel { return []RelevanceLevel{ "HIGH", diff --git a/service/wisdom/types/types.go b/service/wisdom/types/types.go index 8c41207e03d..1ad48d0ef8a 100644 --- a/service/wisdom/types/types.go +++ b/service/wisdom/types/types.go @@ -13,44 +13,57 @@ 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 , + // + // - For [Salesforce], 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 . - // - For Amazon S3 (https://aws.amazon.com/s3/) , the ObjectConfiguration and - // FileConfiguration of your AppIntegrations DataIntegration must be null. The - // SourceURI of your DataIntegration must use the following format: - // s3://your_s3_bucket_name . The bucket policy of the corresponding S3 bucket - // must allow the Amazon Web Services principal app-integrations.amazonaws.com to - // perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the - // bucket. + // + // - For [ServiceNow], 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], 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], your AppIntegrations DataIntegration must have a FileConfiguration, + // including only file extensions that are among docx , pdf , html , htm , and + // txt . + // + // - For [Amazon S3], the ObjectConfiguration and FileConfiguration of your AppIntegrations + // DataIntegration must be null. The SourceURI of your DataIntegration must use + // the following format: s3://your_s3_bucket_name . + // + // The bucket policy of the corresponding S3 bucket must allow the Amazon Web + // Services principal app-integrations.amazonaws.com to perform s3:ListBucket , + // s3:GetObject , and s3:GetBucketLocation against the bucket. + // + // [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api + // [Amazon S3]: https://aws.amazon.com/s3/ + // [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/ + // [SharePoint]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index + // [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm // // 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 , + // + // - For [Salesforce], 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 , + // + // - For [ServiceNow], 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 . + // + // - For [Zendesk], 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. + // + // [ServiceNow]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api + // [Zendesk]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/ + // [Salesforce]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm ObjectFields []string noSmithyDocumentSerde @@ -207,14 +220,16 @@ type AssistantData struct { IntegrationConfiguration *AssistantIntegrationConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the // key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow // kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the - // connect.amazonaws.com service principal. For more information about setting up a - // customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your - // instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . + // connect.amazonaws.com service principal. + // + // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. + // + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. @@ -268,14 +283,16 @@ type AssistantSummary struct { IntegrationConfiguration *AssistantIntegrationConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the // key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow // kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the - // connect.amazonaws.com service principal. For more information about setting up a - // customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your - // instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . + // connect.amazonaws.com service principal. + // + // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. + // + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // The tags used to organize, track, or control access for this resource. @@ -539,19 +556,24 @@ type Filter struct { // The configuration information of the grouping of Wisdom users. type GroupingConfiguration struct { - // The criteria used for grouping Wisdom users. The following is the list of - // supported criteria values. - // - RoutingProfileArn : Grouping the users by their Amazon Connect routing - // profile ARN (https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) - // . User should have SearchRoutingProfile (https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html) - // and DescribeRoutingProfile (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html) + // The criteria used for grouping Wisdom users. + // + // The following is the list of supported criteria values. + // + // - RoutingProfileArn : Grouping the users by their [Amazon Connect routing profile ARN]. User should have [SearchRoutingProfile]and [DescribeRoutingProfile] // permissions when setting criteria to this value. + // + // [Amazon Connect routing profile ARN]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html + // [SearchRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html + // [DescribeRoutingProfile]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html Criteria *string // The list of values that define different groups of Wisdom users. + // // - When setting criteria to RoutingProfileArn , you need to provide a list of - // ARNs of Amazon Connect routing profiles (https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) - // as values of this parameter. + // ARNs of [Amazon Connect routing profiles]as values of this parameter. + // + // [Amazon Connect routing profiles]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html Values []string noSmithyDocumentSerde @@ -609,8 +631,9 @@ type ImportJobData struct { // This member is required. Status ImportJobStatus - // 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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string @@ -677,8 +700,9 @@ type ImportJobSummary struct { // This member is required. Status ImportJobStatus - // 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]. + // + // [StartContentUpload]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html // // This member is required. UploadId *string @@ -746,11 +770,14 @@ type KnowledgeBaseData struct { RenderingConfiguration *RenderingConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the - // key to invoke Wisdom. For more information about setting up a customer managed - // key for Wisdom, see Enable Amazon Connect Wisdom for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . + // key to invoke Wisdom. + // + // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. + // + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // Source configuration information about the knowledge base. @@ -798,11 +825,14 @@ type KnowledgeBaseSummary struct { RenderingConfiguration *RenderingConfiguration // The configuration information for the customer managed key used for encryption. + // // This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , // kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to - // invoke Wisdom. For more information about setting up a customer managed key for - // Wisdom, see Enable Amazon Connect Wisdom for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . + // invoke Wisdom. + // + // For more information about setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. + // + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration // Configuration information about the external data source. @@ -869,8 +899,10 @@ type QuickResponseContents struct { type QuickResponseData struct { // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. // @@ -971,19 +1003,32 @@ type QuickResponseDataProviderMemberContent struct { func (*QuickResponseDataProviderMemberContent) isQuickResponseDataProvider() {} -// The quick response fields to filter the quick response query results by. The -// following is the list of supported field names. +// The quick response fields to filter the quick response query results by. +// +// The following is the list of supported field names. +// // - name +// // - description +// // - shortcutKey +// // - isActive +// // - channels +// // - language +// // - contentType +// // - createdTime +// // - lastModifiedTime +// // - lastModifiedBy +// // - groupingConfiguration.criteria +// // - groupingConfiguration.values type QuickResponseFilterField struct { @@ -1006,19 +1051,32 @@ type QuickResponseFilterField struct { noSmithyDocumentSerde } -// The quick response fields to order the quick response query results by. The -// following is the list of supported field names. +// The quick response fields to order the quick response query results by. +// +// The following is the list of supported field names. +// // - name +// // - description +// // - shortcutKey +// // - isActive +// // - channels +// // - language +// // - contentType +// // - createdTime +// // - lastModifiedTime +// // - lastModifiedBy +// // - groupingConfiguration.criteria +// // - groupingConfiguration.values type QuickResponseOrderField struct { @@ -1033,11 +1091,16 @@ type QuickResponseOrderField struct { noSmithyDocumentSerde } -// The quick response fields to query quick responses by. The following is the -// list of supported field names. +// The quick response fields to query quick responses by. +// +// The following is the list of supported field names. +// // - content +// // - name +// // - description +// // - shortcutKey type QuickResponseQueryField struct { @@ -1087,8 +1150,10 @@ type QuickResponseSearchExpression struct { type QuickResponseSearchResultData struct { // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. // @@ -1187,8 +1252,10 @@ type QuickResponseSearchResultData struct { type QuickResponseSummary struct { // The media type of the quick response content. + // // - Use application/x.quickresponse;format=plain for quick response written in // plain text. + // // - Use application/x.quickresponse;format=markdown for quick response written // in richtext. // @@ -1302,8 +1369,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. // @@ -1342,14 +1411,19 @@ 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) - // . + // calling [GetContent]. + // + // [GetContent]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html TemplateUri *string noSmithyDocumentSerde @@ -1389,10 +1463,11 @@ type SearchExpression struct { type ServerSideEncryptionConfiguration struct { // The customer managed key used for encryption. For more information about - // setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom - // for your instance (https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) - // . For information about valid ID values, see Key identifiers (KeyId) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) - // . + // setting up a customer managed key for Wisdom, see [Enable Amazon Connect Wisdom for your instance]. For information about valid + // ID values, see [Key identifiers (KeyId)]. + // + // [Key identifiers (KeyId)]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id + // [Enable Amazon Connect Wisdom for your instance]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html KmsKeyId *string noSmithyDocumentSerde diff --git a/service/workdocs/api_op_AbortDocumentVersionUpload.go b/service/workdocs/api_op_AbortDocumentVersionUpload.go index 277acdee3b2..a50120f99ef 100644 --- a/service/workdocs/api_op_AbortDocumentVersionUpload.go +++ b/service/workdocs/api_op_AbortDocumentVersionUpload.go @@ -11,9 +11,8 @@ import ( ) // Aborts the upload of the specified document version that was previously -// 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. +// 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) { if params == nil { params = &AbortDocumentVersionUploadInput{} diff --git a/service/workdocs/api_op_CreateNotificationSubscription.go b/service/workdocs/api_op_CreateNotificationSubscription.go index 25b8900eb24..c71972bdec1 100644 --- a/service/workdocs/api_op_CreateNotificationSubscription.go +++ b/service/workdocs/api_op_CreateNotificationSubscription.go @@ -12,9 +12,11 @@ import ( ) // 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. +// receives a confirmation message, and must confirm the subscription. +// +// For more information, see [Setting up notifications for an IAM user or role] in the Amazon WorkDocs Developer Guide. +// +// [Setting up notifications for an IAM user or role]: https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html func (c *Client) CreateNotificationSubscription(ctx context.Context, params *CreateNotificationSubscriptionInput, optFns ...func(*Options)) (*CreateNotificationSubscriptionOutput, error) { if params == nil { params = &CreateNotificationSubscriptionInput{} diff --git a/service/workdocs/api_op_DeleteUser.go b/service/workdocs/api_op_DeleteUser.go index d5c1b4914bb..c180153a97e 100644 --- a/service/workdocs/api_op_DeleteUser.go +++ b/service/workdocs/api_op_DeleteUser.go @@ -10,9 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified user from a Simple AD or Microsoft AD directory. Deleting -// a user immediately and permanently deletes all content in that user's folder -// structure. Site retention policies do NOT apply to this type of deletion. +// Deletes the specified user from a Simple AD or Microsoft AD directory. +// +// Deleting a user immediately and permanently deletes all content in that user's +// folder structure. Site retention policies do NOT apply to this type of deletion. func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error) { if params == nil { params = &DeleteUserInput{} diff --git a/service/workdocs/api_op_DescribeDocumentVersions.go b/service/workdocs/api_op_DescribeDocumentVersions.go index 9cd32ccdd13..2d54e7b4984 100644 --- a/service/workdocs/api_op_DescribeDocumentVersions.go +++ b/service/workdocs/api_op_DescribeDocumentVersions.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves the document versions for the specified document. By default, only -// active versions are returned. +// Retrieves the document versions for the specified document. +// +// By default, only active versions are returned. func (c *Client) DescribeDocumentVersions(ctx context.Context, params *DescribeDocumentVersionsInput, optFns ...func(*Options)) (*DescribeDocumentVersionsOutput, error) { if params == nil { params = &DescribeDocumentVersionsInput{} diff --git a/service/workdocs/api_op_DescribeFolderContents.go b/service/workdocs/api_op_DescribeFolderContents.go index 7c87ca5ed33..0d0e8136857 100644 --- a/service/workdocs/api_op_DescribeFolderContents.go +++ b/service/workdocs/api_op_DescribeFolderContents.go @@ -12,10 +12,12 @@ import ( ) // Describes the contents of the specified folder, including its documents and -// subfolders. By default, Amazon WorkDocs returns the first 100 active document -// and folder metadata items. If there are more results, the response includes a -// marker that you can use to request the next set of results. You can also request -// initialized documents. +// subfolders. +// +// By default, Amazon WorkDocs returns the first 100 active document and folder +// metadata items. If there are more results, the response includes a marker that +// you can use to request the next set of results. You can also request initialized +// documents. func (c *Client) DescribeFolderContents(ctx context.Context, params *DescribeFolderContentsInput, optFns ...func(*Options)) (*DescribeFolderContentsOutput, error) { if params == nil { params = &DescribeFolderContentsInput{} diff --git a/service/workdocs/api_op_DescribeRootFolders.go b/service/workdocs/api_op_DescribeRootFolders.go index 21b4226471b..87b69065335 100644 --- a/service/workdocs/api_op_DescribeRootFolders.go +++ b/service/workdocs/api_op_DescribeRootFolders.go @@ -14,10 +14,13 @@ import ( // 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) -// in the Amazon WorkDocs Developer Guide. +// 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]in the +// Amazon WorkDocs Developer Guide. +// +// [Authentication and Access Control for User Applications]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html func (c *Client) DescribeRootFolders(ctx context.Context, params *DescribeRootFoldersInput, optFns ...func(*Options)) (*DescribeRootFoldersOutput, error) { if params == nil { params = &DescribeRootFoldersInput{} diff --git a/service/workdocs/api_op_DescribeUsers.go b/service/workdocs/api_op_DescribeUsers.go index 15627911cf1..b5589f61a97 100644 --- a/service/workdocs/api_op_DescribeUsers.go +++ b/service/workdocs/api_op_DescribeUsers.go @@ -12,9 +12,11 @@ import ( ) // Describes the specified users. You can describe all users or filter the results -// (for example, by status or organization). By default, Amazon WorkDocs returns -// the first 24 active or pending users. If there are more results, the response -// includes a marker that you can use to request the next set of results. +// (for example, by status or organization). +// +// By default, Amazon WorkDocs returns the first 24 active or pending users. If +// there are more results, the response includes a marker that you can use to +// request the next set of results. func (c *Client) DescribeUsers(ctx context.Context, params *DescribeUsersInput, optFns ...func(*Options)) (*DescribeUsersOutput, error) { if params == nil { params = &DescribeUsersInput{} @@ -58,17 +60,22 @@ 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. + // SurName , or UserName fields included in a [CreateUser]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. + // + // [CreateUser]: https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html Query *string // The sorting criteria. diff --git a/service/workdocs/api_op_GetCurrentUser.go b/service/workdocs/api_op_GetCurrentUser.go index 5a8ce850460..52ec841cac8 100644 --- a/service/workdocs/api_op_GetCurrentUser.go +++ b/service/workdocs/api_op_GetCurrentUser.go @@ -13,10 +13,12 @@ import ( // Retrieves details of the current user for whom the authentication token was // 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) -// in the Amazon WorkDocs Developer Guide. +// register an application with Amazon WorkDocs. For more information, see [Authentication and Access Control for User Applications]in the +// Amazon WorkDocs Developer Guide. +// +// [Authentication and Access Control for User Applications]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html func (c *Client) GetCurrentUser(ctx context.Context, params *GetCurrentUserInput, optFns ...func(*Options)) (*GetCurrentUserOutput, error) { if params == nil { params = &GetCurrentUserInput{} diff --git a/service/workdocs/api_op_GetDocumentPath.go b/service/workdocs/api_op_GetDocumentPath.go index ef9422296c1..03ca253874d 100644 --- a/service/workdocs/api_op_GetDocumentPath.go +++ b/service/workdocs/api_op_GetDocumentPath.go @@ -12,10 +12,12 @@ import ( ) // Retrieves the path information (the hierarchy from the root folder) for the -// requested document. By default, Amazon WorkDocs returns a maximum of 100 levels -// upwards from the requested document and only includes the IDs of the parent -// folders in the path. You can limit the maximum number of levels. You can also -// request the names of the parent folders. +// requested document. +// +// By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the +// requested document and only includes the IDs of the parent folders in the path. +// You can limit the maximum number of levels. You can also request the names of +// the parent folders. func (c *Client) GetDocumentPath(ctx context.Context, params *GetDocumentPathInput, optFns ...func(*Options)) (*GetDocumentPathOutput, error) { if params == nil { params = &GetDocumentPathInput{} diff --git a/service/workdocs/api_op_GetFolderPath.go b/service/workdocs/api_op_GetFolderPath.go index 4df6917f8bc..b80592aa4ba 100644 --- a/service/workdocs/api_op_GetFolderPath.go +++ b/service/workdocs/api_op_GetFolderPath.go @@ -12,10 +12,12 @@ import ( ) // Retrieves the path information (the hierarchy from the root folder) for the -// specified folder. By default, Amazon WorkDocs returns a maximum of 100 levels -// upwards from the requested folder and only includes the IDs of the parent -// folders in the path. You can limit the maximum number of levels. You can also -// request the parent folder names. +// specified folder. +// +// By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the +// requested folder and only includes the IDs of the parent folders in the path. +// You can limit the maximum number of levels. You can also request the parent +// folder names. func (c *Client) GetFolderPath(ctx context.Context, params *GetFolderPathInput, optFns ...func(*Options)) (*GetFolderPathOutput, error) { if params == nil { params = &GetFolderPathInput{} diff --git a/service/workdocs/api_op_InitiateDocumentVersionUpload.go b/service/workdocs/api_op_InitiateDocumentVersionUpload.go index ceb5a4931c8..a14e5940800 100644 --- a/service/workdocs/api_op_InitiateDocumentVersionUpload.go +++ b/service/workdocs/api_op_InitiateDocumentVersionUpload.go @@ -12,12 +12,14 @@ import ( "time" ) -// Creates a new document object and version object. The client specifies the -// 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 . +// Creates a new document object and version object. +// +// The client specifies the 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. 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_UpdateDocumentVersion.go b/service/workdocs/api_op_UpdateDocumentVersion.go index f4e62f8e633..a4868d54cf9 100644 --- a/service/workdocs/api_op_UpdateDocumentVersion.go +++ b/service/workdocs/api_op_UpdateDocumentVersion.go @@ -11,10 +11,11 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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. 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 75a2ab75d9e..94dccd959c5 100644 --- a/service/workdocs/doc.go +++ b/service/workdocs/doc.go @@ -4,17 +4,20 @@ // 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 @@ -29,13 +32,20 @@ // 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: +// 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/) -// . +// For information about Amazon WorkDocs API pricing, see [Amazon WorkDocs Pricing]. +// +// [Amazon WorkDocs Pricing]: https://aws.amazon.com/workdocs/pricing/ package workdocs diff --git a/service/workdocs/options.go b/service/workdocs/options.go index df4739d4291..64d287746be 100644 --- a/service/workdocs/options.go +++ b/service/workdocs/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/workdocs/types/enums.go b/service/workdocs/types/enums.go index da6e960ed2f..0a8906be36f 100644 --- a/service/workdocs/types/enums.go +++ b/service/workdocs/types/enums.go @@ -42,8 +42,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -91,6 +92,7 @@ const ( // Values returns all known values for AdditionalResponseFieldType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AdditionalResponseFieldType) Values() []AdditionalResponseFieldType { return []AdditionalResponseFieldType{ @@ -107,8 +109,9 @@ const ( ) // Values returns all known values for BooleanEnumType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BooleanEnumType) Values() []BooleanEnumType { return []BooleanEnumType{ "TRUE", @@ -126,8 +129,9 @@ const ( ) // Values returns all known values for CommentStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CommentStatusType) Values() []CommentStatusType { return []CommentStatusType{ "DRAFT", @@ -145,8 +149,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "PUBLIC", @@ -170,8 +175,9 @@ const ( ) // Values returns all known values for ContentCategoryType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ContentCategoryType) Values() []ContentCategoryType { return []ContentCategoryType{ "IMAGE", @@ -195,8 +201,9 @@ const ( ) // Values returns all known values for DocumentSourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentSourceType) Values() []DocumentSourceType { return []DocumentSourceType{ "ORIGINAL", @@ -213,8 +220,9 @@ const ( ) // Values returns all known values for DocumentStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DocumentStatusType) Values() []DocumentStatusType { return []DocumentStatusType{ "INITIALIZED", @@ -232,8 +240,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SMALL", @@ -250,8 +259,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "ACTIVE", @@ -268,8 +278,9 @@ const ( ) // Values returns all known values for FolderContentType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FolderContentType) Values() []FolderContentType { return []FolderContentType{ "ALL", @@ -316,8 +327,9 @@ const ( ) // Values returns all known values for LanguageCodeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LanguageCodeType) Values() []LanguageCodeType { return []LanguageCodeType{ "AR", @@ -372,8 +384,9 @@ const ( ) // Values returns all known values for LocaleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LocaleType) Values() []LocaleType { return []LocaleType{ "en", @@ -402,8 +415,9 @@ const ( ) // Values returns all known values for OrderByFieldType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OrderByFieldType) Values() []OrderByFieldType { return []OrderByFieldType{ "RELEVANCE", @@ -423,8 +437,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -443,8 +458,9 @@ const ( ) // Values returns all known values for PrincipalRoleType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalRoleType) Values() []PrincipalRoleType { return []PrincipalRoleType{ "VIEWER", @@ -466,8 +482,9 @@ const ( ) // Values returns all known values for PrincipalType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PrincipalType) Values() []PrincipalType { return []PrincipalType{ "USER", @@ -486,8 +503,9 @@ const ( ) // Values returns all known values for ResourceCollectionType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceCollectionType) Values() []ResourceCollectionType { return []ResourceCollectionType{ "SHARED_WITH_ME", @@ -503,8 +521,9 @@ const ( ) // Values returns all known values for ResourceSortType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceSortType) Values() []ResourceSortType { return []ResourceSortType{ "DATE", @@ -523,8 +542,9 @@ const ( ) // Values returns all known values for ResourceStateType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResourceStateType) Values() []ResourceStateType { return []ResourceStateType{ "ACTIVE", @@ -543,8 +563,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -563,8 +584,9 @@ const ( ) // Values returns all known values for ResponseItemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ResponseItemType) Values() []ResponseItemType { return []ResponseItemType{ "DOCUMENT", @@ -583,8 +605,9 @@ const ( ) // Values returns all known values for RolePermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RolePermissionType) Values() []RolePermissionType { return []RolePermissionType{ "DIRECT", @@ -603,8 +626,9 @@ const ( ) // Values returns all known values for RoleType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RoleType) Values() []RoleType { return []RoleType{ "VIEWER", @@ -623,8 +647,9 @@ const ( ) // Values returns all known values for SearchCollectionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchCollectionType) Values() []SearchCollectionType { return []SearchCollectionType{ "OWNED", @@ -641,8 +666,9 @@ const ( ) // Values returns all known values for SearchQueryScopeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchQueryScopeType) Values() []SearchQueryScopeType { return []SearchQueryScopeType{ "NAME", @@ -661,8 +687,9 @@ const ( ) // Values returns all known values for SearchResourceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SearchResourceType) Values() []SearchResourceType { return []SearchResourceType{ "FOLDER", @@ -681,8 +708,9 @@ const ( ) // Values returns all known values for ShareStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ShareStatusType) Values() []ShareStatusType { return []ShareStatusType{ "SUCCESS", @@ -699,8 +727,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -717,8 +746,9 @@ const ( ) // Values returns all known values for StorageType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StorageType) Values() []StorageType { return []StorageType{ "UNLIMITED", @@ -736,6 +766,7 @@ const ( // 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{ @@ -752,8 +783,9 @@ const ( ) // Values returns all known values for SubscriptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SubscriptionType) Values() []SubscriptionType { return []SubscriptionType{ "ALL", @@ -769,8 +801,9 @@ const ( ) // Values returns all known values for UserFilterType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserFilterType) Values() []UserFilterType { return []UserFilterType{ "ALL", @@ -790,8 +823,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -812,8 +846,9 @@ const ( ) // Values returns all known values for UserStatusType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserStatusType) Values() []UserStatusType { return []UserStatusType{ "ACTIVE", @@ -834,8 +869,9 @@ const ( ) // Values returns all known values for UserType. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserType) Values() []UserType { return []UserType{ "USER", diff --git a/service/worklink/api_op_CreateFleet.go b/service/worklink/api_op_CreateFleet.go index c64c650be14..c3b5080bf8b 100644 --- a/service/worklink/api_op_CreateFleet.go +++ b/service/worklink/api_op_CreateFleet.go @@ -45,7 +45,7 @@ type CreateFleetInput struct { // closest AWS Region to users, which may be outside of your home Region. OptimizeForEndUserLocation *bool - // The tags to add to the resource. A tag is a key-value pair. + // The tags to add to the resource. A tag is a key-value pair. Tags map[string]string noSmithyDocumentSerde diff --git a/service/worklink/options.go b/service/worklink/options.go index 56b4993937b..7f8585c82c9 100644 --- a/service/worklink/options.go +++ b/service/worklink/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/worklink/types/enums.go b/service/worklink/types/enums.go index 82eb133259a..61a4d1b6ebc 100644 --- a/service/worklink/types/enums.go +++ b/service/worklink/types/enums.go @@ -11,6 +11,7 @@ const ( // Values returns all known values for AuthorizationProviderType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (AuthorizationProviderType) Values() []AuthorizationProviderType { return []AuthorizationProviderType{ @@ -27,8 +28,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -51,8 +53,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -79,8 +82,9 @@ const ( ) // Values returns all known values for FleetStatus. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FleetStatus) Values() []FleetStatus { return []FleetStatus{ "CREATING", @@ -100,8 +104,9 @@ const ( ) // Values returns all known values for IdentityProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentityProviderType) Values() []IdentityProviderType { return []IdentityProviderType{ "SAML", diff --git a/service/workmail/api_op_AssociateDelegateToResource.go b/service/workmail/api_op_AssociateDelegateToResource.go index 2ebe37993ab..a9d9950952a 100644 --- a/service/workmail/api_op_AssociateDelegateToResource.go +++ b/service/workmail/api_op_AssociateDelegateToResource.go @@ -28,11 +28,15 @@ func (c *Client) AssociateDelegateToResource(ctx context.Context, params *Associ type AssociateDelegateToResourceInput struct { - // The member (user or group) to associate to the resource. The entity ID can - // accept UserId or GroupID, Username or Groupname, or email. + // The member (user or group) to associate to the resource. + // + // The entity ID can accept UserId or GroupID, Username or Groupname, or email. + // // - Entity: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity: entity // // This member is required. @@ -43,11 +47,15 @@ type AssociateDelegateToResourceInput struct { // This member is required. OrganizationId *string - // The resource for which members (users or groups) are associated. The identifier - // can accept ResourceId, Resourcename, or email. The following identity formats - // are available: + // The resource for which members (users or groups) are associated. + // + // The identifier can accept ResourceId, Resourcename, or email. The following + // identity formats are available: + // // - Resource ID: r-0123456789a0123456789b0123456789 + // // - Email address: resource@domain.tld + // // - Resource name: resource // // This member is required. diff --git a/service/workmail/api_op_AssociateMemberToGroup.go b/service/workmail/api_op_AssociateMemberToGroup.go index 8d2ddc3e842..d6832dbddc2 100644 --- a/service/workmail/api_op_AssociateMemberToGroup.go +++ b/service/workmail/api_op_AssociateMemberToGroup.go @@ -28,22 +28,30 @@ func (c *Client) AssociateMemberToGroup(ctx context.Context, params *AssociateMe type AssociateMemberToGroupInput struct { - // The group to which the member (user or group) is associated. The identifier can - // accept GroupId, Groupname, or email. The following identity formats are - // available: + // The group to which the member (user or group) is associated. + // + // The identifier can accept GroupId, Groupname, or email. The following identity + // formats are available: + // // - Group ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: group@domain.tld + // // - Group name: group // // This member is required. GroupId *string - // The member (user or group) to associate to the group. The member ID can accept - // UserID or GroupId, Username or Groupname, or email. + // The member (user or group) to associate to the group. + // + // The member ID can accept UserID or GroupId, Username or Groupname, or email. + // // - Member: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: member@domain.tld + // // - Member name: member // // This member is required. diff --git a/service/workmail/api_op_CancelMailboxExportJob.go b/service/workmail/api_op_CancelMailboxExportJob.go index 0616a531c59..29a8ee0b071 100644 --- a/service/workmail/api_op_CancelMailboxExportJob.go +++ b/service/workmail/api_op_CancelMailboxExportJob.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Cancels a mailbox export job. If the mailbox export job is near completion, it -// might not be possible to cancel it. +// Cancels a mailbox export job. +// +// If the mailbox export job is near completion, it might not be possible to +// cancel it. func (c *Client) CancelMailboxExportJob(ctx context.Context, params *CancelMailboxExportJobInput, optFns ...func(*Options)) (*CancelMailboxExportJobOutput, error) { if params == nil { params = &CancelMailboxExportJobInput{} diff --git a/service/workmail/api_op_CreateGroup.go b/service/workmail/api_op_CreateGroup.go index 8753f6c7f4f..4190b9c853d 100644 --- a/service/workmail/api_op_CreateGroup.go +++ b/service/workmail/api_op_CreateGroup.go @@ -10,8 +10,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a group that can be used in WorkMail by calling the RegisterToWorkMail -// operation. +// Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation. func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error) { if params == nil { params = &CreateGroupInput{} diff --git a/service/workmail/api_op_CreateImpersonationRole.go b/service/workmail/api_op_CreateImpersonationRole.go index be0ecc5afcc..173e4e7ab4a 100644 --- a/service/workmail/api_op_CreateImpersonationRole.go +++ b/service/workmail/api_op_CreateImpersonationRole.go @@ -11,10 +11,12 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates an impersonation role for the given WorkMail organization. Idempotency -// ensures that an API request completes no more than one time. With an idempotent -// request, if the original request completes successfully, any subsequent retries -// also complete successfully without performing any further actions. +// Creates an impersonation role for the given WorkMail organization. +// +// Idempotency ensures that an API request completes no more than one time. With +// an idempotent request, if the original request completes successfully, any +// subsequent retries also complete successfully without performing any further +// actions. func (c *Client) CreateImpersonationRole(ctx context.Context, params *CreateImpersonationRoleInput, optFns ...func(*Options)) (*CreateImpersonationRoleOutput, error) { if params == nil { params = &CreateImpersonationRoleInput{} diff --git a/service/workmail/api_op_CreateOrganization.go b/service/workmail/api_op_CreateOrganization.go index 71f5a958134..ac78e22537b 100644 --- a/service/workmail/api_op_CreateOrganization.go +++ b/service/workmail/api_op_CreateOrganization.go @@ -16,16 +16,20 @@ 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) -// 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 -// organization. If you don't associate an AWS KMS key, WorkMail creates a default, -// AWS managed key for you. +// information, see [Adding an organization]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]and [Choosing the default domain] 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. +// +// [Adding an organization]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html +// [Adding a domain]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html +// [Choosing the default domain]: https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html func (c *Client) CreateOrganization(ctx context.Context, params *CreateOrganizationInput, optFns ...func(*Options)) (*CreateOrganizationOutput, error) { if params == nil { params = &CreateOrganizationInput{} diff --git a/service/workmail/api_op_CreateUser.go b/service/workmail/api_op_CreateUser.go index d197a41778a..80c2d0b2f72 100644 --- a/service/workmail/api_op_CreateUser.go +++ b/service/workmail/api_op_CreateUser.go @@ -11,8 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates a user who can be used in WorkMail by calling the RegisterToWorkMail -// operation. +// Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation. func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error) { if params == nil { params = &CreateUserInput{} @@ -58,9 +57,10 @@ type CreateUserInput struct { // The password for the new user. Password *string - // The role of the new user. You cannot pass SYSTEM_USER or RESOURCE role in a - // single request. When a user role is not selected, the default role of USER is - // selected. + // The role of the new user. + // + // You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user + // role is not selected, the default role of USER is selected. Role types.UserRole noSmithyDocumentSerde diff --git a/service/workmail/api_op_DeleteAccessControlRule.go b/service/workmail/api_op_DeleteAccessControlRule.go index 06ebdf7f4c2..525f1610c94 100644 --- a/service/workmail/api_op_DeleteAccessControlRule.go +++ b/service/workmail/api_op_DeleteAccessControlRule.go @@ -11,6 +11,7 @@ import ( ) // 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. diff --git a/service/workmail/api_op_DeleteGroup.go b/service/workmail/api_op_DeleteGroup.go index 395018cf36c..bf400c3a8f8 100644 --- a/service/workmail/api_op_DeleteGroup.go +++ b/service/workmail/api_op_DeleteGroup.go @@ -28,10 +28,14 @@ func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optF type DeleteGroupInput struct { - // The identifier of the group to be deleted. The identifier can be the GroupId, - // or Groupname. The following identity formats are available: + // The identifier of the group to be deleted. + // + // The identifier can be the GroupId, or Groupname. The following identity formats + // are available: + // // - Group ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Group name: group // // This member is required. diff --git a/service/workmail/api_op_DeleteMailboxPermissions.go b/service/workmail/api_op_DeleteMailboxPermissions.go index 7a68eb5df09..c84aa57354b 100644 --- a/service/workmail/api_op_DeleteMailboxPermissions.go +++ b/service/workmail/api_op_DeleteMailboxPermissions.go @@ -28,24 +28,32 @@ func (c *Client) DeleteMailboxPermissions(ctx context.Context, params *DeleteMai type DeleteMailboxPermissionsInput struct { - // The identifier of the entity that owns the mailbox. The identifier can be - // UserId or Group Id, Username or Groupname, or email. + // The identifier of the entity that owns the mailbox. + // + // The identifier can be UserId or Group Id, Username or Groupname, or email. + // // - Entity ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. EntityId *string - // The identifier of the entity for which to delete granted permissions. The - // identifier can be UserId, ResourceID, or Group Id, Username or Groupname, or - // email. + // The identifier of the entity for which to delete granted permissions. + // + // The identifier can be UserId, ResourceID, or Group Id, Username or Groupname, + // or email. + // // - Grantee ID: // 12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: grantee@domain.tld + // // - Grantee name: grantee // // This member is required. diff --git a/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go b/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go index dea979d680b..f33f5a5c5c4 100644 --- a/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go +++ b/service/workmail/api_op_DeleteMobileDeviceAccessOverride.go @@ -11,9 +11,11 @@ import ( ) // Deletes the mobile device access override for the given WorkMail organization, -// user, and device. Deleting already deleted and non-existing overrides does not -// produce an error. In those cases, the service sends back an HTTP 200 response -// with an empty HTTP body. +// user, and device. +// +// Deleting already deleted and non-existing overrides does not produce an error. +// In those cases, the service sends back an HTTP 200 response with an empty HTTP +// body. func (c *Client) DeleteMobileDeviceAccessOverride(ctx context.Context, params *DeleteMobileDeviceAccessOverrideInput, optFns ...func(*Options)) (*DeleteMobileDeviceAccessOverrideOutput, error) { if params == nil { params = &DeleteMobileDeviceAccessOverrideInput{} @@ -44,9 +46,12 @@ 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 // // This member is required. diff --git a/service/workmail/api_op_DeleteMobileDeviceAccessRule.go b/service/workmail/api_op_DeleteMobileDeviceAccessRule.go index dabae6f25ee..c7b5fe53803 100644 --- a/service/workmail/api_op_DeleteMobileDeviceAccessRule.go +++ b/service/workmail/api_op_DeleteMobileDeviceAccessRule.go @@ -11,6 +11,7 @@ import ( ) // Deletes a mobile device access 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. diff --git a/service/workmail/api_op_DeleteOrganization.go b/service/workmail/api_op_DeleteOrganization.go index abb07ac23e7..78d816aad9f 100644 --- a/service/workmail/api_op_DeleteOrganization.go +++ b/service/workmail/api_op_DeleteOrganization.go @@ -12,8 +12,10 @@ 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) -// in the WorkMail Administrator Guide. +// associated directory. For more information, see [Removing an organization]in the WorkMail Administrator +// Guide. +// +// [Removing an organization]: https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html func (c *Client) DeleteOrganization(ctx context.Context, params *DeleteOrganizationInput, optFns ...func(*Options)) (*DeleteOrganizationOutput, error) { if params == nil { params = &DeleteOrganizationInput{} diff --git a/service/workmail/api_op_DeleteResource.go b/service/workmail/api_op_DeleteResource.go index 41b8c630b96..05b97a20ca4 100644 --- a/service/workmail/api_op_DeleteResource.go +++ b/service/workmail/api_op_DeleteResource.go @@ -34,9 +34,13 @@ type DeleteResourceInput struct { // This member is required. OrganizationId *string - // The identifier of the resource to be deleted. The identifier can accept - // ResourceId, or Resourcename. The following identity formats are available: + // The identifier of the resource to be deleted. + // + // The identifier can accept ResourceId, or Resourcename. The following identity + // formats are available: + // // - Resource ID: r-0123456789a0123456789b0123456789 + // // - Resource name: resource // // This member is required. diff --git a/service/workmail/api_op_DeleteUser.go b/service/workmail/api_op_DeleteUser.go index 043d93c0825..b8de202d337 100644 --- a/service/workmail/api_op_DeleteUser.go +++ b/service/workmail/api_op_DeleteUser.go @@ -11,10 +11,11 @@ import ( ) // 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. +// 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{} @@ -37,10 +38,14 @@ type DeleteUserInput struct { // This member is required. OrganizationId *string - // The identifier of the user to be deleted. The identifier can be the UserId or - // Username. The following identity formats are available: + // The identifier of the user to be deleted. + // + // The identifier can be the UserId or Username. The following identity formats + // are available: + // // - User ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - User name: user // // This member is required. diff --git a/service/workmail/api_op_DeregisterFromWorkMail.go b/service/workmail/api_op_DeregisterFromWorkMail.go index d9c5dd2e616..41c5724f18d 100644 --- a/service/workmail/api_op_DeregisterFromWorkMail.go +++ b/service/workmail/api_op_DeregisterFromWorkMail.go @@ -31,12 +31,17 @@ func (c *Client) DeregisterFromWorkMail(ctx context.Context, params *DeregisterF type DeregisterFromWorkMailInput struct { - // The identifier for the member to be updated. The identifier can be UserId, - // ResourceId, or Group Id, Username, Resourcename, or Groupname, or email. + // The identifier for the member to be updated. + // + // The identifier can be UserId, ResourceId, or Group Id, Username, Resourcename, + // or Groupname, or email. + // // - Entity ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. diff --git a/service/workmail/api_op_DescribeGroup.go b/service/workmail/api_op_DescribeGroup.go index 0eb23f1ed8c..7b688b99149 100644 --- a/service/workmail/api_op_DescribeGroup.go +++ b/service/workmail/api_op_DescribeGroup.go @@ -30,11 +30,16 @@ func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, type DescribeGroupInput struct { - // The identifier for the group to be described. The identifier can accept - // GroupId, Groupname, or email. The following identity formats are available: + // The identifier for the group to be described. + // + // The identifier can accept GroupId, Groupname, or email. The following identity + // formats are available: + // // - Group ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: group@domain.tld + // // - Group name: group // // This member is required. diff --git a/service/workmail/api_op_DescribeResource.go b/service/workmail/api_op_DescribeResource.go index 1edeaa2291b..2b0f3553bdd 100644 --- a/service/workmail/api_op_DescribeResource.go +++ b/service/workmail/api_op_DescribeResource.go @@ -36,11 +36,15 @@ type DescribeResourceInput struct { // This member is required. OrganizationId *string - // The identifier of the resource to be described. The identifier can accept - // ResourceId, Resourcename, or email. The following identity formats are - // available: + // The identifier of the resource to be described. + // + // The identifier can accept ResourceId, Resourcename, or email. The following + // identity formats are available: + // // - Resource ID: r-0123456789a0123456789b0123456789 + // // - Email address: resource@domain.tld + // // - Resource name: resource // // This member is required. diff --git a/service/workmail/api_op_DescribeUser.go b/service/workmail/api_op_DescribeUser.go index 5a3014927d1..c1c7c1721e6 100644 --- a/service/workmail/api_op_DescribeUser.go +++ b/service/workmail/api_op_DescribeUser.go @@ -35,11 +35,16 @@ type DescribeUserInput struct { // This member is required. OrganizationId *string - // The identifier for the user to be described. The identifier can be the UserId, - // Username, or email. The following identity formats are available: + // The identifier for the user to be described. + // + // The identifier can be the UserId, Username, or email. 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 // // This member is required. diff --git a/service/workmail/api_op_DisassociateDelegateFromResource.go b/service/workmail/api_op_DisassociateDelegateFromResource.go index e8fd50af19a..c758ebd051e 100644 --- a/service/workmail/api_op_DisassociateDelegateFromResource.go +++ b/service/workmail/api_op_DisassociateDelegateFromResource.go @@ -29,11 +29,15 @@ func (c *Client) DisassociateDelegateFromResource(ctx context.Context, params *D type DisassociateDelegateFromResourceInput struct { // The identifier for the member (user, group) to be removed from the resource's - // delegates. The entity ID can accept UserId or GroupID, Username or Groupname, or - // email. + // delegates. + // + // The entity ID can accept UserId or GroupID, Username or Groupname, or email. + // // - Entity: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity: entity // // This member is required. @@ -45,10 +49,14 @@ type DisassociateDelegateFromResourceInput struct { OrganizationId *string // The identifier of the resource from which delegates' set members are removed. + // // The identifier can accept ResourceId, Resourcename, or email. The following // identity formats are available: + // // - Resource ID: r-0123456789a0123456789b0123456789 + // // - Email address: resource@domain.tld + // // - Resource name: resource // // This member is required. diff --git a/service/workmail/api_op_DisassociateMemberFromGroup.go b/service/workmail/api_op_DisassociateMemberFromGroup.go index ea9b3ca4fba..5312b95662a 100644 --- a/service/workmail/api_op_DisassociateMemberFromGroup.go +++ b/service/workmail/api_op_DisassociateMemberFromGroup.go @@ -28,22 +28,30 @@ func (c *Client) DisassociateMemberFromGroup(ctx context.Context, params *Disass type DisassociateMemberFromGroupInput struct { - // The identifier for the group from which members are removed. The identifier can - // accept GroupId, Groupname, or email. The following identity formats are - // available: + // The identifier for the group from which members are removed. + // + // The identifier can accept GroupId, Groupname, or email. The following identity + // formats are available: + // // - Group ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: group@domain.tld + // // - Group name: group // // This member is required. GroupId *string - // The identifier for the member to be removed from the group. The member ID can - // accept UserID or GroupId, Username or Groupname, or email. + // The identifier for the member to be removed from the group. + // + // The member ID can accept UserID or GroupId, Username or Groupname, or email. + // // - Member ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: member@domain.tld + // // - Member name: member // // This member is required. diff --git a/service/workmail/api_op_GetImpersonationRoleEffect.go b/service/workmail/api_op_GetImpersonationRoleEffect.go index 5c7c1a0b2c8..70f98123f0f 100644 --- a/service/workmail/api_op_GetImpersonationRoleEffect.go +++ b/service/workmail/api_op_GetImpersonationRoleEffect.go @@ -41,9 +41,12 @@ 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 // // This member is required. diff --git a/service/workmail/api_op_GetMailDomain.go b/service/workmail/api_op_GetMailDomain.go index 74815a8bc52..cbc44e48fe2 100644 --- a/service/workmail/api_op_GetMailDomain.go +++ b/service/workmail/api_op_GetMailDomain.go @@ -55,7 +55,7 @@ type GetMailDomainOutput struct { // domain. IsTestDomain bool - // Indicates the status of the domain ownership verification. + // Indicates the status of the domain ownership verification. OwnershipVerificationStatus types.DnsRecordVerificationStatus // A list of the DNS records that WorkMail recommends adding in your DNS provider diff --git a/service/workmail/api_op_GetMailboxDetails.go b/service/workmail/api_op_GetMailboxDetails.go index 8736c3a6415..cc3d7d21907 100644 --- a/service/workmail/api_op_GetMailboxDetails.go +++ b/service/workmail/api_op_GetMailboxDetails.go @@ -34,12 +34,16 @@ type GetMailboxDetailsInput struct { // This member is required. OrganizationId *string - // The identifier for the user whose mailbox details are being requested. The - // identifier can be the UserId, Username, or email. The following identity formats - // are available: + // The identifier for the user whose mailbox details are being requested. + // + // The identifier can be the UserId, Username, or email. 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 // // This member is required. diff --git a/service/workmail/api_op_GetMobileDeviceAccessOverride.go b/service/workmail/api_op_GetMobileDeviceAccessOverride.go index 8fa589c9b4e..d6404975777 100644 --- a/service/workmail/api_op_GetMobileDeviceAccessOverride.go +++ b/service/workmail/api_op_GetMobileDeviceAccessOverride.go @@ -43,9 +43,12 @@ 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 // // This member is required. diff --git a/service/workmail/api_op_ListGroupMembers.go b/service/workmail/api_op_ListGroupMembers.go index 2f61646bd7c..cd2737fba4a 100644 --- a/service/workmail/api_op_ListGroupMembers.go +++ b/service/workmail/api_op_ListGroupMembers.go @@ -31,11 +31,16 @@ func (c *Client) ListGroupMembers(ctx context.Context, params *ListGroupMembersI type ListGroupMembersInput struct { // The identifier for the group to which the members (users or groups) are - // associated. The identifier can accept GroupId, Groupname, or email. The - // following identity formats are available: + // associated. + // + // The identifier can accept GroupId, Groupname, or email. The following identity + // formats are available: + // // - Group ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: group@domain.tld + // // - Group name: group // // This member is required. @@ -49,7 +54,7 @@ type ListGroupMembersInput struct { // The maximum number of results to return in a single call. MaxResults *int32 - // The token to use to retrieve the next page of results. The first call does not + // The token to use to retrieve the next page of results. The first call does not // contain any tokens. NextToken *string diff --git a/service/workmail/api_op_ListGroupsForEntity.go b/service/workmail/api_op_ListGroupsForEntity.go index d9fce30eff8..ec0f3034ed4 100644 --- a/service/workmail/api_op_ListGroupsForEntity.go +++ b/service/workmail/api_op_ListGroupsForEntity.go @@ -29,11 +29,15 @@ func (c *Client) ListGroupsForEntity(ctx context.Context, params *ListGroupsForE type ListGroupsForEntityInput struct { - // The identifier for the entity. The entity ID can accept UserId or GroupID, - // Username or Groupname, or email. + // The identifier for the entity. + // + // The entity ID can accept UserId or GroupID, Username or Groupname, or email. + // // - Entity ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. diff --git a/service/workmail/api_op_ListMailboxPermissions.go b/service/workmail/api_op_ListMailboxPermissions.go index a93fe5bc834..40de1465823 100644 --- a/service/workmail/api_op_ListMailboxPermissions.go +++ b/service/workmail/api_op_ListMailboxPermissions.go @@ -31,11 +31,15 @@ func (c *Client) ListMailboxPermissions(ctx context.Context, params *ListMailbox type ListMailboxPermissionsInput struct { // The identifier of the user, or resource for which to list mailbox permissions. + // // The entity ID can accept UserId or ResourceId, Username or Resourcename, or // email. + // // - Entity ID: 12345678-1234-1234-1234-123456789012, or // r-0123456789a0123456789b0123456789 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. diff --git a/service/workmail/api_op_ListMobileDeviceAccessOverrides.go b/service/workmail/api_op_ListMobileDeviceAccessOverrides.go index a5a1ec4ce43..3010eec825c 100644 --- a/service/workmail/api_op_ListMobileDeviceAccessOverrides.go +++ b/service/workmail/api_op_ListMobileDeviceAccessOverrides.go @@ -47,9 +47,12 @@ 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 UserId *string diff --git a/service/workmail/api_op_ListResourceDelegates.go b/service/workmail/api_op_ListResourceDelegates.go index c821a3c6ed1..e66ffbf2985 100644 --- a/service/workmail/api_op_ListResourceDelegates.go +++ b/service/workmail/api_op_ListResourceDelegates.go @@ -36,11 +36,15 @@ type ListResourceDelegatesInput struct { // This member is required. OrganizationId *string - // The identifier for the resource whose delegates are listed. The identifier can - // accept ResourceId, Resourcename, or email. The following identity formats are - // available: + // The identifier for the resource whose delegates are listed. + // + // The identifier can accept ResourceId, Resourcename, or email. The following + // identity formats are available: + // // - Resource ID: r-0123456789a0123456789b0123456789 + // // - Email address: resource@domain.tld + // // - Resource name: resource // // This member is required. diff --git a/service/workmail/api_op_ListResources.go b/service/workmail/api_op_ListResources.go index 396e0872a3f..ef76a030acd 100644 --- a/service/workmail/api_op_ListResources.go +++ b/service/workmail/api_op_ListResources.go @@ -50,7 +50,7 @@ type ListResourcesInput struct { type ListResourcesOutput struct { - // The token used to paginate through all the organization's resources. While + // The token used to paginate through all the organization's resources. While // results are still available, it has an associated value. When the last page is // reached, the token is empty. NextToken *string diff --git a/service/workmail/api_op_ListUsers.go b/service/workmail/api_op_ListUsers.go index 73f3311e553..05a11993ceb 100644 --- a/service/workmail/api_op_ListUsers.go +++ b/service/workmail/api_op_ListUsers.go @@ -50,7 +50,7 @@ type ListUsersInput struct { type ListUsersOutput struct { - // The token to use to retrieve the next page of results. This value is `null` + // 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 diff --git a/service/workmail/api_op_PutMailboxPermissions.go b/service/workmail/api_op_PutMailboxPermissions.go index 10aed0c8045..804e1425d43 100644 --- a/service/workmail/api_op_PutMailboxPermissions.go +++ b/service/workmail/api_op_PutMailboxPermissions.go @@ -31,24 +31,33 @@ func (c *Client) PutMailboxPermissions(ctx context.Context, params *PutMailboxPe type PutMailboxPermissionsInput struct { // The identifier of the user or resource for which to update mailbox permissions. + // // The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, // or Groupname, or email. + // // - Entity ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. EntityId *string // The identifier of the user, group, or resource to which to grant the - // permissions. The identifier can be UserId, ResourceID, or Group Id, Username, - // Resourcename, or Groupname, or email. + // permissions. + // + // The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, + // or Groupname, or email. + // // - Grantee ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: grantee@domain.tld + // // - Grantee name: grantee // // This member is required. diff --git a/service/workmail/api_op_PutMobileDeviceAccessOverride.go b/service/workmail/api_op_PutMobileDeviceAccessOverride.go index fd598698818..bdfd77c0ef4 100644 --- a/service/workmail/api_op_PutMobileDeviceAccessOverride.go +++ b/service/workmail/api_op_PutMobileDeviceAccessOverride.go @@ -48,9 +48,12 @@ type PutMobileDeviceAccessOverrideInput struct { // 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. diff --git a/service/workmail/api_op_RegisterToWorkMail.go b/service/workmail/api_op_RegisterToWorkMail.go index fadada7ac4e..5817a5c401d 100644 --- a/service/workmail/api_op_RegisterToWorkMail.go +++ b/service/workmail/api_op_RegisterToWorkMail.go @@ -14,10 +14,13 @@ 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 -// 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 . +// information, see [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. +// +// [Pricing]: https://aws.amazon.com/workmail/pricing func (c *Client) RegisterToWorkMail(ctx context.Context, params *RegisterToWorkMailInput, optFns ...func(*Options)) (*RegisterToWorkMailOutput, error) { if params == nil { params = &RegisterToWorkMailInput{} @@ -40,12 +43,15 @@ type RegisterToWorkMailInput struct { // This member is required. Email *string - // The identifier for the user, group, or resource to be updated. The identifier - // can accept UserId, ResourceId, or GroupId, or Username, Resourcename, or - // Groupname. The following identity formats are available: + // The identifier for the user, group, or resource to be updated. + // + // The identifier can accept UserId, ResourceId, or GroupId, or Username, + // Resourcename, or Groupname. The following identity formats are available: + // // - Entity ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Entity name: entity // // This member is required. diff --git a/service/workmail/api_op_StartMailboxExportJob.go b/service/workmail/api_op_StartMailboxExportJob.go index 98937ca6197..31b27bc0782 100644 --- a/service/workmail/api_op_StartMailboxExportJob.go +++ b/service/workmail/api_op_StartMailboxExportJob.go @@ -12,8 +12,10 @@ 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]in the WorkMail Administrator +// Guide. +// +// [Exporting mailbox content]: https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html func (c *Client) StartMailboxExportJob(ctx context.Context, params *StartMailboxExportJobInput, optFns ...func(*Options)) (*StartMailboxExportJobOutput, error) { if params == nil { params = &StartMailboxExportJobInput{} @@ -36,13 +38,17 @@ type StartMailboxExportJobInput struct { // This member is required. ClientToken *string - // The identifier of the user or resource associated with the mailbox. The - // identifier can accept UserId or ResourceId, Username or Resourcename, or email. - // The following identity formats are available: + // The identifier of the user or resource associated with the mailbox. + // + // The identifier can accept UserId or ResourceId, Username or Resourcename, or + // email. The following identity formats are available: + // // - Entity ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789 , or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. diff --git a/service/workmail/api_op_TestAvailabilityConfiguration.go b/service/workmail/api_op_TestAvailabilityConfiguration.go index cc62f3779ff..a30e6e9490d 100644 --- a/service/workmail/api_op_TestAvailabilityConfiguration.go +++ b/service/workmail/api_op_TestAvailabilityConfiguration.go @@ -16,8 +16,10 @@ 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_UpdateGroup.go b/service/workmail/api_op_UpdateGroup.go index 7e5fb8e3d00..49c2cc00cd2 100644 --- a/service/workmail/api_op_UpdateGroup.go +++ b/service/workmail/api_op_UpdateGroup.go @@ -28,11 +28,16 @@ func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optF type UpdateGroupInput struct { - // The identifier for the group to be updated. The identifier can accept GroupId, - // Groupname, or email. The following identity formats are available: + // The identifier for the group to be updated. + // + // The identifier can accept GroupId, Groupname, or email. The following identity + // formats are available: + // // - Group ID: 12345678-1234-1234-1234-123456789012 or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: group@domain.tld + // // - Group name: group // // This member is required. diff --git a/service/workmail/api_op_UpdateMailboxQuota.go b/service/workmail/api_op_UpdateMailboxQuota.go index dc574027d35..d70cb259b1e 100644 --- a/service/workmail/api_op_UpdateMailboxQuota.go +++ b/service/workmail/api_op_UpdateMailboxQuota.go @@ -39,12 +39,16 @@ type UpdateMailboxQuotaInput struct { // This member is required. OrganizationId *string - // The identifer for the user for whom to update the mailbox quota. The identifier - // can be the UserId, Username, or email. The following identity formats are - // available: + // The identifer for the user for whom to update the mailbox quota. + // + // The identifier can be the UserId, Username, or email. 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 // // This member is required. diff --git a/service/workmail/api_op_UpdatePrimaryEmailAddress.go b/service/workmail/api_op_UpdatePrimaryEmailAddress.go index b3d85a346ff..5ae1b11aabb 100644 --- a/service/workmail/api_op_UpdatePrimaryEmailAddress.go +++ b/service/workmail/api_op_UpdatePrimaryEmailAddress.go @@ -36,13 +36,18 @@ type UpdatePrimaryEmailAddressInput struct { // This member is required. Email *string - // The user, group, or resource to update. The identifier can accept UseriD, - // ResourceId, or GroupId, Username, Resourcename, or Groupname, or email. The - // following identity formats are available: + // The user, group, or resource to update. + // + // The identifier can accept UseriD, ResourceId, or GroupId, Username, + // Resourcename, or Groupname, or email. The following identity formats are + // available: + // // - Entity ID: 12345678-1234-1234-1234-123456789012, // r-0123456789a0123456789b0123456789, or // S-1-1-12-1234567890-123456789-123456789-1234 + // // - Email address: entity@domain.tld + // // - Entity name: entity // // This member is required. diff --git a/service/workmail/api_op_UpdateResource.go b/service/workmail/api_op_UpdateResource.go index d3b74589900..f7c255376d2 100644 --- a/service/workmail/api_op_UpdateResource.go +++ b/service/workmail/api_op_UpdateResource.go @@ -12,8 +12,8 @@ import ( ) // Updates data for the resource. To have the latest information, it must be -// preceded by a DescribeResource call. The dataset in the request should be the -// one expected when performing another DescribeResource call. +// preceded by a DescribeResourcecall. The dataset in the request should be the one expected when +// performing another DescribeResource call. func (c *Client) UpdateResource(ctx context.Context, params *UpdateResourceInput, optFns ...func(*Options)) (*UpdateResourceOutput, error) { if params == nil { params = &UpdateResourceInput{} @@ -37,11 +37,15 @@ type UpdateResourceInput struct { // This member is required. OrganizationId *string - // The identifier of the resource to be updated. The identifier can accept - // ResourceId, Resourcename, or email. The following identity formats are - // available: + // The identifier of the resource to be updated. + // + // The identifier can accept ResourceId, Resourcename, or email. The following + // identity formats are available: + // // - Resource ID: r-0123456789a0123456789b0123456789 + // // - Email address: resource@domain.tld + // // - Resource name: resource // // This member is required. diff --git a/service/workmail/api_op_UpdateUser.go b/service/workmail/api_op_UpdateUser.go index 50a8fe083f1..23129a70be4 100644 --- a/service/workmail/api_op_UpdateUser.go +++ b/service/workmail/api_op_UpdateUser.go @@ -12,8 +12,8 @@ import ( ) // Updates data for the user. To have the latest information, it must be preceded -// by a DescribeUser call. The dataset in the request should be the one expected -// when performing another DescribeUser call. +// by a DescribeUsercall. The dataset in the request should be the one expected when +// performing another DescribeUser call. func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error) { if params == nil { params = &UpdateUserInput{} @@ -36,11 +36,16 @@ type UpdateUserInput struct { // This member is required. OrganizationId *string - // The identifier for the user to be updated. The identifier can be the UserId, - // Username, or email. The following identity formats are available: + // The identifier for the user to be updated. + // + // The identifier can be the UserId, Username, or email. 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 // // This member is required. @@ -79,7 +84,9 @@ type UpdateUserInput struct { // Updates the user's office. Office *string - // Updates the user role. You cannot pass SYSTEM_USER or RESOURCE. + // Updates the user role. + // + // You cannot pass SYSTEM_USER or RESOURCE. Role types.UserRole // Updates the user's street address. diff --git a/service/workmail/doc.go b/service/workmail/doc.go index c30998986d9..fc6922b0d22 100644 --- a/service/workmail/doc.go +++ b/service/workmail/doc.go @@ -8,8 +8,9 @@ // email, contacts, and calendars using Microsoft Outlook, your browser, or other // native iOS and Android email applications. You can integrate WorkMail with your // existing corporate directory and control both the keys that encrypt your data -// and the location in which your data is stored. The WorkMail API is designed for -// the following scenarios: +// and the location in which your data is stored. +// +// The WorkMail API is designed for the following scenarios: // // - Listing and describing organizations // diff --git a/service/workmail/options.go b/service/workmail/options.go index cb93eca48f2..41fc33e192b 100644 --- a/service/workmail/options.go +++ b/service/workmail/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/workmail/types/enums.go b/service/workmail/types/enums.go index ebfc2fa4e43..af3f6a5340d 100644 --- a/service/workmail/types/enums.go +++ b/service/workmail/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessControlRuleEffect. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessControlRuleEffect) Values() []AccessControlRuleEffect { return []AccessControlRuleEffect{ "ALLOW", @@ -29,8 +30,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -48,6 +50,7 @@ const ( // 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{ @@ -67,6 +70,7 @@ const ( // Values returns all known values for DnsRecordVerificationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DnsRecordVerificationStatus) Values() []DnsRecordVerificationStatus { return []DnsRecordVerificationStatus{ @@ -86,8 +90,9 @@ const ( ) // Values returns all known values for EntityState. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityState) Values() []EntityState { return []EntityState{ "ENABLED", @@ -106,8 +111,9 @@ const ( ) // Values returns all known values for EntityType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EntityType) Values() []EntityType { return []EntityType{ "GROUP", @@ -128,8 +134,9 @@ const ( ) // Values returns all known values for FolderName. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (FolderName) Values() []FolderName { return []FolderName{ "INBOX", @@ -149,8 +156,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "FULL_ACCESS", @@ -169,8 +177,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "RUNNING", @@ -189,8 +198,9 @@ const ( ) // Values returns all known values for MemberType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MemberType) Values() []MemberType { return []MemberType{ "GROUP", @@ -208,8 +218,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MobileDeviceAccessRuleEffect) Values() []MobileDeviceAccessRuleEffect { return []MobileDeviceAccessRuleEffect{ "ALLOW", @@ -227,8 +238,9 @@ const ( ) // Values returns all known values for PermissionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (PermissionType) Values() []PermissionType { return []PermissionType{ "FULL_ACCESS", @@ -246,8 +258,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -265,8 +278,9 @@ const ( ) // Values returns all known values for RetentionAction. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RetentionAction) Values() []RetentionAction { return []RetentionAction{ "NONE", @@ -286,8 +300,9 @@ const ( ) // Values returns all known values for UserRole. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (UserRole) Values() []UserRole { return []UserRole{ "USER", diff --git a/service/workmail/types/errors.go b/service/workmail/types/errors.go index 1595393ab78..da8eb4e7cea 100644 --- a/service/workmail/types/errors.go +++ b/service/workmail/types/errors.go @@ -225,9 +225,9 @@ func (e *InvalidConfigurationException) ErrorCode() string { func (e *InvalidConfigurationException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient } // 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) -// . +// message lists the invalid setting. For examples of invalid settings, refer to [CreateReceiptRule]. +// +// [CreateReceiptRule]: https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html type InvalidCustomSesConfigurationException struct { Message *string diff --git a/service/workmail/types/types.go b/service/workmail/types/types.go index 2063d1c25dc..efd4a8ecaac 100644 --- a/service/workmail/types/types.go +++ b/service/workmail/types/types.go @@ -129,11 +129,13 @@ type DnsRecord struct { noSmithyDocumentSerde } -// 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) -// in the WorkMail Administrator Guide. +// 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]in the WorkMail Administrator Guide. +// +// [Adding a domain]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html type Domain struct { // The fully qualified domain name. @@ -300,7 +302,8 @@ type LambdaAvailabilityProvider struct { noSmithyDocumentSerde } -// Filtering options for ListGroups operation. This is only used as input to +// Filtering options for ListGroups operation. This is only used as input to +// // Operation. type ListGroupsFilters struct { @@ -316,8 +319,9 @@ type ListGroupsFilters struct { noSmithyDocumentSerde } -// Filtering options for ListGroupsForEntity operation. This is only used as input -// to Operation. +// Filtering options for ListGroupsForEntity operation. This is only used as +// +// input to Operation. type ListGroupsForEntityFilters struct { // Filters only group names that start with the provided name prefix. @@ -342,7 +346,8 @@ type ListResourcesFilters struct { noSmithyDocumentSerde } -// Filtering options for ListUsers operation. This is only used as input to +// Filtering options for ListUsers operation. This is only used as input to +// // Operation. type ListUsersFilters struct { diff --git a/service/workmailmessageflow/api_op_PutRawMessageContent.go b/service/workmailmessageflow/api_op_PutRawMessageContent.go index 3831e53feb3..5801e7268e2 100644 --- a/service/workmailmessageflow/api_op_PutRawMessageContent.go +++ b/service/workmailmessageflow/api_op_PutRawMessageContent.go @@ -11,15 +11,19 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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) -// 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) -// returns an updated message. +// 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]. +// +// Updates to an in-transit message only appear when you call PutRawMessageContent +// from an AWS Lambda function configured with a synchronous [Run Lambda]rule. If you call +// PutRawMessageContent on a delivered or sent message, the message remains +// unchanged, even though [GetRawMessageContent]returns an updated message. +// +// [GetRawMessageContent]: https://docs.aws.amazon.com/workmail/latest/APIReference/API_messageflow_GetRawMessageContent.html +// [Run Lambda]: https://docs.aws.amazon.com/workmail/latest/adminguide/lambda.html#synchronous-rules +// [Updating message content with AWS Lambda]: https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html func (c *Client) PutRawMessageContent(ctx context.Context, params *PutRawMessageContentInput, optFns ...func(*Options)) (*PutRawMessageContentOutput, error) { if params == nil { params = &PutRawMessageContentInput{} diff --git a/service/workmailmessageflow/options.go b/service/workmailmessageflow/options.go index c8cbc66d0ba..3bc3631480c 100644 --- a/service/workmailmessageflow/options.go +++ b/service/workmailmessageflow/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/workmailmessageflow/types/errors.go b/service/workmailmessageflow/types/errors.go index 50dd816f7db..c59fd1a60d5 100644 --- a/service/workmailmessageflow/types/errors.go +++ b/service/workmailmessageflow/types/errors.go @@ -8,12 +8,16 @@ 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. +// +// - The [S3 bucket owner]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. +// about policies, see [Updating message content with AWS Lambda]in the WorkMail Administrator Guide. +// +// [S3 bucket owner]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-owner-condition.html +// [Updating message content with AWS Lambda]: https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html type InvalidContentLocation struct { Message *string diff --git a/service/workmailmessageflow/types/types.go b/service/workmailmessageflow/types/types.go index 9472852e718..f1c952fbaf4 100644 --- a/service/workmailmessageflow/types/types.go +++ b/service/workmailmessageflow/types/types.go @@ -8,21 +8,29 @@ import ( // 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) -// . +// information, see [Unsupported Attachment Types]. +// // - 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. +// +// - Per [RFC 5321], 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. +// +// [Unsupported Attachment Types]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types-appendix.html +// [RFC 5321]: https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6 type RawMessageContent struct { // The S3 reference of an email message. @@ -33,12 +41,13 @@ type RawMessageContent struct { noSmithyDocumentSerde } -// 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) -// . +// 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]. +// +// [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_op_AcceptAccountLinkInvitation.go b/service/workspaces/api_op_AcceptAccountLinkInvitation.go index a41309b5236..7b029ebeccd 100644 --- a/service/workspaces/api_op_AcceptAccountLinkInvitation.go +++ b/service/workspaces/api_op_AcceptAccountLinkInvitation.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Accepts the account link invitation. There's currently no unlinking capability -// after you accept the account linking invitation. +// Accepts the account link invitation. +// +// There's currently no unlinking capability after you accept the account linking +// invitation. func (c *Client) AcceptAccountLinkInvitation(ctx context.Context, params *AcceptAccountLinkInvitationInput, optFns ...func(*Options)) (*AcceptAccountLinkInvitationOutput, error) { if params == nil { params = &AcceptAccountLinkInvitationInput{} diff --git a/service/workspaces/api_op_AssociateConnectionAlias.go b/service/workspaces/api_op_AssociateConnectionAlias.go index 3cce26a6012..8df7f3847ba 100644 --- a/service/workspaces/api_op_AssociateConnectionAlias.go +++ b/service/workspaces/api_op_AssociateConnectionAlias.go @@ -11,10 +11,13 @@ import ( ) // 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 . +// enable cross-Region redirection. For more information, see [Cross-Region Redirection for Amazon WorkSpaces]. +// +// Before performing this operation, call [DescribeConnectionAliases] to make sure that the current state of +// the connection alias is CREATED . +// +// [DescribeConnectionAliases]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html +// [Cross-Region Redirection for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html 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_AuthorizeIpRules.go b/service/workspaces/api_op_AuthorizeIpRules.go index 98d3d4d1379..822ea4c5bcd 100644 --- a/service/workspaces/api_op_AuthorizeIpRules.go +++ b/service/workspaces/api_op_AuthorizeIpRules.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Adds one or more rules to the specified IP access control group. This action -// gives users permission to access their WorkSpaces from the CIDR address ranges -// specified in the rules. +// Adds one or more rules to the specified IP access control group. +// +// This action gives users permission to access their WorkSpaces from the CIDR +// address ranges specified in the rules. func (c *Client) AuthorizeIpRules(ctx context.Context, params *AuthorizeIpRulesInput, optFns ...func(*Options)) (*AuthorizeIpRulesOutput, error) { if params == nil { params = &AuthorizeIpRulesInput{} diff --git a/service/workspaces/api_op_CopyWorkspaceImage.go b/service/workspaces/api_op_CopyWorkspaceImage.go index e2f1c169fe0..8f7010b4726 100644 --- a/service/workspaces/api_op_CopyWorkspaceImage.go +++ b/service/workspaces/api_op_CopyWorkspaceImage.go @@ -12,15 +12,21 @@ 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) -// API operations. +// more information about copying images, see [Copy a Custom WorkSpaces Image]. +// +// 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]and [DescribeWorkspaceImagePermissions] API operations. +// +// [DescribeWorkspaceImagePermissions]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html +// [DescribeWorkSpaceImages]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html +// [Copy a Custom WorkSpaces Image]: https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html func (c *Client) CopyWorkspaceImage(ctx context.Context, params *CopyWorkspaceImageInput, optFns ...func(*Options)) (*CopyWorkspaceImageOutput, error) { if params == nil { params = &CopyWorkspaceImageInput{} diff --git a/service/workspaces/api_op_CreateConnectClientAddIn.go b/service/workspaces/api_op_CreateConnectClientAddIn.go index 17957e49dd0..a07e164c234 100644 --- a/service/workspaces/api_op_CreateConnectClientAddIn.go +++ b/service/workspaces/api_op_CreateConnectClientAddIn.go @@ -11,8 +11,10 @@ import ( ) // Creates a client-add-in for Amazon Connect within a directory. You can create -// only one Amazon Connect client add-in within a directory. This client add-in -// allows WorkSpaces users to seamlessly connect to Amazon Connect. +// only one Amazon Connect client add-in within a directory. +// +// This client add-in allows WorkSpaces users to seamlessly connect to Amazon +// Connect. func (c *Client) CreateConnectClientAddIn(ctx context.Context, params *CreateConnectClientAddInInput, optFns ...func(*Options)) (*CreateConnectClientAddInOutput, error) { if params == nil { params = &CreateConnectClientAddInInput{} diff --git a/service/workspaces/api_op_CreateConnectionAlias.go b/service/workspaces/api_op_CreateConnectionAlias.go index d4caf75f1ba..d3a0f0d579f 100644 --- a/service/workspaces/api_op_CreateConnectionAlias.go +++ b/service/workspaces/api_op_CreateConnectionAlias.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -32,11 +33,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. + // 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 417d47e4254..f286f8d0416 100644 --- a/service/workspaces/api_op_CreateIpGroup.go +++ b/service/workspaces/api_op_CreateIpGroup.go @@ -11,11 +11,14 @@ 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 . +// 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 diff --git a/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go b/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go index be492daabe0..933b59663e9 100644 --- a/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go +++ b/service/workspaces/api_op_CreateUpdatedWorkspaceImage.go @@ -13,16 +13,21 @@ import ( // Creates a new updated WorkSpace image based on the specified source image. The // 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) -// . +// the Amazon WorkSpaces components. +// +// To determine which WorkSpace images need to be updated with the latest Amazon +// WorkSpaces requirements, use [DescribeWorkspaceImages]. +// // - 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 func (c *Client) CreateUpdatedWorkspaceImage(ctx context.Context, params *CreateUpdatedWorkspaceImageInput, optFns ...func(*Options)) (*CreateUpdatedWorkspaceImageOutput, error) { if params == nil { params = &CreateUpdatedWorkspaceImageInput{} @@ -55,9 +60,11 @@ 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 55bfd75e6b5..4ad9f1213b4 100644 --- a/service/workspaces/api_op_CreateWorkspaceBundle.go +++ b/service/workspaces/api_op_CreateWorkspaceBundle.go @@ -12,8 +12,9 @@ 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]. +// +// [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{} @@ -59,9 +60,11 @@ type CreateWorkspaceBundleInput struct { // Describes the root volume for a WorkSpace bundle. RootStorage *types.RootStorage - // 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 . + // 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 + // . Tags []types.Tag noSmithyDocumentSerde diff --git a/service/workspaces/api_op_CreateWorkspaceImage.go b/service/workspaces/api_op_CreateWorkspaceImage.go index 27f4ea1a14a..8b8c7bc150f 100644 --- a/service/workspaces/api_op_CreateWorkspaceImage.go +++ b/service/workspaces/api_op_CreateWorkspaceImage.go @@ -75,8 +75,9 @@ 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.]. + // + // [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 ad3918705fc..affb2a3218a 100644 --- a/service/workspaces/api_op_CreateWorkspaces.go +++ b/service/workspaces/api_op_CreateWorkspaces.go @@ -11,15 +11,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Creates one or more WorkSpaces. This operation is asynchronous and returns -// before the WorkSpaces are created. +// 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/) -// . +// information, see [Amazon WorkSpaces Core]. +// // - You don't need to specify the PCOIP protocol for Linux bundles because WSP // is the default protocol for those bundles. +// // - User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core. +// +// [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{} @@ -50,10 +55,11 @@ type CreateWorkspacesOutput struct { // Information about the WorkSpaces that could not be created. FailedRequests []types.FailedCreateWorkspaceRequest - // Information about the WorkSpaces that were created. Because this operation is - // asynchronous, the identifier returned is not immediately available for use with - // other operations. For example, if you call DescribeWorkspaces before the - // WorkSpace is created, the information returned can be incomplete. + // Information about the WorkSpaces that were created. + // + // Because this operation is asynchronous, the identifier returned is not + // immediately available for use with other operations. For example, if you call DescribeWorkspaces + // before the WorkSpace is created, the information returned can be incomplete. PendingRequests []types.Workspace // Metadata pertaining to the operation's result. diff --git a/service/workspaces/api_op_DeleteClientBranding.go b/service/workspaces/api_op_DeleteClientBranding.go index 310e44f3605..e505e633460 100644 --- a/service/workspaces/api_op_DeleteClientBranding.go +++ b/service/workspaces/api_op_DeleteClientBranding.go @@ -14,8 +14,10 @@ import ( // 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. +// 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 f751ba2befa..e4b94d714c1 100644 --- a/service/workspaces/api_op_DeleteConnectionAlias.go +++ b/service/workspaces/api_op_DeleteConnectionAlias.go @@ -10,17 +10,20 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// Deletes the specified connection alias. For more information, see [Cross-Region Redirection for Amazon WorkSpaces]. +// +// 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 +// to prevent potential security issues. For more information, see [Security Considerations if You Stop Using Cross-Region Redirection]. +// +// 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. +// +// [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 +// [Cross-Region Redirection for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html 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_DeleteIpGroup.go b/service/workspaces/api_op_DeleteIpGroup.go index 2901acafbbb..0500ca1dbb5 100644 --- a/service/workspaces/api_op_DeleteIpGroup.go +++ b/service/workspaces/api_op_DeleteIpGroup.go @@ -10,8 +10,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Deletes the specified IP access control group. You cannot delete an IP access -// control group that is associated with a directory. +// Deletes the specified IP access control group. +// +// You cannot delete an IP access control group that is associated with a +// directory. func (c *Client) DeleteIpGroup(ctx context.Context, params *DeleteIpGroupInput, optFns ...func(*Options)) (*DeleteIpGroupOutput, error) { if params == nil { params = &DeleteIpGroupInput{} diff --git a/service/workspaces/api_op_DeleteWorkspaceBundle.go b/service/workspaces/api_op_DeleteWorkspaceBundle.go index e21d030aca9..2f622e3c1d0 100644 --- a/service/workspaces/api_op_DeleteWorkspaceBundle.go +++ b/service/workspaces/api_op_DeleteWorkspaceBundle.go @@ -11,8 +11,9 @@ 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]. +// +// [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 c933e37e9ca..e163aa3588b 100644 --- a/service/workspaces/api_op_DeregisterWorkspaceDirectory.go +++ b/service/workspaces/api_op_DeregisterWorkspaceDirectory.go @@ -13,14 +13,19 @@ import ( // Deregisters the specified directory. This operation is asynchronous and returns // before the WorkSpace directory is deregistered. If any WorkSpaces are registered // to this directory, you must remove them before you can deregister the directory. +// // 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]. +// +// To delete empty directories, see [Delete the Directory for Your WorkSpaces]. 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. +// +// [Delete the Directory for Your WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html +// [Directory Service pricing terms]: http://aws.amazon.com/directoryservice/pricing/ 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_DescribeAccount.go b/service/workspaces/api_op_DescribeAccount.go index e15e71385ae..0f6b8aaaae5 100644 --- a/service/workspaces/api_op_DescribeAccount.go +++ b/service/workspaces/api_op_DescribeAccount.go @@ -38,10 +38,12 @@ type DescribeAccountOutput struct { DedicatedTenancyAccountType types.DedicatedTenancyAccountType // The IP address range, specified as an IPv4 CIDR block, used for the management - // network interface. The management network interface is connected to a secure - // Amazon WorkSpaces management network. It is used for interactive streaming of - // the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon - // WorkSpaces to manage the WorkSpace. + // network interface. + // + // The management network interface is connected to a secure Amazon WorkSpaces + // management network. It is used for interactive streaming of the WorkSpace + // desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage + // the WorkSpace. DedicatedTenancyManagementCidrRange *string // The status of BYOL (whether BYOL is enabled or disabled). diff --git a/service/workspaces/api_op_DescribeClientBranding.go b/service/workspaces/api_op_DescribeClientBranding.go index dfb57eb46aa..6ca2c5083c1 100644 --- a/service/workspaces/api_op_DescribeClientBranding.go +++ b/service/workspaces/api_op_DescribeClientBranding.go @@ -14,8 +14,10 @@ import ( // 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. +// 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 43ebd75e6d0..3235fdf1833 100644 --- a/service/workspaces/api_op_DescribeConnectionAliasPermissions.go +++ b/service/workspaces/api_op_DescribeConnectionAliasPermissions.go @@ -13,8 +13,9 @@ 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]. +// +// [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 7fbb02a14ae..75cefd179b2 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]. +// +// [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 7b6a58d68bb..6780004ef76 100644 --- a/service/workspaces/api_op_DescribeWorkspaceBundles.go +++ b/service/workspaces/api_op_DescribeWorkspaceBundles.go @@ -11,8 +11,9 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Retrieves a list that describes the available WorkSpace bundles. You can filter -// the results using either bundle ID or owner, but not both. +// Retrieves a list that describes the available WorkSpace bundles. +// +// You can filter the results using either bundle ID or owner, but not both. func (c *Client) DescribeWorkspaceBundles(ctx context.Context, params *DescribeWorkspaceBundlesInput, optFns ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error) { if params == nil { params = &DescribeWorkspaceBundlesInput{} @@ -39,8 +40,10 @@ 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_DescribeWorkspaces.go b/service/workspaces/api_op_DescribeWorkspaces.go index 1a57e2c3b3d..ec8bba8dcae 100644 --- a/service/workspaces/api_op_DescribeWorkspaces.go +++ b/service/workspaces/api_op_DescribeWorkspaces.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Describes the specified WorkSpaces. You can filter the results by using the -// bundle identifier, directory identifier, or owner, but you can specify only one -// filter at a time. +// Describes the specified WorkSpaces. +// +// You can filter the results by using the bundle identifier, directory +// identifier, or owner, but you can specify only one filter at a time. func (c *Client) DescribeWorkspaces(ctx context.Context, params *DescribeWorkspacesInput, optFns ...func(*Options)) (*DescribeWorkspacesOutput, error) { if params == nil { params = &DescribeWorkspacesInput{} @@ -52,9 +53,11 @@ type DescribeWorkspacesInput struct { UserName *string // The identifiers of the WorkSpaces. You cannot combine this parameter with any - // other filter. Because the CreateWorkspaces operation is asynchronous, the - // identifier it returns is not immediately available. If you immediately call - // DescribeWorkspaces with this identifier, no information is returned. + // other filter. + // + // Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not + // immediately available. If you immediately call DescribeWorkspaceswith this identifier, no + // information is returned. WorkspaceIds []string // The name of the user-decoupled WorkSpace. @@ -69,8 +72,10 @@ type DescribeWorkspacesOutput struct { // there are no more results to return. NextToken *string - // Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous - // operation, some of the returned information could be incomplete. + // Information about the WorkSpaces. + // + // Because CreateWorkspaces is an asynchronous operation, some of the returned information could + // be incomplete. Workspaces []types.Workspace // Metadata pertaining to the operation's result. diff --git a/service/workspaces/api_op_DisassociateConnectionAlias.go b/service/workspaces/api_op_DisassociateConnectionAlias.go index ffc258aa770..21a1c01649b 100644 --- a/service/workspaces/api_op_DisassociateConnectionAlias.go +++ b/service/workspaces/api_op_DisassociateConnectionAlias.go @@ -12,10 +12,13 @@ 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]. +// +// Before performing this operation, call [DescribeConnectionAliases] to make sure that the current state of +// the connection alias is CREATED . +// +// [DescribeConnectionAliases]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html +// [Cross-Region Redirection for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html 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 a686d8334b8..6eed821dbfb 100644 --- a/service/workspaces/api_op_ImportClientBranding.go +++ b/service/workspaces/api_op_ImportClientBranding.go @@ -14,16 +14,21 @@ import ( // Imports 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 import client branding, the -// default branding experience for the specified platform type is replaced with the -// imported experience +// 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. func (c *Client) ImportClientBranding(ctx context.Context, params *ImportClientBrandingInput, optFns ...func(*Options)) (*ImportClientBrandingOutput, error) { if params == nil { diff --git a/service/workspaces/api_op_ImportWorkspaceImage.go b/service/workspaces/api_op_ImportWorkspaceImage.go index c662abd532e..0a96aa223dc 100644 --- a/service/workspaces/api_op_ImportWorkspaceImage.go +++ b/service/workspaces/api_op_ImportWorkspaceImage.go @@ -14,9 +14,9 @@ import ( // Imports the specified Windows 10 or 11 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) -// . +// information about creating BYOL images, see [Bring Your Own Windows Desktop Licenses]. +// +// [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{} @@ -53,23 +53,30 @@ type ImportWorkspaceImageInput struct { // 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 - // BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by + // _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]. + // + // [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 and 11 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) - // . + // for BYOL images, see [Bring Your Own Windows Desktop Licenses]. + // // - Although this parameter is an array, only one item is allowed at this time. + // // - Windows 11 only supports Microsoft_Office_2019 . + // + // [Bring Your Own Windows Desktop Licenses]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html Applications []types.Application // The tags. Each WorkSpaces resource can have a maximum of 50 tags. diff --git a/service/workspaces/api_op_ListAvailableManagementCidrRanges.go b/service/workspaces/api_op_ListAvailableManagementCidrRanges.go index b9779a3640d..82183ac7bff 100644 --- a/service/workspaces/api_op_ListAvailableManagementCidrRanges.go +++ b/service/workspaces/api_op_ListAvailableManagementCidrRanges.go @@ -12,12 +12,16 @@ import ( // Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you // can use for the network management interface when you enable Bring Your Own -// License (BYOL). This operation can be run only by Amazon Web Services accounts -// that are enabled for BYOL. If your account isn't enabled for BYOL, you'll -// receive an AccessDeniedException error. The management network interface is -// connected to a secure Amazon WorkSpaces management network. It is used for -// interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and -// to allow Amazon WorkSpaces to manage the WorkSpace. +// License (BYOL). +// +// This operation can be run only by Amazon Web Services accounts that are enabled +// for BYOL. If your account isn't enabled for BYOL, you'll receive an +// AccessDeniedException error. +// +// The management network interface is connected to a secure Amazon WorkSpaces +// management network. It is used for interactive streaming of the WorkSpace +// desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage +// the WorkSpace. func (c *Client) ListAvailableManagementCidrRanges(ctx context.Context, params *ListAvailableManagementCidrRangesInput, optFns ...func(*Options)) (*ListAvailableManagementCidrRangesOutput, error) { if params == nil { params = &ListAvailableManagementCidrRangesInput{} diff --git a/service/workspaces/api_op_MigrateWorkspace.go b/service/workspaces/api_op_MigrateWorkspace.go index 6536c2695c3..21ef6514db1 100644 --- a/service/workspaces/api_op_MigrateWorkspace.go +++ b/service/workspaces/api_op_MigrateWorkspace.go @@ -11,15 +11,19 @@ import ( ) // Migrates a WorkSpace from one operating system or bundle type to another, while -// retaining the data on the user volume. The migration process recreates the -// 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) -// . +// retaining the data on the user volume. +// +// The migration process recreates the 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]. +// +// [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 ac70f8b6d6b..40a45cefd65 100644 --- a/service/workspaces/api_op_ModifySamlProperties.go +++ b/service/workspaces/api_op_ModifySamlProperties.go @@ -36,9 +36,12 @@ type ModifySamlPropertiesInput struct { // This member is required. ResourceId *string - // The SAML properties to delete as part of your request. Specify one of the - // following options: + // 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. PropertiesToDelete []types.DeletableSamlProperty diff --git a/service/workspaces/api_op_ModifySelfservicePermissions.go b/service/workspaces/api_op_ModifySelfservicePermissions.go index 3bb8c6fed5f..844fe63250d 100644 --- a/service/workspaces/api_op_ModifySelfservicePermissions.go +++ b/service/workspaces/api_op_ModifySelfservicePermissions.go @@ -12,9 +12,9 @@ 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) -// . +// more information, see [Enable Self-Service WorkSpace Management Capabilities for Your Users]. +// +// [Enable Self-Service WorkSpace Management Capabilities for 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 7086a201498..8a555966176 100644 --- a/service/workspaces/api_op_ModifyWorkspaceAccessProperties.go +++ b/service/workspaces/api_op_ModifyWorkspaceAccessProperties.go @@ -12,8 +12,9 @@ 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]. +// +// [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 58f79fefaf9..eab0365b213 100644 --- a/service/workspaces/api_op_ModifyWorkspaceProperties.go +++ b/service/workspaces/api_op_ModifyWorkspaceProperties.go @@ -12,11 +12,14 @@ import ( ) // 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. +// how to modify the size of the root and user volumes, see [Modify a WorkSpace]. +// +// 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]. +// +// [Amazon WorkSpaces Core]: http://aws.amazon.com/workspaces/core/ +// [Modify a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html 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 1e991deac7a..e41d226c6a5 100644 --- a/service/workspaces/api_op_ModifyWorkspaceState.go +++ b/service/workspaces/api_op_ModifyWorkspaceState.go @@ -11,11 +11,12 @@ 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 d2208aa3198..9ffed808f52 100644 --- a/service/workspaces/api_op_RebootWorkspaces.go +++ b/service/workspaces/api_op_RebootWorkspaces.go @@ -11,11 +11,13 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its -// state is AVAILABLE , UNHEALTHY , or REBOOTING . Reboot a WorkSpace in the -// REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state -// for over 20 minutes. 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 , UNHEALTHY , or +// REBOOTING . Reboot a WorkSpace in the REBOOTING state only if your WorkSpace +// has been stuck in the REBOOTING state for over 20 minutes. +// +// 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 d7b05f123d3..da2277260cb 100644 --- a/service/workspaces/api_op_RebuildWorkspaces.go +++ b/service/workspaces/api_op_RebuildWorkspaces.go @@ -11,12 +11,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Rebuilds the specified WorkSpace. You cannot rebuild a WorkSpace unless its -// 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 +// Rebuilds the specified WorkSpace. +// +// You cannot rebuild a WorkSpace unless its 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]. +// +// This operation is asynchronous and returns before the WorkSpaces have been // completely rebuilt. +// +// [Rebuild a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html func (c *Client) RebuildWorkspaces(ctx context.Context, params *RebuildWorkspacesInput, optFns ...func(*Options)) (*RebuildWorkspacesOutput, error) { if params == nil { params = &RebuildWorkspacesInput{} diff --git a/service/workspaces/api_op_RegisterWorkspaceDirectory.go b/service/workspaces/api_op_RegisterWorkspaceDirectory.go index f4f9cba029e..44c33049850 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]. +// +// [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{} @@ -68,9 +68,9 @@ type RegisterWorkspaceDirectoryInput struct { // Your Own License (BYOL) images, this value must be set to DEDICATED and your // 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) - // . + // error. For more information about BYOL images, see [Bring Your Own Windows Desktop Images]. + // + // [Bring Your Own Windows 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 ef36174d8b1..6a7ff9a393a 100644 --- a/service/workspaces/api_op_RestoreWorkspace.go +++ b/service/workspaces/api_op_RestoreWorkspace.go @@ -10,12 +10,18 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 +// 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]. +// +// This operation is asynchronous and returns before the WorkSpace is completely // restored. +// +// [Restore a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html func (c *Client) RestoreWorkspace(ctx context.Context, params *RestoreWorkspaceInput, optFns ...func(*Options)) (*RestoreWorkspaceOutput, error) { if params == nil { params = &RestoreWorkspaceInput{} diff --git a/service/workspaces/api_op_StartWorkspaces.go b/service/workspaces/api_op_StartWorkspaces.go index 191781f1d8c..eb33e493f68 100644 --- a/service/workspaces/api_op_StartWorkspaces.go +++ b/service/workspaces/api_op_StartWorkspaces.go @@ -11,8 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a -// running mode of AutoStop and a state of STOPPED . +// Starts the specified WorkSpaces. +// +// You cannot start a WorkSpace unless it has a 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 6622edbea1a..b37b274772a 100644 --- a/service/workspaces/api_op_StopWorkspaces.go +++ b/service/workspaces/api_op_StopWorkspaces.go @@ -11,9 +11,10 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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 . +// 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 . 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 50ba5c3ee80..33ba9fb16e2 100644 --- a/service/workspaces/api_op_TerminateWorkspaces.go +++ b/service/workspaces/api_op_TerminateWorkspaces.go @@ -11,24 +11,34 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent -// 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 -// 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. 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 +// Terminates the specified WorkSpaces. +// +// Terminating a WorkSpace is a permanent 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 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]. 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]. +// +// To delete empty directories, see [Delete the Directory for Your WorkSpaces]. 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. +// +// [DescribeWorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html +// [Delete the Directory for Your WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html +// [Directory Service pricing terms]: http://aws.amazon.com/directoryservice/pricing/ 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 900657a0dee..bd974cce70f 100644 --- a/service/workspaces/api_op_UpdateConnectionAliasPermission.go +++ b/service/workspaces/api_op_UpdateConnectionAliasPermission.go @@ -15,16 +15,19 @@ 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 . +// unshared with the account. For more information, see [Cross-Region Redirection for Amazon WorkSpaces]. +// +// - Before performing this operation, call [DescribeConnectionAliases]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. +// +// [DescribeConnectionAliases]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html +// [Cross-Region Redirection for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html 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 352a1eedd90..b4c7d6ea541 100644 --- a/service/workspaces/api_op_UpdateWorkspaceBundle.go +++ b/service/workspaces/api_op_UpdateWorkspaceBundle.go @@ -11,11 +11,14 @@ import ( ) // 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 +// updating WorkSpace bundles, see [Update a Custom WorkSpaces Bundle]. +// +// 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. +// +// [Update a Custom WorkSpaces Bundle]: https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html 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 6796e248c1b..81dd5c0d047 100644 --- a/service/workspaces/api_op_UpdateWorkspaceImagePermission.go +++ b/service/workspaces/api_op_UpdateWorkspaceImagePermission.go @@ -14,18 +14,26 @@ import ( // Region by specifying whether that account has permission to copy the image. If // the copy image permission is granted, the image is shared with that account. If // the copy image permission is revoked, the image is unshared with the account. +// // After an image has been shared, the recipient account can copy the image to -// 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) -// . +// 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]. +// // - 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. +// +// [Share or Unshare a Custom WorkSpaces Image]: https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html func (c *Client) UpdateWorkspaceImagePermission(ctx context.Context, params *UpdateWorkspaceImagePermissionInput, optFns ...func(*Options)) (*UpdateWorkspaceImagePermissionOutput, error) { if params == nil { params = &UpdateWorkspaceImagePermissionInput{} @@ -55,8 +63,10 @@ type UpdateWorkspaceImagePermissionInput struct { ImageId *string // The identifier of the Amazon Web Services account to share or unshare the image - // with. Before sharing the image, confirm that you are sharing to the correct - // Amazon Web Services account ID. + // with. + // + // Before sharing the image, confirm that you are sharing to the correct Amazon + // Web Services account ID. // // This member is required. SharedAccountId *string diff --git a/service/workspaces/doc.go b/service/workspaces/doc.go index b3cabce04d2..ea39b23780c 100644 --- a/service/workspaces/doc.go +++ b/service/workspaces/doc.go @@ -3,24 +3,28 @@ // Package workspaces provides the API client, operations, and parameter types for // Amazon WorkSpaces. // -// Amazon WorkSpaces Service Amazon WorkSpaces enables you to provision virtual, -// cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as -// WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or -// install complex software. You can quickly add or remove users as your needs -// change. Users can access their virtual desktops from multiple devices or web -// browsers. This API Reference provides detailed information about the actions, -// data types, parameters, and errors of the WorkSpaces service. For more -// information about the supported Amazon Web Services Regions, endpoints, and -// service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and -// quotas (https://docs.aws.amazon.com/general/latest/gr/wsp.html) in the Amazon -// 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) -// . +// # Amazon WorkSpaces Service +// +// Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft +// Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces +// eliminates the need to procure and deploy hardware or install complex software. +// You can quickly add or remove users as your needs change. Users can access their +// virtual desktops from multiple devices or web browsers. +// +// This API Reference provides detailed information about the actions, data types, +// parameters, and errors of the WorkSpaces service. For more information about the +// supported Amazon Web Services Regions, endpoints, and service quotas of the +// Amazon WorkSpaces service, see [WorkSpaces endpoints and quotas]in the Amazon 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]. For more information about using the Amazon WorkSpaces +// client application or web browser to access provisioned WorkSpaces, see the [Amazon WorkSpaces User Guide]. +// For more information about using the CLI to manage your WorkSpaces resources, +// see the [WorkSpaces section of the CLI Reference]. +// +// [Amazon WorkSpaces Administration Guide]: https://docs.aws.amazon.com/workspaces/latest/adminguide/ +// [WorkSpaces endpoints and quotas]: https://docs.aws.amazon.com/general/latest/gr/wsp.html +// [WorkSpaces section of the CLI Reference]: https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html +// [Amazon WorkSpaces User Guide]: https://docs.aws.amazon.com/workspaces/latest/userguide/ package workspaces diff --git a/service/workspaces/options.go b/service/workspaces/options.go index ba469893f0b..8d67f95ed6b 100644 --- a/service/workspaces/options.go +++ b/service/workspaces/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/workspaces/types/enums.go b/service/workspaces/types/enums.go index 48dec62f41a..f79db0b1e7b 100644 --- a/service/workspaces/types/enums.go +++ b/service/workspaces/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AccessPropertyValue. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccessPropertyValue) Values() []AccessPropertyValue { return []AccessPropertyValue{ "ALLOW", @@ -32,8 +33,9 @@ const ( ) // Values returns all known values for AccountLinkStatusEnum. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AccountLinkStatusEnum) Values() []AccountLinkStatusEnum { return []AccountLinkStatusEnum{ "LINKED", @@ -53,8 +55,9 @@ const ( ) // Values returns all known values for Application. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Application) Values() []Application { return []Application{ "Microsoft_Office_2016", @@ -73,8 +76,9 @@ const ( // Values returns all known values for ApplicationAssociatedResourceType. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplicationAssociatedResourceType) Values() []ApplicationAssociatedResourceType { return []ApplicationAssociatedResourceType{ "WORKSPACE", @@ -95,8 +99,9 @@ const ( ) // Values returns all known values for AssociationErrorCode. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationErrorCode) Values() []AssociationErrorCode { return []AssociationErrorCode{ "ValidationError.InsufficientDiskSpace", @@ -123,8 +128,9 @@ const ( ) // Values returns all known values for AssociationState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationState) Values() []AssociationState { return []AssociationState{ "PENDING_INSTALL", @@ -151,8 +157,9 @@ const ( ) // Values returns all known values for AssociationStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AssociationStatus) Values() []AssociationStatus { return []AssociationStatus{ "NOT_ASSOCIATED", @@ -172,8 +179,9 @@ const ( // Values returns all known values for BundleAssociatedResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BundleAssociatedResourceType) Values() []BundleAssociatedResourceType { return []BundleAssociatedResourceType{ "APPLICATION", @@ -189,8 +197,9 @@ const ( ) // Values returns all known values for BundleType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BundleType) Values() []BundleType { return []BundleType{ "REGULAR", @@ -208,8 +217,9 @@ const ( // Values returns all known values for CertificateBasedAuthStatusEnum. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (CertificateBasedAuthStatusEnum) Values() []CertificateBasedAuthStatusEnum { return []CertificateBasedAuthStatusEnum{ "DISABLED", @@ -230,8 +240,9 @@ const ( ) // Values returns all known values for ClientDeviceType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ClientDeviceType) Values() []ClientDeviceType { return []ClientDeviceType{ "DeviceTypeWindows", @@ -259,8 +270,9 @@ const ( ) // Values returns all known values for Compute. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Compute) Values() []Compute { return []Compute{ "VALUE", @@ -285,8 +297,9 @@ const ( ) // Values returns all known values for ConnectionAliasState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionAliasState) Values() []ConnectionAliasState { return []ConnectionAliasState{ "CREATING", @@ -305,8 +318,9 @@ const ( ) // Values returns all known values for ConnectionState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ConnectionState) Values() []ConnectionState { return []ConnectionState{ "CONNECTED", @@ -324,8 +338,9 @@ const ( ) // Values returns all known values for DataReplication. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DataReplication) Values() []DataReplication { return []DataReplication{ "NO_REPLICATION", @@ -343,6 +358,7 @@ const ( // Values returns all known values for DedicatedTenancyAccountType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DedicatedTenancyAccountType) Values() []DedicatedTenancyAccountType { return []DedicatedTenancyAccountType{ @@ -362,8 +378,9 @@ const ( // Values returns all known values for DedicatedTenancyModificationStateEnum. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DedicatedTenancyModificationStateEnum) Values() []DedicatedTenancyModificationStateEnum { return []DedicatedTenancyModificationStateEnum{ "PENDING", @@ -381,6 +398,7 @@ const ( // Values returns all known values for DedicatedTenancySupportEnum. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (DedicatedTenancySupportEnum) Values() []DedicatedTenancySupportEnum { return []DedicatedTenancySupportEnum{ @@ -398,8 +416,9 @@ const ( // 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. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DedicatedTenancySupportResultEnum) Values() []DedicatedTenancySupportResultEnum { return []DedicatedTenancySupportResultEnum{ "ENABLED", @@ -416,8 +435,9 @@ const ( // Values returns all known values for DeletableCertificateBasedAuthProperty. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeletableCertificateBasedAuthProperty) Values() []DeletableCertificateBasedAuthProperty { return []DeletableCertificateBasedAuthProperty{ "CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN", @@ -433,8 +453,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "SAML_PROPERTIES_USER_ACCESS_URL", @@ -451,6 +472,7 @@ const ( // Values returns all known values for ImageAssociatedResourceType. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ImageAssociatedResourceType) Values() []ImageAssociatedResourceType { return []ImageAssociatedResourceType{ @@ -467,8 +489,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -485,8 +508,9 @@ const ( ) // Values returns all known values for LogUploadEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (LogUploadEnum) Values() []LogUploadEnum { return []LogUploadEnum{ "ENABLED", @@ -505,6 +529,7 @@ const ( // 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{ @@ -523,8 +548,9 @@ const ( ) // 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. +// be expanded in the future, and so 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{ "UPDATE_INITIATED", @@ -550,8 +576,9 @@ const ( ) // Values returns all known values for OperatingSystemName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperatingSystemName) Values() []OperatingSystemName { return []OperatingSystemName{ "AMAZON_LINUX_2", @@ -577,8 +604,9 @@ const ( ) // Values returns all known values for OperatingSystemType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (OperatingSystemType) Values() []OperatingSystemType { return []OperatingSystemType{ "WINDOWS", @@ -595,8 +623,9 @@ const ( ) // Values returns all known values for Protocol. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Protocol) Values() []Protocol { return []Protocol{ "PCOIP", @@ -613,8 +642,9 @@ const ( ) // Values returns all known values for ReconnectEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ReconnectEnum) Values() []ReconnectEnum { return []ReconnectEnum{ "ENABLED", @@ -632,8 +662,9 @@ const ( ) // Values returns all known values for RunningMode. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (RunningMode) Values() []RunningMode { return []RunningMode{ "AUTO_STOP", @@ -652,8 +683,9 @@ const ( ) // Values returns all known values for SamlStatusEnum. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SamlStatusEnum) Values() []SamlStatusEnum { return []SamlStatusEnum{ "DISABLED", @@ -672,8 +704,9 @@ const ( // Values returns all known values for StandbyWorkspaceRelationshipType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (StandbyWorkspaceRelationshipType) Values() []StandbyWorkspaceRelationshipType { return []StandbyWorkspaceRelationshipType{ "PRIMARY", @@ -690,8 +723,9 @@ const ( ) // Values returns all known values for TargetWorkspaceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetWorkspaceState) Values() []TargetWorkspaceState { return []TargetWorkspaceState{ "AVAILABLE", @@ -708,8 +742,9 @@ const ( ) // Values returns all known values for Tenancy. Note that this can be expanded in -// the future, and so it is only as up to date as the client. The ordering of this -// slice is not guaranteed to be stable across updates. +// the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (Tenancy) Values() []Tenancy { return []Tenancy{ "DEDICATED", @@ -727,8 +762,9 @@ const ( // Values returns all known values for WorkSpaceApplicationLicenseType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkSpaceApplicationLicenseType) Values() []WorkSpaceApplicationLicenseType { return []WorkSpaceApplicationLicenseType{ "LICENSED", @@ -748,6 +784,7 @@ const ( // Values returns all known values for WorkSpaceApplicationState. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (WorkSpaceApplicationState) Values() []WorkSpaceApplicationState { return []WorkSpaceApplicationState{ @@ -767,8 +804,9 @@ const ( // Values returns all known values for WorkSpaceAssociatedResourceType. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkSpaceAssociatedResourceType) Values() []WorkSpaceAssociatedResourceType { return []WorkSpaceAssociatedResourceType{ "APPLICATION", @@ -785,8 +823,9 @@ const ( ) // Values returns all known values for WorkspaceBundleState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceBundleState) Values() []WorkspaceBundleState { return []WorkspaceBundleState{ "AVAILABLE", @@ -807,8 +846,9 @@ const ( ) // Values returns all known values for WorkspaceDirectoryState. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceDirectoryState) Values() []WorkspaceDirectoryState { return []WorkspaceDirectoryState{ "REGISTERING", @@ -828,8 +868,9 @@ const ( ) // Values returns all known values for WorkspaceDirectoryType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceDirectoryType) Values() []WorkspaceDirectoryType { return []WorkspaceDirectoryType{ "SIMPLE_AD", @@ -871,8 +912,9 @@ const ( // Values returns all known values for WorkspaceImageErrorDetailCode. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceImageErrorDetailCode) Values() []WorkspaceImageErrorDetailCode { return []WorkspaceImageErrorDetailCode{ "OutdatedPowershellVersion", @@ -919,8 +961,9 @@ const ( // Values returns all known values for WorkspaceImageIngestionProcess. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceImageIngestionProcess) Values() []WorkspaceImageIngestionProcess { return []WorkspaceImageIngestionProcess{ "BYOL_REGULAR", @@ -943,8 +986,9 @@ const ( // Values returns all known values for WorkspaceImageRequiredTenancy. Note that // this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceImageRequiredTenancy) Values() []WorkspaceImageRequiredTenancy { return []WorkspaceImageRequiredTenancy{ "DEFAULT", @@ -962,8 +1006,9 @@ const ( ) // Values returns all known values for WorkspaceImageState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceImageState) Values() []WorkspaceImageState { return []WorkspaceImageState{ "AVAILABLE", @@ -996,8 +1041,9 @@ const ( ) // Values returns all known values for WorkspaceState. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (WorkspaceState) Values() []WorkspaceState { return []WorkspaceState{ "PENDING", diff --git a/service/workspaces/types/errors.go b/service/workspaces/types/errors.go index a2e5d249e32..e9ee47d6a7a 100644 --- a/service/workspaces/types/errors.go +++ b/service/workspaces/types/errors.go @@ -488,8 +488,9 @@ 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]. +// +// [Configure a VPC for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html type UnsupportedNetworkConfigurationException struct { Message *string @@ -518,9 +519,9 @@ 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) -// . +// more information, see [Required Configuration and Service Components for WorkSpaces]. +// +// [Required Configuration and Service Components for WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html type UnsupportedWorkspaceConfigurationException struct { Message *string @@ -578,8 +579,9 @@ func (e *ValidationException) ErrorFault() smithy.ErrorFault { return smithy.Fau // 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]. +// +// [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 c0c6351a202..4131d23e46d 100644 --- a/service/workspaces/types/types.go +++ b/service/workspaces/types/types.go @@ -190,9 +190,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]. +// +// [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. @@ -217,9 +217,9 @@ 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]. +// +// [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 @@ -241,9 +241,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]. +// +// [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 @@ -276,8 +276,10 @@ type DataReplicationSettings struct { } // Returns default client branding attributes that were imported. These attributes -// display on the client login screen. Client branding attributes are public -// facing. Ensure that you don't include sensitive information. +// display on the client login screen. +// +// Client branding attributes are public facing. Ensure that you don't include +// sensitive information. type DefaultClientBrandingAttributes struct { // The forgotten password link. This is the web address that users can go to if @@ -296,17 +298,21 @@ 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 . 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 . SupportLink *string @@ -314,8 +320,10 @@ type DefaultClientBrandingAttributes struct { } // The default client branding attributes to be imported. These attributes display -// on the client login screen. Client branding attributes are public facing. Ensure -// that you do not include sensitive information. +// on the client login screen. +// +// Client branding attributes are public facing. Ensure that you do not include +// sensitive information. type DefaultImportClientBrandingAttributes struct { // The forgotten password link. This is the web address that users can go to if @@ -334,17 +342,21 @@ 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 . 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 . SupportLink *string @@ -352,13 +364,15 @@ type DefaultImportClientBrandingAttributes struct { } // 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]. +// +// [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]. + // + // [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 @@ -373,13 +387,15 @@ 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]. + // + // [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]. + // + // [WorkSpace Maintenance]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html EnableMaintenanceMode *bool // Specifies whether the directory is enabled for Amazon WorkDocs. @@ -436,10 +452,8 @@ 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. @@ -456,9 +470,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]. +// +// [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 @@ -496,8 +510,10 @@ type ImageResourceAssociation struct { } // The client branding attributes for iOS device types. These attributes are -// displayed on the iOS client login screen only. Client branding attributes are -// public facing. Ensure you do not include sensitive information. +// displayed on the iOS client login screen only. +// +// Client branding attributes are public facing. Ensure you do not include +// sensitive information. type IosClientBrandingAttributes struct { // The forgotten password link. This is the web address that users can go to if @@ -513,16 +529,22 @@ type IosClientBrandingAttributes struct { // 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/) - // in the Apple Human Interface Guidelines. + // object that is converted from a .png file. + // + // For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple + // Human Interface Guidelines. + // + // [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/ 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 - // 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/) - // in the Apple Human Interface Guidelines. + // object that is converted from a .png file. + // + // For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple + // Human Interface Guidelines. + // + // [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/ Logo3xUrl *string // The logo. This is the standard-resolution display that has a 1:1 pixel density @@ -531,17 +553,21 @@ 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 . 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 . SupportLink *string @@ -549,8 +575,10 @@ type IosClientBrandingAttributes struct { } // The client branding attributes to import for iOS device types. These attributes -// are displayed on the iOS client login screen. Client branding attributes are -// public facing. Ensure you do not include sensitive information. +// are displayed on the iOS client login screen. +// +// Client branding attributes are public facing. Ensure you do not include +// sensitive information. type IosImportClientBrandingAttributes struct { // The forgotten password link. This is the web address that users can go to if @@ -571,30 +599,40 @@ type IosImportClientBrandingAttributes struct { // 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/) - // in the Apple Human Interface Guidelines. + // object that is converted from a .png file. + // + // For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple + // Human Interface Guidelines. + // + // [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/ 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 - // 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/) - // in the Apple Human Interface Guidelines. + // object that is converted from a .png file. + // + // For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple + // Human Interface Guidelines. + // + // [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/ 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 . 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 . SupportLink *string @@ -643,10 +681,13 @@ type PendingCreateStandbyWorkspacesRequest struct { // The operational state of the standby WorkSpace. State WorkspaceState - // 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) + // 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] // before the WorkSpace is created, the information returned can be incomplete. + // + // [DescribeWorkspaces]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html UserName *string // The identifier of the standby WorkSpace. @@ -714,18 +755,23 @@ type SamlProperties struct { // (IdP). When the end user is redirected to the user access URL from the // WorkSpaces client application, this relay state parameter name is appended as a // query parameter to the URL along with the relay state endpoint to return the - // user to the client application session. To use SAML 2.0 authentication with - // WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state - // URL. Consult your IdP documentation for more information. + // user to the client application session. + // + // To use SAML 2.0 authentication with WorkSpaces, the IdP must support + // IdP-initiated deep linking for the relay state URL. Consult your IdP + // documentation for more information. RelayStateParameterName *string // 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 @@ -741,8 +787,9 @@ 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]. +// +// [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 @@ -862,8 +909,9 @@ type TerminateRequest struct { } // Describes whether a WorkSpace image needs to be updated with the latest drivers -// and other components required by Amazon WorkSpaces. Only Windows 10 WorkSpace -// images can be programmatically updated at this time. +// and other components required by Amazon WorkSpaces. +// +// Only Windows 10 WorkSpace images can be programmatically updated at this time. type UpdateResult struct { // A description of whether updates for the WorkSpace image are pending or @@ -893,8 +941,9 @@ 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]. + // + // [Launch a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html ComputerName *string // Indicates the settings of the data replication. @@ -926,33 +975,52 @@ type Workspace struct { StandbyWorkspacesProperties []StandbyWorkspacesProperties // The operational state of the WorkSpace. + // // - PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is // being created). + // // - AVAILABLE – The WorkSpace is running and has passed the health checks. + // // - IMPAIRED – Refer to UNHEALTHY state. + // // - UNHEALTHY – The WorkSpace is not responding to health checks. + // // - REBOOTING – The WorkSpace is being rebooted (restarted). + // // - STARTING – The WorkSpace is starting up and health checks are being run. + // // - REBUILDING – The WorkSpace is being rebuilt. + // // - RESTORING – The WorkSpace is being restored. + // // - MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon // Web Services. + // // - ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the // WorkSpaces administrator. + // // - TERMINATING – The WorkSpace is being deleted. + // // - TERMINATED – The WorkSpace has been deleted. + // // - SUSPENDED – The WorkSpace has been suspended for image creation. + // // - UPDATING – The WorkSpace is undergoing an update. + // // - STOPPING – The WorkSpace is being stopped. + // // - STOPPED – The WorkSpace has been stopped. + // // - ERROR – The WorkSpace is an error state (for example, an error occurred // during startup). + // // 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. + // by using [DescribeWorkSpaces]. If the WorkSpace ID isn't returned, then the WorkSpace has been + // successfully terminated. + // + // [DescribeWorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html State WorkspaceState // The identifier of the subnet for the WorkSpace. @@ -981,8 +1049,9 @@ 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]. +// +// [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 @@ -1064,8 +1133,9 @@ type WorkspaceBundle struct { // The type of WorkSpace bundle. BundleType BundleType - // The compute type of the bundle. For more information, see Amazon WorkSpaces - // Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles) . + // The compute type of the bundle. For more information, see [Amazon WorkSpaces Bundles]. + // + // [Amazon WorkSpaces Bundles]: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles ComputeType *ComputeType // The time when the bundle was created. @@ -1119,8 +1189,9 @@ type WorkspaceConnectionStatus struct { } // 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) -// . +// more information, see [Update Directory Details for Your WorkSpaces]. +// +// [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. @@ -1132,31 +1203,39 @@ type WorkspaceCreationProperties struct { // "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. + // escaped. For more information, see [Distinguished Names]in the Microsoft documentation. + // // - The API doesn't validate whether the OU exists. + // + // [Distinguished Names]: https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names 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]. + // + // [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 - // 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. + // 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]in the Amazon WorkDocs Administration Guide. To + // delete a WorkDocs site, see [Deleting a Site]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. + // + // [Deleting a Site]: https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html + // [Disabling Users]: https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html EnableWorkDocs *bool // Indicates whether users are local administrators of their WorkSpaces. @@ -1214,18 +1293,20 @@ 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]. If the directory ID isn't returned, then the directory has been successfully // deregistered. + // + // [DescribeWorkspaceDirectories]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html State WorkspaceDirectoryState // The identifiers of the subnets used with the directory. 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] // . + // + // [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. @@ -1275,8 +1356,9 @@ type WorkspaceImage 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.html) - // . + // information, see [Bring Your Own Windows Desktop Images]. + // + // [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. @@ -1291,30 +1373,39 @@ 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]. + // + // [Amazon WorkSpaces Bundles]: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles ComputeTypeName Compute // The name of the operating system. OperatingSystemName OperatingSystemName - // The protocol. For more information, see Protocols for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html) - // . + // The protocol. For more information, see [Protocols for Amazon WorkSpaces]. + // // - 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 for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html 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]. + // + // [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 - // account team to be allow-listed to use this value. For more information, see - // Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) . + // The running mode. For more information, see [Manage the WorkSpace Running Mode]. + // + // 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]. + // + // [Manage the WorkSpace Running Mode]: https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html + // [Amazon WorkSpaces Core]: http://aws.amazon.com/workspaces/core/ RunningMode RunningMode // The time after a user logs off when WorkSpaces are automatically stopped. @@ -1322,8 +1413,9 @@ 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]. + // + // [Modify a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html UserVolumeSizeGib *int32 noSmithyDocumentSerde @@ -1332,21 +1424,23 @@ type WorkspaceProperties struct { // Describes the information used to create a WorkSpace. type WorkspaceRequest struct { - // The identifier of the bundle for the WorkSpace. You can use - // DescribeWorkspaceBundles to list the available bundles. + // The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the + // available bundles. // // 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. + // use DescribeWorkspaceDirectoriesto list the available directories. // // This member is required. DirectoryId *string // The user name of the user for the WorkSpace. This user name must exist in the - // Directory Service directory for the WorkSpace. The reserved keyword, [UNDEFINED] - // , is used when creating user-decoupled WorkSpaces. + // Directory Service directory for the WorkSpace. + // + // The reserved keyword, [UNDEFINED] , is used when creating user-decoupled + // WorkSpaces. // // This member is required. UserName *string diff --git a/service/workspacesthinclient/api_op_CreateEnvironment.go b/service/workspacesthinclient/api_op_CreateEnvironment.go index e6c1cf3c76c..5d28c4e835e 100644 --- a/service/workspacesthinclient/api_op_CreateEnvironment.go +++ b/service/workspacesthinclient/api_op_CreateEnvironment.go @@ -39,10 +39,15 @@ type CreateEnvironmentInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // The ID of the software set to apply. diff --git a/service/workspacesthinclient/api_op_DeleteDevice.go b/service/workspacesthinclient/api_op_DeleteDevice.go index 160d74f143b..dcb4406cc17 100644 --- a/service/workspacesthinclient/api_op_DeleteDevice.go +++ b/service/workspacesthinclient/api_op_DeleteDevice.go @@ -37,10 +37,15 @@ type DeleteDeviceInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/workspacesthinclient/api_op_DeleteEnvironment.go b/service/workspacesthinclient/api_op_DeleteEnvironment.go index 6a935ee3bcc..634adc08fdb 100644 --- a/service/workspacesthinclient/api_op_DeleteEnvironment.go +++ b/service/workspacesthinclient/api_op_DeleteEnvironment.go @@ -37,10 +37,15 @@ type DeleteEnvironmentInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string noSmithyDocumentSerde diff --git a/service/workspacesthinclient/api_op_DeregisterDevice.go b/service/workspacesthinclient/api_op_DeregisterDevice.go index 9741ac3c4e0..ed2a124f820 100644 --- a/service/workspacesthinclient/api_op_DeregisterDevice.go +++ b/service/workspacesthinclient/api_op_DeregisterDevice.go @@ -38,10 +38,15 @@ type DeregisterDeviceInput 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. If you retry the operation with the same ClientToken , but with - // different parameters, the retry fails with an IdempotentParameterMismatch error. + // all other parameters. We recommend that you use a [UUID type of value]. + // + // If you don't provide this value, then Amazon Web Services generates a random + // one for you. + // + // If you retry the operation with the same ClientToken , but with different + // parameters, the retry fails with an IdempotentParameterMismatch error. + // + // [UUID type of value]: https://wikipedia.org/wiki/Universally_unique_identifier ClientToken *string // The desired new status for the device. diff --git a/service/workspacesthinclient/api_op_ListDevices.go b/service/workspacesthinclient/api_op_ListDevices.go index fee0a8c97e1..ef9f301ff5d 100644 --- a/service/workspacesthinclient/api_op_ListDevices.go +++ b/service/workspacesthinclient/api_op_ListDevices.go @@ -30,8 +30,10 @@ func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optF type ListDevicesInput struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -178,8 +180,10 @@ var _ ListDevicesAPIClient = (*Client)(nil) // ListDevicesPaginatorOptions is the paginator options for ListDevices type ListDevicesPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/workspacesthinclient/api_op_ListEnvironments.go b/service/workspacesthinclient/api_op_ListEnvironments.go index 8511dd8259f..50b6f19ab78 100644 --- a/service/workspacesthinclient/api_op_ListEnvironments.go +++ b/service/workspacesthinclient/api_op_ListEnvironments.go @@ -30,8 +30,10 @@ func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsI type ListEnvironmentsInput struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -179,8 +181,10 @@ var _ ListEnvironmentsAPIClient = (*Client)(nil) // ListEnvironmentsPaginatorOptions is the paginator options for ListEnvironments type ListEnvironmentsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/workspacesthinclient/api_op_ListSoftwareSets.go b/service/workspacesthinclient/api_op_ListSoftwareSets.go index 3854035e8cb..9850fcb7477 100644 --- a/service/workspacesthinclient/api_op_ListSoftwareSets.go +++ b/service/workspacesthinclient/api_op_ListSoftwareSets.go @@ -30,8 +30,10 @@ func (c *Client) ListSoftwareSets(ctx context.Context, params *ListSoftwareSetsI type ListSoftwareSetsInput struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. MaxResults *int32 // If nextToken is returned, there are more results available. The value of @@ -179,8 +181,10 @@ var _ ListSoftwareSetsAPIClient = (*Client)(nil) // ListSoftwareSetsPaginatorOptions is the paginator options for ListSoftwareSets type ListSoftwareSetsPaginatorOptions struct { // The maximum number of results that are returned per call. You can use nextToken - // to obtain further pages of results. This is only an upper limit. The actual - // number of results returned per call might be fewer than the specified maximum. + // to obtain further pages of results. + // + // This is only an upper limit. The actual number of results returned per call + // might be fewer than the specified maximum. Limit int32 // Set to true if pagination should stop if the service returns a pagination token diff --git a/service/workspacesthinclient/doc.go b/service/workspacesthinclient/doc.go index e303c1baab3..f2f344c6046 100644 --- a/service/workspacesthinclient/doc.go +++ b/service/workspacesthinclient/doc.go @@ -10,12 +10,14 @@ // headset, and webcam. To maximize endpoint security, WorkSpaces Thin Client // devices do not allow local data storage or installation of unapproved // applications. The WorkSpaces Thin Client device ships preloaded with device -// management software. You can use these APIs to complete WorkSpaces Thin Client -// tasks, such as creating environments or viewing devices. For more information -// about WorkSpaces Thin Client, including the required permissions to use the -// service, see the Amazon WorkSpaces Thin Client Administrator Guide (https://docs.aws.amazon.com/workspaces-thin-client/latest/ag/) -// . For more information about using the Command Line Interface (CLI) to manage -// your WorkSpaces Thin Client resources, see the WorkSpaces Thin Client section -// of the CLI Reference (https://docs.aws.amazon.com/cli/latest/reference/workspaces-thin-client/index.html) -// . +// management software. +// +// You can use these APIs to complete WorkSpaces Thin Client tasks, such as +// creating environments or viewing devices. For more information about WorkSpaces +// Thin Client, including the required permissions to use the service, see the [Amazon WorkSpaces Thin Client Administrator Guide]. +// For more information about using the Command Line Interface (CLI) to manage your +// WorkSpaces Thin Client resources, see the [WorkSpaces Thin Client section of the CLI Reference]. +// +// [Amazon WorkSpaces Thin Client Administrator Guide]: https://docs.aws.amazon.com/workspaces-thin-client/latest/ag/ +// [WorkSpaces Thin Client section of the CLI Reference]: https://docs.aws.amazon.com/cli/latest/reference/workspaces-thin-client/index.html package workspacesthinclient diff --git a/service/workspacesthinclient/options.go b/service/workspacesthinclient/options.go index 48b7ff835ab..74b713b4028 100644 --- a/service/workspacesthinclient/options.go +++ b/service/workspacesthinclient/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/workspacesthinclient/types/enums.go b/service/workspacesthinclient/types/enums.go index 97420859dd1..97e7c14f871 100644 --- a/service/workspacesthinclient/types/enums.go +++ b/service/workspacesthinclient/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for ApplyTimeOf. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (ApplyTimeOf) Values() []ApplyTimeOf { return []ApplyTimeOf{ "UTC", @@ -34,8 +35,9 @@ const ( ) // 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. +// in the future, and so 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", @@ -58,8 +60,9 @@ const ( ) // Values returns all known values for DesktopType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DesktopType) Values() []DesktopType { return []DesktopType{ "workspaces", @@ -79,8 +82,9 @@ const ( // Values returns all known values for DeviceSoftwareSetComplianceStatus. Note // that this can be expanded in the future, and so it is only as up to date as the -// client. The ordering of this slice is not guaranteed to be stable across -// updates. +// client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (DeviceSoftwareSetComplianceStatus) Values() []DeviceSoftwareSetComplianceStatus { return []DeviceSoftwareSetComplianceStatus{ "NONE", @@ -100,8 +104,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "REGISTERED", @@ -122,8 +127,9 @@ const ( // Values returns all known values for EnvironmentSoftwareSetComplianceStatus. // Note that this can be expanded in the future, and so it is only as up to date as -// the client. The ordering of this slice is not guaranteed to be stable across -// updates. +// the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnvironmentSoftwareSetComplianceStatus) Values() []EnvironmentSoftwareSetComplianceStatus { return []EnvironmentSoftwareSetComplianceStatus{ "NO_REGISTERED_DEVICES", @@ -141,8 +147,9 @@ const ( ) // Values returns all known values for MaintenanceWindowType. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (MaintenanceWindowType) Values() []MaintenanceWindowType { return []MaintenanceWindowType{ "SYSTEM", @@ -159,8 +166,9 @@ const ( ) // Values returns all known values for SoftwareSetUpdateMode. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SoftwareSetUpdateMode) Values() []SoftwareSetUpdateMode { return []SoftwareSetUpdateMode{ "USE_LATEST", @@ -178,6 +186,7 @@ const ( // Values returns all known values for SoftwareSetUpdateSchedule. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SoftwareSetUpdateSchedule) Values() []SoftwareSetUpdateSchedule { return []SoftwareSetUpdateSchedule{ @@ -196,8 +205,9 @@ const ( ) // Values returns all known values for SoftwareSetUpdateStatus. Note that this can -// be expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// be expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SoftwareSetUpdateStatus) Values() []SoftwareSetUpdateStatus { return []SoftwareSetUpdateStatus{ "AVAILABLE", @@ -216,6 +226,7 @@ const ( // Values returns all known values for SoftwareSetValidationStatus. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (SoftwareSetValidationStatus) Values() []SoftwareSetValidationStatus { return []SoftwareSetValidationStatus{ @@ -233,8 +244,9 @@ const ( ) // Values returns all known values for TargetDeviceStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TargetDeviceStatus) Values() []TargetDeviceStatus { return []TargetDeviceStatus{ "DEREGISTERED", @@ -254,6 +266,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/workspacesweb/api_op_CreateBrowserSettings.go b/service/workspacesweb/api_op_CreateBrowserSettings.go index 86a58864c6c..b4e7b6fe237 100644 --- a/service/workspacesweb/api_op_CreateBrowserSettings.go +++ b/service/workspacesweb/api_op_CreateBrowserSettings.go @@ -44,8 +44,10 @@ type CreateBrowserSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The custom managed key of the browser settings. diff --git a/service/workspacesweb/api_op_CreateIdentityProvider.go b/service/workspacesweb/api_op_CreateIdentityProvider.go index a1653cf77e8..c4fb02a3a9b 100644 --- a/service/workspacesweb/api_op_CreateIdentityProvider.go +++ b/service/workspacesweb/api_op_CreateIdentityProvider.go @@ -31,38 +31,69 @@ 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 + // // - IDPInit (boolean) optional + // // - RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 + // // - EncryptedResponses (boolean) optional // // This member is required. @@ -87,8 +118,10 @@ type CreateIdentityProviderInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string noSmithyDocumentSerde diff --git a/service/workspacesweb/api_op_CreateIpAccessSettings.go b/service/workspacesweb/api_op_CreateIpAccessSettings.go index 02b567e75ab..ebbef3ad84a 100644 --- a/service/workspacesweb/api_op_CreateIpAccessSettings.go +++ b/service/workspacesweb/api_op_CreateIpAccessSettings.go @@ -41,8 +41,10 @@ type CreateIpAccessSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The custom managed key of the IP access settings. diff --git a/service/workspacesweb/api_op_CreateNetworkSettings.go b/service/workspacesweb/api_op_CreateNetworkSettings.go index 66b51019108..e35eb32d605 100644 --- a/service/workspacesweb/api_op_CreateNetworkSettings.go +++ b/service/workspacesweb/api_op_CreateNetworkSettings.go @@ -53,8 +53,10 @@ type CreateNetworkSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The tags to add to the network settings resource. A tag is a key-value pair. diff --git a/service/workspacesweb/api_op_CreatePortal.go b/service/workspacesweb/api_op_CreatePortal.go index 62a6785b9a6..6ea0b6bde56 100644 --- a/service/workspacesweb/api_op_CreatePortal.go +++ b/service/workspacesweb/api_op_CreatePortal.go @@ -33,22 +33,27 @@ 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 - // 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. IAM Identity - // Center web portals are authenticated through IAM Identity Center (successor to - // Single Sign-On). Identity sources (including external identity provider - // integration), plus user and group access to your web portal, can be configured - // in the IAM Identity Center. + // 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. + // + // IAM Identity Center web portals are authenticated through IAM Identity Center + // (successor to Single Sign-On). Identity sources (including external identity + // provider integration), plus user and group access to your web portal, can be + // configured in the IAM Identity Center. AuthenticationType types.AuthenticationType // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The customer managed key of the web portal. diff --git a/service/workspacesweb/api_op_CreateTrustStore.go b/service/workspacesweb/api_op_CreateTrustStore.go index 493702d3b5b..aec4b35b19c 100644 --- a/service/workspacesweb/api_op_CreateTrustStore.go +++ b/service/workspacesweb/api_op_CreateTrustStore.go @@ -43,8 +43,10 @@ type CreateTrustStoreInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The tags to add to the trust store. A tag is a key-value pair. diff --git a/service/workspacesweb/api_op_CreateUserAccessLoggingSettings.go b/service/workspacesweb/api_op_CreateUserAccessLoggingSettings.go index 2e75d796f96..2816f688252 100644 --- a/service/workspacesweb/api_op_CreateUserAccessLoggingSettings.go +++ b/service/workspacesweb/api_op_CreateUserAccessLoggingSettings.go @@ -39,8 +39,10 @@ type CreateUserAccessLoggingSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The tags to add to the user settings resource. A tag is a key-value pair. diff --git a/service/workspacesweb/api_op_CreateUserSettings.go b/service/workspacesweb/api_op_CreateUserSettings.go index acc1d0b74c7..ffca89404d7 100644 --- a/service/workspacesweb/api_op_CreateUserSettings.go +++ b/service/workspacesweb/api_op_CreateUserSettings.go @@ -67,8 +67,10 @@ type CreateUserSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The configuration that specifies which cookies should be synchronized from the diff --git a/service/workspacesweb/api_op_TagResource.go b/service/workspacesweb/api_op_TagResource.go index a46bf836161..707552ea457 100644 --- a/service/workspacesweb/api_op_TagResource.go +++ b/service/workspacesweb/api_op_TagResource.go @@ -43,8 +43,10 @@ type TagResourceInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token returns the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string noSmithyDocumentSerde diff --git a/service/workspacesweb/api_op_UpdateBrowserSettings.go b/service/workspacesweb/api_op_UpdateBrowserSettings.go index e4eaafde341..b8485fdab64 100644 --- a/service/workspacesweb/api_op_UpdateBrowserSettings.go +++ b/service/workspacesweb/api_op_UpdateBrowserSettings.go @@ -42,8 +42,10 @@ type UpdateBrowserSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string noSmithyDocumentSerde diff --git a/service/workspacesweb/api_op_UpdateIdentityProvider.go b/service/workspacesweb/api_op_UpdateIdentityProvider.go index 43dc963e662..27a46adda27 100644 --- a/service/workspacesweb/api_op_UpdateIdentityProvider.go +++ b/service/workspacesweb/api_op_UpdateIdentityProvider.go @@ -38,44 +38,77 @@ type UpdateIdentityProviderInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // 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 + // // - IDPInit (boolean) optional + // // - RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 + // // - EncryptedResponses (boolean) optional IdentityProviderDetails map[string]string diff --git a/service/workspacesweb/api_op_UpdateIpAccessSettings.go b/service/workspacesweb/api_op_UpdateIpAccessSettings.go index 1cc4abc2ef7..d3b44d9e092 100644 --- a/service/workspacesweb/api_op_UpdateIpAccessSettings.go +++ b/service/workspacesweb/api_op_UpdateIpAccessSettings.go @@ -38,8 +38,10 @@ type UpdateIpAccessSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The description of the IP access settings. diff --git a/service/workspacesweb/api_op_UpdateNetworkSettings.go b/service/workspacesweb/api_op_UpdateNetworkSettings.go index 0775fdac286..971945f4d27 100644 --- a/service/workspacesweb/api_op_UpdateNetworkSettings.go +++ b/service/workspacesweb/api_op_UpdateNetworkSettings.go @@ -38,8 +38,10 @@ type UpdateNetworkSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // One or more security groups used to control access from streaming instances to diff --git a/service/workspacesweb/api_op_UpdatePortal.go b/service/workspacesweb/api_op_UpdatePortal.go index b878e1c1e6b..f496199ceef 100644 --- a/service/workspacesweb/api_op_UpdatePortal.go +++ b/service/workspacesweb/api_op_UpdatePortal.go @@ -35,14 +35,17 @@ 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 - // 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. IAM Identity - // Center web portals are authenticated through IAM Identity Center (successor to - // Single Sign-On). Identity sources (including external identity provider - // integration), plus user and group access to your web portal, can be configured - // in the IAM Identity Center. + // 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. + // + // IAM Identity Center web portals are authenticated through IAM Identity Center + // (successor to Single Sign-On). Identity sources (including external identity + // provider integration), plus user and group access to your web portal, can be + // configured in the IAM Identity Center. AuthenticationType types.AuthenticationType // The name of the web portal. This is not visible to users who log into the web diff --git a/service/workspacesweb/api_op_UpdateTrustStore.go b/service/workspacesweb/api_op_UpdateTrustStore.go index 5d858a12ba5..5943c90ffd8 100644 --- a/service/workspacesweb/api_op_UpdateTrustStore.go +++ b/service/workspacesweb/api_op_UpdateTrustStore.go @@ -43,8 +43,10 @@ type UpdateTrustStoreInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string noSmithyDocumentSerde diff --git a/service/workspacesweb/api_op_UpdateUserAccessLoggingSettings.go b/service/workspacesweb/api_op_UpdateUserAccessLoggingSettings.go index 6e4dbc29148..70dc4c0fea0 100644 --- a/service/workspacesweb/api_op_UpdateUserAccessLoggingSettings.go +++ b/service/workspacesweb/api_op_UpdateUserAccessLoggingSettings.go @@ -38,8 +38,10 @@ type UpdateUserAccessLoggingSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The ARN of the Kinesis stream. diff --git a/service/workspacesweb/api_op_UpdateUserSettings.go b/service/workspacesweb/api_op_UpdateUserSettings.go index dd36ae004c6..b44ec5b243b 100644 --- a/service/workspacesweb/api_op_UpdateUserSettings.go +++ b/service/workspacesweb/api_op_UpdateUserSettings.go @@ -38,13 +38,16 @@ type UpdateUserSettingsInput struct { // of the request. Idempotency ensures that an API request completes only once. // With an idempotent request, if the original request completes successfully, // subsequent retries with the same client token return the result from the - // original successful request. If you do not specify a client token, one is - // automatically generated by the Amazon Web Services SDK. + // original successful request. + // + // If you do not specify a client token, one is automatically generated by the + // Amazon Web Services SDK. ClientToken *string // The configuration that specifies which cookies should be synchronized from the - // end user's local browser to the remote browser. If the allowlist and blocklist - // are empty, the configuration becomes null. + // end user's local browser to the remote browser. + // + // If the allowlist and blocklist are empty, the configuration becomes null. CookieSynchronizationConfiguration *types.CookieSynchronizationConfiguration // Specifies whether the user can copy text from the streaming session to the diff --git a/service/workspacesweb/options.go b/service/workspacesweb/options.go index 453592286e9..717e8e41e71 100644 --- a/service/workspacesweb/options.go +++ b/service/workspacesweb/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -74,17 +76,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -101,8 +106,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -147,6 +153,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/workspacesweb/types/enums.go b/service/workspacesweb/types/enums.go index d200cf8c4eb..c8b6bf88c05 100644 --- a/service/workspacesweb/types/enums.go +++ b/service/workspacesweb/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for AuthenticationType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (AuthenticationType) Values() []AuthenticationType { return []AuthenticationType{ "Standard", @@ -28,8 +29,9 @@ const ( ) // Values returns all known values for BrowserType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (BrowserType) Values() []BrowserType { return []BrowserType{ "Chrome", @@ -45,8 +47,9 @@ const ( ) // Values returns all known values for EnabledType. Note that this can be expanded -// in the future, and so it is only as up to date as the client. The ordering of -// this slice is not guaranteed to be stable across updates. +// in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EnabledType) Values() []EnabledType { return []EnabledType{ "Disabled", @@ -67,8 +70,9 @@ const ( ) // Values returns all known values for IdentityProviderType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (IdentityProviderType) Values() []IdentityProviderType { return []IdentityProviderType{ "SAML", @@ -90,8 +94,9 @@ const ( ) // 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. +// expanded in the future, and so 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{ "standard.regular", @@ -110,8 +115,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -128,8 +134,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -148,6 +155,7 @@ const ( // Values returns all known values for ValidationExceptionReason. Note that this // can be expanded in the future, and so it is only as up to date as the client. +// // The ordering of this slice is not guaranteed to be stable across updates. func (ValidationExceptionReason) Values() []ValidationExceptionReason { return []ValidationExceptionReason{ diff --git a/service/workspacesweb/types/types.go b/service/workspacesweb/types/types.go index a6b7514bf04..0055821e628 100644 --- a/service/workspacesweb/types/types.go +++ b/service/workspacesweb/types/types.go @@ -134,38 +134,69 @@ 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 (boolean) optional + // // - IDPInit (boolean) optional + // // - RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256 + // // - EncryptedResponses (boolean) optional IdentityProviderDetails map[string]string @@ -220,7 +251,7 @@ type IpAccessSettings struct { // The description of the IP access settings. Description *string - // The display name of the IP access settings. + // The display name of the IP access settings. DisplayName *string // The IP rules of the IP access settings. @@ -317,14 +348,17 @@ type Portal 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 - // 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. IAM Identity - // Center web portals are authenticated through IAM Identity Center (successor to - // Single Sign-On). Identity sources (including external identity provider - // integration), plus user and group access to your web portal, can be configured - // in the IAM Identity Center. + // 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. + // + // IAM Identity Center web portals are authenticated through IAM Identity Center + // (successor to Single Sign-On). Identity sources (including external identity + // provider integration), plus user and group access to your web portal, can be + // configured in the IAM Identity Center. AuthenticationType AuthenticationType // The ARN of the browser settings that is associated with this web portal. @@ -389,14 +423,17 @@ type PortalSummary 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 - // 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. IAM Identity - // Center web portals are authenticated through IAM Identity Center (successor to - // Single Sign-On). Identity sources (including external identity provider - // integration), plus user and group access to your web portal, can be configured - // in the IAM Identity Center. + // 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. + // + // IAM Identity Center web portals are authenticated through IAM Identity Center + // (successor to Single Sign-On). Identity sources (including external identity + // provider integration), plus user and group access to your web portal, can be + // configured in the IAM Identity Center. AuthenticationType AuthenticationType // The ARN of the browser settings that is associated with the web portal. diff --git a/service/xray/api_op_CreateGroup.go b/service/xray/api_op_CreateGroup.go index 80b63f69230..fd47d06f6ca 100644 --- a/service/xray/api_op_CreateGroup.go +++ b/service/xray/api_op_CreateGroup.go @@ -39,26 +39,36 @@ 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. 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: + // group. For more information about ways to use tags, see [Tagging Amazon Web Services resources]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. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/xray/api_op_CreateSamplingRule.go b/service/xray/api_op_CreateSamplingRule.go index 425547bd1bf..b886a2695af 100644 --- a/service/xray/api_op_CreateSamplingRule.go +++ b/service/xray/api_op_CreateSamplingRule.go @@ -12,12 +12,15 @@ 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], 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]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. +// +// [GetSamplingTargets]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html +// [GetSamplingRules]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html func (c *Client) CreateSamplingRule(ctx context.Context, params *CreateSamplingRuleInput, optFns ...func(*Options)) (*CreateSamplingRuleOutput, error) { if params == nil { params = &CreateSamplingRuleInput{} @@ -41,18 +44,26 @@ type CreateSamplingRuleInput struct { SamplingRule *types.SamplingRule // 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: + // sampling rule. For more information about ways to use tags, see [Tagging Amazon Web Services resources]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. + // + // [Tagging Amazon Web Services resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html Tags []types.Tag noSmithyDocumentSerde diff --git a/service/xray/api_op_GetSamplingTargets.go b/service/xray/api_op_GetSamplingTargets.go index 6fed4135afd..e803162131d 100644 --- a/service/xray/api_op_GetSamplingTargets.go +++ b/service/xray/api_op_GetSamplingTargets.go @@ -43,15 +43,17 @@ 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]to get the latest version. + // + // [GetSamplingRules]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html 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) - // that X-Ray could not process. + // Information about [SamplingStatisticsDocument] that X-Ray could not process. + // + // [SamplingStatisticsDocument]: https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html UnprocessedStatistics []types.UnprocessedStatistics // Metadata pertaining to the operation's result. diff --git a/service/xray/api_op_GetServiceGraph.go b/service/xray/api_op_GetServiceGraph.go index edc1df80ae9..edc436f8577 100644 --- a/service/xray/api_op_GetServiceGraph.go +++ b/service/xray/api_op_GetServiceGraph.go @@ -15,9 +15,10 @@ import ( // 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. +// applications that use the [Amazon Web Services X-Ray SDK]. Downstream services can be other applications, +// Amazon Web Services resources, HTTP web APIs, or SQL databases. +// +// [Amazon Web Services X-Ray SDK]: https://docs.aws.amazon.com/xray/index.html 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 fb683876565..97f5d8ecce4 100644 --- a/service/xray/api_op_GetTraceSummaries.go +++ b/service/xray/api_op_GetTraceSummaries.go @@ -14,14 +14,23 @@ 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]in the Amazon Web Services X-Ray Developer Guide. +// +// [Using Filter Expressions]: https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html func (c *Client) GetTraceSummaries(ctx context.Context, params *GetTraceSummariesInput, optFns ...func(*Options)) (*GetTraceSummariesOutput, error) { if params == nil { params = &GetTraceSummariesInput{} diff --git a/service/xray/api_op_PutEncryptionConfig.go b/service/xray/api_op_PutEncryptionConfig.go index 0eee8b772e4..cf916028051 100644 --- a/service/xray/api_op_PutEncryptionConfig.go +++ b/service/xray/api_op_PutEncryptionConfig.go @@ -36,13 +36,17 @@ 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 . KeyId *string diff --git a/service/xray/api_op_PutResourcePolicy.go b/service/xray/api_op_PutResourcePolicy.go index ecb5a21d606..bec73c6892a 100644 --- a/service/xray/api_op_PutResourcePolicy.go +++ b/service/xray/api_op_PutResourcePolicy.go @@ -11,7 +11,8 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// Sets the resource policy to grant one or more Amazon Web Services services and +// Sets the resource policy to grant one or more Amazon Web Services services and +// // accounts permissions to access X-Ray. Each resource policy will be associated // with a specific Amazon Web Services account. Each Amazon Web Services account // can have a maximum of 5 resource policies, and each policy name must be unique @@ -45,21 +46,27 @@ type PutResourcePolicyInput struct { PolicyName *string // A flag to indicate whether to bypass the resource policy lockout safety check. + // // Setting this value to true increases the risk that the policy becomes - // unmanageable. Do not set this value to true indiscriminately. Use this parameter - // only when you include a policy in the request and you intend to prevent the - // principal that is making the request from making a subsequent PutResourcePolicy - // request. The default value is false. + // unmanageable. Do not set this value to true indiscriminately. + // + // Use this parameter only when you include a policy in the request and you intend + // to prevent the principal that is making the request from making a subsequent + // PutResourcePolicy request. + // + // The default value is false. BypassPolicyLockoutCheck bool // Specifies a specific policy revision, to ensure an atomic create operation. By // default the resource policy is created if it does not exist, or updated with an // 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. + // 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. PolicyRevisionId *string noSmithyDocumentSerde diff --git a/service/xray/api_op_PutTraceSegments.go b/service/xray/api_op_PutTraceSegments.go index eccac54bbf1..d14bd423637 100644 --- a/service/xray/api_op_PutTraceSegments.go +++ b/service/xray/api_op_PutTraceSegments.go @@ -11,25 +11,32 @@ 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) -// in the Amazon Web Services X-Ray Developer Guide. Required segment document -// fields +// Uploads segment documents to Amazon Web Services X-Ray. The [X-Ray SDK] 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]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 @@ -37,13 +44,21 @@ import ( // complete segment to overwrite the in-progress segment. // // A trace_id consists of three numbers separated by hyphens. For example, -// 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format +// 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. +// +// [X-Ray SDK]: https://docs.aws.amazon.com/xray/index.html +// [Amazon Web Services X-Ray Segment Documents]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html 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 fef2269bc26..7645cf13e71 100644 --- a/service/xray/api_op_TagResource.go +++ b/service/xray/api_op_TagResource.go @@ -35,19 +35,27 @@ 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: + // group or sampling rule. For more information about ways to use tags, see [Tagging Amazon Web Services resources]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. // + // [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/xray/api_op_UpdateGroup.go b/service/xray/api_op_UpdateGroup.go index e1c351978b2..7fe42efc38d 100644 --- a/service/xray/api_op_UpdateGroup.go +++ b/service/xray/api_op_UpdateGroup.go @@ -39,8 +39,10 @@ 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. diff --git a/service/xray/options.go b/service/xray/options.go index bcc3ba46c14..c3cadd463db 100644 --- a/service/xray/options.go +++ b/service/xray/options.go @@ -50,8 +50,10 @@ type Options struct { // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and - // BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom - // endpoint, set the client option BaseEndpoint instead. + // BaseEndpoint. + // + // To migrate an EndpointResolver implementation that uses a custom endpoint, set + // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be @@ -70,17 +72,20 @@ type Options struct { // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify - // per operation call's retry max attempts. If specified in an operation call's - // functional options with a value that is different than the constructed client's - // Options, the Client's Retryer will be wrapped to use the operation's specific - // RetryMaxAttempts value. + // per operation call's retry max attempts. + // + // If specified in an operation call's functional options with a value that is + // different than the constructed client's Options, the Client's Retryer will be + // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if - // Retryer option is not also specified. When creating a new API Clients this - // member will only be used if the Retryer Options member is nil. This value will - // be ignored if Retryer is not nil. Currently does not support per operation call - // overrides, may in the future. + // Retryer option is not also specified. + // + // When creating a new API Clients this member will only be used if the Retryer + // Options member is nil. This value will be ignored if Retryer is not nil. + // + // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable @@ -97,8 +102,9 @@ type Options struct { // The initial DefaultsMode used when the client options were constructed. If the // DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved - // value was at that point in time. Currently does not support per operation call - // overrides, may in the future. + // value was at that point in time. + // + // Currently does not support per operation call overrides, may in the future. resolvedDefaultsMode aws.DefaultsMode // The HTTP client to invoke API calls with. Defaults to client's default HTTP @@ -143,6 +149,7 @@ func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) { // Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for // this field will likely prevent you from using any endpoint-related service // features released after the introduction of EndpointResolverV2 and BaseEndpoint. +// // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. func WithEndpointResolver(v EndpointResolver) func(*Options) { diff --git a/service/xray/types/enums.go b/service/xray/types/enums.go index 4c0e311fb74..42870cf6a5e 100644 --- a/service/xray/types/enums.go +++ b/service/xray/types/enums.go @@ -11,8 +11,9 @@ const ( ) // Values returns all known values for EncryptionStatus. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionStatus) Values() []EncryptionStatus { return []EncryptionStatus{ "UPDATING", @@ -29,8 +30,9 @@ const ( ) // Values returns all known values for EncryptionType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (EncryptionType) Values() []EncryptionType { return []EncryptionType{ "NONE", @@ -46,8 +48,9 @@ const ( ) // Values returns all known values for InsightCategory. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (InsightCategory) Values() []InsightCategory { return []InsightCategory{ "FAULT", @@ -63,8 +66,9 @@ const ( ) // 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. +// expanded in the future, and so 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", @@ -81,8 +85,9 @@ const ( ) // Values returns all known values for SamplingStrategyName. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (SamplingStrategyName) Values() []SamplingStrategyName { return []SamplingStrategyName{ "PartialScan", @@ -100,8 +105,9 @@ const ( ) // Values returns all known values for TimeRangeType. Note that this can be -// expanded in the future, and so it is only as up to date as the client. The -// ordering of this slice is not guaranteed to be stable across updates. +// expanded in the future, and so it is only as up to date as the client. +// +// The ordering of this slice is not guaranteed to be stable across updates. func (TimeRangeType) Values() []TimeRangeType { return []TimeRangeType{ "TraceId", diff --git a/service/xray/types/types.go b/service/xray/types/types.go index 0b05146322e..386ae56251a 100644 --- a/service/xray/types/types.go +++ b/service/xray/types/types.go @@ -335,8 +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. InsightsConfiguration *InsightsConfiguration @@ -357,8 +359,10 @@ 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. @@ -501,15 +505,19 @@ 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. Type *string @@ -533,7 +541,7 @@ type InsightsConfiguration struct { // Information that describes an insight. type InsightSummary struct { - // Categories The categories that label and describe the type of insight. + // Categories The categories that label and describe the type of insight. Categories []InsightCategory // The impact statistics of the client side service. This includes the number of @@ -768,8 +776,9 @@ type SamplingRule struct { noSmithyDocumentSerde } -// A SamplingRule (https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html) -// and its metadata. +// A [SamplingRule] and its metadata. +// +// [SamplingRule]: https://docs.aws.amazon.com/xray/latest/api/API_SamplingRule.html type SamplingRuleRecord struct { // When the rule was created. @@ -833,8 +842,9 @@ 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]. +// +// [GetSamplingTargets]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html type SamplingStatisticsDocument struct { // A unique identifier for the service in hexadecimal. @@ -904,8 +914,9 @@ 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]. +// +// [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 @@ -929,11 +940,15 @@ 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) -// in the Amazon Web Services X-Ray Developer Guide. +// can be compiled from documents uploaded with [PutTraceSegments], 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] in the Amazon Web Services X-Ray +// Developer Guide. +// +// [PutTraceSegments]: https://docs.aws.amazon.com/xray/latest/api/API_PutTraceSegments.html +// [Amazon Web Services X-Ray Segment Documents]: https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html type Segment struct { // The segment document. @@ -987,13 +1002,17 @@ 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. Type *string @@ -1039,14 +1058,19 @@ 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: +// X-Ray group or sampling rule. For more information about ways to use tags, see [Tagging Amazon Web Services resources] +// 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 type Tag struct { // A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a @@ -1125,8 +1149,9 @@ 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]. + // + // [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. @@ -1222,8 +1247,9 @@ 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] that X-Ray could not process. +// +// [GetSamplingTargets]: https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html type UnprocessedStatistics struct { // The error code.